Call `org-insert-heading' instead of (insert "* ")
[org-mode/org-kjn.git] / lisp / org.el
blobd7d9c6155b7c325c14416ee96a414a51e31e0e6f
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 (declare-function cdlatex-environment "ext:cdlatex" (environment item))
96 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
97 ;; some places -- e.g. see the macro `org-with-limited-levels'.
99 ;; In Org buffers, the value of `outline-regexp' is that of
100 ;; `org-outline-regexp'. The only function still directly relying on
101 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
102 ;; job when `orgstruct-mode' is active.
103 (defvar org-outline-regexp "\\*+ "
104 "Regexp to match Org headlines.")
106 (defvar org-outline-regexp-bol "^\\*+ "
107 "Regexp to match Org headlines.
108 This is similar to `org-outline-regexp' but additionally makes
109 sure that we are at the beginning of the line.")
111 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
112 "Matches a headline, putting stars and text into groups.
113 Stars are put in group 1 and the trimmed body in group 2.")
115 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
116 (unless (boundp 'calendar-view-holidays-initially-flag)
117 (org-defvaralias 'calendar-view-holidays-initially-flag
118 'view-calendar-holidays-initially))
119 (unless (boundp 'calendar-view-diary-initially-flag)
120 (org-defvaralias 'calendar-view-diary-initially-flag
121 'view-diary-entries-initially))
122 (unless (boundp 'diary-fancy-buffer)
123 (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
125 (declare-function org-add-archive-files "org-archive" (files))
127 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
128 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
129 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
130 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
131 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
132 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
133 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
134 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
135 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
136 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
137 (declare-function org-clock-update-time-maybe "org-clock" ())
138 (declare-function org-clocktable-shift "org-clock" (dir n))
140 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
141 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body))
142 (declare-function orgtbl-mode "org-table" (&optional arg))
143 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
144 (declare-function org-beamer-mode "ox-beamer" ())
145 (declare-function org-table-blank-field "org-table" ())
146 (declare-function org-table-edit-field "org-table" (arg))
147 (declare-function org-table-insert-row "org-table" (&optional arg))
148 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
149 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
150 (declare-function org-id-get-create "org-id" (&optional force))
151 (declare-function org-add-archive-files "org-archive" (files))
152 (declare-function org-id-find-id-file "org-id" (id))
153 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
154 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
155 (declare-function org-agenda-redo "org-agenda" (&optional all))
156 (declare-function org-table-align "org-table" ())
157 (declare-function org-table-begin "org-table" (&optional table-type))
158 (declare-function org-table-blank-field "org-table" ())
159 (declare-function org-table-end "org-table" (&optional table-type))
160 (declare-function org-table-end-of-field "org-table" (&optional n))
161 (declare-function org-table-insert-row "org-table" (&optional arg))
162 (declare-function org-table-paste-rectangle "org-table" ())
163 (declare-function org-table-maybe-eval-formula "org-table" ())
164 (declare-function org-table-maybe-recalculate-line "org-table" ())
165 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
166 (declare-function org-plot/gnuplot "org-plot" (&optional params))
168 (declare-function org-element-at-point "org-element" ())
169 (declare-function org-element-cache-reset "org-element" (&optional all))
170 (declare-function org-element-cache-refresh "org-element" (pos))
171 (declare-function org-element-contents "org-element" (element))
172 (declare-function org-element-context "org-element" (&optional element))
173 (declare-function org-element-interpret-data "org-element"
174 (data &optional parent))
175 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
176 (declare-function org-element-parse-buffer "org-element"
177 (&optional granularity visible-only))
178 (declare-function org-element-property "org-element" (property element))
179 (declare-function org-element-put-property "org-element"
180 (element property value))
181 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
182 (declare-function org-element-parse-buffer "org-element"
183 (&optional granularity visible-only))
184 (declare-function org-element-type "org-element" (element))
186 (defsubst org-uniquify (list)
187 "Non-destructively remove duplicate elements from LIST."
188 (let ((res (copy-sequence list))) (delete-dups res)))
190 (defsubst org-get-at-bol (property)
191 "Get text property PROPERTY at the beginning of line."
192 (get-text-property (point-at-bol) property))
194 (defsubst org-trim (s)
195 "Remove whitespace at the beginning and the end of string S."
196 (replace-regexp-in-string
197 "\\`[ \t\n\r]+" ""
198 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
200 ;; load languages based on value of `org-babel-load-languages'
201 (defvar org-babel-load-languages)
203 ;;;###autoload
204 (defun org-babel-do-load-languages (sym value)
205 "Load the languages defined in `org-babel-load-languages'."
206 (set-default sym value)
207 (mapc (lambda (pair)
208 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
209 (if active
210 (progn
211 (require (intern (concat "ob-" lang))))
212 (progn
213 (funcall 'fmakunbound
214 (intern (concat "org-babel-execute:" lang)))
215 (funcall 'fmakunbound
216 (intern (concat "org-babel-expand-body:" lang)))))))
217 org-babel-load-languages))
219 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
220 ;;;###autoload
221 (defun org-babel-load-file (file &optional compile)
222 "Load Emacs Lisp source code blocks in the Org-mode FILE.
223 This function exports the source code using `org-babel-tangle'
224 and then loads the resulting file using `load-file'. With prefix
225 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
226 file to byte-code before it is loaded."
227 (interactive "fFile to load: \nP")
228 (let* ((age (lambda (file)
229 (float-time
230 (time-subtract (current-time)
231 (nth 5 (or (file-attributes (file-truename file))
232 (file-attributes file)))))))
233 (base-name (file-name-sans-extension file))
234 (exported-file (concat base-name ".el")))
235 ;; tangle if the org-mode file is newer than the elisp file
236 (unless (and (file-exists-p exported-file)
237 (> (funcall age file) (funcall age exported-file)))
238 ;; Tangle-file traversal returns reversed list of tangled files
239 ;; and we want to evaluate the first target.
240 (setq exported-file
241 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
242 (message "%s %s"
243 (if compile
244 (progn (byte-compile-file exported-file 'load)
245 "Compiled and loaded")
246 (progn (load-file exported-file) "Loaded"))
247 exported-file)))
249 (defcustom org-babel-load-languages '((emacs-lisp . t))
250 "Languages which can be evaluated in Org-mode buffers.
251 This list can be used to load support for any of the languages
252 below, note that each language will depend on a different set of
253 system executables and/or Emacs modes. When a language is
254 \"loaded\", then code blocks in that language can be evaluated
255 with `org-babel-execute-src-block' bound by default to C-c
256 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
257 be set to remove code block evaluation from the C-c C-c
258 keybinding. By default only Emacs Lisp (which has no
259 requirements) is loaded."
260 :group 'org-babel
261 :set 'org-babel-do-load-languages
262 :version "24.1"
263 :type '(alist :tag "Babel Languages"
264 :key-type
265 (choice
266 (const :tag "Awk" awk)
267 (const :tag "C" C)
268 (const :tag "R" R)
269 (const :tag "Asymptote" asymptote)
270 (const :tag "Calc" calc)
271 (const :tag "Clojure" clojure)
272 (const :tag "CSS" css)
273 (const :tag "Ditaa" ditaa)
274 (const :tag "Dot" dot)
275 (const :tag "Emacs Lisp" emacs-lisp)
276 (const :tag "Forth" forth)
277 (const :tag "Fortran" fortran)
278 (const :tag "Gnuplot" gnuplot)
279 (const :tag "Haskell" haskell)
280 (const :tag "IO" io)
281 (const :tag "J" J)
282 (const :tag "Java" java)
283 (const :tag "Javascript" js)
284 (const :tag "LaTeX" latex)
285 (const :tag "Ledger" ledger)
286 (const :tag "Lilypond" lilypond)
287 (const :tag "Lisp" lisp)
288 (const :tag "Makefile" makefile)
289 (const :tag "Maxima" maxima)
290 (const :tag "Matlab" matlab)
291 (const :tag "Mscgen" mscgen)
292 (const :tag "Ocaml" ocaml)
293 (const :tag "Octave" octave)
294 (const :tag "Org" org)
295 (const :tag "Perl" perl)
296 (const :tag "Pico Lisp" picolisp)
297 (const :tag "PlantUML" plantuml)
298 (const :tag "Python" python)
299 (const :tag "Ruby" ruby)
300 (const :tag "Sass" sass)
301 (const :tag "Scala" scala)
302 (const :tag "Scheme" scheme)
303 (const :tag "Screen" screen)
304 (const :tag "Shell Script" shell)
305 (const :tag "Shen" shen)
306 (const :tag "Sql" sql)
307 (const :tag "Sqlite" sqlite)
308 (const :tag "ebnf2ps" ebnf2ps))
309 :value-type (boolean :tag "Activate" :value t)))
311 ;;;; Customization variables
312 (defcustom org-clone-delete-id nil
313 "Remove ID property of clones of a subtree.
314 When non-nil, clones of a subtree don't inherit the ID property.
315 Otherwise they inherit the ID property with a new unique
316 identifier."
317 :type 'boolean
318 :version "24.1"
319 :group 'org-id)
321 ;;; Version
322 (org-check-version)
324 ;;;###autoload
325 (defun org-version (&optional here full message)
326 "Show the org-mode version.
327 Interactively, or when MESSAGE is non-nil, show it in echo area.
328 With prefix argument, or when HERE is non-nil, insert it at point.
329 In non-interactive uses, a reduced version string is output unless
330 FULL is given."
331 (interactive (list current-prefix-arg t (not current-prefix-arg)))
332 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
333 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
334 (load-suffixes (list ".el"))
335 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
336 (org-trash (or
337 (and (fboundp 'org-release) (fboundp 'org-git-version))
338 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
339 (load-suffixes save-load-suffixes)
340 (org-version (org-release))
341 (git-version (org-git-version))
342 (version (format "Org-mode version %s (%s @ %s)"
343 org-version
344 git-version
345 (if org-install-dir
346 (if (string= org-dir org-install-dir)
347 org-install-dir
348 (concat "mixed installation! " org-install-dir " and " org-dir))
349 "org-loaddefs.el can not be found!")))
350 (version1 (if full version org-version)))
351 (when here (insert version1))
352 (when message (message "%s" version1))
353 version1))
355 (defconst org-version (org-version))
358 ;;; Syntax Constants
360 ;;;; Block
362 (defconst org-block-regexp
363 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
364 "Regular expression for hiding blocks.")
366 (defconst org-dblock-start-re
367 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
368 "Matches the start line of a dynamic block, with parameters.")
370 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
371 "Matches the end of a dynamic block.")
373 ;;;; Clock and Planning
375 (defconst org-clock-string "CLOCK:"
376 "String used as prefix for timestamps clocking work hours on an item.")
378 (defconst org-closed-string "CLOSED:"
379 "String used as the prefix for timestamps logging closing a TODO entry.")
381 (defconst org-deadline-string "DEADLINE:"
382 "String to mark deadline entries.
383 A deadline is this string, followed by a time stamp. Should be a word,
384 terminated by a colon. You can insert a schedule keyword and
385 a timestamp with \\[org-deadline].")
387 (defconst org-scheduled-string "SCHEDULED:"
388 "String to mark scheduled TODO entries.
389 A schedule is this string, followed by a time stamp. Should be a word,
390 terminated by a colon. You can insert a schedule keyword and
391 a timestamp with \\[org-schedule].")
393 (defconst org-ds-keyword-length
394 (+ 2
395 (apply #'max
396 (mapcar #'length
397 (list org-deadline-string org-scheduled-string
398 org-clock-string org-closed-string))))
399 "Maximum length of the DEADLINE and SCHEDULED keywords.")
401 (defconst org-planning-line-re
402 (concat "^[ \t]*"
403 (regexp-opt
404 (list org-closed-string org-deadline-string org-scheduled-string)
406 "Matches a line with planning info.
407 Matched keyword is in group 1.")
409 (defconst org-clock-line-re
410 (concat "^[ \t]*" org-clock-string)
411 "Matches a line with clock info.")
413 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
414 "Matches the DEADLINE keyword.")
416 (defconst org-deadline-time-regexp
417 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
418 "Matches the DEADLINE keyword together with a time stamp.")
420 (defconst org-deadline-time-hour-regexp
421 (concat "\\<" org-deadline-string
422 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
423 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
425 (defconst org-deadline-line-regexp
426 (concat "\\<\\(" org-deadline-string "\\).*")
427 "Matches the DEADLINE keyword and the rest of the line.")
429 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
430 "Matches the SCHEDULED keyword.")
432 (defconst org-scheduled-time-regexp
433 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
434 "Matches the SCHEDULED keyword together with a time stamp.")
436 (defconst org-scheduled-time-hour-regexp
437 (concat "\\<" org-scheduled-string
438 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
439 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
441 (defconst org-closed-time-regexp
442 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
443 "Matches the CLOSED keyword together with a time stamp.")
445 (defconst org-keyword-time-regexp
446 (concat "\\<"
447 (regexp-opt
448 (list org-scheduled-string org-deadline-string org-closed-string
449 org-clock-string)
451 " *[[<]\\([^]>]+\\)[]>]")
452 "Matches any of the 4 keywords, together with the time stamp.")
454 (defconst org-keyword-time-not-clock-regexp
455 (concat
456 "\\<"
457 (regexp-opt
458 (list org-scheduled-string org-deadline-string org-closed-string) t)
459 " *[[<]\\([^]>]+\\)[]>]")
460 "Matches any of the 3 keywords, together with the time stamp.")
462 (defconst org-maybe-keyword-time-regexp
463 (concat "\\(\\<"
464 (regexp-opt
465 (list org-scheduled-string org-deadline-string org-closed-string
466 org-clock-string)
468 "\\)?"
469 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
470 "\\|"
471 "<%%([^\r\n>]*>\\)")
472 "Matches a timestamp, possibly preceded by a keyword.")
474 (defconst org-all-time-keywords
475 (mapcar (lambda (w) (substring w 0 -1))
476 (list org-scheduled-string org-deadline-string
477 org-clock-string org-closed-string))
478 "List of time keywords.")
480 ;;;; Drawer
482 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
483 "Matches first or last line of a hidden block.
484 Group 1 contains drawer's name or \"END\".")
486 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
487 "Regular expression matching the first line of a property drawer.")
489 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
490 "Regular expression matching the last line of a property drawer.")
492 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
493 "Regular expression matching the first line of a clock drawer.")
495 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
496 "Regular expression matching the last line of a clock drawer.")
498 (defconst org-property-drawer-re
499 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
500 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
501 "[ \t]*:END:[ \t]*$")
502 "Matches an entire property drawer.")
504 (defconst org-clock-drawer-re
505 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
506 org-clock-drawer-end-re "\\)\n?")
507 "Matches an entire clock drawer.")
509 ;;;; Headline
511 (defconst org-heading-keyword-regexp-format
512 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
513 "Printf format for a regexp matching a headline with some keyword.
514 This regexp will match the headline of any node which has the
515 exact keyword that is put into the format. The keyword isn't in
516 any group by default, but the stars and the body are.")
518 (defconst org-heading-keyword-maybe-regexp-format
519 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
520 "Printf format for a regexp matching a headline, possibly with some keyword.
521 This regexp can match any headline with the specified keyword, or
522 without a keyword. The keyword isn't in any group by default,
523 but the stars and the body are.")
525 (defconst org-archive-tag "ARCHIVE"
526 "The tag that marks a subtree as archived.
527 An archived subtree does not open during visibility cycling, and does
528 not contribute to the agenda listings.")
530 (defconst org-comment-string "COMMENT"
531 "Entries starting with this keyword will never be exported.
532 An entry can be toggled between COMMENT and normal with
533 \\[org-toggle-comment].")
536 ;;;; LaTeX Environments and Fragments
538 (defconst org-latex-regexps
539 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
540 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
541 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
542 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
543 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
544 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
545 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
546 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
547 "Regular expressions for matching embedded LaTeX.")
549 ;;;; Node Property
551 (defconst org-effort-property "Effort"
552 "The property that is being used to keep track of effort estimates.
553 Effort estimates given in this property need to have the format H:MM.")
555 ;;;; Table
557 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
558 "Detect an org-type or table-type table.")
560 (defconst org-table-line-regexp "^[ \t]*|"
561 "Detect an org-type table line.")
563 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
564 "Detect an org-type table line.")
566 (defconst org-table-hline-regexp "^[ \t]*|-"
567 "Detect an org-type table hline.")
569 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
570 "Detect a table-type table hline.")
572 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
573 "Detect the first line outside a table when searching from within it.
574 This works for both table types.")
576 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
577 "Detect a #+TBLFM line.")
579 ;;;; Timestamp
581 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
582 "Regular expression for fast time stamp matching.")
584 (defconst org-ts-regexp-inactive
585 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
586 "Regular expression for fast inactive time stamp matching.")
588 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
589 "Regular expression for fast time stamp matching.")
591 (defconst org-ts-regexp0
592 "\\(\\([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.
594 This one does not require the space after the date, so it can be used
595 on a string that terminates immediately after the date.")
597 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
598 "Regular expression matching time strings for analysis.")
600 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
601 "Regular expression matching time stamps, with groups.")
603 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
604 "Regular expression matching time stamps (also [..]), with groups.")
606 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
607 "Regular expression matching a time stamp range.")
609 (defconst org-tr-regexp-both
610 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
611 "Regular expression matching a time stamp range.")
613 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
614 org-ts-regexp "\\)?")
615 "Regular expression matching a time stamp or time stamp range.")
617 (defconst org-tsr-regexp-both
618 (concat org-ts-regexp-both "\\(--?-?"
619 org-ts-regexp-both "\\)?")
620 "Regular expression matching a time stamp or time stamp range.
621 The time stamps may be either active or inactive.")
623 (defconst org-repeat-re
624 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
625 "Regular expression for specifying repeated events.
626 After a match, group 1 contains the repeat expression.")
628 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
629 "Formats for `format-time-string' which are used for time stamps.")
632 ;;; The custom variables
634 (defgroup org nil
635 "Outline-based notes management and organizer."
636 :tag "Org"
637 :group 'outlines
638 :group 'calendar)
640 (defcustom org-mode-hook nil
641 "Mode hook for Org-mode, run after the mode was turned on."
642 :group 'org
643 :type 'hook)
645 (defcustom org-load-hook nil
646 "Hook that is run after org.el has been loaded."
647 :group 'org
648 :type 'hook)
650 (defcustom org-log-buffer-setup-hook nil
651 "Hook that is run after an Org log buffer is created."
652 :group 'org
653 :version "24.1"
654 :type 'hook)
656 (defvar org-modules) ; defined below
657 (defvar org-modules-loaded nil
658 "Have the modules been loaded already?")
660 (defun org-load-modules-maybe (&optional force)
661 "Load all extensions listed in `org-modules'."
662 (when (or force (not org-modules-loaded))
663 (mapc (lambda (ext)
664 (condition-case nil (require ext)
665 (error (message "Problems while trying to load feature `%s'" ext))))
666 org-modules)
667 (setq org-modules-loaded t)))
669 (defun org-set-modules (var value)
670 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
671 (set var value)
672 (when (featurep 'org)
673 (org-load-modules-maybe 'force)
674 (org-element-cache-reset 'all)))
676 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
677 "Modules that should always be loaded together with org.el.
679 If a description starts with <C>, the file is not part of Emacs
680 and loading it will require that you have downloaded and properly
681 installed the Org mode distribution.
683 You can also use this system to load external packages (i.e. neither Org
684 core modules, nor modules from the CONTRIB directory). Just add symbols
685 to the end of the list. If the package is called org-xyz.el, then you need
686 to add the symbol `xyz', and the package must have a call to:
688 \(provide 'org-xyz)
690 For export specific modules, see also `org-export-backends'."
691 :group 'org
692 :set 'org-set-modules
693 :version "24.4"
694 :package-version '(Org . "8.0")
695 :type
696 '(set :greedy t
697 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
698 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
699 (const :tag " crypt: Encryption of subtrees" org-crypt)
700 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
701 (const :tag " docview: Links to doc-view buffers" org-docview)
702 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
703 (const :tag " habit: Track your consistency with habits" org-habit)
704 (const :tag " id: Global IDs for identifying entries" org-id)
705 (const :tag " info: Links to Info nodes" org-info)
706 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
707 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
708 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
709 (const :tag " mouse: Additional mouse support" org-mouse)
710 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
711 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
712 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
714 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
715 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
716 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
717 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
718 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
719 (const :tag "C collector: Collect properties into tables" org-collector)
720 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
721 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
722 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
723 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
724 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
725 (const :tag "C eval: Include command output as text" org-eval)
726 (const :tag "C eww: Store link to url of eww" org-eww)
727 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
728 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
729 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
730 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
731 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
732 (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
733 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
734 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
735 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
736 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
737 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
738 (const :tag "C mew: Links to Mew folders/messages" org-mew)
739 (const :tag "C mtags: Support for muse-like tags" org-mtags)
740 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
741 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
742 (const :tag "C registry: A registry for Org-mode links" org-registry)
743 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
744 (const :tag "C secretary: Team management with org-mode" org-secretary)
745 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
746 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
747 (const :tag "C track: Keep up with Org-mode development" org-track)
748 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
749 (const :tag "C vm: Links to VM folders/messages" org-vm)
750 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
751 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
752 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
754 (defvar org-export--registered-backends) ; From ox.el.
755 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
756 (declare-function org-export-backend-name "ox" (backend))
757 (defcustom org-export-backends '(ascii html icalendar latex)
758 "List of export back-ends that should be always available.
760 If a description starts with <C>, the file is not part of Emacs
761 and loading it will require that you have downloaded and properly
762 installed the Org mode distribution.
764 Unlike to `org-modules', libraries in this list will not be
765 loaded along with Org, but only once the export framework is
766 needed.
768 This variable needs to be set before org.el is loaded. If you
769 need to make a change while Emacs is running, use the customize
770 interface or run the following code, where VAL stands for the new
771 value of the variable, after updating it:
773 \(progn
774 \(setq org-export--registered-backends
775 \(org-remove-if-not
776 \(lambda (backend)
777 \(let ((name (org-export-backend-name backend)))
778 \(or (memq name val)
779 \(catch 'parentp
780 \(dolist (b val)
781 \(and (org-export-derived-backend-p b name)
782 \(throw 'parentp t)))))))
783 org-export--registered-backends))
784 \(let ((new-list (mapcar 'org-export-backend-name
785 org-export--registered-backends)))
786 \(dolist (backend val)
787 \(cond
788 \((not (load (format \"ox-%s\" backend) t t))
789 \(message \"Problems while trying to load export back-end `%s'\"
790 backend))
791 \((not (memq backend new-list)) (push backend new-list))))
792 \(set-default 'org-export-backends new-list)))
794 Adding a back-end to this list will also pull the back-end it
795 depends on, if any."
796 :group 'org
797 :group 'org-export
798 :version "24.4"
799 :package-version '(Org . "8.0")
800 :initialize 'custom-initialize-set
801 :set (lambda (var val)
802 (if (not (featurep 'ox)) (set-default var val)
803 ;; Any back-end not required anymore (not present in VAL and not
804 ;; a parent of any back-end in the new value) is removed from the
805 ;; list of registered back-ends.
806 (setq org-export--registered-backends
807 (org-remove-if-not
808 (lambda (backend)
809 (let ((name (org-export-backend-name backend)))
810 (or (memq name val)
811 (catch 'parentp
812 (dolist (b val)
813 (and (org-export-derived-backend-p b name)
814 (throw 'parentp t)))))))
815 org-export--registered-backends))
816 ;; Now build NEW-LIST of both new back-ends and required
817 ;; parents.
818 (let ((new-list (mapcar 'org-export-backend-name
819 org-export--registered-backends)))
820 (dolist (backend val)
821 (cond
822 ((not (load (format "ox-%s" backend) t t))
823 (message "Problems while trying to load export back-end `%s'"
824 backend))
825 ((not (memq backend new-list)) (push backend new-list))))
826 ;; Set VAR to that list with fixed dependencies.
827 (set-default var new-list))))
828 :type '(set :greedy t
829 (const :tag " ascii Export buffer to ASCII format" ascii)
830 (const :tag " beamer Export buffer to Beamer presentation" beamer)
831 (const :tag " html Export buffer to HTML format" html)
832 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
833 (const :tag " latex Export buffer to LaTeX format" latex)
834 (const :tag " man Export buffer to MAN format" man)
835 (const :tag " md Export buffer to Markdown format" md)
836 (const :tag " odt Export buffer to ODT format" odt)
837 (const :tag " org Export buffer to Org format" org)
838 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
839 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
840 (const :tag "C deck Export buffer to deck.js presentations" deck)
841 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
842 (const :tag "C groff Export buffer to Groff format" groff)
843 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
844 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
845 (const :tag "C s5 Export buffer to s5 presentations" s5)
846 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
848 (eval-after-load 'ox
849 '(mapc
850 (lambda (backend)
851 (condition-case nil (require (intern (format "ox-%s" backend)))
852 (error (message "Problems while trying to load export back-end `%s'"
853 backend))))
854 org-export-backends))
856 (defcustom org-support-shift-select nil
857 "Non-nil means make shift-cursor commands select text when possible.
859 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
860 start selecting a region, or enlarge regions started in this way.
861 In Org-mode, in special contexts, these same keys are used for
862 other purposes, important enough to compete with shift selection.
863 Org tries to balance these needs by supporting `shift-select-mode'
864 outside these special contexts, under control of this variable.
866 The default of this variable is nil, to avoid confusing behavior. Shifted
867 cursor keys will then execute Org commands in the following contexts:
868 - on a headline, changing TODO state (left/right) and priority (up/down)
869 - on a time stamp, changing the time
870 - in a plain list item, changing the bullet type
871 - in a property definition line, switching between allowed values
872 - in the BEGIN line of a clock table (changing the time block).
873 Outside these contexts, the commands will throw an error.
875 When this variable is t and the cursor is not in a special
876 context, Org-mode will support shift-selection for making and
877 enlarging regions. To make this more effective, the bullet
878 cycling will no longer happen anywhere in an item line, but only
879 if the cursor is exactly on the bullet.
881 If you set this variable to the symbol `always', then the keys
882 will not be special in headlines, property lines, and item lines,
883 to make shift selection work there as well. If this is what you
884 want, you can use the following alternative commands: `C-c C-t'
885 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
886 can be used to switch TODO sets, `C-c -' to cycle item bullet
887 types, and properties can be edited by hand or in column view.
889 However, when the cursor is on a timestamp, shift-cursor commands
890 will still edit the time stamp - this is just too good to give up.
892 XEmacs user should have this variable set to nil, because
893 `shift-select-mode' is in Emacs 23 or later only."
894 :group 'org
895 :type '(choice
896 (const :tag "Never" nil)
897 (const :tag "When outside special context" t)
898 (const :tag "Everywhere except timestamps" always)))
900 (defcustom org-loop-over-headlines-in-active-region nil
901 "Shall some commands act upon headlines in the active region?
903 When set to `t', some commands will be performed in all headlines
904 within the active region.
906 When set to `start-level', some commands will be performed in all
907 headlines within the active region, provided that these headlines
908 are of the same level than the first one.
910 When set to a string, those commands will be performed on the
911 matching headlines within the active region. Such string must be
912 a tags/property/todo match as it is used in the agenda tags view.
914 The list of commands is: `org-schedule', `org-deadline',
915 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
916 `org-archive-to-archive-sibling'. The archiving commands skip
917 already archived entries."
918 :type '(choice (const :tag "Don't loop" nil)
919 (const :tag "All headlines in active region" t)
920 (const :tag "In active region, headlines at the same level than the first one" start-level)
921 (string :tag "Tags/Property/Todo matcher"))
922 :version "24.1"
923 :group 'org-todo
924 :group 'org-archive)
926 (defgroup org-startup nil
927 "Options concerning startup of Org-mode."
928 :tag "Org Startup"
929 :group 'org)
931 (defcustom org-startup-folded t
932 "Non-nil means entering Org-mode will switch to OVERVIEW.
933 This can also be configured on a per-file basis by adding one of
934 the following lines anywhere in the buffer:
936 #+STARTUP: fold (or `overview', this is equivalent)
937 #+STARTUP: nofold (or `showall', this is equivalent)
938 #+STARTUP: content
939 #+STARTUP: showeverything
941 By default, this option is ignored when Org opens agenda files
942 for the first time. If you want the agenda to honor the startup
943 option, set `org-agenda-inhibit-startup' to nil."
944 :group 'org-startup
945 :type '(choice
946 (const :tag "nofold: show all" nil)
947 (const :tag "fold: overview" t)
948 (const :tag "content: all headlines" content)
949 (const :tag "show everything, even drawers" showeverything)))
951 (defcustom org-startup-truncated t
952 "Non-nil means entering Org-mode will set `truncate-lines'.
953 This is useful since some lines containing links can be very long and
954 uninteresting. Also tables look terrible when wrapped."
955 :group 'org-startup
956 :type 'boolean)
958 (defcustom org-startup-indented nil
959 "Non-nil means turn on `org-indent-mode' on startup.
960 This can also be configured on a per-file basis by adding one of
961 the following lines anywhere in the buffer:
963 #+STARTUP: indent
964 #+STARTUP: noindent"
965 :group 'org-structure
966 :type '(choice
967 (const :tag "Not" nil)
968 (const :tag "Globally (slow on startup in large files)" t)))
970 (defcustom org-use-sub-superscripts t
971 "Non-nil means interpret \"_\" and \"^\" for display.
973 If you want to control how Org exports those characters, see
974 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
975 used to be an alias for `org-export-with-sub-superscripts' in
976 Org <8.0, it is not anymore.
978 When this option is turned on, you can use TeX-like syntax for
979 sub- and superscripts within the buffer. Several characters after
980 \"_\" or \"^\" will be considered as a single item - so grouping
981 with {} is normally not needed. For example, the following things
982 will be parsed as single sub- or superscripts:
984 10^24 or 10^tau several digits will be considered 1 item.
985 10^-12 or 10^-tau a leading sign with digits or a word
986 x^2-y^3 will be read as x^2 - y^3, because items are
987 terminated by almost any nonword/nondigit char.
988 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
990 Still, ambiguity is possible. So when in doubt, use {} to enclose
991 the sub/superscript. If you set this variable to the symbol `{}',
992 the braces are *required* in order to trigger interpretations as
993 sub/superscript. This can be helpful in documents that need \"_\"
994 frequently in plain text."
995 :group 'org-startup
996 :version "24.4"
997 :package-version '(Org . "8.0")
998 :type '(choice
999 (const :tag "Always interpret" t)
1000 (const :tag "Only with braces" {})
1001 (const :tag "Never interpret" nil)))
1003 (defcustom org-startup-with-beamer-mode nil
1004 "Non-nil means turn on `org-beamer-mode' on startup.
1005 This can also be configured on a per-file basis by adding one of
1006 the following lines anywhere in the buffer:
1008 #+STARTUP: beamer"
1009 :group 'org-startup
1010 :version "24.1"
1011 :type 'boolean)
1013 (defcustom org-startup-align-all-tables nil
1014 "Non-nil means align all tables when visiting a file.
1015 This is useful when the column width in tables is forced with <N> cookies
1016 in table fields. Such tables will look correct only after the first re-align.
1017 This can also be configured on a per-file basis by adding one of
1018 the following lines anywhere in the buffer:
1019 #+STARTUP: align
1020 #+STARTUP: noalign"
1021 :group 'org-startup
1022 :type 'boolean)
1024 (defcustom org-startup-with-inline-images nil
1025 "Non-nil means show inline images when loading a new Org file.
1026 This can also be configured on a per-file basis by adding one of
1027 the following lines anywhere in the buffer:
1028 #+STARTUP: inlineimages
1029 #+STARTUP: noinlineimages"
1030 :group 'org-startup
1031 :version "24.1"
1032 :type 'boolean)
1034 (defcustom org-startup-with-latex-preview nil
1035 "Non-nil means preview LaTeX fragments when loading a new Org file.
1037 This can also be configured on a per-file basis by adding one of
1038 the following lines anywhere in the buffer:
1039 #+STARTUP: latexpreview
1040 #+STARTUP: nolatexpreview"
1041 :group 'org-startup
1042 :version "24.4"
1043 :package-version '(Org . "8.0")
1044 :type 'boolean)
1046 (defcustom org-insert-mode-line-in-empty-file nil
1047 "Non-nil means insert the first line setting Org-mode in empty files.
1048 When the function `org-mode' is called interactively in an empty file, this
1049 normally means that the file name does not automatically trigger Org-mode.
1050 To ensure that the file will always be in Org-mode in the future, a
1051 line enforcing Org-mode will be inserted into the buffer, if this option
1052 has been set."
1053 :group 'org-startup
1054 :type 'boolean)
1056 (defcustom org-replace-disputed-keys nil
1057 "Non-nil means use alternative key bindings for some keys.
1058 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1059 These keys are also used by other packages like shift-selection-mode'
1060 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1061 If you want to use Org-mode together with one of these other modes,
1062 or more generally if you would like to move some Org-mode commands to
1063 other keys, set this variable and configure the keys with the variable
1064 `org-disputed-keys'.
1066 This option is only relevant at load-time of Org-mode, and must be set
1067 *before* org.el is loaded. Changing it requires a restart of Emacs to
1068 become effective."
1069 :group 'org-startup
1070 :type 'boolean)
1072 (defcustom org-use-extra-keys nil
1073 "Non-nil means use extra key sequence definitions for certain commands.
1074 This happens automatically if you run XEmacs or if `window-system'
1075 is nil. This variable lets you do the same manually. You must
1076 set it before loading org.
1078 Example: on Carbon Emacs 22 running graphically, with an external
1079 keyboard on a Powerbook, the default way of setting M-left might
1080 not work for either Alt or ESC. Setting this variable will make
1081 it work for ESC."
1082 :group 'org-startup
1083 :type 'boolean)
1085 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1087 (defcustom org-disputed-keys
1088 '(([(shift up)] . [(meta p)])
1089 ([(shift down)] . [(meta n)])
1090 ([(shift left)] . [(meta -)])
1091 ([(shift right)] . [(meta +)])
1092 ([(control shift right)] . [(meta shift +)])
1093 ([(control shift left)] . [(meta shift -)]))
1094 "Keys for which Org-mode and other modes compete.
1095 This is an alist, cars are the default keys, second element specifies
1096 the alternative to use when `org-replace-disputed-keys' is t.
1098 Keys can be specified in any syntax supported by `define-key'.
1099 The value of this option takes effect only at Org-mode's startup,
1100 therefore you'll have to restart Emacs to apply it after changing."
1101 :group 'org-startup
1102 :type 'alist)
1104 (defun org-key (key)
1105 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1106 Or return the original if not disputed.
1107 Also apply the translations defined in `org-xemacs-key-equivalents'."
1108 (when org-replace-disputed-keys
1109 (let* ((nkey (key-description key))
1110 (x (org-find-if (lambda (x)
1111 (equal (key-description (car x)) nkey))
1112 org-disputed-keys)))
1113 (setq key (if x (cdr x) key))))
1114 (when (featurep 'xemacs)
1115 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1116 key)
1118 (defun org-find-if (predicate seq)
1119 (catch 'exit
1120 (while seq
1121 (if (funcall predicate (car seq))
1122 (throw 'exit (car seq))
1123 (pop seq)))))
1125 (defun org-defkey (keymap key def)
1126 "Define a key, possibly translated, as returned by `org-key'."
1127 (define-key keymap (org-key key) def))
1129 (defcustom org-ellipsis nil
1130 "The ellipsis to use in the Org-mode outline.
1131 When nil, just use the standard three dots.
1132 When a string, use that string instead.
1133 When a face, use the standard 3 dots, but with the specified face.
1134 The change affects only Org-mode (which will then use its own display table).
1135 Changing this requires executing \\[org-mode] in a buffer to become
1136 effective."
1137 :group 'org-startup
1138 :type '(choice (const :tag "Default" nil)
1139 (face :tag "Face" :value org-warning)
1140 (string :tag "String" :value "...#")))
1142 (defvar org-display-table nil
1143 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1145 (defgroup org-keywords nil
1146 "Keywords in Org-mode."
1147 :tag "Org Keywords"
1148 :group 'org)
1150 (defcustom org-closed-keep-when-no-todo nil
1151 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1152 :group 'org-todo
1153 :group 'org-keywords
1154 :version "24.4"
1155 :package-version '(Org . "8.0")
1156 :type 'boolean)
1158 (defgroup org-structure nil
1159 "Options concerning the general structure of Org-mode files."
1160 :tag "Org Structure"
1161 :group 'org)
1163 (defgroup org-reveal-location nil
1164 "Options about how to make context of a location visible."
1165 :tag "Org Reveal Location"
1166 :group 'org-structure)
1168 (defconst org-context-choice
1169 '(choice
1170 (const :tag "Always" t)
1171 (const :tag "Never" nil)
1172 (repeat :greedy t :tag "Individual contexts"
1173 (cons
1174 (choice :tag "Context"
1175 (const agenda)
1176 (const org-goto)
1177 (const occur-tree)
1178 (const tags-tree)
1179 (const link-search)
1180 (const mark-goto)
1181 (const bookmark-jump)
1182 (const isearch)
1183 (const default))
1184 (boolean))))
1185 "Contexts for the reveal options.")
1187 (defcustom org-show-hierarchy-above '((default . t))
1188 "Non-nil means show full hierarchy when revealing a location.
1189 Org-mode often shows locations in an org-mode file which might have
1190 been invisible before. When this is set, the hierarchy of headings
1191 above the exposed location is shown.
1192 Turning this off for example for sparse trees makes them very compact.
1193 Instead of t, this can also be an alist specifying this option for different
1194 contexts. Valid contexts are
1195 agenda when exposing an entry from the agenda
1196 org-goto when using the command `org-goto' on key C-c C-j
1197 occur-tree when using the command `org-occur' on key C-c /
1198 tags-tree when constructing a sparse tree based on tags matches
1199 link-search when exposing search matches associated with a link
1200 mark-goto when exposing the jump goal of a mark
1201 bookmark-jump when exposing a bookmark location
1202 isearch when exiting from an incremental search
1203 default default for all contexts not set explicitly"
1204 :group 'org-reveal-location
1205 :type org-context-choice)
1207 (defcustom org-show-following-heading '((default . nil))
1208 "Non-nil means show following heading when revealing a location.
1209 Org-mode often shows locations in an org-mode file which might have
1210 been invisible before. When this is set, the heading following the
1211 match is shown.
1212 Turning this off for example for sparse trees makes them very compact,
1213 but makes it harder to edit the location of the match. In such a case,
1214 use the command \\[org-reveal] to show more context.
1215 Instead of t, this can also be an alist specifying this option for different
1216 contexts. See `org-show-hierarchy-above' for valid contexts."
1217 :group 'org-reveal-location
1218 :type org-context-choice)
1220 (defcustom org-show-siblings '((default . nil) (isearch t) (bookmark-jump t))
1221 "Non-nil means show all sibling heading when revealing a location.
1222 Org-mode often shows locations in an org-mode file which might have
1223 been invisible before. When this is set, the sibling of the current entry
1224 heading are all made visible. If `org-show-hierarchy-above' is t,
1225 the same happens on each level of the hierarchy above the current entry.
1227 By default this is on for the isearch context, off for all other contexts.
1228 Turning this off for example for sparse trees makes them very compact,
1229 but makes it harder to edit the location of the match. In such a case,
1230 use the command \\[org-reveal] to show more context.
1231 Instead of t, this can also be an alist specifying this option for different
1232 contexts. See `org-show-hierarchy-above' for valid contexts."
1233 :group 'org-reveal-location
1234 :type org-context-choice
1235 :version "24.4"
1236 :package-version '(Org . "8.0"))
1238 (defcustom org-show-entry-below '((default . nil))
1239 "Non-nil means show the entry below a headline when revealing a location.
1240 Org-mode often shows locations in an org-mode file which might have
1241 been invisible before. When this is set, the text below the headline that is
1242 exposed is also shown.
1244 By default this is off for all contexts.
1245 Instead of t, this can also be an alist specifying this option for different
1246 contexts. See `org-show-hierarchy-above' for valid contexts."
1247 :group 'org-reveal-location
1248 :type org-context-choice)
1250 (defcustom org-indirect-buffer-display 'other-window
1251 "How should indirect tree buffers be displayed?
1252 This applies to indirect buffers created with the commands
1253 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1254 Valid values are:
1255 current-window Display in the current window
1256 other-window Just display in another window.
1257 dedicated-frame Create one new frame, and re-use it each time.
1258 new-frame Make a new frame each time. Note that in this case
1259 previously-made indirect buffers are kept, and you need to
1260 kill these buffers yourself."
1261 :group 'org-structure
1262 :group 'org-agenda-windows
1263 :type '(choice
1264 (const :tag "In current window" current-window)
1265 (const :tag "In current frame, other window" other-window)
1266 (const :tag "Each time a new frame" new-frame)
1267 (const :tag "One dedicated frame" dedicated-frame)))
1269 (defcustom org-use-speed-commands nil
1270 "Non-nil means activate single letter commands at beginning of a headline.
1271 This may also be a function to test for appropriate locations where speed
1272 commands should be active.
1274 For example, to activate speed commands when the point is on any
1275 star at the beginning of the headline, you can do this:
1277 (setq org-use-speed-commands
1278 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1279 :group 'org-structure
1280 :type '(choice
1281 (const :tag "Never" nil)
1282 (const :tag "At beginning of headline stars" t)
1283 (function)))
1285 (defcustom org-speed-commands-user nil
1286 "Alist of additional speed commands.
1287 This list will be checked before `org-speed-commands-default'
1288 when the variable `org-use-speed-commands' is non-nil
1289 and when the cursor is at the beginning of a headline.
1290 The car if each entry is a string with a single letter, which must
1291 be assigned to `self-insert-command' in the global map.
1292 The cdr is either a command to be called interactively, a function
1293 to be called, or a form to be evaluated.
1294 An entry that is just a list with a single string will be interpreted
1295 as a descriptive headline that will be added when listing the speed
1296 commands in the Help buffer using the `?' speed command."
1297 :group 'org-structure
1298 :type '(repeat :value ("k" . ignore)
1299 (choice :value ("k" . ignore)
1300 (list :tag "Descriptive Headline" (string :tag "Headline"))
1301 (cons :tag "Letter and Command"
1302 (string :tag "Command letter")
1303 (choice
1304 (function)
1305 (sexp))))))
1307 (defcustom org-bookmark-names-plist
1308 '(:last-capture "org-capture-last-stored"
1309 :last-refile "org-refile-last-stored"
1310 :last-capture-marker "org-capture-last-stored-marker")
1311 "Names for bookmarks automatically set by some Org commands.
1312 This can provide strings as names for a number of bookmarks Org sets
1313 automatically. The following keys are currently implemented:
1314 :last-capture
1315 :last-capture-marker
1316 :last-refile
1317 When a key does not show up in the property list, the corresponding bookmark
1318 is not set."
1319 :group 'org-structure
1320 :type 'plist)
1322 (defgroup org-cycle nil
1323 "Options concerning visibility cycling in Org-mode."
1324 :tag "Org Cycle"
1325 :group 'org-structure)
1327 (defcustom org-cycle-skip-children-state-if-no-children t
1328 "Non-nil means skip CHILDREN state in entries that don't have any."
1329 :group 'org-cycle
1330 :type 'boolean)
1332 (defcustom org-cycle-max-level nil
1333 "Maximum level which should still be subject to visibility cycling.
1334 Levels higher than this will, for cycling, be treated as text, not a headline.
1335 When `org-odd-levels-only' is set, a value of N in this variable actually
1336 means 2N-1 stars as the limiting headline.
1337 When nil, cycle all levels.
1338 Note that the limiting level of cycling is also influenced by
1339 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1340 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1341 than its value."
1342 :group 'org-cycle
1343 :type '(choice
1344 (const :tag "No limit" nil)
1345 (integer :tag "Maximum level")))
1347 (defcustom org-hide-block-startup nil
1348 "Non-nil means entering Org-mode will fold all blocks.
1349 This can also be set in on a per-file basis with
1351 #+STARTUP: hideblocks
1352 #+STARTUP: showblocks"
1353 :group 'org-startup
1354 :group 'org-cycle
1355 :type 'boolean)
1357 (defcustom org-cycle-global-at-bob nil
1358 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1359 This makes it possible to do global cycling without having to use S-TAB or
1360 \\[universal-argument] TAB. For this special case to work, the first line
1361 of the buffer must not be a headline -- it may be empty or some other text.
1362 When used in this way, `org-cycle-hook' is disabled temporarily to make
1363 sure the cursor stays at the beginning of the buffer. When this option is
1364 nil, don't do anything special at the beginning of the buffer."
1365 :group 'org-cycle
1366 :type 'boolean)
1368 (defcustom org-cycle-level-after-item/entry-creation t
1369 "Non-nil means cycle entry level or item indentation in new empty entries.
1371 When the cursor is at the end of an empty headline, i.e., with only stars
1372 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1373 and then all possible ancestor states, before returning to the original state.
1374 This makes data entry extremely fast: M-RET to create a new headline,
1375 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1377 When the cursor is at the end of an empty plain list item, one TAB will
1378 make it a subitem, two or more tabs will back up to make this an item
1379 higher up in the item hierarchy."
1380 :group 'org-cycle
1381 :type 'boolean)
1383 (defcustom org-cycle-emulate-tab t
1384 "Where should `org-cycle' emulate TAB.
1385 nil Never
1386 white Only in completely white lines
1387 whitestart Only at the beginning of lines, before the first non-white char
1388 t Everywhere except in headlines
1389 exc-hl-bol Everywhere except at the start of a headline
1390 If TAB is used in a place where it does not emulate TAB, the current subtree
1391 visibility is cycled."
1392 :group 'org-cycle
1393 :type '(choice (const :tag "Never" nil)
1394 (const :tag "Only in completely white lines" white)
1395 (const :tag "Before first char in a line" whitestart)
1396 (const :tag "Everywhere except in headlines" t)
1397 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1399 (defcustom org-cycle-separator-lines 2
1400 "Number of empty lines needed to keep an empty line between collapsed trees.
1401 If you leave an empty line between the end of a subtree and the following
1402 headline, this empty line is hidden when the subtree is folded.
1403 Org-mode will leave (exactly) one empty line visible if the number of
1404 empty lines is equal or larger to the number given in this variable.
1405 So the default 2 means at least 2 empty lines after the end of a subtree
1406 are needed to produce free space between a collapsed subtree and the
1407 following headline.
1409 If the number is negative, and the number of empty lines is at least -N,
1410 all empty lines are shown.
1412 Special case: when 0, never leave empty lines in collapsed view."
1413 :group 'org-cycle
1414 :type 'integer)
1415 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1417 (defcustom org-pre-cycle-hook nil
1418 "Hook that is run before visibility cycling is happening.
1419 The function(s) in this hook must accept a single argument which indicates
1420 the new state that will be set right after running this hook. The
1421 argument is a symbol. Before a global state change, it can have the values
1422 `overview', `content', or `all'. Before a local state change, it can have
1423 the values `folded', `children', or `subtree'."
1424 :group 'org-cycle
1425 :type 'hook)
1427 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1428 org-cycle-hide-drawers
1429 org-cycle-hide-inline-tasks
1430 org-cycle-show-empty-lines
1431 org-optimize-window-after-visibility-change)
1432 "Hook that is run after `org-cycle' has changed the buffer visibility.
1433 The function(s) in this hook must accept a single argument which indicates
1434 the new state that was set by the most recent `org-cycle' command. The
1435 argument is a symbol. After a global state change, it can have the values
1436 `overview', `contents', or `all'. After a local state change, it can have
1437 the values `folded', `children', or `subtree'."
1438 :group 'org-cycle
1439 :type 'hook)
1441 (defgroup org-edit-structure nil
1442 "Options concerning structure editing in Org-mode."
1443 :tag "Org Edit Structure"
1444 :group 'org-structure)
1446 (defcustom org-odd-levels-only nil
1447 "Non-nil means skip even levels and only use odd levels for the outline.
1448 This has the effect that two stars are being added/taken away in
1449 promotion/demotion commands. It also influences how levels are
1450 handled by the exporters.
1451 Changing it requires restart of `font-lock-mode' to become effective
1452 for fontification also in regions already fontified.
1453 You may also set this on a per-file basis by adding one of the following
1454 lines to the buffer:
1456 #+STARTUP: odd
1457 #+STARTUP: oddeven"
1458 :group 'org-edit-structure
1459 :group 'org-appearance
1460 :type 'boolean)
1462 (defcustom org-adapt-indentation t
1463 "Non-nil means adapt indentation to outline node level.
1465 When this variable is set, Org assumes that you write outlines by
1466 indenting text in each node to align with the headline (after the
1467 stars). The following issues are influenced by this variable:
1469 - The indentation is increased by one space in a demotion
1470 command, and decreased by one in a promotion command. However,
1471 in the latter case, if shifting some line in the entry body
1472 would alter document structure (e.g., insert a new headline),
1473 indentation is not changed at all.
1475 - Property drawers and planning information is inserted indented
1476 when this variable is set. When nil, they will not be indented.
1478 - TAB indents a line relative to current level. The lines below
1479 a headline will be indented when this variable is set.
1481 Note that this is all about true indentation, by adding and
1482 removing space characters. See also `org-indent.el' which does
1483 level-dependent indentation in a virtual way, i.e. at display
1484 time in Emacs."
1485 :group 'org-edit-structure
1486 :type 'boolean)
1488 (defcustom org-special-ctrl-a/e nil
1489 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1491 When t, `C-a' will bring back the cursor to the beginning of the
1492 headline text, i.e. after the stars and after a possible TODO
1493 keyword. In an item, this will be the position after bullet and
1494 check-box, if any. When the cursor is already at that position,
1495 another `C-a' will bring it to the beginning of the line.
1497 `C-e' will jump to the end of the headline, ignoring the presence
1498 of tags in the headline. A second `C-e' will then jump to the
1499 true end of the line, after any tags. This also means that, when
1500 this variable is non-nil, `C-e' also will never jump beyond the
1501 end of the heading of a folded section, i.e. not after the
1502 ellipses.
1504 When set to the symbol `reversed', the first `C-a' or `C-e' works
1505 normally, going to the true line boundary first. Only a directly
1506 following, identical keypress will bring the cursor to the
1507 special positions.
1509 This may also be a cons cell where the behavior for `C-a' and
1510 `C-e' is set separately."
1511 :group 'org-edit-structure
1512 :type '(choice
1513 (const :tag "off" nil)
1514 (const :tag "on: after stars/bullet and before tags first" t)
1515 (const :tag "reversed: true line boundary first" reversed)
1516 (cons :tag "Set C-a and C-e separately"
1517 (choice :tag "Special C-a"
1518 (const :tag "off" nil)
1519 (const :tag "on: after stars/bullet first" t)
1520 (const :tag "reversed: before stars/bullet first" reversed))
1521 (choice :tag "Special C-e"
1522 (const :tag "off" nil)
1523 (const :tag "on: before tags first" t)
1524 (const :tag "reversed: after tags first" reversed)))))
1525 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1527 (defcustom org-special-ctrl-k nil
1528 "Non-nil means `C-k' will behave specially in headlines.
1529 When nil, `C-k' will call the default `kill-line' command.
1530 When t, the following will happen while the cursor is in the headline:
1532 - When the cursor is at the beginning of a headline, kill the entire
1533 line and possible the folded subtree below the line.
1534 - When in the middle of the headline text, kill the headline up to the tags.
1535 - When after the headline text, kill the tags."
1536 :group 'org-edit-structure
1537 :type 'boolean)
1539 (defcustom org-ctrl-k-protect-subtree nil
1540 "Non-nil means, do not delete a hidden subtree with C-k.
1541 When set to the symbol `error', simply throw an error when C-k is
1542 used to kill (part-of) a headline that has hidden text behind it.
1543 Any other non-nil value will result in a query to the user, if it is
1544 OK to kill that hidden subtree. When nil, kill without remorse."
1545 :group 'org-edit-structure
1546 :version "24.1"
1547 :type '(choice
1548 (const :tag "Do not protect hidden subtrees" nil)
1549 (const :tag "Protect hidden subtrees with a security query" t)
1550 (const :tag "Never kill a hidden subtree with C-k" error)))
1552 (defcustom org-special-ctrl-o t
1553 "Non-nil means, make `C-o' insert a row in tables."
1554 :group 'org-edit-structure
1555 :type 'boolean)
1557 (defcustom org-catch-invisible-edits nil
1558 "Check if in invisible region before inserting or deleting a character.
1559 Valid values are:
1561 nil Do not check, so just do invisible edits.
1562 error Throw an error and do nothing.
1563 show Make point visible, and do the requested edit.
1564 show-and-error Make point visible, then throw an error and abort the edit.
1565 smart Make point visible, and do insertion/deletion if it is
1566 adjacent to visible text and the change feels predictable.
1567 Never delete a previously invisible character or add in the
1568 middle or right after an invisible region. Basically, this
1569 allows insertion and backward-delete right before ellipses.
1570 FIXME: maybe in this case we should not even show?"
1571 :group 'org-edit-structure
1572 :version "24.1"
1573 :type '(choice
1574 (const :tag "Do not check" nil)
1575 (const :tag "Throw error when trying to edit" error)
1576 (const :tag "Unhide, but do not do the edit" show-and-error)
1577 (const :tag "Show invisible part and do the edit" show)
1578 (const :tag "Be smart and do the right thing" smart)))
1580 (defcustom org-yank-folded-subtrees t
1581 "Non-nil means when yanking subtrees, fold them.
1582 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1583 it starts with a heading and all other headings in it are either children
1584 or siblings, then fold all the subtrees. However, do this only if no
1585 text after the yank would be swallowed into a folded tree by this action."
1586 :group 'org-edit-structure
1587 :type 'boolean)
1589 (defcustom org-yank-adjusted-subtrees nil
1590 "Non-nil means when yanking subtrees, adjust the level.
1591 With this setting, `org-paste-subtree' is used to insert the subtree, see
1592 this function for details."
1593 :group 'org-edit-structure
1594 :type 'boolean)
1596 (defcustom org-M-RET-may-split-line '((default . t))
1597 "Non-nil means M-RET will split the line at the cursor position.
1598 When nil, it will go to the end of the line before making a
1599 new line.
1600 You may also set this option in a different way for different
1601 contexts. Valid contexts are:
1603 headline when creating a new headline
1604 item when creating a new item
1605 table in a table field
1606 default the value to be used for all contexts not explicitly
1607 customized"
1608 :group 'org-structure
1609 :group 'org-table
1610 :type '(choice
1611 (const :tag "Always" t)
1612 (const :tag "Never" nil)
1613 (repeat :greedy t :tag "Individual contexts"
1614 (cons
1615 (choice :tag "Context"
1616 (const headline)
1617 (const item)
1618 (const table)
1619 (const default))
1620 (boolean)))))
1623 (defcustom org-insert-heading-respect-content nil
1624 "Non-nil means insert new headings after the current subtree.
1625 When nil, the new heading is created directly after the current line.
1626 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1627 this variable on for the duration of the command."
1628 :group 'org-structure
1629 :type 'boolean)
1631 (defcustom org-blank-before-new-entry '((heading . auto)
1632 (plain-list-item . auto))
1633 "Should `org-insert-heading' leave a blank line before new heading/item?
1634 The value is an alist, with `heading' and `plain-list-item' as CAR,
1635 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1636 which case Org will look at the surrounding headings/items and try to
1637 make an intelligent decision whether to insert a blank line or not.
1639 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1640 the setting here is ignored and no empty line is inserted to avoid breaking
1641 the list structure."
1642 :group 'org-edit-structure
1643 :type '(list
1644 (cons (const heading)
1645 (choice (const :tag "Never" nil)
1646 (const :tag "Always" t)
1647 (const :tag "Auto" auto)))
1648 (cons (const plain-list-item)
1649 (choice (const :tag "Never" nil)
1650 (const :tag "Always" t)
1651 (const :tag "Auto" auto)))))
1653 (defcustom org-insert-heading-hook nil
1654 "Hook being run after inserting a new heading."
1655 :group 'org-edit-structure
1656 :type 'hook)
1658 (defcustom org-enable-fixed-width-editor t
1659 "Non-nil means lines starting with \":\" are treated as fixed-width.
1660 This currently only means they are never auto-wrapped.
1661 When nil, such lines will be treated like ordinary lines."
1662 :group 'org-edit-structure
1663 :type 'boolean)
1665 (defcustom org-goto-auto-isearch t
1666 "Non-nil means typing characters in `org-goto' starts incremental search.
1667 When nil, you can use these keybindings to navigate the buffer:
1669 q Quit the org-goto interface
1670 n Go to the next visible heading
1671 p Go to the previous visible heading
1672 f Go one heading forward on same level
1673 b Go one heading backward on same level
1674 u Go one heading up"
1675 :group 'org-edit-structure
1676 :type 'boolean)
1678 (defgroup org-sparse-trees nil
1679 "Options concerning sparse trees in Org-mode."
1680 :tag "Org Sparse Trees"
1681 :group 'org-structure)
1683 (defcustom org-highlight-sparse-tree-matches t
1684 "Non-nil means highlight all matches that define a sparse tree.
1685 The highlights will automatically disappear the next time the buffer is
1686 changed by an edit command."
1687 :group 'org-sparse-trees
1688 :type 'boolean)
1690 (defcustom org-remove-highlights-with-change t
1691 "Non-nil means any change to the buffer will remove temporary highlights.
1692 Such highlights are created by `org-occur' and `org-clock-display'.
1693 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1694 The highlights created by `org-toggle-latex-fragment' always need
1695 `C-c C-x C-l' to be removed."
1696 :group 'org-sparse-trees
1697 :group 'org-time
1698 :type 'boolean)
1701 (defcustom org-occur-hook '(org-first-headline-recenter)
1702 "Hook that is run after `org-occur' has constructed a sparse tree.
1703 This can be used to recenter the window to show as much of the structure
1704 as possible."
1705 :group 'org-sparse-trees
1706 :type 'hook)
1708 (defgroup org-imenu-and-speedbar nil
1709 "Options concerning imenu and speedbar in Org-mode."
1710 :tag "Org Imenu and Speedbar"
1711 :group 'org-structure)
1713 (defcustom org-imenu-depth 2
1714 "The maximum level for Imenu access to Org-mode headlines.
1715 This also applied for speedbar access."
1716 :group 'org-imenu-and-speedbar
1717 :type 'integer)
1719 (defgroup org-table nil
1720 "Options concerning tables in Org-mode."
1721 :tag "Org Table"
1722 :group 'org)
1724 (defcustom org-enable-table-editor 'optimized
1725 "Non-nil means lines starting with \"|\" are handled by the table editor.
1726 When nil, such lines will be treated like ordinary lines.
1728 When equal to the symbol `optimized', the table editor will be optimized to
1729 do the following:
1730 - Automatic overwrite mode in front of whitespace in table fields.
1731 This makes the structure of the table stay in tact as long as the edited
1732 field does not exceed the column width.
1733 - Minimize the number of realigns. Normally, the table is aligned each time
1734 TAB or RET are pressed to move to another field. With optimization this
1735 happens only if changes to a field might have changed the column width.
1736 Optimization requires replacing the functions `self-insert-command',
1737 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1738 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1739 very good at guessing when a re-align will be necessary, but you can always
1740 force one with \\[org-ctrl-c-ctrl-c].
1742 If you would like to use the optimized version in Org-mode, but the
1743 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1745 This variable can be used to turn on and off the table editor during a session,
1746 but in order to toggle optimization, a restart is required.
1748 See also the variable `org-table-auto-blank-field'."
1749 :group 'org-table
1750 :type '(choice
1751 (const :tag "off" nil)
1752 (const :tag "on" t)
1753 (const :tag "on, optimized" optimized)))
1755 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1756 (version<= emacs-version "24.1"))
1757 "Non-nil means cluster self-insert commands for undo when possible.
1758 If this is set, then, like in the Emacs command loop, 20 consecutive
1759 characters will be undone together.
1760 This is configurable, because there is some impact on typing performance."
1761 :group 'org-table
1762 :type 'boolean)
1764 (defcustom org-table-tab-recognizes-table.el t
1765 "Non-nil means TAB will automatically notice a table.el table.
1766 When it sees such a table, it moves point into it and - if necessary -
1767 calls `table-recognize-table'."
1768 :group 'org-table-editing
1769 :type 'boolean)
1771 (defgroup org-link nil
1772 "Options concerning links in Org-mode."
1773 :tag "Org Link"
1774 :group 'org)
1776 (defvar org-link-abbrev-alist-local nil
1777 "Buffer-local version of `org-link-abbrev-alist', which see.
1778 The value of this is taken from the #+LINK lines.")
1779 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1781 (defcustom org-link-abbrev-alist nil
1782 "Alist of link abbreviations.
1783 The car of each element is a string, to be replaced at the start of a link.
1784 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1785 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1787 [[linkkey:tag][description]]
1789 The 'linkkey' must be a word word, starting with a letter, followed
1790 by letters, numbers, '-' or '_'.
1792 If REPLACE is a string, the tag will simply be appended to create the link.
1793 If the string contains \"%s\", the tag will be inserted there. If the string
1794 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1795 at that point (see the function `url-hexify-string'). If the string contains
1796 the specifier \"%(my-function)\", then the custom function `my-function' will
1797 be invoked: this function takes the tag as its only argument and must return
1798 a string.
1800 REPLACE may also be a function that will be called with the tag as the
1801 only argument to create the link, which should be returned as a string.
1803 See the manual for examples."
1804 :group 'org-link
1805 :type '(repeat
1806 (cons
1807 (string :tag "Protocol")
1808 (choice
1809 (string :tag "Format")
1810 (function)))))
1812 (defcustom org-descriptive-links t
1813 "Non-nil means Org will display descriptive links.
1814 E.g. [[http://orgmode.org][Org website]] will be displayed as
1815 \"Org Website\", hiding the link itself and just displaying its
1816 description. When set to `nil', Org will display the full links
1817 literally.
1819 You can interactively set the value of this variable by calling
1820 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1821 :group 'org-link
1822 :type 'boolean)
1824 (defcustom org-link-file-path-type 'adaptive
1825 "How the path name in file links should be stored.
1826 Valid values are:
1828 relative Relative to the current directory, i.e. the directory of the file
1829 into which the link is being inserted.
1830 absolute Absolute path, if possible with ~ for home directory.
1831 noabbrev Absolute path, no abbreviation of home directory.
1832 adaptive Use relative path for files in the current directory and sub-
1833 directories of it. For other files, use an absolute path."
1834 :group 'org-link
1835 :type '(choice
1836 (const relative)
1837 (const absolute)
1838 (const noabbrev)
1839 (const adaptive)))
1841 (defvaralias 'org-activate-links 'org-highlight-links)
1842 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1843 "Types of links that should be highlighted in Org-mode files.
1845 This is a list of symbols, each one of them leading to the
1846 highlighting of a certain link type.
1848 You can still open links that are not highlighted.
1850 In principle, it does not hurt to turn on highlighting for all
1851 link types. There may be a small gain when turning off unused
1852 link types. The types are:
1854 bracket The recommended [[link][description]] or [[link]] links with hiding.
1855 angle Links in angular brackets that may contain whitespace like
1856 <bbdb:Carsten Dominik>.
1857 plain Plain links in normal text, no whitespace, like http://google.com.
1858 radio Text that is matched by a radio target, see manual for details.
1859 tag Tag settings in a headline (link to tag search).
1860 date Time stamps (link to calendar).
1861 footnote Footnote labels.
1863 If you set this variable during an Emacs session, use `org-mode-restart'
1864 in the Org buffer so that the change takes effect."
1865 :group 'org-link
1866 :group 'org-appearance
1867 :type '(set :greedy t
1868 (const :tag "Double bracket links" bracket)
1869 (const :tag "Angular bracket links" angle)
1870 (const :tag "Plain text links" plain)
1871 (const :tag "Radio target matches" radio)
1872 (const :tag "Tags" tag)
1873 (const :tag "Timestamps" date)
1874 (const :tag "Footnotes" footnote)))
1876 (defcustom org-make-link-description-function nil
1877 "Function to use for generating link descriptions from links.
1878 When nil, the link location will be used. This function must take
1879 two parameters: the first one is the link, the second one is the
1880 description generated by `org-insert-link'. The function should
1881 return the description to use."
1882 :group 'org-link
1883 :type '(choice (const nil) (function)))
1885 (defgroup org-link-store nil
1886 "Options concerning storing links in Org-mode."
1887 :tag "Org Store Link"
1888 :group 'org-link)
1890 (defcustom org-url-hexify-p t
1891 "When non-nil, hexify URL when creating a link."
1892 :type 'boolean
1893 :version "24.3"
1894 :group 'org-link-store)
1896 (defcustom org-email-link-description-format "Email %c: %.30s"
1897 "Format of the description part of a link to an email or usenet message.
1898 The following %-escapes will be replaced by corresponding information:
1900 %F full \"From\" field
1901 %f name, taken from \"From\" field, address if no name
1902 %T full \"To\" field
1903 %t first name in \"To\" field, address if no name
1904 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1905 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1906 %s subject
1907 %d date
1908 %m message-id.
1910 You may use normal field width specification between the % and the letter.
1911 This is for example useful to limit the length of the subject.
1913 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1914 :group 'org-link-store
1915 :type 'string)
1917 (defcustom org-from-is-user-regexp
1918 (let (r1 r2)
1919 (when (and user-mail-address (not (string= user-mail-address "")))
1920 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1921 (when (and user-full-name (not (string= user-full-name "")))
1922 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1923 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1924 "Regexp matched against the \"From:\" header of an email or usenet message.
1925 It should match if the message is from the user him/herself."
1926 :group 'org-link-store
1927 :type 'regexp)
1929 (defcustom org-context-in-file-links t
1930 "Non-nil means file links from `org-store-link' contain context.
1931 A search string will be added to the file name with :: as separator and
1932 used to find the context when the link is activated by the command
1933 `org-open-at-point'. When this option is t, the entire active region
1934 will be placed in the search string of the file link. If set to a
1935 positive integer, only the first n lines of context will be stored.
1937 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1938 negates this setting for the duration of the command."
1939 :group 'org-link-store
1940 :type '(choice boolean integer))
1942 (defcustom org-keep-stored-link-after-insertion nil
1943 "Non-nil means keep link in list for entire session.
1945 The command `org-store-link' adds a link pointing to the current
1946 location to an internal list. These links accumulate during a session.
1947 The command `org-insert-link' can be used to insert links into any
1948 Org-mode file (offering completion for all stored links). When this
1949 option is nil, every link which has been inserted once using \\[org-insert-link]
1950 will be removed from the list, to make completing the unused links
1951 more efficient."
1952 :group 'org-link-store
1953 :type 'boolean)
1955 (defgroup org-link-follow nil
1956 "Options concerning following links in Org-mode."
1957 :tag "Org Follow Link"
1958 :group 'org-link)
1960 (defcustom org-link-translation-function nil
1961 "Function to translate links with different syntax to Org syntax.
1962 This can be used to translate links created for example by the Planner
1963 or emacs-wiki packages to Org syntax.
1964 The function must accept two parameters, a TYPE containing the link
1965 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1966 which is everything after the link protocol. It should return a cons
1967 with possibly modified values of type and path.
1968 Org contains a function for this, so if you set this variable to
1969 `org-translate-link-from-planner', you should be able follow many
1970 links created by planner."
1971 :group 'org-link-follow
1972 :type '(choice (const nil) (function)))
1974 (defcustom org-follow-link-hook nil
1975 "Hook that is run after a link has been followed."
1976 :group 'org-link-follow
1977 :type 'hook)
1979 (defcustom org-tab-follows-link nil
1980 "Non-nil means on links TAB will follow the link.
1981 Needs to be set before org.el is loaded.
1982 This really should not be used, it does not make sense, and the
1983 implementation is bad."
1984 :group 'org-link-follow
1985 :type 'boolean)
1987 (defcustom org-return-follows-link nil
1988 "Non-nil means on links RET will follow the link.
1989 In tables, the special behavior of RET has precedence."
1990 :group 'org-link-follow
1991 :type 'boolean)
1993 (defcustom org-mouse-1-follows-link
1994 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1995 "Non-nil means mouse-1 on a link will follow the link.
1996 A longer mouse click will still set point. Does not work on XEmacs.
1997 Needs to be set before org.el is loaded."
1998 :group 'org-link-follow
1999 :version "24.4"
2000 :package-version '(Org . "8.3")
2001 :type '(choice
2002 (const :tag "A double click follows the link" double)
2003 (const :tag "Unconditionally follow the link with mouse-1" t)
2004 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
2006 (defcustom org-mark-ring-length 4
2007 "Number of different positions to be recorded in the ring.
2008 Changing this requires a restart of Emacs to work correctly."
2009 :group 'org-link-follow
2010 :type 'integer)
2012 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2013 "Non-nil means internal links in Org files must exactly match a headline.
2014 When nil, the link search tries to match a phrase with all words
2015 in the search text."
2016 :group 'org-link-follow
2017 :version "24.1"
2018 :type '(choice
2019 (const :tag "Use fuzzy text search" nil)
2020 (const :tag "Match only exact headline" t)
2021 (const :tag "Match exact headline or query to create it"
2022 query-to-create)))
2024 (defcustom org-link-frame-setup
2025 '((vm . vm-visit-folder-other-frame)
2026 (vm-imap . vm-visit-imap-folder-other-frame)
2027 (gnus . org-gnus-no-new-news)
2028 (file . find-file-other-window)
2029 (wl . wl-other-frame))
2030 "Setup the frame configuration for following links.
2031 When following a link with Emacs, it may often be useful to display
2032 this link in another window or frame. This variable can be used to
2033 set this up for the different types of links.
2034 For VM, use any of
2035 `vm-visit-folder'
2036 `vm-visit-folder-other-window'
2037 `vm-visit-folder-other-frame'
2038 For Gnus, use any of
2039 `gnus'
2040 `gnus-other-frame'
2041 `org-gnus-no-new-news'
2042 For FILE, use any of
2043 `find-file'
2044 `find-file-other-window'
2045 `find-file-other-frame'
2046 For Wanderlust use any of
2047 `wl'
2048 `wl-other-frame'
2049 For the calendar, use the variable `calendar-setup'.
2050 For BBDB, it is currently only possible to display the matches in
2051 another window."
2052 :group 'org-link-follow
2053 :type '(list
2054 (cons (const vm)
2055 (choice
2056 (const vm-visit-folder)
2057 (const vm-visit-folder-other-window)
2058 (const vm-visit-folder-other-frame)))
2059 (cons (const vm-imap)
2060 (choice
2061 (const vm-visit-imap-folder)
2062 (const vm-visit-imap-folder-other-window)
2063 (const vm-visit-imap-folder-other-frame)))
2064 (cons (const gnus)
2065 (choice
2066 (const gnus)
2067 (const gnus-other-frame)
2068 (const org-gnus-no-new-news)))
2069 (cons (const file)
2070 (choice
2071 (const find-file)
2072 (const find-file-other-window)
2073 (const find-file-other-frame)))
2074 (cons (const wl)
2075 (choice
2076 (const wl)
2077 (const wl-other-frame)))))
2079 (defcustom org-display-internal-link-with-indirect-buffer nil
2080 "Non-nil means use indirect buffer to display infile links.
2081 Activating internal links (from one location in a file to another location
2082 in the same file) normally just jumps to the location. When the link is
2083 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2084 is displayed in
2085 another window. When this option is set, the other window actually displays
2086 an indirect buffer clone of the current buffer, to avoid any visibility
2087 changes to the current buffer."
2088 :group 'org-link-follow
2089 :type 'boolean)
2091 (defcustom org-open-non-existing-files nil
2092 "Non-nil means `org-open-file' will open non-existing files.
2093 When nil, an error will be generated.
2094 This variable applies only to external applications because they
2095 might choke on non-existing files. If the link is to a file that
2096 will be opened in Emacs, the variable is ignored."
2097 :group 'org-link-follow
2098 :type 'boolean)
2100 (defcustom org-open-directory-means-index-dot-org nil
2101 "Non-nil means a link to a directory really means to index.org.
2102 When nil, following a directory link will run dired or open a finder/explorer
2103 window on that directory."
2104 :group 'org-link-follow
2105 :type 'boolean)
2107 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2108 "Non-nil means ask for confirmation before executing shell links.
2109 Shell links can be dangerous: just think about a link
2111 [[shell:rm -rf ~/*][Google Search]]
2113 This link would show up in your Org-mode document as \"Google Search\",
2114 but really it would remove your entire home directory.
2115 Therefore we advise against setting this variable to nil.
2116 Just change it to `y-or-n-p' if you want to confirm with a
2117 single keystroke rather than having to type \"yes\"."
2118 :group 'org-link-follow
2119 :type '(choice
2120 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2121 (const :tag "with y-or-n (faster)" y-or-n-p)
2122 (const :tag "no confirmation (dangerous)" nil)))
2123 (put 'org-confirm-shell-link-function
2124 'safe-local-variable
2125 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2127 (defcustom org-confirm-shell-link-not-regexp ""
2128 "A regexp to skip confirmation for shell links."
2129 :group 'org-link-follow
2130 :version "24.1"
2131 :type 'regexp)
2133 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2134 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2135 Elisp links can be dangerous: just think about a link
2137 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2139 This link would show up in your Org-mode document as \"Google Search\",
2140 but really it would remove your entire home directory.
2141 Therefore we advise against setting this variable to nil.
2142 Just change it to `y-or-n-p' if you want to confirm with a
2143 single keystroke rather than having to type \"yes\"."
2144 :group 'org-link-follow
2145 :type '(choice
2146 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2147 (const :tag "with y-or-n (faster)" y-or-n-p)
2148 (const :tag "no confirmation (dangerous)" nil)))
2149 (put 'org-confirm-shell-link-function
2150 'safe-local-variable
2151 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2153 (defcustom org-confirm-elisp-link-not-regexp ""
2154 "A regexp to skip confirmation for Elisp links."
2155 :group 'org-link-follow
2156 :version "24.1"
2157 :type 'regexp)
2159 (defconst org-file-apps-defaults-gnu
2160 '((remote . emacs)
2161 (system . mailcap)
2162 (t . mailcap))
2163 "Default file applications on a UNIX or GNU/Linux system.
2164 See `org-file-apps'.")
2166 (defconst org-file-apps-defaults-macosx
2167 '((remote . emacs)
2168 (t . "open %s")
2169 (system . "open %s")
2170 ("ps.gz" . "gv %s")
2171 ("eps.gz" . "gv %s")
2172 ("dvi" . "xdvi %s")
2173 ("fig" . "xfig %s"))
2174 "Default file applications on a MacOS X system.
2175 The system \"open\" is known as a default, but we use X11 applications
2176 for some files for which the OS does not have a good default.
2177 See `org-file-apps'.")
2179 (defconst org-file-apps-defaults-windowsnt
2180 (list
2181 '(remote . emacs)
2182 (cons t
2183 (list (if (featurep 'xemacs)
2184 'mswindows-shell-execute
2185 'w32-shell-execute)
2186 "open" 'file))
2187 (cons 'system
2188 (list (if (featurep 'xemacs)
2189 'mswindows-shell-execute
2190 'w32-shell-execute)
2191 "open" 'file)))
2192 "Default file applications on a Windows NT system.
2193 The system \"open\" is used for most files.
2194 See `org-file-apps'.")
2196 (defcustom org-file-apps
2197 '((auto-mode . emacs)
2198 ("\\.mm\\'" . default)
2199 ("\\.x?html?\\'" . default)
2200 ("\\.pdf\\'" . default))
2201 "External applications for opening `file:path' items in a document.
2202 Org-mode uses system defaults for different file types, but
2203 you can use this variable to set the application for a given file
2204 extension. The entries in this list are cons cells where the car identifies
2205 files and the cdr the corresponding command. Possible values for the
2206 file identifier are
2207 \"string\" A string as a file identifier can be interpreted in different
2208 ways, depending on its contents:
2210 - Alphanumeric characters only:
2211 Match links with this file extension.
2212 Example: (\"pdf\" . \"evince %s\")
2213 to open PDFs with evince.
2215 - Regular expression: Match links where the
2216 filename matches the regexp. If you want to
2217 use groups here, use shy groups.
2219 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2220 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2221 to open *.html and *.xhtml with firefox.
2223 - Regular expression which contains (non-shy) groups:
2224 Match links where the whole link, including \"::\", and
2225 anything after that, matches the regexp.
2226 In a custom command string, %1, %2, etc. are replaced with
2227 the parts of the link that were matched by the groups.
2228 For backwards compatibility, if a command string is given
2229 that does not use any of the group matches, this case is
2230 handled identically to the second one (i.e. match against
2231 file name only).
2232 In a custom lisp form, you can access the group matches with
2233 (match-string n link).
2235 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2236 to open [[file:document.pdf::5]] with evince at page 5.
2238 `directory' Matches a directory
2239 `remote' Matches a remote file, accessible through tramp or efs.
2240 Remote files most likely should be visited through Emacs
2241 because external applications cannot handle such paths.
2242 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2243 so all files Emacs knows how to handle. Using this with
2244 command `emacs' will open most files in Emacs. Beware that this
2245 will also open html files inside Emacs, unless you add
2246 (\"html\" . default) to the list as well.
2247 t Default for files not matched by any of the other options.
2248 `system' The system command to open files, like `open' on Windows
2249 and Mac OS X, and mailcap under GNU/Linux. This is the command
2250 that will be selected if you call `C-c C-o' with a double
2251 \\[universal-argument] \\[universal-argument] prefix.
2253 Possible values for the command are:
2254 `emacs' The file will be visited by the current Emacs process.
2255 `default' Use the default application for this file type, which is the
2256 association for t in the list, most likely in the system-specific
2257 part.
2258 This can be used to overrule an unwanted setting in the
2259 system-specific variable.
2260 `system' Use the system command for opening files, like \"open\".
2261 This command is specified by the entry whose car is `system'.
2262 Most likely, the system-specific version of this variable
2263 does define this command, but you can overrule/replace it
2264 here.
2265 string A command to be executed by a shell; %s will be replaced
2266 by the path to the file.
2267 sexp A Lisp form which will be evaluated. The file path will
2268 be available in the Lisp variable `file'.
2269 For more examples, see the system specific constants
2270 `org-file-apps-defaults-macosx'
2271 `org-file-apps-defaults-windowsnt'
2272 `org-file-apps-defaults-gnu'."
2273 :group 'org-link-follow
2274 :type '(repeat
2275 (cons (choice :value ""
2276 (string :tag "Extension")
2277 (const :tag "System command to open files" system)
2278 (const :tag "Default for unrecognized files" t)
2279 (const :tag "Remote file" remote)
2280 (const :tag "Links to a directory" directory)
2281 (const :tag "Any files that have Emacs modes"
2282 auto-mode))
2283 (choice :value ""
2284 (const :tag "Visit with Emacs" emacs)
2285 (const :tag "Use default" default)
2286 (const :tag "Use the system command" system)
2287 (string :tag "Command")
2288 (sexp :tag "Lisp form")))))
2290 (defcustom org-doi-server-url "http://dx.doi.org/"
2291 "The URL of the DOI server."
2292 :type 'string
2293 :version "24.3"
2294 :group 'org-link-follow)
2296 (defgroup org-refile nil
2297 "Options concerning refiling entries in Org-mode."
2298 :tag "Org Refile"
2299 :group 'org)
2301 (defcustom org-directory "~/org"
2302 "Directory with org files.
2303 This is just a default location to look for Org files. There is no need
2304 at all to put your files into this directory. It is only used in the
2305 following situations:
2307 1. When a capture template specifies a target file that is not an
2308 absolute path. The path will then be interpreted relative to
2309 `org-directory'
2310 2. When a capture note is filed away in an interactive way (when exiting the
2311 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2312 with `org-directory' as the default path."
2313 :group 'org-refile
2314 :group 'org-capture
2315 :type 'directory)
2317 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2318 "Default target for storing notes.
2319 Used as a fall back file for org-capture.el, for templates that
2320 do not specify a target file."
2321 :group 'org-refile
2322 :group 'org-capture
2323 :type '(choice
2324 (const :tag "Default from remember-data-file" nil)
2325 file))
2327 (defcustom org-goto-interface 'outline
2328 "The default interface to be used for `org-goto'.
2329 Allowed values are:
2330 outline The interface shows an outline of the relevant file
2331 and the correct heading is found by moving through
2332 the outline or by searching with incremental search.
2333 outline-path-completion Headlines in the current buffer are offered via
2334 completion. This is the interface also used by
2335 the refile command."
2336 :group 'org-refile
2337 :type '(choice
2338 (const :tag "Outline" outline)
2339 (const :tag "Outline-path-completion" outline-path-completion)))
2341 (defcustom org-goto-max-level 5
2342 "Maximum target level when running `org-goto' with refile interface."
2343 :group 'org-refile
2344 :type 'integer)
2346 (defcustom org-reverse-note-order nil
2347 "Non-nil means store new notes at the beginning of a file or entry.
2348 When nil, new notes will be filed to the end of a file or entry.
2349 This can also be a list with cons cells of regular expressions that
2350 are matched against file names, and values."
2351 :group 'org-capture
2352 :group 'org-refile
2353 :type '(choice
2354 (const :tag "Reverse always" t)
2355 (const :tag "Reverse never" nil)
2356 (repeat :tag "By file name regexp"
2357 (cons regexp boolean))))
2359 (defcustom org-log-refile nil
2360 "Information to record when a task is refiled.
2362 Possible values are:
2364 nil Don't add anything
2365 time Add a time stamp to the task
2366 note Prompt for a note and add it with template `org-log-note-headings'
2368 This option can also be set with on a per-file-basis with
2370 #+STARTUP: nologrefile
2371 #+STARTUP: logrefile
2372 #+STARTUP: lognoterefile
2374 You can have local logging settings for a subtree by setting the LOGGING
2375 property to one or more of these keywords.
2377 When bulk-refiling from the agenda, the value `note' is forbidden and
2378 will temporarily be changed to `time'."
2379 :group 'org-refile
2380 :group 'org-progress
2381 :version "24.1"
2382 :type '(choice
2383 (const :tag "No logging" nil)
2384 (const :tag "Record timestamp" time)
2385 (const :tag "Record timestamp with note." note)))
2387 (defcustom org-refile-targets nil
2388 "Targets for refiling entries with \\[org-refile].
2389 This is a list of cons cells. Each cell contains:
2390 - a specification of the files to be considered, either a list of files,
2391 or a symbol whose function or variable value will be used to retrieve
2392 a file name or a list of file names. If you use `org-agenda-files' for
2393 that, all agenda files will be scanned for targets. Nil means consider
2394 headings in the current buffer.
2395 - A specification of how to find candidate refile targets. This may be
2396 any of:
2397 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2398 This tag has to be present in all target headlines, inheritance will
2399 not be considered.
2400 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2401 todo keyword.
2402 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2403 headlines that are refiling targets.
2404 - a cons cell (:level . N). Any headline of level N is considered a target.
2405 Note that, when `org-odd-levels-only' is set, level corresponds to
2406 order in hierarchy, not to the number of stars.
2407 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2408 Note that, when `org-odd-levels-only' is set, level corresponds to
2409 order in hierarchy, not to the number of stars.
2411 Each element of this list generates a set of possible targets.
2412 The union of these sets is presented (with completion) to
2413 the user by `org-refile'.
2415 You can set the variable `org-refile-target-verify-function' to a function
2416 to verify each headline found by the simple criteria above.
2418 When this variable is nil, all top-level headlines in the current buffer
2419 are used, equivalent to the value `((nil . (:level . 1))'."
2420 :group 'org-refile
2421 :type '(repeat
2422 (cons
2423 (choice :value org-agenda-files
2424 (const :tag "All agenda files" org-agenda-files)
2425 (const :tag "Current buffer" nil)
2426 (function) (variable) (file))
2427 (choice :tag "Identify target headline by"
2428 (cons :tag "Specific tag" (const :value :tag) (string))
2429 (cons :tag "TODO keyword" (const :value :todo) (string))
2430 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2431 (cons :tag "Level number" (const :value :level) (integer))
2432 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2434 (defcustom org-refile-target-verify-function nil
2435 "Function to verify if the headline at point should be a refile target.
2436 The function will be called without arguments, with point at the
2437 beginning of the headline. It should return t and leave point
2438 where it is if the headline is a valid target for refiling.
2440 If the target should not be selected, the function must return nil.
2441 In addition to this, it may move point to a place from where the search
2442 should be continued. For example, the function may decide that the entire
2443 subtree of the current entry should be excluded and move point to the end
2444 of the subtree."
2445 :group 'org-refile
2446 :type '(choice
2447 (const nil)
2448 (function)))
2450 (defcustom org-refile-use-cache nil
2451 "Non-nil means cache refile targets to speed up the process.
2452 The cache for a particular file will be updated automatically when
2453 the buffer has been killed, or when any of the marker used for flagging
2454 refile targets no longer points at a live buffer.
2455 If you have added new entries to a buffer that might themselves be targets,
2456 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2457 find that easier, `C-u C-u C-u C-c C-w'."
2458 :group 'org-refile
2459 :version "24.1"
2460 :type 'boolean)
2462 (defcustom org-refile-use-outline-path nil
2463 "Non-nil means provide refile targets as paths.
2464 So a level 3 headline will be available as level1/level2/level3.
2466 When the value is `file', also include the file name (without directory)
2467 into the path. In this case, you can also stop the completion after
2468 the file name, to get entries inserted as top level in the file.
2470 When `full-file-path', include the full file path."
2471 :group 'org-refile
2472 :type '(choice
2473 (const :tag "Not" nil)
2474 (const :tag "Yes" t)
2475 (const :tag "Start with file name" file)
2476 (const :tag "Start with full file path" full-file-path)))
2478 (defcustom org-outline-path-complete-in-steps t
2479 "Non-nil means complete the outline path in hierarchical steps.
2480 When Org-mode uses the refile interface to select an outline path
2481 \(see variable `org-refile-use-outline-path'), the completion of
2482 the path can be done is a single go, or if can be done in steps down
2483 the headline hierarchy. Going in steps is probably the best if you
2484 do not use a special completion package like `ido' or `icicles'.
2485 However, when using these packages, going in one step can be very
2486 fast, while still showing the whole path to the entry."
2487 :group 'org-refile
2488 :type 'boolean)
2490 (defcustom org-refile-allow-creating-parent-nodes nil
2491 "Non-nil means allow to create new nodes as refile targets.
2492 New nodes are then created by adding \"/new node name\" to the completion
2493 of an existing node. When the value of this variable is `confirm',
2494 new node creation must be confirmed by the user (recommended).
2495 When nil, the completion must match an existing entry.
2497 Note that, if the new heading is not seen by the criteria
2498 listed in `org-refile-targets', multiple instances of the same
2499 heading would be created by trying again to file under the new
2500 heading."
2501 :group 'org-refile
2502 :type '(choice
2503 (const :tag "Never" nil)
2504 (const :tag "Always" t)
2505 (const :tag "Prompt for confirmation" confirm)))
2507 (defcustom org-refile-active-region-within-subtree nil
2508 "Non-nil means also refile active region within a subtree.
2510 By default `org-refile' doesn't allow refiling regions if they
2511 don't contain a set of subtrees, but it might be convenient to
2512 do so sometimes: in that case, the first line of the region is
2513 converted to a headline before refiling."
2514 :group 'org-refile
2515 :version "24.1"
2516 :type 'boolean)
2518 (defgroup org-todo nil
2519 "Options concerning TODO items in Org-mode."
2520 :tag "Org TODO"
2521 :group 'org)
2523 (defgroup org-progress nil
2524 "Options concerning Progress logging in Org-mode."
2525 :tag "Org Progress"
2526 :group 'org-time)
2528 (defvar org-todo-interpretation-widgets
2529 '((:tag "Sequence (cycling hits every state)" sequence)
2530 (:tag "Type (cycling directly to DONE)" type))
2531 "The available interpretation symbols for customizing `org-todo-keywords'.
2532 Interested libraries should add to this list.")
2534 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2535 "List of TODO entry keyword sequences and their interpretation.
2536 \\<org-mode-map>This is a list of sequences.
2538 Each sequence starts with a symbol, either `sequence' or `type',
2539 indicating if the keywords should be interpreted as a sequence of
2540 action steps, or as different types of TODO items. The first
2541 keywords are states requiring action - these states will select a headline
2542 for inclusion into the global TODO list Org-mode produces. If one of
2543 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2544 signify that no further action is necessary. If \"|\" is not found,
2545 the last keyword is treated as the only DONE state of the sequence.
2547 The command \\[org-todo] cycles an entry through these states, and one
2548 additional state where no keyword is present. For details about this
2549 cycling, see the manual.
2551 TODO keywords and interpretation can also be set on a per-file basis with
2552 the special #+SEQ_TODO and #+TYP_TODO lines.
2554 Each keyword can optionally specify a character for fast state selection
2555 \(in combination with the variable `org-use-fast-todo-selection')
2556 and specifiers for state change logging, using the same syntax that
2557 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2558 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2559 indicates to record a time stamp each time this state is selected.
2561 Each keyword may also specify if a timestamp or a note should be
2562 recorded when entering or leaving the state, by adding additional
2563 characters in the parenthesis after the keyword. This looks like this:
2564 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2565 record only the time of the state change. With X and Y being either
2566 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2567 Y when leaving the state if and only if the *target* state does not
2568 define X. You may omit any of the fast-selection key or X or /Y,
2569 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2571 For backward compatibility, this variable may also be just a list
2572 of keywords. In this case the interpretation (sequence or type) will be
2573 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2574 :group 'org-todo
2575 :group 'org-keywords
2576 :type '(choice
2577 (repeat :tag "Old syntax, just keywords"
2578 (string :tag "Keyword"))
2579 (repeat :tag "New syntax"
2580 (cons
2581 (choice
2582 :tag "Interpretation"
2583 ;;Quick and dirty way to see
2584 ;;`org-todo-interpretations'. This takes the
2585 ;;place of item arguments
2586 :convert-widget
2587 (lambda (widget)
2588 (widget-put widget
2589 :args (mapcar
2590 (lambda (x)
2591 (widget-convert
2592 (cons 'const x)))
2593 org-todo-interpretation-widgets))
2594 widget))
2595 (repeat
2596 (string :tag "Keyword"))))))
2598 (defvar org-todo-keywords-1 nil
2599 "All TODO and DONE keywords active in a buffer.")
2600 (make-variable-buffer-local 'org-todo-keywords-1)
2601 (defvar org-todo-keywords-for-agenda nil)
2602 (defvar org-done-keywords-for-agenda nil)
2603 (defvar org-todo-keyword-alist-for-agenda nil)
2604 (defvar org-tag-alist-for-agenda nil
2605 "Alist of all tags from all agenda files.")
2606 (defvar org-tag-groups-alist-for-agenda nil
2607 "Alist of all groups tags from all current agenda files.")
2608 (defvar org-tag-groups-alist nil)
2609 (make-variable-buffer-local 'org-tag-groups-alist)
2610 (defvar org-agenda-contributing-files nil)
2611 (defvar org-not-done-keywords nil)
2612 (make-variable-buffer-local 'org-not-done-keywords)
2613 (defvar org-done-keywords nil)
2614 (make-variable-buffer-local 'org-done-keywords)
2615 (defvar org-todo-heads nil)
2616 (make-variable-buffer-local 'org-todo-heads)
2617 (defvar org-todo-sets nil)
2618 (make-variable-buffer-local 'org-todo-sets)
2619 (defvar org-todo-log-states nil)
2620 (make-variable-buffer-local 'org-todo-log-states)
2621 (defvar org-todo-kwd-alist nil)
2622 (make-variable-buffer-local 'org-todo-kwd-alist)
2623 (defvar org-todo-key-alist nil)
2624 (make-variable-buffer-local 'org-todo-key-alist)
2625 (defvar org-todo-key-trigger nil)
2626 (make-variable-buffer-local 'org-todo-key-trigger)
2628 (defcustom org-todo-interpretation 'sequence
2629 "Controls how TODO keywords are interpreted.
2630 This variable is in principle obsolete and is only used for
2631 backward compatibility, if the interpretation of todo keywords is
2632 not given already in `org-todo-keywords'. See that variable for
2633 more information."
2634 :group 'org-todo
2635 :group 'org-keywords
2636 :type '(choice (const sequence)
2637 (const type)))
2639 (defcustom org-use-fast-todo-selection t
2640 "Non-nil means use the fast todo selection scheme with C-c C-t.
2641 This variable describes if and under what circumstances the cycling
2642 mechanism for TODO keywords will be replaced by a single-key, direct
2643 selection scheme.
2645 When nil, fast selection is never used.
2647 When the symbol `prefix', it will be used when `org-todo' is called
2648 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2649 `C-u t' in an agenda buffer.
2651 When t, fast selection is used by default. In this case, the prefix
2652 argument forces cycling instead.
2654 In all cases, the special interface is only used if access keys have
2655 actually been assigned by the user, i.e. if keywords in the configuration
2656 are followed by a letter in parenthesis, like TODO(t)."
2657 :group 'org-todo
2658 :type '(choice
2659 (const :tag "Never" nil)
2660 (const :tag "By default" t)
2661 (const :tag "Only with C-u C-c C-t" prefix)))
2663 (defcustom org-provide-todo-statistics t
2664 "Non-nil means update todo statistics after insert and toggle.
2665 ALL-HEADLINES means update todo statistics by including headlines
2666 with no TODO keyword as well, counting them as not done.
2667 A list of TODO keywords means the same, but skip keywords that are
2668 not in this list.
2669 When set to a list of two lists, the first list contains keywords
2670 to consider as TODO keywords, the second list contains keywords
2671 to consider as DONE keywords.
2673 When this is set, todo statistics is updated in the parent of the
2674 current entry each time a todo state is changed."
2675 :group 'org-todo
2676 :type '(choice
2677 (const :tag "Yes, only for TODO entries" t)
2678 (const :tag "Yes, including all entries" all-headlines)
2679 (repeat :tag "Yes, for TODOs in this list"
2680 (string :tag "TODO keyword"))
2681 (list :tag "Yes, for TODOs and DONEs in these lists"
2682 (repeat (string :tag "TODO keyword"))
2683 (repeat (string :tag "DONE keyword")))
2684 (other :tag "No TODO statistics" nil)))
2686 (defcustom org-hierarchical-todo-statistics t
2687 "Non-nil means TODO statistics covers just direct children.
2688 When nil, all entries in the subtree are considered.
2689 This has only an effect if `org-provide-todo-statistics' is set.
2690 To set this to nil for only a single subtree, use a COOKIE_DATA
2691 property and include the word \"recursive\" into the value."
2692 :group 'org-todo
2693 :type 'boolean)
2695 (defcustom org-after-todo-state-change-hook nil
2696 "Hook which is run after the state of a TODO item was changed.
2697 The new state (a string with a TODO keyword, or nil) is available in the
2698 Lisp variable `org-state'."
2699 :group 'org-todo
2700 :type 'hook)
2702 (defvar org-blocker-hook nil
2703 "Hook for functions that are allowed to block a state change.
2705 Functions in this hook should not modify the buffer.
2706 Each function gets as its single argument a property list,
2707 see `org-trigger-hook' for more information about this list.
2709 If any of the functions in this hook returns nil, the state change
2710 is blocked.")
2712 (defvar org-trigger-hook nil
2713 "Hook for functions that are triggered by a state change.
2715 Each function gets as its single argument a property list with at
2716 least the following elements:
2718 (:type type-of-change :position pos-at-entry-start
2719 :from old-state :to new-state)
2721 Depending on the type, more properties may be present.
2723 This mechanism is currently implemented for:
2725 TODO state changes
2726 ------------------
2727 :type todo-state-change
2728 :from previous state (keyword as a string), or nil, or a symbol
2729 'todo' or 'done', to indicate the general type of state.
2730 :to new state, like in :from")
2732 (defcustom org-enforce-todo-dependencies nil
2733 "Non-nil means undone TODO entries will block switching the parent to DONE.
2734 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2735 be blocked if any prior sibling is not yet done.
2736 Finally, if the parent is blocked because of ordered siblings of its own,
2737 the child will also be blocked."
2738 :set (lambda (var val)
2739 (set var val)
2740 (if val
2741 (add-hook 'org-blocker-hook
2742 'org-block-todo-from-children-or-siblings-or-parent)
2743 (remove-hook 'org-blocker-hook
2744 'org-block-todo-from-children-or-siblings-or-parent)))
2745 :group 'org-todo
2746 :type 'boolean)
2748 (defcustom org-enforce-todo-checkbox-dependencies nil
2749 "Non-nil means unchecked boxes will block switching the parent to DONE.
2750 When this is nil, checkboxes have no influence on switching TODO states.
2751 When non-nil, you first need to check off all check boxes before the TODO
2752 entry can be switched to DONE.
2753 This variable needs to be set before org.el is loaded, and you need to
2754 restart Emacs after a change to make the change effective. The only way
2755 to change is while Emacs is running is through the customize interface."
2756 :set (lambda (var val)
2757 (set var val)
2758 (if val
2759 (add-hook 'org-blocker-hook
2760 'org-block-todo-from-checkboxes)
2761 (remove-hook 'org-blocker-hook
2762 'org-block-todo-from-checkboxes)))
2763 :group 'org-todo
2764 :type 'boolean)
2766 (defcustom org-treat-insert-todo-heading-as-state-change nil
2767 "Non-nil means inserting a TODO heading is treated as state change.
2768 So when the command \\[org-insert-todo-heading] is used, state change
2769 logging will apply if appropriate. When nil, the new TODO item will
2770 be inserted directly, and no logging will take place."
2771 :group 'org-todo
2772 :type 'boolean)
2774 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2775 "Non-nil means switching TODO states with S-cursor counts as state change.
2776 This is the default behavior. However, setting this to nil allows a
2777 convenient way to select a TODO state and bypass any logging associated
2778 with that."
2779 :group 'org-todo
2780 :type 'boolean)
2782 (defcustom org-todo-state-tags-triggers nil
2783 "Tag changes that should be triggered by TODO state changes.
2784 This is a list. Each entry is
2786 (state-change (tag . flag) .......)
2788 State-change can be a string with a state, and empty string to indicate the
2789 state that has no TODO keyword, or it can be one of the symbols `todo'
2790 or `done', meaning any not-done or done state, respectively."
2791 :group 'org-todo
2792 :group 'org-tags
2793 :type '(repeat
2794 (cons (choice :tag "When changing to"
2795 (const :tag "Not-done state" todo)
2796 (const :tag "Done state" done)
2797 (string :tag "State"))
2798 (repeat
2799 (cons :tag "Tag action"
2800 (string :tag "Tag")
2801 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2803 (defcustom org-log-done nil
2804 "Information to record when a task moves to the DONE state.
2806 Possible values are:
2808 nil Don't add anything, just change the keyword
2809 time Add a time stamp to the task
2810 note Prompt for a note and add it with template `org-log-note-headings'
2812 This option can also be set with on a per-file-basis with
2814 #+STARTUP: nologdone
2815 #+STARTUP: logdone
2816 #+STARTUP: lognotedone
2818 You can have local logging settings for a subtree by setting the LOGGING
2819 property to one or more of these keywords."
2820 :group 'org-todo
2821 :group 'org-progress
2822 :type '(choice
2823 (const :tag "No logging" nil)
2824 (const :tag "Record CLOSED timestamp" time)
2825 (const :tag "Record CLOSED timestamp with note." note)))
2827 ;; Normalize old uses of org-log-done.
2828 (cond
2829 ((eq org-log-done t) (setq org-log-done 'time))
2830 ((and (listp org-log-done) (memq 'done org-log-done))
2831 (setq org-log-done 'note)))
2833 (defcustom org-log-reschedule nil
2834 "Information to record when the scheduling date of a tasks is modified.
2836 Possible values are:
2838 nil Don't add anything, just change the date
2839 time Add a time stamp to the task
2840 note Prompt for a note and add it with template `org-log-note-headings'
2842 This option can also be set with on a per-file-basis with
2844 #+STARTUP: nologreschedule
2845 #+STARTUP: logreschedule
2846 #+STARTUP: lognotereschedule"
2847 :group 'org-todo
2848 :group 'org-progress
2849 :type '(choice
2850 (const :tag "No logging" nil)
2851 (const :tag "Record timestamp" time)
2852 (const :tag "Record timestamp with note." note)))
2854 (defcustom org-log-redeadline nil
2855 "Information to record when the deadline date of a tasks is modified.
2857 Possible values are:
2859 nil Don't add anything, just change the date
2860 time Add a time stamp to the task
2861 note Prompt for a note and add it with template `org-log-note-headings'
2863 This option can also be set with on a per-file-basis with
2865 #+STARTUP: nologredeadline
2866 #+STARTUP: logredeadline
2867 #+STARTUP: lognoteredeadline
2869 You can have local logging settings for a subtree by setting the LOGGING
2870 property to one or more of these keywords."
2871 :group 'org-todo
2872 :group 'org-progress
2873 :type '(choice
2874 (const :tag "No logging" nil)
2875 (const :tag "Record timestamp" time)
2876 (const :tag "Record timestamp with note." note)))
2878 (defcustom org-log-note-clock-out nil
2879 "Non-nil means record a note when clocking out of an item.
2880 This can also be configured on a per-file basis by adding one of
2881 the following lines anywhere in the buffer:
2883 #+STARTUP: lognoteclock-out
2884 #+STARTUP: nolognoteclock-out"
2885 :group 'org-todo
2886 :group 'org-progress
2887 :type 'boolean)
2889 (defcustom org-log-done-with-time t
2890 "Non-nil means the CLOSED time stamp will contain date and time.
2891 When nil, only the date will be recorded."
2892 :group 'org-progress
2893 :type 'boolean)
2895 (defcustom org-log-note-headings
2896 '((done . "CLOSING NOTE %t")
2897 (state . "State %-12s from %-12S %t")
2898 (note . "Note taken on %t")
2899 (reschedule . "Rescheduled from %S on %t")
2900 (delschedule . "Not scheduled, was %S on %t")
2901 (redeadline . "New deadline from %S on %t")
2902 (deldeadline . "Removed deadline, was %S on %t")
2903 (refile . "Refiled on %t")
2904 (clock-out . ""))
2905 "Headings for notes added to entries.
2906 The value is an alist, with the car being a symbol indicating the note
2907 context, and the cdr is the heading to be used. The heading may also be the
2908 empty string.
2909 %t in the heading will be replaced by a time stamp.
2910 %T will be an active time stamp instead the default inactive one
2911 %d will be replaced by a short-format time stamp.
2912 %D will be replaced by an active short-format time stamp.
2913 %s will be replaced by the new TODO state, in double quotes.
2914 %S will be replaced by the old TODO state, in double quotes.
2915 %u will be replaced by the user name.
2916 %U will be replaced by the full user name.
2918 In fact, it is not a good idea to change the `state' entry, because
2919 agenda log mode depends on the format of these entries."
2920 :group 'org-todo
2921 :group 'org-progress
2922 :type '(list :greedy t
2923 (cons (const :tag "Heading when closing an item" done) string)
2924 (cons (const :tag
2925 "Heading when changing todo state (todo sequence only)"
2926 state) string)
2927 (cons (const :tag "Heading when just taking a note" note) string)
2928 (cons (const :tag "Heading when rescheduling" reschedule) string)
2929 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2930 (cons (const :tag "Heading when changing deadline" redeadline) string)
2931 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2932 (cons (const :tag "Heading when refiling" refile) string)
2933 (cons (const :tag "Heading when clocking out" clock-out) string)))
2935 (unless (assq 'note org-log-note-headings)
2936 (push '(note . "%t") org-log-note-headings))
2938 (defcustom org-log-into-drawer nil
2939 "Non-nil means insert state change notes and time stamps into a drawer.
2940 When nil, state changes notes will be inserted after the headline and
2941 any scheduling and clock lines, but not inside a drawer.
2943 The value of this variable should be the name of the drawer to use.
2944 LOGBOOK is proposed as the default drawer for this purpose, you can
2945 also set this to a string to define the drawer of your choice.
2947 A value of t is also allowed, representing \"LOGBOOK\".
2949 A value of t or nil can also be set with on a per-file-basis with
2951 #+STARTUP: logdrawer
2952 #+STARTUP: nologdrawer
2954 If this variable is set, `org-log-state-notes-insert-after-drawers'
2955 will be ignored.
2957 You can set the property LOG_INTO_DRAWER to overrule this setting for
2958 a subtree.
2960 Do not check directly this variable in a Lisp program. Call
2961 function `org-log-into-drawer' instead."
2962 :group 'org-todo
2963 :group 'org-progress
2964 :type '(choice
2965 (const :tag "Not into a drawer" nil)
2966 (const :tag "LOGBOOK" t)
2967 (string :tag "Other")))
2969 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2971 (defun org-log-into-drawer ()
2972 "Name of the log drawer, as a string, or nil.
2973 This is the value of `org-log-into-drawer'. However, if the
2974 current entry has or inherits a LOG_INTO_DRAWER property, it will
2975 be used instead of the default value."
2976 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2977 (cond ((equal p "nil") nil)
2978 ((equal p "t") "LOGBOOK")
2979 ((stringp p) p)
2980 (p "LOGBOOK")
2981 ((stringp org-log-into-drawer) org-log-into-drawer)
2982 (org-log-into-drawer "LOGBOOK"))))
2984 (defcustom org-log-state-notes-insert-after-drawers nil
2985 "Non-nil means insert state change notes after any drawers in entry.
2986 Only the drawers that *immediately* follow the headline and the
2987 deadline/scheduled line are skipped.
2988 When nil, insert notes right after the heading and perhaps the line
2989 with deadline/scheduling if present.
2991 This variable will have no effect if `org-log-into-drawer' is
2992 set."
2993 :group 'org-todo
2994 :group 'org-progress
2995 :type 'boolean)
2997 (defcustom org-log-states-order-reversed t
2998 "Non-nil means the latest state note will be directly after heading.
2999 When nil, the state change notes will be ordered according to time.
3001 This option can also be set with on a per-file-basis with
3003 #+STARTUP: logstatesreversed
3004 #+STARTUP: nologstatesreversed"
3005 :group 'org-todo
3006 :group 'org-progress
3007 :type 'boolean)
3009 (defcustom org-todo-repeat-to-state nil
3010 "The TODO state to which a repeater should return the repeating task.
3011 By default this is the first task in a TODO sequence, or the previous state
3012 in a TODO_TYP set. But you can specify another task here.
3013 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3014 :group 'org-todo
3015 :version "24.1"
3016 :type '(choice (const :tag "Head of sequence" nil)
3017 (string :tag "Specific state")))
3019 (defcustom org-log-repeat 'time
3020 "Non-nil means record moving through the DONE state when triggering repeat.
3021 An auto-repeating task is immediately switched back to TODO when
3022 marked DONE. If you are not logging state changes (by adding \"@\"
3023 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3024 record a closing note, there will be no record of the task moving
3025 through DONE. This variable forces taking a note anyway.
3027 nil Don't force a record
3028 time Record a time stamp
3029 note Prompt for a note and add it with template `org-log-note-headings'
3031 This option can also be set with on a per-file-basis with
3033 #+STARTUP: nologrepeat
3034 #+STARTUP: logrepeat
3035 #+STARTUP: lognoterepeat
3037 You can have local logging settings for a subtree by setting the LOGGING
3038 property to one or more of these keywords."
3039 :group 'org-todo
3040 :group 'org-progress
3041 :type '(choice
3042 (const :tag "Don't force a record" nil)
3043 (const :tag "Force recording the DONE state" time)
3044 (const :tag "Force recording a note with the DONE state" note)))
3047 (defgroup org-priorities nil
3048 "Priorities in Org-mode."
3049 :tag "Org Priorities"
3050 :group 'org-todo)
3052 (defcustom org-enable-priority-commands t
3053 "Non-nil means priority commands are active.
3054 When nil, these commands will be disabled, so that you never accidentally
3055 set a priority."
3056 :group 'org-priorities
3057 :type 'boolean)
3059 (defcustom org-highest-priority ?A
3060 "The highest priority of TODO items. A character like ?A, ?B etc.
3061 Must have a smaller ASCII number than `org-lowest-priority'."
3062 :group 'org-priorities
3063 :type 'character)
3065 (defcustom org-lowest-priority ?C
3066 "The lowest priority of TODO items. A character like ?A, ?B etc.
3067 Must have a larger ASCII number than `org-highest-priority'."
3068 :group 'org-priorities
3069 :type 'character)
3071 (defcustom org-default-priority ?B
3072 "The default priority of TODO items.
3073 This is the priority an item gets if no explicit priority is given.
3074 When starting to cycle on an empty priority the first step in the cycle
3075 depends on `org-priority-start-cycle-with-default'. The resulting first
3076 step priority must not exceed the range from `org-highest-priority' to
3077 `org-lowest-priority' which means that `org-default-priority' has to be
3078 in this range exclusive or inclusive the range boundaries. Else the
3079 first step refuses to set the default and the second will fall back
3080 to (depending on the command used) the highest or lowest priority."
3081 :group 'org-priorities
3082 :type 'character)
3084 (defcustom org-priority-start-cycle-with-default t
3085 "Non-nil means start with default priority when starting to cycle.
3086 When this is nil, the first step in the cycle will be (depending on the
3087 command used) one higher or lower than the default priority.
3088 See also `org-default-priority'."
3089 :group 'org-priorities
3090 :type 'boolean)
3092 (defcustom org-get-priority-function nil
3093 "Function to extract the priority from a string.
3094 The string is normally the headline. If this is nil Org computes the
3095 priority from the priority cookie like [#A] in the headline. It returns
3096 an integer, increasing by 1000 for each priority level.
3097 The user can set a different function here, which should take a string
3098 as an argument and return the numeric priority."
3099 :group 'org-priorities
3100 :version "24.1"
3101 :type '(choice
3102 (const nil)
3103 (function)))
3105 (defgroup org-time nil
3106 "Options concerning time stamps and deadlines in Org-mode."
3107 :tag "Org Time"
3108 :group 'org)
3110 (defcustom org-time-stamp-rounding-minutes '(0 5)
3111 "Number of minutes to round time stamps to.
3112 These are two values, the first applies when first creating a time stamp.
3113 The second applies when changing it with the commands `S-up' and `S-down'.
3114 When changing the time stamp, this means that it will change in steps
3115 of N minutes, as given by the second value.
3117 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3118 numbers should be factors of 60, so for example 5, 10, 15.
3120 When this is larger than 1, you can still force an exact time stamp by using
3121 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3122 and by using a prefix arg to `S-up/down' to specify the exact number
3123 of minutes to shift."
3124 :group 'org-time
3125 :get (lambda (var) ; Make sure both elements are there
3126 (if (integerp (default-value var))
3127 (list (default-value var) 5)
3128 (default-value var)))
3129 :type '(list
3130 (integer :tag "when inserting times")
3131 (integer :tag "when modifying times")))
3133 ;; Normalize old customizations of this variable.
3134 (when (integerp org-time-stamp-rounding-minutes)
3135 (setq org-time-stamp-rounding-minutes
3136 (list org-time-stamp-rounding-minutes
3137 org-time-stamp-rounding-minutes)))
3139 (defcustom org-display-custom-times nil
3140 "Non-nil means overlay custom formats over all time stamps.
3141 The formats are defined through the variable `org-time-stamp-custom-formats'.
3142 To turn this on on a per-file basis, insert anywhere in the file:
3143 #+STARTUP: customtime"
3144 :group 'org-time
3145 :set 'set-default
3146 :type 'sexp)
3147 (make-variable-buffer-local 'org-display-custom-times)
3149 (defcustom org-time-stamp-custom-formats
3150 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3151 "Custom formats for time stamps. See `format-time-string' for the syntax.
3152 These are overlaid over the default ISO format if the variable
3153 `org-display-custom-times' is set. Time like %H:%M should be at the
3154 end of the second format. The custom formats are also honored by export
3155 commands, if custom time display is turned on at the time of export."
3156 :group 'org-time
3157 :type 'sexp)
3159 (defun org-time-stamp-format (&optional long inactive)
3160 "Get the right format for a time string."
3161 (let ((f (if long (cdr org-time-stamp-formats)
3162 (car org-time-stamp-formats))))
3163 (if inactive
3164 (concat "[" (substring f 1 -1) "]")
3165 f)))
3167 (defcustom org-time-clocksum-format
3168 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3169 "The format string used when creating CLOCKSUM lines.
3170 This is also used when Org mode generates a time duration.
3172 The value can be a single format string containing two
3173 %-sequences, which will be filled with the number of hours and
3174 minutes in that order.
3176 Alternatively, the value can be a plist associating any of the
3177 keys :years, :months, :weeks, :days, :hours or :minutes with
3178 format strings. The time duration is formatted using only the
3179 time components that are needed and concatenating the results.
3180 If a time unit in absent, it falls back to the next smallest
3181 unit.
3183 The keys :require-years, :require-months, :require-days,
3184 :require-weeks, :require-hours, :require-minutes are also
3185 meaningful. A non-nil value for these keys indicates that the
3186 corresponding time component should always be included, even if
3187 its value is 0.
3190 For example,
3192 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3193 :require-minutes t)
3195 means durations longer than a day will be expressed in days,
3196 hours and minutes, and durations less than a day will always be
3197 expressed in hours and minutes (even for durations less than an
3198 hour).
3200 The value
3202 \(:days \"%dd\" :minutes \"%dm\")
3204 means durations longer than a day will be expressed in days and
3205 minutes, and durations less than a day will be expressed entirely
3206 in minutes (even for durations longer than an hour)."
3207 :group 'org-time
3208 :group 'org-clock
3209 :version "24.4"
3210 :package-version '(Org . "8.0")
3211 :type '(choice (string :tag "Format string")
3212 (set :tag "Plist"
3213 (group :inline t (const :tag "Years" :years)
3214 (string :tag "Format string"))
3215 (group :inline t
3216 (const :tag "Always show years" :require-years)
3217 (const t))
3218 (group :inline t (const :tag "Months" :months)
3219 (string :tag "Format string"))
3220 (group :inline t
3221 (const :tag "Always show months" :require-months)
3222 (const t))
3223 (group :inline t (const :tag "Weeks" :weeks)
3224 (string :tag "Format string"))
3225 (group :inline t
3226 (const :tag "Always show weeks" :require-weeks)
3227 (const t))
3228 (group :inline t (const :tag "Days" :days)
3229 (string :tag "Format string"))
3230 (group :inline t
3231 (const :tag "Always show days" :require-days)
3232 (const t))
3233 (group :inline t (const :tag "Hours" :hours)
3234 (string :tag "Format string"))
3235 (group :inline t
3236 (const :tag "Always show hours" :require-hours)
3237 (const t))
3238 (group :inline t (const :tag "Minutes" :minutes)
3239 (string :tag "Format string"))
3240 (group :inline t
3241 (const :tag "Always show minutes" :require-minutes)
3242 (const t)))))
3244 (defcustom org-time-clocksum-use-fractional nil
3245 "When non-nil, \\[org-clock-display] uses fractional times.
3246 See `org-time-clocksum-format' for more on time clock formats."
3247 :group 'org-time
3248 :group 'org-clock
3249 :version "24.3"
3250 :type 'boolean)
3252 (defcustom org-time-clocksum-use-effort-durations nil
3253 "When non-nil, \\[org-clock-display] uses effort durations.
3254 E.g. by default, one day is considered to be a 8 hours effort,
3255 so a task that has been clocked for 16 hours will be displayed
3256 as during 2 days in the clock display or in the clocktable.
3258 See `org-effort-durations' on how to set effort durations
3259 and `org-time-clocksum-format' for more on time clock formats."
3260 :group 'org-time
3261 :group 'org-clock
3262 :version "24.4"
3263 :package-version '(Org . "8.0")
3264 :type 'boolean)
3266 (defcustom org-time-clocksum-fractional-format "%.2f"
3267 "The format string used when creating CLOCKSUM lines,
3268 or when Org mode generates a time duration, if
3269 `org-time-clocksum-use-fractional' is enabled.
3271 The value can be a single format string containing one
3272 %-sequence, which will be filled with the number of hours as
3273 a float.
3275 Alternatively, the value can be a plist associating any of the
3276 keys :years, :months, :weeks, :days, :hours or :minutes with
3277 a format string. The time duration is formatted using the
3278 largest time unit which gives a non-zero integer part. If all
3279 specified formats have zero integer part, the smallest time unit
3280 is used."
3281 :group 'org-time
3282 :type '(choice (string :tag "Format string")
3283 (set (group :inline t (const :tag "Years" :years)
3284 (string :tag "Format string"))
3285 (group :inline t (const :tag "Months" :months)
3286 (string :tag "Format string"))
3287 (group :inline t (const :tag "Weeks" :weeks)
3288 (string :tag "Format string"))
3289 (group :inline t (const :tag "Days" :days)
3290 (string :tag "Format string"))
3291 (group :inline t (const :tag "Hours" :hours)
3292 (string :tag "Format string"))
3293 (group :inline t (const :tag "Minutes" :minutes)
3294 (string :tag "Format string")))))
3296 (defcustom org-deadline-warning-days 14
3297 "Number of days before expiration during which a deadline becomes active.
3298 This variable governs the display in sparse trees and in the agenda.
3299 When 0 or negative, it means use this number (the absolute value of it)
3300 even if a deadline has a different individual lead time specified.
3302 Custom commands can set this variable in the options section."
3303 :group 'org-time
3304 :group 'org-agenda-daily/weekly
3305 :type 'integer)
3307 (defcustom org-scheduled-delay-days 0
3308 "Number of days before a scheduled item becomes active.
3309 This variable governs the display in sparse trees and in the agenda.
3310 The default value (i.e. 0) means: don't delay scheduled item.
3311 When negative, it means use this number (the absolute value of it)
3312 even if a scheduled item has a different individual delay time
3313 specified.
3315 Custom commands can set this variable in the options section."
3316 :group 'org-time
3317 :group 'org-agenda-daily/weekly
3318 :version "24.4"
3319 :package-version '(Org . "8.0")
3320 :type 'integer)
3322 (defcustom org-read-date-prefer-future t
3323 "Non-nil means assume future for incomplete date input from user.
3324 This affects the following situations:
3325 1. The user gives a month but not a year.
3326 For example, if it is April and you enter \"feb 2\", this will be read
3327 as Feb 2, *next* year. \"May 5\", however, will be this year.
3328 2. The user gives a day, but no month.
3329 For example, if today is the 15th, and you enter \"3\", Org-mode will
3330 read this as the third of *next* month. However, if you enter \"17\",
3331 it will be considered as *this* month.
3333 If you set this variable to the symbol `time', then also the following
3334 will work:
3336 3. If the user gives a time.
3337 If the time is before now, it will be interpreted as tomorrow.
3339 Currently none of this works for ISO week specifications.
3341 When this option is nil, the current day, month and year will always be
3342 used as defaults.
3344 See also `org-agenda-jump-prefer-future'."
3345 :group 'org-time
3346 :type '(choice
3347 (const :tag "Never" nil)
3348 (const :tag "Check month and day" t)
3349 (const :tag "Check month, day, and time" time)))
3351 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3352 "Should the agenda jump command prefer the future for incomplete dates?
3353 The default is to do the same as configured in `org-read-date-prefer-future'.
3354 But you can also set a deviating value here.
3355 This may t or nil, or the symbol `org-read-date-prefer-future'."
3356 :group 'org-agenda
3357 :group 'org-time
3358 :version "24.1"
3359 :type '(choice
3360 (const :tag "Use org-read-date-prefer-future"
3361 org-read-date-prefer-future)
3362 (const :tag "Never" nil)
3363 (const :tag "Always" t)))
3365 (defcustom org-read-date-force-compatible-dates t
3366 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3368 Depending on the system Emacs is running on, certain dates cannot
3369 be represented with the type used internally to represent time.
3370 Dates between 1970-1-1 and 2038-1-1 can always be represented
3371 correctly. Some systems allow for earlier dates, some for later,
3372 some for both. One way to find out it to insert any date into an
3373 Org buffer, putting the cursor on the year and hitting S-up and
3374 S-down to test the range.
3376 When this variable is set to t, the date/time prompt will not let
3377 you specify dates outside the 1970-2037 range, so it is certain that
3378 these dates will work in whatever version of Emacs you are
3379 running, and also that you can move a file from one Emacs implementation
3380 to another. WHenever Org is forcing the year for you, it will display
3381 a message and beep.
3383 When this variable is nil, Org will check if the date is
3384 representable in the specific Emacs implementation you are using.
3385 If not, it will force a year, usually the current year, and beep
3386 to remind you. Currently this setting is not recommended because
3387 the likelihood that you will open your Org files in an Emacs that
3388 has limited date range is not negligible.
3390 A workaround for this problem is to use diary sexp dates for time
3391 stamps outside of this range."
3392 :group 'org-time
3393 :version "24.1"
3394 :type 'boolean)
3396 (defcustom org-read-date-display-live t
3397 "Non-nil means display current interpretation of date prompt live.
3398 This display will be in an overlay, in the minibuffer."
3399 :group 'org-time
3400 :type 'boolean)
3402 (defcustom org-read-date-popup-calendar t
3403 "Non-nil means pop up a calendar when prompting for a date.
3404 In the calendar, the date can be selected with mouse-1. However, the
3405 minibuffer will also be active, and you can simply enter the date as well.
3406 When nil, only the minibuffer will be available."
3407 :group 'org-time
3408 :type 'boolean)
3409 (org-defvaralias 'org-popup-calendar-for-date-prompt
3410 'org-read-date-popup-calendar)
3412 (make-obsolete-variable
3413 'org-read-date-minibuffer-setup-hook
3414 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3415 (defcustom org-read-date-minibuffer-setup-hook nil
3416 "Hook to be used to set up keys for the date/time interface.
3417 Add key definitions to `minibuffer-local-map', which will be a
3418 temporary copy.
3420 WARNING: This option is obsolete, you should use
3421 `org-read-date-minibuffer-local-map' to set up keys."
3422 :group 'org-time
3423 :type 'hook)
3425 (defcustom org-extend-today-until 0
3426 "The hour when your day really ends. Must be an integer.
3427 This has influence for the following applications:
3428 - When switching the agenda to \"today\". It it is still earlier than
3429 the time given here, the day recognized as TODAY is actually yesterday.
3430 - When a date is read from the user and it is still before the time given
3431 here, the current date and time will be assumed to be yesterday, 23:59.
3432 Also, timestamps inserted in capture templates follow this rule.
3434 IMPORTANT: This is a feature whose implementation is and likely will
3435 remain incomplete. Really, it is only here because past midnight seems to
3436 be the favorite working time of John Wiegley :-)"
3437 :group 'org-time
3438 :type 'integer)
3440 (defcustom org-use-effective-time nil
3441 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3442 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3443 \"effective time\" of any timestamps between midnight and 8am will be
3444 23:59 of the previous day."
3445 :group 'org-time
3446 :version "24.1"
3447 :type 'boolean)
3449 (defcustom org-use-last-clock-out-time-as-effective-time nil
3450 "When non-nil, use the last clock out time for `org-todo'.
3451 Note that this option has precedence over the combined use of
3452 `org-use-effective-time' and `org-extend-today-until'."
3453 :group 'org-time
3454 :version "24.4"
3455 :package-version '(Org . "8.0")
3456 :type 'boolean)
3458 (defcustom org-edit-timestamp-down-means-later nil
3459 "Non-nil means S-down will increase the time in a time stamp.
3460 When nil, S-up will increase."
3461 :group 'org-time
3462 :type 'boolean)
3464 (defcustom org-calendar-follow-timestamp-change t
3465 "Non-nil means make the calendar window follow timestamp changes.
3466 When a timestamp is modified and the calendar window is visible, it will be
3467 moved to the new date."
3468 :group 'org-time
3469 :type 'boolean)
3471 (defgroup org-tags nil
3472 "Options concerning tags in Org-mode."
3473 :tag "Org Tags"
3474 :group 'org)
3476 (defcustom org-tag-alist nil
3477 "List of tags allowed in Org-mode files.
3478 When this list is nil, Org-mode will base TAG input on what is already in the
3479 buffer.
3480 The value of this variable is an alist, the car of each entry must be a
3481 keyword as a string, the cdr may be a character that is used to select
3482 that tag through the fast-tag-selection interface.
3483 See the manual for details."
3484 :group 'org-tags
3485 :type '(repeat
3486 (choice
3487 (cons (string :tag "Tag name")
3488 (character :tag "Access char"))
3489 (list :tag "Start radio group"
3490 (const :startgroup)
3491 (option (string :tag "Group description")))
3492 (list :tag "Group tags delimiter"
3493 (const :grouptags))
3494 (list :tag "End radio group"
3495 (const :endgroup)
3496 (option (string :tag "Group description")))
3497 (const :tag "New line" (:newline)))))
3499 (defcustom org-tag-persistent-alist nil
3500 "List of tags that will always appear in all Org-mode files.
3501 This is in addition to any in buffer settings or customizations
3502 of `org-tag-alist'.
3503 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3504 The value of this variable is an alist, the car of each entry must be a
3505 keyword as a string, the cdr may be a character that is used to select
3506 that tag through the fast-tag-selection interface.
3507 See the manual for details.
3508 To disable these tags on a per-file basis, insert anywhere in the file:
3509 #+STARTUP: noptag"
3510 :group 'org-tags
3511 :type '(repeat
3512 (choice
3513 (cons (string :tag "Tag name")
3514 (character :tag "Access char"))
3515 (const :tag "Start radio group" (:startgroup))
3516 (const :tag "Group tags delimiter" (:grouptags))
3517 (const :tag "End radio group" (:endgroup))
3518 (const :tag "New line" (:newline)))))
3520 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3521 "If non-nil, always offer completion for all tags of all agenda files.
3522 Instead of customizing this variable directly, you might want to
3523 set it locally for capture buffers, because there no list of
3524 tags in that file can be created dynamically (there are none).
3526 (add-hook 'org-capture-mode-hook
3527 (lambda ()
3528 (set (make-local-variable
3529 'org-complete-tags-always-offer-all-agenda-tags)
3530 t)))"
3531 :group 'org-tags
3532 :version "24.1"
3533 :type 'boolean)
3535 (defvar org-file-tags nil
3536 "List of tags that can be inherited by all entries in the file.
3537 The tags will be inherited if the variable `org-use-tag-inheritance'
3538 says they should be.
3539 This variable is populated from #+FILETAGS lines.")
3541 (defcustom org-use-fast-tag-selection 'auto
3542 "Non-nil means use fast tag selection scheme.
3543 This is a special interface to select and deselect tags with single keys.
3544 When nil, fast selection is never used.
3545 When the symbol `auto', fast selection is used if and only if selection
3546 characters for tags have been configured, either through the variable
3547 `org-tag-alist' or through a #+TAGS line in the buffer.
3548 When t, fast selection is always used and selection keys are assigned
3549 automatically if necessary."
3550 :group 'org-tags
3551 :type '(choice
3552 (const :tag "Always" t)
3553 (const :tag "Never" nil)
3554 (const :tag "When selection characters are configured" auto)))
3556 (defcustom org-fast-tag-selection-single-key nil
3557 "Non-nil means fast tag selection exits after first change.
3558 When nil, you have to press RET to exit it.
3559 During fast tag selection, you can toggle this flag with `C-c'.
3560 This variable can also have the value `expert'. In this case, the window
3561 displaying the tags menu is not even shown, until you press C-c again."
3562 :group 'org-tags
3563 :type '(choice
3564 (const :tag "No" nil)
3565 (const :tag "Yes" t)
3566 (const :tag "Expert" expert)))
3568 (defvar org-fast-tag-selection-include-todo nil
3569 "Non-nil means fast tags selection interface will also offer TODO states.
3570 This is an undocumented feature, you should not rely on it.")
3572 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3573 "The column to which tags should be indented in a headline.
3574 If this number is positive, it specifies the column. If it is negative,
3575 it means that the tags should be flushright to that column. For example,
3576 -80 works well for a normal 80 character screen.
3577 When 0, place tags directly after headline text, with only one space in
3578 between."
3579 :group 'org-tags
3580 :type 'integer)
3582 (defcustom org-auto-align-tags t
3583 "Non-nil keeps tags aligned when modifying headlines.
3584 Some operations (i.e. demoting) change the length of a headline and
3585 therefore shift the tags around. With this option turned on, after
3586 each such operation the tags are again aligned to `org-tags-column'."
3587 :group 'org-tags
3588 :type 'boolean)
3590 (defcustom org-use-tag-inheritance t
3591 "Non-nil means tags in levels apply also for sublevels.
3592 When nil, only the tags directly given in a specific line apply there.
3593 This may also be a list of tags that should be inherited, or a regexp that
3594 matches tags that should be inherited. Additional control is possible
3595 with the variable `org-tags-exclude-from-inheritance' which gives an
3596 explicit list of tags to be excluded from inheritance, even if the value of
3597 `org-use-tag-inheritance' would select it for inheritance.
3599 If this option is t, a match early-on in a tree can lead to a large
3600 number of matches in the subtree when constructing the agenda or creating
3601 a sparse tree. If you only want to see the first match in a tree during
3602 a search, check out the variable `org-tags-match-list-sublevels'."
3603 :group 'org-tags
3604 :type '(choice
3605 (const :tag "Not" nil)
3606 (const :tag "Always" t)
3607 (repeat :tag "Specific tags" (string :tag "Tag"))
3608 (regexp :tag "Tags matched by regexp")))
3610 (defcustom org-tags-exclude-from-inheritance nil
3611 "List of tags that should never be inherited.
3612 This is a way to exclude a few tags from inheritance. For way to do
3613 the opposite, to actively allow inheritance for selected tags,
3614 see the variable `org-use-tag-inheritance'."
3615 :group 'org-tags
3616 :type '(repeat (string :tag "Tag")))
3618 (defun org-tag-inherit-p (tag)
3619 "Check if TAG is one that should be inherited."
3620 (cond
3621 ((member tag org-tags-exclude-from-inheritance) nil)
3622 ((eq org-use-tag-inheritance t) t)
3623 ((not org-use-tag-inheritance) nil)
3624 ((stringp org-use-tag-inheritance)
3625 (string-match org-use-tag-inheritance tag))
3626 ((listp org-use-tag-inheritance)
3627 (member tag org-use-tag-inheritance))
3628 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3630 (defcustom org-tags-match-list-sublevels t
3631 "Non-nil means list also sublevels of headlines matching a search.
3632 This variable applies to tags/property searches, and also to stuck
3633 projects because this search is based on a tags match as well.
3635 When set to the symbol `indented', sublevels are indented with
3636 leading dots.
3638 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3639 the sublevels of a headline matching a tag search often also match
3640 the same search. Listing all of them can create very long lists.
3641 Setting this variable to nil causes subtrees of a match to be skipped.
3643 This variable is semi-obsolete and probably should always be true. It
3644 is better to limit inheritance to certain tags using the variables
3645 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3646 :group 'org-tags
3647 :type '(choice
3648 (const :tag "No, don't list them" nil)
3649 (const :tag "Yes, do list them" t)
3650 (const :tag "List them, indented with leading dots" indented)))
3652 (defcustom org-tags-sort-function nil
3653 "When set, tags are sorted using this function as a comparator."
3654 :group 'org-tags
3655 :type '(choice
3656 (const :tag "No sorting" nil)
3657 (const :tag "Alphabetical" string<)
3658 (const :tag "Reverse alphabetical" string>)
3659 (function :tag "Custom function" nil)))
3661 (defvar org-tags-history nil
3662 "History of minibuffer reads for tags.")
3663 (defvar org-last-tags-completion-table nil
3664 "The last used completion table for tags.")
3665 (defvar org-after-tags-change-hook nil
3666 "Hook that is run after the tags in a line have changed.")
3668 (defgroup org-properties nil
3669 "Options concerning properties in Org-mode."
3670 :tag "Org Properties"
3671 :group 'org)
3673 (defcustom org-property-format "%-10s %s"
3674 "How property key/value pairs should be formatted by `indent-line'.
3675 When `indent-line' hits a property definition, it will format the line
3676 according to this format, mainly to make sure that the values are
3677 lined-up with respect to each other."
3678 :group 'org-properties
3679 :type 'string)
3681 (defcustom org-properties-postprocess-alist nil
3682 "Alist of properties and functions to adjust inserted values.
3683 Elements of this alist must be of the form
3685 ([string] [function])
3687 where [string] must be a property name and [function] must be a
3688 lambda expression: this lambda expression must take one argument,
3689 the value to adjust, and return the new value as a string.
3691 For example, this element will allow the property \"Remaining\"
3692 to be updated wrt the relation between the \"Effort\" property
3693 and the clock summary:
3695 ((\"Remaining\" (lambda(value)
3696 (let ((clocksum (org-clock-sum-current-item))
3697 (effort (org-duration-string-to-minutes
3698 (org-entry-get (point) \"Effort\"))))
3699 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3700 :group 'org-properties
3701 :version "24.1"
3702 :type '(alist :key-type (string :tag "Property")
3703 :value-type (function :tag "Function")))
3705 (defcustom org-use-property-inheritance nil
3706 "Non-nil means properties apply also for sublevels.
3708 This setting is chiefly used during property searches. Turning it on can
3709 cause significant overhead when doing a search, which is why it is not
3710 on by default.
3712 When nil, only the properties directly given in the current entry count.
3713 When t, every property is inherited. The value may also be a list of
3714 properties that should have inheritance, or a regular expression matching
3715 properties that should be inherited.
3717 However, note that some special properties use inheritance under special
3718 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3719 and the properties ending in \"_ALL\" when they are used as descriptor
3720 for valid values of a property.
3722 Note for programmers:
3723 When querying an entry with `org-entry-get', you can control if inheritance
3724 should be used. By default, `org-entry-get' looks only at the local
3725 properties. You can request inheritance by setting the inherit argument
3726 to t (to force inheritance) or to `selective' (to respect the setting
3727 in this variable)."
3728 :group 'org-properties
3729 :type '(choice
3730 (const :tag "Not" nil)
3731 (const :tag "Always" t)
3732 (repeat :tag "Specific properties" (string :tag "Property"))
3733 (regexp :tag "Properties matched by regexp")))
3735 (defun org-property-inherit-p (property)
3736 "Check if PROPERTY is one that should be inherited."
3737 (cond
3738 ((eq org-use-property-inheritance t) t)
3739 ((not org-use-property-inheritance) nil)
3740 ((stringp org-use-property-inheritance)
3741 (string-match org-use-property-inheritance property))
3742 ((listp org-use-property-inheritance)
3743 (member property org-use-property-inheritance))
3744 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3746 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3747 "The default column format, if no other format has been defined.
3748 This variable can be set on the per-file basis by inserting a line
3750 #+COLUMNS: %25ITEM ....."
3751 :group 'org-properties
3752 :type 'string)
3754 (defcustom org-columns-ellipses ".."
3755 "The ellipses to be used when a field in column view is truncated.
3756 When this is the empty string, as many characters as possible are shown,
3757 but then there will be no visual indication that the field has been truncated.
3758 When this is a string of length N, the last N characters of a truncated
3759 field are replaced by this string. If the column is narrower than the
3760 ellipses string, only part of the ellipses string will be shown."
3761 :group 'org-properties
3762 :type 'string)
3764 (defcustom org-columns-modify-value-for-display-function nil
3765 "Function that modifies values for display in column view.
3766 For example, it can be used to cut out a certain part from a time stamp.
3767 The function must take 2 arguments:
3769 column-title The title of the column (*not* the property name)
3770 value The value that should be modified.
3772 The function should return the value that should be displayed,
3773 or nil if the normal value should be used."
3774 :group 'org-properties
3775 :type '(choice (const nil) (function)))
3777 (defconst org-global-properties-fixed
3778 '(("VISIBILITY_ALL" . "folded children content all")
3779 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3780 "List of property/value pairs that can be inherited by any entry.
3782 These are fixed values, for the preset properties. The user variable
3783 that can be used to add to this list is `org-global-properties'.
3785 The entries in this list are cons cells where the car is a property
3786 name and cdr is a string with the value. If the value represents
3787 multiple items like an \"_ALL\" property, separate the items by
3788 spaces.")
3790 (defcustom org-global-properties nil
3791 "List of property/value pairs that can be inherited by any entry.
3793 This list will be combined with the constant `org-global-properties-fixed'.
3795 The entries in this list are cons cells where the car is a property
3796 name and cdr is a string with the value.
3798 You can set buffer-local values for the same purpose in the variable
3799 `org-file-properties' this by adding lines like
3801 #+PROPERTY: NAME VALUE"
3802 :group 'org-properties
3803 :type '(repeat
3804 (cons (string :tag "Property")
3805 (string :tag "Value"))))
3807 (defvar org-file-properties nil
3808 "List of property/value pairs that can be inherited by any entry.
3809 Valid for the current buffer.
3810 This variable is populated from #+PROPERTY lines.")
3811 (make-variable-buffer-local 'org-file-properties)
3813 (defgroup org-agenda nil
3814 "Options concerning agenda views in Org-mode."
3815 :tag "Org Agenda"
3816 :group 'org)
3818 (defvar org-category nil
3819 "Variable used by org files to set a category for agenda display.
3820 Such files should use a file variable to set it, for example
3822 # -*- mode: org; org-category: \"ELisp\"
3824 or contain a special line
3826 #+CATEGORY: ELisp
3828 If the file does not specify a category, then file's base name
3829 is used instead.")
3830 (make-variable-buffer-local 'org-category)
3831 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3833 (defcustom org-agenda-files nil
3834 "The files to be used for agenda display.
3835 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3836 \\[org-remove-file]. You can also use customize to edit the list.
3838 If an entry is a directory, all files in that directory that are matched by
3839 `org-agenda-file-regexp' will be part of the file list.
3841 If the value of the variable is not a list but a single file name, then
3842 the list of agenda files is actually stored and maintained in that file, one
3843 agenda file per line. In this file paths can be given relative to
3844 `org-directory'. Tilde expansion and environment variable substitution
3845 are also made."
3846 :group 'org-agenda
3847 :type '(choice
3848 (repeat :tag "List of files and directories" file)
3849 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3851 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3852 "Regular expression to match files for `org-agenda-files'.
3853 If any element in the list in that variable contains a directory instead
3854 of a normal file, all files in that directory that are matched by this
3855 regular expression will be included."
3856 :group 'org-agenda
3857 :type 'regexp)
3859 (defcustom org-agenda-text-search-extra-files nil
3860 "List of extra files to be searched by text search commands.
3861 These files will be searched in addition to the agenda files by the
3862 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3863 Note that these files will only be searched for text search commands,
3864 not for the other agenda views like todo lists, tag searches or the weekly
3865 agenda. This variable is intended to list notes and possibly archive files
3866 that should also be searched by these two commands.
3867 In fact, if the first element in the list is the symbol `agenda-archives',
3868 then all archive files of all agenda files will be added to the search
3869 scope."
3870 :group 'org-agenda
3871 :type '(set :greedy t
3872 (const :tag "Agenda Archives" agenda-archives)
3873 (repeat :inline t (file))))
3875 (org-defvaralias 'org-agenda-multi-occur-extra-files
3876 'org-agenda-text-search-extra-files)
3878 (defcustom org-agenda-skip-unavailable-files nil
3879 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3880 A nil value means to remove them, after a query, from the list."
3881 :group 'org-agenda
3882 :type 'boolean)
3884 (defcustom org-calendar-to-agenda-key [?c]
3885 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3886 The command `org-calendar-goto-agenda' will be bound to this key. The
3887 default is the character `c' because then `c' can be used to switch back and
3888 forth between agenda and calendar."
3889 :group 'org-agenda
3890 :type 'sexp)
3892 (defcustom org-calendar-insert-diary-entry-key [?i]
3893 "The key to be installed in `calendar-mode-map' for adding diary entries.
3894 This option is irrelevant until `org-agenda-diary-file' has been configured
3895 to point to an Org-mode file. When that is the case, the command
3896 `org-agenda-diary-entry' will be bound to the key given here, by default
3897 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3898 if you want to continue doing this, you need to change this to a different
3899 key."
3900 :group 'org-agenda
3901 :type 'sexp)
3903 (defcustom org-agenda-diary-file 'diary-file
3904 "File to which to add new entries with the `i' key in agenda and calendar.
3905 When this is the symbol `diary-file', the functionality in the Emacs
3906 calendar will be used to add entries to the `diary-file'. But when this
3907 points to a file, `org-agenda-diary-entry' will be used instead."
3908 :group 'org-agenda
3909 :type '(choice
3910 (const :tag "The standard Emacs diary file" diary-file)
3911 (file :tag "Special Org file diary entries")))
3913 (eval-after-load "calendar"
3914 '(progn
3915 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3916 'org-calendar-goto-agenda)
3917 (add-hook 'calendar-mode-hook
3918 (lambda ()
3919 (unless (eq org-agenda-diary-file 'diary-file)
3920 (define-key calendar-mode-map
3921 org-calendar-insert-diary-entry-key
3922 'org-agenda-diary-entry))))))
3924 (defgroup org-latex nil
3925 "Options for embedding LaTeX code into Org-mode."
3926 :tag "Org LaTeX"
3927 :group 'org)
3929 (defcustom org-format-latex-options
3930 '(:foreground default :background default :scale 1.0
3931 :html-foreground "Black" :html-background "Transparent"
3932 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3933 "Options for creating images from LaTeX fragments.
3934 This is a property list with the following properties:
3935 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3936 `default' means use the foreground of the default face.
3937 `auto' means use the foreground from the text face.
3938 :background the background color, or \"Transparent\".
3939 `default' means use the background of the default face.
3940 `auto' means use the background from the text face.
3941 :scale a scaling factor for the size of the images, to get more pixels
3942 :html-foreground, :html-background, :html-scale
3943 the same numbers for HTML export.
3944 :matchers a list indicating which matchers should be used to
3945 find LaTeX fragments. Valid members of this list are:
3946 \"begin\" find environments
3947 \"$1\" find single characters surrounded by $.$
3948 \"$\" find math expressions surrounded by $...$
3949 \"$$\" find math expressions surrounded by $$....$$
3950 \"\\(\" find math expressions surrounded by \\(...\\)
3951 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3952 :group 'org-latex
3953 :type 'plist)
3955 (defcustom org-format-latex-signal-error t
3956 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3957 When nil, just push out a message."
3958 :group 'org-latex
3959 :version "24.1"
3960 :type 'boolean)
3962 (defcustom org-latex-to-mathml-jar-file nil
3963 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3964 Use this to specify additional executable file say a jar file.
3966 When using MathToWeb as the converter, specify the full-path to
3967 your mathtoweb.jar file."
3968 :group 'org-latex
3969 :version "24.1"
3970 :type '(choice
3971 (const :tag "None" nil)
3972 (file :tag "JAR file" :must-match t)))
3974 (defcustom org-latex-to-mathml-convert-command nil
3975 "Command to convert LaTeX fragments to MathML.
3976 Replace format-specifiers in the command as noted below and use
3977 `shell-command' to convert LaTeX to MathML.
3978 %j: Executable file in fully expanded form as specified by
3979 `org-latex-to-mathml-jar-file'.
3980 %I: Input LaTeX file in fully expanded form
3981 %o: Output MathML file
3982 This command is used by `org-create-math-formula'.
3984 When using MathToWeb as the converter, set this to
3985 \"java -jar %j -unicode -force -df %o %I\"."
3986 :group 'org-latex
3987 :version "24.1"
3988 :type '(choice
3989 (const :tag "None" nil)
3990 (string :tag "\nShell command")))
3992 (defcustom org-latex-create-formula-image-program 'dvipng
3993 "Program to convert LaTeX fragments with.
3995 dvipng Process the LaTeX fragments to dvi file, then convert
3996 dvi files to png files using dvipng.
3997 This will also include processing of non-math environments.
3998 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3999 to convert pdf files to png files"
4000 :group 'org-latex
4001 :version "24.1"
4002 :type '(choice
4003 (const :tag "dvipng" dvipng)
4004 (const :tag "imagemagick" imagemagick)))
4006 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4007 "Path to store latex preview images.
4008 A relative path here creates many directories relative to the
4009 processed org files paths. An absolute path puts all preview
4010 images at the same place."
4011 :group 'org-latex
4012 :version "24.3"
4013 :type 'string)
4015 (defun org-format-latex-mathml-available-p ()
4016 "Return t if `org-latex-to-mathml-convert-command' is usable."
4017 (save-match-data
4018 (when (and (boundp 'org-latex-to-mathml-convert-command)
4019 org-latex-to-mathml-convert-command)
4020 (let ((executable (car (split-string
4021 org-latex-to-mathml-convert-command))))
4022 (when (executable-find executable)
4023 (if (string-match
4024 "%j" org-latex-to-mathml-convert-command)
4025 (file-readable-p org-latex-to-mathml-jar-file)
4026 t))))))
4028 (defcustom org-format-latex-header "\\documentclass{article}
4029 \\usepackage[usenames]{color}
4030 \[PACKAGES]
4031 \[DEFAULT-PACKAGES]
4032 \\pagestyle{empty} % do not remove
4033 % The settings below are copied from fullpage.sty
4034 \\setlength{\\textwidth}{\\paperwidth}
4035 \\addtolength{\\textwidth}{-3cm}
4036 \\setlength{\\oddsidemargin}{1.5cm}
4037 \\addtolength{\\oddsidemargin}{-2.54cm}
4038 \\setlength{\\evensidemargin}{\\oddsidemargin}
4039 \\setlength{\\textheight}{\\paperheight}
4040 \\addtolength{\\textheight}{-\\headheight}
4041 \\addtolength{\\textheight}{-\\headsep}
4042 \\addtolength{\\textheight}{-\\footskip}
4043 \\addtolength{\\textheight}{-3cm}
4044 \\setlength{\\topmargin}{1.5cm}
4045 \\addtolength{\\topmargin}{-2.54cm}"
4046 "The document header used for processing LaTeX fragments.
4047 It is imperative that this header make sure that no page number
4048 appears on the page. The package defined in the variables
4049 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4050 will either replace the placeholder \"[PACKAGES]\" in this
4051 header, or they will be appended."
4052 :group 'org-latex
4053 :type 'string)
4055 (defun org-set-packages-alist (var val)
4056 "Set the packages alist and make sure it has 3 elements per entry."
4057 (set var (mapcar (lambda (x)
4058 (if (and (consp x) (= (length x) 2))
4059 (list (car x) (nth 1 x) t)
4061 val)))
4063 (defun org-get-packages-alist (var)
4064 "Get the packages alist and make sure it has 3 elements per entry."
4065 (mapcar (lambda (x)
4066 (if (and (consp x) (= (length x) 2))
4067 (list (car x) (nth 1 x) t)
4069 (default-value var)))
4071 (defcustom org-latex-default-packages-alist
4072 '(("AUTO" "inputenc" t)
4073 ("T1" "fontenc" t)
4074 ("" "fixltx2e" nil)
4075 ("" "graphicx" t)
4076 ("" "longtable" nil)
4077 ("" "float" nil)
4078 ("" "wrapfig" nil)
4079 ("" "rotating" nil)
4080 ("normalem" "ulem" t)
4081 ("" "amsmath" t)
4082 ("" "textcomp" t)
4083 ("" "marvosym" t)
4084 ("" "wasysym" t)
4085 ("" "amssymb" t)
4086 ("" "capt-of" nil)
4087 ("" "hyperref" nil)
4088 "\\tolerance=1000")
4089 "Alist of default packages to be inserted in the header.
4091 Change this only if one of the packages here causes an
4092 incompatibility with another package you are using.
4094 The packages in this list are needed by one part or another of
4095 Org mode to function properly:
4097 - inputenc, fontenc: for basic font and character selection
4098 - fixltx2e: Important patches of LaTeX itself
4099 - graphicx: for including images
4100 - longtable: For multipage tables
4101 - float, wrapfig: for figure placement
4102 - rotating: for sideways figures and tables
4103 - ulem: for underline and strike-through
4104 - amsmath: for subscript and superscript and math environments
4105 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4106 for interpreting the entities in `org-entities'. You can skip
4107 some of these packages if you don't use any of their symbols.
4108 - capt-of: for captions outside of floats
4109 - hyperref: for cross references
4111 Therefore you should not modify this variable unless you know
4112 what you are doing. The one reason to change it anyway is that
4113 you might be loading some other package that conflicts with one
4114 of the default packages. Each element is either a cell or
4115 a string.
4117 A cell is of the format:
4119 \( \"options\" \"package\" SNIPPET-FLAG).
4121 If SNIPPET-FLAG is non-nil, the package also needs to be included
4122 when compiling LaTeX snippets into images for inclusion into
4123 non-LaTeX output.
4125 A string will be inserted as-is in the header of the document."
4126 :group 'org-latex
4127 :group 'org-export-latex
4128 :set 'org-set-packages-alist
4129 :get 'org-get-packages-alist
4130 :version "24.1"
4131 :type '(repeat
4132 (choice
4133 (list :tag "options/package pair"
4134 (string :tag "options")
4135 (string :tag "package")
4136 (boolean :tag "Snippet"))
4137 (string :tag "A line of LaTeX"))))
4139 (defcustom org-latex-packages-alist nil
4140 "Alist of packages to be inserted in every LaTeX header.
4142 These will be inserted after `org-latex-default-packages-alist'.
4143 Each element is either a cell or a string.
4145 A cell is of the format:
4147 \(\"options\" \"package\" SNIPPET-FLAG)
4149 SNIPPET-FLAG, when non-nil, indicates that this package is also
4150 needed when turning LaTeX snippets into images for inclusion into
4151 non-LaTeX output.
4153 A string will be inserted as-is in the header of the document.
4155 Make sure that you only list packages here which:
4157 - you want in every file;
4158 - do not conflict with the setup in `org-format-latex-header';
4159 - do not conflict with the default packages in
4160 `org-latex-default-packages-alist'."
4161 :group 'org-latex
4162 :group 'org-export-latex
4163 :set 'org-set-packages-alist
4164 :get 'org-get-packages-alist
4165 :type '(repeat
4166 (choice
4167 (list :tag "options/package pair"
4168 (string :tag "options")
4169 (string :tag "package")
4170 (boolean :tag "Snippet"))
4171 (string :tag "A line of LaTeX"))))
4173 (defgroup org-appearance nil
4174 "Settings for Org-mode appearance."
4175 :tag "Org Appearance"
4176 :group 'org)
4178 (defcustom org-level-color-stars-only nil
4179 "Non-nil means fontify only the stars in each headline.
4180 When nil, the entire headline is fontified.
4181 Changing it requires restart of `font-lock-mode' to become effective
4182 also in regions already fontified."
4183 :group 'org-appearance
4184 :type 'boolean)
4186 (defcustom org-hide-leading-stars nil
4187 "Non-nil means hide the first N-1 stars in a headline.
4188 This works by using the face `org-hide' for these stars. This
4189 face is white for a light background, and black for a dark
4190 background. You may have to customize the face `org-hide' to
4191 make this work.
4192 Changing it requires restart of `font-lock-mode' to become effective
4193 also in regions already fontified.
4194 You may also set this on a per-file basis by adding one of the following
4195 lines to the buffer:
4197 #+STARTUP: hidestars
4198 #+STARTUP: showstars"
4199 :group 'org-appearance
4200 :type 'boolean)
4202 (defcustom org-hidden-keywords nil
4203 "List of symbols corresponding to keywords to be hidden the org buffer.
4204 For example, a value '(title) for this list will make the document's title
4205 appear in the buffer without the initial #+TITLE: keyword."
4206 :group 'org-appearance
4207 :version "24.1"
4208 :type '(set (const :tag "#+AUTHOR" author)
4209 (const :tag "#+DATE" date)
4210 (const :tag "#+EMAIL" email)
4211 (const :tag "#+TITLE" title)))
4213 (defcustom org-custom-properties nil
4214 "List of properties (as strings) with a special meaning.
4215 The default use of these custom properties is to let the user
4216 hide them with `org-toggle-custom-properties-visibility'."
4217 :group 'org-properties
4218 :group 'org-appearance
4219 :version "24.3"
4220 :type '(repeat (string :tag "Property Name")))
4222 (defcustom org-fontify-done-headline nil
4223 "Non-nil means change the face of a headline if it is marked DONE.
4224 Normally, only the TODO/DONE keyword indicates the state of a headline.
4225 When this is non-nil, the headline after the keyword is set to the
4226 `org-headline-done' as an additional indication."
4227 :group 'org-appearance
4228 :type 'boolean)
4230 (defcustom org-fontify-emphasized-text t
4231 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4232 Changing this variable requires a restart of Emacs to take effect."
4233 :group 'org-appearance
4234 :type 'boolean)
4236 (defcustom org-fontify-whole-heading-line nil
4237 "Non-nil means fontify the whole line for headings.
4238 This is useful when setting a background color for the
4239 org-level-* faces."
4240 :group 'org-appearance
4241 :type 'boolean)
4243 (defcustom org-highlight-latex-and-related nil
4244 "Non-nil means highlight LaTeX related syntax in the buffer.
4245 When non nil, the value should be a list containing any of the
4246 following symbols:
4247 `latex' Highlight LaTeX snippets and environments.
4248 `script' Highlight subscript and superscript.
4249 `entities' Highlight entities."
4250 :group 'org-appearance
4251 :version "24.4"
4252 :package-version '(Org . "8.0")
4253 :type '(choice
4254 (const :tag "No highlighting" nil)
4255 (set :greedy t :tag "Highlight"
4256 (const :tag "LaTeX snippets and environments" latex)
4257 (const :tag "Subscript and superscript" script)
4258 (const :tag "Entities" entities))))
4260 (defcustom org-hide-emphasis-markers nil
4261 "Non-nil mean font-lock should hide the emphasis marker characters."
4262 :group 'org-appearance
4263 :type 'boolean)
4265 (defcustom org-hide-macro-markers nil
4266 "Non-nil mean font-lock should hide the brackets marking macro calls."
4267 :group 'org-appearance
4268 :type 'boolean)
4270 (defcustom org-pretty-entities nil
4271 "Non-nil means show entities as UTF8 characters.
4272 When nil, the \\name form remains in the buffer."
4273 :group 'org-appearance
4274 :version "24.1"
4275 :type 'boolean)
4277 (defcustom org-pretty-entities-include-sub-superscripts t
4278 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4279 :group 'org-appearance
4280 :version "24.1"
4281 :type 'boolean)
4283 (defvar org-emph-re nil
4284 "Regular expression for matching emphasis.
4285 After a match, the match groups contain these elements:
4286 0 The match of the full regular expression, including the characters
4287 before and after the proper match
4288 1 The character before the proper match, or empty at beginning of line
4289 2 The proper match, including the leading and trailing markers
4290 3 The leading marker like * or /, indicating the type of highlighting
4291 4 The text between the emphasis markers, not including the markers
4292 5 The character after the match, empty at the end of a line")
4293 (defvar org-verbatim-re nil
4294 "Regular expression for matching verbatim text.")
4295 (defvar org-emphasis-regexp-components) ; defined just below
4296 (defvar org-emphasis-alist) ; defined just below
4297 (defun org-set-emph-re (var val)
4298 "Set variable and compute the emphasis regular expression."
4299 (set var val)
4300 (when (and (boundp 'org-emphasis-alist)
4301 (boundp 'org-emphasis-regexp-components)
4302 org-emphasis-alist org-emphasis-regexp-components)
4303 (let* ((e org-emphasis-regexp-components)
4304 (pre (car e))
4305 (post (nth 1 e))
4306 (border (nth 2 e))
4307 (body (nth 3 e))
4308 (nl (nth 4 e))
4309 (body1 (concat body "*?"))
4310 (markers (mapconcat 'car org-emphasis-alist ""))
4311 (vmarkers (mapconcat
4312 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4313 org-emphasis-alist "")))
4314 ;; make sure special characters appear at the right position in the class
4315 (if (string-match "\\^" markers)
4316 (setq markers (concat (replace-match "" t t markers) "^")))
4317 (if (string-match "-" markers)
4318 (setq markers (concat (replace-match "" t t markers) "-")))
4319 (if (string-match "\\^" vmarkers)
4320 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4321 (if (string-match "-" vmarkers)
4322 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4323 (if (> nl 0)
4324 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4325 (int-to-string nl) "\\}")))
4326 ;; Make the regexp
4327 (setq org-emph-re
4328 (concat "\\([" pre "]\\|^\\)"
4329 "\\("
4330 "\\([" markers "]\\)"
4331 "\\("
4332 "[^" border "]\\|"
4333 "[^" border "]"
4334 body1
4335 "[^" border "]"
4336 "\\)"
4337 "\\3\\)"
4338 "\\([" post "]\\|$\\)"))
4339 (setq org-verbatim-re
4340 (concat "\\([" pre "]\\|^\\)"
4341 "\\("
4342 "\\([" vmarkers "]\\)"
4343 "\\("
4344 "[^" border "]\\|"
4345 "[^" border "]"
4346 body1
4347 "[^" border "]"
4348 "\\)"
4349 "\\3\\)"
4350 "\\([" post "]\\|$\\)")))))
4352 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4353 ;; set this option proved cumbersome. See this message/thread:
4354 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4355 (defvar org-emphasis-regexp-components
4356 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4357 "Components used to build the regular expression for emphasis.
4358 This is a list with five entries. Terminology: In an emphasis string
4359 like \" *strong word* \", we call the initial space PREMATCH, the final
4360 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4361 and \"trong wor\" is the body. The different components in this variable
4362 specify what is allowed/forbidden in each part:
4364 pre Chars allowed as prematch. Beginning of line will be allowed too.
4365 post Chars allowed as postmatch. End of line will be allowed too.
4366 border The chars *forbidden* as border characters.
4367 body-regexp A regexp like \".\" to match a body character. Don't use
4368 non-shy groups here, and don't allow newline here.
4369 newline The maximum number of newlines allowed in an emphasis exp.
4371 You need to reload Org or to restart Emacs after customizing this.")
4373 (defcustom org-emphasis-alist
4374 `(("*" bold)
4375 ("/" italic)
4376 ("_" underline)
4377 ("=" org-verbatim verbatim)
4378 ("~" org-code verbatim)
4379 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4380 "Alist of characters and faces to emphasize text.
4381 Text starting and ending with a special character will be emphasized,
4382 for example *bold*, _underlined_ and /italic/. This variable sets the
4383 marker characters and the face to be used by font-lock for highlighting
4384 in Org-mode Emacs buffers.
4386 You need to reload Org or to restart Emacs after customizing this."
4387 :group 'org-appearance
4388 :set 'org-set-emph-re
4389 :version "24.4"
4390 :package-version '(Org . "8.0")
4391 :type '(repeat
4392 (list
4393 (string :tag "Marker character")
4394 (choice
4395 (face :tag "Font-lock-face")
4396 (plist :tag "Face property list"))
4397 (option (const verbatim)))))
4399 (defvar org-protecting-blocks
4400 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4401 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4402 This is needed for font-lock setup.")
4404 ;;; Miscellaneous options
4406 (defgroup org-completion nil
4407 "Completion in Org-mode."
4408 :tag "Org Completion"
4409 :group 'org)
4411 (defcustom org-completion-use-ido nil
4412 "Non-nil means use ido completion wherever possible.
4413 Note that `ido-mode' must be active for this variable to be relevant.
4414 If you decide to turn this variable on, you might well want to turn off
4415 `org-outline-path-complete-in-steps'.
4416 See also `org-completion-use-iswitchb'."
4417 :group 'org-completion
4418 :type 'boolean)
4420 (defcustom org-completion-use-iswitchb nil
4421 "Non-nil means use iswitchb completion wherever possible.
4422 Note that `iswitchb-mode' must be active for this variable to be relevant.
4423 If you decide to turn this variable on, you might well want to turn off
4424 `org-outline-path-complete-in-steps'.
4425 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4426 :group 'org-completion
4427 :type 'boolean)
4429 (defcustom org-completion-fallback-command 'hippie-expand
4430 "The expansion command called by \\[pcomplete] in normal context.
4431 Normal means, no org-mode-specific context."
4432 :group 'org-completion
4433 :type 'function)
4435 ;;; Functions and variables from their packages
4436 ;; Declared here to avoid compiler warnings
4438 ;; XEmacs only
4439 (defvar outline-mode-menu-heading)
4440 (defvar outline-mode-menu-show)
4441 (defvar outline-mode-menu-hide)
4442 (defvar zmacs-regions) ; XEmacs regions
4444 ;; Emacs only
4445 (defvar mark-active)
4447 ;; Various packages
4448 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4449 (declare-function calendar-forward-day "cal-move" (arg))
4450 (declare-function calendar-goto-date "cal-move" (date))
4451 (declare-function calendar-goto-today "cal-move" ())
4452 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4453 (defvar calc-embedded-close-formula)
4454 (defvar calc-embedded-open-formula)
4455 (declare-function cdlatex-tab "ext:cdlatex" ())
4456 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4457 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4458 (defvar font-lock-unfontify-region-function)
4459 (declare-function iswitchb-read-buffer "iswitchb"
4460 (prompt &optional default require-match start matches-set))
4461 (defvar iswitchb-temp-buflist)
4462 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4463 (defvar org-agenda-tags-todo-honor-ignore-options)
4464 (declare-function org-agenda-skip "org-agenda" ())
4465 (declare-function
4466 org-agenda-format-item "org-agenda"
4467 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4468 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4469 (declare-function org-agenda-change-all-lines "org-agenda"
4470 (newhead hdmarker &optional fixface just-this))
4471 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4472 (declare-function org-agenda-maybe-redo "org-agenda" ())
4473 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4474 (beg end))
4475 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4476 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4477 "org-agenda" (&optional end))
4478 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4479 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4480 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4481 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4482 (declare-function org-indent-mode "org-indent" (&optional arg))
4483 (declare-function parse-time-string "parse-time" (string))
4484 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4485 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4486 (defvar remember-data-file)
4487 (defvar texmathp-why)
4488 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4489 (declare-function table--at-cell-p "table" (position &optional object at-column))
4490 (declare-function calc-eval "calc" (str &optional separator &rest args))
4492 ;;;###autoload
4493 (defun turn-on-orgtbl ()
4494 "Unconditionally turn on `orgtbl-mode'."
4495 (require 'org-table)
4496 (orgtbl-mode 1))
4498 (defun org-at-table-p (&optional table-type)
4499 "Return t if the cursor is inside an org-type table.
4500 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4501 (if org-enable-table-editor
4502 (save-excursion
4503 (beginning-of-line 1)
4504 (looking-at (if table-type org-table-any-line-regexp
4505 org-table-line-regexp)))
4506 nil))
4507 (defsubst org-table-p () (org-at-table-p))
4509 (defun org-at-table.el-p ()
4510 "Return t if and only if we are at a table.el table."
4511 (and (org-at-table-p 'any)
4512 (save-excursion
4513 (goto-char (org-table-begin 'any))
4514 (looking-at org-table1-hline-regexp))))
4516 (defun org-table-recognize-table.el ()
4517 "If there is a table.el table nearby, recognize it and move into it."
4518 (if org-table-tab-recognizes-table.el
4519 (if (org-at-table.el-p)
4520 (progn
4521 (beginning-of-line 1)
4522 (if (looking-at org-table-dataline-regexp)
4524 (if (looking-at org-table1-hline-regexp)
4525 (progn
4526 (beginning-of-line 2)
4527 (if (looking-at org-table-any-border-regexp)
4528 (beginning-of-line -1)))))
4529 (if (re-search-forward "|" (org-table-end t) t)
4530 (progn
4531 (require 'table)
4532 (if (table--at-cell-p (point))
4534 (message "recognizing table.el table...")
4535 (table-recognize-table)
4536 (message "recognizing table.el table...done")))
4537 (error "This should not happen"))
4539 nil)
4540 nil))
4542 (defun org-at-table-hline-p ()
4543 "Return t if the cursor is inside a hline in a table."
4544 (if org-enable-table-editor
4545 (save-excursion
4546 (beginning-of-line 1)
4547 (looking-at org-table-hline-regexp))
4548 nil))
4550 (defun org-table-map-tables (function &optional quietly)
4551 "Apply FUNCTION to the start of all tables in the buffer."
4552 (save-excursion
4553 (save-restriction
4554 (widen)
4555 (goto-char (point-min))
4556 (while (re-search-forward org-table-any-line-regexp nil t)
4557 (unless quietly
4558 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4559 (beginning-of-line 1)
4560 (when (and (looking-at org-table-line-regexp)
4561 ;; Exclude tables in src/example/verbatim/clocktable blocks
4562 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4563 (save-excursion (funcall function))
4564 (or (looking-at org-table-line-regexp)
4565 (forward-char 1)))
4566 (re-search-forward org-table-any-border-regexp nil 1))))
4567 (unless quietly (message "Mapping tables: done")))
4569 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4570 (declare-function org-clock-update-mode-line "org-clock" ())
4571 (declare-function org-resolve-clocks "org-clock"
4572 (&optional also-non-dangling-p prompt last-valid))
4574 (defun org-at-TBLFM-p (&optional pos)
4575 "Return t when point (or POS) is in #+TBLFM line."
4576 (save-excursion
4577 (let ((pos pos)))
4578 (goto-char (or pos (point)))
4579 (beginning-of-line 1)
4580 (looking-at org-TBLFM-regexp)))
4582 (defvar org-clock-start-time)
4583 (defvar org-clock-marker (make-marker)
4584 "Marker recording the last clock-in.")
4585 (defvar org-clock-hd-marker (make-marker)
4586 "Marker recording the last clock-in, but the headline position.")
4587 (defvar org-clock-heading ""
4588 "The heading of the current clock entry.")
4589 (defun org-clock-is-active ()
4590 "Return the buffer where the clock is currently running.
4591 Return nil if no clock is running."
4592 (marker-buffer org-clock-marker))
4594 (defun org-check-running-clock ()
4595 "Check if the current buffer contains the running clock.
4596 If yes, offer to stop it and to save the buffer with the changes."
4597 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4598 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4599 (buffer-name))))
4600 (org-clock-out)
4601 (when (y-or-n-p "Save changed buffer?")
4602 (save-buffer))))
4604 (defun org-clocktable-try-shift (dir n)
4605 "Check if this line starts a clock table, if yes, shift the time block."
4606 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4607 (org-clocktable-shift dir n)))
4609 ;;;###autoload
4610 (defun org-clock-persistence-insinuate ()
4611 "Set up hooks for clock persistence."
4612 (require 'org-clock)
4613 (add-hook 'org-mode-hook 'org-clock-load)
4614 (add-hook 'kill-emacs-hook 'org-clock-save))
4616 (defgroup org-archive nil
4617 "Options concerning archiving in Org-mode."
4618 :tag "Org Archive"
4619 :group 'org-structure)
4621 (defcustom org-archive-location "%s_archive::"
4622 "The location where subtrees should be archived.
4624 The value of this variable is a string, consisting of two parts,
4625 separated by a double-colon. The first part is a filename and
4626 the second part is a headline.
4628 When the filename is omitted, archiving happens in the same file.
4629 %s in the filename will be replaced by the current file
4630 name (without the directory part). Archiving to a different file
4631 is useful to keep archived entries from contributing to the
4632 Org-mode Agenda.
4634 The archived entries will be filed as subtrees of the specified
4635 headline. When the headline is omitted, the subtrees are simply
4636 filed away at the end of the file, as top-level entries. Also in
4637 the heading you can use %s to represent the file name, this can be
4638 useful when using the same archive for a number of different files.
4640 Here are a few examples:
4641 \"%s_archive::\"
4642 If the current file is Projects.org, archive in file
4643 Projects.org_archive, as top-level trees. This is the default.
4645 \"::* Archived Tasks\"
4646 Archive in the current file, under the top-level headline
4647 \"* Archived Tasks\".
4649 \"~/org/archive.org::\"
4650 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4652 \"~/org/archive.org::* From %s\"
4653 Archive in file ~/org/archive.org (absolute path), under headlines
4654 \"From FILENAME\" where file name is the current file name.
4656 \"~/org/datetree.org::datetree/* Finished Tasks\"
4657 The \"datetree/\" string is special, signifying to archive
4658 items to the datetree. Items are placed in either the CLOSED
4659 date of the item, or the current date if there is no CLOSED date.
4660 The heading will be a subentry to the current date. There doesn't
4661 need to be a heading, but there always needs to be a slash after
4662 datetree. For example, to store archived items directly in the
4663 datetree, use \"~/org/datetree.org::datetree/\".
4665 \"basement::** Finished Tasks\"
4666 Archive in file ./basement (relative path), as level 3 trees
4667 below the level 2 heading \"** Finished Tasks\".
4669 You may set this option on a per-file basis by adding to the buffer a
4670 line like
4672 #+ARCHIVE: basement::** Finished Tasks
4674 You may also define it locally for a subtree by setting an ARCHIVE property
4675 in the entry. If such a property is found in an entry, or anywhere up
4676 the hierarchy, it will be used."
4677 :group 'org-archive
4678 :type 'string)
4680 (defcustom org-agenda-skip-archived-trees t
4681 "Non-nil means the agenda will skip any items located in archived trees.
4682 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4683 variable is no longer recommended, you should leave it at the value t.
4684 Instead, use the key `v' to cycle the archives-mode in the agenda."
4685 :group 'org-archive
4686 :group 'org-agenda-skip
4687 :type 'boolean)
4689 (defcustom org-columns-skip-archived-trees t
4690 "Non-nil means ignore archived trees when creating column view."
4691 :group 'org-archive
4692 :group 'org-properties
4693 :type 'boolean)
4695 (defcustom org-cycle-open-archived-trees nil
4696 "Non-nil means `org-cycle' will open archived trees.
4697 An archived tree is a tree marked with the tag ARCHIVE.
4698 When nil, archived trees will stay folded. You can still open them with
4699 normal outline commands like `show-all', but not with the cycling commands."
4700 :group 'org-archive
4701 :group 'org-cycle
4702 :type 'boolean)
4704 (defcustom org-sparse-tree-open-archived-trees nil
4705 "Non-nil means sparse tree construction shows matches in archived trees.
4706 When nil, matches in these trees are highlighted, but the trees are kept in
4707 collapsed state."
4708 :group 'org-archive
4709 :group 'org-sparse-trees
4710 :type 'boolean)
4712 (defcustom org-sparse-tree-default-date-type nil
4713 "The default date type when building a sparse tree.
4714 When this is nil, a date is a scheduled or a deadline timestamp.
4715 Otherwise, these types are allowed:
4717 all: all timestamps
4718 active: only active timestamps (<...>)
4719 inactive: only inactive timestamps ([...])
4720 scheduled: only scheduled timestamps
4721 deadline: only deadline timestamps"
4722 :type '(choice (const :tag "Scheduled or deadline" nil)
4723 (const :tag "All timestamps" all)
4724 (const :tag "Only active timestamps" active)
4725 (const :tag "Only inactive timestamps" inactive)
4726 (const :tag "Only scheduled timestamps" scheduled)
4727 (const :tag "Only deadline timestamps" deadline)
4728 (const :tag "Only closed timestamps" closed))
4729 :version "25.1"
4730 :package-version '(Org . "8.3")
4731 :group 'org-sparse-trees)
4733 (defun org-cycle-hide-archived-subtrees (state)
4734 "Re-hide all archived subtrees after a visibility state change."
4735 (when (and (not org-cycle-open-archived-trees)
4736 (not (memq state '(overview folded))))
4737 (save-excursion
4738 (let* ((globalp (memq state '(contents all)))
4739 (beg (if globalp (point-min) (point)))
4740 (end (if globalp (point-max) (org-end-of-subtree t))))
4741 (org-hide-archived-subtrees beg end)
4742 (goto-char beg)
4743 (if (looking-at (concat ".*:" org-archive-tag ":"))
4744 (message "%s" (substitute-command-keys
4745 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4747 (defun org-force-cycle-archived ()
4748 "Cycle subtree even if it is archived."
4749 (interactive)
4750 (setq this-command 'org-cycle)
4751 (let ((org-cycle-open-archived-trees t))
4752 (call-interactively 'org-cycle)))
4754 (defun org-hide-archived-subtrees (beg end)
4755 "Re-hide all archived subtrees after a visibility state change."
4756 (org-with-wide-buffer
4757 (let ((case-fold-search nil)
4758 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4759 (goto-char beg)
4760 (while (and (< (point) end) (re-search-forward re end t))
4761 (when (member org-archive-tag (org-get-tags))
4762 (org-flag-subtree t)
4763 (org-end-of-subtree t))))))
4765 (declare-function outline-end-of-heading "outline" ())
4766 (declare-function outline-flag-region "outline" (from to flag))
4767 (defun org-flag-subtree (flag)
4768 (save-excursion
4769 (org-back-to-heading t)
4770 (outline-end-of-heading)
4771 (outline-flag-region (point)
4772 (progn (org-end-of-subtree t) (point))
4773 flag)))
4775 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4777 ;; Declare Column View Code
4779 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4780 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4781 (declare-function org-columns-compute "org-colview" (property))
4783 ;; Declare ID code
4785 (declare-function org-id-store-link "org-id")
4786 (declare-function org-id-locations-load "org-id")
4787 (declare-function org-id-locations-save "org-id")
4788 (defvar org-id-track-globally)
4790 ;;; Variables for pre-computed regular expressions, all buffer local
4792 (defvar org-todo-regexp nil
4793 "Matches any of the TODO state keywords.")
4794 (make-variable-buffer-local 'org-todo-regexp)
4795 (defvar org-not-done-regexp nil
4796 "Matches any of the TODO state keywords except the last one.")
4797 (make-variable-buffer-local 'org-not-done-regexp)
4798 (defvar org-not-done-heading-regexp nil
4799 "Matches a TODO headline that is not done.")
4800 (make-variable-buffer-local 'org-not-done-regexp)
4801 (defvar org-todo-line-regexp nil
4802 "Matches a headline and puts TODO state into group 2 if present.")
4803 (make-variable-buffer-local 'org-todo-line-regexp)
4804 (defvar org-complex-heading-regexp nil
4805 "Matches a headline and puts everything into groups:
4806 group 1: the stars
4807 group 2: The todo keyword, maybe
4808 group 3: Priority cookie
4809 group 4: True headline
4810 group 5: Tags")
4811 (make-variable-buffer-local 'org-complex-heading-regexp)
4812 (defvar org-complex-heading-regexp-format nil
4813 "Printf format to make regexp to match an exact headline.
4814 This regexp will match the headline of any node which has the
4815 exact headline text that is put into the format, but may have any
4816 TODO state, priority and tags.")
4817 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4818 (defvar org-todo-line-tags-regexp nil
4819 "Matches a headline and puts TODO state into group 2 if present.
4820 Also put tags into group 4 if tags are present.")
4821 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4823 (defconst org-plain-time-of-day-regexp
4824 (concat
4825 "\\(\\<[012]?[0-9]"
4826 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4827 "\\(--?"
4828 "\\(\\<[012]?[0-9]"
4829 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4830 "\\)?")
4831 "Regular expression to match a plain time or time range.
4832 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4833 groups carry important information:
4834 0 the full match
4835 1 the first time, range or not
4836 8 the second time, if it is a range.")
4838 (defconst org-plain-time-extension-regexp
4839 (concat
4840 "\\(\\<[012]?[0-9]"
4841 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4842 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4843 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4844 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4845 groups carry important information:
4846 0 the full match
4847 7 hours of duration
4848 9 minutes of duration")
4850 (defconst org-stamp-time-of-day-regexp
4851 (concat
4852 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4853 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4854 "\\(--?"
4855 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4856 "Regular expression to match a timestamp time or time range.
4857 After a match, the following groups carry important information:
4858 0 the full match
4859 1 date plus weekday, for back referencing to make sure both times are on the same day
4860 2 the first time, range or not
4861 4 the second time, if it is a range.")
4863 (defconst org-startup-options
4864 '(("fold" org-startup-folded t)
4865 ("overview" org-startup-folded t)
4866 ("nofold" org-startup-folded nil)
4867 ("showall" org-startup-folded nil)
4868 ("showeverything" org-startup-folded showeverything)
4869 ("content" org-startup-folded content)
4870 ("indent" org-startup-indented t)
4871 ("noindent" org-startup-indented nil)
4872 ("hidestars" org-hide-leading-stars t)
4873 ("showstars" org-hide-leading-stars nil)
4874 ("odd" org-odd-levels-only t)
4875 ("oddeven" org-odd-levels-only nil)
4876 ("align" org-startup-align-all-tables t)
4877 ("noalign" org-startup-align-all-tables nil)
4878 ("inlineimages" org-startup-with-inline-images t)
4879 ("noinlineimages" org-startup-with-inline-images nil)
4880 ("latexpreview" org-startup-with-latex-preview t)
4881 ("nolatexpreview" org-startup-with-latex-preview nil)
4882 ("customtime" org-display-custom-times t)
4883 ("logdone" org-log-done time)
4884 ("lognotedone" org-log-done note)
4885 ("nologdone" org-log-done nil)
4886 ("lognoteclock-out" org-log-note-clock-out t)
4887 ("nolognoteclock-out" org-log-note-clock-out nil)
4888 ("logrepeat" org-log-repeat state)
4889 ("lognoterepeat" org-log-repeat note)
4890 ("logdrawer" org-log-into-drawer t)
4891 ("nologdrawer" org-log-into-drawer nil)
4892 ("logstatesreversed" org-log-states-order-reversed t)
4893 ("nologstatesreversed" org-log-states-order-reversed nil)
4894 ("nologrepeat" org-log-repeat nil)
4895 ("logreschedule" org-log-reschedule time)
4896 ("lognotereschedule" org-log-reschedule note)
4897 ("nologreschedule" org-log-reschedule nil)
4898 ("logredeadline" org-log-redeadline time)
4899 ("lognoteredeadline" org-log-redeadline note)
4900 ("nologredeadline" org-log-redeadline nil)
4901 ("logrefile" org-log-refile time)
4902 ("lognoterefile" org-log-refile note)
4903 ("nologrefile" org-log-refile nil)
4904 ("fninline" org-footnote-define-inline t)
4905 ("nofninline" org-footnote-define-inline nil)
4906 ("fnlocal" org-footnote-section nil)
4907 ("fnauto" org-footnote-auto-label t)
4908 ("fnprompt" org-footnote-auto-label nil)
4909 ("fnconfirm" org-footnote-auto-label confirm)
4910 ("fnplain" org-footnote-auto-label plain)
4911 ("fnadjust" org-footnote-auto-adjust t)
4912 ("nofnadjust" org-footnote-auto-adjust nil)
4913 ("constcgs" constants-unit-system cgs)
4914 ("constSI" constants-unit-system SI)
4915 ("noptag" org-tag-persistent-alist nil)
4916 ("hideblocks" org-hide-block-startup t)
4917 ("nohideblocks" org-hide-block-startup nil)
4918 ("beamer" org-startup-with-beamer-mode t)
4919 ("entitiespretty" org-pretty-entities t)
4920 ("entitiesplain" org-pretty-entities nil))
4921 "Variable associated with STARTUP options for org-mode.
4922 Each element is a list of three items: the startup options (as written
4923 in the #+STARTUP line), the corresponding variable, and the value to set
4924 this variable to if the option is found. An optional forth element PUSH
4925 means to push this value onto the list in the variable.")
4927 (defcustom org-group-tags t
4928 "When non-nil (the default), use group tags.
4929 This can be turned on/off through `org-toggle-tags-groups'."
4930 :group 'org-tags
4931 :group 'org-startup
4932 :type 'boolean)
4934 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4936 (defun org-toggle-tags-groups ()
4937 "Toggle support for group tags.
4938 Support for group tags is controlled by the option
4939 `org-group-tags', which is non-nil by default."
4940 (interactive)
4941 (setq org-group-tags (not org-group-tags))
4942 (cond ((and (derived-mode-p 'org-agenda-mode)
4943 org-group-tags)
4944 (org-agenda-redo))
4945 ((derived-mode-p 'org-mode)
4946 (let ((org-inhibit-startup t)) (org-mode))))
4947 (message "Groups tags support has been turned %s"
4948 (if org-group-tags "on" "off")))
4950 (defun org-set-regexps-and-options (&optional tags-only)
4951 "Precompute regular expressions used in the current buffer.
4952 When optional argument TAGS-ONLY is non-nil, only compute tags
4953 related expressions."
4954 (when (derived-mode-p 'org-mode)
4955 (let ((alist (org--setup-collect-keywords
4956 (org-make-options-regexp
4957 (append '("FILETAGS" "TAGS" "SETUPFILE")
4958 (and (not tags-only)
4959 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4960 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4961 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4962 (org--setup-process-tags
4963 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4964 (unless tags-only
4965 ;; File properties.
4966 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4967 ;; Archive location.
4968 (let ((archive (cdr (assq 'archive alist))))
4969 (when archive (org-set-local 'org-archive-location archive)))
4970 ;; Category.
4971 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4972 (when cat
4973 (org-set-local 'org-category (intern cat))
4974 (org-set-local 'org-file-properties
4975 (org--update-property-plist
4976 "CATEGORY" cat org-file-properties))))
4977 ;; Columns.
4978 (let ((column (cdr (assq 'columns alist))))
4979 (when column (org-set-local 'org-columns-default-format column)))
4980 ;; Constants.
4981 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4982 ;; Link abbreviations.
4983 (let ((links (cdr (assq 'link alist))))
4984 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4985 ;; Priorities.
4986 (let ((priorities (cdr (assq 'priorities alist))))
4987 (when priorities
4988 (org-set-local 'org-highest-priority (nth 0 priorities))
4989 (org-set-local 'org-lowest-priority (nth 1 priorities))
4990 (org-set-local 'org-default-priority (nth 2 priorities))))
4991 ;; Scripts.
4992 (let ((scripts (assq 'scripts alist)))
4993 (when scripts
4994 (org-set-local 'org-use-sub-superscripts (cdr scripts))))
4995 ;; Startup options.
4996 (let ((startup (cdr (assq 'startup alist))))
4997 (dolist (option startup)
4998 (let ((entry (assoc-string option org-startup-options t)))
4999 (when entry
5000 (let ((var (nth 1 entry))
5001 (val (nth 2 entry)))
5002 (if (not (nth 3 entry)) (org-set-local var val)
5003 (unless (listp (symbol-value var))
5004 (org-set-local var nil))
5005 (add-to-list var val)))))))
5006 ;; TODO keywords.
5007 (org-set-local 'org-todo-kwd-alist nil)
5008 (org-set-local 'org-todo-key-alist nil)
5009 (org-set-local 'org-todo-key-trigger nil)
5010 (org-set-local 'org-todo-keywords-1 nil)
5011 (org-set-local 'org-done-keywords nil)
5012 (org-set-local 'org-todo-heads nil)
5013 (org-set-local 'org-todo-sets nil)
5014 (org-set-local 'org-todo-log-states nil)
5015 (let ((todo-sequences
5016 (or (nreverse (cdr (assq 'todo alist)))
5017 (let ((d (default-value 'org-todo-keywords)))
5018 (if (not (stringp (car d))) d
5019 ;; XXX: Backward compatibility code.
5020 (list (cons org-todo-interpretation d)))))))
5021 (dolist (sequence todo-sequences)
5022 (let* ((sequence (or (run-hook-with-args-until-success
5023 'org-todo-setup-filter-hook sequence)
5024 sequence))
5025 (sequence-type (car sequence))
5026 (keywords (cdr sequence))
5027 (sep (member "|" keywords))
5028 names alist)
5029 (dolist (k (remove "|" keywords))
5030 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5032 (error "Invalid TODO keyword %s" k))
5033 (let ((name (match-string 1 k))
5034 (key (match-string 2 k))
5035 (log (org-extract-log-state-settings k)))
5036 (push name names)
5037 (push (cons name (and key (string-to-char key))) alist)
5038 (when log (push log org-todo-log-states))))
5039 (let* ((names (nreverse names))
5040 (done (if sep (org-remove-keyword-keys (cdr sep))
5041 (last names)))
5042 (head (car names))
5043 (tail (list sequence-type head (car done) (org-last done))))
5044 (add-to-list 'org-todo-heads head 'append)
5045 (push names org-todo-sets)
5046 (setq org-done-keywords (append org-done-keywords done nil))
5047 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5048 (setq org-todo-key-alist
5049 (append org-todo-key-alist
5050 (and alist
5051 (append '((:startgroup))
5052 (nreverse alist)
5053 '((:endgroup))))))
5054 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5055 (setq org-todo-sets (nreverse org-todo-sets)
5056 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5057 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5058 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5059 ;; Compute the regular expressions and other local variables.
5060 ;; Using `org-outline-regexp-bol' would complicate them much,
5061 ;; because of the fixed white space at the end of that string.
5062 (if (not org-done-keywords)
5063 (setq org-done-keywords
5064 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5065 (setq org-not-done-keywords
5066 (org-delete-all org-done-keywords
5067 (copy-sequence org-todo-keywords-1))
5068 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5069 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5070 org-not-done-heading-regexp
5071 (format org-heading-keyword-regexp-format org-not-done-regexp)
5072 org-todo-line-regexp
5073 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5074 org-complex-heading-regexp
5075 (concat "^\\(\\*+\\)"
5076 "\\(?: +" org-todo-regexp "\\)?"
5077 "\\(?: +\\(\\[#.\\]\\)\\)?"
5078 "\\(?: +\\(.*?\\)\\)??"
5079 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5080 "[ \t]*$")
5081 org-complex-heading-regexp-format
5082 (concat "^\\(\\*+\\)"
5083 "\\(?: +" org-todo-regexp "\\)?"
5084 "\\(?: +\\(\\[#.\\]\\)\\)?"
5085 "\\(?: +"
5086 ;; Stats cookies can be stuck to body.
5087 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5088 "\\(%s\\)"
5089 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5090 "\\)"
5091 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5092 "[ \t]*$")
5093 org-todo-line-tags-regexp
5094 (concat "^\\(\\*+\\)"
5095 "\\(?: +" org-todo-regexp "\\)?"
5096 "\\(?: +\\(.*?\\)\\)??"
5097 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5098 "[ \t]*$"))
5099 (org-compute-latex-and-related-regexp)))))
5101 (defun org--setup-collect-keywords (regexp &optional files alist)
5102 "Return setup keywords values as an alist.
5104 REGEXP matches a subset of setup keywords. FILES is a list of
5105 file names already visited. It is used to avoid circular setup
5106 files. ALIST, when non-nil, is the alist computed so far.
5108 Return value contains the following keys: `archive', `category',
5109 `columns', `constants', `filetags', `link', `priorities',
5110 `property', `scripts', `startup', `tags' and `todo'."
5111 (org-with-wide-buffer
5112 (goto-char (point-min))
5113 (let ((case-fold-search t))
5114 (while (re-search-forward regexp nil t)
5115 (let ((element (org-element-at-point)))
5116 (when (eq (org-element-type element) 'keyword)
5117 (let ((key (org-element-property :key element))
5118 (value (org-element-property :value element)))
5119 (cond
5120 ((equal key "ARCHIVE")
5121 (when (org-string-nw-p value)
5122 (push (cons 'archive value) alist)))
5123 ((equal key "CATEGORY") (push (cons 'category value) alist))
5124 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5125 ((equal key "CONSTANTS")
5126 (let* ((constants (assq 'constants alist))
5127 (store (cdr constants)))
5128 (dolist (pair (org-split-string value))
5129 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5130 pair)
5131 (let* ((name (match-string 1 pair))
5132 (value (match-string 2 pair))
5133 (old (assoc name store)))
5134 (if old (setcdr old value)
5135 (push (cons name value) store)))))
5136 (if constants (setcdr constants store)
5137 (push (cons 'constants store) alist))))
5138 ((equal key "FILETAGS")
5139 (when (org-string-nw-p value)
5140 (let ((old (assq 'filetags alist))
5141 (new (apply #'nconc
5142 (mapcar (lambda (x) (org-split-string x ":"))
5143 (org-split-string value)))))
5144 (if old (setcdr old (append new (cdr old)))
5145 (push (cons 'filetags new) alist)))))
5146 ((equal key "LINK")
5147 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5148 (let ((links (assq 'link alist))
5149 (pair (cons (org-match-string-no-properties 1 value)
5150 (org-match-string-no-properties 2 value))))
5151 (if links (push pair (cdr links))
5152 (push (list 'link pair) alist)))))
5153 ((equal key "OPTIONS")
5154 (when (and (org-string-nw-p value)
5155 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5156 (push (cons 'scripts (read (match-string 1 value))) alist)))
5157 ((equal key "PRIORITIES")
5158 (push (cons 'priorities
5159 (let ((prio (org-split-string value)))
5160 (if (< (length prio) 3) '(?A ?C ?B)
5161 (mapcar #'string-to-char prio))))
5162 alist))
5163 ((equal key "PROPERTY")
5164 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5165 (let* ((property (assq 'property alist))
5166 (value (org--update-property-plist
5167 (org-match-string-no-properties 1 value)
5168 (org-match-string-no-properties 2 value)
5169 (cdr property))))
5170 (if property (setcdr property value)
5171 (push (cons 'property value) alist)))))
5172 ((equal key "STARTUP")
5173 (let ((startup (assq 'startup alist)))
5174 (if startup
5175 (setcdr startup
5176 (append (cdr startup) (org-split-string value)))
5177 (push (cons 'startup (org-split-string value)) alist))))
5178 ((equal key "TAGS")
5179 (let ((tag-cell (assq 'tags alist)))
5180 (if tag-cell
5181 (setcdr tag-cell
5182 (append (cdr tag-cell)
5183 '("\\n")
5184 (org-split-string value)))
5185 (push (cons 'tags (org-split-string value)) alist))))
5186 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5187 (let ((todo (assq 'todo alist))
5188 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5189 (org-split-string value))))
5190 (if todo (push value (cdr todo))
5191 (push (list 'todo value) alist))))
5192 ((equal key "SETUPFILE")
5193 (unless buffer-read-only ; Do not check in Gnus messages.
5194 (let ((f (and (org-string-nw-p value)
5195 (expand-file-name
5196 (org-remove-double-quotes value)))))
5197 (when (and f (file-readable-p f) (not (member f files)))
5198 (with-temp-buffer
5199 (insert-file-contents f)
5200 (setq alist
5201 ;; Fake Org mode to benefit from cache
5202 ;; without recurring needlessly.
5203 (let ((major-mode 'org-mode))
5204 (org--setup-collect-keywords
5205 regexp (cons f files) alist)))))))))))))))
5206 alist)
5208 (defun org--setup-process-tags (tags filetags)
5209 "Precompute variables used for tags.
5210 TAGS is a list of tags and tag group symbols, as strings.
5211 FILETAGS is a list of tags, as strings."
5212 ;; Process the file tags.
5213 (org-set-local 'org-file-tags
5214 (mapcar #'org-add-prop-inherited filetags))
5215 ;; Provide default tags if no local tags are found.
5216 (when (and (not tags) org-tag-alist)
5217 (setq tags
5218 (mapcar (lambda (tag)
5219 (case (car tag)
5220 (:startgroup "{")
5221 (:endgroup "}")
5222 (:grouptags ":")
5223 (:newline "\\n")
5224 (otherwise (concat (car tag)
5225 (and (characterp (cdr tag))
5226 (format "(%c)" (cdr tag)))))))
5227 org-tag-alist)))
5228 ;; Process the tags.
5229 (org-set-local 'org-tag-groups-alist nil)
5230 (org-set-local 'org-tag-alist nil)
5231 (let (group-flag)
5232 (while tags
5233 (let ((e (car tags)))
5234 (setq tags (cdr tags))
5235 (cond
5236 ((equal e "{")
5237 (push '(:startgroup) org-tag-alist)
5238 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5239 ((equal e "}")
5240 (push '(:endgroup) org-tag-alist)
5241 (setq group-flag nil))
5242 ((equal e ":")
5243 (push '(:grouptags) org-tag-alist)
5244 (setq group-flag 'append))
5245 ((equal e "\\n") (push '(:newline) org-tag-alist))
5246 ((string-match
5247 (org-re "\\`\\([[:alnum:]_@#%]+\\)\\(?:(\\(.\\))\\)?\\'") e)
5248 (let ((tag (match-string 1 e))
5249 (key (and (match-beginning 2)
5250 (string-to-char (match-string 2 e)))))
5251 (cond ((eq group-flag 'append)
5252 (setcar org-tag-groups-alist
5253 (append (car org-tag-groups-alist) (list tag))))
5254 (group-flag (push (list tag) org-tag-groups-alist)))
5255 (unless (assoc tag org-tag-alist)
5256 (push (cons tag key) org-tag-alist))))))))
5257 (setq org-tag-alist (nreverse org-tag-alist)))
5259 (defun org-file-contents (file &optional noerror)
5260 "Return the contents of FILE, as a string."
5261 (if (and file (file-readable-p file))
5262 (with-temp-buffer
5263 (insert-file-contents file)
5264 (buffer-string))
5265 (funcall (if noerror 'message 'error)
5266 "Cannot read file \"%s\"%s"
5267 file
5268 (let ((from (buffer-file-name (buffer-base-buffer))))
5269 (if from (concat " (referenced in file \"" from "\")") "")))))
5271 (defun org-extract-log-state-settings (x)
5272 "Extract the log state setting from a TODO keyword string.
5273 This will extract info from a string like \"WAIT(w@/!)\"."
5274 (let (kw key log1 log2)
5275 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5276 (setq kw (match-string 1 x)
5277 key (and (match-end 2) (match-string 2 x))
5278 log1 (and (match-end 3) (match-string 3 x))
5279 log2 (and (match-end 4) (match-string 4 x)))
5280 (and (or log1 log2)
5281 (list kw
5282 (and log1 (if (equal log1 "!") 'time 'note))
5283 (and log2 (if (equal log2 "!") 'time 'note)))))))
5285 (defun org-remove-keyword-keys (list)
5286 "Remove a pair of parenthesis at the end of each string in LIST."
5287 (mapcar (lambda (x)
5288 (if (string-match "(.*)$" x)
5289 (substring x 0 (match-beginning 0))
5291 list))
5293 (defun org-assign-fast-keys (alist)
5294 "Assign fast keys to a keyword-key alist.
5295 Respect keys that are already there."
5296 (let (new e (alt ?0))
5297 (while (setq e (pop alist))
5298 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5299 (cdr e)) ;; Key already assigned.
5300 (push e new)
5301 (let ((clist (string-to-list (downcase (car e))))
5302 (used (append new alist)))
5303 (when (= (car clist) ?@)
5304 (pop clist))
5305 (while (and clist (rassoc (car clist) used))
5306 (pop clist))
5307 (unless clist
5308 (while (rassoc alt used)
5309 (incf alt)))
5310 (push (cons (car e) (or (car clist) alt)) new))))
5311 (nreverse new)))
5313 ;;; Some variables used in various places
5315 (defvar org-window-configuration nil
5316 "Used in various places to store a window configuration.")
5317 (defvar org-selected-window nil
5318 "Used in various places to store a window configuration.")
5319 (defvar org-finish-function nil
5320 "Function to be called when `C-c C-c' is used.
5321 This is for getting out of special buffers like capture.")
5324 ;; FIXME: Occasionally check by commenting these, to make sure
5325 ;; no other functions uses these, forgetting to let-bind them.
5326 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5327 (defvar org-last-state)
5328 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5330 ;; Defined somewhere in this file, but used before definition.
5331 (defvar org-entities) ;; defined in org-entities.el
5332 (defvar org-struct-menu)
5333 (defvar org-org-menu)
5334 (defvar org-tbl-menu)
5336 ;;;; Define the Org-mode
5338 ;; We use a before-change function to check if a table might need
5339 ;; an update.
5340 (defvar org-table-may-need-update t
5341 "Indicates that a table might need an update.
5342 This variable is set by `org-before-change-function'.
5343 `org-table-align' sets it back to nil.")
5344 (defun org-before-change-function (beg end)
5345 "Every change indicates that a table might need an update."
5346 (setq org-table-may-need-update t))
5347 (defvar org-mode-map)
5348 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5349 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5350 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5351 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5352 (defvar org-table-buffer-is-an nil)
5354 (defvar bidi-paragraph-direction)
5355 (defvar buffer-face-mode-face)
5357 (require 'outline)
5358 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5359 (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"))
5360 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5362 ;; Other stuff we need.
5363 (require 'time-date)
5364 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5365 (require 'easymenu)
5366 (require 'overlay)
5368 ;; (require 'org-macs) moved higher up in the file before it is first used
5369 (require 'org-entities)
5370 ;; (require 'org-compat) moved higher up in the file before it is first used
5371 (require 'org-faces)
5372 (require 'org-list)
5373 (require 'org-pcomplete)
5374 (require 'org-src)
5375 (require 'org-footnote)
5376 (require 'org-macro)
5378 ;; babel
5379 (require 'ob)
5381 ;;;###autoload
5382 (define-derived-mode org-mode outline-mode "Org"
5383 "Outline-based notes management and organizer, alias
5384 \"Carsten's outline-mode for keeping track of everything.\"
5386 Org-mode develops organizational tasks around a NOTES file which
5387 contains information about projects as plain text. Org-mode is
5388 implemented on top of outline-mode, which is ideal to keep the content
5389 of large files well structured. It supports ToDo items, deadlines and
5390 time stamps, which magically appear in the diary listing of the Emacs
5391 calendar. Tables are easily created with a built-in table editor.
5392 Plain text URL-like links connect to websites, emails (VM), Usenet
5393 messages (Gnus), BBDB entries, and any files related to the project.
5394 For printing and sharing of notes, an Org-mode file (or a part of it)
5395 can be exported as a structured ASCII or HTML file.
5397 The following commands are available:
5399 \\{org-mode-map}"
5401 ;; Get rid of Outline menus, they are not needed
5402 ;; Need to do this here because define-derived-mode sets up
5403 ;; the keymap so late. Still, it is a waste to call this each time
5404 ;; we switch another buffer into org-mode.
5405 (if (featurep 'xemacs)
5406 (when (boundp 'outline-mode-menu-heading)
5407 ;; Assume this is Greg's port, it uses easymenu
5408 (easy-menu-remove outline-mode-menu-heading)
5409 (easy-menu-remove outline-mode-menu-show)
5410 (easy-menu-remove outline-mode-menu-hide))
5411 (define-key org-mode-map [menu-bar headings] 'undefined)
5412 (define-key org-mode-map [menu-bar hide] 'undefined)
5413 (define-key org-mode-map [menu-bar show] 'undefined))
5415 (org-load-modules-maybe)
5416 (easy-menu-add org-org-menu)
5417 (easy-menu-add org-tbl-menu)
5418 (org-install-agenda-files-menu)
5419 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5420 (add-to-invisibility-spec '(org-cwidth))
5421 (add-to-invisibility-spec '(org-hide-block . t))
5422 (when (featurep 'xemacs)
5423 (org-set-local 'line-move-ignore-invisible t))
5424 (org-set-local 'outline-regexp org-outline-regexp)
5425 (org-set-local 'outline-level 'org-outline-level)
5426 (setq bidi-paragraph-direction 'left-to-right)
5427 (when (and org-ellipsis
5428 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5429 (fboundp 'make-glyph-code))
5430 (unless org-display-table
5431 (setq org-display-table (make-display-table)))
5432 (set-display-table-slot
5433 org-display-table 4
5434 (vconcat (mapcar
5435 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5436 org-ellipsis)))
5437 (if (stringp org-ellipsis) org-ellipsis "..."))))
5438 (setq buffer-display-table org-display-table))
5439 (org-set-regexps-and-options)
5440 (org-set-font-lock-defaults)
5441 (when (and org-tag-faces (not org-tags-special-faces-re))
5442 ;; tag faces set outside customize.... force initialization.
5443 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5444 ;; Calc embedded
5445 (org-set-local 'calc-embedded-open-mode "# ")
5446 ;; Modify a few syntax entries
5447 (modify-syntax-entry ?@ "w")
5448 (modify-syntax-entry ?\" "\"")
5449 (modify-syntax-entry ?\\ "_")
5450 (modify-syntax-entry ?~ "_")
5451 (if org-startup-truncated (setq truncate-lines t))
5452 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5453 (org-set-local 'font-lock-unfontify-region-function
5454 'org-unfontify-region)
5455 ;; Activate before-change-function
5456 (org-set-local 'org-table-may-need-update t)
5457 (org-add-hook 'before-change-functions 'org-before-change-function nil
5458 'local)
5459 ;; Check for running clock before killing a buffer
5460 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5461 ;; Initialize macros templates.
5462 (org-macro-initialize-templates)
5463 ;; Initialize radio targets.
5464 (org-update-radio-target-regexp)
5465 ;; Indentation.
5466 (org-set-local 'indent-line-function 'org-indent-line)
5467 (org-set-local 'indent-region-function 'org-indent-region)
5468 ;; Filling and auto-filling.
5469 (org-setup-filling)
5470 ;; Comments.
5471 (org-setup-comments-handling)
5472 ;; Initialize cache.
5473 (org-element-cache-reset)
5474 ;; Beginning/end of defun
5475 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5476 (org-set-local 'end-of-defun-function
5477 (lambda ()
5478 (if (not (org-at-heading-p))
5479 (org-forward-element)
5480 (org-forward-element)
5481 (forward-char -1))))
5482 ;; Next error for sparse trees
5483 (org-set-local 'next-error-function 'org-occur-next-match)
5484 ;; Make sure dependence stuff works reliably, even for users who set it
5485 ;; too late :-(
5486 (if org-enforce-todo-dependencies
5487 (add-hook 'org-blocker-hook
5488 'org-block-todo-from-children-or-siblings-or-parent)
5489 (remove-hook 'org-blocker-hook
5490 'org-block-todo-from-children-or-siblings-or-parent))
5491 (if org-enforce-todo-checkbox-dependencies
5492 (add-hook 'org-blocker-hook
5493 'org-block-todo-from-checkboxes)
5494 (remove-hook 'org-blocker-hook
5495 'org-block-todo-from-checkboxes))
5497 ;; Align options lines
5498 (org-set-local
5499 'align-mode-rules-list
5500 '((org-in-buffer-settings
5501 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5502 (modes . '(org-mode)))))
5504 ;; Imenu
5505 (org-set-local 'imenu-create-index-function
5506 'org-imenu-get-tree)
5508 ;; Make isearch reveal context
5509 (if (or (featurep 'xemacs)
5510 (not (boundp 'outline-isearch-open-invisible-function)))
5511 ;; Emacs 21 and XEmacs make use of the hook
5512 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5513 ;; Emacs 22 deals with this through a special variable
5514 (org-set-local 'outline-isearch-open-invisible-function
5515 (lambda (&rest ignore) (org-show-context 'isearch))))
5517 ;; Setup the pcomplete hooks
5518 (set (make-local-variable 'pcomplete-command-completion-function)
5519 'org-pcomplete-initial)
5520 (set (make-local-variable 'pcomplete-command-name-function)
5521 'org-command-at-point)
5522 (set (make-local-variable 'pcomplete-default-completion-function)
5523 'ignore)
5524 (set (make-local-variable 'pcomplete-parse-arguments-function)
5525 'org-parse-arguments)
5526 (set (make-local-variable 'pcomplete-termination-string) "")
5527 (when (>= emacs-major-version 23)
5528 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5530 ;; If empty file that did not turn on org-mode automatically, make it to.
5531 (if (and org-insert-mode-line-in-empty-file
5532 (org-called-interactively-p 'any)
5533 (= (point-min) (point-max)))
5534 (insert "# -*- mode: org -*-\n\n"))
5535 (unless org-inhibit-startup
5536 (org-unmodified
5537 (and org-startup-with-beamer-mode (org-beamer-mode))
5538 (when org-startup-align-all-tables
5539 (org-table-map-tables 'org-table-align 'quietly))
5540 (when org-startup-with-inline-images
5541 (org-display-inline-images))
5542 (when org-startup-with-latex-preview
5543 (org-toggle-latex-fragment))
5544 (unless org-inhibit-startup-visibility-stuff
5545 (org-set-startup-visibility))
5546 (org-refresh-effort-properties)))
5547 ;; Try to set org-hide correctly
5548 (let ((foreground (org-find-invisible-foreground)))
5549 (if foreground
5550 (set-face-foreground 'org-hide foreground))))
5552 ;; Update `customize-package-emacs-version-alist'
5553 (add-to-list 'customize-package-emacs-version-alist
5554 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5555 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5556 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5558 (defvar org-mode-transpose-word-syntax-table
5559 (let ((st (make-syntax-table text-mode-syntax-table)))
5560 (mapc (lambda(c) (modify-syntax-entry
5561 (string-to-char (car c)) "w p" st))
5562 org-emphasis-alist)
5563 st))
5565 (when (fboundp 'abbrev-table-put)
5566 (abbrev-table-put org-mode-abbrev-table
5567 :parents (list text-mode-abbrev-table)))
5569 (defun org-find-invisible-foreground ()
5570 (let ((candidates (remove
5571 "unspecified-bg"
5572 (nconc
5573 (list (face-background 'default)
5574 (face-background 'org-default))
5575 (mapcar
5576 (lambda (alist)
5577 (when (boundp alist)
5578 (cdr (assoc 'background-color (symbol-value alist)))))
5579 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5580 (list (face-foreground 'org-hide))))))
5581 (car (remove nil candidates))))
5583 (defun org-current-time (&optional rounding-minutes past)
5584 "Current time, possibly rounded to ROUNDING-MINUTES.
5585 When ROUNDING-MINUTES is not an integer, fall back on the car of
5586 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5587 the rounding returns a past time."
5588 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5589 (car org-time-stamp-rounding-minutes)))
5590 (time (decode-time)) res)
5591 (if (< r 1)
5592 (current-time)
5593 (setq res
5594 (apply 'encode-time
5595 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5596 (nthcdr 2 time))))
5597 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5598 (seconds-to-time (- (org-float-time res) (* r 60)))
5599 res))))
5601 (defun org-today ()
5602 "Return today date, considering `org-extend-today-until'."
5603 (time-to-days
5604 (time-subtract (current-time)
5605 (list 0 (* 3600 org-extend-today-until) 0))))
5607 ;;;; Font-Lock stuff, including the activators
5609 (defvar org-mouse-map (make-sparse-keymap))
5610 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5611 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5612 (when org-mouse-1-follows-link
5613 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5614 (when org-tab-follows-link
5615 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5616 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5618 (require 'font-lock)
5620 (defconst org-non-link-chars "]\t\n\r<>")
5621 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5622 "file+sys" "news" "shell" "elisp" "doi" "message"
5623 "help"))
5624 (defvar org-link-types-re nil
5625 "Matches a link that has a url-like prefix like \"http:\"")
5626 (defvar org-link-re-with-space nil
5627 "Matches a link with spaces, optional angular brackets around it.")
5628 (defvar org-link-re-with-space2 nil
5629 "Matches a link with spaces, optional angular brackets around it.")
5630 (defvar org-link-re-with-space3 nil
5631 "Matches a link with spaces, only for internal part in bracket links.")
5632 (defvar org-angle-link-re nil
5633 "Matches link with angular brackets, spaces are allowed.")
5634 (defvar org-plain-link-re nil
5635 "Matches plain link, without spaces.")
5636 (defvar org-bracket-link-regexp nil
5637 "Matches a link in double brackets.")
5638 (defvar org-bracket-link-analytic-regexp nil
5639 "Regular expression used to analyze links.
5640 Here is what the match groups contain after a match:
5641 1: http:
5642 2: http
5643 3: path
5644 4: [desc]
5645 5: desc")
5646 (defvar org-bracket-link-analytic-regexp++ nil
5647 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5648 (defvar org-any-link-re nil
5649 "Regular expression matching any link.")
5651 (defconst org-match-sexp-depth 3
5652 "Number of stacked braces for sub/superscript matching.")
5654 (defun org-create-multibrace-regexp (left right n)
5655 "Create a regular expression which will match a balanced sexp.
5656 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5657 as single character strings.
5658 The regexp returned will match the entire expression including the
5659 delimiters. It will also define a single group which contains the
5660 match except for the outermost delimiters. The maximum depth of
5661 stacked delimiters is N. Escaping delimiters is not possible."
5662 (let* ((nothing (concat "[^" left right "]*?"))
5663 (or "\\|")
5664 (re nothing)
5665 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5666 (while (> n 1)
5667 (setq n (1- n)
5668 re (concat re or next)
5669 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5670 (concat left "\\(" re "\\)" right)))
5672 (defconst org-match-substring-regexp
5673 (concat
5674 "\\(\\S-\\)\\([_^]\\)\\("
5675 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5676 "\\|"
5677 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5678 "\\|"
5679 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5680 "The regular expression matching a sub- or superscript.")
5682 (defconst org-match-substring-with-braces-regexp
5683 (concat
5684 "\\(\\S-\\)\\([_^]\\)"
5685 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5686 "The regular expression matching a sub- or superscript, forcing braces.")
5688 (defun org-make-link-regexps ()
5689 "Update the link regular expressions.
5690 This should be called after the variable `org-link-types' has changed."
5691 (let ((types-re (regexp-opt org-link-types t)))
5692 (setq org-link-types-re
5693 (concat "\\`" types-re ":")
5694 org-link-re-with-space
5695 (concat "<?" types-re ":"
5696 "\\([^" org-non-link-chars " ]"
5697 "[^" org-non-link-chars "]*"
5698 "[^" org-non-link-chars " ]\\)>?")
5699 org-link-re-with-space2
5700 (concat "<?" types-re ":"
5701 "\\([^" org-non-link-chars " ]"
5702 "[^\t\n\r]*"
5703 "[^" org-non-link-chars " ]\\)>?")
5704 org-link-re-with-space3
5705 (concat "<?" types-re ":"
5706 "\\([^" org-non-link-chars " ]"
5707 "[^\t\n\r]*\\)")
5708 org-angle-link-re
5709 (concat "<" types-re ":"
5710 "\\([^" org-non-link-chars " ]"
5711 "[^" org-non-link-chars "]*"
5712 "\\)>")
5713 org-plain-link-re
5714 (concat
5715 "\\<" types-re ":"
5716 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5717 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5718 org-bracket-link-regexp
5719 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5720 org-bracket-link-analytic-regexp
5721 (concat
5722 "\\[\\["
5723 "\\(" types-re ":\\)?"
5724 "\\([^]]+\\)"
5725 "\\]"
5726 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5727 "\\]")
5728 org-bracket-link-analytic-regexp++
5729 (concat
5730 "\\[\\["
5731 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5732 "\\([^]]+\\)"
5733 "\\]"
5734 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5735 "\\]")
5736 org-any-link-re
5737 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5738 org-angle-link-re "\\)\\|\\("
5739 org-plain-link-re "\\)"))))
5741 (org-make-link-regexps)
5743 (defvar org-emph-face nil)
5745 (defun org-do-emphasis-faces (limit)
5746 "Run through the buffer and emphasize strings."
5747 (let (rtn a)
5748 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5749 (let* ((border (char-after (match-beginning 3)))
5750 (bre (regexp-quote (char-to-string border))))
5751 (if (and (not (= border (char-after (match-beginning 4))))
5752 (not (save-match-data
5753 (string-match (concat bre ".*" bre)
5754 (replace-regexp-in-string
5755 "\n" " "
5756 (substring (match-string 2) 1 -1))))))
5757 (progn
5758 (setq rtn t)
5759 (setq a (assoc (match-string 3) org-emphasis-alist))
5760 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5761 'face
5762 (nth 1 a))
5763 (and (nth 2 a)
5764 (org-remove-flyspell-overlays-in
5765 (match-beginning 0) (match-end 0)))
5766 (add-text-properties (match-beginning 2) (match-end 2)
5767 '(font-lock-multiline t org-emphasis t))
5768 (when org-hide-emphasis-markers
5769 (add-text-properties (match-end 4) (match-beginning 5)
5770 '(invisible org-link))
5771 (add-text-properties (match-beginning 3) (match-end 3)
5772 '(invisible org-link))))))
5773 (goto-char (1+ (match-beginning 0))))
5774 rtn))
5776 (defun org-emphasize (&optional char)
5777 "Insert or change an emphasis, i.e. a font like bold or italic.
5778 If there is an active region, change that region to a new emphasis.
5779 If there is no region, just insert the marker characters and position
5780 the cursor between them.
5781 CHAR should be the marker character. If it is a space, it means to
5782 remove the emphasis of the selected region.
5783 If CHAR is not given (for example in an interactive call) it will be
5784 prompted for."
5785 (interactive)
5786 (let ((erc org-emphasis-regexp-components)
5787 (prompt "")
5788 (string "") beg end move c s)
5789 (if (org-region-active-p)
5790 (setq beg (region-beginning) end (region-end)
5791 string (buffer-substring beg end))
5792 (setq move t))
5794 (unless char
5795 (message "Emphasis marker or tag: [%s]"
5796 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5797 (setq char (read-char-exclusive)))
5798 (if (equal char ?\ )
5799 (setq s "" move nil)
5800 (unless (assoc (char-to-string char) org-emphasis-alist)
5801 (user-error "No such emphasis marker: \"%c\"" char))
5802 (setq s (char-to-string char)))
5803 (while (and (> (length string) 1)
5804 (equal (substring string 0 1) (substring string -1))
5805 (assoc (substring string 0 1) org-emphasis-alist))
5806 (setq string (substring string 1 -1)))
5807 (setq string (concat s string s))
5808 (if beg (delete-region beg end))
5809 (unless (or (bolp)
5810 (string-match (concat "[" (nth 0 erc) "\n]")
5811 (char-to-string (char-before (point)))))
5812 (insert " "))
5813 (unless (or (eobp)
5814 (string-match (concat "[" (nth 1 erc) "\n]")
5815 (char-to-string (char-after (point)))))
5816 (insert " ") (backward-char 1))
5817 (insert string)
5818 (and move (backward-char 1))))
5820 (defconst org-nonsticky-props
5821 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5823 (defsubst org-rear-nonsticky-at (pos)
5824 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5826 (defun org-activate-plain-links (limit)
5827 "Add link properties for plain links."
5828 (let (f hl)
5829 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5830 (not (member 'org-tag
5831 (get-text-property (1- (match-beginning 0)) 'face)))
5832 (not (org-in-src-block-p)))
5833 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5834 (setq f (get-text-property (match-beginning 0) 'face))
5835 (setq hl (org-match-string-no-properties 0))
5836 (if (or (eq f 'org-tag)
5837 (and (listp f) (memq 'org-tag f)))
5839 (add-text-properties (match-beginning 0) (match-end 0)
5840 (list 'mouse-face 'highlight
5841 'face 'org-link
5842 'htmlize-link `(:uri ,hl)
5843 'keymap org-mouse-map))
5844 (org-rear-nonsticky-at (match-end 0)))
5845 t)))
5847 (defun org-activate-code (limit)
5848 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5849 (progn
5850 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5851 (remove-text-properties (match-beginning 0) (match-end 0)
5852 '(display t invisible t intangible t))
5853 t)))
5855 (defcustom org-src-fontify-natively t
5856 "When non-nil, fontify code in code blocks."
5857 :type 'boolean
5858 :version "24.4"
5859 :package-version '(Org . "8.3")
5860 :group 'org-appearance
5861 :group 'org-babel)
5863 (defcustom org-allow-promoting-top-level-subtree nil
5864 "When non-nil, allow promoting a top level subtree.
5865 The leading star of the top level headline will be replaced
5866 by a #."
5867 :type 'boolean
5868 :version "24.1"
5869 :group 'org-appearance)
5871 (defun org-fontify-meta-lines-and-blocks (limit)
5872 (condition-case nil
5873 (org-fontify-meta-lines-and-blocks-1 limit)
5874 (error (message "org-mode fontification error"))))
5876 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5877 "Fontify #+ lines and blocks."
5878 (let ((case-fold-search t))
5879 (if (re-search-forward
5880 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5881 limit t)
5882 (let ((beg (match-beginning 0))
5883 (block-start (match-end 0))
5884 (block-end nil)
5885 (lang (match-string 7))
5886 (beg1 (line-beginning-position 2))
5887 (dc1 (downcase (match-string 2)))
5888 (dc3 (downcase (match-string 3)))
5889 end end1 quoting block-type ovl)
5890 (cond
5891 ((member dc1 '("+html:" "+ascii:" "+latex:"))
5892 ;; a single line of backend-specific content
5893 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5894 (remove-text-properties (match-beginning 0) (match-end 0)
5895 '(display t invisible t intangible t))
5896 (add-text-properties (match-beginning 1) (match-end 3)
5897 '(font-lock-fontified t face org-meta-line))
5898 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5899 '(font-lock-fontified t face org-block))
5900 ; for backend-specific code
5902 ((and (match-end 4) (equal dc3 "+begin"))
5903 ;; Truly a block
5904 (setq block-type (downcase (match-string 5))
5905 quoting (member block-type org-protecting-blocks))
5906 (when (re-search-forward
5907 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5908 nil t) ;; on purpose, we look further than LIMIT
5909 (setq end (min (point-max) (match-end 0))
5910 end1 (min (point-max) (1- (match-beginning 0))))
5911 (setq block-end (match-beginning 0))
5912 (when quoting
5913 (org-remove-flyspell-overlays-in beg1 end1)
5914 (remove-text-properties beg end
5915 '(display t invisible t intangible t)))
5916 (add-text-properties
5917 beg end '(font-lock-fontified t font-lock-multiline t))
5918 (add-text-properties beg beg1 '(face org-meta-line))
5919 (org-remove-flyspell-overlays-in beg beg1)
5920 (add-text-properties ; For end_src
5921 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5922 (org-remove-flyspell-overlays-in end1 end)
5923 (cond
5924 ((and lang (not (string= lang "")) org-src-fontify-natively)
5925 (org-src-font-lock-fontify-block lang block-start block-end)
5926 (add-text-properties beg1 block-end '(src-block t)))
5927 (quoting
5928 (add-text-properties beg1 (min (point-max) (1+ end1))
5929 '(face org-block))) ; end of source block
5930 ((not org-fontify-quote-and-verse-blocks))
5931 ((string= block-type "quote")
5932 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5933 ((string= block-type "verse")
5934 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5935 (add-text-properties beg beg1 '(face org-block-begin-line))
5936 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5937 '(face org-block-end-line))
5939 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5940 (org-remove-flyspell-overlays-in
5941 (match-beginning 0)
5942 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5943 (add-text-properties
5944 beg (match-end 3)
5945 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5946 '(font-lock-fontified t invisible t)
5947 '(font-lock-fontified t face org-document-info-keyword)))
5948 (add-text-properties
5949 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5950 (if (string-equal dc1 "+title:")
5951 '(font-lock-fontified t face org-document-title)
5952 '(font-lock-fontified t face org-document-info))))
5953 ((or (equal dc1 "+results")
5954 (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
5955 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5956 "+call:" "+header:" "+headers:" "+name:"))
5957 (and (match-end 4) (equal dc3 "+attr")))
5958 (org-remove-flyspell-overlays-in
5959 (match-beginning 0)
5960 (if (equal "+caption:" dc1) (match-end 2) (match-end 0)))
5961 (add-text-properties
5962 beg (match-end 0)
5963 '(font-lock-fontified t face org-meta-line))
5965 ((member dc3 '(" " ""))
5966 (org-remove-flyspell-overlays-in beg (match-end 0))
5967 (add-text-properties
5968 beg (match-end 0)
5969 '(font-lock-fontified t face font-lock-comment-face)))
5970 (t ;; just any other in-buffer setting, but not indented
5971 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5972 (add-text-properties
5973 beg (match-end 0)
5974 '(font-lock-fontified t face org-meta-line))
5975 t))))))
5977 (defun org-fontify-drawers (limit)
5978 "Fontify drawers."
5979 (when (re-search-forward org-drawer-regexp limit t)
5980 (add-text-properties
5981 (match-beginning 0) (match-end 0)
5982 '(font-lock-fontified t face org-special-keyword))
5983 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5986 (defun org-fontify-macros (limit)
5987 "Fontify macros."
5988 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5989 (add-text-properties
5990 (match-beginning 0) (match-end 0)
5991 '(font-lock-fontified t face org-macro))
5992 (when org-hide-macro-markers
5993 (add-text-properties (match-end 2) (match-beginning 2)
5994 '(invisible t))
5995 (add-text-properties (match-beginning 1) (match-end 1)
5996 '(invisible t)))
5997 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6000 (defun org-activate-angle-links (limit)
6001 "Add text properties for angle links."
6002 (if (and (re-search-forward org-angle-link-re limit t)
6003 (not (org-in-src-block-p)))
6004 (progn
6005 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6006 (add-text-properties (match-beginning 0) (match-end 0)
6007 (list 'mouse-face 'highlight
6008 'keymap org-mouse-map))
6009 (org-rear-nonsticky-at (match-end 0))
6010 t)))
6012 (defun org-activate-footnote-links (limit)
6013 "Add text properties for footnotes."
6014 (let ((fn (org-footnote-next-reference-or-definition limit)))
6015 (when fn
6016 (let* ((beg (nth 1 fn))
6017 (end (nth 2 fn))
6018 (label (car fn))
6019 (referencep (/= (line-beginning-position) beg)))
6020 (when (and referencep (nth 3 fn))
6021 (save-excursion
6022 (goto-char beg)
6023 (search-forward (or label "fn:"))
6024 (org-remove-flyspell-overlays-in beg (match-end 0))))
6025 (add-text-properties beg end
6026 (list 'mouse-face 'highlight
6027 'keymap org-mouse-map
6028 'help-echo
6029 (if referencep "Footnote reference"
6030 "Footnote definition")
6031 'font-lock-fontified t
6032 'font-lock-multiline t
6033 'face 'org-footnote))))))
6035 (defun org-activate-bracket-links (limit)
6036 "Add text properties for bracketed links."
6037 (if (and (re-search-forward org-bracket-link-regexp limit t)
6038 (not (org-in-src-block-p)))
6039 (let* ((hl (org-match-string-no-properties 1))
6040 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6041 (ip (org-maybe-intangible
6042 (list 'invisible 'org-link
6043 'keymap org-mouse-map 'mouse-face 'highlight
6044 'font-lock-multiline t 'help-echo help
6045 'htmlize-link `(:uri ,hl))))
6046 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6047 'font-lock-multiline t 'help-echo help
6048 'htmlize-link `(:uri ,hl))))
6049 ;; We need to remove the invisible property here. Table narrowing
6050 ;; may have made some of this invisible.
6051 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6052 (remove-text-properties (match-beginning 0) (match-end 0)
6053 '(invisible nil))
6054 (if (match-end 3)
6055 (progn
6056 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6057 (org-rear-nonsticky-at (match-beginning 3))
6058 (add-text-properties (match-beginning 3) (match-end 3) vp)
6059 (org-rear-nonsticky-at (match-end 3))
6060 (add-text-properties (match-end 3) (match-end 0) ip)
6061 (org-rear-nonsticky-at (match-end 0)))
6062 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6063 (org-rear-nonsticky-at (match-beginning 1))
6064 (add-text-properties (match-beginning 1) (match-end 1) vp)
6065 (org-rear-nonsticky-at (match-end 1))
6066 (add-text-properties (match-end 1) (match-end 0) ip)
6067 (org-rear-nonsticky-at (match-end 0)))
6068 t)))
6070 (defun org-activate-dates (limit)
6071 "Add text properties for dates."
6072 (if (and (re-search-forward org-tsr-regexp-both limit t)
6073 (not (equal (char-before (match-beginning 0)) 91)))
6074 (progn
6075 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6076 (add-text-properties (match-beginning 0) (match-end 0)
6077 (list 'mouse-face 'highlight
6078 'keymap org-mouse-map))
6079 (org-rear-nonsticky-at (match-end 0))
6080 (when org-display-custom-times
6081 (if (match-end 3)
6082 (org-display-custom-time (match-beginning 3) (match-end 3)))
6083 (org-display-custom-time (match-beginning 1) (match-end 1)))
6084 t)))
6086 (defvar org-target-link-regexp nil
6087 "Regular expression matching radio targets in plain text.")
6088 (make-variable-buffer-local 'org-target-link-regexp)
6090 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6091 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6092 border border border))
6093 "Regular expression matching a link target.")
6095 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6096 "Regular expression matching a radio target.")
6098 (defconst org-any-target-regexp
6099 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6100 "Regular expression matching any target.")
6102 (defun org-activate-target-links (limit)
6103 "Add text properties for target matches."
6104 (when org-target-link-regexp
6105 (let ((case-fold-search t))
6106 (if (re-search-forward org-target-link-regexp limit t)
6107 (progn
6108 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6109 (add-text-properties (match-beginning 1) (match-end 1)
6110 (list 'mouse-face 'highlight
6111 'keymap org-mouse-map
6112 'help-echo "Radio target link"
6113 'org-linked-text t))
6114 (org-rear-nonsticky-at (match-end 1))
6115 t)))))
6117 (defun org-update-radio-target-regexp ()
6118 "Find all radio targets in this file and update the regular expression.
6119 Also refresh fontification if needed."
6120 (interactive)
6121 (let ((old-regexp org-target-link-regexp)
6122 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6123 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6124 (targets
6125 (org-with-wide-buffer
6126 (goto-char (point-min))
6127 (let (rtn)
6128 (while (re-search-forward org-radio-target-regexp nil t)
6129 ;; Make sure point is really within the object.
6130 (backward-char)
6131 (let ((obj (org-element-context)))
6132 (when (eq (org-element-type obj) 'radio-target)
6133 (add-to-list 'rtn (org-element-property :value obj)))))
6134 rtn))))
6135 (setq org-target-link-regexp
6136 (and targets
6137 (concat before-re
6138 (mapconcat
6139 (lambda (x)
6140 (replace-regexp-in-string
6141 " +" "\\s-+" (regexp-quote x) t t))
6142 targets
6143 "\\|")
6144 after-re)))
6145 (unless (equal old-regexp org-target-link-regexp)
6146 ;; Clean-up cache.
6147 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6148 ((not org-target-link-regexp) old-regexp)
6150 (concat before-re
6151 (mapconcat
6152 (lambda (re)
6153 (substring re (length before-re)
6154 (- (length after-re))))
6155 (list old-regexp org-target-link-regexp)
6156 "\\|")
6157 after-re)))))
6158 (org-with-wide-buffer
6159 (goto-char (point-min))
6160 (while (re-search-forward regexp nil t)
6161 (org-element-cache-refresh (match-beginning 1)))))
6162 ;; Re fontify buffer.
6163 (when (memq 'radio org-highlight-links)
6164 (org-restart-font-lock)))))
6166 (defun org-hide-wide-columns (limit)
6167 (let (s e)
6168 (setq s (text-property-any (point) (or limit (point-max))
6169 'org-cwidth t))
6170 (when s
6171 (setq e (next-single-property-change s 'org-cwidth))
6172 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6173 (goto-char e)
6174 t)))
6176 (defvar org-latex-and-related-regexp nil
6177 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6179 (defun org-compute-latex-and-related-regexp ()
6180 "Compute regular expression for LaTeX, entities and sub/superscript.
6181 Result depends on variable `org-highlight-latex-and-related'."
6182 (org-set-local
6183 'org-latex-and-related-regexp
6184 (let* ((re-sub
6185 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6186 ((eq org-use-sub-superscripts '{})
6187 (list org-match-substring-with-braces-regexp))
6188 (org-use-sub-superscripts (list org-match-substring-regexp))))
6189 (re-latex
6190 (when (memq 'latex org-highlight-latex-and-related)
6191 (let ((matchers (plist-get org-format-latex-options :matchers)))
6192 (delq nil
6193 (mapcar (lambda (x)
6194 (and (member (car x) matchers) (nth 1 x)))
6195 org-latex-regexps)))))
6196 (re-entities
6197 (when (memq 'entities org-highlight-latex-and-related)
6198 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6199 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6201 (defun org-do-latex-and-related (limit)
6202 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6203 LIMIT bounds the search for syntax to highlight. Stop at first
6204 highlighted object, if any. Return t if some highlighting was
6205 done, nil otherwise."
6206 (when (org-string-nw-p org-latex-and-related-regexp)
6207 (catch 'found
6208 (while (re-search-forward org-latex-and-related-regexp limit t)
6209 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6210 'face))
6211 '(org-code org-verbatim underline))
6212 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6213 '(?_ ?^))
6215 0)))
6216 (font-lock-prepend-text-property
6217 (+ offset (match-beginning 0)) (match-end 0)
6218 'face 'org-latex-and-related)
6219 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6220 '(font-lock-multiline t)))
6221 (throw 'found t)))
6222 nil)))
6224 (defun org-restart-font-lock ()
6225 "Restart `font-lock-mode', to force refontification."
6226 (when (and (boundp 'font-lock-mode) font-lock-mode)
6227 (font-lock-mode -1)
6228 (font-lock-mode 1)))
6230 (defun org-activate-tags (limit)
6231 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6232 (progn
6233 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6234 (add-text-properties (match-beginning 1) (match-end 1)
6235 (list 'mouse-face 'highlight
6236 'keymap org-mouse-map))
6237 (org-rear-nonsticky-at (match-end 1))
6238 t)))
6240 (defun org-outline-level ()
6241 "Compute the outline level of the heading at point.
6243 If this is called at a normal headline, the level is the number
6244 of stars. Use `org-reduced-level' to remove the effect of
6245 `org-odd-levels'. Unlike to `org-current-level', this function
6246 takes into consideration inlinetasks."
6247 (org-with-wide-buffer
6248 (end-of-line)
6249 (if (re-search-backward org-outline-regexp-bol nil t)
6250 (1- (- (match-end 0) (match-beginning 0)))
6251 0)))
6253 (defvar org-font-lock-keywords nil)
6255 (defsubst org-re-property (property &optional literal allow-null)
6256 "Return a regexp matching a PROPERTY line.
6258 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6259 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6260 non-nil, match properties even without a value.
6262 Match group 3 is set to the value when it exists. If there is no
6263 value and ALLOW-NULL is non-nil, it is set to the empty string."
6264 (concat
6265 "^\\(?4:[ \t]*\\)"
6266 (format "\\(?1::\\(?2:%s\\):\\)"
6267 (if literal property (regexp-quote property)))
6268 (if allow-null
6269 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$"
6270 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$")))
6272 (defconst org-property-re
6273 (org-re-property "\\S-+" 'literal t)
6274 "Regular expression matching a property line.
6275 There are four matching groups:
6276 1: :PROPKEY: including the leading and trailing colon,
6277 2: PROPKEY without the leading and trailing colon,
6278 3: PROPVAL without leading or trailing spaces,
6279 4: the indentation of the current line,
6280 5: trailing whitespace.")
6282 (defvar org-font-lock-hook nil
6283 "Functions to be called for special font lock stuff.")
6285 (defvar org-font-lock-set-keywords-hook nil
6286 "Functions that can manipulate `org-font-lock-extra-keywords'.
6287 This is called after `org-font-lock-extra-keywords' is defined, but before
6288 it is installed to be used by font lock. This can be useful if something
6289 needs to be inserted at a specific position in the font-lock sequence.")
6291 (defun org-font-lock-hook (limit)
6292 "Run `org-font-lock-hook' within LIMIT."
6293 (run-hook-with-args 'org-font-lock-hook limit))
6295 (defun org-set-font-lock-defaults ()
6296 "Set font lock defaults for the current buffer."
6297 (let* ((em org-fontify-emphasized-text)
6298 (lk org-highlight-links)
6299 (org-font-lock-extra-keywords
6300 (list
6301 ;; Call the hook
6302 '(org-font-lock-hook)
6303 ;; Headlines
6304 `(,(if org-fontify-whole-heading-line
6305 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6306 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6307 (1 (org-get-level-face 1))
6308 (2 (org-get-level-face 2))
6309 (3 (org-get-level-face 3)))
6310 ;; Table lines
6311 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6312 (1 'org-table t))
6313 ;; Table internals
6314 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6315 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6316 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6317 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6318 ;; Drawers
6319 '(org-fontify-drawers)
6320 ;; Properties
6321 (list org-property-re
6322 '(1 'org-special-keyword t)
6323 '(3 'org-property-value t))
6324 ;; Links
6325 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6326 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6327 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6328 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6329 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6330 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6331 (if (memq 'footnote lk) '(org-activate-footnote-links))
6332 ;; Targets.
6333 (list org-any-target-regexp '(0 'org-target t))
6334 ;; Diary sexps.
6335 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6336 ;; Macro
6337 '(org-fontify-macros)
6338 '(org-hide-wide-columns (0 nil append))
6339 ;; TODO keyword
6340 (list (format org-heading-keyword-regexp-format
6341 org-todo-regexp)
6342 '(2 (org-get-todo-face 2) t))
6343 ;; DONE
6344 (if org-fontify-done-headline
6345 (list (format org-heading-keyword-regexp-format
6346 (concat
6347 "\\(?:"
6348 (mapconcat 'regexp-quote org-done-keywords "\\|")
6349 "\\)"))
6350 '(2 'org-headline-done t))
6351 nil)
6352 ;; Priorities
6353 '(org-font-lock-add-priority-faces)
6354 ;; Tags
6355 '(org-font-lock-add-tag-faces)
6356 ;; Tags groups
6357 (if (and org-group-tags org-tag-groups-alist)
6358 (list (concat org-outline-regexp-bol ".+\\(:"
6359 (regexp-opt (mapcar 'car org-tag-groups-alist))
6360 ":\\).*$")
6361 '(1 'org-tag-group prepend)))
6362 ;; Special keywords
6363 (list (concat "\\<" org-comment-string) '(0 'org-special-keyword t))
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 (while (re-search-forward
6458 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6459 limit t)
6460 (if (and (not (org-at-comment-p))
6461 (setq ee (org-entity-get (match-string 1)))
6462 (= (length (nth 6 ee)) 1))
6463 (let*
6464 ((end (if (equal (match-string 2) "{}")
6465 (match-end 2)
6466 (match-end 1))))
6467 (add-text-properties
6468 (match-beginning 0) end
6469 (list 'font-lock-fontified t))
6470 (compose-region (match-beginning 0) end
6471 (nth 6 ee) nil)
6472 (backward-char 1)
6473 (throw 'match t))))
6474 nil))))
6476 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6477 "Fontify string S like in Org-mode."
6478 (with-temp-buffer
6479 (insert s)
6480 (let ((org-odd-levels-only odd-levels))
6481 (org-mode)
6482 (font-lock-ensure)
6483 (buffer-string))))
6485 (defvar org-m nil)
6486 (defvar org-l nil)
6487 (defvar org-f nil)
6488 (defun org-get-level-face (n)
6489 "Get the right face for match N in font-lock matching of headlines."
6490 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6491 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6492 (if org-cycle-level-faces
6493 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6494 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6495 (cond
6496 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6497 ((eq n 2) org-f)
6498 (t (if org-level-color-stars-only nil org-f))))
6501 (defun org-get-todo-face (kwd)
6502 "Get the right face for a TODO keyword KWD.
6503 If KWD is a number, get the corresponding match group."
6504 (if (numberp kwd) (setq kwd (match-string kwd)))
6505 (or (org-face-from-face-or-color
6506 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6507 (and (member kwd org-done-keywords) 'org-done)
6508 'org-todo))
6510 (defun org-face-from-face-or-color (context inherit face-or-color)
6511 "Create a face list that inherits INHERIT, but sets the foreground color.
6512 When FACE-OR-COLOR is not a string, just return it."
6513 (if (stringp face-or-color)
6514 (list :inherit inherit
6515 (cdr (assoc context org-faces-easy-properties))
6516 face-or-color)
6517 face-or-color))
6519 (defun org-font-lock-add-tag-faces (limit)
6520 "Add the special tag faces."
6521 (when (and org-tag-faces org-tags-special-faces-re)
6522 (while (re-search-forward org-tags-special-faces-re limit t)
6523 (add-text-properties (match-beginning 1) (match-end 1)
6524 (list 'face (org-get-tag-face 1)
6525 'font-lock-fontified t))
6526 (backward-char 1))))
6528 (defun org-font-lock-add-priority-faces (limit)
6529 "Add the special priority faces."
6530 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6531 (when (save-match-data (org-at-heading-p))
6532 (add-text-properties
6533 (match-beginning 0) (match-end 0)
6534 (list 'face (or (org-face-from-face-or-color
6535 'priority 'org-priority
6536 (cdr (assoc (char-after (match-beginning 1))
6537 org-priority-faces)))
6538 'org-priority)
6539 'font-lock-fontified t)))))
6541 (defun org-get-tag-face (kwd)
6542 "Get the right face for a TODO keyword KWD.
6543 If KWD is a number, get the corresponding match group."
6544 (if (numberp kwd) (setq kwd (match-string kwd)))
6545 (or (org-face-from-face-or-color
6546 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6547 'org-tag))
6549 (defun org-unfontify-region (beg end &optional maybe_loudly)
6550 "Remove fontification and activation overlays from links."
6551 (font-lock-default-unfontify-region beg end)
6552 (let* ((buffer-undo-list t)
6553 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6554 (inhibit-modification-hooks t)
6555 deactivate-mark buffer-file-name buffer-file-truename)
6556 (org-decompose-region beg end)
6557 (remove-text-properties beg end
6558 '(mouse-face t keymap t org-linked-text t
6559 invisible t intangible t
6560 org-emphasis t))
6561 (org-remove-font-lock-display-properties beg end)))
6563 (defconst org-script-display '(((raise -0.3) (height 0.7))
6564 ((raise 0.3) (height 0.7))
6565 ((raise -0.5))
6566 ((raise 0.5)))
6567 "Display properties for showing superscripts and subscripts.")
6569 (defun org-remove-font-lock-display-properties (beg end)
6570 "Remove specific display properties that have been added by font lock.
6571 The will remove the raise properties that are used to show superscripts
6572 and subscripts."
6573 (let (next prop)
6574 (while (< beg end)
6575 (setq next (next-single-property-change beg 'display nil end)
6576 prop (get-text-property beg 'display))
6577 (if (member prop org-script-display)
6578 (put-text-property beg next 'display nil))
6579 (setq beg next))))
6581 (defun org-raise-scripts (limit)
6582 "Add raise properties to sub/superscripts."
6583 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6584 (if (re-search-forward
6585 (if (eq org-use-sub-superscripts t)
6586 org-match-substring-regexp
6587 org-match-substring-with-braces-regexp)
6588 limit t)
6589 (let* ((pos (point)) table-p comment-p
6590 (mpos (match-beginning 3))
6591 (emph-p (get-text-property mpos 'org-emphasis))
6592 (link-p (get-text-property mpos 'mouse-face))
6593 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6594 (goto-char (point-at-bol))
6595 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6596 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6597 (goto-char pos)
6598 ;; Handle a_b^c
6599 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6600 (if (or comment-p emph-p link-p keyw-p)
6602 (put-text-property (match-beginning 3) (match-end 0)
6603 'display
6604 (if (equal (char-after (match-beginning 2)) ?^)
6605 (nth (if table-p 3 1) org-script-display)
6606 (nth (if table-p 2 0) org-script-display)))
6607 (add-text-properties (match-beginning 2) (match-end 2)
6608 (list 'invisible t
6609 'org-dwidth t 'org-dwidth-n 1))
6610 (if (and (eq (char-after (match-beginning 3)) ?{)
6611 (eq (char-before (match-end 3)) ?}))
6612 (progn
6613 (add-text-properties
6614 (match-beginning 3) (1+ (match-beginning 3))
6615 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6616 (add-text-properties
6617 (1- (match-end 3)) (match-end 3)
6618 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6619 t)))))
6621 ;;;; Visibility cycling, including org-goto and indirect buffer
6623 ;;; Cycling
6625 (defvar org-cycle-global-status nil)
6626 (make-variable-buffer-local 'org-cycle-global-status)
6627 (put 'org-cycle-global-status 'org-state t)
6628 (defvar org-cycle-subtree-status nil)
6629 (make-variable-buffer-local 'org-cycle-subtree-status)
6630 (put 'org-cycle-subtree-status 'org-state t)
6632 (defvar org-inlinetask-min-level)
6634 (defun org-unlogged-message (&rest args)
6635 "Display a message, but avoid logging it in the *Messages* buffer."
6636 (let ((message-log-max nil))
6637 (apply 'message args)))
6639 ;;;###autoload
6640 (defun org-cycle (&optional arg)
6641 "TAB-action and visibility cycling for Org-mode.
6643 This is the command invoked in Org-mode by the TAB key. Its main purpose
6644 is outline visibility cycling, but it also invokes other actions
6645 in special contexts.
6647 - When this function is called with a prefix argument, rotate the entire
6648 buffer through 3 states (global cycling)
6649 1. OVERVIEW: Show only top-level headlines.
6650 2. CONTENTS: Show all headlines of all levels, but no body text.
6651 3. SHOW ALL: Show everything.
6652 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6653 determined by the variable `org-startup-folded', and by any VISIBILITY
6654 properties in the buffer.
6655 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6656 including any drawers.
6658 - When inside a table, re-align the table and move to the next field.
6660 - When point is at the beginning of a headline, rotate the subtree started
6661 by this line through 3 different states (local cycling)
6662 1. FOLDED: Only the main headline is shown.
6663 2. CHILDREN: The main headline and the direct children are shown.
6664 From this state, you can move to one of the children
6665 and zoom in further.
6666 3. SUBTREE: Show the entire subtree, including body text.
6667 If there is no subtree, switch directly from CHILDREN to FOLDED.
6669 - When point is at the beginning of an empty headline and the variable
6670 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6671 of the headline by demoting and promoting it to likely levels. This
6672 speeds up creation document structure by pressing TAB once or several
6673 times right after creating a new headline.
6675 - When there is a numeric prefix, go up to a heading with level ARG, do
6676 a `show-subtree' and return to the previous cursor position. If ARG
6677 is negative, go up that many levels.
6679 - When point is not at the beginning of a headline, execute the global
6680 binding for TAB, which is re-indenting the line. See the option
6681 `org-cycle-emulate-tab' for details.
6683 - Special case: if point is at the beginning of the buffer and there is
6684 no headline in line 1, this function will act as if called with prefix arg
6685 (C-u TAB, same as S-TAB) also when called without prefix arg.
6686 But only if also the variable `org-cycle-global-at-bob' is t."
6687 (interactive "P")
6688 (org-load-modules-maybe)
6689 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6690 (and org-cycle-level-after-item/entry-creation
6691 (or (org-cycle-level)
6692 (org-cycle-item-indentation))))
6693 (let* ((limit-level
6694 (or org-cycle-max-level
6695 (and (boundp 'org-inlinetask-min-level)
6696 org-inlinetask-min-level
6697 (1- org-inlinetask-min-level))))
6698 (nstars (and limit-level
6699 (if org-odd-levels-only
6700 (and limit-level (1- (* limit-level 2)))
6701 limit-level)))
6702 (org-outline-regexp
6703 (if (not (derived-mode-p 'org-mode))
6704 outline-regexp
6705 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6706 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6707 (not (looking-at org-outline-regexp))))
6708 (org-cycle-hook
6709 (if bob-special
6710 (delq 'org-optimize-window-after-visibility-change
6711 (copy-sequence org-cycle-hook))
6712 org-cycle-hook))
6713 (pos (point)))
6715 (if (or bob-special (equal arg '(4)))
6716 ;; special case: use global cycling
6717 (setq arg t))
6719 (cond
6721 ((equal arg '(16))
6722 (setq last-command 'dummy)
6723 (org-set-startup-visibility)
6724 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6726 ((equal arg '(64))
6727 (show-all)
6728 (org-unlogged-message "Entire buffer visible, including drawers"))
6730 ;; Try cdlatex TAB completion
6731 ((org-try-cdlatex-tab))
6733 ;; Table: enter it or move to the next field.
6734 ((org-at-table-p 'any)
6735 (if (org-at-table.el-p)
6736 (message "Use C-c ' to edit table.el tables")
6737 (if arg (org-table-edit-field t)
6738 (org-table-justify-field-maybe)
6739 (call-interactively 'org-table-next-field))))
6741 ((run-hook-with-args-until-success
6742 'org-tab-after-check-for-table-hook))
6744 ;; Global cycling: delegate to `org-cycle-internal-global'.
6745 ((eq arg t) (org-cycle-internal-global))
6747 ;; Drawers: delegate to `org-flag-drawer'.
6748 ((save-excursion
6749 (beginning-of-line 1)
6750 (looking-at org-drawer-regexp))
6751 (org-flag-drawer ; toggle block visibility
6752 (not (get-char-property (match-end 0) 'invisible))))
6754 ;; Show-subtree, ARG levels up from here.
6755 ((integerp arg)
6756 (save-excursion
6757 (org-back-to-heading)
6758 (outline-up-heading (if (< arg 0) (- arg)
6759 (- (funcall outline-level) arg)))
6760 (org-show-subtree)))
6762 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6763 ((and (featurep 'org-inlinetask)
6764 (org-inlinetask-at-task-p)
6765 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6766 (org-inlinetask-toggle-visibility))
6768 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6769 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6770 (save-excursion (beginning-of-line 1)
6771 (looking-at org-outline-regexp)))
6772 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6773 (org-cycle-internal-local))
6775 ;; From there: TAB emulation and template completion.
6776 (buffer-read-only (org-back-to-heading))
6778 ((run-hook-with-args-until-success
6779 'org-tab-after-check-for-cycling-hook))
6781 ((org-try-structure-completion))
6783 ((run-hook-with-args-until-success
6784 'org-tab-before-tab-emulation-hook))
6786 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6787 (or (not (bolp))
6788 (not (looking-at org-outline-regexp))))
6789 (call-interactively (global-key-binding "\t")))
6791 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6792 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6793 (or (and (eq org-cycle-emulate-tab 'white)
6794 (= (match-end 0) (point-at-eol)))
6795 (and (eq org-cycle-emulate-tab 'whitestart)
6796 (>= (match-end 0) pos))))
6798 (eq org-cycle-emulate-tab t))
6799 (call-interactively (global-key-binding "\t")))
6801 (t (save-excursion
6802 (org-back-to-heading)
6803 (org-cycle)))))))
6805 (defun org-cycle-internal-global ()
6806 "Do the global cycling action."
6807 ;; Hack to avoid display of messages for .org attachments in Gnus
6808 (let ((ga (string-match "\\*fontification" (buffer-name))))
6809 (cond
6810 ((and (eq last-command this-command)
6811 (eq org-cycle-global-status 'overview))
6812 ;; We just created the overview - now do table of contents
6813 ;; This can be slow in very large buffers, so indicate action
6814 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6815 (unless ga (org-unlogged-message "CONTENTS..."))
6816 (org-content)
6817 (unless ga (org-unlogged-message "CONTENTS...done"))
6818 (setq org-cycle-global-status 'contents)
6819 (run-hook-with-args 'org-cycle-hook 'contents))
6821 ((and (eq last-command this-command)
6822 (eq org-cycle-global-status 'contents))
6823 ;; We just showed the table of contents - now show everything
6824 (run-hook-with-args 'org-pre-cycle-hook 'all)
6825 (show-all)
6826 (unless ga (org-unlogged-message "SHOW ALL"))
6827 (setq org-cycle-global-status 'all)
6828 (run-hook-with-args 'org-cycle-hook 'all))
6831 ;; Default action: go to overview
6832 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6833 (org-overview)
6834 (unless ga (org-unlogged-message "OVERVIEW"))
6835 (setq org-cycle-global-status 'overview)
6836 (run-hook-with-args 'org-cycle-hook 'overview)))))
6838 (defvar org-called-with-limited-levels nil
6839 "Non-nil when `org-with-limited-levels' is currently active.")
6841 (defun org-cycle-internal-local ()
6842 "Do the local cycling action."
6843 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6844 ;; First, determine end of headline (EOH), end of subtree or item
6845 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6846 (save-excursion
6847 (if (org-at-item-p)
6848 (progn
6849 (beginning-of-line)
6850 (setq struct (org-list-struct))
6851 (setq eoh (point-at-eol))
6852 (setq eos (org-list-get-item-end-before-blank (point) struct))
6853 (setq has-children (org-list-has-child-p (point) struct)))
6854 (org-back-to-heading)
6855 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6856 (setq eos (save-excursion (org-end-of-subtree t t)
6857 (when (bolp) (backward-char)) (point)))
6858 (setq has-children
6859 (or (save-excursion
6860 (let ((level (funcall outline-level)))
6861 (outline-next-heading)
6862 (and (org-at-heading-p t)
6863 (> (funcall outline-level) level))))
6864 (save-excursion
6865 (org-list-search-forward (org-item-beginning-re) eos t)))))
6866 ;; Determine end invisible part of buffer (EOL)
6867 (beginning-of-line 2)
6868 ;; XEmacs doesn't have `next-single-char-property-change'
6869 (if (featurep 'xemacs)
6870 (while (and (not (eobp)) ;; this is like `next-line'
6871 (get-char-property (1- (point)) 'invisible))
6872 (beginning-of-line 2))
6873 (while (and (not (eobp)) ;; this is like `next-line'
6874 (get-char-property (1- (point)) 'invisible))
6875 (goto-char (next-single-char-property-change (point) 'invisible))
6876 (and (eolp) (beginning-of-line 2))))
6877 (setq eol (point)))
6878 ;; Find out what to do next and set `this-command'
6879 (cond
6880 ((= eos eoh)
6881 ;; Nothing is hidden behind this heading
6882 (unless (org-before-first-heading-p)
6883 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6884 (org-unlogged-message "EMPTY ENTRY")
6885 (setq org-cycle-subtree-status nil)
6886 (save-excursion
6887 (goto-char eos)
6888 (outline-next-heading)
6889 (if (outline-invisible-p) (org-flag-heading nil))))
6890 ((and (or (>= eol eos)
6891 (not (string-match "\\S-" (buffer-substring eol eos))))
6892 (or has-children
6893 (not (setq children-skipped
6894 org-cycle-skip-children-state-if-no-children))))
6895 ;; Entire subtree is hidden in one line: children view
6896 (unless (org-before-first-heading-p)
6897 (run-hook-with-args 'org-pre-cycle-hook 'children))
6898 (if (org-at-item-p)
6899 (org-list-set-item-visibility (point-at-bol) struct 'children)
6900 (org-show-entry)
6901 (org-with-limited-levels (show-children))
6902 ;; FIXME: This slows down the func way too much.
6903 ;; How keep drawers hidden in subtree anyway?
6904 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6905 ;; (org-cycle-hide-drawers 'subtree))
6907 ;; Fold every list in subtree to top-level items.
6908 (when (eq org-cycle-include-plain-lists 'integrate)
6909 (save-excursion
6910 (org-back-to-heading)
6911 (while (org-list-search-forward (org-item-beginning-re) eos t)
6912 (beginning-of-line 1)
6913 (let* ((struct (org-list-struct))
6914 (prevs (org-list-prevs-alist struct))
6915 (end (org-list-get-bottom-point struct)))
6916 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6917 (org-list-get-all-items (point) struct prevs))
6918 (goto-char (if (< end eos) end eos)))))))
6919 (org-unlogged-message "CHILDREN")
6920 (save-excursion
6921 (goto-char eos)
6922 (outline-next-heading)
6923 (if (outline-invisible-p) (org-flag-heading nil)))
6924 (setq org-cycle-subtree-status 'children)
6925 (unless (org-before-first-heading-p)
6926 (run-hook-with-args 'org-cycle-hook 'children)))
6927 ((or children-skipped
6928 (and (eq last-command this-command)
6929 (eq org-cycle-subtree-status 'children)))
6930 ;; We just showed the children, or no children are there,
6931 ;; now show everything.
6932 (unless (org-before-first-heading-p)
6933 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6934 (outline-flag-region eoh eos nil)
6935 (org-unlogged-message
6936 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6937 (setq org-cycle-subtree-status 'subtree)
6938 (unless (org-before-first-heading-p)
6939 (run-hook-with-args 'org-cycle-hook 'subtree)))
6941 ;; Default action: hide the subtree.
6942 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6943 (outline-flag-region eoh eos t)
6944 (org-unlogged-message "FOLDED")
6945 (setq org-cycle-subtree-status 'folded)
6946 (unless (org-before-first-heading-p)
6947 (run-hook-with-args 'org-cycle-hook 'folded))))))
6949 ;;;###autoload
6950 (defun org-global-cycle (&optional arg)
6951 "Cycle the global visibility. For details see `org-cycle'.
6952 With \\[universal-argument] prefix arg, switch to startup visibility.
6953 With a numeric prefix, show all headlines up to that level."
6954 (interactive "P")
6955 (let ((org-cycle-include-plain-lists
6956 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6957 (cond
6958 ((integerp arg)
6959 (show-all)
6960 (hide-sublevels arg)
6961 (setq org-cycle-global-status 'contents))
6962 ((equal arg '(4))
6963 (org-set-startup-visibility)
6964 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6966 (org-cycle '(4))))))
6968 (defun org-set-startup-visibility ()
6969 "Set the visibility required by startup options and properties."
6970 (cond
6971 ((eq org-startup-folded t)
6972 (org-overview))
6973 ((eq org-startup-folded 'content)
6974 (org-content))
6975 ((or (eq org-startup-folded 'showeverything)
6976 (eq org-startup-folded nil))
6977 (show-all)))
6978 (unless (eq org-startup-folded 'showeverything)
6979 (if org-hide-block-startup (org-hide-block-all))
6980 (org-set-visibility-according-to-property 'no-cleanup)
6981 (org-cycle-hide-archived-subtrees 'all)
6982 (org-cycle-hide-drawers 'all)
6983 (org-cycle-show-empty-lines t)))
6985 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6986 "Switch subtree visibilities according to :VISIBILITY: property."
6987 (interactive)
6988 (let (org-show-entry-below)
6989 (org-with-wide-buffer
6990 (goto-char (point-min))
6991 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
6992 (if (not (org-at-property-p)) (outline-next-heading)
6993 (let ((state (match-string 3)))
6994 (save-excursion
6995 (org-back-to-heading t)
6996 (hide-subtree)
6997 (org-reveal)
6998 (cond
6999 ((equal state "folded")
7000 (hide-subtree))
7001 ((equal state "children")
7002 (org-show-hidden-entry)
7003 (show-children))
7004 ((equal state "content")
7005 (save-excursion
7006 (save-restriction
7007 (org-narrow-to-subtree)
7008 (org-content))))
7009 ((member state '("all" "showall"))
7010 (show-subtree)))))))
7011 (unless no-cleanup
7012 (org-cycle-hide-archived-subtrees 'all)
7013 (org-cycle-hide-drawers 'all)
7014 (org-cycle-show-empty-lines 'all)))))
7016 ;; This function uses outline-regexp instead of the more fundamental
7017 ;; org-outline-regexp so that org-cycle-global works outside of Org
7018 ;; buffers, where outline-regexp is needed.
7019 (defun org-overview ()
7020 "Switch to overview mode, showing only top-level headlines.
7021 This shows all headlines with a level equal or greater than the level
7022 of the first headline in the buffer. This is important, because if the
7023 first headline is not level one, then (hide-sublevels 1) gives confusing
7024 results."
7025 (interactive)
7026 (save-excursion
7027 (let ((level
7028 (save-excursion
7029 (goto-char (point-min))
7030 (if (re-search-forward (concat "^" outline-regexp) nil t)
7031 (progn
7032 (goto-char (match-beginning 0))
7033 (funcall outline-level))))))
7034 (and level (hide-sublevels level)))))
7036 (defun org-content (&optional arg)
7037 "Show all headlines in the buffer, like a table of contents.
7038 With numerical argument N, show content up to level N."
7039 (interactive "P")
7040 (org-overview)
7041 (save-excursion
7042 ;; Visit all headings and show their offspring
7043 (and (integerp arg) (org-overview))
7044 (goto-char (point-max))
7045 (catch 'exit
7046 (while (and (progn (condition-case nil
7047 (outline-previous-visible-heading 1)
7048 (error (goto-char (point-min))))
7050 (looking-at org-outline-regexp))
7051 (if (integerp arg)
7052 (show-children (1- arg))
7053 (show-branches))
7054 (if (bobp) (throw 'exit nil))))))
7056 (defun org-optimize-window-after-visibility-change (state)
7057 "Adjust the window after a change in outline visibility.
7058 This function is the default value of the hook `org-cycle-hook'."
7059 (when (get-buffer-window (current-buffer))
7060 (cond
7061 ((eq state 'content) nil)
7062 ((eq state 'all) nil)
7063 ((eq state 'folded) nil)
7064 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7065 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7067 (defun org-remove-empty-overlays-at (pos)
7068 "Remove outline overlays that do not contain non-white stuff."
7069 (mapc
7070 (lambda (o)
7071 (and (eq 'outline (overlay-get o 'invisible))
7072 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7073 (overlay-end o))))
7074 (delete-overlay o)))
7075 (overlays-at pos)))
7077 (defun org-clean-visibility-after-subtree-move ()
7078 "Fix visibility issues after moving a subtree."
7079 ;; First, find a reasonable region to look at:
7080 ;; Start two siblings above, end three below
7081 (let* ((beg (save-excursion
7082 (and (org-get-last-sibling)
7083 (org-get-last-sibling))
7084 (point)))
7085 (end (save-excursion
7086 (and (org-get-next-sibling)
7087 (org-get-next-sibling)
7088 (org-get-next-sibling))
7089 (if (org-at-heading-p)
7090 (point-at-eol)
7091 (point))))
7092 (level (looking-at "\\*+"))
7093 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7094 (save-excursion
7095 (save-restriction
7096 (narrow-to-region beg end)
7097 (when re
7098 ;; Properly fold already folded siblings
7099 (goto-char (point-min))
7100 (while (re-search-forward re nil t)
7101 (if (and (not (outline-invisible-p))
7102 (save-excursion
7103 (goto-char (point-at-eol)) (outline-invisible-p)))
7104 (hide-entry))))
7105 (org-cycle-show-empty-lines 'overview)
7106 (org-cycle-hide-drawers 'overview)))))
7108 (defun org-cycle-show-empty-lines (state)
7109 "Show empty lines above all visible headlines.
7110 The region to be covered depends on STATE when called through
7111 `org-cycle-hook'. Lisp program can use t for STATE to get the
7112 entire buffer covered. Note that an empty line is only shown if there
7113 are at least `org-cycle-separator-lines' empty lines before the headline."
7114 (when (not (= org-cycle-separator-lines 0))
7115 (save-excursion
7116 (let* ((n (abs org-cycle-separator-lines))
7117 (re (cond
7118 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7119 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7120 (t (let ((ns (number-to-string (- n 2))))
7121 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7122 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7123 beg end b e)
7124 (cond
7125 ((memq state '(overview contents t))
7126 (setq beg (point-min) end (point-max)))
7127 ((memq state '(children folded))
7128 (setq beg (point) end (progn (org-end-of-subtree t t)
7129 (beginning-of-line 2)
7130 (point)))))
7131 (when beg
7132 (goto-char beg)
7133 (while (re-search-forward re end t)
7134 (unless (get-char-property (match-end 1) 'invisible)
7135 (setq e (match-end 1))
7136 (if (< org-cycle-separator-lines 0)
7137 (setq b (save-excursion
7138 (goto-char (match-beginning 0))
7139 (org-back-over-empty-lines)
7140 (if (save-excursion
7141 (goto-char (max (point-min) (1- (point))))
7142 (org-at-heading-p))
7143 (1- (point))
7144 (point))))
7145 (setq b (match-beginning 1)))
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-cycle-hide-inline-tasks (state)
7208 "Re-hide inline tasks when switching to 'contents or 'children
7209 visibility state."
7210 (case state
7211 (contents
7212 (when (org-bound-and-true-p org-inlinetask-min-level)
7213 (hide-sublevels (1- org-inlinetask-min-level))))
7214 (children
7215 (when (featurep 'org-inlinetask)
7216 (save-excursion
7217 (while (and (outline-next-heading)
7218 (org-inlinetask-at-task-p))
7219 (org-inlinetask-toggle-visibility)
7220 (org-inlinetask-goto-end)))))))
7222 (defun org-flag-drawer (flag &optional element)
7223 "When FLAG is non-nil, hide the drawer we are at.
7224 Otherwise make it visible. When optional argument ELEMENT is
7225 a parsed drawer, as returned by `org-element-at-point', hide or
7226 show that drawer instead."
7227 (when (save-excursion
7228 (beginning-of-line)
7229 (org-looking-at-p org-drawer-regexp))
7230 (let ((drawer (or element (org-element-at-point))))
7231 (when (memq (org-element-type drawer) '(drawer property-drawer))
7232 (let ((post (org-element-property :post-affiliated drawer)))
7233 (save-excursion
7234 (outline-flag-region
7235 (progn (goto-char post) (line-end-position))
7236 (progn (goto-char (org-element-property :end drawer))
7237 (skip-chars-backward " \r\t\n")
7238 (line-end-position))
7239 flag))
7240 ;; When the drawer is hidden away, make sure point lies in
7241 ;; a visible part of the buffer.
7242 (when (and flag (> (line-beginning-position) post))
7243 (goto-char post)))))))
7245 (defun org-subtree-end-visible-p ()
7246 "Is the end of the current subtree visible?"
7247 (pos-visible-in-window-p
7248 (save-excursion (org-end-of-subtree t) (point))))
7250 (defun org-first-headline-recenter ()
7251 "Move cursor to the first headline and recenter the headline."
7252 (goto-char (point-min))
7253 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7254 (set-window-start (selected-window) (point-at-bol))))
7256 ;;; Saving and restoring visibility
7258 (defun org-outline-overlay-data (&optional use-markers)
7259 "Return a list of the locations of all outline overlays.
7260 These are overlays with the `invisible' property value `outline'.
7261 The return value is a list of cons cells, with start and stop
7262 positions for each overlay.
7263 If USE-MARKERS is set, return the positions as markers."
7264 (let (beg end)
7265 (save-excursion
7266 (save-restriction
7267 (widen)
7268 (delq nil
7269 (mapcar (lambda (o)
7270 (when (eq (overlay-get o 'invisible) 'outline)
7271 (setq beg (overlay-start o)
7272 end (overlay-end o))
7273 (and beg end (> end beg)
7274 (if use-markers
7275 (cons (copy-marker beg)
7276 (copy-marker end t))
7277 (cons beg end)))))
7278 (overlays-in (point-min) (point-max))))))))
7280 (defun org-set-outline-overlay-data (data)
7281 "Create visibility overlays for all positions in DATA.
7282 DATA should have been made by `org-outline-overlay-data'."
7283 (let (o)
7284 (save-excursion
7285 (save-restriction
7286 (widen)
7287 (show-all)
7288 (mapc (lambda (c)
7289 (outline-flag-region (car c) (cdr c) t))
7290 data)))))
7292 ;;; Folding of blocks
7294 (defvar org-hide-block-overlays nil
7295 "Overlays hiding blocks.")
7296 (make-variable-buffer-local 'org-hide-block-overlays)
7298 (defun org-block-map (function &optional start end)
7299 "Call FUNCTION at the head of all source blocks in the current buffer.
7300 Optional arguments START and END can be used to limit the range."
7301 (let ((start (or start (point-min)))
7302 (end (or end (point-max))))
7303 (save-excursion
7304 (goto-char start)
7305 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7306 (save-excursion
7307 (save-match-data
7308 (goto-char (match-beginning 0))
7309 (funcall function)))))))
7311 (defun org-hide-block-toggle-all ()
7312 "Toggle the visibility of all blocks in the current buffer."
7313 (org-block-map 'org-hide-block-toggle))
7315 (defun org-hide-block-all ()
7316 "Fold all blocks in the current buffer."
7317 (interactive)
7318 (org-show-block-all)
7319 (org-block-map 'org-hide-block-toggle-maybe))
7321 (defun org-show-block-all ()
7322 "Unfold all blocks in the current buffer."
7323 (interactive)
7324 (mapc 'delete-overlay org-hide-block-overlays)
7325 (setq org-hide-block-overlays nil))
7327 (defun org-hide-block-toggle-maybe ()
7328 "Toggle visibility of block at point.
7329 Unlike to `org-hide-block-toggle', this function does not throw
7330 an error. Return a non-nil value when toggling is successful."
7331 (interactive)
7332 (ignore-errors (org-hide-block-toggle)))
7334 (defun org-hide-block-toggle (&optional force)
7335 "Toggle the visibility of the current block.
7336 When optional argument FORCE is `off', make block visible. If it
7337 is non-nil, hide it unconditionally. Throw an error when not at
7338 a block. Return a non-nil value when toggling is successful."
7339 (interactive)
7340 (let ((element (org-element-at-point)))
7341 (unless (memq (org-element-type element)
7342 '(center-block comment-block dynamic-block example-block
7343 export-block quote-block special-block
7344 src-block verse-block))
7345 (user-error "Not at a block"))
7346 (let* ((start (save-excursion
7347 (goto-char (org-element-property :post-affiliated element))
7348 (line-end-position)))
7349 (end (save-excursion
7350 (goto-char (org-element-property :end element))
7351 (skip-chars-backward " \r\t\n")
7352 (line-end-position)))
7353 (overlays (overlays-at start)))
7354 (cond
7355 ;; Do nothing when not before or at the block opening line or
7356 ;; at the block closing line.
7357 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7358 ((and (not (eq force 'off))
7359 (not (memq t (mapcar
7360 (lambda (o)
7361 (eq (overlay-get o 'invisible) 'org-hide-block))
7362 overlays))))
7363 (let ((ov (make-overlay start end)))
7364 (overlay-put ov 'invisible 'org-hide-block)
7365 ;; Make the block accessible to `isearch'.
7366 (overlay-put
7367 ov 'isearch-open-invisible
7368 (lambda (ov)
7369 (when (memq ov org-hide-block-overlays)
7370 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7371 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7372 (delete-overlay ov))))
7373 (push ov org-hide-block-overlays)
7374 ;; When the block is hidden away, make sure point is left in
7375 ;; a visible part of the buffer.
7376 (when (> (line-beginning-position) start)
7377 (goto-char start)
7378 (beginning-of-line))
7379 ;; Signal successful toggling.
7381 ((or (not force) (eq force 'off))
7382 (dolist (ov overlays t)
7383 (when (memq ov org-hide-block-overlays)
7384 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7385 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7386 (delete-overlay ov))))))))
7388 ;; org-tab-after-check-for-cycling-hook
7389 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7390 ;; Remove overlays when changing major mode
7391 (add-hook 'org-mode-hook
7392 (lambda () (org-add-hook 'change-major-mode-hook
7393 'org-show-block-all 'append 'local)))
7395 ;;; Org-goto
7397 (defvar org-goto-window-configuration nil)
7398 (defvar org-goto-marker nil)
7399 (defvar org-goto-map)
7400 (defun org-goto-map ()
7401 "Set the keymap `org-goto'."
7402 (setq org-goto-map
7403 (let ((map (make-sparse-keymap)))
7404 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7405 mouse-drag-region universal-argument org-occur))
7406 cmd)
7407 (while (setq cmd (pop cmds))
7408 (substitute-key-definition cmd cmd map global-map)))
7409 (suppress-keymap map)
7410 (org-defkey map "\C-m" 'org-goto-ret)
7411 (org-defkey map [(return)] 'org-goto-ret)
7412 (org-defkey map [(left)] 'org-goto-left)
7413 (org-defkey map [(right)] 'org-goto-right)
7414 (org-defkey map [(control ?g)] 'org-goto-quit)
7415 (org-defkey map "\C-i" 'org-cycle)
7416 (org-defkey map [(tab)] 'org-cycle)
7417 (org-defkey map [(down)] 'outline-next-visible-heading)
7418 (org-defkey map [(up)] 'outline-previous-visible-heading)
7419 (if org-goto-auto-isearch
7420 (if (fboundp 'define-key-after)
7421 (define-key-after map [t] 'org-goto-local-auto-isearch)
7422 nil)
7423 (org-defkey map "q" 'org-goto-quit)
7424 (org-defkey map "n" 'outline-next-visible-heading)
7425 (org-defkey map "p" 'outline-previous-visible-heading)
7426 (org-defkey map "f" 'outline-forward-same-level)
7427 (org-defkey map "b" 'outline-backward-same-level)
7428 (org-defkey map "u" 'outline-up-heading))
7429 (org-defkey map "/" 'org-occur)
7430 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7431 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7432 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7433 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7434 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7435 map)))
7437 (defconst org-goto-help
7438 "Browse buffer copy, to find location or copy text.%s
7439 RET=jump to location C-g=quit and return to previous location
7440 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7442 (defvar org-goto-start-pos) ; dynamically scoped parameter
7444 (defun org-goto (&optional alternative-interface)
7445 "Look up a different location in the current file, keeping current visibility.
7447 When you want look-up or go to a different location in a
7448 document, the fastest way is often to fold the entire buffer and
7449 then dive into the tree. This method has the disadvantage, that
7450 the previous location will be folded, which may not be what you
7451 want.
7453 This command works around this by showing a copy of the current
7454 buffer in an indirect buffer, in overview mode. You can dive
7455 into the tree in that copy, use org-occur and incremental search
7456 to find a location. When pressing RET or `Q', the command
7457 returns to the original buffer in which the visibility is still
7458 unchanged. After RET it will also jump to the location selected
7459 in the indirect buffer and expose the headline hierarchy above.
7461 With a prefix argument, use the alternative interface: e.g. if
7462 `org-goto-interface' is 'outline use 'outline-path-completion."
7463 (interactive "P")
7464 (org-goto-map)
7465 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7466 (org-refile-use-outline-path t)
7467 (org-refile-target-verify-function nil)
7468 (interface
7469 (if (not alternative-interface)
7470 org-goto-interface
7471 (if (eq org-goto-interface 'outline)
7472 'outline-path-completion
7473 'outline)))
7474 (org-goto-start-pos (point))
7475 (selected-point
7476 (if (eq interface 'outline)
7477 (car (org-get-location (current-buffer) org-goto-help))
7478 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7479 (org-refile-check-position pa)
7480 (nth 3 pa)))))
7481 (if selected-point
7482 (progn
7483 (org-mark-ring-push org-goto-start-pos)
7484 (goto-char selected-point)
7485 (if (or (outline-invisible-p) (org-invisible-p2))
7486 (org-show-context 'org-goto)))
7487 (message "Quit"))))
7489 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7490 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7491 (defvar org-goto-local-auto-isearch-map) ; defined below
7493 (defun org-get-location (buf help)
7494 "Let the user select a location in the Org-mode buffer BUF.
7495 This function uses a recursive edit. It returns the selected position
7496 or nil."
7497 (org-no-popups
7498 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7499 (isearch-hide-immediately nil)
7500 (isearch-search-fun-function
7501 (lambda () 'org-goto-local-search-headings))
7502 (org-goto-selected-point org-goto-exit-command))
7503 (save-excursion
7504 (save-window-excursion
7505 (delete-other-windows)
7506 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7507 (org-pop-to-buffer-same-window
7508 (condition-case nil
7509 (make-indirect-buffer (current-buffer) "*org-goto*")
7510 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7511 (with-output-to-temp-buffer "*Org Help*"
7512 (princ (format help (if org-goto-auto-isearch
7513 " Just type for auto-isearch."
7514 " n/p/f/b/u to navigate, q to quit."))))
7515 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7516 (setq buffer-read-only nil)
7517 (let ((org-startup-truncated t)
7518 (org-startup-folded nil)
7519 (org-startup-align-all-tables nil))
7520 (org-mode)
7521 (org-overview))
7522 (setq buffer-read-only t)
7523 (if (and (boundp 'org-goto-start-pos)
7524 (integer-or-marker-p org-goto-start-pos))
7525 (let ((org-show-hierarchy-above t)
7526 (org-show-siblings t)
7527 (org-show-following-heading t))
7528 (goto-char org-goto-start-pos)
7529 (and (outline-invisible-p) (org-show-context)))
7530 (goto-char (point-min)))
7531 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7532 (message "Select location and press RET")
7533 (use-local-map org-goto-map)
7534 (recursive-edit)))
7535 (kill-buffer "*org-goto*")
7536 (cons org-goto-selected-point org-goto-exit-command))))
7538 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7539 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7540 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7541 (if (fboundp 'isearch-other-control-char)
7542 (progn
7543 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7544 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7545 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7546 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7547 (define-key org-goto-local-auto-isearch-map [return] nil))
7549 (defun org-goto-local-search-headings (string bound noerror)
7550 "Search and make sure that any matches are in headlines."
7551 (catch 'return
7552 (while (if isearch-forward
7553 (search-forward string bound noerror)
7554 (search-backward string bound noerror))
7555 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7556 (and (member :headline context)
7557 (not (member :tags context))))
7558 (throw 'return (point))))))
7560 (defun org-goto-local-auto-isearch ()
7561 "Start isearch."
7562 (interactive)
7563 (goto-char (point-min))
7564 (let ((keys (this-command-keys)))
7565 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7566 (isearch-mode t)
7567 (isearch-process-search-char (string-to-char keys)))))
7569 (defun org-goto-ret (&optional arg)
7570 "Finish `org-goto' by going to the new location."
7571 (interactive "P")
7572 (setq org-goto-selected-point (point)
7573 org-goto-exit-command 'return)
7574 (throw 'exit nil))
7576 (defun org-goto-left ()
7577 "Finish `org-goto' by going to the new location."
7578 (interactive)
7579 (if (org-at-heading-p)
7580 (progn
7581 (beginning-of-line 1)
7582 (setq org-goto-selected-point (point)
7583 org-goto-exit-command 'left)
7584 (throw 'exit nil))
7585 (user-error "Not on a heading")))
7587 (defun org-goto-right ()
7588 "Finish `org-goto' by going to the new location."
7589 (interactive)
7590 (if (org-at-heading-p)
7591 (progn
7592 (setq org-goto-selected-point (point)
7593 org-goto-exit-command 'right)
7594 (throw 'exit nil))
7595 (user-error "Not on a heading")))
7597 (defun org-goto-quit ()
7598 "Finish `org-goto' without cursor motion."
7599 (interactive)
7600 (setq org-goto-selected-point nil)
7601 (setq org-goto-exit-command 'quit)
7602 (throw 'exit nil))
7604 ;;; Indirect buffer display of subtrees
7606 (defvar org-indirect-dedicated-frame nil
7607 "This is the frame being used for indirect tree display.")
7608 (defvar org-last-indirect-buffer nil)
7610 (defun org-tree-to-indirect-buffer (&optional arg)
7611 "Create indirect buffer and narrow it to current subtree.
7612 With a numerical prefix ARG, go up to this level and then take that tree.
7613 If ARG is negative, go up that many levels.
7615 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7616 indirect buffer previously made with this command, to avoid proliferation of
7617 indirect buffers. However, when you call the command with a \
7618 \\[universal-argument] prefix, or
7619 when `org-indirect-buffer-display' is `new-frame', the last buffer
7620 is kept so that you can work with several indirect buffers at the same time.
7621 If `org-indirect-buffer-display' is `dedicated-frame', the \
7622 \\[universal-argument] prefix also
7623 requests that a new frame be made for the new buffer, so that the dedicated
7624 frame is not changed."
7625 (interactive "P")
7626 (let ((cbuf (current-buffer))
7627 (cwin (selected-window))
7628 (pos (point))
7629 beg end level heading ibuf)
7630 (save-excursion
7631 (org-back-to-heading t)
7632 (when (numberp arg)
7633 (setq level (org-outline-level))
7634 (if (< arg 0) (setq arg (+ level arg)))
7635 (while (> (setq level (org-outline-level)) arg)
7636 (org-up-heading-safe)))
7637 (setq beg (point)
7638 heading (org-get-heading))
7639 (org-end-of-subtree t t)
7640 (if (org-at-heading-p) (backward-char 1))
7641 (setq end (point)))
7642 (if (and (buffer-live-p org-last-indirect-buffer)
7643 (not (eq org-indirect-buffer-display 'new-frame))
7644 (not arg))
7645 (kill-buffer org-last-indirect-buffer))
7646 (setq ibuf (org-get-indirect-buffer cbuf heading)
7647 org-last-indirect-buffer ibuf)
7648 (cond
7649 ((or (eq org-indirect-buffer-display 'new-frame)
7650 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7651 (select-frame (make-frame))
7652 (delete-other-windows)
7653 (org-pop-to-buffer-same-window ibuf)
7654 (org-set-frame-title heading))
7655 ((eq org-indirect-buffer-display 'dedicated-frame)
7656 (raise-frame
7657 (select-frame (or (and org-indirect-dedicated-frame
7658 (frame-live-p org-indirect-dedicated-frame)
7659 org-indirect-dedicated-frame)
7660 (setq org-indirect-dedicated-frame (make-frame)))))
7661 (delete-other-windows)
7662 (org-pop-to-buffer-same-window ibuf)
7663 (org-set-frame-title (concat "Indirect: " heading)))
7664 ((eq org-indirect-buffer-display 'current-window)
7665 (org-pop-to-buffer-same-window ibuf))
7666 ((eq org-indirect-buffer-display 'other-window)
7667 (pop-to-buffer ibuf))
7668 (t (error "Invalid value")))
7669 (if (featurep 'xemacs)
7670 (save-excursion (org-mode) (turn-on-font-lock)))
7671 (narrow-to-region beg end)
7672 (show-all)
7673 (goto-char pos)
7674 (run-hook-with-args 'org-cycle-hook 'all)
7675 (and (window-live-p cwin) (select-window cwin))))
7677 (defun org-get-indirect-buffer (&optional buffer heading)
7678 (setq buffer (or buffer (current-buffer)))
7679 (let ((n 1) (base (buffer-name buffer)) bname)
7680 (while (buffer-live-p
7681 (get-buffer
7682 (setq bname
7683 (concat base "-"
7684 (if heading (concat heading "-" (number-to-string n))
7685 (number-to-string n))))))
7686 (setq n (1+ n)))
7687 (condition-case nil
7688 (make-indirect-buffer buffer bname 'clone)
7689 (error (make-indirect-buffer buffer bname)))))
7691 (defun org-set-frame-title (title)
7692 "Set the title of the current frame to the string TITLE."
7693 ;; FIXME: how to name a single frame in XEmacs???
7694 (unless (featurep 'xemacs)
7695 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7697 ;;;; Structure editing
7699 ;;; Inserting headlines
7701 (defun org-previous-line-empty-p (&optional next)
7702 "Is the previous line a blank line?
7703 When NEXT is non-nil, check the next line instead."
7704 (save-excursion
7705 (and (not (bobp))
7706 (or (beginning-of-line (if next 2 0)) t)
7707 (save-match-data
7708 (looking-at "[ \t]*$")))))
7710 (defun org-insert-heading (&optional arg invisible-ok top-level)
7711 "Insert a new heading or an item with the same depth at point.
7713 If point is at the beginning of a heading or a list item, insert
7714 a new heading or a new item above the current one. If point is
7715 at the beginning of a normal line, turn the line into a heading.
7717 If point is in the middle of a headline or a list item, split the
7718 headline or the item and create a new headline/item with the text
7719 in the current line after point \(see `org-M-RET-may-split-line'
7720 on how to modify this behavior).
7722 With one universal prefix argument, set the user option
7723 `org-insert-heading-respect-content' to t for the duration of
7724 the command. This modifies the behavior described above in this
7725 ways: on list items and at the beginning of normal lines, force
7726 the insertion of a heading after the current subtree.
7728 With two universal prefix arguments, insert the heading at the
7729 end of the grandparent subtree. For example, if point is within
7730 a 2nd-level heading, then it will insert a 2nd-level heading at
7731 the end of the 1st-level parent heading.
7733 If point is at the beginning of a headline, insert a sibling
7734 before the current headline. If point is not at the beginning,
7735 split the line and create a new headline with the text in the
7736 current line after point \(see `org-M-RET-may-split-line' on how
7737 to modify this behavior).
7739 If point is at the beginning of a normal line, turn this line
7740 into a heading.
7742 When INVISIBLE-OK is set, stop at invisible headlines when going
7743 back. This is important for non-interactive uses of the
7744 command.
7746 When optional argument TOP-LEVEL is non-nil, insert a level 1
7747 heading, unconditionally."
7748 (interactive "P")
7749 (if (org-called-interactively-p 'any) (org-reveal))
7750 (let ((itemp (and (not top-level) (org-in-item-p)))
7751 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7752 (respect-content (or org-insert-heading-respect-content
7753 (equal arg '(4))))
7754 (initial-content "")
7755 (adjust-empty-lines t))
7757 (cond
7759 ((or (= (buffer-size) 0)
7760 (and (not (save-excursion
7761 (and (ignore-errors (org-back-to-heading invisible-ok))
7762 (org-at-heading-p))))
7763 (or arg (not itemp))))
7764 ;; At beginning of buffer or so high up that only a heading
7765 ;; makes sense.
7766 (cond ((and (bolp) (not respect-content)) (insert "* "))
7767 ((not respect-content)
7768 (unless may-split (end-of-line))
7769 (insert "\n* "))
7770 ((re-search-forward org-outline-regexp-bol nil t)
7771 (beginning-of-line)
7772 (insert "* \n")
7773 (backward-char))
7774 (t (goto-char (point-max))
7775 (insert "\n* ")))
7776 (run-hooks 'org-insert-heading-hook))
7778 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7781 ;; Maybe move at the end of the subtree
7782 (when (equal arg '(16))
7783 (org-up-heading-safe)
7784 (org-end-of-subtree t))
7785 ;; Insert a heading
7786 (save-restriction
7787 (widen)
7788 (let* ((level nil)
7789 (on-heading (org-at-heading-p))
7790 (empty-line-p (if on-heading
7791 (org-previous-line-empty-p)
7792 ;; We will decide later
7793 nil))
7794 ;; Get a level string to fall back on.
7795 (fix-level
7796 (if (org-before-first-heading-p) "*"
7797 (save-excursion
7798 (org-back-to-heading t)
7799 (if (org-previous-line-empty-p) (setq empty-line-p t))
7800 (looking-at org-outline-regexp)
7801 (make-string (1- (length (match-string 0))) ?*))))
7802 (stars
7803 (save-excursion
7804 (condition-case nil
7805 (if top-level "* "
7806 (org-back-to-heading invisible-ok)
7807 (when (and (not on-heading)
7808 (featurep 'org-inlinetask)
7809 (integerp org-inlinetask-min-level)
7810 (>= (length (match-string 0))
7811 org-inlinetask-min-level))
7812 ;; Find a heading level before the inline
7813 ;; task.
7814 (while (and (setq level (org-up-heading-safe))
7815 (>= level org-inlinetask-min-level)))
7816 (if (org-at-heading-p)
7817 (org-back-to-heading invisible-ok)
7818 (error "This should not happen")))
7819 (unless (and (save-excursion
7820 (save-match-data
7821 (org-backward-heading-same-level
7822 1 invisible-ok))
7823 (= (point) (match-beginning 0)))
7824 (not (org-previous-line-empty-p t)))
7825 (setq empty-line-p (or empty-line-p
7826 (org-previous-line-empty-p))))
7827 (match-string 0))
7828 (error (or fix-level "* ")))))
7829 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7830 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7831 pos hide-previous previous-pos)
7833 ;; If we insert after content, move there and clean up
7834 ;; whitespace.
7835 (when (and respect-content
7836 (not (org-looking-at-p org-outline-regexp-bol)))
7837 (if (not (org-before-first-heading-p))
7838 (org-end-of-subtree nil t)
7839 (re-search-forward org-outline-regexp-bol)
7840 (beginning-of-line 0))
7841 (skip-chars-backward " \r\t\n")
7842 (and (not (looking-back "^\\*+"))
7843 (looking-at "[ \t]+") (replace-match ""))
7844 (unless (eobp) (forward-char 1))
7845 (when (looking-at "^\\*")
7846 (unless (bobp) (backward-char 1))
7847 (insert "\n")))
7849 ;; If we are splitting, grab the text that should be moved
7850 ;; to the new headline.
7851 (when may-split
7852 (if (org-on-heading-p)
7853 ;; This is a heading: split intelligently (keeping
7854 ;; tags).
7855 (let ((pos (point)))
7856 (beginning-of-line)
7857 (unless (looking-at org-complex-heading-regexp)
7858 (error "This should not happen"))
7859 (when (and (match-beginning 4)
7860 (> pos (match-beginning 4))
7861 (< pos (match-end 4)))
7862 (setq initial-content (buffer-substring pos (match-end 4)))
7863 (goto-char pos)
7864 (delete-region (point) (match-end 4))
7865 (if (looking-at "[ \t]*$")
7866 (replace-match "")
7867 (insert (make-string (length initial-content) ?\s)))
7868 (setq initial-content (org-trim initial-content)))
7869 (goto-char pos))
7870 ;; A normal line.
7871 (setq initial-content
7872 (org-trim
7873 (delete-and-extract-region (point) (line-end-position))))))
7875 ;; If we are at the beginning of the line, insert before it.
7876 ;; Otherwise, after it.
7877 (cond
7878 ((and (bolp) (looking-at "[ \t]*$")))
7879 ((bolp) (open-line 1))
7880 (t (end-of-line)
7881 (insert "\n")))
7883 ;; Insert the new heading
7884 (insert stars)
7885 (just-one-space)
7886 (insert initial-content)
7887 (when (and adjust-empty-lines
7888 (not (and blank (org-previous-line-empty-p))))
7889 (org-N-empty-lines-before-current (if blank 1 0)))
7890 (run-hooks 'org-insert-heading-hook)))))))
7892 (defun org-N-empty-lines-before-current (N)
7893 "Make the number of empty lines before current exactly N.
7894 So this will delete or add empty lines."
7895 (save-excursion
7896 (beginning-of-line)
7897 (let ((p (point)))
7898 (skip-chars-backward " \r\t\n")
7899 (unless (bolp) (forward-line))
7900 (delete-region (point) p))
7901 (when (> N 0) (insert (make-string N ?\n)))))
7903 (defun org-get-heading (&optional no-tags no-todo)
7904 "Return the heading of the current entry, without the stars.
7905 When NO-TAGS is non-nil, don't include tags.
7906 When NO-TODO is non-nil, don't include TODO keywords."
7907 (save-excursion
7908 (org-back-to-heading t)
7909 (cond
7910 ((and no-tags no-todo)
7911 (looking-at org-complex-heading-regexp)
7912 (match-string 4))
7913 (no-tags
7914 (looking-at (concat org-outline-regexp
7915 "\\(.*?\\)"
7916 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7917 (match-string 1))
7918 (no-todo
7919 (looking-at org-todo-line-regexp)
7920 (match-string 3))
7921 (t (looking-at org-heading-regexp)
7922 (match-string 2)))))
7924 (defvar orgstruct-mode) ; defined below
7926 (defun org-heading-components ()
7927 "Return the components of the current heading.
7928 This is a list with the following elements:
7929 - the level as an integer
7930 - the reduced level, different if `org-odd-levels-only' is set.
7931 - the TODO keyword, or nil
7932 - the priority character, like ?A, or nil if no priority is given
7933 - the headline text itself, or the tags string if no headline text
7934 - the tags string, or nil."
7935 (save-excursion
7936 (org-back-to-heading t)
7937 (if (let (case-fold-search)
7938 (looking-at
7939 (if orgstruct-mode
7940 org-heading-regexp
7941 org-complex-heading-regexp)))
7942 (if orgstruct-mode
7943 (list (length (match-string 1))
7944 (org-reduced-level (length (match-string 1)))
7947 (match-string 2)
7948 nil)
7949 (list (length (match-string 1))
7950 (org-reduced-level (length (match-string 1)))
7951 (org-match-string-no-properties 2)
7952 (and (match-end 3) (aref (match-string 3) 2))
7953 (org-match-string-no-properties 4)
7954 (org-match-string-no-properties 5))))))
7956 (defun org-get-entry ()
7957 "Get the entry text, after heading, entire subtree."
7958 (save-excursion
7959 (org-back-to-heading t)
7960 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7962 (defun org-insert-heading-after-current ()
7963 "Insert a new heading with same level as current, after current subtree."
7964 (interactive)
7965 (org-back-to-heading)
7966 (org-insert-heading)
7967 (org-move-subtree-down)
7968 (end-of-line 1))
7970 (defun org-insert-heading-respect-content (&optional invisible-ok)
7971 "Insert heading with `org-insert-heading-respect-content' set to t."
7972 (interactive)
7973 (org-insert-heading '(4) invisible-ok))
7975 (defun org-insert-todo-heading-respect-content (&optional force-state)
7976 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7977 (interactive)
7978 (org-insert-todo-heading force-state '(4)))
7980 (defun org-insert-todo-heading (arg &optional force-heading)
7981 "Insert a new heading with the same level and TODO state as current heading.
7982 If the heading has no TODO state, or if the state is DONE, use the first
7983 state (TODO by default). Also with one prefix arg, force first state. With
7984 two prefix args, force inserting at the end of the parent subtree."
7985 (interactive "P")
7986 (when (or force-heading (not (org-insert-item 'checkbox)))
7987 (org-insert-heading (or (and (equal arg '(16)) '(16))
7988 force-heading))
7989 (save-excursion
7990 (org-back-to-heading)
7991 (outline-previous-heading)
7992 (looking-at org-todo-line-regexp))
7993 (let*
7994 ((new-mark-x
7995 (if (or (equal arg '(4))
7996 (not (match-beginning 2))
7997 (member (match-string 2) org-done-keywords))
7998 (car org-todo-keywords-1)
7999 (match-string 2)))
8000 (new-mark
8002 (run-hook-with-args-until-success
8003 'org-todo-get-default-hook new-mark-x nil)
8004 new-mark-x)))
8005 (beginning-of-line 1)
8006 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8007 (if org-treat-insert-todo-heading-as-state-change
8008 (org-todo new-mark)
8009 (insert new-mark " "))))
8010 (when org-provide-todo-statistics
8011 (org-update-parent-todo-statistics))))
8013 (defun org-insert-subheading (arg)
8014 "Insert a new subheading and demote it.
8015 Works for outline headings and for plain lists alike."
8016 (interactive "P")
8017 (org-insert-heading arg)
8018 (cond
8019 ((org-at-heading-p) (org-do-demote))
8020 ((org-at-item-p) (org-indent-item))))
8022 (defun org-insert-todo-subheading (arg)
8023 "Insert a new subheading with TODO keyword or checkbox and demote it.
8024 Works for outline headings and for plain lists alike."
8025 (interactive "P")
8026 (org-insert-todo-heading arg)
8027 (cond
8028 ((org-at-heading-p) (org-do-demote))
8029 ((org-at-item-p) (org-indent-item))))
8031 ;;; Promotion and Demotion
8033 (defvar org-after-demote-entry-hook nil
8034 "Hook run after an entry has been demoted.
8035 The cursor will be at the beginning of the entry.
8036 When a subtree is being demoted, the hook will be called for each node.")
8038 (defvar org-after-promote-entry-hook nil
8039 "Hook run after an entry has been promoted.
8040 The cursor will be at the beginning of the entry.
8041 When a subtree is being promoted, the hook will be called for each node.")
8043 (defun org-promote-subtree ()
8044 "Promote the entire subtree.
8045 See also `org-promote'."
8046 (interactive)
8047 (save-excursion
8048 (org-with-limited-levels (org-map-tree 'org-promote)))
8049 (org-fix-position-after-promote))
8051 (defun org-demote-subtree ()
8052 "Demote the entire subtree. See `org-demote'.
8053 See also `org-promote'."
8054 (interactive)
8055 (save-excursion
8056 (org-with-limited-levels (org-map-tree 'org-demote)))
8057 (org-fix-position-after-promote))
8060 (defun org-do-promote ()
8061 "Promote the current heading higher up the tree.
8062 If the region is active in `transient-mark-mode', promote all headings
8063 in the region."
8064 (interactive)
8065 (save-excursion
8066 (if (org-region-active-p)
8067 (org-map-region 'org-promote (region-beginning) (region-end))
8068 (org-promote)))
8069 (org-fix-position-after-promote))
8071 (defun org-do-demote ()
8072 "Demote the current heading lower down the tree.
8073 If the region is active in `transient-mark-mode', demote all headings
8074 in the region."
8075 (interactive)
8076 (save-excursion
8077 (if (org-region-active-p)
8078 (org-map-region 'org-demote (region-beginning) (region-end))
8079 (org-demote)))
8080 (org-fix-position-after-promote))
8082 (defun org-fix-position-after-promote ()
8083 "Make sure that after pro/demotion cursor position is right."
8084 (let ((pos (point)))
8085 (when (save-excursion
8086 (beginning-of-line 1)
8087 (looking-at org-todo-line-regexp)
8088 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8089 (cond ((eobp) (insert " "))
8090 ((eolp) (insert " "))
8091 ((equal (char-after) ?\ ) (forward-char 1))))))
8093 (defun org-current-level ()
8094 "Return the level of the current entry, or nil if before the first headline.
8095 The level is the number of stars at the beginning of the
8096 headline. Use `org-reduced-level' to remove the effect of
8097 `org-odd-levels'. Unlike to `org-outline-level', this function
8098 ignores inlinetasks."
8099 (let ((level (org-with-limited-levels (org-outline-level))))
8100 (and (> level 0) level)))
8102 (defun org-get-previous-line-level ()
8103 "Return the outline depth of the last headline before the current line.
8104 Returns 0 for the first headline in the buffer, and nil if before the
8105 first headline."
8106 (and (org-current-level)
8107 (or (and (/= (line-beginning-position) (point-min))
8108 (save-excursion (beginning-of-line 0) (org-current-level)))
8109 0)))
8111 (defun org-reduced-level (l)
8112 "Compute the effective level of a heading.
8113 This takes into account the setting of `org-odd-levels-only'."
8114 (cond
8115 ((zerop l) 0)
8116 (org-odd-levels-only (1+ (floor (/ l 2))))
8117 (t l)))
8119 (defun org-level-increment ()
8120 "Return the number of stars that will be added or removed at a
8121 time to headlines when structure editing, based on the value of
8122 `org-odd-levels-only'."
8123 (if org-odd-levels-only 2 1))
8125 (defun org-get-valid-level (level &optional change)
8126 "Rectify a level change under the influence of `org-odd-levels-only'
8127 LEVEL is a current level, CHANGE is by how much the level should be
8128 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8129 even level numbers will become the next higher odd number."
8130 (if org-odd-levels-only
8131 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8132 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8133 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8134 (max 1 (+ level (or change 0)))))
8136 (if (boundp 'define-obsolete-function-alias)
8137 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8138 (define-obsolete-function-alias 'org-get-legal-level
8139 'org-get-valid-level)
8140 (define-obsolete-function-alias 'org-get-legal-level
8141 'org-get-valid-level "23.1")))
8143 (defun org-promote ()
8144 "Promote the current heading higher up the tree."
8145 (org-with-wide-buffer
8146 (org-back-to-heading t)
8147 (let* ((after-change-functions (remq 'flyspell-after-change-function
8148 after-change-functions))
8149 (level (save-match-data (funcall outline-level)))
8150 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8151 (diff (abs (- level (length up-head) -1))))
8152 (cond
8153 ((and (= level 1) org-allow-promoting-top-level-subtree)
8154 (replace-match "# " nil t))
8155 ((= level 1)
8156 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8157 (t (replace-match up-head nil t)))
8158 (unless (= level 1)
8159 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8160 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8161 (run-hooks 'org-after-promote-entry-hook))))
8163 (defun org-demote ()
8164 "Demote the current heading lower down the tree."
8165 (org-with-wide-buffer
8166 (org-back-to-heading t)
8167 (let* ((after-change-functions (remq 'flyspell-after-change-function
8168 after-change-functions))
8169 (level (save-match-data (funcall outline-level)))
8170 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8171 (diff (abs (- level (length down-head) -1))))
8172 (replace-match down-head nil t)
8173 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8174 (when org-adapt-indentation (org-fixup-indentation diff))
8175 (run-hooks 'org-after-demote-entry-hook))))
8177 (defun org-cycle-level ()
8178 "Cycle the level of an empty headline through possible states.
8179 This goes first to child, then to parent, level, then up the hierarchy.
8180 After top level, it switches back to sibling level."
8181 (interactive)
8182 (let ((org-adapt-indentation nil))
8183 (when (org-point-at-end-of-empty-headline)
8184 (setq this-command 'org-cycle-level) ; Only needed for caching
8185 (let ((cur-level (org-current-level))
8186 (prev-level (org-get-previous-line-level)))
8187 (cond
8188 ;; If first headline in file, promote to top-level.
8189 ((= prev-level 0)
8190 (loop repeat (/ (- cur-level 1) (org-level-increment))
8191 do (org-do-promote)))
8192 ;; If same level as prev, demote one.
8193 ((= prev-level cur-level)
8194 (org-do-demote))
8195 ;; If parent is top-level, promote to top level if not already.
8196 ((= prev-level 1)
8197 (loop repeat (/ (- cur-level 1) (org-level-increment))
8198 do (org-do-promote)))
8199 ;; If top-level, return to prev-level.
8200 ((= cur-level 1)
8201 (loop repeat (/ (- prev-level 1) (org-level-increment))
8202 do (org-do-demote)))
8203 ;; If less than prev-level, promote one.
8204 ((< cur-level prev-level)
8205 (org-do-promote))
8206 ;; If deeper than prev-level, promote until higher than
8207 ;; prev-level.
8208 ((> cur-level prev-level)
8209 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8210 do (org-do-promote))))
8211 t))))
8213 (defun org-map-tree (fun)
8214 "Call FUN for every heading underneath the current one."
8215 (org-back-to-heading)
8216 (let ((level (funcall outline-level)))
8217 (save-excursion
8218 (funcall fun)
8219 (while (and (progn
8220 (outline-next-heading)
8221 (> (funcall outline-level) level))
8222 (not (eobp)))
8223 (funcall fun)))))
8225 (defun org-map-region (fun beg end)
8226 "Call FUN for every heading between BEG and END."
8227 (let ((org-ignore-region t))
8228 (save-excursion
8229 (setq end (copy-marker end))
8230 (goto-char beg)
8231 (if (and (re-search-forward org-outline-regexp-bol nil t)
8232 (< (point) end))
8233 (funcall fun))
8234 (while (and (progn
8235 (outline-next-heading)
8236 (< (point) end))
8237 (not (eobp)))
8238 (funcall fun)))))
8240 (defun org-fixup-indentation (diff)
8241 "Change the indentation in the current entry by DIFF.
8243 DIFF is an integer. Indentation is done according to the
8244 following rules:
8246 - Planning information and property drawers are always indented
8247 according to the new level of the headline;
8249 - Footnote definitions and their contents are ignored;
8251 - Inlinetasks' boundaries are not shifted;
8253 - Empty lines are ignored;
8255 - Other lines' indentation are shifted by DIFF columns, unless
8256 it would introduce a structural change in the document, in
8257 which case no shifting is done at all.
8259 Assume point is at a heading or an inlinetask beginning."
8260 (org-with-wide-buffer
8261 (narrow-to-region (line-beginning-position)
8262 (save-excursion
8263 (if (org-with-limited-levels (org-at-heading-p))
8264 (org-with-limited-levels (outline-next-heading))
8265 (org-inlinetask-goto-end))
8266 (point)))
8267 (forward-line)
8268 ;; Indent properly planning info and property drawer.
8269 (when (org-looking-at-p org-planning-line-re)
8270 (org-indent-line)
8271 (forward-line))
8272 (when (looking-at org-property-drawer-re)
8273 (goto-char (match-end 0))
8274 (forward-line)
8275 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8276 (catch 'no-shift
8277 (when (zerop diff) (throw 'no-shift nil))
8278 ;; If DIFF is negative, first check if a shift is possible at all
8279 ;; (e.g., it doesn't break structure). This can only happen if
8280 ;; some contents are not properly indented.
8281 (let ((case-fold-search t))
8282 (when (< diff 0)
8283 (let ((diff (- diff))
8284 (forbidden-re (concat org-outline-regexp
8285 "\\|"
8286 (substring org-footnote-definition-re 1))))
8287 (save-excursion
8288 (while (not (eobp))
8289 (cond
8290 ((org-looking-at-p "[ \t]*$") (forward-line))
8291 ((and (org-looking-at-p org-footnote-definition-re)
8292 (let ((e (org-element-at-point)))
8293 (and (eq (org-element-type e) 'footnote-definition)
8294 (goto-char (org-element-property :end e))))))
8295 ((org-looking-at-p org-outline-regexp) (forward-line))
8296 ;; Give up if shifting would move before column 0 or
8297 ;; if it would introduce a headline or a footnote
8298 ;; definition.
8300 (skip-chars-forward " \t")
8301 (let ((ind (current-column)))
8302 (when (or (< ind diff)
8303 (and (= ind diff) (org-looking-at-p forbidden-re)))
8304 (throw 'no-shift nil)))
8305 ;; Ignore contents of example blocks and source
8306 ;; blocks if their indentation is meant to be
8307 ;; preserved. Jump to block's closing line.
8308 (beginning-of-line)
8309 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8310 (let ((e (org-element-at-point)))
8311 (and (memq (org-element-type e)
8312 '(example-block src-block))
8313 (or org-src-preserve-indentation
8314 (org-element-property :preserve-indent e))
8315 (goto-char (org-element-property :end e))
8316 (progn (skip-chars-backward " \r\t\n")
8317 (beginning-of-line)
8318 t))))
8319 (forward-line))))))))
8320 ;; Shift lines but footnote definitions, inlinetasks boundaries
8321 ;; by DIFF. Also skip contents of source or example blocks
8322 ;; when indentation is meant to be preserved.
8323 (while (not (eobp))
8324 (cond
8325 ((and (org-looking-at-p org-footnote-definition-re)
8326 (let ((e (org-element-at-point)))
8327 (and (eq (org-element-type e) 'footnote-definition)
8328 (goto-char (org-element-property :end e))))))
8329 ((org-looking-at-p org-outline-regexp) (forward-line))
8330 ((org-looking-at-p "[ \t]*$") (forward-line))
8332 (org-indent-line-to (+ (org-get-indentation) diff))
8333 (beginning-of-line)
8334 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8335 (let ((e (org-element-at-point)))
8336 (and (memq (org-element-type e)
8337 '(example-block src-block))
8338 (or org-src-preserve-indentation
8339 (org-element-property :preserve-indent e))
8340 (goto-char (org-element-property :end e))
8341 (progn (skip-chars-backward " \r\t\n")
8342 (beginning-of-line)
8343 t))))
8344 (forward-line)))))))))
8346 (defun org-convert-to-odd-levels ()
8347 "Convert an org-mode file with all levels allowed to one with odd levels.
8348 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8349 level 5 etc."
8350 (interactive)
8351 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8352 (let ((outline-level 'org-outline-level)
8353 (org-odd-levels-only nil) n)
8354 (save-excursion
8355 (goto-char (point-min))
8356 (while (re-search-forward "^\\*\\*+ " nil t)
8357 (setq n (- (length (match-string 0)) 2))
8358 (while (>= (setq n (1- n)) 0)
8359 (org-demote))
8360 (end-of-line 1))))))
8362 (defun org-convert-to-oddeven-levels ()
8363 "Convert an org-mode file with only odd levels to one with odd/even levels.
8364 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8365 file contains a section with an even level, conversion would
8366 destroy the structure of the file. An error is signaled in this
8367 case."
8368 (interactive)
8369 (goto-char (point-min))
8370 ;; First check if there are no even levels
8371 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8372 (org-show-context t)
8373 (error "Not all levels are odd in this file. Conversion not possible"))
8374 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8375 (let ((outline-regexp org-outline-regexp)
8376 (outline-level 'org-outline-level)
8377 (org-odd-levels-only nil) n)
8378 (save-excursion
8379 (goto-char (point-min))
8380 (while (re-search-forward "^\\*\\*+ " nil t)
8381 (setq n (/ (1- (length (match-string 0))) 2))
8382 (while (>= (setq n (1- n)) 0)
8383 (org-promote))
8384 (end-of-line 1))))))
8386 (defun org-tr-level (n)
8387 "Make N odd if required."
8388 (if org-odd-levels-only (1+ (/ n 2)) n))
8390 ;;; Vertical tree motion, cutting and pasting of subtrees
8392 (defun org-move-subtree-up (&optional arg)
8393 "Move the current subtree up past ARG headlines of the same level."
8394 (interactive "p")
8395 (org-move-subtree-down (- (prefix-numeric-value arg))))
8397 (defun org-move-subtree-down (&optional arg)
8398 "Move the current subtree down past ARG headlines of the same level."
8399 (interactive "p")
8400 (setq arg (prefix-numeric-value arg))
8401 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8402 'org-get-last-sibling))
8403 (ins-point (make-marker))
8404 (cnt (abs arg))
8405 (col (current-column))
8406 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8407 ;; Select the tree
8408 (org-back-to-heading)
8409 (setq beg0 (point))
8410 (save-excursion
8411 (setq ne-beg (org-back-over-empty-lines))
8412 (setq beg (point)))
8413 (save-match-data
8414 (save-excursion (outline-end-of-heading)
8415 (setq folded (outline-invisible-p)))
8416 (progn (org-end-of-subtree nil t)
8417 (unless (eobp) (backward-char))))
8418 (outline-next-heading)
8419 (setq ne-end (org-back-over-empty-lines))
8420 (setq end (point))
8421 (goto-char beg0)
8422 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8423 ;; include less whitespace
8424 (save-excursion
8425 (goto-char beg)
8426 (forward-line (- ne-beg ne-end))
8427 (setq beg (point))))
8428 ;; Find insertion point, with error handling
8429 (while (> cnt 0)
8430 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8431 (progn (goto-char beg0)
8432 (user-error "Cannot move past superior level or buffer limit")))
8433 (setq cnt (1- cnt)))
8434 (if (> arg 0)
8435 ;; Moving forward - still need to move over subtree
8436 (progn (org-end-of-subtree t t)
8437 (save-excursion
8438 (org-back-over-empty-lines)
8439 (or (bolp) (newline)))))
8440 (setq ne-ins (org-back-over-empty-lines))
8441 (move-marker ins-point (point))
8442 (setq txt (buffer-substring beg end))
8443 (org-save-markers-in-region beg end)
8444 (delete-region beg end)
8445 (org-remove-empty-overlays-at beg)
8446 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8447 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8448 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8449 (let ((bbb (point)))
8450 (insert-before-markers txt)
8451 (org-reinstall-markers-in-region bbb)
8452 (move-marker ins-point bbb))
8453 (or (bolp) (insert "\n"))
8454 (setq ins-end (point))
8455 (goto-char ins-point)
8456 (org-skip-whitespace)
8457 (when (and (< arg 0)
8458 (org-first-sibling-p)
8459 (> ne-ins ne-beg))
8460 ;; Move whitespace back to beginning
8461 (save-excursion
8462 (goto-char ins-end)
8463 (let ((kill-whole-line t))
8464 (kill-line (- ne-ins ne-beg)) (point)))
8465 (insert (make-string (- ne-ins ne-beg) ?\n)))
8466 (move-marker ins-point nil)
8467 (if folded
8468 (hide-subtree)
8469 (org-show-entry)
8470 (show-children)
8471 (org-cycle-hide-drawers 'children))
8472 (org-clean-visibility-after-subtree-move)
8473 ;; move back to the initial column we were at
8474 (move-to-column col)))
8476 (defvar org-subtree-clip ""
8477 "Clipboard for cut and paste of subtrees.
8478 This is actually only a copy of the kill, because we use the normal kill
8479 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8481 (defvar org-subtree-clip-folded nil
8482 "Was the last copied subtree folded?
8483 This is used to fold the tree back after pasting.")
8485 (defun org-cut-subtree (&optional n)
8486 "Cut the current subtree into the clipboard.
8487 With prefix arg N, cut this many sequential subtrees.
8488 This is a short-hand for marking the subtree and then cutting it."
8489 (interactive "p")
8490 (org-copy-subtree n 'cut))
8492 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8493 "Copy the current subtree it in the clipboard.
8494 With prefix arg N, copy this many sequential subtrees.
8495 This is a short-hand for marking the subtree and then copying it.
8496 If CUT is non-nil, actually cut the subtree.
8497 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8498 of some markers in the region, even if CUT is non-nil. This is
8499 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8500 (interactive "p")
8501 (let (beg end folded (beg0 (point)))
8502 (if (org-called-interactively-p 'any)
8503 (org-back-to-heading nil) ; take what looks like a subtree
8504 (org-back-to-heading t)) ; take what is really there
8505 (setq beg (point))
8506 (skip-chars-forward " \t\r\n")
8507 (save-match-data
8508 (if nosubtrees
8509 (outline-next-heading)
8510 (save-excursion (outline-end-of-heading)
8511 (setq folded (outline-invisible-p)))
8512 (ignore-errors (org-forward-heading-same-level (1- n) t))
8513 (org-end-of-subtree t t)))
8514 (setq end (point))
8515 (goto-char beg0)
8516 (when (> end beg)
8517 (setq org-subtree-clip-folded folded)
8518 (when (or cut force-store-markers)
8519 (org-save-markers-in-region beg end))
8520 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8521 (setq org-subtree-clip (current-kill 0))
8522 (message "%s: Subtree(s) with %d characters"
8523 (if cut "Cut" "Copied")
8524 (length org-subtree-clip)))))
8526 (defun org-paste-subtree (&optional level tree for-yank remove)
8527 "Paste the clipboard as a subtree, with modification of headline level.
8528 The entire subtree is promoted or demoted in order to match a new headline
8529 level.
8531 If the cursor is at the beginning of a headline, the same level as
8532 that headline is used to paste the tree.
8534 If not, the new level is derived from the *visible* headings
8535 before and after the insertion point, and taken to be the inferior headline
8536 level of the two. So if the previous visible heading is level 3 and the
8537 next is level 4 (or vice versa), level 4 will be used for insertion.
8538 This makes sure that the subtree remains an independent subtree and does
8539 not swallow low level entries.
8541 You can also force a different level, either by using a numeric prefix
8542 argument, or by inserting the heading marker by hand. For example, if the
8543 cursor is after \"*****\", then the tree will be shifted to level 5.
8545 If optional TREE is given, use this text instead of the kill ring.
8547 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8548 move back over whitespace before inserting, and move point to the end of
8549 the inserted text when done.
8551 When REMOVE is non-nil, remove the subtree from the clipboard."
8552 (interactive "P")
8553 (setq tree (or tree (and kill-ring (current-kill 0))))
8554 (unless (org-kill-is-subtree-p tree)
8555 (user-error "%s"
8556 (substitute-command-keys
8557 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8558 (org-with-limited-levels
8559 (let* ((visp (not (outline-invisible-p)))
8560 (txt tree)
8561 (^re_ "\\(\\*+\\)[ \t]*")
8562 (old-level (if (string-match org-outline-regexp-bol txt)
8563 (- (match-end 0) (match-beginning 0) 1)
8564 -1))
8565 (force-level (cond (level (prefix-numeric-value level))
8566 ((and (looking-at "[ \t]*$")
8567 (string-match
8568 "^\\*+$" (buffer-substring
8569 (point-at-bol) (point))))
8570 (- (match-end 0) (match-beginning 0)))
8571 ((and (bolp)
8572 (looking-at org-outline-regexp))
8573 (- (match-end 0) (point) 1))))
8574 (previous-level (save-excursion
8575 (condition-case nil
8576 (progn
8577 (outline-previous-visible-heading 1)
8578 (if (looking-at ^re_)
8579 (- (match-end 0) (match-beginning 0) 1)
8581 (error 1))))
8582 (next-level (save-excursion
8583 (condition-case nil
8584 (progn
8585 (or (looking-at org-outline-regexp)
8586 (outline-next-visible-heading 1))
8587 (if (looking-at ^re_)
8588 (- (match-end 0) (match-beginning 0) 1)
8590 (error 1))))
8591 (new-level (or force-level (max previous-level next-level)))
8592 (shift (if (or (= old-level -1)
8593 (= new-level -1)
8594 (= old-level new-level))
8596 (- new-level old-level)))
8597 (delta (if (> shift 0) -1 1))
8598 (func (if (> shift 0) 'org-demote 'org-promote))
8599 (org-odd-levels-only nil)
8600 beg end newend)
8601 ;; Remove the forced level indicator
8602 (if force-level
8603 (delete-region (point-at-bol) (point)))
8604 ;; Paste
8605 (beginning-of-line (if (bolp) 1 2))
8606 (setq beg (point))
8607 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8608 (insert-before-markers txt)
8609 (unless (string-match "\n\\'" txt) (insert "\n"))
8610 (setq newend (point))
8611 (org-reinstall-markers-in-region beg)
8612 (setq end (point))
8613 (goto-char beg)
8614 (skip-chars-forward " \t\n\r")
8615 (setq beg (point))
8616 (if (and (outline-invisible-p) visp)
8617 (save-excursion (outline-show-heading)))
8618 ;; Shift if necessary
8619 (unless (= shift 0)
8620 (save-restriction
8621 (narrow-to-region beg end)
8622 (while (not (= shift 0))
8623 (org-map-region func (point-min) (point-max))
8624 (setq shift (+ delta shift)))
8625 (goto-char (point-min))
8626 (setq newend (point-max))))
8627 (when (or (org-called-interactively-p 'interactive) for-yank)
8628 (message "Clipboard pasted as level %d subtree" new-level))
8629 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8630 kill-ring
8631 (eq org-subtree-clip (current-kill 0))
8632 org-subtree-clip-folded)
8633 ;; The tree was folded before it was killed/copied
8634 (hide-subtree))
8635 (and for-yank (goto-char newend))
8636 (and remove (setq kill-ring (cdr kill-ring))))))
8638 (defun org-kill-is-subtree-p (&optional txt)
8639 "Check if the current kill is an outline subtree, or a set of trees.
8640 Returns nil if kill does not start with a headline, or if the first
8641 headline level is not the largest headline level in the tree.
8642 So this will actually accept several entries of equal levels as well,
8643 which is OK for `org-paste-subtree'.
8644 If optional TXT is given, check this string instead of the current kill."
8645 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8646 (re (org-get-limited-outline-regexp))
8647 (^re (concat "^" re))
8648 (start-level (and kill
8649 (string-match
8650 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8651 kill)
8652 (- (match-end 2) (match-beginning 2) 1)))
8653 (start (1+ (or (match-beginning 2) -1))))
8654 (if (not start-level)
8655 (progn
8656 nil) ;; does not even start with a heading
8657 (catch 'exit
8658 (while (setq start (string-match ^re kill (1+ start)))
8659 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8660 (throw 'exit nil)))
8661 t))))
8663 (defvar org-markers-to-move nil
8664 "Markers that should be moved with a cut-and-paste operation.
8665 Those markers are stored together with their positions relative to
8666 the start of the region.")
8668 (defun org-save-markers-in-region (beg end)
8669 "Check markers in region.
8670 If these markers are between BEG and END, record their position relative
8671 to BEG, so that after moving the block of text, we can put the markers back
8672 into place.
8673 This function gets called just before an entry or tree gets cut from the
8674 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8675 called immediately, to move the markers with the entries."
8676 (setq org-markers-to-move nil)
8677 (when (featurep 'org-clock)
8678 (org-clock-save-markers-for-cut-and-paste beg end))
8679 (when (featurep 'org-agenda)
8680 (org-agenda-save-markers-for-cut-and-paste beg end)))
8682 (defun org-check-and-save-marker (marker beg end)
8683 "Check if MARKER is between BEG and END.
8684 If yes, remember the marker and the distance to BEG."
8685 (when (and (marker-buffer marker)
8686 (equal (marker-buffer marker) (current-buffer)))
8687 (if (and (>= marker beg) (< marker end))
8688 (push (cons marker (- marker beg)) org-markers-to-move))))
8690 (defun org-reinstall-markers-in-region (beg)
8691 "Move all remembered markers to their position relative to BEG."
8692 (mapc (lambda (x)
8693 (move-marker (car x) (+ beg (cdr x))))
8694 org-markers-to-move)
8695 (setq org-markers-to-move nil))
8697 (defun org-narrow-to-subtree ()
8698 "Narrow buffer to the current subtree."
8699 (interactive)
8700 (save-excursion
8701 (save-match-data
8702 (org-with-limited-levels
8703 (narrow-to-region
8704 (progn (org-back-to-heading t) (point))
8705 (progn (org-end-of-subtree t t)
8706 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8707 (point)))))))
8709 (defun org-narrow-to-block ()
8710 "Narrow buffer to the current block."
8711 (interactive)
8712 (let* ((case-fold-search t)
8713 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8714 "^[ \t]*#\\+end_.*")))
8715 (if blockp
8716 (narrow-to-region (car blockp) (cdr blockp))
8717 (user-error "Not in a block"))))
8719 (defun org-clone-subtree-with-time-shift (n &optional shift)
8720 "Clone the task (subtree) at point N times.
8721 The clones will be inserted as siblings.
8723 In interactive use, the user will be prompted for the number of
8724 clones to be produced. If the entry has a timestamp, the user
8725 will also be prompted for a time shift, which may be a repeater
8726 as used in time stamps, for example `+3d'. To disable this,
8727 you can call the function with a universal prefix argument.
8729 When a valid repeater is given and the entry contains any time
8730 stamps, the clones will become a sequence in time, with time
8731 stamps in the subtree shifted for each clone produced. If SHIFT
8732 is nil or the empty string, time stamps will be left alone. The
8733 ID property of the original subtree is removed.
8735 If the original subtree did contain time stamps with a repeater,
8736 the following will happen:
8737 - the repeater will be removed in each clone
8738 - an additional clone will be produced, with the current, unshifted
8739 date(s) in the entry.
8740 - the original entry will be placed *after* all the clones, with
8741 repeater intact.
8742 - the start days in the repeater in the original entry will be shifted
8743 to past the last clone.
8744 In this way you can spell out a number of instances of a repeating task,
8745 and still retain the repeater to cover future instances of the task."
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 (if (not (and (integerp n) (> n 0)))
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)) t t s)))
8839 (let ((st (format " %s " s)))
8840 (while (string-match org-emph-re st)
8841 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8842 (setq s (substring st 1 -1)))
8845 (defvar org-priority-regexp) ; defined later in the file
8847 (defvar org-after-sorting-entries-or-items-hook nil
8848 "Hook that is run after a bunch of entries or items have been sorted.
8849 When children are sorted, the cursor is in the parent line when this
8850 hook gets called. When a region or a plain list is sorted, the cursor
8851 will be in the first entry of the sorted region/list.")
8853 (defun org-sort-entries
8854 (&optional with-case sorting-type getkey-func compare-func property)
8855 "Sort entries on a certain level of an outline tree.
8856 If there is an active region, the entries in the region are sorted.
8857 Else, if the cursor is before the first entry, sort the top-level items.
8858 Else, the children of the entry at point are sorted.
8860 Sorting can be alphabetically, numerically, by date/time as given by
8861 a time stamp, by a property, by priority order, or by a custom function.
8863 The command prompts for the sorting type unless it has been given to the
8864 function through the SORTING-TYPE argument, which needs to be a character,
8865 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8866 the precise meaning of each character:
8868 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8869 c By creation time, which is assumed to be the first inactive time stamp
8870 at the beginning of a line.
8871 d By deadline date/time.
8872 k By clocking time.
8873 n Numerically, by converting the beginning of the entry/item to a number.
8874 o By order of TODO keywords.
8875 p By priority according to the cookie.
8876 r By the value of a property.
8877 s By scheduled date/time.
8878 t By date/time, either the first active time stamp in the entry, or, if
8879 none exist, by the first inactive one.
8881 Capital letters will reverse the sort order.
8883 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8884 called with point at the beginning of the record. It must return either
8885 a string or a number that should serve as the sorting key for that record.
8887 Comparing entries ignores case by default. However, with an optional argument
8888 WITH-CASE, the sorting considers case as well.
8890 Sorting is done against the visible part of the headlines, it ignores hidden
8891 links.
8893 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8894 (interactive "P")
8895 (let ((case-func (if with-case 'identity 'downcase))
8896 (cmstr
8897 ;; The clock marker is lost when using `sort-subr', let's
8898 ;; store the clocking string.
8899 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8900 (save-excursion
8901 (goto-char org-clock-marker)
8902 (looking-back "^.*") (match-string-no-properties 0))))
8903 start beg end stars re re2
8904 txt what tmp)
8905 ;; Find beginning and end of region to sort
8906 (cond
8907 ((org-region-active-p)
8908 ;; we will sort the region
8909 (setq end (region-end)
8910 what "region")
8911 (goto-char (region-beginning))
8912 (if (not (org-at-heading-p)) (outline-next-heading))
8913 (setq start (point)))
8914 ((or (org-at-heading-p)
8915 (ignore-errors (progn (org-back-to-heading) t)))
8916 ;; we will sort the children of the current headline
8917 (org-back-to-heading)
8918 (setq start (point)
8919 end (progn (org-end-of-subtree t t)
8920 (or (bolp) (insert "\n"))
8921 (when (>= (org-back-over-empty-lines) 1)
8922 (forward-line 1))
8923 (point))
8924 what "children")
8925 (goto-char start)
8926 (show-subtree)
8927 (outline-next-heading))
8929 ;; we will sort the top-level entries in this file
8930 (goto-char (point-min))
8931 (or (org-at-heading-p) (outline-next-heading))
8932 (setq start (point))
8933 (goto-char (point-max))
8934 (beginning-of-line 1)
8935 (when (looking-at ".*?\\S-")
8936 ;; File ends in a non-white line
8937 (end-of-line 1)
8938 (insert "\n"))
8939 (setq end (point-max))
8940 (setq what "top-level")
8941 (goto-char start)
8942 (show-all)))
8944 (setq beg (point))
8945 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8947 (looking-at "\\(\\*+\\)")
8948 (setq stars (match-string 1)
8949 re (concat "^" (regexp-quote stars) " +")
8950 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8951 txt (buffer-substring beg end))
8952 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8953 (if (and (not (equal stars "*")) (string-match re2 txt))
8954 (user-error "Region to sort contains a level above the first entry"))
8956 (unless sorting-type
8957 (message
8958 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8959 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8960 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8961 what)
8962 (setq sorting-type (read-char-exclusive))
8964 (unless getkey-func
8965 (and (= (downcase sorting-type) ?f)
8966 (setq getkey-func
8967 (org-icompleting-read "Sort using function: "
8968 obarray 'fboundp t nil nil))
8969 (setq getkey-func (intern getkey-func))))
8971 (and (= (downcase sorting-type) ?r)
8972 (not property)
8973 (setq property
8974 (org-icompleting-read "Property: "
8975 (mapcar 'list (org-buffer-property-keys t))
8976 nil t))))
8978 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8979 (message "Sorting entries...")
8981 (save-restriction
8982 (narrow-to-region start end)
8983 (let ((dcst (downcase sorting-type))
8984 (case-fold-search nil)
8985 (now (current-time)))
8986 (sort-subr
8987 (/= dcst sorting-type)
8988 ;; This function moves to the beginning character of the "record" to
8989 ;; be sorted.
8990 (lambda nil
8991 (if (re-search-forward re nil t)
8992 (goto-char (match-beginning 0))
8993 (goto-char (point-max))))
8994 ;; This function moves to the last character of the "record" being
8995 ;; sorted.
8996 (lambda nil
8997 (save-match-data
8998 (condition-case nil
8999 (outline-forward-same-level 1)
9000 (error
9001 (goto-char (point-max))))))
9002 ;; This function returns the value that gets sorted against.
9003 (lambda nil
9004 (cond
9005 ((= dcst ?n)
9006 (if (looking-at org-complex-heading-regexp)
9007 (string-to-number (org-sort-remove-invisible (match-string 4)))
9008 nil))
9009 ((= dcst ?a)
9010 (if (looking-at org-complex-heading-regexp)
9011 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9012 nil))
9013 ((= dcst ?k)
9014 (or (get-text-property (point) :org-clock-minutes) 0))
9015 ((= dcst ?t)
9016 (let ((end (save-excursion (outline-next-heading) (point))))
9017 (if (or (re-search-forward org-ts-regexp end t)
9018 (re-search-forward org-ts-regexp-both end t))
9019 (org-time-string-to-seconds (match-string 0))
9020 (org-float-time now))))
9021 ((= dcst ?c)
9022 (let ((end (save-excursion (outline-next-heading) (point))))
9023 (if (re-search-forward
9024 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9025 end t)
9026 (org-time-string-to-seconds (match-string 0))
9027 (org-float-time now))))
9028 ((= dcst ?s)
9029 (let ((end (save-excursion (outline-next-heading) (point))))
9030 (if (re-search-forward org-scheduled-time-regexp end t)
9031 (org-time-string-to-seconds (match-string 1))
9032 (org-float-time now))))
9033 ((= dcst ?d)
9034 (let ((end (save-excursion (outline-next-heading) (point))))
9035 (if (re-search-forward org-deadline-time-regexp end t)
9036 (org-time-string-to-seconds (match-string 1))
9037 (org-float-time now))))
9038 ((= dcst ?p)
9039 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9040 (string-to-char (match-string 2))
9041 org-default-priority))
9042 ((= dcst ?r)
9043 (or (org-entry-get nil property) ""))
9044 ((= dcst ?o)
9045 (if (looking-at org-complex-heading-regexp)
9046 (let* ((m (match-string 2))
9047 (s (if (member m org-done-keywords) '- '+)))
9048 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9049 ((= dcst ?f)
9050 (if getkey-func
9051 (progn
9052 (setq tmp (funcall getkey-func))
9053 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9054 tmp)
9055 (error "Invalid key function `%s'" getkey-func)))
9056 (t (error "Invalid sorting type `%c'" sorting-type))))
9058 (cond
9059 ((= dcst ?a) 'string<)
9060 ((= dcst ?f) compare-func)
9061 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9062 (run-hooks 'org-after-sorting-entries-or-items-hook)
9063 ;; Reset the clock marker if needed
9064 (when cmstr
9065 (save-excursion
9066 (goto-char start)
9067 (search-forward cmstr nil t)
9068 (move-marker org-clock-marker (point))))
9069 (message "Sorting entries...done")))
9071 ;;; The orgstruct minor mode
9073 ;; Define a minor mode which can be used in other modes in order to
9074 ;; integrate the org-mode structure editing commands.
9076 ;; This is really a hack, because the org-mode structure commands use
9077 ;; keys which normally belong to the major mode. Here is how it
9078 ;; works: The minor mode defines all the keys necessary to operate the
9079 ;; structure commands, but wraps the commands into a function which
9080 ;; tests if the cursor is currently at a headline or a plain list
9081 ;; item. If that is the case, the structure command is used,
9082 ;; temporarily setting many Org-mode variables like regular
9083 ;; expressions for filling etc. However, when any of those keys is
9084 ;; used at a different location, function uses `key-binding' to look
9085 ;; up if the key has an associated command in another currently active
9086 ;; keymap (minor modes, major mode, global), and executes that
9087 ;; command. There might be problems if any of the keys is otherwise
9088 ;; used as a prefix key.
9090 (defcustom orgstruct-heading-prefix-regexp ""
9091 "Regexp that matches the custom prefix of Org headlines in
9092 orgstruct(++)-mode."
9093 :group 'org
9094 :version "24.4"
9095 :package-version '(Org . "8.3")
9096 :type 'regexp)
9097 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9099 (defcustom orgstruct-setup-hook nil
9100 "Hook run after orgstruct-mode-map is filled."
9101 :group 'org
9102 :version "24.4"
9103 :package-version '(Org . "8.0")
9104 :type 'hook)
9106 (defvar orgstruct-initialized nil)
9108 (defvar org-local-vars nil
9109 "List of local variables, for use by `orgstruct-mode'.")
9111 ;;;###autoload
9112 (define-minor-mode orgstruct-mode
9113 "Toggle the minor mode `orgstruct-mode'.
9114 This mode is for using Org-mode structure commands in other
9115 modes. The following keys behave as if Org-mode were active, if
9116 the cursor is on a headline, or on a plain list item (both as
9117 defined by Org-mode)."
9118 nil " OrgStruct" (make-sparse-keymap)
9119 (funcall (if orgstruct-mode
9120 'add-to-invisibility-spec
9121 'remove-from-invisibility-spec)
9122 '(outline . t))
9123 (when orgstruct-mode
9124 (org-load-modules-maybe)
9125 (unless orgstruct-initialized
9126 (orgstruct-setup)
9127 (setq orgstruct-initialized t))))
9129 ;;;###autoload
9130 (defun turn-on-orgstruct ()
9131 "Unconditionally turn on `orgstruct-mode'."
9132 (orgstruct-mode 1))
9134 (defvar org-fb-vars nil)
9135 (make-variable-buffer-local 'org-fb-vars)
9136 (defun orgstruct++-mode (&optional arg)
9137 "Toggle `orgstruct-mode', the enhanced version of it.
9138 In addition to setting orgstruct-mode, this also exports all
9139 indentation and autofilling variables from org-mode into the
9140 buffer. It will also recognize item context in multiline items."
9141 (interactive "P")
9142 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9143 (if (< arg 1)
9144 (progn (orgstruct-mode -1)
9145 (mapc (lambda(v)
9146 (org-set-local (car v)
9147 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9148 org-fb-vars))
9149 (orgstruct-mode 1)
9150 (setq org-fb-vars nil)
9151 (unless org-local-vars
9152 (setq org-local-vars (org-get-local-variables)))
9153 (let (var val)
9154 (mapc
9155 (lambda (x)
9156 (when (string-match
9157 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9158 (symbol-name (car x)))
9159 (setq var (car x) val (nth 1 x))
9160 (push (list var `(quote ,(eval var))) org-fb-vars)
9161 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9162 org-local-vars)
9163 (org-set-local 'orgstruct-is-++ t))))
9165 (defvar orgstruct-is-++ nil
9166 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9167 (make-variable-buffer-local 'orgstruct-is-++)
9169 ;;;###autoload
9170 (defun turn-on-orgstruct++ ()
9171 "Unconditionally turn on `orgstruct++-mode'."
9172 (orgstruct++-mode 1))
9174 (defun orgstruct-error ()
9175 "Error when there is no default binding for a structure key."
9176 (interactive)
9177 (funcall (if (fboundp 'user-error)
9178 'user-error
9179 'error)
9180 "This key has no function outside structure elements"))
9182 (defun orgstruct-setup ()
9183 "Setup orgstruct keymap."
9184 (dolist (cell '((org-demote . t)
9185 (org-metaleft . t)
9186 (org-metaright . t)
9187 (org-promote . t)
9188 (org-shiftmetaleft . t)
9189 (org-shiftmetaright . t)
9190 org-backward-element
9191 org-backward-heading-same-level
9192 org-ctrl-c-ret
9193 org-ctrl-c-minus
9194 org-ctrl-c-star
9195 org-cycle
9196 org-forward-heading-same-level
9197 org-insert-heading
9198 org-insert-heading-respect-content
9199 org-kill-note-or-show-branches
9200 org-mark-subtree
9201 org-meta-return
9202 org-metadown
9203 org-metaup
9204 org-narrow-to-subtree
9205 org-promote-subtree
9206 org-reveal
9207 org-shiftdown
9208 org-shiftleft
9209 org-shiftmetadown
9210 org-shiftmetaup
9211 org-shiftright
9212 org-shifttab
9213 org-shifttab
9214 org-shiftup
9215 org-show-subtree
9216 org-sort
9217 org-up-element
9218 outline-demote
9219 outline-next-visible-heading
9220 outline-previous-visible-heading
9221 outline-promote
9222 outline-up-heading
9223 show-children))
9224 (let ((f (or (car-safe cell) cell))
9225 (disable-when-heading-prefix (cdr-safe cell)))
9226 (when (fboundp f)
9227 (let ((new-bindings))
9228 (dolist (binding (nconc (where-is-internal f org-mode-map)
9229 (where-is-internal f outline-mode-map)))
9230 (push binding new-bindings)
9231 ;; TODO use local-function-key-map
9232 (dolist (rep '(("<tab>" . "TAB")
9233 ("<return>" . "RET")
9234 ("<escape>" . "ESC")
9235 ("<delete>" . "DEL")))
9236 (setq binding (read-kbd-macro
9237 (let ((case-fold-search))
9238 (replace-regexp-in-string
9239 (regexp-quote (cdr rep))
9240 (car rep)
9241 (key-description binding)))))
9242 (pushnew binding new-bindings :test 'equal)))
9243 (dolist (binding new-bindings)
9244 (let ((key (lookup-key orgstruct-mode-map binding)))
9245 (when (or (not key) (numberp key))
9246 (ignore-errors
9247 (org-defkey orgstruct-mode-map
9248 binding
9249 (orgstruct-make-binding
9250 f binding disable-when-heading-prefix))))))))))
9251 (run-hooks 'orgstruct-setup-hook))
9253 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9254 "Create a function for binding in the structure minor mode.
9255 FUN is the command to call inside a table. KEY is the key that
9256 should be checked in for a command to execute outside of tables.
9257 Non-nil `disable-when-heading-prefix' means to disable the command
9258 if `orgstruct-heading-prefix-regexp' is not empty."
9259 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9260 (let ((nname name)
9261 (i 0))
9262 (while (fboundp (intern nname))
9263 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9264 (setq name (intern nname)))
9265 (eval
9266 (let ((bindings '((org-heading-regexp
9267 (concat "^"
9268 orgstruct-heading-prefix-regexp
9269 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9270 (org-outline-regexp
9271 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9272 (org-outline-regexp-bol
9273 (concat "^" org-outline-regexp))
9274 (outline-regexp org-outline-regexp)
9275 (outline-heading-end-regexp "\n")
9276 (outline-level 'org-outline-level)
9277 (outline-heading-alist))))
9278 `(defun ,name (arg)
9279 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9280 "Outside of structure, run the binding of `"
9281 (key-description key) "'."
9282 (when disable-when-heading-prefix
9283 (concat
9284 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9285 "back to the default binding due to limitations of Org's implementation of\n"
9286 "`" (symbol-name fun) "'.")))
9287 (interactive "p")
9288 (let* ((disable
9289 ,(and disable-when-heading-prefix
9290 '(not (string= orgstruct-heading-prefix-regexp ""))))
9291 (fallback
9292 (or disable
9293 (not
9294 (let* ,bindings
9295 (org-context-p 'headline 'item
9296 ,(when (memq fun
9297 '(org-insert-heading
9298 org-insert-heading-respect-content
9299 org-meta-return))
9300 '(when orgstruct-is-++
9301 'item-body))))))))
9302 (if fallback
9303 (let* ((orgstruct-mode)
9304 (binding
9305 (let ((key ,key))
9306 (catch 'exit
9307 (dolist
9308 (rep
9309 '(nil
9310 ("<\\([^>]*\\)tab>" . "\\1TAB")
9311 ("<\\([^>]*\\)return>" . "\\1RET")
9312 ("<\\([^>]*\\)escape>" . "\\1ESC")
9313 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9314 nil)
9315 (when rep
9316 (setq key (read-kbd-macro
9317 (let ((case-fold-search))
9318 (replace-regexp-in-string
9319 (car rep)
9320 (cdr rep)
9321 (key-description key))))))
9322 (when (key-binding key)
9323 (throw 'exit (key-binding key))))))))
9324 (if (keymapp binding)
9325 (org-set-transient-map binding)
9326 (let ((func (or binding
9327 (unless disable
9328 'orgstruct-error))))
9329 (when func
9330 (call-interactively func)))))
9331 (org-run-like-in-org-mode
9332 (lambda ()
9333 (interactive)
9334 (let* ,bindings
9335 (call-interactively ',fun)))))))))
9336 name))
9338 (defun org-contextualize-keys (alist contexts)
9339 "Return valid elements in ALIST depending on CONTEXTS.
9341 `org-agenda-custom-commands' or `org-capture-templates' are the
9342 values used for ALIST, and `org-agenda-custom-commands-contexts'
9343 or `org-capture-templates-contexts' are the associated contexts
9344 definitions."
9345 (let ((contexts
9346 ;; normalize contexts
9347 (mapcar
9348 (lambda(c) (cond ((listp (cadr c))
9349 (list (car c) (car c) (cadr c)))
9350 ((string= "" (cadr c))
9351 (list (car c) (car c) (caddr c)))
9352 (t c))) contexts))
9353 (a alist) c r s)
9354 ;; loop over all commands or templates
9355 (while (setq c (pop a))
9356 (let (vrules repl)
9357 (cond
9358 ((not (assoc (car c) contexts))
9359 (push c r))
9360 ((and (assoc (car c) contexts)
9361 (setq vrules (org-contextualize-validate-key
9362 (car c) contexts)))
9363 (mapc (lambda (vr)
9364 (when (not (equal (car vr) (cadr vr)))
9365 (setq repl vr))) vrules)
9366 (if (not repl) (push c r)
9367 (push (cadr repl) s)
9368 (push
9369 (cons (car c)
9370 (cdr (or (assoc (cadr repl) alist)
9371 (error "Undefined key `%s' as contextual replacement for `%s'"
9372 (cadr repl) (car c)))))
9373 r))))))
9374 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9375 (delq
9377 (delete-dups
9378 (mapcar (lambda (x)
9379 (let ((tpl (car x)))
9380 (when (not (delq
9382 (mapcar (lambda(y)
9383 (equal y tpl)) s))) x)))
9384 (reverse r))))))
9386 (defun org-contextualize-validate-key (key contexts)
9387 "Check CONTEXTS for agenda or capture KEY."
9388 (let (r rr res)
9389 (while (setq r (pop contexts))
9390 (mapc
9391 (lambda (rr)
9392 (when
9393 (and (equal key (car r))
9394 (if (functionp rr) (funcall rr)
9395 (or (and (eq (car rr) 'in-file)
9396 (buffer-file-name)
9397 (string-match (cdr rr) (buffer-file-name)))
9398 (and (eq (car rr) 'in-mode)
9399 (string-match (cdr rr) (symbol-name major-mode)))
9400 (and (eq (car rr) 'in-buffer)
9401 (string-match (cdr rr) (buffer-name)))
9402 (when (and (eq (car rr) 'not-in-file)
9403 (buffer-file-name))
9404 (not (string-match (cdr rr) (buffer-file-name))))
9405 (when (eq (car rr) 'not-in-mode)
9406 (not (string-match (cdr rr) (symbol-name major-mode))))
9407 (when (eq (car rr) 'not-in-buffer)
9408 (not (string-match (cdr rr) (buffer-name)))))))
9409 (push r res)))
9410 (car (last r))))
9411 (delete-dups (delq nil res))))
9413 (defun org-context-p (&rest contexts)
9414 "Check if local context is any of CONTEXTS.
9415 Possible values in the list of contexts are `table', `headline', and `item'."
9416 (let ((pos (point)))
9417 (goto-char (point-at-bol))
9418 (prog1 (or (and (memq 'table contexts)
9419 (looking-at "[ \t]*|"))
9420 (and (memq 'headline contexts)
9421 (looking-at org-outline-regexp))
9422 (and (memq 'item contexts)
9423 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9424 (and (memq 'item-body contexts)
9425 (org-in-item-p)))
9426 (goto-char pos))))
9428 (defun org-get-local-variables ()
9429 "Return a list of all local variables in an Org mode buffer."
9430 (let (varlist)
9431 (with-current-buffer (get-buffer-create "*Org tmp*")
9432 (erase-buffer)
9433 (org-mode)
9434 (setq varlist (buffer-local-variables)))
9435 (kill-buffer "*Org tmp*")
9436 (delq nil
9437 (mapcar
9438 (lambda (x)
9439 (setq x
9440 (if (symbolp x)
9441 (list x)
9442 (list (car x) (cdr x))))
9443 (if (and (not (get (car x) 'org-state))
9444 (string-match
9445 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9446 (symbol-name (car x))))
9447 x nil))
9448 varlist))))
9450 (defun org-clone-local-variables (from-buffer &optional regexp)
9451 "Clone local variables from FROM-BUFFER.
9452 Optional argument REGEXP selects variables to clone."
9453 (mapc
9454 (lambda (pair)
9455 (and (symbolp (car pair))
9456 (or (null regexp)
9457 (string-match regexp (symbol-name (car pair))))
9458 (set (make-local-variable (car pair))
9459 (cdr pair))))
9460 (buffer-local-variables from-buffer)))
9462 ;;;###autoload
9463 (defun org-run-like-in-org-mode (cmd)
9464 "Run a command, pretending that the current buffer is in Org-mode.
9465 This will temporarily bind local variables that are typically bound in
9466 Org-mode to the values they have in Org-mode, and then interactively
9467 call CMD."
9468 (org-load-modules-maybe)
9469 (unless org-local-vars
9470 (setq org-local-vars (org-get-local-variables)))
9471 (let (binds)
9472 (dolist (var org-local-vars)
9473 (when (or (not (boundp (car var)))
9474 (eq (symbol-value (car var))
9475 (default-value (car var))))
9476 (push (list (car var) `(quote ,(cadr var))) binds)))
9477 (eval `(let ,binds
9478 (call-interactively (quote ,cmd))))))
9480 (defun org-get-category (&optional pos force-refresh)
9481 "Get the category applying to position POS."
9482 (save-match-data
9483 (if force-refresh (org-refresh-category-properties))
9484 (let ((pos (or pos (point))))
9485 (or (get-text-property pos 'org-category)
9486 (progn (org-refresh-category-properties)
9487 (get-text-property pos 'org-category))))))
9489 ;;; Refresh properties
9491 (defun org-refresh-properties (dprop tprop)
9492 "Refresh buffer text properties.
9493 DPROP is the drawer property and TPROP is either the
9494 corresponding text property to set, or an alist with each element
9495 being a text property (as a symbol) and a function to apply to
9496 the value of the drawer property."
9497 (let ((case-fold-search t)
9498 (inhibit-read-only t))
9499 (org-with-silent-modifications
9500 (save-excursion
9501 (save-restriction
9502 (widen)
9503 (goto-char (point-min))
9504 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9505 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9507 (defun org-refresh-property (tprop p)
9508 "Refresh the buffer text property TPROP from the drawer property P.
9509 The refresh happens only for the current tree (not subtree)."
9510 (save-excursion
9511 (org-back-to-heading t)
9512 ;; tprop is a text property symbol
9513 (if (symbolp tprop)
9514 (put-text-property
9515 (point) (or (outline-next-heading) (point-max)) tprop p)
9516 ;; tprop is an alist with (properties . function) elements
9517 (mapc (lambda(al)
9518 (save-excursion
9519 (put-text-property
9520 (point-at-bol) (or (outline-next-heading) (point-max))
9521 (car al)
9522 (funcall (cdr al) p))))
9523 tprop))))
9525 (defun org-refresh-category-properties ()
9526 "Refresh category text properties in the buffer."
9527 (let ((case-fold-search t)
9528 (inhibit-read-only t)
9529 (def-cat (cond
9530 ((null org-category)
9531 (if buffer-file-name
9532 (file-name-sans-extension
9533 (file-name-nondirectory buffer-file-name))
9534 "???"))
9535 ((symbolp org-category) (symbol-name org-category))
9536 (t org-category)))
9537 beg end cat pos optionp)
9538 (org-with-silent-modifications
9539 (save-excursion
9540 (save-restriction
9541 (widen)
9542 (goto-char (point-min))
9543 (put-text-property (point) (point-max) 'org-category def-cat)
9544 (while (re-search-forward
9545 "^[ \t]*\\(\\(?:#\\+\\|:\\)CATEGORY:\\)\\(.*\\)" nil t)
9546 (setq pos (match-end 0)
9547 optionp (equal (char-after (match-beginning 0)) ?#)
9548 cat (org-trim (match-string 2)))
9549 (if optionp
9550 (setq beg (point-at-bol) end (point-max))
9551 (org-back-to-heading t)
9552 (setq beg (point) end (org-end-of-subtree t t)))
9553 (put-text-property beg end 'org-category cat)
9554 (goto-char pos)))))))
9556 (defun org-refresh-stats-properties ()
9557 "Refresh stats text properties in the buffer."
9558 (let (stats)
9559 (org-with-silent-modifications
9560 (save-excursion
9561 (save-restriction
9562 (widen)
9563 (goto-char (point-min))
9564 (while (re-search-forward
9565 (concat org-outline-regexp-bol ".*"
9566 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9567 nil t)
9568 (setq stats (cond ((equal (match-string 3) "0") 0)
9569 ((match-string 2)
9570 (/ (* (string-to-number (match-string 2)) 100)
9571 (string-to-number (match-string 3))))
9572 (t (string-to-number (match-string 1)))))
9573 (org-back-to-heading t)
9574 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9575 'org-stats stats)))))))
9577 (defun org-refresh-effort-properties ()
9578 "Refresh effort properties"
9579 (org-refresh-properties
9580 org-effort-property
9581 '((effort . identity)
9582 (effort-minutes . org-duration-string-to-minutes))))
9584 ;;;; Link Stuff
9586 ;;; Link abbreviations
9588 (defun org-link-expand-abbrev (link)
9589 "Apply replacements as defined in `org-link-abbrev-alist'."
9590 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9591 (let* ((key (match-string 1 link))
9592 (as (or (assoc key org-link-abbrev-alist-local)
9593 (assoc key org-link-abbrev-alist)))
9594 (tag (and (match-end 2) (match-string 3 link)))
9595 rpl)
9596 (if (not as)
9597 link
9598 (setq rpl (cdr as))
9599 (cond
9600 ((symbolp rpl) (funcall rpl tag))
9601 ((string-match "%(\\([^)]+\\))" rpl)
9602 (replace-match
9603 (save-match-data
9604 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9605 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9606 ((string-match "%h" rpl)
9607 (replace-match (url-hexify-string (or tag "")) t t rpl))
9608 (t (concat rpl tag)))))
9609 link))
9611 ;;; Storing and inserting links
9613 (defvar org-insert-link-history nil
9614 "Minibuffer history for links inserted with `org-insert-link'.")
9616 (defvar org-stored-links nil
9617 "Contains the links stored with `org-store-link'.")
9619 (defvar org-store-link-plist nil
9620 "Plist with info about the most recently link created with `org-store-link'.")
9622 (defvar org-link-protocols nil
9623 "Link protocols added to Org-mode using `org-add-link-type'.")
9625 (defvar org-store-link-functions nil
9626 "List of functions that are called to create and store a link.
9627 Each function will be called in turn until one returns a non-nil
9628 value. Each function should check if it is responsible for creating
9629 this link (for example by looking at the major mode).
9630 If not, it must exit and return nil.
9631 If yes, it should return a non-nil value after a calling
9632 `org-store-link-props' with a list of properties and values.
9633 Special properties are:
9635 :type The link prefix, like \"http\". This must be given.
9636 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9637 This is obligatory as well.
9638 :description Optional default description for the second pair
9639 of brackets in an Org-mode link. The user can still change
9640 this when inserting this link into an Org-mode buffer.
9642 In addition to these, any additional properties can be specified
9643 and then used in capture templates.")
9645 (defun org-add-link-type (type &optional follow export)
9646 "Add TYPE to the list of `org-link-types'.
9647 Re-compute all regular expressions depending on `org-link-types'
9649 FOLLOW and EXPORT are two functions.
9651 FOLLOW should take the link path as the single argument and do whatever
9652 is necessary to follow the link, for example find a file or display
9653 a mail message.
9655 EXPORT should format the link path for export to one of the export formats.
9656 It should be a function accepting three arguments:
9658 path the path of the link, the text after the prefix (like \"http:\")
9659 desc the description of the link, if any
9660 format the export format, a symbol like `html' or `latex' or `ascii'.
9662 The function may use the FORMAT information to return different values
9663 depending on the format. The return value will be put literally into
9664 the exported file. If the return value is nil, this means Org should
9665 do what it normally does with links which do not have EXPORT defined.
9667 Org mode has a built-in default for exporting links. If you are happy with
9668 this default, there is no need to define an export function for the link
9669 type. For a simple example of an export function, see `org-bbdb.el'."
9670 (add-to-list 'org-link-types type t)
9671 (org-make-link-regexps)
9672 (org-element-update-syntax)
9673 (if (assoc type org-link-protocols)
9674 (setcdr (assoc type org-link-protocols) (list follow export))
9675 (push (list type follow export) org-link-protocols)))
9677 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9678 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9680 ;;;###autoload
9681 (defun org-store-link (arg)
9682 "\\<org-mode-map>Store an org-link to the current location.
9683 This link is added to `org-stored-links' and can later be inserted
9684 into an org-buffer with \\[org-insert-link].
9686 For some link types, a prefix arg is interpreted.
9687 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9688 For file links, arg negates `org-context-in-file-links'.
9690 A double prefix arg force skipping storing functions that are not
9691 part of Org's core.
9693 A triple prefix arg force storing a link for each line in the
9694 active region."
9695 (interactive "P")
9696 (org-load-modules-maybe)
9697 (if (and (equal arg '(64)) (org-region-active-p))
9698 (save-excursion
9699 (let ((end (region-end)))
9700 (goto-char (region-beginning))
9701 (set-mark (point))
9702 (while (< (point-at-eol) end)
9703 (move-end-of-line 1) (activate-mark)
9704 (let (current-prefix-arg)
9705 (call-interactively 'org-store-link))
9706 (move-beginning-of-line 2)
9707 (set-mark (point)))))
9708 (org-with-limited-levels
9709 (setq org-store-link-plist nil)
9710 (let (link cpltxt desc description search
9711 txt custom-id agenda-link sfuns sfunsn)
9712 (cond
9714 ;; Store a link using an external link type
9715 ((and (not (equal arg '(16)))
9716 (setq sfuns
9717 (delq
9718 nil (mapcar (lambda (f)
9719 (let (fs) (if (funcall f) (push f fs))))
9720 org-store-link-functions))
9721 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9722 (or (and (cdr sfuns)
9723 (funcall (intern
9724 (completing-read
9725 "Which function for creating the link? "
9726 sfunsn nil t (car sfunsn)))))
9727 (funcall (caar sfuns)))
9728 (setq link (plist-get org-store-link-plist :link)
9729 desc (or (plist-get org-store-link-plist
9730 :description) link))))
9732 ;; Store a link from a source code buffer
9733 ((org-src-edit-buffer-p)
9734 (let (label gc)
9735 (while (or (not label)
9736 (save-excursion
9737 (save-restriction
9738 (widen)
9739 (goto-char (point-min))
9740 (re-search-forward
9741 (regexp-quote (format org-coderef-label-format label))
9742 nil t))))
9743 (when label (message "Label exists already") (sit-for 2))
9744 (setq label (read-string "Code line label: " label)))
9745 (end-of-line 1)
9746 (setq link (format org-coderef-label-format label))
9747 (setq gc (- 79 (length link)))
9748 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9749 (insert link)
9750 (setq link (concat "(" label ")") desc nil)))
9752 ;; We are in the agenda, link to referenced location
9753 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9754 (let ((m (or (get-text-property (point) 'org-hd-marker)
9755 (get-text-property (point) 'org-marker))))
9756 (when m
9757 (org-with-point-at m
9758 (setq agenda-link
9759 (if (org-called-interactively-p 'any)
9760 (call-interactively 'org-store-link)
9761 (org-store-link nil)))))))
9763 ((eq major-mode 'calendar-mode)
9764 (let ((cd (calendar-cursor-to-date)))
9765 (setq link
9766 (format-time-string
9767 (car org-time-stamp-formats)
9768 (apply 'encode-time
9769 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9770 nil nil nil))))
9771 (org-store-link-props :type "calendar" :date cd)))
9773 ((eq major-mode 'help-mode)
9774 (setq link (concat "help:" (save-excursion
9775 (goto-char (point-min))
9776 (looking-at "^[^ ]+")
9777 (match-string 0))))
9778 (org-store-link-props :type "help"))
9780 ((eq major-mode 'w3-mode)
9781 (setq cpltxt (if (and (buffer-name)
9782 (not (string-match "Untitled" (buffer-name))))
9783 (buffer-name)
9784 (url-view-url t))
9785 link (url-view-url t))
9786 (org-store-link-props :type "w3" :url (url-view-url t)))
9788 ((eq major-mode 'image-mode)
9789 (setq cpltxt (concat "file:"
9790 (abbreviate-file-name buffer-file-name))
9791 link cpltxt)
9792 (org-store-link-props :type "image" :file buffer-file-name))
9794 ;; In dired, store a link to the file of the current line
9795 ((derived-mode-p 'dired-mode)
9796 (let ((file (dired-get-filename nil t)))
9797 (setq file (if file
9798 (abbreviate-file-name
9799 (expand-file-name (dired-get-filename nil t)))
9800 ;; otherwise, no file so use current directory.
9801 default-directory))
9802 (setq cpltxt (concat "file:" file)
9803 link cpltxt)))
9805 ((setq search (run-hook-with-args-until-success
9806 'org-create-file-search-functions))
9807 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9808 "::" search))
9809 (setq cpltxt (or description link)))
9811 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9812 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9813 (cond
9814 ;; Store a link using the target at point
9815 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9816 (setq cpltxt
9817 (concat "file:"
9818 (abbreviate-file-name
9819 (buffer-file-name (buffer-base-buffer)))
9820 "::" (match-string 1))
9821 link cpltxt))
9822 ((and (featurep 'org-id)
9823 (or (eq org-id-link-to-org-use-id t)
9824 (and (org-called-interactively-p 'any)
9825 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9826 (and (eq org-id-link-to-org-use-id
9827 'create-if-interactive-and-no-custom-id)
9828 (not custom-id))))
9829 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9830 ;; Store a link using the ID at point
9831 (setq link (condition-case nil
9832 (prog1 (org-id-store-link)
9833 (setq desc (or (plist-get org-store-link-plist
9834 :description)
9835 "")))
9836 (error
9837 ;; Probably before first headline, link only to file
9838 (concat "file:"
9839 (abbreviate-file-name
9840 (buffer-file-name (buffer-base-buffer))))))))
9842 ;; Just link to current headline
9843 (setq cpltxt (concat "file:"
9844 (abbreviate-file-name
9845 (buffer-file-name (buffer-base-buffer)))))
9846 ;; Add a context search string
9847 (when (org-xor org-context-in-file-links arg)
9848 (let* ((ee (org-element-at-point))
9849 (et (org-element-type ee))
9850 (ev (plist-get (cadr ee) :value))
9851 (ek (plist-get (cadr ee) :key))
9852 (eok (and (stringp ek) (string-match "name" ek))))
9853 (setq txt (cond
9854 ((org-at-heading-p) nil)
9855 ((and (eq et 'keyword) eok) ev)
9856 ((org-region-active-p)
9857 (buffer-substring (region-beginning) (region-end)))))
9858 (when (or (null txt) (string-match "\\S-" txt))
9859 (setq cpltxt
9860 (concat cpltxt "::"
9861 (condition-case nil
9862 (org-make-org-heading-search-string txt)
9863 (error "")))
9864 desc (or (and (eq et 'keyword) eok ev)
9865 (nth 4 (ignore-errors (org-heading-components)))
9866 "NONE")))))
9867 (if (string-match "::\\'" cpltxt)
9868 (setq cpltxt (substring cpltxt 0 -2)))
9869 (setq link cpltxt))))
9871 ((buffer-file-name (buffer-base-buffer))
9872 ;; Just link to this file here.
9873 (setq cpltxt (concat "file:"
9874 (abbreviate-file-name
9875 (buffer-file-name (buffer-base-buffer)))))
9876 ;; Add a context string.
9877 (when (org-xor org-context-in-file-links arg)
9878 (setq txt (if (org-region-active-p)
9879 (buffer-substring (region-beginning) (region-end))
9880 (buffer-substring (point-at-bol) (point-at-eol))))
9881 ;; Only use search option if there is some text.
9882 (when (string-match "\\S-" txt)
9883 (setq cpltxt
9884 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9885 desc "NONE")))
9886 (setq link cpltxt))
9888 ((org-called-interactively-p 'interactive)
9889 (user-error "No method for storing a link from this buffer"))
9891 (t (setq link nil)))
9893 ;; We're done setting link and desc, clean up
9894 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9895 (setq link (or link cpltxt)
9896 desc (or desc cpltxt))
9897 (cond ((equal desc "NONE") (setq desc nil))
9898 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9899 (let ((d0 (match-string 3 desc))
9900 (p0 (match-string 5 desc)))
9901 (setq desc
9902 (replace-regexp-in-string
9903 org-bracket-link-regexp
9904 (concat (or p0 d0)
9905 (if (equal (length (match-string 0 desc))
9906 (length desc)) "*" "")) desc)))))
9908 ;; Return the link
9909 (if (not (and (or (org-called-interactively-p 'any)
9910 executing-kbd-macro) link))
9911 (or agenda-link (and link (org-make-link-string link desc)))
9912 (push (list link desc) org-stored-links)
9913 (message "Stored: %s" (or desc link))
9914 (when custom-id
9915 (setq link (concat "file:" (abbreviate-file-name
9916 (buffer-file-name)) "::#" custom-id))
9917 (push (list link desc) org-stored-links))
9918 (car org-stored-links))))))
9920 (defun org-store-link-props (&rest plist)
9921 "Store link properties, extract names and addresses."
9922 (let (x adr)
9923 (when (setq x (plist-get plist :from))
9924 (setq adr (mail-extract-address-components x))
9925 (setq plist (plist-put plist :fromname (car adr)))
9926 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9927 (when (setq x (plist-get plist :to))
9928 (setq adr (mail-extract-address-components x))
9929 (setq plist (plist-put plist :toname (car adr)))
9930 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9931 (let ((from (plist-get plist :from))
9932 (to (plist-get plist :to)))
9933 (when (and from to org-from-is-user-regexp)
9934 (setq plist
9935 (plist-put plist :fromto
9936 (if (string-match org-from-is-user-regexp from)
9937 (concat "to %t")
9938 (concat "from %f"))))))
9939 (setq org-store-link-plist plist))
9941 (defun org-add-link-props (&rest plist)
9942 "Add these properties to the link property list."
9943 (let (key value)
9944 (while plist
9945 (setq key (pop plist) value (pop plist))
9946 (setq org-store-link-plist
9947 (plist-put org-store-link-plist key value)))))
9949 (defun org-email-link-description (&optional fmt)
9950 "Return the description part of an email link.
9951 This takes information from `org-store-link-plist' and formats it
9952 according to FMT (default from `org-email-link-description-format')."
9953 (setq fmt (or fmt org-email-link-description-format))
9954 (let* ((p org-store-link-plist)
9955 (to (plist-get p :toaddress))
9956 (from (plist-get p :fromaddress))
9957 (table
9958 (list
9959 (cons "%c" (plist-get p :fromto))
9960 (cons "%F" (plist-get p :from))
9961 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9962 (cons "%T" (plist-get p :to))
9963 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9964 (cons "%s" (plist-get p :subject))
9965 (cons "%d" (plist-get p :date))
9966 (cons "%m" (plist-get p :message-id)))))
9967 (when (string-match "%c" fmt)
9968 ;; Check if the user wrote this message
9969 (if (and org-from-is-user-regexp from to
9970 (save-match-data (string-match org-from-is-user-regexp from)))
9971 (setq fmt (replace-match "to %t" t t fmt))
9972 (setq fmt (replace-match "from %f" t t fmt))))
9973 (org-replace-escapes fmt table)))
9975 (defun org-make-org-heading-search-string (&optional string)
9976 "Make search string for the current headline or STRING."
9977 (let ((s (or string
9978 (and (derived-mode-p 'org-mode)
9979 (save-excursion
9980 (org-back-to-heading t)
9981 (org-element-property :raw-value (org-element-at-point))))))
9982 (lines org-context-in-file-links))
9983 (or string (setq s (concat "*" s))) ; Add * for headlines
9984 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9985 (when (and string (integerp lines) (> lines 0))
9986 (let ((slines (org-split-string s "\n")))
9987 (when (< lines (length slines))
9988 (setq s (mapconcat
9989 'identity
9990 (reverse (nthcdr (- (length slines) lines)
9991 (reverse slines))) "\n")))))
9992 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9994 (defun org-make-link-string (link &optional description)
9995 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9996 (unless (string-match "\\S-" link)
9997 (error "Empty link"))
9998 (when (and description
9999 (stringp description)
10000 (not (string-match "\\S-" description)))
10001 (setq description nil))
10002 (when (stringp description)
10003 ;; Remove brackets from the description, they are fatal.
10004 (while (string-match "\\[" description)
10005 (setq description (replace-match "{" t t description)))
10006 (while (string-match "\\]" description)
10007 (setq description (replace-match "}" t t description))))
10008 (when (equal link description)
10009 ;; No description needed, it is identical
10010 (setq description nil))
10011 (when (and (not description)
10012 (not (string-match (org-image-file-name-regexp) link))
10013 (not (equal link (org-link-escape link))))
10014 (setq description (org-extract-attributes link)))
10015 (setq link
10016 (cond ((string-match (org-image-file-name-regexp) link) link)
10017 ((string-match org-link-types-re link)
10018 (concat (match-string 1 link)
10019 (org-link-escape (substring link (match-end 1)))))
10020 (t (org-link-escape link))))
10021 (concat "[[" link "]"
10022 (if description (concat "[" description "]") "")
10023 "]"))
10025 (defconst org-link-escape-chars
10026 ;;%20 %5B %5D
10027 '(?\ ?\[ ?\])
10028 "List of characters that should be escaped in a link when stored to Org.
10029 This is the list that is used for internal purposes.")
10031 (defconst org-link-escape-chars-browser
10032 ;;%20 %22
10033 '(?\ ?\")
10034 "List of characters to be escaped before handing over to the browser.
10035 If you consider using this constant then you probably want to use
10036 the function `org-link-escape-browser' instead. See there why
10037 this constant is a candidate to be removed once Org drops support
10038 for Emacs 24.1 and 24.2.")
10040 (defun org-link-escape (text &optional table merge)
10041 "Return percent escaped representation of TEXT.
10042 TEXT is a string with the text to escape.
10043 Optional argument TABLE is a list with characters that should be
10044 escaped. When nil, `org-link-escape-chars' is used.
10045 If optional argument MERGE is set, merge TABLE into
10046 `org-link-escape-chars'."
10047 ;; Don't escape chars in internal links
10048 (if (string-match "^\\*[[:alnum:]]+" text)
10049 text
10050 (cond
10051 ((and table merge)
10052 (mapc (lambda (defchr)
10053 (unless (member defchr table)
10054 (setq table (cons defchr table))))
10055 org-link-escape-chars))
10056 ((null table)
10057 (setq table org-link-escape-chars)))
10058 (mapconcat
10059 (lambda (char)
10060 (if (or (member char table)
10061 (and (or (< char 32) (= char ?\%) (> char 126))
10062 org-url-hexify-p))
10063 (mapconcat (lambda (sequence-element)
10064 (format "%%%.2X" sequence-element))
10065 (or (encode-coding-char char 'utf-8)
10066 (error "Unable to percent escape character: %s"
10067 (char-to-string char))) "")
10068 (char-to-string char))) text "")))
10070 (defun org-link-escape-browser (text)
10071 "Escape some characters before handing over to the browser.
10072 This function is a candidate to be removed together with the
10073 constant `org-link-escape-chars-browser' once Org drops support
10074 for Emacs 24.1 and 24.2. All calls to this function will have to
10075 be replaced with `url-encode-url' which is available since Emacs
10076 24.3.1."
10077 ;; Example with the Org link
10078 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10079 ;; to open the browser with +subject:"Release 8.2" filled into the
10080 ;; query field: In this case the variable TEXT contains the
10081 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10082 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10083 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10084 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10085 (if (fboundp 'url-encode-url)
10086 (url-encode-url text)
10087 (if (org-string-match-p
10088 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10089 text)
10090 (org-link-escape text org-link-escape-chars-browser)
10091 text)))
10093 (defun org-link-unescape (str)
10094 "Unhex hexified Unicode strings as returned from the JavaScript function
10095 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10096 (unless (and (null str) (string= "" str))
10097 (let ((pos 0) (case-fold-search t) unhexed)
10098 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10099 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10100 (setq str (replace-match unhexed t t str))
10101 (setq pos (+ pos (length unhexed))))))
10102 str)
10104 (defun org-link-unescape-compound (hex)
10105 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10106 Note: this function also decodes single byte encodings like
10107 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10108 (save-match-data
10109 (let* ((bytes (cdr (split-string hex "%")))
10110 (ret "")
10111 (eat 0)
10112 (sum 0))
10113 (while bytes
10114 (let* ((val (string-to-number (pop bytes) 16))
10115 (shift-xor
10116 (if (= 0 eat)
10117 (cond
10118 ((>= val 252) (cons 6 252))
10119 ((>= val 248) (cons 5 248))
10120 ((>= val 240) (cons 4 240))
10121 ((>= val 224) (cons 3 224))
10122 ((>= val 192) (cons 2 192))
10123 (t (cons 0 0)))
10124 (cons 6 128))))
10125 (if (>= val 192) (setq eat (car shift-xor)))
10126 (setq val (logxor val (cdr shift-xor)))
10127 (setq sum (+ (lsh sum (car shift-xor)) val))
10128 (if (> eat 0) (setq eat (- eat 1)))
10129 (cond
10130 ((= 0 eat) ;multi byte
10131 (setq ret (concat ret (org-char-to-string sum)))
10132 (setq sum 0))
10133 ((not bytes) ; single byte(s)
10134 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10135 ret)))
10137 (defun org-link-unescape-single-byte-sequence (hex)
10138 "Unhexify hex-encoded single byte character sequences."
10139 (mapconcat (lambda (byte)
10140 (char-to-string (string-to-number byte 16)))
10141 (cdr (split-string hex "%")) ""))
10143 (defun org-xor (a b)
10144 "Exclusive or."
10145 (if a (not b) b))
10147 (defun org-fixup-message-id-for-http (s)
10148 "Replace special characters in a message id, so it can be used in an http query."
10149 (when (string-match "%" s)
10150 (setq s (mapconcat (lambda (c)
10151 (if (eq c ?%)
10152 "%25"
10153 (char-to-string c)))
10154 s "")))
10155 (while (string-match "<" s)
10156 (setq s (replace-match "%3C" t t s)))
10157 (while (string-match ">" s)
10158 (setq s (replace-match "%3E" t t s)))
10159 (while (string-match "@" s)
10160 (setq s (replace-match "%40" t t s)))
10163 (defun org-link-prettify (link)
10164 "Return a human-readable representation of LINK.
10165 The car of LINK must be a raw link.
10166 The cdr of LINK must be either a link description or nil."
10167 (let ((desc (or (cadr link) "<no description>")))
10168 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10169 "<" (car link) ">")))
10171 ;;;###autoload
10172 (defun org-insert-link-global ()
10173 "Insert a link like Org-mode does.
10174 This command can be called in any mode to insert a link in Org-mode syntax."
10175 (interactive)
10176 (org-load-modules-maybe)
10177 (org-run-like-in-org-mode 'org-insert-link))
10179 (defun org-insert-all-links (arg &optional pre post)
10180 "Insert all links in `org-stored-links'.
10181 When a universal prefix, do not delete the links from `org-stored-links'.
10182 When `ARG' is a number, insert the last N link(s).
10183 `PRE' and `POST' are optional arguments to define a string to
10184 prepend or to append."
10185 (interactive "P")
10186 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10187 (links (copy-seq org-stored-links))
10188 (pr (or pre "- "))
10189 (po (or post "\n"))
10190 (cnt 1) l)
10191 (if (null org-stored-links)
10192 (message "No link to insert")
10193 (while (and (or (listp arg) (>= arg cnt))
10194 (setq l (if (listp arg)
10195 (pop links)
10196 (pop org-stored-links))))
10197 (setq cnt (1+ cnt))
10198 (insert pr)
10199 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10200 (insert po)))))
10202 (defun org-insert-last-stored-link (arg)
10203 "Insert the last link stored in `org-stored-links'."
10204 (interactive "p")
10205 (org-insert-all-links arg "" "\n"))
10207 (defun org-link-fontify-links-to-this-file ()
10208 "Fontify links to the current file in `org-stored-links'."
10209 (let ((f (buffer-file-name)) a b)
10210 (setq a (mapcar (lambda(l)
10211 (let ((ll (car l)))
10212 (when (and (string-match "^file:\\(.+\\)::" ll)
10213 (equal f (expand-file-name (match-string 1 ll))))
10214 ll)))
10215 org-stored-links))
10216 (when (featurep 'org-id)
10217 (setq b (mapcar (lambda(l)
10218 (let ((ll (car l)))
10219 (when (and (string-match "^id:\\(.+\\)$" ll)
10220 (equal f (expand-file-name
10221 (or (org-id-find-id-file
10222 (match-string 1 ll)) ""))))
10223 ll)))
10224 org-stored-links)))
10225 (mapcar (lambda(l)
10226 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10227 (delq nil (append a b)))))
10229 (defvar org-link-links-in-this-file nil)
10230 (defun org-insert-link (&optional complete-file link-location default-description)
10231 "Insert a link. At the prompt, enter the link.
10233 Completion can be used to insert any of the link protocol prefixes like
10234 http or ftp in use.
10236 The history can be used to select a link previously stored with
10237 `org-store-link'. When the empty string is entered (i.e. if you just
10238 press RET at the prompt), the link defaults to the most recently
10239 stored link. As SPC triggers completion in the minibuffer, you need to
10240 use M-SPC or C-q SPC to force the insertion of a space character.
10242 You will also be prompted for a description, and if one is given, it will
10243 be displayed in the buffer instead of the link.
10245 If there is already a link at point, this command will allow you to edit link
10246 and description parts.
10248 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10249 be selected using completion. The path to the file will be relative to the
10250 current directory if the file is in the current directory or a subdirectory.
10251 Otherwise, the link will be the absolute path as completed in the minibuffer
10252 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10253 option `org-link-file-path-type'.
10255 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10256 the current directory or below.
10258 With three \\[universal-argument] prefixes, negate the meaning of
10259 `org-keep-stored-link-after-insertion'.
10261 If `org-make-link-description-function' is non-nil, this function will be
10262 called with the link target, and the result will be the default
10263 link description.
10265 If the LINK-LOCATION parameter is non-nil, this value will be
10266 used as the link location instead of reading one interactively.
10268 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10269 be used as the default description."
10270 (interactive "P")
10271 (let* ((wcf (current-window-configuration))
10272 (origbuf (current-buffer))
10273 (region (if (org-region-active-p)
10274 (buffer-substring (region-beginning) (region-end))))
10275 (remove (and region (list (region-beginning) (region-end))))
10276 (desc region)
10277 tmphist ; byte-compile incorrectly complains about this
10278 (link link-location)
10279 (abbrevs org-link-abbrev-alist-local)
10280 entry file all-prefixes auto-desc)
10281 (cond
10282 (link-location) ; specified by arg, just use it.
10283 ((org-in-regexp org-bracket-link-regexp 1)
10284 ;; We do have a link at point, and we are going to edit it.
10285 (setq remove (list (match-beginning 0) (match-end 0)))
10286 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10287 (setq link (read-string "Link: "
10288 (org-link-unescape
10289 (org-match-string-no-properties 1)))))
10290 ((or (org-in-regexp org-angle-link-re)
10291 (org-in-regexp org-plain-link-re))
10292 ;; Convert to bracket link
10293 (setq remove (list (match-beginning 0) (match-end 0))
10294 link (read-string "Link: "
10295 (org-remove-angle-brackets (match-string 0)))))
10296 ((member complete-file '((4) (16)))
10297 ;; Completing read for file names.
10298 (setq link (org-file-complete-link complete-file)))
10300 ;; Read link, with completion for stored links.
10301 (org-link-fontify-links-to-this-file)
10302 (org-switch-to-buffer-other-window "*Org Links*")
10303 (with-current-buffer "*Org Links*"
10304 (erase-buffer)
10305 (insert "Insert a link.
10306 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10307 (when org-stored-links
10308 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10309 (insert (mapconcat 'org-link-prettify
10310 (reverse org-stored-links) "\n")))
10311 (goto-char (point-min)))
10312 (let ((cw (selected-window)))
10313 (select-window (get-buffer-window "*Org Links*" 'visible))
10314 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10315 (unless (pos-visible-in-window-p (point-max))
10316 (org-fit-window-to-buffer))
10317 (and (window-live-p cw) (select-window cw)))
10318 ;; Fake a link history, containing the stored links.
10319 (setq tmphist (append (mapcar 'car org-stored-links)
10320 org-insert-link-history))
10321 (setq all-prefixes (append (mapcar 'car abbrevs)
10322 (mapcar 'car org-link-abbrev-alist)
10323 org-link-types))
10324 (unwind-protect
10325 (progn
10326 (setq link
10327 (org-completing-read
10328 "Link: "
10329 (append
10330 (mapcar (lambda (x) (concat x ":"))
10331 all-prefixes)
10332 (mapcar 'car org-stored-links))
10333 nil nil nil
10334 'tmphist
10335 (caar org-stored-links)))
10336 (if (not (string-match "\\S-" link))
10337 (user-error "No link selected"))
10338 (mapc (lambda(l)
10339 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10340 org-stored-links)
10341 (if (or (member link all-prefixes)
10342 (and (equal ":" (substring link -1))
10343 (member (substring link 0 -1) all-prefixes)
10344 (setq link (substring link 0 -1))))
10345 (setq link (with-current-buffer origbuf
10346 (org-link-try-special-completion link)))))
10347 (set-window-configuration wcf)
10348 (kill-buffer "*Org Links*"))
10349 (setq entry (assoc link org-stored-links))
10350 (or entry (push link org-insert-link-history))
10351 (setq desc (or desc (nth 1 entry)))))
10353 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10354 (not org-keep-stored-link-after-insertion))
10355 (setq org-stored-links (delq (assoc link org-stored-links)
10356 org-stored-links)))
10358 (if (and (string-match org-plain-link-re link)
10359 (not (string-match org-ts-regexp link)))
10360 ;; URL-like link, normalize the use of angular brackets.
10361 (setq link (org-remove-angle-brackets link)))
10363 ;; Check if we are linking to the current file with a search
10364 ;; option If yes, simplify the link by using only the search
10365 ;; option.
10366 (when (and buffer-file-name
10367 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10368 (let* ((path (match-string 1 link))
10369 (case-fold-search nil)
10370 (search (match-string 2 link)))
10371 (save-match-data
10372 (if (equal (file-truename buffer-file-name) (file-truename path))
10373 ;; We are linking to this same file, with a search option
10374 (setq link search)))))
10376 ;; Check if we can/should use a relative path. If yes, simplify the link
10377 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10378 (let* ((type (match-string 1 link))
10379 (path (match-string 2 link))
10380 (origpath path)
10381 (case-fold-search nil))
10382 (cond
10383 ((or (eq org-link-file-path-type 'absolute)
10384 (equal complete-file '(16)))
10385 (setq path (abbreviate-file-name (expand-file-name path))))
10386 ((eq org-link-file-path-type 'noabbrev)
10387 (setq path (expand-file-name path)))
10388 ((eq org-link-file-path-type 'relative)
10389 (setq path (file-relative-name path)))
10391 (save-match-data
10392 (if (string-match (concat "^" (regexp-quote
10393 (expand-file-name
10394 (file-name-as-directory
10395 default-directory))))
10396 (expand-file-name path))
10397 ;; We are linking a file with relative path name.
10398 (setq path (substring (expand-file-name path)
10399 (match-end 0)))
10400 (setq path (abbreviate-file-name (expand-file-name path)))))))
10401 (setq link (concat type path))
10402 (if (equal desc origpath)
10403 (setq desc path))))
10405 (if org-make-link-description-function
10406 (setq desc
10407 (or (condition-case nil
10408 (funcall org-make-link-description-function link desc)
10409 (error (progn (message "Can't get link description from `%s'"
10410 (symbol-name org-make-link-description-function))
10411 (sit-for 2) nil)))
10412 (read-string "Description: " default-description)))
10413 (if default-description (setq desc default-description)
10414 (setq desc (or (and auto-desc desc)
10415 (read-string "Description: " desc)))))
10417 (unless (string-match "\\S-" desc) (setq desc nil))
10418 (if remove (apply 'delete-region remove))
10419 (insert (org-make-link-string link desc))))
10421 (defun org-link-try-special-completion (type)
10422 "If there is completion support for link type TYPE, offer it."
10423 (let ((fun (intern (concat "org-" type "-complete-link"))))
10424 (if (functionp fun)
10425 (funcall fun)
10426 (read-string "Link (no completion support): " (concat type ":")))))
10428 (defun org-file-complete-link (&optional arg)
10429 "Create a file link using completion."
10430 (let (file link)
10431 (setq file (org-iread-file-name "File: "))
10432 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10433 (pwd1 (file-name-as-directory (abbreviate-file-name
10434 (expand-file-name ".")))))
10435 (cond
10436 ((equal arg '(16))
10437 (setq link (concat
10438 "file:"
10439 (abbreviate-file-name (expand-file-name file)))))
10440 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10441 (setq link (concat "file:" (match-string 1 file))))
10442 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10443 (expand-file-name file))
10444 (setq link (concat
10445 "file:" (match-string 1 (expand-file-name file)))))
10446 (t (setq link (concat "file:" file)))))
10447 link))
10449 (defun org-iread-file-name (&rest args)
10450 "Read-file-name using `ido-mode' speedup if available.
10451 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10452 See `read-file-name' for a description of parameters."
10453 (org-without-partial-completion
10454 (if (and org-completion-use-ido
10455 (fboundp 'ido-read-file-name)
10456 (boundp 'ido-mode) ido-mode
10457 (listp (second args)))
10458 (let ((ido-enter-matching-directory nil))
10459 (apply 'ido-read-file-name args))
10460 (apply 'read-file-name args))))
10462 (defun org-completing-read (&rest args)
10463 "Completing-read with SPACE being a normal character."
10464 (let ((enable-recursive-minibuffers t)
10465 (minibuffer-local-completion-map
10466 (copy-keymap minibuffer-local-completion-map)))
10467 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10468 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10469 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10470 (apply 'org-icompleting-read args)))
10472 (defun org-completing-read-no-i (&rest args)
10473 (let (org-completion-use-ido org-completion-use-iswitchb)
10474 (apply 'org-completing-read args)))
10476 (defun org-iswitchb-completing-read (prompt choices &rest args)
10477 "Use iswitch as a completing-read replacement to choose from choices.
10478 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10479 from."
10480 (let* ((iswitchb-use-virtual-buffers nil)
10481 (iswitchb-make-buflist-hook
10482 (lambda ()
10483 (setq iswitchb-temp-buflist choices))))
10484 (iswitchb-read-buffer prompt)))
10486 (defun org-icompleting-read (&rest args)
10487 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10488 (org-without-partial-completion
10489 (if (and org-completion-use-ido
10490 (fboundp 'ido-completing-read)
10491 (boundp 'ido-mode) ido-mode
10492 (listp (second args)))
10493 (let ((ido-enter-matching-directory nil))
10494 (apply 'ido-completing-read (concat (car args))
10495 (if (consp (car (nth 1 args)))
10496 (mapcar 'car (nth 1 args))
10497 (nth 1 args))
10498 (cddr args)))
10499 (if (and org-completion-use-iswitchb
10500 (boundp 'iswitchb-mode) iswitchb-mode
10501 (listp (second args)))
10502 (apply 'org-iswitchb-completing-read (concat (car args))
10503 (if (consp (car (nth 1 args)))
10504 (mapcar 'car (nth 1 args))
10505 (nth 1 args))
10506 (cddr args))
10507 (apply 'completing-read args)))))
10509 (defun org-extract-attributes (s)
10510 "Extract the attributes cookie from a string and set as text property."
10511 (let (a attr (start 0) key value)
10512 (save-match-data
10513 (when (string-match "{{\\([^}]+\\)}}$" s)
10514 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10515 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10516 (setq key (match-string 1 a) value (match-string 2 a)
10517 start (match-end 0)
10518 attr (plist-put attr (intern key) value))))
10519 (org-add-props s nil 'org-attr attr))
10522 ;;; Opening/following a link
10524 (defvar org-link-search-failed nil)
10526 (defvar org-open-link-functions nil
10527 "Hook for functions finding a plain text link.
10528 These functions must take a single argument, the link content.
10529 They will be called for links that look like [[link text][description]]
10530 when LINK TEXT does not have a protocol like \"http:\" and does not look
10531 like a filename (e.g. \"./blue.png\").
10533 These functions will be called *before* Org attempts to resolve the
10534 link by doing text searches in the current buffer - so if you want a
10535 link \"[[target]]\" to still find \"<<target>>\", your function should
10536 handle this as a special case.
10538 When the function does handle the link, it must return a non-nil value.
10539 If it decides that it is not responsible for this link, it must return
10540 nil to indicate that that Org-mode can continue with other options
10541 like exact and fuzzy text search.")
10543 (defun org-next-link (&optional search-backward)
10544 "Move forward to the next link.
10545 If the link is in hidden text, expose it."
10546 (interactive "P")
10547 (when (and org-link-search-failed (eq this-command last-command))
10548 (goto-char (point-min))
10549 (message "Link search wrapped back to beginning of buffer"))
10550 (setq org-link-search-failed nil)
10551 (let* ((pos (point))
10552 (ct (org-context))
10553 (a (assoc :link ct))
10554 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10555 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10556 ((looking-at org-any-link-re)
10557 ;; Don't stay stuck at link without an org-link face
10558 (forward-char (if search-backward -1 1))))
10559 (if (funcall srch-fun org-any-link-re nil t)
10560 (progn
10561 (goto-char (match-beginning 0))
10562 (if (outline-invisible-p) (org-show-context)))
10563 (goto-char pos)
10564 (setq org-link-search-failed t)
10565 (message "No further link found"))))
10567 (defun org-previous-link ()
10568 "Move backward to the previous link.
10569 If the link is in hidden text, expose it."
10570 (interactive)
10571 (funcall 'org-next-link t))
10573 (defun org-translate-link (s)
10574 "Translate a link string if a translation function has been defined."
10575 (if (and org-link-translation-function
10576 (fboundp org-link-translation-function)
10577 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10578 (progn
10579 (setq s (funcall org-link-translation-function
10580 (match-string 1 s) (match-string 2 s)))
10581 (concat (car s) ":" (cdr s)))
10584 (defun org-translate-link-from-planner (type path)
10585 "Translate a link from Emacs Planner syntax so that Org can follow it.
10586 This is still an experimental function, your mileage may vary."
10587 (cond
10588 ((member type '("http" "https" "news" "ftp"))
10589 ;; standard Internet links are the same.
10590 nil)
10591 ((and (equal type "irc") (string-match "^//" path))
10592 ;; Planner has two / at the beginning of an irc link, we have 1.
10593 ;; We should have zero, actually....
10594 (setq path (substring path 1)))
10595 ((and (equal type "lisp") (string-match "^/" path))
10596 ;; Planner has a slash, we do not.
10597 (setq type "elisp" path (substring path 1)))
10598 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10599 ;; A typical message link. Planner has the id after the final slash,
10600 ;; we separate it with a hash mark
10601 (setq path (concat (match-string 1 path) "#"
10602 (org-remove-angle-brackets (match-string 2 path))))))
10603 (cons type path))
10605 (defun org-find-file-at-mouse (ev)
10606 "Open file link or URL at mouse."
10607 (interactive "e")
10608 (mouse-set-point ev)
10609 (org-open-at-point 'in-emacs))
10611 (defun org-open-at-mouse (ev)
10612 "Open file link or URL at mouse.
10613 See the docstring of `org-open-file' for details."
10614 (interactive "e")
10615 (mouse-set-point ev)
10616 (if (eq major-mode 'org-agenda-mode)
10617 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10618 (org-open-at-point))
10620 (defvar org-window-config-before-follow-link nil
10621 "The window configuration before following a link.
10622 This is saved in case the need arises to restore it.")
10624 (defvar org-open-link-marker (make-marker)
10625 "Marker pointing to the location where `org-open-at-point' was called.")
10627 ;;;###autoload
10628 (defun org-open-at-point-global ()
10629 "Follow a link like Org-mode does.
10630 This command can be called in any mode to follow a link that has
10631 Org-mode syntax."
10632 (interactive)
10633 (org-run-like-in-org-mode 'org-open-at-point))
10635 ;;;###autoload
10636 (defun org-open-link-from-string (s &optional arg reference-buffer)
10637 "Open a link in the string S, as if it was in Org-mode."
10638 (interactive "sLink: \nP")
10639 (let ((reference-buffer (or reference-buffer (current-buffer))))
10640 (with-temp-buffer
10641 (let ((org-inhibit-startup (not reference-buffer)))
10642 (org-mode)
10643 (insert s)
10644 (goto-char (point-min))
10645 (when reference-buffer
10646 (setq org-link-abbrev-alist-local
10647 (with-current-buffer reference-buffer
10648 org-link-abbrev-alist-local)))
10649 (org-open-at-point arg reference-buffer)))))
10651 (defvar org-open-at-point-functions nil
10652 "Hook that is run when following a link at point.
10654 Functions in this hook must return t if they identify and follow
10655 a link at point. If they don't find anything interesting at point,
10656 they must return nil.")
10658 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10659 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10660 (defun org-open-at-point (&optional arg reference-buffer)
10661 "Open link, timestamp, footnote or tags at point.
10663 When point is on a link, follow it. Normally, files will be
10664 opened by an appropriate application. If the optional prefix
10665 argument ARG is non-nil, Emacs will visit the file. With
10666 a double prefix argument, try to open outside of Emacs, in the
10667 application the system uses for this file type.
10669 When point is on a timestamp, open the agenda at the day
10670 specified.
10672 When point is a footnote definition, move to the first reference
10673 found. If it is on a reference, move to the associated
10674 definition.
10676 When point is on a headline, display a list of every link in the
10677 entry, so it is possible to pick one, or all, of them. If point
10678 is on a tag, call `org-tags-view' instead.
10680 When optional argument REFERENCE-BUFFER is non-nil, it should
10681 specify a buffer from where the link search should happen. This
10682 is used internally by `org-open-link-from-string'.
10684 On top of syntactically correct links, this function will open
10685 the link at point in comments or comment blocks and the first
10686 link in a property drawer line."
10687 (interactive "P")
10688 ;; On a code block, open block's results.
10689 (unless (call-interactively 'org-babel-open-src-block-result)
10690 (org-load-modules-maybe)
10691 (move-marker org-open-link-marker (point))
10692 (setq org-window-config-before-follow-link (current-window-configuration))
10693 (org-remove-occur-highlights nil nil t)
10694 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10695 (let* ((context
10696 ;; Only consider supported types, even if they are not
10697 ;; the closest one.
10698 (org-element-lineage
10699 (org-element-context)
10700 '(comment comment-block footnote-definition footnote-reference
10701 headline inlinetask link node-property timestamp)
10703 (type (org-element-type context))
10704 (value (org-element-property :value context)))
10705 (cond
10706 ((not context) (user-error "No link found"))
10707 ;; Exception: open timestamps and links in properties drawers
10708 ;; and comments.
10709 ((memq type '(comment comment-block node-property))
10710 (cond ((org-in-regexp org-any-link-re)
10711 (org-open-link-from-string (match-string-no-properties 0)))
10712 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10713 (org-follow-timestamp-link))
10714 (t (user-error "No link found"))))
10715 ;; On a headline or an inlinetask, but not on a timestamp,
10716 ;; a link, a footnote reference or on tags.
10717 ((and (memq type '(headline inlinetask))
10718 ;; Not on tags.
10719 (progn (save-excursion (beginning-of-line)
10720 (looking-at org-complex-heading-regexp))
10721 (or (not (match-beginning 5))
10722 (< (point) (match-beginning 5)))))
10723 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10724 (links (car data))
10725 (links-end (cdr data)))
10726 (if links
10727 (dolist (link (if (stringp links) (list links) links))
10728 (search-forward link nil links-end)
10729 (goto-char (match-beginning 0))
10730 (org-open-at-point))
10731 (require 'org-attach)
10732 (org-attach-reveal 'if-exists))))
10733 ;; Do nothing on white spaces after an object, unless point
10734 ;; is right after it.
10735 ((> (point)
10736 (save-excursion
10737 (goto-char (org-element-property :end context))
10738 (skip-chars-backward " \t")
10739 (point)))
10740 (user-error "No link found"))
10741 ((eq type 'timestamp) (org-follow-timestamp-link))
10742 ;; On tags within a headline or an inlinetask.
10743 ((and (memq type '(headline inlinetask))
10744 (progn (save-excursion (beginning-of-line)
10745 (looking-at org-complex-heading-regexp))
10746 (and (match-beginning 5)
10747 (>= (point) (match-beginning 5)))))
10748 (org-tags-view arg (substring (match-string 5) 0 -1)))
10749 ((eq type 'link)
10750 ;; When link is located within the description of another
10751 ;; link (e.g., an inline image), always open the parent
10752 ;; link.
10753 (let*((link (let ((up (org-element-property :parent context)))
10754 (if (eq (org-element-type up) 'link) up context)))
10755 (type (org-element-property :type link))
10756 (path (org-link-unescape (org-element-property :path link))))
10757 ;; Switch back to REFERENCE-BUFFER needed when called in
10758 ;; a temporary buffer through `org-open-link-from-string'.
10759 (with-current-buffer (or reference-buffer (current-buffer))
10760 (cond
10761 ((equal type "file")
10762 (if (string-match "[*?{]" (file-name-nondirectory path))
10763 (dired path)
10764 ;; Look into `org-link-protocols' in order to find
10765 ;; a DEDICATED-FUNCTION to open file. The function
10766 ;; will be applied on raw link instead of parsed
10767 ;; link due to the limitation in `org-add-link-type'
10768 ;; ("open" function called with a single argument).
10769 ;; If no such function is found, fallback to
10770 ;; `org-open-file'.
10772 ;; Note : "file+emacs" and "file+sys" types are
10773 ;; hard-coded in order to escape the previous
10774 ;; limitation.
10775 (let* ((option (org-element-property :search-option link))
10776 (app (org-element-property :application link))
10777 (dedicated-function
10778 (nth 1 (assoc app org-link-protocols))))
10779 (if dedicated-function
10780 (funcall dedicated-function
10781 (concat path
10782 (and option (concat "::" option))))
10783 (apply 'org-open-file
10784 path
10785 (cond (arg)
10786 ((equal app "emacs") 'emacs)
10787 ((equal app "sys") 'system))
10788 (cond ((not option) nil)
10789 ((org-string-match-p "\\`[0-9]+\\'" option)
10790 (list (string-to-number option)))
10791 (t (list nil
10792 (org-link-unescape option)))))))))
10793 ((assoc type org-link-protocols)
10794 (funcall (nth 1 (assoc type org-link-protocols)) path))
10795 ((equal type "help")
10796 (let ((f-or-v (intern path)))
10797 (cond ((fboundp f-or-v) (describe-function f-or-v))
10798 ((boundp f-or-v) (describe-variable f-or-v))
10799 (t (error "Not a known function or variable")))))
10800 ((member type '("http" "https" "ftp" "mailto" "news"))
10801 (browse-url (org-link-escape-browser (concat type ":" path))))
10802 ((equal type "doi")
10803 (browse-url
10804 (org-link-escape-browser (concat org-doi-server-url path))))
10805 ((equal type "message") (browse-url (concat type ":" path)))
10806 ((equal type "shell")
10807 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10808 (cmd path))
10809 (if (or (and (org-string-nw-p
10810 org-confirm-shell-link-not-regexp)
10811 (string-match
10812 org-confirm-shell-link-not-regexp cmd))
10813 (not org-confirm-shell-link-function)
10814 (funcall org-confirm-shell-link-function
10815 (format "Execute \"%s\" in shell? "
10816 (org-add-props cmd nil
10817 'face 'org-warning))))
10818 (progn
10819 (message "Executing %s" cmd)
10820 (shell-command cmd buf)
10821 (when (featurep 'midnight)
10822 (setq clean-buffer-list-kill-buffer-names
10823 (cons buf
10824 clean-buffer-list-kill-buffer-names))))
10825 (user-error "Abort"))))
10826 ((equal type "elisp")
10827 (let ((cmd path))
10828 (if (or (and (org-string-nw-p
10829 org-confirm-elisp-link-not-regexp)
10830 (org-string-match-p
10831 org-confirm-elisp-link-not-regexp cmd))
10832 (not org-confirm-elisp-link-function)
10833 (funcall org-confirm-elisp-link-function
10834 (format "Execute \"%s\" as elisp? "
10835 (org-add-props cmd nil
10836 'face 'org-warning))))
10837 (message "%s => %s" cmd
10838 (if (eq (string-to-char cmd) ?\()
10839 (eval (read cmd))
10840 (call-interactively (read cmd))))
10841 (user-error "Abort"))))
10842 ((equal type "id")
10843 (require 'ord-id)
10844 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10845 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10846 (unless (run-hook-with-args-until-success
10847 'org-open-link-functions path)
10848 (if (not arg) (org-mark-ring-push)
10849 (switch-to-buffer-other-window
10850 (org-get-buffer-for-internal-link (current-buffer))))
10851 (let ((cmd `(org-link-search
10852 ,(if (member type '("custom-id" "coderef"))
10853 (org-element-property :raw-link link)
10854 path)
10855 ,(cond ((equal arg '(4)) 'occur)
10856 ((equal arg '(16)) 'org-occur))
10857 ,(org-element-property :begin link))))
10858 (condition-case nil
10859 (let ((org-link-search-inhibit-query t))
10860 (eval cmd))
10861 (error (progn (widen) (eval cmd)))))))
10862 (t (browse-url-at-point))))))
10863 ;; On a footnote reference or at a footnote definition's label.
10864 ((or (eq type 'footnote-reference)
10865 (and (eq type 'footnote-definition)
10866 (save-excursion
10867 ;; Do not validate action when point is on the
10868 ;; spaces right after the footnote label, in
10869 ;; order to be on par with behaviour on links.
10870 (skip-chars-forward " \t")
10871 (let ((begin
10872 (org-element-property :contents-begin context)))
10873 (if begin (< (point) begin)
10874 (= (org-element-property :post-affiliated context)
10875 (line-beginning-position)))))))
10876 (org-footnote-action))
10877 (t (user-error "No link found")))))
10878 (move-marker org-open-link-marker nil)
10879 (run-hook-with-args 'org-follow-link-hook)))
10881 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10882 "Offer links in the current entry and return the selected link.
10883 If there is only one link, return it.
10884 If NTH is an integer, return the NTH link found.
10885 If ZERO is a string, check also this string for a link, and if
10886 there is one, return it."
10887 (with-current-buffer buffer
10888 (save-excursion
10889 (save-restriction
10890 (widen)
10891 (goto-char marker)
10892 (let ((cnt ?0)
10893 (in-emacs (if (integerp nth) nil nth))
10894 have-zero end links link c)
10895 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10896 (push (match-string 0 zero) links)
10897 (setq cnt (1- cnt) have-zero t))
10898 (save-excursion
10899 (org-back-to-heading t)
10900 (setq end (save-excursion (outline-next-heading) (point)))
10901 (while (re-search-forward org-any-link-re end t)
10902 (push (match-string 0) links))
10903 (setq links (org-uniquify (reverse links))))
10904 (cond
10905 ((null links)
10906 (message "No links"))
10907 ((equal (length links) 1)
10908 (setq link (car links)))
10909 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10910 (setq link (nth (if have-zero nth (1- nth)) links)))
10911 (t ; we have to select a link
10912 (save-excursion
10913 (save-window-excursion
10914 (delete-other-windows)
10915 (with-output-to-temp-buffer "*Select Link*"
10916 (mapc (lambda (l)
10917 (if (not (string-match org-bracket-link-regexp l))
10918 (princ (format "[%c] %s\n" (incf cnt)
10919 (org-remove-angle-brackets l)))
10920 (if (match-end 3)
10921 (princ (format "[%c] %s (%s)\n" (incf cnt)
10922 (match-string 3 l) (match-string 1 l)))
10923 (princ (format "[%c] %s\n" (incf cnt)
10924 (match-string 1 l))))))
10925 links))
10926 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10927 (message "Select link to open, RET to open all:")
10928 (setq c (read-char-exclusive))
10929 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10930 (when (equal c ?q) (user-error "Abort"))
10931 (if (equal c ?\C-m)
10932 (setq link links)
10933 (setq nth (- c ?0))
10934 (if have-zero (setq nth (1+ nth)))
10935 (unless (and (integerp nth) (>= (length links) nth))
10936 (user-error "Invalid link selection"))
10937 (setq link (nth (1- nth) links)))))
10938 (cons link end))))))
10940 ;; TODO: These functions are deprecated since `org-open-at-point'
10941 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10942 (defun org-open-file-with-system (path)
10943 "Open file at PATH using the system way of opening it."
10944 (org-open-file path 'system))
10945 (defun org-open-file-with-emacs (path)
10946 "Open file at PATH in Emacs."
10947 (org-open-file path 'emacs))
10950 ;;; File search
10952 (defvar org-create-file-search-functions nil
10953 "List of functions to construct the right search string for a file link.
10954 These functions are called in turn with point at the location to
10955 which the link should point.
10957 A function in the hook should first test if it would like to
10958 handle this file type, for example by checking the `major-mode'
10959 or the file extension. If it decides not to handle this file, it
10960 should just return nil to give other functions a chance. If it
10961 does handle the file, it must return the search string to be used
10962 when following the link. The search string will be part of the
10963 file link, given after a double colon, and `org-open-at-point'
10964 will automatically search for it. If special measures must be
10965 taken to make the search successful, another function should be
10966 added to the companion hook `org-execute-file-search-functions',
10967 which see.
10969 A function in this hook may also use `setq' to set the variable
10970 `description' to provide a suggestion for the descriptive text to
10971 be used for this link when it gets inserted into an Org-mode
10972 buffer with \\[org-insert-link].")
10974 (defvar org-execute-file-search-functions nil
10975 "List of functions to execute a file search triggered by a link.
10977 Functions added to this hook must accept a single argument, the
10978 search string that was part of the file link, the part after the
10979 double colon. The function must first check if it would like to
10980 handle this search, for example by checking the `major-mode' or
10981 the file extension. If it decides not to handle this search, it
10982 should just return nil to give other functions a chance. If it
10983 does handle the search, it must return a non-nil value to keep
10984 other functions from trying.
10986 Each function can access the current prefix argument through the
10987 variable `current-prefix-arg'. Note that a single prefix is used
10988 to force opening a link in Emacs, so it may be good to only use a
10989 numeric or double prefix to guide the search function.
10991 In case this is needed, a function in this hook can also restore
10992 the window configuration before `org-open-at-point' was called using:
10994 (set-window-configuration org-window-config-before-follow-link)")
10996 (defun org-link-search (s &optional type avoid-pos stealth)
10997 "Search for a link search option.
10998 If S is surrounded by forward slashes, it is interpreted as a
10999 regular expression. In org-mode files, this will create an `org-occur'
11000 sparse tree. In ordinary files, `occur' will be used to list matches.
11001 If the current buffer is in `dired-mode', grep will be used to search
11002 in all files. If AVOID-POS is given, ignore matches near that position.
11004 When optional argument STEALTH is non-nil, do not modify
11005 visibility around point, thus ignoring
11006 `org-show-hierarchy-above', `org-show-following-heading' and
11007 `org-show-siblings' variables."
11008 (let ((case-fold-search t)
11009 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
11010 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
11011 (append '(("") (" ") ("\t") ("\n"))
11012 org-emphasis-alist)
11013 "\\|") "\\)"))
11014 (pos (point))
11015 words re0 re2 re4_ re4 re5 re2a re2a_ reall)
11016 (cond
11017 ;; First check if there are any special search functions
11018 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11019 ;; Now try the builtin stuff
11020 ((and (equal (string-to-char s0) ?#)
11021 (> (length s0) 1)
11022 (save-excursion
11023 (goto-char (point-min))
11024 (and
11025 (re-search-forward
11026 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
11027 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
11028 (setq type 'dedicated
11029 pos (match-beginning 0))))
11030 ;; There is an exact target for this
11031 (goto-char pos)
11032 (org-back-to-heading t)))
11033 ((save-excursion
11034 (goto-char (point-min))
11035 (and
11036 (re-search-forward
11037 (concat "<<" (regexp-quote s0) ">>") nil t)
11038 (setq type 'dedicated
11039 pos (match-beginning 0))))
11040 ;; There is an exact target for this
11041 (goto-char pos))
11042 ((save-excursion
11043 (goto-char (point-min))
11044 (and
11045 (re-search-forward
11046 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11047 (setq type 'dedicated pos (match-beginning 0))))
11048 ;; Found an element with a matching #+name affiliated keyword.
11049 (goto-char pos))
11050 ((and (string-match "^(\\(.*\\))$" s0)
11051 (save-excursion
11052 (goto-char (point-min))
11053 (and
11054 (re-search-forward
11055 (concat "[^[]" (regexp-quote
11056 (format org-coderef-label-format
11057 (match-string 1 s0))))
11058 nil t)
11059 (setq type 'dedicated
11060 pos (1+ (match-beginning 0))))))
11061 ;; There is a coderef target for this
11062 (goto-char pos))
11063 ((string-match "^/\\(.*\\)/$" s)
11064 ;; A regular expression
11065 (cond
11066 ((derived-mode-p 'org-mode)
11067 (org-occur (match-string 1 s)))
11068 (t (org-do-occur (match-string 1 s)))))
11069 ((and (derived-mode-p 'org-mode)
11070 (or (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11071 org-link-search-must-match-exact-headline))
11072 ;; Headline search.
11073 (goto-char (point-min))
11074 (cond
11075 ((let (case-fold-search)
11076 (re-search-forward
11077 (let* ((wspace "[ \t]")
11078 (wspaceopt (concat wspace "*"))
11079 (cookie (concat "\\(?:"
11080 wspaceopt
11081 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11082 wspaceopt
11083 "\\)"))
11084 (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)")))
11085 (concat
11086 org-outline-regexp-bol
11087 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11088 "\\(?:\\[#.\\][ \t]+\\)?"
11089 sep "*"
11090 (mapconcat #'identity
11091 (org-split-string (regexp-quote s))
11092 (concat sep "+"))
11093 sep "*"
11094 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11095 "[ \t]*$"))
11096 nil t))
11097 ;; OK, found a match
11098 (setq type 'dedicated)
11099 (goto-char (match-beginning 0)))
11100 ((and (not org-link-search-inhibit-query)
11101 (eq org-link-search-must-match-exact-headline 'query-to-create)
11102 (y-or-n-p "No match - create this as a new heading? "))
11103 (goto-char (point-max))
11104 (unless (bolp) (newline))
11105 (org-insert-heading nil t t)
11106 (insert s "\n")
11107 (beginning-of-line 0))
11109 (goto-char pos)
11110 (error "No match"))))
11112 ;; A normal search string
11113 (remove-text-properties
11114 0 (length s)
11115 '(face nil mouse-face nil keymap nil fontified nil) s)
11116 ;; Make a series of regular expressions to find a match
11117 (setq words (org-split-string s "[ \n\r\t]+")
11119 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11120 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11121 "\\)" markers)
11122 re2a_ (concat "\\(" (mapconcat 'downcase words
11123 "[ \t\r\n]+") "\\)[ \t\r\n]")
11124 re2a (concat "[ \t\r\n]" re2a_)
11125 re4_ (concat "\\(" (mapconcat 'downcase words
11126 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11127 re4 (concat "[^a-zA-Z_]" re4_)
11129 re5 (concat ".*" re4)
11130 reall (concat "\\(" re0 "\\)\\|\\(" re2 "\\)\\|\\(" re4
11131 "\\)\\|\\(" re5 "\\)"))
11132 (cond
11133 ((eq type 'org-occur) (org-occur reall))
11134 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11135 (t (goto-char (point-min))
11136 (setq type 'fuzzy)
11137 (if (or (and (org-search-not-self 1 re0 nil t)
11138 (setq type 'dedicated))
11139 (org-search-not-self 1 re2 nil t)
11140 (org-search-not-self 1 re2a nil t)
11141 (org-search-not-self 1 re4 nil t)
11142 (org-search-not-self 1 re5 nil t))
11143 (goto-char (match-beginning 1))
11144 (goto-char pos)
11145 (error "No match"))))))
11146 (and (derived-mode-p 'org-mode)
11147 (not stealth)
11148 (org-show-context 'link-search))
11149 type))
11151 (defun org-search-not-self (group &rest args)
11152 "Execute `re-search-forward', but only accept matches that do not
11153 enclose the position of `org-open-link-marker'."
11154 (let ((m org-open-link-marker))
11155 (catch 'exit
11156 (while (apply 're-search-forward args)
11157 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11158 (goto-char (match-end group))
11159 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11160 (> (match-beginning 0) (marker-position m))
11161 (< (match-end 0) (marker-position m)))
11162 (save-match-data
11163 (or (not (org-in-regexp
11164 org-bracket-link-analytic-regexp 1))
11165 (not (match-end 4)) ; no description
11166 (and (<= (match-beginning 4) (point))
11167 (>= (match-end 4) (point))))))
11168 (throw 'exit (point))))))))
11170 (defun org-get-buffer-for-internal-link (buffer)
11171 "Return a buffer to be used for displaying the link target of internal links."
11172 (cond
11173 ((not org-display-internal-link-with-indirect-buffer)
11174 buffer)
11175 ((string-match "(Clone)$" (buffer-name buffer))
11176 (message "Buffer is already a clone, not making another one")
11177 ;; we also do not modify visibility in this case
11178 buffer)
11179 (t ; make a new indirect buffer for displaying the link
11180 (let* ((bn (buffer-name buffer))
11181 (ibn (concat bn "(Clone)"))
11182 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11183 (with-current-buffer ib (org-overview))
11184 ib))))
11186 (defun org-do-occur (regexp &optional cleanup)
11187 "Call the Emacs command `occur'.
11188 If CLEANUP is non-nil, remove the printout of the regular expression
11189 in the *Occur* buffer. This is useful if the regex is long and not useful
11190 to read."
11191 (occur regexp)
11192 (when cleanup
11193 (let ((cwin (selected-window)) win beg end)
11194 (when (setq win (get-buffer-window "*Occur*"))
11195 (select-window win))
11196 (goto-char (point-min))
11197 (when (re-search-forward "match[a-z]+" nil t)
11198 (setq beg (match-end 0))
11199 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11200 (setq end (1- (match-beginning 0)))))
11201 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11202 (goto-char (point-min))
11203 (select-window cwin))))
11205 ;;; The mark ring for links jumps
11207 (defvar org-mark-ring nil
11208 "Mark ring for positions before jumps in Org-mode.")
11209 (defvar org-mark-ring-last-goto nil
11210 "Last position in the mark ring used to go back.")
11211 ;; Fill and close the ring
11212 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11213 (loop for i from 1 to org-mark-ring-length do
11214 (push (make-marker) org-mark-ring))
11215 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11216 org-mark-ring)
11218 (defun org-mark-ring-push (&optional pos buffer)
11219 "Put the current position or POS into the mark ring and rotate it."
11220 (interactive)
11221 (setq pos (or pos (point)))
11222 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11223 (move-marker (car org-mark-ring)
11224 (or pos (point))
11225 (or buffer (current-buffer)))
11226 (message "%s"
11227 (substitute-command-keys
11228 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11230 (defun org-mark-ring-goto (&optional n)
11231 "Jump to the previous position in the mark ring.
11232 With prefix arg N, jump back that many stored positions. When
11233 called several times in succession, walk through the entire ring.
11234 Org-mode commands jumping to a different position in the current file,
11235 or to another Org-mode file, automatically push the old position
11236 onto the ring."
11237 (interactive "p")
11238 (let (p m)
11239 (if (eq last-command this-command)
11240 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11241 (setq p org-mark-ring))
11242 (setq org-mark-ring-last-goto p)
11243 (setq m (car p))
11244 (org-pop-to-buffer-same-window (marker-buffer m))
11245 (goto-char m)
11246 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11248 (defun org-remove-angle-brackets (s)
11249 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11250 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11252 (defun org-add-angle-brackets (s)
11253 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11254 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11256 (defun org-remove-double-quotes (s)
11257 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11258 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11261 ;;; Following specific links
11263 (defun org-follow-timestamp-link ()
11264 "Open an agenda view for the time-stamp date/range at point."
11265 (cond
11266 ((org-at-date-range-p t)
11267 (let ((org-agenda-start-on-weekday)
11268 (t1 (match-string 1))
11269 (t2 (match-string 2)) tt1 tt2)
11270 (setq tt1 (time-to-days (org-time-string-to-time t1))
11271 tt2 (time-to-days (org-time-string-to-time t2)))
11272 (let ((org-agenda-buffer-tmp-name
11273 (format "*Org Agenda(a:%s)"
11274 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11275 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11276 ((org-at-timestamp-p t)
11277 (let ((org-agenda-buffer-tmp-name
11278 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11279 (org-agenda-list nil (time-to-days (org-time-string-to-time
11280 (substring (match-string 1) 0 10)))
11281 1)))
11282 (t (error "This should not happen"))))
11285 ;;; Following file links
11286 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11287 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11288 (declare-function mailcap-mime-info
11289 "mailcap" (string &optional request no-decode))
11290 (defvar org-wait nil)
11291 (defun org-open-file (path &optional in-emacs line search)
11292 "Open the file at PATH.
11293 First, this expands any special file name abbreviations. Then the
11294 configuration variable `org-file-apps' is checked if it contains an
11295 entry for this file type, and if yes, the corresponding command is launched.
11297 If no application is found, Emacs simply visits the file.
11299 With optional prefix argument IN-EMACS, Emacs will visit the file.
11300 With a double \\[universal-argument] \\[universal-argument] \
11301 prefix arg, Org tries to avoid opening in Emacs
11302 and to use an external application to visit the file.
11304 Optional LINE specifies a line to go to, optional SEARCH a string
11305 to search for. If LINE or SEARCH is given, the file will be
11306 opened in Emacs, unless an entry from org-file-apps that makes
11307 use of groups in a regexp matches.
11309 If you want to change the way frames are used when following a
11310 link, please customize `org-link-frame-setup'.
11312 If the file does not exist, an error is thrown."
11313 (let* ((file (if (equal path "")
11314 buffer-file-name
11315 (substitute-in-file-name (expand-file-name path))))
11316 (file-apps (append org-file-apps (org-default-apps)))
11317 (apps (org-remove-if
11318 'org-file-apps-entry-match-against-dlink-p file-apps))
11319 (apps-dlink (org-remove-if-not
11320 'org-file-apps-entry-match-against-dlink-p file-apps))
11321 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11322 (dirp (if remp nil (file-directory-p file)))
11323 (file (if (and dirp org-open-directory-means-index-dot-org)
11324 (concat (file-name-as-directory file) "index.org")
11325 file))
11326 (a-m-a-p (assq 'auto-mode apps))
11327 (dfile (downcase file))
11328 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11329 (link (cond ((and (eq line nil)
11330 (eq search nil))
11331 file)
11332 (line
11333 (concat file "::" (number-to-string line)))
11334 (search
11335 (concat file "::" search))))
11336 (dlink (downcase link))
11337 (old-buffer (current-buffer))
11338 (old-pos (point))
11339 (old-mode major-mode)
11340 ext cmd link-match-data)
11341 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11342 (setq ext (match-string 1 dfile))
11343 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11344 (setq ext (match-string 1 dfile))))
11345 (cond
11346 ((member in-emacs '((16) system))
11347 (setq cmd (cdr (assoc 'system apps))))
11348 (in-emacs (setq cmd 'emacs))
11350 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11351 (and dirp (cdr (assoc 'directory apps)))
11352 ; first, try matching against apps-dlink
11353 ; if we get a match here, store the match data for later
11354 (let ((match (assoc-default dlink apps-dlink
11355 'string-match)))
11356 (if match
11357 (progn (setq link-match-data (match-data))
11358 match)
11359 (progn (setq in-emacs (or in-emacs line search))
11360 nil))) ; if we have no match in apps-dlink,
11361 ; always open the file in emacs if line or search
11362 ; is given (for backwards compatibility)
11363 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11364 'string-match)
11365 (cdr (assoc ext apps))
11366 (cdr (assoc t apps))))))
11367 (when (eq cmd 'system)
11368 (setq cmd (cdr (assoc 'system apps))))
11369 (when (eq cmd 'default)
11370 (setq cmd (cdr (assoc t apps))))
11371 (when (eq cmd 'mailcap)
11372 (require 'mailcap)
11373 (mailcap-parse-mailcaps)
11374 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11375 (command (mailcap-mime-info mime-type)))
11376 (if (stringp command)
11377 (setq cmd command)
11378 (setq cmd 'emacs))))
11379 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11380 (not (file-exists-p file))
11381 (not org-open-non-existing-files))
11382 (user-error "No such file: %s" file))
11383 (cond
11384 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11385 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11386 (while (string-match "['\"]%s['\"]" cmd)
11387 (setq cmd (replace-match "%s" t t cmd)))
11388 (while (string-match "%s" cmd)
11389 (setq cmd (replace-match
11390 (save-match-data
11391 (shell-quote-argument
11392 (convert-standard-filename file)))
11393 t t cmd)))
11395 ;; Replace "%1", "%2" etc. in command with group matches from regex
11396 (save-match-data
11397 (let ((match-index 1)
11398 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11399 (set-match-data link-match-data)
11400 (while (<= match-index number-of-groups)
11401 (let ((regex (concat "%" (number-to-string match-index)))
11402 (replace-with (match-string match-index dlink)))
11403 (while (string-match regex cmd)
11404 (setq cmd (replace-match replace-with t t cmd))))
11405 (setq match-index (+ match-index 1)))))
11407 (save-window-excursion
11408 (message "Running %s...done" cmd)
11409 (start-process-shell-command cmd nil cmd)
11410 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11411 ((or (stringp cmd)
11412 (eq cmd 'emacs))
11413 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11414 (widen)
11415 (if line (progn (org-goto-line line)
11416 (if (derived-mode-p 'org-mode)
11417 (org-reveal)))
11418 (if search (org-link-search search))))
11419 ((consp cmd)
11420 (let ((file (convert-standard-filename file)))
11421 (save-match-data
11422 (set-match-data link-match-data)
11423 (eval cmd))))
11424 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11425 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11426 (or (not (equal old-buffer (current-buffer)))
11427 (not (equal old-pos (point))))
11428 (org-mark-ring-push old-pos old-buffer))))
11430 (defun org-file-apps-entry-match-against-dlink-p (entry)
11431 "This function returns non-nil if `entry' uses a regular
11432 expression which should be matched against the whole link by
11433 org-open-file.
11435 It assumes that is the case when the entry uses a regular
11436 expression which has at least one grouping construct and the
11437 action is either a lisp form or a command string containing
11438 '%1', i.e. using at least one subexpression match as a
11439 parameter."
11440 (let ((selector (car entry))
11441 (action (cdr entry)))
11442 (if (stringp selector)
11443 (and (> (regexp-opt-depth selector) 0)
11444 (or (and (stringp action)
11445 (string-match "%[0-9]" action))
11446 (consp action)))
11447 nil)))
11449 (defun org-default-apps ()
11450 "Return the default applications for this operating system."
11451 (cond
11452 ((eq system-type 'darwin)
11453 org-file-apps-defaults-macosx)
11454 ((eq system-type 'windows-nt)
11455 org-file-apps-defaults-windowsnt)
11456 (t org-file-apps-defaults-gnu)))
11458 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11459 "Convert extensions to regular expressions in the cars of LIST.
11460 Also, weed out any non-string entries, because the return value is used
11461 only for regexp matching.
11462 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11463 point to the symbol `emacs', indicating that the file should
11464 be opened in Emacs."
11465 (append
11466 (delq nil
11467 (mapcar (lambda (x)
11468 (if (not (stringp (car x)))
11470 (if (string-match "\\W" (car x))
11472 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11473 list))
11474 (if add-auto-mode
11475 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11477 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11478 (defun org-file-remote-p (file)
11479 "Test whether FILE specifies a location on a remote system.
11480 Return non-nil if the location is indeed remote.
11482 For example, the filename \"/user@host:/foo\" specifies a location
11483 on the system \"/user@host:\"."
11484 (cond ((fboundp 'file-remote-p)
11485 (file-remote-p file))
11486 ((fboundp 'tramp-handle-file-remote-p)
11487 (tramp-handle-file-remote-p file))
11488 ((and (boundp 'ange-ftp-name-format)
11489 (string-match (car ange-ftp-name-format) file))
11490 t)))
11493 ;;;; Refiling
11495 (defun org-get-org-file ()
11496 "Read a filename, with default directory `org-directory'."
11497 (let ((default (or org-default-notes-file remember-data-file)))
11498 (read-file-name (format "File name [%s]: " default)
11499 (file-name-as-directory org-directory)
11500 default)))
11502 (defun org-notes-order-reversed-p ()
11503 "Check if the current file should receive notes in reversed order."
11504 (cond
11505 ((not org-reverse-note-order) nil)
11506 ((eq t org-reverse-note-order) t)
11507 ((not (listp org-reverse-note-order)) nil)
11508 (t (catch 'exit
11509 (let ((all org-reverse-note-order)
11510 entry)
11511 (while (setq entry (pop all))
11512 (if (string-match (car entry) buffer-file-name)
11513 (throw 'exit (cdr entry))))
11514 nil)))))
11516 (defvar org-refile-target-table nil
11517 "The list of refile targets, created by `org-refile'.")
11519 (defvar org-agenda-new-buffers nil
11520 "Buffers created to visit agenda files.")
11522 (defvar org-refile-cache nil
11523 "Cache for refile targets.")
11525 (defvar org-refile-markers nil
11526 "All the markers used for caching refile locations.")
11528 (defun org-refile-marker (pos)
11529 "Get a new refile marker, but only if caching is in use."
11530 (if (not org-refile-use-cache)
11532 (let ((m (make-marker)))
11533 (move-marker m pos)
11534 (push m org-refile-markers)
11535 m)))
11537 (defun org-refile-cache-clear ()
11538 "Clear the refile cache and disable all the markers."
11539 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11540 (setq org-refile-markers nil)
11541 (setq org-refile-cache nil)
11542 (message "Refile cache has been cleared"))
11544 (defun org-refile-cache-check-set (set)
11545 "Check if all the markers in the cache still have live buffers."
11546 (let (marker)
11547 (catch 'exit
11548 (while (and set (setq marker (nth 3 (pop set))))
11549 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11550 (when (and marker (null (marker-buffer marker)))
11551 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11552 (sit-for 3)
11553 (throw 'exit nil)))
11554 t)))
11556 (defun org-refile-cache-put (set &rest identifiers)
11557 "Push the refile targets SET into the cache, under IDENTIFIERS."
11558 (let* ((key (sha1 (prin1-to-string identifiers)))
11559 (entry (assoc key org-refile-cache)))
11560 (if entry
11561 (setcdr entry set)
11562 (push (cons key set) org-refile-cache))))
11564 (defun org-refile-cache-get (&rest identifiers)
11565 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11566 (cond
11567 ((not org-refile-cache) nil)
11568 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11570 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11571 org-refile-cache))))
11572 (and set (org-refile-cache-check-set set) set)))))
11574 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11575 "Produce a table with refile targets."
11576 (let ((case-fold-search nil)
11577 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11578 (entries (or org-refile-targets '((nil . (:level . 1)))))
11579 targets tgs txt re files f desc descre fast-path-p level pos0)
11580 (message "Getting targets...")
11581 (with-current-buffer (or default-buffer (current-buffer))
11582 (while (setq entry (pop entries))
11583 (setq files (car entry) desc (cdr entry))
11584 (setq fast-path-p nil)
11585 (cond
11586 ((null files) (setq files (list (current-buffer))))
11587 ((eq files 'org-agenda-files)
11588 (setq files (org-agenda-files 'unrestricted)))
11589 ((and (symbolp files) (fboundp files))
11590 (setq files (funcall files)))
11591 ((and (symbolp files) (boundp files))
11592 (setq files (symbol-value files))))
11593 (if (stringp files) (setq files (list files)))
11594 (cond
11595 ((eq (car desc) :tag)
11596 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11597 ((eq (car desc) :todo)
11598 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11599 ((eq (car desc) :regexp)
11600 (setq descre (cdr desc)))
11601 ((eq (car desc) :level)
11602 (setq descre (concat "^\\*\\{" (number-to-string
11603 (if org-odd-levels-only
11604 (1- (* 2 (cdr desc)))
11605 (cdr desc)))
11606 "\\}[ \t]")))
11607 ((eq (car desc) :maxlevel)
11608 (setq fast-path-p t)
11609 (setq descre (concat "^\\*\\{1," (number-to-string
11610 (if org-odd-levels-only
11611 (1- (* 2 (cdr desc)))
11612 (cdr desc)))
11613 "\\}[ \t]")))
11614 (t (error "Bad refiling target description %s" desc)))
11615 (while (setq f (pop files))
11616 (with-current-buffer
11617 (if (bufferp f) f (org-get-agenda-file-buffer f))
11619 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11620 (progn
11621 (if (bufferp f) (setq f (buffer-file-name
11622 (buffer-base-buffer f))))
11623 (setq f (and f (expand-file-name f)))
11624 (if (eq org-refile-use-outline-path 'file)
11625 (push (list (file-name-nondirectory f) f nil nil) tgs))
11626 (save-excursion
11627 (save-restriction
11628 (widen)
11629 (goto-char (point-min))
11630 (while (re-search-forward descre nil t)
11631 (goto-char (setq pos0 (point-at-bol)))
11632 (catch 'next
11633 (when org-refile-target-verify-function
11634 (save-match-data
11635 (or (funcall org-refile-target-verify-function)
11636 (throw 'next t))))
11637 (when (and (looking-at org-complex-heading-regexp)
11638 (not (member (match-string 4) excluded-entries))
11639 (match-string 4))
11640 (setq level (org-reduced-level
11641 (- (match-end 1) (match-beginning 1)))
11642 txt (org-link-display-format (match-string 4))
11643 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11644 re (format org-complex-heading-regexp-format
11645 (regexp-quote (match-string 4))))
11646 (when org-refile-use-outline-path
11647 (setq txt (mapconcat
11648 'org-protect-slash
11649 (append
11650 (if (eq org-refile-use-outline-path
11651 'file)
11652 (list (file-name-nondirectory
11653 (buffer-file-name
11654 (buffer-base-buffer))))
11655 (if (eq org-refile-use-outline-path
11656 'full-file-path)
11657 (list (buffer-file-name
11658 (buffer-base-buffer)))))
11659 (org-get-outline-path fast-path-p
11660 level txt)
11661 (list txt))
11662 "/")))
11663 (push (list txt f re (org-refile-marker (point)))
11664 tgs)))
11665 (when (= (point) pos0)
11666 ;; verification function has not moved point
11667 (goto-char (point-at-eol))))))))
11668 (when org-refile-use-cache
11669 (org-refile-cache-put tgs (buffer-file-name) descre))
11670 (setq targets (append tgs targets))))))
11671 (message "Getting targets...done")
11672 (nreverse targets)))
11674 (defun org-protect-slash (s)
11675 (while (string-match "/" s)
11676 (setq s (replace-match "\\" t t s)))
11679 (defvar org-olpa (make-vector 20 nil))
11681 (defun org-get-outline-path (&optional fastp level heading)
11682 "Return the outline path to the current entry, as a list.
11684 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11685 routine which makes outline path derivations for an entire file,
11686 avoiding backtracing. Refile target collection makes use of that."
11687 (if fastp
11688 (progn
11689 (if (> level 19)
11690 (error "Outline path failure, more than 19 levels"))
11691 (loop for i from level upto 19 do
11692 (aset org-olpa i nil))
11693 (prog1
11694 (delq nil (append org-olpa nil))
11695 (aset org-olpa level heading)))
11696 (let (rtn case-fold-search)
11697 (save-excursion
11698 (save-restriction
11699 (widen)
11700 (while (org-up-heading-safe)
11701 (when (looking-at org-complex-heading-regexp)
11702 (push (org-trim
11703 (replace-regexp-in-string
11704 ;; Remove statistical/checkboxes cookies
11705 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11706 (org-match-string-no-properties 4)))
11707 rtn)))
11708 rtn)))))
11710 (defun org-format-outline-path (path &optional width prefix separator)
11711 "Format the outline path PATH for display.
11712 WIDTH is the maximum number of characters that is available.
11713 PREFIX is a prefix to be included in the returned string,
11714 such as the file name.
11715 SEPARATOR is inserted between the different parts of the path,
11716 the default is \"/\"."
11717 (setq width (or width 79))
11718 (if prefix (setq width (- width (length prefix))))
11719 (if (not path)
11720 (or prefix "")
11721 (let* ((nsteps (length path))
11722 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11723 (maxwidth (if (<= total-width width)
11724 10000 ;; everything fits
11725 ;; we need to shorten the level headings
11726 (/ (- width nsteps) nsteps)))
11727 (org-odd-levels-only nil)
11728 (n 0)
11729 (total (1+ (length prefix))))
11730 (setq maxwidth (max maxwidth 10))
11731 (concat prefix
11732 (if prefix (or separator "/"))
11733 (mapconcat
11734 (lambda (h)
11735 (setq n (1+ n))
11736 (if (and (= n nsteps) (< maxwidth 10000))
11737 (setq maxwidth (- total-width total)))
11738 (if (< (length h) maxwidth)
11739 (progn (setq total (+ total (length h) 1)) h)
11740 (setq h (substring h 0 (- maxwidth 2))
11741 total (+ total maxwidth 1))
11742 (if (string-match "[ \t]+\\'" h)
11743 (setq h (substring h 0 (match-beginning 0))))
11744 (setq h (concat h "..")))
11745 (org-add-props h nil 'face
11746 (nth (% (1- n) org-n-level-faces)
11747 org-level-faces))
11749 path (or separator "/"))))))
11751 (defun org-display-outline-path (&optional file current separator just-return-string)
11752 "Display the current outline path in the echo area.
11754 If FILE is non-nil, prepend the output with the file name.
11755 If CURRENT is non-nil, append the current heading to the output.
11756 SEPARATOR is passed through to `org-format-outline-path'. It separates
11757 the different parts of the path and defaults to \"/\".
11758 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11759 (interactive "P")
11760 (let* (case-fold-search
11761 (bfn (buffer-file-name (buffer-base-buffer)))
11762 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11763 res)
11764 (if current (setq path (append path
11765 (save-excursion
11766 (org-back-to-heading t)
11767 (if (looking-at org-complex-heading-regexp)
11768 (list (match-string 4)))))))
11769 (setq res
11770 (org-format-outline-path
11771 path
11772 (1- (frame-width))
11773 (and file bfn (concat (file-name-nondirectory bfn) separator))
11774 separator))
11775 (if just-return-string
11776 (org-no-properties res)
11777 (org-unlogged-message "%s" res))))
11779 (defvar org-refile-history nil
11780 "History for refiling operations.")
11782 (defvar org-after-refile-insert-hook nil
11783 "Hook run after `org-refile' has inserted its stuff at the new location.
11784 Note that this is still *before* the stuff will be removed from
11785 the *old* location.")
11787 (defvar org-capture-last-stored-marker)
11788 (defvar org-refile-keep nil
11789 "Non-nil means `org-refile' will copy instead of refile.")
11791 (defun org-copy ()
11792 "Like `org-refile', but copy."
11793 (interactive)
11794 (let ((org-refile-keep t))
11795 (funcall 'org-refile nil nil nil "Copy")))
11797 (defun org-refile (&optional arg default-buffer rfloc msg)
11798 "Move the entry or entries at point to another heading.
11799 The list of target headings is compiled using the information in
11800 `org-refile-targets', which see.
11802 At the target location, the entry is filed as a subitem of the
11803 target heading. Depending on `org-reverse-note-order', the new
11804 subitem will either be the first or the last subitem.
11806 If there is an active region, all entries in that region will be
11807 refiled. However, the region must fulfill the requirement that
11808 the first heading sets the top-level of the moved text.
11810 With prefix arg ARG, the command will only visit the target
11811 location and not actually move anything.
11813 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11814 refiling operation has put the subtree.
11816 With a numeric prefix argument of `2', refile to the running clock.
11818 With a numeric prefix argument of `3', emulate `org-refile-keep'
11819 being set to `t' and copy to the target location, don't move it.
11820 Beware that keeping refiled entries may result in duplicated ID
11821 properties.
11823 RFLOC can be a refile location obtained in a different way.
11825 MSG is a string to replace \"Refile\" in the default prompt with
11826 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11828 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11830 If you are using target caching (see `org-refile-use-cache'), you
11831 have to clear the target cache in order to find new targets.
11832 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11833 prefix argument (`C-u C-u C-u C-c C-w')."
11834 (interactive "P")
11835 (if (member arg '(0 (64)))
11836 (org-refile-cache-clear)
11837 (let* ((actionmsg (cond (msg msg)
11838 ((equal arg 3) "Refile (and keep)")
11839 (t "Refile")))
11840 (cbuf (current-buffer))
11841 (regionp (org-region-active-p))
11842 (region-start (and regionp (region-beginning)))
11843 (region-end (and regionp (region-end)))
11844 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11845 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11846 pos it nbuf file re level reversed)
11847 (setq last-command nil)
11848 (when regionp
11849 (goto-char region-start)
11850 (or (bolp) (goto-char (point-at-bol)))
11851 (setq region-start (point))
11852 (unless (or (org-kill-is-subtree-p
11853 (buffer-substring region-start region-end))
11854 (prog1 org-refile-active-region-within-subtree
11855 (let ((s (point-at-eol)))
11856 (org-toggle-heading)
11857 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11858 (user-error "The region is not a (sequence of) subtree(s)")))
11859 (if (equal arg '(16))
11860 (org-refile-goto-last-stored)
11861 (when (or
11862 (and (equal arg 2)
11863 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11864 (prog1
11865 (setq it (list (or org-clock-heading "running clock")
11866 (buffer-file-name
11867 (marker-buffer org-clock-hd-marker))
11869 (marker-position org-clock-hd-marker)))
11870 (setq arg nil)))
11871 (setq it (or rfloc
11872 (let (heading-text)
11873 (save-excursion
11874 (unless (and arg (listp arg))
11875 (org-back-to-heading t)
11876 (setq heading-text
11877 (replace-regexp-in-string
11878 org-bracket-link-regexp
11879 "\\3"
11880 (nth 4 (org-heading-components)))))
11881 (org-refile-get-location
11882 (cond ((and arg (listp arg)) "Goto")
11883 (regionp (concat actionmsg " region to"))
11884 (t (concat actionmsg " subtree \""
11885 heading-text "\" to")))
11886 default-buffer
11887 (and (not (equal '(4) arg))
11888 org-refile-allow-creating-parent-nodes)
11889 arg))))))
11890 (setq file (nth 1 it)
11891 re (nth 2 it)
11892 pos (nth 3 it))
11893 (if (and (not arg)
11895 (equal (buffer-file-name) file)
11896 (if regionp
11897 (and (>= pos region-start)
11898 (<= pos region-end))
11899 (and (>= pos (point))
11900 (< pos (save-excursion
11901 (org-end-of-subtree t t))))))
11902 (error "Cannot refile to position inside the tree or region"))
11903 (setq nbuf (or (find-buffer-visiting file)
11904 (find-file-noselect file)))
11905 (if (and arg (not (equal arg 3)))
11906 (progn
11907 (org-pop-to-buffer-same-window nbuf)
11908 (goto-char pos)
11909 (org-show-context 'org-goto))
11910 (if regionp
11911 (progn
11912 (org-kill-new (buffer-substring region-start region-end))
11913 (org-save-markers-in-region region-start region-end))
11914 (org-copy-subtree 1 nil t))
11915 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11916 (find-file-noselect file)))
11917 (setq reversed (org-notes-order-reversed-p))
11918 (save-excursion
11919 (save-restriction
11920 (widen)
11921 (if pos
11922 (progn
11923 (goto-char pos)
11924 (looking-at org-outline-regexp)
11925 (setq level (org-get-valid-level (funcall outline-level) 1))
11926 (goto-char
11927 (if reversed
11928 (or (outline-next-heading) (point-max))
11929 (or (save-excursion (org-get-next-sibling))
11930 (org-end-of-subtree t t)
11931 (point-max)))))
11932 (setq level 1)
11933 (if (not reversed)
11934 (goto-char (point-max))
11935 (goto-char (point-min))
11936 (or (outline-next-heading) (goto-char (point-max)))))
11937 (if (not (bolp)) (newline))
11938 (org-paste-subtree level nil nil t)
11939 (when org-log-refile
11940 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11941 (unless (eq org-log-refile 'note)
11942 (save-excursion (org-add-log-note))))
11943 (and org-auto-align-tags
11944 (let ((org-loop-over-headlines-in-active-region nil))
11945 (org-set-tags nil t)))
11946 (let ((bookmark-name (plist-get org-bookmark-names-plist
11947 :last-refile)))
11948 (when bookmark-name
11949 (with-demoted-errors
11950 (bookmark-set bookmark-name))))
11951 ;; If we are refiling for capture, make sure that the
11952 ;; last-capture pointers point here
11953 (when (org-bound-and-true-p org-refile-for-capture)
11954 (let ((bookmark-name (plist-get org-bookmark-names-plist
11955 :last-capture-marker)))
11956 (when bookmark-name
11957 (with-demoted-errors
11958 (bookmark-set bookmark-name))))
11959 (move-marker org-capture-last-stored-marker (point)))
11960 (if (fboundp 'deactivate-mark) (deactivate-mark))
11961 (run-hooks 'org-after-refile-insert-hook))))
11962 (unless org-refile-keep
11963 (if regionp
11964 (delete-region (point) (+ (point) (- region-end region-start)))
11965 (delete-region
11966 (and (org-back-to-heading t) (point))
11967 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11968 (when (featurep 'org-inlinetask)
11969 (org-inlinetask-remove-END-maybe))
11970 (setq org-markers-to-move nil)
11971 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11973 (defun org-refile-goto-last-stored ()
11974 "Go to the location where the last refile was stored."
11975 (interactive)
11976 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11977 (message "This is the location of the last refile"))
11979 (defun org-refile--get-location (refloc tbl)
11980 "When user refile to REFLOC, find the associated target in TBL.
11981 Also check `org-refile-target-table'."
11982 (car (delq
11984 (mapcar
11985 (lambda (r) (or (assoc r tbl)
11986 (assoc r org-refile-target-table)))
11987 (list (replace-regexp-in-string "/$" "" refloc)
11988 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11990 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11991 no-exclude)
11992 "Prompt the user for a refile location, using PROMPT.
11993 PROMPT should not be suffixed with a colon and a space, because
11994 this function appends the default value from
11995 `org-refile-history' automatically, if that is not empty.
11996 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11997 this is used for the GOTO interface."
11998 (let ((org-refile-targets org-refile-targets)
11999 (org-refile-use-outline-path org-refile-use-outline-path)
12000 excluded-entries)
12001 (when (and (derived-mode-p 'org-mode)
12002 (not org-refile-use-cache)
12003 (not no-exclude))
12004 (org-map-tree
12005 (lambda()
12006 (setq excluded-entries
12007 (append excluded-entries (list (org-get-heading t t)))))))
12008 (setq org-refile-target-table
12009 (org-refile-get-targets default-buffer excluded-entries)))
12010 (unless org-refile-target-table
12011 (user-error "No refile targets"))
12012 (let* ((cbuf (current-buffer))
12013 (partial-completion-mode nil)
12014 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12015 (cfunc (if (and org-refile-use-outline-path
12016 org-outline-path-complete-in-steps)
12017 'org-olpath-completing-read
12018 'org-icompleting-read))
12019 (extra (if org-refile-use-outline-path "/" ""))
12020 (cbnex (concat (buffer-name) extra))
12021 (filename (and cfn (expand-file-name cfn)))
12022 (tbl (mapcar
12023 (lambda (x)
12024 (if (and (not (member org-refile-use-outline-path
12025 '(file full-file-path)))
12026 (not (equal filename (nth 1 x))))
12027 (cons (concat (car x) extra " ("
12028 (file-name-nondirectory (nth 1 x)) ")")
12029 (cdr x))
12030 (cons (concat (car x) extra) (cdr x))))
12031 org-refile-target-table))
12032 (completion-ignore-case t)
12033 cdef
12034 (prompt (concat prompt
12035 (or (and (car org-refile-history)
12036 (concat " (default " (car org-refile-history) ")"))
12037 (and (assoc cbnex tbl) (setq cdef cbnex)
12038 (concat " (default " cbnex ")"))) ": "))
12039 pa answ parent-target child parent old-hist)
12040 (setq old-hist org-refile-history)
12041 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12042 nil 'org-refile-history (or cdef (car org-refile-history))))
12043 (if (setq pa (org-refile--get-location answ tbl))
12044 (progn
12045 (org-refile-check-position pa)
12046 (when (or (not org-refile-history)
12047 (not (eq old-hist org-refile-history))
12048 (not (equal (car pa) (car org-refile-history))))
12049 (setq org-refile-history
12050 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12051 org-refile-history
12052 (cdr org-refile-history))))
12053 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12054 (pop org-refile-history)))
12056 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12057 (progn
12058 (setq parent (match-string 1 answ)
12059 child (match-string 2 answ))
12060 (setq parent-target (org-refile--get-location parent tbl))
12061 (when (and parent-target
12062 (or (eq new-nodes t)
12063 (and (eq new-nodes 'confirm)
12064 (y-or-n-p (format "Create new node \"%s\"? "
12065 child)))))
12066 (org-refile-new-child parent-target child)))
12067 (user-error "Invalid target location")))))
12069 (declare-function org-string-nw-p "org-macs" (s))
12070 (defun org-refile-check-position (refile-pointer)
12071 "Check if the refile pointer matches the headline to which it points."
12072 (let* ((file (nth 1 refile-pointer))
12073 (re (nth 2 refile-pointer))
12074 (pos (nth 3 refile-pointer))
12075 buffer)
12076 (if (and (not (markerp pos)) (not file))
12077 (user-error "Please indicate a target file in the refile path")
12078 (when (org-string-nw-p re)
12079 (setq buffer (if (markerp pos)
12080 (marker-buffer pos)
12081 (or (find-buffer-visiting file)
12082 (find-file-noselect file))))
12083 (with-current-buffer buffer
12084 (save-excursion
12085 (save-restriction
12086 (widen)
12087 (goto-char pos)
12088 (beginning-of-line 1)
12089 (unless (org-looking-at-p re)
12090 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12092 (defun org-refile-new-child (parent-target child)
12093 "Use refile target PARENT-TARGET to add new CHILD below it."
12094 (unless parent-target
12095 (error "Cannot find parent for new node"))
12096 (let ((file (nth 1 parent-target))
12097 (pos (nth 3 parent-target))
12098 level)
12099 (with-current-buffer (or (find-buffer-visiting file)
12100 (find-file-noselect file))
12101 (save-excursion
12102 (save-restriction
12103 (widen)
12104 (if pos
12105 (goto-char pos)
12106 (goto-char (point-max))
12107 (if (not (bolp)) (newline)))
12108 (when (looking-at org-outline-regexp)
12109 (setq level (funcall outline-level))
12110 (org-end-of-subtree t t))
12111 (org-back-over-empty-lines)
12112 (insert "\n" (make-string
12113 (if pos (org-get-valid-level level 1) 1) ?*)
12114 " " child "\n")
12115 (beginning-of-line 0)
12116 (list (concat (car parent-target) "/" child) file "" (point)))))))
12118 (defun org-olpath-completing-read (prompt collection &rest args)
12119 "Read an outline path like a file name."
12120 (let ((thetable collection)
12121 (org-completion-use-ido nil) ; does not work with ido.
12122 (org-completion-use-iswitchb nil)) ; or iswitchb
12123 (apply
12124 'org-icompleting-read prompt
12125 (lambda (string predicate &optional flag)
12126 (let (rtn r f (l (length string)))
12127 (cond
12128 ((eq flag nil)
12129 ;; try completion
12130 (try-completion string thetable))
12131 ((eq flag t)
12132 ;; all-completions
12133 (setq rtn (all-completions string thetable predicate))
12134 (mapcar
12135 (lambda (x)
12136 (setq r (substring x l))
12137 (if (string-match " ([^)]*)$" x)
12138 (setq f (match-string 0 x))
12139 (setq f ""))
12140 (if (string-match "/" r)
12141 (concat string (substring r 0 (match-end 0)) f)
12143 rtn))
12144 ((eq flag 'lambda)
12145 ;; exact match?
12146 (assoc string thetable)))))
12147 args)))
12149 ;;;; Dynamic blocks
12151 (defun org-find-dblock (name)
12152 "Find the first dynamic block with name NAME in the buffer.
12153 If not found, stay at current position and return nil."
12154 (let ((case-fold-search t) pos)
12155 (save-excursion
12156 (goto-char (point-min))
12157 (setq pos (and (re-search-forward
12158 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12159 (match-beginning 0))))
12160 (if pos (goto-char pos))
12161 pos))
12163 (defun org-create-dblock (plist)
12164 "Create a dynamic block section, with parameters taken from PLIST.
12165 PLIST must contain a :name entry which is used as the name of the block."
12166 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12167 (end-of-line 1)
12168 (newline))
12169 (let ((col (current-column))
12170 (name (plist-get plist :name)))
12171 (insert "#+BEGIN: " name)
12172 (while plist
12173 (if (eq (car plist) :name)
12174 (setq plist (cddr plist))
12175 (insert " " (prin1-to-string (pop plist)))))
12176 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12177 (beginning-of-line -2)))
12179 (defun org-prepare-dblock ()
12180 "Prepare dynamic block for refresh.
12181 This empties the block, puts the cursor at the insert position and returns
12182 the property list including an extra property :name with the block name."
12183 (unless (looking-at org-dblock-start-re)
12184 (user-error "Not at a dynamic block"))
12185 (let* ((begdel (1+ (match-end 0)))
12186 (name (org-no-properties (match-string 1)))
12187 (params (append (list :name name)
12188 (read (concat "(" (match-string 3) ")")))))
12189 (save-excursion
12190 (beginning-of-line 1)
12191 (skip-chars-forward " \t")
12192 (setq params (plist-put params :indentation-column (current-column))))
12193 (unless (re-search-forward org-dblock-end-re nil t)
12194 (error "Dynamic block not terminated"))
12195 (setq params
12196 (append params
12197 (list :content (buffer-substring
12198 begdel (match-beginning 0)))))
12199 (delete-region begdel (match-beginning 0))
12200 (goto-char begdel)
12201 (open-line 1)
12202 params))
12204 (defun org-map-dblocks (&optional command)
12205 "Apply COMMAND to all dynamic blocks in the current buffer.
12206 If COMMAND is not given, use `org-update-dblock'."
12207 (let ((cmd (or command 'org-update-dblock)))
12208 (save-excursion
12209 (goto-char (point-min))
12210 (while (re-search-forward org-dblock-start-re nil t)
12211 (goto-char (match-beginning 0))
12212 (save-excursion
12213 (condition-case nil
12214 (funcall cmd)
12215 (error (message "Error during update of dynamic block"))))
12216 (unless (re-search-forward org-dblock-end-re nil t)
12217 (error "Dynamic block not terminated"))))))
12219 (defun org-dblock-update (&optional arg)
12220 "User command for updating dynamic blocks.
12221 Update the dynamic block at point. With prefix ARG, update all dynamic
12222 blocks in the buffer."
12223 (interactive "P")
12224 (if arg
12225 (org-update-all-dblocks)
12226 (or (looking-at org-dblock-start-re)
12227 (org-beginning-of-dblock))
12228 (org-update-dblock)))
12230 (defun org-update-dblock ()
12231 "Update the dynamic block at point.
12232 This means to empty the block, parse for parameters and then call
12233 the correct writing function."
12234 (interactive)
12235 (save-excursion
12236 (let* ((win (selected-window))
12237 (pos (point))
12238 (line (org-current-line))
12239 (params (org-prepare-dblock))
12240 (name (plist-get params :name))
12241 (indent (plist-get params :indentation-column))
12242 (cmd (intern (concat "org-dblock-write:" name))))
12243 (message "Updating dynamic block `%s' at line %d..." name line)
12244 (funcall cmd params)
12245 (message "Updating dynamic block `%s' at line %d...done" name line)
12246 (goto-char pos)
12247 (when (and indent (> indent 0))
12248 (setq indent (make-string indent ?\ ))
12249 (save-excursion
12250 (select-window win)
12251 (org-beginning-of-dblock)
12252 (forward-line 1)
12253 (while (not (looking-at org-dblock-end-re))
12254 (insert indent)
12255 (beginning-of-line 2))
12256 (when (looking-at org-dblock-end-re)
12257 (and (looking-at "[ \t]+")
12258 (replace-match ""))
12259 (insert indent)))))))
12261 (defun org-beginning-of-dblock ()
12262 "Find the beginning of the dynamic block at point.
12263 Error if there is no such block at point."
12264 (let ((pos (point))
12265 beg)
12266 (end-of-line 1)
12267 (if (and (re-search-backward org-dblock-start-re nil t)
12268 (setq beg (match-beginning 0))
12269 (re-search-forward org-dblock-end-re nil t)
12270 (> (match-end 0) pos))
12271 (goto-char beg)
12272 (goto-char pos)
12273 (error "Not in a dynamic block"))))
12275 (defun org-update-all-dblocks ()
12276 "Update all dynamic blocks in the buffer.
12277 This function can be used in a hook."
12278 (interactive)
12279 (when (derived-mode-p 'org-mode)
12280 (org-map-dblocks 'org-update-dblock)))
12283 ;;;; Completion
12285 (declare-function org-export-backend-name "org-export" (cl-x))
12286 (declare-function org-export-backend-options "org-export" (cl-x))
12287 (defun org-get-export-keywords ()
12288 "Return a list of all currently understood export keywords.
12289 Export keywords include options, block names, attributes and
12290 keywords relative to each registered export back-end."
12291 (let (keywords)
12292 (dolist (backend
12293 (org-bound-and-true-p org-export--registered-backends)
12294 (delq nil keywords))
12295 ;; Back-end name (for keywords, like #+LATEX:)
12296 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12297 (dolist (option-entry (org-export-backend-options backend))
12298 ;; Back-end options.
12299 (push (nth 1 option-entry) keywords)))))
12301 (defconst org-options-keywords
12302 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12303 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12304 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12305 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12306 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12308 (defcustom org-structure-template-alist
12309 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12310 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12311 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12312 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12313 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12314 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12315 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12316 ("L" "#+LaTeX: ")
12317 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12318 ("H" "#+HTML: ")
12319 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12320 ("A" "#+ASCII: ")
12321 ("i" "#+INDEX: ?")
12322 ("I" "#+INCLUDE: %file ?"))
12323 "Structure completion elements.
12324 This is a list of abbreviation keys and values. The value gets inserted
12325 if you type `<' followed by the key and then press the completion key,
12326 usually `TAB'. %file will be replaced by a file name after prompting
12327 for the file using completion. The cursor will be placed at the position
12328 of the `?` in the template.
12329 There are two templates for each key, the first uses the original Org syntax,
12330 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12331 the default when the /org-mtags.el/ module has been loaded. See also the
12332 variable `org-mtags-prefer-muse-templates'."
12333 :group 'org-completion
12334 :type '(repeat
12335 (list
12336 (string :tag "Key")
12337 (string :tag "Template")))
12338 :version "25.1"
12339 :package-version '(Org . "8.3"))
12341 (defun org-try-structure-completion ()
12342 "Try to complete a structure template before point.
12343 This looks for strings like \"<e\" on an otherwise empty line and
12344 expands them."
12345 (let ((l (buffer-substring (point-at-bol) (point)))
12347 (when (and (looking-at "[ \t]*$")
12348 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12349 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12350 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12351 (match-beginning 1)) a)
12352 t)))
12354 (defun org-complete-expand-structure-template (start cell)
12355 "Expand a structure template."
12356 (let ((rpl (nth 1 cell))
12357 (ind ""))
12358 (delete-region start (point))
12359 (when (string-match "\\`[ \t]*#\\+" rpl)
12360 (cond
12361 ((bolp))
12362 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12363 (setq ind (buffer-substring (point-at-bol) (point))))
12364 (t (newline))))
12365 (setq start (point))
12366 (if (string-match "%file" rpl)
12367 (setq rpl (replace-match
12368 (concat
12369 "\""
12370 (save-match-data
12371 (abbreviate-file-name (read-file-name "Include file: ")))
12372 "\"")
12373 t t rpl)))
12374 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12375 (concat "\n" ind)))
12376 (insert rpl)
12377 (if (re-search-backward "\\?" start t) (delete-char 1))))
12379 ;;;; TODO, DEADLINE, Comments
12381 (defun org-toggle-comment ()
12382 "Change the COMMENT state of an entry."
12383 (interactive)
12384 (save-excursion
12385 (org-back-to-heading)
12386 (looking-at org-complex-heading-regexp)
12387 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12388 (skip-chars-forward " \t")
12389 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12390 (if (org-in-commented-heading-p t)
12391 (delete-region (point)
12392 (progn (search-forward " " (line-end-position) 'move)
12393 (skip-chars-forward " \t")
12394 (point)))
12395 (insert org-comment-string)
12396 (unless (eolp) (insert " ")))))
12398 (defvar org-last-todo-state-is-todo nil
12399 "This is non-nil when the last TODO state change led to a TODO state.
12400 If the last change removed the TODO tag or switched to DONE, then
12401 this is nil.")
12403 (defvar org-setting-tags nil) ; dynamically skipped
12405 (defvar org-todo-setup-filter-hook nil
12406 "Hook for functions that pre-filter todo specs.
12407 Each function takes a todo spec and returns either nil or the spec
12408 transformed into canonical form." )
12410 (defvar org-todo-get-default-hook nil
12411 "Hook for functions that get a default item for todo.
12412 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12413 nil or a string to be used for the todo mark." )
12415 (defvar org-agenda-headline-snapshot-before-repeat)
12417 (defun org-current-effective-time ()
12418 "Return current time adjusted for `org-extend-today-until' variable."
12419 (let* ((ct (org-current-time))
12420 (dct (decode-time ct))
12421 (ct1
12422 (cond
12423 (org-use-last-clock-out-time-as-effective-time
12424 (or (org-clock-get-last-clock-out-time) ct))
12425 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12426 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12427 (t ct))))
12428 ct1))
12430 (defun org-todo-yesterday (&optional arg)
12431 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12432 (interactive "P")
12433 (if (eq major-mode 'org-agenda-mode)
12434 (apply 'org-agenda-todo-yesterday arg)
12435 (let* ((org-use-effective-time t)
12436 (hour (third (decode-time
12437 (org-current-time))))
12438 (org-extend-today-until (1+ hour)))
12439 (org-todo arg))))
12441 (defvar org-block-entry-blocking ""
12442 "First entry preventing the TODO state change.")
12444 (defun org-cancel-repeater ()
12445 "Cancel a repeater by setting its numeric value to zero."
12446 (interactive)
12447 (save-excursion
12448 (org-back-to-heading t)
12449 (let ((bound1 (point))
12450 (bound0 (save-excursion (outline-next-heading) (point))))
12451 (when (re-search-forward
12452 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12453 org-deadline-time-regexp "\\)\\|\\("
12454 org-ts-regexp "\\)")
12455 bound0 t)
12456 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12457 (replace-match "0" t nil nil 1))))))
12459 (defun org-todo (&optional arg)
12460 "Change the TODO state of an item.
12461 The state of an item is given by a keyword at the start of the heading,
12462 like
12463 *** TODO Write paper
12464 *** DONE Call mom
12466 The different keywords are specified in the variable `org-todo-keywords'.
12467 By default the available states are \"TODO\" and \"DONE\".
12468 So for this example: when the item starts with TODO, it is changed to DONE.
12469 When it starts with DONE, the DONE is removed. And when neither TODO nor
12470 DONE are present, add TODO at the beginning of the heading.
12472 With \\[universal-argument] prefix arg, use completion to determine the new \
12473 state.
12474 With numeric prefix arg, switch to that state.
12475 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12476 keywords (nextset).
12477 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12478 With a numeric prefix arg of 0, inhibit note taking for the change.
12479 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12481 When called through ELisp, arg is also interpreted in the following way:
12482 'none -> empty state
12483 \"\"(empty string) -> switch to empty state
12484 'done -> switch to DONE
12485 'nextset -> switch to the next set of keywords
12486 'previousset -> switch to the previous set of keywords
12487 \"WAITING\" -> switch to the specified keyword, but only if it
12488 really is a member of `org-todo-keywords'."
12489 (interactive "P")
12490 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12491 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12492 'region-start-level 'region))
12493 org-loop-over-headlines-in-active-region)
12494 (org-map-entries
12495 `(org-todo ,arg)
12496 org-loop-over-headlines-in-active-region
12497 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12498 (if (equal arg '(16)) (setq arg 'nextset))
12499 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12500 (let ((org-blocker-hook org-blocker-hook)
12501 commentp
12502 case-fold-search)
12503 (when (equal arg '(64))
12504 (setq arg nil org-blocker-hook nil))
12505 (when (and org-blocker-hook
12506 (or org-inhibit-blocking
12507 (org-entry-get nil "NOBLOCKING")))
12508 (setq org-blocker-hook nil))
12509 (save-excursion
12510 (catch 'exit
12511 (org-back-to-heading t)
12512 (when (org-in-commented-heading-p t)
12513 (org-toggle-comment)
12514 (setq commentp t))
12515 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12516 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12517 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12518 (let* ((match-data (match-data))
12519 (startpos (point-at-bol))
12520 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12521 (org-log-done org-log-done)
12522 (org-log-repeat org-log-repeat)
12523 (org-todo-log-states org-todo-log-states)
12524 (org-inhibit-logging
12525 (if (equal arg 0)
12526 (progn (setq arg nil) 'note) org-inhibit-logging))
12527 (this (match-string 1))
12528 (hl-pos (match-beginning 0))
12529 (head (org-get-todo-sequence-head this))
12530 (ass (assoc head org-todo-kwd-alist))
12531 (interpret (nth 1 ass))
12532 (done-word (nth 3 ass))
12533 (final-done-word (nth 4 ass))
12534 (org-last-state (or this ""))
12535 (completion-ignore-case t)
12536 (member (member this org-todo-keywords-1))
12537 (tail (cdr member))
12538 (org-state (cond
12539 ((and org-todo-key-trigger
12540 (or (and (equal arg '(4))
12541 (eq org-use-fast-todo-selection 'prefix))
12542 (and (not arg) org-use-fast-todo-selection
12543 (not (eq org-use-fast-todo-selection
12544 'prefix)))))
12545 ;; Use fast selection
12546 (org-fast-todo-selection))
12547 ((and (equal arg '(4))
12548 (or (not org-use-fast-todo-selection)
12549 (not org-todo-key-trigger)))
12550 ;; Read a state with completion
12551 (org-icompleting-read
12552 "State: " (mapcar 'list org-todo-keywords-1)
12553 nil t))
12554 ((eq arg 'right)
12555 (if this
12556 (if tail (car tail) nil)
12557 (car org-todo-keywords-1)))
12558 ((eq arg 'left)
12559 (if (equal member org-todo-keywords-1)
12561 (if this
12562 (nth (- (length org-todo-keywords-1)
12563 (length tail) 2)
12564 org-todo-keywords-1)
12565 (org-last org-todo-keywords-1))))
12566 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12567 (setq arg nil))) ; hack to fall back to cycling
12568 (arg
12569 ;; user or caller requests a specific state
12570 (cond
12571 ((equal arg "") nil)
12572 ((eq arg 'none) nil)
12573 ((eq arg 'done) (or done-word (car org-done-keywords)))
12574 ((eq arg 'nextset)
12575 (or (car (cdr (member head org-todo-heads)))
12576 (car org-todo-heads)))
12577 ((eq arg 'previousset)
12578 (let ((org-todo-heads (reverse org-todo-heads)))
12579 (or (car (cdr (member head org-todo-heads)))
12580 (car org-todo-heads))))
12581 ((car (member arg org-todo-keywords-1)))
12582 ((stringp arg)
12583 (user-error "State `%s' not valid in this file" arg))
12584 ((nth (1- (prefix-numeric-value arg))
12585 org-todo-keywords-1))))
12586 ((null member) (or head (car org-todo-keywords-1)))
12587 ((equal this final-done-word) nil) ;; -> make empty
12588 ((null tail) nil) ;; -> first entry
12589 ((memq interpret '(type priority))
12590 (if (eq this-command last-command)
12591 (car tail)
12592 (if (> (length tail) 0)
12593 (or done-word (car org-done-keywords))
12594 nil)))
12596 (car tail))))
12597 (org-state (or
12598 (run-hook-with-args-until-success
12599 'org-todo-get-default-hook org-state org-last-state)
12600 org-state))
12601 (next (if org-state (concat " " org-state " ") " "))
12602 (change-plist (list :type 'todo-state-change :from this :to org-state
12603 :position startpos))
12604 dolog now-done-p)
12605 (when org-blocker-hook
12606 (setq org-last-todo-state-is-todo
12607 (not (member this org-done-keywords)))
12608 (unless (save-excursion
12609 (save-match-data
12610 (org-with-wide-buffer
12611 (run-hook-with-args-until-failure
12612 'org-blocker-hook change-plist))))
12613 (if (org-called-interactively-p 'interactive)
12614 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12615 this org-state org-block-entry-blocking)
12616 ;; fail silently
12617 (message "TODO state change from %s to %s blocked (by \"%s\")"
12618 this org-state org-block-entry-blocking)
12619 (throw 'exit nil))))
12620 (store-match-data match-data)
12621 (replace-match next t t)
12622 (cond ((equal this org-state)
12623 (message "TODO state was already %s" (org-trim next)))
12624 ((pos-visible-in-window-p hl-pos)
12625 (message "TODO state changed to %s" (org-trim next))))
12626 (unless head
12627 (setq head (org-get-todo-sequence-head org-state)
12628 ass (assoc head org-todo-kwd-alist)
12629 interpret (nth 1 ass)
12630 done-word (nth 3 ass)
12631 final-done-word (nth 4 ass)))
12632 (when (memq arg '(nextset previousset))
12633 (message "Keyword-Set %d/%d: %s"
12634 (- (length org-todo-sets) -1
12635 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12636 (length org-todo-sets)
12637 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12638 (setq org-last-todo-state-is-todo
12639 (not (member org-state org-done-keywords)))
12640 (setq now-done-p (and (member org-state org-done-keywords)
12641 (not (member this org-done-keywords))))
12642 (and logging (org-local-logging logging))
12643 (when (and (or org-todo-log-states org-log-done)
12644 (not (eq org-inhibit-logging t))
12645 (not (memq arg '(nextset previousset))))
12646 ;; we need to look at recording a time and note
12647 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12648 (nth 2 (assoc this org-todo-log-states))))
12649 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12650 (setq dolog 'time))
12651 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12652 (and org-state
12653 (member org-state org-not-done-keywords)
12654 (not (member this org-not-done-keywords))))
12655 ;; This is now a todo state and was not one before
12656 ;; If there was a CLOSED time stamp, get rid of it.
12657 (org-add-planning-info nil nil 'closed))
12658 (when (and now-done-p org-log-done)
12659 ;; It is now done, and it was not done before
12660 (org-add-planning-info 'closed (org-current-effective-time))
12661 (if (and (not dolog) (eq 'note org-log-done))
12662 (org-add-log-setup 'done org-state this 'findpos 'note)))
12663 (when (and org-state dolog)
12664 ;; This is a non-nil state, and we need to log it
12665 (org-add-log-setup 'state org-state this 'findpos dolog)))
12666 ;; Fixup tag positioning
12667 (org-todo-trigger-tag-changes org-state)
12668 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12669 (when org-provide-todo-statistics
12670 (org-update-parent-todo-statistics))
12671 (run-hooks 'org-after-todo-state-change-hook)
12672 (if (and arg (not (member org-state org-done-keywords)))
12673 (setq head (org-get-todo-sequence-head org-state)))
12674 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12675 ;; Do we need to trigger a repeat?
12676 (when now-done-p
12677 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12678 ;; This is for the agenda, take a snapshot of the headline.
12679 (save-match-data
12680 (setq org-agenda-headline-snapshot-before-repeat
12681 (org-get-heading))))
12682 (org-auto-repeat-maybe org-state))
12683 ;; Fixup cursor location if close to the keyword
12684 (if (and (outline-on-heading-p)
12685 (not (bolp))
12686 (save-excursion (beginning-of-line 1)
12687 (looking-at org-todo-line-regexp))
12688 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12689 (progn
12690 (goto-char (or (match-end 2) (match-end 1)))
12691 (and (looking-at " ") (just-one-space))))
12692 (when org-trigger-hook
12693 (save-excursion
12694 (run-hook-with-args 'org-trigger-hook change-plist)))
12695 (when commentp (org-toggle-comment))))))))
12697 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12698 "Block turning an entry into a TODO, using the hierarchy.
12699 This checks whether the current task should be blocked from state
12700 changes. Such blocking occurs when:
12702 1. The task has children which are not all in a completed state.
12704 2. A task has a parent with the property :ORDERED:, and there
12705 are siblings prior to the current task with incomplete
12706 status.
12708 3. The parent of the task is blocked because it has siblings that should
12709 be done first, or is child of a block grandparent TODO entry."
12711 (if (not org-enforce-todo-dependencies)
12712 t ; if locally turned off don't block
12713 (catch 'dont-block
12714 ;; If this is not a todo state change, or if this entry is already DONE,
12715 ;; do not block
12716 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12717 (member (plist-get change-plist :from)
12718 (cons 'done org-done-keywords))
12719 (member (plist-get change-plist :to)
12720 (cons 'todo org-not-done-keywords))
12721 (not (plist-get change-plist :to)))
12722 (throw 'dont-block t))
12723 ;; If this task has children, and any are undone, it's blocked
12724 (save-excursion
12725 (org-back-to-heading t)
12726 (let ((this-level (funcall outline-level)))
12727 (outline-next-heading)
12728 (let ((child-level (funcall outline-level)))
12729 (while (and (not (eobp))
12730 (> child-level this-level))
12731 ;; this todo has children, check whether they are all
12732 ;; completed
12733 (if (and (not (org-entry-is-done-p))
12734 (org-entry-is-todo-p))
12735 (progn (setq org-block-entry-blocking (org-get-heading))
12736 (throw 'dont-block nil)))
12737 (outline-next-heading)
12738 (setq child-level (funcall outline-level))))))
12739 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12740 ;; any previous siblings are undone, it's blocked
12741 (save-excursion
12742 (org-back-to-heading t)
12743 (let* ((pos (point))
12744 (parent-pos (and (org-up-heading-safe) (point))))
12745 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12746 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12747 (forward-line 1)
12748 (re-search-forward org-not-done-heading-regexp pos t))
12749 (setq org-block-entry-blocking (match-string 0))
12750 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12751 ;; Search further up the hierarchy, to see if an ancestor is blocked
12752 (while t
12753 (goto-char parent-pos)
12754 (if (not (looking-at org-not-done-heading-regexp))
12755 (throw 'dont-block t)) ; do not block, parent is not a TODO
12756 (setq pos (point))
12757 (setq parent-pos (and (org-up-heading-safe) (point)))
12758 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12759 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12760 (forward-line 1)
12761 (re-search-forward org-not-done-heading-regexp pos t)
12762 (setq org-block-entry-blocking (org-get-heading)))
12763 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12765 (defcustom org-track-ordered-property-with-tag nil
12766 "Should the ORDERED property also be shown as a tag?
12767 The ORDERED property decides if an entry should require subtasks to be
12768 completed in sequence. Since a property is not very visible, setting
12769 this option means that toggling the ORDERED property with the command
12770 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12771 not relevant for the behavior, but it makes things more visible.
12773 Note that toggling the tag with tags commands will not change the property
12774 and therefore not influence behavior!
12776 This can be t, meaning the tag ORDERED should be used, It can also be a
12777 string to select a different tag for this task."
12778 :group 'org-todo
12779 :type '(choice
12780 (const :tag "No tracking" nil)
12781 (const :tag "Track with ORDERED tag" t)
12782 (string :tag "Use other tag")))
12784 (defun org-toggle-ordered-property ()
12785 "Toggle the ORDERED property of the current entry.
12786 For better visibility, you can track the value of this property with a tag.
12787 See variable `org-track-ordered-property-with-tag'."
12788 (interactive)
12789 (let* ((t1 org-track-ordered-property-with-tag)
12790 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12791 (save-excursion
12792 (org-back-to-heading)
12793 (if (org-entry-get nil "ORDERED")
12794 (progn
12795 (org-delete-property "ORDERED")
12796 (and tag (org-toggle-tag tag 'off))
12797 (message "Subtasks can be completed in arbitrary order"))
12798 (org-entry-put nil "ORDERED" "t")
12799 (and tag (org-toggle-tag tag 'on))
12800 (message "Subtasks must be completed in sequence")))))
12802 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12803 (defun org-block-todo-from-checkboxes (change-plist)
12804 "Block turning an entry into a TODO, using checkboxes.
12805 This checks whether the current task should be blocked from state
12806 changes because there are unchecked boxes in this entry."
12807 (if (not org-enforce-todo-checkbox-dependencies)
12808 t ; if locally turned off don't block
12809 (catch 'dont-block
12810 ;; If this is not a todo state change, or if this entry is already DONE,
12811 ;; do not block
12812 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12813 (member (plist-get change-plist :from)
12814 (cons 'done org-done-keywords))
12815 (member (plist-get change-plist :to)
12816 (cons 'todo org-not-done-keywords))
12817 (not (plist-get change-plist :to)))
12818 (throw 'dont-block t))
12819 ;; If this task has checkboxes that are not checked, it's blocked
12820 (save-excursion
12821 (org-back-to-heading t)
12822 (let ((beg (point)) end)
12823 (outline-next-heading)
12824 (setq end (point))
12825 (goto-char beg)
12826 (if (org-list-search-forward
12827 (concat (org-item-beginning-re)
12828 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12829 "\\[[- ]\\]")
12830 end t)
12831 (progn
12832 (if (boundp 'org-blocked-by-checkboxes)
12833 (setq org-blocked-by-checkboxes t))
12834 (throw 'dont-block nil)))))
12835 t))) ; do not block
12837 (defun org-entry-blocked-p ()
12838 "Is the current entry blocked?"
12839 (org-with-silent-modifications
12840 (if (org-entry-get nil "NOBLOCKING")
12841 nil ;; Never block this entry
12842 (not (run-hook-with-args-until-failure
12843 'org-blocker-hook
12844 (list :type 'todo-state-change
12845 :position (point)
12846 :from 'todo
12847 :to 'done))))))
12849 (defun org-update-statistics-cookies (all)
12850 "Update the statistics cookie, either from TODO or from checkboxes.
12851 This should be called with the cursor in a line with a statistics cookie."
12852 (interactive "P")
12853 (if all
12854 (progn
12855 (org-update-checkbox-count 'all)
12856 (org-map-entries 'org-update-parent-todo-statistics))
12857 (if (not (org-at-heading-p))
12858 (org-update-checkbox-count)
12859 (let ((pos (point-marker))
12860 end l1 l2)
12861 (ignore-errors (org-back-to-heading t))
12862 (if (not (org-at-heading-p))
12863 (org-update-checkbox-count)
12864 (setq l1 (org-outline-level))
12865 (setq end (save-excursion
12866 (outline-next-heading)
12867 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12868 (point)))
12869 (if (and (save-excursion
12870 (re-search-forward
12871 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12872 (not (save-excursion (re-search-forward
12873 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12874 (org-update-checkbox-count)
12875 (if (and l2 (> l2 l1))
12876 (progn
12877 (goto-char end)
12878 (org-update-parent-todo-statistics))
12879 (goto-char pos)
12880 (beginning-of-line 1)
12881 (while (re-search-forward
12882 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12883 (point-at-eol) t)
12884 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12885 (goto-char pos)
12886 (move-marker pos nil)))))
12888 (defvar org-entry-property-inherited-from) ;; defined below
12889 (defun org-update-parent-todo-statistics ()
12890 "Update any statistics cookie in the parent of the current headline.
12891 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12892 the entire subtree and this will travel up the hierarchy and update
12893 statistics everywhere."
12894 (let* ((prop (save-excursion (org-up-heading-safe)
12895 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12896 (recursive (or (not org-hierarchical-todo-statistics)
12897 (and prop (string-match "\\<recursive\\>" prop))))
12898 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12900 (first t)
12901 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12902 level ltoggle l1 new ndel
12903 (cnt-all 0) (cnt-done 0) is-percent kwd
12904 checkbox-beg ov ovs ove cookie-present)
12905 (catch 'exit
12906 (save-excursion
12907 (beginning-of-line 1)
12908 (setq ltoggle (funcall outline-level))
12909 ;; Three situations are to consider:
12911 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12912 ;; to the top-level ancestor on the headline;
12914 ;; 2. If parent has "recursive" property, repeat up to the
12915 ;; headline setting that property, taking inheritance into
12916 ;; account;
12918 ;; 3. Else, move up to direct parent and proceed only once.
12919 (while (and (setq level (org-up-heading-safe))
12920 (or recursive first)
12921 (>= (point) lim))
12922 (setq first nil cookie-present nil)
12923 (unless (and level
12924 (not (string-match
12925 "\\<checkbox\\>"
12926 (downcase (or (org-entry-get nil "COOKIE_DATA")
12927 "")))))
12928 (throw 'exit nil))
12929 (while (re-search-forward box-re (point-at-eol) t)
12930 (setq cnt-all 0 cnt-done 0 cookie-present t)
12931 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12932 (save-match-data
12933 (unless (outline-next-heading) (throw 'exit nil))
12934 (while (and (looking-at org-complex-heading-regexp)
12935 (> (setq l1 (length (match-string 1))) level))
12936 (setq kwd (and (or recursive (= l1 ltoggle))
12937 (match-string 2)))
12938 (if (or (eq org-provide-todo-statistics 'all-headlines)
12939 (and (eq org-provide-todo-statistics t)
12940 (or (member kwd org-done-keywords)))
12941 (and (listp org-provide-todo-statistics)
12942 (stringp (car org-provide-todo-statistics))
12943 (or (member kwd org-provide-todo-statistics)
12944 (member kwd org-done-keywords)))
12945 (and (listp org-provide-todo-statistics)
12946 (listp (car org-provide-todo-statistics))
12947 (or (member kwd (car org-provide-todo-statistics))
12948 (and (member kwd org-done-keywords)
12949 (member kwd (cadr org-provide-todo-statistics))))))
12950 (setq cnt-all (1+ cnt-all))
12951 (if (eq org-provide-todo-statistics t)
12952 (and kwd (setq cnt-all (1+ cnt-all)))))
12953 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12954 (member kwd org-done-keywords))
12955 (and (listp org-provide-todo-statistics)
12956 (listp (car org-provide-todo-statistics))
12957 (member kwd org-done-keywords)
12958 (member kwd (cadr org-provide-todo-statistics)))
12959 (and (listp org-provide-todo-statistics)
12960 (stringp (car org-provide-todo-statistics))
12961 (member kwd org-done-keywords)))
12962 (setq cnt-done (1+ cnt-done)))
12963 (outline-next-heading)))
12964 (setq new
12965 (if is-percent
12966 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12967 (format "[%d/%d]" cnt-done cnt-all))
12968 ndel (- (match-end 0) checkbox-beg))
12969 ;; handle overlays when updating cookie from column view
12970 (when (setq ov (car (overlays-at checkbox-beg)))
12971 (setq ovs (overlay-start ov) ove (overlay-end ov))
12972 (delete-overlay ov))
12973 (goto-char checkbox-beg)
12974 (insert new)
12975 (delete-region (point) (+ (point) ndel))
12976 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12977 (when ov (move-overlay ov ovs ove)))
12978 (when cookie-present
12979 (run-hook-with-args 'org-after-todo-statistics-hook
12980 cnt-done (- cnt-all cnt-done))))))
12981 (run-hooks 'org-todo-statistics-hook)))
12983 (defvar org-after-todo-statistics-hook nil
12984 "Hook that is called after a TODO statistics cookie has been updated.
12985 Each function is called with two arguments: the number of not-done entries
12986 and the number of done entries.
12988 For example, the following function, when added to this hook, will switch
12989 an entry to DONE when all children are done, and back to TODO when new
12990 entries are set to a TODO status. Note that this hook is only called
12991 when there is a statistics cookie in the headline!
12993 (defun org-summary-todo (n-done n-not-done)
12994 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12995 (let (org-log-done org-log-states) ; turn off logging
12996 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12999 (defvar org-todo-statistics-hook nil
13000 "Hook that is run whenever Org thinks TODO statistics should be updated.
13001 This hook runs even if there is no statistics cookie present, in which case
13002 `org-after-todo-statistics-hook' would not run.")
13004 (defun org-todo-trigger-tag-changes (state)
13005 "Apply the changes defined in `org-todo-state-tags-triggers'."
13006 (let ((l org-todo-state-tags-triggers)
13007 changes)
13008 (when (or (not state) (equal state ""))
13009 (setq changes (append changes (cdr (assoc "" l)))))
13010 (when (and (stringp state) (> (length state) 0))
13011 (setq changes (append changes (cdr (assoc state l)))))
13012 (when (member state org-not-done-keywords)
13013 (setq changes (append changes (cdr (assoc 'todo l)))))
13014 (when (member state org-done-keywords)
13015 (setq changes (append changes (cdr (assoc 'done l)))))
13016 (dolist (c changes)
13017 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13019 (defun org-local-logging (value)
13020 "Get logging settings from a property VALUE."
13021 (let* (words w a)
13022 ;; directly set the variables, they are already local.
13023 (setq org-log-done nil
13024 org-log-repeat nil
13025 org-todo-log-states nil)
13026 (setq words (org-split-string value))
13027 (while (setq w (pop words))
13028 (cond
13029 ((setq a (assoc w org-startup-options))
13030 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13031 (set (nth 1 a) (nth 2 a))))
13032 ((setq a (org-extract-log-state-settings w))
13033 (and (member (car a) org-todo-keywords-1)
13034 (push a org-todo-log-states)))))))
13036 (defun org-get-todo-sequence-head (kwd)
13037 "Return the head of the TODO sequence to which KWD belongs.
13038 If KWD is not set, check if there is a text property remembering the
13039 right sequence."
13040 (let (p)
13041 (cond
13042 ((not kwd)
13043 (or (get-text-property (point-at-bol) 'org-todo-head)
13044 (progn
13045 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13046 nil (point-at-eol)))
13047 (get-text-property p 'org-todo-head))))
13048 ((not (member kwd org-todo-keywords-1))
13049 (car org-todo-keywords-1))
13050 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13052 (defun org-fast-todo-selection ()
13053 "Fast TODO keyword selection with single keys.
13054 Returns the new TODO keyword, or nil if no state change should occur."
13055 (let* ((fulltable org-todo-key-alist)
13056 (done-keywords org-done-keywords) ;; needed for the faces.
13057 (maxlen (apply 'max (mapcar
13058 (lambda (x)
13059 (if (stringp (car x)) (string-width (car x)) 0))
13060 fulltable)))
13061 (expert nil)
13062 (fwidth (+ maxlen 3 1 3))
13063 (ncol (/ (- (window-width) 4) fwidth))
13064 tg cnt e c tbl
13065 groups ingroup)
13066 (save-excursion
13067 (save-window-excursion
13068 (if expert
13069 (set-buffer (get-buffer-create " *Org todo*"))
13070 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13071 (erase-buffer)
13072 (org-set-local 'org-done-keywords done-keywords)
13073 (setq tbl fulltable cnt 0)
13074 (while (setq e (pop tbl))
13075 (cond
13076 ((equal e '(:startgroup))
13077 (push '() groups) (setq ingroup t)
13078 (when (not (= cnt 0))
13079 (setq cnt 0)
13080 (insert "\n"))
13081 (insert "{ "))
13082 ((equal e '(:endgroup))
13083 (setq ingroup nil cnt 0)
13084 (insert "}\n"))
13085 ((equal e '(:newline))
13086 (when (not (= cnt 0))
13087 (setq cnt 0)
13088 (insert "\n")
13089 (setq e (car tbl))
13090 (while (equal (car tbl) '(:newline))
13091 (insert "\n")
13092 (setq tbl (cdr tbl)))))
13094 (setq tg (car e) c (cdr e))
13095 (if ingroup (push tg (car groups)))
13096 (setq tg (org-add-props tg nil 'face
13097 (org-get-todo-face tg)))
13098 (if (and (= cnt 0) (not ingroup)) (insert " "))
13099 (insert "[" c "] " tg (make-string
13100 (- fwidth 4 (length tg)) ?\ ))
13101 (when (= (setq cnt (1+ cnt)) ncol)
13102 (insert "\n")
13103 (if ingroup (insert " "))
13104 (setq cnt 0)))))
13105 (insert "\n")
13106 (goto-char (point-min))
13107 (if (not expert) (org-fit-window-to-buffer))
13108 (message "[a-z..]:Set [SPC]:clear")
13109 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13110 (cond
13111 ((or (= c ?\C-g)
13112 (and (= c ?q) (not (rassoc c fulltable))))
13113 (setq quit-flag t))
13114 ((= c ?\ ) nil)
13115 ((setq e (rassoc c fulltable) tg (car e))
13117 (t (setq quit-flag t)))))))
13119 (defun org-entry-is-todo-p ()
13120 (member (org-get-todo-state) org-not-done-keywords))
13122 (defun org-entry-is-done-p ()
13123 (member (org-get-todo-state) org-done-keywords))
13125 (defun org-get-todo-state ()
13126 "Return the TODO keyword of the current subtree."
13127 (save-excursion
13128 (org-back-to-heading t)
13129 (and (looking-at org-todo-line-regexp)
13130 (match-end 2)
13131 (match-string 2))))
13133 (defun org-at-date-range-p (&optional inactive-ok)
13134 "Is the cursor inside a date range?"
13135 (interactive)
13136 (save-excursion
13137 (catch 'exit
13138 (let ((pos (point)))
13139 (skip-chars-backward "^[<\r\n")
13140 (skip-chars-backward "<[")
13141 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13142 (>= (match-end 0) pos)
13143 (throw 'exit t))
13144 (skip-chars-backward "^<[\r\n")
13145 (skip-chars-backward "<[")
13146 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13147 (>= (match-end 0) pos)
13148 (throw 'exit t)))
13149 nil)))
13151 (defun org-get-repeat (&optional tagline)
13152 "Check if there is a deadline/schedule with repeater in this entry."
13153 (save-match-data
13154 (save-excursion
13155 (org-back-to-heading t)
13156 (and (re-search-forward (if tagline
13157 (concat tagline "\\s-*" org-repeat-re)
13158 org-repeat-re)
13159 (org-entry-end-position) t)
13160 (match-string-no-properties 1)))))
13162 (defvar org-last-changed-timestamp)
13163 (defvar org-last-inserted-timestamp)
13164 (defvar org-log-post-message)
13165 (defvar org-log-note-purpose)
13166 (defvar org-log-note-how nil)
13167 (defvar org-log-note-extra)
13168 (defun org-auto-repeat-maybe (done-word)
13169 "Check if the current headline contains a repeated deadline/schedule.
13170 If yes, set TODO state back to what it was and change the base date
13171 of repeating deadline/scheduled time stamps to new date.
13172 This function is run automatically after each state change to a DONE state."
13173 ;; last-state is dynamically scoped into this function
13174 (let* ((repeat (org-get-repeat))
13175 (aa (assoc org-last-state org-todo-kwd-alist))
13176 (interpret (nth 1 aa))
13177 (head (nth 2 aa))
13178 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13179 (msg "Entry repeats: ")
13180 (org-log-done nil)
13181 (org-todo-log-states nil)
13182 re type n what ts time to-state)
13183 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13184 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13185 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13186 org-todo-repeat-to-state))
13187 (unless (and to-state (member to-state org-todo-keywords-1))
13188 (setq to-state (if (eq interpret 'type) org-last-state head)))
13189 (org-todo to-state)
13190 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13191 (org-entry-put nil "LAST_REPEAT" (format-time-string
13192 (org-time-stamp-format t t))))
13193 (when org-log-repeat
13194 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13195 (memq 'org-add-log-note post-command-hook))
13196 ;; OK, we are already setup for some record
13197 (if (eq org-log-repeat 'note)
13198 ;; make sure we take a note, not only a time stamp
13199 (setq org-log-note-how 'note))
13200 ;; Set up for taking a record
13201 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13202 org-last-state
13203 'findpos org-log-repeat)))
13204 (org-back-to-heading t)
13205 (org-add-planning-info nil nil 'closed)
13206 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13207 org-deadline-time-regexp "\\)\\|\\("
13208 org-ts-regexp "\\)"))
13209 (while (re-search-forward
13210 re (save-excursion (outline-next-heading) (point)) t)
13211 (setq type (if (match-end 1) org-scheduled-string
13212 (if (match-end 3) org-deadline-string "Plain:"))
13213 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13214 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13215 (setq n (string-to-number (match-string 2 ts))
13216 what (match-string 3 ts))
13217 (if (equal what "w") (setq n (* n 7) what "d"))
13218 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13219 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13220 ;; Preparation, see if we need to modify the start date for the change
13221 (when (match-end 1)
13222 (setq time (save-match-data (org-time-string-to-time ts)))
13223 (cond
13224 ((equal (match-string 1 ts) ".")
13225 ;; Shift starting date to today
13226 (org-timestamp-change
13227 (- (org-today) (time-to-days time))
13228 'day))
13229 ((equal (match-string 1 ts) "+")
13230 (let ((nshiftmax 10) (nshift 0))
13231 (while (or (= nshift 0)
13232 (<= (time-to-days time)
13233 (time-to-days (current-time))))
13234 (when (= (incf nshift) nshiftmax)
13235 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13236 (user-error "Abort")))
13237 (org-timestamp-change n (cdr (assoc what whata)))
13238 (org-at-timestamp-p t)
13239 (setq ts (match-string 1))
13240 (setq time (save-match-data (org-time-string-to-time ts)))))
13241 (org-timestamp-change (- n) (cdr (assoc what whata)))
13242 ;; rematch, so that we have everything in place for the real shift
13243 (org-at-timestamp-p t)
13244 (setq ts (match-string 1))
13245 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13246 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13247 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13248 (setq org-log-post-message msg)
13249 (message "%s" msg))))
13251 (defun org-show-todo-tree (arg)
13252 "Make a compact tree which shows all headlines marked with TODO.
13253 The tree will show the lines where the regexp matches, and all higher
13254 headlines above the match.
13255 With a \\[universal-argument] prefix, prompt for a regexp to match.
13256 With a numeric prefix N, construct a sparse tree for the Nth element
13257 of `org-todo-keywords-1'."
13258 (interactive "P")
13259 (let ((case-fold-search nil)
13260 (kwd-re
13261 (cond ((null arg) org-not-done-regexp)
13262 ((equal arg '(4))
13263 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13264 (mapcar 'list org-todo-keywords-1))))
13265 (concat "\\("
13266 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13267 "\\)\\>")))
13268 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13269 (regexp-quote (nth (1- (prefix-numeric-value arg))
13270 org-todo-keywords-1)))
13271 (t (user-error "Invalid prefix argument: %s" arg)))))
13272 (message "%d TODO entries found"
13273 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13275 (defun org-deadline (arg &optional time)
13276 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13277 With one universal prefix argument, remove any deadline from the item.
13278 With two universal prefix arguments, prompt for a warning delay.
13279 With argument TIME, set the deadline at the corresponding date. TIME
13280 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13281 (interactive "P")
13282 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13283 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13284 'region-start-level 'region))
13285 org-loop-over-headlines-in-active-region)
13286 (org-map-entries
13287 `(org-deadline ',arg ,time)
13288 org-loop-over-headlines-in-active-region
13289 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13290 (let* ((old-date (org-entry-get nil "DEADLINE"))
13291 (old-date-time (if old-date (org-time-string-to-time old-date)))
13292 (repeater (and old-date
13293 (string-match
13294 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13295 old-date)
13296 (match-string 1 old-date))))
13297 (cond
13298 ((equal arg '(4))
13299 (when (and old-date org-log-redeadline)
13300 (org-add-log-setup 'deldeadline nil old-date 'findpos
13301 org-log-redeadline))
13302 (org-remove-timestamp-with-keyword org-deadline-string)
13303 (message "Item no longer has a deadline."))
13304 ((equal arg '(16))
13305 (save-excursion
13306 (org-back-to-heading t)
13307 (if (re-search-forward
13308 org-deadline-time-regexp
13309 (save-excursion (outline-next-heading) (point)) t)
13310 (let* ((rpl0 (match-string 1))
13311 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13312 (replace-match
13313 (concat org-deadline-string
13314 " <" rpl
13315 (format " -%dd"
13316 (abs
13317 (- (time-to-days
13318 (save-match-data
13319 (org-read-date nil t nil "Warn starting from" old-date-time)))
13320 (time-to-days old-date-time))))
13321 ">") t t))
13322 (user-error "No deadline information to update"))))
13324 (org-add-planning-info 'deadline time 'closed)
13325 (when (and old-date org-log-redeadline
13326 (not (equal old-date
13327 (substring org-last-inserted-timestamp 1 -1))))
13328 (org-add-log-setup 'redeadline nil old-date 'findpos
13329 org-log-redeadline))
13330 (when repeater
13331 (save-excursion
13332 (org-back-to-heading t)
13333 (when (re-search-forward (concat org-deadline-string " "
13334 org-last-inserted-timestamp)
13335 (save-excursion
13336 (outline-next-heading) (point)) t)
13337 (goto-char (1- (match-end 0)))
13338 (insert " " repeater)
13339 (setq org-last-inserted-timestamp
13340 (concat (substring org-last-inserted-timestamp 0 -1)
13341 " " repeater
13342 (substring org-last-inserted-timestamp -1))))))
13343 (message "Deadline on %s" org-last-inserted-timestamp))))))
13345 (defun org-schedule (arg &optional time)
13346 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13347 With one universal prefix argument, remove any scheduling date from the item.
13348 With two universal prefix arguments, prompt for a delay cookie.
13349 With argument TIME, scheduled at the corresponding date. TIME can
13350 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13351 (interactive "P")
13352 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13353 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13354 'region-start-level 'region))
13355 org-loop-over-headlines-in-active-region)
13356 (org-map-entries
13357 `(org-schedule ',arg ,time)
13358 org-loop-over-headlines-in-active-region
13359 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13360 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13361 (old-date-time (if old-date (org-time-string-to-time old-date)))
13362 (repeater (and old-date
13363 (string-match
13364 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13365 old-date)
13366 (match-string 1 old-date))))
13367 (cond
13368 ((equal arg '(4))
13369 (progn
13370 (when (and old-date org-log-reschedule)
13371 (org-add-log-setup 'delschedule nil old-date 'findpos
13372 org-log-reschedule))
13373 (org-remove-timestamp-with-keyword org-scheduled-string)
13374 (message "Item is no longer scheduled.")))
13375 ((equal arg '(16))
13376 (save-excursion
13377 (org-back-to-heading t)
13378 (if (re-search-forward
13379 org-scheduled-time-regexp
13380 (save-excursion (outline-next-heading) (point)) t)
13381 (let* ((rpl0 (match-string 1))
13382 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13383 (replace-match
13384 (concat org-scheduled-string
13385 " <" rpl
13386 (format " -%dd"
13387 (abs
13388 (- (time-to-days
13389 (save-match-data
13390 (org-read-date nil t nil "Delay until" old-date-time)))
13391 (time-to-days old-date-time))))
13392 ">") t t))
13393 (user-error "No scheduled information to update"))))
13395 (org-add-planning-info 'scheduled time 'closed)
13396 (when (and old-date org-log-reschedule
13397 (not (equal old-date
13398 (substring org-last-inserted-timestamp 1 -1))))
13399 (org-add-log-setup 'reschedule nil old-date 'findpos
13400 org-log-reschedule))
13401 (when repeater
13402 (save-excursion
13403 (org-back-to-heading t)
13404 (when (re-search-forward (concat org-scheduled-string " "
13405 org-last-inserted-timestamp)
13406 (save-excursion
13407 (outline-next-heading) (point)) t)
13408 (goto-char (1- (match-end 0)))
13409 (insert " " repeater)
13410 (setq org-last-inserted-timestamp
13411 (concat (substring org-last-inserted-timestamp 0 -1)
13412 " " repeater
13413 (substring org-last-inserted-timestamp -1))))))
13414 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13416 (defun org-get-scheduled-time (pom &optional inherit)
13417 "Get the scheduled time as a time tuple, of a format suitable
13418 for calling org-schedule with, or if there is no scheduling,
13419 returns nil."
13420 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13421 (when time
13422 (apply 'encode-time (org-parse-time-string time)))))
13424 (defun org-get-deadline-time (pom &optional inherit)
13425 "Get the deadline as a time tuple, of a format suitable for
13426 calling org-deadline with, or if there is no scheduling, returns
13427 nil."
13428 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13429 (when time
13430 (apply 'encode-time (org-parse-time-string time)))))
13432 (defun org-remove-timestamp-with-keyword (keyword)
13433 "Remove all time stamps with KEYWORD in the current entry."
13434 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13435 beg)
13436 (save-excursion
13437 (org-back-to-heading t)
13438 (setq beg (point))
13439 (outline-next-heading)
13440 (while (re-search-backward re beg t)
13441 (replace-match "")
13442 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13443 (equal (char-before) ?\ ))
13444 (backward-delete-char 1)
13445 (if (string-match "^[ \t]*$" (buffer-substring
13446 (point-at-bol) (point-at-eol)))
13447 (delete-region (point-at-bol)
13448 (min (point-max) (1+ (point-at-eol))))))))))
13450 (defvar org-time-was-given) ; dynamically scoped parameter
13451 (defvar org-end-time-was-given) ; dynamically scoped parameter
13453 (defun org-at-planning-p ()
13454 "Non-nil when point is on a planning info line."
13455 ;; This is as accurate and faster than `org-element-at-point' since
13456 ;; planning info location is fixed in the section.
13457 (org-with-wide-buffer
13458 (beginning-of-line)
13459 (and (org-looking-at-p org-planning-line-re)
13460 (eq (point)
13461 (ignore-errors
13462 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13463 (org-back-to-heading t)
13464 (org-with-limited-levels (org-back-to-heading t)))
13465 (line-beginning-position 2))))))
13467 (defun org-add-planning-info (what &optional time &rest remove)
13468 "Insert new timestamp with keyword in the planning line.
13469 WHAT indicates what kind of time stamp to add. It is a symbol
13470 among `closed', `deadline', `scheduled' and nil. TIME indicates
13471 the time to use. If none is given, the user is prompted for
13472 a date. REMOVE indicates what kind of entries to remove. An old
13473 WHAT entry will also be removed."
13474 (let (org-time-was-given org-end-time-was-given default-time default-input)
13475 (catch 'exit
13476 (when (and (memq what '(scheduled deadline))
13477 (or (not time)
13478 (and (stringp time)
13479 (string-match "^[-+]+[0-9]" time))))
13480 ;; Try to get a default date/time from existing timestamp
13481 (save-excursion
13482 (org-back-to-heading t)
13483 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13484 (when (re-search-forward (if (eq what 'scheduled)
13485 org-scheduled-time-regexp
13486 org-deadline-time-regexp)
13487 end t)
13488 (setq ts (match-string 1)
13489 default-time (apply 'encode-time (org-parse-time-string ts))
13490 default-input (and ts (org-get-compact-tod ts)))))))
13491 (when what
13492 (setq time
13493 (if (stringp time)
13494 ;; This is a string (relative or absolute), set
13495 ;; proper date.
13496 (apply #'encode-time
13497 (org-read-date-analyze
13498 time default-time (decode-time default-time)))
13499 ;; If necessary, get the time from the user
13500 (or time (org-read-date nil 'to-time nil nil
13501 default-time default-input)))))
13503 (org-with-wide-buffer
13504 (org-back-to-heading t)
13505 (forward-line)
13506 (unless (bolp) (insert "\n"))
13507 (cond ((org-looking-at-p org-planning-line-re)
13508 ;; Move to current indentation.
13509 (skip-chars-forward " \t")
13510 ;; Check if we have to remove something.
13511 (dolist (type (if what (cons what remove) remove))
13512 (when (save-excursion
13513 (re-search-forward
13514 (case type
13515 (closed org-closed-time-regexp)
13516 (deadline org-deadline-time-regexp)
13517 (scheduled org-scheduled-time-regexp)
13518 (otherwise (error "Invalid planning type: %s" type)))
13519 (line-end-position) t))
13520 (replace-match "")
13521 (when (looking-at "--+<[^>]+>") (replace-match ""))
13522 (when (and (not what) (eq type 'closed))
13523 (save-excursion
13524 (beginning-of-line)
13525 (if (looking-at "[ \t]*$")
13526 (delete-region (point) (1+ (point-at-eol)))))))
13527 ;; Remove leading white spaces.
13528 (when (and (not (bolp)) (looking-at "[ \t]+")) (replace-match ""))))
13529 ((not what) (throw 'exit nil)) ; Nothing to do.
13530 (t (insert-before-markers "\n")
13531 (backward-char 1)
13532 (when org-adapt-indentation
13533 (org-indent-to-column (1+ (org-outline-level))))))
13534 (when what
13535 ;; Insert planning keyword.
13536 (insert (case what
13537 (closed org-closed-string)
13538 (deadline org-deadline-string)
13539 (scheduled org-scheduled-string)
13540 (otherwise (error "Invalid planning type: %s" what)))
13541 " ")
13542 ;; Insert associated timestamp.
13543 (let ((ts (org-insert-time-stamp
13544 time
13545 (or org-time-was-given
13546 (and (eq what 'closed) org-log-done-with-time))
13547 (eq what 'closed)
13548 nil nil (list org-end-time-was-given))))
13549 (unless (eolp) (insert " "))
13550 ts))))))
13552 (defvar org-log-note-marker (make-marker))
13553 (defvar org-log-note-purpose nil)
13554 (defvar org-log-note-state nil)
13555 (defvar org-log-note-previous-state nil)
13556 (defvar org-log-note-extra nil)
13557 (defvar org-log-note-window-configuration nil)
13558 (defvar org-log-note-return-to (make-marker))
13559 (defvar org-log-note-effective-time nil
13560 "Remembered current time so that dynamically scoped
13561 `org-extend-today-until' affects tha timestamps in state change
13562 log")
13564 (defvar org-log-post-message nil
13565 "Message to be displayed after a log note has been stored.
13566 The auto-repeater uses this.")
13568 (defun org-add-note ()
13569 "Add a note to the current entry.
13570 This is done in the same way as adding a state change note."
13571 (interactive)
13572 (org-add-log-setup 'note nil nil 'findpos nil))
13574 (defun org-log-beginning (&optional create)
13575 "Return expected start of log notes in current entry.
13576 When optional argument CREATE is non-nil, the function creates
13577 a drawer to store notes, if necessary. Returned position ignores
13578 narrowing."
13579 (org-with-wide-buffer
13580 (org-end-of-meta-data)
13581 (let ((end (if (org-at-heading-p) (point)
13582 (save-excursion (outline-next-heading) (point))))
13583 (drawer (org-log-into-drawer)))
13584 (cond
13585 (drawer
13586 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13587 (case-fold-search t))
13588 (catch 'exit
13589 ;; Try to find existing drawer.
13590 (while (re-search-forward regexp end t)
13591 (let ((element (org-element-at-point)))
13592 (when (eq (org-element-type element) 'drawer)
13593 (let ((cend (org-element-property :contents-end element)))
13594 (when (and (not org-log-states-order-reversed) cend)
13595 (goto-char cend)))
13596 (throw 'exit nil))))
13597 ;; No drawer found. Create one, if permitted.
13598 (when create
13599 (unless (bolp) (insert "\n"))
13600 (let ((beg (point)))
13601 (insert ":" drawer ":\n:END:\n")
13602 (org-indent-region beg (point)))
13603 (end-of-line -1)))))
13604 (org-log-state-notes-insert-after-drawers
13605 (while (and (looking-at org-drawer-regexp)
13606 (progn (goto-char (match-end 0))
13607 (re-search-forward org-property-end-re end t)))
13608 (forward-line)))))
13609 (if (bolp) (point) (line-beginning-position 2))))
13611 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13612 "Set up the post command hook to take a note.
13613 If this is about to TODO state change, the new state is expected in STATE.
13614 When FINDPOS is non-nil, find the correct position for the note in
13615 the current entry. If not, assume that it can be inserted at point.
13616 HOW is an indicator what kind of note should be created.
13617 EXTRA is additional text that will be inserted into the notes buffer."
13618 (org-with-wide-buffer
13619 (when findpos
13620 (goto-char (org-log-beginning t))
13621 (unless org-log-states-order-reversed
13622 (org-skip-over-state-notes)
13623 (skip-chars-backward " \t\n\r")
13624 (forward-line)))
13625 (move-marker org-log-note-marker (point))
13626 ;; Preserve position even if a property drawer is inserted in the
13627 ;; process.
13628 (set-marker-insertion-type org-log-note-marker t)
13629 (setq org-log-note-purpose purpose
13630 org-log-note-state state
13631 org-log-note-previous-state prev-state
13632 org-log-note-how how
13633 org-log-note-extra extra
13634 org-log-note-effective-time (org-current-effective-time))
13635 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13637 (defun org-skip-over-state-notes ()
13638 "Skip past the list of State notes in an entry."
13639 (when (ignore-errors (goto-char (org-in-item-p)))
13640 (let* ((struct (org-list-struct))
13641 (prevs (org-list-prevs-alist struct))
13642 (regexp
13643 (concat "[ \t]*- +"
13644 (replace-regexp-in-string
13645 " +" " +"
13646 (org-replace-escapes
13647 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13648 `(("%d" . ,org-ts-regexp-inactive)
13649 ("%D" . ,org-ts-regexp)
13650 ("%s" . "\"\\S-+\"")
13651 ("%S" . "\"\\S-+\"")
13652 ("%t" . ,org-ts-regexp-inactive)
13653 ("%T" . ,org-ts-regexp)
13654 ("%u" . ".*?")
13655 ("%U" . ".*?")))))))
13656 (while (org-looking-at-p regexp)
13657 (goto-char (or (org-list-get-next-item (point) struct prevs)
13658 (org-list-get-item-end (point) struct)))))))
13660 (defun org-add-log-note (&optional purpose)
13661 "Pop up a window for taking a note, and add this note later at point."
13662 (remove-hook 'post-command-hook 'org-add-log-note)
13663 (setq org-log-note-window-configuration (current-window-configuration))
13664 (delete-other-windows)
13665 (move-marker org-log-note-return-to (point))
13666 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13667 (goto-char org-log-note-marker)
13668 (org-switch-to-buffer-other-window "*Org Note*")
13669 (erase-buffer)
13670 (if (memq org-log-note-how '(time state))
13671 (let (current-prefix-arg) (org-store-log-note))
13672 (let ((org-inhibit-startup t)) (org-mode))
13673 (insert (format "# Insert note for %s.
13674 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13675 (cond
13676 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13677 ((eq org-log-note-purpose 'done) "closed todo item")
13678 ((eq org-log-note-purpose 'state)
13679 (format "state change from \"%s\" to \"%s\""
13680 (or org-log-note-previous-state "")
13681 (or org-log-note-state "")))
13682 ((eq org-log-note-purpose 'reschedule)
13683 "rescheduling")
13684 ((eq org-log-note-purpose 'delschedule)
13685 "no longer scheduled")
13686 ((eq org-log-note-purpose 'redeadline)
13687 "changing deadline")
13688 ((eq org-log-note-purpose 'deldeadline)
13689 "removing deadline")
13690 ((eq org-log-note-purpose 'refile)
13691 "refiling")
13692 ((eq org-log-note-purpose 'note)
13693 "this entry")
13694 (t (error "This should not happen")))))
13695 (if org-log-note-extra (insert org-log-note-extra))
13696 (org-set-local 'org-finish-function 'org-store-log-note)
13697 (run-hooks 'org-log-buffer-setup-hook)))
13699 (defvar org-note-abort nil) ; dynamically scoped
13700 (defun org-store-log-note ()
13701 "Finish taking a log note, and insert it to where it belongs."
13702 (let ((txt (buffer-string)))
13703 (kill-buffer (current-buffer))
13704 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13705 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13706 (setq txt (replace-match "" t t txt)))
13707 (if (string-match "\\s-+\\'" txt)
13708 (setq txt (replace-match "" t t txt)))
13709 (setq lines (org-split-string txt "\n"))
13710 (when (and note (string-match "\\S-" note))
13711 (setq note
13712 (org-replace-escapes
13713 note
13714 (list (cons "%u" (user-login-name))
13715 (cons "%U" user-full-name)
13716 (cons "%t" (format-time-string
13717 (org-time-stamp-format 'long 'inactive)
13718 org-log-note-effective-time))
13719 (cons "%T" (format-time-string
13720 (org-time-stamp-format 'long nil)
13721 org-log-note-effective-time))
13722 (cons "%d" (format-time-string
13723 (org-time-stamp-format nil 'inactive)
13724 org-log-note-effective-time))
13725 (cons "%D" (format-time-string
13726 (org-time-stamp-format nil nil)
13727 org-log-note-effective-time))
13728 (cons "%s" (if org-log-note-state
13729 (concat "\"" org-log-note-state "\"")
13730 ""))
13731 (cons "%S" (if org-log-note-previous-state
13732 (concat "\"" org-log-note-previous-state "\"")
13733 "\"\"")))))
13734 (when lines (setq note (concat note " \\\\")))
13735 (push note lines))
13736 (when (or current-prefix-arg org-note-abort)
13737 (when (org-log-into-drawer)
13738 (org-remove-empty-drawer-at org-log-note-marker))
13739 (setq lines nil))
13740 (when lines
13741 (with-current-buffer (marker-buffer org-log-note-marker)
13742 (save-excursion
13743 (goto-char org-log-note-marker)
13744 (move-marker org-log-note-marker nil)
13745 ;; Make sure point is at the beginning of an empty line.
13746 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13747 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13748 ;; In an existing list, add a new item at the top level.
13749 ;; Otherwise, indent line like a regular one.
13750 (let ((itemp (org-in-item-p)))
13751 (if itemp
13752 (org-indent-line-to
13753 (let ((struct (save-excursion
13754 (goto-char itemp) (org-list-struct))))
13755 (org-list-get-ind (org-list-get-top-point struct) struct)))
13756 (org-indent-line)))
13757 (insert (org-list-bullet-string "-") (pop lines))
13758 (let ((ind (org-list-item-body-column (line-beginning-position))))
13759 (dolist (line lines)
13760 (insert "\n")
13761 (org-indent-line-to ind)
13762 (insert line)))
13763 (message "Note stored")
13764 (org-back-to-heading t)
13765 (org-cycle-hide-drawers 'children))
13766 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13767 ;; from within `org-add-log-note' because `buffer-undo-list'
13768 ;; is then modified outside of `org-with-remote-undo'.
13769 (when (eq this-command 'org-agenda-todo)
13770 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13771 ;; Don't add undo information when called from `org-agenda-todo'
13772 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13773 (set-window-configuration org-log-note-window-configuration)
13774 (with-current-buffer (marker-buffer org-log-note-return-to)
13775 (goto-char org-log-note-return-to))
13776 (move-marker org-log-note-return-to nil)
13777 (and org-log-post-message (message "%s" org-log-post-message))))
13779 (defun org-remove-empty-drawer-at (pos)
13780 "Remove an empty drawer at position POS.
13781 POS may also be a marker."
13782 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13783 (org-with-wide-buffer
13784 (goto-char pos)
13785 (let ((drawer (org-element-at-point)))
13786 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13787 (not (org-element-property :contents-begin drawer)))
13788 (delete-region (org-element-property :begin drawer)
13789 (progn (goto-char (org-element-property :end drawer))
13790 (skip-chars-backward " \r\t\n")
13791 (forward-line)
13792 (point))))))))
13794 (defvar org-ts-type nil)
13795 (defun org-sparse-tree (&optional arg type)
13796 "Create a sparse tree, prompt for the details.
13797 This command can create sparse trees. You first need to select the type
13798 of match used to create the tree:
13800 t Show all TODO entries.
13801 T Show entries with a specific TODO keyword.
13802 m Show entries selected by a tags/property match.
13803 p Enter a property name and its value (both with completion on existing
13804 names/values) and show entries with that property.
13805 r Show entries matching a regular expression (`/' can be used as well).
13806 b Show deadlines and scheduled items before a date.
13807 a Show deadlines and scheduled items after a date.
13808 d Show deadlines due within `org-deadline-warning-days'.
13809 D Show deadlines and scheduled items between a date range."
13810 (interactive "P")
13811 (setq type (or type org-sparse-tree-default-date-type))
13812 (setq org-ts-type type)
13813 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13814 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13815 [c]ycle through date types: %s"
13816 (case type
13817 (all "all timestamps")
13818 (scheduled "only scheduled")
13819 (deadline "only deadline")
13820 (active "only active timestamps")
13821 (inactive "only inactive timestamps")
13822 (closed "with a closed time-stamp")
13823 (otherwise "scheduled/deadline")))
13824 (let ((answer (read-char-exclusive)))
13825 (case answer
13827 (org-sparse-tree
13829 (cadr
13830 (memq type '(nil all scheduled deadline active inactive closed)))))
13831 (?d (call-interactively 'org-check-deadlines))
13832 (?b (call-interactively 'org-check-before-date))
13833 (?a (call-interactively 'org-check-after-date))
13834 (?D (call-interactively 'org-check-dates-range))
13835 (?t (call-interactively 'org-show-todo-tree))
13836 (?T (org-show-todo-tree '(4)))
13837 (?m (call-interactively 'org-match-sparse-tree))
13838 ((?p ?P)
13839 (let* ((kwd (org-icompleting-read
13840 "Property: " (mapcar 'list (org-buffer-property-keys))))
13841 (value (org-icompleting-read
13842 "Value: " (mapcar 'list (org-property-values kwd)))))
13843 (unless (string-match "\\`{.*}\\'" value)
13844 (setq value (concat "\"" value "\"")))
13845 (org-match-sparse-tree arg (concat kwd "=" value))))
13846 ((?r ?R ?/) (call-interactively 'org-occur))
13847 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13849 (defvar org-occur-highlights nil
13850 "List of overlays used for occur matches.")
13851 (make-variable-buffer-local 'org-occur-highlights)
13852 (defvar org-occur-parameters nil
13853 "Parameters of the active org-occur calls.
13854 This is a list, each call to org-occur pushes as cons cell,
13855 containing the regular expression and the callback, onto the list.
13856 The list can contain several entries if `org-occur' has been called
13857 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13858 will only contain one set of parameters. When the highlights are
13859 removed (for example with `C-c C-c', or with the next edit (depending
13860 on `org-remove-highlights-with-change'), this variable is emptied
13861 as well.")
13862 (make-variable-buffer-local 'org-occur-parameters)
13864 (defun org-occur (regexp &optional keep-previous callback)
13865 "Make a compact tree which shows all matches of REGEXP.
13866 The tree will show the lines where the regexp matches, and all higher
13867 headlines above the match. It will also show the heading after the match,
13868 to make sure editing the matching entry is easy.
13869 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13870 call to `org-occur' will be kept, to allow stacking of calls to this
13871 command.
13872 If CALLBACK is non-nil, it is a function which is called to confirm
13873 that the match should indeed be shown."
13874 (interactive "sRegexp: \nP")
13875 (when (equal regexp "")
13876 (user-error "Regexp cannot be empty"))
13877 (unless keep-previous
13878 (org-remove-occur-highlights nil nil t))
13879 (push (cons regexp callback) org-occur-parameters)
13880 (let ((cnt 0))
13881 (save-excursion
13882 (goto-char (point-min))
13883 (if (or (not keep-previous) ; do not want to keep
13884 (not org-occur-highlights)) ; no previous matches
13885 ;; hide everything
13886 (org-overview))
13887 (while (re-search-forward regexp nil t)
13888 (when (or (not callback)
13889 (save-match-data (funcall callback)))
13890 (setq cnt (1+ cnt))
13891 (when org-highlight-sparse-tree-matches
13892 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13893 (org-show-context 'occur-tree))))
13894 (when org-remove-highlights-with-change
13895 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13896 nil 'local))
13897 (unless org-sparse-tree-open-archived-trees
13898 (org-hide-archived-subtrees (point-min) (point-max)))
13899 (run-hooks 'org-occur-hook)
13900 (if (org-called-interactively-p 'interactive)
13901 (message "%d match(es) for regexp %s" cnt regexp))
13902 cnt))
13904 (defun org-occur-next-match (&optional n reset)
13905 "Function for `next-error-function' to find sparse tree matches.
13906 N is the number of matches to move, when negative move backwards.
13907 RESET is entirely ignored - this function always goes back to the
13908 starting point when no match is found."
13909 (let* ((limit (if (< n 0) (point-min) (point-max)))
13910 (search-func (if (< n 0)
13911 'previous-single-char-property-change
13912 'next-single-char-property-change))
13913 (n (abs n))
13914 (pos (point))
13916 (catch 'exit
13917 (while (setq p1 (funcall search-func (point) 'org-type))
13918 (when (equal p1 limit)
13919 (goto-char pos)
13920 (user-error "No more matches"))
13921 (when (equal (get-char-property p1 'org-type) 'org-occur)
13922 (setq n (1- n))
13923 (when (= n 0)
13924 (goto-char p1)
13925 (throw 'exit (point))))
13926 (goto-char p1))
13927 (goto-char p1)
13928 (user-error "No more matches"))))
13930 (defun org-show-context (&optional key)
13931 "Make sure point and context are visible.
13932 How much context is shown depends upon the variables
13933 `org-show-hierarchy-above', `org-show-following-heading',
13934 `org-show-entry-below' and `org-show-siblings'."
13935 (let ((heading-p (org-at-heading-p t))
13936 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13937 (following-p (org-get-alist-option org-show-following-heading key))
13938 (entry-p (org-get-alist-option org-show-entry-below key))
13939 (siblings-p (org-get-alist-option org-show-siblings key)))
13940 ;; Show heading or entry text
13941 (if (and heading-p (not entry-p))
13942 (org-flag-heading nil) ; only show the heading
13943 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13944 (org-show-hidden-entry))) ; show entire entry
13945 (when following-p
13946 ;; Show next sibling, or heading below text
13947 (save-excursion
13948 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13949 (org-flag-heading nil))))
13950 (when siblings-p (org-show-siblings))
13951 (when hierarchy-p
13952 ;; show all higher headings, possibly with siblings
13953 (save-excursion
13954 (while (and (ignore-errors (progn (org-up-heading-all 1) t))
13955 (not (bobp)))
13956 (org-flag-heading nil)
13957 (when siblings-p (org-show-siblings)))))))
13959 (defvar org-reveal-start-hook nil
13960 "Hook run before revealing a location.")
13962 (defun org-reveal (&optional siblings)
13963 "Show current entry, hierarchy above it, and the following headline.
13964 This can be used to show a consistent set of context around locations
13965 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13966 not t for the search context.
13968 With optional argument SIBLINGS, on each level of the hierarchy all
13969 siblings are shown. This repairs the tree structure to what it would
13970 look like when opened with hierarchical calls to `org-cycle'.
13971 With double optional argument \\[universal-argument] \\[universal-argument], \
13972 go to the parent and show the
13973 entire tree."
13974 (interactive "P")
13975 (run-hooks 'org-reveal-start-hook)
13976 (let ((org-show-hierarchy-above t)
13977 (org-show-following-heading t)
13978 (org-show-siblings (if siblings t org-show-siblings)))
13979 (org-show-context nil))
13980 (when (equal siblings '(16))
13981 (save-excursion
13982 (when (org-up-heading-safe)
13983 (org-show-subtree)
13984 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13986 (defun org-highlight-new-match (beg end)
13987 "Highlight from BEG to END and mark the highlight is an occur headline."
13988 (let ((ov (make-overlay beg end)))
13989 (overlay-put ov 'face 'secondary-selection)
13990 (overlay-put ov 'org-type 'org-occur)
13991 (push ov org-occur-highlights)))
13993 (defun org-remove-occur-highlights (&optional beg end noremove)
13994 "Remove the occur highlights from the buffer.
13995 BEG and END are ignored. If NOREMOVE is nil, remove this function
13996 from the `before-change-functions' in the current buffer."
13997 (interactive)
13998 (unless org-inhibit-highlight-removal
13999 (mapc 'delete-overlay org-occur-highlights)
14000 (setq org-occur-highlights nil)
14001 (setq org-occur-parameters nil)
14002 (unless noremove
14003 (remove-hook 'before-change-functions
14004 'org-remove-occur-highlights 'local))))
14006 ;;;; Priorities
14008 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14009 "Regular expression matching the priority indicator.")
14011 (defvar org-remove-priority-next-time nil)
14013 (defun org-priority-up ()
14014 "Increase the priority of the current item."
14015 (interactive)
14016 (org-priority 'up))
14018 (defun org-priority-down ()
14019 "Decrease the priority of the current item."
14020 (interactive)
14021 (org-priority 'down))
14023 (defun org-priority (&optional action show)
14024 "Change the priority of an item.
14025 ACTION can be `set', `up', `down', or a character."
14026 (interactive "P")
14027 (if (equal action '(4))
14028 (org-show-priority)
14029 (unless org-enable-priority-commands
14030 (user-error "Priority commands are disabled"))
14031 (setq action (or action 'set))
14032 (let (current new news have remove)
14033 (save-excursion
14034 (org-back-to-heading t)
14035 (if (looking-at org-priority-regexp)
14036 (setq current (string-to-char (match-string 2))
14037 have t))
14038 (cond
14039 ((eq action 'remove)
14040 (setq remove t new ?\ ))
14041 ((or (eq action 'set)
14042 (if (featurep 'xemacs) (characterp action) (integerp action)))
14043 (if (not (eq action 'set))
14044 (setq new action)
14045 (message "Priority %c-%c, SPC to remove: "
14046 org-highest-priority org-lowest-priority)
14047 (save-match-data
14048 (setq new (read-char-exclusive))))
14049 (if (and (= (upcase org-highest-priority) org-highest-priority)
14050 (= (upcase org-lowest-priority) org-lowest-priority))
14051 (setq new (upcase new)))
14052 (cond ((equal new ?\ ) (setq remove t))
14053 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14054 (user-error "Priority must be between `%c' and `%c'"
14055 org-highest-priority org-lowest-priority))))
14056 ((eq action 'up)
14057 (setq new (if have
14058 (1- current) ; normal cycling
14059 ;; last priority was empty
14060 (if (eq last-command this-command)
14061 org-lowest-priority ; wrap around empty to lowest
14062 ;; default
14063 (if org-priority-start-cycle-with-default
14064 org-default-priority
14065 (1- org-default-priority))))))
14066 ((eq action 'down)
14067 (setq new (if have
14068 (1+ current) ; normal cycling
14069 ;; last priority was empty
14070 (if (eq last-command this-command)
14071 org-highest-priority ; wrap around empty to highest
14072 ;; default
14073 (if org-priority-start-cycle-with-default
14074 org-default-priority
14075 (1+ org-default-priority))))))
14076 (t (user-error "Invalid action")))
14077 (if (or (< (upcase new) org-highest-priority)
14078 (> (upcase new) org-lowest-priority))
14079 (if (and (memq action '(up down))
14080 (not have) (not (eq last-command this-command)))
14081 ;; `new' is from default priority
14082 (error
14083 "The default can not be set, see `org-default-priority' why")
14084 ;; normal cycling: `new' is beyond highest/lowest priority
14085 ;; and is wrapped around to the empty priority
14086 (setq remove t)))
14087 (setq news (format "%c" new))
14088 (if have
14089 (if remove
14090 (replace-match "" t t nil 1)
14091 (replace-match news t t nil 2))
14092 (if remove
14093 (user-error "No priority cookie found in line")
14094 (let ((case-fold-search nil))
14095 (looking-at org-todo-line-regexp))
14096 (if (match-end 2)
14097 (progn
14098 (goto-char (match-end 2))
14099 (insert " [#" news "]"))
14100 (goto-char (match-beginning 3))
14101 (insert "[#" news "] "))))
14102 (org-set-tags nil 'align))
14103 (if remove
14104 (message "Priority removed")
14105 (message "Priority of current item set to %s" news)))))
14107 (defun org-show-priority ()
14108 "Show the priority of the current item.
14109 This priority is composed of the main priority given with the [#A] cookies,
14110 and by additional input from the age of a schedules or deadline entry."
14111 (interactive)
14112 (let ((pri (if (eq major-mode 'org-agenda-mode)
14113 (org-get-at-bol 'priority)
14114 (save-excursion
14115 (save-match-data
14116 (beginning-of-line)
14117 (and (looking-at org-heading-regexp)
14118 (org-get-priority (match-string 0))))))))
14119 (message "Priority is %d" (if pri pri -1000))))
14121 (defun org-get-priority (s)
14122 "Find priority cookie and return priority."
14123 (save-match-data
14124 (if (functionp org-get-priority-function)
14125 (funcall org-get-priority-function)
14126 (if (not (string-match org-priority-regexp s))
14127 (* 1000 (- org-lowest-priority org-default-priority))
14128 (* 1000 (- org-lowest-priority
14129 (string-to-char (match-string 2 s))))))))
14131 ;;;; Tags
14133 (defvar org-agenda-archives-mode)
14134 (defvar org-map-continue-from nil
14135 "Position from where mapping should continue.
14136 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14138 (defvar org-scanner-tags nil
14139 "The current tag list while the tags scanner is running.")
14140 (defvar org-trust-scanner-tags nil
14141 "Should `org-get-tags-at' use the tags for the scanner.
14142 This is for internal dynamical scoping only.
14143 When this is non-nil, the function `org-get-tags-at' will return the value
14144 of `org-scanner-tags' instead of building the list by itself. This
14145 can lead to large speed-ups when the tags scanner is used in a file with
14146 many entries, and when the list of tags is retrieved, for example to
14147 obtain a list of properties. Building the tags list for each entry in such
14148 a file becomes an N^2 operation - but with this variable set, it scales
14149 as N.")
14151 (defun org-scan-tags (action matcher todo-only &optional start-level)
14152 "Scan headline tags with inheritance and produce output ACTION.
14154 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14155 or `agenda' to produce an entry list for an agenda view. It can also be
14156 a Lisp form or a function that should be called at each matched headline, in
14157 this case the return value is a list of all return values from these calls.
14159 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14160 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14161 only lines with a not-done TODO keyword are included in the output.
14162 This should be the same variable that was scoped into
14163 and set by `org-make-tags-matcher' when it constructed MATCHER.
14165 START-LEVEL can be a string with asterisks, reducing the scope to
14166 headlines matching this string."
14167 (require 'org-agenda)
14168 (let* ((re (concat "^"
14169 (if start-level
14170 ;; Get the correct level to match
14171 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14172 org-outline-regexp)
14173 " *\\(\\<\\("
14174 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14175 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14176 (props (list 'face 'default
14177 'done-face 'org-agenda-done
14178 'undone-face 'default
14179 'mouse-face 'highlight
14180 'org-not-done-regexp org-not-done-regexp
14181 'org-todo-regexp org-todo-regexp
14182 'org-complex-heading-regexp org-complex-heading-regexp
14183 'help-echo
14184 (format "mouse-2 or RET jump to org file %s"
14185 (abbreviate-file-name
14186 (or (buffer-file-name (buffer-base-buffer))
14187 (buffer-name (buffer-base-buffer)))))))
14188 (org-map-continue-from nil)
14189 lspos tags tags-list
14190 (tags-alist (list (cons 0 org-file-tags)))
14191 (llast 0) rtn rtn1 level category i txt
14192 todo marker entry priority)
14193 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14194 (setq action (list 'lambda nil action)))
14195 (save-excursion
14196 (goto-char (point-min))
14197 (when (eq action 'sparse-tree)
14198 (org-overview)
14199 (org-remove-occur-highlights))
14200 (while (let (case-fold-search)
14201 (re-search-forward re nil t))
14202 (setq org-map-continue-from nil)
14203 (catch :skip
14204 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14205 tags (if (match-end 4) (org-match-string-no-properties 4)))
14206 (goto-char (setq lspos (match-beginning 0)))
14207 (setq level (org-reduced-level (org-outline-level))
14208 category (org-get-category))
14209 (setq i llast llast level)
14210 ;; remove tag lists from same and sublevels
14211 (while (>= i level)
14212 (when (setq entry (assoc i tags-alist))
14213 (setq tags-alist (delete entry tags-alist)))
14214 (setq i (1- i)))
14215 ;; add the next tags
14216 (when tags
14217 (setq tags (org-split-string tags ":")
14218 tags-alist
14219 (cons (cons level tags) tags-alist)))
14220 ;; compile tags for current headline
14221 (setq tags-list
14222 (if org-use-tag-inheritance
14223 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14224 tags)
14225 org-scanner-tags tags-list)
14226 (when org-use-tag-inheritance
14227 (setcdr (car tags-alist)
14228 (mapcar (lambda (x)
14229 (setq x (copy-sequence x))
14230 (org-add-prop-inherited x))
14231 (cdar tags-alist))))
14232 (when (and tags org-use-tag-inheritance
14233 (or (not (eq t org-use-tag-inheritance))
14234 org-tags-exclude-from-inheritance))
14235 ;; selective inheritance, remove uninherited ones
14236 (setcdr (car tags-alist)
14237 (org-remove-uninherited-tags (cdar tags-alist))))
14238 (when (and
14240 ;; eval matcher only when the todo condition is OK
14241 (and (or (not todo-only) (member todo org-not-done-keywords))
14242 (let ((case-fold-search t) (org-trust-scanner-tags t))
14243 (eval matcher)))
14245 ;; Call the skipper, but return t if it does not skip,
14246 ;; so that the `and' form continues evaluating
14247 (progn
14248 (unless (eq action 'sparse-tree) (org-agenda-skip))
14251 ;; Check if timestamps are deselecting this entry
14252 (or (not todo-only)
14253 (and (member todo org-not-done-keywords)
14254 (or (not org-agenda-tags-todo-honor-ignore-options)
14255 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14257 ;; select this headline
14258 (cond
14259 ((eq action 'sparse-tree)
14260 (and org-highlight-sparse-tree-matches
14261 (org-get-heading) (match-end 0)
14262 (org-highlight-new-match
14263 (match-beginning 1) (match-end 1)))
14264 (org-show-context 'tags-tree))
14265 ((eq action 'agenda)
14266 (setq txt (org-agenda-format-item
14268 (concat
14269 (if (eq org-tags-match-list-sublevels 'indented)
14270 (make-string (1- level) ?.) "")
14271 (org-get-heading))
14272 level category
14273 tags-list)
14274 priority (org-get-priority txt))
14275 (goto-char lspos)
14276 (setq marker (org-agenda-new-marker))
14277 (org-add-props txt props
14278 'org-marker marker 'org-hd-marker marker 'org-category category
14279 'todo-state todo
14280 'priority priority 'type "tagsmatch")
14281 (push txt rtn))
14282 ((functionp action)
14283 (setq org-map-continue-from nil)
14284 (save-excursion
14285 (setq rtn1 (funcall action))
14286 (push rtn1 rtn)))
14287 (t (user-error "Invalid action")))
14289 ;; if we are to skip sublevels, jump to end of subtree
14290 (unless org-tags-match-list-sublevels
14291 (org-end-of-subtree t)
14292 (backward-char 1))))
14293 ;; Get the correct position from where to continue
14294 (if org-map-continue-from
14295 (goto-char org-map-continue-from)
14296 (and (= (point) lspos) (end-of-line 1)))))
14297 (when (and (eq action 'sparse-tree)
14298 (not org-sparse-tree-open-archived-trees))
14299 (org-hide-archived-subtrees (point-min) (point-max)))
14300 (nreverse rtn)))
14302 (defun org-remove-uninherited-tags (tags)
14303 "Remove all tags that are not inherited from the list TAGS."
14304 (cond
14305 ((eq org-use-tag-inheritance t)
14306 (if org-tags-exclude-from-inheritance
14307 (org-delete-all org-tags-exclude-from-inheritance tags)
14308 tags))
14309 ((not org-use-tag-inheritance) nil)
14310 ((stringp org-use-tag-inheritance)
14311 (delq nil (mapcar
14312 (lambda (x)
14313 (if (and (string-match org-use-tag-inheritance x)
14314 (not (member x org-tags-exclude-from-inheritance)))
14315 x nil))
14316 tags)))
14317 ((listp org-use-tag-inheritance)
14318 (delq nil (mapcar
14319 (lambda (x)
14320 (if (member x org-use-tag-inheritance) x nil))
14321 tags)))))
14323 (defun org-match-sparse-tree (&optional todo-only match)
14324 "Create a sparse tree according to tags string MATCH.
14325 MATCH can contain positive and negative selection of tags, like
14326 \"+WORK+URGENT-WITHBOSS\".
14327 If optional argument TODO-ONLY is non-nil, only select lines that are
14328 also TODO lines."
14329 (interactive "P")
14330 (org-agenda-prepare-buffers (list (current-buffer)))
14331 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14333 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14335 (defvar org-cached-props nil)
14336 (defun org-cached-entry-get (pom property)
14337 (if (or (eq t org-use-property-inheritance)
14338 (and (stringp org-use-property-inheritance)
14339 (let ((case-fold-search t))
14340 (org-string-match-p org-use-property-inheritance property)))
14341 (and (listp org-use-property-inheritance)
14342 (member-ignore-case property org-use-property-inheritance)))
14343 ;; Caching is not possible, check it directly.
14344 (org-entry-get pom property 'inherit)
14345 ;; Get all properties, so we can do complicated checks easily.
14346 (cdr (assoc-string property
14347 (or org-cached-props
14348 (setq org-cached-props (org-entry-properties pom)))
14349 t))))
14351 (defun org-global-tags-completion-table (&optional files)
14352 "Return the list of all tags in all agenda buffer/files.
14353 Optional FILES argument is a list of files which can be used
14354 instead of the agenda files."
14355 (save-excursion
14356 (org-uniquify
14357 (delq nil
14358 (apply 'append
14359 (mapcar
14360 (lambda (file)
14361 (set-buffer (find-file-noselect file))
14362 (append (org-get-buffer-tags)
14363 (mapcar (lambda (x) (if (stringp (car-safe x))
14364 (list (car-safe x)) nil))
14365 org-tag-alist)))
14366 (if (and files (car files))
14367 files
14368 (org-agenda-files))))))))
14370 (defun org-make-tags-matcher (match)
14371 "Create the TAGS/TODO matcher form for the selection string MATCH.
14373 The variable `todo-only' is scoped dynamically into this function.
14374 It will be set to t if the matcher restricts matching to TODO entries,
14375 otherwise will not be touched.
14377 Returns a cons of the selection string MATCH and the constructed
14378 lisp form implementing the matcher. The matcher is to be evaluated
14379 at an Org entry, with point on the headline, and returns t if the
14380 entry matches the selection string MATCH. The returned lisp form
14381 references two variables with information about the entry, which
14382 must be bound around the form's evaluation: todo, the TODO keyword
14383 at the entry (or nil of none); and tags-list, the list of all tags
14384 at the entry including inherited ones. Additionally, the category
14385 of the entry (if any) must be specified as the text property
14386 'org-category on the headline.
14388 See also `org-scan-tags'.
14390 (declare (special todo-only))
14391 (unless (boundp 'todo-only)
14392 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14393 (unless match
14394 ;; Get a new match request, with completion against the global
14395 ;; tags table and the local tags in current buffer
14396 (let ((org-last-tags-completion-table
14397 (org-uniquify
14398 (delq nil (append (org-get-buffer-tags)
14399 (org-global-tags-completion-table))))))
14400 (setq match (org-completing-read-no-i
14401 "Match: " 'org-tags-completion-function nil nil nil
14402 'org-tags-history))))
14404 ;; Parse the string and create a lisp form
14405 (let ((match0 match)
14406 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14407 minus tag mm
14408 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14409 orterms term orlist re-p str-p level-p level-op time-p
14410 prop-p pn pv po gv rest (start 0) (ss 0))
14411 ;; Expand group tags
14412 (setq match (org-tags-expand match))
14414 ;; Check if there is a TODO part of this match, which would be the
14415 ;; part after a "/". TO make sure that this slash is not part of
14416 ;; a property value to be matched against, we also check that there
14417 ;; is no " after that slash.
14418 ;; First, find the last slash
14419 (while (string-match "/+" match ss)
14420 (setq start (match-beginning 0) ss (match-end 0)))
14421 (if (and (string-match "/+" match start)
14422 (not (save-match-data (string-match "\"" match start))))
14423 ;; match contains also a todo-matching request
14424 (progn
14425 (setq tagsmatch (substring match 0 (match-beginning 0))
14426 todomatch (substring match (match-end 0)))
14427 (if (string-match "^!" todomatch)
14428 (setq todo-only t todomatch (substring todomatch 1)))
14429 (if (string-match "^\\s-*$" todomatch)
14430 (setq todomatch nil)))
14431 ;; only matching tags
14432 (setq tagsmatch match todomatch nil))
14434 ;; Make the tags matcher
14435 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14436 (setq tagsmatcher t)
14437 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14438 (while (setq term (pop orterms))
14439 (while (and (equal (substring term -1) "\\") orterms)
14440 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14441 (while (string-match re term)
14442 (setq rest (substring term (match-end 0))
14443 minus (and (match-end 1)
14444 (equal (match-string 1 term) "-"))
14445 tag (save-match-data (replace-regexp-in-string
14446 "\\\\-" "-"
14447 (match-string 2 term)))
14448 re-p (equal (string-to-char tag) ?{)
14449 level-p (match-end 4)
14450 prop-p (match-end 5)
14451 mm (cond
14452 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14453 (level-p
14454 (setq level-op (org-op-to-function (match-string 3 term)))
14455 `(,level-op level ,(string-to-number
14456 (match-string 4 term))))
14457 (prop-p
14458 (setq pn (match-string 5 term)
14459 po (match-string 6 term)
14460 pv (match-string 7 term)
14461 re-p (equal (string-to-char pv) ?{)
14462 str-p (equal (string-to-char pv) ?\")
14463 time-p (save-match-data
14464 (string-match "^\"[[<].*[]>]\"$" pv))
14465 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14466 (if time-p (setq pv (org-matcher-time pv)))
14467 (setq po (org-op-to-function po (if time-p 'time str-p)))
14468 (cond
14469 ((equal pn "CATEGORY")
14470 (setq gv '(get-text-property (point) 'org-category)))
14471 ((equal pn "TODO")
14472 (setq gv 'todo))
14474 (setq gv `(org-cached-entry-get nil ,pn))))
14475 (if re-p
14476 (if (eq po 'org<>)
14477 `(not (string-match ,pv (or ,gv "")))
14478 `(string-match ,pv (or ,gv "")))
14479 (if str-p
14480 `(,po (or ,gv "") ,pv)
14481 `(,po (string-to-number (or ,gv ""))
14482 ,(string-to-number pv) ))))
14483 (t `(member ,tag tags-list)))
14484 mm (if minus (list 'not mm) mm)
14485 term rest)
14486 (push mm tagsmatcher))
14487 (push (if (> (length tagsmatcher) 1)
14488 (cons 'and tagsmatcher)
14489 (car tagsmatcher))
14490 orlist)
14491 (setq tagsmatcher nil))
14492 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14493 (setq tagsmatcher
14494 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14495 ;; Make the todo matcher
14496 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14497 (setq todomatcher t)
14498 (setq orterms (org-split-string todomatch "|") orlist nil)
14499 (while (setq term (pop orterms))
14500 (while (string-match re term)
14501 (setq minus (and (match-end 1)
14502 (equal (match-string 1 term) "-"))
14503 kwd (match-string 2 term)
14504 re-p (equal (string-to-char kwd) ?{)
14505 term (substring term (match-end 0))
14506 mm (if re-p
14507 `(string-match ,(substring kwd 1 -1) todo)
14508 (list 'equal 'todo kwd))
14509 mm (if minus (list 'not mm) mm))
14510 (push mm todomatcher))
14511 (push (if (> (length todomatcher) 1)
14512 (cons 'and todomatcher)
14513 (car todomatcher))
14514 orlist)
14515 (setq todomatcher nil))
14516 (setq todomatcher (if (> (length orlist) 1)
14517 (cons 'or orlist) (car orlist))))
14519 ;; Return the string and lisp forms of the matcher
14520 (setq matcher (if todomatcher
14521 (list 'and tagsmatcher todomatcher)
14522 tagsmatcher))
14523 (when todo-only
14524 (setq matcher (list 'and '(member todo org-not-done-keywords)
14525 matcher)))
14526 (cons match0 matcher)))
14528 (defun org-tags-expand (match &optional single-as-list downcased)
14529 "Expand group tags in MATCH.
14531 This replaces every group tag in MATCH with a regexp tag search.
14532 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14533 will be replaced like this:
14535 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14536 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14537 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14539 Replacing by a regexp preserves the structure of the match.
14540 E.g., this expansion
14542 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14544 will match anything tagged with \"Lab\" and \"Home\", or tagged
14545 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14547 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14548 assumed to be a single group tag, and the function will return
14549 the list of tags in this group.
14551 When DOWNCASE is non-nil, expand downcased TAGS."
14552 (if org-group-tags
14553 (let* ((case-fold-search t)
14554 (stable org-mode-syntax-table)
14555 (tal (or org-tag-groups-alist-for-agenda
14556 org-tag-groups-alist))
14557 (tal (if downcased
14558 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14559 (tml (mapcar 'car tal))
14560 (rtnmatch match) rpl)
14561 ;; @ and _ are allowed as word-components in tags
14562 (modify-syntax-entry ?@ "w" stable)
14563 (modify-syntax-entry ?_ "w" stable)
14564 (while (and tml
14565 (with-syntax-table stable
14566 (string-match
14567 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14568 (regexp-opt tml) "\\>\\)") rtnmatch)))
14569 (let* ((dir (match-string 1 rtnmatch))
14570 (tag (match-string 2 rtnmatch))
14571 (tag (if downcased (downcase tag) tag)))
14572 (setq tml (delete tag tml))
14573 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14574 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14575 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14576 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14577 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14578 (if single-as-list
14579 (or (reverse rpl) (list rtnmatch))
14580 rtnmatch))
14581 (if single-as-list (list (if downcased (downcase match) match))
14582 match)))
14584 (defun org-op-to-function (op &optional stringp)
14585 "Turn an operator into the appropriate function."
14586 (setq op
14587 (cond
14588 ((equal op "<" ) '(< string< org-time<))
14589 ((equal op ">" ) '(> org-string> org-time>))
14590 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14591 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14592 ((member op '("=" "==")) '(= string= org-time=))
14593 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14594 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14596 (defun org<> (a b) (not (= a b)))
14597 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14598 (defun org-string>= (a b) (not (string< a b)))
14599 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14600 (defun org-string<> (a b) (not (string= a b)))
14601 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14602 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14603 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14604 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14605 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14606 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14607 (defun org-2ft (s)
14608 "Convert S to a floating point time.
14609 If S is already a number, just return it. If it is a string, parse
14610 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14611 (cond
14612 ((numberp s) s)
14613 ((stringp s)
14614 (condition-case nil
14615 (float-time (apply 'encode-time (org-parse-time-string s)))
14616 (error 0.)))
14617 (t 0.)))
14619 (defun org-time-today ()
14620 "Time in seconds today at 0:00.
14621 Returns the float number of seconds since the beginning of the
14622 epoch to the beginning of today (00:00)."
14623 (float-time (apply 'encode-time
14624 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14626 (defun org-matcher-time (s)
14627 "Interpret a time comparison value."
14628 (save-match-data
14629 (cond
14630 ((string= s "<now>") (float-time))
14631 ((string= s "<today>") (org-time-today))
14632 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14633 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14634 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14635 (+ (org-time-today)
14636 (* (string-to-number (match-string 1 s))
14637 (cdr (assoc (match-string 2 s)
14638 '(("d" . 86400.0) ("w" . 604800.0)
14639 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14640 (t (org-2ft s)))))
14642 (defun org-match-any-p (re list)
14643 "Does re match any element of list?"
14644 (setq list (mapcar (lambda (x) (string-match re x)) list))
14645 (delq nil list))
14647 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14648 (defvar org-tags-overlay (make-overlay 1 1))
14649 (org-detach-overlay org-tags-overlay)
14651 (defun org-get-local-tags-at (&optional pos)
14652 "Get a list of tags defined in the current headline."
14653 (org-get-tags-at pos 'local))
14655 (defun org-get-local-tags ()
14656 "Get a list of tags defined in the current headline."
14657 (org-get-tags-at nil 'local))
14659 (defun org-get-tags-at (&optional pos local)
14660 "Get a list of all headline tags applicable at POS.
14661 POS defaults to point. If tags are inherited, the list contains
14662 the targets in the same sequence as the headlines appear, i.e.
14663 the tags of the current headline come last.
14664 When LOCAL is non-nil, only return tags from the current headline,
14665 ignore inherited ones."
14666 (interactive)
14667 (if (and org-trust-scanner-tags
14668 (or (not pos) (equal pos (point)))
14669 (not local))
14670 org-scanner-tags
14671 (let (tags ltags lastpos parent)
14672 (save-excursion
14673 (save-restriction
14674 (widen)
14675 (goto-char (or pos (point)))
14676 (save-match-data
14677 (catch 'done
14678 (condition-case nil
14679 (progn
14680 (org-back-to-heading t)
14681 (while (not (equal lastpos (point)))
14682 (setq lastpos (point))
14683 (when (looking-at
14684 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14685 (setq ltags (org-split-string
14686 (org-match-string-no-properties 1) ":"))
14687 (when parent
14688 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14689 (setq tags (append
14690 (if parent
14691 (org-remove-uninherited-tags ltags)
14692 ltags)
14693 tags)))
14694 (or org-use-tag-inheritance (throw 'done t))
14695 (if local (throw 'done t))
14696 (or (org-up-heading-safe) (error nil))
14697 (setq parent t)))
14698 (error nil)))))
14699 (if local
14700 tags
14701 (reverse (delete-dups
14702 (reverse (append
14703 (org-remove-uninherited-tags
14704 org-file-tags) tags)))))))))
14706 (defun org-add-prop-inherited (s)
14707 (add-text-properties 0 (length s) '(inherited t) s)
14710 (defun org-toggle-tag (tag &optional onoff)
14711 "Toggle the tag TAG for the current line.
14712 If ONOFF is `on' or `off', don't toggle but set to this state."
14713 (let (res current)
14714 (save-excursion
14715 (org-back-to-heading t)
14716 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14717 (point-at-eol) t)
14718 (progn
14719 (setq current (match-string 1))
14720 (replace-match ""))
14721 (setq current ""))
14722 (setq current (nreverse (org-split-string current ":")))
14723 (cond
14724 ((eq onoff 'on)
14725 (setq res t)
14726 (or (member tag current) (push tag current)))
14727 ((eq onoff 'off)
14728 (or (not (member tag current)) (setq current (delete tag current))))
14729 (t (if (member tag current)
14730 (setq current (delete tag current))
14731 (setq res t)
14732 (push tag current))))
14733 (end-of-line 1)
14734 (if current
14735 (progn
14736 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14737 (org-set-tags nil t))
14738 (delete-horizontal-space))
14739 (run-hooks 'org-after-tags-change-hook))
14740 res))
14742 (defun org-align-tags-here (to-col)
14743 ;; Assumes that this is a headline
14744 "Align tags on the current headline to TO-COL."
14745 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14746 (beginning-of-line 1)
14747 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14748 (< pos (match-beginning 2)))
14749 (progn
14750 (setq tags-l (- (match-end 2) (match-beginning 2)))
14751 (goto-char (match-beginning 1))
14752 (insert " ")
14753 (delete-region (point) (1+ (match-beginning 2)))
14754 (setq ncol (max (current-column)
14755 (1+ col)
14756 (if (> to-col 0)
14757 to-col
14758 (- (abs to-col) tags-l))))
14759 (setq p (point))
14760 (insert (make-string (- ncol (current-column)) ?\ ))
14761 (setq ncol (current-column))
14762 (when indent-tabs-mode (tabify p (point-at-eol)))
14763 (org-move-to-column (min ncol col)))
14764 (goto-char pos))))
14766 (defun org-set-tags-command (&optional arg just-align)
14767 "Call the set-tags command for the current entry."
14768 (interactive "P")
14769 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14770 (org-set-tags arg just-align)
14771 (save-excursion
14772 (unless (and (org-region-active-p)
14773 org-loop-over-headlines-in-active-region)
14774 (org-back-to-heading t))
14775 (org-set-tags arg just-align))))
14777 (defun org-set-tags-to (data)
14778 "Set the tags of the current entry to DATA, replacing the current tags.
14779 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14780 If DATA is nil or the empty string, any tags will be removed."
14781 (interactive "sTags: ")
14782 (setq data
14783 (cond
14784 ((eq data nil) "")
14785 ((equal data "") "")
14786 ((stringp data)
14787 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14788 ":"))
14789 ((listp data)
14790 (concat ":" (mapconcat 'identity data ":") ":"))))
14791 (when data
14792 (save-excursion
14793 (org-back-to-heading t)
14794 (when (looking-at org-complex-heading-regexp)
14795 (if (match-end 5)
14796 (progn
14797 (goto-char (match-beginning 5))
14798 (insert data)
14799 (delete-region (point) (point-at-eol))
14800 (org-set-tags nil 'align))
14801 (goto-char (point-at-eol))
14802 (insert " " data)
14803 (org-set-tags nil 'align)))
14804 (beginning-of-line 1)
14805 (if (looking-at ".*?\\([ \t]+\\)$")
14806 (delete-region (match-beginning 1) (match-end 1))))))
14808 (defun org-align-all-tags ()
14809 "Align the tags i all headings."
14810 (interactive)
14811 (save-excursion
14812 (or (ignore-errors (org-back-to-heading t))
14813 (outline-next-heading))
14814 (if (org-at-heading-p)
14815 (org-set-tags t)
14816 (message "No headings"))))
14818 (defvar org-indent-indentation-per-level)
14819 (defun org-set-tags (&optional arg just-align)
14820 "Set the tags for the current headline.
14821 With prefix ARG, realign all tags in headings in the current buffer.
14822 When JUST-ALIGN is non-nil, only align tags."
14823 (interactive "P")
14824 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14825 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14826 'region-start-level 'region))
14827 org-loop-over-headlines-in-active-region)
14828 (org-map-entries
14829 ;; We don't use ARG and JUST-ALIGN here because these args
14830 ;; are not useful when looping over headlines.
14831 `(org-set-tags)
14832 org-loop-over-headlines-in-active-region
14833 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14834 (let* ((re org-outline-regexp-bol)
14835 (current (unless arg (org-get-tags-string)))
14836 (col (current-column))
14837 (org-setting-tags t)
14838 table current-tags inherited-tags ; computed below when needed
14839 tags p0 c0 c1 rpl di tc level)
14840 (if arg
14841 (save-excursion
14842 (goto-char (point-min))
14843 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14844 (while (re-search-forward re nil t)
14845 (org-set-tags nil t)
14846 (end-of-line 1)))
14847 (message "All tags realigned to column %d" org-tags-column))
14848 (if just-align
14849 (setq tags current)
14850 ;; Get a new set of tags from the user
14851 (save-excursion
14852 (setq table (append org-tag-persistent-alist
14853 (or org-tag-alist (org-get-buffer-tags))
14854 (and
14855 org-complete-tags-always-offer-all-agenda-tags
14856 (org-global-tags-completion-table
14857 (org-agenda-files))))
14858 org-last-tags-completion-table table
14859 current-tags (org-split-string current ":")
14860 inherited-tags (nreverse
14861 (nthcdr (length current-tags)
14862 (nreverse (org-get-tags-at))))
14863 tags
14864 (if (or (eq t org-use-fast-tag-selection)
14865 (and org-use-fast-tag-selection
14866 (delq nil (mapcar 'cdr table))))
14867 (org-fast-tag-selection
14868 current-tags inherited-tags table
14869 (if org-fast-tag-selection-include-todo
14870 org-todo-key-alist))
14871 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14872 (org-trim
14873 (org-icompleting-read "Tags: "
14874 'org-tags-completion-function
14875 nil nil current 'org-tags-history))))))
14876 (while (string-match "[-+&]+" tags)
14877 ;; No boolean logic, just a list
14878 (setq tags (replace-match ":" t t tags))))
14880 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14882 (if org-tags-sort-function
14883 (setq tags (mapconcat 'identity
14884 (sort (org-split-string
14885 tags (org-re "[^[:alnum:]_@#%]+"))
14886 org-tags-sort-function) ":")))
14888 (if (string-match "\\`[\t ]*\\'" tags)
14889 (setq tags "")
14890 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14891 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14893 ;; Insert new tags at the correct column
14894 (beginning-of-line 1)
14895 (setq level (or (and (looking-at org-outline-regexp)
14896 (- (match-end 0) (point) 1))
14898 (cond
14899 ((and (equal current "") (equal tags "")))
14900 ((re-search-forward
14901 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14902 (point-at-eol) t)
14903 (if (equal tags "")
14904 (setq rpl "")
14905 (goto-char (match-beginning 0))
14906 (setq c0 (current-column)
14907 ;; compute offset for the case of org-indent-mode active
14908 di (if (org-bound-and-true-p org-indent-mode)
14909 (* (1- org-indent-indentation-per-level) (1- level))
14911 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14912 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14913 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
14914 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14915 (replace-match rpl t t)
14916 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14917 tags)
14918 (t (error "Tags alignment failed")))
14919 (org-move-to-column col)
14920 (unless just-align
14921 (run-hooks 'org-after-tags-change-hook))))))
14923 (defun org-change-tag-in-region (beg end tag off)
14924 "Add or remove TAG for each entry in the region.
14925 This works in the agenda, and also in an org-mode buffer."
14926 (interactive
14927 (list (region-beginning) (region-end)
14928 (let ((org-last-tags-completion-table
14929 (if (derived-mode-p 'org-mode)
14930 (org-uniquify
14931 (delq nil (append (org-get-buffer-tags)
14932 (org-global-tags-completion-table))))
14933 (org-global-tags-completion-table))))
14934 (org-icompleting-read
14935 "Tag: " 'org-tags-completion-function nil nil nil
14936 'org-tags-history))
14937 (progn
14938 (message "[s]et or [r]emove? ")
14939 (equal (read-char-exclusive) ?r))))
14940 (if (fboundp 'deactivate-mark) (deactivate-mark))
14941 (let ((agendap (equal major-mode 'org-agenda-mode))
14942 l1 l2 m buf pos newhead (cnt 0))
14943 (goto-char end)
14944 (setq l2 (1- (org-current-line)))
14945 (goto-char beg)
14946 (setq l1 (org-current-line))
14947 (loop for l from l1 to l2 do
14948 (org-goto-line l)
14949 (setq m (get-text-property (point) 'org-hd-marker))
14950 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14951 (and agendap m))
14952 (setq buf (if agendap (marker-buffer m) (current-buffer))
14953 pos (if agendap m (point)))
14954 (with-current-buffer buf
14955 (save-excursion
14956 (save-restriction
14957 (goto-char pos)
14958 (setq cnt (1+ cnt))
14959 (org-toggle-tag tag (if off 'off 'on))
14960 (setq newhead (org-get-heading)))))
14961 (and agendap (org-agenda-change-all-lines newhead m))))
14962 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14964 (defun org-tags-completion-function (string predicate &optional flag)
14965 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14966 (confirm (lambda (x) (stringp (car x)))))
14967 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14968 (setq s1 (match-string 1 string)
14969 s2 (match-string 2 string))
14970 (setq s1 "" s2 string))
14971 (cond
14972 ((eq flag nil)
14973 ;; try completion
14974 (setq rtn (try-completion s2 ctable confirm))
14975 (if (stringp rtn)
14976 (setq rtn
14977 (concat s1 s2 (substring rtn (length s2))
14978 (if (and org-add-colon-after-tag-completion
14979 (assoc rtn ctable))
14980 ":" ""))))
14981 rtn)
14982 ((eq flag t)
14983 ;; all-completions
14984 (all-completions s2 ctable confirm))
14985 ((eq flag 'lambda)
14986 ;; exact match?
14987 (assoc s2 ctable)))))
14989 (defun org-fast-tag-insert (kwd tags face &optional end)
14990 "Insert KDW, and the TAGS, the latter with face FACE.
14991 Also insert END."
14992 (insert (format "%-12s" (concat kwd ":"))
14993 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14994 (or end "")))
14996 (defun org-fast-tag-show-exit (flag)
14997 (save-excursion
14998 (org-goto-line 3)
14999 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15000 (replace-match ""))
15001 (when flag
15002 (end-of-line 1)
15003 (org-move-to-column (- (window-width) 19) t)
15004 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15006 (defun org-set-current-tags-overlay (current prefix)
15007 "Add an overlay to CURRENT tag with PREFIX."
15008 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15009 (if (featurep 'xemacs)
15010 (org-overlay-display org-tags-overlay (concat prefix s)
15011 'secondary-selection)
15012 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15013 (org-overlay-display org-tags-overlay (concat prefix s)))))
15015 (defvar org-last-tag-selection-key nil)
15016 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15017 "Fast tag selection with single keys.
15018 CURRENT is the current list of tags in the headline, INHERITED is the
15019 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15020 possibly with grouping information. TODO-TABLE is a similar table with
15021 TODO keywords, should these have keys assigned to them.
15022 If the keys are nil, a-z are automatically assigned.
15023 Returns the new tags string, or nil to not change the current settings."
15024 (let* ((fulltable (append table todo-table))
15025 (maxlen (apply 'max (mapcar
15026 (lambda (x)
15027 (if (stringp (car x)) (string-width (car x)) 0))
15028 fulltable)))
15029 (buf (current-buffer))
15030 (expert (eq org-fast-tag-selection-single-key 'expert))
15031 (buffer-tags nil)
15032 (fwidth (+ maxlen 3 1 3))
15033 (ncol (/ (- (window-width) 4) fwidth))
15034 (i-face 'org-done)
15035 (c-face 'org-todo)
15036 tg cnt e c char c1 c2 ntable tbl rtn
15037 ov-start ov-end ov-prefix
15038 (exit-after-next org-fast-tag-selection-single-key)
15039 (done-keywords org-done-keywords)
15040 groups ingroup)
15041 (save-excursion
15042 (beginning-of-line 1)
15043 (if (looking-at
15044 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15045 (setq ov-start (match-beginning 1)
15046 ov-end (match-end 1)
15047 ov-prefix "")
15048 (setq ov-start (1- (point-at-eol))
15049 ov-end (1+ ov-start))
15050 (skip-chars-forward "^\n\r")
15051 (setq ov-prefix
15052 (concat
15053 (buffer-substring (1- (point)) (point))
15054 (if (> (current-column) org-tags-column)
15056 (make-string (- org-tags-column (current-column)) ?\ ))))))
15057 (move-overlay org-tags-overlay ov-start ov-end)
15058 (save-window-excursion
15059 (if expert
15060 (set-buffer (get-buffer-create " *Org tags*"))
15061 (delete-other-windows)
15062 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15063 (org-switch-to-buffer-other-window " *Org tags*"))
15064 (erase-buffer)
15065 (org-set-local 'org-done-keywords done-keywords)
15066 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15067 (org-fast-tag-insert "Current" current c-face "\n\n")
15068 (org-fast-tag-show-exit exit-after-next)
15069 (org-set-current-tags-overlay current ov-prefix)
15070 (setq tbl fulltable char ?a cnt 0)
15071 (while (setq e (pop tbl))
15072 (cond
15073 ((equal (car e) :startgroup)
15074 (push '() groups) (setq ingroup t)
15075 (when (not (= cnt 0))
15076 (setq cnt 0)
15077 (insert "\n"))
15078 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15079 ((equal (car e) :endgroup)
15080 (setq ingroup nil cnt 0)
15081 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15082 ((equal e '(:newline))
15083 (when (not (= cnt 0))
15084 (setq cnt 0)
15085 (insert "\n")
15086 (setq e (car tbl))
15087 (while (equal (car tbl) '(:newline))
15088 (insert "\n")
15089 (setq tbl (cdr tbl)))))
15090 ((equal e '(:grouptags)) nil)
15092 (setq tg (copy-sequence (car e)) c2 nil)
15093 (if (cdr e)
15094 (setq c (cdr e))
15095 ;; automatically assign a character.
15096 (setq c1 (string-to-char
15097 (downcase (substring
15098 tg (if (= (string-to-char tg) ?@) 1 0)))))
15099 (if (or (rassoc c1 ntable) (rassoc c1 table))
15100 (while (or (rassoc char ntable) (rassoc char table))
15101 (setq char (1+ char)))
15102 (setq c2 c1))
15103 (setq c (or c2 char)))
15104 (if ingroup (push tg (car groups)))
15105 (setq tg (org-add-props tg nil 'face
15106 (cond
15107 ((not (assoc tg table))
15108 (org-get-todo-face tg))
15109 ((member tg current) c-face)
15110 ((member tg inherited) i-face))))
15111 (if (equal (caar tbl) :grouptags)
15112 (org-add-props tg nil 'face 'org-tag-group))
15113 (if (and (= cnt 0) (not ingroup)) (insert " "))
15114 (insert "[" c "] " tg (make-string
15115 (- fwidth 4 (length tg)) ?\ ))
15116 (push (cons tg c) ntable)
15117 (when (= (setq cnt (1+ cnt)) ncol)
15118 (insert "\n")
15119 (if ingroup (insert " "))
15120 (setq cnt 0)))))
15121 (setq ntable (nreverse ntable))
15122 (insert "\n")
15123 (goto-char (point-min))
15124 (if (not expert) (org-fit-window-to-buffer))
15125 (setq rtn
15126 (catch 'exit
15127 (while t
15128 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15129 (if (not groups) "no " "")
15130 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15131 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15132 (setq org-last-tag-selection-key c)
15133 (cond
15134 ((= c ?\r) (throw 'exit t))
15135 ((= c ?!)
15136 (setq groups (not groups))
15137 (goto-char (point-min))
15138 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15139 ((= c ?\C-c)
15140 (if (not expert)
15141 (org-fast-tag-show-exit
15142 (setq exit-after-next (not exit-after-next)))
15143 (setq expert nil)
15144 (delete-other-windows)
15145 (set-window-buffer (split-window-vertically) " *Org tags*")
15146 (org-switch-to-buffer-other-window " *Org tags*")
15147 (org-fit-window-to-buffer)))
15148 ((or (= c ?\C-g)
15149 (and (= c ?q) (not (rassoc c ntable))))
15150 (org-detach-overlay org-tags-overlay)
15151 (setq quit-flag t))
15152 ((= c ?\ )
15153 (setq current nil)
15154 (if exit-after-next (setq exit-after-next 'now)))
15155 ((= c ?\t)
15156 (condition-case nil
15157 (setq tg (org-icompleting-read
15158 "Tag: "
15159 (or buffer-tags
15160 (with-current-buffer buf
15161 (org-get-buffer-tags)))))
15162 (quit (setq tg "")))
15163 (when (string-match "\\S-" tg)
15164 (add-to-list 'buffer-tags (list tg))
15165 (if (member tg current)
15166 (setq current (delete tg current))
15167 (push tg current)))
15168 (if exit-after-next (setq exit-after-next 'now)))
15169 ((setq e (rassoc c todo-table) tg (car e))
15170 (with-current-buffer buf
15171 (save-excursion (org-todo tg)))
15172 (if exit-after-next (setq exit-after-next 'now)))
15173 ((setq e (rassoc c ntable) tg (car e))
15174 (if (member tg current)
15175 (setq current (delete tg current))
15176 (loop for g in groups do
15177 (if (member tg g)
15178 (mapc (lambda (x)
15179 (setq current (delete x current)))
15180 g)))
15181 (push tg current))
15182 (if exit-after-next (setq exit-after-next 'now))))
15184 ;; Create a sorted list
15185 (setq current
15186 (sort current
15187 (lambda (a b)
15188 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15189 (if (eq exit-after-next 'now) (throw 'exit t))
15190 (goto-char (point-min))
15191 (beginning-of-line 2)
15192 (delete-region (point) (point-at-eol))
15193 (org-fast-tag-insert "Current" current c-face)
15194 (org-set-current-tags-overlay current ov-prefix)
15195 (while (re-search-forward
15196 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15197 (setq tg (match-string 1))
15198 (add-text-properties
15199 (match-beginning 1) (match-end 1)
15200 (list 'face
15201 (cond
15202 ((member tg current) c-face)
15203 ((member tg inherited) i-face)
15204 (t (get-text-property (match-beginning 1) 'face))))))
15205 (goto-char (point-min)))))
15206 (org-detach-overlay org-tags-overlay)
15207 (if rtn
15208 (mapconcat 'identity current ":")
15209 nil))))
15211 (defun org-get-tags-string ()
15212 "Get the TAGS string in the current headline."
15213 (unless (org-at-heading-p t)
15214 (user-error "Not on a heading"))
15215 (save-excursion
15216 (beginning-of-line 1)
15217 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15218 (org-match-string-no-properties 1)
15219 "")))
15221 (defun org-get-tags ()
15222 "Get the list of tags specified in the current headline."
15223 (org-split-string (org-get-tags-string) ":"))
15225 (defun org-get-buffer-tags ()
15226 "Get a table of all tags used in the buffer, for completion."
15227 (org-with-wide-buffer
15228 (goto-char (point-min))
15229 (let ((tag-re (concat org-outline-regexp-bol
15230 "\\(?:.*?[ \t]\\)?"
15231 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15232 tags)
15233 (while (re-search-forward tag-re nil t)
15234 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15235 (push tag tags)))
15236 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15238 ;;;; The mapping API
15240 (defun org-map-entries (func &optional match scope &rest skip)
15241 "Call FUNC at each headline selected by MATCH in SCOPE.
15243 FUNC is a function or a lisp form. The function will be called without
15244 arguments, with the cursor positioned at the beginning of the headline.
15245 The return values of all calls to the function will be collected and
15246 returned as a list.
15248 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15249 does not need to preserve point. After evaluation, the cursor will be
15250 moved to the end of the line (presumably of the headline of the
15251 processed entry) and search continues from there. Under some
15252 circumstances, this may not produce the wanted results. For example,
15253 if you have removed (e.g. archived) the current (sub)tree it could
15254 mean that the next entry will be skipped entirely. In such cases, you
15255 can specify the position from where search should continue by making
15256 FUNC set the variable `org-map-continue-from' to the desired buffer
15257 position.
15259 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15260 Only headlines that are matched by this query will be considered during
15261 the iteration. When MATCH is nil or t, all headlines will be
15262 visited by the iteration.
15264 SCOPE determines the scope of this command. It can be any of:
15266 nil The current buffer, respecting the restriction if any
15267 tree The subtree started with the entry at point
15268 region The entries within the active region, if any
15269 region-start-level
15270 The entries within the active region, but only those at
15271 the same level than the first one.
15272 file The current buffer, without restriction
15273 file-with-archives
15274 The current buffer, and any archives associated with it
15275 agenda All agenda files
15276 agenda-with-archives
15277 All agenda files with any archive files associated with them
15278 \(file1 file2 ...)
15279 If this is a list, all files in the list will be scanned
15281 The remaining args are treated as settings for the skipping facilities of
15282 the scanner. The following items can be given here:
15284 archive skip trees with the archive tag
15285 comment skip trees with the COMMENT keyword
15286 function or Emacs Lisp form:
15287 will be used as value for `org-agenda-skip-function', so
15288 whenever the function returns a position, FUNC will not be
15289 called for that entry and search will continue from the
15290 position returned
15292 If your function needs to retrieve the tags including inherited tags
15293 at the *current* entry, you can use the value of the variable
15294 `org-scanner-tags' which will be much faster than getting the value
15295 with `org-get-tags-at'. If your function gets properties with
15296 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15297 to t around the call to `org-entry-properties' to get the same speedup.
15298 Note that if your function moves around to retrieve tags and properties at
15299 a *different* entry, you cannot use these techniques."
15300 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15301 (not (org-region-active-p)))
15302 (let* ((org-agenda-archives-mode nil) ; just to make sure
15303 (org-agenda-skip-archived-trees (memq 'archive skip))
15304 (org-agenda-skip-comment-trees (memq 'comment skip))
15305 (org-agenda-skip-function
15306 (car (org-delete-all '(comment archive) skip)))
15307 (org-tags-match-list-sublevels t)
15308 (start-level (eq scope 'region-start-level))
15309 matcher file res
15310 org-todo-keywords-for-agenda
15311 org-done-keywords-for-agenda
15312 org-todo-keyword-alist-for-agenda
15313 org-tag-alist-for-agenda
15314 todo-only)
15316 (cond
15317 ((eq match t) (setq matcher t))
15318 ((eq match nil) (setq matcher t))
15319 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15321 (save-excursion
15322 (save-restriction
15323 (cond ((eq scope 'tree)
15324 (org-back-to-heading t)
15325 (org-narrow-to-subtree)
15326 (setq scope nil))
15327 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15328 (org-region-active-p))
15329 ;; If needed, set start-level to a string like "2"
15330 (when start-level
15331 (save-excursion
15332 (goto-char (region-beginning))
15333 (unless (org-at-heading-p) (outline-next-heading))
15334 (setq start-level (org-current-level))))
15335 (narrow-to-region (region-beginning)
15336 (save-excursion
15337 (goto-char (region-end))
15338 (unless (and (bolp) (org-at-heading-p))
15339 (outline-next-heading))
15340 (point)))
15341 (setq scope nil)))
15343 (if (not scope)
15344 (progn
15345 (org-agenda-prepare-buffers
15346 (list (buffer-file-name (current-buffer))))
15347 (setq res (org-scan-tags func matcher todo-only start-level)))
15348 ;; Get the right scope
15349 (cond
15350 ((and scope (listp scope) (symbolp (car scope)))
15351 (setq scope (eval scope)))
15352 ((eq scope 'agenda)
15353 (setq scope (org-agenda-files t)))
15354 ((eq scope 'agenda-with-archives)
15355 (setq scope (org-agenda-files t))
15356 (setq scope (org-add-archive-files scope)))
15357 ((eq scope 'file)
15358 (setq scope (list (buffer-file-name))))
15359 ((eq scope 'file-with-archives)
15360 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15361 (org-agenda-prepare-buffers scope)
15362 (while (setq file (pop scope))
15363 (with-current-buffer (org-find-base-buffer-visiting file)
15364 (save-excursion
15365 (save-restriction
15366 (widen)
15367 (goto-char (point-min))
15368 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15369 res)))
15371 ;;; Properties API
15373 (defconst org-special-properties
15374 '("ALLTAGS" "BLOCKED" "CATEGORY" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE"
15375 "FILE" "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA"
15376 "TODO")
15377 "The special properties valid in Org mode.
15378 These are properties that are not defined in the property drawer,
15379 but in some other way.")
15381 (defconst org-default-properties
15382 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15383 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15384 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15385 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15386 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15387 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15388 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15389 "Some properties that are used by Org mode for various purposes.
15390 Being in this list makes sure that they are offered for completion.")
15392 (defun org--update-property-plist (key val props)
15393 "Associate KEY to VAL in alist PROPS.
15394 Modifications are made by side-effect. Return new alist."
15395 (let* ((appending (string= (substring key -1) "+"))
15396 (key (if appending (substring key 0 -1) key))
15397 (old (assoc-string key props t)))
15398 (if (not old) (cons (cons key val) props)
15399 (setcdr old (if appending (concat (cdr old) " " val) val))
15400 props)))
15402 (defun org-get-property-block (&optional beg force)
15403 "Return the (beg . end) range of the body of the property drawer.
15404 BEG is the beginning of the current subtree, or of the part
15405 before the first headline. If it is not given, it will be found.
15406 If the drawer does not exist, create it if FORCE is non-nil, or
15407 return nil."
15408 (org-with-wide-buffer
15409 (when beg (goto-char beg))
15410 (unless (org-before-first-heading-p)
15411 (let ((beg (cond (beg)
15412 ((or (not (featurep 'org-inlinetask))
15413 (org-inlinetask-in-task-p))
15414 (org-back-to-heading t))
15415 (t (org-with-limited-levels (org-back-to-heading t))))))
15416 (forward-line)
15417 (when (org-looking-at-p org-planning-line-re) (forward-line))
15418 (cond ((looking-at org-property-drawer-re)
15419 (forward-line)
15420 (cons (point) (progn (goto-char (match-end 0))
15421 (line-beginning-position))))
15422 (force
15423 (goto-char beg)
15424 (org-insert-property-drawer)
15425 (let ((pos (save-excursion (search-forward ":END:")
15426 (line-beginning-position))))
15427 (cons pos pos))))))))
15429 (defun org-at-property-p ()
15430 "Non-nil when point is inside a property drawer.
15431 See `org-property-re' for match data, if applicable."
15432 (save-excursion
15433 (beginning-of-line)
15434 (and (looking-at org-property-re)
15435 (let ((property-drawer (save-match-data (org-get-property-block))))
15436 (and property-drawer (< (point) (cdr property-drawer)))))))
15438 (defun org-property-action ()
15439 "Do an action on properties."
15440 (interactive)
15441 (unless (org-at-property-p) (user-error "Not at a property"))
15442 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15443 (let ((c (read-char-exclusive)))
15444 (case c
15445 (?s (call-interactively #'org-set-property))
15446 (?d (call-interactively #'org-delete-property))
15447 (?D (call-interactively #'org-delete-property-globally))
15448 (?c (call-interactively #'org-compute-property-at-point))
15449 (otherwise (user-error "No such property action %c" c)))))
15451 (defun org-inc-effort ()
15452 "Increment the value of the effort property in the current entry."
15453 (interactive)
15454 (org-set-effort nil t))
15456 (defvar org-clock-effort) ; Defined in org-clock.el.
15457 (defvar org-clock-current-task) ; Defined in org-clock.el.
15458 (defun org-set-effort (&optional value increment)
15459 "Set the effort property of the current entry.
15460 With numerical prefix arg, use the nth allowed value, 0 stands for the
15461 10th allowed value.
15463 When INCREMENT is non-nil, set the property to the next allowed value."
15464 (interactive "P")
15465 (if (equal value 0) (setq value 10))
15466 (let* ((completion-ignore-case t)
15467 (prop org-effort-property)
15468 (cur (org-entry-get nil prop))
15469 (allowed (org-property-get-allowed-values nil prop 'table))
15470 (existing (mapcar 'list (org-property-values prop)))
15471 (heading (nth 4 (org-heading-components)))
15473 (val (cond
15474 ((stringp value) value)
15475 ((and allowed (integerp value))
15476 (or (car (nth (1- value) allowed))
15477 (car (org-last allowed))))
15478 ((and allowed increment)
15479 (or (caadr (member (list cur) allowed))
15480 (user-error "Allowed effort values are not set")))
15481 (allowed
15482 (message "Select 1-9,0, [RET%s]: %s"
15483 (if cur (concat "=" cur) "")
15484 (mapconcat 'car allowed " "))
15485 (setq rpl (read-char-exclusive))
15486 (if (equal rpl ?\r)
15488 (setq rpl (- rpl ?0))
15489 (if (equal rpl 0) (setq rpl 10))
15490 (if (and (> rpl 0) (<= rpl (length allowed)))
15491 (car (nth (1- rpl) allowed))
15492 (org-completing-read "Effort: " allowed nil))))
15494 (let (org-completion-use-ido org-completion-use-iswitchb)
15495 (org-completing-read
15496 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15497 (concat "[" cur "]") "")
15498 ": ")
15499 existing nil nil "" nil cur))))))
15500 (unless (equal (org-entry-get nil prop) val)
15501 (org-entry-put nil prop val))
15502 (org-refresh-property
15503 '((effort . identity)
15504 (effort-minutes . org-duration-string-to-minutes))
15505 val)
15506 (when (string= heading org-clock-current-task)
15507 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15508 (org-clock-update-mode-line))
15509 (message "%s is now %s" prop val)))
15511 (defun org-entry-properties (&optional pom which)
15512 "Get all properties of the current entry.
15514 When POM is a buffer position, get all properties from the entry
15515 there instead.
15517 This includes the TODO keyword, the tags, time strings for
15518 deadline, scheduled, and clocking, and any additional properties
15519 defined in the entry.
15521 If WHICH is nil or `all', get all properties. If WHICH is
15522 `special' or `standard', only get that subclass. If WHICH is
15523 a string, only get that property.
15525 Return value is an alist. Keys are properties, as upcased
15526 strings."
15527 (org-with-point-at pom
15528 (when (and (derived-mode-p 'org-mode)
15529 (ignore-errors (org-back-to-heading t)))
15530 (catch 'exit
15531 (let* ((beg (point))
15532 (specific (and (stringp which) (upcase which)))
15533 (which (cond ((not specific) which)
15534 ((member specific org-special-properties) 'special)
15535 (t 'standard)))
15536 props)
15537 ;; Get the special properties, like TODO and TAGS.
15538 (when (memq which '(nil all special))
15539 (when (or (not specific) (string= specific "CLOCKSUM"))
15540 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15541 (when clocksum
15542 (push (cons "CLOCKSUM"
15543 (org-columns-number-to-string
15544 (/ (float clocksum) 60.) 'add_times))
15545 props)))
15546 (when specific (throw 'exit props)))
15547 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15548 (let ((clocksumt (get-text-property (point)
15549 :org-clock-minutes-today)))
15550 (when clocksumt
15551 (push (cons "CLOCKSUM_T"
15552 (org-columns-number-to-string
15553 (/ (float clocksumt) 60.) 'add_times))
15554 props)))
15555 (when specific (throw 'exit props)))
15556 (when (or (not specific) (string= specific "ITEM"))
15557 (when (looking-at org-complex-heading-regexp)
15558 (push (cons "ITEM"
15559 (concat
15560 (org-match-string-no-properties 1)
15561 (let ((title (org-match-string-no-properties 4)))
15562 (when (org-string-nw-p title)
15563 (concat " " (org-remove-tabs title))))))
15564 props))
15565 (when specific (throw 'exit props)))
15566 (when (or (not specific) (string= specific "TODO"))
15567 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15568 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15569 (when specific (throw 'exit props)))
15570 (when (or (not specific) (string= specific "PRIORITY"))
15571 (when (looking-at org-priority-regexp)
15572 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15573 (when specific (throw 'exit props)))
15574 (when (or (not specific) (string= specific "FILE"))
15575 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15576 props)
15577 (when specific (throw 'exit props)))
15578 (when (or (not specific) (string= specific "TAGS"))
15579 (let ((value (org-string-nw-p (org-get-tags-string))))
15580 (when value (push (cons "TAGS" value) props)))
15581 (when specific (throw 'exit props)))
15582 (when (or (not specific) (string= specific "ALLTAGS"))
15583 (let ((value (org-get-tags-at)))
15584 (when value
15585 (push (cons "ALLTAGS"
15586 (format ":%s:" (mapconcat #'identity value ":")))
15587 props)))
15588 (when specific (throw 'exit props)))
15589 (when (or (not specific) (string= specific "BLOCKED"))
15590 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15591 (when specific (throw 'exit props)))
15592 (when (or (not specific)
15593 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15594 (forward-line)
15595 (when (org-looking-at-p org-planning-line-re)
15596 (end-of-line)
15597 (let ((bol (line-beginning-position))
15598 ;; Backward compatibility: time keywords used to
15599 ;; be configurable (before 8.3). Make sure we
15600 ;; get the correct keyword.
15601 (key-assoc `(("CLOSED" . ,org-closed-string)
15602 ("DEADLINE" . ,org-deadline-string)
15603 ("SCHEDULED" . ,org-scheduled-string))))
15604 (dolist (pair (if specific (list (assoc specific key-assoc))
15605 key-assoc))
15606 (save-excursion
15607 (when (search-backward (cdr pair) bol t)
15608 (goto-char (match-end 0))
15609 (skip-chars-forward " \t")
15610 (and (looking-at org-ts-regexp-both)
15611 (push (cons (car pair)
15612 (org-match-string-no-properties 0))
15613 props)))))))
15614 (when specific (throw 'exit props)))
15615 (when (or (not specific)
15616 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15617 (let ((find-ts
15618 (lambda (end ts)
15619 (let ((regexp (if (or (string= specific "TIMESTAMP")
15620 (assoc "TIMESTAMP_IA" ts))
15621 org-ts-regexp
15622 org-ts-regexp-both)))
15623 (catch 'next
15624 (while (re-search-forward regexp end t)
15625 (backward-char)
15626 (let ((object (org-element-context)))
15627 ;; Accept to match timestamps in node
15628 ;; properties, too.
15629 (when (memq (org-element-type object)
15630 '(node-property timestamp))
15631 (let ((type
15632 (org-element-property :type object)))
15633 (cond
15634 ((and (memq type '(active active-range))
15635 (not (equal specific "TIMESTAMP_IA")))
15636 (unless (assoc "TIMESTAMP" ts)
15637 (push (cons "TIMESTAMP"
15638 (org-element-property
15639 :raw-value object))
15641 (when specific (throw 'exit ts))))
15642 ((and (memq type '(inactive inactive-range))
15643 (not (string= specific "TIMESTAMP")))
15644 (unless (assoc "TIMESTAMP_IA" ts)
15645 (push (cons "TIMESTAMP_IA"
15646 (org-element-property
15647 :raw-value object))
15649 (when specific (throw 'exit ts))))))
15650 ;; Both timestamp types are found,
15651 ;; move to next part.
15652 (when (= (length ts) 2) (throw 'next ts)))))
15653 ts)))))
15654 (goto-char beg)
15655 ;; First look for timestamps within headline.
15656 (let ((ts (funcall find-ts (line-end-position) nil)))
15657 (if (= (length ts) 2) (setq props (nconc ts props))
15658 (forward-line)
15659 ;; Then find timestamps in the section, skipping
15660 ;; planning line.
15661 (when (org-looking-at-p org-planning-line-re)
15662 (forward-line))
15663 (let ((end (save-excursion (outline-next-heading))))
15664 (setq props (nconc (funcall find-ts end ts) props))))))))
15665 ;; Get the standard properties, like :PROP:.
15666 (when (memq which '(nil all standard))
15667 ;; If we are looking after a specific property, delegate
15668 ;; to `org-entry-get', which is faster. However, make an
15669 ;; exception for "CATEGORY", since it can be also set
15670 ;; through keywords (i.e. #+CATEGORY).
15671 (if (and specific (not (equal specific "CATEGORY")))
15672 (let ((value (org-entry-get beg specific nil t)))
15673 (throw 'exit (and value (list (cons specific value)))))
15674 (let ((range (org-get-property-block beg)))
15675 (when range
15676 (let ((end (cdr range)) seen-base)
15677 (goto-char (car range))
15678 ;; Unlike to `org--update-property-plist', we
15679 ;; handle the case where base values is found
15680 ;; after its extension. We also forbid standard
15681 ;; properties to be named as special properties.
15682 (while (re-search-forward org-property-re end t)
15683 (let* ((key (upcase (org-match-string-no-properties 2)))
15684 (extendp (org-string-match-p "\\+\\'" key))
15685 (key-base (if extendp (substring key 0 -1) key))
15686 (value (org-match-string-no-properties 3)))
15687 (cond
15688 ((member-ignore-case key-base org-special-properties))
15689 (extendp
15690 (setq props
15691 (org--update-property-plist key value props)))
15692 ((member key seen-base))
15693 (t (push key seen-base)
15694 (let ((p (assoc-string key props t)))
15695 (if p (setcdr p (concat value " " (cdr p)))
15696 (push (cons key value) props))))))))))))
15697 (unless (assoc "CATEGORY" props)
15698 (push (cons "CATEGORY" (org-get-category beg)) props)
15699 (when (string= specific "CATEGORY") (throw 'exit props)))
15700 ;; Return value.
15701 (append (get-text-property beg 'org-summaries) props))))))
15703 (defun org-entry-get (pom property &optional inherit literal-nil)
15704 "Get value of PROPERTY for entry or content at point-or-marker POM.
15706 If INHERIT is non-nil and the entry does not have the property,
15707 then also check higher levels of the hierarchy. If INHERIT is
15708 the symbol `selective', use inheritance only if the setting in
15709 `org-use-property-inheritance' selects PROPERTY for inheritance.
15711 If the property is present but empty, the return value is the
15712 empty string. If the property is not present at all, nil is
15713 returned. In any other case, return the value as a string.
15714 Search is case-insensitive.
15716 If LITERAL-NIL is set, return the string value \"nil\" as
15717 a string, do not interpret it as the list atom nil. This is used
15718 for inheritance when a \"nil\" value can supersede a non-nil
15719 value higher up the hierarchy."
15720 (org-with-point-at pom
15721 (cond
15722 ((and inherit
15723 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15724 (org-entry-get-with-inheritance property literal-nil))
15725 ((member-ignore-case property org-special-properties)
15726 ;; We need a special property. Use `org-entry-properties' to
15727 ;; retrieve it, but specify the wanted property.
15728 (cdr (assoc-string property (org-entry-properties nil property))))
15730 (let ((range (org-get-property-block)))
15731 (when range
15732 (let* ((case-fold-search t)
15733 (end (cdr range))
15734 (props
15735 (let ((global
15736 (or (assoc-string property org-file-properties t)
15737 (assoc-string property org-global-properties t)
15738 (assoc-string
15739 property org-global-properties-fixed t))))
15740 ;; Make sure to not re-use GLOBAL as
15741 ;; `org--update-property-plist' would alter it by
15742 ;; side-effect.
15743 (and global (list (cons property (cdr global))))))
15744 (find-value
15745 (lambda (key)
15746 (when (re-search-forward (org-re-property key nil t) end t)
15747 (setq props
15748 (org--update-property-plist
15749 key (org-match-string-no-properties 3) props))))))
15750 (goto-char (car range))
15751 ;; Find base value.
15752 (save-excursion (funcall find-value property))
15753 ;; Find additional values.
15754 (let ((property+ (concat property "+")))
15755 (while (funcall find-value property+)))
15756 ;; Return final value.
15757 (let ((val (cdr (assoc-string property props t))))
15758 (if literal-nil val (org-not-nil val))))))))))
15760 (defun org-property-or-variable-value (var &optional inherit)
15761 "Check if there is a property fixing the value of VAR.
15762 If yes, return this value. If not, return the current value of the variable."
15763 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15764 (if (and prop (stringp prop) (string-match "\\S-" prop))
15765 (read prop)
15766 (symbol-value var))))
15768 (defun org-entry-delete (pom property)
15769 "Delete the property PROPERTY from entry at point-or-marker POM."
15770 (unless (member property org-special-properties)
15771 (org-with-point-at pom
15772 (let ((range (org-get-property-block)))
15773 (when range
15774 (let ((begin (car range))
15775 (end (copy-marker (cdr range))))
15776 (goto-char begin)
15777 (when (re-search-forward (org-re-property property nil t) end t)
15778 (delete-region (match-beginning 0) (line-beginning-position 2))
15779 ;; If drawer is empty, remove it altogether.
15780 (when (= begin end)
15781 (delete-region (line-beginning-position 0)
15782 (line-beginning-position 2)))
15783 (set-marker end nil))))))))
15785 ;; Multi-values properties are properties that contain multiple values
15786 ;; These values are assumed to be single words, separated by whitespace.
15787 (defun org-entry-add-to-multivalued-property (pom property value)
15788 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15789 (let* ((old (org-entry-get pom property))
15790 (values (and old (org-split-string old "[ \t]"))))
15791 (setq value (org-entry-protect-space value))
15792 (unless (member value values)
15793 (setq values (append values (list value)))
15794 (org-entry-put pom property
15795 (mapconcat 'identity values " ")))))
15797 (defun org-entry-remove-from-multivalued-property (pom property value)
15798 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15799 (let* ((old (org-entry-get pom property))
15800 (values (and old (org-split-string old "[ \t]"))))
15801 (setq value (org-entry-protect-space value))
15802 (when (member value values)
15803 (setq values (delete value values))
15804 (org-entry-put pom property
15805 (mapconcat 'identity values " ")))))
15807 (defun org-entry-member-in-multivalued-property (pom property value)
15808 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15809 (let* ((old (org-entry-get pom property))
15810 (values (and old (org-split-string old "[ \t]"))))
15811 (setq value (org-entry-protect-space value))
15812 (member value values)))
15814 (defun org-entry-get-multivalued-property (pom property)
15815 "Return a list of values in a multivalued property."
15816 (let* ((value (org-entry-get pom property))
15817 (values (and value (org-split-string value "[ \t]"))))
15818 (mapcar 'org-entry-restore-space values)))
15820 (defun org-entry-put-multivalued-property (pom property &rest values)
15821 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15822 VALUES should be a list of strings. Spaces will be protected."
15823 (org-entry-put pom property
15824 (mapconcat 'org-entry-protect-space values " "))
15825 (let* ((value (org-entry-get pom property))
15826 (values (and value (org-split-string value "[ \t]"))))
15827 (mapcar 'org-entry-restore-space values)))
15829 (defun org-entry-protect-space (s)
15830 "Protect spaces and newline in string S."
15831 (while (string-match " " s)
15832 (setq s (replace-match "%20" t t s)))
15833 (while (string-match "\n" s)
15834 (setq s (replace-match "%0A" t t s)))
15837 (defun org-entry-restore-space (s)
15838 "Restore spaces and newline in string S."
15839 (while (string-match "%20" s)
15840 (setq s (replace-match " " t t s)))
15841 (while (string-match "%0A" s)
15842 (setq s (replace-match "\n" t t s)))
15845 (defvar org-entry-property-inherited-from (make-marker)
15846 "Marker pointing to the entry from where a property was inherited.
15847 Each call to `org-entry-get-with-inheritance' will set this marker to the
15848 location of the entry where the inheritance search matched. If there was
15849 no match, the marker will point nowhere.
15850 Note that also `org-entry-get' calls this function, if the INHERIT flag
15851 is set.")
15853 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15854 "Get PROPERTY of entry or content at point, search higher levels if needed.
15855 The search will stop at the first ancestor which has the property defined.
15856 If the value found is \"nil\", return nil to show that the property
15857 should be considered as undefined (this is the meaning of nil here).
15858 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15859 (move-marker org-entry-property-inherited-from nil)
15860 (let (value)
15861 (org-with-wide-buffer
15862 (catch 'exit
15863 (while t
15864 (when (setq value (org-entry-get nil property nil literal-nil))
15865 (org-back-to-heading t)
15866 (move-marker org-entry-property-inherited-from (point))
15867 (throw 'exit nil))
15868 (or (org-up-heading-safe) (throw 'exit nil)))))
15869 (unless value
15870 (setq value
15871 (cdr (or (assoc-string property org-file-properties t)
15872 (assoc-string property org-global-properties t)
15873 (assoc-string property org-global-properties-fixed t)))))
15874 (if literal-nil value (org-not-nil value))))
15876 (defvar org-property-changed-functions nil
15877 "Hook called when the value of a property has changed.
15878 Each hook function should accept two arguments, the name of the property
15879 and the new value.")
15881 (defun org-entry-put (pom property value)
15882 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15884 If the value is `nil', it is converted to the empty string. If
15885 it is not a string, an error is raised.
15887 PROPERTY can be any regular property (see
15888 `org-special-properties'). It can also be \"TODO\",
15889 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
15891 For the last two properties, VALUE may have any of the special
15892 values \"earlier\" and \"later\". The function then increases or
15893 decreases scheduled or deadline date by one day."
15894 (cond ((null value) (setq value ""))
15895 ((not (stringp value)) (error "Properties values should be strings")))
15896 (org-with-point-at pom
15897 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
15898 (org-back-to-heading t)
15899 (org-with-limited-levels (org-back-to-heading t)))
15900 (let ((beg (point)))
15901 (cond
15902 ((equal property "TODO")
15903 (cond ((not (org-string-nw-p value)) (setq value 'none))
15904 ((not (member value org-todo-keywords-1))
15905 (user-error "\"%s\" is not a valid TODO state" value)))
15906 (org-todo value)
15907 (org-set-tags nil 'align))
15908 ((equal property "PRIORITY")
15909 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
15910 (org-set-tags nil 'align))
15911 ((equal property "SCHEDULED")
15912 (forward-line)
15913 (if (and (org-looking-at-p org-planning-line-re)
15914 (re-search-forward
15915 org-scheduled-time-regexp (line-end-position) t))
15916 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15917 ((string= value "later") (org-timestamp-change 1 'day))
15918 ((string= value "") (org-schedule '(4)))
15919 (t (org-schedule nil value)))
15920 (if (member value '("earlier" "later" ""))
15921 (call-interactively #'org-schedule)
15922 (org-schedule nil value))))
15923 ((equal property "DEADLINE")
15924 (forward-line)
15925 (if (and (org-looking-at-p org-planning-line-re)
15926 (re-search-forward
15927 org-deadline-time-regexp (line-end-position) t))
15928 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15929 ((string= value "later") (org-timestamp-change 1 'day))
15930 ((string= value "") (org-deadline '(4)))
15931 (t (org-deadline nil value)))
15932 (if (member value '("earlier" "later" ""))
15933 (call-interactively #'org-deadline)
15934 (org-deadline nil value))))
15935 ((member property org-special-properties)
15936 (error "The %s property cannot be set with `org-entry-put'" property))
15938 (let* ((range (org-get-property-block beg 'force))
15939 (end (cdr range))
15940 (case-fold-search t))
15941 (goto-char (car range))
15942 (if (re-search-forward (org-re-property property nil t) end t)
15943 (progn (delete-region (match-beginning 0) (match-end 0))
15944 (goto-char (match-beginning 0)))
15945 (goto-char end)
15946 (insert "\n")
15947 (backward-char))
15948 (insert ":" property ":")
15949 (when value (insert " " value))
15950 (org-indent-line)))))
15951 (run-hook-with-args 'org-property-changed-functions property value)))
15953 (defun org-buffer-property-keys (&optional specials defaults columns)
15954 "Get all property keys in the current buffer.
15956 When SPECIALS is non-nil, also list the special properties that
15957 reflect things like tags and TODO state.
15959 When DEFAULTS is non-nil, also include properties that has
15960 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
15961 DESCRIPTION, LOCATION, and LOGGING and others.
15963 When COLUMNS in non-nil, also include property names given in
15964 COLUMN formats in the current buffer."
15965 (let ((case-fold-search t)
15966 (props (append
15967 (and specials org-special-properties)
15968 (and defaults (cons org-effort-property org-default-properties))
15969 nil)))
15970 (org-with-wide-buffer
15971 (goto-char (point-min))
15972 (while (re-search-forward org-property-start-re nil t)
15973 (let ((range (org-get-property-block)))
15974 (catch 'skip
15975 (unless range
15976 (when (and (not (org-before-first-heading-p))
15977 (y-or-n-p (format "Malformed drawer at %d, repair?"
15978 (line-beginning-position))))
15979 (org-get-property-block nil t))
15980 (throw 'skip nil))
15981 (goto-char (car range))
15982 (let ((begin (car range))
15983 (end (cdr range)))
15984 ;; Make sure that found property block is not located
15985 ;; before current point, as it would generate an infloop.
15986 ;; It can happen, for example, in the following
15987 ;; situation:
15989 ;; * Headline
15990 ;; :PROPERTIES:
15991 ;; ...
15992 ;; :END:
15993 ;; *************** Inlinetask
15994 ;; #+BEGIN_EXAMPLE
15995 ;; :PROPERTIES:
15996 ;; #+END_EXAMPLE
15998 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
15999 (while (< (point) end)
16000 (let ((p (progn (looking-at org-property-re)
16001 (org-match-string-no-properties 2))))
16002 ;; Only add true property name, not extension symbol.
16003 (add-to-list 'props
16004 (if (not (org-string-match-p "\\+\\'" p)) p
16005 (substring p 0 -1))))
16006 (forward-line))))
16007 (outline-next-heading)))
16008 (when columns
16009 (goto-char (point-min))
16010 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16011 (let ((element (org-element-at-point)))
16012 (when (memq (org-element-type element) '(keyword node-property))
16013 (let ((value (org-element-property :value element))
16014 (start 0))
16015 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16016 (setq start (match-end 0))
16017 (let ((p (org-match-string-no-properties 1 value)))
16018 (unless (member-ignore-case p org-special-properties)
16019 (add-to-list 'props p))))))))))
16020 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16022 (defun org-property-values (key)
16023 "List all non-nil values of property KEY in current buffer."
16024 (org-with-wide-buffer
16025 (goto-char (point-min))
16026 (let ((case-fold-search t)
16027 (re (org-re-property key))
16028 values)
16029 (while (re-search-forward re nil t)
16030 (add-to-list 'values (org-entry-get (point) key)))
16031 values)))
16033 (defun org-insert-property-drawer ()
16034 "Insert a property drawer into the current entry."
16035 (org-with-wide-buffer
16036 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16037 (org-back-to-heading t)
16038 (org-with-limited-levels (org-back-to-heading t)))
16039 (forward-line)
16040 (when (org-looking-at-p org-planning-line-re) (forward-line))
16041 (unless (org-looking-at-p org-property-drawer-re)
16042 (let ((inhibit-read-only t))
16043 (unless (bolp) (insert "\n"))
16044 (let ((begin (point)))
16045 (insert ":PROPERTIES:\n:END:\n")
16046 (org-indent-region begin (point)))))))
16048 (defun org-insert-drawer (&optional arg drawer)
16049 "Insert a drawer at point.
16051 When optional argument ARG is non-nil, insert a property drawer.
16053 Optional argument DRAWER, when non-nil, is a string representing
16054 drawer's name. Otherwise, the user is prompted for a name.
16056 If a region is active, insert the drawer around that region
16057 instead.
16059 Point is left between drawer's boundaries."
16060 (interactive "P")
16061 (let* ((drawer (if arg "PROPERTIES"
16062 (or drawer (read-from-minibuffer "Drawer: ")))))
16063 (cond
16064 ;; With C-u, fall back on `org-insert-property-drawer'
16065 (arg (org-insert-property-drawer))
16066 ;; Check validity of suggested drawer's name.
16067 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16068 (user-error "Invalid drawer name"))
16069 ;; With an active region, insert a drawer at point.
16070 ((not (org-region-active-p))
16071 (progn
16072 (unless (bolp) (insert "\n"))
16073 (insert (format ":%s:\n\n:END:\n" drawer))
16074 (forward-line -2)))
16075 ;; Otherwise, insert the drawer at point
16077 (let ((rbeg (region-beginning))
16078 (rend (copy-marker (region-end))))
16079 (unwind-protect
16080 (progn
16081 (goto-char rbeg)
16082 (beginning-of-line)
16083 (when (save-excursion
16084 (re-search-forward org-outline-regexp-bol rend t))
16085 (user-error "Drawers cannot contain headlines"))
16086 ;; Position point at the beginning of the first
16087 ;; non-blank line in region. Insert drawer's opening
16088 ;; there, then indent it.
16089 (org-skip-whitespace)
16090 (beginning-of-line)
16091 (insert ":" drawer ":\n")
16092 (forward-line -1)
16093 (indent-for-tab-command)
16094 ;; Move point to the beginning of the first blank line
16095 ;; after the last non-blank line in region. Insert
16096 ;; drawer's closing, then indent it.
16097 (goto-char rend)
16098 (skip-chars-backward " \r\t\n")
16099 (insert "\n:END:")
16100 (deactivate-mark t)
16101 (indent-for-tab-command)
16102 (unless (eolp) (insert "\n")))
16103 ;; Clear marker, whatever the outcome of insertion is.
16104 (set-marker rend nil)))))))
16106 (defvar org-property-set-functions-alist nil
16107 "Property set function alist.
16108 Each entry should have the following format:
16110 (PROPERTY . READ-FUNCTION)
16112 The read function will be called with the same argument as
16113 `org-completing-read'.")
16115 (defun org-set-property-function (property)
16116 "Get the function that should be used to set PROPERTY.
16117 This is computed according to `org-property-set-functions-alist'."
16118 (or (cdr (assoc property org-property-set-functions-alist))
16119 'org-completing-read))
16121 (defun org-read-property-value (property)
16122 "Read PROPERTY value from user."
16123 (let* ((completion-ignore-case t)
16124 (allowed (org-property-get-allowed-values nil property 'table))
16125 (cur (org-entry-get nil property))
16126 (prompt (concat property " value"
16127 (if (and cur (string-match "\\S-" cur))
16128 (concat " [" cur "]") "") ": "))
16129 (set-function (org-set-property-function property))
16130 (val (if allowed
16131 (funcall set-function prompt allowed nil
16132 (not (get-text-property 0 'org-unrestricted
16133 (caar allowed))))
16134 (let (org-completion-use-ido org-completion-use-iswitchb)
16135 (funcall set-function prompt
16136 (mapcar 'list (org-property-values property))
16137 nil nil "" nil cur)))))
16138 (org-trim val)))
16140 (defvar org-last-set-property nil)
16141 (defvar org-last-set-property-value nil)
16142 (defun org-read-property-name ()
16143 "Read a property name."
16144 (let* ((completion-ignore-case t)
16145 (keys (org-buffer-property-keys nil t t))
16146 (default-prop (or (save-excursion
16147 (save-match-data
16148 (beginning-of-line)
16149 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
16150 (null (string= (match-string 1) "END"))
16151 (match-string 1))))
16152 org-last-set-property))
16153 (property (org-icompleting-read
16154 (concat "Property"
16155 (if default-prop (concat " [" default-prop "]") "")
16156 ": ")
16157 (mapcar 'list keys)
16158 nil nil nil nil
16159 default-prop)))
16160 (if (member property keys)
16161 property
16162 (or (cdr (assoc (downcase property)
16163 (mapcar (lambda (x) (cons (downcase x) x))
16164 keys)))
16165 property))))
16167 (defun org-set-property-and-value (use-last)
16168 "Allow to set [PROPERTY]: [value] direction from prompt.
16169 When use-default, don't even ask, just use the last
16170 \"[PROPERTY]: [value]\" string from the history."
16171 (interactive "P")
16172 (let* ((completion-ignore-case t)
16173 (pv (or (and use-last org-last-set-property-value)
16174 (org-completing-read
16175 "Enter a \"[Property]: [value]\" pair: "
16176 nil nil nil nil nil
16177 org-last-set-property-value)))
16178 prop val)
16179 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16180 (setq prop (match-string 1 pv)
16181 val (match-string 2 pv))
16182 (org-set-property prop val))))
16184 (defun org-set-property (property value)
16185 "In the current entry, set PROPERTY to VALUE.
16186 When called interactively, this will prompt for a property name, offering
16187 completion on existing and default properties. And then it will prompt
16188 for a value, offering completion either on allowed values (via an inherited
16189 xxx_ALL property) or on existing values in other instances of this property
16190 in the current file."
16191 (interactive (list nil nil))
16192 (let* ((property (or property (org-read-property-name)))
16193 (value (or value (org-read-property-value property)))
16194 (fn (cdr (assoc property org-properties-postprocess-alist))))
16195 (setq org-last-set-property property)
16196 (setq org-last-set-property-value (concat property ": " value))
16197 ;; Possibly postprocess the inserted value:
16198 (when fn (setq value (funcall fn value)))
16199 (unless (equal (org-entry-get nil property) value)
16200 (org-entry-put nil property value))))
16202 (defun org-delete-property (property)
16203 "In the current entry, delete PROPERTY."
16204 (interactive
16205 (let* ((completion-ignore-case t)
16206 (cat (org-entry-get (point) "CATEGORY"))
16207 (props0 (org-entry-properties nil 'standard))
16208 (props (if cat props0
16209 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16210 (prop (if (< 1 (length props))
16211 (org-icompleting-read "Property: " props nil t)
16212 (caar props))))
16213 (list prop)))
16214 (if (not property)
16215 (message "No property to delete in this entry")
16216 (org-entry-delete nil property)
16217 (message "Property \"%s\" deleted" property)))
16219 (defun org-delete-property-globally (property)
16220 "Remove PROPERTY globally, from all entries."
16221 (interactive
16222 (let* ((completion-ignore-case t)
16223 (prop (org-icompleting-read
16224 "Globally remove property: "
16225 (mapcar 'list (org-buffer-property-keys)))))
16226 (list prop)))
16227 (save-excursion
16228 (save-restriction
16229 (widen)
16230 (goto-char (point-min))
16231 (let ((cnt 0))
16232 (while (re-search-forward
16233 (org-re-property property)
16234 nil t)
16235 (setq cnt (1+ cnt))
16236 (delete-region (match-beginning 0) (1+ (point-at-eol))))
16237 (message "Property \"%s\" removed from %d entries" property cnt)))))
16239 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16241 (defun org-compute-property-at-point ()
16242 "Compute the property at point.
16243 This looks for an enclosing column format, extracts the operator and
16244 then applies it to the property in the column format's scope."
16245 (interactive)
16246 (unless (org-at-property-p)
16247 (user-error "Not at a property"))
16248 (let ((prop (org-match-string-no-properties 2)))
16249 (org-columns-get-format-and-top-level)
16250 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16251 (user-error "No operator defined for property %s" prop))
16252 (org-columns-compute prop)))
16254 (defvar org-property-allowed-value-functions nil
16255 "Hook for functions supplying allowed values for a specific property.
16256 The functions must take a single argument, the name of the property, and
16257 return a flat list of allowed values. If \":ETC\" is one of
16258 the values, this means that these values are intended as defaults for
16259 completion, but that other values should be allowed too.
16260 The functions must return nil if they are not responsible for this
16261 property.")
16263 (defun org-property-get-allowed-values (pom property &optional table)
16264 "Get allowed values for the property PROPERTY.
16265 When TABLE is non-nil, return an alist that can directly be used for
16266 completion."
16267 (let (vals)
16268 (cond
16269 ((equal property "TODO")
16270 (setq vals (org-with-point-at pom
16271 (append org-todo-keywords-1 '("")))))
16272 ((equal property "PRIORITY")
16273 (let ((n org-lowest-priority))
16274 (while (>= n org-highest-priority)
16275 (push (char-to-string n) vals)
16276 (setq n (1- n)))))
16277 ((member property org-special-properties))
16278 ((setq vals (run-hook-with-args-until-success
16279 'org-property-allowed-value-functions property)))
16281 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16282 (when (and vals (string-match "\\S-" vals))
16283 (setq vals (car (read-from-string (concat "(" vals ")"))))
16284 (setq vals (mapcar (lambda (x)
16285 (cond ((stringp x) x)
16286 ((numberp x) (number-to-string x))
16287 ((symbolp x) (symbol-name x))
16288 (t "???")))
16289 vals)))))
16290 (when (member ":ETC" vals)
16291 (setq vals (remove ":ETC" vals))
16292 (org-add-props (car vals) '(org-unrestricted t)))
16293 (if table (mapcar 'list vals) vals)))
16295 (defun org-property-previous-allowed-value (&optional previous)
16296 "Switch to the next allowed value for this property."
16297 (interactive)
16298 (org-property-next-allowed-value t))
16300 (defun org-property-next-allowed-value (&optional previous)
16301 "Switch to the next allowed value for this property."
16302 (interactive)
16303 (unless (org-at-property-p)
16304 (user-error "Not at a property"))
16305 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16306 (key (match-string 2))
16307 (value (match-string 3))
16308 (allowed (or (org-property-get-allowed-values (point) key)
16309 (and (member value '("[ ]" "[-]" "[X]"))
16310 '("[ ]" "[X]"))))
16311 (heading (save-match-data (nth 4 (org-heading-components))))
16312 nval)
16313 (unless allowed
16314 (user-error "Allowed values for this property have not been defined"))
16315 (if previous (setq allowed (reverse allowed)))
16316 (if (member value allowed)
16317 (setq nval (car (cdr (member value allowed)))))
16318 (setq nval (or nval (car allowed)))
16319 (if (equal nval value)
16320 (user-error "Only one allowed value for this property"))
16321 (org-at-property-p)
16322 (replace-match (concat " :" key ": " nval) t t)
16323 (org-indent-line)
16324 (beginning-of-line 1)
16325 (skip-chars-forward " \t")
16326 (when (equal prop org-effort-property)
16327 (org-refresh-property
16328 '((effort . identity)
16329 (effort-minutes . org-duration-string-to-minutes))
16330 nval)
16331 (when (string= org-clock-current-task heading)
16332 (setq org-clock-effort nval)
16333 (org-clock-update-mode-line)))
16334 (run-hook-with-args 'org-property-changed-functions key nval)))
16336 (defun org-find-olp (path &optional this-buffer)
16337 "Return a marker pointing to the entry at outline path OLP.
16338 If anything goes wrong, throw an error.
16339 You can wrap this call to catch the error like this:
16341 (condition-case msg
16342 (org-mobile-locate-entry (match-string 4))
16343 (error (nth 1 msg)))
16345 The return value will then be either a string with the error message,
16346 or a marker if everything is OK.
16348 If THIS-BUFFER is set, the outline path does not contain a file,
16349 only headings."
16350 (let* ((file (if this-buffer buffer-file-name (pop path)))
16351 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16352 (level 1)
16353 (lmin 1)
16354 (lmax 1)
16355 limit re end found pos heading cnt flevel)
16356 (unless buffer (error "File not found :%s" file))
16357 (with-current-buffer buffer
16358 (save-excursion
16359 (save-restriction
16360 (widen)
16361 (setq limit (point-max))
16362 (goto-char (point-min))
16363 (while (setq heading (pop path))
16364 (setq re (format org-complex-heading-regexp-format
16365 (regexp-quote heading)))
16366 (setq cnt 0 pos (point))
16367 (while (re-search-forward re end t)
16368 (setq level (- (match-end 1) (match-beginning 1)))
16369 (if (and (>= level lmin) (<= level lmax))
16370 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16371 (when (= cnt 0) (error "Heading not found on level %d: %s"
16372 lmax heading))
16373 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16374 lmax heading))
16375 (goto-char found)
16376 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16377 (setq end (save-excursion (org-end-of-subtree t t))))
16378 (when (org-at-heading-p)
16379 (point-marker)))))))
16381 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16382 "Find node HEADING in BUFFER.
16383 Return a marker to the heading if it was found, or nil if not.
16384 If POS-ONLY is set, return just the position instead of a marker.
16386 The heading text must match exact, but it may have a TODO keyword,
16387 a priority cookie and tags in the standard locations."
16388 (with-current-buffer (or buffer (current-buffer))
16389 (save-excursion
16390 (save-restriction
16391 (widen)
16392 (goto-char (point-min))
16393 (let (case-fold-search)
16394 (if (re-search-forward
16395 (format org-complex-heading-regexp-format
16396 (regexp-quote heading)) nil t)
16397 (if pos-only
16398 (match-beginning 0)
16399 (move-marker (make-marker) (match-beginning 0)))))))))
16401 (defun org-find-exact-heading-in-directory (heading &optional dir)
16402 "Find Org node headline HEADING in all .org files in directory DIR.
16403 When the target headline is found, return a marker to this location."
16404 (let ((files (directory-files (or dir default-directory)
16405 t "\\`[^.#].*\\.org\\'"))
16406 file visiting m buffer)
16407 (catch 'found
16408 (while (setq file (pop files))
16409 (message "trying %s" file)
16410 (setq visiting (org-find-base-buffer-visiting file))
16411 (setq buffer (or visiting (find-file-noselect file)))
16412 (setq m (org-find-exact-headline-in-buffer
16413 heading buffer))
16414 (when (and (not m) (not visiting)) (kill-buffer buffer))
16415 (and m (throw 'found m))))))
16417 (defun org-find-entry-with-id (ident)
16418 "Locate the entry that contains the ID property with exact value IDENT.
16419 IDENT can be a string, a symbol or a number, this function will search for
16420 the string representation of it.
16421 Return the position where this entry starts, or nil if there is no such entry."
16422 (interactive "sID: ")
16423 (let ((id (cond
16424 ((stringp ident) ident)
16425 ((symbol-name ident) (symbol-name ident))
16426 ((numberp ident) (number-to-string ident))
16427 (t (error "IDENT %s must be a string, symbol or number" ident))))
16428 (case-fold-search nil))
16429 (save-excursion
16430 (save-restriction
16431 (widen)
16432 (goto-char (point-min))
16433 (when (re-search-forward
16434 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16435 nil t)
16436 (org-back-to-heading t)
16437 (point))))))
16439 ;;;; Timestamps
16441 (defvar org-last-changed-timestamp nil)
16442 (defvar org-last-inserted-timestamp nil
16443 "The last time stamp inserted with `org-insert-time-stamp'.")
16444 (defvar org-ts-what) ; dynamically scoped parameter
16446 (defun org-time-stamp (arg &optional inactive)
16447 "Prompt for a date/time and insert a time stamp.
16448 If the user specifies a time like HH:MM or if this command is
16449 called with at least one prefix argument, the time stamp contains
16450 the date and the time. Otherwise, only the date is be included.
16452 All parts of a date not specified by the user is filled in from
16453 the current date/time. So if you just press return without
16454 typing anything, the time stamp will represent the current
16455 date/time.
16457 If there is already a timestamp at the cursor, it will be
16458 modified.
16460 With two universal prefix arguments, insert an active timestamp
16461 with the current time without prompting the user.
16463 When called from lisp, the timestamp is inactive if INACTIVE is
16464 non-nil."
16465 (interactive "P")
16466 (let* ((ts nil)
16467 (default-time
16468 ;; Default time is either today, or, when entering a range,
16469 ;; the range start.
16470 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16471 (save-excursion
16472 (re-search-backward
16473 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16474 (- (point) 20) t)))
16475 (apply 'encode-time (org-parse-time-string (match-string 1)))
16476 (current-time)))
16477 (default-input (and ts (org-get-compact-tod ts)))
16478 (repeater (save-excursion
16479 (save-match-data
16480 (beginning-of-line)
16481 (when (re-search-forward
16482 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16483 (save-excursion (progn (end-of-line) (point))) t)
16484 (match-string 0)))))
16485 org-time-was-given org-end-time-was-given time)
16486 (cond
16487 ((and (org-at-timestamp-p t)
16488 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16489 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16490 (insert "--")
16491 (setq time (let ((this-command this-command))
16492 (org-read-date arg 'totime nil nil
16493 default-time default-input inactive)))
16494 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16495 ((org-at-timestamp-p t)
16496 (setq time (let ((this-command this-command))
16497 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16498 (when (org-at-timestamp-p t) ; just to get the match data
16499 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16500 (replace-match "")
16501 (setq org-last-changed-timestamp
16502 (org-insert-time-stamp
16503 time (or org-time-was-given arg)
16504 inactive nil nil (list org-end-time-was-given)))
16505 (when repeater (goto-char (1- (point))) (insert " " repeater)
16506 (setq org-last-changed-timestamp
16507 (concat (substring org-last-inserted-timestamp 0 -1)
16508 " " repeater ">"))))
16509 (message "Timestamp updated"))
16510 ((equal arg '(16))
16511 (org-insert-time-stamp (current-time) t inactive))
16513 (setq time (let ((this-command this-command))
16514 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16515 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16516 nil nil (list org-end-time-was-given))))))
16518 ;; FIXME: can we use this for something else, like computing time differences?
16519 (defun org-get-compact-tod (s)
16520 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16521 (let* ((t1 (match-string 1 s))
16522 (h1 (string-to-number (match-string 2 s)))
16523 (m1 (string-to-number (match-string 3 s)))
16524 (t2 (and (match-end 4) (match-string 5 s)))
16525 (h2 (and t2 (string-to-number (match-string 6 s))))
16526 (m2 (and t2 (string-to-number (match-string 7 s))))
16527 dh dm)
16528 (if (not t2)
16530 (setq dh (- h2 h1) dm (- m2 m1))
16531 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16532 (concat t1 "+" (number-to-string dh)
16533 (and (/= 0 dm) (format ":%02d" dm)))))))
16535 (defun org-time-stamp-inactive (&optional arg)
16536 "Insert an inactive time stamp.
16537 An inactive time stamp is enclosed in square brackets instead of angle
16538 brackets. It is inactive in the sense that it does not trigger agenda entries,
16539 does not link to the calendar and cannot be changed with the S-cursor keys.
16540 So these are more for recording a certain time/date."
16541 (interactive "P")
16542 (org-time-stamp arg 'inactive))
16544 (defvar org-date-ovl (make-overlay 1 1))
16545 (overlay-put org-date-ovl 'face 'org-date-selected)
16546 (org-detach-overlay org-date-ovl)
16548 (defvar org-ans1) ; dynamically scoped parameter
16549 (defvar org-ans2) ; dynamically scoped parameter
16551 (defvar org-plain-time-of-day-regexp) ; defined below
16553 (defvar org-overriding-default-time nil) ; dynamically scoped
16554 (defvar org-read-date-overlay nil)
16555 (defvar org-dcst nil) ; dynamically scoped
16556 (defvar org-read-date-history nil)
16557 (defvar org-read-date-final-answer nil)
16558 (defvar org-read-date-analyze-futurep nil)
16559 (defvar org-read-date-analyze-forced-year nil)
16560 (defvar org-read-date-inactive)
16562 (defvar org-read-date-minibuffer-local-map
16563 (let* ((map (make-sparse-keymap)))
16564 (set-keymap-parent map minibuffer-local-map)
16565 (org-defkey map (kbd ".")
16566 (lambda () (interactive)
16567 ;; Are we at the beginning of the prompt?
16568 (if (looking-back "^[^:]+: ")
16569 (org-eval-in-calendar '(calendar-goto-today))
16570 (insert "."))))
16571 (org-defkey map (kbd "C-.")
16572 (lambda () (interactive)
16573 (org-eval-in-calendar '(calendar-goto-today))))
16574 (org-defkey map [(meta shift left)]
16575 (lambda () (interactive)
16576 (org-eval-in-calendar '(calendar-backward-month 1))))
16577 (org-defkey map [(meta shift right)]
16578 (lambda () (interactive)
16579 (org-eval-in-calendar '(calendar-forward-month 1))))
16580 (org-defkey map [(meta shift up)]
16581 (lambda () (interactive)
16582 (org-eval-in-calendar '(calendar-backward-year 1))))
16583 (org-defkey map [(meta shift down)]
16584 (lambda () (interactive)
16585 (org-eval-in-calendar '(calendar-forward-year 1))))
16586 (org-defkey map [?\e (shift left)]
16587 (lambda () (interactive)
16588 (org-eval-in-calendar '(calendar-backward-month 1))))
16589 (org-defkey map [?\e (shift right)]
16590 (lambda () (interactive)
16591 (org-eval-in-calendar '(calendar-forward-month 1))))
16592 (org-defkey map [?\e (shift up)]
16593 (lambda () (interactive)
16594 (org-eval-in-calendar '(calendar-backward-year 1))))
16595 (org-defkey map [?\e (shift down)]
16596 (lambda () (interactive)
16597 (org-eval-in-calendar '(calendar-forward-year 1))))
16598 (org-defkey map [(shift up)]
16599 (lambda () (interactive)
16600 (org-eval-in-calendar '(calendar-backward-week 1))))
16601 (org-defkey map [(shift down)]
16602 (lambda () (interactive)
16603 (org-eval-in-calendar '(calendar-forward-week 1))))
16604 (org-defkey map [(shift left)]
16605 (lambda () (interactive)
16606 (org-eval-in-calendar '(calendar-backward-day 1))))
16607 (org-defkey map [(shift right)]
16608 (lambda () (interactive)
16609 (org-eval-in-calendar '(calendar-forward-day 1))))
16610 (org-defkey map "!"
16611 (lambda () (interactive)
16612 (org-eval-in-calendar '(diary-view-entries))
16613 (message "")))
16614 (org-defkey map ">"
16615 (lambda () (interactive)
16616 (org-eval-in-calendar '(calendar-scroll-left 1))))
16617 (org-defkey map "<"
16618 (lambda () (interactive)
16619 (org-eval-in-calendar '(calendar-scroll-right 1))))
16620 (org-defkey map "\C-v"
16621 (lambda () (interactive)
16622 (org-eval-in-calendar
16623 '(calendar-scroll-left-three-months 1))))
16624 (org-defkey map "\M-v"
16625 (lambda () (interactive)
16626 (org-eval-in-calendar
16627 '(calendar-scroll-right-three-months 1))))
16628 map)
16629 "Keymap for minibuffer commands when using `org-read-date'.")
16631 (defvar org-def)
16632 (defvar org-defdecode)
16633 (defvar org-with-time)
16635 (defun org-read-date (&optional org-with-time to-time from-string prompt
16636 default-time default-input inactive)
16637 "Read a date, possibly a time, and make things smooth for the user.
16638 The prompt will suggest to enter an ISO date, but you can also enter anything
16639 which will at least partially be understood by `parse-time-string'.
16640 Unrecognized parts of the date will default to the current day, month, year,
16641 hour and minute. If this command is called to replace a timestamp at point,
16642 or to enter the second timestamp of a range, the default time is taken
16643 from the existing stamp. Furthermore, the command prefers the future,
16644 so if you are giving a date where the year is not given, and the day-month
16645 combination is already past in the current year, it will assume you
16646 mean next year. For details, see the manual. A few examples:
16648 3-2-5 --> 2003-02-05
16649 feb 15 --> currentyear-02-15
16650 2/15 --> currentyear-02-15
16651 sep 12 9 --> 2009-09-12
16652 12:45 --> today 12:45
16653 22 sept 0:34 --> currentyear-09-22 0:34
16654 12 --> currentyear-currentmonth-12
16655 Fri --> nearest Friday after today
16656 -Tue --> last Tuesday
16657 etc.
16659 Furthermore you can specify a relative date by giving, as the *first* thing
16660 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16661 change in days weeks, months, years.
16662 With a single plus or minus, the date is relative to today. With a double
16663 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16664 +4d --> four days from today
16665 +4 --> same as above
16666 +2w --> two weeks from today
16667 ++5 --> five days from default date
16669 The function understands only English month and weekday abbreviations.
16671 While prompting, a calendar is popped up - you can also select the
16672 date with the mouse (button 1). The calendar shows a period of three
16673 months. To scroll it to other months, use the keys `>' and `<'.
16674 If you don't like the calendar, turn it off with
16675 \(setq org-read-date-popup-calendar nil)
16677 With optional argument TO-TIME, the date will immediately be converted
16678 to an internal time.
16679 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16680 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16681 still enter a time, and this function will inform the calling routine
16682 about this change. The calling routine may then choose to change the
16683 format used to insert the time stamp into the buffer to include the time.
16684 With optional argument FROM-STRING, read from this string instead from
16685 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16686 the time/date that is used for everything that is not specified by the
16687 user."
16688 (require 'parse-time)
16689 (let* ((org-time-stamp-rounding-minutes
16690 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16691 (org-dcst org-display-custom-times)
16692 (ct (org-current-time))
16693 (org-def (or org-overriding-default-time default-time ct))
16694 (org-defdecode (decode-time org-def))
16695 (dummy (progn
16696 (when (< (nth 2 org-defdecode) org-extend-today-until)
16697 (setcar (nthcdr 2 org-defdecode) -1)
16698 (setcar (nthcdr 1 org-defdecode) 59)
16699 (setq org-def (apply 'encode-time org-defdecode)
16700 org-defdecode (decode-time org-def)))))
16701 (cur-frame (selected-frame))
16702 (mouse-autoselect-window nil) ; Don't let the mouse jump
16703 (calendar-frame-setup nil)
16704 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16705 (calendar-move-hook nil)
16706 (calendar-view-diary-initially-flag nil)
16707 (calendar-view-holidays-initially-flag nil)
16708 (timestr (format-time-string
16709 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16710 (prompt (concat (if prompt (concat prompt " ") "")
16711 (format "Date+time [%s]: " timestr)))
16712 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16714 (cond
16715 (from-string (setq ans from-string))
16716 (org-read-date-popup-calendar
16717 (save-excursion
16718 (save-window-excursion
16719 (calendar)
16720 (when (eq calendar-setup 'calendar-only)
16721 (setq cal-frame
16722 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16723 (select-frame cal-frame))
16724 (org-eval-in-calendar '(setq cursor-type nil) t)
16725 (unwind-protect
16726 (progn
16727 (calendar-forward-day (- (time-to-days org-def)
16728 (calendar-absolute-from-gregorian
16729 (calendar-current-date))))
16730 (org-eval-in-calendar nil t)
16731 (let* ((old-map (current-local-map))
16732 (map (copy-keymap calendar-mode-map))
16733 (minibuffer-local-map
16734 (copy-keymap org-read-date-minibuffer-local-map)))
16735 (org-defkey map (kbd "RET") 'org-calendar-select)
16736 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16737 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16738 (unwind-protect
16739 (progn
16740 (use-local-map map)
16741 (setq org-read-date-inactive inactive)
16742 (add-hook 'post-command-hook 'org-read-date-display)
16743 (setq org-ans0 (read-string prompt default-input
16744 'org-read-date-history nil))
16745 ;; org-ans0: from prompt
16746 ;; org-ans1: from mouse click
16747 ;; org-ans2: from calendar motion
16748 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16749 (remove-hook 'post-command-hook 'org-read-date-display)
16750 (use-local-map old-map)
16751 (when org-read-date-overlay
16752 (delete-overlay org-read-date-overlay)
16753 (setq org-read-date-overlay nil)))))
16754 (bury-buffer "*Calendar*")
16755 (when cal-frame
16756 (delete-frame cal-frame)
16757 (select-frame-set-input-focus cur-frame))))))
16759 (t ; Naked prompt only
16760 (unwind-protect
16761 (setq ans (read-string prompt default-input
16762 'org-read-date-history timestr))
16763 (when org-read-date-overlay
16764 (delete-overlay org-read-date-overlay)
16765 (setq org-read-date-overlay nil)))))
16767 (setq final (org-read-date-analyze ans org-def org-defdecode))
16769 (when org-read-date-analyze-forced-year
16770 (message "Year was forced into %s"
16771 (if org-read-date-force-compatible-dates
16772 "compatible range (1970-2037)"
16773 "range representable on this machine"))
16774 (ding))
16776 ;; One round trip to get rid of 34th of August and stuff like that....
16777 (setq final (decode-time (apply 'encode-time final)))
16779 (setq org-read-date-final-answer ans)
16781 (if to-time
16782 (apply 'encode-time final)
16783 (if (and (boundp 'org-time-was-given) org-time-was-given)
16784 (format "%04d-%02d-%02d %02d:%02d"
16785 (nth 5 final) (nth 4 final) (nth 3 final)
16786 (nth 2 final) (nth 1 final))
16787 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16789 (defun org-read-date-display ()
16790 "Display the current date prompt interpretation in the minibuffer."
16791 (when org-read-date-display-live
16792 (when org-read-date-overlay
16793 (delete-overlay org-read-date-overlay))
16794 (when (minibufferp (current-buffer))
16795 (save-excursion
16796 (end-of-line 1)
16797 (while (not (equal (buffer-substring
16798 (max (point-min) (- (point) 4)) (point))
16799 " "))
16800 (insert " ")))
16801 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16802 " " (or org-ans1 org-ans2)))
16803 (org-end-time-was-given nil)
16804 (f (org-read-date-analyze ans org-def org-defdecode))
16805 (fmts (if org-dcst
16806 org-time-stamp-custom-formats
16807 org-time-stamp-formats))
16808 (fmt (if (or org-with-time
16809 (and (boundp 'org-time-was-given) org-time-was-given))
16810 (cdr fmts)
16811 (car fmts)))
16812 (txt (format-time-string fmt (apply 'encode-time f)))
16813 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16814 (txt (concat "=> " txt)))
16815 (when (and org-end-time-was-given
16816 (string-match org-plain-time-of-day-regexp txt))
16817 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16818 org-end-time-was-given
16819 (substring txt (match-end 0)))))
16820 (when org-read-date-analyze-futurep
16821 (setq txt (concat txt " (=>F)")))
16822 (setq org-read-date-overlay
16823 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16824 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16826 (defun org-read-date-analyze (ans org-def org-defdecode)
16827 "Analyze the combined answer of the date prompt."
16828 ;; FIXME: cleanup and comment
16829 (let ((nowdecode (decode-time (current-time)))
16830 delta deltan deltaw deltadef year month day
16831 hour minute second wday pm h2 m2 tl wday1
16832 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16833 (setq org-read-date-analyze-futurep nil
16834 org-read-date-analyze-forced-year nil)
16835 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16836 (setq ans "+0"))
16838 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16839 (setq ans (replace-match "" t t ans)
16840 deltan (car delta)
16841 deltaw (nth 1 delta)
16842 deltadef (nth 2 delta)))
16844 ;; Check if there is an iso week date in there. If yes, store the
16845 ;; info and postpone interpreting it until the rest of the parsing
16846 ;; is done.
16847 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16848 (setq iso-year (if (match-end 1)
16849 (org-small-year-to-year
16850 (string-to-number (match-string 1 ans))))
16851 iso-weekday (if (match-end 3)
16852 (string-to-number (match-string 3 ans)))
16853 iso-week (string-to-number (match-string 2 ans)))
16854 (setq ans (replace-match "" t t ans)))
16856 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16857 (when (string-match
16858 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16859 (setq year (if (match-end 2)
16860 (string-to-number (match-string 2 ans))
16861 (progn (setq kill-year t)
16862 (string-to-number (format-time-string "%Y"))))
16863 month (string-to-number (match-string 3 ans))
16864 day (string-to-number (match-string 4 ans)))
16865 (if (< year 100) (setq year (+ 2000 year)))
16866 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16867 t nil ans)))
16869 ;; Help matching dotted european dates
16870 (when (string-match
16871 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16872 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16873 (setq kill-year t)
16874 (string-to-number (format-time-string "%Y")))
16875 day (string-to-number (match-string 1 ans))
16876 month (string-to-number (match-string 2 ans))
16877 ans (replace-match (format "%04d-%02d-%02d" year month day)
16878 t nil ans)))
16880 ;; Help matching american dates, like 5/30 or 5/30/7
16881 (when (string-match
16882 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16883 (setq year (if (match-end 4)
16884 (string-to-number (match-string 4 ans))
16885 (progn (setq kill-year t)
16886 (string-to-number (format-time-string "%Y"))))
16887 month (string-to-number (match-string 1 ans))
16888 day (string-to-number (match-string 2 ans)))
16889 (if (< year 100) (setq year (+ 2000 year)))
16890 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16891 t nil ans)))
16892 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16893 ;; If there is a time with am/pm, and *no* time without it, we convert
16894 ;; so that matching will be successful.
16895 (loop for i from 1 to 2 do ; twice, for end time as well
16896 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16897 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16898 (setq hour (string-to-number (match-string 1 ans))
16899 minute (if (match-end 3)
16900 (string-to-number (match-string 3 ans))
16902 pm (equal ?p
16903 (string-to-char (downcase (match-string 4 ans)))))
16904 (if (and (= hour 12) (not pm))
16905 (setq hour 0)
16906 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16907 (setq ans (replace-match (format "%02d:%02d" hour minute)
16908 t t ans))))
16910 ;; Check if a time range is given as a duration
16911 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16912 (setq hour (string-to-number (match-string 1 ans))
16913 h2 (+ hour (string-to-number (match-string 3 ans)))
16914 minute (string-to-number (match-string 2 ans))
16915 m2 (+ minute (if (match-end 5) (string-to-number
16916 (match-string 5 ans))0)))
16917 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16918 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16919 t t ans)))
16921 ;; Check if there is a time range
16922 (when (boundp 'org-end-time-was-given)
16923 (setq org-time-was-given nil)
16924 (when (and (string-match org-plain-time-of-day-regexp ans)
16925 (match-end 8))
16926 (setq org-end-time-was-given (match-string 8 ans))
16927 (setq ans (concat (substring ans 0 (match-beginning 7))
16928 (substring ans (match-end 7))))))
16930 (setq tl (parse-time-string ans)
16931 day (or (nth 3 tl) (nth 3 org-defdecode))
16932 month
16933 (cond ((nth 4 tl))
16934 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
16935 ;; Day was specified. Make sure DAY+MONTH
16936 ;; combination happens in the future.
16937 ((nth 3 tl)
16938 (setq futurep t)
16939 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
16940 (nth 4 nowdecode)))
16941 (t (nth 4 org-defdecode)))
16942 year
16943 (cond ((and (not kill-year) (nth 5 tl)))
16944 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
16945 ;; Month was guessed in the future and is at least
16946 ;; equal to NOWDECODE's. Fix year accordingly.
16947 (futurep
16948 (if (or (> month (nth 4 nowdecode))
16949 (>= day (nth 3 nowdecode)))
16950 (nth 5 nowdecode)
16951 (1+ (nth 5 nowdecode))))
16952 ;; Month was specified. Make sure MONTH+YEAR
16953 ;; combination happens in the future.
16954 ((nth 4 tl)
16955 (setq futurep t)
16956 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
16957 ((< month (nth 5 nowdecode)) (1+ (nth 5 nowdecode)))
16958 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
16959 (t (nth 5 nowdecode))))
16960 (t (nth 5 org-defdecode)))
16961 hour (or (nth 2 tl) (nth 2 org-defdecode))
16962 minute (or (nth 1 tl) (nth 1 org-defdecode))
16963 second (or (nth 0 tl) 0)
16964 wday (nth 6 tl))
16966 (when (and (eq org-read-date-prefer-future 'time)
16967 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16968 (equal day (nth 3 nowdecode))
16969 (equal month (nth 4 nowdecode))
16970 (equal year (nth 5 nowdecode))
16971 (nth 2 tl)
16972 (or (< (nth 2 tl) (nth 2 nowdecode))
16973 (and (= (nth 2 tl) (nth 2 nowdecode))
16974 (nth 1 tl)
16975 (< (nth 1 tl) (nth 1 nowdecode)))))
16976 (setq day (1+ day)
16977 futurep t))
16979 ;; Special date definitions below
16980 (cond
16981 (iso-week
16982 ;; There was an iso week
16983 (require 'cal-iso)
16984 (setq futurep nil)
16985 (setq year (or iso-year year)
16986 day (or iso-weekday wday 1)
16987 wday nil ; to make sure that the trigger below does not match
16988 iso-date (calendar-gregorian-from-absolute
16989 (calendar-iso-to-absolute
16990 (list iso-week day year))))
16991 ; FIXME: Should we also push ISO weeks into the future?
16992 ; (when (and org-read-date-prefer-future
16993 ; (not iso-year)
16994 ; (< (calendar-absolute-from-gregorian iso-date)
16995 ; (time-to-days (current-time))))
16996 ; (setq year (1+ year)
16997 ; iso-date (calendar-gregorian-from-absolute
16998 ; (calendar-iso-to-absolute
16999 ; (list iso-week day year)))))
17000 (setq month (car iso-date)
17001 year (nth 2 iso-date)
17002 day (nth 1 iso-date)))
17003 (deltan
17004 (setq futurep nil)
17005 (unless deltadef
17006 (let ((now (decode-time (current-time))))
17007 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17008 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17009 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17010 ((equal deltaw "m") (setq month (+ month deltan)))
17011 ((equal deltaw "y") (setq year (+ year deltan)))))
17012 ((and wday (not (nth 3 tl)))
17013 ;; Weekday was given, but no day, so pick that day in the week
17014 ;; on or after the derived date.
17015 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17016 (unless (equal wday wday1)
17017 (setq day (+ day (% (- wday wday1 -7) 7))))))
17018 (if (and (boundp 'org-time-was-given)
17019 (nth 2 tl))
17020 (setq org-time-was-given t))
17021 (if (< year 100) (setq year (+ 2000 year)))
17022 ;; Check of the date is representable
17023 (if org-read-date-force-compatible-dates
17024 (progn
17025 (if (< year 1970)
17026 (setq year 1970 org-read-date-analyze-forced-year t))
17027 (if (> year 2037)
17028 (setq year 2037 org-read-date-analyze-forced-year t)))
17029 (condition-case nil
17030 (ignore (encode-time second minute hour day month year))
17031 (error
17032 (setq year (nth 5 org-defdecode))
17033 (setq org-read-date-analyze-forced-year t))))
17034 (setq org-read-date-analyze-futurep futurep)
17035 (list second minute hour day month year)))
17037 (defvar parse-time-weekdays)
17038 (defun org-read-date-get-relative (s today default)
17039 "Check string S for special relative date string.
17040 TODAY and DEFAULT are internal times, for today and for a default.
17041 Return shift list (N what def-flag)
17042 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17043 N is the number of WHATs to shift.
17044 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17045 the DEFAULT date rather than TODAY."
17046 (require 'parse-time)
17047 (when (and
17048 (string-match
17049 (concat
17050 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17051 "\\([0-9]+\\)?"
17052 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17053 "\\([ \t]\\|$\\)") s)
17054 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17055 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17056 (string-to-char (substring (match-string 1 s) -1))
17057 ?+))
17058 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17059 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17060 (what (if (match-end 3) (match-string 3 s) "d"))
17061 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17062 (date (if rel default today))
17063 (wday (nth 6 (decode-time date)))
17064 delta)
17065 (if wday1
17066 (progn
17067 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17068 (if (= delta 0) (setq delta 7))
17069 (if (= dir ?-)
17070 (progn
17071 (setq delta (- delta 7))
17072 (if (= delta 0) (setq delta -7))))
17073 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17074 (list delta "d" rel))
17075 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17077 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17078 "Turn a user-specified date into the internal representation.
17079 The internal representation needed by the calendar is (month day year).
17080 This is a wrapper to handle the brain-dead convention in calendar that
17081 user function argument order change dependent on argument order."
17082 (if (boundp 'calendar-date-style)
17083 (cond
17084 ((eq calendar-date-style 'american)
17085 (list arg1 arg2 arg3))
17086 ((eq calendar-date-style 'european)
17087 (list arg2 arg1 arg3))
17088 ((eq calendar-date-style 'iso)
17089 (list arg2 arg3 arg1)))
17090 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17091 (if (org-bound-and-true-p european-calendar-style)
17092 (list arg2 arg1 arg3)
17093 (list arg1 arg2 arg3)))))
17095 (defun org-eval-in-calendar (form &optional keepdate)
17096 "Eval FORM in the calendar window and return to current window.
17097 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17098 otherwise stick to the current value of `org-ans2'."
17099 (let ((sf (selected-frame))
17100 (sw (selected-window)))
17101 (select-window (get-buffer-window "*Calendar*" t))
17102 (eval form)
17103 (when (and (not keepdate) (calendar-cursor-to-date))
17104 (let* ((date (calendar-cursor-to-date))
17105 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17106 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17107 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17108 (select-window sw)
17109 (org-select-frame-set-input-focus sf)))
17111 (defun org-calendar-select ()
17112 "Return to `org-read-date' with the date currently selected.
17113 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17114 (interactive)
17115 (when (calendar-cursor-to-date)
17116 (let* ((date (calendar-cursor-to-date))
17117 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17118 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17119 (if (active-minibuffer-window) (exit-minibuffer))))
17121 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17122 "Insert a date stamp for the date given by the internal TIME.
17123 See `format-time-string' for the format of TIME.
17124 WITH-HM means use the stamp format that includes the time of the day.
17125 INACTIVE means use square brackets instead of angular ones, so that the
17126 stamp will not contribute to the agenda.
17127 PRE and POST are optional strings to be inserted before and after the
17128 stamp.
17129 The command returns the inserted time stamp."
17130 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17131 stamp)
17132 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17133 (insert-before-markers (or pre ""))
17134 (when (listp extra)
17135 (setq extra (car extra))
17136 (if (and (stringp extra)
17137 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17138 (setq extra (format "-%02d:%02d"
17139 (string-to-number (match-string 1 extra))
17140 (string-to-number (match-string 2 extra))))
17141 (setq extra nil)))
17142 (when extra
17143 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17144 (insert-before-markers (setq stamp (format-time-string fmt time)))
17145 (insert-before-markers (or post ""))
17146 (setq org-last-inserted-timestamp stamp)))
17148 (defun org-toggle-time-stamp-overlays ()
17149 "Toggle the use of custom time stamp formats."
17150 (interactive)
17151 (setq org-display-custom-times (not org-display-custom-times))
17152 (unless org-display-custom-times
17153 (let ((p (point-min)) (bmp (buffer-modified-p)))
17154 (while (setq p (next-single-property-change p 'display))
17155 (if (and (get-text-property p 'display)
17156 (eq (get-text-property p 'face) 'org-date))
17157 (remove-text-properties
17158 p (setq p (next-single-property-change p 'display))
17159 '(display t))))
17160 (set-buffer-modified-p bmp)))
17161 (if (featurep 'xemacs)
17162 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17163 (org-restart-font-lock)
17164 (setq org-table-may-need-update t)
17165 (if org-display-custom-times
17166 (message "Time stamps are overlaid with custom format")
17167 (message "Time stamp overlays removed")))
17169 (defun org-display-custom-time (beg end)
17170 "Overlay modified time stamp format over timestamp between BEG and END."
17171 (let* ((ts (buffer-substring beg end))
17172 t1 w1 with-hm tf time str w2 (off 0))
17173 (save-match-data
17174 (setq t1 (org-parse-time-string ts t))
17175 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17176 (setq off (- (match-end 0) (match-beginning 0)))))
17177 (setq end (- end off))
17178 (setq w1 (- end beg)
17179 with-hm (and (nth 1 t1) (nth 2 t1))
17180 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17181 time (org-fix-decoded-time t1)
17182 str (org-add-props
17183 (format-time-string
17184 (substring tf 1 -1) (apply 'encode-time time))
17185 nil 'mouse-face 'highlight)
17186 w2 (length str))
17187 (if (not (= w2 w1))
17188 (add-text-properties (1+ beg) (+ 2 beg)
17189 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17190 (if (featurep 'xemacs)
17191 (progn
17192 (put-text-property beg end 'invisible t)
17193 (put-text-property beg end 'end-glyph (make-glyph str)))
17194 (put-text-property beg end 'display str))))
17196 (defun org-fix-decoded-time (time)
17197 "Set 0 instead of nil for the first 6 elements of time.
17198 Don't touch the rest."
17199 (let ((n 0))
17200 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17202 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17204 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17205 "Difference between TIMESTAMP-STRING and now in days.
17206 If SECONDS is non-nil, return the difference in seconds."
17207 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17208 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17209 (funcall fdiff (current-time)))))
17211 (defun org-deadline-close (timestamp-string &optional ndays)
17212 "Is the time in TIMESTAMP-STRING close to the current date?"
17213 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17214 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17215 (not (org-entry-is-done-p))))
17217 (defun org-get-wdays (ts &optional delay zero-delay)
17218 "Get the deadline lead time appropriate for timestring TS.
17219 When DELAY is non-nil, get the delay time for scheduled items
17220 instead of the deadline lead time. When ZERO-DELAY is non-nil
17221 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17222 don't try to find the delay cookie in the scheduled timestamp."
17223 (let ((tv (if delay org-scheduled-delay-days
17224 org-deadline-warning-days)))
17225 (cond
17226 ((or (and delay (< tv 0))
17227 (and delay zero-delay (<= tv 0))
17228 (and (not delay) (<= tv 0)))
17229 ;; Enforce this value no matter what
17230 (- tv))
17231 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17232 ;; lead time is specified.
17233 (floor (* (string-to-number (match-string 1 ts))
17234 (cdr (assoc (match-string 2 ts)
17235 '(("d" . 1) ("w" . 7)
17236 ("m" . 30.4) ("y" . 365.25)
17237 ("h" . 0.041667)))))))
17238 ;; go for the default.
17239 (t tv))))
17241 (defun org-calendar-select-mouse (ev)
17242 "Return to `org-read-date' with the date currently selected.
17243 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17244 (interactive "e")
17245 (mouse-set-point ev)
17246 (when (calendar-cursor-to-date)
17247 (let* ((date (calendar-cursor-to-date))
17248 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17249 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17250 (if (active-minibuffer-window) (exit-minibuffer))))
17252 (defun org-check-deadlines (ndays)
17253 "Check if there are any deadlines due or past due.
17254 A deadline is considered due if it happens within `org-deadline-warning-days'
17255 days from today's date. If the deadline appears in an entry marked DONE,
17256 it is not shown. The prefix arg NDAYS can be used to test that many
17257 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17258 (interactive "P")
17259 (let* ((org-warn-days
17260 (cond
17261 ((equal ndays '(4)) 100000)
17262 (ndays (prefix-numeric-value ndays))
17263 (t (abs org-deadline-warning-days))))
17264 (case-fold-search nil)
17265 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17266 (callback
17267 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17269 (message "%d deadlines past-due or due within %d days"
17270 (org-occur regexp nil callback)
17271 org-warn-days)))
17273 (defsubst org-re-timestamp (type)
17274 "Return a regexp for timestamp TYPE.
17275 Allowed values for TYPE are:
17277 all: all timestamps
17278 active: only active timestamps (<...>)
17279 inactive: only inactive timestamps ([...])
17280 scheduled: only scheduled timestamps
17281 deadline: only deadline timestamps
17282 closed: only closed time-stamps
17284 When TYPE is nil, fall back on returning a regexp that matches
17285 both scheduled and deadline timestamps."
17286 (case type
17287 (all org-ts-regexp-both)
17288 (active org-ts-regexp)
17289 (inactive org-ts-regexp-inactive)
17290 (scheduled org-scheduled-time-regexp)
17291 (deadline org-deadline-time-regexp)
17292 (closed org-closed-time-regexp)
17293 (otherwise
17294 (concat "\\<"
17295 (regexp-opt (list org-deadline-string org-scheduled-string))
17296 " *<\\([^>]+\\)>"))))
17298 (defun org-check-before-date (date)
17299 "Check if there are deadlines or scheduled entries before DATE."
17300 (interactive (list (org-read-date)))
17301 (let ((case-fold-search nil)
17302 (regexp (org-re-timestamp org-ts-type))
17303 (callback
17304 `(lambda ()
17305 (and ,(if (memq org-ts-type '(active inactive all))
17306 '(eq (org-element-type (org-element-context) 'timestamp))
17307 '(org-at-planning-p))
17308 (time-less-p
17309 (org-time-string-to-time (match-string 1))
17310 (org-time-string-to-time date))))))
17311 (message "%d entries before %s"
17312 (org-occur regexp nil callback) date)))
17314 (defun org-check-after-date (date)
17315 "Check if there are deadlines or scheduled entries after DATE."
17316 (interactive (list (org-read-date)))
17317 (let ((case-fold-search nil)
17318 (regexp (org-re-timestamp org-ts-type))
17319 (callback
17320 `(lambda ()
17321 (and ,(if (memq org-ts-type '(active inactive all))
17322 '(eq (org-element-type (org-element-context) 'timestamp))
17323 '(org-at-planning-p))
17324 (not (time-less-p
17325 (org-time-string-to-time (match-string 1))
17326 (org-time-string-to-time date)))))))
17327 (message "%d entries after %s"
17328 (org-occur regexp nil callback) date)))
17330 (defun org-check-dates-range (start-date end-date)
17331 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17332 (interactive (list (org-read-date nil nil nil "Range starts")
17333 (org-read-date nil nil nil "Range end")))
17334 (let ((case-fold-search nil)
17335 (regexp (org-re-timestamp org-ts-type))
17336 (callback
17337 `(lambda ()
17338 (let ((match (match-string 1)))
17339 (and
17340 ,(if (memq org-ts-type '(active inactive all))
17341 '(eq (org-element-type (org-element-context) 'timestamp))
17342 '(org-at-planning-p))
17343 (not (time-less-p
17344 (org-time-string-to-time match)
17345 (org-time-string-to-time start-date)))
17346 (time-less-p
17347 (org-time-string-to-time match)
17348 (org-time-string-to-time end-date)))))))
17349 (message "%d entries between %s and %s"
17350 (org-occur regexp nil callback) start-date end-date)))
17352 (defun org-evaluate-time-range (&optional to-buffer)
17353 "Evaluate a time range by computing the difference between start and end.
17354 Normally the result is just printed in the echo area, but with prefix arg
17355 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17356 If the time range is actually in a table, the result is inserted into the
17357 next column.
17358 For time difference computation, a year is assumed to be exactly 365
17359 days in order to avoid rounding problems."
17360 (interactive "P")
17362 (org-clock-update-time-maybe)
17363 (save-excursion
17364 (unless (org-at-date-range-p t)
17365 (goto-char (point-at-bol))
17366 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17367 (if (not (org-at-date-range-p t))
17368 (user-error "Not at a time-stamp range, and none found in current line")))
17369 (let* ((ts1 (match-string 1))
17370 (ts2 (match-string 2))
17371 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17372 (match-end (match-end 0))
17373 (time1 (org-time-string-to-time ts1))
17374 (time2 (org-time-string-to-time ts2))
17375 (t1 (org-float-time time1))
17376 (t2 (org-float-time time2))
17377 (diff (abs (- t2 t1)))
17378 (negative (< (- t2 t1) 0))
17379 ;; (ys (floor (* 365 24 60 60)))
17380 (ds (* 24 60 60))
17381 (hs (* 60 60))
17382 (fy "%dy %dd %02d:%02d")
17383 (fy1 "%dy %dd")
17384 (fd "%dd %02d:%02d")
17385 (fd1 "%dd")
17386 (fh "%02d:%02d")
17387 y d h m align)
17388 (if havetime
17389 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17391 d (floor (/ diff ds)) diff (mod diff ds)
17392 h (floor (/ diff hs)) diff (mod diff hs)
17393 m (floor (/ diff 60)))
17394 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17396 d (floor (+ (/ diff ds) 0.5))
17397 h 0 m 0))
17398 (if (not to-buffer)
17399 (message "%s" (org-make-tdiff-string y d h m))
17400 (if (org-at-table-p)
17401 (progn
17402 (goto-char match-end)
17403 (setq align t)
17404 (and (looking-at " *|") (goto-char (match-end 0))))
17405 (goto-char match-end))
17406 (if (looking-at
17407 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17408 (replace-match ""))
17409 (if negative (insert " -"))
17410 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17411 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17412 (insert " " (format fh h m))))
17413 (if align (org-table-align))
17414 (message "Time difference inserted")))))
17416 (defun org-make-tdiff-string (y d h m)
17417 (let ((fmt "")
17418 (l nil))
17419 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17420 l (push y l)))
17421 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17422 l (push d l)))
17423 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17424 l (push h l)))
17425 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17426 l (push m l)))
17427 (apply 'format fmt (nreverse l))))
17429 (defun org-time-string-to-time (s &optional buffer pos)
17430 "Convert a timestamp string into internal time."
17431 (condition-case errdata
17432 (apply 'encode-time (org-parse-time-string s))
17433 (error (error "Bad timestamp `%s'%s\nError was: %s"
17434 s (if (not (and buffer pos))
17436 (format " at %d in buffer `%s'" pos buffer))
17437 (cdr errdata)))))
17439 (defun org-time-string-to-seconds (s)
17440 "Convert a timestamp string to a number of seconds."
17441 (org-float-time (org-time-string-to-time s)))
17443 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17444 "Convert a time stamp to an absolute day number.
17445 If there is a specifier for a cyclic time stamp, get the closest
17446 date to DAYNR.
17447 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17448 The variable `date' is bound by the calendar when this is called."
17449 (cond
17450 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17451 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17452 daynr
17453 (+ daynr 1000)))
17454 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17455 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17456 (time-to-days (current-time))) (match-string 0 s)
17457 prefer show-all))
17458 (t (time-to-days
17459 (condition-case errdata
17460 (apply 'encode-time (org-parse-time-string s))
17461 (error (error "Bad timestamp `%s'%s\nError was: %s"
17462 s (if (not (and buffer pos))
17464 (format " at %d in buffer `%s'" pos buffer))
17465 (cdr errdata))))))))
17467 (defun org-days-to-iso-week (days)
17468 "Return the iso week number."
17469 (require 'cal-iso)
17470 (car (calendar-iso-from-absolute days)))
17472 (defun org-small-year-to-year (year)
17473 "Convert 2-digit years into 4-digit years.
17474 YEAR is expanded into one of the 30 next years, if possible, or
17475 into a past one. Any year larger than 99 is returned unchanged."
17476 (if (>= year 100) year
17477 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17478 (century (/ current 100))
17479 (offset (- year (% current 100))))
17480 (cond ((> offset 30) (+ (* (1- century) 100) year))
17481 ((> offset -70) (+ (* century 100) year))
17482 (t (+ (* (1+ century) 100) year))))))
17484 (defun org-time-from-absolute (d)
17485 "Return the time corresponding to date D.
17486 D may be an absolute day number, or a calendar-type list (month day year)."
17487 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17488 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17490 (defun org-calendar-holiday ()
17491 "List of holidays, for Diary display in Org-mode."
17492 (require 'holidays)
17493 (let ((hl (funcall
17494 (if (fboundp 'calendar-check-holidays)
17495 'calendar-check-holidays 'check-calendar-holidays) date)))
17496 (if hl (mapconcat 'identity hl "; "))))
17498 (defun org-diary-sexp-entry (sexp entry date)
17499 "Process a SEXP diary ENTRY for DATE."
17500 (require 'diary-lib)
17501 (let ((result (if calendar-debug-sexp
17502 (let ((stack-trace-on-error t))
17503 (eval (car (read-from-string sexp))))
17504 (condition-case nil
17505 (eval (car (read-from-string sexp)))
17506 (error
17507 (beep)
17508 (message "Bad sexp at line %d in %s: %s"
17509 (org-current-line)
17510 (buffer-file-name) sexp)
17511 (sleep-for 2))))))
17512 (cond ((stringp result) (split-string result "; "))
17513 ((and (consp result)
17514 (not (consp (cdr result)))
17515 (stringp (cdr result))) (cdr result))
17516 ((and (consp result)
17517 (stringp (car result))) result)
17518 (result entry))))
17520 (defun org-diary-to-ical-string (frombuf)
17521 "Get iCalendar entries from diary entries in buffer FROMBUF.
17522 This uses the icalendar.el library."
17523 (let* ((tmpdir (if (featurep 'xemacs)
17524 (temp-directory)
17525 temporary-file-directory))
17526 (tmpfile (make-temp-name
17527 (expand-file-name "orgics" tmpdir)))
17528 buf rtn b e)
17529 (with-current-buffer frombuf
17530 (icalendar-export-region (point-min) (point-max) tmpfile)
17531 (setq buf (find-buffer-visiting tmpfile))
17532 (set-buffer buf)
17533 (goto-char (point-min))
17534 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17535 (setq b (match-beginning 0)))
17536 (goto-char (point-max))
17537 (if (re-search-backward "^END:VEVENT" nil t)
17538 (setq e (match-end 0)))
17539 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17540 (kill-buffer buf)
17541 (delete-file tmpfile)
17542 rtn))
17544 (defun org-closest-date (start current change prefer show-all)
17545 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17546 When PREFER is `past', return a date that is either CURRENT or past.
17547 When PREFER is `future', return a date that is either CURRENT or future.
17548 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17549 ;; Make the proper lists from the dates
17550 (catch 'exit
17551 (let ((a1 '(("h" . hour)
17552 ("d" . day)
17553 ("w" . week)
17554 ("m" . month)
17555 ("y" . year)))
17556 (shour (nth 2 (org-parse-time-string start)))
17557 dn dw sday cday n1 n2 n0
17558 d m y y1 y2 date1 date2 nmonths nm ny m2)
17560 (setq start (org-date-to-gregorian start)
17561 current (org-date-to-gregorian
17562 (if show-all
17563 current
17564 (time-to-days (current-time))))
17565 sday (calendar-absolute-from-gregorian start)
17566 cday (calendar-absolute-from-gregorian current))
17568 (if (<= cday sday) (throw 'exit sday))
17570 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17571 (setq dn (string-to-number (match-string 1 change))
17572 dw (cdr (assoc (match-string 2 change) a1)))
17573 (user-error "Invalid change specifier: %s" change))
17574 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17575 (cond
17576 ((eq dw 'hour)
17577 (let ((missing-hours
17578 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17579 dn)))
17580 (setq n1 (if (zerop missing-hours) cday
17581 (- cday (1+ (floor (/ missing-hours 24)))))
17582 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17583 ((eq dw 'day)
17584 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17585 n2 (+ n1 dn)))
17586 ((eq dw 'year)
17587 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17588 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17589 (setq date1 (list m d y1)
17590 n1 (calendar-absolute-from-gregorian date1)
17591 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17592 n2 (calendar-absolute-from-gregorian date2)))
17593 ((eq dw 'month)
17594 ;; approx number of month between the two dates
17595 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17596 ;; How often does dn fit in there?
17597 (setq d (nth 1 start) m (car start) y (nth 2 start)
17598 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17599 m (+ m nm)
17600 ny (floor (/ m 12))
17601 y (+ y ny)
17602 m (- m (* ny 12)))
17603 (while (> m 12) (setq m (- m 12) y (1+ y)))
17604 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17605 (setq m2 (+ m dn) y2 y)
17606 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17607 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17608 (while (<= n2 cday)
17609 (setq n1 n2 m m2 y y2)
17610 (setq m2 (+ m dn) y2 y)
17611 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17612 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17613 ;; Make sure n1 is the earlier date
17614 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17615 (if show-all
17616 (cond
17617 ((eq prefer 'past) (if (= cday n2) n2 n1))
17618 ((eq prefer 'future) (if (= cday n1) n1 n2))
17619 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17620 (cond
17621 ((eq prefer 'past) (if (= cday n2) n2 n1))
17622 ((eq prefer 'future) (if (= cday n1) n1 n2))
17623 (t (if (= cday n1) n1 n2)))))))
17625 (defun org-date-to-gregorian (date)
17626 "Turn any specification of DATE into a Gregorian date for the calendar."
17627 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17628 ((and (listp date) (= (length date) 3)) date)
17629 ((stringp date)
17630 (setq date (org-parse-time-string date))
17631 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17632 ((listp date)
17633 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17635 (defun org-parse-time-string (s &optional nodefault)
17636 "Parse the standard Org-mode time string.
17637 This should be a lot faster than the normal `parse-time-string'.
17638 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17639 hour and minute fields will be nil if not given."
17640 (cond ((string-match org-ts-regexp0 s)
17641 (list 0
17642 (if (or (match-beginning 8) (not nodefault))
17643 (string-to-number (or (match-string 8 s) "0")))
17644 (if (or (match-beginning 7) (not nodefault))
17645 (string-to-number (or (match-string 7 s) "0")))
17646 (string-to-number (match-string 4 s))
17647 (string-to-number (match-string 3 s))
17648 (string-to-number (match-string 2 s))
17649 nil nil nil))
17650 ((string-match "^<[^>]+>$" s)
17651 (decode-time (seconds-to-time (org-matcher-time s))))
17652 (t (error "Not a standard Org-mode time string: %s" s))))
17654 (defun org-timestamp-up (&optional arg)
17655 "Increase the date item at the cursor by one.
17656 If the cursor is on the year, change the year. If it is on the month,
17657 the day or the time, change that.
17658 With prefix ARG, change by that many units."
17659 (interactive "p")
17660 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17662 (defun org-timestamp-down (&optional arg)
17663 "Decrease the date item at the cursor by one.
17664 If the cursor is on the year, change the year. If it is on the month,
17665 the day or the time, change that.
17666 With prefix ARG, change by that many units."
17667 (interactive "p")
17668 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17670 (defun org-timestamp-up-day (&optional arg)
17671 "Increase the date in the time stamp by one day.
17672 With prefix ARG, change that many days."
17673 (interactive "p")
17674 (if (and (not (org-at-timestamp-p t))
17675 (org-at-heading-p))
17676 (org-todo 'up)
17677 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17679 (defun org-timestamp-down-day (&optional arg)
17680 "Decrease the date in the time stamp by one day.
17681 With prefix ARG, change that many days."
17682 (interactive "p")
17683 (if (and (not (org-at-timestamp-p t))
17684 (org-at-heading-p))
17685 (org-todo 'down)
17686 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17688 (defun org-at-timestamp-p (&optional inactive-ok)
17689 "Determine if the cursor is in or at a timestamp."
17690 (interactive)
17691 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17692 (pos (point))
17693 (ans (or (looking-at tsr)
17694 (save-excursion
17695 (skip-chars-backward "^[<\n\r\t")
17696 (if (> (point) (point-min)) (backward-char 1))
17697 (and (looking-at tsr)
17698 (> (- (match-end 0) pos) -1))))))
17699 (and ans
17700 (boundp 'org-ts-what)
17701 (setq org-ts-what
17702 (cond
17703 ((= pos (match-beginning 0)) 'bracket)
17704 ;; Point is considered to be "on the bracket" whether
17705 ;; it's really on it or right after it.
17706 ((= pos (1- (match-end 0))) 'bracket)
17707 ((= pos (match-end 0)) 'after)
17708 ((org-pos-in-match-range pos 2) 'year)
17709 ((org-pos-in-match-range pos 3) 'month)
17710 ((org-pos-in-match-range pos 7) 'hour)
17711 ((org-pos-in-match-range pos 8) 'minute)
17712 ((or (org-pos-in-match-range pos 4)
17713 (org-pos-in-match-range pos 5)) 'day)
17714 ((and (> pos (or (match-end 8) (match-end 5)))
17715 (< pos (match-end 0)))
17716 (- pos (or (match-end 8) (match-end 5))))
17717 (t 'day))))
17718 ans))
17720 (defun org-toggle-timestamp-type ()
17721 "Toggle the type (<active> or [inactive]) of a time stamp."
17722 (interactive)
17723 (when (org-at-timestamp-p t)
17724 (let ((beg (match-beginning 0)) (end (match-end 0))
17725 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17726 (save-excursion
17727 (goto-char beg)
17728 (while (re-search-forward "[][<>]" end t)
17729 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17730 t t)))
17731 (message "Timestamp is now %sactive"
17732 (if (equal (char-after beg) ?<) "" "in")))))
17734 (defun org-at-clock-log-p nil
17735 "Is the cursor on the clock log line?"
17736 (save-excursion
17737 (move-beginning-of-line 1)
17738 (looking-at org-clock-line-re)))
17740 (defvar org-clock-history) ; defined in org-clock.el
17741 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17742 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17743 "Change the date in the time stamp at point.
17744 The date will be changed by N times WHAT. WHAT can be `day', `month',
17745 `year', `minute', `second'. If WHAT is not given, the cursor position
17746 in the timestamp determines what will be changed.
17747 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17748 (let ((origin (point)) origin-cat
17749 with-hm inactive
17750 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17751 org-ts-what
17752 extra rem
17753 ts time time0 fixnext clrgx)
17754 (if (not (org-at-timestamp-p t))
17755 (user-error "Not at a timestamp"))
17756 (if (and (not what) (eq org-ts-what 'bracket))
17757 (org-toggle-timestamp-type)
17758 ;; Point isn't on brackets. Remember the part of the time-stamp
17759 ;; the point was in. Indeed, size of time-stamps may change,
17760 ;; but point must be kept in the same category nonetheless.
17761 (setq origin-cat org-ts-what)
17762 (if (and (not what) (not (eq org-ts-what 'day))
17763 org-display-custom-times
17764 (get-text-property (point) 'display)
17765 (not (get-text-property (1- (point)) 'display)))
17766 (setq org-ts-what 'day))
17767 (setq org-ts-what (or what org-ts-what)
17768 inactive (= (char-after (match-beginning 0)) ?\[)
17769 ts (match-string 0))
17770 (replace-match "")
17771 (when (string-match
17772 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17774 (setq extra (match-string 1 ts))
17775 (if suppress-tmp-delay
17776 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17777 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17778 (setq with-hm t))
17779 (setq time0 (org-parse-time-string ts))
17780 (when (and updown
17781 (eq org-ts-what 'minute)
17782 (not current-prefix-arg))
17783 ;; This looks like s-up and s-down. Change by one rounding step.
17784 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17785 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17786 (setcar (cdr time0) (+ (nth 1 time0)
17787 (if (> n 0) (- rem) (- dm rem))))))
17788 (setq time
17789 (encode-time (or (car time0) 0)
17790 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17791 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17792 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17793 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17794 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17795 (nthcdr 6 time0)))
17796 (when (and (member org-ts-what '(hour minute))
17797 extra
17798 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17799 (setq extra (org-modify-ts-extra
17800 extra
17801 (if (eq org-ts-what 'hour) 2 5)
17802 n dm)))
17803 (when (integerp org-ts-what)
17804 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17805 (if (eq what 'calendar)
17806 (let ((cal-date (org-get-date-from-calendar)))
17807 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17808 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17809 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17810 (setcar time0 (or (car time0) 0))
17811 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17812 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17813 (setq time (apply 'encode-time time0))))
17814 ;; Insert the new time-stamp, and ensure point stays in the same
17815 ;; category as before (i.e. not after the last position in that
17816 ;; category).
17817 (let ((pos (point)))
17818 ;; Stay before inserted string. `save-excursion' is of no use.
17819 (setq org-last-changed-timestamp
17820 (org-insert-time-stamp time with-hm inactive nil nil extra))
17821 (goto-char pos))
17822 (save-match-data
17823 (looking-at org-ts-regexp3)
17824 (goto-char (cond
17825 ;; `day' category ends before `hour' if any, or at
17826 ;; the end of the day name.
17827 ((eq origin-cat 'day)
17828 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17829 ((eq origin-cat 'hour) (min (match-end 7) origin))
17830 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17831 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17832 ;; `year' and `month' have both fixed size: point
17833 ;; couldn't have moved into another part.
17834 (t origin))))
17835 ;; Update clock if on a CLOCK line.
17836 (org-clock-update-time-maybe)
17837 ;; Maybe adjust the closest clock in `org-clock-history'
17838 (when org-clock-adjust-closest
17839 (if (not (and (org-at-clock-log-p)
17840 (< 1 (length (delq nil (mapcar 'marker-position
17841 org-clock-history))))))
17842 (message "No clock to adjust")
17843 (cond ((save-excursion ; fix previous clock?
17844 (re-search-backward org-ts-regexp0 nil t)
17845 (org-looking-back (concat org-clock-string " \\[")))
17846 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17847 ((save-excursion ; fix next clock?
17848 (re-search-backward org-ts-regexp0 nil t)
17849 (looking-at (concat org-ts-regexp0 "\\] =>")))
17850 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17851 (save-window-excursion
17852 ;; Find closest clock to point, adjust the previous/next one in history
17853 (let* ((p (save-excursion (org-back-to-heading t)))
17854 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17855 (clfixnth
17856 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17857 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17858 (if (not clfixpos)
17859 (message "No clock to adjust")
17860 (save-excursion
17861 (org-goto-marker-or-bmk clfixpos)
17862 (org-show-subtree)
17863 (when (re-search-forward clrgx nil t)
17864 (goto-char (match-beginning 1))
17865 (let (org-clock-adjust-closest)
17866 (org-timestamp-change n org-ts-what updown))
17867 (message "Clock adjusted in %s for heading: %s"
17868 (file-name-nondirectory (buffer-file-name))
17869 (org-get-heading t t)))))))))
17870 ;; Try to recenter the calendar window, if any.
17871 (if (and org-calendar-follow-timestamp-change
17872 (get-buffer-window "*Calendar*" t)
17873 (memq org-ts-what '(day month year)))
17874 (org-recenter-calendar (time-to-days time))))))
17876 (defun org-modify-ts-extra (s pos n dm)
17877 "Change the different parts of the lead-time and repeat fields in timestamp."
17878 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17879 ng h m new rem)
17880 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17881 (cond
17882 ((or (org-pos-in-match-range pos 2)
17883 (org-pos-in-match-range pos 3))
17884 (setq m (string-to-number (match-string 3 s))
17885 h (string-to-number (match-string 2 s)))
17886 (if (org-pos-in-match-range pos 2)
17887 (setq h (+ h n))
17888 (setq n (* dm (org-no-warnings (signum n))))
17889 (when (not (= 0 (setq rem (% m dm))))
17890 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17891 (setq m (+ m n)))
17892 (if (< m 0) (setq m (+ m 60) h (1- h)))
17893 (if (> m 59) (setq m (- m 60) h (1+ h)))
17894 (setq h (min 24 (max 0 h)))
17895 (setq ng 1 new (format "-%02d:%02d" h m)))
17896 ((org-pos-in-match-range pos 6)
17897 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17898 ((org-pos-in-match-range pos 5)
17899 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17901 ((org-pos-in-match-range pos 9)
17902 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17903 ((org-pos-in-match-range pos 8)
17904 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17906 (when ng
17907 (setq s (concat
17908 (substring s 0 (match-beginning ng))
17910 (substring s (match-end ng))))))
17913 (defun org-recenter-calendar (date)
17914 "If the calendar is visible, recenter it to DATE."
17915 (let ((cwin (get-buffer-window "*Calendar*" t)))
17916 (when cwin
17917 (let ((calendar-move-hook nil))
17918 (with-selected-window cwin
17919 (calendar-goto-date (if (listp date) date
17920 (calendar-gregorian-from-absolute date))))))))
17922 (defun org-goto-calendar (&optional arg)
17923 "Go to the Emacs calendar at the current date.
17924 If there is a time stamp in the current line, go to that date.
17925 A prefix ARG can be used to force the current date."
17926 (interactive "P")
17927 (let ((tsr org-ts-regexp) diff
17928 (calendar-move-hook nil)
17929 (calendar-view-holidays-initially-flag nil)
17930 (calendar-view-diary-initially-flag nil))
17931 (if (or (org-at-timestamp-p)
17932 (save-excursion
17933 (beginning-of-line 1)
17934 (looking-at (concat ".*" tsr))))
17935 (let ((d1 (time-to-days (current-time)))
17936 (d2 (time-to-days
17937 (org-time-string-to-time (match-string 1)))))
17938 (setq diff (- d2 d1))))
17939 (calendar)
17940 (calendar-goto-today)
17941 (if (and diff (not arg)) (calendar-forward-day diff))))
17943 (defun org-get-date-from-calendar ()
17944 "Return a list (month day year) of date at point in calendar."
17945 (with-current-buffer "*Calendar*"
17946 (save-match-data
17947 (calendar-cursor-to-date))))
17949 (defun org-date-from-calendar ()
17950 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17951 If there is already a time stamp at the cursor position, update it."
17952 (interactive)
17953 (if (org-at-timestamp-p t)
17954 (org-timestamp-change 0 'calendar)
17955 (let ((cal-date (org-get-date-from-calendar)))
17956 (org-insert-time-stamp
17957 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17959 (defcustom org-effort-durations
17960 `(("min" . 1)
17961 ("h" . 60)
17962 ("d" . ,(* 60 8))
17963 ("w" . ,(* 60 8 5))
17964 ("m" . ,(* 60 8 5 4))
17965 ("y" . ,(* 60 8 5 40)))
17966 "Conversion factor to minutes for an effort modifier.
17968 Each entry has the form (MODIFIER . MINUTES).
17970 In an effort string, a number followed by MODIFIER is multiplied
17971 by the specified number of MINUTES to obtain an effort in
17972 minutes.
17974 For example, if the value of this variable is ((\"hours\" . 60)), then an
17975 effort string \"2hours\" is equivalent to 120 minutes."
17976 :group 'org-agenda
17977 :version "25.1"
17978 :package-version '(Org . "8.3")
17979 :type '(alist :key-type (string :tag "Modifier")
17980 :value-type (number :tag "Minutes")))
17982 (defun org-minutes-to-clocksum-string (m)
17983 "Format number of minutes as a clocksum string.
17984 The format is determined by `org-time-clocksum-format',
17985 `org-time-clocksum-use-fractional' and
17986 `org-time-clocksum-fractional-format' and
17987 `org-time-clocksum-use-effort-durations'."
17988 (let ((clocksum "")
17989 (m (round m)) ; Don't allow fractions of minutes
17990 h d w mo y fmt n)
17991 (setq h (if org-time-clocksum-use-effort-durations
17992 (cdr (assoc "h" org-effort-durations)) 60)
17993 d (if org-time-clocksum-use-effort-durations
17994 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17995 w (if org-time-clocksum-use-effort-durations
17996 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17997 mo (if org-time-clocksum-use-effort-durations
17998 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17999 y (if org-time-clocksum-use-effort-durations
18000 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18001 ;; fractional format
18002 (if org-time-clocksum-use-fractional
18003 (cond
18004 ;; single format string
18005 ((stringp org-time-clocksum-fractional-format)
18006 (format org-time-clocksum-fractional-format (/ m (float h))))
18007 ;; choice of fractional formats for different time units
18008 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18009 (> (/ (truncate m) (* y d h)) 0))
18010 (format fmt (/ m (* y d (float h)))))
18011 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18012 (> (/ (truncate m) (* mo d h)) 0))
18013 (format fmt (/ m (* mo d (float h)))))
18014 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18015 (> (/ (truncate m) (* w d h)) 0))
18016 (format fmt (/ m (* w d (float h)))))
18017 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18018 (> (/ (truncate m) (* d h)) 0))
18019 (format fmt (/ m (* d (float h)))))
18020 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18021 (> (/ (truncate m) h) 0))
18022 (format fmt (/ m (float h))))
18023 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18024 (format fmt m))
18025 ;; fall back to smallest time unit with a format
18026 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18027 (format fmt (/ m (float h))))
18028 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18029 (format fmt (/ m (* d (float h)))))
18030 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18031 (format fmt (/ m (* w d (float h)))))
18032 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18033 (format fmt (/ m (* mo d (float h)))))
18034 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18035 (format fmt (/ m (* y d (float h))))))
18036 ;; standard (non-fractional) format, with single format string
18037 (if (stringp org-time-clocksum-format)
18038 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18039 ;; separate formats components
18040 (and (setq fmt (plist-get org-time-clocksum-format :years))
18041 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18042 (plist-get org-time-clocksum-format :require-years))
18043 (setq clocksum (concat clocksum (format fmt n))
18044 m (- m (* n y d h))))
18045 (and (setq fmt (plist-get org-time-clocksum-format :months))
18046 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18047 (plist-get org-time-clocksum-format :require-months))
18048 (setq clocksum (concat clocksum (format fmt n))
18049 m (- m (* n mo d h))))
18050 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18051 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18052 (plist-get org-time-clocksum-format :require-weeks))
18053 (setq clocksum (concat clocksum (format fmt n))
18054 m (- m (* n w d h))))
18055 (and (setq fmt (plist-get org-time-clocksum-format :days))
18056 (or (> (setq n (/ (truncate m) (* d h))) 0)
18057 (plist-get org-time-clocksum-format :require-days))
18058 (setq clocksum (concat clocksum (format fmt n))
18059 m (- m (* n d h))))
18060 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18061 (or (> (setq n (/ (truncate m) h)) 0)
18062 (plist-get org-time-clocksum-format :require-hours))
18063 (setq clocksum (concat clocksum (format fmt n))
18064 m (- m (* n h))))
18065 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18066 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18067 (setq clocksum (concat clocksum (format fmt m))))
18068 ;; return formatted time duration
18069 clocksum))))
18071 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18072 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18073 "Org mode version 8.0")
18075 (defun org-hours-to-clocksum-string (n)
18076 (org-minutes-to-clocksum-string (* n 60)))
18078 (defun org-hh:mm-string-to-minutes (s)
18079 "Convert a string H:MM to a number of minutes.
18080 If the string is just a number, interpret it as minutes.
18081 In fact, the first hh:mm or number in the string will be taken,
18082 there can be extra stuff in the string.
18083 If no number is found, the return value is 0."
18084 (cond
18085 ((integerp s) s)
18086 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18087 (+ (* (string-to-number (match-string 1 s)) 60)
18088 (string-to-number (match-string 2 s))))
18089 ((string-match "\\([0-9]+\\)" s)
18090 (string-to-number (match-string 1 s)))
18091 (t 0)))
18093 (defcustom org-image-actual-width t
18094 "Should we use the actual width of images when inlining them?
18096 When set to `t', always use the image width.
18098 When set to a number, use imagemagick (when available) to set
18099 the image's width to this value.
18101 When set to a number in a list, try to get the width from any
18102 #+ATTR.* keyword if it matches a width specification like
18104 #+ATTR_HTML: :width 300px
18106 and fall back on that number if none is found.
18108 When set to nil, try to get the width from an #+ATTR.* keyword
18109 and fall back on the original width if none is found.
18111 This requires Emacs >= 24.1, build with imagemagick support."
18112 :group 'org-appearance
18113 :version "24.4"
18114 :package-version '(Org . "8.0")
18115 :type '(choice
18116 (const :tag "Use the image width" t)
18117 (integer :tag "Use a number of pixels")
18118 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18119 (const :tag "Use #+ATTR* or don't resize" nil)))
18121 (defcustom org-agenda-inhibit-startup nil
18122 "Inhibit startup when preparing agenda buffers.
18123 When this variable is `t', the initialization of the Org agenda
18124 buffers is inhibited: e.g. the visibility state is not set, the
18125 tables are not re-aligned, etc."
18126 :type 'boolean
18127 :version "24.3"
18128 :group 'org-agenda)
18130 (define-obsolete-variable-alias
18131 'org-agenda-ignore-drawer-properties
18132 'org-agenda-ignore-properties "25.1")
18134 (defcustom org-agenda-ignore-properties nil
18135 "Avoid updating text properties when building the agenda.
18136 Properties are used to prepare buffers for effort estimates,
18137 appointments, statistics and subtree-local categories.
18138 If you don't use these in the agenda, you can add them to this
18139 list and agenda building will be a bit faster.
18140 The value is a list, with zero or more of the symbols `effort', `appt',
18141 `stats' or `category'."
18142 :type '(set :greedy t
18143 (const effort)
18144 (const appt)
18145 (const stats)
18146 (const category))
18147 :version "25.1"
18148 :package-version '(Org . "8.3")
18149 :group 'org-agenda)
18151 (defun org-duration-string-to-minutes (s &optional output-to-string)
18152 "Convert a duration string S to minutes.
18154 A bare number is interpreted as minutes, modifiers can be set by
18155 customizing `org-effort-durations' (which see).
18157 Entries containing a colon are interpreted as H:MM by
18158 `org-hh:mm-string-to-minutes'."
18159 (let ((result 0)
18160 (re (concat "\\([0-9.]+\\) *\\("
18161 (regexp-opt (mapcar 'car org-effort-durations))
18162 "\\)")))
18163 (while (string-match re s)
18164 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18165 (string-to-number (match-string 1 s))))
18166 (setq s (replace-match "" nil t s)))
18167 (setq result (floor result))
18168 (incf result (org-hh:mm-string-to-minutes s))
18169 (if output-to-string (number-to-string result) result)))
18171 ;;;; Files
18173 (defun org-save-all-org-buffers ()
18174 "Save all Org-mode buffers without user confirmation."
18175 (interactive)
18176 (message "Saving all Org-mode buffers...")
18177 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18178 (when (featurep 'org-id) (org-id-locations-save))
18179 (message "Saving all Org-mode buffers... done"))
18181 (defun org-revert-all-org-buffers ()
18182 "Revert all Org-mode buffers.
18183 Prompt for confirmation when there are unsaved changes.
18184 Be sure you know what you are doing before letting this function
18185 overwrite your changes.
18187 This function is useful in a setup where one tracks org files
18188 with a version control system, to revert on one machine after pulling
18189 changes from another. I believe the procedure must be like this:
18191 1. M-x org-save-all-org-buffers
18192 2. Pull changes from the other machine, resolve conflicts
18193 3. M-x org-revert-all-org-buffers"
18194 (interactive)
18195 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18196 (user-error "Abort"))
18197 (save-excursion
18198 (save-window-excursion
18199 (mapc
18200 (lambda (b)
18201 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18202 (with-current-buffer b buffer-file-name))
18203 (org-pop-to-buffer-same-window b)
18204 (revert-buffer t 'no-confirm)))
18205 (buffer-list))
18206 (when (and (featurep 'org-id) org-id-track-globally)
18207 (org-id-locations-load)))))
18209 ;;;; Agenda files
18211 ;;;###autoload
18212 (defun org-switchb (&optional arg)
18213 "Switch between Org buffers.
18214 With one prefix argument, restrict available buffers to files.
18215 With two prefix arguments, restrict available buffers to agenda files.
18217 Defaults to `iswitchb' for buffer name completion.
18218 Set `org-completion-use-ido' to make it use ido instead."
18219 (interactive "P")
18220 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18221 ((equal arg '(16)) (org-buffer-list 'agenda))
18222 (t (org-buffer-list))))
18223 (org-completion-use-iswitchb org-completion-use-iswitchb)
18224 (org-completion-use-ido org-completion-use-ido))
18225 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18226 (setq org-completion-use-iswitchb t))
18227 (org-pop-to-buffer-same-window
18228 (org-icompleting-read "Org buffer: "
18229 (mapcar 'list (mapcar 'buffer-name blist))
18230 nil t))))
18232 ;;; Define some older names previously used for this functionality
18233 ;;;###autoload
18234 (defalias 'org-ido-switchb 'org-switchb)
18235 ;;;###autoload
18236 (defalias 'org-iswitchb 'org-switchb)
18238 (defun org-buffer-list (&optional predicate exclude-tmp)
18239 "Return a list of Org buffers.
18240 PREDICATE can be `export', `files' or `agenda'.
18242 export restrict the list to Export buffers.
18243 files restrict the list to buffers visiting Org files.
18244 agenda restrict the list to buffers visiting agenda files.
18246 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18247 (let* ((bfn nil)
18248 (agenda-files (and (eq predicate 'agenda)
18249 (mapcar 'file-truename (org-agenda-files t))))
18250 (filter
18251 (cond
18252 ((eq predicate 'files)
18253 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18254 ((eq predicate 'export)
18255 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18256 ((eq predicate 'agenda)
18257 (lambda (b)
18258 (with-current-buffer b
18259 (and (derived-mode-p 'org-mode)
18260 (setq bfn (buffer-file-name b))
18261 (member (file-truename bfn) agenda-files)))))
18262 (t (lambda (b) (with-current-buffer b
18263 (or (derived-mode-p 'org-mode)
18264 (string-match "\*Org .*Export"
18265 (buffer-name b)))))))))
18266 (delq nil
18267 (mapcar
18268 (lambda(b)
18269 (if (and (funcall filter b)
18270 (or (not exclude-tmp)
18271 (not (string-match "tmp" (buffer-name b)))))
18273 nil))
18274 (buffer-list)))))
18276 (defun org-agenda-files (&optional unrestricted archives)
18277 "Get the list of agenda files.
18278 Optional UNRESTRICTED means return the full list even if a restriction
18279 is currently in place.
18280 When ARCHIVES is t, include all archive files that are really being
18281 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18282 `org-agenda-archives-mode' is t."
18283 (let ((files
18284 (cond
18285 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18286 ((stringp org-agenda-files) (org-read-agenda-file-list))
18287 ((listp org-agenda-files) org-agenda-files)
18288 (t (error "Invalid value of `org-agenda-files'")))))
18289 (setq files (apply 'append
18290 (mapcar (lambda (f)
18291 (if (file-directory-p f)
18292 (directory-files
18293 f t org-agenda-file-regexp)
18294 (list f)))
18295 files)))
18296 (when org-agenda-skip-unavailable-files
18297 (setq files (delq nil
18298 (mapcar (function
18299 (lambda (file)
18300 (and (file-readable-p file) file)))
18301 files))))
18302 (when (or (eq archives t)
18303 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18304 (setq files (org-add-archive-files files)))
18305 files))
18307 (defun org-agenda-file-p (&optional file)
18308 "Return non-nil, if FILE is an agenda file.
18309 If FILE is omitted, use the file associated with the current
18310 buffer."
18311 (let ((fname (or file (buffer-file-name))))
18312 (and fname
18313 (member (file-truename fname)
18314 (mapcar #'file-truename (org-agenda-files t))))))
18316 (defun org-edit-agenda-file-list ()
18317 "Edit the list of agenda files.
18318 Depending on setup, this either uses customize to edit the variable
18319 `org-agenda-files', or it visits the file that is holding the list. In the
18320 latter case, the buffer is set up in a way that saving it automatically kills
18321 the buffer and restores the previous window configuration."
18322 (interactive)
18323 (if (stringp org-agenda-files)
18324 (let ((cw (current-window-configuration)))
18325 (find-file org-agenda-files)
18326 (org-set-local 'org-window-configuration cw)
18327 (org-add-hook 'after-save-hook
18328 (lambda ()
18329 (set-window-configuration
18330 (prog1 org-window-configuration
18331 (kill-buffer (current-buffer))))
18332 (org-install-agenda-files-menu)
18333 (message "New agenda file list installed"))
18334 nil 'local)
18335 (message "%s" (substitute-command-keys
18336 "Edit list and finish with \\[save-buffer]")))
18337 (customize-variable 'org-agenda-files)))
18339 (defun org-store-new-agenda-file-list (list)
18340 "Set new value for the agenda file list and save it correctly."
18341 (if (stringp org-agenda-files)
18342 (let ((fe (org-read-agenda-file-list t)) b u)
18343 (while (setq b (find-buffer-visiting org-agenda-files))
18344 (kill-buffer b))
18345 (with-temp-file org-agenda-files
18346 (insert
18347 (mapconcat
18348 (lambda (f) ;; Keep un-expanded entries.
18349 (if (setq u (assoc f fe))
18350 (cdr u)
18352 list "\n")
18353 "\n")))
18354 (let ((org-mode-hook nil) (org-inhibit-startup t)
18355 (org-insert-mode-line-in-empty-file nil))
18356 (setq org-agenda-files list)
18357 (customize-save-variable 'org-agenda-files org-agenda-files))))
18359 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18360 "Read the list of agenda files from a file.
18361 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18362 filenames, used by `org-store-new-agenda-file-list' to write back
18363 un-expanded file names."
18364 (when (file-directory-p org-agenda-files)
18365 (error "`org-agenda-files' cannot be a single directory"))
18366 (when (stringp org-agenda-files)
18367 (with-temp-buffer
18368 (insert-file-contents org-agenda-files)
18369 (mapcar
18370 (lambda (f)
18371 (let ((e (expand-file-name (substitute-in-file-name f)
18372 org-directory)))
18373 (if pair-with-expansion
18374 (cons e f)
18375 e)))
18376 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18378 ;;;###autoload
18379 (defun org-cycle-agenda-files ()
18380 "Cycle through the files in `org-agenda-files'.
18381 If the current buffer visits an agenda file, find the next one in the list.
18382 If the current buffer does not, find the first agenda file."
18383 (interactive)
18384 (let* ((fs (org-agenda-files t))
18385 (files (append fs (list (car fs))))
18386 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18387 file)
18388 (unless files (user-error "No agenda files"))
18389 (catch 'exit
18390 (while (setq file (pop files))
18391 (if (equal (file-truename file) tcf)
18392 (when (car files)
18393 (find-file (car files))
18394 (throw 'exit t))))
18395 (find-file (car fs)))
18396 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18398 (defun org-agenda-file-to-front (&optional to-end)
18399 "Move/add the current file to the top of the agenda file list.
18400 If the file is not present in the list, it is added to the front. If it is
18401 present, it is moved there. With optional argument TO-END, add/move to the
18402 end of the list."
18403 (interactive "P")
18404 (let ((org-agenda-skip-unavailable-files nil)
18405 (file-alist (mapcar (lambda (x)
18406 (cons (file-truename x) x))
18407 (org-agenda-files t)))
18408 (ctf (file-truename
18409 (or buffer-file-name
18410 (user-error "Please save the current buffer to a file"))))
18411 x had)
18412 (setq x (assoc ctf file-alist) had x)
18414 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18415 (if to-end
18416 (setq file-alist (append (delq x file-alist) (list x)))
18417 (setq file-alist (cons x (delq x file-alist))))
18418 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18419 (org-install-agenda-files-menu)
18420 (message "File %s to %s of agenda file list"
18421 (if had "moved" "added") (if to-end "end" "front"))))
18423 (defun org-remove-file (&optional file)
18424 "Remove current file from the list of files in variable `org-agenda-files'.
18425 These are the files which are being checked for agenda entries.
18426 Optional argument FILE means use this file instead of the current."
18427 (interactive)
18428 (let* ((org-agenda-skip-unavailable-files nil)
18429 (file (or file buffer-file-name
18430 (user-error "Current buffer does not visit a file")))
18431 (true-file (file-truename file))
18432 (afile (abbreviate-file-name file))
18433 (files (delq nil (mapcar
18434 (lambda (x)
18435 (if (equal true-file
18436 (file-truename x))
18437 nil x))
18438 (org-agenda-files t)))))
18439 (if (not (= (length files) (length (org-agenda-files t))))
18440 (progn
18441 (org-store-new-agenda-file-list files)
18442 (org-install-agenda-files-menu)
18443 (message "Removed from Org Agenda list: %s" afile))
18444 (message "File was not in list: %s (not removed)" afile))))
18446 (defun org-file-menu-entry (file)
18447 (vector file (list 'find-file file) t))
18449 (defun org-check-agenda-file (file)
18450 "Make sure FILE exists. If not, ask user what to do."
18451 (when (not (file-exists-p file))
18452 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18453 (abbreviate-file-name file))
18454 (let ((r (downcase (read-char-exclusive))))
18455 (cond
18456 ((equal r ?r)
18457 (org-remove-file file)
18458 (throw 'nextfile t))
18459 (t (user-error "Abort"))))))
18461 (defun org-get-agenda-file-buffer (file)
18462 "Get an agenda buffer visiting FILE.
18463 If the buffer needs to be created, add it to the list of buffers
18464 which might be released later."
18465 (let ((buf (org-find-base-buffer-visiting file)))
18466 (if buf
18467 buf ; just return it
18468 ;; Make a new buffer and remember it
18469 (setq buf (find-file-noselect file))
18470 (if buf (push buf org-agenda-new-buffers))
18471 buf)))
18473 (defun org-release-buffers (blist)
18474 "Release all buffers in list, asking the user for confirmation when needed.
18475 When a buffer is unmodified, it is just killed. When modified, it is saved
18476 \(if the user agrees) and then killed."
18477 (let (buf file)
18478 (while (setq buf (pop blist))
18479 (setq file (buffer-file-name buf))
18480 (when (and (buffer-modified-p buf)
18481 file
18482 (y-or-n-p (format "Save file %s? " file)))
18483 (with-current-buffer buf (save-buffer)))
18484 (kill-buffer buf))))
18486 (defun org-agenda-prepare-buffers (files)
18487 "Create buffers for all agenda files, protect archived trees and comments."
18488 (interactive)
18489 (let ((pa '(:org-archived t))
18490 (pc '(:org-comment t))
18491 (pall '(:org-archived t :org-comment t))
18492 (inhibit-read-only t)
18493 (org-inhibit-startup org-agenda-inhibit-startup)
18494 (rea (concat ":" org-archive-tag ":"))
18495 file re pos)
18496 (setq org-tag-alist-for-agenda nil
18497 org-tag-groups-alist-for-agenda nil)
18498 (save-excursion
18499 (save-restriction
18500 (while (setq file (pop files))
18501 (catch 'nextfile
18502 (if (bufferp file)
18503 (set-buffer file)
18504 (org-check-agenda-file file)
18505 (set-buffer (org-get-agenda-file-buffer file)))
18506 (widen)
18507 (org-set-regexps-and-options 'tags-only)
18508 (setq pos (point))
18509 (or (memq 'category org-agenda-ignore-properties)
18510 (org-refresh-category-properties))
18511 (or (memq 'stats org-agenda-ignore-properties)
18512 (org-refresh-stats-properties))
18513 (or (memq 'effort org-agenda-ignore-properties)
18514 (org-refresh-effort-properties))
18515 (or (memq 'appt org-agenda-ignore-properties)
18516 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18517 (setq org-todo-keywords-for-agenda
18518 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18519 (setq org-done-keywords-for-agenda
18520 (append org-done-keywords-for-agenda org-done-keywords))
18521 (setq org-todo-keyword-alist-for-agenda
18522 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18523 (setq org-tag-alist-for-agenda
18524 (org-uniquify
18525 (append org-tag-alist-for-agenda
18526 org-tag-alist
18527 org-tag-persistent-alist)))
18528 (if org-group-tags
18529 (setq org-tag-groups-alist-for-agenda
18530 (org-uniquify-alist
18531 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18532 (org-with-silent-modifications
18533 (save-excursion
18534 (remove-text-properties (point-min) (point-max) pall)
18535 (when org-agenda-skip-archived-trees
18536 (goto-char (point-min))
18537 (while (re-search-forward rea nil t)
18538 (if (org-at-heading-p t)
18539 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18540 (goto-char (point-min))
18541 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18542 (while (re-search-forward re nil t)
18543 (when (save-match-data (org-in-commented-heading-p t))
18544 (add-text-properties
18545 (match-beginning 0) (org-end-of-subtree t) pc)))))
18546 (goto-char pos)))))
18547 (setq org-todo-keywords-for-agenda
18548 (org-uniquify org-todo-keywords-for-agenda))
18549 (setq org-todo-keyword-alist-for-agenda
18550 (org-uniquify org-todo-keyword-alist-for-agenda))))
18553 ;;;; CDLaTeX minor mode
18555 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18556 "Keymap for the minor `org-cdlatex-mode'.")
18558 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18559 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18560 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18561 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18562 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18564 (defvar org-cdlatex-texmathp-advice-is-done nil
18565 "Flag remembering if we have applied the advice to texmathp already.")
18567 (define-minor-mode org-cdlatex-mode
18568 "Toggle the minor `org-cdlatex-mode'.
18569 This mode supports entering LaTeX environment and math in LaTeX fragments
18570 in Org-mode.
18571 \\{org-cdlatex-mode-map}"
18572 nil " OCDL" nil
18573 (when org-cdlatex-mode
18574 (require 'cdlatex)
18575 (run-hooks 'cdlatex-mode-hook)
18576 (cdlatex-compute-tables))
18577 (unless org-cdlatex-texmathp-advice-is-done
18578 (setq org-cdlatex-texmathp-advice-is-done t)
18579 (defadvice texmathp (around org-math-always-on activate)
18580 "Always return t in org-mode buffers.
18581 This is because we want to insert math symbols without dollars even outside
18582 the LaTeX math segments. If Orgmode thinks that point is actually inside
18583 an embedded LaTeX fragment, let texmathp do its job.
18584 \\[org-cdlatex-mode-map]"
18585 (interactive)
18586 (let (p)
18587 (cond
18588 ((not (derived-mode-p 'org-mode)) ad-do-it)
18589 ((eq this-command 'cdlatex-math-symbol)
18590 (setq ad-return-value t
18591 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18593 (let ((p (org-inside-LaTeX-fragment-p)))
18594 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18595 (setq ad-return-value t
18596 texmathp-why '("Org-mode embedded math" . 0))
18597 (if p ad-do-it)))))))))
18599 (defun turn-on-org-cdlatex ()
18600 "Unconditionally turn on `org-cdlatex-mode'."
18601 (org-cdlatex-mode 1))
18603 (defun org-try-cdlatex-tab ()
18604 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18605 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18606 - inside a LaTeX fragment, or
18607 - after the first word in a line, where an abbreviation expansion could
18608 insert a LaTeX environment."
18609 (when org-cdlatex-mode
18610 (cond
18611 ;; Before any word on the line: No expansion possible.
18612 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18613 ;; Just after first word on the line: Expand it. Make sure it
18614 ;; cannot happen on headlines, though.
18615 ((save-excursion
18616 (skip-chars-backward "a-zA-Z0-9*")
18617 (skip-chars-backward " \t")
18618 (and (bolp) (not (org-at-heading-p))))
18619 (cdlatex-tab) t)
18620 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18622 (defun org-cdlatex-underscore-caret (&optional arg)
18623 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18624 Revert to the normal definition outside of these fragments."
18625 (interactive "P")
18626 (if (org-inside-LaTeX-fragment-p)
18627 (call-interactively 'cdlatex-sub-superscript)
18628 (let (org-cdlatex-mode)
18629 (call-interactively (key-binding (vector last-input-event))))))
18631 (defun org-cdlatex-math-modify (&optional arg)
18632 "Execute `cdlatex-math-modify' in LaTeX fragments.
18633 Revert to the normal definition outside of these fragments."
18634 (interactive "P")
18635 (if (org-inside-LaTeX-fragment-p)
18636 (call-interactively 'cdlatex-math-modify)
18637 (let (org-cdlatex-mode)
18638 (call-interactively (key-binding (vector last-input-event))))))
18640 (defun org-cdlatex-environment-indent (&optional environment item)
18641 "Execute `cdlatex-environment' and indent the inserted environment."
18642 (interactive)
18643 (cdlatex-environment environment item)
18644 (let ((element (org-element-at-point)))
18645 (org-indent-region (org-element-property :begin element)
18646 (org-element-property :end element))))
18649 ;;;; LaTeX fragments
18651 (defun org-inside-LaTeX-fragment-p ()
18652 "Test if point is inside a LaTeX fragment.
18653 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18654 sequence appearing also before point.
18655 Even though the matchers for math are configurable, this function assumes
18656 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18657 delimiters are skipped when they have been removed by customization.
18658 The return value is nil, or a cons cell with the delimiter and the
18659 position of this delimiter.
18661 This function does a reasonably good job, but can locally be fooled by
18662 for example currency specifications. For example it will assume being in
18663 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18664 fragments that are properly closed, but during editing, we have to live
18665 with the uncertainty caused by missing closing delimiters. This function
18666 looks only before point, not after."
18667 (catch 'exit
18668 (let ((pos (point))
18669 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18670 (lim (progn
18671 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18672 (point)))
18673 dd-on str (start 0) m re)
18674 (goto-char pos)
18675 (when dodollar
18676 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18677 re (nth 1 (assoc "$" org-latex-regexps)))
18678 (while (string-match re str start)
18679 (cond
18680 ((= (match-end 0) (length str))
18681 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18682 ((= (match-end 0) (- (length str) 5))
18683 (throw 'exit nil))
18684 (t (setq start (match-end 0))))))
18685 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18686 (goto-char pos)
18687 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18688 (and (match-beginning 2) (throw 'exit nil))
18689 ;; count $$
18690 (while (re-search-backward "\\$\\$" lim t)
18691 (setq dd-on (not dd-on)))
18692 (goto-char pos)
18693 (if dd-on (cons "$$" m))))))
18695 (defun org-inside-latex-macro-p ()
18696 "Is point inside a LaTeX macro or its arguments?"
18697 (save-match-data
18698 (org-in-regexp
18699 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18701 (defvar org-latex-fragment-image-overlays nil
18702 "List of overlays carrying the images of latex fragments.")
18703 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18705 (defun org-remove-latex-fragment-image-overlays ()
18706 "Remove all overlays with LaTeX fragment images in current buffer."
18707 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18708 (setq org-latex-fragment-image-overlays nil))
18710 (define-obsolete-function-alias
18711 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18712 (defun org-toggle-latex-fragment (&optional subtree)
18713 "Preview the LaTeX fragment at point, or all locally or globally.
18714 If the cursor is in a LaTeX fragment, create the image and overlay
18715 it over the source code. If there is no fragment at point, display
18716 all fragments in the current text, from one headline to the next. With
18717 prefix SUBTREE, display all fragments in the current subtree. With a
18718 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18719 the cursor is before the first headline,
18720 display all fragments in the buffer.
18721 The images can be removed again with \\[org-toggle-latex-fragment]."
18722 (interactive "P")
18723 (unless (buffer-file-name (buffer-base-buffer))
18724 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18725 (if org-latex-fragment-image-overlays
18726 (progn (org-remove-latex-fragment-image-overlays)
18727 (message "LaTeX fragments images removed"))
18728 (when (display-graphic-p)
18729 (org-remove-latex-fragment-image-overlays)
18730 (org-with-wide-buffer
18731 (let (beg end msg)
18732 (cond
18733 ((equal subtree '(16))
18734 (setq beg (point-min) end (point-max)
18735 msg "Creating images for buffer...%s"))
18736 ((equal subtree '(4))
18737 (org-back-to-heading)
18738 (setq beg (point) end (org-end-of-subtree t)
18739 msg "Creating images for subtree...%s"))
18740 ((let ((context (org-element-context)))
18741 (when (memq (org-element-type context)
18742 '(latex-environment latex-fragment))
18743 (setq beg (org-element-property :begin context)
18744 end (org-element-property :end context)
18745 msg "Creating image...%s"))))
18746 ((org-before-first-heading-p)
18747 (setq beg (point-min) end (point-max)
18748 msg "Creating images for buffer...%s"))
18750 (org-back-to-heading)
18751 (setq beg (point) end (progn (outline-next-heading) (point))
18752 msg "Creating images for entry...%s")))
18753 (message msg "")
18754 (narrow-to-region beg end)
18755 (goto-char beg)
18756 (org-format-latex
18757 (concat org-latex-preview-ltxpng-directory
18758 (file-name-sans-extension
18759 (file-name-nondirectory
18760 (buffer-file-name (buffer-base-buffer)))))
18761 default-directory 'overlays msg 'forbuffer
18762 org-latex-create-formula-image-program)
18763 (message msg "done. Use `C-c C-x C-l' to remove images."))))))
18765 (defun org-format-latex
18766 (prefix &optional dir overlays msg forbuffer processing-type)
18767 "Replace LaTeX fragments with links to an image, and produce images.
18768 Some of the options can be changed using the variable
18769 `org-format-latex-options'."
18770 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18771 (unless (eq processing-type 'verbatim)
18772 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
18773 (cnt 0)
18774 checkdir-flag)
18775 (goto-char (point-min))
18776 (while (re-search-forward math-regexp nil t)
18777 (unless (and overlays
18778 (eq (get-char-property (point) 'org-overlay-type)
18779 'org-latex-overlay))
18780 (let* ((context (org-element-context))
18781 (type (org-element-type context)))
18782 (when (memq type '(latex-environment latex-fragment))
18783 (let ((block-type (eq type 'latex-environment))
18784 (value (org-element-property :value context))
18785 (beg (org-element-property :begin context))
18786 (end (save-excursion
18787 (goto-char (org-element-property :end context))
18788 (skip-chars-backward " \r\t\n")
18789 (point))))
18790 (case processing-type
18791 (mathjax
18792 ;; Prepare for MathJax processing.
18793 (if (eq (char-after beg) ?$)
18794 (save-excursion
18795 (delete-region beg end)
18796 (insert "\\(" (substring value 1 -1) "\\)"))
18797 (goto-char end)))
18798 ((dvipng imagemagick)
18799 ;; Process to an image.
18800 (incf cnt)
18801 (goto-char beg)
18802 (let* ((face (face-at-point))
18803 ;; Get the colors from the face at point.
18805 (let ((color (plist-get org-format-latex-options
18806 :foreground)))
18807 (if (and forbuffer (eq color 'auto))
18808 (face-attribute face :foreground nil 'default)
18809 color)))
18811 (let ((color (plist-get org-format-latex-options
18812 :background)))
18813 (if (and forbuffer (eq color 'auto))
18814 (face-attribute face :background nil 'default)
18815 color)))
18816 (hash (sha1 (prin1-to-string
18817 (list org-format-latex-header
18818 org-latex-default-packages-alist
18819 org-latex-packages-alist
18820 org-format-latex-options
18821 forbuffer value fg bg))))
18822 (absprefix (expand-file-name prefix dir))
18823 (linkfile (format "%s_%s.png" prefix hash))
18824 (movefile (format "%s_%s.png" absprefix hash))
18825 (sep (and block-type "\n\n"))
18826 (link (concat sep "[[file:" linkfile "]]" sep))
18827 (options
18828 (org-combine-plists
18829 org-format-latex-options
18830 `(:foreground ,fg :background ,bg))))
18831 (when msg (message msg cnt))
18832 (unless checkdir-flag ; Ensure the directory exists.
18833 (setq checkdir-flag t)
18834 (let ((todir (file-name-directory absprefix)))
18835 (unless (file-directory-p todir)
18836 (make-directory todir t))))
18837 (unless (file-exists-p movefile)
18838 (org-create-formula-image
18839 value movefile options forbuffer processing-type))
18840 (if overlays
18841 (progn
18842 (dolist (o (overlays-in beg end))
18843 (when (eq (overlay-get o 'org-overlay-type)
18844 'org-latex-overlay)
18845 (delete-overlay o)))
18846 (let ((ov (make-overlay beg end)))
18847 (overlay-put ov
18848 'org-overlay-type
18849 'org-latex-overlay)
18850 (if (featurep 'xemacs)
18851 (progn
18852 (overlay-put ov 'invisible t)
18853 (overlay-put
18854 ov 'end-glyph
18855 (make-glyph
18856 (vector 'png :file movefile))))
18857 (overlay-put
18858 ov 'display
18859 (list 'image
18860 :type 'png
18861 :file movefile
18862 :ascent 'center)))
18863 (push ov org-latex-fragment-image-overlays))
18864 (goto-char end))
18865 (delete-region beg end)
18866 (insert
18867 (org-add-props link
18868 (list 'org-latex-src
18869 (replace-regexp-in-string "\"" "" value)
18870 'org-latex-src-embed-type
18871 (if block-type 'paragraph 'character)))))))
18872 (mathml
18873 ;; Process to MathML.
18874 (unless (org-format-latex-mathml-available-p)
18875 (user-error "LaTeX to MathML converter not configured"))
18876 (incf cnt)
18877 (when msg (message msg cnt))
18878 (goto-char beg)
18879 (delete-region beg end)
18880 (insert (org-format-latex-as-mathml
18881 value block-type prefix dir)))
18882 (otherwise
18883 (error "Unknown conversion type %s for LaTeX fragments"
18884 processing-type)))))))))))
18886 (defun org-create-math-formula (latex-frag &optional mathml-file)
18887 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18888 Use `org-latex-to-mathml-convert-command'. If the conversion is
18889 sucessful, return the portion between \"<math...> </math>\"
18890 elements otherwise return nil. When MATHML-FILE is specified,
18891 write the results in to that file. When invoked as an
18892 interactive command, prompt for LATEX-FRAG, with initial value
18893 set to the current active region and echo the results for user
18894 inspection."
18895 (interactive (list (let ((frag (when (org-region-active-p)
18896 (buffer-substring-no-properties
18897 (region-beginning) (region-end)))))
18898 (read-string "LaTeX Fragment: " frag nil frag))))
18899 (unless latex-frag (user-error "Invalid LaTeX fragment"))
18900 (let* ((tmp-in-file (file-relative-name
18901 (make-temp-name (expand-file-name "ltxmathml-in"))))
18902 (ignore (write-region latex-frag nil tmp-in-file))
18903 (tmp-out-file (file-relative-name
18904 (make-temp-name (expand-file-name "ltxmathml-out"))))
18905 (cmd (format-spec
18906 org-latex-to-mathml-convert-command
18907 `((?j . ,(shell-quote-argument
18908 (expand-file-name org-latex-to-mathml-jar-file)))
18909 (?I . ,(shell-quote-argument tmp-in-file))
18910 (?o . ,(shell-quote-argument tmp-out-file)))))
18911 mathml shell-command-output)
18912 (when (org-called-interactively-p 'any)
18913 (unless (org-format-latex-mathml-available-p)
18914 (user-error "LaTeX to MathML converter not configured")))
18915 (message "Running %s" cmd)
18916 (setq shell-command-output (shell-command-to-string cmd))
18917 (setq mathml
18918 (when (file-readable-p tmp-out-file)
18919 (with-current-buffer (find-file-noselect tmp-out-file t)
18920 (goto-char (point-min))
18921 (when (re-search-forward
18922 (concat
18923 (regexp-quote
18924 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18925 "\\(.\\|\n\\)*"
18926 (regexp-quote "</math>")) nil t)
18927 (prog1 (match-string 0) (kill-buffer))))))
18928 (cond
18929 (mathml
18930 (setq mathml
18931 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18932 (when mathml-file
18933 (write-region mathml nil mathml-file))
18934 (when (org-called-interactively-p 'any)
18935 (message mathml)))
18936 ((message "LaTeX to MathML conversion failed")
18937 (message shell-command-output)))
18938 (delete-file tmp-in-file)
18939 (when (file-exists-p tmp-out-file)
18940 (delete-file tmp-out-file))
18941 mathml))
18943 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18944 prefix &optional dir)
18945 "Use `org-create-math-formula' but check local cache first."
18946 (let* ((absprefix (expand-file-name prefix dir))
18947 (print-length nil) (print-level nil)
18948 (formula-id (concat
18949 "formula-"
18950 (sha1
18951 (prin1-to-string
18952 (list latex-frag
18953 org-latex-to-mathml-convert-command)))))
18954 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18955 (formula-cache-dir (file-name-directory formula-cache)))
18957 (unless (file-directory-p formula-cache-dir)
18958 (make-directory formula-cache-dir t))
18960 (unless (file-exists-p formula-cache)
18961 (org-create-math-formula latex-frag formula-cache))
18963 (if (file-exists-p formula-cache)
18964 ;; Successful conversion. Return the link to MathML file.
18965 (org-add-props
18966 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18967 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18968 'org-latex-src-embed-type (if latex-frag-type
18969 'paragraph 'character)))
18970 ;; Failed conversion. Return the LaTeX fragment verbatim
18971 latex-frag)))
18973 (defun org-create-formula-image (string tofile options buffer &optional type)
18974 "Create an image from LaTeX source using dvipng or convert.
18975 This function calls either `org-create-formula-image-with-dvipng'
18976 or `org-create-formula-image-with-imagemagick' depending on the
18977 value of `org-latex-create-formula-image-program' or on the value
18978 of the optional TYPE variable.
18980 Note: ultimately these two function should be combined as they
18981 share a good deal of logic."
18982 (org-check-external-command
18983 "latex" "needed to convert LaTeX fragments to images")
18984 (funcall
18985 (case (or type org-latex-create-formula-image-program)
18986 ('dvipng
18987 (org-check-external-command
18988 "dvipng" "needed to convert LaTeX fragments to images")
18989 'org-create-formula-image-with-dvipng)
18990 ('imagemagick
18991 (org-check-external-command
18992 "convert" "you need to install imagemagick")
18993 'org-create-formula-image-with-imagemagick)
18994 (t (error
18995 "Invalid value of `org-latex-create-formula-image-program'")))
18996 string tofile options buffer))
18998 (declare-function org-export-get-backend "ox" (name))
18999 (declare-function org-export--get-global-options "ox" (&optional backend))
19000 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19001 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19002 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19003 (defun org-create-formula--latex-header ()
19004 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19005 (let ((info (org-combine-plists (org-export--get-global-options
19006 (org-export-get-backend 'latex))
19007 (org-export--get-inbuffer-options
19008 (org-export-get-backend 'latex)))))
19009 (org-latex-guess-babel-language
19010 (org-latex-guess-inputenc
19011 (org-splice-latex-header
19012 org-format-latex-header
19013 org-latex-default-packages-alist
19014 org-latex-packages-alist t
19015 (plist-get info :latex-header)))
19016 info)))
19018 (defun org--get-display-dpi ()
19019 "Get the DPI of the display.
19021 Assumes that the display has the same pixel width in the
19022 horizontal and vertical directions."
19023 (if (display-graphic-p)
19024 (round (/ (display-pixel-height)
19025 (/ (display-mm-height) 25.4)))
19026 (error "Attempt to calculate the dpi of a non-graphic display")))
19028 ;; This function borrows from Ganesh Swami's latex2png.el
19029 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19030 "This calls dvipng."
19031 (require 'ox-latex)
19032 (let* ((tmpdir (if (featurep 'xemacs)
19033 (temp-directory)
19034 temporary-file-directory))
19035 (texfilebase (make-temp-name
19036 (expand-file-name "orgtex" tmpdir)))
19037 (texfile (concat texfilebase ".tex"))
19038 (dvifile (concat texfilebase ".dvi"))
19039 (pngfile (concat texfilebase ".png"))
19040 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19041 ;; This assumes that the display has the same pixel width in
19042 ;; the horizontal and vertical directions
19043 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19044 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19045 "Black"))
19046 (bg (or (plist-get options (if buffer :background :html-background))
19047 "Transparent")))
19048 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19049 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19050 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19051 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19052 (let ((latex-header (org-create-formula--latex-header)))
19053 (with-temp-file texfile
19054 (insert latex-header)
19055 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19056 (let ((dir default-directory))
19057 (ignore-errors
19058 (cd tmpdir)
19059 (call-process "latex" nil nil nil texfile))
19060 (cd dir))
19061 (if (not (file-exists-p dvifile))
19062 (progn (message "Failed to create dvi file from %s" texfile) nil)
19063 (ignore-errors
19064 (if (featurep 'xemacs)
19065 (call-process "dvipng" nil nil nil
19066 "-fg" fg "-bg" bg
19067 "-T" "tight"
19068 "-o" pngfile
19069 dvifile)
19070 (call-process "dvipng" nil nil nil
19071 "-fg" fg "-bg" bg
19072 "-D" dpi
19073 ;;"-x" scale "-y" scale
19074 "-T" "tight"
19075 "-o" pngfile
19076 dvifile)))
19077 (if (not (file-exists-p pngfile))
19078 (if org-format-latex-signal-error
19079 (error "Failed to create png file from %s" texfile)
19080 (message "Failed to create png file from %s" texfile)
19081 nil)
19082 ;; Use the requested file name and clean up
19083 (copy-file pngfile tofile 'replace)
19084 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19085 (if (file-exists-p (concat texfilebase e))
19086 (delete-file (concat texfilebase e))))
19087 pngfile))))
19089 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19090 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19091 "This calls convert, which is included into imagemagick."
19092 (require 'ox-latex)
19093 (let* ((tmpdir (if (featurep 'xemacs)
19094 (temp-directory)
19095 temporary-file-directory))
19096 (texfilebase (make-temp-name
19097 (expand-file-name "orgtex" tmpdir)))
19098 (texfile (concat texfilebase ".tex"))
19099 (pdffile (concat texfilebase ".pdf"))
19100 (pngfile (concat texfilebase ".png"))
19101 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19102 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19103 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19104 "black"))
19105 (bg (or (plist-get options (if buffer :background :html-background))
19106 "white")))
19107 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19108 (setq fg (org-latex-color-format fg)))
19109 (if (eq bg 'default) (setq bg (org-latex-color :background))
19110 (setq bg (org-latex-color-format
19111 (if (string= bg "Transparent") "white" bg))))
19112 (let ((latex-header (org-create-formula--latex-header)))
19113 (with-temp-file texfile
19114 (insert latex-header)
19115 (insert "\n\\begin{document}\n"
19116 "\\definecolor{fg}{rgb}{" fg "}\n"
19117 "\\definecolor{bg}{rgb}{" bg "}\n"
19118 "\n\\pagecolor{bg}\n"
19119 "\n{\\color{fg}\n"
19120 string
19121 "\n}\n"
19122 "\n\\end{document}\n")))
19123 (org-latex-compile texfile t)
19124 (if (not (file-exists-p pdffile))
19125 (progn (message "Failed to create pdf file from %s" texfile) nil)
19126 (ignore-errors
19127 (if (featurep 'xemacs)
19128 (call-process "convert" nil nil nil
19129 "-density" "96"
19130 "-trim"
19131 "-antialias"
19132 pdffile
19133 "-quality" "100"
19134 ;; "-sharpen" "0x1.0"
19135 pngfile)
19136 (call-process "convert" nil nil nil
19137 "-density" dpi
19138 "-trim"
19139 "-antialias"
19140 pdffile
19141 "-quality" "100"
19142 ;; "-sharpen" "0x1.0"
19143 pngfile)))
19144 (if (not (file-exists-p pngfile))
19145 (if org-format-latex-signal-error
19146 (error "Failed to create png file from %s" texfile)
19147 (message "Failed to create png file from %s" texfile)
19148 nil)
19149 ;; Use the requested file name and clean up
19150 (copy-file pngfile tofile 'replace)
19151 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19152 (if (file-exists-p (concat texfilebase e))
19153 (delete-file (concat texfilebase e))))
19154 pngfile))))
19156 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19157 "Fill a LaTeX header template TPL.
19158 In the template, the following place holders will be recognized:
19160 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19161 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19162 [PACKAGES] \\usepackage statements for PKG
19163 [NO-PACKAGES] do not include PKG
19164 [EXTRA] the string EXTRA
19165 [NO-EXTRA] do not include EXTRA
19167 For backward compatibility, if both the positive and the negative place
19168 holder is missing, the positive one (without the \"NO-\") will be
19169 assumed to be present at the end of the template.
19170 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19171 EXTRA is a string.
19172 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19173 (let (rpl (end ""))
19174 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19175 (setq rpl (if (or (match-end 1) (not def-pkg))
19176 "" (org-latex-packages-to-string def-pkg snippets-p t))
19177 tpl (replace-match rpl t t tpl))
19178 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19180 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19181 (setq rpl (if (or (match-end 1) (not pkg))
19182 "" (org-latex-packages-to-string pkg snippets-p t))
19183 tpl (replace-match rpl t t tpl))
19184 (if pkg (setq end
19185 (concat end "\n"
19186 (org-latex-packages-to-string pkg snippets-p)))))
19188 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19189 (setq rpl (if (or (match-end 1) (not extra))
19190 "" (concat extra "\n"))
19191 tpl (replace-match rpl t t tpl))
19192 (if (and extra (string-match "\\S-" extra))
19193 (setq end (concat end "\n" extra))))
19195 (if (string-match "\\S-" end)
19196 (concat tpl "\n" end)
19197 tpl)))
19199 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19200 "Turn an alist of packages into a string with the \\usepackage macros."
19201 (setq pkg (mapconcat (lambda(p)
19202 (cond
19203 ((stringp p) p)
19204 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19205 (format "%% Package %s omitted" (cadr p)))
19206 ((equal "" (car p))
19207 (format "\\usepackage{%s}" (cadr p)))
19209 (format "\\usepackage[%s]{%s}"
19210 (car p) (cadr p)))))
19212 "\n"))
19213 (if newline (concat pkg "\n") pkg))
19215 (defun org-dvipng-color (attr)
19216 "Return a RGB color specification for dvipng."
19217 (apply 'format "rgb %s %s %s"
19218 (mapcar 'org-normalize-color
19219 (if (featurep 'xemacs)
19220 (color-rgb-components
19221 (face-property 'default
19222 (cond ((eq attr :foreground) 'foreground)
19223 ((eq attr :background) 'background))))
19224 (color-values (face-attribute 'default attr nil))))))
19226 (defun org-dvipng-color-format (color-name)
19227 "Convert COLOR-NAME to a RGB color value for dvipng."
19228 (apply 'format "rgb %s %s %s"
19229 (mapcar 'org-normalize-color
19230 (color-values color-name))))
19232 (defun org-latex-color (attr)
19233 "Return a RGB color for the LaTeX color package."
19234 (apply 'format "%s,%s,%s"
19235 (mapcar 'org-normalize-color
19236 (if (featurep 'xemacs)
19237 (color-rgb-components
19238 (face-property 'default
19239 (cond ((eq attr :foreground) 'foreground)
19240 ((eq attr :background) 'background))))
19241 (color-values (face-attribute 'default attr nil))))))
19243 (defun org-latex-color-format (color-name)
19244 "Convert COLOR-NAME to a RGB color value."
19245 (apply 'format "%s,%s,%s"
19246 (mapcar 'org-normalize-color
19247 (color-values color-name))))
19249 (defun org-normalize-color (value)
19250 "Return string to be used as color value for an RGB component."
19251 (format "%g" (/ value 65535.0)))
19255 ;; Image display
19257 (defvar org-inline-image-overlays nil)
19258 (make-variable-buffer-local 'org-inline-image-overlays)
19260 (defun org-toggle-inline-images (&optional include-linked)
19261 "Toggle the display of inline images.
19262 INCLUDE-LINKED is passed to `org-display-inline-images'."
19263 (interactive "P")
19264 (if org-inline-image-overlays
19265 (progn
19266 (org-remove-inline-images)
19267 (when (org-called-interactively-p 'interactive)
19268 (message "Inline image display turned off")))
19269 (org-display-inline-images include-linked)
19270 (when (org-called-interactively-p 'interactive)
19271 (message (if org-inline-image-overlays
19272 (format "%d images displayed inline"
19273 (length org-inline-image-overlays))
19274 "No images to display inline")))))
19276 (defun org-redisplay-inline-images ()
19277 "Refresh the display of inline images."
19278 (interactive)
19279 (if (not org-inline-image-overlays)
19280 (org-toggle-inline-images)
19281 (org-toggle-inline-images)
19282 (org-toggle-inline-images)))
19284 (defun org-display-inline-images (&optional include-linked refresh beg end)
19285 "Display inline images.
19287 An inline image is a link which follows either of these
19288 conventions:
19290 1. Its path is a file with an extension matching return value
19291 from `image-file-name-regexp' and it has no contents.
19293 2. Its description consists in a single link of the previous
19294 type.
19296 When optional argument INCLUDE-LINKED is non-nil, also links with
19297 a text description part will be inlined. This can be nice for
19298 a quick look at those images, but it does not reflect what
19299 exported files will look like.
19301 When optional argument REFRESH is non-nil, refresh existing
19302 images between BEG and END. This will create new image displays
19303 only if necessary. BEG and END default to the buffer
19304 boundaries."
19305 (interactive "P")
19306 (when (display-graphic-p)
19307 (unless refresh
19308 (org-remove-inline-images)
19309 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19310 (org-with-wide-buffer
19311 (goto-char (or beg (point-min)))
19312 (let ((case-fold-search t)
19313 (file-extension-re (org-image-file-name-regexp)))
19314 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19315 (let ((link (save-match-data (org-element-context))))
19316 ;; Check if we're at an inline image.
19317 (when (and (equal (org-element-property :type link) "file")
19318 (or include-linked
19319 (not (org-element-property :contents-begin link)))
19320 (let ((parent (org-element-property :parent link)))
19321 (or (not (eq (org-element-type parent) 'link))
19322 (not (cdr (org-element-contents parent)))))
19323 (org-string-match-p file-extension-re
19324 (org-element-property :path link)))
19325 (let ((file (expand-file-name (org-element-property :path link))))
19326 (when (file-exists-p file)
19327 (let ((width
19328 ;; Apply `org-image-actual-width' specifications.
19329 (cond
19330 ((not (image-type-available-p 'imagemagick)) nil)
19331 ((eq org-image-actual-width t) nil)
19332 ((listp org-image-actual-width)
19334 ;; First try to find a width among
19335 ;; attributes associated to the paragraph
19336 ;; containing link.
19337 (let ((paragraph
19338 (let ((e link))
19339 (while (and (setq e (org-element-property
19340 :parent e))
19341 (not (eq (org-element-type e)
19342 'paragraph))))
19343 e)))
19344 (when paragraph
19345 (save-excursion
19346 (goto-char (org-element-property :begin paragraph))
19347 (when
19348 (re-search-forward
19349 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19350 (org-element-property
19351 :post-affiliated paragraph)
19353 (string-to-number (match-string 1))))))
19354 ;; Otherwise, fall-back to provided number.
19355 (car org-image-actual-width)))
19356 ((numberp org-image-actual-width)
19357 org-image-actual-width)))
19358 (old (get-char-property-and-overlay
19359 (org-element-property :begin link)
19360 'org-image-overlay)))
19361 (if (and (car-safe old) refresh)
19362 (image-refresh (overlay-get (cdr old) 'display))
19363 (let ((image (create-image file
19364 (and width 'imagemagick)
19366 :width width)))
19367 (when image
19368 (let* ((link
19369 ;; If inline image is the description
19370 ;; of another link, be sure to
19371 ;; consider the latter as the one to
19372 ;; apply the overlay on.
19373 (let ((parent
19374 (org-element-property :parent link)))
19375 (if (eq (org-element-type parent) 'link)
19376 parent
19377 link)))
19378 (ov (make-overlay
19379 (org-element-property :begin link)
19380 (progn
19381 (goto-char
19382 (org-element-property :end link))
19383 (skip-chars-backward " \t")
19384 (point)))))
19385 (overlay-put ov 'display image)
19386 (overlay-put ov 'face 'default)
19387 (overlay-put ov 'org-image-overlay t)
19388 (overlay-put
19389 ov 'modification-hooks
19390 (list 'org-display-inline-remove-overlay))
19391 (push ov org-inline-image-overlays)))))))))))))))
19393 (define-obsolete-function-alias
19394 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19396 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19397 "Remove inline-display overlay if a corresponding region is modified."
19398 (let ((inhibit-modification-hooks t))
19399 (when (and ov after)
19400 (delete ov org-inline-image-overlays)
19401 (delete-overlay ov))))
19403 (defun org-remove-inline-images ()
19404 "Remove inline display of images."
19405 (interactive)
19406 (mapc 'delete-overlay org-inline-image-overlays)
19407 (setq org-inline-image-overlays nil))
19409 ;;;; Key bindings
19411 ;; Outline functions from `outline-mode-prefix-map'
19412 ;; that can be remapped in Org:
19413 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19414 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19415 (define-key org-mode-map [remap outline-forward-same-level]
19416 'org-forward-heading-same-level)
19417 (define-key org-mode-map [remap outline-backward-same-level]
19418 'org-backward-heading-same-level)
19419 (define-key org-mode-map [remap show-branches]
19420 'org-kill-note-or-show-branches)
19421 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19422 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19423 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19424 (define-key org-mode-map [remap outline-next-visible-heading]
19425 'org-next-visible-heading)
19426 (define-key org-mode-map [remap outline-previous-visible-heading]
19427 'org-previous-visible-heading)
19429 ;; Outline functions from `outline-mode-prefix-map' that can not
19430 ;; be remapped in Org:
19432 ;; - the column "key binding" shows whether the Outline function is still
19433 ;; available in Org mode on the same key that it has been bound to in
19434 ;; Outline mode:
19435 ;; - "overridden": key used for a different functionality in Org mode
19436 ;; - else: key still bound to the same Outline function in Org mode
19438 ;; | Outline function | key binding | Org replacement |
19439 ;; |------------------------------------+-------------+--------------------------|
19440 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19441 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19442 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19443 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19444 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19445 ;; | `show-entry' | overridden | no replacement |
19446 ;; | `show-children' | `C-c C-i' | visibility cycling |
19447 ;; | `show-branches' | `C-c C-k' | still same function |
19448 ;; | `show-subtree' | overridden | visibility cycling |
19449 ;; | `show-all' | overridden | no replacement |
19450 ;; | `hide-subtree' | overridden | visibility cycling |
19451 ;; | `hide-body' | overridden | no replacement |
19452 ;; | `hide-entry' | overridden | visibility cycling |
19453 ;; | `hide-leaves' | overridden | no replacement |
19454 ;; | `hide-sublevels' | overridden | no replacement |
19455 ;; | `hide-other' | overridden | no replacement |
19457 ;; Make `C-c C-x' a prefix key
19458 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19460 ;; TAB key with modifiers
19461 (org-defkey org-mode-map "\C-i" 'org-cycle)
19462 (org-defkey org-mode-map [(tab)] 'org-cycle)
19463 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19464 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19465 ;; The following line is necessary under Suse GNU/Linux
19466 (unless (featurep 'xemacs)
19467 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19468 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19469 (define-key org-mode-map [backtab] 'org-shifttab)
19471 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19472 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19473 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19475 ;; Cursor keys with modifiers
19476 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19477 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19478 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19479 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19481 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19482 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19483 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19484 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19485 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19486 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19488 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19489 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19490 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19491 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19493 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19494 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19495 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19496 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19498 ;; Babel keys
19499 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19500 (mapc (lambda (pair)
19501 (define-key org-babel-map (car pair) (cdr pair)))
19502 org-babel-key-bindings)
19504 ;;; Extra keys for tty access.
19505 ;; We only set them when really needed because otherwise the
19506 ;; menus don't show the simple keys
19508 (when (or org-use-extra-keys
19509 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19510 (not window-system))
19511 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19512 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19513 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19514 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19515 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19516 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19517 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19518 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19519 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19520 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19521 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19522 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19523 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19524 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19525 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19526 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19527 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19528 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19529 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19530 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19531 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19532 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19533 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19534 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19535 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19536 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19537 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19538 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19540 ;; All the other keys
19542 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19543 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19544 (if (boundp 'narrow-map)
19545 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19546 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19547 (if (boundp 'narrow-map)
19548 (org-defkey narrow-map "b" 'org-narrow-to-block)
19549 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19550 (if (boundp 'narrow-map)
19551 (org-defkey narrow-map "e" 'org-narrow-to-element)
19552 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19553 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19554 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19555 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19556 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19557 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19558 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19559 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19560 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19561 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19562 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19563 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19564 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19565 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19566 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19567 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19568 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19569 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19570 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19571 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19572 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19573 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19574 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19575 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19576 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19577 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19578 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19579 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19580 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19581 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19582 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19583 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19584 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19585 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19586 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19587 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19588 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19589 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19590 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19591 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19592 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19593 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19594 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19595 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19596 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19597 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19598 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19599 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19600 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19601 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19602 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19603 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19604 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19605 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19606 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19607 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19608 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19609 (org-defkey org-mode-map "\C-c^" 'org-sort)
19610 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19611 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19612 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19613 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19614 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19615 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19616 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19617 (org-defkey org-mode-map "\C-m" 'org-return)
19618 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19619 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19620 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19621 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19622 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19623 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19624 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19625 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19626 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19627 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19628 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19629 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19630 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19631 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19632 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19633 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19634 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19635 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19636 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19637 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19638 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19639 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19640 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19641 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19642 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19644 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19645 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19646 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19648 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19649 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19650 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19651 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19652 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19653 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19654 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19655 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19656 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19657 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19658 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19659 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19660 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19661 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19662 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19663 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19664 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19665 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19666 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19667 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19668 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19669 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19670 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19672 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19673 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19674 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19675 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19676 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19678 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19680 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19682 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19683 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19685 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19688 (when (featurep 'xemacs)
19689 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19692 (defconst org-speed-commands-default
19694 ("Outline Navigation")
19695 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19696 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19697 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19698 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19699 ("F" . org-next-block)
19700 ("B" . org-previous-block)
19701 ("u" . (org-speed-move-safe 'outline-up-heading))
19702 ("j" . org-goto)
19703 ("g" . (org-refile t))
19704 ("Outline Visibility")
19705 ("c" . org-cycle)
19706 ("C" . org-shifttab)
19707 (" " . org-display-outline-path)
19708 ("s" . org-narrow-to-subtree)
19709 ("=" . org-columns)
19710 ("Outline Structure Editing")
19711 ("U" . org-metaup)
19712 ("D" . org-metadown)
19713 ("r" . org-metaright)
19714 ("l" . org-metaleft)
19715 ("R" . org-shiftmetaright)
19716 ("L" . org-shiftmetaleft)
19717 ("i" . (progn (forward-char 1) (call-interactively
19718 'org-insert-heading-respect-content)))
19719 ("^" . org-sort)
19720 ("w" . org-refile)
19721 ("a" . org-archive-subtree-default-with-confirmation)
19722 ("@" . org-mark-subtree)
19723 ("#" . org-toggle-comment)
19724 ("Clock Commands")
19725 ("I" . org-clock-in)
19726 ("O" . org-clock-out)
19727 ("Meta Data Editing")
19728 ("t" . org-todo)
19729 ("," . (org-priority))
19730 ("0" . (org-priority ?\ ))
19731 ("1" . (org-priority ?A))
19732 ("2" . (org-priority ?B))
19733 ("3" . (org-priority ?C))
19734 (":" . org-set-tags-command)
19735 ("e" . org-set-effort)
19736 ("E" . org-inc-effort)
19737 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19738 (org-entry-put (point) "APPT_WARNTIME" m)))
19739 ("Agenda Views etc")
19740 ("v" . org-agenda)
19741 ("/" . org-sparse-tree)
19742 ("Misc")
19743 ("o" . org-open-at-point)
19744 ("?" . org-speed-command-help)
19745 ("<" . (org-agenda-set-restriction-lock 'subtree))
19746 (">" . (org-agenda-remove-restriction-lock))
19748 "The default speed commands.")
19750 (defun org-print-speed-command (e)
19751 (if (> (length (car e)) 1)
19752 (progn
19753 (princ "\n")
19754 (princ (car e))
19755 (princ "\n")
19756 (princ (make-string (length (car e)) ?-))
19757 (princ "\n"))
19758 (princ (car e))
19759 (princ " ")
19760 (if (symbolp (cdr e))
19761 (princ (symbol-name (cdr e)))
19762 (prin1 (cdr e)))
19763 (princ "\n")))
19765 (defun org-speed-command-help ()
19766 "Show the available speed commands."
19767 (interactive)
19768 (if (not org-use-speed-commands)
19769 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19770 (with-output-to-temp-buffer "*Help*"
19771 (princ "User-defined Speed commands\n===========================\n")
19772 (mapc 'org-print-speed-command org-speed-commands-user)
19773 (princ "\n")
19774 (princ "Built-in Speed commands\n=======================\n")
19775 (mapc 'org-print-speed-command org-speed-commands-default))
19776 (with-current-buffer "*Help*"
19777 (setq truncate-lines t))))
19779 (defun org-speed-move-safe (cmd)
19780 "Execute CMD, but make sure that the cursor always ends up in a headline.
19781 If not, return to the original position and throw an error."
19782 (interactive)
19783 (let ((pos (point)))
19784 (call-interactively cmd)
19785 (unless (and (bolp) (org-at-heading-p))
19786 (goto-char pos)
19787 (error "Boundary reached while executing %s" cmd))))
19789 (defvar org-self-insert-command-undo-counter 0)
19791 (defvar org-table-auto-blank-field) ; defined in org-table.el
19792 (defvar org-speed-command nil)
19794 (define-obsolete-function-alias
19795 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19797 (defun org-speed-command-activate (keys)
19798 "Hook for activating single-letter speed commands.
19799 `org-speed-commands-default' specifies a minimal command set.
19800 Use `org-speed-commands-user' for further customization."
19801 (when (or (and (bolp) (looking-at org-outline-regexp))
19802 (and (functionp org-use-speed-commands)
19803 (funcall org-use-speed-commands)))
19804 (cdr (assoc keys (append org-speed-commands-user
19805 org-speed-commands-default)))))
19807 (define-obsolete-function-alias
19808 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19810 (defun org-babel-speed-command-activate (keys)
19811 "Hook for activating single-letter code block commands."
19812 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19813 (cdr (assoc keys org-babel-key-bindings))))
19815 (defcustom org-speed-command-hook
19816 '(org-speed-command-default-hook org-babel-speed-command-hook)
19817 "Hook for activating speed commands at strategic locations.
19818 Hook functions are called in sequence until a valid handler is
19819 found.
19821 Each hook takes a single argument, a user-pressed command key
19822 which is also a `self-insert-command' from the global map.
19824 Within the hook, examine the cursor position and the command key
19825 and return nil or a valid handler as appropriate. Handler could
19826 be one of an interactive command, a function, or a form.
19828 Set `org-use-speed-commands' to non-nil value to enable this
19829 hook. The default setting is `org-speed-command-activate'."
19830 :group 'org-structure
19831 :version "24.1"
19832 :type 'hook)
19834 (defun org-self-insert-command (N)
19835 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19836 If the cursor is in a table looking at whitespace, the whitespace is
19837 overwritten, and the table is not marked as requiring realignment."
19838 (interactive "p")
19839 (org-check-before-invisible-edit 'insert)
19840 (cond
19841 ((and org-use-speed-commands
19842 (let ((kv (this-command-keys-vector)))
19843 (setq org-speed-command
19844 (run-hook-with-args-until-success
19845 'org-speed-command-hook
19846 (make-string 1 (aref kv (1- (length kv))))))))
19847 (cond
19848 ((commandp org-speed-command)
19849 (setq this-command org-speed-command)
19850 (call-interactively org-speed-command))
19851 ((functionp org-speed-command)
19852 (funcall org-speed-command))
19853 ((and org-speed-command (listp org-speed-command))
19854 (eval org-speed-command))
19855 (t (let (org-use-speed-commands)
19856 (call-interactively 'org-self-insert-command)))))
19857 ((and
19858 (org-table-p)
19859 (progn
19860 ;; check if we blank the field, and if that triggers align
19861 (and (featurep 'org-table) org-table-auto-blank-field
19862 (memq last-command
19863 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
19864 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19865 ;; got extra space, this field does not determine column width
19866 (let (org-table-may-need-update) (org-table-blank-field))
19867 ;; no extra space, this field may determine column width
19868 (org-table-blank-field)))
19870 (eq N 1)
19871 (looking-at "[^|\n]* |"))
19872 (let (org-table-may-need-update)
19873 (goto-char (1- (match-end 0)))
19874 (backward-delete-char 1)
19875 (goto-char (match-beginning 0))
19876 (self-insert-command N)))
19878 (setq org-table-may-need-update t)
19879 (self-insert-command N)
19880 (org-fix-tags-on-the-fly)
19881 (if org-self-insert-cluster-for-undo
19882 (if (not (eq last-command 'org-self-insert-command))
19883 (setq org-self-insert-command-undo-counter 1)
19884 (if (>= org-self-insert-command-undo-counter 20)
19885 (setq org-self-insert-command-undo-counter 1)
19886 (and (> org-self-insert-command-undo-counter 0)
19887 buffer-undo-list (listp buffer-undo-list)
19888 (not (cadr buffer-undo-list)) ; remove nil entry
19889 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19890 (setq org-self-insert-command-undo-counter
19891 (1+ org-self-insert-command-undo-counter))))))))
19893 (defun org-check-before-invisible-edit (kind)
19894 "Check is editing if kind KIND would be dangerous with invisible text around.
19895 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19896 ;; First, try to get out of here as quickly as possible, to reduce overhead
19897 (if (and org-catch-invisible-edits
19898 (or (not (boundp 'visible-mode)) (not visible-mode))
19899 (or (get-char-property (point) 'invisible)
19900 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19901 ;; OK, we need to take a closer look
19902 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19903 (invisible-before-point (if (bobp) nil (get-char-property
19904 (1- (point)) 'invisible)))
19905 (border-and-ok-direction
19907 ;; Check if we are acting predictably before invisible text
19908 (and invisible-at-point (not invisible-before-point)
19909 (memq kind '(insert delete-backward)))
19910 ;; Check if we are acting predictably after invisible text
19911 ;; This works not well, and I have turned it off. It seems
19912 ;; better to always show and stop after invisible text.
19913 ;; (and (not invisible-at-point) invisible-before-point
19914 ;; (memq kind '(insert delete)))
19916 (when (or (memq invisible-at-point '(outline org-hide-block t))
19917 (memq invisible-before-point '(outline org-hide-block t)))
19918 (if (eq org-catch-invisible-edits 'error)
19919 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19920 (if (and org-custom-properties-overlays
19921 (y-or-n-p "Display invisible properties in this buffer? "))
19922 (org-toggle-custom-properties-visibility)
19923 ;; Make the area visible
19924 (save-excursion
19925 (if invisible-before-point
19926 (goto-char (previous-single-char-property-change
19927 (point) 'invisible)))
19928 (show-subtree))
19929 (cond
19930 ((eq org-catch-invisible-edits 'show)
19931 ;; That's it, we do the edit after showing
19932 (message
19933 "Unfolding invisible region around point before editing")
19934 (sit-for 1))
19935 ((and (eq org-catch-invisible-edits 'smart)
19936 border-and-ok-direction)
19937 (message "Unfolding invisible region around point before editing"))
19939 ;; Don't do the edit, make the user repeat it in full visibility
19940 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19942 (defun org-fix-tags-on-the-fly ()
19943 (when (and (equal (char-after (point-at-bol)) ?*)
19944 (org-at-heading-p))
19945 (org-align-tags-here org-tags-column)))
19947 (defun org-delete-backward-char (N)
19948 "Like `delete-backward-char', insert whitespace at field end in tables.
19949 When deleting backwards, in tables this function will insert whitespace in
19950 front of the next \"|\" separator, to keep the table aligned. The table will
19951 still be marked for re-alignment if the field did fill the entire column,
19952 because, in this case the deletion might narrow the column."
19953 (interactive "p")
19954 (save-match-data
19955 (org-check-before-invisible-edit 'delete-backward)
19956 (if (and (org-table-p)
19957 (eq N 1)
19958 (string-match "|" (buffer-substring (point-at-bol) (point)))
19959 (looking-at ".*?|"))
19960 (let ((pos (point))
19961 (noalign (looking-at "[^|\n\r]* |"))
19962 (c org-table-may-need-update))
19963 (backward-delete-char N)
19964 (if (not overwrite-mode)
19965 (progn
19966 (skip-chars-forward "^|")
19967 (insert " ")
19968 (goto-char (1- pos))))
19969 ;; noalign: if there were two spaces at the end, this field
19970 ;; does not determine the width of the column.
19971 (if noalign (setq org-table-may-need-update c)))
19972 (backward-delete-char N)
19973 (org-fix-tags-on-the-fly))))
19975 (defun org-delete-char (N)
19976 "Like `delete-char', but insert whitespace at field end in tables.
19977 When deleting characters, in tables this function will insert whitespace in
19978 front of the next \"|\" separator, to keep the table aligned. The table will
19979 still be marked for re-alignment if the field did fill the entire column,
19980 because, in this case the deletion might narrow the column."
19981 (interactive "p")
19982 (save-match-data
19983 (org-check-before-invisible-edit 'delete)
19984 (if (and (org-table-p)
19985 (not (bolp))
19986 (not (= (char-after) ?|))
19987 (eq N 1))
19988 (if (looking-at ".*?|")
19989 (let ((pos (point))
19990 (noalign (looking-at "[^|\n\r]* |"))
19991 (c org-table-may-need-update))
19992 (replace-match
19993 (concat (substring (match-string 0) 1 -1) " |") nil t)
19994 (goto-char pos)
19995 ;; noalign: if there were two spaces at the end, this field
19996 ;; does not determine the width of the column.
19997 (if noalign (setq org-table-may-need-update c)))
19998 (delete-char N))
19999 (delete-char N)
20000 (org-fix-tags-on-the-fly))))
20002 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20003 (put 'org-self-insert-command 'delete-selection
20004 (lambda ()
20005 (not (run-hook-with-args-until-success
20006 'self-insert-uses-region-functions))))
20007 (put 'orgtbl-self-insert-command 'delete-selection
20008 (lambda ()
20009 (not (run-hook-with-args-until-success
20010 'self-insert-uses-region-functions))))
20011 (put 'org-delete-char 'delete-selection 'supersede)
20012 (put 'org-delete-backward-char 'delete-selection 'supersede)
20013 (put 'org-yank 'delete-selection 'yank)
20015 ;; Make `flyspell-mode' delay after some commands
20016 (put 'org-self-insert-command 'flyspell-delayed t)
20017 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20018 (put 'org-delete-char 'flyspell-delayed t)
20019 (put 'org-delete-backward-char 'flyspell-delayed t)
20021 ;; Make pabbrev-mode expand after org-mode commands
20022 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20023 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20025 (defun org-remap (map &rest commands)
20026 "In MAP, remap the functions given in COMMANDS.
20027 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20028 (let (new old)
20029 (while commands
20030 (setq old (pop commands) new (pop commands))
20031 (if (fboundp 'command-remapping)
20032 (org-defkey map (vector 'remap old) new)
20033 (substitute-key-definition old new map global-map)))))
20035 (defun org-transpose-words ()
20036 "Transpose words for Org.
20037 This uses the `org-mode-transpose-word-syntax-table' syntax
20038 table, which interprets characters in `org-emphasis-alist' as
20039 word constituents."
20040 (interactive)
20041 (with-syntax-table org-mode-transpose-word-syntax-table
20042 (call-interactively 'transpose-words)))
20043 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20045 (when (eq org-enable-table-editor 'optimized)
20046 ;; If the user wants maximum table support, we need to hijack
20047 ;; some standard editing functions
20048 (org-remap org-mode-map
20049 'self-insert-command 'org-self-insert-command
20050 'delete-char 'org-delete-char
20051 'delete-backward-char 'org-delete-backward-char)
20052 (org-defkey org-mode-map "|" 'org-force-self-insert))
20054 (defvar org-ctrl-c-ctrl-c-hook nil
20055 "Hook for functions attaching themselves to `C-c C-c'.
20057 This can be used to add additional functionality to the C-c C-c
20058 key which executes context-dependent commands. This hook is run
20059 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20060 run after the last test.
20062 Each function will be called with no arguments. The function
20063 must check if the context is appropriate for it to act. If yes,
20064 it should do its thing and then return a non-nil value. If the
20065 context is wrong, just do nothing and return nil.")
20067 (defvar org-ctrl-c-ctrl-c-final-hook nil
20068 "Hook for functions attaching themselves to `C-c C-c'.
20070 This can be used to add additional functionality to the C-c C-c
20071 key which executes context-dependent commands. This hook is run
20072 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20073 before the first test.
20075 Each function will be called with no arguments. The function
20076 must check if the context is appropriate for it to act. If yes,
20077 it should do its thing and then return a non-nil value. If the
20078 context is wrong, just do nothing and return nil.")
20080 (defvar org-tab-first-hook nil
20081 "Hook for functions to attach themselves to TAB.
20082 See `org-ctrl-c-ctrl-c-hook' for more information.
20083 This hook runs as the first action when TAB is pressed, even before
20084 `org-cycle' messes around with the `outline-regexp' to cater for
20085 inline tasks and plain list item folding.
20086 If any function in this hook returns t, any other actions that
20087 would have been caused by TAB (such as table field motion or visibility
20088 cycling) will not occur.")
20090 (defvar org-tab-after-check-for-table-hook nil
20091 "Hook for functions to attach themselves to TAB.
20092 See `org-ctrl-c-ctrl-c-hook' for more information.
20093 This hook runs after it has been established that the cursor is not in a
20094 table, but before checking if the cursor is in a headline or if global cycling
20095 should be done.
20096 If any function in this hook returns t, not other actions like visibility
20097 cycling will be done.")
20099 (defvar org-tab-after-check-for-cycling-hook nil
20100 "Hook for functions to attach themselves to TAB.
20101 See `org-ctrl-c-ctrl-c-hook' for more information.
20102 This hook runs after it has been established that not table field motion and
20103 not visibility should be done because of current context. This is probably
20104 the place where a package like yasnippets can hook in.")
20106 (defvar org-tab-before-tab-emulation-hook nil
20107 "Hook for functions to attach themselves to TAB.
20108 See `org-ctrl-c-ctrl-c-hook' for more information.
20109 This hook runs after every other options for TAB have been exhausted, but
20110 before indentation and \t insertion takes place.")
20112 (defvar org-metaleft-hook nil
20113 "Hook for functions attaching themselves to `M-left'.
20114 See `org-ctrl-c-ctrl-c-hook' for more information.")
20115 (defvar org-metaright-hook nil
20116 "Hook for functions attaching themselves to `M-right'.
20117 See `org-ctrl-c-ctrl-c-hook' for more information.")
20118 (defvar org-metaup-hook nil
20119 "Hook for functions attaching themselves to `M-up'.
20120 See `org-ctrl-c-ctrl-c-hook' for more information.")
20121 (defvar org-metadown-hook nil
20122 "Hook for functions attaching themselves to `M-down'.
20123 See `org-ctrl-c-ctrl-c-hook' for more information.")
20124 (defvar org-shiftmetaleft-hook nil
20125 "Hook for functions attaching themselves to `M-S-left'.
20126 See `org-ctrl-c-ctrl-c-hook' for more information.")
20127 (defvar org-shiftmetaright-hook nil
20128 "Hook for functions attaching themselves to `M-S-right'.
20129 See `org-ctrl-c-ctrl-c-hook' for more information.")
20130 (defvar org-shiftmetaup-hook nil
20131 "Hook for functions attaching themselves to `M-S-up'.
20132 See `org-ctrl-c-ctrl-c-hook' for more information.")
20133 (defvar org-shiftmetadown-hook nil
20134 "Hook for functions attaching themselves to `M-S-down'.
20135 See `org-ctrl-c-ctrl-c-hook' for more information.")
20136 (defvar org-metareturn-hook nil
20137 "Hook for functions attaching themselves to `M-RET'.
20138 See `org-ctrl-c-ctrl-c-hook' for more information.")
20139 (defvar org-shiftup-hook nil
20140 "Hook for functions attaching themselves to `S-up'.
20141 See `org-ctrl-c-ctrl-c-hook' for more information.")
20142 (defvar org-shiftup-final-hook nil
20143 "Hook for functions attaching themselves to `S-up'.
20144 This one runs after all other options except shift-select have been excluded.
20145 See `org-ctrl-c-ctrl-c-hook' for more information.")
20146 (defvar org-shiftdown-hook nil
20147 "Hook for functions attaching themselves to `S-down'.
20148 See `org-ctrl-c-ctrl-c-hook' for more information.")
20149 (defvar org-shiftdown-final-hook nil
20150 "Hook for functions attaching themselves to `S-down'.
20151 This one runs after all other options except shift-select have been excluded.
20152 See `org-ctrl-c-ctrl-c-hook' for more information.")
20153 (defvar org-shiftleft-hook nil
20154 "Hook for functions attaching themselves to `S-left'.
20155 See `org-ctrl-c-ctrl-c-hook' for more information.")
20156 (defvar org-shiftleft-final-hook nil
20157 "Hook for functions attaching themselves to `S-left'.
20158 This one runs after all other options except shift-select have been excluded.
20159 See `org-ctrl-c-ctrl-c-hook' for more information.")
20160 (defvar org-shiftright-hook nil
20161 "Hook for functions attaching themselves to `S-right'.
20162 See `org-ctrl-c-ctrl-c-hook' for more information.")
20163 (defvar org-shiftright-final-hook nil
20164 "Hook for functions attaching themselves to `S-right'.
20165 This one runs after all other options except shift-select have been excluded.
20166 See `org-ctrl-c-ctrl-c-hook' for more information.")
20168 (defun org-modifier-cursor-error ()
20169 "Throw an error, a modified cursor command was applied in wrong context."
20170 (user-error "This command is active in special context like tables, headlines or items"))
20172 (defun org-shiftselect-error ()
20173 "Throw an error because Shift-Cursor command was applied in wrong context."
20174 (if (and (boundp 'shift-select-mode) shift-select-mode)
20175 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20176 (user-error "This command works only in special context like headlines or timestamps")))
20178 (defun org-call-for-shift-select (cmd)
20179 (let ((this-command-keys-shift-translated t))
20180 (call-interactively cmd)))
20182 (defun org-shifttab (&optional arg)
20183 "Global visibility cycling or move to previous table field.
20184 Call `org-table-previous-field' within a table.
20185 When ARG is nil, cycle globally through visibility states.
20186 When ARG is a numeric prefix, show contents of this level."
20187 (interactive "P")
20188 (cond
20189 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20190 ((integerp arg)
20191 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20192 (message "Content view to level: %d" arg)
20193 (org-content (prefix-numeric-value arg2))
20194 (org-cycle-show-empty-lines t)
20195 (setq org-cycle-global-status 'overview)))
20196 (t (call-interactively 'org-global-cycle))))
20198 (defun org-shiftmetaleft ()
20199 "Promote subtree or delete table column.
20200 Calls `org-promote-subtree', `org-outdent-item-tree', or
20201 `org-table-delete-column', depending on context. See the
20202 individual commands for more information."
20203 (interactive)
20204 (cond
20205 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20206 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20207 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20208 ((if (not (org-region-active-p)) (org-at-item-p)
20209 (save-excursion (goto-char (region-beginning))
20210 (org-at-item-p)))
20211 (call-interactively 'org-outdent-item-tree))
20212 (t (org-modifier-cursor-error))))
20214 (defun org-shiftmetaright ()
20215 "Demote subtree or insert table column.
20216 Calls `org-demote-subtree', `org-indent-item-tree', or
20217 `org-table-insert-column', depending on context. See the
20218 individual commands for more information."
20219 (interactive)
20220 (cond
20221 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20222 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20223 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20224 ((if (not (org-region-active-p)) (org-at-item-p)
20225 (save-excursion (goto-char (region-beginning))
20226 (org-at-item-p)))
20227 (call-interactively 'org-indent-item-tree))
20228 (t (org-modifier-cursor-error))))
20230 (defun org-shiftmetaup (&optional arg)
20231 "Drag the line at point up.
20232 In a table, kill the current row.
20233 On a clock timestamp, update the value of the timestamp like `S-<up>'
20234 but also adjust the previous clocked item in the clock history.
20235 Everywhere else, drag the line at point up."
20236 (interactive "P")
20237 (cond
20238 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20239 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20240 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20241 (call-interactively 'org-timestamp-up)))
20242 (t (call-interactively 'org-drag-line-backward))))
20244 (defun org-shiftmetadown (&optional arg)
20245 "Drag the line at point down.
20246 In a table, insert an empty row at the current line.
20247 On a clock timestamp, update the value of the timestamp like `S-<down>'
20248 but also adjust the previous clocked item in the clock history.
20249 Everywhere else, drag the line at point down."
20250 (interactive "P")
20251 (cond
20252 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20253 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20254 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20255 (call-interactively 'org-timestamp-down)))
20256 (t (call-interactively 'org-drag-line-forward))))
20258 (defsubst org-hidden-tree-error ()
20259 (user-error
20260 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20262 (defun org-metaleft (&optional arg)
20263 "Promote heading or move table column to left.
20264 Calls `org-do-promote' or `org-table-move-column', depending on context.
20265 With no specific context, calls the Emacs default `backward-word'.
20266 See the individual commands for more information."
20267 (interactive "P")
20268 (cond
20269 ((run-hook-with-args-until-success 'org-metaleft-hook))
20270 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20271 ((org-with-limited-levels
20272 (or (org-at-heading-p)
20273 (and (org-region-active-p)
20274 (save-excursion
20275 (goto-char (region-beginning))
20276 (org-at-heading-p)))))
20277 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20278 (call-interactively 'org-do-promote))
20279 ;; At an inline task.
20280 ((org-at-heading-p)
20281 (call-interactively 'org-inlinetask-promote))
20282 ((or (org-at-item-p)
20283 (and (org-region-active-p)
20284 (save-excursion
20285 (goto-char (region-beginning))
20286 (org-at-item-p))))
20287 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20288 (call-interactively 'org-outdent-item))
20289 (t (call-interactively 'backward-word))))
20291 (defun org-metaright (&optional arg)
20292 "Demote a subtree, a list item or move table column to right.
20293 In front of a drawer or a block keyword, indent it correctly.
20294 With no specific context, calls the Emacs default `forward-word'.
20295 See the individual commands for more information."
20296 (interactive "P")
20297 (cond
20298 ((run-hook-with-args-until-success 'org-metaright-hook))
20299 ((org-at-table-p) (call-interactively 'org-table-move-column))
20300 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20301 ((org-at-block-p) (call-interactively 'org-indent-block))
20302 ((org-with-limited-levels
20303 (or (org-at-heading-p)
20304 (and (org-region-active-p)
20305 (save-excursion
20306 (goto-char (region-beginning))
20307 (org-at-heading-p)))))
20308 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20309 (call-interactively 'org-do-demote))
20310 ;; At an inline task.
20311 ((org-at-heading-p)
20312 (call-interactively 'org-inlinetask-demote))
20313 ((or (org-at-item-p)
20314 (and (org-region-active-p)
20315 (save-excursion
20316 (goto-char (region-beginning))
20317 (org-at-item-p))))
20318 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20319 (call-interactively 'org-indent-item))
20320 (t (call-interactively 'forward-word))))
20322 (defun org-check-for-hidden (what)
20323 "Check if there are hidden headlines/items in the current visual line.
20324 WHAT can be either `headlines' or `items'. If the current line is
20325 an outline or item heading and it has a folded subtree below it,
20326 this function returns t, nil otherwise."
20327 (let ((re (cond
20328 ((eq what 'headlines) org-outline-regexp-bol)
20329 ((eq what 'items) (org-item-beginning-re))
20330 (t (error "This should not happen"))))
20331 beg end)
20332 (save-excursion
20333 (catch 'exit
20334 (unless (org-region-active-p)
20335 (setq beg (point-at-bol))
20336 (beginning-of-line 2)
20337 (while (and (not (eobp)) ;; this is like `next-line'
20338 (get-char-property (1- (point)) 'invisible))
20339 (beginning-of-line 2))
20340 (setq end (point))
20341 (goto-char beg)
20342 (goto-char (point-at-eol))
20343 (setq end (max end (point)))
20344 (while (re-search-forward re end t)
20345 (if (get-char-property (match-beginning 0) 'invisible)
20346 (throw 'exit t))))
20347 nil))))
20349 (defun org-metaup (&optional arg)
20350 "Move subtree up or move table row up.
20351 Calls `org-move-subtree-up' or `org-table-move-row' or
20352 `org-move-item-up', depending on context. See the individual commands
20353 for more information."
20354 (interactive "P")
20355 (cond
20356 ((run-hook-with-args-until-success 'org-metaup-hook))
20357 ((org-region-active-p)
20358 (let* ((a (min (region-beginning) (region-end)))
20359 (b (1- (max (region-beginning) (region-end))))
20360 (c (save-excursion (goto-char a)
20361 (move-beginning-of-line 0)))
20362 (d (save-excursion (goto-char a)
20363 (move-end-of-line 0) (point))))
20364 (transpose-regions a b c d)
20365 (goto-char c)))
20366 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20367 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20368 ((org-at-item-p) (call-interactively 'org-move-item-up))
20369 (t (org-drag-element-backward))))
20371 (defun org-metadown (&optional arg)
20372 "Move subtree down or move table row down.
20373 Calls `org-move-subtree-down' or `org-table-move-row' or
20374 `org-move-item-down', depending on context. See the individual
20375 commands for more information."
20376 (interactive "P")
20377 (cond
20378 ((run-hook-with-args-until-success 'org-metadown-hook))
20379 ((org-region-active-p)
20380 (let* ((a (min (region-beginning) (region-end)))
20381 (b (max (region-beginning) (region-end)))
20382 (c (save-excursion (goto-char b)
20383 (move-beginning-of-line 1)))
20384 (d (save-excursion (goto-char b)
20385 (move-end-of-line 1) (1+ (point)))))
20386 (transpose-regions a b c d)
20387 (goto-char d)))
20388 ((org-at-table-p) (call-interactively 'org-table-move-row))
20389 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20390 ((org-at-item-p) (call-interactively 'org-move-item-down))
20391 (t (org-drag-element-forward))))
20393 (defun org-shiftup (&optional arg)
20394 "Increase item in timestamp or increase priority of current headline.
20395 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20396 depending on context. See the individual commands for more information."
20397 (interactive "P")
20398 (cond
20399 ((run-hook-with-args-until-success 'org-shiftup-hook))
20400 ((and org-support-shift-select (org-region-active-p))
20401 (org-call-for-shift-select 'previous-line))
20402 ((org-at-timestamp-p t)
20403 (call-interactively (if org-edit-timestamp-down-means-later
20404 'org-timestamp-down 'org-timestamp-up)))
20405 ((and (not (eq org-support-shift-select 'always))
20406 org-enable-priority-commands
20407 (org-at-heading-p))
20408 (call-interactively 'org-priority-up))
20409 ((and (not org-support-shift-select) (org-at-item-p))
20410 (call-interactively 'org-previous-item))
20411 ((org-clocktable-try-shift 'up arg))
20412 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20413 (org-support-shift-select
20414 (org-call-for-shift-select 'previous-line))
20415 (t (org-shiftselect-error))))
20417 (defun org-shiftdown (&optional arg)
20418 "Decrease item in timestamp or decrease priority of current headline.
20419 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20420 depending on context. See the individual commands for more information."
20421 (interactive "P")
20422 (cond
20423 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20424 ((and org-support-shift-select (org-region-active-p))
20425 (org-call-for-shift-select 'next-line))
20426 ((org-at-timestamp-p t)
20427 (call-interactively (if org-edit-timestamp-down-means-later
20428 'org-timestamp-up 'org-timestamp-down)))
20429 ((and (not (eq org-support-shift-select 'always))
20430 org-enable-priority-commands
20431 (org-at-heading-p))
20432 (call-interactively 'org-priority-down))
20433 ((and (not org-support-shift-select) (org-at-item-p))
20434 (call-interactively 'org-next-item))
20435 ((org-clocktable-try-shift 'down arg))
20436 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20437 (org-support-shift-select
20438 (org-call-for-shift-select 'next-line))
20439 (t (org-shiftselect-error))))
20441 (defun org-shiftright (&optional arg)
20442 "Cycle the thing at point or in the current line, depending on context.
20443 Depending on context, this does one of the following:
20445 - switch a timestamp at point one day into the future
20446 - on a headline, switch to the next TODO keyword.
20447 - on an item, switch entire list to the next bullet type
20448 - on a property line, switch to the next allowed value
20449 - on a clocktable definition line, move time block into the future"
20450 (interactive "P")
20451 (cond
20452 ((run-hook-with-args-until-success 'org-shiftright-hook))
20453 ((and org-support-shift-select (org-region-active-p))
20454 (org-call-for-shift-select 'forward-char))
20455 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20456 ((and (not (eq org-support-shift-select 'always))
20457 (org-at-heading-p))
20458 (let ((org-inhibit-logging
20459 (not org-treat-S-cursor-todo-selection-as-state-change))
20460 (org-inhibit-blocking
20461 (not org-treat-S-cursor-todo-selection-as-state-change)))
20462 (org-call-with-arg 'org-todo 'right)))
20463 ((or (and org-support-shift-select
20464 (not (eq org-support-shift-select 'always))
20465 (org-at-item-bullet-p))
20466 (and (not org-support-shift-select) (org-at-item-p)))
20467 (org-call-with-arg 'org-cycle-list-bullet nil))
20468 ((and (not (eq org-support-shift-select 'always))
20469 (org-at-property-p))
20470 (call-interactively 'org-property-next-allowed-value))
20471 ((org-clocktable-try-shift 'right arg))
20472 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20473 (org-support-shift-select
20474 (org-call-for-shift-select 'forward-char))
20475 (t (org-shiftselect-error))))
20477 (defun org-shiftleft (&optional arg)
20478 "Cycle the thing at point or in the current line, depending on context.
20479 Depending on context, this does one of the following:
20481 - switch a timestamp at point one day into the past
20482 - on a headline, switch to the previous TODO keyword.
20483 - on an item, switch entire list to the previous bullet type
20484 - on a property line, switch to the previous allowed value
20485 - on a clocktable definition line, move time block into the past"
20486 (interactive "P")
20487 (cond
20488 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20489 ((and org-support-shift-select (org-region-active-p))
20490 (org-call-for-shift-select 'backward-char))
20491 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20492 ((and (not (eq org-support-shift-select 'always))
20493 (org-at-heading-p))
20494 (let ((org-inhibit-logging
20495 (not org-treat-S-cursor-todo-selection-as-state-change))
20496 (org-inhibit-blocking
20497 (not org-treat-S-cursor-todo-selection-as-state-change)))
20498 (org-call-with-arg 'org-todo 'left)))
20499 ((or (and org-support-shift-select
20500 (not (eq org-support-shift-select 'always))
20501 (org-at-item-bullet-p))
20502 (and (not org-support-shift-select) (org-at-item-p)))
20503 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20504 ((and (not (eq org-support-shift-select 'always))
20505 (org-at-property-p))
20506 (call-interactively 'org-property-previous-allowed-value))
20507 ((org-clocktable-try-shift 'left arg))
20508 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20509 (org-support-shift-select
20510 (org-call-for-shift-select 'backward-char))
20511 (t (org-shiftselect-error))))
20513 (defun org-shiftcontrolright ()
20514 "Switch to next TODO set."
20515 (interactive)
20516 (cond
20517 ((and org-support-shift-select (org-region-active-p))
20518 (org-call-for-shift-select 'forward-word))
20519 ((and (not (eq org-support-shift-select 'always))
20520 (org-at-heading-p))
20521 (org-call-with-arg 'org-todo 'nextset))
20522 (org-support-shift-select
20523 (org-call-for-shift-select 'forward-word))
20524 (t (org-shiftselect-error))))
20526 (defun org-shiftcontrolleft ()
20527 "Switch to previous TODO set."
20528 (interactive)
20529 (cond
20530 ((and org-support-shift-select (org-region-active-p))
20531 (org-call-for-shift-select 'backward-word))
20532 ((and (not (eq org-support-shift-select 'always))
20533 (org-at-heading-p))
20534 (org-call-with-arg 'org-todo 'previousset))
20535 (org-support-shift-select
20536 (org-call-for-shift-select 'backward-word))
20537 (t (org-shiftselect-error))))
20539 (defun org-shiftcontrolup (&optional n)
20540 "Change timestamps synchronously up in CLOCK log lines.
20541 Optional argument N tells to change by that many units."
20542 (interactive "P")
20543 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20544 (let (org-support-shift-select)
20545 (org-clock-timestamps-up n))
20546 (user-error "Not at a clock log")))
20548 (defun org-shiftcontroldown (&optional n)
20549 "Change timestamps synchronously down in CLOCK log lines.
20550 Optional argument N tells to change by that many units."
20551 (interactive "P")
20552 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20553 (let (org-support-shift-select)
20554 (org-clock-timestamps-down n))
20555 (user-error "Not at a clock log")))
20557 (defun org-increase-number-at-point (&optional inc)
20558 "Increment the number at point.
20559 With an optional prefix numeric argument INC, increment using
20560 this numeric value."
20561 (interactive "p")
20562 (if (not (number-at-point))
20563 (user-error "Not on a number")
20564 (unless inc (setq inc 1))
20565 (let ((pos (point))
20566 (beg (skip-chars-backward "-+^/*0-9eE."))
20567 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20568 (setq nap (buffer-substring-no-properties
20569 (+ pos beg) (+ pos beg end)))
20570 (delete-region (+ pos beg) (+ pos beg end))
20571 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20572 (when (org-at-table-p)
20573 (org-table-align)
20574 (org-table-end-of-field 1))))
20576 (defun org-decrease-number-at-point (&optional inc)
20577 "Decrement the number at point.
20578 With an optional prefix numeric argument INC, decrement using
20579 this numeric value."
20580 (interactive "p")
20581 (org-increase-number-at-point (- inc)))
20583 (defun org-ctrl-c-ret ()
20584 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20585 (interactive)
20586 (cond
20587 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20588 (t (call-interactively 'org-insert-heading))))
20590 (defun org-find-visible ()
20591 (let ((s (point)))
20592 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20593 (get-char-property s 'invisible)))
20595 (defun org-find-invisible ()
20596 (let ((s (point)))
20597 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20598 (not (get-char-property s 'invisible))))
20601 (defun org-copy-visible (beg end)
20602 "Copy the visible parts of the region."
20603 (interactive "r")
20604 (let (snippets s)
20605 (save-excursion
20606 (save-restriction
20607 (narrow-to-region beg end)
20608 (setq s (goto-char (point-min)))
20609 (while (not (= (point) (point-max)))
20610 (goto-char (org-find-invisible))
20611 (push (buffer-substring s (point)) snippets)
20612 (setq s (goto-char (org-find-visible))))))
20613 (kill-new (apply 'concat (nreverse snippets)))))
20615 (defun org-copy-special ()
20616 "Copy region in table or copy current subtree.
20617 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20618 See the individual commands for more information."
20619 (interactive)
20620 (call-interactively
20621 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20623 (defun org-cut-special ()
20624 "Cut region in table or cut current subtree.
20625 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20626 See the individual commands for more information."
20627 (interactive)
20628 (call-interactively
20629 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20631 (defun org-paste-special (arg)
20632 "Paste rectangular region into table, or past subtree relative to level.
20633 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20634 See the individual commands for more information."
20635 (interactive "P")
20636 (if (org-at-table-p)
20637 (org-table-paste-rectangle)
20638 (org-paste-subtree arg)))
20640 (defsubst org-in-fixed-width-region-p ()
20641 "Is point in a fixed-width region?"
20642 (save-match-data
20643 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20645 (defun org-edit-special (&optional arg)
20646 "Call a special editor for the element at point.
20647 When at a table, call the formula editor with `org-table-edit-formulas'.
20648 When in a source code block, call `org-edit-src-code'.
20649 When in a fixed-width region, call `org-edit-fixed-width-region'.
20650 When in an export block, call `org-edit-export-block'.
20651 When at an #+INCLUDE keyword, visit the included file.
20652 On a link, call `ffap' to visit the link at point.
20653 Otherwise, return a user error."
20654 (interactive "P")
20655 (let ((element (org-element-at-point)))
20656 (assert (not buffer-read-only) nil
20657 "Buffer is read-only: %s" (buffer-name))
20658 (case (org-element-type element)
20659 (src-block
20660 (if (not arg) (org-edit-src-code)
20661 (let* ((info (org-babel-get-src-block-info))
20662 (lang (nth 0 info))
20663 (params (nth 2 info))
20664 (session (cdr (assq :session params))))
20665 (if (not session) (org-edit-src-code)
20666 ;; At a src-block with a session and function called with
20667 ;; an ARG: switch to the buffer related to the inferior
20668 ;; process.
20669 (switch-to-buffer
20670 (funcall (intern (concat "org-babel-prep-session:" lang))
20671 session params))))))
20672 (keyword
20673 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20674 (org-open-link-from-string
20675 (format "[[%s]]"
20676 (expand-file-name
20677 (let ((value (org-element-property :value element)))
20678 (cond ((not (org-string-nw-p value))
20679 (user-error "No file to edit"))
20680 ((string-match "\\`\"\\(.*?\\)\"" value)
20681 (match-string 1 value))
20682 ((string-match "\\`[^ \t\"]\\S-*" value)
20683 (match-string 0 value))
20684 (t (user-error "No valid file specified")))))))
20685 (user-error "No special environment to edit here")))
20686 (table
20687 (if (eq (org-element-property :type element) 'table.el)
20688 (org-edit-table.el)
20689 (call-interactively 'org-table-edit-formulas)))
20690 ;; Only Org tables contain `table-row' type elements.
20691 (table-row (call-interactively 'org-table-edit-formulas))
20692 ((example-block src-block) (org-edit-src-code))
20693 (export-block (org-edit-export-block))
20694 (fixed-width (org-edit-fixed-width-region))
20695 (otherwise
20696 ;; No notable element at point. Though, we may be at a link,
20697 ;; which is an object. Thus, scan deeper.
20698 (if (eq (org-element-type (org-element-context element)) 'link)
20699 (call-interactively 'ffap)
20700 (user-error "No special environment to edit here"))))))
20702 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20703 (defun org-ctrl-c-ctrl-c (&optional arg)
20704 "Set tags in headline, or update according to changed information at point.
20706 This command does many different things, depending on context:
20708 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20709 this is what we do.
20711 - If the cursor is on a statistics cookie, update it.
20713 - If the cursor is in a headline, prompt for tags and insert them
20714 into the current line, aligned to `org-tags-column'. When called
20715 with prefix arg, realign all tags in the current buffer.
20717 - If the cursor is in one of the special #+KEYWORD lines, this
20718 triggers scanning the buffer for these lines and updating the
20719 information.
20721 - If the cursor is inside a table, realign the table. This command
20722 works even if the automatic table editor has been turned off.
20724 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20725 the entire table.
20727 - If the cursor is at a footnote reference or definition, jump to
20728 the corresponding definition or references, respectively.
20730 - If the cursor is a the beginning of a dynamic block, update it.
20732 - If the current buffer is a capture buffer, close note and file it.
20734 - If the cursor is on a <<<target>>>, update radio targets and
20735 corresponding links in this buffer.
20737 - If the cursor is on a numbered item in a plain list, renumber the
20738 ordered list.
20740 - If the cursor is on a checkbox, toggle it.
20742 - If the cursor is on a code block, evaluate it. The variable
20743 `org-confirm-babel-evaluate' can be used to control prompting
20744 before code block evaluation, by default every code block
20745 evaluation requires confirmation. Code block evaluation can be
20746 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20747 (interactive "P")
20748 (cond
20749 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20750 org-occur-highlights)
20751 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20752 (org-remove-occur-highlights)
20753 (message "Temporary highlights/overlays removed from current buffer"))
20754 ((and (local-variable-p 'org-finish-function (current-buffer))
20755 (fboundp org-finish-function))
20756 (funcall org-finish-function))
20757 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20759 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20760 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20761 (user-error "C-c C-c can do nothing useful at this location"))
20762 (let* ((context (org-element-context))
20763 (type (org-element-type context)))
20764 (case type
20765 ;; When at a link, act according to the parent instead.
20766 (link (setq context (org-element-property :parent context))
20767 (setq type (org-element-type context)))
20768 ;; Unsupported object types: refer to the first supported
20769 ;; element or object containing it.
20770 ((bold code entity export-snippet inline-babel-call inline-src-block
20771 italic latex-fragment line-break macro strike-through subscript
20772 superscript underline verbatim)
20773 (setq context
20774 (org-element-lineage
20775 context '(radio-target paragraph verse-block table-cell)))))
20776 ;; For convenience: at the first line of a paragraph on the
20777 ;; same line as an item, apply function on that item instead.
20778 (when (eq type 'paragraph)
20779 (let ((parent (org-element-property :parent context)))
20780 (when (and (eq (org-element-type parent) 'item)
20781 (= (line-beginning-position)
20782 (org-element-property :begin parent)))
20783 (setq context parent type 'item))))
20784 ;; Act according to type of element or object at point.
20785 (case type
20786 (clock (org-clock-update-time-maybe))
20787 (dynamic-block
20788 (save-excursion
20789 (goto-char (org-element-property :post-affiliated context))
20790 (org-update-dblock)))
20791 (footnote-definition
20792 (goto-char (org-element-property :post-affiliated context))
20793 (call-interactively 'org-footnote-action))
20794 (footnote-reference (call-interactively 'org-footnote-action))
20795 ((headline inlinetask)
20796 (save-excursion (goto-char (org-element-property :begin context))
20797 (call-interactively 'org-set-tags)))
20798 (item
20799 ;; At an item: a double C-u set checkbox to "[-]"
20800 ;; unconditionally, whereas a single one will toggle its
20801 ;; presence. Without an universal argument, if the item
20802 ;; has a checkbox, toggle it. Otherwise repair the list.
20803 (let* ((box (org-element-property :checkbox context))
20804 (struct (org-element-property :structure context))
20805 (old-struct (copy-tree struct))
20806 (parents (org-list-parents-alist struct))
20807 (prevs (org-list-prevs-alist struct))
20808 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20809 (org-list-set-checkbox
20810 (org-element-property :begin context) struct
20811 (cond ((equal arg '(16)) "[-]")
20812 ((and (not box) (equal arg '(4))) "[ ]")
20813 ((or (not box) (equal arg '(4))) nil)
20814 ((eq box 'on) "[ ]")
20815 (t "[X]")))
20816 ;; Mimic `org-list-write-struct' but with grabbing
20817 ;; a return value from `org-list-struct-fix-box'.
20818 (org-list-struct-fix-ind struct parents 2)
20819 (org-list-struct-fix-item-end struct)
20820 (org-list-struct-fix-bul struct prevs)
20821 (org-list-struct-fix-ind struct parents)
20822 (let ((block-item
20823 (org-list-struct-fix-box struct parents prevs orderedp)))
20824 (if (and box (equal struct old-struct))
20825 (if (equal arg '(16))
20826 (message "Checkboxes already reset")
20827 (user-error "Cannot toggle this checkbox: %s"
20828 (if (eq box 'on)
20829 "all subitems checked"
20830 "unchecked subitems")))
20831 (org-list-struct-apply-struct struct old-struct)
20832 (org-update-checkbox-count-maybe))
20833 (when block-item
20834 (message "Checkboxes were removed due to empty box at line %d"
20835 (org-current-line block-item))))))
20836 (keyword
20837 (let ((org-inhibit-startup-visibility-stuff t)
20838 (org-startup-align-all-tables nil))
20839 (when (boundp 'org-table-coordinate-overlays)
20840 (mapc 'delete-overlay org-table-coordinate-overlays)
20841 (setq org-table-coordinate-overlays nil))
20842 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20843 (message "Local setup has been refreshed"))
20844 (plain-list
20845 ;; At a plain list, with a double C-u argument, set
20846 ;; checkboxes of each item to "[-]", whereas a single one
20847 ;; will toggle their presence according to the state of the
20848 ;; first item in the list. Without an argument, repair the
20849 ;; list.
20850 (let* ((begin (org-element-property :contents-begin context))
20851 (beginm (move-marker (make-marker) begin))
20852 (struct (org-element-property :structure context))
20853 (old-struct (copy-tree struct))
20854 (first-box (save-excursion
20855 (goto-char begin)
20856 (looking-at org-list-full-item-re)
20857 (match-string-no-properties 3)))
20858 (new-box (cond ((equal arg '(16)) "[-]")
20859 ((equal arg '(4)) (unless first-box "[ ]"))
20860 ((equal first-box "[X]") "[ ]")
20861 (t "[X]"))))
20862 (cond
20863 (arg
20864 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20865 (org-list-get-all-items
20866 begin struct (org-list-prevs-alist struct))))
20867 ((and first-box (eq (point) begin))
20868 ;; For convenience, when point is at bol on the first
20869 ;; item of the list and no argument is provided, simply
20870 ;; toggle checkbox of that item, if any.
20871 (org-list-set-checkbox begin struct new-box)))
20872 (org-list-write-struct
20873 struct (org-list-parents-alist struct) old-struct)
20874 (org-update-checkbox-count-maybe)
20875 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20876 ((property-drawer node-property)
20877 (call-interactively 'org-property-action))
20878 ((radio-target target)
20879 (call-interactively 'org-update-radio-target-regexp))
20880 (statistics-cookie
20881 (call-interactively 'org-update-statistics-cookies))
20882 ((table table-cell table-row)
20883 ;; At a table, recalculate every field and align it. Also
20884 ;; send the table if necessary. If the table has
20885 ;; a `table.el' type, just give up. At a table row or
20886 ;; cell, maybe recalculate line but always align table.
20887 (if (eq (org-element-property :type context) 'table.el)
20888 (message "Use C-c ' to edit table.el tables")
20889 (let ((org-enable-table-editor t))
20890 (if (or (eq type 'table)
20891 ;; Check if point is at a TBLFM line.
20892 (and (eq type 'table-row)
20893 (= (point) (org-element-property :end context))))
20894 (save-excursion
20895 (if (org-at-TBLFM-p)
20896 (progn (require 'org-table)
20897 (org-table-calc-current-TBLFM))
20898 (goto-char (org-element-property :contents-begin context))
20899 (org-call-with-arg 'org-table-recalculate (or arg t))
20900 (orgtbl-send-table 'maybe)))
20901 (org-table-maybe-eval-formula)
20902 (cond (arg (call-interactively 'org-table-recalculate))
20903 ((org-table-maybe-recalculate-line))
20904 (t (org-table-align)))))))
20905 (timestamp (org-timestamp-change 0 'day))
20906 (otherwise
20907 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20908 (user-error
20909 "C-c C-c can do nothing useful at this location")))))))))
20911 (defun org-mode-restart ()
20912 (interactive)
20913 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20914 (funcall major-mode)
20915 (hack-local-variables)
20916 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20917 (org-indent-mode -1)))
20918 (message "%s restarted" major-mode))
20920 (defun org-kill-note-or-show-branches ()
20921 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20922 (interactive)
20923 (if (not org-finish-function)
20924 (progn
20925 (hide-subtree)
20926 (call-interactively 'show-branches))
20927 (let ((org-note-abort t))
20928 (funcall org-finish-function))))
20930 (defun org-open-line (n)
20931 "Insert a new row in tables, call `open-line' elsewhere.
20932 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20933 (interactive "*p")
20934 (cond
20935 ((not org-special-ctrl-o)
20936 (open-line n))
20937 ((org-at-table-p)
20938 (org-table-insert-row))
20940 (open-line n))))
20942 (defun org-return (&optional indent)
20943 "Goto next table row or insert a newline.
20945 Calls `org-table-next-row' or `newline', depending on context.
20947 When optional INDENT argument is non-nil, call
20948 `newline-and-indent' instead of `newline'.
20950 When `org-return-follows-link' is non-nil and point is on
20951 a timestamp or a link, call `org-open-at-point'. However, it
20952 will not happen if point is in a table or on a \"dead\"
20953 object (e.g., within a comment). In these case, you need to use
20954 `org-open-at-point' directly."
20955 (interactive)
20956 (if (and (save-excursion
20957 (beginning-of-line)
20958 (looking-at org-todo-line-regexp))
20959 (match-beginning 3)
20960 (>= (point) (match-beginning 3)))
20961 ;; Point is on headline tags. Do not break them: add a newline
20962 ;; after the headline instead.
20963 (progn (org-show-entry)
20964 (end-of-line)
20965 (if indent (newline-and-indent) (newline)))
20966 (let* ((context (if org-return-follows-link (org-element-context)
20967 (org-element-at-point)))
20968 (type (org-element-type context)))
20969 (cond
20970 ;; In a table, call `org-table-next-row'.
20971 ((or (and (eq type 'table)
20972 (>= (point) (org-element-property :contents-begin context))
20973 (< (point) (org-element-property :contents-end context)))
20974 (org-element-lineage context '(table-row table-cell) t))
20975 (org-table-justify-field-maybe)
20976 (call-interactively #'org-table-next-row))
20977 ;; On a link or a timestamp but not on white spaces after it,
20978 ;; call `org-open-line' if `org-return-follows-link' allows it.
20979 ((and org-return-follows-link
20980 (memq type '(link timestamp))
20981 (< (point)
20982 (save-excursion (goto-char (org-element-property :end context))
20983 (skip-chars-backward " \t")
20984 (point))))
20985 (call-interactively #'org-open-at-point))
20986 ;; In a list, make sure indenting keeps trailing text within.
20987 ((and indent
20988 (not (eolp))
20989 (org-element-lineage context '(item plain-list) t))
20990 (let ((trailing-data
20991 (delete-and-extract-region (point) (line-end-position))))
20992 (newline-and-indent)
20993 (save-excursion (insert trailing-data))))
20994 (t (if indent (newline-and-indent) (newline)))))))
20996 (defun org-return-indent ()
20997 "Goto next table row or insert a newline and indent.
20998 Calls `org-table-next-row' or `newline-and-indent', depending on
20999 context. See the individual commands for more information."
21000 (interactive)
21001 (org-return t))
21003 (defun org-ctrl-c-star ()
21004 "Compute table, or change heading status of lines.
21005 Calls `org-table-recalculate' or `org-toggle-heading',
21006 depending on context."
21007 (interactive)
21008 (cond
21009 ((org-at-table-p)
21010 (call-interactively 'org-table-recalculate))
21012 ;; Convert all lines in region to list items
21013 (call-interactively 'org-toggle-heading))))
21015 (defun org-ctrl-c-minus ()
21016 "Insert separator line in table or modify bullet status of line.
21017 Also turns a plain line or a region of lines into list items.
21018 Calls `org-table-insert-hline', `org-toggle-item', or
21019 `org-cycle-list-bullet', depending on context."
21020 (interactive)
21021 (cond
21022 ((org-at-table-p)
21023 (call-interactively 'org-table-insert-hline))
21024 ((org-region-active-p)
21025 (call-interactively 'org-toggle-item))
21026 ((org-in-item-p)
21027 (call-interactively 'org-cycle-list-bullet))
21029 (call-interactively 'org-toggle-item))))
21031 (defun org-toggle-item (arg)
21032 "Convert headings or normal lines to items, items to normal lines.
21033 If there is no active region, only the current line is considered.
21035 If the first non blank line in the region is a headline, convert
21036 all headlines to items, shifting text accordingly.
21038 If it is an item, convert all items to normal lines.
21040 If it is normal text, change region into a list of items.
21041 With a prefix argument ARG, change the region in a single item."
21042 (interactive "P")
21043 (let ((shift-text
21044 (function
21045 ;; Shift text in current section to IND, from point to END.
21046 ;; The function leaves point to END line.
21047 (lambda (ind end)
21048 (let ((min-i 1000) (end (copy-marker end)))
21049 ;; First determine the minimum indentation (MIN-I) of
21050 ;; the text.
21051 (save-excursion
21052 (catch 'exit
21053 (while (< (point) end)
21054 (let ((i (org-get-indentation)))
21055 (cond
21056 ;; Skip blank lines and inline tasks.
21057 ((looking-at "^[ \t]*$"))
21058 ((looking-at org-outline-regexp-bol))
21059 ;; We can't find less than 0 indentation.
21060 ((zerop i) (throw 'exit (setq min-i 0)))
21061 ((< i min-i) (setq min-i i))))
21062 (forward-line))))
21063 ;; Then indent each line so that a line indented to
21064 ;; MIN-I becomes indented to IND. Ignore blank lines
21065 ;; and inline tasks in the process.
21066 (let ((delta (- ind min-i)))
21067 (while (< (point) end)
21068 (unless (or (looking-at "^[ \t]*$")
21069 (looking-at org-outline-regexp-bol))
21070 (org-indent-line-to (+ (org-get-indentation) delta)))
21071 (forward-line)))))))
21072 (skip-blanks
21073 (function
21074 ;; Return beginning of first non-blank line, starting from
21075 ;; line at POS.
21076 (lambda (pos)
21077 (save-excursion
21078 (goto-char pos)
21079 (skip-chars-forward " \r\t\n")
21080 (point-at-bol)))))
21081 beg end)
21082 ;; Determine boundaries of changes.
21083 (if (org-region-active-p)
21084 (setq beg (funcall skip-blanks (region-beginning))
21085 end (copy-marker (region-end)))
21086 (setq beg (funcall skip-blanks (point-at-bol))
21087 end (copy-marker (point-at-eol))))
21088 ;; Depending on the starting line, choose an action on the text
21089 ;; between BEG and END.
21090 (org-with-limited-levels
21091 (save-excursion
21092 (goto-char beg)
21093 (cond
21094 ;; Case 1. Start at an item: de-itemize. Note that it only
21095 ;; happens when a region is active: `org-ctrl-c-minus'
21096 ;; would call `org-cycle-list-bullet' otherwise.
21097 ((org-at-item-p)
21098 (while (< (point) end)
21099 (when (org-at-item-p)
21100 (skip-chars-forward " \t")
21101 (delete-region (point) (match-end 0)))
21102 (forward-line)))
21103 ;; Case 2. Start at an heading: convert to items.
21104 ((org-at-heading-p)
21105 (let* ((bul (org-list-bullet-string "-"))
21106 (bul-len (length bul))
21107 (done (org-entry-is-done-p))
21108 (todo (org-entry-is-todo-p))
21109 ;; Indentation of the first heading. It should be
21110 ;; relative to the indentation of its parent, if any.
21111 (start-ind (save-excursion
21112 (cond
21113 ((not org-adapt-indentation) 0)
21114 ((not (outline-previous-heading)) 0)
21115 (t (length (match-string 0))))))
21116 ;; Level of first heading. Further headings will be
21117 ;; compared to it to determine hierarchy in the list.
21118 (ref-level (org-reduced-level (org-outline-level))))
21119 (when (or done todo) (org-todo ""))
21120 (while (< (point) end)
21121 (let* ((level (org-reduced-level (org-outline-level)))
21122 (delta (max 0 (- level ref-level))))
21123 ;; If current headline is less indented than the first
21124 ;; one, set it as reference, in order to preserve
21125 ;; subtrees.
21126 (when (< level ref-level) (setq ref-level level))
21127 (replace-match bul t t)
21128 (org-indent-line-to (+ start-ind (* delta bul-len)))
21129 (when (or done todo)
21130 (let* ((struct (org-list-struct))
21131 (old (copy-tree struct)))
21132 (org-list-set-checkbox (line-beginning-position)
21133 struct
21134 (if done "[X]" "[ ]"))
21135 (org-list-write-struct struct
21136 (org-list-parents-alist struct)
21137 old)))
21138 ;; Ensure all text down to END (or SECTION-END) belongs
21139 ;; to the newly created item.
21140 (let ((section-end (save-excursion
21141 (or (outline-next-heading) (point)))))
21142 (forward-line)
21143 (funcall shift-text
21144 (+ start-ind (* (1+ delta) bul-len))
21145 (min end section-end)))))))
21146 ;; Case 3. Normal line with ARG: make the first line of region
21147 ;; an item, and shift indentation of others lines to
21148 ;; set them as item's body.
21149 (arg (let* ((bul (org-list-bullet-string "-"))
21150 (bul-len (length bul))
21151 (ref-ind (org-get-indentation)))
21152 (skip-chars-forward " \t")
21153 (insert bul)
21154 (forward-line)
21155 (while (< (point) end)
21156 ;; Ensure that lines less indented than first one
21157 ;; still get included in item body.
21158 (funcall shift-text
21159 (+ ref-ind bul-len)
21160 (min end (save-excursion (or (outline-next-heading)
21161 (point)))))
21162 (forward-line))))
21163 ;; Case 4. Normal line without ARG: turn each non-item line
21164 ;; into an item.
21166 (while (< (point) end)
21167 (unless (or (org-at-heading-p) (org-at-item-p))
21168 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21169 (replace-match
21170 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21171 (forward-line))))))))
21173 (defun org-toggle-heading (&optional nstars)
21174 "Convert headings to normal text, or items or text to headings.
21175 If there is no active region, only convert the current line.
21177 With a \\[universal-argument] prefix, convert the whole list at
21178 point into heading.
21180 In a region:
21182 - If the first non blank line is a headline, remove the stars
21183 from all headlines in the region.
21185 - If it is a normal line, turn each and every normal line (i.e.,
21186 not an heading or an item) in the region into headings. If you
21187 want to convert only the first line of this region, use one
21188 universal prefix argument.
21190 - If it is a plain list item, turn all plain list items into headings.
21192 When converting a line into a heading, the number of stars is chosen
21193 such that the lines become children of the current entry. However,
21194 when a numeric prefix argument is given, its value determines the
21195 number of stars to add."
21196 (interactive "P")
21197 (let ((skip-blanks
21198 (function
21199 ;; Return beginning of first non-blank line, starting from
21200 ;; line at POS.
21201 (lambda (pos)
21202 (save-excursion
21203 (goto-char pos)
21204 (while (org-at-comment-p) (forward-line))
21205 (skip-chars-forward " \r\t\n")
21206 (point-at-bol)))))
21207 beg end toggled)
21208 ;; Determine boundaries of changes. If a universal prefix has
21209 ;; been given, put the list in a region. If region ends at a bol,
21210 ;; do not consider the last line to be in the region.
21212 (when (and current-prefix-arg (org-at-item-p))
21213 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21214 (org-mark-element))
21216 (if (org-region-active-p)
21217 (setq beg (funcall skip-blanks (region-beginning))
21218 end (copy-marker (save-excursion
21219 (goto-char (region-end))
21220 (if (bolp) (point) (point-at-eol)))))
21221 (setq beg (funcall skip-blanks (point-at-bol))
21222 end (copy-marker (point-at-eol))))
21223 ;; Ensure inline tasks don't count as headings.
21224 (org-with-limited-levels
21225 (save-excursion
21226 (goto-char beg)
21227 (cond
21228 ;; Case 1. Started at an heading: de-star headings.
21229 ((org-at-heading-p)
21230 (while (< (point) end)
21231 (when (org-at-heading-p t)
21232 (looking-at org-outline-regexp) (replace-match "")
21233 (setq toggled t))
21234 (forward-line)))
21235 ;; Case 2. Started at an item: change items into headlines.
21236 ;; One star will be added by `org-list-to-subtree'.
21237 ((org-at-item-p)
21238 (while (< (point) end)
21239 (when (org-at-item-p)
21240 ;; Pay attention to cases when region ends before list.
21241 (let* ((struct (org-list-struct))
21242 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21243 (save-restriction
21244 (narrow-to-region (point) list-end)
21245 (insert (org-list-to-subtree (org-list-parse-list t)))))
21246 (setq toggled t))
21247 (forward-line)))
21248 ;; Case 3. Started at normal text: make every line an heading,
21249 ;; skipping headlines and items.
21250 (t (let* ((stars
21251 (make-string
21252 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21253 (add-stars
21254 (cond (nstars "") ; stars from prefix only
21255 ((equal stars "") "*") ; before first heading
21256 (org-odd-levels-only "**") ; inside heading, odd
21257 (t "*"))) ; inside heading, oddeven
21258 (rpl (concat stars add-stars " "))
21259 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21260 (while (< (point) (if (equal nstars '(4)) lend end))
21261 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21262 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21263 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21264 (forward-line)))))))
21265 (unless toggled (message "Cannot toggle heading from here"))))
21267 (defun org-meta-return (&optional arg)
21268 "Insert a new heading or wrap a region in a table.
21269 Calls `org-insert-heading' or `org-table-wrap-region', depending
21270 on context. See the individual commands for more information."
21271 (interactive "P")
21272 (org-check-before-invisible-edit 'insert)
21273 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21274 (let* ((element (org-element-at-point))
21275 (type (org-element-type element)))
21276 (when (eq type 'table-row)
21277 (setq element (org-element-property :parent element))
21278 (setq type 'table))
21279 (if (and (eq type 'table)
21280 (eq (org-element-property :type element) 'org)
21281 (>= (point) (org-element-property :contents-begin element))
21282 (< (point) (org-element-property :contents-end element)))
21283 (call-interactively 'org-table-wrap-region)
21284 (call-interactively 'org-insert-heading)))))
21286 ;;; Menu entries
21288 (defsubst org-in-subtree-not-table-p ()
21289 "Are we in a subtree and not in a table?"
21290 (and (not (org-before-first-heading-p))
21291 (not (org-at-table-p))))
21293 ;; Define the Org-mode menus
21294 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21295 '("Tbl"
21296 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21297 ["Next Field" org-cycle (org-at-table-p)]
21298 ["Previous Field" org-shifttab (org-at-table-p)]
21299 ["Next Row" org-return (org-at-table-p)]
21300 "--"
21301 ["Blank Field" org-table-blank-field (org-at-table-p)]
21302 ["Edit Field" org-table-edit-field (org-at-table-p)]
21303 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21304 "--"
21305 ("Column"
21306 ["Move Column Left" org-metaleft (org-at-table-p)]
21307 ["Move Column Right" org-metaright (org-at-table-p)]
21308 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21309 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21310 ("Row"
21311 ["Move Row Up" org-metaup (org-at-table-p)]
21312 ["Move Row Down" org-metadown (org-at-table-p)]
21313 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21314 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21315 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21316 "--"
21317 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21318 ("Rectangle"
21319 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21320 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21321 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21322 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21323 "--"
21324 ("Calculate"
21325 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21326 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21327 ["Edit Formulas" org-edit-special (org-at-table-p)]
21328 "--"
21329 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21330 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21331 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21332 "--"
21333 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21334 "--"
21335 ["Sum Column/Rectangle" org-table-sum
21336 (or (org-at-table-p) (org-region-active-p))]
21337 ["Which Column?" org-table-current-column (org-at-table-p)])
21338 ["Debug Formulas"
21339 org-table-toggle-formula-debugger
21340 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21341 ["Show Col/Row Numbers"
21342 org-table-toggle-coordinate-overlays
21343 :style toggle
21344 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21345 "--"
21346 ["Create" org-table-create (and (not (org-at-table-p))
21347 org-enable-table-editor)]
21348 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21349 ["Import from File" org-table-import (not (org-at-table-p))]
21350 ["Export to File" org-table-export (org-at-table-p)]
21351 "--"
21352 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21353 "--"
21354 ("Plot"
21355 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21356 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21358 (easy-menu-define org-org-menu org-mode-map "Org menu"
21359 '("Org"
21360 ("Show/Hide"
21361 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21362 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21363 ["Sparse Tree..." org-sparse-tree t]
21364 ["Reveal Context" org-reveal t]
21365 ["Show All" show-all t]
21366 "--"
21367 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21368 "--"
21369 ["New Heading" org-insert-heading t]
21370 ("Navigate Headings"
21371 ["Up" outline-up-heading t]
21372 ["Next" outline-next-visible-heading t]
21373 ["Previous" outline-previous-visible-heading t]
21374 ["Next Same Level" outline-forward-same-level t]
21375 ["Previous Same Level" outline-backward-same-level t]
21376 "--"
21377 ["Jump" org-goto t])
21378 ("Edit Structure"
21379 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21380 "--"
21381 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21382 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21383 "--"
21384 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21385 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21386 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21387 "--"
21388 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21389 "--"
21390 ["Copy visible text" org-copy-visible t]
21391 "--"
21392 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21393 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21394 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21395 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21396 "--"
21397 ["Sort Region/Children" org-sort t]
21398 "--"
21399 ["Convert to odd levels" org-convert-to-odd-levels t]
21400 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21401 ("Editing"
21402 ["Emphasis..." org-emphasize t]
21403 ["Edit Source Example" org-edit-special t]
21404 "--"
21405 ["Footnote new/jump" org-footnote-action t]
21406 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21407 ("Archive"
21408 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21409 "--"
21410 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21411 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21412 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21414 "--"
21415 ("Hyperlinks"
21416 ["Store Link (Global)" org-store-link t]
21417 ["Find existing link to here" org-occur-link-in-agenda-files t]
21418 ["Insert Link" org-insert-link t]
21419 ["Follow Link" org-open-at-point t]
21420 "--"
21421 ["Next link" org-next-link t]
21422 ["Previous link" org-previous-link t]
21423 "--"
21424 ["Descriptive Links"
21425 org-toggle-link-display
21426 :style radio
21427 :selected org-descriptive-links
21429 ["Literal Links"
21430 org-toggle-link-display
21431 :style radio
21432 :selected (not org-descriptive-links)])
21433 "--"
21434 ("TODO Lists"
21435 ["TODO/DONE/-" org-todo t]
21436 ("Select keyword"
21437 ["Next keyword" org-shiftright (org-at-heading-p)]
21438 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21439 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21440 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21441 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21442 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21443 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21444 "--"
21445 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21446 :selected org-enforce-todo-dependencies :style toggle :active t]
21447 "Settings for tree at point"
21448 ["Do Children sequentially" org-toggle-ordered-property :style radio
21449 :selected (org-entry-get nil "ORDERED")
21450 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21451 ["Do Children parallel" org-toggle-ordered-property :style radio
21452 :selected (not (org-entry-get nil "ORDERED"))
21453 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21454 "--"
21455 ["Set Priority" org-priority t]
21456 ["Priority Up" org-shiftup t]
21457 ["Priority Down" org-shiftdown t]
21458 "--"
21459 ["Get news from all feeds" org-feed-update-all t]
21460 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21461 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21462 ("TAGS and Properties"
21463 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21464 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21465 "--"
21466 ["Set property" org-set-property (not (org-before-first-heading-p))]
21467 ["Column view of properties" org-columns t]
21468 ["Insert Column View DBlock" org-insert-columns-dblock t])
21469 ("Dates and Scheduling"
21470 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21471 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21472 ("Change Date"
21473 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21474 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21475 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21476 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21477 ["Compute Time Range" org-evaluate-time-range t]
21478 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21479 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21480 "--"
21481 ["Custom time format" org-toggle-time-stamp-overlays
21482 :style radio :selected org-display-custom-times]
21483 "--"
21484 ["Goto Calendar" org-goto-calendar t]
21485 ["Date from Calendar" org-date-from-calendar t]
21486 "--"
21487 ["Start/Restart Timer" org-timer-start t]
21488 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21489 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21490 ["Insert Timer String" org-timer t]
21491 ["Insert Timer Item" org-timer-item t])
21492 ("Logging work"
21493 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21494 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21495 ["Clock out" org-clock-out t]
21496 ["Clock cancel" org-clock-cancel t]
21497 "--"
21498 ["Mark as default task" org-clock-mark-default-task t]
21499 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21500 ["Goto running clock" org-clock-goto t]
21501 "--"
21502 ["Display times" org-clock-display t]
21503 ["Create clock table" org-clock-report t]
21504 "--"
21505 ["Record DONE time"
21506 (progn (setq org-log-done (not org-log-done))
21507 (message "Switching to %s will %s record a timestamp"
21508 (car org-done-keywords)
21509 (if org-log-done "automatically" "not")))
21510 :style toggle :selected org-log-done])
21511 "--"
21512 ["Agenda Command..." org-agenda t]
21513 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21514 ("File List for Agenda")
21515 ("Special views current file"
21516 ["TODO Tree" org-show-todo-tree t]
21517 ["Check Deadlines" org-check-deadlines t]
21518 ["Timeline" org-timeline t]
21519 ["Tags/Property tree" org-match-sparse-tree t])
21520 "--"
21521 ["Export/Publish..." org-export-dispatch t]
21522 ("LaTeX"
21523 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21524 :selected org-cdlatex-mode]
21525 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21526 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21527 ["Modify math symbol" org-cdlatex-math-modify
21528 (org-inside-LaTeX-fragment-p)]
21529 ["Insert citation" org-reftex-citation t]
21530 "--"
21531 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21532 "--"
21533 ("MobileOrg"
21534 ["Push Files and Views" org-mobile-push t]
21535 ["Get Captured and Flagged" org-mobile-pull t]
21536 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21537 "--"
21538 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21539 "--"
21540 ("Documentation"
21541 ["Show Version" org-version t]
21542 ["Info Documentation" org-info t])
21543 ("Customize"
21544 ["Browse Org Group" org-customize t]
21545 "--"
21546 ["Expand This Menu" org-create-customize-menu
21547 (fboundp 'customize-menu-create)])
21548 ["Send bug report" org-submit-bug-report t]
21549 "--"
21550 ("Refresh/Reload"
21551 ["Refresh setup current buffer" org-mode-restart t]
21552 ["Reload Org (after update)" org-reload t]
21553 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21556 (defun org-info (&optional node)
21557 "Read documentation for Org-mode in the info system.
21558 With optional NODE, go directly to that node."
21559 (interactive)
21560 (info (format "(org)%s" (or node ""))))
21562 ;;;###autoload
21563 (defun org-submit-bug-report ()
21564 "Submit a bug report on Org-mode via mail.
21566 Don't hesitate to report any problems or inaccurate documentation.
21568 If you don't have setup sending mail from (X)Emacs, please copy the
21569 output buffer into your mail program, as it gives us important
21570 information about your Org-mode version and configuration."
21571 (interactive)
21572 (require 'reporter)
21573 (org-load-modules-maybe)
21574 (org-require-autoloaded-modules)
21575 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21576 (reporter-submit-bug-report
21577 "emacs-orgmode@gnu.org"
21578 (org-version nil 'full)
21579 (let (list)
21580 (save-window-excursion
21581 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21582 (delete-other-windows)
21583 (erase-buffer)
21584 (insert "You are about to submit a bug report to the Org-mode mailing list.
21586 We would like to add your full Org-mode and Outline configuration to the
21587 bug report. This greatly simplifies the work of the maintainer and
21588 other experts on the mailing list.
21590 HOWEVER, some variables you have customized may contain private
21591 information. The names of customers, colleagues, or friends, might
21592 appear in the form of file names, tags, todo states, or search strings.
21593 If you answer yes to the prompt, you might want to check and remove
21594 such private information before sending the email.")
21595 (add-text-properties (point-min) (point-max) '(face org-warning))
21596 (when (yes-or-no-p "Include your Org-mode configuration ")
21597 (mapatoms
21598 (lambda (v)
21599 (and (boundp v)
21600 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21601 (or (and (symbol-value v)
21602 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21603 (and
21604 (get v 'custom-type) (get v 'standard-value)
21605 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21606 (push v list)))))
21607 (kill-buffer (get-buffer "*Warn about privacy*"))
21608 list))
21609 nil nil
21610 "Remember to cover the basics, that is, what you expected to happen and
21611 what in fact did happen. You don't know how to make a good report? See
21613 http://orgmode.org/manual/Feedback.html#Feedback
21615 Your bug report will be posted to the Org-mode mailing list.
21616 ------------------------------------------------------------------------")
21617 (save-excursion
21618 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21619 (replace-match "\\1Bug: \\3 [\\2]")))))
21622 (defun org-install-agenda-files-menu ()
21623 (let ((bl (buffer-list)))
21624 (save-excursion
21625 (while bl
21626 (set-buffer (pop bl))
21627 (if (derived-mode-p 'org-mode) (setq bl nil)))
21628 (when (derived-mode-p 'org-mode)
21629 (easy-menu-change
21630 '("Org") "File List for Agenda"
21631 (append
21632 (list
21633 ["Edit File List" (org-edit-agenda-file-list) t]
21634 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21635 ["Remove Current File from List" org-remove-file t]
21636 ["Cycle through agenda files" org-cycle-agenda-files t]
21637 ["Occur in all agenda files" org-occur-in-agenda-files t]
21638 "--")
21639 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21641 ;;;; Documentation
21643 (defun org-require-autoloaded-modules ()
21644 (interactive)
21645 (mapc 'require
21646 '(org-agenda org-archive org-attach org-clock org-colview org-id
21647 org-table org-timer)))
21649 ;;;###autoload
21650 (defun org-reload (&optional uncompiled)
21651 "Reload all org lisp files.
21652 With prefix arg UNCOMPILED, load the uncompiled versions."
21653 (interactive "P")
21654 (require 'loadhist)
21655 (let* ((org-dir (org-find-library-dir "org"))
21656 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21657 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21658 (remove-re (mapconcat 'identity
21659 (mapcar (lambda (f) (concat "^" f "$"))
21660 (list (if (featurep 'xemacs)
21661 "org-colview"
21662 "org-colview-xemacs")
21663 "org" "org-loaddefs" "org-version"))
21664 "\\|"))
21665 (feats (delete-dups
21666 (mapcar 'file-name-sans-extension
21667 (mapcar 'file-name-nondirectory
21668 (delq nil
21669 (mapcar 'feature-file
21670 features))))))
21671 (lfeat (append
21672 (sort
21673 (setq feats
21674 (delq nil (mapcar
21675 (lambda (f)
21676 (if (and (string-match feature-re f)
21677 (not (string-match remove-re f)))
21678 f nil))
21679 feats)))
21680 'string-lessp)
21681 (list "org-version" "org")))
21682 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21683 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21684 load-uncore load-misses)
21685 (setq load-misses
21686 (delq 't
21687 (mapcar (lambda (f)
21688 (or (org-load-noerror-mustsuffix (concat org-dir f))
21689 (and (string= org-dir contrib-dir)
21690 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21691 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21692 (add-to-list 'load-uncore f 'append)
21695 lfeat)))
21696 (if load-uncore
21697 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21698 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21699 (if load-misses
21700 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21701 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21702 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21704 ;;;###autoload
21705 (defun org-customize ()
21706 "Call the customize function with org as argument."
21707 (interactive)
21708 (org-load-modules-maybe)
21709 (org-require-autoloaded-modules)
21710 (customize-browse 'org))
21712 (defun org-create-customize-menu ()
21713 "Create a full customization menu for Org-mode, insert it into the menu."
21714 (interactive)
21715 (org-load-modules-maybe)
21716 (org-require-autoloaded-modules)
21717 (if (fboundp 'customize-menu-create)
21718 (progn
21719 (easy-menu-change
21720 '("Org") "Customize"
21721 `(["Browse Org group" org-customize t]
21722 "--"
21723 ,(customize-menu-create 'org)
21724 ["Set" Custom-set t]
21725 ["Save" Custom-save t]
21726 ["Reset to Current" Custom-reset-current t]
21727 ["Reset to Saved" Custom-reset-saved t]
21728 ["Reset to Standard Settings" Custom-reset-standard t]))
21729 (message "\"Org\"-menu now contains full customization menu"))
21730 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21732 ;;;; Miscellaneous stuff
21734 ;;; Generally useful functions
21736 (defsubst org-get-at-eol (property n)
21737 "Get text property PROPERTY at the end of line less N characters."
21738 (get-text-property (- (point-at-eol) n) property))
21740 (defun org-find-text-property-in-string (prop s)
21741 "Return the first non-nil value of property PROP in string S."
21742 (or (get-text-property 0 prop s)
21743 (get-text-property (or (next-single-property-change 0 prop s) 0)
21744 prop s)))
21746 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21747 "Display the given MESSAGE as a warning."
21748 (if (fboundp 'display-warning)
21749 (display-warning 'org message
21750 (if (featurep 'xemacs) 'warning :warning))
21751 (let ((buf (get-buffer-create "*Org warnings*")))
21752 (with-current-buffer buf
21753 (goto-char (point-max))
21754 (insert "Warning (Org): " message)
21755 (unless (bolp)
21756 (newline)))
21757 (display-buffer buf)
21758 (sit-for 0))))
21760 (defun org-eval (form)
21761 "Eval FORM and return result."
21762 (condition-case error
21763 (eval form)
21764 (error (format "%%![Error: %s]" error))))
21766 (defun org-in-clocktable-p ()
21767 "Check if the cursor is in a clocktable."
21768 (let ((pos (point)) start)
21769 (save-excursion
21770 (end-of-line 1)
21771 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21772 (setq start (match-beginning 0))
21773 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21774 (>= (match-end 0) pos)
21775 start))))
21777 (defun org-in-verbatim-emphasis ()
21778 (save-match-data
21779 (and (org-in-regexp org-emph-re 2)
21780 (>= (point) (match-beginning 3))
21781 (<= (point) (match-end 4))
21782 (member (match-string 3) '("=" "~")))))
21784 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21785 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21786 (if (and marker (marker-buffer marker)
21787 (buffer-live-p (marker-buffer marker)))
21788 (progn
21789 (org-pop-to-buffer-same-window (marker-buffer marker))
21790 (if (or (> marker (point-max)) (< marker (point-min)))
21791 (widen))
21792 (goto-char marker)
21793 (org-show-context 'org-goto))
21794 (if bookmark
21795 (bookmark-jump bookmark)
21796 (error "Cannot find location"))))
21798 (defun org-quote-csv-field (s)
21799 "Quote field for inclusion in CSV material."
21800 (if (string-match "[\",]" s)
21801 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21804 (defun org-force-self-insert (N)
21805 "Needed to enforce self-insert under remapping."
21806 (interactive "p")
21807 (self-insert-command N))
21809 (defun org-string-width (s)
21810 "Compute width of string, ignoring invisible characters.
21811 This ignores character with invisibility property `org-link', and also
21812 characters with property `org-cwidth', because these will become invisible
21813 upon the next fontification round."
21814 (let (b l)
21815 (when (or (eq t buffer-invisibility-spec)
21816 (assq 'org-link buffer-invisibility-spec))
21817 (while (setq b (text-property-any 0 (length s)
21818 'invisible 'org-link s))
21819 (setq s (concat (substring s 0 b)
21820 (substring s (or (next-single-property-change
21821 b 'invisible s) (length s)))))))
21822 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21823 (setq s (concat (substring s 0 b)
21824 (substring s (or (next-single-property-change
21825 b 'org-cwidth s) (length s))))))
21826 (setq l (string-width s) b -1)
21827 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21828 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21831 (defun org-shorten-string (s maxlength)
21832 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21833 If the string is shorter or has length MAXLENGTH, just return the
21834 original string. If it is longer, the functions finds a space in the
21835 string, breaks this string off at that locations and adds three dots
21836 as ellipsis. Including the ellipsis, the string will not be longer
21837 than MAXLENGTH. If finding a good breaking point in the string does
21838 not work, the string is just chopped off in the middle of a word
21839 if necessary."
21840 (if (<= (length s) maxlength)
21842 (let* ((n (max (- maxlength 4) 1))
21843 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21844 (if (string-match re s)
21845 (concat (match-string 1 s) "...")
21846 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21848 (defun org-get-indentation (&optional line)
21849 "Get the indentation of the current line, interpreting tabs.
21850 When LINE is given, assume it represents a line and compute its indentation."
21851 (if line
21852 (if (string-match "^ *" (org-remove-tabs line))
21853 (match-end 0))
21854 (save-excursion
21855 (beginning-of-line 1)
21856 (skip-chars-forward " \t")
21857 (current-column))))
21859 (defun org-get-string-indentation (s)
21860 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21861 (let ((n -1) (i 0) (w tab-width) c)
21862 (catch 'exit
21863 (while (< (setq n (1+ n)) (length s))
21864 (setq c (aref s n))
21865 (cond ((= c ?\ ) (setq i (1+ i)))
21866 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21867 (t (throw 'exit t)))))
21870 (defun org-remove-tabs (s &optional width)
21871 "Replace tabulators in S with spaces.
21872 Assumes that s is a single line, starting in column 0."
21873 (setq width (or width tab-width))
21874 (while (string-match "\t" s)
21875 (setq s (replace-match
21876 (make-string
21877 (- (* width (/ (+ (match-beginning 0) width) width))
21878 (match-beginning 0)) ?\ )
21879 t t s)))
21882 (defun org-fix-indentation (line ind)
21883 "Fix indentation in LINE.
21884 IND is a cons cell with target and minimum indentation.
21885 If the current indentation in LINE is smaller than the minimum,
21886 leave it alone. If it is larger than ind, set it to the target."
21887 (let* ((l (org-remove-tabs line))
21888 (i (org-get-indentation l))
21889 (i1 (car ind)) (i2 (cdr ind)))
21890 (if (>= i i2) (setq l (substring line i2)))
21891 (if (> i1 0)
21892 (concat (make-string i1 ?\ ) l)
21893 l)))
21895 (defun org-remove-indentation (code &optional n)
21896 "Remove the maximum common indentation from the lines in CODE.
21897 N may optionally be the number of spaces to remove."
21898 (with-temp-buffer
21899 (insert code)
21900 (org-do-remove-indentation n)
21901 (buffer-string)))
21903 (defun org-do-remove-indentation (&optional n)
21904 "Remove the maximum common indentation from the buffer."
21905 (untabify (point-min) (point-max))
21906 (let ((min 10000) re)
21907 (if n
21908 (setq min n)
21909 (goto-char (point-min))
21910 (while (re-search-forward "^ *[^ \n]" nil t)
21911 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21912 (unless (or (= min 0) (= min 10000))
21913 (setq re (format "^ \\{%d\\}" min))
21914 (goto-char (point-min))
21915 (while (re-search-forward re nil t)
21916 (replace-match "")
21917 (end-of-line 1))
21918 min)))
21920 (defun org-fill-template (template alist)
21921 "Find each %key of ALIST in TEMPLATE and replace it."
21922 (let ((case-fold-search nil)
21923 entry key value)
21924 (setq alist (sort (copy-sequence alist)
21925 (lambda (a b) (< (length (car a)) (length (car b))))))
21926 (while (setq entry (pop alist))
21927 (setq template
21928 (replace-regexp-in-string
21929 (concat "%" (regexp-quote (car entry)))
21930 (or (cdr entry) "") template t t)))
21931 template))
21933 (defun org-base-buffer (buffer)
21934 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21935 (if (not buffer)
21936 buffer
21937 (or (buffer-base-buffer buffer)
21938 buffer)))
21940 (defun org-wrap (string &optional width lines)
21941 "Wrap string to either a number of lines, or a width in characters.
21942 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21943 that costs. If there is a word longer than WIDTH, the text is actually
21944 wrapped to the length of that word.
21945 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21946 many lines, whatever width that takes.
21947 The return value is a list of lines, without newlines at the end."
21948 (let* ((words (org-split-string string "[ \t\n]+"))
21949 (maxword (apply 'max (mapcar 'org-string-width words)))
21950 w ll)
21951 (cond (width
21952 (org-do-wrap words (max maxword width)))
21953 (lines
21954 (setq w maxword)
21955 (setq ll (org-do-wrap words maxword))
21956 (if (<= (length ll) lines)
21958 (setq ll words)
21959 (while (> (length ll) lines)
21960 (setq w (1+ w))
21961 (setq ll (org-do-wrap words w)))
21962 ll))
21963 (t (error "Cannot wrap this")))))
21965 (defun org-do-wrap (words width)
21966 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21967 (let (lines line)
21968 (while words
21969 (setq line (pop words))
21970 (while (and words (< (+ (length line) (length (car words))) width))
21971 (setq line (concat line " " (pop words))))
21972 (setq lines (push line lines)))
21973 (nreverse lines)))
21975 (defun org-split-string (string &optional separators)
21976 "Splits STRING into substrings at SEPARATORS.
21977 No empty strings are returned if there are matches at the beginning
21978 and end of string."
21979 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21980 (start 0)
21981 notfirst
21982 (list nil))
21983 (while (and (string-match rexp string
21984 (if (and notfirst
21985 (= start (match-beginning 0))
21986 (< start (length string)))
21987 (1+ start) start))
21988 (< (match-beginning 0) (length string)))
21989 (setq notfirst t)
21990 (or (eq (match-beginning 0) 0)
21991 (and (eq (match-beginning 0) (match-end 0))
21992 (eq (match-beginning 0) start))
21993 (setq list
21994 (cons (substring string start (match-beginning 0))
21995 list)))
21996 (setq start (match-end 0)))
21997 (or (eq start (length string))
21998 (setq list
21999 (cons (substring string start)
22000 list)))
22001 (nreverse list)))
22003 (defun org-quote-vert (s)
22004 "Replace \"|\" with \"\\vert\"."
22005 (while (string-match "|" s)
22006 (setq s (replace-match "\\vert" t t s)))
22009 (defun org-uuidgen-p (s)
22010 "Is S an ID created by UUIDGEN?"
22011 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22013 (defun org-in-src-block-p (&optional inside)
22014 "Whether point is in a code source block.
22015 When INSIDE is non-nil, don't consider we are within a src block
22016 when point is at #+BEGIN_SRC or #+END_SRC."
22017 (let ((case-fold-search t) ov)
22018 (or (and (eq (get-char-property (point) 'src-block) t))
22019 (and (not inside)
22020 (save-match-data
22021 (save-excursion
22022 (beginning-of-line)
22023 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22025 (defun org-context ()
22026 "Return a list of contexts of the current cursor position.
22027 If several contexts apply, all are returned.
22028 Each context entry is a list with a symbol naming the context, and
22029 two positions indicating start and end of the context. Possible
22030 contexts are:
22032 :headline anywhere in a headline
22033 :headline-stars on the leading stars in a headline
22034 :todo-keyword on a TODO keyword (including DONE) in a headline
22035 :tags on the TAGS in a headline
22036 :priority on the priority cookie in a headline
22037 :item on the first line of a plain list item
22038 :item-bullet on the bullet/number of a plain list item
22039 :checkbox on the checkbox in a plain list item
22040 :table in an org-mode table
22041 :table-special on a special filed in a table
22042 :table-table in a table.el table
22043 :clocktable in a clocktable
22044 :src-block in a source block
22045 :link on a hyperlink
22046 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22047 :target on a <<target>>
22048 :radio-target on a <<<radio-target>>>
22049 :latex-fragment on a LaTeX fragment
22050 :latex-preview on a LaTeX fragment with overlaid preview image
22052 This function expects the position to be visible because it uses font-lock
22053 faces as a help to recognize the following contexts: :table-special, :link,
22054 and :keyword."
22055 (let* ((f (get-text-property (point) 'face))
22056 (faces (if (listp f) f (list f)))
22057 (case-fold-search t)
22058 (p (point)) clist o)
22059 ;; First the large context
22060 (cond
22061 ((org-at-heading-p t)
22062 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22063 (when (progn
22064 (beginning-of-line 1)
22065 (looking-at org-todo-line-tags-regexp))
22066 (push (org-point-in-group p 1 :headline-stars) clist)
22067 (push (org-point-in-group p 2 :todo-keyword) clist)
22068 (push (org-point-in-group p 4 :tags) clist))
22069 (goto-char p)
22070 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22071 (if (looking-at "\\[#[A-Z0-9]\\]")
22072 (push (org-point-in-group p 0 :priority) clist)))
22074 ((org-at-item-p)
22075 (push (org-point-in-group p 2 :item-bullet) clist)
22076 (push (list :item (point-at-bol)
22077 (save-excursion (org-end-of-item) (point)))
22078 clist)
22079 (and (org-at-item-checkbox-p)
22080 (push (org-point-in-group p 0 :checkbox) clist)))
22082 ((org-at-table-p)
22083 (push (list :table (org-table-begin) (org-table-end)) clist)
22084 (if (memq 'org-formula faces)
22085 (push (list :table-special
22086 (previous-single-property-change p 'face)
22087 (next-single-property-change p 'face)) clist)))
22088 ((org-at-table-p 'any)
22089 (push (list :table-table) clist)))
22090 (goto-char p)
22092 (let ((case-fold-search t))
22093 ;; New the "medium" contexts: clocktables, source blocks
22094 (cond ((org-in-clocktable-p)
22095 (push (list :clocktable
22096 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22097 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22098 (match-beginning 1))
22099 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22100 (match-end 0))) clist))
22101 ((org-in-src-block-p)
22102 (push (list :src-block
22103 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22104 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22105 (match-beginning 1))
22106 (and (search-forward "#+END_SRC" nil t)
22107 (match-beginning 0))) clist))))
22108 (goto-char p)
22110 ;; Now the small context
22111 (cond
22112 ((org-at-timestamp-p)
22113 (push (org-point-in-group p 0 :timestamp) clist))
22114 ((memq 'org-link faces)
22115 (push (list :link
22116 (previous-single-property-change p 'face)
22117 (next-single-property-change p 'face)) clist))
22118 ((memq 'org-special-keyword faces)
22119 (push (list :keyword
22120 (previous-single-property-change p 'face)
22121 (next-single-property-change p 'face)) clist))
22122 ((org-at-target-p)
22123 (push (org-point-in-group p 0 :target) clist)
22124 (goto-char (1- (match-beginning 0)))
22125 (if (looking-at org-radio-target-regexp)
22126 (push (org-point-in-group p 0 :radio-target) clist))
22127 (goto-char p))
22128 ((setq o (car (delq nil
22129 (mapcar
22130 (lambda (x)
22131 (if (memq x org-latex-fragment-image-overlays) x))
22132 (overlays-at (point))))))
22133 (push (list :latex-fragment
22134 (overlay-start o) (overlay-end o)) clist)
22135 (push (list :latex-preview
22136 (overlay-start o) (overlay-end o)) clist))
22137 ((org-inside-LaTeX-fragment-p)
22138 ;; FIXME: positions wrong.
22139 (push (list :latex-fragment (point) (point)) clist)))
22141 (setq clist (nreverse (delq nil clist)))
22142 clist))
22144 (defun org-in-regexp (re &optional nlines visually)
22145 "Check if point is inside a match of RE.
22147 Normally only the current line is checked, but you can include
22148 NLINES extra lines after point into the search. If VISUALLY is
22149 set, require that the cursor is not after the match but really
22150 on, so that the block visually is on the match."
22151 (catch 'exit
22152 (let ((pos (point))
22153 (eol (point-at-eol (+ 1 (or nlines 0))))
22154 (inc (if visually 1 0)))
22155 (save-excursion
22156 (beginning-of-line (- 1 (or nlines 0)))
22157 (while (re-search-forward re eol t)
22158 (if (and (<= (match-beginning 0) pos)
22159 (>= (+ inc (match-end 0)) pos))
22160 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22161 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22162 "Org mode 8.3")
22164 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22165 "Non-nil when point is between matches of START-RE and END-RE.
22167 Also return a non-nil value when point is on one of the matches.
22169 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22170 buffer positions. Default values are the positions of headlines
22171 surrounding the point.
22173 The functions returns a cons cell whose car (resp. cdr) is the
22174 position before START-RE (resp. after END-RE)."
22175 (save-match-data
22176 (let ((pos (point))
22177 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22178 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22179 beg end)
22180 (save-excursion
22181 ;; Point is on a block when on START-RE or if START-RE can be
22182 ;; found before it...
22183 (and (or (org-in-regexp start-re)
22184 (re-search-backward start-re limit-up t))
22185 (setq beg (match-beginning 0))
22186 ;; ... and END-RE after it...
22187 (goto-char (match-end 0))
22188 (re-search-forward end-re limit-down t)
22189 (> (setq end (match-end 0)) pos)
22190 ;; ... without another START-RE in-between.
22191 (goto-char (match-beginning 0))
22192 (not (re-search-backward start-re (1+ beg) t))
22193 ;; Return value.
22194 (cons beg end))))))
22196 (defun org-in-block-p (names)
22197 "Non-nil when point belongs to a block whose name belongs to NAMES.
22199 NAMES is a list of strings containing names of blocks.
22201 Return first block name matched, or nil. Beware that in case of
22202 nested blocks, the returned name may not belong to the closest
22203 block from point."
22204 (save-match-data
22205 (catch 'exit
22206 (let ((case-fold-search t)
22207 (lim-up (save-excursion (outline-previous-heading)))
22208 (lim-down (save-excursion (outline-next-heading))))
22209 (mapc (lambda (name)
22210 (let ((n (regexp-quote name)))
22211 (when (org-between-regexps-p
22212 (concat "^[ \t]*#\\+begin_" n)
22213 (concat "^[ \t]*#\\+end_" n)
22214 lim-up lim-down)
22215 (throw 'exit n))))
22216 names))
22217 nil)))
22219 (defun org-occur-in-agenda-files (regexp &optional nlines)
22220 "Call `multi-occur' with buffers for all agenda files."
22221 (interactive "sOrg-files matching: \np")
22222 (let* ((files (org-agenda-files))
22223 (tnames (mapcar 'file-truename files))
22224 (extra org-agenda-text-search-extra-files)
22226 (when (eq (car extra) 'agenda-archives)
22227 (setq extra (cdr extra))
22228 (setq files (org-add-archive-files files)))
22229 (while (setq f (pop extra))
22230 (unless (member (file-truename f) tnames)
22231 (add-to-list 'files f 'append)
22232 (add-to-list 'tnames (file-truename f) 'append)))
22233 (multi-occur
22234 (mapcar (lambda (x)
22235 (with-current-buffer
22236 (or (get-file-buffer x) (find-file-noselect x))
22237 (widen)
22238 (current-buffer)))
22239 files)
22240 regexp)))
22242 (if (boundp 'occur-mode-find-occurrence-hook)
22243 ;; Emacs 23
22244 (add-hook 'occur-mode-find-occurrence-hook
22245 (lambda ()
22246 (when (derived-mode-p 'org-mode)
22247 (org-reveal))))
22248 ;; Emacs 22
22249 (defadvice occur-mode-goto-occurrence
22250 (after org-occur-reveal activate)
22251 (and (derived-mode-p 'org-mode) (org-reveal)))
22252 (defadvice occur-mode-goto-occurrence-other-window
22253 (after org-occur-reveal activate)
22254 (and (derived-mode-p 'org-mode) (org-reveal)))
22255 (defadvice occur-mode-display-occurrence
22256 (after org-occur-reveal activate)
22257 (when (derived-mode-p 'org-mode)
22258 (let ((pos (occur-mode-find-occurrence)))
22259 (with-current-buffer (marker-buffer pos)
22260 (save-excursion
22261 (goto-char pos)
22262 (org-reveal)))))))
22264 (defun org-occur-link-in-agenda-files ()
22265 "Create a link and search for it in the agendas.
22266 The link is not stored in `org-stored-links', it is just created
22267 for the search purpose."
22268 (interactive)
22269 (let ((link (condition-case nil
22270 (org-store-link nil)
22271 (error "Unable to create a link to here"))))
22272 (org-occur-in-agenda-files (regexp-quote link))))
22274 (defun org-reverse-string (string)
22275 "Return the reverse of STRING."
22276 (apply 'string (reverse (string-to-list string))))
22278 ;; defsubst org-uniquify must be defined before first use
22280 (defun org-uniquify-alist (alist)
22281 "Merge elements of ALIST with the same key.
22283 For example, in this alist:
22285 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22286 => '((a 1 3) (b 2))
22288 merge (a 1) and (a 3) into (a 1 3).
22290 The function returns the new ALIST."
22291 (let (rtn)
22292 (mapc
22293 (lambda (e)
22294 (let (n)
22295 (if (not (assoc (car e) rtn))
22296 (push e rtn)
22297 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22298 (setq rtn (assq-delete-all (car e) rtn))
22299 (push n rtn))))
22300 alist)
22301 rtn))
22303 (defun org-delete-all (elts list)
22304 "Remove all elements in ELTS from LIST."
22305 (while elts
22306 (setq list (delete (pop elts) list)))
22307 list)
22309 (defun org-count (cl-item cl-seq)
22310 "Count the number of occurrences of ITEM in SEQ.
22311 Taken from `count' in cl-seq.el with all keyword arguments removed."
22312 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22313 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22314 (while (< cl-start cl-end)
22315 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22316 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22317 (setq cl-start (1+ cl-start)))
22318 cl-count))
22320 (defun org-remove-if (predicate seq)
22321 "Remove everything from SEQ that fulfills PREDICATE."
22322 (let (res e)
22323 (while seq
22324 (setq e (pop seq))
22325 (if (not (funcall predicate e)) (push e res)))
22326 (nreverse res)))
22328 (defun org-remove-if-not (predicate seq)
22329 "Remove everything from SEQ that does not fulfill PREDICATE."
22330 (let (res e)
22331 (while seq
22332 (setq e (pop seq))
22333 (if (funcall predicate e) (push e res)))
22334 (nreverse res)))
22336 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22337 "Reduce two-argument FUNCTION across SEQ.
22338 Taken from `reduce' in cl-seq.el with all keyword arguments but
22339 \":initial-value\" removed."
22340 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22341 (cadr (memq :initial-value cl-keys)))
22342 (cl-seq (pop cl-seq))
22343 (t (funcall cl-func)))))
22344 (while cl-seq
22345 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22346 cl-accum))
22348 (defun org-every (pred seq)
22349 "Return true if PREDICATE is true of every element of SEQ.
22350 Adapted from `every' in cl.el."
22351 (catch 'org-every
22352 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22355 (defun org-some (pred seq)
22356 "Return true if PREDICATE is true of any element of SEQ.
22357 Adapted from `some' in cl.el."
22358 (catch 'org-some
22359 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22360 nil))
22362 (defun org-back-over-empty-lines ()
22363 "Move backwards over whitespace, to the beginning of the first empty line.
22364 Returns the number of empty lines passed."
22365 (let ((pos (point)))
22366 (if (cdr (assoc 'heading org-blank-before-new-entry))
22367 (skip-chars-backward " \t\n\r")
22368 (unless (eobp)
22369 (forward-line -1)))
22370 (beginning-of-line 2)
22371 (goto-char (min (point) pos))
22372 (count-lines (point) pos)))
22374 (defun org-skip-whitespace ()
22375 (skip-chars-forward " \t\n\r"))
22377 (defun org-point-in-group (point group &optional context)
22378 "Check if POINT is in match-group GROUP.
22379 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22380 match. If the match group does not exist or point is not inside it,
22381 return nil."
22382 (and (match-beginning group)
22383 (>= point (match-beginning group))
22384 (<= point (match-end group))
22385 (if context
22386 (list context (match-beginning group) (match-end group))
22387 t)))
22389 (defun org-switch-to-buffer-other-window (&rest args)
22390 "Switch to buffer in a second window on the current frame.
22391 In particular, do not allow pop-up frames.
22392 Returns the newly created buffer."
22393 (org-no-popups
22394 (apply 'switch-to-buffer-other-window args)))
22396 (defun org-combine-plists (&rest plists)
22397 "Create a single property list from all plists in PLISTS.
22398 The process starts by copying the first list, and then setting properties
22399 from the other lists. Settings in the last list are the most significant
22400 ones and overrule settings in the other lists."
22401 (let ((rtn (copy-sequence (pop plists)))
22402 p v ls)
22403 (while plists
22404 (setq ls (pop plists))
22405 (while ls
22406 (setq p (pop ls) v (pop ls))
22407 (setq rtn (plist-put rtn p v))))
22408 rtn))
22410 (defun org-replace-escapes (string table)
22411 "Replace %-escapes in STRING with values in TABLE.
22412 TABLE is an association list with keys like \"%a\" and string values.
22413 The sequences in STRING may contain normal field width and padding information,
22414 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22415 so values can contain further %-escapes if they are define later in TABLE."
22416 (let ((tbl (copy-alist table))
22417 (case-fold-search nil)
22418 (pchg 0)
22419 e re rpl)
22420 (while (setq e (pop tbl))
22421 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22422 (when (and (cdr e) (string-match re (cdr e)))
22423 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22424 (safe "SREF"))
22425 (add-text-properties 0 3 (list 'sref sref) safe)
22426 (setcdr e (replace-match safe t t (cdr e)))))
22427 (while (string-match re string)
22428 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22429 (cdr e)))
22430 (setq string (replace-match rpl t t string))))
22431 (while (setq pchg (next-property-change pchg string))
22432 (let ((sref (get-text-property pchg 'sref string)))
22433 (when (and sref (string-match "SREF" string pchg))
22434 (setq string (replace-match sref t t string)))))
22435 string))
22437 (defun org-sublist (list start end)
22438 "Return a section of LIST, from START to END.
22439 Counting starts at 1."
22440 (let (rtn (c start))
22441 (setq list (nthcdr (1- start) list))
22442 (while (and list (<= c end))
22443 (push (pop list) rtn)
22444 (setq c (1+ c)))
22445 (nreverse rtn)))
22447 (defun org-find-base-buffer-visiting (file)
22448 "Like `find-buffer-visiting' but always return the base buffer and
22449 not an indirect buffer."
22450 (let ((buf (or (get-file-buffer file)
22451 (find-buffer-visiting file))))
22452 (if buf
22453 (or (buffer-base-buffer buf) buf)
22454 nil)))
22456 (defun org-image-file-name-regexp (&optional extensions)
22457 "Return regexp matching the file names of images.
22458 If EXTENSIONS is given, only match these."
22459 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22460 (image-file-name-regexp)
22461 (let ((image-file-name-extensions
22462 (or extensions
22463 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22464 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22465 (concat "\\."
22466 (regexp-opt (nconc (mapcar 'upcase
22467 image-file-name-extensions)
22468 image-file-name-extensions)
22470 "\\'"))))
22472 (defun org-file-image-p (file &optional extensions)
22473 "Return non-nil if FILE is an image."
22474 (save-match-data
22475 (string-match (org-image-file-name-regexp extensions) file)))
22477 (defun org-get-cursor-date (&optional with-time)
22478 "Return the date at cursor in as a time.
22479 This works in the calendar and in the agenda, anywhere else it just
22480 returns the current time.
22481 If WITH-TIME is non-nil, returns the time of the event at point (in
22482 the agenda) or the current time of the day."
22483 (let (date day defd tp tm hod mod)
22484 (when with-time
22485 (setq tp (get-text-property (point) 'time))
22486 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22487 (setq hod (string-to-number (match-string 1 tp))
22488 mod (string-to-number (match-string 2 tp))))
22489 (or tp (setq hod (nth 2 (decode-time (current-time)))
22490 mod (nth 1 (decode-time (current-time))))))
22491 (cond
22492 ((eq major-mode 'calendar-mode)
22493 (setq date (calendar-cursor-to-date)
22494 defd (encode-time 0 (or mod 0) (or hod 0)
22495 (nth 1 date) (nth 0 date) (nth 2 date))))
22496 ((eq major-mode 'org-agenda-mode)
22497 (setq day (get-text-property (point) 'day))
22498 (if day
22499 (setq date (calendar-gregorian-from-absolute day)
22500 defd (encode-time 0 (or mod 0) (or hod 0)
22501 (nth 1 date) (nth 0 date) (nth 2 date))))))
22502 (or defd (current-time))))
22504 (defun org-mark-subtree (&optional up)
22505 "Mark the current subtree.
22506 This puts point at the start of the current subtree, and mark at
22507 the end. If a numeric prefix UP is given, move up into the
22508 hierarchy of headlines by UP levels before marking the subtree."
22509 (interactive "P")
22510 (org-with-limited-levels
22511 (cond ((org-at-heading-p) (beginning-of-line))
22512 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22513 (t (outline-previous-visible-heading 1))))
22514 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22515 (if (org-called-interactively-p 'any)
22516 (call-interactively 'org-mark-element)
22517 (org-mark-element)))
22520 ;;; Indentation
22522 (defun org--get-expected-indentation (element contentsp)
22523 "Expected indentation column for current line, according to ELEMENT.
22524 ELEMENT is an element containing point. CONTENTSP is non-nil
22525 when indentation is to be computed according to contents of
22526 ELEMENT."
22527 (let ((type (org-element-type element))
22528 (start (org-element-property :begin element)))
22529 (org-with-wide-buffer
22530 (cond
22531 (contentsp
22532 (case type
22533 (footnote-definition 0)
22534 ((headline inlinetask nil)
22535 (if (not org-adapt-indentation) 0
22536 (let ((level (org-current-level)))
22537 (if level (1+ level) 0))))
22538 (item
22539 (org-list-item-body-column
22540 (org-element-property :post-affiliated element)))
22541 (plain-list
22542 (save-excursion
22543 (goto-char (org-element-property :post-affiliated element))
22544 (org-get-indentation)))
22545 (otherwise
22546 (goto-char start)
22547 (org-get-indentation))))
22548 ((memq type '(headline inlinetask nil))
22549 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22550 (org--get-expected-indentation element t)
22552 ((eq type 'footnote-definition) 0)
22553 ;; First paragraph of a footnote definition or an item.
22554 ;; Indent like parent.
22555 ((< (line-beginning-position) start)
22556 (org--get-expected-indentation
22557 (org-element-property :parent element) t))
22558 ;; At first line: indent according to previous sibling, if any,
22559 ;; ignoring footnote definitions and inline tasks, or parent's
22560 ;; contents.
22561 ((= (line-beginning-position) start)
22562 (catch 'exit
22563 (while t
22564 (if (= (point-min) start) (throw 'exit 0)
22565 (goto-char (1- start))
22566 (let* ((previous (org-element-at-point))
22567 (parent previous))
22568 (while (and parent (<= (org-element-property :end parent) start))
22569 (setq previous parent
22570 parent (org-element-property :parent parent)))
22571 (cond
22572 ((not previous) (throw 'exit 0))
22573 ((> (org-element-property :end previous) start)
22574 (throw 'exit (org--get-expected-indentation previous t)))
22575 ((memq (org-element-type previous)
22576 '(footnote-definition inlinetask))
22577 (setq start (org-element-property :begin previous)))
22578 (t (goto-char (org-element-property :begin previous))
22579 (throw 'exit
22580 (if (bolp) (org-get-indentation)
22581 ;; At first paragraph in an item or
22582 ;; a footnote definition.
22583 (org--get-expected-indentation
22584 (org-element-property :parent previous) t))))))))))
22585 ;; Otherwise, move to the first non-blank line above.
22587 (beginning-of-line)
22588 (let ((pos (point)))
22589 (skip-chars-backward " \r\t\n")
22590 (cond
22591 ;; Two blank lines end a footnote definition or a plain
22592 ;; list. When we indent an empty line after them, the
22593 ;; containing list or footnote definition is over, so it
22594 ;; qualifies as a previous sibling. Therefore, we indent
22595 ;; like its first line.
22596 ((and (memq type '(footnote-definition plain-list))
22597 (> (count-lines (point) pos) 2))
22598 (goto-char start)
22599 (org-get-indentation))
22600 ;; Line above is the first one of a paragraph at the
22601 ;; beginning of an item or a footnote definition. Indent
22602 ;; like parent.
22603 ((< (line-beginning-position) start)
22604 (org--get-expected-indentation
22605 (org-element-property :parent element) t))
22606 ;; POS is after contents in a greater element. Indent like
22607 ;; the beginning of the element.
22609 ;; As a special case, if point is at the end of a footnote
22610 ;; definition or an item, indent like the very last element
22611 ;; within.
22612 ((and (not (eq type 'paragraph))
22613 (let ((cend (org-element-property :contents-end element)))
22614 (and cend (<= cend pos))))
22615 (if (memq type '(footnote-definition item plain-list))
22616 (org--get-expected-indentation (org-element-at-point) nil)
22617 (goto-char start)
22618 (org-get-indentation)))
22619 ;; In any other case, indent like the current line.
22620 (t (org-get-indentation)))))))))
22622 (defun org--align-node-property ()
22623 "Align node property at point.
22624 Alignment is done according to `org-property-format', which see."
22625 (when (save-excursion
22626 (beginning-of-line)
22627 (looking-at org-property-re))
22628 (replace-match
22629 (concat (match-string 4)
22630 (org-trim
22631 (format org-property-format (match-string 1) (match-string 3))))
22632 t t)))
22634 (defun org-indent-line ()
22635 "Indent line depending on context.
22637 Indentation is done according to the following rules:
22639 - Footnote definitions, headlines and inline tasks have to
22640 start at column 0.
22642 - On the very first line of an element, consider, in order, the
22643 next rules until one matches:
22645 1. If there's a sibling element before, ignoring footnote
22646 definitions and inline tasks, indent like its first line.
22648 2. If element has a parent, indent like its contents. More
22649 precisely, if parent is an item, indent after the
22650 description part, if any, or the bullet (see
22651 `org-list-description-max-indent'). Else, indent like
22652 parent's first line.
22654 3. Otherwise, indent relatively to current level, if
22655 `org-adapt-indentation' is non-nil, or to left margin.
22657 - On a blank line at the end of an element, indent according to
22658 the type of the element. More precisely
22660 1. If element is a plain list, an item, or a footnote
22661 definition, indent like the very last element within.
22663 2. If element is a paragraph, indent like its last non blank
22664 line.
22666 3. Otherwise, indent like its very first line.
22668 - In the code part of a source block, use language major mode
22669 to indent current line if `org-src-tab-acts-natively' is
22670 non-nil. If it is nil, do nothing.
22672 - Otherwise, indent like the first non-blank line above.
22674 The function doesn't indent an item as it could break the whole
22675 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22676 \\[org-shiftmetaright].
22678 Also align node properties according to `org-property-format'."
22679 (interactive)
22680 (cond
22681 (orgstruct-is-++
22682 (let ((indent-line-function
22683 (cadadr (assq 'indent-line-function org-fb-vars))))
22684 (indent-according-to-mode)))
22685 ((org-at-heading-p) 'noindent)
22687 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22688 (type (org-element-type element)))
22689 (cond ((and (memq type '(plain-list item))
22690 (= (line-beginning-position)
22691 (org-element-property :post-affiliated element)))
22692 'noindent)
22693 ((and (eq type 'src-block)
22694 org-src-tab-acts-natively
22695 (> (line-beginning-position)
22696 (org-element-property :post-affiliated element))
22697 (< (line-beginning-position)
22698 (org-with-wide-buffer
22699 (goto-char (org-element-property :end element))
22700 (skip-chars-backward " \r\t\n")
22701 (line-beginning-position))))
22702 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22704 (let ((column (org--get-expected-indentation element nil)))
22705 ;; Preserve current column.
22706 (if (<= (current-column) (current-indentation))
22707 (org-indent-line-to column)
22708 (save-excursion (org-indent-line-to column))))
22709 ;; Align node property. Also preserve current column.
22710 (when (eq type 'node-property)
22711 (let ((column (current-column)))
22712 (org--align-node-property)
22713 (org-move-to-column column)))))))))
22715 (defun org-indent-region (start end)
22716 "Indent each non-blank line in the region.
22717 Called from a program, START and END specify the region to
22718 indent. The function will not indent contents of example blocks,
22719 verse blocks and export blocks as leading white spaces are
22720 assumed to be significant there."
22721 (interactive "r")
22722 (save-excursion
22723 (goto-char start)
22724 (skip-chars-forward " \r\t\n")
22725 (unless (eobp) (beginning-of-line))
22726 (let ((indent-to
22727 (lambda (ind pos)
22728 ;; Set IND as indentation for all lines between point and
22729 ;; POS or END, whichever comes first. Blank lines are
22730 ;; ignored. Leave point after POS once done.
22731 (let ((limit (copy-marker (min end pos))))
22732 (while (< (point) limit)
22733 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
22734 (forward-line))
22735 (set-marker limit nil))))
22736 (end (copy-marker end)))
22737 (while (< (point) end)
22738 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
22739 (let* ((element (org-element-at-point))
22740 (type (org-element-type element))
22741 (element-end (copy-marker (org-element-property :end element)))
22742 (ind (org--get-expected-indentation element nil)))
22743 (cond
22744 ((or (memq type '(paragraph table table-row))
22745 (not (or (org-element-property :contents-begin element)
22746 (memq type
22747 '(example-block export-block src-block)))))
22748 ;; Elements here are indented as a single block. Also
22749 ;; align node properties.
22750 (when (eq type 'node-property)
22751 (org--align-node-property)
22752 (beginning-of-line))
22753 (funcall indent-to ind element-end))
22755 ;; Elements in this category consist of three parts:
22756 ;; before the contents, the contents, and after the
22757 ;; contents. The contents are treated specially,
22758 ;; according to the element type, or not indented at
22759 ;; all. Other parts are indented as a single block.
22760 (let* ((post (copy-marker
22761 (org-element-property :post-affiliated element)))
22762 (cbeg
22763 (copy-marker
22764 (cond
22765 ((not (org-element-property :contents-begin element))
22766 ;; Fake contents for source blocks.
22767 (org-with-wide-buffer
22768 (goto-char post)
22769 (forward-line)
22770 (point)))
22771 ((memq type '(footnote-definition item plain-list))
22772 ;; Contents in these elements could start on
22773 ;; the same line as the beginning of the
22774 ;; element. Make sure we start indenting
22775 ;; from the second line.
22776 (org-with-wide-buffer
22777 (goto-char post)
22778 (end-of-line)
22779 (skip-chars-forward " \r\t\n")
22780 (if (eobp) (point) (line-beginning-position))))
22781 (t (org-element-property :contents-begin element)))))
22782 (cend (copy-marker
22783 (or (org-element-property :contents-end element)
22784 ;; Fake contents for source blocks.
22785 (org-with-wide-buffer
22786 (goto-char element-end)
22787 (skip-chars-backward " \r\t\n")
22788 (line-beginning-position)))
22789 t)))
22790 ;; Do not change items indentation individually as it
22791 ;; might break the list as a whole. On the other
22792 ;; hand, when at a plain list, indent it as a whole.
22793 (cond ((eq type 'plain-list)
22794 (let ((offset (- ind (org-get-indentation))))
22795 (unless (zerop offset)
22796 (indent-rigidly (org-element-property :begin element)
22797 (org-element-property :end element)
22798 offset))
22799 (goto-char cbeg)))
22800 ((eq type 'item) (goto-char cbeg))
22801 (t (funcall indent-to ind cbeg)))
22802 (when (< (point) end)
22803 (case type
22804 ((example-block export-block verse-block))
22805 (src-block
22806 ;; In a source block, indent source code
22807 ;; according to language major mode, but only if
22808 ;; `org-src-tab-acts-natively' is non-nil.
22809 (when (and (< (point) end) org-src-tab-acts-natively)
22810 (ignore-errors
22811 (org-babel-do-in-edit-buffer
22812 (indent-region (point-min) (point-max))))))
22813 (t (org-indent-region (point) (min cend end))))
22814 (goto-char (min cend end))
22815 (when (< (point) end) (funcall indent-to ind element-end)))
22816 (set-marker post nil)
22817 (set-marker cbeg nil)
22818 (set-marker cend nil))))
22819 (set-marker element-end nil))))
22820 (set-marker end nil))))
22822 (defun org-indent-drawer ()
22823 "Indent the drawer at point."
22824 (interactive)
22825 (unless (save-excursion
22826 (beginning-of-line)
22827 (org-looking-at-p org-drawer-regexp))
22828 (user-error "Not at a drawer"))
22829 (let ((element (org-element-at-point)))
22830 (unless (memq (org-element-type element) '(drawer property-drawer))
22831 (user-error "Not at a drawer"))
22832 (org-with-wide-buffer
22833 (org-indent-region (org-element-property :begin element)
22834 (org-element-property :end element))))
22835 (message "Drawer at point indented"))
22837 (defun org-indent-block ()
22838 "Indent the block at point."
22839 (interactive)
22840 (unless (save-excursion
22841 (beginning-of-line)
22842 (let ((case-fold-search t))
22843 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
22844 (user-error "Not at a block"))
22845 (let ((element (org-element-at-point)))
22846 (unless (memq (org-element-type element)
22847 '(comment-block center-block dynamic-block example-block
22848 export-block quote-block special-block
22849 src-block verse-block))
22850 (user-error "Not at a block"))
22851 (org-with-wide-buffer
22852 (org-indent-region (org-element-property :begin element)
22853 (org-element-property :end element))))
22854 (message "Block at point indented"))
22857 ;;; Filling
22859 ;; We use our own fill-paragraph and auto-fill functions.
22861 ;; `org-fill-paragraph' relies on adaptive filling and context
22862 ;; checking. Appropriate `fill-prefix' is computed with
22863 ;; `org-adaptive-fill-function'.
22865 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22866 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22867 ;; `org-adaptive-fill-function' value. Internally,
22868 ;; `org-comment-line-break-function' breaks the line.
22870 ;; `org-setup-filling' installs filling and auto-filling related
22871 ;; variables during `org-mode' initialization.
22873 (defvar org-element-paragraph-separate) ; org-element.el
22874 (defun org-setup-filling ()
22875 (require 'org-element)
22876 ;; Prevent auto-fill from inserting unwanted new items.
22877 (when (boundp 'fill-nobreak-predicate)
22878 (org-set-local
22879 'fill-nobreak-predicate
22880 (org-uniquify
22881 (append fill-nobreak-predicate
22882 '(org-fill-line-break-nobreak-p
22883 org-fill-paragraph-with-timestamp-nobreak-p)))))
22884 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22885 (org-set-local 'paragraph-start paragraph-ending)
22886 (org-set-local 'paragraph-separate paragraph-ending))
22887 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22888 (org-set-local 'auto-fill-inhibit-regexp nil)
22889 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22890 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22891 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22893 (defun org-fill-line-break-nobreak-p ()
22894 "Non-nil when a new line at point would create an Org line break."
22895 (save-excursion
22896 (skip-chars-backward "[ \t]")
22897 (skip-chars-backward "\\\\")
22898 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22900 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22901 "Non-nil when a new line at point would split a timestamp."
22902 (and (org-at-timestamp-p t)
22903 (not (looking-at org-ts-regexp-both))))
22905 (declare-function message-in-body-p "message" ())
22906 (defvar orgtbl-line-start-regexp) ; From org-table.el
22907 (defun org-adaptive-fill-function ()
22908 "Compute a fill prefix for the current line.
22909 Return fill prefix, as a string, or nil if current line isn't
22910 meant to be filled. For convenience, if `adaptive-fill-regexp'
22911 matches in paragraphs or comments, use it."
22912 (catch 'exit
22913 (when (derived-mode-p 'message-mode)
22914 (save-excursion
22915 (beginning-of-line)
22916 (cond ((or (not (message-in-body-p))
22917 (looking-at orgtbl-line-start-regexp))
22918 (throw 'exit nil))
22919 ((looking-at message-cite-prefix-regexp)
22920 (throw 'exit (match-string-no-properties 0)))
22921 ((looking-at org-outline-regexp)
22922 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
22923 (org-with-wide-buffer
22924 (unless (org-at-heading-p)
22925 (let* ((p (line-beginning-position))
22926 (element (save-excursion
22927 (beginning-of-line)
22928 (org-element-at-point)))
22929 (type (org-element-type element))
22930 (post-affiliated (org-element-property :post-affiliated element)))
22931 (unless (< p post-affiliated)
22932 (case type
22933 (comment
22934 (save-excursion
22935 (beginning-of-line)
22936 (looking-at "[ \t]*")
22937 (concat (match-string 0) "# ")))
22938 (footnote-definition "")
22939 ((item plain-list)
22940 (make-string (org-list-item-body-column post-affiliated) ?\s))
22941 (paragraph
22942 ;; Fill prefix is usually the same as the current line,
22943 ;; unless the paragraph is at the beginning of an item.
22944 (let ((parent (org-element-property :parent element)))
22945 (save-excursion
22946 (beginning-of-line)
22947 (cond ((eq (org-element-type parent) 'item)
22948 (make-string (org-list-item-body-column
22949 (org-element-property :begin parent))
22950 ?\s))
22951 ((and adaptive-fill-regexp
22952 ;; Locally disable
22953 ;; `adaptive-fill-function' to let
22954 ;; `fill-context-prefix' handle
22955 ;; `adaptive-fill-regexp' variable.
22956 (let (adaptive-fill-function)
22957 (fill-context-prefix
22958 post-affiliated
22959 (org-element-property :end element)))))
22960 ((looking-at "[ \t]+") (match-string 0))
22961 (t "")))))
22962 (comment-block
22963 ;; Only fill contents if P is within block boundaries.
22964 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22965 (forward-line)
22966 (point)))
22967 (cend (save-excursion
22968 (goto-char (org-element-property :end element))
22969 (skip-chars-backward " \r\t\n")
22970 (line-beginning-position))))
22971 (when (and (>= p cbeg) (< p cend))
22972 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22973 (match-string 0)
22974 "")))))))))))
22976 (declare-function message-goto-body "message" ())
22977 (defvar message-cite-prefix-regexp) ; From message.el
22978 (defun org-fill-paragraph (&optional justify)
22979 "Fill element at point, when applicable.
22981 This function only applies to comment blocks, comments, example
22982 blocks and paragraphs. Also, as a special case, re-align table
22983 when point is at one.
22985 If JUSTIFY is non-nil (interactively, with prefix argument),
22986 justify as well. If `sentence-end-double-space' is non-nil, then
22987 period followed by one space does not end a sentence, so don't
22988 break a line there. The variable `fill-column' controls the
22989 width for filling.
22991 For convenience, when point is at a plain list, an item or
22992 a footnote definition, try to fill the first paragraph within."
22993 (interactive)
22994 (if (and (derived-mode-p 'message-mode)
22995 (or (not (message-in-body-p))
22996 (save-excursion (move-beginning-of-line 1)
22997 (looking-at message-cite-prefix-regexp))))
22998 ;; First ensure filling is correct in message-mode.
22999 (let ((fill-paragraph-function
23000 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23001 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23002 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23003 (paragraph-separate
23004 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23005 (fill-paragraph nil))
23006 (with-syntax-table org-mode-transpose-word-syntax-table
23007 ;; Move to end of line in order to get the first paragraph
23008 ;; within a plain list or a footnote definition.
23009 (let ((element (save-excursion
23010 (end-of-line)
23011 (or (ignore-errors (org-element-at-point))
23012 (user-error "An element cannot be parsed line %d"
23013 (line-number-at-pos (point)))))))
23014 ;; First check if point is in a blank line at the beginning of
23015 ;; the buffer. In that case, ignore filling.
23016 (case (org-element-type element)
23017 ;; Use major mode filling function is src blocks.
23018 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23019 ;; Align Org tables, leave table.el tables as-is.
23020 (table-row (org-table-align) t)
23021 (table
23022 (when (eq (org-element-property :type element) 'org)
23023 (save-excursion
23024 (goto-char (org-element-property :post-affiliated element))
23025 (org-table-align)))
23027 (paragraph
23028 ;; Paragraphs may contain `line-break' type objects.
23029 (let ((beg (max (point-min)
23030 (org-element-property :contents-begin element)))
23031 (end (min (point-max)
23032 (org-element-property :contents-end element))))
23033 ;; Do nothing if point is at an affiliated keyword.
23034 (if (< (line-end-position) beg) t
23035 (when (derived-mode-p 'message-mode)
23036 ;; In `message-mode', do not fill following citation
23037 ;; in current paragraph nor text before message body.
23038 (let ((body-start (save-excursion (message-goto-body))))
23039 (when body-start (setq beg (max body-start beg))))
23040 (when (save-excursion
23041 (re-search-forward
23042 (concat "^" message-cite-prefix-regexp) end t))
23043 (setq end (match-beginning 0))))
23044 ;; Fill paragraph, taking line breaks into account.
23045 (save-excursion
23046 (goto-char beg)
23047 (let ((cuts (list beg)))
23048 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23049 (when (eq 'line-break
23050 (org-element-type
23051 (save-excursion (backward-char)
23052 (org-element-context))))
23053 (push (point) cuts)))
23054 (dolist (c (delq end cuts))
23055 (fill-region-as-paragraph c end justify)
23056 (setq end c))))
23057 t)))
23058 ;; Contents of `comment-block' type elements should be
23059 ;; filled as plain text, but only if point is within block
23060 ;; markers.
23061 (comment-block
23062 (let* ((case-fold-search t)
23063 (beg (save-excursion
23064 (goto-char (org-element-property :begin element))
23065 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23066 (forward-line)
23067 (point)))
23068 (end (save-excursion
23069 (goto-char (org-element-property :end element))
23070 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23071 (line-beginning-position))))
23072 (if (or (< (point) beg) (> (point) end)) t
23073 (fill-region-as-paragraph
23074 (save-excursion (end-of-line)
23075 (re-search-backward "^[ \t]*$" beg 'move)
23076 (line-beginning-position))
23077 (save-excursion (beginning-of-line)
23078 (re-search-forward "^[ \t]*$" end 'move)
23079 (line-beginning-position))
23080 justify))))
23081 ;; Fill comments.
23082 (comment
23083 (let ((begin (org-element-property :post-affiliated element))
23084 (end (org-element-property :end element)))
23085 (when (and (>= (point) begin) (<= (point) end))
23086 (let ((begin (save-excursion
23087 (end-of-line)
23088 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23089 (progn (forward-line) (point))
23090 begin)))
23091 (end (save-excursion
23092 (end-of-line)
23093 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23094 (1- (line-beginning-position))
23095 (skip-chars-backward " \r\t\n")
23096 (line-end-position)))))
23097 ;; Do not fill comments when at a blank line.
23098 (when (> end begin)
23099 (let ((fill-prefix
23100 (save-excursion
23101 (beginning-of-line)
23102 (looking-at "[ \t]*#")
23103 (let ((comment-prefix (match-string 0)))
23104 (goto-char (match-end 0))
23105 (if (looking-at adaptive-fill-regexp)
23106 (concat comment-prefix (match-string 0))
23107 (concat comment-prefix " "))))))
23108 (save-excursion
23109 (fill-region-as-paragraph begin end justify))))))
23111 ;; Ignore every other element.
23112 (otherwise t))))))
23114 (defun org-auto-fill-function ()
23115 "Auto-fill function."
23116 ;; Check if auto-filling is meaningful.
23117 (let ((fc (current-fill-column)))
23118 (when (and fc (> (current-column) fc))
23119 (let* ((fill-prefix (org-adaptive-fill-function))
23120 ;; Enforce empty fill prefix, if required. Otherwise, it
23121 ;; will be computed again.
23122 (adaptive-fill-mode (not (equal fill-prefix ""))))
23123 (when fill-prefix (do-auto-fill))))))
23125 (defun org-comment-line-break-function (&optional soft)
23126 "Break line at point and indent, continuing comment if within one.
23127 The inserted newline is marked hard if variable
23128 `use-hard-newlines' is true, unless optional argument SOFT is
23129 non-nil."
23130 (if soft (insert-and-inherit ?\n) (newline 1))
23131 (save-excursion (forward-char -1) (delete-horizontal-space))
23132 (delete-horizontal-space)
23133 (indent-to-left-margin)
23134 (insert-before-markers-and-inherit fill-prefix))
23137 ;;; Fixed Width Areas
23139 (defun org-toggle-fixed-width ()
23140 "Toggle fixed-width markup.
23142 Add or remove fixed-width markup on current line, whenever it
23143 makes sense. Return an error otherwise.
23145 If a region is active and if it contains only fixed-width areas
23146 or blank lines, remove all fixed-width markup in it. If the
23147 region contains anything else, convert all non-fixed-width lines
23148 to fixed-width ones.
23150 Blank lines at the end of the region are ignored unless the
23151 region only contains such lines."
23152 (interactive)
23153 (if (not (org-region-active-p))
23154 ;; No region:
23156 ;; Remove fixed width marker only in a fixed-with element.
23158 ;; Add fixed width maker in paragraphs, in blank lines after
23159 ;; elements or at the beginning of a headline or an inlinetask,
23160 ;; and before any one-line elements (e.g., a clock).
23161 (progn
23162 (beginning-of-line)
23163 (let* ((element (org-element-at-point))
23164 (type (org-element-type element)))
23165 (cond
23166 ((and (eq type 'fixed-width)
23167 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23168 (replace-match
23169 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23170 ((and (memq type '(babel-call clock comment diary-sexp headline
23171 horizontal-rule keyword paragraph
23172 planning))
23173 (<= (org-element-property :post-affiliated element) (point)))
23174 (skip-chars-forward " \t")
23175 (insert ": "))
23176 ((and (org-looking-at-p "[ \t]*$")
23177 (or (eq type 'inlinetask)
23178 (save-excursion
23179 (skip-chars-forward " \r\t\n")
23180 (<= (org-element-property :end element) (point)))))
23181 (delete-region (point) (line-end-position))
23182 (org-indent-line)
23183 (insert ": "))
23184 (t (user-error "Cannot insert a fixed-width line here")))))
23185 ;; Region active.
23186 (let* ((begin (save-excursion
23187 (goto-char (region-beginning))
23188 (line-beginning-position)))
23189 (end (copy-marker
23190 (save-excursion
23191 (goto-char (region-end))
23192 (unless (eolp) (beginning-of-line))
23193 (if (save-excursion (re-search-backward "\\S-" begin t))
23194 (progn (skip-chars-backward " \r\t\n") (point))
23195 (point)))))
23196 (all-fixed-width-p
23197 (catch 'not-all-p
23198 (save-excursion
23199 (goto-char begin)
23200 (skip-chars-forward " \r\t\n")
23201 (when (eobp) (throw 'not-all-p nil))
23202 (while (< (point) end)
23203 (let ((element (org-element-at-point)))
23204 (if (eq (org-element-type element) 'fixed-width)
23205 (goto-char (org-element-property :end element))
23206 (throw 'not-all-p nil))))
23207 t))))
23208 (if all-fixed-width-p
23209 (save-excursion
23210 (goto-char begin)
23211 (while (< (point) end)
23212 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23213 (replace-match
23214 "" nil nil nil
23215 (if (= (line-end-position) (match-end 0)) 0 1)))
23216 (forward-line)))
23217 (let ((min-ind (point-max)))
23218 ;; Find minimum indentation across all lines.
23219 (save-excursion
23220 (goto-char begin)
23221 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23222 (setq min-ind 0)
23223 (catch 'zerop
23224 (while (< (point) end)
23225 (unless (org-looking-at-p "[ \t]*$")
23226 (let ((ind (org-get-indentation)))
23227 (setq min-ind (min min-ind ind))
23228 (when (zerop ind) (throw 'zerop t))))
23229 (forward-line)))))
23230 ;; Loop over all lines and add fixed-width markup everywhere
23231 ;; but in fixed-width lines.
23232 (save-excursion
23233 (goto-char begin)
23234 (while (< (point) end)
23235 (cond
23236 ((org-at-heading-p)
23237 (insert ": ")
23238 (forward-line)
23239 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23240 (insert ":")
23241 (forward-line)))
23242 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23243 (let* ((element (org-element-at-point))
23244 (element-end (org-element-property :end element)))
23245 (if (eq (org-element-type element) 'fixed-width)
23246 (progn (goto-char element-end)
23247 (skip-chars-backward " \r\t\n")
23248 (forward-line))
23249 (let ((limit (min end element-end)))
23250 (while (< (point) limit)
23251 (org-move-to-column min-ind t)
23252 (insert ": ")
23253 (forward-line))))))
23255 (org-move-to-column min-ind t)
23256 (insert ": ")
23257 (forward-line)))))))
23258 (set-marker end nil))))
23261 ;;; Comments
23263 ;; Org comments syntax is quite complex. It requires the entire line
23264 ;; to be just a comment. Also, even with the right syntax at the
23265 ;; beginning of line, some some elements (i.e. verse-block or
23266 ;; example-block) don't accept comments. Usual Emacs comment commands
23267 ;; cannot cope with those requirements. Therefore, Org replaces them.
23269 ;; Org still relies on `comment-dwim', but cannot trust
23270 ;; `comment-only-p'. So, `comment-region-function' and
23271 ;; `uncomment-region-function' both point
23272 ;; to`org-comment-or-uncomment-region'. Eventually,
23273 ;; `org-insert-comment' takes care of insertion of comments at the
23274 ;; beginning of line.
23276 ;; `org-setup-comments-handling' install comments related variables
23277 ;; during `org-mode' initialization.
23279 (defun org-setup-comments-handling ()
23280 (interactive)
23281 (org-set-local 'comment-use-syntax nil)
23282 (org-set-local 'comment-start "# ")
23283 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23284 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23285 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23286 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23288 (defun org-insert-comment ()
23289 "Insert an empty comment above current line.
23290 If the line is empty, insert comment at its beginning. When
23291 point is within a source block, comment according to the related
23292 major mode."
23293 (if (let ((element (org-element-at-point)))
23294 (and (eq (org-element-type element) 'src-block)
23295 (< (save-excursion
23296 (goto-char (org-element-property :post-affiliated element))
23297 (line-end-position))
23298 (point))
23299 (> (save-excursion
23300 (goto-char (org-element-property :end element))
23301 (skip-chars-backward " \r\t\n")
23302 (line-beginning-position))
23303 (point))))
23304 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23305 (beginning-of-line)
23306 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23307 (open-line 1))
23308 (org-indent-line)
23309 (insert "# ")))
23311 (defvar comment-empty-lines) ; From newcomment.el.
23312 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23313 "Comment or uncomment each non-blank line in the region.
23314 Uncomment each non-blank line between BEG and END if it only
23315 contains commented lines. Otherwise, comment them. If region is
23316 strictly within a source block, use appropriate comment syntax."
23317 (if (let ((element (org-element-at-point)))
23318 (and (eq (org-element-type element) 'src-block)
23319 (< (save-excursion
23320 (goto-char (org-element-property :post-affiliated element))
23321 (line-end-position))
23322 beg)
23323 (>= (save-excursion
23324 (goto-char (org-element-property :end element))
23325 (skip-chars-backward " \r\t\n")
23326 (line-beginning-position))
23327 end)))
23328 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23329 (save-restriction
23330 ;; Restrict region
23331 (narrow-to-region (save-excursion (goto-char beg)
23332 (skip-chars-forward " \r\t\n" end)
23333 (line-beginning-position))
23334 (save-excursion (goto-char end)
23335 (skip-chars-backward " \r\t\n" beg)
23336 (line-end-position)))
23337 (let ((uncommentp
23338 ;; UNCOMMENTP is non-nil when every non blank line between
23339 ;; BEG and END is a comment.
23340 (save-excursion
23341 (goto-char (point-min))
23342 (while (and (not (eobp))
23343 (let ((element (org-element-at-point)))
23344 (and (eq (org-element-type element) 'comment)
23345 (goto-char (min (point-max)
23346 (org-element-property
23347 :end element)))))))
23348 (eobp))))
23349 (if uncommentp
23350 ;; Only blank lines and comments in region: uncomment it.
23351 (save-excursion
23352 (goto-char (point-min))
23353 (while (not (eobp))
23354 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23355 (replace-match "" nil nil nil 1))
23356 (forward-line)))
23357 ;; Comment each line in region.
23358 (let ((min-indent (point-max)))
23359 ;; First find the minimum indentation across all lines.
23360 (save-excursion
23361 (goto-char (point-min))
23362 (while (and (not (eobp)) (not (zerop min-indent)))
23363 (unless (looking-at "[ \t]*$")
23364 (setq min-indent (min min-indent (current-indentation))))
23365 (forward-line)))
23366 ;; Then loop over all lines.
23367 (save-excursion
23368 (goto-char (point-min))
23369 (while (not (eobp))
23370 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23371 ;; Don't get fooled by invisible text (e.g. link path)
23372 ;; when moving to column MIN-INDENT.
23373 (let ((buffer-invisibility-spec nil))
23374 (org-move-to-column min-indent t))
23375 (insert comment-start))
23376 (forward-line)))))))))
23378 (defun org-comment-dwim (arg)
23379 "Call `comment-dwim' within a source edit buffer if needed."
23380 (interactive "*P")
23381 (if (org-in-src-block-p)
23382 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23383 (call-interactively 'comment-dwim)))
23386 ;;; Timestamps API
23388 ;; This section contains tools to operate on timestamp objects, as
23389 ;; returned by, e.g. `org-element-context'.
23391 (defun org-timestamp-has-time-p (timestamp)
23392 "Non-nil when TIMESTAMP has a time specified."
23393 (org-element-property :hour-start timestamp))
23395 (defun org-timestamp-format (timestamp format &optional end utc)
23396 "Format a TIMESTAMP element into a string.
23398 FORMAT is a format specifier to be passed to
23399 `format-time-string'.
23401 When optional argument END is non-nil, use end of date-range or
23402 time-range, if possible.
23404 When optional argument UTC is non-nil, time will be expressed as
23405 Universal Time."
23406 (format-time-string
23407 format
23408 (apply 'encode-time
23409 (cons 0
23410 (mapcar
23411 (lambda (prop) (or (org-element-property prop timestamp) 0))
23412 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23413 '(:minute-start :hour-start :day-start :month-start
23414 :year-start)))))
23415 utc))
23417 (defun org-timestamp-split-range (timestamp &optional end)
23418 "Extract a timestamp object from a date or time range.
23420 TIMESTAMP is a timestamp object. END, when non-nil, means extract
23421 the end of the range. Otherwise, extract its start.
23423 Return a new timestamp object sharing the same parent as
23424 TIMESTAMP."
23425 (let ((type (org-element-property :type timestamp)))
23426 (if (memq type '(active inactive diary)) timestamp
23427 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
23428 ;; Set new type.
23429 (org-element-put-property
23430 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23431 ;; Copy start properties over end properties if END is
23432 ;; non-nil. Otherwise, copy end properties over `start' ones.
23433 (let ((p-alist '((:minute-start . :minute-end)
23434 (:hour-start . :hour-end)
23435 (:day-start . :day-end)
23436 (:month-start . :month-end)
23437 (:year-start . :year-end))))
23438 (dolist (p-cell p-alist)
23439 (org-element-put-property
23440 split-ts
23441 (funcall (if end 'car 'cdr) p-cell)
23442 (org-element-property
23443 (funcall (if end 'cdr 'car) p-cell) split-ts)))
23444 ;; Eventually refresh `:raw-value'.
23445 (org-element-put-property split-ts :raw-value nil)
23446 (org-element-put-property
23447 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23449 (defun org-timestamp-translate (timestamp &optional boundary)
23450 "Translate TIMESTAMP object to custom format.
23452 Format string is defined in `org-time-stamp-custom-formats',
23453 which see.
23455 When optional argument BOUNDARY is non-nil, it is either the
23456 symbol `start' or `end'. In this case, only translate the
23457 starting or ending part of TIMESTAMP if it is a date or time
23458 range. Otherwise, translate both parts.
23460 Return timestamp as-is if `org-display-custom-times' is nil or if
23461 it has a `diary' type."
23462 (let ((type (org-element-property :type timestamp)))
23463 (if (or (not org-display-custom-times) (eq type 'diary))
23464 (org-element-interpret-data timestamp)
23465 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23466 org-time-stamp-custom-formats)))
23467 (if (and (not boundary) (memq type '(active-range inactive-range)))
23468 (concat (org-timestamp-format timestamp fmt)
23469 "--"
23470 (org-timestamp-format timestamp fmt t))
23471 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23475 ;;; Other stuff.
23477 (defun org-reftex-citation ()
23478 "Use reftex-citation to insert a citation into the buffer.
23479 This looks for a line like
23481 #+BIBLIOGRAPHY: foo plain option:-d
23483 and derives from it that foo.bib is the bibliography file relevant
23484 for this document. It then installs the necessary environment for RefTeX
23485 to work in this buffer and calls `reftex-citation' to insert a citation
23486 into the buffer.
23488 Export of such citations to both LaTeX and HTML is handled by the contributed
23489 package ox-bibtex by Taru Karttunen."
23490 (interactive)
23491 (let ((reftex-docstruct-symbol 'rds)
23492 (reftex-cite-format "\\cite{%l}")
23493 rds bib)
23494 (save-excursion
23495 (save-restriction
23496 (widen)
23497 (let ((case-fold-search t)
23498 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23499 (if (not (save-excursion
23500 (or (re-search-forward re nil t)
23501 (re-search-backward re nil t))))
23502 (user-error "No bibliography defined in file")
23503 (setq bib (concat (match-string 1) ".bib")
23504 rds (list (list 'bib bib)))))))
23505 (call-interactively 'reftex-citation)))
23507 ;;;; Functions extending outline functionality
23509 (defun org-beginning-of-line (&optional arg)
23510 "Go to the beginning of the current line. If that is invisible, continue
23511 to a visible line beginning. This makes the function of C-a more intuitive.
23512 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23513 first attempt, and only move to after the tags when the cursor is already
23514 beyond the end of the headline."
23515 (interactive "P")
23516 (let ((pos (point))
23517 (special (if (consp org-special-ctrl-a/e)
23518 (car org-special-ctrl-a/e)
23519 org-special-ctrl-a/e))
23520 deactivate-mark refpos)
23521 (if (org-bound-and-true-p visual-line-mode)
23522 (beginning-of-visual-line 1)
23523 (beginning-of-line 1))
23524 (if (and arg (fboundp 'move-beginning-of-line))
23525 (call-interactively 'move-beginning-of-line)
23526 (if (bobp)
23528 (backward-char 1)
23529 (if (org-truely-invisible-p)
23530 (while (and (not (bobp)) (org-truely-invisible-p))
23531 (backward-char 1)
23532 (beginning-of-line 1))
23533 (forward-char 1))))
23534 (when special
23535 (cond
23536 ((and (looking-at org-complex-heading-regexp)
23537 (= (char-after (match-end 1)) ?\ ))
23538 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23539 (point-at-eol)))
23540 (goto-char
23541 (if (eq special t)
23542 (cond ((> pos refpos) refpos)
23543 ((= pos (point)) refpos)
23544 (t (point)))
23545 (cond ((> pos (point)) (point))
23546 ((not (eq last-command this-command)) (point))
23547 (t refpos)))))
23548 ((org-at-item-p)
23549 ;; Being at an item and not looking at an the item means point
23550 ;; was previously moved to beginning of a visual line, which
23551 ;; doesn't contain the item. Therefore, do nothing special,
23552 ;; just stay here.
23553 (when (looking-at org-list-full-item-re)
23554 ;; Set special position at first white space character after
23555 ;; bullet, and check-box, if any.
23556 (let ((after-bullet
23557 (let ((box (match-end 3)))
23558 (if (not box) (match-end 1)
23559 (let ((after (char-after box)))
23560 (if (and after (= after ? )) (1+ box) box))))))
23561 ;; Special case: Move point to special position when
23562 ;; currently after it or at beginning of line.
23563 (if (eq special t)
23564 (when (or (> pos after-bullet) (= (point) pos))
23565 (goto-char after-bullet))
23566 ;; Reversed case: Move point to special position when
23567 ;; point was already at beginning of line and command is
23568 ;; repeated.
23569 (when (and (= (point) pos) (eq last-command this-command))
23570 (goto-char after-bullet))))))))
23571 (org-no-warnings
23572 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23573 (setq disable-point-adjustment
23574 (or (not (invisible-p (point)))
23575 (not (invisible-p (max (point-min) (1- (point))))))))
23577 (defun org-end-of-line (&optional arg)
23578 "Go to the end of the line.
23579 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23580 tags on the first attempt, and only move to after the tags when
23581 the cursor is already beyond the end of the headline."
23582 (interactive "P")
23583 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23584 org-special-ctrl-a/e))
23585 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23586 'end-of-visual-line)
23587 ((fboundp 'move-end-of-line) 'move-end-of-line)
23588 (t 'end-of-line)))
23589 deactivate-mark)
23590 (if (or (not special) arg) (call-interactively move-fun)
23591 (let* ((element (save-excursion (beginning-of-line)
23592 (org-element-at-point)))
23593 (type (org-element-type element)))
23594 (cond
23595 ((memq type '(headline inlinetask))
23596 (let ((pos (point)))
23597 (beginning-of-line 1)
23598 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23599 (if (eq special t)
23600 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23601 (goto-char (match-beginning 1))
23602 (goto-char (match-end 0)))
23603 (if (or (< pos (match-end 0))
23604 (not (eq this-command last-command)))
23605 (goto-char (match-end 0))
23606 (goto-char (match-beginning 1))))
23607 (call-interactively move-fun))))
23608 ((outline-invisible-p (line-end-position))
23609 ;; If element is hidden, `move-end-of-line' would put point
23610 ;; after it. Use `end-of-line' to stay on current line.
23611 (call-interactively 'end-of-line))
23612 (t (call-interactively move-fun)))))
23613 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23614 (setq disable-point-adjustment
23615 (or (not (invisible-p (point)))
23616 (not (invisible-p (max (point-min) (1- (point))))))))
23618 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23619 (define-key org-mode-map "\C-e" 'org-end-of-line)
23621 (defun org-backward-sentence (&optional arg)
23622 "Go to beginning of sentence, or beginning of table field.
23623 This will call `backward-sentence' or `org-table-beginning-of-field',
23624 depending on context."
23625 (interactive "P")
23626 (cond
23627 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
23628 (t (call-interactively 'backward-sentence))))
23630 (defun org-forward-sentence (&optional arg)
23631 "Go to end of sentence, or end of table field.
23632 This will call `forward-sentence' or `org-table-end-of-field',
23633 depending on context."
23634 (interactive "P")
23635 (cond
23636 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
23637 (t (call-interactively 'forward-sentence))))
23639 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23640 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23642 (defun org-kill-line (&optional arg)
23643 "Kill line, to tags or end of line."
23644 (interactive "P")
23645 (cond
23646 ((or (not org-special-ctrl-k)
23647 (bolp)
23648 (not (org-at-heading-p)))
23649 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23650 org-ctrl-k-protect-subtree)
23651 (if (or (eq org-ctrl-k-protect-subtree 'error)
23652 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23653 (user-error "C-k aborted as it would kill a hidden subtree")))
23654 (call-interactively
23655 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23656 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23657 (kill-region (point) (match-beginning 1))
23658 (org-set-tags nil t))
23659 (t (kill-region (point) (point-at-eol)))))
23661 (define-key org-mode-map "\C-k" 'org-kill-line)
23663 (defun org-yank (&optional arg)
23664 "Yank. If the kill is a subtree, treat it specially.
23665 This command will look at the current kill and check if is a single
23666 subtree, or a series of subtrees[1]. If it passes the test, and if the
23667 cursor is at the beginning of a line or after the stars of a currently
23668 empty headline, then the yank is handled specially. How exactly depends
23669 on the value of the following variables, both set by default.
23671 `org-yank-folded-subtrees'
23672 When set, the subtree(s) will be folded after insertion, but only
23673 if doing so would now swallow text after the yanked text.
23675 `org-yank-adjusted-subtrees'
23676 When set, the subtree will be promoted or demoted in order to
23677 fit into the local outline tree structure, which means that the
23678 level will be adjusted so that it becomes the smaller one of the
23679 two *visible* surrounding headings.
23681 Any prefix to this command will cause `yank' to be called directly with
23682 no special treatment. In particular, a simple \\[universal-argument] prefix \
23683 will just
23684 plainly yank the text as it is.
23686 \[1] The test checks if the first non-white line is a heading
23687 and if there are no other headings with fewer stars."
23688 (interactive "P")
23689 (org-yank-generic 'yank arg))
23691 (defun org-yank-generic (command arg)
23692 "Perform some yank-like command.
23694 This function implements the behavior described in the `org-yank'
23695 documentation. However, it has been generalized to work for any
23696 interactive command with similar behavior."
23698 ;; pretend to be command COMMAND
23699 (setq this-command command)
23701 (if arg
23702 (call-interactively command)
23704 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23705 (and (org-kill-is-subtree-p)
23706 (or (bolp)
23707 (and (looking-at "[ \t]*$")
23708 (string-match
23709 "\\`\\*+\\'"
23710 (buffer-substring (point-at-bol) (point)))))))
23711 swallowp)
23712 (cond
23713 ((and subtreep org-yank-folded-subtrees)
23714 (let ((beg (point))
23715 end)
23716 (if (and subtreep org-yank-adjusted-subtrees)
23717 (org-paste-subtree nil nil 'for-yank)
23718 (call-interactively command))
23720 (setq end (point))
23721 (goto-char beg)
23722 (when (and (bolp) subtreep
23723 (not (setq swallowp
23724 (org-yank-folding-would-swallow-text beg end))))
23725 (org-with-limited-levels
23726 (or (looking-at org-outline-regexp)
23727 (re-search-forward org-outline-regexp-bol end t))
23728 (while (and (< (point) end) (looking-at org-outline-regexp))
23729 (hide-subtree)
23730 (org-cycle-show-empty-lines 'folded)
23731 (condition-case nil
23732 (outline-forward-same-level 1)
23733 (error (goto-char end))))))
23734 (when swallowp
23735 (message
23736 "Inserted text not folded because that would swallow text"))
23738 (goto-char end)
23739 (skip-chars-forward " \t\n\r")
23740 (beginning-of-line 1)
23741 (push-mark beg 'nomsg)))
23742 ((and subtreep org-yank-adjusted-subtrees)
23743 (let ((beg (point-at-bol)))
23744 (org-paste-subtree nil nil 'for-yank)
23745 (push-mark beg 'nomsg)))
23747 (call-interactively command))))))
23749 (defun org-yank-folding-would-swallow-text (beg end)
23750 "Would hide-subtree at BEG swallow any text after END?"
23751 (let (level)
23752 (org-with-limited-levels
23753 (save-excursion
23754 (goto-char beg)
23755 (when (or (looking-at org-outline-regexp)
23756 (re-search-forward org-outline-regexp-bol end t))
23757 (setq level (org-outline-level)))
23758 (goto-char end)
23759 (skip-chars-forward " \t\r\n\v\f")
23760 (if (or (eobp)
23761 (and (bolp) (looking-at org-outline-regexp)
23762 (<= (org-outline-level) level)))
23763 nil ; Nothing would be swallowed
23764 t))))) ; something would swallow
23766 (define-key org-mode-map "\C-y" 'org-yank)
23768 (defun org-truely-invisible-p ()
23769 "Check if point is at a character currently not visible.
23770 This version does not only check the character property, but also
23771 `visible-mode'."
23772 ;; Early versions of noutline don't have `outline-invisible-p'.
23773 (if (org-bound-and-true-p visible-mode)
23775 (outline-invisible-p)))
23777 (defun org-invisible-p2 ()
23778 "Check if point is at a character currently not visible."
23779 (save-excursion
23780 (if (and (eolp) (not (bobp))) (backward-char 1))
23781 ;; Early versions of noutline don't have `outline-invisible-p'.
23782 (outline-invisible-p)))
23784 (defun org-back-to-heading (&optional invisible-ok)
23785 "Call `outline-back-to-heading', but provide a better error message."
23786 (condition-case nil
23787 (outline-back-to-heading invisible-ok)
23788 (error (error "Before first headline at position %d in buffer %s"
23789 (point) (current-buffer)))))
23791 (defun org-before-first-heading-p ()
23792 "Before first heading?"
23793 (save-excursion
23794 (end-of-line)
23795 (null (re-search-backward org-outline-regexp-bol nil t))))
23797 (defun org-at-heading-p (&optional ignored)
23798 (outline-on-heading-p t))
23799 ;; Compatibility alias with Org versions < 7.8.03
23800 (defalias 'org-on-heading-p 'org-at-heading-p)
23802 (defun org-in-commented-heading-p (&optional no-inheritance)
23803 "Non-nil if point is under a commented heading.
23804 This function also checks ancestors of the current headline,
23805 unless optional argument NO-INHERITANCE is non-nil."
23806 (cond
23807 ((org-before-first-heading-p) nil)
23808 ((let ((headline (nth 4 (org-heading-components))))
23809 (and headline
23810 (let ((case-fold-search nil))
23811 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
23812 headline)))))
23813 (no-inheritance nil)
23815 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
23817 (defun org-at-comment-p nil
23818 "Is cursor in a commented line?"
23819 (save-excursion
23820 (save-match-data
23821 (beginning-of-line)
23822 (looking-at "^[ \t]*# "))))
23824 (defun org-at-drawer-p nil
23825 "Is cursor at a drawer keyword?"
23826 (save-excursion
23827 (move-beginning-of-line 1)
23828 (looking-at org-drawer-regexp)))
23830 (defun org-at-block-p nil
23831 "Is cursor at a block keyword?"
23832 (save-excursion
23833 (move-beginning-of-line 1)
23834 (looking-at org-block-regexp)))
23836 (defun org-point-at-end-of-empty-headline ()
23837 "If point is at the end of an empty headline, return t, else nil.
23838 If the heading only contains a TODO keyword, it is still still considered
23839 empty."
23840 (and (looking-at "[ \t]*$")
23841 (when org-todo-line-regexp
23842 (save-excursion
23843 (beginning-of-line 1)
23844 (let ((case-fold-search nil))
23845 (looking-at org-todo-line-regexp)
23846 (string= (match-string 3) ""))))))
23848 (defun org-at-heading-or-item-p ()
23849 (or (org-at-heading-p) (org-at-item-p)))
23851 (defun org-at-target-p ()
23852 (or (org-in-regexp org-radio-target-regexp)
23853 (org-in-regexp org-target-regexp)))
23854 ;; Compatibility alias with Org versions < 7.8.03
23855 (defalias 'org-on-target-p 'org-at-target-p)
23857 (defun org-up-heading-all (arg)
23858 "Move to the heading line of which the present line is a subheading.
23859 This function considers both visible and invisible heading lines.
23860 With argument, move up ARG levels."
23861 (if (fboundp 'outline-up-heading-all)
23862 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23863 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23865 (defun org-up-heading-safe ()
23866 "Move to the heading line of which the present line is a subheading.
23867 This version will not throw an error. It will return the level of the
23868 headline found, or nil if no higher level is found.
23870 Also, this function will be a lot faster than `outline-up-heading',
23871 because it relies on stars being the outline starters. This can really
23872 make a significant difference in outlines with very many siblings."
23873 (when (ignore-errors (org-back-to-heading t))
23874 (let ((level-up (1- (funcall outline-level))))
23875 (and (> level-up 0)
23876 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
23877 (funcall outline-level)))))
23879 (defun org-first-sibling-p ()
23880 "Is this heading the first child of its parents?"
23881 (interactive)
23882 (let ((re org-outline-regexp-bol)
23883 level l)
23884 (unless (org-at-heading-p t)
23885 (user-error "Not at a heading"))
23886 (setq level (funcall outline-level))
23887 (save-excursion
23888 (if (not (re-search-backward re nil t))
23890 (setq l (funcall outline-level))
23891 (< l level)))))
23893 (defun org-goto-sibling (&optional previous)
23894 "Goto the next sibling, even if it is invisible.
23895 When PREVIOUS is set, go to the previous sibling instead. Returns t
23896 when a sibling was found. When none is found, return nil and don't
23897 move point."
23898 (let ((fun (if previous 're-search-backward 're-search-forward))
23899 (pos (point))
23900 (re org-outline-regexp-bol)
23901 level l)
23902 (when (ignore-errors (org-back-to-heading t))
23903 (setq level (funcall outline-level))
23904 (catch 'exit
23905 (or previous (forward-char 1))
23906 (while (funcall fun re nil t)
23907 (setq l (funcall outline-level))
23908 (when (< l level) (goto-char pos) (throw 'exit nil))
23909 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23910 (goto-char pos)
23911 nil))))
23913 (defun org-show-siblings ()
23914 "Show all siblings of the current headline."
23915 (save-excursion
23916 (while (org-goto-sibling) (org-flag-heading nil)))
23917 (save-excursion
23918 (while (org-goto-sibling 'previous)
23919 (org-flag-heading nil))))
23921 (defun org-goto-first-child ()
23922 "Goto the first child, even if it is invisible.
23923 Return t when a child was found. Otherwise don't move point and
23924 return nil."
23925 (let (level (pos (point)) (re org-outline-regexp-bol))
23926 (when (ignore-errors (org-back-to-heading t))
23927 (setq level (outline-level))
23928 (forward-char 1)
23929 (if (and (re-search-forward re nil t) (> (outline-level) level))
23930 (progn (goto-char (match-beginning 0)) t)
23931 (goto-char pos) nil))))
23933 (defun org-show-hidden-entry ()
23934 "Show an entry where even the heading is hidden."
23935 (save-excursion
23936 (org-show-entry)))
23938 (defun org-flag-heading (flag &optional entry)
23939 "Flag the current heading. FLAG non-nil means make invisible.
23940 When ENTRY is non-nil, show the entire entry."
23941 (save-excursion
23942 (org-back-to-heading t)
23943 ;; Check if we should show the entire entry
23944 (if entry
23945 (progn
23946 (org-show-entry)
23947 (save-excursion
23948 (and (outline-next-heading)
23949 (org-flag-heading nil))))
23950 (outline-flag-region (max (point-min) (1- (point)))
23951 (save-excursion (outline-end-of-heading) (point))
23952 flag))))
23954 (defun org-get-next-sibling ()
23955 "Move to next heading of the same level, and return point.
23956 If there is no such heading, return nil.
23957 This is like outline-next-sibling, but invisible headings are ok."
23958 (let ((level (funcall outline-level)))
23959 (outline-next-heading)
23960 (while (and (not (eobp)) (> (funcall outline-level) level))
23961 (outline-next-heading))
23962 (if (or (eobp) (< (funcall outline-level) level))
23964 (point))))
23966 (defun org-get-last-sibling ()
23967 "Move to previous heading of the same level, and return point.
23968 If there is no such heading, return nil."
23969 (let ((opoint (point))
23970 (level (funcall outline-level)))
23971 (outline-previous-heading)
23972 (when (and (/= (point) opoint) (outline-on-heading-p t))
23973 (while (and (> (funcall outline-level) level)
23974 (not (bobp)))
23975 (outline-previous-heading))
23976 (if (< (funcall outline-level) level)
23978 (point)))))
23980 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23981 "Goto to the end of a subtree."
23982 ;; This contains an exact copy of the original function, but it uses
23983 ;; `org-back-to-heading', to make it work also in invisible
23984 ;; trees. And is uses an invisible-ok argument.
23985 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23986 ;; Furthermore, when used inside Org, finding the end of a large subtree
23987 ;; with many children and grandchildren etc, this can be much faster
23988 ;; than the outline version.
23989 (org-back-to-heading invisible-ok)
23990 (let ((first t)
23991 (level (funcall outline-level)))
23992 (if (and (derived-mode-p 'org-mode) (< level 1000))
23993 ;; A true heading (not a plain list item), in Org-mode
23994 ;; This means we can easily find the end by looking
23995 ;; only for the right number of stars. Using a regexp to do
23996 ;; this is so much faster than using a Lisp loop.
23997 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
23998 (forward-char 1)
23999 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24000 ;; something else, do it the slow way
24001 (while (and (not (eobp))
24002 (or first (> (funcall outline-level) level)))
24003 (setq first nil)
24004 (outline-next-heading)))
24005 (unless to-heading
24006 (if (memq (preceding-char) '(?\n ?\^M))
24007 (progn
24008 ;; Go to end of line before heading
24009 (forward-char -1)
24010 (if (memq (preceding-char) '(?\n ?\^M))
24011 ;; leave blank line before heading
24012 (forward-char -1))))))
24013 (point))
24015 (defun org-end-of-meta-data (&optional full)
24016 "Skip planning line and properties drawer in current entry.
24017 When optional argument FULL is non-nil, also skip empty lines,
24018 clocking lines and regular drawers at the beginning of the
24019 entry."
24020 (org-back-to-heading t)
24021 (forward-line)
24022 (when (org-looking-at-p org-planning-line-re) (forward-line))
24023 (when (looking-at org-property-drawer-re)
24024 (goto-char (match-end 0))
24025 (forward-line))
24026 (when (and full (not (org-at-heading-p)))
24027 (catch 'exit
24028 (let ((end (save-excursion (outline-next-heading) (point)))
24029 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24030 (while (not (eobp))
24031 (cond ((org-looking-at-p org-drawer-regexp)
24032 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24033 (forward-line)
24034 (throw 'exit t)))
24035 ((org-looking-at-p re) (forward-line))
24036 (t (throw 'exit t))))))))
24038 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24039 "Move forward to the ARG'th subheading at same level as this one.
24040 Stop at the first and last subheadings of a superior heading.
24041 Normally this only looks at visible headings, but when INVISIBLE-OK is
24042 non-nil it will also look at invisible ones."
24043 (interactive "p")
24044 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24045 (if (and arg (< arg 0))
24046 (goto-char (point-min))
24047 (outline-next-heading))
24048 (org-at-heading-p)
24049 (let ((level (- (match-end 0) (match-beginning 0) 1))
24050 (f (if (and arg (< arg 0))
24051 're-search-backward
24052 're-search-forward))
24053 (count (if arg (abs arg) 1))
24054 (result (point)))
24055 (while (and (prog1 (> count 0)
24056 (forward-char (if (and arg (< arg 0)) -1 1)))
24057 (funcall f org-outline-regexp-bol nil 'move))
24058 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24059 (cond ((< l level) (setq count 0))
24060 ((and (= l level)
24061 (or invisible-ok
24062 (progn
24063 (goto-char (line-beginning-position))
24064 (not (outline-invisible-p)))))
24065 (setq count (1- count))
24066 (when (eq l level)
24067 (setq result (point)))))))
24068 (goto-char result))
24069 (beginning-of-line 1)))
24071 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24072 "Move backward to the ARG'th subheading at same level as this one.
24073 Stop at the first and last subheadings of a superior heading."
24074 (interactive "p")
24075 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24077 (defun org-next-visible-heading (arg)
24078 "Move to the next visible heading.
24080 This function wraps `outline-next-visible-heading' with
24081 `org-with-limited-levels' in order to skip over inline tasks and
24082 respect customization of `org-odd-levels-only'."
24083 (interactive "p")
24084 (org-with-limited-levels
24085 (outline-next-visible-heading arg)))
24087 (defun org-previous-visible-heading (arg)
24088 "Move to the next visible heading.
24090 This function wraps `outline-previous-visible-heading' with
24091 `org-with-limited-levels' in order to skip over inline tasks and
24092 respect customization of `org-odd-levels-only'."
24093 (interactive "p")
24094 (org-with-limited-levels
24095 (outline-previous-visible-heading arg)))
24097 (defun org-next-block (arg &optional backward block-regexp)
24098 "Jump to the next block.
24099 With a prefix argument ARG, jump forward ARG many source blocks.
24100 When BACKWARD is non-nil, jump to the previous block.
24101 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24102 (interactive "p")
24103 (let ((re (or block-regexp org-block-regexp))
24104 (re-search-fn (or (and backward 're-search-backward)
24105 're-search-forward)))
24106 (if (looking-at re) (forward-char 1))
24107 (condition-case nil
24108 (funcall re-search-fn re nil nil arg)
24109 (error (user-error "No %s code blocks"
24110 (if backward "previous" "further" ))))
24111 (goto-char (match-beginning 0)) (org-show-context)))
24113 (defun org-previous-block (arg &optional block-regexp)
24114 "Jump to the previous block.
24115 With a prefix argument ARG, jump backward ARG many source blocks.
24116 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24117 (interactive "p")
24118 (org-next-block arg t block-regexp))
24120 (defun org-forward-paragraph ()
24121 "Move forward to beginning of next paragraph or equivalent.
24123 The function moves point to the beginning of the next visible
24124 structural element, which can be a paragraph, a table, a list
24125 item, etc. It also provides some special moves for convenience:
24127 - On an affiliated keyword, jump to the beginning of the
24128 relative element.
24129 - On an item or a footnote definition, move to the second
24130 element inside, if any.
24131 - On a table or a property drawer, jump after it.
24132 - On a verse or source block, stop after blank lines."
24133 (interactive)
24134 (when (eobp) (user-error "Cannot move further down"))
24135 (let* ((deactivate-mark nil)
24136 (element (org-element-at-point))
24137 (type (org-element-type element))
24138 (post-affiliated (org-element-property :post-affiliated element))
24139 (contents-begin (org-element-property :contents-begin element))
24140 (contents-end (org-element-property :contents-end element))
24141 (end (let ((end (org-element-property :end element)) (parent element))
24142 (while (and (setq parent (org-element-property :parent parent))
24143 (= (org-element-property :contents-end parent) end))
24144 (setq end (org-element-property :end parent)))
24145 end)))
24146 (cond ((not element)
24147 (skip-chars-forward " \r\t\n")
24148 (or (eobp) (beginning-of-line)))
24149 ;; On affiliated keywords, move to element's beginning.
24150 ((< (point) post-affiliated)
24151 (goto-char post-affiliated))
24152 ;; At a table row, move to the end of the table. Similarly,
24153 ;; at a node property, move to the end of the property
24154 ;; drawer.
24155 ((memq type '(node-property table-row))
24156 (goto-char (org-element-property
24157 :end (org-element-property :parent element))))
24158 ((memq type '(property-drawer table)) (goto-char end))
24159 ;; Consider blank lines as separators in verse and source
24160 ;; blocks to ease editing.
24161 ((memq type '(src-block verse-block))
24162 (when (eq type 'src-block)
24163 (setq contents-end
24164 (save-excursion (goto-char end)
24165 (skip-chars-backward " \r\t\n")
24166 (line-beginning-position))))
24167 (beginning-of-line)
24168 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24169 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24170 (goto-char end)
24171 (skip-chars-forward " \r\t\n")
24172 (if (= (point) contents-end) (goto-char end)
24173 (beginning-of-line))))
24174 ;; With no contents, just skip element.
24175 ((not contents-begin) (goto-char end))
24176 ;; If contents are invisible, skip the element altogether.
24177 ((outline-invisible-p (line-end-position))
24178 (case type
24179 (headline
24180 (org-with-limited-levels (outline-next-visible-heading 1)))
24181 ;; At a plain list, make sure we move to the next item
24182 ;; instead of skipping the whole list.
24183 (plain-list (forward-char)
24184 (org-forward-paragraph))
24185 (otherwise (goto-char end))))
24186 ((>= (point) contents-end) (goto-char end))
24187 ((>= (point) contents-begin)
24188 ;; This can only happen on paragraphs and plain lists.
24189 (case type
24190 (paragraph (goto-char end))
24191 ;; At a plain list, try to move to second element in
24192 ;; first item, if possible.
24193 (plain-list (end-of-line)
24194 (org-forward-paragraph))))
24195 ;; When contents start on the middle of a line (e.g. in
24196 ;; items and footnote definitions), try to reach first
24197 ;; element starting after current line.
24198 ((> (line-end-position) contents-begin)
24199 (end-of-line)
24200 (org-forward-paragraph))
24201 (t (goto-char contents-begin)))))
24203 (defun org-backward-paragraph ()
24204 "Move backward to start of previous paragraph or equivalent.
24206 The function moves point to the beginning of the current
24207 structural element, which can be a paragraph, a table, a list
24208 item, etc., or to the beginning of the previous visible one if
24209 point is already there. It also provides some special moves for
24210 convenience:
24212 - On an affiliated keyword, jump to the first one.
24213 - On a table or a property drawer, move to its beginning.
24214 - On a verse or source block, stop before blank lines."
24215 (interactive)
24216 (when (bobp) (user-error "Cannot move further up"))
24217 (let* ((deactivate-mark nil)
24218 (element (org-element-at-point))
24219 (type (org-element-type element))
24220 (contents-begin (org-element-property :contents-begin element))
24221 (contents-end (org-element-property :contents-end element))
24222 (post-affiliated (org-element-property :post-affiliated element))
24223 (begin (org-element-property :begin element)))
24224 (cond
24225 ((not element) (goto-char (point-min)))
24226 ((= (point) begin)
24227 (backward-char)
24228 (org-backward-paragraph))
24229 ((<= (point) post-affiliated) (goto-char begin))
24230 ((memq type '(node-property table-row))
24231 (goto-char (org-element-property
24232 :post-affiliated (org-element-property :parent element))))
24233 ((memq type '(property-drawer table)) (goto-char begin))
24234 ((memq type '(src-block verse-block))
24235 (when (eq type 'src-block)
24236 (setq contents-begin
24237 (save-excursion (goto-char begin) (forward-line) (point))))
24238 (if (= (point) contents-begin) (goto-char post-affiliated)
24239 ;; Inside a verse block, see blank lines as paragraph
24240 ;; separators.
24241 (let ((origin (point)))
24242 (skip-chars-backward " \r\t\n" contents-begin)
24243 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24244 (skip-chars-forward " \r\t\n" origin)
24245 (if (= (point) origin) (goto-char contents-begin)
24246 (beginning-of-line))))))
24247 ((not contents-begin) (goto-char (or post-affiliated begin)))
24248 ((eq type 'paragraph)
24249 (goto-char contents-begin)
24250 ;; When at first paragraph in an item or a footnote definition,
24251 ;; move directly to beginning of line.
24252 (let ((parent-contents
24253 (org-element-property
24254 :contents-begin (org-element-property :parent element))))
24255 (when (and parent-contents (= parent-contents contents-begin))
24256 (beginning-of-line))))
24257 ;; At the end of a greater element, move to the beginning of the
24258 ;; last element within.
24259 ((>= (point) contents-end)
24260 (goto-char (1- contents-end))
24261 (org-backward-paragraph))
24262 (t (goto-char (or post-affiliated begin))))
24263 ;; Ensure we never leave point invisible.
24264 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24266 (defun org-forward-element ()
24267 "Move forward by one element.
24268 Move to the next element at the same level, when possible."
24269 (interactive)
24270 (cond ((eobp) (user-error "Cannot move further down"))
24271 ((org-with-limited-levels (org-at-heading-p))
24272 (let ((origin (point)))
24273 (goto-char (org-end-of-subtree nil t))
24274 (unless (org-with-limited-levels (org-at-heading-p))
24275 (goto-char origin)
24276 (user-error "Cannot move further down"))))
24278 (let* ((elem (org-element-at-point))
24279 (end (org-element-property :end elem))
24280 (parent (org-element-property :parent elem)))
24281 (cond ((and parent (= (org-element-property :contents-end parent) end))
24282 (goto-char (org-element-property :end parent)))
24283 ((integer-or-marker-p end) (goto-char end))
24284 (t (message "No element at point")))))))
24286 (defun org-backward-element ()
24287 "Move backward by one element.
24288 Move to the previous element at the same level, when possible."
24289 (interactive)
24290 (cond ((bobp) (user-error "Cannot move further up"))
24291 ((org-with-limited-levels (org-at-heading-p))
24292 ;; At a headline, move to the previous one, if any, or stay
24293 ;; here.
24294 (let ((origin (point)))
24295 (org-with-limited-levels (org-backward-heading-same-level 1))
24296 ;; When current headline has no sibling above, move to its
24297 ;; parent.
24298 (when (= (point) origin)
24299 (or (org-with-limited-levels (org-up-heading-safe))
24300 (progn (goto-char origin)
24301 (user-error "Cannot move further up"))))))
24303 (let* ((elem (org-element-at-point))
24304 (beg (org-element-property :begin elem)))
24305 (cond
24306 ;; Move to beginning of current element if point isn't
24307 ;; there already.
24308 ((null beg) (message "No element at point"))
24309 ((/= (point) beg) (goto-char beg))
24310 (t (goto-char beg)
24311 (skip-chars-backward " \r\t\n")
24312 (unless (bobp)
24313 (let ((prev (org-element-at-point)))
24314 (goto-char (org-element-property :begin prev))
24315 (while (and (setq prev (org-element-property :parent prev))
24316 (<= (org-element-property :end prev) beg))
24317 (goto-char (org-element-property :begin prev)))))))))))
24319 (defun org-up-element ()
24320 "Move to upper element."
24321 (interactive)
24322 (if (org-with-limited-levels (org-at-heading-p))
24323 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24324 (let* ((elem (org-element-at-point))
24325 (parent (org-element-property :parent elem)))
24326 (if parent (goto-char (org-element-property :begin parent))
24327 (if (org-with-limited-levels (org-before-first-heading-p))
24328 (user-error "No surrounding element")
24329 (org-with-limited-levels (org-back-to-heading)))))))
24331 (defvar org-element-greater-elements)
24332 (defun org-down-element ()
24333 "Move to inner element."
24334 (interactive)
24335 (let ((element (org-element-at-point)))
24336 (cond
24337 ((memq (org-element-type element) '(plain-list table))
24338 (goto-char (org-element-property :contents-begin element))
24339 (forward-char))
24340 ((memq (org-element-type element) org-element-greater-elements)
24341 ;; If contents are hidden, first disclose them.
24342 (when (outline-invisible-p (line-end-position)) (org-cycle))
24343 (goto-char (or (org-element-property :contents-begin element)
24344 (user-error "No content for this element"))))
24345 (t (user-error "No inner element")))))
24347 (defun org-drag-element-backward ()
24348 "Move backward element at point."
24349 (interactive)
24350 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24351 (let* ((elem (org-element-at-point))
24352 (prev-elem
24353 (save-excursion
24354 (goto-char (org-element-property :begin elem))
24355 (skip-chars-backward " \r\t\n")
24356 (unless (bobp)
24357 (let* ((beg (org-element-property :begin elem))
24358 (prev (org-element-at-point))
24359 (up prev))
24360 (while (and (setq up (org-element-property :parent up))
24361 (<= (org-element-property :end up) beg))
24362 (setq prev up))
24363 prev)))))
24364 ;; Error out if no previous element or previous element is
24365 ;; a parent of the current one.
24366 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24367 (user-error "Cannot drag element backward")
24368 (let ((pos (point)))
24369 (org-element-swap-A-B prev-elem elem)
24370 (goto-char (+ (org-element-property :begin prev-elem)
24371 (- pos (org-element-property :begin elem)))))))))
24373 (defun org-drag-element-forward ()
24374 "Move forward element at point."
24375 (interactive)
24376 (let* ((pos (point))
24377 (elem (org-element-at-point)))
24378 (when (= (point-max) (org-element-property :end elem))
24379 (user-error "Cannot drag element forward"))
24380 (goto-char (org-element-property :end elem))
24381 (let ((next-elem (org-element-at-point)))
24382 (when (or (org-element-nested-p elem next-elem)
24383 (and (eq (org-element-type next-elem) 'headline)
24384 (not (eq (org-element-type elem) 'headline))))
24385 (goto-char pos)
24386 (user-error "Cannot drag element forward"))
24387 ;; Compute new position of point: it's shifted by NEXT-ELEM
24388 ;; body's length (without final blanks) and by the length of
24389 ;; blanks between ELEM and NEXT-ELEM.
24390 (let ((size-next (- (save-excursion
24391 (goto-char (org-element-property :end next-elem))
24392 (skip-chars-backward " \r\t\n")
24393 (forward-line)
24394 ;; Small correction if buffer doesn't end
24395 ;; with a newline character.
24396 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24397 (org-element-property :begin next-elem)))
24398 (size-blank (- (org-element-property :end elem)
24399 (save-excursion
24400 (goto-char (org-element-property :end elem))
24401 (skip-chars-backward " \r\t\n")
24402 (forward-line)
24403 (point)))))
24404 (org-element-swap-A-B elem next-elem)
24405 (goto-char (+ pos size-next size-blank))))))
24407 (defun org-drag-line-forward (arg)
24408 "Drag the line at point ARG lines forward."
24409 (interactive "p")
24410 (dotimes (n (abs arg))
24411 (let ((c (current-column)))
24412 (if (< 0 arg)
24413 (progn
24414 (beginning-of-line 2)
24415 (transpose-lines 1)
24416 (beginning-of-line 0))
24417 (transpose-lines 1)
24418 (beginning-of-line -1))
24419 (org-move-to-column c))))
24421 (defun org-drag-line-backward (arg)
24422 "Drag the line at point ARG lines backward."
24423 (interactive "p")
24424 (org-drag-line-forward (- arg)))
24426 (defun org-mark-element ()
24427 "Put point at beginning of this element, mark at end.
24429 Interactively, if this command is repeated or (in Transient Mark
24430 mode) if the mark is active, it marks the next element after the
24431 ones already marked."
24432 (interactive)
24433 (let (deactivate-mark)
24434 (if (and (org-called-interactively-p 'any)
24435 (or (and (eq last-command this-command) (mark t))
24436 (and transient-mark-mode mark-active)))
24437 (set-mark
24438 (save-excursion
24439 (goto-char (mark))
24440 (goto-char (org-element-property :end (org-element-at-point)))))
24441 (let ((element (org-element-at-point)))
24442 (end-of-line)
24443 (push-mark (org-element-property :end element) t t)
24444 (goto-char (org-element-property :begin element))))))
24446 (defun org-narrow-to-element ()
24447 "Narrow buffer to current element."
24448 (interactive)
24449 (let ((elem (org-element-at-point)))
24450 (cond
24451 ((eq (car elem) 'headline)
24452 (narrow-to-region
24453 (org-element-property :begin elem)
24454 (org-element-property :end elem)))
24455 ((memq (car elem) org-element-greater-elements)
24456 (narrow-to-region
24457 (org-element-property :contents-begin elem)
24458 (org-element-property :contents-end elem)))
24460 (narrow-to-region
24461 (org-element-property :begin elem)
24462 (org-element-property :end elem))))))
24464 (defun org-transpose-element ()
24465 "Transpose current and previous elements, keeping blank lines between.
24466 Point is moved after both elements."
24467 (interactive)
24468 (org-skip-whitespace)
24469 (let ((end (org-element-property :end (org-element-at-point))))
24470 (org-drag-element-backward)
24471 (goto-char end)))
24473 (defun org-unindent-buffer ()
24474 "Un-indent the visible part of the buffer.
24475 Relative indentation (between items, inside blocks, etc.) isn't
24476 modified."
24477 (interactive)
24478 (unless (eq major-mode 'org-mode)
24479 (user-error "Cannot un-indent a buffer not in Org mode"))
24480 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24481 unindent-tree ; For byte-compiler.
24482 (unindent-tree
24483 (function
24484 (lambda (contents)
24485 (mapc
24486 (lambda (element)
24487 (if (memq (org-element-type element) '(headline section))
24488 (funcall unindent-tree (org-element-contents element))
24489 (save-excursion
24490 (save-restriction
24491 (narrow-to-region
24492 (org-element-property :begin element)
24493 (org-element-property :end element))
24494 (org-do-remove-indentation)))))
24495 (reverse contents))))))
24496 (funcall unindent-tree (org-element-contents parse-tree))))
24498 (defun org-show-subtree ()
24499 "Show everything after this heading at deeper levels."
24500 (interactive)
24501 (outline-flag-region
24502 (point)
24503 (save-excursion
24504 (org-end-of-subtree t t))
24505 nil))
24507 (defun org-show-entry ()
24508 "Show the body directly following this heading.
24509 Show the heading too, if it is currently invisible."
24510 (interactive)
24511 (save-excursion
24512 (ignore-errors
24513 (org-back-to-heading t)
24514 (outline-flag-region
24515 (max (point-min) (1- (point)))
24516 (save-excursion
24517 (if (re-search-forward
24518 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24519 (match-beginning 1)
24520 (point-max)))
24521 nil)
24522 (org-cycle-hide-drawers 'children))))
24524 (defun org-make-options-regexp (kwds &optional extra)
24525 "Make a regular expression for keyword lines.
24526 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24527 when non-nil, is a regexp matching keywords names."
24528 (concat "^[ \t]*#\\+\\("
24529 (regexp-opt kwds)
24530 (and extra (concat (and kwds "\\|") extra))
24531 "\\):[ \t]*\\(.*\\)"))
24533 ;; Make isearch reveal the necessary context
24534 (defun org-isearch-end ()
24535 "Reveal context after isearch exits."
24536 (when isearch-success ; only if search was successful
24537 (if (featurep 'xemacs)
24538 ;; Under XEmacs, the hook is run in the correct place,
24539 ;; we directly show the context.
24540 (org-show-context 'isearch)
24541 ;; In Emacs the hook runs *before* restoring the overlays.
24542 ;; So we have to use a one-time post-command-hook to do this.
24543 ;; (Emacs 22 has a special variable, see function `org-mode')
24544 (unless (and (boundp 'isearch-mode-end-hook-quit)
24545 isearch-mode-end-hook-quit)
24546 ;; Only when the isearch was not quitted.
24547 (org-add-hook 'post-command-hook 'org-isearch-post-command
24548 'append 'local)))))
24550 (defun org-isearch-post-command ()
24551 "Remove self from hook, and show context."
24552 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24553 (org-show-context 'isearch))
24556 ;;;; Integration with and fixes for other packages
24558 ;;; Imenu support
24560 (defvar org-imenu-markers nil
24561 "All markers currently used by Imenu.")
24562 (make-variable-buffer-local 'org-imenu-markers)
24564 (defun org-imenu-new-marker (&optional pos)
24565 "Return a new marker for use by Imenu, and remember the marker."
24566 (let ((m (make-marker)))
24567 (move-marker m (or pos (point)))
24568 (push m org-imenu-markers)
24571 (defun org-imenu-get-tree ()
24572 "Produce the index for Imenu."
24573 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24574 (setq org-imenu-markers nil)
24575 (let* ((n org-imenu-depth)
24576 (re (concat "^" (org-get-limited-outline-regexp)))
24577 (subs (make-vector (1+ n) nil))
24578 (last-level 0)
24579 m level head0 head)
24580 (save-excursion
24581 (save-restriction
24582 (widen)
24583 (goto-char (point-max))
24584 (while (re-search-backward re nil t)
24585 (setq level (org-reduced-level (funcall outline-level)))
24586 (when (and (<= level n)
24587 (looking-at org-complex-heading-regexp)
24588 (setq head0 (org-match-string-no-properties 4)))
24589 (setq head (org-link-display-format head0)
24590 m (org-imenu-new-marker))
24591 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24592 (if (>= level last-level)
24593 (push (cons head m) (aref subs level))
24594 (push (cons head (aref subs (1+ level))) (aref subs level))
24595 (loop for i from (1+ level) to n do (aset subs i nil)))
24596 (setq last-level level)))))
24597 (aref subs 1)))
24599 (eval-after-load "imenu"
24600 '(progn
24601 (add-hook 'imenu-after-jump-hook
24602 (lambda ()
24603 (if (derived-mode-p 'org-mode)
24604 (org-show-context 'org-goto))))))
24606 (defun org-link-display-format (link)
24607 "Replace a link with its the description.
24608 If there is no description, use the link target."
24609 (save-match-data
24610 (if (string-match org-bracket-link-analytic-regexp link)
24611 (replace-match (if (match-end 5)
24612 (match-string 5 link)
24613 (concat (match-string 1 link)
24614 (match-string 3 link)))
24615 nil t link)
24616 link)))
24618 (defun org-toggle-link-display ()
24619 "Toggle the literal or descriptive display of links."
24620 (interactive)
24621 (if org-descriptive-links
24622 (progn (org-remove-from-invisibility-spec '(org-link))
24623 (org-restart-font-lock)
24624 (setq org-descriptive-links nil))
24625 (progn (add-to-invisibility-spec '(org-link))
24626 (org-restart-font-lock)
24627 (setq org-descriptive-links t))))
24629 ;; Speedbar support
24631 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24632 "Overlay marking the agenda restriction line in speedbar.")
24633 (overlay-put org-speedbar-restriction-lock-overlay
24634 'face 'org-agenda-restriction-lock)
24635 (overlay-put org-speedbar-restriction-lock-overlay
24636 'help-echo "Agendas are currently limited to this item.")
24637 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24639 (defun org-speedbar-set-agenda-restriction ()
24640 "Restrict future agenda commands to the location at point in speedbar.
24641 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24642 (interactive)
24643 (require 'org-agenda)
24644 (let (p m tp np dir txt)
24645 (cond
24646 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24647 'org-imenu t))
24648 (setq m (get-text-property p 'org-imenu-marker))
24649 (with-current-buffer (marker-buffer m)
24650 (goto-char m)
24651 (org-agenda-set-restriction-lock 'subtree)))
24652 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24653 'speedbar-function 'speedbar-find-file))
24654 (setq tp (previous-single-property-change
24655 (1+ p) 'speedbar-function)
24656 np (next-single-property-change
24657 tp 'speedbar-function)
24658 dir (speedbar-line-directory)
24659 txt (buffer-substring-no-properties (or tp (point-min))
24660 (or np (point-max))))
24661 (with-current-buffer (find-file-noselect
24662 (let ((default-directory dir))
24663 (expand-file-name txt)))
24664 (unless (derived-mode-p 'org-mode)
24665 (user-error "Cannot restrict to non-Org-mode file"))
24666 (org-agenda-set-restriction-lock 'file)))
24667 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24668 (move-overlay org-speedbar-restriction-lock-overlay
24669 (point-at-bol) (point-at-eol))
24670 (setq current-prefix-arg nil)
24671 (org-agenda-maybe-redo)))
24673 (defvar speedbar-file-key-map)
24674 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24675 (eval-after-load "speedbar"
24676 '(progn
24677 (speedbar-add-supported-extension ".org")
24678 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24679 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24680 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24681 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24682 (add-hook 'speedbar-visiting-tag-hook
24683 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24685 ;;; Fixes and Hacks for problems with other packages
24687 (defun org--flyspell-object-check-p (element)
24688 "Non-nil when Flyspell can check object at point.
24689 ELEMENT is the element at point."
24690 (let ((object (save-excursion
24691 (when (org-looking-at-p "\\>") (backward-char))
24692 (org-element-context element))))
24693 (case (org-element-type object)
24694 ;; Prevent checks in links due to keybinding conflict with
24695 ;; Flyspell.
24696 ((code entity export-snippet inline-babel-call
24697 inline-src-block line-break latex-fragment link macro
24698 statistics-cookie target timestamp verbatim)
24699 nil)
24700 (footnote-reference
24701 ;; Only in inline footnotes, within the definition.
24702 (and (eq (org-element-property :type object) 'inline)
24703 (< (save-excursion
24704 (goto-char (org-element-property :begin object))
24705 (search-forward ":" nil t 2))
24706 (point))))
24707 (otherwise t))))
24709 (defun org-mode-flyspell-verify ()
24710 "Function used for `flyspell-generic-check-word-predicate'."
24711 (if (org-at-heading-p)
24712 ;; At a headline or an inlinetask, check title only. This is
24713 ;; faster than relying on `org-element-at-point'.
24714 (and (save-excursion (beginning-of-line)
24715 (and (let ((case-fold-search t))
24716 (not (looking-at "\\*+ END[ \t]*$")))
24717 (looking-at org-complex-heading-regexp)))
24718 (match-beginning 4)
24719 (>= (point) (match-beginning 4))
24720 (or (not (match-beginning 5))
24721 (< (point) (match-beginning 5))))
24722 (let* ((element (org-element-at-point))
24723 (post-affiliated (org-element-property :post-affiliated element)))
24724 (cond
24725 ;; Ignore checks in all affiliated keywords but captions.
24726 ((< (point) post-affiliated)
24727 (and (save-excursion
24728 (beginning-of-line)
24729 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24730 (> (point) (match-end 0))
24731 (org--flyspell-object-check-p element)))
24732 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24733 ((let ((log (org-log-into-drawer)))
24734 (and log
24735 (let ((drawer (org-element-lineage element '(drawer))))
24736 (and drawer
24737 (eq (compare-strings
24738 log nil nil
24739 (org-element-property :drawer-name drawer) nil nil t)
24740 t)))))
24741 nil)
24743 (case (org-element-type element)
24744 ((comment quote-section) t)
24745 (comment-block
24746 ;; Allow checks between block markers, not on them.
24747 (and (> (line-beginning-position) post-affiliated)
24748 (save-excursion
24749 (end-of-line)
24750 (skip-chars-forward " \r\t\n")
24751 (< (point) (org-element-property :end element)))))
24752 ;; Arbitrary list of keywords where checks are meaningful.
24753 ;; Make sure point is on the value part of the element.
24754 (keyword
24755 (and (member (org-element-property :key element)
24756 '("DESCRIPTION" "TITLE"))
24757 (< (save-excursion
24758 (beginning-of-line) (search-forward ":") (point))
24759 (point))))
24760 ;; Check is globally allowed in paragraphs verse blocks and
24761 ;; table rows (after affiliated keywords) but some objects
24762 ;; must not be affected.
24763 ((paragraph table-row verse-block)
24764 (let ((cbeg (org-element-property :contents-begin element))
24765 (cend (org-element-property :contents-end element)))
24766 (and cbeg (>= (point) cbeg) (< (point) cend)
24767 (org--flyspell-object-check-p element))))))))))
24768 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
24770 (defun org-remove-flyspell-overlays-in (beg end)
24771 "Remove flyspell overlays in region."
24772 (and (org-bound-and-true-p flyspell-mode)
24773 (fboundp 'flyspell-delete-region-overlays)
24774 (flyspell-delete-region-overlays beg end)))
24776 (defvar flyspell-delayed-commands)
24777 (eval-after-load "flyspell"
24778 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
24780 ;; Make `bookmark-jump' shows the jump location if it was hidden.
24781 (eval-after-load "bookmark"
24782 '(if (boundp 'bookmark-after-jump-hook)
24783 ;; We can use the hook
24784 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
24785 ;; Hook not available, use advice
24786 (defadvice bookmark-jump (after org-make-visible activate)
24787 "Make the position visible."
24788 (org-bookmark-jump-unhide))))
24790 ;; Make sure saveplace shows the location if it was hidden
24791 (eval-after-load "saveplace"
24792 '(defadvice save-place-find-file-hook (after org-make-visible activate)
24793 "Make the position visible."
24794 (org-bookmark-jump-unhide)))
24796 ;; Make sure ecb shows the location if it was hidden
24797 (eval-after-load "ecb"
24798 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
24799 "Make hierarchy visible when jumping into location from ECB tree buffer."
24800 (if (derived-mode-p 'org-mode)
24801 (org-show-context))))
24803 (defun org-bookmark-jump-unhide ()
24804 "Unhide the current position, to show the bookmark location."
24805 (and (derived-mode-p 'org-mode)
24806 (or (outline-invisible-p)
24807 (save-excursion (goto-char (max (point-min) (1- (point))))
24808 (outline-invisible-p)))
24809 (org-show-context 'bookmark-jump)))
24811 (defun org-mark-jump-unhide ()
24812 "Make the point visible with `org-show-context' after jumping to the mark."
24813 (when (and (derived-mode-p 'org-mode)
24814 (outline-invisible-p))
24815 (org-show-context 'mark-goto)))
24817 (eval-after-load "simple"
24818 '(defadvice pop-to-mark-command (after org-make-visible activate)
24819 "Make the point visible with `org-show-context'."
24820 (org-mark-jump-unhide)))
24822 (eval-after-load "simple"
24823 '(defadvice exchange-point-and-mark (after org-make-visible activate)
24824 "Make the point visible with `org-show-context'."
24825 (org-mark-jump-unhide)))
24827 (eval-after-load "simple"
24828 '(defadvice pop-global-mark (after org-make-visible activate)
24829 "Make the point visible with `org-show-context'."
24830 (org-mark-jump-unhide)))
24832 ;; Make session.el ignore our circular variable
24833 (defvar session-globals-exclude)
24834 (eval-after-load "session"
24835 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24837 ;;;; Finish up
24839 (provide 'org)
24841 (run-hooks 'org-load-hook)
24843 ;;; org.el ends here