Merge branch 'maint'
[org-mode.git] / lisp / org.el
blob2750e8a22071c4213b8fcf5e06d1a688f12f70e1
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
44 ;; linked webpages.
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
50 ;; http://orgmode.org/org.html#Installation
52 ;; Documentation
53 ;; -------------
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
63 ;;; Code:
65 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
66 (defvar org-table-formula-constants-local nil
67 "Local version of `org-table-formula-constants'.")
68 (make-variable-buffer-local 'org-table-formula-constants-local)
70 ;;;; Require other packages
72 (eval-when-compile
73 (require 'cl)
74 (require 'gnus-sum))
76 (require 'calendar)
77 (require 'find-func)
78 (require 'format-spec)
80 (or (equal this-command 'eval-buffer)
81 (condition-case nil
82 (load (concat (file-name-directory load-file-name)
83 "org-loaddefs.el")
84 nil t t t)
85 (error
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
87 (sit-for 3)
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
89 (sit-for 3))))
91 (require 'org-macs)
92 (require 'org-compat)
94 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
95 ;; some places -- e.g. see the macro `org-with-limited-levels'.
97 ;; In Org buffers, the value of `outline-regexp' is that of
98 ;; `org-outline-regexp'. The only function still directly relying on
99 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
100 ;; job when `orgstruct-mode' is active.
101 (defvar org-outline-regexp "\\*+ "
102 "Regexp to match Org headlines.")
104 (defvar org-outline-regexp-bol "^\\*+ "
105 "Regexp to match Org headlines.
106 This is similar to `org-outline-regexp' but additionally makes
107 sure that we are at the beginning of the line.")
109 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
110 "Matches a headline, putting stars and text into groups.
111 Stars are put in group 1 and the trimmed body in group 2.")
113 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
114 (unless (boundp 'calendar-view-holidays-initially-flag)
115 (org-defvaralias 'calendar-view-holidays-initially-flag
116 'view-calendar-holidays-initially))
117 (unless (boundp 'calendar-view-diary-initially-flag)
118 (org-defvaralias 'calendar-view-diary-initially-flag
119 'view-diary-entries-initially))
120 (unless (boundp 'diary-fancy-buffer)
121 (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
123 (declare-function cdlatex-environment "ext:cdlatex" (environment item))
124 (declare-function org-add-archive-files "org-archive" (files))
125 (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
126 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
127 (declare-function org-agenda-redo "org-agenda" (&optional all))
128 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body))
129 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
130 (declare-function org-beamer-mode "ox-beamer" ())
131 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
132 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
133 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
134 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
135 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
136 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
137 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
138 (declare-function org-clock-update-time-maybe "org-clock" ())
139 (declare-function org-clocktable-shift "org-clock" (dir n))
140 (declare-function org-element-at-point "org-element" ())
141 (declare-function org-element-cache-refresh "org-element" (pos))
142 (declare-function org-element-cache-reset "org-element" (&optional all))
143 (declare-function org-element-contents "org-element" (element))
144 (declare-function org-element-context "org-element" (&optional element))
145 (declare-function org-element-copy "org-element" (datum))
146 (declare-function org-element-interpret-data "org-element" (data &optional parent))
147 (declare-function org-element-lineage "org-element" (blob &optional types with-self))
148 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
149 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
150 (declare-function org-element-property "org-element" (property element))
151 (declare-function org-element-put-property "org-element" (element property value))
152 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
153 (declare-function org-element-type "org-element" (element))
154 (declare-function org-element-update-syntax "org-element" ())
155 (declare-function org-id-find-id-file "org-id" (id))
156 (declare-function org-id-get-create "org-id" (&optional force))
157 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
158 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
159 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
160 (declare-function org-plot/gnuplot "org-plot" (&optional params))
161 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
162 (declare-function org-table-align "org-table" ())
163 (declare-function org-table-begin "org-table" (&optional table-type))
164 (declare-function org-table-beginning-of-field "org-table" (&optional n))
165 (declare-function org-table-blank-field "org-table" ())
166 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
167 (declare-function org-table-edit-field "org-table" (arg))
168 (declare-function org-table-end "org-table" (&optional table-type))
169 (declare-function org-table-end-of-field "org-table" (&optional n))
170 (declare-function org-table-insert-row "org-table" (&optional arg))
171 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
172 (declare-function org-table-maybe-eval-formula "org-table" ())
173 (declare-function org-table-maybe-recalculate-line "org-table" ())
174 (declare-function org-table-next-row "org-table" ())
175 (declare-function org-table-paste-rectangle "org-table" ())
176 (declare-function org-table-wrap-region "org-table" (arg))
177 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
178 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
179 (declare-function orgtbl-mode "org-table" (&optional arg))
181 (defsubst org-uniquify (list)
182 "Non-destructively remove duplicate elements from LIST."
183 (let ((res (copy-sequence list))) (delete-dups res)))
185 (defsubst org-get-at-bol (property)
186 "Get text property PROPERTY at the beginning of line."
187 (get-text-property (point-at-bol) property))
189 (defsubst org-trim (s)
190 "Remove whitespace at the beginning and the end of string S."
191 (replace-regexp-in-string
192 "\\`[ \t\n\r]+" ""
193 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
195 ;; load languages based on value of `org-babel-load-languages'
196 (defvar org-babel-load-languages)
198 ;;;###autoload
199 (defun org-babel-do-load-languages (sym value)
200 "Load the languages defined in `org-babel-load-languages'."
201 (set-default sym value)
202 (mapc (lambda (pair)
203 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
204 (if active
205 (progn
206 (require (intern (concat "ob-" lang))))
207 (progn
208 (funcall 'fmakunbound
209 (intern (concat "org-babel-execute:" lang)))
210 (funcall 'fmakunbound
211 (intern (concat "org-babel-expand-body:" lang)))))))
212 org-babel-load-languages))
214 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
215 ;;;###autoload
216 (defun org-babel-load-file (file &optional compile)
217 "Load Emacs Lisp source code blocks in the Org-mode FILE.
218 This function exports the source code using `org-babel-tangle'
219 and then loads the resulting file using `load-file'. With prefix
220 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
221 file to byte-code before it is loaded."
222 (interactive "fFile to load: \nP")
223 (let* ((age (lambda (file)
224 (float-time
225 (time-subtract (current-time)
226 (nth 5 (or (file-attributes (file-truename file))
227 (file-attributes file)))))))
228 (base-name (file-name-sans-extension file))
229 (exported-file (concat base-name ".el")))
230 ;; tangle if the org-mode file is newer than the elisp file
231 (unless (and (file-exists-p exported-file)
232 (> (funcall age file) (funcall age exported-file)))
233 ;; Tangle-file traversal returns reversed list of tangled files
234 ;; and we want to evaluate the first target.
235 (setq exported-file
236 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
237 (message "%s %s"
238 (if compile
239 (progn (byte-compile-file exported-file 'load)
240 "Compiled and loaded")
241 (progn (load-file exported-file) "Loaded"))
242 exported-file)))
244 (defcustom org-babel-load-languages '((emacs-lisp . t))
245 "Languages which can be evaluated in Org-mode buffers.
246 This list can be used to load support for any of the languages
247 below, note that each language will depend on a different set of
248 system executables and/or Emacs modes. When a language is
249 \"loaded\", then code blocks in that language can be evaluated
250 with `org-babel-execute-src-block' bound by default to C-c
251 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
252 be set to remove code block evaluation from the C-c C-c
253 keybinding. By default only Emacs Lisp (which has no
254 requirements) is loaded."
255 :group 'org-babel
256 :set 'org-babel-do-load-languages
257 :version "24.1"
258 :type '(alist :tag "Babel Languages"
259 :key-type
260 (choice
261 (const :tag "Awk" awk)
262 (const :tag "C" C)
263 (const :tag "R" R)
264 (const :tag "Asymptote" asymptote)
265 (const :tag "Calc" calc)
266 (const :tag "Clojure" clojure)
267 (const :tag "CSS" css)
268 (const :tag "Ditaa" ditaa)
269 (const :tag "Dot" dot)
270 (const :tag "Emacs Lisp" emacs-lisp)
271 (const :tag "Forth" forth)
272 (const :tag "Fortran" fortran)
273 (const :tag "Gnuplot" gnuplot)
274 (const :tag "Haskell" haskell)
275 (const :tag "IO" io)
276 (const :tag "J" J)
277 (const :tag "Java" java)
278 (const :tag "Javascript" js)
279 (const :tag "LaTeX" latex)
280 (const :tag "Ledger" ledger)
281 (const :tag "Lilypond" lilypond)
282 (const :tag "Lisp" lisp)
283 (const :tag "Makefile" makefile)
284 (const :tag "Maxima" maxima)
285 (const :tag "Matlab" matlab)
286 (const :tag "Mscgen" mscgen)
287 (const :tag "Ocaml" ocaml)
288 (const :tag "Octave" octave)
289 (const :tag "Org" org)
290 (const :tag "Perl" perl)
291 (const :tag "Pico Lisp" picolisp)
292 (const :tag "PlantUML" plantuml)
293 (const :tag "Python" python)
294 (const :tag "Ruby" ruby)
295 (const :tag "Sass" sass)
296 (const :tag "Scala" scala)
297 (const :tag "Scheme" scheme)
298 (const :tag "Screen" screen)
299 (const :tag "Shell Script" shell)
300 (const :tag "Shen" shen)
301 (const :tag "Sql" sql)
302 (const :tag "Sqlite" sqlite)
303 (const :tag "ebnf2ps" ebnf2ps))
304 :value-type (boolean :tag "Activate" :value t)))
306 ;;;; Customization variables
307 (defcustom org-clone-delete-id nil
308 "Remove ID property of clones of a subtree.
309 When non-nil, clones of a subtree don't inherit the ID property.
310 Otherwise they inherit the ID property with a new unique
311 identifier."
312 :type 'boolean
313 :version "24.1"
314 :group 'org-id)
316 ;;; Version
317 (org-check-version)
319 ;;;###autoload
320 (defun org-version (&optional here full message)
321 "Show the org-mode version.
322 Interactively, or when MESSAGE is non-nil, show it in echo area.
323 With prefix argument, or when HERE is non-nil, insert it at point.
324 In non-interactive uses, a reduced version string is output unless
325 FULL is given."
326 (interactive (list current-prefix-arg t (not current-prefix-arg)))
327 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
328 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
329 (load-suffixes (list ".el"))
330 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
331 (org-trash (or
332 (and (fboundp 'org-release) (fboundp 'org-git-version))
333 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
334 (load-suffixes save-load-suffixes)
335 (org-version (org-release))
336 (git-version (org-git-version))
337 (version (format "Org-mode version %s (%s @ %s)"
338 org-version
339 git-version
340 (if org-install-dir
341 (if (string= org-dir org-install-dir)
342 org-install-dir
343 (concat "mixed installation! " org-install-dir " and " org-dir))
344 "org-loaddefs.el can not be found!")))
345 (version1 (if full version org-version)))
346 (when here (insert version1))
347 (when message (message "%s" version1))
348 version1))
350 (defconst org-version (org-version))
353 ;;; Syntax Constants
355 ;;;; Block
357 (defconst org-block-regexp
358 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
359 "Regular expression for hiding blocks.")
361 (defconst org-dblock-start-re
362 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
363 "Matches the start line of a dynamic block, with parameters.")
365 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
366 "Matches the end of a dynamic block.")
368 ;;;; Clock and Planning
370 (defconst org-clock-string "CLOCK:"
371 "String used as prefix for timestamps clocking work hours on an item.")
373 (defvar org-closed-string "CLOSED:"
374 "String used as the prefix for timestamps logging closing a TODO entry.")
376 (defvar org-deadline-string "DEADLINE:"
377 "String to mark deadline entries.
378 A deadline is this string, followed by a time stamp. Should be a word,
379 terminated by a colon. You can insert a schedule keyword and
380 a timestamp with \\[org-deadline].")
382 (defvar org-scheduled-string "SCHEDULED:"
383 "String to mark scheduled TODO entries.
384 A schedule is this string, followed by a time stamp. Should be a word,
385 terminated by a colon. You can insert a schedule keyword and
386 a timestamp with \\[org-schedule].")
388 (defconst org-ds-keyword-length
389 (+ 2
390 (apply #'max
391 (mapcar #'length
392 (list org-deadline-string org-scheduled-string
393 org-clock-string org-closed-string))))
394 "Maximum length of the DEADLINE and SCHEDULED keywords.")
396 (defconst org-planning-line-re
397 (concat "^[ \t]*"
398 (regexp-opt
399 (list org-closed-string org-deadline-string org-scheduled-string)
401 "Matches a line with planning info.
402 Matched keyword is in group 1.")
404 (defconst org-clock-line-re
405 (concat "^[ \t]*" org-clock-string)
406 "Matches a line with clock info.")
408 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
409 "Matches the DEADLINE keyword.")
411 (defconst org-deadline-time-regexp
412 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
413 "Matches the DEADLINE keyword together with a time stamp.")
415 (defconst org-deadline-time-hour-regexp
416 (concat "\\<" org-deadline-string
417 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
418 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
420 (defconst org-deadline-line-regexp
421 (concat "\\<\\(" org-deadline-string "\\).*")
422 "Matches the DEADLINE keyword and the rest of the line.")
424 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
425 "Matches the SCHEDULED keyword.")
427 (defconst org-scheduled-time-regexp
428 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
429 "Matches the SCHEDULED keyword together with a time stamp.")
431 (defconst org-scheduled-time-hour-regexp
432 (concat "\\<" org-scheduled-string
433 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
434 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
436 (defconst org-closed-time-regexp
437 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
438 "Matches the CLOSED keyword together with a time stamp.")
440 (defconst org-keyword-time-regexp
441 (concat "\\<"
442 (regexp-opt
443 (list org-scheduled-string org-deadline-string org-closed-string
444 org-clock-string)
446 " *[[<]\\([^]>]+\\)[]>]")
447 "Matches any of the 4 keywords, together with the time stamp.")
449 (defconst org-keyword-time-not-clock-regexp
450 (concat
451 "\\<"
452 (regexp-opt
453 (list org-scheduled-string org-deadline-string org-closed-string) t)
454 " *[[<]\\([^]>]+\\)[]>]")
455 "Matches any of the 3 keywords, together with the time stamp.")
457 (defconst org-maybe-keyword-time-regexp
458 (concat "\\(\\<"
459 (regexp-opt
460 (list org-scheduled-string org-deadline-string org-closed-string
461 org-clock-string)
463 "\\)?"
464 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
465 "\\|"
466 "<%%([^\r\n>]*>\\)")
467 "Matches a timestamp, possibly preceded by a keyword.")
469 (defconst org-all-time-keywords
470 (mapcar (lambda (w) (substring w 0 -1))
471 (list org-scheduled-string org-deadline-string
472 org-clock-string org-closed-string))
473 "List of time keywords.")
475 ;;;; Drawer
477 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
478 "Matches first or last line of a hidden block.
479 Group 1 contains drawer's name or \"END\".")
481 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
482 "Regular expression matching the first line of a property drawer.")
484 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
485 "Regular expression matching the last line of a property drawer.")
487 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
488 "Regular expression matching the first line of a clock drawer.")
490 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
491 "Regular expression matching the last line of a clock drawer.")
493 (defconst org-property-drawer-re
494 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
495 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
496 "[ \t]*:END:[ \t]*$")
497 "Matches an entire property drawer.")
499 (defconst org-clock-drawer-re
500 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
501 org-clock-drawer-end-re "\\)\n?")
502 "Matches an entire clock drawer.")
504 ;;;; Headline
506 (defconst org-heading-keyword-regexp-format
507 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
508 "Printf format for a regexp matching a headline with some keyword.
509 This regexp will match the headline of any node which has the
510 exact keyword that is put into the format. The keyword isn't in
511 any group by default, but the stars and the body are.")
513 (defconst org-heading-keyword-maybe-regexp-format
514 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
515 "Printf format for a regexp matching a headline, possibly with some keyword.
516 This regexp can match any headline with the specified keyword, or
517 without a keyword. The keyword isn't in any group by default,
518 but the stars and the body are.")
520 (defconst org-archive-tag "ARCHIVE"
521 "The tag that marks a subtree as archived.
522 An archived subtree does not open during visibility cycling, and does
523 not contribute to the agenda listings.")
525 (defconst org-comment-string "COMMENT"
526 "Entries starting with this keyword will never be exported.
527 An entry can be toggled between COMMENT and normal with
528 \\[org-toggle-comment].")
531 ;;;; LaTeX Environments and Fragments
533 (defconst org-latex-regexps
534 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
535 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
536 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
537 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
538 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
539 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
540 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
541 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
542 "Regular expressions for matching embedded LaTeX.")
544 ;;;; Node Property
546 (defconst org-effort-property "Effort"
547 "The property that is being used to keep track of effort estimates.
548 Effort estimates given in this property need to have the format H:MM.")
550 ;;;; Table
552 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
553 "Detect an org-type or table-type table.")
555 (defconst org-table-line-regexp "^[ \t]*|"
556 "Detect an org-type table line.")
558 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
559 "Detect an org-type table line.")
561 (defconst org-table-hline-regexp "^[ \t]*|-"
562 "Detect an org-type table hline.")
564 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
565 "Detect a table-type table hline.")
567 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
568 "Detect the first line outside a table when searching from within it.
569 This works for both table types.")
571 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
572 "Detect a #+TBLFM line.")
574 ;;;; Timestamp
576 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
577 "Regular expression for fast time stamp matching.")
579 (defconst org-ts-regexp-inactive
580 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
581 "Regular expression for fast inactive time stamp matching.")
583 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
584 "Regular expression for fast time stamp matching.")
586 (defconst org-ts-regexp0
587 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
588 "Regular expression matching time strings for analysis.
589 This one does not require the space after the date, so it can be used
590 on a string that terminates immediately after the date.")
592 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
593 "Regular expression matching time strings for analysis.")
595 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
596 "Regular expression matching time stamps, with groups.")
598 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
599 "Regular expression matching time stamps (also [..]), with groups.")
601 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
602 "Regular expression matching a time stamp range.")
604 (defconst org-tr-regexp-both
605 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
606 "Regular expression matching a time stamp range.")
608 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
609 org-ts-regexp "\\)?")
610 "Regular expression matching a time stamp or time stamp range.")
612 (defconst org-tsr-regexp-both
613 (concat org-ts-regexp-both "\\(--?-?"
614 org-ts-regexp-both "\\)?")
615 "Regular expression matching a time stamp or time stamp range.
616 The time stamps may be either active or inactive.")
618 (defconst org-repeat-re
619 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
620 "Regular expression for specifying repeated events.
621 After a match, group 1 contains the repeat expression.")
623 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
624 "Formats for `format-time-string' which are used for time stamps.")
627 ;;; The custom variables
629 (defgroup org nil
630 "Outline-based notes management and organizer."
631 :tag "Org"
632 :group 'outlines
633 :group 'calendar)
635 (defcustom org-mode-hook nil
636 "Mode hook for Org-mode, run after the mode was turned on."
637 :group 'org
638 :type 'hook)
640 (defcustom org-load-hook nil
641 "Hook that is run after org.el has been loaded."
642 :group 'org
643 :type 'hook)
645 (defcustom org-log-buffer-setup-hook nil
646 "Hook that is run after an Org log buffer is created."
647 :group 'org
648 :version "24.1"
649 :type 'hook)
651 (defvar org-modules) ; defined below
652 (defvar org-modules-loaded nil
653 "Have the modules been loaded already?")
655 (defun org-load-modules-maybe (&optional force)
656 "Load all extensions listed in `org-modules'."
657 (when (or force (not org-modules-loaded))
658 (mapc (lambda (ext)
659 (condition-case nil (require ext)
660 (error (message "Problems while trying to load feature `%s'" ext))))
661 org-modules)
662 (setq org-modules-loaded t)))
664 (defun org-set-modules (var value)
665 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
666 (set var value)
667 (when (featurep 'org)
668 (org-load-modules-maybe 'force)
669 (org-element-cache-reset 'all)))
671 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
672 "Modules that should always be loaded together with org.el.
674 If a description starts with <C>, the file is not part of Emacs
675 and loading it will require that you have downloaded and properly
676 installed the Org mode distribution.
678 You can also use this system to load external packages (i.e. neither Org
679 core modules, nor modules from the CONTRIB directory). Just add symbols
680 to the end of the list. If the package is called org-xyz.el, then you need
681 to add the symbol `xyz', and the package must have a call to:
683 \(provide 'org-xyz)
685 For export specific modules, see also `org-export-backends'."
686 :group 'org
687 :set 'org-set-modules
688 :version "24.4"
689 :package-version '(Org . "8.0")
690 :type
691 '(set :greedy t
692 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
693 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
694 (const :tag " crypt: Encryption of subtrees" org-crypt)
695 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
696 (const :tag " docview: Links to doc-view buffers" org-docview)
697 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
698 (const :tag " habit: Track your consistency with habits" org-habit)
699 (const :tag " id: Global IDs for identifying entries" org-id)
700 (const :tag " info: Links to Info nodes" org-info)
701 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
702 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
703 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
704 (const :tag " mouse: Additional mouse support" org-mouse)
705 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
706 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
707 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
709 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
710 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
711 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
712 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
713 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
714 (const :tag "C collector: Collect properties into tables" org-collector)
715 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
716 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
717 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
718 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
719 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
720 (const :tag "C eval: Include command output as text" org-eval)
721 (const :tag "C eww: Store link to url of eww" org-eww)
722 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
723 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
724 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
725 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
726 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
727 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
728 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
729 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
730 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
731 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
732 (const :tag "C mew: Links to Mew folders/messages" org-mew)
733 (const :tag "C mtags: Support for muse-like tags" org-mtags)
734 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
735 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
736 (const :tag "C registry: A registry for Org-mode links" org-registry)
737 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
738 (const :tag "C secretary: Team management with org-mode" org-secretary)
739 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
740 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
741 (const :tag "C track: Keep up with Org-mode development" org-track)
742 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
743 (const :tag "C vm: Links to VM folders/messages" org-vm)
744 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
745 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
746 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
748 (defvar org-export-registered-backends) ; From ox.el.
749 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
750 (declare-function org-export-backend-name "ox" (backend))
751 (defcustom org-export-backends '(ascii html icalendar latex)
752 "List of export back-ends that should be always available.
754 If a description starts with <C>, the file is not part of Emacs
755 and loading it will require that you have downloaded and properly
756 installed the Org mode distribution.
758 Unlike to `org-modules', libraries in this list will not be
759 loaded along with Org, but only once the export framework is
760 needed.
762 This variable needs to be set before org.el is loaded. If you
763 need to make a change while Emacs is running, use the customize
764 interface or run the following code, where VAL stands for the new
765 value of the variable, after updating it:
767 \(progn
768 \(setq org-export-registered-backends
769 \(org-remove-if-not
770 \(lambda (backend)
771 \(let ((name (org-export-backend-name backend)))
772 \(or (memq name val)
773 \(catch 'parentp
774 \(dolist (b val)
775 \(and (org-export-derived-backend-p b name)
776 \(throw 'parentp t)))))))
777 org-export-registered-backends))
778 \(let ((new-list (mapcar #'org-export-backend-name
779 org-export-registered-backends)))
780 \(dolist (backend val)
781 \(cond
782 \((not (load (format \"ox-%s\" backend) t t))
783 \(message \"Problems while trying to load export back-end `%s'\"
784 backend))
785 \((not (memq backend new-list)) (push backend new-list))))
786 \(set-default 'org-export-backends new-list)))
788 Adding a back-end to this list will also pull the back-end it
789 depends on, if any."
790 :group 'org
791 :group 'org-export
792 :version "24.4"
793 :package-version '(Org . "8.0")
794 :initialize 'custom-initialize-set
795 :set (lambda (var val)
796 (if (not (featurep 'ox)) (set-default var val)
797 ;; Any back-end not required anymore (not present in VAL and not
798 ;; a parent of any back-end in the new value) is removed from the
799 ;; list of registered back-ends.
800 (setq org-export-registered-backends
801 (org-remove-if-not
802 (lambda (backend)
803 (let ((name (org-export-backend-name backend)))
804 (or (memq name val)
805 (catch 'parentp
806 (dolist (b val)
807 (and (org-export-derived-backend-p b name)
808 (throw 'parentp t)))))))
809 org-export-registered-backends))
810 ;; Now build NEW-LIST of both new back-ends and required
811 ;; parents.
812 (let ((new-list (mapcar #'org-export-backend-name
813 org-export-registered-backends)))
814 (dolist (backend val)
815 (cond
816 ((not (load (format "ox-%s" backend) t t))
817 (message "Problems while trying to load export back-end `%s'"
818 backend))
819 ((not (memq backend new-list)) (push backend new-list))))
820 ;; Set VAR to that list with fixed dependencies.
821 (set-default var new-list))))
822 :type '(set :greedy t
823 (const :tag " ascii Export buffer to ASCII format" ascii)
824 (const :tag " beamer Export buffer to Beamer presentation" beamer)
825 (const :tag " html Export buffer to HTML format" html)
826 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
827 (const :tag " latex Export buffer to LaTeX format" latex)
828 (const :tag " man Export buffer to MAN format" man)
829 (const :tag " md Export buffer to Markdown format" md)
830 (const :tag " odt Export buffer to ODT format" odt)
831 (const :tag " org Export buffer to Org format" org)
832 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
833 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
834 (const :tag "C deck Export buffer to deck.js presentations" deck)
835 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
836 (const :tag "C groff Export buffer to Groff format" groff)
837 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
838 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
839 (const :tag "C s5 Export buffer to s5 presentations" s5)
840 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
842 (eval-after-load 'ox
843 '(mapc
844 (lambda (backend)
845 (condition-case nil (require (intern (format "ox-%s" backend)))
846 (error (message "Problems while trying to load export back-end `%s'"
847 backend))))
848 org-export-backends))
850 (defcustom org-support-shift-select nil
851 "Non-nil means make shift-cursor commands select text when possible.
853 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
854 start selecting a region, or enlarge regions started in this way.
855 In Org-mode, in special contexts, these same keys are used for
856 other purposes, important enough to compete with shift selection.
857 Org tries to balance these needs by supporting `shift-select-mode'
858 outside these special contexts, under control of this variable.
860 The default of this variable is nil, to avoid confusing behavior. Shifted
861 cursor keys will then execute Org commands in the following contexts:
862 - on a headline, changing TODO state (left/right) and priority (up/down)
863 - on a time stamp, changing the time
864 - in a plain list item, changing the bullet type
865 - in a property definition line, switching between allowed values
866 - in the BEGIN line of a clock table (changing the time block).
867 Outside these contexts, the commands will throw an error.
869 When this variable is t and the cursor is not in a special
870 context, Org-mode will support shift-selection for making and
871 enlarging regions. To make this more effective, the bullet
872 cycling will no longer happen anywhere in an item line, but only
873 if the cursor is exactly on the bullet.
875 If you set this variable to the symbol `always', then the keys
876 will not be special in headlines, property lines, and item lines,
877 to make shift selection work there as well. If this is what you
878 want, you can use the following alternative commands: `C-c C-t'
879 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
880 can be used to switch TODO sets, `C-c -' to cycle item bullet
881 types, and properties can be edited by hand or in column view.
883 However, when the cursor is on a timestamp, shift-cursor commands
884 will still edit the time stamp - this is just too good to give up.
886 XEmacs user should have this variable set to nil, because
887 `shift-select-mode' is in Emacs 23 or later only."
888 :group 'org
889 :type '(choice
890 (const :tag "Never" nil)
891 (const :tag "When outside special context" t)
892 (const :tag "Everywhere except timestamps" always)))
894 (defcustom org-loop-over-headlines-in-active-region nil
895 "Shall some commands act upon headlines in the active region?
897 When set to t, some commands will be performed in all headlines
898 within the active region.
900 When set to `start-level', some commands will be performed in all
901 headlines within the active region, provided that these headlines
902 are of the same level than the first one.
904 When set to a string, those commands will be performed on the
905 matching headlines within the active region. Such string must be
906 a tags/property/todo match as it is used in the agenda tags view.
908 The list of commands is: `org-schedule', `org-deadline',
909 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
910 `org-archive-to-archive-sibling'. The archiving commands skip
911 already archived entries."
912 :type '(choice (const :tag "Don't loop" nil)
913 (const :tag "All headlines in active region" t)
914 (const :tag "In active region, headlines at the same level than the first one" start-level)
915 (string :tag "Tags/Property/Todo matcher"))
916 :version "24.1"
917 :group 'org-todo
918 :group 'org-archive)
920 (defgroup org-startup nil
921 "Options concerning startup of Org-mode."
922 :tag "Org Startup"
923 :group 'org)
925 (defcustom org-startup-folded t
926 "Non-nil means entering Org-mode will switch to OVERVIEW.
927 This can also be configured on a per-file basis by adding one of
928 the following lines anywhere in the buffer:
930 #+STARTUP: fold (or `overview', this is equivalent)
931 #+STARTUP: nofold (or `showall', this is equivalent)
932 #+STARTUP: content
933 #+STARTUP: showeverything
935 By default, this option is ignored when Org opens agenda files
936 for the first time. If you want the agenda to honor the startup
937 option, set `org-agenda-inhibit-startup' to nil."
938 :group 'org-startup
939 :type '(choice
940 (const :tag "nofold: show all" nil)
941 (const :tag "fold: overview" t)
942 (const :tag "content: all headlines" content)
943 (const :tag "show everything, even drawers" showeverything)))
945 (defcustom org-startup-truncated t
946 "Non-nil means entering Org-mode will set `truncate-lines'.
947 This is useful since some lines containing links can be very long and
948 uninteresting. Also tables look terrible when wrapped."
949 :group 'org-startup
950 :type 'boolean)
952 (defcustom org-startup-indented nil
953 "Non-nil means turn on `org-indent-mode' on startup.
954 This can also be configured on a per-file basis by adding one of
955 the following lines anywhere in the buffer:
957 #+STARTUP: indent
958 #+STARTUP: noindent"
959 :group 'org-structure
960 :type '(choice
961 (const :tag "Not" nil)
962 (const :tag "Globally (slow on startup in large files)" t)))
964 (defcustom org-use-sub-superscripts t
965 "Non-nil means interpret \"_\" and \"^\" for display.
967 If you want to control how Org exports those characters, see
968 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
969 used to be an alias for `org-export-with-sub-superscripts' in
970 Org <8.0, it is not anymore.
972 When this option is turned on, you can use TeX-like syntax for
973 sub- and superscripts within the buffer. Several characters after
974 \"_\" or \"^\" will be considered as a single item - so grouping
975 with {} is normally not needed. For example, the following things
976 will be parsed as single sub- or superscripts:
978 10^24 or 10^tau several digits will be considered 1 item.
979 10^-12 or 10^-tau a leading sign with digits or a word
980 x^2-y^3 will be read as x^2 - y^3, because items are
981 terminated by almost any nonword/nondigit char.
982 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
984 Still, ambiguity is possible. So when in doubt, use {} to enclose
985 the sub/superscript. If you set this variable to the symbol `{}',
986 the braces are *required* in order to trigger interpretations as
987 sub/superscript. This can be helpful in documents that need \"_\"
988 frequently in plain text."
989 :group 'org-startup
990 :version "24.4"
991 :package-version '(Org . "8.0")
992 :type '(choice
993 (const :tag "Always interpret" t)
994 (const :tag "Only with braces" {})
995 (const :tag "Never interpret" nil)))
997 (defcustom org-startup-with-beamer-mode nil
998 "Non-nil means turn on `org-beamer-mode' on startup.
999 This can also be configured on a per-file basis by adding one of
1000 the following lines anywhere in the buffer:
1002 #+STARTUP: beamer"
1003 :group 'org-startup
1004 :version "24.1"
1005 :type 'boolean)
1007 (defcustom org-startup-align-all-tables nil
1008 "Non-nil means align all tables when visiting a file.
1009 This is useful when the column width in tables is forced with <N> cookies
1010 in table fields. Such tables will look correct only after the first re-align.
1011 This can also be configured on a per-file basis by adding one of
1012 the following lines anywhere in the buffer:
1013 #+STARTUP: align
1014 #+STARTUP: noalign"
1015 :group 'org-startup
1016 :type 'boolean)
1018 (defcustom org-startup-with-inline-images nil
1019 "Non-nil means show inline images when loading a new Org file.
1020 This can also be configured on a per-file basis by adding one of
1021 the following lines anywhere in the buffer:
1022 #+STARTUP: inlineimages
1023 #+STARTUP: noinlineimages"
1024 :group 'org-startup
1025 :version "24.1"
1026 :type 'boolean)
1028 (defcustom org-startup-with-latex-preview nil
1029 "Non-nil means preview LaTeX fragments when loading a new Org file.
1031 This can also be configured on a per-file basis by adding one of
1032 the following lines anywhere in the buffer:
1033 #+STARTUP: latexpreview
1034 #+STARTUP: nolatexpreview"
1035 :group 'org-startup
1036 :version "24.4"
1037 :package-version '(Org . "8.0")
1038 :type 'boolean)
1040 (defcustom org-insert-mode-line-in-empty-file nil
1041 "Non-nil means insert the first line setting Org-mode in empty files.
1042 When the function `org-mode' is called interactively in an empty file, this
1043 normally means that the file name does not automatically trigger Org-mode.
1044 To ensure that the file will always be in Org-mode in the future, a
1045 line enforcing Org-mode will be inserted into the buffer, if this option
1046 has been set."
1047 :group 'org-startup
1048 :type 'boolean)
1050 (defcustom org-replace-disputed-keys nil
1051 "Non-nil means use alternative key bindings for some keys.
1052 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1053 These keys are also used by other packages like shift-selection-mode'
1054 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1055 If you want to use Org-mode together with one of these other modes,
1056 or more generally if you would like to move some Org-mode commands to
1057 other keys, set this variable and configure the keys with the variable
1058 `org-disputed-keys'.
1060 This option is only relevant at load-time of Org-mode, and must be set
1061 *before* org.el is loaded. Changing it requires a restart of Emacs to
1062 become effective."
1063 :group 'org-startup
1064 :type 'boolean)
1066 (defcustom org-use-extra-keys nil
1067 "Non-nil means use extra key sequence definitions for certain commands.
1068 This happens automatically if you run XEmacs or if `window-system'
1069 is nil. This variable lets you do the same manually. You must
1070 set it before loading org.
1072 Example: on Carbon Emacs 22 running graphically, with an external
1073 keyboard on a Powerbook, the default way of setting M-left might
1074 not work for either Alt or ESC. Setting this variable will make
1075 it work for ESC."
1076 :group 'org-startup
1077 :type 'boolean)
1079 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1081 (defcustom org-disputed-keys
1082 '(([(shift up)] . [(meta p)])
1083 ([(shift down)] . [(meta n)])
1084 ([(shift left)] . [(meta -)])
1085 ([(shift right)] . [(meta +)])
1086 ([(control shift right)] . [(meta shift +)])
1087 ([(control shift left)] . [(meta shift -)]))
1088 "Keys for which Org-mode and other modes compete.
1089 This is an alist, cars are the default keys, second element specifies
1090 the alternative to use when `org-replace-disputed-keys' is t.
1092 Keys can be specified in any syntax supported by `define-key'.
1093 The value of this option takes effect only at Org-mode's startup,
1094 therefore you'll have to restart Emacs to apply it after changing."
1095 :group 'org-startup
1096 :type 'alist)
1098 (defun org-key (key)
1099 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1100 Or return the original if not disputed.
1101 Also apply the translations defined in `org-xemacs-key-equivalents'."
1102 (when org-replace-disputed-keys
1103 (let* ((nkey (key-description key))
1104 (x (org-find-if (lambda (x)
1105 (equal (key-description (car x)) nkey))
1106 org-disputed-keys)))
1107 (setq key (if x (cdr x) key))))
1108 (when (featurep 'xemacs)
1109 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1110 key)
1112 (defun org-find-if (predicate seq)
1113 (catch 'exit
1114 (while seq
1115 (if (funcall predicate (car seq))
1116 (throw 'exit (car seq))
1117 (pop seq)))))
1119 (defun org-defkey (keymap key def)
1120 "Define a key, possibly translated, as returned by `org-key'."
1121 (define-key keymap (org-key key) def))
1123 (defcustom org-ellipsis nil
1124 "The ellipsis to use in the Org-mode outline.
1125 When nil, just use the standard three dots.
1126 When a string, use that string instead.
1127 When a face, use the standard 3 dots, but with the specified face.
1128 The change affects only Org-mode (which will then use its own display table).
1129 Changing this requires executing \\[org-mode] in a buffer to become
1130 effective."
1131 :group 'org-startup
1132 :type '(choice (const :tag "Default" nil)
1133 (face :tag "Face" :value org-warning)
1134 (string :tag "String" :value "...#")))
1136 (defvar org-display-table nil
1137 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1139 (defgroup org-keywords nil
1140 "Keywords in Org-mode."
1141 :tag "Org Keywords"
1142 :group 'org)
1144 (defcustom org-closed-keep-when-no-todo nil
1145 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1146 :group 'org-todo
1147 :group 'org-keywords
1148 :version "24.4"
1149 :package-version '(Org . "8.0")
1150 :type 'boolean)
1152 (defgroup org-structure nil
1153 "Options concerning the general structure of Org-mode files."
1154 :tag "Org Structure"
1155 :group 'org)
1157 (defgroup org-reveal-location nil
1158 "Options about how to make context of a location visible."
1159 :tag "Org Reveal Location"
1160 :group 'org-structure)
1162 (defcustom org-show-context-detail '((isearch . lineage)
1163 (bookmark-jump . lineage)
1164 (default . ancestors))
1165 "Alist between context and visibility span when revealing a location.
1167 \\<org-mode-map>Some actions may move point into invisible
1168 locations. As a consequence, Org always expose a neighborhood
1169 around point. How much is shown depends on the initial action,
1170 or context. Valid contexts are
1172 agenda when exposing an entry from the agenda
1173 org-goto when using the command `org-goto' (\\[org-goto])
1174 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1175 tags-tree when constructing a sparse tree based on tags matches
1176 link-search when exposing search matches associated with a link
1177 mark-goto when exposing the jump goal of a mark
1178 bookmark-jump when exposing a bookmark location
1179 isearch when exiting from an incremental search
1180 default default for all contexts not set explicitly
1182 Allowed visibility spans are
1184 minimal show current headline; if point is not on headline,
1185 also show entry
1187 local show current headline, entry and next headline
1189 ancestors show current headline and its direct ancestors; if
1190 point is not on headline, also show entry
1192 lineage show current headline, its direct ancestors and all
1193 their children; if point is not on headline, also show
1194 entry and first child
1196 tree show current headline, its direct ancestors and all
1197 their children; if point is not on headline, also show
1198 entry and all children
1200 canonical show current headline, its direct ancestors along with
1201 their entries and children; if point is not located on
1202 the headline, also show current entry and all children
1204 As special cases, a nil or t value means show all contexts in
1205 `minimal' or `canonical' view, respectively.
1207 Some views can make displayed information very compact, but also
1208 make it harder to edit the location of the match. In such
1209 a case, use the command `org-reveal' (\\[org-reveal]) to show
1210 more context."
1211 :group 'org-reveal-location
1212 :version "25.1"
1213 :package-version '(Org . "8.3")
1214 :type '(choice
1215 (const :tag "Canonical" t)
1216 (const :tag "Minimal" nil)
1217 (repeat :greedy t :tag "Individual contexts"
1218 (cons
1219 (choice :tag "Context"
1220 (const agenda)
1221 (const org-goto)
1222 (const occur-tree)
1223 (const tags-tree)
1224 (const link-search)
1225 (const mark-goto)
1226 (const bookmark-jump)
1227 (const isearch)
1228 (const default))
1229 (choice :tag "Detail level"
1230 (const minimal)
1231 (const local)
1232 (const ancestors)
1233 (const lineage)
1234 (const tree)
1235 (const canonical))))))
1237 (defcustom org-indirect-buffer-display 'other-window
1238 "How should indirect tree buffers be displayed?
1239 This applies to indirect buffers created with the commands
1240 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1241 Valid values are:
1242 current-window Display in the current window
1243 other-window Just display in another window.
1244 dedicated-frame Create one new frame, and re-use it each time.
1245 new-frame Make a new frame each time. Note that in this case
1246 previously-made indirect buffers are kept, and you need to
1247 kill these buffers yourself."
1248 :group 'org-structure
1249 :group 'org-agenda-windows
1250 :type '(choice
1251 (const :tag "In current window" current-window)
1252 (const :tag "In current frame, other window" other-window)
1253 (const :tag "Each time a new frame" new-frame)
1254 (const :tag "One dedicated frame" dedicated-frame)))
1256 (defcustom org-use-speed-commands nil
1257 "Non-nil means activate single letter commands at beginning of a headline.
1258 This may also be a function to test for appropriate locations where speed
1259 commands should be active.
1261 For example, to activate speed commands when the point is on any
1262 star at the beginning of the headline, you can do this:
1264 (setq org-use-speed-commands
1265 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1266 :group 'org-structure
1267 :type '(choice
1268 (const :tag "Never" nil)
1269 (const :tag "At beginning of headline stars" t)
1270 (function)))
1272 (defcustom org-speed-commands-user nil
1273 "Alist of additional speed commands.
1274 This list will be checked before `org-speed-commands-default'
1275 when the variable `org-use-speed-commands' is non-nil
1276 and when the cursor is at the beginning of a headline.
1277 The car if each entry is a string with a single letter, which must
1278 be assigned to `self-insert-command' in the global map.
1279 The cdr is either a command to be called interactively, a function
1280 to be called, or a form to be evaluated.
1281 An entry that is just a list with a single string will be interpreted
1282 as a descriptive headline that will be added when listing the speed
1283 commands in the Help buffer using the `?' speed command."
1284 :group 'org-structure
1285 :type '(repeat :value ("k" . ignore)
1286 (choice :value ("k" . ignore)
1287 (list :tag "Descriptive Headline" (string :tag "Headline"))
1288 (cons :tag "Letter and Command"
1289 (string :tag "Command letter")
1290 (choice
1291 (function)
1292 (sexp))))))
1294 (defcustom org-bookmark-names-plist
1295 '(:last-capture "org-capture-last-stored"
1296 :last-refile "org-refile-last-stored"
1297 :last-capture-marker "org-capture-last-stored-marker")
1298 "Names for bookmarks automatically set by some Org commands.
1299 This can provide strings as names for a number of bookmarks Org sets
1300 automatically. The following keys are currently implemented:
1301 :last-capture
1302 :last-capture-marker
1303 :last-refile
1304 When a key does not show up in the property list, the corresponding bookmark
1305 is not set."
1306 :group 'org-structure
1307 :type 'plist)
1309 (defgroup org-cycle nil
1310 "Options concerning visibility cycling in Org-mode."
1311 :tag "Org Cycle"
1312 :group 'org-structure)
1314 (defcustom org-cycle-skip-children-state-if-no-children t
1315 "Non-nil means skip CHILDREN state in entries that don't have any."
1316 :group 'org-cycle
1317 :type 'boolean)
1319 (defcustom org-cycle-max-level nil
1320 "Maximum level which should still be subject to visibility cycling.
1321 Levels higher than this will, for cycling, be treated as text, not a headline.
1322 When `org-odd-levels-only' is set, a value of N in this variable actually
1323 means 2N-1 stars as the limiting headline.
1324 When nil, cycle all levels.
1325 Note that the limiting level of cycling is also influenced by
1326 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1327 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1328 than its value."
1329 :group 'org-cycle
1330 :type '(choice
1331 (const :tag "No limit" nil)
1332 (integer :tag "Maximum level")))
1334 (defcustom org-hide-block-startup nil
1335 "Non-nil means entering Org-mode will fold all blocks.
1336 This can also be set in on a per-file basis with
1338 #+STARTUP: hideblocks
1339 #+STARTUP: showblocks"
1340 :group 'org-startup
1341 :group 'org-cycle
1342 :type 'boolean)
1344 (defcustom org-cycle-global-at-bob nil
1345 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1346 This makes it possible to do global cycling without having to use S-TAB or
1347 \\[universal-argument] TAB. For this special case to work, the first line
1348 of the buffer must not be a headline -- it may be empty or some other text.
1349 When used in this way, `org-cycle-hook' is disabled temporarily to make
1350 sure the cursor stays at the beginning of the buffer. When this option is
1351 nil, don't do anything special at the beginning of the buffer."
1352 :group 'org-cycle
1353 :type 'boolean)
1355 (defcustom org-cycle-level-after-item/entry-creation t
1356 "Non-nil means cycle entry level or item indentation in new empty entries.
1358 When the cursor is at the end of an empty headline, i.e., with only stars
1359 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1360 and then all possible ancestor states, before returning to the original state.
1361 This makes data entry extremely fast: M-RET to create a new headline,
1362 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1364 When the cursor is at the end of an empty plain list item, one TAB will
1365 make it a subitem, two or more tabs will back up to make this an item
1366 higher up in the item hierarchy."
1367 :group 'org-cycle
1368 :type 'boolean)
1370 (defcustom org-cycle-emulate-tab t
1371 "Where should `org-cycle' emulate TAB.
1372 nil Never
1373 white Only in completely white lines
1374 whitestart Only at the beginning of lines, before the first non-white char
1375 t Everywhere except in headlines
1376 exc-hl-bol Everywhere except at the start of a headline
1377 If TAB is used in a place where it does not emulate TAB, the current subtree
1378 visibility is cycled."
1379 :group 'org-cycle
1380 :type '(choice (const :tag "Never" nil)
1381 (const :tag "Only in completely white lines" white)
1382 (const :tag "Before first char in a line" whitestart)
1383 (const :tag "Everywhere except in headlines" t)
1384 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1386 (defcustom org-cycle-separator-lines 2
1387 "Number of empty lines needed to keep an empty line between collapsed trees.
1388 If you leave an empty line between the end of a subtree and the following
1389 headline, this empty line is hidden when the subtree is folded.
1390 Org-mode will leave (exactly) one empty line visible if the number of
1391 empty lines is equal or larger to the number given in this variable.
1392 So the default 2 means at least 2 empty lines after the end of a subtree
1393 are needed to produce free space between a collapsed subtree and the
1394 following headline.
1396 If the number is negative, and the number of empty lines is at least -N,
1397 all empty lines are shown.
1399 Special case: when 0, never leave empty lines in collapsed view."
1400 :group 'org-cycle
1401 :type 'integer)
1402 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1404 (defcustom org-pre-cycle-hook nil
1405 "Hook that is run before visibility cycling is happening.
1406 The function(s) in this hook must accept a single argument which indicates
1407 the new state that will be set right after running this hook. The
1408 argument is a symbol. Before a global state change, it can have the values
1409 `overview', `content', or `all'. Before a local state change, it can have
1410 the values `folded', `children', or `subtree'."
1411 :group 'org-cycle
1412 :type 'hook)
1414 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1415 org-cycle-hide-drawers
1416 org-cycle-show-empty-lines
1417 org-optimize-window-after-visibility-change)
1418 "Hook that is run after `org-cycle' has changed the buffer visibility.
1419 The function(s) in this hook must accept a single argument which indicates
1420 the new state that was set by the most recent `org-cycle' command. The
1421 argument is a symbol. After a global state change, it can have the values
1422 `overview', `contents', or `all'. After a local state change, it can have
1423 the values `folded', `children', or `subtree'."
1424 :group 'org-cycle
1425 :type 'hook
1426 :version "25.1"
1427 :package-version '(Org . "8.3"))
1429 (defgroup org-edit-structure nil
1430 "Options concerning structure editing in Org-mode."
1431 :tag "Org Edit Structure"
1432 :group 'org-structure)
1434 (defcustom org-odd-levels-only nil
1435 "Non-nil means skip even levels and only use odd levels for the outline.
1436 This has the effect that two stars are being added/taken away in
1437 promotion/demotion commands. It also influences how levels are
1438 handled by the exporters.
1439 Changing it requires restart of `font-lock-mode' to become effective
1440 for fontification also in regions already fontified.
1441 You may also set this on a per-file basis by adding one of the following
1442 lines to the buffer:
1444 #+STARTUP: odd
1445 #+STARTUP: oddeven"
1446 :group 'org-edit-structure
1447 :group 'org-appearance
1448 :type 'boolean)
1450 (defcustom org-adapt-indentation t
1451 "Non-nil means adapt indentation to outline node level.
1453 When this variable is set, Org assumes that you write outlines by
1454 indenting text in each node to align with the headline (after the
1455 stars). The following issues are influenced by this variable:
1457 - The indentation is increased by one space in a demotion
1458 command, and decreased by one in a promotion command. However,
1459 in the latter case, if shifting some line in the entry body
1460 would alter document structure (e.g., insert a new headline),
1461 indentation is not changed at all.
1463 - Property drawers and planning information is inserted indented
1464 when this variable is set. When nil, they will not be indented.
1466 - TAB indents a line relative to current level. The lines below
1467 a headline will be indented when this variable is set.
1469 Note that this is all about true indentation, by adding and
1470 removing space characters. See also `org-indent.el' which does
1471 level-dependent indentation in a virtual way, i.e. at display
1472 time in Emacs."
1473 :group 'org-edit-structure
1474 :type 'boolean)
1476 (defcustom org-special-ctrl-a/e nil
1477 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1479 When t, `C-a' will bring back the cursor to the beginning of the
1480 headline text, i.e. after the stars and after a possible TODO
1481 keyword. In an item, this will be the position after bullet and
1482 check-box, if any. When the cursor is already at that position,
1483 another `C-a' will bring it to the beginning of the line.
1485 `C-e' will jump to the end of the headline, ignoring the presence
1486 of tags in the headline. A second `C-e' will then jump to the
1487 true end of the line, after any tags. This also means that, when
1488 this variable is non-nil, `C-e' also will never jump beyond the
1489 end of the heading of a folded section, i.e. not after the
1490 ellipses.
1492 When set to the symbol `reversed', the first `C-a' or `C-e' works
1493 normally, going to the true line boundary first. Only a directly
1494 following, identical keypress will bring the cursor to the
1495 special positions.
1497 This may also be a cons cell where the behavior for `C-a' and
1498 `C-e' is set separately."
1499 :group 'org-edit-structure
1500 :type '(choice
1501 (const :tag "off" nil)
1502 (const :tag "on: after stars/bullet and before tags first" t)
1503 (const :tag "reversed: true line boundary first" reversed)
1504 (cons :tag "Set C-a and C-e separately"
1505 (choice :tag "Special C-a"
1506 (const :tag "off" nil)
1507 (const :tag "on: after stars/bullet first" t)
1508 (const :tag "reversed: before stars/bullet first" reversed))
1509 (choice :tag "Special C-e"
1510 (const :tag "off" nil)
1511 (const :tag "on: before tags first" t)
1512 (const :tag "reversed: after tags first" reversed)))))
1513 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1515 (defcustom org-special-ctrl-k nil
1516 "Non-nil means `C-k' will behave specially in headlines.
1517 When nil, `C-k' will call the default `kill-line' command.
1518 When t, the following will happen while the cursor is in the headline:
1520 - When the cursor is at the beginning of a headline, kill the entire
1521 line and possible the folded subtree below the line.
1522 - When in the middle of the headline text, kill the headline up to the tags.
1523 - When after the headline text, kill the tags."
1524 :group 'org-edit-structure
1525 :type 'boolean)
1527 (defcustom org-ctrl-k-protect-subtree nil
1528 "Non-nil means, do not delete a hidden subtree with C-k.
1529 When set to the symbol `error', simply throw an error when C-k is
1530 used to kill (part-of) a headline that has hidden text behind it.
1531 Any other non-nil value will result in a query to the user, if it is
1532 OK to kill that hidden subtree. When nil, kill without remorse."
1533 :group 'org-edit-structure
1534 :version "24.1"
1535 :type '(choice
1536 (const :tag "Do not protect hidden subtrees" nil)
1537 (const :tag "Protect hidden subtrees with a security query" t)
1538 (const :tag "Never kill a hidden subtree with C-k" error)))
1540 (defcustom org-special-ctrl-o t
1541 "Non-nil means, make `C-o' insert a row in tables."
1542 :group 'org-edit-structure
1543 :type 'boolean)
1545 (defcustom org-catch-invisible-edits nil
1546 "Check if in invisible region before inserting or deleting a character.
1547 Valid values are:
1549 nil Do not check, so just do invisible edits.
1550 error Throw an error and do nothing.
1551 show Make point visible, and do the requested edit.
1552 show-and-error Make point visible, then throw an error and abort the edit.
1553 smart Make point visible, and do insertion/deletion if it is
1554 adjacent to visible text and the change feels predictable.
1555 Never delete a previously invisible character or add in the
1556 middle or right after an invisible region. Basically, this
1557 allows insertion and backward-delete right before ellipses.
1558 FIXME: maybe in this case we should not even show?"
1559 :group 'org-edit-structure
1560 :version "24.1"
1561 :type '(choice
1562 (const :tag "Do not check" nil)
1563 (const :tag "Throw error when trying to edit" error)
1564 (const :tag "Unhide, but do not do the edit" show-and-error)
1565 (const :tag "Show invisible part and do the edit" show)
1566 (const :tag "Be smart and do the right thing" smart)))
1568 (defcustom org-yank-folded-subtrees t
1569 "Non-nil means when yanking subtrees, fold them.
1570 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1571 it starts with a heading and all other headings in it are either children
1572 or siblings, then fold all the subtrees. However, do this only if no
1573 text after the yank would be swallowed into a folded tree by this action."
1574 :group 'org-edit-structure
1575 :type 'boolean)
1577 (defcustom org-yank-adjusted-subtrees nil
1578 "Non-nil means when yanking subtrees, adjust the level.
1579 With this setting, `org-paste-subtree' is used to insert the subtree, see
1580 this function for details."
1581 :group 'org-edit-structure
1582 :type 'boolean)
1584 (defcustom org-M-RET-may-split-line '((default . t))
1585 "Non-nil means M-RET will split the line at the cursor position.
1586 When nil, it will go to the end of the line before making a
1587 new line.
1588 You may also set this option in a different way for different
1589 contexts. Valid contexts are:
1591 headline when creating a new headline
1592 item when creating a new item
1593 table in a table field
1594 default the value to be used for all contexts not explicitly
1595 customized"
1596 :group 'org-structure
1597 :group 'org-table
1598 :type '(choice
1599 (const :tag "Always" t)
1600 (const :tag "Never" nil)
1601 (repeat :greedy t :tag "Individual contexts"
1602 (cons
1603 (choice :tag "Context"
1604 (const headline)
1605 (const item)
1606 (const table)
1607 (const default))
1608 (boolean)))))
1611 (defcustom org-insert-heading-respect-content nil
1612 "Non-nil means insert new headings after the current subtree.
1613 When nil, the new heading is created directly after the current line.
1614 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1615 this variable on for the duration of the command."
1616 :group 'org-structure
1617 :type 'boolean)
1619 (defcustom org-blank-before-new-entry '((heading . auto)
1620 (plain-list-item . auto))
1621 "Should `org-insert-heading' leave a blank line before new heading/item?
1622 The value is an alist, with `heading' and `plain-list-item' as CAR,
1623 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1624 which case Org will look at the surrounding headings/items and try to
1625 make an intelligent decision whether to insert a blank line or not."
1626 :group 'org-edit-structure
1627 :type '(list
1628 (cons (const heading)
1629 (choice (const :tag "Never" nil)
1630 (const :tag "Always" t)
1631 (const :tag "Auto" auto)))
1632 (cons (const plain-list-item)
1633 (choice (const :tag "Never" nil)
1634 (const :tag "Always" t)
1635 (const :tag "Auto" auto)))))
1637 (defcustom org-insert-heading-hook nil
1638 "Hook being run after inserting a new heading."
1639 :group 'org-edit-structure
1640 :type 'hook)
1642 (defcustom org-enable-fixed-width-editor t
1643 "Non-nil means lines starting with \":\" are treated as fixed-width.
1644 This currently only means they are never auto-wrapped.
1645 When nil, such lines will be treated like ordinary lines."
1646 :group 'org-edit-structure
1647 :type 'boolean)
1649 (defcustom org-goto-auto-isearch t
1650 "Non-nil means typing characters in `org-goto' starts incremental search.
1651 When nil, you can use these keybindings to navigate the buffer:
1653 q Quit the org-goto interface
1654 n Go to the next visible heading
1655 p Go to the previous visible heading
1656 f Go one heading forward on same level
1657 b Go one heading backward on same level
1658 u Go one heading up"
1659 :group 'org-edit-structure
1660 :type 'boolean)
1662 (defgroup org-sparse-trees nil
1663 "Options concerning sparse trees in Org-mode."
1664 :tag "Org Sparse Trees"
1665 :group 'org-structure)
1667 (defcustom org-highlight-sparse-tree-matches t
1668 "Non-nil means highlight all matches that define a sparse tree.
1669 The highlights will automatically disappear the next time the buffer is
1670 changed by an edit command."
1671 :group 'org-sparse-trees
1672 :type 'boolean)
1674 (defcustom org-remove-highlights-with-change t
1675 "Non-nil means any change to the buffer will remove temporary highlights.
1676 Such highlights are created by `org-occur' and `org-clock-display'.
1677 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1678 The highlights created by `org-toggle-latex-fragment' always need
1679 `C-c C-x C-l' to be removed."
1680 :group 'org-sparse-trees
1681 :group 'org-time
1682 :type 'boolean)
1685 (defcustom org-occur-hook '(org-first-headline-recenter)
1686 "Hook that is run after `org-occur' has constructed a sparse tree.
1687 This can be used to recenter the window to show as much of the structure
1688 as possible."
1689 :group 'org-sparse-trees
1690 :type 'hook)
1692 (defgroup org-imenu-and-speedbar nil
1693 "Options concerning imenu and speedbar in Org-mode."
1694 :tag "Org Imenu and Speedbar"
1695 :group 'org-structure)
1697 (defcustom org-imenu-depth 2
1698 "The maximum level for Imenu access to Org-mode headlines.
1699 This also applied for speedbar access."
1700 :group 'org-imenu-and-speedbar
1701 :type 'integer)
1703 (defgroup org-table nil
1704 "Options concerning tables in Org-mode."
1705 :tag "Org Table"
1706 :group 'org)
1708 (defcustom org-enable-table-editor 'optimized
1709 "Non-nil means lines starting with \"|\" are handled by the table editor.
1710 When nil, such lines will be treated like ordinary lines.
1712 When equal to the symbol `optimized', the table editor will be optimized to
1713 do the following:
1714 - Automatic overwrite mode in front of whitespace in table fields.
1715 This makes the structure of the table stay in tact as long as the edited
1716 field does not exceed the column width.
1717 - Minimize the number of realigns. Normally, the table is aligned each time
1718 TAB or RET are pressed to move to another field. With optimization this
1719 happens only if changes to a field might have changed the column width.
1720 Optimization requires replacing the functions `self-insert-command',
1721 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1722 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1723 very good at guessing when a re-align will be necessary, but you can always
1724 force one with \\[org-ctrl-c-ctrl-c].
1726 If you would like to use the optimized version in Org-mode, but the
1727 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1729 This variable can be used to turn on and off the table editor during a session,
1730 but in order to toggle optimization, a restart is required.
1732 See also the variable `org-table-auto-blank-field'."
1733 :group 'org-table
1734 :type '(choice
1735 (const :tag "off" nil)
1736 (const :tag "on" t)
1737 (const :tag "on, optimized" optimized)))
1739 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1740 (version<= emacs-version "24.1"))
1741 "Non-nil means cluster self-insert commands for undo when possible.
1742 If this is set, then, like in the Emacs command loop, 20 consecutive
1743 characters will be undone together.
1744 This is configurable, because there is some impact on typing performance."
1745 :group 'org-table
1746 :type 'boolean)
1748 (defcustom org-table-tab-recognizes-table.el t
1749 "Non-nil means TAB will automatically notice a table.el table.
1750 When it sees such a table, it moves point into it and - if necessary -
1751 calls `table-recognize-table'."
1752 :group 'org-table-editing
1753 :type 'boolean)
1755 (defgroup org-link nil
1756 "Options concerning links in Org-mode."
1757 :tag "Org Link"
1758 :group 'org)
1760 (defvar org-link-abbrev-alist-local nil
1761 "Buffer-local version of `org-link-abbrev-alist', which see.
1762 The value of this is taken from the #+LINK lines.")
1763 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1765 (defcustom org-link-abbrev-alist nil
1766 "Alist of link abbreviations.
1767 The car of each element is a string, to be replaced at the start of a link.
1768 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1769 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1771 [[linkkey:tag][description]]
1773 The 'linkkey' must be a word word, starting with a letter, followed
1774 by letters, numbers, '-' or '_'.
1776 If REPLACE is a string, the tag will simply be appended to create the link.
1777 If the string contains \"%s\", the tag will be inserted there. If the string
1778 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1779 at that point (see the function `url-hexify-string'). If the string contains
1780 the specifier \"%(my-function)\", then the custom function `my-function' will
1781 be invoked: this function takes the tag as its only argument and must return
1782 a string.
1784 REPLACE may also be a function that will be called with the tag as the
1785 only argument to create the link, which should be returned as a string.
1787 See the manual for examples."
1788 :group 'org-link
1789 :type '(repeat
1790 (cons
1791 (string :tag "Protocol")
1792 (choice
1793 (string :tag "Format")
1794 (function)))))
1796 (defcustom org-descriptive-links t
1797 "Non-nil means Org will display descriptive links.
1798 E.g. [[http://orgmode.org][Org website]] will be displayed as
1799 \"Org Website\", hiding the link itself and just displaying its
1800 description. When set to nil, Org will display the full links
1801 literally.
1803 You can interactively set the value of this variable by calling
1804 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1805 :group 'org-link
1806 :type 'boolean)
1808 (defcustom org-link-file-path-type 'adaptive
1809 "How the path name in file links should be stored.
1810 Valid values are:
1812 relative Relative to the current directory, i.e. the directory of the file
1813 into which the link is being inserted.
1814 absolute Absolute path, if possible with ~ for home directory.
1815 noabbrev Absolute path, no abbreviation of home directory.
1816 adaptive Use relative path for files in the current directory and sub-
1817 directories of it. For other files, use an absolute path."
1818 :group 'org-link
1819 :type '(choice
1820 (const relative)
1821 (const absolute)
1822 (const noabbrev)
1823 (const adaptive)))
1825 (defvaralias 'org-activate-links 'org-highlight-links)
1826 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1827 "Types of links that should be highlighted in Org-mode files.
1829 This is a list of symbols, each one of them leading to the
1830 highlighting of a certain link type.
1832 You can still open links that are not highlighted.
1834 In principle, it does not hurt to turn on highlighting for all
1835 link types. There may be a small gain when turning off unused
1836 link types. The types are:
1838 bracket The recommended [[link][description]] or [[link]] links with hiding.
1839 angle Links in angular brackets that may contain whitespace like
1840 <bbdb:Carsten Dominik>.
1841 plain Plain links in normal text, no whitespace, like http://google.com.
1842 radio Text that is matched by a radio target, see manual for details.
1843 tag Tag settings in a headline (link to tag search).
1844 date Time stamps (link to calendar).
1845 footnote Footnote labels.
1847 If you set this variable during an Emacs session, use `org-mode-restart'
1848 in the Org buffer so that the change takes effect."
1849 :group 'org-link
1850 :group 'org-appearance
1851 :type '(set :greedy t
1852 (const :tag "Double bracket links" bracket)
1853 (const :tag "Angular bracket links" angle)
1854 (const :tag "Plain text links" plain)
1855 (const :tag "Radio target matches" radio)
1856 (const :tag "Tags" tag)
1857 (const :tag "Timestamps" date)
1858 (const :tag "Footnotes" footnote)))
1860 (defcustom org-make-link-description-function nil
1861 "Function to use for generating link descriptions from links.
1862 When nil, the link location will be used. This function must take
1863 two parameters: the first one is the link, the second one is the
1864 description generated by `org-insert-link'. The function should
1865 return the description to use."
1866 :group 'org-link
1867 :type '(choice (const nil) (function)))
1869 (defgroup org-link-store nil
1870 "Options concerning storing links in Org-mode."
1871 :tag "Org Store Link"
1872 :group 'org-link)
1874 (defcustom org-url-hexify-p t
1875 "When non-nil, hexify URL when creating a link."
1876 :type 'boolean
1877 :version "24.3"
1878 :group 'org-link-store)
1880 (defcustom org-email-link-description-format "Email %c: %.30s"
1881 "Format of the description part of a link to an email or usenet message.
1882 The following %-escapes will be replaced by corresponding information:
1884 %F full \"From\" field
1885 %f name, taken from \"From\" field, address if no name
1886 %T full \"To\" field
1887 %t first name in \"To\" field, address if no name
1888 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1889 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1890 %s subject
1891 %d date
1892 %m message-id.
1894 You may use normal field width specification between the % and the letter.
1895 This is for example useful to limit the length of the subject.
1897 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1898 :group 'org-link-store
1899 :type 'string)
1901 (defcustom org-from-is-user-regexp
1902 (let (r1 r2)
1903 (when (and user-mail-address (not (string= user-mail-address "")))
1904 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1905 (when (and user-full-name (not (string= user-full-name "")))
1906 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1907 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1908 "Regexp matched against the \"From:\" header of an email or usenet message.
1909 It should match if the message is from the user him/herself."
1910 :group 'org-link-store
1911 :type 'regexp)
1913 (defcustom org-context-in-file-links t
1914 "Non-nil means file links from `org-store-link' contain context.
1915 A search string will be added to the file name with :: as separator and
1916 used to find the context when the link is activated by the command
1917 `org-open-at-point'. When this option is t, the entire active region
1918 will be placed in the search string of the file link. If set to a
1919 positive integer, only the first n lines of context will be stored.
1921 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1922 negates this setting for the duration of the command."
1923 :group 'org-link-store
1924 :type '(choice boolean integer))
1926 (defcustom org-keep-stored-link-after-insertion nil
1927 "Non-nil means keep link in list for entire session.
1929 The command `org-store-link' adds a link pointing to the current
1930 location to an internal list. These links accumulate during a session.
1931 The command `org-insert-link' can be used to insert links into any
1932 Org-mode file (offering completion for all stored links). When this
1933 option is nil, every link which has been inserted once using \\[org-insert-link]
1934 will be removed from the list, to make completing the unused links
1935 more efficient."
1936 :group 'org-link-store
1937 :type 'boolean)
1939 (defgroup org-link-follow nil
1940 "Options concerning following links in Org-mode."
1941 :tag "Org Follow Link"
1942 :group 'org-link)
1944 (defcustom org-link-translation-function nil
1945 "Function to translate links with different syntax to Org syntax.
1946 This can be used to translate links created for example by the Planner
1947 or emacs-wiki packages to Org syntax.
1948 The function must accept two parameters, a TYPE containing the link
1949 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1950 which is everything after the link protocol. It should return a cons
1951 with possibly modified values of type and path.
1952 Org contains a function for this, so if you set this variable to
1953 `org-translate-link-from-planner', you should be able follow many
1954 links created by planner."
1955 :group 'org-link-follow
1956 :type '(choice (const nil) (function)))
1958 (defcustom org-follow-link-hook nil
1959 "Hook that is run after a link has been followed."
1960 :group 'org-link-follow
1961 :type 'hook)
1963 (defcustom org-tab-follows-link nil
1964 "Non-nil means on links TAB will follow the link.
1965 Needs to be set before org.el is loaded.
1966 This really should not be used, it does not make sense, and the
1967 implementation is bad."
1968 :group 'org-link-follow
1969 :type 'boolean)
1971 (defcustom org-return-follows-link nil
1972 "Non-nil means on links RET will follow the link.
1973 In tables, the special behavior of RET has precedence."
1974 :group 'org-link-follow
1975 :type 'boolean)
1977 (defcustom org-mouse-1-follows-link
1978 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1979 "Non-nil means mouse-1 on a link will follow the link.
1980 A longer mouse click will still set point. Does not work on XEmacs.
1981 Needs to be set before org.el is loaded."
1982 :group 'org-link-follow
1983 :version "24.4"
1984 :package-version '(Org . "8.3")
1985 :type '(choice
1986 (const :tag "A double click follows the link" double)
1987 (const :tag "Unconditionally follow the link with mouse-1" t)
1988 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1990 (defcustom org-mark-ring-length 4
1991 "Number of different positions to be recorded in the ring.
1992 Changing this requires a restart of Emacs to work correctly."
1993 :group 'org-link-follow
1994 :type 'integer)
1996 (defcustom org-link-search-must-match-exact-headline 'query-to-create
1997 "Non-nil means internal links in Org files must exactly match a headline.
1998 When nil, the link search tries to match a phrase with all words
1999 in the search text."
2000 :group 'org-link-follow
2001 :version "24.1"
2002 :type '(choice
2003 (const :tag "Use fuzzy text search" nil)
2004 (const :tag "Match only exact headline" t)
2005 (const :tag "Match exact headline or query to create it"
2006 query-to-create)))
2008 (defcustom org-link-frame-setup
2009 '((vm . vm-visit-folder-other-frame)
2010 (vm-imap . vm-visit-imap-folder-other-frame)
2011 (gnus . org-gnus-no-new-news)
2012 (file . find-file-other-window)
2013 (wl . wl-other-frame))
2014 "Setup the frame configuration for following links.
2015 When following a link with Emacs, it may often be useful to display
2016 this link in another window or frame. This variable can be used to
2017 set this up for the different types of links.
2018 For VM, use any of
2019 `vm-visit-folder'
2020 `vm-visit-folder-other-window'
2021 `vm-visit-folder-other-frame'
2022 For Gnus, use any of
2023 `gnus'
2024 `gnus-other-frame'
2025 `org-gnus-no-new-news'
2026 For FILE, use any of
2027 `find-file'
2028 `find-file-other-window'
2029 `find-file-other-frame'
2030 For Wanderlust use any of
2031 `wl'
2032 `wl-other-frame'
2033 For the calendar, use the variable `calendar-setup'.
2034 For BBDB, it is currently only possible to display the matches in
2035 another window."
2036 :group 'org-link-follow
2037 :type '(list
2038 (cons (const vm)
2039 (choice
2040 (const vm-visit-folder)
2041 (const vm-visit-folder-other-window)
2042 (const vm-visit-folder-other-frame)))
2043 (cons (const vm-imap)
2044 (choice
2045 (const vm-visit-imap-folder)
2046 (const vm-visit-imap-folder-other-window)
2047 (const vm-visit-imap-folder-other-frame)))
2048 (cons (const gnus)
2049 (choice
2050 (const gnus)
2051 (const gnus-other-frame)
2052 (const org-gnus-no-new-news)))
2053 (cons (const file)
2054 (choice
2055 (const find-file)
2056 (const find-file-other-window)
2057 (const find-file-other-frame)))
2058 (cons (const wl)
2059 (choice
2060 (const wl)
2061 (const wl-other-frame)))))
2063 (defcustom org-display-internal-link-with-indirect-buffer nil
2064 "Non-nil means use indirect buffer to display infile links.
2065 Activating internal links (from one location in a file to another location
2066 in the same file) normally just jumps to the location. When the link is
2067 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2068 is displayed in
2069 another window. When this option is set, the other window actually displays
2070 an indirect buffer clone of the current buffer, to avoid any visibility
2071 changes to the current buffer."
2072 :group 'org-link-follow
2073 :type 'boolean)
2075 (defcustom org-open-non-existing-files nil
2076 "Non-nil means `org-open-file' will open non-existing files.
2077 When nil, an error will be generated.
2078 This variable applies only to external applications because they
2079 might choke on non-existing files. If the link is to a file that
2080 will be opened in Emacs, the variable is ignored."
2081 :group 'org-link-follow
2082 :type 'boolean)
2084 (defcustom org-open-directory-means-index-dot-org nil
2085 "Non-nil means a link to a directory really means to index.org.
2086 When nil, following a directory link will run dired or open a finder/explorer
2087 window on that directory."
2088 :group 'org-link-follow
2089 :type 'boolean)
2091 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2092 "Non-nil means ask for confirmation before executing shell links.
2093 Shell links can be dangerous: just think about a link
2095 [[shell:rm -rf ~/*][Google Search]]
2097 This link would show up in your Org-mode document as \"Google Search\",
2098 but really it would remove your entire home directory.
2099 Therefore we advise against setting this variable to nil.
2100 Just change it to `y-or-n-p' if you want to confirm with a
2101 single keystroke rather than having to type \"yes\"."
2102 :group 'org-link-follow
2103 :type '(choice
2104 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2105 (const :tag "with y-or-n (faster)" y-or-n-p)
2106 (const :tag "no confirmation (dangerous)" nil)))
2107 (put 'org-confirm-shell-link-function
2108 'safe-local-variable
2109 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2111 (defcustom org-confirm-shell-link-not-regexp ""
2112 "A regexp to skip confirmation for shell links."
2113 :group 'org-link-follow
2114 :version "24.1"
2115 :type 'regexp)
2117 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2118 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2119 Elisp links can be dangerous: just think about a link
2121 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2123 This link would show up in your Org-mode document as \"Google Search\",
2124 but really it would remove your entire home directory.
2125 Therefore we advise against setting this variable to nil.
2126 Just change it to `y-or-n-p' if you want to confirm with a
2127 single keystroke rather than having to type \"yes\"."
2128 :group 'org-link-follow
2129 :type '(choice
2130 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2131 (const :tag "with y-or-n (faster)" y-or-n-p)
2132 (const :tag "no confirmation (dangerous)" nil)))
2133 (put 'org-confirm-shell-link-function
2134 'safe-local-variable
2135 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2137 (defcustom org-confirm-elisp-link-not-regexp ""
2138 "A regexp to skip confirmation for Elisp links."
2139 :group 'org-link-follow
2140 :version "24.1"
2141 :type 'regexp)
2143 (defconst org-file-apps-defaults-gnu
2144 '((remote . emacs)
2145 (system . mailcap)
2146 (t . mailcap))
2147 "Default file applications on a UNIX or GNU/Linux system.
2148 See `org-file-apps'.")
2150 (defconst org-file-apps-defaults-macosx
2151 '((remote . emacs)
2152 (t . "open %s")
2153 (system . "open %s")
2154 ("ps.gz" . "gv %s")
2155 ("eps.gz" . "gv %s")
2156 ("dvi" . "xdvi %s")
2157 ("fig" . "xfig %s"))
2158 "Default file applications on a MacOS X system.
2159 The system \"open\" is known as a default, but we use X11 applications
2160 for some files for which the OS does not have a good default.
2161 See `org-file-apps'.")
2163 (defconst org-file-apps-defaults-windowsnt
2164 (list
2165 '(remote . emacs)
2166 (cons t
2167 (list (if (featurep 'xemacs)
2168 'mswindows-shell-execute
2169 'w32-shell-execute)
2170 "open" 'file))
2171 (cons 'system
2172 (list (if (featurep 'xemacs)
2173 'mswindows-shell-execute
2174 'w32-shell-execute)
2175 "open" 'file)))
2176 "Default file applications on a Windows NT system.
2177 The system \"open\" is used for most files.
2178 See `org-file-apps'.")
2180 (defcustom org-file-apps
2181 '((auto-mode . emacs)
2182 ("\\.mm\\'" . default)
2183 ("\\.x?html?\\'" . default)
2184 ("\\.pdf\\'" . default))
2185 "External applications for opening `file:path' items in a document.
2186 Org-mode uses system defaults for different file types, but
2187 you can use this variable to set the application for a given file
2188 extension. The entries in this list are cons cells where the car identifies
2189 files and the cdr the corresponding command. Possible values for the
2190 file identifier are
2191 \"string\" A string as a file identifier can be interpreted in different
2192 ways, depending on its contents:
2194 - Alphanumeric characters only:
2195 Match links with this file extension.
2196 Example: (\"pdf\" . \"evince %s\")
2197 to open PDFs with evince.
2199 - Regular expression: Match links where the
2200 filename matches the regexp. If you want to
2201 use groups here, use shy groups.
2203 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2204 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2205 to open *.html and *.xhtml with firefox.
2207 - Regular expression which contains (non-shy) groups:
2208 Match links where the whole link, including \"::\", and
2209 anything after that, matches the regexp.
2210 In a custom command string, %1, %2, etc. are replaced with
2211 the parts of the link that were matched by the groups.
2212 For backwards compatibility, if a command string is given
2213 that does not use any of the group matches, this case is
2214 handled identically to the second one (i.e. match against
2215 file name only).
2216 In a custom lisp form, you can access the group matches with
2217 (match-string n link).
2219 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2220 to open [[file:document.pdf::5]] with evince at page 5.
2222 `directory' Matches a directory
2223 `remote' Matches a remote file, accessible through tramp or efs.
2224 Remote files most likely should be visited through Emacs
2225 because external applications cannot handle such paths.
2226 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2227 so all files Emacs knows how to handle. Using this with
2228 command `emacs' will open most files in Emacs. Beware that this
2229 will also open html files inside Emacs, unless you add
2230 (\"html\" . default) to the list as well.
2231 t Default for files not matched by any of the other options.
2232 `system' The system command to open files, like `open' on Windows
2233 and Mac OS X, and mailcap under GNU/Linux. This is the command
2234 that will be selected if you call `C-c C-o' with a double
2235 \\[universal-argument] \\[universal-argument] prefix.
2237 Possible values for the command are:
2238 `emacs' The file will be visited by the current Emacs process.
2239 `default' Use the default application for this file type, which is the
2240 association for t in the list, most likely in the system-specific
2241 part.
2242 This can be used to overrule an unwanted setting in the
2243 system-specific variable.
2244 `system' Use the system command for opening files, like \"open\".
2245 This command is specified by the entry whose car is `system'.
2246 Most likely, the system-specific version of this variable
2247 does define this command, but you can overrule/replace it
2248 here.
2249 string A command to be executed by a shell; %s will be replaced
2250 by the path to the file.
2251 sexp A Lisp form which will be evaluated. The file path will
2252 be available in the Lisp variable `file'.
2253 For more examples, see the system specific constants
2254 `org-file-apps-defaults-macosx'
2255 `org-file-apps-defaults-windowsnt'
2256 `org-file-apps-defaults-gnu'."
2257 :group 'org-link-follow
2258 :type '(repeat
2259 (cons (choice :value ""
2260 (string :tag "Extension")
2261 (const :tag "System command to open files" system)
2262 (const :tag "Default for unrecognized files" t)
2263 (const :tag "Remote file" remote)
2264 (const :tag "Links to a directory" directory)
2265 (const :tag "Any files that have Emacs modes"
2266 auto-mode))
2267 (choice :value ""
2268 (const :tag "Visit with Emacs" emacs)
2269 (const :tag "Use default" default)
2270 (const :tag "Use the system command" system)
2271 (string :tag "Command")
2272 (sexp :tag "Lisp form")))))
2274 (defcustom org-doi-server-url "http://dx.doi.org/"
2275 "The URL of the DOI server."
2276 :type 'string
2277 :version "24.3"
2278 :group 'org-link-follow)
2280 (defgroup org-refile nil
2281 "Options concerning refiling entries in Org-mode."
2282 :tag "Org Refile"
2283 :group 'org)
2285 (defcustom org-directory "~/org"
2286 "Directory with org files.
2287 This is just a default location to look for Org files. There is no need
2288 at all to put your files into this directory. It is only used in the
2289 following situations:
2291 1. When a capture template specifies a target file that is not an
2292 absolute path. The path will then be interpreted relative to
2293 `org-directory'
2294 2. When a capture note is filed away in an interactive way (when exiting the
2295 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2296 with `org-directory' as the default path."
2297 :group 'org-refile
2298 :group 'org-capture
2299 :type 'directory)
2301 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2302 "Default target for storing notes.
2303 Used as a fall back file for org-capture.el, for templates that
2304 do not specify a target file."
2305 :group 'org-refile
2306 :group 'org-capture
2307 :type 'file)
2309 (defcustom org-goto-interface 'outline
2310 "The default interface to be used for `org-goto'.
2311 Allowed values are:
2312 outline The interface shows an outline of the relevant file
2313 and the correct heading is found by moving through
2314 the outline or by searching with incremental search.
2315 outline-path-completion Headlines in the current buffer are offered via
2316 completion. This is the interface also used by
2317 the refile command."
2318 :group 'org-refile
2319 :type '(choice
2320 (const :tag "Outline" outline)
2321 (const :tag "Outline-path-completion" outline-path-completion)))
2323 (defcustom org-goto-max-level 5
2324 "Maximum target level when running `org-goto' with refile interface."
2325 :group 'org-refile
2326 :type 'integer)
2328 (defcustom org-reverse-note-order nil
2329 "Non-nil means store new notes at the beginning of a file or entry.
2330 When nil, new notes will be filed to the end of a file or entry.
2331 This can also be a list with cons cells of regular expressions that
2332 are matched against file names, and values."
2333 :group 'org-capture
2334 :group 'org-refile
2335 :type '(choice
2336 (const :tag "Reverse always" t)
2337 (const :tag "Reverse never" nil)
2338 (repeat :tag "By file name regexp"
2339 (cons regexp boolean))))
2341 (defcustom org-log-refile nil
2342 "Information to record when a task is refiled.
2344 Possible values are:
2346 nil Don't add anything
2347 time Add a time stamp to the task
2348 note Prompt for a note and add it with template `org-log-note-headings'
2350 This option can also be set with on a per-file-basis with
2352 #+STARTUP: nologrefile
2353 #+STARTUP: logrefile
2354 #+STARTUP: lognoterefile
2356 You can have local logging settings for a subtree by setting the LOGGING
2357 property to one or more of these keywords.
2359 When bulk-refiling from the agenda, the value `note' is forbidden and
2360 will temporarily be changed to `time'."
2361 :group 'org-refile
2362 :group 'org-progress
2363 :version "24.1"
2364 :type '(choice
2365 (const :tag "No logging" nil)
2366 (const :tag "Record timestamp" time)
2367 (const :tag "Record timestamp with note." note)))
2369 (defcustom org-refile-targets nil
2370 "Targets for refiling entries with \\[org-refile].
2371 This is a list of cons cells. Each cell contains:
2372 - a specification of the files to be considered, either a list of files,
2373 or a symbol whose function or variable value will be used to retrieve
2374 a file name or a list of file names. If you use `org-agenda-files' for
2375 that, all agenda files will be scanned for targets. Nil means consider
2376 headings in the current buffer.
2377 - A specification of how to find candidate refile targets. This may be
2378 any of:
2379 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2380 This tag has to be present in all target headlines, inheritance will
2381 not be considered.
2382 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2383 todo keyword.
2384 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2385 headlines that are refiling targets.
2386 - a cons cell (:level . N). Any headline of level N is considered a target.
2387 Note that, when `org-odd-levels-only' is set, level corresponds to
2388 order in hierarchy, not to the number of stars.
2389 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2390 Note that, when `org-odd-levels-only' is set, level corresponds to
2391 order in hierarchy, not to the number of stars.
2393 Each element of this list generates a set of possible targets.
2394 The union of these sets is presented (with completion) to
2395 the user by `org-refile'.
2397 You can set the variable `org-refile-target-verify-function' to a function
2398 to verify each headline found by the simple criteria above.
2400 When this variable is nil, all top-level headlines in the current buffer
2401 are used, equivalent to the value `((nil . (:level . 1))'."
2402 :group 'org-refile
2403 :type '(repeat
2404 (cons
2405 (choice :value org-agenda-files
2406 (const :tag "All agenda files" org-agenda-files)
2407 (const :tag "Current buffer" nil)
2408 (function) (variable) (file))
2409 (choice :tag "Identify target headline by"
2410 (cons :tag "Specific tag" (const :value :tag) (string))
2411 (cons :tag "TODO keyword" (const :value :todo) (string))
2412 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2413 (cons :tag "Level number" (const :value :level) (integer))
2414 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2416 (defcustom org-refile-target-verify-function nil
2417 "Function to verify if the headline at point should be a refile target.
2418 The function will be called without arguments, with point at the
2419 beginning of the headline. It should return t and leave point
2420 where it is if the headline is a valid target for refiling.
2422 If the target should not be selected, the function must return nil.
2423 In addition to this, it may move point to a place from where the search
2424 should be continued. For example, the function may decide that the entire
2425 subtree of the current entry should be excluded and move point to the end
2426 of the subtree."
2427 :group 'org-refile
2428 :type '(choice
2429 (const nil)
2430 (function)))
2432 (defcustom org-refile-use-cache nil
2433 "Non-nil means cache refile targets to speed up the process.
2434 The cache for a particular file will be updated automatically when
2435 the buffer has been killed, or when any of the marker used for flagging
2436 refile targets no longer points at a live buffer.
2437 If you have added new entries to a buffer that might themselves be targets,
2438 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2439 find that easier, `C-u C-u C-u C-c C-w'."
2440 :group 'org-refile
2441 :version "24.1"
2442 :type 'boolean)
2444 (defcustom org-refile-use-outline-path nil
2445 "Non-nil means provide refile targets as paths.
2446 So a level 3 headline will be available as level1/level2/level3.
2448 When the value is `file', also include the file name (without directory)
2449 into the path. In this case, you can also stop the completion after
2450 the file name, to get entries inserted as top level in the file.
2452 When `full-file-path', include the full file path."
2453 :group 'org-refile
2454 :type '(choice
2455 (const :tag "Not" nil)
2456 (const :tag "Yes" t)
2457 (const :tag "Start with file name" file)
2458 (const :tag "Start with full file path" full-file-path)))
2460 (defcustom org-outline-path-complete-in-steps t
2461 "Non-nil means complete the outline path in hierarchical steps.
2462 When Org-mode uses the refile interface to select an outline path
2463 \(see variable `org-refile-use-outline-path'), the completion of
2464 the path can be done in a single go, or it can be done in steps down
2465 the headline hierarchy. Going in steps is probably the best if you
2466 do not use a special completion package like `ido' or `icicles'.
2467 However, when using these packages, going in one step can be very
2468 fast, while still showing the whole path to the entry."
2469 :group 'org-refile
2470 :type 'boolean)
2472 (defcustom org-refile-allow-creating-parent-nodes nil
2473 "Non-nil means allow to create new nodes as refile targets.
2474 New nodes are then created by adding \"/new node name\" to the completion
2475 of an existing node. When the value of this variable is `confirm',
2476 new node creation must be confirmed by the user (recommended).
2477 When nil, the completion must match an existing entry.
2479 Note that, if the new heading is not seen by the criteria
2480 listed in `org-refile-targets', multiple instances of the same
2481 heading would be created by trying again to file under the new
2482 heading."
2483 :group 'org-refile
2484 :type '(choice
2485 (const :tag "Never" nil)
2486 (const :tag "Always" t)
2487 (const :tag "Prompt for confirmation" confirm)))
2489 (defcustom org-refile-active-region-within-subtree nil
2490 "Non-nil means also refile active region within a subtree.
2492 By default `org-refile' doesn't allow refiling regions if they
2493 don't contain a set of subtrees, but it might be convenient to
2494 do so sometimes: in that case, the first line of the region is
2495 converted to a headline before refiling."
2496 :group 'org-refile
2497 :version "24.1"
2498 :type 'boolean)
2500 (defgroup org-todo nil
2501 "Options concerning TODO items in Org-mode."
2502 :tag "Org TODO"
2503 :group 'org)
2505 (defgroup org-progress nil
2506 "Options concerning Progress logging in Org-mode."
2507 :tag "Org Progress"
2508 :group 'org-time)
2510 (defvar org-todo-interpretation-widgets
2511 '((:tag "Sequence (cycling hits every state)" sequence)
2512 (:tag "Type (cycling directly to DONE)" type))
2513 "The available interpretation symbols for customizing `org-todo-keywords'.
2514 Interested libraries should add to this list.")
2516 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2517 "List of TODO entry keyword sequences and their interpretation.
2518 \\<org-mode-map>This is a list of sequences.
2520 Each sequence starts with a symbol, either `sequence' or `type',
2521 indicating if the keywords should be interpreted as a sequence of
2522 action steps, or as different types of TODO items. The first
2523 keywords are states requiring action - these states will select a headline
2524 for inclusion into the global TODO list Org-mode produces. If one of
2525 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2526 signify that no further action is necessary. If \"|\" is not found,
2527 the last keyword is treated as the only DONE state of the sequence.
2529 The command \\[org-todo] cycles an entry through these states, and one
2530 additional state where no keyword is present. For details about this
2531 cycling, see the manual.
2533 TODO keywords and interpretation can also be set on a per-file basis with
2534 the special #+SEQ_TODO and #+TYP_TODO lines.
2536 Each keyword can optionally specify a character for fast state selection
2537 \(in combination with the variable `org-use-fast-todo-selection')
2538 and specifiers for state change logging, using the same syntax that
2539 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2540 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2541 indicates to record a time stamp each time this state is selected.
2543 Each keyword may also specify if a timestamp or a note should be
2544 recorded when entering or leaving the state, by adding additional
2545 characters in the parenthesis after the keyword. This looks like this:
2546 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2547 record only the time of the state change. With X and Y being either
2548 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2549 Y when leaving the state if and only if the *target* state does not
2550 define X. You may omit any of the fast-selection key or X or /Y,
2551 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2553 For backward compatibility, this variable may also be just a list
2554 of keywords. In this case the interpretation (sequence or type) will be
2555 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2556 :group 'org-todo
2557 :group 'org-keywords
2558 :type '(choice
2559 (repeat :tag "Old syntax, just keywords"
2560 (string :tag "Keyword"))
2561 (repeat :tag "New syntax"
2562 (cons
2563 (choice
2564 :tag "Interpretation"
2565 ;;Quick and dirty way to see
2566 ;;`org-todo-interpretations'. This takes the
2567 ;;place of item arguments
2568 :convert-widget
2569 (lambda (widget)
2570 (widget-put widget
2571 :args (mapcar
2572 (lambda (x)
2573 (widget-convert
2574 (cons 'const x)))
2575 org-todo-interpretation-widgets))
2576 widget))
2577 (repeat
2578 (string :tag "Keyword"))))))
2580 (defvar org-todo-keywords-1 nil
2581 "All TODO and DONE keywords active in a buffer.")
2582 (make-variable-buffer-local 'org-todo-keywords-1)
2583 (defvar org-todo-keywords-for-agenda nil)
2584 (defvar org-done-keywords-for-agenda nil)
2585 (defvar org-todo-keyword-alist-for-agenda nil)
2586 (defvar org-tag-alist-for-agenda nil
2587 "Alist of all tags from all agenda files.")
2588 (defvar org-tag-groups-alist-for-agenda nil
2589 "Alist of all groups tags from all current agenda files.")
2590 (defvar org-tag-groups-alist nil)
2591 (make-variable-buffer-local 'org-tag-groups-alist)
2592 (defvar org-agenda-contributing-files nil)
2593 (defvar org-not-done-keywords nil)
2594 (make-variable-buffer-local 'org-not-done-keywords)
2595 (defvar org-done-keywords nil)
2596 (make-variable-buffer-local 'org-done-keywords)
2597 (defvar org-todo-heads nil)
2598 (make-variable-buffer-local 'org-todo-heads)
2599 (defvar org-todo-sets nil)
2600 (make-variable-buffer-local 'org-todo-sets)
2601 (defvar org-todo-log-states nil)
2602 (make-variable-buffer-local 'org-todo-log-states)
2603 (defvar org-todo-kwd-alist nil)
2604 (make-variable-buffer-local 'org-todo-kwd-alist)
2605 (defvar org-todo-key-alist nil)
2606 (make-variable-buffer-local 'org-todo-key-alist)
2607 (defvar org-todo-key-trigger nil)
2608 (make-variable-buffer-local 'org-todo-key-trigger)
2610 (defcustom org-todo-interpretation 'sequence
2611 "Controls how TODO keywords are interpreted.
2612 This variable is in principle obsolete and is only used for
2613 backward compatibility, if the interpretation of todo keywords is
2614 not given already in `org-todo-keywords'. See that variable for
2615 more information."
2616 :group 'org-todo
2617 :group 'org-keywords
2618 :type '(choice (const sequence)
2619 (const type)))
2621 (defcustom org-use-fast-todo-selection t
2622 "Non-nil means use the fast todo selection scheme with C-c C-t.
2623 This variable describes if and under what circumstances the cycling
2624 mechanism for TODO keywords will be replaced by a single-key, direct
2625 selection scheme.
2627 When nil, fast selection is never used.
2629 When the symbol `prefix', it will be used when `org-todo' is called
2630 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2631 `C-u t' in an agenda buffer.
2633 When t, fast selection is used by default. In this case, the prefix
2634 argument forces cycling instead.
2636 In all cases, the special interface is only used if access keys have
2637 actually been assigned by the user, i.e. if keywords in the configuration
2638 are followed by a letter in parenthesis, like TODO(t)."
2639 :group 'org-todo
2640 :type '(choice
2641 (const :tag "Never" nil)
2642 (const :tag "By default" t)
2643 (const :tag "Only with C-u C-c C-t" prefix)))
2645 (defcustom org-provide-todo-statistics t
2646 "Non-nil means update todo statistics after insert and toggle.
2647 ALL-HEADLINES means update todo statistics by including headlines
2648 with no TODO keyword as well, counting them as not done.
2649 A list of TODO keywords means the same, but skip keywords that are
2650 not in this list.
2651 When set to a list of two lists, the first list contains keywords
2652 to consider as TODO keywords, the second list contains keywords
2653 to consider as DONE keywords.
2655 When this is set, todo statistics is updated in the parent of the
2656 current entry each time a todo state is changed."
2657 :group 'org-todo
2658 :type '(choice
2659 (const :tag "Yes, only for TODO entries" t)
2660 (const :tag "Yes, including all entries" all-headlines)
2661 (repeat :tag "Yes, for TODOs in this list"
2662 (string :tag "TODO keyword"))
2663 (list :tag "Yes, for TODOs and DONEs in these lists"
2664 (repeat (string :tag "TODO keyword"))
2665 (repeat (string :tag "DONE keyword")))
2666 (other :tag "No TODO statistics" nil)))
2668 (defcustom org-hierarchical-todo-statistics t
2669 "Non-nil means TODO statistics covers just direct children.
2670 When nil, all entries in the subtree are considered.
2671 This has only an effect if `org-provide-todo-statistics' is set.
2672 To set this to nil for only a single subtree, use a COOKIE_DATA
2673 property and include the word \"recursive\" into the value."
2674 :group 'org-todo
2675 :type 'boolean)
2677 (defcustom org-after-todo-state-change-hook nil
2678 "Hook which is run after the state of a TODO item was changed.
2679 The new state (a string with a TODO keyword, or nil) is available in the
2680 Lisp variable `org-state'."
2681 :group 'org-todo
2682 :type 'hook)
2684 (defvar org-blocker-hook nil
2685 "Hook for functions that are allowed to block a state change.
2687 Functions in this hook should not modify the buffer.
2688 Each function gets as its single argument a property list,
2689 see `org-trigger-hook' for more information about this list.
2691 If any of the functions in this hook returns nil, the state change
2692 is blocked.")
2694 (defvar org-trigger-hook nil
2695 "Hook for functions that are triggered by a state change.
2697 Each function gets as its single argument a property list with at
2698 least the following elements:
2700 (:type type-of-change :position pos-at-entry-start
2701 :from old-state :to new-state)
2703 Depending on the type, more properties may be present.
2705 This mechanism is currently implemented for:
2707 TODO state changes
2708 ------------------
2709 :type todo-state-change
2710 :from previous state (keyword as a string), or nil, or a symbol
2711 'todo' or 'done', to indicate the general type of state.
2712 :to new state, like in :from")
2714 (defcustom org-enforce-todo-dependencies nil
2715 "Non-nil means undone TODO entries will block switching the parent to DONE.
2716 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2717 be blocked if any prior sibling is not yet done.
2718 Finally, if the parent is blocked because of ordered siblings of its own,
2719 the child will also be blocked."
2720 :set (lambda (var val)
2721 (set var val)
2722 (if val
2723 (add-hook 'org-blocker-hook
2724 'org-block-todo-from-children-or-siblings-or-parent)
2725 (remove-hook 'org-blocker-hook
2726 'org-block-todo-from-children-or-siblings-or-parent)))
2727 :group 'org-todo
2728 :type 'boolean)
2730 (defcustom org-enforce-todo-checkbox-dependencies nil
2731 "Non-nil means unchecked boxes will block switching the parent to DONE.
2732 When this is nil, checkboxes have no influence on switching TODO states.
2733 When non-nil, you first need to check off all check boxes before the TODO
2734 entry can be switched to DONE.
2735 This variable needs to be set before org.el is loaded, and you need to
2736 restart Emacs after a change to make the change effective. The only way
2737 to change is while Emacs is running is through the customize interface."
2738 :set (lambda (var val)
2739 (set var val)
2740 (if val
2741 (add-hook 'org-blocker-hook
2742 'org-block-todo-from-checkboxes)
2743 (remove-hook 'org-blocker-hook
2744 'org-block-todo-from-checkboxes)))
2745 :group 'org-todo
2746 :type 'boolean)
2748 (defcustom org-treat-insert-todo-heading-as-state-change nil
2749 "Non-nil means inserting a TODO heading is treated as state change.
2750 So when the command \\[org-insert-todo-heading] is used, state change
2751 logging will apply if appropriate. When nil, the new TODO item will
2752 be inserted directly, and no logging will take place."
2753 :group 'org-todo
2754 :type 'boolean)
2756 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2757 "Non-nil means switching TODO states with S-cursor counts as state change.
2758 This is the default behavior. However, setting this to nil allows a
2759 convenient way to select a TODO state and bypass any logging associated
2760 with that."
2761 :group 'org-todo
2762 :type 'boolean)
2764 (defcustom org-todo-state-tags-triggers nil
2765 "Tag changes that should be triggered by TODO state changes.
2766 This is a list. Each entry is
2768 (state-change (tag . flag) .......)
2770 State-change can be a string with a state, and empty string to indicate the
2771 state that has no TODO keyword, or it can be one of the symbols `todo'
2772 or `done', meaning any not-done or done state, respectively."
2773 :group 'org-todo
2774 :group 'org-tags
2775 :type '(repeat
2776 (cons (choice :tag "When changing to"
2777 (const :tag "Not-done state" todo)
2778 (const :tag "Done state" done)
2779 (string :tag "State"))
2780 (repeat
2781 (cons :tag "Tag action"
2782 (string :tag "Tag")
2783 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2785 (defcustom org-log-done nil
2786 "Information to record when a task moves to the DONE state.
2788 Possible values are:
2790 nil Don't add anything, just change the keyword
2791 time Add a time stamp to the task
2792 note Prompt for a note and add it with template `org-log-note-headings'
2794 This option can also be set with on a per-file-basis with
2796 #+STARTUP: nologdone
2797 #+STARTUP: logdone
2798 #+STARTUP: lognotedone
2800 You can have local logging settings for a subtree by setting the LOGGING
2801 property to one or more of these keywords."
2802 :group 'org-todo
2803 :group 'org-progress
2804 :type '(choice
2805 (const :tag "No logging" nil)
2806 (const :tag "Record CLOSED timestamp" time)
2807 (const :tag "Record CLOSED timestamp with note." note)))
2809 ;; Normalize old uses of org-log-done.
2810 (cond
2811 ((eq org-log-done t) (setq org-log-done 'time))
2812 ((and (listp org-log-done) (memq 'done org-log-done))
2813 (setq org-log-done 'note)))
2815 (defcustom org-log-reschedule nil
2816 "Information to record when the scheduling date of a tasks is modified.
2818 Possible values are:
2820 nil Don't add anything, just change the date
2821 time Add a time stamp to the task
2822 note Prompt for a note and add it with template `org-log-note-headings'
2824 This option can also be set with on a per-file-basis with
2826 #+STARTUP: nologreschedule
2827 #+STARTUP: logreschedule
2828 #+STARTUP: lognotereschedule"
2829 :group 'org-todo
2830 :group 'org-progress
2831 :type '(choice
2832 (const :tag "No logging" nil)
2833 (const :tag "Record timestamp" time)
2834 (const :tag "Record timestamp with note." note)))
2836 (defcustom org-log-redeadline nil
2837 "Information to record when the deadline date of a tasks is modified.
2839 Possible values are:
2841 nil Don't add anything, just change the date
2842 time Add a time stamp to the task
2843 note Prompt for a note and add it with template `org-log-note-headings'
2845 This option can also be set with on a per-file-basis with
2847 #+STARTUP: nologredeadline
2848 #+STARTUP: logredeadline
2849 #+STARTUP: lognoteredeadline
2851 You can have local logging settings for a subtree by setting the LOGGING
2852 property to one or more of these keywords."
2853 :group 'org-todo
2854 :group 'org-progress
2855 :type '(choice
2856 (const :tag "No logging" nil)
2857 (const :tag "Record timestamp" time)
2858 (const :tag "Record timestamp with note." note)))
2860 (defcustom org-log-note-clock-out nil
2861 "Non-nil means record a note when clocking out of an item.
2862 This can also be configured on a per-file basis by adding one of
2863 the following lines anywhere in the buffer:
2865 #+STARTUP: lognoteclock-out
2866 #+STARTUP: nolognoteclock-out"
2867 :group 'org-todo
2868 :group 'org-progress
2869 :type 'boolean)
2871 (defcustom org-log-done-with-time t
2872 "Non-nil means the CLOSED time stamp will contain date and time.
2873 When nil, only the date will be recorded."
2874 :group 'org-progress
2875 :type 'boolean)
2877 (defcustom org-log-note-headings
2878 '((done . "CLOSING NOTE %t")
2879 (state . "State %-12s from %-12S %t")
2880 (note . "Note taken on %t")
2881 (reschedule . "Rescheduled from %S on %t")
2882 (delschedule . "Not scheduled, was %S on %t")
2883 (redeadline . "New deadline from %S on %t")
2884 (deldeadline . "Removed deadline, was %S on %t")
2885 (refile . "Refiled on %t")
2886 (clock-out . ""))
2887 "Headings for notes added to entries.
2889 The value is an alist, with the car being a symbol indicating the
2890 note context, and the cdr is the heading to be used. The heading
2891 may also be the empty string. The following placeholders can be
2892 used:
2894 %t a time stamp.
2895 %T an active time stamp instead the default inactive one
2896 %d a short-format time stamp.
2897 %D an active short-format time stamp.
2898 %s the new TODO state or time stamp (inactive), in double quotes.
2899 %S the old TODO state or time stamp (inactive), in double quotes.
2900 %u the user name.
2901 %U full user name.
2903 In fact, it is not a good idea to change the `state' entry,
2904 because Agenda Log mode depends on the format of these entries."
2905 :group 'org-todo
2906 :group 'org-progress
2907 :type '(list :greedy t
2908 (cons (const :tag "Heading when closing an item" done) string)
2909 (cons (const :tag
2910 "Heading when changing todo state (todo sequence only)"
2911 state) string)
2912 (cons (const :tag "Heading when just taking a note" note) string)
2913 (cons (const :tag "Heading when rescheduling" reschedule) string)
2914 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2915 (cons (const :tag "Heading when changing deadline" redeadline) string)
2916 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2917 (cons (const :tag "Heading when refiling" refile) string)
2918 (cons (const :tag "Heading when clocking out" clock-out) string)))
2920 (unless (assq 'note org-log-note-headings)
2921 (push '(note . "%t") org-log-note-headings))
2923 (defcustom org-log-into-drawer nil
2924 "Non-nil means insert state change notes and time stamps into a drawer.
2925 When nil, state changes notes will be inserted after the headline and
2926 any scheduling and clock lines, but not inside a drawer.
2928 The value of this variable should be the name of the drawer to use.
2929 LOGBOOK is proposed as the default drawer for this purpose, you can
2930 also set this to a string to define the drawer of your choice.
2932 A value of t is also allowed, representing \"LOGBOOK\".
2934 A value of t or nil can also be set with on a per-file-basis with
2936 #+STARTUP: logdrawer
2937 #+STARTUP: nologdrawer
2939 If this variable is set, `org-log-state-notes-insert-after-drawers'
2940 will be ignored.
2942 You can set the property LOG_INTO_DRAWER to overrule this setting for
2943 a subtree.
2945 Do not check directly this variable in a Lisp program. Call
2946 function `org-log-into-drawer' instead."
2947 :group 'org-todo
2948 :group 'org-progress
2949 :type '(choice
2950 (const :tag "Not into a drawer" nil)
2951 (const :tag "LOGBOOK" t)
2952 (string :tag "Other")))
2954 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2956 (defun org-log-into-drawer ()
2957 "Name of the log drawer, as a string, or nil.
2958 This is the value of `org-log-into-drawer'. However, if the
2959 current entry has or inherits a LOG_INTO_DRAWER property, it will
2960 be used instead of the default value."
2961 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2962 (cond ((equal p "nil") nil)
2963 ((equal p "t") "LOGBOOK")
2964 ((stringp p) p)
2965 (p "LOGBOOK")
2966 ((stringp org-log-into-drawer) org-log-into-drawer)
2967 (org-log-into-drawer "LOGBOOK"))))
2969 (defcustom org-log-state-notes-insert-after-drawers nil
2970 "Non-nil means insert state change notes after any drawers in entry.
2971 Only the drawers that *immediately* follow the headline and the
2972 deadline/scheduled line are skipped.
2973 When nil, insert notes right after the heading and perhaps the line
2974 with deadline/scheduling if present.
2976 This variable will have no effect if `org-log-into-drawer' is
2977 set."
2978 :group 'org-todo
2979 :group 'org-progress
2980 :type 'boolean)
2982 (defcustom org-log-states-order-reversed t
2983 "Non-nil means the latest state note will be directly after heading.
2984 When nil, the state change notes will be ordered according to time.
2986 This option can also be set with on a per-file-basis with
2988 #+STARTUP: logstatesreversed
2989 #+STARTUP: nologstatesreversed"
2990 :group 'org-todo
2991 :group 'org-progress
2992 :type 'boolean)
2994 (defcustom org-todo-repeat-to-state nil
2995 "The TODO state to which a repeater should return the repeating task.
2996 By default this is the first task in a TODO sequence, or the previous state
2997 in a TODO_TYP set. But you can specify another task here.
2998 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2999 :group 'org-todo
3000 :version "24.1"
3001 :type '(choice (const :tag "Head of sequence" nil)
3002 (string :tag "Specific state")))
3004 (defcustom org-log-repeat 'time
3005 "Non-nil means record moving through the DONE state when triggering repeat.
3006 An auto-repeating task is immediately switched back to TODO when
3007 marked DONE. If you are not logging state changes (by adding \"@\"
3008 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3009 record a closing note, there will be no record of the task moving
3010 through DONE. This variable forces taking a note anyway.
3012 nil Don't force a record
3013 time Record a time stamp
3014 note Prompt for a note and add it with template `org-log-note-headings'
3016 This option can also be set with on a per-file-basis with
3018 #+STARTUP: nologrepeat
3019 #+STARTUP: logrepeat
3020 #+STARTUP: lognoterepeat
3022 You can have local logging settings for a subtree by setting the LOGGING
3023 property to one or more of these keywords."
3024 :group 'org-todo
3025 :group 'org-progress
3026 :type '(choice
3027 (const :tag "Don't force a record" nil)
3028 (const :tag "Force recording the DONE state" time)
3029 (const :tag "Force recording a note with the DONE state" note)))
3032 (defgroup org-priorities nil
3033 "Priorities in Org-mode."
3034 :tag "Org Priorities"
3035 :group 'org-todo)
3037 (defcustom org-enable-priority-commands t
3038 "Non-nil means priority commands are active.
3039 When nil, these commands will be disabled, so that you never accidentally
3040 set a priority."
3041 :group 'org-priorities
3042 :type 'boolean)
3044 (defcustom org-highest-priority ?A
3045 "The highest priority of TODO items. A character like ?A, ?B etc.
3046 Must have a smaller ASCII number than `org-lowest-priority'."
3047 :group 'org-priorities
3048 :type 'character)
3050 (defcustom org-lowest-priority ?C
3051 "The lowest priority of TODO items. A character like ?A, ?B etc.
3052 Must have a larger ASCII number than `org-highest-priority'."
3053 :group 'org-priorities
3054 :type 'character)
3056 (defcustom org-default-priority ?B
3057 "The default priority of TODO items.
3058 This is the priority an item gets if no explicit priority is given.
3059 When starting to cycle on an empty priority the first step in the cycle
3060 depends on `org-priority-start-cycle-with-default'. The resulting first
3061 step priority must not exceed the range from `org-highest-priority' to
3062 `org-lowest-priority' which means that `org-default-priority' has to be
3063 in this range exclusive or inclusive the range boundaries. Else the
3064 first step refuses to set the default and the second will fall back
3065 to (depending on the command used) the highest or lowest priority."
3066 :group 'org-priorities
3067 :type 'character)
3069 (defcustom org-priority-start-cycle-with-default t
3070 "Non-nil means start with default priority when starting to cycle.
3071 When this is nil, the first step in the cycle will be (depending on the
3072 command used) one higher or lower than the default priority.
3073 See also `org-default-priority'."
3074 :group 'org-priorities
3075 :type 'boolean)
3077 (defcustom org-get-priority-function nil
3078 "Function to extract the priority from a string.
3079 The string is normally the headline. If this is nil Org computes the
3080 priority from the priority cookie like [#A] in the headline. It returns
3081 an integer, increasing by 1000 for each priority level.
3082 The user can set a different function here, which should take a string
3083 as an argument and return the numeric priority."
3084 :group 'org-priorities
3085 :version "24.1"
3086 :type '(choice
3087 (const nil)
3088 (function)))
3090 (defgroup org-time nil
3091 "Options concerning time stamps and deadlines in Org-mode."
3092 :tag "Org Time"
3093 :group 'org)
3095 (defcustom org-time-stamp-rounding-minutes '(0 5)
3096 "Number of minutes to round time stamps to.
3097 These are two values, the first applies when first creating a time stamp.
3098 The second applies when changing it with the commands `S-up' and `S-down'.
3099 When changing the time stamp, this means that it will change in steps
3100 of N minutes, as given by the second value.
3102 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3103 numbers should be factors of 60, so for example 5, 10, 15.
3105 When this is larger than 1, you can still force an exact time stamp by using
3106 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3107 and by using a prefix arg to `S-up/down' to specify the exact number
3108 of minutes to shift."
3109 :group 'org-time
3110 :get (lambda (var) ; Make sure both elements are there
3111 (if (integerp (default-value var))
3112 (list (default-value var) 5)
3113 (default-value var)))
3114 :type '(list
3115 (integer :tag "when inserting times")
3116 (integer :tag "when modifying times")))
3118 ;; Normalize old customizations of this variable.
3119 (when (integerp org-time-stamp-rounding-minutes)
3120 (setq org-time-stamp-rounding-minutes
3121 (list org-time-stamp-rounding-minutes
3122 org-time-stamp-rounding-minutes)))
3124 (defcustom org-display-custom-times nil
3125 "Non-nil means overlay custom formats over all time stamps.
3126 The formats are defined through the variable `org-time-stamp-custom-formats'.
3127 To turn this on on a per-file basis, insert anywhere in the file:
3128 #+STARTUP: customtime"
3129 :group 'org-time
3130 :set 'set-default
3131 :type 'sexp)
3132 (make-variable-buffer-local 'org-display-custom-times)
3134 (defcustom org-time-stamp-custom-formats
3135 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3136 "Custom formats for time stamps. See `format-time-string' for the syntax.
3137 These are overlaid over the default ISO format if the variable
3138 `org-display-custom-times' is set. Time like %H:%M should be at the
3139 end of the second format. The custom formats are also honored by export
3140 commands, if custom time display is turned on at the time of export."
3141 :group 'org-time
3142 :type 'sexp)
3144 (defun org-time-stamp-format (&optional long inactive)
3145 "Get the right format for a time string."
3146 (let ((f (if long (cdr org-time-stamp-formats)
3147 (car org-time-stamp-formats))))
3148 (if inactive
3149 (concat "[" (substring f 1 -1) "]")
3150 f)))
3152 (defcustom org-time-clocksum-format
3153 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3154 "The format string used when creating CLOCKSUM lines.
3155 This is also used when Org mode generates a time duration.
3157 The value can be a single format string containing two
3158 %-sequences, which will be filled with the number of hours and
3159 minutes in that order.
3161 Alternatively, the value can be a plist associating any of the
3162 keys :years, :months, :weeks, :days, :hours or :minutes with
3163 format strings. The time duration is formatted using only the
3164 time components that are needed and concatenating the results.
3165 If a time unit in absent, it falls back to the next smallest
3166 unit.
3168 The keys :require-years, :require-months, :require-days,
3169 :require-weeks, :require-hours, :require-minutes are also
3170 meaningful. A non-nil value for these keys indicates that the
3171 corresponding time component should always be included, even if
3172 its value is 0.
3175 For example,
3177 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3178 :require-minutes t)
3180 means durations longer than a day will be expressed in days,
3181 hours and minutes, and durations less than a day will always be
3182 expressed in hours and minutes (even for durations less than an
3183 hour).
3185 The value
3187 \(:days \"%dd\" :minutes \"%dm\")
3189 means durations longer than a day will be expressed in days and
3190 minutes, and durations less than a day will be expressed entirely
3191 in minutes (even for durations longer than an hour)."
3192 :group 'org-time
3193 :group 'org-clock
3194 :version "24.4"
3195 :package-version '(Org . "8.0")
3196 :type '(choice (string :tag "Format string")
3197 (set :tag "Plist"
3198 (group :inline t (const :tag "Years" :years)
3199 (string :tag "Format string"))
3200 (group :inline t
3201 (const :tag "Always show years" :require-years)
3202 (const t))
3203 (group :inline t (const :tag "Months" :months)
3204 (string :tag "Format string"))
3205 (group :inline t
3206 (const :tag "Always show months" :require-months)
3207 (const t))
3208 (group :inline t (const :tag "Weeks" :weeks)
3209 (string :tag "Format string"))
3210 (group :inline t
3211 (const :tag "Always show weeks" :require-weeks)
3212 (const t))
3213 (group :inline t (const :tag "Days" :days)
3214 (string :tag "Format string"))
3215 (group :inline t
3216 (const :tag "Always show days" :require-days)
3217 (const t))
3218 (group :inline t (const :tag "Hours" :hours)
3219 (string :tag "Format string"))
3220 (group :inline t
3221 (const :tag "Always show hours" :require-hours)
3222 (const t))
3223 (group :inline t (const :tag "Minutes" :minutes)
3224 (string :tag "Format string"))
3225 (group :inline t
3226 (const :tag "Always show minutes" :require-minutes)
3227 (const t)))))
3229 (defcustom org-time-clocksum-use-fractional nil
3230 "When non-nil, \\[org-clock-display] uses fractional times.
3231 See `org-time-clocksum-format' for more on time clock formats."
3232 :group 'org-time
3233 :group 'org-clock
3234 :version "24.3"
3235 :type 'boolean)
3237 (defcustom org-time-clocksum-use-effort-durations nil
3238 "When non-nil, \\[org-clock-display] uses effort durations.
3239 E.g. by default, one day is considered to be a 8 hours effort,
3240 so a task that has been clocked for 16 hours will be displayed
3241 as during 2 days in the clock display or in the clocktable.
3243 See `org-effort-durations' on how to set effort durations
3244 and `org-time-clocksum-format' for more on time clock formats."
3245 :group 'org-time
3246 :group 'org-clock
3247 :version "24.4"
3248 :package-version '(Org . "8.0")
3249 :type 'boolean)
3251 (defcustom org-time-clocksum-fractional-format "%.2f"
3252 "The format string used when creating CLOCKSUM lines,
3253 or when Org mode generates a time duration, if
3254 `org-time-clocksum-use-fractional' is enabled.
3256 The value can be a single format string containing one
3257 %-sequence, which will be filled with the number of hours as
3258 a float.
3260 Alternatively, the value can be a plist associating any of the
3261 keys :years, :months, :weeks, :days, :hours or :minutes with
3262 a format string. The time duration is formatted using the
3263 largest time unit which gives a non-zero integer part. If all
3264 specified formats have zero integer part, the smallest time unit
3265 is used."
3266 :group 'org-time
3267 :type '(choice (string :tag "Format string")
3268 (set (group :inline t (const :tag "Years" :years)
3269 (string :tag "Format string"))
3270 (group :inline t (const :tag "Months" :months)
3271 (string :tag "Format string"))
3272 (group :inline t (const :tag "Weeks" :weeks)
3273 (string :tag "Format string"))
3274 (group :inline t (const :tag "Days" :days)
3275 (string :tag "Format string"))
3276 (group :inline t (const :tag "Hours" :hours)
3277 (string :tag "Format string"))
3278 (group :inline t (const :tag "Minutes" :minutes)
3279 (string :tag "Format string")))))
3281 (defcustom org-deadline-warning-days 14
3282 "Number of days before expiration during which a deadline becomes active.
3283 This variable governs the display in sparse trees and in the agenda.
3284 When 0 or negative, it means use this number (the absolute value of it)
3285 even if a deadline has a different individual lead time specified.
3287 Custom commands can set this variable in the options section."
3288 :group 'org-time
3289 :group 'org-agenda-daily/weekly
3290 :type 'integer)
3292 (defcustom org-scheduled-delay-days 0
3293 "Number of days before a scheduled item becomes active.
3294 This variable governs the display in sparse trees and in the agenda.
3295 The default value (i.e. 0) means: don't delay scheduled item.
3296 When negative, it means use this number (the absolute value of it)
3297 even if a scheduled item has a different individual delay time
3298 specified.
3300 Custom commands can set this variable in the options section."
3301 :group 'org-time
3302 :group 'org-agenda-daily/weekly
3303 :version "24.4"
3304 :package-version '(Org . "8.0")
3305 :type 'integer)
3307 (defcustom org-read-date-prefer-future t
3308 "Non-nil means assume future for incomplete date input from user.
3309 This affects the following situations:
3310 1. The user gives a month but not a year.
3311 For example, if it is April and you enter \"feb 2\", this will be read
3312 as Feb 2, *next* year. \"May 5\", however, will be this year.
3313 2. The user gives a day, but no month.
3314 For example, if today is the 15th, and you enter \"3\", Org-mode will
3315 read this as the third of *next* month. However, if you enter \"17\",
3316 it will be considered as *this* month.
3318 If you set this variable to the symbol `time', then also the following
3319 will work:
3321 3. If the user gives a time.
3322 If the time is before now, it will be interpreted as tomorrow.
3324 Currently none of this works for ISO week specifications.
3326 When this option is nil, the current day, month and year will always be
3327 used as defaults.
3329 See also `org-agenda-jump-prefer-future'."
3330 :group 'org-time
3331 :type '(choice
3332 (const :tag "Never" nil)
3333 (const :tag "Check month and day" t)
3334 (const :tag "Check month, day, and time" time)))
3336 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3337 "Should the agenda jump command prefer the future for incomplete dates?
3338 The default is to do the same as configured in `org-read-date-prefer-future'.
3339 But you can also set a deviating value here.
3340 This may t or nil, or the symbol `org-read-date-prefer-future'."
3341 :group 'org-agenda
3342 :group 'org-time
3343 :version "24.1"
3344 :type '(choice
3345 (const :tag "Use org-read-date-prefer-future"
3346 org-read-date-prefer-future)
3347 (const :tag "Never" nil)
3348 (const :tag "Always" t)))
3350 (defcustom org-read-date-force-compatible-dates t
3351 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3353 Depending on the system Emacs is running on, certain dates cannot
3354 be represented with the type used internally to represent time.
3355 Dates between 1970-1-1 and 2038-1-1 can always be represented
3356 correctly. Some systems allow for earlier dates, some for later,
3357 some for both. One way to find out it to insert any date into an
3358 Org buffer, putting the cursor on the year and hitting S-up and
3359 S-down to test the range.
3361 When this variable is set to t, the date/time prompt will not let
3362 you specify dates outside the 1970-2037 range, so it is certain that
3363 these dates will work in whatever version of Emacs you are
3364 running, and also that you can move a file from one Emacs implementation
3365 to another. WHenever Org is forcing the year for you, it will display
3366 a message and beep.
3368 When this variable is nil, Org will check if the date is
3369 representable in the specific Emacs implementation you are using.
3370 If not, it will force a year, usually the current year, and beep
3371 to remind you. Currently this setting is not recommended because
3372 the likelihood that you will open your Org files in an Emacs that
3373 has limited date range is not negligible.
3375 A workaround for this problem is to use diary sexp dates for time
3376 stamps outside of this range."
3377 :group 'org-time
3378 :version "24.1"
3379 :type 'boolean)
3381 (defcustom org-read-date-display-live t
3382 "Non-nil means display current interpretation of date prompt live.
3383 This display will be in an overlay, in the minibuffer."
3384 :group 'org-time
3385 :type 'boolean)
3387 (defcustom org-read-date-popup-calendar t
3388 "Non-nil means pop up a calendar when prompting for a date.
3389 In the calendar, the date can be selected with mouse-1. However, the
3390 minibuffer will also be active, and you can simply enter the date as well.
3391 When nil, only the minibuffer will be available."
3392 :group 'org-time
3393 :type 'boolean)
3394 (org-defvaralias 'org-popup-calendar-for-date-prompt
3395 'org-read-date-popup-calendar)
3397 (make-obsolete-variable
3398 'org-read-date-minibuffer-setup-hook
3399 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3400 (defcustom org-read-date-minibuffer-setup-hook nil
3401 "Hook to be used to set up keys for the date/time interface.
3402 Add key definitions to `minibuffer-local-map', which will be a
3403 temporary copy.
3405 WARNING: This option is obsolete, you should use
3406 `org-read-date-minibuffer-local-map' to set up keys."
3407 :group 'org-time
3408 :type 'hook)
3410 (defcustom org-extend-today-until 0
3411 "The hour when your day really ends. Must be an integer.
3412 This has influence for the following applications:
3413 - When switching the agenda to \"today\". It it is still earlier than
3414 the time given here, the day recognized as TODAY is actually yesterday.
3415 - When a date is read from the user and it is still before the time given
3416 here, the current date and time will be assumed to be yesterday, 23:59.
3417 Also, timestamps inserted in capture templates follow this rule.
3419 IMPORTANT: This is a feature whose implementation is and likely will
3420 remain incomplete. Really, it is only here because past midnight seems to
3421 be the favorite working time of John Wiegley :-)"
3422 :group 'org-time
3423 :type 'integer)
3425 (defcustom org-use-effective-time nil
3426 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3427 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3428 \"effective time\" of any timestamps between midnight and 8am will be
3429 23:59 of the previous day."
3430 :group 'org-time
3431 :version "24.1"
3432 :type 'boolean)
3434 (defcustom org-use-last-clock-out-time-as-effective-time nil
3435 "When non-nil, use the last clock out time for `org-todo'.
3436 Note that this option has precedence over the combined use of
3437 `org-use-effective-time' and `org-extend-today-until'."
3438 :group 'org-time
3439 :version "24.4"
3440 :package-version '(Org . "8.0")
3441 :type 'boolean)
3443 (defcustom org-edit-timestamp-down-means-later nil
3444 "Non-nil means S-down will increase the time in a time stamp.
3445 When nil, S-up will increase."
3446 :group 'org-time
3447 :type 'boolean)
3449 (defcustom org-calendar-follow-timestamp-change t
3450 "Non-nil means make the calendar window follow timestamp changes.
3451 When a timestamp is modified and the calendar window is visible, it will be
3452 moved to the new date."
3453 :group 'org-time
3454 :type 'boolean)
3456 (defgroup org-tags nil
3457 "Options concerning tags in Org-mode."
3458 :tag "Org Tags"
3459 :group 'org)
3461 (defcustom org-tag-alist nil
3462 "List of tags allowed in Org-mode files.
3463 When this list is nil, Org-mode will base TAG input on what is already in the
3464 buffer.
3465 The value of this variable is an alist, the car of each entry must be a
3466 keyword as a string, the cdr may be a character that is used to select
3467 that tag through the fast-tag-selection interface.
3468 See the manual for details."
3469 :group 'org-tags
3470 :type '(repeat
3471 (choice
3472 (cons (string :tag "Tag name")
3473 (character :tag "Access char"))
3474 (list :tag "Start radio group"
3475 (const :startgroup)
3476 (option (string :tag "Group description")))
3477 (list :tag "Start tag group, non distinct"
3478 (const :startgrouptag)
3479 (option (string :tag "Group description")))
3480 (list :tag "Group tags delimiter"
3481 (const :grouptags))
3482 (list :tag "End radio group"
3483 (const :endgroup)
3484 (option (string :tag "Group description")))
3485 (list :tag "End tag group, non distinct"
3486 (const :endgrouptag)
3487 (option (string :tag "Group description")))
3488 (const :tag "New line" (:newline)))))
3490 (defcustom org-tag-persistent-alist nil
3491 "List of tags that will always appear in all Org-mode files.
3492 This is in addition to any in buffer settings or customizations
3493 of `org-tag-alist'.
3494 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3495 The value of this variable is an alist, the car of each entry must be a
3496 keyword as a string, the cdr may be a character that is used to select
3497 that tag through the fast-tag-selection interface.
3498 See the manual for details.
3499 To disable these tags on a per-file basis, insert anywhere in the file:
3500 #+STARTUP: noptag"
3501 :group 'org-tags
3502 :type '(repeat
3503 (choice
3504 (cons (string :tag "Tag name")
3505 (character :tag "Access char"))
3506 (const :tag "Start radio group" (:startgroup))
3507 (const :tag "Group tags delimiter" (:grouptags))
3508 (const :tag "End radio group" (:endgroup))
3509 (const :tag "New line" (:newline)))))
3511 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3512 "If non-nil, always offer completion for all tags of all agenda files.
3513 Instead of customizing this variable directly, you might want to
3514 set it locally for capture buffers, because there no list of
3515 tags in that file can be created dynamically (there are none).
3517 (add-hook 'org-capture-mode-hook
3518 (lambda ()
3519 (set (make-local-variable
3520 'org-complete-tags-always-offer-all-agenda-tags)
3521 t)))"
3522 :group 'org-tags
3523 :version "24.1"
3524 :type 'boolean)
3526 (defvar org-file-tags nil
3527 "List of tags that can be inherited by all entries in the file.
3528 The tags will be inherited if the variable `org-use-tag-inheritance'
3529 says they should be.
3530 This variable is populated from #+FILETAGS lines.")
3532 (defcustom org-use-fast-tag-selection 'auto
3533 "Non-nil means use fast tag selection scheme.
3534 This is a special interface to select and deselect tags with single keys.
3535 When nil, fast selection is never used.
3536 When the symbol `auto', fast selection is used if and only if selection
3537 characters for tags have been configured, either through the variable
3538 `org-tag-alist' or through a #+TAGS line in the buffer.
3539 When t, fast selection is always used and selection keys are assigned
3540 automatically if necessary."
3541 :group 'org-tags
3542 :type '(choice
3543 (const :tag "Always" t)
3544 (const :tag "Never" nil)
3545 (const :tag "When selection characters are configured" auto)))
3547 (defcustom org-fast-tag-selection-single-key nil
3548 "Non-nil means fast tag selection exits after first change.
3549 When nil, you have to press RET to exit it.
3550 During fast tag selection, you can toggle this flag with `C-c'.
3551 This variable can also have the value `expert'. In this case, the window
3552 displaying the tags menu is not even shown, until you press C-c again."
3553 :group 'org-tags
3554 :type '(choice
3555 (const :tag "No" nil)
3556 (const :tag "Yes" t)
3557 (const :tag "Expert" expert)))
3559 (defvar org-fast-tag-selection-include-todo nil
3560 "Non-nil means fast tags selection interface will also offer TODO states.
3561 This is an undocumented feature, you should not rely on it.")
3563 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3564 "The column to which tags should be indented in a headline.
3565 If this number is positive, it specifies the column. If it is negative,
3566 it means that the tags should be flushright to that column. For example,
3567 -80 works well for a normal 80 character screen.
3568 When 0, place tags directly after headline text, with only one space in
3569 between."
3570 :group 'org-tags
3571 :type 'integer)
3573 (defcustom org-auto-align-tags t
3574 "Non-nil keeps tags aligned when modifying headlines.
3575 Some operations (i.e. demoting) change the length of a headline and
3576 therefore shift the tags around. With this option turned on, after
3577 each such operation the tags are again aligned to `org-tags-column'."
3578 :group 'org-tags
3579 :type 'boolean)
3581 (defcustom org-use-tag-inheritance t
3582 "Non-nil means tags in levels apply also for sublevels.
3583 When nil, only the tags directly given in a specific line apply there.
3584 This may also be a list of tags that should be inherited, or a regexp that
3585 matches tags that should be inherited. Additional control is possible
3586 with the variable `org-tags-exclude-from-inheritance' which gives an
3587 explicit list of tags to be excluded from inheritance, even if the value of
3588 `org-use-tag-inheritance' would select it for inheritance.
3590 If this option is t, a match early-on in a tree can lead to a large
3591 number of matches in the subtree when constructing the agenda or creating
3592 a sparse tree. If you only want to see the first match in a tree during
3593 a search, check out the variable `org-tags-match-list-sublevels'."
3594 :group 'org-tags
3595 :type '(choice
3596 (const :tag "Not" nil)
3597 (const :tag "Always" t)
3598 (repeat :tag "Specific tags" (string :tag "Tag"))
3599 (regexp :tag "Tags matched by regexp")))
3601 (defcustom org-tags-exclude-from-inheritance nil
3602 "List of tags that should never be inherited.
3603 This is a way to exclude a few tags from inheritance. For way to do
3604 the opposite, to actively allow inheritance for selected tags,
3605 see the variable `org-use-tag-inheritance'."
3606 :group 'org-tags
3607 :type '(repeat (string :tag "Tag")))
3609 (defun org-tag-inherit-p (tag)
3610 "Check if TAG is one that should be inherited."
3611 (cond
3612 ((member tag org-tags-exclude-from-inheritance) nil)
3613 ((eq org-use-tag-inheritance t) t)
3614 ((not org-use-tag-inheritance) nil)
3615 ((stringp org-use-tag-inheritance)
3616 (string-match org-use-tag-inheritance tag))
3617 ((listp org-use-tag-inheritance)
3618 (member tag org-use-tag-inheritance))
3619 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3621 (defcustom org-tags-match-list-sublevels t
3622 "Non-nil means list also sublevels of headlines matching a search.
3623 This variable applies to tags/property searches, and also to stuck
3624 projects because this search is based on a tags match as well.
3626 When set to the symbol `indented', sublevels are indented with
3627 leading dots.
3629 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3630 the sublevels of a headline matching a tag search often also match
3631 the same search. Listing all of them can create very long lists.
3632 Setting this variable to nil causes subtrees of a match to be skipped.
3634 This variable is semi-obsolete and probably should always be true. It
3635 is better to limit inheritance to certain tags using the variables
3636 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3637 :group 'org-tags
3638 :type '(choice
3639 (const :tag "No, don't list them" nil)
3640 (const :tag "Yes, do list them" t)
3641 (const :tag "List them, indented with leading dots" indented)))
3643 (defcustom org-tags-sort-function nil
3644 "When set, tags are sorted using this function as a comparator."
3645 :group 'org-tags
3646 :type '(choice
3647 (const :tag "No sorting" nil)
3648 (const :tag "Alphabetical" string<)
3649 (const :tag "Reverse alphabetical" string>)
3650 (function :tag "Custom function" nil)))
3652 (defvar org-tags-history nil
3653 "History of minibuffer reads for tags.")
3654 (defvar org-last-tags-completion-table nil
3655 "The last used completion table for tags.")
3656 (defvar org-after-tags-change-hook nil
3657 "Hook that is run after the tags in a line have changed.")
3659 (defgroup org-properties nil
3660 "Options concerning properties in Org-mode."
3661 :tag "Org Properties"
3662 :group 'org)
3664 (defcustom org-property-format "%-10s %s"
3665 "How property key/value pairs should be formatted by `indent-line'.
3666 When `indent-line' hits a property definition, it will format the line
3667 according to this format, mainly to make sure that the values are
3668 lined-up with respect to each other."
3669 :group 'org-properties
3670 :type 'string)
3672 (defcustom org-properties-postprocess-alist nil
3673 "Alist of properties and functions to adjust inserted values.
3674 Elements of this alist must be of the form
3676 ([string] [function])
3678 where [string] must be a property name and [function] must be a
3679 lambda expression: this lambda expression must take one argument,
3680 the value to adjust, and return the new value as a string.
3682 For example, this element will allow the property \"Remaining\"
3683 to be updated wrt the relation between the \"Effort\" property
3684 and the clock summary:
3686 ((\"Remaining\" (lambda(value)
3687 (let ((clocksum (org-clock-sum-current-item))
3688 (effort (org-duration-string-to-minutes
3689 (org-entry-get (point) \"Effort\"))))
3690 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3691 :group 'org-properties
3692 :version "24.1"
3693 :type '(alist :key-type (string :tag "Property")
3694 :value-type (function :tag "Function")))
3696 (defcustom org-use-property-inheritance nil
3697 "Non-nil means properties apply also for sublevels.
3699 This setting is chiefly used during property searches. Turning it on can
3700 cause significant overhead when doing a search, which is why it is not
3701 on by default.
3703 When nil, only the properties directly given in the current entry count.
3704 When t, every property is inherited. The value may also be a list of
3705 properties that should have inheritance, or a regular expression matching
3706 properties that should be inherited.
3708 However, note that some special properties use inheritance under special
3709 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3710 and the properties ending in \"_ALL\" when they are used as descriptor
3711 for valid values of a property.
3713 Note for programmers:
3714 When querying an entry with `org-entry-get', you can control if inheritance
3715 should be used. By default, `org-entry-get' looks only at the local
3716 properties. You can request inheritance by setting the inherit argument
3717 to t (to force inheritance) or to `selective' (to respect the setting
3718 in this variable)."
3719 :group 'org-properties
3720 :type '(choice
3721 (const :tag "Not" nil)
3722 (const :tag "Always" t)
3723 (repeat :tag "Specific properties" (string :tag "Property"))
3724 (regexp :tag "Properties matched by regexp")))
3726 (defun org-property-inherit-p (property)
3727 "Check if PROPERTY is one that should be inherited."
3728 (cond
3729 ((eq org-use-property-inheritance t) t)
3730 ((not org-use-property-inheritance) nil)
3731 ((stringp org-use-property-inheritance)
3732 (string-match org-use-property-inheritance property))
3733 ((listp org-use-property-inheritance)
3734 (member property org-use-property-inheritance))
3735 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3737 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3738 "The default column format, if no other format has been defined.
3739 This variable can be set on the per-file basis by inserting a line
3741 #+COLUMNS: %25ITEM ....."
3742 :group 'org-properties
3743 :type 'string)
3745 (defcustom org-columns-ellipses ".."
3746 "The ellipses to be used when a field in column view is truncated.
3747 When this is the empty string, as many characters as possible are shown,
3748 but then there will be no visual indication that the field has been truncated.
3749 When this is a string of length N, the last N characters of a truncated
3750 field are replaced by this string. If the column is narrower than the
3751 ellipses string, only part of the ellipses string will be shown."
3752 :group 'org-properties
3753 :type 'string)
3755 (defcustom org-columns-modify-value-for-display-function nil
3756 "Function that modifies values for display in column view.
3757 For example, it can be used to cut out a certain part from a time stamp.
3758 The function must take 2 arguments:
3760 column-title The title of the column (*not* the property name)
3761 value The value that should be modified.
3763 The function should return the value that should be displayed,
3764 or nil if the normal value should be used."
3765 :group 'org-properties
3766 :type '(choice (const nil) (function)))
3768 (defconst org-global-properties-fixed
3769 '(("VISIBILITY_ALL" . "folded children content all")
3770 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3771 "List of property/value pairs that can be inherited by any entry.
3773 These are fixed values, for the preset properties. The user variable
3774 that can be used to add to this list is `org-global-properties'.
3776 The entries in this list are cons cells where the car is a property
3777 name and cdr is a string with the value. If the value represents
3778 multiple items like an \"_ALL\" property, separate the items by
3779 spaces.")
3781 (defcustom org-global-properties nil
3782 "List of property/value pairs that can be inherited by any entry.
3784 This list will be combined with the constant `org-global-properties-fixed'.
3786 The entries in this list are cons cells where the car is a property
3787 name and cdr is a string with the value.
3789 You can set buffer-local values for the same purpose in the variable
3790 `org-file-properties' this by adding lines like
3792 #+PROPERTY: NAME VALUE"
3793 :group 'org-properties
3794 :type '(repeat
3795 (cons (string :tag "Property")
3796 (string :tag "Value"))))
3798 (defvar org-file-properties nil
3799 "List of property/value pairs that can be inherited by any entry.
3800 Valid for the current buffer.
3801 This variable is populated from #+PROPERTY lines.")
3802 (make-variable-buffer-local 'org-file-properties)
3804 (defgroup org-agenda nil
3805 "Options concerning agenda views in Org-mode."
3806 :tag "Org Agenda"
3807 :group 'org)
3809 (defvar org-category nil
3810 "Variable used by org files to set a category for agenda display.
3811 Such files should use a file variable to set it, for example
3813 # -*- mode: org; org-category: \"ELisp\"
3815 or contain a special line
3817 #+CATEGORY: ELisp
3819 If the file does not specify a category, then file's base name
3820 is used instead.")
3821 (make-variable-buffer-local 'org-category)
3822 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3824 (defcustom org-agenda-files nil
3825 "The files to be used for agenda display.
3826 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3827 \\[org-remove-file]. You can also use customize to edit the list.
3829 If an entry is a directory, all files in that directory that are matched by
3830 `org-agenda-file-regexp' will be part of the file list.
3832 If the value of the variable is not a list but a single file name, then
3833 the list of agenda files is actually stored and maintained in that file, one
3834 agenda file per line. In this file paths can be given relative to
3835 `org-directory'. Tilde expansion and environment variable substitution
3836 are also made."
3837 :group 'org-agenda
3838 :type '(choice
3839 (repeat :tag "List of files and directories" file)
3840 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3842 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3843 "Regular expression to match files for `org-agenda-files'.
3844 If any element in the list in that variable contains a directory instead
3845 of a normal file, all files in that directory that are matched by this
3846 regular expression will be included."
3847 :group 'org-agenda
3848 :type 'regexp)
3850 (defcustom org-agenda-text-search-extra-files nil
3851 "List of extra files to be searched by text search commands.
3852 These files will be searched in addition to the agenda files by the
3853 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3854 Note that these files will only be searched for text search commands,
3855 not for the other agenda views like todo lists, tag searches or the weekly
3856 agenda. This variable is intended to list notes and possibly archive files
3857 that should also be searched by these two commands.
3858 In fact, if the first element in the list is the symbol `agenda-archives',
3859 then all archive files of all agenda files will be added to the search
3860 scope."
3861 :group 'org-agenda
3862 :type '(set :greedy t
3863 (const :tag "Agenda Archives" agenda-archives)
3864 (repeat :inline t (file))))
3866 (org-defvaralias 'org-agenda-multi-occur-extra-files
3867 'org-agenda-text-search-extra-files)
3869 (defcustom org-agenda-skip-unavailable-files nil
3870 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3871 A nil value means to remove them, after a query, from the list."
3872 :group 'org-agenda
3873 :type 'boolean)
3875 (defcustom org-calendar-to-agenda-key [?c]
3876 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3877 The command `org-calendar-goto-agenda' will be bound to this key. The
3878 default is the character `c' because then `c' can be used to switch back and
3879 forth between agenda and calendar."
3880 :group 'org-agenda
3881 :type 'sexp)
3883 (defcustom org-calendar-insert-diary-entry-key [?i]
3884 "The key to be installed in `calendar-mode-map' for adding diary entries.
3885 This option is irrelevant until `org-agenda-diary-file' has been configured
3886 to point to an Org-mode file. When that is the case, the command
3887 `org-agenda-diary-entry' will be bound to the key given here, by default
3888 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3889 if you want to continue doing this, you need to change this to a different
3890 key."
3891 :group 'org-agenda
3892 :type 'sexp)
3894 (defcustom org-agenda-diary-file 'diary-file
3895 "File to which to add new entries with the `i' key in agenda and calendar.
3896 When this is the symbol `diary-file', the functionality in the Emacs
3897 calendar will be used to add entries to the `diary-file'. But when this
3898 points to a file, `org-agenda-diary-entry' will be used instead."
3899 :group 'org-agenda
3900 :type '(choice
3901 (const :tag "The standard Emacs diary file" diary-file)
3902 (file :tag "Special Org file diary entries")))
3904 (eval-after-load "calendar"
3905 '(progn
3906 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3907 'org-calendar-goto-agenda)
3908 (add-hook 'calendar-mode-hook
3909 (lambda ()
3910 (unless (eq org-agenda-diary-file 'diary-file)
3911 (define-key calendar-mode-map
3912 org-calendar-insert-diary-entry-key
3913 'org-agenda-diary-entry))))))
3915 (defgroup org-latex nil
3916 "Options for embedding LaTeX code into Org-mode."
3917 :tag "Org LaTeX"
3918 :group 'org)
3920 (defcustom org-format-latex-options
3921 '(:foreground default :background default :scale 1.0
3922 :html-foreground "Black" :html-background "Transparent"
3923 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3924 "Options for creating images from LaTeX fragments.
3925 This is a property list with the following properties:
3926 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3927 `default' means use the foreground of the default face.
3928 `auto' means use the foreground from the text face.
3929 :background the background color, or \"Transparent\".
3930 `default' means use the background of the default face.
3931 `auto' means use the background from the text face.
3932 :scale a scaling factor for the size of the images, to get more pixels
3933 :html-foreground, :html-background, :html-scale
3934 the same numbers for HTML export.
3935 :matchers a list indicating which matchers should be used to
3936 find LaTeX fragments. Valid members of this list are:
3937 \"begin\" find environments
3938 \"$1\" find single characters surrounded by $.$
3939 \"$\" find math expressions surrounded by $...$
3940 \"$$\" find math expressions surrounded by $$....$$
3941 \"\\(\" find math expressions surrounded by \\(...\\)
3942 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3943 :group 'org-latex
3944 :type 'plist)
3946 (defcustom org-format-latex-signal-error t
3947 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3948 When nil, just push out a message."
3949 :group 'org-latex
3950 :version "24.1"
3951 :type 'boolean)
3953 (defcustom org-latex-to-mathml-jar-file nil
3954 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3955 Use this to specify additional executable file say a jar file.
3957 When using MathToWeb as the converter, specify the full-path to
3958 your mathtoweb.jar file."
3959 :group 'org-latex
3960 :version "24.1"
3961 :type '(choice
3962 (const :tag "None" nil)
3963 (file :tag "JAR file" :must-match t)))
3965 (defcustom org-latex-to-mathml-convert-command nil
3966 "Command to convert LaTeX fragments to MathML.
3967 Replace format-specifiers in the command as noted below and use
3968 `shell-command' to convert LaTeX to MathML.
3969 %j: Executable file in fully expanded form as specified by
3970 `org-latex-to-mathml-jar-file'.
3971 %I: Input LaTeX file in fully expanded form.
3972 %i: The latex fragment to be converted.
3973 %o: Output MathML file.
3975 This command is used by `org-create-math-formula'.
3977 When using MathToWeb as the converter, set this option to
3978 \"java -jar %j -unicode -force -df %o %I\".
3980 When using LaTeXML set this option to
3981 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3982 :group 'org-latex
3983 :version "24.1"
3984 :type '(choice
3985 (const :tag "None" nil)
3986 (string :tag "\nShell command")))
3988 (defcustom org-latex-create-formula-image-program 'dvipng
3989 "Program to convert LaTeX fragments with.
3991 dvipng Process the LaTeX fragments to dvi file, then convert
3992 dvi files to png files using dvipng.
3993 This will also include processing of non-math environments.
3994 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3995 to convert pdf files to png files"
3996 :group 'org-latex
3997 :version "24.1"
3998 :type '(choice
3999 (const :tag "dvipng" dvipng)
4000 (const :tag "imagemagick" imagemagick)))
4002 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4003 "Path to store latex preview images.
4004 A relative path here creates many directories relative to the
4005 processed org files paths. An absolute path puts all preview
4006 images at the same place."
4007 :group 'org-latex
4008 :version "24.3"
4009 :type 'string)
4011 (defun org-format-latex-mathml-available-p ()
4012 "Return t if `org-latex-to-mathml-convert-command' is usable."
4013 (save-match-data
4014 (when (and (boundp 'org-latex-to-mathml-convert-command)
4015 org-latex-to-mathml-convert-command)
4016 (let ((executable (car (split-string
4017 org-latex-to-mathml-convert-command))))
4018 (when (executable-find executable)
4019 (if (string-match
4020 "%j" org-latex-to-mathml-convert-command)
4021 (file-readable-p org-latex-to-mathml-jar-file)
4022 t))))))
4024 (defcustom org-format-latex-header "\\documentclass{article}
4025 \\usepackage[usenames]{color}
4026 \[PACKAGES]
4027 \[DEFAULT-PACKAGES]
4028 \\pagestyle{empty} % do not remove
4029 % The settings below are copied from fullpage.sty
4030 \\setlength{\\textwidth}{\\paperwidth}
4031 \\addtolength{\\textwidth}{-3cm}
4032 \\setlength{\\oddsidemargin}{1.5cm}
4033 \\addtolength{\\oddsidemargin}{-2.54cm}
4034 \\setlength{\\evensidemargin}{\\oddsidemargin}
4035 \\setlength{\\textheight}{\\paperheight}
4036 \\addtolength{\\textheight}{-\\headheight}
4037 \\addtolength{\\textheight}{-\\headsep}
4038 \\addtolength{\\textheight}{-\\footskip}
4039 \\addtolength{\\textheight}{-3cm}
4040 \\setlength{\\topmargin}{1.5cm}
4041 \\addtolength{\\topmargin}{-2.54cm}"
4042 "The document header used for processing LaTeX fragments.
4043 It is imperative that this header make sure that no page number
4044 appears on the page. The package defined in the variables
4045 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4046 will either replace the placeholder \"[PACKAGES]\" in this
4047 header, or they will be appended."
4048 :group 'org-latex
4049 :type 'string)
4051 (defun org-set-packages-alist (var val)
4052 "Set the packages alist and make sure it has 3 elements per entry."
4053 (set var (mapcar (lambda (x)
4054 (if (and (consp x) (= (length x) 2))
4055 (list (car x) (nth 1 x) t)
4057 val)))
4059 (defun org-get-packages-alist (var)
4060 "Get the packages alist and make sure it has 3 elements per entry."
4061 (mapcar (lambda (x)
4062 (if (and (consp x) (= (length x) 2))
4063 (list (car x) (nth 1 x) t)
4065 (default-value var)))
4067 (defcustom org-latex-default-packages-alist
4068 '(("AUTO" "inputenc" t)
4069 ("T1" "fontenc" t)
4070 ("" "fixltx2e" nil)
4071 ("" "graphicx" t)
4072 ("" "grffile" t)
4073 ("" "longtable" nil)
4074 ("" "wrapfig" nil)
4075 ("" "rotating" nil)
4076 ("normalem" "ulem" t)
4077 ("" "amsmath" t)
4078 ("" "textcomp" t)
4079 ("" "amssymb" t)
4080 ("" "capt-of" nil)
4081 ("" "hyperref" nil))
4082 "Alist of default packages to be inserted in the header.
4084 Change this only if one of the packages here causes an
4085 incompatibility with another package you are using.
4087 The packages in this list are needed by one part or another of
4088 Org mode to function properly:
4090 - inputenc, fontenc: for basic font and character selection
4091 - fixltx2e: Important patches of LaTeX itself
4092 - graphicx: for including images
4093 - grffile: allow periods and spaces in graphics file names
4094 - longtable: For multipage tables
4095 - wrapfig: for figure placement
4096 - rotating: for sideways figures and tables
4097 - ulem: for underline and strike-through
4098 - amsmath: for subscript and superscript and math environments
4099 - textcomp, amssymb: for various symbols used
4100 for interpreting the entities in `org-entities'. You can skip
4101 some of these packages if you don't use any of their symbols.
4102 - capt-of: for captions outside of floats
4103 - hyperref: for cross references
4105 Therefore you should not modify this variable unless you know
4106 what you are doing. The one reason to change it anyway is that
4107 you might be loading some other package that conflicts with one
4108 of the default packages. Each element is either a cell or
4109 a string.
4111 A cell is of the format
4113 \(\"options\" \"package\" SNIPPET-FLAG)
4115 If SNIPPET-FLAG is non-nil, the package also needs to be included
4116 when compiling LaTeX snippets into images for inclusion into
4117 non-LaTeX output.
4119 A string will be inserted as-is in the header of the document."
4120 :group 'org-latex
4121 :group 'org-export-latex
4122 :set 'org-set-packages-alist
4123 :get 'org-get-packages-alist
4124 :version "25.1"
4125 :package-version '(Org . "8.3")
4126 :type '(repeat
4127 (choice
4128 (list :tag "options/package pair"
4129 (string :tag "options")
4130 (string :tag "package")
4131 (boolean :tag "Snippet"))
4132 (string :tag "A line of LaTeX"))))
4134 (defcustom org-latex-packages-alist nil
4135 "Alist of packages to be inserted in every LaTeX header.
4137 These will be inserted after `org-latex-default-packages-alist'.
4138 Each element is either a cell or a string.
4140 A cell is of the format:
4142 \(\"options\" \"package\" SNIPPET-FLAG)
4144 SNIPPET-FLAG, when non-nil, indicates that this package is also
4145 needed when turning LaTeX snippets into images for inclusion into
4146 non-LaTeX output.
4148 A string will be inserted as-is in the header of the document.
4150 Make sure that you only list packages here which:
4152 - you want in every file;
4153 - do not conflict with the setup in `org-format-latex-header';
4154 - do not conflict with the default packages in
4155 `org-latex-default-packages-alist'."
4156 :group 'org-latex
4157 :group 'org-export-latex
4158 :set 'org-set-packages-alist
4159 :get 'org-get-packages-alist
4160 :type '(repeat
4161 (choice
4162 (list :tag "options/package pair"
4163 (string :tag "options")
4164 (string :tag "package")
4165 (boolean :tag "Snippet"))
4166 (string :tag "A line of LaTeX"))))
4168 (defgroup org-appearance nil
4169 "Settings for Org-mode appearance."
4170 :tag "Org Appearance"
4171 :group 'org)
4173 (defcustom org-level-color-stars-only nil
4174 "Non-nil means fontify only the stars in each headline.
4175 When nil, the entire headline is fontified.
4176 Changing it requires restart of `font-lock-mode' to become effective
4177 also in regions already fontified."
4178 :group 'org-appearance
4179 :type 'boolean)
4181 (defcustom org-hide-leading-stars nil
4182 "Non-nil means hide the first N-1 stars in a headline.
4183 This works by using the face `org-hide' for these stars. This
4184 face is white for a light background, and black for a dark
4185 background. You may have to customize the face `org-hide' to
4186 make this work.
4187 Changing it requires restart of `font-lock-mode' to become effective
4188 also in regions already fontified.
4189 You may also set this on a per-file basis by adding one of the following
4190 lines to the buffer:
4192 #+STARTUP: hidestars
4193 #+STARTUP: showstars"
4194 :group 'org-appearance
4195 :type 'boolean)
4197 (defcustom org-hidden-keywords nil
4198 "List of symbols corresponding to keywords to be hidden the org buffer.
4199 For example, a value '(title) for this list will make the document's title
4200 appear in the buffer without the initial #+TITLE: keyword."
4201 :group 'org-appearance
4202 :version "24.1"
4203 :type '(set (const :tag "#+AUTHOR" author)
4204 (const :tag "#+DATE" date)
4205 (const :tag "#+EMAIL" email)
4206 (const :tag "#+TITLE" title)))
4208 (defcustom org-custom-properties nil
4209 "List of properties (as strings) with a special meaning.
4210 The default use of these custom properties is to let the user
4211 hide them with `org-toggle-custom-properties-visibility'."
4212 :group 'org-properties
4213 :group 'org-appearance
4214 :version "24.3"
4215 :type '(repeat (string :tag "Property Name")))
4217 (defcustom org-fontify-done-headline nil
4218 "Non-nil means change the face of a headline if it is marked DONE.
4219 Normally, only the TODO/DONE keyword indicates the state of a headline.
4220 When this is non-nil, the headline after the keyword is set to the
4221 `org-headline-done' as an additional indication."
4222 :group 'org-appearance
4223 :type 'boolean)
4225 (defcustom org-fontify-emphasized-text t
4226 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4227 Changing this variable requires a restart of Emacs to take effect."
4228 :group 'org-appearance
4229 :type 'boolean)
4231 (defcustom org-fontify-whole-heading-line nil
4232 "Non-nil means fontify the whole line for headings.
4233 This is useful when setting a background color for the
4234 org-level-* faces."
4235 :group 'org-appearance
4236 :type 'boolean)
4238 (defcustom org-highlight-latex-and-related nil
4239 "Non-nil means highlight LaTeX related syntax in the buffer.
4240 When non nil, the value should be a list containing any of the
4241 following symbols:
4242 `latex' Highlight LaTeX snippets and environments.
4243 `script' Highlight subscript and superscript.
4244 `entities' Highlight entities."
4245 :group 'org-appearance
4246 :version "24.4"
4247 :package-version '(Org . "8.0")
4248 :type '(choice
4249 (const :tag "No highlighting" nil)
4250 (set :greedy t :tag "Highlight"
4251 (const :tag "LaTeX snippets and environments" latex)
4252 (const :tag "Subscript and superscript" script)
4253 (const :tag "Entities" entities))))
4255 (defcustom org-hide-emphasis-markers nil
4256 "Non-nil mean font-lock should hide the emphasis marker characters."
4257 :group 'org-appearance
4258 :type 'boolean)
4260 (defcustom org-hide-macro-markers nil
4261 "Non-nil mean font-lock should hide the brackets marking macro calls."
4262 :group 'org-appearance
4263 :type 'boolean)
4265 (defcustom org-pretty-entities nil
4266 "Non-nil means show entities as UTF8 characters.
4267 When nil, the \\name form remains in the buffer."
4268 :group 'org-appearance
4269 :version "24.1"
4270 :type 'boolean)
4272 (defcustom org-pretty-entities-include-sub-superscripts t
4273 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4274 :group 'org-appearance
4275 :version "24.1"
4276 :type 'boolean)
4278 (defvar org-emph-re nil
4279 "Regular expression for matching emphasis.
4280 After a match, the match groups contain these elements:
4281 0 The match of the full regular expression, including the characters
4282 before and after the proper match
4283 1 The character before the proper match, or empty at beginning of line
4284 2 The proper match, including the leading and trailing markers
4285 3 The leading marker like * or /, indicating the type of highlighting
4286 4 The text between the emphasis markers, not including the markers
4287 5 The character after the match, empty at the end of a line")
4288 (defvar org-verbatim-re nil
4289 "Regular expression for matching verbatim text.")
4290 (defvar org-emphasis-regexp-components) ; defined just below
4291 (defvar org-emphasis-alist) ; defined just below
4292 (defun org-set-emph-re (var val)
4293 "Set variable and compute the emphasis regular expression."
4294 (set var val)
4295 (when (and (boundp 'org-emphasis-alist)
4296 (boundp 'org-emphasis-regexp-components)
4297 org-emphasis-alist org-emphasis-regexp-components)
4298 (let* ((e org-emphasis-regexp-components)
4299 (pre (car e))
4300 (post (nth 1 e))
4301 (border (nth 2 e))
4302 (body (nth 3 e))
4303 (nl (nth 4 e))
4304 (body1 (concat body "*?"))
4305 (markers (mapconcat 'car org-emphasis-alist ""))
4306 (vmarkers (mapconcat
4307 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4308 org-emphasis-alist "")))
4309 ;; make sure special characters appear at the right position in the class
4310 (if (string-match "\\^" markers)
4311 (setq markers (concat (replace-match "" t t markers) "^")))
4312 (if (string-match "-" markers)
4313 (setq markers (concat (replace-match "" t t markers) "-")))
4314 (if (string-match "\\^" vmarkers)
4315 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4316 (if (string-match "-" vmarkers)
4317 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4318 (if (> nl 0)
4319 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4320 (int-to-string nl) "\\}")))
4321 ;; Make the regexp
4322 (setq org-emph-re
4323 (concat "\\([" pre "]\\|^\\)"
4324 "\\("
4325 "\\([" markers "]\\)"
4326 "\\("
4327 "[^" border "]\\|"
4328 "[^" border "]"
4329 body1
4330 "[^" border "]"
4331 "\\)"
4332 "\\3\\)"
4333 "\\([" post "]\\|$\\)"))
4334 (setq org-verbatim-re
4335 (concat "\\([" pre "]\\|^\\)"
4336 "\\("
4337 "\\([" vmarkers "]\\)"
4338 "\\("
4339 "[^" border "]\\|"
4340 "[^" border "]"
4341 body1
4342 "[^" border "]"
4343 "\\)"
4344 "\\3\\)"
4345 "\\([" post "]\\|$\\)")))))
4347 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4348 ;; set this option proved cumbersome. See this message/thread:
4349 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4350 (defvar org-emphasis-regexp-components
4351 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4352 "Components used to build the regular expression for emphasis.
4353 This is a list with five entries. Terminology: In an emphasis string
4354 like \" *strong word* \", we call the initial space PREMATCH, the final
4355 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4356 and \"trong wor\" is the body. The different components in this variable
4357 specify what is allowed/forbidden in each part:
4359 pre Chars allowed as prematch. Beginning of line will be allowed too.
4360 post Chars allowed as postmatch. End of line will be allowed too.
4361 border The chars *forbidden* as border characters.
4362 body-regexp A regexp like \".\" to match a body character. Don't use
4363 non-shy groups here, and don't allow newline here.
4364 newline The maximum number of newlines allowed in an emphasis exp.
4366 You need to reload Org or to restart Emacs after customizing this.")
4368 (defcustom org-emphasis-alist
4369 `(("*" bold)
4370 ("/" italic)
4371 ("_" underline)
4372 ("=" org-verbatim verbatim)
4373 ("~" org-code verbatim)
4374 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4375 "Alist of characters and faces to emphasize text.
4376 Text starting and ending with a special character will be emphasized,
4377 for example *bold*, _underlined_ and /italic/. This variable sets the
4378 marker characters and the face to be used by font-lock for highlighting
4379 in Org-mode Emacs buffers.
4381 You need to reload Org or to restart Emacs after customizing this."
4382 :group 'org-appearance
4383 :set 'org-set-emph-re
4384 :version "24.4"
4385 :package-version '(Org . "8.0")
4386 :type '(repeat
4387 (list
4388 (string :tag "Marker character")
4389 (choice
4390 (face :tag "Font-lock-face")
4391 (plist :tag "Face property list"))
4392 (option (const verbatim)))))
4394 (defvar org-protecting-blocks
4395 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4396 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4397 This is needed for font-lock setup.")
4399 ;;; Miscellaneous options
4401 (defgroup org-completion nil
4402 "Completion in Org-mode."
4403 :tag "Org Completion"
4404 :group 'org)
4406 (defcustom org-completion-use-ido nil
4407 "Non-nil means use ido completion wherever possible.
4408 Note that `ido-mode' must be active for this variable to be relevant.
4409 If you decide to turn this variable on, you might well want to turn off
4410 `org-outline-path-complete-in-steps'.
4411 See also `org-completion-use-iswitchb'."
4412 :group 'org-completion
4413 :type 'boolean)
4415 (defcustom org-completion-use-iswitchb nil
4416 "Non-nil means use iswitchb completion wherever possible.
4417 Note that `iswitchb-mode' must be active for this variable to be relevant.
4418 If you decide to turn this variable on, you might well want to turn off
4419 `org-outline-path-complete-in-steps'.
4420 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4421 :group 'org-completion
4422 :type 'boolean)
4424 (defcustom org-completion-fallback-command 'hippie-expand
4425 "The expansion command called by \\[pcomplete] in normal context.
4426 Normal means, no org-mode-specific context."
4427 :group 'org-completion
4428 :type 'function)
4430 ;;; Functions and variables from their packages
4431 ;; Declared here to avoid compiler warnings
4433 ;; XEmacs only
4434 (defvar outline-mode-menu-heading)
4435 (defvar outline-mode-menu-show)
4436 (defvar outline-mode-menu-hide)
4437 (defvar zmacs-regions) ; XEmacs regions
4439 ;; Emacs only
4440 (defvar mark-active)
4442 ;; Various packages
4443 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4444 (declare-function calendar-forward-day "cal-move" (arg))
4445 (declare-function calendar-goto-date "cal-move" (date))
4446 (declare-function calendar-goto-today "cal-move" ())
4447 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4448 (defvar calc-embedded-close-formula)
4449 (defvar calc-embedded-open-formula)
4450 (declare-function cdlatex-tab "ext:cdlatex" ())
4451 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4452 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4453 (defvar font-lock-unfontify-region-function)
4454 (declare-function iswitchb-read-buffer "iswitchb"
4455 (prompt &optional default require-match start matches-set))
4456 (defvar iswitchb-temp-buflist)
4457 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4458 (defvar org-agenda-tags-todo-honor-ignore-options)
4459 (declare-function org-agenda-skip "org-agenda" ())
4460 (declare-function
4461 org-agenda-format-item "org-agenda"
4462 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4463 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4464 (declare-function org-agenda-change-all-lines "org-agenda"
4465 (newhead hdmarker &optional fixface just-this))
4466 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4467 (declare-function org-agenda-maybe-redo "org-agenda" ())
4468 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4469 (beg end))
4470 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4471 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4472 "org-agenda" (&optional end))
4473 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4474 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4475 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4476 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4477 (declare-function org-indent-mode "org-indent" (&optional arg))
4478 (declare-function parse-time-string "parse-time" (string))
4479 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4480 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4481 (defvar remember-data-file)
4482 (defvar texmathp-why)
4483 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4484 (declare-function table--at-cell-p "table" (position &optional object at-column))
4485 (declare-function calc-eval "calc" (str &optional separator &rest args))
4487 ;;;###autoload
4488 (defun turn-on-orgtbl ()
4489 "Unconditionally turn on `orgtbl-mode'."
4490 (require 'org-table)
4491 (orgtbl-mode 1))
4493 (defun org-at-table-p (&optional table-type)
4494 "Non-nil if the cursor is inside an Org table.
4495 If TABLE-TYPE is non-nil, also check for table.el-type tables.
4496 If `org-enable-table-editor' is nil, return nil unconditionally."
4497 (and
4498 org-enable-table-editor
4499 (save-excursion
4500 (beginning-of-line)
4501 (org-looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
4502 (or (not (derived-mode-p 'org-mode))
4503 (let ((e (org-element-lineage (org-element-at-point) '(table) t)))
4504 (and e (or table-type (eq (org-element-property :type e) 'org)))))))
4505 (defsubst org-table-p () (org-at-table-p))
4507 (defun org-at-table.el-p ()
4508 "Non-nil when point is at a table.el table."
4509 (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4510 (let ((element (org-element-at-point)))
4511 (and (eq (org-element-type element) 'table)
4512 (eq (org-element-property :type element) 'table.el)))))
4514 (defun org-table-recognize-table.el ()
4515 "If there is a table.el table nearby, recognize it and move into it."
4516 (when (and org-table-tab-recognizes-table.el (org-at-table.el-p))
4517 (beginning-of-line)
4518 (unless (or (looking-at org-table-dataline-regexp)
4519 (not (looking-at org-table1-hline-regexp)))
4520 (forward-line)
4521 (when (looking-at org-table-any-border-regexp)
4522 (forward-line -2)))
4523 (if (re-search-forward "|" (org-table-end t) t)
4524 (progn
4525 (require 'table)
4526 (if (table--at-cell-p (point)) t
4527 (message "recognizing table.el table...")
4528 (table-recognize-table)
4529 (message "recognizing table.el table...done")))
4530 (error "This should not happen"))))
4532 (defun org-at-table-hline-p ()
4533 "Non-nil when point is inside a hline in a table.
4534 Assume point is already in a table. If `org-enable-table-editor'
4535 is nil, return nil unconditionally."
4536 (and org-enable-table-editor
4537 (save-excursion
4538 (beginning-of-line)
4539 (looking-at org-table-hline-regexp))))
4541 (defun org-table-map-tables (function &optional quietly)
4542 "Apply FUNCTION to the start of all tables in the buffer."
4543 (save-excursion
4544 (save-restriction
4545 (widen)
4546 (goto-char (point-min))
4547 (while (re-search-forward org-table-any-line-regexp nil t)
4548 (unless quietly
4549 (message "Mapping tables: %d%%"
4550 (floor (* 100.0 (point)) (buffer-size))))
4551 (beginning-of-line 1)
4552 (when (and (looking-at org-table-line-regexp)
4553 ;; Exclude tables in src/example/verbatim/clocktable blocks
4554 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4555 (save-excursion (funcall function))
4556 (or (looking-at org-table-line-regexp)
4557 (forward-char 1)))
4558 (re-search-forward org-table-any-border-regexp nil 1))))
4559 (unless quietly (message "Mapping tables: done")))
4561 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4562 (declare-function org-clock-update-mode-line "org-clock" ())
4563 (declare-function org-resolve-clocks "org-clock"
4564 (&optional also-non-dangling-p prompt last-valid))
4566 (defun org-at-TBLFM-p (&optional pos)
4567 "Non-nil when point (or POS) is in #+TBLFM line."
4568 (save-excursion
4569 (goto-char (or pos (point)))
4570 (beginning-of-line)
4571 (and (let ((case-fold-search t)) (looking-at org-TBLFM-regexp))
4572 (eq (org-element-type (org-element-at-point)) 'table))))
4574 (defvar org-clock-start-time)
4575 (defvar org-clock-marker (make-marker)
4576 "Marker recording the last clock-in.")
4577 (defvar org-clock-hd-marker (make-marker)
4578 "Marker recording the last clock-in, but the headline position.")
4579 (defvar org-clock-heading ""
4580 "The heading of the current clock entry.")
4581 (defun org-clock-is-active ()
4582 "Return the buffer where the clock is currently running.
4583 Return nil if no clock is running."
4584 (marker-buffer org-clock-marker))
4586 (defun org-check-running-clock ()
4587 "Check if the current buffer contains the running clock.
4588 If yes, offer to stop it and to save the buffer with the changes."
4589 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4590 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4591 (buffer-name))))
4592 (org-clock-out)
4593 (when (y-or-n-p "Save changed buffer?")
4594 (save-buffer))))
4596 (defun org-clocktable-try-shift (dir n)
4597 "Check if this line starts a clock table, if yes, shift the time block."
4598 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4599 (org-clocktable-shift dir n)))
4601 ;;;###autoload
4602 (defun org-clock-persistence-insinuate ()
4603 "Set up hooks for clock persistence."
4604 (require 'org-clock)
4605 (add-hook 'org-mode-hook 'org-clock-load)
4606 (add-hook 'kill-emacs-hook 'org-clock-save))
4608 (defgroup org-archive nil
4609 "Options concerning archiving in Org-mode."
4610 :tag "Org Archive"
4611 :group 'org-structure)
4613 (defcustom org-archive-location "%s_archive::"
4614 "The location where subtrees should be archived.
4616 The value of this variable is a string, consisting of two parts,
4617 separated by a double-colon. The first part is a filename and
4618 the second part is a headline.
4620 When the filename is omitted, archiving happens in the same file.
4621 %s in the filename will be replaced by the current file
4622 name (without the directory part). Archiving to a different file
4623 is useful to keep archived entries from contributing to the
4624 Org-mode Agenda.
4626 The archived entries will be filed as subtrees of the specified
4627 headline. When the headline is omitted, the subtrees are simply
4628 filed away at the end of the file, as top-level entries. Also in
4629 the heading you can use %s to represent the file name, this can be
4630 useful when using the same archive for a number of different files.
4632 Here are a few examples:
4633 \"%s_archive::\"
4634 If the current file is Projects.org, archive in file
4635 Projects.org_archive, as top-level trees. This is the default.
4637 \"::* Archived Tasks\"
4638 Archive in the current file, under the top-level headline
4639 \"* Archived Tasks\".
4641 \"~/org/archive.org::\"
4642 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4644 \"~/org/archive.org::* From %s\"
4645 Archive in file ~/org/archive.org (absolute path), under headlines
4646 \"From FILENAME\" where file name is the current file name.
4648 \"~/org/datetree.org::datetree/* Finished Tasks\"
4649 The \"datetree/\" string is special, signifying to archive
4650 items to the datetree. Items are placed in either the CLOSED
4651 date of the item, or the current date if there is no CLOSED date.
4652 The heading will be a subentry to the current date. There doesn't
4653 need to be a heading, but there always needs to be a slash after
4654 datetree. For example, to store archived items directly in the
4655 datetree, use \"~/org/datetree.org::datetree/\".
4657 \"basement::** Finished Tasks\"
4658 Archive in file ./basement (relative path), as level 3 trees
4659 below the level 2 heading \"** Finished Tasks\".
4661 You may set this option on a per-file basis by adding to the buffer a
4662 line like
4664 #+ARCHIVE: basement::** Finished Tasks
4666 You may also define it locally for a subtree by setting an ARCHIVE property
4667 in the entry. If such a property is found in an entry, or anywhere up
4668 the hierarchy, it will be used."
4669 :group 'org-archive
4670 :type 'string)
4672 (defcustom org-agenda-skip-archived-trees t
4673 "Non-nil means the agenda will skip any items located in archived trees.
4674 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4675 variable is no longer recommended, you should leave it at the value t.
4676 Instead, use the key `v' to cycle the archives-mode in the agenda."
4677 :group 'org-archive
4678 :group 'org-agenda-skip
4679 :type 'boolean)
4681 (defcustom org-columns-skip-archived-trees t
4682 "Non-nil means ignore archived trees when creating column view."
4683 :group 'org-archive
4684 :group 'org-properties
4685 :type 'boolean)
4687 (defcustom org-cycle-open-archived-trees nil
4688 "Non-nil means `org-cycle' will open archived trees.
4689 An archived tree is a tree marked with the tag ARCHIVE.
4690 When nil, archived trees will stay folded. You can still open them with
4691 normal outline commands like `show-all', but not with the cycling commands."
4692 :group 'org-archive
4693 :group 'org-cycle
4694 :type 'boolean)
4696 (defcustom org-sparse-tree-open-archived-trees nil
4697 "Non-nil means sparse tree construction shows matches in archived trees.
4698 When nil, matches in these trees are highlighted, but the trees are kept in
4699 collapsed state."
4700 :group 'org-archive
4701 :group 'org-sparse-trees
4702 :type 'boolean)
4704 (defcustom org-sparse-tree-default-date-type nil
4705 "The default date type when building a sparse tree.
4706 When this is nil, a date is a scheduled or a deadline timestamp.
4707 Otherwise, these types are allowed:
4709 all: all timestamps
4710 active: only active timestamps (<...>)
4711 inactive: only inactive timestamps ([...])
4712 scheduled: only scheduled timestamps
4713 deadline: only deadline timestamps"
4714 :type '(choice (const :tag "Scheduled or deadline" nil)
4715 (const :tag "All timestamps" all)
4716 (const :tag "Only active timestamps" active)
4717 (const :tag "Only inactive timestamps" inactive)
4718 (const :tag "Only scheduled timestamps" scheduled)
4719 (const :tag "Only deadline timestamps" deadline)
4720 (const :tag "Only closed timestamps" closed))
4721 :version "25.1"
4722 :package-version '(Org . "8.3")
4723 :group 'org-sparse-trees)
4725 (defun org-cycle-hide-archived-subtrees (state)
4726 "Re-hide all archived subtrees after a visibility state change."
4727 (when (and (not org-cycle-open-archived-trees)
4728 (not (memq state '(overview folded))))
4729 (save-excursion
4730 (let* ((globalp (memq state '(contents all)))
4731 (beg (if globalp (point-min) (point)))
4732 (end (if globalp (point-max) (org-end-of-subtree t))))
4733 (org-hide-archived-subtrees beg end)
4734 (goto-char beg)
4735 (if (looking-at (concat ".*:" org-archive-tag ":"))
4736 (message "%s" (substitute-command-keys
4737 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4739 (defun org-force-cycle-archived ()
4740 "Cycle subtree even if it is archived."
4741 (interactive)
4742 (setq this-command 'org-cycle)
4743 (let ((org-cycle-open-archived-trees t))
4744 (call-interactively 'org-cycle)))
4746 (defun org-hide-archived-subtrees (beg end)
4747 "Re-hide all archived subtrees after a visibility state change."
4748 (org-with-wide-buffer
4749 (let ((case-fold-search nil)
4750 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4751 (goto-char beg)
4752 ;; Include headline point is currently on.
4753 (beginning-of-line)
4754 (while (and (< (point) end) (re-search-forward re end t))
4755 (when (member org-archive-tag (org-get-tags))
4756 (org-flag-subtree t)
4757 (org-end-of-subtree t))))))
4759 (declare-function outline-end-of-heading "outline" ())
4760 (declare-function outline-flag-region "outline" (from to flag))
4761 (defun org-flag-subtree (flag)
4762 (save-excursion
4763 (org-back-to-heading t)
4764 (outline-end-of-heading)
4765 (outline-flag-region (point)
4766 (progn (org-end-of-subtree t) (point))
4767 flag)))
4769 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4771 ;; Declare Column View Code
4773 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4774 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4775 (declare-function org-columns-compute "org-colview" (property))
4777 ;; Declare ID code
4779 (declare-function org-id-store-link "org-id")
4780 (declare-function org-id-locations-load "org-id")
4781 (declare-function org-id-locations-save "org-id")
4782 (defvar org-id-track-globally)
4784 ;;; Variables for pre-computed regular expressions, all buffer local
4786 (defvar org-todo-regexp nil
4787 "Matches any of the TODO state keywords.")
4788 (make-variable-buffer-local 'org-todo-regexp)
4789 (defvar org-not-done-regexp nil
4790 "Matches any of the TODO state keywords except the last one.")
4791 (make-variable-buffer-local 'org-not-done-regexp)
4792 (defvar org-not-done-heading-regexp nil
4793 "Matches a TODO headline that is not done.")
4794 (make-variable-buffer-local 'org-not-done-heading-regexp)
4795 (defvar org-todo-line-regexp nil
4796 "Matches a headline and puts TODO state into group 2 if present.")
4797 (make-variable-buffer-local 'org-todo-line-regexp)
4798 (defvar org-complex-heading-regexp nil
4799 "Matches a headline and puts everything into groups:
4800 group 1: the stars
4801 group 2: The todo keyword, maybe
4802 group 3: Priority cookie
4803 group 4: True headline
4804 group 5: Tags")
4805 (make-variable-buffer-local 'org-complex-heading-regexp)
4806 (defvar org-complex-heading-regexp-format nil
4807 "Printf format to make regexp to match an exact headline.
4808 This regexp will match the headline of any node which has the
4809 exact headline text that is put into the format, but may have any
4810 TODO state, priority and tags.")
4811 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4812 (defvar org-todo-line-tags-regexp nil
4813 "Matches a headline and puts TODO state into group 2 if present.
4814 Also put tags into group 4 if tags are present.")
4815 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4817 (defconst org-plain-time-of-day-regexp
4818 (concat
4819 "\\(\\<[012]?[0-9]"
4820 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4821 "\\(--?"
4822 "\\(\\<[012]?[0-9]"
4823 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4824 "\\)?")
4825 "Regular expression to match a plain time or time range.
4826 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4827 groups carry important information:
4828 0 the full match
4829 1 the first time, range or not
4830 8 the second time, if it is a range.")
4832 (defconst org-plain-time-extension-regexp
4833 (concat
4834 "\\(\\<[012]?[0-9]"
4835 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4836 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4837 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4838 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4839 groups carry important information:
4840 0 the full match
4841 7 hours of duration
4842 9 minutes of duration")
4844 (defconst org-stamp-time-of-day-regexp
4845 (concat
4846 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4847 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4848 "\\(--?"
4849 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4850 "Regular expression to match a timestamp time or time range.
4851 After a match, the following groups carry important information:
4852 0 the full match
4853 1 date plus weekday, for back referencing to make sure both times are on the same day
4854 2 the first time, range or not
4855 4 the second time, if it is a range.")
4857 (defconst org-startup-options
4858 '(("fold" org-startup-folded t)
4859 ("overview" org-startup-folded t)
4860 ("nofold" org-startup-folded nil)
4861 ("showall" org-startup-folded nil)
4862 ("showeverything" org-startup-folded showeverything)
4863 ("content" org-startup-folded content)
4864 ("indent" org-startup-indented t)
4865 ("noindent" org-startup-indented nil)
4866 ("hidestars" org-hide-leading-stars t)
4867 ("showstars" org-hide-leading-stars nil)
4868 ("odd" org-odd-levels-only t)
4869 ("oddeven" org-odd-levels-only nil)
4870 ("align" org-startup-align-all-tables t)
4871 ("noalign" org-startup-align-all-tables nil)
4872 ("inlineimages" org-startup-with-inline-images t)
4873 ("noinlineimages" org-startup-with-inline-images nil)
4874 ("latexpreview" org-startup-with-latex-preview t)
4875 ("nolatexpreview" org-startup-with-latex-preview nil)
4876 ("customtime" org-display-custom-times t)
4877 ("logdone" org-log-done time)
4878 ("lognotedone" org-log-done note)
4879 ("nologdone" org-log-done nil)
4880 ("lognoteclock-out" org-log-note-clock-out t)
4881 ("nolognoteclock-out" org-log-note-clock-out nil)
4882 ("logrepeat" org-log-repeat state)
4883 ("lognoterepeat" org-log-repeat note)
4884 ("logdrawer" org-log-into-drawer t)
4885 ("nologdrawer" org-log-into-drawer nil)
4886 ("logstatesreversed" org-log-states-order-reversed t)
4887 ("nologstatesreversed" org-log-states-order-reversed nil)
4888 ("nologrepeat" org-log-repeat nil)
4889 ("logreschedule" org-log-reschedule time)
4890 ("lognotereschedule" org-log-reschedule note)
4891 ("nologreschedule" org-log-reschedule nil)
4892 ("logredeadline" org-log-redeadline time)
4893 ("lognoteredeadline" org-log-redeadline note)
4894 ("nologredeadline" org-log-redeadline nil)
4895 ("logrefile" org-log-refile time)
4896 ("lognoterefile" org-log-refile note)
4897 ("nologrefile" org-log-refile nil)
4898 ("fninline" org-footnote-define-inline t)
4899 ("nofninline" org-footnote-define-inline nil)
4900 ("fnlocal" org-footnote-section nil)
4901 ("fnauto" org-footnote-auto-label t)
4902 ("fnprompt" org-footnote-auto-label nil)
4903 ("fnconfirm" org-footnote-auto-label confirm)
4904 ("fnplain" org-footnote-auto-label plain)
4905 ("fnadjust" org-footnote-auto-adjust t)
4906 ("nofnadjust" org-footnote-auto-adjust nil)
4907 ("constcgs" constants-unit-system cgs)
4908 ("constSI" constants-unit-system SI)
4909 ("noptag" org-tag-persistent-alist nil)
4910 ("hideblocks" org-hide-block-startup t)
4911 ("nohideblocks" org-hide-block-startup nil)
4912 ("beamer" org-startup-with-beamer-mode t)
4913 ("entitiespretty" org-pretty-entities t)
4914 ("entitiesplain" org-pretty-entities nil))
4915 "Variable associated with STARTUP options for org-mode.
4916 Each element is a list of three items: the startup options (as written
4917 in the #+STARTUP line), the corresponding variable, and the value to set
4918 this variable to if the option is found. An optional forth element PUSH
4919 means to push this value onto the list in the variable.")
4921 (defcustom org-group-tags t
4922 "When non-nil (the default), use group tags.
4923 This can be turned on/off through `org-toggle-tags-groups'."
4924 :group 'org-tags
4925 :group 'org-startup
4926 :type 'boolean)
4928 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4930 (defun org-toggle-tags-groups ()
4931 "Toggle support for group tags.
4932 Support for group tags is controlled by the option
4933 `org-group-tags', which is non-nil by default."
4934 (interactive)
4935 (setq org-group-tags (not org-group-tags))
4936 (cond ((and (derived-mode-p 'org-agenda-mode)
4937 org-group-tags)
4938 (org-agenda-redo))
4939 ((derived-mode-p 'org-mode)
4940 (let ((org-inhibit-startup t)) (org-mode))))
4941 (message "Groups tags support has been turned %s"
4942 (if org-group-tags "on" "off")))
4944 (defun org-set-regexps-and-options (&optional tags-only)
4945 "Precompute regular expressions used in the current buffer.
4946 When optional argument TAGS-ONLY is non-nil, only compute tags
4947 related expressions."
4948 (when (derived-mode-p 'org-mode)
4949 (let ((alist (org--setup-collect-keywords
4950 (org-make-options-regexp
4951 (append '("FILETAGS" "TAGS" "SETUPFILE")
4952 (and (not tags-only)
4953 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4954 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4955 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4956 (org--setup-process-tags
4957 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4958 (unless tags-only
4959 ;; File properties.
4960 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4961 ;; Archive location.
4962 (let ((archive (cdr (assq 'archive alist))))
4963 (when archive (org-set-local 'org-archive-location archive)))
4964 ;; Category.
4965 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4966 (when cat
4967 (org-set-local 'org-category (intern cat))
4968 (org-set-local 'org-file-properties
4969 (org--update-property-plist
4970 "CATEGORY" cat org-file-properties))))
4971 ;; Columns.
4972 (let ((column (cdr (assq 'columns alist))))
4973 (when column (org-set-local 'org-columns-default-format column)))
4974 ;; Constants.
4975 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4976 ;; Link abbreviations.
4977 (let ((links (cdr (assq 'link alist))))
4978 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4979 ;; Priorities.
4980 (let ((priorities (cdr (assq 'priorities alist))))
4981 (when priorities
4982 (org-set-local 'org-highest-priority (nth 0 priorities))
4983 (org-set-local 'org-lowest-priority (nth 1 priorities))
4984 (org-set-local 'org-default-priority (nth 2 priorities))))
4985 ;; Scripts.
4986 (let ((scripts (assq 'scripts alist)))
4987 (when scripts
4988 (org-set-local 'org-use-sub-superscripts (cdr scripts))))
4989 ;; Startup options.
4990 (let ((startup (cdr (assq 'startup alist))))
4991 (dolist (option startup)
4992 (let ((entry (assoc-string option org-startup-options t)))
4993 (when entry
4994 (let ((var (nth 1 entry))
4995 (val (nth 2 entry)))
4996 (if (not (nth 3 entry)) (org-set-local var val)
4997 (unless (listp (symbol-value var))
4998 (org-set-local var nil))
4999 (add-to-list var val)))))))
5000 ;; TODO keywords.
5001 (org-set-local 'org-todo-kwd-alist nil)
5002 (org-set-local 'org-todo-key-alist nil)
5003 (org-set-local 'org-todo-key-trigger nil)
5004 (org-set-local 'org-todo-keywords-1 nil)
5005 (org-set-local 'org-done-keywords nil)
5006 (org-set-local 'org-todo-heads nil)
5007 (org-set-local 'org-todo-sets nil)
5008 (org-set-local 'org-todo-log-states nil)
5009 (let ((todo-sequences
5010 (or (nreverse (cdr (assq 'todo alist)))
5011 (let ((d (default-value 'org-todo-keywords)))
5012 (if (not (stringp (car d))) d
5013 ;; XXX: Backward compatibility code.
5014 (list (cons org-todo-interpretation d)))))))
5015 (dolist (sequence todo-sequences)
5016 (let* ((sequence (or (run-hook-with-args-until-success
5017 'org-todo-setup-filter-hook sequence)
5018 sequence))
5019 (sequence-type (car sequence))
5020 (keywords (cdr sequence))
5021 (sep (member "|" keywords))
5022 names alist)
5023 (dolist (k (remove "|" keywords))
5024 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5026 (error "Invalid TODO keyword %s" k))
5027 (let ((name (match-string 1 k))
5028 (key (match-string 2 k))
5029 (log (org-extract-log-state-settings k)))
5030 (push name names)
5031 (push (cons name (and key (string-to-char key))) alist)
5032 (when log (push log org-todo-log-states))))
5033 (let* ((names (nreverse names))
5034 (done (if sep (org-remove-keyword-keys (cdr sep))
5035 (last names)))
5036 (head (car names))
5037 (tail (list sequence-type head (car done) (org-last done))))
5038 (add-to-list 'org-todo-heads head 'append)
5039 (push names org-todo-sets)
5040 (setq org-done-keywords (append org-done-keywords done nil))
5041 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5042 (setq org-todo-key-alist
5043 (append org-todo-key-alist
5044 (and alist
5045 (append '((:startgroup))
5046 (nreverse alist)
5047 '((:endgroup))))))
5048 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5049 (setq org-todo-sets (nreverse org-todo-sets)
5050 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5051 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5052 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5053 ;; Compute the regular expressions and other local variables.
5054 ;; Using `org-outline-regexp-bol' would complicate them much,
5055 ;; because of the fixed white space at the end of that string.
5056 (if (not org-done-keywords)
5057 (setq org-done-keywords
5058 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5059 (setq org-not-done-keywords
5060 (org-delete-all org-done-keywords
5061 (copy-sequence org-todo-keywords-1))
5062 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5063 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5064 org-not-done-heading-regexp
5065 (format org-heading-keyword-regexp-format org-not-done-regexp)
5066 org-todo-line-regexp
5067 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5068 org-complex-heading-regexp
5069 (concat "^\\(\\*+\\)"
5070 "\\(?: +" org-todo-regexp "\\)?"
5071 "\\(?: +\\(\\[#.\\]\\)\\)?"
5072 "\\(?: +\\(.*?\\)\\)??"
5073 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5074 "[ \t]*$")
5075 org-complex-heading-regexp-format
5076 (concat "^\\(\\*+\\)"
5077 "\\(?: +" org-todo-regexp "\\)?"
5078 "\\(?: +\\(\\[#.\\]\\)\\)?"
5079 "\\(?: +"
5080 ;; Stats cookies can be stuck to body.
5081 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5082 "\\(%s\\)"
5083 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5084 "\\)"
5085 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5086 "[ \t]*$")
5087 org-todo-line-tags-regexp
5088 (concat "^\\(\\*+\\)"
5089 "\\(?: +" org-todo-regexp "\\)?"
5090 "\\(?: +\\(.*?\\)\\)??"
5091 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5092 "[ \t]*$"))
5093 (org-compute-latex-and-related-regexp)))))
5095 (defun org--setup-collect-keywords (regexp &optional files alist)
5096 "Return setup keywords values as an alist.
5098 REGEXP matches a subset of setup keywords. FILES is a list of
5099 file names already visited. It is used to avoid circular setup
5100 files. ALIST, when non-nil, is the alist computed so far.
5102 Return value contains the following keys: `archive', `category',
5103 `columns', `constants', `filetags', `link', `priorities',
5104 `property', `scripts', `startup', `tags' and `todo'."
5105 (org-with-wide-buffer
5106 (goto-char (point-min))
5107 (let ((case-fold-search t))
5108 (while (re-search-forward regexp nil t)
5109 (let ((element (org-element-at-point)))
5110 (when (eq (org-element-type element) 'keyword)
5111 (let ((key (org-element-property :key element))
5112 (value (org-element-property :value element)))
5113 (cond
5114 ((equal key "ARCHIVE")
5115 (when (org-string-nw-p value)
5116 (push (cons 'archive value) alist)))
5117 ((equal key "CATEGORY") (push (cons 'category value) alist))
5118 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5119 ((equal key "CONSTANTS")
5120 (let* ((constants (assq 'constants alist))
5121 (store (cdr constants)))
5122 (dolist (pair (org-split-string value))
5123 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5124 pair)
5125 (let* ((name (match-string 1 pair))
5126 (value (match-string 2 pair))
5127 (old (assoc name store)))
5128 (if old (setcdr old value)
5129 (push (cons name value) store)))))
5130 (if constants (setcdr constants store)
5131 (push (cons 'constants store) alist))))
5132 ((equal key "FILETAGS")
5133 (when (org-string-nw-p value)
5134 (let ((old (assq 'filetags alist))
5135 (new (apply #'nconc
5136 (mapcar (lambda (x) (org-split-string x ":"))
5137 (org-split-string value)))))
5138 (if old (setcdr old (append new (cdr old)))
5139 (push (cons 'filetags new) alist)))))
5140 ((equal key "LINK")
5141 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5142 (let ((links (assq 'link alist))
5143 (pair (cons (org-match-string-no-properties 1 value)
5144 (org-match-string-no-properties 2 value))))
5145 (if links (push pair (cdr links))
5146 (push (list 'link pair) alist)))))
5147 ((equal key "OPTIONS")
5148 (when (and (org-string-nw-p value)
5149 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5150 (push (cons 'scripts (read (match-string 1 value))) alist)))
5151 ((equal key "PRIORITIES")
5152 (push (cons 'priorities
5153 (let ((prio (org-split-string value)))
5154 (if (< (length prio) 3) '(?A ?C ?B)
5155 (mapcar #'string-to-char prio))))
5156 alist))
5157 ((equal key "PROPERTY")
5158 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5159 (let* ((property (assq 'property alist))
5160 (value (org--update-property-plist
5161 (org-match-string-no-properties 1 value)
5162 (org-match-string-no-properties 2 value)
5163 (cdr property))))
5164 (if property (setcdr property value)
5165 (push (cons 'property value) alist)))))
5166 ((equal key "STARTUP")
5167 (let ((startup (assq 'startup alist)))
5168 (if startup
5169 (setcdr startup
5170 (append (cdr startup) (org-split-string value)))
5171 (push (cons 'startup (org-split-string value)) alist))))
5172 ((equal key "TAGS")
5173 (let ((tag-cell (assq 'tags alist)))
5174 (if tag-cell
5175 (setcdr tag-cell
5176 (append (cdr tag-cell)
5177 '("\\n")
5178 (org-split-string value)))
5179 (push (cons 'tags (org-split-string value)) alist))))
5180 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5181 (let ((todo (assq 'todo alist))
5182 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5183 (org-split-string value))))
5184 (if todo (push value (cdr todo))
5185 (push (list 'todo value) alist))))
5186 ((equal key "SETUPFILE")
5187 (unless buffer-read-only ; Do not check in Gnus messages.
5188 (let ((f (and (org-string-nw-p value)
5189 (expand-file-name
5190 (org-remove-double-quotes value)))))
5191 (when (and f (file-readable-p f) (not (member f files)))
5192 (with-temp-buffer
5193 (insert-file-contents f)
5194 (setq alist
5195 ;; Fake Org mode to benefit from cache
5196 ;; without recurring needlessly.
5197 (let ((major-mode 'org-mode))
5198 (org--setup-collect-keywords
5199 regexp (cons f files) alist)))))))))))))))
5200 alist)
5202 (defun org--setup-process-tags (tags filetags)
5203 "Precompute variables used for tags.
5204 TAGS is a list of tags and tag group symbols, as strings.
5205 FILETAGS is a list of tags, as strings."
5206 ;; Process the file tags.
5207 (org-set-local 'org-file-tags
5208 (mapcar #'org-add-prop-inherited filetags))
5209 ;; Provide default tags if no local tags are found.
5210 (when (and (not tags) org-tag-alist)
5211 (setq tags
5212 (mapcar (lambda (tag)
5213 (case (car tag)
5214 (:startgroup "{")
5215 (:endgroup "}")
5216 (:startgrouptag "[")
5217 (:endgrouptag "]")
5218 (:grouptags ":")
5219 (:newline "\\n")
5220 (otherwise (concat (car tag)
5221 (and (characterp (cdr tag))
5222 (format "(%c)" (cdr tag)))))))
5223 org-tag-alist)))
5224 ;; Process the tags.
5225 (org-set-local 'org-tag-groups-alist nil)
5226 (org-set-local 'org-tag-alist nil)
5227 (let (group-flag)
5228 (while tags
5229 (let ((e (car tags)))
5230 (setq tags (cdr tags))
5231 (cond
5232 ((equal e "{")
5233 (push '(:startgroup) org-tag-alist)
5234 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5235 ((equal e "}")
5236 (push '(:endgroup) org-tag-alist)
5237 (setq group-flag nil))
5238 ((equal e "[")
5239 (push '(:startgrouptag) org-tag-alist)
5240 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5241 ((equal e "]")
5242 (push '(:endgrouptag) org-tag-alist)
5243 (setq group-flag nil))
5244 ((equal e ":")
5245 (push '(:grouptags) org-tag-alist)
5246 (setq group-flag 'append))
5247 ((equal e "\\n") (push '(:newline) org-tag-alist))
5248 ((string-match
5249 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5250 "\\|{.+?}\\)" ; regular expression
5251 "\\(?:(\\(.\\))\\)?\\'")) e)
5252 (let ((tag (match-string 1 e))
5253 (key (and (match-beginning 2)
5254 (string-to-char (match-string 2 e)))))
5255 (cond ((eq group-flag 'append)
5256 (setcar org-tag-groups-alist
5257 (append (car org-tag-groups-alist) (list tag))))
5258 (group-flag (push (list tag) org-tag-groups-alist)))
5259 ;; Push all tags in groups, no matter if they already exist.
5260 (unless (and (not group-flag) (assoc tag org-tag-alist))
5261 (push (cons tag key) org-tag-alist))))))))
5262 (setq org-tag-alist (nreverse org-tag-alist)))
5264 (defun org-file-contents (file &optional noerror)
5265 "Return the contents of FILE, as a string."
5266 (if (and file (file-readable-p file))
5267 (with-temp-buffer
5268 (insert-file-contents file)
5269 (buffer-string))
5270 (funcall (if noerror 'message 'error)
5271 "Cannot read file \"%s\"%s"
5272 file
5273 (let ((from (buffer-file-name (buffer-base-buffer))))
5274 (if from (concat " (referenced in file \"" from "\")") "")))))
5276 (defun org-extract-log-state-settings (x)
5277 "Extract the log state setting from a TODO keyword string.
5278 This will extract info from a string like \"WAIT(w@/!)\"."
5279 (let (kw key log1 log2)
5280 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5281 (setq kw (match-string 1 x)
5282 key (and (match-end 2) (match-string 2 x))
5283 log1 (and (match-end 3) (match-string 3 x))
5284 log2 (and (match-end 4) (match-string 4 x)))
5285 (and (or log1 log2)
5286 (list kw
5287 (and log1 (if (equal log1 "!") 'time 'note))
5288 (and log2 (if (equal log2 "!") 'time 'note)))))))
5290 (defun org-remove-keyword-keys (list)
5291 "Remove a pair of parenthesis at the end of each string in LIST."
5292 (mapcar (lambda (x)
5293 (if (string-match "(.*)$" x)
5294 (substring x 0 (match-beginning 0))
5296 list))
5298 (defun org-assign-fast-keys (alist)
5299 "Assign fast keys to a keyword-key alist.
5300 Respect keys that are already there."
5301 (let (new e (alt ?0))
5302 (while (setq e (pop alist))
5303 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5304 (cdr e)) ;; Key already assigned.
5305 (push e new)
5306 (let ((clist (string-to-list (downcase (car e))))
5307 (used (append new alist)))
5308 (when (= (car clist) ?@)
5309 (pop clist))
5310 (while (and clist (rassoc (car clist) used))
5311 (pop clist))
5312 (unless clist
5313 (while (rassoc alt used)
5314 (incf alt)))
5315 (push (cons (car e) (or (car clist) alt)) new))))
5316 (nreverse new)))
5318 ;;; Some variables used in various places
5320 (defvar org-window-configuration nil
5321 "Used in various places to store a window configuration.")
5322 (defvar org-selected-window nil
5323 "Used in various places to store a window configuration.")
5324 (defvar org-finish-function nil
5325 "Function to be called when `C-c C-c' is used.
5326 This is for getting out of special buffers like capture.")
5329 ;; FIXME: Occasionally check by commenting these, to make sure
5330 ;; no other functions uses these, forgetting to let-bind them.
5331 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5332 (defvar org-last-state)
5333 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5335 ;; Defined somewhere in this file, but used before definition.
5336 (defvar org-entities) ;; defined in org-entities.el
5337 (defvar org-struct-menu)
5338 (defvar org-org-menu)
5339 (defvar org-tbl-menu)
5341 ;;;; Define the Org-mode
5343 ;; We use a before-change function to check if a table might need
5344 ;; an update.
5345 (defvar org-table-may-need-update t
5346 "Indicates that a table might need an update.
5347 This variable is set by `org-before-change-function'.
5348 `org-table-align' sets it back to nil.")
5349 (defun org-before-change-function (beg end)
5350 "Every change indicates that a table might need an update."
5351 (setq org-table-may-need-update t))
5352 (defvar org-mode-map)
5353 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5354 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5355 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5356 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5357 (defvar org-table-buffer-is-an nil)
5359 (defvar bidi-paragraph-direction)
5360 (defvar buffer-face-mode-face)
5362 (require 'outline)
5363 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5364 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
5365 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5367 ;; Other stuff we need.
5368 (require 'time-date)
5369 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5370 (require 'easymenu)
5371 (autoload 'easy-menu-add "easymenu")
5372 (require 'overlay)
5374 ;; (require 'org-macs) moved higher up in the file before it is first used
5375 (require 'org-entities)
5376 ;; (require 'org-compat) moved higher up in the file before it is first used
5377 (require 'org-faces)
5378 (require 'org-list)
5379 (require 'org-pcomplete)
5380 (require 'org-src)
5381 (require 'org-footnote)
5382 (require 'org-macro)
5384 ;; babel
5385 (require 'ob)
5387 ;;;###autoload
5388 (define-derived-mode org-mode outline-mode "Org"
5389 "Outline-based notes management and organizer, alias
5390 \"Carsten's outline-mode for keeping track of everything.\"
5392 Org-mode develops organizational tasks around a NOTES file which
5393 contains information about projects as plain text. Org-mode is
5394 implemented on top of outline-mode, which is ideal to keep the content
5395 of large files well structured. It supports ToDo items, deadlines and
5396 time stamps, which magically appear in the diary listing of the Emacs
5397 calendar. Tables are easily created with a built-in table editor.
5398 Plain text URL-like links connect to websites, emails (VM), Usenet
5399 messages (Gnus), BBDB entries, and any files related to the project.
5400 For printing and sharing of notes, an Org-mode file (or a part of it)
5401 can be exported as a structured ASCII or HTML file.
5403 The following commands are available:
5405 \\{org-mode-map}"
5407 ;; Get rid of Outline menus, they are not needed
5408 ;; Need to do this here because define-derived-mode sets up
5409 ;; the keymap so late. Still, it is a waste to call this each time
5410 ;; we switch another buffer into org-mode.
5411 (if (featurep 'xemacs)
5412 (when (boundp 'outline-mode-menu-heading)
5413 ;; Assume this is Greg's port, it uses easymenu
5414 (easy-menu-remove outline-mode-menu-heading)
5415 (easy-menu-remove outline-mode-menu-show)
5416 (easy-menu-remove outline-mode-menu-hide))
5417 (define-key org-mode-map [menu-bar headings] 'undefined)
5418 (define-key org-mode-map [menu-bar hide] 'undefined)
5419 (define-key org-mode-map [menu-bar show] 'undefined))
5421 (org-load-modules-maybe)
5422 (when (featurep 'xemacs)
5423 (easy-menu-add org-org-menu)
5424 (easy-menu-add org-tbl-menu))
5425 (org-install-agenda-files-menu)
5426 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5427 (add-to-invisibility-spec '(org-cwidth))
5428 (add-to-invisibility-spec '(org-hide-block . t))
5429 (when (featurep 'xemacs)
5430 (org-set-local 'line-move-ignore-invisible t))
5431 (org-set-local 'outline-regexp org-outline-regexp)
5432 (org-set-local 'outline-level 'org-outline-level)
5433 (setq bidi-paragraph-direction 'left-to-right)
5434 (when (and org-ellipsis
5435 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5436 (fboundp 'make-glyph-code))
5437 (unless org-display-table
5438 (setq org-display-table (make-display-table)))
5439 (set-display-table-slot
5440 org-display-table 4
5441 (vconcat (mapcar
5442 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5443 org-ellipsis)))
5444 (if (stringp org-ellipsis) org-ellipsis "..."))))
5445 (setq buffer-display-table org-display-table))
5446 (org-set-regexps-and-options)
5447 (org-set-font-lock-defaults)
5448 (when (and org-tag-faces (not org-tags-special-faces-re))
5449 ;; tag faces set outside customize.... force initialization.
5450 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5451 ;; Calc embedded
5452 (org-set-local 'calc-embedded-open-mode "# ")
5453 ;; Modify a few syntax entries
5454 (modify-syntax-entry ?@ "w")
5455 (modify-syntax-entry ?\" "\"")
5456 (modify-syntax-entry ?\\ "_")
5457 (modify-syntax-entry ?~ "_")
5458 (if org-startup-truncated (setq truncate-lines t))
5459 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5460 (org-set-local 'font-lock-unfontify-region-function
5461 'org-unfontify-region)
5462 ;; Activate before-change-function
5463 (org-set-local 'org-table-may-need-update t)
5464 (org-add-hook 'before-change-functions 'org-before-change-function nil
5465 'local)
5466 ;; Check for running clock before killing a buffer
5467 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5468 ;; Initialize macros templates.
5469 (org-macro-initialize-templates)
5470 ;; Initialize radio targets.
5471 (org-update-radio-target-regexp)
5472 ;; Indentation.
5473 (org-set-local 'indent-line-function 'org-indent-line)
5474 (org-set-local 'indent-region-function 'org-indent-region)
5475 ;; Filling and auto-filling.
5476 (org-setup-filling)
5477 ;; Comments.
5478 (org-setup-comments-handling)
5479 ;; Initialize cache.
5480 (org-element-cache-reset)
5481 ;; Beginning/end of defun
5482 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5483 (org-set-local 'end-of-defun-function
5484 (lambda ()
5485 (if (not (org-at-heading-p))
5486 (org-forward-element)
5487 (org-forward-element)
5488 (forward-char -1))))
5489 ;; Next error for sparse trees
5490 (org-set-local 'next-error-function 'org-occur-next-match)
5491 ;; Make sure dependence stuff works reliably, even for users who set it
5492 ;; too late :-(
5493 (if org-enforce-todo-dependencies
5494 (add-hook 'org-blocker-hook
5495 'org-block-todo-from-children-or-siblings-or-parent)
5496 (remove-hook 'org-blocker-hook
5497 'org-block-todo-from-children-or-siblings-or-parent))
5498 (if org-enforce-todo-checkbox-dependencies
5499 (add-hook 'org-blocker-hook
5500 'org-block-todo-from-checkboxes)
5501 (remove-hook 'org-blocker-hook
5502 'org-block-todo-from-checkboxes))
5504 ;; Align options lines
5505 (org-set-local
5506 'align-mode-rules-list
5507 '((org-in-buffer-settings
5508 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5509 (modes . '(org-mode)))))
5511 ;; Imenu
5512 (org-set-local 'imenu-create-index-function
5513 'org-imenu-get-tree)
5515 ;; Make isearch reveal context
5516 (if (or (featurep 'xemacs)
5517 (not (boundp 'outline-isearch-open-invisible-function)))
5518 ;; Emacs 21 and XEmacs make use of the hook
5519 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5520 ;; Emacs 22 deals with this through a special variable
5521 (org-set-local 'outline-isearch-open-invisible-function
5522 (lambda (&rest ignore) (org-show-context 'isearch))))
5524 ;; Setup the pcomplete hooks
5525 (set (make-local-variable 'pcomplete-command-completion-function)
5526 'org-pcomplete-initial)
5527 (set (make-local-variable 'pcomplete-command-name-function)
5528 'org-command-at-point)
5529 (set (make-local-variable 'pcomplete-default-completion-function)
5530 'ignore)
5531 (set (make-local-variable 'pcomplete-parse-arguments-function)
5532 'org-parse-arguments)
5533 (set (make-local-variable 'pcomplete-termination-string) "")
5534 (when (>= emacs-major-version 23)
5535 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5537 ;; If empty file that did not turn on org-mode automatically, make it to.
5538 (if (and org-insert-mode-line-in-empty-file
5539 (org-called-interactively-p 'any)
5540 (= (point-min) (point-max)))
5541 (insert "# -*- mode: org -*-\n\n"))
5542 (unless org-inhibit-startup
5543 (org-unmodified
5544 (and org-startup-with-beamer-mode (org-beamer-mode))
5545 (when org-startup-align-all-tables
5546 (org-table-map-tables 'org-table-align 'quietly))
5547 (when org-startup-with-inline-images
5548 (org-display-inline-images))
5549 (when org-startup-with-latex-preview
5550 (org-toggle-latex-fragment))
5551 (unless org-inhibit-startup-visibility-stuff
5552 (org-set-startup-visibility))
5553 (org-refresh-effort-properties)))
5554 ;; Try to set org-hide correctly
5555 (let ((foreground (org-find-invisible-foreground)))
5556 (if foreground
5557 (set-face-foreground 'org-hide foreground))))
5559 ;; Update `customize-package-emacs-version-alist'
5560 (add-to-list 'customize-package-emacs-version-alist
5561 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5562 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5563 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5565 (defvar org-mode-transpose-word-syntax-table
5566 (let ((st (make-syntax-table text-mode-syntax-table)))
5567 (mapc (lambda(c) (modify-syntax-entry
5568 (string-to-char (car c)) "w p" st))
5569 org-emphasis-alist)
5570 st))
5572 (when (fboundp 'abbrev-table-put)
5573 (abbrev-table-put org-mode-abbrev-table
5574 :parents (list text-mode-abbrev-table)))
5576 (defun org-find-invisible-foreground ()
5577 (let ((candidates (remove
5578 "unspecified-bg"
5579 (nconc
5580 (list (face-background 'default)
5581 (face-background 'org-default))
5582 (mapcar
5583 (lambda (alist)
5584 (when (boundp alist)
5585 (cdr (assoc 'background-color (symbol-value alist)))))
5586 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5587 (list (face-foreground 'org-hide))))))
5588 (car (remove nil candidates))))
5590 (defun org-current-time (&optional rounding-minutes past)
5591 "Current time, possibly rounded to ROUNDING-MINUTES.
5592 When ROUNDING-MINUTES is not an integer, fall back on the car of
5593 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5594 the rounding returns a past time."
5595 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5596 (car org-time-stamp-rounding-minutes)))
5597 (time (decode-time)) res)
5598 (if (< r 1)
5599 (current-time)
5600 (setq res
5601 (apply 'encode-time
5602 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5603 (nthcdr 2 time))))
5604 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5605 (seconds-to-time (- (org-float-time res) (* r 60)))
5606 res))))
5608 (defun org-today ()
5609 "Return today date, considering `org-extend-today-until'."
5610 (time-to-days
5611 (time-subtract (current-time)
5612 (list 0 (* 3600 org-extend-today-until) 0))))
5614 ;;;; Font-Lock stuff, including the activators
5616 (defvar org-mouse-map (make-sparse-keymap))
5617 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5618 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5619 (when org-mouse-1-follows-link
5620 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5621 (when org-tab-follows-link
5622 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5623 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5625 (require 'font-lock)
5627 (defconst org-non-link-chars "]\t\n\r<>")
5628 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5629 "file+sys" "news" "shell" "elisp" "doi" "message"
5630 "help"))
5631 (defvar org-link-types-re nil
5632 "Matches a link that has a url-like prefix like \"http:\"")
5633 (defvar org-link-re-with-space nil
5634 "Matches a link with spaces, optional angular brackets around it.")
5635 (defvar org-link-re-with-space2 nil
5636 "Matches a link with spaces, optional angular brackets around it.")
5637 (defvar org-link-re-with-space3 nil
5638 "Matches a link with spaces, only for internal part in bracket links.")
5639 (defvar org-angle-link-re nil
5640 "Matches link with angular brackets, spaces are allowed.")
5641 (defvar org-plain-link-re nil
5642 "Matches plain link, without spaces.")
5643 (defvar org-bracket-link-regexp nil
5644 "Matches a link in double brackets.")
5645 (defvar org-bracket-link-analytic-regexp nil
5646 "Regular expression used to analyze links.
5647 Here is what the match groups contain after a match:
5648 1: http:
5649 2: http
5650 3: path
5651 4: [desc]
5652 5: desc")
5653 (defvar org-bracket-link-analytic-regexp++ nil
5654 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5655 (defvar org-any-link-re nil
5656 "Regular expression matching any link.")
5658 (defconst org-match-sexp-depth 3
5659 "Number of stacked braces for sub/superscript matching.")
5661 (defun org-create-multibrace-regexp (left right n)
5662 "Create a regular expression which will match a balanced sexp.
5663 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5664 as single character strings.
5665 The regexp returned will match the entire expression including the
5666 delimiters. It will also define a single group which contains the
5667 match except for the outermost delimiters. The maximum depth of
5668 stacked delimiters is N. Escaping delimiters is not possible."
5669 (let* ((nothing (concat "[^" left right "]*?"))
5670 (or "\\|")
5671 (re nothing)
5672 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5673 (while (> n 1)
5674 (setq n (1- n)
5675 re (concat re or next)
5676 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5677 (concat left "\\(" re "\\)" right)))
5679 (defconst org-match-substring-regexp
5680 (concat
5681 "\\(\\S-\\)\\([_^]\\)\\("
5682 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5683 "\\|"
5684 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5685 "\\|"
5686 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5687 "The regular expression matching a sub- or superscript.")
5689 (defconst org-match-substring-with-braces-regexp
5690 (concat
5691 "\\(\\S-\\)\\([_^]\\)"
5692 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5693 "The regular expression matching a sub- or superscript, forcing braces.")
5695 (defun org-make-link-regexps ()
5696 "Update the link regular expressions.
5697 This should be called after the variable `org-link-types' has changed."
5698 (let ((types-re (regexp-opt org-link-types t)))
5699 (setq org-link-types-re
5700 (concat "\\`" types-re ":")
5701 org-link-re-with-space
5702 (concat "<?" types-re ":"
5703 "\\([^" org-non-link-chars " ]"
5704 "[^" org-non-link-chars "]*"
5705 "[^" org-non-link-chars " ]\\)>?")
5706 org-link-re-with-space2
5707 (concat "<?" types-re ":"
5708 "\\([^" org-non-link-chars " ]"
5709 "[^\t\n\r]*"
5710 "[^" org-non-link-chars " ]\\)>?")
5711 org-link-re-with-space3
5712 (concat "<?" types-re ":"
5713 "\\([^" org-non-link-chars " ]"
5714 "[^\t\n\r]*\\)")
5715 org-angle-link-re
5716 (format "<%s:\\([^>\n]*\\(?:\n[ \t]*[^> \t\n][^>\n]*\\)*\\)>"
5717 types-re)
5718 org-plain-link-re
5719 (concat
5720 "\\<" types-re ":"
5721 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5722 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5723 org-bracket-link-regexp
5724 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5725 org-bracket-link-analytic-regexp
5726 (concat
5727 "\\[\\["
5728 "\\(" types-re ":\\)?"
5729 "\\([^]]+\\)"
5730 "\\]"
5731 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5732 "\\]")
5733 org-bracket-link-analytic-regexp++
5734 (concat
5735 "\\[\\["
5736 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5737 "\\([^]]+\\)"
5738 "\\]"
5739 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5740 "\\]")
5741 org-any-link-re
5742 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5743 org-angle-link-re "\\)\\|\\("
5744 org-plain-link-re "\\)"))))
5746 (org-make-link-regexps)
5748 (defvar org-emph-face nil)
5750 (defun org-do-emphasis-faces (limit)
5751 "Run through the buffer and emphasize strings."
5752 (let (rtn a)
5753 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5754 (let* ((border (char-after (match-beginning 3)))
5755 (bre (regexp-quote (char-to-string border))))
5756 (if (and (not (= border (char-after (match-beginning 4))))
5757 (not (save-match-data
5758 (string-match (concat bre ".*" bre)
5759 (replace-regexp-in-string
5760 "\n" " "
5761 (substring (match-string 2) 1 -1))))))
5762 (progn
5763 (setq rtn t)
5764 (setq a (assoc (match-string 3) org-emphasis-alist))
5765 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5766 'face
5767 (nth 1 a))
5768 (and (nth 2 a)
5769 (org-remove-flyspell-overlays-in
5770 (match-beginning 0) (match-end 0)))
5771 (add-text-properties (match-beginning 2) (match-end 2)
5772 '(font-lock-multiline t org-emphasis t))
5773 (when org-hide-emphasis-markers
5774 (add-text-properties (match-end 4) (match-beginning 5)
5775 '(invisible org-link))
5776 (add-text-properties (match-beginning 3) (match-end 3)
5777 '(invisible org-link))))))
5778 (goto-char (1+ (match-beginning 0))))
5779 rtn))
5781 (defun org-emphasize (&optional char)
5782 "Insert or change an emphasis, i.e. a font like bold or italic.
5783 If there is an active region, change that region to a new emphasis.
5784 If there is no region, just insert the marker characters and position
5785 the cursor between them.
5786 CHAR should be the marker character. If it is a space, it means to
5787 remove the emphasis of the selected region.
5788 If CHAR is not given (for example in an interactive call) it will be
5789 prompted for."
5790 (interactive)
5791 (let ((erc org-emphasis-regexp-components)
5792 (prompt "")
5793 (string "") beg end move c s)
5794 (if (org-region-active-p)
5795 (setq beg (region-beginning) end (region-end)
5796 string (buffer-substring beg end))
5797 (setq move t))
5799 (unless char
5800 (message "Emphasis marker or tag: [%s]"
5801 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5802 (setq char (read-char-exclusive)))
5803 (if (equal char ?\ )
5804 (setq s "" move nil)
5805 (unless (assoc (char-to-string char) org-emphasis-alist)
5806 (user-error "No such emphasis marker: \"%c\"" char))
5807 (setq s (char-to-string char)))
5808 (while (and (> (length string) 1)
5809 (equal (substring string 0 1) (substring string -1))
5810 (assoc (substring string 0 1) org-emphasis-alist))
5811 (setq string (substring string 1 -1)))
5812 (setq string (concat s string s))
5813 (if beg (delete-region beg end))
5814 (unless (or (bolp)
5815 (string-match (concat "[" (nth 0 erc) "\n]")
5816 (char-to-string (char-before (point)))))
5817 (insert " "))
5818 (unless (or (eobp)
5819 (string-match (concat "[" (nth 1 erc) "\n]")
5820 (char-to-string (char-after (point)))))
5821 (insert " ") (backward-char 1))
5822 (insert string)
5823 (and move (backward-char 1))))
5825 (defconst org-nonsticky-props
5826 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5828 (defsubst org-rear-nonsticky-at (pos)
5829 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5831 (defun org-activate-plain-links (limit)
5832 "Add link properties for plain links."
5833 (let (f hl)
5834 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5835 (not (member 'org-tag
5836 (get-text-property (1- (match-beginning 0)) 'face)))
5837 (not (org-in-src-block-p)))
5838 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5839 (setq f (get-text-property (match-beginning 0) 'face))
5840 (setq hl (org-match-string-no-properties 0))
5841 (if (or (eq f 'org-tag)
5842 (and (listp f) (memq 'org-tag f)))
5844 (add-text-properties (match-beginning 0) (match-end 0)
5845 (list 'mouse-face 'highlight
5846 'face 'org-link
5847 'htmlize-link `(:uri ,hl)
5848 'keymap org-mouse-map))
5849 (org-rear-nonsticky-at (match-end 0)))
5850 t)))
5852 (defun org-activate-code (limit)
5853 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5854 (progn
5855 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5856 (remove-text-properties (match-beginning 0) (match-end 0)
5857 '(display t invisible t intangible t))
5858 t)))
5860 (defcustom org-src-fontify-natively t
5861 "When non-nil, fontify code in code blocks."
5862 :type 'boolean
5863 :version "24.4"
5864 :package-version '(Org . "8.3")
5865 :group 'org-appearance
5866 :group 'org-babel)
5868 (defcustom org-allow-promoting-top-level-subtree nil
5869 "When non-nil, allow promoting a top level subtree.
5870 The leading star of the top level headline will be replaced
5871 by a #."
5872 :type 'boolean
5873 :version "24.1"
5874 :group 'org-appearance)
5876 (defun org-fontify-meta-lines-and-blocks (limit)
5877 (condition-case nil
5878 (org-fontify-meta-lines-and-blocks-1 limit)
5879 (error (message "org-mode fontification error"))))
5881 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5882 "Fontify #+ lines and blocks."
5883 (let ((case-fold-search t))
5884 (if (re-search-forward
5885 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5886 limit t)
5887 (let ((beg (match-beginning 0))
5888 (block-start (match-end 0))
5889 (block-end nil)
5890 (lang (match-string 7))
5891 (beg1 (line-beginning-position 2))
5892 (dc1 (downcase (match-string 2)))
5893 (dc3 (downcase (match-string 3)))
5894 end end1 quoting block-type ovl)
5895 (cond
5896 ((and (match-end 4) (equal dc3 "+begin"))
5897 ;; Truly a block
5898 (setq block-type (downcase (match-string 5))
5899 quoting (member block-type org-protecting-blocks))
5900 (when (re-search-forward
5901 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5902 nil t) ;; on purpose, we look further than LIMIT
5903 (setq end (min (point-max) (match-end 0))
5904 end1 (min (point-max) (1- (match-beginning 0))))
5905 (setq block-end (match-beginning 0))
5906 (when quoting
5907 (org-remove-flyspell-overlays-in beg1 end1)
5908 (remove-text-properties beg end
5909 '(display t invisible t intangible t)))
5910 (add-text-properties
5911 beg end '(font-lock-fontified t font-lock-multiline t))
5912 (add-text-properties beg beg1 '(face org-meta-line))
5913 (org-remove-flyspell-overlays-in beg beg1)
5914 (add-text-properties ; For end_src
5915 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5916 (org-remove-flyspell-overlays-in end1 end)
5917 (cond
5918 ((and lang (not (string= lang "")) org-src-fontify-natively)
5919 (org-src-font-lock-fontify-block lang block-start block-end)
5920 (add-text-properties beg1 block-end '(src-block t)))
5921 (quoting
5922 (add-text-properties beg1 (min (point-max) (1+ end1))
5923 '(face org-block))) ; end of source block
5924 ((not org-fontify-quote-and-verse-blocks))
5925 ((string= block-type "quote")
5926 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5927 ((string= block-type "verse")
5928 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5929 (add-text-properties beg beg1 '(face org-block-begin-line))
5930 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5931 '(face org-block-end-line))
5933 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5934 (org-remove-flyspell-overlays-in
5935 (match-beginning 0)
5936 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5937 (add-text-properties
5938 beg (match-end 3)
5939 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5940 '(font-lock-fontified t invisible t)
5941 '(font-lock-fontified t face org-document-info-keyword)))
5942 (add-text-properties
5943 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5944 (if (string-equal dc1 "+title:")
5945 '(font-lock-fontified t face org-document-title)
5946 '(font-lock-fontified t face org-document-info))))
5947 ((equal dc1 "+caption:")
5948 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5949 (remove-text-properties (match-beginning 0) (match-end 0)
5950 '(display t invisible t intangible t))
5951 (add-text-properties (match-beginning 1) (match-end 3)
5952 '(font-lock-fontified t face org-meta-line))
5953 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5954 '(font-lock-fontified t face org-block))
5956 ((member dc3 '(" " ""))
5957 (org-remove-flyspell-overlays-in beg (match-end 0))
5958 (add-text-properties
5959 beg (match-end 0)
5960 '(font-lock-fontified t face font-lock-comment-face)))
5961 (t ;; just any other in-buffer setting, but not indented
5962 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5963 (remove-text-properties (match-beginning 0) (match-end 0)
5964 '(display t invisible t intangible t))
5965 (add-text-properties beg (match-end 0)
5966 '(font-lock-fontified t face org-meta-line))
5967 t))))))
5969 (defun org-fontify-drawers (limit)
5970 "Fontify drawers."
5971 (when (re-search-forward org-drawer-regexp limit t)
5972 (add-text-properties
5973 (match-beginning 0) (match-end 0)
5974 '(font-lock-fontified t face org-special-keyword))
5975 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5978 (defun org-fontify-macros (limit)
5979 "Fontify macros."
5980 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5981 (add-text-properties
5982 (match-beginning 0) (match-end 0)
5983 '(font-lock-fontified t face org-macro))
5984 (when org-hide-macro-markers
5985 (add-text-properties (match-end 2) (match-beginning 2)
5986 '(invisible t))
5987 (add-text-properties (match-beginning 1) (match-end 1)
5988 '(invisible t)))
5989 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5992 (defun org-activate-angle-links (limit)
5993 "Add text properties for angle links."
5994 (if (and (re-search-forward org-angle-link-re limit t)
5995 (not (org-in-src-block-p)))
5996 (progn
5997 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5998 (add-text-properties (match-beginning 0) (match-end 0)
5999 (list 'mouse-face 'highlight
6000 'keymap org-mouse-map
6001 'font-lock-multiline t))
6002 (org-rear-nonsticky-at (match-end 0))
6003 t)))
6005 (defun org-activate-footnote-links (limit)
6006 "Add text properties for footnotes."
6007 (let ((fn (org-footnote-next-reference-or-definition limit)))
6008 (when fn
6009 (let* ((beg (nth 1 fn))
6010 (end (nth 2 fn))
6011 (label (car fn))
6012 (referencep (/= (line-beginning-position) beg)))
6013 (when (and referencep (nth 3 fn))
6014 (save-excursion
6015 (goto-char beg)
6016 (search-forward (or label "fn:"))
6017 (org-remove-flyspell-overlays-in beg (match-end 0))))
6018 (add-text-properties beg end
6019 (list 'mouse-face 'highlight
6020 'keymap org-mouse-map
6021 'help-echo
6022 (if referencep "Footnote reference"
6023 "Footnote definition")
6024 'font-lock-fontified t
6025 'font-lock-multiline t
6026 'face 'org-footnote))))))
6028 (defun org-activate-bracket-links (limit)
6029 "Add text properties for bracketed links."
6030 (if (and (re-search-forward org-bracket-link-regexp limit t)
6031 (not (org-in-src-block-p)))
6032 (let* ((hl (org-match-string-no-properties 1))
6033 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6034 (ip (org-maybe-intangible
6035 (list 'invisible 'org-link
6036 'keymap org-mouse-map 'mouse-face 'highlight
6037 'font-lock-multiline t 'help-echo help
6038 'htmlize-link `(:uri ,hl))))
6039 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6040 'font-lock-multiline t 'help-echo help
6041 'htmlize-link `(:uri ,hl))))
6042 ;; We need to remove the invisible property here. Table narrowing
6043 ;; may have made some of this invisible.
6044 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6045 (remove-text-properties (match-beginning 0) (match-end 0)
6046 '(invisible nil))
6047 (if (match-end 3)
6048 (progn
6049 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6050 (org-rear-nonsticky-at (match-beginning 3))
6051 (add-text-properties (match-beginning 3) (match-end 3) vp)
6052 (org-rear-nonsticky-at (match-end 3))
6053 (add-text-properties (match-end 3) (match-end 0) ip)
6054 (org-rear-nonsticky-at (match-end 0)))
6055 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6056 (org-rear-nonsticky-at (match-beginning 1))
6057 (add-text-properties (match-beginning 1) (match-end 1) vp)
6058 (org-rear-nonsticky-at (match-end 1))
6059 (add-text-properties (match-end 1) (match-end 0) ip)
6060 (org-rear-nonsticky-at (match-end 0)))
6061 t)))
6063 (defun org-activate-dates (limit)
6064 "Add text properties for dates."
6065 (if (and (re-search-forward org-tsr-regexp-both limit t)
6066 (not (equal (char-before (match-beginning 0)) 91)))
6067 (progn
6068 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6069 (add-text-properties (match-beginning 0) (match-end 0)
6070 (list 'mouse-face 'highlight
6071 'keymap org-mouse-map))
6072 (org-rear-nonsticky-at (match-end 0))
6073 (when org-display-custom-times
6074 (if (match-end 3)
6075 (org-display-custom-time (match-beginning 3) (match-end 3)))
6076 (org-display-custom-time (match-beginning 1) (match-end 1)))
6077 t)))
6079 (defvar org-target-link-regexp nil
6080 "Regular expression matching radio targets in plain text.")
6081 (make-variable-buffer-local 'org-target-link-regexp)
6083 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6084 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6085 border border border))
6086 "Regular expression matching a link target.")
6088 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6089 "Regular expression matching a radio target.")
6091 (defconst org-any-target-regexp
6092 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6093 "Regular expression matching any target.")
6095 (defun org-activate-target-links (limit)
6096 "Add text properties for target matches."
6097 (when org-target-link-regexp
6098 (let ((case-fold-search t))
6099 (if (re-search-forward org-target-link-regexp limit t)
6100 (progn
6101 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6102 (add-text-properties (match-beginning 1) (match-end 1)
6103 (list 'mouse-face 'highlight
6104 'keymap org-mouse-map
6105 'help-echo "Radio target link"
6106 'org-linked-text t))
6107 (org-rear-nonsticky-at (match-end 1))
6108 t)))))
6110 (defun org-update-radio-target-regexp ()
6111 "Find all radio targets in this file and update the regular expression.
6112 Also refresh fontification if needed."
6113 (interactive)
6114 (let ((old-regexp org-target-link-regexp)
6115 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6116 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6117 (targets
6118 (org-with-wide-buffer
6119 (goto-char (point-min))
6120 (let (rtn)
6121 (while (re-search-forward org-radio-target-regexp nil t)
6122 ;; Make sure point is really within the object.
6123 (backward-char)
6124 (let ((obj (org-element-context)))
6125 (when (eq (org-element-type obj) 'radio-target)
6126 (add-to-list 'rtn (org-element-property :value obj)))))
6127 rtn))))
6128 (setq org-target-link-regexp
6129 (and targets
6130 (concat before-re
6131 (mapconcat
6132 (lambda (x)
6133 (replace-regexp-in-string
6134 " +" "\\s-+" (regexp-quote x) t t))
6135 targets
6136 "\\|")
6137 after-re)))
6138 (unless (equal old-regexp org-target-link-regexp)
6139 ;; Clean-up cache.
6140 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6141 ((not org-target-link-regexp) old-regexp)
6143 (concat before-re
6144 (mapconcat
6145 (lambda (re)
6146 (substring re (length before-re)
6147 (- (length after-re))))
6148 (list old-regexp org-target-link-regexp)
6149 "\\|")
6150 after-re)))))
6151 (org-with-wide-buffer
6152 (goto-char (point-min))
6153 (while (re-search-forward regexp nil t)
6154 (org-element-cache-refresh (match-beginning 1)))))
6155 ;; Re fontify buffer.
6156 (when (memq 'radio org-highlight-links)
6157 (org-restart-font-lock)))))
6159 (defun org-hide-wide-columns (limit)
6160 (let (s e)
6161 (setq s (text-property-any (point) (or limit (point-max))
6162 'org-cwidth t))
6163 (when s
6164 (setq e (next-single-property-change s 'org-cwidth))
6165 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6166 (goto-char e)
6167 t)))
6169 (defvar org-latex-and-related-regexp nil
6170 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6172 (defun org-compute-latex-and-related-regexp ()
6173 "Compute regular expression for LaTeX, entities and sub/superscript.
6174 Result depends on variable `org-highlight-latex-and-related'."
6175 (org-set-local
6176 'org-latex-and-related-regexp
6177 (let* ((re-sub
6178 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6179 ((eq org-use-sub-superscripts '{})
6180 (list org-match-substring-with-braces-regexp))
6181 (org-use-sub-superscripts (list org-match-substring-regexp))))
6182 (re-latex
6183 (when (memq 'latex org-highlight-latex-and-related)
6184 (let ((matchers (plist-get org-format-latex-options :matchers)))
6185 (delq nil
6186 (mapcar (lambda (x)
6187 (and (member (car x) matchers) (nth 1 x)))
6188 org-latex-regexps)))))
6189 (re-entities
6190 (when (memq 'entities org-highlight-latex-and-related)
6191 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6192 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6194 (defun org-do-latex-and-related (limit)
6195 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6196 LIMIT bounds the search for syntax to highlight. Stop at first
6197 highlighted object, if any. Return t if some highlighting was
6198 done, nil otherwise."
6199 (when (org-string-nw-p org-latex-and-related-regexp)
6200 (catch 'found
6201 (while (re-search-forward org-latex-and-related-regexp limit t)
6202 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6203 'face))
6204 '(org-code org-verbatim underline))
6205 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6206 '(?_ ?^))
6208 0)))
6209 (font-lock-prepend-text-property
6210 (+ offset (match-beginning 0)) (match-end 0)
6211 'face 'org-latex-and-related)
6212 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6213 '(font-lock-multiline t)))
6214 (throw 'found t)))
6215 nil)))
6217 (defun org-restart-font-lock ()
6218 "Restart `font-lock-mode', to force refontification."
6219 (when (and (boundp 'font-lock-mode) font-lock-mode)
6220 (font-lock-mode -1)
6221 (font-lock-mode 1)))
6223 (defun org-activate-tags (limit)
6224 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6225 (progn
6226 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6227 (add-text-properties (match-beginning 1) (match-end 1)
6228 (list 'mouse-face 'highlight
6229 'keymap org-mouse-map))
6230 (org-rear-nonsticky-at (match-end 1))
6231 t)))
6233 (defun org-outline-level ()
6234 "Compute the outline level of the heading at point.
6236 If this is called at a normal headline, the level is the number
6237 of stars. Use `org-reduced-level' to remove the effect of
6238 `org-odd-levels'. Unlike to `org-current-level', this function
6239 takes into consideration inlinetasks."
6240 (org-with-wide-buffer
6241 (end-of-line)
6242 (if (re-search-backward org-outline-regexp-bol nil t)
6243 (1- (- (match-end 0) (match-beginning 0)))
6244 0)))
6246 (defvar org-font-lock-keywords nil)
6248 (defsubst org-re-property (property &optional literal allow-null value)
6249 "Return a regexp matching a PROPERTY line.
6251 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6252 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6253 non-nil, match properties even without a value.
6255 Match group 3 is set to the value when it exists. If there is no
6256 value and ALLOW-NULL is non-nil, it is set to the empty string.
6258 With optional argument VALUE, match only property lines with
6259 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6260 unless LITERAL is non-nil."
6261 (concat
6262 "^\\(?4:[ \t]*\\)"
6263 (format "\\(?1::\\(?2:%s\\):\\)"
6264 (if literal property (regexp-quote property)))
6265 (cond (value
6266 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6267 (if literal value (regexp-quote value))))
6268 (allow-null
6269 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6271 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6273 (defconst org-property-re
6274 (org-re-property "\\S-+" 'literal t)
6275 "Regular expression matching a property line.
6276 There are four matching groups:
6277 1: :PROPKEY: including the leading and trailing colon,
6278 2: PROPKEY without the leading and trailing colon,
6279 3: PROPVAL without leading or trailing spaces,
6280 4: the indentation of the current line,
6281 5: trailing whitespace.")
6283 (defvar org-font-lock-hook nil
6284 "Functions to be called for special font lock stuff.")
6286 (defvar org-font-lock-set-keywords-hook nil
6287 "Functions that can manipulate `org-font-lock-extra-keywords'.
6288 This is called after `org-font-lock-extra-keywords' is defined, but before
6289 it is installed to be used by font lock. This can be useful if something
6290 needs to be inserted at a specific position in the font-lock sequence.")
6292 (defun org-font-lock-hook (limit)
6293 "Run `org-font-lock-hook' within LIMIT."
6294 (run-hook-with-args 'org-font-lock-hook limit))
6296 (defun org-set-font-lock-defaults ()
6297 "Set font lock defaults for the current buffer."
6298 (let* ((em org-fontify-emphasized-text)
6299 (lk org-highlight-links)
6300 (org-font-lock-extra-keywords
6301 (list
6302 ;; Call the hook
6303 '(org-font-lock-hook)
6304 ;; Headlines
6305 `(,(if org-fontify-whole-heading-line
6306 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6307 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6308 (1 (org-get-level-face 1))
6309 (2 (org-get-level-face 2))
6310 (3 (org-get-level-face 3)))
6311 ;; Table lines
6312 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6313 (1 'org-table t))
6314 ;; Table internals
6315 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6316 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6317 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6318 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6319 ;; Drawers
6320 '(org-fontify-drawers)
6321 ;; Properties
6322 (list org-property-re
6323 '(1 'org-special-keyword t)
6324 '(3 'org-property-value t))
6325 ;; Links
6326 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6327 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6328 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6329 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6330 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6331 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6332 (if (memq 'footnote lk) '(org-activate-footnote-links))
6333 ;; Targets.
6334 (list org-any-target-regexp '(0 'org-target t))
6335 ;; Diary sexps.
6336 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6337 ;; Macro
6338 '(org-fontify-macros)
6339 '(org-hide-wide-columns (0 nil append))
6340 ;; TODO keyword
6341 (list (format org-heading-keyword-regexp-format
6342 org-todo-regexp)
6343 '(2 (org-get-todo-face 2) t))
6344 ;; DONE
6345 (if org-fontify-done-headline
6346 (list (format org-heading-keyword-regexp-format
6347 (concat
6348 "\\(?:"
6349 (mapconcat 'regexp-quote org-done-keywords "\\|")
6350 "\\)"))
6351 '(2 'org-headline-done t))
6352 nil)
6353 ;; Priorities
6354 '(org-font-lock-add-priority-faces)
6355 ;; Tags
6356 '(org-font-lock-add-tag-faces)
6357 ;; Tags groups
6358 (if (and org-group-tags org-tag-groups-alist)
6359 (list (concat org-outline-regexp-bol ".+\\(:"
6360 (regexp-opt (mapcar 'car org-tag-groups-alist))
6361 ":\\).*$")
6362 '(1 'org-tag-group prepend)))
6363 ;; Special keywords
6364 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6365 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6366 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6367 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6368 ;; Emphasis
6369 (if em
6370 (if (featurep 'xemacs)
6371 '(org-do-emphasis-faces (0 nil append))
6372 '(org-do-emphasis-faces)))
6373 ;; Checkboxes
6374 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6375 1 'org-checkbox prepend)
6376 (if (cdr (assq 'checkbox org-list-automatic-rules))
6377 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6378 (0 (org-get-checkbox-statistics-face) t)))
6379 ;; Description list items
6380 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6381 1 'org-list-dt prepend)
6382 ;; ARCHIVEd headings
6383 (list (concat
6384 org-outline-regexp-bol
6385 "\\(.*:" org-archive-tag ":.*\\)")
6386 '(1 'org-archived prepend))
6387 ;; Specials
6388 '(org-do-latex-and-related)
6389 '(org-fontify-entities)
6390 '(org-raise-scripts)
6391 ;; Code
6392 '(org-activate-code (1 'org-code t))
6393 ;; COMMENT
6394 (list (format
6395 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6396 org-todo-regexp
6397 org-comment-string)
6398 '(9 'org-special-keyword t))
6399 ;; Blocks and meta lines
6400 '(org-fontify-meta-lines-and-blocks))))
6401 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6402 (run-hooks 'org-font-lock-set-keywords-hook)
6403 ;; Now set the full font-lock-keywords
6404 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6405 (org-set-local 'font-lock-defaults
6406 '(org-font-lock-keywords t nil nil backward-paragraph))
6407 (kill-local-variable 'font-lock-keywords) nil))
6409 (defun org-toggle-pretty-entities ()
6410 "Toggle the composition display of entities as UTF8 characters."
6411 (interactive)
6412 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6413 (org-restart-font-lock)
6414 (if org-pretty-entities
6415 (message "Entities are now displayed as UTF8 characters")
6416 (save-restriction
6417 (widen)
6418 (org-decompose-region (point-min) (point-max))
6419 (message "Entities are now displayed as plain text"))))
6421 (defvar org-custom-properties-overlays nil
6422 "List of overlays used for custom properties.")
6423 (make-variable-buffer-local 'org-custom-properties-overlays)
6425 (defun org-toggle-custom-properties-visibility ()
6426 "Display or hide properties in `org-custom-properties'."
6427 (interactive)
6428 (if org-custom-properties-overlays
6429 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6430 (setq org-custom-properties-overlays nil))
6431 (when org-custom-properties
6432 (org-with-wide-buffer
6433 (goto-char (point-min))
6434 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6435 (while (re-search-forward regexp nil t)
6436 (let ((end (cdr (save-match-data (org-get-property-block)))))
6437 (when (and end (< (point) end))
6438 ;; Hide first custom property in current drawer.
6439 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6440 (overlay-put o 'invisible t)
6441 (overlay-put o 'org-custom-property t)
6442 (push o org-custom-properties-overlays))
6443 ;; Hide additional custom properties in the same drawer.
6444 (while (re-search-forward regexp end t)
6445 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6446 (overlay-put o 'invisible t)
6447 (overlay-put o 'org-custom-property t)
6448 (push o org-custom-properties-overlays)))))
6449 ;; Each entry is limited to a single property drawer.
6450 (outline-next-heading)))))))
6452 (defun org-fontify-entities (limit)
6453 "Find an entity to fontify."
6454 (let (ee)
6455 (when org-pretty-entities
6456 (catch 'match
6457 ;; "\_ "-family is left out on purpose. Only the first one,
6458 ;; i.e., "\_ ", could be fontified anyway, and it would be
6459 ;; confusing when adding a second white space character.
6460 (while (re-search-forward
6461 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6462 limit t)
6463 (if (and (not (org-at-comment-p))
6464 (setq ee (org-entity-get (match-string 1)))
6465 (= (length (nth 6 ee)) 1))
6466 (let*
6467 ((end (if (equal (match-string 2) "{}")
6468 (match-end 2)
6469 (match-end 1))))
6470 (add-text-properties
6471 (match-beginning 0) end
6472 (list 'font-lock-fontified t))
6473 (compose-region (match-beginning 0) end
6474 (nth 6 ee) nil)
6475 (backward-char 1)
6476 (throw 'match t))))
6477 nil))))
6479 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6480 "Fontify string S like in Org-mode."
6481 (with-temp-buffer
6482 (insert s)
6483 (let ((org-odd-levels-only odd-levels))
6484 (org-mode)
6485 (font-lock-ensure)
6486 (buffer-string))))
6488 (defvar org-m nil)
6489 (defvar org-l nil)
6490 (defvar org-f nil)
6491 (defun org-get-level-face (n)
6492 "Get the right face for match N in font-lock matching of headlines."
6493 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6494 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6495 (if org-cycle-level-faces
6496 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6497 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6498 (cond
6499 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6500 ((eq n 2) org-f)
6501 (t (if org-level-color-stars-only nil org-f))))
6503 (defun org-face-from-face-or-color (context inherit face-or-color)
6504 "Create a face list that inherits INHERIT, but sets the foreground color.
6505 When FACE-OR-COLOR is not a string, just return it."
6506 (if (stringp face-or-color)
6507 (list :inherit inherit
6508 (cdr (assoc context org-faces-easy-properties))
6509 face-or-color)
6510 face-or-color))
6512 (defun org-get-todo-face (kwd)
6513 "Get the right face for a TODO keyword KWD.
6514 If KWD is a number, get the corresponding match group."
6515 (if (numberp kwd) (setq kwd (match-string kwd)))
6516 (or (org-face-from-face-or-color
6517 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6518 (and (member kwd org-done-keywords) 'org-done)
6519 'org-todo))
6521 (defun org-get-priority-face (priority)
6522 "Get the right face for PRIORITY.
6523 PRIORITY is a character."
6524 (or (org-face-from-face-or-color
6525 'priority 'org-priority (cdr (assq priority org-priority-faces)))
6526 'org-priority))
6528 (defun org-get-tag-face (tag)
6529 "Get the right face for TAG.
6530 If TAG is a number, get the corresponding match group."
6531 (let ((tag (if (wholenump tag) (match-string tag) tag)))
6532 (or (org-face-from-face-or-color
6533 'tag 'org-tag (cdr (assoc tag org-tag-faces)))
6534 'org-tag)))
6536 (defun org-font-lock-add-priority-faces (limit)
6537 "Add the special priority faces."
6538 (while (re-search-forward "^\\*+ .*?\\(\\[#\\(.\\)\\]\\)" limit t)
6539 (add-text-properties
6540 (match-beginning 1) (match-end 1)
6541 (list 'face (org-get-priority-face (string-to-char (match-string 2)))
6542 'font-lock-fontified t))))
6544 (defun org-font-lock-add-tag-faces (limit)
6545 "Add the special tag faces."
6546 (when (and org-tag-faces org-tags-special-faces-re)
6547 (while (re-search-forward org-tags-special-faces-re limit t)
6548 (add-text-properties (match-beginning 1) (match-end 1)
6549 (list 'face (org-get-tag-face 1)
6550 'font-lock-fontified t))
6551 (backward-char 1))))
6553 (defun org-unfontify-region (beg end &optional maybe_loudly)
6554 "Remove fontification and activation overlays from links."
6555 (font-lock-default-unfontify-region beg end)
6556 (let* ((buffer-undo-list t)
6557 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6558 (inhibit-modification-hooks t)
6559 deactivate-mark buffer-file-name buffer-file-truename)
6560 (org-decompose-region beg end)
6561 (remove-text-properties beg end
6562 '(mouse-face t keymap t org-linked-text t
6563 invisible t intangible t
6564 org-emphasis t))
6565 (org-remove-font-lock-display-properties beg end)))
6567 (defconst org-script-display '(((raise -0.3) (height 0.7))
6568 ((raise 0.3) (height 0.7))
6569 ((raise -0.5))
6570 ((raise 0.5)))
6571 "Display properties for showing superscripts and subscripts.")
6573 (defun org-remove-font-lock-display-properties (beg end)
6574 "Remove specific display properties that have been added by font lock.
6575 The will remove the raise properties that are used to show superscripts
6576 and subscripts."
6577 (let (next prop)
6578 (while (< beg end)
6579 (setq next (next-single-property-change beg 'display nil end)
6580 prop (get-text-property beg 'display))
6581 (if (member prop org-script-display)
6582 (put-text-property beg next 'display nil))
6583 (setq beg next))))
6585 (defun org-raise-scripts (limit)
6586 "Add raise properties to sub/superscripts."
6587 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6588 (if (re-search-forward
6589 (if (eq org-use-sub-superscripts t)
6590 org-match-substring-regexp
6591 org-match-substring-with-braces-regexp)
6592 limit t)
6593 (let* ((pos (point)) table-p comment-p
6594 (mpos (match-beginning 3))
6595 (emph-p (get-text-property mpos 'org-emphasis))
6596 (link-p (get-text-property mpos 'mouse-face))
6597 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6598 (goto-char (point-at-bol))
6599 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6600 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6601 (goto-char pos)
6602 ;; Handle a_b^c
6603 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6604 (if (or comment-p emph-p link-p keyw-p)
6606 (put-text-property (match-beginning 3) (match-end 0)
6607 'display
6608 (if (equal (char-after (match-beginning 2)) ?^)
6609 (nth (if table-p 3 1) org-script-display)
6610 (nth (if table-p 2 0) org-script-display)))
6611 (add-text-properties (match-beginning 2) (match-end 2)
6612 (list 'invisible t
6613 'org-dwidth t 'org-dwidth-n 1))
6614 (if (and (eq (char-after (match-beginning 3)) ?{)
6615 (eq (char-before (match-end 3)) ?}))
6616 (progn
6617 (add-text-properties
6618 (match-beginning 3) (1+ (match-beginning 3))
6619 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6620 (add-text-properties
6621 (1- (match-end 3)) (match-end 3)
6622 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6623 t)))))
6625 ;;;; Visibility cycling, including org-goto and indirect buffer
6627 ;;; Cycling
6629 (defvar org-cycle-global-status nil)
6630 (make-variable-buffer-local 'org-cycle-global-status)
6631 (put 'org-cycle-global-status 'org-state t)
6632 (defvar org-cycle-subtree-status nil)
6633 (make-variable-buffer-local 'org-cycle-subtree-status)
6634 (put 'org-cycle-subtree-status 'org-state t)
6636 (defvar org-inlinetask-min-level)
6638 (defun org-unlogged-message (&rest args)
6639 "Display a message, but avoid logging it in the *Messages* buffer."
6640 (let ((message-log-max nil))
6641 (apply 'message args)))
6643 ;;;###autoload
6644 (defun org-cycle (&optional arg)
6645 "TAB-action and visibility cycling for Org-mode.
6647 This is the command invoked in Org-mode by the TAB key. Its main purpose
6648 is outline visibility cycling, but it also invokes other actions
6649 in special contexts.
6651 - When this function is called with a prefix argument, rotate the entire
6652 buffer through 3 states (global cycling)
6653 1. OVERVIEW: Show only top-level headlines.
6654 2. CONTENTS: Show all headlines of all levels, but no body text.
6655 3. SHOW ALL: Show everything.
6656 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6657 determined by the variable `org-startup-folded', and by any VISIBILITY
6658 properties in the buffer.
6659 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6660 including any drawers.
6662 - When inside a table, re-align the table and move to the next field.
6664 - When point is at the beginning of a headline, rotate the subtree started
6665 by this line through 3 different states (local cycling)
6666 1. FOLDED: Only the main headline is shown.
6667 2. CHILDREN: The main headline and the direct children are shown.
6668 From this state, you can move to one of the children
6669 and zoom in further.
6670 3. SUBTREE: Show the entire subtree, including body text.
6671 If there is no subtree, switch directly from CHILDREN to FOLDED.
6673 - When point is at the beginning of an empty headline and the variable
6674 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6675 of the headline by demoting and promoting it to likely levels. This
6676 speeds up creation document structure by pressing TAB once or several
6677 times right after creating a new headline.
6679 - When there is a numeric prefix, go up to a heading with level ARG, do
6680 a `show-subtree' and return to the previous cursor position. If ARG
6681 is negative, go up that many levels.
6683 - When point is not at the beginning of a headline, execute the global
6684 binding for TAB, which is re-indenting the line. See the option
6685 `org-cycle-emulate-tab' for details.
6687 - Special case: if point is at the beginning of the buffer and there is
6688 no headline in line 1, this function will act as if called with prefix arg
6689 (C-u TAB, same as S-TAB) also when called without prefix arg.
6690 But only if also the variable `org-cycle-global-at-bob' is t."
6691 (interactive "P")
6692 (org-load-modules-maybe)
6693 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6694 (and org-cycle-level-after-item/entry-creation
6695 (or (org-cycle-level)
6696 (org-cycle-item-indentation))))
6697 (let* ((limit-level
6698 (or org-cycle-max-level
6699 (and (boundp 'org-inlinetask-min-level)
6700 org-inlinetask-min-level
6701 (1- org-inlinetask-min-level))))
6702 (nstars (and limit-level
6703 (if org-odd-levels-only
6704 (and limit-level (1- (* limit-level 2)))
6705 limit-level)))
6706 (org-outline-regexp
6707 (if (not (derived-mode-p 'org-mode))
6708 outline-regexp
6709 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6710 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6711 (not (looking-at org-outline-regexp))))
6712 (org-cycle-hook
6713 (if bob-special
6714 (delq 'org-optimize-window-after-visibility-change
6715 (copy-sequence org-cycle-hook))
6716 org-cycle-hook))
6717 (pos (point)))
6719 (if (or bob-special (equal arg '(4)))
6720 ;; special case: use global cycling
6721 (setq arg t))
6723 (cond
6725 ((equal arg '(16))
6726 (setq last-command 'dummy)
6727 (org-set-startup-visibility)
6728 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6730 ((equal arg '(64))
6731 (show-all)
6732 (org-unlogged-message "Entire buffer visible, including drawers"))
6734 ;; Try cdlatex TAB completion
6735 ((org-try-cdlatex-tab))
6737 ;; Table: enter it or move to the next field.
6738 ((org-at-table-p 'any)
6739 (if (org-at-table.el-p)
6740 (message "Use C-c ' to edit table.el tables")
6741 (if arg (org-table-edit-field t)
6742 (org-table-justify-field-maybe)
6743 (call-interactively 'org-table-next-field))))
6745 ((run-hook-with-args-until-success
6746 'org-tab-after-check-for-table-hook))
6748 ;; Global cycling: delegate to `org-cycle-internal-global'.
6749 ((eq arg t) (org-cycle-internal-global))
6751 ;; Drawers: delegate to `org-flag-drawer'.
6752 ((save-excursion
6753 (beginning-of-line 1)
6754 (looking-at org-drawer-regexp))
6755 (org-flag-drawer ; toggle block visibility
6756 (not (get-char-property (match-end 0) 'invisible))))
6758 ;; Show-subtree, ARG levels up from here.
6759 ((integerp arg)
6760 (save-excursion
6761 (org-back-to-heading)
6762 (outline-up-heading (if (< arg 0) (- arg)
6763 (- (funcall outline-level) arg)))
6764 (org-show-subtree)))
6766 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6767 ((and (featurep 'org-inlinetask)
6768 (org-inlinetask-at-task-p)
6769 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6770 (org-inlinetask-toggle-visibility))
6772 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6773 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6774 (save-excursion (move-beginning-of-line 1)
6775 (looking-at org-outline-regexp)))
6776 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6777 (org-cycle-internal-local))
6779 ;; From there: TAB emulation and template completion.
6780 (buffer-read-only (org-back-to-heading))
6782 ((run-hook-with-args-until-success
6783 'org-tab-after-check-for-cycling-hook))
6785 ((org-try-structure-completion))
6787 ((run-hook-with-args-until-success
6788 'org-tab-before-tab-emulation-hook))
6790 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6791 (or (not (bolp))
6792 (not (looking-at org-outline-regexp))))
6793 (call-interactively (global-key-binding "\t")))
6795 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6796 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6797 (or (and (eq org-cycle-emulate-tab 'white)
6798 (= (match-end 0) (point-at-eol)))
6799 (and (eq org-cycle-emulate-tab 'whitestart)
6800 (>= (match-end 0) pos))))
6802 (eq org-cycle-emulate-tab t))
6803 (call-interactively (global-key-binding "\t")))
6805 (t (save-excursion
6806 (org-back-to-heading)
6807 (org-cycle)))))))
6809 (defun org-cycle-internal-global ()
6810 "Do the global cycling action."
6811 ;; Hack to avoid display of messages for .org attachments in Gnus
6812 (let ((ga (string-match "\\*fontification" (buffer-name))))
6813 (cond
6814 ((and (eq last-command this-command)
6815 (eq org-cycle-global-status 'overview))
6816 ;; We just created the overview - now do table of contents
6817 ;; This can be slow in very large buffers, so indicate action
6818 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6819 (unless ga (org-unlogged-message "CONTENTS..."))
6820 (org-content)
6821 (unless ga (org-unlogged-message "CONTENTS...done"))
6822 (setq org-cycle-global-status 'contents)
6823 (run-hook-with-args 'org-cycle-hook 'contents))
6825 ((and (eq last-command this-command)
6826 (eq org-cycle-global-status 'contents))
6827 ;; We just showed the table of contents - now show everything
6828 (run-hook-with-args 'org-pre-cycle-hook 'all)
6829 (show-all)
6830 (unless ga (org-unlogged-message "SHOW ALL"))
6831 (setq org-cycle-global-status 'all)
6832 (run-hook-with-args 'org-cycle-hook 'all))
6835 ;; Default action: go to overview
6836 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6837 (org-overview)
6838 (unless ga (org-unlogged-message "OVERVIEW"))
6839 (setq org-cycle-global-status 'overview)
6840 (run-hook-with-args 'org-cycle-hook 'overview)))))
6842 (defvar org-called-with-limited-levels nil
6843 "Non-nil when `org-with-limited-levels' is currently active.")
6845 (defun org-cycle-internal-local ()
6846 "Do the local cycling action."
6847 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6848 ;; First, determine end of headline (EOH), end of subtree or item
6849 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6850 (save-excursion
6851 (if (org-at-item-p)
6852 (progn
6853 (beginning-of-line)
6854 (setq struct (org-list-struct))
6855 (setq eoh (point-at-eol))
6856 (setq eos (org-list-get-item-end-before-blank (point) struct))
6857 (setq has-children (org-list-has-child-p (point) struct)))
6858 (org-back-to-heading)
6859 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6860 (setq eos (save-excursion (org-end-of-subtree t t)
6861 (when (bolp) (backward-char)) (point)))
6862 (setq has-children
6863 (or (save-excursion
6864 (let ((level (funcall outline-level)))
6865 (outline-next-heading)
6866 (and (org-at-heading-p t)
6867 (> (funcall outline-level) level))))
6868 (save-excursion
6869 (org-list-search-forward (org-item-beginning-re) eos t)))))
6870 ;; Determine end invisible part of buffer (EOL)
6871 (beginning-of-line 2)
6872 ;; XEmacs doesn't have `next-single-char-property-change'
6873 (if (featurep 'xemacs)
6874 (while (and (not (eobp)) ;; this is like `next-line'
6875 (get-char-property (1- (point)) 'invisible))
6876 (beginning-of-line 2))
6877 (while (and (not (eobp)) ;; this is like `next-line'
6878 (get-char-property (1- (point)) 'invisible))
6879 (goto-char (next-single-char-property-change (point) 'invisible))
6880 (and (eolp) (beginning-of-line 2))))
6881 (setq eol (point)))
6882 ;; Find out what to do next and set `this-command'
6883 (cond
6884 ((= eos eoh)
6885 ;; Nothing is hidden behind this heading
6886 (unless (org-before-first-heading-p)
6887 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6888 (org-unlogged-message "EMPTY ENTRY")
6889 (setq org-cycle-subtree-status nil)
6890 (save-excursion
6891 (goto-char eos)
6892 (outline-next-heading)
6893 (if (outline-invisible-p) (org-flag-heading nil))))
6894 ((and (or (>= eol eos)
6895 (not (string-match "\\S-" (buffer-substring eol eos))))
6896 (or has-children
6897 (not (setq children-skipped
6898 org-cycle-skip-children-state-if-no-children))))
6899 ;; Entire subtree is hidden in one line: children view
6900 (unless (org-before-first-heading-p)
6901 (run-hook-with-args 'org-pre-cycle-hook 'children))
6902 (if (org-at-item-p)
6903 (org-list-set-item-visibility (point-at-bol) struct 'children)
6904 (org-show-entry)
6905 (org-with-limited-levels (org-show-children))
6906 ;; FIXME: This slows down the func way too much.
6907 ;; How keep drawers hidden in subtree anyway?
6908 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6909 ;; (org-cycle-hide-drawers 'subtree))
6911 ;; Fold every list in subtree to top-level items.
6912 (when (eq org-cycle-include-plain-lists 'integrate)
6913 (save-excursion
6914 (org-back-to-heading)
6915 (while (org-list-search-forward (org-item-beginning-re) eos t)
6916 (beginning-of-line 1)
6917 (let* ((struct (org-list-struct))
6918 (prevs (org-list-prevs-alist struct))
6919 (end (org-list-get-bottom-point struct)))
6920 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6921 (org-list-get-all-items (point) struct prevs))
6922 (goto-char (if (< end eos) end eos)))))))
6923 (org-unlogged-message "CHILDREN")
6924 (save-excursion
6925 (goto-char eos)
6926 (outline-next-heading)
6927 (if (outline-invisible-p) (org-flag-heading nil)))
6928 (setq org-cycle-subtree-status 'children)
6929 (unless (org-before-first-heading-p)
6930 (run-hook-with-args 'org-cycle-hook 'children)))
6931 ((or children-skipped
6932 (and (eq last-command this-command)
6933 (eq org-cycle-subtree-status 'children)))
6934 ;; We just showed the children, or no children are there,
6935 ;; now show everything.
6936 (unless (org-before-first-heading-p)
6937 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6938 (outline-flag-region eoh eos nil)
6939 (org-unlogged-message
6940 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6941 (setq org-cycle-subtree-status 'subtree)
6942 (unless (org-before-first-heading-p)
6943 (run-hook-with-args 'org-cycle-hook 'subtree)))
6945 ;; Default action: hide the subtree.
6946 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6947 (outline-flag-region eoh eos t)
6948 (org-unlogged-message "FOLDED")
6949 (setq org-cycle-subtree-status 'folded)
6950 (unless (org-before-first-heading-p)
6951 (run-hook-with-args 'org-cycle-hook 'folded))))))
6953 ;;;###autoload
6954 (defun org-global-cycle (&optional arg)
6955 "Cycle the global visibility. For details see `org-cycle'.
6956 With \\[universal-argument] prefix arg, switch to startup visibility.
6957 With a numeric prefix, show all headlines up to that level."
6958 (interactive "P")
6959 (let ((org-cycle-include-plain-lists
6960 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6961 (cond
6962 ((integerp arg)
6963 (show-all)
6964 (hide-sublevels arg)
6965 (setq org-cycle-global-status 'contents))
6966 ((equal arg '(4))
6967 (org-set-startup-visibility)
6968 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6970 (org-cycle '(4))))))
6972 (defun org-set-startup-visibility ()
6973 "Set the visibility required by startup options and properties."
6974 (cond
6975 ((eq org-startup-folded t)
6976 (org-overview))
6977 ((eq org-startup-folded 'content)
6978 (org-content))
6979 ((or (eq org-startup-folded 'showeverything)
6980 (eq org-startup-folded nil))
6981 (show-all)))
6982 (unless (eq org-startup-folded 'showeverything)
6983 (if org-hide-block-startup (org-hide-block-all))
6984 (org-set-visibility-according-to-property 'no-cleanup)
6985 (org-cycle-hide-archived-subtrees 'all)
6986 (org-cycle-hide-drawers 'all)
6987 (org-cycle-show-empty-lines t)))
6989 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6990 "Switch subtree visibilities according to :VISIBILITY: property."
6991 (interactive)
6992 (let (org-show-entry-below)
6993 (org-with-wide-buffer
6994 (goto-char (point-min))
6995 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
6996 (if (not (org-at-property-p)) (outline-next-heading)
6997 (let ((state (match-string 3)))
6998 (save-excursion
6999 (org-back-to-heading t)
7000 (hide-subtree)
7001 (org-reveal)
7002 (cond
7003 ((equal state "folded")
7004 (hide-subtree))
7005 ((equal state "children")
7006 (org-show-hidden-entry)
7007 (org-show-children))
7008 ((equal state "content")
7009 (save-excursion
7010 (save-restriction
7011 (org-narrow-to-subtree)
7012 (org-content))))
7013 ((member state '("all" "showall"))
7014 (show-subtree)))))))
7015 (unless no-cleanup
7016 (org-cycle-hide-archived-subtrees 'all)
7017 (org-cycle-hide-drawers 'all)
7018 (org-cycle-show-empty-lines 'all)))))
7020 ;; This function uses outline-regexp instead of the more fundamental
7021 ;; org-outline-regexp so that org-cycle-global works outside of Org
7022 ;; buffers, where outline-regexp is needed.
7023 (defun org-overview ()
7024 "Switch to overview mode, showing only top-level headlines.
7025 This shows all headlines with a level equal or greater than the level
7026 of the first headline in the buffer. This is important, because if the
7027 first headline is not level one, then (hide-sublevels 1) gives confusing
7028 results."
7029 (interactive)
7030 (save-excursion
7031 (let ((level
7032 (save-excursion
7033 (goto-char (point-min))
7034 (if (re-search-forward (concat "^" outline-regexp) nil t)
7035 (progn
7036 (goto-char (match-beginning 0))
7037 (funcall outline-level))))))
7038 (and level (hide-sublevels level)))))
7040 (defun org-content (&optional arg)
7041 "Show all headlines in the buffer, like a table of contents.
7042 With numerical argument N, show content up to level N."
7043 (interactive "P")
7044 (org-overview)
7045 (save-excursion
7046 ;; Visit all headings and show their offspring
7047 (and (integerp arg) (org-overview))
7048 (goto-char (point-max))
7049 (catch 'exit
7050 (while (and (progn (condition-case nil
7051 (outline-previous-visible-heading 1)
7052 (error (goto-char (point-min))))
7054 (looking-at org-outline-regexp))
7055 (if (integerp arg)
7056 (org-show-children (1- arg))
7057 (show-branches))
7058 (if (bobp) (throw 'exit nil))))))
7060 (defun org-optimize-window-after-visibility-change (state)
7061 "Adjust the window after a change in outline visibility.
7062 This function is the default value of the hook `org-cycle-hook'."
7063 (when (get-buffer-window (current-buffer))
7064 (cond
7065 ((eq state 'content) nil)
7066 ((eq state 'all) nil)
7067 ((eq state 'folded) nil)
7068 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7069 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7071 (defun org-remove-empty-overlays-at (pos)
7072 "Remove outline overlays that do not contain non-white stuff."
7073 (mapc
7074 (lambda (o)
7075 (and (eq 'outline (overlay-get o 'invisible))
7076 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7077 (overlay-end o))))
7078 (delete-overlay o)))
7079 (overlays-at pos)))
7081 (defun org-clean-visibility-after-subtree-move ()
7082 "Fix visibility issues after moving a subtree."
7083 ;; First, find a reasonable region to look at:
7084 ;; Start two siblings above, end three below
7085 (let* ((beg (save-excursion
7086 (and (org-get-last-sibling)
7087 (org-get-last-sibling))
7088 (point)))
7089 (end (save-excursion
7090 (and (org-get-next-sibling)
7091 (org-get-next-sibling)
7092 (org-get-next-sibling))
7093 (if (org-at-heading-p)
7094 (point-at-eol)
7095 (point))))
7096 (level (looking-at "\\*+"))
7097 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7098 (save-excursion
7099 (save-restriction
7100 (narrow-to-region beg end)
7101 (when re
7102 ;; Properly fold already folded siblings
7103 (goto-char (point-min))
7104 (while (re-search-forward re nil t)
7105 (if (and (not (outline-invisible-p))
7106 (save-excursion
7107 (goto-char (point-at-eol)) (outline-invisible-p)))
7108 (hide-entry))))
7109 (org-cycle-show-empty-lines 'overview)
7110 (org-cycle-hide-drawers 'overview)))))
7112 (defun org-cycle-show-empty-lines (state)
7113 "Show empty lines above all visible headlines.
7114 The region to be covered depends on STATE when called through
7115 `org-cycle-hook'. Lisp program can use t for STATE to get the
7116 entire buffer covered. Note that an empty line is only shown if there
7117 are at least `org-cycle-separator-lines' empty lines before the headline."
7118 (when (/= org-cycle-separator-lines 0)
7119 (save-excursion
7120 (let* ((n (abs org-cycle-separator-lines))
7121 (re (cond
7122 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7123 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7124 (t (let ((ns (number-to-string (- n 2))))
7125 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7126 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7127 beg end)
7128 (cond
7129 ((memq state '(overview contents t))
7130 (setq beg (point-min) end (point-max)))
7131 ((memq state '(children folded))
7132 (setq beg (point)
7133 end (progn (org-end-of-subtree t t)
7134 (line-beginning-position 2)))))
7135 (when beg
7136 (goto-char beg)
7137 (while (re-search-forward re end t)
7138 (unless (get-char-property (match-end 1) 'invisible)
7139 (let ((e (match-end 1))
7140 (b (if (>= org-cycle-separator-lines 0)
7141 (match-beginning 1)
7142 (save-excursion
7143 (goto-char (match-beginning 0))
7144 (skip-chars-backward " \t\n")
7145 (line-end-position)))))
7146 (outline-flag-region b e nil))))))))
7147 ;; Never hide empty lines at the end of the file.
7148 (save-excursion
7149 (goto-char (point-max))
7150 (outline-previous-heading)
7151 (outline-end-of-heading)
7152 (if (and (looking-at "[ \t\n]+")
7153 (= (match-end 0) (point-max)))
7154 (outline-flag-region (point) (match-end 0) nil))))
7156 (defun org-show-empty-lines-in-parent ()
7157 "Move to the parent and re-show empty lines before visible headlines."
7158 (save-excursion
7159 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7160 (org-cycle-show-empty-lines context))))
7162 (defun org-files-list ()
7163 "Return `org-agenda-files' list, plus all open org-mode files.
7164 This is useful for operations that need to scan all of a user's
7165 open and agenda-wise Org files."
7166 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7167 (dolist (buf (buffer-list))
7168 (with-current-buffer buf
7169 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7170 (let ((file (expand-file-name (buffer-file-name))))
7171 (unless (member file files)
7172 (push file files))))))
7173 files))
7175 (defsubst org-entry-beginning-position ()
7176 "Return the beginning position of the current entry."
7177 (save-excursion (outline-back-to-heading t) (point)))
7179 (defsubst org-entry-end-position ()
7180 "Return the end position of the current entry."
7181 (save-excursion (outline-next-heading) (point)))
7183 (defun org-cycle-hide-drawers (state &optional exceptions)
7184 "Re-hide all drawers after a visibility state change.
7185 When non-nil, optional argument EXCEPTIONS is a list of strings
7186 specifying which drawers should not be hidden."
7187 (when (and (derived-mode-p 'org-mode)
7188 (not (memq state '(overview folded contents))))
7189 (save-excursion
7190 (let* ((globalp (memq state '(contents all)))
7191 (beg (if globalp (point-min) (point)))
7192 (end (if globalp (point-max)
7193 (if (eq state 'children)
7194 (save-excursion (outline-next-heading) (point))
7195 (org-end-of-subtree t)))))
7196 (goto-char beg)
7197 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7198 (unless (member-ignore-case (match-string 1) exceptions)
7199 (let ((drawer (org-element-at-point)))
7200 (when (memq (org-element-type drawer) '(drawer property-drawer))
7201 (org-flag-drawer t drawer)
7202 ;; Make sure to skip drawer entirely or we might flag
7203 ;; it another time when matching its ending line with
7204 ;; `org-drawer-regexp'.
7205 (goto-char (org-element-property :end drawer))))))))))
7207 (defun org-flag-drawer (flag &optional element)
7208 "When FLAG is non-nil, hide the drawer we are at.
7209 Otherwise make it visible. When optional argument ELEMENT is
7210 a parsed drawer, as returned by `org-element-at-point', hide or
7211 show that drawer instead."
7212 (when (save-excursion
7213 (beginning-of-line)
7214 (org-looking-at-p org-drawer-regexp))
7215 (let ((drawer (or element (org-element-at-point))))
7216 (when (memq (org-element-type drawer) '(drawer property-drawer))
7217 (let ((post (org-element-property :post-affiliated drawer)))
7218 (save-excursion
7219 (outline-flag-region
7220 (progn (goto-char post) (line-end-position))
7221 (progn (goto-char (org-element-property :end drawer))
7222 (skip-chars-backward " \r\t\n")
7223 (line-end-position))
7224 flag))
7225 ;; When the drawer is hidden away, make sure point lies in
7226 ;; a visible part of the buffer.
7227 (when (and flag (> (line-beginning-position) post))
7228 (goto-char post)))))))
7230 (defun org-subtree-end-visible-p ()
7231 "Is the end of the current subtree visible?"
7232 (pos-visible-in-window-p
7233 (save-excursion (org-end-of-subtree t) (point))))
7235 (defun org-first-headline-recenter ()
7236 "Move cursor to the first headline and recenter the headline."
7237 (goto-char (point-min))
7238 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7239 (set-window-start (selected-window) (point-at-bol))))
7241 ;;; Saving and restoring visibility
7243 (defun org-outline-overlay-data (&optional use-markers)
7244 "Return a list of the locations of all outline overlays.
7245 These are overlays with the `invisible' property value `outline'.
7246 The return value is a list of cons cells, with start and stop
7247 positions for each overlay.
7248 If USE-MARKERS is set, return the positions as markers."
7249 (let (beg end)
7250 (save-excursion
7251 (save-restriction
7252 (widen)
7253 (delq nil
7254 (mapcar (lambda (o)
7255 (when (eq (overlay-get o 'invisible) 'outline)
7256 (setq beg (overlay-start o)
7257 end (overlay-end o))
7258 (and beg end (> end beg)
7259 (if use-markers
7260 (cons (copy-marker beg)
7261 (copy-marker end t))
7262 (cons beg end)))))
7263 (overlays-in (point-min) (point-max))))))))
7265 (defun org-set-outline-overlay-data (data)
7266 "Create visibility overlays for all positions in DATA.
7267 DATA should have been made by `org-outline-overlay-data'."
7268 (let (o)
7269 (save-excursion
7270 (save-restriction
7271 (widen)
7272 (show-all)
7273 (mapc (lambda (c)
7274 (outline-flag-region (car c) (cdr c) t))
7275 data)))))
7277 ;;; Folding of blocks
7279 (defvar org-hide-block-overlays nil
7280 "Overlays hiding blocks.")
7281 (make-variable-buffer-local 'org-hide-block-overlays)
7283 (defun org-block-map (function &optional start end)
7284 "Call FUNCTION at the head of all source blocks in the current buffer.
7285 Optional arguments START and END can be used to limit the range."
7286 (let ((start (or start (point-min)))
7287 (end (or end (point-max))))
7288 (save-excursion
7289 (goto-char start)
7290 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7291 (save-excursion
7292 (save-match-data
7293 (goto-char (match-beginning 0))
7294 (funcall function)))))))
7296 (defun org-hide-block-toggle-all ()
7297 "Toggle the visibility of all blocks in the current buffer."
7298 (org-block-map 'org-hide-block-toggle))
7300 (defun org-hide-block-all ()
7301 "Fold all blocks in the current buffer."
7302 (interactive)
7303 (org-show-block-all)
7304 (org-block-map 'org-hide-block-toggle-maybe))
7306 (defun org-show-block-all ()
7307 "Unfold all blocks in the current buffer."
7308 (interactive)
7309 (mapc 'delete-overlay org-hide-block-overlays)
7310 (setq org-hide-block-overlays nil))
7312 (defun org-hide-block-toggle-maybe ()
7313 "Toggle visibility of block at point.
7314 Unlike to `org-hide-block-toggle', this function does not throw
7315 an error. Return a non-nil value when toggling is successful."
7316 (interactive)
7317 (ignore-errors (org-hide-block-toggle)))
7319 (defun org-hide-block-toggle (&optional force)
7320 "Toggle the visibility of the current block.
7321 When optional argument FORCE is `off', make block visible. If it
7322 is non-nil, hide it unconditionally. Throw an error when not at
7323 a block. Return a non-nil value when toggling is successful."
7324 (interactive)
7325 (let ((element (org-element-at-point)))
7326 (unless (memq (org-element-type element)
7327 '(center-block comment-block dynamic-block example-block
7328 export-block quote-block special-block
7329 src-block verse-block))
7330 (user-error "Not at a block"))
7331 (let* ((start (save-excursion
7332 (goto-char (org-element-property :post-affiliated element))
7333 (line-end-position)))
7334 (end (save-excursion
7335 (goto-char (org-element-property :end element))
7336 (skip-chars-backward " \r\t\n")
7337 (line-end-position)))
7338 (overlays (overlays-at start)))
7339 (cond
7340 ;; Do nothing when not before or at the block opening line or
7341 ;; at the block closing line.
7342 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7343 ((and (not (eq force 'off))
7344 (not (memq t (mapcar
7345 (lambda (o)
7346 (eq (overlay-get o 'invisible) 'org-hide-block))
7347 overlays))))
7348 (let ((ov (make-overlay start end)))
7349 (overlay-put ov 'invisible 'org-hide-block)
7350 ;; Make the block accessible to `isearch'.
7351 (overlay-put
7352 ov 'isearch-open-invisible
7353 (lambda (ov)
7354 (when (memq ov org-hide-block-overlays)
7355 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7356 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7357 (delete-overlay ov))))
7358 (push ov org-hide-block-overlays)
7359 ;; When the block is hidden away, make sure point is left in
7360 ;; a visible part of the buffer.
7361 (when (> (line-beginning-position) start)
7362 (goto-char start)
7363 (beginning-of-line))
7364 ;; Signal successful toggling.
7366 ((or (not force) (eq force 'off))
7367 (dolist (ov overlays t)
7368 (when (memq ov org-hide-block-overlays)
7369 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7370 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7371 (delete-overlay ov))))))))
7373 ;; org-tab-after-check-for-cycling-hook
7374 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7375 ;; Remove overlays when changing major mode
7376 (add-hook 'org-mode-hook
7377 (lambda () (org-add-hook 'change-major-mode-hook
7378 'org-show-block-all 'append 'local)))
7380 ;;; Org-goto
7382 (defvar org-goto-window-configuration nil)
7383 (defvar org-goto-marker nil)
7384 (defvar org-goto-map)
7385 (defun org-goto-map ()
7386 "Set the keymap `org-goto'."
7387 (setq org-goto-map
7388 (let ((map (make-sparse-keymap)))
7389 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7390 mouse-drag-region universal-argument org-occur)))
7391 (dolist (cmd cmds)
7392 (substitute-key-definition cmd cmd map global-map)))
7393 (suppress-keymap map)
7394 (org-defkey map "\C-m" 'org-goto-ret)
7395 (org-defkey map [(return)] 'org-goto-ret)
7396 (org-defkey map [(left)] 'org-goto-left)
7397 (org-defkey map [(right)] 'org-goto-right)
7398 (org-defkey map [(control ?g)] 'org-goto-quit)
7399 (org-defkey map "\C-i" 'org-cycle)
7400 (org-defkey map [(tab)] 'org-cycle)
7401 (org-defkey map [(down)] 'outline-next-visible-heading)
7402 (org-defkey map [(up)] 'outline-previous-visible-heading)
7403 (if org-goto-auto-isearch
7404 (if (fboundp 'define-key-after)
7405 (define-key-after map [t] 'org-goto-local-auto-isearch)
7406 nil)
7407 (org-defkey map "q" 'org-goto-quit)
7408 (org-defkey map "n" 'outline-next-visible-heading)
7409 (org-defkey map "p" 'outline-previous-visible-heading)
7410 (org-defkey map "f" 'outline-forward-same-level)
7411 (org-defkey map "b" 'outline-backward-same-level)
7412 (org-defkey map "u" 'outline-up-heading))
7413 (org-defkey map "/" 'org-occur)
7414 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7415 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7416 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7417 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7418 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7419 map)))
7421 (defconst org-goto-help
7422 "Browse buffer copy, to find location or copy text.%s
7423 RET=jump to location C-g=quit and return to previous location
7424 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7426 (defvar org-goto-start-pos) ; dynamically scoped parameter
7428 (defun org-goto (&optional alternative-interface)
7429 "Look up a different location in the current file, keeping current visibility.
7431 When you want look-up or go to a different location in a
7432 document, the fastest way is often to fold the entire buffer and
7433 then dive into the tree. This method has the disadvantage, that
7434 the previous location will be folded, which may not be what you
7435 want.
7437 This command works around this by showing a copy of the current
7438 buffer in an indirect buffer, in overview mode. You can dive
7439 into the tree in that copy, use org-occur and incremental search
7440 to find a location. When pressing RET or `Q', the command
7441 returns to the original buffer in which the visibility is still
7442 unchanged. After RET it will also jump to the location selected
7443 in the indirect buffer and expose the headline hierarchy above.
7445 With a prefix argument, use the alternative interface: e.g. if
7446 `org-goto-interface' is 'outline use 'outline-path-completion."
7447 (interactive "P")
7448 (org-goto-map)
7449 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7450 (org-refile-use-outline-path t)
7451 (org-refile-target-verify-function nil)
7452 (interface
7453 (if (not alternative-interface)
7454 org-goto-interface
7455 (if (eq org-goto-interface 'outline)
7456 'outline-path-completion
7457 'outline)))
7458 (org-goto-start-pos (point))
7459 (selected-point
7460 (if (eq interface 'outline)
7461 (car (org-get-location (current-buffer) org-goto-help))
7462 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7463 (org-refile-check-position pa)
7464 (nth 3 pa)))))
7465 (if selected-point
7466 (progn
7467 (org-mark-ring-push org-goto-start-pos)
7468 (goto-char selected-point)
7469 (if (or (outline-invisible-p) (org-invisible-p2))
7470 (org-show-context 'org-goto)))
7471 (message "Quit"))))
7473 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7474 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7475 (defvar org-goto-local-auto-isearch-map) ; defined below
7477 (defun org-get-location (buf help)
7478 "Let the user select a location in the Org-mode buffer BUF.
7479 This function uses a recursive edit. It returns the selected position
7480 or nil."
7481 (org-no-popups
7482 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7483 (isearch-hide-immediately nil)
7484 (isearch-search-fun-function
7485 (lambda () 'org-goto-local-search-headings))
7486 (org-goto-selected-point org-goto-exit-command))
7487 (save-excursion
7488 (save-window-excursion
7489 (delete-other-windows)
7490 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7491 (org-pop-to-buffer-same-window
7492 (condition-case nil
7493 (make-indirect-buffer (current-buffer) "*org-goto*")
7494 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7495 (with-output-to-temp-buffer "*Org Help*"
7496 (princ (format help (if org-goto-auto-isearch
7497 " Just type for auto-isearch."
7498 " n/p/f/b/u to navigate, q to quit."))))
7499 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7500 (setq buffer-read-only nil)
7501 (let ((org-startup-truncated t)
7502 (org-startup-folded nil)
7503 (org-startup-align-all-tables nil))
7504 (org-mode)
7505 (org-overview))
7506 (setq buffer-read-only t)
7507 (if (and (boundp 'org-goto-start-pos)
7508 (integer-or-marker-p org-goto-start-pos))
7509 (progn (goto-char org-goto-start-pos)
7510 (when (outline-invisible-p)
7511 (org-show-set-visibility 'lineage)))
7512 (goto-char (point-min)))
7513 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7514 (message "Select location and press RET")
7515 (use-local-map org-goto-map)
7516 (recursive-edit)))
7517 (kill-buffer "*org-goto*")
7518 (cons org-goto-selected-point org-goto-exit-command))))
7520 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7521 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7522 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7523 (if (fboundp 'isearch-other-control-char)
7524 (progn
7525 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7526 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7527 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7528 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7529 (define-key org-goto-local-auto-isearch-map [return] nil))
7531 (defun org-goto-local-search-headings (string bound noerror)
7532 "Search and make sure that any matches are in headlines."
7533 (catch 'return
7534 (while (if isearch-forward
7535 (search-forward string bound noerror)
7536 (search-backward string bound noerror))
7537 (when (save-match-data
7538 (and (save-excursion
7539 (beginning-of-line)
7540 (looking-at org-complex-heading-regexp))
7541 (or (not (match-beginning 5))
7542 (< (point) (match-beginning 5)))))
7543 (throw 'return (point))))))
7545 (defun org-goto-local-auto-isearch ()
7546 "Start isearch."
7547 (interactive)
7548 (goto-char (point-min))
7549 (let ((keys (this-command-keys)))
7550 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7551 (isearch-mode t)
7552 (isearch-process-search-char (string-to-char keys)))))
7554 (defun org-goto-ret (&optional arg)
7555 "Finish `org-goto' by going to the new location."
7556 (interactive "P")
7557 (setq org-goto-selected-point (point)
7558 org-goto-exit-command 'return)
7559 (throw 'exit nil))
7561 (defun org-goto-left ()
7562 "Finish `org-goto' by going to the new location."
7563 (interactive)
7564 (if (org-at-heading-p)
7565 (progn
7566 (beginning-of-line 1)
7567 (setq org-goto-selected-point (point)
7568 org-goto-exit-command 'left)
7569 (throw 'exit nil))
7570 (user-error "Not on a heading")))
7572 (defun org-goto-right ()
7573 "Finish `org-goto' by going to the new location."
7574 (interactive)
7575 (if (org-at-heading-p)
7576 (progn
7577 (setq org-goto-selected-point (point)
7578 org-goto-exit-command 'right)
7579 (throw 'exit nil))
7580 (user-error "Not on a heading")))
7582 (defun org-goto-quit ()
7583 "Finish `org-goto' without cursor motion."
7584 (interactive)
7585 (setq org-goto-selected-point nil)
7586 (setq org-goto-exit-command 'quit)
7587 (throw 'exit nil))
7589 ;;; Indirect buffer display of subtrees
7591 (defvar org-indirect-dedicated-frame nil
7592 "This is the frame being used for indirect tree display.")
7593 (defvar org-last-indirect-buffer nil)
7595 (defun org-tree-to-indirect-buffer (&optional arg)
7596 "Create indirect buffer and narrow it to current subtree.
7597 With a numerical prefix ARG, go up to this level and then take that tree.
7598 If ARG is negative, go up that many levels.
7600 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7601 indirect buffer previously made with this command, to avoid proliferation of
7602 indirect buffers. However, when you call the command with a \
7603 \\[universal-argument] prefix, or
7604 when `org-indirect-buffer-display' is `new-frame', the last buffer
7605 is kept so that you can work with several indirect buffers at the same time.
7606 If `org-indirect-buffer-display' is `dedicated-frame', the \
7607 \\[universal-argument] prefix also
7608 requests that a new frame be made for the new buffer, so that the dedicated
7609 frame is not changed."
7610 (interactive "P")
7611 (let ((cbuf (current-buffer))
7612 (cwin (selected-window))
7613 (pos (point))
7614 beg end level heading ibuf)
7615 (save-excursion
7616 (org-back-to-heading t)
7617 (when (numberp arg)
7618 (setq level (org-outline-level))
7619 (if (< arg 0) (setq arg (+ level arg)))
7620 (while (> (setq level (org-outline-level)) arg)
7621 (org-up-heading-safe)))
7622 (setq beg (point)
7623 heading (org-get-heading))
7624 (org-end-of-subtree t t)
7625 (if (org-at-heading-p) (backward-char 1))
7626 (setq end (point)))
7627 (if (and (buffer-live-p org-last-indirect-buffer)
7628 (not (eq org-indirect-buffer-display 'new-frame))
7629 (not arg))
7630 (kill-buffer org-last-indirect-buffer))
7631 (setq ibuf (org-get-indirect-buffer cbuf heading)
7632 org-last-indirect-buffer ibuf)
7633 (cond
7634 ((or (eq org-indirect-buffer-display 'new-frame)
7635 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7636 (select-frame (make-frame))
7637 (delete-other-windows)
7638 (org-pop-to-buffer-same-window ibuf)
7639 (org-set-frame-title heading))
7640 ((eq org-indirect-buffer-display 'dedicated-frame)
7641 (raise-frame
7642 (select-frame (or (and org-indirect-dedicated-frame
7643 (frame-live-p org-indirect-dedicated-frame)
7644 org-indirect-dedicated-frame)
7645 (setq org-indirect-dedicated-frame (make-frame)))))
7646 (delete-other-windows)
7647 (org-pop-to-buffer-same-window ibuf)
7648 (org-set-frame-title (concat "Indirect: " heading)))
7649 ((eq org-indirect-buffer-display 'current-window)
7650 (org-pop-to-buffer-same-window ibuf))
7651 ((eq org-indirect-buffer-display 'other-window)
7652 (pop-to-buffer ibuf))
7653 (t (error "Invalid value")))
7654 (if (featurep 'xemacs)
7655 (save-excursion (org-mode) (turn-on-font-lock)))
7656 (narrow-to-region beg end)
7657 (show-all)
7658 (goto-char pos)
7659 (run-hook-with-args 'org-cycle-hook 'all)
7660 (and (window-live-p cwin) (select-window cwin))))
7662 (defun org-get-indirect-buffer (&optional buffer heading)
7663 (setq buffer (or buffer (current-buffer)))
7664 (let ((n 1) (base (buffer-name buffer)) bname)
7665 (while (buffer-live-p
7666 (get-buffer
7667 (setq bname
7668 (concat base "-"
7669 (if heading (concat heading "-" (number-to-string n))
7670 (number-to-string n))))))
7671 (setq n (1+ n)))
7672 (condition-case nil
7673 (make-indirect-buffer buffer bname 'clone)
7674 (error (make-indirect-buffer buffer bname)))))
7676 (defun org-set-frame-title (title)
7677 "Set the title of the current frame to the string TITLE."
7678 ;; FIXME: how to name a single frame in XEmacs???
7679 (unless (featurep 'xemacs)
7680 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7682 ;;;; Structure editing
7684 ;;; Inserting headlines
7686 (defun org-previous-line-empty-p (&optional next)
7687 "Is the previous line a blank line?
7688 When NEXT is non-nil, check the next line instead."
7689 (save-excursion
7690 (and (not (bobp))
7691 (or (beginning-of-line (if next 2 0)) t)
7692 (save-match-data
7693 (looking-at "[ \t]*$")))))
7695 (defun org-insert-heading (&optional arg invisible-ok top-level)
7696 "Insert a new heading or an item with the same depth at point.
7698 If point is at the beginning of a heading or a list item, insert
7699 a new heading or a new item above the current one. If point is
7700 at the beginning of a normal line, turn the line into a heading.
7702 If point is in the middle of a headline or a list item, split the
7703 headline or the item and create a new headline/item with the text
7704 in the current line after point \(see `org-M-RET-may-split-line'
7705 on how to modify this behavior).
7707 With one universal prefix argument, set the user option
7708 `org-insert-heading-respect-content' to t for the duration of
7709 the command. This modifies the behavior described above in this
7710 ways: on list items and at the beginning of normal lines, force
7711 the insertion of a heading after the current subtree.
7713 With two universal prefix arguments, insert the heading at the
7714 end of the grandparent subtree. For example, if point is within
7715 a 2nd-level heading, then it will insert a 2nd-level heading at
7716 the end of the 1st-level parent heading.
7718 If point is at the beginning of a headline, insert a sibling
7719 before the current headline. If point is not at the beginning,
7720 split the line and create a new headline with the text in the
7721 current line after point \(see `org-M-RET-may-split-line' on how
7722 to modify this behavior).
7724 If point is at the beginning of a normal line, turn this line
7725 into a heading.
7727 When INVISIBLE-OK is set, stop at invisible headlines when going
7728 back. This is important for non-interactive uses of the
7729 command.
7731 When optional argument TOP-LEVEL is non-nil, insert a level 1
7732 heading, unconditionally."
7733 (interactive "P")
7734 (if (org-called-interactively-p 'any) (org-reveal))
7735 (let ((itemp (and (not top-level) (org-in-item-p)))
7736 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7737 (respect-content (or org-insert-heading-respect-content
7738 (equal arg '(4))))
7739 (initial-content ""))
7741 (cond
7743 ((or (= (buffer-size) 0)
7744 (and (not (save-excursion
7745 (and (ignore-errors (org-back-to-heading invisible-ok))
7746 (org-at-heading-p))))
7747 (or arg (not itemp))))
7748 ;; At beginning of buffer or so high up that only a heading
7749 ;; makes sense.
7750 (cond ((and (bolp) (not respect-content)) (insert "* "))
7751 ((not respect-content)
7752 (unless may-split (end-of-line))
7753 (insert "\n* "))
7754 ((re-search-forward org-outline-regexp-bol nil t)
7755 (beginning-of-line)
7756 (insert "* \n")
7757 (backward-char))
7758 (t (goto-char (point-max))
7759 (insert "\n* ")))
7760 (run-hooks 'org-insert-heading-hook))
7762 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7765 ;; Maybe move at the end of the subtree
7766 (when (equal arg '(16))
7767 (org-up-heading-safe)
7768 (org-end-of-subtree t))
7769 ;; Insert a heading
7770 (save-restriction
7771 (widen)
7772 (let* ((level nil)
7773 (on-heading (org-at-heading-p))
7774 (empty-line-p (if on-heading
7775 (org-previous-line-empty-p)
7776 ;; We will decide later
7777 nil))
7778 ;; Get a level string to fall back on.
7779 (fix-level
7780 (if (org-before-first-heading-p) "*"
7781 (save-excursion
7782 (org-back-to-heading t)
7783 (if (org-previous-line-empty-p) (setq empty-line-p t))
7784 (looking-at org-outline-regexp)
7785 (make-string (1- (length (match-string 0))) ?*))))
7786 (stars
7787 (save-excursion
7788 (condition-case nil
7789 (if top-level "* "
7790 (org-back-to-heading invisible-ok)
7791 (when (and (not on-heading)
7792 (featurep 'org-inlinetask)
7793 (integerp org-inlinetask-min-level)
7794 (>= (length (match-string 0))
7795 org-inlinetask-min-level))
7796 ;; Find a heading level before the inline
7797 ;; task.
7798 (while (and (setq level (org-up-heading-safe))
7799 (>= level org-inlinetask-min-level)))
7800 (if (org-at-heading-p)
7801 (org-back-to-heading invisible-ok)
7802 (error "This should not happen")))
7803 (unless (and (save-excursion
7804 (save-match-data
7805 (org-backward-heading-same-level
7806 1 invisible-ok))
7807 (= (point) (match-beginning 0)))
7808 (not (org-previous-line-empty-p t)))
7809 (setq empty-line-p (or empty-line-p
7810 (org-previous-line-empty-p))))
7811 (match-string 0))
7812 (error (or fix-level "* ")))))
7813 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7814 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7815 pos hide-previous previous-pos)
7817 ;; If we insert after content, move there and clean up
7818 ;; whitespace.
7819 (when (and respect-content
7820 (not (org-looking-at-p org-outline-regexp-bol)))
7821 (if (not (org-before-first-heading-p))
7822 (org-end-of-subtree nil t)
7823 (re-search-forward org-outline-regexp-bol)
7824 (beginning-of-line 0))
7825 (skip-chars-backward " \r\t\n")
7826 (and (not (looking-back "^\\*+" (line-beginning-position)))
7827 (looking-at "[ \t]+") (replace-match ""))
7828 (unless (eobp) (forward-char 1))
7829 (when (looking-at "^\\*")
7830 (unless (bobp) (backward-char 1))
7831 (insert "\n")))
7833 ;; If we are splitting, grab the text that should be moved
7834 ;; to the new headline.
7835 (when may-split
7836 (if (org-on-heading-p)
7837 ;; This is a heading: split intelligently (keeping
7838 ;; tags).
7839 (let ((pos (point)))
7840 (beginning-of-line)
7841 (unless (looking-at org-complex-heading-regexp)
7842 (error "This should not happen"))
7843 (when (and (match-beginning 4)
7844 (> pos (match-beginning 4))
7845 (< pos (match-end 4)))
7846 (setq initial-content (buffer-substring pos (match-end 4)))
7847 (goto-char pos)
7848 (delete-region (point) (match-end 4))
7849 (if (looking-at "[ \t]*$")
7850 (replace-match "")
7851 (insert (make-string (length initial-content) ?\s)))
7852 (setq initial-content (org-trim initial-content)))
7853 (goto-char pos))
7854 ;; A normal line.
7855 (setq initial-content
7856 (org-trim
7857 (delete-and-extract-region (point) (line-end-position))))))
7859 ;; If we are at the beginning of the line, insert before it.
7860 ;; Otherwise, after it.
7861 (cond
7862 ((and (bolp) (looking-at "[ \t]*$")))
7863 ((bolp) (save-excursion (insert "\n")))
7864 (t (end-of-line)
7865 (insert "\n")))
7867 ;; Insert the new heading
7868 (insert stars)
7869 (just-one-space)
7870 (insert initial-content)
7871 (unless (and blank (org-previous-line-empty-p))
7872 (org-N-empty-lines-before-current (if blank 1 0)))
7873 ;; Adjust visibility, which may be messed up if we removed
7874 ;; blank lines while previous entry was hidden.
7875 (let ((bol (line-beginning-position)))
7876 (dolist (o (overlays-at (1- bol)))
7877 (when (and (eq (overlay-get o 'invisible) 'outline)
7878 (eq (overlay-end o) bol))
7879 (move-overlay o (overlay-start o) (1- bol)))))
7880 (run-hooks 'org-insert-heading-hook)))))))
7882 (defun org-N-empty-lines-before-current (N)
7883 "Make the number of empty lines before current exactly N.
7884 So this will delete or add empty lines."
7885 (save-excursion
7886 (beginning-of-line)
7887 (let ((p (point)))
7888 (skip-chars-backward " \r\t\n")
7889 (unless (bolp) (forward-line))
7890 (delete-region (point) p))
7891 (when (> N 0) (insert (make-string N ?\n)))))
7893 (defun org-get-heading (&optional no-tags no-todo)
7894 "Return the heading of the current entry, without the stars.
7895 When NO-TAGS is non-nil, don't include tags.
7896 When NO-TODO is non-nil, don't include TODO keywords."
7897 (save-excursion
7898 (org-back-to-heading t)
7899 (cond
7900 ((and no-tags no-todo)
7901 (looking-at org-complex-heading-regexp)
7902 (match-string 4))
7903 (no-tags
7904 (looking-at (concat org-outline-regexp
7905 "\\(.*?\\)"
7906 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7907 (match-string 1))
7908 (no-todo
7909 (looking-at org-todo-line-regexp)
7910 (match-string 3))
7911 (t (looking-at org-heading-regexp)
7912 (match-string 2)))))
7914 (defvar orgstruct-mode) ; defined below
7916 (defun org-heading-components ()
7917 "Return the components of the current heading.
7918 This is a list with the following elements:
7919 - the level as an integer
7920 - the reduced level, different if `org-odd-levels-only' is set.
7921 - the TODO keyword, or nil
7922 - the priority character, like ?A, or nil if no priority is given
7923 - the headline text itself, or the tags string if no headline text
7924 - the tags string, or nil."
7925 (save-excursion
7926 (org-back-to-heading t)
7927 (if (let (case-fold-search)
7928 (looking-at
7929 (if orgstruct-mode
7930 org-heading-regexp
7931 org-complex-heading-regexp)))
7932 (if orgstruct-mode
7933 (list (length (match-string 1))
7934 (org-reduced-level (length (match-string 1)))
7937 (match-string 2)
7938 nil)
7939 (list (length (match-string 1))
7940 (org-reduced-level (length (match-string 1)))
7941 (org-match-string-no-properties 2)
7942 (and (match-end 3) (aref (match-string 3) 2))
7943 (org-match-string-no-properties 4)
7944 (org-match-string-no-properties 5))))))
7946 (defun org-get-entry ()
7947 "Get the entry text, after heading, entire subtree."
7948 (save-excursion
7949 (org-back-to-heading t)
7950 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7952 (defun org-insert-heading-after-current ()
7953 "Insert a new heading with same level as current, after current subtree."
7954 (interactive)
7955 (org-back-to-heading)
7956 (org-insert-heading)
7957 (org-move-subtree-down)
7958 (end-of-line 1))
7960 (defun org-insert-heading-respect-content (&optional invisible-ok)
7961 "Insert heading with `org-insert-heading-respect-content' set to t."
7962 (interactive)
7963 (org-insert-heading '(4) invisible-ok))
7965 (defun org-insert-todo-heading-respect-content (&optional force-state)
7966 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7967 (interactive)
7968 (org-insert-todo-heading force-state '(4)))
7970 (defun org-insert-todo-heading (arg &optional force-heading)
7971 "Insert a new heading with the same level and TODO state as current heading.
7972 If the heading has no TODO state, or if the state is DONE, use the first
7973 state (TODO by default). Also with one prefix arg, force first state. With
7974 two prefix args, force inserting at the end of the parent subtree."
7975 (interactive "P")
7976 (when (or force-heading (not (org-insert-item 'checkbox)))
7977 (org-insert-heading (or (and (equal arg '(16)) '(16))
7978 force-heading))
7979 (save-excursion
7980 (org-back-to-heading)
7981 (outline-previous-heading)
7982 (looking-at org-todo-line-regexp))
7983 (let*
7984 ((new-mark-x
7985 (if (or (equal arg '(4))
7986 (not (match-beginning 2))
7987 (member (match-string 2) org-done-keywords))
7988 (car org-todo-keywords-1)
7989 (match-string 2)))
7990 (new-mark
7992 (run-hook-with-args-until-success
7993 'org-todo-get-default-hook new-mark-x nil)
7994 new-mark-x)))
7995 (beginning-of-line 1)
7996 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7997 (if org-treat-insert-todo-heading-as-state-change
7998 (org-todo new-mark)
7999 (insert new-mark " "))))
8000 (when org-provide-todo-statistics
8001 (org-update-parent-todo-statistics))))
8003 (defun org-insert-subheading (arg)
8004 "Insert a new subheading and demote it.
8005 Works for outline headings and for plain lists alike."
8006 (interactive "P")
8007 (org-insert-heading arg)
8008 (cond
8009 ((org-at-heading-p) (org-do-demote))
8010 ((org-at-item-p) (org-indent-item))))
8012 (defun org-insert-todo-subheading (arg)
8013 "Insert a new subheading with TODO keyword or checkbox and demote it.
8014 Works for outline headings and for plain lists alike."
8015 (interactive "P")
8016 (org-insert-todo-heading arg)
8017 (cond
8018 ((org-at-heading-p) (org-do-demote))
8019 ((org-at-item-p) (org-indent-item))))
8021 ;;; Promotion and Demotion
8023 (defvar org-after-demote-entry-hook nil
8024 "Hook run after an entry has been demoted.
8025 The cursor will be at the beginning of the entry.
8026 When a subtree is being demoted, the hook will be called for each node.")
8028 (defvar org-after-promote-entry-hook nil
8029 "Hook run after an entry has been promoted.
8030 The cursor will be at the beginning of the entry.
8031 When a subtree is being promoted, the hook will be called for each node.")
8033 (defun org-promote-subtree ()
8034 "Promote the entire subtree.
8035 See also `org-promote'."
8036 (interactive)
8037 (save-excursion
8038 (org-with-limited-levels (org-map-tree 'org-promote)))
8039 (org-fix-position-after-promote))
8041 (defun org-demote-subtree ()
8042 "Demote the entire subtree. See `org-demote'.
8043 See also `org-promote'."
8044 (interactive)
8045 (save-excursion
8046 (org-with-limited-levels (org-map-tree 'org-demote)))
8047 (org-fix-position-after-promote))
8050 (defun org-do-promote ()
8051 "Promote the current heading higher up the tree.
8052 If the region is active in `transient-mark-mode', promote all headings
8053 in the region."
8054 (interactive)
8055 (save-excursion
8056 (if (org-region-active-p)
8057 (org-map-region 'org-promote (region-beginning) (region-end))
8058 (org-promote)))
8059 (org-fix-position-after-promote))
8061 (defun org-do-demote ()
8062 "Demote the current heading lower down the tree.
8063 If the region is active in `transient-mark-mode', demote all headings
8064 in the region."
8065 (interactive)
8066 (save-excursion
8067 (if (org-region-active-p)
8068 (org-map-region 'org-demote (region-beginning) (region-end))
8069 (org-demote)))
8070 (org-fix-position-after-promote))
8072 (defun org-fix-position-after-promote ()
8073 "Make sure that after pro/demotion cursor position is right."
8074 (let ((pos (point)))
8075 (when (save-excursion
8076 (beginning-of-line 1)
8077 (looking-at org-todo-line-regexp)
8078 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8079 (cond ((eobp) (insert " "))
8080 ((eolp) (insert " "))
8081 ((equal (char-after) ?\ ) (forward-char 1))))))
8083 (defun org-current-level ()
8084 "Return the level of the current entry, or nil if before the first headline.
8085 The level is the number of stars at the beginning of the
8086 headline. Use `org-reduced-level' to remove the effect of
8087 `org-odd-levels'. Unlike to `org-outline-level', this function
8088 ignores inlinetasks."
8089 (let ((level (org-with-limited-levels (org-outline-level))))
8090 (and (> level 0) level)))
8092 (defun org-get-previous-line-level ()
8093 "Return the outline depth of the last headline before the current line.
8094 Returns 0 for the first headline in the buffer, and nil if before the
8095 first headline."
8096 (and (org-current-level)
8097 (or (and (/= (line-beginning-position) (point-min))
8098 (save-excursion (beginning-of-line 0) (org-current-level)))
8099 0)))
8101 (defun org-reduced-level (l)
8102 "Compute the effective level of a heading.
8103 This takes into account the setting of `org-odd-levels-only'."
8104 (cond
8105 ((zerop l) 0)
8106 (org-odd-levels-only (1+ (floor (/ l 2))))
8107 (t l)))
8109 (defun org-level-increment ()
8110 "Return the number of stars that will be added or removed at a
8111 time to headlines when structure editing, based on the value of
8112 `org-odd-levels-only'."
8113 (if org-odd-levels-only 2 1))
8115 (defun org-get-valid-level (level &optional change)
8116 "Rectify a level change under the influence of `org-odd-levels-only'
8117 LEVEL is a current level, CHANGE is by how much the level should be
8118 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8119 even level numbers will become the next higher odd number."
8120 (if org-odd-levels-only
8121 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8122 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8123 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8124 (max 1 (+ level (or change 0)))))
8126 (if (boundp 'define-obsolete-function-alias)
8127 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8128 (define-obsolete-function-alias 'org-get-legal-level
8129 'org-get-valid-level)
8130 (define-obsolete-function-alias 'org-get-legal-level
8131 'org-get-valid-level "23.1")))
8133 (defun org-promote ()
8134 "Promote the current heading higher up the tree."
8135 (org-with-wide-buffer
8136 (org-back-to-heading t)
8137 (let* ((after-change-functions (remq 'flyspell-after-change-function
8138 after-change-functions))
8139 (level (save-match-data (funcall outline-level)))
8140 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8141 (diff (abs (- level (length up-head) -1))))
8142 (cond
8143 ((and (= level 1) org-allow-promoting-top-level-subtree)
8144 (replace-match "# " nil t))
8145 ((= level 1)
8146 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8147 (t (replace-match up-head nil t)))
8148 (unless (= level 1)
8149 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8150 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8151 (run-hooks 'org-after-promote-entry-hook))))
8153 (defun org-demote ()
8154 "Demote the current heading lower down 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 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8161 (diff (abs (- level (length down-head) -1))))
8162 (replace-match down-head nil t)
8163 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8164 (when org-adapt-indentation (org-fixup-indentation diff))
8165 (run-hooks 'org-after-demote-entry-hook))))
8167 (defun org-cycle-level ()
8168 "Cycle the level of an empty headline through possible states.
8169 This goes first to child, then to parent, level, then up the hierarchy.
8170 After top level, it switches back to sibling level."
8171 (interactive)
8172 (let ((org-adapt-indentation nil))
8173 (when (org-point-at-end-of-empty-headline)
8174 (setq this-command 'org-cycle-level) ; Only needed for caching
8175 (let ((cur-level (org-current-level))
8176 (prev-level (org-get-previous-line-level)))
8177 (cond
8178 ;; If first headline in file, promote to top-level.
8179 ((= prev-level 0)
8180 (loop repeat (/ (- cur-level 1) (org-level-increment))
8181 do (org-do-promote)))
8182 ;; If same level as prev, demote one.
8183 ((= prev-level cur-level)
8184 (org-do-demote))
8185 ;; If parent is top-level, promote to top level if not already.
8186 ((= prev-level 1)
8187 (loop repeat (/ (- cur-level 1) (org-level-increment))
8188 do (org-do-promote)))
8189 ;; If top-level, return to prev-level.
8190 ((= cur-level 1)
8191 (loop repeat (/ (- prev-level 1) (org-level-increment))
8192 do (org-do-demote)))
8193 ;; If less than prev-level, promote one.
8194 ((< cur-level prev-level)
8195 (org-do-promote))
8196 ;; If deeper than prev-level, promote until higher than
8197 ;; prev-level.
8198 ((> cur-level prev-level)
8199 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8200 do (org-do-promote))))
8201 t))))
8203 (defun org-map-tree (fun)
8204 "Call FUN for every heading underneath the current one."
8205 (org-back-to-heading)
8206 (let ((level (funcall outline-level)))
8207 (save-excursion
8208 (funcall fun)
8209 (while (and (progn
8210 (outline-next-heading)
8211 (> (funcall outline-level) level))
8212 (not (eobp)))
8213 (funcall fun)))))
8215 (defun org-map-region (fun beg end)
8216 "Call FUN for every heading between BEG and END."
8217 (let ((org-ignore-region t))
8218 (save-excursion
8219 (setq end (copy-marker end))
8220 (goto-char beg)
8221 (if (and (re-search-forward org-outline-regexp-bol nil t)
8222 (< (point) end))
8223 (funcall fun))
8224 (while (and (progn
8225 (outline-next-heading)
8226 (< (point) end))
8227 (not (eobp)))
8228 (funcall fun)))))
8230 (defun org-fixup-indentation (diff)
8231 "Change the indentation in the current entry by DIFF.
8233 DIFF is an integer. Indentation is done according to the
8234 following rules:
8236 - Planning information and property drawers are always indented
8237 according to the new level of the headline;
8239 - Footnote definitions and their contents are ignored;
8241 - Inlinetasks' boundaries are not shifted;
8243 - Empty lines are ignored;
8245 - Other lines' indentation are shifted by DIFF columns, unless
8246 it would introduce a structural change in the document, in
8247 which case no shifting is done at all.
8249 Assume point is at a heading or an inlinetask beginning."
8250 (org-with-wide-buffer
8251 (narrow-to-region (line-beginning-position)
8252 (save-excursion
8253 (if (org-with-limited-levels (org-at-heading-p))
8254 (org-with-limited-levels (outline-next-heading))
8255 (org-inlinetask-goto-end))
8256 (point)))
8257 (forward-line)
8258 ;; Indent properly planning info and property drawer.
8259 (when (org-looking-at-p org-planning-line-re)
8260 (org-indent-line)
8261 (forward-line))
8262 (when (looking-at org-property-drawer-re)
8263 (goto-char (match-end 0))
8264 (forward-line)
8265 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8266 (catch 'no-shift
8267 (when (zerop diff) (throw 'no-shift nil))
8268 ;; If DIFF is negative, first check if a shift is possible at all
8269 ;; (e.g., it doesn't break structure). This can only happen if
8270 ;; some contents are not properly indented.
8271 (let ((case-fold-search t))
8272 (when (< diff 0)
8273 (let ((diff (- diff))
8274 (forbidden-re (concat org-outline-regexp
8275 "\\|"
8276 (substring org-footnote-definition-re 1))))
8277 (save-excursion
8278 (while (not (eobp))
8279 (cond
8280 ((org-looking-at-p "[ \t]*$") (forward-line))
8281 ((and (org-looking-at-p org-footnote-definition-re)
8282 (let ((e (org-element-at-point)))
8283 (and (eq (org-element-type e) 'footnote-definition)
8284 (goto-char (org-element-property :end e))))))
8285 ((org-looking-at-p org-outline-regexp) (forward-line))
8286 ;; Give up if shifting would move before column 0 or
8287 ;; if it would introduce a headline or a footnote
8288 ;; definition.
8290 (skip-chars-forward " \t")
8291 (let ((ind (current-column)))
8292 (when (or (< ind diff)
8293 (and (= ind diff) (org-looking-at-p forbidden-re)))
8294 (throw 'no-shift nil)))
8295 ;; Ignore contents of example blocks and source
8296 ;; blocks if their indentation is meant to be
8297 ;; preserved. Jump to block's closing line.
8298 (beginning-of-line)
8299 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8300 (let ((e (org-element-at-point)))
8301 (and (memq (org-element-type e)
8302 '(example-block src-block))
8303 (or org-src-preserve-indentation
8304 (org-element-property :preserve-indent e))
8305 (goto-char (org-element-property :end e))
8306 (progn (skip-chars-backward " \r\t\n")
8307 (beginning-of-line)
8308 t))))
8309 (forward-line))))))))
8310 ;; Shift lines but footnote definitions, inlinetasks boundaries
8311 ;; by DIFF. Also skip contents of source or example blocks
8312 ;; when indentation is meant to be preserved.
8313 (while (not (eobp))
8314 (cond
8315 ((and (org-looking-at-p org-footnote-definition-re)
8316 (let ((e (org-element-at-point)))
8317 (and (eq (org-element-type e) 'footnote-definition)
8318 (goto-char (org-element-property :end e))))))
8319 ((org-looking-at-p org-outline-regexp) (forward-line))
8320 ((org-looking-at-p "[ \t]*$") (forward-line))
8322 (org-indent-line-to (+ (org-get-indentation) diff))
8323 (beginning-of-line)
8324 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8325 (let ((e (org-element-at-point)))
8326 (and (memq (org-element-type e)
8327 '(example-block src-block))
8328 (or org-src-preserve-indentation
8329 (org-element-property :preserve-indent e))
8330 (goto-char (org-element-property :end e))
8331 (progn (skip-chars-backward " \r\t\n")
8332 (beginning-of-line)
8333 t))))
8334 (forward-line)))))))))
8336 (defun org-convert-to-odd-levels ()
8337 "Convert an org-mode file with all levels allowed to one with odd levels.
8338 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8339 level 5 etc."
8340 (interactive)
8341 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8342 (let ((outline-level 'org-outline-level)
8343 (org-odd-levels-only nil) n)
8344 (save-excursion
8345 (goto-char (point-min))
8346 (while (re-search-forward "^\\*\\*+ " nil t)
8347 (setq n (- (length (match-string 0)) 2))
8348 (while (>= (setq n (1- n)) 0)
8349 (org-demote))
8350 (end-of-line 1))))))
8352 (defun org-convert-to-oddeven-levels ()
8353 "Convert an org-mode file with only odd levels to one with odd/even levels.
8354 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8355 file contains a section with an even level, conversion would
8356 destroy the structure of the file. An error is signaled in this
8357 case."
8358 (interactive)
8359 (goto-char (point-min))
8360 ;; First check if there are no even levels
8361 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8362 (org-show-set-visibility 'canonical)
8363 (error "Not all levels are odd in this file. Conversion not possible"))
8364 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8365 (let ((outline-regexp org-outline-regexp)
8366 (outline-level 'org-outline-level)
8367 (org-odd-levels-only nil) n)
8368 (save-excursion
8369 (goto-char (point-min))
8370 (while (re-search-forward "^\\*\\*+ " nil t)
8371 (setq n (/ (1- (length (match-string 0))) 2))
8372 (while (>= (setq n (1- n)) 0)
8373 (org-promote))
8374 (end-of-line 1))))))
8376 (defun org-tr-level (n)
8377 "Make N odd if required."
8378 (if org-odd-levels-only (1+ (/ n 2)) n))
8380 ;;; Vertical tree motion, cutting and pasting of subtrees
8382 (defun org-move-subtree-up (&optional arg)
8383 "Move the current subtree up past ARG headlines of the same level."
8384 (interactive "p")
8385 (org-move-subtree-down (- (prefix-numeric-value arg))))
8387 (defun org-move-subtree-down (&optional arg)
8388 "Move the current subtree down past ARG headlines of the same level."
8389 (interactive "p")
8390 (setq arg (prefix-numeric-value arg))
8391 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8392 'org-get-last-sibling))
8393 (ins-point (make-marker))
8394 (cnt (abs arg))
8395 (col (current-column))
8396 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8397 ;; Select the tree
8398 (org-back-to-heading)
8399 (setq beg0 (point))
8400 (save-excursion
8401 (setq ne-beg (org-back-over-empty-lines))
8402 (setq beg (point)))
8403 (save-match-data
8404 (save-excursion (outline-end-of-heading)
8405 (setq folded (outline-invisible-p)))
8406 (progn (org-end-of-subtree nil t)
8407 (unless (eobp) (backward-char))))
8408 (outline-next-heading)
8409 (setq ne-end (org-back-over-empty-lines))
8410 (setq end (point))
8411 (goto-char beg0)
8412 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8413 ;; include less whitespace
8414 (save-excursion
8415 (goto-char beg)
8416 (forward-line (- ne-beg ne-end))
8417 (setq beg (point))))
8418 ;; Find insertion point, with error handling
8419 (while (> cnt 0)
8420 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8421 (progn (goto-char beg0)
8422 (user-error "Cannot move past superior level or buffer limit")))
8423 (setq cnt (1- cnt)))
8424 (if (> arg 0)
8425 ;; Moving forward - still need to move over subtree
8426 (progn (org-end-of-subtree t t)
8427 (save-excursion
8428 (org-back-over-empty-lines)
8429 (or (bolp) (newline)))))
8430 (setq ne-ins (org-back-over-empty-lines))
8431 (move-marker ins-point (point))
8432 (setq txt (buffer-substring beg end))
8433 (org-save-markers-in-region beg end)
8434 (delete-region beg end)
8435 (org-remove-empty-overlays-at beg)
8436 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8437 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8438 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8439 (let ((bbb (point)))
8440 (insert-before-markers txt)
8441 (org-reinstall-markers-in-region bbb)
8442 (move-marker ins-point bbb))
8443 (or (bolp) (insert "\n"))
8444 (setq ins-end (point))
8445 (goto-char ins-point)
8446 (org-skip-whitespace)
8447 (when (and (< arg 0)
8448 (org-first-sibling-p)
8449 (> ne-ins ne-beg))
8450 ;; Move whitespace back to beginning
8451 (save-excursion
8452 (goto-char ins-end)
8453 (let ((kill-whole-line t))
8454 (kill-line (- ne-ins ne-beg)) (point)))
8455 (insert (make-string (- ne-ins ne-beg) ?\n)))
8456 (move-marker ins-point nil)
8457 (if folded
8458 (hide-subtree)
8459 (org-show-entry)
8460 (org-show-children)
8461 (org-cycle-hide-drawers 'children))
8462 (org-clean-visibility-after-subtree-move)
8463 ;; move back to the initial column we were at
8464 (move-to-column col)))
8466 (defvar org-subtree-clip ""
8467 "Clipboard for cut and paste of subtrees.
8468 This is actually only a copy of the kill, because we use the normal kill
8469 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8471 (defvar org-subtree-clip-folded nil
8472 "Was the last copied subtree folded?
8473 This is used to fold the tree back after pasting.")
8475 (defun org-cut-subtree (&optional n)
8476 "Cut the current subtree into the clipboard.
8477 With prefix arg N, cut this many sequential subtrees.
8478 This is a short-hand for marking the subtree and then cutting it."
8479 (interactive "p")
8480 (org-copy-subtree n 'cut))
8482 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8483 "Copy the current subtree it in the clipboard.
8484 With prefix arg N, copy this many sequential subtrees.
8485 This is a short-hand for marking the subtree and then copying it.
8486 If CUT is non-nil, actually cut the subtree.
8487 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8488 of some markers in the region, even if CUT is non-nil. This is
8489 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8490 (interactive "p")
8491 (let (beg end folded (beg0 (point)))
8492 (if (org-called-interactively-p 'any)
8493 (org-back-to-heading nil) ; take what looks like a subtree
8494 (org-back-to-heading t)) ; take what is really there
8495 (setq beg (point))
8496 (skip-chars-forward " \t\r\n")
8497 (save-match-data
8498 (if nosubtrees
8499 (outline-next-heading)
8500 (save-excursion (outline-end-of-heading)
8501 (setq folded (outline-invisible-p)))
8502 (ignore-errors (org-forward-heading-same-level (1- n) t))
8503 (org-end-of-subtree t t)))
8504 ;; Include the end of an inlinetask
8505 (when (and (featurep 'org-inlinetask)
8506 (looking-at-p (concat (org-inlinetask-outline-regexp)
8507 "END[ \t]*$")))
8508 (end-of-line))
8509 (setq end (point))
8510 (goto-char beg0)
8511 (when (> end beg)
8512 (setq org-subtree-clip-folded folded)
8513 (when (or cut force-store-markers)
8514 (org-save-markers-in-region beg end))
8515 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8516 (setq org-subtree-clip (current-kill 0))
8517 (message "%s: Subtree(s) with %d characters"
8518 (if cut "Cut" "Copied")
8519 (length org-subtree-clip)))))
8521 (defun org-paste-subtree (&optional level tree for-yank remove)
8522 "Paste the clipboard as a subtree, with modification of headline level.
8523 The entire subtree is promoted or demoted in order to match a new headline
8524 level.
8526 If the cursor is at the beginning of a headline, the same level as
8527 that headline is used to paste the tree.
8529 If not, the new level is derived from the *visible* headings
8530 before and after the insertion point, and taken to be the inferior headline
8531 level of the two. So if the previous visible heading is level 3 and the
8532 next is level 4 (or vice versa), level 4 will be used for insertion.
8533 This makes sure that the subtree remains an independent subtree and does
8534 not swallow low level entries.
8536 You can also force a different level, either by using a numeric prefix
8537 argument, or by inserting the heading marker by hand. For example, if the
8538 cursor is after \"*****\", then the tree will be shifted to level 5.
8540 If optional TREE is given, use this text instead of the kill ring.
8542 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8543 move back over whitespace before inserting, and move point to the end of
8544 the inserted text when done.
8546 When REMOVE is non-nil, remove the subtree from the clipboard."
8547 (interactive "P")
8548 (setq tree (or tree (and kill-ring (current-kill 0))))
8549 (unless (org-kill-is-subtree-p tree)
8550 (user-error "%s"
8551 (substitute-command-keys
8552 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8553 (org-with-limited-levels
8554 (let* ((visp (not (outline-invisible-p)))
8555 (txt tree)
8556 (^re_ "\\(\\*+\\)[ \t]*")
8557 (old-level (if (string-match org-outline-regexp-bol txt)
8558 (- (match-end 0) (match-beginning 0) 1)
8559 -1))
8560 (force-level (cond (level (prefix-numeric-value level))
8561 ((and (looking-at "[ \t]*$")
8562 (string-match
8563 "^\\*+$" (buffer-substring
8564 (point-at-bol) (point))))
8565 (- (match-end 0) (match-beginning 0)))
8566 ((and (bolp)
8567 (looking-at org-outline-regexp))
8568 (- (match-end 0) (point) 1))))
8569 (previous-level (save-excursion
8570 (condition-case nil
8571 (progn
8572 (outline-previous-visible-heading 1)
8573 (if (looking-at ^re_)
8574 (- (match-end 0) (match-beginning 0) 1)
8576 (error 1))))
8577 (next-level (save-excursion
8578 (condition-case nil
8579 (progn
8580 (or (looking-at org-outline-regexp)
8581 (outline-next-visible-heading 1))
8582 (if (looking-at ^re_)
8583 (- (match-end 0) (match-beginning 0) 1)
8585 (error 1))))
8586 (new-level (or force-level (max previous-level next-level)))
8587 (shift (if (or (= old-level -1)
8588 (= new-level -1)
8589 (= old-level new-level))
8591 (- new-level old-level)))
8592 (delta (if (> shift 0) -1 1))
8593 (func (if (> shift 0) 'org-demote 'org-promote))
8594 (org-odd-levels-only nil)
8595 beg end newend)
8596 ;; Remove the forced level indicator
8597 (if force-level
8598 (delete-region (point-at-bol) (point)))
8599 ;; Paste
8600 (beginning-of-line (if (bolp) 1 2))
8601 (setq beg (point))
8602 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8603 (insert-before-markers txt)
8604 (unless (string-match "\n\\'" txt) (insert "\n"))
8605 (setq newend (point))
8606 (org-reinstall-markers-in-region beg)
8607 (setq end (point))
8608 (goto-char beg)
8609 (skip-chars-forward " \t\n\r")
8610 (setq beg (point))
8611 (if (and (outline-invisible-p) visp)
8612 (save-excursion (outline-show-heading)))
8613 ;; Shift if necessary
8614 (unless (= shift 0)
8615 (save-restriction
8616 (narrow-to-region beg end)
8617 (while (not (= shift 0))
8618 (org-map-region func (point-min) (point-max))
8619 (setq shift (+ delta shift)))
8620 (goto-char (point-min))
8621 (setq newend (point-max))))
8622 (when (or (org-called-interactively-p 'interactive) for-yank)
8623 (message "Clipboard pasted as level %d subtree" new-level))
8624 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8625 kill-ring
8626 (eq org-subtree-clip (current-kill 0))
8627 org-subtree-clip-folded)
8628 ;; The tree was folded before it was killed/copied
8629 (hide-subtree))
8630 (and for-yank (goto-char newend))
8631 (and remove (setq kill-ring (cdr kill-ring))))))
8633 (defun org-kill-is-subtree-p (&optional txt)
8634 "Check if the current kill is an outline subtree, or a set of trees.
8635 Returns nil if kill does not start with a headline, or if the first
8636 headline level is not the largest headline level in the tree.
8637 So this will actually accept several entries of equal levels as well,
8638 which is OK for `org-paste-subtree'.
8639 If optional TXT is given, check this string instead of the current kill."
8640 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8641 (re (org-get-limited-outline-regexp))
8642 (^re (concat "^" re))
8643 (start-level (and kill
8644 (string-match
8645 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8646 kill)
8647 (- (match-end 2) (match-beginning 2) 1)))
8648 (start (1+ (or (match-beginning 2) -1))))
8649 (if (not start-level)
8650 (progn
8651 nil) ;; does not even start with a heading
8652 (catch 'exit
8653 (while (setq start (string-match ^re kill (1+ start)))
8654 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8655 (throw 'exit nil)))
8656 t))))
8658 (defvar org-markers-to-move nil
8659 "Markers that should be moved with a cut-and-paste operation.
8660 Those markers are stored together with their positions relative to
8661 the start of the region.")
8663 (defun org-save-markers-in-region (beg end)
8664 "Check markers in region.
8665 If these markers are between BEG and END, record their position relative
8666 to BEG, so that after moving the block of text, we can put the markers back
8667 into place.
8668 This function gets called just before an entry or tree gets cut from the
8669 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8670 called immediately, to move the markers with the entries."
8671 (setq org-markers-to-move nil)
8672 (when (featurep 'org-clock)
8673 (org-clock-save-markers-for-cut-and-paste beg end))
8674 (when (featurep 'org-agenda)
8675 (org-agenda-save-markers-for-cut-and-paste beg end)))
8677 (defun org-check-and-save-marker (marker beg end)
8678 "Check if MARKER is between BEG and END.
8679 If yes, remember the marker and the distance to BEG."
8680 (when (and (marker-buffer marker)
8681 (equal (marker-buffer marker) (current-buffer)))
8682 (if (and (>= marker beg) (< marker end))
8683 (push (cons marker (- marker beg)) org-markers-to-move))))
8685 (defun org-reinstall-markers-in-region (beg)
8686 "Move all remembered markers to their position relative to BEG."
8687 (mapc (lambda (x)
8688 (move-marker (car x) (+ beg (cdr x))))
8689 org-markers-to-move)
8690 (setq org-markers-to-move nil))
8692 (defun org-narrow-to-subtree ()
8693 "Narrow buffer to the current subtree."
8694 (interactive)
8695 (save-excursion
8696 (save-match-data
8697 (org-with-limited-levels
8698 (narrow-to-region
8699 (progn (org-back-to-heading t) (point))
8700 (progn (org-end-of-subtree t t)
8701 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8702 (point)))))))
8704 (defun org-narrow-to-block ()
8705 "Narrow buffer to the current block."
8706 (interactive)
8707 (let* ((case-fold-search t)
8708 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8709 "^[ \t]*#\\+end_.*")))
8710 (if blockp
8711 (narrow-to-region (car blockp) (cdr blockp))
8712 (user-error "Not in a block"))))
8714 (defun org-clone-subtree-with-time-shift (n &optional shift)
8715 "Clone the task (subtree) at point N times.
8716 The clones will be inserted as siblings.
8718 In interactive use, the user will be prompted for the number of
8719 clones to be produced. If the entry has a timestamp, the user
8720 will also be prompted for a time shift, which may be a repeater
8721 as used in time stamps, for example `+3d'. To disable this,
8722 you can call the function with a universal prefix argument.
8724 When a valid repeater is given and the entry contains any time
8725 stamps, the clones will become a sequence in time, with time
8726 stamps in the subtree shifted for each clone produced. If SHIFT
8727 is nil or the empty string, time stamps will be left alone. The
8728 ID property of the original subtree is removed.
8730 If the original subtree did contain time stamps with a repeater,
8731 the following will happen:
8732 - the repeater will be removed in each clone
8733 - an additional clone will be produced, with the current, unshifted
8734 date(s) in the entry.
8735 - the original entry will be placed *after* all the clones, with
8736 repeater intact.
8737 - the start days in the repeater in the original entry will be shifted
8738 to past the last clone.
8739 In this way you can spell out a number of instances of a repeating task,
8740 and still retain the repeater to cover future instances of the task.
8742 As described above, N+1 clones are produced when the original
8743 subtree has a repeater. Setting N to 0, then, can be used to
8744 remove the repeater from a subtree and create a shifted clone
8745 with the original repeater."
8746 (interactive "nNumber of clones to produce: ")
8747 (let ((shift
8748 (or shift
8749 (if (and (not (equal current-prefix-arg '(4)))
8750 (save-excursion
8751 (re-search-forward org-ts-regexp-both
8752 (save-excursion
8753 (org-end-of-subtree t)
8754 (point)) t)))
8755 (read-from-minibuffer
8756 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8757 ""))) ;; No time shift
8758 (n-no-remove -1)
8759 (drawer-re org-drawer-regexp)
8760 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8761 beg end template task idprop
8762 shift-n shift-what doshift nmin nmax)
8763 (unless (wholenump n)
8764 (user-error "Invalid number of replications %s" n))
8765 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8766 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8767 shift)))
8768 (user-error "Invalid shift specification %s" shift))
8769 (when doshift
8770 (setq shift-n (string-to-number (match-string 1 shift))
8771 shift-what (cdr (assoc (match-string 2 shift)
8772 '(("d" . day) ("w" . week)
8773 ("m" . month) ("y" . year))))))
8774 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8775 (setq nmin 1 nmax n)
8776 (org-back-to-heading t)
8777 (setq beg (point))
8778 (setq idprop (org-entry-get nil "ID"))
8779 (org-end-of-subtree t t)
8780 (or (bolp) (insert "\n"))
8781 (setq end (point))
8782 (setq template (buffer-substring beg end))
8783 (when (and doshift
8784 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8785 (delete-region beg end)
8786 (setq end beg)
8787 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8788 (goto-char end)
8789 (loop for n from nmin to nmax do
8790 ;; prepare clone
8791 (with-temp-buffer
8792 (insert template)
8793 (org-mode)
8794 (goto-char (point-min))
8795 (org-show-subtree)
8796 (and idprop (if org-clone-delete-id
8797 (org-entry-delete nil "ID")
8798 (org-id-get-create t)))
8799 (unless (= n 0)
8800 (while (re-search-forward org-clock-re nil t)
8801 (kill-whole-line))
8802 (goto-char (point-min))
8803 (while (re-search-forward drawer-re nil t)
8804 (org-remove-empty-drawer-at (point))))
8805 (goto-char (point-min))
8806 (when doshift
8807 (while (re-search-forward org-ts-regexp-both nil t)
8808 (org-timestamp-change (* n shift-n) shift-what))
8809 (unless (= n n-no-remove)
8810 (goto-char (point-min))
8811 (while (re-search-forward org-ts-regexp nil t)
8812 (save-excursion
8813 (goto-char (match-beginning 0))
8814 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8815 (delete-region (match-beginning 1) (match-end 1)))))))
8816 (setq task (buffer-string)))
8817 (insert task))
8818 (goto-char beg)))
8820 ;;; Outline Sorting
8822 (defun org-sort (with-case)
8823 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8824 Optional argument WITH-CASE means sort case-sensitively."
8825 (interactive "P")
8826 (cond
8827 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8828 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8830 (org-call-with-arg 'org-sort-entries with-case))))
8832 (defun org-sort-remove-invisible (s)
8833 "Remove invisible links from string S."
8834 (remove-text-properties 0 (length s) org-rm-props s)
8835 (while (string-match org-bracket-link-regexp s)
8836 (setq s (replace-match (if (match-end 2)
8837 (match-string 3 s)
8838 (match-string 1 s))
8839 t t s)))
8840 (let ((st (format " %s " s)))
8841 (while (string-match org-emph-re st)
8842 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8843 (setq s (substring st 1 -1)))
8846 (defvar org-priority-regexp) ; defined later in the file
8848 (defvar org-after-sorting-entries-or-items-hook nil
8849 "Hook that is run after a bunch of entries or items have been sorted.
8850 When children are sorted, the cursor is in the parent line when this
8851 hook gets called. When a region or a plain list is sorted, the cursor
8852 will be in the first entry of the sorted region/list.")
8854 (defun org-sort-entries
8855 (&optional with-case sorting-type getkey-func compare-func property)
8856 "Sort entries on a certain level of an outline tree.
8857 If there is an active region, the entries in the region are sorted.
8858 Else, if the cursor is before the first entry, sort the top-level items.
8859 Else, the children of the entry at point are sorted.
8861 Sorting can be alphabetically, numerically, by date/time as given by
8862 a time stamp, by a property, by priority order, or by a custom function.
8864 The command prompts for the sorting type unless it has been given to the
8865 function through the SORTING-TYPE argument, which needs to be a character,
8866 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8867 the precise meaning of each character:
8869 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8870 c By creation time, which is assumed to be the first inactive time stamp
8871 at the beginning of a line.
8872 d By deadline date/time.
8873 k By clocking time.
8874 n Numerically, by converting the beginning of the entry/item to a number.
8875 o By order of TODO keywords.
8876 p By priority according to the cookie.
8877 r By the value of a property.
8878 s By scheduled date/time.
8879 t By date/time, either the first active time stamp in the entry, or, if
8880 none exist, by the first inactive one.
8882 Capital letters will reverse the sort order.
8884 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8885 called with point at the beginning of the record. It must return either
8886 a string or a number that should serve as the sorting key for that record.
8888 Comparing entries ignores case by default. However, with an optional argument
8889 WITH-CASE, the sorting considers case as well.
8891 Sorting is done against the visible part of the headlines, it ignores hidden
8892 links.
8894 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8895 (interactive "P")
8896 (let ((case-func (if with-case 'identity 'downcase))
8897 (cmstr
8898 ;; The clock marker is lost when using `sort-subr', let's
8899 ;; store the clocking string.
8900 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8901 (save-excursion
8902 (goto-char org-clock-marker)
8903 (buffer-substring-no-properties (line-beginning-position)
8904 (point)))))
8905 start beg end stars re re2
8906 txt what tmp)
8907 ;; Find beginning and end of region to sort
8908 (cond
8909 ((org-region-active-p)
8910 ;; we will sort the region
8911 (setq end (region-end)
8912 what "region")
8913 (goto-char (region-beginning))
8914 (if (not (org-at-heading-p)) (outline-next-heading))
8915 (setq start (point)))
8916 ((or (org-at-heading-p)
8917 (ignore-errors (progn (org-back-to-heading) t)))
8918 ;; we will sort the children of the current headline
8919 (org-back-to-heading)
8920 (setq start (point)
8921 end (progn (org-end-of-subtree t t)
8922 (or (bolp) (insert "\n"))
8923 (when (>= (org-back-over-empty-lines) 1)
8924 (forward-line 1))
8925 (point))
8926 what "children")
8927 (goto-char start)
8928 (show-subtree)
8929 (outline-next-heading))
8931 ;; we will sort the top-level entries in this file
8932 (goto-char (point-min))
8933 (or (org-at-heading-p) (outline-next-heading))
8934 (setq start (point))
8935 (goto-char (point-max))
8936 (beginning-of-line 1)
8937 (when (looking-at ".*?\\S-")
8938 ;; File ends in a non-white line
8939 (end-of-line 1)
8940 (insert "\n"))
8941 (setq end (point-max))
8942 (setq what "top-level")
8943 (goto-char start)
8944 (show-all)))
8946 (setq beg (point))
8947 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8949 (looking-at "\\(\\*+\\)")
8950 (setq stars (match-string 1)
8951 re (concat "^" (regexp-quote stars) " +")
8952 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8953 txt (buffer-substring beg end))
8954 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8955 (if (and (not (equal stars "*")) (string-match re2 txt))
8956 (user-error "Region to sort contains a level above the first entry"))
8958 (unless sorting-type
8959 (message
8960 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8961 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8962 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8963 what)
8964 (setq sorting-type (read-char-exclusive))
8966 (unless getkey-func
8967 (and (= (downcase sorting-type) ?f)
8968 (setq getkey-func
8969 (org-icompleting-read "Sort using function: "
8970 obarray 'fboundp t nil nil))
8971 (setq getkey-func (intern getkey-func))))
8973 (and (= (downcase sorting-type) ?r)
8974 (not property)
8975 (setq property
8976 (org-icompleting-read "Property: "
8977 (mapcar 'list (org-buffer-property-keys t))
8978 nil t))))
8980 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8981 (message "Sorting entries...")
8983 (save-restriction
8984 (narrow-to-region start end)
8985 (let ((dcst (downcase sorting-type))
8986 (case-fold-search nil)
8987 (now (current-time)))
8988 (sort-subr
8989 (/= dcst sorting-type)
8990 ;; This function moves to the beginning character of the "record" to
8991 ;; be sorted.
8992 (lambda nil
8993 (if (re-search-forward re nil t)
8994 (goto-char (match-beginning 0))
8995 (goto-char (point-max))))
8996 ;; This function moves to the last character of the "record" being
8997 ;; sorted.
8998 (lambda nil
8999 (save-match-data
9000 (condition-case nil
9001 (outline-forward-same-level 1)
9002 (error
9003 (goto-char (point-max))))))
9004 ;; This function returns the value that gets sorted against.
9005 (lambda nil
9006 (cond
9007 ((= dcst ?n)
9008 (if (looking-at org-complex-heading-regexp)
9009 (string-to-number (org-sort-remove-invisible (match-string 4)))
9010 nil))
9011 ((= dcst ?a)
9012 (if (looking-at org-complex-heading-regexp)
9013 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9014 nil))
9015 ((= dcst ?k)
9016 (or (get-text-property (point) :org-clock-minutes) 0))
9017 ((= dcst ?t)
9018 (let ((end (save-excursion (outline-next-heading) (point))))
9019 (if (or (re-search-forward org-ts-regexp end t)
9020 (re-search-forward org-ts-regexp-both end t))
9021 (org-time-string-to-seconds (match-string 0))
9022 (org-float-time now))))
9023 ((= dcst ?c)
9024 (let ((end (save-excursion (outline-next-heading) (point))))
9025 (if (re-search-forward
9026 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9027 end t)
9028 (org-time-string-to-seconds (match-string 0))
9029 (org-float-time now))))
9030 ((= dcst ?s)
9031 (let ((end (save-excursion (outline-next-heading) (point))))
9032 (if (re-search-forward org-scheduled-time-regexp end t)
9033 (org-time-string-to-seconds (match-string 1))
9034 (org-float-time now))))
9035 ((= dcst ?d)
9036 (let ((end (save-excursion (outline-next-heading) (point))))
9037 (if (re-search-forward org-deadline-time-regexp end t)
9038 (org-time-string-to-seconds (match-string 1))
9039 (org-float-time now))))
9040 ((= dcst ?p)
9041 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9042 (string-to-char (match-string 2))
9043 org-default-priority))
9044 ((= dcst ?r)
9045 (or (org-entry-get nil property) ""))
9046 ((= dcst ?o)
9047 (if (looking-at org-complex-heading-regexp)
9048 (let* ((m (match-string 2))
9049 (s (if (member m org-done-keywords) '- '+)))
9050 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9051 ((= dcst ?f)
9052 (if getkey-func
9053 (progn
9054 (setq tmp (funcall getkey-func))
9055 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9056 tmp)
9057 (error "Invalid key function `%s'" getkey-func)))
9058 (t (error "Invalid sorting type `%c'" sorting-type))))
9060 (cond
9061 ((= dcst ?a) 'string<)
9062 ((= dcst ?f) compare-func)
9063 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9064 (run-hooks 'org-after-sorting-entries-or-items-hook)
9065 ;; Reset the clock marker if needed
9066 (when cmstr
9067 (save-excursion
9068 (goto-char start)
9069 (search-forward cmstr nil t)
9070 (move-marker org-clock-marker (point))))
9071 (message "Sorting entries...done")))
9073 ;;; The orgstruct minor mode
9075 ;; Define a minor mode which can be used in other modes in order to
9076 ;; integrate the org-mode structure editing commands.
9078 ;; This is really a hack, because the org-mode structure commands use
9079 ;; keys which normally belong to the major mode. Here is how it
9080 ;; works: The minor mode defines all the keys necessary to operate the
9081 ;; structure commands, but wraps the commands into a function which
9082 ;; tests if the cursor is currently at a headline or a plain list
9083 ;; item. If that is the case, the structure command is used,
9084 ;; temporarily setting many Org-mode variables like regular
9085 ;; expressions for filling etc. However, when any of those keys is
9086 ;; used at a different location, function uses `key-binding' to look
9087 ;; up if the key has an associated command in another currently active
9088 ;; keymap (minor modes, major mode, global), and executes that
9089 ;; command. There might be problems if any of the keys is otherwise
9090 ;; used as a prefix key.
9092 (defcustom orgstruct-heading-prefix-regexp ""
9093 "Regexp that matches the custom prefix of Org headlines in
9094 orgstruct(++)-mode."
9095 :group 'org
9096 :version "24.4"
9097 :package-version '(Org . "8.3")
9098 :type 'regexp)
9099 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9101 (defcustom orgstruct-setup-hook nil
9102 "Hook run after orgstruct-mode-map is filled."
9103 :group 'org
9104 :version "24.4"
9105 :package-version '(Org . "8.0")
9106 :type 'hook)
9108 (defvar orgstruct-initialized nil)
9110 (defvar org-local-vars nil
9111 "List of local variables, for use by `orgstruct-mode'.")
9113 ;;;###autoload
9114 (define-minor-mode orgstruct-mode
9115 "Toggle the minor mode `orgstruct-mode'.
9116 This mode is for using Org-mode structure commands in other
9117 modes. The following keys behave as if Org-mode were active, if
9118 the cursor is on a headline, or on a plain list item (both as
9119 defined by Org-mode)."
9120 nil " OrgStruct" (make-sparse-keymap)
9121 (funcall (if orgstruct-mode
9122 'add-to-invisibility-spec
9123 'remove-from-invisibility-spec)
9124 '(outline . t))
9125 (when orgstruct-mode
9126 (org-load-modules-maybe)
9127 (unless orgstruct-initialized
9128 (orgstruct-setup)
9129 (setq orgstruct-initialized t))))
9131 ;;;###autoload
9132 (defun turn-on-orgstruct ()
9133 "Unconditionally turn on `orgstruct-mode'."
9134 (orgstruct-mode 1))
9136 (defvar org-fb-vars nil)
9137 (make-variable-buffer-local 'org-fb-vars)
9138 (defun orgstruct++-mode (&optional arg)
9139 "Toggle `orgstruct-mode', the enhanced version of it.
9140 In addition to setting orgstruct-mode, this also exports all
9141 indentation and autofilling variables from org-mode into the
9142 buffer. It will also recognize item context in multiline items."
9143 (interactive "P")
9144 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9145 (if (< arg 1)
9146 (progn (orgstruct-mode -1)
9147 (mapc (lambda(v)
9148 (org-set-local (car v)
9149 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9150 org-fb-vars))
9151 (orgstruct-mode 1)
9152 (setq org-fb-vars nil)
9153 (unless org-local-vars
9154 (setq org-local-vars (org-get-local-variables)))
9155 (let (var val)
9156 (mapc
9157 (lambda (x)
9158 (when (string-match
9159 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9160 (symbol-name (car x)))
9161 (setq var (car x) val (nth 1 x))
9162 (push (list var `(quote ,(eval var))) org-fb-vars)
9163 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9164 org-local-vars)
9165 (org-set-local 'orgstruct-is-++ t))))
9167 (defvar orgstruct-is-++ nil
9168 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9169 (make-variable-buffer-local 'orgstruct-is-++)
9171 ;;;###autoload
9172 (defun turn-on-orgstruct++ ()
9173 "Unconditionally turn on `orgstruct++-mode'."
9174 (orgstruct++-mode 1))
9176 (defun orgstruct-error ()
9177 "Error when there is no default binding for a structure key."
9178 (interactive)
9179 (funcall (if (fboundp 'user-error)
9180 'user-error
9181 'error)
9182 "This key has no function outside structure elements"))
9184 (defun orgstruct-setup ()
9185 "Setup orgstruct keymap."
9186 (dolist (cell '((org-demote . t)
9187 (org-metaleft . t)
9188 (org-metaright . t)
9189 (org-promote . t)
9190 (org-shiftmetaleft . t)
9191 (org-shiftmetaright . t)
9192 org-backward-element
9193 org-backward-heading-same-level
9194 org-ctrl-c-ret
9195 org-ctrl-c-minus
9196 org-ctrl-c-star
9197 org-cycle
9198 org-forward-heading-same-level
9199 org-insert-heading
9200 org-insert-heading-respect-content
9201 org-kill-note-or-show-branches
9202 org-mark-subtree
9203 org-meta-return
9204 org-metadown
9205 org-metaup
9206 org-narrow-to-subtree
9207 org-promote-subtree
9208 org-reveal
9209 org-shiftdown
9210 org-shiftleft
9211 org-shiftmetadown
9212 org-shiftmetaup
9213 org-shiftright
9214 org-shifttab
9215 org-shifttab
9216 org-shiftup
9217 org-show-children
9218 org-show-subtree
9219 org-sort
9220 org-up-element
9221 outline-demote
9222 outline-next-visible-heading
9223 outline-previous-visible-heading
9224 outline-promote
9225 outline-up-heading))
9226 (let ((f (or (car-safe cell) cell))
9227 (disable-when-heading-prefix (cdr-safe cell)))
9228 (when (fboundp f)
9229 (let ((new-bindings))
9230 (dolist (binding (nconc (where-is-internal f org-mode-map)
9231 (where-is-internal f outline-mode-map)))
9232 (push binding new-bindings)
9233 ;; TODO use local-function-key-map
9234 (dolist (rep '(("<tab>" . "TAB")
9235 ("<return>" . "RET")
9236 ("<escape>" . "ESC")
9237 ("<delete>" . "DEL")))
9238 (setq binding (read-kbd-macro
9239 (let ((case-fold-search))
9240 (replace-regexp-in-string
9241 (regexp-quote (cdr rep))
9242 (car rep)
9243 (key-description binding)))))
9244 (pushnew binding new-bindings :test 'equal)))
9245 (dolist (binding new-bindings)
9246 (let ((key (lookup-key orgstruct-mode-map binding)))
9247 (when (or (not key) (numberp key))
9248 (ignore-errors
9249 (org-defkey orgstruct-mode-map
9250 binding
9251 (orgstruct-make-binding
9252 f binding disable-when-heading-prefix))))))))))
9253 (run-hooks 'orgstruct-setup-hook))
9255 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9256 "Create a function for binding in the structure minor mode.
9257 FUN is the command to call inside a table. KEY is the key that
9258 should be checked in for a command to execute outside of tables.
9259 Non-nil `disable-when-heading-prefix' means to disable the command
9260 if `orgstruct-heading-prefix-regexp' is not empty."
9261 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9262 (let ((nname name)
9263 (i 0))
9264 (while (fboundp (intern nname))
9265 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9266 (setq name (intern nname)))
9267 (eval
9268 (let ((bindings '((org-heading-regexp
9269 (concat "^"
9270 orgstruct-heading-prefix-regexp
9271 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9272 (org-outline-regexp
9273 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9274 (org-outline-regexp-bol
9275 (concat "^" org-outline-regexp))
9276 (outline-regexp org-outline-regexp)
9277 (outline-heading-end-regexp "\n")
9278 (outline-level 'org-outline-level)
9279 (outline-heading-alist))))
9280 `(defun ,name (arg)
9281 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9282 "Outside of structure, run the binding of `"
9283 (key-description key) "'."
9284 (when disable-when-heading-prefix
9285 (concat
9286 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9287 "back to the default binding due to limitations of Org's implementation of\n"
9288 "`" (symbol-name fun) "'.")))
9289 (interactive "p")
9290 (let* ((disable
9291 ,(and disable-when-heading-prefix
9292 '(not (string= orgstruct-heading-prefix-regexp ""))))
9293 (fallback
9294 (or disable
9295 (not
9296 (let* ,bindings
9297 (org-context-p 'headline 'item
9298 ,(when (memq fun
9299 '(org-insert-heading
9300 org-insert-heading-respect-content
9301 org-meta-return))
9302 '(when orgstruct-is-++
9303 'item-body))))))))
9304 (if fallback
9305 (let* ((orgstruct-mode)
9306 (binding
9307 (let ((key ,key))
9308 (catch 'exit
9309 (dolist
9310 (rep
9311 '(nil
9312 ("<\\([^>]*\\)tab>" . "\\1TAB")
9313 ("<\\([^>]*\\)return>" . "\\1RET")
9314 ("<\\([^>]*\\)escape>" . "\\1ESC")
9315 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9316 nil)
9317 (when rep
9318 (setq key (read-kbd-macro
9319 (let ((case-fold-search))
9320 (replace-regexp-in-string
9321 (car rep)
9322 (cdr rep)
9323 (key-description key))))))
9324 (when (key-binding key)
9325 (throw 'exit (key-binding key))))))))
9326 (if (keymapp binding)
9327 (org-set-transient-map binding)
9328 (let ((func (or binding
9329 (unless disable
9330 'orgstruct-error))))
9331 (when func
9332 (call-interactively func)))))
9333 (org-run-like-in-org-mode
9334 (lambda ()
9335 (interactive)
9336 (let* ,bindings
9337 (call-interactively ',fun)))))))))
9338 name))
9340 (defun org-contextualize-keys (alist contexts)
9341 "Return valid elements in ALIST depending on CONTEXTS.
9343 `org-agenda-custom-commands' or `org-capture-templates' are the
9344 values used for ALIST, and `org-agenda-custom-commands-contexts'
9345 or `org-capture-templates-contexts' are the associated contexts
9346 definitions."
9347 (let ((contexts
9348 ;; normalize contexts
9349 (mapcar
9350 (lambda(c) (cond ((listp (cadr c))
9351 (list (car c) (car c) (cadr c)))
9352 ((string= "" (cadr c))
9353 (list (car c) (car c) (caddr c)))
9354 (t c)))
9355 contexts))
9356 (a alist) r s)
9357 ;; loop over all commands or templates
9358 (dolist (c a)
9359 (let (vrules repl)
9360 (cond
9361 ((not (assoc (car c) contexts))
9362 (push c r))
9363 ((and (assoc (car c) contexts)
9364 (setq vrules (org-contextualize-validate-key
9365 (car c) contexts)))
9366 (mapc (lambda (vr)
9367 (when (not (equal (car vr) (cadr vr)))
9368 (setq repl vr)))
9369 vrules)
9370 (if (not repl) (push c r)
9371 (push (cadr repl) s)
9372 (push
9373 (cons (car c)
9374 (cdr (or (assoc (cadr repl) alist)
9375 (error "Undefined key `%s' as contextual replacement for `%s'"
9376 (cadr repl) (car c)))))
9377 r))))))
9378 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9379 (delq
9381 (delete-dups
9382 (mapcar (lambda (x)
9383 (let ((tpl (car x)))
9384 (when (not (delq
9386 (mapcar (lambda (y)
9387 (equal y tpl))
9388 s)))
9389 x)))
9390 (reverse r))))))
9392 (defun org-contextualize-validate-key (key contexts)
9393 "Check CONTEXTS for agenda or capture KEY."
9394 (let (rr res)
9395 (dolist (r contexts)
9396 (mapc
9397 (lambda (rr)
9398 (when
9399 (and (equal key (car r))
9400 (if (functionp rr) (funcall rr)
9401 (or (and (eq (car rr) 'in-file)
9402 (buffer-file-name)
9403 (string-match (cdr rr) (buffer-file-name)))
9404 (and (eq (car rr) 'in-mode)
9405 (string-match (cdr rr) (symbol-name major-mode)))
9406 (and (eq (car rr) 'in-buffer)
9407 (string-match (cdr rr) (buffer-name)))
9408 (when (and (eq (car rr) 'not-in-file)
9409 (buffer-file-name))
9410 (not (string-match (cdr rr) (buffer-file-name))))
9411 (when (eq (car rr) 'not-in-mode)
9412 (not (string-match (cdr rr) (symbol-name major-mode))))
9413 (when (eq (car rr) 'not-in-buffer)
9414 (not (string-match (cdr rr) (buffer-name)))))))
9415 (push r res)))
9416 (car (last r))))
9417 (delete-dups (delq nil res))))
9419 (defun org-context-p (&rest contexts)
9420 "Check if local context is any of CONTEXTS.
9421 Possible values in the list of contexts are `table', `headline', and `item'."
9422 (let ((pos (point)))
9423 (goto-char (point-at-bol))
9424 (prog1 (or (and (memq 'table contexts)
9425 (looking-at "[ \t]*|"))
9426 (and (memq 'headline contexts)
9427 (looking-at org-outline-regexp))
9428 (and (memq 'item contexts)
9429 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9430 (and (memq 'item-body contexts)
9431 (org-in-item-p)))
9432 (goto-char pos))))
9434 (defun org-get-local-variables ()
9435 "Return a list of all local variables in an Org mode buffer."
9436 (let (varlist)
9437 (with-current-buffer (get-buffer-create "*Org tmp*")
9438 (erase-buffer)
9439 (org-mode)
9440 (setq varlist (buffer-local-variables)))
9441 (kill-buffer "*Org tmp*")
9442 (delq nil
9443 (mapcar
9444 (lambda (x)
9445 (setq x
9446 (if (symbolp x)
9447 (list x)
9448 (list (car x) (cdr x))))
9449 (if (and (not (get (car x) 'org-state))
9450 (string-match
9451 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9452 (symbol-name (car x))))
9453 x nil))
9454 varlist))))
9456 (defun org-clone-local-variables (from-buffer &optional regexp)
9457 "Clone local variables from FROM-BUFFER.
9458 Optional argument REGEXP selects variables to clone."
9459 (mapc
9460 (lambda (pair)
9461 (and (symbolp (car pair))
9462 (or (null regexp)
9463 (string-match regexp (symbol-name (car pair))))
9464 (set (make-local-variable (car pair))
9465 (cdr pair))))
9466 (buffer-local-variables from-buffer)))
9468 ;;;###autoload
9469 (defun org-run-like-in-org-mode (cmd)
9470 "Run a command, pretending that the current buffer is in Org-mode.
9471 This will temporarily bind local variables that are typically bound in
9472 Org-mode to the values they have in Org-mode, and then interactively
9473 call CMD."
9474 (org-load-modules-maybe)
9475 (unless org-local-vars
9476 (setq org-local-vars (org-get-local-variables)))
9477 (let (binds)
9478 (dolist (var org-local-vars)
9479 (when (or (not (boundp (car var)))
9480 (eq (symbol-value (car var))
9481 (default-value (car var))))
9482 (push (list (car var) `(quote ,(cadr var))) binds)))
9483 (eval `(let ,binds
9484 (call-interactively (quote ,cmd))))))
9486 (defun org-get-category (&optional pos force-refresh)
9487 "Get the category applying to position POS."
9488 (save-match-data
9489 (if force-refresh (org-refresh-category-properties))
9490 (let ((pos (or pos (point))))
9491 (or (get-text-property pos 'org-category)
9492 (progn (org-refresh-category-properties)
9493 (get-text-property pos 'org-category))))))
9495 ;;; Refresh properties
9497 (defun org-refresh-properties (dprop tprop)
9498 "Refresh buffer text properties.
9499 DPROP is the drawer property and TPROP is either the
9500 corresponding text property to set, or an alist with each element
9501 being a text property (as a symbol) and a function to apply to
9502 the value of the drawer property."
9503 (let ((case-fold-search t)
9504 (inhibit-read-only t))
9505 (org-with-silent-modifications
9506 (save-excursion
9507 (save-restriction
9508 (widen)
9509 (goto-char (point-min))
9510 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9511 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9513 (defun org-refresh-property (tprop p)
9514 "Refresh the buffer text property TPROP from the drawer property P.
9515 The refresh happens only for the current tree (not subtree)."
9516 (unless (org-before-first-heading-p)
9517 (save-excursion
9518 (org-back-to-heading t)
9519 (if (symbolp tprop)
9520 ;; TPROP is a text property symbol
9521 (put-text-property
9522 (point) (or (outline-next-heading) (point-max)) tprop p)
9523 ;; TPROP is an alist with (properties . function) elements
9524 (dolist (al tprop)
9525 (save-excursion
9526 (put-text-property
9527 (line-beginning-position) (or (outline-next-heading) (point-max))
9528 (car al)
9529 (funcall (cdr al) p))))))))
9531 (defun org-refresh-category-properties ()
9532 "Refresh category text properties in the buffer."
9533 (let ((case-fold-search t)
9534 (inhibit-read-only t)
9535 (default-category
9536 (cond ((null org-category)
9537 (if buffer-file-name
9538 (file-name-sans-extension
9539 (file-name-nondirectory buffer-file-name))
9540 "???"))
9541 ((symbolp org-category) (symbol-name org-category))
9542 (t org-category))))
9543 (org-with-silent-modifications
9544 (org-with-wide-buffer
9545 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9546 ;; This is the default category for the buffer. If none is
9547 ;; found, fall-back to `org-category' or buffer file name.
9548 (put-text-property
9549 (point-min) (point-max)
9550 'org-category
9551 (catch 'buffer-category
9552 (goto-char (point-max))
9553 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9554 (let ((element (org-element-at-point)))
9555 (when (eq (org-element-type element) 'keyword)
9556 (throw 'buffer-category
9557 (org-element-property :value element)))))
9558 default-category))
9559 ;; Set sub-tree specific categories.
9560 (goto-char (point-min))
9561 (let ((regexp (org-re-property "CATEGORY")))
9562 (while (re-search-forward regexp nil t)
9563 (let ((value (org-match-string-no-properties 3)))
9564 (when (org-at-property-p)
9565 (put-text-property
9566 (save-excursion (org-back-to-heading t) (point))
9567 (save-excursion (org-end-of-subtree t t) (point))
9568 'org-category
9569 value)))))))))
9571 (defun org-refresh-stats-properties ()
9572 "Refresh stats text properties in the buffer."
9573 (let (stats)
9574 (org-with-silent-modifications
9575 (save-excursion
9576 (save-restriction
9577 (widen)
9578 (goto-char (point-min))
9579 (while (re-search-forward
9580 (concat org-outline-regexp-bol ".*"
9581 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9582 nil t)
9583 (setq stats (cond ((equal (match-string 3) "0") 0)
9584 ((match-string 2)
9585 (/ (* (string-to-number (match-string 2)) 100)
9586 (string-to-number (match-string 3))))
9587 (t (string-to-number (match-string 1)))))
9588 (org-back-to-heading t)
9589 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9590 'org-stats stats)))))))
9592 (defun org-refresh-effort-properties ()
9593 "Refresh effort properties"
9594 (org-refresh-properties
9595 org-effort-property
9596 '((effort . identity)
9597 (effort-minutes . org-duration-string-to-minutes))))
9599 ;;;; Link Stuff
9601 ;;; Link abbreviations
9603 (defun org-link-expand-abbrev (link)
9604 "Apply replacements as defined in `org-link-abbrev-alist'."
9605 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9606 (let* ((key (match-string 1 link))
9607 (as (or (assoc key org-link-abbrev-alist-local)
9608 (assoc key org-link-abbrev-alist)))
9609 (tag (and (match-end 2) (match-string 3 link)))
9610 rpl)
9611 (if (not as)
9612 link
9613 (setq rpl (cdr as))
9614 (cond
9615 ((symbolp rpl) (funcall rpl tag))
9616 ((string-match "%(\\([^)]+\\))" rpl)
9617 (replace-match
9618 (save-match-data
9619 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9620 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9621 ((string-match "%h" rpl)
9622 (replace-match (url-hexify-string (or tag "")) t t rpl))
9623 (t (concat rpl tag)))))
9624 link))
9626 ;;; Storing and inserting links
9628 (defvar org-insert-link-history nil
9629 "Minibuffer history for links inserted with `org-insert-link'.")
9631 (defvar org-stored-links nil
9632 "Contains the links stored with `org-store-link'.")
9634 (defvar org-store-link-plist nil
9635 "Plist with info about the most recently link created with `org-store-link'.")
9637 (defvar org-link-protocols nil
9638 "Link protocols added to Org-mode using `org-add-link-type'.")
9640 (defvar org-store-link-functions nil
9641 "List of functions that are called to create and store a link.
9642 Each function will be called in turn until one returns a non-nil
9643 value. Each function should check if it is responsible for creating
9644 this link (for example by looking at the major mode).
9645 If not, it must exit and return nil.
9646 If yes, it should return a non-nil value after a calling
9647 `org-store-link-props' with a list of properties and values.
9648 Special properties are:
9650 :type The link prefix, like \"http\". This must be given.
9651 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9652 This is obligatory as well.
9653 :description Optional default description for the second pair
9654 of brackets in an Org-mode link. The user can still change
9655 this when inserting this link into an Org-mode buffer.
9657 In addition to these, any additional properties can be specified
9658 and then used in capture templates.")
9660 (defun org-add-link-type (type &optional follow export)
9661 "Add TYPE to the list of `org-link-types'.
9662 Re-compute all regular expressions depending on `org-link-types'
9664 FOLLOW and EXPORT are two functions.
9666 FOLLOW should take the link path as the single argument and do whatever
9667 is necessary to follow the link, for example find a file or display
9668 a mail message.
9670 EXPORT should format the link path for export to one of the export formats.
9671 It should be a function accepting three arguments:
9673 path the path of the link, the text after the prefix (like \"http:\")
9674 desc the description of the link, if any
9675 format the export format, a symbol like `html' or `latex' or `ascii'.
9677 The function may use the FORMAT information to return different values
9678 depending on the format. The return value will be put literally into
9679 the exported file. If the return value is nil, this means Org should
9680 do what it normally does with links which do not have EXPORT defined.
9682 Org mode has a built-in default for exporting links. If you are happy with
9683 this default, there is no need to define an export function for the link
9684 type. For a simple example of an export function, see `org-bbdb.el'."
9685 (add-to-list 'org-link-types type t)
9686 (org-make-link-regexps)
9687 (org-element-update-syntax)
9688 (if (assoc type org-link-protocols)
9689 (setcdr (assoc type org-link-protocols) (list follow export))
9690 (push (list type follow export) org-link-protocols)))
9692 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9693 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9695 ;;;###autoload
9696 (defun org-store-link (arg)
9697 "\\<org-mode-map>Store an org-link to the current location.
9698 This link is added to `org-stored-links' and can later be inserted
9699 into an Org buffer with \\[org-insert-link].
9701 For some link types, a prefix ARG is interpreted.
9702 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9703 For file links, ARG negates `org-context-in-file-links'.
9705 A double prefix ARG force skipping storing functions that are not
9706 part of Org's core.
9708 A triple prefix ARG force storing a link for each line in the
9709 active region."
9710 (interactive "P")
9711 (org-load-modules-maybe)
9712 (if (and (equal arg '(64)) (org-region-active-p))
9713 (save-excursion
9714 (let ((end (region-end)))
9715 (goto-char (region-beginning))
9716 (set-mark (point))
9717 (while (< (point-at-eol) end)
9718 (move-end-of-line 1) (activate-mark)
9719 (let (current-prefix-arg)
9720 (call-interactively 'org-store-link))
9721 (move-beginning-of-line 2)
9722 (set-mark (point)))))
9723 (org-with-limited-levels
9724 (setq org-store-link-plist nil)
9725 (let (link cpltxt desc description search
9726 txt custom-id agenda-link sfuns sfunsn)
9727 (cond
9729 ;; Store a link using an external link type
9730 ((and (not (equal arg '(16)))
9731 (setq sfuns
9732 (delq
9733 nil (mapcar (lambda (f)
9734 (let (fs) (if (funcall f) (push f fs))))
9735 org-store-link-functions))
9736 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9737 (or (and (cdr sfuns)
9738 (funcall (intern
9739 (completing-read
9740 "Which function for creating the link? "
9741 sfunsn nil t (car sfunsn)))))
9742 (funcall (caar sfuns)))
9743 (setq link (plist-get org-store-link-plist :link)
9744 desc (or (plist-get org-store-link-plist
9745 :description)
9746 link))))
9748 ;; Store a link from a source code buffer.
9749 ((org-src-edit-buffer-p)
9750 (cond
9751 ((save-excursion
9752 (beginning-of-line)
9753 (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
9754 "[ \t]*$")))
9755 (setq link (format "(%s)" (org-match-string-no-properties 1))))
9756 ((org-called-interactively-p 'any)
9757 (let (label)
9758 (while (or (not label)
9759 (org-with-wide-buffer
9760 (goto-char (point-min))
9761 (re-search-forward
9762 (regexp-quote (format org-coderef-label-format label))
9763 nil t)))
9764 (when label (message "Label exists already") (sit-for 2))
9765 (setq label (read-string "Code line label: " label)))
9766 (end-of-line)
9767 (setq link (format org-coderef-label-format label))
9768 (let ((gc (- 79 (length link))))
9769 (if (< (current-column) gc) (org-move-to-column gc t)
9770 (insert " ")))
9771 (insert link)
9772 (setq link (concat "(" label ")") desc nil)))
9773 (t (setq link nil))))
9775 ;; We are in the agenda, link to referenced location
9776 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9777 (let ((m (or (get-text-property (point) 'org-hd-marker)
9778 (get-text-property (point) 'org-marker))))
9779 (when m
9780 (org-with-point-at m
9781 (setq agenda-link
9782 (if (org-called-interactively-p 'any)
9783 (call-interactively 'org-store-link)
9784 (org-store-link nil)))))))
9786 ((eq major-mode 'calendar-mode)
9787 (let ((cd (calendar-cursor-to-date)))
9788 (setq link
9789 (format-time-string
9790 (car org-time-stamp-formats)
9791 (apply 'encode-time
9792 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9793 nil nil nil))))
9794 (org-store-link-props :type "calendar" :date cd)))
9796 ((eq major-mode 'help-mode)
9797 (setq link (concat "help:" (save-excursion
9798 (goto-char (point-min))
9799 (looking-at "^[^ ]+")
9800 (match-string 0))))
9801 (org-store-link-props :type "help"))
9803 ((eq major-mode 'w3-mode)
9804 (setq cpltxt (if (and (buffer-name)
9805 (not (string-match "Untitled" (buffer-name))))
9806 (buffer-name)
9807 (url-view-url t))
9808 link (url-view-url t))
9809 (org-store-link-props :type "w3" :url (url-view-url t)))
9811 ((eq major-mode 'image-mode)
9812 (setq cpltxt (concat "file:"
9813 (abbreviate-file-name buffer-file-name))
9814 link cpltxt)
9815 (org-store-link-props :type "image" :file buffer-file-name))
9817 ;; In dired, store a link to the file of the current line
9818 ((derived-mode-p 'dired-mode)
9819 (let ((file (dired-get-filename nil t)))
9820 (setq file (if file
9821 (abbreviate-file-name
9822 (expand-file-name (dired-get-filename nil t)))
9823 ;; otherwise, no file so use current directory.
9824 default-directory))
9825 (setq cpltxt (concat "file:" file)
9826 link cpltxt)))
9828 ((setq search (run-hook-with-args-until-success
9829 'org-create-file-search-functions))
9830 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9831 "::" search))
9832 (setq cpltxt (or description link)))
9834 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9835 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9836 (cond
9837 ;; Store a link using the target at point
9838 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9839 (setq cpltxt
9840 (concat "file:"
9841 (abbreviate-file-name
9842 (buffer-file-name (buffer-base-buffer)))
9843 "::" (match-string 1))
9844 link cpltxt))
9845 ((and (featurep 'org-id)
9846 (or (eq org-id-link-to-org-use-id t)
9847 (and (org-called-interactively-p 'any)
9848 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9849 (and (eq org-id-link-to-org-use-id
9850 'create-if-interactive-and-no-custom-id)
9851 (not custom-id))))
9852 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9853 ;; Store a link using the ID at point
9854 (setq link (condition-case nil
9855 (prog1 (org-id-store-link)
9856 (setq desc (or (plist-get org-store-link-plist
9857 :description)
9858 "")))
9859 (error
9860 ;; Probably before first headline, link only to file
9861 (concat "file:"
9862 (abbreviate-file-name
9863 (buffer-file-name (buffer-base-buffer))))))))
9865 ;; Just link to current headline
9866 (setq cpltxt (concat "file:"
9867 (abbreviate-file-name
9868 (buffer-file-name (buffer-base-buffer)))))
9869 ;; Add a context search string
9870 (when (org-xor org-context-in-file-links arg)
9871 (let* ((ee (org-element-at-point))
9872 (et (org-element-type ee))
9873 (ev (plist-get (cadr ee) :value))
9874 (ek (plist-get (cadr ee) :key))
9875 (eok (and (stringp ek) (string-match "name" ek))))
9876 (setq txt (cond
9877 ((org-at-heading-p) nil)
9878 ((and (eq et 'keyword) eok) ev)
9879 ((org-region-active-p)
9880 (buffer-substring (region-beginning) (region-end)))))
9881 (when (or (null txt) (string-match "\\S-" txt))
9882 (setq cpltxt
9883 (concat cpltxt "::"
9884 (condition-case nil
9885 (org-make-org-heading-search-string txt)
9886 (error "")))
9887 desc (or (and (eq et 'keyword) eok ev)
9888 (nth 4 (ignore-errors (org-heading-components)))
9889 "NONE")))))
9890 (if (string-match "::\\'" cpltxt)
9891 (setq cpltxt (substring cpltxt 0 -2)))
9892 (setq link cpltxt))))
9894 ((buffer-file-name (buffer-base-buffer))
9895 ;; Just link to this file here.
9896 (setq cpltxt (concat "file:"
9897 (abbreviate-file-name
9898 (buffer-file-name (buffer-base-buffer)))))
9899 ;; Add a context string.
9900 (when (org-xor org-context-in-file-links arg)
9901 (setq txt (if (org-region-active-p)
9902 (buffer-substring (region-beginning) (region-end))
9903 (buffer-substring (point-at-bol) (point-at-eol))))
9904 ;; Only use search option if there is some text.
9905 (when (string-match "\\S-" txt)
9906 (setq cpltxt
9907 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9908 desc "NONE")))
9909 (setq link cpltxt))
9911 ((org-called-interactively-p 'interactive)
9912 (user-error "No method for storing a link from this buffer"))
9914 (t (setq link nil)))
9916 ;; We're done setting link and desc, clean up
9917 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9918 (setq link (or link cpltxt)
9919 desc (or desc cpltxt))
9920 (cond ((equal desc "NONE") (setq desc nil))
9921 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9922 (let ((d0 (match-string 3 desc))
9923 (p0 (match-string 5 desc)))
9924 (setq desc
9925 (replace-regexp-in-string
9926 org-bracket-link-regexp
9927 (concat (or p0 d0)
9928 (if (equal (length (match-string 0 desc))
9929 (length desc)) "*" "")) desc)))))
9931 ;; Return the link
9932 (if (not (and (or (org-called-interactively-p 'any)
9933 executing-kbd-macro)
9934 link))
9935 (or agenda-link (and link (org-make-link-string link desc)))
9936 (push (list link desc) org-stored-links)
9937 (message "Stored: %s" (or desc link))
9938 (when custom-id
9939 (setq link (concat "file:" (abbreviate-file-name
9940 (buffer-file-name)) "::#" custom-id))
9941 (push (list link desc) org-stored-links))
9942 (car org-stored-links))))))
9944 (defun org-store-link-props (&rest plist)
9945 "Store link properties, extract names and addresses."
9946 (let (x adr)
9947 (when (setq x (plist-get plist :from))
9948 (setq adr (mail-extract-address-components x))
9949 (setq plist (plist-put plist :fromname (car adr)))
9950 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9951 (when (setq x (plist-get plist :to))
9952 (setq adr (mail-extract-address-components x))
9953 (setq plist (plist-put plist :toname (car adr)))
9954 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9955 (let ((from (plist-get plist :from))
9956 (to (plist-get plist :to)))
9957 (when (and from to org-from-is-user-regexp)
9958 (setq plist
9959 (plist-put plist :fromto
9960 (if (string-match org-from-is-user-regexp from)
9961 (concat "to %t")
9962 (concat "from %f"))))))
9963 (setq org-store-link-plist plist))
9965 (defun org-add-link-props (&rest plist)
9966 "Add these properties to the link property list."
9967 (let (key value)
9968 (while plist
9969 (setq key (pop plist) value (pop plist))
9970 (setq org-store-link-plist
9971 (plist-put org-store-link-plist key value)))))
9973 (defun org-email-link-description (&optional fmt)
9974 "Return the description part of an email link.
9975 This takes information from `org-store-link-plist' and formats it
9976 according to FMT (default from `org-email-link-description-format')."
9977 (setq fmt (or fmt org-email-link-description-format))
9978 (let* ((p org-store-link-plist)
9979 (to (plist-get p :toaddress))
9980 (from (plist-get p :fromaddress))
9981 (table
9982 (list
9983 (cons "%c" (plist-get p :fromto))
9984 (cons "%F" (plist-get p :from))
9985 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9986 (cons "%T" (plist-get p :to))
9987 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9988 (cons "%s" (plist-get p :subject))
9989 (cons "%d" (plist-get p :date))
9990 (cons "%m" (plist-get p :message-id)))))
9991 (when (string-match "%c" fmt)
9992 ;; Check if the user wrote this message
9993 (if (and org-from-is-user-regexp from to
9994 (save-match-data (string-match org-from-is-user-regexp from)))
9995 (setq fmt (replace-match "to %t" t t fmt))
9996 (setq fmt (replace-match "from %f" t t fmt))))
9997 (org-replace-escapes fmt table)))
9999 (defun org-make-org-heading-search-string (&optional string)
10000 "Make search string for the current headline or STRING."
10001 (let ((s (or string
10002 (and (derived-mode-p 'org-mode)
10003 (save-excursion
10004 (org-back-to-heading t)
10005 (org-element-property :raw-value (org-element-at-point))))))
10006 (lines org-context-in-file-links))
10007 (or string (setq s (concat "*" s))) ; Add * for headlines
10008 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10009 (when (and string (integerp lines) (> lines 0))
10010 (let ((slines (org-split-string s "\n")))
10011 (when (< lines (length slines))
10012 (setq s (mapconcat
10013 'identity
10014 (reverse (nthcdr (- (length slines) lines)
10015 (reverse slines))) "\n")))))
10016 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10018 (defun org-make-link-string (link &optional description)
10019 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10020 (unless (org-string-nw-p link) (error "Empty link"))
10021 (let ((uri (cond ((string-match org-link-types-re link)
10022 (concat (match-string 1 link)
10023 (org-link-escape (substring link (match-end 1)))))
10024 ;; For readability, url-encode internal links only
10025 ;; when absolutely needed (i.e, when they contain
10026 ;; square brackets). File links however, are
10027 ;; encoded since, e.g., spaces are significant.
10028 ((or (file-name-absolute-p link)
10029 (org-string-match-p "\\`\\.\\.?/\\|[][]" link))
10030 (org-link-escape link))
10031 (t link)))
10032 (description
10033 (and (org-string-nw-p description)
10034 ;; Remove brackets from description, as they are fatal.
10035 (replace-regexp-in-string
10036 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10037 (org-trim description)))))
10038 (format "[[%s]%s]"
10040 (if description (format "[%s]" description) ""))))
10042 (defconst org-link-escape-chars
10043 ;;%20 %5B %5D %25
10044 '(?\s ?\[ ?\] ?%)
10045 "List of characters that should be escaped in a link when stored to Org.
10046 This is the list that is used for internal purposes.")
10048 (defconst org-link-escape-chars-browser
10049 ;;%20 %22
10050 '(?\s ?\")
10051 "List of characters to be escaped before handing over to the browser.
10052 If you consider using this constant then you probably want to use
10053 the function `org-link-escape-browser' instead. See there why
10054 this constant is a candidate to be removed once Org drops support
10055 for Emacs 24.1 and 24.2.")
10057 (defun org-link-escape (text &optional table merge)
10058 "Return percent escaped representation of TEXT.
10059 TEXT is a string with the text to escape.
10060 Optional argument TABLE is a list with characters that should be
10061 escaped. When nil, `org-link-escape-chars' is used.
10062 If optional argument MERGE is set, merge TABLE into
10063 `org-link-escape-chars'."
10064 (let ((characters-to-encode
10065 (cond ((null table) org-link-escape-chars)
10066 (merge (append org-link-escape-chars table))
10067 (t table))))
10068 (mapconcat
10069 (lambda (c)
10070 (if (or (memq c characters-to-encode)
10071 (and org-url-hexify-p (or (< c 32) (> c 126))))
10072 (mapconcat (lambda (e) (format "%%%.2X" e))
10073 (or (encode-coding-char c 'utf-8)
10074 (error "Unable to percent escape character: %c" c))
10076 (char-to-string c)))
10077 text "")))
10079 (defun org-link-escape-browser (text)
10080 "Escape some characters before handing over to the browser.
10081 This function is a candidate to be removed together with the
10082 constant `org-link-escape-chars-browser' once Org drops support
10083 for Emacs 24.1 and 24.2. All calls to this function will have to
10084 be replaced with `url-encode-url' which is available since Emacs
10085 24.3.1."
10086 ;; Example with the Org link
10087 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10088 ;; to open the browser with +subject:"Release 8.2" filled into the
10089 ;; query field: In this case the variable TEXT contains the
10090 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10091 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10092 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10093 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10094 (if (fboundp 'url-encode-url)
10095 (url-encode-url text)
10096 (if (org-string-match-p
10097 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10098 text)
10099 (org-link-escape text org-link-escape-chars-browser)
10100 text)))
10102 (defun org-link-unescape (str)
10103 "Unhex hexified Unicode parts in string STR.
10104 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10105 reciprocal of `org-link-escape', which see."
10106 (if (org-string-nw-p str)
10107 (replace-regexp-in-string
10108 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10109 str))
10111 (defun org-link-unescape-compound (hex)
10112 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10113 Note: this function also decodes single byte encodings like
10114 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10115 (save-match-data
10116 (let* ((bytes (cdr (split-string hex "%")))
10117 (ret "")
10118 (eat 0)
10119 (sum 0))
10120 (while bytes
10121 (let* ((val (string-to-number (pop bytes) 16))
10122 (shift-xor
10123 (if (= 0 eat)
10124 (cond
10125 ((>= val 252) (cons 6 252))
10126 ((>= val 248) (cons 5 248))
10127 ((>= val 240) (cons 4 240))
10128 ((>= val 224) (cons 3 224))
10129 ((>= val 192) (cons 2 192))
10130 (t (cons 0 0)))
10131 (cons 6 128))))
10132 (if (>= val 192) (setq eat (car shift-xor)))
10133 (setq val (logxor val (cdr shift-xor)))
10134 (setq sum (+ (lsh sum (car shift-xor)) val))
10135 (if (> eat 0) (setq eat (- eat 1)))
10136 (cond
10137 ((= 0 eat) ;multi byte
10138 (setq ret (concat ret (org-char-to-string sum)))
10139 (setq sum 0))
10140 ((not bytes) ; single byte(s)
10141 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10142 ret)))
10144 (defun org-link-unescape-single-byte-sequence (hex)
10145 "Unhexify hex-encoded single byte character sequences."
10146 (mapconcat (lambda (byte)
10147 (char-to-string (string-to-number byte 16)))
10148 (cdr (split-string hex "%")) ""))
10150 (defun org-xor (a b)
10151 "Exclusive or."
10152 (if a (not b) b))
10154 (defun org-fixup-message-id-for-http (s)
10155 "Replace special characters in a message id, so it can be used in an http query."
10156 (when (string-match "%" s)
10157 (setq s (mapconcat (lambda (c)
10158 (if (eq c ?%)
10159 "%25"
10160 (char-to-string c)))
10161 s "")))
10162 (while (string-match "<" s)
10163 (setq s (replace-match "%3C" t t s)))
10164 (while (string-match ">" s)
10165 (setq s (replace-match "%3E" t t s)))
10166 (while (string-match "@" s)
10167 (setq s (replace-match "%40" t t s)))
10170 (defun org-link-prettify (link)
10171 "Return a human-readable representation of LINK.
10172 The car of LINK must be a raw link.
10173 The cdr of LINK must be either a link description or nil."
10174 (let ((desc (or (cadr link) "<no description>")))
10175 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10176 "<" (car link) ">")))
10178 ;;;###autoload
10179 (defun org-insert-link-global ()
10180 "Insert a link like Org-mode does.
10181 This command can be called in any mode to insert a link in Org-mode syntax."
10182 (interactive)
10183 (org-load-modules-maybe)
10184 (org-run-like-in-org-mode 'org-insert-link))
10186 (defun org-insert-all-links (arg &optional pre post)
10187 "Insert all links in `org-stored-links'.
10188 When a universal prefix, do not delete the links from `org-stored-links'.
10189 When `ARG' is a number, insert the last N link(s).
10190 `PRE' and `POST' are optional arguments to define a string to
10191 prepend or to append."
10192 (interactive "P")
10193 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10194 (links (copy-seq org-stored-links))
10195 (pr (or pre "- "))
10196 (po (or post "\n"))
10197 (cnt 1) l)
10198 (if (null org-stored-links)
10199 (message "No link to insert")
10200 (while (and (or (listp arg) (>= arg cnt))
10201 (setq l (if (listp arg)
10202 (pop links)
10203 (pop org-stored-links))))
10204 (setq cnt (1+ cnt))
10205 (insert pr)
10206 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10207 (insert po)))))
10209 (defun org-insert-last-stored-link (arg)
10210 "Insert the last link stored in `org-stored-links'."
10211 (interactive "p")
10212 (org-insert-all-links arg "" "\n"))
10214 (defun org-link-fontify-links-to-this-file ()
10215 "Fontify links to the current file in `org-stored-links'."
10216 (let ((f (buffer-file-name)) a b)
10217 (setq a (mapcar (lambda(l)
10218 (let ((ll (car l)))
10219 (when (and (string-match "^file:\\(.+\\)::" ll)
10220 (equal f (expand-file-name (match-string 1 ll))))
10221 ll)))
10222 org-stored-links))
10223 (when (featurep 'org-id)
10224 (setq b (mapcar (lambda(l)
10225 (let ((ll (car l)))
10226 (when (and (string-match "^id:\\(.+\\)$" ll)
10227 (equal f (expand-file-name
10228 (or (org-id-find-id-file
10229 (match-string 1 ll)) ""))))
10230 ll)))
10231 org-stored-links)))
10232 (mapcar (lambda(l)
10233 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10234 (delq nil (append a b)))))
10236 (defvar org-link-links-in-this-file nil)
10237 (defun org-insert-link (&optional complete-file link-location default-description)
10238 "Insert a link. At the prompt, enter the link.
10240 Completion can be used to insert any of the link protocol prefixes like
10241 http or ftp in use.
10243 The history can be used to select a link previously stored with
10244 `org-store-link'. When the empty string is entered (i.e. if you just
10245 press RET at the prompt), the link defaults to the most recently
10246 stored link. As SPC triggers completion in the minibuffer, you need to
10247 use M-SPC or C-q SPC to force the insertion of a space character.
10249 You will also be prompted for a description, and if one is given, it will
10250 be displayed in the buffer instead of the link.
10252 If there is already a link at point, this command will allow you to edit link
10253 and description parts.
10255 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10256 be selected using completion. The path to the file will be relative to the
10257 current directory if the file is in the current directory or a subdirectory.
10258 Otherwise, the link will be the absolute path as completed in the minibuffer
10259 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10260 option `org-link-file-path-type'.
10262 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10263 the current directory or below.
10265 With three \\[universal-argument] prefixes, negate the meaning of
10266 `org-keep-stored-link-after-insertion'.
10268 If `org-make-link-description-function' is non-nil, this function will be
10269 called with the link target, and the result will be the default
10270 link description.
10272 If the LINK-LOCATION parameter is non-nil, this value will be
10273 used as the link location instead of reading one interactively.
10275 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10276 be used as the default description."
10277 (interactive "P")
10278 (let* ((wcf (current-window-configuration))
10279 (origbuf (current-buffer))
10280 (region (if (org-region-active-p)
10281 (buffer-substring (region-beginning) (region-end))))
10282 (remove (and region (list (region-beginning) (region-end))))
10283 (desc region)
10284 tmphist ; byte-compile incorrectly complains about this
10285 (link link-location)
10286 (abbrevs org-link-abbrev-alist-local)
10287 entry file all-prefixes auto-desc)
10288 (cond
10289 (link-location) ; specified by arg, just use it.
10290 ((org-in-regexp org-bracket-link-regexp 1)
10291 ;; We do have a link at point, and we are going to edit it.
10292 (setq remove (list (match-beginning 0) (match-end 0)))
10293 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10294 (setq link (read-string "Link: "
10295 (org-link-unescape
10296 (org-match-string-no-properties 1)))))
10297 ((or (org-in-regexp org-angle-link-re)
10298 (org-in-regexp org-plain-link-re))
10299 ;; Convert to bracket link
10300 (setq remove (list (match-beginning 0) (match-end 0))
10301 link (read-string "Link: "
10302 (org-remove-angle-brackets (match-string 0)))))
10303 ((member complete-file '((4) (16)))
10304 ;; Completing read for file names.
10305 (setq link (org-file-complete-link complete-file)))
10307 ;; Read link, with completion for stored links.
10308 (org-link-fontify-links-to-this-file)
10309 (org-switch-to-buffer-other-window "*Org Links*")
10310 (with-current-buffer "*Org Links*"
10311 (erase-buffer)
10312 (insert "Insert a link.
10313 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10314 (when org-stored-links
10315 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10316 (insert (mapconcat 'org-link-prettify
10317 (reverse org-stored-links) "\n")))
10318 (goto-char (point-min)))
10319 (let ((cw (selected-window)))
10320 (select-window (get-buffer-window "*Org Links*" 'visible))
10321 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10322 (unless (pos-visible-in-window-p (point-max))
10323 (org-fit-window-to-buffer))
10324 (and (window-live-p cw) (select-window cw)))
10325 ;; Fake a link history, containing the stored links.
10326 (setq tmphist (append (mapcar 'car org-stored-links)
10327 org-insert-link-history))
10328 (setq all-prefixes (append (mapcar 'car abbrevs)
10329 (mapcar 'car org-link-abbrev-alist)
10330 org-link-types))
10331 (unwind-protect
10332 (progn
10333 (setq link
10334 (org-completing-read
10335 "Link: "
10336 (append
10337 (mapcar (lambda (x) (concat x ":"))
10338 all-prefixes)
10339 (mapcar 'car org-stored-links))
10340 nil nil nil
10341 'tmphist
10342 (caar org-stored-links)))
10343 (if (not (string-match "\\S-" link))
10344 (user-error "No link selected"))
10345 (mapc (lambda(l)
10346 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10347 org-stored-links)
10348 (if (or (member link all-prefixes)
10349 (and (equal ":" (substring link -1))
10350 (member (substring link 0 -1) all-prefixes)
10351 (setq link (substring link 0 -1))))
10352 (setq link (with-current-buffer origbuf
10353 (org-link-try-special-completion link)))))
10354 (set-window-configuration wcf)
10355 (kill-buffer "*Org Links*"))
10356 (setq entry (assoc link org-stored-links))
10357 (or entry (push link org-insert-link-history))
10358 (setq desc (or desc (nth 1 entry)))))
10360 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10361 (not org-keep-stored-link-after-insertion))
10362 (setq org-stored-links (delq (assoc link org-stored-links)
10363 org-stored-links)))
10365 (if (and (string-match org-plain-link-re link)
10366 (not (string-match org-ts-regexp link)))
10367 ;; URL-like link, normalize the use of angular brackets.
10368 (setq link (org-remove-angle-brackets link)))
10370 ;; Check if we are linking to the current file with a search
10371 ;; option If yes, simplify the link by using only the search
10372 ;; option.
10373 (when (and buffer-file-name
10374 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10375 (let* ((path (match-string 1 link))
10376 (case-fold-search nil)
10377 (search (match-string 2 link)))
10378 (save-match-data
10379 (if (equal (file-truename buffer-file-name) (file-truename path))
10380 ;; We are linking to this same file, with a search option
10381 (setq link search)))))
10383 ;; Check if we can/should use a relative path. If yes, simplify the link
10384 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10385 (let* ((type (match-string 1 link))
10386 (path (match-string 2 link))
10387 (origpath path)
10388 (case-fold-search nil))
10389 (cond
10390 ((or (eq org-link-file-path-type 'absolute)
10391 (equal complete-file '(16)))
10392 (setq path (abbreviate-file-name (expand-file-name path))))
10393 ((eq org-link-file-path-type 'noabbrev)
10394 (setq path (expand-file-name path)))
10395 ((eq org-link-file-path-type 'relative)
10396 (setq path (file-relative-name path)))
10398 (save-match-data
10399 (if (string-match (concat "^" (regexp-quote
10400 (expand-file-name
10401 (file-name-as-directory
10402 default-directory))))
10403 (expand-file-name path))
10404 ;; We are linking a file with relative path name.
10405 (setq path (substring (expand-file-name path)
10406 (match-end 0)))
10407 (setq path (abbreviate-file-name (expand-file-name path)))))))
10408 (setq link (concat type path))
10409 (if (equal desc origpath)
10410 (setq desc path))))
10412 (if org-make-link-description-function
10413 (setq desc
10414 (or (condition-case nil
10415 (funcall org-make-link-description-function link desc)
10416 (error (progn (message "Can't get link description from `%s'"
10417 (symbol-name org-make-link-description-function))
10418 (sit-for 2) nil)))
10419 (read-string "Description: " default-description)))
10420 (if default-description (setq desc default-description)
10421 (setq desc (or (and auto-desc desc)
10422 (read-string "Description: " desc)))))
10424 (unless (string-match "\\S-" desc) (setq desc nil))
10425 (if remove (apply 'delete-region remove))
10426 (insert (org-make-link-string link desc))))
10428 (defun org-link-try-special-completion (type)
10429 "If there is completion support for link type TYPE, offer it."
10430 (let ((fun (intern (concat "org-" type "-complete-link"))))
10431 (if (functionp fun)
10432 (funcall fun)
10433 (read-string "Link (no completion support): " (concat type ":")))))
10435 (defun org-file-complete-link (&optional arg)
10436 "Create a file link using completion."
10437 (let ((file (org-iread-file-name "File: "))
10438 (pwd (file-name-as-directory (expand-file-name ".")))
10439 (pwd1 (file-name-as-directory (abbreviate-file-name
10440 (expand-file-name ".")))))
10441 (cond ((equal arg '(16))
10442 (concat "file:"
10443 (abbreviate-file-name (expand-file-name file))))
10444 ((string-match
10445 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10446 (concat "file:" (match-string 1 file)))
10447 ((string-match
10448 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10449 (expand-file-name file))
10450 (concat "file:"
10451 (match-string 1 (expand-file-name file))))
10452 (t (concat "file:" file)))))
10454 (defun org-iread-file-name (&rest args)
10455 "Read-file-name using `ido-mode' speedup if available.
10456 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10457 See `read-file-name' for a description of parameters."
10458 (org-without-partial-completion
10459 (if (and org-completion-use-ido
10460 (fboundp 'ido-read-file-name)
10461 (org-bound-and-true-p ido-mode)
10462 (listp (nth 1 args)))
10463 (let ((ido-enter-matching-directory nil))
10464 (apply #'ido-read-file-name args))
10465 (apply #'read-file-name args))))
10467 (defun org-completing-read (&rest args)
10468 "Completing-read with SPACE being a normal character."
10469 (let ((enable-recursive-minibuffers t)
10470 (minibuffer-local-completion-map
10471 (copy-keymap minibuffer-local-completion-map)))
10472 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10473 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10474 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10475 (apply 'org-icompleting-read args)))
10477 (defun org-completing-read-no-i (&rest args)
10478 (let (org-completion-use-ido org-completion-use-iswitchb)
10479 (apply 'org-completing-read args)))
10481 (defun org-iswitchb-completing-read (prompt choices &rest args)
10482 "Use iswitch as a completing-read replacement to choose from choices.
10483 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10484 from."
10485 (let* ((iswitchb-use-virtual-buffers nil)
10486 (iswitchb-make-buflist-hook
10487 (lambda ()
10488 (setq iswitchb-temp-buflist choices))))
10489 (iswitchb-read-buffer prompt)))
10491 (defun org-icompleting-read (&rest args)
10492 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10493 Should be called like `completing-read'."
10494 (org-without-partial-completion
10495 (if (not (listp (nth 1 args)))
10496 ;; Ido only supports lists as the COLLECTION argument. Use
10497 ;; default completion function when second argument is not
10498 ;; a list.
10499 (apply #'completing-read args)
10500 (let ((ido-enter-matching-directory nil))
10501 (apply (cond ((and org-completion-use-ido
10502 (fboundp 'ido-completing-read)
10503 (org-bound-and-true-p ido-mode))
10504 #'ido-completing-read)
10505 ((and org-completion-use-iswitchb
10506 (org-bound-and-true-p iswitchb-mode))
10507 #'org-iswitchb-completing-read)
10508 (t #'completing-read))
10509 args)))))
10511 ;;; Opening/following a link
10513 (defvar org-link-search-failed nil)
10515 (defvar org-open-link-functions nil
10516 "Hook for functions finding a plain text link.
10517 These functions must take a single argument, the link content.
10518 They will be called for links that look like [[link text][description]]
10519 when LINK TEXT does not have a protocol like \"http:\" and does not look
10520 like a filename (e.g. \"./blue.png\").
10522 These functions will be called *before* Org attempts to resolve the
10523 link by doing text searches in the current buffer - so if you want a
10524 link \"[[target]]\" to still find \"<<target>>\", your function should
10525 handle this as a special case.
10527 When the function does handle the link, it must return a non-nil value.
10528 If it decides that it is not responsible for this link, it must return
10529 nil to indicate that that Org-mode can continue with other options
10530 like exact and fuzzy text search.")
10532 (defun org-next-link (&optional search-backward)
10533 "Move forward to the next link.
10534 If the link is in hidden text, expose it."
10535 (interactive "P")
10536 (when (and org-link-search-failed (eq this-command last-command))
10537 (goto-char (point-min))
10538 (message "Link search wrapped back to beginning of buffer"))
10539 (setq org-link-search-failed nil)
10540 (let* ((pos (point))
10541 (ct (org-context))
10542 (a (assoc :link ct))
10543 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10544 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10545 ((looking-at org-any-link-re)
10546 ;; Don't stay stuck at link without an org-link face
10547 (forward-char (if search-backward -1 1))))
10548 (if (funcall srch-fun org-any-link-re nil t)
10549 (progn
10550 (goto-char (match-beginning 0))
10551 (if (outline-invisible-p) (org-show-context)))
10552 (goto-char pos)
10553 (setq org-link-search-failed t)
10554 (message "No further link found"))))
10556 (defun org-previous-link ()
10557 "Move backward to the previous link.
10558 If the link is in hidden text, expose it."
10559 (interactive)
10560 (funcall 'org-next-link t))
10562 (defun org-translate-link (s)
10563 "Translate a link string if a translation function has been defined."
10564 (with-temp-buffer
10565 (insert (org-trim s))
10566 (org-trim (org-element-interpret-data (org-element-context)))))
10568 (defun org-translate-link-from-planner (type path)
10569 "Translate a link from Emacs Planner syntax so that Org can follow it.
10570 This is still an experimental function, your mileage may vary."
10571 (cond
10572 ((member type '("http" "https" "news" "ftp"))
10573 ;; standard Internet links are the same.
10574 nil)
10575 ((and (equal type "irc") (string-match "^//" path))
10576 ;; Planner has two / at the beginning of an irc link, we have 1.
10577 ;; We should have zero, actually....
10578 (setq path (substring path 1)))
10579 ((and (equal type "lisp") (string-match "^/" path))
10580 ;; Planner has a slash, we do not.
10581 (setq type "elisp" path (substring path 1)))
10582 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10583 ;; A typical message link. Planner has the id after the final slash,
10584 ;; we separate it with a hash mark
10585 (setq path (concat (match-string 1 path) "#"
10586 (org-remove-angle-brackets (match-string 2 path))))))
10587 (cons type path))
10589 (defun org-find-file-at-mouse (ev)
10590 "Open file link or URL at mouse."
10591 (interactive "e")
10592 (mouse-set-point ev)
10593 (org-open-at-point 'in-emacs))
10595 (defun org-open-at-mouse (ev)
10596 "Open file link or URL at mouse.
10597 See the docstring of `org-open-file' for details."
10598 (interactive "e")
10599 (mouse-set-point ev)
10600 (if (eq major-mode 'org-agenda-mode)
10601 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10602 (org-open-at-point))
10604 (defvar org-window-config-before-follow-link nil
10605 "The window configuration before following a link.
10606 This is saved in case the need arises to restore it.")
10608 ;;;###autoload
10609 (defun org-open-at-point-global ()
10610 "Follow a link like Org-mode does.
10611 This command can be called in any mode to follow a link that has
10612 Org-mode syntax."
10613 (interactive)
10614 (org-run-like-in-org-mode 'org-open-at-point))
10616 ;;;###autoload
10617 (defun org-open-link-from-string (s &optional arg reference-buffer)
10618 "Open a link in the string S, as if it was in Org-mode."
10619 (interactive "sLink: \nP")
10620 (let ((reference-buffer (or reference-buffer (current-buffer))))
10621 (with-temp-buffer
10622 (let ((org-inhibit-startup (not reference-buffer)))
10623 (org-mode)
10624 (insert s)
10625 (goto-char (point-min))
10626 (when reference-buffer
10627 (setq org-link-abbrev-alist-local
10628 (with-current-buffer reference-buffer
10629 org-link-abbrev-alist-local)))
10630 (org-open-at-point arg reference-buffer)))))
10632 (defvar org-open-at-point-functions nil
10633 "Hook that is run when following a link at point.
10635 Functions in this hook must return t if they identify and follow
10636 a link at point. If they don't find anything interesting at point,
10637 they must return nil.")
10639 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10640 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10641 (defun org-open-at-point (&optional arg reference-buffer)
10642 "Open link, timestamp, footnote or tags at point.
10644 When point is on a link, follow it. Normally, files will be
10645 opened by an appropriate application. If the optional prefix
10646 argument ARG is non-nil, Emacs will visit the file. With
10647 a double prefix argument, try to open outside of Emacs, in the
10648 application the system uses for this file type.
10650 When point is on a timestamp, open the agenda at the day
10651 specified.
10653 When point is a footnote definition, move to the first reference
10654 found. If it is on a reference, move to the associated
10655 definition.
10657 When point is on a headline, display a list of every link in the
10658 entry, so it is possible to pick one, or all, of them. If point
10659 is on a tag, call `org-tags-view' instead.
10661 When optional argument REFERENCE-BUFFER is non-nil, it should
10662 specify a buffer from where the link search should happen. This
10663 is used internally by `org-open-link-from-string'.
10665 On top of syntactically correct links, this function will open
10666 the link at point in comments or comment blocks and the first
10667 link in a property drawer line."
10668 (interactive "P")
10669 ;; On a code block, open block's results.
10670 (unless (call-interactively 'org-babel-open-src-block-result)
10671 (org-load-modules-maybe)
10672 (setq org-window-config-before-follow-link (current-window-configuration))
10673 (org-remove-occur-highlights nil nil t)
10674 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10675 (let* ((context
10676 ;; Only consider supported types, even if they are not
10677 ;; the closest one.
10678 (org-element-lineage
10679 (org-element-context)
10680 '(clock comment comment-block footnote-definition
10681 footnote-reference headline inlinetask keyword link
10682 node-property timestamp)
10684 (type (org-element-type context))
10685 (value (org-element-property :value context)))
10686 (cond
10687 ((not context) (user-error "No link found"))
10688 ;; Exception: open timestamps and links in properties
10689 ;; drawers, keywords and comments.
10690 ((memq type '(comment comment-block keyword node-property))
10691 (cond ((org-in-regexp org-any-link-re)
10692 (org-open-link-from-string (match-string-no-properties 0)))
10693 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10694 (org-follow-timestamp-link))
10695 (t (user-error "No link found"))))
10696 ;; On a headline or an inlinetask, but not on a timestamp,
10697 ;; a link, a footnote reference or on tags.
10698 ((and (memq type '(headline inlinetask))
10699 ;; Not on tags.
10700 (progn (save-excursion (beginning-of-line)
10701 (looking-at org-complex-heading-regexp))
10702 (or (not (match-beginning 5))
10703 (< (point) (match-beginning 5)))))
10704 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10705 (links (car data))
10706 (links-end (cdr data)))
10707 (if links
10708 (dolist (link (if (stringp links) (list links) links))
10709 (search-forward link nil links-end)
10710 (goto-char (match-beginning 0))
10711 (org-open-at-point))
10712 (require 'org-attach)
10713 (org-attach-reveal 'if-exists))))
10714 ;; On a clock line, make sure point is on the timestamp
10715 ;; before opening it.
10716 ((and (eq type 'clock)
10717 value
10718 (>= (point) (org-element-property :begin value))
10719 (<= (point) (org-element-property :end value)))
10720 (org-follow-timestamp-link))
10721 ;; Do nothing on white spaces after an object, unless point
10722 ;; is right after it.
10723 ((> (point)
10724 (save-excursion
10725 (goto-char (org-element-property :end context))
10726 (skip-chars-backward " \t")
10727 (point)))
10728 (user-error "No link found"))
10729 ((eq type 'timestamp) (org-follow-timestamp-link))
10730 ;; On tags within a headline or an inlinetask.
10731 ((and (memq type '(headline inlinetask))
10732 (progn (save-excursion (beginning-of-line)
10733 (looking-at org-complex-heading-regexp))
10734 (and (match-beginning 5)
10735 (>= (point) (match-beginning 5)))))
10736 (org-tags-view arg (substring (match-string 5) 0 -1)))
10737 ((eq type 'link)
10738 ;; When link is located within the description of another
10739 ;; link (e.g., an inline image), always open the parent
10740 ;; link.
10741 (let*((link (let ((up (org-element-property :parent context)))
10742 (if (eq (org-element-type up) 'link) up context)))
10743 (type (org-element-property :type link))
10744 (path (org-link-unescape (org-element-property :path link))))
10745 ;; Switch back to REFERENCE-BUFFER needed when called in
10746 ;; a temporary buffer through `org-open-link-from-string'.
10747 (with-current-buffer (or reference-buffer (current-buffer))
10748 (cond
10749 ((equal type "file")
10750 (if (string-match "[*?{]" (file-name-nondirectory path))
10751 (dired path)
10752 ;; Look into `org-link-protocols' in order to find
10753 ;; a DEDICATED-FUNCTION to open file. The function
10754 ;; will be applied on raw link instead of parsed
10755 ;; link due to the limitation in `org-add-link-type'
10756 ;; ("open" function called with a single argument).
10757 ;; If no such function is found, fallback to
10758 ;; `org-open-file'.
10760 ;; Note : "file+emacs" and "file+sys" types are
10761 ;; hard-coded in order to escape the previous
10762 ;; limitation.
10763 (let* ((option (org-element-property :search-option link))
10764 (app (org-element-property :application link))
10765 (dedicated-function
10766 (nth 1 (assoc app org-link-protocols))))
10767 (if dedicated-function
10768 (funcall dedicated-function
10769 (concat path
10770 (and option (concat "::" option))))
10771 (apply #'org-open-file
10772 path
10773 (cond (arg)
10774 ((equal app "emacs") 'emacs)
10775 ((equal app "sys") 'system))
10776 (cond ((not option) nil)
10777 ((org-string-match-p "\\`[0-9]+\\'" option)
10778 (list (string-to-number option)))
10779 (t (list nil
10780 (org-link-unescape option)))))))))
10781 ((assoc type org-link-protocols)
10782 (funcall (nth 1 (assoc type org-link-protocols)) path))
10783 ((equal type "help")
10784 (let ((f-or-v (intern path)))
10785 (cond ((fboundp f-or-v) (describe-function f-or-v))
10786 ((boundp f-or-v) (describe-variable f-or-v))
10787 (t (error "Not a known function or variable")))))
10788 ((member type '("http" "https" "ftp" "mailto" "news"))
10789 (browse-url (org-link-escape-browser (concat type ":" path))))
10790 ((equal type "doi")
10791 (browse-url
10792 (org-link-escape-browser (concat org-doi-server-url path))))
10793 ((equal type "message") (browse-url (concat type ":" path)))
10794 ((equal type "shell")
10795 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10796 (cmd path))
10797 (if (or (and (org-string-nw-p
10798 org-confirm-shell-link-not-regexp)
10799 (string-match
10800 org-confirm-shell-link-not-regexp cmd))
10801 (not org-confirm-shell-link-function)
10802 (funcall org-confirm-shell-link-function
10803 (format "Execute \"%s\" in shell? "
10804 (org-add-props cmd nil
10805 'face 'org-warning))))
10806 (progn
10807 (message "Executing %s" cmd)
10808 (shell-command cmd buf)
10809 (when (featurep 'midnight)
10810 (setq clean-buffer-list-kill-buffer-names
10811 (cons (buffer-name buf)
10812 clean-buffer-list-kill-buffer-names))))
10813 (user-error "Abort"))))
10814 ((equal type "elisp")
10815 (let ((cmd path))
10816 (if (or (and (org-string-nw-p
10817 org-confirm-elisp-link-not-regexp)
10818 (org-string-match-p
10819 org-confirm-elisp-link-not-regexp cmd))
10820 (not org-confirm-elisp-link-function)
10821 (funcall org-confirm-elisp-link-function
10822 (format "Execute \"%s\" as elisp? "
10823 (org-add-props cmd nil
10824 'face 'org-warning))))
10825 (message "%s => %s" cmd
10826 (if (eq (string-to-char cmd) ?\()
10827 (eval (read cmd))
10828 (call-interactively (read cmd))))
10829 (user-error "Abort"))))
10830 ((equal type "id")
10831 (require 'org-id)
10832 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10833 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10834 (unless (run-hook-with-args-until-success
10835 'org-open-link-functions path)
10836 (if (not arg) (org-mark-ring-push)
10837 (switch-to-buffer-other-window
10838 (org-get-buffer-for-internal-link (current-buffer))))
10839 (let ((destination
10840 (org-with-wide-buffer
10841 (if (equal type "radio")
10842 (org-search-radio-target
10843 (org-element-property :path link))
10844 (org-link-search
10845 (if (member type '("custom-id" "coderef"))
10846 (org-element-property :raw-link link)
10847 path)
10848 ;; Prevent fuzzy links from matching
10849 ;; themselves.
10850 (and (equal type "fuzzy")
10851 (+ 2 (org-element-property :begin link)))))
10852 (point))))
10853 (unless (and (<= (point-min) destination)
10854 (>= (point-max) destination))
10855 (widen))
10856 (goto-char destination))))
10857 (t (browse-url-at-point))))))
10858 ;; On a footnote reference or at a footnote definition's label.
10859 ((or (eq type 'footnote-reference)
10860 (and (eq type 'footnote-definition)
10861 (save-excursion
10862 ;; Do not validate action when point is on the
10863 ;; spaces right after the footnote label, in
10864 ;; order to be on par with behaviour on links.
10865 (skip-chars-forward " \t")
10866 (let ((begin
10867 (org-element-property :contents-begin context)))
10868 (if begin (< (point) begin)
10869 (= (org-element-property :post-affiliated context)
10870 (line-beginning-position)))))))
10871 (org-footnote-action))
10872 (t (user-error "No link found")))))
10873 (run-hook-with-args 'org-follow-link-hook)))
10875 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10876 "Offer links in the current entry and return the selected link.
10877 If there is only one link, return it.
10878 If NTH is an integer, return the NTH link found.
10879 If ZERO is a string, check also this string for a link, and if
10880 there is one, return it."
10881 (with-current-buffer buffer
10882 (save-excursion
10883 (save-restriction
10884 (widen)
10885 (goto-char marker)
10886 (let ((cnt ?0)
10887 (in-emacs (if (integerp nth) nil nth))
10888 have-zero end links link c)
10889 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10890 (push (match-string 0 zero) links)
10891 (setq cnt (1- cnt) have-zero t))
10892 (save-excursion
10893 (org-back-to-heading t)
10894 (setq end (save-excursion (outline-next-heading) (point)))
10895 (while (re-search-forward org-any-link-re end t)
10896 (push (match-string 0) links))
10897 (setq links (org-uniquify (reverse links))))
10898 (cond
10899 ((null links)
10900 (message "No links"))
10901 ((equal (length links) 1)
10902 (setq link (car links)))
10903 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10904 (setq link (nth (if have-zero nth (1- nth)) links)))
10905 (t ; we have to select a link
10906 (save-excursion
10907 (save-window-excursion
10908 (delete-other-windows)
10909 (with-output-to-temp-buffer "*Select Link*"
10910 (mapc (lambda (l)
10911 (if (not (string-match org-bracket-link-regexp l))
10912 (princ (format "[%c] %s\n" (incf cnt)
10913 (org-remove-angle-brackets l)))
10914 (if (match-end 3)
10915 (princ (format "[%c] %s (%s)\n" (incf cnt)
10916 (match-string 3 l) (match-string 1 l)))
10917 (princ (format "[%c] %s\n" (incf cnt)
10918 (match-string 1 l))))))
10919 links))
10920 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10921 (message "Select link to open, RET to open all:")
10922 (setq c (read-char-exclusive))
10923 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10924 (when (equal c ?q) (user-error "Abort"))
10925 (if (equal c ?\C-m)
10926 (setq link links)
10927 (setq nth (- c ?0))
10928 (if have-zero (setq nth (1+ nth)))
10929 (unless (and (integerp nth) (>= (length links) nth))
10930 (user-error "Invalid link selection"))
10931 (setq link (nth (1- nth) links)))))
10932 (cons link end))))))
10934 ;; TODO: These functions are deprecated since `org-open-at-point'
10935 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10936 (defun org-open-file-with-system (path)
10937 "Open file at PATH using the system way of opening it."
10938 (org-open-file path 'system))
10939 (defun org-open-file-with-emacs (path)
10940 "Open file at PATH in Emacs."
10941 (org-open-file path 'emacs))
10944 ;;; File search
10946 (defvar org-create-file-search-functions nil
10947 "List of functions to construct the right search string for a file link.
10948 These functions are called in turn with point at the location to
10949 which the link should point.
10951 A function in the hook should first test if it would like to
10952 handle this file type, for example by checking the `major-mode'
10953 or the file extension. If it decides not to handle this file, it
10954 should just return nil to give other functions a chance. If it
10955 does handle the file, it must return the search string to be used
10956 when following the link. The search string will be part of the
10957 file link, given after a double colon, and `org-open-at-point'
10958 will automatically search for it. If special measures must be
10959 taken to make the search successful, another function should be
10960 added to the companion hook `org-execute-file-search-functions',
10961 which see.
10963 A function in this hook may also use `setq' to set the variable
10964 `description' to provide a suggestion for the descriptive text to
10965 be used for this link when it gets inserted into an Org-mode
10966 buffer with \\[org-insert-link].")
10968 (defvar org-execute-file-search-functions nil
10969 "List of functions to execute a file search triggered by a link.
10971 Functions added to this hook must accept a single argument, the
10972 search string that was part of the file link, the part after the
10973 double colon. The function must first check if it would like to
10974 handle this search, for example by checking the `major-mode' or
10975 the file extension. If it decides not to handle this search, it
10976 should just return nil to give other functions a chance. If it
10977 does handle the search, it must return a non-nil value to keep
10978 other functions from trying.
10980 Each function can access the current prefix argument through the
10981 variable `current-prefix-arg'. Note that a single prefix is used
10982 to force opening a link in Emacs, so it may be good to only use a
10983 numeric or double prefix to guide the search function.
10985 In case this is needed, a function in this hook can also restore
10986 the window configuration before `org-open-at-point' was called using:
10988 (set-window-configuration org-window-config-before-follow-link)")
10990 (defun org-search-radio-target (target)
10991 "Search a radio target matching TARGET in current buffer.
10992 White spaces are not significant."
10993 (let ((re (format "<<<%s>>>"
10994 (mapconcat #'regexp-quote
10995 (org-split-string target "[ \t\n]+")
10996 "[ \t]+\\(?:\n[ \t]*\\)?")))
10997 (origin (point)))
10998 (goto-char (point-min))
10999 (catch :radio-match
11000 (while (re-search-forward re nil t)
11001 (backward-char)
11002 (let ((object (org-element-context)))
11003 (when (eq (org-element-type object) 'radio-target)
11004 (goto-char (org-element-property :begin object))
11005 (org-show-context 'link-search)
11006 (throw :radio-match nil))))
11007 (goto-char origin)
11008 (user-error "No match for radio target: %s" target))))
11010 (defun org-link-search (s &optional avoid-pos stealth)
11011 "Search for a search string S.
11013 If S starts with \"#\", it triggers a custom ID search.
11015 If S is enclosed within parenthesis, it initiates a coderef
11016 search.
11018 If S is surrounded by forward slashes, it is interpreted as
11019 a regular expression. In Org mode files, this will create an
11020 `org-occur' sparse tree. In ordinary files, `occur' will be used
11021 to list matches. If the current buffer is in `dired-mode', grep
11022 will be used to search in all files.
11024 When AVOID-POS is given, ignore matches near that position.
11026 When optional argument STEALTH is non-nil, do not modify
11027 visibility around point, thus ignoring `org-show-context-detail'
11028 variable.
11030 Search is case-insensitive and ignores white spaces. Return type
11031 of matched result, with is either `dedicated' or `fuzzy'."
11032 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11033 (let* ((case-fold-search t)
11034 (origin (point))
11035 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11036 (words (org-split-string s "[ \t\n]+"))
11037 (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
11038 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11039 type)
11040 (cond
11041 ;; Check if there are any special search functions.
11042 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11043 ((eq (string-to-char s) ?#)
11044 ;; Look for a custom ID S if S starts with "#".
11045 (let* ((id (substring normalized 1))
11046 (match (org-find-property "CUSTOM_ID" id)))
11047 (if match (progn (goto-char match) (setf type 'dedicated))
11048 (error "No match for custom ID: %s" id))))
11049 ((string-match "\\`(\\(.*\\))\\'" normalized)
11050 ;; Look for coderef targets if S is enclosed within parenthesis.
11051 (let ((coderef (match-string-no-properties 1 normalized))
11052 (re (substring s-single-re 1 -1)))
11053 (goto-char (point-min))
11054 (catch :coderef-match
11055 (while (re-search-forward re nil t)
11056 (let ((element (org-element-at-point)))
11057 (when (and (memq (org-element-type element)
11058 '(example-block src-block))
11059 ;; Build proper regexp according to current
11060 ;; block's label format.
11061 (let ((label-fmt
11062 (regexp-quote
11063 (or (org-element-property :label-fmt element)
11064 org-coderef-label-format))))
11065 (save-excursion
11066 (beginning-of-line)
11067 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11068 (format label-fmt coderef))))))
11069 (setq type 'dedicated)
11070 (goto-char (match-beginning 1))
11071 (throw :coderef-match nil))))
11072 (goto-char origin)
11073 (error "No match for coderef: %s" coderef))))
11074 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11075 ;; Look for a regular expression.
11076 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11077 (match-string 1 s)))
11078 ;; Fuzzy links.
11080 (let* ((starred (eq (string-to-char normalized) ?*))
11081 (headline-search (and (derived-mode-p 'org-mode)
11082 (or org-link-search-must-match-exact-headline
11083 starred))))
11084 (cond
11085 ;; Look for targets, only if not in a headline search.
11086 ((and (not starred)
11087 (let ((target (format "<<%s>>" s-multi-re)))
11088 (catch :target-match
11089 (goto-char (point-min))
11090 (while (re-search-forward target nil t)
11091 (backward-char)
11092 (let ((context (org-element-context)))
11093 (when (eq (org-element-type context) 'target)
11094 (setq type 'dedicated)
11095 (goto-char (org-element-property :begin context))
11096 (throw :target-match t))))
11097 nil))))
11098 ;; Look for elements named after S, only if not in a headline
11099 ;; search.
11100 ((and (not starred)
11101 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11102 (catch :name-match
11103 (goto-char (point-min))
11104 (while (re-search-forward name nil t)
11105 (let ((element (org-element-at-point)))
11106 (when (equal (org-split-string
11107 (org-element-property :name element)
11108 "[ \t]+")
11109 words)
11110 (setq type 'dedicated)
11111 (beginning-of-line)
11112 (throw :name-match t))))
11113 nil))))
11114 ;; Regular text search. Prefer headlines in Org mode
11115 ;; buffers.
11116 ((and (derived-mode-p 'org-mode)
11117 (let* ((wspace "[ \t]")
11118 (wspaceopt (concat wspace "*"))
11119 (cookie (concat "\\(?:"
11120 wspaceopt
11121 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11122 wspaceopt
11123 "\\)"))
11124 (sep (concat "\\(?:\\(?:" wspace "\\|" cookie "\\)+\\)"))
11125 (re (concat
11126 org-outline-regexp-bol
11127 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11128 "\\(?:\\[#.\\][ \t]+\\)?"
11129 "\\(?:" org-comment-string "[ \t]+\\)?"
11130 sep "?"
11131 (let ((title (mapconcat #'regexp-quote
11132 words
11133 sep)))
11134 (if starred (substring title 1) title))
11135 sep "?"
11136 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11137 "[ \t]*$")))
11138 (goto-char (point-min))
11139 (re-search-forward re nil t)))
11140 (goto-char (match-beginning 0))
11141 (setq type 'dedicated))
11142 ;; Offer to create non-existent headline depending on
11143 ;; `org-link-search-must-match-exact-headline'.
11144 ((and (derived-mode-p 'org-mode)
11145 (not org-link-search-inhibit-query)
11146 (eq org-link-search-must-match-exact-headline 'query-to-create)
11147 (yes-or-no-p "No match - create this as a new heading? "))
11148 (goto-char (point-max))
11149 (unless (bolp) (newline))
11150 (org-insert-heading nil t t)
11151 (insert s "\n")
11152 (beginning-of-line 0))
11153 ;; Only headlines are looked after. No need to process
11154 ;; further: throw an error.
11155 ((and (derived-mode-p 'org-mode)
11156 (or starred org-link-search-must-match-exact-headline))
11157 (goto-char origin)
11158 (error "No match for fuzzy expression: %s" normalized))
11159 ;; Regular text search.
11160 ((catch :fuzzy-match
11161 (goto-char (point-min))
11162 (while (re-search-forward s-multi-re nil t)
11163 ;; Skip match if it contains AVOID-POS or it is included
11164 ;; in a link with a description but outside the
11165 ;; description.
11166 (unless (or (and avoid-pos
11167 (<= (match-beginning 0) avoid-pos)
11168 (> (match-end 0) avoid-pos))
11169 (and (save-match-data
11170 (org-in-regexp org-bracket-link-regexp))
11171 (match-beginning 3)
11172 (or (> (match-beginning 3) (point))
11173 (<= (match-end 3) (point)))
11174 (org-element-lineage
11175 (save-match-data (org-element-context))
11176 '(link) t)))
11177 (goto-char (match-beginning 0))
11178 (setq type 'fuzzy)
11179 (throw :fuzzy-match t)))
11180 nil))
11181 ;; All failed. Throw an error.
11182 (t (goto-char origin)
11183 (error "No match for fuzzy expression: %s" normalized))))))
11184 ;; Disclose surroundings of match, if appropriate.
11185 (when (and (derived-mode-p 'org-mode) (not stealth))
11186 (org-show-context 'link-search))
11187 type))
11189 (defun org-get-buffer-for-internal-link (buffer)
11190 "Return a buffer to be used for displaying the link target of internal links."
11191 (cond
11192 ((not org-display-internal-link-with-indirect-buffer)
11193 buffer)
11194 ((string-match "(Clone)$" (buffer-name buffer))
11195 (message "Buffer is already a clone, not making another one")
11196 ;; we also do not modify visibility in this case
11197 buffer)
11198 (t ; make a new indirect buffer for displaying the link
11199 (let* ((bn (buffer-name buffer))
11200 (ibn (concat bn "(Clone)"))
11201 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11202 (with-current-buffer ib (org-overview))
11203 ib))))
11205 (defun org-do-occur (regexp &optional cleanup)
11206 "Call the Emacs command `occur'.
11207 If CLEANUP is non-nil, remove the printout of the regular expression
11208 in the *Occur* buffer. This is useful if the regex is long and not useful
11209 to read."
11210 (occur regexp)
11211 (when cleanup
11212 (let ((cwin (selected-window)) win beg end)
11213 (when (setq win (get-buffer-window "*Occur*"))
11214 (select-window win))
11215 (goto-char (point-min))
11216 (when (re-search-forward "match[a-z]+" nil t)
11217 (setq beg (match-end 0))
11218 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11219 (setq end (1- (match-beginning 0)))))
11220 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11221 (goto-char (point-min))
11222 (select-window cwin))))
11224 ;;; The mark ring for links jumps
11226 (defvar org-mark-ring nil
11227 "Mark ring for positions before jumps in Org-mode.")
11228 (defvar org-mark-ring-last-goto nil
11229 "Last position in the mark ring used to go back.")
11230 ;; Fill and close the ring
11231 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11232 (loop for i from 1 to org-mark-ring-length do
11233 (push (make-marker) org-mark-ring))
11234 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11235 org-mark-ring)
11237 (defun org-mark-ring-push (&optional pos buffer)
11238 "Put the current position or POS into the mark ring and rotate it."
11239 (interactive)
11240 (setq pos (or pos (point)))
11241 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11242 (move-marker (car org-mark-ring)
11243 (or pos (point))
11244 (or buffer (current-buffer)))
11245 (message "%s"
11246 (substitute-command-keys
11247 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11249 (defun org-mark-ring-goto (&optional n)
11250 "Jump to the previous position in the mark ring.
11251 With prefix arg N, jump back that many stored positions. When
11252 called several times in succession, walk through the entire ring.
11253 Org-mode commands jumping to a different position in the current file,
11254 or to another Org-mode file, automatically push the old position
11255 onto the ring."
11256 (interactive "p")
11257 (let (p m)
11258 (if (eq last-command this-command)
11259 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11260 (setq p org-mark-ring))
11261 (setq org-mark-ring-last-goto p)
11262 (setq m (car p))
11263 (org-pop-to-buffer-same-window (marker-buffer m))
11264 (goto-char m)
11265 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11267 (defun org-remove-angle-brackets (s)
11268 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11269 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11271 (defun org-add-angle-brackets (s)
11272 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11273 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11275 (defun org-remove-double-quotes (s)
11276 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11277 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11280 ;;; Following specific links
11282 (defun org-follow-timestamp-link ()
11283 "Open an agenda view for the time-stamp date/range at point."
11284 (cond
11285 ((org-at-date-range-p t)
11286 (let ((org-agenda-start-on-weekday)
11287 (t1 (match-string 1))
11288 (t2 (match-string 2)) tt1 tt2)
11289 (setq tt1 (time-to-days (org-time-string-to-time t1))
11290 tt2 (time-to-days (org-time-string-to-time t2)))
11291 (let ((org-agenda-buffer-tmp-name
11292 (format "*Org Agenda(a:%s)"
11293 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11294 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11295 ((org-at-timestamp-p t)
11296 (let ((org-agenda-buffer-tmp-name
11297 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11298 (org-agenda-list nil (time-to-days (org-time-string-to-time
11299 (substring (match-string 1) 0 10)))
11300 1)))
11301 (t (error "This should not happen"))))
11304 ;;; Following file links
11305 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11306 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11307 (declare-function mailcap-mime-info
11308 "mailcap" (string &optional request no-decode))
11309 (defvar org-wait nil)
11310 (defun org-open-file (path &optional in-emacs line search)
11311 "Open the file at PATH.
11312 First, this expands any special file name abbreviations. Then the
11313 configuration variable `org-file-apps' is checked if it contains an
11314 entry for this file type, and if yes, the corresponding command is launched.
11316 If no application is found, Emacs simply visits the file.
11318 With optional prefix argument IN-EMACS, Emacs will visit the file.
11319 With a double \\[universal-argument] \\[universal-argument] \
11320 prefix arg, Org tries to avoid opening in Emacs
11321 and to use an external application to visit the file.
11323 Optional LINE specifies a line to go to, optional SEARCH a string
11324 to search for. If LINE or SEARCH is given, the file will be
11325 opened in Emacs, unless an entry from org-file-apps that makes
11326 use of groups in a regexp matches.
11328 If you want to change the way frames are used when following a
11329 link, please customize `org-link-frame-setup'.
11331 If the file does not exist, an error is thrown."
11332 (let* ((file (if (equal path "")
11333 buffer-file-name
11334 (substitute-in-file-name (expand-file-name path))))
11335 (file-apps (append org-file-apps (org-default-apps)))
11336 (apps (org-remove-if
11337 'org-file-apps-entry-match-against-dlink-p file-apps))
11338 (apps-dlink (org-remove-if-not
11339 'org-file-apps-entry-match-against-dlink-p file-apps))
11340 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11341 (dirp (if remp nil (file-directory-p file)))
11342 (file (if (and dirp org-open-directory-means-index-dot-org)
11343 (concat (file-name-as-directory file) "index.org")
11344 file))
11345 (a-m-a-p (assq 'auto-mode apps))
11346 (dfile (downcase file))
11347 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11348 (link (cond ((and (eq line nil)
11349 (eq search nil))
11350 file)
11351 (line
11352 (concat file "::" (number-to-string line)))
11353 (search
11354 (concat file "::" search))))
11355 (dlink (downcase link))
11356 (old-buffer (current-buffer))
11357 (old-pos (point))
11358 (old-mode major-mode)
11359 ext cmd link-match-data)
11360 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11361 (setq ext (match-string 1 dfile))
11362 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11363 (setq ext (match-string 1 dfile))))
11364 (cond
11365 ((member in-emacs '((16) system))
11366 (setq cmd (cdr (assoc 'system apps))))
11367 (in-emacs (setq cmd 'emacs))
11369 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11370 (and dirp (cdr (assoc 'directory apps)))
11371 ; first, try matching against apps-dlink
11372 ; if we get a match here, store the match data for later
11373 (let ((match (assoc-default dlink apps-dlink
11374 'string-match)))
11375 (if match
11376 (progn (setq link-match-data (match-data))
11377 match)
11378 (progn (setq in-emacs (or in-emacs line search))
11379 nil))) ; if we have no match in apps-dlink,
11380 ; always open the file in emacs if line or search
11381 ; is given (for backwards compatibility)
11382 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11383 'string-match)
11384 (cdr (assoc ext apps))
11385 (cdr (assoc t apps))))))
11386 (when (eq cmd 'system)
11387 (setq cmd (cdr (assoc 'system apps))))
11388 (when (eq cmd 'default)
11389 (setq cmd (cdr (assoc t apps))))
11390 (when (eq cmd 'mailcap)
11391 (require 'mailcap)
11392 (mailcap-parse-mailcaps)
11393 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11394 (command (mailcap-mime-info mime-type)))
11395 (if (stringp command)
11396 (setq cmd command)
11397 (setq cmd 'emacs))))
11398 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11399 (not (file-exists-p file))
11400 (not org-open-non-existing-files))
11401 (user-error "No such file: %s" file))
11402 (cond
11403 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11404 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11405 (while (string-match "['\"]%s['\"]" cmd)
11406 (setq cmd (replace-match "%s" t t cmd)))
11407 (while (string-match "%s" cmd)
11408 (setq cmd (replace-match
11409 (save-match-data
11410 (shell-quote-argument
11411 (convert-standard-filename file)))
11412 t t cmd)))
11414 ;; Replace "%1", "%2" etc. in command with group matches from regex
11415 (save-match-data
11416 (let ((match-index 1)
11417 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11418 (set-match-data link-match-data)
11419 (while (<= match-index number-of-groups)
11420 (let ((regex (concat "%" (number-to-string match-index)))
11421 (replace-with (match-string match-index dlink)))
11422 (while (string-match regex cmd)
11423 (setq cmd (replace-match replace-with t t cmd))))
11424 (setq match-index (+ match-index 1)))))
11426 (save-window-excursion
11427 (message "Running %s...done" cmd)
11428 (start-process-shell-command cmd nil cmd)
11429 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11430 ((or (stringp cmd)
11431 (eq cmd 'emacs))
11432 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11433 (widen)
11434 (if line (progn (org-goto-line line)
11435 (if (derived-mode-p 'org-mode)
11436 (org-reveal)))
11437 (if search (org-link-search search))))
11438 ((consp cmd)
11439 (let ((file (convert-standard-filename file)))
11440 (save-match-data
11441 (set-match-data link-match-data)
11442 (eval cmd))))
11443 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11444 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11445 (or (not (equal old-buffer (current-buffer)))
11446 (not (equal old-pos (point))))
11447 (org-mark-ring-push old-pos old-buffer))))
11449 (defun org-file-apps-entry-match-against-dlink-p (entry)
11450 "This function returns non-nil if `entry' uses a regular
11451 expression which should be matched against the whole link by
11452 org-open-file.
11454 It assumes that is the case when the entry uses a regular
11455 expression which has at least one grouping construct and the
11456 action is either a lisp form or a command string containing
11457 '%1', i.e. using at least one subexpression match as a
11458 parameter."
11459 (let ((selector (car entry))
11460 (action (cdr entry)))
11461 (if (stringp selector)
11462 (and (> (regexp-opt-depth selector) 0)
11463 (or (and (stringp action)
11464 (string-match "%[0-9]" action))
11465 (consp action)))
11466 nil)))
11468 (defun org-default-apps ()
11469 "Return the default applications for this operating system."
11470 (cond
11471 ((eq system-type 'darwin)
11472 org-file-apps-defaults-macosx)
11473 ((eq system-type 'windows-nt)
11474 org-file-apps-defaults-windowsnt)
11475 (t org-file-apps-defaults-gnu)))
11477 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11478 "Convert extensions to regular expressions in the cars of LIST.
11479 Also, weed out any non-string entries, because the return value is used
11480 only for regexp matching.
11481 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11482 point to the symbol `emacs', indicating that the file should
11483 be opened in Emacs."
11484 (append
11485 (delq nil
11486 (mapcar (lambda (x)
11487 (if (not (stringp (car x)))
11489 (if (string-match "\\W" (car x))
11491 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11492 list))
11493 (if add-auto-mode
11494 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11496 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11497 (defun org-file-remote-p (file)
11498 "Test whether FILE specifies a location on a remote system.
11499 Return non-nil if the location is indeed remote.
11501 For example, the filename \"/user@host:/foo\" specifies a location
11502 on the system \"/user@host:\"."
11503 (cond ((fboundp 'file-remote-p)
11504 (file-remote-p file))
11505 ((fboundp 'tramp-handle-file-remote-p)
11506 (tramp-handle-file-remote-p file))
11507 ((and (boundp 'ange-ftp-name-format)
11508 (string-match (car ange-ftp-name-format) file))
11509 t)))
11512 ;;;; Refiling
11514 (defun org-get-org-file ()
11515 "Read a filename, with default directory `org-directory'."
11516 (let ((default (or org-default-notes-file remember-data-file)))
11517 (read-file-name (format "File name [%s]: " default)
11518 (file-name-as-directory org-directory)
11519 default)))
11521 (defun org-notes-order-reversed-p ()
11522 "Check if the current file should receive notes in reversed order."
11523 (cond
11524 ((not org-reverse-note-order) nil)
11525 ((eq t org-reverse-note-order) t)
11526 ((not (listp org-reverse-note-order)) nil)
11527 (t (catch 'exit
11528 (dolist (entry org-reverse-note-order)
11529 (if (string-match (car entry) buffer-file-name)
11530 (throw 'exit (cdr entry))))))))
11532 (defvar org-refile-target-table nil
11533 "The list of refile targets, created by `org-refile'.")
11535 (defvar org-agenda-new-buffers nil
11536 "Buffers created to visit agenda files.")
11538 (defvar org-refile-cache nil
11539 "Cache for refile targets.")
11541 (defvar org-refile-markers nil
11542 "All the markers used for caching refile locations.")
11544 (defun org-refile-marker (pos)
11545 "Get a new refile marker, but only if caching is in use."
11546 (if (not org-refile-use-cache)
11548 (let ((m (make-marker)))
11549 (move-marker m pos)
11550 (push m org-refile-markers)
11551 m)))
11553 (defun org-refile-cache-clear ()
11554 "Clear the refile cache and disable all the markers."
11555 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11556 (setq org-refile-markers nil)
11557 (setq org-refile-cache nil)
11558 (message "Refile cache has been cleared"))
11560 (defun org-refile-cache-check-set (set)
11561 "Check if all the markers in the cache still have live buffers."
11562 (let (marker)
11563 (catch 'exit
11564 (while (and set (setq marker (nth 3 (pop set))))
11565 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11566 (when (and marker (null (marker-buffer marker)))
11567 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11568 (sit-for 3)
11569 (throw 'exit nil)))
11570 t)))
11572 (defun org-refile-cache-put (set &rest identifiers)
11573 "Push the refile targets SET into the cache, under IDENTIFIERS."
11574 (let* ((key (sha1 (prin1-to-string identifiers)))
11575 (entry (assoc key org-refile-cache)))
11576 (if entry
11577 (setcdr entry set)
11578 (push (cons key set) org-refile-cache))))
11580 (defun org-refile-cache-get (&rest identifiers)
11581 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11582 (cond
11583 ((not org-refile-cache) nil)
11584 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11586 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11587 org-refile-cache))))
11588 (and set (org-refile-cache-check-set set) set)))))
11590 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11591 "Produce a table with refile targets."
11592 (let ((case-fold-search nil)
11593 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11594 (entries (or org-refile-targets '((nil . (:level . 1)))))
11595 targets tgs txt re files desc descre fast-path-p level pos0)
11596 (message "Getting targets...")
11597 (with-current-buffer (or default-buffer (current-buffer))
11598 (dolist (entry entries)
11599 (setq files (car entry) desc (cdr entry))
11600 (setq fast-path-p nil)
11601 (cond
11602 ((null files) (setq files (list (current-buffer))))
11603 ((eq files 'org-agenda-files)
11604 (setq files (org-agenda-files 'unrestricted)))
11605 ((and (symbolp files) (fboundp files))
11606 (setq files (funcall files)))
11607 ((and (symbolp files) (boundp files))
11608 (setq files (symbol-value files))))
11609 (if (stringp files) (setq files (list files)))
11610 (cond
11611 ((eq (car desc) :tag)
11612 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11613 ((eq (car desc) :todo)
11614 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11615 ((eq (car desc) :regexp)
11616 (setq descre (cdr desc)))
11617 ((eq (car desc) :level)
11618 (setq descre (concat "^\\*\\{" (number-to-string
11619 (if org-odd-levels-only
11620 (1- (* 2 (cdr desc)))
11621 (cdr desc)))
11622 "\\}[ \t]")))
11623 ((eq (car desc) :maxlevel)
11624 (setq fast-path-p t)
11625 (setq descre (concat "^\\*\\{1," (number-to-string
11626 (if org-odd-levels-only
11627 (1- (* 2 (cdr desc)))
11628 (cdr desc)))
11629 "\\}[ \t]")))
11630 (t (error "Bad refiling target description %s" desc)))
11631 (dolist (f files)
11632 (with-current-buffer
11633 (if (bufferp f) f (org-get-agenda-file-buffer f))
11635 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11636 (progn
11637 (if (bufferp f) (setq f (buffer-file-name
11638 (buffer-base-buffer f))))
11639 (setq f (and f (expand-file-name f)))
11640 (if (eq org-refile-use-outline-path 'file)
11641 (push (list (file-name-nondirectory f) f nil nil) tgs))
11642 (save-excursion
11643 (save-restriction
11644 (widen)
11645 (goto-char (point-min))
11646 (while (re-search-forward descre nil t)
11647 (goto-char (setq pos0 (point-at-bol)))
11648 (catch 'next
11649 (when org-refile-target-verify-function
11650 (save-match-data
11651 (or (funcall org-refile-target-verify-function)
11652 (throw 'next t))))
11653 (when (and (looking-at org-complex-heading-regexp)
11654 (not (member (match-string 4) excluded-entries))
11655 (match-string 4))
11656 (setq level (org-reduced-level
11657 (- (match-end 1) (match-beginning 1)))
11658 txt (org-link-display-format (match-string 4))
11659 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11660 re (format org-complex-heading-regexp-format
11661 (regexp-quote (match-string 4))))
11662 (when org-refile-use-outline-path
11663 (setq txt (mapconcat
11664 'org-protect-slash
11665 (append
11666 (if (eq org-refile-use-outline-path
11667 'file)
11668 (list (file-name-nondirectory
11669 (buffer-file-name
11670 (buffer-base-buffer))))
11671 (if (eq org-refile-use-outline-path
11672 'full-file-path)
11673 (list (buffer-file-name
11674 (buffer-base-buffer)))))
11675 (org-get-outline-path fast-path-p
11676 level txt)
11677 (list txt))
11678 "/")))
11679 (push (list txt f re (org-refile-marker (point)))
11680 tgs)))
11681 (when (= (point) pos0)
11682 ;; verification function has not moved point
11683 (goto-char (point-at-eol))))))))
11684 (when org-refile-use-cache
11685 (org-refile-cache-put tgs (buffer-file-name) descre))
11686 (setq targets (append tgs targets))))))
11687 (message "Getting targets...done")
11688 (nreverse targets)))
11690 (defun org-protect-slash (s)
11691 (while (string-match "/" s)
11692 (setq s (replace-match "\\" t t s)))
11695 (defvar org-olpa (make-vector 20 nil))
11697 (defun org-get-outline-path (&optional fastp level heading)
11698 "Return the outline path to the current entry, as a list.
11700 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11701 routine which makes outline path derivations for an entire file,
11702 avoiding backtracing. Refile target collection makes use of that."
11703 (if fastp
11704 (progn
11705 (if (> level 19)
11706 (error "Outline path failure, more than 19 levels"))
11707 (loop for i from level upto 19 do
11708 (aset org-olpa i nil))
11709 (prog1
11710 (delq nil (append org-olpa nil))
11711 (aset org-olpa level heading)))
11712 (let (rtn case-fold-search)
11713 (save-excursion
11714 (save-restriction
11715 (widen)
11716 (while (org-up-heading-safe)
11717 (when (looking-at org-complex-heading-regexp)
11718 (push (org-trim
11719 (replace-regexp-in-string
11720 ;; Remove statistical/checkboxes cookies
11721 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11722 (org-match-string-no-properties 4)))
11723 rtn)))
11724 rtn)))))
11726 (defun org-format-outline-path (path &optional width prefix separator)
11727 "Format the outline path PATH for display.
11728 WIDTH is the maximum number of characters that is available.
11729 PREFIX is a prefix to be included in the returned string,
11730 such as the file name.
11731 SEPARATOR is inserted between the different parts of the path,
11732 the default is \"/\"."
11733 (setq width (or width 79))
11734 (if prefix (setq width (- width (length prefix))))
11735 (if (not path)
11736 (or prefix "")
11737 (let* ((nsteps (length path))
11738 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11739 (maxwidth (if (<= total-width width)
11740 10000 ;; everything fits
11741 ;; we need to shorten the level headings
11742 (/ (- width nsteps) nsteps)))
11743 (org-odd-levels-only nil)
11744 (n 0)
11745 (total (1+ (length prefix))))
11746 (setq maxwidth (max maxwidth 10))
11747 (concat prefix
11748 (if prefix (or separator "/"))
11749 (mapconcat
11750 (lambda (h)
11751 (setq n (1+ n))
11752 (if (and (= n nsteps) (< maxwidth 10000))
11753 (setq maxwidth (- total-width total)))
11754 (if (< (length h) maxwidth)
11755 (progn (setq total (+ total (length h) 1)) h)
11756 (setq h (substring h 0 (- maxwidth 2))
11757 total (+ total maxwidth 1))
11758 (if (string-match "[ \t]+\\'" h)
11759 (setq h (substring h 0 (match-beginning 0))))
11760 (setq h (concat h "..")))
11761 (org-add-props h nil 'face
11762 (nth (% (1- n) org-n-level-faces)
11763 org-level-faces))
11765 path (or separator "/"))))))
11767 (defun org-display-outline-path (&optional file current separator just-return-string)
11768 "Display the current outline path in the echo area.
11770 If FILE is non-nil, prepend the output with the file name.
11771 If CURRENT is non-nil, append the current heading to the output.
11772 SEPARATOR is passed through to `org-format-outline-path'. It separates
11773 the different parts of the path and defaults to \"/\".
11774 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11775 (interactive "P")
11776 (let* (case-fold-search
11777 (bfn (buffer-file-name (buffer-base-buffer)))
11778 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11779 res)
11780 (if current (setq path (append path
11781 (save-excursion
11782 (org-back-to-heading t)
11783 (if (looking-at org-complex-heading-regexp)
11784 (list (match-string 4)))))))
11785 (setq res
11786 (org-format-outline-path
11787 path
11788 (1- (frame-width))
11789 (and file bfn (concat (file-name-nondirectory bfn) separator))
11790 separator))
11791 (if just-return-string
11792 (org-no-properties res)
11793 (org-unlogged-message "%s" res))))
11795 (defvar org-refile-history nil
11796 "History for refiling operations.")
11798 (defvar org-after-refile-insert-hook nil
11799 "Hook run after `org-refile' has inserted its stuff at the new location.
11800 Note that this is still *before* the stuff will be removed from
11801 the *old* location.")
11803 (defvar org-capture-last-stored-marker)
11804 (defvar org-refile-keep nil
11805 "Non-nil means `org-refile' will copy instead of refile.")
11807 (defun org-copy ()
11808 "Like `org-refile', but copy."
11809 (interactive)
11810 (let ((org-refile-keep t))
11811 (funcall 'org-refile nil nil nil "Copy")))
11813 (defun org-refile (&optional arg default-buffer rfloc msg)
11814 "Move the entry or entries at point to another heading.
11815 The list of target headings is compiled using the information in
11816 `org-refile-targets', which see.
11818 At the target location, the entry is filed as a subitem of the
11819 target heading. Depending on `org-reverse-note-order', the new
11820 subitem will either be the first or the last subitem.
11822 If there is an active region, all entries in that region will be
11823 refiled. However, the region must fulfill the requirement that
11824 the first heading sets the top-level of the moved text.
11826 With prefix arg ARG, the command will only visit the target
11827 location and not actually move anything.
11829 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11830 refiling operation has put the subtree.
11832 With a numeric prefix argument of `2', refile to the running clock.
11834 With a numeric prefix argument of `3', emulate `org-refile-keep'
11835 being set to t and copy to the target location, don't move it.
11836 Beware that keeping refiled entries may result in duplicated ID
11837 properties.
11839 RFLOC can be a refile location obtained in a different way.
11841 MSG is a string to replace \"Refile\" in the default prompt with
11842 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11844 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11846 If you are using target caching (see `org-refile-use-cache'), you
11847 have to clear the target cache in order to find new targets.
11848 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11849 prefix argument (`C-u C-u C-u C-c C-w')."
11850 (interactive "P")
11851 (if (member arg '(0 (64)))
11852 (org-refile-cache-clear)
11853 (let* ((actionmsg (cond (msg msg)
11854 ((equal arg 3) "Refile (and keep)")
11855 (t "Refile")))
11856 (cbuf (current-buffer))
11857 (regionp (org-region-active-p))
11858 (region-start (and regionp (region-beginning)))
11859 (region-end (and regionp (region-end)))
11860 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11861 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11862 pos it nbuf file re level reversed)
11863 (setq last-command nil)
11864 (when regionp
11865 (goto-char region-start)
11866 (or (bolp) (goto-char (point-at-bol)))
11867 (setq region-start (point))
11868 (unless (or (org-kill-is-subtree-p
11869 (buffer-substring region-start region-end))
11870 (prog1 org-refile-active-region-within-subtree
11871 (let ((s (point-at-eol)))
11872 (org-toggle-heading)
11873 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11874 (user-error "The region is not a (sequence of) subtree(s)")))
11875 (if (equal arg '(16))
11876 (org-refile-goto-last-stored)
11877 (when (or
11878 (and (equal arg 2)
11879 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11880 (prog1
11881 (setq it (list (or org-clock-heading "running clock")
11882 (buffer-file-name
11883 (marker-buffer org-clock-hd-marker))
11885 (marker-position org-clock-hd-marker)))
11886 (setq arg nil)))
11887 (setq it (or rfloc
11888 (let (heading-text)
11889 (save-excursion
11890 (unless (and arg (listp arg))
11891 (org-back-to-heading t)
11892 (setq heading-text
11893 (replace-regexp-in-string
11894 org-bracket-link-regexp
11895 "\\3"
11896 (nth 4 (org-heading-components)))))
11897 (org-refile-get-location
11898 (cond ((and arg (listp arg)) "Goto")
11899 (regionp (concat actionmsg " region to"))
11900 (t (concat actionmsg " subtree \""
11901 heading-text "\" to")))
11902 default-buffer
11903 (and (not (equal '(4) arg))
11904 org-refile-allow-creating-parent-nodes)
11905 arg))))))
11906 (setq file (nth 1 it)
11907 re (nth 2 it)
11908 pos (nth 3 it))
11909 (if (and (not arg)
11911 (equal (buffer-file-name) file)
11912 (if regionp
11913 (and (>= pos region-start)
11914 (<= pos region-end))
11915 (and (>= pos (point))
11916 (< pos (save-excursion
11917 (org-end-of-subtree t t))))))
11918 (error "Cannot refile to position inside the tree or region"))
11919 (setq nbuf (or (find-buffer-visiting file)
11920 (find-file-noselect file)))
11921 (if (and arg (not (equal arg 3)))
11922 (progn
11923 (org-pop-to-buffer-same-window nbuf)
11924 (goto-char pos)
11925 (org-show-context 'org-goto))
11926 (if regionp
11927 (progn
11928 (org-kill-new (buffer-substring region-start region-end))
11929 (org-save-markers-in-region region-start region-end))
11930 (org-copy-subtree 1 nil t))
11931 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11932 (find-file-noselect file)))
11933 (setq reversed (org-notes-order-reversed-p))
11934 (save-excursion
11935 (save-restriction
11936 (widen)
11937 (if pos
11938 (progn
11939 (goto-char pos)
11940 (looking-at org-outline-regexp)
11941 (setq level (org-get-valid-level (funcall outline-level) 1))
11942 (goto-char
11943 (if reversed
11944 (or (outline-next-heading) (point-max))
11945 (or (save-excursion (org-get-next-sibling))
11946 (org-end-of-subtree t t)
11947 (point-max)))))
11948 (setq level 1)
11949 (if (not reversed)
11950 (goto-char (point-max))
11951 (goto-char (point-min))
11952 (or (outline-next-heading) (goto-char (point-max)))))
11953 (if (not (bolp)) (newline))
11954 (org-paste-subtree level nil nil t)
11955 (when org-log-refile
11956 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11957 (unless (eq org-log-refile 'note)
11958 (save-excursion (org-add-log-note))))
11959 (and org-auto-align-tags
11960 (let ((org-loop-over-headlines-in-active-region nil))
11961 (org-set-tags nil t)))
11962 (let ((bookmark-name (plist-get org-bookmark-names-plist
11963 :last-refile)))
11964 (when bookmark-name
11965 (with-demoted-errors
11966 (bookmark-set bookmark-name))))
11967 ;; If we are refiling for capture, make sure that the
11968 ;; last-capture pointers point here
11969 (when (org-bound-and-true-p org-refile-for-capture)
11970 (let ((bookmark-name (plist-get org-bookmark-names-plist
11971 :last-capture-marker)))
11972 (when bookmark-name
11973 (with-demoted-errors
11974 (bookmark-set bookmark-name))))
11975 (move-marker org-capture-last-stored-marker (point)))
11976 (if (fboundp 'deactivate-mark) (deactivate-mark))
11977 (run-hooks 'org-after-refile-insert-hook))))
11978 (unless org-refile-keep
11979 (if regionp
11980 (delete-region (point) (+ (point) (- region-end region-start)))
11981 (delete-region
11982 (and (org-back-to-heading t) (point))
11983 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11984 (when (featurep 'org-inlinetask)
11985 (org-inlinetask-remove-END-maybe))
11986 (setq org-markers-to-move nil)
11987 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11989 (defun org-refile-goto-last-stored ()
11990 "Go to the location where the last refile was stored."
11991 (interactive)
11992 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11993 (message "This is the location of the last refile"))
11995 (defun org-refile--get-location (refloc tbl)
11996 "When user refile to REFLOC, find the associated target in TBL.
11997 Also check `org-refile-target-table'."
11998 (car (delq
12000 (mapcar
12001 (lambda (r) (or (assoc r tbl)
12002 (assoc r org-refile-target-table)))
12003 (list (replace-regexp-in-string "/$" "" refloc)
12004 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12006 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
12007 no-exclude)
12008 "Prompt the user for a refile location, using PROMPT.
12009 PROMPT should not be suffixed with a colon and a space, because
12010 this function appends the default value from
12011 `org-refile-history' automatically, if that is not empty.
12012 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12013 this is used for the GOTO interface."
12014 (let ((org-refile-targets org-refile-targets)
12015 (org-refile-use-outline-path org-refile-use-outline-path)
12016 excluded-entries)
12017 (when (and (derived-mode-p 'org-mode)
12018 (not org-refile-use-cache)
12019 (not no-exclude))
12020 (org-map-tree
12021 (lambda()
12022 (setq excluded-entries
12023 (append excluded-entries (list (org-get-heading t t)))))))
12024 (setq org-refile-target-table
12025 (org-refile-get-targets default-buffer excluded-entries)))
12026 (unless org-refile-target-table
12027 (user-error "No refile targets"))
12028 (let* ((cbuf (current-buffer))
12029 (partial-completion-mode nil)
12030 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12031 (cfunc (if (and org-refile-use-outline-path
12032 org-outline-path-complete-in-steps)
12033 'org-olpath-completing-read
12034 'org-icompleting-read))
12035 (extra (if org-refile-use-outline-path "/" ""))
12036 (cbnex (concat (buffer-name) extra))
12037 (filename (and cfn (expand-file-name cfn)))
12038 (tbl (mapcar
12039 (lambda (x)
12040 (if (and (not (member org-refile-use-outline-path
12041 '(file full-file-path)))
12042 (not (equal filename (nth 1 x))))
12043 (cons (concat (car x) extra " ("
12044 (file-name-nondirectory (nth 1 x)) ")")
12045 (cdr x))
12046 (cons (concat (car x) extra) (cdr x))))
12047 org-refile-target-table))
12048 (completion-ignore-case t)
12049 cdef
12050 (prompt (concat prompt
12051 (or (and (car org-refile-history)
12052 (concat " (default " (car org-refile-history) ")"))
12053 (and (assoc cbnex tbl) (setq cdef cbnex)
12054 (concat " (default " cbnex ")"))) ": "))
12055 pa answ parent-target child parent old-hist)
12056 (setq old-hist org-refile-history)
12057 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12058 nil 'org-refile-history (or cdef (car org-refile-history))))
12059 (if (setq pa (org-refile--get-location answ tbl))
12060 (progn
12061 (org-refile-check-position pa)
12062 (when (or (not org-refile-history)
12063 (not (eq old-hist org-refile-history))
12064 (not (equal (car pa) (car org-refile-history))))
12065 (setq org-refile-history
12066 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12067 org-refile-history
12068 (cdr org-refile-history))))
12069 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12070 (pop org-refile-history)))
12072 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12073 (progn
12074 (setq parent (match-string 1 answ)
12075 child (match-string 2 answ))
12076 (setq parent-target (org-refile--get-location parent tbl))
12077 (when (and parent-target
12078 (or (eq new-nodes t)
12079 (and (eq new-nodes 'confirm)
12080 (y-or-n-p (format "Create new node \"%s\"? "
12081 child)))))
12082 (org-refile-new-child parent-target child)))
12083 (user-error "Invalid target location")))))
12085 (declare-function org-string-nw-p "org-macs" (s))
12086 (defun org-refile-check-position (refile-pointer)
12087 "Check if the refile pointer matches the headline to which it points."
12088 (let* ((file (nth 1 refile-pointer))
12089 (re (nth 2 refile-pointer))
12090 (pos (nth 3 refile-pointer))
12091 buffer)
12092 (if (and (not (markerp pos)) (not file))
12093 (user-error "Please indicate a target file in the refile path")
12094 (when (org-string-nw-p re)
12095 (setq buffer (if (markerp pos)
12096 (marker-buffer pos)
12097 (or (find-buffer-visiting file)
12098 (find-file-noselect file))))
12099 (with-current-buffer buffer
12100 (save-excursion
12101 (save-restriction
12102 (widen)
12103 (goto-char pos)
12104 (beginning-of-line 1)
12105 (unless (org-looking-at-p re)
12106 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12108 (defun org-refile-new-child (parent-target child)
12109 "Use refile target PARENT-TARGET to add new CHILD below it."
12110 (unless parent-target
12111 (error "Cannot find parent for new node"))
12112 (let ((file (nth 1 parent-target))
12113 (pos (nth 3 parent-target))
12114 level)
12115 (with-current-buffer (or (find-buffer-visiting file)
12116 (find-file-noselect file))
12117 (save-excursion
12118 (save-restriction
12119 (widen)
12120 (if pos
12121 (goto-char pos)
12122 (goto-char (point-max))
12123 (if (not (bolp)) (newline)))
12124 (when (looking-at org-outline-regexp)
12125 (setq level (funcall outline-level))
12126 (org-end-of-subtree t t))
12127 (org-back-over-empty-lines)
12128 (insert "\n" (make-string
12129 (if pos (org-get-valid-level level 1) 1) ?*)
12130 " " child "\n")
12131 (beginning-of-line 0)
12132 (list (concat (car parent-target) "/" child) file "" (point)))))))
12134 (defun org-olpath-completing-read (prompt collection &rest args)
12135 "Read an outline path like a file name."
12136 (let ((thetable collection)
12137 (org-completion-use-ido nil) ; does not work with ido.
12138 (org-completion-use-iswitchb nil)) ; or iswitchb
12139 (apply #'org-icompleting-read
12140 prompt
12141 (lambda (string predicate &optional flag)
12142 (cond
12143 ((eq flag nil) (try-completion string thetable))
12144 ((eq flag t)
12145 (let ((l (length string)))
12146 (mapcar (lambda (x)
12147 (let ((r (substring x l))
12148 (f (if (string-match " ([^)]*)$" x)
12149 (match-string 0 x)
12150 "")))
12151 (if (string-match "/" r)
12152 (concat string (substring r 0 (match-end 0)) f)
12153 x)))
12154 (all-completions string thetable predicate))))
12155 ;; Exact match?
12156 ((eq flag 'lambda) (assoc string thetable))))
12157 args)))
12159 ;;;; Dynamic blocks
12161 (defun org-find-dblock (name)
12162 "Find the first dynamic block with name NAME in the buffer.
12163 If not found, stay at current position and return nil."
12164 (let ((case-fold-search t) pos)
12165 (save-excursion
12166 (goto-char (point-min))
12167 (setq pos (and (re-search-forward
12168 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12169 (match-beginning 0))))
12170 (if pos (goto-char pos))
12171 pos))
12173 (defun org-create-dblock (plist)
12174 "Create a dynamic block section, with parameters taken from PLIST.
12175 PLIST must contain a :name entry which is used as the name of the block."
12176 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12177 (end-of-line 1)
12178 (newline))
12179 (let ((col (current-column))
12180 (name (plist-get plist :name)))
12181 (insert "#+BEGIN: " name)
12182 (while plist
12183 (if (eq (car plist) :name)
12184 (setq plist (cddr plist))
12185 (insert " " (prin1-to-string (pop plist)))))
12186 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12187 (beginning-of-line -2)))
12189 (defun org-prepare-dblock ()
12190 "Prepare dynamic block for refresh.
12191 This empties the block, puts the cursor at the insert position and returns
12192 the property list including an extra property :name with the block name."
12193 (unless (looking-at org-dblock-start-re)
12194 (user-error "Not at a dynamic block"))
12195 (let* ((begdel (1+ (match-end 0)))
12196 (name (org-no-properties (match-string 1)))
12197 (params (append (list :name name)
12198 (read (concat "(" (match-string 3) ")")))))
12199 (save-excursion
12200 (beginning-of-line 1)
12201 (skip-chars-forward " \t")
12202 (setq params (plist-put params :indentation-column (current-column))))
12203 (unless (re-search-forward org-dblock-end-re nil t)
12204 (error "Dynamic block not terminated"))
12205 (setq params
12206 (append params
12207 (list :content (buffer-substring
12208 begdel (match-beginning 0)))))
12209 (delete-region begdel (match-beginning 0))
12210 (goto-char begdel)
12211 (open-line 1)
12212 params))
12214 (defun org-map-dblocks (&optional command)
12215 "Apply COMMAND to all dynamic blocks in the current buffer.
12216 If COMMAND is not given, use `org-update-dblock'."
12217 (let ((cmd (or command 'org-update-dblock)))
12218 (save-excursion
12219 (goto-char (point-min))
12220 (while (re-search-forward org-dblock-start-re nil t)
12221 (goto-char (match-beginning 0))
12222 (save-excursion
12223 (condition-case nil
12224 (funcall cmd)
12225 (error (message "Error during update of dynamic block"))))
12226 (unless (re-search-forward org-dblock-end-re nil t)
12227 (error "Dynamic block not terminated"))))))
12229 (defun org-dblock-update (&optional arg)
12230 "User command for updating dynamic blocks.
12231 Update the dynamic block at point. With prefix ARG, update all dynamic
12232 blocks in the buffer."
12233 (interactive "P")
12234 (if arg
12235 (org-update-all-dblocks)
12236 (or (looking-at org-dblock-start-re)
12237 (org-beginning-of-dblock))
12238 (org-update-dblock)))
12240 (defun org-update-dblock ()
12241 "Update the dynamic block at point.
12242 This means to empty the block, parse for parameters and then call
12243 the correct writing function."
12244 (interactive)
12245 (save-excursion
12246 (let* ((win (selected-window))
12247 (pos (point))
12248 (line (org-current-line))
12249 (params (org-prepare-dblock))
12250 (name (plist-get params :name))
12251 (indent (plist-get params :indentation-column))
12252 (cmd (intern (concat "org-dblock-write:" name))))
12253 (message "Updating dynamic block `%s' at line %d..." name line)
12254 (funcall cmd params)
12255 (message "Updating dynamic block `%s' at line %d...done" name line)
12256 (goto-char pos)
12257 (when (and indent (> indent 0))
12258 (setq indent (make-string indent ?\ ))
12259 (save-excursion
12260 (select-window win)
12261 (org-beginning-of-dblock)
12262 (forward-line 1)
12263 (while (not (looking-at org-dblock-end-re))
12264 (insert indent)
12265 (beginning-of-line 2))
12266 (when (looking-at org-dblock-end-re)
12267 (and (looking-at "[ \t]+")
12268 (replace-match ""))
12269 (insert indent)))))))
12271 (defun org-beginning-of-dblock ()
12272 "Find the beginning of the dynamic block at point.
12273 Error if there is no such block at point."
12274 (let ((pos (point))
12275 beg)
12276 (end-of-line 1)
12277 (if (and (re-search-backward org-dblock-start-re nil t)
12278 (setq beg (match-beginning 0))
12279 (re-search-forward org-dblock-end-re nil t)
12280 (> (match-end 0) pos))
12281 (goto-char beg)
12282 (goto-char pos)
12283 (error "Not in a dynamic block"))))
12285 (defun org-update-all-dblocks ()
12286 "Update all dynamic blocks in the buffer.
12287 This function can be used in a hook."
12288 (interactive)
12289 (when (derived-mode-p 'org-mode)
12290 (org-map-dblocks 'org-update-dblock)))
12293 ;;;; Completion
12295 (declare-function org-export-backend-name "org-export" (cl-x))
12296 (declare-function org-export-backend-options "org-export" (cl-x))
12297 (defun org-get-export-keywords ()
12298 "Return a list of all currently understood export keywords.
12299 Export keywords include options, block names, attributes and
12300 keywords relative to each registered export back-end."
12301 (let (keywords)
12302 (dolist (backend
12303 (org-bound-and-true-p org-export-registered-backends)
12304 (delq nil keywords))
12305 ;; Back-end name (for keywords, like #+LATEX:)
12306 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12307 (dolist (option-entry (org-export-backend-options backend))
12308 ;; Back-end options.
12309 (push (nth 1 option-entry) keywords)))))
12311 (defconst org-options-keywords
12312 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12313 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12314 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12315 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12316 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12318 (defcustom org-structure-template-alist
12319 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12320 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12321 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12322 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12323 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12324 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12325 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12326 ("L" "#+LaTeX: ")
12327 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12328 ("H" "#+HTML: ")
12329 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12330 ("A" "#+ASCII: ")
12331 ("i" "#+INDEX: ?")
12332 ("I" "#+INCLUDE: %file ?"))
12333 "Structure completion elements.
12334 This is a list of abbreviation keys and values. The value gets inserted
12335 if you type `<' followed by the key and then press the completion key,
12336 usually `TAB'. %file will be replaced by a file name after prompting
12337 for the file using completion. The cursor will be placed at the position
12338 of the `?' in the template.
12339 There are two templates for each key, the first uses the original Org syntax,
12340 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12341 the default when the /org-mtags.el/ module has been loaded. See also the
12342 variable `org-mtags-prefer-muse-templates'."
12343 :group 'org-completion
12344 :type '(repeat
12345 (list
12346 (string :tag "Key")
12347 (string :tag "Template")))
12348 :version "25.1"
12349 :package-version '(Org . "8.3"))
12351 (defun org-try-structure-completion ()
12352 "Try to complete a structure template before point.
12353 This looks for strings like \"<e\" on an otherwise empty line and
12354 expands them."
12355 (let ((l (buffer-substring (point-at-bol) (point)))
12357 (when (and (looking-at "[ \t]*$")
12358 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12359 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12360 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12361 (match-beginning 1)) a)
12362 t)))
12364 (defun org-complete-expand-structure-template (start cell)
12365 "Expand a structure template."
12366 (let ((rpl (nth 1 cell))
12367 (ind ""))
12368 (delete-region start (point))
12369 (when (string-match "\\`[ \t]*#\\+" rpl)
12370 (cond
12371 ((bolp))
12372 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12373 (setq ind (buffer-substring (point-at-bol) (point))))
12374 (t (newline))))
12375 (setq start (point))
12376 (if (string-match "%file" rpl)
12377 (setq rpl (replace-match
12378 (concat
12379 "\""
12380 (save-match-data
12381 (abbreviate-file-name (read-file-name "Include file: ")))
12382 "\"")
12383 t t rpl)))
12384 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12385 (concat "\n" ind)))
12386 (insert rpl)
12387 (if (re-search-backward "\\?" start t) (delete-char 1))))
12389 ;;;; TODO, DEADLINE, Comments
12391 (defun org-toggle-comment ()
12392 "Change the COMMENT state of an entry."
12393 (interactive)
12394 (save-excursion
12395 (org-back-to-heading)
12396 (looking-at org-complex-heading-regexp)
12397 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12398 (skip-chars-forward " \t")
12399 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12400 (if (org-in-commented-heading-p t)
12401 (delete-region (point)
12402 (progn (search-forward " " (line-end-position) 'move)
12403 (skip-chars-forward " \t")
12404 (point)))
12405 (insert org-comment-string)
12406 (unless (eolp) (insert " ")))))
12408 (defvar org-last-todo-state-is-todo nil
12409 "This is non-nil when the last TODO state change led to a TODO state.
12410 If the last change removed the TODO tag or switched to DONE, then
12411 this is nil.")
12413 (defvar org-setting-tags nil) ; dynamically skipped
12415 (defvar org-todo-setup-filter-hook nil
12416 "Hook for functions that pre-filter todo specs.
12417 Each function takes a todo spec and returns either nil or the spec
12418 transformed into canonical form." )
12420 (defvar org-todo-get-default-hook nil
12421 "Hook for functions that get a default item for todo.
12422 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12423 nil or a string to be used for the todo mark." )
12425 (defvar org-agenda-headline-snapshot-before-repeat)
12427 (defun org-current-effective-time ()
12428 "Return current time adjusted for `org-extend-today-until' variable."
12429 (let* ((ct (org-current-time))
12430 (dct (decode-time ct))
12431 (ct1
12432 (cond
12433 (org-use-last-clock-out-time-as-effective-time
12434 (or (org-clock-get-last-clock-out-time) ct))
12435 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12436 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12437 (t ct))))
12438 ct1))
12440 (defun org-todo-yesterday (&optional arg)
12441 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12442 (interactive "P")
12443 (if (eq major-mode 'org-agenda-mode)
12444 (apply 'org-agenda-todo-yesterday arg)
12445 (let* ((org-use-effective-time t)
12446 (hour (third (decode-time
12447 (org-current-time))))
12448 (org-extend-today-until (1+ hour)))
12449 (org-todo arg))))
12451 (defvar org-block-entry-blocking ""
12452 "First entry preventing the TODO state change.")
12454 (defun org-cancel-repeater ()
12455 "Cancel a repeater by setting its numeric value to zero."
12456 (interactive)
12457 (save-excursion
12458 (org-back-to-heading t)
12459 (let ((bound1 (point))
12460 (bound0 (save-excursion (outline-next-heading) (point))))
12461 (when (re-search-forward
12462 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12463 org-deadline-time-regexp "\\)\\|\\("
12464 org-ts-regexp "\\)")
12465 bound0 t)
12466 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12467 (replace-match "0" t nil nil 1))))))
12469 (defun org-todo (&optional arg)
12470 "Change the TODO state of an item.
12471 The state of an item is given by a keyword at the start of the heading,
12472 like
12473 *** TODO Write paper
12474 *** DONE Call mom
12476 The different keywords are specified in the variable `org-todo-keywords'.
12477 By default the available states are \"TODO\" and \"DONE\".
12478 So for this example: when the item starts with TODO, it is changed to DONE.
12479 When it starts with DONE, the DONE is removed. And when neither TODO nor
12480 DONE are present, add TODO at the beginning of the heading.
12482 With \\[universal-argument] prefix arg, use completion to determine the new \
12483 state.
12484 With numeric prefix arg, switch to that state.
12485 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12486 keywords (nextset).
12487 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12488 With a numeric prefix arg of 0, inhibit note taking for the change.
12489 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12491 When called through ELisp, arg is also interpreted in the following way:
12492 'none -> empty state
12493 \"\"(empty string) -> switch to empty state
12494 'done -> switch to DONE
12495 'nextset -> switch to the next set of keywords
12496 'previousset -> switch to the previous set of keywords
12497 \"WAITING\" -> switch to the specified keyword, but only if it
12498 really is a member of `org-todo-keywords'."
12499 (interactive "P")
12500 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12501 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12502 'region-start-level 'region))
12503 org-loop-over-headlines-in-active-region)
12504 (org-map-entries
12505 `(org-todo ,arg)
12506 org-loop-over-headlines-in-active-region
12507 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12508 (if (equal arg '(16)) (setq arg 'nextset))
12509 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12510 (let ((org-blocker-hook org-blocker-hook)
12511 commentp
12512 case-fold-search)
12513 (when (equal arg '(64))
12514 (setq arg nil org-blocker-hook nil))
12515 (when (and org-blocker-hook
12516 (or org-inhibit-blocking
12517 (org-entry-get nil "NOBLOCKING")))
12518 (setq org-blocker-hook nil))
12519 (save-excursion
12520 (catch 'exit
12521 (org-back-to-heading t)
12522 (when (org-in-commented-heading-p t)
12523 (org-toggle-comment)
12524 (setq commentp t))
12525 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12526 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12527 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12528 (let* ((match-data (match-data))
12529 (startpos (point-at-bol))
12530 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12531 (org-log-done org-log-done)
12532 (org-log-repeat org-log-repeat)
12533 (org-todo-log-states org-todo-log-states)
12534 (org-inhibit-logging
12535 (if (equal arg 0)
12536 (progn (setq arg nil) 'note) org-inhibit-logging))
12537 (this (match-string 1))
12538 (hl-pos (match-beginning 0))
12539 (head (org-get-todo-sequence-head this))
12540 (ass (assoc head org-todo-kwd-alist))
12541 (interpret (nth 1 ass))
12542 (done-word (nth 3 ass))
12543 (final-done-word (nth 4 ass))
12544 (org-last-state (or this ""))
12545 (completion-ignore-case t)
12546 (member (member this org-todo-keywords-1))
12547 (tail (cdr member))
12548 (org-state (cond
12549 ((and org-todo-key-trigger
12550 (or (and (equal arg '(4))
12551 (eq org-use-fast-todo-selection 'prefix))
12552 (and (not arg) org-use-fast-todo-selection
12553 (not (eq org-use-fast-todo-selection
12554 'prefix)))))
12555 ;; Use fast selection
12556 (org-fast-todo-selection))
12557 ((and (equal arg '(4))
12558 (or (not org-use-fast-todo-selection)
12559 (not org-todo-key-trigger)))
12560 ;; Read a state with completion
12561 (org-icompleting-read
12562 "State: " (mapcar 'list org-todo-keywords-1)
12563 nil t))
12564 ((eq arg 'right)
12565 (if this
12566 (if tail (car tail) nil)
12567 (car org-todo-keywords-1)))
12568 ((eq arg 'left)
12569 (if (equal member org-todo-keywords-1)
12571 (if this
12572 (nth (- (length org-todo-keywords-1)
12573 (length tail) 2)
12574 org-todo-keywords-1)
12575 (org-last org-todo-keywords-1))))
12576 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12577 (setq arg nil))) ; hack to fall back to cycling
12578 (arg
12579 ;; user or caller requests a specific state
12580 (cond
12581 ((equal arg "") nil)
12582 ((eq arg 'none) nil)
12583 ((eq arg 'done) (or done-word (car org-done-keywords)))
12584 ((eq arg 'nextset)
12585 (or (car (cdr (member head org-todo-heads)))
12586 (car org-todo-heads)))
12587 ((eq arg 'previousset)
12588 (let ((org-todo-heads (reverse org-todo-heads)))
12589 (or (car (cdr (member head org-todo-heads)))
12590 (car org-todo-heads))))
12591 ((car (member arg org-todo-keywords-1)))
12592 ((stringp arg)
12593 (user-error "State `%s' not valid in this file" arg))
12594 ((nth (1- (prefix-numeric-value arg))
12595 org-todo-keywords-1))))
12596 ((null member) (or head (car org-todo-keywords-1)))
12597 ((equal this final-done-word) nil) ;; -> make empty
12598 ((null tail) nil) ;; -> first entry
12599 ((memq interpret '(type priority))
12600 (if (eq this-command last-command)
12601 (car tail)
12602 (if (> (length tail) 0)
12603 (or done-word (car org-done-keywords))
12604 nil)))
12606 (car tail))))
12607 (org-state (or
12608 (run-hook-with-args-until-success
12609 'org-todo-get-default-hook org-state org-last-state)
12610 org-state))
12611 (next (if org-state (concat " " org-state " ") " "))
12612 (change-plist (list :type 'todo-state-change :from this :to org-state
12613 :position startpos))
12614 dolog now-done-p)
12615 (when org-blocker-hook
12616 (setq org-last-todo-state-is-todo
12617 (not (member this org-done-keywords)))
12618 (unless (save-excursion
12619 (save-match-data
12620 (org-with-wide-buffer
12621 (run-hook-with-args-until-failure
12622 'org-blocker-hook change-plist))))
12623 (if (org-called-interactively-p 'interactive)
12624 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12625 this org-state org-block-entry-blocking)
12626 ;; fail silently
12627 (message "TODO state change from %s to %s blocked (by \"%s\")"
12628 this org-state org-block-entry-blocking)
12629 (throw 'exit nil))))
12630 (store-match-data match-data)
12631 (replace-match next t t)
12632 (cond ((equal this org-state)
12633 (message "TODO state was already %s" (org-trim next)))
12634 ((pos-visible-in-window-p hl-pos)
12635 (message "TODO state changed to %s" (org-trim next))))
12636 (unless head
12637 (setq head (org-get-todo-sequence-head org-state)
12638 ass (assoc head org-todo-kwd-alist)
12639 interpret (nth 1 ass)
12640 done-word (nth 3 ass)
12641 final-done-word (nth 4 ass)))
12642 (when (memq arg '(nextset previousset))
12643 (message "Keyword-Set %d/%d: %s"
12644 (- (length org-todo-sets) -1
12645 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12646 (length org-todo-sets)
12647 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12648 (setq org-last-todo-state-is-todo
12649 (not (member org-state org-done-keywords)))
12650 (setq now-done-p (and (member org-state org-done-keywords)
12651 (not (member this org-done-keywords))))
12652 (and logging (org-local-logging logging))
12653 (when (and (or org-todo-log-states org-log-done)
12654 (not (eq org-inhibit-logging t))
12655 (not (memq arg '(nextset previousset))))
12656 ;; we need to look at recording a time and note
12657 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12658 (nth 2 (assoc this org-todo-log-states))))
12659 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12660 (setq dolog 'time))
12661 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12662 (and org-state
12663 (member org-state org-not-done-keywords)
12664 (not (member this org-not-done-keywords))))
12665 ;; This is now a todo state and was not one before
12666 ;; If there was a CLOSED time stamp, get rid of it.
12667 (org-add-planning-info nil nil 'closed))
12668 (when (and now-done-p org-log-done)
12669 ;; It is now done, and it was not done before
12670 (org-add-planning-info 'closed (org-current-effective-time))
12671 (if (and (not dolog) (eq 'note org-log-done))
12672 (org-add-log-setup 'done org-state this 'findpos 'note)))
12673 (when (and org-state dolog)
12674 ;; This is a non-nil state, and we need to log it
12675 (org-add-log-setup 'state org-state this 'findpos dolog)))
12676 ;; Fixup tag positioning
12677 (org-todo-trigger-tag-changes org-state)
12678 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12679 (when org-provide-todo-statistics
12680 (org-update-parent-todo-statistics))
12681 (run-hooks 'org-after-todo-state-change-hook)
12682 (if (and arg (not (member org-state org-done-keywords)))
12683 (setq head (org-get-todo-sequence-head org-state)))
12684 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12685 ;; Do we need to trigger a repeat?
12686 (when now-done-p
12687 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12688 ;; This is for the agenda, take a snapshot of the headline.
12689 (save-match-data
12690 (setq org-agenda-headline-snapshot-before-repeat
12691 (org-get-heading))))
12692 (org-auto-repeat-maybe org-state))
12693 ;; Fixup cursor location if close to the keyword
12694 (if (and (outline-on-heading-p)
12695 (not (bolp))
12696 (save-excursion (beginning-of-line 1)
12697 (looking-at org-todo-line-regexp))
12698 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12699 (progn
12700 (goto-char (or (match-end 2) (match-end 1)))
12701 (and (looking-at " ") (just-one-space))))
12702 (when org-trigger-hook
12703 (save-excursion
12704 (run-hook-with-args 'org-trigger-hook change-plist)))
12705 (when commentp (org-toggle-comment))))))))
12707 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12708 "Block turning an entry into a TODO, using the hierarchy.
12709 This checks whether the current task should be blocked from state
12710 changes. Such blocking occurs when:
12712 1. The task has children which are not all in a completed state.
12714 2. A task has a parent with the property :ORDERED:, and there
12715 are siblings prior to the current task with incomplete
12716 status.
12718 3. The parent of the task is blocked because it has siblings that should
12719 be done first, or is child of a block grandparent TODO entry."
12721 (if (not org-enforce-todo-dependencies)
12722 t ; if locally turned off don't block
12723 (catch 'dont-block
12724 ;; If this is not a todo state change, or if this entry is already DONE,
12725 ;; do not block
12726 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12727 (member (plist-get change-plist :from)
12728 (cons 'done org-done-keywords))
12729 (member (plist-get change-plist :to)
12730 (cons 'todo org-not-done-keywords))
12731 (not (plist-get change-plist :to)))
12732 (throw 'dont-block t))
12733 ;; If this task has children, and any are undone, it's blocked
12734 (save-excursion
12735 (org-back-to-heading t)
12736 (let ((this-level (funcall outline-level)))
12737 (outline-next-heading)
12738 (let ((child-level (funcall outline-level)))
12739 (while (and (not (eobp))
12740 (> child-level this-level))
12741 ;; this todo has children, check whether they are all
12742 ;; completed
12743 (if (and (not (org-entry-is-done-p))
12744 (org-entry-is-todo-p))
12745 (progn (setq org-block-entry-blocking (org-get-heading))
12746 (throw 'dont-block nil)))
12747 (outline-next-heading)
12748 (setq child-level (funcall outline-level))))))
12749 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12750 ;; any previous siblings are undone, it's blocked
12751 (save-excursion
12752 (org-back-to-heading t)
12753 (let* ((pos (point))
12754 (parent-pos (and (org-up-heading-safe) (point))))
12755 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12756 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12757 (forward-line 1)
12758 (re-search-forward org-not-done-heading-regexp pos t))
12759 (setq org-block-entry-blocking (match-string 0))
12760 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12761 ;; Search further up the hierarchy, to see if an ancestor is blocked
12762 (while t
12763 (goto-char parent-pos)
12764 (if (not (looking-at org-not-done-heading-regexp))
12765 (throw 'dont-block t)) ; do not block, parent is not a TODO
12766 (setq pos (point))
12767 (setq parent-pos (and (org-up-heading-safe) (point)))
12768 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12769 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12770 (forward-line 1)
12771 (re-search-forward org-not-done-heading-regexp pos t)
12772 (setq org-block-entry-blocking (org-get-heading)))
12773 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12775 (defcustom org-track-ordered-property-with-tag nil
12776 "Should the ORDERED property also be shown as a tag?
12777 The ORDERED property decides if an entry should require subtasks to be
12778 completed in sequence. Since a property is not very visible, setting
12779 this option means that toggling the ORDERED property with the command
12780 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12781 not relevant for the behavior, but it makes things more visible.
12783 Note that toggling the tag with tags commands will not change the property
12784 and therefore not influence behavior!
12786 This can be t, meaning the tag ORDERED should be used, It can also be a
12787 string to select a different tag for this task."
12788 :group 'org-todo
12789 :type '(choice
12790 (const :tag "No tracking" nil)
12791 (const :tag "Track with ORDERED tag" t)
12792 (string :tag "Use other tag")))
12794 (defun org-toggle-ordered-property ()
12795 "Toggle the ORDERED property of the current entry.
12796 For better visibility, you can track the value of this property with a tag.
12797 See variable `org-track-ordered-property-with-tag'."
12798 (interactive)
12799 (let* ((t1 org-track-ordered-property-with-tag)
12800 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12801 (save-excursion
12802 (org-back-to-heading)
12803 (if (org-entry-get nil "ORDERED")
12804 (progn
12805 (org-delete-property "ORDERED")
12806 (and tag (org-toggle-tag tag 'off))
12807 (message "Subtasks can be completed in arbitrary order"))
12808 (org-entry-put nil "ORDERED" "t")
12809 (and tag (org-toggle-tag tag 'on))
12810 (message "Subtasks must be completed in sequence")))))
12812 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12813 (defun org-block-todo-from-checkboxes (change-plist)
12814 "Block turning an entry into a TODO, using checkboxes.
12815 This checks whether the current task should be blocked from state
12816 changes because there are unchecked boxes in this entry."
12817 (if (not org-enforce-todo-checkbox-dependencies)
12818 t ; if locally turned off don't block
12819 (catch 'dont-block
12820 ;; If this is not a todo state change, or if this entry is already DONE,
12821 ;; do not block
12822 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12823 (member (plist-get change-plist :from)
12824 (cons 'done org-done-keywords))
12825 (member (plist-get change-plist :to)
12826 (cons 'todo org-not-done-keywords))
12827 (not (plist-get change-plist :to)))
12828 (throw 'dont-block t))
12829 ;; If this task has checkboxes that are not checked, it's blocked
12830 (save-excursion
12831 (org-back-to-heading t)
12832 (let ((beg (point)) end)
12833 (outline-next-heading)
12834 (setq end (point))
12835 (goto-char beg)
12836 (if (org-list-search-forward
12837 (concat (org-item-beginning-re)
12838 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12839 "\\[[- ]\\]")
12840 end t)
12841 (progn
12842 (if (boundp 'org-blocked-by-checkboxes)
12843 (setq org-blocked-by-checkboxes t))
12844 (throw 'dont-block nil)))))
12845 t))) ; do not block
12847 (defun org-entry-blocked-p ()
12848 "Non-nil if entry at point is blocked."
12849 (and (not (org-entry-get nil "NOBLOCKING"))
12850 (member (org-entry-get nil "TODO") org-not-done-keywords)
12851 (not (run-hook-with-args-until-failure
12852 'org-blocker-hook
12853 (list :type 'todo-state-change
12854 :position (point)
12855 :from 'todo
12856 :to 'done)))))
12858 (defun org-update-statistics-cookies (all)
12859 "Update the statistics cookie, either from TODO or from checkboxes.
12860 This should be called with the cursor in a line with a statistics cookie."
12861 (interactive "P")
12862 (if all
12863 (progn
12864 (org-update-checkbox-count 'all)
12865 (org-map-entries 'org-update-parent-todo-statistics))
12866 (if (not (org-at-heading-p))
12867 (org-update-checkbox-count)
12868 (let ((pos (point-marker))
12869 end l1 l2)
12870 (ignore-errors (org-back-to-heading t))
12871 (if (not (org-at-heading-p))
12872 (org-update-checkbox-count)
12873 (setq l1 (org-outline-level))
12874 (setq end (save-excursion
12875 (outline-next-heading)
12876 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12877 (point)))
12878 (if (and (save-excursion
12879 (re-search-forward
12880 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12881 (not (save-excursion (re-search-forward
12882 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12883 (org-update-checkbox-count)
12884 (if (and l2 (> l2 l1))
12885 (progn
12886 (goto-char end)
12887 (org-update-parent-todo-statistics))
12888 (goto-char pos)
12889 (beginning-of-line 1)
12890 (while (re-search-forward
12891 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12892 (point-at-eol) t)
12893 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12894 (goto-char pos)
12895 (move-marker pos nil)))))
12897 (defvar org-entry-property-inherited-from) ;; defined below
12898 (defun org-update-parent-todo-statistics ()
12899 "Update any statistics cookie in the parent of the current headline.
12900 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12901 the entire subtree and this will travel up the hierarchy and update
12902 statistics everywhere."
12903 (let* ((prop (save-excursion (org-up-heading-safe)
12904 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12905 (recursive (or (not org-hierarchical-todo-statistics)
12906 (and prop (string-match "\\<recursive\\>" prop))))
12907 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12909 (first t)
12910 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12911 level ltoggle l1 new ndel
12912 (cnt-all 0) (cnt-done 0) is-percent kwd
12913 checkbox-beg ov ovs ove cookie-present)
12914 (catch 'exit
12915 (save-excursion
12916 (beginning-of-line 1)
12917 (setq ltoggle (funcall outline-level))
12918 ;; Three situations are to consider:
12920 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12921 ;; to the top-level ancestor on the headline;
12923 ;; 2. If parent has "recursive" property, repeat up to the
12924 ;; headline setting that property, taking inheritance into
12925 ;; account;
12927 ;; 3. Else, move up to direct parent and proceed only once.
12928 (while (and (setq level (org-up-heading-safe))
12929 (or recursive first)
12930 (>= (point) lim))
12931 (setq first nil cookie-present nil)
12932 (unless (and level
12933 (not (string-match
12934 "\\<checkbox\\>"
12935 (downcase (or (org-entry-get nil "COOKIE_DATA")
12936 "")))))
12937 (throw 'exit nil))
12938 (while (re-search-forward box-re (point-at-eol) t)
12939 (setq cnt-all 0 cnt-done 0 cookie-present t)
12940 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12941 (save-match-data
12942 (unless (outline-next-heading) (throw 'exit nil))
12943 (while (and (looking-at org-complex-heading-regexp)
12944 (> (setq l1 (length (match-string 1))) level))
12945 (setq kwd (and (or recursive (= l1 ltoggle))
12946 (match-string 2)))
12947 (if (or (eq org-provide-todo-statistics 'all-headlines)
12948 (and (eq org-provide-todo-statistics t)
12949 (or (member kwd org-done-keywords)))
12950 (and (listp org-provide-todo-statistics)
12951 (stringp (car org-provide-todo-statistics))
12952 (or (member kwd org-provide-todo-statistics)
12953 (member kwd org-done-keywords)))
12954 (and (listp org-provide-todo-statistics)
12955 (listp (car org-provide-todo-statistics))
12956 (or (member kwd (car org-provide-todo-statistics))
12957 (and (member kwd org-done-keywords)
12958 (member kwd (cadr org-provide-todo-statistics))))))
12959 (setq cnt-all (1+ cnt-all))
12960 (if (eq org-provide-todo-statistics t)
12961 (and kwd (setq cnt-all (1+ cnt-all)))))
12962 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12963 (member kwd org-done-keywords))
12964 (and (listp org-provide-todo-statistics)
12965 (listp (car org-provide-todo-statistics))
12966 (member kwd org-done-keywords)
12967 (member kwd (cadr org-provide-todo-statistics)))
12968 (and (listp org-provide-todo-statistics)
12969 (stringp (car org-provide-todo-statistics))
12970 (member kwd org-done-keywords)))
12971 (setq cnt-done (1+ cnt-done)))
12972 (outline-next-heading)))
12973 (setq new
12974 (if is-percent
12975 (format "[%d%%]" (floor (* 100.0 cnt-done)
12976 (max 1 cnt-all)))
12977 (format "[%d/%d]" cnt-done cnt-all))
12978 ndel (- (match-end 0) checkbox-beg))
12979 ;; handle overlays when updating cookie from column view
12980 (when (setq ov (car (overlays-at checkbox-beg)))
12981 (setq ovs (overlay-start ov) ove (overlay-end ov))
12982 (delete-overlay ov))
12983 (goto-char checkbox-beg)
12984 (insert new)
12985 (delete-region (point) (+ (point) ndel))
12986 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12987 (when ov (move-overlay ov ovs ove)))
12988 (when cookie-present
12989 (run-hook-with-args 'org-after-todo-statistics-hook
12990 cnt-done (- cnt-all cnt-done))))))
12991 (run-hooks 'org-todo-statistics-hook)))
12993 (defvar org-after-todo-statistics-hook nil
12994 "Hook that is called after a TODO statistics cookie has been updated.
12995 Each function is called with two arguments: the number of not-done entries
12996 and the number of done entries.
12998 For example, the following function, when added to this hook, will switch
12999 an entry to DONE when all children are done, and back to TODO when new
13000 entries are set to a TODO status. Note that this hook is only called
13001 when there is a statistics cookie in the headline!
13003 (defun org-summary-todo (n-done n-not-done)
13004 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13005 (let (org-log-done org-log-states) ; turn off logging
13006 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13009 (defvar org-todo-statistics-hook nil
13010 "Hook that is run whenever Org thinks TODO statistics should be updated.
13011 This hook runs even if there is no statistics cookie present, in which case
13012 `org-after-todo-statistics-hook' would not run.")
13014 (defun org-todo-trigger-tag-changes (state)
13015 "Apply the changes defined in `org-todo-state-tags-triggers'."
13016 (let ((l org-todo-state-tags-triggers)
13017 changes)
13018 (when (or (not state) (equal state ""))
13019 (setq changes (append changes (cdr (assoc "" l)))))
13020 (when (and (stringp state) (> (length state) 0))
13021 (setq changes (append changes (cdr (assoc state l)))))
13022 (when (member state org-not-done-keywords)
13023 (setq changes (append changes (cdr (assoc 'todo l)))))
13024 (when (member state org-done-keywords)
13025 (setq changes (append changes (cdr (assoc 'done l)))))
13026 (dolist (c changes)
13027 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13029 (defun org-local-logging (value)
13030 "Get logging settings from a property VALUE."
13031 ;; Directly set the variables, they are already local.
13032 (setq org-log-done nil
13033 org-log-repeat nil
13034 org-todo-log-states nil)
13035 (dolist (w (org-split-string value))
13036 (let (a)
13037 (cond
13038 ((setq a (assoc w org-startup-options))
13039 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13040 (set (nth 1 a) (nth 2 a))))
13041 ((setq a (org-extract-log-state-settings w))
13042 (and (member (car a) org-todo-keywords-1)
13043 (push a org-todo-log-states)))))))
13045 (defun org-get-todo-sequence-head (kwd)
13046 "Return the head of the TODO sequence to which KWD belongs.
13047 If KWD is not set, check if there is a text property remembering the
13048 right sequence."
13049 (let (p)
13050 (cond
13051 ((not kwd)
13052 (or (get-text-property (point-at-bol) 'org-todo-head)
13053 (progn
13054 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13055 nil (point-at-eol)))
13056 (get-text-property p 'org-todo-head))))
13057 ((not (member kwd org-todo-keywords-1))
13058 (car org-todo-keywords-1))
13059 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13061 (defun org-fast-todo-selection ()
13062 "Fast TODO keyword selection with single keys.
13063 Returns the new TODO keyword, or nil if no state change should occur."
13064 (let* ((fulltable org-todo-key-alist)
13065 (done-keywords org-done-keywords) ;; needed for the faces.
13066 (maxlen (apply 'max (mapcar
13067 (lambda (x)
13068 (if (stringp (car x)) (string-width (car x)) 0))
13069 fulltable)))
13070 (expert nil)
13071 (fwidth (+ maxlen 3 1 3))
13072 (ncol (/ (- (window-width) 4) fwidth))
13073 tg cnt e c tbl
13074 groups ingroup)
13075 (save-excursion
13076 (save-window-excursion
13077 (if expert
13078 (set-buffer (get-buffer-create " *Org todo*"))
13079 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13080 (erase-buffer)
13081 (org-set-local 'org-done-keywords done-keywords)
13082 (setq tbl fulltable cnt 0)
13083 (while (setq e (pop tbl))
13084 (cond
13085 ((equal e '(:startgroup))
13086 (push '() groups) (setq ingroup t)
13087 (when (not (= cnt 0))
13088 (setq cnt 0)
13089 (insert "\n"))
13090 (insert "{ "))
13091 ((equal e '(:endgroup))
13092 (setq ingroup nil cnt 0)
13093 (insert "}\n"))
13094 ((equal e '(:newline))
13095 (when (not (= cnt 0))
13096 (setq cnt 0)
13097 (insert "\n")
13098 (setq e (car tbl))
13099 (while (equal (car tbl) '(:newline))
13100 (insert "\n")
13101 (setq tbl (cdr tbl)))))
13103 (setq tg (car e) c (cdr e))
13104 (if ingroup (push tg (car groups)))
13105 (setq tg (org-add-props tg nil 'face
13106 (org-get-todo-face tg)))
13107 (if (and (= cnt 0) (not ingroup)) (insert " "))
13108 (insert "[" c "] " tg (make-string
13109 (- fwidth 4 (length tg)) ?\ ))
13110 (when (= (setq cnt (1+ cnt)) ncol)
13111 (insert "\n")
13112 (if ingroup (insert " "))
13113 (setq cnt 0)))))
13114 (insert "\n")
13115 (goto-char (point-min))
13116 (if (not expert) (org-fit-window-to-buffer))
13117 (message "[a-z..]:Set [SPC]:clear")
13118 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13119 (cond
13120 ((or (= c ?\C-g)
13121 (and (= c ?q) (not (rassoc c fulltable))))
13122 (setq quit-flag t))
13123 ((= c ?\ ) nil)
13124 ((setq e (rassoc c fulltable) tg (car e))
13126 (t (setq quit-flag t)))))))
13128 (defun org-entry-is-todo-p ()
13129 (member (org-get-todo-state) org-not-done-keywords))
13131 (defun org-entry-is-done-p ()
13132 (member (org-get-todo-state) org-done-keywords))
13134 (defun org-get-todo-state ()
13135 "Return the TODO keyword of the current subtree."
13136 (save-excursion
13137 (org-back-to-heading t)
13138 (and (looking-at org-todo-line-regexp)
13139 (match-end 2)
13140 (match-string 2))))
13142 (defun org-at-date-range-p (&optional inactive-ok)
13143 "Non-nil if point is inside a date range.
13145 When optional argument INACTIVE-OK is non-nil, also consider
13146 inactive time ranges.
13148 When this function returns a non-nil value, match data is set
13149 according to `org-tr-regexp-both' or `org-tr-regexp', depending
13150 on INACTIVE-OK."
13151 (interactive)
13152 (save-excursion
13153 (catch 'exit
13154 (let ((pos (point)))
13155 (skip-chars-backward "^[<\r\n")
13156 (skip-chars-backward "<[")
13157 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13158 (>= (match-end 0) pos)
13159 (throw 'exit t))
13160 (skip-chars-backward "^<[\r\n")
13161 (skip-chars-backward "<[")
13162 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13163 (>= (match-end 0) pos)
13164 (throw 'exit t)))
13165 nil)))
13167 (defun org-get-repeat (&optional tagline)
13168 "Check if there is a deadline/schedule with repeater in this entry."
13169 (save-match-data
13170 (save-excursion
13171 (org-back-to-heading t)
13172 (and (re-search-forward (if tagline
13173 (concat tagline "\\s-*" org-repeat-re)
13174 org-repeat-re)
13175 (org-entry-end-position) t)
13176 (match-string-no-properties 1)))))
13178 (defvar org-last-changed-timestamp)
13179 (defvar org-last-inserted-timestamp)
13180 (defvar org-log-post-message)
13181 (defvar org-log-note-purpose)
13182 (defvar org-log-note-how nil)
13183 (defvar org-log-note-extra)
13184 (defun org-auto-repeat-maybe (done-word)
13185 "Check if the current headline contains a repeated deadline/schedule.
13186 If yes, set TODO state back to what it was and change the base date
13187 of repeating deadline/scheduled time stamps to new date.
13188 This function is run automatically after each state change to a DONE state."
13189 ;; last-state is dynamically scoped into this function
13190 (let* ((repeat (org-get-repeat))
13191 (aa (assoc org-last-state org-todo-kwd-alist))
13192 (interpret (nth 1 aa))
13193 (head (nth 2 aa))
13194 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13195 (msg "Entry repeats: ")
13196 (org-log-done nil)
13197 (org-todo-log-states nil)
13198 re type n what ts time to-state)
13199 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13200 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13201 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13202 org-todo-repeat-to-state))
13203 (unless (and to-state (member to-state org-todo-keywords-1))
13204 (setq to-state (if (eq interpret 'type) org-last-state head)))
13205 (org-todo to-state)
13206 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13207 (org-entry-put nil "LAST_REPEAT" (format-time-string
13208 (org-time-stamp-format t t))))
13209 (when org-log-repeat
13210 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13211 (memq 'org-add-log-note post-command-hook))
13212 ;; OK, we are already setup for some record
13213 (if (eq org-log-repeat 'note)
13214 ;; make sure we take a note, not only a time stamp
13215 (setq org-log-note-how 'note))
13216 ;; Set up for taking a record
13217 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13218 org-last-state
13219 'findpos org-log-repeat)))
13220 (org-back-to-heading t)
13221 (org-add-planning-info nil nil 'closed)
13222 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13223 org-deadline-time-regexp "\\)\\|\\("
13224 org-ts-regexp "\\)"))
13225 (while (re-search-forward
13226 re (save-excursion (outline-next-heading) (point)) t)
13227 (setq type (if (match-end 1) org-scheduled-string
13228 (if (match-end 3) org-deadline-string "Plain:"))
13229 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13230 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13231 (setq n (string-to-number (match-string 2 ts))
13232 what (match-string 3 ts))
13233 (if (equal what "w") (setq n (* n 7) what "d"))
13234 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13235 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13236 ;; Preparation, see if we need to modify the start date for the change
13237 (when (match-end 1)
13238 (setq time (save-match-data (org-time-string-to-time ts)))
13239 (cond
13240 ((equal (match-string 1 ts) ".")
13241 ;; Shift starting date to today
13242 (org-timestamp-change
13243 (- (org-today) (time-to-days time))
13244 'day))
13245 ((equal (match-string 1 ts) "+")
13246 (let ((nshiftmax 10) (nshift 0))
13247 (while (or (= nshift 0)
13248 (<= (time-to-days time)
13249 (time-to-days (current-time))))
13250 (when (= (incf nshift) nshiftmax)
13251 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13252 (user-error "Abort")))
13253 (org-timestamp-change n (cdr (assoc what whata)))
13254 (org-at-timestamp-p t)
13255 (setq ts (match-string 1))
13256 (setq time (save-match-data (org-time-string-to-time ts)))))
13257 (org-timestamp-change (- n) (cdr (assoc what whata)))
13258 ;; rematch, so that we have everything in place for the real shift
13259 (org-at-timestamp-p t)
13260 (setq ts (match-string 1))
13261 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13262 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13263 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13264 (setq org-log-post-message msg)
13265 (message "%s" msg))))
13267 (defun org-show-todo-tree (arg)
13268 "Make a compact tree which shows all headlines marked with TODO.
13269 The tree will show the lines where the regexp matches, and all higher
13270 headlines above the match.
13271 With a \\[universal-argument] prefix, prompt for a regexp to match.
13272 With a numeric prefix N, construct a sparse tree for the Nth element
13273 of `org-todo-keywords-1'."
13274 (interactive "P")
13275 (let ((case-fold-search nil)
13276 (kwd-re
13277 (cond ((null arg) org-not-done-regexp)
13278 ((equal arg '(4))
13279 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13280 (mapcar 'list org-todo-keywords-1))))
13281 (concat "\\("
13282 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13283 "\\)\\>")))
13284 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13285 (regexp-quote (nth (1- (prefix-numeric-value arg))
13286 org-todo-keywords-1)))
13287 (t (user-error "Invalid prefix argument: %s" arg)))))
13288 (message "%d TODO entries found"
13289 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13291 (defun org-deadline (arg &optional time)
13292 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13293 With one universal prefix argument, remove any deadline from the item.
13294 With two universal prefix arguments, prompt for a warning delay.
13295 With argument TIME, set the deadline at the corresponding date. TIME
13296 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13297 (interactive "P")
13298 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13299 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13300 'region-start-level 'region))
13301 org-loop-over-headlines-in-active-region)
13302 (org-map-entries
13303 `(org-deadline ',arg ,time)
13304 org-loop-over-headlines-in-active-region
13305 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13306 (let* ((old-date (org-entry-get nil "DEADLINE"))
13307 (old-date-time (if old-date (org-time-string-to-time old-date)))
13308 (repeater (and old-date
13309 (string-match
13310 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13311 old-date)
13312 (match-string 1 old-date))))
13313 (cond
13314 ((equal arg '(4))
13315 (when (and old-date org-log-redeadline)
13316 (org-add-log-setup 'deldeadline nil old-date 'findpos
13317 org-log-redeadline))
13318 (org-remove-timestamp-with-keyword org-deadline-string)
13319 (message "Item no longer has a deadline."))
13320 ((equal arg '(16))
13321 (save-excursion
13322 (org-back-to-heading t)
13323 (if (re-search-forward
13324 org-deadline-time-regexp
13325 (save-excursion (outline-next-heading) (point)) t)
13326 (let* ((rpl0 (match-string 1))
13327 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13328 (replace-match
13329 (concat org-deadline-string
13330 " <" rpl
13331 (format " -%dd"
13332 (abs
13333 (- (time-to-days
13334 (save-match-data
13335 (org-read-date nil t nil "Warn starting from" old-date-time)))
13336 (time-to-days old-date-time))))
13337 ">") t t))
13338 (user-error "No deadline information to update"))))
13340 (org-add-planning-info 'deadline time 'closed)
13341 (when (and old-date
13342 org-log-redeadline
13343 (not (equal old-date org-last-inserted-timestamp)))
13344 (org-add-log-setup
13345 'redeadline org-last-inserted-timestamp old-date 'findpos
13346 org-log-redeadline))
13347 (when repeater
13348 (save-excursion
13349 (org-back-to-heading t)
13350 (when (re-search-forward (concat org-deadline-string " "
13351 org-last-inserted-timestamp)
13352 (save-excursion
13353 (outline-next-heading) (point)) t)
13354 (goto-char (1- (match-end 0)))
13355 (insert " " repeater)
13356 (setq org-last-inserted-timestamp
13357 (concat (substring org-last-inserted-timestamp 0 -1)
13358 " " repeater
13359 (substring org-last-inserted-timestamp -1))))))
13360 (message "Deadline on %s" org-last-inserted-timestamp))))))
13362 (defun org-schedule (arg &optional time)
13363 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13364 With one universal prefix argument, remove any scheduling date from the item.
13365 With two universal prefix arguments, prompt for a delay cookie.
13366 With argument TIME, scheduled at the corresponding date. TIME can
13367 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13368 (interactive "P")
13369 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13370 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13371 'region-start-level 'region))
13372 org-loop-over-headlines-in-active-region)
13373 (org-map-entries
13374 `(org-schedule ',arg ,time)
13375 org-loop-over-headlines-in-active-region
13376 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13377 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13378 (old-date-time (if old-date (org-time-string-to-time old-date)))
13379 (repeater (and old-date
13380 (string-match
13381 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13382 old-date)
13383 (match-string 1 old-date))))
13384 (cond
13385 ((equal arg '(4))
13386 (progn
13387 (when (and old-date org-log-reschedule)
13388 (org-add-log-setup 'delschedule nil old-date 'findpos
13389 org-log-reschedule))
13390 (org-remove-timestamp-with-keyword org-scheduled-string)
13391 (message "Item is no longer scheduled.")))
13392 ((equal arg '(16))
13393 (save-excursion
13394 (org-back-to-heading t)
13395 (if (re-search-forward
13396 org-scheduled-time-regexp
13397 (save-excursion (outline-next-heading) (point)) t)
13398 (let* ((rpl0 (match-string 1))
13399 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13400 (replace-match
13401 (concat org-scheduled-string
13402 " <" rpl
13403 (format " -%dd"
13404 (abs
13405 (- (time-to-days
13406 (save-match-data
13407 (org-read-date nil t nil "Delay until" old-date-time)))
13408 (time-to-days old-date-time))))
13409 ">") t t))
13410 (user-error "No scheduled information to update"))))
13412 (org-add-planning-info 'scheduled time 'closed)
13413 (when (and old-date
13414 org-log-reschedule
13415 (not (equal old-date org-last-inserted-timestamp)))
13416 (org-add-log-setup
13417 'reschedule org-last-inserted-timestamp old-date 'findpos
13418 org-log-reschedule))
13419 (when repeater
13420 (save-excursion
13421 (org-back-to-heading t)
13422 (when (re-search-forward (concat org-scheduled-string " "
13423 org-last-inserted-timestamp)
13424 (save-excursion
13425 (outline-next-heading) (point)) t)
13426 (goto-char (1- (match-end 0)))
13427 (insert " " repeater)
13428 (setq org-last-inserted-timestamp
13429 (concat (substring org-last-inserted-timestamp 0 -1)
13430 " " repeater
13431 (substring org-last-inserted-timestamp -1))))))
13432 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13434 (defun org-get-scheduled-time (pom &optional inherit)
13435 "Get the scheduled time as a time tuple, of a format suitable
13436 for calling org-schedule with, or if there is no scheduling,
13437 returns nil."
13438 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13439 (when time
13440 (apply 'encode-time (org-parse-time-string time)))))
13442 (defun org-get-deadline-time (pom &optional inherit)
13443 "Get the deadline as a time tuple, of a format suitable for
13444 calling org-deadline with, or if there is no scheduling, returns
13445 nil."
13446 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13447 (when time
13448 (apply 'encode-time (org-parse-time-string time)))))
13450 (defun org-remove-timestamp-with-keyword (keyword)
13451 "Remove all time stamps with KEYWORD in the current entry."
13452 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13453 beg)
13454 (save-excursion
13455 (org-back-to-heading t)
13456 (setq beg (point))
13457 (outline-next-heading)
13458 (while (re-search-backward re beg t)
13459 (replace-match "")
13460 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13461 (equal (char-before) ?\ ))
13462 (backward-delete-char 1)
13463 (if (string-match "^[ \t]*$" (buffer-substring
13464 (point-at-bol) (point-at-eol)))
13465 (delete-region (point-at-bol)
13466 (min (point-max) (1+ (point-at-eol))))))))))
13468 (defvar org-time-was-given) ; dynamically scoped parameter
13469 (defvar org-end-time-was-given) ; dynamically scoped parameter
13471 (defun org-at-planning-p ()
13472 "Non-nil when point is on a planning info line."
13473 ;; This is as accurate and faster than `org-element-at-point' since
13474 ;; planning info location is fixed in the section.
13475 (org-with-wide-buffer
13476 (beginning-of-line)
13477 (and (org-looking-at-p org-planning-line-re)
13478 (eq (point)
13479 (ignore-errors
13480 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13481 (org-back-to-heading t)
13482 (org-with-limited-levels (org-back-to-heading t)))
13483 (line-beginning-position 2))))))
13485 (defun org-add-planning-info (what &optional time &rest remove)
13486 "Insert new timestamp with keyword in the planning line.
13487 WHAT indicates what kind of time stamp to add. It is a symbol
13488 among `closed', `deadline', `scheduled' and nil. TIME indicates
13489 the time to use. If none is given, the user is prompted for
13490 a date. REMOVE indicates what kind of entries to remove. An old
13491 WHAT entry will also be removed."
13492 (let (org-time-was-given org-end-time-was-given default-time default-input)
13493 (catch 'exit
13494 (when (and (memq what '(scheduled deadline))
13495 (or (not time)
13496 (and (stringp time)
13497 (string-match "^[-+]+[0-9]" time))))
13498 ;; Try to get a default date/time from existing timestamp
13499 (save-excursion
13500 (org-back-to-heading t)
13501 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13502 (when (re-search-forward (if (eq what 'scheduled)
13503 org-scheduled-time-regexp
13504 org-deadline-time-regexp)
13505 end t)
13506 (setq ts (match-string 1)
13507 default-time (apply 'encode-time (org-parse-time-string ts))
13508 default-input (and ts (org-get-compact-tod ts)))))))
13509 (when what
13510 (setq time
13511 (if (stringp time)
13512 ;; This is a string (relative or absolute), set
13513 ;; proper date.
13514 (apply #'encode-time
13515 (org-read-date-analyze
13516 time default-time (decode-time default-time)))
13517 ;; If necessary, get the time from the user
13518 (or time (org-read-date nil 'to-time nil nil
13519 default-time default-input)))))
13521 (org-with-wide-buffer
13522 (org-back-to-heading t)
13523 (forward-line)
13524 (unless (bolp) (insert "\n"))
13525 (cond ((org-looking-at-p org-planning-line-re)
13526 ;; Move to current indentation.
13527 (skip-chars-forward " \t")
13528 ;; Check if we have to remove something.
13529 (dolist (type (if what (cons what remove) remove))
13530 (save-excursion
13531 (when (re-search-forward
13532 (concat
13533 " *"
13534 (case type
13535 (closed org-closed-time-regexp)
13536 (deadline org-deadline-time-regexp)
13537 (scheduled org-scheduled-time-regexp)
13538 (otherwise
13539 (error "Invalid planning type: %s" type))))
13540 (line-end-position) t)
13541 (replace-match "")
13542 (when (looking-at "--+<[^>]+>") (replace-match ""))
13543 (when (and (not what) (eq type 'closed))
13544 (save-excursion
13545 (beginning-of-line)
13546 (when (looking-at "[ \t]*$")
13547 (delete-region (point)
13548 (line-beginning-position 2)))))))
13549 ;; Remove leading white spaces.
13550 (when (looking-at "[ \t]+") (replace-match ""))))
13551 ((not what) (throw 'exit nil)) ; Nothing to do.
13552 (t (insert-before-markers "\n")
13553 (backward-char 1)
13554 (when org-adapt-indentation
13555 (org-indent-to-column (1+ (org-outline-level))))))
13556 (when what
13557 ;; Insert planning keyword.
13558 (insert (case what
13559 (closed org-closed-string)
13560 (deadline org-deadline-string)
13561 (scheduled org-scheduled-string)
13562 (otherwise (error "Invalid planning type: %s" what)))
13563 " ")
13564 ;; Insert associated timestamp.
13565 (let ((ts (org-insert-time-stamp
13566 time
13567 (or org-time-was-given
13568 (and (eq what 'closed) org-log-done-with-time))
13569 (eq what 'closed)
13570 nil nil (list org-end-time-was-given))))
13571 (unless (eolp) (insert " "))
13572 ts))))))
13574 (defvar org-log-note-marker (make-marker))
13575 (defvar org-log-note-purpose nil)
13576 (defvar org-log-note-state nil)
13577 (defvar org-log-note-previous-state nil)
13578 (defvar org-log-note-extra nil)
13579 (defvar org-log-note-window-configuration nil)
13580 (defvar org-log-note-return-to (make-marker))
13581 (defvar org-log-note-effective-time nil
13582 "Remembered current time so that dynamically scoped
13583 `org-extend-today-until' affects tha timestamps in state change
13584 log")
13586 (defvar org-log-post-message nil
13587 "Message to be displayed after a log note has been stored.
13588 The auto-repeater uses this.")
13590 (defun org-add-note ()
13591 "Add a note to the current entry.
13592 This is done in the same way as adding a state change note."
13593 (interactive)
13594 (org-add-log-setup 'note nil nil 'findpos nil))
13596 (defun org-log-beginning (&optional create)
13597 "Return expected start of log notes in current entry.
13598 When optional argument CREATE is non-nil, the function creates
13599 a drawer to store notes, if necessary. Returned position ignores
13600 narrowing."
13601 (org-with-wide-buffer
13602 (org-end-of-meta-data)
13603 (let ((end (if (org-at-heading-p) (point)
13604 (save-excursion (outline-next-heading) (point))))
13605 (drawer (org-log-into-drawer)))
13606 (cond
13607 (drawer
13608 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13609 (case-fold-search t))
13610 (catch 'exit
13611 ;; Try to find existing drawer.
13612 (while (re-search-forward regexp end t)
13613 (let ((element (org-element-at-point)))
13614 (when (eq (org-element-type element) 'drawer)
13615 (let ((cend (org-element-property :contents-end element)))
13616 (when (and (not org-log-states-order-reversed) cend)
13617 (goto-char cend)))
13618 (throw 'exit nil))))
13619 ;; No drawer found. Create one, if permitted.
13620 (when create
13621 (unless (bolp) (insert "\n"))
13622 (let ((beg (point)))
13623 (insert ":" drawer ":\n:END:\n")
13624 (org-indent-region beg (point)))
13625 (end-of-line -1)))))
13626 (org-log-state-notes-insert-after-drawers
13627 (while (and (looking-at org-drawer-regexp)
13628 (progn (goto-char (match-end 0))
13629 (re-search-forward org-property-end-re end t)))
13630 (forward-line)))))
13631 (if (bolp) (point) (line-beginning-position 2))))
13633 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13634 "Set up the post command hook to take a note.
13635 If this is about to TODO state change, the new state is expected in STATE.
13636 When FINDPOS is non-nil, find the correct position for the note in
13637 the current entry. If not, assume that it can be inserted at point.
13638 HOW is an indicator what kind of note should be created.
13639 EXTRA is additional text that will be inserted into the notes buffer."
13640 (org-with-wide-buffer
13641 (when findpos
13642 (goto-char (org-log-beginning t))
13643 (unless org-log-states-order-reversed
13644 (org-skip-over-state-notes)
13645 (skip-chars-backward " \t\n\r")
13646 (forward-line)))
13647 (move-marker org-log-note-marker (point))
13648 ;; Preserve position even if a property drawer is inserted in the
13649 ;; process.
13650 (set-marker-insertion-type org-log-note-marker t)
13651 (setq org-log-note-purpose purpose
13652 org-log-note-state state
13653 org-log-note-previous-state prev-state
13654 org-log-note-how how
13655 org-log-note-extra extra
13656 org-log-note-effective-time (org-current-effective-time))
13657 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13659 (defun org-skip-over-state-notes ()
13660 "Skip past the list of State notes in an entry."
13661 (when (ignore-errors (goto-char (org-in-item-p)))
13662 (let* ((struct (org-list-struct))
13663 (prevs (org-list-prevs-alist struct))
13664 (regexp
13665 (concat "[ \t]*- +"
13666 (replace-regexp-in-string
13667 " +" " +"
13668 (org-replace-escapes
13669 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13670 `(("%d" . ,org-ts-regexp-inactive)
13671 ("%D" . ,org-ts-regexp)
13672 ("%s" . "\"\\S-+\"")
13673 ("%S" . "\"\\S-+\"")
13674 ("%t" . ,org-ts-regexp-inactive)
13675 ("%T" . ,org-ts-regexp)
13676 ("%u" . ".*?")
13677 ("%U" . ".*?")))))))
13678 (while (org-looking-at-p regexp)
13679 (goto-char (or (org-list-get-next-item (point) struct prevs)
13680 (org-list-get-item-end (point) struct)))))))
13682 (defun org-add-log-note (&optional purpose)
13683 "Pop up a window for taking a note, and add this note later at point."
13684 (remove-hook 'post-command-hook 'org-add-log-note)
13685 (setq org-log-note-window-configuration (current-window-configuration))
13686 (delete-other-windows)
13687 (move-marker org-log-note-return-to (point))
13688 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13689 (goto-char org-log-note-marker)
13690 (org-switch-to-buffer-other-window "*Org Note*")
13691 (erase-buffer)
13692 (if (memq org-log-note-how '(time state))
13693 (let (current-prefix-arg) (org-store-log-note))
13694 (let ((org-inhibit-startup t)) (org-mode))
13695 (insert (format "# Insert note for %s.
13696 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13697 (cond
13698 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13699 ((eq org-log-note-purpose 'done) "closed todo item")
13700 ((eq org-log-note-purpose 'state)
13701 (format "state change from \"%s\" to \"%s\""
13702 (or org-log-note-previous-state "")
13703 (or org-log-note-state "")))
13704 ((eq org-log-note-purpose 'reschedule)
13705 "rescheduling")
13706 ((eq org-log-note-purpose 'delschedule)
13707 "no longer scheduled")
13708 ((eq org-log-note-purpose 'redeadline)
13709 "changing deadline")
13710 ((eq org-log-note-purpose 'deldeadline)
13711 "removing deadline")
13712 ((eq org-log-note-purpose 'refile)
13713 "refiling")
13714 ((eq org-log-note-purpose 'note)
13715 "this entry")
13716 (t (error "This should not happen")))))
13717 (if org-log-note-extra (insert org-log-note-extra))
13718 (org-set-local 'org-finish-function 'org-store-log-note)
13719 (run-hooks 'org-log-buffer-setup-hook)))
13721 (defvar org-note-abort nil) ; dynamically scoped
13722 (defun org-store-log-note ()
13723 "Finish taking a log note, and insert it to where it belongs."
13724 (let ((txt (buffer-string)))
13725 (kill-buffer (current-buffer))
13726 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13727 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13728 (setq txt (replace-match "" t t txt)))
13729 (if (string-match "\\s-+\\'" txt)
13730 (setq txt (replace-match "" t t txt)))
13731 (setq lines (org-split-string txt "\n"))
13732 (when (and note (string-match "\\S-" note))
13733 (setq note
13734 (org-replace-escapes
13735 note
13736 (list (cons "%u" (user-login-name))
13737 (cons "%U" user-full-name)
13738 (cons "%t" (format-time-string
13739 (org-time-stamp-format 'long 'inactive)
13740 org-log-note-effective-time))
13741 (cons "%T" (format-time-string
13742 (org-time-stamp-format 'long nil)
13743 org-log-note-effective-time))
13744 (cons "%d" (format-time-string
13745 (org-time-stamp-format nil 'inactive)
13746 org-log-note-effective-time))
13747 (cons "%D" (format-time-string
13748 (org-time-stamp-format nil nil)
13749 org-log-note-effective-time))
13750 (cons "%s" (cond
13751 ((not org-log-note-state) "")
13752 ((org-string-match-p org-ts-regexp
13753 org-log-note-state)
13754 (format "\"[%s]\""
13755 (substring org-log-note-state 1 -1)))
13756 (t (format "\"%s\"" org-log-note-state))))
13757 (cons "%S"
13758 (cond
13759 ((not org-log-note-previous-state) "")
13760 ((org-string-match-p org-ts-regexp
13761 org-log-note-previous-state)
13762 (format "\"[%s]\""
13763 (substring
13764 org-log-note-previous-state 1 -1)))
13765 (t (format "\"%s\""
13766 org-log-note-previous-state)))))))
13767 (when lines (setq note (concat note " \\\\")))
13768 (push note lines))
13769 (when (or current-prefix-arg org-note-abort)
13770 (when (org-log-into-drawer)
13771 (org-remove-empty-drawer-at org-log-note-marker))
13772 (setq lines nil))
13773 (when lines
13774 (with-current-buffer (marker-buffer org-log-note-marker)
13775 (org-with-wide-buffer
13776 (goto-char org-log-note-marker)
13777 (move-marker org-log-note-marker nil)
13778 ;; Make sure point is at the beginning of an empty line.
13779 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13780 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13781 ;; In an existing list, add a new item at the top level.
13782 ;; Otherwise, indent line like a regular one.
13783 (let ((itemp (org-in-item-p)))
13784 (if itemp
13785 (org-indent-line-to
13786 (let ((struct (save-excursion
13787 (goto-char itemp) (org-list-struct))))
13788 (org-list-get-ind (org-list-get-top-point struct) struct)))
13789 (org-indent-line)))
13790 (insert (org-list-bullet-string "-") (pop lines))
13791 (let ((ind (org-list-item-body-column (line-beginning-position))))
13792 (dolist (line lines)
13793 (insert "\n")
13794 (org-indent-line-to ind)
13795 (insert line)))
13796 (message "Note stored")
13797 (org-back-to-heading t)
13798 (org-cycle-hide-drawers 'children))
13799 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13800 ;; from within `org-add-log-note' because `buffer-undo-list'
13801 ;; is then modified outside of `org-with-remote-undo'.
13802 (when (eq this-command 'org-agenda-todo)
13803 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13804 ;; Don't add undo information when called from `org-agenda-todo'
13805 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13806 (set-window-configuration org-log-note-window-configuration)
13807 (with-current-buffer (marker-buffer org-log-note-return-to)
13808 (goto-char org-log-note-return-to))
13809 (move-marker org-log-note-return-to nil)
13810 (and org-log-post-message (message "%s" org-log-post-message))))
13812 (defun org-remove-empty-drawer-at (pos)
13813 "Remove an empty drawer at position POS.
13814 POS may also be a marker."
13815 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13816 (org-with-wide-buffer
13817 (goto-char pos)
13818 (let ((drawer (org-element-at-point)))
13819 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13820 (not (org-element-property :contents-begin drawer)))
13821 (delete-region (org-element-property :begin drawer)
13822 (progn (goto-char (org-element-property :end drawer))
13823 (skip-chars-backward " \r\t\n")
13824 (forward-line)
13825 (point))))))))
13827 (defvar org-ts-type nil)
13828 (defun org-sparse-tree (&optional arg type)
13829 "Create a sparse tree, prompt for the details.
13830 This command can create sparse trees. You first need to select the type
13831 of match used to create the tree:
13833 t Show all TODO entries.
13834 T Show entries with a specific TODO keyword.
13835 m Show entries selected by a tags/property match.
13836 p Enter a property name and its value (both with completion on existing
13837 names/values) and show entries with that property.
13838 r Show entries matching a regular expression (`/' can be used as well).
13839 b Show deadlines and scheduled items before a date.
13840 a Show deadlines and scheduled items after a date.
13841 d Show deadlines due within `org-deadline-warning-days'.
13842 D Show deadlines and scheduled items between a date range."
13843 (interactive "P")
13844 (setq type (or type org-sparse-tree-default-date-type))
13845 (setq org-ts-type type)
13846 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13847 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13848 [c]ycle through date types: %s"
13849 (case type
13850 (all "all timestamps")
13851 (scheduled "only scheduled")
13852 (deadline "only deadline")
13853 (active "only active timestamps")
13854 (inactive "only inactive timestamps")
13855 (closed "with a closed time-stamp")
13856 (otherwise "scheduled/deadline")))
13857 (let ((answer (read-char-exclusive)))
13858 (case answer
13860 (org-sparse-tree
13862 (cadr
13863 (memq type '(nil all scheduled deadline active inactive closed)))))
13864 (?d (call-interactively 'org-check-deadlines))
13865 (?b (call-interactively 'org-check-before-date))
13866 (?a (call-interactively 'org-check-after-date))
13867 (?D (call-interactively 'org-check-dates-range))
13868 (?t (call-interactively 'org-show-todo-tree))
13869 (?T (org-show-todo-tree '(4)))
13870 (?m (call-interactively 'org-match-sparse-tree))
13871 ((?p ?P)
13872 (let* ((kwd (org-icompleting-read
13873 "Property: " (mapcar 'list (org-buffer-property-keys))))
13874 (value (org-icompleting-read
13875 "Value: " (mapcar 'list (org-property-values kwd)))))
13876 (unless (string-match "\\`{.*}\\'" value)
13877 (setq value (concat "\"" value "\"")))
13878 (org-match-sparse-tree arg (concat kwd "=" value))))
13879 ((?r ?R ?/) (call-interactively 'org-occur))
13880 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13882 (defvar org-occur-highlights nil
13883 "List of overlays used for occur matches.")
13884 (make-variable-buffer-local 'org-occur-highlights)
13885 (defvar org-occur-parameters nil
13886 "Parameters of the active org-occur calls.
13887 This is a list, each call to org-occur pushes as cons cell,
13888 containing the regular expression and the callback, onto the list.
13889 The list can contain several entries if `org-occur' has been called
13890 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13891 will only contain one set of parameters. When the highlights are
13892 removed (for example with `C-c C-c', or with the next edit (depending
13893 on `org-remove-highlights-with-change'), this variable is emptied
13894 as well.")
13895 (make-variable-buffer-local 'org-occur-parameters)
13897 (defun org-occur (regexp &optional keep-previous callback)
13898 "Make a compact tree which shows all matches of REGEXP.
13899 The tree will show the lines where the regexp matches, and all higher
13900 headlines above the match. It will also show the heading after the match,
13901 to make sure editing the matching entry is easy.
13902 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13903 call to `org-occur' will be kept, to allow stacking of calls to this
13904 command.
13905 If CALLBACK is non-nil, it is a function which is called to confirm
13906 that the match should indeed be shown."
13907 (interactive "sRegexp: \nP")
13908 (when (equal regexp "")
13909 (user-error "Regexp cannot be empty"))
13910 (unless keep-previous
13911 (org-remove-occur-highlights nil nil t))
13912 (push (cons regexp callback) org-occur-parameters)
13913 (let ((cnt 0))
13914 (save-excursion
13915 (goto-char (point-min))
13916 (if (or (not keep-previous) ; do not want to keep
13917 (not org-occur-highlights)) ; no previous matches
13918 ;; hide everything
13919 (org-overview))
13920 (while (re-search-forward regexp nil t)
13921 (backward-char) ;; FIXME: Match timestamps at the end of a headline
13922 (when (or (not callback)
13923 (save-match-data (funcall callback)))
13924 (setq cnt (1+ cnt))
13925 (when org-highlight-sparse-tree-matches
13926 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13927 (org-show-context 'occur-tree))))
13928 (when org-remove-highlights-with-change
13929 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13930 nil 'local))
13931 (unless org-sparse-tree-open-archived-trees
13932 (org-hide-archived-subtrees (point-min) (point-max)))
13933 (run-hooks 'org-occur-hook)
13934 (if (org-called-interactively-p 'interactive)
13935 (message "%d match(es) for regexp %s" cnt regexp))
13936 cnt))
13938 (defun org-occur-next-match (&optional n reset)
13939 "Function for `next-error-function' to find sparse tree matches.
13940 N is the number of matches to move, when negative move backwards.
13941 RESET is entirely ignored - this function always goes back to the
13942 starting point when no match is found."
13943 (let* ((limit (if (< n 0) (point-min) (point-max)))
13944 (search-func (if (< n 0)
13945 'previous-single-char-property-change
13946 'next-single-char-property-change))
13947 (n (abs n))
13948 (pos (point))
13950 (catch 'exit
13951 (while (setq p1 (funcall search-func (point) 'org-type))
13952 (when (equal p1 limit)
13953 (goto-char pos)
13954 (user-error "No more matches"))
13955 (when (equal (get-char-property p1 'org-type) 'org-occur)
13956 (setq n (1- n))
13957 (when (= n 0)
13958 (goto-char p1)
13959 (throw 'exit (point))))
13960 (goto-char p1))
13961 (goto-char p1)
13962 (user-error "No more matches"))))
13964 (defun org-show-context (&optional key)
13965 "Make sure point and context are visible.
13966 Optional argument KEY, when non-nil, is a symbol. See
13967 `org-show-context-detail' for allowed values and how much is to
13968 be shown."
13969 (org-show-set-visibility
13970 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13971 ((cdr (assq key org-show-context-detail)))
13972 (t (cdr (assq 'default org-show-context-detail))))))
13974 (defun org-show-set-visibility (detail)
13975 "Set visibility around point according to DETAIL.
13976 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13977 `tree', `canonical' or t. See `org-show-context-detail' for more
13978 information."
13979 (unless (org-before-first-heading-p)
13980 ;; Show current heading and possibly its entry, following headline
13981 ;; or all children.
13982 (if (and (org-at-heading-p) (not (eq detail 'local)))
13983 (org-flag-heading nil)
13984 (org-show-entry)
13985 (org-with-limited-levels
13986 (case detail
13987 ((tree canonical t) (org-show-children))
13988 ((nil minimal ancestors))
13989 (t (save-excursion
13990 (outline-next-heading)
13991 (org-flag-heading nil))))))
13992 ;; Show all siblings.
13993 (when (eq detail 'lineage) (org-show-siblings))
13994 ;; Show ancestors, possibly with their children.
13995 (when (memq detail '(ancestors lineage tree canonical t))
13996 (save-excursion
13997 (while (org-up-heading-safe)
13998 (org-flag-heading nil)
13999 (when (memq detail '(canonical t)) (org-show-entry))
14000 (when (memq detail '(tree canonical t)) (org-show-children)))))))
14002 (defvar org-reveal-start-hook nil
14003 "Hook run before revealing a location.")
14005 (defun org-reveal (&optional siblings)
14006 "Show current entry, hierarchy above it, and the following headline.
14008 This can be used to show a consistent set of context around
14009 locations exposed with `org-show-context'.
14011 With optional argument SIBLINGS, on each level of the hierarchy all
14012 siblings are shown. This repairs the tree structure to what it would
14013 look like when opened with hierarchical calls to `org-cycle'.
14015 With double optional argument \\[universal-argument] \\[universal-argument], \
14016 go to the parent and show the
14017 entire tree."
14018 (interactive "P")
14019 (run-hooks 'org-reveal-start-hook)
14020 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14021 ((equal siblings '(16))
14022 (save-excursion
14023 (when (org-up-heading-safe)
14024 (org-show-subtree)
14025 (run-hook-with-args 'org-cycle-hook 'subtree))))
14026 (t (org-show-set-visibility 'lineage))))
14028 (defun org-highlight-new-match (beg end)
14029 "Highlight from BEG to END and mark the highlight is an occur headline."
14030 (let ((ov (make-overlay beg end)))
14031 (overlay-put ov 'face 'secondary-selection)
14032 (overlay-put ov 'org-type 'org-occur)
14033 (push ov org-occur-highlights)))
14035 (defun org-remove-occur-highlights (&optional beg end noremove)
14036 "Remove the occur highlights from the buffer.
14037 BEG and END are ignored. If NOREMOVE is nil, remove this function
14038 from the `before-change-functions' in the current buffer."
14039 (interactive)
14040 (unless org-inhibit-highlight-removal
14041 (mapc 'delete-overlay org-occur-highlights)
14042 (setq org-occur-highlights nil)
14043 (setq org-occur-parameters nil)
14044 (unless noremove
14045 (remove-hook 'before-change-functions
14046 'org-remove-occur-highlights 'local))))
14048 ;;;; Priorities
14050 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14051 "Regular expression matching the priority indicator.")
14053 (defvar org-remove-priority-next-time nil)
14055 (defun org-priority-up ()
14056 "Increase the priority of the current item."
14057 (interactive)
14058 (org-priority 'up))
14060 (defun org-priority-down ()
14061 "Decrease the priority of the current item."
14062 (interactive)
14063 (org-priority 'down))
14065 (defun org-priority (&optional action show)
14066 "Change the priority of an item.
14067 ACTION can be `set', `up', `down', or a character."
14068 (interactive "P")
14069 (if (equal action '(4))
14070 (org-show-priority)
14071 (unless org-enable-priority-commands
14072 (user-error "Priority commands are disabled"))
14073 (setq action (or action 'set))
14074 (let (current new news have remove)
14075 (save-excursion
14076 (org-back-to-heading t)
14077 (if (looking-at org-priority-regexp)
14078 (setq current (string-to-char (match-string 2))
14079 have t))
14080 (cond
14081 ((eq action 'remove)
14082 (setq remove t new ?\ ))
14083 ((or (eq action 'set)
14084 (if (featurep 'xemacs) (characterp action) (integerp action)))
14085 (if (not (eq action 'set))
14086 (setq new action)
14087 (message "Priority %c-%c, SPC to remove: "
14088 org-highest-priority org-lowest-priority)
14089 (save-match-data
14090 (setq new (read-char-exclusive))))
14091 (if (and (= (upcase org-highest-priority) org-highest-priority)
14092 (= (upcase org-lowest-priority) org-lowest-priority))
14093 (setq new (upcase new)))
14094 (cond ((equal new ?\ ) (setq remove t))
14095 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14096 (user-error "Priority must be between `%c' and `%c'"
14097 org-highest-priority org-lowest-priority))))
14098 ((eq action 'up)
14099 (setq new (if have
14100 (1- current) ; normal cycling
14101 ;; last priority was empty
14102 (if (eq last-command this-command)
14103 org-lowest-priority ; wrap around empty to lowest
14104 ;; default
14105 (if org-priority-start-cycle-with-default
14106 org-default-priority
14107 (1- org-default-priority))))))
14108 ((eq action 'down)
14109 (setq new (if have
14110 (1+ current) ; normal cycling
14111 ;; last priority was empty
14112 (if (eq last-command this-command)
14113 org-highest-priority ; wrap around empty to highest
14114 ;; default
14115 (if org-priority-start-cycle-with-default
14116 org-default-priority
14117 (1+ org-default-priority))))))
14118 (t (user-error "Invalid action")))
14119 (if (or (< (upcase new) org-highest-priority)
14120 (> (upcase new) org-lowest-priority))
14121 (if (and (memq action '(up down))
14122 (not have) (not (eq last-command this-command)))
14123 ;; `new' is from default priority
14124 (error
14125 "The default can not be set, see `org-default-priority' why")
14126 ;; normal cycling: `new' is beyond highest/lowest priority
14127 ;; and is wrapped around to the empty priority
14128 (setq remove t)))
14129 (setq news (format "%c" new))
14130 (if have
14131 (if remove
14132 (replace-match "" t t nil 1)
14133 (replace-match news t t nil 2))
14134 (if remove
14135 (user-error "No priority cookie found in line")
14136 (let ((case-fold-search nil))
14137 (looking-at org-todo-line-regexp))
14138 (if (match-end 2)
14139 (progn
14140 (goto-char (match-end 2))
14141 (insert " [#" news "]"))
14142 (goto-char (match-beginning 3))
14143 (insert "[#" news "] "))))
14144 (org-set-tags nil 'align))
14145 (if remove
14146 (message "Priority removed")
14147 (message "Priority of current item set to %s" news)))))
14149 (defun org-show-priority ()
14150 "Show the priority of the current item.
14151 This priority is composed of the main priority given with the [#A] cookies,
14152 and by additional input from the age of a schedules or deadline entry."
14153 (interactive)
14154 (let ((pri (if (eq major-mode 'org-agenda-mode)
14155 (org-get-at-bol 'priority)
14156 (save-excursion
14157 (save-match-data
14158 (beginning-of-line)
14159 (and (looking-at org-heading-regexp)
14160 (org-get-priority (match-string 0))))))))
14161 (message "Priority is %d" (if pri pri -1000))))
14163 (defun org-get-priority (s)
14164 "Find priority cookie and return priority."
14165 (save-match-data
14166 (if (functionp org-get-priority-function)
14167 (funcall org-get-priority-function)
14168 (if (not (string-match org-priority-regexp s))
14169 (* 1000 (- org-lowest-priority org-default-priority))
14170 (* 1000 (- org-lowest-priority
14171 (string-to-char (match-string 2 s))))))))
14173 ;;;; Tags
14175 (defvar org-agenda-archives-mode)
14176 (defvar org-map-continue-from nil
14177 "Position from where mapping should continue.
14178 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14180 (defvar org-scanner-tags nil
14181 "The current tag list while the tags scanner is running.")
14182 (defvar org-trust-scanner-tags nil
14183 "Should `org-get-tags-at' use the tags for the scanner.
14184 This is for internal dynamical scoping only.
14185 When this is non-nil, the function `org-get-tags-at' will return the value
14186 of `org-scanner-tags' instead of building the list by itself. This
14187 can lead to large speed-ups when the tags scanner is used in a file with
14188 many entries, and when the list of tags is retrieved, for example to
14189 obtain a list of properties. Building the tags list for each entry in such
14190 a file becomes an N^2 operation - but with this variable set, it scales
14191 as N.")
14193 (defun org-scan-tags (action matcher todo-only &optional start-level)
14194 "Scan headline tags with inheritance and produce output ACTION.
14196 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14197 or `agenda' to produce an entry list for an agenda view. It can also be
14198 a Lisp form or a function that should be called at each matched headline, in
14199 this case the return value is a list of all return values from these calls.
14201 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14202 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14203 only lines with a not-done TODO keyword are included in the output.
14204 This should be the same variable that was scoped into
14205 and set by `org-make-tags-matcher' when it constructed MATCHER.
14207 START-LEVEL can be a string with asterisks, reducing the scope to
14208 headlines matching this string."
14209 (require 'org-agenda)
14210 (let* ((re (concat "^"
14211 (if start-level
14212 ;; Get the correct level to match
14213 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14214 org-outline-regexp)
14215 " *\\(\\<\\("
14216 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14217 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14218 (props (list 'face 'default
14219 'done-face 'org-agenda-done
14220 'undone-face 'default
14221 'mouse-face 'highlight
14222 'org-not-done-regexp org-not-done-regexp
14223 'org-todo-regexp org-todo-regexp
14224 'org-complex-heading-regexp org-complex-heading-regexp
14225 'help-echo
14226 (format "mouse-2 or RET jump to org file %s"
14227 (abbreviate-file-name
14228 (or (buffer-file-name (buffer-base-buffer))
14229 (buffer-name (buffer-base-buffer)))))))
14230 (org-map-continue-from nil)
14231 lspos tags tags-list
14232 (tags-alist (list (cons 0 org-file-tags)))
14233 (llast 0) rtn rtn1 level category i txt
14234 todo marker entry priority
14235 ts-date ts-date-type ts-date-pair)
14236 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14237 (setq action (list 'lambda nil action)))
14238 (save-excursion
14239 (goto-char (point-min))
14240 (when (eq action 'sparse-tree)
14241 (org-overview)
14242 (org-remove-occur-highlights))
14243 (while (let (case-fold-search)
14244 (re-search-forward re nil t))
14245 (setq org-map-continue-from nil)
14246 (catch :skip
14247 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14248 tags (if (match-end 4) (org-match-string-no-properties 4)))
14249 (goto-char (setq lspos (match-beginning 0)))
14250 (setq level (org-reduced-level (org-outline-level))
14251 category (org-get-category))
14252 (when (eq action 'agenda)
14253 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14254 ts-date (car ts-date-pair)
14255 ts-date-type (cdr ts-date-pair)))
14256 (setq i llast llast level)
14257 ;; remove tag lists from same and sublevels
14258 (while (>= i level)
14259 (when (setq entry (assoc i tags-alist))
14260 (setq tags-alist (delete entry tags-alist)))
14261 (setq i (1- i)))
14262 ;; add the next tags
14263 (when tags
14264 (setq tags (org-split-string tags ":")
14265 tags-alist
14266 (cons (cons level tags) tags-alist)))
14267 ;; compile tags for current headline
14268 (setq tags-list
14269 (if org-use-tag-inheritance
14270 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14271 tags)
14272 org-scanner-tags tags-list)
14273 (when org-use-tag-inheritance
14274 (setcdr (car tags-alist)
14275 (mapcar (lambda (x)
14276 (setq x (copy-sequence x))
14277 (org-add-prop-inherited x))
14278 (cdar tags-alist))))
14279 (when (and tags org-use-tag-inheritance
14280 (or (not (eq t org-use-tag-inheritance))
14281 org-tags-exclude-from-inheritance))
14282 ;; selective inheritance, remove uninherited ones
14283 (setcdr (car tags-alist)
14284 (org-remove-uninherited-tags (cdar tags-alist))))
14285 (when (and
14287 ;; eval matcher only when the todo condition is OK
14288 (and (or (not todo-only) (member todo org-not-done-keywords))
14289 (let ((case-fold-search t) (org-trust-scanner-tags t))
14290 (eval matcher)))
14292 ;; Call the skipper, but return t if it does not skip,
14293 ;; so that the `and' form continues evaluating
14294 (progn
14295 (unless (eq action 'sparse-tree) (org-agenda-skip))
14298 ;; Check if timestamps are deselecting this entry
14299 (or (not todo-only)
14300 (and (member todo org-not-done-keywords)
14301 (or (not org-agenda-tags-todo-honor-ignore-options)
14302 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14304 ;; select this headline
14305 (cond
14306 ((eq action 'sparse-tree)
14307 (and org-highlight-sparse-tree-matches
14308 (org-get-heading) (match-end 0)
14309 (org-highlight-new-match
14310 (match-beginning 1) (match-end 1)))
14311 (org-show-context 'tags-tree))
14312 ((eq action 'agenda)
14313 (setq txt (org-agenda-format-item
14315 (concat
14316 (if (eq org-tags-match-list-sublevels 'indented)
14317 (make-string (1- level) ?.) "")
14318 (org-get-heading))
14319 (make-string level ?\s)
14320 category
14321 tags-list)
14322 priority (org-get-priority txt))
14323 (goto-char lspos)
14324 (setq marker (org-agenda-new-marker))
14325 (org-add-props txt props
14326 'org-marker marker 'org-hd-marker marker 'org-category category
14327 'todo-state todo
14328 'ts-date ts-date
14329 'priority priority
14330 'type (concat "tagsmatch" ts-date-type))
14331 (push txt rtn))
14332 ((functionp action)
14333 (setq org-map-continue-from nil)
14334 (save-excursion
14335 (setq rtn1 (funcall action))
14336 (push rtn1 rtn)))
14337 (t (user-error "Invalid action")))
14339 ;; if we are to skip sublevels, jump to end of subtree
14340 (unless org-tags-match-list-sublevels
14341 (org-end-of-subtree t)
14342 (backward-char 1))))
14343 ;; Get the correct position from where to continue
14344 (if org-map-continue-from
14345 (goto-char org-map-continue-from)
14346 (and (= (point) lspos) (end-of-line 1)))))
14347 (when (and (eq action 'sparse-tree)
14348 (not org-sparse-tree-open-archived-trees))
14349 (org-hide-archived-subtrees (point-min) (point-max)))
14350 (nreverse rtn)))
14352 (defun org-remove-uninherited-tags (tags)
14353 "Remove all tags that are not inherited from the list TAGS."
14354 (cond
14355 ((eq org-use-tag-inheritance t)
14356 (if org-tags-exclude-from-inheritance
14357 (org-delete-all org-tags-exclude-from-inheritance tags)
14358 tags))
14359 ((not org-use-tag-inheritance) nil)
14360 ((stringp org-use-tag-inheritance)
14361 (delq nil (mapcar
14362 (lambda (x)
14363 (if (and (string-match org-use-tag-inheritance x)
14364 (not (member x org-tags-exclude-from-inheritance)))
14365 x nil))
14366 tags)))
14367 ((listp org-use-tag-inheritance)
14368 (delq nil (mapcar
14369 (lambda (x)
14370 (if (member x org-use-tag-inheritance) x nil))
14371 tags)))))
14373 (defun org-match-sparse-tree (&optional todo-only match)
14374 "Create a sparse tree according to tags string MATCH.
14375 MATCH can contain positive and negative selection of tags, like
14376 \"+WORK+URGENT-WITHBOSS\".
14377 If optional argument TODO-ONLY is non-nil, only select lines that are
14378 also TODO lines."
14379 (interactive "P")
14380 (org-agenda-prepare-buffers (list (current-buffer)))
14381 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14383 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14385 (defvar org-cached-props nil)
14386 (defun org-cached-entry-get (pom property)
14387 (if (or (eq t org-use-property-inheritance)
14388 (and (stringp org-use-property-inheritance)
14389 (let ((case-fold-search t))
14390 (org-string-match-p org-use-property-inheritance property)))
14391 (and (listp org-use-property-inheritance)
14392 (member-ignore-case property org-use-property-inheritance)))
14393 ;; Caching is not possible, check it directly.
14394 (org-entry-get pom property 'inherit)
14395 ;; Get all properties, so we can do complicated checks easily.
14396 (cdr (assoc-string property
14397 (or org-cached-props
14398 (setq org-cached-props (org-entry-properties pom)))
14399 t))))
14401 (defun org-global-tags-completion-table (&optional files)
14402 "Return the list of all tags in all agenda buffer/files.
14403 Optional FILES argument is a list of files which can be used
14404 instead of the agenda files."
14405 (save-excursion
14406 (org-uniquify
14407 (delq nil
14408 (apply 'append
14409 (mapcar
14410 (lambda (file)
14411 (set-buffer (find-file-noselect file))
14412 (append (org-get-buffer-tags)
14413 (mapcar (lambda (x) (if (stringp (car-safe x))
14414 (list (car-safe x)) nil))
14415 org-tag-alist)))
14416 (if (and files (car files))
14417 files
14418 (org-agenda-files))))))))
14420 (defun org-make-tags-matcher (match)
14421 "Create the TAGS/TODO matcher form for the selection string MATCH.
14423 The variable `todo-only' is scoped dynamically into this function.
14424 It will be set to t if the matcher restricts matching to TODO entries,
14425 otherwise will not be touched.
14427 Returns a cons of the selection string MATCH and the constructed
14428 lisp form implementing the matcher. The matcher is to be evaluated
14429 at an Org entry, with point on the headline, and returns t if the
14430 entry matches the selection string MATCH. The returned lisp form
14431 references two variables with information about the entry, which
14432 must be bound around the form's evaluation: todo, the TODO keyword
14433 at the entry (or nil of none); and tags-list, the list of all tags
14434 at the entry including inherited ones. Additionally, the category
14435 of the entry (if any) must be specified as the text property
14436 'org-category on the headline.
14438 See also `org-scan-tags'.
14440 (declare (special todo-only))
14441 (unless (boundp 'todo-only)
14442 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14443 (unless match
14444 ;; Get a new match request, with completion against the global
14445 ;; tags table and the local tags in current buffer
14446 (let ((org-last-tags-completion-table
14447 (org-uniquify
14448 (delq nil (append (org-get-buffer-tags)
14449 (org-global-tags-completion-table))))))
14450 (setq match (org-completing-read-no-i
14451 "Match: " 'org-tags-completion-function nil nil nil
14452 'org-tags-history))))
14454 ;; Parse the string and create a lisp form
14455 (let ((match0 match)
14456 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14457 minus tag mm
14458 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14459 orterms term orlist re-p str-p level-p level-op time-p
14460 prop-p pn pv po gv rest (start 0) (ss 0))
14461 ;; Expand group tags
14462 (setq match (org-tags-expand match))
14464 ;; Check if there is a TODO part of this match, which would be the
14465 ;; part after a "/". TO make sure that this slash is not part of
14466 ;; a property value to be matched against, we also check that there
14467 ;; is no " after that slash.
14468 ;; First, find the last slash
14469 (while (string-match "/+" match ss)
14470 (setq start (match-beginning 0) ss (match-end 0)))
14471 (if (and (string-match "/+" match start)
14472 (not (save-match-data (string-match "\"" match start))))
14473 ;; match contains also a todo-matching request
14474 (progn
14475 (setq tagsmatch (substring match 0 (match-beginning 0))
14476 todomatch (substring match (match-end 0)))
14477 (if (string-match "^!" todomatch)
14478 (setq todo-only t todomatch (substring todomatch 1)))
14479 (if (string-match "^\\s-*$" todomatch)
14480 (setq todomatch nil)))
14481 ;; only matching tags
14482 (setq tagsmatch match todomatch nil))
14484 ;; Make the tags matcher
14485 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14486 (setq tagsmatcher t)
14487 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14488 (while (setq term (pop orterms))
14489 (while (and (equal (substring term -1) "\\") orterms)
14490 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14491 (while (string-match re term)
14492 (setq rest (substring term (match-end 0))
14493 minus (and (match-end 1)
14494 (equal (match-string 1 term) "-"))
14495 tag (save-match-data (replace-regexp-in-string
14496 "\\\\-" "-"
14497 (match-string 2 term)))
14498 re-p (equal (string-to-char tag) ?{)
14499 level-p (match-end 4)
14500 prop-p (match-end 5)
14501 mm (cond
14502 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14503 (level-p
14504 (setq level-op (org-op-to-function (match-string 3 term)))
14505 `(,level-op level ,(string-to-number
14506 (match-string 4 term))))
14507 (prop-p
14508 (setq pn (match-string 5 term)
14509 po (match-string 6 term)
14510 pv (match-string 7 term)
14511 re-p (equal (string-to-char pv) ?{)
14512 str-p (equal (string-to-char pv) ?\")
14513 time-p (save-match-data
14514 (string-match "^\"[[<].*[]>]\"$" pv))
14515 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14516 (if time-p (setq pv (org-matcher-time pv)))
14517 (setq po (org-op-to-function po (if time-p 'time str-p)))
14518 (cond
14519 ((equal pn "CATEGORY")
14520 (setq gv '(get-text-property (point) 'org-category)))
14521 ((equal pn "TODO")
14522 (setq gv 'todo))
14524 (setq gv `(org-cached-entry-get nil ,pn))))
14525 (if re-p
14526 (if (eq po 'org<>)
14527 `(not (string-match ,pv (or ,gv "")))
14528 `(string-match ,pv (or ,gv "")))
14529 (if str-p
14530 `(,po (or ,gv "") ,pv)
14531 `(,po (string-to-number (or ,gv ""))
14532 ,(string-to-number pv) ))))
14533 (t `(member ,tag tags-list)))
14534 mm (if minus (list 'not mm) mm)
14535 term rest)
14536 (push mm tagsmatcher))
14537 (push (if (> (length tagsmatcher) 1)
14538 (cons 'and tagsmatcher)
14539 (car tagsmatcher))
14540 orlist)
14541 (setq tagsmatcher nil))
14542 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14543 (setq tagsmatcher
14544 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14545 ;; Make the todo matcher
14546 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14547 (setq todomatcher t)
14548 (setq orterms (org-split-string todomatch "|") orlist nil)
14549 (dolist (term orterms)
14550 (while (string-match re term)
14551 (setq minus (and (match-end 1)
14552 (equal (match-string 1 term) "-"))
14553 kwd (match-string 2 term)
14554 re-p (equal (string-to-char kwd) ?{)
14555 term (substring term (match-end 0))
14556 mm (if re-p
14557 `(string-match ,(substring kwd 1 -1) todo)
14558 (list 'equal 'todo kwd))
14559 mm (if minus (list 'not mm) mm))
14560 (push mm todomatcher))
14561 (push (if (> (length todomatcher) 1)
14562 (cons 'and todomatcher)
14563 (car todomatcher))
14564 orlist)
14565 (setq todomatcher nil))
14566 (setq todomatcher (if (> (length orlist) 1)
14567 (cons 'or orlist) (car orlist))))
14569 ;; Return the string and lisp forms of the matcher
14570 (setq matcher (if todomatcher
14571 (list 'and tagsmatcher todomatcher)
14572 tagsmatcher))
14573 (when todo-only
14574 (setq matcher (list 'and '(member todo org-not-done-keywords)
14575 matcher)))
14576 (cons match0 matcher)))
14578 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14579 "Expand group tags in MATCH.
14581 This replaces every group tag in MATCH with a regexp tag search.
14582 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14583 will be replaced like this:
14585 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14586 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14587 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14589 Replacing by a regexp preserves the structure of the match.
14590 E.g., this expansion
14592 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14594 will match anything tagged with \"Lab\" and \"Home\", or tagged
14595 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14597 A group tag in MATCH can contain regular expressions of its own.
14598 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14599 will be replaced like this:
14601 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14603 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14604 assumed to be a single group tag, and the function will return
14605 the list of tags in this group.
14607 When DOWNCASE is non-nil, expand downcased TAGS."
14608 (if org-group-tags
14609 (let* ((case-fold-search t)
14610 (stable org-mode-syntax-table)
14611 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14612 (taggroups (if downcased
14613 (mapcar (lambda (tg) (mapcar #'downcase tg))
14614 taggroups)
14615 taggroups))
14616 (taggroups-keys (mapcar #'car taggroups))
14617 (return-match (if downcased (downcase match) match))
14618 (count 0)
14619 (work-already-expanded tags-already-expanded)
14620 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14621 ;; @ and _ are allowed as word-components in tags.
14622 (modify-syntax-entry ?@ "w" stable)
14623 (modify-syntax-entry ?_ "w" stable)
14624 ;; Temporarily replace regexp-expressions in the match-expression.
14625 (while (string-match "{.+?}" return-match)
14626 (incf count)
14627 (push (match-string 0 return-match) regexps-in-match)
14628 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14629 (while (and taggroups-keys
14630 (with-syntax-table stable
14631 (string-match
14632 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14633 (regexp-opt taggroups-keys) "\\>\\)")
14634 return-match)))
14635 (let* ((dir (match-string 1 return-match))
14636 (tag (match-string 2 return-match))
14637 (tag (if downcased (downcase tag) tag)))
14638 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14639 (member tag work-already-expanded))
14640 (setq tags-in-group (assoc tag taggroups))
14641 (push tag work-already-expanded)
14642 ;; Recursively expand each tag in the group, if the tag hasn't
14643 ;; already been expanded. Restore the match-data after all recursive calls.
14644 (save-match-data
14645 (let (tags-expanded)
14646 (dolist (x (cdr tags-in-group))
14647 (if (and (member x taggroups-keys)
14648 (not (member x work-already-expanded)))
14649 (setq tags-expanded
14650 (delete-dups
14651 (append
14652 (org-tags-expand x t downcased
14653 work-already-expanded)
14654 tags-expanded)))
14655 (setq tags-expanded
14656 (append (list x) tags-expanded)))
14657 (setq work-already-expanded
14658 (delete-dups
14659 (append tags-expanded
14660 work-already-expanded))))
14661 (setq tags-in-group
14662 (delete-dups (cons (car tags-in-group)
14663 tags-expanded)))))
14664 ;; Filter tag-regexps from tags.
14665 (setq regexp-in-group-escaped
14666 (delq nil (mapcar (lambda (x)
14667 (if (stringp x)
14668 (and (equal "{" (substring x 0 1))
14669 (equal "}" (substring x -1))
14672 tags-in-group))
14673 regexp-in-group
14674 (mapcar (lambda (x)
14675 (substring x 1 -1))
14676 regexp-in-group-escaped)
14677 tags-in-group
14678 (delq nil (mapcar (lambda (x)
14679 (if (stringp x)
14680 (and (not (equal "{" (substring x 0 1)))
14681 (not (equal "}" (substring x -1)))
14684 tags-in-group)))
14685 ;; If single-as-list, do no more in the while-loop.
14686 (if (not single-as-list)
14687 (progn
14688 (when regexp-in-group
14689 (setq regexp-in-group
14690 (concat "\\|"
14691 (mapconcat 'identity regexp-in-group
14692 "\\|"))))
14693 (setq tags-in-group
14694 (concat dir
14695 "{\\<"
14696 (regexp-opt tags-in-group)
14697 "\\>"
14698 regexp-in-group
14699 "}"))
14700 (when (stringp tags-in-group)
14701 (org-add-props tags-in-group '(grouptag t)))
14702 (setq return-match
14703 (replace-match tags-in-group t t return-match)))
14704 (setq tags-in-group
14705 (append regexp-in-group-escaped tags-in-group))))
14706 (setq taggroups-keys (delete tag taggroups-keys))))
14707 ;; Add the regular expressions back into the match-expression again.
14708 (while regexps-in-match
14709 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14710 (pop regexps-in-match)
14711 return-match t t))
14712 (decf count))
14713 (if single-as-list
14714 (if tags-in-group tags-in-group (list return-match))
14715 return-match))
14716 (if single-as-list
14717 (list (if downcased (downcase match) match))
14718 match)))
14720 (defun org-op-to-function (op &optional stringp)
14721 "Turn an operator into the appropriate function."
14722 (setq op
14723 (cond
14724 ((equal op "<" ) '(< string< org-time<))
14725 ((equal op ">" ) '(> org-string> org-time>))
14726 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14727 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14728 ((member op '("=" "==")) '(= string= org-time=))
14729 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14730 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14732 (defun org<> (a b) (not (= a b)))
14733 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14734 (defun org-string>= (a b) (not (string< a b)))
14735 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14736 (defun org-string<> (a b) (not (string= a b)))
14737 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14738 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14739 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14740 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14741 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14742 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14743 (defun org-2ft (s)
14744 "Convert S to a floating point time.
14745 If S is already a number, just return it. If it is a string, parse
14746 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14747 (cond
14748 ((numberp s) s)
14749 ((stringp s)
14750 (condition-case nil
14751 (float-time (apply 'encode-time (org-parse-time-string s)))
14752 (error 0.)))
14753 (t 0.)))
14755 (defun org-time-today ()
14756 "Time in seconds today at 0:00.
14757 Returns the float number of seconds since the beginning of the
14758 epoch to the beginning of today (00:00)."
14759 (float-time (apply 'encode-time
14760 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14762 (defun org-matcher-time (s)
14763 "Interpret a time comparison value."
14764 (save-match-data
14765 (cond
14766 ((string= s "<now>") (float-time))
14767 ((string= s "<today>") (org-time-today))
14768 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14769 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14770 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14771 (+ (org-time-today)
14772 (* (string-to-number (match-string 1 s))
14773 (cdr (assoc (match-string 2 s)
14774 '(("d" . 86400.0) ("w" . 604800.0)
14775 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14776 (t (org-2ft s)))))
14778 (defun org-match-any-p (re list)
14779 "Does re match any element of list?"
14780 (setq list (mapcar (lambda (x) (string-match re x)) list))
14781 (delq nil list))
14783 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14784 (defvar org-tags-overlay (make-overlay 1 1))
14785 (org-detach-overlay org-tags-overlay)
14787 (defun org-get-local-tags-at (&optional pos)
14788 "Get a list of tags defined in the current headline."
14789 (org-get-tags-at pos 'local))
14791 (defun org-get-local-tags ()
14792 "Get a list of tags defined in the current headline."
14793 (org-get-tags-at nil 'local))
14795 (defun org-get-tags-at (&optional pos local)
14796 "Get a list of all headline tags applicable at POS.
14797 POS defaults to point. If tags are inherited, the list contains
14798 the targets in the same sequence as the headlines appear, i.e.
14799 the tags of the current headline come last.
14800 When LOCAL is non-nil, only return tags from the current headline,
14801 ignore inherited ones."
14802 (interactive)
14803 (if (and org-trust-scanner-tags
14804 (or (not pos) (equal pos (point)))
14805 (not local))
14806 org-scanner-tags
14807 (let (tags ltags lastpos parent)
14808 (save-excursion
14809 (save-restriction
14810 (widen)
14811 (goto-char (or pos (point)))
14812 (save-match-data
14813 (catch 'done
14814 (condition-case nil
14815 (progn
14816 (org-back-to-heading t)
14817 (while (not (equal lastpos (point)))
14818 (setq lastpos (point))
14819 (when (looking-at
14820 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14821 (setq ltags (org-split-string
14822 (org-match-string-no-properties 1) ":"))
14823 (when parent
14824 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14825 (setq tags (append
14826 (if parent
14827 (org-remove-uninherited-tags ltags)
14828 ltags)
14829 tags)))
14830 (or org-use-tag-inheritance (throw 'done t))
14831 (if local (throw 'done t))
14832 (or (org-up-heading-safe) (error nil))
14833 (setq parent t)))
14834 (error nil)))))
14835 (if local
14836 tags
14837 (reverse (delete-dups
14838 (reverse (append
14839 (org-remove-uninherited-tags
14840 org-file-tags)
14841 tags)))))))))
14843 (defun org-add-prop-inherited (s)
14844 (add-text-properties 0 (length s) '(inherited t) s)
14847 (defun org-toggle-tag (tag &optional onoff)
14848 "Toggle the tag TAG for the current line.
14849 If ONOFF is `on' or `off', don't toggle but set to this state."
14850 (let (res current)
14851 (save-excursion
14852 (org-back-to-heading t)
14853 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14854 (point-at-eol) t)
14855 (progn
14856 (setq current (match-string 1))
14857 (replace-match ""))
14858 (setq current ""))
14859 (setq current (nreverse (org-split-string current ":")))
14860 (cond
14861 ((eq onoff 'on)
14862 (setq res t)
14863 (or (member tag current) (push tag current)))
14864 ((eq onoff 'off)
14865 (or (not (member tag current)) (setq current (delete tag current))))
14866 (t (if (member tag current)
14867 (setq current (delete tag current))
14868 (setq res t)
14869 (push tag current))))
14870 (end-of-line 1)
14871 (if current
14872 (progn
14873 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14874 (org-set-tags nil t))
14875 (delete-horizontal-space))
14876 (run-hooks 'org-after-tags-change-hook))
14877 res))
14879 (defun org-align-tags-here (to-col)
14880 ;; Assumes that this is a headline
14881 "Align tags on the current headline to TO-COL."
14882 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14883 (beginning-of-line 1)
14884 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14885 (< pos (match-beginning 2)))
14886 (progn
14887 (setq tags-l (- (match-end 2) (match-beginning 2)))
14888 (goto-char (match-beginning 1))
14889 (insert " ")
14890 (delete-region (point) (1+ (match-beginning 2)))
14891 (setq ncol (max (current-column)
14892 (1+ col)
14893 (if (> to-col 0)
14894 to-col
14895 (- (abs to-col) tags-l))))
14896 (setq p (point))
14897 (insert (make-string (- ncol (current-column)) ?\ ))
14898 (setq ncol (current-column))
14899 (when indent-tabs-mode (tabify p (point-at-eol)))
14900 (org-move-to-column (min ncol col)))
14901 (goto-char pos))))
14903 (defun org-set-tags-command (&optional arg just-align)
14904 "Call the set-tags command for the current entry."
14905 (interactive "P")
14906 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14907 (org-set-tags arg just-align)
14908 (save-excursion
14909 (unless (and (org-region-active-p)
14910 org-loop-over-headlines-in-active-region)
14911 (org-back-to-heading t))
14912 (org-set-tags arg just-align))))
14914 (defun org-set-tags-to (data)
14915 "Set the tags of the current entry to DATA, replacing the current tags.
14916 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14917 If DATA is nil or the empty string, any tags will be removed."
14918 (interactive "sTags: ")
14919 (setq data
14920 (cond
14921 ((eq data nil) "")
14922 ((equal data "") "")
14923 ((stringp data)
14924 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14925 ":"))
14926 ((listp data)
14927 (concat ":" (mapconcat 'identity data ":") ":"))))
14928 (when data
14929 (save-excursion
14930 (org-back-to-heading t)
14931 (when (looking-at org-complex-heading-regexp)
14932 (if (match-end 5)
14933 (progn
14934 (goto-char (match-beginning 5))
14935 (insert data)
14936 (delete-region (point) (point-at-eol))
14937 (org-set-tags nil 'align))
14938 (goto-char (point-at-eol))
14939 (insert " " data)
14940 (org-set-tags nil 'align)))
14941 (beginning-of-line 1)
14942 (if (looking-at ".*?\\([ \t]+\\)$")
14943 (delete-region (match-beginning 1) (match-end 1))))))
14945 (defun org-align-all-tags ()
14946 "Align the tags i all headings."
14947 (interactive)
14948 (save-excursion
14949 (or (ignore-errors (org-back-to-heading t))
14950 (outline-next-heading))
14951 (if (org-at-heading-p)
14952 (org-set-tags t)
14953 (message "No headings"))))
14955 (defvar org-indent-indentation-per-level)
14956 (defun org-set-tags (&optional arg just-align)
14957 "Set the tags for the current headline.
14958 With prefix ARG, realign all tags in headings in the current buffer.
14959 When JUST-ALIGN is non-nil, only align tags."
14960 (interactive "P")
14961 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14962 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14963 'region-start-level
14964 'region))
14965 org-loop-over-headlines-in-active-region)
14966 (org-map-entries
14967 ;; We don't use ARG and JUST-ALIGN here because these args
14968 ;; are not useful when looping over headlines.
14969 #'org-set-tags
14970 org-loop-over-headlines-in-active-region
14972 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
14973 (let ((org-setting-tags t))
14974 (if arg
14975 (save-excursion
14976 (goto-char (point-min))
14977 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14978 (while (re-search-forward org-outline-regexp-bol nil t)
14979 (org-set-tags nil t)
14980 (end-of-line)))
14981 (message "All tags realigned to column %d" org-tags-column))
14982 (let* ((current (org-get-tags-string))
14983 (col (current-column))
14984 (tags
14985 (if just-align current
14986 ;; Get a new set of tags from the user.
14987 (save-excursion
14988 (let* ((table
14989 (setq
14990 org-last-tags-completion-table
14991 (append
14992 org-tag-persistent-alist
14993 (or org-tag-alist (org-get-buffer-tags))
14994 (and
14995 org-complete-tags-always-offer-all-agenda-tags
14996 (org-global-tags-completion-table
14997 (org-agenda-files))))))
14998 (current-tags (org-split-string current ":"))
14999 (inherited-tags
15000 (nreverse (nthcdr (length current-tags)
15001 (nreverse (org-get-tags-at))))))
15002 (replace-regexp-in-string
15003 "\\([-+&]+\\|,\\)"
15005 (if (or (eq t org-use-fast-tag-selection)
15006 (and org-use-fast-tag-selection
15007 (delq nil (mapcar #'cdr table))))
15008 (org-fast-tag-selection
15009 current-tags inherited-tags table
15010 (and org-fast-tag-selection-include-todo
15011 org-todo-key-alist))
15012 (let ((org-add-colon-after-tag-completion
15013 (< 1 (length table))))
15014 (org-trim
15015 (completing-read
15016 "Tags: "
15017 #'org-tags-completion-function
15018 nil nil current 'org-tags-history))))))))))
15020 (when org-tags-sort-function
15021 (setq tags
15022 (mapconcat
15023 #'identity
15024 (sort (org-split-string tags (org-re "[^[:alnum:]_@#%]+"))
15025 org-tags-sort-function)
15026 ":")))
15028 (if (not (org-string-nw-p tags)) (setq tags "")
15029 (unless (string-match ":\\'" tags) (setq tags (concat tags ":")))
15030 (unless (string-match "\\`:" tags) (setq tags (concat ":" tags))))
15032 ;; Insert new tags at the correct column
15033 (beginning-of-line)
15034 (let ((level (if (looking-at org-outline-regexp)
15035 (- (match-end 0) (point) 1)
15036 1)))
15037 (cond
15038 ((and (equal current "") (equal tags "")))
15039 ((re-search-forward
15040 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15041 (line-end-position)
15043 (if (equal tags "") (replace-match "" t t)
15044 (goto-char (match-beginning 0))
15045 (let* ((c0 (current-column))
15046 ;; Compute offset for the case of org-indent-mode
15047 ;; active.
15048 (di (if (org-bound-and-true-p org-indent-mode)
15049 (* (1- org-indent-indentation-per-level)
15050 (1- level))
15052 (p0 (if (eq (char-before) ?*) (1+ (point)) (point)))
15053 (tc (+ org-tags-column
15054 (if (> org-tags-column 0) (- di) di)))
15055 (c1 (max (1+ c0)
15056 (if (> tc 0) tc
15057 (- (- tc) (string-width tags)))))
15058 (rpl (concat (make-string (max 0 (- c1 c0)) ?\s) tags)))
15059 (replace-match rpl t t)
15060 (when (and (not (featurep 'xemacs)) indent-tabs-mode)
15061 (tabify p0 (point))))))
15062 (t (error "Tags alignment failed"))))
15063 (org-move-to-column col))
15064 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15066 (defun org-change-tag-in-region (beg end tag off)
15067 "Add or remove TAG for each entry in the region.
15068 This works in the agenda, and also in an org-mode buffer."
15069 (interactive
15070 (list (region-beginning) (region-end)
15071 (let ((org-last-tags-completion-table
15072 (if (derived-mode-p 'org-mode)
15073 (org-uniquify
15074 (delq nil (append (org-get-buffer-tags)
15075 (org-global-tags-completion-table))))
15076 (org-global-tags-completion-table))))
15077 (org-icompleting-read
15078 "Tag: " 'org-tags-completion-function nil nil nil
15079 'org-tags-history))
15080 (progn
15081 (message "[s]et or [r]emove? ")
15082 (equal (read-char-exclusive) ?r))))
15083 (if (fboundp 'deactivate-mark) (deactivate-mark))
15084 (let ((agendap (equal major-mode 'org-agenda-mode))
15085 l1 l2 m buf pos newhead (cnt 0))
15086 (goto-char end)
15087 (setq l2 (1- (org-current-line)))
15088 (goto-char beg)
15089 (setq l1 (org-current-line))
15090 (loop for l from l1 to l2 do
15091 (org-goto-line l)
15092 (setq m (get-text-property (point) 'org-hd-marker))
15093 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15094 (and agendap m))
15095 (setq buf (if agendap (marker-buffer m) (current-buffer))
15096 pos (if agendap m (point)))
15097 (with-current-buffer buf
15098 (save-excursion
15099 (save-restriction
15100 (goto-char pos)
15101 (setq cnt (1+ cnt))
15102 (org-toggle-tag tag (if off 'off 'on))
15103 (setq newhead (org-get-heading)))))
15104 (and agendap (org-agenda-change-all-lines newhead m))))
15105 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15107 (defun org-tags-completion-function (string predicate &optional flag)
15108 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15109 (confirm (lambda (x) (stringp (car x)))))
15110 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15111 (setq s1 (match-string 1 string)
15112 s2 (match-string 2 string))
15113 (setq s1 "" s2 string))
15114 (cond
15115 ((eq flag nil)
15116 ;; try completion
15117 (setq rtn (try-completion s2 ctable confirm))
15118 (if (stringp rtn)
15119 (setq rtn
15120 (concat s1 s2 (substring rtn (length s2))
15121 (if (and org-add-colon-after-tag-completion
15122 (assoc rtn ctable))
15123 ":" ""))))
15124 rtn)
15125 ((eq flag t)
15126 ;; all-completions
15127 (all-completions s2 ctable confirm))
15128 ((eq flag 'lambda)
15129 ;; exact match?
15130 (assoc s2 ctable)))))
15132 (defun org-fast-tag-insert (kwd tags face &optional end)
15133 "Insert KDW, and the TAGS, the latter with face FACE.
15134 Also insert END."
15135 (insert (format "%-12s" (concat kwd ":"))
15136 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15137 (or end "")))
15139 (defun org-fast-tag-show-exit (flag)
15140 (save-excursion
15141 (org-goto-line 3)
15142 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15143 (replace-match ""))
15144 (when flag
15145 (end-of-line 1)
15146 (org-move-to-column (- (window-width) 19) t)
15147 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15149 (defun org-set-current-tags-overlay (current prefix)
15150 "Add an overlay to CURRENT tag with PREFIX."
15151 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15152 (if (featurep 'xemacs)
15153 (org-overlay-display org-tags-overlay (concat prefix s)
15154 'secondary-selection)
15155 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15156 (org-overlay-display org-tags-overlay (concat prefix s)))))
15158 (defvar org-last-tag-selection-key nil)
15159 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15160 "Fast tag selection with single keys.
15161 CURRENT is the current list of tags in the headline, INHERITED is the
15162 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15163 possibly with grouping information. TODO-TABLE is a similar table with
15164 TODO keywords, should these have keys assigned to them.
15165 If the keys are nil, a-z are automatically assigned.
15166 Returns the new tags string, or nil to not change the current settings."
15167 (let* ((fulltable (append table todo-table))
15168 (maxlen (apply 'max (mapcar
15169 (lambda (x)
15170 (if (stringp (car x)) (string-width (car x)) 0))
15171 fulltable)))
15172 (buf (current-buffer))
15173 (expert (eq org-fast-tag-selection-single-key 'expert))
15174 (buffer-tags nil)
15175 (fwidth (+ maxlen 3 1 3))
15176 (ncol (/ (- (window-width) 4) fwidth))
15177 (i-face 'org-done)
15178 (c-face 'org-todo)
15179 tg cnt e c char c1 c2 ntable tbl rtn
15180 ov-start ov-end ov-prefix
15181 (exit-after-next org-fast-tag-selection-single-key)
15182 (done-keywords org-done-keywords)
15183 groups ingroup intaggroup)
15184 (save-excursion
15185 (beginning-of-line 1)
15186 (if (looking-at
15187 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15188 (setq ov-start (match-beginning 1)
15189 ov-end (match-end 1)
15190 ov-prefix "")
15191 (setq ov-start (1- (point-at-eol))
15192 ov-end (1+ ov-start))
15193 (skip-chars-forward "^\n\r")
15194 (setq ov-prefix
15195 (concat
15196 (buffer-substring (1- (point)) (point))
15197 (if (> (current-column) org-tags-column)
15199 (make-string (- org-tags-column (current-column)) ?\ ))))))
15200 (move-overlay org-tags-overlay ov-start ov-end)
15201 (save-window-excursion
15202 (if expert
15203 (set-buffer (get-buffer-create " *Org tags*"))
15204 (delete-other-windows)
15205 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15206 (org-switch-to-buffer-other-window " *Org tags*"))
15207 (erase-buffer)
15208 (org-set-local 'org-done-keywords done-keywords)
15209 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15210 (org-fast-tag-insert "Current" current c-face "\n\n")
15211 (org-fast-tag-show-exit exit-after-next)
15212 (org-set-current-tags-overlay current ov-prefix)
15213 (setq tbl fulltable char ?a cnt 0)
15214 (while (setq e (pop tbl))
15215 (cond
15216 ((eq (car e) :startgroup)
15217 (push '() groups) (setq ingroup t)
15218 (unless (zerop cnt)
15219 (setq cnt 0)
15220 (insert "\n"))
15221 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15222 ((eq (car e) :endgroup)
15223 (setq ingroup nil cnt 0)
15224 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15225 ((eq (car e) :startgrouptag)
15226 (setq intaggroup t)
15227 (unless (zerop cnt)
15228 (setq cnt 0)
15229 (insert "\n"))
15230 (insert "[ "))
15231 ((eq (car e) :endgrouptag)
15232 (setq intaggroup nil cnt 0)
15233 (insert "]\n"))
15234 ((equal e '(:newline))
15235 (unless (zerop cnt)
15236 (setq cnt 0)
15237 (insert "\n")
15238 (setq e (car tbl))
15239 (while (equal (car tbl) '(:newline))
15240 (insert "\n")
15241 (setq tbl (cdr tbl)))))
15242 ((equal e '(:grouptags)) (insert " : "))
15244 (setq tg (copy-sequence (car e)) c2 nil)
15245 (if (cdr e)
15246 (setq c (cdr e))
15247 ;; automatically assign a character.
15248 (setq c1 (string-to-char
15249 (downcase (substring
15250 tg (if (= (string-to-char tg) ?@) 1 0)))))
15251 (if (or (rassoc c1 ntable) (rassoc c1 table))
15252 (while (or (rassoc char ntable) (rassoc char table))
15253 (setq char (1+ char)))
15254 (setq c2 c1))
15255 (setq c (or c2 char)))
15256 (when ingroup (push tg (car groups)))
15257 (setq tg (org-add-props tg nil 'face
15258 (cond
15259 ((not (assoc tg table))
15260 (org-get-todo-face tg))
15261 ((member tg current) c-face)
15262 ((member tg inherited) i-face))))
15263 (when (equal (caar tbl) :grouptags)
15264 (org-add-props tg nil 'face 'org-tag-group))
15265 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15266 (insert "[" c "] " tg (make-string
15267 (- fwidth 4 (length tg)) ?\ ))
15268 (push (cons tg c) ntable)
15269 (when (= (incf cnt) ncol)
15270 (insert "\n")
15271 (when (or ingroup intaggroup) (insert " "))
15272 (setq cnt 0)))))
15273 (setq ntable (nreverse ntable))
15274 (insert "\n")
15275 (goto-char (point-min))
15276 (unless expert (org-fit-window-to-buffer))
15277 (setq rtn
15278 (catch 'exit
15279 (while t
15280 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15281 (if (not groups) "no " "")
15282 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15283 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15284 (setq org-last-tag-selection-key c)
15285 (cond
15286 ((= c ?\r) (throw 'exit t))
15287 ((= c ?!)
15288 (setq groups (not groups))
15289 (goto-char (point-min))
15290 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15291 ((= c ?\C-c)
15292 (if (not expert)
15293 (org-fast-tag-show-exit
15294 (setq exit-after-next (not exit-after-next)))
15295 (setq expert nil)
15296 (delete-other-windows)
15297 (set-window-buffer (split-window-vertically) " *Org tags*")
15298 (org-switch-to-buffer-other-window " *Org tags*")
15299 (org-fit-window-to-buffer)))
15300 ((or (= c ?\C-g)
15301 (and (= c ?q) (not (rassoc c ntable))))
15302 (org-detach-overlay org-tags-overlay)
15303 (setq quit-flag t))
15304 ((= c ?\ )
15305 (setq current nil)
15306 (when exit-after-next (setq exit-after-next 'now)))
15307 ((= c ?\t)
15308 (condition-case nil
15309 (setq tg (org-icompleting-read
15310 "Tag: "
15311 (or buffer-tags
15312 (with-current-buffer buf
15313 (setq buffer-tags
15314 (org-get-buffer-tags))))))
15315 (quit (setq tg "")))
15316 (when (string-match "\\S-" tg)
15317 (add-to-list 'buffer-tags (list tg))
15318 (if (member tg current)
15319 (setq current (delete tg current))
15320 (push tg current)))
15321 (when exit-after-next (setq exit-after-next 'now)))
15322 ((setq e (rassoc c todo-table) tg (car e))
15323 (with-current-buffer buf
15324 (save-excursion (org-todo tg)))
15325 (when exit-after-next (setq exit-after-next 'now)))
15326 ((setq e (rassoc c ntable) tg (car e))
15327 (if (member tg current)
15328 (setq current (delete tg current))
15329 (loop for g in groups do
15330 (when (member tg g)
15331 (dolist (x g) (setq current (delete x current)))))
15332 (push tg current))
15333 (when exit-after-next (setq exit-after-next 'now))))
15335 ;; Create a sorted list
15336 (setq current
15337 (sort current
15338 (lambda (a b)
15339 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15340 (when (eq exit-after-next 'now) (throw 'exit t))
15341 (goto-char (point-min))
15342 (beginning-of-line 2)
15343 (delete-region (point) (point-at-eol))
15344 (org-fast-tag-insert "Current" current c-face)
15345 (org-set-current-tags-overlay current ov-prefix)
15346 (while (re-search-forward
15347 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15348 (setq tg (match-string 1))
15349 (add-text-properties
15350 (match-beginning 1) (match-end 1)
15351 (list 'face
15352 (cond
15353 ((member tg current) c-face)
15354 ((member tg inherited) i-face)
15355 (t (get-text-property (match-beginning 1) 'face))))))
15356 (goto-char (point-min)))))
15357 (org-detach-overlay org-tags-overlay)
15358 (if rtn
15359 (mapconcat 'identity current ":")
15360 nil))))
15362 (defun org-get-tags-string ()
15363 "Get the TAGS string in the current headline."
15364 (unless (org-at-heading-p t)
15365 (user-error "Not on a heading"))
15366 (save-excursion
15367 (beginning-of-line 1)
15368 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15369 (org-match-string-no-properties 1)
15370 "")))
15372 (defun org-get-tags ()
15373 "Get the list of tags specified in the current headline."
15374 (org-split-string (org-get-tags-string) ":"))
15376 (defun org-get-buffer-tags ()
15377 "Get a table of all tags used in the buffer, for completion."
15378 (org-with-wide-buffer
15379 (goto-char (point-min))
15380 (let ((tag-re (concat org-outline-regexp-bol
15381 "\\(?:.*?[ \t]\\)?"
15382 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15383 tags)
15384 (while (re-search-forward tag-re nil t)
15385 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15386 (push tag tags)))
15387 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15389 ;;;; The mapping API
15391 (defun org-map-entries (func &optional match scope &rest skip)
15392 "Call FUNC at each headline selected by MATCH in SCOPE.
15394 FUNC is a function or a lisp form. The function will be called without
15395 arguments, with the cursor positioned at the beginning of the headline.
15396 The return values of all calls to the function will be collected and
15397 returned as a list.
15399 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15400 does not need to preserve point. After evaluation, the cursor will be
15401 moved to the end of the line (presumably of the headline of the
15402 processed entry) and search continues from there. Under some
15403 circumstances, this may not produce the wanted results. For example,
15404 if you have removed (e.g. archived) the current (sub)tree it could
15405 mean that the next entry will be skipped entirely. In such cases, you
15406 can specify the position from where search should continue by making
15407 FUNC set the variable `org-map-continue-from' to the desired buffer
15408 position.
15410 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15411 Only headlines that are matched by this query will be considered during
15412 the iteration. When MATCH is nil or t, all headlines will be
15413 visited by the iteration.
15415 SCOPE determines the scope of this command. It can be any of:
15417 nil The current buffer, respecting the restriction if any
15418 tree The subtree started with the entry at point
15419 region The entries within the active region, if any
15420 region-start-level
15421 The entries within the active region, but only those at
15422 the same level than the first one.
15423 file The current buffer, without restriction
15424 file-with-archives
15425 The current buffer, and any archives associated with it
15426 agenda All agenda files
15427 agenda-with-archives
15428 All agenda files with any archive files associated with them
15429 \(file1 file2 ...)
15430 If this is a list, all files in the list will be scanned
15432 The remaining args are treated as settings for the skipping facilities of
15433 the scanner. The following items can be given here:
15435 archive skip trees with the archive tag
15436 comment skip trees with the COMMENT keyword
15437 function or Emacs Lisp form:
15438 will be used as value for `org-agenda-skip-function', so
15439 whenever the function returns a position, FUNC will not be
15440 called for that entry and search will continue from the
15441 position returned
15443 If your function needs to retrieve the tags including inherited tags
15444 at the *current* entry, you can use the value of the variable
15445 `org-scanner-tags' which will be much faster than getting the value
15446 with `org-get-tags-at'. If your function gets properties with
15447 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15448 to t around the call to `org-entry-properties' to get the same speedup.
15449 Note that if your function moves around to retrieve tags and properties at
15450 a *different* entry, you cannot use these techniques."
15451 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15452 (not (org-region-active-p)))
15453 (let* ((org-agenda-archives-mode nil) ; just to make sure
15454 (org-agenda-skip-archived-trees (memq 'archive skip))
15455 (org-agenda-skip-comment-trees (memq 'comment skip))
15456 (org-agenda-skip-function
15457 (car (org-delete-all '(comment archive) skip)))
15458 (org-tags-match-list-sublevels t)
15459 (start-level (eq scope 'region-start-level))
15460 matcher file res
15461 org-todo-keywords-for-agenda
15462 org-done-keywords-for-agenda
15463 org-todo-keyword-alist-for-agenda
15464 org-tag-alist-for-agenda
15465 todo-only)
15467 (cond
15468 ((eq match t) (setq matcher t))
15469 ((eq match nil) (setq matcher t))
15470 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15472 (save-excursion
15473 (save-restriction
15474 (cond ((eq scope 'tree)
15475 (org-back-to-heading t)
15476 (org-narrow-to-subtree)
15477 (setq scope nil))
15478 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15479 (org-region-active-p))
15480 ;; If needed, set start-level to a string like "2"
15481 (when start-level
15482 (save-excursion
15483 (goto-char (region-beginning))
15484 (unless (org-at-heading-p) (outline-next-heading))
15485 (setq start-level (org-current-level))))
15486 (narrow-to-region (region-beginning)
15487 (save-excursion
15488 (goto-char (region-end))
15489 (unless (and (bolp) (org-at-heading-p))
15490 (outline-next-heading))
15491 (point)))
15492 (setq scope nil)))
15494 (if (not scope)
15495 (progn
15496 (org-agenda-prepare-buffers
15497 (and buffer-file-name (list buffer-file-name)))
15498 (setq res (org-scan-tags func matcher todo-only start-level)))
15499 ;; Get the right scope
15500 (cond
15501 ((and scope (listp scope) (symbolp (car scope)))
15502 (setq scope (eval scope)))
15503 ((eq scope 'agenda)
15504 (setq scope (org-agenda-files t)))
15505 ((eq scope 'agenda-with-archives)
15506 (setq scope (org-agenda-files t))
15507 (setq scope (org-add-archive-files scope)))
15508 ((eq scope 'file)
15509 (setq scope (and buffer-file-name (list buffer-file-name))))
15510 ((eq scope 'file-with-archives)
15511 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15512 (org-agenda-prepare-buffers scope)
15513 (dolist (file scope)
15514 (with-current-buffer (org-find-base-buffer-visiting file)
15515 (save-excursion
15516 (save-restriction
15517 (widen)
15518 (goto-char (point-min))
15519 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15520 res)))
15522 ;;; Properties API
15524 (defconst org-special-properties
15525 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15526 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15527 "The special properties valid in Org mode.
15528 These are properties that are not defined in the property drawer,
15529 but in some other way.")
15531 (defconst org-default-properties
15532 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15533 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15534 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15535 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15536 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15537 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15538 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15539 "Some properties that are used by Org mode for various purposes.
15540 Being in this list makes sure that they are offered for completion.")
15542 (defun org--update-property-plist (key val props)
15543 "Associate KEY to VAL in alist PROPS.
15544 Modifications are made by side-effect. Return new alist."
15545 (let* ((appending (string= (substring key -1) "+"))
15546 (key (if appending (substring key 0 -1) key))
15547 (old (assoc-string key props t)))
15548 (if (not old) (cons (cons key val) props)
15549 (setcdr old (if appending (concat (cdr old) " " val) val))
15550 props)))
15552 (defun org-get-property-block (&optional beg force)
15553 "Return the (beg . end) range of the body of the property drawer.
15554 BEG is the beginning of the current subtree, or of the part
15555 before the first headline. If it is not given, it will be found.
15556 If the drawer does not exist, create it if FORCE is non-nil, or
15557 return nil."
15558 (org-with-wide-buffer
15559 (when beg (goto-char beg))
15560 (unless (org-before-first-heading-p)
15561 (let ((beg (cond (beg)
15562 ((or (not (featurep 'org-inlinetask))
15563 (org-inlinetask-in-task-p))
15564 (org-back-to-heading t))
15565 (t (org-with-limited-levels (org-back-to-heading t))))))
15566 (forward-line)
15567 (when (org-looking-at-p org-planning-line-re) (forward-line))
15568 (cond ((looking-at org-property-drawer-re)
15569 (forward-line)
15570 (cons (point) (progn (goto-char (match-end 0))
15571 (line-beginning-position))))
15572 (force
15573 (goto-char beg)
15574 (org-insert-property-drawer)
15575 (let ((pos (save-excursion (search-forward ":END:")
15576 (line-beginning-position))))
15577 (cons pos pos))))))))
15579 (defun org-at-property-p ()
15580 "Non-nil when point is inside a property drawer.
15581 See `org-property-re' for match data, if applicable."
15582 (save-excursion
15583 (beginning-of-line)
15584 (and (looking-at org-property-re)
15585 (let ((property-drawer (save-match-data (org-get-property-block))))
15586 (and property-drawer
15587 (>= (point) (car property-drawer))
15588 (< (point) (cdr property-drawer)))))))
15590 (defun org-property-action ()
15591 "Do an action on properties."
15592 (interactive)
15593 (unless (org-at-property-p) (user-error "Not at a property"))
15594 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15595 (let ((c (read-char-exclusive)))
15596 (case c
15597 (?s (call-interactively #'org-set-property))
15598 (?d (call-interactively #'org-delete-property))
15599 (?D (call-interactively #'org-delete-property-globally))
15600 (?c (call-interactively #'org-compute-property-at-point))
15601 (otherwise (user-error "No such property action %c" c)))))
15603 (defun org-inc-effort ()
15604 "Increment the value of the effort property in the current entry."
15605 (interactive)
15606 (org-set-effort nil t))
15608 (defvar org-clock-effort) ; Defined in org-clock.el.
15609 (defvar org-clock-current-task) ; Defined in org-clock.el.
15610 (defun org-set-effort (&optional value increment)
15611 "Set the effort property of the current entry.
15612 With numerical prefix arg, use the nth allowed value, 0 stands for the
15613 10th allowed value.
15615 When INCREMENT is non-nil, set the property to the next allowed value."
15616 (interactive "P")
15617 (if (equal value 0) (setq value 10))
15618 (let* ((completion-ignore-case t)
15619 (prop org-effort-property)
15620 (cur (org-entry-get nil prop))
15621 (allowed (org-property-get-allowed-values nil prop 'table))
15622 (existing (mapcar 'list (org-property-values prop)))
15623 (heading (nth 4 (org-heading-components)))
15625 (val (cond
15626 ((stringp value) value)
15627 ((and allowed (integerp value))
15628 (or (car (nth (1- value) allowed))
15629 (car (org-last allowed))))
15630 ((and allowed increment)
15631 (or (caadr (member (list cur) allowed))
15632 (user-error "Allowed effort values are not set")))
15633 (allowed
15634 (message "Select 1-9,0, [RET%s]: %s"
15635 (if cur (concat "=" cur) "")
15636 (mapconcat 'car allowed " "))
15637 (setq rpl (read-char-exclusive))
15638 (if (equal rpl ?\r)
15640 (setq rpl (- rpl ?0))
15641 (if (equal rpl 0) (setq rpl 10))
15642 (if (and (> rpl 0) (<= rpl (length allowed)))
15643 (car (nth (1- rpl) allowed))
15644 (org-completing-read "Effort: " allowed nil))))
15646 (let (org-completion-use-ido org-completion-use-iswitchb)
15647 (org-completing-read
15648 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15649 (concat "[" cur "]") "")
15650 ": ")
15651 existing nil nil "" nil cur))))))
15652 (unless (equal (org-entry-get nil prop) val)
15653 (org-entry-put nil prop val))
15654 (org-refresh-property
15655 '((effort . identity)
15656 (effort-minutes . org-duration-string-to-minutes))
15657 val)
15658 (when (string= heading org-clock-current-task)
15659 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15660 (org-clock-update-mode-line))
15661 (message "%s is now %s" prop val)))
15663 (defun org-entry-properties (&optional pom which)
15664 "Get all properties of the current entry.
15666 When POM is a buffer position, get all properties from the entry
15667 there instead.
15669 This includes the TODO keyword, the tags, time strings for
15670 deadline, scheduled, and clocking, and any additional properties
15671 defined in the entry.
15673 If WHICH is nil or `all', get all properties. If WHICH is
15674 `special' or `standard', only get that subclass. If WHICH is
15675 a string, only get that property.
15677 Return value is an alist. Keys are properties, as upcased
15678 strings."
15679 (org-with-point-at pom
15680 (when (and (derived-mode-p 'org-mode)
15681 (ignore-errors (org-back-to-heading t)))
15682 (catch 'exit
15683 (let* ((beg (point))
15684 (specific (and (stringp which) (upcase which)))
15685 (which (cond ((not specific) which)
15686 ((member specific org-special-properties) 'special)
15687 (t 'standard)))
15688 props)
15689 ;; Get the special properties, like TODO and TAGS.
15690 (when (memq which '(nil all special))
15691 (when (or (not specific) (string= specific "CLOCKSUM"))
15692 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15693 (when clocksum
15694 (push (cons "CLOCKSUM"
15695 (org-columns-number-to-string
15696 (/ (float clocksum) 60.) 'add_times))
15697 props)))
15698 (when specific (throw 'exit props)))
15699 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15700 (let ((clocksumt (get-text-property (point)
15701 :org-clock-minutes-today)))
15702 (when clocksumt
15703 (push (cons "CLOCKSUM_T"
15704 (org-columns-number-to-string
15705 (/ (float clocksumt) 60.) 'add_times))
15706 props)))
15707 (when specific (throw 'exit props)))
15708 (when (or (not specific) (string= specific "ITEM"))
15709 (when (looking-at org-complex-heading-regexp)
15710 (push (cons "ITEM"
15711 (concat
15712 (org-match-string-no-properties 1)
15713 (let ((title (org-match-string-no-properties 4)))
15714 (when (org-string-nw-p title)
15715 (concat " " (org-remove-tabs title))))))
15716 props))
15717 (when specific (throw 'exit props)))
15718 (when (or (not specific) (string= specific "TODO"))
15719 (let ((case-fold-search nil))
15720 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15721 (push (cons "TODO" (org-match-string-no-properties 2)) props)))
15722 (when specific (throw 'exit props)))
15723 (when (or (not specific) (string= specific "PRIORITY"))
15724 (push (cons "PRIORITY"
15725 (if (looking-at org-priority-regexp)
15726 (org-match-string-no-properties 2)
15727 (char-to-string org-default-priority)))
15728 props)
15729 (when specific (throw 'exit props)))
15730 (when (or (not specific) (string= specific "FILE"))
15731 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15732 props)
15733 (when specific (throw 'exit props)))
15734 (when (or (not specific) (string= specific "TAGS"))
15735 (let ((value (org-string-nw-p (org-get-tags-string))))
15736 (when value (push (cons "TAGS" value) props)))
15737 (when specific (throw 'exit props)))
15738 (when (or (not specific) (string= specific "ALLTAGS"))
15739 (let ((value (org-get-tags-at)))
15740 (when value
15741 (push (cons "ALLTAGS"
15742 (format ":%s:" (mapconcat #'identity value ":")))
15743 props)))
15744 (when specific (throw 'exit props)))
15745 (when (or (not specific) (string= specific "BLOCKED"))
15746 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15747 (when specific (throw 'exit props)))
15748 (when (or (not specific)
15749 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15750 (forward-line)
15751 (when (org-looking-at-p org-planning-line-re)
15752 (end-of-line)
15753 (let ((bol (line-beginning-position))
15754 ;; Backward compatibility: time keywords used to
15755 ;; be configurable (before 8.3). Make sure we
15756 ;; get the correct keyword.
15757 (key-assoc `(("CLOSED" . ,org-closed-string)
15758 ("DEADLINE" . ,org-deadline-string)
15759 ("SCHEDULED" . ,org-scheduled-string))))
15760 (dolist (pair (if specific (list (assoc specific key-assoc))
15761 key-assoc))
15762 (save-excursion
15763 (when (search-backward (cdr pair) bol t)
15764 (goto-char (match-end 0))
15765 (skip-chars-forward " \t")
15766 (and (looking-at org-ts-regexp-both)
15767 (push (cons (car pair)
15768 (org-match-string-no-properties 0))
15769 props)))))))
15770 (when specific (throw 'exit props)))
15771 (when (or (not specific)
15772 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15773 (let ((find-ts
15774 (lambda (end ts)
15775 (let ((regexp (cond
15776 ((string= specific "TIMESTAMP")
15777 org-ts-regexp)
15778 ((string= specific "TIMESTAMP_IA")
15779 org-ts-regexp-inactive)
15780 ((assoc "TIMESTAMP_IA" ts)
15781 org-ts-regexp)
15782 ((assoc "TIMESTAMP" ts)
15783 org-ts-regexp-inactive)
15784 (t org-ts-regexp-both))))
15785 (catch 'next
15786 (while (re-search-forward regexp end t)
15787 (backward-char)
15788 (let ((object (org-element-context)))
15789 ;; Accept to match timestamps in node
15790 ;; properties, too.
15791 (when (memq (org-element-type object)
15792 '(node-property timestamp))
15793 (let ((type
15794 (org-element-property :type object)))
15795 (cond
15796 ((and (memq type '(active active-range))
15797 (not (equal specific "TIMESTAMP_IA")))
15798 (unless (assoc "TIMESTAMP" ts)
15799 (push (cons "TIMESTAMP"
15800 (org-element-property
15801 :raw-value object))
15803 (when specific (throw 'exit ts))))
15804 ((and (memq type '(inactive inactive-range))
15805 (not (string= specific "TIMESTAMP")))
15806 (unless (assoc "TIMESTAMP_IA" ts)
15807 (push (cons "TIMESTAMP_IA"
15808 (org-element-property
15809 :raw-value object))
15811 (when specific (throw 'exit ts))))))
15812 ;; Both timestamp types are found,
15813 ;; move to next part.
15814 (when (= (length ts) 2) (throw 'next ts)))))
15815 ts)))))
15816 (goto-char beg)
15817 ;; First look for timestamps within headline.
15818 (let ((ts (funcall find-ts (line-end-position) nil)))
15819 (if (= (length ts) 2) (setq props (nconc ts props))
15820 (forward-line)
15821 ;; Then find timestamps in the section, skipping
15822 ;; planning line.
15823 (when (org-looking-at-p org-planning-line-re)
15824 (forward-line))
15825 (let ((end (save-excursion (outline-next-heading))))
15826 (setq props (nconc (funcall find-ts end ts) props))))))))
15827 ;; Get the standard properties, like :PROP:.
15828 (when (memq which '(nil all standard))
15829 ;; If we are looking after a specific property, delegate
15830 ;; to `org-entry-get', which is faster. However, make an
15831 ;; exception for "CATEGORY", since it can be also set
15832 ;; through keywords (i.e. #+CATEGORY).
15833 (if (and specific (not (equal specific "CATEGORY")))
15834 (let ((value (org-entry-get beg specific nil t)))
15835 (throw 'exit (and value (list (cons specific value)))))
15836 (let ((range (org-get-property-block beg)))
15837 (when range
15838 (let ((end (cdr range)) seen-base)
15839 (goto-char (car range))
15840 ;; Unlike to `org--update-property-plist', we
15841 ;; handle the case where base values is found
15842 ;; after its extension. We also forbid standard
15843 ;; properties to be named as special properties.
15844 (while (re-search-forward org-property-re end t)
15845 (let* ((key (upcase (org-match-string-no-properties 2)))
15846 (extendp (org-string-match-p "\\+\\'" key))
15847 (key-base (if extendp (substring key 0 -1) key))
15848 (value (org-match-string-no-properties 3)))
15849 (cond
15850 ((member-ignore-case key-base org-special-properties))
15851 (extendp
15852 (setq props
15853 (org--update-property-plist key value props)))
15854 ((member key seen-base))
15855 (t (push key seen-base)
15856 (let ((p (assoc-string key props t)))
15857 (if p (setcdr p (concat value " " (cdr p)))
15858 (push (cons key value) props))))))))))))
15859 (unless (assoc "CATEGORY" props)
15860 (push (cons "CATEGORY" (org-get-category beg)) props)
15861 (when (string= specific "CATEGORY") (throw 'exit props)))
15862 ;; Return value.
15863 props)))))
15865 (defun org-property--local-values (property literal-nil)
15866 "Return value for PROPERTY in current entry.
15867 Value is a list whose care is the base value for PROPERTY and cdr
15868 a list of accumulated values. Return nil if neither is found in
15869 the entry. Also return nil when PROPERTY is set to \"nil\",
15870 unless LITERAL-NIL is non-nil."
15871 (let ((range (org-get-property-block)))
15872 (when range
15873 (goto-char (car range))
15874 (let* ((case-fold-search t)
15875 (end (cdr range))
15876 (value
15877 ;; Base value.
15878 (save-excursion
15879 (let ((v (and (re-search-forward
15880 (org-re-property property nil t) end t)
15881 (org-match-string-no-properties 3))))
15882 (list (if literal-nil v (org-not-nil v)))))))
15883 ;; Find additional values.
15884 (let* ((property+ (org-re-property (concat property "+") nil t)))
15885 (while (re-search-forward property+ end t)
15886 (push (org-match-string-no-properties 3) value)))
15887 ;; Return final values.
15888 (and (not (equal value '(nil))) (nreverse value))))))
15890 (defun org-entry-get (pom property &optional inherit literal-nil)
15891 "Get value of PROPERTY for entry or content at point-or-marker POM.
15893 If INHERIT is non-nil and the entry does not have the property,
15894 then also check higher levels of the hierarchy. If INHERIT is
15895 the symbol `selective', use inheritance only if the setting in
15896 `org-use-property-inheritance' selects PROPERTY for inheritance.
15898 If the property is present but empty, the return value is the
15899 empty string. If the property is not present at all, nil is
15900 returned. In any other case, return the value as a string.
15901 Search is case-insensitive.
15903 If LITERAL-NIL is set, return the string value \"nil\" as
15904 a string, do not interpret it as the list atom nil. This is used
15905 for inheritance when a \"nil\" value can supersede a non-nil
15906 value higher up the hierarchy."
15907 (org-with-point-at pom
15908 (cond
15909 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15910 ;; We need a special property. Use `org-entry-properties' to
15911 ;; retrieve it, but specify the wanted property.
15912 (cdr (assoc-string property (org-entry-properties nil property))))
15913 ((and inherit
15914 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15915 (org-entry-get-with-inheritance property literal-nil))
15917 (let* ((local (org-property--local-values property literal-nil))
15918 (value (and local (mapconcat #'identity (delq nil local) " "))))
15919 (if literal-nil value (org-not-nil value)))))))
15921 (defun org-property-or-variable-value (var &optional inherit)
15922 "Check if there is a property fixing the value of VAR.
15923 If yes, return this value. If not, return the current value of the variable."
15924 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15925 (if (and prop (stringp prop) (string-match "\\S-" prop))
15926 (read prop)
15927 (symbol-value var))))
15929 (defun org-entry-delete (pom property)
15930 "Delete PROPERTY from entry at point-or-marker POM.
15931 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15932 non-nil when a property was removed."
15933 (unless (member property org-special-properties)
15934 (org-with-point-at pom
15935 (let ((range (org-get-property-block)))
15936 (when range
15937 (let* ((begin (car range))
15938 (origin (cdr range))
15939 (end (copy-marker origin))
15940 (re (org-re-property
15941 (concat (regexp-quote property) "\\+?") t t)))
15942 (goto-char begin)
15943 (while (re-search-forward re end t)
15944 (delete-region (match-beginning 0) (line-beginning-position 2)))
15945 ;; If drawer is empty, remove it altogether.
15946 (when (= begin end)
15947 (delete-region (line-beginning-position 0)
15948 (line-beginning-position 2)))
15949 ;; Return non-nil if some property was removed.
15950 (prog1 (/= end origin) (set-marker end nil))))))))
15952 ;; Multi-values properties are properties that contain multiple values
15953 ;; These values are assumed to be single words, separated by whitespace.
15954 (defun org-entry-add-to-multivalued-property (pom property value)
15955 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15956 (let* ((old (org-entry-get pom property))
15957 (values (and old (org-split-string old "[ \t]"))))
15958 (setq value (org-entry-protect-space value))
15959 (unless (member value values)
15960 (setq values (append values (list value)))
15961 (org-entry-put pom property
15962 (mapconcat 'identity values " ")))))
15964 (defun org-entry-remove-from-multivalued-property (pom property value)
15965 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15966 (let* ((old (org-entry-get pom property))
15967 (values (and old (org-split-string old "[ \t]"))))
15968 (setq value (org-entry-protect-space value))
15969 (when (member value values)
15970 (setq values (delete value values))
15971 (org-entry-put pom property
15972 (mapconcat 'identity values " ")))))
15974 (defun org-entry-member-in-multivalued-property (pom property value)
15975 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15976 (let* ((old (org-entry-get pom property))
15977 (values (and old (org-split-string old "[ \t]"))))
15978 (setq value (org-entry-protect-space value))
15979 (member value values)))
15981 (defun org-entry-get-multivalued-property (pom property)
15982 "Return a list of values in a multivalued property."
15983 (let* ((value (org-entry-get pom property))
15984 (values (and value (org-split-string value "[ \t]"))))
15985 (mapcar 'org-entry-restore-space values)))
15987 (defun org-entry-put-multivalued-property (pom property &rest values)
15988 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15989 VALUES should be a list of strings. Spaces will be protected."
15990 (org-entry-put pom property
15991 (mapconcat 'org-entry-protect-space values " "))
15992 (let* ((value (org-entry-get pom property))
15993 (values (and value (org-split-string value "[ \t]"))))
15994 (mapcar 'org-entry-restore-space values)))
15996 (defun org-entry-protect-space (s)
15997 "Protect spaces and newline in string S."
15998 (while (string-match " " s)
15999 (setq s (replace-match "%20" t t s)))
16000 (while (string-match "\n" s)
16001 (setq s (replace-match "%0A" t t s)))
16004 (defun org-entry-restore-space (s)
16005 "Restore spaces and newline in string S."
16006 (while (string-match "%20" s)
16007 (setq s (replace-match " " t t s)))
16008 (while (string-match "%0A" s)
16009 (setq s (replace-match "\n" t t s)))
16012 (defvar org-entry-property-inherited-from (make-marker)
16013 "Marker pointing to the entry from where a property was inherited.
16014 Each call to `org-entry-get-with-inheritance' will set this marker to the
16015 location of the entry where the inheritance search matched. If there was
16016 no match, the marker will point nowhere.
16017 Note that also `org-entry-get' calls this function, if the INHERIT flag
16018 is set.")
16020 (defun org-entry-get-with-inheritance (property &optional literal-nil)
16021 "Get PROPERTY of entry or content at point, search higher levels if needed.
16022 The search will stop at the first ancestor which has the property defined.
16023 If the value found is \"nil\", return nil to show that the property
16024 should be considered as undefined (this is the meaning of nil here).
16025 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16026 (move-marker org-entry-property-inherited-from nil)
16027 (org-with-wide-buffer
16028 (let (value)
16029 (catch 'exit
16030 (while t
16031 (let ((v (org-property--local-values property literal-nil)))
16032 (when v
16033 (setq value
16034 (concat (mapconcat #'identity (delq nil v) " ")
16035 (and value " ")
16036 value)))
16037 (cond
16038 ((car v)
16039 (org-back-to-heading t)
16040 (move-marker org-entry-property-inherited-from (point))
16041 (throw 'exit nil))
16042 ((org-up-heading-safe))
16044 (let ((global
16045 (cdr (or (assoc-string property org-file-properties t)
16046 (assoc-string property org-global-properties t)
16047 (assoc-string property org-global-properties-fixed t)))))
16048 (cond ((not global))
16049 (value (setq value (concat global " " value)))
16050 (t (setq value global))))
16051 (throw 'exit nil))))))
16052 (if literal-nil value (org-not-nil value)))))
16054 (defvar org-property-changed-functions nil
16055 "Hook called when the value of a property has changed.
16056 Each hook function should accept two arguments, the name of the property
16057 and the new value.")
16059 (defun org-entry-put (pom property value)
16060 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16062 If the value is nil, it is converted to the empty string. If
16063 it is not a string, an error is raised.
16065 PROPERTY can be any regular property (see
16066 `org-special-properties'). It can also be \"TODO\",
16067 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16069 For the last two properties, VALUE may have any of the special
16070 values \"earlier\" and \"later\". The function then increases or
16071 decreases scheduled or deadline date by one day."
16072 (cond ((null value) (setq value ""))
16073 ((not (stringp value)) (error "Properties values should be strings")))
16074 (org-with-point-at pom
16075 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16076 (org-back-to-heading t)
16077 (org-with-limited-levels (org-back-to-heading t)))
16078 (let ((beg (point)))
16079 (cond
16080 ((equal property "TODO")
16081 (cond ((not (org-string-nw-p value)) (setq value 'none))
16082 ((not (member value org-todo-keywords-1))
16083 (user-error "\"%s\" is not a valid TODO state" value)))
16084 (org-todo value)
16085 (org-set-tags nil 'align))
16086 ((equal property "PRIORITY")
16087 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16088 (org-set-tags nil 'align))
16089 ((equal property "SCHEDULED")
16090 (forward-line)
16091 (if (and (org-looking-at-p org-planning-line-re)
16092 (re-search-forward
16093 org-scheduled-time-regexp (line-end-position) t))
16094 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16095 ((string= value "later") (org-timestamp-change 1 'day))
16096 ((string= value "") (org-schedule '(4)))
16097 (t (org-schedule nil value)))
16098 (if (member value '("earlier" "later" ""))
16099 (call-interactively #'org-schedule)
16100 (org-schedule nil value))))
16101 ((equal property "DEADLINE")
16102 (forward-line)
16103 (if (and (org-looking-at-p org-planning-line-re)
16104 (re-search-forward
16105 org-deadline-time-regexp (line-end-position) t))
16106 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16107 ((string= value "later") (org-timestamp-change 1 'day))
16108 ((string= value "") (org-deadline '(4)))
16109 (t (org-deadline nil value)))
16110 (if (member value '("earlier" "later" ""))
16111 (call-interactively #'org-deadline)
16112 (org-deadline nil value))))
16113 ((member property org-special-properties)
16114 (error "The %s property cannot be set with `org-entry-put'" property))
16116 (let* ((range (org-get-property-block beg 'force))
16117 (end (cdr range))
16118 (case-fold-search t))
16119 (goto-char (car range))
16120 (if (re-search-forward (org-re-property property nil t) end t)
16121 (progn (delete-region (match-beginning 0) (match-end 0))
16122 (goto-char (match-beginning 0)))
16123 (goto-char end)
16124 (insert "\n")
16125 (backward-char))
16126 (insert ":" property ":")
16127 (when value (insert " " value))
16128 (org-indent-line)))))
16129 (run-hook-with-args 'org-property-changed-functions property value)))
16131 (defun org-buffer-property-keys (&optional specials defaults columns)
16132 "Get all property keys in the current buffer.
16134 When SPECIALS is non-nil, also list the special properties that
16135 reflect things like tags and TODO state.
16137 When DEFAULTS is non-nil, also include properties that has
16138 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16139 DESCRIPTION, LOCATION, and LOGGING and others.
16141 When COLUMNS in non-nil, also include property names given in
16142 COLUMN formats in the current buffer."
16143 (let ((case-fold-search t)
16144 (props (append
16145 (and specials org-special-properties)
16146 (and defaults (cons org-effort-property org-default-properties))
16147 nil)))
16148 (org-with-wide-buffer
16149 (goto-char (point-min))
16150 (while (re-search-forward org-property-start-re nil t)
16151 (let ((range (org-get-property-block)))
16152 (catch 'skip
16153 (unless range
16154 (when (and (not (org-before-first-heading-p))
16155 (y-or-n-p (format "Malformed drawer at %d, repair?"
16156 (line-beginning-position))))
16157 (org-get-property-block nil t))
16158 (throw 'skip nil))
16159 (goto-char (car range))
16160 (let ((begin (car range))
16161 (end (cdr range)))
16162 ;; Make sure that found property block is not located
16163 ;; before current point, as it would generate an infloop.
16164 ;; It can happen, for example, in the following
16165 ;; situation:
16167 ;; * Headline
16168 ;; :PROPERTIES:
16169 ;; ...
16170 ;; :END:
16171 ;; *************** Inlinetask
16172 ;; #+BEGIN_EXAMPLE
16173 ;; :PROPERTIES:
16174 ;; #+END_EXAMPLE
16176 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16177 (while (< (point) end)
16178 (let ((p (progn (looking-at org-property-re)
16179 (org-match-string-no-properties 2))))
16180 ;; Only add true property name, not extension symbol.
16181 (add-to-list 'props
16182 (if (not (org-string-match-p "\\+\\'" p)) p
16183 (substring p 0 -1))))
16184 (forward-line))))
16185 (outline-next-heading)))
16186 (when columns
16187 (goto-char (point-min))
16188 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16189 (let ((element (org-element-at-point)))
16190 (when (memq (org-element-type element) '(keyword node-property))
16191 (let ((value (org-element-property :value element))
16192 (start 0))
16193 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16194 (setq start (match-end 0))
16195 (let ((p (org-match-string-no-properties 1 value)))
16196 (unless (member-ignore-case p org-special-properties)
16197 (add-to-list 'props p))))))))))
16198 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16200 (defun org-property-values (key)
16201 "List all non-nil values of property KEY in current buffer."
16202 (org-with-wide-buffer
16203 (goto-char (point-min))
16204 (let ((case-fold-search t)
16205 (re (org-re-property key))
16206 values)
16207 (while (re-search-forward re nil t)
16208 (add-to-list 'values (org-entry-get (point) key)))
16209 values)))
16211 (defun org-insert-property-drawer ()
16212 "Insert a property drawer into the current entry."
16213 (org-with-wide-buffer
16214 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16215 (org-back-to-heading t)
16216 (org-with-limited-levels (org-back-to-heading t)))
16217 (forward-line)
16218 (when (org-looking-at-p org-planning-line-re) (forward-line))
16219 (unless (org-looking-at-p org-property-drawer-re)
16220 (let ((inhibit-read-only t))
16221 (unless (bolp) (insert "\n"))
16222 (let ((begin (point)))
16223 (insert ":PROPERTIES:\n:END:\n")
16224 (org-indent-region begin (point)))))))
16226 (defun org-insert-drawer (&optional arg drawer)
16227 "Insert a drawer at point.
16229 When optional argument ARG is non-nil, insert a property drawer.
16231 Optional argument DRAWER, when non-nil, is a string representing
16232 drawer's name. Otherwise, the user is prompted for a name.
16234 If a region is active, insert the drawer around that region
16235 instead.
16237 Point is left between drawer's boundaries."
16238 (interactive "P")
16239 (let* ((drawer (if arg "PROPERTIES"
16240 (or drawer (read-from-minibuffer "Drawer: ")))))
16241 (cond
16242 ;; With C-u, fall back on `org-insert-property-drawer'
16243 (arg (org-insert-property-drawer))
16244 ;; Check validity of suggested drawer's name.
16245 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16246 (user-error "Invalid drawer name"))
16247 ;; With an active region, insert a drawer at point.
16248 ((not (org-region-active-p))
16249 (progn
16250 (unless (bolp) (insert "\n"))
16251 (insert (format ":%s:\n\n:END:\n" drawer))
16252 (forward-line -2)))
16253 ;; Otherwise, insert the drawer at point
16255 (let ((rbeg (region-beginning))
16256 (rend (copy-marker (region-end))))
16257 (unwind-protect
16258 (progn
16259 (goto-char rbeg)
16260 (beginning-of-line)
16261 (when (save-excursion
16262 (re-search-forward org-outline-regexp-bol rend t))
16263 (user-error "Drawers cannot contain headlines"))
16264 ;; Position point at the beginning of the first
16265 ;; non-blank line in region. Insert drawer's opening
16266 ;; there, then indent it.
16267 (org-skip-whitespace)
16268 (beginning-of-line)
16269 (insert ":" drawer ":\n")
16270 (forward-line -1)
16271 (indent-for-tab-command)
16272 ;; Move point to the beginning of the first blank line
16273 ;; after the last non-blank line in region. Insert
16274 ;; drawer's closing, then indent it.
16275 (goto-char rend)
16276 (skip-chars-backward " \r\t\n")
16277 (insert "\n:END:")
16278 (deactivate-mark t)
16279 (indent-for-tab-command)
16280 (unless (eolp) (insert "\n")))
16281 ;; Clear marker, whatever the outcome of insertion is.
16282 (set-marker rend nil)))))))
16284 (defvar org-property-set-functions-alist nil
16285 "Property set function alist.
16286 Each entry should have the following format:
16288 (PROPERTY . READ-FUNCTION)
16290 The read function will be called with the same argument as
16291 `org-completing-read'.")
16293 (defun org-set-property-function (property)
16294 "Get the function that should be used to set PROPERTY.
16295 This is computed according to `org-property-set-functions-alist'."
16296 (or (cdr (assoc property org-property-set-functions-alist))
16297 'org-completing-read))
16299 (defun org-read-property-value (property)
16300 "Read PROPERTY value from user."
16301 (let* ((completion-ignore-case t)
16302 (allowed (org-property-get-allowed-values nil property 'table))
16303 (cur (org-entry-get nil property))
16304 (prompt (concat property " value"
16305 (if (and cur (string-match "\\S-" cur))
16306 (concat " [" cur "]") "") ": "))
16307 (set-function (org-set-property-function property))
16308 (val (if allowed
16309 (funcall set-function prompt allowed nil
16310 (not (get-text-property 0 'org-unrestricted
16311 (caar allowed))))
16312 (let (org-completion-use-ido org-completion-use-iswitchb)
16313 (funcall set-function prompt
16314 (mapcar 'list (org-property-values property))
16315 nil nil "" nil cur)))))
16316 (org-trim val)))
16318 (defvar org-last-set-property nil)
16319 (defvar org-last-set-property-value nil)
16320 (defun org-read-property-name ()
16321 "Read a property name."
16322 (let ((completion-ignore-case t)
16323 (default-prop (or (and (org-at-property-p)
16324 (org-match-string-no-properties 2))
16325 org-last-set-property)))
16326 (org-completing-read
16327 (concat "Property"
16328 (if default-prop (concat " [" default-prop "]") "")
16329 ": ")
16330 (mapcar #'list (org-buffer-property-keys nil t t))
16331 nil nil nil nil default-prop)))
16333 (defun org-set-property-and-value (use-last)
16334 "Allow to set [PROPERTY]: [value] direction from prompt.
16335 When use-default, don't even ask, just use the last
16336 \"[PROPERTY]: [value]\" string from the history."
16337 (interactive "P")
16338 (let* ((completion-ignore-case t)
16339 (pv (or (and use-last org-last-set-property-value)
16340 (org-completing-read
16341 "Enter a \"[Property]: [value]\" pair: "
16342 nil nil nil nil nil
16343 org-last-set-property-value)))
16344 prop val)
16345 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16346 (setq prop (match-string 1 pv)
16347 val (match-string 2 pv))
16348 (org-set-property prop val))))
16350 (defun org-set-property (property value)
16351 "In the current entry, set PROPERTY to VALUE.
16352 When called interactively, this will prompt for a property name, offering
16353 completion on existing and default properties. And then it will prompt
16354 for a value, offering completion either on allowed values (via an inherited
16355 xxx_ALL property) or on existing values in other instances of this property
16356 in the current file."
16357 (interactive (list nil nil))
16358 (let* ((property (or property (org-read-property-name)))
16359 (value (or value (org-read-property-value property)))
16360 (fn (cdr (assoc property org-properties-postprocess-alist))))
16361 (setq org-last-set-property property)
16362 (setq org-last-set-property-value (concat property ": " value))
16363 ;; Possibly postprocess the inserted value:
16364 (when fn (setq value (funcall fn value)))
16365 (unless (equal (org-entry-get nil property) value)
16366 (org-entry-put nil property value))))
16368 (defun org-find-property (property &optional value)
16369 "Find first entry in buffer that sets PROPERTY.
16371 When optional argument VALUE is non-nil, only consider an entry
16372 if it contains PROPERTY set to this value. If PROPERTY should be
16373 explicitly set to nil, use string \"nil\" for VALUE.
16375 Return position where the entry begins, or nil if there is no
16376 such entry. If narrowing is in effect, only search the visible
16377 part of the buffer."
16378 (save-excursion
16379 (goto-char (point-min))
16380 (let ((case-fold-search t)
16381 (re (org-re-property property nil (not value) value)))
16382 (catch 'exit
16383 (while (re-search-forward re nil t)
16384 (when (if value (org-at-property-p)
16385 (org-entry-get (point) property nil t))
16386 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16388 (defun org-delete-property (property)
16389 "In the current entry, delete PROPERTY."
16390 (interactive
16391 (let* ((completion-ignore-case t)
16392 (cat (org-entry-get (point) "CATEGORY"))
16393 (props0 (org-entry-properties nil 'standard))
16394 (props (if cat props0
16395 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16396 (prop (if (< 1 (length props))
16397 (org-icompleting-read "Property: " props nil t)
16398 (caar props))))
16399 (list prop)))
16400 (if (not property)
16401 (message "No property to delete in this entry")
16402 (org-entry-delete nil property)
16403 (message "Property \"%s\" deleted" property)))
16405 (defun org-delete-property-globally (property)
16406 "Remove PROPERTY globally, from all entries.
16407 This function ignores narrowing, if any."
16408 (interactive
16409 (let* ((completion-ignore-case t)
16410 (prop (org-icompleting-read
16411 "Globally remove property: "
16412 (mapcar #'list (org-buffer-property-keys)))))
16413 (list prop)))
16414 (org-with-wide-buffer
16415 (goto-char (point-min))
16416 (let ((count 0)
16417 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16418 (while (re-search-forward re nil t)
16419 (when (org-entry-delete (point) property) (incf count)))
16420 (message "Property \"%s\" removed from %d entries" property count))))
16422 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16424 (defun org-compute-property-at-point ()
16425 "Compute the property at point.
16426 This looks for an enclosing column format, extracts the operator and
16427 then applies it to the property in the column format's scope."
16428 (interactive)
16429 (unless (org-at-property-p)
16430 (user-error "Not at a property"))
16431 (let ((prop (org-match-string-no-properties 2)))
16432 (org-columns-get-format-and-top-level)
16433 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16434 (user-error "No operator defined for property %s" prop))
16435 (org-columns-compute prop)))
16437 (defvar org-property-allowed-value-functions nil
16438 "Hook for functions supplying allowed values for a specific property.
16439 The functions must take a single argument, the name of the property, and
16440 return a flat list of allowed values. If \":ETC\" is one of
16441 the values, this means that these values are intended as defaults for
16442 completion, but that other values should be allowed too.
16443 The functions must return nil if they are not responsible for this
16444 property.")
16446 (defun org-property-get-allowed-values (pom property &optional table)
16447 "Get allowed values for the property PROPERTY.
16448 When TABLE is non-nil, return an alist that can directly be used for
16449 completion."
16450 (let (vals)
16451 (cond
16452 ((equal property "TODO")
16453 (setq vals (org-with-point-at pom
16454 (append org-todo-keywords-1 '("")))))
16455 ((equal property "PRIORITY")
16456 (let ((n org-lowest-priority))
16457 (while (>= n org-highest-priority)
16458 (push (char-to-string n) vals)
16459 (setq n (1- n)))))
16460 ((equal property "CATEGORY"))
16461 ((member property org-special-properties))
16462 ((setq vals (run-hook-with-args-until-success
16463 'org-property-allowed-value-functions property)))
16465 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16466 (when (and vals (string-match "\\S-" vals))
16467 (setq vals (car (read-from-string (concat "(" vals ")"))))
16468 (setq vals (mapcar (lambda (x)
16469 (cond ((stringp x) x)
16470 ((numberp x) (number-to-string x))
16471 ((symbolp x) (symbol-name x))
16472 (t "???")))
16473 vals)))))
16474 (when (member ":ETC" vals)
16475 (setq vals (remove ":ETC" vals))
16476 (org-add-props (car vals) '(org-unrestricted t)))
16477 (if table (mapcar 'list vals) vals)))
16479 (defun org-property-previous-allowed-value (&optional previous)
16480 "Switch to the next allowed value for this property."
16481 (interactive)
16482 (org-property-next-allowed-value t))
16484 (defun org-property-next-allowed-value (&optional previous)
16485 "Switch to the next allowed value for this property."
16486 (interactive)
16487 (unless (org-at-property-p)
16488 (user-error "Not at a property"))
16489 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16490 (key (match-string 2))
16491 (value (match-string 3))
16492 (allowed (or (org-property-get-allowed-values (point) key)
16493 (and (member value '("[ ]" "[-]" "[X]"))
16494 '("[ ]" "[X]"))))
16495 (heading (save-match-data (nth 4 (org-heading-components))))
16496 nval)
16497 (unless allowed
16498 (user-error "Allowed values for this property have not been defined"))
16499 (if previous (setq allowed (reverse allowed)))
16500 (if (member value allowed)
16501 (setq nval (car (cdr (member value allowed)))))
16502 (setq nval (or nval (car allowed)))
16503 (if (equal nval value)
16504 (user-error "Only one allowed value for this property"))
16505 (org-at-property-p)
16506 (replace-match (concat " :" key ": " nval) t t)
16507 (org-indent-line)
16508 (beginning-of-line 1)
16509 (skip-chars-forward " \t")
16510 (when (equal prop org-effort-property)
16511 (org-refresh-property
16512 '((effort . identity)
16513 (effort-minutes . org-duration-string-to-minutes))
16514 nval)
16515 (when (string= org-clock-current-task heading)
16516 (setq org-clock-effort nval)
16517 (org-clock-update-mode-line)))
16518 (run-hook-with-args 'org-property-changed-functions key nval)))
16520 (defun org-find-olp (path &optional this-buffer)
16521 "Return a marker pointing to the entry at outline path OLP.
16522 If anything goes wrong, throw an error.
16523 You can wrap this call to catch the error like this:
16525 (condition-case msg
16526 (org-mobile-locate-entry (match-string 4))
16527 (error (nth 1 msg)))
16529 The return value will then be either a string with the error message,
16530 or a marker if everything is OK.
16532 If THIS-BUFFER is set, the outline path does not contain a file,
16533 only headings."
16534 (let* ((file (if this-buffer buffer-file-name (pop path)))
16535 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16536 (level 1)
16537 (lmin 1)
16538 (lmax 1)
16539 limit re end found pos heading cnt flevel)
16540 (unless buffer (error "File not found :%s" file))
16541 (with-current-buffer buffer
16542 (save-excursion
16543 (save-restriction
16544 (widen)
16545 (setq limit (point-max))
16546 (goto-char (point-min))
16547 (dolist (heading path)
16548 (setq re (format org-complex-heading-regexp-format
16549 (regexp-quote heading)))
16550 (setq cnt 0 pos (point))
16551 (while (re-search-forward re end t)
16552 (setq level (- (match-end 1) (match-beginning 1)))
16553 (if (and (>= level lmin) (<= level lmax))
16554 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16555 (when (= cnt 0) (error "Heading not found on level %d: %s"
16556 lmax heading))
16557 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16558 lmax heading))
16559 (goto-char found)
16560 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16561 (setq end (save-excursion (org-end-of-subtree t t))))
16562 (when (org-at-heading-p)
16563 (point-marker)))))))
16565 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16566 "Find node HEADING in BUFFER.
16567 Return a marker to the heading if it was found, or nil if not.
16568 If POS-ONLY is set, return just the position instead of a marker.
16570 The heading text must match exact, but it may have a TODO keyword,
16571 a priority cookie and tags in the standard locations."
16572 (with-current-buffer (or buffer (current-buffer))
16573 (save-excursion
16574 (save-restriction
16575 (widen)
16576 (goto-char (point-min))
16577 (let (case-fold-search)
16578 (if (re-search-forward
16579 (format org-complex-heading-regexp-format
16580 (regexp-quote heading)) nil t)
16581 (if pos-only
16582 (match-beginning 0)
16583 (move-marker (make-marker) (match-beginning 0)))))))))
16585 (defun org-find-exact-heading-in-directory (heading &optional dir)
16586 "Find Org node headline HEADING in all .org files in directory DIR.
16587 When the target headline is found, return a marker to this location."
16588 (let ((files (directory-files (or dir default-directory)
16589 t "\\`[^.#].*\\.org\\'"))
16590 visiting m buffer)
16591 (catch 'found
16592 (dolist (file files)
16593 (message "trying %s" file)
16594 (setq visiting (org-find-base-buffer-visiting file))
16595 (setq buffer (or visiting (find-file-noselect file)))
16596 (setq m (org-find-exact-headline-in-buffer
16597 heading buffer))
16598 (when (and (not m) (not visiting)) (kill-buffer buffer))
16599 (and m (throw 'found m))))))
16601 (defun org-find-entry-with-id (ident)
16602 "Locate the entry that contains the ID property with exact value IDENT.
16603 IDENT can be a string, a symbol or a number, this function will search for
16604 the string representation of it.
16605 Return the position where this entry starts, or nil if there is no such entry."
16606 (interactive "sID: ")
16607 (let ((id (cond
16608 ((stringp ident) ident)
16609 ((symbolp ident) (symbol-name ident))
16610 ((numberp ident) (number-to-string ident))
16611 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16612 (org-with-wide-buffer (org-find-property "ID" id))))
16614 ;;;; Timestamps
16616 (defvar org-last-changed-timestamp nil)
16617 (defvar org-last-inserted-timestamp nil
16618 "The last time stamp inserted with `org-insert-time-stamp'.")
16619 (defvar org-ts-what) ; dynamically scoped parameter
16621 (defun org-time-stamp (arg &optional inactive)
16622 "Prompt for a date/time and insert a time stamp.
16624 If the user specifies a time like HH:MM or if this command is
16625 called with at least one prefix argument, the time stamp contains
16626 the date and the time. Otherwise, only the date is included.
16628 All parts of a date not specified by the user are filled in from
16629 the timestamp at point, if any, or the current date/time
16630 otherwise.
16632 If there is already a timestamp at the cursor, it is replaced.
16634 With two universal prefix arguments, insert an active timestamp
16635 with the current time without prompting the user.
16637 When called from lisp, the timestamp is inactive if INACTIVE is
16638 non-nil."
16639 (interactive "P")
16640 (let* ((ts (cond
16641 ((org-at-date-range-p t)
16642 (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
16643 ((org-at-timestamp-p t) (match-string 0))))
16644 ;; Default time is either the timestamp at point or today.
16645 ;; When entering a range, only the range start is considered.
16646 (default-time (if (not ts) (current-time)
16647 (apply #'encode-time (org-parse-time-string ts))))
16648 (default-input (and ts (org-get-compact-tod ts)))
16649 (repeater (and ts
16650 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16651 (match-string 0 ts)))
16652 org-time-was-given
16653 org-end-time-was-given
16654 (time
16655 (and (if (equal arg '(16)) (current-time)
16656 ;; Preserve `this-command' and `last-command'.
16657 (let ((this-command this-command)
16658 (last-command last-command))
16659 (org-read-date
16660 arg 'totime nil nil default-time default-input
16661 inactive))))))
16662 (cond
16663 ((and ts
16664 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16665 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16666 (insert "--")
16667 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16669 ;; Make sure we're on a timestamp. When in the middle of a date
16670 ;; range, move arbitrarily to range end.
16671 (unless (org-at-timestamp-p t)
16672 (skip-chars-forward "-")
16673 (org-at-timestamp-p t))
16674 (replace-match "")
16675 (setq org-last-changed-timestamp
16676 (org-insert-time-stamp
16677 time (or org-time-was-given arg)
16678 inactive nil nil (list org-end-time-was-given)))
16679 (when repeater
16680 (backward-char)
16681 (insert " " repeater)
16682 (setq org-last-changed-timestamp
16683 (concat (substring org-last-inserted-timestamp 0 -1)
16684 " " repeater ">")))
16685 (message "Timestamp updated"))
16686 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16687 (t (org-insert-time-stamp
16688 time (or org-time-was-given arg) inactive nil nil
16689 (list org-end-time-was-given))))))
16691 ;; FIXME: can we use this for something else, like computing time differences?
16692 (defun org-get-compact-tod (s)
16693 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16694 (let* ((t1 (match-string 1 s))
16695 (h1 (string-to-number (match-string 2 s)))
16696 (m1 (string-to-number (match-string 3 s)))
16697 (t2 (and (match-end 4) (match-string 5 s)))
16698 (h2 (and t2 (string-to-number (match-string 6 s))))
16699 (m2 (and t2 (string-to-number (match-string 7 s))))
16700 dh dm)
16701 (if (not t2)
16703 (setq dh (- h2 h1) dm (- m2 m1))
16704 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16705 (concat t1 "+" (number-to-string dh)
16706 (and (/= 0 dm) (format ":%02d" dm)))))))
16708 (defun org-time-stamp-inactive (&optional arg)
16709 "Insert an inactive time stamp.
16710 An inactive time stamp is enclosed in square brackets instead of angle
16711 brackets. It is inactive in the sense that it does not trigger agenda entries,
16712 does not link to the calendar and cannot be changed with the S-cursor keys.
16713 So these are more for recording a certain time/date."
16714 (interactive "P")
16715 (org-time-stamp arg 'inactive))
16717 (defvar org-date-ovl (make-overlay 1 1))
16718 (overlay-put org-date-ovl 'face 'org-date-selected)
16719 (org-detach-overlay org-date-ovl)
16721 (defvar org-ans1) ; dynamically scoped parameter
16722 (defvar org-ans2) ; dynamically scoped parameter
16724 (defvar org-plain-time-of-day-regexp) ; defined below
16726 (defvar org-overriding-default-time nil) ; dynamically scoped
16727 (defvar org-read-date-overlay nil)
16728 (defvar org-dcst nil) ; dynamically scoped
16729 (defvar org-read-date-history nil)
16730 (defvar org-read-date-final-answer nil)
16731 (defvar org-read-date-analyze-futurep nil)
16732 (defvar org-read-date-analyze-forced-year nil)
16733 (defvar org-read-date-inactive)
16735 (defvar org-read-date-minibuffer-local-map
16736 (let* ((map (make-sparse-keymap)))
16737 (set-keymap-parent map minibuffer-local-map)
16738 (org-defkey map (kbd ".")
16739 (lambda () (interactive)
16740 ;; Are we at the beginning of the prompt?
16741 (if (looking-back "^[^:]+: ")
16742 (org-eval-in-calendar '(calendar-goto-today))
16743 (insert "."))))
16744 (org-defkey map (kbd "C-.")
16745 (lambda () (interactive)
16746 (org-eval-in-calendar '(calendar-goto-today))))
16747 (org-defkey map [(meta shift left)]
16748 (lambda () (interactive)
16749 (org-eval-in-calendar '(calendar-backward-month 1))))
16750 (org-defkey map [(meta shift right)]
16751 (lambda () (interactive)
16752 (org-eval-in-calendar '(calendar-forward-month 1))))
16753 (org-defkey map [(meta shift up)]
16754 (lambda () (interactive)
16755 (org-eval-in-calendar '(calendar-backward-year 1))))
16756 (org-defkey map [(meta shift down)]
16757 (lambda () (interactive)
16758 (org-eval-in-calendar '(calendar-forward-year 1))))
16759 (org-defkey map [?\e (shift left)]
16760 (lambda () (interactive)
16761 (org-eval-in-calendar '(calendar-backward-month 1))))
16762 (org-defkey map [?\e (shift right)]
16763 (lambda () (interactive)
16764 (org-eval-in-calendar '(calendar-forward-month 1))))
16765 (org-defkey map [?\e (shift up)]
16766 (lambda () (interactive)
16767 (org-eval-in-calendar '(calendar-backward-year 1))))
16768 (org-defkey map [?\e (shift down)]
16769 (lambda () (interactive)
16770 (org-eval-in-calendar '(calendar-forward-year 1))))
16771 (org-defkey map [(shift up)]
16772 (lambda () (interactive)
16773 (org-eval-in-calendar '(calendar-backward-week 1))))
16774 (org-defkey map [(shift down)]
16775 (lambda () (interactive)
16776 (org-eval-in-calendar '(calendar-forward-week 1))))
16777 (org-defkey map [(shift left)]
16778 (lambda () (interactive)
16779 (org-eval-in-calendar '(calendar-backward-day 1))))
16780 (org-defkey map [(shift right)]
16781 (lambda () (interactive)
16782 (org-eval-in-calendar '(calendar-forward-day 1))))
16783 (org-defkey map "!"
16784 (lambda () (interactive)
16785 (org-eval-in-calendar '(diary-view-entries))
16786 (message "")))
16787 (org-defkey map ">"
16788 (lambda () (interactive)
16789 (org-eval-in-calendar '(calendar-scroll-left 1))))
16790 (org-defkey map "<"
16791 (lambda () (interactive)
16792 (org-eval-in-calendar '(calendar-scroll-right 1))))
16793 (org-defkey map "\C-v"
16794 (lambda () (interactive)
16795 (org-eval-in-calendar
16796 '(calendar-scroll-left-three-months 1))))
16797 (org-defkey map "\M-v"
16798 (lambda () (interactive)
16799 (org-eval-in-calendar
16800 '(calendar-scroll-right-three-months 1))))
16801 map)
16802 "Keymap for minibuffer commands when using `org-read-date'.")
16804 (defvar org-def)
16805 (defvar org-defdecode)
16806 (defvar org-with-time)
16808 (defun org-read-date (&optional org-with-time to-time from-string prompt
16809 default-time default-input inactive)
16810 "Read a date, possibly a time, and make things smooth for the user.
16811 The prompt will suggest to enter an ISO date, but you can also enter anything
16812 which will at least partially be understood by `parse-time-string'.
16813 Unrecognized parts of the date will default to the current day, month, year,
16814 hour and minute. If this command is called to replace a timestamp at point,
16815 or to enter the second timestamp of a range, the default time is taken
16816 from the existing stamp. Furthermore, the command prefers the future,
16817 so if you are giving a date where the year is not given, and the day-month
16818 combination is already past in the current year, it will assume you
16819 mean next year. For details, see the manual. A few examples:
16821 3-2-5 --> 2003-02-05
16822 feb 15 --> currentyear-02-15
16823 2/15 --> currentyear-02-15
16824 sep 12 9 --> 2009-09-12
16825 12:45 --> today 12:45
16826 22 sept 0:34 --> currentyear-09-22 0:34
16827 12 --> currentyear-currentmonth-12
16828 Fri --> nearest Friday after today
16829 -Tue --> last Tuesday
16830 etc.
16832 Furthermore you can specify a relative date by giving, as the *first* thing
16833 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16834 change in days weeks, months, years.
16835 With a single plus or minus, the date is relative to today. With a double
16836 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16837 +4d --> four days from today
16838 +4 --> same as above
16839 +2w --> two weeks from today
16840 ++5 --> five days from default date
16842 The function understands only English month and weekday abbreviations.
16844 While prompting, a calendar is popped up - you can also select the
16845 date with the mouse (button 1). The calendar shows a period of three
16846 months. To scroll it to other months, use the keys `>' and `<'.
16847 If you don't like the calendar, turn it off with
16848 \(setq org-read-date-popup-calendar nil)
16850 With optional argument TO-TIME, the date will immediately be converted
16851 to an internal time.
16852 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16853 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16854 still enter a time, and this function will inform the calling routine
16855 about this change. The calling routine may then choose to change the
16856 format used to insert the time stamp into the buffer to include the time.
16857 With optional argument FROM-STRING, read from this string instead from
16858 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16859 the time/date that is used for everything that is not specified by the
16860 user."
16861 (require 'parse-time)
16862 (let* ((org-time-stamp-rounding-minutes
16863 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16864 (org-dcst org-display-custom-times)
16865 (ct (org-current-time))
16866 (org-def (or org-overriding-default-time default-time ct))
16867 (org-defdecode (decode-time org-def))
16868 (dummy (progn
16869 (when (< (nth 2 org-defdecode) org-extend-today-until)
16870 (setcar (nthcdr 2 org-defdecode) -1)
16871 (setcar (nthcdr 1 org-defdecode) 59)
16872 (setq org-def (apply 'encode-time org-defdecode)
16873 org-defdecode (decode-time org-def)))))
16874 (cur-frame (selected-frame))
16875 (mouse-autoselect-window nil) ; Don't let the mouse jump
16876 (calendar-frame-setup nil)
16877 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16878 (calendar-move-hook nil)
16879 (calendar-view-diary-initially-flag nil)
16880 (calendar-view-holidays-initially-flag nil)
16881 (timestr (format-time-string
16882 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16883 (prompt (concat (if prompt (concat prompt " ") "")
16884 (format "Date+time [%s]: " timestr)))
16885 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16887 (cond
16888 (from-string (setq ans from-string))
16889 (org-read-date-popup-calendar
16890 (save-excursion
16891 (save-window-excursion
16892 (calendar)
16893 (when (eq calendar-setup 'calendar-only)
16894 (setq cal-frame
16895 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16896 (select-frame cal-frame))
16897 (org-eval-in-calendar '(setq cursor-type nil) t)
16898 (unwind-protect
16899 (progn
16900 (calendar-forward-day (- (time-to-days org-def)
16901 (calendar-absolute-from-gregorian
16902 (calendar-current-date))))
16903 (org-eval-in-calendar nil t)
16904 (let* ((old-map (current-local-map))
16905 (map (copy-keymap calendar-mode-map))
16906 (minibuffer-local-map
16907 (copy-keymap org-read-date-minibuffer-local-map)))
16908 (org-defkey map (kbd "RET") 'org-calendar-select)
16909 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16910 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16911 (unwind-protect
16912 (progn
16913 (use-local-map map)
16914 (setq org-read-date-inactive inactive)
16915 (add-hook 'post-command-hook 'org-read-date-display)
16916 (setq org-ans0 (read-string prompt default-input
16917 'org-read-date-history nil))
16918 ;; org-ans0: from prompt
16919 ;; org-ans1: from mouse click
16920 ;; org-ans2: from calendar motion
16921 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16922 (remove-hook 'post-command-hook 'org-read-date-display)
16923 (use-local-map old-map)
16924 (when org-read-date-overlay
16925 (delete-overlay org-read-date-overlay)
16926 (setq org-read-date-overlay nil)))))
16927 (bury-buffer "*Calendar*")
16928 (when cal-frame
16929 (delete-frame cal-frame)
16930 (select-frame-set-input-focus cur-frame))))))
16932 (t ; Naked prompt only
16933 (unwind-protect
16934 (setq ans (read-string prompt default-input
16935 'org-read-date-history timestr))
16936 (when org-read-date-overlay
16937 (delete-overlay org-read-date-overlay)
16938 (setq org-read-date-overlay nil)))))
16940 (setq final (org-read-date-analyze ans org-def org-defdecode))
16942 (when org-read-date-analyze-forced-year
16943 (message "Year was forced into %s"
16944 (if org-read-date-force-compatible-dates
16945 "compatible range (1970-2037)"
16946 "range representable on this machine"))
16947 (ding))
16949 ;; One round trip to get rid of 34th of August and stuff like that....
16950 (setq final (decode-time (apply 'encode-time final)))
16952 (setq org-read-date-final-answer ans)
16954 (if to-time
16955 (apply 'encode-time final)
16956 (if (and (boundp 'org-time-was-given) org-time-was-given)
16957 (format "%04d-%02d-%02d %02d:%02d"
16958 (nth 5 final) (nth 4 final) (nth 3 final)
16959 (nth 2 final) (nth 1 final))
16960 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16962 (defun org-read-date-display ()
16963 "Display the current date prompt interpretation in the minibuffer."
16964 (when org-read-date-display-live
16965 (when org-read-date-overlay
16966 (delete-overlay org-read-date-overlay))
16967 (when (minibufferp (current-buffer))
16968 (save-excursion
16969 (end-of-line 1)
16970 (while (not (equal (buffer-substring
16971 (max (point-min) (- (point) 4)) (point))
16972 " "))
16973 (insert " ")))
16974 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16975 " " (or org-ans1 org-ans2)))
16976 (org-end-time-was-given nil)
16977 (f (org-read-date-analyze ans org-def org-defdecode))
16978 (fmts (if org-dcst
16979 org-time-stamp-custom-formats
16980 org-time-stamp-formats))
16981 (fmt (if (or org-with-time
16982 (and (boundp 'org-time-was-given) org-time-was-given))
16983 (cdr fmts)
16984 (car fmts)))
16985 (txt (format-time-string fmt (apply 'encode-time f)))
16986 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16987 (txt (concat "=> " txt)))
16988 (when (and org-end-time-was-given
16989 (string-match org-plain-time-of-day-regexp txt))
16990 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16991 org-end-time-was-given
16992 (substring txt (match-end 0)))))
16993 (when org-read-date-analyze-futurep
16994 (setq txt (concat txt " (=>F)")))
16995 (setq org-read-date-overlay
16996 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16997 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16999 (defun org-read-date-analyze (ans org-def org-defdecode)
17000 "Analyze the combined answer of the date prompt."
17001 ;; FIXME: cleanup and comment
17002 ;; Pass `current-time' result to `decode-time' (instead of calling
17003 ;; without arguments) so that only `current-time' has to be
17004 ;; overriden in tests.
17005 (let ((nowdecode (decode-time (current-time)))
17006 delta deltan deltaw deltadef year month day
17007 hour minute second wday pm h2 m2 tl wday1
17008 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
17009 (setq org-read-date-analyze-futurep nil
17010 org-read-date-analyze-forced-year nil)
17011 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
17012 (setq ans "+0"))
17014 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
17015 (setq ans (replace-match "" t t ans)
17016 deltan (car delta)
17017 deltaw (nth 1 delta)
17018 deltadef (nth 2 delta)))
17020 ;; Check if there is an iso week date in there. If yes, store the
17021 ;; info and postpone interpreting it until the rest of the parsing
17022 ;; is done.
17023 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17024 (setq iso-year (if (match-end 1)
17025 (org-small-year-to-year
17026 (string-to-number (match-string 1 ans))))
17027 iso-weekday (if (match-end 3)
17028 (string-to-number (match-string 3 ans)))
17029 iso-week (string-to-number (match-string 2 ans)))
17030 (setq ans (replace-match "" t t ans)))
17032 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17033 (when (string-match
17034 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17035 (setq year (if (match-end 2)
17036 (string-to-number (match-string 2 ans))
17037 (progn (setq kill-year t)
17038 (string-to-number (format-time-string "%Y"))))
17039 month (string-to-number (match-string 3 ans))
17040 day (string-to-number (match-string 4 ans)))
17041 (if (< year 100) (setq year (+ 2000 year)))
17042 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17043 t nil ans)))
17045 ;; Help matching dotted european dates
17046 (when (string-match
17047 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17048 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17049 (setq kill-year t)
17050 (string-to-number (format-time-string "%Y")))
17051 day (string-to-number (match-string 1 ans))
17052 month (string-to-number (match-string 2 ans))
17053 ans (replace-match (format "%04d-%02d-%02d" year month day)
17054 t nil ans)))
17056 ;; Help matching american dates, like 5/30 or 5/30/7
17057 (when (string-match
17058 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17059 (setq year (if (match-end 4)
17060 (string-to-number (match-string 4 ans))
17061 (progn (setq kill-year t)
17062 (string-to-number (format-time-string "%Y"))))
17063 month (string-to-number (match-string 1 ans))
17064 day (string-to-number (match-string 2 ans)))
17065 (if (< year 100) (setq year (+ 2000 year)))
17066 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17067 t nil ans)))
17068 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17069 ;; If there is a time with am/pm, and *no* time without it, we convert
17070 ;; so that matching will be successful.
17071 (loop for i from 1 to 2 do ; twice, for end time as well
17072 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17073 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17074 (setq hour (string-to-number (match-string 1 ans))
17075 minute (if (match-end 3)
17076 (string-to-number (match-string 3 ans))
17078 pm (equal ?p
17079 (string-to-char (downcase (match-string 4 ans)))))
17080 (if (and (= hour 12) (not pm))
17081 (setq hour 0)
17082 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17083 (setq ans (replace-match (format "%02d:%02d" hour minute)
17084 t t ans))))
17086 ;; Check if a time range is given as a duration
17087 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17088 (setq hour (string-to-number (match-string 1 ans))
17089 h2 (+ hour (string-to-number (match-string 3 ans)))
17090 minute (string-to-number (match-string 2 ans))
17091 m2 (+ minute (if (match-end 5) (string-to-number
17092 (match-string 5 ans))0)))
17093 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17094 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17095 t t ans)))
17097 ;; Check if there is a time range
17098 (when (boundp 'org-end-time-was-given)
17099 (setq org-time-was-given nil)
17100 (when (and (string-match org-plain-time-of-day-regexp ans)
17101 (match-end 8))
17102 (setq org-end-time-was-given (match-string 8 ans))
17103 (setq ans (concat (substring ans 0 (match-beginning 7))
17104 (substring ans (match-end 7))))))
17106 (setq tl (parse-time-string ans)
17107 day (or (nth 3 tl) (nth 3 org-defdecode))
17108 month
17109 (cond ((nth 4 tl))
17110 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17111 ;; Day was specified. Make sure DAY+MONTH
17112 ;; combination happens in the future.
17113 ((nth 3 tl)
17114 (setq futurep t)
17115 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17116 (nth 4 nowdecode)))
17117 (t (nth 4 org-defdecode)))
17118 year
17119 (cond ((and (not kill-year) (nth 5 tl)))
17120 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17121 ;; Month was guessed in the future and is at least
17122 ;; equal to NOWDECODE's. Fix year accordingly.
17123 (futurep
17124 (if (or (> month (nth 4 nowdecode))
17125 (>= day (nth 3 nowdecode)))
17126 (nth 5 nowdecode)
17127 (1+ (nth 5 nowdecode))))
17128 ;; Month was specified. Make sure MONTH+YEAR
17129 ;; combination happens in the future.
17130 ((nth 4 tl)
17131 (setq futurep t)
17132 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17133 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17134 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17135 (t (nth 5 nowdecode))))
17136 (t (nth 5 org-defdecode)))
17137 hour (or (nth 2 tl) (nth 2 org-defdecode))
17138 minute (or (nth 1 tl) (nth 1 org-defdecode))
17139 second (or (nth 0 tl) 0)
17140 wday (nth 6 tl))
17142 (when (and (eq org-read-date-prefer-future 'time)
17143 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17144 (equal day (nth 3 nowdecode))
17145 (equal month (nth 4 nowdecode))
17146 (equal year (nth 5 nowdecode))
17147 (nth 2 tl)
17148 (or (< (nth 2 tl) (nth 2 nowdecode))
17149 (and (= (nth 2 tl) (nth 2 nowdecode))
17150 (nth 1 tl)
17151 (< (nth 1 tl) (nth 1 nowdecode)))))
17152 (setq day (1+ day)
17153 futurep t))
17155 ;; Special date definitions below
17156 (cond
17157 (iso-week
17158 ;; There was an iso week
17159 (require 'cal-iso)
17160 (setq futurep nil)
17161 (setq year (or iso-year year)
17162 day (or iso-weekday wday 1)
17163 wday nil ; to make sure that the trigger below does not match
17164 iso-date (calendar-gregorian-from-absolute
17165 (calendar-iso-to-absolute
17166 (list iso-week day year))))
17167 ; FIXME: Should we also push ISO weeks into the future?
17168 ; (when (and org-read-date-prefer-future
17169 ; (not iso-year)
17170 ; (< (calendar-absolute-from-gregorian iso-date)
17171 ; (time-to-days (current-time))))
17172 ; (setq year (1+ year)
17173 ; iso-date (calendar-gregorian-from-absolute
17174 ; (calendar-iso-to-absolute
17175 ; (list iso-week day year)))))
17176 (setq month (car iso-date)
17177 year (nth 2 iso-date)
17178 day (nth 1 iso-date)))
17179 (deltan
17180 (setq futurep nil)
17181 (unless deltadef
17182 ;; Pass `current-time' result to `decode-time' (instead of
17183 ;; calling without arguments) so that only `current-time' has
17184 ;; to be overriden in tests.
17185 (let ((now (decode-time (current-time))))
17186 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17187 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17188 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17189 ((equal deltaw "m") (setq month (+ month deltan)))
17190 ((equal deltaw "y") (setq year (+ year deltan)))))
17191 ((and wday (not (nth 3 tl)))
17192 ;; Weekday was given, but no day, so pick that day in the week
17193 ;; on or after the derived date.
17194 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17195 (unless (equal wday wday1)
17196 (setq day (+ day (% (- wday wday1 -7) 7))))))
17197 (if (and (boundp 'org-time-was-given)
17198 (nth 2 tl))
17199 (setq org-time-was-given t))
17200 (if (< year 100) (setq year (+ 2000 year)))
17201 ;; Check of the date is representable
17202 (if org-read-date-force-compatible-dates
17203 (progn
17204 (if (< year 1970)
17205 (setq year 1970 org-read-date-analyze-forced-year t))
17206 (if (> year 2037)
17207 (setq year 2037 org-read-date-analyze-forced-year t)))
17208 (condition-case nil
17209 (ignore (encode-time second minute hour day month year))
17210 (error
17211 (setq year (nth 5 org-defdecode))
17212 (setq org-read-date-analyze-forced-year t))))
17213 (setq org-read-date-analyze-futurep futurep)
17214 (list second minute hour day month year)))
17216 (defvar parse-time-weekdays)
17217 (defun org-read-date-get-relative (s today default)
17218 "Check string S for special relative date string.
17219 TODAY and DEFAULT are internal times, for today and for a default.
17220 Return shift list (N what def-flag)
17221 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17222 N is the number of WHATs to shift.
17223 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17224 the DEFAULT date rather than TODAY."
17225 (require 'parse-time)
17226 (when (and
17227 (string-match
17228 (concat
17229 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17230 "\\([0-9]+\\)?"
17231 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17232 "\\([ \t]\\|$\\)") s)
17233 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17234 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17235 (string-to-char (substring (match-string 1 s) -1))
17236 ?+))
17237 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17238 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17239 (what (if (match-end 3) (match-string 3 s) "d"))
17240 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17241 (date (if rel default today))
17242 (wday (nth 6 (decode-time date)))
17243 delta)
17244 (if wday1
17245 (progn
17246 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17247 (if (= delta 0) (setq delta 7))
17248 (if (= dir ?-)
17249 (progn
17250 (setq delta (- delta 7))
17251 (if (= delta 0) (setq delta -7))))
17252 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17253 (list delta "d" rel))
17254 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17256 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17257 "Turn a user-specified date into the internal representation.
17258 The internal representation needed by the calendar is (month day year).
17259 This is a wrapper to handle the brain-dead convention in calendar that
17260 user function argument order change dependent on argument order."
17261 (if (boundp 'calendar-date-style)
17262 (cond
17263 ((eq calendar-date-style 'american)
17264 (list arg1 arg2 arg3))
17265 ((eq calendar-date-style 'european)
17266 (list arg2 arg1 arg3))
17267 ((eq calendar-date-style 'iso)
17268 (list arg2 arg3 arg1)))
17269 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17270 (if (org-bound-and-true-p european-calendar-style)
17271 (list arg2 arg1 arg3)
17272 (list arg1 arg2 arg3)))))
17274 (defun org-eval-in-calendar (form &optional keepdate)
17275 "Eval FORM in the calendar window and return to current window.
17276 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17277 otherwise stick to the current value of `org-ans2'."
17278 (let ((sf (selected-frame))
17279 (sw (selected-window)))
17280 (select-window (get-buffer-window "*Calendar*" t))
17281 (eval form)
17282 (when (and (not keepdate) (calendar-cursor-to-date))
17283 (let* ((date (calendar-cursor-to-date))
17284 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17285 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17286 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17287 (select-window sw)
17288 (org-select-frame-set-input-focus sf)))
17290 (defun org-calendar-select ()
17291 "Return to `org-read-date' with the date currently selected.
17292 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17293 (interactive)
17294 (when (calendar-cursor-to-date)
17295 (let* ((date (calendar-cursor-to-date))
17296 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17297 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17298 (if (active-minibuffer-window) (exit-minibuffer))))
17300 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17301 "Insert a date stamp for the date given by the internal TIME.
17302 See `format-time-string' for the format of TIME.
17303 WITH-HM means use the stamp format that includes the time of the day.
17304 INACTIVE means use square brackets instead of angular ones, so that the
17305 stamp will not contribute to the agenda.
17306 PRE and POST are optional strings to be inserted before and after the
17307 stamp.
17308 The command returns the inserted time stamp."
17309 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17310 stamp)
17311 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17312 (insert-before-markers (or pre ""))
17313 (when (listp extra)
17314 (setq extra (car extra))
17315 (if (and (stringp extra)
17316 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17317 (setq extra (format "-%02d:%02d"
17318 (string-to-number (match-string 1 extra))
17319 (string-to-number (match-string 2 extra))))
17320 (setq extra nil)))
17321 (when extra
17322 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17323 (insert-before-markers (setq stamp (format-time-string fmt time)))
17324 (insert-before-markers (or post ""))
17325 (setq org-last-inserted-timestamp stamp)))
17327 (defun org-toggle-time-stamp-overlays ()
17328 "Toggle the use of custom time stamp formats."
17329 (interactive)
17330 (setq org-display-custom-times (not org-display-custom-times))
17331 (unless org-display-custom-times
17332 (let ((p (point-min)) (bmp (buffer-modified-p)))
17333 (while (setq p (next-single-property-change p 'display))
17334 (if (and (get-text-property p 'display)
17335 (eq (get-text-property p 'face) 'org-date))
17336 (remove-text-properties
17337 p (setq p (next-single-property-change p 'display))
17338 '(display t))))
17339 (set-buffer-modified-p bmp)))
17340 (if (featurep 'xemacs)
17341 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17342 (org-restart-font-lock)
17343 (setq org-table-may-need-update t)
17344 (if org-display-custom-times
17345 (message "Time stamps are overlaid with custom format")
17346 (message "Time stamp overlays removed")))
17348 (defun org-display-custom-time (beg end)
17349 "Overlay modified time stamp format over timestamp between BEG and END."
17350 (let* ((ts (buffer-substring beg end))
17351 t1 w1 with-hm tf time str w2 (off 0))
17352 (save-match-data
17353 (setq t1 (org-parse-time-string ts t))
17354 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17355 (setq off (- (match-end 0) (match-beginning 0)))))
17356 (setq end (- end off))
17357 (setq w1 (- end beg)
17358 with-hm (and (nth 1 t1) (nth 2 t1))
17359 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17360 time (org-fix-decoded-time t1)
17361 str (org-add-props
17362 (format-time-string
17363 (substring tf 1 -1) (apply 'encode-time time))
17364 nil 'mouse-face 'highlight)
17365 w2 (length str))
17366 (if (not (= w2 w1))
17367 (add-text-properties (1+ beg) (+ 2 beg)
17368 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17369 (if (featurep 'xemacs)
17370 (progn
17371 (put-text-property beg end 'invisible t)
17372 (put-text-property beg end 'end-glyph (make-glyph str)))
17373 (put-text-property beg end 'display str))))
17375 (defun org-fix-decoded-time (time)
17376 "Set 0 instead of nil for the first 6 elements of time.
17377 Don't touch the rest."
17378 (let ((n 0))
17379 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17381 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17383 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17384 "Difference between TIMESTAMP-STRING and now in days.
17385 If SECONDS is non-nil, return the difference in seconds."
17386 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17387 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17388 (funcall fdiff (current-time)))))
17390 (defun org-deadline-close (timestamp-string &optional ndays)
17391 "Is the time in TIMESTAMP-STRING close to the current date?"
17392 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17393 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17394 (not (org-entry-is-done-p))))
17396 (defun org-get-wdays (ts &optional delay zero-delay)
17397 "Get the deadline lead time appropriate for timestring TS.
17398 When DELAY is non-nil, get the delay time for scheduled items
17399 instead of the deadline lead time. When ZERO-DELAY is non-nil
17400 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17401 don't try to find the delay cookie in the scheduled timestamp."
17402 (let ((tv (if delay org-scheduled-delay-days
17403 org-deadline-warning-days)))
17404 (cond
17405 ((or (and delay (< tv 0))
17406 (and delay zero-delay (<= tv 0))
17407 (and (not delay) (<= tv 0)))
17408 ;; Enforce this value no matter what
17409 (- tv))
17410 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17411 ;; lead time is specified.
17412 (floor (* (string-to-number (match-string 1 ts))
17413 (cdr (assoc (match-string 2 ts)
17414 '(("d" . 1) ("w" . 7)
17415 ("m" . 30.4) ("y" . 365.25)
17416 ("h" . 0.041667)))))))
17417 ;; go for the default.
17418 (t tv))))
17420 (defun org-calendar-select-mouse (ev)
17421 "Return to `org-read-date' with the date currently selected.
17422 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17423 (interactive "e")
17424 (mouse-set-point ev)
17425 (when (calendar-cursor-to-date)
17426 (let* ((date (calendar-cursor-to-date))
17427 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17428 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17429 (if (active-minibuffer-window) (exit-minibuffer))))
17431 (defun org-check-deadlines (ndays)
17432 "Check if there are any deadlines due or past due.
17433 A deadline is considered due if it happens within `org-deadline-warning-days'
17434 days from today's date. If the deadline appears in an entry marked DONE,
17435 it is not shown. The prefix arg NDAYS can be used to test that many
17436 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17437 (interactive "P")
17438 (let* ((org-warn-days
17439 (cond
17440 ((equal ndays '(4)) 100000)
17441 (ndays (prefix-numeric-value ndays))
17442 (t (abs org-deadline-warning-days))))
17443 (case-fold-search nil)
17444 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17445 (callback
17446 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17447 (message "%d deadlines past-due or due within %d days"
17448 (org-occur regexp nil callback)
17449 org-warn-days)))
17451 (defsubst org-re-timestamp (type)
17452 "Return a regexp for timestamp TYPE.
17453 Allowed values for TYPE are:
17455 all: all timestamps
17456 active: only active timestamps (<...>)
17457 inactive: only inactive timestamps ([...])
17458 scheduled: only scheduled timestamps
17459 deadline: only deadline timestamps
17460 closed: only closed time-stamps
17462 When TYPE is nil, fall back on returning a regexp that matches
17463 both scheduled and deadline timestamps."
17464 (case type
17465 (all org-ts-regexp-both)
17466 (active org-ts-regexp)
17467 (inactive org-ts-regexp-inactive)
17468 (scheduled org-scheduled-time-regexp)
17469 (deadline org-deadline-time-regexp)
17470 (closed org-closed-time-regexp)
17471 (otherwise
17472 (concat "\\<"
17473 (regexp-opt (list org-deadline-string org-scheduled-string))
17474 " *<\\([^>]+\\)>"))))
17476 (defun org-check-before-date (date)
17477 "Check if there are deadlines or scheduled entries before DATE."
17478 (interactive (list (org-read-date)))
17479 (let ((case-fold-search nil)
17480 (regexp (org-re-timestamp org-ts-type))
17481 (callback
17482 `(lambda ()
17483 (let ((match (match-string 1)))
17484 (and ,(if (memq org-ts-type '(active inactive all))
17485 '(eq (org-element-type (org-element-context)) 'timestamp)
17486 '(org-at-planning-p))
17487 (time-less-p
17488 (org-time-string-to-time match)
17489 (org-time-string-to-time date)))))))
17490 (message "%d entries before %s"
17491 (org-occur regexp nil callback) date)))
17493 (defun org-check-after-date (date)
17494 "Check if there are deadlines or scheduled entries after DATE."
17495 (interactive (list (org-read-date)))
17496 (let ((case-fold-search nil)
17497 (regexp (org-re-timestamp org-ts-type))
17498 (callback
17499 `(lambda ()
17500 (let ((match (match-string 1)))
17501 (and ,(if (memq org-ts-type '(active inactive all))
17502 '(eq (org-element-type (org-element-context)) 'timestamp)
17503 '(org-at-planning-p))
17504 (not (time-less-p
17505 (org-time-string-to-time match)
17506 (org-time-string-to-time date))))))))
17507 (message "%d entries after %s"
17508 (org-occur regexp nil callback) date)))
17510 (defun org-check-dates-range (start-date end-date)
17511 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17512 (interactive (list (org-read-date nil nil nil "Range starts")
17513 (org-read-date nil nil nil "Range end")))
17514 (let ((case-fold-search nil)
17515 (regexp (org-re-timestamp org-ts-type))
17516 (callback
17517 `(lambda ()
17518 (let ((match (match-string 1)))
17519 (and
17520 ,(if (memq org-ts-type '(active inactive all))
17521 '(eq (org-element-type (org-element-context)) 'timestamp)
17522 '(org-at-planning-p))
17523 (not (time-less-p
17524 (org-time-string-to-time match)
17525 (org-time-string-to-time start-date)))
17526 (time-less-p
17527 (org-time-string-to-time match)
17528 (org-time-string-to-time end-date)))))))
17529 (message "%d entries between %s and %s"
17530 (org-occur regexp nil callback) start-date end-date)))
17532 (defun org-evaluate-time-range (&optional to-buffer)
17533 "Evaluate a time range by computing the difference between start and end.
17534 Normally the result is just printed in the echo area, but with prefix arg
17535 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17536 If the time range is actually in a table, the result is inserted into the
17537 next column.
17538 For time difference computation, a year is assumed to be exactly 365
17539 days in order to avoid rounding problems."
17540 (interactive "P")
17542 (org-clock-update-time-maybe)
17543 (save-excursion
17544 (unless (org-at-date-range-p t)
17545 (goto-char (point-at-bol))
17546 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17547 (if (not (org-at-date-range-p t))
17548 (user-error "Not at a time-stamp range, and none found in current line")))
17549 (let* ((ts1 (match-string 1))
17550 (ts2 (match-string 2))
17551 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17552 (match-end (match-end 0))
17553 (time1 (org-time-string-to-time ts1))
17554 (time2 (org-time-string-to-time ts2))
17555 (t1 (org-float-time time1))
17556 (t2 (org-float-time time2))
17557 (diff (abs (- t2 t1)))
17558 (negative (< (- t2 t1) 0))
17559 ;; (ys (floor (* 365 24 60 60)))
17560 (ds (* 24 60 60))
17561 (hs (* 60 60))
17562 (fy "%dy %dd %02d:%02d")
17563 (fy1 "%dy %dd")
17564 (fd "%dd %02d:%02d")
17565 (fd1 "%dd")
17566 (fh "%02d:%02d")
17567 y d h m align)
17568 (if havetime
17569 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17571 d (floor (/ diff ds)) diff (mod diff ds)
17572 h (floor (/ diff hs)) diff (mod diff hs)
17573 m (floor (/ diff 60)))
17574 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17576 d (floor (+ (/ diff ds) 0.5))
17577 h 0 m 0))
17578 (if (not to-buffer)
17579 (message "%s" (org-make-tdiff-string y d h m))
17580 (if (org-at-table-p)
17581 (progn
17582 (goto-char match-end)
17583 (setq align t)
17584 (and (looking-at " *|") (goto-char (match-end 0))))
17585 (goto-char match-end))
17586 (if (looking-at
17587 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17588 (replace-match ""))
17589 (if negative (insert " -"))
17590 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17591 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17592 (insert " " (format fh h m))))
17593 (if align (org-table-align))
17594 (message "Time difference inserted")))))
17596 (defun org-make-tdiff-string (y d h m)
17597 (let ((fmt "")
17598 (l nil))
17599 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17600 l (push y l)))
17601 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17602 l (push d l)))
17603 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17604 l (push h l)))
17605 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17606 l (push m l)))
17607 (apply 'format fmt (nreverse l))))
17609 (defun org-time-string-to-time (s &optional buffer pos)
17610 "Convert a timestamp string into internal time."
17611 (condition-case errdata
17612 (apply 'encode-time (org-parse-time-string s))
17613 (error (error "Bad timestamp `%s'%s\nError was: %s"
17614 s (if (not (and buffer pos))
17616 (format " at %d in buffer `%s'" pos buffer))
17617 (cdr errdata)))))
17619 (defun org-time-string-to-seconds (s)
17620 "Convert a timestamp string to a number of seconds."
17621 (org-float-time (org-time-string-to-time s)))
17623 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17624 "Convert a time stamp to an absolute day number.
17625 If there is a specifier for a cyclic time stamp, get the closest
17626 date to DAYNR.
17627 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17628 The variable `date' is bound by the calendar when this is called."
17629 (cond
17630 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17631 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17632 daynr
17633 (+ daynr 1000)))
17634 ((and daynr (string-match "\\+\\([0-9]+\\)[hdwmy]" s)
17635 (> (string-to-number (match-string 1 s)) 0))
17636 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17637 (time-to-days (current-time))) (match-string 0 s)
17638 prefer show-all))
17639 (t (time-to-days
17640 (condition-case errdata
17641 (apply 'encode-time (org-parse-time-string s))
17642 (error (error "Bad timestamp `%s'%s\nError was: %s"
17643 s (if (not (and buffer pos))
17645 (format " at %d in buffer `%s'" pos buffer))
17646 (cdr errdata))))))))
17648 (defun org-days-to-iso-week (days)
17649 "Return the iso week number."
17650 (require 'cal-iso)
17651 (car (calendar-iso-from-absolute days)))
17653 (defun org-small-year-to-year (year)
17654 "Convert 2-digit years into 4-digit years.
17655 YEAR is expanded into one of the 30 next years, if possible, or
17656 into a past one. Any year larger than 99 is returned unchanged."
17657 (if (>= year 100) year
17658 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17659 (century (/ current 100))
17660 (offset (- year (% current 100))))
17661 (cond ((> offset 30) (+ (* (1- century) 100) year))
17662 ((> offset -70) (+ (* century 100) year))
17663 (t (+ (* (1+ century) 100) year))))))
17665 (defun org-time-from-absolute (d)
17666 "Return the time corresponding to date D.
17667 D may be an absolute day number, or a calendar-type list (month day year)."
17668 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17669 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17671 (defun org-calendar-holiday ()
17672 "List of holidays, for Diary display in Org-mode."
17673 (require 'holidays)
17674 (let ((hl (funcall
17675 (if (fboundp 'calendar-check-holidays)
17676 'calendar-check-holidays 'check-calendar-holidays) date)))
17677 (if hl (mapconcat 'identity hl "; "))))
17679 (defun org-diary-sexp-entry (sexp entry date)
17680 "Process a SEXP diary ENTRY for DATE."
17681 (require 'diary-lib)
17682 (let ((result (if calendar-debug-sexp
17683 (let ((stack-trace-on-error t))
17684 (eval (car (read-from-string sexp))))
17685 (condition-case nil
17686 (eval (car (read-from-string sexp)))
17687 (error
17688 (beep)
17689 (message "Bad sexp at line %d in %s: %s"
17690 (org-current-line)
17691 (buffer-file-name) sexp)
17692 (sleep-for 2))))))
17693 (cond ((stringp result) (split-string result "; "))
17694 ((and (consp result)
17695 (not (consp (cdr result)))
17696 (stringp (cdr result))) (cdr result))
17697 ((and (consp result)
17698 (stringp (car result))) result)
17699 (result entry))))
17701 (defun org-diary-to-ical-string (frombuf)
17702 "Get iCalendar entries from diary entries in buffer FROMBUF.
17703 This uses the icalendar.el library."
17704 (let* ((tmpdir (if (featurep 'xemacs)
17705 (temp-directory)
17706 temporary-file-directory))
17707 (tmpfile (make-temp-name
17708 (expand-file-name "orgics" tmpdir)))
17709 buf rtn b e)
17710 (with-current-buffer frombuf
17711 (icalendar-export-region (point-min) (point-max) tmpfile)
17712 (setq buf (find-buffer-visiting tmpfile))
17713 (set-buffer buf)
17714 (goto-char (point-min))
17715 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17716 (setq b (match-beginning 0)))
17717 (goto-char (point-max))
17718 (if (re-search-backward "^END:VEVENT" nil t)
17719 (setq e (match-end 0)))
17720 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17721 (kill-buffer buf)
17722 (delete-file tmpfile)
17723 rtn))
17725 (defun org-closest-date (start current change prefer show-all)
17726 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17727 When PREFER is `past', return a date that is either CURRENT or past.
17728 When PREFER is `future', return a date that is either CURRENT or future.
17729 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17730 ;; Make the proper lists from the dates
17731 (catch 'exit
17732 (let ((a1 '(("h" . hour)
17733 ("d" . day)
17734 ("w" . week)
17735 ("m" . month)
17736 ("y" . year)))
17737 (shour (nth 2 (org-parse-time-string start)))
17738 dn dw sday cday n1 n2 n0
17739 d m y y1 y2 date1 date2 nmonths nm ny m2)
17741 (setq start (org-date-to-gregorian start)
17742 current (org-date-to-gregorian
17743 (if show-all
17744 current
17745 (time-to-days (current-time))))
17746 sday (calendar-absolute-from-gregorian start)
17747 cday (calendar-absolute-from-gregorian current))
17749 (if (<= cday sday) (throw 'exit sday))
17751 (when (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17752 (setq dn (string-to-number (match-string 1 change))
17753 dw (cdr (assoc (match-string 2 change) a1))))
17754 (unless (and dn (> dn 0))
17755 (user-error "Invalid change specifier: %s" change))
17756 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17757 (cond
17758 ((eq dw 'hour)
17759 (let ((missing-hours
17760 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17761 dn)))
17762 (setq n1 (if (zerop missing-hours) cday
17763 (- cday (1+ (floor (/ missing-hours 24)))))
17764 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17765 ((eq dw 'day)
17766 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17767 n2 (+ n1 dn)))
17768 ((eq dw 'year)
17769 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17770 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17771 (setq date1 (list m d y1)
17772 n1 (calendar-absolute-from-gregorian date1)
17773 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17774 n2 (calendar-absolute-from-gregorian date2)))
17775 ((eq dw 'month)
17776 ;; approx number of month between the two dates
17777 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17778 ;; How often does dn fit in there?
17779 (setq d (nth 1 start) m (car start) y (nth 2 start)
17780 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17781 m (+ m nm)
17782 ny (floor (/ m 12))
17783 y (+ y ny)
17784 m (- m (* ny 12)))
17785 (while (> m 12) (setq m (- m 12) y (1+ y)))
17786 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17787 (setq m2 (+ m dn) y2 y)
17788 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17789 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17790 (while (<= n2 cday)
17791 (setq n1 n2 m m2 y y2)
17792 (setq m2 (+ m dn) y2 y)
17793 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17794 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17795 ;; Make sure n1 is the earlier date
17796 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17797 (if show-all
17798 (cond
17799 ((eq prefer 'past) (if (= cday n2) n2 n1))
17800 ((eq prefer 'future) (if (= cday n1) n1 n2))
17801 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17802 (cond
17803 ((eq prefer 'past) (if (= cday n2) n2 n1))
17804 ((eq prefer 'future) (if (= cday n1) n1 n2))
17805 (t (if (= cday n1) n1 n2)))))))
17807 (defun org-date-to-gregorian (date)
17808 "Turn any specification of DATE into a Gregorian date for the calendar."
17809 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17810 ((and (listp date) (= (length date) 3)) date)
17811 ((stringp date)
17812 (setq date (org-parse-time-string date))
17813 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17814 ((listp date)
17815 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17817 (defun org-parse-time-string (s &optional nodefault)
17818 "Parse the standard Org-mode time string.
17819 This should be a lot faster than the normal `parse-time-string'.
17820 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17821 hour and minute fields will be nil if not given."
17822 (cond ((string-match org-ts-regexp0 s)
17823 (list 0
17824 (if (or (match-beginning 8) (not nodefault))
17825 (string-to-number (or (match-string 8 s) "0")))
17826 (if (or (match-beginning 7) (not nodefault))
17827 (string-to-number (or (match-string 7 s) "0")))
17828 (string-to-number (match-string 4 s))
17829 (string-to-number (match-string 3 s))
17830 (string-to-number (match-string 2 s))
17831 nil nil nil))
17832 ((string-match "^<[^>]+>$" s)
17833 (decode-time (seconds-to-time (org-matcher-time s))))
17834 (t (error "Not a standard Org-mode time string: %s" s))))
17836 (defun org-timestamp-up (&optional arg)
17837 "Increase the date item at the cursor by one.
17838 If the cursor is on the year, change the year. If it is on the month,
17839 the day or the time, change that.
17840 With prefix ARG, change by that many units."
17841 (interactive "p")
17842 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17844 (defun org-timestamp-down (&optional arg)
17845 "Decrease the date item at the cursor by one.
17846 If the cursor is on the year, change the year. If it is on the month,
17847 the day or the time, change that.
17848 With prefix ARG, change by that many units."
17849 (interactive "p")
17850 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17852 (defun org-timestamp-up-day (&optional arg)
17853 "Increase the date in the time stamp by one day.
17854 With prefix ARG, change that many days."
17855 (interactive "p")
17856 (if (and (not (org-at-timestamp-p t))
17857 (org-at-heading-p))
17858 (org-todo 'up)
17859 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17861 (defun org-timestamp-down-day (&optional arg)
17862 "Decrease the date in the time stamp by one day.
17863 With prefix ARG, change that many days."
17864 (interactive "p")
17865 (if (and (not (org-at-timestamp-p t))
17866 (org-at-heading-p))
17867 (org-todo 'down)
17868 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17870 (defun org-at-timestamp-p (&optional inactive-ok)
17871 "Non-nil if point is inside a timestamp.
17873 When optional argument INACTIVE-OK is non-nil, also consider
17874 inactive timestamps.
17876 When this function returns a non-nil value, match data is set
17877 according to `org-ts-regexp3' or `org-ts-regexp2', depending on
17878 INACTIVE-OK."
17879 (interactive)
17880 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17881 (pos (point))
17882 (ans (or (looking-at tsr)
17883 (save-excursion
17884 (skip-chars-backward "^[<\n\r\t")
17885 (if (> (point) (point-min)) (backward-char 1))
17886 (and (looking-at tsr)
17887 (> (- (match-end 0) pos) -1))))))
17888 (and ans
17889 (boundp 'org-ts-what)
17890 (setq org-ts-what
17891 (cond
17892 ((= pos (match-beginning 0)) 'bracket)
17893 ;; Point is considered to be "on the bracket" whether
17894 ;; it's really on it or right after it.
17895 ((= pos (1- (match-end 0))) 'bracket)
17896 ((= pos (match-end 0)) 'after)
17897 ((org-pos-in-match-range pos 2) 'year)
17898 ((org-pos-in-match-range pos 3) 'month)
17899 ((org-pos-in-match-range pos 7) 'hour)
17900 ((org-pos-in-match-range pos 8) 'minute)
17901 ((or (org-pos-in-match-range pos 4)
17902 (org-pos-in-match-range pos 5)) 'day)
17903 ((and (> pos (or (match-end 8) (match-end 5)))
17904 (< pos (match-end 0)))
17905 (- pos (or (match-end 8) (match-end 5))))
17906 (t 'day))))
17907 ans))
17909 (defun org-toggle-timestamp-type ()
17910 "Toggle the type (<active> or [inactive]) of a time stamp."
17911 (interactive)
17912 (when (org-at-timestamp-p t)
17913 (let ((beg (match-beginning 0)) (end (match-end 0))
17914 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17915 (save-excursion
17916 (goto-char beg)
17917 (while (re-search-forward "[][<>]" end t)
17918 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17919 t t)))
17920 (message "Timestamp is now %sactive"
17921 (if (equal (char-after beg) ?<) "" "in")))))
17923 (defun org-at-clock-log-p nil
17924 "Is the cursor on the clock log line?"
17925 (save-excursion
17926 (move-beginning-of-line 1)
17927 (looking-at org-clock-line-re)))
17929 (defvar org-clock-history) ; defined in org-clock.el
17930 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17931 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17932 "Change the date in the time stamp at point.
17933 The date will be changed by N times WHAT. WHAT can be `day', `month',
17934 `year', `minute', `second'. If WHAT is not given, the cursor position
17935 in the timestamp determines what will be changed.
17936 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17937 (let ((origin (point)) origin-cat
17938 with-hm inactive
17939 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17940 org-ts-what
17941 extra rem
17942 ts time time0 fixnext clrgx)
17943 (if (not (org-at-timestamp-p t))
17944 (user-error "Not at a timestamp"))
17945 (if (and (not what) (eq org-ts-what 'bracket))
17946 (org-toggle-timestamp-type)
17947 ;; Point isn't on brackets. Remember the part of the time-stamp
17948 ;; the point was in. Indeed, size of time-stamps may change,
17949 ;; but point must be kept in the same category nonetheless.
17950 (setq origin-cat org-ts-what)
17951 (if (and (not what) (not (eq org-ts-what 'day))
17952 org-display-custom-times
17953 (get-text-property (point) 'display)
17954 (not (get-text-property (1- (point)) 'display)))
17955 (setq org-ts-what 'day))
17956 (setq org-ts-what (or what org-ts-what)
17957 inactive (= (char-after (match-beginning 0)) ?\[)
17958 ts (match-string 0))
17959 (replace-match "")
17960 (when (string-match
17961 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17963 (setq extra (match-string 1 ts))
17964 (if suppress-tmp-delay
17965 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17966 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17967 (setq with-hm t))
17968 (setq time0 (org-parse-time-string ts))
17969 (when (and updown
17970 (eq org-ts-what 'minute)
17971 (not current-prefix-arg))
17972 ;; This looks like s-up and s-down. Change by one rounding step.
17973 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17974 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17975 (setcar (cdr time0) (+ (nth 1 time0)
17976 (if (> n 0) (- rem) (- dm rem))))))
17977 (setq time
17978 (encode-time (or (car time0) 0)
17979 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17980 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17981 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17982 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17983 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17984 (nthcdr 6 time0)))
17985 (when (and (member org-ts-what '(hour minute))
17986 extra
17987 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17988 (setq extra (org-modify-ts-extra
17989 extra
17990 (if (eq org-ts-what 'hour) 2 5)
17991 n dm)))
17992 (when (integerp org-ts-what)
17993 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17994 (if (eq what 'calendar)
17995 (let ((cal-date (org-get-date-from-calendar)))
17996 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17997 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17998 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17999 (setcar time0 (or (car time0) 0))
18000 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
18001 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
18002 (setq time (apply 'encode-time time0))))
18003 ;; Insert the new time-stamp, and ensure point stays in the same
18004 ;; category as before (i.e. not after the last position in that
18005 ;; category).
18006 (let ((pos (point)))
18007 ;; Stay before inserted string. `save-excursion' is of no use.
18008 (setq org-last-changed-timestamp
18009 (org-insert-time-stamp time with-hm inactive nil nil extra))
18010 (goto-char pos))
18011 (save-match-data
18012 (looking-at org-ts-regexp3)
18013 (goto-char (cond
18014 ;; `day' category ends before `hour' if any, or at
18015 ;; the end of the day name.
18016 ((eq origin-cat 'day)
18017 (min (or (match-beginning 7) (1- (match-end 5))) origin))
18018 ((eq origin-cat 'hour) (min (match-end 7) origin))
18019 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
18020 ((integerp origin-cat) (min (1- (match-end 0)) origin))
18021 ;; `year' and `month' have both fixed size: point
18022 ;; couldn't have moved into another part.
18023 (t origin))))
18024 ;; Update clock if on a CLOCK line.
18025 (org-clock-update-time-maybe)
18026 ;; Maybe adjust the closest clock in `org-clock-history'
18027 (when org-clock-adjust-closest
18028 (if (not (and (org-at-clock-log-p)
18029 (< 1 (length (delq nil (mapcar 'marker-position
18030 org-clock-history))))))
18031 (message "No clock to adjust")
18032 (cond ((save-excursion ; fix previous clock?
18033 (re-search-backward org-ts-regexp0 nil t)
18034 (org-looking-back (concat org-clock-string " \\[")))
18035 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18036 ((save-excursion ; fix next clock?
18037 (re-search-backward org-ts-regexp0 nil t)
18038 (looking-at (concat org-ts-regexp0 "\\] =>")))
18039 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18040 (save-window-excursion
18041 ;; Find closest clock to point, adjust the previous/next one in history
18042 (let* ((p (save-excursion (org-back-to-heading t)))
18043 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18044 (clfixnth
18045 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18046 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
18047 (if (not clfixpos)
18048 (message "No clock to adjust")
18049 (save-excursion
18050 (org-goto-marker-or-bmk clfixpos)
18051 (org-show-subtree)
18052 (when (re-search-forward clrgx nil t)
18053 (goto-char (match-beginning 1))
18054 (let (org-clock-adjust-closest)
18055 (org-timestamp-change n org-ts-what updown))
18056 (message "Clock adjusted in %s for heading: %s"
18057 (file-name-nondirectory (buffer-file-name))
18058 (org-get-heading t t)))))))))
18059 ;; Try to recenter the calendar window, if any.
18060 (if (and org-calendar-follow-timestamp-change
18061 (get-buffer-window "*Calendar*" t)
18062 (memq org-ts-what '(day month year)))
18063 (org-recenter-calendar (time-to-days time))))))
18065 (defun org-modify-ts-extra (s pos n dm)
18066 "Change the different parts of the lead-time and repeat fields in timestamp."
18067 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18068 ng h m new rem)
18069 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18070 (cond
18071 ((or (org-pos-in-match-range pos 2)
18072 (org-pos-in-match-range pos 3))
18073 (setq m (string-to-number (match-string 3 s))
18074 h (string-to-number (match-string 2 s)))
18075 (if (org-pos-in-match-range pos 2)
18076 (setq h (+ h n))
18077 (setq n (* dm (org-no-warnings (signum n))))
18078 (when (not (= 0 (setq rem (% m dm))))
18079 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18080 (setq m (+ m n)))
18081 (if (< m 0) (setq m (+ m 60) h (1- h)))
18082 (if (> m 59) (setq m (- m 60) h (1+ h)))
18083 (setq h (min 24 (max 0 h)))
18084 (setq ng 1 new (format "-%02d:%02d" h m)))
18085 ((org-pos-in-match-range pos 6)
18086 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18087 ((org-pos-in-match-range pos 5)
18088 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18090 ((org-pos-in-match-range pos 9)
18091 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18092 ((org-pos-in-match-range pos 8)
18093 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18095 (when ng
18096 (setq s (concat
18097 (substring s 0 (match-beginning ng))
18099 (substring s (match-end ng))))))
18102 (defun org-recenter-calendar (date)
18103 "If the calendar is visible, recenter it to DATE."
18104 (let ((cwin (get-buffer-window "*Calendar*" t)))
18105 (when cwin
18106 (let ((calendar-move-hook nil))
18107 (with-selected-window cwin
18108 (calendar-goto-date (if (listp date) date
18109 (calendar-gregorian-from-absolute date))))))))
18111 (defun org-goto-calendar (&optional arg)
18112 "Go to the Emacs calendar at the current date.
18113 If there is a time stamp in the current line, go to that date.
18114 A prefix ARG can be used to force the current date."
18115 (interactive "P")
18116 (let ((tsr org-ts-regexp) diff
18117 (calendar-move-hook nil)
18118 (calendar-view-holidays-initially-flag nil)
18119 (calendar-view-diary-initially-flag nil))
18120 (if (or (org-at-timestamp-p)
18121 (save-excursion
18122 (beginning-of-line 1)
18123 (looking-at (concat ".*" tsr))))
18124 (let ((d1 (time-to-days (current-time)))
18125 (d2 (time-to-days
18126 (org-time-string-to-time (match-string 1)))))
18127 (setq diff (- d2 d1))))
18128 (calendar)
18129 (calendar-goto-today)
18130 (if (and diff (not arg)) (calendar-forward-day diff))))
18132 (defun org-get-date-from-calendar ()
18133 "Return a list (month day year) of date at point in calendar."
18134 (with-current-buffer "*Calendar*"
18135 (save-match-data
18136 (calendar-cursor-to-date))))
18138 (defun org-date-from-calendar ()
18139 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18140 If there is already a time stamp at the cursor position, update it."
18141 (interactive)
18142 (if (org-at-timestamp-p t)
18143 (org-timestamp-change 0 'calendar)
18144 (let ((cal-date (org-get-date-from-calendar)))
18145 (org-insert-time-stamp
18146 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18148 (defcustom org-effort-durations
18149 `(("min" . 1)
18150 ("h" . 60)
18151 ("d" . ,(* 60 8))
18152 ("w" . ,(* 60 8 5))
18153 ("m" . ,(* 60 8 5 4))
18154 ("y" . ,(* 60 8 5 40)))
18155 "Conversion factor to minutes for an effort modifier.
18157 Each entry has the form (MODIFIER . MINUTES).
18159 In an effort string, a number followed by MODIFIER is multiplied
18160 by the specified number of MINUTES to obtain an effort in
18161 minutes.
18163 For example, if the value of this variable is ((\"hours\" . 60)), then an
18164 effort string \"2hours\" is equivalent to 120 minutes."
18165 :group 'org-agenda
18166 :version "25.1"
18167 :package-version '(Org . "8.3")
18168 :type '(alist :key-type (string :tag "Modifier")
18169 :value-type (number :tag "Minutes")))
18171 (defun org-minutes-to-clocksum-string (m)
18172 "Format number of minutes as a clocksum string.
18173 The format is determined by `org-time-clocksum-format',
18174 `org-time-clocksum-use-fractional' and
18175 `org-time-clocksum-fractional-format' and
18176 `org-time-clocksum-use-effort-durations'."
18177 (let ((clocksum "")
18178 (m (round m)) ; Don't allow fractions of minutes
18179 h d w mo y fmt n)
18180 (setq h (if org-time-clocksum-use-effort-durations
18181 (cdr (assoc "h" org-effort-durations)) 60)
18182 d (if org-time-clocksum-use-effort-durations
18183 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18184 w (if org-time-clocksum-use-effort-durations
18185 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18186 mo (if org-time-clocksum-use-effort-durations
18187 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18188 y (if org-time-clocksum-use-effort-durations
18189 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18190 ;; fractional format
18191 (if org-time-clocksum-use-fractional
18192 (cond
18193 ;; single format string
18194 ((stringp org-time-clocksum-fractional-format)
18195 (format org-time-clocksum-fractional-format (/ m (float h))))
18196 ;; choice of fractional formats for different time units
18197 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18198 (> (/ (truncate m) (* y d h)) 0))
18199 (format fmt (/ m (* y d (float h)))))
18200 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18201 (> (/ (truncate m) (* mo d h)) 0))
18202 (format fmt (/ m (* mo d (float h)))))
18203 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18204 (> (/ (truncate m) (* w d h)) 0))
18205 (format fmt (/ m (* w d (float h)))))
18206 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18207 (> (/ (truncate m) (* d h)) 0))
18208 (format fmt (/ m (* d (float h)))))
18209 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18210 (> (/ (truncate m) h) 0))
18211 (format fmt (/ m (float h))))
18212 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18213 (format fmt m))
18214 ;; fall back to smallest time unit with a format
18215 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18216 (format fmt (/ m (float h))))
18217 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18218 (format fmt (/ m (* d (float h)))))
18219 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18220 (format fmt (/ m (* w d (float h)))))
18221 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18222 (format fmt (/ m (* mo d (float h)))))
18223 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18224 (format fmt (/ m (* y d (float h))))))
18225 ;; standard (non-fractional) format, with single format string
18226 (if (stringp org-time-clocksum-format)
18227 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18228 ;; separate formats components
18229 (and (setq fmt (plist-get org-time-clocksum-format :years))
18230 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18231 (plist-get org-time-clocksum-format :require-years))
18232 (setq clocksum (concat clocksum (format fmt n))
18233 m (- m (* n y d h))))
18234 (and (setq fmt (plist-get org-time-clocksum-format :months))
18235 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18236 (plist-get org-time-clocksum-format :require-months))
18237 (setq clocksum (concat clocksum (format fmt n))
18238 m (- m (* n mo d h))))
18239 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18240 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18241 (plist-get org-time-clocksum-format :require-weeks))
18242 (setq clocksum (concat clocksum (format fmt n))
18243 m (- m (* n w d h))))
18244 (and (setq fmt (plist-get org-time-clocksum-format :days))
18245 (or (> (setq n (/ (truncate m) (* d h))) 0)
18246 (plist-get org-time-clocksum-format :require-days))
18247 (setq clocksum (concat clocksum (format fmt n))
18248 m (- m (* n d h))))
18249 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18250 (or (> (setq n (/ (truncate m) h)) 0)
18251 (plist-get org-time-clocksum-format :require-hours))
18252 (setq clocksum (concat clocksum (format fmt n))
18253 m (- m (* n h))))
18254 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18255 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18256 (setq clocksum (concat clocksum (format fmt m))))
18257 ;; return formatted time duration
18258 clocksum))))
18260 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18261 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18262 "Org mode version 8.0")
18264 (defun org-hours-to-clocksum-string (n)
18265 (org-minutes-to-clocksum-string (* n 60)))
18267 (defun org-hh:mm-string-to-minutes (s)
18268 "Convert a string H:MM to a number of minutes.
18269 If the string is just a number, interpret it as minutes.
18270 In fact, the first hh:mm or number in the string will be taken,
18271 there can be extra stuff in the string.
18272 If no number is found, the return value is 0."
18273 (cond
18274 ((integerp s) s)
18275 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18276 (+ (* (string-to-number (match-string 1 s)) 60)
18277 (string-to-number (match-string 2 s))))
18278 ((string-match "\\([0-9]+\\)" s)
18279 (string-to-number (match-string 1 s)))
18280 (t 0)))
18282 (defcustom org-image-actual-width t
18283 "Should we use the actual width of images when inlining them?
18285 When set to t, always use the image width.
18287 When set to a number, use imagemagick (when available) to set
18288 the image's width to this value.
18290 When set to a number in a list, try to get the width from any
18291 #+ATTR.* keyword if it matches a width specification like
18293 #+ATTR_HTML: :width 300px
18295 and fall back on that number if none is found.
18297 When set to nil, try to get the width from an #+ATTR.* keyword
18298 and fall back on the original width if none is found.
18300 This requires Emacs >= 24.1, build with imagemagick support."
18301 :group 'org-appearance
18302 :version "24.4"
18303 :package-version '(Org . "8.0")
18304 :type '(choice
18305 (const :tag "Use the image width" t)
18306 (integer :tag "Use a number of pixels")
18307 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18308 (const :tag "Use #+ATTR* or don't resize" nil)))
18310 (defcustom org-agenda-inhibit-startup nil
18311 "Inhibit startup when preparing agenda buffers.
18312 When this variable is t, the initialization of the Org agenda
18313 buffers is inhibited: e.g. the visibility state is not set, the
18314 tables are not re-aligned, etc."
18315 :type 'boolean
18316 :version "24.3"
18317 :group 'org-agenda)
18319 (define-obsolete-variable-alias
18320 'org-agenda-ignore-drawer-properties
18321 'org-agenda-ignore-properties "25.1")
18323 (defcustom org-agenda-ignore-properties nil
18324 "Avoid updating text properties when building the agenda.
18325 Properties are used to prepare buffers for effort estimates,
18326 appointments, statistics and subtree-local categories.
18327 If you don't use these in the agenda, you can add them to this
18328 list and agenda building will be a bit faster.
18329 The value is a list, with zero or more of the symbols `effort', `appt',
18330 `stats' or `category'."
18331 :type '(set :greedy t
18332 (const effort)
18333 (const appt)
18334 (const stats)
18335 (const category))
18336 :version "25.1"
18337 :package-version '(Org . "8.3")
18338 :group 'org-agenda)
18340 (defun org-duration-string-to-minutes (s &optional output-to-string)
18341 "Convert a duration string S to minutes.
18343 A bare number is interpreted as minutes, modifiers can be set by
18344 customizing `org-effort-durations' (which see).
18346 Entries containing a colon are interpreted as H:MM by
18347 `org-hh:mm-string-to-minutes'."
18348 (let ((result 0)
18349 (re (concat "\\([0-9.]+\\) *\\("
18350 (regexp-opt (mapcar 'car org-effort-durations))
18351 "\\)")))
18352 (while (string-match re s)
18353 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18354 (string-to-number (match-string 1 s))))
18355 (setq s (replace-match "" nil t s)))
18356 (setq result (floor result))
18357 (incf result (org-hh:mm-string-to-minutes s))
18358 (if output-to-string (number-to-string result) result)))
18360 ;;;; Files
18362 (defun org-save-all-org-buffers ()
18363 "Save all Org-mode buffers without user confirmation."
18364 (interactive)
18365 (message "Saving all Org-mode buffers...")
18366 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18367 (when (featurep 'org-id) (org-id-locations-save))
18368 (message "Saving all Org-mode buffers... done"))
18370 (defun org-revert-all-org-buffers ()
18371 "Revert all Org-mode buffers.
18372 Prompt for confirmation when there are unsaved changes.
18373 Be sure you know what you are doing before letting this function
18374 overwrite your changes.
18376 This function is useful in a setup where one tracks org files
18377 with a version control system, to revert on one machine after pulling
18378 changes from another. I believe the procedure must be like this:
18380 1. M-x org-save-all-org-buffers
18381 2. Pull changes from the other machine, resolve conflicts
18382 3. M-x org-revert-all-org-buffers"
18383 (interactive)
18384 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18385 (user-error "Abort"))
18386 (save-excursion
18387 (save-window-excursion
18388 (mapc
18389 (lambda (b)
18390 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18391 (with-current-buffer b buffer-file-name))
18392 (org-pop-to-buffer-same-window b)
18393 (revert-buffer t 'no-confirm)))
18394 (buffer-list))
18395 (when (and (featurep 'org-id) org-id-track-globally)
18396 (org-id-locations-load)))))
18398 ;;;; Agenda files
18400 ;;;###autoload
18401 (defun org-switchb (&optional arg)
18402 "Switch between Org buffers.
18403 With one prefix argument, restrict available buffers to files.
18404 With two prefix arguments, restrict available buffers to agenda files.
18406 Defaults to `iswitchb' for buffer name completion.
18407 Set `org-completion-use-ido' to make it use ido instead."
18408 (interactive "P")
18409 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18410 ((equal arg '(16)) (org-buffer-list 'agenda))
18411 (t (org-buffer-list))))
18412 (org-completion-use-iswitchb org-completion-use-iswitchb)
18413 (org-completion-use-ido org-completion-use-ido))
18414 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18415 (setq org-completion-use-iswitchb t))
18416 (org-pop-to-buffer-same-window
18417 (org-icompleting-read "Org buffer: "
18418 (mapcar 'list (mapcar 'buffer-name blist))
18419 nil t))))
18421 ;;; Define some older names previously used for this functionality
18422 ;;;###autoload
18423 (defalias 'org-ido-switchb 'org-switchb)
18424 ;;;###autoload
18425 (defalias 'org-iswitchb 'org-switchb)
18427 (defun org-buffer-list (&optional predicate exclude-tmp)
18428 "Return a list of Org buffers.
18429 PREDICATE can be `export', `files' or `agenda'.
18431 export restrict the list to Export buffers.
18432 files restrict the list to buffers visiting Org files.
18433 agenda restrict the list to buffers visiting agenda files.
18435 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18436 (let* ((bfn nil)
18437 (agenda-files (and (eq predicate 'agenda)
18438 (mapcar 'file-truename (org-agenda-files t))))
18439 (filter
18440 (cond
18441 ((eq predicate 'files)
18442 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18443 ((eq predicate 'export)
18444 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18445 ((eq predicate 'agenda)
18446 (lambda (b)
18447 (with-current-buffer b
18448 (and (derived-mode-p 'org-mode)
18449 (setq bfn (buffer-file-name b))
18450 (member (file-truename bfn) agenda-files)))))
18451 (t (lambda (b) (with-current-buffer b
18452 (or (derived-mode-p 'org-mode)
18453 (string-match "\*Org .*Export"
18454 (buffer-name b)))))))))
18455 (delq nil
18456 (mapcar
18457 (lambda(b)
18458 (if (and (funcall filter b)
18459 (or (not exclude-tmp)
18460 (not (string-match "tmp" (buffer-name b)))))
18462 nil))
18463 (buffer-list)))))
18465 (defun org-agenda-files (&optional unrestricted archives)
18466 "Get the list of agenda files.
18467 Optional UNRESTRICTED means return the full list even if a restriction
18468 is currently in place.
18469 When ARCHIVES is t, include all archive files that are really being
18470 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18471 `org-agenda-archives-mode' is t."
18472 (let ((files
18473 (cond
18474 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18475 ((stringp org-agenda-files) (org-read-agenda-file-list))
18476 ((listp org-agenda-files) org-agenda-files)
18477 (t (error "Invalid value of `org-agenda-files'")))))
18478 (setq files (apply 'append
18479 (mapcar (lambda (f)
18480 (if (file-directory-p f)
18481 (directory-files
18482 f t org-agenda-file-regexp)
18483 (list f)))
18484 files)))
18485 (when org-agenda-skip-unavailable-files
18486 (setq files (delq nil
18487 (mapcar (function
18488 (lambda (file)
18489 (and (file-readable-p file) file)))
18490 files))))
18491 (when (or (eq archives t)
18492 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18493 (setq files (org-add-archive-files files)))
18494 files))
18496 (defun org-agenda-file-p (&optional file)
18497 "Return non-nil, if FILE is an agenda file.
18498 If FILE is omitted, use the file associated with the current
18499 buffer."
18500 (let ((fname (or file (buffer-file-name))))
18501 (and fname
18502 (member (file-truename fname)
18503 (mapcar #'file-truename (org-agenda-files t))))))
18505 (defun org-edit-agenda-file-list ()
18506 "Edit the list of agenda files.
18507 Depending on setup, this either uses customize to edit the variable
18508 `org-agenda-files', or it visits the file that is holding the list. In the
18509 latter case, the buffer is set up in a way that saving it automatically kills
18510 the buffer and restores the previous window configuration."
18511 (interactive)
18512 (if (stringp org-agenda-files)
18513 (let ((cw (current-window-configuration)))
18514 (find-file org-agenda-files)
18515 (org-set-local 'org-window-configuration cw)
18516 (org-add-hook 'after-save-hook
18517 (lambda ()
18518 (set-window-configuration
18519 (prog1 org-window-configuration
18520 (kill-buffer (current-buffer))))
18521 (org-install-agenda-files-menu)
18522 (message "New agenda file list installed"))
18523 nil 'local)
18524 (message "%s" (substitute-command-keys
18525 "Edit list and finish with \\[save-buffer]")))
18526 (customize-variable 'org-agenda-files)))
18528 (defun org-store-new-agenda-file-list (list)
18529 "Set new value for the agenda file list and save it correctly."
18530 (if (stringp org-agenda-files)
18531 (let ((fe (org-read-agenda-file-list t)) b u)
18532 (while (setq b (find-buffer-visiting org-agenda-files))
18533 (kill-buffer b))
18534 (with-temp-file org-agenda-files
18535 (insert
18536 (mapconcat
18537 (lambda (f) ;; Keep un-expanded entries.
18538 (if (setq u (assoc f fe))
18539 (cdr u)
18541 list "\n")
18542 "\n")))
18543 (let ((org-mode-hook nil) (org-inhibit-startup t)
18544 (org-insert-mode-line-in-empty-file nil))
18545 (setq org-agenda-files list)
18546 (customize-save-variable 'org-agenda-files org-agenda-files))))
18548 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18549 "Read the list of agenda files from a file.
18550 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18551 filenames, used by `org-store-new-agenda-file-list' to write back
18552 un-expanded file names."
18553 (when (file-directory-p org-agenda-files)
18554 (error "`org-agenda-files' cannot be a single directory"))
18555 (when (stringp org-agenda-files)
18556 (with-temp-buffer
18557 (insert-file-contents org-agenda-files)
18558 (mapcar
18559 (lambda (f)
18560 (let ((e (expand-file-name (substitute-in-file-name f)
18561 org-directory)))
18562 (if pair-with-expansion
18563 (cons e f)
18564 e)))
18565 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18567 ;;;###autoload
18568 (defun org-cycle-agenda-files ()
18569 "Cycle through the files in `org-agenda-files'.
18570 If the current buffer visits an agenda file, find the next one in the list.
18571 If the current buffer does not, find the first agenda file."
18572 (interactive)
18573 (let* ((fs (or (org-agenda-files t)
18574 (user-error "No agenda files")))
18575 (files (copy-sequence fs))
18576 (tcf (and buffer-file-name (file-truename buffer-file-name)))
18577 file)
18578 (when tcf
18579 (while (and (setq file (pop files))
18580 (not (equal (file-truename file) tcf)))))
18581 (find-file (car (or files fs)))
18582 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18584 (defun org-agenda-file-to-front (&optional to-end)
18585 "Move/add the current file to the top of the agenda file list.
18586 If the file is not present in the list, it is added to the front. If it is
18587 present, it is moved there. With optional argument TO-END, add/move to the
18588 end of the list."
18589 (interactive "P")
18590 (let ((org-agenda-skip-unavailable-files nil)
18591 (file-alist (mapcar (lambda (x)
18592 (cons (file-truename x) x))
18593 (org-agenda-files t)))
18594 (ctf (file-truename
18595 (or buffer-file-name
18596 (user-error "Please save the current buffer to a file"))))
18597 x had)
18598 (setq x (assoc ctf file-alist) had x)
18600 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18601 (if to-end
18602 (setq file-alist (append (delq x file-alist) (list x)))
18603 (setq file-alist (cons x (delq x file-alist))))
18604 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18605 (org-install-agenda-files-menu)
18606 (message "File %s to %s of agenda file list"
18607 (if had "moved" "added") (if to-end "end" "front"))))
18609 (defun org-remove-file (&optional file)
18610 "Remove current file from the list of files in variable `org-agenda-files'.
18611 These are the files which are being checked for agenda entries.
18612 Optional argument FILE means use this file instead of the current."
18613 (interactive)
18614 (let* ((org-agenda-skip-unavailable-files nil)
18615 (file (or file buffer-file-name
18616 (user-error "Current buffer does not visit a file")))
18617 (true-file (file-truename file))
18618 (afile (abbreviate-file-name file))
18619 (files (delq nil (mapcar
18620 (lambda (x)
18621 (if (equal true-file
18622 (file-truename x))
18623 nil x))
18624 (org-agenda-files t)))))
18625 (if (not (= (length files) (length (org-agenda-files t))))
18626 (progn
18627 (org-store-new-agenda-file-list files)
18628 (org-install-agenda-files-menu)
18629 (message "Removed from Org Agenda list: %s" afile))
18630 (message "File was not in list: %s (not removed)" afile))))
18632 (defun org-file-menu-entry (file)
18633 (vector file (list 'find-file file) t))
18635 (defun org-check-agenda-file (file)
18636 "Make sure FILE exists. If not, ask user what to do."
18637 (when (not (file-exists-p file))
18638 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18639 (abbreviate-file-name file))
18640 (let ((r (downcase (read-char-exclusive))))
18641 (cond
18642 ((equal r ?r)
18643 (org-remove-file file)
18644 (throw 'nextfile t))
18645 (t (user-error "Abort"))))))
18647 (defun org-get-agenda-file-buffer (file)
18648 "Get an agenda buffer visiting FILE.
18649 If the buffer needs to be created, add it to the list of buffers
18650 which might be released later."
18651 (let ((buf (org-find-base-buffer-visiting file)))
18652 (if buf
18653 buf ; just return it
18654 ;; Make a new buffer and remember it
18655 (setq buf (find-file-noselect file))
18656 (if buf (push buf org-agenda-new-buffers))
18657 buf)))
18659 (defun org-release-buffers (blist)
18660 "Release all buffers in list, asking the user for confirmation when needed.
18661 When a buffer is unmodified, it is just killed. When modified, it is saved
18662 \(if the user agrees) and then killed."
18663 (let (file)
18664 (dolist (buf blist)
18665 (setq file (buffer-file-name buf))
18666 (when (and (buffer-modified-p buf)
18667 file
18668 (y-or-n-p (format "Save file %s? " file)))
18669 (with-current-buffer buf (save-buffer)))
18670 (kill-buffer buf))))
18672 (defun org-agenda-prepare-buffers (files)
18673 "Create buffers for all agenda files, protect archived trees and comments."
18674 (interactive)
18675 (let ((pa '(:org-archived t))
18676 (pc '(:org-comment t))
18677 (pall '(:org-archived t :org-comment t))
18678 (inhibit-read-only t)
18679 (org-inhibit-startup org-agenda-inhibit-startup)
18680 (rea (concat ":" org-archive-tag ":"))
18681 file re pos)
18682 (setq org-tag-alist-for-agenda nil
18683 org-tag-groups-alist-for-agenda nil)
18684 (save-excursion
18685 (save-restriction
18686 (dolist (file files)
18687 (catch 'nextfile
18688 (if (bufferp file)
18689 (set-buffer file)
18690 (org-check-agenda-file file)
18691 (set-buffer (org-get-agenda-file-buffer file)))
18692 (widen)
18693 (org-set-regexps-and-options 'tags-only)
18694 (setq pos (point))
18695 (or (memq 'category org-agenda-ignore-properties)
18696 (org-refresh-category-properties))
18697 (or (memq 'stats org-agenda-ignore-properties)
18698 (org-refresh-stats-properties))
18699 (or (memq 'effort org-agenda-ignore-properties)
18700 (org-refresh-effort-properties))
18701 (or (memq 'appt org-agenda-ignore-properties)
18702 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18703 (setq org-todo-keywords-for-agenda
18704 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18705 (setq org-done-keywords-for-agenda
18706 (append org-done-keywords-for-agenda org-done-keywords))
18707 (setq org-todo-keyword-alist-for-agenda
18708 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18709 (setq org-tag-alist-for-agenda
18710 (org-uniquify
18711 (append org-tag-alist-for-agenda
18712 org-tag-alist
18713 org-tag-persistent-alist)))
18714 (if org-group-tags
18715 (setq org-tag-groups-alist-for-agenda
18716 (org-uniquify-alist
18717 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18718 (org-with-silent-modifications
18719 (save-excursion
18720 (remove-text-properties (point-min) (point-max) pall)
18721 (when org-agenda-skip-archived-trees
18722 (goto-char (point-min))
18723 (while (re-search-forward rea nil t)
18724 (if (org-at-heading-p t)
18725 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18726 (goto-char (point-min))
18727 (setq re (format "^\\*+ .*\\<%s\\>" org-comment-string))
18728 (while (re-search-forward re nil t)
18729 (when (save-match-data (org-in-commented-heading-p t))
18730 (add-text-properties
18731 (match-beginning 0) (org-end-of-subtree t) pc)))))
18732 (goto-char pos)))))
18733 (setq org-todo-keywords-for-agenda
18734 (org-uniquify org-todo-keywords-for-agenda))
18735 (setq org-todo-keyword-alist-for-agenda
18736 (org-uniquify org-todo-keyword-alist-for-agenda))))
18739 ;;;; CDLaTeX minor mode
18741 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18742 "Keymap for the minor `org-cdlatex-mode'.")
18744 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18745 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18746 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18747 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18748 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18750 (defvar org-cdlatex-texmathp-advice-is-done nil
18751 "Flag remembering if we have applied the advice to texmathp already.")
18753 (define-minor-mode org-cdlatex-mode
18754 "Toggle the minor `org-cdlatex-mode'.
18755 This mode supports entering LaTeX environment and math in LaTeX fragments
18756 in Org-mode.
18757 \\{org-cdlatex-mode-map}"
18758 nil " OCDL" nil
18759 (when org-cdlatex-mode
18760 (require 'cdlatex)
18761 (run-hooks 'cdlatex-mode-hook)
18762 (cdlatex-compute-tables))
18763 (unless org-cdlatex-texmathp-advice-is-done
18764 (setq org-cdlatex-texmathp-advice-is-done t)
18765 (defadvice texmathp (around org-math-always-on activate)
18766 "Always return t in org-mode buffers.
18767 This is because we want to insert math symbols without dollars even outside
18768 the LaTeX math segments. If Orgmode thinks that point is actually inside
18769 an embedded LaTeX fragment, let texmathp do its job.
18770 \\[org-cdlatex-mode-map]"
18771 (interactive)
18772 (let (p)
18773 (cond
18774 ((not (derived-mode-p 'org-mode)) ad-do-it)
18775 ((eq this-command 'cdlatex-math-symbol)
18776 (setq ad-return-value t
18777 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18779 (let ((p (org-inside-LaTeX-fragment-p)))
18780 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18781 (setq ad-return-value t
18782 texmathp-why '("Org-mode embedded math" . 0))
18783 (if p ad-do-it)))))))))
18785 (defun turn-on-org-cdlatex ()
18786 "Unconditionally turn on `org-cdlatex-mode'."
18787 (org-cdlatex-mode 1))
18789 (defun org-try-cdlatex-tab ()
18790 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18791 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18792 - inside a LaTeX fragment, or
18793 - after the first word in a line, where an abbreviation expansion could
18794 insert a LaTeX environment."
18795 (when org-cdlatex-mode
18796 (cond
18797 ;; Before any word on the line: No expansion possible.
18798 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18799 ;; Just after first word on the line: Expand it. Make sure it
18800 ;; cannot happen on headlines, though.
18801 ((save-excursion
18802 (skip-chars-backward "a-zA-Z0-9*")
18803 (skip-chars-backward " \t")
18804 (and (bolp) (not (org-at-heading-p))))
18805 (cdlatex-tab) t)
18806 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18808 (defun org-cdlatex-underscore-caret (&optional arg)
18809 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18810 Revert to the normal definition outside of these fragments."
18811 (interactive "P")
18812 (if (org-inside-LaTeX-fragment-p)
18813 (call-interactively 'cdlatex-sub-superscript)
18814 (let (org-cdlatex-mode)
18815 (call-interactively (key-binding (vector last-input-event))))))
18817 (defun org-cdlatex-math-modify (&optional arg)
18818 "Execute `cdlatex-math-modify' in LaTeX fragments.
18819 Revert to the normal definition outside of these fragments."
18820 (interactive "P")
18821 (if (org-inside-LaTeX-fragment-p)
18822 (call-interactively 'cdlatex-math-modify)
18823 (let (org-cdlatex-mode)
18824 (call-interactively (key-binding (vector last-input-event))))))
18826 (defun org-cdlatex-environment-indent (&optional environment item)
18827 "Execute `cdlatex-environment' and indent the inserted environment.
18829 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18831 The inserted environment is indented to current indentation
18832 unless point is at the beginning of the line, in which the
18833 environment remains unintended."
18834 (interactive)
18835 ;; cdlatex-environment always return nil. Therefore, capture output
18836 ;; first and determine if an environment was selected.
18837 (let* ((beg (point-marker))
18838 (end (copy-marker (point) t))
18839 (inserted (progn
18840 (ignore-errors (cdlatex-environment environment item))
18841 (< beg end)))
18842 ;; Figure out how many lines to move forward after the
18843 ;; environment has been inserted.
18844 (lines (when inserted
18845 (save-excursion
18846 (- (loop while (< beg (point))
18847 with x = 0
18848 do (forward-line -1)
18849 (incf x)
18850 finally return x)
18851 (if (progn (goto-char beg)
18852 (and (progn (skip-chars-forward " \t") (eolp))
18853 (progn (skip-chars-backward " \t") (bolp))))
18854 1 0)))))
18855 (env (org-trim (delete-and-extract-region beg end))))
18856 (when inserted
18857 ;; Get indentation of next line unless at column 0.
18858 (let ((ind (if (bolp) 0
18859 (save-excursion
18860 (org-return-indent)
18861 (prog1 (org-get-indentation)
18862 (when (progn (skip-chars-forward " \t") (eolp))
18863 (delete-region beg (point)))))))
18864 (bol (progn (skip-chars-backward " \t") (bolp))))
18865 ;; Insert a newline before environment unless at column zero
18866 ;; to "escape" the current line. Insert a newline if
18867 ;; something is one the same line as \end{ENVIRONMENT}.
18868 (insert
18869 (concat (unless bol "\n") env
18870 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18871 (unless (zerop ind)
18872 (save-excursion
18873 (goto-char beg)
18874 (while (< (point) end)
18875 (unless (eolp) (org-indent-line-to ind))
18876 (forward-line))))
18877 (goto-char beg)
18878 (forward-line lines)
18879 (org-indent-line-to ind)))
18880 (set-marker beg nil)
18881 (set-marker end nil)))
18884 ;;;; LaTeX fragments
18886 (defun org-inside-LaTeX-fragment-p ()
18887 "Test if point is inside a LaTeX fragment.
18888 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18889 sequence appearing also before point.
18890 Even though the matchers for math are configurable, this function assumes
18891 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18892 delimiters are skipped when they have been removed by customization.
18893 The return value is nil, or a cons cell with the delimiter and the
18894 position of this delimiter.
18896 This function does a reasonably good job, but can locally be fooled by
18897 for example currency specifications. For example it will assume being in
18898 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18899 fragments that are properly closed, but during editing, we have to live
18900 with the uncertainty caused by missing closing delimiters. This function
18901 looks only before point, not after."
18902 (catch 'exit
18903 (let ((pos (point))
18904 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18905 (lim (progn
18906 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18907 (point)))
18908 dd-on str (start 0) m re)
18909 (goto-char pos)
18910 (when dodollar
18911 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18912 re (nth 1 (assoc "$" org-latex-regexps)))
18913 (while (string-match re str start)
18914 (cond
18915 ((= (match-end 0) (length str))
18916 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18917 ((= (match-end 0) (- (length str) 5))
18918 (throw 'exit nil))
18919 (t (setq start (match-end 0))))))
18920 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18921 (goto-char pos)
18922 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18923 (and (match-beginning 2) (throw 'exit nil))
18924 ;; count $$
18925 (while (re-search-backward "\\$\\$" lim t)
18926 (setq dd-on (not dd-on)))
18927 (goto-char pos)
18928 (if dd-on (cons "$$" m))))))
18930 (defun org-inside-latex-macro-p ()
18931 "Is point inside a LaTeX macro or its arguments?"
18932 (save-match-data
18933 (org-in-regexp
18934 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18936 (defvar org-latex-fragment-image-overlays nil
18937 "List of overlays carrying the images of latex fragments.")
18938 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18940 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18941 "Remove all overlays with LaTeX fragment images in current buffer.
18942 When optional arguments BEG and END are non-nil, remove all
18943 overlays between them instead. Return t when some overlays were
18944 removed, nil otherwise."
18945 (let (removedp)
18946 (setq org-latex-fragment-image-overlays
18947 (let ((beg (or beg (point-min)))
18948 (end (or end (point-max))))
18949 (org-remove-if
18950 (lambda (o)
18951 (and (>= (overlay-start o) beg)
18952 (<= (overlay-end o) end)
18953 (progn (delete-overlay o)
18954 (or removedp (setq removedp t)))))
18955 org-latex-fragment-image-overlays)))
18956 removedp))
18958 (define-obsolete-function-alias
18959 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18960 (defun org-toggle-latex-fragment (&optional arg)
18961 "Preview the LaTeX fragment at point, or all locally or globally.
18963 If the cursor is on a LaTeX fragment, create the image and overlay
18964 it over the source code, if there is none. Remove it otherwise.
18965 If there is no fragment at point, display all fragments in the
18966 current section.
18968 With prefix ARG, preview or clear image for all fragments in the
18969 current subtree or in the whole buffer when used before the first
18970 headline. With a double prefix ARG \\[universal-argument] \
18971 \\[universal-argument] preview or clear images
18972 for all fragments in the buffer."
18973 (interactive "P")
18974 (unless (buffer-file-name (buffer-base-buffer))
18975 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18976 (when (display-graphic-p)
18977 (catch 'exit
18978 (save-excursion
18979 (let ((window-start (window-start)) msg)
18980 (save-restriction
18981 (cond
18982 ((or (equal arg '(16))
18983 (and (equal arg '(4))
18984 (org-with-limited-levels (org-before-first-heading-p))))
18985 (if (org-remove-latex-fragment-image-overlays)
18986 (progn (message "LaTeX fragments images removed from buffer")
18987 (throw 'exit nil))
18988 (setq msg "Creating images for buffer...")))
18989 ((equal arg '(4))
18990 (org-with-limited-levels (org-back-to-heading t))
18991 (let ((beg (point))
18992 (end (progn (org-end-of-subtree t) (point))))
18993 (if (org-remove-latex-fragment-image-overlays beg end)
18994 (progn
18995 (message "LaTeX fragment images removed from subtree")
18996 (throw 'exit nil))
18997 (setq msg "Creating images for subtree...")
18998 (narrow-to-region beg end))))
18999 ((let ((datum (org-element-context)))
19000 (when (memq (org-element-type datum)
19001 '(latex-environment latex-fragment))
19002 (let* ((beg (org-element-property :begin datum))
19003 (end (org-element-property :end datum)))
19004 (if (org-remove-latex-fragment-image-overlays beg end)
19005 (progn (message "LaTeX fragment image removed")
19006 (throw 'exit nil))
19007 (narrow-to-region beg end)
19008 (setq msg "Creating image..."))))))
19010 (org-with-limited-levels
19011 (let ((beg (if (org-at-heading-p) (line-beginning-position)
19012 (outline-previous-heading)
19013 (point)))
19014 (end (progn (outline-next-heading) (point))))
19015 (if (org-remove-latex-fragment-image-overlays beg end)
19016 (progn
19017 (message "LaTeX fragment images removed from section")
19018 (throw 'exit nil))
19019 (setq msg "Creating images for section...")
19020 (narrow-to-region beg end))))))
19021 (let ((file (buffer-file-name (buffer-base-buffer))))
19022 (org-format-latex
19023 (concat org-latex-preview-ltxpng-directory
19024 (file-name-sans-extension (file-name-nondirectory file)))
19025 ;; Emacs cannot overlay images from remote hosts.
19026 ;; Create it in `temporary-file-directory' instead.
19027 (if (file-remote-p file) temporary-file-directory
19028 default-directory)
19029 'overlays msg 'forbuffer
19030 org-latex-create-formula-image-program)))
19031 ;; Work around a bug that doesn't restore window's start
19032 ;; when widening back the buffer.
19033 (set-window-start nil window-start)
19034 (message (concat msg "done")))))))
19036 (defun org-format-latex
19037 (prefix &optional dir overlays msg forbuffer processing-type)
19038 "Replace LaTeX fragments with links to an image, and produce images.
19040 When optional argument OVERLAYS is non-nil, display the image on
19041 top of the fragment instead of replacing it.
19043 PROCESSING-TYPE is the conversion method to use, as a symbol.
19045 Some of the options can be changed using the variable
19046 `org-format-latex-options', which see."
19047 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19048 (unless (eq processing-type 'verbatim)
19049 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19050 (cnt 0)
19051 checkdir-flag)
19052 (goto-char (point-min))
19053 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19054 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19055 (overlay-recenter (point-max)))
19056 (while (re-search-forward math-regexp nil t)
19057 (unless (and overlays
19058 (eq (get-char-property (point) 'org-overlay-type)
19059 'org-latex-overlay))
19060 (let* ((context (org-element-context))
19061 (type (org-element-type context)))
19062 (when (memq type '(latex-environment latex-fragment))
19063 (let ((block-type (eq type 'latex-environment))
19064 (value (org-element-property :value context))
19065 (beg (org-element-property :begin context))
19066 (end (save-excursion
19067 (goto-char (org-element-property :end context))
19068 (skip-chars-backward " \r\t\n")
19069 (point))))
19070 (case processing-type
19071 (mathjax
19072 ;; Prepare for MathJax processing.
19073 (if (eq (char-after beg) ?$)
19074 (save-excursion
19075 (delete-region beg end)
19076 (insert "\\(" (substring value 1 -1) "\\)"))
19077 (goto-char end)))
19078 ((dvipng imagemagick)
19079 ;; Process to an image.
19080 (incf cnt)
19081 (goto-char beg)
19082 (let* ((face (face-at-point))
19083 ;; Get the colors from the face at point.
19085 (let ((color (plist-get org-format-latex-options
19086 :foreground)))
19087 (if (and forbuffer (eq color 'auto))
19088 (face-attribute face :foreground nil 'default)
19089 color)))
19091 (let ((color (plist-get org-format-latex-options
19092 :background)))
19093 (if (and forbuffer (eq color 'auto))
19094 (face-attribute face :background nil 'default)
19095 color)))
19096 (hash (sha1 (prin1-to-string
19097 (list org-format-latex-header
19098 org-latex-default-packages-alist
19099 org-latex-packages-alist
19100 org-format-latex-options
19101 forbuffer value fg bg))))
19102 (absprefix (expand-file-name prefix dir))
19103 (linkfile (format "%s_%s.png" prefix hash))
19104 (movefile (format "%s_%s.png" absprefix hash))
19105 (sep (and block-type "\n\n"))
19106 (link (concat sep "[[file:" linkfile "]]" sep))
19107 (options
19108 (org-combine-plists
19109 org-format-latex-options
19110 `(:foreground ,fg :background ,bg))))
19111 (when msg (message msg cnt))
19112 (unless checkdir-flag ; Ensure the directory exists.
19113 (setq checkdir-flag t)
19114 (let ((todir (file-name-directory absprefix)))
19115 (unless (file-directory-p todir)
19116 (make-directory todir t))))
19117 (unless (file-exists-p movefile)
19118 (org-create-formula-image
19119 value movefile options forbuffer processing-type))
19120 (if overlays
19121 (progn
19122 (dolist (o (overlays-in beg end))
19123 (when (eq (overlay-get o 'org-overlay-type)
19124 'org-latex-overlay)
19125 (delete-overlay o)))
19126 (let ((ov (make-overlay beg end)))
19127 (overlay-put ov
19128 'org-overlay-type
19129 'org-latex-overlay)
19130 (overlay-put ov 'evaporate t)
19131 (if (featurep 'xemacs)
19132 (progn
19133 (overlay-put ov 'invisible t)
19134 (overlay-put
19135 ov 'end-glyph
19136 (make-glyph
19137 (vector 'png :file movefile))))
19138 (overlay-put
19139 ov 'display
19140 (list 'image
19141 :type 'png
19142 :file movefile
19143 :ascent 'center)))
19144 (push ov org-latex-fragment-image-overlays))
19145 (goto-char end))
19146 (delete-region beg end)
19147 (insert
19148 (org-add-props link
19149 (list 'org-latex-src
19150 (replace-regexp-in-string "\"" "" value)
19151 'org-latex-src-embed-type
19152 (if block-type 'paragraph 'character)))))))
19153 (mathml
19154 ;; Process to MathML.
19155 (unless (org-format-latex-mathml-available-p)
19156 (user-error "LaTeX to MathML converter not configured"))
19157 (incf cnt)
19158 (when msg (message msg cnt))
19159 (goto-char beg)
19160 (delete-region beg end)
19161 (insert (org-format-latex-as-mathml
19162 value block-type prefix dir)))
19163 (otherwise
19164 (error "Unknown conversion type %s for LaTeX fragments"
19165 processing-type)))))))))))
19167 (defun org-create-math-formula (latex-frag &optional mathml-file)
19168 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19169 Use `org-latex-to-mathml-convert-command'. If the conversion is
19170 sucessful, return the portion between \"<math...> </math>\"
19171 elements otherwise return nil. When MATHML-FILE is specified,
19172 write the results in to that file. When invoked as an
19173 interactive command, prompt for LATEX-FRAG, with initial value
19174 set to the current active region and echo the results for user
19175 inspection."
19176 (interactive (list (let ((frag (when (org-region-active-p)
19177 (buffer-substring-no-properties
19178 (region-beginning) (region-end)))))
19179 (read-string "LaTeX Fragment: " frag nil frag))))
19180 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19181 (let* ((tmp-in-file (file-relative-name
19182 (make-temp-name (expand-file-name "ltxmathml-in"))))
19183 (ignore (write-region latex-frag nil tmp-in-file))
19184 (tmp-out-file (file-relative-name
19185 (make-temp-name (expand-file-name "ltxmathml-out"))))
19186 (cmd (format-spec
19187 org-latex-to-mathml-convert-command
19188 `((?j . ,(and org-latex-to-mathml-jar-file
19189 (shell-quote-argument
19190 (expand-file-name
19191 org-latex-to-mathml-jar-file))))
19192 (?I . ,(shell-quote-argument tmp-in-file))
19193 (?i . ,latex-frag)
19194 (?o . ,(shell-quote-argument tmp-out-file)))))
19195 mathml shell-command-output)
19196 (when (org-called-interactively-p 'any)
19197 (unless (org-format-latex-mathml-available-p)
19198 (user-error "LaTeX to MathML converter not configured")))
19199 (message "Running %s" cmd)
19200 (setq shell-command-output (shell-command-to-string cmd))
19201 (setq mathml
19202 (when (file-readable-p tmp-out-file)
19203 (with-current-buffer (find-file-noselect tmp-out-file t)
19204 (goto-char (point-min))
19205 (when (re-search-forward
19206 (concat
19207 (regexp-quote
19208 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19209 "[^>]*?>"
19210 "\\(.\\|\n\\)*"
19211 "</math>")
19212 nil t)
19213 (prog1 (match-string 0) (kill-buffer))))))
19214 (cond
19215 (mathml
19216 (setq mathml
19217 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19218 (when mathml-file
19219 (write-region mathml nil mathml-file))
19220 (when (org-called-interactively-p 'any)
19221 (message mathml)))
19222 ((message "LaTeX to MathML conversion failed")
19223 (message shell-command-output)))
19224 (delete-file tmp-in-file)
19225 (when (file-exists-p tmp-out-file)
19226 (delete-file tmp-out-file))
19227 mathml))
19229 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19230 prefix &optional dir)
19231 "Use `org-create-math-formula' but check local cache first."
19232 (let* ((absprefix (expand-file-name prefix dir))
19233 (print-length nil) (print-level nil)
19234 (formula-id (concat
19235 "formula-"
19236 (sha1
19237 (prin1-to-string
19238 (list latex-frag
19239 org-latex-to-mathml-convert-command)))))
19240 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19241 (formula-cache-dir (file-name-directory formula-cache)))
19243 (unless (file-directory-p formula-cache-dir)
19244 (make-directory formula-cache-dir t))
19246 (unless (file-exists-p formula-cache)
19247 (org-create-math-formula latex-frag formula-cache))
19249 (if (file-exists-p formula-cache)
19250 ;; Successful conversion. Return the link to MathML file.
19251 (org-add-props
19252 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19253 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19254 'org-latex-src-embed-type (if latex-frag-type
19255 'paragraph 'character)))
19256 ;; Failed conversion. Return the LaTeX fragment verbatim
19257 latex-frag)))
19259 (defun org-create-formula-image (string tofile options buffer &optional type)
19260 "Create an image from LaTeX source using dvipng or convert.
19261 This function calls either `org-create-formula-image-with-dvipng'
19262 or `org-create-formula-image-with-imagemagick' depending on the
19263 value of `org-latex-create-formula-image-program' or on the value
19264 of the optional TYPE variable.
19266 Note: ultimately these two function should be combined as they
19267 share a good deal of logic."
19268 (org-check-external-command
19269 "latex" "needed to convert LaTeX fragments to images")
19270 (funcall
19271 (case (or type org-latex-create-formula-image-program)
19272 (dvipng
19273 (org-check-external-command
19274 "dvipng" "needed to convert LaTeX fragments to images")
19275 #'org-create-formula-image-with-dvipng)
19276 (imagemagick
19277 (org-check-external-command
19278 "convert" "you need to install imagemagick")
19279 #'org-create-formula-image-with-imagemagick)
19280 (t (error
19281 "Invalid value of `org-latex-create-formula-image-program'")))
19282 string tofile options buffer))
19284 (declare-function org-export-get-backend "ox" (name))
19285 (declare-function org-export--get-global-options "ox" (&optional backend))
19286 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19287 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19288 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19289 (defun org-create-formula--latex-header ()
19290 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19291 (let ((info (org-combine-plists (org-export--get-global-options
19292 (org-export-get-backend 'latex))
19293 (org-export--get-inbuffer-options
19294 (org-export-get-backend 'latex)))))
19295 (org-latex-guess-babel-language
19296 (org-latex-guess-inputenc
19297 (org-splice-latex-header
19298 org-format-latex-header
19299 org-latex-default-packages-alist
19300 org-latex-packages-alist t
19301 (plist-get info :latex-header)))
19302 info)))
19304 (defun org--get-display-dpi ()
19305 "Get the DPI of the display.
19307 Assumes that the display has the same pixel width in the
19308 horizontal and vertical directions."
19309 (if (display-graphic-p)
19310 (round (/ (display-pixel-height)
19311 (/ (display-mm-height) 25.4)))
19312 (error "Attempt to calculate the dpi of a non-graphic display")))
19314 ;; This function borrows from Ganesh Swami's latex2png.el
19315 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19316 "This calls dvipng."
19317 (require 'ox-latex)
19318 (let* ((tmpdir (if (featurep 'xemacs)
19319 (temp-directory)
19320 temporary-file-directory))
19321 (texfilebase (make-temp-name
19322 (expand-file-name "orgtex" tmpdir)))
19323 (texfile (concat texfilebase ".tex"))
19324 (dvifile (concat texfilebase ".dvi"))
19325 (pngfile (concat texfilebase ".png"))
19326 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19327 ;; This assumes that the display has the same pixel width in
19328 ;; the horizontal and vertical directions
19329 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19330 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19331 "Black"))
19332 (bg (or (plist-get options (if buffer :background :html-background))
19333 "Transparent")))
19334 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19335 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19336 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19337 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19338 (let ((latex-header (org-create-formula--latex-header)))
19339 (with-temp-file texfile
19340 (insert latex-header)
19341 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19342 (let ((dir default-directory))
19343 (ignore-errors
19344 (cd tmpdir)
19345 (call-process "latex" nil nil nil texfile))
19346 (cd dir))
19347 (if (not (file-exists-p dvifile))
19348 (progn (message "Failed to create dvi file from %s" texfile) nil)
19349 (ignore-errors
19350 (if (featurep 'xemacs)
19351 (call-process "dvipng" nil nil nil
19352 "-fg" fg "-bg" bg
19353 "-T" "tight"
19354 "-o" pngfile
19355 dvifile)
19356 (call-process "dvipng" nil nil nil
19357 "-fg" fg "-bg" bg
19358 "-D" dpi
19359 ;;"-x" scale "-y" scale
19360 "-T" "tight"
19361 "-o" pngfile
19362 dvifile)))
19363 (if (not (file-exists-p pngfile))
19364 (if org-format-latex-signal-error
19365 (error "Failed to create png file from %s" texfile)
19366 (message "Failed to create png file from %s" texfile)
19367 nil)
19368 ;; Use the requested file name and clean up
19369 (copy-file pngfile tofile 'replace)
19370 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19371 (if (file-exists-p (concat texfilebase e))
19372 (delete-file (concat texfilebase e))))
19373 pngfile))))
19375 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19376 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19377 "This calls convert, which is included into imagemagick."
19378 (require 'ox-latex)
19379 (let* ((tmpdir (if (featurep 'xemacs)
19380 (temp-directory)
19381 temporary-file-directory))
19382 (texfilebase (make-temp-name
19383 (expand-file-name "orgtex" tmpdir)))
19384 (texfile (concat texfilebase ".tex"))
19385 (pdffile (concat texfilebase ".pdf"))
19386 (pngfile (concat texfilebase ".png"))
19387 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19388 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19389 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19390 "black"))
19391 (bg (or (plist-get options (if buffer :background :html-background))
19392 "white")))
19393 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19394 (setq fg (org-latex-color-format fg)))
19395 (if (eq bg 'default) (setq bg (org-latex-color :background))
19396 (setq bg (org-latex-color-format
19397 (if (string= bg "Transparent") "white" bg))))
19398 (let ((latex-header (org-create-formula--latex-header)))
19399 (with-temp-file texfile
19400 (insert latex-header)
19401 (insert "\n\\begin{document}\n"
19402 "\\definecolor{fg}{rgb}{" fg "}\n"
19403 "\\definecolor{bg}{rgb}{" bg "}\n"
19404 "\n\\pagecolor{bg}\n"
19405 "\n{\\color{fg}\n"
19406 string
19407 "\n}\n"
19408 "\n\\end{document}\n")))
19409 (org-latex-compile texfile t)
19410 (if (not (file-exists-p pdffile))
19411 (progn (message "Failed to create pdf file from %s" texfile) nil)
19412 (ignore-errors
19413 (if (featurep 'xemacs)
19414 (call-process "convert" nil nil nil
19415 "-density" "96"
19416 "-trim"
19417 "-antialias"
19418 pdffile
19419 "-quality" "100"
19420 ;; "-sharpen" "0x1.0"
19421 pngfile)
19422 (call-process "convert" nil nil nil
19423 "-density" dpi
19424 "-trim"
19425 "-antialias"
19426 pdffile
19427 "-quality" "100"
19428 ;; "-sharpen" "0x1.0"
19429 pngfile)))
19430 (if (not (file-exists-p pngfile))
19431 (if org-format-latex-signal-error
19432 (error "Failed to create png file from %s" texfile)
19433 (message "Failed to create png file from %s" texfile)
19434 nil)
19435 ;; Use the requested file name and clean up
19436 (copy-file pngfile tofile 'replace)
19437 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19438 (if (file-exists-p (concat texfilebase e))
19439 (delete-file (concat texfilebase e))))
19440 pngfile))))
19442 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19443 "Fill a LaTeX header template TPL.
19444 In the template, the following place holders will be recognized:
19446 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19447 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19448 [PACKAGES] \\usepackage statements for PKG
19449 [NO-PACKAGES] do not include PKG
19450 [EXTRA] the string EXTRA
19451 [NO-EXTRA] do not include EXTRA
19453 For backward compatibility, if both the positive and the negative place
19454 holder is missing, the positive one (without the \"NO-\") will be
19455 assumed to be present at the end of the template.
19456 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19457 EXTRA is a string.
19458 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19459 (let (rpl (end ""))
19460 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19461 (setq rpl (if (or (match-end 1) (not def-pkg))
19462 "" (org-latex-packages-to-string def-pkg snippets-p t))
19463 tpl (replace-match rpl t t tpl))
19464 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19466 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19467 (setq rpl (if (or (match-end 1) (not pkg))
19468 "" (org-latex-packages-to-string pkg snippets-p t))
19469 tpl (replace-match rpl t t tpl))
19470 (if pkg (setq end
19471 (concat end "\n"
19472 (org-latex-packages-to-string pkg snippets-p)))))
19474 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19475 (setq rpl (if (or (match-end 1) (not extra))
19476 "" (concat extra "\n"))
19477 tpl (replace-match rpl t t tpl))
19478 (if (and extra (string-match "\\S-" extra))
19479 (setq end (concat end "\n" extra))))
19481 (if (string-match "\\S-" end)
19482 (concat tpl "\n" end)
19483 tpl)))
19485 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19486 "Turn an alist of packages into a string with the \\usepackage macros."
19487 (setq pkg (mapconcat (lambda(p)
19488 (cond
19489 ((stringp p) p)
19490 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19491 (format "%% Package %s omitted" (cadr p)))
19492 ((equal "" (car p))
19493 (format "\\usepackage{%s}" (cadr p)))
19495 (format "\\usepackage[%s]{%s}"
19496 (car p) (cadr p)))))
19498 "\n"))
19499 (if newline (concat pkg "\n") pkg))
19501 (defun org-dvipng-color (attr)
19502 "Return a RGB color specification for dvipng."
19503 (apply 'format "rgb %s %s %s"
19504 (mapcar 'org-normalize-color
19505 (if (featurep 'xemacs)
19506 (color-rgb-components
19507 (face-property 'default
19508 (cond ((eq attr :foreground) 'foreground)
19509 ((eq attr :background) 'background))))
19510 (color-values (face-attribute 'default attr nil))))))
19512 (defun org-dvipng-color-format (color-name)
19513 "Convert COLOR-NAME to a RGB color value for dvipng."
19514 (apply 'format "rgb %s %s %s"
19515 (mapcar 'org-normalize-color
19516 (color-values color-name))))
19518 (defun org-latex-color (attr)
19519 "Return a RGB color for the LaTeX color package."
19520 (apply 'format "%s,%s,%s"
19521 (mapcar 'org-normalize-color
19522 (if (featurep 'xemacs)
19523 (color-rgb-components
19524 (face-property 'default
19525 (cond ((eq attr :foreground) 'foreground)
19526 ((eq attr :background) 'background))))
19527 (color-values (face-attribute 'default attr nil))))))
19529 (defun org-latex-color-format (color-name)
19530 "Convert COLOR-NAME to a RGB color value."
19531 (apply 'format "%s,%s,%s"
19532 (mapcar 'org-normalize-color
19533 (color-values color-name))))
19535 (defun org-normalize-color (value)
19536 "Return string to be used as color value for an RGB component."
19537 (format "%g" (/ value 65535.0)))
19541 ;; Image display
19543 (defvar org-inline-image-overlays nil)
19544 (make-variable-buffer-local 'org-inline-image-overlays)
19546 (defun org-toggle-inline-images (&optional include-linked)
19547 "Toggle the display of inline images.
19548 INCLUDE-LINKED is passed to `org-display-inline-images'."
19549 (interactive "P")
19550 (if org-inline-image-overlays
19551 (progn
19552 (org-remove-inline-images)
19553 (when (org-called-interactively-p 'interactive)
19554 (message "Inline image display turned off")))
19555 (org-display-inline-images include-linked)
19556 (when (org-called-interactively-p 'interactive)
19557 (message (if org-inline-image-overlays
19558 (format "%d images displayed inline"
19559 (length org-inline-image-overlays))
19560 "No images to display inline")))))
19562 (defun org-redisplay-inline-images ()
19563 "Refresh the display of inline images."
19564 (interactive)
19565 (if (not org-inline-image-overlays)
19566 (org-toggle-inline-images)
19567 (org-toggle-inline-images)
19568 (org-toggle-inline-images)))
19570 (defun org-display-inline-images (&optional include-linked refresh beg end)
19571 "Display inline images.
19573 An inline image is a link which follows either of these
19574 conventions:
19576 1. Its path is a file with an extension matching return value
19577 from `image-file-name-regexp' and it has no contents.
19579 2. Its description consists in a single link of the previous
19580 type.
19582 When optional argument INCLUDE-LINKED is non-nil, also links with
19583 a text description part will be inlined. This can be nice for
19584 a quick look at those images, but it does not reflect what
19585 exported files will look like.
19587 When optional argument REFRESH is non-nil, refresh existing
19588 images between BEG and END. This will create new image displays
19589 only if necessary. BEG and END default to the buffer
19590 boundaries."
19591 (interactive "P")
19592 (when (display-graphic-p)
19593 (unless refresh
19594 (org-remove-inline-images)
19595 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19596 (org-with-wide-buffer
19597 (goto-char (or beg (point-min)))
19598 (let ((case-fold-search t)
19599 (file-extension-re (org-image-file-name-regexp)))
19600 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19601 (let ((link (save-match-data (org-element-context))))
19602 ;; Check if we're at an inline image.
19603 (when (and (equal (org-element-property :type link) "file")
19604 (or include-linked
19605 (not (org-element-property :contents-begin link)))
19606 (let ((parent (org-element-property :parent link)))
19607 (or (not (eq (org-element-type parent) 'link))
19608 (not (cdr (org-element-contents parent)))))
19609 (org-string-match-p file-extension-re
19610 (org-element-property :path link)))
19611 (let ((file (expand-file-name
19612 (org-link-unescape
19613 (org-element-property :path link)))))
19614 (when (file-exists-p file)
19615 (let ((width
19616 ;; Apply `org-image-actual-width' specifications.
19617 (cond
19618 ((not (image-type-available-p 'imagemagick)) nil)
19619 ((eq org-image-actual-width t) nil)
19620 ((listp org-image-actual-width)
19622 ;; First try to find a width among
19623 ;; attributes associated to the paragraph
19624 ;; containing link.
19625 (let ((paragraph
19626 (let ((e link))
19627 (while (and (setq e (org-element-property
19628 :parent e))
19629 (not (eq (org-element-type e)
19630 'paragraph))))
19631 e)))
19632 (when paragraph
19633 (save-excursion
19634 (goto-char (org-element-property :begin paragraph))
19635 (when
19636 (re-search-forward
19637 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19638 (org-element-property
19639 :post-affiliated paragraph)
19641 (string-to-number (match-string 1))))))
19642 ;; Otherwise, fall-back to provided number.
19643 (car org-image-actual-width)))
19644 ((numberp org-image-actual-width)
19645 org-image-actual-width)))
19646 (old (get-char-property-and-overlay
19647 (org-element-property :begin link)
19648 'org-image-overlay)))
19649 (if (and (car-safe old) refresh)
19650 (image-refresh (overlay-get (cdr old) 'display))
19651 (let ((image (create-image file
19652 (and width 'imagemagick)
19654 :width width)))
19655 (when image
19656 (let* ((link
19657 ;; If inline image is the description
19658 ;; of another link, be sure to
19659 ;; consider the latter as the one to
19660 ;; apply the overlay on.
19661 (let ((parent
19662 (org-element-property :parent link)))
19663 (if (eq (org-element-type parent) 'link)
19664 parent
19665 link)))
19666 (ov (make-overlay
19667 (org-element-property :begin link)
19668 (progn
19669 (goto-char
19670 (org-element-property :end link))
19671 (skip-chars-backward " \t")
19672 (point)))))
19673 (overlay-put ov 'display image)
19674 (overlay-put ov 'face 'default)
19675 (overlay-put ov 'org-image-overlay t)
19676 (overlay-put
19677 ov 'modification-hooks
19678 (list 'org-display-inline-remove-overlay))
19679 (push ov org-inline-image-overlays)))))))))))))))
19681 (define-obsolete-function-alias
19682 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19684 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19685 "Remove inline-display overlay if a corresponding region is modified."
19686 (let ((inhibit-modification-hooks t))
19687 (when (and ov after)
19688 (delete ov org-inline-image-overlays)
19689 (delete-overlay ov))))
19691 (defun org-remove-inline-images ()
19692 "Remove inline display of images."
19693 (interactive)
19694 (mapc 'delete-overlay org-inline-image-overlays)
19695 (setq org-inline-image-overlays nil))
19697 ;;;; Key bindings
19699 ;; Outline functions from `outline-mode-prefix-map'
19700 ;; that can be remapped in Org:
19701 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19702 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19703 (define-key org-mode-map [remap outline-forward-same-level]
19704 'org-forward-heading-same-level)
19705 (define-key org-mode-map [remap outline-backward-same-level]
19706 'org-backward-heading-same-level)
19707 (define-key org-mode-map [remap show-branches]
19708 'org-kill-note-or-show-branches)
19709 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19710 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19711 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19712 (define-key org-mode-map [remap outline-next-visible-heading]
19713 'org-next-visible-heading)
19714 (define-key org-mode-map [remap outline-previous-visible-heading]
19715 'org-previous-visible-heading)
19716 (define-key org-mode-map [remap show-children] 'org-show-children)
19718 ;; Outline functions from `outline-mode-prefix-map' that can not
19719 ;; be remapped in Org:
19721 ;; - the column "key binding" shows whether the Outline function is still
19722 ;; available in Org mode on the same key that it has been bound to in
19723 ;; Outline mode:
19724 ;; - "overridden": key used for a different functionality in Org mode
19725 ;; - else: key still bound to the same Outline function in Org mode
19727 ;; | Outline function | key binding | Org replacement |
19728 ;; |------------------------------------+-------------+--------------------------|
19729 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19730 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19731 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19732 ;; | `show-entry' | overridden | no replacement |
19733 ;; | `show-branches' | `C-c C-k' | still same function |
19734 ;; | `show-subtree' | overridden | visibility cycling |
19735 ;; | `show-all' | overridden | no replacement |
19736 ;; | `hide-subtree' | overridden | visibility cycling |
19737 ;; | `hide-body' | overridden | no replacement |
19738 ;; | `hide-entry' | overridden | visibility cycling |
19739 ;; | `hide-leaves' | overridden | no replacement |
19740 ;; | `hide-sublevels' | overridden | no replacement |
19741 ;; | `hide-other' | overridden | no replacement |
19743 ;; Make `C-c C-x' a prefix key
19744 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19746 ;; TAB key with modifiers
19747 (org-defkey org-mode-map "\C-i" 'org-cycle)
19748 (org-defkey org-mode-map [(tab)] 'org-cycle)
19749 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19750 (org-defkey org-mode-map "\M-\t" #'pcomplete)
19751 ;; The following line is necessary under Suse GNU/Linux
19752 (unless (featurep 'xemacs)
19753 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19754 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19755 (define-key org-mode-map [backtab] 'org-shifttab)
19757 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19758 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19759 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19761 ;; Cursor keys with modifiers
19762 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19763 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19764 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19765 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19767 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19768 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19769 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19770 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19771 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19772 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19774 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19775 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19776 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19777 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19779 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19780 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19781 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19782 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19784 ;; Babel keys
19785 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19786 (mapc (lambda (pair)
19787 (define-key org-babel-map (car pair) (cdr pair)))
19788 org-babel-key-bindings)
19790 ;;; Extra keys for tty access.
19791 ;; We only set them when really needed because otherwise the
19792 ;; menus don't show the simple keys
19794 (when (or org-use-extra-keys
19795 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19796 (not window-system))
19797 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19798 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19799 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19800 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19801 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19802 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19803 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19804 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19805 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19806 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19807 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19808 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19809 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19810 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19811 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19812 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19813 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19814 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19815 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19816 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19817 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19818 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19819 (org-defkey org-mode-map [?\e (tab)] #'pcomplete)
19820 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19821 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19822 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19823 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19824 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19826 ;; All the other keys
19828 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19829 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19830 (if (boundp 'narrow-map)
19831 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19832 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19833 (if (boundp 'narrow-map)
19834 (org-defkey narrow-map "b" 'org-narrow-to-block)
19835 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19836 (if (boundp 'narrow-map)
19837 (org-defkey narrow-map "e" 'org-narrow-to-element)
19838 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19839 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19840 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19841 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19842 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19843 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19844 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19845 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19846 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19847 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19848 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19849 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree)
19850 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19851 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19852 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19853 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19854 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19855 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19856 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19857 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19858 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19859 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19860 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19861 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19862 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19863 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19864 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19865 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19866 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19867 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19868 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19869 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19870 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19871 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19872 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19873 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19874 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19875 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19876 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19877 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19878 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19879 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19880 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19881 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19882 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19883 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19884 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19885 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19886 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19887 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19888 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19889 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19890 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19891 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19892 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19893 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19894 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19895 (org-defkey org-mode-map "\C-c^" 'org-sort)
19896 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19897 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19898 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19899 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19900 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19901 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19902 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19903 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19904 (org-defkey org-mode-map "\C-m" 'org-return)
19905 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19906 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19907 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19908 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19909 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19910 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19911 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19912 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19913 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19914 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19915 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19916 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19917 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19918 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19919 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19920 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19921 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19922 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19923 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19924 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19925 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19926 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19927 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19928 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19929 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19931 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19932 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19933 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19935 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19936 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19937 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19938 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19939 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19940 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19941 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19942 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19943 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19944 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19945 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19946 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19947 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19948 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19949 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19950 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19951 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19952 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19953 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19954 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19955 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19956 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19958 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19959 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19960 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19961 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19962 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19964 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19966 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19968 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19969 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19971 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19974 (when (featurep 'xemacs)
19975 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19978 (defconst org-speed-commands-default
19980 ("Outline Navigation")
19981 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19982 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19983 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19984 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19985 ("F" . org-next-block)
19986 ("B" . org-previous-block)
19987 ("u" . (org-speed-move-safe 'outline-up-heading))
19988 ("j" . org-goto)
19989 ("g" . (org-refile t))
19990 ("Outline Visibility")
19991 ("c" . org-cycle)
19992 ("C" . org-shifttab)
19993 (" " . org-display-outline-path)
19994 ("s" . org-narrow-to-subtree)
19995 ("=" . org-columns)
19996 ("Outline Structure Editing")
19997 ("U" . org-metaup)
19998 ("D" . org-metadown)
19999 ("r" . org-metaright)
20000 ("l" . org-metaleft)
20001 ("R" . org-shiftmetaright)
20002 ("L" . org-shiftmetaleft)
20003 ("i" . (progn (forward-char 1) (call-interactively
20004 'org-insert-heading-respect-content)))
20005 ("^" . org-sort)
20006 ("w" . org-refile)
20007 ("a" . org-archive-subtree-default-with-confirmation)
20008 ("@" . org-mark-subtree)
20009 ("#" . org-toggle-comment)
20010 ("Clock Commands")
20011 ("I" . org-clock-in)
20012 ("O" . org-clock-out)
20013 ("Meta Data Editing")
20014 ("t" . org-todo)
20015 ("," . (org-priority))
20016 ("0" . (org-priority ?\ ))
20017 ("1" . (org-priority ?A))
20018 ("2" . (org-priority ?B))
20019 ("3" . (org-priority ?C))
20020 (":" . org-set-tags-command)
20021 ("e" . org-set-effort)
20022 ("E" . org-inc-effort)
20023 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
20024 (org-entry-put (point) "APPT_WARNTIME" m)))
20025 ("Agenda Views etc")
20026 ("v" . org-agenda)
20027 ("/" . org-sparse-tree)
20028 ("Misc")
20029 ("o" . org-open-at-point)
20030 ("?" . org-speed-command-help)
20031 ("<" . (org-agenda-set-restriction-lock 'subtree))
20032 (">" . (org-agenda-remove-restriction-lock))
20034 "The default speed commands.")
20036 (defun org-print-speed-command (e)
20037 (if (> (length (car e)) 1)
20038 (progn
20039 (princ "\n")
20040 (princ (car e))
20041 (princ "\n")
20042 (princ (make-string (length (car e)) ?-))
20043 (princ "\n"))
20044 (princ (car e))
20045 (princ " ")
20046 (if (symbolp (cdr e))
20047 (princ (symbol-name (cdr e)))
20048 (prin1 (cdr e)))
20049 (princ "\n")))
20051 (defun org-speed-command-help ()
20052 "Show the available speed commands."
20053 (interactive)
20054 (if (not org-use-speed-commands)
20055 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20056 (with-output-to-temp-buffer "*Help*"
20057 (princ "User-defined Speed commands\n===========================\n")
20058 (mapc 'org-print-speed-command org-speed-commands-user)
20059 (princ "\n")
20060 (princ "Built-in Speed commands\n=======================\n")
20061 (mapc 'org-print-speed-command org-speed-commands-default))
20062 (with-current-buffer "*Help*"
20063 (setq truncate-lines t))))
20065 (defun org-speed-move-safe (cmd)
20066 "Execute CMD, but make sure that the cursor always ends up in a headline.
20067 If not, return to the original position and throw an error."
20068 (interactive)
20069 (let ((pos (point)))
20070 (call-interactively cmd)
20071 (unless (and (bolp) (org-at-heading-p))
20072 (goto-char pos)
20073 (error "Boundary reached while executing %s" cmd))))
20075 (defvar org-self-insert-command-undo-counter 0)
20077 (defvar org-table-auto-blank-field) ; defined in org-table.el
20078 (defvar org-speed-command nil)
20080 (define-obsolete-function-alias
20081 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20083 (defun org-speed-command-activate (keys)
20084 "Hook for activating single-letter speed commands.
20085 `org-speed-commands-default' specifies a minimal command set.
20086 Use `org-speed-commands-user' for further customization."
20087 (when (or (and (bolp) (looking-at org-outline-regexp))
20088 (and (functionp org-use-speed-commands)
20089 (funcall org-use-speed-commands)))
20090 (cdr (assoc keys (append org-speed-commands-user
20091 org-speed-commands-default)))))
20093 (define-obsolete-function-alias
20094 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20096 (defun org-babel-speed-command-activate (keys)
20097 "Hook for activating single-letter code block commands."
20098 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20099 (cdr (assoc keys org-babel-key-bindings))))
20101 (defcustom org-speed-command-hook
20102 '(org-speed-command-default-hook org-babel-speed-command-hook)
20103 "Hook for activating speed commands at strategic locations.
20104 Hook functions are called in sequence until a valid handler is
20105 found.
20107 Each hook takes a single argument, a user-pressed command key
20108 which is also a `self-insert-command' from the global map.
20110 Within the hook, examine the cursor position and the command key
20111 and return nil or a valid handler as appropriate. Handler could
20112 be one of an interactive command, a function, or a form.
20114 Set `org-use-speed-commands' to non-nil value to enable this
20115 hook. The default setting is `org-speed-command-activate'."
20116 :group 'org-structure
20117 :version "24.1"
20118 :type 'hook)
20120 (defun org-self-insert-command (N)
20121 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20122 If the cursor is in a table looking at whitespace, the whitespace is
20123 overwritten, and the table is not marked as requiring realignment."
20124 (interactive "p")
20125 (org-check-before-invisible-edit 'insert)
20126 (cond
20127 ((and org-use-speed-commands
20128 (let ((kv (this-command-keys-vector)))
20129 (setq org-speed-command
20130 (run-hook-with-args-until-success
20131 'org-speed-command-hook
20132 (make-string 1 (aref kv (1- (length kv))))))))
20133 (cond
20134 ((commandp org-speed-command)
20135 (setq this-command org-speed-command)
20136 (call-interactively org-speed-command))
20137 ((functionp org-speed-command)
20138 (funcall org-speed-command))
20139 ((and org-speed-command (listp org-speed-command))
20140 (eval org-speed-command))
20141 (t (let (org-use-speed-commands)
20142 (call-interactively 'org-self-insert-command)))))
20143 ((and
20144 (org-table-p)
20145 (progn
20146 ;; check if we blank the field, and if that triggers align
20147 (and (featurep 'org-table) org-table-auto-blank-field
20148 (memq last-command
20149 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20150 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20151 ;; got extra space, this field does not determine column width
20152 (let (org-table-may-need-update) (org-table-blank-field))
20153 ;; no extra space, this field may determine column width
20154 (org-table-blank-field)))
20156 (eq N 1)
20157 (looking-at "[^|\n]* |"))
20158 (let (org-table-may-need-update)
20159 (goto-char (1- (match-end 0)))
20160 (backward-delete-char 1)
20161 (goto-char (match-beginning 0))
20162 (self-insert-command N)))
20164 (setq org-table-may-need-update t)
20165 (self-insert-command N)
20166 (org-fix-tags-on-the-fly)
20167 (if org-self-insert-cluster-for-undo
20168 (if (not (eq last-command 'org-self-insert-command))
20169 (setq org-self-insert-command-undo-counter 1)
20170 (if (>= org-self-insert-command-undo-counter 20)
20171 (setq org-self-insert-command-undo-counter 1)
20172 (and (> org-self-insert-command-undo-counter 0)
20173 buffer-undo-list (listp buffer-undo-list)
20174 (not (cadr buffer-undo-list)) ; remove nil entry
20175 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20176 (setq org-self-insert-command-undo-counter
20177 (1+ org-self-insert-command-undo-counter))))))))
20179 (defun org-check-before-invisible-edit (kind)
20180 "Check is editing if kind KIND would be dangerous with invisible text around.
20181 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20182 ;; First, try to get out of here as quickly as possible, to reduce overhead
20183 (if (and org-catch-invisible-edits
20184 (or (not (boundp 'visible-mode)) (not visible-mode))
20185 (or (get-char-property (point) 'invisible)
20186 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20187 ;; OK, we need to take a closer look
20188 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20189 (invisible-before-point (if (bobp) nil (get-char-property
20190 (1- (point)) 'invisible)))
20191 (border-and-ok-direction
20193 ;; Check if we are acting predictably before invisible text
20194 (and invisible-at-point (not invisible-before-point)
20195 (memq kind '(insert delete-backward)))
20196 ;; Check if we are acting predictably after invisible text
20197 ;; This works not well, and I have turned it off. It seems
20198 ;; better to always show and stop after invisible text.
20199 ;; (and (not invisible-at-point) invisible-before-point
20200 ;; (memq kind '(insert delete)))
20202 (when (or (memq invisible-at-point '(outline org-hide-block t))
20203 (memq invisible-before-point '(outline org-hide-block t)))
20204 (if (eq org-catch-invisible-edits 'error)
20205 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20206 (if (and org-custom-properties-overlays
20207 (y-or-n-p "Display invisible properties in this buffer? "))
20208 (org-toggle-custom-properties-visibility)
20209 ;; Make the area visible
20210 (save-excursion
20211 (if invisible-before-point
20212 (goto-char (previous-single-char-property-change
20213 (point) 'invisible)))
20214 (show-subtree))
20215 (cond
20216 ((eq org-catch-invisible-edits 'show)
20217 ;; That's it, we do the edit after showing
20218 (message
20219 "Unfolding invisible region around point before editing")
20220 (sit-for 1))
20221 ((and (eq org-catch-invisible-edits 'smart)
20222 border-and-ok-direction)
20223 (message "Unfolding invisible region around point before editing"))
20225 ;; Don't do the edit, make the user repeat it in full visibility
20226 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20228 (defun org-fix-tags-on-the-fly ()
20229 (when (and (equal (char-after (point-at-bol)) ?*)
20230 (org-at-heading-p))
20231 (org-align-tags-here org-tags-column)))
20233 (defun org-delete-backward-char (N)
20234 "Like `delete-backward-char', insert whitespace at field end in tables.
20235 When deleting backwards, in tables this function will insert whitespace in
20236 front of the next \"|\" separator, to keep the table aligned. The table will
20237 still be marked for re-alignment if the field did fill the entire column,
20238 because, in this case the deletion might narrow the column."
20239 (interactive "p")
20240 (save-match-data
20241 (org-check-before-invisible-edit 'delete-backward)
20242 (if (and (org-table-p)
20243 (eq N 1)
20244 (string-match "|" (buffer-substring (point-at-bol) (point)))
20245 (looking-at ".*?|"))
20246 (let ((pos (point))
20247 (noalign (looking-at "[^|\n\r]* |"))
20248 (c org-table-may-need-update))
20249 (backward-delete-char N)
20250 (if (not overwrite-mode)
20251 (progn
20252 (skip-chars-forward "^|")
20253 (insert " ")
20254 (goto-char (1- pos))))
20255 ;; noalign: if there were two spaces at the end, this field
20256 ;; does not determine the width of the column.
20257 (if noalign (setq org-table-may-need-update c)))
20258 (backward-delete-char N)
20259 (org-fix-tags-on-the-fly))))
20261 (defun org-delete-char (N)
20262 "Like `delete-char', but insert whitespace at field end in tables.
20263 When deleting characters, 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)
20270 (if (and (org-table-p)
20271 (not (bolp))
20272 (not (= (char-after) ?|))
20273 (eq N 1))
20274 (if (looking-at ".*?|")
20275 (let ((pos (point))
20276 (noalign (looking-at "[^|\n\r]* |"))
20277 (c org-table-may-need-update))
20278 (replace-match
20279 (concat (substring (match-string 0) 1 -1) " |") nil t)
20280 (goto-char pos)
20281 ;; noalign: if there were two spaces at the end, this field
20282 ;; does not determine the width of the column.
20283 (if noalign (setq org-table-may-need-update c)))
20284 (delete-char N))
20285 (delete-char N)
20286 (org-fix-tags-on-the-fly))))
20288 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20289 (put 'org-self-insert-command 'delete-selection
20290 (lambda ()
20291 (not (run-hook-with-args-until-success
20292 'self-insert-uses-region-functions))))
20293 (put 'orgtbl-self-insert-command 'delete-selection
20294 (lambda ()
20295 (not (run-hook-with-args-until-success
20296 'self-insert-uses-region-functions))))
20297 (put 'org-delete-char 'delete-selection 'supersede)
20298 (put 'org-delete-backward-char 'delete-selection 'supersede)
20299 (put 'org-yank 'delete-selection 'yank)
20301 ;; Make `flyspell-mode' delay after some commands
20302 (put 'org-self-insert-command 'flyspell-delayed t)
20303 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20304 (put 'org-delete-char 'flyspell-delayed t)
20305 (put 'org-delete-backward-char 'flyspell-delayed t)
20307 ;; Make pabbrev-mode expand after org-mode commands
20308 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20309 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20311 (defun org-remap (map &rest commands)
20312 "In MAP, remap the functions given in COMMANDS.
20313 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20314 (let (new old)
20315 (while commands
20316 (setq old (pop commands) new (pop commands))
20317 (if (fboundp 'command-remapping)
20318 (org-defkey map (vector 'remap old) new)
20319 (substitute-key-definition old new map global-map)))))
20321 (defun org-transpose-words ()
20322 "Transpose words for Org.
20323 This uses the `org-mode-transpose-word-syntax-table' syntax
20324 table, which interprets characters in `org-emphasis-alist' as
20325 word constituents."
20326 (interactive)
20327 (with-syntax-table org-mode-transpose-word-syntax-table
20328 (call-interactively 'transpose-words)))
20329 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20331 (when (eq org-enable-table-editor 'optimized)
20332 ;; If the user wants maximum table support, we need to hijack
20333 ;; some standard editing functions
20334 (org-remap org-mode-map
20335 'self-insert-command 'org-self-insert-command
20336 'delete-char 'org-delete-char
20337 'delete-backward-char 'org-delete-backward-char)
20338 (org-defkey org-mode-map "|" 'org-force-self-insert))
20340 (defvar org-ctrl-c-ctrl-c-hook nil
20341 "Hook for functions attaching themselves to `C-c C-c'.
20343 This can be used to add additional functionality to the C-c C-c
20344 key which executes context-dependent commands. This hook is run
20345 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20346 run after the last test.
20348 Each function will be called with no arguments. The function
20349 must check if the context is appropriate for it to act. If yes,
20350 it should do its thing and then return a non-nil value. If the
20351 context is wrong, just do nothing and return nil.")
20353 (defvar org-ctrl-c-ctrl-c-final-hook nil
20354 "Hook for functions attaching themselves to `C-c C-c'.
20356 This can be used to add additional functionality to the C-c C-c
20357 key which executes context-dependent commands. This hook is run
20358 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20359 before the first test.
20361 Each function will be called with no arguments. The function
20362 must check if the context is appropriate for it to act. If yes,
20363 it should do its thing and then return a non-nil value. If the
20364 context is wrong, just do nothing and return nil.")
20366 (defvar org-tab-first-hook nil
20367 "Hook for functions to attach themselves to TAB.
20368 See `org-ctrl-c-ctrl-c-hook' for more information.
20369 This hook runs as the first action when TAB is pressed, even before
20370 `org-cycle' messes around with the `outline-regexp' to cater for
20371 inline tasks and plain list item folding.
20372 If any function in this hook returns t, any other actions that
20373 would have been caused by TAB (such as table field motion or visibility
20374 cycling) will not occur.")
20376 (defvar org-tab-after-check-for-table-hook nil
20377 "Hook for functions to attach themselves to TAB.
20378 See `org-ctrl-c-ctrl-c-hook' for more information.
20379 This hook runs after it has been established that the cursor is not in a
20380 table, but before checking if the cursor is in a headline or if global cycling
20381 should be done.
20382 If any function in this hook returns t, not other actions like visibility
20383 cycling will be done.")
20385 (defvar org-tab-after-check-for-cycling-hook nil
20386 "Hook for functions to attach themselves to TAB.
20387 See `org-ctrl-c-ctrl-c-hook' for more information.
20388 This hook runs after it has been established that not table field motion and
20389 not visibility should be done because of current context. This is probably
20390 the place where a package like yasnippets can hook in.")
20392 (defvar org-tab-before-tab-emulation-hook nil
20393 "Hook for functions to attach themselves to TAB.
20394 See `org-ctrl-c-ctrl-c-hook' for more information.
20395 This hook runs after every other options for TAB have been exhausted, but
20396 before indentation and \t insertion takes place.")
20398 (defvar org-metaleft-hook nil
20399 "Hook for functions attaching themselves to `M-left'.
20400 See `org-ctrl-c-ctrl-c-hook' for more information.")
20401 (defvar org-metaright-hook nil
20402 "Hook for functions attaching themselves to `M-right'.
20403 See `org-ctrl-c-ctrl-c-hook' for more information.")
20404 (defvar org-metaup-hook nil
20405 "Hook for functions attaching themselves to `M-up'.
20406 See `org-ctrl-c-ctrl-c-hook' for more information.")
20407 (defvar org-metadown-hook nil
20408 "Hook for functions attaching themselves to `M-down'.
20409 See `org-ctrl-c-ctrl-c-hook' for more information.")
20410 (defvar org-shiftmetaleft-hook nil
20411 "Hook for functions attaching themselves to `M-S-left'.
20412 See `org-ctrl-c-ctrl-c-hook' for more information.")
20413 (defvar org-shiftmetaright-hook nil
20414 "Hook for functions attaching themselves to `M-S-right'.
20415 See `org-ctrl-c-ctrl-c-hook' for more information.")
20416 (defvar org-shiftmetaup-hook nil
20417 "Hook for functions attaching themselves to `M-S-up'.
20418 See `org-ctrl-c-ctrl-c-hook' for more information.")
20419 (defvar org-shiftmetadown-hook nil
20420 "Hook for functions attaching themselves to `M-S-down'.
20421 See `org-ctrl-c-ctrl-c-hook' for more information.")
20422 (defvar org-metareturn-hook nil
20423 "Hook for functions attaching themselves to `M-RET'.
20424 See `org-ctrl-c-ctrl-c-hook' for more information.")
20425 (defvar org-shiftup-hook nil
20426 "Hook for functions attaching themselves to `S-up'.
20427 See `org-ctrl-c-ctrl-c-hook' for more information.")
20428 (defvar org-shiftup-final-hook nil
20429 "Hook for functions attaching themselves to `S-up'.
20430 This one runs after all other options except shift-select have been excluded.
20431 See `org-ctrl-c-ctrl-c-hook' for more information.")
20432 (defvar org-shiftdown-hook nil
20433 "Hook for functions attaching themselves to `S-down'.
20434 See `org-ctrl-c-ctrl-c-hook' for more information.")
20435 (defvar org-shiftdown-final-hook nil
20436 "Hook for functions attaching themselves to `S-down'.
20437 This one runs after all other options except shift-select have been excluded.
20438 See `org-ctrl-c-ctrl-c-hook' for more information.")
20439 (defvar org-shiftleft-hook nil
20440 "Hook for functions attaching themselves to `S-left'.
20441 See `org-ctrl-c-ctrl-c-hook' for more information.")
20442 (defvar org-shiftleft-final-hook nil
20443 "Hook for functions attaching themselves to `S-left'.
20444 This one runs after all other options except shift-select have been excluded.
20445 See `org-ctrl-c-ctrl-c-hook' for more information.")
20446 (defvar org-shiftright-hook nil
20447 "Hook for functions attaching themselves to `S-right'.
20448 See `org-ctrl-c-ctrl-c-hook' for more information.")
20449 (defvar org-shiftright-final-hook nil
20450 "Hook for functions attaching themselves to `S-right'.
20451 This one runs after all other options except shift-select have been excluded.
20452 See `org-ctrl-c-ctrl-c-hook' for more information.")
20454 (defun org-modifier-cursor-error ()
20455 "Throw an error, a modified cursor command was applied in wrong context."
20456 (user-error "This command is active in special context like tables, headlines or items"))
20458 (defun org-shiftselect-error ()
20459 "Throw an error because Shift-Cursor command was applied in wrong context."
20460 (if (and (boundp 'shift-select-mode) shift-select-mode)
20461 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20462 (user-error "This command works only in special context like headlines or timestamps")))
20464 (defun org-call-for-shift-select (cmd)
20465 (let ((this-command-keys-shift-translated t))
20466 (call-interactively cmd)))
20468 (defun org-shifttab (&optional arg)
20469 "Global visibility cycling or move to previous table field.
20470 Call `org-table-previous-field' within a table.
20471 When ARG is nil, cycle globally through visibility states.
20472 When ARG is a numeric prefix, show contents of this level."
20473 (interactive "P")
20474 (cond
20475 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20476 ((integerp arg)
20477 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20478 (message "Content view to level: %d" arg)
20479 (org-content (prefix-numeric-value arg2))
20480 (org-cycle-show-empty-lines t)
20481 (setq org-cycle-global-status 'overview)))
20482 (t (call-interactively 'org-global-cycle))))
20484 (defun org-shiftmetaleft ()
20485 "Promote subtree or delete table column.
20486 Calls `org-promote-subtree', `org-outdent-item-tree', or
20487 `org-table-delete-column', depending on context. See the
20488 individual commands for more information."
20489 (interactive)
20490 (cond
20491 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20492 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20493 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20494 ((if (not (org-region-active-p)) (org-at-item-p)
20495 (save-excursion (goto-char (region-beginning))
20496 (org-at-item-p)))
20497 (call-interactively 'org-outdent-item-tree))
20498 (t (org-modifier-cursor-error))))
20500 (defun org-shiftmetaright ()
20501 "Demote subtree or insert table column.
20502 Calls `org-demote-subtree', `org-indent-item-tree', or
20503 `org-table-insert-column', depending on context. See the
20504 individual commands for more information."
20505 (interactive)
20506 (cond
20507 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20508 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20509 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20510 ((if (not (org-region-active-p)) (org-at-item-p)
20511 (save-excursion (goto-char (region-beginning))
20512 (org-at-item-p)))
20513 (call-interactively 'org-indent-item-tree))
20514 (t (org-modifier-cursor-error))))
20516 (defun org-shiftmetaup (&optional arg)
20517 "Drag the line at point up.
20518 In a table, kill the current row.
20519 On a clock timestamp, update the value of the timestamp like `S-<up>'
20520 but also adjust the previous clocked item in the clock history.
20521 Everywhere else, drag the line at point up."
20522 (interactive "P")
20523 (cond
20524 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20525 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20526 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20527 (call-interactively 'org-timestamp-up)))
20528 (t (call-interactively 'org-drag-line-backward))))
20530 (defun org-shiftmetadown (&optional arg)
20531 "Drag the line at point down.
20532 In a table, insert an empty row at the current line.
20533 On a clock timestamp, update the value of the timestamp like `S-<down>'
20534 but also adjust the previous clocked item in the clock history.
20535 Everywhere else, drag the line at point down."
20536 (interactive "P")
20537 (cond
20538 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20539 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20540 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20541 (call-interactively 'org-timestamp-down)))
20542 (t (call-interactively 'org-drag-line-forward))))
20544 (defsubst org-hidden-tree-error ()
20545 (user-error
20546 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20548 (defun org-metaleft (&optional arg)
20549 "Promote heading, list item at point or move table column left.
20551 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20552 depending on context. With no specific context, calls the Emacs
20553 default `backward-word'. See the individual commands for more
20554 information.
20556 This function runs the hook `org-metaleft-hook' as a first step,
20557 and returns at first non-nil value."
20558 (interactive "P")
20559 (cond
20560 ((run-hook-with-args-until-success 'org-metaleft-hook))
20561 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20562 ((org-with-limited-levels
20563 (or (org-at-heading-p)
20564 (and (org-region-active-p)
20565 (save-excursion
20566 (goto-char (region-beginning))
20567 (org-at-heading-p)))))
20568 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20569 (call-interactively 'org-do-promote))
20570 ;; At an inline task.
20571 ((org-at-heading-p)
20572 (call-interactively 'org-inlinetask-promote))
20573 ((or (org-at-item-p)
20574 (and (org-region-active-p)
20575 (save-excursion
20576 (goto-char (region-beginning))
20577 (org-at-item-p))))
20578 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20579 (call-interactively 'org-outdent-item))
20580 (t (call-interactively 'backward-word))))
20582 (defun org-metaright (&optional arg)
20583 "Demote heading, list item at point or move table column right.
20585 In front of a drawer or a block keyword, indent it correctly.
20587 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20588 `org-indnet-drawer' or `org-indent-block' depending on context.
20589 With no specific context, calls the Emacs default `forward-word'.
20590 See the individual commands for more information.
20592 This function runs the hook `org-metaright-hook' as a first step,
20593 and returns at first non-nil value."
20594 (interactive "P")
20595 (cond
20596 ((run-hook-with-args-until-success 'org-metaright-hook))
20597 ((org-at-table-p) (call-interactively 'org-table-move-column))
20598 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20599 ((org-at-block-p) (call-interactively 'org-indent-block))
20600 ((org-with-limited-levels
20601 (or (org-at-heading-p)
20602 (and (org-region-active-p)
20603 (save-excursion
20604 (goto-char (region-beginning))
20605 (org-at-heading-p)))))
20606 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20607 (call-interactively 'org-do-demote))
20608 ;; At an inline task.
20609 ((org-at-heading-p)
20610 (call-interactively 'org-inlinetask-demote))
20611 ((or (org-at-item-p)
20612 (and (org-region-active-p)
20613 (save-excursion
20614 (goto-char (region-beginning))
20615 (org-at-item-p))))
20616 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20617 (call-interactively 'org-indent-item))
20618 (t (call-interactively 'forward-word))))
20620 (defun org-check-for-hidden (what)
20621 "Check if there are hidden headlines/items in the current visual line.
20622 WHAT can be either `headlines' or `items'. If the current line is
20623 an outline or item heading and it has a folded subtree below it,
20624 this function returns t, nil otherwise."
20625 (let ((re (cond
20626 ((eq what 'headlines) org-outline-regexp-bol)
20627 ((eq what 'items) (org-item-beginning-re))
20628 (t (error "This should not happen"))))
20629 beg end)
20630 (save-excursion
20631 (catch 'exit
20632 (unless (org-region-active-p)
20633 (setq beg (point-at-bol))
20634 (beginning-of-line 2)
20635 (while (and (not (eobp)) ;; this is like `next-line'
20636 (get-char-property (1- (point)) 'invisible))
20637 (beginning-of-line 2))
20638 (setq end (point))
20639 (goto-char beg)
20640 (goto-char (point-at-eol))
20641 (setq end (max end (point)))
20642 (while (re-search-forward re end t)
20643 (if (get-char-property (match-beginning 0) 'invisible)
20644 (throw 'exit t))))
20645 nil))))
20647 (defun org-metaup (&optional arg)
20648 "Move subtree up or move table row up.
20649 Calls `org-move-subtree-up' or `org-table-move-row' or
20650 `org-move-item-up', depending on context. See the individual commands
20651 for more information."
20652 (interactive "P")
20653 (cond
20654 ((run-hook-with-args-until-success 'org-metaup-hook))
20655 ((org-region-active-p)
20656 (let* ((a (min (region-beginning) (region-end)))
20657 (b (1- (max (region-beginning) (region-end))))
20658 (c (save-excursion (goto-char a)
20659 (move-beginning-of-line 0)))
20660 (d (save-excursion (goto-char a)
20661 (move-end-of-line 0) (point))))
20662 (transpose-regions a b c d)
20663 (goto-char c)))
20664 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20665 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20666 ((org-at-item-p) (call-interactively 'org-move-item-up))
20667 (t (org-drag-element-backward))))
20669 (defun org-metadown (&optional arg)
20670 "Move subtree down or move table row down.
20671 Calls `org-move-subtree-down' or `org-table-move-row' or
20672 `org-move-item-down', depending on context. See the individual
20673 commands for more information."
20674 (interactive "P")
20675 (cond
20676 ((run-hook-with-args-until-success 'org-metadown-hook))
20677 ((org-region-active-p)
20678 (let* ((a (min (region-beginning) (region-end)))
20679 (b (max (region-beginning) (region-end)))
20680 (c (save-excursion (goto-char b)
20681 (move-beginning-of-line 1)))
20682 (d (save-excursion (goto-char b)
20683 (move-end-of-line 1) (1+ (point)))))
20684 (transpose-regions a b c d)
20685 (goto-char d)))
20686 ((org-at-table-p) (call-interactively 'org-table-move-row))
20687 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20688 ((org-at-item-p) (call-interactively 'org-move-item-down))
20689 (t (org-drag-element-forward))))
20691 (defun org-shiftup (&optional arg)
20692 "Increase item in timestamp or increase priority of current headline.
20693 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20694 depending on context. See the individual commands for more information."
20695 (interactive "P")
20696 (cond
20697 ((run-hook-with-args-until-success 'org-shiftup-hook))
20698 ((and org-support-shift-select (org-region-active-p))
20699 (org-call-for-shift-select 'previous-line))
20700 ((org-at-timestamp-p t)
20701 (call-interactively (if org-edit-timestamp-down-means-later
20702 'org-timestamp-down 'org-timestamp-up)))
20703 ((and (not (eq org-support-shift-select 'always))
20704 org-enable-priority-commands
20705 (org-at-heading-p))
20706 (call-interactively 'org-priority-up))
20707 ((and (not org-support-shift-select) (org-at-item-p))
20708 (call-interactively 'org-previous-item))
20709 ((org-clocktable-try-shift 'up arg))
20710 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20711 (org-support-shift-select
20712 (org-call-for-shift-select 'previous-line))
20713 (t (org-shiftselect-error))))
20715 (defun org-shiftdown (&optional arg)
20716 "Decrease item in timestamp or decrease priority of current headline.
20717 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20718 depending on context. See the individual commands for more information."
20719 (interactive "P")
20720 (cond
20721 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20722 ((and org-support-shift-select (org-region-active-p))
20723 (org-call-for-shift-select 'next-line))
20724 ((org-at-timestamp-p t)
20725 (call-interactively (if org-edit-timestamp-down-means-later
20726 'org-timestamp-up 'org-timestamp-down)))
20727 ((and (not (eq org-support-shift-select 'always))
20728 org-enable-priority-commands
20729 (org-at-heading-p))
20730 (call-interactively 'org-priority-down))
20731 ((and (not org-support-shift-select) (org-at-item-p))
20732 (call-interactively 'org-next-item))
20733 ((org-clocktable-try-shift 'down arg))
20734 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20735 (org-support-shift-select
20736 (org-call-for-shift-select 'next-line))
20737 (t (org-shiftselect-error))))
20739 (defun org-shiftright (&optional arg)
20740 "Cycle the thing at point or in the current line, depending on context.
20741 Depending on context, this does one of the following:
20743 - switch a timestamp at point one day into the future
20744 - on a headline, switch to the next TODO keyword.
20745 - on an item, switch entire list to the next bullet type
20746 - on a property line, switch to the next allowed value
20747 - on a clocktable definition line, move time block into the future"
20748 (interactive "P")
20749 (cond
20750 ((run-hook-with-args-until-success 'org-shiftright-hook))
20751 ((and org-support-shift-select (org-region-active-p))
20752 (org-call-for-shift-select 'forward-char))
20753 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20754 ((and (not (eq org-support-shift-select 'always))
20755 (org-at-heading-p))
20756 (let ((org-inhibit-logging
20757 (not org-treat-S-cursor-todo-selection-as-state-change))
20758 (org-inhibit-blocking
20759 (not org-treat-S-cursor-todo-selection-as-state-change)))
20760 (org-call-with-arg 'org-todo 'right)))
20761 ((or (and org-support-shift-select
20762 (not (eq org-support-shift-select 'always))
20763 (org-at-item-bullet-p))
20764 (and (not org-support-shift-select) (org-at-item-p)))
20765 (org-call-with-arg 'org-cycle-list-bullet nil))
20766 ((and (not (eq org-support-shift-select 'always))
20767 (org-at-property-p))
20768 (call-interactively 'org-property-next-allowed-value))
20769 ((org-clocktable-try-shift 'right arg))
20770 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20771 (org-support-shift-select
20772 (org-call-for-shift-select 'forward-char))
20773 (t (org-shiftselect-error))))
20775 (defun org-shiftleft (&optional arg)
20776 "Cycle the thing at point or in the current line, depending on context.
20777 Depending on context, this does one of the following:
20779 - switch a timestamp at point one day into the past
20780 - on a headline, switch to the previous TODO keyword.
20781 - on an item, switch entire list to the previous bullet type
20782 - on a property line, switch to the previous allowed value
20783 - on a clocktable definition line, move time block into the past"
20784 (interactive "P")
20785 (cond
20786 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20787 ((and org-support-shift-select (org-region-active-p))
20788 (org-call-for-shift-select 'backward-char))
20789 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20790 ((and (not (eq org-support-shift-select 'always))
20791 (org-at-heading-p))
20792 (let ((org-inhibit-logging
20793 (not org-treat-S-cursor-todo-selection-as-state-change))
20794 (org-inhibit-blocking
20795 (not org-treat-S-cursor-todo-selection-as-state-change)))
20796 (org-call-with-arg 'org-todo 'left)))
20797 ((or (and org-support-shift-select
20798 (not (eq org-support-shift-select 'always))
20799 (org-at-item-bullet-p))
20800 (and (not org-support-shift-select) (org-at-item-p)))
20801 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20802 ((and (not (eq org-support-shift-select 'always))
20803 (org-at-property-p))
20804 (call-interactively 'org-property-previous-allowed-value))
20805 ((org-clocktable-try-shift 'left arg))
20806 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20807 (org-support-shift-select
20808 (org-call-for-shift-select 'backward-char))
20809 (t (org-shiftselect-error))))
20811 (defun org-shiftcontrolright ()
20812 "Switch to next TODO set."
20813 (interactive)
20814 (cond
20815 ((and org-support-shift-select (org-region-active-p))
20816 (org-call-for-shift-select 'forward-word))
20817 ((and (not (eq org-support-shift-select 'always))
20818 (org-at-heading-p))
20819 (org-call-with-arg 'org-todo 'nextset))
20820 (org-support-shift-select
20821 (org-call-for-shift-select 'forward-word))
20822 (t (org-shiftselect-error))))
20824 (defun org-shiftcontrolleft ()
20825 "Switch to previous TODO set."
20826 (interactive)
20827 (cond
20828 ((and org-support-shift-select (org-region-active-p))
20829 (org-call-for-shift-select 'backward-word))
20830 ((and (not (eq org-support-shift-select 'always))
20831 (org-at-heading-p))
20832 (org-call-with-arg 'org-todo 'previousset))
20833 (org-support-shift-select
20834 (org-call-for-shift-select 'backward-word))
20835 (t (org-shiftselect-error))))
20837 (defun org-shiftcontrolup (&optional n)
20838 "Change timestamps synchronously up in CLOCK log lines.
20839 Optional argument N tells to change by that many units."
20840 (interactive "P")
20841 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20842 (let (org-support-shift-select)
20843 (org-clock-timestamps-up n))
20844 (user-error "Not at a clock log")))
20846 (defun org-shiftcontroldown (&optional n)
20847 "Change timestamps synchronously down in CLOCK log lines.
20848 Optional argument N tells to change by that many units."
20849 (interactive "P")
20850 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20851 (let (org-support-shift-select)
20852 (org-clock-timestamps-down n))
20853 (user-error "Not at a clock log")))
20855 (defun org-increase-number-at-point (&optional inc)
20856 "Increment the number at point.
20857 With an optional prefix numeric argument INC, increment using
20858 this numeric value."
20859 (interactive "p")
20860 (if (not (number-at-point))
20861 (user-error "Not on a number")
20862 (unless inc (setq inc 1))
20863 (let ((pos (point))
20864 (beg (skip-chars-backward "-+^/*0-9eE."))
20865 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20866 (setq nap (buffer-substring-no-properties
20867 (+ pos beg) (+ pos beg end)))
20868 (delete-region (+ pos beg) (+ pos beg end))
20869 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20870 (when (org-at-table-p)
20871 (org-table-align)
20872 (org-table-end-of-field 1))))
20874 (defun org-decrease-number-at-point (&optional inc)
20875 "Decrement the number at point.
20876 With an optional prefix numeric argument INC, decrement using
20877 this numeric value."
20878 (interactive "p")
20879 (org-increase-number-at-point (- (or inc 1))))
20881 (defun org-ctrl-c-ret ()
20882 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20883 (interactive)
20884 (cond
20885 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20886 (t (call-interactively 'org-insert-heading))))
20888 (defun org-find-visible ()
20889 (let ((s (point)))
20890 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20891 (get-char-property s 'invisible)))
20893 (defun org-find-invisible ()
20894 (let ((s (point)))
20895 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20896 (not (get-char-property s 'invisible))))
20899 (defun org-copy-visible (beg end)
20900 "Copy the visible parts of the region."
20901 (interactive "r")
20902 (let (snippets s)
20903 (save-excursion
20904 (save-restriction
20905 (narrow-to-region beg end)
20906 (setq s (goto-char (point-min)))
20907 (while (not (= (point) (point-max)))
20908 (goto-char (org-find-invisible))
20909 (push (buffer-substring s (point)) snippets)
20910 (setq s (goto-char (org-find-visible))))))
20911 (kill-new (apply 'concat (nreverse snippets)))))
20913 (defun org-copy-special ()
20914 "Copy region in table or copy current subtree.
20915 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20916 See the individual commands for more information."
20917 (interactive)
20918 (call-interactively
20919 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20921 (defun org-cut-special ()
20922 "Cut region in table or cut current subtree.
20923 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20924 See the individual commands for more information."
20925 (interactive)
20926 (call-interactively
20927 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20929 (defun org-paste-special (arg)
20930 "Paste rectangular region into table, or past subtree relative to level.
20931 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20932 See the individual commands for more information."
20933 (interactive "P")
20934 (if (org-at-table-p)
20935 (org-table-paste-rectangle)
20936 (org-paste-subtree arg)))
20938 (defsubst org-in-fixed-width-region-p ()
20939 "Is point in a fixed-width region?"
20940 (save-match-data
20941 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20943 (defun org-edit-special (&optional arg)
20944 "Call a special editor for the element at point.
20945 When at a table, call the formula editor with `org-table-edit-formulas'.
20946 When in a source code block, call `org-edit-src-code'.
20947 When in a fixed-width region, call `org-edit-fixed-width-region'.
20948 When in an export block, call `org-edit-export-block'.
20949 When at an #+INCLUDE keyword, visit the included file.
20950 When at a footnote reference, call `org-edit-footnote-reference'
20951 On a link, call `ffap' to visit the link at point.
20952 Otherwise, return a user error."
20953 (interactive "P")
20954 (let ((element (org-element-at-point)))
20955 (assert (not buffer-read-only) nil
20956 "Buffer is read-only: %s" (buffer-name))
20957 (case (org-element-type element)
20958 (src-block
20959 (if (not arg) (org-edit-src-code)
20960 (let* ((info (org-babel-get-src-block-info))
20961 (lang (nth 0 info))
20962 (params (nth 2 info))
20963 (session (cdr (assq :session params))))
20964 (if (not session) (org-edit-src-code)
20965 ;; At a src-block with a session and function called with
20966 ;; an ARG: switch to the buffer related to the inferior
20967 ;; process.
20968 (switch-to-buffer
20969 (funcall (intern (concat "org-babel-prep-session:" lang))
20970 session params))))))
20971 (keyword
20972 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20973 (org-open-link-from-string
20974 (format "[[%s]]"
20975 (expand-file-name
20976 (let ((value (org-element-property :value element)))
20977 (cond ((not (org-string-nw-p value))
20978 (user-error "No file to edit"))
20979 ((string-match "\\`\"\\(.*?\\)\"" value)
20980 (match-string 1 value))
20981 ((string-match "\\`[^ \t\"]\\S-*" value)
20982 (match-string 0 value))
20983 (t (user-error "No valid file specified")))))))
20984 (user-error "No special environment to edit here")))
20985 (table
20986 (if (eq (org-element-property :type element) 'table.el)
20987 (org-edit-table.el)
20988 (call-interactively 'org-table-edit-formulas)))
20989 ;; Only Org tables contain `table-row' type elements.
20990 (table-row (call-interactively 'org-table-edit-formulas))
20991 (example-block (org-edit-src-code))
20992 (export-block (org-edit-export-block))
20993 (fixed-width (org-edit-fixed-width-region))
20994 (otherwise
20995 ;; No notable element at point. Though, we may be at a link or
20996 ;; a footnote reference, which are objects. Thus, scan deeper.
20997 (let ((context (org-element-context element)))
20998 (case (org-element-type context)
20999 (link (call-interactively #'ffap))
21000 (footnote-reference (org-edit-footnote-reference))
21001 (t (user-error "No special environment to edit here"))))))))
21003 (defvar org-table-coordinate-overlays) ; defined in org-table.el
21004 (defun org-ctrl-c-ctrl-c (&optional arg)
21005 "Set tags in headline, or update according to changed information at point.
21007 This command does many different things, depending on context:
21009 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
21010 this is what we do.
21012 - If the cursor is on a statistics cookie, update it.
21014 - If the cursor is in a headline, prompt for tags and insert them
21015 into the current line, aligned to `org-tags-column'. When called
21016 with prefix arg, realign all tags in the current buffer.
21018 - If the cursor is in one of the special #+KEYWORD lines, this
21019 triggers scanning the buffer for these lines and updating the
21020 information.
21022 - If the cursor is inside a table, realign the table. This command
21023 works even if the automatic table editor has been turned off.
21025 - If the cursor is on a #+TBLFM line, re-apply the formulas to
21026 the entire table.
21028 - If the cursor is at a footnote reference or definition, jump to
21029 the corresponding definition or references, respectively.
21031 - If the cursor is a the beginning of a dynamic block, update it.
21033 - If the current buffer is a capture buffer, close note and file it.
21035 - If the cursor is on a <<<target>>>, update radio targets and
21036 corresponding links in this buffer.
21038 - If the cursor is on a numbered item in a plain list, renumber the
21039 ordered list.
21041 - If the cursor is on a checkbox, toggle it.
21043 - If the cursor is on a code block, evaluate it. The variable
21044 `org-confirm-babel-evaluate' can be used to control prompting
21045 before code block evaluation, by default every code block
21046 evaluation requires confirmation. Code block evaluation can be
21047 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21048 (interactive "P")
21049 (cond
21050 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
21051 org-occur-highlights)
21052 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21053 (org-remove-occur-highlights)
21054 (message "Temporary highlights/overlays removed from current buffer"))
21055 ((and (local-variable-p 'org-finish-function (current-buffer))
21056 (fboundp org-finish-function))
21057 (funcall org-finish-function))
21058 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21060 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
21061 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21062 (user-error "C-c C-c can do nothing useful at this location"))
21063 (let* ((context (org-element-context))
21064 (type (org-element-type context)))
21065 (case type
21066 ;; When at a link, act according to the parent instead.
21067 (link (setq context (org-element-property :parent context))
21068 (setq type (org-element-type context)))
21069 ;; Unsupported object types: refer to the first supported
21070 ;; element or object containing it.
21071 ((bold code entity export-snippet inline-babel-call inline-src-block
21072 italic latex-fragment line-break macro strike-through subscript
21073 superscript underline verbatim)
21074 (setq context
21075 (org-element-lineage
21076 context '(radio-target paragraph verse-block table-cell)))))
21077 ;; For convenience: at the first line of a paragraph on the
21078 ;; same line as an item, apply function on that item instead.
21079 (when (eq type 'paragraph)
21080 (let ((parent (org-element-property :parent context)))
21081 (when (and (eq (org-element-type parent) 'item)
21082 (= (line-beginning-position)
21083 (org-element-property :begin parent)))
21084 (setq context parent type 'item))))
21085 ;; Act according to type of element or object at point.
21086 (case type
21087 (clock (org-clock-update-time-maybe))
21088 (dynamic-block
21089 (save-excursion
21090 (goto-char (org-element-property :post-affiliated context))
21091 (org-update-dblock)))
21092 (footnote-definition
21093 (goto-char (org-element-property :post-affiliated context))
21094 (call-interactively 'org-footnote-action))
21095 (footnote-reference (call-interactively 'org-footnote-action))
21096 ((headline inlinetask)
21097 (save-excursion (goto-char (org-element-property :begin context))
21098 (call-interactively 'org-set-tags)))
21099 (item
21100 ;; At an item: a double C-u set checkbox to "[-]"
21101 ;; unconditionally, whereas a single one will toggle its
21102 ;; presence. Without a universal argument, if the item
21103 ;; has a checkbox, toggle it. Otherwise repair the list.
21104 (let* ((box (org-element-property :checkbox context))
21105 (struct (org-element-property :structure context))
21106 (old-struct (copy-tree struct))
21107 (parents (org-list-parents-alist struct))
21108 (prevs (org-list-prevs-alist struct))
21109 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21110 (org-list-set-checkbox
21111 (org-element-property :begin context) struct
21112 (cond ((equal arg '(16)) "[-]")
21113 ((and (not box) (equal arg '(4))) "[ ]")
21114 ((or (not box) (equal arg '(4))) nil)
21115 ((eq box 'on) "[ ]")
21116 (t "[X]")))
21117 ;; Mimic `org-list-write-struct' but with grabbing
21118 ;; a return value from `org-list-struct-fix-box'.
21119 (org-list-struct-fix-ind struct parents 2)
21120 (org-list-struct-fix-item-end struct)
21121 (org-list-struct-fix-bul struct prevs)
21122 (org-list-struct-fix-ind struct parents)
21123 (let ((block-item
21124 (org-list-struct-fix-box struct parents prevs orderedp)))
21125 (if (and box (equal struct old-struct))
21126 (if (equal arg '(16))
21127 (message "Checkboxes already reset")
21128 (user-error "Cannot toggle this checkbox: %s"
21129 (if (eq box 'on)
21130 "all subitems checked"
21131 "unchecked subitems")))
21132 (org-list-struct-apply-struct struct old-struct)
21133 (org-update-checkbox-count-maybe))
21134 (when block-item
21135 (message "Checkboxes were removed due to empty box at line %d"
21136 (org-current-line block-item))))))
21137 (keyword
21138 (let ((org-inhibit-startup-visibility-stuff t)
21139 (org-startup-align-all-tables nil))
21140 (when (boundp 'org-table-coordinate-overlays)
21141 (mapc 'delete-overlay org-table-coordinate-overlays)
21142 (setq org-table-coordinate-overlays nil))
21143 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21144 (message "Local setup has been refreshed"))
21145 (plain-list
21146 ;; At a plain list, with a double C-u argument, set
21147 ;; checkboxes of each item to "[-]", whereas a single one
21148 ;; will toggle their presence according to the state of the
21149 ;; first item in the list. Without an argument, repair the
21150 ;; list.
21151 (let* ((begin (org-element-property :contents-begin context))
21152 (beginm (move-marker (make-marker) begin))
21153 (struct (org-element-property :structure context))
21154 (old-struct (copy-tree struct))
21155 (first-box (save-excursion
21156 (goto-char begin)
21157 (looking-at org-list-full-item-re)
21158 (match-string-no-properties 3)))
21159 (new-box (cond ((equal arg '(16)) "[-]")
21160 ((equal arg '(4)) (unless first-box "[ ]"))
21161 ((equal first-box "[X]") "[ ]")
21162 (t "[X]"))))
21163 (cond
21164 (arg
21165 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21166 (org-list-get-all-items
21167 begin struct (org-list-prevs-alist struct))))
21168 ((and first-box (eq (point) begin))
21169 ;; For convenience, when point is at bol on the first
21170 ;; item of the list and no argument is provided, simply
21171 ;; toggle checkbox of that item, if any.
21172 (org-list-set-checkbox begin struct new-box)))
21173 (org-list-write-struct
21174 struct (org-list-parents-alist struct) old-struct)
21175 (org-update-checkbox-count-maybe)
21176 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21177 ((property-drawer node-property)
21178 (call-interactively 'org-property-action))
21179 ((radio-target target)
21180 (call-interactively 'org-update-radio-target-regexp))
21181 (statistics-cookie
21182 (call-interactively 'org-update-statistics-cookies))
21183 ((table table-cell table-row)
21184 ;; At a table, recalculate every field and align it. Also
21185 ;; send the table if necessary. If the table has
21186 ;; a `table.el' type, just give up. At a table row or
21187 ;; cell, maybe recalculate line but always align table.
21188 (if (eq (org-element-property :type context) 'table.el)
21189 (message "Use C-c ' to edit table.el tables")
21190 (let ((org-enable-table-editor t))
21191 (if (or (eq type 'table)
21192 ;; Check if point is at a TBLFM line.
21193 (and (eq type 'table-row)
21194 (= (point) (org-element-property :end context))))
21195 (save-excursion
21196 (if (org-at-TBLFM-p)
21197 (progn (require 'org-table)
21198 (org-table-calc-current-TBLFM))
21199 (goto-char (org-element-property :contents-begin context))
21200 (org-call-with-arg 'org-table-recalculate (or arg t))
21201 (orgtbl-send-table 'maybe)))
21202 (org-table-maybe-eval-formula)
21203 (cond (arg (call-interactively 'org-table-recalculate))
21204 ((org-table-maybe-recalculate-line))
21205 (t (org-table-align)))))))
21206 (timestamp (org-timestamp-change 0 'day))
21207 (otherwise
21208 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21209 (user-error
21210 "C-c C-c can do nothing useful at this location")))))))))
21212 (defun org-mode-restart ()
21213 (interactive)
21214 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21215 (funcall major-mode)
21216 (hack-local-variables)
21217 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21218 (org-indent-mode -1)))
21219 (message "%s restarted" major-mode))
21221 (defun org-kill-note-or-show-branches ()
21222 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21223 (interactive)
21224 (if (not org-finish-function)
21225 (progn
21226 (hide-subtree)
21227 (call-interactively 'show-branches))
21228 (let ((org-note-abort t))
21229 (funcall org-finish-function))))
21231 (defun org-delete-indentation (&optional ARG)
21232 "Join current line to previous and fix whitespace at join.
21234 If previous line is a headline add to headline title. Otherwise
21235 the function calls `delete-indentation'.
21237 With argument, join this line to following line."
21238 (interactive "*P")
21239 (if (save-excursion
21240 (if ARG (beginning-of-line)
21241 (forward-line -1))
21242 (looking-at org-complex-heading-regexp))
21243 ;; At headline.
21244 (let ((tags-column (when (match-beginning 5)
21245 (save-excursion (goto-char (match-beginning 5))
21246 (current-column))))
21247 (string (concat " " (progn (when ARG (forward-line 1))
21248 (org-trim (delete-and-extract-region
21249 (line-beginning-position)
21250 (line-end-position)))))))
21251 (unless (bobp) (delete-region (point) (1- (point))))
21252 (goto-char (or (match-end 4)
21253 (match-beginning 5)
21254 (match-end 0)))
21255 (skip-chars-backward " \t")
21256 (save-excursion (insert string))
21257 ;; Adjust alignment of tags.
21258 (when tags-column
21259 (org-align-tags-here (if org-auto-align-tags
21260 org-tags-column
21261 tags-column))))
21262 (delete-indentation ARG)))
21264 (defun org-open-line (n)
21265 "Insert a new row in tables, call `open-line' elsewhere.
21266 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21267 (interactive "*p")
21268 (cond
21269 ((not org-special-ctrl-o)
21270 (open-line n))
21271 ((org-at-table-p)
21272 (org-table-insert-row))
21274 (open-line n))))
21276 (defun org-return (&optional indent)
21277 "Goto next table row or insert a newline.
21279 Calls `org-table-next-row' or `newline', depending on context.
21281 When optional INDENT argument is non-nil, call
21282 `newline-and-indent' instead of `newline'.
21284 When `org-return-follows-link' is non-nil and point is on
21285 a timestamp or a link, call `org-open-at-point'. However, it
21286 will not happen if point is in a table or on a \"dead\"
21287 object (e.g., within a comment). In these case, you need to use
21288 `org-open-at-point' directly."
21289 (interactive)
21290 (let* ((context (if org-return-follows-link (org-element-context)
21291 (org-element-at-point)))
21292 (type (org-element-type context)))
21293 (cond
21294 ;; In a table, call `org-table-next-row'.
21295 ((or (and (eq type 'table)
21296 (>= (point) (org-element-property :contents-begin context))
21297 (< (point) (org-element-property :contents-end context)))
21298 (org-element-lineage context '(table-row table-cell) t))
21299 (org-table-justify-field-maybe)
21300 (call-interactively #'org-table-next-row))
21301 ;; On a link or a timestamp but not on white spaces after it,
21302 ;; call `org-open-line' if `org-return-follows-link' allows it.
21303 ((and org-return-follows-link
21304 (memq type '(link timestamp))
21305 (< (point)
21306 (save-excursion (goto-char (org-element-property :end context))
21307 (skip-chars-backward " \t")
21308 (point))))
21309 (call-interactively #'org-open-at-point))
21310 ;; Insert newline in heading, but preserve tags.
21311 ((and (not (bolp))
21312 (save-excursion (beginning-of-line)
21313 (looking-at org-complex-heading-regexp)))
21314 ;; At headline. Split line. However, if point is on keyword,
21315 ;; priority cookie or tags, do not break any of them: add
21316 ;; a newline after the headline instead.
21317 (let ((tags-column (and (match-beginning 5)
21318 (save-excursion (goto-char (match-beginning 5))
21319 (current-column))))
21320 (string
21321 (when (and (match-end 4)
21322 (>= (point)
21323 (or (match-end 3) (match-end 2) (1+ (match-end 1))))
21324 (<= (point) (match-end 4)))
21325 (delete-and-extract-region (point) (match-end 4)))))
21326 (when (and tags-column string) ; Adjust tag alignment.
21327 (org-align-tags-here
21328 (if org-auto-align-tags org-tags-column tags-column)))
21329 (end-of-line)
21330 (org-show-entry)
21331 (if indent (newline-and-indent) (newline))
21332 (when string (save-excursion (insert (org-trim string))))))
21333 ;; In a list, make sure indenting keeps trailing text within.
21334 ((and indent
21335 (not (eolp))
21336 (org-element-lineage context '(item)))
21337 (let ((trailing-data
21338 (delete-and-extract-region (point) (line-end-position))))
21339 (newline-and-indent)
21340 (save-excursion (insert trailing-data))))
21341 (t (if indent (newline-and-indent) (newline))))))
21343 (defun org-return-indent ()
21344 "Goto next table row or insert a newline and indent.
21345 Calls `org-table-next-row' or `newline-and-indent', depending on
21346 context. See the individual commands for more information."
21347 (interactive)
21348 (org-return t))
21350 (defun org-ctrl-c-star ()
21351 "Compute table, or change heading status of lines.
21352 Calls `org-table-recalculate' or `org-toggle-heading',
21353 depending on context."
21354 (interactive)
21355 (cond
21356 ((org-at-table-p)
21357 (call-interactively 'org-table-recalculate))
21359 ;; Convert all lines in region to list items
21360 (call-interactively 'org-toggle-heading))))
21362 (defun org-ctrl-c-minus ()
21363 "Insert separator line in table or modify bullet status of line.
21364 Also turns a plain line or a region of lines into list items.
21365 Calls `org-table-insert-hline', `org-toggle-item', or
21366 `org-cycle-list-bullet', depending on context."
21367 (interactive)
21368 (cond
21369 ((org-at-table-p)
21370 (call-interactively 'org-table-insert-hline))
21371 ((org-region-active-p)
21372 (call-interactively 'org-toggle-item))
21373 ((org-in-item-p)
21374 (call-interactively 'org-cycle-list-bullet))
21376 (call-interactively 'org-toggle-item))))
21378 (defun org-toggle-item (arg)
21379 "Convert headings or normal lines to items, items to normal lines.
21380 If there is no active region, only the current line is considered.
21382 If the first non blank line in the region is a headline, convert
21383 all headlines to items, shifting text accordingly.
21385 If it is an item, convert all items to normal lines.
21387 If it is normal text, change region into a list of items.
21388 With a prefix argument ARG, change the region in a single item."
21389 (interactive "P")
21390 (let ((shift-text
21391 (function
21392 ;; Shift text in current section to IND, from point to END.
21393 ;; The function leaves point to END line.
21394 (lambda (ind end)
21395 (let ((min-i 1000) (end (copy-marker end)))
21396 ;; First determine the minimum indentation (MIN-I) of
21397 ;; the text.
21398 (save-excursion
21399 (catch 'exit
21400 (while (< (point) end)
21401 (let ((i (org-get-indentation)))
21402 (cond
21403 ;; Skip blank lines and inline tasks.
21404 ((looking-at "^[ \t]*$"))
21405 ((looking-at org-outline-regexp-bol))
21406 ;; We can't find less than 0 indentation.
21407 ((zerop i) (throw 'exit (setq min-i 0)))
21408 ((< i min-i) (setq min-i i))))
21409 (forward-line))))
21410 ;; Then indent each line so that a line indented to
21411 ;; MIN-I becomes indented to IND. Ignore blank lines
21412 ;; and inline tasks in the process.
21413 (let ((delta (- ind min-i)))
21414 (while (< (point) end)
21415 (unless (or (looking-at "^[ \t]*$")
21416 (looking-at org-outline-regexp-bol))
21417 (org-indent-line-to (+ (org-get-indentation) delta)))
21418 (forward-line)))))))
21419 (skip-blanks
21420 (function
21421 ;; Return beginning of first non-blank line, starting from
21422 ;; line at POS.
21423 (lambda (pos)
21424 (save-excursion
21425 (goto-char pos)
21426 (skip-chars-forward " \r\t\n")
21427 (point-at-bol)))))
21428 beg end)
21429 ;; Determine boundaries of changes.
21430 (if (org-region-active-p)
21431 (setq beg (funcall skip-blanks (region-beginning))
21432 end (copy-marker (region-end)))
21433 (setq beg (funcall skip-blanks (point-at-bol))
21434 end (copy-marker (point-at-eol))))
21435 ;; Depending on the starting line, choose an action on the text
21436 ;; between BEG and END.
21437 (org-with-limited-levels
21438 (save-excursion
21439 (goto-char beg)
21440 (cond
21441 ;; Case 1. Start at an item: de-itemize. Note that it only
21442 ;; happens when a region is active: `org-ctrl-c-minus'
21443 ;; would call `org-cycle-list-bullet' otherwise.
21444 ((org-at-item-p)
21445 (while (< (point) end)
21446 (when (org-at-item-p)
21447 (skip-chars-forward " \t")
21448 (delete-region (point) (match-end 0)))
21449 (forward-line)))
21450 ;; Case 2. Start at an heading: convert to items.
21451 ((org-at-heading-p)
21452 (let* ((bul (org-list-bullet-string "-"))
21453 (bul-len (length bul))
21454 (done (org-entry-is-done-p))
21455 (todo (org-entry-is-todo-p))
21456 ;; Indentation of the first heading. It should be
21457 ;; relative to the indentation of its parent, if any.
21458 (start-ind (save-excursion
21459 (cond
21460 ((not org-adapt-indentation) 0)
21461 ((not (outline-previous-heading)) 0)
21462 (t (length (match-string 0))))))
21463 ;; Level of first heading. Further headings will be
21464 ;; compared to it to determine hierarchy in the list.
21465 (ref-level (org-reduced-level (org-outline-level))))
21466 (when (or done todo) (org-todo ""))
21467 (while (< (point) end)
21468 (let* ((level (org-reduced-level (org-outline-level)))
21469 (delta (max 0 (- level ref-level))))
21470 ;; If current headline is less indented than the first
21471 ;; one, set it as reference, in order to preserve
21472 ;; subtrees.
21473 (when (< level ref-level) (setq ref-level level))
21474 (replace-match bul t t)
21475 (org-indent-line-to (+ start-ind (* delta bul-len)))
21476 (when (or done todo)
21477 (let* ((struct (org-list-struct))
21478 (old (copy-tree struct)))
21479 (org-list-set-checkbox (line-beginning-position)
21480 struct
21481 (if done "[X]" "[ ]"))
21482 (org-list-write-struct struct
21483 (org-list-parents-alist struct)
21484 old)))
21485 ;; Ensure all text down to END (or SECTION-END) belongs
21486 ;; to the newly created item.
21487 (let ((section-end (save-excursion
21488 (or (outline-next-heading) (point)))))
21489 (forward-line)
21490 (funcall shift-text
21491 (+ start-ind (* (1+ delta) bul-len))
21492 (min end section-end)))))))
21493 ;; Case 3. Normal line with ARG: make the first line of region
21494 ;; an item, and shift indentation of others lines to
21495 ;; set them as item's body.
21496 (arg (let* ((bul (org-list-bullet-string "-"))
21497 (bul-len (length bul))
21498 (ref-ind (org-get-indentation)))
21499 (skip-chars-forward " \t")
21500 (insert bul)
21501 (forward-line)
21502 (while (< (point) end)
21503 ;; Ensure that lines less indented than first one
21504 ;; still get included in item body.
21505 (funcall shift-text
21506 (+ ref-ind bul-len)
21507 (min end (save-excursion (or (outline-next-heading)
21508 (point)))))
21509 (forward-line))))
21510 ;; Case 4. Normal line without ARG: turn each non-item line
21511 ;; into an item.
21513 (while (< (point) end)
21514 (unless (or (org-at-heading-p) (org-at-item-p))
21515 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21516 (replace-match
21517 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21518 (forward-line))))))))
21520 (defun org-toggle-heading (&optional nstars)
21521 "Convert headings to normal text, or items or text to headings.
21522 If there is no active region, only convert the current line.
21524 With a \\[universal-argument] prefix, convert the whole list at
21525 point into heading.
21527 In a region:
21529 - If the first non blank line is a headline, remove the stars
21530 from all headlines in the region.
21532 - If it is a normal line, turn each and every normal line (i.e.,
21533 not an heading or an item) in the region into headings. If you
21534 want to convert only the first line of this region, use one
21535 universal prefix argument.
21537 - If it is a plain list item, turn all plain list items into headings.
21539 When converting a line into a heading, the number of stars is chosen
21540 such that the lines become children of the current entry. However,
21541 when a numeric prefix argument is given, its value determines the
21542 number of stars to add."
21543 (interactive "P")
21544 (let ((skip-blanks
21545 (function
21546 ;; Return beginning of first non-blank line, starting from
21547 ;; line at POS.
21548 (lambda (pos)
21549 (save-excursion
21550 (goto-char pos)
21551 (while (org-at-comment-p) (forward-line))
21552 (skip-chars-forward " \r\t\n")
21553 (point-at-bol)))))
21554 beg end toggled)
21555 ;; Determine boundaries of changes. If a universal prefix has
21556 ;; been given, put the list in a region. If region ends at a bol,
21557 ;; do not consider the last line to be in the region.
21559 (when (and current-prefix-arg (org-at-item-p))
21560 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21561 (org-mark-element))
21563 (if (org-region-active-p)
21564 (setq beg (funcall skip-blanks (region-beginning))
21565 end (copy-marker (save-excursion
21566 (goto-char (region-end))
21567 (if (bolp) (point) (point-at-eol)))))
21568 (setq beg (funcall skip-blanks (point-at-bol))
21569 end (copy-marker (point-at-eol))))
21570 ;; Ensure inline tasks don't count as headings.
21571 (org-with-limited-levels
21572 (save-excursion
21573 (goto-char beg)
21574 (cond
21575 ;; Case 1. Started at an heading: de-star headings.
21576 ((org-at-heading-p)
21577 (while (< (point) end)
21578 (when (org-at-heading-p t)
21579 (looking-at org-outline-regexp) (replace-match "")
21580 (setq toggled t))
21581 (forward-line)))
21582 ;; Case 2. Started at an item: change items into headlines.
21583 ;; One star will be added by `org-list-to-subtree'.
21584 ((org-at-item-p)
21585 (while (< (point) end)
21586 (when (org-at-item-p)
21587 ;; Pay attention to cases when region ends before list.
21588 (let* ((struct (org-list-struct))
21589 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21590 (save-restriction
21591 (narrow-to-region (point) list-end)
21592 (insert (org-list-to-subtree (org-list-parse-list t)))))
21593 (setq toggled t))
21594 (forward-line)))
21595 ;; Case 3. Started at normal text: make every line an heading,
21596 ;; skipping headlines and items.
21597 (t (let* ((stars
21598 (make-string
21599 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21600 (add-stars
21601 (cond (nstars "") ; stars from prefix only
21602 ((equal stars "") "*") ; before first heading
21603 (org-odd-levels-only "**") ; inside heading, odd
21604 (t "*"))) ; inside heading, oddeven
21605 (rpl (concat stars add-stars " "))
21606 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21607 (while (< (point) (if (equal nstars '(4)) lend end))
21608 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21609 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21610 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21611 (forward-line)))))))
21612 (unless toggled (message "Cannot toggle heading from here"))))
21614 (defun org-meta-return (&optional _arg)
21615 "Insert a new heading or wrap a region in a table.
21616 Calls `org-insert-heading' or `org-table-wrap-region', depending
21617 on context. See the individual commands for more information."
21618 (interactive)
21619 (org-check-before-invisible-edit 'insert)
21620 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21621 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21622 #'org-insert-heading))))
21624 ;;; Menu entries
21626 (defsubst org-in-subtree-not-table-p ()
21627 "Are we in a subtree and not in a table?"
21628 (and (not (org-before-first-heading-p))
21629 (not (org-at-table-p))))
21631 ;; Define the Org-mode menus
21632 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21633 '("Tbl"
21634 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21635 ["Next Field" org-cycle (org-at-table-p)]
21636 ["Previous Field" org-shifttab (org-at-table-p)]
21637 ["Next Row" org-return (org-at-table-p)]
21638 "--"
21639 ["Blank Field" org-table-blank-field (org-at-table-p)]
21640 ["Edit Field" org-table-edit-field (org-at-table-p)]
21641 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21642 "--"
21643 ("Column"
21644 ["Move Column Left" org-metaleft (org-at-table-p)]
21645 ["Move Column Right" org-metaright (org-at-table-p)]
21646 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21647 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21648 ("Row"
21649 ["Move Row Up" org-metaup (org-at-table-p)]
21650 ["Move Row Down" org-metadown (org-at-table-p)]
21651 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21652 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21653 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21654 "--"
21655 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21656 ("Rectangle"
21657 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21658 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21659 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21660 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21661 "--"
21662 ("Calculate"
21663 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21664 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21665 ["Edit Formulas" org-edit-special (org-at-table-p)]
21666 "--"
21667 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21668 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21669 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21670 "--"
21671 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21672 "--"
21673 ["Sum Column/Rectangle" org-table-sum
21674 (or (org-at-table-p) (org-region-active-p))]
21675 ["Which Column?" org-table-current-column (org-at-table-p)])
21676 ["Debug Formulas"
21677 org-table-toggle-formula-debugger
21678 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21679 ["Show Col/Row Numbers"
21680 org-table-toggle-coordinate-overlays
21681 :style toggle
21682 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21683 "--"
21684 ["Create" org-table-create (and (not (org-at-table-p))
21685 org-enable-table-editor)]
21686 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21687 ["Import from File" org-table-import (not (org-at-table-p))]
21688 ["Export to File" org-table-export (org-at-table-p)]
21689 "--"
21690 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21691 "--"
21692 ("Plot"
21693 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21694 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21696 (easy-menu-define org-org-menu org-mode-map "Org menu"
21697 '("Org"
21698 ("Show/Hide"
21699 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21700 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21701 ["Sparse Tree..." org-sparse-tree t]
21702 ["Reveal Context" org-reveal t]
21703 ["Show All" show-all t]
21704 "--"
21705 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21706 "--"
21707 ["New Heading" org-insert-heading t]
21708 ("Navigate Headings"
21709 ["Up" outline-up-heading t]
21710 ["Next" outline-next-visible-heading t]
21711 ["Previous" outline-previous-visible-heading t]
21712 ["Next Same Level" outline-forward-same-level t]
21713 ["Previous Same Level" outline-backward-same-level t]
21714 "--"
21715 ["Jump" org-goto t])
21716 ("Edit Structure"
21717 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21718 "--"
21719 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21720 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21721 "--"
21722 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21723 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21724 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21725 "--"
21726 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21727 "--"
21728 ["Copy visible text" org-copy-visible t]
21729 "--"
21730 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21731 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21732 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21733 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21734 "--"
21735 ["Sort Region/Children" org-sort t]
21736 "--"
21737 ["Convert to odd levels" org-convert-to-odd-levels t]
21738 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21739 ("Editing"
21740 ["Emphasis..." org-emphasize t]
21741 ["Edit Source Example" org-edit-special t]
21742 "--"
21743 ["Footnote new/jump" org-footnote-action t]
21744 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21745 ("Archive"
21746 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21747 "--"
21748 ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
21749 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21750 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21752 "--"
21753 ("Hyperlinks"
21754 ["Store Link (Global)" org-store-link t]
21755 ["Find existing link to here" org-occur-link-in-agenda-files t]
21756 ["Insert Link" org-insert-link t]
21757 ["Follow Link" org-open-at-point t]
21758 "--"
21759 ["Next link" org-next-link t]
21760 ["Previous link" org-previous-link t]
21761 "--"
21762 ["Descriptive Links"
21763 org-toggle-link-display
21764 :style radio
21765 :selected org-descriptive-links
21767 ["Literal Links"
21768 org-toggle-link-display
21769 :style radio
21770 :selected (not org-descriptive-links)])
21771 "--"
21772 ("TODO Lists"
21773 ["TODO/DONE/-" org-todo t]
21774 ("Select keyword"
21775 ["Next keyword" org-shiftright (org-at-heading-p)]
21776 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21777 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21778 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21779 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21780 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21781 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21782 "--"
21783 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21784 :selected org-enforce-todo-dependencies :style toggle :active t]
21785 "Settings for tree at point"
21786 ["Do Children sequentially" org-toggle-ordered-property :style radio
21787 :selected (org-entry-get nil "ORDERED")
21788 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21789 ["Do Children parallel" org-toggle-ordered-property :style radio
21790 :selected (not (org-entry-get nil "ORDERED"))
21791 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21792 "--"
21793 ["Set Priority" org-priority t]
21794 ["Priority Up" org-shiftup t]
21795 ["Priority Down" org-shiftdown t]
21796 "--"
21797 ["Get news from all feeds" org-feed-update-all t]
21798 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21799 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21800 ("TAGS and Properties"
21801 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21802 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21803 "--"
21804 ["Set property" org-set-property (not (org-before-first-heading-p))]
21805 ["Column view of properties" org-columns t]
21806 ["Insert Column View DBlock" org-insert-columns-dblock t])
21807 ("Dates and Scheduling"
21808 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21809 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21810 ("Change Date"
21811 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21812 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21813 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21814 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21815 ["Compute Time Range" org-evaluate-time-range t]
21816 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21817 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21818 "--"
21819 ["Custom time format" org-toggle-time-stamp-overlays
21820 :style radio :selected org-display-custom-times]
21821 "--"
21822 ["Goto Calendar" org-goto-calendar t]
21823 ["Date from Calendar" org-date-from-calendar t]
21824 "--"
21825 ["Start/Restart Timer" org-timer-start t]
21826 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21827 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21828 ["Insert Timer String" org-timer t]
21829 ["Insert Timer Item" org-timer-item t])
21830 ("Logging work"
21831 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21832 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21833 ["Clock out" org-clock-out t]
21834 ["Clock cancel" org-clock-cancel t]
21835 "--"
21836 ["Mark as default task" org-clock-mark-default-task t]
21837 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21838 ["Goto running clock" org-clock-goto t]
21839 "--"
21840 ["Display times" org-clock-display t]
21841 ["Create clock table" org-clock-report t]
21842 "--"
21843 ["Record DONE time"
21844 (progn (setq org-log-done (not org-log-done))
21845 (message "Switching to %s will %s record a timestamp"
21846 (car org-done-keywords)
21847 (if org-log-done "automatically" "not")))
21848 :style toggle :selected org-log-done])
21849 "--"
21850 ["Agenda Command..." org-agenda t]
21851 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21852 ("File List for Agenda")
21853 ("Special views current file"
21854 ["TODO Tree" org-show-todo-tree t]
21855 ["Check Deadlines" org-check-deadlines t]
21856 ["Timeline" org-timeline t]
21857 ["Tags/Property tree" org-match-sparse-tree t])
21858 "--"
21859 ["Export/Publish..." org-export-dispatch t]
21860 ("LaTeX"
21861 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21862 :selected org-cdlatex-mode]
21863 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21864 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21865 ["Modify math symbol" org-cdlatex-math-modify
21866 (org-inside-LaTeX-fragment-p)]
21867 ["Insert citation" org-reftex-citation t]
21868 "--"
21869 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21870 "--"
21871 ("MobileOrg"
21872 ["Push Files and Views" org-mobile-push t]
21873 ["Get Captured and Flagged" org-mobile-pull t]
21874 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21875 "--"
21876 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21877 "--"
21878 ("Documentation"
21879 ["Show Version" org-version t]
21880 ["Info Documentation" org-info t])
21881 ("Customize"
21882 ["Browse Org Group" org-customize t]
21883 "--"
21884 ["Expand This Menu" org-create-customize-menu
21885 (fboundp 'customize-menu-create)])
21886 ["Send bug report" org-submit-bug-report t]
21887 "--"
21888 ("Refresh/Reload"
21889 ["Refresh setup current buffer" org-mode-restart t]
21890 ["Reload Org (after update)" org-reload t]
21891 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21894 (defun org-info (&optional node)
21895 "Read documentation for Org-mode in the info system.
21896 With optional NODE, go directly to that node."
21897 (interactive)
21898 (info (format "(org)%s" (or node ""))))
21900 ;;;###autoload
21901 (defun org-submit-bug-report ()
21902 "Submit a bug report on Org-mode via mail.
21904 Don't hesitate to report any problems or inaccurate documentation.
21906 If you don't have setup sending mail from (X)Emacs, please copy the
21907 output buffer into your mail program, as it gives us important
21908 information about your Org-mode version and configuration."
21909 (interactive)
21910 (require 'reporter)
21911 (defvar reporter-prompt-for-summary-p)
21912 (org-load-modules-maybe)
21913 (org-require-autoloaded-modules)
21914 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21915 (reporter-submit-bug-report
21916 "emacs-orgmode@gnu.org"
21917 (org-version nil 'full)
21918 (let (list)
21919 (save-window-excursion
21920 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21921 (delete-other-windows)
21922 (erase-buffer)
21923 (insert "You are about to submit a bug report to the Org-mode mailing list.
21925 We would like to add your full Org-mode and Outline configuration to the
21926 bug report. This greatly simplifies the work of the maintainer and
21927 other experts on the mailing list.
21929 HOWEVER, some variables you have customized may contain private
21930 information. The names of customers, colleagues, or friends, might
21931 appear in the form of file names, tags, todo states, or search strings.
21932 If you answer yes to the prompt, you might want to check and remove
21933 such private information before sending the email.")
21934 (add-text-properties (point-min) (point-max) '(face org-warning))
21935 (when (yes-or-no-p "Include your Org-mode configuration ")
21936 (mapatoms
21937 (lambda (v)
21938 (and (boundp v)
21939 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21940 (or (and (symbol-value v)
21941 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21942 (and
21943 (get v 'custom-type) (get v 'standard-value)
21944 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21945 (push v list)))))
21946 (kill-buffer (get-buffer "*Warn about privacy*"))
21947 list))
21948 nil nil
21949 "Remember to cover the basics, that is, what you expected to happen and
21950 what in fact did happen. You don't know how to make a good report? See
21952 http://orgmode.org/manual/Feedback.html#Feedback
21954 Your bug report will be posted to the Org-mode mailing list.
21955 ------------------------------------------------------------------------")
21956 (save-excursion
21957 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21958 (replace-match "\\1Bug: \\3 [\\2]")))))
21961 (defun org-install-agenda-files-menu ()
21962 (let ((bl (buffer-list)))
21963 (save-excursion
21964 (while bl
21965 (set-buffer (pop bl))
21966 (if (derived-mode-p 'org-mode) (setq bl nil)))
21967 (when (derived-mode-p 'org-mode)
21968 (easy-menu-change
21969 '("Org") "File List for Agenda"
21970 (append
21971 (list
21972 ["Edit File List" (org-edit-agenda-file-list) t]
21973 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21974 ["Remove Current File from List" org-remove-file t]
21975 ["Cycle through agenda files" org-cycle-agenda-files t]
21976 ["Occur in all agenda files" org-occur-in-agenda-files t]
21977 "--")
21978 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21980 ;;;; Documentation
21982 (defun org-require-autoloaded-modules ()
21983 (interactive)
21984 (mapc 'require
21985 '(org-agenda org-archive org-attach org-clock org-colview org-id
21986 org-table org-timer)))
21988 ;;;###autoload
21989 (defun org-reload (&optional uncompiled)
21990 "Reload all org lisp files.
21991 With prefix arg UNCOMPILED, load the uncompiled versions."
21992 (interactive "P")
21993 (require 'loadhist)
21994 (let* ((org-dir (org-find-library-dir "org"))
21995 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21996 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21997 (remove-re (mapconcat 'identity
21998 (mapcar (lambda (f) (concat "^" f "$"))
21999 (list (if (featurep 'xemacs)
22000 "org-colview"
22001 "org-colview-xemacs")
22002 "org" "org-loaddefs" "org-version"))
22003 "\\|"))
22004 (feats (delete-dups
22005 (mapcar 'file-name-sans-extension
22006 (mapcar 'file-name-nondirectory
22007 (delq nil
22008 (mapcar 'feature-file
22009 features))))))
22010 (lfeat (append
22011 (sort
22012 (setq feats
22013 (delq nil (mapcar
22014 (lambda (f)
22015 (if (and (string-match feature-re f)
22016 (not (string-match remove-re f)))
22017 f nil))
22018 feats)))
22019 'string-lessp)
22020 (list "org-version" "org")))
22021 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
22022 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
22023 load-uncore load-misses)
22024 (setq load-misses
22025 (delq 't
22026 (mapcar (lambda (f)
22027 (or (org-load-noerror-mustsuffix (concat org-dir f))
22028 (and (string= org-dir contrib-dir)
22029 (org-load-noerror-mustsuffix (concat contrib-dir f)))
22030 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
22031 (add-to-list 'load-uncore f 'append)
22034 lfeat)))
22035 (if load-uncore
22036 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
22037 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
22038 (if load-misses
22039 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
22040 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
22041 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
22043 ;;;###autoload
22044 (defun org-customize ()
22045 "Call the customize function with org as argument."
22046 (interactive)
22047 (org-load-modules-maybe)
22048 (org-require-autoloaded-modules)
22049 (customize-browse 'org))
22051 (defun org-create-customize-menu ()
22052 "Create a full customization menu for Org-mode, insert it into the menu."
22053 (interactive)
22054 (org-load-modules-maybe)
22055 (org-require-autoloaded-modules)
22056 (if (fboundp 'customize-menu-create)
22057 (progn
22058 (easy-menu-change
22059 '("Org") "Customize"
22060 `(["Browse Org group" org-customize t]
22061 "--"
22062 ,(customize-menu-create 'org)
22063 ["Set" Custom-set t]
22064 ["Save" Custom-save t]
22065 ["Reset to Current" Custom-reset-current t]
22066 ["Reset to Saved" Custom-reset-saved t]
22067 ["Reset to Standard Settings" Custom-reset-standard t]))
22068 (message "\"Org\"-menu now contains full customization menu"))
22069 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22071 ;;;; Miscellaneous stuff
22073 ;;; Generally useful functions
22075 (defsubst org-get-at-eol (property n)
22076 "Get text property PROPERTY at the end of line less N characters."
22077 (get-text-property (- (point-at-eol) n) property))
22079 (defun org-find-text-property-in-string (prop s)
22080 "Return the first non-nil value of property PROP in string S."
22081 (or (get-text-property 0 prop s)
22082 (get-text-property (or (next-single-property-change 0 prop s) 0)
22083 prop s)))
22085 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22086 "Display the given MESSAGE as a warning."
22087 (if (fboundp 'display-warning)
22088 (display-warning 'org message
22089 (if (featurep 'xemacs) 'warning :warning))
22090 (let ((buf (get-buffer-create "*Org warnings*")))
22091 (with-current-buffer buf
22092 (goto-char (point-max))
22093 (insert "Warning (Org): " message)
22094 (unless (bolp)
22095 (newline)))
22096 (display-buffer buf)
22097 (sit-for 0))))
22099 (defun org-eval (form)
22100 "Eval FORM and return result."
22101 (condition-case error
22102 (eval form)
22103 (error (format "%%![Error: %s]" error))))
22105 (defun org-in-clocktable-p ()
22106 "Check if the cursor is in a clocktable."
22107 (let ((pos (point)) start)
22108 (save-excursion
22109 (end-of-line 1)
22110 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22111 (setq start (match-beginning 0))
22112 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22113 (>= (match-end 0) pos)
22114 start))))
22116 (defun org-in-verbatim-emphasis ()
22117 (save-match-data
22118 (and (org-in-regexp org-emph-re 2)
22119 (>= (point) (match-beginning 3))
22120 (<= (point) (match-end 4))
22121 (member (match-string 3) '("=" "~")))))
22123 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22124 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22125 (if (and marker (marker-buffer marker)
22126 (buffer-live-p (marker-buffer marker)))
22127 (progn
22128 (org-pop-to-buffer-same-window (marker-buffer marker))
22129 (if (or (> marker (point-max)) (< marker (point-min)))
22130 (widen))
22131 (goto-char marker)
22132 (org-show-context 'org-goto))
22133 (if bookmark
22134 (bookmark-jump bookmark)
22135 (error "Cannot find location"))))
22137 (defun org-quote-csv-field (s)
22138 "Quote field for inclusion in CSV material."
22139 (if (string-match "[\",]" s)
22140 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22143 (defun org-force-self-insert (N)
22144 "Needed to enforce self-insert under remapping."
22145 (interactive "p")
22146 (self-insert-command N))
22148 (defun org-string-width (s)
22149 "Compute width of string, ignoring invisible characters.
22150 This ignores character with invisibility property `org-link', and also
22151 characters with property `org-cwidth', because these will become invisible
22152 upon the next fontification round."
22153 (let (b l)
22154 (when (or (eq t buffer-invisibility-spec)
22155 (assq 'org-link buffer-invisibility-spec))
22156 (while (setq b (text-property-any 0 (length s)
22157 'invisible 'org-link s))
22158 (setq s (concat (substring s 0 b)
22159 (substring s (or (next-single-property-change
22160 b 'invisible s)
22161 (length s)))))))
22162 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22163 (setq s (concat (substring s 0 b)
22164 (substring s (or (next-single-property-change
22165 b 'org-cwidth s)
22166 (length s))))))
22167 (setq l (string-width s) b -1)
22168 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22169 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22172 (defun org-shorten-string (s maxlength)
22173 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22174 If the string is shorter or has length MAXLENGTH, just return the
22175 original string. If it is longer, the functions finds a space in the
22176 string, breaks this string off at that locations and adds three dots
22177 as ellipsis. Including the ellipsis, the string will not be longer
22178 than MAXLENGTH. If finding a good breaking point in the string does
22179 not work, the string is just chopped off in the middle of a word
22180 if necessary."
22181 (if (<= (length s) maxlength)
22183 (let* ((n (max (- maxlength 4) 1))
22184 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22185 (if (string-match re s)
22186 (concat (match-string 1 s) "...")
22187 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22189 (defun org-get-indentation (&optional line)
22190 "Get the indentation of the current line, interpreting tabs.
22191 When LINE is given, assume it represents a line and compute its indentation."
22192 (if line
22193 (if (string-match "^ *" (org-remove-tabs line))
22194 (match-end 0))
22195 (save-excursion
22196 (beginning-of-line 1)
22197 (skip-chars-forward " \t")
22198 (current-column))))
22200 (defun org-get-string-indentation (s)
22201 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22202 (let ((n -1) (i 0) (w tab-width) c)
22203 (catch 'exit
22204 (while (< (setq n (1+ n)) (length s))
22205 (setq c (aref s n))
22206 (cond ((= c ?\ ) (setq i (1+ i)))
22207 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22208 (t (throw 'exit t)))))
22211 (defun org-remove-tabs (s &optional width)
22212 "Replace tabulators in S with spaces.
22213 Assumes that s is a single line, starting in column 0."
22214 (setq width (or width tab-width))
22215 (while (string-match "\t" s)
22216 (setq s (replace-match
22217 (make-string
22218 (- (* width (/ (+ (match-beginning 0) width) width))
22219 (match-beginning 0)) ?\ )
22220 t t s)))
22223 (defun org-fix-indentation (line ind)
22224 "Fix indentation in LINE.
22225 IND is a cons cell with target and minimum indentation.
22226 If the current indentation in LINE is smaller than the minimum,
22227 leave it alone. If it is larger than ind, set it to the target."
22228 (let* ((l (org-remove-tabs line))
22229 (i (org-get-indentation l))
22230 (i1 (car ind)) (i2 (cdr ind)))
22231 (if (>= i i2) (setq l (substring line i2)))
22232 (if (> i1 0)
22233 (concat (make-string i1 ?\ ) l)
22234 l)))
22236 (defun org-remove-indentation (code &optional n)
22237 "Remove the maximum common indentation from the lines in CODE.
22238 N may optionally be the number of spaces to remove."
22239 (with-temp-buffer
22240 (insert code)
22241 (org-do-remove-indentation n)
22242 (buffer-string)))
22244 (defun org-do-remove-indentation (&optional n)
22245 "Remove the maximum common indentation from the buffer."
22246 (untabify (point-min) (point-max))
22247 (let ((min 10000) re)
22248 (if n
22249 (setq min n)
22250 (goto-char (point-min))
22251 (while (re-search-forward "^ *[^ \n]" nil t)
22252 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22253 (unless (or (= min 0) (= min 10000))
22254 (setq re (format "^ \\{%d\\}" min))
22255 (goto-char (point-min))
22256 (while (re-search-forward re nil t)
22257 (replace-match "")
22258 (end-of-line 1))
22259 min)))
22261 (defun org-fill-template (template alist)
22262 "Find each %key of ALIST in TEMPLATE and replace it."
22263 (let ((case-fold-search nil))
22264 (dolist (entry (sort (copy-sequence alist)
22265 (lambda (a b) (< (length (car a)) (length (car b))))))
22266 (setq template
22267 (replace-regexp-in-string
22268 (concat "%" (regexp-quote (car entry)))
22269 (or (cdr entry) "") template t t)))
22270 template))
22272 (defun org-base-buffer (buffer)
22273 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22274 (if (not buffer)
22275 buffer
22276 (or (buffer-base-buffer buffer)
22277 buffer)))
22279 (defun org-wrap (string &optional width lines)
22280 "Wrap string to either a number of lines, or a width in characters.
22281 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22282 that costs. If there is a word longer than WIDTH, the text is actually
22283 wrapped to the length of that word.
22284 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22285 many lines, whatever width that takes.
22286 The return value is a list of lines, without newlines at the end."
22287 (let* ((words (org-split-string string "[ \t\n]+"))
22288 (maxword (apply 'max (mapcar 'org-string-width words)))
22289 w ll)
22290 (cond (width
22291 (org-do-wrap words (max maxword width)))
22292 (lines
22293 (setq w maxword)
22294 (setq ll (org-do-wrap words maxword))
22295 (if (<= (length ll) lines)
22297 (setq ll words)
22298 (while (> (length ll) lines)
22299 (setq w (1+ w))
22300 (setq ll (org-do-wrap words w)))
22301 ll))
22302 (t (error "Cannot wrap this")))))
22304 (defun org-do-wrap (words width)
22305 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22306 (let (lines line)
22307 (while words
22308 (setq line (pop words))
22309 (while (and words (< (+ (length line) (length (car words))) width))
22310 (setq line (concat line " " (pop words))))
22311 (setq lines (push line lines)))
22312 (nreverse lines)))
22314 (defun org-split-string (string &optional separators)
22315 "Splits STRING into substrings at SEPARATORS.
22316 SEPARATORS is a regular expression.
22317 No empty strings are returned if there are matches at the beginning
22318 and end of string."
22319 ;; FIXME: why not use (split-string STRING SEPARATORS t)?
22320 (let ((start 0) notfirst list)
22321 (while (and (string-match (or separators "[ \f\t\n\r\v]+") string
22322 (if (and notfirst
22323 (= start (match-beginning 0))
22324 (< start (length string)))
22325 (1+ start) start))
22326 (< (match-beginning 0) (length string)))
22327 (setq notfirst t)
22328 (or (eq (match-beginning 0) 0)
22329 (and (eq (match-beginning 0) (match-end 0))
22330 (eq (match-beginning 0) start))
22331 (push (substring string start (match-beginning 0)) list))
22332 (setq start (match-end 0)))
22333 (or (eq start (length string))
22334 (push (substring string start) list))
22335 (nreverse list)))
22337 (defun org-quote-vert (s)
22338 "Replace \"|\" with \"\\vert\"."
22339 (while (string-match "|" s)
22340 (setq s (replace-match "\\vert" t t s)))
22343 (defun org-uuidgen-p (s)
22344 "Is S an ID created by UUIDGEN?"
22345 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22347 (defun org-in-src-block-p (&optional inside)
22348 "Whether point is in a code source block.
22349 When INSIDE is non-nil, don't consider we are within a src block
22350 when point is at #+BEGIN_SRC or #+END_SRC."
22351 (let ((case-fold-search t) ov)
22352 (or (and (eq (get-char-property (point) 'src-block) t))
22353 (and (not inside)
22354 (save-match-data
22355 (save-excursion
22356 (beginning-of-line)
22357 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22359 (defun org-context ()
22360 "Return a list of contexts of the current cursor position.
22361 If several contexts apply, all are returned.
22362 Each context entry is a list with a symbol naming the context, and
22363 two positions indicating start and end of the context. Possible
22364 contexts are:
22366 :headline anywhere in a headline
22367 :headline-stars on the leading stars in a headline
22368 :todo-keyword on a TODO keyword (including DONE) in a headline
22369 :tags on the TAGS in a headline
22370 :priority on the priority cookie in a headline
22371 :item on the first line of a plain list item
22372 :item-bullet on the bullet/number of a plain list item
22373 :checkbox on the checkbox in a plain list item
22374 :table in an org-mode table
22375 :table-special on a special filed in a table
22376 :table-table in a table.el table
22377 :clocktable in a clocktable
22378 :src-block in a source block
22379 :link on a hyperlink
22380 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22381 :target on a <<target>>
22382 :radio-target on a <<<radio-target>>>
22383 :latex-fragment on a LaTeX fragment
22384 :latex-preview on a LaTeX fragment with overlaid preview image
22386 This function expects the position to be visible because it uses font-lock
22387 faces as a help to recognize the following contexts: :table-special, :link,
22388 and :keyword."
22389 (let* ((f (get-text-property (point) 'face))
22390 (faces (if (listp f) f (list f)))
22391 (case-fold-search t)
22392 (p (point)) clist o)
22393 ;; First the large context
22394 (cond
22395 ((org-at-heading-p t)
22396 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22397 (when (progn
22398 (beginning-of-line 1)
22399 (looking-at org-todo-line-tags-regexp))
22400 (push (org-point-in-group p 1 :headline-stars) clist)
22401 (push (org-point-in-group p 2 :todo-keyword) clist)
22402 (push (org-point-in-group p 4 :tags) clist))
22403 (goto-char p)
22404 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22405 (if (looking-at "\\[#[A-Z0-9]\\]")
22406 (push (org-point-in-group p 0 :priority) clist)))
22408 ((org-at-item-p)
22409 (push (org-point-in-group p 2 :item-bullet) clist)
22410 (push (list :item (point-at-bol)
22411 (save-excursion (org-end-of-item) (point)))
22412 clist)
22413 (and (org-at-item-checkbox-p)
22414 (push (org-point-in-group p 0 :checkbox) clist)))
22416 ((org-at-table-p)
22417 (push (list :table (org-table-begin) (org-table-end)) clist)
22418 (if (memq 'org-formula faces)
22419 (push (list :table-special
22420 (previous-single-property-change p 'face)
22421 (next-single-property-change p 'face)) clist)))
22422 ((org-at-table-p 'any)
22423 (push (list :table-table) clist)))
22424 (goto-char p)
22426 (let ((case-fold-search t))
22427 ;; New the "medium" contexts: clocktables, source blocks
22428 (cond ((org-in-clocktable-p)
22429 (push (list :clocktable
22430 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22431 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22432 (match-beginning 1))
22433 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22434 (match-end 0))) clist))
22435 ((org-in-src-block-p)
22436 (push (list :src-block
22437 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22438 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22439 (match-beginning 1))
22440 (and (search-forward "#+END_SRC" nil t)
22441 (match-beginning 0))) clist))))
22442 (goto-char p)
22444 ;; Now the small context
22445 (cond
22446 ((org-at-timestamp-p)
22447 (push (org-point-in-group p 0 :timestamp) clist))
22448 ((memq 'org-link faces)
22449 (push (list :link
22450 (previous-single-property-change p 'face)
22451 (next-single-property-change p 'face)) clist))
22452 ((memq 'org-special-keyword faces)
22453 (push (list :keyword
22454 (previous-single-property-change p 'face)
22455 (next-single-property-change p 'face)) clist))
22456 ((org-at-target-p)
22457 (push (org-point-in-group p 0 :target) clist)
22458 (goto-char (1- (match-beginning 0)))
22459 (if (looking-at org-radio-target-regexp)
22460 (push (org-point-in-group p 0 :radio-target) clist))
22461 (goto-char p))
22462 ((setq o (car (delq nil
22463 (mapcar
22464 (lambda (x)
22465 (if (memq x org-latex-fragment-image-overlays) x))
22466 (overlays-at (point))))))
22467 (push (list :latex-fragment
22468 (overlay-start o) (overlay-end o)) clist)
22469 (push (list :latex-preview
22470 (overlay-start o) (overlay-end o)) clist))
22471 ((org-inside-LaTeX-fragment-p)
22472 ;; FIXME: positions wrong.
22473 (push (list :latex-fragment (point) (point)) clist)))
22475 (setq clist (nreverse (delq nil clist)))
22476 clist))
22478 (defun org-in-regexp (re &optional nlines visually)
22479 "Check if point is inside a match of RE.
22481 Normally only the current line is checked, but you can include
22482 NLINES extra lines after point into the search. If VISUALLY is
22483 set, require that the cursor is not after the match but really
22484 on, so that the block visually is on the match."
22485 (catch 'exit
22486 (let ((pos (point))
22487 (eol (point-at-eol (+ 1 (or nlines 0))))
22488 (inc (if visually 1 0)))
22489 (save-excursion
22490 (beginning-of-line (- 1 (or nlines 0)))
22491 (while (re-search-forward re eol t)
22492 (if (and (<= (match-beginning 0) pos)
22493 (>= (+ inc (match-end 0)) pos))
22494 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22495 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22496 "Org mode 8.3")
22498 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22499 "Non-nil when point is between matches of START-RE and END-RE.
22501 Also return a non-nil value when point is on one of the matches.
22503 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22504 buffer positions. Default values are the positions of headlines
22505 surrounding the point.
22507 The functions returns a cons cell whose car (resp. cdr) is the
22508 position before START-RE (resp. after END-RE)."
22509 (save-match-data
22510 (let ((pos (point))
22511 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22512 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22513 beg end)
22514 (save-excursion
22515 ;; Point is on a block when on START-RE or if START-RE can be
22516 ;; found before it...
22517 (and (or (org-in-regexp start-re)
22518 (re-search-backward start-re limit-up t))
22519 (setq beg (match-beginning 0))
22520 ;; ... and END-RE after it...
22521 (goto-char (match-end 0))
22522 (re-search-forward end-re limit-down t)
22523 (> (setq end (match-end 0)) pos)
22524 ;; ... without another START-RE in-between.
22525 (goto-char (match-beginning 0))
22526 (not (re-search-backward start-re (1+ beg) t))
22527 ;; Return value.
22528 (cons beg end))))))
22530 (defun org-in-block-p (names)
22531 "Non-nil when point belongs to a block whose name belongs to NAMES.
22533 NAMES is a list of strings containing names of blocks.
22535 Return first block name matched, or nil. Beware that in case of
22536 nested blocks, the returned name may not belong to the closest
22537 block from point."
22538 (save-match-data
22539 (catch 'exit
22540 (let ((case-fold-search t)
22541 (lim-up (save-excursion (outline-previous-heading)))
22542 (lim-down (save-excursion (outline-next-heading))))
22543 (mapc (lambda (name)
22544 (let ((n (regexp-quote name)))
22545 (when (org-between-regexps-p
22546 (concat "^[ \t]*#\\+begin_" n)
22547 (concat "^[ \t]*#\\+end_" n)
22548 lim-up lim-down)
22549 (throw 'exit n))))
22550 names))
22551 nil)))
22553 (defun org-occur-in-agenda-files (regexp &optional _nlines)
22554 "Call `multi-occur' with buffers for all agenda files."
22555 (interactive "sOrg-files matching: ")
22556 (let* ((files (org-agenda-files))
22557 (tnames (mapcar #'file-truename files))
22558 (extra org-agenda-text-search-extra-files))
22559 (when (eq (car extra) 'agenda-archives)
22560 (setq extra (cdr extra))
22561 (setq files (org-add-archive-files files)))
22562 (dolist (f extra)
22563 (unless (member (file-truename f) tnames)
22564 (unless (member f files) (setq files (append files (list f))))
22565 (setq tnames (append tnames (list (file-truename f))))))
22566 (multi-occur
22567 (mapcar (lambda (x)
22568 (with-current-buffer
22569 ;; FIXME: Why not just (find-file-noselect x)?
22570 ;; Is it to avoid the "revert buffer" prompt?
22571 (or (get-file-buffer x) (find-file-noselect x))
22572 (widen)
22573 (current-buffer)))
22574 files)
22575 regexp)))
22577 (if (boundp 'occur-mode-find-occurrence-hook)
22578 ;; Emacs 23
22579 (add-hook 'occur-mode-find-occurrence-hook
22580 (lambda ()
22581 (when (derived-mode-p 'org-mode)
22582 (org-reveal))))
22583 ;; Emacs 22
22584 (defadvice occur-mode-goto-occurrence
22585 (after org-occur-reveal activate)
22586 (and (derived-mode-p 'org-mode) (org-reveal)))
22587 (defadvice occur-mode-goto-occurrence-other-window
22588 (after org-occur-reveal activate)
22589 (and (derived-mode-p 'org-mode) (org-reveal)))
22590 (defadvice occur-mode-display-occurrence
22591 (after org-occur-reveal activate)
22592 (when (derived-mode-p 'org-mode)
22593 (let ((pos (occur-mode-find-occurrence)))
22594 (with-current-buffer (marker-buffer pos)
22595 (save-excursion
22596 (goto-char pos)
22597 (org-reveal)))))))
22599 (defun org-occur-link-in-agenda-files ()
22600 "Create a link and search for it in the agendas.
22601 The link is not stored in `org-stored-links', it is just created
22602 for the search purpose."
22603 (interactive)
22604 (let ((link (condition-case nil
22605 (org-store-link nil)
22606 (error "Unable to create a link to here"))))
22607 (org-occur-in-agenda-files (regexp-quote link))))
22609 (defun org-reverse-string (string)
22610 "Return the reverse of STRING."
22611 (apply 'string (reverse (string-to-list string))))
22613 ;; defsubst org-uniquify must be defined before first use
22615 (defun org-uniquify-alist (alist)
22616 "Merge elements of ALIST with the same key.
22618 For example, in this alist:
22620 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22621 => '((a 1 3) (b 2))
22623 merge (a 1) and (a 3) into (a 1 3).
22625 The function returns the new ALIST."
22626 (let (rtn)
22627 (mapc
22628 (lambda (e)
22629 (let (n)
22630 (if (not (assoc (car e) rtn))
22631 (push e rtn)
22632 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22633 (setq rtn (assq-delete-all (car e) rtn))
22634 (push n rtn))))
22635 alist)
22636 rtn))
22638 (defun org-delete-all (elts list)
22639 "Remove all elements in ELTS from LIST."
22640 (while elts
22641 (setq list (delete (pop elts) list)))
22642 list)
22644 (defun org-count (cl-item cl-seq)
22645 "Count the number of occurrences of ITEM in SEQ.
22646 Taken from `count' in cl-seq.el with all keyword arguments removed."
22647 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22648 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22649 (while (< cl-start cl-end)
22650 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22651 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22652 (setq cl-start (1+ cl-start)))
22653 cl-count))
22655 (defun org-remove-if (predicate seq)
22656 "Remove everything from SEQ that fulfills PREDICATE."
22657 (let (res e)
22658 (while seq
22659 (setq e (pop seq))
22660 (if (not (funcall predicate e)) (push e res)))
22661 (nreverse res)))
22663 (defun org-remove-if-not (predicate seq)
22664 "Remove everything from SEQ that does not fulfill PREDICATE."
22665 (let (res e)
22666 (while seq
22667 (setq e (pop seq))
22668 (if (funcall predicate e) (push e res)))
22669 (nreverse res)))
22671 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22672 "Reduce two-argument FUNCTION across SEQ.
22673 Taken from `reduce' in cl-seq.el with all keyword arguments but
22674 \":initial-value\" removed."
22675 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22676 (cadr (memq :initial-value cl-keys)))
22677 (cl-seq (pop cl-seq))
22678 (t (funcall cl-func)))))
22679 (while cl-seq
22680 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22681 cl-accum))
22683 (defun org-every (pred seq)
22684 "Return true if PREDICATE is true of every element of SEQ.
22685 Adapted from `every' in cl.el."
22686 (catch 'org-every
22687 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22690 (defun org-some (pred seq)
22691 "Return true if PREDICATE is true of any element of SEQ.
22692 Adapted from `some' in cl.el."
22693 (catch 'org-some
22694 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22695 nil))
22697 (defun org-back-over-empty-lines ()
22698 "Move backwards over whitespace, to the beginning of the first empty line.
22699 Returns the number of empty lines passed."
22700 (let ((pos (point)))
22701 (if (cdr (assoc 'heading org-blank-before-new-entry))
22702 (skip-chars-backward " \t\n\r")
22703 (unless (eobp)
22704 (forward-line -1)))
22705 (beginning-of-line 2)
22706 (goto-char (min (point) pos))
22707 (count-lines (point) pos)))
22709 (defun org-skip-whitespace ()
22710 (skip-chars-forward " \t\n\r"))
22712 (defun org-point-in-group (point group &optional context)
22713 "Check if POINT is in match-group GROUP.
22714 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22715 match. If the match group does not exist or point is not inside it,
22716 return nil."
22717 (and (match-beginning group)
22718 (>= point (match-beginning group))
22719 (<= point (match-end group))
22720 (if context
22721 (list context (match-beginning group) (match-end group))
22722 t)))
22724 (defun org-switch-to-buffer-other-window (&rest args)
22725 "Switch to buffer in a second window on the current frame.
22726 In particular, do not allow pop-up frames.
22727 Returns the newly created buffer."
22728 (org-no-popups
22729 (apply 'switch-to-buffer-other-window args)))
22731 (defun org-combine-plists (&rest plists)
22732 "Create a single property list from all plists in PLISTS.
22733 The process starts by copying the first list, and then setting properties
22734 from the other lists. Settings in the last list are the most significant
22735 ones and overrule settings in the other lists."
22736 (let ((rtn (copy-sequence (pop plists)))
22737 p v ls)
22738 (while plists
22739 (setq ls (pop plists))
22740 (while ls
22741 (setq p (pop ls) v (pop ls))
22742 (setq rtn (plist-put rtn p v))))
22743 rtn))
22745 (defun org-replace-escapes (string table)
22746 "Replace %-escapes in STRING with values in TABLE.
22747 TABLE is an association list with keys like \"%a\" and string values.
22748 The sequences in STRING may contain normal field width and padding information,
22749 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22750 so values can contain further %-escapes if they are define later in TABLE."
22751 (let ((tbl (copy-alist table))
22752 (case-fold-search nil)
22753 (pchg 0)
22754 e re rpl)
22755 (dolist (e tbl)
22756 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22757 (when (and (cdr e) (string-match re (cdr e)))
22758 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22759 (safe "SREF"))
22760 (add-text-properties 0 3 (list 'sref sref) safe)
22761 (setcdr e (replace-match safe t t (cdr e)))))
22762 (while (string-match re string)
22763 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22764 (cdr e)))
22765 (setq string (replace-match rpl t t string))))
22766 (while (setq pchg (next-property-change pchg string))
22767 (let ((sref (get-text-property pchg 'sref string)))
22768 (when (and sref (string-match "SREF" string pchg))
22769 (setq string (replace-match sref t t string)))))
22770 string))
22772 (defun org-sublist (list start end)
22773 "Return a section of LIST, from START to END.
22774 Counting starts at 1."
22775 (let (rtn (c start))
22776 (setq list (nthcdr (1- start) list))
22777 (while (and list (<= c end))
22778 (push (pop list) rtn)
22779 (setq c (1+ c)))
22780 (nreverse rtn)))
22782 (defun org-find-base-buffer-visiting (file)
22783 "Like `find-buffer-visiting' but always return the base buffer and
22784 not an indirect buffer."
22785 (let ((buf (or (get-file-buffer file)
22786 (find-buffer-visiting file))))
22787 (if buf
22788 (or (buffer-base-buffer buf) buf)
22789 nil)))
22791 (defun org-image-file-name-regexp (&optional extensions)
22792 "Return regexp matching the file names of images.
22793 If EXTENSIONS is given, only match these."
22794 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22795 (image-file-name-regexp)
22796 (let ((image-file-name-extensions
22797 (or extensions
22798 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22799 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22800 (concat "\\."
22801 (regexp-opt (nconc (mapcar 'upcase
22802 image-file-name-extensions)
22803 image-file-name-extensions)
22805 "\\'"))))
22807 (defun org-file-image-p (file &optional extensions)
22808 "Return non-nil if FILE is an image."
22809 (save-match-data
22810 (string-match (org-image-file-name-regexp extensions) file)))
22812 (defun org-get-cursor-date (&optional with-time)
22813 "Return the date at cursor in as a time.
22814 This works in the calendar and in the agenda, anywhere else it just
22815 returns the current time.
22816 If WITH-TIME is non-nil, returns the time of the event at point (in
22817 the agenda) or the current time of the day."
22818 (let (date day defd tp hod mod)
22819 (when with-time
22820 (setq tp (get-text-property (point) 'time))
22821 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22822 (setq hod (string-to-number (match-string 1 tp))
22823 mod (string-to-number (match-string 2 tp))))
22824 (or tp (let ((now (decode-time)))
22825 (setq hod (nth 2 now)
22826 mod (nth 1 now)))))
22827 (cond
22828 ((eq major-mode 'calendar-mode)
22829 (setq date (calendar-cursor-to-date)
22830 defd (encode-time 0 (or mod 0) (or hod 0)
22831 (nth 1 date) (nth 0 date) (nth 2 date))))
22832 ((eq major-mode 'org-agenda-mode)
22833 (setq day (get-text-property (point) 'day))
22834 (if day
22835 (setq date (calendar-gregorian-from-absolute day)
22836 defd (encode-time 0 (or mod 0) (or hod 0)
22837 (nth 1 date) (nth 0 date) (nth 2 date))))))
22838 (or defd (current-time))))
22840 (defun org-mark-subtree (&optional up)
22841 "Mark the current subtree.
22842 This puts point at the start of the current subtree, and mark at
22843 the end. If a numeric prefix UP is given, move up into the
22844 hierarchy of headlines by UP levels before marking the subtree."
22845 (interactive "P")
22846 (org-with-limited-levels
22847 (cond ((org-at-heading-p) (beginning-of-line))
22848 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22849 (t (outline-previous-visible-heading 1))))
22850 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22851 (if (org-called-interactively-p 'any)
22852 (call-interactively 'org-mark-element)
22853 (org-mark-element)))
22856 ;;; Indentation
22858 (defun org--get-expected-indentation (element contentsp)
22859 "Expected indentation column for current line, according to ELEMENT.
22860 ELEMENT is an element containing point. CONTENTSP is non-nil
22861 when indentation is to be computed according to contents of
22862 ELEMENT."
22863 (let ((type (org-element-type element))
22864 (start (org-element-property :begin element))
22865 (post-affiliated (org-element-property :post-affiliated element)))
22866 (org-with-wide-buffer
22867 (cond
22868 (contentsp
22869 (case type
22870 ((diary-sexp footnote-definition) 0)
22871 ((headline inlinetask nil)
22872 (if (not org-adapt-indentation) 0
22873 (let ((level (org-current-level)))
22874 (if level (1+ level) 0))))
22875 ((item plain-list) (org-list-item-body-column post-affiliated))
22877 (goto-char start)
22878 (org-get-indentation))))
22879 ((memq type '(headline inlinetask nil))
22880 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22881 (org--get-expected-indentation element t)
22883 ((memq type '(diary-sexp footnote-definition)) 0)
22884 ;; First paragraph of a footnote definition or an item.
22885 ;; Indent like parent.
22886 ((< (line-beginning-position) start)
22887 (org--get-expected-indentation
22888 (org-element-property :parent element) t))
22889 ;; At first line: indent according to previous sibling, if any,
22890 ;; ignoring footnote definitions and inline tasks, or parent's
22891 ;; contents.
22892 ((= (line-beginning-position) start)
22893 (catch 'exit
22894 (while t
22895 (if (= (point-min) start) (throw 'exit 0)
22896 (goto-char (1- start))
22897 (let* ((previous (org-element-at-point))
22898 (parent previous))
22899 (while (and parent (<= (org-element-property :end parent) start))
22900 (setq previous parent
22901 parent (org-element-property :parent parent)))
22902 (cond
22903 ((not previous) (throw 'exit 0))
22904 ((> (org-element-property :end previous) start)
22905 (throw 'exit (org--get-expected-indentation previous t)))
22906 ((memq (org-element-type previous)
22907 '(footnote-definition inlinetask))
22908 (setq start (org-element-property :begin previous)))
22909 (t (goto-char (org-element-property :begin previous))
22910 (throw 'exit
22911 (if (bolp) (org-get-indentation)
22912 ;; At first paragraph in an item or
22913 ;; a footnote definition.
22914 (org--get-expected-indentation
22915 (org-element-property :parent previous) t))))))))))
22916 ;; Otherwise, move to the first non-blank line above.
22918 (beginning-of-line)
22919 (let ((pos (point)))
22920 (skip-chars-backward " \r\t\n")
22921 (cond
22922 ;; Two blank lines end a footnote definition or a plain
22923 ;; list. When we indent an empty line after them, the
22924 ;; containing list or footnote definition is over, so it
22925 ;; qualifies as a previous sibling. Therefore, we indent
22926 ;; like its first line.
22927 ((and (memq type '(footnote-definition plain-list))
22928 (> (count-lines (point) pos) 2))
22929 (goto-char start)
22930 (org-get-indentation))
22931 ;; Line above is the first one of a paragraph at the
22932 ;; beginning of an item or a footnote definition. Indent
22933 ;; like parent.
22934 ((< (line-beginning-position) start)
22935 (org--get-expected-indentation
22936 (org-element-property :parent element) t))
22937 ;; Line above is the beginning of an element, i.e., point
22938 ;; was originally on the blank lines between element's start
22939 ;; and contents.
22940 ((= (line-beginning-position) post-affiliated)
22941 (org--get-expected-indentation element t))
22942 ;; POS is after contents in a greater element. Indent like
22943 ;; the beginning of the element.
22945 ;; As a special case, if point is at the end of a footnote
22946 ;; definition or an item, indent like the very last element
22947 ;; within.
22948 ((and (not (eq type 'paragraph))
22949 (let ((cend (org-element-property :contents-end element)))
22950 (and cend (<= cend pos))))
22951 (if (memq type '(footnote-definition item plain-list))
22952 (let ((last (org-element-at-point)))
22953 (org--get-expected-indentation
22954 last
22955 (memq (org-element-type last)
22956 '(footnote-definition item plain-list))))
22957 (goto-char start)
22958 (org-get-indentation)))
22959 ;; In any other case, indent like the current line.
22960 (t (org-get-indentation)))))))))
22962 (defun org--align-node-property ()
22963 "Align node property at point.
22964 Alignment is done according to `org-property-format', which see."
22965 (when (save-excursion
22966 (beginning-of-line)
22967 (looking-at org-property-re))
22968 (replace-match
22969 (concat (match-string 4)
22970 (org-trim
22971 (format org-property-format (match-string 1) (match-string 3))))
22972 t t)))
22974 (defun org-indent-line ()
22975 "Indent line depending on context.
22977 Indentation is done according to the following rules:
22979 - Footnote definitions, diary sexps, headlines and inline tasks
22980 have to start at column 0.
22982 - On the very first line of an element, consider, in order, the
22983 next rules until one matches:
22985 1. If there's a sibling element before, ignoring footnote
22986 definitions and inline tasks, indent like its first line.
22988 2. If element has a parent, indent like its contents. More
22989 precisely, if parent is an item, indent after the
22990 description part, if any, or the bullet (see
22991 `org-list-description-max-indent'). Else, indent like
22992 parent's first line.
22994 3. Otherwise, indent relatively to current level, if
22995 `org-adapt-indentation' is non-nil, or to left margin.
22997 - On a blank line at the end of an element, indent according to
22998 the type of the element. More precisely
23000 1. If element is a plain list, an item, or a footnote
23001 definition, indent like the very last element within.
23003 2. If element is a paragraph, indent like its last non blank
23004 line.
23006 3. Otherwise, indent like its very first line.
23008 - In the code part of a source block, use language major mode
23009 to indent current line if `org-src-tab-acts-natively' is
23010 non-nil. If it is nil, do nothing.
23012 - Otherwise, indent like the first non-blank line above.
23014 The function doesn't indent an item as it could break the whole
23015 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
23016 \\[org-shiftmetaright].
23018 Also align node properties according to `org-property-format'."
23019 (interactive)
23020 (cond
23021 (orgstruct-is-++
23022 (let ((indent-line-function
23023 (cadadr (assq 'indent-line-function org-fb-vars))))
23024 (indent-according-to-mode)))
23025 ((org-at-heading-p) 'noindent)
23027 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
23028 (type (org-element-type element)))
23029 (cond ((and (memq type '(plain-list item))
23030 (= (line-beginning-position)
23031 (org-element-property :post-affiliated element)))
23032 'noindent)
23033 ((and (eq type 'src-block)
23034 org-src-tab-acts-natively
23035 (> (line-beginning-position)
23036 (org-element-property :post-affiliated element))
23037 (< (line-beginning-position)
23038 (org-with-wide-buffer
23039 (goto-char (org-element-property :end element))
23040 (skip-chars-backward " \r\t\n")
23041 (line-beginning-position))))
23042 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
23044 (let ((column (org--get-expected-indentation element nil)))
23045 ;; Preserve current column.
23046 (if (<= (current-column) (current-indentation))
23047 (org-indent-line-to column)
23048 (save-excursion (org-indent-line-to column))))
23049 ;; Align node property. Also preserve current column.
23050 (when (eq type 'node-property)
23051 (let ((column (current-column)))
23052 (org--align-node-property)
23053 (org-move-to-column column)))))))))
23055 (defun org-indent-region (start end)
23056 "Indent each non-blank line in the region.
23057 Called from a program, START and END specify the region to
23058 indent. The function will not indent contents of example blocks,
23059 verse blocks and export blocks as leading white spaces are
23060 assumed to be significant there."
23061 (interactive "r")
23062 (save-excursion
23063 (goto-char start)
23064 (skip-chars-forward " \r\t\n")
23065 (unless (eobp) (beginning-of-line))
23066 (let ((indent-to
23067 (lambda (ind pos)
23068 ;; Set IND as indentation for all lines between point and
23069 ;; POS or END, whichever comes first. Blank lines are
23070 ;; ignored. Leave point after POS once done.
23071 (let ((limit (copy-marker (min end pos))))
23072 (while (< (point) limit)
23073 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23074 (forward-line))
23075 (set-marker limit nil))))
23076 (end (copy-marker end)))
23077 (while (< (point) end)
23078 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23079 (let* ((element (org-element-at-point))
23080 (type (org-element-type element))
23081 (element-end (copy-marker (org-element-property :end element)))
23082 (ind (org--get-expected-indentation element nil)))
23083 (cond
23084 ((or (memq type '(paragraph table table-row))
23085 (not (or (org-element-property :contents-begin element)
23086 (memq type
23087 '(example-block export-block src-block)))))
23088 ;; Elements here are indented as a single block. Also
23089 ;; align node properties.
23090 (when (eq type 'node-property)
23091 (org--align-node-property)
23092 (beginning-of-line))
23093 (funcall indent-to ind element-end))
23095 ;; Elements in this category consist of three parts:
23096 ;; before the contents, the contents, and after the
23097 ;; contents. The contents are treated specially,
23098 ;; according to the element type, or not indented at
23099 ;; all. Other parts are indented as a single block.
23100 (let* ((post (copy-marker
23101 (org-element-property :post-affiliated element)))
23102 (cbeg
23103 (copy-marker
23104 (cond
23105 ((not (org-element-property :contents-begin element))
23106 ;; Fake contents for source blocks.
23107 (org-with-wide-buffer
23108 (goto-char post)
23109 (forward-line)
23110 (point)))
23111 ((memq type '(footnote-definition item plain-list))
23112 ;; Contents in these elements could start on
23113 ;; the same line as the beginning of the
23114 ;; element. Make sure we start indenting
23115 ;; from the second line.
23116 (org-with-wide-buffer
23117 (goto-char post)
23118 (end-of-line)
23119 (skip-chars-forward " \r\t\n")
23120 (if (eobp) (point) (line-beginning-position))))
23121 (t (org-element-property :contents-begin element)))))
23122 (cend (copy-marker
23123 (or (org-element-property :contents-end element)
23124 ;; Fake contents for source blocks.
23125 (org-with-wide-buffer
23126 (goto-char element-end)
23127 (skip-chars-backward " \r\t\n")
23128 (line-beginning-position)))
23129 t)))
23130 ;; Do not change items indentation individually as it
23131 ;; might break the list as a whole. On the other
23132 ;; hand, when at a plain list, indent it as a whole.
23133 (cond ((eq type 'plain-list)
23134 (let ((offset (- ind (org-get-indentation))))
23135 (unless (zerop offset)
23136 (indent-rigidly (org-element-property :begin element)
23137 (org-element-property :end element)
23138 offset))
23139 (goto-char cbeg)))
23140 ((eq type 'item) (goto-char cbeg))
23141 (t (funcall indent-to ind cbeg)))
23142 (when (< (point) end)
23143 (case type
23144 ((example-block export-block verse-block))
23145 (src-block
23146 ;; In a source block, indent source code
23147 ;; according to language major mode, but only if
23148 ;; `org-src-tab-acts-natively' is non-nil.
23149 (when (and (< (point) end) org-src-tab-acts-natively)
23150 (ignore-errors
23151 (org-babel-do-in-edit-buffer
23152 (indent-region (point-min) (point-max))))))
23153 (t (org-indent-region (point) (min cend end))))
23154 (goto-char (min cend end))
23155 (when (< (point) end) (funcall indent-to ind element-end)))
23156 (set-marker post nil)
23157 (set-marker cbeg nil)
23158 (set-marker cend nil))))
23159 (set-marker element-end nil))))
23160 (set-marker end nil))))
23162 (defun org-indent-drawer ()
23163 "Indent the drawer at point."
23164 (interactive)
23165 (unless (save-excursion
23166 (beginning-of-line)
23167 (org-looking-at-p org-drawer-regexp))
23168 (user-error "Not at a drawer"))
23169 (let ((element (org-element-at-point)))
23170 (unless (memq (org-element-type element) '(drawer property-drawer))
23171 (user-error "Not at a drawer"))
23172 (org-with-wide-buffer
23173 (org-indent-region (org-element-property :begin element)
23174 (org-element-property :end element))))
23175 (message "Drawer at point indented"))
23177 (defun org-indent-block ()
23178 "Indent the block at point."
23179 (interactive)
23180 (unless (save-excursion
23181 (beginning-of-line)
23182 (let ((case-fold-search t))
23183 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23184 (user-error "Not at a block"))
23185 (let ((element (org-element-at-point)))
23186 (unless (memq (org-element-type element)
23187 '(comment-block center-block dynamic-block example-block
23188 export-block quote-block special-block
23189 src-block verse-block))
23190 (user-error "Not at a block"))
23191 (org-with-wide-buffer
23192 (org-indent-region (org-element-property :begin element)
23193 (org-element-property :end element))))
23194 (message "Block at point indented"))
23197 ;;; Filling
23199 ;; We use our own fill-paragraph and auto-fill functions.
23201 ;; `org-fill-paragraph' relies on adaptive filling and context
23202 ;; checking. Appropriate `fill-prefix' is computed with
23203 ;; `org-adaptive-fill-function'.
23205 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23206 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23207 ;; `org-adaptive-fill-function' value. Internally,
23208 ;; `org-comment-line-break-function' breaks the line.
23210 ;; `org-setup-filling' installs filling and auto-filling related
23211 ;; variables during `org-mode' initialization.
23213 (defvar org-element-paragraph-separate) ; org-element.el
23214 (defun org-setup-filling ()
23215 (require 'org-element)
23216 ;; Prevent auto-fill from inserting unwanted new items.
23217 (when (boundp 'fill-nobreak-predicate)
23218 (org-set-local
23219 'fill-nobreak-predicate
23220 (org-uniquify
23221 (append fill-nobreak-predicate
23222 '(org-fill-line-break-nobreak-p
23223 org-fill-paragraph-with-timestamp-nobreak-p)))))
23224 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23225 (org-set-local 'paragraph-start paragraph-ending)
23226 (org-set-local 'paragraph-separate paragraph-ending))
23227 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23228 (org-set-local 'auto-fill-inhibit-regexp nil)
23229 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23230 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23231 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23233 (defun org-fill-line-break-nobreak-p ()
23234 "Non-nil when a new line at point would create an Org line break."
23235 (save-excursion
23236 (skip-chars-backward "[ \t]")
23237 (skip-chars-backward "\\\\")
23238 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23240 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23241 "Non-nil when a new line at point would split a timestamp."
23242 (and (org-at-timestamp-p t)
23243 (not (looking-at org-ts-regexp-both))))
23245 (declare-function message-in-body-p "message" ())
23246 (defvar orgtbl-line-start-regexp) ; From org-table.el
23247 (defun org-adaptive-fill-function ()
23248 "Compute a fill prefix for the current line.
23249 Return fill prefix, as a string, or nil if current line isn't
23250 meant to be filled. For convenience, if `adaptive-fill-regexp'
23251 matches in paragraphs or comments, use it."
23252 (catch 'exit
23253 (when (derived-mode-p 'message-mode)
23254 (save-excursion
23255 (beginning-of-line)
23256 (cond ((not (message-in-body-p)) (throw 'exit nil))
23257 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23258 ((looking-at message-cite-prefix-regexp)
23259 (throw 'exit (match-string-no-properties 0)))
23260 ((looking-at org-outline-regexp)
23261 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23262 (org-with-wide-buffer
23263 (unless (org-at-heading-p)
23264 (let* ((p (line-beginning-position))
23265 (element (save-excursion
23266 (beginning-of-line)
23267 (org-element-at-point)))
23268 (type (org-element-type element))
23269 (post-affiliated (org-element-property :post-affiliated element)))
23270 (unless (< p post-affiliated)
23271 (case type
23272 (comment
23273 (save-excursion
23274 (beginning-of-line)
23275 (looking-at "[ \t]*")
23276 (concat (match-string 0) "# ")))
23277 (footnote-definition "")
23278 ((item plain-list)
23279 (make-string (org-list-item-body-column post-affiliated) ?\s))
23280 (paragraph
23281 ;; Fill prefix is usually the same as the current line,
23282 ;; unless the paragraph is at the beginning of an item.
23283 (let ((parent (org-element-property :parent element)))
23284 (save-excursion
23285 (beginning-of-line)
23286 (cond ((eq (org-element-type parent) 'item)
23287 (make-string (org-list-item-body-column
23288 (org-element-property :begin parent))
23289 ?\s))
23290 ((and adaptive-fill-regexp
23291 ;; Locally disable
23292 ;; `adaptive-fill-function' to let
23293 ;; `fill-context-prefix' handle
23294 ;; `adaptive-fill-regexp' variable.
23295 (let (adaptive-fill-function)
23296 (fill-context-prefix
23297 post-affiliated
23298 (org-element-property :end element)))))
23299 ((looking-at "[ \t]+") (match-string 0))
23300 (t "")))))
23301 (comment-block
23302 ;; Only fill contents if P is within block boundaries.
23303 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23304 (forward-line)
23305 (point)))
23306 (cend (save-excursion
23307 (goto-char (org-element-property :end element))
23308 (skip-chars-backward " \r\t\n")
23309 (line-beginning-position))))
23310 (when (and (>= p cbeg) (< p cend))
23311 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23312 (match-string 0)
23313 "")))))))))))
23315 (declare-function message-goto-body "message" ())
23316 (defvar message-cite-prefix-regexp) ; From message.el
23317 (defun org-fill-paragraph (&optional justify)
23318 "Fill element at point, when applicable.
23320 This function only applies to comment blocks, comments, example
23321 blocks and paragraphs. Also, as a special case, re-align table
23322 when point is at one.
23324 If JUSTIFY is non-nil (interactively, with prefix argument),
23325 justify as well. If `sentence-end-double-space' is non-nil, then
23326 period followed by one space does not end a sentence, so don't
23327 break a line there. The variable `fill-column' controls the
23328 width for filling.
23330 For convenience, when point is at a plain list, an item or
23331 a footnote definition, try to fill the first paragraph within."
23332 (interactive)
23333 (if (and (derived-mode-p 'message-mode)
23334 (or (not (message-in-body-p))
23335 (save-excursion (move-beginning-of-line 1)
23336 (looking-at message-cite-prefix-regexp))))
23337 ;; First ensure filling is correct in message-mode.
23338 (let ((fill-paragraph-function
23339 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23340 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23341 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23342 (paragraph-separate
23343 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23344 (fill-paragraph nil))
23345 (with-syntax-table org-mode-transpose-word-syntax-table
23346 ;; Move to end of line in order to get the first paragraph
23347 ;; within a plain list or a footnote definition.
23348 (let ((element (save-excursion
23349 (end-of-line)
23350 (or (ignore-errors (org-element-at-point))
23351 (user-error "An element cannot be parsed line %d"
23352 (line-number-at-pos (point)))))))
23353 ;; First check if point is in a blank line at the beginning of
23354 ;; the buffer. In that case, ignore filling.
23355 (case (org-element-type element)
23356 ;; Use major mode filling function is src blocks.
23357 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23358 ;; Align Org tables, leave table.el tables as-is.
23359 (table-row (org-table-align) t)
23360 (table
23361 (when (eq (org-element-property :type element) 'org)
23362 (save-excursion
23363 (goto-char (org-element-property :post-affiliated element))
23364 (org-table-align)))
23366 (paragraph
23367 ;; Paragraphs may contain `line-break' type objects.
23368 (let ((beg (max (point-min)
23369 (org-element-property :contents-begin element)))
23370 (end (min (point-max)
23371 (org-element-property :contents-end element))))
23372 ;; Do nothing if point is at an affiliated keyword.
23373 (if (< (line-end-position) beg) t
23374 (when (derived-mode-p 'message-mode)
23375 ;; In `message-mode', do not fill following citation
23376 ;; in current paragraph nor text before message body.
23377 (let ((body-start (save-excursion (message-goto-body))))
23378 (when body-start (setq beg (max body-start beg))))
23379 (when (save-excursion
23380 (re-search-forward
23381 (concat "^" message-cite-prefix-regexp) end t))
23382 (setq end (match-beginning 0))))
23383 ;; Fill paragraph, taking line breaks into account.
23384 (save-excursion
23385 (goto-char beg)
23386 (let ((cuts (list beg)))
23387 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23388 (when (eq 'line-break
23389 (org-element-type
23390 (save-excursion (backward-char)
23391 (org-element-context))))
23392 (push (point) cuts)))
23393 (dolist (c (delq end cuts))
23394 (fill-region-as-paragraph c end justify)
23395 (setq end c))))
23396 t)))
23397 ;; Contents of `comment-block' type elements should be
23398 ;; filled as plain text, but only if point is within block
23399 ;; markers.
23400 (comment-block
23401 (let* ((case-fold-search t)
23402 (beg (save-excursion
23403 (goto-char (org-element-property :begin element))
23404 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23405 (forward-line)
23406 (point)))
23407 (end (save-excursion
23408 (goto-char (org-element-property :end element))
23409 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23410 (line-beginning-position))))
23411 (if (or (< (point) beg) (> (point) end)) t
23412 (fill-region-as-paragraph
23413 (save-excursion (end-of-line)
23414 (re-search-backward "^[ \t]*$" beg 'move)
23415 (line-beginning-position))
23416 (save-excursion (beginning-of-line)
23417 (re-search-forward "^[ \t]*$" end 'move)
23418 (line-beginning-position))
23419 justify))))
23420 ;; Fill comments.
23421 (comment
23422 (let ((begin (org-element-property :post-affiliated element))
23423 (end (org-element-property :end element)))
23424 (when (and (>= (point) begin) (<= (point) end))
23425 (let ((begin (save-excursion
23426 (end-of-line)
23427 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23428 (progn (forward-line) (point))
23429 begin)))
23430 (end (save-excursion
23431 (end-of-line)
23432 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23433 (1- (line-beginning-position))
23434 (skip-chars-backward " \r\t\n")
23435 (line-end-position)))))
23436 ;; Do not fill comments when at a blank line.
23437 (when (> end begin)
23438 (let ((fill-prefix
23439 (save-excursion
23440 (beginning-of-line)
23441 (looking-at "[ \t]*#")
23442 (let ((comment-prefix (match-string 0)))
23443 (goto-char (match-end 0))
23444 (if (looking-at adaptive-fill-regexp)
23445 (concat comment-prefix (match-string 0))
23446 (concat comment-prefix " "))))))
23447 (save-excursion
23448 (fill-region-as-paragraph begin end justify))))))
23450 ;; Ignore every other element.
23451 (otherwise t))))))
23453 (defun org-auto-fill-function ()
23454 "Auto-fill function."
23455 ;; Check if auto-filling is meaningful.
23456 (let ((fc (current-fill-column)))
23457 (when (and fc (> (current-column) fc))
23458 (let* ((fill-prefix (org-adaptive-fill-function))
23459 ;; Enforce empty fill prefix, if required. Otherwise, it
23460 ;; will be computed again.
23461 (adaptive-fill-mode (not (equal fill-prefix ""))))
23462 (when fill-prefix (do-auto-fill))))))
23464 (defun org-comment-line-break-function (&optional soft)
23465 "Break line at point and indent, continuing comment if within one.
23466 The inserted newline is marked hard if variable
23467 `use-hard-newlines' is true, unless optional argument SOFT is
23468 non-nil."
23469 (if soft (insert-and-inherit ?\n) (newline 1))
23470 (save-excursion (forward-char -1) (delete-horizontal-space))
23471 (delete-horizontal-space)
23472 (indent-to-left-margin)
23473 (insert-before-markers-and-inherit fill-prefix))
23476 ;;; Fixed Width Areas
23478 (defun org-toggle-fixed-width ()
23479 "Toggle fixed-width markup.
23481 Add or remove fixed-width markup on current line, whenever it
23482 makes sense. Return an error otherwise.
23484 If a region is active and if it contains only fixed-width areas
23485 or blank lines, remove all fixed-width markup in it. If the
23486 region contains anything else, convert all non-fixed-width lines
23487 to fixed-width ones.
23489 Blank lines at the end of the region are ignored unless the
23490 region only contains such lines."
23491 (interactive)
23492 (if (not (org-region-active-p))
23493 ;; No region:
23495 ;; Remove fixed width marker only in a fixed-with element.
23497 ;; Add fixed width maker in paragraphs, in blank lines after
23498 ;; elements or at the beginning of a headline or an inlinetask,
23499 ;; and before any one-line elements (e.g., a clock).
23500 (progn
23501 (beginning-of-line)
23502 (let* ((element (org-element-at-point))
23503 (type (org-element-type element)))
23504 (cond
23505 ((and (eq type 'fixed-width)
23506 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23507 (replace-match
23508 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23509 ((and (memq type '(babel-call clock comment diary-sexp headline
23510 horizontal-rule keyword paragraph
23511 planning))
23512 (<= (org-element-property :post-affiliated element) (point)))
23513 (skip-chars-forward " \t")
23514 (insert ": "))
23515 ((and (org-looking-at-p "[ \t]*$")
23516 (or (eq type 'inlinetask)
23517 (save-excursion
23518 (skip-chars-forward " \r\t\n")
23519 (<= (org-element-property :end element) (point)))))
23520 (delete-region (point) (line-end-position))
23521 (org-indent-line)
23522 (insert ": "))
23523 (t (user-error "Cannot insert a fixed-width line here")))))
23524 ;; Region active.
23525 (let* ((begin (save-excursion
23526 (goto-char (region-beginning))
23527 (line-beginning-position)))
23528 (end (copy-marker
23529 (save-excursion
23530 (goto-char (region-end))
23531 (unless (eolp) (beginning-of-line))
23532 (if (save-excursion (re-search-backward "\\S-" begin t))
23533 (progn (skip-chars-backward " \r\t\n") (point))
23534 (point)))))
23535 (all-fixed-width-p
23536 (catch 'not-all-p
23537 (save-excursion
23538 (goto-char begin)
23539 (skip-chars-forward " \r\t\n")
23540 (when (eobp) (throw 'not-all-p nil))
23541 (while (< (point) end)
23542 (let ((element (org-element-at-point)))
23543 (if (eq (org-element-type element) 'fixed-width)
23544 (goto-char (org-element-property :end element))
23545 (throw 'not-all-p nil))))
23546 t))))
23547 (if all-fixed-width-p
23548 (save-excursion
23549 (goto-char begin)
23550 (while (< (point) end)
23551 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23552 (replace-match
23553 "" nil nil nil
23554 (if (= (line-end-position) (match-end 0)) 0 1)))
23555 (forward-line)))
23556 (let ((min-ind (point-max)))
23557 ;; Find minimum indentation across all lines.
23558 (save-excursion
23559 (goto-char begin)
23560 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23561 (setq min-ind 0)
23562 (catch 'zerop
23563 (while (< (point) end)
23564 (unless (org-looking-at-p "[ \t]*$")
23565 (let ((ind (org-get-indentation)))
23566 (setq min-ind (min min-ind ind))
23567 (when (zerop ind) (throw 'zerop t))))
23568 (forward-line)))))
23569 ;; Loop over all lines and add fixed-width markup everywhere
23570 ;; but in fixed-width lines.
23571 (save-excursion
23572 (goto-char begin)
23573 (while (< (point) end)
23574 (cond
23575 ((org-at-heading-p)
23576 (insert ": ")
23577 (forward-line)
23578 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23579 (insert ":")
23580 (forward-line)))
23581 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23582 (let* ((element (org-element-at-point))
23583 (element-end (org-element-property :end element)))
23584 (if (eq (org-element-type element) 'fixed-width)
23585 (progn (goto-char element-end)
23586 (skip-chars-backward " \r\t\n")
23587 (forward-line))
23588 (let ((limit (min end element-end)))
23589 (while (< (point) limit)
23590 (org-move-to-column min-ind t)
23591 (insert ": ")
23592 (forward-line))))))
23594 (org-move-to-column min-ind t)
23595 (insert ": ")
23596 (forward-line)))))))
23597 (set-marker end nil))))
23600 ;;; Comments
23602 ;; Org comments syntax is quite complex. It requires the entire line
23603 ;; to be just a comment. Also, even with the right syntax at the
23604 ;; beginning of line, some some elements (i.e. verse-block or
23605 ;; example-block) don't accept comments. Usual Emacs comment commands
23606 ;; cannot cope with those requirements. Therefore, Org replaces them.
23608 ;; Org still relies on `comment-dwim', but cannot trust
23609 ;; `comment-only-p'. So, `comment-region-function' and
23610 ;; `uncomment-region-function' both point
23611 ;; to`org-comment-or-uncomment-region'. Eventually,
23612 ;; `org-insert-comment' takes care of insertion of comments at the
23613 ;; beginning of line.
23615 ;; `org-setup-comments-handling' install comments related variables
23616 ;; during `org-mode' initialization.
23618 (defun org-setup-comments-handling ()
23619 (interactive)
23620 (org-set-local 'comment-use-syntax nil)
23621 (org-set-local 'comment-start "# ")
23622 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23623 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23624 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23625 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23627 (defun org-insert-comment ()
23628 "Insert an empty comment above current line.
23629 If the line is empty, insert comment at its beginning. When
23630 point is within a source block, comment according to the related
23631 major mode."
23632 (if (let ((element (org-element-at-point)))
23633 (and (eq (org-element-type element) 'src-block)
23634 (< (save-excursion
23635 (goto-char (org-element-property :post-affiliated element))
23636 (line-end-position))
23637 (point))
23638 (> (save-excursion
23639 (goto-char (org-element-property :end element))
23640 (skip-chars-backward " \r\t\n")
23641 (line-beginning-position))
23642 (point))))
23643 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23644 (beginning-of-line)
23645 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23646 (open-line 1))
23647 (org-indent-line)
23648 (insert "# ")))
23650 (defvar comment-empty-lines) ; From newcomment.el.
23651 (defun org-comment-or-uncomment-region (beg end &rest _)
23652 "Comment or uncomment each non-blank line in the region.
23653 Uncomment each non-blank line between BEG and END if it only
23654 contains commented lines. Otherwise, comment them. If region is
23655 strictly within a source block, use appropriate comment syntax."
23656 (if (let ((element (org-element-at-point)))
23657 (and (eq (org-element-type element) 'src-block)
23658 (< (save-excursion
23659 (goto-char (org-element-property :post-affiliated element))
23660 (line-end-position))
23661 beg)
23662 (>= (save-excursion
23663 (goto-char (org-element-property :end element))
23664 (skip-chars-backward " \r\t\n")
23665 (line-beginning-position))
23666 end)))
23667 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23668 (save-restriction
23669 ;; Restrict region
23670 (narrow-to-region (save-excursion (goto-char beg)
23671 (skip-chars-forward " \r\t\n" end)
23672 (line-beginning-position))
23673 (save-excursion (goto-char end)
23674 (skip-chars-backward " \r\t\n" beg)
23675 (line-end-position)))
23676 (let ((uncommentp
23677 ;; UNCOMMENTP is non-nil when every non blank line between
23678 ;; BEG and END is a comment.
23679 (save-excursion
23680 (goto-char (point-min))
23681 (while (and (not (eobp))
23682 (let ((element (org-element-at-point)))
23683 (and (eq (org-element-type element) 'comment)
23684 (goto-char (min (point-max)
23685 (org-element-property
23686 :end element)))))))
23687 (eobp))))
23688 (if uncommentp
23689 ;; Only blank lines and comments in region: uncomment it.
23690 (save-excursion
23691 (goto-char (point-min))
23692 (while (not (eobp))
23693 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23694 (replace-match "" nil nil nil 1))
23695 (forward-line)))
23696 ;; Comment each line in region.
23697 (let ((min-indent (point-max)))
23698 ;; First find the minimum indentation across all lines.
23699 (save-excursion
23700 (goto-char (point-min))
23701 (while (and (not (eobp)) (not (zerop min-indent)))
23702 (unless (looking-at "[ \t]*$")
23703 (setq min-indent (min min-indent (current-indentation))))
23704 (forward-line)))
23705 ;; Then loop over all lines.
23706 (save-excursion
23707 (goto-char (point-min))
23708 (while (not (eobp))
23709 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23710 ;; Don't get fooled by invisible text (e.g. link path)
23711 ;; when moving to column MIN-INDENT.
23712 (let ((buffer-invisibility-spec nil))
23713 (org-move-to-column min-indent t))
23714 (insert comment-start))
23715 (forward-line)))))))))
23717 (defun org-comment-dwim (arg)
23718 "Call `comment-dwim' within a source edit buffer if needed."
23719 (interactive "*P")
23720 (if (org-in-src-block-p)
23721 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23722 (call-interactively 'comment-dwim)))
23725 ;;; Timestamps API
23727 ;; This section contains tools to operate on timestamp objects, as
23728 ;; returned by, e.g. `org-element-context'.
23730 (defun org-timestamp--to-internal-time (timestamp &optional end)
23731 "Encode TIMESTAMP object into Emacs internal time.
23732 Use end of date range or time range when END is non-nil."
23733 (apply #'encode-time
23734 (cons 0
23735 (mapcar
23736 (lambda (prop) (or (org-element-property prop timestamp) 0))
23737 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23738 '(:minute-start :hour-start :day-start :month-start
23739 :year-start))))))
23741 (defun org-timestamp-has-time-p (timestamp)
23742 "Non-nil when TIMESTAMP has a time specified."
23743 (org-element-property :hour-start timestamp))
23745 (defun org-timestamp-format (timestamp format &optional end utc)
23746 "Format a TIMESTAMP object into a string.
23748 FORMAT is a format specifier to be passed to
23749 `format-time-string'.
23751 When optional argument END is non-nil, use end of date-range or
23752 time-range, if possible.
23754 When optional argument UTC is non-nil, time will be expressed as
23755 Universal Time."
23756 (format-time-string
23757 format (org-timestamp--to-internal-time timestamp end) utc))
23759 (defun org-timestamp-split-range (timestamp &optional end)
23760 "Extract a TIMESTAMP object from a date or time range.
23762 END, when non-nil, means extract the end of the range.
23763 Otherwise, extract its start.
23765 Return a new timestamp object."
23766 (let ((type (org-element-property :type timestamp)))
23767 (if (memq type '(active inactive diary)) timestamp
23768 (let ((split-ts (org-element-copy timestamp)))
23769 ;; Set new type.
23770 (org-element-put-property
23771 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23772 ;; Copy start properties over end properties if END is
23773 ;; non-nil. Otherwise, copy end properties over `start' ones.
23774 (let ((p-alist '((:minute-start . :minute-end)
23775 (:hour-start . :hour-end)
23776 (:day-start . :day-end)
23777 (:month-start . :month-end)
23778 (:year-start . :year-end))))
23779 (dolist (p-cell p-alist)
23780 (org-element-put-property
23781 split-ts
23782 (funcall (if end #'car #'cdr) p-cell)
23783 (org-element-property
23784 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23785 ;; Eventually refresh `:raw-value'.
23786 (org-element-put-property split-ts :raw-value nil)
23787 (org-element-put-property
23788 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23790 (defun org-timestamp-translate (timestamp &optional boundary)
23791 "Translate TIMESTAMP object to custom format.
23793 Format string is defined in `org-time-stamp-custom-formats',
23794 which see.
23796 When optional argument BOUNDARY is non-nil, it is either the
23797 symbol `start' or `end'. In this case, only translate the
23798 starting or ending part of TIMESTAMP if it is a date or time
23799 range. Otherwise, translate both parts.
23801 Return timestamp as-is if `org-display-custom-times' is nil or if
23802 it has a `diary' type."
23803 (let ((type (org-element-property :type timestamp)))
23804 (if (or (not org-display-custom-times) (eq type 'diary))
23805 (org-element-interpret-data timestamp)
23806 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23807 org-time-stamp-custom-formats)))
23808 (if (and (not boundary) (memq type '(active-range inactive-range)))
23809 (concat (org-timestamp-format timestamp fmt)
23810 "--"
23811 (org-timestamp-format timestamp fmt t))
23812 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23816 ;;; Other stuff.
23818 (defvar reftex-docstruct-symbol)
23819 (defvar reftex-cite-format)
23820 (defvar org--rds)
23822 (defun org-reftex-citation ()
23823 "Use reftex-citation to insert a citation into the buffer.
23824 This looks for a line like
23826 #+BIBLIOGRAPHY: foo plain option:-d
23828 and derives from it that foo.bib is the bibliography file relevant
23829 for this document. It then installs the necessary environment for RefTeX
23830 to work in this buffer and calls `reftex-citation' to insert a citation
23831 into the buffer.
23833 Export of such citations to both LaTeX and HTML is handled by the contributed
23834 package ox-bibtex by Taru Karttunen."
23835 (interactive)
23836 (let ((reftex-docstruct-symbol 'org--rds)
23837 (reftex-cite-format "\\cite{%l}")
23838 org--rds bib)
23839 (save-excursion
23840 (save-restriction
23841 (widen)
23842 (let ((case-fold-search t)
23843 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23844 (if (not (save-excursion
23845 (or (re-search-forward re nil t)
23846 (re-search-backward re nil t))))
23847 (user-error "No bibliography defined in file")
23848 (setq bib (concat (match-string 1) ".bib")
23849 org--rds (list (list 'bib bib)))))))
23850 (call-interactively 'reftex-citation)))
23852 ;;;; Functions extending outline functionality
23854 (defun org-beginning-of-line (&optional arg)
23855 "Go to the beginning of the current line. If that is invisible, continue
23856 to a visible line beginning. This makes the function of C-a more intuitive.
23857 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23858 first attempt, and only move to after the tags when the cursor is already
23859 beyond the end of the headline."
23860 (interactive "P")
23861 (let ((pos (point))
23862 (special (if (consp org-special-ctrl-a/e)
23863 (car org-special-ctrl-a/e)
23864 org-special-ctrl-a/e))
23865 deactivate-mark refpos)
23866 (if (org-bound-and-true-p visual-line-mode)
23867 (beginning-of-visual-line 1)
23868 (beginning-of-line 1))
23869 (if (and arg (fboundp 'move-beginning-of-line))
23870 (call-interactively 'move-beginning-of-line)
23871 (if (bobp)
23873 (backward-char 1)
23874 (if (org-truely-invisible-p)
23875 (while (and (not (bobp)) (org-truely-invisible-p))
23876 (backward-char 1)
23877 (beginning-of-line 1))
23878 (forward-char 1))))
23879 (when special
23880 (cond
23881 ((and (looking-at org-complex-heading-regexp)
23882 (eq (char-after (match-end 1)) ?\s))
23883 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23884 (point-at-eol)))
23885 (goto-char
23886 (if (eq special t)
23887 (cond ((> pos refpos) refpos)
23888 ((= pos (point)) refpos)
23889 (t (point)))
23890 (cond ((> pos (point)) (point))
23891 ((not (eq last-command this-command)) (point))
23892 (t refpos)))))
23893 ((org-at-item-p)
23894 ;; Being at an item and not looking at an the item means point
23895 ;; was previously moved to beginning of a visual line, which
23896 ;; doesn't contain the item. Therefore, do nothing special,
23897 ;; just stay here.
23898 (when (looking-at org-list-full-item-re)
23899 ;; Set special position at first white space character after
23900 ;; bullet, and check-box, if any.
23901 (let ((after-bullet
23902 (let ((box (match-end 3)))
23903 (if (not box) (match-end 1)
23904 (let ((after (char-after box)))
23905 (if (and after (= after ? )) (1+ box) box))))))
23906 ;; Special case: Move point to special position when
23907 ;; currently after it or at beginning of line.
23908 (if (eq special t)
23909 (when (or (> pos after-bullet) (= (point) pos))
23910 (goto-char after-bullet))
23911 ;; Reversed case: Move point to special position when
23912 ;; point was already at beginning of line and command is
23913 ;; repeated.
23914 (when (and (= (point) pos) (eq last-command this-command))
23915 (goto-char after-bullet))))))))
23916 (org-no-warnings
23917 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23918 (setq disable-point-adjustment
23919 (or (not (invisible-p (point)))
23920 (not (invisible-p (max (point-min) (1- (point))))))))
23922 (defun org-end-of-line (&optional arg)
23923 "Go to the end of the line.
23924 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23925 tags on the first attempt, and only move to after the tags when
23926 the cursor is already beyond the end of the headline."
23927 (interactive "P")
23928 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23929 org-special-ctrl-a/e))
23930 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23931 'end-of-visual-line)
23932 ((fboundp 'move-end-of-line) 'move-end-of-line)
23933 (t 'end-of-line)))
23934 deactivate-mark)
23935 (if (or (not special) arg) (call-interactively move-fun)
23936 (let* ((element (save-excursion (beginning-of-line)
23937 (org-element-at-point)))
23938 (type (org-element-type element)))
23939 (cond
23940 ((memq type '(headline inlinetask))
23941 (let ((pos (point)))
23942 (beginning-of-line 1)
23943 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23944 (if (eq special t)
23945 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23946 (goto-char (match-beginning 1))
23947 (goto-char (match-end 0)))
23948 (if (or (< pos (match-end 0))
23949 (not (eq this-command last-command)))
23950 (goto-char (match-end 0))
23951 (goto-char (match-beginning 1))))
23952 (call-interactively move-fun))))
23953 ((outline-invisible-p (line-end-position))
23954 ;; If element is hidden, `move-end-of-line' would put point
23955 ;; after it. Use `end-of-line' to stay on current line.
23956 (call-interactively 'end-of-line))
23957 (t (call-interactively move-fun)))))
23958 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23959 (setq disable-point-adjustment
23960 (or (not (invisible-p (point)))
23961 (not (invisible-p (max (point-min) (1- (point))))))))
23963 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23964 (define-key org-mode-map "\C-e" 'org-end-of-line)
23966 (defun org-backward-sentence (&optional _arg)
23967 "Go to beginning of sentence, or beginning of table field.
23968 This will call `backward-sentence' or `org-table-beginning-of-field',
23969 depending on context."
23970 (interactive)
23971 (let* ((element (org-element-at-point))
23972 (contents-begin (org-element-property :contents-begin element))
23973 (table (org-element-lineage element '(table) t)))
23974 (if (and table
23975 (> (point) contents-begin)
23976 (<= (point) (org-element-property :contents-end table)))
23977 (call-interactively #'org-table-beginning-of-field)
23978 (save-restriction
23979 (when (and contents-begin
23980 (< (point-min) contents-begin)
23981 (> (point) contents-begin))
23982 (narrow-to-region contents-begin
23983 (org-element-property :contents-end element)))
23984 (call-interactively #'backward-sentence)))))
23986 (defun org-forward-sentence (&optional _arg)
23987 "Go to end of sentence, or end of table field.
23988 This will call `forward-sentence' or `org-table-end-of-field',
23989 depending on context."
23990 (interactive)
23991 (let* ((element (org-element-at-point))
23992 (contents-end (org-element-property :contents-end element))
23993 (table (org-element-lineage element '(table) t)))
23994 (if (and table
23995 (>= (point) (org-element-property :contents-begin table))
23996 (< (point) contents-end))
23997 (call-interactively #'org-table-end-of-field)
23998 (save-restriction
23999 (when (and contents-end
24000 (> (point-max) contents-end)
24001 ;; Skip blank lines between elements.
24002 (< (org-element-property :end element)
24003 (save-excursion (goto-char contents-end)
24004 (skip-chars-forward " \r\t\n"))))
24005 (narrow-to-region (org-element-property :contents-begin element)
24006 contents-end))
24007 (call-interactively #'forward-sentence)))))
24009 (define-key org-mode-map "\M-a" 'org-backward-sentence)
24010 (define-key org-mode-map "\M-e" 'org-forward-sentence)
24012 (defun org-kill-line (&optional _arg)
24013 "Kill line, to tags or end of line."
24014 (interactive)
24015 (cond
24016 ((or (not org-special-ctrl-k)
24017 (bolp)
24018 (not (org-at-heading-p)))
24019 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
24020 org-ctrl-k-protect-subtree)
24021 (if (or (eq org-ctrl-k-protect-subtree 'error)
24022 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
24023 (user-error "C-k aborted as it would kill a hidden subtree")))
24024 (call-interactively
24025 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
24026 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
24027 (kill-region (point) (match-beginning 1))
24028 (org-set-tags nil t))
24029 (t (kill-region (point) (point-at-eol)))))
24031 (define-key org-mode-map "\C-k" 'org-kill-line)
24033 (defun org-yank (&optional arg)
24034 "Yank. If the kill is a subtree, treat it specially.
24035 This command will look at the current kill and check if is a single
24036 subtree, or a series of subtrees[1]. If it passes the test, and if the
24037 cursor is at the beginning of a line or after the stars of a currently
24038 empty headline, then the yank is handled specially. How exactly depends
24039 on the value of the following variables, both set by default.
24041 `org-yank-folded-subtrees'
24042 When set, the subtree(s) will be folded after insertion, but only
24043 if doing so would now swallow text after the yanked text.
24045 `org-yank-adjusted-subtrees'
24046 When set, the subtree will be promoted or demoted in order to
24047 fit into the local outline tree structure, which means that the
24048 level will be adjusted so that it becomes the smaller one of the
24049 two *visible* surrounding headings.
24051 Any prefix to this command will cause `yank' to be called directly with
24052 no special treatment. In particular, a simple \\[universal-argument] prefix \
24053 will just
24054 plainly yank the text as it is.
24056 \[1] The test checks if the first non-white line is a heading
24057 and if there are no other headings with fewer stars."
24058 (interactive "P")
24059 (org-yank-generic 'yank arg))
24061 (defun org-yank-generic (command arg)
24062 "Perform some yank-like command.
24064 This function implements the behavior described in the `org-yank'
24065 documentation. However, it has been generalized to work for any
24066 interactive command with similar behavior."
24068 ;; pretend to be command COMMAND
24069 (setq this-command command)
24071 (if arg
24072 (call-interactively command)
24074 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24075 (and (org-kill-is-subtree-p)
24076 (or (bolp)
24077 (and (looking-at "[ \t]*$")
24078 (string-match
24079 "\\`\\*+\\'"
24080 (buffer-substring (point-at-bol) (point)))))))
24081 swallowp)
24082 (cond
24083 ((and subtreep org-yank-folded-subtrees)
24084 (let ((beg (point))
24085 end)
24086 (if (and subtreep org-yank-adjusted-subtrees)
24087 (org-paste-subtree nil nil 'for-yank)
24088 (call-interactively command))
24090 (setq end (point))
24091 (goto-char beg)
24092 (when (and (bolp) subtreep
24093 (not (setq swallowp
24094 (org-yank-folding-would-swallow-text beg end))))
24095 (org-with-limited-levels
24096 (or (looking-at org-outline-regexp)
24097 (re-search-forward org-outline-regexp-bol end t))
24098 (while (and (< (point) end) (looking-at org-outline-regexp))
24099 (hide-subtree)
24100 (org-cycle-show-empty-lines 'folded)
24101 (condition-case nil
24102 (outline-forward-same-level 1)
24103 (error (goto-char end))))))
24104 (when swallowp
24105 (message
24106 "Inserted text not folded because that would swallow text"))
24108 (goto-char end)
24109 (skip-chars-forward " \t\n\r")
24110 (beginning-of-line 1)
24111 (push-mark beg 'nomsg)))
24112 ((and subtreep org-yank-adjusted-subtrees)
24113 (let ((beg (point-at-bol)))
24114 (org-paste-subtree nil nil 'for-yank)
24115 (push-mark beg 'nomsg)))
24117 (call-interactively command))))))
24119 (defun org-yank-folding-would-swallow-text (beg end)
24120 "Would hide-subtree at BEG swallow any text after END?"
24121 (let (level)
24122 (org-with-limited-levels
24123 (save-excursion
24124 (goto-char beg)
24125 (when (or (looking-at org-outline-regexp)
24126 (re-search-forward org-outline-regexp-bol end t))
24127 (setq level (org-outline-level)))
24128 (goto-char end)
24129 (skip-chars-forward " \t\r\n\v\f")
24130 (if (or (eobp)
24131 (and (bolp) (looking-at org-outline-regexp)
24132 (<= (org-outline-level) level)))
24133 nil ; Nothing would be swallowed
24134 t))))) ; something would swallow
24136 (define-key org-mode-map "\C-y" 'org-yank)
24138 (defun org-truely-invisible-p ()
24139 "Check if point is at a character currently not visible.
24140 This version does not only check the character property, but also
24141 `visible-mode'."
24142 ;; Early versions of noutline don't have `outline-invisible-p'.
24143 (if (org-bound-and-true-p visible-mode)
24145 (outline-invisible-p)))
24147 (defun org-invisible-p2 ()
24148 "Check if point is at a character currently not visible."
24149 (save-excursion
24150 (if (and (eolp) (not (bobp))) (backward-char 1))
24151 ;; Early versions of noutline don't have `outline-invisible-p'.
24152 (outline-invisible-p)))
24154 (defun org-back-to-heading (&optional invisible-ok)
24155 "Call `outline-back-to-heading', but provide a better error message."
24156 (condition-case nil
24157 (outline-back-to-heading invisible-ok)
24158 (error (error "Before first headline at position %d in buffer %s"
24159 (point) (current-buffer)))))
24161 (defun org-before-first-heading-p ()
24162 "Before first heading?"
24163 (save-excursion
24164 (end-of-line)
24165 (null (re-search-backward org-outline-regexp-bol nil t))))
24167 (defun org-at-heading-p (&optional ignored)
24168 (outline-on-heading-p t))
24169 ;; Compatibility alias with Org versions < 7.8.03
24170 (defalias 'org-on-heading-p 'org-at-heading-p)
24172 (defun org-in-commented-heading-p (&optional no-inheritance)
24173 "Non-nil if point is under a commented heading.
24174 This function also checks ancestors of the current headline,
24175 unless optional argument NO-INHERITANCE is non-nil."
24176 (cond
24177 ((org-before-first-heading-p) nil)
24178 ((let ((headline (nth 4 (org-heading-components))))
24179 (and headline
24180 (let ((case-fold-search nil))
24181 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24182 headline)))))
24183 (no-inheritance nil)
24185 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24187 (defun org-at-comment-p nil
24188 "Is cursor in a commented line?"
24189 (save-excursion
24190 (save-match-data
24191 (beginning-of-line)
24192 (looking-at "^[ \t]*# "))))
24194 (defun org-at-drawer-p nil
24195 "Is cursor at a drawer keyword?"
24196 (save-excursion
24197 (move-beginning-of-line 1)
24198 (looking-at org-drawer-regexp)))
24200 (defun org-at-block-p nil
24201 "Is cursor at a block keyword?"
24202 (save-excursion
24203 (move-beginning-of-line 1)
24204 (looking-at org-block-regexp)))
24206 (defun org-point-at-end-of-empty-headline ()
24207 "If point is at the end of an empty headline, return t, else nil.
24208 If the heading only contains a TODO keyword, it is still still considered
24209 empty."
24210 (and (looking-at "[ \t]*$")
24211 (when org-todo-line-regexp
24212 (save-excursion
24213 (beginning-of-line 1)
24214 (let ((case-fold-search nil))
24215 (looking-at org-todo-line-regexp)
24216 (string= (match-string 3) ""))))))
24218 (defun org-at-heading-or-item-p ()
24219 (or (org-at-heading-p) (org-at-item-p)))
24221 (defun org-at-target-p ()
24222 (or (org-in-regexp org-radio-target-regexp)
24223 (org-in-regexp org-target-regexp)))
24224 ;; Compatibility alias with Org versions < 7.8.03
24225 (defalias 'org-on-target-p 'org-at-target-p)
24227 (defun org-up-heading-all (arg)
24228 "Move to the heading line of which the present line is a subheading.
24229 This function considers both visible and invisible heading lines.
24230 With argument, move up ARG levels."
24231 (if (fboundp 'outline-up-heading-all)
24232 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24233 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24235 (defun org-up-heading-safe ()
24236 "Move to the heading line of which the present line is a subheading.
24237 This version will not throw an error. It will return the level of the
24238 headline found, or nil if no higher level is found.
24240 Also, this function will be a lot faster than `outline-up-heading',
24241 because it relies on stars being the outline starters. This can really
24242 make a significant difference in outlines with very many siblings."
24243 (when (ignore-errors (org-back-to-heading t))
24244 (let ((level-up (1- (funcall outline-level))))
24245 (and (> level-up 0)
24246 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24247 (funcall outline-level)))))
24249 (defun org-first-sibling-p ()
24250 "Is this heading the first child of its parents?"
24251 (interactive)
24252 (let ((re org-outline-regexp-bol)
24253 level l)
24254 (unless (org-at-heading-p t)
24255 (user-error "Not at a heading"))
24256 (setq level (funcall outline-level))
24257 (save-excursion
24258 (if (not (re-search-backward re nil t))
24260 (setq l (funcall outline-level))
24261 (< l level)))))
24263 (defun org-goto-sibling (&optional previous)
24264 "Goto the next sibling, even if it is invisible.
24265 When PREVIOUS is set, go to the previous sibling instead. Returns t
24266 when a sibling was found. When none is found, return nil and don't
24267 move point."
24268 (let ((fun (if previous 're-search-backward 're-search-forward))
24269 (pos (point))
24270 (re org-outline-regexp-bol)
24271 level l)
24272 (when (ignore-errors (org-back-to-heading t))
24273 (setq level (funcall outline-level))
24274 (catch 'exit
24275 (or previous (forward-char 1))
24276 (while (funcall fun re nil t)
24277 (setq l (funcall outline-level))
24278 (when (< l level) (goto-char pos) (throw 'exit nil))
24279 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24280 (goto-char pos)
24281 nil))))
24283 (defun org-show-siblings ()
24284 "Show all siblings of the current headline."
24285 (save-excursion
24286 (while (org-goto-sibling) (org-flag-heading nil)))
24287 (save-excursion
24288 (while (org-goto-sibling 'previous)
24289 (org-flag-heading nil))))
24291 (defun org-goto-first-child ()
24292 "Goto the first child, even if it is invisible.
24293 Return t when a child was found. Otherwise don't move point and
24294 return nil."
24295 (let (level (pos (point)) (re org-outline-regexp-bol))
24296 (when (ignore-errors (org-back-to-heading t))
24297 (setq level (outline-level))
24298 (forward-char 1)
24299 (if (and (re-search-forward re nil t) (> (outline-level) level))
24300 (progn (goto-char (match-beginning 0)) t)
24301 (goto-char pos) nil))))
24303 (defun org-show-hidden-entry ()
24304 "Show an entry where even the heading is hidden."
24305 (save-excursion
24306 (org-show-entry)))
24308 (defun org-flag-heading (flag &optional entry)
24309 "Flag the current heading. FLAG non-nil means make invisible.
24310 When ENTRY is non-nil, show the entire entry."
24311 (save-excursion
24312 (org-back-to-heading t)
24313 ;; Check if we should show the entire entry
24314 (if entry
24315 (progn
24316 (org-show-entry)
24317 (save-excursion
24318 (and (outline-next-heading)
24319 (org-flag-heading nil))))
24320 (outline-flag-region (max (point-min) (1- (point)))
24321 (save-excursion (outline-end-of-heading) (point))
24322 flag))))
24324 (defun org-get-next-sibling ()
24325 "Move to next heading of the same level, and return point.
24326 If there is no such heading, return nil.
24327 This is like outline-next-sibling, but invisible headings are ok."
24328 (let ((level (funcall outline-level)))
24329 (outline-next-heading)
24330 (while (and (not (eobp)) (> (funcall outline-level) level))
24331 (outline-next-heading))
24332 (if (or (eobp) (< (funcall outline-level) level))
24334 (point))))
24336 (defun org-get-last-sibling ()
24337 "Move to previous heading of the same level, and return point.
24338 If there is no such heading, return nil."
24339 (let ((opoint (point))
24340 (level (funcall outline-level)))
24341 (outline-previous-heading)
24342 (when (and (/= (point) opoint) (outline-on-heading-p t))
24343 (while (and (> (funcall outline-level) level)
24344 (not (bobp)))
24345 (outline-previous-heading))
24346 (if (< (funcall outline-level) level)
24348 (point)))))
24350 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24351 "Goto to the end of a subtree."
24352 ;; This contains an exact copy of the original function, but it uses
24353 ;; `org-back-to-heading', to make it work also in invisible
24354 ;; trees. And is uses an invisible-ok argument.
24355 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24356 ;; Furthermore, when used inside Org, finding the end of a large subtree
24357 ;; with many children and grandchildren etc, this can be much faster
24358 ;; than the outline version.
24359 (org-back-to-heading invisible-ok)
24360 (let ((first t)
24361 (level (funcall outline-level)))
24362 (if (and (derived-mode-p 'org-mode) (< level 1000))
24363 ;; A true heading (not a plain list item), in Org-mode
24364 ;; This means we can easily find the end by looking
24365 ;; only for the right number of stars. Using a regexp to do
24366 ;; this is so much faster than using a Lisp loop.
24367 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24368 (forward-char 1)
24369 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24370 ;; something else, do it the slow way
24371 (while (and (not (eobp))
24372 (or first (> (funcall outline-level) level)))
24373 (setq first nil)
24374 (outline-next-heading)))
24375 (unless to-heading
24376 (if (memq (preceding-char) '(?\n ?\^M))
24377 (progn
24378 ;; Go to end of line before heading
24379 (forward-char -1)
24380 (if (memq (preceding-char) '(?\n ?\^M))
24381 ;; leave blank line before heading
24382 (forward-char -1))))))
24383 (point))
24385 (defun org-end-of-meta-data (&optional full)
24386 "Skip planning line and properties drawer in current entry.
24387 When optional argument FULL is non-nil, also skip empty lines,
24388 clocking lines and regular drawers at the beginning of the
24389 entry."
24390 (org-back-to-heading t)
24391 (forward-line)
24392 (when (org-looking-at-p org-planning-line-re) (forward-line))
24393 (when (looking-at org-property-drawer-re)
24394 (goto-char (match-end 0))
24395 (forward-line))
24396 (when (and full (not (org-at-heading-p)))
24397 (catch 'exit
24398 (let ((end (save-excursion (outline-next-heading) (point)))
24399 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24400 (while (not (eobp))
24401 (cond ((org-looking-at-p org-drawer-regexp)
24402 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24403 (forward-line)
24404 (throw 'exit t)))
24405 ((org-looking-at-p re) (forward-line))
24406 (t (throw 'exit t))))))))
24408 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24409 "Move forward to the ARG'th subheading at same level as this one.
24410 Stop at the first and last subheadings of a superior heading.
24411 Normally this only looks at visible headings, but when INVISIBLE-OK is
24412 non-nil it will also look at invisible ones."
24413 (interactive "p")
24414 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24415 (if (and arg (< arg 0))
24416 (goto-char (point-min))
24417 (outline-next-heading))
24418 (org-at-heading-p)
24419 (let ((level (- (match-end 0) (match-beginning 0) 1))
24420 (f (if (and arg (< arg 0))
24421 're-search-backward
24422 're-search-forward))
24423 (count (if arg (abs arg) 1))
24424 (result (point)))
24425 (while (and (prog1 (> count 0)
24426 (forward-char (if (and arg (< arg 0)) -1 1)))
24427 (funcall f org-outline-regexp-bol nil 'move))
24428 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24429 (cond ((< l level) (setq count 0))
24430 ((and (= l level)
24431 (or invisible-ok
24432 (progn
24433 (goto-char (line-beginning-position))
24434 (not (outline-invisible-p)))))
24435 (setq count (1- count))
24436 (when (eq l level)
24437 (setq result (point)))))))
24438 (goto-char result))
24439 (beginning-of-line 1)))
24441 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24442 "Move backward to the ARG'th subheading at same level as this one.
24443 Stop at the first and last subheadings of a superior heading."
24444 (interactive "p")
24445 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24447 (defun org-next-visible-heading (arg)
24448 "Move to the next visible heading.
24450 This function wraps `outline-next-visible-heading' with
24451 `org-with-limited-levels' in order to skip over inline tasks and
24452 respect customization of `org-odd-levels-only'."
24453 (interactive "p")
24454 (org-with-limited-levels
24455 (outline-next-visible-heading arg)))
24457 (defun org-previous-visible-heading (arg)
24458 "Move to the next visible heading.
24460 This function wraps `outline-previous-visible-heading' with
24461 `org-with-limited-levels' in order to skip over inline tasks and
24462 respect customization of `org-odd-levels-only'."
24463 (interactive "p")
24464 (org-with-limited-levels
24465 (outline-previous-visible-heading arg)))
24467 (defun org-next-block (arg &optional backward block-regexp)
24468 "Jump to the next block.
24470 With a prefix argument ARG, jump forward ARG many blocks.
24472 When BACKWARD is non-nil, jump to the previous block.
24474 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24475 Match data is set according to this regexp when the function
24476 returns.
24478 Return point at beginning of the opening line of found block.
24479 Throw an error if no block is found."
24480 (interactive "p")
24481 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24482 (case-fold-search t)
24483 (search-fn (if backward #'re-search-backward #'re-search-forward))
24484 (count (or arg 1))
24485 (origin (point))
24486 last-element)
24487 (if backward (beginning-of-line) (end-of-line))
24488 (while (and (> count 0) (funcall search-fn re nil t))
24489 (let ((element (save-excursion
24490 (goto-char (match-beginning 0))
24491 (save-match-data (org-element-at-point)))))
24492 (when (and (memq (org-element-type element)
24493 '(center-block comment-block dynamic-block
24494 example-block export-block quote-block
24495 special-block src-block verse-block))
24496 (<= (match-beginning 0)
24497 (org-element-property :post-affiliated element)))
24498 (setq last-element element)
24499 (decf count))))
24500 (if (= count 0)
24501 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24502 (save-match-data (org-show-context)))
24503 (goto-char origin)
24504 (user-error "No %s code blocks" (if backward "previous" "further")))))
24506 (defun org-previous-block (arg &optional block-regexp)
24507 "Jump to the previous block.
24508 With a prefix argument ARG, jump backward ARG many source blocks.
24509 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24510 (interactive "p")
24511 (org-next-block arg t block-regexp))
24513 (defun org-forward-paragraph ()
24514 "Move forward to beginning of next paragraph or equivalent.
24516 The function moves point to the beginning of the next visible
24517 structural element, which can be a paragraph, a table, a list
24518 item, etc. It also provides some special moves for convenience:
24520 - On an affiliated keyword, jump to the beginning of the
24521 relative element.
24522 - On an item or a footnote definition, move to the second
24523 element inside, if any.
24524 - On a table or a property drawer, jump after it.
24525 - On a verse or source block, stop after blank lines."
24526 (interactive)
24527 (when (eobp) (user-error "Cannot move further down"))
24528 (let* ((deactivate-mark nil)
24529 (element (org-element-at-point))
24530 (type (org-element-type element))
24531 (post-affiliated (org-element-property :post-affiliated element))
24532 (contents-begin (org-element-property :contents-begin element))
24533 (contents-end (org-element-property :contents-end element))
24534 (end (let ((end (org-element-property :end element)) (parent element))
24535 (while (and (setq parent (org-element-property :parent parent))
24536 (= (org-element-property :contents-end parent) end))
24537 (setq end (org-element-property :end parent)))
24538 end)))
24539 (cond ((not element)
24540 (skip-chars-forward " \r\t\n")
24541 (or (eobp) (beginning-of-line)))
24542 ;; On affiliated keywords, move to element's beginning.
24543 ((< (point) post-affiliated)
24544 (goto-char post-affiliated))
24545 ;; At a table row, move to the end of the table. Similarly,
24546 ;; at a node property, move to the end of the property
24547 ;; drawer.
24548 ((memq type '(node-property table-row))
24549 (goto-char (org-element-property
24550 :end (org-element-property :parent element))))
24551 ((memq type '(property-drawer table)) (goto-char end))
24552 ;; Consider blank lines as separators in verse and source
24553 ;; blocks to ease editing.
24554 ((memq type '(src-block verse-block))
24555 (when (eq type 'src-block)
24556 (setq contents-end
24557 (save-excursion (goto-char end)
24558 (skip-chars-backward " \r\t\n")
24559 (line-beginning-position))))
24560 (beginning-of-line)
24561 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24562 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24563 (goto-char end)
24564 (skip-chars-forward " \r\t\n")
24565 (if (= (point) contents-end) (goto-char end)
24566 (beginning-of-line))))
24567 ;; With no contents, just skip element.
24568 ((not contents-begin) (goto-char end))
24569 ;; If contents are invisible, skip the element altogether.
24570 ((outline-invisible-p (line-end-position))
24571 (case type
24572 (headline
24573 (org-with-limited-levels (outline-next-visible-heading 1)))
24574 ;; At a plain list, make sure we move to the next item
24575 ;; instead of skipping the whole list.
24576 (plain-list (forward-char)
24577 (org-forward-paragraph))
24578 (otherwise (goto-char end))))
24579 ((>= (point) contents-end) (goto-char end))
24580 ((>= (point) contents-begin)
24581 ;; This can only happen on paragraphs and plain lists.
24582 (case type
24583 (paragraph (goto-char end))
24584 ;; At a plain list, try to move to second element in
24585 ;; first item, if possible.
24586 (plain-list (end-of-line)
24587 (org-forward-paragraph))))
24588 ;; When contents start on the middle of a line (e.g. in
24589 ;; items and footnote definitions), try to reach first
24590 ;; element starting after current line.
24591 ((> (line-end-position) contents-begin)
24592 (end-of-line)
24593 (org-forward-paragraph))
24594 (t (goto-char contents-begin)))))
24596 (defun org-backward-paragraph ()
24597 "Move backward to start of previous paragraph or equivalent.
24599 The function moves point to the beginning of the current
24600 structural element, which can be a paragraph, a table, a list
24601 item, etc., or to the beginning of the previous visible one if
24602 point is already there. It also provides some special moves for
24603 convenience:
24605 - On an affiliated keyword, jump to the first one.
24606 - On a table or a property drawer, move to its beginning.
24607 - On a verse or source block, stop before blank lines."
24608 (interactive)
24609 (when (bobp) (user-error "Cannot move further up"))
24610 (let* ((deactivate-mark nil)
24611 (element (org-element-at-point))
24612 (type (org-element-type element))
24613 (contents-begin (org-element-property :contents-begin element))
24614 (contents-end (org-element-property :contents-end element))
24615 (post-affiliated (org-element-property :post-affiliated element))
24616 (begin (org-element-property :begin element)))
24617 (cond
24618 ((not element) (goto-char (point-min)))
24619 ((= (point) begin)
24620 (backward-char)
24621 (org-backward-paragraph))
24622 ((<= (point) post-affiliated) (goto-char begin))
24623 ((memq type '(node-property table-row))
24624 (goto-char (org-element-property
24625 :post-affiliated (org-element-property :parent element))))
24626 ((memq type '(property-drawer table)) (goto-char begin))
24627 ((memq type '(src-block verse-block))
24628 (when (eq type 'src-block)
24629 (setq contents-begin
24630 (save-excursion (goto-char begin) (forward-line) (point))))
24631 (if (= (point) contents-begin) (goto-char post-affiliated)
24632 ;; Inside a verse block, see blank lines as paragraph
24633 ;; separators.
24634 (let ((origin (point)))
24635 (skip-chars-backward " \r\t\n" contents-begin)
24636 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24637 (skip-chars-forward " \r\t\n" origin)
24638 (if (= (point) origin) (goto-char contents-begin)
24639 (beginning-of-line))))))
24640 ((not contents-begin) (goto-char (or post-affiliated begin)))
24641 ((eq type 'paragraph)
24642 (goto-char contents-begin)
24643 ;; When at first paragraph in an item or a footnote definition,
24644 ;; move directly to beginning of line.
24645 (let ((parent-contents
24646 (org-element-property
24647 :contents-begin (org-element-property :parent element))))
24648 (when (and parent-contents (= parent-contents contents-begin))
24649 (beginning-of-line))))
24650 ;; At the end of a greater element, move to the beginning of the
24651 ;; last element within.
24652 ((>= (point) contents-end)
24653 (goto-char (1- contents-end))
24654 (org-backward-paragraph))
24655 (t (goto-char (or post-affiliated begin))))
24656 ;; Ensure we never leave point invisible.
24657 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24659 (defun org-forward-element ()
24660 "Move forward by one element.
24661 Move to the next element at the same level, when possible."
24662 (interactive)
24663 (cond ((eobp) (user-error "Cannot move further down"))
24664 ((org-with-limited-levels (org-at-heading-p))
24665 (let ((origin (point)))
24666 (goto-char (org-end-of-subtree nil t))
24667 (unless (org-with-limited-levels (org-at-heading-p))
24668 (goto-char origin)
24669 (user-error "Cannot move further down"))))
24671 (let* ((elem (org-element-at-point))
24672 (end (org-element-property :end elem))
24673 (parent (org-element-property :parent elem)))
24674 (cond ((and parent (= (org-element-property :contents-end parent) end))
24675 (goto-char (org-element-property :end parent)))
24676 ((integer-or-marker-p end) (goto-char end))
24677 (t (message "No element at point")))))))
24679 (defun org-backward-element ()
24680 "Move backward by one element.
24681 Move to the previous element at the same level, when possible."
24682 (interactive)
24683 (cond ((bobp) (user-error "Cannot move further up"))
24684 ((org-with-limited-levels (org-at-heading-p))
24685 ;; At a headline, move to the previous one, if any, or stay
24686 ;; here.
24687 (let ((origin (point)))
24688 (org-with-limited-levels (org-backward-heading-same-level 1))
24689 ;; When current headline has no sibling above, move to its
24690 ;; parent.
24691 (when (= (point) origin)
24692 (or (org-with-limited-levels (org-up-heading-safe))
24693 (progn (goto-char origin)
24694 (user-error "Cannot move further up"))))))
24696 (let* ((elem (org-element-at-point))
24697 (beg (org-element-property :begin elem)))
24698 (cond
24699 ;; Move to beginning of current element if point isn't
24700 ;; there already.
24701 ((null beg) (message "No element at point"))
24702 ((/= (point) beg) (goto-char beg))
24703 (t (goto-char beg)
24704 (skip-chars-backward " \r\t\n")
24705 (unless (bobp)
24706 (let ((prev (org-element-at-point)))
24707 (goto-char (org-element-property :begin prev))
24708 (while (and (setq prev (org-element-property :parent prev))
24709 (<= (org-element-property :end prev) beg))
24710 (goto-char (org-element-property :begin prev)))))))))))
24712 (defun org-up-element ()
24713 "Move to upper element."
24714 (interactive)
24715 (if (org-with-limited-levels (org-at-heading-p))
24716 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24717 (let* ((elem (org-element-at-point))
24718 (parent (org-element-property :parent elem)))
24719 (if parent (goto-char (org-element-property :begin parent))
24720 (if (org-with-limited-levels (org-before-first-heading-p))
24721 (user-error "No surrounding element")
24722 (org-with-limited-levels (org-back-to-heading)))))))
24724 (defvar org-element-greater-elements)
24725 (defun org-down-element ()
24726 "Move to inner element."
24727 (interactive)
24728 (let ((element (org-element-at-point)))
24729 (cond
24730 ((memq (org-element-type element) '(plain-list table))
24731 (goto-char (org-element-property :contents-begin element))
24732 (forward-char))
24733 ((memq (org-element-type element) org-element-greater-elements)
24734 ;; If contents are hidden, first disclose them.
24735 (when (outline-invisible-p (line-end-position)) (org-cycle))
24736 (goto-char (or (org-element-property :contents-begin element)
24737 (user-error "No content for this element"))))
24738 (t (user-error "No inner element")))))
24740 (defun org-drag-element-backward ()
24741 "Move backward element at point."
24742 (interactive)
24743 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24744 (let* ((elem (org-element-at-point))
24745 (prev-elem
24746 (save-excursion
24747 (goto-char (org-element-property :begin elem))
24748 (skip-chars-backward " \r\t\n")
24749 (unless (bobp)
24750 (let* ((beg (org-element-property :begin elem))
24751 (prev (org-element-at-point))
24752 (up prev))
24753 (while (and (setq up (org-element-property :parent up))
24754 (<= (org-element-property :end up) beg))
24755 (setq prev up))
24756 prev)))))
24757 ;; Error out if no previous element or previous element is
24758 ;; a parent of the current one.
24759 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24760 (user-error "Cannot drag element backward")
24761 (let ((pos (point)))
24762 (org-element-swap-A-B prev-elem elem)
24763 (goto-char (+ (org-element-property :begin prev-elem)
24764 (- pos (org-element-property :begin elem)))))))))
24766 (defun org-drag-element-forward ()
24767 "Move forward element at point."
24768 (interactive)
24769 (let* ((pos (point))
24770 (elem (org-element-at-point)))
24771 (when (= (point-max) (org-element-property :end elem))
24772 (user-error "Cannot drag element forward"))
24773 (goto-char (org-element-property :end elem))
24774 (let ((next-elem (org-element-at-point)))
24775 (when (or (org-element-nested-p elem next-elem)
24776 (and (eq (org-element-type next-elem) 'headline)
24777 (not (eq (org-element-type elem) 'headline))))
24778 (goto-char pos)
24779 (user-error "Cannot drag element forward"))
24780 ;; Compute new position of point: it's shifted by NEXT-ELEM
24781 ;; body's length (without final blanks) and by the length of
24782 ;; blanks between ELEM and NEXT-ELEM.
24783 (let ((size-next (- (save-excursion
24784 (goto-char (org-element-property :end next-elem))
24785 (skip-chars-backward " \r\t\n")
24786 (forward-line)
24787 ;; Small correction if buffer doesn't end
24788 ;; with a newline character.
24789 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24790 (org-element-property :begin next-elem)))
24791 (size-blank (- (org-element-property :end elem)
24792 (save-excursion
24793 (goto-char (org-element-property :end elem))
24794 (skip-chars-backward " \r\t\n")
24795 (forward-line)
24796 (point)))))
24797 (org-element-swap-A-B elem next-elem)
24798 (goto-char (+ pos size-next size-blank))))))
24800 (defun org-drag-line-forward (arg)
24801 "Drag the line at point ARG lines forward."
24802 (interactive "p")
24803 (dotimes (n (abs arg))
24804 (let ((c (current-column)))
24805 (if (< 0 arg)
24806 (progn
24807 (beginning-of-line 2)
24808 (transpose-lines 1)
24809 (beginning-of-line 0))
24810 (transpose-lines 1)
24811 (beginning-of-line -1))
24812 (org-move-to-column c))))
24814 (defun org-drag-line-backward (arg)
24815 "Drag the line at point ARG lines backward."
24816 (interactive "p")
24817 (org-drag-line-forward (- arg)))
24819 (defun org-mark-element ()
24820 "Put point at beginning of this element, mark at end.
24822 Interactively, if this command is repeated or (in Transient Mark
24823 mode) if the mark is active, it marks the next element after the
24824 ones already marked."
24825 (interactive)
24826 (let (deactivate-mark)
24827 (if (and (org-called-interactively-p 'any)
24828 (or (and (eq last-command this-command) (mark t))
24829 (and transient-mark-mode mark-active)))
24830 (set-mark
24831 (save-excursion
24832 (goto-char (mark))
24833 (goto-char (org-element-property :end (org-element-at-point)))))
24834 (let ((element (org-element-at-point)))
24835 (end-of-line)
24836 (push-mark (org-element-property :end element) t t)
24837 (goto-char (org-element-property :begin element))))))
24839 (defun org-narrow-to-element ()
24840 "Narrow buffer to current element."
24841 (interactive)
24842 (let ((elem (org-element-at-point)))
24843 (cond
24844 ((eq (car elem) 'headline)
24845 (narrow-to-region
24846 (org-element-property :begin elem)
24847 (org-element-property :end elem)))
24848 ((memq (car elem) org-element-greater-elements)
24849 (narrow-to-region
24850 (org-element-property :contents-begin elem)
24851 (org-element-property :contents-end elem)))
24853 (narrow-to-region
24854 (org-element-property :begin elem)
24855 (org-element-property :end elem))))))
24857 (defun org-transpose-element ()
24858 "Transpose current and previous elements, keeping blank lines between.
24859 Point is moved after both elements."
24860 (interactive)
24861 (org-skip-whitespace)
24862 (let ((end (org-element-property :end (org-element-at-point))))
24863 (org-drag-element-backward)
24864 (goto-char end)))
24866 (defun org-unindent-buffer ()
24867 "Un-indent the visible part of the buffer.
24868 Relative indentation (between items, inside blocks, etc.) isn't
24869 modified."
24870 (interactive)
24871 (unless (eq major-mode 'org-mode)
24872 (user-error "Cannot un-indent a buffer not in Org mode"))
24873 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24874 unindent-tree ; For byte-compiler.
24875 (unindent-tree
24876 (function
24877 (lambda (contents)
24878 (mapc
24879 (lambda (element)
24880 (if (memq (org-element-type element) '(headline section))
24881 (funcall unindent-tree (org-element-contents element))
24882 (save-excursion
24883 (save-restriction
24884 (narrow-to-region
24885 (org-element-property :begin element)
24886 (org-element-property :end element))
24887 (org-do-remove-indentation)))))
24888 (reverse contents))))))
24889 (funcall unindent-tree (org-element-contents parse-tree))))
24891 (defun org-show-children (&optional level)
24892 "Show all direct subheadings of this heading.
24893 Prefix arg LEVEL is how many levels below the current level should be shown.
24894 Default is enough to cause the following heading to appear."
24895 (save-excursion
24896 (org-back-to-heading t)
24897 (let* ((current-level (funcall outline-level))
24898 (max-level (org-get-valid-level
24899 current-level (if level (prefix-numeric-value level) 1)))
24900 (end (save-excursion (org-end-of-subtree t t)))
24901 (regexp-fmt "^\\*\\{%d,%s\\}\\(?: \\|$\\)")
24902 (past-first-child nil)
24903 ;; Make sure to skip inlinetasks.
24904 (re (format regexp-fmt
24905 current-level
24906 (cond
24907 ((not (featurep 'org-inlinetask)) "")
24908 (org-odd-levels-only (- (* 2 org-inlinetask-min-level)
24910 (t (1- org-inlinetask-min-level))))))
24911 ;; Display parent heading.
24912 (outline-flag-region (line-end-position 0) (line-end-position) nil)
24913 (forward-line)
24914 ;; Display children. First child may be deeper than expected
24915 ;; MAX-LEVEL. Since we want to display it anyway, adjust
24916 ;; MAX-LEVEL accordingly.
24917 (while (re-search-forward re end t)
24918 (unless past-first-child
24919 (setq re (format regexp-fmt
24920 current-level
24921 (max (funcall outline-level) max-level)))
24922 (setq past-first-child t))
24923 (outline-flag-region (line-end-position 0) (line-end-position) nil)))))
24925 (defun org-show-subtree ()
24926 "Show everything after this heading at deeper levels."
24927 (interactive)
24928 (outline-flag-region
24929 (point)
24930 (save-excursion
24931 (org-end-of-subtree t t))
24932 nil))
24934 (defun org-show-entry ()
24935 "Show the body directly following this heading.
24936 Show the heading too, if it is currently invisible."
24937 (interactive)
24938 (save-excursion
24939 (ignore-errors
24940 (org-back-to-heading t)
24941 (outline-flag-region
24942 (max (point-min) (1- (point)))
24943 (save-excursion
24944 (if (re-search-forward
24945 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24946 (match-beginning 1)
24947 (point-max)))
24948 nil)
24949 (org-cycle-hide-drawers 'children))))
24951 (defun org-make-options-regexp (kwds &optional extra)
24952 "Make a regular expression for keyword lines.
24953 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24954 when non-nil, is a regexp matching keywords names."
24955 (concat "^[ \t]*#\\+\\("
24956 (regexp-opt kwds)
24957 (and extra (concat (and kwds "\\|") extra))
24958 "\\):[ \t]*\\(.*\\)"))
24960 ;; Make isearch reveal the necessary context
24961 (defun org-isearch-end ()
24962 "Reveal context after isearch exits."
24963 (when isearch-success ; only if search was successful
24964 (if (featurep 'xemacs)
24965 ;; Under XEmacs, the hook is run in the correct place,
24966 ;; we directly show the context.
24967 (org-show-context 'isearch)
24968 ;; In Emacs the hook runs *before* restoring the overlays.
24969 ;; So we have to use a one-time post-command-hook to do this.
24970 ;; (Emacs 22 has a special variable, see function `org-mode')
24971 (unless (and (boundp 'isearch-mode-end-hook-quit)
24972 isearch-mode-end-hook-quit)
24973 ;; Only when the isearch was not quitted.
24974 (org-add-hook 'post-command-hook 'org-isearch-post-command
24975 'append 'local)))))
24977 (defun org-isearch-post-command ()
24978 "Remove self from hook, and show context."
24979 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24980 (org-show-context 'isearch))
24983 ;;;; Integration with and fixes for other packages
24985 ;;; Imenu support
24987 (defvar org-imenu-markers nil
24988 "All markers currently used by Imenu.")
24989 (make-variable-buffer-local 'org-imenu-markers)
24991 (defun org-imenu-new-marker (&optional pos)
24992 "Return a new marker for use by Imenu, and remember the marker."
24993 (let ((m (make-marker)))
24994 (move-marker m (or pos (point)))
24995 (push m org-imenu-markers)
24998 (defun org-imenu-get-tree ()
24999 "Produce the index for Imenu."
25000 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
25001 (setq org-imenu-markers nil)
25002 (let* ((n org-imenu-depth)
25003 (re (concat "^" (org-get-limited-outline-regexp)))
25004 (subs (make-vector (1+ n) nil))
25005 (last-level 0)
25006 m level head0 head)
25007 (save-excursion
25008 (save-restriction
25009 (widen)
25010 (goto-char (point-max))
25011 (while (re-search-backward re nil t)
25012 (setq level (org-reduced-level (funcall outline-level)))
25013 (when (and (<= level n)
25014 (looking-at org-complex-heading-regexp)
25015 (setq head0 (org-match-string-no-properties 4)))
25016 (setq head (org-link-display-format head0)
25017 m (org-imenu-new-marker))
25018 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
25019 (if (>= level last-level)
25020 (push (cons head m) (aref subs level))
25021 (push (cons head (aref subs (1+ level))) (aref subs level))
25022 (loop for i from (1+ level) to n do (aset subs i nil)))
25023 (setq last-level level)))))
25024 (aref subs 1)))
25026 (eval-after-load "imenu"
25027 '(progn
25028 (add-hook 'imenu-after-jump-hook
25029 (lambda ()
25030 (if (derived-mode-p 'org-mode)
25031 (org-show-context 'org-goto))))))
25033 (defun org-link-display-format (link)
25034 "Replace a link with its the description.
25035 If there is no description, use the link target."
25036 (save-match-data
25037 (if (string-match org-bracket-link-analytic-regexp link)
25038 (replace-match (if (match-end 5)
25039 (match-string 5 link)
25040 (concat (match-string 1 link)
25041 (match-string 3 link)))
25042 nil t link)
25043 link)))
25045 (defun org-toggle-link-display ()
25046 "Toggle the literal or descriptive display of links."
25047 (interactive)
25048 (if org-descriptive-links
25049 (progn (org-remove-from-invisibility-spec '(org-link))
25050 (org-restart-font-lock)
25051 (setq org-descriptive-links nil))
25052 (progn (add-to-invisibility-spec '(org-link))
25053 (org-restart-font-lock)
25054 (setq org-descriptive-links t))))
25056 ;; Speedbar support
25058 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
25059 "Overlay marking the agenda restriction line in speedbar.")
25060 (overlay-put org-speedbar-restriction-lock-overlay
25061 'face 'org-agenda-restriction-lock)
25062 (overlay-put org-speedbar-restriction-lock-overlay
25063 'help-echo "Agendas are currently limited to this item.")
25064 (org-detach-overlay org-speedbar-restriction-lock-overlay)
25066 (defun org-speedbar-set-agenda-restriction ()
25067 "Restrict future agenda commands to the location at point in speedbar.
25068 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
25069 (interactive)
25070 (require 'org-agenda)
25071 (let (p m tp np dir txt)
25072 (cond
25073 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25074 'org-imenu t))
25075 (setq m (get-text-property p 'org-imenu-marker))
25076 (with-current-buffer (marker-buffer m)
25077 (goto-char m)
25078 (org-agenda-set-restriction-lock 'subtree)))
25079 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25080 'speedbar-function 'speedbar-find-file))
25081 (setq tp (previous-single-property-change
25082 (1+ p) 'speedbar-function)
25083 np (next-single-property-change
25084 tp 'speedbar-function)
25085 dir (speedbar-line-directory)
25086 txt (buffer-substring-no-properties (or tp (point-min))
25087 (or np (point-max))))
25088 (with-current-buffer (find-file-noselect
25089 (let ((default-directory dir))
25090 (expand-file-name txt)))
25091 (unless (derived-mode-p 'org-mode)
25092 (user-error "Cannot restrict to non-Org-mode file"))
25093 (org-agenda-set-restriction-lock 'file)))
25094 (t (user-error "Don't know how to restrict Org-mode's agenda")))
25095 (move-overlay org-speedbar-restriction-lock-overlay
25096 (point-at-bol) (point-at-eol))
25097 (setq current-prefix-arg nil)
25098 (org-agenda-maybe-redo)))
25100 (defvar speedbar-file-key-map)
25101 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25102 (eval-after-load "speedbar"
25103 '(progn
25104 (speedbar-add-supported-extension ".org")
25105 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25106 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25107 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25108 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25109 (add-hook 'speedbar-visiting-tag-hook
25110 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25112 ;;; Fixes and Hacks for problems with other packages
25114 (defun org--flyspell-object-check-p (element)
25115 "Non-nil when Flyspell can check object at point.
25116 ELEMENT is the element at point."
25117 (let ((object (save-excursion
25118 (when (org-looking-at-p "\\>") (backward-char))
25119 (org-element-context element))))
25120 (case (org-element-type object)
25121 ;; Prevent checks in links due to keybinding conflict with
25122 ;; Flyspell.
25123 ((code entity export-snippet inline-babel-call
25124 inline-src-block line-break latex-fragment link macro
25125 statistics-cookie target timestamp verbatim)
25126 nil)
25127 (footnote-reference
25128 ;; Only in inline footnotes, within the definition.
25129 (and (eq (org-element-property :type object) 'inline)
25130 (< (save-excursion
25131 (goto-char (org-element-property :begin object))
25132 (search-forward ":" nil t 2))
25133 (point))))
25134 (otherwise t))))
25136 (defun org-mode-flyspell-verify ()
25137 "Function used for `flyspell-generic-check-word-predicate'."
25138 (if (org-at-heading-p)
25139 ;; At a headline or an inlinetask, check title only. This is
25140 ;; faster than relying on `org-element-at-point'.
25141 (and (save-excursion (beginning-of-line)
25142 (and (let ((case-fold-search t))
25143 (not (looking-at "\\*+ END[ \t]*$")))
25144 (looking-at org-complex-heading-regexp)))
25145 (match-beginning 4)
25146 (>= (point) (match-beginning 4))
25147 (or (not (match-beginning 5))
25148 (< (point) (match-beginning 5))))
25149 (let* ((element (org-element-at-point))
25150 (post-affiliated (org-element-property :post-affiliated element)))
25151 (cond
25152 ;; Ignore checks in all affiliated keywords but captions.
25153 ((< (point) post-affiliated)
25154 (and (save-excursion
25155 (beginning-of-line)
25156 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25157 (> (point) (match-end 0))
25158 (org--flyspell-object-check-p element)))
25159 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25160 ((let ((log (org-log-into-drawer)))
25161 (and log
25162 (let ((drawer (org-element-lineage element '(drawer))))
25163 (and drawer
25164 (eq (compare-strings
25165 log nil nil
25166 (org-element-property :drawer-name drawer) nil nil t)
25167 t)))))
25168 nil)
25170 (case (org-element-type element)
25171 ((comment quote-section) t)
25172 (comment-block
25173 ;; Allow checks between block markers, not on them.
25174 (and (> (line-beginning-position) post-affiliated)
25175 (save-excursion
25176 (end-of-line)
25177 (skip-chars-forward " \r\t\n")
25178 (< (point) (org-element-property :end element)))))
25179 ;; Arbitrary list of keywords where checks are meaningful.
25180 ;; Make sure point is on the value part of the element.
25181 (keyword
25182 (and (member (org-element-property :key element)
25183 '("DESCRIPTION" "TITLE"))
25184 (save-excursion
25185 (search-backward ":" (line-beginning-position) t))))
25186 ;; Check is globally allowed in paragraphs verse blocks and
25187 ;; table rows (after affiliated keywords) but some objects
25188 ;; must not be affected.
25189 ((paragraph table-row verse-block)
25190 (let ((cbeg (org-element-property :contents-begin element))
25191 (cend (org-element-property :contents-end element)))
25192 (and cbeg (>= (point) cbeg) (< (point) cend)
25193 (org--flyspell-object-check-p element))))))))))
25194 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25196 (defun org-remove-flyspell-overlays-in (beg end)
25197 "Remove flyspell overlays in region."
25198 (and (org-bound-and-true-p flyspell-mode)
25199 (fboundp 'flyspell-delete-region-overlays)
25200 (flyspell-delete-region-overlays beg end)))
25202 (defvar flyspell-delayed-commands)
25203 (eval-after-load "flyspell"
25204 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25206 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25207 (eval-after-load "bookmark"
25208 '(if (boundp 'bookmark-after-jump-hook)
25209 ;; We can use the hook
25210 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25211 ;; Hook not available, use advice
25212 (defadvice bookmark-jump (after org-make-visible activate)
25213 "Make the position visible."
25214 (org-bookmark-jump-unhide))))
25216 ;; Make sure saveplace shows the location if it was hidden
25217 (eval-after-load "saveplace"
25218 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25219 "Make the position visible."
25220 (org-bookmark-jump-unhide)))
25222 ;; Make sure ecb shows the location if it was hidden
25223 (eval-after-load "ecb"
25224 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25225 "Make hierarchy visible when jumping into location from ECB tree buffer."
25226 (if (derived-mode-p 'org-mode)
25227 (org-show-context))))
25229 (defun org-bookmark-jump-unhide ()
25230 "Unhide the current position, to show the bookmark location."
25231 (and (derived-mode-p 'org-mode)
25232 (or (outline-invisible-p)
25233 (save-excursion (goto-char (max (point-min) (1- (point))))
25234 (outline-invisible-p)))
25235 (org-show-context 'bookmark-jump)))
25237 (defun org-mark-jump-unhide ()
25238 "Make the point visible with `org-show-context' after jumping to the mark."
25239 (when (and (derived-mode-p 'org-mode)
25240 (outline-invisible-p))
25241 (org-show-context 'mark-goto)))
25243 (eval-after-load "simple"
25244 '(defadvice pop-to-mark-command (after org-make-visible activate)
25245 "Make the point visible with `org-show-context'."
25246 (org-mark-jump-unhide)))
25248 (eval-after-load "simple"
25249 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25250 "Make the point visible with `org-show-context'."
25251 (org-mark-jump-unhide)))
25253 (eval-after-load "simple"
25254 '(defadvice pop-global-mark (after org-make-visible activate)
25255 "Make the point visible with `org-show-context'."
25256 (org-mark-jump-unhide)))
25258 ;; Make session.el ignore our circular variable
25259 (defvar session-globals-exclude)
25260 (eval-after-load "session"
25261 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25263 ;;;; Finish up
25265 (provide 'org)
25267 (run-hooks 'org-load-hook)
25269 ;;; org.el ends here