Fix 434103
[org-mode/org-tableheadings.git] / lisp / org.el
blobe359922348274476da023c7196a1ca40dd4cfcb5
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2014 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 (setq exported-file
239 (car (org-babel-tangle-file file exported-file "emacs-lisp"))))
240 (message "%s %s"
241 (if compile
242 (progn (byte-compile-file exported-file 'load)
243 "Compiled and loaded")
244 (progn (load-file exported-file) "Loaded"))
245 exported-file)))
247 (defcustom org-babel-load-languages '((emacs-lisp . t))
248 "Languages which can be evaluated in Org-mode buffers.
249 This list can be used to load support for any of the languages
250 below, note that each language will depend on a different set of
251 system executables and/or Emacs modes. When a language is
252 \"loaded\", then code blocks in that language can be evaluated
253 with `org-babel-execute-src-block' bound by default to C-c
254 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
255 be set to remove code block evaluation from the C-c C-c
256 keybinding. By default only Emacs Lisp (which has no
257 requirements) is loaded."
258 :group 'org-babel
259 :set 'org-babel-do-load-languages
260 :version "24.1"
261 :type '(alist :tag "Babel Languages"
262 :key-type
263 (choice
264 (const :tag "Awk" awk)
265 (const :tag "C" C)
266 (const :tag "R" R)
267 (const :tag "Asymptote" asymptote)
268 (const :tag "Calc" calc)
269 (const :tag "Clojure" clojure)
270 (const :tag "CSS" css)
271 (const :tag "Ditaa" ditaa)
272 (const :tag "Dot" dot)
273 (const :tag "Emacs Lisp" emacs-lisp)
274 (const :tag "Forth" forth)
275 (const :tag "Fortran" fortran)
276 (const :tag "Gnuplot" gnuplot)
277 (const :tag "Haskell" haskell)
278 (const :tag "IO" io)
279 (const :tag "J" J)
280 (const :tag "Java" java)
281 (const :tag "Javascript" js)
282 (const :tag "LaTeX" latex)
283 (const :tag "Ledger" ledger)
284 (const :tag "Lilypond" lilypond)
285 (const :tag "Lisp" lisp)
286 (const :tag "Makefile" makefile)
287 (const :tag "Maxima" maxima)
288 (const :tag "Matlab" matlab)
289 (const :tag "Mscgen" mscgen)
290 (const :tag "Ocaml" ocaml)
291 (const :tag "Octave" octave)
292 (const :tag "Org" org)
293 (const :tag "Perl" perl)
294 (const :tag "Pico Lisp" picolisp)
295 (const :tag "PlantUML" plantuml)
296 (const :tag "Python" python)
297 (const :tag "Ruby" ruby)
298 (const :tag "Sass" sass)
299 (const :tag "Scala" scala)
300 (const :tag "Scheme" scheme)
301 (const :tag "Screen" screen)
302 (const :tag "Shell Script" shell)
303 (const :tag "Shen" shen)
304 (const :tag "Sql" sql)
305 (const :tag "Sqlite" sqlite)
306 (const :tag "ebnf2ps" ebnf2ps))
307 :value-type (boolean :tag "Activate" :value t)))
309 ;;;; Customization variables
310 (defcustom org-clone-delete-id nil
311 "Remove ID property of clones of a subtree.
312 When non-nil, clones of a subtree don't inherit the ID property.
313 Otherwise they inherit the ID property with a new unique
314 identifier."
315 :type 'boolean
316 :version "24.1"
317 :group 'org-id)
319 ;;; Version
320 (org-check-version)
322 ;;;###autoload
323 (defun org-version (&optional here full message)
324 "Show the org-mode version.
325 Interactively, or when MESSAGE is non-nil, show it in echo area.
326 With prefix argument, or when HERE is non-nil, insert it at point.
327 In non-interactive uses, a reduced version string is output unless
328 FULL is given."
329 (interactive (list current-prefix-arg t (not current-prefix-arg)))
330 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
331 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
332 (load-suffixes (list ".el"))
333 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
334 (org-trash (or
335 (and (fboundp 'org-release) (fboundp 'org-git-version))
336 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
337 (load-suffixes save-load-suffixes)
338 (org-version (org-release))
339 (git-version (org-git-version))
340 (version (format "Org-mode version %s (%s @ %s)"
341 org-version
342 git-version
343 (if org-install-dir
344 (if (string= org-dir org-install-dir)
345 org-install-dir
346 (concat "mixed installation! " org-install-dir " and " org-dir))
347 "org-loaddefs.el can not be found!")))
348 (version1 (if full version org-version)))
349 (when here (insert version1))
350 (when message (message "%s" version1))
351 version1))
353 (defconst org-version (org-version))
356 ;;; Syntax Constants
358 ;;;; Block
360 (defconst org-block-regexp
361 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
362 "Regular expression for hiding blocks.")
364 (defconst org-dblock-start-re
365 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
366 "Matches the start line of a dynamic block, with parameters.")
368 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
369 "Matches the end of a dynamic block.")
371 ;;;; Clock and Planning
373 (defconst org-clock-string "CLOCK:"
374 "String used as prefix for timestamps clocking work hours on an item.")
376 (defconst org-closed-string "CLOSED:"
377 "String used as the prefix for timestamps logging closing a TODO entry.")
379 (defconst org-deadline-string "DEADLINE:"
380 "String to mark deadline entries.
381 A deadline is this string, followed by a time stamp. Should be a word,
382 terminated by a colon. You can insert a schedule keyword and
383 a timestamp with \\[org-deadline].")
385 (defconst org-scheduled-string "SCHEDULED:"
386 "String to mark scheduled TODO entries.
387 A schedule is this string, followed by a time stamp. Should be a word,
388 terminated by a colon. You can insert a schedule keyword and
389 a timestamp with \\[org-schedule].")
391 (defconst org-ds-keyword-length
392 (+ 2
393 (apply #'max
394 (mapcar #'length
395 (list org-deadline-string org-scheduled-string
396 org-clock-string org-closed-string))))
397 "Maximum length of the DEADLINE and SCHEDULED keywords.")
399 (defconst org-planning-line-re
400 (concat "^[ \t]*"
401 (regexp-opt
402 (list org-closed-string org-deadline-string org-scheduled-string)
404 "Matches a line with planning info.
405 Matched keyword is in group 1.")
407 (defconst org-clock-line-re
408 (concat "^[ \t]*" org-clock-string)
409 "Matches a line with clock info.")
411 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
412 "Matches the DEADLINE keyword.")
414 (defconst org-deadline-time-regexp
415 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
416 "Matches the DEADLINE keyword together with a time stamp.")
418 (defconst org-deadline-time-hour-regexp
419 (concat "\\<" org-deadline-string
420 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
421 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
423 (defconst org-deadline-line-regexp
424 (concat "\\<\\(" org-deadline-string "\\).*")
425 "Matches the DEADLINE keyword and the rest of the line.")
427 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
428 "Matches the SCHEDULED keyword.")
430 (defconst org-scheduled-time-regexp
431 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
432 "Matches the SCHEDULED keyword together with a time stamp.")
434 (defconst org-scheduled-time-hour-regexp
435 (concat "\\<" org-scheduled-string
436 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
437 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
439 (defconst org-closed-time-regexp
440 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
441 "Matches the CLOSED keyword together with a time stamp.")
443 (defconst org-keyword-time-regexp
444 (concat "\\<"
445 (regexp-opt
446 (list org-scheduled-string org-deadline-string org-closed-string
447 org-clock-string)
449 " *[[<]\\([^]>]+\\)[]>]")
450 "Matches any of the 4 keywords, together with the time stamp.")
452 (defconst org-keyword-time-not-clock-regexp
453 (concat
454 "\\<"
455 (regexp-opt
456 (list org-scheduled-string org-deadline-string org-closed-string) t)
457 " *[[<]\\([^]>]+\\)[]>]")
458 "Matches any of the 3 keywords, together with the time stamp.")
460 (defconst org-maybe-keyword-time-regexp
461 (concat "\\(\\<"
462 (regexp-opt
463 (list org-scheduled-string org-deadline-string org-closed-string
464 org-clock-string)
466 "\\)?"
467 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
468 "\\|"
469 "<%%([^\r\n>]*>\\)")
470 "Matches a timestamp, possibly preceded by a keyword.")
472 (defconst org-all-time-keywords
473 (mapcar (lambda (w) (substring w 0 -1))
474 (list org-scheduled-string org-deadline-string
475 org-clock-string org-closed-string))
476 "List of time keywords.")
478 ;;;; Drawer
480 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
481 "Matches first or last line of a hidden block.
482 Group 1 contains drawer's name or \"END\".")
484 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
485 "Regular expression matching the first line of a property drawer.")
487 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
488 "Regular expression matching the last line of a property drawer.")
490 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
491 "Regular expression matching the first line of a clock drawer.")
493 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
494 "Regular expression matching the last line of a clock drawer.")
496 (defconst org-property-drawer-re
497 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
498 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
499 "[ \t]*:END:[ \t]*$")
500 "Matches an entire property drawer.")
502 (defconst org-clock-drawer-re
503 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
504 org-clock-drawer-end-re "\\)\n?")
505 "Matches an entire clock drawer.")
507 ;;;; Headline
509 (defconst org-heading-keyword-regexp-format
510 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
511 "Printf format for a regexp matching a headline with some keyword.
512 This regexp will match the headline of any node which has the
513 exact keyword that is put into the format. The keyword isn't in
514 any group by default, but the stars and the body are.")
516 (defconst org-heading-keyword-maybe-regexp-format
517 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
518 "Printf format for a regexp matching a headline, possibly with some keyword.
519 This regexp can match any headline with the specified keyword, or
520 without a keyword. The keyword isn't in any group by default,
521 but the stars and the body are.")
523 (defconst org-archive-tag "ARCHIVE"
524 "The tag that marks a subtree as archived.
525 An archived subtree does not open during visibility cycling, and does
526 not contribute to the agenda listings.")
528 (defconst org-comment-string "COMMENT"
529 "Entries starting with this keyword will never be exported.
530 An entry can be toggled between COMMENT and normal with
531 \\[org-toggle-comment].")
534 ;;;; LaTeX Environments and Fragments
536 (defconst org-latex-regexps
537 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
538 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
539 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
540 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
541 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
542 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
543 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
544 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
545 "Regular expressions for matching embedded LaTeX.")
547 ;;;; Node Property
549 (defconst org-effort-property "Effort"
550 "The property that is being used to keep track of effort estimates.
551 Effort estimates given in this property need to have the format H:MM.")
553 ;;;; Table
555 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
556 "Detect an org-type or table-type table.")
558 (defconst org-table-line-regexp "^[ \t]*|"
559 "Detect an org-type table line.")
561 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
562 "Detect an org-type table line.")
564 (defconst org-table-hline-regexp "^[ \t]*|-"
565 "Detect an org-type table hline.")
567 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
568 "Detect a table-type table hline.")
570 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
571 "Detect the first line outside a table when searching from within it.
572 This works for both table types.")
574 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
575 "Detect a #+TBLFM line.")
577 ;;;; Timestamp
579 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
580 "Regular expression for fast time stamp matching.")
582 (defconst org-ts-regexp-inactive
583 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
584 "Regular expression for fast inactive time stamp matching.")
586 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
587 "Regular expression for fast time stamp matching.")
589 (defconst org-ts-regexp0
590 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
591 "Regular expression matching time strings for analysis.
592 This one does not require the space after the date, so it can be used
593 on a string that terminates immediately after the date.")
595 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
596 "Regular expression matching time strings for analysis.")
598 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
599 "Regular expression matching time stamps, with groups.")
601 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
602 "Regular expression matching time stamps (also [..]), with groups.")
604 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
605 "Regular expression matching a time stamp range.")
607 (defconst org-tr-regexp-both
608 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
609 "Regular expression matching a time stamp range.")
611 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
612 org-ts-regexp "\\)?")
613 "Regular expression matching a time stamp or time stamp range.")
615 (defconst org-tsr-regexp-both
616 (concat org-ts-regexp-both "\\(--?-?"
617 org-ts-regexp-both "\\)?")
618 "Regular expression matching a time stamp or time stamp range.
619 The time stamps may be either active or inactive.")
621 (defconst org-repeat-re
622 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
623 "Regular expression for specifying repeated events.
624 After a match, group 1 contains the repeat expression.")
626 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
627 "Formats for `format-time-string' which are used for time stamps.")
630 ;;; The custom variables
632 (defgroup org nil
633 "Outline-based notes management and organizer."
634 :tag "Org"
635 :group 'outlines
636 :group 'calendar)
638 (defcustom org-mode-hook nil
639 "Mode hook for Org-mode, run after the mode was turned on."
640 :group 'org
641 :type 'hook)
643 (defcustom org-load-hook nil
644 "Hook that is run after org.el has been loaded."
645 :group 'org
646 :type 'hook)
648 (defcustom org-log-buffer-setup-hook nil
649 "Hook that is run after an Org log buffer is created."
650 :group 'org
651 :version "24.1"
652 :type 'hook)
654 (defvar org-modules) ; defined below
655 (defvar org-modules-loaded nil
656 "Have the modules been loaded already?")
658 (defun org-load-modules-maybe (&optional force)
659 "Load all extensions listed in `org-modules'."
660 (when (or force (not org-modules-loaded))
661 (mapc (lambda (ext)
662 (condition-case nil (require ext)
663 (error (message "Problems while trying to load feature `%s'" ext))))
664 org-modules)
665 (setq org-modules-loaded t)))
667 (defun org-set-modules (var value)
668 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
669 (set var value)
670 (when (featurep 'org)
671 (org-load-modules-maybe 'force)
672 (org-element-cache-reset 'all)))
674 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
675 "Modules that should always be loaded together with org.el.
677 If a description starts with <C>, the file is not part of Emacs
678 and loading it will require that you have downloaded and properly
679 installed the Org mode distribution.
681 You can also use this system to load external packages (i.e. neither Org
682 core modules, nor modules from the CONTRIB directory). Just add symbols
683 to the end of the list. If the package is called org-xyz.el, then you need
684 to add the symbol `xyz', and the package must have a call to:
686 \(provide 'org-xyz)
688 For export specific modules, see also `org-export-backends'."
689 :group 'org
690 :set 'org-set-modules
691 :version "24.4"
692 :package-version '(Org . "8.0")
693 :type
694 '(set :greedy t
695 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
696 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
697 (const :tag " crypt: Encryption of subtrees" org-crypt)
698 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
699 (const :tag " docview: Links to doc-view buffers" org-docview)
700 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
701 (const :tag " habit: Track your consistency with habits" org-habit)
702 (const :tag " id: Global IDs for identifying entries" org-id)
703 (const :tag " info: Links to Info nodes" org-info)
704 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
705 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
706 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
707 (const :tag " mouse: Additional mouse support" org-mouse)
708 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
709 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
710 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
712 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
713 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
714 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
715 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
716 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
717 (const :tag "C collector: Collect properties into tables" org-collector)
718 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
719 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
720 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
721 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
722 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
723 (const :tag "C eval: Include command output as text" org-eval)
724 (const :tag "C eww: Store link to url of eww" org-eww)
725 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
726 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
727 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
728 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
729 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
730 (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
731 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
732 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
733 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
734 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
735 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
736 (const :tag "C mew: Links to Mew folders/messages" org-mew)
737 (const :tag "C mtags: Support for muse-like tags" org-mtags)
738 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
739 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
740 (const :tag "C registry: A registry for Org-mode links" org-registry)
741 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
742 (const :tag "C secretary: Team management with org-mode" org-secretary)
743 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
744 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
745 (const :tag "C track: Keep up with Org-mode development" org-track)
746 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
747 (const :tag "C vm: Links to VM folders/messages" org-vm)
748 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
749 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
750 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
752 (defvar org-export--registered-backends) ; From ox.el.
753 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
754 (declare-function org-export-backend-name "ox" (backend))
755 (defcustom org-export-backends '(ascii html icalendar latex)
756 "List of export back-ends that should be always available.
758 If a description starts with <C>, the file is not part of Emacs
759 and loading it will require that you have downloaded and properly
760 installed the Org mode distribution.
762 Unlike to `org-modules', libraries in this list will not be
763 loaded along with Org, but only once the export framework is
764 needed.
766 This variable needs to be set before org.el is loaded. If you
767 need to make a change while Emacs is running, use the customize
768 interface or run the following code, where VAL stands for the new
769 value of the variable, after updating it:
771 \(progn
772 \(setq org-export--registered-backends
773 \(org-remove-if-not
774 \(lambda (backend)
775 \(let ((name (org-export-backend-name backend)))
776 \(or (memq name val)
777 \(catch 'parentp
778 \(dolist (b val)
779 \(and (org-export-derived-backend-p b name)
780 \(throw 'parentp t)))))))
781 org-export--registered-backends))
782 \(let ((new-list (mapcar 'org-export-backend-name
783 org-export--registered-backends)))
784 \(dolist (backend val)
785 \(cond
786 \((not (load (format \"ox-%s\" backend) t t))
787 \(message \"Problems while trying to load export back-end `%s'\"
788 backend))
789 \((not (memq backend new-list)) (push backend new-list))))
790 \(set-default 'org-export-backends new-list)))
792 Adding a back-end to this list will also pull the back-end it
793 depends on, if any."
794 :group 'org
795 :group 'org-export
796 :version "24.4"
797 :package-version '(Org . "8.0")
798 :initialize 'custom-initialize-set
799 :set (lambda (var val)
800 (if (not (featurep 'ox)) (set-default var val)
801 ;; Any back-end not required anymore (not present in VAL and not
802 ;; a parent of any back-end in the new value) is removed from the
803 ;; list of registered back-ends.
804 (setq org-export--registered-backends
805 (org-remove-if-not
806 (lambda (backend)
807 (let ((name (org-export-backend-name backend)))
808 (or (memq name val)
809 (catch 'parentp
810 (dolist (b val)
811 (and (org-export-derived-backend-p b name)
812 (throw 'parentp t)))))))
813 org-export--registered-backends))
814 ;; Now build NEW-LIST of both new back-ends and required
815 ;; parents.
816 (let ((new-list (mapcar 'org-export-backend-name
817 org-export--registered-backends)))
818 (dolist (backend val)
819 (cond
820 ((not (load (format "ox-%s" backend) t t))
821 (message "Problems while trying to load export back-end `%s'"
822 backend))
823 ((not (memq backend new-list)) (push backend new-list))))
824 ;; Set VAR to that list with fixed dependencies.
825 (set-default var new-list))))
826 :type '(set :greedy t
827 (const :tag " ascii Export buffer to ASCII format" ascii)
828 (const :tag " beamer Export buffer to Beamer presentation" beamer)
829 (const :tag " html Export buffer to HTML format" html)
830 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
831 (const :tag " latex Export buffer to LaTeX format" latex)
832 (const :tag " man Export buffer to MAN format" man)
833 (const :tag " md Export buffer to Markdown format" md)
834 (const :tag " odt Export buffer to ODT format" odt)
835 (const :tag " org Export buffer to Org format" org)
836 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
837 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
838 (const :tag "C deck Export buffer to deck.js presentations" deck)
839 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
840 (const :tag "C groff Export buffer to Groff format" groff)
841 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
842 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
843 (const :tag "C s5 Export buffer to s5 presentations" s5)
844 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
846 (eval-after-load 'ox
847 '(mapc
848 (lambda (backend)
849 (condition-case nil (require (intern (format "ox-%s" backend)))
850 (error (message "Problems while trying to load export back-end `%s'"
851 backend))))
852 org-export-backends))
854 (defcustom org-support-shift-select nil
855 "Non-nil means make shift-cursor commands select text when possible.
857 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
858 start selecting a region, or enlarge regions started in this way.
859 In Org-mode, in special contexts, these same keys are used for
860 other purposes, important enough to compete with shift selection.
861 Org tries to balance these needs by supporting `shift-select-mode'
862 outside these special contexts, under control of this variable.
864 The default of this variable is nil, to avoid confusing behavior. Shifted
865 cursor keys will then execute Org commands in the following contexts:
866 - on a headline, changing TODO state (left/right) and priority (up/down)
867 - on a time stamp, changing the time
868 - in a plain list item, changing the bullet type
869 - in a property definition line, switching between allowed values
870 - in the BEGIN line of a clock table (changing the time block).
871 Outside these contexts, the commands will throw an error.
873 When this variable is t and the cursor is not in a special
874 context, Org-mode will support shift-selection for making and
875 enlarging regions. To make this more effective, the bullet
876 cycling will no longer happen anywhere in an item line, but only
877 if the cursor is exactly on the bullet.
879 If you set this variable to the symbol `always', then the keys
880 will not be special in headlines, property lines, and item lines,
881 to make shift selection work there as well. If this is what you
882 want, you can use the following alternative commands: `C-c C-t'
883 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
884 can be used to switch TODO sets, `C-c -' to cycle item bullet
885 types, and properties can be edited by hand or in column view.
887 However, when the cursor is on a timestamp, shift-cursor commands
888 will still edit the time stamp - this is just too good to give up.
890 XEmacs user should have this variable set to nil, because
891 `shift-select-mode' is in Emacs 23 or later only."
892 :group 'org
893 :type '(choice
894 (const :tag "Never" nil)
895 (const :tag "When outside special context" t)
896 (const :tag "Everywhere except timestamps" always)))
898 (defcustom org-loop-over-headlines-in-active-region nil
899 "Shall some commands act upon headlines in the active region?
901 When set to `t', some commands will be performed in all headlines
902 within the active region.
904 When set to `start-level', some commands will be performed in all
905 headlines within the active region, provided that these headlines
906 are of the same level than the first one.
908 When set to a string, those commands will be performed on the
909 matching headlines within the active region. Such string must be
910 a tags/property/todo match as it is used in the agenda tags view.
912 The list of commands is: `org-schedule', `org-deadline',
913 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
914 `org-archive-to-archive-sibling'. The archiving commands skip
915 already archived entries."
916 :type '(choice (const :tag "Don't loop" nil)
917 (const :tag "All headlines in active region" t)
918 (const :tag "In active region, headlines at the same level than the first one" start-level)
919 (string :tag "Tags/Property/Todo matcher"))
920 :version "24.1"
921 :group 'org-todo
922 :group 'org-archive)
924 (defgroup org-startup nil
925 "Options concerning startup of Org-mode."
926 :tag "Org Startup"
927 :group 'org)
929 (defcustom org-startup-folded t
930 "Non-nil means entering Org-mode will switch to OVERVIEW.
931 This can also be configured on a per-file basis by adding one of
932 the following lines anywhere in the buffer:
934 #+STARTUP: fold (or `overview', this is equivalent)
935 #+STARTUP: nofold (or `showall', this is equivalent)
936 #+STARTUP: content
937 #+STARTUP: showeverything
939 By default, this option is ignored when Org opens agenda files
940 for the first time. If you want the agenda to honor the startup
941 option, set `org-agenda-inhibit-startup' to nil."
942 :group 'org-startup
943 :type '(choice
944 (const :tag "nofold: show all" nil)
945 (const :tag "fold: overview" t)
946 (const :tag "content: all headlines" content)
947 (const :tag "show everything, even drawers" showeverything)))
949 (defcustom org-startup-truncated t
950 "Non-nil means entering Org-mode will set `truncate-lines'.
951 This is useful since some lines containing links can be very long and
952 uninteresting. Also tables look terrible when wrapped."
953 :group 'org-startup
954 :type 'boolean)
956 (defcustom org-startup-indented nil
957 "Non-nil means turn on `org-indent-mode' on startup.
958 This can also be configured on a per-file basis by adding one of
959 the following lines anywhere in the buffer:
961 #+STARTUP: indent
962 #+STARTUP: noindent"
963 :group 'org-structure
964 :type '(choice
965 (const :tag "Not" nil)
966 (const :tag "Globally (slow on startup in large files)" t)))
968 (defcustom org-use-sub-superscripts t
969 "Non-nil means interpret \"_\" and \"^\" for display.
971 If you want to control how Org exports those characters, see
972 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
973 used to be an alias for `org-export-with-sub-superscripts' in
974 Org <8.0, it is not anymore.
976 When this option is turned on, you can use TeX-like syntax for
977 sub- and superscripts within the buffer. Several characters after
978 \"_\" or \"^\" will be considered as a single item - so grouping
979 with {} is normally not needed. For example, the following things
980 will be parsed as single sub- or superscripts:
982 10^24 or 10^tau several digits will be considered 1 item.
983 10^-12 or 10^-tau a leading sign with digits or a word
984 x^2-y^3 will be read as x^2 - y^3, because items are
985 terminated by almost any nonword/nondigit char.
986 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
988 Still, ambiguity is possible. So when in doubt, use {} to enclose
989 the sub/superscript. If you set this variable to the symbol `{}',
990 the braces are *required* in order to trigger interpretations as
991 sub/superscript. This can be helpful in documents that need \"_\"
992 frequently in plain text."
993 :group 'org-startup
994 :version "24.4"
995 :package-version '(Org . "8.0")
996 :type '(choice
997 (const :tag "Always interpret" t)
998 (const :tag "Only with braces" {})
999 (const :tag "Never interpret" nil)))
1001 (defcustom org-startup-with-beamer-mode nil
1002 "Non-nil means turn on `org-beamer-mode' on startup.
1003 This can also be configured on a per-file basis by adding one of
1004 the following lines anywhere in the buffer:
1006 #+STARTUP: beamer"
1007 :group 'org-startup
1008 :version "24.1"
1009 :type 'boolean)
1011 (defcustom org-startup-align-all-tables nil
1012 "Non-nil means align all tables when visiting a file.
1013 This is useful when the column width in tables is forced with <N> cookies
1014 in table fields. Such tables will look correct only after the first re-align.
1015 This can also be configured on a per-file basis by adding one of
1016 the following lines anywhere in the buffer:
1017 #+STARTUP: align
1018 #+STARTUP: noalign"
1019 :group 'org-startup
1020 :type 'boolean)
1022 (defcustom org-startup-with-inline-images nil
1023 "Non-nil means show inline images when loading a new Org file.
1024 This can also be configured on a per-file basis by adding one of
1025 the following lines anywhere in the buffer:
1026 #+STARTUP: inlineimages
1027 #+STARTUP: noinlineimages"
1028 :group 'org-startup
1029 :version "24.1"
1030 :type 'boolean)
1032 (defcustom org-startup-with-latex-preview nil
1033 "Non-nil means preview LaTeX fragments when loading a new Org file.
1035 This can also be configured on a per-file basis by adding one of
1036 the following lines anywhere in the buffer:
1037 #+STARTUP: latexpreview
1038 #+STARTUP: nolatexpreview"
1039 :group 'org-startup
1040 :version "24.4"
1041 :package-version '(Org . "8.0")
1042 :type 'boolean)
1044 (defcustom org-insert-mode-line-in-empty-file nil
1045 "Non-nil means insert the first line setting Org-mode in empty files.
1046 When the function `org-mode' is called interactively in an empty file, this
1047 normally means that the file name does not automatically trigger Org-mode.
1048 To ensure that the file will always be in Org-mode in the future, a
1049 line enforcing Org-mode will be inserted into the buffer, if this option
1050 has been set."
1051 :group 'org-startup
1052 :type 'boolean)
1054 (defcustom org-replace-disputed-keys nil
1055 "Non-nil means use alternative key bindings for some keys.
1056 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1057 These keys are also used by other packages like shift-selection-mode'
1058 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1059 If you want to use Org-mode together with one of these other modes,
1060 or more generally if you would like to move some Org-mode commands to
1061 other keys, set this variable and configure the keys with the variable
1062 `org-disputed-keys'.
1064 This option is only relevant at load-time of Org-mode, and must be set
1065 *before* org.el is loaded. Changing it requires a restart of Emacs to
1066 become effective."
1067 :group 'org-startup
1068 :type 'boolean)
1070 (defcustom org-use-extra-keys nil
1071 "Non-nil means use extra key sequence definitions for certain commands.
1072 This happens automatically if you run XEmacs or if `window-system'
1073 is nil. This variable lets you do the same manually. You must
1074 set it before loading org.
1076 Example: on Carbon Emacs 22 running graphically, with an external
1077 keyboard on a Powerbook, the default way of setting M-left might
1078 not work for either Alt or ESC. Setting this variable will make
1079 it work for ESC."
1080 :group 'org-startup
1081 :type 'boolean)
1083 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1085 (defcustom org-disputed-keys
1086 '(([(shift up)] . [(meta p)])
1087 ([(shift down)] . [(meta n)])
1088 ([(shift left)] . [(meta -)])
1089 ([(shift right)] . [(meta +)])
1090 ([(control shift right)] . [(meta shift +)])
1091 ([(control shift left)] . [(meta shift -)]))
1092 "Keys for which Org-mode and other modes compete.
1093 This is an alist, cars are the default keys, second element specifies
1094 the alternative to use when `org-replace-disputed-keys' is t.
1096 Keys can be specified in any syntax supported by `define-key'.
1097 The value of this option takes effect only at Org-mode's startup,
1098 therefore you'll have to restart Emacs to apply it after changing."
1099 :group 'org-startup
1100 :type 'alist)
1102 (defun org-key (key)
1103 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1104 Or return the original if not disputed.
1105 Also apply the translations defined in `org-xemacs-key-equivalents'."
1106 (when org-replace-disputed-keys
1107 (let* ((nkey (key-description key))
1108 (x (org-find-if (lambda (x)
1109 (equal (key-description (car x)) nkey))
1110 org-disputed-keys)))
1111 (setq key (if x (cdr x) key))))
1112 (when (featurep 'xemacs)
1113 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1114 key)
1116 (defun org-find-if (predicate seq)
1117 (catch 'exit
1118 (while seq
1119 (if (funcall predicate (car seq))
1120 (throw 'exit (car seq))
1121 (pop seq)))))
1123 (defun org-defkey (keymap key def)
1124 "Define a key, possibly translated, as returned by `org-key'."
1125 (define-key keymap (org-key key) def))
1127 (defcustom org-ellipsis nil
1128 "The ellipsis to use in the Org-mode outline.
1129 When nil, just use the standard three dots.
1130 When a string, use that string instead.
1131 When a face, use the standard 3 dots, but with the specified face.
1132 The change affects only Org-mode (which will then use its own display table).
1133 Changing this requires executing \\[org-mode] in a buffer to become
1134 effective."
1135 :group 'org-startup
1136 :type '(choice (const :tag "Default" nil)
1137 (face :tag "Face" :value org-warning)
1138 (string :tag "String" :value "...#")))
1140 (defvar org-display-table nil
1141 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1143 (defgroup org-keywords nil
1144 "Keywords in Org-mode."
1145 :tag "Org Keywords"
1146 :group 'org)
1148 (defcustom org-closed-keep-when-no-todo nil
1149 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1150 :group 'org-todo
1151 :group 'org-keywords
1152 :version "24.4"
1153 :package-version '(Org . "8.0")
1154 :type 'boolean)
1156 (defgroup org-structure nil
1157 "Options concerning the general structure of Org-mode files."
1158 :tag "Org Structure"
1159 :group 'org)
1161 (defgroup org-reveal-location nil
1162 "Options about how to make context of a location visible."
1163 :tag "Org Reveal Location"
1164 :group 'org-structure)
1166 (defconst org-context-choice
1167 '(choice
1168 (const :tag "Always" t)
1169 (const :tag "Never" nil)
1170 (repeat :greedy t :tag "Individual contexts"
1171 (cons
1172 (choice :tag "Context"
1173 (const agenda)
1174 (const org-goto)
1175 (const occur-tree)
1176 (const tags-tree)
1177 (const link-search)
1178 (const mark-goto)
1179 (const bookmark-jump)
1180 (const isearch)
1181 (const default))
1182 (boolean))))
1183 "Contexts for the reveal options.")
1185 (defcustom org-show-hierarchy-above '((default . t))
1186 "Non-nil means show full hierarchy when revealing a location.
1187 Org-mode often shows locations in an org-mode file which might have
1188 been invisible before. When this is set, the hierarchy of headings
1189 above the exposed location is shown.
1190 Turning this off for example for sparse trees makes them very compact.
1191 Instead of t, this can also be an alist specifying this option for different
1192 contexts. Valid contexts are
1193 agenda when exposing an entry from the agenda
1194 org-goto when using the command `org-goto' on key C-c C-j
1195 occur-tree when using the command `org-occur' on key C-c /
1196 tags-tree when constructing a sparse tree based on tags matches
1197 link-search when exposing search matches associated with a link
1198 mark-goto when exposing the jump goal of a mark
1199 bookmark-jump when exposing a bookmark location
1200 isearch when exiting from an incremental search
1201 default default for all contexts not set explicitly"
1202 :group 'org-reveal-location
1203 :type org-context-choice)
1205 (defcustom org-show-following-heading '((default . nil))
1206 "Non-nil means show following heading when revealing a location.
1207 Org-mode often shows locations in an org-mode file which might have
1208 been invisible before. When this is set, the heading following the
1209 match is shown.
1210 Turning this off for example for sparse trees makes them very compact,
1211 but makes it harder to edit the location of the match. In such a case,
1212 use the command \\[org-reveal] to show more context.
1213 Instead of t, this can also be an alist specifying this option for different
1214 contexts. See `org-show-hierarchy-above' for valid contexts."
1215 :group 'org-reveal-location
1216 :type org-context-choice)
1218 (defcustom org-show-siblings '((default . nil) (isearch t) (bookmark-jump t))
1219 "Non-nil means show all sibling heading when revealing a location.
1220 Org-mode often shows locations in an org-mode file which might have
1221 been invisible before. When this is set, the sibling of the current entry
1222 heading are all made visible. If `org-show-hierarchy-above' is t,
1223 the same happens on each level of the hierarchy above the current entry.
1225 By default this is on for the isearch context, off for all other contexts.
1226 Turning this off for example for sparse trees makes them very compact,
1227 but makes it harder to edit the location of the match. In such a case,
1228 use the command \\[org-reveal] to show more context.
1229 Instead of t, this can also be an alist specifying this option for different
1230 contexts. See `org-show-hierarchy-above' for valid contexts."
1231 :group 'org-reveal-location
1232 :type org-context-choice
1233 :version "24.4"
1234 :package-version '(Org . "8.0"))
1236 (defcustom org-show-entry-below '((default . nil))
1237 "Non-nil means show the entry below a headline when revealing a location.
1238 Org-mode often shows locations in an org-mode file which might have
1239 been invisible before. When this is set, the text below the headline that is
1240 exposed is also shown.
1242 By default this is off for all contexts.
1243 Instead of t, this can also be an alist specifying this option for different
1244 contexts. See `org-show-hierarchy-above' for valid contexts."
1245 :group 'org-reveal-location
1246 :type org-context-choice)
1248 (defcustom org-indirect-buffer-display 'other-window
1249 "How should indirect tree buffers be displayed?
1250 This applies to indirect buffers created with the commands
1251 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1252 Valid values are:
1253 current-window Display in the current window
1254 other-window Just display in another window.
1255 dedicated-frame Create one new frame, and re-use it each time.
1256 new-frame Make a new frame each time. Note that in this case
1257 previously-made indirect buffers are kept, and you need to
1258 kill these buffers yourself."
1259 :group 'org-structure
1260 :group 'org-agenda-windows
1261 :type '(choice
1262 (const :tag "In current window" current-window)
1263 (const :tag "In current frame, other window" other-window)
1264 (const :tag "Each time a new frame" new-frame)
1265 (const :tag "One dedicated frame" dedicated-frame)))
1267 (defcustom org-use-speed-commands nil
1268 "Non-nil means activate single letter commands at beginning of a headline.
1269 This may also be a function to test for appropriate locations where speed
1270 commands should be active.
1272 For example, to activate speed commands when the point is on any
1273 star at the beginning of the headline, you can do this:
1275 (setq org-use-speed-commands
1276 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1277 :group 'org-structure
1278 :type '(choice
1279 (const :tag "Never" nil)
1280 (const :tag "At beginning of headline stars" t)
1281 (function)))
1283 (defcustom org-speed-commands-user nil
1284 "Alist of additional speed commands.
1285 This list will be checked before `org-speed-commands-default'
1286 when the variable `org-use-speed-commands' is non-nil
1287 and when the cursor is at the beginning of a headline.
1288 The car if each entry is a string with a single letter, which must
1289 be assigned to `self-insert-command' in the global map.
1290 The cdr is either a command to be called interactively, a function
1291 to be called, or a form to be evaluated.
1292 An entry that is just a list with a single string will be interpreted
1293 as a descriptive headline that will be added when listing the speed
1294 commands in the Help buffer using the `?' speed command."
1295 :group 'org-structure
1296 :type '(repeat :value ("k" . ignore)
1297 (choice :value ("k" . ignore)
1298 (list :tag "Descriptive Headline" (string :tag "Headline"))
1299 (cons :tag "Letter and Command"
1300 (string :tag "Command letter")
1301 (choice
1302 (function)
1303 (sexp))))))
1305 (defcustom org-bookmark-names-plist
1306 '(:last-capture "org-capture-last-stored"
1307 :last-refile "org-refile-last-stored"
1308 :last-capture-marker "org-capture-last-stored-marker")
1309 "Names for bookmarks automatically set by some Org commands.
1310 This can provide strings as names for a number of bookmarks Org sets
1311 automatically. The following keys are currently implemented:
1312 :last-capture
1313 :last-capture-marker
1314 :last-refile
1315 When a key does not show up in the property list, the corresponding bookmark
1316 is not set."
1317 :group 'org-structure
1318 :type 'plist)
1320 (defgroup org-cycle nil
1321 "Options concerning visibility cycling in Org-mode."
1322 :tag "Org Cycle"
1323 :group 'org-structure)
1325 (defcustom org-cycle-skip-children-state-if-no-children t
1326 "Non-nil means skip CHILDREN state in entries that don't have any."
1327 :group 'org-cycle
1328 :type 'boolean)
1330 (defcustom org-cycle-max-level nil
1331 "Maximum level which should still be subject to visibility cycling.
1332 Levels higher than this will, for cycling, be treated as text, not a headline.
1333 When `org-odd-levels-only' is set, a value of N in this variable actually
1334 means 2N-1 stars as the limiting headline.
1335 When nil, cycle all levels.
1336 Note that the limiting level of cycling is also influenced by
1337 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1338 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1339 than its value."
1340 :group 'org-cycle
1341 :type '(choice
1342 (const :tag "No limit" nil)
1343 (integer :tag "Maximum level")))
1345 (defcustom org-hide-block-startup nil
1346 "Non-nil means entering Org-mode will fold all blocks.
1347 This can also be set in on a per-file basis with
1349 #+STARTUP: hideblocks
1350 #+STARTUP: showblocks"
1351 :group 'org-startup
1352 :group 'org-cycle
1353 :type 'boolean)
1355 (defcustom org-cycle-global-at-bob nil
1356 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1357 This makes it possible to do global cycling without having to use S-TAB or
1358 \\[universal-argument] TAB. For this special case to work, the first line
1359 of the buffer must not be a headline -- it may be empty or some other text.
1360 When used in this way, `org-cycle-hook' is disabled temporarily to make
1361 sure the cursor stays at the beginning of the buffer. When this option is
1362 nil, don't do anything special at the beginning of the buffer."
1363 :group 'org-cycle
1364 :type 'boolean)
1366 (defcustom org-cycle-level-after-item/entry-creation t
1367 "Non-nil means cycle entry level or item indentation in new empty entries.
1369 When the cursor is at the end of an empty headline, i.e., with only stars
1370 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1371 and then all possible ancestor states, before returning to the original state.
1372 This makes data entry extremely fast: M-RET to create a new headline,
1373 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1375 When the cursor is at the end of an empty plain list item, one TAB will
1376 make it a subitem, two or more tabs will back up to make this an item
1377 higher up in the item hierarchy."
1378 :group 'org-cycle
1379 :type 'boolean)
1381 (defcustom org-cycle-emulate-tab t
1382 "Where should `org-cycle' emulate TAB.
1383 nil Never
1384 white Only in completely white lines
1385 whitestart Only at the beginning of lines, before the first non-white char
1386 t Everywhere except in headlines
1387 exc-hl-bol Everywhere except at the start of a headline
1388 If TAB is used in a place where it does not emulate TAB, the current subtree
1389 visibility is cycled."
1390 :group 'org-cycle
1391 :type '(choice (const :tag "Never" nil)
1392 (const :tag "Only in completely white lines" white)
1393 (const :tag "Before first char in a line" whitestart)
1394 (const :tag "Everywhere except in headlines" t)
1395 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1397 (defcustom org-cycle-separator-lines 2
1398 "Number of empty lines needed to keep an empty line between collapsed trees.
1399 If you leave an empty line between the end of a subtree and the following
1400 headline, this empty line is hidden when the subtree is folded.
1401 Org-mode will leave (exactly) one empty line visible if the number of
1402 empty lines is equal or larger to the number given in this variable.
1403 So the default 2 means at least 2 empty lines after the end of a subtree
1404 are needed to produce free space between a collapsed subtree and the
1405 following headline.
1407 If the number is negative, and the number of empty lines is at least -N,
1408 all empty lines are shown.
1410 Special case: when 0, never leave empty lines in collapsed view."
1411 :group 'org-cycle
1412 :type 'integer)
1413 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1415 (defcustom org-pre-cycle-hook nil
1416 "Hook that is run before visibility cycling is happening.
1417 The function(s) in this hook must accept a single argument which indicates
1418 the new state that will be set right after running this hook. The
1419 argument is a symbol. Before a global state change, it can have the values
1420 `overview', `content', or `all'. Before a local state change, it can have
1421 the values `folded', `children', or `subtree'."
1422 :group 'org-cycle
1423 :type 'hook)
1425 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1426 org-cycle-hide-drawers
1427 org-cycle-hide-inline-tasks
1428 org-cycle-show-empty-lines
1429 org-optimize-window-after-visibility-change)
1430 "Hook that is run after `org-cycle' has changed the buffer visibility.
1431 The function(s) in this hook must accept a single argument which indicates
1432 the new state that was set by the most recent `org-cycle' command. The
1433 argument is a symbol. After a global state change, it can have the values
1434 `overview', `contents', or `all'. After a local state change, it can have
1435 the values `folded', `children', or `subtree'."
1436 :group 'org-cycle
1437 :type 'hook)
1439 (defgroup org-edit-structure nil
1440 "Options concerning structure editing in Org-mode."
1441 :tag "Org Edit Structure"
1442 :group 'org-structure)
1444 (defcustom org-odd-levels-only nil
1445 "Non-nil means skip even levels and only use odd levels for the outline.
1446 This has the effect that two stars are being added/taken away in
1447 promotion/demotion commands. It also influences how levels are
1448 handled by the exporters.
1449 Changing it requires restart of `font-lock-mode' to become effective
1450 for fontification also in regions already fontified.
1451 You may also set this on a per-file basis by adding one of the following
1452 lines to the buffer:
1454 #+STARTUP: odd
1455 #+STARTUP: oddeven"
1456 :group 'org-edit-structure
1457 :group 'org-appearance
1458 :type 'boolean)
1460 (defcustom org-adapt-indentation t
1461 "Non-nil means adapt indentation to outline node level.
1463 When this variable is set, Org assumes that you write outlines by
1464 indenting text in each node to align with the headline (after the
1465 stars). The following issues are influenced by this variable:
1467 - The indentation is increased by one space in a demotion
1468 command, and decreased by one in a promotion command. However,
1469 in the latter case, if shifting some line in the entry body
1470 would alter document structure (e.g., insert a new headline),
1471 indentation is not changed at all.
1473 - Property drawers and planning information is inserted indented
1474 when this variable is set. When nil, they will not be indented.
1476 - TAB indents a line relative to current level. The lines below
1477 a headline will be indented when this variable is set.
1479 Note that this is all about true indentation, by adding and
1480 removing space characters. See also `org-indent.el' which does
1481 level-dependent indentation in a virtual way, i.e. at display
1482 time in Emacs."
1483 :group 'org-edit-structure
1484 :type 'boolean)
1486 (defcustom org-special-ctrl-a/e nil
1487 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1489 When t, `C-a' will bring back the cursor to the beginning of the
1490 headline text, i.e. after the stars and after a possible TODO
1491 keyword. In an item, this will be the position after bullet and
1492 check-box, if any. When the cursor is already at that position,
1493 another `C-a' will bring it to the beginning of the line.
1495 `C-e' will jump to the end of the headline, ignoring the presence
1496 of tags in the headline. A second `C-e' will then jump to the
1497 true end of the line, after any tags. This also means that, when
1498 this variable is non-nil, `C-e' also will never jump beyond the
1499 end of the heading of a folded section, i.e. not after the
1500 ellipses.
1502 When set to the symbol `reversed', the first `C-a' or `C-e' works
1503 normally, going to the true line boundary first. Only a directly
1504 following, identical keypress will bring the cursor to the
1505 special positions.
1507 This may also be a cons cell where the behavior for `C-a' and
1508 `C-e' is set separately."
1509 :group 'org-edit-structure
1510 :type '(choice
1511 (const :tag "off" nil)
1512 (const :tag "on: after stars/bullet and before tags first" t)
1513 (const :tag "reversed: true line boundary first" reversed)
1514 (cons :tag "Set C-a and C-e separately"
1515 (choice :tag "Special C-a"
1516 (const :tag "off" nil)
1517 (const :tag "on: after stars/bullet first" t)
1518 (const :tag "reversed: before stars/bullet first" reversed))
1519 (choice :tag "Special C-e"
1520 (const :tag "off" nil)
1521 (const :tag "on: before tags first" t)
1522 (const :tag "reversed: after tags first" reversed)))))
1523 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1525 (defcustom org-special-ctrl-k nil
1526 "Non-nil means `C-k' will behave specially in headlines.
1527 When nil, `C-k' will call the default `kill-line' command.
1528 When t, the following will happen while the cursor is in the headline:
1530 - When the cursor is at the beginning of a headline, kill the entire
1531 line and possible the folded subtree below the line.
1532 - When in the middle of the headline text, kill the headline up to the tags.
1533 - When after the headline text, kill the tags."
1534 :group 'org-edit-structure
1535 :type 'boolean)
1537 (defcustom org-ctrl-k-protect-subtree nil
1538 "Non-nil means, do not delete a hidden subtree with C-k.
1539 When set to the symbol `error', simply throw an error when C-k is
1540 used to kill (part-of) a headline that has hidden text behind it.
1541 Any other non-nil value will result in a query to the user, if it is
1542 OK to kill that hidden subtree. When nil, kill without remorse."
1543 :group 'org-edit-structure
1544 :version "24.1"
1545 :type '(choice
1546 (const :tag "Do not protect hidden subtrees" nil)
1547 (const :tag "Protect hidden subtrees with a security query" t)
1548 (const :tag "Never kill a hidden subtree with C-k" error)))
1550 (defcustom org-special-ctrl-o t
1551 "Non-nil means, make `C-o' insert a row in tables."
1552 :group 'org-edit-structure
1553 :type 'boolean)
1555 (defcustom org-catch-invisible-edits nil
1556 "Check if in invisible region before inserting or deleting a character.
1557 Valid values are:
1559 nil Do not check, so just do invisible edits.
1560 error Throw an error and do nothing.
1561 show Make point visible, and do the requested edit.
1562 show-and-error Make point visible, then throw an error and abort the edit.
1563 smart Make point visible, and do insertion/deletion if it is
1564 adjacent to visible text and the change feels predictable.
1565 Never delete a previously invisible character or add in the
1566 middle or right after an invisible region. Basically, this
1567 allows insertion and backward-delete right before ellipses.
1568 FIXME: maybe in this case we should not even show?"
1569 :group 'org-edit-structure
1570 :version "24.1"
1571 :type '(choice
1572 (const :tag "Do not check" nil)
1573 (const :tag "Throw error when trying to edit" error)
1574 (const :tag "Unhide, but do not do the edit" show-and-error)
1575 (const :tag "Show invisible part and do the edit" show)
1576 (const :tag "Be smart and do the right thing" smart)))
1578 (defcustom org-yank-folded-subtrees t
1579 "Non-nil means when yanking subtrees, fold them.
1580 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1581 it starts with a heading and all other headings in it are either children
1582 or siblings, then fold all the subtrees. However, do this only if no
1583 text after the yank would be swallowed into a folded tree by this action."
1584 :group 'org-edit-structure
1585 :type 'boolean)
1587 (defcustom org-yank-adjusted-subtrees nil
1588 "Non-nil means when yanking subtrees, adjust the level.
1589 With this setting, `org-paste-subtree' is used to insert the subtree, see
1590 this function for details."
1591 :group 'org-edit-structure
1592 :type 'boolean)
1594 (defcustom org-M-RET-may-split-line '((default . t))
1595 "Non-nil means M-RET will split the line at the cursor position.
1596 When nil, it will go to the end of the line before making a
1597 new line.
1598 You may also set this option in a different way for different
1599 contexts. Valid contexts are:
1601 headline when creating a new headline
1602 item when creating a new item
1603 table in a table field
1604 default the value to be used for all contexts not explicitly
1605 customized"
1606 :group 'org-structure
1607 :group 'org-table
1608 :type '(choice
1609 (const :tag "Always" t)
1610 (const :tag "Never" nil)
1611 (repeat :greedy t :tag "Individual contexts"
1612 (cons
1613 (choice :tag "Context"
1614 (const headline)
1615 (const item)
1616 (const table)
1617 (const default))
1618 (boolean)))))
1621 (defcustom org-insert-heading-respect-content nil
1622 "Non-nil means insert new headings after the current subtree.
1623 When nil, the new heading is created directly after the current line.
1624 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1625 this variable on for the duration of the command."
1626 :group 'org-structure
1627 :type 'boolean)
1629 (defcustom org-blank-before-new-entry '((heading . auto)
1630 (plain-list-item . auto))
1631 "Should `org-insert-heading' leave a blank line before new heading/item?
1632 The value is an alist, with `heading' and `plain-list-item' as CAR,
1633 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1634 which case Org will look at the surrounding headings/items and try to
1635 make an intelligent decision whether to insert a blank line or not.
1637 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1638 the setting here is ignored and no empty line is inserted to avoid breaking
1639 the list structure."
1640 :group 'org-edit-structure
1641 :type '(list
1642 (cons (const heading)
1643 (choice (const :tag "Never" nil)
1644 (const :tag "Always" t)
1645 (const :tag "Auto" auto)))
1646 (cons (const plain-list-item)
1647 (choice (const :tag "Never" nil)
1648 (const :tag "Always" t)
1649 (const :tag "Auto" auto)))))
1651 (defcustom org-insert-heading-hook nil
1652 "Hook being run after inserting a new heading."
1653 :group 'org-edit-structure
1654 :type 'hook)
1656 (defcustom org-enable-fixed-width-editor t
1657 "Non-nil means lines starting with \":\" are treated as fixed-width.
1658 This currently only means they are never auto-wrapped.
1659 When nil, such lines will be treated like ordinary lines."
1660 :group 'org-edit-structure
1661 :type 'boolean)
1663 (defcustom org-goto-auto-isearch t
1664 "Non-nil means typing characters in `org-goto' starts incremental search.
1665 When nil, you can use these keybindings to navigate the buffer:
1667 q Quit the org-goto interface
1668 n Go to the next visible heading
1669 p Go to the previous visible heading
1670 f Go one heading forward on same level
1671 b Go one heading backward on same level
1672 u Go one heading up"
1673 :group 'org-edit-structure
1674 :type 'boolean)
1676 (defgroup org-sparse-trees nil
1677 "Options concerning sparse trees in Org-mode."
1678 :tag "Org Sparse Trees"
1679 :group 'org-structure)
1681 (defcustom org-highlight-sparse-tree-matches t
1682 "Non-nil means highlight all matches that define a sparse tree.
1683 The highlights will automatically disappear the next time the buffer is
1684 changed by an edit command."
1685 :group 'org-sparse-trees
1686 :type 'boolean)
1688 (defcustom org-remove-highlights-with-change t
1689 "Non-nil means any change to the buffer will remove temporary highlights.
1690 Such highlights are created by `org-occur' and `org-clock-display'.
1691 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1692 The highlights created by `org-toggle-latex-fragment' always need
1693 `C-c C-x C-l' to be removed."
1694 :group 'org-sparse-trees
1695 :group 'org-time
1696 :type 'boolean)
1699 (defcustom org-occur-hook '(org-first-headline-recenter)
1700 "Hook that is run after `org-occur' has constructed a sparse tree.
1701 This can be used to recenter the window to show as much of the structure
1702 as possible."
1703 :group 'org-sparse-trees
1704 :type 'hook)
1706 (defgroup org-imenu-and-speedbar nil
1707 "Options concerning imenu and speedbar in Org-mode."
1708 :tag "Org Imenu and Speedbar"
1709 :group 'org-structure)
1711 (defcustom org-imenu-depth 2
1712 "The maximum level for Imenu access to Org-mode headlines.
1713 This also applied for speedbar access."
1714 :group 'org-imenu-and-speedbar
1715 :type 'integer)
1717 (defgroup org-table nil
1718 "Options concerning tables in Org-mode."
1719 :tag "Org Table"
1720 :group 'org)
1722 (defcustom org-enable-table-editor 'optimized
1723 "Non-nil means lines starting with \"|\" are handled by the table editor.
1724 When nil, such lines will be treated like ordinary lines.
1726 When equal to the symbol `optimized', the table editor will be optimized to
1727 do the following:
1728 - Automatic overwrite mode in front of whitespace in table fields.
1729 This makes the structure of the table stay in tact as long as the edited
1730 field does not exceed the column width.
1731 - Minimize the number of realigns. Normally, the table is aligned each time
1732 TAB or RET are pressed to move to another field. With optimization this
1733 happens only if changes to a field might have changed the column width.
1734 Optimization requires replacing the functions `self-insert-command',
1735 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1736 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1737 very good at guessing when a re-align will be necessary, but you can always
1738 force one with \\[org-ctrl-c-ctrl-c].
1740 If you would like to use the optimized version in Org-mode, but the
1741 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1743 This variable can be used to turn on and off the table editor during a session,
1744 but in order to toggle optimization, a restart is required.
1746 See also the variable `org-table-auto-blank-field'."
1747 :group 'org-table
1748 :type '(choice
1749 (const :tag "off" nil)
1750 (const :tag "on" t)
1751 (const :tag "on, optimized" optimized)))
1753 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1754 (version<= emacs-version "24.1"))
1755 "Non-nil means cluster self-insert commands for undo when possible.
1756 If this is set, then, like in the Emacs command loop, 20 consecutive
1757 characters will be undone together.
1758 This is configurable, because there is some impact on typing performance."
1759 :group 'org-table
1760 :type 'boolean)
1762 (defcustom org-table-tab-recognizes-table.el t
1763 "Non-nil means TAB will automatically notice a table.el table.
1764 When it sees such a table, it moves point into it and - if necessary -
1765 calls `table-recognize-table'."
1766 :group 'org-table-editing
1767 :type 'boolean)
1769 (defgroup org-link nil
1770 "Options concerning links in Org-mode."
1771 :tag "Org Link"
1772 :group 'org)
1774 (defvar org-link-abbrev-alist-local nil
1775 "Buffer-local version of `org-link-abbrev-alist', which see.
1776 The value of this is taken from the #+LINK lines.")
1777 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1779 (defcustom org-link-abbrev-alist nil
1780 "Alist of link abbreviations.
1781 The car of each element is a string, to be replaced at the start of a link.
1782 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1783 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1785 [[linkkey:tag][description]]
1787 The 'linkkey' must be a word word, starting with a letter, followed
1788 by letters, numbers, '-' or '_'.
1790 If REPLACE is a string, the tag will simply be appended to create the link.
1791 If the string contains \"%s\", the tag will be inserted there. If the string
1792 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1793 at that point (see the function `url-hexify-string'). If the string contains
1794 the specifier \"%(my-function)\", then the custom function `my-function' will
1795 be invoked: this function takes the tag as its only argument and must return
1796 a string.
1798 REPLACE may also be a function that will be called with the tag as the
1799 only argument to create the link, which should be returned as a string.
1801 See the manual for examples."
1802 :group 'org-link
1803 :type '(repeat
1804 (cons
1805 (string :tag "Protocol")
1806 (choice
1807 (string :tag "Format")
1808 (function)))))
1810 (defcustom org-descriptive-links t
1811 "Non-nil means Org will display descriptive links.
1812 E.g. [[http://orgmode.org][Org website]] will be displayed as
1813 \"Org Website\", hiding the link itself and just displaying its
1814 description. When set to `nil', Org will display the full links
1815 literally.
1817 You can interactively set the value of this variable by calling
1818 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1819 :group 'org-link
1820 :type 'boolean)
1822 (defcustom org-link-file-path-type 'adaptive
1823 "How the path name in file links should be stored.
1824 Valid values are:
1826 relative Relative to the current directory, i.e. the directory of the file
1827 into which the link is being inserted.
1828 absolute Absolute path, if possible with ~ for home directory.
1829 noabbrev Absolute path, no abbreviation of home directory.
1830 adaptive Use relative path for files in the current directory and sub-
1831 directories of it. For other files, use an absolute path."
1832 :group 'org-link
1833 :type '(choice
1834 (const relative)
1835 (const absolute)
1836 (const noabbrev)
1837 (const adaptive)))
1839 (defvaralias 'org-activate-links 'org-highlight-links)
1840 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1841 "Types of links that should be highlighted in Org-mode files.
1843 This is a list of symbols, each one of them leading to the
1844 highlighting of a certain link type.
1846 You can still open links that are not highlighted.
1848 In principle, it does not hurt to turn on highlighting for all
1849 link types. There may be a small gain when turning off unused
1850 link types. The types are:
1852 bracket The recommended [[link][description]] or [[link]] links with hiding.
1853 angle Links in angular brackets that may contain whitespace like
1854 <bbdb:Carsten Dominik>.
1855 plain Plain links in normal text, no whitespace, like http://google.com.
1856 radio Text that is matched by a radio target, see manual for details.
1857 tag Tag settings in a headline (link to tag search).
1858 date Time stamps (link to calendar).
1859 footnote Footnote labels.
1861 If you set this variable during an Emacs session, use `org-mode-restart'
1862 in the Org buffer so that the change takes effect."
1863 :group 'org-link
1864 :group 'org-appearance
1865 :type '(set :greedy t
1866 (const :tag "Double bracket links" bracket)
1867 (const :tag "Angular bracket links" angle)
1868 (const :tag "Plain text links" plain)
1869 (const :tag "Radio target matches" radio)
1870 (const :tag "Tags" tag)
1871 (const :tag "Timestamps" date)
1872 (const :tag "Footnotes" footnote)))
1874 (defcustom org-make-link-description-function nil
1875 "Function to use for generating link descriptions from links.
1876 When nil, the link location will be used. This function must take
1877 two parameters: the first one is the link, the second one is the
1878 description generated by `org-insert-link'. The function should
1879 return the description to use."
1880 :group 'org-link
1881 :type '(choice (const nil) (function)))
1883 (defgroup org-link-store nil
1884 "Options concerning storing links in Org-mode."
1885 :tag "Org Store Link"
1886 :group 'org-link)
1888 (defcustom org-url-hexify-p t
1889 "When non-nil, hexify URL when creating a link."
1890 :type 'boolean
1891 :version "24.3"
1892 :group 'org-link-store)
1894 (defcustom org-email-link-description-format "Email %c: %.30s"
1895 "Format of the description part of a link to an email or usenet message.
1896 The following %-escapes will be replaced by corresponding information:
1898 %F full \"From\" field
1899 %f name, taken from \"From\" field, address if no name
1900 %T full \"To\" field
1901 %t first name in \"To\" field, address if no name
1902 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1903 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1904 %s subject
1905 %d date
1906 %m message-id.
1908 You may use normal field width specification between the % and the letter.
1909 This is for example useful to limit the length of the subject.
1911 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1912 :group 'org-link-store
1913 :type 'string)
1915 (defcustom org-from-is-user-regexp
1916 (let (r1 r2)
1917 (when (and user-mail-address (not (string= user-mail-address "")))
1918 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1919 (when (and user-full-name (not (string= user-full-name "")))
1920 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1921 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1922 "Regexp matched against the \"From:\" header of an email or usenet message.
1923 It should match if the message is from the user him/herself."
1924 :group 'org-link-store
1925 :type 'regexp)
1927 (defcustom org-context-in-file-links t
1928 "Non-nil means file links from `org-store-link' contain context.
1929 A search string will be added to the file name with :: as separator and
1930 used to find the context when the link is activated by the command
1931 `org-open-at-point'. When this option is t, the entire active region
1932 will be placed in the search string of the file link. If set to a
1933 positive integer, only the first n lines of context will be stored.
1935 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1936 negates this setting for the duration of the command."
1937 :group 'org-link-store
1938 :type '(choice boolean integer))
1940 (defcustom org-keep-stored-link-after-insertion nil
1941 "Non-nil means keep link in list for entire session.
1943 The command `org-store-link' adds a link pointing to the current
1944 location to an internal list. These links accumulate during a session.
1945 The command `org-insert-link' can be used to insert links into any
1946 Org-mode file (offering completion for all stored links). When this
1947 option is nil, every link which has been inserted once using \\[org-insert-link]
1948 will be removed from the list, to make completing the unused links
1949 more efficient."
1950 :group 'org-link-store
1951 :type 'boolean)
1953 (defgroup org-link-follow nil
1954 "Options concerning following links in Org-mode."
1955 :tag "Org Follow Link"
1956 :group 'org-link)
1958 (defcustom org-link-translation-function nil
1959 "Function to translate links with different syntax to Org syntax.
1960 This can be used to translate links created for example by the Planner
1961 or emacs-wiki packages to Org syntax.
1962 The function must accept two parameters, a TYPE containing the link
1963 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1964 which is everything after the link protocol. It should return a cons
1965 with possibly modified values of type and path.
1966 Org contains a function for this, so if you set this variable to
1967 `org-translate-link-from-planner', you should be able follow many
1968 links created by planner."
1969 :group 'org-link-follow
1970 :type '(choice (const nil) (function)))
1972 (defcustom org-follow-link-hook nil
1973 "Hook that is run after a link has been followed."
1974 :group 'org-link-follow
1975 :type 'hook)
1977 (defcustom org-tab-follows-link nil
1978 "Non-nil means on links TAB will follow the link.
1979 Needs to be set before org.el is loaded.
1980 This really should not be used, it does not make sense, and the
1981 implementation is bad."
1982 :group 'org-link-follow
1983 :type 'boolean)
1985 (defcustom org-return-follows-link nil
1986 "Non-nil means on links RET will follow the link.
1987 In tables, the special behavior of RET has precedence."
1988 :group 'org-link-follow
1989 :type 'boolean)
1991 (defcustom org-mouse-1-follows-link
1992 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1993 "Non-nil means mouse-1 on a link will follow the link.
1994 A longer mouse click will still set point. Does not work on XEmacs.
1995 Needs to be set before org.el is loaded."
1996 :group 'org-link-follow
1997 :version "24.4"
1998 :package-version '(Org . "8.3")
1999 :type '(choice
2000 (const :tag "A double click follows the link" double)
2001 (const :tag "Unconditionally follow the link with mouse-1" t)
2002 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
2004 (defcustom org-mark-ring-length 4
2005 "Number of different positions to be recorded in the ring.
2006 Changing this requires a restart of Emacs to work correctly."
2007 :group 'org-link-follow
2008 :type 'integer)
2010 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2011 "Non-nil means internal links in Org files must exactly match a headline.
2012 When nil, the link search tries to match a phrase with all words
2013 in the search text."
2014 :group 'org-link-follow
2015 :version "24.1"
2016 :type '(choice
2017 (const :tag "Use fuzzy text search" nil)
2018 (const :tag "Match only exact headline" t)
2019 (const :tag "Match exact headline or query to create it"
2020 query-to-create)))
2022 (defcustom org-link-frame-setup
2023 '((vm . vm-visit-folder-other-frame)
2024 (vm-imap . vm-visit-imap-folder-other-frame)
2025 (gnus . org-gnus-no-new-news)
2026 (file . find-file-other-window)
2027 (wl . wl-other-frame))
2028 "Setup the frame configuration for following links.
2029 When following a link with Emacs, it may often be useful to display
2030 this link in another window or frame. This variable can be used to
2031 set this up for the different types of links.
2032 For VM, use any of
2033 `vm-visit-folder'
2034 `vm-visit-folder-other-window'
2035 `vm-visit-folder-other-frame'
2036 For Gnus, use any of
2037 `gnus'
2038 `gnus-other-frame'
2039 `org-gnus-no-new-news'
2040 For FILE, use any of
2041 `find-file'
2042 `find-file-other-window'
2043 `find-file-other-frame'
2044 For Wanderlust use any of
2045 `wl'
2046 `wl-other-frame'
2047 For the calendar, use the variable `calendar-setup'.
2048 For BBDB, it is currently only possible to display the matches in
2049 another window."
2050 :group 'org-link-follow
2051 :type '(list
2052 (cons (const vm)
2053 (choice
2054 (const vm-visit-folder)
2055 (const vm-visit-folder-other-window)
2056 (const vm-visit-folder-other-frame)))
2057 (cons (const vm-imap)
2058 (choice
2059 (const vm-visit-imap-folder)
2060 (const vm-visit-imap-folder-other-window)
2061 (const vm-visit-imap-folder-other-frame)))
2062 (cons (const gnus)
2063 (choice
2064 (const gnus)
2065 (const gnus-other-frame)
2066 (const org-gnus-no-new-news)))
2067 (cons (const file)
2068 (choice
2069 (const find-file)
2070 (const find-file-other-window)
2071 (const find-file-other-frame)))
2072 (cons (const wl)
2073 (choice
2074 (const wl)
2075 (const wl-other-frame)))))
2077 (defcustom org-display-internal-link-with-indirect-buffer nil
2078 "Non-nil means use indirect buffer to display infile links.
2079 Activating internal links (from one location in a file to another location
2080 in the same file) normally just jumps to the location. When the link is
2081 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2082 is displayed in
2083 another window. When this option is set, the other window actually displays
2084 an indirect buffer clone of the current buffer, to avoid any visibility
2085 changes to the current buffer."
2086 :group 'org-link-follow
2087 :type 'boolean)
2089 (defcustom org-open-non-existing-files nil
2090 "Non-nil means `org-open-file' will open non-existing files.
2091 When nil, an error will be generated.
2092 This variable applies only to external applications because they
2093 might choke on non-existing files. If the link is to a file that
2094 will be opened in Emacs, the variable is ignored."
2095 :group 'org-link-follow
2096 :type 'boolean)
2098 (defcustom org-open-directory-means-index-dot-org nil
2099 "Non-nil means a link to a directory really means to index.org.
2100 When nil, following a directory link will run dired or open a finder/explorer
2101 window on that directory."
2102 :group 'org-link-follow
2103 :type 'boolean)
2105 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2106 "Non-nil means ask for confirmation before executing shell links.
2107 Shell links can be dangerous: just think about a link
2109 [[shell:rm -rf ~/*][Google Search]]
2111 This link would show up in your Org-mode document as \"Google Search\",
2112 but really it would remove your entire home directory.
2113 Therefore we advise against setting this variable to nil.
2114 Just change it to `y-or-n-p' if you want to confirm with a
2115 single keystroke rather than having to type \"yes\"."
2116 :group 'org-link-follow
2117 :type '(choice
2118 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2119 (const :tag "with y-or-n (faster)" y-or-n-p)
2120 (const :tag "no confirmation (dangerous)" nil)))
2121 (put 'org-confirm-shell-link-function
2122 'safe-local-variable
2123 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2125 (defcustom org-confirm-shell-link-not-regexp ""
2126 "A regexp to skip confirmation for shell links."
2127 :group 'org-link-follow
2128 :version "24.1"
2129 :type 'regexp)
2131 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2132 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2133 Elisp links can be dangerous: just think about a link
2135 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2137 This link would show up in your Org-mode document as \"Google Search\",
2138 but really it would remove your entire home directory.
2139 Therefore we advise against setting this variable to nil.
2140 Just change it to `y-or-n-p' if you want to confirm with a
2141 single keystroke rather than having to type \"yes\"."
2142 :group 'org-link-follow
2143 :type '(choice
2144 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2145 (const :tag "with y-or-n (faster)" y-or-n-p)
2146 (const :tag "no confirmation (dangerous)" nil)))
2147 (put 'org-confirm-shell-link-function
2148 'safe-local-variable
2149 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2151 (defcustom org-confirm-elisp-link-not-regexp ""
2152 "A regexp to skip confirmation for Elisp links."
2153 :group 'org-link-follow
2154 :version "24.1"
2155 :type 'regexp)
2157 (defconst org-file-apps-defaults-gnu
2158 '((remote . emacs)
2159 (system . mailcap)
2160 (t . mailcap))
2161 "Default file applications on a UNIX or GNU/Linux system.
2162 See `org-file-apps'.")
2164 (defconst org-file-apps-defaults-macosx
2165 '((remote . emacs)
2166 (t . "open %s")
2167 (system . "open %s")
2168 ("ps.gz" . "gv %s")
2169 ("eps.gz" . "gv %s")
2170 ("dvi" . "xdvi %s")
2171 ("fig" . "xfig %s"))
2172 "Default file applications on a MacOS X system.
2173 The system \"open\" is known as a default, but we use X11 applications
2174 for some files for which the OS does not have a good default.
2175 See `org-file-apps'.")
2177 (defconst org-file-apps-defaults-windowsnt
2178 (list
2179 '(remote . emacs)
2180 (cons t
2181 (list (if (featurep 'xemacs)
2182 'mswindows-shell-execute
2183 'w32-shell-execute)
2184 "open" 'file))
2185 (cons 'system
2186 (list (if (featurep 'xemacs)
2187 'mswindows-shell-execute
2188 'w32-shell-execute)
2189 "open" 'file)))
2190 "Default file applications on a Windows NT system.
2191 The system \"open\" is used for most files.
2192 See `org-file-apps'.")
2194 (defcustom org-file-apps
2195 '((auto-mode . emacs)
2196 ("\\.mm\\'" . default)
2197 ("\\.x?html?\\'" . default)
2198 ("\\.pdf\\'" . default))
2199 "External applications for opening `file:path' items in a document.
2200 Org-mode uses system defaults for different file types, but
2201 you can use this variable to set the application for a given file
2202 extension. The entries in this list are cons cells where the car identifies
2203 files and the cdr the corresponding command. Possible values for the
2204 file identifier are
2205 \"string\" A string as a file identifier can be interpreted in different
2206 ways, depending on its contents:
2208 - Alphanumeric characters only:
2209 Match links with this file extension.
2210 Example: (\"pdf\" . \"evince %s\")
2211 to open PDFs with evince.
2213 - Regular expression: Match links where the
2214 filename matches the regexp. If you want to
2215 use groups here, use shy groups.
2217 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2218 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2219 to open *.html and *.xhtml with firefox.
2221 - Regular expression which contains (non-shy) groups:
2222 Match links where the whole link, including \"::\", and
2223 anything after that, matches the regexp.
2224 In a custom command string, %1, %2, etc. are replaced with
2225 the parts of the link that were matched by the groups.
2226 For backwards compatibility, if a command string is given
2227 that does not use any of the group matches, this case is
2228 handled identically to the second one (i.e. match against
2229 file name only).
2230 In a custom lisp form, you can access the group matches with
2231 (match-string n link).
2233 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2234 to open [[file:document.pdf::5]] with evince at page 5.
2236 `directory' Matches a directory
2237 `remote' Matches a remote file, accessible through tramp or efs.
2238 Remote files most likely should be visited through Emacs
2239 because external applications cannot handle such paths.
2240 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2241 so all files Emacs knows how to handle. Using this with
2242 command `emacs' will open most files in Emacs. Beware that this
2243 will also open html files inside Emacs, unless you add
2244 (\"html\" . default) to the list as well.
2245 t Default for files not matched by any of the other options.
2246 `system' The system command to open files, like `open' on Windows
2247 and Mac OS X, and mailcap under GNU/Linux. This is the command
2248 that will be selected if you call `C-c C-o' with a double
2249 \\[universal-argument] \\[universal-argument] prefix.
2251 Possible values for the command are:
2252 `emacs' The file will be visited by the current Emacs process.
2253 `default' Use the default application for this file type, which is the
2254 association for t in the list, most likely in the system-specific
2255 part.
2256 This can be used to overrule an unwanted setting in the
2257 system-specific variable.
2258 `system' Use the system command for opening files, like \"open\".
2259 This command is specified by the entry whose car is `system'.
2260 Most likely, the system-specific version of this variable
2261 does define this command, but you can overrule/replace it
2262 here.
2263 string A command to be executed by a shell; %s will be replaced
2264 by the path to the file.
2265 sexp A Lisp form which will be evaluated. The file path will
2266 be available in the Lisp variable `file'.
2267 For more examples, see the system specific constants
2268 `org-file-apps-defaults-macosx'
2269 `org-file-apps-defaults-windowsnt'
2270 `org-file-apps-defaults-gnu'."
2271 :group 'org-link-follow
2272 :type '(repeat
2273 (cons (choice :value ""
2274 (string :tag "Extension")
2275 (const :tag "System command to open files" system)
2276 (const :tag "Default for unrecognized files" t)
2277 (const :tag "Remote file" remote)
2278 (const :tag "Links to a directory" directory)
2279 (const :tag "Any files that have Emacs modes"
2280 auto-mode))
2281 (choice :value ""
2282 (const :tag "Visit with Emacs" emacs)
2283 (const :tag "Use default" default)
2284 (const :tag "Use the system command" system)
2285 (string :tag "Command")
2286 (sexp :tag "Lisp form")))))
2288 (defcustom org-doi-server-url "http://dx.doi.org/"
2289 "The URL of the DOI server."
2290 :type 'string
2291 :version "24.3"
2292 :group 'org-link-follow)
2294 (defgroup org-refile nil
2295 "Options concerning refiling entries in Org-mode."
2296 :tag "Org Refile"
2297 :group 'org)
2299 (defcustom org-directory "~/org"
2300 "Directory with org files.
2301 This is just a default location to look for Org files. There is no need
2302 at all to put your files into this directory. It is only used in the
2303 following situations:
2305 1. When a capture template specifies a target file that is not an
2306 absolute path. The path will then be interpreted relative to
2307 `org-directory'
2308 2. When a capture note is filed away in an interactive way (when exiting the
2309 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2310 with `org-directory' as the default path."
2311 :group 'org-refile
2312 :group 'org-capture
2313 :type 'directory)
2315 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2316 "Default target for storing notes.
2317 Used as a fall back file for org-capture.el, for templates that
2318 do not specify a target file."
2319 :group 'org-refile
2320 :group 'org-capture
2321 :type '(choice
2322 (const :tag "Default from remember-data-file" nil)
2323 file))
2325 (defcustom org-goto-interface 'outline
2326 "The default interface to be used for `org-goto'.
2327 Allowed values are:
2328 outline The interface shows an outline of the relevant file
2329 and the correct heading is found by moving through
2330 the outline or by searching with incremental search.
2331 outline-path-completion Headlines in the current buffer are offered via
2332 completion. This is the interface also used by
2333 the refile command."
2334 :group 'org-refile
2335 :type '(choice
2336 (const :tag "Outline" outline)
2337 (const :tag "Outline-path-completion" outline-path-completion)))
2339 (defcustom org-goto-max-level 5
2340 "Maximum target level when running `org-goto' with refile interface."
2341 :group 'org-refile
2342 :type 'integer)
2344 (defcustom org-reverse-note-order nil
2345 "Non-nil means store new notes at the beginning of a file or entry.
2346 When nil, new notes will be filed to the end of a file or entry.
2347 This can also be a list with cons cells of regular expressions that
2348 are matched against file names, and values."
2349 :group 'org-capture
2350 :group 'org-refile
2351 :type '(choice
2352 (const :tag "Reverse always" t)
2353 (const :tag "Reverse never" nil)
2354 (repeat :tag "By file name regexp"
2355 (cons regexp boolean))))
2357 (defcustom org-log-refile nil
2358 "Information to record when a task is refiled.
2360 Possible values are:
2362 nil Don't add anything
2363 time Add a time stamp to the task
2364 note Prompt for a note and add it with template `org-log-note-headings'
2366 This option can also be set with on a per-file-basis with
2368 #+STARTUP: nologrefile
2369 #+STARTUP: logrefile
2370 #+STARTUP: lognoterefile
2372 You can have local logging settings for a subtree by setting the LOGGING
2373 property to one or more of these keywords.
2375 When bulk-refiling from the agenda, the value `note' is forbidden and
2376 will temporarily be changed to `time'."
2377 :group 'org-refile
2378 :group 'org-progress
2379 :version "24.1"
2380 :type '(choice
2381 (const :tag "No logging" nil)
2382 (const :tag "Record timestamp" time)
2383 (const :tag "Record timestamp with note." note)))
2385 (defcustom org-refile-targets nil
2386 "Targets for refiling entries with \\[org-refile].
2387 This is a list of cons cells. Each cell contains:
2388 - a specification of the files to be considered, either a list of files,
2389 or a symbol whose function or variable value will be used to retrieve
2390 a file name or a list of file names. If you use `org-agenda-files' for
2391 that, all agenda files will be scanned for targets. Nil means consider
2392 headings in the current buffer.
2393 - A specification of how to find candidate refile targets. This may be
2394 any of:
2395 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2396 This tag has to be present in all target headlines, inheritance will
2397 not be considered.
2398 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2399 todo keyword.
2400 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2401 headlines that are refiling targets.
2402 - a cons cell (:level . N). Any headline of level N is considered a target.
2403 Note that, when `org-odd-levels-only' is set, level corresponds to
2404 order in hierarchy, not to the number of stars.
2405 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2406 Note that, when `org-odd-levels-only' is set, level corresponds to
2407 order in hierarchy, not to the number of stars.
2409 Each element of this list generates a set of possible targets.
2410 The union of these sets is presented (with completion) to
2411 the user by `org-refile'.
2413 You can set the variable `org-refile-target-verify-function' to a function
2414 to verify each headline found by the simple criteria above.
2416 When this variable is nil, all top-level headlines in the current buffer
2417 are used, equivalent to the value `((nil . (:level . 1))'."
2418 :group 'org-refile
2419 :type '(repeat
2420 (cons
2421 (choice :value org-agenda-files
2422 (const :tag "All agenda files" org-agenda-files)
2423 (const :tag "Current buffer" nil)
2424 (function) (variable) (file))
2425 (choice :tag "Identify target headline by"
2426 (cons :tag "Specific tag" (const :value :tag) (string))
2427 (cons :tag "TODO keyword" (const :value :todo) (string))
2428 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2429 (cons :tag "Level number" (const :value :level) (integer))
2430 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2432 (defcustom org-refile-target-verify-function nil
2433 "Function to verify if the headline at point should be a refile target.
2434 The function will be called without arguments, with point at the
2435 beginning of the headline. It should return t and leave point
2436 where it is if the headline is a valid target for refiling.
2438 If the target should not be selected, the function must return nil.
2439 In addition to this, it may move point to a place from where the search
2440 should be continued. For example, the function may decide that the entire
2441 subtree of the current entry should be excluded and move point to the end
2442 of the subtree."
2443 :group 'org-refile
2444 :type '(choice
2445 (const nil)
2446 (function)))
2448 (defcustom org-refile-use-cache nil
2449 "Non-nil means cache refile targets to speed up the process.
2450 The cache for a particular file will be updated automatically when
2451 the buffer has been killed, or when any of the marker used for flagging
2452 refile targets no longer points at a live buffer.
2453 If you have added new entries to a buffer that might themselves be targets,
2454 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2455 find that easier, `C-u C-u C-u C-c C-w'."
2456 :group 'org-refile
2457 :version "24.1"
2458 :type 'boolean)
2460 (defcustom org-refile-use-outline-path nil
2461 "Non-nil means provide refile targets as paths.
2462 So a level 3 headline will be available as level1/level2/level3.
2464 When the value is `file', also include the file name (without directory)
2465 into the path. In this case, you can also stop the completion after
2466 the file name, to get entries inserted as top level in the file.
2468 When `full-file-path', include the full file path."
2469 :group 'org-refile
2470 :type '(choice
2471 (const :tag "Not" nil)
2472 (const :tag "Yes" t)
2473 (const :tag "Start with file name" file)
2474 (const :tag "Start with full file path" full-file-path)))
2476 (defcustom org-outline-path-complete-in-steps t
2477 "Non-nil means complete the outline path in hierarchical steps.
2478 When Org-mode uses the refile interface to select an outline path
2479 \(see variable `org-refile-use-outline-path'), the completion of
2480 the path can be done is a single go, or if can be done in steps down
2481 the headline hierarchy. Going in steps is probably the best if you
2482 do not use a special completion package like `ido' or `icicles'.
2483 However, when using these packages, going in one step can be very
2484 fast, while still showing the whole path to the entry."
2485 :group 'org-refile
2486 :type 'boolean)
2488 (defcustom org-refile-allow-creating-parent-nodes nil
2489 "Non-nil means allow to create new nodes as refile targets.
2490 New nodes are then created by adding \"/new node name\" to the completion
2491 of an existing node. When the value of this variable is `confirm',
2492 new node creation must be confirmed by the user (recommended).
2493 When nil, the completion must match an existing entry.
2495 Note that, if the new heading is not seen by the criteria
2496 listed in `org-refile-targets', multiple instances of the same
2497 heading would be created by trying again to file under the new
2498 heading."
2499 :group 'org-refile
2500 :type '(choice
2501 (const :tag "Never" nil)
2502 (const :tag "Always" t)
2503 (const :tag "Prompt for confirmation" confirm)))
2505 (defcustom org-refile-active-region-within-subtree nil
2506 "Non-nil means also refile active region within a subtree.
2508 By default `org-refile' doesn't allow refiling regions if they
2509 don't contain a set of subtrees, but it might be convenient to
2510 do so sometimes: in that case, the first line of the region is
2511 converted to a headline before refiling."
2512 :group 'org-refile
2513 :version "24.1"
2514 :type 'boolean)
2516 (defgroup org-todo nil
2517 "Options concerning TODO items in Org-mode."
2518 :tag "Org TODO"
2519 :group 'org)
2521 (defgroup org-progress nil
2522 "Options concerning Progress logging in Org-mode."
2523 :tag "Org Progress"
2524 :group 'org-time)
2526 (defvar org-todo-interpretation-widgets
2527 '((:tag "Sequence (cycling hits every state)" sequence)
2528 (:tag "Type (cycling directly to DONE)" type))
2529 "The available interpretation symbols for customizing `org-todo-keywords'.
2530 Interested libraries should add to this list.")
2532 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2533 "List of TODO entry keyword sequences and their interpretation.
2534 \\<org-mode-map>This is a list of sequences.
2536 Each sequence starts with a symbol, either `sequence' or `type',
2537 indicating if the keywords should be interpreted as a sequence of
2538 action steps, or as different types of TODO items. The first
2539 keywords are states requiring action - these states will select a headline
2540 for inclusion into the global TODO list Org-mode produces. If one of
2541 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2542 signify that no further action is necessary. If \"|\" is not found,
2543 the last keyword is treated as the only DONE state of the sequence.
2545 The command \\[org-todo] cycles an entry through these states, and one
2546 additional state where no keyword is present. For details about this
2547 cycling, see the manual.
2549 TODO keywords and interpretation can also be set on a per-file basis with
2550 the special #+SEQ_TODO and #+TYP_TODO lines.
2552 Each keyword can optionally specify a character for fast state selection
2553 \(in combination with the variable `org-use-fast-todo-selection')
2554 and specifiers for state change logging, using the same syntax that
2555 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2556 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2557 indicates to record a time stamp each time this state is selected.
2559 Each keyword may also specify if a timestamp or a note should be
2560 recorded when entering or leaving the state, by adding additional
2561 characters in the parenthesis after the keyword. This looks like this:
2562 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2563 record only the time of the state change. With X and Y being either
2564 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2565 Y when leaving the state if and only if the *target* state does not
2566 define X. You may omit any of the fast-selection key or X or /Y,
2567 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2569 For backward compatibility, this variable may also be just a list
2570 of keywords. In this case the interpretation (sequence or type) will be
2571 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2572 :group 'org-todo
2573 :group 'org-keywords
2574 :type '(choice
2575 (repeat :tag "Old syntax, just keywords"
2576 (string :tag "Keyword"))
2577 (repeat :tag "New syntax"
2578 (cons
2579 (choice
2580 :tag "Interpretation"
2581 ;;Quick and dirty way to see
2582 ;;`org-todo-interpretations'. This takes the
2583 ;;place of item arguments
2584 :convert-widget
2585 (lambda (widget)
2586 (widget-put widget
2587 :args (mapcar
2588 (lambda (x)
2589 (widget-convert
2590 (cons 'const x)))
2591 org-todo-interpretation-widgets))
2592 widget))
2593 (repeat
2594 (string :tag "Keyword"))))))
2596 (defvar org-todo-keywords-1 nil
2597 "All TODO and DONE keywords active in a buffer.")
2598 (make-variable-buffer-local 'org-todo-keywords-1)
2599 (defvar org-todo-keywords-for-agenda nil)
2600 (defvar org-done-keywords-for-agenda nil)
2601 (defvar org-todo-keyword-alist-for-agenda nil)
2602 (defvar org-tag-alist-for-agenda nil
2603 "Alist of all tags from all agenda files.")
2604 (defvar org-tag-groups-alist-for-agenda nil
2605 "Alist of all groups tags from all current agenda files.")
2606 (defvar org-tag-groups-alist nil)
2607 (make-variable-buffer-local 'org-tag-groups-alist)
2608 (defvar org-agenda-contributing-files nil)
2609 (defvar org-not-done-keywords nil)
2610 (make-variable-buffer-local 'org-not-done-keywords)
2611 (defvar org-done-keywords nil)
2612 (make-variable-buffer-local 'org-done-keywords)
2613 (defvar org-todo-heads nil)
2614 (make-variable-buffer-local 'org-todo-heads)
2615 (defvar org-todo-sets nil)
2616 (make-variable-buffer-local 'org-todo-sets)
2617 (defvar org-todo-log-states nil)
2618 (make-variable-buffer-local 'org-todo-log-states)
2619 (defvar org-todo-kwd-alist nil)
2620 (make-variable-buffer-local 'org-todo-kwd-alist)
2621 (defvar org-todo-key-alist nil)
2622 (make-variable-buffer-local 'org-todo-key-alist)
2623 (defvar org-todo-key-trigger nil)
2624 (make-variable-buffer-local 'org-todo-key-trigger)
2626 (defcustom org-todo-interpretation 'sequence
2627 "Controls how TODO keywords are interpreted.
2628 This variable is in principle obsolete and is only used for
2629 backward compatibility, if the interpretation of todo keywords is
2630 not given already in `org-todo-keywords'. See that variable for
2631 more information."
2632 :group 'org-todo
2633 :group 'org-keywords
2634 :type '(choice (const sequence)
2635 (const type)))
2637 (defcustom org-use-fast-todo-selection t
2638 "Non-nil means use the fast todo selection scheme with C-c C-t.
2639 This variable describes if and under what circumstances the cycling
2640 mechanism for TODO keywords will be replaced by a single-key, direct
2641 selection scheme.
2643 When nil, fast selection is never used.
2645 When the symbol `prefix', it will be used when `org-todo' is called
2646 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2647 `C-u t' in an agenda buffer.
2649 When t, fast selection is used by default. In this case, the prefix
2650 argument forces cycling instead.
2652 In all cases, the special interface is only used if access keys have
2653 actually been assigned by the user, i.e. if keywords in the configuration
2654 are followed by a letter in parenthesis, like TODO(t)."
2655 :group 'org-todo
2656 :type '(choice
2657 (const :tag "Never" nil)
2658 (const :tag "By default" t)
2659 (const :tag "Only with C-u C-c C-t" prefix)))
2661 (defcustom org-provide-todo-statistics t
2662 "Non-nil means update todo statistics after insert and toggle.
2663 ALL-HEADLINES means update todo statistics by including headlines
2664 with no TODO keyword as well, counting them as not done.
2665 A list of TODO keywords means the same, but skip keywords that are
2666 not in this list.
2667 When set to a list of two lists, the first list contains keywords
2668 to consider as TODO keywords, the second list contains keywords
2669 to consider as DONE keywords.
2671 When this is set, todo statistics is updated in the parent of the
2672 current entry each time a todo state is changed."
2673 :group 'org-todo
2674 :type '(choice
2675 (const :tag "Yes, only for TODO entries" t)
2676 (const :tag "Yes, including all entries" all-headlines)
2677 (repeat :tag "Yes, for TODOs in this list"
2678 (string :tag "TODO keyword"))
2679 (list :tag "Yes, for TODOs and DONEs in these lists"
2680 (repeat (string :tag "TODO keyword"))
2681 (repeat (string :tag "DONE keyword")))
2682 (other :tag "No TODO statistics" nil)))
2684 (defcustom org-hierarchical-todo-statistics t
2685 "Non-nil means TODO statistics covers just direct children.
2686 When nil, all entries in the subtree are considered.
2687 This has only an effect if `org-provide-todo-statistics' is set.
2688 To set this to nil for only a single subtree, use a COOKIE_DATA
2689 property and include the word \"recursive\" into the value."
2690 :group 'org-todo
2691 :type 'boolean)
2693 (defcustom org-after-todo-state-change-hook nil
2694 "Hook which is run after the state of a TODO item was changed.
2695 The new state (a string with a TODO keyword, or nil) is available in the
2696 Lisp variable `org-state'."
2697 :group 'org-todo
2698 :type 'hook)
2700 (defvar org-blocker-hook nil
2701 "Hook for functions that are allowed to block a state change.
2703 Functions in this hook should not modify the buffer.
2704 Each function gets as its single argument a property list,
2705 see `org-trigger-hook' for more information about this list.
2707 If any of the functions in this hook returns nil, the state change
2708 is blocked.")
2710 (defvar org-trigger-hook nil
2711 "Hook for functions that are triggered by a state change.
2713 Each function gets as its single argument a property list with at
2714 least the following elements:
2716 (:type type-of-change :position pos-at-entry-start
2717 :from old-state :to new-state)
2719 Depending on the type, more properties may be present.
2721 This mechanism is currently implemented for:
2723 TODO state changes
2724 ------------------
2725 :type todo-state-change
2726 :from previous state (keyword as a string), or nil, or a symbol
2727 'todo' or 'done', to indicate the general type of state.
2728 :to new state, like in :from")
2730 (defcustom org-enforce-todo-dependencies nil
2731 "Non-nil means undone TODO entries will block switching the parent to DONE.
2732 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2733 be blocked if any prior sibling is not yet done.
2734 Finally, if the parent is blocked because of ordered siblings of its own,
2735 the child will also be blocked."
2736 :set (lambda (var val)
2737 (set var val)
2738 (if val
2739 (add-hook 'org-blocker-hook
2740 'org-block-todo-from-children-or-siblings-or-parent)
2741 (remove-hook 'org-blocker-hook
2742 'org-block-todo-from-children-or-siblings-or-parent)))
2743 :group 'org-todo
2744 :type 'boolean)
2746 (defcustom org-enforce-todo-checkbox-dependencies nil
2747 "Non-nil means unchecked boxes will block switching the parent to DONE.
2748 When this is nil, checkboxes have no influence on switching TODO states.
2749 When non-nil, you first need to check off all check boxes before the TODO
2750 entry can be switched to DONE.
2751 This variable needs to be set before org.el is loaded, and you need to
2752 restart Emacs after a change to make the change effective. The only way
2753 to change is while Emacs is running is through the customize interface."
2754 :set (lambda (var val)
2755 (set var val)
2756 (if val
2757 (add-hook 'org-blocker-hook
2758 'org-block-todo-from-checkboxes)
2759 (remove-hook 'org-blocker-hook
2760 'org-block-todo-from-checkboxes)))
2761 :group 'org-todo
2762 :type 'boolean)
2764 (defcustom org-treat-insert-todo-heading-as-state-change nil
2765 "Non-nil means inserting a TODO heading is treated as state change.
2766 So when the command \\[org-insert-todo-heading] is used, state change
2767 logging will apply if appropriate. When nil, the new TODO item will
2768 be inserted directly, and no logging will take place."
2769 :group 'org-todo
2770 :type 'boolean)
2772 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2773 "Non-nil means switching TODO states with S-cursor counts as state change.
2774 This is the default behavior. However, setting this to nil allows a
2775 convenient way to select a TODO state and bypass any logging associated
2776 with that."
2777 :group 'org-todo
2778 :type 'boolean)
2780 (defcustom org-todo-state-tags-triggers nil
2781 "Tag changes that should be triggered by TODO state changes.
2782 This is a list. Each entry is
2784 (state-change (tag . flag) .......)
2786 State-change can be a string with a state, and empty string to indicate the
2787 state that has no TODO keyword, or it can be one of the symbols `todo'
2788 or `done', meaning any not-done or done state, respectively."
2789 :group 'org-todo
2790 :group 'org-tags
2791 :type '(repeat
2792 (cons (choice :tag "When changing to"
2793 (const :tag "Not-done state" todo)
2794 (const :tag "Done state" done)
2795 (string :tag "State"))
2796 (repeat
2797 (cons :tag "Tag action"
2798 (string :tag "Tag")
2799 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2801 (defcustom org-log-done nil
2802 "Information to record when a task moves to the DONE state.
2804 Possible values are:
2806 nil Don't add anything, just change the keyword
2807 time Add a time stamp to the task
2808 note Prompt for a note and add it with template `org-log-note-headings'
2810 This option can also be set with on a per-file-basis with
2812 #+STARTUP: nologdone
2813 #+STARTUP: logdone
2814 #+STARTUP: lognotedone
2816 You can have local logging settings for a subtree by setting the LOGGING
2817 property to one or more of these keywords."
2818 :group 'org-todo
2819 :group 'org-progress
2820 :type '(choice
2821 (const :tag "No logging" nil)
2822 (const :tag "Record CLOSED timestamp" time)
2823 (const :tag "Record CLOSED timestamp with note." note)))
2825 ;; Normalize old uses of org-log-done.
2826 (cond
2827 ((eq org-log-done t) (setq org-log-done 'time))
2828 ((and (listp org-log-done) (memq 'done org-log-done))
2829 (setq org-log-done 'note)))
2831 (defcustom org-log-reschedule nil
2832 "Information to record when the scheduling date of a tasks is modified.
2834 Possible values are:
2836 nil Don't add anything, just change the date
2837 time Add a time stamp to the task
2838 note Prompt for a note and add it with template `org-log-note-headings'
2840 This option can also be set with on a per-file-basis with
2842 #+STARTUP: nologreschedule
2843 #+STARTUP: logreschedule
2844 #+STARTUP: lognotereschedule"
2845 :group 'org-todo
2846 :group 'org-progress
2847 :type '(choice
2848 (const :tag "No logging" nil)
2849 (const :tag "Record timestamp" time)
2850 (const :tag "Record timestamp with note." note)))
2852 (defcustom org-log-redeadline nil
2853 "Information to record when the deadline date of a tasks is modified.
2855 Possible values are:
2857 nil Don't add anything, just change the date
2858 time Add a time stamp to the task
2859 note Prompt for a note and add it with template `org-log-note-headings'
2861 This option can also be set with on a per-file-basis with
2863 #+STARTUP: nologredeadline
2864 #+STARTUP: logredeadline
2865 #+STARTUP: lognoteredeadline
2867 You can have local logging settings for a subtree by setting the LOGGING
2868 property to one or more of these keywords."
2869 :group 'org-todo
2870 :group 'org-progress
2871 :type '(choice
2872 (const :tag "No logging" nil)
2873 (const :tag "Record timestamp" time)
2874 (const :tag "Record timestamp with note." note)))
2876 (defcustom org-log-note-clock-out nil
2877 "Non-nil means record a note when clocking out of an item.
2878 This can also be configured on a per-file basis by adding one of
2879 the following lines anywhere in the buffer:
2881 #+STARTUP: lognoteclock-out
2882 #+STARTUP: nolognoteclock-out"
2883 :group 'org-todo
2884 :group 'org-progress
2885 :type 'boolean)
2887 (defcustom org-log-done-with-time t
2888 "Non-nil means the CLOSED time stamp will contain date and time.
2889 When nil, only the date will be recorded."
2890 :group 'org-progress
2891 :type 'boolean)
2893 (defcustom org-log-note-headings
2894 '((done . "CLOSING NOTE %t")
2895 (state . "State %-12s from %-12S %t")
2896 (note . "Note taken on %t")
2897 (reschedule . "Rescheduled from %S on %t")
2898 (delschedule . "Not scheduled, was %S on %t")
2899 (redeadline . "New deadline from %S on %t")
2900 (deldeadline . "Removed deadline, was %S on %t")
2901 (refile . "Refiled on %t")
2902 (clock-out . ""))
2903 "Headings for notes added to entries.
2904 The value is an alist, with the car being a symbol indicating the note
2905 context, and the cdr is the heading to be used. The heading may also be the
2906 empty string.
2907 %t in the heading will be replaced by a time stamp.
2908 %T will be an active time stamp instead the default inactive one
2909 %d will be replaced by a short-format time stamp.
2910 %D will be replaced by an active short-format time stamp.
2911 %s will be replaced by the new TODO state, in double quotes.
2912 %S will be replaced by the old TODO state, in double quotes.
2913 %u will be replaced by the user name.
2914 %U will be replaced by the full user name.
2916 In fact, it is not a good idea to change the `state' entry, because
2917 agenda log mode depends on the format of these entries."
2918 :group 'org-todo
2919 :group 'org-progress
2920 :type '(list :greedy t
2921 (cons (const :tag "Heading when closing an item" done) string)
2922 (cons (const :tag
2923 "Heading when changing todo state (todo sequence only)"
2924 state) string)
2925 (cons (const :tag "Heading when just taking a note" note) string)
2926 (cons (const :tag "Heading when rescheduling" reschedule) string)
2927 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2928 (cons (const :tag "Heading when changing deadline" redeadline) string)
2929 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2930 (cons (const :tag "Heading when refiling" refile) string)
2931 (cons (const :tag "Heading when clocking out" clock-out) string)))
2933 (unless (assq 'note org-log-note-headings)
2934 (push '(note . "%t") org-log-note-headings))
2936 (defcustom org-log-into-drawer nil
2937 "Non-nil means insert state change notes and time stamps into a drawer.
2938 When nil, state changes notes will be inserted after the headline and
2939 any scheduling and clock lines, but not inside a drawer.
2941 The value of this variable should be the name of the drawer to use.
2942 LOGBOOK is proposed as the default drawer for this purpose, you can
2943 also set this to a string to define the drawer of your choice.
2945 A value of t is also allowed, representing \"LOGBOOK\".
2947 A value of t or nil can also be set with on a per-file-basis with
2949 #+STARTUP: logdrawer
2950 #+STARTUP: nologdrawer
2952 If this variable is set, `org-log-state-notes-insert-after-drawers'
2953 will be ignored.
2955 You can set the property LOG_INTO_DRAWER to overrule this setting for
2956 a subtree.
2958 Do not check directly this variable in a Lisp program. Call
2959 function `org-log-into-drawer' instead."
2960 :group 'org-todo
2961 :group 'org-progress
2962 :type '(choice
2963 (const :tag "Not into a drawer" nil)
2964 (const :tag "LOGBOOK" t)
2965 (string :tag "Other")))
2967 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2969 (defun org-log-into-drawer ()
2970 "Name of the log drawer, as a string, or nil.
2971 This is the value of `org-log-into-drawer'. However, if the
2972 current entry has or inherits a LOG_INTO_DRAWER property, it will
2973 be used instead of the default value."
2974 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2975 (cond ((equal p "nil") nil)
2976 ((equal p "t") "LOGBOOK")
2977 ((stringp p) p)
2978 (p "LOGBOOK")
2979 ((stringp org-log-into-drawer) org-log-into-drawer)
2980 (org-log-into-drawer "LOGBOOK"))))
2982 (defcustom org-log-state-notes-insert-after-drawers nil
2983 "Non-nil means insert state change notes after any drawers in entry.
2984 Only the drawers that *immediately* follow the headline and the
2985 deadline/scheduled line are skipped.
2986 When nil, insert notes right after the heading and perhaps the line
2987 with deadline/scheduling if present.
2989 This variable will have no effect if `org-log-into-drawer' is
2990 set."
2991 :group 'org-todo
2992 :group 'org-progress
2993 :type 'boolean)
2995 (defcustom org-log-states-order-reversed t
2996 "Non-nil means the latest state note will be directly after heading.
2997 When nil, the state change notes will be ordered according to time.
2999 This option can also be set with on a per-file-basis with
3001 #+STARTUP: logstatesreversed
3002 #+STARTUP: nologstatesreversed"
3003 :group 'org-todo
3004 :group 'org-progress
3005 :type 'boolean)
3007 (defcustom org-todo-repeat-to-state nil
3008 "The TODO state to which a repeater should return the repeating task.
3009 By default this is the first task in a TODO sequence, or the previous state
3010 in a TODO_TYP set. But you can specify another task here.
3011 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3012 :group 'org-todo
3013 :version "24.1"
3014 :type '(choice (const :tag "Head of sequence" nil)
3015 (string :tag "Specific state")))
3017 (defcustom org-log-repeat 'time
3018 "Non-nil means record moving through the DONE state when triggering repeat.
3019 An auto-repeating task is immediately switched back to TODO when
3020 marked DONE. If you are not logging state changes (by adding \"@\"
3021 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3022 record a closing note, there will be no record of the task moving
3023 through DONE. This variable forces taking a note anyway.
3025 nil Don't force a record
3026 time Record a time stamp
3027 note Prompt for a note and add it with template `org-log-note-headings'
3029 This option can also be set with on a per-file-basis with
3031 #+STARTUP: nologrepeat
3032 #+STARTUP: logrepeat
3033 #+STARTUP: lognoterepeat
3035 You can have local logging settings for a subtree by setting the LOGGING
3036 property to one or more of these keywords."
3037 :group 'org-todo
3038 :group 'org-progress
3039 :type '(choice
3040 (const :tag "Don't force a record" nil)
3041 (const :tag "Force recording the DONE state" time)
3042 (const :tag "Force recording a note with the DONE state" note)))
3045 (defgroup org-priorities nil
3046 "Priorities in Org-mode."
3047 :tag "Org Priorities"
3048 :group 'org-todo)
3050 (defcustom org-enable-priority-commands t
3051 "Non-nil means priority commands are active.
3052 When nil, these commands will be disabled, so that you never accidentally
3053 set a priority."
3054 :group 'org-priorities
3055 :type 'boolean)
3057 (defcustom org-highest-priority ?A
3058 "The highest priority of TODO items. A character like ?A, ?B etc.
3059 Must have a smaller ASCII number than `org-lowest-priority'."
3060 :group 'org-priorities
3061 :type 'character)
3063 (defcustom org-lowest-priority ?C
3064 "The lowest priority of TODO items. A character like ?A, ?B etc.
3065 Must have a larger ASCII number than `org-highest-priority'."
3066 :group 'org-priorities
3067 :type 'character)
3069 (defcustom org-default-priority ?B
3070 "The default priority of TODO items.
3071 This is the priority an item gets if no explicit priority is given.
3072 When starting to cycle on an empty priority the first step in the cycle
3073 depends on `org-priority-start-cycle-with-default'. The resulting first
3074 step priority must not exceed the range from `org-highest-priority' to
3075 `org-lowest-priority' which means that `org-default-priority' has to be
3076 in this range exclusive or inclusive the range boundaries. Else the
3077 first step refuses to set the default and the second will fall back
3078 to (depending on the command used) the highest or lowest priority."
3079 :group 'org-priorities
3080 :type 'character)
3082 (defcustom org-priority-start-cycle-with-default t
3083 "Non-nil means start with default priority when starting to cycle.
3084 When this is nil, the first step in the cycle will be (depending on the
3085 command used) one higher or lower than the default priority.
3086 See also `org-default-priority'."
3087 :group 'org-priorities
3088 :type 'boolean)
3090 (defcustom org-get-priority-function nil
3091 "Function to extract the priority from a string.
3092 The string is normally the headline. If this is nil Org computes the
3093 priority from the priority cookie like [#A] in the headline. It returns
3094 an integer, increasing by 1000 for each priority level.
3095 The user can set a different function here, which should take a string
3096 as an argument and return the numeric priority."
3097 :group 'org-priorities
3098 :version "24.1"
3099 :type '(choice
3100 (const nil)
3101 (function)))
3103 (defgroup org-time nil
3104 "Options concerning time stamps and deadlines in Org-mode."
3105 :tag "Org Time"
3106 :group 'org)
3108 (defcustom org-time-stamp-rounding-minutes '(0 5)
3109 "Number of minutes to round time stamps to.
3110 These are two values, the first applies when first creating a time stamp.
3111 The second applies when changing it with the commands `S-up' and `S-down'.
3112 When changing the time stamp, this means that it will change in steps
3113 of N minutes, as given by the second value.
3115 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3116 numbers should be factors of 60, so for example 5, 10, 15.
3118 When this is larger than 1, you can still force an exact time stamp by using
3119 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3120 and by using a prefix arg to `S-up/down' to specify the exact number
3121 of minutes to shift."
3122 :group 'org-time
3123 :get (lambda (var) ; Make sure both elements are there
3124 (if (integerp (default-value var))
3125 (list (default-value var) 5)
3126 (default-value var)))
3127 :type '(list
3128 (integer :tag "when inserting times")
3129 (integer :tag "when modifying times")))
3131 ;; Normalize old customizations of this variable.
3132 (when (integerp org-time-stamp-rounding-minutes)
3133 (setq org-time-stamp-rounding-minutes
3134 (list org-time-stamp-rounding-minutes
3135 org-time-stamp-rounding-minutes)))
3137 (defcustom org-display-custom-times nil
3138 "Non-nil means overlay custom formats over all time stamps.
3139 The formats are defined through the variable `org-time-stamp-custom-formats'.
3140 To turn this on on a per-file basis, insert anywhere in the file:
3141 #+STARTUP: customtime"
3142 :group 'org-time
3143 :set 'set-default
3144 :type 'sexp)
3145 (make-variable-buffer-local 'org-display-custom-times)
3147 (defcustom org-time-stamp-custom-formats
3148 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3149 "Custom formats for time stamps. See `format-time-string' for the syntax.
3150 These are overlaid over the default ISO format if the variable
3151 `org-display-custom-times' is set. Time like %H:%M should be at the
3152 end of the second format. The custom formats are also honored by export
3153 commands, if custom time display is turned on at the time of export."
3154 :group 'org-time
3155 :type 'sexp)
3157 (defun org-time-stamp-format (&optional long inactive)
3158 "Get the right format for a time string."
3159 (let ((f (if long (cdr org-time-stamp-formats)
3160 (car org-time-stamp-formats))))
3161 (if inactive
3162 (concat "[" (substring f 1 -1) "]")
3163 f)))
3165 (defcustom org-time-clocksum-format
3166 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3167 "The format string used when creating CLOCKSUM lines.
3168 This is also used when Org mode generates a time duration.
3170 The value can be a single format string containing two
3171 %-sequences, which will be filled with the number of hours and
3172 minutes in that order.
3174 Alternatively, the value can be a plist associating any of the
3175 keys :years, :months, :weeks, :days, :hours or :minutes with
3176 format strings. The time duration is formatted using only the
3177 time components that are needed and concatenating the results.
3178 If a time unit in absent, it falls back to the next smallest
3179 unit.
3181 The keys :require-years, :require-months, :require-days,
3182 :require-weeks, :require-hours, :require-minutes are also
3183 meaningful. A non-nil value for these keys indicates that the
3184 corresponding time component should always be included, even if
3185 its value is 0.
3188 For example,
3190 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3191 :require-minutes t)
3193 means durations longer than a day will be expressed in days,
3194 hours and minutes, and durations less than a day will always be
3195 expressed in hours and minutes (even for durations less than an
3196 hour).
3198 The value
3200 \(:days \"%dd\" :minutes \"%dm\")
3202 means durations longer than a day will be expressed in days and
3203 minutes, and durations less than a day will be expressed entirely
3204 in minutes (even for durations longer than an hour)."
3205 :group 'org-time
3206 :group 'org-clock
3207 :version "24.4"
3208 :package-version '(Org . "8.0")
3209 :type '(choice (string :tag "Format string")
3210 (set :tag "Plist"
3211 (group :inline t (const :tag "Years" :years)
3212 (string :tag "Format string"))
3213 (group :inline t
3214 (const :tag "Always show years" :require-years)
3215 (const t))
3216 (group :inline t (const :tag "Months" :months)
3217 (string :tag "Format string"))
3218 (group :inline t
3219 (const :tag "Always show months" :require-months)
3220 (const t))
3221 (group :inline t (const :tag "Weeks" :weeks)
3222 (string :tag "Format string"))
3223 (group :inline t
3224 (const :tag "Always show weeks" :require-weeks)
3225 (const t))
3226 (group :inline t (const :tag "Days" :days)
3227 (string :tag "Format string"))
3228 (group :inline t
3229 (const :tag "Always show days" :require-days)
3230 (const t))
3231 (group :inline t (const :tag "Hours" :hours)
3232 (string :tag "Format string"))
3233 (group :inline t
3234 (const :tag "Always show hours" :require-hours)
3235 (const t))
3236 (group :inline t (const :tag "Minutes" :minutes)
3237 (string :tag "Format string"))
3238 (group :inline t
3239 (const :tag "Always show minutes" :require-minutes)
3240 (const t)))))
3242 (defcustom org-time-clocksum-use-fractional nil
3243 "When non-nil, \\[org-clock-display] uses fractional times.
3244 See `org-time-clocksum-format' for more on time clock formats."
3245 :group 'org-time
3246 :group 'org-clock
3247 :version "24.3"
3248 :type 'boolean)
3250 (defcustom org-time-clocksum-use-effort-durations nil
3251 "When non-nil, \\[org-clock-display] uses effort durations.
3252 E.g. by default, one day is considered to be a 8 hours effort,
3253 so a task that has been clocked for 16 hours will be displayed
3254 as during 2 days in the clock display or in the clocktable.
3256 See `org-effort-durations' on how to set effort durations
3257 and `org-time-clocksum-format' for more on time clock formats."
3258 :group 'org-time
3259 :group 'org-clock
3260 :version "24.4"
3261 :package-version '(Org . "8.0")
3262 :type 'boolean)
3264 (defcustom org-time-clocksum-fractional-format "%.2f"
3265 "The format string used when creating CLOCKSUM lines,
3266 or when Org mode generates a time duration, if
3267 `org-time-clocksum-use-fractional' is enabled.
3269 The value can be a single format string containing one
3270 %-sequence, which will be filled with the number of hours as
3271 a float.
3273 Alternatively, the value can be a plist associating any of the
3274 keys :years, :months, :weeks, :days, :hours or :minutes with
3275 a format string. The time duration is formatted using the
3276 largest time unit which gives a non-zero integer part. If all
3277 specified formats have zero integer part, the smallest time unit
3278 is used."
3279 :group 'org-time
3280 :type '(choice (string :tag "Format string")
3281 (set (group :inline t (const :tag "Years" :years)
3282 (string :tag "Format string"))
3283 (group :inline t (const :tag "Months" :months)
3284 (string :tag "Format string"))
3285 (group :inline t (const :tag "Weeks" :weeks)
3286 (string :tag "Format string"))
3287 (group :inline t (const :tag "Days" :days)
3288 (string :tag "Format string"))
3289 (group :inline t (const :tag "Hours" :hours)
3290 (string :tag "Format string"))
3291 (group :inline t (const :tag "Minutes" :minutes)
3292 (string :tag "Format string")))))
3294 (defcustom org-deadline-warning-days 14
3295 "Number of days before expiration during which a deadline becomes active.
3296 This variable governs the display in sparse trees and in the agenda.
3297 When 0 or negative, it means use this number (the absolute value of it)
3298 even if a deadline has a different individual lead time specified.
3300 Custom commands can set this variable in the options section."
3301 :group 'org-time
3302 :group 'org-agenda-daily/weekly
3303 :type 'integer)
3305 (defcustom org-scheduled-delay-days 0
3306 "Number of days before a scheduled item becomes active.
3307 This variable governs the display in sparse trees and in the agenda.
3308 The default value (i.e. 0) means: don't delay scheduled item.
3309 When negative, it means use this number (the absolute value of it)
3310 even if a scheduled item has a different individual delay time
3311 specified.
3313 Custom commands can set this variable in the options section."
3314 :group 'org-time
3315 :group 'org-agenda-daily/weekly
3316 :version "24.4"
3317 :package-version '(Org . "8.0")
3318 :type 'integer)
3320 (defcustom org-read-date-prefer-future t
3321 "Non-nil means assume future for incomplete date input from user.
3322 This affects the following situations:
3323 1. The user gives a month but not a year.
3324 For example, if it is April and you enter \"feb 2\", this will be read
3325 as Feb 2, *next* year. \"May 5\", however, will be this year.
3326 2. The user gives a day, but no month.
3327 For example, if today is the 15th, and you enter \"3\", Org-mode will
3328 read this as the third of *next* month. However, if you enter \"17\",
3329 it will be considered as *this* month.
3331 If you set this variable to the symbol `time', then also the following
3332 will work:
3334 3. If the user gives a time.
3335 If the time is before now, it will be interpreted as tomorrow.
3337 Currently none of this works for ISO week specifications.
3339 When this option is nil, the current day, month and year will always be
3340 used as defaults.
3342 See also `org-agenda-jump-prefer-future'."
3343 :group 'org-time
3344 :type '(choice
3345 (const :tag "Never" nil)
3346 (const :tag "Check month and day" t)
3347 (const :tag "Check month, day, and time" time)))
3349 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3350 "Should the agenda jump command prefer the future for incomplete dates?
3351 The default is to do the same as configured in `org-read-date-prefer-future'.
3352 But you can also set a deviating value here.
3353 This may t or nil, or the symbol `org-read-date-prefer-future'."
3354 :group 'org-agenda
3355 :group 'org-time
3356 :version "24.1"
3357 :type '(choice
3358 (const :tag "Use org-read-date-prefer-future"
3359 org-read-date-prefer-future)
3360 (const :tag "Never" nil)
3361 (const :tag "Always" t)))
3363 (defcustom org-read-date-force-compatible-dates t
3364 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3366 Depending on the system Emacs is running on, certain dates cannot
3367 be represented with the type used internally to represent time.
3368 Dates between 1970-1-1 and 2038-1-1 can always be represented
3369 correctly. Some systems allow for earlier dates, some for later,
3370 some for both. One way to find out it to insert any date into an
3371 Org buffer, putting the cursor on the year and hitting S-up and
3372 S-down to test the range.
3374 When this variable is set to t, the date/time prompt will not let
3375 you specify dates outside the 1970-2037 range, so it is certain that
3376 these dates will work in whatever version of Emacs you are
3377 running, and also that you can move a file from one Emacs implementation
3378 to another. WHenever Org is forcing the year for you, it will display
3379 a message and beep.
3381 When this variable is nil, Org will check if the date is
3382 representable in the specific Emacs implementation you are using.
3383 If not, it will force a year, usually the current year, and beep
3384 to remind you. Currently this setting is not recommended because
3385 the likelihood that you will open your Org files in an Emacs that
3386 has limited date range is not negligible.
3388 A workaround for this problem is to use diary sexp dates for time
3389 stamps outside of this range."
3390 :group 'org-time
3391 :version "24.1"
3392 :type 'boolean)
3394 (defcustom org-read-date-display-live t
3395 "Non-nil means display current interpretation of date prompt live.
3396 This display will be in an overlay, in the minibuffer."
3397 :group 'org-time
3398 :type 'boolean)
3400 (defcustom org-read-date-popup-calendar t
3401 "Non-nil means pop up a calendar when prompting for a date.
3402 In the calendar, the date can be selected with mouse-1. However, the
3403 minibuffer will also be active, and you can simply enter the date as well.
3404 When nil, only the minibuffer will be available."
3405 :group 'org-time
3406 :type 'boolean)
3407 (org-defvaralias 'org-popup-calendar-for-date-prompt
3408 'org-read-date-popup-calendar)
3410 (make-obsolete-variable
3411 'org-read-date-minibuffer-setup-hook
3412 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3413 (defcustom org-read-date-minibuffer-setup-hook nil
3414 "Hook to be used to set up keys for the date/time interface.
3415 Add key definitions to `minibuffer-local-map', which will be a
3416 temporary copy.
3418 WARNING: This option is obsolete, you should use
3419 `org-read-date-minibuffer-local-map' to set up keys."
3420 :group 'org-time
3421 :type 'hook)
3423 (defcustom org-extend-today-until 0
3424 "The hour when your day really ends. Must be an integer.
3425 This has influence for the following applications:
3426 - When switching the agenda to \"today\". It it is still earlier than
3427 the time given here, the day recognized as TODAY is actually yesterday.
3428 - When a date is read from the user and it is still before the time given
3429 here, the current date and time will be assumed to be yesterday, 23:59.
3430 Also, timestamps inserted in capture templates follow this rule.
3432 IMPORTANT: This is a feature whose implementation is and likely will
3433 remain incomplete. Really, it is only here because past midnight seems to
3434 be the favorite working time of John Wiegley :-)"
3435 :group 'org-time
3436 :type 'integer)
3438 (defcustom org-use-effective-time nil
3439 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3440 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3441 \"effective time\" of any timestamps between midnight and 8am will be
3442 23:59 of the previous day."
3443 :group 'org-time
3444 :version "24.1"
3445 :type 'boolean)
3447 (defcustom org-use-last-clock-out-time-as-effective-time nil
3448 "When non-nil, use the last clock out time for `org-todo'.
3449 Note that this option has precedence over the combined use of
3450 `org-use-effective-time' and `org-extend-today-until'."
3451 :group 'org-time
3452 :version "24.4"
3453 :package-version '(Org . "8.0")
3454 :type 'boolean)
3456 (defcustom org-edit-timestamp-down-means-later nil
3457 "Non-nil means S-down will increase the time in a time stamp.
3458 When nil, S-up will increase."
3459 :group 'org-time
3460 :type 'boolean)
3462 (defcustom org-calendar-follow-timestamp-change t
3463 "Non-nil means make the calendar window follow timestamp changes.
3464 When a timestamp is modified and the calendar window is visible, it will be
3465 moved to the new date."
3466 :group 'org-time
3467 :type 'boolean)
3469 (defgroup org-tags nil
3470 "Options concerning tags in Org-mode."
3471 :tag "Org Tags"
3472 :group 'org)
3474 (defcustom org-tag-alist nil
3475 "List of tags allowed in Org-mode files.
3476 When this list is nil, Org-mode will base TAG input on what is already in the
3477 buffer.
3478 The value of this variable is an alist, the car of each entry must be a
3479 keyword as a string, the cdr may be a character that is used to select
3480 that tag through the fast-tag-selection interface.
3481 See the manual for details."
3482 :group 'org-tags
3483 :type '(repeat
3484 (choice
3485 (cons (string :tag "Tag name")
3486 (character :tag "Access char"))
3487 (list :tag "Start radio group"
3488 (const :startgroup)
3489 (option (string :tag "Group description")))
3490 (list :tag "Group tags delimiter"
3491 (const :grouptags))
3492 (list :tag "End radio group"
3493 (const :endgroup)
3494 (option (string :tag "Group description")))
3495 (const :tag "New line" (:newline)))))
3497 (defcustom org-tag-persistent-alist nil
3498 "List of tags that will always appear in all Org-mode files.
3499 This is in addition to any in buffer settings or customizations
3500 of `org-tag-alist'.
3501 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3502 The value of this variable is an alist, the car of each entry must be a
3503 keyword as a string, the cdr may be a character that is used to select
3504 that tag through the fast-tag-selection interface.
3505 See the manual for details.
3506 To disable these tags on a per-file basis, insert anywhere in the file:
3507 #+STARTUP: noptag"
3508 :group 'org-tags
3509 :type '(repeat
3510 (choice
3511 (cons (string :tag "Tag name")
3512 (character :tag "Access char"))
3513 (const :tag "Start radio group" (:startgroup))
3514 (const :tag "Group tags delimiter" (:grouptags))
3515 (const :tag "End radio group" (:endgroup))
3516 (const :tag "New line" (:newline)))))
3518 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3519 "If non-nil, always offer completion for all tags of all agenda files.
3520 Instead of customizing this variable directly, you might want to
3521 set it locally for capture buffers, because there no list of
3522 tags in that file can be created dynamically (there are none).
3524 (add-hook 'org-capture-mode-hook
3525 (lambda ()
3526 (set (make-local-variable
3527 'org-complete-tags-always-offer-all-agenda-tags)
3528 t)))"
3529 :group 'org-tags
3530 :version "24.1"
3531 :type 'boolean)
3533 (defvar org-file-tags nil
3534 "List of tags that can be inherited by all entries in the file.
3535 The tags will be inherited if the variable `org-use-tag-inheritance'
3536 says they should be.
3537 This variable is populated from #+FILETAGS lines.")
3539 (defcustom org-use-fast-tag-selection 'auto
3540 "Non-nil means use fast tag selection scheme.
3541 This is a special interface to select and deselect tags with single keys.
3542 When nil, fast selection is never used.
3543 When the symbol `auto', fast selection is used if and only if selection
3544 characters for tags have been configured, either through the variable
3545 `org-tag-alist' or through a #+TAGS line in the buffer.
3546 When t, fast selection is always used and selection keys are assigned
3547 automatically if necessary."
3548 :group 'org-tags
3549 :type '(choice
3550 (const :tag "Always" t)
3551 (const :tag "Never" nil)
3552 (const :tag "When selection characters are configured" auto)))
3554 (defcustom org-fast-tag-selection-single-key nil
3555 "Non-nil means fast tag selection exits after first change.
3556 When nil, you have to press RET to exit it.
3557 During fast tag selection, you can toggle this flag with `C-c'.
3558 This variable can also have the value `expert'. In this case, the window
3559 displaying the tags menu is not even shown, until you press C-c again."
3560 :group 'org-tags
3561 :type '(choice
3562 (const :tag "No" nil)
3563 (const :tag "Yes" t)
3564 (const :tag "Expert" expert)))
3566 (defvar org-fast-tag-selection-include-todo nil
3567 "Non-nil means fast tags selection interface will also offer TODO states.
3568 This is an undocumented feature, you should not rely on it.")
3570 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3571 "The column to which tags should be indented in a headline.
3572 If this number is positive, it specifies the column. If it is negative,
3573 it means that the tags should be flushright to that column. For example,
3574 -80 works well for a normal 80 character screen.
3575 When 0, place tags directly after headline text, with only one space in
3576 between."
3577 :group 'org-tags
3578 :type 'integer)
3580 (defcustom org-auto-align-tags t
3581 "Non-nil keeps tags aligned when modifying headlines.
3582 Some operations (i.e. demoting) change the length of a headline and
3583 therefore shift the tags around. With this option turned on, after
3584 each such operation the tags are again aligned to `org-tags-column'."
3585 :group 'org-tags
3586 :type 'boolean)
3588 (defcustom org-use-tag-inheritance t
3589 "Non-nil means tags in levels apply also for sublevels.
3590 When nil, only the tags directly given in a specific line apply there.
3591 This may also be a list of tags that should be inherited, or a regexp that
3592 matches tags that should be inherited. Additional control is possible
3593 with the variable `org-tags-exclude-from-inheritance' which gives an
3594 explicit list of tags to be excluded from inheritance, even if the value of
3595 `org-use-tag-inheritance' would select it for inheritance.
3597 If this option is t, a match early-on in a tree can lead to a large
3598 number of matches in the subtree when constructing the agenda or creating
3599 a sparse tree. If you only want to see the first match in a tree during
3600 a search, check out the variable `org-tags-match-list-sublevels'."
3601 :group 'org-tags
3602 :type '(choice
3603 (const :tag "Not" nil)
3604 (const :tag "Always" t)
3605 (repeat :tag "Specific tags" (string :tag "Tag"))
3606 (regexp :tag "Tags matched by regexp")))
3608 (defcustom org-tags-exclude-from-inheritance nil
3609 "List of tags that should never be inherited.
3610 This is a way to exclude a few tags from inheritance. For way to do
3611 the opposite, to actively allow inheritance for selected tags,
3612 see the variable `org-use-tag-inheritance'."
3613 :group 'org-tags
3614 :type '(repeat (string :tag "Tag")))
3616 (defun org-tag-inherit-p (tag)
3617 "Check if TAG is one that should be inherited."
3618 (cond
3619 ((member tag org-tags-exclude-from-inheritance) nil)
3620 ((eq org-use-tag-inheritance t) t)
3621 ((not org-use-tag-inheritance) nil)
3622 ((stringp org-use-tag-inheritance)
3623 (string-match org-use-tag-inheritance tag))
3624 ((listp org-use-tag-inheritance)
3625 (member tag org-use-tag-inheritance))
3626 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3628 (defcustom org-tags-match-list-sublevels t
3629 "Non-nil means list also sublevels of headlines matching a search.
3630 This variable applies to tags/property searches, and also to stuck
3631 projects because this search is based on a tags match as well.
3633 When set to the symbol `indented', sublevels are indented with
3634 leading dots.
3636 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3637 the sublevels of a headline matching a tag search often also match
3638 the same search. Listing all of them can create very long lists.
3639 Setting this variable to nil causes subtrees of a match to be skipped.
3641 This variable is semi-obsolete and probably should always be true. It
3642 is better to limit inheritance to certain tags using the variables
3643 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3644 :group 'org-tags
3645 :type '(choice
3646 (const :tag "No, don't list them" nil)
3647 (const :tag "Yes, do list them" t)
3648 (const :tag "List them, indented with leading dots" indented)))
3650 (defcustom org-tags-sort-function nil
3651 "When set, tags are sorted using this function as a comparator."
3652 :group 'org-tags
3653 :type '(choice
3654 (const :tag "No sorting" nil)
3655 (const :tag "Alphabetical" string<)
3656 (const :tag "Reverse alphabetical" string>)
3657 (function :tag "Custom function" nil)))
3659 (defvar org-tags-history nil
3660 "History of minibuffer reads for tags.")
3661 (defvar org-last-tags-completion-table nil
3662 "The last used completion table for tags.")
3663 (defvar org-after-tags-change-hook nil
3664 "Hook that is run after the tags in a line have changed.")
3666 (defgroup org-properties nil
3667 "Options concerning properties in Org-mode."
3668 :tag "Org Properties"
3669 :group 'org)
3671 (defcustom org-property-format "%-10s %s"
3672 "How property key/value pairs should be formatted by `indent-line'.
3673 When `indent-line' hits a property definition, it will format the line
3674 according to this format, mainly to make sure that the values are
3675 lined-up with respect to each other."
3676 :group 'org-properties
3677 :type 'string)
3679 (defcustom org-properties-postprocess-alist nil
3680 "Alist of properties and functions to adjust inserted values.
3681 Elements of this alist must be of the form
3683 ([string] [function])
3685 where [string] must be a property name and [function] must be a
3686 lambda expression: this lambda expression must take one argument,
3687 the value to adjust, and return the new value as a string.
3689 For example, this element will allow the property \"Remaining\"
3690 to be updated wrt the relation between the \"Effort\" property
3691 and the clock summary:
3693 ((\"Remaining\" (lambda(value)
3694 (let ((clocksum (org-clock-sum-current-item))
3695 (effort (org-duration-string-to-minutes
3696 (org-entry-get (point) \"Effort\"))))
3697 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3698 :group 'org-properties
3699 :version "24.1"
3700 :type '(alist :key-type (string :tag "Property")
3701 :value-type (function :tag "Function")))
3703 (defcustom org-use-property-inheritance nil
3704 "Non-nil means properties apply also for sublevels.
3706 This setting is chiefly used during property searches. Turning it on can
3707 cause significant overhead when doing a search, which is why it is not
3708 on by default.
3710 When nil, only the properties directly given in the current entry count.
3711 When t, every property is inherited. The value may also be a list of
3712 properties that should have inheritance, or a regular expression matching
3713 properties that should be inherited.
3715 However, note that some special properties use inheritance under special
3716 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3717 and the properties ending in \"_ALL\" when they are used as descriptor
3718 for valid values of a property.
3720 Note for programmers:
3721 When querying an entry with `org-entry-get', you can control if inheritance
3722 should be used. By default, `org-entry-get' looks only at the local
3723 properties. You can request inheritance by setting the inherit argument
3724 to t (to force inheritance) or to `selective' (to respect the setting
3725 in this variable)."
3726 :group 'org-properties
3727 :type '(choice
3728 (const :tag "Not" nil)
3729 (const :tag "Always" t)
3730 (repeat :tag "Specific properties" (string :tag "Property"))
3731 (regexp :tag "Properties matched by regexp")))
3733 (defun org-property-inherit-p (property)
3734 "Check if PROPERTY is one that should be inherited."
3735 (cond
3736 ((eq org-use-property-inheritance t) t)
3737 ((not org-use-property-inheritance) nil)
3738 ((stringp org-use-property-inheritance)
3739 (string-match org-use-property-inheritance property))
3740 ((listp org-use-property-inheritance)
3741 (member property org-use-property-inheritance))
3742 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3744 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3745 "The default column format, if no other format has been defined.
3746 This variable can be set on the per-file basis by inserting a line
3748 #+COLUMNS: %25ITEM ....."
3749 :group 'org-properties
3750 :type 'string)
3752 (defcustom org-columns-ellipses ".."
3753 "The ellipses to be used when a field in column view is truncated.
3754 When this is the empty string, as many characters as possible are shown,
3755 but then there will be no visual indication that the field has been truncated.
3756 When this is a string of length N, the last N characters of a truncated
3757 field are replaced by this string. If the column is narrower than the
3758 ellipses string, only part of the ellipses string will be shown."
3759 :group 'org-properties
3760 :type 'string)
3762 (defcustom org-columns-modify-value-for-display-function nil
3763 "Function that modifies values for display in column view.
3764 For example, it can be used to cut out a certain part from a time stamp.
3765 The function must take 2 arguments:
3767 column-title The title of the column (*not* the property name)
3768 value The value that should be modified.
3770 The function should return the value that should be displayed,
3771 or nil if the normal value should be used."
3772 :group 'org-properties
3773 :type '(choice (const nil) (function)))
3775 (defconst org-global-properties-fixed
3776 '(("VISIBILITY_ALL" . "folded children content all")
3777 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3778 "List of property/value pairs that can be inherited by any entry.
3780 These are fixed values, for the preset properties. The user variable
3781 that can be used to add to this list is `org-global-properties'.
3783 The entries in this list are cons cells where the car is a property
3784 name and cdr is a string with the value. If the value represents
3785 multiple items like an \"_ALL\" property, separate the items by
3786 spaces.")
3788 (defcustom org-global-properties nil
3789 "List of property/value pairs that can be inherited by any entry.
3791 This list will be combined with the constant `org-global-properties-fixed'.
3793 The entries in this list are cons cells where the car is a property
3794 name and cdr is a string with the value.
3796 You can set buffer-local values for the same purpose in the variable
3797 `org-file-properties' this by adding lines like
3799 #+PROPERTY: NAME VALUE"
3800 :group 'org-properties
3801 :type '(repeat
3802 (cons (string :tag "Property")
3803 (string :tag "Value"))))
3805 (defvar org-file-properties nil
3806 "List of property/value pairs that can be inherited by any entry.
3807 Valid for the current buffer.
3808 This variable is populated from #+PROPERTY lines.")
3809 (make-variable-buffer-local 'org-file-properties)
3811 (defgroup org-agenda nil
3812 "Options concerning agenda views in Org-mode."
3813 :tag "Org Agenda"
3814 :group 'org)
3816 (defvar org-category nil
3817 "Variable used by org files to set a category for agenda display.
3818 Such files should use a file variable to set it, for example
3820 # -*- mode: org; org-category: \"ELisp\"
3822 or contain a special line
3824 #+CATEGORY: ELisp
3826 If the file does not specify a category, then file's base name
3827 is used instead.")
3828 (make-variable-buffer-local 'org-category)
3829 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3831 (defcustom org-agenda-files nil
3832 "The files to be used for agenda display.
3833 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3834 \\[org-remove-file]. You can also use customize to edit the list.
3836 If an entry is a directory, all files in that directory that are matched by
3837 `org-agenda-file-regexp' will be part of the file list.
3839 If the value of the variable is not a list but a single file name, then
3840 the list of agenda files is actually stored and maintained in that file, one
3841 agenda file per line. In this file paths can be given relative to
3842 `org-directory'. Tilde expansion and environment variable substitution
3843 are also made."
3844 :group 'org-agenda
3845 :type '(choice
3846 (repeat :tag "List of files and directories" file)
3847 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3849 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3850 "Regular expression to match files for `org-agenda-files'.
3851 If any element in the list in that variable contains a directory instead
3852 of a normal file, all files in that directory that are matched by this
3853 regular expression will be included."
3854 :group 'org-agenda
3855 :type 'regexp)
3857 (defcustom org-agenda-text-search-extra-files nil
3858 "List of extra files to be searched by text search commands.
3859 These files will be searched in addition to the agenda files by the
3860 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3861 Note that these files will only be searched for text search commands,
3862 not for the other agenda views like todo lists, tag searches or the weekly
3863 agenda. This variable is intended to list notes and possibly archive files
3864 that should also be searched by these two commands.
3865 In fact, if the first element in the list is the symbol `agenda-archives',
3866 then all archive files of all agenda files will be added to the search
3867 scope."
3868 :group 'org-agenda
3869 :type '(set :greedy t
3870 (const :tag "Agenda Archives" agenda-archives)
3871 (repeat :inline t (file))))
3873 (org-defvaralias 'org-agenda-multi-occur-extra-files
3874 'org-agenda-text-search-extra-files)
3876 (defcustom org-agenda-skip-unavailable-files nil
3877 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3878 A nil value means to remove them, after a query, from the list."
3879 :group 'org-agenda
3880 :type 'boolean)
3882 (defcustom org-calendar-to-agenda-key [?c]
3883 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3884 The command `org-calendar-goto-agenda' will be bound to this key. The
3885 default is the character `c' because then `c' can be used to switch back and
3886 forth between agenda and calendar."
3887 :group 'org-agenda
3888 :type 'sexp)
3890 (defcustom org-calendar-insert-diary-entry-key [?i]
3891 "The key to be installed in `calendar-mode-map' for adding diary entries.
3892 This option is irrelevant until `org-agenda-diary-file' has been configured
3893 to point to an Org-mode file. When that is the case, the command
3894 `org-agenda-diary-entry' will be bound to the key given here, by default
3895 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3896 if you want to continue doing this, you need to change this to a different
3897 key."
3898 :group 'org-agenda
3899 :type 'sexp)
3901 (defcustom org-agenda-diary-file 'diary-file
3902 "File to which to add new entries with the `i' key in agenda and calendar.
3903 When this is the symbol `diary-file', the functionality in the Emacs
3904 calendar will be used to add entries to the `diary-file'. But when this
3905 points to a file, `org-agenda-diary-entry' will be used instead."
3906 :group 'org-agenda
3907 :type '(choice
3908 (const :tag "The standard Emacs diary file" diary-file)
3909 (file :tag "Special Org file diary entries")))
3911 (eval-after-load "calendar"
3912 '(progn
3913 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3914 'org-calendar-goto-agenda)
3915 (add-hook 'calendar-mode-hook
3916 (lambda ()
3917 (unless (eq org-agenda-diary-file 'diary-file)
3918 (define-key calendar-mode-map
3919 org-calendar-insert-diary-entry-key
3920 'org-agenda-diary-entry))))))
3922 (defgroup org-latex nil
3923 "Options for embedding LaTeX code into Org-mode."
3924 :tag "Org LaTeX"
3925 :group 'org)
3927 (defcustom org-format-latex-options
3928 '(:foreground default :background default :scale 1.0
3929 :html-foreground "Black" :html-background "Transparent"
3930 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3931 "Options for creating images from LaTeX fragments.
3932 This is a property list with the following properties:
3933 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3934 `default' means use the foreground of the default face.
3935 `auto' means use the foreground from the text face.
3936 :background the background color, or \"Transparent\".
3937 `default' means use the background of the default face.
3938 `auto' means use the background from the text face.
3939 :scale a scaling factor for the size of the images, to get more pixels
3940 :html-foreground, :html-background, :html-scale
3941 the same numbers for HTML export.
3942 :matchers a list indicating which matchers should be used to
3943 find LaTeX fragments. Valid members of this list are:
3944 \"begin\" find environments
3945 \"$1\" find single characters surrounded by $.$
3946 \"$\" find math expressions surrounded by $...$
3947 \"$$\" find math expressions surrounded by $$....$$
3948 \"\\(\" find math expressions surrounded by \\(...\\)
3949 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3950 :group 'org-latex
3951 :type 'plist)
3953 (defcustom org-format-latex-signal-error t
3954 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3955 When nil, just push out a message."
3956 :group 'org-latex
3957 :version "24.1"
3958 :type 'boolean)
3960 (defcustom org-latex-to-mathml-jar-file nil
3961 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3962 Use this to specify additional executable file say a jar file.
3964 When using MathToWeb as the converter, specify the full-path to
3965 your mathtoweb.jar file."
3966 :group 'org-latex
3967 :version "24.1"
3968 :type '(choice
3969 (const :tag "None" nil)
3970 (file :tag "JAR file" :must-match t)))
3972 (defcustom org-latex-to-mathml-convert-command nil
3973 "Command to convert LaTeX fragments to MathML.
3974 Replace format-specifiers in the command as noted below and use
3975 `shell-command' to convert LaTeX to MathML.
3976 %j: Executable file in fully expanded form as specified by
3977 `org-latex-to-mathml-jar-file'.
3978 %I: Input LaTeX file in fully expanded form
3979 %o: Output MathML file
3980 This command is used by `org-create-math-formula'.
3982 When using MathToWeb as the converter, set this to
3983 \"java -jar %j -unicode -force -df %o %I\"."
3984 :group 'org-latex
3985 :version "24.1"
3986 :type '(choice
3987 (const :tag "None" nil)
3988 (string :tag "\nShell command")))
3990 (defcustom org-latex-create-formula-image-program 'dvipng
3991 "Program to convert LaTeX fragments with.
3993 dvipng Process the LaTeX fragments to dvi file, then convert
3994 dvi files to png files using dvipng.
3995 This will also include processing of non-math environments.
3996 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3997 to convert pdf files to png files"
3998 :group 'org-latex
3999 :version "24.1"
4000 :type '(choice
4001 (const :tag "dvipng" dvipng)
4002 (const :tag "imagemagick" imagemagick)))
4004 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4005 "Path to store latex preview images.
4006 A relative path here creates many directories relative to the
4007 processed org files paths. An absolute path puts all preview
4008 images at the same place."
4009 :group 'org-latex
4010 :version "24.3"
4011 :type 'string)
4013 (defun org-format-latex-mathml-available-p ()
4014 "Return t if `org-latex-to-mathml-convert-command' is usable."
4015 (save-match-data
4016 (when (and (boundp 'org-latex-to-mathml-convert-command)
4017 org-latex-to-mathml-convert-command)
4018 (let ((executable (car (split-string
4019 org-latex-to-mathml-convert-command))))
4020 (when (executable-find executable)
4021 (if (string-match
4022 "%j" org-latex-to-mathml-convert-command)
4023 (file-readable-p org-latex-to-mathml-jar-file)
4024 t))))))
4026 (defcustom org-format-latex-header "\\documentclass{article}
4027 \\usepackage[usenames]{color}
4028 \[PACKAGES]
4029 \[DEFAULT-PACKAGES]
4030 \\pagestyle{empty} % do not remove
4031 % The settings below are copied from fullpage.sty
4032 \\setlength{\\textwidth}{\\paperwidth}
4033 \\addtolength{\\textwidth}{-3cm}
4034 \\setlength{\\oddsidemargin}{1.5cm}
4035 \\addtolength{\\oddsidemargin}{-2.54cm}
4036 \\setlength{\\evensidemargin}{\\oddsidemargin}
4037 \\setlength{\\textheight}{\\paperheight}
4038 \\addtolength{\\textheight}{-\\headheight}
4039 \\addtolength{\\textheight}{-\\headsep}
4040 \\addtolength{\\textheight}{-\\footskip}
4041 \\addtolength{\\textheight}{-3cm}
4042 \\setlength{\\topmargin}{1.5cm}
4043 \\addtolength{\\topmargin}{-2.54cm}"
4044 "The document header used for processing LaTeX fragments.
4045 It is imperative that this header make sure that no page number
4046 appears on the page. The package defined in the variables
4047 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4048 will either replace the placeholder \"[PACKAGES]\" in this
4049 header, or they will be appended."
4050 :group 'org-latex
4051 :type 'string)
4053 (defun org-set-packages-alist (var val)
4054 "Set the packages alist and make sure it has 3 elements per entry."
4055 (set var (mapcar (lambda (x)
4056 (if (and (consp x) (= (length x) 2))
4057 (list (car x) (nth 1 x) t)
4059 val)))
4061 (defun org-get-packages-alist (var)
4062 "Get the packages alist and make sure it has 3 elements per entry."
4063 (mapcar (lambda (x)
4064 (if (and (consp x) (= (length x) 2))
4065 (list (car x) (nth 1 x) t)
4067 (default-value var)))
4069 (defcustom org-latex-default-packages-alist
4070 '(("AUTO" "inputenc" t)
4071 ("T1" "fontenc" t)
4072 ("" "fixltx2e" nil)
4073 ("" "graphicx" t)
4074 ("" "longtable" nil)
4075 ("" "float" nil)
4076 ("" "wrapfig" nil)
4077 ("" "rotating" nil)
4078 ("normalem" "ulem" t)
4079 ("" "amsmath" t)
4080 ("" "textcomp" t)
4081 ("" "marvosym" t)
4082 ("" "wasysym" t)
4083 ("" "amssymb" t)
4084 ("" "capt-of" nil)
4085 ("" "hyperref" nil)
4086 "\\tolerance=1000")
4087 "Alist of default packages to be inserted in the header.
4089 Change this only if one of the packages here causes an
4090 incompatibility with another package you are using.
4092 The packages in this list are needed by one part or another of
4093 Org mode to function properly:
4095 - inputenc, fontenc: for basic font and character selection
4096 - fixltx2e: Important patches of LaTeX itself
4097 - graphicx: for including images
4098 - longtable: For multipage tables
4099 - float, wrapfig: for figure placement
4100 - rotating: for sideways figures and tables
4101 - ulem: for underline and strike-through
4102 - amsmath: for subscript and superscript and math environments
4103 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4104 for interpreting the entities in `org-entities'. You can skip
4105 some of these packages if you don't use any of their symbols.
4106 - capt-of: for captions outside of floats
4107 - hyperref: for cross references
4109 Therefore you should not modify this variable unless you know
4110 what you are doing. The one reason to change it anyway is that
4111 you might be loading some other package that conflicts with one
4112 of the default packages. Each element is either a cell or
4113 a string.
4115 A cell is of the format:
4117 \( \"options\" \"package\" SNIPPET-FLAG).
4119 If SNIPPET-FLAG is non-nil, the package also needs to be included
4120 when compiling LaTeX snippets into images for inclusion into
4121 non-LaTeX output.
4123 A string will be inserted as-is in the header of the document."
4124 :group 'org-latex
4125 :group 'org-export-latex
4126 :set 'org-set-packages-alist
4127 :get 'org-get-packages-alist
4128 :version "24.1"
4129 :type '(repeat
4130 (choice
4131 (list :tag "options/package pair"
4132 (string :tag "options")
4133 (string :tag "package")
4134 (boolean :tag "Snippet"))
4135 (string :tag "A line of LaTeX"))))
4137 (defcustom org-latex-packages-alist nil
4138 "Alist of packages to be inserted in every LaTeX header.
4140 These will be inserted after `org-latex-default-packages-alist'.
4141 Each element is either a cell or a string.
4143 A cell is of the format:
4145 \(\"options\" \"package\" SNIPPET-FLAG)
4147 SNIPPET-FLAG, when non-nil, indicates that this package is also
4148 needed when turning LaTeX snippets into images for inclusion into
4149 non-LaTeX output.
4151 A string will be inserted as-is in the header of the document.
4153 Make sure that you only list packages here which:
4155 - you want in every file;
4156 - do not conflict with the setup in `org-format-latex-header';
4157 - do not conflict with the default packages in
4158 `org-latex-default-packages-alist'."
4159 :group 'org-latex
4160 :group 'org-export-latex
4161 :set 'org-set-packages-alist
4162 :get 'org-get-packages-alist
4163 :type '(repeat
4164 (choice
4165 (list :tag "options/package pair"
4166 (string :tag "options")
4167 (string :tag "package")
4168 (boolean :tag "Snippet"))
4169 (string :tag "A line of LaTeX"))))
4171 (defgroup org-appearance nil
4172 "Settings for Org-mode appearance."
4173 :tag "Org Appearance"
4174 :group 'org)
4176 (defcustom org-level-color-stars-only nil
4177 "Non-nil means fontify only the stars in each headline.
4178 When nil, the entire headline is fontified.
4179 Changing it requires restart of `font-lock-mode' to become effective
4180 also in regions already fontified."
4181 :group 'org-appearance
4182 :type 'boolean)
4184 (defcustom org-hide-leading-stars nil
4185 "Non-nil means hide the first N-1 stars in a headline.
4186 This works by using the face `org-hide' for these stars. This
4187 face is white for a light background, and black for a dark
4188 background. You may have to customize the face `org-hide' to
4189 make this work.
4190 Changing it requires restart of `font-lock-mode' to become effective
4191 also in regions already fontified.
4192 You may also set this on a per-file basis by adding one of the following
4193 lines to the buffer:
4195 #+STARTUP: hidestars
4196 #+STARTUP: showstars"
4197 :group 'org-appearance
4198 :type 'boolean)
4200 (defcustom org-hidden-keywords nil
4201 "List of symbols corresponding to keywords to be hidden the org buffer.
4202 For example, a value '(title) for this list will make the document's title
4203 appear in the buffer without the initial #+TITLE: keyword."
4204 :group 'org-appearance
4205 :version "24.1"
4206 :type '(set (const :tag "#+AUTHOR" author)
4207 (const :tag "#+DATE" date)
4208 (const :tag "#+EMAIL" email)
4209 (const :tag "#+TITLE" title)))
4211 (defcustom org-custom-properties nil
4212 "List of properties (as strings) with a special meaning.
4213 The default use of these custom properties is to let the user
4214 hide them with `org-toggle-custom-properties-visibility'."
4215 :group 'org-properties
4216 :group 'org-appearance
4217 :version "24.3"
4218 :type '(repeat (string :tag "Property Name")))
4220 (defcustom org-fontify-done-headline nil
4221 "Non-nil means change the face of a headline if it is marked DONE.
4222 Normally, only the TODO/DONE keyword indicates the state of a headline.
4223 When this is non-nil, the headline after the keyword is set to the
4224 `org-headline-done' as an additional indication."
4225 :group 'org-appearance
4226 :type 'boolean)
4228 (defcustom org-fontify-emphasized-text t
4229 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4230 Changing this variable requires a restart of Emacs to take effect."
4231 :group 'org-appearance
4232 :type 'boolean)
4234 (defcustom org-fontify-whole-heading-line nil
4235 "Non-nil means fontify the whole line for headings.
4236 This is useful when setting a background color for the
4237 org-level-* faces."
4238 :group 'org-appearance
4239 :type 'boolean)
4241 (defcustom org-highlight-latex-and-related nil
4242 "Non-nil means highlight LaTeX related syntax in the buffer.
4243 When non nil, the value should be a list containing any of the
4244 following symbols:
4245 `latex' Highlight LaTeX snippets and environments.
4246 `script' Highlight subscript and superscript.
4247 `entities' Highlight entities."
4248 :group 'org-appearance
4249 :version "24.4"
4250 :package-version '(Org . "8.0")
4251 :type '(choice
4252 (const :tag "No highlighting" nil)
4253 (set :greedy t :tag "Highlight"
4254 (const :tag "LaTeX snippets and environments" latex)
4255 (const :tag "Subscript and superscript" script)
4256 (const :tag "Entities" entities))))
4258 (defcustom org-hide-emphasis-markers nil
4259 "Non-nil mean font-lock should hide the emphasis marker characters."
4260 :group 'org-appearance
4261 :type 'boolean)
4263 (defcustom org-hide-macro-markers nil
4264 "Non-nil mean font-lock should hide the brackets marking macro calls."
4265 :group 'org-appearance
4266 :type 'boolean)
4268 (defcustom org-pretty-entities nil
4269 "Non-nil means show entities as UTF8 characters.
4270 When nil, the \\name form remains in the buffer."
4271 :group 'org-appearance
4272 :version "24.1"
4273 :type 'boolean)
4275 (defcustom org-pretty-entities-include-sub-superscripts t
4276 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4277 :group 'org-appearance
4278 :version "24.1"
4279 :type 'boolean)
4281 (defvar org-emph-re nil
4282 "Regular expression for matching emphasis.
4283 After a match, the match groups contain these elements:
4284 0 The match of the full regular expression, including the characters
4285 before and after the proper match
4286 1 The character before the proper match, or empty at beginning of line
4287 2 The proper match, including the leading and trailing markers
4288 3 The leading marker like * or /, indicating the type of highlighting
4289 4 The text between the emphasis markers, not including the markers
4290 5 The character after the match, empty at the end of a line")
4291 (defvar org-verbatim-re nil
4292 "Regular expression for matching verbatim text.")
4293 (defvar org-emphasis-regexp-components) ; defined just below
4294 (defvar org-emphasis-alist) ; defined just below
4295 (defun org-set-emph-re (var val)
4296 "Set variable and compute the emphasis regular expression."
4297 (set var val)
4298 (when (and (boundp 'org-emphasis-alist)
4299 (boundp 'org-emphasis-regexp-components)
4300 org-emphasis-alist org-emphasis-regexp-components)
4301 (let* ((e org-emphasis-regexp-components)
4302 (pre (car e))
4303 (post (nth 1 e))
4304 (border (nth 2 e))
4305 (body (nth 3 e))
4306 (nl (nth 4 e))
4307 (body1 (concat body "*?"))
4308 (markers (mapconcat 'car org-emphasis-alist ""))
4309 (vmarkers (mapconcat
4310 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4311 org-emphasis-alist "")))
4312 ;; make sure special characters appear at the right position in the class
4313 (if (string-match "\\^" markers)
4314 (setq markers (concat (replace-match "" t t markers) "^")))
4315 (if (string-match "-" markers)
4316 (setq markers (concat (replace-match "" t t markers) "-")))
4317 (if (string-match "\\^" vmarkers)
4318 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4319 (if (string-match "-" vmarkers)
4320 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4321 (if (> nl 0)
4322 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4323 (int-to-string nl) "\\}")))
4324 ;; Make the regexp
4325 (setq org-emph-re
4326 (concat "\\([" pre "]\\|^\\)"
4327 "\\("
4328 "\\([" markers "]\\)"
4329 "\\("
4330 "[^" border "]\\|"
4331 "[^" border "]"
4332 body1
4333 "[^" border "]"
4334 "\\)"
4335 "\\3\\)"
4336 "\\([" post "]\\|$\\)"))
4337 (setq org-verbatim-re
4338 (concat "\\([" pre "]\\|^\\)"
4339 "\\("
4340 "\\([" vmarkers "]\\)"
4341 "\\("
4342 "[^" border "]\\|"
4343 "[^" border "]"
4344 body1
4345 "[^" border "]"
4346 "\\)"
4347 "\\3\\)"
4348 "\\([" post "]\\|$\\)")))))
4350 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4351 ;; set this option proved cumbersome. See this message/thread:
4352 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4353 (defvar org-emphasis-regexp-components
4354 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4355 "Components used to build the regular expression for emphasis.
4356 This is a list with five entries. Terminology: In an emphasis string
4357 like \" *strong word* \", we call the initial space PREMATCH, the final
4358 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4359 and \"trong wor\" is the body. The different components in this variable
4360 specify what is allowed/forbidden in each part:
4362 pre Chars allowed as prematch. Beginning of line will be allowed too.
4363 post Chars allowed as postmatch. End of line will be allowed too.
4364 border The chars *forbidden* as border characters.
4365 body-regexp A regexp like \".\" to match a body character. Don't use
4366 non-shy groups here, and don't allow newline here.
4367 newline The maximum number of newlines allowed in an emphasis exp.
4369 You need to reload Org or to restart Emacs after customizing this.")
4371 (defcustom org-emphasis-alist
4372 `(("*" bold)
4373 ("/" italic)
4374 ("_" underline)
4375 ("=" org-verbatim verbatim)
4376 ("~" org-code verbatim)
4377 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4378 "Alist of characters and faces to emphasize text.
4379 Text starting and ending with a special character will be emphasized,
4380 for example *bold*, _underlined_ and /italic/. This variable sets the
4381 marker characters and the face to be used by font-lock for highlighting
4382 in Org-mode Emacs buffers.
4384 You need to reload Org or to restart Emacs after customizing this."
4385 :group 'org-appearance
4386 :set 'org-set-emph-re
4387 :version "24.4"
4388 :package-version '(Org . "8.0")
4389 :type '(repeat
4390 (list
4391 (string :tag "Marker character")
4392 (choice
4393 (face :tag "Font-lock-face")
4394 (plist :tag "Face property list"))
4395 (option (const verbatim)))))
4397 (defvar org-protecting-blocks
4398 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4399 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4400 This is needed for font-lock setup.")
4402 ;;; Miscellaneous options
4404 (defgroup org-completion nil
4405 "Completion in Org-mode."
4406 :tag "Org Completion"
4407 :group 'org)
4409 (defcustom org-completion-use-ido nil
4410 "Non-nil means use ido completion wherever possible.
4411 Note that `ido-mode' must be active for this variable to be relevant.
4412 If you decide to turn this variable on, you might well want to turn off
4413 `org-outline-path-complete-in-steps'.
4414 See also `org-completion-use-iswitchb'."
4415 :group 'org-completion
4416 :type 'boolean)
4418 (defcustom org-completion-use-iswitchb nil
4419 "Non-nil means use iswitchb completion wherever possible.
4420 Note that `iswitchb-mode' must be active for this variable to be relevant.
4421 If you decide to turn this variable on, you might well want to turn off
4422 `org-outline-path-complete-in-steps'.
4423 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4424 :group 'org-completion
4425 :type 'boolean)
4427 (defcustom org-completion-fallback-command 'hippie-expand
4428 "The expansion command called by \\[pcomplete] in normal context.
4429 Normal means, no org-mode-specific context."
4430 :group 'org-completion
4431 :type 'function)
4433 ;;; Functions and variables from their packages
4434 ;; Declared here to avoid compiler warnings
4436 ;; XEmacs only
4437 (defvar outline-mode-menu-heading)
4438 (defvar outline-mode-menu-show)
4439 (defvar outline-mode-menu-hide)
4440 (defvar zmacs-regions) ; XEmacs regions
4442 ;; Emacs only
4443 (defvar mark-active)
4445 ;; Various packages
4446 (declare-function calendar-absolute-from-iso "cal-iso" (date))
4447 (declare-function calendar-forward-day "cal-move" (arg))
4448 (declare-function calendar-goto-date "cal-move" (date))
4449 (declare-function calendar-goto-today "cal-move" ())
4450 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4451 (defvar calc-embedded-close-formula)
4452 (defvar calc-embedded-open-formula)
4453 (declare-function cdlatex-tab "ext:cdlatex" ())
4454 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4455 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4456 (defvar font-lock-unfontify-region-function)
4457 (declare-function iswitchb-read-buffer "iswitchb"
4458 (prompt &optional default require-match start matches-set))
4459 (defvar iswitchb-temp-buflist)
4460 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4461 (defvar org-agenda-tags-todo-honor-ignore-options)
4462 (declare-function org-agenda-skip "org-agenda" ())
4463 (declare-function
4464 org-agenda-format-item "org-agenda"
4465 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4466 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4467 (declare-function org-agenda-change-all-lines "org-agenda"
4468 (newhead hdmarker &optional fixface just-this))
4469 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4470 (declare-function org-agenda-maybe-redo "org-agenda" ())
4471 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4472 (beg end))
4473 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4474 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4475 "org-agenda" (&optional end))
4476 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4477 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4478 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4479 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4480 (declare-function org-indent-mode "org-indent" (&optional arg))
4481 (declare-function parse-time-string "parse-time" (string))
4482 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4483 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4484 (defvar remember-data-file)
4485 (defvar texmathp-why)
4486 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4487 (declare-function table--at-cell-p "table" (position &optional object at-column))
4488 (declare-function calc-eval "calc" (str &optional separator &rest args))
4490 ;;;###autoload
4491 (defun turn-on-orgtbl ()
4492 "Unconditionally turn on `orgtbl-mode'."
4493 (require 'org-table)
4494 (orgtbl-mode 1))
4496 (defun org-at-table-p (&optional table-type)
4497 "Return t if the cursor is inside an org-type table.
4498 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4499 (if org-enable-table-editor
4500 (save-excursion
4501 (beginning-of-line 1)
4502 (looking-at (if table-type org-table-any-line-regexp
4503 org-table-line-regexp)))
4504 nil))
4505 (defsubst org-table-p () (org-at-table-p))
4507 (defun org-at-table.el-p ()
4508 "Return t if and only if we are at a table.el table."
4509 (and (org-at-table-p 'any)
4510 (save-excursion
4511 (goto-char (org-table-begin 'any))
4512 (looking-at org-table1-hline-regexp))))
4514 (defun org-table-recognize-table.el ()
4515 "If there is a table.el table nearby, recognize it and move into it."
4516 (if org-table-tab-recognizes-table.el
4517 (if (org-at-table.el-p)
4518 (progn
4519 (beginning-of-line 1)
4520 (if (looking-at org-table-dataline-regexp)
4522 (if (looking-at org-table1-hline-regexp)
4523 (progn
4524 (beginning-of-line 2)
4525 (if (looking-at org-table-any-border-regexp)
4526 (beginning-of-line -1)))))
4527 (if (re-search-forward "|" (org-table-end t) t)
4528 (progn
4529 (require 'table)
4530 (if (table--at-cell-p (point))
4532 (message "recognizing table.el table...")
4533 (table-recognize-table)
4534 (message "recognizing table.el table...done")))
4535 (error "This should not happen"))
4537 nil)
4538 nil))
4540 (defun org-at-table-hline-p ()
4541 "Return t if the cursor is inside a hline in a table."
4542 (if org-enable-table-editor
4543 (save-excursion
4544 (beginning-of-line 1)
4545 (looking-at org-table-hline-regexp))
4546 nil))
4548 (defun org-table-map-tables (function &optional quietly)
4549 "Apply FUNCTION to the start of all tables in the buffer."
4550 (save-excursion
4551 (save-restriction
4552 (widen)
4553 (goto-char (point-min))
4554 (while (re-search-forward org-table-any-line-regexp nil t)
4555 (unless quietly
4556 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4557 (beginning-of-line 1)
4558 (when (and (looking-at org-table-line-regexp)
4559 ;; Exclude tables in src/example/verbatim/clocktable blocks
4560 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4561 (save-excursion (funcall function))
4562 (or (looking-at org-table-line-regexp)
4563 (forward-char 1)))
4564 (re-search-forward org-table-any-border-regexp nil 1))))
4565 (unless quietly (message "Mapping tables: done")))
4567 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4568 (declare-function org-clock-update-mode-line "org-clock" ())
4569 (declare-function org-resolve-clocks "org-clock"
4570 (&optional also-non-dangling-p prompt last-valid))
4572 (defun org-at-TBLFM-p (&optional pos)
4573 "Return t when point (or POS) is in #+TBLFM line."
4574 (save-excursion
4575 (let ((pos pos)))
4576 (goto-char (or pos (point)))
4577 (beginning-of-line 1)
4578 (looking-at org-TBLFM-regexp)))
4580 (defvar org-clock-start-time)
4581 (defvar org-clock-marker (make-marker)
4582 "Marker recording the last clock-in.")
4583 (defvar org-clock-hd-marker (make-marker)
4584 "Marker recording the last clock-in, but the headline position.")
4585 (defvar org-clock-heading ""
4586 "The heading of the current clock entry.")
4587 (defun org-clock-is-active ()
4588 "Return the buffer where the clock is currently running.
4589 Return nil if no clock is running."
4590 (marker-buffer org-clock-marker))
4592 (defun org-check-running-clock ()
4593 "Check if the current buffer contains the running clock.
4594 If yes, offer to stop it and to save the buffer with the changes."
4595 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4596 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4597 (buffer-name))))
4598 (org-clock-out)
4599 (when (y-or-n-p "Save changed buffer?")
4600 (save-buffer))))
4602 (defun org-clocktable-try-shift (dir n)
4603 "Check if this line starts a clock table, if yes, shift the time block."
4604 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4605 (org-clocktable-shift dir n)))
4607 ;;;###autoload
4608 (defun org-clock-persistence-insinuate ()
4609 "Set up hooks for clock persistence."
4610 (require 'org-clock)
4611 (add-hook 'org-mode-hook 'org-clock-load)
4612 (add-hook 'kill-emacs-hook 'org-clock-save))
4614 (defgroup org-archive nil
4615 "Options concerning archiving in Org-mode."
4616 :tag "Org Archive"
4617 :group 'org-structure)
4619 (defcustom org-archive-location "%s_archive::"
4620 "The location where subtrees should be archived.
4622 The value of this variable is a string, consisting of two parts,
4623 separated by a double-colon. The first part is a filename and
4624 the second part is a headline.
4626 When the filename is omitted, archiving happens in the same file.
4627 %s in the filename will be replaced by the current file
4628 name (without the directory part). Archiving to a different file
4629 is useful to keep archived entries from contributing to the
4630 Org-mode Agenda.
4632 The archived entries will be filed as subtrees of the specified
4633 headline. When the headline is omitted, the subtrees are simply
4634 filed away at the end of the file, as top-level entries. Also in
4635 the heading you can use %s to represent the file name, this can be
4636 useful when using the same archive for a number of different files.
4638 Here are a few examples:
4639 \"%s_archive::\"
4640 If the current file is Projects.org, archive in file
4641 Projects.org_archive, as top-level trees. This is the default.
4643 \"::* Archived Tasks\"
4644 Archive in the current file, under the top-level headline
4645 \"* Archived Tasks\".
4647 \"~/org/archive.org::\"
4648 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4650 \"~/org/archive.org::* From %s\"
4651 Archive in file ~/org/archive.org (absolute path), under headlines
4652 \"From FILENAME\" where file name is the current file name.
4654 \"~/org/datetree.org::datetree/* Finished Tasks\"
4655 The \"datetree/\" string is special, signifying to archive
4656 items to the datetree. Items are placed in either the CLOSED
4657 date of the item, or the current date if there is no CLOSED date.
4658 The heading will be a subentry to the current date. There doesn't
4659 need to be a heading, but there always needs to be a slash after
4660 datetree. For example, to store archived items directly in the
4661 datetree, use \"~/org/datetree.org::datetree/\".
4663 \"basement::** Finished Tasks\"
4664 Archive in file ./basement (relative path), as level 3 trees
4665 below the level 2 heading \"** Finished Tasks\".
4667 You may set this option on a per-file basis by adding to the buffer a
4668 line like
4670 #+ARCHIVE: basement::** Finished Tasks
4672 You may also define it locally for a subtree by setting an ARCHIVE property
4673 in the entry. If such a property is found in an entry, or anywhere up
4674 the hierarchy, it will be used."
4675 :group 'org-archive
4676 :type 'string)
4678 (defcustom org-agenda-skip-archived-trees t
4679 "Non-nil means the agenda will skip any items located in archived trees.
4680 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4681 variable is no longer recommended, you should leave it at the value t.
4682 Instead, use the key `v' to cycle the archives-mode in the agenda."
4683 :group 'org-archive
4684 :group 'org-agenda-skip
4685 :type 'boolean)
4687 (defcustom org-columns-skip-archived-trees t
4688 "Non-nil means ignore archived trees when creating column view."
4689 :group 'org-archive
4690 :group 'org-properties
4691 :type 'boolean)
4693 (defcustom org-cycle-open-archived-trees nil
4694 "Non-nil means `org-cycle' will open archived trees.
4695 An archived tree is a tree marked with the tag ARCHIVE.
4696 When nil, archived trees will stay folded. You can still open them with
4697 normal outline commands like `show-all', but not with the cycling commands."
4698 :group 'org-archive
4699 :group 'org-cycle
4700 :type 'boolean)
4702 (defcustom org-sparse-tree-open-archived-trees nil
4703 "Non-nil means sparse tree construction shows matches in archived trees.
4704 When nil, matches in these trees are highlighted, but the trees are kept in
4705 collapsed state."
4706 :group 'org-archive
4707 :group 'org-sparse-trees
4708 :type 'boolean)
4710 (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
4711 "The default date type when building a sparse tree.
4712 When this is nil, a date is a scheduled or a deadline timestamp.
4713 Otherwise, these types are allowed:
4715 all: all timestamps
4716 active: only active timestamps (<...>)
4717 inactive: only inactive timestamps (<...)
4718 scheduled: only scheduled timestamps
4719 deadline: only deadline timestamps"
4720 :type '(choice (const :tag "Scheduled or deadline" scheduled-or-deadline)
4721 (const :tag "All timestamps" all)
4722 (const :tag "Only active timestamps" active)
4723 (const :tag "Only inactive timestamps" inactive)
4724 (const :tag "Only scheduled timestamps" scheduled)
4725 (const :tag "Only deadline timestamps" deadline)
4726 (const :tag "Only closed timestamps" closed))
4727 :version "24.3"
4728 :group 'org-sparse-trees)
4730 (defun org-cycle-hide-archived-subtrees (state)
4731 "Re-hide all archived subtrees after a visibility state change."
4732 (when (and (not org-cycle-open-archived-trees)
4733 (not (memq state '(overview folded))))
4734 (save-excursion
4735 (let* ((globalp (memq state '(contents all)))
4736 (beg (if globalp (point-min) (point)))
4737 (end (if globalp (point-max) (org-end-of-subtree t))))
4738 (org-hide-archived-subtrees beg end)
4739 (goto-char beg)
4740 (if (looking-at (concat ".*:" org-archive-tag ":"))
4741 (message "%s" (substitute-command-keys
4742 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4744 (defun org-force-cycle-archived ()
4745 "Cycle subtree even if it is archived."
4746 (interactive)
4747 (setq this-command 'org-cycle)
4748 (let ((org-cycle-open-archived-trees t))
4749 (call-interactively 'org-cycle)))
4751 (defun org-hide-archived-subtrees (beg end)
4752 "Re-hide all archived subtrees after a visibility state change."
4753 (save-excursion
4754 (let* ((re (concat ":" org-archive-tag ":")))
4755 (goto-char beg)
4756 (while (re-search-forward re end t)
4757 (when (org-at-heading-p)
4758 (org-flag-subtree t)
4759 (org-end-of-subtree t))))))
4761 (declare-function outline-end-of-heading "outline" ())
4762 (declare-function outline-flag-region "outline" (from to flag))
4763 (defun org-flag-subtree (flag)
4764 (save-excursion
4765 (org-back-to-heading t)
4766 (outline-end-of-heading)
4767 (outline-flag-region (point)
4768 (progn (org-end-of-subtree t) (point))
4769 flag)))
4771 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4773 ;; Declare Column View Code
4775 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4776 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4777 (declare-function org-columns-compute "org-colview" (property))
4779 ;; Declare ID code
4781 (declare-function org-id-store-link "org-id")
4782 (declare-function org-id-locations-load "org-id")
4783 (declare-function org-id-locations-save "org-id")
4784 (defvar org-id-track-globally)
4786 ;;; Variables for pre-computed regular expressions, all buffer local
4788 (defvar org-todo-regexp nil
4789 "Matches any of the TODO state keywords.")
4790 (make-variable-buffer-local 'org-todo-regexp)
4791 (defvar org-not-done-regexp nil
4792 "Matches any of the TODO state keywords except the last one.")
4793 (make-variable-buffer-local 'org-not-done-regexp)
4794 (defvar org-not-done-heading-regexp nil
4795 "Matches a TODO headline that is not done.")
4796 (make-variable-buffer-local 'org-not-done-regexp)
4797 (defvar org-todo-line-regexp nil
4798 "Matches a headline and puts TODO state into group 2 if present.")
4799 (make-variable-buffer-local 'org-todo-line-regexp)
4800 (defvar org-complex-heading-regexp nil
4801 "Matches a headline and puts everything into groups:
4802 group 1: the stars
4803 group 2: The todo keyword, maybe
4804 group 3: Priority cookie
4805 group 4: True headline
4806 group 5: Tags")
4807 (make-variable-buffer-local 'org-complex-heading-regexp)
4808 (defvar org-complex-heading-regexp-format nil
4809 "Printf format to make regexp to match an exact headline.
4810 This regexp will match the headline of any node which has the
4811 exact headline text that is put into the format, but may have any
4812 TODO state, priority and tags.")
4813 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4814 (defvar org-todo-line-tags-regexp nil
4815 "Matches a headline and puts TODO state into group 2 if present.
4816 Also put tags into group 4 if tags are present.")
4817 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4819 (defconst org-plain-time-of-day-regexp
4820 (concat
4821 "\\(\\<[012]?[0-9]"
4822 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4823 "\\(--?"
4824 "\\(\\<[012]?[0-9]"
4825 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4826 "\\)?")
4827 "Regular expression to match a plain time or time range.
4828 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4829 groups carry important information:
4830 0 the full match
4831 1 the first time, range or not
4832 8 the second time, if it is a range.")
4834 (defconst org-plain-time-extension-regexp
4835 (concat
4836 "\\(\\<[012]?[0-9]"
4837 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4838 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4839 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4840 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4841 groups carry important information:
4842 0 the full match
4843 7 hours of duration
4844 9 minutes of duration")
4846 (defconst org-stamp-time-of-day-regexp
4847 (concat
4848 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4849 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4850 "\\(--?"
4851 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4852 "Regular expression to match a timestamp time or time range.
4853 After a match, the following groups carry important information:
4854 0 the full match
4855 1 date plus weekday, for back referencing to make sure both times are on the same day
4856 2 the first time, range or not
4857 4 the second time, if it is a range.")
4859 (defconst org-startup-options
4860 '(("fold" org-startup-folded t)
4861 ("overview" org-startup-folded t)
4862 ("nofold" org-startup-folded nil)
4863 ("showall" org-startup-folded nil)
4864 ("showeverything" org-startup-folded showeverything)
4865 ("content" org-startup-folded content)
4866 ("indent" org-startup-indented t)
4867 ("noindent" org-startup-indented nil)
4868 ("hidestars" org-hide-leading-stars t)
4869 ("showstars" org-hide-leading-stars nil)
4870 ("odd" org-odd-levels-only t)
4871 ("oddeven" org-odd-levels-only nil)
4872 ("align" org-startup-align-all-tables t)
4873 ("noalign" org-startup-align-all-tables nil)
4874 ("inlineimages" org-startup-with-inline-images t)
4875 ("noinlineimages" org-startup-with-inline-images nil)
4876 ("latexpreview" org-startup-with-latex-preview t)
4877 ("nolatexpreview" org-startup-with-latex-preview nil)
4878 ("customtime" org-display-custom-times t)
4879 ("logdone" org-log-done time)
4880 ("lognotedone" org-log-done note)
4881 ("nologdone" org-log-done nil)
4882 ("lognoteclock-out" org-log-note-clock-out t)
4883 ("nolognoteclock-out" org-log-note-clock-out nil)
4884 ("logrepeat" org-log-repeat state)
4885 ("lognoterepeat" org-log-repeat note)
4886 ("logdrawer" org-log-into-drawer t)
4887 ("nologdrawer" org-log-into-drawer nil)
4888 ("logstatesreversed" org-log-states-order-reversed t)
4889 ("nologstatesreversed" org-log-states-order-reversed nil)
4890 ("nologrepeat" org-log-repeat nil)
4891 ("logreschedule" org-log-reschedule time)
4892 ("lognotereschedule" org-log-reschedule note)
4893 ("nologreschedule" org-log-reschedule nil)
4894 ("logredeadline" org-log-redeadline time)
4895 ("lognoteredeadline" org-log-redeadline note)
4896 ("nologredeadline" org-log-redeadline nil)
4897 ("logrefile" org-log-refile time)
4898 ("lognoterefile" org-log-refile note)
4899 ("nologrefile" org-log-refile nil)
4900 ("fninline" org-footnote-define-inline t)
4901 ("nofninline" org-footnote-define-inline nil)
4902 ("fnlocal" org-footnote-section nil)
4903 ("fnauto" org-footnote-auto-label t)
4904 ("fnprompt" org-footnote-auto-label nil)
4905 ("fnconfirm" org-footnote-auto-label confirm)
4906 ("fnplain" org-footnote-auto-label plain)
4907 ("fnadjust" org-footnote-auto-adjust t)
4908 ("nofnadjust" org-footnote-auto-adjust nil)
4909 ("constcgs" constants-unit-system cgs)
4910 ("constSI" constants-unit-system SI)
4911 ("noptag" org-tag-persistent-alist nil)
4912 ("hideblocks" org-hide-block-startup t)
4913 ("nohideblocks" org-hide-block-startup nil)
4914 ("beamer" org-startup-with-beamer-mode t)
4915 ("entitiespretty" org-pretty-entities t)
4916 ("entitiesplain" org-pretty-entities nil))
4917 "Variable associated with STARTUP options for org-mode.
4918 Each element is a list of three items: the startup options (as written
4919 in the #+STARTUP line), the corresponding variable, and the value to set
4920 this variable to if the option is found. An optional forth element PUSH
4921 means to push this value onto the list in the variable.")
4923 (defcustom org-group-tags t
4924 "When non-nil (the default), use group tags.
4925 This can be turned on/off through `org-toggle-tags-groups'."
4926 :group 'org-tags
4927 :group 'org-startup
4928 :type 'boolean)
4930 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4932 (defun org-toggle-tags-groups ()
4933 "Toggle support for group tags.
4934 Support for group tags is controlled by the option
4935 `org-group-tags', which is non-nil by default."
4936 (interactive)
4937 (setq org-group-tags (not org-group-tags))
4938 (cond ((and (derived-mode-p 'org-agenda-mode)
4939 org-group-tags)
4940 (org-agenda-redo))
4941 ((derived-mode-p 'org-mode)
4942 (let ((org-inhibit-startup t)) (org-mode))))
4943 (message "Groups tags support has been turned %s"
4944 (if org-group-tags "on" "off")))
4946 (defun org-set-regexps-and-options (&optional tags-only)
4947 "Precompute regular expressions used in the current buffer.
4948 When optional argument TAGS-ONLY is non-nil, only compute tags
4949 related expressions."
4950 (when (derived-mode-p 'org-mode)
4951 (let ((alist (org--setup-collect-keywords
4952 (org-make-options-regexp
4953 (append '("FILETAGS" "TAGS" "SETUPFILE")
4954 (and (not tags-only)
4955 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4956 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4957 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4958 (org--setup-process-tags
4959 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4960 (unless tags-only
4961 ;; File properties.
4962 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4963 ;; Archive location.
4964 (let ((archive (cdr (assq 'archive alist))))
4965 (when archive (org-set-local 'org-archive-location archive)))
4966 ;; Category.
4967 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4968 (when cat
4969 (org-set-local 'org-category (intern cat))
4970 (org-set-local 'org-file-properties
4971 (org--update-property-plist
4972 "CATEGORY" cat org-file-properties))))
4973 ;; Columns.
4974 (let ((column (cdr (assq 'columns alist))))
4975 (when column (org-set-local 'org-columns-default-format column)))
4976 ;; Constants.
4977 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4978 ;; Link abbreviations.
4979 (let ((links (cdr (assq 'link alist))))
4980 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4981 ;; Priorities.
4982 (let ((priorities (cdr (assq 'priorities alist))))
4983 (when priorities
4984 (org-set-local 'org-highest-priority (nth 0 priorities))
4985 (org-set-local 'org-lowest-priority (nth 1 priorities))
4986 (org-set-local 'org-default-priority (nth 2 priorities))))
4987 ;; Scripts.
4988 (let ((scripts (assq 'scripts alist)))
4989 (when scripts
4990 (org-set-local 'org-use-sub-superscripts (cdr scripts))))
4991 ;; Startup options.
4992 (let ((startup (cdr (assq 'startup alist))))
4993 (dolist (option startup)
4994 (let ((entry (assoc-string option org-startup-options t)))
4995 (when entry
4996 (let ((var (nth 1 entry))
4997 (val (nth 2 entry)))
4998 (if (not (nth 3 entry)) (org-set-local var val)
4999 (unless (listp (symbol-value var))
5000 (org-set-local var nil))
5001 (add-to-list var val)))))))
5002 ;; TODO keywords.
5003 (org-set-local 'org-todo-kwd-alist nil)
5004 (org-set-local 'org-todo-key-alist nil)
5005 (org-set-local 'org-todo-key-trigger nil)
5006 (org-set-local 'org-todo-keywords-1 nil)
5007 (org-set-local 'org-done-keywords nil)
5008 (org-set-local 'org-todo-heads nil)
5009 (org-set-local 'org-todo-sets nil)
5010 (org-set-local 'org-todo-log-states nil)
5011 (let ((todo-sequences
5012 (or (nreverse (cdr (assq 'todo alist)))
5013 (let ((d (default-value 'org-todo-keywords)))
5014 (if (not (stringp (car d))) d
5015 ;; XXX: Backward compatibility code.
5016 (list (cons org-todo-interpretation d)))))))
5017 (dolist (sequence todo-sequences)
5018 (let* ((sequence (or (run-hook-with-args-until-success
5019 'org-todo-setup-filter-hook sequence)
5020 sequence))
5021 (sequence-type (car sequence))
5022 (keywords (cdr sequence))
5023 (sep (member "|" keywords))
5024 names alist)
5025 (dolist (k (remove "|" keywords))
5026 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5028 (error "Invalid TODO keyword %s" k))
5029 (let ((name (match-string 1 k))
5030 (key (match-string 2 k))
5031 (log (org-extract-log-state-settings k)))
5032 (push name names)
5033 (push (cons name (and key (string-to-char key))) alist)
5034 (when log (push log org-todo-log-states))))
5035 (let* ((names (nreverse names))
5036 (done (if sep (org-remove-keyword-keys (cdr sep))
5037 (last names)))
5038 (head (car names))
5039 (tail (list sequence-type head (car done) (org-last done))))
5040 (add-to-list 'org-todo-heads head 'append)
5041 (push names org-todo-sets)
5042 (setq org-done-keywords (append org-done-keywords done nil))
5043 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5044 (setq org-todo-key-alist
5045 (append org-todo-key-alist
5046 (and alist
5047 (append '((:startgroup))
5048 (nreverse alist)
5049 '((:endgroup))))))
5050 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5051 (setq org-todo-sets (nreverse org-todo-sets)
5052 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5053 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5054 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5055 ;; Compute the regular expressions and other local variables.
5056 ;; Using `org-outline-regexp-bol' would complicate them much,
5057 ;; because of the fixed white space at the end of that string.
5058 (if (not org-done-keywords)
5059 (setq org-done-keywords
5060 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5061 (setq org-not-done-keywords
5062 (org-delete-all org-done-keywords
5063 (copy-sequence org-todo-keywords-1))
5064 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5065 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5066 org-not-done-heading-regexp
5067 (format org-heading-keyword-regexp-format org-not-done-regexp)
5068 org-todo-line-regexp
5069 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5070 org-complex-heading-regexp
5071 (concat "^\\(\\*+\\)"
5072 "\\(?: +" org-todo-regexp "\\)?"
5073 "\\(?: +\\(\\[#.\\]\\)\\)?"
5074 "\\(?: +\\(.*?\\)\\)??"
5075 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5076 "[ \t]*$")
5077 org-complex-heading-regexp-format
5078 (concat "^\\(\\*+\\)"
5079 "\\(?: +" org-todo-regexp "\\)?"
5080 "\\(?: +\\(\\[#.\\]\\)\\)?"
5081 "\\(?: +"
5082 ;; Stats cookies can be stuck to body.
5083 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5084 "\\(%s\\)"
5085 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5086 "\\)"
5087 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5088 "[ \t]*$")
5089 org-todo-line-tags-regexp
5090 (concat "^\\(\\*+\\)"
5091 "\\(?: +" org-todo-regexp "\\)?"
5092 "\\(?: +\\(.*?\\)\\)??"
5093 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5094 "[ \t]*$"))
5095 (org-compute-latex-and-related-regexp)))))
5097 (defun org--setup-collect-keywords (regexp &optional files alist)
5098 "Return setup keywords values as an alist.
5100 REGEXP matches a subset of setup keywords. FILES is a list of
5101 file names already visited. It is used to avoid circular setup
5102 files. ALIST, when non-nil, is the alist computed so far.
5104 Return value contains the following keys: `archive', `category',
5105 `columns', `constants', `filetags', `link', `priorities',
5106 `property', `scripts', `startup', `tags' and `todo'."
5107 (org-with-wide-buffer
5108 (goto-char (point-min))
5109 (let ((case-fold-search t))
5110 (while (re-search-forward regexp nil t)
5111 (let ((element (org-element-at-point)))
5112 (when (eq (org-element-type element) 'keyword)
5113 (let ((key (org-element-property :key element))
5114 (value (org-element-property :value element)))
5115 (cond
5116 ((equal key "ARCHIVE")
5117 (when (org-string-nw-p value)
5118 (push (cons 'archive value) alist)))
5119 ((equal key "CATEGORY") (push (cons 'category value) alist))
5120 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5121 ((equal key "CONSTANTS")
5122 (let* ((constants (assq 'constants alist))
5123 (store (cdr constants)))
5124 (dolist (pair (org-split-string value))
5125 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5126 pair)
5127 (let* ((name (match-string 1 pair))
5128 (value (match-string 2 pair))
5129 (old (assoc name store)))
5130 (if old (setcdr old value)
5131 (push (cons name value) store)))))
5132 (if constants (setcdr constants store)
5133 (push (cons 'constants store) alist))))
5134 ((equal key "FILETAGS")
5135 (when (org-string-nw-p value)
5136 (let ((old (assq 'filetags alist))
5137 (new (apply #'nconc
5138 (mapcar (lambda (x) (org-split-string x ":"))
5139 (org-split-string value)))))
5140 (if old (setcdr old (append new (cdr old)))
5141 (push (cons 'filetags new) alist)))))
5142 ((equal key "LINK")
5143 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5144 (let ((links (assq 'link alist))
5145 (pair (cons (org-match-string-no-properties 1 value)
5146 (org-match-string-no-properties 2 value))))
5147 (if links (push pair (cdr links))
5148 (push (list 'link pair) alist)))))
5149 ((equal key "OPTIONS")
5150 (when (and (org-string-nw-p value)
5151 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5152 (push (cons 'scripts (read (match-string 1 value))) alist)))
5153 ((equal key "PRIORITIES")
5154 (push (cons 'priorities
5155 (let ((prio (org-split-string value)))
5156 (if (< (length prio) 3) '(?A ?C ?B)
5157 (mapcar #'string-to-char prio))))
5158 alist))
5159 ((equal key "PROPERTY")
5160 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5161 (let* ((property (assq 'property alist))
5162 (value (org--update-property-plist
5163 (org-match-string-no-properties 1 value)
5164 (org-match-string-no-properties 2 value)
5165 (cdr property))))
5166 (if property (setcdr property value)
5167 (push (cons 'property value) alist)))))
5168 ((equal key "STARTUP")
5169 (let ((startup (assq 'startup alist)))
5170 (if startup
5171 (setcdr startup
5172 (append (cdr startup) (org-split-string value)))
5173 (push (cons 'startup (org-split-string value)) alist))))
5174 ((equal key "TAGS")
5175 (let ((tag-cell (assq 'tags alist)))
5176 (if tag-cell
5177 (setcdr tag-cell
5178 (append (cdr tag-cell)
5179 '("\\n")
5180 (org-split-string value)))
5181 (push (cons 'tags (org-split-string value)) alist))))
5182 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5183 (let ((todo (assq 'todo alist))
5184 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5185 (org-split-string value))))
5186 (if todo (push value (cdr todo))
5187 (push (list 'todo value) alist))))
5188 ((equal key "SETUPFILE")
5189 (unless buffer-read-only ; Do not check in Gnus messages.
5190 (let ((f (and (org-string-nw-p value)
5191 (expand-file-name
5192 (org-remove-double-quotes value)))))
5193 (when (and f (file-readable-p f) (not (member f files)))
5194 (with-temp-buffer
5195 (insert-file-contents f)
5196 (setq alist
5197 ;; Fake Org mode to benefit from cache
5198 ;; without recurring needlessly.
5199 (let ((major-mode 'org-mode))
5200 (org--setup-collect-keywords
5201 regexp (cons f files) alist)))))))))))))))
5202 alist)
5204 (defun org--setup-process-tags (tags filetags)
5205 "Precompute variables used for tags.
5206 TAGS is a list of tags and tag group symbols, as strings.
5207 FILETAGS is a list of tags, as strings."
5208 ;; Process the file tags.
5209 (org-set-local 'org-file-tags
5210 (mapcar #'org-add-prop-inherited filetags))
5211 ;; Provide default tags if no local tags are found.
5212 (when (and (not tags) org-tag-alist)
5213 (setq tags
5214 (mapcar (lambda (tag)
5215 (case (car tag)
5216 (:startgroup "{")
5217 (:endgroup "}")
5218 (:grouptags ":")
5219 (:newline "\\n")
5220 (otherwise (concat (car tag)
5221 (and (characterp (cdr tag))
5222 (format "(%c)" (cdr tag)))))))
5223 org-tag-alist)))
5224 ;; Process the tags.
5225 (org-set-local 'org-tag-groups-alist nil)
5226 (org-set-local 'org-tag-alist nil)
5227 (let (group-flag)
5228 (while tags
5229 (let ((e (car tags)))
5230 (setq tags (cdr tags))
5231 (cond
5232 ((equal e "{")
5233 (push '(:startgroup) org-tag-alist)
5234 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5235 ((equal e "}")
5236 (push '(:endgroup) org-tag-alist)
5237 (setq group-flag nil))
5238 ((equal e ":")
5239 (push '(:grouptags) org-tag-alist)
5240 (setq group-flag 'append))
5241 ((equal e "\\n") (push '(:newline) org-tag-alist))
5242 ((string-match
5243 (org-re "\\`\\([[:alnum:]_@#%]+\\)\\(?:(\\(.\\))\\)?\\'") e)
5244 (let ((tag (match-string 1 e))
5245 (key (and (match-beginning 2)
5246 (string-to-char (match-string 2 e)))))
5247 (cond ((eq group-flag 'append)
5248 (setcar org-tag-groups-alist
5249 (append (car org-tag-groups-alist) (list tag))))
5250 (group-flag (push (list tag) org-tag-groups-alist)))
5251 (unless (assoc tag org-tag-alist)
5252 (push (cons tag key) org-tag-alist))))))))
5253 (setq org-tag-alist (nreverse org-tag-alist)))
5255 (defun org-file-contents (file &optional noerror)
5256 "Return the contents of FILE, as a string."
5257 (if (and file (file-readable-p file))
5258 (with-temp-buffer
5259 (insert-file-contents file)
5260 (buffer-string))
5261 (funcall (if noerror 'message 'error)
5262 "Cannot read file \"%s\"%s"
5263 file
5264 (let ((from (buffer-file-name (buffer-base-buffer))))
5265 (if from (concat " (referenced in file \"" from "\")") "")))))
5267 (defun org-extract-log-state-settings (x)
5268 "Extract the log state setting from a TODO keyword string.
5269 This will extract info from a string like \"WAIT(w@/!)\"."
5270 (let (kw key log1 log2)
5271 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5272 (setq kw (match-string 1 x)
5273 key (and (match-end 2) (match-string 2 x))
5274 log1 (and (match-end 3) (match-string 3 x))
5275 log2 (and (match-end 4) (match-string 4 x)))
5276 (and (or log1 log2)
5277 (list kw
5278 (and log1 (if (equal log1 "!") 'time 'note))
5279 (and log2 (if (equal log2 "!") 'time 'note)))))))
5281 (defun org-remove-keyword-keys (list)
5282 "Remove a pair of parenthesis at the end of each string in LIST."
5283 (mapcar (lambda (x)
5284 (if (string-match "(.*)$" x)
5285 (substring x 0 (match-beginning 0))
5287 list))
5289 (defun org-assign-fast-keys (alist)
5290 "Assign fast keys to a keyword-key alist.
5291 Respect keys that are already there."
5292 (let (new e (alt ?0))
5293 (while (setq e (pop alist))
5294 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5295 (cdr e)) ;; Key already assigned.
5296 (push e new)
5297 (let ((clist (string-to-list (downcase (car e))))
5298 (used (append new alist)))
5299 (when (= (car clist) ?@)
5300 (pop clist))
5301 (while (and clist (rassoc (car clist) used))
5302 (pop clist))
5303 (unless clist
5304 (while (rassoc alt used)
5305 (incf alt)))
5306 (push (cons (car e) (or (car clist) alt)) new))))
5307 (nreverse new)))
5309 ;;; Some variables used in various places
5311 (defvar org-window-configuration nil
5312 "Used in various places to store a window configuration.")
5313 (defvar org-selected-window nil
5314 "Used in various places to store a window configuration.")
5315 (defvar org-finish-function nil
5316 "Function to be called when `C-c C-c' is used.
5317 This is for getting out of special buffers like capture.")
5320 ;; FIXME: Occasionally check by commenting these, to make sure
5321 ;; no other functions uses these, forgetting to let-bind them.
5322 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5323 (defvar org-last-state)
5324 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5326 ;; Defined somewhere in this file, but used before definition.
5327 (defvar org-entities) ;; defined in org-entities.el
5328 (defvar org-struct-menu)
5329 (defvar org-org-menu)
5330 (defvar org-tbl-menu)
5332 ;;;; Define the Org-mode
5334 ;; We use a before-change function to check if a table might need
5335 ;; an update.
5336 (defvar org-table-may-need-update t
5337 "Indicates that a table might need an update.
5338 This variable is set by `org-before-change-function'.
5339 `org-table-align' sets it back to nil.")
5340 (defun org-before-change-function (beg end)
5341 "Every change indicates that a table might need an update."
5342 (setq org-table-may-need-update t))
5343 (defvar org-mode-map)
5344 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5345 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5346 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5347 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5348 (defvar org-table-buffer-is-an nil)
5350 (defvar bidi-paragraph-direction)
5351 (defvar buffer-face-mode-face)
5353 (require 'outline)
5354 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5355 (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"))
5356 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5358 ;; Other stuff we need.
5359 (require 'time-date)
5360 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5361 (require 'easymenu)
5362 (require 'overlay)
5364 ;; (require 'org-macs) moved higher up in the file before it is first used
5365 (require 'org-entities)
5366 ;; (require 'org-compat) moved higher up in the file before it is first used
5367 (require 'org-faces)
5368 (require 'org-list)
5369 (require 'org-pcomplete)
5370 (require 'org-src)
5371 (require 'org-footnote)
5372 (require 'org-macro)
5374 ;; babel
5375 (require 'ob)
5377 ;;;###autoload
5378 (define-derived-mode org-mode outline-mode "Org"
5379 "Outline-based notes management and organizer, alias
5380 \"Carsten's outline-mode for keeping track of everything.\"
5382 Org-mode develops organizational tasks around a NOTES file which
5383 contains information about projects as plain text. Org-mode is
5384 implemented on top of outline-mode, which is ideal to keep the content
5385 of large files well structured. It supports ToDo items, deadlines and
5386 time stamps, which magically appear in the diary listing of the Emacs
5387 calendar. Tables are easily created with a built-in table editor.
5388 Plain text URL-like links connect to websites, emails (VM), Usenet
5389 messages (Gnus), BBDB entries, and any files related to the project.
5390 For printing and sharing of notes, an Org-mode file (or a part of it)
5391 can be exported as a structured ASCII or HTML file.
5393 The following commands are available:
5395 \\{org-mode-map}"
5397 ;; Get rid of Outline menus, they are not needed
5398 ;; Need to do this here because define-derived-mode sets up
5399 ;; the keymap so late. Still, it is a waste to call this each time
5400 ;; we switch another buffer into org-mode.
5401 (if (featurep 'xemacs)
5402 (when (boundp 'outline-mode-menu-heading)
5403 ;; Assume this is Greg's port, it uses easymenu
5404 (easy-menu-remove outline-mode-menu-heading)
5405 (easy-menu-remove outline-mode-menu-show)
5406 (easy-menu-remove outline-mode-menu-hide))
5407 (define-key org-mode-map [menu-bar headings] 'undefined)
5408 (define-key org-mode-map [menu-bar hide] 'undefined)
5409 (define-key org-mode-map [menu-bar show] 'undefined))
5411 (org-load-modules-maybe)
5412 (easy-menu-add org-org-menu)
5413 (easy-menu-add org-tbl-menu)
5414 (org-install-agenda-files-menu)
5415 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5416 (add-to-invisibility-spec '(org-cwidth))
5417 (add-to-invisibility-spec '(org-hide-block . t))
5418 (when (featurep 'xemacs)
5419 (org-set-local 'line-move-ignore-invisible t))
5420 (org-set-local 'outline-regexp org-outline-regexp)
5421 (org-set-local 'outline-level 'org-outline-level)
5422 (setq bidi-paragraph-direction 'left-to-right)
5423 (when (and org-ellipsis
5424 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5425 (fboundp 'make-glyph-code))
5426 (unless org-display-table
5427 (setq org-display-table (make-display-table)))
5428 (set-display-table-slot
5429 org-display-table 4
5430 (vconcat (mapcar
5431 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5432 org-ellipsis)))
5433 (if (stringp org-ellipsis) org-ellipsis "..."))))
5434 (setq buffer-display-table org-display-table))
5435 (org-set-regexps-and-options)
5436 (org-set-font-lock-defaults)
5437 (when (and org-tag-faces (not org-tags-special-faces-re))
5438 ;; tag faces set outside customize.... force initialization.
5439 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5440 ;; Calc embedded
5441 (org-set-local 'calc-embedded-open-mode "# ")
5442 ;; Modify a few syntax entries
5443 (modify-syntax-entry ?@ "w")
5444 (modify-syntax-entry ?\" "\"")
5445 (modify-syntax-entry ?\\ "_")
5446 (modify-syntax-entry ?~ "_")
5447 (if org-startup-truncated (setq truncate-lines t))
5448 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5449 (org-set-local 'font-lock-unfontify-region-function
5450 'org-unfontify-region)
5451 ;; Activate before-change-function
5452 (org-set-local 'org-table-may-need-update t)
5453 (org-add-hook 'before-change-functions 'org-before-change-function nil
5454 'local)
5455 ;; Check for running clock before killing a buffer
5456 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5457 ;; Initialize macros templates.
5458 (org-macro-initialize-templates)
5459 ;; Initialize radio targets.
5460 (org-update-radio-target-regexp)
5461 ;; Indentation.
5462 (org-set-local 'indent-line-function 'org-indent-line)
5463 (org-set-local 'indent-region-function 'org-indent-region)
5464 ;; Filling and auto-filling.
5465 (org-setup-filling)
5466 ;; Comments.
5467 (org-setup-comments-handling)
5468 ;; Initialize cache.
5469 (org-element-cache-reset)
5470 ;; Beginning/end of defun
5471 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5472 (org-set-local 'end-of-defun-function
5473 (lambda ()
5474 (if (not (org-at-heading-p))
5475 (org-forward-element)
5476 (org-forward-element)
5477 (forward-char -1))))
5478 ;; Next error for sparse trees
5479 (org-set-local 'next-error-function 'org-occur-next-match)
5480 ;; Make sure dependence stuff works reliably, even for users who set it
5481 ;; too late :-(
5482 (if org-enforce-todo-dependencies
5483 (add-hook 'org-blocker-hook
5484 'org-block-todo-from-children-or-siblings-or-parent)
5485 (remove-hook 'org-blocker-hook
5486 'org-block-todo-from-children-or-siblings-or-parent))
5487 (if org-enforce-todo-checkbox-dependencies
5488 (add-hook 'org-blocker-hook
5489 'org-block-todo-from-checkboxes)
5490 (remove-hook 'org-blocker-hook
5491 'org-block-todo-from-checkboxes))
5493 ;; Align options lines
5494 (org-set-local
5495 'align-mode-rules-list
5496 '((org-in-buffer-settings
5497 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5498 (modes . '(org-mode)))))
5500 ;; Imenu
5501 (org-set-local 'imenu-create-index-function
5502 'org-imenu-get-tree)
5504 ;; Make isearch reveal context
5505 (if (or (featurep 'xemacs)
5506 (not (boundp 'outline-isearch-open-invisible-function)))
5507 ;; Emacs 21 and XEmacs make use of the hook
5508 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5509 ;; Emacs 22 deals with this through a special variable
5510 (org-set-local 'outline-isearch-open-invisible-function
5511 (lambda (&rest ignore) (org-show-context 'isearch))))
5513 ;; Setup the pcomplete hooks
5514 (set (make-local-variable 'pcomplete-command-completion-function)
5515 'org-pcomplete-initial)
5516 (set (make-local-variable 'pcomplete-command-name-function)
5517 'org-command-at-point)
5518 (set (make-local-variable 'pcomplete-default-completion-function)
5519 'ignore)
5520 (set (make-local-variable 'pcomplete-parse-arguments-function)
5521 'org-parse-arguments)
5522 (set (make-local-variable 'pcomplete-termination-string) "")
5523 (when (>= emacs-major-version 23)
5524 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5526 ;; If empty file that did not turn on org-mode automatically, make it to.
5527 (if (and org-insert-mode-line-in-empty-file
5528 (org-called-interactively-p 'any)
5529 (= (point-min) (point-max)))
5530 (insert "# -*- mode: org -*-\n\n"))
5531 (unless org-inhibit-startup
5532 (org-unmodified
5533 (and org-startup-with-beamer-mode (org-beamer-mode))
5534 (when org-startup-align-all-tables
5535 (org-table-map-tables 'org-table-align 'quietly))
5536 (when org-startup-with-inline-images
5537 (org-display-inline-images))
5538 (when org-startup-with-latex-preview
5539 (org-toggle-latex-fragment))
5540 (unless org-inhibit-startup-visibility-stuff
5541 (org-set-startup-visibility))
5542 (org-refresh-effort-properties)))
5543 ;; Try to set org-hide correctly
5544 (let ((foreground (org-find-invisible-foreground)))
5545 (if foreground
5546 (set-face-foreground 'org-hide foreground))))
5548 ;; Update `customize-package-emacs-version-alist'
5549 (add-to-list 'customize-package-emacs-version-alist
5550 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5551 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5552 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5554 (defvar org-mode-transpose-word-syntax-table
5555 (let ((st (make-syntax-table text-mode-syntax-table)))
5556 (mapc (lambda(c) (modify-syntax-entry
5557 (string-to-char (car c)) "w p" st))
5558 org-emphasis-alist)
5559 st))
5561 (when (fboundp 'abbrev-table-put)
5562 (abbrev-table-put org-mode-abbrev-table
5563 :parents (list text-mode-abbrev-table)))
5565 (defun org-find-invisible-foreground ()
5566 (let ((candidates (remove
5567 "unspecified-bg"
5568 (nconc
5569 (list (face-background 'default)
5570 (face-background 'org-default))
5571 (mapcar
5572 (lambda (alist)
5573 (when (boundp alist)
5574 (cdr (assoc 'background-color (symbol-value alist)))))
5575 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5576 (list (face-foreground 'org-hide))))))
5577 (car (remove nil candidates))))
5579 (defun org-current-time (&optional rounding-minutes past)
5580 "Current time, possibly rounded to ROUNDING-MINUTES.
5581 When ROUNDING-MINUTES is not an integer, fall back on the car of
5582 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5583 the rounding returns a past time."
5584 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5585 (car org-time-stamp-rounding-minutes)))
5586 (time (decode-time)) res)
5587 (if (< r 1)
5588 (current-time)
5589 (setq res
5590 (apply 'encode-time
5591 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5592 (nthcdr 2 time))))
5593 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5594 (seconds-to-time (- (org-float-time res) (* r 60)))
5595 res))))
5597 (defun org-today ()
5598 "Return today date, considering `org-extend-today-until'."
5599 (time-to-days
5600 (time-subtract (current-time)
5601 (list 0 (* 3600 org-extend-today-until) 0))))
5603 ;;;; Font-Lock stuff, including the activators
5605 (defvar org-mouse-map (make-sparse-keymap))
5606 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5607 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5608 (when org-mouse-1-follows-link
5609 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5610 (when org-tab-follows-link
5611 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5612 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5614 (require 'font-lock)
5616 (defconst org-non-link-chars "]\t\n\r<>")
5617 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5618 "file+sys" "news" "shell" "elisp" "doi" "message"
5619 "help"))
5620 (defvar org-link-types-re nil
5621 "Matches a link that has a url-like prefix like \"http:\"")
5622 (defvar org-link-re-with-space nil
5623 "Matches a link with spaces, optional angular brackets around it.")
5624 (defvar org-link-re-with-space2 nil
5625 "Matches a link with spaces, optional angular brackets around it.")
5626 (defvar org-link-re-with-space3 nil
5627 "Matches a link with spaces, only for internal part in bracket links.")
5628 (defvar org-angle-link-re nil
5629 "Matches link with angular brackets, spaces are allowed.")
5630 (defvar org-plain-link-re nil
5631 "Matches plain link, without spaces.")
5632 (defvar org-bracket-link-regexp nil
5633 "Matches a link in double brackets.")
5634 (defvar org-bracket-link-analytic-regexp nil
5635 "Regular expression used to analyze links.
5636 Here is what the match groups contain after a match:
5637 1: http:
5638 2: http
5639 3: path
5640 4: [desc]
5641 5: desc")
5642 (defvar org-bracket-link-analytic-regexp++ nil
5643 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5644 (defvar org-any-link-re nil
5645 "Regular expression matching any link.")
5647 (defconst org-match-sexp-depth 3
5648 "Number of stacked braces for sub/superscript matching.")
5650 (defun org-create-multibrace-regexp (left right n)
5651 "Create a regular expression which will match a balanced sexp.
5652 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5653 as single character strings.
5654 The regexp returned will match the entire expression including the
5655 delimiters. It will also define a single group which contains the
5656 match except for the outermost delimiters. The maximum depth of
5657 stacked delimiters is N. Escaping delimiters is not possible."
5658 (let* ((nothing (concat "[^" left right "]*?"))
5659 (or "\\|")
5660 (re nothing)
5661 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5662 (while (> n 1)
5663 (setq n (1- n)
5664 re (concat re or next)
5665 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5666 (concat left "\\(" re "\\)" right)))
5668 (defconst org-match-substring-regexp
5669 (concat
5670 "\\(\\S-\\)\\([_^]\\)\\("
5671 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5672 "\\|"
5673 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5674 "\\|"
5675 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5676 "The regular expression matching a sub- or superscript.")
5678 (defconst org-match-substring-with-braces-regexp
5679 (concat
5680 "\\(\\S-\\)\\([_^]\\)"
5681 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5682 "The regular expression matching a sub- or superscript, forcing braces.")
5684 (defun org-make-link-regexps ()
5685 "Update the link regular expressions.
5686 This should be called after the variable `org-link-types' has changed."
5687 (let ((types-re (regexp-opt org-link-types t)))
5688 (setq org-link-types-re
5689 (concat "\\`" types-re ":")
5690 org-link-re-with-space
5691 (concat "<?" types-re ":"
5692 "\\([^" org-non-link-chars " ]"
5693 "[^" org-non-link-chars "]*"
5694 "[^" org-non-link-chars " ]\\)>?")
5695 org-link-re-with-space2
5696 (concat "<?" types-re ":"
5697 "\\([^" org-non-link-chars " ]"
5698 "[^\t\n\r]*"
5699 "[^" org-non-link-chars " ]\\)>?")
5700 org-link-re-with-space3
5701 (concat "<?" types-re ":"
5702 "\\([^" org-non-link-chars " ]"
5703 "[^\t\n\r]*\\)")
5704 org-angle-link-re
5705 (concat "<" types-re ":"
5706 "\\([^" org-non-link-chars " ]"
5707 "[^" org-non-link-chars "]*"
5708 "\\)>")
5709 org-plain-link-re
5710 (concat
5711 "\\<" types-re ":"
5712 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5713 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5714 org-bracket-link-regexp
5715 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5716 org-bracket-link-analytic-regexp
5717 (concat
5718 "\\[\\["
5719 "\\(" types-re ":\\)?"
5720 "\\([^]]+\\)"
5721 "\\]"
5722 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5723 "\\]")
5724 org-bracket-link-analytic-regexp++
5725 (concat
5726 "\\[\\["
5727 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5728 "\\([^]]+\\)"
5729 "\\]"
5730 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5731 "\\]")
5732 org-any-link-re
5733 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5734 org-angle-link-re "\\)\\|\\("
5735 org-plain-link-re "\\)"))))
5737 (org-make-link-regexps)
5739 (defvar org-emph-face nil)
5741 (defun org-do-emphasis-faces (limit)
5742 "Run through the buffer and emphasize strings."
5743 (let (rtn a)
5744 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5745 (let* ((border (char-after (match-beginning 3)))
5746 (bre (regexp-quote (char-to-string border))))
5747 (if (and (not (= border (char-after (match-beginning 4))))
5748 (not (save-match-data
5749 (string-match (concat bre ".*" bre)
5750 (replace-regexp-in-string
5751 "\n" " "
5752 (substring (match-string 2) 1 -1))))))
5753 (progn
5754 (setq rtn t)
5755 (setq a (assoc (match-string 3) org-emphasis-alist))
5756 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5757 'face
5758 (nth 1 a))
5759 (and (nth 2 a)
5760 (org-remove-flyspell-overlays-in
5761 (match-beginning 0) (match-end 0)))
5762 (add-text-properties (match-beginning 2) (match-end 2)
5763 '(font-lock-multiline t org-emphasis t))
5764 (when org-hide-emphasis-markers
5765 (add-text-properties (match-end 4) (match-beginning 5)
5766 '(invisible org-link))
5767 (add-text-properties (match-beginning 3) (match-end 3)
5768 '(invisible org-link))))))
5769 (goto-char (1+ (match-beginning 0))))
5770 rtn))
5772 (defun org-emphasize (&optional char)
5773 "Insert or change an emphasis, i.e. a font like bold or italic.
5774 If there is an active region, change that region to a new emphasis.
5775 If there is no region, just insert the marker characters and position
5776 the cursor between them.
5777 CHAR should be the marker character. If it is a space, it means to
5778 remove the emphasis of the selected region.
5779 If CHAR is not given (for example in an interactive call) it will be
5780 prompted for."
5781 (interactive)
5782 (let ((erc org-emphasis-regexp-components)
5783 (prompt "")
5784 (string "") beg end move c s)
5785 (if (org-region-active-p)
5786 (setq beg (region-beginning) end (region-end)
5787 string (buffer-substring beg end))
5788 (setq move t))
5790 (unless char
5791 (message "Emphasis marker or tag: [%s]"
5792 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5793 (setq char (read-char-exclusive)))
5794 (if (equal char ?\ )
5795 (setq s "" move nil)
5796 (unless (assoc (char-to-string char) org-emphasis-alist)
5797 (user-error "No such emphasis marker: \"%c\"" char))
5798 (setq s (char-to-string char)))
5799 (while (and (> (length string) 1)
5800 (equal (substring string 0 1) (substring string -1))
5801 (assoc (substring string 0 1) org-emphasis-alist))
5802 (setq string (substring string 1 -1)))
5803 (setq string (concat s string s))
5804 (if beg (delete-region beg end))
5805 (unless (or (bolp)
5806 (string-match (concat "[" (nth 0 erc) "\n]")
5807 (char-to-string (char-before (point)))))
5808 (insert " "))
5809 (unless (or (eobp)
5810 (string-match (concat "[" (nth 1 erc) "\n]")
5811 (char-to-string (char-after (point)))))
5812 (insert " ") (backward-char 1))
5813 (insert string)
5814 (and move (backward-char 1))))
5816 (defconst org-nonsticky-props
5817 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5819 (defsubst org-rear-nonsticky-at (pos)
5820 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5822 (defun org-activate-plain-links (limit)
5823 "Add link properties for plain links."
5824 (let (f hl)
5825 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5826 (not (member 'org-tag
5827 (get-text-property (1- (match-beginning 0)) 'face)))
5828 (not (org-in-src-block-p)))
5829 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5830 (setq f (get-text-property (match-beginning 0) 'face))
5831 (setq hl (org-match-string-no-properties 0))
5832 (if (or (eq f 'org-tag)
5833 (and (listp f) (memq 'org-tag f)))
5835 (add-text-properties (match-beginning 0) (match-end 0)
5836 (list 'mouse-face 'highlight
5837 'face 'org-link
5838 'htmlize-link `(:uri ,hl)
5839 'keymap org-mouse-map))
5840 (org-rear-nonsticky-at (match-end 0)))
5841 t)))
5843 (defun org-activate-code (limit)
5844 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5845 (progn
5846 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5847 (remove-text-properties (match-beginning 0) (match-end 0)
5848 '(display t invisible t intangible t))
5849 t)))
5851 (defcustom org-src-fontify-natively t
5852 "When non-nil, fontify code in code blocks."
5853 :type 'boolean
5854 :version "24.4"
5855 :package-version '(Org . "8.3")
5856 :group 'org-appearance
5857 :group 'org-babel)
5859 (defcustom org-allow-promoting-top-level-subtree nil
5860 "When non-nil, allow promoting a top level subtree.
5861 The leading star of the top level headline will be replaced
5862 by a #."
5863 :type 'boolean
5864 :version "24.1"
5865 :group 'org-appearance)
5867 (defun org-fontify-meta-lines-and-blocks (limit)
5868 (condition-case nil
5869 (org-fontify-meta-lines-and-blocks-1 limit)
5870 (error (message "org-mode fontification error"))))
5872 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5873 "Fontify #+ lines and blocks."
5874 (let ((case-fold-search t))
5875 (if (re-search-forward
5876 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5877 limit t)
5878 (let ((beg (match-beginning 0))
5879 (block-start (match-end 0))
5880 (block-end nil)
5881 (lang (match-string 7))
5882 (beg1 (line-beginning-position 2))
5883 (dc1 (downcase (match-string 2)))
5884 (dc3 (downcase (match-string 3)))
5885 end end1 quoting block-type ovl)
5886 (cond
5887 ((member dc1 '("+html:" "+ascii:" "+latex:"))
5888 ;; a single line of backend-specific content
5889 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5890 (remove-text-properties (match-beginning 0) (match-end 0)
5891 '(display t invisible t intangible t))
5892 (add-text-properties (match-beginning 1) (match-end 3)
5893 '(font-lock-fontified t face org-meta-line))
5894 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5895 '(font-lock-fontified t face org-block))
5896 ; for backend-specific code
5898 ((and (match-end 4) (equal dc3 "+begin"))
5899 ;; Truly a block
5900 (setq block-type (downcase (match-string 5))
5901 quoting (member block-type org-protecting-blocks))
5902 (when (re-search-forward
5903 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5904 nil t) ;; on purpose, we look further than LIMIT
5905 (setq end (min (point-max) (match-end 0))
5906 end1 (min (point-max) (1- (match-beginning 0))))
5907 (setq block-end (match-beginning 0))
5908 (when quoting
5909 (org-remove-flyspell-overlays-in beg1 end1)
5910 (remove-text-properties beg end
5911 '(display t invisible t intangible t)))
5912 (add-text-properties
5913 beg end '(font-lock-fontified t font-lock-multiline t))
5914 (add-text-properties beg beg1 '(face org-meta-line))
5915 (org-remove-flyspell-overlays-in beg beg1)
5916 (add-text-properties ; For end_src
5917 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5918 (org-remove-flyspell-overlays-in end1 end)
5919 (cond
5920 ((and lang (not (string= lang "")) org-src-fontify-natively)
5921 (org-src-font-lock-fontify-block lang block-start block-end)
5922 (add-text-properties beg1 block-end '(src-block t)))
5923 (quoting
5924 (add-text-properties beg1 (min (point-max) (1+ end1))
5925 '(face org-block))) ; end of source block
5926 ((not org-fontify-quote-and-verse-blocks))
5927 ((string= block-type "quote")
5928 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5929 ((string= block-type "verse")
5930 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5931 (add-text-properties beg beg1 '(face org-block-begin-line))
5932 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5933 '(face org-block-end-line))
5935 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5936 (org-remove-flyspell-overlays-in
5937 (match-beginning 0)
5938 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5939 (add-text-properties
5940 beg (match-end 3)
5941 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5942 '(font-lock-fontified t invisible t)
5943 '(font-lock-fontified t face org-document-info-keyword)))
5944 (add-text-properties
5945 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5946 (if (string-equal dc1 "+title:")
5947 '(font-lock-fontified t face org-document-title)
5948 '(font-lock-fontified t face org-document-info))))
5949 ((or (equal dc1 "+results")
5950 (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
5951 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5952 "+call:" "+header:" "+headers:" "+name:"))
5953 (and (match-end 4) (equal dc3 "+attr")))
5954 (org-remove-flyspell-overlays-in
5955 (match-beginning 0)
5956 (if (equal "+caption:" dc1) (match-end 2) (match-end 0)))
5957 (add-text-properties
5958 beg (match-end 0)
5959 '(font-lock-fontified t face org-meta-line))
5961 ((member dc3 '(" " ""))
5962 (org-remove-flyspell-overlays-in beg (match-end 0))
5963 (add-text-properties
5964 beg (match-end 0)
5965 '(font-lock-fontified t face font-lock-comment-face)))
5966 (t ;; just any other in-buffer setting, but not indented
5967 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5968 (add-text-properties
5969 beg (match-end 0)
5970 '(font-lock-fontified t face org-meta-line))
5971 t))))))
5973 (defun org-fontify-drawers (limit)
5974 "Fontify drawers."
5975 (when (re-search-forward org-drawer-regexp limit t)
5976 (add-text-properties
5977 (match-beginning 0) (match-end 0)
5978 '(font-lock-fontified t face org-special-keyword))
5979 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5982 (defun org-fontify-macros (limit)
5983 "Fontify macros."
5984 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5985 (add-text-properties
5986 (match-beginning 0) (match-end 0)
5987 '(font-lock-fontified t face org-macro))
5988 (when org-hide-macro-markers
5989 (add-text-properties (match-end 2) (match-beginning 2)
5990 '(invisible t))
5991 (add-text-properties (match-beginning 1) (match-end 1)
5992 '(invisible t)))
5993 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5996 (defun org-activate-angle-links (limit)
5997 "Add text properties for angle links."
5998 (if (and (re-search-forward org-angle-link-re limit t)
5999 (not (org-in-src-block-p)))
6000 (progn
6001 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6002 (add-text-properties (match-beginning 0) (match-end 0)
6003 (list 'mouse-face 'highlight
6004 'keymap org-mouse-map))
6005 (org-rear-nonsticky-at (match-end 0))
6006 t)))
6008 (defun org-activate-footnote-links (limit)
6009 "Add text properties for footnotes."
6010 (let ((fn (org-footnote-next-reference-or-definition limit)))
6011 (when fn
6012 (let* ((beg (nth 1 fn))
6013 (end (nth 2 fn))
6014 (label (car fn))
6015 (referencep (/= (line-beginning-position) beg)))
6016 (when (and referencep (nth 3 fn))
6017 (save-excursion
6018 (goto-char beg)
6019 (search-forward (or label "fn:"))
6020 (org-remove-flyspell-overlays-in beg (match-end 0))))
6021 (add-text-properties beg end
6022 (list 'mouse-face 'highlight
6023 'keymap org-mouse-map
6024 'help-echo
6025 (if referencep "Footnote reference"
6026 "Footnote definition")
6027 'font-lock-fontified t
6028 'font-lock-multiline t
6029 'face 'org-footnote))))))
6031 (defun org-activate-bracket-links (limit)
6032 "Add text properties for bracketed links."
6033 (if (and (re-search-forward org-bracket-link-regexp limit t)
6034 (not (org-in-src-block-p)))
6035 (let* ((hl (org-match-string-no-properties 1))
6036 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6037 (ip (org-maybe-intangible
6038 (list 'invisible 'org-link
6039 'keymap org-mouse-map 'mouse-face 'highlight
6040 'font-lock-multiline t 'help-echo help
6041 'htmlize-link `(:uri ,hl))))
6042 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6043 'font-lock-multiline t 'help-echo help
6044 'htmlize-link `(:uri ,hl))))
6045 ;; We need to remove the invisible property here. Table narrowing
6046 ;; may have made some of this invisible.
6047 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6048 (remove-text-properties (match-beginning 0) (match-end 0)
6049 '(invisible nil))
6050 (if (match-end 3)
6051 (progn
6052 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6053 (org-rear-nonsticky-at (match-beginning 3))
6054 (add-text-properties (match-beginning 3) (match-end 3) vp)
6055 (org-rear-nonsticky-at (match-end 3))
6056 (add-text-properties (match-end 3) (match-end 0) ip)
6057 (org-rear-nonsticky-at (match-end 0)))
6058 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6059 (org-rear-nonsticky-at (match-beginning 1))
6060 (add-text-properties (match-beginning 1) (match-end 1) vp)
6061 (org-rear-nonsticky-at (match-end 1))
6062 (add-text-properties (match-end 1) (match-end 0) ip)
6063 (org-rear-nonsticky-at (match-end 0)))
6064 t)))
6066 (defun org-activate-dates (limit)
6067 "Add text properties for dates."
6068 (if (and (re-search-forward org-tsr-regexp-both limit t)
6069 (not (equal (char-before (match-beginning 0)) 91)))
6070 (progn
6071 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6072 (add-text-properties (match-beginning 0) (match-end 0)
6073 (list 'mouse-face 'highlight
6074 'keymap org-mouse-map))
6075 (org-rear-nonsticky-at (match-end 0))
6076 (when org-display-custom-times
6077 (if (match-end 3)
6078 (org-display-custom-time (match-beginning 3) (match-end 3)))
6079 (org-display-custom-time (match-beginning 1) (match-end 1)))
6080 t)))
6082 (defvar org-target-link-regexp nil
6083 "Regular expression matching radio targets in plain text.")
6084 (make-variable-buffer-local 'org-target-link-regexp)
6086 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6087 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6088 border border border))
6089 "Regular expression matching a link target.")
6091 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6092 "Regular expression matching a radio target.")
6094 (defconst org-any-target-regexp
6095 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6096 "Regular expression matching any target.")
6098 (defun org-activate-target-links (limit)
6099 "Add text properties for target matches."
6100 (when org-target-link-regexp
6101 (let ((case-fold-search t))
6102 (if (re-search-forward org-target-link-regexp limit t)
6103 (progn
6104 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6105 (add-text-properties (match-beginning 1) (match-end 1)
6106 (list 'mouse-face 'highlight
6107 'keymap org-mouse-map
6108 'help-echo "Radio target link"
6109 'org-linked-text t))
6110 (org-rear-nonsticky-at (match-end 1))
6111 t)))))
6113 (defun org-update-radio-target-regexp ()
6114 "Find all radio targets in this file and update the regular expression.
6115 Also refresh fontification if needed."
6116 (interactive)
6117 (let ((old-regexp org-target-link-regexp)
6118 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6119 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6120 (targets
6121 (org-with-wide-buffer
6122 (goto-char (point-min))
6123 (let (rtn)
6124 (while (re-search-forward org-radio-target-regexp nil t)
6125 ;; Make sure point is really within the object.
6126 (backward-char)
6127 (let ((obj (org-element-context)))
6128 (when (eq (org-element-type obj) 'radio-target)
6129 (add-to-list 'rtn (org-element-property :value obj)))))
6130 rtn))))
6131 (setq org-target-link-regexp
6132 (and targets
6133 (concat before-re
6134 (mapconcat
6135 (lambda (x)
6136 (replace-regexp-in-string
6137 " +" "\\s-+" (regexp-quote x) t t))
6138 targets
6139 "\\|")
6140 after-re)))
6141 (unless (equal old-regexp org-target-link-regexp)
6142 ;; Clean-up cache.
6143 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6144 ((not org-target-link-regexp) old-regexp)
6146 (concat before-re
6147 (mapconcat
6148 (lambda (re)
6149 (substring re (length before-re)
6150 (- (length after-re))))
6151 (list old-regexp org-target-link-regexp)
6152 "\\|")
6153 after-re)))))
6154 (org-with-wide-buffer
6155 (goto-char (point-min))
6156 (while (re-search-forward regexp nil t)
6157 (org-element-cache-refresh (match-beginning 1)))))
6158 ;; Re fontify buffer.
6159 (when (memq 'radio org-highlight-links)
6160 (org-restart-font-lock)))))
6162 (defun org-hide-wide-columns (limit)
6163 (let (s e)
6164 (setq s (text-property-any (point) (or limit (point-max))
6165 'org-cwidth t))
6166 (when s
6167 (setq e (next-single-property-change s 'org-cwidth))
6168 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6169 (goto-char e)
6170 t)))
6172 (defvar org-latex-and-related-regexp nil
6173 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6175 (defun org-compute-latex-and-related-regexp ()
6176 "Compute regular expression for LaTeX, entities and sub/superscript.
6177 Result depends on variable `org-highlight-latex-and-related'."
6178 (org-set-local
6179 'org-latex-and-related-regexp
6180 (let* ((re-sub
6181 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6182 ((eq org-use-sub-superscripts '{})
6183 (list org-match-substring-with-braces-regexp))
6184 (org-use-sub-superscripts (list org-match-substring-regexp))))
6185 (re-latex
6186 (when (memq 'latex org-highlight-latex-and-related)
6187 (let ((matchers (plist-get org-format-latex-options :matchers)))
6188 (delq nil
6189 (mapcar (lambda (x)
6190 (and (member (car x) matchers) (nth 1 x)))
6191 org-latex-regexps)))))
6192 (re-entities
6193 (when (memq 'entities org-highlight-latex-and-related)
6194 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6195 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6197 (defun org-do-latex-and-related (limit)
6198 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6199 LIMIT bounds the search for syntax to highlight. Stop at first
6200 highlighted object, if any. Return t if some highlighting was
6201 done, nil otherwise."
6202 (when (org-string-nw-p org-latex-and-related-regexp)
6203 (catch 'found
6204 (while (re-search-forward org-latex-and-related-regexp limit t)
6205 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6206 'face))
6207 '(org-code org-verbatim underline))
6208 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6209 '(?_ ?^))
6211 0)))
6212 (font-lock-prepend-text-property
6213 (+ offset (match-beginning 0)) (match-end 0)
6214 'face 'org-latex-and-related)
6215 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6216 '(font-lock-multiline t)))
6217 (throw 'found t)))
6218 nil)))
6220 (defun org-restart-font-lock ()
6221 "Restart `font-lock-mode', to force refontification."
6222 (when (and (boundp 'font-lock-mode) font-lock-mode)
6223 (font-lock-mode -1)
6224 (font-lock-mode 1)))
6226 (defun org-activate-tags (limit)
6227 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6228 (progn
6229 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6230 (add-text-properties (match-beginning 1) (match-end 1)
6231 (list 'mouse-face 'highlight
6232 'keymap org-mouse-map))
6233 (org-rear-nonsticky-at (match-end 1))
6234 t)))
6236 (defun org-outline-level ()
6237 "Compute the outline level of the heading at point.
6238 If this is called at a normal headline, the level is the number of stars.
6239 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6240 (save-excursion
6241 (if (not (ignore-errors (org-back-to-heading t)))
6243 (looking-at org-outline-regexp)
6244 (1- (- (match-end 0) (match-beginning 0))))))
6246 (defvar org-font-lock-keywords nil)
6248 (defsubst org-re-property (property &optional literal allow-null)
6249 "Return a regexp matching a PROPERTY line.
6251 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6252 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6253 non-nil, match properties even without a value.
6255 Match group 3 is set to the value when it exists. If there is no
6256 value and ALLOW-NULL is non-nil, it is set to the empty string."
6257 (concat
6258 "^\\(?4:[ \t]*\\)"
6259 (format "\\(?1::\\(?2:%s\\):\\)"
6260 (if literal property (regexp-quote property)))
6261 (if allow-null
6262 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$"
6263 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$")))
6265 (defconst org-property-re
6266 (org-re-property "\\S-+" 'literal t)
6267 "Regular expression matching a property line.
6268 There are four matching groups:
6269 1: :PROPKEY: including the leading and trailing colon,
6270 2: PROPKEY without the leading and trailing colon,
6271 3: PROPVAL without leading or trailing spaces,
6272 4: the indentation of the current line,
6273 5: trailing whitespace.")
6275 (defvar org-font-lock-hook nil
6276 "Functions to be called for special font lock stuff.")
6278 (defvar org-font-lock-set-keywords-hook nil
6279 "Functions that can manipulate `org-font-lock-extra-keywords'.
6280 This is called after `org-font-lock-extra-keywords' is defined, but before
6281 it is installed to be used by font lock. This can be useful if something
6282 needs to be inserted at a specific position in the font-lock sequence.")
6284 (defun org-font-lock-hook (limit)
6285 "Run `org-font-lock-hook' within LIMIT."
6286 (run-hook-with-args 'org-font-lock-hook limit))
6288 (defun org-set-font-lock-defaults ()
6289 "Set font lock defaults for the current buffer."
6290 (let* ((em org-fontify-emphasized-text)
6291 (lk org-highlight-links)
6292 (org-font-lock-extra-keywords
6293 (list
6294 ;; Call the hook
6295 '(org-font-lock-hook)
6296 ;; Headlines
6297 `(,(if org-fontify-whole-heading-line
6298 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6299 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6300 (1 (org-get-level-face 1))
6301 (2 (org-get-level-face 2))
6302 (3 (org-get-level-face 3)))
6303 ;; Table lines
6304 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6305 (1 'org-table t))
6306 ;; Table internals
6307 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6308 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6309 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6310 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6311 ;; Drawers
6312 '(org-fontify-drawers)
6313 ;; Properties
6314 (list org-property-re
6315 '(1 'org-special-keyword t)
6316 '(3 'org-property-value t))
6317 ;; Links
6318 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6319 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6320 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6321 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6322 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6323 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6324 (if (memq 'footnote lk) '(org-activate-footnote-links))
6325 ;; Targets.
6326 (list org-any-target-regexp '(0 'org-target t))
6327 ;; Diary sexps.
6328 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6329 ;; Macro
6330 '(org-fontify-macros)
6331 '(org-hide-wide-columns (0 nil append))
6332 ;; TODO keyword
6333 (list (format org-heading-keyword-regexp-format
6334 org-todo-regexp)
6335 '(2 (org-get-todo-face 2) t))
6336 ;; DONE
6337 (if org-fontify-done-headline
6338 (list (format org-heading-keyword-regexp-format
6339 (concat
6340 "\\(?:"
6341 (mapconcat 'regexp-quote org-done-keywords "\\|")
6342 "\\)"))
6343 '(2 'org-headline-done t))
6344 nil)
6345 ;; Priorities
6346 '(org-font-lock-add-priority-faces)
6347 ;; Tags
6348 '(org-font-lock-add-tag-faces)
6349 ;; Tags groups
6350 (if (and org-group-tags org-tag-groups-alist)
6351 (list (concat org-outline-regexp-bol ".+\\(:"
6352 (regexp-opt (mapcar 'car org-tag-groups-alist))
6353 ":\\).*$")
6354 '(1 'org-tag-group prepend)))
6355 ;; Special keywords
6356 (list (concat "\\<" org-comment-string) '(0 'org-special-keyword t))
6357 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6358 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6359 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6360 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6361 ;; Emphasis
6362 (if em
6363 (if (featurep 'xemacs)
6364 '(org-do-emphasis-faces (0 nil append))
6365 '(org-do-emphasis-faces)))
6366 ;; Checkboxes
6367 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6368 1 'org-checkbox prepend)
6369 (if (cdr (assq 'checkbox org-list-automatic-rules))
6370 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6371 (0 (org-get-checkbox-statistics-face) t)))
6372 ;; Description list items
6373 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6374 1 'org-list-dt prepend)
6375 ;; ARCHIVEd headings
6376 (list (concat
6377 org-outline-regexp-bol
6378 "\\(.*:" org-archive-tag ":.*\\)")
6379 '(1 'org-archived prepend))
6380 ;; Specials
6381 '(org-do-latex-and-related)
6382 '(org-fontify-entities)
6383 '(org-raise-scripts)
6384 ;; Code
6385 '(org-activate-code (1 'org-code t))
6386 ;; COMMENT
6387 (list (format
6388 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6389 org-todo-regexp
6390 org-comment-string)
6391 '(9 'org-special-keyword t))
6392 ;; Blocks and meta lines
6393 '(org-fontify-meta-lines-and-blocks))))
6394 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6395 (run-hooks 'org-font-lock-set-keywords-hook)
6396 ;; Now set the full font-lock-keywords
6397 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6398 (org-set-local 'font-lock-defaults
6399 '(org-font-lock-keywords t nil nil backward-paragraph))
6400 (kill-local-variable 'font-lock-keywords) nil))
6402 (defun org-toggle-pretty-entities ()
6403 "Toggle the composition display of entities as UTF8 characters."
6404 (interactive)
6405 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6406 (org-restart-font-lock)
6407 (if org-pretty-entities
6408 (message "Entities are now displayed as UTF8 characters")
6409 (save-restriction
6410 (widen)
6411 (org-decompose-region (point-min) (point-max))
6412 (message "Entities are now displayed as plain text"))))
6414 (defvar org-custom-properties-overlays nil
6415 "List of overlays used for custom properties.")
6416 (make-variable-buffer-local 'org-custom-properties-overlays)
6418 (defun org-toggle-custom-properties-visibility ()
6419 "Display or hide properties in `org-custom-properties'."
6420 (interactive)
6421 (if org-custom-properties-overlays
6422 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6423 (setq org-custom-properties-overlays nil))
6424 (when org-custom-properties
6425 (org-with-wide-buffer
6426 (goto-char (point-min))
6427 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6428 (while (re-search-forward regexp nil t)
6429 (let ((end (cdr (save-match-data (org-get-property-block)))))
6430 (when (and end (< (point) end))
6431 ;; Hide first custom property in current drawer.
6432 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6433 (overlay-put o 'invisible t)
6434 (overlay-put o 'org-custom-property t)
6435 (push o org-custom-properties-overlays))
6436 ;; Hide additional custom properties in the same drawer.
6437 (while (re-search-forward regexp end t)
6438 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6439 (overlay-put o 'invisible t)
6440 (overlay-put o 'org-custom-property t)
6441 (push o org-custom-properties-overlays)))))
6442 ;; Each entry is limited to a single property drawer.
6443 (outline-next-heading)))))))
6445 (defun org-fontify-entities (limit)
6446 "Find an entity to fontify."
6447 (let (ee)
6448 (when org-pretty-entities
6449 (catch 'match
6450 (while (re-search-forward
6451 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6452 limit t)
6453 (if (and (not (org-at-comment-p))
6454 (setq ee (org-entity-get (match-string 1)))
6455 (= (length (nth 6 ee)) 1))
6456 (let*
6457 ((end (if (equal (match-string 2) "{}")
6458 (match-end 2)
6459 (match-end 1))))
6460 (add-text-properties
6461 (match-beginning 0) end
6462 (list 'font-lock-fontified t))
6463 (compose-region (match-beginning 0) end
6464 (nth 6 ee) nil)
6465 (backward-char 1)
6466 (throw 'match t))))
6467 nil))))
6469 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6470 "Fontify string S like in Org-mode."
6471 (with-temp-buffer
6472 (insert s)
6473 (let ((org-odd-levels-only odd-levels))
6474 (org-mode)
6475 (font-lock-ensure)
6476 (buffer-string))))
6478 (defvar org-m nil)
6479 (defvar org-l nil)
6480 (defvar org-f nil)
6481 (defun org-get-level-face (n)
6482 "Get the right face for match N in font-lock matching of headlines."
6483 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6484 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6485 (if org-cycle-level-faces
6486 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6487 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6488 (cond
6489 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6490 ((eq n 2) org-f)
6491 (t (if org-level-color-stars-only nil org-f))))
6494 (defun org-get-todo-face (kwd)
6495 "Get the right face for a TODO keyword KWD.
6496 If KWD is a number, get the corresponding match group."
6497 (if (numberp kwd) (setq kwd (match-string kwd)))
6498 (or (org-face-from-face-or-color
6499 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6500 (and (member kwd org-done-keywords) 'org-done)
6501 'org-todo))
6503 (defun org-face-from-face-or-color (context inherit face-or-color)
6504 "Create a face list that inherits INHERIT, but sets the foreground color.
6505 When FACE-OR-COLOR is not a string, just return it."
6506 (if (stringp face-or-color)
6507 (list :inherit inherit
6508 (cdr (assoc context org-faces-easy-properties))
6509 face-or-color)
6510 face-or-color))
6512 (defun org-font-lock-add-tag-faces (limit)
6513 "Add the special tag faces."
6514 (when (and org-tag-faces org-tags-special-faces-re)
6515 (while (re-search-forward org-tags-special-faces-re limit t)
6516 (add-text-properties (match-beginning 1) (match-end 1)
6517 (list 'face (org-get-tag-face 1)
6518 'font-lock-fontified t))
6519 (backward-char 1))))
6521 (defun org-font-lock-add-priority-faces (limit)
6522 "Add the special priority faces."
6523 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6524 (when (save-match-data (org-at-heading-p))
6525 (add-text-properties
6526 (match-beginning 0) (match-end 0)
6527 (list 'face (or (org-face-from-face-or-color
6528 'priority 'org-priority
6529 (cdr (assoc (char-after (match-beginning 1))
6530 org-priority-faces)))
6531 'org-priority)
6532 'font-lock-fontified t)))))
6534 (defun org-get-tag-face (kwd)
6535 "Get the right face for a TODO keyword KWD.
6536 If KWD is a number, get the corresponding match group."
6537 (if (numberp kwd) (setq kwd (match-string kwd)))
6538 (or (org-face-from-face-or-color
6539 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6540 'org-tag))
6542 (defun org-unfontify-region (beg end &optional maybe_loudly)
6543 "Remove fontification and activation overlays from links."
6544 (font-lock-default-unfontify-region beg end)
6545 (let* ((buffer-undo-list t)
6546 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6547 (inhibit-modification-hooks t)
6548 deactivate-mark buffer-file-name buffer-file-truename)
6549 (org-decompose-region beg end)
6550 (remove-text-properties beg end
6551 '(mouse-face t keymap t org-linked-text t
6552 invisible t intangible t
6553 org-emphasis t))
6554 (org-remove-font-lock-display-properties beg end)))
6556 (defconst org-script-display '(((raise -0.3) (height 0.7))
6557 ((raise 0.3) (height 0.7))
6558 ((raise -0.5))
6559 ((raise 0.5)))
6560 "Display properties for showing superscripts and subscripts.")
6562 (defun org-remove-font-lock-display-properties (beg end)
6563 "Remove specific display properties that have been added by font lock.
6564 The will remove the raise properties that are used to show superscripts
6565 and subscripts."
6566 (let (next prop)
6567 (while (< beg end)
6568 (setq next (next-single-property-change beg 'display nil end)
6569 prop (get-text-property beg 'display))
6570 (if (member prop org-script-display)
6571 (put-text-property beg next 'display nil))
6572 (setq beg next))))
6574 (defun org-raise-scripts (limit)
6575 "Add raise properties to sub/superscripts."
6576 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6577 (if (re-search-forward
6578 (if (eq org-use-sub-superscripts t)
6579 org-match-substring-regexp
6580 org-match-substring-with-braces-regexp)
6581 limit t)
6582 (let* ((pos (point)) table-p comment-p
6583 (mpos (match-beginning 3))
6584 (emph-p (get-text-property mpos 'org-emphasis))
6585 (link-p (get-text-property mpos 'mouse-face))
6586 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6587 (goto-char (point-at-bol))
6588 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6589 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6590 (goto-char pos)
6591 ;; Handle a_b^c
6592 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6593 (if (or comment-p emph-p link-p keyw-p)
6595 (put-text-property (match-beginning 3) (match-end 0)
6596 'display
6597 (if (equal (char-after (match-beginning 2)) ?^)
6598 (nth (if table-p 3 1) org-script-display)
6599 (nth (if table-p 2 0) org-script-display)))
6600 (add-text-properties (match-beginning 2) (match-end 2)
6601 (list 'invisible t
6602 'org-dwidth t 'org-dwidth-n 1))
6603 (if (and (eq (char-after (match-beginning 3)) ?{)
6604 (eq (char-before (match-end 3)) ?}))
6605 (progn
6606 (add-text-properties
6607 (match-beginning 3) (1+ (match-beginning 3))
6608 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6609 (add-text-properties
6610 (1- (match-end 3)) (match-end 3)
6611 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6612 t)))))
6614 ;;;; Visibility cycling, including org-goto and indirect buffer
6616 ;;; Cycling
6618 (defvar org-cycle-global-status nil)
6619 (make-variable-buffer-local 'org-cycle-global-status)
6620 (put 'org-cycle-global-status 'org-state t)
6621 (defvar org-cycle-subtree-status nil)
6622 (make-variable-buffer-local 'org-cycle-subtree-status)
6623 (put 'org-cycle-subtree-status 'org-state t)
6625 (defvar org-inlinetask-min-level)
6627 (defun org-unlogged-message (&rest args)
6628 "Display a message, but avoid logging it in the *Messages* buffer."
6629 (let ((message-log-max nil))
6630 (apply 'message args)))
6632 ;;;###autoload
6633 (defun org-cycle (&optional arg)
6634 "TAB-action and visibility cycling for Org-mode.
6636 This is the command invoked in Org-mode by the TAB key. Its main purpose
6637 is outline visibility cycling, but it also invokes other actions
6638 in special contexts.
6640 - When this function is called with a prefix argument, rotate the entire
6641 buffer through 3 states (global cycling)
6642 1. OVERVIEW: Show only top-level headlines.
6643 2. CONTENTS: Show all headlines of all levels, but no body text.
6644 3. SHOW ALL: Show everything.
6645 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6646 determined by the variable `org-startup-folded', and by any VISIBILITY
6647 properties in the buffer.
6648 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6649 including any drawers.
6651 - When inside a table, re-align the table and move to the next field.
6653 - When point is at the beginning of a headline, rotate the subtree started
6654 by this line through 3 different states (local cycling)
6655 1. FOLDED: Only the main headline is shown.
6656 2. CHILDREN: The main headline and the direct children are shown.
6657 From this state, you can move to one of the children
6658 and zoom in further.
6659 3. SUBTREE: Show the entire subtree, including body text.
6660 If there is no subtree, switch directly from CHILDREN to FOLDED.
6662 - When point is at the beginning of an empty headline and the variable
6663 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6664 of the headline by demoting and promoting it to likely levels. This
6665 speeds up creation document structure by pressing TAB once or several
6666 times right after creating a new headline.
6668 - When there is a numeric prefix, go up to a heading with level ARG, do
6669 a `show-subtree' and return to the previous cursor position. If ARG
6670 is negative, go up that many levels.
6672 - When point is not at the beginning of a headline, execute the global
6673 binding for TAB, which is re-indenting the line. See the option
6674 `org-cycle-emulate-tab' for details.
6676 - Special case: if point is at the beginning of the buffer and there is
6677 no headline in line 1, this function will act as if called with prefix arg
6678 (C-u TAB, same as S-TAB) also when called without prefix arg.
6679 But only if also the variable `org-cycle-global-at-bob' is t."
6680 (interactive "P")
6681 (org-load-modules-maybe)
6682 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6683 (and org-cycle-level-after-item/entry-creation
6684 (or (org-cycle-level)
6685 (org-cycle-item-indentation))))
6686 (let* ((limit-level
6687 (or org-cycle-max-level
6688 (and (boundp 'org-inlinetask-min-level)
6689 org-inlinetask-min-level
6690 (1- org-inlinetask-min-level))))
6691 (nstars (and limit-level
6692 (if org-odd-levels-only
6693 (and limit-level (1- (* limit-level 2)))
6694 limit-level)))
6695 (org-outline-regexp
6696 (if (not (derived-mode-p 'org-mode))
6697 outline-regexp
6698 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6699 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6700 (not (looking-at org-outline-regexp))))
6701 (org-cycle-hook
6702 (if bob-special
6703 (delq 'org-optimize-window-after-visibility-change
6704 (copy-sequence org-cycle-hook))
6705 org-cycle-hook))
6706 (pos (point)))
6708 (if (or bob-special (equal arg '(4)))
6709 ;; special case: use global cycling
6710 (setq arg t))
6712 (cond
6714 ((equal arg '(16))
6715 (setq last-command 'dummy)
6716 (org-set-startup-visibility)
6717 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6719 ((equal arg '(64))
6720 (show-all)
6721 (org-unlogged-message "Entire buffer visible, including drawers"))
6723 ;; Try cdlatex TAB completion
6724 ((org-try-cdlatex-tab))
6726 ;; Table: enter it or move to the next field.
6727 ((org-at-table-p 'any)
6728 (if (org-at-table.el-p)
6729 (message "Use C-c ' to edit table.el tables")
6730 (if arg (org-table-edit-field t)
6731 (org-table-justify-field-maybe)
6732 (call-interactively 'org-table-next-field))))
6734 ((run-hook-with-args-until-success
6735 'org-tab-after-check-for-table-hook))
6737 ;; Global cycling: delegate to `org-cycle-internal-global'.
6738 ((eq arg t) (org-cycle-internal-global))
6740 ;; Drawers: delegate to `org-flag-drawer'.
6741 ((save-excursion
6742 (beginning-of-line 1)
6743 (looking-at org-drawer-regexp))
6744 (org-flag-drawer ; toggle block visibility
6745 (not (get-char-property (match-end 0) 'invisible))))
6747 ;; Show-subtree, ARG levels up from here.
6748 ((integerp arg)
6749 (save-excursion
6750 (org-back-to-heading)
6751 (outline-up-heading (if (< arg 0) (- arg)
6752 (- (funcall outline-level) arg)))
6753 (org-show-subtree)))
6755 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6756 ((and (featurep 'org-inlinetask)
6757 (org-inlinetask-at-task-p)
6758 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6759 (org-inlinetask-toggle-visibility))
6761 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6762 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6763 (save-excursion (beginning-of-line 1)
6764 (looking-at org-outline-regexp)))
6765 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6766 (org-cycle-internal-local))
6768 ;; From there: TAB emulation and template completion.
6769 (buffer-read-only (org-back-to-heading))
6771 ((run-hook-with-args-until-success
6772 'org-tab-after-check-for-cycling-hook))
6774 ((org-try-structure-completion))
6776 ((run-hook-with-args-until-success
6777 'org-tab-before-tab-emulation-hook))
6779 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6780 (or (not (bolp))
6781 (not (looking-at org-outline-regexp))))
6782 (call-interactively (global-key-binding "\t")))
6784 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6785 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6786 (or (and (eq org-cycle-emulate-tab 'white)
6787 (= (match-end 0) (point-at-eol)))
6788 (and (eq org-cycle-emulate-tab 'whitestart)
6789 (>= (match-end 0) pos))))
6791 (eq org-cycle-emulate-tab t))
6792 (call-interactively (global-key-binding "\t")))
6794 (t (save-excursion
6795 (org-back-to-heading)
6796 (org-cycle)))))))
6798 (defun org-cycle-internal-global ()
6799 "Do the global cycling action."
6800 ;; Hack to avoid display of messages for .org attachments in Gnus
6801 (let ((ga (string-match "\\*fontification" (buffer-name))))
6802 (cond
6803 ((and (eq last-command this-command)
6804 (eq org-cycle-global-status 'overview))
6805 ;; We just created the overview - now do table of contents
6806 ;; This can be slow in very large buffers, so indicate action
6807 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6808 (unless ga (org-unlogged-message "CONTENTS..."))
6809 (org-content)
6810 (unless ga (org-unlogged-message "CONTENTS...done"))
6811 (setq org-cycle-global-status 'contents)
6812 (run-hook-with-args 'org-cycle-hook 'contents))
6814 ((and (eq last-command this-command)
6815 (eq org-cycle-global-status 'contents))
6816 ;; We just showed the table of contents - now show everything
6817 (run-hook-with-args 'org-pre-cycle-hook 'all)
6818 (show-all)
6819 (unless ga (org-unlogged-message "SHOW ALL"))
6820 (setq org-cycle-global-status 'all)
6821 (run-hook-with-args 'org-cycle-hook 'all))
6824 ;; Default action: go to overview
6825 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6826 (org-overview)
6827 (unless ga (org-unlogged-message "OVERVIEW"))
6828 (setq org-cycle-global-status 'overview)
6829 (run-hook-with-args 'org-cycle-hook 'overview)))))
6831 (defvar org-called-with-limited-levels nil
6832 "Non-nil when `org-with-limited-levels' is currently active.")
6834 (defun org-cycle-internal-local ()
6835 "Do the local cycling action."
6836 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6837 ;; First, determine end of headline (EOH), end of subtree or item
6838 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6839 (save-excursion
6840 (if (org-at-item-p)
6841 (progn
6842 (beginning-of-line)
6843 (setq struct (org-list-struct))
6844 (setq eoh (point-at-eol))
6845 (setq eos (org-list-get-item-end-before-blank (point) struct))
6846 (setq has-children (org-list-has-child-p (point) struct)))
6847 (org-back-to-heading)
6848 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6849 (setq eos (save-excursion (org-end-of-subtree t t)
6850 (when (bolp) (backward-char)) (point)))
6851 (setq has-children
6852 (or (save-excursion
6853 (let ((level (funcall outline-level)))
6854 (outline-next-heading)
6855 (and (org-at-heading-p t)
6856 (> (funcall outline-level) level))))
6857 (save-excursion
6858 (org-list-search-forward (org-item-beginning-re) eos t)))))
6859 ;; Determine end invisible part of buffer (EOL)
6860 (beginning-of-line 2)
6861 ;; XEmacs doesn't have `next-single-char-property-change'
6862 (if (featurep 'xemacs)
6863 (while (and (not (eobp)) ;; this is like `next-line'
6864 (get-char-property (1- (point)) 'invisible))
6865 (beginning-of-line 2))
6866 (while (and (not (eobp)) ;; this is like `next-line'
6867 (get-char-property (1- (point)) 'invisible))
6868 (goto-char (next-single-char-property-change (point) 'invisible))
6869 (and (eolp) (beginning-of-line 2))))
6870 (setq eol (point)))
6871 ;; Find out what to do next and set `this-command'
6872 (cond
6873 ((= eos eoh)
6874 ;; Nothing is hidden behind this heading
6875 (unless (org-before-first-heading-p)
6876 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6877 (org-unlogged-message "EMPTY ENTRY")
6878 (setq org-cycle-subtree-status nil)
6879 (save-excursion
6880 (goto-char eos)
6881 (outline-next-heading)
6882 (if (outline-invisible-p) (org-flag-heading nil))))
6883 ((and (or (>= eol eos)
6884 (not (string-match "\\S-" (buffer-substring eol eos))))
6885 (or has-children
6886 (not (setq children-skipped
6887 org-cycle-skip-children-state-if-no-children))))
6888 ;; Entire subtree is hidden in one line: children view
6889 (unless (org-before-first-heading-p)
6890 (run-hook-with-args 'org-pre-cycle-hook 'children))
6891 (if (org-at-item-p)
6892 (org-list-set-item-visibility (point-at-bol) struct 'children)
6893 (org-show-entry)
6894 (org-with-limited-levels (show-children))
6895 ;; FIXME: This slows down the func way too much.
6896 ;; How keep drawers hidden in subtree anyway?
6897 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6898 ;; (org-cycle-hide-drawers 'subtree))
6900 ;; Fold every list in subtree to top-level items.
6901 (when (eq org-cycle-include-plain-lists 'integrate)
6902 (save-excursion
6903 (org-back-to-heading)
6904 (while (org-list-search-forward (org-item-beginning-re) eos t)
6905 (beginning-of-line 1)
6906 (let* ((struct (org-list-struct))
6907 (prevs (org-list-prevs-alist struct))
6908 (end (org-list-get-bottom-point struct)))
6909 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6910 (org-list-get-all-items (point) struct prevs))
6911 (goto-char (if (< end eos) end eos)))))))
6912 (org-unlogged-message "CHILDREN")
6913 (save-excursion
6914 (goto-char eos)
6915 (outline-next-heading)
6916 (if (outline-invisible-p) (org-flag-heading nil)))
6917 (setq org-cycle-subtree-status 'children)
6918 (unless (org-before-first-heading-p)
6919 (run-hook-with-args 'org-cycle-hook 'children)))
6920 ((or children-skipped
6921 (and (eq last-command this-command)
6922 (eq org-cycle-subtree-status 'children)))
6923 ;; We just showed the children, or no children are there,
6924 ;; now show everything.
6925 (unless (org-before-first-heading-p)
6926 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6927 (outline-flag-region eoh eos nil)
6928 (org-unlogged-message
6929 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6930 (setq org-cycle-subtree-status 'subtree)
6931 (unless (org-before-first-heading-p)
6932 (run-hook-with-args 'org-cycle-hook 'subtree)))
6934 ;; Default action: hide the subtree.
6935 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6936 (outline-flag-region eoh eos t)
6937 (org-unlogged-message "FOLDED")
6938 (setq org-cycle-subtree-status 'folded)
6939 (unless (org-before-first-heading-p)
6940 (run-hook-with-args 'org-cycle-hook 'folded))))))
6942 ;;;###autoload
6943 (defun org-global-cycle (&optional arg)
6944 "Cycle the global visibility. For details see `org-cycle'.
6945 With \\[universal-argument] prefix arg, switch to startup visibility.
6946 With a numeric prefix, show all headlines up to that level."
6947 (interactive "P")
6948 (let ((org-cycle-include-plain-lists
6949 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6950 (cond
6951 ((integerp arg)
6952 (show-all)
6953 (hide-sublevels arg)
6954 (setq org-cycle-global-status 'contents))
6955 ((equal arg '(4))
6956 (org-set-startup-visibility)
6957 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6959 (org-cycle '(4))))))
6961 (defun org-set-startup-visibility ()
6962 "Set the visibility required by startup options and properties."
6963 (cond
6964 ((eq org-startup-folded t)
6965 (org-overview))
6966 ((eq org-startup-folded 'content)
6967 (org-content))
6968 ((or (eq org-startup-folded 'showeverything)
6969 (eq org-startup-folded nil))
6970 (show-all)))
6971 (unless (eq org-startup-folded 'showeverything)
6972 (if org-hide-block-startup (org-hide-block-all))
6973 (org-set-visibility-according-to-property 'no-cleanup)
6974 (org-cycle-hide-archived-subtrees 'all)
6975 (org-cycle-hide-drawers 'all)
6976 (org-cycle-show-empty-lines t)))
6978 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6979 "Switch subtree visibilities according to :VISIBILITY: property."
6980 (interactive)
6981 (let (org-show-entry-below state)
6982 (save-excursion
6983 (goto-char (point-min))
6984 (while (re-search-forward
6985 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6986 nil t)
6987 (setq state (match-string 1))
6988 (save-excursion
6989 (org-back-to-heading t)
6990 (hide-subtree)
6991 (org-reveal)
6992 (cond
6993 ((equal state '("fold" "folded"))
6994 (hide-subtree))
6995 ((equal state "children")
6996 (org-show-hidden-entry)
6997 (show-children))
6998 ((equal state "content")
6999 (save-excursion
7000 (save-restriction
7001 (org-narrow-to-subtree)
7002 (org-content))))
7003 ((member state '("all" "showall"))
7004 (show-subtree)))))
7005 (unless no-cleanup
7006 (org-cycle-hide-archived-subtrees 'all)
7007 (org-cycle-hide-drawers 'all)
7008 (org-cycle-show-empty-lines 'all)))))
7010 ;; This function uses outline-regexp instead of the more fundamental
7011 ;; org-outline-regexp so that org-cycle-global works outside of Org
7012 ;; buffers, where outline-regexp is needed.
7013 (defun org-overview ()
7014 "Switch to overview mode, showing only top-level headlines.
7015 This shows all headlines with a level equal or greater than the level
7016 of the first headline in the buffer. This is important, because if the
7017 first headline is not level one, then (hide-sublevels 1) gives confusing
7018 results."
7019 (interactive)
7020 (save-excursion
7021 (let ((level
7022 (save-excursion
7023 (goto-char (point-min))
7024 (if (re-search-forward (concat "^" outline-regexp) nil t)
7025 (progn
7026 (goto-char (match-beginning 0))
7027 (funcall outline-level))))))
7028 (and level (hide-sublevels level)))))
7030 (defun org-content (&optional arg)
7031 "Show all headlines in the buffer, like a table of contents.
7032 With numerical argument N, show content up to level N."
7033 (interactive "P")
7034 (org-overview)
7035 (save-excursion
7036 ;; Visit all headings and show their offspring
7037 (and (integerp arg) (org-overview))
7038 (goto-char (point-max))
7039 (catch 'exit
7040 (while (and (progn (condition-case nil
7041 (outline-previous-visible-heading 1)
7042 (error (goto-char (point-min))))
7044 (looking-at org-outline-regexp))
7045 (if (integerp arg)
7046 (show-children (1- arg))
7047 (show-branches))
7048 (if (bobp) (throw 'exit nil))))))
7050 (defun org-optimize-window-after-visibility-change (state)
7051 "Adjust the window after a change in outline visibility.
7052 This function is the default value of the hook `org-cycle-hook'."
7053 (when (get-buffer-window (current-buffer))
7054 (cond
7055 ((eq state 'content) nil)
7056 ((eq state 'all) nil)
7057 ((eq state 'folded) nil)
7058 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7059 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7061 (defun org-remove-empty-overlays-at (pos)
7062 "Remove outline overlays that do not contain non-white stuff."
7063 (mapc
7064 (lambda (o)
7065 (and (eq 'outline (overlay-get o 'invisible))
7066 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7067 (overlay-end o))))
7068 (delete-overlay o)))
7069 (overlays-at pos)))
7071 (defun org-clean-visibility-after-subtree-move ()
7072 "Fix visibility issues after moving a subtree."
7073 ;; First, find a reasonable region to look at:
7074 ;; Start two siblings above, end three below
7075 (let* ((beg (save-excursion
7076 (and (org-get-last-sibling)
7077 (org-get-last-sibling))
7078 (point)))
7079 (end (save-excursion
7080 (and (org-get-next-sibling)
7081 (org-get-next-sibling)
7082 (org-get-next-sibling))
7083 (if (org-at-heading-p)
7084 (point-at-eol)
7085 (point))))
7086 (level (looking-at "\\*+"))
7087 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7088 (save-excursion
7089 (save-restriction
7090 (narrow-to-region beg end)
7091 (when re
7092 ;; Properly fold already folded siblings
7093 (goto-char (point-min))
7094 (while (re-search-forward re nil t)
7095 (if (and (not (outline-invisible-p))
7096 (save-excursion
7097 (goto-char (point-at-eol)) (outline-invisible-p)))
7098 (hide-entry))))
7099 (org-cycle-show-empty-lines 'overview)
7100 (org-cycle-hide-drawers 'overview)))))
7102 (defun org-cycle-show-empty-lines (state)
7103 "Show empty lines above all visible headlines.
7104 The region to be covered depends on STATE when called through
7105 `org-cycle-hook'. Lisp program can use t for STATE to get the
7106 entire buffer covered. Note that an empty line is only shown if there
7107 are at least `org-cycle-separator-lines' empty lines before the headline."
7108 (when (not (= org-cycle-separator-lines 0))
7109 (save-excursion
7110 (let* ((n (abs org-cycle-separator-lines))
7111 (re (cond
7112 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7113 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7114 (t (let ((ns (number-to-string (- n 2))))
7115 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7116 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7117 beg end b e)
7118 (cond
7119 ((memq state '(overview contents t))
7120 (setq beg (point-min) end (point-max)))
7121 ((memq state '(children folded))
7122 (setq beg (point) end (progn (org-end-of-subtree t t)
7123 (beginning-of-line 2)
7124 (point)))))
7125 (when beg
7126 (goto-char beg)
7127 (while (re-search-forward re end t)
7128 (unless (get-char-property (match-end 1) 'invisible)
7129 (setq e (match-end 1))
7130 (if (< org-cycle-separator-lines 0)
7131 (setq b (save-excursion
7132 (goto-char (match-beginning 0))
7133 (org-back-over-empty-lines)
7134 (if (save-excursion
7135 (goto-char (max (point-min) (1- (point))))
7136 (org-at-heading-p))
7137 (1- (point))
7138 (point))))
7139 (setq b (match-beginning 1)))
7140 (outline-flag-region b e nil)))))))
7141 ;; Never hide empty lines at the end of the file.
7142 (save-excursion
7143 (goto-char (point-max))
7144 (outline-previous-heading)
7145 (outline-end-of-heading)
7146 (if (and (looking-at "[ \t\n]+")
7147 (= (match-end 0) (point-max)))
7148 (outline-flag-region (point) (match-end 0) nil))))
7150 (defun org-show-empty-lines-in-parent ()
7151 "Move to the parent and re-show empty lines before visible headlines."
7152 (save-excursion
7153 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7154 (org-cycle-show-empty-lines context))))
7156 (defun org-files-list ()
7157 "Return `org-agenda-files' list, plus all open org-mode files.
7158 This is useful for operations that need to scan all of a user's
7159 open and agenda-wise Org files."
7160 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7161 (dolist (buf (buffer-list))
7162 (with-current-buffer buf
7163 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7164 (let ((file (expand-file-name (buffer-file-name))))
7165 (unless (member file files)
7166 (push file files))))))
7167 files))
7169 (defsubst org-entry-beginning-position ()
7170 "Return the beginning position of the current entry."
7171 (save-excursion (outline-back-to-heading t) (point)))
7173 (defsubst org-entry-end-position ()
7174 "Return the end position of the current entry."
7175 (save-excursion (outline-next-heading) (point)))
7177 (defun org-cycle-hide-drawers (state &optional exceptions)
7178 "Re-hide all drawers after a visibility state change.
7179 When non-nil, optional argument EXCEPTIONS is a list of strings
7180 specifying which drawers should not be hidden."
7181 (when (and (derived-mode-p 'org-mode)
7182 (not (memq state '(overview folded contents))))
7183 (save-excursion
7184 (let* ((globalp (memq state '(contents all)))
7185 (beg (if globalp (point-min) (point)))
7186 (end (if globalp (point-max)
7187 (if (eq state 'children)
7188 (save-excursion (outline-next-heading) (point))
7189 (org-end-of-subtree t)))))
7190 (goto-char beg)
7191 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7192 (unless (member-ignore-case (match-string 1) exceptions)
7193 (let ((drawer (org-element-at-point)))
7194 (when (memq (org-element-type drawer) '(drawer property-drawer))
7195 (org-flag-drawer t drawer)
7196 ;; Make sure to skip drawer entirely or we might flag
7197 ;; it another time when matching its ending line with
7198 ;; `org-drawer-regexp'.
7199 (goto-char (org-element-property :end drawer))))))))))
7201 (defun org-cycle-hide-inline-tasks (state)
7202 "Re-hide inline tasks when switching to 'contents or 'children
7203 visibility state."
7204 (case state
7205 (contents
7206 (when (org-bound-and-true-p org-inlinetask-min-level)
7207 (hide-sublevels (1- org-inlinetask-min-level))))
7208 (children
7209 (when (featurep 'org-inlinetask)
7210 (save-excursion
7211 (while (and (outline-next-heading)
7212 (org-inlinetask-at-task-p))
7213 (org-inlinetask-toggle-visibility)
7214 (org-inlinetask-goto-end)))))))
7216 (defun org-flag-drawer (flag &optional element)
7217 "When FLAG is non-nil, hide the drawer we are at.
7218 Otherwise make it visible. When optional argument ELEMENT is
7219 a parsed drawer, as returned by `org-element-at-point', hide or
7220 show that drawer instead."
7221 (when (save-excursion
7222 (beginning-of-line)
7223 (org-looking-at-p org-drawer-regexp))
7224 (let ((drawer (or element (org-element-at-point))))
7225 (when (memq (org-element-type drawer) '(drawer property-drawer))
7226 (let ((post (org-element-property :post-affiliated drawer)))
7227 (save-excursion
7228 (outline-flag-region
7229 (progn (goto-char post) (line-end-position))
7230 (progn (goto-char (org-element-property :end drawer))
7231 (skip-chars-backward " \r\t\n")
7232 (line-end-position))
7233 flag))
7234 ;; When the drawer is hidden away, make sure point lies in
7235 ;; a visible part of the buffer.
7236 (when (and flag (> (line-beginning-position) post))
7237 (goto-char post)))))))
7239 (defun org-subtree-end-visible-p ()
7240 "Is the end of the current subtree visible?"
7241 (pos-visible-in-window-p
7242 (save-excursion (org-end-of-subtree t) (point))))
7244 (defun org-first-headline-recenter ()
7245 "Move cursor to the first headline and recenter the headline."
7246 (goto-char (point-min))
7247 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7248 (set-window-start (selected-window) (point-at-bol))))
7250 ;;; Saving and restoring visibility
7252 (defun org-outline-overlay-data (&optional use-markers)
7253 "Return a list of the locations of all outline overlays.
7254 These are overlays with the `invisible' property value `outline'.
7255 The return value is a list of cons cells, with start and stop
7256 positions for each overlay.
7257 If USE-MARKERS is set, return the positions as markers."
7258 (let (beg end)
7259 (save-excursion
7260 (save-restriction
7261 (widen)
7262 (delq nil
7263 (mapcar (lambda (o)
7264 (when (eq (overlay-get o 'invisible) 'outline)
7265 (setq beg (overlay-start o)
7266 end (overlay-end o))
7267 (and beg end (> end beg)
7268 (if use-markers
7269 (cons (copy-marker beg)
7270 (copy-marker end t))
7271 (cons beg end)))))
7272 (overlays-in (point-min) (point-max))))))))
7274 (defun org-set-outline-overlay-data (data)
7275 "Create visibility overlays for all positions in DATA.
7276 DATA should have been made by `org-outline-overlay-data'."
7277 (let (o)
7278 (save-excursion
7279 (save-restriction
7280 (widen)
7281 (show-all)
7282 (mapc (lambda (c)
7283 (outline-flag-region (car c) (cdr c) t))
7284 data)))))
7286 ;;; Folding of blocks
7288 (defvar org-hide-block-overlays nil
7289 "Overlays hiding blocks.")
7290 (make-variable-buffer-local 'org-hide-block-overlays)
7292 (defun org-block-map (function &optional start end)
7293 "Call FUNCTION at the head of all source blocks in the current buffer.
7294 Optional arguments START and END can be used to limit the range."
7295 (let ((start (or start (point-min)))
7296 (end (or end (point-max))))
7297 (save-excursion
7298 (goto-char start)
7299 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7300 (save-excursion
7301 (save-match-data
7302 (goto-char (match-beginning 0))
7303 (funcall function)))))))
7305 (defun org-hide-block-toggle-all ()
7306 "Toggle the visibility of all blocks in the current buffer."
7307 (org-block-map 'org-hide-block-toggle))
7309 (defun org-hide-block-all ()
7310 "Fold all blocks in the current buffer."
7311 (interactive)
7312 (org-show-block-all)
7313 (org-block-map 'org-hide-block-toggle-maybe))
7315 (defun org-show-block-all ()
7316 "Unfold all blocks in the current buffer."
7317 (interactive)
7318 (mapc 'delete-overlay org-hide-block-overlays)
7319 (setq org-hide-block-overlays nil))
7321 (defun org-hide-block-toggle-maybe ()
7322 "Toggle visibility of block at point.
7323 Unlike to `org-hide-block-toggle', this function does not throw
7324 an error. Return a non-nil value when toggling is successful."
7325 (interactive)
7326 (ignore-errors (org-hide-block-toggle)))
7328 (defun org-hide-block-toggle (&optional force)
7329 "Toggle the visibility of the current block.
7330 When optional argument FORCE is `off', make block visible. If it
7331 is non-nil, hide it unconditionally. Throw an error when not at
7332 a block. Return a non-nil value when toggling is successful."
7333 (interactive)
7334 (let ((element (org-element-at-point)))
7335 (unless (memq (org-element-type element)
7336 '(center-block comment-block dynamic-block example-block
7337 export-block quote-block special-block
7338 src-block verse-block))
7339 (user-error "Not at a block"))
7340 (let* ((start (save-excursion
7341 (goto-char (org-element-property :post-affiliated element))
7342 (line-end-position)))
7343 (end (save-excursion
7344 (goto-char (org-element-property :end element))
7345 (skip-chars-backward " \r\t\n")
7346 (line-end-position)))
7347 (overlays (overlays-at start)))
7348 (cond
7349 ;; Do nothing when not before or at the block opening line or
7350 ;; at the block closing line.
7351 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7352 ((and (not (eq force 'off))
7353 (not (memq t (mapcar
7354 (lambda (o)
7355 (eq (overlay-get o 'invisible) 'org-hide-block))
7356 overlays))))
7357 (let ((ov (make-overlay start end)))
7358 (overlay-put ov 'invisible 'org-hide-block)
7359 ;; Make the block accessible to `isearch'.
7360 (overlay-put
7361 ov 'isearch-open-invisible
7362 (lambda (ov)
7363 (when (memq ov org-hide-block-overlays)
7364 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7365 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7366 (delete-overlay ov))))
7367 (push ov org-hide-block-overlays)
7368 ;; When the block is hidden away, make sure point is left in
7369 ;; a visible part of the buffer.
7370 (when (> (line-beginning-position) start)
7371 (goto-char start)
7372 (beginning-of-line))
7373 ;; Signal successful toggling.
7375 ((or (not force) (eq force 'off))
7376 (dolist (ov overlays t)
7377 (when (memq ov org-hide-block-overlays)
7378 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7379 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7380 (delete-overlay ov))))))))
7382 ;; org-tab-after-check-for-cycling-hook
7383 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7384 ;; Remove overlays when changing major mode
7385 (add-hook 'org-mode-hook
7386 (lambda () (org-add-hook 'change-major-mode-hook
7387 'org-show-block-all 'append 'local)))
7389 ;;; Org-goto
7391 (defvar org-goto-window-configuration nil)
7392 (defvar org-goto-marker nil)
7393 (defvar org-goto-map)
7394 (defun org-goto-map ()
7395 "Set the keymap `org-goto'."
7396 (setq org-goto-map
7397 (let ((map (make-sparse-keymap)))
7398 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7399 mouse-drag-region universal-argument org-occur))
7400 cmd)
7401 (while (setq cmd (pop cmds))
7402 (substitute-key-definition cmd cmd map global-map)))
7403 (suppress-keymap map)
7404 (org-defkey map "\C-m" 'org-goto-ret)
7405 (org-defkey map [(return)] 'org-goto-ret)
7406 (org-defkey map [(left)] 'org-goto-left)
7407 (org-defkey map [(right)] 'org-goto-right)
7408 (org-defkey map [(control ?g)] 'org-goto-quit)
7409 (org-defkey map "\C-i" 'org-cycle)
7410 (org-defkey map [(tab)] 'org-cycle)
7411 (org-defkey map [(down)] 'outline-next-visible-heading)
7412 (org-defkey map [(up)] 'outline-previous-visible-heading)
7413 (if org-goto-auto-isearch
7414 (if (fboundp 'define-key-after)
7415 (define-key-after map [t] 'org-goto-local-auto-isearch)
7416 nil)
7417 (org-defkey map "q" 'org-goto-quit)
7418 (org-defkey map "n" 'outline-next-visible-heading)
7419 (org-defkey map "p" 'outline-previous-visible-heading)
7420 (org-defkey map "f" 'outline-forward-same-level)
7421 (org-defkey map "b" 'outline-backward-same-level)
7422 (org-defkey map "u" 'outline-up-heading))
7423 (org-defkey map "/" 'org-occur)
7424 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7425 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7426 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7427 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7428 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7429 map)))
7431 (defconst org-goto-help
7432 "Browse buffer copy, to find location or copy text.%s
7433 RET=jump to location C-g=quit and return to previous location
7434 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7436 (defvar org-goto-start-pos) ; dynamically scoped parameter
7438 (defun org-goto (&optional alternative-interface)
7439 "Look up a different location in the current file, keeping current visibility.
7441 When you want look-up or go to a different location in a
7442 document, the fastest way is often to fold the entire buffer and
7443 then dive into the tree. This method has the disadvantage, that
7444 the previous location will be folded, which may not be what you
7445 want.
7447 This command works around this by showing a copy of the current
7448 buffer in an indirect buffer, in overview mode. You can dive
7449 into the tree in that copy, use org-occur and incremental search
7450 to find a location. When pressing RET or `Q', the command
7451 returns to the original buffer in which the visibility is still
7452 unchanged. After RET it will also jump to the location selected
7453 in the indirect buffer and expose the headline hierarchy above.
7455 With a prefix argument, use the alternative interface: e.g. if
7456 `org-goto-interface' is 'outline use 'outline-path-completion."
7457 (interactive "P")
7458 (org-goto-map)
7459 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7460 (org-refile-use-outline-path t)
7461 (org-refile-target-verify-function nil)
7462 (interface
7463 (if (not alternative-interface)
7464 org-goto-interface
7465 (if (eq org-goto-interface 'outline)
7466 'outline-path-completion
7467 'outline)))
7468 (org-goto-start-pos (point))
7469 (selected-point
7470 (if (eq interface 'outline)
7471 (car (org-get-location (current-buffer) org-goto-help))
7472 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7473 (org-refile-check-position pa)
7474 (nth 3 pa)))))
7475 (if selected-point
7476 (progn
7477 (org-mark-ring-push org-goto-start-pos)
7478 (goto-char selected-point)
7479 (if (or (outline-invisible-p) (org-invisible-p2))
7480 (org-show-context 'org-goto)))
7481 (message "Quit"))))
7483 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7484 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7485 (defvar org-goto-local-auto-isearch-map) ; defined below
7487 (defun org-get-location (buf help)
7488 "Let the user select a location in the Org-mode buffer BUF.
7489 This function uses a recursive edit. It returns the selected position
7490 or nil."
7491 (org-no-popups
7492 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7493 (isearch-hide-immediately nil)
7494 (isearch-search-fun-function
7495 (lambda () 'org-goto-local-search-headings))
7496 (org-goto-selected-point org-goto-exit-command))
7497 (save-excursion
7498 (save-window-excursion
7499 (delete-other-windows)
7500 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7501 (org-pop-to-buffer-same-window
7502 (condition-case nil
7503 (make-indirect-buffer (current-buffer) "*org-goto*")
7504 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7505 (with-output-to-temp-buffer "*Org Help*"
7506 (princ (format help (if org-goto-auto-isearch
7507 " Just type for auto-isearch."
7508 " n/p/f/b/u to navigate, q to quit."))))
7509 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7510 (setq buffer-read-only nil)
7511 (let ((org-startup-truncated t)
7512 (org-startup-folded nil)
7513 (org-startup-align-all-tables nil))
7514 (org-mode)
7515 (org-overview))
7516 (setq buffer-read-only t)
7517 (if (and (boundp 'org-goto-start-pos)
7518 (integer-or-marker-p org-goto-start-pos))
7519 (let ((org-show-hierarchy-above t)
7520 (org-show-siblings t)
7521 (org-show-following-heading t))
7522 (goto-char org-goto-start-pos)
7523 (and (outline-invisible-p) (org-show-context)))
7524 (goto-char (point-min)))
7525 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7526 (message "Select location and press RET")
7527 (use-local-map org-goto-map)
7528 (recursive-edit)))
7529 (kill-buffer "*org-goto*")
7530 (cons org-goto-selected-point org-goto-exit-command))))
7532 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7533 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7534 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7535 (if (fboundp 'isearch-other-control-char)
7536 (progn
7537 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7538 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7539 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7540 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7541 (define-key org-goto-local-auto-isearch-map [return] nil))
7543 (defun org-goto-local-search-headings (string bound noerror)
7544 "Search and make sure that any matches are in headlines."
7545 (catch 'return
7546 (while (if isearch-forward
7547 (search-forward string bound noerror)
7548 (search-backward string bound noerror))
7549 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7550 (and (member :headline context)
7551 (not (member :tags context))))
7552 (throw 'return (point))))))
7554 (defun org-goto-local-auto-isearch ()
7555 "Start isearch."
7556 (interactive)
7557 (goto-char (point-min))
7558 (let ((keys (this-command-keys)))
7559 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7560 (isearch-mode t)
7561 (isearch-process-search-char (string-to-char keys)))))
7563 (defun org-goto-ret (&optional arg)
7564 "Finish `org-goto' by going to the new location."
7565 (interactive "P")
7566 (setq org-goto-selected-point (point)
7567 org-goto-exit-command 'return)
7568 (throw 'exit nil))
7570 (defun org-goto-left ()
7571 "Finish `org-goto' by going to the new location."
7572 (interactive)
7573 (if (org-at-heading-p)
7574 (progn
7575 (beginning-of-line 1)
7576 (setq org-goto-selected-point (point)
7577 org-goto-exit-command 'left)
7578 (throw 'exit nil))
7579 (user-error "Not on a heading")))
7581 (defun org-goto-right ()
7582 "Finish `org-goto' by going to the new location."
7583 (interactive)
7584 (if (org-at-heading-p)
7585 (progn
7586 (setq org-goto-selected-point (point)
7587 org-goto-exit-command 'right)
7588 (throw 'exit nil))
7589 (user-error "Not on a heading")))
7591 (defun org-goto-quit ()
7592 "Finish `org-goto' without cursor motion."
7593 (interactive)
7594 (setq org-goto-selected-point nil)
7595 (setq org-goto-exit-command 'quit)
7596 (throw 'exit nil))
7598 ;;; Indirect buffer display of subtrees
7600 (defvar org-indirect-dedicated-frame nil
7601 "This is the frame being used for indirect tree display.")
7602 (defvar org-last-indirect-buffer nil)
7604 (defun org-tree-to-indirect-buffer (&optional arg)
7605 "Create indirect buffer and narrow it to current subtree.
7606 With a numerical prefix ARG, go up to this level and then take that tree.
7607 If ARG is negative, go up that many levels.
7609 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7610 indirect buffer previously made with this command, to avoid proliferation of
7611 indirect buffers. However, when you call the command with a \
7612 \\[universal-argument] prefix, or
7613 when `org-indirect-buffer-display' is `new-frame', the last buffer
7614 is kept so that you can work with several indirect buffers at the same time.
7615 If `org-indirect-buffer-display' is `dedicated-frame', the \
7616 \\[universal-argument] prefix also
7617 requests that a new frame be made for the new buffer, so that the dedicated
7618 frame is not changed."
7619 (interactive "P")
7620 (let ((cbuf (current-buffer))
7621 (cwin (selected-window))
7622 (pos (point))
7623 beg end level heading ibuf)
7624 (save-excursion
7625 (org-back-to-heading t)
7626 (when (numberp arg)
7627 (setq level (org-outline-level))
7628 (if (< arg 0) (setq arg (+ level arg)))
7629 (while (> (setq level (org-outline-level)) arg)
7630 (org-up-heading-safe)))
7631 (setq beg (point)
7632 heading (org-get-heading))
7633 (org-end-of-subtree t t)
7634 (if (org-at-heading-p) (backward-char 1))
7635 (setq end (point)))
7636 (if (and (buffer-live-p org-last-indirect-buffer)
7637 (not (eq org-indirect-buffer-display 'new-frame))
7638 (not arg))
7639 (kill-buffer org-last-indirect-buffer))
7640 (setq ibuf (org-get-indirect-buffer cbuf heading)
7641 org-last-indirect-buffer ibuf)
7642 (cond
7643 ((or (eq org-indirect-buffer-display 'new-frame)
7644 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7645 (select-frame (make-frame))
7646 (delete-other-windows)
7647 (org-pop-to-buffer-same-window ibuf)
7648 (org-set-frame-title heading))
7649 ((eq org-indirect-buffer-display 'dedicated-frame)
7650 (raise-frame
7651 (select-frame (or (and org-indirect-dedicated-frame
7652 (frame-live-p org-indirect-dedicated-frame)
7653 org-indirect-dedicated-frame)
7654 (setq org-indirect-dedicated-frame (make-frame)))))
7655 (delete-other-windows)
7656 (org-pop-to-buffer-same-window ibuf)
7657 (org-set-frame-title (concat "Indirect: " heading)))
7658 ((eq org-indirect-buffer-display 'current-window)
7659 (org-pop-to-buffer-same-window ibuf))
7660 ((eq org-indirect-buffer-display 'other-window)
7661 (pop-to-buffer ibuf))
7662 (t (error "Invalid value")))
7663 (if (featurep 'xemacs)
7664 (save-excursion (org-mode) (turn-on-font-lock)))
7665 (narrow-to-region beg end)
7666 (show-all)
7667 (goto-char pos)
7668 (run-hook-with-args 'org-cycle-hook 'all)
7669 (and (window-live-p cwin) (select-window cwin))))
7671 (defun org-get-indirect-buffer (&optional buffer heading)
7672 (setq buffer (or buffer (current-buffer)))
7673 (let ((n 1) (base (buffer-name buffer)) bname)
7674 (while (buffer-live-p
7675 (get-buffer
7676 (setq bname
7677 (concat base "-"
7678 (if heading (concat heading "-" (number-to-string n))
7679 (number-to-string n))))))
7680 (setq n (1+ n)))
7681 (condition-case nil
7682 (make-indirect-buffer buffer bname 'clone)
7683 (error (make-indirect-buffer buffer bname)))))
7685 (defun org-set-frame-title (title)
7686 "Set the title of the current frame to the string TITLE."
7687 ;; FIXME: how to name a single frame in XEmacs???
7688 (unless (featurep 'xemacs)
7689 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7691 ;;;; Structure editing
7693 ;;; Inserting headlines
7695 (defun org-previous-line-empty-p (&optional next)
7696 "Is the previous line a blank line?
7697 When NEXT is non-nil, check the next line instead."
7698 (save-excursion
7699 (and (not (bobp))
7700 (or (beginning-of-line (if next 2 0)) t)
7701 (save-match-data
7702 (looking-at "[ \t]*$")))))
7704 (defun org-insert-heading (&optional arg invisible-ok)
7705 "Insert a new heading or an item with the same depth at point.
7707 If point is at the beginning of a heading or a list item, insert
7708 a new heading or a new item above the current one. If point is
7709 at the beginning of a normal line, turn the line into a heading.
7711 If point is in the middle of a headline or a list item, split the
7712 headline or the item and create a new headline/item with the text
7713 in the current line after point \(see `org-M-RET-may-split-line'
7714 on how to modify this behavior).
7716 With one universal prefix argument, set the user option
7717 `org-insert-heading-respect-content' to t for the duration of
7718 the command. This modifies the behavior described above in this
7719 ways: on list items and at the beginning of normal lines, force
7720 the insertion of a heading after the current subtree.
7722 With two universal prefix arguments, insert the heading at the
7723 end of the grandparent subtree. For example, if point is within
7724 a 2nd-level heading, then it will insert a 2nd-level heading at
7725 the end of the 1st-level parent heading.
7727 If point is at the beginning of a headline, insert a sibling
7728 before the current headline. If point is not at the beginning,
7729 split the line and create a new headline with the text in the
7730 current line after point \(see `org-M-RET-may-split-line' on how
7731 to modify this behavior).
7733 If point is at the beginning of a normal line, turn this line
7734 into a heading.
7736 When INVISIBLE-OK is set, stop at invisible headlines when going
7737 back. This is important for non-interactive uses of the
7738 command."
7739 (interactive "P")
7740 (if (org-called-interactively-p 'any) (org-reveal))
7741 (let ((itemp (org-in-item-p))
7742 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7743 (respect-content (or org-insert-heading-respect-content
7744 (equal arg '(4))))
7745 (initial-content "")
7746 (adjust-empty-lines t))
7748 (cond
7750 ((or (= (buffer-size) 0)
7751 (and (not (save-excursion
7752 (and (ignore-errors (org-back-to-heading invisible-ok))
7753 (org-at-heading-p))))
7754 (or arg (not itemp))))
7755 ;; At beginning of buffer or so high up that only a heading
7756 ;; makes sense.
7757 (cond ((and (bolp) (not respect-content)) (insert "* "))
7758 ((not respect-content)
7759 (unless may-split (end-of-line))
7760 (insert "\n* "))
7761 ((re-search-forward org-outline-regexp-bol nil t)
7762 (beginning-of-line)
7763 (insert "* \n")
7764 (backward-char))
7765 (t (goto-char (point-max))
7766 (insert "\n* ")))
7767 (run-hooks 'org-insert-heading-hook))
7769 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7772 ;; Maybe move at the end of the subtree
7773 (when (equal arg '(16))
7774 (org-up-heading-safe)
7775 (org-end-of-subtree t))
7776 ;; Insert a heading
7777 (save-restriction
7778 (widen)
7779 (let* ((level nil)
7780 (on-heading (org-at-heading-p))
7781 (empty-line-p (if on-heading
7782 (org-previous-line-empty-p)
7783 ;; We will decide later
7784 nil))
7785 ;; Get a level string to fall back on
7786 (fix-level
7787 (if (org-before-first-heading-p) "*"
7788 (save-excursion
7789 (org-back-to-heading t)
7790 (if (org-previous-line-empty-p) (setq empty-line-p t))
7791 (looking-at org-outline-regexp)
7792 (make-string (1- (length (match-string 0))) ?*))))
7793 (stars
7794 (save-excursion
7795 (condition-case nil
7796 (progn
7797 (org-back-to-heading invisible-ok)
7798 (when (and (not on-heading)
7799 (featurep 'org-inlinetask)
7800 (integerp org-inlinetask-min-level)
7801 (>= (length (match-string 0))
7802 org-inlinetask-min-level))
7803 ;; Find a heading level before the inline task
7804 (while (and (setq level (org-up-heading-safe))
7805 (>= level org-inlinetask-min-level)))
7806 (if (org-at-heading-p)
7807 (org-back-to-heading invisible-ok)
7808 (error "This should not happen")))
7809 (unless (and (save-excursion
7810 (save-match-data
7811 (org-backward-heading-same-level
7812 1 invisible-ok))
7813 (= (point) (match-beginning 0)))
7814 (not (org-previous-line-empty-p t)))
7815 (setq empty-line-p (or empty-line-p
7816 (org-previous-line-empty-p))))
7817 (match-string 0))
7818 (error (or fix-level "* ")))))
7819 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7820 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7821 pos hide-previous previous-pos)
7823 ;; If we insert after content, move there and clean up whitespace
7824 (when (and respect-content
7825 (not (org-looking-at-p org-outline-regexp-bol)))
7826 (if (not (org-before-first-heading-p))
7827 (org-end-of-subtree nil t)
7828 (re-search-forward org-outline-regexp-bol)
7829 (beginning-of-line 0))
7830 (skip-chars-backward " \r\n")
7831 (and (not (looking-back "^\\*+"))
7832 (looking-at "[ \t]+") (replace-match ""))
7833 (unless (eobp) (forward-char 1))
7834 (when (looking-at "^\\*")
7835 (unless (bobp) (backward-char 1))
7836 (insert "\n")))
7838 ;; If we are splitting, grab the text that should be moved to the new headline
7839 (when may-split
7840 (if (org-on-heading-p)
7841 ;; This is a heading, we split intelligently (keeping tags)
7842 (let ((pos (point)))
7843 (goto-char (point-at-bol))
7844 (unless (looking-at org-complex-heading-regexp)
7845 (error "This should not happen"))
7846 (when (and (match-beginning 4)
7847 (> pos (match-beginning 4))
7848 (< pos (match-end 4)))
7849 (setq initial-content (buffer-substring pos (match-end 4)))
7850 (goto-char pos)
7851 (delete-region (point) (match-end 4))
7852 (if (looking-at "[ \t]*$")
7853 (replace-match "")
7854 (insert (make-string (length initial-content) ?\ )))
7855 (setq initial-content (org-trim initial-content)))
7856 (goto-char pos))
7857 ;; a normal line
7858 (setq initial-content
7859 (org-trim (buffer-substring (point) (point-at-eol))))
7860 (delete-region (point) (point-at-eol))))
7862 ;; If we are at the beginning of the line, insert before it. Else after
7863 (cond
7864 ((and (bolp) (looking-at "[ \t]*$")))
7865 ((and (bolp) (not (looking-at "[ \t]*$")))
7866 (open-line 1))
7868 (goto-char (point-at-eol))
7869 (insert "\n")))
7871 ;; Insert the new heading
7872 (insert stars)
7873 (just-one-space)
7874 (insert initial-content)
7875 (when adjust-empty-lines
7876 (if (or (not blank)
7877 (and blank (not (org-previous-line-empty-p))))
7878 (org-N-empty-lines-before-current (if blank 1 0))))
7879 (run-hooks 'org-insert-heading-hook)))))))
7881 (defun org-N-empty-lines-before-current (N)
7882 "Make the number of empty lines before current exactly N.
7883 So this will delete or add empty lines."
7884 (save-excursion
7885 (beginning-of-line)
7886 (let ((p (point)))
7887 (skip-chars-backward " \r\t\n")
7888 (unless (bolp) (forward-line))
7889 (delete-region (point) p))
7890 (when (> N 0) (insert (make-string N ?\n)))))
7892 (defun org-get-heading (&optional no-tags no-todo)
7893 "Return the heading of the current entry, without the stars.
7894 When NO-TAGS is non-nil, don't include tags.
7895 When NO-TODO is non-nil, don't include TODO keywords."
7896 (save-excursion
7897 (org-back-to-heading t)
7898 (cond
7899 ((and no-tags no-todo)
7900 (looking-at org-complex-heading-regexp)
7901 (match-string 4))
7902 (no-tags
7903 (looking-at (concat org-outline-regexp
7904 "\\(.*?\\)"
7905 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7906 (match-string 1))
7907 (no-todo
7908 (looking-at org-todo-line-regexp)
7909 (match-string 3))
7910 (t (looking-at org-heading-regexp)
7911 (match-string 2)))))
7913 (defvar orgstruct-mode) ; defined below
7915 (defun org-heading-components ()
7916 "Return the components of the current heading.
7917 This is a list with the following elements:
7918 - the level as an integer
7919 - the reduced level, different if `org-odd-levels-only' is set.
7920 - the TODO keyword, or nil
7921 - the priority character, like ?A, or nil if no priority is given
7922 - the headline text itself, or the tags string if no headline text
7923 - the tags string, or nil."
7924 (save-excursion
7925 (org-back-to-heading t)
7926 (if (let (case-fold-search)
7927 (looking-at
7928 (if orgstruct-mode
7929 org-heading-regexp
7930 org-complex-heading-regexp)))
7931 (if orgstruct-mode
7932 (list (length (match-string 1))
7933 (org-reduced-level (length (match-string 1)))
7936 (match-string 2)
7937 nil)
7938 (list (length (match-string 1))
7939 (org-reduced-level (length (match-string 1)))
7940 (org-match-string-no-properties 2)
7941 (and (match-end 3) (aref (match-string 3) 2))
7942 (org-match-string-no-properties 4)
7943 (org-match-string-no-properties 5))))))
7945 (defun org-get-entry ()
7946 "Get the entry text, after heading, entire subtree."
7947 (save-excursion
7948 (org-back-to-heading t)
7949 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7951 (defun org-insert-heading-after-current ()
7952 "Insert a new heading with same level as current, after current subtree."
7953 (interactive)
7954 (org-back-to-heading)
7955 (org-insert-heading)
7956 (org-move-subtree-down)
7957 (end-of-line 1))
7959 (defun org-insert-heading-respect-content (&optional invisible-ok)
7960 "Insert heading with `org-insert-heading-respect-content' set to t."
7961 (interactive)
7962 (org-insert-heading '(4) invisible-ok))
7964 (defun org-insert-todo-heading-respect-content (&optional force-state)
7965 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7966 (interactive)
7967 (org-insert-todo-heading force-state '(4)))
7969 (defun org-insert-todo-heading (arg &optional force-heading)
7970 "Insert a new heading with the same level and TODO state as current heading.
7971 If the heading has no TODO state, or if the state is DONE, use the first
7972 state (TODO by default). Also with one prefix arg, force first state. With
7973 two prefix args, force inserting at the end of the parent subtree."
7974 (interactive "P")
7975 (when (or force-heading (not (org-insert-item 'checkbox)))
7976 (org-insert-heading (or (and (equal arg '(16)) '(16))
7977 force-heading))
7978 (save-excursion
7979 (org-back-to-heading)
7980 (outline-previous-heading)
7981 (looking-at org-todo-line-regexp))
7982 (let*
7983 ((new-mark-x
7984 (if (or (equal arg '(4))
7985 (not (match-beginning 2))
7986 (member (match-string 2) org-done-keywords))
7987 (car org-todo-keywords-1)
7988 (match-string 2)))
7989 (new-mark
7991 (run-hook-with-args-until-success
7992 'org-todo-get-default-hook new-mark-x nil)
7993 new-mark-x)))
7994 (beginning-of-line 1)
7995 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7996 (if org-treat-insert-todo-heading-as-state-change
7997 (org-todo new-mark)
7998 (insert new-mark " "))))
7999 (when org-provide-todo-statistics
8000 (org-update-parent-todo-statistics))))
8002 (defun org-insert-subheading (arg)
8003 "Insert a new subheading and demote it.
8004 Works for outline headings and for plain lists alike."
8005 (interactive "P")
8006 (org-insert-heading arg)
8007 (cond
8008 ((org-at-heading-p) (org-do-demote))
8009 ((org-at-item-p) (org-indent-item))))
8011 (defun org-insert-todo-subheading (arg)
8012 "Insert a new subheading with TODO keyword or checkbox and demote it.
8013 Works for outline headings and for plain lists alike."
8014 (interactive "P")
8015 (org-insert-todo-heading arg)
8016 (cond
8017 ((org-at-heading-p) (org-do-demote))
8018 ((org-at-item-p) (org-indent-item))))
8020 ;;; Promotion and Demotion
8022 (defvar org-after-demote-entry-hook nil
8023 "Hook run after an entry has been demoted.
8024 The cursor will be at the beginning of the entry.
8025 When a subtree is being demoted, the hook will be called for each node.")
8027 (defvar org-after-promote-entry-hook nil
8028 "Hook run after an entry has been promoted.
8029 The cursor will be at the beginning of the entry.
8030 When a subtree is being promoted, the hook will be called for each node.")
8032 (defun org-promote-subtree ()
8033 "Promote the entire subtree.
8034 See also `org-promote'."
8035 (interactive)
8036 (save-excursion
8037 (org-with-limited-levels (org-map-tree 'org-promote)))
8038 (org-fix-position-after-promote))
8040 (defun org-demote-subtree ()
8041 "Demote the entire subtree. See `org-demote'.
8042 See also `org-promote'."
8043 (interactive)
8044 (save-excursion
8045 (org-with-limited-levels (org-map-tree 'org-demote)))
8046 (org-fix-position-after-promote))
8049 (defun org-do-promote ()
8050 "Promote the current heading higher up the tree.
8051 If the region is active in `transient-mark-mode', promote all headings
8052 in the region."
8053 (interactive)
8054 (save-excursion
8055 (if (org-region-active-p)
8056 (org-map-region 'org-promote (region-beginning) (region-end))
8057 (org-promote)))
8058 (org-fix-position-after-promote))
8060 (defun org-do-demote ()
8061 "Demote the current heading lower down the tree.
8062 If the region is active in `transient-mark-mode', demote all headings
8063 in the region."
8064 (interactive)
8065 (save-excursion
8066 (if (org-region-active-p)
8067 (org-map-region 'org-demote (region-beginning) (region-end))
8068 (org-demote)))
8069 (org-fix-position-after-promote))
8071 (defun org-fix-position-after-promote ()
8072 "Make sure that after pro/demotion cursor position is right."
8073 (let ((pos (point)))
8074 (when (save-excursion
8075 (beginning-of-line 1)
8076 (looking-at org-todo-line-regexp)
8077 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8078 (cond ((eobp) (insert " "))
8079 ((eolp) (insert " "))
8080 ((equal (char-after) ?\ ) (forward-char 1))))))
8082 (defun org-current-level ()
8083 "Return the level of the current entry, or nil if before the first headline.
8084 The level is the number of stars at the beginning of the headline."
8085 (save-excursion
8086 (org-with-limited-levels
8087 (if (ignore-errors (org-back-to-heading t))
8088 (funcall outline-level)))))
8090 (defun org-get-previous-line-level ()
8091 "Return the outline depth of the last headline before the current line.
8092 Returns 0 for the first headline in the buffer, and nil if before the
8093 first headline."
8094 (and (org-current-level)
8095 (or (and (/= (line-beginning-position) (point-min))
8096 (save-excursion (beginning-of-line 0) (org-current-level)))
8097 0)))
8099 (defun org-reduced-level (l)
8100 "Compute the effective level of a heading.
8101 This takes into account the setting of `org-odd-levels-only'."
8102 (cond
8103 ((zerop l) 0)
8104 (org-odd-levels-only (1+ (floor (/ l 2))))
8105 (t l)))
8107 (defun org-level-increment ()
8108 "Return the number of stars that will be added or removed at a
8109 time to headlines when structure editing, based on the value of
8110 `org-odd-levels-only'."
8111 (if org-odd-levels-only 2 1))
8113 (defun org-get-valid-level (level &optional change)
8114 "Rectify a level change under the influence of `org-odd-levels-only'
8115 LEVEL is a current level, CHANGE is by how much the level should be
8116 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8117 even level numbers will become the next higher odd number."
8118 (if org-odd-levels-only
8119 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8120 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8121 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8122 (max 1 (+ level (or change 0)))))
8124 (if (boundp 'define-obsolete-function-alias)
8125 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8126 (define-obsolete-function-alias 'org-get-legal-level
8127 'org-get-valid-level)
8128 (define-obsolete-function-alias 'org-get-legal-level
8129 'org-get-valid-level "23.1")))
8131 (defun org-promote ()
8132 "Promote the current heading higher up the tree."
8133 (org-with-wide-buffer
8134 (org-back-to-heading t)
8135 (let* ((after-change-functions (remq 'flyspell-after-change-function
8136 after-change-functions))
8137 (level (save-match-data (funcall outline-level)))
8138 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8139 (diff (abs (- level (length up-head) -1))))
8140 (cond
8141 ((and (= level 1) org-allow-promoting-top-level-subtree)
8142 (replace-match "# " nil t))
8143 ((= level 1)
8144 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8145 (t (replace-match up-head nil t)))
8146 (unless (= level 1)
8147 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8148 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8149 (run-hooks 'org-after-promote-entry-hook))))
8151 (defun org-demote ()
8152 "Demote the current heading lower down the tree."
8153 (org-with-wide-buffer
8154 (org-back-to-heading t)
8155 (let* ((after-change-functions (remq 'flyspell-after-change-function
8156 after-change-functions))
8157 (level (save-match-data (funcall outline-level)))
8158 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8159 (diff (abs (- level (length down-head) -1))))
8160 (replace-match down-head nil t)
8161 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8162 (when org-adapt-indentation (org-fixup-indentation diff))
8163 (run-hooks 'org-after-demote-entry-hook))))
8165 (defun org-cycle-level ()
8166 "Cycle the level of an empty headline through possible states.
8167 This goes first to child, then to parent, level, then up the hierarchy.
8168 After top level, it switches back to sibling level."
8169 (interactive)
8170 (let ((org-adapt-indentation nil))
8171 (when (org-point-at-end-of-empty-headline)
8172 (setq this-command 'org-cycle-level) ; Only needed for caching
8173 (let ((cur-level (org-current-level))
8174 (prev-level (org-get-previous-line-level)))
8175 (cond
8176 ;; If first headline in file, promote to top-level.
8177 ((= prev-level 0)
8178 (loop repeat (/ (- cur-level 1) (org-level-increment))
8179 do (org-do-promote)))
8180 ;; If same level as prev, demote one.
8181 ((= prev-level cur-level)
8182 (org-do-demote))
8183 ;; If parent is top-level, promote to top level if not already.
8184 ((= prev-level 1)
8185 (loop repeat (/ (- cur-level 1) (org-level-increment))
8186 do (org-do-promote)))
8187 ;; If top-level, return to prev-level.
8188 ((= cur-level 1)
8189 (loop repeat (/ (- prev-level 1) (org-level-increment))
8190 do (org-do-demote)))
8191 ;; If less than prev-level, promote one.
8192 ((< cur-level prev-level)
8193 (org-do-promote))
8194 ;; If deeper than prev-level, promote until higher than
8195 ;; prev-level.
8196 ((> cur-level prev-level)
8197 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8198 do (org-do-promote))))
8199 t))))
8201 (defun org-map-tree (fun)
8202 "Call FUN for every heading underneath the current one."
8203 (org-back-to-heading)
8204 (let ((level (funcall outline-level)))
8205 (save-excursion
8206 (funcall fun)
8207 (while (and (progn
8208 (outline-next-heading)
8209 (> (funcall outline-level) level))
8210 (not (eobp)))
8211 (funcall fun)))))
8213 (defun org-map-region (fun beg end)
8214 "Call FUN for every heading between BEG and END."
8215 (let ((org-ignore-region t))
8216 (save-excursion
8217 (setq end (copy-marker end))
8218 (goto-char beg)
8219 (if (and (re-search-forward org-outline-regexp-bol nil t)
8220 (< (point) end))
8221 (funcall fun))
8222 (while (and (progn
8223 (outline-next-heading)
8224 (< (point) end))
8225 (not (eobp)))
8226 (funcall fun)))))
8228 (defun org-fixup-indentation (diff)
8229 "Change the indentation in the current entry by DIFF.
8231 DIFF is an integer. Indentation is done according to the
8232 following rules:
8234 - Planning information and property drawers are always indented
8235 according to the new level of the headline;
8237 - Footnote definitions and their contents are ignored;
8239 - Inlinetasks' boundaries are not shifted;
8241 - Empty lines are ignored;
8243 - Other lines' indentation are shifted by DIFF columns, unless
8244 it would introduce a structural change in the document, in
8245 which case no shifting is done at all.
8247 Assume point is at a heading or an inlinetask beginning."
8248 (org-with-wide-buffer
8249 (narrow-to-region (line-beginning-position)
8250 (save-excursion
8251 (if (org-with-limited-levels (org-at-heading-p))
8252 (org-with-limited-levels (outline-next-heading))
8253 (org-inlinetask-goto-end))
8254 (point)))
8255 (forward-line)
8256 ;; Indent properly planning info and property drawer.
8257 (when (org-looking-at-p org-planning-line-re)
8258 (org-indent-line)
8259 (forward-line))
8260 (when (looking-at org-property-drawer-re)
8261 (goto-char (match-end 0))
8262 (forward-line)
8263 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8264 (catch 'no-shift
8265 (when (zerop diff) (throw 'no-shift nil))
8266 ;; If DIFF is negative, first check if a shift is possible at all
8267 ;; (e.g., it doesn't break structure). This can only happen if
8268 ;; some contents are not properly indented.
8269 (let ((case-fold-search t))
8270 (when (< diff 0)
8271 (let ((diff (- diff))
8272 (forbidden-re (concat org-outline-regexp
8273 "\\|"
8274 (substring org-footnote-definition-re 1))))
8275 (save-excursion
8276 (while (not (eobp))
8277 (cond
8278 ((org-looking-at-p "[ \t]*$") (forward-line))
8279 ((and (org-looking-at-p org-footnote-definition-re)
8280 (let ((e (org-element-at-point)))
8281 (and (eq (org-element-type e) 'footnote-definition)
8282 (goto-char (org-element-property :end e))))))
8283 ((org-looking-at-p org-outline-regexp) (forward-line))
8284 ;; Give up if shifting would move before column 0 or
8285 ;; if it would introduce a headline or a footnote
8286 ;; definition.
8288 (skip-chars-forward " \t")
8289 (let ((ind (current-column)))
8290 (when (or (< ind diff)
8291 (and (= ind diff) (org-looking-at-p forbidden-re)))
8292 (throw 'no-shift nil)))
8293 ;; Ignore contents of example blocks and source
8294 ;; blocks if their indentation is meant to be
8295 ;; preserved. Jump to block's closing line.
8296 (beginning-of-line)
8297 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8298 (let ((e (org-element-at-point)))
8299 (and (memq (org-element-type e)
8300 '(example-block src-block))
8301 (or org-src-preserve-indentation
8302 (org-element-property :preserve-indent e))
8303 (goto-char (org-element-property :end e))
8304 (progn (skip-chars-backward " \r\t\n")
8305 (beginning-of-line)
8306 t))))
8307 (forward-line))))))))
8308 ;; Shift lines but footnote definitions, inlinetasks boundaries
8309 ;; by DIFF. Also skip contents of source or example blocks
8310 ;; when indentation is meant to be preserved.
8311 (while (not (eobp))
8312 (cond
8313 ((and (org-looking-at-p org-footnote-definition-re)
8314 (let ((e (org-element-at-point)))
8315 (and (eq (org-element-type e) 'footnote-definition)
8316 (goto-char (org-element-property :end e))))))
8317 ((org-looking-at-p org-outline-regexp) (forward-line))
8318 ((org-looking-at-p "[ \t]*$") (forward-line))
8320 (org-indent-line-to (+ (org-get-indentation) diff))
8321 (beginning-of-line)
8322 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8323 (let ((e (org-element-at-point)))
8324 (and (memq (org-element-type e)
8325 '(example-block src-block))
8326 (or org-src-preserve-indentation
8327 (org-element-property :preserve-indent e))
8328 (goto-char (org-element-property :end e))
8329 (progn (skip-chars-backward " \r\t\n")
8330 (beginning-of-line)
8331 t))))
8332 (forward-line)))))))))
8334 (defun org-convert-to-odd-levels ()
8335 "Convert an org-mode file with all levels allowed to one with odd levels.
8336 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8337 level 5 etc."
8338 (interactive)
8339 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8340 (let ((outline-level 'org-outline-level)
8341 (org-odd-levels-only nil) n)
8342 (save-excursion
8343 (goto-char (point-min))
8344 (while (re-search-forward "^\\*\\*+ " nil t)
8345 (setq n (- (length (match-string 0)) 2))
8346 (while (>= (setq n (1- n)) 0)
8347 (org-demote))
8348 (end-of-line 1))))))
8350 (defun org-convert-to-oddeven-levels ()
8351 "Convert an org-mode file with only odd levels to one with odd/even levels.
8352 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8353 file contains a section with an even level, conversion would
8354 destroy the structure of the file. An error is signaled in this
8355 case."
8356 (interactive)
8357 (goto-char (point-min))
8358 ;; First check if there are no even levels
8359 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8360 (org-show-context t)
8361 (error "Not all levels are odd in this file. Conversion not possible"))
8362 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8363 (let ((outline-regexp org-outline-regexp)
8364 (outline-level 'org-outline-level)
8365 (org-odd-levels-only nil) n)
8366 (save-excursion
8367 (goto-char (point-min))
8368 (while (re-search-forward "^\\*\\*+ " nil t)
8369 (setq n (/ (1- (length (match-string 0))) 2))
8370 (while (>= (setq n (1- n)) 0)
8371 (org-promote))
8372 (end-of-line 1))))))
8374 (defun org-tr-level (n)
8375 "Make N odd if required."
8376 (if org-odd-levels-only (1+ (/ n 2)) n))
8378 ;;; Vertical tree motion, cutting and pasting of subtrees
8380 (defun org-move-subtree-up (&optional arg)
8381 "Move the current subtree up past ARG headlines of the same level."
8382 (interactive "p")
8383 (org-move-subtree-down (- (prefix-numeric-value arg))))
8385 (defun org-move-subtree-down (&optional arg)
8386 "Move the current subtree down past ARG headlines of the same level."
8387 (interactive "p")
8388 (setq arg (prefix-numeric-value arg))
8389 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8390 'org-get-last-sibling))
8391 (ins-point (make-marker))
8392 (cnt (abs arg))
8393 (col (current-column))
8394 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8395 ;; Select the tree
8396 (org-back-to-heading)
8397 (setq beg0 (point))
8398 (save-excursion
8399 (setq ne-beg (org-back-over-empty-lines))
8400 (setq beg (point)))
8401 (save-match-data
8402 (save-excursion (outline-end-of-heading)
8403 (setq folded (outline-invisible-p)))
8404 (progn (org-end-of-subtree nil t)
8405 (unless (eobp) (backward-char))))
8406 (outline-next-heading)
8407 (setq ne-end (org-back-over-empty-lines))
8408 (setq end (point))
8409 (goto-char beg0)
8410 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8411 ;; include less whitespace
8412 (save-excursion
8413 (goto-char beg)
8414 (forward-line (- ne-beg ne-end))
8415 (setq beg (point))))
8416 ;; Find insertion point, with error handling
8417 (while (> cnt 0)
8418 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8419 (progn (goto-char beg0)
8420 (user-error "Cannot move past superior level or buffer limit")))
8421 (setq cnt (1- cnt)))
8422 (if (> arg 0)
8423 ;; Moving forward - still need to move over subtree
8424 (progn (org-end-of-subtree t t)
8425 (save-excursion
8426 (org-back-over-empty-lines)
8427 (or (bolp) (newline)))))
8428 (setq ne-ins (org-back-over-empty-lines))
8429 (move-marker ins-point (point))
8430 (setq txt (buffer-substring beg end))
8431 (org-save-markers-in-region beg end)
8432 (delete-region beg end)
8433 (org-remove-empty-overlays-at beg)
8434 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8435 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8436 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8437 (let ((bbb (point)))
8438 (insert-before-markers txt)
8439 (org-reinstall-markers-in-region bbb)
8440 (move-marker ins-point bbb))
8441 (or (bolp) (insert "\n"))
8442 (setq ins-end (point))
8443 (goto-char ins-point)
8444 (org-skip-whitespace)
8445 (when (and (< arg 0)
8446 (org-first-sibling-p)
8447 (> ne-ins ne-beg))
8448 ;; Move whitespace back to beginning
8449 (save-excursion
8450 (goto-char ins-end)
8451 (let ((kill-whole-line t))
8452 (kill-line (- ne-ins ne-beg)) (point)))
8453 (insert (make-string (- ne-ins ne-beg) ?\n)))
8454 (move-marker ins-point nil)
8455 (if folded
8456 (hide-subtree)
8457 (org-show-entry)
8458 (show-children)
8459 (org-cycle-hide-drawers 'children))
8460 (org-clean-visibility-after-subtree-move)
8461 ;; move back to the initial column we were at
8462 (move-to-column col)))
8464 (defvar org-subtree-clip ""
8465 "Clipboard for cut and paste of subtrees.
8466 This is actually only a copy of the kill, because we use the normal kill
8467 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8469 (defvar org-subtree-clip-folded nil
8470 "Was the last copied subtree folded?
8471 This is used to fold the tree back after pasting.")
8473 (defun org-cut-subtree (&optional n)
8474 "Cut the current subtree into the clipboard.
8475 With prefix arg N, cut this many sequential subtrees.
8476 This is a short-hand for marking the subtree and then cutting it."
8477 (interactive "p")
8478 (org-copy-subtree n 'cut))
8480 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8481 "Copy the current subtree it in the clipboard.
8482 With prefix arg N, copy this many sequential subtrees.
8483 This is a short-hand for marking the subtree and then copying it.
8484 If CUT is non-nil, actually cut the subtree.
8485 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8486 of some markers in the region, even if CUT is non-nil. This is
8487 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8488 (interactive "p")
8489 (let (beg end folded (beg0 (point)))
8490 (if (org-called-interactively-p 'any)
8491 (org-back-to-heading nil) ; take what looks like a subtree
8492 (org-back-to-heading t)) ; take what is really there
8493 (setq beg (point))
8494 (skip-chars-forward " \t\r\n")
8495 (save-match-data
8496 (if nosubtrees
8497 (outline-next-heading)
8498 (save-excursion (outline-end-of-heading)
8499 (setq folded (outline-invisible-p)))
8500 (ignore-errors (org-forward-heading-same-level (1- n) t))
8501 (org-end-of-subtree t t)))
8502 (setq end (point))
8503 (goto-char beg0)
8504 (when (> end beg)
8505 (setq org-subtree-clip-folded folded)
8506 (when (or cut force-store-markers)
8507 (org-save-markers-in-region beg end))
8508 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8509 (setq org-subtree-clip (current-kill 0))
8510 (message "%s: Subtree(s) with %d characters"
8511 (if cut "Cut" "Copied")
8512 (length org-subtree-clip)))))
8514 (defun org-paste-subtree (&optional level tree for-yank remove)
8515 "Paste the clipboard as a subtree, with modification of headline level.
8516 The entire subtree is promoted or demoted in order to match a new headline
8517 level.
8519 If the cursor is at the beginning of a headline, the same level as
8520 that headline is used to paste the tree.
8522 If not, the new level is derived from the *visible* headings
8523 before and after the insertion point, and taken to be the inferior headline
8524 level of the two. So if the previous visible heading is level 3 and the
8525 next is level 4 (or vice versa), level 4 will be used for insertion.
8526 This makes sure that the subtree remains an independent subtree and does
8527 not swallow low level entries.
8529 You can also force a different level, either by using a numeric prefix
8530 argument, or by inserting the heading marker by hand. For example, if the
8531 cursor is after \"*****\", then the tree will be shifted to level 5.
8533 If optional TREE is given, use this text instead of the kill ring.
8535 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8536 move back over whitespace before inserting, and move point to the end of
8537 the inserted text when done.
8539 When REMOVE is non-nil, remove the subtree from the clipboard."
8540 (interactive "P")
8541 (setq tree (or tree (and kill-ring (current-kill 0))))
8542 (unless (org-kill-is-subtree-p tree)
8543 (user-error "%s"
8544 (substitute-command-keys
8545 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8546 (org-with-limited-levels
8547 (let* ((visp (not (outline-invisible-p)))
8548 (txt tree)
8549 (^re_ "\\(\\*+\\)[ \t]*")
8550 (old-level (if (string-match org-outline-regexp-bol txt)
8551 (- (match-end 0) (match-beginning 0) 1)
8552 -1))
8553 (force-level (cond (level (prefix-numeric-value level))
8554 ((and (looking-at "[ \t]*$")
8555 (string-match
8556 "^\\*+$" (buffer-substring
8557 (point-at-bol) (point))))
8558 (- (match-end 0) (match-beginning 0)))
8559 ((and (bolp)
8560 (looking-at org-outline-regexp))
8561 (- (match-end 0) (point) 1))))
8562 (previous-level (save-excursion
8563 (condition-case nil
8564 (progn
8565 (outline-previous-visible-heading 1)
8566 (if (looking-at ^re_)
8567 (- (match-end 0) (match-beginning 0) 1)
8569 (error 1))))
8570 (next-level (save-excursion
8571 (condition-case nil
8572 (progn
8573 (or (looking-at org-outline-regexp)
8574 (outline-next-visible-heading 1))
8575 (if (looking-at ^re_)
8576 (- (match-end 0) (match-beginning 0) 1)
8578 (error 1))))
8579 (new-level (or force-level (max previous-level next-level)))
8580 (shift (if (or (= old-level -1)
8581 (= new-level -1)
8582 (= old-level new-level))
8584 (- new-level old-level)))
8585 (delta (if (> shift 0) -1 1))
8586 (func (if (> shift 0) 'org-demote 'org-promote))
8587 (org-odd-levels-only nil)
8588 beg end newend)
8589 ;; Remove the forced level indicator
8590 (if force-level
8591 (delete-region (point-at-bol) (point)))
8592 ;; Paste
8593 (beginning-of-line (if (bolp) 1 2))
8594 (setq beg (point))
8595 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8596 (insert-before-markers txt)
8597 (unless (string-match "\n\\'" txt) (insert "\n"))
8598 (setq newend (point))
8599 (org-reinstall-markers-in-region beg)
8600 (setq end (point))
8601 (goto-char beg)
8602 (skip-chars-forward " \t\n\r")
8603 (setq beg (point))
8604 (if (and (outline-invisible-p) visp)
8605 (save-excursion (outline-show-heading)))
8606 ;; Shift if necessary
8607 (unless (= shift 0)
8608 (save-restriction
8609 (narrow-to-region beg end)
8610 (while (not (= shift 0))
8611 (org-map-region func (point-min) (point-max))
8612 (setq shift (+ delta shift)))
8613 (goto-char (point-min))
8614 (setq newend (point-max))))
8615 (when (or (org-called-interactively-p 'interactive) for-yank)
8616 (message "Clipboard pasted as level %d subtree" new-level))
8617 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8618 kill-ring
8619 (eq org-subtree-clip (current-kill 0))
8620 org-subtree-clip-folded)
8621 ;; The tree was folded before it was killed/copied
8622 (hide-subtree))
8623 (and for-yank (goto-char newend))
8624 (and remove (setq kill-ring (cdr kill-ring))))))
8626 (defun org-kill-is-subtree-p (&optional txt)
8627 "Check if the current kill is an outline subtree, or a set of trees.
8628 Returns nil if kill does not start with a headline, or if the first
8629 headline level is not the largest headline level in the tree.
8630 So this will actually accept several entries of equal levels as well,
8631 which is OK for `org-paste-subtree'.
8632 If optional TXT is given, check this string instead of the current kill."
8633 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8634 (re (org-get-limited-outline-regexp))
8635 (^re (concat "^" re))
8636 (start-level (and kill
8637 (string-match
8638 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8639 kill)
8640 (- (match-end 2) (match-beginning 2) 1)))
8641 (start (1+ (or (match-beginning 2) -1))))
8642 (if (not start-level)
8643 (progn
8644 nil) ;; does not even start with a heading
8645 (catch 'exit
8646 (while (setq start (string-match ^re kill (1+ start)))
8647 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8648 (throw 'exit nil)))
8649 t))))
8651 (defvar org-markers-to-move nil
8652 "Markers that should be moved with a cut-and-paste operation.
8653 Those markers are stored together with their positions relative to
8654 the start of the region.")
8656 (defun org-save-markers-in-region (beg end)
8657 "Check markers in region.
8658 If these markers are between BEG and END, record their position relative
8659 to BEG, so that after moving the block of text, we can put the markers back
8660 into place.
8661 This function gets called just before an entry or tree gets cut from the
8662 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8663 called immediately, to move the markers with the entries."
8664 (setq org-markers-to-move nil)
8665 (when (featurep 'org-clock)
8666 (org-clock-save-markers-for-cut-and-paste beg end))
8667 (when (featurep 'org-agenda)
8668 (org-agenda-save-markers-for-cut-and-paste beg end)))
8670 (defun org-check-and-save-marker (marker beg end)
8671 "Check if MARKER is between BEG and END.
8672 If yes, remember the marker and the distance to BEG."
8673 (when (and (marker-buffer marker)
8674 (equal (marker-buffer marker) (current-buffer)))
8675 (if (and (>= marker beg) (< marker end))
8676 (push (cons marker (- marker beg)) org-markers-to-move))))
8678 (defun org-reinstall-markers-in-region (beg)
8679 "Move all remembered markers to their position relative to BEG."
8680 (mapc (lambda (x)
8681 (move-marker (car x) (+ beg (cdr x))))
8682 org-markers-to-move)
8683 (setq org-markers-to-move nil))
8685 (defun org-narrow-to-subtree ()
8686 "Narrow buffer to the current subtree."
8687 (interactive)
8688 (save-excursion
8689 (save-match-data
8690 (org-with-limited-levels
8691 (narrow-to-region
8692 (progn (org-back-to-heading t) (point))
8693 (progn (org-end-of-subtree t t)
8694 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8695 (point)))))))
8697 (defun org-narrow-to-block ()
8698 "Narrow buffer to the current block."
8699 (interactive)
8700 (let* ((case-fold-search t)
8701 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8702 "^[ \t]*#\\+end_.*")))
8703 (if blockp
8704 (narrow-to-region (car blockp) (cdr blockp))
8705 (user-error "Not in a block"))))
8707 (defun org-clone-subtree-with-time-shift (n &optional shift)
8708 "Clone the task (subtree) at point N times.
8709 The clones will be inserted as siblings.
8711 In interactive use, the user will be prompted for the number of
8712 clones to be produced. If the entry has a timestamp, the user
8713 will also be prompted for a time shift, which may be a repeater
8714 as used in time stamps, for example `+3d'. To disable this,
8715 you can call the function with a universal prefix argument.
8717 When a valid repeater is given and the entry contains any time
8718 stamps, the clones will become a sequence in time, with time
8719 stamps in the subtree shifted for each clone produced. If SHIFT
8720 is nil or the empty string, time stamps will be left alone. The
8721 ID property of the original subtree is removed.
8723 If the original subtree did contain time stamps with a repeater,
8724 the following will happen:
8725 - the repeater will be removed in each clone
8726 - an additional clone will be produced, with the current, unshifted
8727 date(s) in the entry.
8728 - the original entry will be placed *after* all the clones, with
8729 repeater intact.
8730 - the start days in the repeater in the original entry will be shifted
8731 to past the last clone.
8732 In this way you can spell out a number of instances of a repeating task,
8733 and still retain the repeater to cover future instances of the task."
8734 (interactive "nNumber of clones to produce: ")
8735 (let ((shift
8736 (or shift
8737 (if (and (not (equal current-prefix-arg '(4)))
8738 (save-excursion
8739 (re-search-forward org-ts-regexp-both
8740 (save-excursion
8741 (org-end-of-subtree t)
8742 (point)) t)))
8743 (read-from-minibuffer
8744 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8745 ""))) ;; No time shift
8746 (n-no-remove -1)
8747 (drawer-re org-drawer-regexp)
8748 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8749 beg end template task idprop
8750 shift-n shift-what doshift nmin nmax)
8751 (if (not (and (integerp n) (> n 0)))
8752 (user-error "Invalid number of replications %s" n))
8753 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8754 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8755 shift)))
8756 (user-error "Invalid shift specification %s" shift))
8757 (when doshift
8758 (setq shift-n (string-to-number (match-string 1 shift))
8759 shift-what (cdr (assoc (match-string 2 shift)
8760 '(("d" . day) ("w" . week)
8761 ("m" . month) ("y" . year))))))
8762 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8763 (setq nmin 1 nmax n)
8764 (org-back-to-heading t)
8765 (setq beg (point))
8766 (setq idprop (org-entry-get nil "ID"))
8767 (org-end-of-subtree t t)
8768 (or (bolp) (insert "\n"))
8769 (setq end (point))
8770 (setq template (buffer-substring beg end))
8771 (when (and doshift
8772 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8773 (delete-region beg end)
8774 (setq end beg)
8775 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8776 (goto-char end)
8777 (loop for n from nmin to nmax do
8778 ;; prepare clone
8779 (with-temp-buffer
8780 (insert template)
8781 (org-mode)
8782 (goto-char (point-min))
8783 (org-show-subtree)
8784 (and idprop (if org-clone-delete-id
8785 (org-entry-delete nil "ID")
8786 (org-id-get-create t)))
8787 (unless (= n 0)
8788 (while (re-search-forward org-clock-re nil t)
8789 (kill-whole-line))
8790 (goto-char (point-min))
8791 (while (re-search-forward drawer-re nil t)
8792 (org-remove-empty-drawer-at (point))))
8793 (goto-char (point-min))
8794 (when doshift
8795 (while (re-search-forward org-ts-regexp-both nil t)
8796 (org-timestamp-change (* n shift-n) shift-what))
8797 (unless (= n n-no-remove)
8798 (goto-char (point-min))
8799 (while (re-search-forward org-ts-regexp nil t)
8800 (save-excursion
8801 (goto-char (match-beginning 0))
8802 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8803 (delete-region (match-beginning 1) (match-end 1)))))))
8804 (setq task (buffer-string)))
8805 (insert task))
8806 (goto-char beg)))
8808 ;;; Outline Sorting
8810 (defun org-sort (with-case)
8811 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8812 Optional argument WITH-CASE means sort case-sensitively."
8813 (interactive "P")
8814 (cond
8815 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8816 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8818 (org-call-with-arg 'org-sort-entries with-case))))
8820 (defun org-sort-remove-invisible (s)
8821 "Remove invisible links from string S."
8822 (remove-text-properties 0 (length s) org-rm-props s)
8823 (while (string-match org-bracket-link-regexp s)
8824 (setq s (replace-match (if (match-end 2)
8825 (match-string 3 s)
8826 (match-string 1 s)) t t s)))
8827 (let ((st (format " %s " s)))
8828 (while (string-match org-emph-re st)
8829 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8830 (setq s (substring st 1 -1)))
8833 (defvar org-priority-regexp) ; defined later in the file
8835 (defvar org-after-sorting-entries-or-items-hook nil
8836 "Hook that is run after a bunch of entries or items have been sorted.
8837 When children are sorted, the cursor is in the parent line when this
8838 hook gets called. When a region or a plain list is sorted, the cursor
8839 will be in the first entry of the sorted region/list.")
8841 (defun org-sort-entries
8842 (&optional with-case sorting-type getkey-func compare-func property)
8843 "Sort entries on a certain level of an outline tree.
8844 If there is an active region, the entries in the region are sorted.
8845 Else, if the cursor is before the first entry, sort the top-level items.
8846 Else, the children of the entry at point are sorted.
8848 Sorting can be alphabetically, numerically, by date/time as given by
8849 a time stamp, by a property, by priority order, or by a custom function.
8851 The command prompts for the sorting type unless it has been given to the
8852 function through the SORTING-TYPE argument, which needs to be a character,
8853 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8854 the precise meaning of each character:
8856 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8857 c By creation time, which is assumed to be the first inactive time stamp
8858 at the beginning of a line.
8859 d By deadline date/time.
8860 k By clocking time.
8861 n Numerically, by converting the beginning of the entry/item to a number.
8862 o By order of TODO keywords.
8863 p By priority according to the cookie.
8864 r By the value of a property.
8865 s By scheduled date/time.
8866 t By date/time, either the first active time stamp in the entry, or, if
8867 none exist, by the first inactive one.
8869 Capital letters will reverse the sort order.
8871 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8872 called with point at the beginning of the record. It must return either
8873 a string or a number that should serve as the sorting key for that record.
8875 Comparing entries ignores case by default. However, with an optional argument
8876 WITH-CASE, the sorting considers case as well.
8878 Sorting is done against the visible part of the headlines, it ignores hidden
8879 links.
8881 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8882 (interactive "P")
8883 (let ((case-func (if with-case 'identity 'downcase))
8884 (cmstr
8885 ;; The clock marker is lost when using `sort-subr', let's
8886 ;; store the clocking string.
8887 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8888 (save-excursion
8889 (goto-char org-clock-marker)
8890 (looking-back "^.*") (match-string-no-properties 0))))
8891 start beg end stars re re2
8892 txt what tmp)
8893 ;; Find beginning and end of region to sort
8894 (cond
8895 ((org-region-active-p)
8896 ;; we will sort the region
8897 (setq end (region-end)
8898 what "region")
8899 (goto-char (region-beginning))
8900 (if (not (org-at-heading-p)) (outline-next-heading))
8901 (setq start (point)))
8902 ((or (org-at-heading-p)
8903 (ignore-errors (progn (org-back-to-heading) t)))
8904 ;; we will sort the children of the current headline
8905 (org-back-to-heading)
8906 (setq start (point)
8907 end (progn (org-end-of-subtree t t)
8908 (or (bolp) (insert "\n"))
8909 (when (>= (org-back-over-empty-lines) 1)
8910 (forward-line 1))
8911 (point))
8912 what "children")
8913 (goto-char start)
8914 (show-subtree)
8915 (outline-next-heading))
8917 ;; we will sort the top-level entries in this file
8918 (goto-char (point-min))
8919 (or (org-at-heading-p) (outline-next-heading))
8920 (setq start (point))
8921 (goto-char (point-max))
8922 (beginning-of-line 1)
8923 (when (looking-at ".*?\\S-")
8924 ;; File ends in a non-white line
8925 (end-of-line 1)
8926 (insert "\n"))
8927 (setq end (point-max))
8928 (setq what "top-level")
8929 (goto-char start)
8930 (show-all)))
8932 (setq beg (point))
8933 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8935 (looking-at "\\(\\*+\\)")
8936 (setq stars (match-string 1)
8937 re (concat "^" (regexp-quote stars) " +")
8938 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8939 txt (buffer-substring beg end))
8940 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8941 (if (and (not (equal stars "*")) (string-match re2 txt))
8942 (user-error "Region to sort contains a level above the first entry"))
8944 (unless sorting-type
8945 (message
8946 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8947 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8948 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8949 what)
8950 (setq sorting-type (read-char-exclusive))
8952 (unless getkey-func
8953 (and (= (downcase sorting-type) ?f)
8954 (setq getkey-func
8955 (org-icompleting-read "Sort using function: "
8956 obarray 'fboundp t nil nil))
8957 (setq getkey-func (intern getkey-func))))
8959 (and (= (downcase sorting-type) ?r)
8960 (not property)
8961 (setq property
8962 (org-icompleting-read "Property: "
8963 (mapcar 'list (org-buffer-property-keys t))
8964 nil t))))
8966 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8967 (message "Sorting entries...")
8969 (save-restriction
8970 (narrow-to-region start end)
8971 (let ((dcst (downcase sorting-type))
8972 (case-fold-search nil)
8973 (now (current-time)))
8974 (sort-subr
8975 (/= dcst sorting-type)
8976 ;; This function moves to the beginning character of the "record" to
8977 ;; be sorted.
8978 (lambda nil
8979 (if (re-search-forward re nil t)
8980 (goto-char (match-beginning 0))
8981 (goto-char (point-max))))
8982 ;; This function moves to the last character of the "record" being
8983 ;; sorted.
8984 (lambda nil
8985 (save-match-data
8986 (condition-case nil
8987 (outline-forward-same-level 1)
8988 (error
8989 (goto-char (point-max))))))
8990 ;; This function returns the value that gets sorted against.
8991 (lambda nil
8992 (cond
8993 ((= dcst ?n)
8994 (if (looking-at org-complex-heading-regexp)
8995 (string-to-number (org-sort-remove-invisible (match-string 4)))
8996 nil))
8997 ((= dcst ?a)
8998 (if (looking-at org-complex-heading-regexp)
8999 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9000 nil))
9001 ((= dcst ?k)
9002 (or (get-text-property (point) :org-clock-minutes) 0))
9003 ((= dcst ?t)
9004 (let ((end (save-excursion (outline-next-heading) (point))))
9005 (if (or (re-search-forward org-ts-regexp end t)
9006 (re-search-forward org-ts-regexp-both end t))
9007 (org-time-string-to-seconds (match-string 0))
9008 (org-float-time now))))
9009 ((= dcst ?c)
9010 (let ((end (save-excursion (outline-next-heading) (point))))
9011 (if (re-search-forward
9012 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9013 end t)
9014 (org-time-string-to-seconds (match-string 0))
9015 (org-float-time now))))
9016 ((= dcst ?s)
9017 (let ((end (save-excursion (outline-next-heading) (point))))
9018 (if (re-search-forward org-scheduled-time-regexp end t)
9019 (org-time-string-to-seconds (match-string 1))
9020 (org-float-time now))))
9021 ((= dcst ?d)
9022 (let ((end (save-excursion (outline-next-heading) (point))))
9023 (if (re-search-forward org-deadline-time-regexp end t)
9024 (org-time-string-to-seconds (match-string 1))
9025 (org-float-time now))))
9026 ((= dcst ?p)
9027 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9028 (string-to-char (match-string 2))
9029 org-default-priority))
9030 ((= dcst ?r)
9031 (or (org-entry-get nil property) ""))
9032 ((= dcst ?o)
9033 (if (looking-at org-complex-heading-regexp)
9034 (let* ((m (match-string 2))
9035 (s (if (member m org-done-keywords) '- '+)))
9036 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9037 ((= dcst ?f)
9038 (if getkey-func
9039 (progn
9040 (setq tmp (funcall getkey-func))
9041 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9042 tmp)
9043 (error "Invalid key function `%s'" getkey-func)))
9044 (t (error "Invalid sorting type `%c'" sorting-type))))
9046 (cond
9047 ((= dcst ?a) 'string<)
9048 ((= dcst ?f) compare-func)
9049 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9050 (run-hooks 'org-after-sorting-entries-or-items-hook)
9051 ;; Reset the clock marker if needed
9052 (when cmstr
9053 (save-excursion
9054 (goto-char start)
9055 (search-forward cmstr nil t)
9056 (move-marker org-clock-marker (point))))
9057 (message "Sorting entries...done")))
9059 (defun org-do-sort (table what &optional with-case sorting-type)
9060 "Sort TABLE of WHAT according to SORTING-TYPE.
9061 The user will be prompted for the SORTING-TYPE if the call to this
9062 function does not specify it.
9063 WHAT is only for the prompt, to indicate what is being sorted.
9064 The sorting key will be extracted from the car of the elements of
9065 the table.
9066 If WITH-CASE is non-nil, the sorting will be case-sensitive."
9067 (unless sorting-type
9068 (message
9069 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
9070 what)
9071 (setq sorting-type (read-char-exclusive)))
9072 (let ((dcst (downcase sorting-type))
9073 extractfun comparefun)
9074 ;; Define the appropriate functions
9075 (cond
9076 ((= dcst ?n)
9077 (setq extractfun 'string-to-number
9078 comparefun (if (= dcst sorting-type) '< '>)))
9079 ((= dcst ?a)
9080 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
9081 (lambda(x) (downcase (org-sort-remove-invisible x))))
9082 comparefun (if (= dcst sorting-type)
9083 'string<
9084 (lambda (a b) (and (not (string< a b))
9085 (not (string= a b)))))))
9086 ((= dcst ?t)
9087 (setq extractfun
9088 (lambda (x)
9089 (cond ((or (string-match org-ts-regexp x)
9090 (string-match org-ts-regexp-both x))
9091 (org-float-time
9092 (org-time-string-to-time (match-string 0 x))))
9093 ((string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" x)
9094 (org-hh:mm-string-to-minutes x))
9095 (t 0)))
9096 comparefun (if (= dcst sorting-type) '< '>)))
9097 (t (error "Invalid sorting type `%c'" sorting-type)))
9099 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
9100 table)
9101 (lambda (a b) (funcall comparefun (car a) (car b))))))
9104 ;;; The orgstruct minor mode
9106 ;; Define a minor mode which can be used in other modes in order to
9107 ;; integrate the org-mode structure editing commands.
9109 ;; This is really a hack, because the org-mode structure commands use
9110 ;; keys which normally belong to the major mode. Here is how it
9111 ;; works: The minor mode defines all the keys necessary to operate the
9112 ;; structure commands, but wraps the commands into a function which
9113 ;; tests if the cursor is currently at a headline or a plain list
9114 ;; item. If that is the case, the structure command is used,
9115 ;; temporarily setting many Org-mode variables like regular
9116 ;; expressions for filling etc. However, when any of those keys is
9117 ;; used at a different location, function uses `key-binding' to look
9118 ;; up if the key has an associated command in another currently active
9119 ;; keymap (minor modes, major mode, global), and executes that
9120 ;; command. There might be problems if any of the keys is otherwise
9121 ;; used as a prefix key.
9123 (defcustom orgstruct-heading-prefix-regexp ""
9124 "Regexp that matches the custom prefix of Org headlines in
9125 orgstruct(++)-mode."
9126 :group 'org
9127 :version "24.4"
9128 :package-version '(Org . "8.3")
9129 :type 'regexp)
9130 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9132 (defcustom orgstruct-setup-hook nil
9133 "Hook run after orgstruct-mode-map is filled."
9134 :group 'org
9135 :version "24.4"
9136 :package-version '(Org . "8.0")
9137 :type 'hook)
9139 (defvar orgstruct-initialized nil)
9141 (defvar org-local-vars nil
9142 "List of local variables, for use by `orgstruct-mode'.")
9144 ;;;###autoload
9145 (define-minor-mode orgstruct-mode
9146 "Toggle the minor mode `orgstruct-mode'.
9147 This mode is for using Org-mode structure commands in other
9148 modes. The following keys behave as if Org-mode were active, if
9149 the cursor is on a headline, or on a plain list item (both as
9150 defined by Org-mode)."
9151 nil " OrgStruct" (make-sparse-keymap)
9152 (funcall (if orgstruct-mode
9153 'add-to-invisibility-spec
9154 'remove-from-invisibility-spec)
9155 '(outline . t))
9156 (when orgstruct-mode
9157 (org-load-modules-maybe)
9158 (unless orgstruct-initialized
9159 (orgstruct-setup)
9160 (setq orgstruct-initialized t))))
9162 ;;;###autoload
9163 (defun turn-on-orgstruct ()
9164 "Unconditionally turn on `orgstruct-mode'."
9165 (orgstruct-mode 1))
9167 (defvar org-fb-vars nil)
9168 (make-variable-buffer-local 'org-fb-vars)
9169 (defun orgstruct++-mode (&optional arg)
9170 "Toggle `orgstruct-mode', the enhanced version of it.
9171 In addition to setting orgstruct-mode, this also exports all
9172 indentation and autofilling variables from org-mode into the
9173 buffer. It will also recognize item context in multiline items."
9174 (interactive "P")
9175 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9176 (if (< arg 1)
9177 (progn (orgstruct-mode -1)
9178 (mapc (lambda(v)
9179 (org-set-local (car v)
9180 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9181 org-fb-vars))
9182 (orgstruct-mode 1)
9183 (setq org-fb-vars nil)
9184 (unless org-local-vars
9185 (setq org-local-vars (org-get-local-variables)))
9186 (let (var val)
9187 (mapc
9188 (lambda (x)
9189 (when (string-match
9190 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9191 (symbol-name (car x)))
9192 (setq var (car x) val (nth 1 x))
9193 (push (list var `(quote ,(eval var))) org-fb-vars)
9194 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9195 org-local-vars)
9196 (org-set-local 'orgstruct-is-++ t))))
9198 (defvar orgstruct-is-++ nil
9199 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9200 (make-variable-buffer-local 'orgstruct-is-++)
9202 ;;;###autoload
9203 (defun turn-on-orgstruct++ ()
9204 "Unconditionally turn on `orgstruct++-mode'."
9205 (orgstruct++-mode 1))
9207 (defun orgstruct-error ()
9208 "Error when there is no default binding for a structure key."
9209 (interactive)
9210 (funcall (if (fboundp 'user-error)
9211 'user-error
9212 'error)
9213 "This key has no function outside structure elements"))
9215 (defun orgstruct-setup ()
9216 "Setup orgstruct keymap."
9217 (dolist (cell '((org-demote . t)
9218 (org-metaleft . t)
9219 (org-metaright . t)
9220 (org-promote . t)
9221 (org-shiftmetaleft . t)
9222 (org-shiftmetaright . t)
9223 org-backward-element
9224 org-backward-heading-same-level
9225 org-ctrl-c-ret
9226 org-ctrl-c-minus
9227 org-ctrl-c-star
9228 org-cycle
9229 org-forward-heading-same-level
9230 org-insert-heading
9231 org-insert-heading-respect-content
9232 org-kill-note-or-show-branches
9233 org-mark-subtree
9234 org-meta-return
9235 org-metadown
9236 org-metaup
9237 org-narrow-to-subtree
9238 org-promote-subtree
9239 org-reveal
9240 org-shiftdown
9241 org-shiftleft
9242 org-shiftmetadown
9243 org-shiftmetaup
9244 org-shiftright
9245 org-shifttab
9246 org-shifttab
9247 org-shiftup
9248 org-show-subtree
9249 org-sort
9250 org-up-element
9251 outline-demote
9252 outline-next-visible-heading
9253 outline-previous-visible-heading
9254 outline-promote
9255 outline-up-heading
9256 show-children))
9257 (let ((f (or (car-safe cell) cell))
9258 (disable-when-heading-prefix (cdr-safe cell)))
9259 (when (fboundp f)
9260 (let ((new-bindings))
9261 (dolist (binding (nconc (where-is-internal f org-mode-map)
9262 (where-is-internal f outline-mode-map)))
9263 (push binding new-bindings)
9264 ;; TODO use local-function-key-map
9265 (dolist (rep '(("<tab>" . "TAB")
9266 ("<return>" . "RET")
9267 ("<escape>" . "ESC")
9268 ("<delete>" . "DEL")))
9269 (setq binding (read-kbd-macro
9270 (let ((case-fold-search))
9271 (replace-regexp-in-string
9272 (regexp-quote (cdr rep))
9273 (car rep)
9274 (key-description binding)))))
9275 (pushnew binding new-bindings :test 'equal)))
9276 (dolist (binding new-bindings)
9277 (let ((key (lookup-key orgstruct-mode-map binding)))
9278 (when (or (not key) (numberp key))
9279 (ignore-errors
9280 (org-defkey orgstruct-mode-map
9281 binding
9282 (orgstruct-make-binding
9283 f binding disable-when-heading-prefix))))))))))
9284 (run-hooks 'orgstruct-setup-hook))
9286 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9287 "Create a function for binding in the structure minor mode.
9288 FUN is the command to call inside a table. KEY is the key that
9289 should be checked in for a command to execute outside of tables.
9290 Non-nil `disable-when-heading-prefix' means to disable the command
9291 if `orgstruct-heading-prefix-regexp' is not empty."
9292 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9293 (let ((nname name)
9294 (i 0))
9295 (while (fboundp (intern nname))
9296 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9297 (setq name (intern nname)))
9298 (eval
9299 (let ((bindings '((org-heading-regexp
9300 (concat "^"
9301 orgstruct-heading-prefix-regexp
9302 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9303 (org-outline-regexp
9304 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9305 (org-outline-regexp-bol
9306 (concat "^" org-outline-regexp))
9307 (outline-regexp org-outline-regexp)
9308 (outline-heading-end-regexp "\n")
9309 (outline-level 'org-outline-level)
9310 (outline-heading-alist))))
9311 `(defun ,name (arg)
9312 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9313 "Outside of structure, run the binding of `"
9314 (key-description key) "'."
9315 (when disable-when-heading-prefix
9316 (concat
9317 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9318 "back to the default binding due to limitations of Org's implementation of\n"
9319 "`" (symbol-name fun) "'.")))
9320 (interactive "p")
9321 (let* ((disable
9322 ,(and disable-when-heading-prefix
9323 '(not (string= orgstruct-heading-prefix-regexp ""))))
9324 (fallback
9325 (or disable
9326 (not
9327 (let* ,bindings
9328 (org-context-p 'headline 'item
9329 ,(when (memq fun
9330 '(org-insert-heading
9331 org-insert-heading-respect-content
9332 org-meta-return))
9333 '(when orgstruct-is-++
9334 'item-body))))))))
9335 (if fallback
9336 (let* ((orgstruct-mode)
9337 (binding
9338 (let ((key ,key))
9339 (catch 'exit
9340 (dolist
9341 (rep
9342 '(nil
9343 ("<\\([^>]*\\)tab>" . "\\1TAB")
9344 ("<\\([^>]*\\)return>" . "\\1RET")
9345 ("<\\([^>]*\\)escape>" . "\\1ESC")
9346 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9347 nil)
9348 (when rep
9349 (setq key (read-kbd-macro
9350 (let ((case-fold-search))
9351 (replace-regexp-in-string
9352 (car rep)
9353 (cdr rep)
9354 (key-description key))))))
9355 (when (key-binding key)
9356 (throw 'exit (key-binding key))))))))
9357 (if (keymapp binding)
9358 (org-set-transient-map binding)
9359 (let ((func (or binding
9360 (unless disable
9361 'orgstruct-error))))
9362 (when func
9363 (call-interactively func)))))
9364 (org-run-like-in-org-mode
9365 (lambda ()
9366 (interactive)
9367 (let* ,bindings
9368 (call-interactively ',fun)))))))))
9369 name))
9371 (defun org-contextualize-keys (alist contexts)
9372 "Return valid elements in ALIST depending on CONTEXTS.
9374 `org-agenda-custom-commands' or `org-capture-templates' are the
9375 values used for ALIST, and `org-agenda-custom-commands-contexts'
9376 or `org-capture-templates-contexts' are the associated contexts
9377 definitions."
9378 (let ((contexts
9379 ;; normalize contexts
9380 (mapcar
9381 (lambda(c) (cond ((listp (cadr c))
9382 (list (car c) (car c) (cadr c)))
9383 ((string= "" (cadr c))
9384 (list (car c) (car c) (caddr c)))
9385 (t c))) contexts))
9386 (a alist) c r s)
9387 ;; loop over all commands or templates
9388 (while (setq c (pop a))
9389 (let (vrules repl)
9390 (cond
9391 ((not (assoc (car c) contexts))
9392 (push c r))
9393 ((and (assoc (car c) contexts)
9394 (setq vrules (org-contextualize-validate-key
9395 (car c) contexts)))
9396 (mapc (lambda (vr)
9397 (when (not (equal (car vr) (cadr vr)))
9398 (setq repl vr))) vrules)
9399 (if (not repl) (push c r)
9400 (push (cadr repl) s)
9401 (push
9402 (cons (car c)
9403 (cdr (or (assoc (cadr repl) alist)
9404 (error "Undefined key `%s' as contextual replacement for `%s'"
9405 (cadr repl) (car c)))))
9406 r))))))
9407 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9408 (delq
9410 (delete-dups
9411 (mapcar (lambda (x)
9412 (let ((tpl (car x)))
9413 (when (not (delq
9415 (mapcar (lambda(y)
9416 (equal y tpl)) s))) x)))
9417 (reverse r))))))
9419 (defun org-contextualize-validate-key (key contexts)
9420 "Check CONTEXTS for agenda or capture KEY."
9421 (let (r rr res)
9422 (while (setq r (pop contexts))
9423 (mapc
9424 (lambda (rr)
9425 (when
9426 (and (equal key (car r))
9427 (if (functionp rr) (funcall rr)
9428 (or (and (eq (car rr) 'in-file)
9429 (buffer-file-name)
9430 (string-match (cdr rr) (buffer-file-name)))
9431 (and (eq (car rr) 'in-mode)
9432 (string-match (cdr rr) (symbol-name major-mode)))
9433 (and (eq (car rr) 'in-buffer)
9434 (string-match (cdr rr) (buffer-name)))
9435 (when (and (eq (car rr) 'not-in-file)
9436 (buffer-file-name))
9437 (not (string-match (cdr rr) (buffer-file-name))))
9438 (when (eq (car rr) 'not-in-mode)
9439 (not (string-match (cdr rr) (symbol-name major-mode))))
9440 (when (eq (car rr) 'not-in-buffer)
9441 (not (string-match (cdr rr) (buffer-name)))))))
9442 (push r res)))
9443 (car (last r))))
9444 (delete-dups (delq nil res))))
9446 (defun org-context-p (&rest contexts)
9447 "Check if local context is any of CONTEXTS.
9448 Possible values in the list of contexts are `table', `headline', and `item'."
9449 (let ((pos (point)))
9450 (goto-char (point-at-bol))
9451 (prog1 (or (and (memq 'table contexts)
9452 (looking-at "[ \t]*|"))
9453 (and (memq 'headline contexts)
9454 (looking-at org-outline-regexp))
9455 (and (memq 'item contexts)
9456 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9457 (and (memq 'item-body contexts)
9458 (org-in-item-p)))
9459 (goto-char pos))))
9461 (defun org-get-local-variables ()
9462 "Return a list of all local variables in an Org mode buffer."
9463 (let (varlist)
9464 (with-current-buffer (get-buffer-create "*Org tmp*")
9465 (erase-buffer)
9466 (org-mode)
9467 (setq varlist (buffer-local-variables)))
9468 (kill-buffer "*Org tmp*")
9469 (delq nil
9470 (mapcar
9471 (lambda (x)
9472 (setq x
9473 (if (symbolp x)
9474 (list x)
9475 (list (car x) (cdr x))))
9476 (if (and (not (get (car x) 'org-state))
9477 (string-match
9478 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9479 (symbol-name (car x))))
9480 x nil))
9481 varlist))))
9483 (defun org-clone-local-variables (from-buffer &optional regexp)
9484 "Clone local variables from FROM-BUFFER.
9485 Optional argument REGEXP selects variables to clone."
9486 (mapc
9487 (lambda (pair)
9488 (and (symbolp (car pair))
9489 (or (null regexp)
9490 (string-match regexp (symbol-name (car pair))))
9491 (set (make-local-variable (car pair))
9492 (cdr pair))))
9493 (buffer-local-variables from-buffer)))
9495 ;;;###autoload
9496 (defun org-run-like-in-org-mode (cmd)
9497 "Run a command, pretending that the current buffer is in Org-mode.
9498 This will temporarily bind local variables that are typically bound in
9499 Org-mode to the values they have in Org-mode, and then interactively
9500 call CMD."
9501 (org-load-modules-maybe)
9502 (unless org-local-vars
9503 (setq org-local-vars (org-get-local-variables)))
9504 (let (binds)
9505 (dolist (var org-local-vars)
9506 (when (or (not (boundp (car var)))
9507 (eq (symbol-value (car var))
9508 (default-value (car var))))
9509 (push (list (car var) `(quote ,(cadr var))) binds)))
9510 (eval `(let ,binds
9511 (call-interactively (quote ,cmd))))))
9513 (defun org-get-category (&optional pos force-refresh)
9514 "Get the category applying to position POS."
9515 (save-match-data
9516 (if force-refresh (org-refresh-category-properties))
9517 (let ((pos (or pos (point))))
9518 (or (get-text-property pos 'org-category)
9519 (progn (org-refresh-category-properties)
9520 (get-text-property pos 'org-category))))))
9522 ;;; Refresh properties
9524 (defun org-refresh-properties (dprop tprop)
9525 "Refresh buffer text properties.
9526 DPROP is the drawer property and TPROP is either the
9527 corresponding text property to set, or an alist with each element
9528 being a text property (as a symbol) and a function to apply to
9529 the value of the drawer property."
9530 (let ((case-fold-search t)
9531 (inhibit-read-only t))
9532 (org-with-silent-modifications
9533 (save-excursion
9534 (save-restriction
9535 (widen)
9536 (goto-char (point-min))
9537 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9538 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9540 (defun org-refresh-property (tprop p)
9541 "Refresh the buffer text property TPROP from the drawer property P.
9542 The refresh happens only for the current tree (not subtree)."
9543 (save-excursion
9544 (org-back-to-heading t)
9545 ;; tprop is a text property symbol
9546 (if (symbolp tprop)
9547 (put-text-property
9548 (point) (or (outline-next-heading) (point-max)) tprop p)
9549 ;; tprop is an alist with (properties . function) elements
9550 (mapc (lambda(al)
9551 (save-excursion
9552 (put-text-property
9553 (point-at-bol) (or (outline-next-heading) (point-max))
9554 (car al)
9555 (funcall (cdr al) p))))
9556 tprop))))
9558 (defun org-refresh-category-properties ()
9559 "Refresh category text properties in the buffer."
9560 (let ((case-fold-search t)
9561 (inhibit-read-only t)
9562 (def-cat (cond
9563 ((null org-category)
9564 (if buffer-file-name
9565 (file-name-sans-extension
9566 (file-name-nondirectory buffer-file-name))
9567 "???"))
9568 ((symbolp org-category) (symbol-name org-category))
9569 (t org-category)))
9570 beg end cat pos optionp)
9571 (org-with-silent-modifications
9572 (save-excursion
9573 (save-restriction
9574 (widen)
9575 (goto-char (point-min))
9576 (put-text-property (point) (point-max) 'org-category def-cat)
9577 (while (re-search-forward
9578 "^[ \t]*\\(\\(?:#\\+\\|:\\)CATEGORY:\\)\\(.*\\)" nil t)
9579 (setq pos (match-end 0)
9580 optionp (equal (char-after (match-beginning 0)) ?#)
9581 cat (org-trim (match-string 2)))
9582 (if optionp
9583 (setq beg (point-at-bol) end (point-max))
9584 (org-back-to-heading t)
9585 (setq beg (point) end (org-end-of-subtree t t)))
9586 (put-text-property beg end 'org-category cat)
9587 (goto-char pos)))))))
9589 (defun org-refresh-stats-properties ()
9590 "Refresh stats text properties in the buffer."
9591 (let (stats)
9592 (org-with-silent-modifications
9593 (save-excursion
9594 (save-restriction
9595 (widen)
9596 (goto-char (point-min))
9597 (while (re-search-forward
9598 (concat org-outline-regexp-bol ".*"
9599 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9600 nil t)
9601 (setq stats (cond ((equal (match-string 3) "0") 0)
9602 ((match-string 2)
9603 (/ (* (string-to-number (match-string 2)) 100)
9604 (string-to-number (match-string 3))))
9605 (t (string-to-number (match-string 1)))))
9606 (org-back-to-heading t)
9607 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9608 'org-stats stats)))))))
9610 (defun org-refresh-effort-properties ()
9611 "Refresh effort properties"
9612 (org-refresh-properties
9613 org-effort-property
9614 '((effort . identity)
9615 (effort-minutes . org-duration-string-to-minutes))))
9617 ;;;; Link Stuff
9619 ;;; Link abbreviations
9621 (defun org-link-expand-abbrev (link)
9622 "Apply replacements as defined in `org-link-abbrev-alist'."
9623 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9624 (let* ((key (match-string 1 link))
9625 (as (or (assoc key org-link-abbrev-alist-local)
9626 (assoc key org-link-abbrev-alist)))
9627 (tag (and (match-end 2) (match-string 3 link)))
9628 rpl)
9629 (if (not as)
9630 link
9631 (setq rpl (cdr as))
9632 (cond
9633 ((symbolp rpl) (funcall rpl tag))
9634 ((string-match "%(\\([^)]+\\))" rpl)
9635 (replace-match
9636 (save-match-data
9637 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9638 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9639 ((string-match "%h" rpl)
9640 (replace-match (url-hexify-string (or tag "")) t t rpl))
9641 (t (concat rpl tag)))))
9642 link))
9644 ;;; Storing and inserting links
9646 (defvar org-insert-link-history nil
9647 "Minibuffer history for links inserted with `org-insert-link'.")
9649 (defvar org-stored-links nil
9650 "Contains the links stored with `org-store-link'.")
9652 (defvar org-store-link-plist nil
9653 "Plist with info about the most recently link created with `org-store-link'.")
9655 (defvar org-link-protocols nil
9656 "Link protocols added to Org-mode using `org-add-link-type'.")
9658 (defvar org-store-link-functions nil
9659 "List of functions that are called to create and store a link.
9660 Each function will be called in turn until one returns a non-nil
9661 value. Each function should check if it is responsible for creating
9662 this link (for example by looking at the major mode).
9663 If not, it must exit and return nil.
9664 If yes, it should return a non-nil value after a calling
9665 `org-store-link-props' with a list of properties and values.
9666 Special properties are:
9668 :type The link prefix, like \"http\". This must be given.
9669 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9670 This is obligatory as well.
9671 :description Optional default description for the second pair
9672 of brackets in an Org-mode link. The user can still change
9673 this when inserting this link into an Org-mode buffer.
9675 In addition to these, any additional properties can be specified
9676 and then used in capture templates.")
9678 (defun org-add-link-type (type &optional follow export)
9679 "Add TYPE to the list of `org-link-types'.
9680 Re-compute all regular expressions depending on `org-link-types'
9682 FOLLOW and EXPORT are two functions.
9684 FOLLOW should take the link path as the single argument and do whatever
9685 is necessary to follow the link, for example find a file or display
9686 a mail message.
9688 EXPORT should format the link path for export to one of the export formats.
9689 It should be a function accepting three arguments:
9691 path the path of the link, the text after the prefix (like \"http:\")
9692 desc the description of the link, if any, or a description added by
9693 org-export-normalize-links if there is none
9694 format the export format, a symbol like `html' or `latex' or `ascii'..
9696 The function may use the FORMAT information to return different values
9697 depending on the format. The return value will be put literally into
9698 the exported file. If the return value is nil, this means Org should
9699 do what it normally does with links which do not have EXPORT defined.
9701 Org mode has a built-in default for exporting links. If you are happy with
9702 this default, there is no need to define an export function for the link
9703 type. For a simple example of an export function, see `org-bbdb.el'."
9704 (add-to-list 'org-link-types type t)
9705 (org-make-link-regexps)
9706 (org-element-update-syntax)
9707 (if (assoc type org-link-protocols)
9708 (setcdr (assoc type org-link-protocols) (list follow export))
9709 (push (list type follow export) org-link-protocols)))
9711 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9712 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9714 ;;;###autoload
9715 (defun org-store-link (arg)
9716 "\\<org-mode-map>Store an org-link to the current location.
9717 This link is added to `org-stored-links' and can later be inserted
9718 into an org-buffer with \\[org-insert-link].
9720 For some link types, a prefix arg is interpreted.
9721 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9722 For file links, arg negates `org-context-in-file-links'.
9724 A double prefix arg force skipping storing functions that are not
9725 part of Org's core.
9727 A triple prefix arg force storing a link for each line in the
9728 active region."
9729 (interactive "P")
9730 (org-load-modules-maybe)
9731 (if (and (equal arg '(64)) (org-region-active-p))
9732 (save-excursion
9733 (let ((end (region-end)))
9734 (goto-char (region-beginning))
9735 (set-mark (point))
9736 (while (< (point-at-eol) end)
9737 (move-end-of-line 1) (activate-mark)
9738 (let (current-prefix-arg)
9739 (call-interactively 'org-store-link))
9740 (move-beginning-of-line 2)
9741 (set-mark (point)))))
9742 (org-with-limited-levels
9743 (setq org-store-link-plist nil)
9744 (let (link cpltxt desc description search
9745 txt custom-id agenda-link sfuns sfunsn)
9746 (cond
9748 ;; Store a link using an external link type
9749 ((and (not (equal arg '(16)))
9750 (setq sfuns
9751 (delq
9752 nil (mapcar (lambda (f)
9753 (let (fs) (if (funcall f) (push f fs))))
9754 org-store-link-functions))
9755 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9756 (or (and (cdr sfuns)
9757 (funcall (intern
9758 (completing-read
9759 "Which function for creating the link? "
9760 sfunsn nil t (car sfunsn)))))
9761 (funcall (caar sfuns)))
9762 (setq link (plist-get org-store-link-plist :link)
9763 desc (or (plist-get org-store-link-plist
9764 :description) link))))
9766 ;; Store a link from a source code buffer
9767 ((org-src-edit-buffer-p)
9768 (let (label gc)
9769 (while (or (not label)
9770 (save-excursion
9771 (save-restriction
9772 (widen)
9773 (goto-char (point-min))
9774 (re-search-forward
9775 (regexp-quote (format org-coderef-label-format label))
9776 nil t))))
9777 (when label (message "Label exists already") (sit-for 2))
9778 (setq label (read-string "Code line label: " label)))
9779 (end-of-line 1)
9780 (setq link (format org-coderef-label-format label))
9781 (setq gc (- 79 (length link)))
9782 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9783 (insert link)
9784 (setq link (concat "(" label ")") desc nil)))
9786 ;; We are in the agenda, link to referenced location
9787 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9788 (let ((m (or (get-text-property (point) 'org-hd-marker)
9789 (get-text-property (point) 'org-marker))))
9790 (when m
9791 (org-with-point-at m
9792 (setq agenda-link
9793 (if (org-called-interactively-p 'any)
9794 (call-interactively 'org-store-link)
9795 (org-store-link nil)))))))
9797 ((eq major-mode 'calendar-mode)
9798 (let ((cd (calendar-cursor-to-date)))
9799 (setq link
9800 (format-time-string
9801 (car org-time-stamp-formats)
9802 (apply 'encode-time
9803 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9804 nil nil nil))))
9805 (org-store-link-props :type "calendar" :date cd)))
9807 ((eq major-mode 'help-mode)
9808 (setq link (concat "help:" (save-excursion
9809 (goto-char (point-min))
9810 (looking-at "^[^ ]+")
9811 (match-string 0))))
9812 (org-store-link-props :type "help"))
9814 ((eq major-mode 'w3-mode)
9815 (setq cpltxt (if (and (buffer-name)
9816 (not (string-match "Untitled" (buffer-name))))
9817 (buffer-name)
9818 (url-view-url t))
9819 link (url-view-url t))
9820 (org-store-link-props :type "w3" :url (url-view-url t)))
9822 ((eq major-mode 'image-mode)
9823 (setq cpltxt (concat "file:"
9824 (abbreviate-file-name buffer-file-name))
9825 link cpltxt)
9826 (org-store-link-props :type "image" :file buffer-file-name))
9828 ;; In dired, store a link to the file of the current line
9829 ((derived-mode-p 'dired-mode)
9830 (let ((file (dired-get-filename nil t)))
9831 (setq file (if file
9832 (abbreviate-file-name
9833 (expand-file-name (dired-get-filename nil t)))
9834 ;; otherwise, no file so use current directory.
9835 default-directory))
9836 (setq cpltxt (concat "file:" file)
9837 link cpltxt)))
9839 ((setq search (run-hook-with-args-until-success
9840 'org-create-file-search-functions))
9841 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9842 "::" search))
9843 (setq cpltxt (or description link)))
9845 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9846 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9847 (cond
9848 ;; Store a link using the target at point
9849 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9850 (setq cpltxt
9851 (concat "file:"
9852 (abbreviate-file-name
9853 (buffer-file-name (buffer-base-buffer)))
9854 "::" (match-string 1))
9855 link cpltxt))
9856 ((and (featurep 'org-id)
9857 (or (eq org-id-link-to-org-use-id t)
9858 (and (org-called-interactively-p 'any)
9859 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9860 (and (eq org-id-link-to-org-use-id
9861 'create-if-interactive-and-no-custom-id)
9862 (not custom-id))))
9863 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9864 ;; Store a link using the ID at point
9865 (setq link (condition-case nil
9866 (prog1 (org-id-store-link)
9867 (setq desc (or (plist-get org-store-link-plist
9868 :description)
9869 "")))
9870 (error
9871 ;; Probably before first headline, link only to file
9872 (concat "file:"
9873 (abbreviate-file-name
9874 (buffer-file-name (buffer-base-buffer))))))))
9876 ;; Just link to current headline
9877 (setq cpltxt (concat "file:"
9878 (abbreviate-file-name
9879 (buffer-file-name (buffer-base-buffer)))))
9880 ;; Add a context search string
9881 (when (org-xor org-context-in-file-links arg)
9882 (let* ((ee (org-element-at-point))
9883 (et (org-element-type ee))
9884 (ev (plist-get (cadr ee) :value))
9885 (ek (plist-get (cadr ee) :key))
9886 (eok (and (stringp ek) (string-match "name" ek))))
9887 (setq txt (cond
9888 ((org-at-heading-p) nil)
9889 ((and (eq et 'keyword) eok) ev)
9890 ((org-region-active-p)
9891 (buffer-substring (region-beginning) (region-end)))))
9892 (when (or (null txt) (string-match "\\S-" txt))
9893 (setq cpltxt
9894 (concat cpltxt "::"
9895 (condition-case nil
9896 (org-make-org-heading-search-string txt)
9897 (error "")))
9898 desc (or (and (eq et 'keyword) eok ev)
9899 (nth 4 (ignore-errors (org-heading-components)))
9900 "NONE")))))
9901 (if (string-match "::\\'" cpltxt)
9902 (setq cpltxt (substring cpltxt 0 -2)))
9903 (setq link cpltxt))))
9905 ((buffer-file-name (buffer-base-buffer))
9906 ;; Just link to this file here.
9907 (setq cpltxt (concat "file:"
9908 (abbreviate-file-name
9909 (buffer-file-name (buffer-base-buffer)))))
9910 ;; Add a context string.
9911 (when (org-xor org-context-in-file-links arg)
9912 (setq txt (if (org-region-active-p)
9913 (buffer-substring (region-beginning) (region-end))
9914 (buffer-substring (point-at-bol) (point-at-eol))))
9915 ;; Only use search option if there is some text.
9916 (when (string-match "\\S-" txt)
9917 (setq cpltxt
9918 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9919 desc "NONE")))
9920 (setq link cpltxt))
9922 ((org-called-interactively-p 'interactive)
9923 (user-error "No method for storing a link from this buffer"))
9925 (t (setq link nil)))
9927 ;; We're done setting link and desc, clean up
9928 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9929 (setq link (or link cpltxt)
9930 desc (or desc cpltxt))
9931 (cond ((equal desc "NONE") (setq desc nil))
9932 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9933 (let ((d0 (match-string 3 desc))
9934 (p0 (match-string 5 desc)))
9935 (setq desc
9936 (replace-regexp-in-string
9937 org-bracket-link-regexp
9938 (concat (or p0 d0)
9939 (if (equal (length (match-string 0 desc))
9940 (length desc)) "*" "")) desc)))))
9942 ;; Return the link
9943 (if (not (and (or (org-called-interactively-p 'any)
9944 executing-kbd-macro) link))
9945 (or agenda-link (and link (org-make-link-string link desc)))
9946 (push (list link desc) org-stored-links)
9947 (message "Stored: %s" (or desc link))
9948 (when custom-id
9949 (setq link (concat "file:" (abbreviate-file-name
9950 (buffer-file-name)) "::#" custom-id))
9951 (push (list link desc) org-stored-links))
9952 (car org-stored-links))))))
9954 (defun org-store-link-props (&rest plist)
9955 "Store link properties, extract names and addresses."
9956 (let (x adr)
9957 (when (setq x (plist-get plist :from))
9958 (setq adr (mail-extract-address-components x))
9959 (setq plist (plist-put plist :fromname (car adr)))
9960 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9961 (when (setq x (plist-get plist :to))
9962 (setq adr (mail-extract-address-components x))
9963 (setq plist (plist-put plist :toname (car adr)))
9964 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9965 (let ((from (plist-get plist :from))
9966 (to (plist-get plist :to)))
9967 (when (and from to org-from-is-user-regexp)
9968 (setq plist
9969 (plist-put plist :fromto
9970 (if (string-match org-from-is-user-regexp from)
9971 (concat "to %t")
9972 (concat "from %f"))))))
9973 (setq org-store-link-plist plist))
9975 (defun org-add-link-props (&rest plist)
9976 "Add these properties to the link property list."
9977 (let (key value)
9978 (while plist
9979 (setq key (pop plist) value (pop plist))
9980 (setq org-store-link-plist
9981 (plist-put org-store-link-plist key value)))))
9983 (defun org-email-link-description (&optional fmt)
9984 "Return the description part of an email link.
9985 This takes information from `org-store-link-plist' and formats it
9986 according to FMT (default from `org-email-link-description-format')."
9987 (setq fmt (or fmt org-email-link-description-format))
9988 (let* ((p org-store-link-plist)
9989 (to (plist-get p :toaddress))
9990 (from (plist-get p :fromaddress))
9991 (table
9992 (list
9993 (cons "%c" (plist-get p :fromto))
9994 (cons "%F" (plist-get p :from))
9995 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9996 (cons "%T" (plist-get p :to))
9997 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9998 (cons "%s" (plist-get p :subject))
9999 (cons "%d" (plist-get p :date))
10000 (cons "%m" (plist-get p :message-id)))))
10001 (when (string-match "%c" fmt)
10002 ;; Check if the user wrote this message
10003 (if (and org-from-is-user-regexp from to
10004 (save-match-data (string-match org-from-is-user-regexp from)))
10005 (setq fmt (replace-match "to %t" t t fmt))
10006 (setq fmt (replace-match "from %f" t t fmt))))
10007 (org-replace-escapes fmt table)))
10009 (defun org-make-org-heading-search-string (&optional string)
10010 "Make search string for the current headline or STRING."
10011 (let ((s (or string
10012 (and (derived-mode-p 'org-mode)
10013 (save-excursion
10014 (org-back-to-heading t)
10015 (org-element-property :raw-value (org-element-at-point))))))
10016 (lines org-context-in-file-links))
10017 (or string (setq s (concat "*" s))) ; Add * for headlines
10018 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10019 (when (and string (integerp lines) (> lines 0))
10020 (let ((slines (org-split-string s "\n")))
10021 (when (< lines (length slines))
10022 (setq s (mapconcat
10023 'identity
10024 (reverse (nthcdr (- (length slines) lines)
10025 (reverse slines))) "\n")))))
10026 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10028 (defun org-make-link-string (link &optional description)
10029 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10030 (unless (string-match "\\S-" link)
10031 (error "Empty link"))
10032 (when (and description
10033 (stringp description)
10034 (not (string-match "\\S-" description)))
10035 (setq description nil))
10036 (when (stringp description)
10037 ;; Remove brackets from the description, they are fatal.
10038 (while (string-match "\\[" description)
10039 (setq description (replace-match "{" t t description)))
10040 (while (string-match "\\]" description)
10041 (setq description (replace-match "}" t t description))))
10042 (when (equal link description)
10043 ;; No description needed, it is identical
10044 (setq description nil))
10045 (when (and (not description)
10046 (not (string-match (org-image-file-name-regexp) link))
10047 (not (equal link (org-link-escape link))))
10048 (setq description (org-extract-attributes link)))
10049 (setq link
10050 (cond ((string-match (org-image-file-name-regexp) link) link)
10051 ((string-match org-link-types-re link)
10052 (concat (match-string 1 link)
10053 (org-link-escape (substring link (match-end 1)))))
10054 (t (org-link-escape link))))
10055 (concat "[[" link "]"
10056 (if description (concat "[" description "]") "")
10057 "]"))
10059 (defconst org-link-escape-chars
10060 ;;%20 %5B %5D
10061 '(?\ ?\[ ?\])
10062 "List of characters that should be escaped in a link when stored to Org.
10063 This is the list that is used for internal purposes.")
10065 (defconst org-link-escape-chars-browser
10066 ;;%20 %22
10067 '(?\ ?\")
10068 "List of characters to be escaped before handing over to the browser.
10069 If you consider using this constant then you probably want to use
10070 the function `org-link-escape-browser' instead. See there why
10071 this constant is a candidate to be removed once Org drops support
10072 for Emacs 24.1 and 24.2.")
10074 (defun org-link-escape (text &optional table merge)
10075 "Return percent escaped representation of TEXT.
10076 TEXT is a string with the text to escape.
10077 Optional argument TABLE is a list with characters that should be
10078 escaped. When nil, `org-link-escape-chars' is used.
10079 If optional argument MERGE is set, merge TABLE into
10080 `org-link-escape-chars'."
10081 ;; Don't escape chars in internal links
10082 (if (string-match "^\\*[[:alnum:]]+" text)
10083 text
10084 (cond
10085 ((and table merge)
10086 (mapc (lambda (defchr)
10087 (unless (member defchr table)
10088 (setq table (cons defchr table))))
10089 org-link-escape-chars))
10090 ((null table)
10091 (setq table org-link-escape-chars)))
10092 (mapconcat
10093 (lambda (char)
10094 (if (or (member char table)
10095 (and (or (< char 32) (= char ?\%) (> char 126))
10096 org-url-hexify-p))
10097 (mapconcat (lambda (sequence-element)
10098 (format "%%%.2X" sequence-element))
10099 (or (encode-coding-char char 'utf-8)
10100 (error "Unable to percent escape character: %s"
10101 (char-to-string char))) "")
10102 (char-to-string char))) text "")))
10104 (defun org-link-escape-browser (text)
10105 "Escape some characters before handing over to the browser.
10106 This function is a candidate to be removed together with the
10107 constant `org-link-escape-chars-browser' once Org drops support
10108 for Emacs 24.1 and 24.2. All calls to this function will have to
10109 be replaced with `url-encode-url' which is available since Emacs
10110 24.3.1."
10111 ;; Example with the Org link
10112 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10113 ;; to open the browser with +subject:"Release 8.2" filled into the
10114 ;; query field: In this case the variable TEXT contains the
10115 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10116 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10117 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10118 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10119 (if (fboundp 'url-encode-url)
10120 (url-encode-url text)
10121 (if (org-string-match-p
10122 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10123 text)
10124 (org-link-escape text org-link-escape-chars-browser)
10125 text)))
10127 (defun org-link-unescape (str)
10128 "Unhex hexified Unicode strings as returned from the JavaScript function
10129 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10130 (unless (and (null str) (string= "" str))
10131 (let ((pos 0) (case-fold-search t) unhexed)
10132 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10133 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10134 (setq str (replace-match unhexed t t str))
10135 (setq pos (+ pos (length unhexed))))))
10136 str)
10138 (defun org-link-unescape-compound (hex)
10139 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10140 Note: this function also decodes single byte encodings like
10141 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10142 (save-match-data
10143 (let* ((bytes (cdr (split-string hex "%")))
10144 (ret "")
10145 (eat 0)
10146 (sum 0))
10147 (while bytes
10148 (let* ((val (string-to-number (pop bytes) 16))
10149 (shift-xor
10150 (if (= 0 eat)
10151 (cond
10152 ((>= val 252) (cons 6 252))
10153 ((>= val 248) (cons 5 248))
10154 ((>= val 240) (cons 4 240))
10155 ((>= val 224) (cons 3 224))
10156 ((>= val 192) (cons 2 192))
10157 (t (cons 0 0)))
10158 (cons 6 128))))
10159 (if (>= val 192) (setq eat (car shift-xor)))
10160 (setq val (logxor val (cdr shift-xor)))
10161 (setq sum (+ (lsh sum (car shift-xor)) val))
10162 (if (> eat 0) (setq eat (- eat 1)))
10163 (cond
10164 ((= 0 eat) ;multi byte
10165 (setq ret (concat ret (org-char-to-string sum)))
10166 (setq sum 0))
10167 ((not bytes) ; single byte(s)
10168 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10169 ret)))
10171 (defun org-link-unescape-single-byte-sequence (hex)
10172 "Unhexify hex-encoded single byte character sequences."
10173 (mapconcat (lambda (byte)
10174 (char-to-string (string-to-number byte 16)))
10175 (cdr (split-string hex "%")) ""))
10177 (defun org-xor (a b)
10178 "Exclusive or."
10179 (if a (not b) b))
10181 (defun org-fixup-message-id-for-http (s)
10182 "Replace special characters in a message id, so it can be used in an http query."
10183 (when (string-match "%" s)
10184 (setq s (mapconcat (lambda (c)
10185 (if (eq c ?%)
10186 "%25"
10187 (char-to-string c)))
10188 s "")))
10189 (while (string-match "<" s)
10190 (setq s (replace-match "%3C" t t s)))
10191 (while (string-match ">" s)
10192 (setq s (replace-match "%3E" t t s)))
10193 (while (string-match "@" s)
10194 (setq s (replace-match "%40" t t s)))
10197 (defun org-link-prettify (link)
10198 "Return a human-readable representation of LINK.
10199 The car of LINK must be a raw link.
10200 The cdr of LINK must be either a link description or nil."
10201 (let ((desc (or (cadr link) "<no description>")))
10202 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10203 "<" (car link) ">")))
10205 ;;;###autoload
10206 (defun org-insert-link-global ()
10207 "Insert a link like Org-mode does.
10208 This command can be called in any mode to insert a link in Org-mode syntax."
10209 (interactive)
10210 (org-load-modules-maybe)
10211 (org-run-like-in-org-mode 'org-insert-link))
10213 (defun org-insert-all-links (arg &optional pre post)
10214 "Insert all links in `org-stored-links'.
10215 When a universal prefix, do not delete the links from `org-stored-links'.
10216 When `ARG' is a number, insert the last N link(s).
10217 `PRE' and `POST' are optional arguments to define a string to
10218 prepend or to append."
10219 (interactive "P")
10220 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10221 (links (copy-seq org-stored-links))
10222 (pr (or pre "- "))
10223 (po (or post "\n"))
10224 (cnt 1) l)
10225 (if (null org-stored-links)
10226 (message "No link to insert")
10227 (while (and (or (listp arg) (>= arg cnt))
10228 (setq l (if (listp arg)
10229 (pop links)
10230 (pop org-stored-links))))
10231 (setq cnt (1+ cnt))
10232 (insert pr)
10233 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10234 (insert po)))))
10236 (defun org-insert-last-stored-link (arg)
10237 "Insert the last link stored in `org-stored-links'."
10238 (interactive "p")
10239 (org-insert-all-links arg "" "\n"))
10241 (defun org-link-fontify-links-to-this-file ()
10242 "Fontify links to the current file in `org-stored-links'."
10243 (let ((f (buffer-file-name)) a b)
10244 (setq a (mapcar (lambda(l)
10245 (let ((ll (car l)))
10246 (when (and (string-match "^file:\\(.+\\)::" ll)
10247 (equal f (expand-file-name (match-string 1 ll))))
10248 ll)))
10249 org-stored-links))
10250 (when (featurep 'org-id)
10251 (setq b (mapcar (lambda(l)
10252 (let ((ll (car l)))
10253 (when (and (string-match "^id:\\(.+\\)$" ll)
10254 (equal f (expand-file-name
10255 (or (org-id-find-id-file
10256 (match-string 1 ll)) ""))))
10257 ll)))
10258 org-stored-links)))
10259 (mapcar (lambda(l)
10260 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10261 (delq nil (append a b)))))
10263 (defvar org-link-links-in-this-file nil)
10264 (defun org-insert-link (&optional complete-file link-location default-description)
10265 "Insert a link. At the prompt, enter the link.
10267 Completion can be used to insert any of the link protocol prefixes like
10268 http or ftp in use.
10270 The history can be used to select a link previously stored with
10271 `org-store-link'. When the empty string is entered (i.e. if you just
10272 press RET at the prompt), the link defaults to the most recently
10273 stored link. As SPC triggers completion in the minibuffer, you need to
10274 use M-SPC or C-q SPC to force the insertion of a space character.
10276 You will also be prompted for a description, and if one is given, it will
10277 be displayed in the buffer instead of the link.
10279 If there is already a link at point, this command will allow you to edit link
10280 and description parts.
10282 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10283 be selected using completion. The path to the file will be relative to the
10284 current directory if the file is in the current directory or a subdirectory.
10285 Otherwise, the link will be the absolute path as completed in the minibuffer
10286 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10287 option `org-link-file-path-type'.
10289 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10290 the current directory or below.
10292 With three \\[universal-argument] prefixes, negate the meaning of
10293 `org-keep-stored-link-after-insertion'.
10295 If `org-make-link-description-function' is non-nil, this function will be
10296 called with the link target, and the result will be the default
10297 link description.
10299 If the LINK-LOCATION parameter is non-nil, this value will be
10300 used as the link location instead of reading one interactively.
10302 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10303 be used as the default description."
10304 (interactive "P")
10305 (let* ((wcf (current-window-configuration))
10306 (origbuf (current-buffer))
10307 (region (if (org-region-active-p)
10308 (buffer-substring (region-beginning) (region-end))))
10309 (remove (and region (list (region-beginning) (region-end))))
10310 (desc region)
10311 tmphist ; byte-compile incorrectly complains about this
10312 (link link-location)
10313 (abbrevs org-link-abbrev-alist-local)
10314 entry file all-prefixes auto-desc)
10315 (cond
10316 (link-location) ; specified by arg, just use it.
10317 ((org-in-regexp org-bracket-link-regexp 1)
10318 ;; We do have a link at point, and we are going to edit it.
10319 (setq remove (list (match-beginning 0) (match-end 0)))
10320 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10321 (setq link (read-string "Link: "
10322 (org-link-unescape
10323 (org-match-string-no-properties 1)))))
10324 ((or (org-in-regexp org-angle-link-re)
10325 (org-in-regexp org-plain-link-re))
10326 ;; Convert to bracket link
10327 (setq remove (list (match-beginning 0) (match-end 0))
10328 link (read-string "Link: "
10329 (org-remove-angle-brackets (match-string 0)))))
10330 ((member complete-file '((4) (16)))
10331 ;; Completing read for file names.
10332 (setq link (org-file-complete-link complete-file)))
10334 ;; Read link, with completion for stored links.
10335 (org-link-fontify-links-to-this-file)
10336 (org-switch-to-buffer-other-window "*Org Links*")
10337 (with-current-buffer "*Org Links*"
10338 (erase-buffer)
10339 (insert "Insert a link.
10340 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10341 (when org-stored-links
10342 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10343 (insert (mapconcat 'org-link-prettify
10344 (reverse org-stored-links) "\n")))
10345 (goto-char (point-min)))
10346 (let ((cw (selected-window)))
10347 (select-window (get-buffer-window "*Org Links*" 'visible))
10348 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10349 (unless (pos-visible-in-window-p (point-max))
10350 (org-fit-window-to-buffer))
10351 (and (window-live-p cw) (select-window cw)))
10352 ;; Fake a link history, containing the stored links.
10353 (setq tmphist (append (mapcar 'car org-stored-links)
10354 org-insert-link-history))
10355 (setq all-prefixes (append (mapcar 'car abbrevs)
10356 (mapcar 'car org-link-abbrev-alist)
10357 org-link-types))
10358 (unwind-protect
10359 (progn
10360 (setq link
10361 (org-completing-read
10362 "Link: "
10363 (append
10364 (mapcar (lambda (x) (concat x ":"))
10365 all-prefixes)
10366 (mapcar 'car org-stored-links))
10367 nil nil nil
10368 'tmphist
10369 (caar org-stored-links)))
10370 (if (not (string-match "\\S-" link))
10371 (user-error "No link selected"))
10372 (mapc (lambda(l)
10373 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10374 org-stored-links)
10375 (if (or (member link all-prefixes)
10376 (and (equal ":" (substring link -1))
10377 (member (substring link 0 -1) all-prefixes)
10378 (setq link (substring link 0 -1))))
10379 (setq link (with-current-buffer origbuf
10380 (org-link-try-special-completion link)))))
10381 (set-window-configuration wcf)
10382 (kill-buffer "*Org Links*"))
10383 (setq entry (assoc link org-stored-links))
10384 (or entry (push link org-insert-link-history))
10385 (setq desc (or desc (nth 1 entry)))))
10387 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10388 (not org-keep-stored-link-after-insertion))
10389 (setq org-stored-links (delq (assoc link org-stored-links)
10390 org-stored-links)))
10392 (if (and (string-match org-plain-link-re link)
10393 (not (string-match org-ts-regexp link)))
10394 ;; URL-like link, normalize the use of angular brackets.
10395 (setq link (org-remove-angle-brackets link)))
10397 ;; Check if we are linking to the current file with a search
10398 ;; option If yes, simplify the link by using only the search
10399 ;; option.
10400 (when (and buffer-file-name
10401 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10402 (let* ((path (match-string 1 link))
10403 (case-fold-search nil)
10404 (search (match-string 2 link)))
10405 (save-match-data
10406 (if (equal (file-truename buffer-file-name) (file-truename path))
10407 ;; We are linking to this same file, with a search option
10408 (setq link search)))))
10410 ;; Check if we can/should use a relative path. If yes, simplify the link
10411 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10412 (let* ((type (match-string 1 link))
10413 (path (match-string 2 link))
10414 (origpath path)
10415 (case-fold-search nil))
10416 (cond
10417 ((or (eq org-link-file-path-type 'absolute)
10418 (equal complete-file '(16)))
10419 (setq path (abbreviate-file-name (expand-file-name path))))
10420 ((eq org-link-file-path-type 'noabbrev)
10421 (setq path (expand-file-name path)))
10422 ((eq org-link-file-path-type 'relative)
10423 (setq path (file-relative-name path)))
10425 (save-match-data
10426 (if (string-match (concat "^" (regexp-quote
10427 (expand-file-name
10428 (file-name-as-directory
10429 default-directory))))
10430 (expand-file-name path))
10431 ;; We are linking a file with relative path name.
10432 (setq path (substring (expand-file-name path)
10433 (match-end 0)))
10434 (setq path (abbreviate-file-name (expand-file-name path)))))))
10435 (setq link (concat type path))
10436 (if (equal desc origpath)
10437 (setq desc path))))
10439 (if org-make-link-description-function
10440 (setq desc
10441 (or (condition-case nil
10442 (funcall org-make-link-description-function link desc)
10443 (error (progn (message "Can't get link description from `%s'"
10444 (symbol-name org-make-link-description-function))
10445 (sit-for 2) nil)))
10446 (read-string "Description: " default-description)))
10447 (if default-description (setq desc default-description)
10448 (setq desc (or (and auto-desc desc)
10449 (read-string "Description: " desc)))))
10451 (unless (string-match "\\S-" desc) (setq desc nil))
10452 (if remove (apply 'delete-region remove))
10453 (insert (org-make-link-string link desc))))
10455 (defun org-link-try-special-completion (type)
10456 "If there is completion support for link type TYPE, offer it."
10457 (let ((fun (intern (concat "org-" type "-complete-link"))))
10458 (if (functionp fun)
10459 (funcall fun)
10460 (read-string "Link (no completion support): " (concat type ":")))))
10462 (defun org-file-complete-link (&optional arg)
10463 "Create a file link using completion."
10464 (let (file link)
10465 (setq file (org-iread-file-name "File: "))
10466 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10467 (pwd1 (file-name-as-directory (abbreviate-file-name
10468 (expand-file-name ".")))))
10469 (cond
10470 ((equal arg '(16))
10471 (setq link (concat
10472 "file:"
10473 (abbreviate-file-name (expand-file-name file)))))
10474 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10475 (setq link (concat "file:" (match-string 1 file))))
10476 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10477 (expand-file-name file))
10478 (setq link (concat
10479 "file:" (match-string 1 (expand-file-name file)))))
10480 (t (setq link (concat "file:" file)))))
10481 link))
10483 (defun org-iread-file-name (&rest args)
10484 "Read-file-name using `ido-mode' speedup if available.
10485 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10486 See `read-file-name' for a description of parameters."
10487 (org-without-partial-completion
10488 (if (and org-completion-use-ido
10489 (fboundp 'ido-read-file-name)
10490 (boundp 'ido-mode) ido-mode
10491 (listp (second args)))
10492 (let ((ido-enter-matching-directory nil))
10493 (apply 'ido-read-file-name args))
10494 (apply 'read-file-name args))))
10496 (defun org-completing-read (&rest args)
10497 "Completing-read with SPACE being a normal character."
10498 (let ((enable-recursive-minibuffers t)
10499 (minibuffer-local-completion-map
10500 (copy-keymap minibuffer-local-completion-map)))
10501 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10502 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10503 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10504 (apply 'org-icompleting-read args)))
10506 (defun org-completing-read-no-i (&rest args)
10507 (let (org-completion-use-ido org-completion-use-iswitchb)
10508 (apply 'org-completing-read args)))
10510 (defun org-iswitchb-completing-read (prompt choices &rest args)
10511 "Use iswitch as a completing-read replacement to choose from choices.
10512 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10513 from."
10514 (let* ((iswitchb-use-virtual-buffers nil)
10515 (iswitchb-make-buflist-hook
10516 (lambda ()
10517 (setq iswitchb-temp-buflist choices))))
10518 (iswitchb-read-buffer prompt)))
10520 (defun org-icompleting-read (&rest args)
10521 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10522 (org-without-partial-completion
10523 (if (and org-completion-use-ido
10524 (fboundp 'ido-completing-read)
10525 (boundp 'ido-mode) ido-mode
10526 (listp (second args)))
10527 (let ((ido-enter-matching-directory nil))
10528 (apply 'ido-completing-read (concat (car args))
10529 (if (consp (car (nth 1 args)))
10530 (mapcar 'car (nth 1 args))
10531 (nth 1 args))
10532 (cddr args)))
10533 (if (and org-completion-use-iswitchb
10534 (boundp 'iswitchb-mode) iswitchb-mode
10535 (listp (second args)))
10536 (apply 'org-iswitchb-completing-read (concat (car args))
10537 (if (consp (car (nth 1 args)))
10538 (mapcar 'car (nth 1 args))
10539 (nth 1 args))
10540 (cddr args))
10541 (apply 'completing-read args)))))
10543 (defun org-extract-attributes (s)
10544 "Extract the attributes cookie from a string and set as text property."
10545 (let (a attr (start 0) key value)
10546 (save-match-data
10547 (when (string-match "{{\\([^}]+\\)}}$" s)
10548 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10549 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10550 (setq key (match-string 1 a) value (match-string 2 a)
10551 start (match-end 0)
10552 attr (plist-put attr (intern key) value))))
10553 (org-add-props s nil 'org-attr attr))
10556 ;;; Opening/following a link
10558 (defvar org-link-search-failed nil)
10560 (defvar org-open-link-functions nil
10561 "Hook for functions finding a plain text link.
10562 These functions must take a single argument, the link content.
10563 They will be called for links that look like [[link text][description]]
10564 when LINK TEXT does not have a protocol like \"http:\" and does not look
10565 like a filename (e.g. \"./blue.png\").
10567 These functions will be called *before* Org attempts to resolve the
10568 link by doing text searches in the current buffer - so if you want a
10569 link \"[[target]]\" to still find \"<<target>>\", your function should
10570 handle this as a special case.
10572 When the function does handle the link, it must return a non-nil value.
10573 If it decides that it is not responsible for this link, it must return
10574 nil to indicate that that Org-mode can continue with other options
10575 like exact and fuzzy text search.")
10577 (defun org-next-link (&optional search-backward)
10578 "Move forward to the next link.
10579 If the link is in hidden text, expose it."
10580 (interactive "P")
10581 (when (and org-link-search-failed (eq this-command last-command))
10582 (goto-char (point-min))
10583 (message "Link search wrapped back to beginning of buffer"))
10584 (setq org-link-search-failed nil)
10585 (let* ((pos (point))
10586 (ct (org-context))
10587 (a (assoc :link ct))
10588 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10589 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10590 ((looking-at org-any-link-re)
10591 ;; Don't stay stuck at link without an org-link face
10592 (forward-char (if search-backward -1 1))))
10593 (if (funcall srch-fun org-any-link-re nil t)
10594 (progn
10595 (goto-char (match-beginning 0))
10596 (if (outline-invisible-p) (org-show-context)))
10597 (goto-char pos)
10598 (setq org-link-search-failed t)
10599 (message "No further link found"))))
10601 (defun org-previous-link ()
10602 "Move backward to the previous link.
10603 If the link is in hidden text, expose it."
10604 (interactive)
10605 (funcall 'org-next-link t))
10607 (defun org-translate-link (s)
10608 "Translate a link string if a translation function has been defined."
10609 (if (and org-link-translation-function
10610 (fboundp org-link-translation-function)
10611 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10612 (progn
10613 (setq s (funcall org-link-translation-function
10614 (match-string 1 s) (match-string 2 s)))
10615 (concat (car s) ":" (cdr s)))
10618 (defun org-translate-link-from-planner (type path)
10619 "Translate a link from Emacs Planner syntax so that Org can follow it.
10620 This is still an experimental function, your mileage may vary."
10621 (cond
10622 ((member type '("http" "https" "news" "ftp"))
10623 ;; standard Internet links are the same.
10624 nil)
10625 ((and (equal type "irc") (string-match "^//" path))
10626 ;; Planner has two / at the beginning of an irc link, we have 1.
10627 ;; We should have zero, actually....
10628 (setq path (substring path 1)))
10629 ((and (equal type "lisp") (string-match "^/" path))
10630 ;; Planner has a slash, we do not.
10631 (setq type "elisp" path (substring path 1)))
10632 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10633 ;; A typical message link. Planner has the id after the final slash,
10634 ;; we separate it with a hash mark
10635 (setq path (concat (match-string 1 path) "#"
10636 (org-remove-angle-brackets (match-string 2 path))))))
10637 (cons type path))
10639 (defun org-find-file-at-mouse (ev)
10640 "Open file link or URL at mouse."
10641 (interactive "e")
10642 (mouse-set-point ev)
10643 (org-open-at-point 'in-emacs))
10645 (defun org-open-at-mouse (ev)
10646 "Open file link or URL at mouse.
10647 See the docstring of `org-open-file' for details."
10648 (interactive "e")
10649 (mouse-set-point ev)
10650 (if (eq major-mode 'org-agenda-mode)
10651 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10652 (org-open-at-point))
10654 (defvar org-window-config-before-follow-link nil
10655 "The window configuration before following a link.
10656 This is saved in case the need arises to restore it.")
10658 (defvar org-open-link-marker (make-marker)
10659 "Marker pointing to the location where `org-open-at-point' was called.")
10661 ;;;###autoload
10662 (defun org-open-at-point-global ()
10663 "Follow a link like Org-mode does.
10664 This command can be called in any mode to follow a link that has
10665 Org-mode syntax."
10666 (interactive)
10667 (org-run-like-in-org-mode 'org-open-at-point))
10669 ;;;###autoload
10670 (defun org-open-link-from-string (s &optional arg reference-buffer)
10671 "Open a link in the string S, as if it was in Org-mode."
10672 (interactive "sLink: \nP")
10673 (let ((reference-buffer (or reference-buffer (current-buffer))))
10674 (with-temp-buffer
10675 (let ((org-inhibit-startup (not reference-buffer)))
10676 (org-mode)
10677 (insert s)
10678 (goto-char (point-min))
10679 (when reference-buffer
10680 (setq org-link-abbrev-alist-local
10681 (with-current-buffer reference-buffer
10682 org-link-abbrev-alist-local)))
10683 (org-open-at-point arg reference-buffer)))))
10685 (defvar org-open-at-point-functions nil
10686 "Hook that is run when following a link at point.
10688 Functions in this hook must return t if they identify and follow
10689 a link at point. If they don't find anything interesting at point,
10690 they must return nil.")
10692 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10693 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10694 (defun org-open-at-point (&optional arg reference-buffer)
10695 "Open link, timestamp, footnote or tags at point.
10697 When point is on a link, follow it. Normally, files will be
10698 opened by an appropriate application. If the optional prefix
10699 argument ARG is non-nil, Emacs will visit the file. With
10700 a double prefix argument, try to open outside of Emacs, in the
10701 application the system uses for this file type.
10703 When point is on a timestamp, open the agenda at the day
10704 specified.
10706 When point is a footnote definition, move to the first reference
10707 found. If it is on a reference, move to the associated
10708 definition.
10710 When point is on a headline, display a list of every link in the
10711 entry, so it is possible to pick one, or all, of them. If point
10712 is on a tag, call `org-tags-view' instead.
10714 When optional argument REFERENCE-BUFFER is non-nil, it should
10715 specify a buffer from where the link search should happen. This
10716 is used internally by `org-open-link-from-string'.
10718 On top of syntactically correct links, this function will open
10719 the link at point in comments or comment blocks and the first
10720 link in a property drawer line."
10721 (interactive "P")
10722 ;; On a code block, open block's results.
10723 (unless (call-interactively 'org-babel-open-src-block-result)
10724 (org-load-modules-maybe)
10725 (move-marker org-open-link-marker (point))
10726 (setq org-window-config-before-follow-link (current-window-configuration))
10727 (org-remove-occur-highlights nil nil t)
10728 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10729 (let* ((context (org-element-context)) type value)
10730 ;; On an unsupported type, check if point is contained within
10731 ;; a support one.
10732 (while (and (not (memq (setq type (org-element-type context))
10733 '(comment comment-block
10734 headline inlinetask link
10735 footnote-definition footnote-reference
10736 node-property timestamp)))
10737 (setq context (org-element-property :parent context))))
10738 (setq value (org-element-property :value context))
10739 (cond
10740 ;; Blank lines at the beginning of buffer: bail out.
10741 ((not context) (user-error "No link found"))
10742 ;; Exception n°1: links in property drawers
10743 ((eq type 'node-property)
10744 (org-open-link-from-string
10745 (and (string-match org-any-link-re value)
10746 (match-string-no-properties 0 value))))
10747 ;; Exception n°2: links in comments.
10748 ((memq type '(comment comment-block))
10749 (save-excursion
10750 (skip-chars-forward "\\S-" (point-at-eol))
10751 (let ((string-rear (replace-regexp-in-string
10752 "^[ \t]*# [ \t]*" ""
10753 (buffer-substring (point) (line-beginning-position))))
10754 (string-front (buffer-substring (point) (line-end-position))))
10755 (with-temp-buffer
10756 (let ((org-inhibit-startup t)) (org-mode))
10757 (insert value)
10758 (goto-char (point-min))
10759 (when (and (search-forward string-rear nil t)
10760 (search-forward string-front (line-end-position) t))
10761 (goto-char (match-beginning 0))
10762 (org-open-at-point)
10763 (when (string= string-rear "") (forward-char)))))))
10764 ;; On a headline or an inlinetask, but not on a timestamp,
10765 ;; a link, a footnote reference or on tags.
10766 ((and (memq type '(headline inlinetask))
10767 ;; Not on tags.
10768 (progn (save-excursion (beginning-of-line)
10769 (looking-at org-complex-heading-regexp))
10770 (or (not (match-beginning 5))
10771 (< (point) (match-beginning 5)))))
10772 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10773 (links (car data))
10774 (links-end (cdr data)))
10775 (if links
10776 (dolist (link (if (stringp links) (list links) links))
10777 (search-forward link nil links-end)
10778 (goto-char (match-beginning 0))
10779 (org-open-at-point))
10780 (require 'org-attach)
10781 (org-attach-reveal 'if-exists))))
10782 ;; Do nothing on white spaces after an object, unless point
10783 ;; is right after it.
10784 ((> (point)
10785 (save-excursion
10786 (goto-char (org-element-property :end context))
10787 (skip-chars-backward " \t")
10788 (point)))
10789 (user-error "No link found"))
10790 ((eq type 'timestamp) (org-follow-timestamp-link))
10791 ;; On tags within a headline or an inlinetask.
10792 ((and (memq type '(headline inlinetask))
10793 (progn (save-excursion (beginning-of-line)
10794 (looking-at org-complex-heading-regexp))
10795 (and (match-beginning 5)
10796 (>= (point) (match-beginning 5)))))
10797 (org-tags-view arg (substring (match-string 5) 0 -1)))
10798 ((eq type 'link)
10799 ;; When link is located within the description of another
10800 ;; link (e.g., an inline image), always open the parent
10801 ;; link.
10802 (let*((link (let ((up (org-element-property :parent context)))
10803 (if (eq (org-element-type up) 'link) up context)))
10804 (type (org-element-property :type link))
10805 (path (org-link-unescape (org-element-property :path link))))
10806 ;; Switch back to REFERENCE-BUFFER needed when called in
10807 ;; a temporary buffer through `org-open-link-from-string'.
10808 (with-current-buffer (or reference-buffer (current-buffer))
10809 (cond
10810 ((equal type "file")
10811 (if (string-match "[*?{]" (file-name-nondirectory path))
10812 (dired path)
10813 ;; Look into `org-link-protocols' in order to find
10814 ;; a DEDICATED-FUNCTION to open file. The function
10815 ;; will be applied on raw link instead of parsed
10816 ;; link due to the limitation in `org-add-link-type'
10817 ;; ("open" function called with a single argument).
10818 ;; If no such function is found, fallback to
10819 ;; `org-open-file'.
10821 ;; Note : "file+emacs" and "file+sys" types are
10822 ;; hard-coded in order to escape the previous
10823 ;; limitation.
10824 (let* ((option (org-element-property :search-option link))
10825 (app (org-element-property :application link))
10826 (dedicated-function
10827 (nth 1 (assoc app org-link-protocols))))
10828 (if dedicated-function
10829 (funcall dedicated-function
10830 (concat path
10831 (and option (concat "::" option))))
10832 (apply 'org-open-file
10833 path
10834 (cond (arg)
10835 ((equal app "emacs") 'emacs)
10836 ((equal app "sys") 'system))
10837 (cond ((not option) nil)
10838 ((org-string-match-p "\\`[0-9]+\\'" option)
10839 (list (string-to-number option)))
10840 (t (list nil
10841 (org-link-unescape option)))))))))
10842 ((assoc type org-link-protocols)
10843 (funcall (nth 1 (assoc type org-link-protocols)) path))
10844 ((equal type "help")
10845 (let ((f-or-v (intern path)))
10846 (cond ((fboundp f-or-v) (describe-function f-or-v))
10847 ((boundp f-or-v) (describe-variable f-or-v))
10848 (t (error "Not a known function or variable")))))
10849 ((member type '("http" "https" "ftp" "mailto" "news"))
10850 (browse-url (org-link-escape-browser (concat type ":" path))))
10851 ((equal type "doi")
10852 (browse-url
10853 (org-link-escape-browser (concat org-doi-server-url path))))
10854 ((equal type "message") (browse-url (concat type ":" path)))
10855 ((equal type "shell")
10856 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10857 (cmd path))
10858 (if (or (and (org-string-nw-p
10859 org-confirm-shell-link-not-regexp)
10860 (string-match
10861 org-confirm-shell-link-not-regexp cmd))
10862 (not org-confirm-shell-link-function)
10863 (funcall org-confirm-shell-link-function
10864 (format "Execute \"%s\" in shell? "
10865 (org-add-props cmd nil
10866 'face 'org-warning))))
10867 (progn
10868 (message "Executing %s" cmd)
10869 (shell-command cmd buf)
10870 (when (featurep 'midnight)
10871 (setq clean-buffer-list-kill-buffer-names
10872 (cons buf
10873 clean-buffer-list-kill-buffer-names))))
10874 (user-error "Abort"))))
10875 ((equal type "elisp")
10876 (let ((cmd path))
10877 (if (or (and (org-string-nw-p
10878 org-confirm-elisp-link-not-regexp)
10879 (org-string-match-p
10880 org-confirm-elisp-link-not-regexp cmd))
10881 (not org-confirm-elisp-link-function)
10882 (funcall org-confirm-elisp-link-function
10883 (format "Execute \"%s\" as elisp? "
10884 (org-add-props cmd nil
10885 'face 'org-warning))))
10886 (message "%s => %s" cmd
10887 (if (eq (string-to-char cmd) ?\()
10888 (eval (read cmd))
10889 (call-interactively (read cmd))))
10890 (user-error "Abort"))))
10891 ((equal type "id")
10892 (require 'ord-id)
10893 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10894 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10895 (unless (run-hook-with-args-until-success
10896 'org-open-link-functions path)
10897 (if (not arg) (org-mark-ring-push)
10898 (switch-to-buffer-other-window
10899 (org-get-buffer-for-internal-link (current-buffer))))
10900 (let ((cmd `(org-link-search
10901 ,(if (member type '("custom-id" "coderef"))
10902 (org-element-property :raw-link link)
10903 path)
10904 ,(cond ((equal arg '(4)) 'occur)
10905 ((equal arg '(16)) 'org-occur))
10906 ,(org-element-property :begin link))))
10907 (condition-case nil
10908 (let ((org-link-search-inhibit-query t))
10909 (eval cmd))
10910 (error (progn (widen) (eval cmd)))))))
10911 (t (browse-url-at-point))))))
10912 ;; On a footnote reference or at a footnote definition's label.
10913 ((or (eq type 'footnote-reference)
10914 (and (eq type 'footnote-definition)
10915 (save-excursion
10916 ;; Do not validate action when point is on the
10917 ;; spaces right after the footnote label, in
10918 ;; order to be on par with behaviour on links.
10919 (skip-chars-forward " \t")
10920 (let ((begin
10921 (org-element-property :contents-begin context)))
10922 (if begin (< (point) begin)
10923 (= (org-element-property :post-affiliated context)
10924 (line-beginning-position)))))))
10925 (org-footnote-action))
10926 (t (user-error "No link found")))))
10927 (move-marker org-open-link-marker nil)
10928 (run-hook-with-args 'org-follow-link-hook)))
10930 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10931 "Offer links in the current entry and return the selected link.
10932 If there is only one link, return it.
10933 If NTH is an integer, return the NTH link found.
10934 If ZERO is a string, check also this string for a link, and if
10935 there is one, return it."
10936 (with-current-buffer buffer
10937 (save-excursion
10938 (save-restriction
10939 (widen)
10940 (goto-char marker)
10941 (let ((cnt ?0)
10942 (in-emacs (if (integerp nth) nil nth))
10943 have-zero end links link c)
10944 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10945 (push (match-string 0 zero) links)
10946 (setq cnt (1- cnt) have-zero t))
10947 (save-excursion
10948 (org-back-to-heading t)
10949 (setq end (save-excursion (outline-next-heading) (point)))
10950 (while (re-search-forward org-any-link-re end t)
10951 (push (match-string 0) links))
10952 (setq links (org-uniquify (reverse links))))
10953 (cond
10954 ((null links)
10955 (message "No links"))
10956 ((equal (length links) 1)
10957 (setq link (car links)))
10958 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10959 (setq link (nth (if have-zero nth (1- nth)) links)))
10960 (t ; we have to select a link
10961 (save-excursion
10962 (save-window-excursion
10963 (delete-other-windows)
10964 (with-output-to-temp-buffer "*Select Link*"
10965 (mapc (lambda (l)
10966 (if (not (string-match org-bracket-link-regexp l))
10967 (princ (format "[%c] %s\n" (incf cnt)
10968 (org-remove-angle-brackets l)))
10969 (if (match-end 3)
10970 (princ (format "[%c] %s (%s)\n" (incf cnt)
10971 (match-string 3 l) (match-string 1 l)))
10972 (princ (format "[%c] %s\n" (incf cnt)
10973 (match-string 1 l))))))
10974 links))
10975 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10976 (message "Select link to open, RET to open all:")
10977 (setq c (read-char-exclusive))
10978 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10979 (when (equal c ?q) (user-error "Abort"))
10980 (if (equal c ?\C-m)
10981 (setq link links)
10982 (setq nth (- c ?0))
10983 (if have-zero (setq nth (1+ nth)))
10984 (unless (and (integerp nth) (>= (length links) nth))
10985 (user-error "Invalid link selection"))
10986 (setq link (nth (1- nth) links)))))
10987 (cons link end))))))
10989 ;; TODO: These functions are deprecated since `org-open-at-point'
10990 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10991 (defun org-open-file-with-system (path)
10992 "Open file at PATH using the system way of opening it."
10993 (org-open-file path 'system))
10994 (defun org-open-file-with-emacs (path)
10995 "Open file at PATH in Emacs."
10996 (org-open-file path 'emacs))
10999 ;;; File search
11001 (defvar org-create-file-search-functions nil
11002 "List of functions to construct the right search string for a file link.
11003 These functions are called in turn with point at the location to
11004 which the link should point.
11006 A function in the hook should first test if it would like to
11007 handle this file type, for example by checking the `major-mode'
11008 or the file extension. If it decides not to handle this file, it
11009 should just return nil to give other functions a chance. If it
11010 does handle the file, it must return the search string to be used
11011 when following the link. The search string will be part of the
11012 file link, given after a double colon, and `org-open-at-point'
11013 will automatically search for it. If special measures must be
11014 taken to make the search successful, another function should be
11015 added to the companion hook `org-execute-file-search-functions',
11016 which see.
11018 A function in this hook may also use `setq' to set the variable
11019 `description' to provide a suggestion for the descriptive text to
11020 be used for this link when it gets inserted into an Org-mode
11021 buffer with \\[org-insert-link].")
11023 (defvar org-execute-file-search-functions nil
11024 "List of functions to execute a file search triggered by a link.
11026 Functions added to this hook must accept a single argument, the
11027 search string that was part of the file link, the part after the
11028 double colon. The function must first check if it would like to
11029 handle this search, for example by checking the `major-mode' or
11030 the file extension. If it decides not to handle this search, it
11031 should just return nil to give other functions a chance. If it
11032 does handle the search, it must return a non-nil value to keep
11033 other functions from trying.
11035 Each function can access the current prefix argument through the
11036 variable `current-prefix-arg'. Note that a single prefix is used
11037 to force opening a link in Emacs, so it may be good to only use a
11038 numeric or double prefix to guide the search function.
11040 In case this is needed, a function in this hook can also restore
11041 the window configuration before `org-open-at-point' was called using:
11043 (set-window-configuration org-window-config-before-follow-link)")
11045 (defun org-link-search (s &optional type avoid-pos stealth)
11046 "Search for a link search option.
11047 If S is surrounded by forward slashes, it is interpreted as a
11048 regular expression. In org-mode files, this will create an `org-occur'
11049 sparse tree. In ordinary files, `occur' will be used to list matches.
11050 If the current buffer is in `dired-mode', grep will be used to search
11051 in all files. If AVOID-POS is given, ignore matches near that position.
11053 When optional argument STEALTH is non-nil, do not modify
11054 visibility around point, thus ignoring
11055 `org-show-hierarchy-above', `org-show-following-heading' and
11056 `org-show-siblings' variables."
11057 (let ((case-fold-search t)
11058 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
11059 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
11060 (append '(("") (" ") ("\t") ("\n"))
11061 org-emphasis-alist)
11062 "\\|") "\\)"))
11063 (pos (point))
11064 (pre nil) (post nil)
11065 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
11066 (cond
11067 ;; First check if there are any special search functions
11068 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11069 ;; Now try the builtin stuff
11070 ((and (equal (string-to-char s0) ?#)
11071 (> (length s0) 1)
11072 (save-excursion
11073 (goto-char (point-min))
11074 (and
11075 (re-search-forward
11076 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
11077 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
11078 (setq type 'dedicated
11079 pos (match-beginning 0))))
11080 ;; There is an exact target for this
11081 (goto-char pos)
11082 (org-back-to-heading t)))
11083 ((save-excursion
11084 (goto-char (point-min))
11085 (and
11086 (re-search-forward
11087 (concat "<<" (regexp-quote s0) ">>") nil t)
11088 (setq type 'dedicated
11089 pos (match-beginning 0))))
11090 ;; There is an exact target for this
11091 (goto-char pos))
11092 ((save-excursion
11093 (goto-char (point-min))
11094 (and
11095 (re-search-forward
11096 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11097 (setq type 'dedicated pos (match-beginning 0))))
11098 ;; Found an element with a matching #+name affiliated keyword.
11099 (goto-char pos))
11100 ((and (string-match "^(\\(.*\\))$" s0)
11101 (save-excursion
11102 (goto-char (point-min))
11103 (and
11104 (re-search-forward
11105 (concat "[^[]" (regexp-quote
11106 (format org-coderef-label-format
11107 (match-string 1 s0))))
11108 nil t)
11109 (setq type 'dedicated
11110 pos (1+ (match-beginning 0))))))
11111 ;; There is a coderef target for this
11112 (goto-char pos))
11113 ((string-match "^/\\(.*\\)/$" s)
11114 ;; A regular expression
11115 (cond
11116 ((derived-mode-p 'org-mode)
11117 (org-occur (match-string 1 s)))
11118 (t (org-do-occur (match-string 1 s)))))
11119 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
11120 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11121 (goto-char (point-min))
11122 (cond
11123 ((let (case-fold-search)
11124 (re-search-forward (format org-complex-heading-regexp-format
11125 (regexp-quote s))
11126 nil t))
11127 ;; OK, found a match
11128 (setq type 'dedicated)
11129 (goto-char (match-beginning 0)))
11130 ((and (not org-link-search-inhibit-query)
11131 (eq org-link-search-must-match-exact-headline 'query-to-create)
11132 (y-or-n-p "No match - create this as a new heading? "))
11133 (goto-char (point-max))
11134 (or (bolp) (newline))
11135 (insert "* " s "\n")
11136 (beginning-of-line 0))
11138 (goto-char pos)
11139 (error "No match"))))
11141 ;; A normal search string
11142 (when (equal (string-to-char s) ?*)
11143 ;; Anchor on headlines, post may include tags.
11144 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
11145 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
11146 s (substring s 1)))
11147 (remove-text-properties
11148 0 (length s)
11149 '(face nil mouse-face nil keymap nil fontified nil) s)
11150 ;; Make a series of regular expressions to find a match
11151 (setq words (org-split-string s "[ \n\r\t]+")
11153 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11154 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11155 "\\)" markers)
11156 re2a_ (concat "\\(" (mapconcat 'downcase words
11157 "[ \t\r\n]+") "\\)[ \t\r\n]")
11158 re2a (concat "[ \t\r\n]" re2a_)
11159 re4_ (concat "\\(" (mapconcat 'downcase words
11160 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11161 re4 (concat "[^a-zA-Z_]" re4_)
11163 re1 (concat pre re2 post)
11164 re3 (concat pre (if pre re4_ re4) post)
11165 re5 (concat pre ".*" re4)
11166 re2 (concat pre re2)
11167 re2a (concat pre (if pre re2a_ re2a))
11168 re4 (concat pre (if pre re4_ re4))
11169 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
11170 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
11171 re5 "\\)"))
11172 (cond
11173 ((eq type 'org-occur) (org-occur reall))
11174 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11175 (t (goto-char (point-min))
11176 (setq type 'fuzzy)
11177 (if (or (and (org-search-not-self 1 re0 nil t)
11178 (setq type 'dedicated))
11179 (org-search-not-self 1 re1 nil t)
11180 (org-search-not-self 1 re2 nil t)
11181 (org-search-not-self 1 re2a nil t)
11182 (org-search-not-self 1 re3 nil t)
11183 (org-search-not-self 1 re4 nil t)
11184 (org-search-not-self 1 re5 nil t))
11185 (goto-char (match-beginning 1))
11186 (goto-char pos)
11187 (error "No match"))))))
11188 (and (derived-mode-p 'org-mode)
11189 (not stealth)
11190 (org-show-context 'link-search))
11191 type))
11193 (defun org-search-not-self (group &rest args)
11194 "Execute `re-search-forward', but only accept matches that do not
11195 enclose the position of `org-open-link-marker'."
11196 (let ((m org-open-link-marker))
11197 (catch 'exit
11198 (while (apply 're-search-forward args)
11199 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11200 (goto-char (match-end group))
11201 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11202 (> (match-beginning 0) (marker-position m))
11203 (< (match-end 0) (marker-position m)))
11204 (save-match-data
11205 (or (not (org-in-regexp
11206 org-bracket-link-analytic-regexp 1))
11207 (not (match-end 4)) ; no description
11208 (and (<= (match-beginning 4) (point))
11209 (>= (match-end 4) (point))))))
11210 (throw 'exit (point))))))))
11212 (defun org-get-buffer-for-internal-link (buffer)
11213 "Return a buffer to be used for displaying the link target of internal links."
11214 (cond
11215 ((not org-display-internal-link-with-indirect-buffer)
11216 buffer)
11217 ((string-match "(Clone)$" (buffer-name buffer))
11218 (message "Buffer is already a clone, not making another one")
11219 ;; we also do not modify visibility in this case
11220 buffer)
11221 (t ; make a new indirect buffer for displaying the link
11222 (let* ((bn (buffer-name buffer))
11223 (ibn (concat bn "(Clone)"))
11224 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11225 (with-current-buffer ib (org-overview))
11226 ib))))
11228 (defun org-do-occur (regexp &optional cleanup)
11229 "Call the Emacs command `occur'.
11230 If CLEANUP is non-nil, remove the printout of the regular expression
11231 in the *Occur* buffer. This is useful if the regex is long and not useful
11232 to read."
11233 (occur regexp)
11234 (when cleanup
11235 (let ((cwin (selected-window)) win beg end)
11236 (when (setq win (get-buffer-window "*Occur*"))
11237 (select-window win))
11238 (goto-char (point-min))
11239 (when (re-search-forward "match[a-z]+" nil t)
11240 (setq beg (match-end 0))
11241 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11242 (setq end (1- (match-beginning 0)))))
11243 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11244 (goto-char (point-min))
11245 (select-window cwin))))
11247 ;;; The mark ring for links jumps
11249 (defvar org-mark-ring nil
11250 "Mark ring for positions before jumps in Org-mode.")
11251 (defvar org-mark-ring-last-goto nil
11252 "Last position in the mark ring used to go back.")
11253 ;; Fill and close the ring
11254 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11255 (loop for i from 1 to org-mark-ring-length do
11256 (push (make-marker) org-mark-ring))
11257 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11258 org-mark-ring)
11260 (defun org-mark-ring-push (&optional pos buffer)
11261 "Put the current position or POS into the mark ring and rotate it."
11262 (interactive)
11263 (setq pos (or pos (point)))
11264 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11265 (move-marker (car org-mark-ring)
11266 (or pos (point))
11267 (or buffer (current-buffer)))
11268 (message "%s"
11269 (substitute-command-keys
11270 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11272 (defun org-mark-ring-goto (&optional n)
11273 "Jump to the previous position in the mark ring.
11274 With prefix arg N, jump back that many stored positions. When
11275 called several times in succession, walk through the entire ring.
11276 Org-mode commands jumping to a different position in the current file,
11277 or to another Org-mode file, automatically push the old position
11278 onto the ring."
11279 (interactive "p")
11280 (let (p m)
11281 (if (eq last-command this-command)
11282 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11283 (setq p org-mark-ring))
11284 (setq org-mark-ring-last-goto p)
11285 (setq m (car p))
11286 (org-pop-to-buffer-same-window (marker-buffer m))
11287 (goto-char m)
11288 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11290 (defun org-remove-angle-brackets (s)
11291 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11292 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11294 (defun org-add-angle-brackets (s)
11295 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11296 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11298 (defun org-remove-double-quotes (s)
11299 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11300 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11303 ;;; Following specific links
11305 (defun org-follow-timestamp-link ()
11306 "Open an agenda view for the time-stamp date/range at point."
11307 (cond
11308 ((org-at-date-range-p t)
11309 (let ((org-agenda-start-on-weekday)
11310 (t1 (match-string 1))
11311 (t2 (match-string 2)) tt1 tt2)
11312 (setq tt1 (time-to-days (org-time-string-to-time t1))
11313 tt2 (time-to-days (org-time-string-to-time t2)))
11314 (let ((org-agenda-buffer-tmp-name
11315 (format "*Org Agenda(a:%s)"
11316 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11317 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11318 ((org-at-timestamp-p t)
11319 (let ((org-agenda-buffer-tmp-name
11320 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11321 (org-agenda-list nil (time-to-days (org-time-string-to-time
11322 (substring (match-string 1) 0 10)))
11323 1)))
11324 (t (error "This should not happen"))))
11327 ;;; Following file links
11328 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11329 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11330 (declare-function mailcap-mime-info
11331 "mailcap" (string &optional request no-decode))
11332 (defvar org-wait nil)
11333 (defun org-open-file (path &optional in-emacs line search)
11334 "Open the file at PATH.
11335 First, this expands any special file name abbreviations. Then the
11336 configuration variable `org-file-apps' is checked if it contains an
11337 entry for this file type, and if yes, the corresponding command is launched.
11339 If no application is found, Emacs simply visits the file.
11341 With optional prefix argument IN-EMACS, Emacs will visit the file.
11342 With a double \\[universal-argument] \\[universal-argument] \
11343 prefix arg, Org tries to avoid opening in Emacs
11344 and to use an external application to visit the file.
11346 Optional LINE specifies a line to go to, optional SEARCH a string
11347 to search for. If LINE or SEARCH is given, the file will be
11348 opened in Emacs, unless an entry from org-file-apps that makes
11349 use of groups in a regexp matches.
11351 If you want to change the way frames are used when following a
11352 link, please customize `org-link-frame-setup'.
11354 If the file does not exist, an error is thrown."
11355 (let* ((file (if (equal path "")
11356 buffer-file-name
11357 (substitute-in-file-name (expand-file-name path))))
11358 (file-apps (append org-file-apps (org-default-apps)))
11359 (apps (org-remove-if
11360 'org-file-apps-entry-match-against-dlink-p file-apps))
11361 (apps-dlink (org-remove-if-not
11362 'org-file-apps-entry-match-against-dlink-p file-apps))
11363 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11364 (dirp (if remp nil (file-directory-p file)))
11365 (file (if (and dirp org-open-directory-means-index-dot-org)
11366 (concat (file-name-as-directory file) "index.org")
11367 file))
11368 (a-m-a-p (assq 'auto-mode apps))
11369 (dfile (downcase file))
11370 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11371 (link (cond ((and (eq line nil)
11372 (eq search nil))
11373 file)
11374 (line
11375 (concat file "::" (number-to-string line)))
11376 (search
11377 (concat file "::" search))))
11378 (dlink (downcase link))
11379 (old-buffer (current-buffer))
11380 (old-pos (point))
11381 (old-mode major-mode)
11382 ext cmd link-match-data)
11383 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11384 (setq ext (match-string 1 dfile))
11385 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11386 (setq ext (match-string 1 dfile))))
11387 (cond
11388 ((member in-emacs '((16) system))
11389 (setq cmd (cdr (assoc 'system apps))))
11390 (in-emacs (setq cmd 'emacs))
11392 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11393 (and dirp (cdr (assoc 'directory apps)))
11394 ; first, try matching against apps-dlink
11395 ; if we get a match here, store the match data for later
11396 (let ((match (assoc-default dlink apps-dlink
11397 'string-match)))
11398 (if match
11399 (progn (setq link-match-data (match-data))
11400 match)
11401 (progn (setq in-emacs (or in-emacs line search))
11402 nil))) ; if we have no match in apps-dlink,
11403 ; always open the file in emacs if line or search
11404 ; is given (for backwards compatibility)
11405 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11406 'string-match)
11407 (cdr (assoc ext apps))
11408 (cdr (assoc t apps))))))
11409 (when (eq cmd 'system)
11410 (setq cmd (cdr (assoc 'system apps))))
11411 (when (eq cmd 'default)
11412 (setq cmd (cdr (assoc t apps))))
11413 (when (eq cmd 'mailcap)
11414 (require 'mailcap)
11415 (mailcap-parse-mailcaps)
11416 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11417 (command (mailcap-mime-info mime-type)))
11418 (if (stringp command)
11419 (setq cmd command)
11420 (setq cmd 'emacs))))
11421 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11422 (not (file-exists-p file))
11423 (not org-open-non-existing-files))
11424 (user-error "No such file: %s" file))
11425 (cond
11426 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11427 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11428 (while (string-match "['\"]%s['\"]" cmd)
11429 (setq cmd (replace-match "%s" t t cmd)))
11430 (while (string-match "%s" cmd)
11431 (setq cmd (replace-match
11432 (save-match-data
11433 (shell-quote-argument
11434 (convert-standard-filename file)))
11435 t t cmd)))
11437 ;; Replace "%1", "%2" etc. in command with group matches from regex
11438 (save-match-data
11439 (let ((match-index 1)
11440 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11441 (set-match-data link-match-data)
11442 (while (<= match-index number-of-groups)
11443 (let ((regex (concat "%" (number-to-string match-index)))
11444 (replace-with (match-string match-index dlink)))
11445 (while (string-match regex cmd)
11446 (setq cmd (replace-match replace-with t t cmd))))
11447 (setq match-index (+ match-index 1)))))
11449 (save-window-excursion
11450 (message "Running %s...done" cmd)
11451 (start-process-shell-command cmd nil cmd)
11452 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11453 ((or (stringp cmd)
11454 (eq cmd 'emacs))
11455 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11456 (widen)
11457 (if line (progn (org-goto-line line)
11458 (if (derived-mode-p 'org-mode)
11459 (org-reveal)))
11460 (if search (org-link-search search))))
11461 ((consp cmd)
11462 (let ((file (convert-standard-filename file)))
11463 (save-match-data
11464 (set-match-data link-match-data)
11465 (eval cmd))))
11466 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11467 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11468 (or (not (equal old-buffer (current-buffer)))
11469 (not (equal old-pos (point))))
11470 (org-mark-ring-push old-pos old-buffer))))
11472 (defun org-file-apps-entry-match-against-dlink-p (entry)
11473 "This function returns non-nil if `entry' uses a regular
11474 expression which should be matched against the whole link by
11475 org-open-file.
11477 It assumes that is the case when the entry uses a regular
11478 expression which has at least one grouping construct and the
11479 action is either a lisp form or a command string containing
11480 '%1', i.e. using at least one subexpression match as a
11481 parameter."
11482 (let ((selector (car entry))
11483 (action (cdr entry)))
11484 (if (stringp selector)
11485 (and (> (regexp-opt-depth selector) 0)
11486 (or (and (stringp action)
11487 (string-match "%[0-9]" action))
11488 (consp action)))
11489 nil)))
11491 (defun org-default-apps ()
11492 "Return the default applications for this operating system."
11493 (cond
11494 ((eq system-type 'darwin)
11495 org-file-apps-defaults-macosx)
11496 ((eq system-type 'windows-nt)
11497 org-file-apps-defaults-windowsnt)
11498 (t org-file-apps-defaults-gnu)))
11500 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11501 "Convert extensions to regular expressions in the cars of LIST.
11502 Also, weed out any non-string entries, because the return value is used
11503 only for regexp matching.
11504 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11505 point to the symbol `emacs', indicating that the file should
11506 be opened in Emacs."
11507 (append
11508 (delq nil
11509 (mapcar (lambda (x)
11510 (if (not (stringp (car x)))
11512 (if (string-match "\\W" (car x))
11514 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11515 list))
11516 (if add-auto-mode
11517 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11519 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11520 (defun org-file-remote-p (file)
11521 "Test whether FILE specifies a location on a remote system.
11522 Return non-nil if the location is indeed remote.
11524 For example, the filename \"/user@host:/foo\" specifies a location
11525 on the system \"/user@host:\"."
11526 (cond ((fboundp 'file-remote-p)
11527 (file-remote-p file))
11528 ((fboundp 'tramp-handle-file-remote-p)
11529 (tramp-handle-file-remote-p file))
11530 ((and (boundp 'ange-ftp-name-format)
11531 (string-match (car ange-ftp-name-format) file))
11532 t)))
11535 ;;;; Refiling
11537 (defun org-get-org-file ()
11538 "Read a filename, with default directory `org-directory'."
11539 (let ((default (or org-default-notes-file remember-data-file)))
11540 (read-file-name (format "File name [%s]: " default)
11541 (file-name-as-directory org-directory)
11542 default)))
11544 (defun org-notes-order-reversed-p ()
11545 "Check if the current file should receive notes in reversed order."
11546 (cond
11547 ((not org-reverse-note-order) nil)
11548 ((eq t org-reverse-note-order) t)
11549 ((not (listp org-reverse-note-order)) nil)
11550 (t (catch 'exit
11551 (let ((all org-reverse-note-order)
11552 entry)
11553 (while (setq entry (pop all))
11554 (if (string-match (car entry) buffer-file-name)
11555 (throw 'exit (cdr entry))))
11556 nil)))))
11558 (defvar org-refile-target-table nil
11559 "The list of refile targets, created by `org-refile'.")
11561 (defvar org-agenda-new-buffers nil
11562 "Buffers created to visit agenda files.")
11564 (defvar org-refile-cache nil
11565 "Cache for refile targets.")
11567 (defvar org-refile-markers nil
11568 "All the markers used for caching refile locations.")
11570 (defun org-refile-marker (pos)
11571 "Get a new refile marker, but only if caching is in use."
11572 (if (not org-refile-use-cache)
11574 (let ((m (make-marker)))
11575 (move-marker m pos)
11576 (push m org-refile-markers)
11577 m)))
11579 (defun org-refile-cache-clear ()
11580 "Clear the refile cache and disable all the markers."
11581 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11582 (setq org-refile-markers nil)
11583 (setq org-refile-cache nil)
11584 (message "Refile cache has been cleared"))
11586 (defun org-refile-cache-check-set (set)
11587 "Check if all the markers in the cache still have live buffers."
11588 (let (marker)
11589 (catch 'exit
11590 (while (and set (setq marker (nth 3 (pop set))))
11591 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11592 (when (and marker (null (marker-buffer marker)))
11593 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11594 (sit-for 3)
11595 (throw 'exit nil)))
11596 t)))
11598 (defun org-refile-cache-put (set &rest identifiers)
11599 "Push the refile targets SET into the cache, under IDENTIFIERS."
11600 (let* ((key (sha1 (prin1-to-string identifiers)))
11601 (entry (assoc key org-refile-cache)))
11602 (if entry
11603 (setcdr entry set)
11604 (push (cons key set) org-refile-cache))))
11606 (defun org-refile-cache-get (&rest identifiers)
11607 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11608 (cond
11609 ((not org-refile-cache) nil)
11610 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11612 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11613 org-refile-cache))))
11614 (and set (org-refile-cache-check-set set) set)))))
11616 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11617 "Produce a table with refile targets."
11618 (let ((case-fold-search nil)
11619 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11620 (entries (or org-refile-targets '((nil . (:level . 1)))))
11621 targets tgs txt re files f desc descre fast-path-p level pos0)
11622 (message "Getting targets...")
11623 (with-current-buffer (or default-buffer (current-buffer))
11624 (while (setq entry (pop entries))
11625 (setq files (car entry) desc (cdr entry))
11626 (setq fast-path-p nil)
11627 (cond
11628 ((null files) (setq files (list (current-buffer))))
11629 ((eq files 'org-agenda-files)
11630 (setq files (org-agenda-files 'unrestricted)))
11631 ((and (symbolp files) (fboundp files))
11632 (setq files (funcall files)))
11633 ((and (symbolp files) (boundp files))
11634 (setq files (symbol-value files))))
11635 (if (stringp files) (setq files (list files)))
11636 (cond
11637 ((eq (car desc) :tag)
11638 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11639 ((eq (car desc) :todo)
11640 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11641 ((eq (car desc) :regexp)
11642 (setq descre (cdr desc)))
11643 ((eq (car desc) :level)
11644 (setq descre (concat "^\\*\\{" (number-to-string
11645 (if org-odd-levels-only
11646 (1- (* 2 (cdr desc)))
11647 (cdr desc)))
11648 "\\}[ \t]")))
11649 ((eq (car desc) :maxlevel)
11650 (setq fast-path-p t)
11651 (setq descre (concat "^\\*\\{1," (number-to-string
11652 (if org-odd-levels-only
11653 (1- (* 2 (cdr desc)))
11654 (cdr desc)))
11655 "\\}[ \t]")))
11656 (t (error "Bad refiling target description %s" desc)))
11657 (while (setq f (pop files))
11658 (with-current-buffer
11659 (if (bufferp f) f (org-get-agenda-file-buffer f))
11661 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11662 (progn
11663 (if (bufferp f) (setq f (buffer-file-name
11664 (buffer-base-buffer f))))
11665 (setq f (and f (expand-file-name f)))
11666 (if (eq org-refile-use-outline-path 'file)
11667 (push (list (file-name-nondirectory f) f nil nil) tgs))
11668 (save-excursion
11669 (save-restriction
11670 (widen)
11671 (goto-char (point-min))
11672 (while (re-search-forward descre nil t)
11673 (goto-char (setq pos0 (point-at-bol)))
11674 (catch 'next
11675 (when org-refile-target-verify-function
11676 (save-match-data
11677 (or (funcall org-refile-target-verify-function)
11678 (throw 'next t))))
11679 (when (and (looking-at org-complex-heading-regexp)
11680 (not (member (match-string 4) excluded-entries))
11681 (match-string 4))
11682 (setq level (org-reduced-level
11683 (- (match-end 1) (match-beginning 1)))
11684 txt (org-link-display-format (match-string 4))
11685 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11686 re (format org-complex-heading-regexp-format
11687 (regexp-quote (match-string 4))))
11688 (when org-refile-use-outline-path
11689 (setq txt (mapconcat
11690 'org-protect-slash
11691 (append
11692 (if (eq org-refile-use-outline-path
11693 'file)
11694 (list (file-name-nondirectory
11695 (buffer-file-name
11696 (buffer-base-buffer))))
11697 (if (eq org-refile-use-outline-path
11698 'full-file-path)
11699 (list (buffer-file-name
11700 (buffer-base-buffer)))))
11701 (org-get-outline-path fast-path-p
11702 level txt)
11703 (list txt))
11704 "/")))
11705 (push (list txt f re (org-refile-marker (point)))
11706 tgs)))
11707 (when (= (point) pos0)
11708 ;; verification function has not moved point
11709 (goto-char (point-at-eol))))))))
11710 (when org-refile-use-cache
11711 (org-refile-cache-put tgs (buffer-file-name) descre))
11712 (setq targets (append tgs targets))))))
11713 (message "Getting targets...done")
11714 (nreverse targets)))
11716 (defun org-protect-slash (s)
11717 (while (string-match "/" s)
11718 (setq s (replace-match "\\" t t s)))
11721 (defvar org-olpa (make-vector 20 nil))
11723 (defun org-get-outline-path (&optional fastp level heading)
11724 "Return the outline path to the current entry, as a list.
11726 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11727 routine which makes outline path derivations for an entire file,
11728 avoiding backtracing. Refile target collection makes use of that."
11729 (if fastp
11730 (progn
11731 (if (> level 19)
11732 (error "Outline path failure, more than 19 levels"))
11733 (loop for i from level upto 19 do
11734 (aset org-olpa i nil))
11735 (prog1
11736 (delq nil (append org-olpa nil))
11737 (aset org-olpa level heading)))
11738 (let (rtn case-fold-search)
11739 (save-excursion
11740 (save-restriction
11741 (widen)
11742 (while (org-up-heading-safe)
11743 (when (looking-at org-complex-heading-regexp)
11744 (push (org-trim
11745 (replace-regexp-in-string
11746 ;; Remove statistical/checkboxes cookies
11747 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11748 (org-match-string-no-properties 4)))
11749 rtn)))
11750 rtn)))))
11752 (defun org-format-outline-path (path &optional width prefix separator)
11753 "Format the outline path PATH for display.
11754 WIDTH is the maximum number of characters that is available.
11755 PREFIX is a prefix to be included in the returned string,
11756 such as the file name.
11757 SEPARATOR is inserted between the different parts of the path,
11758 the default is \"/\"."
11759 (setq width (or width 79))
11760 (if prefix (setq width (- width (length prefix))))
11761 (if (not path)
11762 (or prefix "")
11763 (let* ((nsteps (length path))
11764 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11765 (maxwidth (if (<= total-width width)
11766 10000 ;; everything fits
11767 ;; we need to shorten the level headings
11768 (/ (- width nsteps) nsteps)))
11769 (org-odd-levels-only nil)
11770 (n 0)
11771 (total (1+ (length prefix))))
11772 (setq maxwidth (max maxwidth 10))
11773 (concat prefix
11774 (if prefix (or separator "/"))
11775 (mapconcat
11776 (lambda (h)
11777 (setq n (1+ n))
11778 (if (and (= n nsteps) (< maxwidth 10000))
11779 (setq maxwidth (- total-width total)))
11780 (if (< (length h) maxwidth)
11781 (progn (setq total (+ total (length h) 1)) h)
11782 (setq h (substring h 0 (- maxwidth 2))
11783 total (+ total maxwidth 1))
11784 (if (string-match "[ \t]+\\'" h)
11785 (setq h (substring h 0 (match-beginning 0))))
11786 (setq h (concat h "..")))
11787 (org-add-props h nil 'face
11788 (nth (% (1- n) org-n-level-faces)
11789 org-level-faces))
11791 path (or separator "/"))))))
11793 (defun org-display-outline-path (&optional file current separator just-return-string)
11794 "Display the current outline path in the echo area.
11796 If FILE is non-nil, prepend the output with the file name.
11797 If CURRENT is non-nil, append the current heading to the output.
11798 SEPARATOR is passed through to `org-format-outline-path'. It separates
11799 the different parts of the path and defaults to \"/\".
11800 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11801 (interactive "P")
11802 (let* (case-fold-search
11803 (bfn (buffer-file-name (buffer-base-buffer)))
11804 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11805 res)
11806 (if current (setq path (append path
11807 (save-excursion
11808 (org-back-to-heading t)
11809 (if (looking-at org-complex-heading-regexp)
11810 (list (match-string 4)))))))
11811 (setq res
11812 (org-format-outline-path
11813 path
11814 (1- (frame-width))
11815 (and file bfn (concat (file-name-nondirectory bfn) separator))
11816 separator))
11817 (if just-return-string
11818 (org-no-properties res)
11819 (org-unlogged-message "%s" res))))
11821 (defvar org-refile-history nil
11822 "History for refiling operations.")
11824 (defvar org-after-refile-insert-hook nil
11825 "Hook run after `org-refile' has inserted its stuff at the new location.
11826 Note that this is still *before* the stuff will be removed from
11827 the *old* location.")
11829 (defvar org-capture-last-stored-marker)
11830 (defvar org-refile-keep nil
11831 "Non-nil means `org-refile' will copy instead of refile.")
11833 (defun org-copy ()
11834 "Like `org-refile', but copy."
11835 (interactive)
11836 (let ((org-refile-keep t))
11837 (funcall 'org-refile nil nil nil "Copy")))
11839 (defun org-refile (&optional arg default-buffer rfloc msg)
11840 "Move the entry or entries at point to another heading.
11841 The list of target headings is compiled using the information in
11842 `org-refile-targets', which see.
11844 At the target location, the entry is filed as a subitem of the
11845 target heading. Depending on `org-reverse-note-order', the new
11846 subitem will either be the first or the last subitem.
11848 If there is an active region, all entries in that region will be
11849 refiled. However, the region must fulfill the requirement that
11850 the first heading sets the top-level of the moved text.
11852 With prefix arg ARG, the command will only visit the target
11853 location and not actually move anything.
11855 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11856 refiling operation has put the subtree.
11858 With a numeric prefix argument of `2', refile to the running clock.
11860 With a numeric prefix argument of `3', emulate `org-refile-keep'
11861 being set to `t' and copy to the target location, don't move it.
11862 Beware that keeping refiled entries may result in duplicated ID
11863 properties.
11865 RFLOC can be a refile location obtained in a different way.
11867 MSG is a string to replace \"Refile\" in the default prompt with
11868 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11870 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11872 If you are using target caching (see `org-refile-use-cache'), you
11873 have to clear the target cache in order to find new targets.
11874 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11875 prefix argument (`C-u C-u C-u C-c C-w')."
11876 (interactive "P")
11877 (if (member arg '(0 (64)))
11878 (org-refile-cache-clear)
11879 (let* ((actionmsg (cond (msg msg)
11880 ((equal arg 3) "Refile (and keep)")
11881 (t "Refile")))
11882 (cbuf (current-buffer))
11883 (regionp (org-region-active-p))
11884 (region-start (and regionp (region-beginning)))
11885 (region-end (and regionp (region-end)))
11886 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11887 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11888 pos it nbuf file re level reversed)
11889 (setq last-command nil)
11890 (when regionp
11891 (goto-char region-start)
11892 (or (bolp) (goto-char (point-at-bol)))
11893 (setq region-start (point))
11894 (unless (or (org-kill-is-subtree-p
11895 (buffer-substring region-start region-end))
11896 (prog1 org-refile-active-region-within-subtree
11897 (let ((s (point-at-eol)))
11898 (org-toggle-heading)
11899 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11900 (user-error "The region is not a (sequence of) subtree(s)")))
11901 (if (equal arg '(16))
11902 (org-refile-goto-last-stored)
11903 (when (or
11904 (and (equal arg 2)
11905 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11906 (prog1
11907 (setq it (list (or org-clock-heading "running clock")
11908 (buffer-file-name
11909 (marker-buffer org-clock-hd-marker))
11911 (marker-position org-clock-hd-marker)))
11912 (setq arg nil)))
11913 (setq it (or rfloc
11914 (let (heading-text)
11915 (save-excursion
11916 (unless (and arg (listp arg))
11917 (org-back-to-heading t)
11918 (setq heading-text
11919 (replace-regexp-in-string
11920 org-bracket-link-regexp
11921 "\\3"
11922 (nth 4 (org-heading-components)))))
11923 (org-refile-get-location
11924 (cond ((and arg (listp arg)) "Goto")
11925 (regionp (concat actionmsg " region to"))
11926 (t (concat actionmsg " subtree \""
11927 heading-text "\" to")))
11928 default-buffer
11929 (and (not (equal '(4) arg))
11930 org-refile-allow-creating-parent-nodes)
11931 arg))))))
11932 (setq file (nth 1 it)
11933 re (nth 2 it)
11934 pos (nth 3 it))
11935 (if (and (not arg)
11937 (equal (buffer-file-name) file)
11938 (if regionp
11939 (and (>= pos region-start)
11940 (<= pos region-end))
11941 (and (>= pos (point))
11942 (< pos (save-excursion
11943 (org-end-of-subtree t t))))))
11944 (error "Cannot refile to position inside the tree or region"))
11945 (setq nbuf (or (find-buffer-visiting file)
11946 (find-file-noselect file)))
11947 (if (and arg (not (equal arg 3)))
11948 (progn
11949 (org-pop-to-buffer-same-window nbuf)
11950 (goto-char pos)
11951 (org-show-context 'org-goto))
11952 (if regionp
11953 (progn
11954 (org-kill-new (buffer-substring region-start region-end))
11955 (org-save-markers-in-region region-start region-end))
11956 (org-copy-subtree 1 nil t))
11957 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11958 (find-file-noselect file)))
11959 (setq reversed (org-notes-order-reversed-p))
11960 (save-excursion
11961 (save-restriction
11962 (widen)
11963 (if pos
11964 (progn
11965 (goto-char pos)
11966 (looking-at org-outline-regexp)
11967 (setq level (org-get-valid-level (funcall outline-level) 1))
11968 (goto-char
11969 (if reversed
11970 (or (outline-next-heading) (point-max))
11971 (or (save-excursion (org-get-next-sibling))
11972 (org-end-of-subtree t t)
11973 (point-max)))))
11974 (setq level 1)
11975 (if (not reversed)
11976 (goto-char (point-max))
11977 (goto-char (point-min))
11978 (or (outline-next-heading) (goto-char (point-max)))))
11979 (if (not (bolp)) (newline))
11980 (org-paste-subtree level nil nil t)
11981 (when org-log-refile
11982 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11983 (unless (eq org-log-refile 'note)
11984 (save-excursion (org-add-log-note))))
11985 (and org-auto-align-tags
11986 (let ((org-loop-over-headlines-in-active-region nil))
11987 (org-set-tags nil t)))
11988 (let ((bookmark-name (plist-get org-bookmark-names-plist
11989 :last-refile)))
11990 (when bookmark-name
11991 (with-demoted-errors
11992 (bookmark-set bookmark-name))))
11993 ;; If we are refiling for capture, make sure that the
11994 ;; last-capture pointers point here
11995 (when (org-bound-and-true-p org-refile-for-capture)
11996 (let ((bookmark-name (plist-get org-bookmark-names-plist
11997 :last-capture-marker)))
11998 (when bookmark-name
11999 (with-demoted-errors
12000 (bookmark-set bookmark-name))))
12001 (move-marker org-capture-last-stored-marker (point)))
12002 (if (fboundp 'deactivate-mark) (deactivate-mark))
12003 (run-hooks 'org-after-refile-insert-hook))))
12004 (unless org-refile-keep
12005 (if regionp
12006 (delete-region (point) (+ (point) (- region-end region-start)))
12007 (delete-region
12008 (and (org-back-to-heading t) (point))
12009 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
12010 (when (featurep 'org-inlinetask)
12011 (org-inlinetask-remove-END-maybe))
12012 (setq org-markers-to-move nil)
12013 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
12015 (defun org-refile-goto-last-stored ()
12016 "Go to the location where the last refile was stored."
12017 (interactive)
12018 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
12019 (message "This is the location of the last refile"))
12021 (defun org-refile--get-location (refloc tbl)
12022 "When user refile to REFLOC, find the associated target in TBL.
12023 Also check `org-refile-target-table'."
12024 (car (delq
12026 (mapcar
12027 (lambda (r) (or (assoc r tbl)
12028 (assoc r org-refile-target-table)))
12029 (list (replace-regexp-in-string "/$" "" refloc)
12030 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12032 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
12033 no-exclude)
12034 "Prompt the user for a refile location, using PROMPT.
12035 PROMPT should not be suffixed with a colon and a space, because
12036 this function appends the default value from
12037 `org-refile-history' automatically, if that is not empty.
12038 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12039 this is used for the GOTO interface."
12040 (let ((org-refile-targets org-refile-targets)
12041 (org-refile-use-outline-path org-refile-use-outline-path)
12042 excluded-entries)
12043 (when (and (derived-mode-p 'org-mode)
12044 (not org-refile-use-cache)
12045 (not no-exclude))
12046 (org-map-tree
12047 (lambda()
12048 (setq excluded-entries
12049 (append excluded-entries (list (org-get-heading t t)))))))
12050 (setq org-refile-target-table
12051 (org-refile-get-targets default-buffer excluded-entries)))
12052 (unless org-refile-target-table
12053 (user-error "No refile targets"))
12054 (let* ((cbuf (current-buffer))
12055 (partial-completion-mode nil)
12056 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12057 (cfunc (if (and org-refile-use-outline-path
12058 org-outline-path-complete-in-steps)
12059 'org-olpath-completing-read
12060 'org-icompleting-read))
12061 (extra (if org-refile-use-outline-path "/" ""))
12062 (cbnex (concat (buffer-name) extra))
12063 (filename (and cfn (expand-file-name cfn)))
12064 (tbl (mapcar
12065 (lambda (x)
12066 (if (and (not (member org-refile-use-outline-path
12067 '(file full-file-path)))
12068 (not (equal filename (nth 1 x))))
12069 (cons (concat (car x) extra " ("
12070 (file-name-nondirectory (nth 1 x)) ")")
12071 (cdr x))
12072 (cons (concat (car x) extra) (cdr x))))
12073 org-refile-target-table))
12074 (completion-ignore-case t)
12075 cdef
12076 (prompt (concat prompt
12077 (or (and (car org-refile-history)
12078 (concat " (default " (car org-refile-history) ")"))
12079 (and (assoc cbnex tbl) (setq cdef cbnex)
12080 (concat " (default " cbnex ")"))) ": "))
12081 pa answ parent-target child parent old-hist)
12082 (setq old-hist org-refile-history)
12083 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12084 nil 'org-refile-history (or cdef (car org-refile-history))))
12085 (if (setq pa (org-refile--get-location answ tbl))
12086 (progn
12087 (org-refile-check-position pa)
12088 (when (or (not org-refile-history)
12089 (not (eq old-hist org-refile-history))
12090 (not (equal (car pa) (car org-refile-history))))
12091 (setq org-refile-history
12092 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12093 org-refile-history
12094 (cdr org-refile-history))))
12095 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12096 (pop org-refile-history)))
12098 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12099 (progn
12100 (setq parent (match-string 1 answ)
12101 child (match-string 2 answ))
12102 (setq parent-target (org-refile--get-location parent tbl))
12103 (when (and parent-target
12104 (or (eq new-nodes t)
12105 (and (eq new-nodes 'confirm)
12106 (y-or-n-p (format "Create new node \"%s\"? "
12107 child)))))
12108 (org-refile-new-child parent-target child)))
12109 (user-error "Invalid target location")))))
12111 (declare-function org-string-nw-p "org-macs" (s))
12112 (defun org-refile-check-position (refile-pointer)
12113 "Check if the refile pointer matches the headline to which it points."
12114 (let* ((file (nth 1 refile-pointer))
12115 (re (nth 2 refile-pointer))
12116 (pos (nth 3 refile-pointer))
12117 buffer)
12118 (if (and (not (markerp pos)) (not file))
12119 (user-error "Please indicate a target file in the refile path")
12120 (when (org-string-nw-p re)
12121 (setq buffer (if (markerp pos)
12122 (marker-buffer pos)
12123 (or (find-buffer-visiting file)
12124 (find-file-noselect file))))
12125 (with-current-buffer buffer
12126 (save-excursion
12127 (save-restriction
12128 (widen)
12129 (goto-char pos)
12130 (beginning-of-line 1)
12131 (unless (org-looking-at-p re)
12132 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12134 (defun org-refile-new-child (parent-target child)
12135 "Use refile target PARENT-TARGET to add new CHILD below it."
12136 (unless parent-target
12137 (error "Cannot find parent for new node"))
12138 (let ((file (nth 1 parent-target))
12139 (pos (nth 3 parent-target))
12140 level)
12141 (with-current-buffer (or (find-buffer-visiting file)
12142 (find-file-noselect file))
12143 (save-excursion
12144 (save-restriction
12145 (widen)
12146 (if pos
12147 (goto-char pos)
12148 (goto-char (point-max))
12149 (if (not (bolp)) (newline)))
12150 (when (looking-at org-outline-regexp)
12151 (setq level (funcall outline-level))
12152 (org-end-of-subtree t t))
12153 (org-back-over-empty-lines)
12154 (insert "\n" (make-string
12155 (if pos (org-get-valid-level level 1) 1) ?*)
12156 " " child "\n")
12157 (beginning-of-line 0)
12158 (list (concat (car parent-target) "/" child) file "" (point)))))))
12160 (defun org-olpath-completing-read (prompt collection &rest args)
12161 "Read an outline path like a file name."
12162 (let ((thetable collection)
12163 (org-completion-use-ido nil) ; does not work with ido.
12164 (org-completion-use-iswitchb nil)) ; or iswitchb
12165 (apply
12166 'org-icompleting-read prompt
12167 (lambda (string predicate &optional flag)
12168 (let (rtn r f (l (length string)))
12169 (cond
12170 ((eq flag nil)
12171 ;; try completion
12172 (try-completion string thetable))
12173 ((eq flag t)
12174 ;; all-completions
12175 (setq rtn (all-completions string thetable predicate))
12176 (mapcar
12177 (lambda (x)
12178 (setq r (substring x l))
12179 (if (string-match " ([^)]*)$" x)
12180 (setq f (match-string 0 x))
12181 (setq f ""))
12182 (if (string-match "/" r)
12183 (concat string (substring r 0 (match-end 0)) f)
12185 rtn))
12186 ((eq flag 'lambda)
12187 ;; exact match?
12188 (assoc string thetable)))))
12189 args)))
12191 ;;;; Dynamic blocks
12193 (defun org-find-dblock (name)
12194 "Find the first dynamic block with name NAME in the buffer.
12195 If not found, stay at current position and return nil."
12196 (let ((case-fold-search t) pos)
12197 (save-excursion
12198 (goto-char (point-min))
12199 (setq pos (and (re-search-forward
12200 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12201 (match-beginning 0))))
12202 (if pos (goto-char pos))
12203 pos))
12205 (defun org-create-dblock (plist)
12206 "Create a dynamic block section, with parameters taken from PLIST.
12207 PLIST must contain a :name entry which is used as the name of the block."
12208 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12209 (end-of-line 1)
12210 (newline))
12211 (let ((col (current-column))
12212 (name (plist-get plist :name)))
12213 (insert "#+BEGIN: " name)
12214 (while plist
12215 (if (eq (car plist) :name)
12216 (setq plist (cddr plist))
12217 (insert " " (prin1-to-string (pop plist)))))
12218 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12219 (beginning-of-line -2)))
12221 (defun org-prepare-dblock ()
12222 "Prepare dynamic block for refresh.
12223 This empties the block, puts the cursor at the insert position and returns
12224 the property list including an extra property :name with the block name."
12225 (unless (looking-at org-dblock-start-re)
12226 (user-error "Not at a dynamic block"))
12227 (let* ((begdel (1+ (match-end 0)))
12228 (name (org-no-properties (match-string 1)))
12229 (params (append (list :name name)
12230 (read (concat "(" (match-string 3) ")")))))
12231 (save-excursion
12232 (beginning-of-line 1)
12233 (skip-chars-forward " \t")
12234 (setq params (plist-put params :indentation-column (current-column))))
12235 (unless (re-search-forward org-dblock-end-re nil t)
12236 (error "Dynamic block not terminated"))
12237 (setq params
12238 (append params
12239 (list :content (buffer-substring
12240 begdel (match-beginning 0)))))
12241 (delete-region begdel (match-beginning 0))
12242 (goto-char begdel)
12243 (open-line 1)
12244 params))
12246 (defun org-map-dblocks (&optional command)
12247 "Apply COMMAND to all dynamic blocks in the current buffer.
12248 If COMMAND is not given, use `org-update-dblock'."
12249 (let ((cmd (or command 'org-update-dblock)))
12250 (save-excursion
12251 (goto-char (point-min))
12252 (while (re-search-forward org-dblock-start-re nil t)
12253 (goto-char (match-beginning 0))
12254 (save-excursion
12255 (condition-case nil
12256 (funcall cmd)
12257 (error (message "Error during update of dynamic block"))))
12258 (unless (re-search-forward org-dblock-end-re nil t)
12259 (error "Dynamic block not terminated"))))))
12261 (defun org-dblock-update (&optional arg)
12262 "User command for updating dynamic blocks.
12263 Update the dynamic block at point. With prefix ARG, update all dynamic
12264 blocks in the buffer."
12265 (interactive "P")
12266 (if arg
12267 (org-update-all-dblocks)
12268 (or (looking-at org-dblock-start-re)
12269 (org-beginning-of-dblock))
12270 (org-update-dblock)))
12272 (defun org-update-dblock ()
12273 "Update the dynamic block at point.
12274 This means to empty the block, parse for parameters and then call
12275 the correct writing function."
12276 (interactive)
12277 (save-excursion
12278 (let* ((win (selected-window))
12279 (pos (point))
12280 (line (org-current-line))
12281 (params (org-prepare-dblock))
12282 (name (plist-get params :name))
12283 (indent (plist-get params :indentation-column))
12284 (cmd (intern (concat "org-dblock-write:" name))))
12285 (message "Updating dynamic block `%s' at line %d..." name line)
12286 (funcall cmd params)
12287 (message "Updating dynamic block `%s' at line %d...done" name line)
12288 (goto-char pos)
12289 (when (and indent (> indent 0))
12290 (setq indent (make-string indent ?\ ))
12291 (save-excursion
12292 (select-window win)
12293 (org-beginning-of-dblock)
12294 (forward-line 1)
12295 (while (not (looking-at org-dblock-end-re))
12296 (insert indent)
12297 (beginning-of-line 2))
12298 (when (looking-at org-dblock-end-re)
12299 (and (looking-at "[ \t]+")
12300 (replace-match ""))
12301 (insert indent)))))))
12303 (defun org-beginning-of-dblock ()
12304 "Find the beginning of the dynamic block at point.
12305 Error if there is no such block at point."
12306 (let ((pos (point))
12307 beg)
12308 (end-of-line 1)
12309 (if (and (re-search-backward org-dblock-start-re nil t)
12310 (setq beg (match-beginning 0))
12311 (re-search-forward org-dblock-end-re nil t)
12312 (> (match-end 0) pos))
12313 (goto-char beg)
12314 (goto-char pos)
12315 (error "Not in a dynamic block"))))
12317 (defun org-update-all-dblocks ()
12318 "Update all dynamic blocks in the buffer.
12319 This function can be used in a hook."
12320 (interactive)
12321 (when (derived-mode-p 'org-mode)
12322 (org-map-dblocks 'org-update-dblock)))
12325 ;;;; Completion
12327 (declare-function org-export-backend-name "org-export" (cl-x))
12328 (declare-function org-export-backend-options "org-export" (cl-x))
12329 (defun org-get-export-keywords ()
12330 "Return a list of all currently understood export keywords.
12331 Export keywords include options, block names, attributes and
12332 keywords relative to each registered export back-end."
12333 (let (keywords)
12334 (dolist (backend
12335 (org-bound-and-true-p org-export--registered-backends)
12336 (delq nil keywords))
12337 ;; Back-end name (for keywords, like #+LATEX:)
12338 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12339 (dolist (option-entry (org-export-backend-options backend))
12340 ;; Back-end options.
12341 (push (nth 1 option-entry) keywords)))))
12343 (defconst org-options-keywords
12344 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12345 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12346 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12347 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12348 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12350 (defcustom org-structure-template-alist
12351 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12352 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12353 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12354 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12355 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12356 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12357 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12358 ("L" "#+LaTeX: ")
12359 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12360 ("H" "#+HTML: ")
12361 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12362 ("A" "#+ASCII: ")
12363 ("i" "#+INDEX: ?")
12364 ("I" "#+INCLUDE: %file ?"))
12365 "Structure completion elements.
12366 This is a list of abbreviation keys and values. The value gets inserted
12367 if you type `<' followed by the key and then press the completion key,
12368 usually `TAB'. %file will be replaced by a file name after prompting
12369 for the file using completion. The cursor will be placed at the position
12370 of the `?` in the template.
12371 There are two templates for each key, the first uses the original Org syntax,
12372 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12373 the default when the /org-mtags.el/ module has been loaded. See also the
12374 variable `org-mtags-prefer-muse-templates'."
12375 :group 'org-completion
12376 :type '(repeat
12377 (list
12378 (string :tag "Key")
12379 (string :tag "Template")))
12380 :version "25.1"
12381 :package-version '(Org . "8.3"))
12383 (defun org-try-structure-completion ()
12384 "Try to complete a structure template before point.
12385 This looks for strings like \"<e\" on an otherwise empty line and
12386 expands them."
12387 (let ((l (buffer-substring (point-at-bol) (point)))
12389 (when (and (looking-at "[ \t]*$")
12390 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12391 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12392 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12393 (match-beginning 1)) a)
12394 t)))
12396 (defun org-complete-expand-structure-template (start cell)
12397 "Expand a structure template."
12398 (let ((rpl (nth 1 cell))
12399 (ind ""))
12400 (delete-region start (point))
12401 (when (string-match "\\`[ \t]*#\\+" rpl)
12402 (cond
12403 ((bolp))
12404 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12405 (setq ind (buffer-substring (point-at-bol) (point))))
12406 (t (newline))))
12407 (setq start (point))
12408 (if (string-match "%file" rpl)
12409 (setq rpl (replace-match
12410 (concat
12411 "\""
12412 (save-match-data
12413 (abbreviate-file-name (read-file-name "Include file: ")))
12414 "\"")
12415 t t rpl)))
12416 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12417 (concat "\n" ind)))
12418 (insert rpl)
12419 (if (re-search-backward "\\?" start t) (delete-char 1))))
12421 ;;;; TODO, DEADLINE, Comments
12423 (defun org-toggle-comment ()
12424 "Change the COMMENT state of an entry."
12425 (interactive)
12426 (save-excursion
12427 (org-back-to-heading)
12428 (looking-at org-complex-heading-regexp)
12429 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12430 (skip-chars-forward " \t")
12431 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12432 (if (org-in-commented-heading-p t)
12433 (delete-region (point)
12434 (progn (search-forward " " (line-end-position) 'move)
12435 (skip-chars-forward " \t")
12436 (point)))
12437 (insert org-comment-string)
12438 (unless (eolp) (insert " ")))))
12440 (defvar org-last-todo-state-is-todo nil
12441 "This is non-nil when the last TODO state change led to a TODO state.
12442 If the last change removed the TODO tag or switched to DONE, then
12443 this is nil.")
12445 (defvar org-setting-tags nil) ; dynamically skipped
12447 (defvar org-todo-setup-filter-hook nil
12448 "Hook for functions that pre-filter todo specs.
12449 Each function takes a todo spec and returns either nil or the spec
12450 transformed into canonical form." )
12452 (defvar org-todo-get-default-hook nil
12453 "Hook for functions that get a default item for todo.
12454 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12455 nil or a string to be used for the todo mark." )
12457 (defvar org-agenda-headline-snapshot-before-repeat)
12459 (defun org-current-effective-time ()
12460 "Return current time adjusted for `org-extend-today-until' variable."
12461 (let* ((ct (org-current-time))
12462 (dct (decode-time ct))
12463 (ct1
12464 (cond
12465 (org-use-last-clock-out-time-as-effective-time
12466 (or (org-clock-get-last-clock-out-time) ct))
12467 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12468 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12469 (t ct))))
12470 ct1))
12472 (defun org-todo-yesterday (&optional arg)
12473 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12474 (interactive "P")
12475 (if (eq major-mode 'org-agenda-mode)
12476 (apply 'org-agenda-todo-yesterday arg)
12477 (let* ((org-use-effective-time t)
12478 (hour (third (decode-time
12479 (org-current-time))))
12480 (org-extend-today-until (1+ hour)))
12481 (org-todo arg))))
12483 (defvar org-block-entry-blocking ""
12484 "First entry preventing the TODO state change.")
12486 (defun org-cancel-repeater ()
12487 "Cancel a repeater by setting its numeric value to zero."
12488 (interactive)
12489 (save-excursion
12490 (org-back-to-heading t)
12491 (let ((bound1 (point))
12492 (bound0 (save-excursion (outline-next-heading) (point))))
12493 (when (re-search-forward
12494 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12495 org-deadline-time-regexp "\\)\\|\\("
12496 org-ts-regexp "\\)")
12497 bound0 t)
12498 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12499 (replace-match "0" t nil nil 1))))))
12501 (defun org-todo (&optional arg)
12502 "Change the TODO state of an item.
12503 The state of an item is given by a keyword at the start of the heading,
12504 like
12505 *** TODO Write paper
12506 *** DONE Call mom
12508 The different keywords are specified in the variable `org-todo-keywords'.
12509 By default the available states are \"TODO\" and \"DONE\".
12510 So for this example: when the item starts with TODO, it is changed to DONE.
12511 When it starts with DONE, the DONE is removed. And when neither TODO nor
12512 DONE are present, add TODO at the beginning of the heading.
12514 With \\[universal-argument] prefix arg, use completion to determine the new \
12515 state.
12516 With numeric prefix arg, switch to that state.
12517 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12518 keywords (nextset).
12519 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12520 With a numeric prefix arg of 0, inhibit note taking for the change.
12521 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12523 When called through ELisp, arg is also interpreted in the following way:
12524 'none -> empty state
12525 \"\"(empty string) -> switch to empty state
12526 'done -> switch to DONE
12527 'nextset -> switch to the next set of keywords
12528 'previousset -> switch to the previous set of keywords
12529 \"WAITING\" -> switch to the specified keyword, but only if it
12530 really is a member of `org-todo-keywords'."
12531 (interactive "P")
12532 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12533 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12534 'region-start-level 'region))
12535 org-loop-over-headlines-in-active-region)
12536 (org-map-entries
12537 `(org-todo ,arg)
12538 org-loop-over-headlines-in-active-region
12539 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12540 (if (equal arg '(16)) (setq arg 'nextset))
12541 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12542 (let ((org-blocker-hook org-blocker-hook)
12543 commentp
12544 case-fold-search)
12545 (when (equal arg '(64))
12546 (setq arg nil org-blocker-hook nil))
12547 (when (and org-blocker-hook
12548 (or org-inhibit-blocking
12549 (org-entry-get nil "NOBLOCKING")))
12550 (setq org-blocker-hook nil))
12551 (save-excursion
12552 (catch 'exit
12553 (org-back-to-heading t)
12554 (when (org-in-commented-heading-p t)
12555 (org-toggle-comment)
12556 (setq commentp t))
12557 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12558 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12559 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12560 (let* ((match-data (match-data))
12561 (startpos (point-at-bol))
12562 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12563 (org-log-done org-log-done)
12564 (org-log-repeat org-log-repeat)
12565 (org-todo-log-states org-todo-log-states)
12566 (org-inhibit-logging
12567 (if (equal arg 0)
12568 (progn (setq arg nil) 'note) org-inhibit-logging))
12569 (this (match-string 1))
12570 (hl-pos (match-beginning 0))
12571 (head (org-get-todo-sequence-head this))
12572 (ass (assoc head org-todo-kwd-alist))
12573 (interpret (nth 1 ass))
12574 (done-word (nth 3 ass))
12575 (final-done-word (nth 4 ass))
12576 (org-last-state (or this ""))
12577 (completion-ignore-case t)
12578 (member (member this org-todo-keywords-1))
12579 (tail (cdr member))
12580 (org-state (cond
12581 ((and org-todo-key-trigger
12582 (or (and (equal arg '(4))
12583 (eq org-use-fast-todo-selection 'prefix))
12584 (and (not arg) org-use-fast-todo-selection
12585 (not (eq org-use-fast-todo-selection
12586 'prefix)))))
12587 ;; Use fast selection
12588 (org-fast-todo-selection))
12589 ((and (equal arg '(4))
12590 (or (not org-use-fast-todo-selection)
12591 (not org-todo-key-trigger)))
12592 ;; Read a state with completion
12593 (org-icompleting-read
12594 "State: " (mapcar 'list org-todo-keywords-1)
12595 nil t))
12596 ((eq arg 'right)
12597 (if this
12598 (if tail (car tail) nil)
12599 (car org-todo-keywords-1)))
12600 ((eq arg 'left)
12601 (if (equal member org-todo-keywords-1)
12603 (if this
12604 (nth (- (length org-todo-keywords-1)
12605 (length tail) 2)
12606 org-todo-keywords-1)
12607 (org-last org-todo-keywords-1))))
12608 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12609 (setq arg nil))) ; hack to fall back to cycling
12610 (arg
12611 ;; user or caller requests a specific state
12612 (cond
12613 ((equal arg "") nil)
12614 ((eq arg 'none) nil)
12615 ((eq arg 'done) (or done-word (car org-done-keywords)))
12616 ((eq arg 'nextset)
12617 (or (car (cdr (member head org-todo-heads)))
12618 (car org-todo-heads)))
12619 ((eq arg 'previousset)
12620 (let ((org-todo-heads (reverse org-todo-heads)))
12621 (or (car (cdr (member head org-todo-heads)))
12622 (car org-todo-heads))))
12623 ((car (member arg org-todo-keywords-1)))
12624 ((stringp arg)
12625 (user-error "State `%s' not valid in this file" arg))
12626 ((nth (1- (prefix-numeric-value arg))
12627 org-todo-keywords-1))))
12628 ((null member) (or head (car org-todo-keywords-1)))
12629 ((equal this final-done-word) nil) ;; -> make empty
12630 ((null tail) nil) ;; -> first entry
12631 ((memq interpret '(type priority))
12632 (if (eq this-command last-command)
12633 (car tail)
12634 (if (> (length tail) 0)
12635 (or done-word (car org-done-keywords))
12636 nil)))
12638 (car tail))))
12639 (org-state (or
12640 (run-hook-with-args-until-success
12641 'org-todo-get-default-hook org-state org-last-state)
12642 org-state))
12643 (next (if org-state (concat " " org-state " ") " "))
12644 (change-plist (list :type 'todo-state-change :from this :to org-state
12645 :position startpos))
12646 dolog now-done-p)
12647 (when org-blocker-hook
12648 (setq org-last-todo-state-is-todo
12649 (not (member this org-done-keywords)))
12650 (unless (save-excursion
12651 (save-match-data
12652 (org-with-wide-buffer
12653 (run-hook-with-args-until-failure
12654 'org-blocker-hook change-plist))))
12655 (if (org-called-interactively-p 'interactive)
12656 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12657 this org-state org-block-entry-blocking)
12658 ;; fail silently
12659 (message "TODO state change from %s to %s blocked (by \"%s\")"
12660 this org-state org-block-entry-blocking)
12661 (throw 'exit nil))))
12662 (store-match-data match-data)
12663 (replace-match next t t)
12664 (cond ((equal this org-state)
12665 (message "TODO state was already %s" (org-trim next)))
12666 ((pos-visible-in-window-p hl-pos)
12667 (message "TODO state changed to %s" (org-trim next))))
12668 (unless head
12669 (setq head (org-get-todo-sequence-head org-state)
12670 ass (assoc head org-todo-kwd-alist)
12671 interpret (nth 1 ass)
12672 done-word (nth 3 ass)
12673 final-done-word (nth 4 ass)))
12674 (when (memq arg '(nextset previousset))
12675 (message "Keyword-Set %d/%d: %s"
12676 (- (length org-todo-sets) -1
12677 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12678 (length org-todo-sets)
12679 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12680 (setq org-last-todo-state-is-todo
12681 (not (member org-state org-done-keywords)))
12682 (setq now-done-p (and (member org-state org-done-keywords)
12683 (not (member this org-done-keywords))))
12684 (and logging (org-local-logging logging))
12685 (when (and (or org-todo-log-states org-log-done)
12686 (not (eq org-inhibit-logging t))
12687 (not (memq arg '(nextset previousset))))
12688 ;; we need to look at recording a time and note
12689 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12690 (nth 2 (assoc this org-todo-log-states))))
12691 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12692 (setq dolog 'time))
12693 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12694 (and org-state
12695 (member org-state org-not-done-keywords)
12696 (not (member this org-not-done-keywords))))
12697 ;; This is now a todo state and was not one before
12698 ;; If there was a CLOSED time stamp, get rid of it.
12699 (org-add-planning-info nil nil 'closed))
12700 (when (and now-done-p org-log-done)
12701 ;; It is now done, and it was not done before
12702 (org-add-planning-info 'closed (org-current-effective-time))
12703 (if (and (not dolog) (eq 'note org-log-done))
12704 (org-add-log-setup 'done org-state this 'findpos 'note)))
12705 (when (and org-state dolog)
12706 ;; This is a non-nil state, and we need to log it
12707 (org-add-log-setup 'state org-state this 'findpos dolog)))
12708 ;; Fixup tag positioning
12709 (org-todo-trigger-tag-changes org-state)
12710 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12711 (when org-provide-todo-statistics
12712 (org-update-parent-todo-statistics))
12713 (run-hooks 'org-after-todo-state-change-hook)
12714 (if (and arg (not (member org-state org-done-keywords)))
12715 (setq head (org-get-todo-sequence-head org-state)))
12716 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12717 ;; Do we need to trigger a repeat?
12718 (when now-done-p
12719 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12720 ;; This is for the agenda, take a snapshot of the headline.
12721 (save-match-data
12722 (setq org-agenda-headline-snapshot-before-repeat
12723 (org-get-heading))))
12724 (org-auto-repeat-maybe org-state))
12725 ;; Fixup cursor location if close to the keyword
12726 (if (and (outline-on-heading-p)
12727 (not (bolp))
12728 (save-excursion (beginning-of-line 1)
12729 (looking-at org-todo-line-regexp))
12730 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12731 (progn
12732 (goto-char (or (match-end 2) (match-end 1)))
12733 (and (looking-at " ") (just-one-space))))
12734 (when org-trigger-hook
12735 (save-excursion
12736 (run-hook-with-args 'org-trigger-hook change-plist)))
12737 (when commentp (org-toggle-comment))))))))
12739 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12740 "Block turning an entry into a TODO, using the hierarchy.
12741 This checks whether the current task should be blocked from state
12742 changes. Such blocking occurs when:
12744 1. The task has children which are not all in a completed state.
12746 2. A task has a parent with the property :ORDERED:, and there
12747 are siblings prior to the current task with incomplete
12748 status.
12750 3. The parent of the task is blocked because it has siblings that should
12751 be done first, or is child of a block grandparent TODO entry."
12753 (if (not org-enforce-todo-dependencies)
12754 t ; if locally turned off don't block
12755 (catch 'dont-block
12756 ;; If this is not a todo state change, or if this entry is already DONE,
12757 ;; do not block
12758 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12759 (member (plist-get change-plist :from)
12760 (cons 'done org-done-keywords))
12761 (member (plist-get change-plist :to)
12762 (cons 'todo org-not-done-keywords))
12763 (not (plist-get change-plist :to)))
12764 (throw 'dont-block t))
12765 ;; If this task has children, and any are undone, it's blocked
12766 (save-excursion
12767 (org-back-to-heading t)
12768 (let ((this-level (funcall outline-level)))
12769 (outline-next-heading)
12770 (let ((child-level (funcall outline-level)))
12771 (while (and (not (eobp))
12772 (> child-level this-level))
12773 ;; this todo has children, check whether they are all
12774 ;; completed
12775 (if (and (not (org-entry-is-done-p))
12776 (org-entry-is-todo-p))
12777 (progn (setq org-block-entry-blocking (org-get-heading))
12778 (throw 'dont-block nil)))
12779 (outline-next-heading)
12780 (setq child-level (funcall outline-level))))))
12781 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12782 ;; any previous siblings are undone, it's blocked
12783 (save-excursion
12784 (org-back-to-heading t)
12785 (let* ((pos (point))
12786 (parent-pos (and (org-up-heading-safe) (point))))
12787 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12788 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12789 (forward-line 1)
12790 (re-search-forward org-not-done-heading-regexp pos t))
12791 (setq org-block-entry-blocking (match-string 0))
12792 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12793 ;; Search further up the hierarchy, to see if an ancestor is blocked
12794 (while t
12795 (goto-char parent-pos)
12796 (if (not (looking-at org-not-done-heading-regexp))
12797 (throw 'dont-block t)) ; do not block, parent is not a TODO
12798 (setq pos (point))
12799 (setq parent-pos (and (org-up-heading-safe) (point)))
12800 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12801 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12802 (forward-line 1)
12803 (re-search-forward org-not-done-heading-regexp pos t)
12804 (setq org-block-entry-blocking (org-get-heading)))
12805 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12807 (defcustom org-track-ordered-property-with-tag nil
12808 "Should the ORDERED property also be shown as a tag?
12809 The ORDERED property decides if an entry should require subtasks to be
12810 completed in sequence. Since a property is not very visible, setting
12811 this option means that toggling the ORDERED property with the command
12812 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12813 not relevant for the behavior, but it makes things more visible.
12815 Note that toggling the tag with tags commands will not change the property
12816 and therefore not influence behavior!
12818 This can be t, meaning the tag ORDERED should be used, It can also be a
12819 string to select a different tag for this task."
12820 :group 'org-todo
12821 :type '(choice
12822 (const :tag "No tracking" nil)
12823 (const :tag "Track with ORDERED tag" t)
12824 (string :tag "Use other tag")))
12826 (defun org-toggle-ordered-property ()
12827 "Toggle the ORDERED property of the current entry.
12828 For better visibility, you can track the value of this property with a tag.
12829 See variable `org-track-ordered-property-with-tag'."
12830 (interactive)
12831 (let* ((t1 org-track-ordered-property-with-tag)
12832 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12833 (save-excursion
12834 (org-back-to-heading)
12835 (if (org-entry-get nil "ORDERED")
12836 (progn
12837 (org-delete-property "ORDERED")
12838 (and tag (org-toggle-tag tag 'off))
12839 (message "Subtasks can be completed in arbitrary order"))
12840 (org-entry-put nil "ORDERED" "t")
12841 (and tag (org-toggle-tag tag 'on))
12842 (message "Subtasks must be completed in sequence")))))
12844 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12845 (defun org-block-todo-from-checkboxes (change-plist)
12846 "Block turning an entry into a TODO, using checkboxes.
12847 This checks whether the current task should be blocked from state
12848 changes because there are unchecked boxes in this entry."
12849 (if (not org-enforce-todo-checkbox-dependencies)
12850 t ; if locally turned off don't block
12851 (catch 'dont-block
12852 ;; If this is not a todo state change, or if this entry is already DONE,
12853 ;; do not block
12854 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12855 (member (plist-get change-plist :from)
12856 (cons 'done org-done-keywords))
12857 (member (plist-get change-plist :to)
12858 (cons 'todo org-not-done-keywords))
12859 (not (plist-get change-plist :to)))
12860 (throw 'dont-block t))
12861 ;; If this task has checkboxes that are not checked, it's blocked
12862 (save-excursion
12863 (org-back-to-heading t)
12864 (let ((beg (point)) end)
12865 (outline-next-heading)
12866 (setq end (point))
12867 (goto-char beg)
12868 (if (org-list-search-forward
12869 (concat (org-item-beginning-re)
12870 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12871 "\\[[- ]\\]")
12872 end t)
12873 (progn
12874 (if (boundp 'org-blocked-by-checkboxes)
12875 (setq org-blocked-by-checkboxes t))
12876 (throw 'dont-block nil)))))
12877 t))) ; do not block
12879 (defun org-entry-blocked-p ()
12880 "Is the current entry blocked?"
12881 (org-with-silent-modifications
12882 (if (org-entry-get nil "NOBLOCKING")
12883 nil ;; Never block this entry
12884 (not (run-hook-with-args-until-failure
12885 'org-blocker-hook
12886 (list :type 'todo-state-change
12887 :position (point)
12888 :from 'todo
12889 :to 'done))))))
12891 (defun org-update-statistics-cookies (all)
12892 "Update the statistics cookie, either from TODO or from checkboxes.
12893 This should be called with the cursor in a line with a statistics cookie."
12894 (interactive "P")
12895 (if all
12896 (progn
12897 (org-update-checkbox-count 'all)
12898 (org-map-entries 'org-update-parent-todo-statistics))
12899 (if (not (org-at-heading-p))
12900 (org-update-checkbox-count)
12901 (let ((pos (point-marker))
12902 end l1 l2)
12903 (ignore-errors (org-back-to-heading t))
12904 (if (not (org-at-heading-p))
12905 (org-update-checkbox-count)
12906 (setq l1 (org-outline-level))
12907 (setq end (save-excursion
12908 (outline-next-heading)
12909 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12910 (point)))
12911 (if (and (save-excursion
12912 (re-search-forward
12913 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12914 (not (save-excursion (re-search-forward
12915 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12916 (org-update-checkbox-count)
12917 (if (and l2 (> l2 l1))
12918 (progn
12919 (goto-char end)
12920 (org-update-parent-todo-statistics))
12921 (goto-char pos)
12922 (beginning-of-line 1)
12923 (while (re-search-forward
12924 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12925 (point-at-eol) t)
12926 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12927 (goto-char pos)
12928 (move-marker pos nil)))))
12930 (defvar org-entry-property-inherited-from) ;; defined below
12931 (defun org-update-parent-todo-statistics ()
12932 "Update any statistics cookie in the parent of the current headline.
12933 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12934 the entire subtree and this will travel up the hierarchy and update
12935 statistics everywhere."
12936 (let* ((prop (save-excursion (org-up-heading-safe)
12937 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12938 (recursive (or (not org-hierarchical-todo-statistics)
12939 (and prop (string-match "\\<recursive\\>" prop))))
12940 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12942 (first t)
12943 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12944 level ltoggle l1 new ndel
12945 (cnt-all 0) (cnt-done 0) is-percent kwd
12946 checkbox-beg ov ovs ove cookie-present)
12947 (catch 'exit
12948 (save-excursion
12949 (beginning-of-line 1)
12950 (setq ltoggle (funcall outline-level))
12951 ;; Three situations are to consider:
12953 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12954 ;; to the top-level ancestor on the headline;
12956 ;; 2. If parent has "recursive" property, repeat up to the
12957 ;; headline setting that property, taking inheritance into
12958 ;; account;
12960 ;; 3. Else, move up to direct parent and proceed only once.
12961 (while (and (setq level (org-up-heading-safe))
12962 (or recursive first)
12963 (>= (point) lim))
12964 (setq first nil cookie-present nil)
12965 (unless (and level
12966 (not (string-match
12967 "\\<checkbox\\>"
12968 (downcase (or (org-entry-get nil "COOKIE_DATA")
12969 "")))))
12970 (throw 'exit nil))
12971 (while (re-search-forward box-re (point-at-eol) t)
12972 (setq cnt-all 0 cnt-done 0 cookie-present t)
12973 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12974 (save-match-data
12975 (unless (outline-next-heading) (throw 'exit nil))
12976 (while (and (looking-at org-complex-heading-regexp)
12977 (> (setq l1 (length (match-string 1))) level))
12978 (setq kwd (and (or recursive (= l1 ltoggle))
12979 (match-string 2)))
12980 (if (or (eq org-provide-todo-statistics 'all-headlines)
12981 (and (eq org-provide-todo-statistics t)
12982 (or (member kwd org-done-keywords)))
12983 (and (listp org-provide-todo-statistics)
12984 (stringp (car org-provide-todo-statistics))
12985 (or (member kwd org-provide-todo-statistics)
12986 (member kwd org-done-keywords)))
12987 (and (listp org-provide-todo-statistics)
12988 (listp (car org-provide-todo-statistics))
12989 (or (member kwd (car org-provide-todo-statistics))
12990 (and (member kwd org-done-keywords)
12991 (member kwd (cadr org-provide-todo-statistics))))))
12992 (setq cnt-all (1+ cnt-all))
12993 (if (eq org-provide-todo-statistics t)
12994 (and kwd (setq cnt-all (1+ cnt-all)))))
12995 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12996 (member kwd org-done-keywords))
12997 (and (listp org-provide-todo-statistics)
12998 (listp (car org-provide-todo-statistics))
12999 (member kwd org-done-keywords)
13000 (member kwd (cadr org-provide-todo-statistics)))
13001 (and (listp org-provide-todo-statistics)
13002 (stringp (car org-provide-todo-statistics))
13003 (member kwd org-done-keywords)))
13004 (setq cnt-done (1+ cnt-done)))
13005 (outline-next-heading)))
13006 (setq new
13007 (if is-percent
13008 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
13009 (format "[%d/%d]" cnt-done cnt-all))
13010 ndel (- (match-end 0) checkbox-beg))
13011 ;; handle overlays when updating cookie from column view
13012 (when (setq ov (car (overlays-at checkbox-beg)))
13013 (setq ovs (overlay-start ov) ove (overlay-end ov))
13014 (delete-overlay ov))
13015 (goto-char checkbox-beg)
13016 (insert new)
13017 (delete-region (point) (+ (point) ndel))
13018 (when org-auto-align-tags (org-fix-tags-on-the-fly))
13019 (when ov (move-overlay ov ovs ove)))
13020 (when cookie-present
13021 (run-hook-with-args 'org-after-todo-statistics-hook
13022 cnt-done (- cnt-all cnt-done))))))
13023 (run-hooks 'org-todo-statistics-hook)))
13025 (defvar org-after-todo-statistics-hook nil
13026 "Hook that is called after a TODO statistics cookie has been updated.
13027 Each function is called with two arguments: the number of not-done entries
13028 and the number of done entries.
13030 For example, the following function, when added to this hook, will switch
13031 an entry to DONE when all children are done, and back to TODO when new
13032 entries are set to a TODO status. Note that this hook is only called
13033 when there is a statistics cookie in the headline!
13035 (defun org-summary-todo (n-done n-not-done)
13036 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13037 (let (org-log-done org-log-states) ; turn off logging
13038 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13041 (defvar org-todo-statistics-hook nil
13042 "Hook that is run whenever Org thinks TODO statistics should be updated.
13043 This hook runs even if there is no statistics cookie present, in which case
13044 `org-after-todo-statistics-hook' would not run.")
13046 (defun org-todo-trigger-tag-changes (state)
13047 "Apply the changes defined in `org-todo-state-tags-triggers'."
13048 (let ((l org-todo-state-tags-triggers)
13049 changes)
13050 (when (or (not state) (equal state ""))
13051 (setq changes (append changes (cdr (assoc "" l)))))
13052 (when (and (stringp state) (> (length state) 0))
13053 (setq changes (append changes (cdr (assoc state l)))))
13054 (when (member state org-not-done-keywords)
13055 (setq changes (append changes (cdr (assoc 'todo l)))))
13056 (when (member state org-done-keywords)
13057 (setq changes (append changes (cdr (assoc 'done l)))))
13058 (dolist (c changes)
13059 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13061 (defun org-local-logging (value)
13062 "Get logging settings from a property VALUE."
13063 (let* (words w a)
13064 ;; directly set the variables, they are already local.
13065 (setq org-log-done nil
13066 org-log-repeat nil
13067 org-todo-log-states nil)
13068 (setq words (org-split-string value))
13069 (while (setq w (pop words))
13070 (cond
13071 ((setq a (assoc w org-startup-options))
13072 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13073 (set (nth 1 a) (nth 2 a))))
13074 ((setq a (org-extract-log-state-settings w))
13075 (and (member (car a) org-todo-keywords-1)
13076 (push a org-todo-log-states)))))))
13078 (defun org-get-todo-sequence-head (kwd)
13079 "Return the head of the TODO sequence to which KWD belongs.
13080 If KWD is not set, check if there is a text property remembering the
13081 right sequence."
13082 (let (p)
13083 (cond
13084 ((not kwd)
13085 (or (get-text-property (point-at-bol) 'org-todo-head)
13086 (progn
13087 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13088 nil (point-at-eol)))
13089 (get-text-property p 'org-todo-head))))
13090 ((not (member kwd org-todo-keywords-1))
13091 (car org-todo-keywords-1))
13092 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13094 (defun org-fast-todo-selection ()
13095 "Fast TODO keyword selection with single keys.
13096 Returns the new TODO keyword, or nil if no state change should occur."
13097 (let* ((fulltable org-todo-key-alist)
13098 (done-keywords org-done-keywords) ;; needed for the faces.
13099 (maxlen (apply 'max (mapcar
13100 (lambda (x)
13101 (if (stringp (car x)) (string-width (car x)) 0))
13102 fulltable)))
13103 (expert nil)
13104 (fwidth (+ maxlen 3 1 3))
13105 (ncol (/ (- (window-width) 4) fwidth))
13106 tg cnt e c tbl
13107 groups ingroup)
13108 (save-excursion
13109 (save-window-excursion
13110 (if expert
13111 (set-buffer (get-buffer-create " *Org todo*"))
13112 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13113 (erase-buffer)
13114 (org-set-local 'org-done-keywords done-keywords)
13115 (setq tbl fulltable cnt 0)
13116 (while (setq e (pop tbl))
13117 (cond
13118 ((equal e '(:startgroup))
13119 (push '() groups) (setq ingroup t)
13120 (when (not (= cnt 0))
13121 (setq cnt 0)
13122 (insert "\n"))
13123 (insert "{ "))
13124 ((equal e '(:endgroup))
13125 (setq ingroup nil cnt 0)
13126 (insert "}\n"))
13127 ((equal e '(:newline))
13128 (when (not (= cnt 0))
13129 (setq cnt 0)
13130 (insert "\n")
13131 (setq e (car tbl))
13132 (while (equal (car tbl) '(:newline))
13133 (insert "\n")
13134 (setq tbl (cdr tbl)))))
13136 (setq tg (car e) c (cdr e))
13137 (if ingroup (push tg (car groups)))
13138 (setq tg (org-add-props tg nil 'face
13139 (org-get-todo-face tg)))
13140 (if (and (= cnt 0) (not ingroup)) (insert " "))
13141 (insert "[" c "] " tg (make-string
13142 (- fwidth 4 (length tg)) ?\ ))
13143 (when (= (setq cnt (1+ cnt)) ncol)
13144 (insert "\n")
13145 (if ingroup (insert " "))
13146 (setq cnt 0)))))
13147 (insert "\n")
13148 (goto-char (point-min))
13149 (if (not expert) (org-fit-window-to-buffer))
13150 (message "[a-z..]:Set [SPC]:clear")
13151 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13152 (cond
13153 ((or (= c ?\C-g)
13154 (and (= c ?q) (not (rassoc c fulltable))))
13155 (setq quit-flag t))
13156 ((= c ?\ ) nil)
13157 ((setq e (rassoc c fulltable) tg (car e))
13159 (t (setq quit-flag t)))))))
13161 (defun org-entry-is-todo-p ()
13162 (member (org-get-todo-state) org-not-done-keywords))
13164 (defun org-entry-is-done-p ()
13165 (member (org-get-todo-state) org-done-keywords))
13167 (defun org-get-todo-state ()
13168 "Return the TODO keyword of the current subtree."
13169 (save-excursion
13170 (org-back-to-heading t)
13171 (and (looking-at org-todo-line-regexp)
13172 (match-end 2)
13173 (match-string 2))))
13175 (defun org-at-date-range-p (&optional inactive-ok)
13176 "Is the cursor inside a date range?"
13177 (interactive)
13178 (save-excursion
13179 (catch 'exit
13180 (let ((pos (point)))
13181 (skip-chars-backward "^[<\r\n")
13182 (skip-chars-backward "<[")
13183 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13184 (>= (match-end 0) pos)
13185 (throw 'exit t))
13186 (skip-chars-backward "^<[\r\n")
13187 (skip-chars-backward "<[")
13188 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13189 (>= (match-end 0) pos)
13190 (throw 'exit t)))
13191 nil)))
13193 (defun org-get-repeat (&optional tagline)
13194 "Check if there is a deadline/schedule with repeater in this entry."
13195 (save-match-data
13196 (save-excursion
13197 (org-back-to-heading t)
13198 (and (re-search-forward (if tagline
13199 (concat tagline "\\s-*" org-repeat-re)
13200 org-repeat-re)
13201 (org-entry-end-position) t)
13202 (match-string-no-properties 1)))))
13204 (defvar org-last-changed-timestamp)
13205 (defvar org-last-inserted-timestamp)
13206 (defvar org-log-post-message)
13207 (defvar org-log-note-purpose)
13208 (defvar org-log-note-how nil)
13209 (defvar org-log-note-extra)
13210 (defun org-auto-repeat-maybe (done-word)
13211 "Check if the current headline contains a repeated deadline/schedule.
13212 If yes, set TODO state back to what it was and change the base date
13213 of repeating deadline/scheduled time stamps to new date.
13214 This function is run automatically after each state change to a DONE state."
13215 ;; last-state is dynamically scoped into this function
13216 (let* ((repeat (org-get-repeat))
13217 (aa (assoc org-last-state org-todo-kwd-alist))
13218 (interpret (nth 1 aa))
13219 (head (nth 2 aa))
13220 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13221 (msg "Entry repeats: ")
13222 (org-log-done nil)
13223 (org-todo-log-states nil)
13224 re type n what ts time to-state)
13225 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13226 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13227 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13228 org-todo-repeat-to-state))
13229 (unless (and to-state (member to-state org-todo-keywords-1))
13230 (setq to-state (if (eq interpret 'type) org-last-state head)))
13231 (org-todo to-state)
13232 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13233 (org-entry-put nil "LAST_REPEAT" (format-time-string
13234 (org-time-stamp-format t t))))
13235 (when org-log-repeat
13236 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13237 (memq 'org-add-log-note post-command-hook))
13238 ;; OK, we are already setup for some record
13239 (if (eq org-log-repeat 'note)
13240 ;; make sure we take a note, not only a time stamp
13241 (setq org-log-note-how 'note))
13242 ;; Set up for taking a record
13243 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13244 org-last-state
13245 'findpos org-log-repeat)))
13246 (org-back-to-heading t)
13247 (org-add-planning-info nil nil 'closed)
13248 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13249 org-deadline-time-regexp "\\)\\|\\("
13250 org-ts-regexp "\\)"))
13251 (while (re-search-forward
13252 re (save-excursion (outline-next-heading) (point)) t)
13253 (setq type (if (match-end 1) org-scheduled-string
13254 (if (match-end 3) org-deadline-string "Plain:"))
13255 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13256 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13257 (setq n (string-to-number (match-string 2 ts))
13258 what (match-string 3 ts))
13259 (if (equal what "w") (setq n (* n 7) what "d"))
13260 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13261 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13262 ;; Preparation, see if we need to modify the start date for the change
13263 (when (match-end 1)
13264 (setq time (save-match-data (org-time-string-to-time ts)))
13265 (cond
13266 ((equal (match-string 1 ts) ".")
13267 ;; Shift starting date to today
13268 (org-timestamp-change
13269 (- (org-today) (time-to-days time))
13270 'day))
13271 ((equal (match-string 1 ts) "+")
13272 (let ((nshiftmax 10) (nshift 0))
13273 (while (or (= nshift 0)
13274 (<= (time-to-days time)
13275 (time-to-days (current-time))))
13276 (when (= (incf nshift) nshiftmax)
13277 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13278 (user-error "Abort")))
13279 (org-timestamp-change n (cdr (assoc what whata)))
13280 (org-at-timestamp-p t)
13281 (setq ts (match-string 1))
13282 (setq time (save-match-data (org-time-string-to-time ts)))))
13283 (org-timestamp-change (- n) (cdr (assoc what whata)))
13284 ;; rematch, so that we have everything in place for the real shift
13285 (org-at-timestamp-p t)
13286 (setq ts (match-string 1))
13287 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13288 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13289 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13290 (setq org-log-post-message msg)
13291 (message "%s" msg))))
13293 (defun org-show-todo-tree (arg)
13294 "Make a compact tree which shows all headlines marked with TODO.
13295 The tree will show the lines where the regexp matches, and all higher
13296 headlines above the match.
13297 With a \\[universal-argument] prefix, prompt for a regexp to match.
13298 With a numeric prefix N, construct a sparse tree for the Nth element
13299 of `org-todo-keywords-1'."
13300 (interactive "P")
13301 (let ((case-fold-search nil)
13302 (kwd-re
13303 (cond ((null arg) org-not-done-regexp)
13304 ((equal arg '(4))
13305 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13306 (mapcar 'list org-todo-keywords-1))))
13307 (concat "\\("
13308 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13309 "\\)\\>")))
13310 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13311 (regexp-quote (nth (1- (prefix-numeric-value arg))
13312 org-todo-keywords-1)))
13313 (t (user-error "Invalid prefix argument: %s" arg)))))
13314 (message "%d TODO entries found"
13315 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13317 (defun org-deadline (arg &optional time)
13318 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13319 With one universal prefix argument, remove any deadline from the item.
13320 With two universal prefix arguments, prompt for a warning delay.
13321 With argument TIME, set the deadline at the corresponding date. TIME
13322 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13323 (interactive "P")
13324 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13325 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13326 'region-start-level 'region))
13327 org-loop-over-headlines-in-active-region)
13328 (org-map-entries
13329 `(org-deadline ',arg ,time)
13330 org-loop-over-headlines-in-active-region
13331 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13332 (let* ((old-date (org-entry-get nil "DEADLINE"))
13333 (old-date-time (if old-date (org-time-string-to-time old-date)))
13334 (repeater (and old-date
13335 (string-match
13336 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13337 old-date)
13338 (match-string 1 old-date))))
13339 (cond
13340 ((equal arg '(4))
13341 (when (and old-date org-log-redeadline)
13342 (org-add-log-setup 'deldeadline nil old-date 'findpos
13343 org-log-redeadline))
13344 (org-remove-timestamp-with-keyword org-deadline-string)
13345 (message "Item no longer has a deadline."))
13346 ((equal arg '(16))
13347 (save-excursion
13348 (org-back-to-heading t)
13349 (if (re-search-forward
13350 org-deadline-time-regexp
13351 (save-excursion (outline-next-heading) (point)) t)
13352 (let* ((rpl0 (match-string 1))
13353 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13354 (replace-match
13355 (concat org-deadline-string
13356 " <" rpl
13357 (format " -%dd"
13358 (abs
13359 (- (time-to-days
13360 (save-match-data
13361 (org-read-date nil t nil "Warn starting from" old-date-time)))
13362 (time-to-days old-date-time))))
13363 ">") t t))
13364 (user-error "No deadline information to update"))))
13366 (org-add-planning-info 'deadline time 'closed)
13367 (when (and old-date org-log-redeadline
13368 (not (equal old-date
13369 (substring org-last-inserted-timestamp 1 -1))))
13370 (org-add-log-setup 'redeadline nil old-date 'findpos
13371 org-log-redeadline))
13372 (when repeater
13373 (save-excursion
13374 (org-back-to-heading t)
13375 (when (re-search-forward (concat org-deadline-string " "
13376 org-last-inserted-timestamp)
13377 (save-excursion
13378 (outline-next-heading) (point)) t)
13379 (goto-char (1- (match-end 0)))
13380 (insert " " repeater)
13381 (setq org-last-inserted-timestamp
13382 (concat (substring org-last-inserted-timestamp 0 -1)
13383 " " repeater
13384 (substring org-last-inserted-timestamp -1))))))
13385 (message "Deadline on %s" org-last-inserted-timestamp))))))
13387 (defun org-schedule (arg &optional time)
13388 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13389 With one universal prefix argument, remove any scheduling date from the item.
13390 With two universal prefix arguments, prompt for a delay cookie.
13391 With argument TIME, scheduled at the corresponding date. TIME can
13392 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13393 (interactive "P")
13394 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13395 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13396 'region-start-level 'region))
13397 org-loop-over-headlines-in-active-region)
13398 (org-map-entries
13399 `(org-schedule ',arg ,time)
13400 org-loop-over-headlines-in-active-region
13401 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13402 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13403 (old-date-time (if old-date (org-time-string-to-time old-date)))
13404 (repeater (and old-date
13405 (string-match
13406 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13407 old-date)
13408 (match-string 1 old-date))))
13409 (cond
13410 ((equal arg '(4))
13411 (progn
13412 (when (and old-date org-log-reschedule)
13413 (org-add-log-setup 'delschedule nil old-date 'findpos
13414 org-log-reschedule))
13415 (org-remove-timestamp-with-keyword org-scheduled-string)
13416 (message "Item is no longer scheduled.")))
13417 ((equal arg '(16))
13418 (save-excursion
13419 (org-back-to-heading t)
13420 (if (re-search-forward
13421 org-scheduled-time-regexp
13422 (save-excursion (outline-next-heading) (point)) t)
13423 (let* ((rpl0 (match-string 1))
13424 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13425 (replace-match
13426 (concat org-scheduled-string
13427 " <" rpl
13428 (format " -%dd"
13429 (abs
13430 (- (time-to-days
13431 (save-match-data
13432 (org-read-date nil t nil "Delay until" old-date-time)))
13433 (time-to-days old-date-time))))
13434 ">") t t))
13435 (user-error "No scheduled information to update"))))
13437 (org-add-planning-info 'scheduled time 'closed)
13438 (when (and old-date org-log-reschedule
13439 (not (equal old-date
13440 (substring org-last-inserted-timestamp 1 -1))))
13441 (org-add-log-setup 'reschedule nil old-date 'findpos
13442 org-log-reschedule))
13443 (when repeater
13444 (save-excursion
13445 (org-back-to-heading t)
13446 (when (re-search-forward (concat org-scheduled-string " "
13447 org-last-inserted-timestamp)
13448 (save-excursion
13449 (outline-next-heading) (point)) t)
13450 (goto-char (1- (match-end 0)))
13451 (insert " " repeater)
13452 (setq org-last-inserted-timestamp
13453 (concat (substring org-last-inserted-timestamp 0 -1)
13454 " " repeater
13455 (substring org-last-inserted-timestamp -1))))))
13456 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13458 (defun org-get-scheduled-time (pom &optional inherit)
13459 "Get the scheduled time as a time tuple, of a format suitable
13460 for calling org-schedule with, or if there is no scheduling,
13461 returns nil."
13462 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13463 (when time
13464 (apply 'encode-time (org-parse-time-string time)))))
13466 (defun org-get-deadline-time (pom &optional inherit)
13467 "Get the deadline as a time tuple, of a format suitable for
13468 calling org-deadline with, or if there is no scheduling, returns
13469 nil."
13470 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13471 (when time
13472 (apply 'encode-time (org-parse-time-string time)))))
13474 (defun org-remove-timestamp-with-keyword (keyword)
13475 "Remove all time stamps with KEYWORD in the current entry."
13476 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13477 beg)
13478 (save-excursion
13479 (org-back-to-heading t)
13480 (setq beg (point))
13481 (outline-next-heading)
13482 (while (re-search-backward re beg t)
13483 (replace-match "")
13484 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13485 (equal (char-before) ?\ ))
13486 (backward-delete-char 1)
13487 (if (string-match "^[ \t]*$" (buffer-substring
13488 (point-at-bol) (point-at-eol)))
13489 (delete-region (point-at-bol)
13490 (min (point-max) (1+ (point-at-eol))))))))))
13492 (defvar org-time-was-given) ; dynamically scoped parameter
13493 (defvar org-end-time-was-given) ; dynamically scoped parameter
13495 (defun org-add-planning-info (what &optional time &rest remove)
13496 "Insert new timestamp with keyword in the planning line.
13497 WHAT indicates what kind of time stamp to add. It is a symbol
13498 among `closed', `deadline', `scheduled' and nil. TIME indicates
13499 the time to use. If none is given, the user is prompted for
13500 a date. REMOVE indicates what kind of entries to remove. An old
13501 WHAT entry will also be removed."
13502 (let (org-time-was-given org-end-time-was-given default-time default-input)
13503 (catch 'exit
13504 (when (and (memq what '(scheduled deadline))
13505 (or (not time)
13506 (and (stringp time)
13507 (string-match "^[-+]+[0-9]" time))))
13508 ;; Try to get a default date/time from existing timestamp
13509 (save-excursion
13510 (org-back-to-heading t)
13511 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13512 (when (re-search-forward (if (eq what 'scheduled)
13513 org-scheduled-time-regexp
13514 org-deadline-time-regexp)
13515 end t)
13516 (setq ts (match-string 1)
13517 default-time (apply 'encode-time (org-parse-time-string ts))
13518 default-input (and ts (org-get-compact-tod ts)))))))
13519 (when what
13520 (setq time
13521 (if (stringp time)
13522 ;; This is a string (relative or absolute), set
13523 ;; proper date.
13524 (apply #'encode-time
13525 (org-read-date-analyze
13526 time default-time (decode-time default-time)))
13527 ;; If necessary, get the time from the user
13528 (or time (org-read-date nil 'to-time nil nil
13529 default-time default-input)))))
13531 (org-with-wide-buffer
13532 (org-back-to-heading t)
13533 (forward-line)
13534 (unless (bolp) (insert "\n"))
13535 (cond ((org-looking-at-p org-planning-line-re)
13536 ;; Move to current indentation.
13537 (skip-chars-forward " \t")
13538 ;; Check if we have to remove something.
13539 (dolist (type (if what (cons what remove) remove))
13540 (when (save-excursion
13541 (re-search-forward
13542 (case type
13543 (closed org-closed-time-regexp)
13544 (deadline org-deadline-time-regexp)
13545 (scheduled org-scheduled-time-regexp)
13546 (otherwise (error "Invalid planning type: %s" type)))
13547 (line-end-position) t))
13548 (replace-match "")
13549 (when (looking-at "--+<[^>]+>") (replace-match ""))
13550 (when (and (not what) (eq type 'closed))
13551 (save-excursion
13552 (beginning-of-line)
13553 (if (looking-at "[ \t]*$")
13554 (delete-region (point) (1+ (point-at-eol)))))))
13555 ;; Remove leading white spaces.
13556 (when (and (not (bolp)) (looking-at "[ \t]+")) (replace-match ""))))
13557 ((not what) (throw 'exit nil)) ; Nothing to do.
13558 (t (insert-before-markers "\n")
13559 (backward-char 1)
13560 (when org-adapt-indentation
13561 (org-indent-to-column (1+ (org-outline-level))))))
13562 (when what
13563 ;; Insert planning keyword.
13564 (insert (case what
13565 (closed org-closed-string)
13566 (deadline org-deadline-string)
13567 (scheduled org-scheduled-string)
13568 (otherwise (error "Invalid planning type: %s" what)))
13569 " ")
13570 ;; Insert associated timestamp.
13571 (let ((ts (org-insert-time-stamp
13572 time
13573 (or org-time-was-given
13574 (and (eq what 'closed) org-log-done-with-time))
13575 (eq what 'closed)
13576 nil nil (list org-end-time-was-given))))
13577 (unless (eolp) (insert " "))
13578 ts))))))
13580 (defvar org-log-note-marker (make-marker))
13581 (defvar org-log-note-purpose nil)
13582 (defvar org-log-note-state nil)
13583 (defvar org-log-note-previous-state nil)
13584 (defvar org-log-note-extra nil)
13585 (defvar org-log-note-window-configuration nil)
13586 (defvar org-log-note-return-to (make-marker))
13587 (defvar org-log-note-effective-time nil
13588 "Remembered current time so that dynamically scoped
13589 `org-extend-today-until' affects tha timestamps in state change
13590 log")
13592 (defvar org-log-post-message nil
13593 "Message to be displayed after a log note has been stored.
13594 The auto-repeater uses this.")
13596 (defun org-add-note ()
13597 "Add a note to the current entry.
13598 This is done in the same way as adding a state change note."
13599 (interactive)
13600 (org-add-log-setup 'note nil nil 'findpos nil))
13602 (defun org-log-beginning (&optional create)
13603 "Return expected start of log notes in current entry.
13604 When optional argument CREATE is non-nil, the function creates
13605 a drawer to store notes, if necessary. Returned position ignores
13606 narrowing."
13607 (org-with-wide-buffer
13608 (org-back-to-heading t)
13609 ;; Skip planning info and property drawer.
13610 (forward-line)
13611 (when (org-looking-at-p org-planning-line-re) (forward-line))
13612 (when (looking-at org-property-drawer-re)
13613 (goto-char (match-end 0))
13614 (forward-line))
13615 (if (org-at-heading-p) (point)
13616 (let ((end (save-excursion (outline-next-heading) (point)))
13617 (drawer (org-log-into-drawer)))
13618 (cond
13619 (drawer
13620 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13621 (case-fold-search t))
13622 (catch 'exit
13623 ;; Try to find existing drawer.
13624 (while (re-search-forward regexp end t)
13625 (let ((element (org-element-at-point)))
13626 (when (eq (org-element-type element) 'drawer)
13627 (let ((cend (org-element-property :contents-end element)))
13628 (when (and (not org-log-states-order-reversed) cend)
13629 (goto-char cend)))
13630 (throw 'exit nil))))
13631 ;; No drawer found. Create one, if permitted.
13632 (when create
13633 (unless (bolp) (insert "\n"))
13634 (let ((beg (point)))
13635 (insert ":" drawer ":\n:END:\n")
13636 (org-indent-region beg (point)))
13637 (end-of-line -1)))))
13638 (org-log-state-notes-insert-after-drawers
13639 (while (and (looking-at org-drawer-regexp)
13640 (progn (goto-char (match-end 0))
13641 (re-search-forward org-property-end-re end t)))
13642 (forward-line)))))
13643 (if (bolp) (point) (line-beginning-position 2)))))
13645 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13646 "Set up the post command hook to take a note.
13647 If this is about to TODO state change, the new state is expected in STATE.
13648 When FINDPOS is non-nil, find the correct position for the note in
13649 the current entry. If not, assume that it can be inserted at point.
13650 HOW is an indicator what kind of note should be created.
13651 EXTRA is additional text that will be inserted into the notes buffer."
13652 (org-with-wide-buffer
13653 (when findpos
13654 (goto-char (org-log-beginning t))
13655 (unless org-log-states-order-reversed
13656 (org-skip-over-state-notes)
13657 (skip-chars-backward " \t\n\r")
13658 (forward-line)))
13659 (move-marker org-log-note-marker (point))
13660 ;; Preserve position even if a property drawer is inserted in the
13661 ;; process.
13662 (set-marker-insertion-type org-log-note-marker t)
13663 (setq org-log-note-purpose purpose
13664 org-log-note-state state
13665 org-log-note-previous-state prev-state
13666 org-log-note-how how
13667 org-log-note-extra extra
13668 org-log-note-effective-time (org-current-effective-time))
13669 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13671 (defun org-skip-over-state-notes ()
13672 "Skip past the list of State notes in an entry."
13673 (when (ignore-errors (goto-char (org-in-item-p)))
13674 (let* ((struct (org-list-struct))
13675 (prevs (org-list-prevs-alist struct))
13676 (regexp
13677 (concat "[ \t]*- +"
13678 (replace-regexp-in-string
13679 " +" " +"
13680 (org-replace-escapes
13681 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13682 `(("%d" . ,org-ts-regexp-inactive)
13683 ("%D" . ,org-ts-regexp)
13684 ("%s" . "\"\\S-+\"")
13685 ("%S" . "\"\\S-+\"")
13686 ("%t" . ,org-ts-regexp-inactive)
13687 ("%T" . ,org-ts-regexp)
13688 ("%u" . ".*?")
13689 ("%U" . ".*?")))))))
13690 (while (org-looking-at-p regexp)
13691 (goto-char (or (org-list-get-next-item (point) struct prevs)
13692 (org-list-get-item-end (point) struct)))))))
13694 (defun org-add-log-note (&optional purpose)
13695 "Pop up a window for taking a note, and add this note later at point."
13696 (remove-hook 'post-command-hook 'org-add-log-note)
13697 (setq org-log-note-window-configuration (current-window-configuration))
13698 (delete-other-windows)
13699 (move-marker org-log-note-return-to (point))
13700 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13701 (goto-char org-log-note-marker)
13702 (org-switch-to-buffer-other-window "*Org Note*")
13703 (erase-buffer)
13704 (if (memq org-log-note-how '(time state))
13705 (let (current-prefix-arg) (org-store-log-note))
13706 (let ((org-inhibit-startup t)) (org-mode))
13707 (insert (format "# Insert note for %s.
13708 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13709 (cond
13710 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13711 ((eq org-log-note-purpose 'done) "closed todo item")
13712 ((eq org-log-note-purpose 'state)
13713 (format "state change from \"%s\" to \"%s\""
13714 (or org-log-note-previous-state "")
13715 (or org-log-note-state "")))
13716 ((eq org-log-note-purpose 'reschedule)
13717 "rescheduling")
13718 ((eq org-log-note-purpose 'delschedule)
13719 "no longer scheduled")
13720 ((eq org-log-note-purpose 'redeadline)
13721 "changing deadline")
13722 ((eq org-log-note-purpose 'deldeadline)
13723 "removing deadline")
13724 ((eq org-log-note-purpose 'refile)
13725 "refiling")
13726 ((eq org-log-note-purpose 'note)
13727 "this entry")
13728 (t (error "This should not happen")))))
13729 (if org-log-note-extra (insert org-log-note-extra))
13730 (org-set-local 'org-finish-function 'org-store-log-note)
13731 (run-hooks 'org-log-buffer-setup-hook)))
13733 (defvar org-note-abort nil) ; dynamically scoped
13734 (defun org-store-log-note ()
13735 "Finish taking a log note, and insert it to where it belongs."
13736 (let ((txt (buffer-string)))
13737 (kill-buffer (current-buffer))
13738 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13739 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13740 (setq txt (replace-match "" t t txt)))
13741 (if (string-match "\\s-+\\'" txt)
13742 (setq txt (replace-match "" t t txt)))
13743 (setq lines (org-split-string txt "\n"))
13744 (when (and note (string-match "\\S-" note))
13745 (setq note
13746 (org-replace-escapes
13747 note
13748 (list (cons "%u" (user-login-name))
13749 (cons "%U" user-full-name)
13750 (cons "%t" (format-time-string
13751 (org-time-stamp-format 'long 'inactive)
13752 org-log-note-effective-time))
13753 (cons "%T" (format-time-string
13754 (org-time-stamp-format 'long nil)
13755 org-log-note-effective-time))
13756 (cons "%d" (format-time-string
13757 (org-time-stamp-format nil 'inactive)
13758 org-log-note-effective-time))
13759 (cons "%D" (format-time-string
13760 (org-time-stamp-format nil nil)
13761 org-log-note-effective-time))
13762 (cons "%s" (if org-log-note-state
13763 (concat "\"" org-log-note-state "\"")
13764 ""))
13765 (cons "%S" (if org-log-note-previous-state
13766 (concat "\"" org-log-note-previous-state "\"")
13767 "\"\"")))))
13768 (when lines (setq note (concat note " \\\\")))
13769 (push note lines))
13770 (when (or current-prefix-arg org-note-abort)
13771 (when (org-log-into-drawer)
13772 (org-remove-empty-drawer-at org-log-note-marker))
13773 (setq lines nil))
13774 (when lines
13775 (with-current-buffer (marker-buffer org-log-note-marker)
13776 (save-excursion
13777 (goto-char org-log-note-marker)
13778 (move-marker org-log-note-marker nil)
13779 ;; Make sure point is at the beginning of an empty line.
13780 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13781 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13782 ;; In an existing list, add a new item at the top level.
13783 ;; Otherwise, indent line like a regular one.
13784 (let ((itemp (org-in-item-p)))
13785 (if itemp
13786 (org-indent-line-to
13787 (let ((struct (save-excursion
13788 (goto-char itemp) (org-list-struct))))
13789 (org-list-get-ind (org-list-get-top-point struct) struct)))
13790 (org-indent-line)))
13791 (insert (org-list-bullet-string "-") (pop lines))
13792 (let ((ind (org-list-item-body-column (line-beginning-position))))
13793 (dolist (line lines)
13794 (insert "\n")
13795 (org-indent-line-to ind)
13796 (insert line)))
13797 (message "Note stored")
13798 (org-back-to-heading t)
13799 (org-cycle-hide-drawers 'children))
13800 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13801 ;; from within `org-add-log-note' because `buffer-undo-list'
13802 ;; is then modified outside of `org-with-remote-undo'.
13803 (when (eq this-command 'org-agenda-todo)
13804 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13805 ;; Don't add undo information when called from `org-agenda-todo'
13806 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13807 (set-window-configuration org-log-note-window-configuration)
13808 (with-current-buffer (marker-buffer org-log-note-return-to)
13809 (goto-char org-log-note-return-to))
13810 (move-marker org-log-note-return-to nil)
13811 (and org-log-post-message (message "%s" org-log-post-message))))
13813 (defun org-remove-empty-drawer-at (pos)
13814 "Remove an empty drawer at position POS.
13815 POS may also be a marker."
13816 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13817 (org-with-wide-buffer
13818 (goto-char pos)
13819 (let ((drawer (org-element-at-point)))
13820 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13821 (not (org-element-property :contents-begin drawer)))
13822 (delete-region (org-element-property :begin drawer)
13823 (progn (goto-char (org-element-property :end drawer))
13824 (skip-chars-backward " \r\t\n")
13825 (forward-line)
13826 (point))))))))
13828 (defvar org-ts-type nil)
13829 (defun org-sparse-tree (&optional arg type)
13830 "Create a sparse tree, prompt for the details.
13831 This command can create sparse trees. You first need to select the type
13832 of match used to create the tree:
13834 t Show all TODO entries.
13835 T Show entries with a specific TODO keyword.
13836 m Show entries selected by a tags/property match.
13837 p Enter a property name and its value (both with completion on existing
13838 names/values) and show entries with that property.
13839 r Show entries matching a regular expression (`/' can be used as well).
13840 b Show deadlines and scheduled items before a date.
13841 a Show deadlines and scheduled items after a date.
13842 d Show deadlines due within `org-deadline-warning-days'.
13843 D Show deadlines and scheduled items between a date range."
13844 (interactive "P")
13845 (setq type (or type org-sparse-tree-default-date-type))
13846 (setq org-ts-type type)
13847 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13848 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13849 [c]ycle through date types: %s"
13850 (case type
13851 (all "all timestamps")
13852 (scheduled "only scheduled")
13853 (deadline "only deadline")
13854 (active "only active timestamps")
13855 (inactive "only inactive timestamps")
13856 (scheduled-or-deadline "scheduled/deadline")
13857 (closed "with a closed time-stamp")
13858 (otherwise "scheduled/deadline")))
13859 (let ((answer (read-char-exclusive)))
13860 (case answer
13862 (org-sparse-tree
13864 (cadr (memq type '(scheduled-or-deadline all scheduled deadline active
13865 inactive closed)))))
13866 (?d (call-interactively 'org-check-deadlines))
13867 (?b (call-interactively 'org-check-before-date))
13868 (?a (call-interactively 'org-check-after-date))
13869 (?D (call-interactively 'org-check-dates-range))
13870 (?t (call-interactively 'org-show-todo-tree))
13871 (?T (org-show-todo-tree '(4)))
13872 (?m (call-interactively 'org-match-sparse-tree))
13873 ((?p ?P)
13874 (let* ((kwd (org-icompleting-read
13875 "Property: " (mapcar 'list (org-buffer-property-keys))))
13876 (value (org-icompleting-read
13877 "Value: " (mapcar 'list (org-property-values kwd)))))
13878 (unless (string-match "\\`{.*}\\'" value)
13879 (setq value (concat "\"" value "\"")))
13880 (org-match-sparse-tree arg (concat kwd "=" value))))
13881 ((?r ?R ?/) (call-interactively 'org-occur))
13882 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13884 (defvar org-occur-highlights nil
13885 "List of overlays used for occur matches.")
13886 (make-variable-buffer-local 'org-occur-highlights)
13887 (defvar org-occur-parameters nil
13888 "Parameters of the active org-occur calls.
13889 This is a list, each call to org-occur pushes as cons cell,
13890 containing the regular expression and the callback, onto the list.
13891 The list can contain several entries if `org-occur' has been called
13892 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13893 will only contain one set of parameters. When the highlights are
13894 removed (for example with `C-c C-c', or with the next edit (depending
13895 on `org-remove-highlights-with-change'), this variable is emptied
13896 as well.")
13897 (make-variable-buffer-local 'org-occur-parameters)
13899 (defun org-occur (regexp &optional keep-previous callback)
13900 "Make a compact tree which shows all matches of REGEXP.
13901 The tree will show the lines where the regexp matches, and all higher
13902 headlines above the match. It will also show the heading after the match,
13903 to make sure editing the matching entry is easy.
13904 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13905 call to `org-occur' will be kept, to allow stacking of calls to this
13906 command.
13907 If CALLBACK is non-nil, it is a function which is called to confirm
13908 that the match should indeed be shown."
13909 (interactive "sRegexp: \nP")
13910 (when (equal regexp "")
13911 (user-error "Regexp cannot be empty"))
13912 (unless keep-previous
13913 (org-remove-occur-highlights nil nil t))
13914 (push (cons regexp callback) org-occur-parameters)
13915 (let ((cnt 0))
13916 (save-excursion
13917 (goto-char (point-min))
13918 (if (or (not keep-previous) ; do not want to keep
13919 (not org-occur-highlights)) ; no previous matches
13920 ;; hide everything
13921 (org-overview))
13922 (while (re-search-forward regexp nil t)
13923 (when (or (not callback)
13924 (save-match-data (funcall callback)))
13925 (setq cnt (1+ cnt))
13926 (when org-highlight-sparse-tree-matches
13927 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13928 (org-show-context 'occur-tree))))
13929 (when org-remove-highlights-with-change
13930 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13931 nil 'local))
13932 (unless org-sparse-tree-open-archived-trees
13933 (org-hide-archived-subtrees (point-min) (point-max)))
13934 (run-hooks 'org-occur-hook)
13935 (if (org-called-interactively-p 'interactive)
13936 (message "%d match(es) for regexp %s" cnt regexp))
13937 cnt))
13939 (defun org-occur-next-match (&optional n reset)
13940 "Function for `next-error-function' to find sparse tree matches.
13941 N is the number of matches to move, when negative move backwards.
13942 RESET is entirely ignored - this function always goes back to the
13943 starting point when no match is found."
13944 (let* ((limit (if (< n 0) (point-min) (point-max)))
13945 (search-func (if (< n 0)
13946 'previous-single-char-property-change
13947 'next-single-char-property-change))
13948 (n (abs n))
13949 (pos (point))
13951 (catch 'exit
13952 (while (setq p1 (funcall search-func (point) 'org-type))
13953 (when (equal p1 limit)
13954 (goto-char pos)
13955 (user-error "No more matches"))
13956 (when (equal (get-char-property p1 'org-type) 'org-occur)
13957 (setq n (1- n))
13958 (when (= n 0)
13959 (goto-char p1)
13960 (throw 'exit (point))))
13961 (goto-char p1))
13962 (goto-char p1)
13963 (user-error "No more matches"))))
13965 (defun org-show-context (&optional key)
13966 "Make sure point and context are visible.
13967 How much context is shown depends upon the variables
13968 `org-show-hierarchy-above', `org-show-following-heading',
13969 `org-show-entry-below' and `org-show-siblings'."
13970 (let ((heading-p (org-at-heading-p t))
13971 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13972 (following-p (org-get-alist-option org-show-following-heading key))
13973 (entry-p (org-get-alist-option org-show-entry-below key))
13974 (siblings-p (org-get-alist-option org-show-siblings key)))
13975 ;; Show heading or entry text
13976 (if (and heading-p (not entry-p))
13977 (org-flag-heading nil) ; only show the heading
13978 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13979 (org-show-hidden-entry))) ; show entire entry
13980 (when following-p
13981 ;; Show next sibling, or heading below text
13982 (save-excursion
13983 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13984 (org-flag-heading nil))))
13985 (when siblings-p (org-show-siblings))
13986 (when hierarchy-p
13987 ;; show all higher headings, possibly with siblings
13988 (save-excursion
13989 (while (and (ignore-errors (progn (org-up-heading-all 1) t))
13990 (not (bobp)))
13991 (org-flag-heading nil)
13992 (when siblings-p (org-show-siblings)))))))
13994 (defvar org-reveal-start-hook nil
13995 "Hook run before revealing a location.")
13997 (defun org-reveal (&optional siblings)
13998 "Show current entry, hierarchy above it, and the following headline.
13999 This can be used to show a consistent set of context around locations
14000 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
14001 not t for the search context.
14003 With optional argument SIBLINGS, on each level of the hierarchy all
14004 siblings are shown. This repairs the tree structure to what it would
14005 look like when opened with hierarchical calls to `org-cycle'.
14006 With double optional argument \\[universal-argument] \\[universal-argument], \
14007 go to the parent and show the
14008 entire tree."
14009 (interactive "P")
14010 (run-hooks 'org-reveal-start-hook)
14011 (let ((org-show-hierarchy-above t)
14012 (org-show-following-heading t)
14013 (org-show-siblings (if siblings t org-show-siblings)))
14014 (org-show-context nil))
14015 (when (equal siblings '(16))
14016 (save-excursion
14017 (when (org-up-heading-safe)
14018 (org-show-subtree)
14019 (run-hook-with-args 'org-cycle-hook 'subtree)))))
14021 (defun org-highlight-new-match (beg end)
14022 "Highlight from BEG to END and mark the highlight is an occur headline."
14023 (let ((ov (make-overlay beg end)))
14024 (overlay-put ov 'face 'secondary-selection)
14025 (overlay-put ov 'org-type 'org-occur)
14026 (push ov org-occur-highlights)))
14028 (defun org-remove-occur-highlights (&optional beg end noremove)
14029 "Remove the occur highlights from the buffer.
14030 BEG and END are ignored. If NOREMOVE is nil, remove this function
14031 from the `before-change-functions' in the current buffer."
14032 (interactive)
14033 (unless org-inhibit-highlight-removal
14034 (mapc 'delete-overlay org-occur-highlights)
14035 (setq org-occur-highlights nil)
14036 (setq org-occur-parameters nil)
14037 (unless noremove
14038 (remove-hook 'before-change-functions
14039 'org-remove-occur-highlights 'local))))
14041 ;;;; Priorities
14043 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14044 "Regular expression matching the priority indicator.")
14046 (defvar org-remove-priority-next-time nil)
14048 (defun org-priority-up ()
14049 "Increase the priority of the current item."
14050 (interactive)
14051 (org-priority 'up))
14053 (defun org-priority-down ()
14054 "Decrease the priority of the current item."
14055 (interactive)
14056 (org-priority 'down))
14058 (defun org-priority (&optional action show)
14059 "Change the priority of an item.
14060 ACTION can be `set', `up', `down', or a character."
14061 (interactive "P")
14062 (if (equal action '(4))
14063 (org-show-priority)
14064 (unless org-enable-priority-commands
14065 (user-error "Priority commands are disabled"))
14066 (setq action (or action 'set))
14067 (let (current new news have remove)
14068 (save-excursion
14069 (org-back-to-heading t)
14070 (if (looking-at org-priority-regexp)
14071 (setq current (string-to-char (match-string 2))
14072 have t))
14073 (cond
14074 ((eq action 'remove)
14075 (setq remove t new ?\ ))
14076 ((or (eq action 'set)
14077 (if (featurep 'xemacs) (characterp action) (integerp action)))
14078 (if (not (eq action 'set))
14079 (setq new action)
14080 (message "Priority %c-%c, SPC to remove: "
14081 org-highest-priority org-lowest-priority)
14082 (save-match-data
14083 (setq new (read-char-exclusive))))
14084 (if (and (= (upcase org-highest-priority) org-highest-priority)
14085 (= (upcase org-lowest-priority) org-lowest-priority))
14086 (setq new (upcase new)))
14087 (cond ((equal new ?\ ) (setq remove t))
14088 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14089 (user-error "Priority must be between `%c' and `%c'"
14090 org-highest-priority org-lowest-priority))))
14091 ((eq action 'up)
14092 (setq new (if have
14093 (1- current) ; normal cycling
14094 ;; last priority was empty
14095 (if (eq last-command this-command)
14096 org-lowest-priority ; wrap around empty to lowest
14097 ;; default
14098 (if org-priority-start-cycle-with-default
14099 org-default-priority
14100 (1- org-default-priority))))))
14101 ((eq action 'down)
14102 (setq new (if have
14103 (1+ current) ; normal cycling
14104 ;; last priority was empty
14105 (if (eq last-command this-command)
14106 org-highest-priority ; wrap around empty to highest
14107 ;; default
14108 (if org-priority-start-cycle-with-default
14109 org-default-priority
14110 (1+ org-default-priority))))))
14111 (t (user-error "Invalid action")))
14112 (if (or (< (upcase new) org-highest-priority)
14113 (> (upcase new) org-lowest-priority))
14114 (if (and (memq action '(up down))
14115 (not have) (not (eq last-command this-command)))
14116 ;; `new' is from default priority
14117 (error
14118 "The default can not be set, see `org-default-priority' why")
14119 ;; normal cycling: `new' is beyond highest/lowest priority
14120 ;; and is wrapped around to the empty priority
14121 (setq remove t)))
14122 (setq news (format "%c" new))
14123 (if have
14124 (if remove
14125 (replace-match "" t t nil 1)
14126 (replace-match news t t nil 2))
14127 (if remove
14128 (user-error "No priority cookie found in line")
14129 (let ((case-fold-search nil))
14130 (looking-at org-todo-line-regexp))
14131 (if (match-end 2)
14132 (progn
14133 (goto-char (match-end 2))
14134 (insert " [#" news "]"))
14135 (goto-char (match-beginning 3))
14136 (insert "[#" news "] "))))
14137 (org-set-tags nil 'align))
14138 (if remove
14139 (message "Priority removed")
14140 (message "Priority of current item set to %s" news)))))
14142 (defun org-show-priority ()
14143 "Show the priority of the current item.
14144 This priority is composed of the main priority given with the [#A] cookies,
14145 and by additional input from the age of a schedules or deadline entry."
14146 (interactive)
14147 (let ((pri (if (eq major-mode 'org-agenda-mode)
14148 (org-get-at-bol 'priority)
14149 (save-excursion
14150 (save-match-data
14151 (beginning-of-line)
14152 (and (looking-at org-heading-regexp)
14153 (org-get-priority (match-string 0))))))))
14154 (message "Priority is %d" (if pri pri -1000))))
14156 (defun org-get-priority (s)
14157 "Find priority cookie and return priority."
14158 (save-match-data
14159 (if (functionp org-get-priority-function)
14160 (funcall org-get-priority-function)
14161 (if (not (string-match org-priority-regexp s))
14162 (* 1000 (- org-lowest-priority org-default-priority))
14163 (* 1000 (- org-lowest-priority
14164 (string-to-char (match-string 2 s))))))))
14166 ;;;; Tags
14168 (defvar org-agenda-archives-mode)
14169 (defvar org-map-continue-from nil
14170 "Position from where mapping should continue.
14171 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14173 (defvar org-scanner-tags nil
14174 "The current tag list while the tags scanner is running.")
14175 (defvar org-trust-scanner-tags nil
14176 "Should `org-get-tags-at' use the tags for the scanner.
14177 This is for internal dynamical scoping only.
14178 When this is non-nil, the function `org-get-tags-at' will return the value
14179 of `org-scanner-tags' instead of building the list by itself. This
14180 can lead to large speed-ups when the tags scanner is used in a file with
14181 many entries, and when the list of tags is retrieved, for example to
14182 obtain a list of properties. Building the tags list for each entry in such
14183 a file becomes an N^2 operation - but with this variable set, it scales
14184 as N.")
14186 (defun org-scan-tags (action matcher todo-only &optional start-level)
14187 "Scan headline tags with inheritance and produce output ACTION.
14189 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14190 or `agenda' to produce an entry list for an agenda view. It can also be
14191 a Lisp form or a function that should be called at each matched headline, in
14192 this case the return value is a list of all return values from these calls.
14194 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14195 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14196 only lines with a not-done TODO keyword are included in the output.
14197 This should be the same variable that was scoped into
14198 and set by `org-make-tags-matcher' when it constructed MATCHER.
14200 START-LEVEL can be a string with asterisks, reducing the scope to
14201 headlines matching this string."
14202 (require 'org-agenda)
14203 (let* ((re (concat "^"
14204 (if start-level
14205 ;; Get the correct level to match
14206 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14207 org-outline-regexp)
14208 " *\\(\\<\\("
14209 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14210 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14211 (props (list 'face 'default
14212 'done-face 'org-agenda-done
14213 'undone-face 'default
14214 'mouse-face 'highlight
14215 'org-not-done-regexp org-not-done-regexp
14216 'org-todo-regexp org-todo-regexp
14217 'org-complex-heading-regexp org-complex-heading-regexp
14218 'help-echo
14219 (format "mouse-2 or RET jump to org file %s"
14220 (abbreviate-file-name
14221 (or (buffer-file-name (buffer-base-buffer))
14222 (buffer-name (buffer-base-buffer)))))))
14223 (org-map-continue-from nil)
14224 lspos tags tags-list
14225 (tags-alist (list (cons 0 org-file-tags)))
14226 (llast 0) rtn rtn1 level category i txt
14227 todo marker entry priority)
14228 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14229 (setq action (list 'lambda nil action)))
14230 (save-excursion
14231 (goto-char (point-min))
14232 (when (eq action 'sparse-tree)
14233 (org-overview)
14234 (org-remove-occur-highlights))
14235 (while (let (case-fold-search)
14236 (re-search-forward re nil t))
14237 (setq org-map-continue-from nil)
14238 (catch :skip
14239 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14240 tags (if (match-end 4) (org-match-string-no-properties 4)))
14241 (goto-char (setq lspos (match-beginning 0)))
14242 (setq level (org-reduced-level (org-outline-level))
14243 category (org-get-category))
14244 (setq i llast llast level)
14245 ;; remove tag lists from same and sublevels
14246 (while (>= i level)
14247 (when (setq entry (assoc i tags-alist))
14248 (setq tags-alist (delete entry tags-alist)))
14249 (setq i (1- i)))
14250 ;; add the next tags
14251 (when tags
14252 (setq tags (org-split-string tags ":")
14253 tags-alist
14254 (cons (cons level tags) tags-alist)))
14255 ;; compile tags for current headline
14256 (setq tags-list
14257 (if org-use-tag-inheritance
14258 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14259 tags)
14260 org-scanner-tags tags-list)
14261 (when org-use-tag-inheritance
14262 (setcdr (car tags-alist)
14263 (mapcar (lambda (x)
14264 (setq x (copy-sequence x))
14265 (org-add-prop-inherited x))
14266 (cdar tags-alist))))
14267 (when (and tags org-use-tag-inheritance
14268 (or (not (eq t org-use-tag-inheritance))
14269 org-tags-exclude-from-inheritance))
14270 ;; selective inheritance, remove uninherited ones
14271 (setcdr (car tags-alist)
14272 (org-remove-uninherited-tags (cdar tags-alist))))
14273 (when (and
14275 ;; eval matcher only when the todo condition is OK
14276 (and (or (not todo-only) (member todo org-not-done-keywords))
14277 (let ((case-fold-search t) (org-trust-scanner-tags t))
14278 (eval matcher)))
14280 ;; Call the skipper, but return t if it does not skip,
14281 ;; so that the `and' form continues evaluating
14282 (progn
14283 (unless (eq action 'sparse-tree) (org-agenda-skip))
14286 ;; Check if timestamps are deselecting this entry
14287 (or (not todo-only)
14288 (and (member todo org-not-done-keywords)
14289 (or (not org-agenda-tags-todo-honor-ignore-options)
14290 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14292 ;; select this headline
14293 (cond
14294 ((eq action 'sparse-tree)
14295 (and org-highlight-sparse-tree-matches
14296 (org-get-heading) (match-end 0)
14297 (org-highlight-new-match
14298 (match-beginning 1) (match-end 1)))
14299 (org-show-context 'tags-tree))
14300 ((eq action 'agenda)
14301 (setq txt (org-agenda-format-item
14303 (concat
14304 (if (eq org-tags-match-list-sublevels 'indented)
14305 (make-string (1- level) ?.) "")
14306 (org-get-heading))
14307 level category
14308 tags-list)
14309 priority (org-get-priority txt))
14310 (goto-char lspos)
14311 (setq marker (org-agenda-new-marker))
14312 (org-add-props txt props
14313 'org-marker marker 'org-hd-marker marker 'org-category category
14314 'todo-state todo
14315 'priority priority 'type "tagsmatch")
14316 (push txt rtn))
14317 ((functionp action)
14318 (setq org-map-continue-from nil)
14319 (save-excursion
14320 (setq rtn1 (funcall action))
14321 (push rtn1 rtn)))
14322 (t (user-error "Invalid action")))
14324 ;; if we are to skip sublevels, jump to end of subtree
14325 (unless org-tags-match-list-sublevels
14326 (org-end-of-subtree t)
14327 (backward-char 1))))
14328 ;; Get the correct position from where to continue
14329 (if org-map-continue-from
14330 (goto-char org-map-continue-from)
14331 (and (= (point) lspos) (end-of-line 1)))))
14332 (when (and (eq action 'sparse-tree)
14333 (not org-sparse-tree-open-archived-trees))
14334 (org-hide-archived-subtrees (point-min) (point-max)))
14335 (nreverse rtn)))
14337 (defun org-remove-uninherited-tags (tags)
14338 "Remove all tags that are not inherited from the list TAGS."
14339 (cond
14340 ((eq org-use-tag-inheritance t)
14341 (if org-tags-exclude-from-inheritance
14342 (org-delete-all org-tags-exclude-from-inheritance tags)
14343 tags))
14344 ((not org-use-tag-inheritance) nil)
14345 ((stringp org-use-tag-inheritance)
14346 (delq nil (mapcar
14347 (lambda (x)
14348 (if (and (string-match org-use-tag-inheritance x)
14349 (not (member x org-tags-exclude-from-inheritance)))
14350 x nil))
14351 tags)))
14352 ((listp org-use-tag-inheritance)
14353 (delq nil (mapcar
14354 (lambda (x)
14355 (if (member x org-use-tag-inheritance) x nil))
14356 tags)))))
14358 (defun org-match-sparse-tree (&optional todo-only match)
14359 "Create a sparse tree according to tags string MATCH.
14360 MATCH can contain positive and negative selection of tags, like
14361 \"+WORK+URGENT-WITHBOSS\".
14362 If optional argument TODO-ONLY is non-nil, only select lines that are
14363 also TODO lines."
14364 (interactive "P")
14365 (org-agenda-prepare-buffers (list (current-buffer)))
14366 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14368 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14370 (defvar org-cached-props nil)
14371 (defun org-cached-entry-get (pom property)
14372 (if (or (eq t org-use-property-inheritance)
14373 (and (stringp org-use-property-inheritance)
14374 (let ((case-fold-search t))
14375 (org-string-match-p org-use-property-inheritance property)))
14376 (and (listp org-use-property-inheritance)
14377 (member-ignore-case property org-use-property-inheritance)))
14378 ;; Caching is not possible, check it directly.
14379 (org-entry-get pom property 'inherit)
14380 ;; Get all properties, so we can do complicated checks easily.
14381 (cdr (assoc-string property
14382 (or org-cached-props
14383 (setq org-cached-props (org-entry-properties pom)))
14384 t))))
14386 (defun org-global-tags-completion-table (&optional files)
14387 "Return the list of all tags in all agenda buffer/files.
14388 Optional FILES argument is a list of files which can be used
14389 instead of the agenda files."
14390 (save-excursion
14391 (org-uniquify
14392 (delq nil
14393 (apply 'append
14394 (mapcar
14395 (lambda (file)
14396 (set-buffer (find-file-noselect file))
14397 (append (org-get-buffer-tags)
14398 (mapcar (lambda (x) (if (stringp (car-safe x))
14399 (list (car-safe x)) nil))
14400 org-tag-alist)))
14401 (if (and files (car files))
14402 files
14403 (org-agenda-files))))))))
14405 (defun org-make-tags-matcher (match)
14406 "Create the TAGS/TODO matcher form for the selection string MATCH.
14408 The variable `todo-only' is scoped dynamically into this function.
14409 It will be set to t if the matcher restricts matching to TODO entries,
14410 otherwise will not be touched.
14412 Returns a cons of the selection string MATCH and the constructed
14413 lisp form implementing the matcher. The matcher is to be evaluated
14414 at an Org entry, with point on the headline, and returns t if the
14415 entry matches the selection string MATCH. The returned lisp form
14416 references two variables with information about the entry, which
14417 must be bound around the form's evaluation: todo, the TODO keyword
14418 at the entry (or nil of none); and tags-list, the list of all tags
14419 at the entry including inherited ones. Additionally, the category
14420 of the entry (if any) must be specified as the text property
14421 'org-category on the headline.
14423 See also `org-scan-tags'.
14425 (declare (special todo-only))
14426 (unless (boundp 'todo-only)
14427 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14428 (unless match
14429 ;; Get a new match request, with completion against the global
14430 ;; tags table and the local tags in current buffer
14431 (let ((org-last-tags-completion-table
14432 (org-uniquify
14433 (delq nil (append (org-get-buffer-tags)
14434 (org-global-tags-completion-table))))))
14435 (setq match (org-completing-read-no-i
14436 "Match: " 'org-tags-completion-function nil nil nil
14437 'org-tags-history))))
14439 ;; Parse the string and create a lisp form
14440 (let ((match0 match)
14441 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14442 minus tag mm
14443 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14444 orterms term orlist re-p str-p level-p level-op time-p
14445 prop-p pn pv po gv rest (start 0) (ss 0))
14446 ;; Expand group tags
14447 (setq match (org-tags-expand match))
14449 ;; Check if there is a TODO part of this match, which would be the
14450 ;; part after a "/". TO make sure that this slash is not part of
14451 ;; a property value to be matched against, we also check that there
14452 ;; is no " after that slash.
14453 ;; First, find the last slash
14454 (while (string-match "/+" match ss)
14455 (setq start (match-beginning 0) ss (match-end 0)))
14456 (if (and (string-match "/+" match start)
14457 (not (save-match-data (string-match "\"" match start))))
14458 ;; match contains also a todo-matching request
14459 (progn
14460 (setq tagsmatch (substring match 0 (match-beginning 0))
14461 todomatch (substring match (match-end 0)))
14462 (if (string-match "^!" todomatch)
14463 (setq todo-only t todomatch (substring todomatch 1)))
14464 (if (string-match "^\\s-*$" todomatch)
14465 (setq todomatch nil)))
14466 ;; only matching tags
14467 (setq tagsmatch match todomatch nil))
14469 ;; Make the tags matcher
14470 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14471 (setq tagsmatcher t)
14472 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14473 (while (setq term (pop orterms))
14474 (while (and (equal (substring term -1) "\\") orterms)
14475 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14476 (while (string-match re term)
14477 (setq rest (substring term (match-end 0))
14478 minus (and (match-end 1)
14479 (equal (match-string 1 term) "-"))
14480 tag (save-match-data (replace-regexp-in-string
14481 "\\\\-" "-"
14482 (match-string 2 term)))
14483 re-p (equal (string-to-char tag) ?{)
14484 level-p (match-end 4)
14485 prop-p (match-end 5)
14486 mm (cond
14487 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14488 (level-p
14489 (setq level-op (org-op-to-function (match-string 3 term)))
14490 `(,level-op level ,(string-to-number
14491 (match-string 4 term))))
14492 (prop-p
14493 (setq pn (match-string 5 term)
14494 po (match-string 6 term)
14495 pv (match-string 7 term)
14496 re-p (equal (string-to-char pv) ?{)
14497 str-p (equal (string-to-char pv) ?\")
14498 time-p (save-match-data
14499 (string-match "^\"[[<].*[]>]\"$" pv))
14500 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14501 (if time-p (setq pv (org-matcher-time pv)))
14502 (setq po (org-op-to-function po (if time-p 'time str-p)))
14503 (cond
14504 ((equal pn "CATEGORY")
14505 (setq gv '(get-text-property (point) 'org-category)))
14506 ((equal pn "TODO")
14507 (setq gv 'todo))
14509 (setq gv `(org-cached-entry-get nil ,pn))))
14510 (if re-p
14511 (if (eq po 'org<>)
14512 `(not (string-match ,pv (or ,gv "")))
14513 `(string-match ,pv (or ,gv "")))
14514 (if str-p
14515 `(,po (or ,gv "") ,pv)
14516 `(,po (string-to-number (or ,gv ""))
14517 ,(string-to-number pv) ))))
14518 (t `(member ,tag tags-list)))
14519 mm (if minus (list 'not mm) mm)
14520 term rest)
14521 (push mm tagsmatcher))
14522 (push (if (> (length tagsmatcher) 1)
14523 (cons 'and tagsmatcher)
14524 (car tagsmatcher))
14525 orlist)
14526 (setq tagsmatcher nil))
14527 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14528 (setq tagsmatcher
14529 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14530 ;; Make the todo matcher
14531 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14532 (setq todomatcher t)
14533 (setq orterms (org-split-string todomatch "|") orlist nil)
14534 (while (setq term (pop orterms))
14535 (while (string-match re term)
14536 (setq minus (and (match-end 1)
14537 (equal (match-string 1 term) "-"))
14538 kwd (match-string 2 term)
14539 re-p (equal (string-to-char kwd) ?{)
14540 term (substring term (match-end 0))
14541 mm (if re-p
14542 `(string-match ,(substring kwd 1 -1) todo)
14543 (list 'equal 'todo kwd))
14544 mm (if minus (list 'not mm) mm))
14545 (push mm todomatcher))
14546 (push (if (> (length todomatcher) 1)
14547 (cons 'and todomatcher)
14548 (car todomatcher))
14549 orlist)
14550 (setq todomatcher nil))
14551 (setq todomatcher (if (> (length orlist) 1)
14552 (cons 'or orlist) (car orlist))))
14554 ;; Return the string and lisp forms of the matcher
14555 (setq matcher (if todomatcher
14556 (list 'and tagsmatcher todomatcher)
14557 tagsmatcher))
14558 (when todo-only
14559 (setq matcher (list 'and '(member todo org-not-done-keywords)
14560 matcher)))
14561 (cons match0 matcher)))
14563 (defun org-tags-expand (match &optional single-as-list downcased)
14564 "Expand group tags in MATCH.
14566 This replaces every group tag in MATCH with a regexp tag search.
14567 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14568 will be replaced like this:
14570 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14571 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14572 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14574 Replacing by a regexp preserves the structure of the match.
14575 E.g., this expansion
14577 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14579 will match anything tagged with \"Lab\" and \"Home\", or tagged
14580 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14582 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14583 assumed to be a single group tag, and the function will return
14584 the list of tags in this group.
14586 When DOWNCASE is non-nil, expand downcased TAGS."
14587 (if org-group-tags
14588 (let* ((case-fold-search t)
14589 (stable org-mode-syntax-table)
14590 (tal (or org-tag-groups-alist-for-agenda
14591 org-tag-groups-alist))
14592 (tal (if downcased
14593 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14594 (tml (mapcar 'car tal))
14595 (rtnmatch match) rpl)
14596 ;; @ and _ are allowed as word-components in tags
14597 (modify-syntax-entry ?@ "w" stable)
14598 (modify-syntax-entry ?_ "w" stable)
14599 (while (and tml
14600 (with-syntax-table stable
14601 (string-match
14602 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14603 (regexp-opt tml) "\\>\\)") rtnmatch)))
14604 (let* ((dir (match-string 1 rtnmatch))
14605 (tag (match-string 2 rtnmatch))
14606 (tag (if downcased (downcase tag) tag)))
14607 (setq tml (delete tag tml))
14608 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14609 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14610 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14611 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14612 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14613 (if single-as-list
14614 (or (reverse rpl) (list rtnmatch))
14615 rtnmatch))
14616 (if single-as-list (list (if downcased (downcase match) match))
14617 match)))
14619 (defun org-op-to-function (op &optional stringp)
14620 "Turn an operator into the appropriate function."
14621 (setq op
14622 (cond
14623 ((equal op "<" ) '(< string< org-time<))
14624 ((equal op ">" ) '(> org-string> org-time>))
14625 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14626 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14627 ((member op '("=" "==")) '(= string= org-time=))
14628 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14629 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14631 (defun org<> (a b) (not (= a b)))
14632 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14633 (defun org-string>= (a b) (not (string< a b)))
14634 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14635 (defun org-string<> (a b) (not (string= a b)))
14636 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14637 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14638 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14639 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14640 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14641 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14642 (defun org-2ft (s)
14643 "Convert S to a floating point time.
14644 If S is already a number, just return it. If it is a string, parse
14645 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14646 (cond
14647 ((numberp s) s)
14648 ((stringp s)
14649 (condition-case nil
14650 (float-time (apply 'encode-time (org-parse-time-string s)))
14651 (error 0.)))
14652 (t 0.)))
14654 (defun org-time-today ()
14655 "Time in seconds today at 0:00.
14656 Returns the float number of seconds since the beginning of the
14657 epoch to the beginning of today (00:00)."
14658 (float-time (apply 'encode-time
14659 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14661 (defun org-matcher-time (s)
14662 "Interpret a time comparison value."
14663 (save-match-data
14664 (cond
14665 ((string= s "<now>") (float-time))
14666 ((string= s "<today>") (org-time-today))
14667 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14668 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14669 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14670 (+ (org-time-today)
14671 (* (string-to-number (match-string 1 s))
14672 (cdr (assoc (match-string 2 s)
14673 '(("d" . 86400.0) ("w" . 604800.0)
14674 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14675 (t (org-2ft s)))))
14677 (defun org-match-any-p (re list)
14678 "Does re match any element of list?"
14679 (setq list (mapcar (lambda (x) (string-match re x)) list))
14680 (delq nil list))
14682 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14683 (defvar org-tags-overlay (make-overlay 1 1))
14684 (org-detach-overlay org-tags-overlay)
14686 (defun org-get-local-tags-at (&optional pos)
14687 "Get a list of tags defined in the current headline."
14688 (org-get-tags-at pos 'local))
14690 (defun org-get-local-tags ()
14691 "Get a list of tags defined in the current headline."
14692 (org-get-tags-at nil 'local))
14694 (defun org-get-tags-at (&optional pos local)
14695 "Get a list of all headline tags applicable at POS.
14696 POS defaults to point. If tags are inherited, the list contains
14697 the targets in the same sequence as the headlines appear, i.e.
14698 the tags of the current headline come last.
14699 When LOCAL is non-nil, only return tags from the current headline,
14700 ignore inherited ones."
14701 (interactive)
14702 (if (and org-trust-scanner-tags
14703 (or (not pos) (equal pos (point)))
14704 (not local))
14705 org-scanner-tags
14706 (let (tags ltags lastpos parent)
14707 (save-excursion
14708 (save-restriction
14709 (widen)
14710 (goto-char (or pos (point)))
14711 (save-match-data
14712 (catch 'done
14713 (condition-case nil
14714 (progn
14715 (org-back-to-heading t)
14716 (while (not (equal lastpos (point)))
14717 (setq lastpos (point))
14718 (when (looking-at
14719 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14720 (setq ltags (org-split-string
14721 (org-match-string-no-properties 1) ":"))
14722 (when parent
14723 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14724 (setq tags (append
14725 (if parent
14726 (org-remove-uninherited-tags ltags)
14727 ltags)
14728 tags)))
14729 (or org-use-tag-inheritance (throw 'done t))
14730 (if local (throw 'done t))
14731 (or (org-up-heading-safe) (error nil))
14732 (setq parent t)))
14733 (error nil)))))
14734 (if local
14735 tags
14736 (reverse (delete-dups
14737 (reverse (append
14738 (org-remove-uninherited-tags
14739 org-file-tags) tags)))))))))
14741 (defun org-add-prop-inherited (s)
14742 (add-text-properties 0 (length s) '(inherited t) s)
14745 (defun org-toggle-tag (tag &optional onoff)
14746 "Toggle the tag TAG for the current line.
14747 If ONOFF is `on' or `off', don't toggle but set to this state."
14748 (let (res current)
14749 (save-excursion
14750 (org-back-to-heading t)
14751 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14752 (point-at-eol) t)
14753 (progn
14754 (setq current (match-string 1))
14755 (replace-match ""))
14756 (setq current ""))
14757 (setq current (nreverse (org-split-string current ":")))
14758 (cond
14759 ((eq onoff 'on)
14760 (setq res t)
14761 (or (member tag current) (push tag current)))
14762 ((eq onoff 'off)
14763 (or (not (member tag current)) (setq current (delete tag current))))
14764 (t (if (member tag current)
14765 (setq current (delete tag current))
14766 (setq res t)
14767 (push tag current))))
14768 (end-of-line 1)
14769 (if current
14770 (progn
14771 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14772 (org-set-tags nil t))
14773 (delete-horizontal-space))
14774 (run-hooks 'org-after-tags-change-hook))
14775 res))
14777 (defun org-align-tags-here (to-col)
14778 ;; Assumes that this is a headline
14779 "Align tags on the current headline to TO-COL."
14780 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14781 (beginning-of-line 1)
14782 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14783 (< pos (match-beginning 2)))
14784 (progn
14785 (setq tags-l (- (match-end 2) (match-beginning 2)))
14786 (goto-char (match-beginning 1))
14787 (insert " ")
14788 (delete-region (point) (1+ (match-beginning 2)))
14789 (setq ncol (max (current-column)
14790 (1+ col)
14791 (if (> to-col 0)
14792 to-col
14793 (- (abs to-col) tags-l))))
14794 (setq p (point))
14795 (insert (make-string (- ncol (current-column)) ?\ ))
14796 (setq ncol (current-column))
14797 (when indent-tabs-mode (tabify p (point-at-eol)))
14798 (org-move-to-column (min ncol col)))
14799 (goto-char pos))))
14801 (defun org-set-tags-command (&optional arg just-align)
14802 "Call the set-tags command for the current entry."
14803 (interactive "P")
14804 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14805 (org-set-tags arg just-align)
14806 (save-excursion
14807 (unless (and (org-region-active-p)
14808 org-loop-over-headlines-in-active-region)
14809 (org-back-to-heading t))
14810 (org-set-tags arg just-align))))
14812 (defun org-set-tags-to (data)
14813 "Set the tags of the current entry to DATA, replacing the current tags.
14814 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14815 If DATA is nil or the empty string, any tags will be removed."
14816 (interactive "sTags: ")
14817 (setq data
14818 (cond
14819 ((eq data nil) "")
14820 ((equal data "") "")
14821 ((stringp data)
14822 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14823 ":"))
14824 ((listp data)
14825 (concat ":" (mapconcat 'identity data ":") ":"))))
14826 (when data
14827 (save-excursion
14828 (org-back-to-heading t)
14829 (when (looking-at org-complex-heading-regexp)
14830 (if (match-end 5)
14831 (progn
14832 (goto-char (match-beginning 5))
14833 (insert data)
14834 (delete-region (point) (point-at-eol))
14835 (org-set-tags nil 'align))
14836 (goto-char (point-at-eol))
14837 (insert " " data)
14838 (org-set-tags nil 'align)))
14839 (beginning-of-line 1)
14840 (if (looking-at ".*?\\([ \t]+\\)$")
14841 (delete-region (match-beginning 1) (match-end 1))))))
14843 (defun org-align-all-tags ()
14844 "Align the tags i all headings."
14845 (interactive)
14846 (save-excursion
14847 (or (ignore-errors (org-back-to-heading t))
14848 (outline-next-heading))
14849 (if (org-at-heading-p)
14850 (org-set-tags t)
14851 (message "No headings"))))
14853 (defvar org-indent-indentation-per-level)
14854 (defun org-set-tags (&optional arg just-align)
14855 "Set the tags for the current headline.
14856 With prefix ARG, realign all tags in headings in the current buffer.
14857 When JUST-ALIGN is non-nil, only align tags."
14858 (interactive "P")
14859 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14860 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14861 'region-start-level 'region))
14862 org-loop-over-headlines-in-active-region)
14863 (org-map-entries
14864 ;; We don't use ARG and JUST-ALIGN here because these args
14865 ;; are not useful when looping over headlines.
14866 `(org-set-tags)
14867 org-loop-over-headlines-in-active-region
14868 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14869 (let* ((re org-outline-regexp-bol)
14870 (current (unless arg (org-get-tags-string)))
14871 (col (current-column))
14872 (org-setting-tags t)
14873 table current-tags inherited-tags ; computed below when needed
14874 tags p0 c0 c1 rpl di tc level)
14875 (if arg
14876 (save-excursion
14877 (goto-char (point-min))
14878 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14879 (while (re-search-forward re nil t)
14880 (org-set-tags nil t)
14881 (end-of-line 1)))
14882 (message "All tags realigned to column %d" org-tags-column))
14883 (if just-align
14884 (setq tags current)
14885 ;; Get a new set of tags from the user
14886 (save-excursion
14887 (setq table (append org-tag-persistent-alist
14888 (or org-tag-alist (org-get-buffer-tags))
14889 (and
14890 org-complete-tags-always-offer-all-agenda-tags
14891 (org-global-tags-completion-table
14892 (org-agenda-files))))
14893 org-last-tags-completion-table table
14894 current-tags (org-split-string current ":")
14895 inherited-tags (nreverse
14896 (nthcdr (length current-tags)
14897 (nreverse (org-get-tags-at))))
14898 tags
14899 (if (or (eq t org-use-fast-tag-selection)
14900 (and org-use-fast-tag-selection
14901 (delq nil (mapcar 'cdr table))))
14902 (org-fast-tag-selection
14903 current-tags inherited-tags table
14904 (if org-fast-tag-selection-include-todo
14905 org-todo-key-alist))
14906 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14907 (org-trim
14908 (org-icompleting-read "Tags: "
14909 'org-tags-completion-function
14910 nil nil current 'org-tags-history))))))
14911 (while (string-match "[-+&]+" tags)
14912 ;; No boolean logic, just a list
14913 (setq tags (replace-match ":" t t tags))))
14915 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14917 (if org-tags-sort-function
14918 (setq tags (mapconcat 'identity
14919 (sort (org-split-string
14920 tags (org-re "[^[:alnum:]_@#%]+"))
14921 org-tags-sort-function) ":")))
14923 (if (string-match "\\`[\t ]*\\'" tags)
14924 (setq tags "")
14925 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14926 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14928 ;; Insert new tags at the correct column
14929 (beginning-of-line 1)
14930 (setq level (or (and (looking-at org-outline-regexp)
14931 (- (match-end 0) (point) 1))
14933 (cond
14934 ((and (equal current "") (equal tags "")))
14935 ((re-search-forward
14936 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14937 (point-at-eol) t)
14938 (if (equal tags "")
14939 (setq rpl "")
14940 (goto-char (match-beginning 0))
14941 (setq c0 (current-column)
14942 ;; compute offset for the case of org-indent-mode active
14943 di (if (org-bound-and-true-p org-indent-mode)
14944 (* (1- org-indent-indentation-per-level) (1- level))
14946 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14947 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14948 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
14949 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14950 (replace-match rpl t t)
14951 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14952 tags)
14953 (t (error "Tags alignment failed")))
14954 (org-move-to-column col)
14955 (unless just-align
14956 (run-hooks 'org-after-tags-change-hook))))))
14958 (defun org-change-tag-in-region (beg end tag off)
14959 "Add or remove TAG for each entry in the region.
14960 This works in the agenda, and also in an org-mode buffer."
14961 (interactive
14962 (list (region-beginning) (region-end)
14963 (let ((org-last-tags-completion-table
14964 (if (derived-mode-p 'org-mode)
14965 (org-uniquify
14966 (delq nil (append (org-get-buffer-tags)
14967 (org-global-tags-completion-table))))
14968 (org-global-tags-completion-table))))
14969 (org-icompleting-read
14970 "Tag: " 'org-tags-completion-function nil nil nil
14971 'org-tags-history))
14972 (progn
14973 (message "[s]et or [r]emove? ")
14974 (equal (read-char-exclusive) ?r))))
14975 (if (fboundp 'deactivate-mark) (deactivate-mark))
14976 (let ((agendap (equal major-mode 'org-agenda-mode))
14977 l1 l2 m buf pos newhead (cnt 0))
14978 (goto-char end)
14979 (setq l2 (1- (org-current-line)))
14980 (goto-char beg)
14981 (setq l1 (org-current-line))
14982 (loop for l from l1 to l2 do
14983 (org-goto-line l)
14984 (setq m (get-text-property (point) 'org-hd-marker))
14985 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14986 (and agendap m))
14987 (setq buf (if agendap (marker-buffer m) (current-buffer))
14988 pos (if agendap m (point)))
14989 (with-current-buffer buf
14990 (save-excursion
14991 (save-restriction
14992 (goto-char pos)
14993 (setq cnt (1+ cnt))
14994 (org-toggle-tag tag (if off 'off 'on))
14995 (setq newhead (org-get-heading)))))
14996 (and agendap (org-agenda-change-all-lines newhead m))))
14997 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14999 (defun org-tags-completion-function (string predicate &optional flag)
15000 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15001 (confirm (lambda (x) (stringp (car x)))))
15002 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15003 (setq s1 (match-string 1 string)
15004 s2 (match-string 2 string))
15005 (setq s1 "" s2 string))
15006 (cond
15007 ((eq flag nil)
15008 ;; try completion
15009 (setq rtn (try-completion s2 ctable confirm))
15010 (if (stringp rtn)
15011 (setq rtn
15012 (concat s1 s2 (substring rtn (length s2))
15013 (if (and org-add-colon-after-tag-completion
15014 (assoc rtn ctable))
15015 ":" ""))))
15016 rtn)
15017 ((eq flag t)
15018 ;; all-completions
15019 (all-completions s2 ctable confirm))
15020 ((eq flag 'lambda)
15021 ;; exact match?
15022 (assoc s2 ctable)))))
15024 (defun org-fast-tag-insert (kwd tags face &optional end)
15025 "Insert KDW, and the TAGS, the latter with face FACE.
15026 Also insert END."
15027 (insert (format "%-12s" (concat kwd ":"))
15028 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15029 (or end "")))
15031 (defun org-fast-tag-show-exit (flag)
15032 (save-excursion
15033 (org-goto-line 3)
15034 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15035 (replace-match ""))
15036 (when flag
15037 (end-of-line 1)
15038 (org-move-to-column (- (window-width) 19) t)
15039 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15041 (defun org-set-current-tags-overlay (current prefix)
15042 "Add an overlay to CURRENT tag with PREFIX."
15043 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15044 (if (featurep 'xemacs)
15045 (org-overlay-display org-tags-overlay (concat prefix s)
15046 'secondary-selection)
15047 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15048 (org-overlay-display org-tags-overlay (concat prefix s)))))
15050 (defvar org-last-tag-selection-key nil)
15051 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15052 "Fast tag selection with single keys.
15053 CURRENT is the current list of tags in the headline, INHERITED is the
15054 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15055 possibly with grouping information. TODO-TABLE is a similar table with
15056 TODO keywords, should these have keys assigned to them.
15057 If the keys are nil, a-z are automatically assigned.
15058 Returns the new tags string, or nil to not change the current settings."
15059 (let* ((fulltable (append table todo-table))
15060 (maxlen (apply 'max (mapcar
15061 (lambda (x)
15062 (if (stringp (car x)) (string-width (car x)) 0))
15063 fulltable)))
15064 (buf (current-buffer))
15065 (expert (eq org-fast-tag-selection-single-key 'expert))
15066 (buffer-tags nil)
15067 (fwidth (+ maxlen 3 1 3))
15068 (ncol (/ (- (window-width) 4) fwidth))
15069 (i-face 'org-done)
15070 (c-face 'org-todo)
15071 tg cnt e c char c1 c2 ntable tbl rtn
15072 ov-start ov-end ov-prefix
15073 (exit-after-next org-fast-tag-selection-single-key)
15074 (done-keywords org-done-keywords)
15075 groups ingroup)
15076 (save-excursion
15077 (beginning-of-line 1)
15078 (if (looking-at
15079 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15080 (setq ov-start (match-beginning 1)
15081 ov-end (match-end 1)
15082 ov-prefix "")
15083 (setq ov-start (1- (point-at-eol))
15084 ov-end (1+ ov-start))
15085 (skip-chars-forward "^\n\r")
15086 (setq ov-prefix
15087 (concat
15088 (buffer-substring (1- (point)) (point))
15089 (if (> (current-column) org-tags-column)
15091 (make-string (- org-tags-column (current-column)) ?\ ))))))
15092 (move-overlay org-tags-overlay ov-start ov-end)
15093 (save-window-excursion
15094 (if expert
15095 (set-buffer (get-buffer-create " *Org tags*"))
15096 (delete-other-windows)
15097 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15098 (org-switch-to-buffer-other-window " *Org tags*"))
15099 (erase-buffer)
15100 (org-set-local 'org-done-keywords done-keywords)
15101 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15102 (org-fast-tag-insert "Current" current c-face "\n\n")
15103 (org-fast-tag-show-exit exit-after-next)
15104 (org-set-current-tags-overlay current ov-prefix)
15105 (setq tbl fulltable char ?a cnt 0)
15106 (while (setq e (pop tbl))
15107 (cond
15108 ((equal (car e) :startgroup)
15109 (push '() groups) (setq ingroup t)
15110 (when (not (= cnt 0))
15111 (setq cnt 0)
15112 (insert "\n"))
15113 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15114 ((equal (car e) :endgroup)
15115 (setq ingroup nil cnt 0)
15116 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15117 ((equal e '(:newline))
15118 (when (not (= cnt 0))
15119 (setq cnt 0)
15120 (insert "\n")
15121 (setq e (car tbl))
15122 (while (equal (car tbl) '(:newline))
15123 (insert "\n")
15124 (setq tbl (cdr tbl)))))
15125 ((equal e '(:grouptags)) nil)
15127 (setq tg (copy-sequence (car e)) c2 nil)
15128 (if (cdr e)
15129 (setq c (cdr e))
15130 ;; automatically assign a character.
15131 (setq c1 (string-to-char
15132 (downcase (substring
15133 tg (if (= (string-to-char tg) ?@) 1 0)))))
15134 (if (or (rassoc c1 ntable) (rassoc c1 table))
15135 (while (or (rassoc char ntable) (rassoc char table))
15136 (setq char (1+ char)))
15137 (setq c2 c1))
15138 (setq c (or c2 char)))
15139 (if ingroup (push tg (car groups)))
15140 (setq tg (org-add-props tg nil 'face
15141 (cond
15142 ((not (assoc tg table))
15143 (org-get-todo-face tg))
15144 ((member tg current) c-face)
15145 ((member tg inherited) i-face))))
15146 (if (equal (caar tbl) :grouptags)
15147 (org-add-props tg nil 'face 'org-tag-group))
15148 (if (and (= cnt 0) (not ingroup)) (insert " "))
15149 (insert "[" c "] " tg (make-string
15150 (- fwidth 4 (length tg)) ?\ ))
15151 (push (cons tg c) ntable)
15152 (when (= (setq cnt (1+ cnt)) ncol)
15153 (insert "\n")
15154 (if ingroup (insert " "))
15155 (setq cnt 0)))))
15156 (setq ntable (nreverse ntable))
15157 (insert "\n")
15158 (goto-char (point-min))
15159 (if (not expert) (org-fit-window-to-buffer))
15160 (setq rtn
15161 (catch 'exit
15162 (while t
15163 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15164 (if (not groups) "no " "")
15165 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15166 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15167 (setq org-last-tag-selection-key c)
15168 (cond
15169 ((= c ?\r) (throw 'exit t))
15170 ((= c ?!)
15171 (setq groups (not groups))
15172 (goto-char (point-min))
15173 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15174 ((= c ?\C-c)
15175 (if (not expert)
15176 (org-fast-tag-show-exit
15177 (setq exit-after-next (not exit-after-next)))
15178 (setq expert nil)
15179 (delete-other-windows)
15180 (set-window-buffer (split-window-vertically) " *Org tags*")
15181 (org-switch-to-buffer-other-window " *Org tags*")
15182 (org-fit-window-to-buffer)))
15183 ((or (= c ?\C-g)
15184 (and (= c ?q) (not (rassoc c ntable))))
15185 (org-detach-overlay org-tags-overlay)
15186 (setq quit-flag t))
15187 ((= c ?\ )
15188 (setq current nil)
15189 (if exit-after-next (setq exit-after-next 'now)))
15190 ((= c ?\t)
15191 (condition-case nil
15192 (setq tg (org-icompleting-read
15193 "Tag: "
15194 (or buffer-tags
15195 (with-current-buffer buf
15196 (org-get-buffer-tags)))))
15197 (quit (setq tg "")))
15198 (when (string-match "\\S-" tg)
15199 (add-to-list 'buffer-tags (list tg))
15200 (if (member tg current)
15201 (setq current (delete tg current))
15202 (push tg current)))
15203 (if exit-after-next (setq exit-after-next 'now)))
15204 ((setq e (rassoc c todo-table) tg (car e))
15205 (with-current-buffer buf
15206 (save-excursion (org-todo tg)))
15207 (if exit-after-next (setq exit-after-next 'now)))
15208 ((setq e (rassoc c ntable) tg (car e))
15209 (if (member tg current)
15210 (setq current (delete tg current))
15211 (loop for g in groups do
15212 (if (member tg g)
15213 (mapc (lambda (x)
15214 (setq current (delete x current)))
15215 g)))
15216 (push tg current))
15217 (if exit-after-next (setq exit-after-next 'now))))
15219 ;; Create a sorted list
15220 (setq current
15221 (sort current
15222 (lambda (a b)
15223 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15224 (if (eq exit-after-next 'now) (throw 'exit t))
15225 (goto-char (point-min))
15226 (beginning-of-line 2)
15227 (delete-region (point) (point-at-eol))
15228 (org-fast-tag-insert "Current" current c-face)
15229 (org-set-current-tags-overlay current ov-prefix)
15230 (while (re-search-forward
15231 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15232 (setq tg (match-string 1))
15233 (add-text-properties
15234 (match-beginning 1) (match-end 1)
15235 (list 'face
15236 (cond
15237 ((member tg current) c-face)
15238 ((member tg inherited) i-face)
15239 (t (get-text-property (match-beginning 1) 'face))))))
15240 (goto-char (point-min)))))
15241 (org-detach-overlay org-tags-overlay)
15242 (if rtn
15243 (mapconcat 'identity current ":")
15244 nil))))
15246 (defun org-get-tags-string ()
15247 "Get the TAGS string in the current headline."
15248 (unless (org-at-heading-p t)
15249 (user-error "Not on a heading"))
15250 (save-excursion
15251 (beginning-of-line 1)
15252 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15253 (org-match-string-no-properties 1)
15254 "")))
15256 (defun org-get-tags ()
15257 "Get the list of tags specified in the current headline."
15258 (org-split-string (org-get-tags-string) ":"))
15260 (defun org-get-buffer-tags ()
15261 "Get a table of all tags used in the buffer, for completion."
15262 (org-with-wide-buffer
15263 (goto-char (point-min))
15264 (let ((tag-re (concat org-outline-regexp-bol
15265 "\\(?:.*?[ \t]\\)?"
15266 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15267 tags)
15268 (while (re-search-forward tag-re nil t)
15269 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15270 (push tag tags)))
15271 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15273 ;;;; The mapping API
15275 (defun org-map-entries (func &optional match scope &rest skip)
15276 "Call FUNC at each headline selected by MATCH in SCOPE.
15278 FUNC is a function or a lisp form. The function will be called without
15279 arguments, with the cursor positioned at the beginning of the headline.
15280 The return values of all calls to the function will be collected and
15281 returned as a list.
15283 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15284 does not need to preserve point. After evaluation, the cursor will be
15285 moved to the end of the line (presumably of the headline of the
15286 processed entry) and search continues from there. Under some
15287 circumstances, this may not produce the wanted results. For example,
15288 if you have removed (e.g. archived) the current (sub)tree it could
15289 mean that the next entry will be skipped entirely. In such cases, you
15290 can specify the position from where search should continue by making
15291 FUNC set the variable `org-map-continue-from' to the desired buffer
15292 position.
15294 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15295 Only headlines that are matched by this query will be considered during
15296 the iteration. When MATCH is nil or t, all headlines will be
15297 visited by the iteration.
15299 SCOPE determines the scope of this command. It can be any of:
15301 nil The current buffer, respecting the restriction if any
15302 tree The subtree started with the entry at point
15303 region The entries within the active region, if any
15304 region-start-level
15305 The entries within the active region, but only those at
15306 the same level than the first one.
15307 file The current buffer, without restriction
15308 file-with-archives
15309 The current buffer, and any archives associated with it
15310 agenda All agenda files
15311 agenda-with-archives
15312 All agenda files with any archive files associated with them
15313 \(file1 file2 ...)
15314 If this is a list, all files in the list will be scanned
15316 The remaining args are treated as settings for the skipping facilities of
15317 the scanner. The following items can be given here:
15319 archive skip trees with the archive tag
15320 comment skip trees with the COMMENT keyword
15321 function or Emacs Lisp form:
15322 will be used as value for `org-agenda-skip-function', so
15323 whenever the function returns a position, FUNC will not be
15324 called for that entry and search will continue from the
15325 position returned
15327 If your function needs to retrieve the tags including inherited tags
15328 at the *current* entry, you can use the value of the variable
15329 `org-scanner-tags' which will be much faster than getting the value
15330 with `org-get-tags-at'. If your function gets properties with
15331 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15332 to t around the call to `org-entry-properties' to get the same speedup.
15333 Note that if your function moves around to retrieve tags and properties at
15334 a *different* entry, you cannot use these techniques."
15335 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15336 (not (org-region-active-p)))
15337 (let* ((org-agenda-archives-mode nil) ; just to make sure
15338 (org-agenda-skip-archived-trees (memq 'archive skip))
15339 (org-agenda-skip-comment-trees (memq 'comment skip))
15340 (org-agenda-skip-function
15341 (car (org-delete-all '(comment archive) skip)))
15342 (org-tags-match-list-sublevels t)
15343 (start-level (eq scope 'region-start-level))
15344 matcher file res
15345 org-todo-keywords-for-agenda
15346 org-done-keywords-for-agenda
15347 org-todo-keyword-alist-for-agenda
15348 org-tag-alist-for-agenda
15349 todo-only)
15351 (cond
15352 ((eq match t) (setq matcher t))
15353 ((eq match nil) (setq matcher t))
15354 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15356 (save-excursion
15357 (save-restriction
15358 (cond ((eq scope 'tree)
15359 (org-back-to-heading t)
15360 (org-narrow-to-subtree)
15361 (setq scope nil))
15362 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15363 (org-region-active-p))
15364 ;; If needed, set start-level to a string like "2"
15365 (when start-level
15366 (save-excursion
15367 (goto-char (region-beginning))
15368 (unless (org-at-heading-p) (outline-next-heading))
15369 (setq start-level (org-current-level))))
15370 (narrow-to-region (region-beginning)
15371 (save-excursion
15372 (goto-char (region-end))
15373 (unless (and (bolp) (org-at-heading-p))
15374 (outline-next-heading))
15375 (point)))
15376 (setq scope nil)))
15378 (if (not scope)
15379 (progn
15380 (org-agenda-prepare-buffers
15381 (list (buffer-file-name (current-buffer))))
15382 (setq res (org-scan-tags func matcher todo-only start-level)))
15383 ;; Get the right scope
15384 (cond
15385 ((and scope (listp scope) (symbolp (car scope)))
15386 (setq scope (eval scope)))
15387 ((eq scope 'agenda)
15388 (setq scope (org-agenda-files t)))
15389 ((eq scope 'agenda-with-archives)
15390 (setq scope (org-agenda-files t))
15391 (setq scope (org-add-archive-files scope)))
15392 ((eq scope 'file)
15393 (setq scope (list (buffer-file-name))))
15394 ((eq scope 'file-with-archives)
15395 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15396 (org-agenda-prepare-buffers scope)
15397 (while (setq file (pop scope))
15398 (with-current-buffer (org-find-base-buffer-visiting file)
15399 (save-excursion
15400 (save-restriction
15401 (widen)
15402 (goto-char (point-min))
15403 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15404 res)))
15406 ;;; Properties API
15408 (defconst org-special-properties
15409 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15410 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15411 "The special properties valid in Org mode.
15412 These are properties that are not defined in the property drawer,
15413 but in some other way.")
15415 (defconst org-default-properties
15416 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15417 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15418 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15419 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15420 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15421 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15422 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15423 "Some properties that are used by Org mode for various purposes.
15424 Being in this list makes sure that they are offered for completion.")
15426 (defun org--update-property-plist (key val props)
15427 "Associate KEY to VAL in alist PROPS.
15428 Modifications are made by side-effect. Return new alist."
15429 (let* ((appending (string= (substring key -1) "+"))
15430 (key (if appending (substring key 0 -1) key))
15431 (old (assoc-string key props t)))
15432 (if (not old) (cons (cons key val) props)
15433 (setcdr old (if appending (concat (cdr old) " " val) val))
15434 props)))
15436 (defun org-get-property-block (&optional beg force)
15437 "Return the (beg . end) range of the body of the property drawer.
15438 BEG is the beginning of the current subtree, or of the part
15439 before the first headline. If it is not given, it will be found.
15440 If the drawer does not exist, create it if FORCE is non-nil, or
15441 return nil."
15442 (org-with-wide-buffer
15443 (when beg (goto-char beg))
15444 (unless (org-before-first-heading-p)
15445 (let ((beg (cond (beg)
15446 ((or (not (featurep 'org-inlinetask))
15447 (org-inlinetask-in-task-p))
15448 (org-back-to-heading t))
15449 (t (org-with-limited-levels (org-back-to-heading t))))))
15450 (forward-line)
15451 (when (org-looking-at-p org-planning-line-re) (forward-line))
15452 (cond ((looking-at org-property-drawer-re)
15453 (forward-line)
15454 (cons (point) (progn (goto-char (match-end 0))
15455 (line-beginning-position))))
15456 (force
15457 (goto-char beg)
15458 (org-insert-property-drawer)
15459 (let ((pos (save-excursion (search-forward ":END:")
15460 (line-beginning-position))))
15461 (cons pos pos))))))))
15463 (defun org-at-property-p ()
15464 "Non-nil when point is inside a property drawer.
15465 See `org-property-re' for match data, if applicable."
15466 (save-excursion
15467 (beginning-of-line)
15468 (and (looking-at org-property-re)
15469 (let ((property-drawer (save-match-data (org-get-property-block))))
15470 (and property-drawer (< (point) (cdr property-drawer)))))))
15472 (defun org-property-action ()
15473 "Do an action on properties."
15474 (interactive)
15475 (unless (org-at-property-p) (user-error "Not at a property"))
15476 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15477 (let ((c (read-char-exclusive)))
15478 (case c
15479 (?s (call-interactively #'org-set-property))
15480 (?d (call-interactively #'org-delete-property))
15481 (?D (call-interactively #'org-delete-property-globally))
15482 (?c (call-interactively #'org-compute-property-at-point))
15483 (otherwise (user-error "No such property action %c" c)))))
15485 (defun org-inc-effort ()
15486 "Increment the value of the effort property in the current entry."
15487 (interactive)
15488 (org-set-effort nil t))
15490 (defvar org-clock-effort) ; Defined in org-clock.el.
15491 (defvar org-clock-current-task) ; Defined in org-clock.el.
15492 (defun org-set-effort (&optional value increment)
15493 "Set the effort property of the current entry.
15494 With numerical prefix arg, use the nth allowed value, 0 stands for the
15495 10th allowed value.
15497 When INCREMENT is non-nil, set the property to the next allowed value."
15498 (interactive "P")
15499 (if (equal value 0) (setq value 10))
15500 (let* ((completion-ignore-case t)
15501 (prop org-effort-property)
15502 (cur (org-entry-get nil prop))
15503 (allowed (org-property-get-allowed-values nil prop 'table))
15504 (existing (mapcar 'list (org-property-values prop)))
15505 (heading (nth 4 (org-heading-components)))
15507 (val (cond
15508 ((stringp value) value)
15509 ((and allowed (integerp value))
15510 (or (car (nth (1- value) allowed))
15511 (car (org-last allowed))))
15512 ((and allowed increment)
15513 (or (caadr (member (list cur) allowed))
15514 (user-error "Allowed effort values are not set")))
15515 (allowed
15516 (message "Select 1-9,0, [RET%s]: %s"
15517 (if cur (concat "=" cur) "")
15518 (mapconcat 'car allowed " "))
15519 (setq rpl (read-char-exclusive))
15520 (if (equal rpl ?\r)
15522 (setq rpl (- rpl ?0))
15523 (if (equal rpl 0) (setq rpl 10))
15524 (if (and (> rpl 0) (<= rpl (length allowed)))
15525 (car (nth (1- rpl) allowed))
15526 (org-completing-read "Effort: " allowed nil))))
15528 (let (org-completion-use-ido org-completion-use-iswitchb)
15529 (org-completing-read
15530 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15531 (concat "[" cur "]") "")
15532 ": ")
15533 existing nil nil "" nil cur))))))
15534 (unless (equal (org-entry-get nil prop) val)
15535 (org-entry-put nil prop val))
15536 (org-refresh-property
15537 '((effort . identity)
15538 (effort-minutes . org-duration-string-to-minutes))
15539 val)
15540 (when (string= heading org-clock-current-task)
15541 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15542 (org-clock-update-mode-line))
15543 (message "%s is now %s" prop val)))
15545 (defun org-entry-properties (&optional pom which)
15546 "Get all properties of the current entry.
15548 When POM is a buffer position, get all properties from the entry
15549 there instead.
15551 This includes the TODO keyword, the tags, time strings for
15552 deadline, scheduled, and clocking, and any additional properties
15553 defined in the entry.
15555 If WHICH is nil or `all', get all properties. If WHICH is
15556 `special' or `standard', only get that subclass. If WHICH is
15557 a string, only get that property.
15559 Return value is an alist. Keys are properties, as upcased
15560 strings."
15561 (org-with-point-at pom
15562 (when (and (derived-mode-p 'org-mode)
15563 (ignore-errors (org-back-to-heading t)))
15564 (catch 'exit
15565 (let* ((beg (point))
15566 (specific (and (stringp which) (upcase which)))
15567 (which (cond ((not specific) which)
15568 ((member specific org-special-properties) 'special)
15569 (t 'standard)))
15570 props)
15571 ;; Get the special properties, like TODO and TAGS.
15572 (when (memq which '(nil all special))
15573 (when (or (not specific) (string= specific "CLOCKSUM"))
15574 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15575 (when clocksum
15576 (push (cons "CLOCKSUM"
15577 (org-columns-number-to-string
15578 (/ (float clocksum) 60.) 'add_times))
15579 props)))
15580 (when specific (throw 'exit props)))
15581 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15582 (let ((clocksumt (get-text-property (point)
15583 :org-clock-minutes-today)))
15584 (when clocksumt
15585 (push (cons "CLOCKSUM_T"
15586 (org-columns-number-to-string
15587 (/ (float clocksumt) 60.) 'add_times))
15588 props)))
15589 (when specific (throw 'exit props)))
15590 (when (or (not specific) (string= specific "ITEM"))
15591 (when (looking-at org-complex-heading-regexp)
15592 (push (cons "ITEM"
15593 (concat
15594 (org-match-string-no-properties 1)
15595 (let ((title (org-match-string-no-properties 4)))
15596 (when (org-string-nw-p title)
15597 (concat " " (org-remove-tabs title))))))
15598 props))
15599 (when specific (throw 'exit props)))
15600 (when (or (not specific) (string= specific "TODO"))
15601 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15602 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15603 (when specific (throw 'exit props)))
15604 (when (or (not specific) (string= specific "PRIORITY"))
15605 (when (looking-at org-priority-regexp)
15606 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15607 (when specific (throw 'exit props)))
15608 (when (or (not specific) (string= specific "FILE"))
15609 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15610 props)
15611 (when specific (throw 'exit props)))
15612 (when (or (not specific) (string= specific "TAGS"))
15613 (let ((value (org-string-nw-p (org-get-tags-string))))
15614 (when value (push (cons "TAGS" value) props)))
15615 (when specific (throw 'exit props)))
15616 (when (or (not specific) (string= specific "ALLTAGS"))
15617 (let ((value (org-get-tags-at)))
15618 (when value
15619 (push (cons "ALLTAGS"
15620 (format ":%s:" (mapconcat #'identity value ":")))
15621 props)))
15622 (when specific (throw 'exit props)))
15623 (when (or (not specific) (string= specific "BLOCKED"))
15624 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15625 (when specific (throw 'exit props)))
15626 (when (or (not specific)
15627 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15628 (forward-line)
15629 (when (org-looking-at-p org-planning-line-re)
15630 (end-of-line)
15631 (let ((bol (line-beginning-position))
15632 ;; Backward compatibility: time keywords used to
15633 ;; be configurable (before 8.3). Make sure we
15634 ;; get the correct keyword.
15635 (key-assoc `(("CLOSED" . ,org-closed-string)
15636 ("DEADLINE" . ,org-deadline-string)
15637 ("SCHEDULED" . ,org-scheduled-string))))
15638 (dolist (pair (if specific (list (assoc specific key-assoc))
15639 key-assoc))
15640 (save-excursion
15641 (when (search-backward (cdr pair) bol t)
15642 (goto-char (match-end 0))
15643 (skip-chars-forward " \t")
15644 (and (looking-at org-ts-regexp-both)
15645 (push (cons (car pair)
15646 (org-match-string-no-properties 0))
15647 props)))))))
15648 (when specific (throw 'exit props)))
15649 (when (or (not specific)
15650 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15651 (let ((find-ts
15652 (lambda (end ts)
15653 (let ((regexp (if (or (string= specific "TIMESTAMP")
15654 (assoc "TIMESTAMP_IA" ts))
15655 org-ts-regexp
15656 org-ts-regexp-both)))
15657 (catch 'next
15658 (while (re-search-forward regexp end t)
15659 (backward-char)
15660 (let ((object (org-element-context)))
15661 ;; Accept to match timestamps in node
15662 ;; properties, too.
15663 (when (memq (org-element-type object)
15664 '(node-property timestamp))
15665 (let ((type
15666 (org-element-property :type object)))
15667 (cond
15668 ((and (memq type '(active active-range))
15669 (not (equal specific "TIMESTAMP_IA")))
15670 (unless (assoc "TIMESTAMP" ts)
15671 (push (cons "TIMESTAMP"
15672 (org-element-property
15673 :raw-value object))
15675 (when specific (throw 'exit ts))))
15676 ((and (memq type '(inactive inactive-range))
15677 (not (string= specific "TIMESTAMP")))
15678 (unless (assoc "TIMESTAMP_IA" ts)
15679 (push (cons "TIMESTAMP_IA"
15680 (org-element-property
15681 :raw-value object))
15683 (when specific (throw 'exit ts))))))
15684 ;; Both timestamp types are found,
15685 ;; move to next part.
15686 (when (= (length ts) 2) (throw 'next ts)))))
15687 ts)))))
15688 (goto-char beg)
15689 ;; First look for timestamps within headline.
15690 (let ((ts (funcall find-ts (line-end-position) nil)))
15691 (if (= (length ts) 2) (setq props (nconc ts props))
15692 (forward-line)
15693 ;; Then find timestamps in the section, skipping
15694 ;; planning line.
15695 (when (org-looking-at-p org-planning-line-re)
15696 (forward-line))
15697 (let ((end (save-excursion (outline-next-heading))))
15698 (setq props (nconc (funcall find-ts end ts) props))))))))
15699 ;; Get the standard properties, like :PROP:.
15700 (when (memq which '(nil all standard))
15701 ;; If we are looking after a specific property, delegate
15702 ;; to `org-entry-get', which is faster. However, make an
15703 ;; exception for "CATEGORY", since it can be also set
15704 ;; through keywords (i.e. #+CATEGORY).
15705 (if (and specific (not (equal specific "CATEGORY")))
15706 (let ((value (org-entry-get beg specific nil t)))
15707 (throw 'exit (and value (list (cons specific value)))))
15708 (let ((range (org-get-property-block beg)))
15709 (when range
15710 (let ((end (cdr range)) seen-base)
15711 (goto-char (car range))
15712 ;; Unlike to `org--update-property-plist', we
15713 ;; handle the case where base values is found
15714 ;; after its extension. We also forbid standard
15715 ;; properties to be named as special properties.
15716 (while (re-search-forward org-property-re end t)
15717 (let* ((key (upcase (org-match-string-no-properties 2)))
15718 (extendp (org-string-match-p "\\+\\'" key))
15719 (key-base (if extendp (substring key 0 -1) key))
15720 (value (org-match-string-no-properties 3)))
15721 (cond
15722 ((member-ignore-case key-base org-special-properties))
15723 (extendp
15724 (setq props
15725 (org--update-property-plist key value props)))
15726 ((member key seen-base))
15727 (t (push key seen-base)
15728 (let ((p (assoc-string key props t)))
15729 (if p (setcdr p (concat value " " (cdr p)))
15730 (push (cons key value) props))))))))))))
15731 (unless (assoc "CATEGORY" props)
15732 (push (cons "CATEGORY" (org-get-category beg)) props)
15733 (when (string= specific "CATEGORY") (throw 'exit props)))
15734 ;; Return value.
15735 (append (get-text-property beg 'org-summaries) props))))))
15737 (defun org-entry-get (pom property &optional inherit literal-nil)
15738 "Get value of PROPERTY for entry or content at point-or-marker POM.
15740 If INHERIT is non-nil and the entry does not have the property,
15741 then also check higher levels of the hierarchy. If INHERIT is
15742 the symbol `selective', use inheritance only if the setting in
15743 `org-use-property-inheritance' selects PROPERTY for inheritance.
15745 If the property is present but empty, the return value is the
15746 empty string. If the property is not present at all, nil is
15747 returned. In any other case, return the value as a string.
15748 Search is case-insensitive.
15750 If LITERAL-NIL is set, return the string value \"nil\" as
15751 a string, do not interpret it as the list atom nil. This is used
15752 for inheritance when a \"nil\" value can supersede a non-nil
15753 value higher up the hierarchy."
15754 (org-with-point-at pom
15755 (cond
15756 ((and inherit
15757 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15758 (org-entry-get-with-inheritance property literal-nil))
15759 ((member-ignore-case property org-special-properties)
15760 ;; We need a special property. Use `org-entry-properties' to
15761 ;; retrieve it, but specify the wanted property.
15762 (cdr (assoc-string property (org-entry-properties nil property))))
15764 (let ((range (org-get-property-block)))
15765 (when range
15766 (let* ((case-fold-search t)
15767 (end (cdr range))
15768 (props
15769 (let ((global
15770 (or (assoc-string property org-file-properties t)
15771 (assoc-string property org-global-properties t)
15772 (assoc-string
15773 property org-global-properties-fixed t))))
15774 ;; Make sure to not re-use GLOBAL as
15775 ;; `org--update-property-plist' would alter it by
15776 ;; side-effect.
15777 (and global (list (cons property (cdr global))))))
15778 (find-value
15779 (lambda (key)
15780 (when (re-search-forward (org-re-property key nil t) end t)
15781 (setq props
15782 (org--update-property-plist
15783 key (org-match-string-no-properties 3) props))))))
15784 (goto-char (car range))
15785 ;; Find base value.
15786 (save-excursion (funcall find-value property))
15787 ;; Find additional values.
15788 (let ((property+ (concat property "+")))
15789 (while (funcall find-value property+)))
15790 ;; Return final value.
15791 (let ((val (cdr (assoc-string property props t))))
15792 (if literal-nil val (org-not-nil val))))))))))
15794 (defun org-property-or-variable-value (var &optional inherit)
15795 "Check if there is a property fixing the value of VAR.
15796 If yes, return this value. If not, return the current value of the variable."
15797 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15798 (if (and prop (stringp prop) (string-match "\\S-" prop))
15799 (read prop)
15800 (symbol-value var))))
15802 (defun org-entry-delete (pom property)
15803 "Delete the property PROPERTY from entry at point-or-marker POM."
15804 (unless (member property org-special-properties)
15805 (org-with-point-at pom
15806 (let ((range (org-get-property-block)))
15807 (when range
15808 (let ((begin (car range))
15809 (end (copy-marker (cdr range))))
15810 (goto-char begin)
15811 (when (re-search-forward (org-re-property property nil t) end t)
15812 (delete-region (match-beginning 0) (line-beginning-position 2))
15813 ;; If drawer is empty, remove it altogether.
15814 (when (= begin end)
15815 (delete-region (line-beginning-position 0)
15816 (line-beginning-position 2)))
15817 (set-marker end nil))))))))
15819 ;; Multi-values properties are properties that contain multiple values
15820 ;; These values are assumed to be single words, separated by whitespace.
15821 (defun org-entry-add-to-multivalued-property (pom property value)
15822 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15823 (let* ((old (org-entry-get pom property))
15824 (values (and old (org-split-string old "[ \t]"))))
15825 (setq value (org-entry-protect-space value))
15826 (unless (member value values)
15827 (setq values (append values (list value)))
15828 (org-entry-put pom property
15829 (mapconcat 'identity values " ")))))
15831 (defun org-entry-remove-from-multivalued-property (pom property value)
15832 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15833 (let* ((old (org-entry-get pom property))
15834 (values (and old (org-split-string old "[ \t]"))))
15835 (setq value (org-entry-protect-space value))
15836 (when (member value values)
15837 (setq values (delete value values))
15838 (org-entry-put pom property
15839 (mapconcat 'identity values " ")))))
15841 (defun org-entry-member-in-multivalued-property (pom property value)
15842 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15843 (let* ((old (org-entry-get pom property))
15844 (values (and old (org-split-string old "[ \t]"))))
15845 (setq value (org-entry-protect-space value))
15846 (member value values)))
15848 (defun org-entry-get-multivalued-property (pom property)
15849 "Return a list of values in a multivalued property."
15850 (let* ((value (org-entry-get pom property))
15851 (values (and value (org-split-string value "[ \t]"))))
15852 (mapcar 'org-entry-restore-space values)))
15854 (defun org-entry-put-multivalued-property (pom property &rest values)
15855 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15856 VALUES should be a list of strings. Spaces will be protected."
15857 (org-entry-put pom property
15858 (mapconcat 'org-entry-protect-space values " "))
15859 (let* ((value (org-entry-get pom property))
15860 (values (and value (org-split-string value "[ \t]"))))
15861 (mapcar 'org-entry-restore-space values)))
15863 (defun org-entry-protect-space (s)
15864 "Protect spaces and newline in string S."
15865 (while (string-match " " s)
15866 (setq s (replace-match "%20" t t s)))
15867 (while (string-match "\n" s)
15868 (setq s (replace-match "%0A" t t s)))
15871 (defun org-entry-restore-space (s)
15872 "Restore spaces and newline in string S."
15873 (while (string-match "%20" s)
15874 (setq s (replace-match " " t t s)))
15875 (while (string-match "%0A" s)
15876 (setq s (replace-match "\n" t t s)))
15879 (defvar org-entry-property-inherited-from (make-marker)
15880 "Marker pointing to the entry from where a property was inherited.
15881 Each call to `org-entry-get-with-inheritance' will set this marker to the
15882 location of the entry where the inheritance search matched. If there was
15883 no match, the marker will point nowhere.
15884 Note that also `org-entry-get' calls this function, if the INHERIT flag
15885 is set.")
15887 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15888 "Get PROPERTY of entry or content at point, search higher levels if needed.
15889 The search will stop at the first ancestor which has the property defined.
15890 If the value found is \"nil\", return nil to show that the property
15891 should be considered as undefined (this is the meaning of nil here).
15892 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15893 (move-marker org-entry-property-inherited-from nil)
15894 (let (value)
15895 (org-with-wide-buffer
15896 (catch 'exit
15897 (while t
15898 (when (setq value (org-entry-get nil property nil literal-nil))
15899 (org-back-to-heading t)
15900 (move-marker org-entry-property-inherited-from (point))
15901 (throw 'exit nil))
15902 (or (org-up-heading-safe) (throw 'exit nil)))))
15903 (unless value
15904 (setq value
15905 (cdr (or (assoc-string property org-file-properties t)
15906 (assoc-string property org-global-properties t)
15907 (assoc-string property org-global-properties-fixed t)))))
15908 (if literal-nil value (org-not-nil value))))
15910 (defvar org-property-changed-functions nil
15911 "Hook called when the value of a property has changed.
15912 Each hook function should accept two arguments, the name of the property
15913 and the new value.")
15915 (defun org-entry-put (pom property value)
15916 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15918 If the value is `nil', it is converted to the empty string. If
15919 it is not a string, an error is raised.
15921 PROPERTY can be any regular property (see
15922 `org-special-properties'). It can also be \"TODO\",
15923 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
15925 For the last two properties, VALUE may have any of the special
15926 values \"earlier\" and \"later\". The function then increases or
15927 decreases scheduled or deadline date by one day."
15928 (cond ((null value) (setq value ""))
15929 ((not (stringp value)) (error "Properties values should be strings")))
15930 (org-with-point-at pom
15931 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
15932 (org-back-to-heading t)
15933 (org-with-limited-levels (org-back-to-heading t)))
15934 (let ((beg (point)))
15935 (cond
15936 ((equal property "TODO")
15937 (cond ((not (org-string-nw-p value)) (setq value 'none))
15938 ((not (member value org-todo-keywords-1))
15939 (user-error "\"%s\" is not a valid TODO state" value)))
15940 (org-todo value)
15941 (org-set-tags nil 'align))
15942 ((equal property "PRIORITY")
15943 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
15944 (org-set-tags nil 'align))
15945 ((equal property "SCHEDULED")
15946 (forward-line)
15947 (if (and (org-looking-at-p org-planning-line-re)
15948 (re-search-forward
15949 org-scheduled-time-regexp (line-end-position) t))
15950 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15951 ((string= value "later") (org-timestamp-change 1 'day))
15952 ((string= value "") (org-schedule '(4)))
15953 (t (org-schedule nil value)))
15954 (if (member value '("earlier" "later" ""))
15955 (call-interactively #'org-schedule)
15956 (org-schedule nil value))))
15957 ((equal property "DEADLINE")
15958 (forward-line)
15959 (if (and (org-looking-at-p org-planning-line-re)
15960 (re-search-forward
15961 org-deadline-time-regexp (line-end-position) t))
15962 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15963 ((string= value "later") (org-timestamp-change 1 'day))
15964 ((string= value "") (org-deadline '(4)))
15965 (t (org-deadline nil value)))
15966 (if (member value '("earlier" "later" ""))
15967 (call-interactively #'org-deadline)
15968 (org-deadline nil value))))
15969 ((member property org-special-properties)
15970 (error "The %s property cannot be set with `org-entry-put'" property))
15972 (let* ((range (org-get-property-block beg 'force))
15973 (end (cdr range))
15974 (case-fold-search t))
15975 (goto-char (car range))
15976 (if (re-search-forward (org-re-property property nil t) end t)
15977 (progn (delete-region (match-beginning 0) (match-end 0))
15978 (goto-char (match-beginning 0)))
15979 (goto-char end)
15980 (insert "\n")
15981 (backward-char))
15982 (insert ":" property ":")
15983 (when value (insert " " value))
15984 (org-indent-line)))))
15985 (run-hook-with-args 'org-property-changed-functions property value)))
15987 (defun org-buffer-property-keys (&optional specials defaults columns)
15988 "Get all property keys in the current buffer.
15990 When SPECIALS is non-nil, also list the special properties that
15991 reflect things like tags and TODO state.
15993 When DEFAULTS is non-nil, also include properties that has
15994 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
15995 DESCRIPTION, LOCATION, and LOGGING and others.
15997 When COLUMNS in non-nil, also include property names given in
15998 COLUMN formats in the current buffer."
15999 (let ((case-fold-search t)
16000 (props (append
16001 (and specials org-special-properties)
16002 (and defaults (cons org-effort-property org-default-properties))
16003 nil)))
16004 (org-with-wide-buffer
16005 (goto-char (point-min))
16006 (while (re-search-forward org-property-start-re nil t)
16007 (let ((range (org-get-property-block)))
16008 (catch 'skip
16009 (unless range
16010 (when (and (not (org-before-first-heading-p))
16011 (y-or-n-p (format "Malformed drawer at %d, repair?"
16012 (line-beginning-position))))
16013 (org-get-property-block nil t))
16014 (throw 'skip nil))
16015 (goto-char (car range))
16016 (let ((begin (car range))
16017 (end (cdr range)))
16018 ;; Make sure that found property block is not located
16019 ;; before current point, as it would generate an infloop.
16020 ;; It can happen, for example, in the following
16021 ;; situation:
16023 ;; * Headline
16024 ;; :PROPERTIES:
16025 ;; ...
16026 ;; :END:
16027 ;; *************** Inlinetask
16028 ;; #+BEGIN_EXAMPLE
16029 ;; :PROPERTIES:
16030 ;; #+END_EXAMPLE
16032 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16033 (while (< (point) end)
16034 (let ((p (progn (looking-at org-property-re)
16035 (org-match-string-no-properties 2))))
16036 ;; Only add true property name, not extension symbol.
16037 (add-to-list 'props
16038 (if (not (org-string-match-p "\\+\\'" p)) p
16039 (substring p 0 -1))))
16040 (forward-line))))
16041 (outline-next-heading)))
16042 (when columns
16043 (goto-char (point-min))
16044 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16045 (let ((element (org-element-at-point)))
16046 (when (memq (org-element-type element) '(keyword node-property))
16047 (let ((value (org-element-property :value element))
16048 (start 0))
16049 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16050 (setq start (match-end 0))
16051 (let ((p (org-match-string-no-properties 1 value)))
16052 (unless (member-ignore-case p org-special-properties)
16053 (add-to-list 'props p))))))))))
16054 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16056 (defun org-property-values (key)
16057 "List all non-nil values of property KEY in current buffer."
16058 (org-with-wide-buffer
16059 (goto-char (point-min))
16060 (let ((case-fold-search t)
16061 (re (org-re-property key))
16062 values)
16063 (while (re-search-forward re nil t)
16064 (add-to-list 'values (org-entry-get (point) key)))
16065 values)))
16067 (defun org-insert-property-drawer ()
16068 "Insert a property drawer into the current entry."
16069 (org-with-wide-buffer
16070 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16071 (org-back-to-heading t)
16072 (org-with-limited-levels (org-back-to-heading t)))
16073 (forward-line)
16074 (when (org-looking-at-p org-planning-line-re) (forward-line))
16075 (unless (org-looking-at-p org-property-drawer-re)
16076 (let ((inhibit-read-only t))
16077 (unless (bolp) (insert "\n"))
16078 (let ((begin (point)))
16079 (insert ":PROPERTIES:\n:END:\n")
16080 (org-indent-region begin (point)))))))
16082 (defun org-insert-drawer (&optional arg drawer)
16083 "Insert a drawer at point.
16085 When optional argument ARG is non-nil, insert a property drawer.
16087 Optional argument DRAWER, when non-nil, is a string representing
16088 drawer's name. Otherwise, the user is prompted for a name.
16090 If a region is active, insert the drawer around that region
16091 instead.
16093 Point is left between drawer's boundaries."
16094 (interactive "P")
16095 (let* ((drawer (if arg "PROPERTIES"
16096 (or drawer (read-from-minibuffer "Drawer: ")))))
16097 (cond
16098 ;; With C-u, fall back on `org-insert-property-drawer'
16099 (arg (org-insert-property-drawer))
16100 ;; Check validity of suggested drawer's name.
16101 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16102 (user-error "Invalid drawer name"))
16103 ;; With an active region, insert a drawer at point.
16104 ((not (org-region-active-p))
16105 (progn
16106 (unless (bolp) (insert "\n"))
16107 (insert (format ":%s:\n\n:END:\n" drawer))
16108 (forward-line -2)))
16109 ;; Otherwise, insert the drawer at point
16111 (let ((rbeg (region-beginning))
16112 (rend (copy-marker (region-end))))
16113 (unwind-protect
16114 (progn
16115 (goto-char rbeg)
16116 (beginning-of-line)
16117 (when (save-excursion
16118 (re-search-forward org-outline-regexp-bol rend t))
16119 (user-error "Drawers cannot contain headlines"))
16120 ;; Position point at the beginning of the first
16121 ;; non-blank line in region. Insert drawer's opening
16122 ;; there, then indent it.
16123 (org-skip-whitespace)
16124 (beginning-of-line)
16125 (insert ":" drawer ":\n")
16126 (forward-line -1)
16127 (indent-for-tab-command)
16128 ;; Move point to the beginning of the first blank line
16129 ;; after the last non-blank line in region. Insert
16130 ;; drawer's closing, then indent it.
16131 (goto-char rend)
16132 (skip-chars-backward " \r\t\n")
16133 (insert "\n:END:")
16134 (deactivate-mark t)
16135 (indent-for-tab-command)
16136 (unless (eolp) (insert "\n")))
16137 ;; Clear marker, whatever the outcome of insertion is.
16138 (set-marker rend nil)))))))
16140 (defvar org-property-set-functions-alist nil
16141 "Property set function alist.
16142 Each entry should have the following format:
16144 (PROPERTY . READ-FUNCTION)
16146 The read function will be called with the same argument as
16147 `org-completing-read'.")
16149 (defun org-set-property-function (property)
16150 "Get the function that should be used to set PROPERTY.
16151 This is computed according to `org-property-set-functions-alist'."
16152 (or (cdr (assoc property org-property-set-functions-alist))
16153 'org-completing-read))
16155 (defun org-read-property-value (property)
16156 "Read PROPERTY value from user."
16157 (let* ((completion-ignore-case t)
16158 (allowed (org-property-get-allowed-values nil property 'table))
16159 (cur (org-entry-get nil property))
16160 (prompt (concat property " value"
16161 (if (and cur (string-match "\\S-" cur))
16162 (concat " [" cur "]") "") ": "))
16163 (set-function (org-set-property-function property))
16164 (val (if allowed
16165 (funcall set-function prompt allowed nil
16166 (not (get-text-property 0 'org-unrestricted
16167 (caar allowed))))
16168 (let (org-completion-use-ido org-completion-use-iswitchb)
16169 (funcall set-function prompt
16170 (mapcar 'list (org-property-values property))
16171 nil nil "" nil cur)))))
16172 (org-trim val)))
16174 (defvar org-last-set-property nil)
16175 (defvar org-last-set-property-value nil)
16176 (defun org-read-property-name ()
16177 "Read a property name."
16178 (let* ((completion-ignore-case t)
16179 (keys (org-buffer-property-keys nil t t))
16180 (default-prop (or (save-excursion
16181 (save-match-data
16182 (beginning-of-line)
16183 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
16184 (null (string= (match-string 1) "END"))
16185 (match-string 1))))
16186 org-last-set-property))
16187 (property (org-icompleting-read
16188 (concat "Property"
16189 (if default-prop (concat " [" default-prop "]") "")
16190 ": ")
16191 (mapcar 'list keys)
16192 nil nil nil nil
16193 default-prop)))
16194 (if (member property keys)
16195 property
16196 (or (cdr (assoc (downcase property)
16197 (mapcar (lambda (x) (cons (downcase x) x))
16198 keys)))
16199 property))))
16201 (defun org-set-property-and-value (use-last)
16202 "Allow to set [PROPERTY]: [value] direction from prompt.
16203 When use-default, don't even ask, just use the last
16204 \"[PROPERTY]: [value]\" string from the history."
16205 (interactive "P")
16206 (let* ((completion-ignore-case t)
16207 (pv (or (and use-last org-last-set-property-value)
16208 (org-completing-read
16209 "Enter a \"[Property]: [value]\" pair: "
16210 nil nil nil nil nil
16211 org-last-set-property-value)))
16212 prop val)
16213 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16214 (setq prop (match-string 1 pv)
16215 val (match-string 2 pv))
16216 (org-set-property prop val))))
16218 (defun org-set-property (property value)
16219 "In the current entry, set PROPERTY to VALUE.
16220 When called interactively, this will prompt for a property name, offering
16221 completion on existing and default properties. And then it will prompt
16222 for a value, offering completion either on allowed values (via an inherited
16223 xxx_ALL property) or on existing values in other instances of this property
16224 in the current file."
16225 (interactive (list nil nil))
16226 (let* ((property (or property (org-read-property-name)))
16227 (value (or value (org-read-property-value property)))
16228 (fn (cdr (assoc property org-properties-postprocess-alist))))
16229 (setq org-last-set-property property)
16230 (setq org-last-set-property-value (concat property ": " value))
16231 ;; Possibly postprocess the inserted value:
16232 (when fn (setq value (funcall fn value)))
16233 (unless (equal (org-entry-get nil property) value)
16234 (org-entry-put nil property value))))
16236 (defun org-delete-property (property)
16237 "In the current entry, delete PROPERTY."
16238 (interactive
16239 (let* ((completion-ignore-case t)
16240 (cat (org-entry-get (point) "CATEGORY"))
16241 (props0 (org-entry-properties nil 'standard))
16242 (props (if cat props0
16243 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16244 (prop (if (< 1 (length props))
16245 (org-icompleting-read "Property: " props nil t)
16246 (caar props))))
16247 (list prop)))
16248 (if (not property)
16249 (message "No property to delete in this entry")
16250 (org-entry-delete nil property)
16251 (message "Property \"%s\" deleted" property)))
16253 (defun org-delete-property-globally (property)
16254 "Remove PROPERTY globally, from all entries."
16255 (interactive
16256 (let* ((completion-ignore-case t)
16257 (prop (org-icompleting-read
16258 "Globally remove property: "
16259 (mapcar 'list (org-buffer-property-keys)))))
16260 (list prop)))
16261 (save-excursion
16262 (save-restriction
16263 (widen)
16264 (goto-char (point-min))
16265 (let ((cnt 0))
16266 (while (re-search-forward
16267 (org-re-property property)
16268 nil t)
16269 (setq cnt (1+ cnt))
16270 (delete-region (match-beginning 0) (1+ (point-at-eol))))
16271 (message "Property \"%s\" removed from %d entries" property cnt)))))
16273 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16275 (defun org-compute-property-at-point ()
16276 "Compute the property at point.
16277 This looks for an enclosing column format, extracts the operator and
16278 then applies it to the property in the column format's scope."
16279 (interactive)
16280 (unless (org-at-property-p)
16281 (user-error "Not at a property"))
16282 (let ((prop (org-match-string-no-properties 2)))
16283 (org-columns-get-format-and-top-level)
16284 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16285 (user-error "No operator defined for property %s" prop))
16286 (org-columns-compute prop)))
16288 (defvar org-property-allowed-value-functions nil
16289 "Hook for functions supplying allowed values for a specific property.
16290 The functions must take a single argument, the name of the property, and
16291 return a flat list of allowed values. If \":ETC\" is one of
16292 the values, this means that these values are intended as defaults for
16293 completion, but that other values should be allowed too.
16294 The functions must return nil if they are not responsible for this
16295 property.")
16297 (defun org-property-get-allowed-values (pom property &optional table)
16298 "Get allowed values for the property PROPERTY.
16299 When TABLE is non-nil, return an alist that can directly be used for
16300 completion."
16301 (let (vals)
16302 (cond
16303 ((equal property "TODO")
16304 (setq vals (org-with-point-at pom
16305 (append org-todo-keywords-1 '("")))))
16306 ((equal property "PRIORITY")
16307 (let ((n org-lowest-priority))
16308 (while (>= n org-highest-priority)
16309 (push (char-to-string n) vals)
16310 (setq n (1- n)))))
16311 ((member property org-special-properties))
16312 ((setq vals (run-hook-with-args-until-success
16313 'org-property-allowed-value-functions property)))
16315 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16316 (when (and vals (string-match "\\S-" vals))
16317 (setq vals (car (read-from-string (concat "(" vals ")"))))
16318 (setq vals (mapcar (lambda (x)
16319 (cond ((stringp x) x)
16320 ((numberp x) (number-to-string x))
16321 ((symbolp x) (symbol-name x))
16322 (t "???")))
16323 vals)))))
16324 (when (member ":ETC" vals)
16325 (setq vals (remove ":ETC" vals))
16326 (org-add-props (car vals) '(org-unrestricted t)))
16327 (if table (mapcar 'list vals) vals)))
16329 (defun org-property-previous-allowed-value (&optional previous)
16330 "Switch to the next allowed value for this property."
16331 (interactive)
16332 (org-property-next-allowed-value t))
16334 (defun org-property-next-allowed-value (&optional previous)
16335 "Switch to the next allowed value for this property."
16336 (interactive)
16337 (unless (org-at-property-p)
16338 (user-error "Not at a property"))
16339 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16340 (key (match-string 2))
16341 (value (match-string 3))
16342 (allowed (or (org-property-get-allowed-values (point) key)
16343 (and (member value '("[ ]" "[-]" "[X]"))
16344 '("[ ]" "[X]"))))
16345 (heading (save-match-data (nth 4 (org-heading-components))))
16346 nval)
16347 (unless allowed
16348 (user-error "Allowed values for this property have not been defined"))
16349 (if previous (setq allowed (reverse allowed)))
16350 (if (member value allowed)
16351 (setq nval (car (cdr (member value allowed)))))
16352 (setq nval (or nval (car allowed)))
16353 (if (equal nval value)
16354 (user-error "Only one allowed value for this property"))
16355 (org-at-property-p)
16356 (replace-match (concat " :" key ": " nval) t t)
16357 (org-indent-line)
16358 (beginning-of-line 1)
16359 (skip-chars-forward " \t")
16360 (when (equal prop org-effort-property)
16361 (org-refresh-property
16362 '((effort . identity)
16363 (effort-minutes . org-duration-string-to-minutes))
16364 nval)
16365 (when (string= org-clock-current-task heading)
16366 (setq org-clock-effort nval)
16367 (org-clock-update-mode-line)))
16368 (run-hook-with-args 'org-property-changed-functions key nval)))
16370 (defun org-find-olp (path &optional this-buffer)
16371 "Return a marker pointing to the entry at outline path OLP.
16372 If anything goes wrong, throw an error.
16373 You can wrap this call to catch the error like this:
16375 (condition-case msg
16376 (org-mobile-locate-entry (match-string 4))
16377 (error (nth 1 msg)))
16379 The return value will then be either a string with the error message,
16380 or a marker if everything is OK.
16382 If THIS-BUFFER is set, the outline path does not contain a file,
16383 only headings."
16384 (let* ((file (if this-buffer buffer-file-name (pop path)))
16385 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16386 (level 1)
16387 (lmin 1)
16388 (lmax 1)
16389 limit re end found pos heading cnt flevel)
16390 (unless buffer (error "File not found :%s" file))
16391 (with-current-buffer buffer
16392 (save-excursion
16393 (save-restriction
16394 (widen)
16395 (setq limit (point-max))
16396 (goto-char (point-min))
16397 (while (setq heading (pop path))
16398 (setq re (format org-complex-heading-regexp-format
16399 (regexp-quote heading)))
16400 (setq cnt 0 pos (point))
16401 (while (re-search-forward re end t)
16402 (setq level (- (match-end 1) (match-beginning 1)))
16403 (if (and (>= level lmin) (<= level lmax))
16404 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16405 (when (= cnt 0) (error "Heading not found on level %d: %s"
16406 lmax heading))
16407 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16408 lmax heading))
16409 (goto-char found)
16410 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16411 (setq end (save-excursion (org-end-of-subtree t t))))
16412 (when (org-at-heading-p)
16413 (point-marker)))))))
16415 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16416 "Find node HEADING in BUFFER.
16417 Return a marker to the heading if it was found, or nil if not.
16418 If POS-ONLY is set, return just the position instead of a marker.
16420 The heading text must match exact, but it may have a TODO keyword,
16421 a priority cookie and tags in the standard locations."
16422 (with-current-buffer (or buffer (current-buffer))
16423 (save-excursion
16424 (save-restriction
16425 (widen)
16426 (goto-char (point-min))
16427 (let (case-fold-search)
16428 (if (re-search-forward
16429 (format org-complex-heading-regexp-format
16430 (regexp-quote heading)) nil t)
16431 (if pos-only
16432 (match-beginning 0)
16433 (move-marker (make-marker) (match-beginning 0)))))))))
16435 (defun org-find-exact-heading-in-directory (heading &optional dir)
16436 "Find Org node headline HEADING in all .org files in directory DIR.
16437 When the target headline is found, return a marker to this location."
16438 (let ((files (directory-files (or dir default-directory)
16439 t "\\`[^.#].*\\.org\\'"))
16440 file visiting m buffer)
16441 (catch 'found
16442 (while (setq file (pop files))
16443 (message "trying %s" file)
16444 (setq visiting (org-find-base-buffer-visiting file))
16445 (setq buffer (or visiting (find-file-noselect file)))
16446 (setq m (org-find-exact-headline-in-buffer
16447 heading buffer))
16448 (when (and (not m) (not visiting)) (kill-buffer buffer))
16449 (and m (throw 'found m))))))
16451 (defun org-find-entry-with-id (ident)
16452 "Locate the entry that contains the ID property with exact value IDENT.
16453 IDENT can be a string, a symbol or a number, this function will search for
16454 the string representation of it.
16455 Return the position where this entry starts, or nil if there is no such entry."
16456 (interactive "sID: ")
16457 (let ((id (cond
16458 ((stringp ident) ident)
16459 ((symbol-name ident) (symbol-name ident))
16460 ((numberp ident) (number-to-string ident))
16461 (t (error "IDENT %s must be a string, symbol or number" ident))))
16462 (case-fold-search nil))
16463 (save-excursion
16464 (save-restriction
16465 (widen)
16466 (goto-char (point-min))
16467 (when (re-search-forward
16468 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16469 nil t)
16470 (org-back-to-heading t)
16471 (point))))))
16473 ;;;; Timestamps
16475 (defvar org-last-changed-timestamp nil)
16476 (defvar org-last-inserted-timestamp nil
16477 "The last time stamp inserted with `org-insert-time-stamp'.")
16478 (defvar org-ts-what) ; dynamically scoped parameter
16480 (defun org-time-stamp (arg &optional inactive)
16481 "Prompt for a date/time and insert a time stamp.
16482 If the user specifies a time like HH:MM or if this command is
16483 called with at least one prefix argument, the time stamp contains
16484 the date and the time. Otherwise, only the date is be included.
16486 All parts of a date not specified by the user is filled in from
16487 the current date/time. So if you just press return without
16488 typing anything, the time stamp will represent the current
16489 date/time.
16491 If there is already a timestamp at the cursor, it will be
16492 modified.
16494 With two universal prefix arguments, insert an active timestamp
16495 with the current time without prompting the user.
16497 When called from lisp, the timestamp is inactive if INACTIVE is
16498 non-nil."
16499 (interactive "P")
16500 (let* ((ts nil)
16501 (default-time
16502 ;; Default time is either today, or, when entering a range,
16503 ;; the range start.
16504 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16505 (save-excursion
16506 (re-search-backward
16507 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16508 (- (point) 20) t)))
16509 (apply 'encode-time (org-parse-time-string (match-string 1)))
16510 (current-time)))
16511 (default-input (and ts (org-get-compact-tod ts)))
16512 (repeater (save-excursion
16513 (save-match-data
16514 (beginning-of-line)
16515 (when (re-search-forward
16516 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16517 (save-excursion (progn (end-of-line) (point))) t)
16518 (match-string 0)))))
16519 org-time-was-given org-end-time-was-given time)
16520 (cond
16521 ((and (org-at-timestamp-p t)
16522 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16523 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16524 (insert "--")
16525 (setq time (let ((this-command this-command))
16526 (org-read-date arg 'totime nil nil
16527 default-time default-input inactive)))
16528 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16529 ((org-at-timestamp-p t)
16530 (setq time (let ((this-command this-command))
16531 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16532 (when (org-at-timestamp-p t) ; just to get the match data
16533 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16534 (replace-match "")
16535 (setq org-last-changed-timestamp
16536 (org-insert-time-stamp
16537 time (or org-time-was-given arg)
16538 inactive nil nil (list org-end-time-was-given)))
16539 (when repeater (goto-char (1- (point))) (insert " " repeater)
16540 (setq org-last-changed-timestamp
16541 (concat (substring org-last-inserted-timestamp 0 -1)
16542 " " repeater ">"))))
16543 (message "Timestamp updated"))
16544 ((equal arg '(16))
16545 (org-insert-time-stamp (current-time) t inactive))
16547 (setq time (let ((this-command this-command))
16548 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16549 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16550 nil nil (list org-end-time-was-given))))))
16552 ;; FIXME: can we use this for something else, like computing time differences?
16553 (defun org-get-compact-tod (s)
16554 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16555 (let* ((t1 (match-string 1 s))
16556 (h1 (string-to-number (match-string 2 s)))
16557 (m1 (string-to-number (match-string 3 s)))
16558 (t2 (and (match-end 4) (match-string 5 s)))
16559 (h2 (and t2 (string-to-number (match-string 6 s))))
16560 (m2 (and t2 (string-to-number (match-string 7 s))))
16561 dh dm)
16562 (if (not t2)
16564 (setq dh (- h2 h1) dm (- m2 m1))
16565 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16566 (concat t1 "+" (number-to-string dh)
16567 (and (/= 0 dm) (format ":%02d" dm)))))))
16569 (defun org-time-stamp-inactive (&optional arg)
16570 "Insert an inactive time stamp.
16571 An inactive time stamp is enclosed in square brackets instead of angle
16572 brackets. It is inactive in the sense that it does not trigger agenda entries,
16573 does not link to the calendar and cannot be changed with the S-cursor keys.
16574 So these are more for recording a certain time/date."
16575 (interactive "P")
16576 (org-time-stamp arg 'inactive))
16578 (defvar org-date-ovl (make-overlay 1 1))
16579 (overlay-put org-date-ovl 'face 'org-date-selected)
16580 (org-detach-overlay org-date-ovl)
16582 (defvar org-ans1) ; dynamically scoped parameter
16583 (defvar org-ans2) ; dynamically scoped parameter
16585 (defvar org-plain-time-of-day-regexp) ; defined below
16587 (defvar org-overriding-default-time nil) ; dynamically scoped
16588 (defvar org-read-date-overlay nil)
16589 (defvar org-dcst nil) ; dynamically scoped
16590 (defvar org-read-date-history nil)
16591 (defvar org-read-date-final-answer nil)
16592 (defvar org-read-date-analyze-futurep nil)
16593 (defvar org-read-date-analyze-forced-year nil)
16594 (defvar org-read-date-inactive)
16596 (defvar org-read-date-minibuffer-local-map
16597 (let* ((map (make-sparse-keymap)))
16598 (set-keymap-parent map minibuffer-local-map)
16599 (org-defkey map (kbd ".")
16600 (lambda () (interactive)
16601 ;; Are we at the beginning of the prompt?
16602 (if (looking-back "^[^:]+: ")
16603 (org-eval-in-calendar '(calendar-goto-today))
16604 (insert "."))))
16605 (org-defkey map (kbd "C-.")
16606 (lambda () (interactive)
16607 (org-eval-in-calendar '(calendar-goto-today))))
16608 (org-defkey map [(meta shift left)]
16609 (lambda () (interactive)
16610 (org-eval-in-calendar '(calendar-backward-month 1))))
16611 (org-defkey map [(meta shift right)]
16612 (lambda () (interactive)
16613 (org-eval-in-calendar '(calendar-forward-month 1))))
16614 (org-defkey map [(meta shift up)]
16615 (lambda () (interactive)
16616 (org-eval-in-calendar '(calendar-backward-year 1))))
16617 (org-defkey map [(meta shift down)]
16618 (lambda () (interactive)
16619 (org-eval-in-calendar '(calendar-forward-year 1))))
16620 (org-defkey map [?\e (shift left)]
16621 (lambda () (interactive)
16622 (org-eval-in-calendar '(calendar-backward-month 1))))
16623 (org-defkey map [?\e (shift right)]
16624 (lambda () (interactive)
16625 (org-eval-in-calendar '(calendar-forward-month 1))))
16626 (org-defkey map [?\e (shift up)]
16627 (lambda () (interactive)
16628 (org-eval-in-calendar '(calendar-backward-year 1))))
16629 (org-defkey map [?\e (shift down)]
16630 (lambda () (interactive)
16631 (org-eval-in-calendar '(calendar-forward-year 1))))
16632 (org-defkey map [(shift up)]
16633 (lambda () (interactive)
16634 (org-eval-in-calendar '(calendar-backward-week 1))))
16635 (org-defkey map [(shift down)]
16636 (lambda () (interactive)
16637 (org-eval-in-calendar '(calendar-forward-week 1))))
16638 (org-defkey map [(shift left)]
16639 (lambda () (interactive)
16640 (org-eval-in-calendar '(calendar-backward-day 1))))
16641 (org-defkey map [(shift right)]
16642 (lambda () (interactive)
16643 (org-eval-in-calendar '(calendar-forward-day 1))))
16644 (org-defkey map "!"
16645 (lambda () (interactive)
16646 (org-eval-in-calendar '(diary-view-entries))
16647 (message "")))
16648 (org-defkey map ">"
16649 (lambda () (interactive)
16650 (org-eval-in-calendar '(calendar-scroll-left 1))))
16651 (org-defkey map "<"
16652 (lambda () (interactive)
16653 (org-eval-in-calendar '(calendar-scroll-right 1))))
16654 (org-defkey map "\C-v"
16655 (lambda () (interactive)
16656 (org-eval-in-calendar
16657 '(calendar-scroll-left-three-months 1))))
16658 (org-defkey map "\M-v"
16659 (lambda () (interactive)
16660 (org-eval-in-calendar
16661 '(calendar-scroll-right-three-months 1))))
16662 map)
16663 "Keymap for minibuffer commands when using `org-read-date'.")
16665 (defvar org-def)
16666 (defvar org-defdecode)
16667 (defvar org-with-time)
16669 (defun org-read-date (&optional org-with-time to-time from-string prompt
16670 default-time default-input inactive)
16671 "Read a date, possibly a time, and make things smooth for the user.
16672 The prompt will suggest to enter an ISO date, but you can also enter anything
16673 which will at least partially be understood by `parse-time-string'.
16674 Unrecognized parts of the date will default to the current day, month, year,
16675 hour and minute. If this command is called to replace a timestamp at point,
16676 or to enter the second timestamp of a range, the default time is taken
16677 from the existing stamp. Furthermore, the command prefers the future,
16678 so if you are giving a date where the year is not given, and the day-month
16679 combination is already past in the current year, it will assume you
16680 mean next year. For details, see the manual. A few examples:
16682 3-2-5 --> 2003-02-05
16683 feb 15 --> currentyear-02-15
16684 2/15 --> currentyear-02-15
16685 sep 12 9 --> 2009-09-12
16686 12:45 --> today 12:45
16687 22 sept 0:34 --> currentyear-09-22 0:34
16688 12 --> currentyear-currentmonth-12
16689 Fri --> nearest Friday after today
16690 -Tue --> last Tuesday
16691 etc.
16693 Furthermore you can specify a relative date by giving, as the *first* thing
16694 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16695 change in days weeks, months, years.
16696 With a single plus or minus, the date is relative to today. With a double
16697 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16698 +4d --> four days from today
16699 +4 --> same as above
16700 +2w --> two weeks from today
16701 ++5 --> five days from default date
16703 The function understands only English month and weekday abbreviations.
16705 While prompting, a calendar is popped up - you can also select the
16706 date with the mouse (button 1). The calendar shows a period of three
16707 months. To scroll it to other months, use the keys `>' and `<'.
16708 If you don't like the calendar, turn it off with
16709 \(setq org-read-date-popup-calendar nil)
16711 With optional argument TO-TIME, the date will immediately be converted
16712 to an internal time.
16713 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16714 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16715 still enter a time, and this function will inform the calling routine
16716 about this change. The calling routine may then choose to change the
16717 format used to insert the time stamp into the buffer to include the time.
16718 With optional argument FROM-STRING, read from this string instead from
16719 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16720 the time/date that is used for everything that is not specified by the
16721 user."
16722 (require 'parse-time)
16723 (let* ((org-time-stamp-rounding-minutes
16724 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16725 (org-dcst org-display-custom-times)
16726 (ct (org-current-time))
16727 (org-def (or org-overriding-default-time default-time ct))
16728 (org-defdecode (decode-time org-def))
16729 (dummy (progn
16730 (when (< (nth 2 org-defdecode) org-extend-today-until)
16731 (setcar (nthcdr 2 org-defdecode) -1)
16732 (setcar (nthcdr 1 org-defdecode) 59)
16733 (setq org-def (apply 'encode-time org-defdecode)
16734 org-defdecode (decode-time org-def)))))
16735 (mouse-autoselect-window nil) ; Don't let the mouse jump
16736 (calendar-frame-setup nil)
16737 (calendar-setup nil)
16738 (calendar-move-hook nil)
16739 (calendar-view-diary-initially-flag nil)
16740 (calendar-view-holidays-initially-flag nil)
16741 (timestr (format-time-string
16742 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16743 (prompt (concat (if prompt (concat prompt " ") "")
16744 (format "Date+time [%s]: " timestr)))
16745 ans (org-ans0 "") org-ans1 org-ans2 final)
16747 (cond
16748 (from-string (setq ans from-string))
16749 (org-read-date-popup-calendar
16750 (save-excursion
16751 (save-window-excursion
16752 (calendar)
16753 (org-eval-in-calendar '(setq cursor-type nil) t)
16754 (unwind-protect
16755 (progn
16756 (calendar-forward-day (- (time-to-days org-def)
16757 (calendar-absolute-from-gregorian
16758 (calendar-current-date))))
16759 (org-eval-in-calendar nil t)
16760 (let* ((old-map (current-local-map))
16761 (map (copy-keymap calendar-mode-map))
16762 (minibuffer-local-map
16763 (copy-keymap org-read-date-minibuffer-local-map)))
16764 (org-defkey map (kbd "RET") 'org-calendar-select)
16765 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16766 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16767 (unwind-protect
16768 (progn
16769 (use-local-map map)
16770 (setq org-read-date-inactive inactive)
16771 (add-hook 'post-command-hook 'org-read-date-display)
16772 (setq org-ans0 (read-string prompt default-input
16773 'org-read-date-history nil))
16774 ;; org-ans0: from prompt
16775 ;; org-ans1: from mouse click
16776 ;; org-ans2: from calendar motion
16777 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16778 (remove-hook 'post-command-hook 'org-read-date-display)
16779 (use-local-map old-map)
16780 (when org-read-date-overlay
16781 (delete-overlay org-read-date-overlay)
16782 (setq org-read-date-overlay nil)))))
16783 (bury-buffer "*Calendar*")))))
16785 (t ; Naked prompt only
16786 (unwind-protect
16787 (setq ans (read-string prompt default-input
16788 'org-read-date-history timestr))
16789 (when org-read-date-overlay
16790 (delete-overlay org-read-date-overlay)
16791 (setq org-read-date-overlay nil)))))
16793 (setq final (org-read-date-analyze ans org-def org-defdecode))
16795 (when org-read-date-analyze-forced-year
16796 (message "Year was forced into %s"
16797 (if org-read-date-force-compatible-dates
16798 "compatible range (1970-2037)"
16799 "range representable on this machine"))
16800 (ding))
16802 ;; One round trip to get rid of 34th of August and stuff like that....
16803 (setq final (decode-time (apply 'encode-time final)))
16805 (setq org-read-date-final-answer ans)
16807 (if to-time
16808 (apply 'encode-time final)
16809 (if (and (boundp 'org-time-was-given) org-time-was-given)
16810 (format "%04d-%02d-%02d %02d:%02d"
16811 (nth 5 final) (nth 4 final) (nth 3 final)
16812 (nth 2 final) (nth 1 final))
16813 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16815 (defun org-read-date-display ()
16816 "Display the current date prompt interpretation in the minibuffer."
16817 (when org-read-date-display-live
16818 (when org-read-date-overlay
16819 (delete-overlay org-read-date-overlay))
16820 (when (minibufferp (current-buffer))
16821 (save-excursion
16822 (end-of-line 1)
16823 (while (not (equal (buffer-substring
16824 (max (point-min) (- (point) 4)) (point))
16825 " "))
16826 (insert " ")))
16827 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16828 " " (or org-ans1 org-ans2)))
16829 (org-end-time-was-given nil)
16830 (f (org-read-date-analyze ans org-def org-defdecode))
16831 (fmts (if org-dcst
16832 org-time-stamp-custom-formats
16833 org-time-stamp-formats))
16834 (fmt (if (or org-with-time
16835 (and (boundp 'org-time-was-given) org-time-was-given))
16836 (cdr fmts)
16837 (car fmts)))
16838 (txt (format-time-string fmt (apply 'encode-time f)))
16839 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16840 (txt (concat "=> " txt)))
16841 (when (and org-end-time-was-given
16842 (string-match org-plain-time-of-day-regexp txt))
16843 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16844 org-end-time-was-given
16845 (substring txt (match-end 0)))))
16846 (when org-read-date-analyze-futurep
16847 (setq txt (concat txt " (=>F)")))
16848 (setq org-read-date-overlay
16849 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16850 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16852 (defun org-read-date-analyze (ans org-def org-defdecode)
16853 "Analyze the combined answer of the date prompt."
16854 ;; FIXME: cleanup and comment
16855 (let ((nowdecode (decode-time (current-time)))
16856 delta deltan deltaw deltadef year month day
16857 hour minute second wday pm h2 m2 tl wday1
16858 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16859 (setq org-read-date-analyze-futurep nil
16860 org-read-date-analyze-forced-year nil)
16861 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16862 (setq ans "+0"))
16864 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16865 (setq ans (replace-match "" t t ans)
16866 deltan (car delta)
16867 deltaw (nth 1 delta)
16868 deltadef (nth 2 delta)))
16870 ;; Check if there is an iso week date in there. If yes, store the
16871 ;; info and postpone interpreting it until the rest of the parsing
16872 ;; is done.
16873 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16874 (setq iso-year (if (match-end 1)
16875 (org-small-year-to-year
16876 (string-to-number (match-string 1 ans))))
16877 iso-weekday (if (match-end 3)
16878 (string-to-number (match-string 3 ans)))
16879 iso-week (string-to-number (match-string 2 ans)))
16880 (setq ans (replace-match "" t t ans)))
16882 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16883 (when (string-match
16884 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16885 (setq year (if (match-end 2)
16886 (string-to-number (match-string 2 ans))
16887 (progn (setq kill-year t)
16888 (string-to-number (format-time-string "%Y"))))
16889 month (string-to-number (match-string 3 ans))
16890 day (string-to-number (match-string 4 ans)))
16891 (if (< year 100) (setq year (+ 2000 year)))
16892 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16893 t nil ans)))
16895 ;; Help matching dotted european dates
16896 (when (string-match
16897 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16898 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16899 (setq kill-year t)
16900 (string-to-number (format-time-string "%Y")))
16901 day (string-to-number (match-string 1 ans))
16902 month (string-to-number (match-string 2 ans))
16903 ans (replace-match (format "%04d-%02d-%02d" year month day)
16904 t nil ans)))
16906 ;; Help matching american dates, like 5/30 or 5/30/7
16907 (when (string-match
16908 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16909 (setq year (if (match-end 4)
16910 (string-to-number (match-string 4 ans))
16911 (progn (setq kill-year t)
16912 (string-to-number (format-time-string "%Y"))))
16913 month (string-to-number (match-string 1 ans))
16914 day (string-to-number (match-string 2 ans)))
16915 (if (< year 100) (setq year (+ 2000 year)))
16916 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16917 t nil ans)))
16918 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16919 ;; If there is a time with am/pm, and *no* time without it, we convert
16920 ;; so that matching will be successful.
16921 (loop for i from 1 to 2 do ; twice, for end time as well
16922 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16923 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16924 (setq hour (string-to-number (match-string 1 ans))
16925 minute (if (match-end 3)
16926 (string-to-number (match-string 3 ans))
16928 pm (equal ?p
16929 (string-to-char (downcase (match-string 4 ans)))))
16930 (if (and (= hour 12) (not pm))
16931 (setq hour 0)
16932 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16933 (setq ans (replace-match (format "%02d:%02d" hour minute)
16934 t t ans))))
16936 ;; Check if a time range is given as a duration
16937 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16938 (setq hour (string-to-number (match-string 1 ans))
16939 h2 (+ hour (string-to-number (match-string 3 ans)))
16940 minute (string-to-number (match-string 2 ans))
16941 m2 (+ minute (if (match-end 5) (string-to-number
16942 (match-string 5 ans))0)))
16943 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16944 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16945 t t ans)))
16947 ;; Check if there is a time range
16948 (when (boundp 'org-end-time-was-given)
16949 (setq org-time-was-given nil)
16950 (when (and (string-match org-plain-time-of-day-regexp ans)
16951 (match-end 8))
16952 (setq org-end-time-was-given (match-string 8 ans))
16953 (setq ans (concat (substring ans 0 (match-beginning 7))
16954 (substring ans (match-end 7))))))
16956 (setq tl (parse-time-string ans)
16957 day (or (nth 3 tl) (nth 3 org-defdecode))
16958 month (or (nth 4 tl)
16959 (if (and org-read-date-prefer-future
16960 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16961 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16962 (nth 4 org-defdecode)))
16963 year (or (and (not kill-year) (nth 5 tl))
16964 (if (and org-read-date-prefer-future
16965 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16966 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16967 (nth 5 org-defdecode)))
16968 hour (or (nth 2 tl) (nth 2 org-defdecode))
16969 minute (or (nth 1 tl) (nth 1 org-defdecode))
16970 second (or (nth 0 tl) 0)
16971 wday (nth 6 tl))
16973 (when (and (eq org-read-date-prefer-future 'time)
16974 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16975 (equal day (nth 3 nowdecode))
16976 (equal month (nth 4 nowdecode))
16977 (equal year (nth 5 nowdecode))
16978 (nth 2 tl)
16979 (or (< (nth 2 tl) (nth 2 nowdecode))
16980 (and (= (nth 2 tl) (nth 2 nowdecode))
16981 (nth 1 tl)
16982 (< (nth 1 tl) (nth 1 nowdecode)))))
16983 (setq day (1+ day)
16984 futurep t))
16986 ;; Special date definitions below
16987 (cond
16988 (iso-week
16989 ;; There was an iso week
16990 (require 'cal-iso)
16991 (setq futurep nil)
16992 (setq year (or iso-year year)
16993 day (or iso-weekday wday 1)
16994 wday nil ; to make sure that the trigger below does not match
16995 iso-date (calendar-gregorian-from-absolute
16996 (calendar-absolute-from-iso
16997 (list iso-week day year))))
16998 ; FIXME: Should we also push ISO weeks into the future?
16999 ; (when (and org-read-date-prefer-future
17000 ; (not iso-year)
17001 ; (< (calendar-absolute-from-gregorian iso-date)
17002 ; (time-to-days (current-time))))
17003 ; (setq year (1+ year)
17004 ; iso-date (calendar-gregorian-from-absolute
17005 ; (calendar-absolute-from-iso
17006 ; (list iso-week day year)))))
17007 (setq month (car iso-date)
17008 year (nth 2 iso-date)
17009 day (nth 1 iso-date)))
17010 (deltan
17011 (setq futurep nil)
17012 (unless deltadef
17013 (let ((now (decode-time (current-time))))
17014 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17015 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17016 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17017 ((equal deltaw "m") (setq month (+ month deltan)))
17018 ((equal deltaw "y") (setq year (+ year deltan)))))
17019 ((and wday (not (nth 3 tl)))
17020 ;; Weekday was given, but no day, so pick that day in the week
17021 ;; on or after the derived date.
17022 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17023 (unless (equal wday wday1)
17024 (setq day (+ day (% (- wday wday1 -7) 7))))))
17025 (if (and (boundp 'org-time-was-given)
17026 (nth 2 tl))
17027 (setq org-time-was-given t))
17028 (if (< year 100) (setq year (+ 2000 year)))
17029 ;; Check of the date is representable
17030 (if org-read-date-force-compatible-dates
17031 (progn
17032 (if (< year 1970)
17033 (setq year 1970 org-read-date-analyze-forced-year t))
17034 (if (> year 2037)
17035 (setq year 2037 org-read-date-analyze-forced-year t)))
17036 (condition-case nil
17037 (ignore (encode-time second minute hour day month year))
17038 (error
17039 (setq year (nth 5 org-defdecode))
17040 (setq org-read-date-analyze-forced-year t))))
17041 (setq org-read-date-analyze-futurep futurep)
17042 (list second minute hour day month year)))
17044 (defvar parse-time-weekdays)
17045 (defun org-read-date-get-relative (s today default)
17046 "Check string S for special relative date string.
17047 TODAY and DEFAULT are internal times, for today and for a default.
17048 Return shift list (N what def-flag)
17049 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17050 N is the number of WHATs to shift.
17051 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17052 the DEFAULT date rather than TODAY."
17053 (require 'parse-time)
17054 (when (and
17055 (string-match
17056 (concat
17057 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17058 "\\([0-9]+\\)?"
17059 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17060 "\\([ \t]\\|$\\)") s)
17061 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17062 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17063 (string-to-char (substring (match-string 1 s) -1))
17064 ?+))
17065 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17066 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17067 (what (if (match-end 3) (match-string 3 s) "d"))
17068 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17069 (date (if rel default today))
17070 (wday (nth 6 (decode-time date)))
17071 delta)
17072 (if wday1
17073 (progn
17074 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17075 (if (= delta 0) (setq delta 7))
17076 (if (= dir ?-)
17077 (progn
17078 (setq delta (- delta 7))
17079 (if (= delta 0) (setq delta -7))))
17080 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17081 (list delta "d" rel))
17082 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17084 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17085 "Turn a user-specified date into the internal representation.
17086 The internal representation needed by the calendar is (month day year).
17087 This is a wrapper to handle the brain-dead convention in calendar that
17088 user function argument order change dependent on argument order."
17089 (if (boundp 'calendar-date-style)
17090 (cond
17091 ((eq calendar-date-style 'american)
17092 (list arg1 arg2 arg3))
17093 ((eq calendar-date-style 'european)
17094 (list arg2 arg1 arg3))
17095 ((eq calendar-date-style 'iso)
17096 (list arg2 arg3 arg1)))
17097 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17098 (if (org-bound-and-true-p european-calendar-style)
17099 (list arg2 arg1 arg3)
17100 (list arg1 arg2 arg3)))))
17102 (defun org-eval-in-calendar (form &optional keepdate)
17103 "Eval FORM in the calendar window and return to current window.
17104 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17105 otherwise stick to the current value of `org-ans2'."
17106 (let ((sf (selected-frame))
17107 (sw (selected-window)))
17108 (select-window (get-buffer-window "*Calendar*" t))
17109 (eval form)
17110 (when (and (not keepdate) (calendar-cursor-to-date))
17111 (let* ((date (calendar-cursor-to-date))
17112 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17113 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17114 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17115 (select-window sw)
17116 (org-select-frame-set-input-focus sf)))
17118 (defun org-calendar-select ()
17119 "Return to `org-read-date' with the date currently selected.
17120 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17121 (interactive)
17122 (when (calendar-cursor-to-date)
17123 (let* ((date (calendar-cursor-to-date))
17124 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17125 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17126 (if (active-minibuffer-window) (exit-minibuffer))))
17128 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17129 "Insert a date stamp for the date given by the internal TIME.
17130 WITH-HM means use the stamp format that includes the time of the day.
17131 INACTIVE means use square brackets instead of angular ones, so that the
17132 stamp will not contribute to the agenda.
17133 PRE and POST are optional strings to be inserted before and after the
17134 stamp.
17135 The command returns the inserted time stamp."
17136 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17137 stamp)
17138 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17139 (insert-before-markers (or pre ""))
17140 (when (listp extra)
17141 (setq extra (car extra))
17142 (if (and (stringp extra)
17143 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17144 (setq extra (format "-%02d:%02d"
17145 (string-to-number (match-string 1 extra))
17146 (string-to-number (match-string 2 extra))))
17147 (setq extra nil)))
17148 (when extra
17149 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17150 (insert-before-markers (setq stamp (format-time-string fmt time)))
17151 (insert-before-markers (or post ""))
17152 (setq org-last-inserted-timestamp stamp)))
17154 (defun org-toggle-time-stamp-overlays ()
17155 "Toggle the use of custom time stamp formats."
17156 (interactive)
17157 (setq org-display-custom-times (not org-display-custom-times))
17158 (unless org-display-custom-times
17159 (let ((p (point-min)) (bmp (buffer-modified-p)))
17160 (while (setq p (next-single-property-change p 'display))
17161 (if (and (get-text-property p 'display)
17162 (eq (get-text-property p 'face) 'org-date))
17163 (remove-text-properties
17164 p (setq p (next-single-property-change p 'display))
17165 '(display t))))
17166 (set-buffer-modified-p bmp)))
17167 (if (featurep 'xemacs)
17168 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17169 (org-restart-font-lock)
17170 (setq org-table-may-need-update t)
17171 (if org-display-custom-times
17172 (message "Time stamps are overlaid with custom format")
17173 (message "Time stamp overlays removed")))
17175 (defun org-display-custom-time (beg end)
17176 "Overlay modified time stamp format over timestamp between BEG and END."
17177 (let* ((ts (buffer-substring beg end))
17178 t1 w1 with-hm tf time str w2 (off 0))
17179 (save-match-data
17180 (setq t1 (org-parse-time-string ts t))
17181 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17182 (setq off (- (match-end 0) (match-beginning 0)))))
17183 (setq end (- end off))
17184 (setq w1 (- end beg)
17185 with-hm (and (nth 1 t1) (nth 2 t1))
17186 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17187 time (org-fix-decoded-time t1)
17188 str (org-add-props
17189 (format-time-string
17190 (substring tf 1 -1) (apply 'encode-time time))
17191 nil 'mouse-face 'highlight)
17192 w2 (length str))
17193 (if (not (= w2 w1))
17194 (add-text-properties (1+ beg) (+ 2 beg)
17195 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17196 (if (featurep 'xemacs)
17197 (progn
17198 (put-text-property beg end 'invisible t)
17199 (put-text-property beg end 'end-glyph (make-glyph str)))
17200 (put-text-property beg end 'display str))))
17202 (defun org-fix-decoded-time (time)
17203 "Set 0 instead of nil for the first 6 elements of time.
17204 Don't touch the rest."
17205 (let ((n 0))
17206 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17208 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17210 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17211 "Difference between TIMESTAMP-STRING and now in days.
17212 If SECONDS is non-nil, return the difference in seconds."
17213 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17214 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17215 (funcall fdiff (current-time)))))
17217 (defun org-deadline-close (timestamp-string &optional ndays)
17218 "Is the time in TIMESTAMP-STRING close to the current date?"
17219 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17220 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17221 (not (org-entry-is-done-p))))
17223 (defun org-get-wdays (ts &optional delay zero-delay)
17224 "Get the deadline lead time appropriate for timestring TS.
17225 When DELAY is non-nil, get the delay time for scheduled items
17226 instead of the deadline lead time. When ZERO-DELAY is non-nil
17227 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17228 don't try to find the delay cookie in the scheduled timestamp."
17229 (let ((tv (if delay org-scheduled-delay-days
17230 org-deadline-warning-days)))
17231 (cond
17232 ((or (and delay (< tv 0))
17233 (and delay zero-delay (<= tv 0))
17234 (and (not delay) (<= tv 0)))
17235 ;; Enforce this value no matter what
17236 (- tv))
17237 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17238 ;; lead time is specified.
17239 (floor (* (string-to-number (match-string 1 ts))
17240 (cdr (assoc (match-string 2 ts)
17241 '(("d" . 1) ("w" . 7)
17242 ("m" . 30.4) ("y" . 365.25)
17243 ("h" . 0.041667)))))))
17244 ;; go for the default.
17245 (t tv))))
17247 (defun org-calendar-select-mouse (ev)
17248 "Return to `org-read-date' with the date currently selected.
17249 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17250 (interactive "e")
17251 (mouse-set-point ev)
17252 (when (calendar-cursor-to-date)
17253 (let* ((date (calendar-cursor-to-date))
17254 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17255 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17256 (if (active-minibuffer-window) (exit-minibuffer))))
17258 (defun org-check-deadlines (ndays)
17259 "Check if there are any deadlines due or past due.
17260 A deadline is considered due if it happens within `org-deadline-warning-days'
17261 days from today's date. If the deadline appears in an entry marked DONE,
17262 it is not shown. The prefix arg NDAYS can be used to test that many
17263 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17264 (interactive "P")
17265 (let* ((org-warn-days
17266 (cond
17267 ((equal ndays '(4)) 100000)
17268 (ndays (prefix-numeric-value ndays))
17269 (t (abs org-deadline-warning-days))))
17270 (case-fold-search nil)
17271 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17272 (callback
17273 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17275 (message "%d deadlines past-due or due within %d days"
17276 (org-occur regexp nil callback)
17277 org-warn-days)))
17279 (defsubst org-re-timestamp (type)
17280 "Return a regexp for timestamp TYPE.
17281 Allowed values for TYPE are:
17283 all: all timestamps
17284 active: only active timestamps (<...>)
17285 inactive: only inactive timestamps ([...])
17286 scheduled: only scheduled timestamps
17287 deadline: only deadline timestamps
17288 closed: only closed time-stamps
17290 When TYPE is nil, fall back on returning a regexp that matches
17291 both scheduled and deadline timestamps."
17292 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
17293 ((eq type 'active) org-ts-regexp)
17294 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
17295 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
17296 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17297 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
17298 ((eq type 'scheduled-or-deadline)
17299 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
17301 (defun org-check-before-date (date)
17302 "Check if there are deadlines or scheduled entries before DATE."
17303 (interactive (list (org-read-date)))
17304 (let ((case-fold-search nil)
17305 (regexp (org-re-timestamp org-ts-type))
17306 (callback
17307 (lambda () (time-less-p
17308 (org-time-string-to-time (match-string 1))
17309 (org-time-string-to-time date)))))
17310 (message "%d entries before %s"
17311 (org-occur regexp nil callback) date)))
17313 (defun org-check-after-date (date)
17314 "Check if there are deadlines or scheduled entries after DATE."
17315 (interactive (list (org-read-date)))
17316 (let ((case-fold-search nil)
17317 (regexp (org-re-timestamp org-ts-type))
17318 (callback
17319 (lambda () (not
17320 (time-less-p
17321 (org-time-string-to-time (match-string 1))
17322 (org-time-string-to-time date))))))
17323 (message "%d entries after %s"
17324 (org-occur regexp nil callback) date)))
17326 (defun org-check-dates-range (start-date end-date)
17327 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17328 (interactive (list (org-read-date nil nil nil "Range starts")
17329 (org-read-date nil nil nil "Range end")))
17330 (let ((case-fold-search nil)
17331 (regexp (org-re-timestamp org-ts-type))
17332 (callback
17333 (lambda ()
17334 (let ((match (match-string 1)))
17335 (and
17336 (not (time-less-p
17337 (org-time-string-to-time match)
17338 (org-time-string-to-time start-date)))
17339 (time-less-p
17340 (org-time-string-to-time match)
17341 (org-time-string-to-time end-date)))))))
17342 (message "%d entries between %s and %s"
17343 (org-occur regexp nil callback) start-date end-date)))
17345 (defun org-evaluate-time-range (&optional to-buffer)
17346 "Evaluate a time range by computing the difference between start and end.
17347 Normally the result is just printed in the echo area, but with prefix arg
17348 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17349 If the time range is actually in a table, the result is inserted into the
17350 next column.
17351 For time difference computation, a year is assumed to be exactly 365
17352 days in order to avoid rounding problems."
17353 (interactive "P")
17355 (org-clock-update-time-maybe)
17356 (save-excursion
17357 (unless (org-at-date-range-p t)
17358 (goto-char (point-at-bol))
17359 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17360 (if (not (org-at-date-range-p t))
17361 (user-error "Not at a time-stamp range, and none found in current line")))
17362 (let* ((ts1 (match-string 1))
17363 (ts2 (match-string 2))
17364 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17365 (match-end (match-end 0))
17366 (time1 (org-time-string-to-time ts1))
17367 (time2 (org-time-string-to-time ts2))
17368 (t1 (org-float-time time1))
17369 (t2 (org-float-time time2))
17370 (diff (abs (- t2 t1)))
17371 (negative (< (- t2 t1) 0))
17372 ;; (ys (floor (* 365 24 60 60)))
17373 (ds (* 24 60 60))
17374 (hs (* 60 60))
17375 (fy "%dy %dd %02d:%02d")
17376 (fy1 "%dy %dd")
17377 (fd "%dd %02d:%02d")
17378 (fd1 "%dd")
17379 (fh "%02d:%02d")
17380 y d h m align)
17381 (if havetime
17382 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17384 d (floor (/ diff ds)) diff (mod diff ds)
17385 h (floor (/ diff hs)) diff (mod diff hs)
17386 m (floor (/ diff 60)))
17387 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17389 d (floor (+ (/ diff ds) 0.5))
17390 h 0 m 0))
17391 (if (not to-buffer)
17392 (message "%s" (org-make-tdiff-string y d h m))
17393 (if (org-at-table-p)
17394 (progn
17395 (goto-char match-end)
17396 (setq align t)
17397 (and (looking-at " *|") (goto-char (match-end 0))))
17398 (goto-char match-end))
17399 (if (looking-at
17400 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17401 (replace-match ""))
17402 (if negative (insert " -"))
17403 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17404 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17405 (insert " " (format fh h m))))
17406 (if align (org-table-align))
17407 (message "Time difference inserted")))))
17409 (defun org-make-tdiff-string (y d h m)
17410 (let ((fmt "")
17411 (l nil))
17412 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17413 l (push y l)))
17414 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17415 l (push d l)))
17416 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17417 l (push h l)))
17418 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17419 l (push m l)))
17420 (apply 'format fmt (nreverse l))))
17422 (defun org-time-string-to-time (s &optional buffer pos)
17423 "Convert a timestamp string into internal time."
17424 (condition-case errdata
17425 (apply 'encode-time (org-parse-time-string s))
17426 (error (error "Bad timestamp `%s'%s\nError was: %s"
17427 s (if (not (and buffer pos))
17429 (format " at %d in buffer `%s'" pos buffer))
17430 (cdr errdata)))))
17432 (defun org-time-string-to-seconds (s)
17433 "Convert a timestamp string to a number of seconds."
17434 (org-float-time (org-time-string-to-time s)))
17436 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17437 "Convert a time stamp to an absolute day number.
17438 If there is a specifier for a cyclic time stamp, get the closest
17439 date to DAYNR.
17440 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17441 The variable `date' is bound by the calendar when this is called."
17442 (cond
17443 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17444 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17445 daynr
17446 (+ daynr 1000)))
17447 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17448 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17449 (time-to-days (current-time))) (match-string 0 s)
17450 prefer show-all))
17451 (t (time-to-days
17452 (condition-case errdata
17453 (apply 'encode-time (org-parse-time-string s))
17454 (error (error "Bad timestamp `%s'%s\nError was: %s"
17455 s (if (not (and buffer pos))
17457 (format " at %d in buffer `%s'" pos buffer))
17458 (cdr errdata))))))))
17460 (defun org-days-to-iso-week (days)
17461 "Return the iso week number."
17462 (require 'cal-iso)
17463 (car (calendar-iso-from-absolute days)))
17465 (defun org-small-year-to-year (year)
17466 "Convert 2-digit years into 4-digit years.
17467 YEAR is expanded into one of the 30 next years, if possible, or
17468 into a past one. Any year larger than 99 is returned unchanged."
17469 (if (>= year 100) year
17470 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17471 (century (/ current 100))
17472 (offset (- year (% current 100))))
17473 (cond ((> offset 30) (+ (* (1- century) 100) year))
17474 ((> offset -70) (+ (* century 100) year))
17475 (t (+ (* (1+ century) 100) year))))))
17477 (defun org-time-from-absolute (d)
17478 "Return the time corresponding to date D.
17479 D may be an absolute day number, or a calendar-type list (month day year)."
17480 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17481 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17483 (defun org-calendar-holiday ()
17484 "List of holidays, for Diary display in Org-mode."
17485 (require 'holidays)
17486 (let ((hl (funcall
17487 (if (fboundp 'calendar-check-holidays)
17488 'calendar-check-holidays 'check-calendar-holidays) date)))
17489 (if hl (mapconcat 'identity hl "; "))))
17491 (defun org-diary-sexp-entry (sexp entry date)
17492 "Process a SEXP diary ENTRY for DATE."
17493 (require 'diary-lib)
17494 (let ((result (if calendar-debug-sexp
17495 (let ((stack-trace-on-error t))
17496 (eval (car (read-from-string sexp))))
17497 (condition-case nil
17498 (eval (car (read-from-string sexp)))
17499 (error
17500 (beep)
17501 (message "Bad sexp at line %d in %s: %s"
17502 (org-current-line)
17503 (buffer-file-name) sexp)
17504 (sleep-for 2))))))
17505 (cond ((stringp result) (split-string result "; "))
17506 ((and (consp result)
17507 (not (consp (cdr result)))
17508 (stringp (cdr result))) (cdr result))
17509 ((and (consp result)
17510 (stringp (car result))) result)
17511 (result entry))))
17513 (defun org-diary-to-ical-string (frombuf)
17514 "Get iCalendar entries from diary entries in buffer FROMBUF.
17515 This uses the icalendar.el library."
17516 (let* ((tmpdir (if (featurep 'xemacs)
17517 (temp-directory)
17518 temporary-file-directory))
17519 (tmpfile (make-temp-name
17520 (expand-file-name "orgics" tmpdir)))
17521 buf rtn b e)
17522 (with-current-buffer frombuf
17523 (icalendar-export-region (point-min) (point-max) tmpfile)
17524 (setq buf (find-buffer-visiting tmpfile))
17525 (set-buffer buf)
17526 (goto-char (point-min))
17527 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17528 (setq b (match-beginning 0)))
17529 (goto-char (point-max))
17530 (if (re-search-backward "^END:VEVENT" nil t)
17531 (setq e (match-end 0)))
17532 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17533 (kill-buffer buf)
17534 (delete-file tmpfile)
17535 rtn))
17537 (defun org-closest-date (start current change prefer show-all)
17538 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17539 When PREFER is `past', return a date that is either CURRENT or past.
17540 When PREFER is `future', return a date that is either CURRENT or future.
17541 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17542 ;; Make the proper lists from the dates
17543 (catch 'exit
17544 (let ((a1 '(("h" . hour)
17545 ("d" . day)
17546 ("w" . week)
17547 ("m" . month)
17548 ("y" . year)))
17549 (shour (nth 2 (org-parse-time-string start)))
17550 dn dw sday cday n1 n2 n0
17551 d m y y1 y2 date1 date2 nmonths nm ny m2)
17553 (setq start (org-date-to-gregorian start)
17554 current (org-date-to-gregorian
17555 (if show-all
17556 current
17557 (time-to-days (current-time))))
17558 sday (calendar-absolute-from-gregorian start)
17559 cday (calendar-absolute-from-gregorian current))
17561 (if (<= cday sday) (throw 'exit sday))
17563 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17564 (setq dn (string-to-number (match-string 1 change))
17565 dw (cdr (assoc (match-string 2 change) a1)))
17566 (user-error "Invalid change specifier: %s" change))
17567 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17568 (cond
17569 ((eq dw 'hour)
17570 (let ((missing-hours
17571 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17572 dn)))
17573 (setq n1 (if (zerop missing-hours) cday
17574 (- cday (1+ (floor (/ missing-hours 24)))))
17575 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17576 ((eq dw 'day)
17577 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17578 n2 (+ n1 dn)))
17579 ((eq dw 'year)
17580 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17581 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17582 (setq date1 (list m d y1)
17583 n1 (calendar-absolute-from-gregorian date1)
17584 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17585 n2 (calendar-absolute-from-gregorian date2)))
17586 ((eq dw 'month)
17587 ;; approx number of month between the two dates
17588 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17589 ;; How often does dn fit in there?
17590 (setq d (nth 1 start) m (car start) y (nth 2 start)
17591 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17592 m (+ m nm)
17593 ny (floor (/ m 12))
17594 y (+ y ny)
17595 m (- m (* ny 12)))
17596 (while (> m 12) (setq m (- m 12) y (1+ y)))
17597 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17598 (setq m2 (+ m dn) y2 y)
17599 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17600 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17601 (while (<= n2 cday)
17602 (setq n1 n2 m m2 y y2)
17603 (setq m2 (+ m dn) y2 y)
17604 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17605 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17606 ;; Make sure n1 is the earlier date
17607 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17608 (if show-all
17609 (cond
17610 ((eq prefer 'past) (if (= cday n2) n2 n1))
17611 ((eq prefer 'future) (if (= cday n1) n1 n2))
17612 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17613 (cond
17614 ((eq prefer 'past) (if (= cday n2) n2 n1))
17615 ((eq prefer 'future) (if (= cday n1) n1 n2))
17616 (t (if (= cday n1) n1 n2)))))))
17618 (defun org-date-to-gregorian (date)
17619 "Turn any specification of DATE into a Gregorian date for the calendar."
17620 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17621 ((and (listp date) (= (length date) 3)) date)
17622 ((stringp date)
17623 (setq date (org-parse-time-string date))
17624 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17625 ((listp date)
17626 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17628 (defun org-parse-time-string (s &optional nodefault)
17629 "Parse the standard Org-mode time string.
17630 This should be a lot faster than the normal `parse-time-string'.
17631 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17632 hour and minute fields will be nil if not given."
17633 (cond ((string-match org-ts-regexp0 s)
17634 (list 0
17635 (if (or (match-beginning 8) (not nodefault))
17636 (string-to-number (or (match-string 8 s) "0")))
17637 (if (or (match-beginning 7) (not nodefault))
17638 (string-to-number (or (match-string 7 s) "0")))
17639 (string-to-number (match-string 4 s))
17640 (string-to-number (match-string 3 s))
17641 (string-to-number (match-string 2 s))
17642 nil nil nil))
17643 ((string-match "^<[^>]+>$" s)
17644 (decode-time (seconds-to-time (org-matcher-time s))))
17645 (t (error "Not a standard Org-mode time string: %s" s))))
17647 (defun org-timestamp-up (&optional arg)
17648 "Increase the date item at the cursor by one.
17649 If the cursor is on the year, change the year. If it is on the month,
17650 the day or the time, change that.
17651 With prefix ARG, change by that many units."
17652 (interactive "p")
17653 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17655 (defun org-timestamp-down (&optional arg)
17656 "Decrease the date item at the cursor by one.
17657 If the cursor is on the year, change the year. If it is on the month,
17658 the day or the time, change that.
17659 With prefix ARG, change by that many units."
17660 (interactive "p")
17661 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17663 (defun org-timestamp-up-day (&optional arg)
17664 "Increase the date in the time stamp by one day.
17665 With prefix ARG, change that many days."
17666 (interactive "p")
17667 (if (and (not (org-at-timestamp-p t))
17668 (org-at-heading-p))
17669 (org-todo 'up)
17670 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17672 (defun org-timestamp-down-day (&optional arg)
17673 "Decrease the date in the time stamp by one day.
17674 With prefix ARG, change that many days."
17675 (interactive "p")
17676 (if (and (not (org-at-timestamp-p t))
17677 (org-at-heading-p))
17678 (org-todo 'down)
17679 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17681 (defun org-at-timestamp-p (&optional inactive-ok)
17682 "Determine if the cursor is in or at a timestamp."
17683 (interactive)
17684 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17685 (pos (point))
17686 (ans (or (looking-at tsr)
17687 (save-excursion
17688 (skip-chars-backward "^[<\n\r\t")
17689 (if (> (point) (point-min)) (backward-char 1))
17690 (and (looking-at tsr)
17691 (> (- (match-end 0) pos) -1))))))
17692 (and ans
17693 (boundp 'org-ts-what)
17694 (setq org-ts-what
17695 (cond
17696 ((= pos (match-beginning 0)) 'bracket)
17697 ;; Point is considered to be "on the bracket" whether
17698 ;; it's really on it or right after it.
17699 ((= pos (1- (match-end 0))) 'bracket)
17700 ((= pos (match-end 0)) 'after)
17701 ((org-pos-in-match-range pos 2) 'year)
17702 ((org-pos-in-match-range pos 3) 'month)
17703 ((org-pos-in-match-range pos 7) 'hour)
17704 ((org-pos-in-match-range pos 8) 'minute)
17705 ((or (org-pos-in-match-range pos 4)
17706 (org-pos-in-match-range pos 5)) 'day)
17707 ((and (> pos (or (match-end 8) (match-end 5)))
17708 (< pos (match-end 0)))
17709 (- pos (or (match-end 8) (match-end 5))))
17710 (t 'day))))
17711 ans))
17713 (defun org-toggle-timestamp-type ()
17714 "Toggle the type (<active> or [inactive]) of a time stamp."
17715 (interactive)
17716 (when (org-at-timestamp-p t)
17717 (let ((beg (match-beginning 0)) (end (match-end 0))
17718 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17719 (save-excursion
17720 (goto-char beg)
17721 (while (re-search-forward "[][<>]" end t)
17722 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17723 t t)))
17724 (message "Timestamp is now %sactive"
17725 (if (equal (char-after beg) ?<) "" "in")))))
17727 (defun org-at-clock-log-p nil
17728 "Is the cursor on the clock log line?"
17729 (save-excursion
17730 (move-beginning-of-line 1)
17731 (looking-at org-clock-line-re)))
17733 (defvar org-clock-history) ; defined in org-clock.el
17734 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17735 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17736 "Change the date in the time stamp at point.
17737 The date will be changed by N times WHAT. WHAT can be `day', `month',
17738 `year', `minute', `second'. If WHAT is not given, the cursor position
17739 in the timestamp determines what will be changed.
17740 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17741 (let ((origin (point)) origin-cat
17742 with-hm inactive
17743 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17744 org-ts-what
17745 extra rem
17746 ts time time0 fixnext clrgx)
17747 (if (not (org-at-timestamp-p t))
17748 (user-error "Not at a timestamp"))
17749 (if (and (not what) (eq org-ts-what 'bracket))
17750 (org-toggle-timestamp-type)
17751 ;; Point isn't on brackets. Remember the part of the time-stamp
17752 ;; the point was in. Indeed, size of time-stamps may change,
17753 ;; but point must be kept in the same category nonetheless.
17754 (setq origin-cat org-ts-what)
17755 (if (and (not what) (not (eq org-ts-what 'day))
17756 org-display-custom-times
17757 (get-text-property (point) 'display)
17758 (not (get-text-property (1- (point)) 'display)))
17759 (setq org-ts-what 'day))
17760 (setq org-ts-what (or what org-ts-what)
17761 inactive (= (char-after (match-beginning 0)) ?\[)
17762 ts (match-string 0))
17763 (replace-match "")
17764 (when (string-match
17765 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17767 (setq extra (match-string 1 ts))
17768 (if suppress-tmp-delay
17769 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17770 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17771 (setq with-hm t))
17772 (setq time0 (org-parse-time-string ts))
17773 (when (and updown
17774 (eq org-ts-what 'minute)
17775 (not current-prefix-arg))
17776 ;; This looks like s-up and s-down. Change by one rounding step.
17777 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17778 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17779 (setcar (cdr time0) (+ (nth 1 time0)
17780 (if (> n 0) (- rem) (- dm rem))))))
17781 (setq time
17782 (encode-time (or (car time0) 0)
17783 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17784 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17785 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17786 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17787 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17788 (nthcdr 6 time0)))
17789 (when (and (member org-ts-what '(hour minute))
17790 extra
17791 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17792 (setq extra (org-modify-ts-extra
17793 extra
17794 (if (eq org-ts-what 'hour) 2 5)
17795 n dm)))
17796 (when (integerp org-ts-what)
17797 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17798 (if (eq what 'calendar)
17799 (let ((cal-date (org-get-date-from-calendar)))
17800 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17801 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17802 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17803 (setcar time0 (or (car time0) 0))
17804 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17805 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17806 (setq time (apply 'encode-time time0))))
17807 ;; Insert the new time-stamp, and ensure point stays in the same
17808 ;; category as before (i.e. not after the last position in that
17809 ;; category).
17810 (let ((pos (point)))
17811 ;; Stay before inserted string. `save-excursion' is of no use.
17812 (setq org-last-changed-timestamp
17813 (org-insert-time-stamp time with-hm inactive nil nil extra))
17814 (goto-char pos))
17815 (save-match-data
17816 (looking-at org-ts-regexp3)
17817 (goto-char (cond
17818 ;; `day' category ends before `hour' if any, or at
17819 ;; the end of the day name.
17820 ((eq origin-cat 'day)
17821 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17822 ((eq origin-cat 'hour) (min (match-end 7) origin))
17823 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17824 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17825 ;; `year' and `month' have both fixed size: point
17826 ;; couldn't have moved into another part.
17827 (t origin))))
17828 ;; Update clock if on a CLOCK line.
17829 (org-clock-update-time-maybe)
17830 ;; Maybe adjust the closest clock in `org-clock-history'
17831 (when org-clock-adjust-closest
17832 (if (not (and (org-at-clock-log-p)
17833 (< 1 (length (delq nil (mapcar 'marker-position
17834 org-clock-history))))))
17835 (message "No clock to adjust")
17836 (cond ((save-excursion ; fix previous clock?
17837 (re-search-backward org-ts-regexp0 nil t)
17838 (org-looking-back (concat org-clock-string " \\[")))
17839 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17840 ((save-excursion ; fix next clock?
17841 (re-search-backward org-ts-regexp0 nil t)
17842 (looking-at (concat org-ts-regexp0 "\\] =>")))
17843 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17844 (save-window-excursion
17845 ;; Find closest clock to point, adjust the previous/next one in history
17846 (let* ((p (save-excursion (org-back-to-heading t)))
17847 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17848 (clfixnth
17849 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17850 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17851 (if (not clfixpos)
17852 (message "No clock to adjust")
17853 (save-excursion
17854 (org-goto-marker-or-bmk clfixpos)
17855 (org-show-subtree)
17856 (when (re-search-forward clrgx nil t)
17857 (goto-char (match-beginning 1))
17858 (let (org-clock-adjust-closest)
17859 (org-timestamp-change n org-ts-what updown))
17860 (message "Clock adjusted in %s for heading: %s"
17861 (file-name-nondirectory (buffer-file-name))
17862 (org-get-heading t t)))))))))
17863 ;; Try to recenter the calendar window, if any.
17864 (if (and org-calendar-follow-timestamp-change
17865 (get-buffer-window "*Calendar*" t)
17866 (memq org-ts-what '(day month year)))
17867 (org-recenter-calendar (time-to-days time))))))
17869 (defun org-modify-ts-extra (s pos n dm)
17870 "Change the different parts of the lead-time and repeat fields in timestamp."
17871 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17872 ng h m new rem)
17873 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17874 (cond
17875 ((or (org-pos-in-match-range pos 2)
17876 (org-pos-in-match-range pos 3))
17877 (setq m (string-to-number (match-string 3 s))
17878 h (string-to-number (match-string 2 s)))
17879 (if (org-pos-in-match-range pos 2)
17880 (setq h (+ h n))
17881 (setq n (* dm (org-no-warnings (signum n))))
17882 (when (not (= 0 (setq rem (% m dm))))
17883 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17884 (setq m (+ m n)))
17885 (if (< m 0) (setq m (+ m 60) h (1- h)))
17886 (if (> m 59) (setq m (- m 60) h (1+ h)))
17887 (setq h (min 24 (max 0 h)))
17888 (setq ng 1 new (format "-%02d:%02d" h m)))
17889 ((org-pos-in-match-range pos 6)
17890 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17891 ((org-pos-in-match-range pos 5)
17892 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17894 ((org-pos-in-match-range pos 9)
17895 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17896 ((org-pos-in-match-range pos 8)
17897 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17899 (when ng
17900 (setq s (concat
17901 (substring s 0 (match-beginning ng))
17903 (substring s (match-end ng))))))
17906 (defun org-recenter-calendar (date)
17907 "If the calendar is visible, recenter it to DATE."
17908 (let ((cwin (get-buffer-window "*Calendar*" t)))
17909 (when cwin
17910 (let ((calendar-move-hook nil))
17911 (with-selected-window cwin
17912 (calendar-goto-date (if (listp date) date
17913 (calendar-gregorian-from-absolute date))))))))
17915 (defun org-goto-calendar (&optional arg)
17916 "Go to the Emacs calendar at the current date.
17917 If there is a time stamp in the current line, go to that date.
17918 A prefix ARG can be used to force the current date."
17919 (interactive "P")
17920 (let ((tsr org-ts-regexp) diff
17921 (calendar-move-hook nil)
17922 (calendar-view-holidays-initially-flag nil)
17923 (calendar-view-diary-initially-flag nil))
17924 (if (or (org-at-timestamp-p)
17925 (save-excursion
17926 (beginning-of-line 1)
17927 (looking-at (concat ".*" tsr))))
17928 (let ((d1 (time-to-days (current-time)))
17929 (d2 (time-to-days
17930 (org-time-string-to-time (match-string 1)))))
17931 (setq diff (- d2 d1))))
17932 (calendar)
17933 (calendar-goto-today)
17934 (if (and diff (not arg)) (calendar-forward-day diff))))
17936 (defun org-get-date-from-calendar ()
17937 "Return a list (month day year) of date at point in calendar."
17938 (with-current-buffer "*Calendar*"
17939 (save-match-data
17940 (calendar-cursor-to-date))))
17942 (defun org-date-from-calendar ()
17943 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17944 If there is already a time stamp at the cursor position, update it."
17945 (interactive)
17946 (if (org-at-timestamp-p t)
17947 (org-timestamp-change 0 'calendar)
17948 (let ((cal-date (org-get-date-from-calendar)))
17949 (org-insert-time-stamp
17950 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17952 (defcustom org-effort-durations
17953 `(("min" . 1)
17954 ("h" . 60)
17955 ("d" . ,(* 60 8))
17956 ("w" . ,(* 60 8 5))
17957 ("m" . ,(* 60 8 5 4))
17958 ("y" . ,(* 60 8 5 40)))
17959 "Conversion factor to minutes for an effort modifier.
17961 Each entry has the form (MODIFIER . MINUTES).
17963 In an effort string, a number followed by MODIFIER is multiplied
17964 by the specified number of MINUTES to obtain an effort in
17965 minutes.
17967 For example, if the value of this variable is ((\"hours\" . 60)), then an
17968 effort string \"2hours\" is equivalent to 120 minutes."
17969 :group 'org-agenda
17970 :version "25.1"
17971 :package-version '(Org . "8.3")
17972 :type '(alist :key-type (string :tag "Modifier")
17973 :value-type (number :tag "Minutes")))
17975 (defun org-minutes-to-clocksum-string (m)
17976 "Format number of minutes as a clocksum string.
17977 The format is determined by `org-time-clocksum-format',
17978 `org-time-clocksum-use-fractional' and
17979 `org-time-clocksum-fractional-format' and
17980 `org-time-clocksum-use-effort-durations'."
17981 (let ((clocksum "")
17982 (m (round m)) ; Don't allow fractions of minutes
17983 h d w mo y fmt n)
17984 (setq h (if org-time-clocksum-use-effort-durations
17985 (cdr (assoc "h" org-effort-durations)) 60)
17986 d (if org-time-clocksum-use-effort-durations
17987 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17988 w (if org-time-clocksum-use-effort-durations
17989 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17990 mo (if org-time-clocksum-use-effort-durations
17991 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17992 y (if org-time-clocksum-use-effort-durations
17993 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17994 ;; fractional format
17995 (if org-time-clocksum-use-fractional
17996 (cond
17997 ;; single format string
17998 ((stringp org-time-clocksum-fractional-format)
17999 (format org-time-clocksum-fractional-format (/ m (float h))))
18000 ;; choice of fractional formats for different time units
18001 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18002 (> (/ (truncate m) (* y d h)) 0))
18003 (format fmt (/ m (* y d (float h)))))
18004 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18005 (> (/ (truncate m) (* mo d h)) 0))
18006 (format fmt (/ m (* mo d (float h)))))
18007 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18008 (> (/ (truncate m) (* w d h)) 0))
18009 (format fmt (/ m (* w d (float h)))))
18010 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18011 (> (/ (truncate m) (* d h)) 0))
18012 (format fmt (/ m (* d (float h)))))
18013 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18014 (> (/ (truncate m) h) 0))
18015 (format fmt (/ m (float h))))
18016 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18017 (format fmt m))
18018 ;; fall back to smallest time unit with a format
18019 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18020 (format fmt (/ m (float h))))
18021 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18022 (format fmt (/ m (* d (float h)))))
18023 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18024 (format fmt (/ m (* w d (float h)))))
18025 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18026 (format fmt (/ m (* mo d (float h)))))
18027 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18028 (format fmt (/ m (* y d (float h))))))
18029 ;; standard (non-fractional) format, with single format string
18030 (if (stringp org-time-clocksum-format)
18031 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18032 ;; separate formats components
18033 (and (setq fmt (plist-get org-time-clocksum-format :years))
18034 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18035 (plist-get org-time-clocksum-format :require-years))
18036 (setq clocksum (concat clocksum (format fmt n))
18037 m (- m (* n y d h))))
18038 (and (setq fmt (plist-get org-time-clocksum-format :months))
18039 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18040 (plist-get org-time-clocksum-format :require-months))
18041 (setq clocksum (concat clocksum (format fmt n))
18042 m (- m (* n mo d h))))
18043 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18044 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18045 (plist-get org-time-clocksum-format :require-weeks))
18046 (setq clocksum (concat clocksum (format fmt n))
18047 m (- m (* n w d h))))
18048 (and (setq fmt (plist-get org-time-clocksum-format :days))
18049 (or (> (setq n (/ (truncate m) (* d h))) 0)
18050 (plist-get org-time-clocksum-format :require-days))
18051 (setq clocksum (concat clocksum (format fmt n))
18052 m (- m (* n d h))))
18053 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18054 (or (> (setq n (/ (truncate m) h)) 0)
18055 (plist-get org-time-clocksum-format :require-hours))
18056 (setq clocksum (concat clocksum (format fmt n))
18057 m (- m (* n h))))
18058 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18059 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18060 (setq clocksum (concat clocksum (format fmt m))))
18061 ;; return formatted time duration
18062 clocksum))))
18064 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18065 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18066 "Org mode version 8.0")
18068 (defun org-hours-to-clocksum-string (n)
18069 (org-minutes-to-clocksum-string (* n 60)))
18071 (defun org-hh:mm-string-to-minutes (s)
18072 "Convert a string H:MM to a number of minutes.
18073 If the string is just a number, interpret it as minutes.
18074 In fact, the first hh:mm or number in the string will be taken,
18075 there can be extra stuff in the string.
18076 If no number is found, the return value is 0."
18077 (cond
18078 ((integerp s) s)
18079 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18080 (+ (* (string-to-number (match-string 1 s)) 60)
18081 (string-to-number (match-string 2 s))))
18082 ((string-match "\\([0-9]+\\)" s)
18083 (string-to-number (match-string 1 s)))
18084 (t 0)))
18086 (defcustom org-image-actual-width t
18087 "Should we use the actual width of images when inlining them?
18089 When set to `t', always use the image width.
18091 When set to a number, use imagemagick (when available) to set
18092 the image's width to this value.
18094 When set to a number in a list, try to get the width from any
18095 #+ATTR.* keyword if it matches a width specification like
18097 #+ATTR_HTML: :width 300px
18099 and fall back on that number if none is found.
18101 When set to nil, try to get the width from an #+ATTR.* keyword
18102 and fall back on the original width if none is found.
18104 This requires Emacs >= 24.1, build with imagemagick support."
18105 :group 'org-appearance
18106 :version "24.4"
18107 :package-version '(Org . "8.0")
18108 :type '(choice
18109 (const :tag "Use the image width" t)
18110 (integer :tag "Use a number of pixels")
18111 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18112 (const :tag "Use #+ATTR* or don't resize" nil)))
18114 (defcustom org-agenda-inhibit-startup nil
18115 "Inhibit startup when preparing agenda buffers.
18116 When this variable is `t', the initialization of the Org agenda
18117 buffers is inhibited: e.g. the visibility state is not set, the
18118 tables are not re-aligned, etc."
18119 :type 'boolean
18120 :version "24.3"
18121 :group 'org-agenda)
18123 (define-obsolete-variable-alias
18124 'org-agenda-ignore-drawer-properties
18125 'org-agenda-ignore-properties "25.1")
18127 (defcustom org-agenda-ignore-properties nil
18128 "Avoid updating text properties when building the agenda.
18129 Properties are used to prepare buffers for effort estimates,
18130 appointments, statistics and subtree-local categories.
18131 If you don't use these in the agenda, you can add them to this
18132 list and agenda building will be a bit faster.
18133 The value is a list, with zero or more of the symbols `effort', `appt',
18134 `stats' or `category'."
18135 :type '(set :greedy t
18136 (const effort)
18137 (const appt)
18138 (const stats)
18139 (const category))
18140 :version "25.1"
18141 :package-version '(Org . "8.3")
18142 :group 'org-agenda)
18144 (defun org-duration-string-to-minutes (s &optional output-to-string)
18145 "Convert a duration string S to minutes.
18147 A bare number is interpreted as minutes, modifiers can be set by
18148 customizing `org-effort-durations' (which see).
18150 Entries containing a colon are interpreted as H:MM by
18151 `org-hh:mm-string-to-minutes'."
18152 (let ((result 0)
18153 (re (concat "\\([0-9.]+\\) *\\("
18154 (regexp-opt (mapcar 'car org-effort-durations))
18155 "\\)")))
18156 (while (string-match re s)
18157 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18158 (string-to-number (match-string 1 s))))
18159 (setq s (replace-match "" nil t s)))
18160 (setq result (floor result))
18161 (incf result (org-hh:mm-string-to-minutes s))
18162 (if output-to-string (number-to-string result) result)))
18164 ;;;; Files
18166 (defun org-save-all-org-buffers ()
18167 "Save all Org-mode buffers without user confirmation."
18168 (interactive)
18169 (message "Saving all Org-mode buffers...")
18170 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18171 (when (featurep 'org-id) (org-id-locations-save))
18172 (message "Saving all Org-mode buffers... done"))
18174 (defun org-revert-all-org-buffers ()
18175 "Revert all Org-mode buffers.
18176 Prompt for confirmation when there are unsaved changes.
18177 Be sure you know what you are doing before letting this function
18178 overwrite your changes.
18180 This function is useful in a setup where one tracks org files
18181 with a version control system, to revert on one machine after pulling
18182 changes from another. I believe the procedure must be like this:
18184 1. M-x org-save-all-org-buffers
18185 2. Pull changes from the other machine, resolve conflicts
18186 3. M-x org-revert-all-org-buffers"
18187 (interactive)
18188 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18189 (user-error "Abort"))
18190 (save-excursion
18191 (save-window-excursion
18192 (mapc
18193 (lambda (b)
18194 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18195 (with-current-buffer b buffer-file-name))
18196 (org-pop-to-buffer-same-window b)
18197 (revert-buffer t 'no-confirm)))
18198 (buffer-list))
18199 (when (and (featurep 'org-id) org-id-track-globally)
18200 (org-id-locations-load)))))
18202 ;;;; Agenda files
18204 ;;;###autoload
18205 (defun org-switchb (&optional arg)
18206 "Switch between Org buffers.
18207 With one prefix argument, restrict available buffers to files.
18208 With two prefix arguments, restrict available buffers to agenda files.
18210 Defaults to `iswitchb' for buffer name completion.
18211 Set `org-completion-use-ido' to make it use ido instead."
18212 (interactive "P")
18213 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18214 ((equal arg '(16)) (org-buffer-list 'agenda))
18215 (t (org-buffer-list))))
18216 (org-completion-use-iswitchb org-completion-use-iswitchb)
18217 (org-completion-use-ido org-completion-use-ido))
18218 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18219 (setq org-completion-use-iswitchb t))
18220 (org-pop-to-buffer-same-window
18221 (org-icompleting-read "Org buffer: "
18222 (mapcar 'list (mapcar 'buffer-name blist))
18223 nil t))))
18225 ;;; Define some older names previously used for this functionality
18226 ;;;###autoload
18227 (defalias 'org-ido-switchb 'org-switchb)
18228 ;;;###autoload
18229 (defalias 'org-iswitchb 'org-switchb)
18231 (defun org-buffer-list (&optional predicate exclude-tmp)
18232 "Return a list of Org buffers.
18233 PREDICATE can be `export', `files' or `agenda'.
18235 export restrict the list to Export buffers.
18236 files restrict the list to buffers visiting Org files.
18237 agenda restrict the list to buffers visiting agenda files.
18239 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18240 (let* ((bfn nil)
18241 (agenda-files (and (eq predicate 'agenda)
18242 (mapcar 'file-truename (org-agenda-files t))))
18243 (filter
18244 (cond
18245 ((eq predicate 'files)
18246 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18247 ((eq predicate 'export)
18248 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18249 ((eq predicate 'agenda)
18250 (lambda (b)
18251 (with-current-buffer b
18252 (and (derived-mode-p 'org-mode)
18253 (setq bfn (buffer-file-name b))
18254 (member (file-truename bfn) agenda-files)))))
18255 (t (lambda (b) (with-current-buffer b
18256 (or (derived-mode-p 'org-mode)
18257 (string-match "\*Org .*Export"
18258 (buffer-name b)))))))))
18259 (delq nil
18260 (mapcar
18261 (lambda(b)
18262 (if (and (funcall filter b)
18263 (or (not exclude-tmp)
18264 (not (string-match "tmp" (buffer-name b)))))
18266 nil))
18267 (buffer-list)))))
18269 (defun org-agenda-files (&optional unrestricted archives)
18270 "Get the list of agenda files.
18271 Optional UNRESTRICTED means return the full list even if a restriction
18272 is currently in place.
18273 When ARCHIVES is t, include all archive files that are really being
18274 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18275 `org-agenda-archives-mode' is t."
18276 (let ((files
18277 (cond
18278 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18279 ((stringp org-agenda-files) (org-read-agenda-file-list))
18280 ((listp org-agenda-files) org-agenda-files)
18281 (t (error "Invalid value of `org-agenda-files'")))))
18282 (setq files (apply 'append
18283 (mapcar (lambda (f)
18284 (if (file-directory-p f)
18285 (directory-files
18286 f t org-agenda-file-regexp)
18287 (list f)))
18288 files)))
18289 (when org-agenda-skip-unavailable-files
18290 (setq files (delq nil
18291 (mapcar (function
18292 (lambda (file)
18293 (and (file-readable-p file) file)))
18294 files))))
18295 (when (or (eq archives t)
18296 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18297 (setq files (org-add-archive-files files)))
18298 files))
18300 (defun org-agenda-file-p (&optional file)
18301 "Return non-nil, if FILE is an agenda file.
18302 If FILE is omitted, use the file associated with the current
18303 buffer."
18304 (let ((fname (or file (buffer-file-name))))
18305 (and fname
18306 (member (file-truename fname)
18307 (mapcar #'file-truename (org-agenda-files t))))))
18309 (defun org-edit-agenda-file-list ()
18310 "Edit the list of agenda files.
18311 Depending on setup, this either uses customize to edit the variable
18312 `org-agenda-files', or it visits the file that is holding the list. In the
18313 latter case, the buffer is set up in a way that saving it automatically kills
18314 the buffer and restores the previous window configuration."
18315 (interactive)
18316 (if (stringp org-agenda-files)
18317 (let ((cw (current-window-configuration)))
18318 (find-file org-agenda-files)
18319 (org-set-local 'org-window-configuration cw)
18320 (org-add-hook 'after-save-hook
18321 (lambda ()
18322 (set-window-configuration
18323 (prog1 org-window-configuration
18324 (kill-buffer (current-buffer))))
18325 (org-install-agenda-files-menu)
18326 (message "New agenda file list installed"))
18327 nil 'local)
18328 (message "%s" (substitute-command-keys
18329 "Edit list and finish with \\[save-buffer]")))
18330 (customize-variable 'org-agenda-files)))
18332 (defun org-store-new-agenda-file-list (list)
18333 "Set new value for the agenda file list and save it correctly."
18334 (if (stringp org-agenda-files)
18335 (let ((fe (org-read-agenda-file-list t)) b u)
18336 (while (setq b (find-buffer-visiting org-agenda-files))
18337 (kill-buffer b))
18338 (with-temp-file org-agenda-files
18339 (insert
18340 (mapconcat
18341 (lambda (f) ;; Keep un-expanded entries.
18342 (if (setq u (assoc f fe))
18343 (cdr u)
18345 list "\n")
18346 "\n")))
18347 (let ((org-mode-hook nil) (org-inhibit-startup t)
18348 (org-insert-mode-line-in-empty-file nil))
18349 (setq org-agenda-files list)
18350 (customize-save-variable 'org-agenda-files org-agenda-files))))
18352 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18353 "Read the list of agenda files from a file.
18354 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18355 filenames, used by `org-store-new-agenda-file-list' to write back
18356 un-expanded file names."
18357 (when (file-directory-p org-agenda-files)
18358 (error "`org-agenda-files' cannot be a single directory"))
18359 (when (stringp org-agenda-files)
18360 (with-temp-buffer
18361 (insert-file-contents org-agenda-files)
18362 (mapcar
18363 (lambda (f)
18364 (let ((e (expand-file-name (substitute-in-file-name f)
18365 org-directory)))
18366 (if pair-with-expansion
18367 (cons e f)
18368 e)))
18369 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18371 ;;;###autoload
18372 (defun org-cycle-agenda-files ()
18373 "Cycle through the files in `org-agenda-files'.
18374 If the current buffer visits an agenda file, find the next one in the list.
18375 If the current buffer does not, find the first agenda file."
18376 (interactive)
18377 (let* ((fs (org-agenda-files t))
18378 (files (append fs (list (car fs))))
18379 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18380 file)
18381 (unless files (user-error "No agenda files"))
18382 (catch 'exit
18383 (while (setq file (pop files))
18384 (if (equal (file-truename file) tcf)
18385 (when (car files)
18386 (find-file (car files))
18387 (throw 'exit t))))
18388 (find-file (car fs)))
18389 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18391 (defun org-agenda-file-to-front (&optional to-end)
18392 "Move/add the current file to the top of the agenda file list.
18393 If the file is not present in the list, it is added to the front. If it is
18394 present, it is moved there. With optional argument TO-END, add/move to the
18395 end of the list."
18396 (interactive "P")
18397 (let ((org-agenda-skip-unavailable-files nil)
18398 (file-alist (mapcar (lambda (x)
18399 (cons (file-truename x) x))
18400 (org-agenda-files t)))
18401 (ctf (file-truename
18402 (or buffer-file-name
18403 (user-error "Please save the current buffer to a file"))))
18404 x had)
18405 (setq x (assoc ctf file-alist) had x)
18407 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18408 (if to-end
18409 (setq file-alist (append (delq x file-alist) (list x)))
18410 (setq file-alist (cons x (delq x file-alist))))
18411 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18412 (org-install-agenda-files-menu)
18413 (message "File %s to %s of agenda file list"
18414 (if had "moved" "added") (if to-end "end" "front"))))
18416 (defun org-remove-file (&optional file)
18417 "Remove current file from the list of files in variable `org-agenda-files'.
18418 These are the files which are being checked for agenda entries.
18419 Optional argument FILE means use this file instead of the current."
18420 (interactive)
18421 (let* ((org-agenda-skip-unavailable-files nil)
18422 (file (or file buffer-file-name
18423 (user-error "Current buffer does not visit a file")))
18424 (true-file (file-truename file))
18425 (afile (abbreviate-file-name file))
18426 (files (delq nil (mapcar
18427 (lambda (x)
18428 (if (equal true-file
18429 (file-truename x))
18430 nil x))
18431 (org-agenda-files t)))))
18432 (if (not (= (length files) (length (org-agenda-files t))))
18433 (progn
18434 (org-store-new-agenda-file-list files)
18435 (org-install-agenda-files-menu)
18436 (message "Removed from Org Agenda list: %s" afile))
18437 (message "File was not in list: %s (not removed)" afile))))
18439 (defun org-file-menu-entry (file)
18440 (vector file (list 'find-file file) t))
18442 (defun org-check-agenda-file (file)
18443 "Make sure FILE exists. If not, ask user what to do."
18444 (when (not (file-exists-p file))
18445 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18446 (abbreviate-file-name file))
18447 (let ((r (downcase (read-char-exclusive))))
18448 (cond
18449 ((equal r ?r)
18450 (org-remove-file file)
18451 (throw 'nextfile t))
18452 (t (user-error "Abort"))))))
18454 (defun org-get-agenda-file-buffer (file)
18455 "Get an agenda buffer visiting FILE.
18456 If the buffer needs to be created, add it to the list of buffers
18457 which might be released later."
18458 (let ((buf (org-find-base-buffer-visiting file)))
18459 (if buf
18460 buf ; just return it
18461 ;; Make a new buffer and remember it
18462 (setq buf (find-file-noselect file))
18463 (if buf (push buf org-agenda-new-buffers))
18464 buf)))
18466 (defun org-release-buffers (blist)
18467 "Release all buffers in list, asking the user for confirmation when needed.
18468 When a buffer is unmodified, it is just killed. When modified, it is saved
18469 \(if the user agrees) and then killed."
18470 (let (buf file)
18471 (while (setq buf (pop blist))
18472 (setq file (buffer-file-name buf))
18473 (when (and (buffer-modified-p buf)
18474 file
18475 (y-or-n-p (format "Save file %s? " file)))
18476 (with-current-buffer buf (save-buffer)))
18477 (kill-buffer buf))))
18479 (defun org-agenda-prepare-buffers (files)
18480 "Create buffers for all agenda files, protect archived trees and comments."
18481 (interactive)
18482 (let ((pa '(:org-archived t))
18483 (pc '(:org-comment t))
18484 (pall '(:org-archived t :org-comment t))
18485 (inhibit-read-only t)
18486 (org-inhibit-startup org-agenda-inhibit-startup)
18487 (rea (concat ":" org-archive-tag ":"))
18488 file re pos)
18489 (setq org-tag-alist-for-agenda nil
18490 org-tag-groups-alist-for-agenda nil)
18491 (save-excursion
18492 (save-restriction
18493 (while (setq file (pop files))
18494 (catch 'nextfile
18495 (if (bufferp file)
18496 (set-buffer file)
18497 (org-check-agenda-file file)
18498 (set-buffer (org-get-agenda-file-buffer file)))
18499 (widen)
18500 (org-set-regexps-and-options 'tags-only)
18501 (setq pos (point))
18502 (or (memq 'category org-agenda-ignore-properties)
18503 (org-refresh-category-properties))
18504 (or (memq 'stats org-agenda-ignore-properties)
18505 (org-refresh-stats-properties))
18506 (or (memq 'effort org-agenda-ignore-properties)
18507 (org-refresh-effort-properties))
18508 (or (memq 'appt org-agenda-ignore-properties)
18509 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18510 (setq org-todo-keywords-for-agenda
18511 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18512 (setq org-done-keywords-for-agenda
18513 (append org-done-keywords-for-agenda org-done-keywords))
18514 (setq org-todo-keyword-alist-for-agenda
18515 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18516 (setq org-tag-alist-for-agenda
18517 (org-uniquify
18518 (append org-tag-alist-for-agenda
18519 org-tag-alist
18520 org-tag-persistent-alist)))
18521 (if org-group-tags
18522 (setq org-tag-groups-alist-for-agenda
18523 (org-uniquify-alist
18524 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18525 (org-with-silent-modifications
18526 (save-excursion
18527 (remove-text-properties (point-min) (point-max) pall)
18528 (when org-agenda-skip-archived-trees
18529 (goto-char (point-min))
18530 (while (re-search-forward rea nil t)
18531 (if (org-at-heading-p t)
18532 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18533 (goto-char (point-min))
18534 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18535 (while (re-search-forward re nil t)
18536 (when (save-match-data (org-in-commented-heading-p t))
18537 (add-text-properties
18538 (match-beginning 0) (org-end-of-subtree t) pc)))))
18539 (goto-char pos)))))
18540 (setq org-todo-keywords-for-agenda
18541 (org-uniquify org-todo-keywords-for-agenda))
18542 (setq org-todo-keyword-alist-for-agenda
18543 (org-uniquify org-todo-keyword-alist-for-agenda))))
18546 ;;;; CDLaTeX minor mode
18548 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18549 "Keymap for the minor `org-cdlatex-mode'.")
18551 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18552 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18553 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18554 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18555 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18557 (defvar org-cdlatex-texmathp-advice-is-done nil
18558 "Flag remembering if we have applied the advice to texmathp already.")
18560 (define-minor-mode org-cdlatex-mode
18561 "Toggle the minor `org-cdlatex-mode'.
18562 This mode supports entering LaTeX environment and math in LaTeX fragments
18563 in Org-mode.
18564 \\{org-cdlatex-mode-map}"
18565 nil " OCDL" nil
18566 (when org-cdlatex-mode
18567 (require 'cdlatex)
18568 (run-hooks 'cdlatex-mode-hook)
18569 (cdlatex-compute-tables))
18570 (unless org-cdlatex-texmathp-advice-is-done
18571 (setq org-cdlatex-texmathp-advice-is-done t)
18572 (defadvice texmathp (around org-math-always-on activate)
18573 "Always return t in org-mode buffers.
18574 This is because we want to insert math symbols without dollars even outside
18575 the LaTeX math segments. If Orgmode thinks that point is actually inside
18576 an embedded LaTeX fragment, let texmathp do its job.
18577 \\[org-cdlatex-mode-map]"
18578 (interactive)
18579 (let (p)
18580 (cond
18581 ((not (derived-mode-p 'org-mode)) ad-do-it)
18582 ((eq this-command 'cdlatex-math-symbol)
18583 (setq ad-return-value t
18584 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18586 (let ((p (org-inside-LaTeX-fragment-p)))
18587 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18588 (setq ad-return-value t
18589 texmathp-why '("Org-mode embedded math" . 0))
18590 (if p ad-do-it)))))))))
18592 (defun turn-on-org-cdlatex ()
18593 "Unconditionally turn on `org-cdlatex-mode'."
18594 (org-cdlatex-mode 1))
18596 (defun org-try-cdlatex-tab ()
18597 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18598 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18599 - inside a LaTeX fragment, or
18600 - after the first word in a line, where an abbreviation expansion could
18601 insert a LaTeX environment."
18602 (when org-cdlatex-mode
18603 (cond
18604 ;; Before any word on the line: No expansion possible.
18605 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18606 ;; Just after first word on the line: Expand it. Make sure it
18607 ;; cannot happen on headlines, though.
18608 ((save-excursion
18609 (skip-chars-backward "a-zA-Z0-9*")
18610 (skip-chars-backward " \t")
18611 (and (bolp) (not (org-at-heading-p))))
18612 (cdlatex-tab) t)
18613 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18615 (defun org-cdlatex-underscore-caret (&optional arg)
18616 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18617 Revert to the normal definition outside of these fragments."
18618 (interactive "P")
18619 (if (org-inside-LaTeX-fragment-p)
18620 (call-interactively 'cdlatex-sub-superscript)
18621 (let (org-cdlatex-mode)
18622 (call-interactively (key-binding (vector last-input-event))))))
18624 (defun org-cdlatex-math-modify (&optional arg)
18625 "Execute `cdlatex-math-modify' in LaTeX fragments.
18626 Revert to the normal definition outside of these fragments."
18627 (interactive "P")
18628 (if (org-inside-LaTeX-fragment-p)
18629 (call-interactively 'cdlatex-math-modify)
18630 (let (org-cdlatex-mode)
18631 (call-interactively (key-binding (vector last-input-event))))))
18633 (defun org-cdlatex-environment-indent (&optional environment item)
18634 "Execute `cdlatex-environment' and indent the inserted environment."
18635 (interactive)
18636 (cdlatex-environment environment item)
18637 (let ((element (org-element-at-point)))
18638 (org-indent-region (org-element-property :begin element)
18639 (org-element-property :end element))))
18642 ;;;; LaTeX fragments
18644 (defun org-inside-LaTeX-fragment-p ()
18645 "Test if point is inside a LaTeX fragment.
18646 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18647 sequence appearing also before point.
18648 Even though the matchers for math are configurable, this function assumes
18649 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18650 delimiters are skipped when they have been removed by customization.
18651 The return value is nil, or a cons cell with the delimiter and the
18652 position of this delimiter.
18654 This function does a reasonably good job, but can locally be fooled by
18655 for example currency specifications. For example it will assume being in
18656 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18657 fragments that are properly closed, but during editing, we have to live
18658 with the uncertainty caused by missing closing delimiters. This function
18659 looks only before point, not after."
18660 (catch 'exit
18661 (let ((pos (point))
18662 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18663 (lim (progn
18664 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18665 (point)))
18666 dd-on str (start 0) m re)
18667 (goto-char pos)
18668 (when dodollar
18669 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18670 re (nth 1 (assoc "$" org-latex-regexps)))
18671 (while (string-match re str start)
18672 (cond
18673 ((= (match-end 0) (length str))
18674 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18675 ((= (match-end 0) (- (length str) 5))
18676 (throw 'exit nil))
18677 (t (setq start (match-end 0))))))
18678 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18679 (goto-char pos)
18680 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18681 (and (match-beginning 2) (throw 'exit nil))
18682 ;; count $$
18683 (while (re-search-backward "\\$\\$" lim t)
18684 (setq dd-on (not dd-on)))
18685 (goto-char pos)
18686 (if dd-on (cons "$$" m))))))
18688 (defun org-inside-latex-macro-p ()
18689 "Is point inside a LaTeX macro or its arguments?"
18690 (save-match-data
18691 (org-in-regexp
18692 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18694 (defvar org-latex-fragment-image-overlays nil
18695 "List of overlays carrying the images of latex fragments.")
18696 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18698 (defun org-remove-latex-fragment-image-overlays ()
18699 "Remove all overlays with LaTeX fragment images in current buffer."
18700 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18701 (setq org-latex-fragment-image-overlays nil))
18703 (define-obsolete-function-alias
18704 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18705 (defun org-toggle-latex-fragment (&optional subtree)
18706 "Preview the LaTeX fragment at point, or all locally or globally.
18707 If the cursor is in a LaTeX fragment, create the image and overlay
18708 it over the source code. If there is no fragment at point, display
18709 all fragments in the current text, from one headline to the next. With
18710 prefix SUBTREE, display all fragments in the current subtree. With a
18711 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18712 the cursor is before the first headline,
18713 display all fragments in the buffer.
18714 The images can be removed again with \\[org-toggle-latex-fragment]."
18715 (interactive "P")
18716 (unless (buffer-file-name (buffer-base-buffer))
18717 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18718 (if org-latex-fragment-image-overlays
18719 (progn (org-remove-latex-fragment-image-overlays)
18720 (message "LaTeX fragments images removed"))
18721 (when (display-graphic-p)
18722 (org-remove-latex-fragment-image-overlays)
18723 (org-with-wide-buffer
18724 (let (beg end msg)
18725 (cond
18726 ((equal subtree '(16))
18727 (setq beg (point-min) end (point-max)
18728 msg "Creating images for buffer...%s"))
18729 ((equal subtree '(4))
18730 (org-back-to-heading)
18731 (setq beg (point) end (org-end-of-subtree t)
18732 msg "Creating images for subtree...%s"))
18733 ((let ((context (org-element-context)))
18734 (when (memq (org-element-type context)
18735 '(latex-environment latex-fragment))
18736 (setq beg (org-element-property :begin context)
18737 end (org-element-property :end context)
18738 msg "Creating image...%s"))))
18739 ((org-before-first-heading-p)
18740 (setq beg (point-min) end (point-max)
18741 msg "Creating images for buffer...%s"))
18743 (org-back-to-heading)
18744 (setq beg (point) end (progn (outline-next-heading) (point))
18745 msg "Creating images for entry...%s")))
18746 (message msg "")
18747 (narrow-to-region beg end)
18748 (goto-char beg)
18749 (org-format-latex
18750 (concat org-latex-preview-ltxpng-directory
18751 (file-name-sans-extension
18752 (file-name-nondirectory
18753 (buffer-file-name (buffer-base-buffer)))))
18754 default-directory 'overlays msg 'forbuffer
18755 org-latex-create-formula-image-program)
18756 (message msg "done. Use `C-c C-x C-l' to remove images."))))))
18758 (defun org-format-latex
18759 (prefix &optional dir overlays msg forbuffer processing-type)
18760 "Replace LaTeX fragments with links to an image, and produce images.
18761 Some of the options can be changed using the variable
18762 `org-format-latex-options'."
18763 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18764 (unless (eq processing-type 'verbatim)
18765 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
18766 (cnt 0)
18767 checkdir-flag)
18768 (goto-char (point-min))
18769 (while (re-search-forward math-regexp nil t)
18770 (unless (and overlays
18771 (eq (get-char-property (point) 'org-overlay-type)
18772 'org-latex-overlay))
18773 (let* ((context (org-element-context))
18774 (type (org-element-type context)))
18775 (when (memq type '(latex-environment latex-fragment))
18776 (let ((block-type (eq type 'latex-environment))
18777 (value (org-element-property :value context))
18778 (beg (org-element-property :begin context))
18779 (end (save-excursion
18780 (goto-char (org-element-property :end context))
18781 (skip-chars-backward " \r\t\n")
18782 (point))))
18783 (case processing-type
18784 (mathjax
18785 ;; Prepare for MathJax processing.
18786 (if (eq (char-after beg) ?$)
18787 (save-excursion
18788 (delete-region beg end)
18789 (insert "\\(" (substring value 1 -1) "\\)"))
18790 (goto-char end)))
18791 ((dvipng imagemagick)
18792 ;; Process to an image.
18793 (incf cnt)
18794 (goto-char beg)
18795 (let* ((face (face-at-point))
18796 ;; Get the colors from the face at point.
18798 (let ((color (plist-get org-format-latex-options
18799 :foreground)))
18800 (if (and forbuffer (eq color 'auto))
18801 (face-attribute face :foreground nil 'default)
18802 color)))
18804 (let ((color (plist-get org-format-latex-options
18805 :background)))
18806 (if (and forbuffer (eq color 'auto))
18807 (face-attribute face :background nil 'default)
18808 color)))
18809 (hash (sha1 (prin1-to-string
18810 (list org-format-latex-header
18811 org-latex-default-packages-alist
18812 org-latex-packages-alist
18813 org-format-latex-options
18814 forbuffer value fg bg))))
18815 (absprefix (expand-file-name prefix dir))
18816 (linkfile (format "%s_%s.png" prefix hash))
18817 (movefile (format "%s_%s.png" absprefix hash))
18818 (sep (and block-type "\n\n"))
18819 (link (concat sep "[[file:" linkfile "]]" sep))
18820 (options
18821 (org-combine-plists
18822 org-format-latex-options
18823 `(:foreground ,fg :background ,bg))))
18824 (when msg (message msg cnt))
18825 (unless checkdir-flag ; Ensure the directory exists.
18826 (setq checkdir-flag t)
18827 (let ((todir (file-name-directory absprefix)))
18828 (unless (file-directory-p todir)
18829 (make-directory todir t))))
18830 (unless (file-exists-p movefile)
18831 (org-create-formula-image
18832 value movefile options forbuffer processing-type))
18833 (if overlays
18834 (progn
18835 (dolist (o (overlays-in beg end))
18836 (when (eq (overlay-get o 'org-overlay-type)
18837 'org-latex-overlay)
18838 (delete-overlay o)))
18839 (let ((ov (make-overlay beg end)))
18840 (overlay-put ov
18841 'org-overlay-type
18842 'org-latex-overlay)
18843 (if (featurep 'xemacs)
18844 (progn
18845 (overlay-put ov 'invisible t)
18846 (overlay-put
18847 ov 'end-glyph
18848 (make-glyph
18849 (vector 'png :file movefile))))
18850 (overlay-put
18851 ov 'display
18852 (list 'image
18853 :type 'png
18854 :file movefile
18855 :ascent 'center)))
18856 (push ov org-latex-fragment-image-overlays))
18857 (goto-char end))
18858 (delete-region beg end)
18859 (insert
18860 (org-add-props link
18861 (list 'org-latex-src
18862 (replace-regexp-in-string "\"" "" value)
18863 'org-latex-src-embed-type
18864 (if block-type 'paragraph 'character)))))))
18865 (mathml
18866 ;; Process to MathML.
18867 (unless (org-format-latex-mathml-available-p)
18868 (user-error "LaTeX to MathML converter not configured"))
18869 (incf cnt)
18870 (when msg (message msg cnt))
18871 (goto-char beg)
18872 (delete-region beg end)
18873 (insert (org-format-latex-as-mathml
18874 value block-type prefix dir)))
18875 (otherwise
18876 (error "Unknown conversion type %s for LaTeX fragments"
18877 processing-type)))))))))))
18879 (defun org-create-math-formula (latex-frag &optional mathml-file)
18880 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18881 Use `org-latex-to-mathml-convert-command'. If the conversion is
18882 sucessful, return the portion between \"<math...> </math>\"
18883 elements otherwise return nil. When MATHML-FILE is specified,
18884 write the results in to that file. When invoked as an
18885 interactive command, prompt for LATEX-FRAG, with initial value
18886 set to the current active region and echo the results for user
18887 inspection."
18888 (interactive (list (let ((frag (when (org-region-active-p)
18889 (buffer-substring-no-properties
18890 (region-beginning) (region-end)))))
18891 (read-string "LaTeX Fragment: " frag nil frag))))
18892 (unless latex-frag (user-error "Invalid LaTeX fragment"))
18893 (let* ((tmp-in-file (file-relative-name
18894 (make-temp-name (expand-file-name "ltxmathml-in"))))
18895 (ignore (write-region latex-frag nil tmp-in-file))
18896 (tmp-out-file (file-relative-name
18897 (make-temp-name (expand-file-name "ltxmathml-out"))))
18898 (cmd (format-spec
18899 org-latex-to-mathml-convert-command
18900 `((?j . ,(shell-quote-argument
18901 (expand-file-name org-latex-to-mathml-jar-file)))
18902 (?I . ,(shell-quote-argument tmp-in-file))
18903 (?o . ,(shell-quote-argument tmp-out-file)))))
18904 mathml shell-command-output)
18905 (when (org-called-interactively-p 'any)
18906 (unless (org-format-latex-mathml-available-p)
18907 (user-error "LaTeX to MathML converter not configured")))
18908 (message "Running %s" cmd)
18909 (setq shell-command-output (shell-command-to-string cmd))
18910 (setq mathml
18911 (when (file-readable-p tmp-out-file)
18912 (with-current-buffer (find-file-noselect tmp-out-file t)
18913 (goto-char (point-min))
18914 (when (re-search-forward
18915 (concat
18916 (regexp-quote
18917 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18918 "\\(.\\|\n\\)*"
18919 (regexp-quote "</math>")) nil t)
18920 (prog1 (match-string 0) (kill-buffer))))))
18921 (cond
18922 (mathml
18923 (setq mathml
18924 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18925 (when mathml-file
18926 (write-region mathml nil mathml-file))
18927 (when (org-called-interactively-p 'any)
18928 (message mathml)))
18929 ((message "LaTeX to MathML conversion failed")
18930 (message shell-command-output)))
18931 (delete-file tmp-in-file)
18932 (when (file-exists-p tmp-out-file)
18933 (delete-file tmp-out-file))
18934 mathml))
18936 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18937 prefix &optional dir)
18938 "Use `org-create-math-formula' but check local cache first."
18939 (let* ((absprefix (expand-file-name prefix dir))
18940 (print-length nil) (print-level nil)
18941 (formula-id (concat
18942 "formula-"
18943 (sha1
18944 (prin1-to-string
18945 (list latex-frag
18946 org-latex-to-mathml-convert-command)))))
18947 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18948 (formula-cache-dir (file-name-directory formula-cache)))
18950 (unless (file-directory-p formula-cache-dir)
18951 (make-directory formula-cache-dir t))
18953 (unless (file-exists-p formula-cache)
18954 (org-create-math-formula latex-frag formula-cache))
18956 (if (file-exists-p formula-cache)
18957 ;; Successful conversion. Return the link to MathML file.
18958 (org-add-props
18959 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18960 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18961 'org-latex-src-embed-type (if latex-frag-type
18962 'paragraph 'character)))
18963 ;; Failed conversion. Return the LaTeX fragment verbatim
18964 latex-frag)))
18966 (defun org-create-formula-image (string tofile options buffer &optional type)
18967 "Create an image from LaTeX source using dvipng or convert.
18968 This function calls either `org-create-formula-image-with-dvipng'
18969 or `org-create-formula-image-with-imagemagick' depending on the
18970 value of `org-latex-create-formula-image-program' or on the value
18971 of the optional TYPE variable.
18973 Note: ultimately these two function should be combined as they
18974 share a good deal of logic."
18975 (org-check-external-command
18976 "latex" "needed to convert LaTeX fragments to images")
18977 (funcall
18978 (case (or type org-latex-create-formula-image-program)
18979 ('dvipng
18980 (org-check-external-command
18981 "dvipng" "needed to convert LaTeX fragments to images")
18982 'org-create-formula-image-with-dvipng)
18983 ('imagemagick
18984 (org-check-external-command
18985 "convert" "you need to install imagemagick")
18986 'org-create-formula-image-with-imagemagick)
18987 (t (error
18988 "Invalid value of `org-latex-create-formula-image-program'")))
18989 string tofile options buffer))
18991 (declare-function org-export-get-backend "ox" (name))
18992 (declare-function org-export--get-global-options "ox" (&optional backend))
18993 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18994 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18995 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18996 (defun org-create-formula--latex-header ()
18997 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18998 (let ((info (org-combine-plists (org-export--get-global-options
18999 (org-export-get-backend 'latex))
19000 (org-export--get-inbuffer-options
19001 (org-export-get-backend 'latex)))))
19002 (org-latex-guess-babel-language
19003 (org-latex-guess-inputenc
19004 (org-splice-latex-header
19005 org-format-latex-header
19006 org-latex-default-packages-alist
19007 org-latex-packages-alist t
19008 (plist-get info :latex-header)))
19009 info)))
19011 ;; This function borrows from Ganesh Swami's latex2png.el
19012 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19013 "This calls dvipng."
19014 (require 'ox-latex)
19015 (let* ((tmpdir (if (featurep 'xemacs)
19016 (temp-directory)
19017 temporary-file-directory))
19018 (texfilebase (make-temp-name
19019 (expand-file-name "orgtex" tmpdir)))
19020 (texfile (concat texfilebase ".tex"))
19021 (dvifile (concat texfilebase ".dvi"))
19022 (pngfile (concat texfilebase ".png"))
19023 (fnh (if (featurep 'xemacs)
19024 (font-height (face-font 'default))
19025 (face-attribute 'default :height nil)))
19026 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19027 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
19028 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19029 "Black"))
19030 (bg (or (plist-get options (if buffer :background :html-background))
19031 "Transparent")))
19032 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19033 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19034 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19035 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19036 (let ((latex-header (org-create-formula--latex-header)))
19037 (with-temp-file texfile
19038 (insert latex-header)
19039 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19040 (let ((dir default-directory))
19041 (ignore-errors
19042 (cd tmpdir)
19043 (call-process "latex" nil nil nil texfile))
19044 (cd dir))
19045 (if (not (file-exists-p dvifile))
19046 (progn (message "Failed to create dvi file from %s" texfile) nil)
19047 (ignore-errors
19048 (if (featurep 'xemacs)
19049 (call-process "dvipng" nil nil nil
19050 "-fg" fg "-bg" bg
19051 "-T" "tight"
19052 "-o" pngfile
19053 dvifile)
19054 (call-process "dvipng" nil nil nil
19055 "-fg" fg "-bg" bg
19056 "-D" dpi
19057 ;;"-x" scale "-y" scale
19058 "-T" "tight"
19059 "-o" pngfile
19060 dvifile)))
19061 (if (not (file-exists-p pngfile))
19062 (if org-format-latex-signal-error
19063 (error "Failed to create png file from %s" texfile)
19064 (message "Failed to create png file from %s" texfile)
19065 nil)
19066 ;; Use the requested file name and clean up
19067 (copy-file pngfile tofile 'replace)
19068 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19069 (if (file-exists-p (concat texfilebase e))
19070 (delete-file (concat texfilebase e))))
19071 pngfile))))
19073 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19074 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19075 "This calls convert, which is included into imagemagick."
19076 (require 'ox-latex)
19077 (let* ((tmpdir (if (featurep 'xemacs)
19078 (temp-directory)
19079 temporary-file-directory))
19080 (texfilebase (make-temp-name
19081 (expand-file-name "orgtex" tmpdir)))
19082 (texfile (concat texfilebase ".tex"))
19083 (pdffile (concat texfilebase ".pdf"))
19084 (pngfile (concat texfilebase ".png"))
19085 (fnh (if (featurep 'xemacs)
19086 (font-height (face-font 'default))
19087 (face-attribute 'default :height nil)))
19088 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19089 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
19090 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19091 "black"))
19092 (bg (or (plist-get options (if buffer :background :html-background))
19093 "white")))
19094 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19095 (setq fg (org-latex-color-format fg)))
19096 (if (eq bg 'default) (setq bg (org-latex-color :background))
19097 (setq bg (org-latex-color-format
19098 (if (string= bg "Transparent") "white" bg))))
19099 (let ((latex-header (org-create-formula--latex-header)))
19100 (with-temp-file texfile
19101 (insert latex-header)
19102 (insert "\n\\begin{document}\n"
19103 "\\definecolor{fg}{rgb}{" fg "}\n"
19104 "\\definecolor{bg}{rgb}{" bg "}\n"
19105 "\n\\pagecolor{bg}\n"
19106 "\n{\\color{fg}\n"
19107 string
19108 "\n}\n"
19109 "\n\\end{document}\n")))
19110 (org-latex-compile texfile t)
19111 (if (not (file-exists-p pdffile))
19112 (progn (message "Failed to create pdf file from %s" texfile) nil)
19113 (ignore-errors
19114 (if (featurep 'xemacs)
19115 (call-process "convert" nil nil nil
19116 "-density" "96"
19117 "-trim"
19118 "-antialias"
19119 pdffile
19120 "-quality" "100"
19121 ;; "-sharpen" "0x1.0"
19122 pngfile)
19123 (call-process "convert" nil nil nil
19124 "-density" dpi
19125 "-trim"
19126 "-antialias"
19127 pdffile
19128 "-quality" "100"
19129 ;; "-sharpen" "0x1.0"
19130 pngfile)))
19131 (if (not (file-exists-p pngfile))
19132 (if org-format-latex-signal-error
19133 (error "Failed to create png file from %s" texfile)
19134 (message "Failed to create png file from %s" texfile)
19135 nil)
19136 ;; Use the requested file name and clean up
19137 (copy-file pngfile tofile 'replace)
19138 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19139 (if (file-exists-p (concat texfilebase e))
19140 (delete-file (concat texfilebase e))))
19141 pngfile))))
19143 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19144 "Fill a LaTeX header template TPL.
19145 In the template, the following place holders will be recognized:
19147 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19148 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19149 [PACKAGES] \\usepackage statements for PKG
19150 [NO-PACKAGES] do not include PKG
19151 [EXTRA] the string EXTRA
19152 [NO-EXTRA] do not include EXTRA
19154 For backward compatibility, if both the positive and the negative place
19155 holder is missing, the positive one (without the \"NO-\") will be
19156 assumed to be present at the end of the template.
19157 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19158 EXTRA is a string.
19159 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19160 (let (rpl (end ""))
19161 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19162 (setq rpl (if (or (match-end 1) (not def-pkg))
19163 "" (org-latex-packages-to-string def-pkg snippets-p t))
19164 tpl (replace-match rpl t t tpl))
19165 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19167 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19168 (setq rpl (if (or (match-end 1) (not pkg))
19169 "" (org-latex-packages-to-string pkg snippets-p t))
19170 tpl (replace-match rpl t t tpl))
19171 (if pkg (setq end
19172 (concat end "\n"
19173 (org-latex-packages-to-string pkg snippets-p)))))
19175 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19176 (setq rpl (if (or (match-end 1) (not extra))
19177 "" (concat extra "\n"))
19178 tpl (replace-match rpl t t tpl))
19179 (if (and extra (string-match "\\S-" extra))
19180 (setq end (concat end "\n" extra))))
19182 (if (string-match "\\S-" end)
19183 (concat tpl "\n" end)
19184 tpl)))
19186 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19187 "Turn an alist of packages into a string with the \\usepackage macros."
19188 (setq pkg (mapconcat (lambda(p)
19189 (cond
19190 ((stringp p) p)
19191 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19192 (format "%% Package %s omitted" (cadr p)))
19193 ((equal "" (car p))
19194 (format "\\usepackage{%s}" (cadr p)))
19196 (format "\\usepackage[%s]{%s}"
19197 (car p) (cadr p)))))
19199 "\n"))
19200 (if newline (concat pkg "\n") pkg))
19202 (defun org-dvipng-color (attr)
19203 "Return a RGB color specification for dvipng."
19204 (apply 'format "rgb %s %s %s"
19205 (mapcar 'org-normalize-color
19206 (if (featurep 'xemacs)
19207 (color-rgb-components
19208 (face-property 'default
19209 (cond ((eq attr :foreground) 'foreground)
19210 ((eq attr :background) 'background))))
19211 (color-values (face-attribute 'default attr nil))))))
19213 (defun org-dvipng-color-format (color-name)
19214 "Convert COLOR-NAME to a RGB color value for dvipng."
19215 (apply 'format "rgb %s %s %s"
19216 (mapcar 'org-normalize-color
19217 (color-values color-name))))
19219 (defun org-latex-color (attr)
19220 "Return a RGB color for the LaTeX color package."
19221 (apply 'format "%s,%s,%s"
19222 (mapcar 'org-normalize-color
19223 (if (featurep 'xemacs)
19224 (color-rgb-components
19225 (face-property 'default
19226 (cond ((eq attr :foreground) 'foreground)
19227 ((eq attr :background) 'background))))
19228 (color-values (face-attribute 'default attr nil))))))
19230 (defun org-latex-color-format (color-name)
19231 "Convert COLOR-NAME to a RGB color value."
19232 (apply 'format "%s,%s,%s"
19233 (mapcar 'org-normalize-color
19234 (color-values color-name))))
19236 (defun org-normalize-color (value)
19237 "Return string to be used as color value for an RGB component."
19238 (format "%g" (/ value 65535.0)))
19242 ;; Image display
19244 (defvar org-inline-image-overlays nil)
19245 (make-variable-buffer-local 'org-inline-image-overlays)
19247 (defun org-toggle-inline-images (&optional include-linked)
19248 "Toggle the display of inline images.
19249 INCLUDE-LINKED is passed to `org-display-inline-images'."
19250 (interactive "P")
19251 (if org-inline-image-overlays
19252 (progn
19253 (org-remove-inline-images)
19254 (message "Inline image display turned off"))
19255 (org-display-inline-images include-linked)
19256 (if (and (org-called-interactively-p)
19257 org-inline-image-overlays)
19258 (message "%d images displayed inline"
19259 (length org-inline-image-overlays))
19260 (message "No images to display inline"))))
19262 (defun org-redisplay-inline-images ()
19263 "Refresh the display of inline images."
19264 (interactive)
19265 (if (not org-inline-image-overlays)
19266 (org-toggle-inline-images)
19267 (org-toggle-inline-images)
19268 (org-toggle-inline-images)))
19270 (defun org-display-inline-images (&optional include-linked refresh beg end)
19271 "Display inline images.
19273 An inline image is a link which follows either of these
19274 conventions:
19276 1. Its path is a file with an extension matching return value
19277 from `image-file-name-regexp' and it has no contents.
19279 2. Its description consists in a single link of the previous
19280 type.
19282 When optional argument INCLUDE-LINKED is non-nil, also links with
19283 a text description part will be inlined. This can be nice for
19284 a quick look at those images, but it does not reflect what
19285 exported files will look like.
19287 When optional argument REFRESH is non-nil, refresh existing
19288 images between BEG and END. This will create new image displays
19289 only if necessary. BEG and END default to the buffer
19290 boundaries."
19291 (interactive "P")
19292 (when (display-graphic-p)
19293 (unless refresh
19294 (org-remove-inline-images)
19295 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19296 (org-with-wide-buffer
19297 (goto-char (or beg (point-min)))
19298 (let ((case-fold-search t)
19299 (file-extension-re (org-image-file-name-regexp)))
19300 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19301 (let ((link (save-match-data (org-element-context))))
19302 ;; Check if we're at an inline image.
19303 (when (and (equal (org-element-property :type link) "file")
19304 (or include-linked
19305 (not (org-element-property :contents-begin link)))
19306 (let ((parent (org-element-property :parent link)))
19307 (or (not (eq (org-element-type parent) 'link))
19308 (not (cdr (org-element-contents parent)))))
19309 (org-string-match-p file-extension-re
19310 (org-element-property :path link)))
19311 (let ((file (expand-file-name (org-element-property :path link))))
19312 (when (file-exists-p file)
19313 (let ((width
19314 ;; Apply `org-image-actual-width' specifications.
19315 (cond
19316 ((not (image-type-available-p 'imagemagick)) nil)
19317 ((eq org-image-actual-width t) nil)
19318 ((listp org-image-actual-width)
19320 ;; First try to find a width among
19321 ;; attributes associated to the paragraph
19322 ;; containing link.
19323 (let ((paragraph
19324 (let ((e link))
19325 (while (and (setq e (org-element-property
19326 :parent e))
19327 (not (eq (org-element-type e)
19328 'paragraph))))
19329 e)))
19330 (when paragraph
19331 (save-excursion
19332 (goto-char (org-element-property :begin paragraph))
19333 (when
19334 (re-search-forward
19335 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19336 (org-element-property
19337 :post-affiliated paragraph)
19339 (string-to-number (match-string 1))))))
19340 ;; Otherwise, fall-back to provided number.
19341 (car org-image-actual-width)))
19342 ((numberp org-image-actual-width)
19343 org-image-actual-width)))
19344 (old (get-char-property-and-overlay
19345 (org-element-property :begin link)
19346 'org-image-overlay)))
19347 (if (and (car-safe old) refresh)
19348 (image-refresh (overlay-get (cdr old) 'display))
19349 (let ((image (create-image file
19350 (and width 'imagemagick)
19352 :width width)))
19353 (when image
19354 (let* ((link
19355 ;; If inline image is the description
19356 ;; of another link, be sure to
19357 ;; consider the latter as the one to
19358 ;; apply the overlay on.
19359 (let ((parent
19360 (org-element-property :parent link)))
19361 (if (eq (org-element-type parent) 'link)
19362 parent
19363 link)))
19364 (ov (make-overlay
19365 (org-element-property :begin link)
19366 (progn
19367 (goto-char
19368 (org-element-property :end link))
19369 (skip-chars-backward " \t")
19370 (point)))))
19371 (overlay-put ov 'display image)
19372 (overlay-put ov 'face 'default)
19373 (overlay-put ov 'org-image-overlay t)
19374 (overlay-put
19375 ov 'modification-hooks
19376 (list 'org-display-inline-remove-overlay))
19377 (push ov org-inline-image-overlays)))))))))))))))
19379 (define-obsolete-function-alias
19380 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19382 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19383 "Remove inline-display overlay if a corresponding region is modified."
19384 (let ((inhibit-modification-hooks t))
19385 (when (and ov after)
19386 (delete ov org-inline-image-overlays)
19387 (delete-overlay ov))))
19389 (defun org-remove-inline-images ()
19390 "Remove inline display of images."
19391 (interactive)
19392 (mapc 'delete-overlay org-inline-image-overlays)
19393 (setq org-inline-image-overlays nil))
19395 ;;;; Key bindings
19397 ;; Outline functions from `outline-mode-prefix-map'
19398 ;; that can be remapped in Org:
19399 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19400 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19401 (define-key org-mode-map [remap outline-forward-same-level]
19402 'org-forward-heading-same-level)
19403 (define-key org-mode-map [remap outline-backward-same-level]
19404 'org-backward-heading-same-level)
19405 (define-key org-mode-map [remap show-branches]
19406 'org-kill-note-or-show-branches)
19407 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19408 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19409 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19411 ;; Outline functions from `outline-mode-prefix-map' that can not
19412 ;; be remapped in Org:
19414 ;; - the column "key binding" shows whether the Outline function is still
19415 ;; available in Org mode on the same key that it has been bound to in
19416 ;; Outline mode:
19417 ;; - "overridden": key used for a different functionality in Org mode
19418 ;; - else: key still bound to the same Outline function in Org mode
19420 ;; | Outline function | key binding | Org replacement |
19421 ;; |------------------------------------+-------------+-----------------------|
19422 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
19423 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
19424 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19425 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19426 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19427 ;; | `show-entry' | overridden | no replacement |
19428 ;; | `show-children' | `C-c C-i' | visibility cycling |
19429 ;; | `show-branches' | `C-c C-k' | still same function |
19430 ;; | `show-subtree' | overridden | visibility cycling |
19431 ;; | `show-all' | overridden | no replacement |
19432 ;; | `hide-subtree' | overridden | visibility cycling |
19433 ;; | `hide-body' | overridden | no replacement |
19434 ;; | `hide-entry' | overridden | visibility cycling |
19435 ;; | `hide-leaves' | overridden | no replacement |
19436 ;; | `hide-sublevels' | overridden | no replacement |
19437 ;; | `hide-other' | overridden | no replacement |
19439 ;; Make `C-c C-x' a prefix key
19440 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19442 ;; TAB key with modifiers
19443 (org-defkey org-mode-map "\C-i" 'org-cycle)
19444 (org-defkey org-mode-map [(tab)] 'org-cycle)
19445 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19446 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19447 ;; The following line is necessary under Suse GNU/Linux
19448 (unless (featurep 'xemacs)
19449 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19450 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19451 (define-key org-mode-map [backtab] 'org-shifttab)
19453 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19454 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19455 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19457 ;; Cursor keys with modifiers
19458 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19459 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19460 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19461 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19463 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19464 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19465 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19466 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19467 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19468 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19470 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19471 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19472 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19473 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19475 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19476 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19477 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19478 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19480 ;; Babel keys
19481 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19482 (mapc (lambda (pair)
19483 (define-key org-babel-map (car pair) (cdr pair)))
19484 org-babel-key-bindings)
19486 ;;; Extra keys for tty access.
19487 ;; We only set them when really needed because otherwise the
19488 ;; menus don't show the simple keys
19490 (when (or org-use-extra-keys
19491 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19492 (not window-system))
19493 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19494 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19495 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19496 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19497 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19498 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19499 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19500 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19501 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19502 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19503 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19504 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19505 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19506 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19507 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19508 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19509 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19510 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19511 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19512 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19513 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19514 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19515 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19516 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19517 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19518 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19519 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19520 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19522 ;; All the other keys
19524 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19525 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19526 (if (boundp 'narrow-map)
19527 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19528 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19529 (if (boundp 'narrow-map)
19530 (org-defkey narrow-map "b" 'org-narrow-to-block)
19531 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19532 (if (boundp 'narrow-map)
19533 (org-defkey narrow-map "e" 'org-narrow-to-element)
19534 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19535 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19536 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19537 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19538 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19539 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19540 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19541 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19542 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19543 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19544 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19545 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19546 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19547 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19548 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19549 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19550 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19551 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19552 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19553 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19554 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19555 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19556 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19557 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19558 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19559 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19560 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19561 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19562 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19563 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19564 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19565 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19566 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19567 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19568 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19569 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19570 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19571 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19572 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19573 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19574 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19575 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19576 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19577 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19578 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19579 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19580 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19581 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19582 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19583 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19584 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19585 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19586 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19587 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19588 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19589 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19590 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19591 (org-defkey org-mode-map "\C-c^" 'org-sort)
19592 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19593 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19594 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19595 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19596 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19597 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19598 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19599 (org-defkey org-mode-map "\C-m" 'org-return)
19600 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19601 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19602 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19603 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19604 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19605 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19606 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19607 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19608 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19609 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19610 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19611 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19612 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19613 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19614 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19615 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19616 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19617 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19618 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19619 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19620 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19621 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19622 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19623 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19624 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19626 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19627 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19628 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19630 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19631 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19632 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19633 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19634 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19635 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19636 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19637 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19638 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19639 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19640 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19641 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19642 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19643 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19644 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19645 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19646 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19647 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19648 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19649 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19650 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19651 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19652 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19654 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19655 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19656 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19657 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19658 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19660 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19662 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19664 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19665 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19667 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19670 (when (featurep 'xemacs)
19671 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19674 (defconst org-speed-commands-default
19676 ("Outline Navigation")
19677 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19678 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19679 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19680 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19681 ("F" . org-next-block)
19682 ("B" . org-previous-block)
19683 ("u" . (org-speed-move-safe 'outline-up-heading))
19684 ("j" . org-goto)
19685 ("g" . (org-refile t))
19686 ("Outline Visibility")
19687 ("c" . org-cycle)
19688 ("C" . org-shifttab)
19689 (" " . org-display-outline-path)
19690 ("s" . org-narrow-to-subtree)
19691 ("=" . org-columns)
19692 ("Outline Structure Editing")
19693 ("U" . org-metaup)
19694 ("D" . org-metadown)
19695 ("r" . org-metaright)
19696 ("l" . org-metaleft)
19697 ("R" . org-shiftmetaright)
19698 ("L" . org-shiftmetaleft)
19699 ("i" . (progn (forward-char 1) (call-interactively
19700 'org-insert-heading-respect-content)))
19701 ("^" . org-sort)
19702 ("w" . org-refile)
19703 ("a" . org-archive-subtree-default-with-confirmation)
19704 ("@" . org-mark-subtree)
19705 ("#" . org-toggle-comment)
19706 ("Clock Commands")
19707 ("I" . org-clock-in)
19708 ("O" . org-clock-out)
19709 ("Meta Data Editing")
19710 ("t" . org-todo)
19711 ("," . (org-priority))
19712 ("0" . (org-priority ?\ ))
19713 ("1" . (org-priority ?A))
19714 ("2" . (org-priority ?B))
19715 ("3" . (org-priority ?C))
19716 (":" . org-set-tags-command)
19717 ("e" . org-set-effort)
19718 ("E" . org-inc-effort)
19719 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19720 (org-entry-put (point) "APPT_WARNTIME" m)))
19721 ("Agenda Views etc")
19722 ("v" . org-agenda)
19723 ("/" . org-sparse-tree)
19724 ("Misc")
19725 ("o" . org-open-at-point)
19726 ("?" . org-speed-command-help)
19727 ("<" . (org-agenda-set-restriction-lock 'subtree))
19728 (">" . (org-agenda-remove-restriction-lock))
19730 "The default speed commands.")
19732 (defun org-print-speed-command (e)
19733 (if (> (length (car e)) 1)
19734 (progn
19735 (princ "\n")
19736 (princ (car e))
19737 (princ "\n")
19738 (princ (make-string (length (car e)) ?-))
19739 (princ "\n"))
19740 (princ (car e))
19741 (princ " ")
19742 (if (symbolp (cdr e))
19743 (princ (symbol-name (cdr e)))
19744 (prin1 (cdr e)))
19745 (princ "\n")))
19747 (defun org-speed-command-help ()
19748 "Show the available speed commands."
19749 (interactive)
19750 (if (not org-use-speed-commands)
19751 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19752 (with-output-to-temp-buffer "*Help*"
19753 (princ "User-defined Speed commands\n===========================\n")
19754 (mapc 'org-print-speed-command org-speed-commands-user)
19755 (princ "\n")
19756 (princ "Built-in Speed commands\n=======================\n")
19757 (mapc 'org-print-speed-command org-speed-commands-default))
19758 (with-current-buffer "*Help*"
19759 (setq truncate-lines t))))
19761 (defun org-speed-move-safe (cmd)
19762 "Execute CMD, but make sure that the cursor always ends up in a headline.
19763 If not, return to the original position and throw an error."
19764 (interactive)
19765 (let ((pos (point)))
19766 (call-interactively cmd)
19767 (unless (and (bolp) (org-at-heading-p))
19768 (goto-char pos)
19769 (error "Boundary reached while executing %s" cmd))))
19771 (defvar org-self-insert-command-undo-counter 0)
19773 (defvar org-table-auto-blank-field) ; defined in org-table.el
19774 (defvar org-speed-command nil)
19776 (define-obsolete-function-alias
19777 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19779 (defun org-speed-command-activate (keys)
19780 "Hook for activating single-letter speed commands.
19781 `org-speed-commands-default' specifies a minimal command set.
19782 Use `org-speed-commands-user' for further customization."
19783 (when (or (and (bolp) (looking-at org-outline-regexp))
19784 (and (functionp org-use-speed-commands)
19785 (funcall org-use-speed-commands)))
19786 (cdr (assoc keys (append org-speed-commands-user
19787 org-speed-commands-default)))))
19789 (define-obsolete-function-alias
19790 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19792 (defun org-babel-speed-command-activate (keys)
19793 "Hook for activating single-letter code block commands."
19794 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19795 (cdr (assoc keys org-babel-key-bindings))))
19797 (defcustom org-speed-command-hook
19798 '(org-speed-command-default-hook org-babel-speed-command-hook)
19799 "Hook for activating speed commands at strategic locations.
19800 Hook functions are called in sequence until a valid handler is
19801 found.
19803 Each hook takes a single argument, a user-pressed command key
19804 which is also a `self-insert-command' from the global map.
19806 Within the hook, examine the cursor position and the command key
19807 and return nil or a valid handler as appropriate. Handler could
19808 be one of an interactive command, a function, or a form.
19810 Set `org-use-speed-commands' to non-nil value to enable this
19811 hook. The default setting is `org-speed-command-activate'."
19812 :group 'org-structure
19813 :version "24.1"
19814 :type 'hook)
19816 (defun org-self-insert-command (N)
19817 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19818 If the cursor is in a table looking at whitespace, the whitespace is
19819 overwritten, and the table is not marked as requiring realignment."
19820 (interactive "p")
19821 (org-check-before-invisible-edit 'insert)
19822 (cond
19823 ((and org-use-speed-commands
19824 (let ((kv (this-command-keys-vector)))
19825 (setq org-speed-command
19826 (run-hook-with-args-until-success
19827 'org-speed-command-hook
19828 (make-string 1 (aref kv (1- (length kv))))))))
19829 (cond
19830 ((commandp org-speed-command)
19831 (setq this-command org-speed-command)
19832 (call-interactively org-speed-command))
19833 ((functionp org-speed-command)
19834 (funcall org-speed-command))
19835 ((and org-speed-command (listp org-speed-command))
19836 (eval org-speed-command))
19837 (t (let (org-use-speed-commands)
19838 (call-interactively 'org-self-insert-command)))))
19839 ((and
19840 (org-table-p)
19841 (progn
19842 ;; check if we blank the field, and if that triggers align
19843 (and (featurep 'org-table) org-table-auto-blank-field
19844 (memq last-command
19845 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
19846 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19847 ;; got extra space, this field does not determine column width
19848 (let (org-table-may-need-update) (org-table-blank-field))
19849 ;; no extra space, this field may determine column width
19850 (org-table-blank-field)))
19852 (eq N 1)
19853 (looking-at "[^|\n]* |"))
19854 (let (org-table-may-need-update)
19855 (goto-char (1- (match-end 0)))
19856 (backward-delete-char 1)
19857 (goto-char (match-beginning 0))
19858 (self-insert-command N)))
19860 (setq org-table-may-need-update t)
19861 (self-insert-command N)
19862 (org-fix-tags-on-the-fly)
19863 (if org-self-insert-cluster-for-undo
19864 (if (not (eq last-command 'org-self-insert-command))
19865 (setq org-self-insert-command-undo-counter 1)
19866 (if (>= org-self-insert-command-undo-counter 20)
19867 (setq org-self-insert-command-undo-counter 1)
19868 (and (> org-self-insert-command-undo-counter 0)
19869 buffer-undo-list (listp buffer-undo-list)
19870 (not (cadr buffer-undo-list)) ; remove nil entry
19871 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19872 (setq org-self-insert-command-undo-counter
19873 (1+ org-self-insert-command-undo-counter))))))))
19875 (defun org-check-before-invisible-edit (kind)
19876 "Check is editing if kind KIND would be dangerous with invisible text around.
19877 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19878 ;; First, try to get out of here as quickly as possible, to reduce overhead
19879 (if (and org-catch-invisible-edits
19880 (or (not (boundp 'visible-mode)) (not visible-mode))
19881 (or (get-char-property (point) 'invisible)
19882 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19883 ;; OK, we need to take a closer look
19884 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19885 (invisible-before-point (if (bobp) nil (get-char-property
19886 (1- (point)) 'invisible)))
19887 (border-and-ok-direction
19889 ;; Check if we are acting predictably before invisible text
19890 (and invisible-at-point (not invisible-before-point)
19891 (memq kind '(insert delete-backward)))
19892 ;; Check if we are acting predictably after invisible text
19893 ;; This works not well, and I have turned it off. It seems
19894 ;; better to always show and stop after invisible text.
19895 ;; (and (not invisible-at-point) invisible-before-point
19896 ;; (memq kind '(insert delete)))
19898 (when (or (memq invisible-at-point '(outline org-hide-block t))
19899 (memq invisible-before-point '(outline org-hide-block t)))
19900 (if (eq org-catch-invisible-edits 'error)
19901 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19902 (if (and org-custom-properties-overlays
19903 (y-or-n-p "Display invisible properties in this buffer? "))
19904 (org-toggle-custom-properties-visibility)
19905 ;; Make the area visible
19906 (save-excursion
19907 (if invisible-before-point
19908 (goto-char (previous-single-char-property-change
19909 (point) 'invisible)))
19910 (show-subtree))
19911 (cond
19912 ((eq org-catch-invisible-edits 'show)
19913 ;; That's it, we do the edit after showing
19914 (message
19915 "Unfolding invisible region around point before editing")
19916 (sit-for 1))
19917 ((and (eq org-catch-invisible-edits 'smart)
19918 border-and-ok-direction)
19919 (message "Unfolding invisible region around point before editing"))
19921 ;; Don't do the edit, make the user repeat it in full visibility
19922 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19924 (defun org-fix-tags-on-the-fly ()
19925 (when (and (equal (char-after (point-at-bol)) ?*)
19926 (org-at-heading-p))
19927 (org-align-tags-here org-tags-column)))
19929 (defun org-delete-backward-char (N)
19930 "Like `delete-backward-char', insert whitespace at field end in tables.
19931 When deleting backwards, in tables this function will insert whitespace in
19932 front of the next \"|\" separator, to keep the table aligned. The table will
19933 still be marked for re-alignment if the field did fill the entire column,
19934 because, in this case the deletion might narrow the column."
19935 (interactive "p")
19936 (save-match-data
19937 (org-check-before-invisible-edit 'delete-backward)
19938 (if (and (org-table-p)
19939 (eq N 1)
19940 (string-match "|" (buffer-substring (point-at-bol) (point)))
19941 (looking-at ".*?|"))
19942 (let ((pos (point))
19943 (noalign (looking-at "[^|\n\r]* |"))
19944 (c org-table-may-need-update))
19945 (backward-delete-char N)
19946 (if (not overwrite-mode)
19947 (progn
19948 (skip-chars-forward "^|")
19949 (insert " ")
19950 (goto-char (1- pos))))
19951 ;; noalign: if there were two spaces at the end, this field
19952 ;; does not determine the width of the column.
19953 (if noalign (setq org-table-may-need-update c)))
19954 (backward-delete-char N)
19955 (org-fix-tags-on-the-fly))))
19957 (defun org-delete-char (N)
19958 "Like `delete-char', but insert whitespace at field end in tables.
19959 When deleting characters, in tables this function will insert whitespace in
19960 front of the next \"|\" separator, to keep the table aligned. The table will
19961 still be marked for re-alignment if the field did fill the entire column,
19962 because, in this case the deletion might narrow the column."
19963 (interactive "p")
19964 (save-match-data
19965 (org-check-before-invisible-edit 'delete)
19966 (if (and (org-table-p)
19967 (not (bolp))
19968 (not (= (char-after) ?|))
19969 (eq N 1))
19970 (if (looking-at ".*?|")
19971 (let ((pos (point))
19972 (noalign (looking-at "[^|\n\r]* |"))
19973 (c org-table-may-need-update))
19974 (replace-match
19975 (concat (substring (match-string 0) 1 -1) " |") nil t)
19976 (goto-char pos)
19977 ;; noalign: if there were two spaces at the end, this field
19978 ;; does not determine the width of the column.
19979 (if noalign (setq org-table-may-need-update c)))
19980 (delete-char N))
19981 (delete-char N)
19982 (org-fix-tags-on-the-fly))))
19984 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19985 (put 'org-self-insert-command 'delete-selection
19986 (lambda ()
19987 (not (run-hook-with-args-until-success
19988 'self-insert-uses-region-functions))))
19989 (put 'orgtbl-self-insert-command 'delete-selection
19990 (lambda ()
19991 (not (run-hook-with-args-until-success
19992 'self-insert-uses-region-functions))))
19993 (put 'org-delete-char 'delete-selection 'supersede)
19994 (put 'org-delete-backward-char 'delete-selection 'supersede)
19995 (put 'org-yank 'delete-selection 'yank)
19997 ;; Make `flyspell-mode' delay after some commands
19998 (put 'org-self-insert-command 'flyspell-delayed t)
19999 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20000 (put 'org-delete-char 'flyspell-delayed t)
20001 (put 'org-delete-backward-char 'flyspell-delayed t)
20003 ;; Make pabbrev-mode expand after org-mode commands
20004 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20005 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20007 (defun org-remap (map &rest commands)
20008 "In MAP, remap the functions given in COMMANDS.
20009 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20010 (let (new old)
20011 (while commands
20012 (setq old (pop commands) new (pop commands))
20013 (if (fboundp 'command-remapping)
20014 (org-defkey map (vector 'remap old) new)
20015 (substitute-key-definition old new map global-map)))))
20017 (defun org-transpose-words ()
20018 "Transpose words for Org.
20019 This uses the `org-mode-transpose-word-syntax-table' syntax
20020 table, which interprets characters in `org-emphasis-alist' as
20021 word constituents."
20022 (interactive)
20023 (with-syntax-table org-mode-transpose-word-syntax-table
20024 (call-interactively 'transpose-words)))
20025 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20027 (when (eq org-enable-table-editor 'optimized)
20028 ;; If the user wants maximum table support, we need to hijack
20029 ;; some standard editing functions
20030 (org-remap org-mode-map
20031 'self-insert-command 'org-self-insert-command
20032 'delete-char 'org-delete-char
20033 'delete-backward-char 'org-delete-backward-char)
20034 (org-defkey org-mode-map "|" 'org-force-self-insert))
20036 (defvar org-ctrl-c-ctrl-c-hook nil
20037 "Hook for functions attaching themselves to `C-c C-c'.
20039 This can be used to add additional functionality to the C-c C-c
20040 key which executes context-dependent commands. This hook is run
20041 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20042 run after the last test.
20044 Each function will be called with no arguments. The function
20045 must check if the context is appropriate for it to act. If yes,
20046 it should do its thing and then return a non-nil value. If the
20047 context is wrong, just do nothing and return nil.")
20049 (defvar org-ctrl-c-ctrl-c-final-hook nil
20050 "Hook for functions attaching themselves to `C-c C-c'.
20052 This can be used to add additional functionality to the C-c C-c
20053 key which executes context-dependent commands. This hook is run
20054 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20055 before the first test.
20057 Each function will be called with no arguments. The function
20058 must check if the context is appropriate for it to act. If yes,
20059 it should do its thing and then return a non-nil value. If the
20060 context is wrong, just do nothing and return nil.")
20062 (defvar org-tab-first-hook nil
20063 "Hook for functions to attach themselves to TAB.
20064 See `org-ctrl-c-ctrl-c-hook' for more information.
20065 This hook runs as the first action when TAB is pressed, even before
20066 `org-cycle' messes around with the `outline-regexp' to cater for
20067 inline tasks and plain list item folding.
20068 If any function in this hook returns t, any other actions that
20069 would have been caused by TAB (such as table field motion or visibility
20070 cycling) will not occur.")
20072 (defvar org-tab-after-check-for-table-hook nil
20073 "Hook for functions to attach themselves to TAB.
20074 See `org-ctrl-c-ctrl-c-hook' for more information.
20075 This hook runs after it has been established that the cursor is not in a
20076 table, but before checking if the cursor is in a headline or if global cycling
20077 should be done.
20078 If any function in this hook returns t, not other actions like visibility
20079 cycling will be done.")
20081 (defvar org-tab-after-check-for-cycling-hook nil
20082 "Hook for functions to attach themselves to TAB.
20083 See `org-ctrl-c-ctrl-c-hook' for more information.
20084 This hook runs after it has been established that not table field motion and
20085 not visibility should be done because of current context. This is probably
20086 the place where a package like yasnippets can hook in.")
20088 (defvar org-tab-before-tab-emulation-hook nil
20089 "Hook for functions to attach themselves to TAB.
20090 See `org-ctrl-c-ctrl-c-hook' for more information.
20091 This hook runs after every other options for TAB have been exhausted, but
20092 before indentation and \t insertion takes place.")
20094 (defvar org-metaleft-hook nil
20095 "Hook for functions attaching themselves to `M-left'.
20096 See `org-ctrl-c-ctrl-c-hook' for more information.")
20097 (defvar org-metaright-hook nil
20098 "Hook for functions attaching themselves to `M-right'.
20099 See `org-ctrl-c-ctrl-c-hook' for more information.")
20100 (defvar org-metaup-hook nil
20101 "Hook for functions attaching themselves to `M-up'.
20102 See `org-ctrl-c-ctrl-c-hook' for more information.")
20103 (defvar org-metadown-hook nil
20104 "Hook for functions attaching themselves to `M-down'.
20105 See `org-ctrl-c-ctrl-c-hook' for more information.")
20106 (defvar org-shiftmetaleft-hook nil
20107 "Hook for functions attaching themselves to `M-S-left'.
20108 See `org-ctrl-c-ctrl-c-hook' for more information.")
20109 (defvar org-shiftmetaright-hook nil
20110 "Hook for functions attaching themselves to `M-S-right'.
20111 See `org-ctrl-c-ctrl-c-hook' for more information.")
20112 (defvar org-shiftmetaup-hook nil
20113 "Hook for functions attaching themselves to `M-S-up'.
20114 See `org-ctrl-c-ctrl-c-hook' for more information.")
20115 (defvar org-shiftmetadown-hook nil
20116 "Hook for functions attaching themselves to `M-S-down'.
20117 See `org-ctrl-c-ctrl-c-hook' for more information.")
20118 (defvar org-metareturn-hook nil
20119 "Hook for functions attaching themselves to `M-RET'.
20120 See `org-ctrl-c-ctrl-c-hook' for more information.")
20121 (defvar org-shiftup-hook nil
20122 "Hook for functions attaching themselves to `S-up'.
20123 See `org-ctrl-c-ctrl-c-hook' for more information.")
20124 (defvar org-shiftup-final-hook nil
20125 "Hook for functions attaching themselves to `S-up'.
20126 This one runs after all other options except shift-select have been excluded.
20127 See `org-ctrl-c-ctrl-c-hook' for more information.")
20128 (defvar org-shiftdown-hook nil
20129 "Hook for functions attaching themselves to `S-down'.
20130 See `org-ctrl-c-ctrl-c-hook' for more information.")
20131 (defvar org-shiftdown-final-hook nil
20132 "Hook for functions attaching themselves to `S-down'.
20133 This one runs after all other options except shift-select have been excluded.
20134 See `org-ctrl-c-ctrl-c-hook' for more information.")
20135 (defvar org-shiftleft-hook nil
20136 "Hook for functions attaching themselves to `S-left'.
20137 See `org-ctrl-c-ctrl-c-hook' for more information.")
20138 (defvar org-shiftleft-final-hook nil
20139 "Hook for functions attaching themselves to `S-left'.
20140 This one runs after all other options except shift-select have been excluded.
20141 See `org-ctrl-c-ctrl-c-hook' for more information.")
20142 (defvar org-shiftright-hook nil
20143 "Hook for functions attaching themselves to `S-right'.
20144 See `org-ctrl-c-ctrl-c-hook' for more information.")
20145 (defvar org-shiftright-final-hook nil
20146 "Hook for functions attaching themselves to `S-right'.
20147 This one runs after all other options except shift-select have been excluded.
20148 See `org-ctrl-c-ctrl-c-hook' for more information.")
20150 (defun org-modifier-cursor-error ()
20151 "Throw an error, a modified cursor command was applied in wrong context."
20152 (user-error "This command is active in special context like tables, headlines or items"))
20154 (defun org-shiftselect-error ()
20155 "Throw an error because Shift-Cursor command was applied in wrong context."
20156 (if (and (boundp 'shift-select-mode) shift-select-mode)
20157 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20158 (user-error "This command works only in special context like headlines or timestamps")))
20160 (defun org-call-for-shift-select (cmd)
20161 (let ((this-command-keys-shift-translated t))
20162 (call-interactively cmd)))
20164 (defun org-shifttab (&optional arg)
20165 "Global visibility cycling or move to previous table field.
20166 Call `org-table-previous-field' within a table.
20167 When ARG is nil, cycle globally through visibility states.
20168 When ARG is a numeric prefix, show contents of this level."
20169 (interactive "P")
20170 (cond
20171 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20172 ((integerp arg)
20173 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20174 (message "Content view to level: %d" arg)
20175 (org-content (prefix-numeric-value arg2))
20176 (org-cycle-show-empty-lines t)
20177 (setq org-cycle-global-status 'overview)))
20178 (t (call-interactively 'org-global-cycle))))
20180 (defun org-shiftmetaleft ()
20181 "Promote subtree or delete table column.
20182 Calls `org-promote-subtree', `org-outdent-item-tree', or
20183 `org-table-delete-column', depending on context. See the
20184 individual commands for more information."
20185 (interactive)
20186 (cond
20187 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20188 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20189 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20190 ((if (not (org-region-active-p)) (org-at-item-p)
20191 (save-excursion (goto-char (region-beginning))
20192 (org-at-item-p)))
20193 (call-interactively 'org-outdent-item-tree))
20194 (t (org-modifier-cursor-error))))
20196 (defun org-shiftmetaright ()
20197 "Demote subtree or insert table column.
20198 Calls `org-demote-subtree', `org-indent-item-tree', or
20199 `org-table-insert-column', depending on context. See the
20200 individual commands for more information."
20201 (interactive)
20202 (cond
20203 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20204 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20205 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20206 ((if (not (org-region-active-p)) (org-at-item-p)
20207 (save-excursion (goto-char (region-beginning))
20208 (org-at-item-p)))
20209 (call-interactively 'org-indent-item-tree))
20210 (t (org-modifier-cursor-error))))
20212 (defun org-shiftmetaup (&optional arg)
20213 "Drag the line at point up.
20214 In a table, kill the current row.
20215 On a clock timestamp, update the value of the timestamp like `S-<up>'
20216 but also adjust the previous clocked item in the clock history.
20217 Everywhere else, drag the line at point up."
20218 (interactive "P")
20219 (cond
20220 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20221 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20222 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20223 (call-interactively 'org-timestamp-up)))
20224 (t (call-interactively 'org-drag-line-backward))))
20226 (defun org-shiftmetadown (&optional arg)
20227 "Drag the line at point down.
20228 In a table, insert an empty row at the current line.
20229 On a clock timestamp, update the value of the timestamp like `S-<down>'
20230 but also adjust the previous clocked item in the clock history.
20231 Everywhere else, drag the line at point down."
20232 (interactive "P")
20233 (cond
20234 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20235 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20236 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20237 (call-interactively 'org-timestamp-down)))
20238 (t (call-interactively 'org-drag-line-forward))))
20240 (defsubst org-hidden-tree-error ()
20241 (user-error
20242 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20244 (defun org-metaleft (&optional arg)
20245 "Promote heading or move table column to left.
20246 Calls `org-do-promote' or `org-table-move-column', depending on context.
20247 With no specific context, calls the Emacs default `backward-word'.
20248 See the individual commands for more information."
20249 (interactive "P")
20250 (cond
20251 ((run-hook-with-args-until-success 'org-metaleft-hook))
20252 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20253 ((org-with-limited-levels
20254 (or (org-at-heading-p)
20255 (and (org-region-active-p)
20256 (save-excursion
20257 (goto-char (region-beginning))
20258 (org-at-heading-p)))))
20259 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20260 (call-interactively 'org-do-promote))
20261 ;; At an inline task.
20262 ((org-at-heading-p)
20263 (call-interactively 'org-inlinetask-promote))
20264 ((or (org-at-item-p)
20265 (and (org-region-active-p)
20266 (save-excursion
20267 (goto-char (region-beginning))
20268 (org-at-item-p))))
20269 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20270 (call-interactively 'org-outdent-item))
20271 (t (call-interactively 'backward-word))))
20273 (defun org-metaright (&optional arg)
20274 "Demote a subtree, a list item or move table column to right.
20275 In front of a drawer or a block keyword, indent it correctly.
20276 With no specific context, calls the Emacs default `forward-word'.
20277 See the individual commands for more information."
20278 (interactive "P")
20279 (cond
20280 ((run-hook-with-args-until-success 'org-metaright-hook))
20281 ((org-at-table-p) (call-interactively 'org-table-move-column))
20282 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20283 ((org-at-block-p) (call-interactively 'org-indent-block))
20284 ((org-with-limited-levels
20285 (or (org-at-heading-p)
20286 (and (org-region-active-p)
20287 (save-excursion
20288 (goto-char (region-beginning))
20289 (org-at-heading-p)))))
20290 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20291 (call-interactively 'org-do-demote))
20292 ;; At an inline task.
20293 ((org-at-heading-p)
20294 (call-interactively 'org-inlinetask-demote))
20295 ((or (org-at-item-p)
20296 (and (org-region-active-p)
20297 (save-excursion
20298 (goto-char (region-beginning))
20299 (org-at-item-p))))
20300 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20301 (call-interactively 'org-indent-item))
20302 (t (call-interactively 'forward-word))))
20304 (defun org-check-for-hidden (what)
20305 "Check if there are hidden headlines/items in the current visual line.
20306 WHAT can be either `headlines' or `items'. If the current line is
20307 an outline or item heading and it has a folded subtree below it,
20308 this function returns t, nil otherwise."
20309 (let ((re (cond
20310 ((eq what 'headlines) org-outline-regexp-bol)
20311 ((eq what 'items) (org-item-beginning-re))
20312 (t (error "This should not happen"))))
20313 beg end)
20314 (save-excursion
20315 (catch 'exit
20316 (unless (org-region-active-p)
20317 (setq beg (point-at-bol))
20318 (beginning-of-line 2)
20319 (while (and (not (eobp)) ;; this is like `next-line'
20320 (get-char-property (1- (point)) 'invisible))
20321 (beginning-of-line 2))
20322 (setq end (point))
20323 (goto-char beg)
20324 (goto-char (point-at-eol))
20325 (setq end (max end (point)))
20326 (while (re-search-forward re end t)
20327 (if (get-char-property (match-beginning 0) 'invisible)
20328 (throw 'exit t))))
20329 nil))))
20331 (defun org-metaup (&optional arg)
20332 "Move subtree up or move table row up.
20333 Calls `org-move-subtree-up' or `org-table-move-row' or
20334 `org-move-item-up', depending on context. See the individual commands
20335 for more information."
20336 (interactive "P")
20337 (cond
20338 ((run-hook-with-args-until-success 'org-metaup-hook))
20339 ((org-region-active-p)
20340 (let* ((a (min (region-beginning) (region-end)))
20341 (b (1- (max (region-beginning) (region-end))))
20342 (c (save-excursion (goto-char a)
20343 (move-beginning-of-line 0)))
20344 (d (save-excursion (goto-char a)
20345 (move-end-of-line 0) (point))))
20346 (transpose-regions a b c d)
20347 (goto-char c)))
20348 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20349 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20350 ((org-at-item-p) (call-interactively 'org-move-item-up))
20351 (t (org-drag-element-backward))))
20353 (defun org-metadown (&optional arg)
20354 "Move subtree down or move table row down.
20355 Calls `org-move-subtree-down' or `org-table-move-row' or
20356 `org-move-item-down', depending on context. See the individual
20357 commands for more information."
20358 (interactive "P")
20359 (cond
20360 ((run-hook-with-args-until-success 'org-metadown-hook))
20361 ((org-region-active-p)
20362 (let* ((a (min (region-beginning) (region-end)))
20363 (b (max (region-beginning) (region-end)))
20364 (c (save-excursion (goto-char b)
20365 (move-beginning-of-line 1)))
20366 (d (save-excursion (goto-char b)
20367 (move-end-of-line 1) (1+ (point)))))
20368 (transpose-regions a b c d)
20369 (goto-char d)))
20370 ((org-at-table-p) (call-interactively 'org-table-move-row))
20371 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20372 ((org-at-item-p) (call-interactively 'org-move-item-down))
20373 (t (org-drag-element-forward))))
20375 (defun org-shiftup (&optional arg)
20376 "Increase item in timestamp or increase priority of current headline.
20377 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20378 depending on context. See the individual commands for more information."
20379 (interactive "P")
20380 (cond
20381 ((run-hook-with-args-until-success 'org-shiftup-hook))
20382 ((and org-support-shift-select (org-region-active-p))
20383 (org-call-for-shift-select 'previous-line))
20384 ((org-at-timestamp-p t)
20385 (call-interactively (if org-edit-timestamp-down-means-later
20386 'org-timestamp-down 'org-timestamp-up)))
20387 ((and (not (eq org-support-shift-select 'always))
20388 org-enable-priority-commands
20389 (org-at-heading-p))
20390 (call-interactively 'org-priority-up))
20391 ((and (not org-support-shift-select) (org-at-item-p))
20392 (call-interactively 'org-previous-item))
20393 ((org-clocktable-try-shift 'up arg))
20394 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20395 (org-support-shift-select
20396 (org-call-for-shift-select 'previous-line))
20397 (t (org-shiftselect-error))))
20399 (defun org-shiftdown (&optional arg)
20400 "Decrease item in timestamp or decrease priority of current headline.
20401 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20402 depending on context. See the individual commands for more information."
20403 (interactive "P")
20404 (cond
20405 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20406 ((and org-support-shift-select (org-region-active-p))
20407 (org-call-for-shift-select 'next-line))
20408 ((org-at-timestamp-p t)
20409 (call-interactively (if org-edit-timestamp-down-means-later
20410 'org-timestamp-up 'org-timestamp-down)))
20411 ((and (not (eq org-support-shift-select 'always))
20412 org-enable-priority-commands
20413 (org-at-heading-p))
20414 (call-interactively 'org-priority-down))
20415 ((and (not org-support-shift-select) (org-at-item-p))
20416 (call-interactively 'org-next-item))
20417 ((org-clocktable-try-shift 'down arg))
20418 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20419 (org-support-shift-select
20420 (org-call-for-shift-select 'next-line))
20421 (t (org-shiftselect-error))))
20423 (defun org-shiftright (&optional arg)
20424 "Cycle the thing at point or in the current line, depending on context.
20425 Depending on context, this does one of the following:
20427 - switch a timestamp at point one day into the future
20428 - on a headline, switch to the next TODO keyword.
20429 - on an item, switch entire list to the next bullet type
20430 - on a property line, switch to the next allowed value
20431 - on a clocktable definition line, move time block into the future"
20432 (interactive "P")
20433 (cond
20434 ((run-hook-with-args-until-success 'org-shiftright-hook))
20435 ((and org-support-shift-select (org-region-active-p))
20436 (org-call-for-shift-select 'forward-char))
20437 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20438 ((and (not (eq org-support-shift-select 'always))
20439 (org-at-heading-p))
20440 (let ((org-inhibit-logging
20441 (not org-treat-S-cursor-todo-selection-as-state-change))
20442 (org-inhibit-blocking
20443 (not org-treat-S-cursor-todo-selection-as-state-change)))
20444 (org-call-with-arg 'org-todo 'right)))
20445 ((or (and org-support-shift-select
20446 (not (eq org-support-shift-select 'always))
20447 (org-at-item-bullet-p))
20448 (and (not org-support-shift-select) (org-at-item-p)))
20449 (org-call-with-arg 'org-cycle-list-bullet nil))
20450 ((and (not (eq org-support-shift-select 'always))
20451 (org-at-property-p))
20452 (call-interactively 'org-property-next-allowed-value))
20453 ((org-clocktable-try-shift 'right arg))
20454 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20455 (org-support-shift-select
20456 (org-call-for-shift-select 'forward-char))
20457 (t (org-shiftselect-error))))
20459 (defun org-shiftleft (&optional arg)
20460 "Cycle the thing at point or in the current line, depending on context.
20461 Depending on context, this does one of the following:
20463 - switch a timestamp at point one day into the past
20464 - on a headline, switch to the previous TODO keyword.
20465 - on an item, switch entire list to the previous bullet type
20466 - on a property line, switch to the previous allowed value
20467 - on a clocktable definition line, move time block into the past"
20468 (interactive "P")
20469 (cond
20470 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20471 ((and org-support-shift-select (org-region-active-p))
20472 (org-call-for-shift-select 'backward-char))
20473 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20474 ((and (not (eq org-support-shift-select 'always))
20475 (org-at-heading-p))
20476 (let ((org-inhibit-logging
20477 (not org-treat-S-cursor-todo-selection-as-state-change))
20478 (org-inhibit-blocking
20479 (not org-treat-S-cursor-todo-selection-as-state-change)))
20480 (org-call-with-arg 'org-todo 'left)))
20481 ((or (and org-support-shift-select
20482 (not (eq org-support-shift-select 'always))
20483 (org-at-item-bullet-p))
20484 (and (not org-support-shift-select) (org-at-item-p)))
20485 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20486 ((and (not (eq org-support-shift-select 'always))
20487 (org-at-property-p))
20488 (call-interactively 'org-property-previous-allowed-value))
20489 ((org-clocktable-try-shift 'left arg))
20490 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20491 (org-support-shift-select
20492 (org-call-for-shift-select 'backward-char))
20493 (t (org-shiftselect-error))))
20495 (defun org-shiftcontrolright ()
20496 "Switch to next TODO set."
20497 (interactive)
20498 (cond
20499 ((and org-support-shift-select (org-region-active-p))
20500 (org-call-for-shift-select 'forward-word))
20501 ((and (not (eq org-support-shift-select 'always))
20502 (org-at-heading-p))
20503 (org-call-with-arg 'org-todo 'nextset))
20504 (org-support-shift-select
20505 (org-call-for-shift-select 'forward-word))
20506 (t (org-shiftselect-error))))
20508 (defun org-shiftcontrolleft ()
20509 "Switch to previous TODO set."
20510 (interactive)
20511 (cond
20512 ((and org-support-shift-select (org-region-active-p))
20513 (org-call-for-shift-select 'backward-word))
20514 ((and (not (eq org-support-shift-select 'always))
20515 (org-at-heading-p))
20516 (org-call-with-arg 'org-todo 'previousset))
20517 (org-support-shift-select
20518 (org-call-for-shift-select 'backward-word))
20519 (t (org-shiftselect-error))))
20521 (defun org-shiftcontrolup (&optional n)
20522 "Change timestamps synchronously up in CLOCK log lines.
20523 Optional argument N tells to change by that many units."
20524 (interactive "P")
20525 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20526 (let (org-support-shift-select)
20527 (org-clock-timestamps-up n))
20528 (user-error "Not at a clock log")))
20530 (defun org-shiftcontroldown (&optional n)
20531 "Change timestamps synchronously down in CLOCK log lines.
20532 Optional argument N tells to change by that many units."
20533 (interactive "P")
20534 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20535 (let (org-support-shift-select)
20536 (org-clock-timestamps-down n))
20537 (user-error "Not at a clock log")))
20539 (defun org-increase-number-at-point (&optional inc)
20540 "Increment the number at point.
20541 With an optional prefix numeric argument INC, increment using
20542 this numeric value."
20543 (interactive "p")
20544 (if (not (number-at-point))
20545 (user-error "Not on a number")
20546 (unless inc (setq inc 1))
20547 (let ((pos (point))
20548 (beg (skip-chars-backward "-+^/*0-9eE."))
20549 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20550 (setq nap (buffer-substring-no-properties
20551 (+ pos beg) (+ pos beg end)))
20552 (delete-region (+ pos beg) (+ pos beg end))
20553 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20554 (when (org-at-table-p)
20555 (org-table-align)
20556 (org-table-end-of-field 1))))
20558 (defun org-decrease-number-at-point (&optional inc)
20559 "Decrement the number at point.
20560 With an optional prefix numeric argument INC, decrement using
20561 this numeric value."
20562 (interactive "p")
20563 (org-increase-number-at-point (- inc)))
20565 (defun org-ctrl-c-ret ()
20566 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20567 (interactive)
20568 (cond
20569 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20570 (t (call-interactively 'org-insert-heading))))
20572 (defun org-find-visible ()
20573 (let ((s (point)))
20574 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20575 (get-char-property s 'invisible)))
20577 (defun org-find-invisible ()
20578 (let ((s (point)))
20579 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20580 (not (get-char-property s 'invisible))))
20583 (defun org-copy-visible (beg end)
20584 "Copy the visible parts of the region."
20585 (interactive "r")
20586 (let (snippets s)
20587 (save-excursion
20588 (save-restriction
20589 (narrow-to-region beg end)
20590 (setq s (goto-char (point-min)))
20591 (while (not (= (point) (point-max)))
20592 (goto-char (org-find-invisible))
20593 (push (buffer-substring s (point)) snippets)
20594 (setq s (goto-char (org-find-visible))))))
20595 (kill-new (apply 'concat (nreverse snippets)))))
20597 (defun org-copy-special ()
20598 "Copy region in table or copy current subtree.
20599 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20600 See the individual commands for more information."
20601 (interactive)
20602 (call-interactively
20603 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20605 (defun org-cut-special ()
20606 "Cut region in table or cut current subtree.
20607 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20608 See the individual commands for more information."
20609 (interactive)
20610 (call-interactively
20611 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20613 (defun org-paste-special (arg)
20614 "Paste rectangular region into table, or past subtree relative to level.
20615 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20616 See the individual commands for more information."
20617 (interactive "P")
20618 (if (org-at-table-p)
20619 (org-table-paste-rectangle)
20620 (org-paste-subtree arg)))
20622 (defsubst org-in-fixed-width-region-p ()
20623 "Is point in a fixed-width region?"
20624 (save-match-data
20625 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20627 (defun org-edit-special (&optional arg)
20628 "Call a special editor for the element at point.
20629 When at a table, call the formula editor with `org-table-edit-formulas'.
20630 When in a source code block, call `org-edit-src-code'.
20631 When in a fixed-width region, call `org-edit-fixed-width-region'.
20632 When in an export block, call `org-edit-export-block'.
20633 When at an #+INCLUDE keyword, visit the included file.
20634 On a link, call `ffap' to visit the link at point.
20635 Otherwise, return a user error."
20636 (interactive "P")
20637 (let ((element (org-element-at-point)))
20638 (assert (not buffer-read-only) nil
20639 "Buffer is read-only: %s" (buffer-name))
20640 (case (org-element-type element)
20641 (src-block
20642 (if (not arg) (org-edit-src-code)
20643 (let* ((info (org-babel-get-src-block-info))
20644 (lang (nth 0 info))
20645 (params (nth 2 info))
20646 (session (cdr (assq :session params))))
20647 (if (not session) (org-edit-src-code)
20648 ;; At a src-block with a session and function called with
20649 ;; an ARG: switch to the buffer related to the inferior
20650 ;; process.
20651 (switch-to-buffer
20652 (funcall (intern (concat "org-babel-prep-session:" lang))
20653 session params))))))
20654 (keyword
20655 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20656 (org-open-link-from-string
20657 (format "[[%s]]"
20658 (expand-file-name
20659 (let ((value (org-element-property :value element)))
20660 (cond ((not (org-string-nw-p value))
20661 (user-error "No file to edit"))
20662 ((string-match "\\`\"\\(.*?\\)\"" value)
20663 (match-string 1 value))
20664 ((string-match "\\`[^ \t\"]\\S-*" value)
20665 (match-string 0 value))
20666 (t (user-error "No valid file specified")))))))
20667 (user-error "No special environment to edit here")))
20668 (table
20669 (if (eq (org-element-property :type element) 'table.el)
20670 (org-edit-table.el)
20671 (call-interactively 'org-table-edit-formulas)))
20672 ;; Only Org tables contain `table-row' type elements.
20673 (table-row (call-interactively 'org-table-edit-formulas))
20674 ((example-block src-block) (org-edit-src-code))
20675 (export-block (org-edit-export-block))
20676 (fixed-width (org-edit-fixed-width-region))
20677 (otherwise
20678 ;; No notable element at point. Though, we may be at a link,
20679 ;; which is an object. Thus, scan deeper.
20680 (if (eq (org-element-type (org-element-context element)) 'link)
20681 (call-interactively 'ffap)
20682 (user-error "No special environment to edit here"))))))
20684 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20685 (defun org-ctrl-c-ctrl-c (&optional arg)
20686 "Set tags in headline, or update according to changed information at point.
20688 This command does many different things, depending on context:
20690 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20691 this is what we do.
20693 - If the cursor is on a statistics cookie, update it.
20695 - If the cursor is in a headline, prompt for tags and insert them
20696 into the current line, aligned to `org-tags-column'. When called
20697 with prefix arg, realign all tags in the current buffer.
20699 - If the cursor is in one of the special #+KEYWORD lines, this
20700 triggers scanning the buffer for these lines and updating the
20701 information.
20703 - If the cursor is inside a table, realign the table. This command
20704 works even if the automatic table editor has been turned off.
20706 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20707 the entire table.
20709 - If the cursor is at a footnote reference or definition, jump to
20710 the corresponding definition or references, respectively.
20712 - If the cursor is a the beginning of a dynamic block, update it.
20714 - If the current buffer is a capture buffer, close note and file it.
20716 - If the cursor is on a <<<target>>>, update radio targets and
20717 corresponding links in this buffer.
20719 - If the cursor is on a numbered item in a plain list, renumber the
20720 ordered list.
20722 - If the cursor is on a checkbox, toggle it.
20724 - If the cursor is on a code block, evaluate it. The variable
20725 `org-confirm-babel-evaluate' can be used to control prompting
20726 before code block evaluation, by default every code block
20727 evaluation requires confirmation. Code block evaluation can be
20728 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20729 (interactive "P")
20730 (cond
20731 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20732 org-occur-highlights)
20733 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20734 (org-remove-occur-highlights)
20735 (message "Temporary highlights/overlays removed from current buffer"))
20736 ((and (local-variable-p 'org-finish-function (current-buffer))
20737 (fboundp org-finish-function))
20738 (funcall org-finish-function))
20739 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20741 (let* ((context (org-element-context)) (type (org-element-type context)))
20742 ;; Test if point is within a blank line.
20743 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20744 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20745 (user-error "C-c C-c can do nothing useful at this location"))
20746 (case type
20747 ;; When at a link, act according to the parent instead.
20748 (link (setq context (org-element-property :parent context))
20749 (setq type (org-element-type context)))
20750 ;; Unsupported object types: refer to the first supported
20751 ;; element or object containing it.
20752 ((bold code entity export-snippet inline-babel-call inline-src-block
20753 italic latex-fragment line-break macro strike-through subscript
20754 superscript underline verbatim)
20755 (while (and (setq context (org-element-property :parent context))
20756 (not (memq (setq type (org-element-type context))
20757 '(radio-target paragraph verse-block
20758 table-cell)))))))
20759 ;; For convenience: at the first line of a paragraph on the
20760 ;; same line as an item, apply function on that item instead.
20761 (when (eq type 'paragraph)
20762 (let ((parent (org-element-property :parent context)))
20763 (when (and (eq (org-element-type parent) 'item)
20764 (= (point-at-bol) (org-element-property :begin parent)))
20765 (setq context parent type 'item))))
20766 ;; Act according to type of element or object at point.
20767 (case type
20768 (clock (org-clock-update-time-maybe))
20769 (dynamic-block
20770 (save-excursion
20771 (goto-char (org-element-property :post-affiliated context))
20772 (org-update-dblock)))
20773 (footnote-definition
20774 (goto-char (org-element-property :post-affiliated context))
20775 (call-interactively 'org-footnote-action))
20776 (footnote-reference (call-interactively 'org-footnote-action))
20777 ((headline inlinetask)
20778 (save-excursion (goto-char (org-element-property :begin context))
20779 (call-interactively 'org-set-tags)))
20780 (item
20781 ;; At an item: a double C-u set checkbox to "[-]"
20782 ;; unconditionally, whereas a single one will toggle its
20783 ;; presence. Without an universal argument, if the item
20784 ;; has a checkbox, toggle it. Otherwise repair the list.
20785 (let* ((box (org-element-property :checkbox context))
20786 (struct (org-element-property :structure context))
20787 (old-struct (copy-tree struct))
20788 (parents (org-list-parents-alist struct))
20789 (prevs (org-list-prevs-alist struct))
20790 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20791 (org-list-set-checkbox
20792 (org-element-property :begin context) struct
20793 (cond ((equal arg '(16)) "[-]")
20794 ((and (not box) (equal arg '(4))) "[ ]")
20795 ((or (not box) (equal arg '(4))) nil)
20796 ((eq box 'on) "[ ]")
20797 (t "[X]")))
20798 ;; Mimic `org-list-write-struct' but with grabbing
20799 ;; a return value from `org-list-struct-fix-box'.
20800 (org-list-struct-fix-ind struct parents 2)
20801 (org-list-struct-fix-item-end struct)
20802 (org-list-struct-fix-bul struct prevs)
20803 (org-list-struct-fix-ind struct parents)
20804 (let ((block-item
20805 (org-list-struct-fix-box struct parents prevs orderedp)))
20806 (if (and box (equal struct old-struct))
20807 (if (equal arg '(16))
20808 (message "Checkboxes already reset")
20809 (user-error "Cannot toggle this checkbox: %s"
20810 (if (eq box 'on)
20811 "all subitems checked"
20812 "unchecked subitems")))
20813 (org-list-struct-apply-struct struct old-struct)
20814 (org-update-checkbox-count-maybe))
20815 (when block-item
20816 (message "Checkboxes were removed due to empty box at line %d"
20817 (org-current-line block-item))))))
20818 (keyword
20819 (let ((org-inhibit-startup-visibility-stuff t)
20820 (org-startup-align-all-tables nil))
20821 (when (boundp 'org-table-coordinate-overlays)
20822 (mapc 'delete-overlay org-table-coordinate-overlays)
20823 (setq org-table-coordinate-overlays nil))
20824 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20825 (message "Local setup has been refreshed"))
20826 (plain-list
20827 ;; At a plain list, with a double C-u argument, set
20828 ;; checkboxes of each item to "[-]", whereas a single one
20829 ;; will toggle their presence according to the state of the
20830 ;; first item in the list. Without an argument, repair the
20831 ;; list.
20832 (let* ((begin (org-element-property :contents-begin context))
20833 (beginm (move-marker (make-marker) begin))
20834 (struct (org-element-property :structure context))
20835 (old-struct (copy-tree struct))
20836 (first-box (save-excursion
20837 (goto-char begin)
20838 (looking-at org-list-full-item-re)
20839 (match-string-no-properties 3)))
20840 (new-box (cond ((equal arg '(16)) "[-]")
20841 ((equal arg '(4)) (unless first-box "[ ]"))
20842 ((equal first-box "[X]") "[ ]")
20843 (t "[X]"))))
20844 (cond
20845 (arg
20846 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20847 (org-list-get-all-items
20848 begin struct (org-list-prevs-alist struct))))
20849 ((and first-box (eq (point) begin))
20850 ;; For convenience, when point is at bol on the first
20851 ;; item of the list and no argument is provided, simply
20852 ;; toggle checkbox of that item, if any.
20853 (org-list-set-checkbox begin struct new-box)))
20854 (org-list-write-struct
20855 struct (org-list-parents-alist struct) old-struct)
20856 (org-update-checkbox-count-maybe)
20857 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20858 ((property-drawer node-property)
20859 (call-interactively 'org-property-action))
20860 ((radio-target target)
20861 (call-interactively 'org-update-radio-target-regexp))
20862 (statistics-cookie
20863 (call-interactively 'org-update-statistics-cookies))
20864 ((table table-cell table-row)
20865 ;; At a table, recalculate every field and align it. Also
20866 ;; send the table if necessary. If the table has
20867 ;; a `table.el' type, just give up. At a table row or
20868 ;; cell, maybe recalculate line but always align table.
20869 (if (eq (org-element-property :type context) 'table.el)
20870 (message "Use C-c ' to edit table.el tables")
20871 (let ((org-enable-table-editor t))
20872 (if (or (eq type 'table)
20873 ;; Check if point is at a TBLFM line.
20874 (and (eq type 'table-row)
20875 (= (point) (org-element-property :end context))))
20876 (save-excursion
20877 (if (org-at-TBLFM-p)
20878 (progn (require 'org-table)
20879 (org-table-calc-current-TBLFM))
20880 (goto-char (org-element-property :contents-begin context))
20881 (org-call-with-arg 'org-table-recalculate (or arg t))
20882 (orgtbl-send-table 'maybe)))
20883 (org-table-maybe-eval-formula)
20884 (cond (arg (call-interactively 'org-table-recalculate))
20885 ((org-table-maybe-recalculate-line))
20886 (t (org-table-align)))))))
20887 (timestamp (org-timestamp-change 0 'day))
20888 (otherwise
20889 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20890 (user-error
20891 "C-c C-c can do nothing useful at this location")))))))))
20893 (defun org-mode-restart ()
20894 (interactive)
20895 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20896 (funcall major-mode)
20897 (hack-local-variables)
20898 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20899 (org-indent-mode -1)))
20900 (message "%s restarted" major-mode))
20902 (defun org-kill-note-or-show-branches ()
20903 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20904 (interactive)
20905 (if (not org-finish-function)
20906 (progn
20907 (hide-subtree)
20908 (call-interactively 'show-branches))
20909 (let ((org-note-abort t))
20910 (funcall org-finish-function))))
20912 (defun org-open-line (n)
20913 "Insert a new row in tables, call `open-line' elsewhere.
20914 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20915 (interactive "*p")
20916 (cond
20917 ((not org-special-ctrl-o)
20918 (open-line n))
20919 ((org-at-table-p)
20920 (org-table-insert-row))
20922 (open-line n))))
20924 (defun org-return (&optional indent)
20925 "Goto next table row or insert a newline.
20927 Calls `org-table-next-row' or `newline', depending on context.
20929 When optional INDENT argument is non-nil, call
20930 `newline-and-indent' instead of `newline'.
20932 When `org-return-follows-link' is non-nil and point is on
20933 a timestamp or a link, call `org-open-at-point'. However, it
20934 will not happen if point is in a table or on a \"dead\"
20935 object (e.g., within a comment). In these case, you need to use
20936 `org-open-at-point' directly."
20937 (interactive)
20938 (if (and (save-excursion
20939 (beginning-of-line)
20940 (looking-at org-todo-line-regexp))
20941 (match-beginning 3)
20942 (>= (point) (match-beginning 3)))
20943 ;; Point is on headline tags. Do not break them: add a newline
20944 ;; after the headline instead.
20945 (progn (org-show-entry)
20946 (end-of-line)
20947 (if indent (newline-and-indent) (newline)))
20948 (let* ((context (if org-return-follows-link (org-element-context)
20949 (org-element-at-point)))
20950 (type (org-element-type context)))
20951 (cond
20952 ;; In a table, call `org-table-next-row'.
20953 ((or (and (eq type 'table)
20954 (>= (point) (org-element-property :contents-begin context))
20955 (< (point) (org-element-property :contents-end context)))
20956 (org-element-lineage context '(table-row table-cell) t))
20957 (org-table-justify-field-maybe)
20958 (call-interactively #'org-table-next-row))
20959 ;; On a link or a timestamp but not on white spaces after it,
20960 ;; call `org-open-line' if `org-return-follows-link' allows it.
20961 ((and org-return-follows-link
20962 (memq type '(link timestamp))
20963 (< (point)
20964 (save-excursion (goto-char (org-element-property :end context))
20965 (skip-chars-backward " \t")
20966 (point))))
20967 (call-interactively #'org-open-at-point))
20968 ;; In a list, make sure indenting keeps trailing text within.
20969 ((and indent
20970 (not (eolp))
20971 (org-element-lineage context '(item plain-list) t))
20972 (let ((trailing-data
20973 (delete-and-extract-region (point) (line-end-position))))
20974 (newline-and-indent)
20975 (save-excursion (insert trailing-data))))
20976 (t (if indent (newline-and-indent) (newline)))))))
20978 (defun org-return-indent ()
20979 "Goto next table row or insert a newline and indent.
20980 Calls `org-table-next-row' or `newline-and-indent', depending on
20981 context. See the individual commands for more information."
20982 (interactive)
20983 (org-return t))
20985 (defun org-ctrl-c-star ()
20986 "Compute table, or change heading status of lines.
20987 Calls `org-table-recalculate' or `org-toggle-heading',
20988 depending on context."
20989 (interactive)
20990 (cond
20991 ((org-at-table-p)
20992 (call-interactively 'org-table-recalculate))
20994 ;; Convert all lines in region to list items
20995 (call-interactively 'org-toggle-heading))))
20997 (defun org-ctrl-c-minus ()
20998 "Insert separator line in table or modify bullet status of line.
20999 Also turns a plain line or a region of lines into list items.
21000 Calls `org-table-insert-hline', `org-toggle-item', or
21001 `org-cycle-list-bullet', depending on context."
21002 (interactive)
21003 (cond
21004 ((org-at-table-p)
21005 (call-interactively 'org-table-insert-hline))
21006 ((org-region-active-p)
21007 (call-interactively 'org-toggle-item))
21008 ((org-in-item-p)
21009 (call-interactively 'org-cycle-list-bullet))
21011 (call-interactively 'org-toggle-item))))
21013 (defun org-toggle-item (arg)
21014 "Convert headings or normal lines to items, items to normal lines.
21015 If there is no active region, only the current line is considered.
21017 If the first non blank line in the region is a headline, convert
21018 all headlines to items, shifting text accordingly.
21020 If it is an item, convert all items to normal lines.
21022 If it is normal text, change region into a list of items.
21023 With a prefix argument ARG, change the region in a single item."
21024 (interactive "P")
21025 (let ((shift-text
21026 (function
21027 ;; Shift text in current section to IND, from point to END.
21028 ;; The function leaves point to END line.
21029 (lambda (ind end)
21030 (let ((min-i 1000) (end (copy-marker end)))
21031 ;; First determine the minimum indentation (MIN-I) of
21032 ;; the text.
21033 (save-excursion
21034 (catch 'exit
21035 (while (< (point) end)
21036 (let ((i (org-get-indentation)))
21037 (cond
21038 ;; Skip blank lines and inline tasks.
21039 ((looking-at "^[ \t]*$"))
21040 ((looking-at org-outline-regexp-bol))
21041 ;; We can't find less than 0 indentation.
21042 ((zerop i) (throw 'exit (setq min-i 0)))
21043 ((< i min-i) (setq min-i i))))
21044 (forward-line))))
21045 ;; Then indent each line so that a line indented to
21046 ;; MIN-I becomes indented to IND. Ignore blank lines
21047 ;; and inline tasks in the process.
21048 (let ((delta (- ind min-i)))
21049 (while (< (point) end)
21050 (unless (or (looking-at "^[ \t]*$")
21051 (looking-at org-outline-regexp-bol))
21052 (org-indent-line-to (+ (org-get-indentation) delta)))
21053 (forward-line)))))))
21054 (skip-blanks
21055 (function
21056 ;; Return beginning of first non-blank line, starting from
21057 ;; line at POS.
21058 (lambda (pos)
21059 (save-excursion
21060 (goto-char pos)
21061 (skip-chars-forward " \r\t\n")
21062 (point-at-bol)))))
21063 beg end)
21064 ;; Determine boundaries of changes.
21065 (if (org-region-active-p)
21066 (setq beg (funcall skip-blanks (region-beginning))
21067 end (copy-marker (region-end)))
21068 (setq beg (funcall skip-blanks (point-at-bol))
21069 end (copy-marker (point-at-eol))))
21070 ;; Depending on the starting line, choose an action on the text
21071 ;; between BEG and END.
21072 (org-with-limited-levels
21073 (save-excursion
21074 (goto-char beg)
21075 (cond
21076 ;; Case 1. Start at an item: de-itemize. Note that it only
21077 ;; happens when a region is active: `org-ctrl-c-minus'
21078 ;; would call `org-cycle-list-bullet' otherwise.
21079 ((org-at-item-p)
21080 (while (< (point) end)
21081 (when (org-at-item-p)
21082 (skip-chars-forward " \t")
21083 (delete-region (point) (match-end 0)))
21084 (forward-line)))
21085 ;; Case 2. Start at an heading: convert to items.
21086 ((org-at-heading-p)
21087 (let* ((bul (org-list-bullet-string "-"))
21088 (bul-len (length bul))
21089 (done (org-entry-is-done-p))
21090 (todo (org-entry-is-todo-p))
21091 ;; Indentation of the first heading. It should be
21092 ;; relative to the indentation of its parent, if any.
21093 (start-ind (save-excursion
21094 (cond
21095 ((not org-adapt-indentation) 0)
21096 ((not (outline-previous-heading)) 0)
21097 (t (length (match-string 0))))))
21098 ;; Level of first heading. Further headings will be
21099 ;; compared to it to determine hierarchy in the list.
21100 (ref-level (org-reduced-level (org-outline-level))))
21101 (when (or done todo) (org-todo ""))
21102 (while (< (point) end)
21103 (let* ((level (org-reduced-level (org-outline-level)))
21104 (delta (max 0 (- level ref-level))))
21105 ;; If current headline is less indented than the first
21106 ;; one, set it as reference, in order to preserve
21107 ;; subtrees.
21108 (when (< level ref-level) (setq ref-level level))
21109 (replace-match bul t t)
21110 (org-indent-line-to (+ start-ind (* delta bul-len)))
21111 (when (or done todo)
21112 (let* ((struct (org-list-struct))
21113 (old (copy-tree struct)))
21114 (org-list-set-checkbox (line-beginning-position)
21115 struct
21116 (if done "[X]" "[ ]"))
21117 (org-list-write-struct struct
21118 (org-list-parents-alist struct)
21119 old)))
21120 ;; Ensure all text down to END (or SECTION-END) belongs
21121 ;; to the newly created item.
21122 (let ((section-end (save-excursion
21123 (or (outline-next-heading) (point)))))
21124 (forward-line)
21125 (funcall shift-text
21126 (+ start-ind (* (1+ delta) bul-len))
21127 (min end section-end)))))))
21128 ;; Case 3. Normal line with ARG: make the first line of region
21129 ;; an item, and shift indentation of others lines to
21130 ;; set them as item's body.
21131 (arg (let* ((bul (org-list-bullet-string "-"))
21132 (bul-len (length bul))
21133 (ref-ind (org-get-indentation)))
21134 (skip-chars-forward " \t")
21135 (insert bul)
21136 (forward-line)
21137 (while (< (point) end)
21138 ;; Ensure that lines less indented than first one
21139 ;; still get included in item body.
21140 (funcall shift-text
21141 (+ ref-ind bul-len)
21142 (min end (save-excursion (or (outline-next-heading)
21143 (point)))))
21144 (forward-line))))
21145 ;; Case 4. Normal line without ARG: turn each non-item line
21146 ;; into an item.
21148 (while (< (point) end)
21149 (unless (or (org-at-heading-p) (org-at-item-p))
21150 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21151 (replace-match
21152 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21153 (forward-line))))))))
21155 (defun org-toggle-heading (&optional nstars)
21156 "Convert headings to normal text, or items or text to headings.
21157 If there is no active region, only convert the current line.
21159 With a \\[universal-argument] prefix, convert the whole list at
21160 point into heading.
21162 In a region:
21164 - If the first non blank line is a headline, remove the stars
21165 from all headlines in the region.
21167 - If it is a normal line, turn each and every normal line (i.e.,
21168 not an heading or an item) in the region into headings. If you
21169 want to convert only the first line of this region, use one
21170 universal prefix argument.
21172 - If it is a plain list item, turn all plain list items into headings.
21174 When converting a line into a heading, the number of stars is chosen
21175 such that the lines become children of the current entry. However,
21176 when a numeric prefix argument is given, its value determines the
21177 number of stars to add."
21178 (interactive "P")
21179 (let ((skip-blanks
21180 (function
21181 ;; Return beginning of first non-blank line, starting from
21182 ;; line at POS.
21183 (lambda (pos)
21184 (save-excursion
21185 (goto-char pos)
21186 (while (org-at-comment-p) (forward-line))
21187 (skip-chars-forward " \r\t\n")
21188 (point-at-bol)))))
21189 beg end toggled)
21190 ;; Determine boundaries of changes. If a universal prefix has
21191 ;; been given, put the list in a region. If region ends at a bol,
21192 ;; do not consider the last line to be in the region.
21194 (when (and current-prefix-arg (org-at-item-p))
21195 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21196 (org-mark-element))
21198 (if (org-region-active-p)
21199 (setq beg (funcall skip-blanks (region-beginning))
21200 end (copy-marker (save-excursion
21201 (goto-char (region-end))
21202 (if (bolp) (point) (point-at-eol)))))
21203 (setq beg (funcall skip-blanks (point-at-bol))
21204 end (copy-marker (point-at-eol))))
21205 ;; Ensure inline tasks don't count as headings.
21206 (org-with-limited-levels
21207 (save-excursion
21208 (goto-char beg)
21209 (cond
21210 ;; Case 1. Started at an heading: de-star headings.
21211 ((org-at-heading-p)
21212 (while (< (point) end)
21213 (when (org-at-heading-p t)
21214 (looking-at org-outline-regexp) (replace-match "")
21215 (setq toggled t))
21216 (forward-line)))
21217 ;; Case 2. Started at an item: change items into headlines.
21218 ;; One star will be added by `org-list-to-subtree'.
21219 ((org-at-item-p)
21220 (let* ((stars (make-string
21221 ;; subtract the star that will be added again by
21222 ;; `org-list-to-subtree'
21223 (if (numberp nstars) (1- nstars)
21224 (or (org-current-level) 0))
21225 ?*))
21226 (add-stars
21227 (cond (nstars "") ; stars from prefix only
21228 ((equal stars "") "") ; before first heading
21229 (org-odd-levels-only "*") ; inside heading, odd
21230 (t "")))) ; inside heading, oddeven
21231 (while (< (point) end)
21232 (when (org-at-item-p)
21233 ;; Pay attention to cases when region ends before list.
21234 (let* ((struct (org-list-struct))
21235 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21236 (save-restriction
21237 (narrow-to-region (point) list-end)
21238 (insert
21239 (org-list-to-subtree
21240 (org-list-parse-list t)
21241 '(:istart (concat stars add-stars (funcall get-stars depth))
21242 :icount (concat stars add-stars (funcall get-stars depth)))))))
21243 (setq toggled t))
21244 (forward-line))))
21245 ;; Case 3. Started at normal text: make every line an heading,
21246 ;; skipping headlines and items.
21247 (t (let* ((stars
21248 (make-string
21249 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21250 (add-stars
21251 (cond (nstars "") ; stars from prefix only
21252 ((equal stars "") "*") ; before first heading
21253 (org-odd-levels-only "**") ; inside heading, odd
21254 (t "*"))) ; inside heading, oddeven
21255 (rpl (concat stars add-stars " "))
21256 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21257 (while (< (point) (if (equal nstars '(4)) lend end))
21258 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21259 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21260 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21261 (forward-line)))))))
21262 (unless toggled (message "Cannot toggle heading from here"))))
21264 (defun org-meta-return (&optional arg)
21265 "Insert a new heading or wrap a region in a table.
21266 Calls `org-insert-heading' or `org-table-wrap-region', depending
21267 on context. See the individual commands for more information."
21268 (interactive "P")
21269 (org-check-before-invisible-edit 'insert)
21270 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21271 (let* ((element (org-element-at-point))
21272 (type (org-element-type element)))
21273 (when (eq type 'table-row)
21274 (setq element (org-element-property :parent element))
21275 (setq type 'table))
21276 (if (and (eq type 'table)
21277 (eq (org-element-property :type element) 'org)
21278 (>= (point) (org-element-property :contents-begin element))
21279 (< (point) (org-element-property :contents-end element)))
21280 (call-interactively 'org-table-wrap-region)
21281 (call-interactively 'org-insert-heading)))))
21283 ;;; Menu entries
21285 (defsubst org-in-subtree-not-table-p ()
21286 "Are we in a subtree and not in a table?"
21287 (and (not (org-before-first-heading-p))
21288 (not (org-at-table-p))))
21290 ;; Define the Org-mode menus
21291 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21292 '("Tbl"
21293 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21294 ["Next Field" org-cycle (org-at-table-p)]
21295 ["Previous Field" org-shifttab (org-at-table-p)]
21296 ["Next Row" org-return (org-at-table-p)]
21297 "--"
21298 ["Blank Field" org-table-blank-field (org-at-table-p)]
21299 ["Edit Field" org-table-edit-field (org-at-table-p)]
21300 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21301 "--"
21302 ("Column"
21303 ["Move Column Left" org-metaleft (org-at-table-p)]
21304 ["Move Column Right" org-metaright (org-at-table-p)]
21305 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21306 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21307 ("Row"
21308 ["Move Row Up" org-metaup (org-at-table-p)]
21309 ["Move Row Down" org-metadown (org-at-table-p)]
21310 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21311 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21312 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21313 "--"
21314 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21315 ("Rectangle"
21316 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21317 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21318 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21319 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21320 "--"
21321 ("Calculate"
21322 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21323 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21324 ["Edit Formulas" org-edit-special (org-at-table-p)]
21325 "--"
21326 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21327 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21328 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21329 "--"
21330 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21331 "--"
21332 ["Sum Column/Rectangle" org-table-sum
21333 (or (org-at-table-p) (org-region-active-p))]
21334 ["Which Column?" org-table-current-column (org-at-table-p)])
21335 ["Debug Formulas"
21336 org-table-toggle-formula-debugger
21337 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21338 ["Show Col/Row Numbers"
21339 org-table-toggle-coordinate-overlays
21340 :style toggle
21341 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21342 "--"
21343 ["Create" org-table-create (and (not (org-at-table-p))
21344 org-enable-table-editor)]
21345 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21346 ["Import from File" org-table-import (not (org-at-table-p))]
21347 ["Export to File" org-table-export (org-at-table-p)]
21348 "--"
21349 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21350 "--"
21351 ("Plot"
21352 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21353 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21355 (easy-menu-define org-org-menu org-mode-map "Org menu"
21356 '("Org"
21357 ("Show/Hide"
21358 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21359 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21360 ["Sparse Tree..." org-sparse-tree t]
21361 ["Reveal Context" org-reveal t]
21362 ["Show All" show-all t]
21363 "--"
21364 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21365 "--"
21366 ["New Heading" org-insert-heading t]
21367 ("Navigate Headings"
21368 ["Up" outline-up-heading t]
21369 ["Next" outline-next-visible-heading t]
21370 ["Previous" outline-previous-visible-heading t]
21371 ["Next Same Level" outline-forward-same-level t]
21372 ["Previous Same Level" outline-backward-same-level t]
21373 "--"
21374 ["Jump" org-goto t])
21375 ("Edit Structure"
21376 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21377 "--"
21378 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21379 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21380 "--"
21381 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21382 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21383 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21384 "--"
21385 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21386 "--"
21387 ["Copy visible text" org-copy-visible t]
21388 "--"
21389 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21390 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21391 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21392 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21393 "--"
21394 ["Sort Region/Children" org-sort t]
21395 "--"
21396 ["Convert to odd levels" org-convert-to-odd-levels t]
21397 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21398 ("Editing"
21399 ["Emphasis..." org-emphasize t]
21400 ["Edit Source Example" org-edit-special t]
21401 "--"
21402 ["Footnote new/jump" org-footnote-action t]
21403 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21404 ("Archive"
21405 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21406 "--"
21407 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21408 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21409 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21411 "--"
21412 ("Hyperlinks"
21413 ["Store Link (Global)" org-store-link t]
21414 ["Find existing link to here" org-occur-link-in-agenda-files t]
21415 ["Insert Link" org-insert-link t]
21416 ["Follow Link" org-open-at-point t]
21417 "--"
21418 ["Next link" org-next-link t]
21419 ["Previous link" org-previous-link t]
21420 "--"
21421 ["Descriptive Links"
21422 org-toggle-link-display
21423 :style radio
21424 :selected org-descriptive-links
21426 ["Literal Links"
21427 org-toggle-link-display
21428 :style radio
21429 :selected (not org-descriptive-links)])
21430 "--"
21431 ("TODO Lists"
21432 ["TODO/DONE/-" org-todo t]
21433 ("Select keyword"
21434 ["Next keyword" org-shiftright (org-at-heading-p)]
21435 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21436 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21437 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21438 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21439 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21440 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21441 "--"
21442 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21443 :selected org-enforce-todo-dependencies :style toggle :active t]
21444 "Settings for tree at point"
21445 ["Do Children sequentially" org-toggle-ordered-property :style radio
21446 :selected (org-entry-get nil "ORDERED")
21447 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21448 ["Do Children parallel" org-toggle-ordered-property :style radio
21449 :selected (not (org-entry-get nil "ORDERED"))
21450 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21451 "--"
21452 ["Set Priority" org-priority t]
21453 ["Priority Up" org-shiftup t]
21454 ["Priority Down" org-shiftdown t]
21455 "--"
21456 ["Get news from all feeds" org-feed-update-all t]
21457 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21458 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21459 ("TAGS and Properties"
21460 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21461 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21462 "--"
21463 ["Set property" org-set-property (not (org-before-first-heading-p))]
21464 ["Column view of properties" org-columns t]
21465 ["Insert Column View DBlock" org-insert-columns-dblock t])
21466 ("Dates and Scheduling"
21467 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21468 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21469 ("Change Date"
21470 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21471 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21472 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21473 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21474 ["Compute Time Range" org-evaluate-time-range t]
21475 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21476 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21477 "--"
21478 ["Custom time format" org-toggle-time-stamp-overlays
21479 :style radio :selected org-display-custom-times]
21480 "--"
21481 ["Goto Calendar" org-goto-calendar t]
21482 ["Date from Calendar" org-date-from-calendar t]
21483 "--"
21484 ["Start/Restart Timer" org-timer-start t]
21485 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21486 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21487 ["Insert Timer String" org-timer t]
21488 ["Insert Timer Item" org-timer-item t])
21489 ("Logging work"
21490 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21491 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21492 ["Clock out" org-clock-out t]
21493 ["Clock cancel" org-clock-cancel t]
21494 "--"
21495 ["Mark as default task" org-clock-mark-default-task t]
21496 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21497 ["Goto running clock" org-clock-goto t]
21498 "--"
21499 ["Display times" org-clock-display t]
21500 ["Create clock table" org-clock-report t]
21501 "--"
21502 ["Record DONE time"
21503 (progn (setq org-log-done (not org-log-done))
21504 (message "Switching to %s will %s record a timestamp"
21505 (car org-done-keywords)
21506 (if org-log-done "automatically" "not")))
21507 :style toggle :selected org-log-done])
21508 "--"
21509 ["Agenda Command..." org-agenda t]
21510 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21511 ("File List for Agenda")
21512 ("Special views current file"
21513 ["TODO Tree" org-show-todo-tree t]
21514 ["Check Deadlines" org-check-deadlines t]
21515 ["Timeline" org-timeline t]
21516 ["Tags/Property tree" org-match-sparse-tree t])
21517 "--"
21518 ["Export/Publish..." org-export-dispatch t]
21519 ("LaTeX"
21520 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21521 :selected org-cdlatex-mode]
21522 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21523 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21524 ["Modify math symbol" org-cdlatex-math-modify
21525 (org-inside-LaTeX-fragment-p)]
21526 ["Insert citation" org-reftex-citation t]
21527 "--"
21528 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21529 "--"
21530 ("MobileOrg"
21531 ["Push Files and Views" org-mobile-push t]
21532 ["Get Captured and Flagged" org-mobile-pull t]
21533 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21534 "--"
21535 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21536 "--"
21537 ("Documentation"
21538 ["Show Version" org-version t]
21539 ["Info Documentation" org-info t])
21540 ("Customize"
21541 ["Browse Org Group" org-customize t]
21542 "--"
21543 ["Expand This Menu" org-create-customize-menu
21544 (fboundp 'customize-menu-create)])
21545 ["Send bug report" org-submit-bug-report t]
21546 "--"
21547 ("Refresh/Reload"
21548 ["Refresh setup current buffer" org-mode-restart t]
21549 ["Reload Org (after update)" org-reload t]
21550 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21553 (defun org-info (&optional node)
21554 "Read documentation for Org-mode in the info system.
21555 With optional NODE, go directly to that node."
21556 (interactive)
21557 (info (format "(org)%s" (or node ""))))
21559 ;;;###autoload
21560 (defun org-submit-bug-report ()
21561 "Submit a bug report on Org-mode via mail.
21563 Don't hesitate to report any problems or inaccurate documentation.
21565 If you don't have setup sending mail from (X)Emacs, please copy the
21566 output buffer into your mail program, as it gives us important
21567 information about your Org-mode version and configuration."
21568 (interactive)
21569 (require 'reporter)
21570 (org-load-modules-maybe)
21571 (org-require-autoloaded-modules)
21572 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21573 (reporter-submit-bug-report
21574 "emacs-orgmode@gnu.org"
21575 (org-version nil 'full)
21576 (let (list)
21577 (save-window-excursion
21578 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21579 (delete-other-windows)
21580 (erase-buffer)
21581 (insert "You are about to submit a bug report to the Org-mode mailing list.
21583 We would like to add your full Org-mode and Outline configuration to the
21584 bug report. This greatly simplifies the work of the maintainer and
21585 other experts on the mailing list.
21587 HOWEVER, some variables you have customized may contain private
21588 information. The names of customers, colleagues, or friends, might
21589 appear in the form of file names, tags, todo states, or search strings.
21590 If you answer yes to the prompt, you might want to check and remove
21591 such private information before sending the email.")
21592 (add-text-properties (point-min) (point-max) '(face org-warning))
21593 (when (yes-or-no-p "Include your Org-mode configuration ")
21594 (mapatoms
21595 (lambda (v)
21596 (and (boundp v)
21597 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21598 (or (and (symbol-value v)
21599 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21600 (and
21601 (get v 'custom-type) (get v 'standard-value)
21602 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21603 (push v list)))))
21604 (kill-buffer (get-buffer "*Warn about privacy*"))
21605 list))
21606 nil nil
21607 "Remember to cover the basics, that is, what you expected to happen and
21608 what in fact did happen. You don't know how to make a good report? See
21610 http://orgmode.org/manual/Feedback.html#Feedback
21612 Your bug report will be posted to the Org-mode mailing list.
21613 ------------------------------------------------------------------------")
21614 (save-excursion
21615 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21616 (replace-match "\\1Bug: \\3 [\\2]")))))
21619 (defun org-install-agenda-files-menu ()
21620 (let ((bl (buffer-list)))
21621 (save-excursion
21622 (while bl
21623 (set-buffer (pop bl))
21624 (if (derived-mode-p 'org-mode) (setq bl nil)))
21625 (when (derived-mode-p 'org-mode)
21626 (easy-menu-change
21627 '("Org") "File List for Agenda"
21628 (append
21629 (list
21630 ["Edit File List" (org-edit-agenda-file-list) t]
21631 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21632 ["Remove Current File from List" org-remove-file t]
21633 ["Cycle through agenda files" org-cycle-agenda-files t]
21634 ["Occur in all agenda files" org-occur-in-agenda-files t]
21635 "--")
21636 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21638 ;;;; Documentation
21640 (defun org-require-autoloaded-modules ()
21641 (interactive)
21642 (mapc 'require
21643 '(org-agenda org-archive org-attach org-clock org-colview org-id
21644 org-table org-timer)))
21646 ;;;###autoload
21647 (defun org-reload (&optional uncompiled)
21648 "Reload all org lisp files.
21649 With prefix arg UNCOMPILED, load the uncompiled versions."
21650 (interactive "P")
21651 (require 'loadhist)
21652 (let* ((org-dir (org-find-library-dir "org"))
21653 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21654 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21655 (remove-re (mapconcat 'identity
21656 (mapcar (lambda (f) (concat "^" f "$"))
21657 (list (if (featurep 'xemacs)
21658 "org-colview"
21659 "org-colview-xemacs")
21660 "org" "org-loaddefs" "org-version"))
21661 "\\|"))
21662 (feats (delete-dups
21663 (mapcar 'file-name-sans-extension
21664 (mapcar 'file-name-nondirectory
21665 (delq nil
21666 (mapcar 'feature-file
21667 features))))))
21668 (lfeat (append
21669 (sort
21670 (setq feats
21671 (delq nil (mapcar
21672 (lambda (f)
21673 (if (and (string-match feature-re f)
21674 (not (string-match remove-re f)))
21675 f nil))
21676 feats)))
21677 'string-lessp)
21678 (list "org-version" "org")))
21679 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21680 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21681 load-uncore load-misses)
21682 (setq load-misses
21683 (delq 't
21684 (mapcar (lambda (f)
21685 (or (org-load-noerror-mustsuffix (concat org-dir f))
21686 (and (string= org-dir contrib-dir)
21687 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21688 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21689 (add-to-list 'load-uncore f 'append)
21692 lfeat)))
21693 (if load-uncore
21694 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21695 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21696 (if load-misses
21697 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21698 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21699 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21701 ;;;###autoload
21702 (defun org-customize ()
21703 "Call the customize function with org as argument."
21704 (interactive)
21705 (org-load-modules-maybe)
21706 (org-require-autoloaded-modules)
21707 (customize-browse 'org))
21709 (defun org-create-customize-menu ()
21710 "Create a full customization menu for Org-mode, insert it into the menu."
21711 (interactive)
21712 (org-load-modules-maybe)
21713 (org-require-autoloaded-modules)
21714 (if (fboundp 'customize-menu-create)
21715 (progn
21716 (easy-menu-change
21717 '("Org") "Customize"
21718 `(["Browse Org group" org-customize t]
21719 "--"
21720 ,(customize-menu-create 'org)
21721 ["Set" Custom-set t]
21722 ["Save" Custom-save t]
21723 ["Reset to Current" Custom-reset-current t]
21724 ["Reset to Saved" Custom-reset-saved t]
21725 ["Reset to Standard Settings" Custom-reset-standard t]))
21726 (message "\"Org\"-menu now contains full customization menu"))
21727 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21729 ;;;; Miscellaneous stuff
21731 ;;; Generally useful functions
21733 (defsubst org-get-at-eol (property n)
21734 "Get text property PROPERTY at the end of line less N characters."
21735 (get-text-property (- (point-at-eol) n) property))
21737 (defun org-find-text-property-in-string (prop s)
21738 "Return the first non-nil value of property PROP in string S."
21739 (or (get-text-property 0 prop s)
21740 (get-text-property (or (next-single-property-change 0 prop s) 0)
21741 prop s)))
21743 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21744 "Display the given MESSAGE as a warning."
21745 (if (fboundp 'display-warning)
21746 (display-warning 'org message
21747 (if (featurep 'xemacs) 'warning :warning))
21748 (let ((buf (get-buffer-create "*Org warnings*")))
21749 (with-current-buffer buf
21750 (goto-char (point-max))
21751 (insert "Warning (Org): " message)
21752 (unless (bolp)
21753 (newline)))
21754 (display-buffer buf)
21755 (sit-for 0))))
21757 (defun org-eval (form)
21758 "Eval FORM and return result."
21759 (condition-case error
21760 (eval form)
21761 (error (format "%%![Error: %s]" error))))
21763 (defun org-in-clocktable-p ()
21764 "Check if the cursor is in a clocktable."
21765 (let ((pos (point)) start)
21766 (save-excursion
21767 (end-of-line 1)
21768 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21769 (setq start (match-beginning 0))
21770 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21771 (>= (match-end 0) pos)
21772 start))))
21774 (defun org-in-verbatim-emphasis ()
21775 (save-match-data
21776 (and (org-in-regexp org-emph-re 2)
21777 (>= (point) (match-beginning 3))
21778 (<= (point) (match-end 4))
21779 (member (match-string 3) '("=" "~")))))
21781 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21782 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21783 (if (and marker (marker-buffer marker)
21784 (buffer-live-p (marker-buffer marker)))
21785 (progn
21786 (org-pop-to-buffer-same-window (marker-buffer marker))
21787 (if (or (> marker (point-max)) (< marker (point-min)))
21788 (widen))
21789 (goto-char marker)
21790 (org-show-context 'org-goto))
21791 (if bookmark
21792 (bookmark-jump bookmark)
21793 (error "Cannot find location"))))
21795 (defun org-quote-csv-field (s)
21796 "Quote field for inclusion in CSV material."
21797 (if (string-match "[\",]" s)
21798 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21801 (defun org-force-self-insert (N)
21802 "Needed to enforce self-insert under remapping."
21803 (interactive "p")
21804 (self-insert-command N))
21806 (defun org-string-width (s)
21807 "Compute width of string, ignoring invisible characters.
21808 This ignores character with invisibility property `org-link', and also
21809 characters with property `org-cwidth', because these will become invisible
21810 upon the next fontification round."
21811 (let (b l)
21812 (when (or (eq t buffer-invisibility-spec)
21813 (assq 'org-link buffer-invisibility-spec))
21814 (while (setq b (text-property-any 0 (length s)
21815 'invisible 'org-link s))
21816 (setq s (concat (substring s 0 b)
21817 (substring s (or (next-single-property-change
21818 b 'invisible s) (length s)))))))
21819 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21820 (setq s (concat (substring s 0 b)
21821 (substring s (or (next-single-property-change
21822 b 'org-cwidth s) (length s))))))
21823 (setq l (string-width s) b -1)
21824 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21825 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21828 (defun org-shorten-string (s maxlength)
21829 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21830 If the string is shorter or has length MAXLENGTH, just return the
21831 original string. If it is longer, the functions finds a space in the
21832 string, breaks this string off at that locations and adds three dots
21833 as ellipsis. Including the ellipsis, the string will not be longer
21834 than MAXLENGTH. If finding a good breaking point in the string does
21835 not work, the string is just chopped off in the middle of a word
21836 if necessary."
21837 (if (<= (length s) maxlength)
21839 (let* ((n (max (- maxlength 4) 1))
21840 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21841 (if (string-match re s)
21842 (concat (match-string 1 s) "...")
21843 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21845 (defun org-get-indentation (&optional line)
21846 "Get the indentation of the current line, interpreting tabs.
21847 When LINE is given, assume it represents a line and compute its indentation."
21848 (if line
21849 (if (string-match "^ *" (org-remove-tabs line))
21850 (match-end 0))
21851 (save-excursion
21852 (beginning-of-line 1)
21853 (skip-chars-forward " \t")
21854 (current-column))))
21856 (defun org-get-string-indentation (s)
21857 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21858 (let ((n -1) (i 0) (w tab-width) c)
21859 (catch 'exit
21860 (while (< (setq n (1+ n)) (length s))
21861 (setq c (aref s n))
21862 (cond ((= c ?\ ) (setq i (1+ i)))
21863 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21864 (t (throw 'exit t)))))
21867 (defun org-remove-tabs (s &optional width)
21868 "Replace tabulators in S with spaces.
21869 Assumes that s is a single line, starting in column 0."
21870 (setq width (or width tab-width))
21871 (while (string-match "\t" s)
21872 (setq s (replace-match
21873 (make-string
21874 (- (* width (/ (+ (match-beginning 0) width) width))
21875 (match-beginning 0)) ?\ )
21876 t t s)))
21879 (defun org-fix-indentation (line ind)
21880 "Fix indentation in LINE.
21881 IND is a cons cell with target and minimum indentation.
21882 If the current indentation in LINE is smaller than the minimum,
21883 leave it alone. If it is larger than ind, set it to the target."
21884 (let* ((l (org-remove-tabs line))
21885 (i (org-get-indentation l))
21886 (i1 (car ind)) (i2 (cdr ind)))
21887 (if (>= i i2) (setq l (substring line i2)))
21888 (if (> i1 0)
21889 (concat (make-string i1 ?\ ) l)
21890 l)))
21892 (defun org-remove-indentation (code &optional n)
21893 "Remove the maximum common indentation from the lines in CODE.
21894 N may optionally be the number of spaces to remove."
21895 (with-temp-buffer
21896 (insert code)
21897 (org-do-remove-indentation n)
21898 (buffer-string)))
21900 (defun org-do-remove-indentation (&optional n)
21901 "Remove the maximum common indentation from the buffer."
21902 (untabify (point-min) (point-max))
21903 (let ((min 10000) re)
21904 (if n
21905 (setq min n)
21906 (goto-char (point-min))
21907 (while (re-search-forward "^ *[^ \n]" nil t)
21908 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21909 (unless (or (= min 0) (= min 10000))
21910 (setq re (format "^ \\{%d\\}" min))
21911 (goto-char (point-min))
21912 (while (re-search-forward re nil t)
21913 (replace-match "")
21914 (end-of-line 1))
21915 min)))
21917 (defun org-fill-template (template alist)
21918 "Find each %key of ALIST in TEMPLATE and replace it."
21919 (let ((case-fold-search nil)
21920 entry key value)
21921 (setq alist (sort (copy-sequence alist)
21922 (lambda (a b) (< (length (car a)) (length (car b))))))
21923 (while (setq entry (pop alist))
21924 (setq template
21925 (replace-regexp-in-string
21926 (concat "%" (regexp-quote (car entry)))
21927 (or (cdr entry) "") template t t)))
21928 template))
21930 (defun org-base-buffer (buffer)
21931 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21932 (if (not buffer)
21933 buffer
21934 (or (buffer-base-buffer buffer)
21935 buffer)))
21937 (defun org-wrap (string &optional width lines)
21938 "Wrap string to either a number of lines, or a width in characters.
21939 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21940 that costs. If there is a word longer than WIDTH, the text is actually
21941 wrapped to the length of that word.
21942 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21943 many lines, whatever width that takes.
21944 The return value is a list of lines, without newlines at the end."
21945 (let* ((words (org-split-string string "[ \t\n]+"))
21946 (maxword (apply 'max (mapcar 'org-string-width words)))
21947 w ll)
21948 (cond (width
21949 (org-do-wrap words (max maxword width)))
21950 (lines
21951 (setq w maxword)
21952 (setq ll (org-do-wrap words maxword))
21953 (if (<= (length ll) lines)
21955 (setq ll words)
21956 (while (> (length ll) lines)
21957 (setq w (1+ w))
21958 (setq ll (org-do-wrap words w)))
21959 ll))
21960 (t (error "Cannot wrap this")))))
21962 (defun org-do-wrap (words width)
21963 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21964 (let (lines line)
21965 (while words
21966 (setq line (pop words))
21967 (while (and words (< (+ (length line) (length (car words))) width))
21968 (setq line (concat line " " (pop words))))
21969 (setq lines (push line lines)))
21970 (nreverse lines)))
21972 (defun org-split-string (string &optional separators)
21973 "Splits STRING into substrings at SEPARATORS.
21974 No empty strings are returned if there are matches at the beginning
21975 and end of string."
21976 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21977 (start 0)
21978 notfirst
21979 (list nil))
21980 (while (and (string-match rexp string
21981 (if (and notfirst
21982 (= start (match-beginning 0))
21983 (< start (length string)))
21984 (1+ start) start))
21985 (< (match-beginning 0) (length string)))
21986 (setq notfirst t)
21987 (or (eq (match-beginning 0) 0)
21988 (and (eq (match-beginning 0) (match-end 0))
21989 (eq (match-beginning 0) start))
21990 (setq list
21991 (cons (substring string start (match-beginning 0))
21992 list)))
21993 (setq start (match-end 0)))
21994 (or (eq start (length string))
21995 (setq list
21996 (cons (substring string start)
21997 list)))
21998 (nreverse list)))
22000 (defun org-quote-vert (s)
22001 "Replace \"|\" with \"\\vert\"."
22002 (while (string-match "|" s)
22003 (setq s (replace-match "\\vert" t t s)))
22006 (defun org-uuidgen-p (s)
22007 "Is S an ID created by UUIDGEN?"
22008 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22010 (defun org-in-src-block-p (&optional inside)
22011 "Whether point is in a code source block.
22012 When INSIDE is non-nil, don't consider we are within a src block
22013 when point is at #+BEGIN_SRC or #+END_SRC."
22014 (let ((case-fold-search t) ov)
22015 (or (and (eq (get-char-property (point) 'src-block) t))
22016 (and (not inside)
22017 (save-match-data
22018 (save-excursion
22019 (beginning-of-line)
22020 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22022 (defun org-context ()
22023 "Return a list of contexts of the current cursor position.
22024 If several contexts apply, all are returned.
22025 Each context entry is a list with a symbol naming the context, and
22026 two positions indicating start and end of the context. Possible
22027 contexts are:
22029 :headline anywhere in a headline
22030 :headline-stars on the leading stars in a headline
22031 :todo-keyword on a TODO keyword (including DONE) in a headline
22032 :tags on the TAGS in a headline
22033 :priority on the priority cookie in a headline
22034 :item on the first line of a plain list item
22035 :item-bullet on the bullet/number of a plain list item
22036 :checkbox on the checkbox in a plain list item
22037 :table in an org-mode table
22038 :table-special on a special filed in a table
22039 :table-table in a table.el table
22040 :clocktable in a clocktable
22041 :src-block in a source block
22042 :link on a hyperlink
22043 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22044 :target on a <<target>>
22045 :radio-target on a <<<radio-target>>>
22046 :latex-fragment on a LaTeX fragment
22047 :latex-preview on a LaTeX fragment with overlaid preview image
22049 This function expects the position to be visible because it uses font-lock
22050 faces as a help to recognize the following contexts: :table-special, :link,
22051 and :keyword."
22052 (let* ((f (get-text-property (point) 'face))
22053 (faces (if (listp f) f (list f)))
22054 (case-fold-search t)
22055 (p (point)) clist o)
22056 ;; First the large context
22057 (cond
22058 ((org-at-heading-p t)
22059 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22060 (when (progn
22061 (beginning-of-line 1)
22062 (looking-at org-todo-line-tags-regexp))
22063 (push (org-point-in-group p 1 :headline-stars) clist)
22064 (push (org-point-in-group p 2 :todo-keyword) clist)
22065 (push (org-point-in-group p 4 :tags) clist))
22066 (goto-char p)
22067 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22068 (if (looking-at "\\[#[A-Z0-9]\\]")
22069 (push (org-point-in-group p 0 :priority) clist)))
22071 ((org-at-item-p)
22072 (push (org-point-in-group p 2 :item-bullet) clist)
22073 (push (list :item (point-at-bol)
22074 (save-excursion (org-end-of-item) (point)))
22075 clist)
22076 (and (org-at-item-checkbox-p)
22077 (push (org-point-in-group p 0 :checkbox) clist)))
22079 ((org-at-table-p)
22080 (push (list :table (org-table-begin) (org-table-end)) clist)
22081 (if (memq 'org-formula faces)
22082 (push (list :table-special
22083 (previous-single-property-change p 'face)
22084 (next-single-property-change p 'face)) clist)))
22085 ((org-at-table-p 'any)
22086 (push (list :table-table) clist)))
22087 (goto-char p)
22089 (let ((case-fold-search t))
22090 ;; New the "medium" contexts: clocktables, source blocks
22091 (cond ((org-in-clocktable-p)
22092 (push (list :clocktable
22093 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22094 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22095 (match-beginning 1))
22096 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22097 (match-end 0))) clist))
22098 ((org-in-src-block-p)
22099 (push (list :src-block
22100 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22101 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22102 (match-beginning 1))
22103 (and (search-forward "#+END_SRC" nil t)
22104 (match-beginning 0))) clist))))
22105 (goto-char p)
22107 ;; Now the small context
22108 (cond
22109 ((org-at-timestamp-p)
22110 (push (org-point-in-group p 0 :timestamp) clist))
22111 ((memq 'org-link faces)
22112 (push (list :link
22113 (previous-single-property-change p 'face)
22114 (next-single-property-change p 'face)) clist))
22115 ((memq 'org-special-keyword faces)
22116 (push (list :keyword
22117 (previous-single-property-change p 'face)
22118 (next-single-property-change p 'face)) clist))
22119 ((org-at-target-p)
22120 (push (org-point-in-group p 0 :target) clist)
22121 (goto-char (1- (match-beginning 0)))
22122 (if (looking-at org-radio-target-regexp)
22123 (push (org-point-in-group p 0 :radio-target) clist))
22124 (goto-char p))
22125 ((setq o (car (delq nil
22126 (mapcar
22127 (lambda (x)
22128 (if (memq x org-latex-fragment-image-overlays) x))
22129 (overlays-at (point))))))
22130 (push (list :latex-fragment
22131 (overlay-start o) (overlay-end o)) clist)
22132 (push (list :latex-preview
22133 (overlay-start o) (overlay-end o)) clist))
22134 ((org-inside-LaTeX-fragment-p)
22135 ;; FIXME: positions wrong.
22136 (push (list :latex-fragment (point) (point)) clist)))
22138 (setq clist (nreverse (delq nil clist)))
22139 clist))
22141 ;; FIXME: Compare with at-regexp-p Do we need both?
22142 (defun org-in-regexp (re &optional nlines visually)
22143 "Check if point is inside a match of regexp.
22144 Normally only the current line is checked, but you can include NLINES extra
22145 lines both before and after point into the search.
22146 If VISUALLY is set, require that the cursor is not after the match but
22147 really on, so that the block visually is on the match."
22148 (catch 'exit
22149 (let ((pos (point))
22150 (eol (point-at-eol (+ 1 (or nlines 0))))
22151 (inc (if visually 1 0)))
22152 (save-excursion
22153 (beginning-of-line (- 1 (or nlines 0)))
22154 (while (re-search-forward re eol t)
22155 (if (and (<= (match-beginning 0) pos)
22156 (>= (+ inc (match-end 0)) pos))
22157 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22159 (defun org-at-regexp-p (regexp)
22160 "Is point inside a match of REGEXP in the current line?"
22161 (catch 'exit
22162 (save-excursion
22163 (let ((pos (point)) (end (point-at-eol)))
22164 (beginning-of-line 1)
22165 (while (re-search-forward regexp end t)
22166 (if (and (<= (match-beginning 0) pos)
22167 (>= (match-end 0) pos))
22168 (throw 'exit t)))
22169 nil))))
22171 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22172 "Non-nil when point is between matches of START-RE and END-RE.
22174 Also return a non-nil value when point is on one of the matches.
22176 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22177 buffer positions. Default values are the positions of headlines
22178 surrounding the point.
22180 The functions returns a cons cell whose car (resp. cdr) is the
22181 position before START-RE (resp. after END-RE)."
22182 (save-match-data
22183 (let ((pos (point))
22184 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22185 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22186 beg end)
22187 (save-excursion
22188 ;; Point is on a block when on START-RE or if START-RE can be
22189 ;; found before it...
22190 (and (or (org-at-regexp-p start-re)
22191 (re-search-backward start-re limit-up t))
22192 (setq beg (match-beginning 0))
22193 ;; ... and END-RE after it...
22194 (goto-char (match-end 0))
22195 (re-search-forward end-re limit-down t)
22196 (> (setq end (match-end 0)) pos)
22197 ;; ... without another START-RE in-between.
22198 (goto-char (match-beginning 0))
22199 (not (re-search-backward start-re (1+ beg) t))
22200 ;; Return value.
22201 (cons beg end))))))
22203 (defun org-in-block-p (names)
22204 "Non-nil when point belongs to a block whose name belongs to NAMES.
22206 NAMES is a list of strings containing names of blocks.
22208 Return first block name matched, or nil. Beware that in case of
22209 nested blocks, the returned name may not belong to the closest
22210 block from point."
22211 (save-match-data
22212 (catch 'exit
22213 (let ((case-fold-search t)
22214 (lim-up (save-excursion (outline-previous-heading)))
22215 (lim-down (save-excursion (outline-next-heading))))
22216 (mapc (lambda (name)
22217 (let ((n (regexp-quote name)))
22218 (when (org-between-regexps-p
22219 (concat "^[ \t]*#\\+begin_" n)
22220 (concat "^[ \t]*#\\+end_" n)
22221 lim-up lim-down)
22222 (throw 'exit n))))
22223 names))
22224 nil)))
22226 (defun org-in-drawer-p ()
22227 "Non-nil if point is within a drawer.
22228 If point is within a drawer, return it, as parsed data."
22229 (let ((element (save-match-data (org-element-at-point))))
22230 (while (and element (not (memq (org-element-type element)
22231 '(drawer property-drawer))))
22232 (setq element (org-element-property :parent element)))
22233 element))
22235 (defun org-occur-in-agenda-files (regexp &optional nlines)
22236 "Call `multi-occur' with buffers for all agenda files."
22237 (interactive "sOrg-files matching: \np")
22238 (let* ((files (org-agenda-files))
22239 (tnames (mapcar 'file-truename files))
22240 (extra org-agenda-text-search-extra-files)
22242 (when (eq (car extra) 'agenda-archives)
22243 (setq extra (cdr extra))
22244 (setq files (org-add-archive-files files)))
22245 (while (setq f (pop extra))
22246 (unless (member (file-truename f) tnames)
22247 (add-to-list 'files f 'append)
22248 (add-to-list 'tnames (file-truename f) 'append)))
22249 (multi-occur
22250 (mapcar (lambda (x)
22251 (with-current-buffer
22252 (or (get-file-buffer x) (find-file-noselect x))
22253 (widen)
22254 (current-buffer)))
22255 files)
22256 regexp)))
22258 (if (boundp 'occur-mode-find-occurrence-hook)
22259 ;; Emacs 23
22260 (add-hook 'occur-mode-find-occurrence-hook
22261 (lambda ()
22262 (when (derived-mode-p 'org-mode)
22263 (org-reveal))))
22264 ;; Emacs 22
22265 (defadvice occur-mode-goto-occurrence
22266 (after org-occur-reveal activate)
22267 (and (derived-mode-p 'org-mode) (org-reveal)))
22268 (defadvice occur-mode-goto-occurrence-other-window
22269 (after org-occur-reveal activate)
22270 (and (derived-mode-p 'org-mode) (org-reveal)))
22271 (defadvice occur-mode-display-occurrence
22272 (after org-occur-reveal activate)
22273 (when (derived-mode-p 'org-mode)
22274 (let ((pos (occur-mode-find-occurrence)))
22275 (with-current-buffer (marker-buffer pos)
22276 (save-excursion
22277 (goto-char pos)
22278 (org-reveal)))))))
22280 (defun org-occur-link-in-agenda-files ()
22281 "Create a link and search for it in the agendas.
22282 The link is not stored in `org-stored-links', it is just created
22283 for the search purpose."
22284 (interactive)
22285 (let ((link (condition-case nil
22286 (org-store-link nil)
22287 (error "Unable to create a link to here"))))
22288 (org-occur-in-agenda-files (regexp-quote link))))
22290 (defun org-reverse-string (string)
22291 "Return the reverse of STRING."
22292 (apply 'string (reverse (string-to-list string))))
22294 ;; defsubst org-uniquify must be defined before first use
22296 (defun org-uniquify-alist (alist)
22297 "Merge elements of ALIST with the same key.
22299 For example, in this alist:
22301 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22302 => '((a 1 3) (b 2))
22304 merge (a 1) and (a 3) into (a 1 3).
22306 The function returns the new ALIST."
22307 (let (rtn)
22308 (mapc
22309 (lambda (e)
22310 (let (n)
22311 (if (not (assoc (car e) rtn))
22312 (push e rtn)
22313 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22314 (setq rtn (assq-delete-all (car e) rtn))
22315 (push n rtn))))
22316 alist)
22317 rtn))
22319 (defun org-delete-all (elts list)
22320 "Remove all elements in ELTS from LIST."
22321 (while elts
22322 (setq list (delete (pop elts) list)))
22323 list)
22325 (defun org-count (cl-item cl-seq)
22326 "Count the number of occurrences of ITEM in SEQ.
22327 Taken from `count' in cl-seq.el with all keyword arguments removed."
22328 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22329 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22330 (while (< cl-start cl-end)
22331 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22332 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22333 (setq cl-start (1+ cl-start)))
22334 cl-count))
22336 (defun org-remove-if (predicate seq)
22337 "Remove everything from SEQ that fulfills PREDICATE."
22338 (let (res e)
22339 (while seq
22340 (setq e (pop seq))
22341 (if (not (funcall predicate e)) (push e res)))
22342 (nreverse res)))
22344 (defun org-remove-if-not (predicate seq)
22345 "Remove everything from SEQ that does not fulfill PREDICATE."
22346 (let (res e)
22347 (while seq
22348 (setq e (pop seq))
22349 (if (funcall predicate e) (push e res)))
22350 (nreverse res)))
22352 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22353 "Reduce two-argument FUNCTION across SEQ.
22354 Taken from `reduce' in cl-seq.el with all keyword arguments but
22355 \":initial-value\" removed."
22356 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22357 (cadr (memq :initial-value cl-keys)))
22358 (cl-seq (pop cl-seq))
22359 (t (funcall cl-func)))))
22360 (while cl-seq
22361 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22362 cl-accum))
22364 (defun org-every (pred seq)
22365 "Return true if PREDICATE is true of every element of SEQ.
22366 Adapted from `every' in cl.el."
22367 (catch 'org-every
22368 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22371 (defun org-some (pred seq)
22372 "Return true if PREDICATE is true of any element of SEQ.
22373 Adapted from `some' in cl.el."
22374 (catch 'org-some
22375 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22376 nil))
22378 (defun org-back-over-empty-lines ()
22379 "Move backwards over whitespace, to the beginning of the first empty line.
22380 Returns the number of empty lines passed."
22381 (let ((pos (point)))
22382 (if (cdr (assoc 'heading org-blank-before-new-entry))
22383 (skip-chars-backward " \t\n\r")
22384 (unless (eobp)
22385 (forward-line -1)))
22386 (beginning-of-line 2)
22387 (goto-char (min (point) pos))
22388 (count-lines (point) pos)))
22390 (defun org-skip-whitespace ()
22391 (skip-chars-forward " \t\n\r"))
22393 (defun org-point-in-group (point group &optional context)
22394 "Check if POINT is in match-group GROUP.
22395 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22396 match. If the match group does not exist or point is not inside it,
22397 return nil."
22398 (and (match-beginning group)
22399 (>= point (match-beginning group))
22400 (<= point (match-end group))
22401 (if context
22402 (list context (match-beginning group) (match-end group))
22403 t)))
22405 (defun org-switch-to-buffer-other-window (&rest args)
22406 "Switch to buffer in a second window on the current frame.
22407 In particular, do not allow pop-up frames.
22408 Returns the newly created buffer."
22409 (org-no-popups
22410 (apply 'switch-to-buffer-other-window args)))
22412 (defun org-combine-plists (&rest plists)
22413 "Create a single property list from all plists in PLISTS.
22414 The process starts by copying the first list, and then setting properties
22415 from the other lists. Settings in the last list are the most significant
22416 ones and overrule settings in the other lists."
22417 (let ((rtn (copy-sequence (pop plists)))
22418 p v ls)
22419 (while plists
22420 (setq ls (pop plists))
22421 (while ls
22422 (setq p (pop ls) v (pop ls))
22423 (setq rtn (plist-put rtn p v))))
22424 rtn))
22426 (defun org-replace-escapes (string table)
22427 "Replace %-escapes in STRING with values in TABLE.
22428 TABLE is an association list with keys like \"%a\" and string values.
22429 The sequences in STRING may contain normal field width and padding information,
22430 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22431 so values can contain further %-escapes if they are define later in TABLE."
22432 (let ((tbl (copy-alist table))
22433 (case-fold-search nil)
22434 (pchg 0)
22435 e re rpl)
22436 (while (setq e (pop tbl))
22437 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22438 (when (and (cdr e) (string-match re (cdr e)))
22439 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22440 (safe "SREF"))
22441 (add-text-properties 0 3 (list 'sref sref) safe)
22442 (setcdr e (replace-match safe t t (cdr e)))))
22443 (while (string-match re string)
22444 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22445 (cdr e)))
22446 (setq string (replace-match rpl t t string))))
22447 (while (setq pchg (next-property-change pchg string))
22448 (let ((sref (get-text-property pchg 'sref string)))
22449 (when (and sref (string-match "SREF" string pchg))
22450 (setq string (replace-match sref t t string)))))
22451 string))
22453 (defun org-sublist (list start end)
22454 "Return a section of LIST, from START to END.
22455 Counting starts at 1."
22456 (let (rtn (c start))
22457 (setq list (nthcdr (1- start) list))
22458 (while (and list (<= c end))
22459 (push (pop list) rtn)
22460 (setq c (1+ c)))
22461 (nreverse rtn)))
22463 (defun org-find-base-buffer-visiting (file)
22464 "Like `find-buffer-visiting' but always return the base buffer and
22465 not an indirect buffer."
22466 (let ((buf (or (get-file-buffer file)
22467 (find-buffer-visiting file))))
22468 (if buf
22469 (or (buffer-base-buffer buf) buf)
22470 nil)))
22472 (defun org-image-file-name-regexp (&optional extensions)
22473 "Return regexp matching the file names of images.
22474 If EXTENSIONS is given, only match these."
22475 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22476 (image-file-name-regexp)
22477 (let ((image-file-name-extensions
22478 (or extensions
22479 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22480 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22481 (concat "\\."
22482 (regexp-opt (nconc (mapcar 'upcase
22483 image-file-name-extensions)
22484 image-file-name-extensions)
22486 "\\'"))))
22488 (defun org-file-image-p (file &optional extensions)
22489 "Return non-nil if FILE is an image."
22490 (save-match-data
22491 (string-match (org-image-file-name-regexp extensions) file)))
22493 (defun org-get-cursor-date (&optional with-time)
22494 "Return the date at cursor in as a time.
22495 This works in the calendar and in the agenda, anywhere else it just
22496 returns the current time.
22497 If WITH-TIME is non-nil, returns the time of the event at point (in
22498 the agenda) or the current time of the day."
22499 (let (date day defd tp tm hod mod)
22500 (when with-time
22501 (setq tp (get-text-property (point) 'time))
22502 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22503 (setq hod (string-to-number (match-string 1 tp))
22504 mod (string-to-number (match-string 2 tp))))
22505 (or tp (setq hod (nth 2 (decode-time (current-time)))
22506 mod (nth 1 (decode-time (current-time))))))
22507 (cond
22508 ((eq major-mode 'calendar-mode)
22509 (setq date (calendar-cursor-to-date)
22510 defd (encode-time 0 (or mod 0) (or hod 0)
22511 (nth 1 date) (nth 0 date) (nth 2 date))))
22512 ((eq major-mode 'org-agenda-mode)
22513 (setq day (get-text-property (point) 'day))
22514 (if day
22515 (setq date (calendar-gregorian-from-absolute day)
22516 defd (encode-time 0 (or mod 0) (or hod 0)
22517 (nth 1 date) (nth 0 date) (nth 2 date))))))
22518 (or defd (current-time))))
22520 (defun org-mark-subtree (&optional up)
22521 "Mark the current subtree.
22522 This puts point at the start of the current subtree, and mark at
22523 the end. If a numeric prefix UP is given, move up into the
22524 hierarchy of headlines by UP levels before marking the subtree."
22525 (interactive "P")
22526 (org-with-limited-levels
22527 (cond ((org-at-heading-p) (beginning-of-line))
22528 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22529 (t (outline-previous-visible-heading 1))))
22530 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22531 (if (org-called-interactively-p 'any)
22532 (call-interactively 'org-mark-element)
22533 (org-mark-element)))
22536 ;;; Indentation
22538 (defun org--get-expected-indentation (element contentsp)
22539 "Expected indentation column for current line, according to ELEMENT.
22540 ELEMENT is an element containing point. CONTENTSP is non-nil
22541 when indentation is to be computed according to contents of
22542 ELEMENT."
22543 (let ((type (org-element-type element))
22544 (start (org-element-property :begin element)))
22545 (org-with-wide-buffer
22546 (cond
22547 (contentsp
22548 (case type
22549 (footnote-definition 0)
22550 ((headline inlinetask nil)
22551 (if (not org-adapt-indentation) 0
22552 (let ((level (org-current-level)))
22553 (if level (1+ level) 0))))
22554 (item
22555 (org-list-item-body-column
22556 (org-element-property :post-affiliated element)))
22557 (plain-list
22558 (save-excursion
22559 (goto-char (org-element-property :post-affiliated element))
22560 (org-get-indentation)))
22561 (otherwise
22562 (goto-char start)
22563 (org-get-indentation))))
22564 ((memq type '(headline inlinetask nil))
22565 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22566 (org--get-expected-indentation element t)
22568 ((eq type 'footnote-definition) 0)
22569 ;; First paragraph of a footnote definition or an item.
22570 ;; Indent like parent.
22571 ((< (line-beginning-position) start)
22572 (org--get-expected-indentation
22573 (org-element-property :parent element) t))
22574 ;; At first line: indent according to previous sibling, if any,
22575 ;; ignoring footnote definitions and inline tasks, or parent's
22576 ;; contents.
22577 ((= (line-beginning-position) start)
22578 (catch 'exit
22579 (while t
22580 (if (= (point-min) start) (throw 'exit 0)
22581 (goto-char (1- start))
22582 (let* ((previous (org-element-at-point))
22583 (parent previous))
22584 (while (and parent (<= (org-element-property :end parent) start))
22585 (setq previous parent
22586 parent (org-element-property :parent parent)))
22587 (cond
22588 ((not previous) (throw 'exit 0))
22589 ((> (org-element-property :end previous) start)
22590 (throw 'exit (org--get-expected-indentation previous t)))
22591 ((memq (org-element-type previous)
22592 '(footnote-definition inlinetask))
22593 (setq start (org-element-property :begin previous)))
22594 (t (goto-char (org-element-property :begin previous))
22595 (throw 'exit
22596 (if (bolp) (org-get-indentation)
22597 ;; At first paragraph in an item or
22598 ;; a footnote definition.
22599 (org--get-expected-indentation
22600 (org-element-property :parent previous) t))))))))))
22601 ;; Otherwise, move to the first non-blank line above.
22603 (beginning-of-line)
22604 (let ((pos (point)))
22605 (skip-chars-backward " \r\t\n")
22606 (cond
22607 ;; Two blank lines end a footnote definition or a plain
22608 ;; list. When we indent an empty line after them, the
22609 ;; containing list or footnote definition is over, so it
22610 ;; qualifies as a previous sibling. Therefore, we indent
22611 ;; like its first line.
22612 ((and (memq type '(footnote-definition plain-list))
22613 (> (count-lines (point) pos) 2))
22614 (goto-char start)
22615 (org-get-indentation))
22616 ;; Line above is the first one of a paragraph at the
22617 ;; beginning of an item or a footnote definition. Indent
22618 ;; like parent.
22619 ((< (line-beginning-position) start)
22620 (org--get-expected-indentation
22621 (org-element-property :parent element) t))
22622 ;; POS is after contents in a greater element. Indent like
22623 ;; the beginning of the element.
22625 ;; As a special case, if point is at the end of a footnote
22626 ;; definition or an item, indent like the very last element
22627 ;; within.
22628 ((and (not (eq type 'paragraph))
22629 (let ((cend (org-element-property :contents-end element)))
22630 (and cend (<= cend pos))))
22631 (if (memq type '(footnote-definition item plain-list))
22632 (org--get-expected-indentation (org-element-at-point) nil)
22633 (goto-char start)
22634 (org-get-indentation)))
22635 ;; In any other case, indent like the current line.
22636 (t (org-get-indentation)))))))))
22638 (defun org--align-node-property ()
22639 "Align node property at point.
22640 Alignment is done according to `org-property-format', which see."
22641 (when (save-excursion
22642 (beginning-of-line)
22643 (looking-at org-property-re))
22644 (replace-match
22645 (concat (match-string 4)
22646 (org-trim
22647 (format org-property-format (match-string 1) (match-string 3))))
22648 t t)))
22650 (defun org-indent-line ()
22651 "Indent line depending on context.
22653 Indentation is done according to the following rules:
22655 - Footnote definitions, headlines and inline tasks have to
22656 start at column 0.
22658 - On the very first line of an element, consider, in order, the
22659 next rules until one matches:
22661 1. If there's a sibling element before, ignoring footnote
22662 definitions and inline tasks, indent like its first line.
22664 2. If element has a parent, indent like its contents. More
22665 precisely, if parent is an item, indent after the
22666 description part, if any, or the bullet (see
22667 `org-list-description-max-indent'). Else, indent like
22668 parent's first line.
22670 3. Otherwise, indent relatively to current level, if
22671 `org-adapt-indentation' is non-nil, or to left margin.
22673 - On a blank line at the end of an element, indent according to
22674 the type of the element. More precisely
22676 1. If element is a plain list, an item, or a footnote
22677 definition, indent like the very last element within.
22679 2. If element is a paragraph, indent like its last non blank
22680 line.
22682 3. Otherwise, indent like its very first line.
22684 - In the code part of a source block, use language major mode
22685 to indent current line if `org-src-tab-acts-natively' is
22686 non-nil. If it is nil, do nothing.
22688 - Otherwise, indent like the first non-blank line above.
22690 The function doesn't indent an item as it could break the whole
22691 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22692 \\[org-shiftmetaright].
22694 Also align node properties according to `org-property-format'."
22695 (interactive)
22696 (cond
22697 (orgstruct-is-++
22698 (let ((indent-line-function
22699 (cadadr (assq 'indent-line-function org-fb-vars))))
22700 (indent-according-to-mode)))
22701 ((org-at-heading-p) 'noindent)
22703 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22704 (type (org-element-type element)))
22705 (cond ((and (memq type '(plain-list item))
22706 (= (line-beginning-position)
22707 (org-element-property :post-affiliated element)))
22708 'noindent)
22709 ((and (eq type 'src-block)
22710 org-src-tab-acts-natively
22711 (> (line-beginning-position)
22712 (org-element-property :post-affiliated element))
22713 (< (line-beginning-position)
22714 (org-with-wide-buffer
22715 (goto-char (org-element-property :end element))
22716 (skip-chars-backward " \r\t\n")
22717 (line-beginning-position))))
22718 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22720 (let ((column (org--get-expected-indentation element nil)))
22721 ;; Preserve current column.
22722 (if (<= (current-column) (current-indentation))
22723 (org-indent-line-to column)
22724 (save-excursion (org-indent-line-to column))))
22725 ;; Align node property. Also preserve current column.
22726 (when (eq type 'node-property)
22727 (let ((column (current-column)))
22728 (org--align-node-property)
22729 (org-move-to-column column)))))))))
22731 (defun org-indent-region (start end)
22732 "Indent each non-blank line in the region.
22733 Called from a program, START and END specify the region to
22734 indent. The function will not indent contents of example blocks,
22735 verse blocks and export blocks as leading white spaces are
22736 assumed to be significant there."
22737 (interactive "r")
22738 (save-excursion
22739 (goto-char start)
22740 (skip-chars-forward " \r\t\n")
22741 (unless (eobp) (beginning-of-line))
22742 (let ((indent-to
22743 (lambda (ind pos)
22744 ;; Set IND as indentation for all lines between point and
22745 ;; POS or END, whichever comes first. Blank lines are
22746 ;; ignored. Leave point after POS once done.
22747 (let ((limit (copy-marker (min end pos))))
22748 (while (< (point) limit)
22749 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
22750 (forward-line))
22751 (set-marker limit nil))))
22752 (end (copy-marker end)))
22753 (while (< (point) end)
22754 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
22755 (let* ((element (org-element-at-point))
22756 (type (org-element-type element))
22757 (element-end (copy-marker (org-element-property :end element)))
22758 (ind (org--get-expected-indentation element nil)))
22759 (cond
22760 ((or (memq type '(paragraph table table-row))
22761 (not (or (org-element-property :contents-begin element)
22762 (memq type
22763 '(example-block export-block src-block)))))
22764 ;; Elements here are indented as a single block. Also
22765 ;; align node properties.
22766 (when (eq type 'node-property)
22767 (org--align-node-property)
22768 (beginning-of-line))
22769 (funcall indent-to ind element-end))
22771 ;; Elements in this category consist of three parts:
22772 ;; before the contents, the contents, and after the
22773 ;; contents. The contents are treated specially,
22774 ;; according to the element type, or not indented at
22775 ;; all. Other parts are indented as a single block.
22776 (let* ((post (copy-marker
22777 (org-element-property :post-affiliated element)))
22778 (cbeg
22779 (copy-marker
22780 (cond
22781 ((not (org-element-property :contents-begin element))
22782 ;; Fake contents for source blocks.
22783 (org-with-wide-buffer
22784 (goto-char post)
22785 (forward-line)
22786 (point)))
22787 ((memq type '(footnote-definition item plain-list))
22788 ;; Contents in these elements could start on
22789 ;; the same line as the beginning of the
22790 ;; element. Make sure we start indenting
22791 ;; from the second line.
22792 (org-with-wide-buffer
22793 (goto-char post)
22794 (end-of-line)
22795 (skip-chars-forward " \r\t\n")
22796 (if (eobp) (point) (line-beginning-position))))
22797 (t (org-element-property :contents-begin element)))))
22798 (cend (copy-marker
22799 (or (org-element-property :contents-end element)
22800 ;; Fake contents for source blocks.
22801 (org-with-wide-buffer
22802 (goto-char element-end)
22803 (skip-chars-backward " \r\t\n")
22804 (line-beginning-position)))
22805 t)))
22806 ;; Do not change items indentation individually as it
22807 ;; might break the list as a whole. On the other
22808 ;; hand, when at a plain list, indent it as a whole.
22809 (cond ((eq type 'plain-list)
22810 (let ((offset (- ind (org-get-indentation))))
22811 (unless (zerop offset)
22812 (indent-rigidly (org-element-property :begin element)
22813 (org-element-property :end element)
22814 offset))
22815 (goto-char cbeg)))
22816 ((eq type 'item) (goto-char cbeg))
22817 (t (funcall indent-to ind cbeg)))
22818 (when (< (point) end)
22819 (case type
22820 ((example-block export-block verse-block))
22821 (src-block
22822 ;; In a source block, indent source code
22823 ;; according to language major mode, but only if
22824 ;; `org-src-tab-acts-natively' is non-nil.
22825 (when (and (< (point) end) org-src-tab-acts-natively)
22826 (ignore-errors
22827 (org-babel-do-in-edit-buffer
22828 (indent-region (point-min) (point-max))))))
22829 (t (org-indent-region (point) (min cend end))))
22830 (goto-char (min cend end))
22831 (when (< (point) end) (funcall indent-to ind element-end)))
22832 (set-marker post nil)
22833 (set-marker cbeg nil)
22834 (set-marker cend nil))))
22835 (set-marker element-end nil))))
22836 (set-marker end nil))))
22838 (defun org-indent-drawer ()
22839 "Indent the drawer at point."
22840 (interactive)
22841 (unless (save-excursion
22842 (beginning-of-line)
22843 (org-looking-at-p org-drawer-regexp))
22844 (user-error "Not at a drawer"))
22845 (let ((element (org-element-at-point)))
22846 (unless (memq (org-element-type element) '(drawer property-drawer))
22847 (user-error "Not at a drawer"))
22848 (org-with-wide-buffer
22849 (org-indent-region (org-element-property :begin element)
22850 (org-element-property :end element))))
22851 (message "Drawer at point indented"))
22853 (defun org-indent-block ()
22854 "Indent the block at point."
22855 (interactive)
22856 (unless (save-excursion
22857 (beginning-of-line)
22858 (let ((case-fold-search t))
22859 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
22860 (user-error "Not at a block"))
22861 (let ((element (org-element-at-point)))
22862 (unless (memq (org-element-type element)
22863 '(comment-block center-block dynamic-block example-block
22864 export-block quote-block special-block
22865 src-block verse-block))
22866 (user-error "Not at a block"))
22867 (org-with-wide-buffer
22868 (org-indent-region (org-element-property :begin element)
22869 (org-element-property :end element))))
22870 (message "Block at point indented"))
22873 ;;; Filling
22875 ;; We use our own fill-paragraph and auto-fill functions.
22877 ;; `org-fill-paragraph' relies on adaptive filling and context
22878 ;; checking. Appropriate `fill-prefix' is computed with
22879 ;; `org-adaptive-fill-function'.
22881 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22882 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22883 ;; `org-adaptive-fill-function' value. Internally,
22884 ;; `org-comment-line-break-function' breaks the line.
22886 ;; `org-setup-filling' installs filling and auto-filling related
22887 ;; variables during `org-mode' initialization.
22889 (defvar org-element-paragraph-separate) ; org-element.el
22890 (defun org-setup-filling ()
22891 (require 'org-element)
22892 ;; Prevent auto-fill from inserting unwanted new items.
22893 (when (boundp 'fill-nobreak-predicate)
22894 (org-set-local
22895 'fill-nobreak-predicate
22896 (org-uniquify
22897 (append fill-nobreak-predicate
22898 '(org-fill-line-break-nobreak-p
22899 org-fill-paragraph-with-timestamp-nobreak-p)))))
22900 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22901 (org-set-local 'paragraph-start paragraph-ending)
22902 (org-set-local 'paragraph-separate paragraph-ending))
22903 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22904 (org-set-local 'auto-fill-inhibit-regexp nil)
22905 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22906 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22907 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22909 (defun org-fill-line-break-nobreak-p ()
22910 "Non-nil when a new line at point would create an Org line break."
22911 (save-excursion
22912 (skip-chars-backward "[ \t]")
22913 (skip-chars-backward "\\\\")
22914 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22916 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22917 "Non-nil when a new line at point would split a timestamp."
22918 (and (org-at-timestamp-p t)
22919 (not (looking-at org-ts-regexp-both))))
22921 (declare-function message-in-body-p "message" ())
22922 (defvar orgtbl-line-start-regexp) ; From org-table.el
22923 (defun org-adaptive-fill-function ()
22924 "Compute a fill prefix for the current line.
22925 Return fill prefix, as a string, or nil if current line isn't
22926 meant to be filled. For convenience, if `adaptive-fill-regexp'
22927 matches in paragraphs or comments, use it."
22928 (catch 'exit
22929 (when (derived-mode-p 'message-mode)
22930 (save-excursion
22931 (beginning-of-line)
22932 (cond ((or (not (message-in-body-p))
22933 (looking-at orgtbl-line-start-regexp))
22934 (throw 'exit nil))
22935 ((looking-at message-cite-prefix-regexp)
22936 (throw 'exit (match-string-no-properties 0)))
22937 ((looking-at org-outline-regexp)
22938 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
22939 (org-with-wide-buffer
22940 (unless (org-at-heading-p)
22941 (let* ((p (line-beginning-position))
22942 (element (save-excursion
22943 (beginning-of-line)
22944 (org-element-at-point)))
22945 (type (org-element-type element))
22946 (post-affiliated (org-element-property :post-affiliated element)))
22947 (unless (< p post-affiliated)
22948 (case type
22949 (comment
22950 (save-excursion
22951 (beginning-of-line)
22952 (looking-at "[ \t]*")
22953 (concat (match-string 0) "# ")))
22954 (footnote-definition "")
22955 ((item plain-list)
22956 (make-string (org-list-item-body-column post-affiliated) ?\s))
22957 (paragraph
22958 ;; Fill prefix is usually the same as the current line,
22959 ;; unless the paragraph is at the beginning of an item.
22960 (let ((parent (org-element-property :parent element)))
22961 (save-excursion
22962 (beginning-of-line)
22963 (cond ((eq (org-element-type parent) 'item)
22964 (make-string (org-list-item-body-column
22965 (org-element-property :begin parent))
22966 ?\s))
22967 ((and adaptive-fill-regexp
22968 ;; Locally disable
22969 ;; `adaptive-fill-function' to let
22970 ;; `fill-context-prefix' handle
22971 ;; `adaptive-fill-regexp' variable.
22972 (let (adaptive-fill-function)
22973 (fill-context-prefix
22974 post-affiliated
22975 (org-element-property :end element)))))
22976 ((looking-at "[ \t]+") (match-string 0))
22977 (t "")))))
22978 (comment-block
22979 ;; Only fill contents if P is within block boundaries.
22980 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22981 (forward-line)
22982 (point)))
22983 (cend (save-excursion
22984 (goto-char (org-element-property :end element))
22985 (skip-chars-backward " \r\t\n")
22986 (line-beginning-position))))
22987 (when (and (>= p cbeg) (< p cend))
22988 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22989 (match-string 0)
22990 "")))))))))))
22992 (declare-function message-goto-body "message" ())
22993 (defvar message-cite-prefix-regexp) ; From message.el
22994 (defun org-fill-paragraph (&optional justify)
22995 "Fill element at point, when applicable.
22997 This function only applies to comment blocks, comments, example
22998 blocks and paragraphs. Also, as a special case, re-align table
22999 when point is at one.
23001 If JUSTIFY is non-nil (interactively, with prefix argument),
23002 justify as well. If `sentence-end-double-space' is non-nil, then
23003 period followed by one space does not end a sentence, so don't
23004 break a line there. The variable `fill-column' controls the
23005 width for filling.
23007 For convenience, when point is at a plain list, an item or
23008 a footnote definition, try to fill the first paragraph within."
23009 (interactive)
23010 (if (and (derived-mode-p 'message-mode)
23011 (or (not (message-in-body-p))
23012 (save-excursion (move-beginning-of-line 1)
23013 (looking-at message-cite-prefix-regexp))))
23014 ;; First ensure filling is correct in message-mode.
23015 (let ((fill-paragraph-function
23016 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23017 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23018 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23019 (paragraph-separate
23020 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23021 (fill-paragraph nil))
23022 (with-syntax-table org-mode-transpose-word-syntax-table
23023 ;; Move to end of line in order to get the first paragraph
23024 ;; within a plain list or a footnote definition.
23025 (let ((element (save-excursion
23026 (end-of-line)
23027 (or (ignore-errors (org-element-at-point))
23028 (user-error "An element cannot be parsed line %d"
23029 (line-number-at-pos (point)))))))
23030 ;; First check if point is in a blank line at the beginning of
23031 ;; the buffer. In that case, ignore filling.
23032 (case (org-element-type element)
23033 ;; Use major mode filling function is src blocks.
23034 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23035 ;; Align Org tables, leave table.el tables as-is.
23036 (table-row (org-table-align) t)
23037 (table
23038 (when (eq (org-element-property :type element) 'org)
23039 (save-excursion
23040 (goto-char (org-element-property :post-affiliated element))
23041 (org-table-align)))
23043 (paragraph
23044 ;; Paragraphs may contain `line-break' type objects.
23045 (let ((beg (max (point-min)
23046 (org-element-property :contents-begin element)))
23047 (end (min (point-max)
23048 (org-element-property :contents-end element))))
23049 ;; Do nothing if point is at an affiliated keyword.
23050 (if (< (line-end-position) beg) t
23051 (when (derived-mode-p 'message-mode)
23052 ;; In `message-mode', do not fill following citation
23053 ;; in current paragraph nor text before message body.
23054 (let ((body-start (save-excursion (message-goto-body))))
23055 (when body-start (setq beg (max body-start beg))))
23056 (when (save-excursion
23057 (re-search-forward
23058 (concat "^" message-cite-prefix-regexp) end t))
23059 (setq end (match-beginning 0))))
23060 ;; Fill paragraph, taking line breaks into account.
23061 (save-excursion
23062 (goto-char beg)
23063 (let ((cuts (list beg)))
23064 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23065 (when (eq 'line-break
23066 (org-element-type
23067 (save-excursion (backward-char)
23068 (org-element-context))))
23069 (push (point) cuts)))
23070 (dolist (c (delq end cuts))
23071 (fill-region-as-paragraph c end justify)
23072 (setq end c))))
23073 t)))
23074 ;; Contents of `comment-block' type elements should be
23075 ;; filled as plain text, but only if point is within block
23076 ;; markers.
23077 (comment-block
23078 (let* ((case-fold-search t)
23079 (beg (save-excursion
23080 (goto-char (org-element-property :begin element))
23081 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23082 (forward-line)
23083 (point)))
23084 (end (save-excursion
23085 (goto-char (org-element-property :end element))
23086 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23087 (line-beginning-position))))
23088 (if (or (< (point) beg) (> (point) end)) t
23089 (fill-region-as-paragraph
23090 (save-excursion (end-of-line)
23091 (re-search-backward "^[ \t]*$" beg 'move)
23092 (line-beginning-position))
23093 (save-excursion (beginning-of-line)
23094 (re-search-forward "^[ \t]*$" end 'move)
23095 (line-beginning-position))
23096 justify))))
23097 ;; Fill comments.
23098 (comment
23099 (let ((begin (org-element-property :post-affiliated element))
23100 (end (org-element-property :end element)))
23101 (when (and (>= (point) begin) (<= (point) end))
23102 (let ((begin (save-excursion
23103 (end-of-line)
23104 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23105 (progn (forward-line) (point))
23106 begin)))
23107 (end (save-excursion
23108 (end-of-line)
23109 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23110 (1- (line-beginning-position))
23111 (skip-chars-backward " \r\t\n")
23112 (line-end-position)))))
23113 ;; Do not fill comments when at a blank line.
23114 (when (> end begin)
23115 (let ((fill-prefix
23116 (save-excursion
23117 (beginning-of-line)
23118 (looking-at "[ \t]*#")
23119 (let ((comment-prefix (match-string 0)))
23120 (goto-char (match-end 0))
23121 (if (looking-at adaptive-fill-regexp)
23122 (concat comment-prefix (match-string 0))
23123 (concat comment-prefix " "))))))
23124 (save-excursion
23125 (fill-region-as-paragraph begin end justify))))))
23127 ;; Ignore every other element.
23128 (otherwise t))))))
23130 (defun org-auto-fill-function ()
23131 "Auto-fill function."
23132 ;; Check if auto-filling is meaningful.
23133 (let ((fc (current-fill-column)))
23134 (when (and fc (> (current-column) fc))
23135 (let* ((fill-prefix (org-adaptive-fill-function))
23136 ;; Enforce empty fill prefix, if required. Otherwise, it
23137 ;; will be computed again.
23138 (adaptive-fill-mode (not (equal fill-prefix ""))))
23139 (when fill-prefix (do-auto-fill))))))
23141 (defun org-comment-line-break-function (&optional soft)
23142 "Break line at point and indent, continuing comment if within one.
23143 The inserted newline is marked hard if variable
23144 `use-hard-newlines' is true, unless optional argument SOFT is
23145 non-nil."
23146 (if soft (insert-and-inherit ?\n) (newline 1))
23147 (save-excursion (forward-char -1) (delete-horizontal-space))
23148 (delete-horizontal-space)
23149 (indent-to-left-margin)
23150 (insert-before-markers-and-inherit fill-prefix))
23153 ;;; Fixed Width Areas
23155 (defun org-toggle-fixed-width ()
23156 "Toggle fixed-width markup.
23158 Add or remove fixed-width markup on current line, whenever it
23159 makes sense. Return an error otherwise.
23161 If a region is active and if it contains only fixed-width areas
23162 or blank lines, remove all fixed-width markup in it. If the
23163 region contains anything else, convert all non-fixed-width lines
23164 to fixed-width ones.
23166 Blank lines at the end of the region are ignored unless the
23167 region only contains such lines."
23168 (interactive)
23169 (if (not (org-region-active-p))
23170 ;; No region:
23172 ;; Remove fixed width marker only in a fixed-with element.
23174 ;; Add fixed width maker in paragraphs, in blank lines after
23175 ;; elements or at the beginning of a headline or an inlinetask,
23176 ;; and before any one-line elements (e.g., a clock).
23177 (progn
23178 (beginning-of-line)
23179 (let* ((element (org-element-at-point))
23180 (type (org-element-type element)))
23181 (cond
23182 ((and (eq type 'fixed-width)
23183 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23184 (replace-match
23185 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23186 ((and (memq type '(babel-call clock comment diary-sexp headline
23187 horizontal-rule keyword paragraph
23188 planning))
23189 (<= (org-element-property :post-affiliated element) (point)))
23190 (skip-chars-forward " \t")
23191 (insert ": "))
23192 ((and (org-looking-at-p "[ \t]*$")
23193 (or (eq type 'inlinetask)
23194 (save-excursion
23195 (skip-chars-forward " \r\t\n")
23196 (<= (org-element-property :end element) (point)))))
23197 (delete-region (point) (line-end-position))
23198 (org-indent-line)
23199 (insert ": "))
23200 (t (user-error "Cannot insert a fixed-width line here")))))
23201 ;; Region active.
23202 (let* ((begin (save-excursion
23203 (goto-char (region-beginning))
23204 (line-beginning-position)))
23205 (end (copy-marker
23206 (save-excursion
23207 (goto-char (region-end))
23208 (unless (eolp) (beginning-of-line))
23209 (if (save-excursion (re-search-backward "\\S-" begin t))
23210 (progn (skip-chars-backward " \r\t\n") (point))
23211 (point)))))
23212 (all-fixed-width-p
23213 (catch 'not-all-p
23214 (save-excursion
23215 (goto-char begin)
23216 (skip-chars-forward " \r\t\n")
23217 (when (eobp) (throw 'not-all-p nil))
23218 (while (< (point) end)
23219 (let ((element (org-element-at-point)))
23220 (if (eq (org-element-type element) 'fixed-width)
23221 (goto-char (org-element-property :end element))
23222 (throw 'not-all-p nil))))
23223 t))))
23224 (if all-fixed-width-p
23225 (save-excursion
23226 (goto-char begin)
23227 (while (< (point) end)
23228 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23229 (replace-match
23230 "" nil nil nil
23231 (if (= (line-end-position) (match-end 0)) 0 1)))
23232 (forward-line)))
23233 (let ((min-ind (point-max)))
23234 ;; Find minimum indentation across all lines.
23235 (save-excursion
23236 (goto-char begin)
23237 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23238 (setq min-ind 0)
23239 (catch 'zerop
23240 (while (< (point) end)
23241 (unless (org-looking-at-p "[ \t]*$")
23242 (let ((ind (org-get-indentation)))
23243 (setq min-ind (min min-ind ind))
23244 (when (zerop ind) (throw 'zerop t))))
23245 (forward-line)))))
23246 ;; Loop over all lines and add fixed-width markup everywhere
23247 ;; but in fixed-width lines.
23248 (save-excursion
23249 (goto-char begin)
23250 (while (< (point) end)
23251 (cond
23252 ((org-at-heading-p)
23253 (insert ": ")
23254 (forward-line)
23255 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23256 (insert ":")
23257 (forward-line)))
23258 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23259 (let* ((element (org-element-at-point))
23260 (element-end (org-element-property :end element)))
23261 (if (eq (org-element-type element) 'fixed-width)
23262 (progn (goto-char element-end)
23263 (skip-chars-backward " \r\t\n")
23264 (forward-line))
23265 (let ((limit (min end element-end)))
23266 (while (< (point) limit)
23267 (org-move-to-column min-ind t)
23268 (insert ": ")
23269 (forward-line))))))
23271 (org-move-to-column min-ind t)
23272 (insert ": ")
23273 (forward-line)))))))
23274 (set-marker end nil))))
23277 ;;; Comments
23279 ;; Org comments syntax is quite complex. It requires the entire line
23280 ;; to be just a comment. Also, even with the right syntax at the
23281 ;; beginning of line, some some elements (i.e. verse-block or
23282 ;; example-block) don't accept comments. Usual Emacs comment commands
23283 ;; cannot cope with those requirements. Therefore, Org replaces them.
23285 ;; Org still relies on `comment-dwim', but cannot trust
23286 ;; `comment-only-p'. So, `comment-region-function' and
23287 ;; `uncomment-region-function' both point
23288 ;; to`org-comment-or-uncomment-region'. Eventually,
23289 ;; `org-insert-comment' takes care of insertion of comments at the
23290 ;; beginning of line.
23292 ;; `org-setup-comments-handling' install comments related variables
23293 ;; during `org-mode' initialization.
23295 (defun org-setup-comments-handling ()
23296 (interactive)
23297 (org-set-local 'comment-use-syntax nil)
23298 (org-set-local 'comment-start "# ")
23299 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23300 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23301 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23302 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23304 (defun org-insert-comment ()
23305 "Insert an empty comment above current line.
23306 If the line is empty, insert comment at its beginning. When
23307 point is within a source block, comment according to the related
23308 major mode."
23309 (if (let ((element (org-element-at-point)))
23310 (and (eq (org-element-type element) 'src-block)
23311 (< (save-excursion
23312 (goto-char (org-element-property :post-affiliated element))
23313 (line-end-position))
23314 (point))
23315 (> (save-excursion
23316 (goto-char (org-element-property :end element))
23317 (skip-chars-backward " \r\t\n")
23318 (line-beginning-position))
23319 (point))))
23320 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23321 (beginning-of-line)
23322 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23323 (open-line 1))
23324 (org-indent-line)
23325 (insert "# ")))
23327 (defvar comment-empty-lines) ; From newcomment.el.
23328 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23329 "Comment or uncomment each non-blank line in the region.
23330 Uncomment each non-blank line between BEG and END if it only
23331 contains commented lines. Otherwise, comment them. If region is
23332 strictly within a source block, use appropriate comment syntax."
23333 (if (let ((element (org-element-at-point)))
23334 (and (eq (org-element-type element) 'src-block)
23335 (< (save-excursion
23336 (goto-char (org-element-property :post-affiliated element))
23337 (line-end-position))
23338 beg)
23339 (>= (save-excursion
23340 (goto-char (org-element-property :end element))
23341 (skip-chars-backward " \r\t\n")
23342 (line-beginning-position))
23343 end)))
23344 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23345 (save-restriction
23346 ;; Restrict region
23347 (narrow-to-region (save-excursion (goto-char beg)
23348 (skip-chars-forward " \r\t\n" end)
23349 (line-beginning-position))
23350 (save-excursion (goto-char end)
23351 (skip-chars-backward " \r\t\n" beg)
23352 (line-end-position)))
23353 (let ((uncommentp
23354 ;; UNCOMMENTP is non-nil when every non blank line between
23355 ;; BEG and END is a comment.
23356 (save-excursion
23357 (goto-char (point-min))
23358 (while (and (not (eobp))
23359 (let ((element (org-element-at-point)))
23360 (and (eq (org-element-type element) 'comment)
23361 (goto-char (min (point-max)
23362 (org-element-property
23363 :end element)))))))
23364 (eobp))))
23365 (if uncommentp
23366 ;; Only blank lines and comments in region: uncomment it.
23367 (save-excursion
23368 (goto-char (point-min))
23369 (while (not (eobp))
23370 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23371 (replace-match "" nil nil nil 1))
23372 (forward-line)))
23373 ;; Comment each line in region.
23374 (let ((min-indent (point-max)))
23375 ;; First find the minimum indentation across all lines.
23376 (save-excursion
23377 (goto-char (point-min))
23378 (while (and (not (eobp)) (not (zerop min-indent)))
23379 (unless (looking-at "[ \t]*$")
23380 (setq min-indent (min min-indent (current-indentation))))
23381 (forward-line)))
23382 ;; Then loop over all lines.
23383 (save-excursion
23384 (goto-char (point-min))
23385 (while (not (eobp))
23386 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23387 ;; Don't get fooled by invisible text (e.g. link path)
23388 ;; when moving to column MIN-INDENT.
23389 (let ((buffer-invisibility-spec nil))
23390 (org-move-to-column min-indent t))
23391 (insert comment-start))
23392 (forward-line)))))))))
23394 (defun org-comment-dwim (arg)
23395 "Call `comment-dwim' within a source edit buffer if needed."
23396 (interactive "*P")
23397 (if (org-in-src-block-p)
23398 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23399 (call-interactively 'comment-dwim)))
23402 ;;; Planning
23404 ;; This section contains tools to operate on timestamp objects, as
23405 ;; returned by, e.g. `org-element-context'.
23407 (defun org-timestamp-has-time-p (timestamp)
23408 "Non-nil when TIMESTAMP has a time specified."
23409 (org-element-property :hour-start timestamp))
23411 (defun org-timestamp-format (timestamp format &optional end utc)
23412 "Format a TIMESTAMP element into a string.
23414 FORMAT is a format specifier to be passed to
23415 `format-time-string'.
23417 When optional argument END is non-nil, use end of date-range or
23418 time-range, if possible.
23420 When optional argument UTC is non-nil, time will be expressed as
23421 Universal Time."
23422 (format-time-string
23423 format
23424 (apply 'encode-time
23425 (cons 0
23426 (mapcar
23427 (lambda (prop) (or (org-element-property prop timestamp) 0))
23428 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23429 '(:minute-start :hour-start :day-start :month-start
23430 :year-start)))))
23431 utc))
23433 (defun org-timestamp-split-range (timestamp &optional end)
23434 "Extract a timestamp object from a date or time range.
23436 TIMESTAMP is a timestamp object. END, when non-nil, means extract
23437 the end of the range. Otherwise, extract its start.
23439 Return a new timestamp object sharing the same parent as
23440 TIMESTAMP."
23441 (let ((type (org-element-property :type timestamp)))
23442 (if (memq type '(active inactive diary)) timestamp
23443 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
23444 ;; Set new type.
23445 (org-element-put-property
23446 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23447 ;; Copy start properties over end properties if END is
23448 ;; non-nil. Otherwise, copy end properties over `start' ones.
23449 (let ((p-alist '((:minute-start . :minute-end)
23450 (:hour-start . :hour-end)
23451 (:day-start . :day-end)
23452 (:month-start . :month-end)
23453 (:year-start . :year-end))))
23454 (dolist (p-cell p-alist)
23455 (org-element-put-property
23456 split-ts
23457 (funcall (if end 'car 'cdr) p-cell)
23458 (org-element-property
23459 (funcall (if end 'cdr 'car) p-cell) split-ts)))
23460 ;; Eventually refresh `:raw-value'.
23461 (org-element-put-property split-ts :raw-value nil)
23462 (org-element-put-property
23463 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23465 (defun org-timestamp-translate (timestamp &optional boundary)
23466 "Translate TIMESTAMP object to custom format.
23468 Format string is defined in `org-time-stamp-custom-formats',
23469 which see.
23471 When optional argument BOUNDARY is non-nil, it is either the
23472 symbol `start' or `end'. In this case, only translate the
23473 starting or ending part of TIMESTAMP if it is a date or time
23474 range. Otherwise, translate both parts.
23476 Return timestamp as-is if `org-display-custom-times' is nil or if
23477 it has a `diary' type."
23478 (let ((type (org-element-property :type timestamp)))
23479 (if (or (not org-display-custom-times) (eq type 'diary))
23480 (org-element-interpret-data timestamp)
23481 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23482 org-time-stamp-custom-formats)))
23483 (if (and (not boundary) (memq type '(active-range inactive-range)))
23484 (concat (org-timestamp-format timestamp fmt)
23485 "--"
23486 (org-timestamp-format timestamp fmt t))
23487 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23491 ;;; Other stuff.
23493 (defun org-reftex-citation ()
23494 "Use reftex-citation to insert a citation into the buffer.
23495 This looks for a line like
23497 #+BIBLIOGRAPHY: foo plain option:-d
23499 and derives from it that foo.bib is the bibliography file relevant
23500 for this document. It then installs the necessary environment for RefTeX
23501 to work in this buffer and calls `reftex-citation' to insert a citation
23502 into the buffer.
23504 Export of such citations to both LaTeX and HTML is handled by the contributed
23505 package ox-bibtex by Taru Karttunen."
23506 (interactive)
23507 (let ((reftex-docstruct-symbol 'rds)
23508 (reftex-cite-format "\\cite{%l}")
23509 rds bib)
23510 (save-excursion
23511 (save-restriction
23512 (widen)
23513 (let ((case-fold-search t)
23514 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23515 (if (not (save-excursion
23516 (or (re-search-forward re nil t)
23517 (re-search-backward re nil t))))
23518 (user-error "No bibliography defined in file")
23519 (setq bib (concat (match-string 1) ".bib")
23520 rds (list (list 'bib bib)))))))
23521 (call-interactively 'reftex-citation)))
23523 ;;;; Functions extending outline functionality
23525 (defun org-beginning-of-line (&optional arg)
23526 "Go to the beginning of the current line. If that is invisible, continue
23527 to a visible line beginning. This makes the function of C-a more intuitive.
23528 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23529 first attempt, and only move to after the tags when the cursor is already
23530 beyond the end of the headline."
23531 (interactive "P")
23532 (let ((pos (point))
23533 (special (if (consp org-special-ctrl-a/e)
23534 (car org-special-ctrl-a/e)
23535 org-special-ctrl-a/e))
23536 deactivate-mark refpos)
23537 (if (org-bound-and-true-p visual-line-mode)
23538 (beginning-of-visual-line 1)
23539 (beginning-of-line 1))
23540 (if (and arg (fboundp 'move-beginning-of-line))
23541 (call-interactively 'move-beginning-of-line)
23542 (if (bobp)
23544 (backward-char 1)
23545 (if (org-truely-invisible-p)
23546 (while (and (not (bobp)) (org-truely-invisible-p))
23547 (backward-char 1)
23548 (beginning-of-line 1))
23549 (forward-char 1))))
23550 (when special
23551 (cond
23552 ((and (looking-at org-complex-heading-regexp)
23553 (= (char-after (match-end 1)) ?\ ))
23554 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23555 (point-at-eol)))
23556 (goto-char
23557 (if (eq special t)
23558 (cond ((> pos refpos) refpos)
23559 ((= pos (point)) refpos)
23560 (t (point)))
23561 (cond ((> pos (point)) (point))
23562 ((not (eq last-command this-command)) (point))
23563 (t refpos)))))
23564 ((org-at-item-p)
23565 ;; Being at an item and not looking at an the item means point
23566 ;; was previously moved to beginning of a visual line, which
23567 ;; doesn't contain the item. Therefore, do nothing special,
23568 ;; just stay here.
23569 (when (looking-at org-list-full-item-re)
23570 ;; Set special position at first white space character after
23571 ;; bullet, and check-box, if any.
23572 (let ((after-bullet
23573 (let ((box (match-end 3)))
23574 (if (not box) (match-end 1)
23575 (let ((after (char-after box)))
23576 (if (and after (= after ? )) (1+ box) box))))))
23577 ;; Special case: Move point to special position when
23578 ;; currently after it or at beginning of line.
23579 (if (eq special t)
23580 (when (or (> pos after-bullet) (= (point) pos))
23581 (goto-char after-bullet))
23582 ;; Reversed case: Move point to special position when
23583 ;; point was already at beginning of line and command is
23584 ;; repeated.
23585 (when (and (= (point) pos) (eq last-command this-command))
23586 (goto-char after-bullet))))))))
23587 (org-no-warnings
23588 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23589 (setq disable-point-adjustment
23590 (or (not (invisible-p (point)))
23591 (not (invisible-p (max (point-min) (1- (point))))))))
23593 (defun org-end-of-line (&optional arg)
23594 "Go to the end of the line.
23595 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23596 tags on the first attempt, and only move to after the tags when
23597 the cursor is already beyond the end of the headline."
23598 (interactive "P")
23599 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23600 org-special-ctrl-a/e))
23601 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23602 'end-of-visual-line)
23603 ((fboundp 'move-end-of-line) 'move-end-of-line)
23604 (t 'end-of-line)))
23605 deactivate-mark)
23606 (if (or (not special) arg) (call-interactively move-fun)
23607 (let* ((element (save-excursion (beginning-of-line)
23608 (org-element-at-point)))
23609 (type (org-element-type element)))
23610 (cond
23611 ((memq type '(headline inlinetask))
23612 (let ((pos (point)))
23613 (beginning-of-line 1)
23614 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23615 (if (eq special t)
23616 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23617 (goto-char (match-beginning 1))
23618 (goto-char (match-end 0)))
23619 (if (or (< pos (match-end 0))
23620 (not (eq this-command last-command)))
23621 (goto-char (match-end 0))
23622 (goto-char (match-beginning 1))))
23623 (call-interactively move-fun))))
23624 ((outline-invisible-p (line-end-position))
23625 ;; If element is hidden, `move-end-of-line' would put point
23626 ;; after it. Use `end-of-line' to stay on current line.
23627 (call-interactively 'end-of-line))
23628 (t (call-interactively move-fun)))))
23629 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23630 (setq disable-point-adjustment
23631 (or (not (invisible-p (point)))
23632 (not (invisible-p (max (point-min) (1- (point))))))))
23634 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23635 (define-key org-mode-map "\C-e" 'org-end-of-line)
23637 (defun org-backward-sentence (&optional arg)
23638 "Go to beginning of sentence, or beginning of table field.
23639 This will call `backward-sentence' or `org-table-beginning-of-field',
23640 depending on context."
23641 (interactive "P")
23642 (cond
23643 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
23644 (t (call-interactively 'backward-sentence))))
23646 (defun org-forward-sentence (&optional arg)
23647 "Go to end of sentence, or end of table field.
23648 This will call `forward-sentence' or `org-table-end-of-field',
23649 depending on context."
23650 (interactive "P")
23651 (cond
23652 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
23653 (t (call-interactively 'forward-sentence))))
23655 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23656 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23658 (defun org-kill-line (&optional arg)
23659 "Kill line, to tags or end of line."
23660 (interactive "P")
23661 (cond
23662 ((or (not org-special-ctrl-k)
23663 (bolp)
23664 (not (org-at-heading-p)))
23665 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23666 org-ctrl-k-protect-subtree)
23667 (if (or (eq org-ctrl-k-protect-subtree 'error)
23668 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23669 (user-error "C-k aborted as it would kill a hidden subtree")))
23670 (call-interactively
23671 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23672 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23673 (kill-region (point) (match-beginning 1))
23674 (org-set-tags nil t))
23675 (t (kill-region (point) (point-at-eol)))))
23677 (define-key org-mode-map "\C-k" 'org-kill-line)
23679 (defun org-yank (&optional arg)
23680 "Yank. If the kill is a subtree, treat it specially.
23681 This command will look at the current kill and check if is a single
23682 subtree, or a series of subtrees[1]. If it passes the test, and if the
23683 cursor is at the beginning of a line or after the stars of a currently
23684 empty headline, then the yank is handled specially. How exactly depends
23685 on the value of the following variables, both set by default.
23687 `org-yank-folded-subtrees'
23688 When set, the subtree(s) will be folded after insertion, but only
23689 if doing so would now swallow text after the yanked text.
23691 `org-yank-adjusted-subtrees'
23692 When set, the subtree will be promoted or demoted in order to
23693 fit into the local outline tree structure, which means that the
23694 level will be adjusted so that it becomes the smaller one of the
23695 two *visible* surrounding headings.
23697 Any prefix to this command will cause `yank' to be called directly with
23698 no special treatment. In particular, a simple \\[universal-argument] prefix \
23699 will just
23700 plainly yank the text as it is.
23702 \[1] The test checks if the first non-white line is a heading
23703 and if there are no other headings with fewer stars."
23704 (interactive "P")
23705 (org-yank-generic 'yank arg))
23707 (defun org-yank-generic (command arg)
23708 "Perform some yank-like command.
23710 This function implements the behavior described in the `org-yank'
23711 documentation. However, it has been generalized to work for any
23712 interactive command with similar behavior."
23714 ;; pretend to be command COMMAND
23715 (setq this-command command)
23717 (if arg
23718 (call-interactively command)
23720 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23721 (and (org-kill-is-subtree-p)
23722 (or (bolp)
23723 (and (looking-at "[ \t]*$")
23724 (string-match
23725 "\\`\\*+\\'"
23726 (buffer-substring (point-at-bol) (point)))))))
23727 swallowp)
23728 (cond
23729 ((and subtreep org-yank-folded-subtrees)
23730 (let ((beg (point))
23731 end)
23732 (if (and subtreep org-yank-adjusted-subtrees)
23733 (org-paste-subtree nil nil 'for-yank)
23734 (call-interactively command))
23736 (setq end (point))
23737 (goto-char beg)
23738 (when (and (bolp) subtreep
23739 (not (setq swallowp
23740 (org-yank-folding-would-swallow-text beg end))))
23741 (org-with-limited-levels
23742 (or (looking-at org-outline-regexp)
23743 (re-search-forward org-outline-regexp-bol end t))
23744 (while (and (< (point) end) (looking-at org-outline-regexp))
23745 (hide-subtree)
23746 (org-cycle-show-empty-lines 'folded)
23747 (condition-case nil
23748 (outline-forward-same-level 1)
23749 (error (goto-char end))))))
23750 (when swallowp
23751 (message
23752 "Inserted text not folded because that would swallow text"))
23754 (goto-char end)
23755 (skip-chars-forward " \t\n\r")
23756 (beginning-of-line 1)
23757 (push-mark beg 'nomsg)))
23758 ((and subtreep org-yank-adjusted-subtrees)
23759 (let ((beg (point-at-bol)))
23760 (org-paste-subtree nil nil 'for-yank)
23761 (push-mark beg 'nomsg)))
23763 (call-interactively command))))))
23765 (defun org-yank-folding-would-swallow-text (beg end)
23766 "Would hide-subtree at BEG swallow any text after END?"
23767 (let (level)
23768 (org-with-limited-levels
23769 (save-excursion
23770 (goto-char beg)
23771 (when (or (looking-at org-outline-regexp)
23772 (re-search-forward org-outline-regexp-bol end t))
23773 (setq level (org-outline-level)))
23774 (goto-char end)
23775 (skip-chars-forward " \t\r\n\v\f")
23776 (if (or (eobp)
23777 (and (bolp) (looking-at org-outline-regexp)
23778 (<= (org-outline-level) level)))
23779 nil ; Nothing would be swallowed
23780 t))))) ; something would swallow
23782 (define-key org-mode-map "\C-y" 'org-yank)
23784 (defun org-truely-invisible-p ()
23785 "Check if point is at a character currently not visible.
23786 This version does not only check the character property, but also
23787 `visible-mode'."
23788 ;; Early versions of noutline don't have `outline-invisible-p'.
23789 (if (org-bound-and-true-p visible-mode)
23791 (outline-invisible-p)))
23793 (defun org-invisible-p2 ()
23794 "Check if point is at a character currently not visible."
23795 (save-excursion
23796 (if (and (eolp) (not (bobp))) (backward-char 1))
23797 ;; Early versions of noutline don't have `outline-invisible-p'.
23798 (outline-invisible-p)))
23800 (defun org-back-to-heading (&optional invisible-ok)
23801 "Call `outline-back-to-heading', but provide a better error message."
23802 (condition-case nil
23803 (outline-back-to-heading invisible-ok)
23804 (error (error "Before first headline at position %d in buffer %s"
23805 (point) (current-buffer)))))
23807 (defun org-before-first-heading-p ()
23808 "Before first heading?"
23809 (save-excursion
23810 (end-of-line)
23811 (null (re-search-backward org-outline-regexp-bol nil t))))
23813 (defun org-at-heading-p (&optional ignored)
23814 (outline-on-heading-p t))
23815 ;; Compatibility alias with Org versions < 7.8.03
23816 (defalias 'org-on-heading-p 'org-at-heading-p)
23818 (defun org-in-commented-heading-p (&optional no-inheritance)
23819 "Non-nil if point is under a commented heading.
23820 This function also checks ancestors of the current headline,
23821 unless optional argument NO-INHERITANCE is non-nil."
23822 (cond
23823 ((org-before-first-heading-p) nil)
23824 ((let ((headline (nth 4 (org-heading-components))))
23825 (and headline
23826 (let ((case-fold-search nil))
23827 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
23828 headline)))))
23829 (no-inheritance nil)
23831 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
23833 (defun org-at-comment-p nil
23834 "Is cursor in a commented line?"
23835 (save-excursion
23836 (save-match-data
23837 (beginning-of-line)
23838 (looking-at "^[ \t]*# "))))
23840 (defun org-at-drawer-p nil
23841 "Is cursor at a drawer keyword?"
23842 (save-excursion
23843 (move-beginning-of-line 1)
23844 (looking-at org-drawer-regexp)))
23846 (defun org-at-block-p nil
23847 "Is cursor at a block keyword?"
23848 (save-excursion
23849 (move-beginning-of-line 1)
23850 (looking-at org-block-regexp)))
23852 (defun org-point-at-end-of-empty-headline ()
23853 "If point is at the end of an empty headline, return t, else nil.
23854 If the heading only contains a TODO keyword, it is still still considered
23855 empty."
23856 (and (looking-at "[ \t]*$")
23857 (when org-todo-line-regexp
23858 (save-excursion
23859 (beginning-of-line 1)
23860 (let ((case-fold-search nil))
23861 (looking-at org-todo-line-regexp)
23862 (string= (match-string 3) ""))))))
23864 (defun org-at-heading-or-item-p ()
23865 (or (org-at-heading-p) (org-at-item-p)))
23867 (defun org-at-target-p ()
23868 (or (org-in-regexp org-radio-target-regexp)
23869 (org-in-regexp org-target-regexp)))
23870 ;; Compatibility alias with Org versions < 7.8.03
23871 (defalias 'org-on-target-p 'org-at-target-p)
23873 (defun org-up-heading-all (arg)
23874 "Move to the heading line of which the present line is a subheading.
23875 This function considers both visible and invisible heading lines.
23876 With argument, move up ARG levels."
23877 (if (fboundp 'outline-up-heading-all)
23878 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23879 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23881 (defun org-up-heading-safe ()
23882 "Move to the heading line of which the present line is a subheading.
23883 This version will not throw an error. It will return the level of the
23884 headline found, or nil if no higher level is found.
23886 Also, this function will be a lot faster than `outline-up-heading',
23887 because it relies on stars being the outline starters. This can really
23888 make a significant difference in outlines with very many siblings."
23889 (when (ignore-errors (org-back-to-heading t))
23890 (let ((level-up (1- (funcall outline-level))))
23891 (and (> level-up 0)
23892 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
23893 (funcall outline-level)))))
23895 (defun org-first-sibling-p ()
23896 "Is this heading the first child of its parents?"
23897 (interactive)
23898 (let ((re org-outline-regexp-bol)
23899 level l)
23900 (unless (org-at-heading-p t)
23901 (user-error "Not at a heading"))
23902 (setq level (funcall outline-level))
23903 (save-excursion
23904 (if (not (re-search-backward re nil t))
23906 (setq l (funcall outline-level))
23907 (< l level)))))
23909 (defun org-goto-sibling (&optional previous)
23910 "Goto the next sibling, even if it is invisible.
23911 When PREVIOUS is set, go to the previous sibling instead. Returns t
23912 when a sibling was found. When none is found, return nil and don't
23913 move point."
23914 (let ((fun (if previous 're-search-backward 're-search-forward))
23915 (pos (point))
23916 (re org-outline-regexp-bol)
23917 level l)
23918 (when (ignore-errors (org-back-to-heading t))
23919 (setq level (funcall outline-level))
23920 (catch 'exit
23921 (or previous (forward-char 1))
23922 (while (funcall fun re nil t)
23923 (setq l (funcall outline-level))
23924 (when (< l level) (goto-char pos) (throw 'exit nil))
23925 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23926 (goto-char pos)
23927 nil))))
23929 (defun org-show-siblings ()
23930 "Show all siblings of the current headline."
23931 (save-excursion
23932 (while (org-goto-sibling) (org-flag-heading nil)))
23933 (save-excursion
23934 (while (org-goto-sibling 'previous)
23935 (org-flag-heading nil))))
23937 (defun org-goto-first-child ()
23938 "Goto the first child, even if it is invisible.
23939 Return t when a child was found. Otherwise don't move point and
23940 return nil."
23941 (let (level (pos (point)) (re org-outline-regexp-bol))
23942 (when (ignore-errors (org-back-to-heading t))
23943 (setq level (outline-level))
23944 (forward-char 1)
23945 (if (and (re-search-forward re nil t) (> (outline-level) level))
23946 (progn (goto-char (match-beginning 0)) t)
23947 (goto-char pos) nil))))
23949 (defun org-show-hidden-entry ()
23950 "Show an entry where even the heading is hidden."
23951 (save-excursion
23952 (org-show-entry)))
23954 (defun org-flag-heading (flag &optional entry)
23955 "Flag the current heading. FLAG non-nil means make invisible.
23956 When ENTRY is non-nil, show the entire entry."
23957 (save-excursion
23958 (org-back-to-heading t)
23959 ;; Check if we should show the entire entry
23960 (if entry
23961 (progn
23962 (org-show-entry)
23963 (save-excursion
23964 (and (outline-next-heading)
23965 (org-flag-heading nil))))
23966 (outline-flag-region (max (point-min) (1- (point)))
23967 (save-excursion (outline-end-of-heading) (point))
23968 flag))))
23970 (defun org-get-next-sibling ()
23971 "Move to next heading of the same level, and return point.
23972 If there is no such heading, return nil.
23973 This is like outline-next-sibling, but invisible headings are ok."
23974 (let ((level (funcall outline-level)))
23975 (outline-next-heading)
23976 (while (and (not (eobp)) (> (funcall outline-level) level))
23977 (outline-next-heading))
23978 (if (or (eobp) (< (funcall outline-level) level))
23980 (point))))
23982 (defun org-get-last-sibling ()
23983 "Move to previous heading of the same level, and return point.
23984 If there is no such heading, return nil."
23985 (let ((opoint (point))
23986 (level (funcall outline-level)))
23987 (outline-previous-heading)
23988 (when (and (/= (point) opoint) (outline-on-heading-p t))
23989 (while (and (> (funcall outline-level) level)
23990 (not (bobp)))
23991 (outline-previous-heading))
23992 (if (< (funcall outline-level) level)
23994 (point)))))
23996 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23997 "Goto to the end of a subtree."
23998 ;; This contains an exact copy of the original function, but it uses
23999 ;; `org-back-to-heading', to make it work also in invisible
24000 ;; trees. And is uses an invisible-ok argument.
24001 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24002 ;; Furthermore, when used inside Org, finding the end of a large subtree
24003 ;; with many children and grandchildren etc, this can be much faster
24004 ;; than the outline version.
24005 (org-back-to-heading invisible-ok)
24006 (let ((first t)
24007 (level (funcall outline-level)))
24008 (if (and (derived-mode-p 'org-mode) (< level 1000))
24009 ;; A true heading (not a plain list item), in Org-mode
24010 ;; This means we can easily find the end by looking
24011 ;; only for the right number of stars. Using a regexp to do
24012 ;; this is so much faster than using a Lisp loop.
24013 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24014 (forward-char 1)
24015 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24016 ;; something else, do it the slow way
24017 (while (and (not (eobp))
24018 (or first (> (funcall outline-level) level)))
24019 (setq first nil)
24020 (outline-next-heading)))
24021 (unless to-heading
24022 (if (memq (preceding-char) '(?\n ?\^M))
24023 (progn
24024 ;; Go to end of line before heading
24025 (forward-char -1)
24026 (if (memq (preceding-char) '(?\n ?\^M))
24027 ;; leave blank line before heading
24028 (forward-char -1))))))
24029 (point))
24031 (defun org-end-of-meta-data-and-drawers ()
24032 "Jump to the first text after meta data and drawers in the current entry.
24033 This will move over empty lines, lines with planning time stamps,
24034 clocking lines, and drawers."
24035 (org-back-to-heading t)
24036 (let ((end (save-excursion (outline-next-heading) (point)))
24037 (re (concat "\\(" org-drawer-regexp "\\)"
24038 "\\|" "[ \t]*" org-keyword-time-regexp)))
24039 (forward-line 1)
24040 (while (re-search-forward re end t)
24041 (if (not (match-end 1))
24042 ;; empty or planning line
24043 (forward-line 1)
24044 ;; a drawer, find the end
24045 (re-search-forward "^[ \t]*:END:" end 'move)
24046 (forward-line 1)))
24047 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
24048 (point)))
24050 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24051 "Move forward to the ARG'th subheading at same level as this one.
24052 Stop at the first and last subheadings of a superior heading.
24053 Normally this only looks at visible headings, but when INVISIBLE-OK is
24054 non-nil it will also look at invisible ones."
24055 (interactive "p")
24056 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24057 (if (and arg (< arg 0))
24058 (goto-char (point-min))
24059 (outline-next-heading))
24060 (org-at-heading-p)
24061 (let ((level (- (match-end 0) (match-beginning 0) 1))
24062 (f (if (and arg (< arg 0))
24063 're-search-backward
24064 're-search-forward))
24065 (count (if arg (abs arg) 1))
24066 (result (point)))
24067 (while (and (prog1 (> count 0)
24068 (forward-char (if (and arg (< arg 0)) -1 1)))
24069 (funcall f org-outline-regexp-bol nil 'move))
24070 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24071 (cond ((< l level) (setq count 0))
24072 ((and (= l level)
24073 (or invisible-ok
24074 (progn
24075 (goto-char (line-beginning-position))
24076 (not (outline-invisible-p)))))
24077 (setq count (1- count))
24078 (when (eq l level)
24079 (setq result (point)))))))
24080 (goto-char result))
24081 (beginning-of-line 1)))
24083 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24084 "Move backward to the ARG'th subheading at same level as this one.
24085 Stop at the first and last subheadings of a superior heading."
24086 (interactive "p")
24087 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24089 (defun org-next-block (arg &optional backward block-regexp)
24090 "Jump to the next block.
24091 With a prefix argument ARG, jump forward ARG many source blocks.
24092 When BACKWARD is non-nil, jump to the previous block.
24093 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24094 (interactive "p")
24095 (let ((re (or block-regexp org-block-regexp))
24096 (re-search-fn (or (and backward 're-search-backward)
24097 're-search-forward)))
24098 (if (looking-at re) (forward-char 1))
24099 (condition-case nil
24100 (funcall re-search-fn re nil nil arg)
24101 (error (user-error "No %s code blocks"
24102 (if backward "previous" "further" ))))
24103 (goto-char (match-beginning 0)) (org-show-context)))
24105 (defun org-previous-block (arg &optional block-regexp)
24106 "Jump to the previous block.
24107 With a prefix argument ARG, jump backward ARG many source blocks.
24108 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24109 (interactive "p")
24110 (org-next-block arg t block-regexp))
24112 (defun org-forward-paragraph ()
24113 "Move forward to beginning of next paragraph or equivalent.
24115 The function moves point to the beginning of the next visible
24116 structural element, which can be a paragraph, a table, a list
24117 item, etc. It also provides some special moves for convenience:
24119 - On an affiliated keyword, jump to the beginning of the
24120 relative element.
24121 - On an item or a footnote definition, move to the second
24122 element inside, if any.
24123 - On a table or a property drawer, jump after it.
24124 - On a verse or source block, stop after blank lines."
24125 (interactive)
24126 (when (eobp) (user-error "Cannot move further down"))
24127 (let* ((deactivate-mark nil)
24128 (element (org-element-at-point))
24129 (type (org-element-type element))
24130 (post-affiliated (org-element-property :post-affiliated element))
24131 (contents-begin (org-element-property :contents-begin element))
24132 (contents-end (org-element-property :contents-end element))
24133 (end (let ((end (org-element-property :end element)) (parent element))
24134 (while (and (setq parent (org-element-property :parent parent))
24135 (= (org-element-property :contents-end parent) end))
24136 (setq end (org-element-property :end parent)))
24137 end)))
24138 (cond ((not element)
24139 (skip-chars-forward " \r\t\n")
24140 (or (eobp) (beginning-of-line)))
24141 ;; On affiliated keywords, move to element's beginning.
24142 ((< (point) post-affiliated)
24143 (goto-char post-affiliated))
24144 ;; At a table row, move to the end of the table. Similarly,
24145 ;; at a node property, move to the end of the property
24146 ;; drawer.
24147 ((memq type '(node-property table-row))
24148 (goto-char (org-element-property
24149 :end (org-element-property :parent element))))
24150 ((memq type '(property-drawer table)) (goto-char end))
24151 ;; Consider blank lines as separators in verse and source
24152 ;; blocks to ease editing.
24153 ((memq type '(src-block verse-block))
24154 (when (eq type 'src-block)
24155 (setq contents-end
24156 (save-excursion (goto-char end)
24157 (skip-chars-backward " \r\t\n")
24158 (line-beginning-position))))
24159 (beginning-of-line)
24160 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24161 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24162 (goto-char end)
24163 (skip-chars-forward " \r\t\n")
24164 (if (= (point) contents-end) (goto-char end)
24165 (beginning-of-line))))
24166 ;; With no contents, just skip element.
24167 ((not contents-begin) (goto-char end))
24168 ;; If contents are invisible, skip the element altogether.
24169 ((outline-invisible-p (line-end-position))
24170 (case type
24171 (headline
24172 (org-with-limited-levels (outline-next-visible-heading 1)))
24173 ;; At a plain list, make sure we move to the next item
24174 ;; instead of skipping the whole list.
24175 (plain-list (forward-char)
24176 (org-forward-paragraph))
24177 (otherwise (goto-char end))))
24178 ((>= (point) contents-end) (goto-char end))
24179 ((>= (point) contents-begin)
24180 ;; This can only happen on paragraphs and plain lists.
24181 (case type
24182 (paragraph (goto-char end))
24183 ;; At a plain list, try to move to second element in
24184 ;; first item, if possible.
24185 (plain-list (end-of-line)
24186 (org-forward-paragraph))))
24187 ;; When contents start on the middle of a line (e.g. in
24188 ;; items and footnote definitions), try to reach first
24189 ;; element starting after current line.
24190 ((> (line-end-position) contents-begin)
24191 (end-of-line)
24192 (org-forward-paragraph))
24193 (t (goto-char contents-begin)))))
24195 (defun org-backward-paragraph ()
24196 "Move backward to start of previous paragraph or equivalent.
24198 The function moves point to the beginning of the current
24199 structural element, which can be a paragraph, a table, a list
24200 item, etc., or to the beginning of the previous visible one if
24201 point is already there. It also provides some special moves for
24202 convenience:
24204 - On an affiliated keyword, jump to the first one.
24205 - On a table or a property drawer, move to its beginning.
24206 - On a verse or source block, stop before blank lines."
24207 (interactive)
24208 (when (bobp) (user-error "Cannot move further up"))
24209 (let* ((deactivate-mark nil)
24210 (element (org-element-at-point))
24211 (type (org-element-type element))
24212 (contents-begin (org-element-property :contents-begin element))
24213 (contents-end (org-element-property :contents-end element))
24214 (post-affiliated (org-element-property :post-affiliated element))
24215 (begin (org-element-property :begin element)))
24216 (cond
24217 ((not element) (goto-char (point-min)))
24218 ((= (point) begin)
24219 (backward-char)
24220 (org-backward-paragraph))
24221 ((<= (point) post-affiliated) (goto-char begin))
24222 ((memq type '(node-property table-row))
24223 (goto-char (org-element-property
24224 :post-affiliated (org-element-property :parent element))))
24225 ((memq type '(property-drawer table)) (goto-char begin))
24226 ((memq type '(src-block verse-block))
24227 (when (eq type 'src-block)
24228 (setq contents-begin
24229 (save-excursion (goto-char begin) (forward-line) (point))))
24230 (if (= (point) contents-begin) (goto-char post-affiliated)
24231 ;; Inside a verse block, see blank lines as paragraph
24232 ;; separators.
24233 (let ((origin (point)))
24234 (skip-chars-backward " \r\t\n" contents-begin)
24235 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24236 (skip-chars-forward " \r\t\n" origin)
24237 (if (= (point) origin) (goto-char contents-begin)
24238 (beginning-of-line))))))
24239 ((not contents-begin) (goto-char (or post-affiliated begin)))
24240 ((eq type 'paragraph)
24241 (goto-char contents-begin)
24242 ;; When at first paragraph in an item or a footnote definition,
24243 ;; move directly to beginning of line.
24244 (let ((parent-contents
24245 (org-element-property
24246 :contents-begin (org-element-property :parent element))))
24247 (when (and parent-contents (= parent-contents contents-begin))
24248 (beginning-of-line))))
24249 ;; At the end of a greater element, move to the beginning of the
24250 ;; last element within.
24251 ((>= (point) contents-end)
24252 (goto-char (1- contents-end))
24253 (org-backward-paragraph))
24254 (t (goto-char (or post-affiliated begin))))
24255 ;; Ensure we never leave point invisible.
24256 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24258 (defun org-forward-element ()
24259 "Move forward by one element.
24260 Move to the next element at the same level, when possible."
24261 (interactive)
24262 (cond ((eobp) (user-error "Cannot move further down"))
24263 ((org-with-limited-levels (org-at-heading-p))
24264 (let ((origin (point)))
24265 (goto-char (org-end-of-subtree nil t))
24266 (unless (org-with-limited-levels (org-at-heading-p))
24267 (goto-char origin)
24268 (user-error "Cannot move further down"))))
24270 (let* ((elem (org-element-at-point))
24271 (end (org-element-property :end elem))
24272 (parent (org-element-property :parent elem)))
24273 (cond ((and parent (= (org-element-property :contents-end parent) end))
24274 (goto-char (org-element-property :end parent)))
24275 ((integer-or-marker-p end) (goto-char end))
24276 (t (message "No element at point")))))))
24278 (defun org-backward-element ()
24279 "Move backward by one element.
24280 Move to the previous element at the same level, when possible."
24281 (interactive)
24282 (cond ((bobp) (user-error "Cannot move further up"))
24283 ((org-with-limited-levels (org-at-heading-p))
24284 ;; At a headline, move to the previous one, if any, or stay
24285 ;; here.
24286 (let ((origin (point)))
24287 (org-with-limited-levels (org-backward-heading-same-level 1))
24288 ;; When current headline has no sibling above, move to its
24289 ;; parent.
24290 (when (= (point) origin)
24291 (or (org-with-limited-levels (org-up-heading-safe))
24292 (progn (goto-char origin)
24293 (user-error "Cannot move further up"))))))
24295 (let* ((elem (org-element-at-point))
24296 (beg (org-element-property :begin elem)))
24297 (cond
24298 ;; Move to beginning of current element if point isn't
24299 ;; there already.
24300 ((null beg) (message "No element at point"))
24301 ((/= (point) beg) (goto-char beg))
24302 (t (goto-char beg)
24303 (skip-chars-backward " \r\t\n")
24304 (unless (bobp)
24305 (let ((prev (org-element-at-point)))
24306 (goto-char (org-element-property :begin prev))
24307 (while (and (setq prev (org-element-property :parent prev))
24308 (<= (org-element-property :end prev) beg))
24309 (goto-char (org-element-property :begin prev)))))))))))
24311 (defun org-up-element ()
24312 "Move to upper element."
24313 (interactive)
24314 (if (org-with-limited-levels (org-at-heading-p))
24315 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24316 (let* ((elem (org-element-at-point))
24317 (parent (org-element-property :parent elem)))
24318 (if parent (goto-char (org-element-property :begin parent))
24319 (if (org-with-limited-levels (org-before-first-heading-p))
24320 (user-error "No surrounding element")
24321 (org-with-limited-levels (org-back-to-heading)))))))
24323 (defvar org-element-greater-elements)
24324 (defun org-down-element ()
24325 "Move to inner element."
24326 (interactive)
24327 (let ((element (org-element-at-point)))
24328 (cond
24329 ((memq (org-element-type element) '(plain-list table))
24330 (goto-char (org-element-property :contents-begin element))
24331 (forward-char))
24332 ((memq (org-element-type element) org-element-greater-elements)
24333 ;; If contents are hidden, first disclose them.
24334 (when (outline-invisible-p (line-end-position)) (org-cycle))
24335 (goto-char (or (org-element-property :contents-begin element)
24336 (user-error "No content for this element"))))
24337 (t (user-error "No inner element")))))
24339 (defun org-drag-element-backward ()
24340 "Move backward element at point."
24341 (interactive)
24342 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24343 (let* ((elem (org-element-at-point))
24344 (prev-elem
24345 (save-excursion
24346 (goto-char (org-element-property :begin elem))
24347 (skip-chars-backward " \r\t\n")
24348 (unless (bobp)
24349 (let* ((beg (org-element-property :begin elem))
24350 (prev (org-element-at-point))
24351 (up prev))
24352 (while (and (setq up (org-element-property :parent up))
24353 (<= (org-element-property :end up) beg))
24354 (setq prev up))
24355 prev)))))
24356 ;; Error out if no previous element or previous element is
24357 ;; a parent of the current one.
24358 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24359 (user-error "Cannot drag element backward")
24360 (let ((pos (point)))
24361 (org-element-swap-A-B prev-elem elem)
24362 (goto-char (+ (org-element-property :begin prev-elem)
24363 (- pos (org-element-property :begin elem)))))))))
24365 (defun org-drag-element-forward ()
24366 "Move forward element at point."
24367 (interactive)
24368 (let* ((pos (point))
24369 (elem (org-element-at-point)))
24370 (when (= (point-max) (org-element-property :end elem))
24371 (user-error "Cannot drag element forward"))
24372 (goto-char (org-element-property :end elem))
24373 (let ((next-elem (org-element-at-point)))
24374 (when (or (org-element-nested-p elem next-elem)
24375 (and (eq (org-element-type next-elem) 'headline)
24376 (not (eq (org-element-type elem) 'headline))))
24377 (goto-char pos)
24378 (user-error "Cannot drag element forward"))
24379 ;; Compute new position of point: it's shifted by NEXT-ELEM
24380 ;; body's length (without final blanks) and by the length of
24381 ;; blanks between ELEM and NEXT-ELEM.
24382 (let ((size-next (- (save-excursion
24383 (goto-char (org-element-property :end next-elem))
24384 (skip-chars-backward " \r\t\n")
24385 (forward-line)
24386 ;; Small correction if buffer doesn't end
24387 ;; with a newline character.
24388 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24389 (org-element-property :begin next-elem)))
24390 (size-blank (- (org-element-property :end elem)
24391 (save-excursion
24392 (goto-char (org-element-property :end elem))
24393 (skip-chars-backward " \r\t\n")
24394 (forward-line)
24395 (point)))))
24396 (org-element-swap-A-B elem next-elem)
24397 (goto-char (+ pos size-next size-blank))))))
24399 (defun org-drag-line-forward (arg)
24400 "Drag the line at point ARG lines forward."
24401 (interactive "p")
24402 (dotimes (n (abs arg))
24403 (let ((c (current-column)))
24404 (if (< 0 arg)
24405 (progn
24406 (beginning-of-line 2)
24407 (transpose-lines 1)
24408 (beginning-of-line 0))
24409 (transpose-lines 1)
24410 (beginning-of-line -1))
24411 (org-move-to-column c))))
24413 (defun org-drag-line-backward (arg)
24414 "Drag the line at point ARG lines backward."
24415 (interactive "p")
24416 (org-drag-line-forward (- arg)))
24418 (defun org-mark-element ()
24419 "Put point at beginning of this element, mark at end.
24421 Interactively, if this command is repeated or (in Transient Mark
24422 mode) if the mark is active, it marks the next element after the
24423 ones already marked."
24424 (interactive)
24425 (let (deactivate-mark)
24426 (if (and (org-called-interactively-p 'any)
24427 (or (and (eq last-command this-command) (mark t))
24428 (and transient-mark-mode mark-active)))
24429 (set-mark
24430 (save-excursion
24431 (goto-char (mark))
24432 (goto-char (org-element-property :end (org-element-at-point)))))
24433 (let ((element (org-element-at-point)))
24434 (end-of-line)
24435 (push-mark (org-element-property :end element) t t)
24436 (goto-char (org-element-property :begin element))))))
24438 (defun org-narrow-to-element ()
24439 "Narrow buffer to current element."
24440 (interactive)
24441 (let ((elem (org-element-at-point)))
24442 (cond
24443 ((eq (car elem) 'headline)
24444 (narrow-to-region
24445 (org-element-property :begin elem)
24446 (org-element-property :end elem)))
24447 ((memq (car elem) org-element-greater-elements)
24448 (narrow-to-region
24449 (org-element-property :contents-begin elem)
24450 (org-element-property :contents-end elem)))
24452 (narrow-to-region
24453 (org-element-property :begin elem)
24454 (org-element-property :end elem))))))
24456 (defun org-transpose-element ()
24457 "Transpose current and previous elements, keeping blank lines between.
24458 Point is moved after both elements."
24459 (interactive)
24460 (org-skip-whitespace)
24461 (let ((end (org-element-property :end (org-element-at-point))))
24462 (org-drag-element-backward)
24463 (goto-char end)))
24465 (defun org-unindent-buffer ()
24466 "Un-indent the visible part of the buffer.
24467 Relative indentation (between items, inside blocks, etc.) isn't
24468 modified."
24469 (interactive)
24470 (unless (eq major-mode 'org-mode)
24471 (user-error "Cannot un-indent a buffer not in Org mode"))
24472 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24473 unindent-tree ; For byte-compiler.
24474 (unindent-tree
24475 (function
24476 (lambda (contents)
24477 (mapc
24478 (lambda (element)
24479 (if (memq (org-element-type element) '(headline section))
24480 (funcall unindent-tree (org-element-contents element))
24481 (save-excursion
24482 (save-restriction
24483 (narrow-to-region
24484 (org-element-property :begin element)
24485 (org-element-property :end element))
24486 (org-do-remove-indentation)))))
24487 (reverse contents))))))
24488 (funcall unindent-tree (org-element-contents parse-tree))))
24490 (defun org-show-subtree ()
24491 "Show everything after this heading at deeper levels."
24492 (interactive)
24493 (outline-flag-region
24494 (point)
24495 (save-excursion
24496 (org-end-of-subtree t t))
24497 nil))
24499 (defun org-show-entry ()
24500 "Show the body directly following this heading.
24501 Show the heading too, if it is currently invisible."
24502 (interactive)
24503 (save-excursion
24504 (ignore-errors
24505 (org-back-to-heading t)
24506 (outline-flag-region
24507 (max (point-min) (1- (point)))
24508 (save-excursion
24509 (if (re-search-forward
24510 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24511 (match-beginning 1)
24512 (point-max)))
24513 nil)
24514 (org-cycle-hide-drawers 'children))))
24516 (defun org-make-options-regexp (kwds &optional extra)
24517 "Make a regular expression for keyword lines.
24518 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24519 when non-nil, is a regexp matching keywords names."
24520 (concat "^[ \t]*#\\+\\("
24521 (regexp-opt kwds)
24522 (and extra (concat (and kwds "\\|") extra))
24523 "\\):[ \t]*\\(.*\\)"))
24525 ;; Make isearch reveal the necessary context
24526 (defun org-isearch-end ()
24527 "Reveal context after isearch exits."
24528 (when isearch-success ; only if search was successful
24529 (if (featurep 'xemacs)
24530 ;; Under XEmacs, the hook is run in the correct place,
24531 ;; we directly show the context.
24532 (org-show-context 'isearch)
24533 ;; In Emacs the hook runs *before* restoring the overlays.
24534 ;; So we have to use a one-time post-command-hook to do this.
24535 ;; (Emacs 22 has a special variable, see function `org-mode')
24536 (unless (and (boundp 'isearch-mode-end-hook-quit)
24537 isearch-mode-end-hook-quit)
24538 ;; Only when the isearch was not quitted.
24539 (org-add-hook 'post-command-hook 'org-isearch-post-command
24540 'append 'local)))))
24542 (defun org-isearch-post-command ()
24543 "Remove self from hook, and show context."
24544 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24545 (org-show-context 'isearch))
24548 ;;;; Integration with and fixes for other packages
24550 ;;; Imenu support
24552 (defvar org-imenu-markers nil
24553 "All markers currently used by Imenu.")
24554 (make-variable-buffer-local 'org-imenu-markers)
24556 (defun org-imenu-new-marker (&optional pos)
24557 "Return a new marker for use by Imenu, and remember the marker."
24558 (let ((m (make-marker)))
24559 (move-marker m (or pos (point)))
24560 (push m org-imenu-markers)
24563 (defun org-imenu-get-tree ()
24564 "Produce the index for Imenu."
24565 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24566 (setq org-imenu-markers nil)
24567 (let* ((n org-imenu-depth)
24568 (re (concat "^" (org-get-limited-outline-regexp)))
24569 (subs (make-vector (1+ n) nil))
24570 (last-level 0)
24571 m level head0 head)
24572 (save-excursion
24573 (save-restriction
24574 (widen)
24575 (goto-char (point-max))
24576 (while (re-search-backward re nil t)
24577 (setq level (org-reduced-level (funcall outline-level)))
24578 (when (and (<= level n)
24579 (looking-at org-complex-heading-regexp)
24580 (setq head0 (org-match-string-no-properties 4)))
24581 (setq head (org-link-display-format head0)
24582 m (org-imenu-new-marker))
24583 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24584 (if (>= level last-level)
24585 (push (cons head m) (aref subs level))
24586 (push (cons head (aref subs (1+ level))) (aref subs level))
24587 (loop for i from (1+ level) to n do (aset subs i nil)))
24588 (setq last-level level)))))
24589 (aref subs 1)))
24591 (eval-after-load "imenu"
24592 '(progn
24593 (add-hook 'imenu-after-jump-hook
24594 (lambda ()
24595 (if (derived-mode-p 'org-mode)
24596 (org-show-context 'org-goto))))))
24598 (defun org-link-display-format (link)
24599 "Replace a link with its the description.
24600 If there is no description, use the link target."
24601 (save-match-data
24602 (if (string-match org-bracket-link-analytic-regexp link)
24603 (replace-match (if (match-end 5)
24604 (match-string 5 link)
24605 (concat (match-string 1 link)
24606 (match-string 3 link)))
24607 nil t link)
24608 link)))
24610 (defun org-toggle-link-display ()
24611 "Toggle the literal or descriptive display of links."
24612 (interactive)
24613 (if org-descriptive-links
24614 (progn (org-remove-from-invisibility-spec '(org-link))
24615 (org-restart-font-lock)
24616 (setq org-descriptive-links nil))
24617 (progn (add-to-invisibility-spec '(org-link))
24618 (org-restart-font-lock)
24619 (setq org-descriptive-links t))))
24621 ;; Speedbar support
24623 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24624 "Overlay marking the agenda restriction line in speedbar.")
24625 (overlay-put org-speedbar-restriction-lock-overlay
24626 'face 'org-agenda-restriction-lock)
24627 (overlay-put org-speedbar-restriction-lock-overlay
24628 'help-echo "Agendas are currently limited to this item.")
24629 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24631 (defun org-speedbar-set-agenda-restriction ()
24632 "Restrict future agenda commands to the location at point in speedbar.
24633 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24634 (interactive)
24635 (require 'org-agenda)
24636 (let (p m tp np dir txt)
24637 (cond
24638 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24639 'org-imenu t))
24640 (setq m (get-text-property p 'org-imenu-marker))
24641 (with-current-buffer (marker-buffer m)
24642 (goto-char m)
24643 (org-agenda-set-restriction-lock 'subtree)))
24644 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24645 'speedbar-function 'speedbar-find-file))
24646 (setq tp (previous-single-property-change
24647 (1+ p) 'speedbar-function)
24648 np (next-single-property-change
24649 tp 'speedbar-function)
24650 dir (speedbar-line-directory)
24651 txt (buffer-substring-no-properties (or tp (point-min))
24652 (or np (point-max))))
24653 (with-current-buffer (find-file-noselect
24654 (let ((default-directory dir))
24655 (expand-file-name txt)))
24656 (unless (derived-mode-p 'org-mode)
24657 (user-error "Cannot restrict to non-Org-mode file"))
24658 (org-agenda-set-restriction-lock 'file)))
24659 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24660 (move-overlay org-speedbar-restriction-lock-overlay
24661 (point-at-bol) (point-at-eol))
24662 (setq current-prefix-arg nil)
24663 (org-agenda-maybe-redo)))
24665 (defvar speedbar-file-key-map)
24666 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24667 (eval-after-load "speedbar"
24668 '(progn
24669 (speedbar-add-supported-extension ".org")
24670 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24671 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24672 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24673 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24674 (add-hook 'speedbar-visiting-tag-hook
24675 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24677 ;;; Fixes and Hacks for problems with other packages
24679 (defun org--flyspell-object-check-p (element)
24680 "Non-nil when Flyspell can check object at point.
24681 ELEMENT is the element at point."
24682 (let ((object (save-excursion
24683 (when (org-looking-at-p "\\>") (backward-char))
24684 (org-element-context element))))
24685 (case (org-element-type object)
24686 ;; Prevent checks in links due to keybinding conflict with
24687 ;; Flyspell.
24688 ((code entity export-snippet inline-babel-call
24689 inline-src-block line-break latex-fragment link macro
24690 statistics-cookie target timestamp verbatim)
24691 nil)
24692 (footnote-reference
24693 ;; Only in inline footnotes, within the definition.
24694 (and (eq (org-element-property :type object) 'inline)
24695 (< (save-excursion
24696 (goto-char (org-element-property :begin object))
24697 (search-forward ":" nil t 2))
24698 (point))))
24699 (otherwise t))))
24701 (defun org-mode-flyspell-verify ()
24702 "Function used for `flyspell-generic-check-word-predicate'."
24703 (if (org-at-heading-p)
24704 ;; At a headline or an inlinetask, check title only. This is
24705 ;; faster than relying on `org-element-at-point'.
24706 (and (save-excursion (beginning-of-line)
24707 (and (let ((case-fold-search t))
24708 (not (looking-at "\\*+ END[ \t]*$")))
24709 (looking-at org-complex-heading-regexp)))
24710 (match-beginning 4)
24711 (>= (point) (match-beginning 4))
24712 (or (not (match-beginning 5))
24713 (< (point) (match-beginning 5))))
24714 (let* ((element (org-element-at-point))
24715 (post-affiliated (org-element-property :post-affiliated element)))
24716 (cond
24717 ;; Ignore checks in all affiliated keywords but captions.
24718 ((< (point) post-affiliated)
24719 (and (save-excursion
24720 (beginning-of-line)
24721 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24722 (> (point) (match-end 0))
24723 (org--flyspell-object-check-p element)))
24724 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24725 ((let ((log (org-log-into-drawer)))
24726 (and log
24727 (let ((drawer (org-element-lineage element '(drawer))))
24728 (and drawer
24729 (eq (compare-strings
24730 log nil nil
24731 (org-element-property :drawer-name drawer) nil nil t)
24732 t)))))
24733 nil)
24735 (case (org-element-type element)
24736 ((comment quote-section) t)
24737 (comment-block
24738 ;; Allow checks between block markers, not on them.
24739 (and (> (line-beginning-position) post-affiliated)
24740 (save-excursion
24741 (end-of-line)
24742 (skip-chars-forward " \r\t\n")
24743 (< (point) (org-element-property :end element)))))
24744 ;; Arbitrary list of keywords where checks are meaningful.
24745 ;; Make sure point is on the value part of the element.
24746 (keyword
24747 (and (member (org-element-property :key element)
24748 '("DESCRIPTION" "TITLE"))
24749 (< (save-excursion
24750 (beginning-of-line) (search-forward ":") (point))
24751 (point))))
24752 ;; Check is globally allowed in paragraphs verse blocks and
24753 ;; table rows (after affiliated keywords) but some objects
24754 ;; must not be affected.
24755 ((paragraph table-row verse-block)
24756 (let ((cbeg (org-element-property :contents-begin element))
24757 (cend (org-element-property :contents-end element)))
24758 (and cbeg (>= (point) cbeg) (< (point) cend)
24759 (org--flyspell-object-check-p element))))))))))
24760 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
24762 (defun org-remove-flyspell-overlays-in (beg end)
24763 "Remove flyspell overlays in region."
24764 (and (org-bound-and-true-p flyspell-mode)
24765 (fboundp 'flyspell-delete-region-overlays)
24766 (flyspell-delete-region-overlays beg end)))
24768 (defvar flyspell-delayed-commands)
24769 (eval-after-load "flyspell"
24770 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
24772 ;; Make `bookmark-jump' shows the jump location if it was hidden.
24773 (eval-after-load "bookmark"
24774 '(if (boundp 'bookmark-after-jump-hook)
24775 ;; We can use the hook
24776 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
24777 ;; Hook not available, use advice
24778 (defadvice bookmark-jump (after org-make-visible activate)
24779 "Make the position visible."
24780 (org-bookmark-jump-unhide))))
24782 ;; Make sure saveplace shows the location if it was hidden
24783 (eval-after-load "saveplace"
24784 '(defadvice save-place-find-file-hook (after org-make-visible activate)
24785 "Make the position visible."
24786 (org-bookmark-jump-unhide)))
24788 ;; Make sure ecb shows the location if it was hidden
24789 (eval-after-load "ecb"
24790 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
24791 "Make hierarchy visible when jumping into location from ECB tree buffer."
24792 (if (derived-mode-p 'org-mode)
24793 (org-show-context))))
24795 (defun org-bookmark-jump-unhide ()
24796 "Unhide the current position, to show the bookmark location."
24797 (and (derived-mode-p 'org-mode)
24798 (or (outline-invisible-p)
24799 (save-excursion (goto-char (max (point-min) (1- (point))))
24800 (outline-invisible-p)))
24801 (org-show-context 'bookmark-jump)))
24803 (defun org-mark-jump-unhide ()
24804 "Make the point visible with `org-show-context' after jumping to the mark."
24805 (when (and (derived-mode-p 'org-mode)
24806 (outline-invisible-p))
24807 (org-show-context 'mark-goto)))
24809 (eval-after-load "simple"
24810 '(defadvice pop-to-mark-command (after org-make-visible activate)
24811 "Make the point visible with `org-show-context'."
24812 (org-mark-jump-unhide)))
24814 (eval-after-load "simple"
24815 '(defadvice exchange-point-and-mark (after org-make-visible activate)
24816 "Make the point visible with `org-show-context'."
24817 (org-mark-jump-unhide)))
24819 (eval-after-load "simple"
24820 '(defadvice pop-global-mark (after org-make-visible activate)
24821 "Make the point visible with `org-show-context'."
24822 (org-mark-jump-unhide)))
24824 ;; Make session.el ignore our circular variable
24825 (defvar session-globals-exclude)
24826 (eval-after-load "session"
24827 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24829 ;;;; Finish up
24831 (provide 'org)
24833 (run-hooks 'org-load-hook)
24835 ;;; org.el ends here