Open outer link on nested links
[org-mode.git] / lisp / org.el
blob6ab13f4b39dab81e60227bf503677f3e12426922
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."
2957 :group 'org-todo
2958 :group 'org-progress
2959 :type '(choice
2960 (const :tag "Not into a drawer" nil)
2961 (const :tag "LOGBOOK" t)
2962 (string :tag "Other")))
2964 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2966 (defun org-log-into-drawer ()
2967 "Return the value of `org-log-into-drawer', but let properties overrule.
2968 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2969 used instead of the default value."
2970 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2971 (cond
2972 ((not p) org-log-into-drawer)
2973 ((equal p "nil") nil)
2974 ((equal p "t") "LOGBOOK")
2975 (t p))))
2977 (defcustom org-log-state-notes-insert-after-drawers nil
2978 "Non-nil means insert state change notes after any drawers in entry.
2979 Only the drawers that *immediately* follow the headline and the
2980 deadline/scheduled line are skipped.
2981 When nil, insert notes right after the heading and perhaps the line
2982 with deadline/scheduling if present.
2984 This variable will have no effect if `org-log-into-drawer' is
2985 set."
2986 :group 'org-todo
2987 :group 'org-progress
2988 :type 'boolean)
2990 (defcustom org-log-states-order-reversed t
2991 "Non-nil means the latest state note will be directly after heading.
2992 When nil, the state change notes will be ordered according to time.
2994 This option can also be set with on a per-file-basis with
2996 #+STARTUP: logstatesreversed
2997 #+STARTUP: nologstatesreversed"
2998 :group 'org-todo
2999 :group 'org-progress
3000 :type 'boolean)
3002 (defcustom org-todo-repeat-to-state nil
3003 "The TODO state to which a repeater should return the repeating task.
3004 By default this is the first task in a TODO sequence, or the previous state
3005 in a TODO_TYP set. But you can specify another task here.
3006 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3007 :group 'org-todo
3008 :version "24.1"
3009 :type '(choice (const :tag "Head of sequence" nil)
3010 (string :tag "Specific state")))
3012 (defcustom org-log-repeat 'time
3013 "Non-nil means record moving through the DONE state when triggering repeat.
3014 An auto-repeating task is immediately switched back to TODO when
3015 marked DONE. If you are not logging state changes (by adding \"@\"
3016 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3017 record a closing note, there will be no record of the task moving
3018 through DONE. This variable forces taking a note anyway.
3020 nil Don't force a record
3021 time Record a time stamp
3022 note Prompt for a note and add it with template `org-log-note-headings'
3024 This option can also be set with on a per-file-basis with
3026 #+STARTUP: nologrepeat
3027 #+STARTUP: logrepeat
3028 #+STARTUP: lognoterepeat
3030 You can have local logging settings for a subtree by setting the LOGGING
3031 property to one or more of these keywords."
3032 :group 'org-todo
3033 :group 'org-progress
3034 :type '(choice
3035 (const :tag "Don't force a record" nil)
3036 (const :tag "Force recording the DONE state" time)
3037 (const :tag "Force recording a note with the DONE state" note)))
3040 (defgroup org-priorities nil
3041 "Priorities in Org-mode."
3042 :tag "Org Priorities"
3043 :group 'org-todo)
3045 (defcustom org-enable-priority-commands t
3046 "Non-nil means priority commands are active.
3047 When nil, these commands will be disabled, so that you never accidentally
3048 set a priority."
3049 :group 'org-priorities
3050 :type 'boolean)
3052 (defcustom org-highest-priority ?A
3053 "The highest priority of TODO items. A character like ?A, ?B etc.
3054 Must have a smaller ASCII number than `org-lowest-priority'."
3055 :group 'org-priorities
3056 :type 'character)
3058 (defcustom org-lowest-priority ?C
3059 "The lowest priority of TODO items. A character like ?A, ?B etc.
3060 Must have a larger ASCII number than `org-highest-priority'."
3061 :group 'org-priorities
3062 :type 'character)
3064 (defcustom org-default-priority ?B
3065 "The default priority of TODO items.
3066 This is the priority an item gets if no explicit priority is given.
3067 When starting to cycle on an empty priority the first step in the cycle
3068 depends on `org-priority-start-cycle-with-default'. The resulting first
3069 step priority must not exceed the range from `org-highest-priority' to
3070 `org-lowest-priority' which means that `org-default-priority' has to be
3071 in this range exclusive or inclusive the range boundaries. Else the
3072 first step refuses to set the default and the second will fall back
3073 to (depending on the command used) the highest or lowest priority."
3074 :group 'org-priorities
3075 :type 'character)
3077 (defcustom org-priority-start-cycle-with-default t
3078 "Non-nil means start with default priority when starting to cycle.
3079 When this is nil, the first step in the cycle will be (depending on the
3080 command used) one higher or lower than the default priority.
3081 See also `org-default-priority'."
3082 :group 'org-priorities
3083 :type 'boolean)
3085 (defcustom org-get-priority-function nil
3086 "Function to extract the priority from a string.
3087 The string is normally the headline. If this is nil Org computes the
3088 priority from the priority cookie like [#A] in the headline. It returns
3089 an integer, increasing by 1000 for each priority level.
3090 The user can set a different function here, which should take a string
3091 as an argument and return the numeric priority."
3092 :group 'org-priorities
3093 :version "24.1"
3094 :type '(choice
3095 (const nil)
3096 (function)))
3098 (defgroup org-time nil
3099 "Options concerning time stamps and deadlines in Org-mode."
3100 :tag "Org Time"
3101 :group 'org)
3103 (defcustom org-insert-labeled-timestamps-at-point nil
3104 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
3105 When nil, these labeled time stamps are forces into the second line of an
3106 entry, just after the headline. When scheduling from the global TODO list,
3107 the time stamp will always be forced into the second line."
3108 :group 'org-time
3109 :type 'boolean)
3111 (defcustom org-time-stamp-rounding-minutes '(0 5)
3112 "Number of minutes to round time stamps to.
3113 These are two values, the first applies when first creating a time stamp.
3114 The second applies when changing it with the commands `S-up' and `S-down'.
3115 When changing the time stamp, this means that it will change in steps
3116 of N minutes, as given by the second value.
3118 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3119 numbers should be factors of 60, so for example 5, 10, 15.
3121 When this is larger than 1, you can still force an exact time stamp by using
3122 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3123 and by using a prefix arg to `S-up/down' to specify the exact number
3124 of minutes to shift."
3125 :group 'org-time
3126 :get (lambda (var) ; Make sure both elements are there
3127 (if (integerp (default-value var))
3128 (list (default-value var) 5)
3129 (default-value var)))
3130 :type '(list
3131 (integer :tag "when inserting times")
3132 (integer :tag "when modifying times")))
3134 ;; Normalize old customizations of this variable.
3135 (when (integerp org-time-stamp-rounding-minutes)
3136 (setq org-time-stamp-rounding-minutes
3137 (list org-time-stamp-rounding-minutes
3138 org-time-stamp-rounding-minutes)))
3140 (defcustom org-display-custom-times nil
3141 "Non-nil means overlay custom formats over all time stamps.
3142 The formats are defined through the variable `org-time-stamp-custom-formats'.
3143 To turn this on on a per-file basis, insert anywhere in the file:
3144 #+STARTUP: customtime"
3145 :group 'org-time
3146 :set 'set-default
3147 :type 'sexp)
3148 (make-variable-buffer-local 'org-display-custom-times)
3150 (defcustom org-time-stamp-custom-formats
3151 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3152 "Custom formats for time stamps. See `format-time-string' for the syntax.
3153 These are overlaid over the default ISO format if the variable
3154 `org-display-custom-times' is set. Time like %H:%M should be at the
3155 end of the second format. The custom formats are also honored by export
3156 commands, if custom time display is turned on at the time of export."
3157 :group 'org-time
3158 :type 'sexp)
3160 (defun org-time-stamp-format (&optional long inactive)
3161 "Get the right format for a time string."
3162 (let ((f (if long (cdr org-time-stamp-formats)
3163 (car org-time-stamp-formats))))
3164 (if inactive
3165 (concat "[" (substring f 1 -1) "]")
3166 f)))
3168 (defcustom org-time-clocksum-format
3169 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3170 "The format string used when creating CLOCKSUM lines.
3171 This is also used when Org mode generates a time duration.
3173 The value can be a single format string containing two
3174 %-sequences, which will be filled with the number of hours and
3175 minutes in that order.
3177 Alternatively, the value can be a plist associating any of the
3178 keys :years, :months, :weeks, :days, :hours or :minutes with
3179 format strings. The time duration is formatted using only the
3180 time components that are needed and concatenating the results.
3181 If a time unit in absent, it falls back to the next smallest
3182 unit.
3184 The keys :require-years, :require-months, :require-days,
3185 :require-weeks, :require-hours, :require-minutes are also
3186 meaningful. A non-nil value for these keys indicates that the
3187 corresponding time component should always be included, even if
3188 its value is 0.
3191 For example,
3193 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3194 :require-minutes t)
3196 means durations longer than a day will be expressed in days,
3197 hours and minutes, and durations less than a day will always be
3198 expressed in hours and minutes (even for durations less than an
3199 hour).
3201 The value
3203 \(:days \"%dd\" :minutes \"%dm\")
3205 means durations longer than a day will be expressed in days and
3206 minutes, and durations less than a day will be expressed entirely
3207 in minutes (even for durations longer than an hour)."
3208 :group 'org-time
3209 :group 'org-clock
3210 :version "24.4"
3211 :package-version '(Org . "8.0")
3212 :type '(choice (string :tag "Format string")
3213 (set :tag "Plist"
3214 (group :inline t (const :tag "Years" :years)
3215 (string :tag "Format string"))
3216 (group :inline t
3217 (const :tag "Always show years" :require-years)
3218 (const t))
3219 (group :inline t (const :tag "Months" :months)
3220 (string :tag "Format string"))
3221 (group :inline t
3222 (const :tag "Always show months" :require-months)
3223 (const t))
3224 (group :inline t (const :tag "Weeks" :weeks)
3225 (string :tag "Format string"))
3226 (group :inline t
3227 (const :tag "Always show weeks" :require-weeks)
3228 (const t))
3229 (group :inline t (const :tag "Days" :days)
3230 (string :tag "Format string"))
3231 (group :inline t
3232 (const :tag "Always show days" :require-days)
3233 (const t))
3234 (group :inline t (const :tag "Hours" :hours)
3235 (string :tag "Format string"))
3236 (group :inline t
3237 (const :tag "Always show hours" :require-hours)
3238 (const t))
3239 (group :inline t (const :tag "Minutes" :minutes)
3240 (string :tag "Format string"))
3241 (group :inline t
3242 (const :tag "Always show minutes" :require-minutes)
3243 (const t)))))
3245 (defcustom org-time-clocksum-use-fractional nil
3246 "When non-nil, \\[org-clock-display] uses fractional times.
3247 See `org-time-clocksum-format' for more on time clock formats."
3248 :group 'org-time
3249 :group 'org-clock
3250 :version "24.3"
3251 :type 'boolean)
3253 (defcustom org-time-clocksum-use-effort-durations nil
3254 "When non-nil, \\[org-clock-display] uses effort durations.
3255 E.g. by default, one day is considered to be a 8 hours effort,
3256 so a task that has been clocked for 16 hours will be displayed
3257 as during 2 days in the clock display or in the clocktable.
3259 See `org-effort-durations' on how to set effort durations
3260 and `org-time-clocksum-format' for more on time clock formats."
3261 :group 'org-time
3262 :group 'org-clock
3263 :version "24.4"
3264 :package-version '(Org . "8.0")
3265 :type 'boolean)
3267 (defcustom org-time-clocksum-fractional-format "%.2f"
3268 "The format string used when creating CLOCKSUM lines,
3269 or when Org mode generates a time duration, if
3270 `org-time-clocksum-use-fractional' is enabled.
3272 The value can be a single format string containing one
3273 %-sequence, which will be filled with the number of hours as
3274 a float.
3276 Alternatively, the value can be a plist associating any of the
3277 keys :years, :months, :weeks, :days, :hours or :minutes with
3278 a format string. The time duration is formatted using the
3279 largest time unit which gives a non-zero integer part. If all
3280 specified formats have zero integer part, the smallest time unit
3281 is used."
3282 :group 'org-time
3283 :type '(choice (string :tag "Format string")
3284 (set (group :inline t (const :tag "Years" :years)
3285 (string :tag "Format string"))
3286 (group :inline t (const :tag "Months" :months)
3287 (string :tag "Format string"))
3288 (group :inline t (const :tag "Weeks" :weeks)
3289 (string :tag "Format string"))
3290 (group :inline t (const :tag "Days" :days)
3291 (string :tag "Format string"))
3292 (group :inline t (const :tag "Hours" :hours)
3293 (string :tag "Format string"))
3294 (group :inline t (const :tag "Minutes" :minutes)
3295 (string :tag "Format string")))))
3297 (defcustom org-deadline-warning-days 14
3298 "Number of days before expiration during which a deadline becomes active.
3299 This variable governs the display in sparse trees and in the agenda.
3300 When 0 or negative, it means use this number (the absolute value of it)
3301 even if a deadline has a different individual lead time specified.
3303 Custom commands can set this variable in the options section."
3304 :group 'org-time
3305 :group 'org-agenda-daily/weekly
3306 :type 'integer)
3308 (defcustom org-scheduled-delay-days 0
3309 "Number of days before a scheduled item becomes active.
3310 This variable governs the display in sparse trees and in the agenda.
3311 The default value (i.e. 0) means: don't delay scheduled item.
3312 When negative, it means use this number (the absolute value of it)
3313 even if a scheduled item has a different individual delay time
3314 specified.
3316 Custom commands can set this variable in the options section."
3317 :group 'org-time
3318 :group 'org-agenda-daily/weekly
3319 :version "24.4"
3320 :package-version '(Org . "8.0")
3321 :type 'integer)
3323 (defcustom org-read-date-prefer-future t
3324 "Non-nil means assume future for incomplete date input from user.
3325 This affects the following situations:
3326 1. The user gives a month but not a year.
3327 For example, if it is April and you enter \"feb 2\", this will be read
3328 as Feb 2, *next* year. \"May 5\", however, will be this year.
3329 2. The user gives a day, but no month.
3330 For example, if today is the 15th, and you enter \"3\", Org-mode will
3331 read this as the third of *next* month. However, if you enter \"17\",
3332 it will be considered as *this* month.
3334 If you set this variable to the symbol `time', then also the following
3335 will work:
3337 3. If the user gives a time.
3338 If the time is before now, it will be interpreted as tomorrow.
3340 Currently none of this works for ISO week specifications.
3342 When this option is nil, the current day, month and year will always be
3343 used as defaults.
3345 See also `org-agenda-jump-prefer-future'."
3346 :group 'org-time
3347 :type '(choice
3348 (const :tag "Never" nil)
3349 (const :tag "Check month and day" t)
3350 (const :tag "Check month, day, and time" time)))
3352 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3353 "Should the agenda jump command prefer the future for incomplete dates?
3354 The default is to do the same as configured in `org-read-date-prefer-future'.
3355 But you can also set a deviating value here.
3356 This may t or nil, or the symbol `org-read-date-prefer-future'."
3357 :group 'org-agenda
3358 :group 'org-time
3359 :version "24.1"
3360 :type '(choice
3361 (const :tag "Use org-read-date-prefer-future"
3362 org-read-date-prefer-future)
3363 (const :tag "Never" nil)
3364 (const :tag "Always" t)))
3366 (defcustom org-read-date-force-compatible-dates t
3367 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3369 Depending on the system Emacs is running on, certain dates cannot
3370 be represented with the type used internally to represent time.
3371 Dates between 1970-1-1 and 2038-1-1 can always be represented
3372 correctly. Some systems allow for earlier dates, some for later,
3373 some for both. One way to find out it to insert any date into an
3374 Org buffer, putting the cursor on the year and hitting S-up and
3375 S-down to test the range.
3377 When this variable is set to t, the date/time prompt will not let
3378 you specify dates outside the 1970-2037 range, so it is certain that
3379 these dates will work in whatever version of Emacs you are
3380 running, and also that you can move a file from one Emacs implementation
3381 to another. WHenever Org is forcing the year for you, it will display
3382 a message and beep.
3384 When this variable is nil, Org will check if the date is
3385 representable in the specific Emacs implementation you are using.
3386 If not, it will force a year, usually the current year, and beep
3387 to remind you. Currently this setting is not recommended because
3388 the likelihood that you will open your Org files in an Emacs that
3389 has limited date range is not negligible.
3391 A workaround for this problem is to use diary sexp dates for time
3392 stamps outside of this range."
3393 :group 'org-time
3394 :version "24.1"
3395 :type 'boolean)
3397 (defcustom org-read-date-display-live t
3398 "Non-nil means display current interpretation of date prompt live.
3399 This display will be in an overlay, in the minibuffer."
3400 :group 'org-time
3401 :type 'boolean)
3403 (defcustom org-read-date-popup-calendar t
3404 "Non-nil means pop up a calendar when prompting for a date.
3405 In the calendar, the date can be selected with mouse-1. However, the
3406 minibuffer will also be active, and you can simply enter the date as well.
3407 When nil, only the minibuffer will be available."
3408 :group 'org-time
3409 :type 'boolean)
3410 (org-defvaralias 'org-popup-calendar-for-date-prompt
3411 'org-read-date-popup-calendar)
3413 (make-obsolete-variable
3414 'org-read-date-minibuffer-setup-hook
3415 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3416 (defcustom org-read-date-minibuffer-setup-hook nil
3417 "Hook to be used to set up keys for the date/time interface.
3418 Add key definitions to `minibuffer-local-map', which will be a
3419 temporary copy.
3421 WARNING: This option is obsolete, you should use
3422 `org-read-date-minibuffer-local-map' to set up keys."
3423 :group 'org-time
3424 :type 'hook)
3426 (defcustom org-extend-today-until 0
3427 "The hour when your day really ends. Must be an integer.
3428 This has influence for the following applications:
3429 - When switching the agenda to \"today\". It it is still earlier than
3430 the time given here, the day recognized as TODAY is actually yesterday.
3431 - When a date is read from the user and it is still before the time given
3432 here, the current date and time will be assumed to be yesterday, 23:59.
3433 Also, timestamps inserted in capture templates follow this rule.
3435 IMPORTANT: This is a feature whose implementation is and likely will
3436 remain incomplete. Really, it is only here because past midnight seems to
3437 be the favorite working time of John Wiegley :-)"
3438 :group 'org-time
3439 :type 'integer)
3441 (defcustom org-use-effective-time nil
3442 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3443 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3444 \"effective time\" of any timestamps between midnight and 8am will be
3445 23:59 of the previous day."
3446 :group 'org-time
3447 :version "24.1"
3448 :type 'boolean)
3450 (defcustom org-use-last-clock-out-time-as-effective-time nil
3451 "When non-nil, use the last clock out time for `org-todo'.
3452 Note that this option has precedence over the combined use of
3453 `org-use-effective-time' and `org-extend-today-until'."
3454 :group 'org-time
3455 :version "24.4"
3456 :package-version '(Org . "8.0")
3457 :type 'boolean)
3459 (defcustom org-edit-timestamp-down-means-later nil
3460 "Non-nil means S-down will increase the time in a time stamp.
3461 When nil, S-up will increase."
3462 :group 'org-time
3463 :type 'boolean)
3465 (defcustom org-calendar-follow-timestamp-change t
3466 "Non-nil means make the calendar window follow timestamp changes.
3467 When a timestamp is modified and the calendar window is visible, it will be
3468 moved to the new date."
3469 :group 'org-time
3470 :type 'boolean)
3472 (defgroup org-tags nil
3473 "Options concerning tags in Org-mode."
3474 :tag "Org Tags"
3475 :group 'org)
3477 (defcustom org-tag-alist nil
3478 "List of tags allowed in Org-mode files.
3479 When this list is nil, Org-mode will base TAG input on what is already in the
3480 buffer.
3481 The value of this variable is an alist, the car of each entry must be a
3482 keyword as a string, the cdr may be a character that is used to select
3483 that tag through the fast-tag-selection interface.
3484 See the manual for details."
3485 :group 'org-tags
3486 :type '(repeat
3487 (choice
3488 (cons (string :tag "Tag name")
3489 (character :tag "Access char"))
3490 (list :tag "Start radio group"
3491 (const :startgroup)
3492 (option (string :tag "Group description")))
3493 (list :tag "Group tags delimiter"
3494 (const :grouptags))
3495 (list :tag "End radio group"
3496 (const :endgroup)
3497 (option (string :tag "Group description")))
3498 (const :tag "New line" (:newline)))))
3500 (defcustom org-tag-persistent-alist nil
3501 "List of tags that will always appear in all Org-mode files.
3502 This is in addition to any in buffer settings or customizations
3503 of `org-tag-alist'.
3504 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3505 The value of this variable is an alist, the car of each entry must be a
3506 keyword as a string, the cdr may be a character that is used to select
3507 that tag through the fast-tag-selection interface.
3508 See the manual for details.
3509 To disable these tags on a per-file basis, insert anywhere in the file:
3510 #+STARTUP: noptag"
3511 :group 'org-tags
3512 :type '(repeat
3513 (choice
3514 (cons (string :tag "Tag name")
3515 (character :tag "Access char"))
3516 (const :tag "Start radio group" (:startgroup))
3517 (const :tag "Group tags delimiter" (:grouptags))
3518 (const :tag "End radio group" (:endgroup))
3519 (const :tag "New line" (:newline)))))
3521 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3522 "If non-nil, always offer completion for all tags of all agenda files.
3523 Instead of customizing this variable directly, you might want to
3524 set it locally for capture buffers, because there no list of
3525 tags in that file can be created dynamically (there are none).
3527 (add-hook 'org-capture-mode-hook
3528 (lambda ()
3529 (set (make-local-variable
3530 'org-complete-tags-always-offer-all-agenda-tags)
3531 t)))"
3532 :group 'org-tags
3533 :version "24.1"
3534 :type 'boolean)
3536 (defvar org-file-tags nil
3537 "List of tags that can be inherited by all entries in the file.
3538 The tags will be inherited if the variable `org-use-tag-inheritance'
3539 says they should be.
3540 This variable is populated from #+FILETAGS lines.")
3542 (defcustom org-use-fast-tag-selection 'auto
3543 "Non-nil means use fast tag selection scheme.
3544 This is a special interface to select and deselect tags with single keys.
3545 When nil, fast selection is never used.
3546 When the symbol `auto', fast selection is used if and only if selection
3547 characters for tags have been configured, either through the variable
3548 `org-tag-alist' or through a #+TAGS line in the buffer.
3549 When t, fast selection is always used and selection keys are assigned
3550 automatically if necessary."
3551 :group 'org-tags
3552 :type '(choice
3553 (const :tag "Always" t)
3554 (const :tag "Never" nil)
3555 (const :tag "When selection characters are configured" auto)))
3557 (defcustom org-fast-tag-selection-single-key nil
3558 "Non-nil means fast tag selection exits after first change.
3559 When nil, you have to press RET to exit it.
3560 During fast tag selection, you can toggle this flag with `C-c'.
3561 This variable can also have the value `expert'. In this case, the window
3562 displaying the tags menu is not even shown, until you press C-c again."
3563 :group 'org-tags
3564 :type '(choice
3565 (const :tag "No" nil)
3566 (const :tag "Yes" t)
3567 (const :tag "Expert" expert)))
3569 (defvar org-fast-tag-selection-include-todo nil
3570 "Non-nil means fast tags selection interface will also offer TODO states.
3571 This is an undocumented feature, you should not rely on it.")
3573 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3574 "The column to which tags should be indented in a headline.
3575 If this number is positive, it specifies the column. If it is negative,
3576 it means that the tags should be flushright to that column. For example,
3577 -80 works well for a normal 80 character screen.
3578 When 0, place tags directly after headline text, with only one space in
3579 between."
3580 :group 'org-tags
3581 :type 'integer)
3583 (defcustom org-auto-align-tags t
3584 "Non-nil keeps tags aligned when modifying headlines.
3585 Some operations (i.e. demoting) change the length of a headline and
3586 therefore shift the tags around. With this option turned on, after
3587 each such operation the tags are again aligned to `org-tags-column'."
3588 :group 'org-tags
3589 :type 'boolean)
3591 (defcustom org-use-tag-inheritance t
3592 "Non-nil means tags in levels apply also for sublevels.
3593 When nil, only the tags directly given in a specific line apply there.
3594 This may also be a list of tags that should be inherited, or a regexp that
3595 matches tags that should be inherited. Additional control is possible
3596 with the variable `org-tags-exclude-from-inheritance' which gives an
3597 explicit list of tags to be excluded from inheritance, even if the value of
3598 `org-use-tag-inheritance' would select it for inheritance.
3600 If this option is t, a match early-on in a tree can lead to a large
3601 number of matches in the subtree when constructing the agenda or creating
3602 a sparse tree. If you only want to see the first match in a tree during
3603 a search, check out the variable `org-tags-match-list-sublevels'."
3604 :group 'org-tags
3605 :type '(choice
3606 (const :tag "Not" nil)
3607 (const :tag "Always" t)
3608 (repeat :tag "Specific tags" (string :tag "Tag"))
3609 (regexp :tag "Tags matched by regexp")))
3611 (defcustom org-tags-exclude-from-inheritance nil
3612 "List of tags that should never be inherited.
3613 This is a way to exclude a few tags from inheritance. For way to do
3614 the opposite, to actively allow inheritance for selected tags,
3615 see the variable `org-use-tag-inheritance'."
3616 :group 'org-tags
3617 :type '(repeat (string :tag "Tag")))
3619 (defun org-tag-inherit-p (tag)
3620 "Check if TAG is one that should be inherited."
3621 (cond
3622 ((member tag org-tags-exclude-from-inheritance) nil)
3623 ((eq org-use-tag-inheritance t) t)
3624 ((not org-use-tag-inheritance) nil)
3625 ((stringp org-use-tag-inheritance)
3626 (string-match org-use-tag-inheritance tag))
3627 ((listp org-use-tag-inheritance)
3628 (member tag org-use-tag-inheritance))
3629 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3631 (defcustom org-tags-match-list-sublevels t
3632 "Non-nil means list also sublevels of headlines matching a search.
3633 This variable applies to tags/property searches, and also to stuck
3634 projects because this search is based on a tags match as well.
3636 When set to the symbol `indented', sublevels are indented with
3637 leading dots.
3639 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3640 the sublevels of a headline matching a tag search often also match
3641 the same search. Listing all of them can create very long lists.
3642 Setting this variable to nil causes subtrees of a match to be skipped.
3644 This variable is semi-obsolete and probably should always be true. It
3645 is better to limit inheritance to certain tags using the variables
3646 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3647 :group 'org-tags
3648 :type '(choice
3649 (const :tag "No, don't list them" nil)
3650 (const :tag "Yes, do list them" t)
3651 (const :tag "List them, indented with leading dots" indented)))
3653 (defcustom org-tags-sort-function nil
3654 "When set, tags are sorted using this function as a comparator."
3655 :group 'org-tags
3656 :type '(choice
3657 (const :tag "No sorting" nil)
3658 (const :tag "Alphabetical" string<)
3659 (const :tag "Reverse alphabetical" string>)
3660 (function :tag "Custom function" nil)))
3662 (defvar org-tags-history nil
3663 "History of minibuffer reads for tags.")
3664 (defvar org-last-tags-completion-table nil
3665 "The last used completion table for tags.")
3666 (defvar org-after-tags-change-hook nil
3667 "Hook that is run after the tags in a line have changed.")
3669 (defgroup org-properties nil
3670 "Options concerning properties in Org-mode."
3671 :tag "Org Properties"
3672 :group 'org)
3674 (defcustom org-property-format "%-10s %s"
3675 "How property key/value pairs should be formatted by `indent-line'.
3676 When `indent-line' hits a property definition, it will format the line
3677 according to this format, mainly to make sure that the values are
3678 lined-up with respect to each other."
3679 :group 'org-properties
3680 :type 'string)
3682 (defcustom org-properties-postprocess-alist nil
3683 "Alist of properties and functions to adjust inserted values.
3684 Elements of this alist must be of the form
3686 ([string] [function])
3688 where [string] must be a property name and [function] must be a
3689 lambda expression: this lambda expression must take one argument,
3690 the value to adjust, and return the new value as a string.
3692 For example, this element will allow the property \"Remaining\"
3693 to be updated wrt the relation between the \"Effort\" property
3694 and the clock summary:
3696 ((\"Remaining\" (lambda(value)
3697 (let ((clocksum (org-clock-sum-current-item))
3698 (effort (org-duration-string-to-minutes
3699 (org-entry-get (point) \"Effort\"))))
3700 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3701 :group 'org-properties
3702 :version "24.1"
3703 :type '(alist :key-type (string :tag "Property")
3704 :value-type (function :tag "Function")))
3706 (defcustom org-use-property-inheritance nil
3707 "Non-nil means properties apply also for sublevels.
3709 This setting is chiefly used during property searches. Turning it on can
3710 cause significant overhead when doing a search, which is why it is not
3711 on by default.
3713 When nil, only the properties directly given in the current entry count.
3714 When t, every property is inherited. The value may also be a list of
3715 properties that should have inheritance, or a regular expression matching
3716 properties that should be inherited.
3718 However, note that some special properties use inheritance under special
3719 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3720 and the properties ending in \"_ALL\" when they are used as descriptor
3721 for valid values of a property.
3723 Note for programmers:
3724 When querying an entry with `org-entry-get', you can control if inheritance
3725 should be used. By default, `org-entry-get' looks only at the local
3726 properties. You can request inheritance by setting the inherit argument
3727 to t (to force inheritance) or to `selective' (to respect the setting
3728 in this variable)."
3729 :group 'org-properties
3730 :type '(choice
3731 (const :tag "Not" nil)
3732 (const :tag "Always" t)
3733 (repeat :tag "Specific properties" (string :tag "Property"))
3734 (regexp :tag "Properties matched by regexp")))
3736 (defun org-property-inherit-p (property)
3737 "Check if PROPERTY is one that should be inherited."
3738 (cond
3739 ((eq org-use-property-inheritance t) t)
3740 ((not org-use-property-inheritance) nil)
3741 ((stringp org-use-property-inheritance)
3742 (string-match org-use-property-inheritance property))
3743 ((listp org-use-property-inheritance)
3744 (member property org-use-property-inheritance))
3745 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3747 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3748 "The default column format, if no other format has been defined.
3749 This variable can be set on the per-file basis by inserting a line
3751 #+COLUMNS: %25ITEM ....."
3752 :group 'org-properties
3753 :type 'string)
3755 (defcustom org-columns-ellipses ".."
3756 "The ellipses to be used when a field in column view is truncated.
3757 When this is the empty string, as many characters as possible are shown,
3758 but then there will be no visual indication that the field has been truncated.
3759 When this is a string of length N, the last N characters of a truncated
3760 field are replaced by this string. If the column is narrower than the
3761 ellipses string, only part of the ellipses string will be shown."
3762 :group 'org-properties
3763 :type 'string)
3765 (defcustom org-columns-modify-value-for-display-function nil
3766 "Function that modifies values for display in column view.
3767 For example, it can be used to cut out a certain part from a time stamp.
3768 The function must take 2 arguments:
3770 column-title The title of the column (*not* the property name)
3771 value The value that should be modified.
3773 The function should return the value that should be displayed,
3774 or nil if the normal value should be used."
3775 :group 'org-properties
3776 :type '(choice (const nil) (function)))
3778 (defconst org-global-properties-fixed
3779 '(("VISIBILITY_ALL" . "folded children content all")
3780 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3781 "List of property/value pairs that can be inherited by any entry.
3783 These are fixed values, for the preset properties. The user variable
3784 that can be used to add to this list is `org-global-properties'.
3786 The entries in this list are cons cells where the car is a property
3787 name and cdr is a string with the value. If the value represents
3788 multiple items like an \"_ALL\" property, separate the items by
3789 spaces.")
3791 (defcustom org-global-properties nil
3792 "List of property/value pairs that can be inherited by any entry.
3794 This list will be combined with the constant `org-global-properties-fixed'.
3796 The entries in this list are cons cells where the car is a property
3797 name and cdr is a string with the value.
3799 You can set buffer-local values for the same purpose in the variable
3800 `org-file-properties' this by adding lines like
3802 #+PROPERTY: NAME VALUE"
3803 :group 'org-properties
3804 :type '(repeat
3805 (cons (string :tag "Property")
3806 (string :tag "Value"))))
3808 (defvar org-file-properties nil
3809 "List of property/value pairs that can be inherited by any entry.
3810 Valid for the current buffer.
3811 This variable is populated from #+PROPERTY lines.")
3812 (make-variable-buffer-local 'org-file-properties)
3814 (defgroup org-agenda nil
3815 "Options concerning agenda views in Org-mode."
3816 :tag "Org Agenda"
3817 :group 'org)
3819 (defvar org-category nil
3820 "Variable used by org files to set a category for agenda display.
3821 Such files should use a file variable to set it, for example
3823 # -*- mode: org; org-category: \"ELisp\"
3825 or contain a special line
3827 #+CATEGORY: ELisp
3829 If the file does not specify a category, then file's base name
3830 is used instead.")
3831 (make-variable-buffer-local 'org-category)
3832 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3834 (defcustom org-agenda-files nil
3835 "The files to be used for agenda display.
3836 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3837 \\[org-remove-file]. You can also use customize to edit the list.
3839 If an entry is a directory, all files in that directory that are matched by
3840 `org-agenda-file-regexp' will be part of the file list.
3842 If the value of the variable is not a list but a single file name, then
3843 the list of agenda files is actually stored and maintained in that file, one
3844 agenda file per line. In this file paths can be given relative to
3845 `org-directory'. Tilde expansion and environment variable substitution
3846 are also made."
3847 :group 'org-agenda
3848 :type '(choice
3849 (repeat :tag "List of files and directories" file)
3850 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3852 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3853 "Regular expression to match files for `org-agenda-files'.
3854 If any element in the list in that variable contains a directory instead
3855 of a normal file, all files in that directory that are matched by this
3856 regular expression will be included."
3857 :group 'org-agenda
3858 :type 'regexp)
3860 (defcustom org-agenda-text-search-extra-files nil
3861 "List of extra files to be searched by text search commands.
3862 These files will be searched in addition to the agenda files by the
3863 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3864 Note that these files will only be searched for text search commands,
3865 not for the other agenda views like todo lists, tag searches or the weekly
3866 agenda. This variable is intended to list notes and possibly archive files
3867 that should also be searched by these two commands.
3868 In fact, if the first element in the list is the symbol `agenda-archives',
3869 then all archive files of all agenda files will be added to the search
3870 scope."
3871 :group 'org-agenda
3872 :type '(set :greedy t
3873 (const :tag "Agenda Archives" agenda-archives)
3874 (repeat :inline t (file))))
3876 (org-defvaralias 'org-agenda-multi-occur-extra-files
3877 'org-agenda-text-search-extra-files)
3879 (defcustom org-agenda-skip-unavailable-files nil
3880 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3881 A nil value means to remove them, after a query, from the list."
3882 :group 'org-agenda
3883 :type 'boolean)
3885 (defcustom org-calendar-to-agenda-key [?c]
3886 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3887 The command `org-calendar-goto-agenda' will be bound to this key. The
3888 default is the character `c' because then `c' can be used to switch back and
3889 forth between agenda and calendar."
3890 :group 'org-agenda
3891 :type 'sexp)
3893 (defcustom org-calendar-insert-diary-entry-key [?i]
3894 "The key to be installed in `calendar-mode-map' for adding diary entries.
3895 This option is irrelevant until `org-agenda-diary-file' has been configured
3896 to point to an Org-mode file. When that is the case, the command
3897 `org-agenda-diary-entry' will be bound to the key given here, by default
3898 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3899 if you want to continue doing this, you need to change this to a different
3900 key."
3901 :group 'org-agenda
3902 :type 'sexp)
3904 (defcustom org-agenda-diary-file 'diary-file
3905 "File to which to add new entries with the `i' key in agenda and calendar.
3906 When this is the symbol `diary-file', the functionality in the Emacs
3907 calendar will be used to add entries to the `diary-file'. But when this
3908 points to a file, `org-agenda-diary-entry' will be used instead."
3909 :group 'org-agenda
3910 :type '(choice
3911 (const :tag "The standard Emacs diary file" diary-file)
3912 (file :tag "Special Org file diary entries")))
3914 (eval-after-load "calendar"
3915 '(progn
3916 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3917 'org-calendar-goto-agenda)
3918 (add-hook 'calendar-mode-hook
3919 (lambda ()
3920 (unless (eq org-agenda-diary-file 'diary-file)
3921 (define-key calendar-mode-map
3922 org-calendar-insert-diary-entry-key
3923 'org-agenda-diary-entry))))))
3925 (defgroup org-latex nil
3926 "Options for embedding LaTeX code into Org-mode."
3927 :tag "Org LaTeX"
3928 :group 'org)
3930 (defcustom org-format-latex-options
3931 '(:foreground default :background default :scale 1.0
3932 :html-foreground "Black" :html-background "Transparent"
3933 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3934 "Options for creating images from LaTeX fragments.
3935 This is a property list with the following properties:
3936 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3937 `default' means use the foreground of the default face.
3938 `auto' means use the foreground from the text face.
3939 :background the background color, or \"Transparent\".
3940 `default' means use the background of the default face.
3941 `auto' means use the background from the text face.
3942 :scale a scaling factor for the size of the images, to get more pixels
3943 :html-foreground, :html-background, :html-scale
3944 the same numbers for HTML export.
3945 :matchers a list indicating which matchers should be used to
3946 find LaTeX fragments. Valid members of this list are:
3947 \"begin\" find environments
3948 \"$1\" find single characters surrounded by $.$
3949 \"$\" find math expressions surrounded by $...$
3950 \"$$\" find math expressions surrounded by $$....$$
3951 \"\\(\" find math expressions surrounded by \\(...\\)
3952 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3953 :group 'org-latex
3954 :type 'plist)
3956 (defcustom org-format-latex-signal-error t
3957 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3958 When nil, just push out a message."
3959 :group 'org-latex
3960 :version "24.1"
3961 :type 'boolean)
3963 (defcustom org-latex-to-mathml-jar-file nil
3964 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3965 Use this to specify additional executable file say a jar file.
3967 When using MathToWeb as the converter, specify the full-path to
3968 your mathtoweb.jar file."
3969 :group 'org-latex
3970 :version "24.1"
3971 :type '(choice
3972 (const :tag "None" nil)
3973 (file :tag "JAR file" :must-match t)))
3975 (defcustom org-latex-to-mathml-convert-command nil
3976 "Command to convert LaTeX fragments to MathML.
3977 Replace format-specifiers in the command as noted below and use
3978 `shell-command' to convert LaTeX to MathML.
3979 %j: Executable file in fully expanded form as specified by
3980 `org-latex-to-mathml-jar-file'.
3981 %I: Input LaTeX file in fully expanded form
3982 %o: Output MathML file
3983 This command is used by `org-create-math-formula'.
3985 When using MathToWeb as the converter, set this to
3986 \"java -jar %j -unicode -force -df %o %I\"."
3987 :group 'org-latex
3988 :version "24.1"
3989 :type '(choice
3990 (const :tag "None" nil)
3991 (string :tag "\nShell command")))
3993 (defcustom org-latex-create-formula-image-program 'dvipng
3994 "Program to convert LaTeX fragments with.
3996 dvipng Process the LaTeX fragments to dvi file, then convert
3997 dvi files to png files using dvipng.
3998 This will also include processing of non-math environments.
3999 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
4000 to convert pdf files to png files"
4001 :group 'org-latex
4002 :version "24.1"
4003 :type '(choice
4004 (const :tag "dvipng" dvipng)
4005 (const :tag "imagemagick" imagemagick)))
4007 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4008 "Path to store latex preview images.
4009 A relative path here creates many directories relative to the
4010 processed org files paths. An absolute path puts all preview
4011 images at the same place."
4012 :group 'org-latex
4013 :version "24.3"
4014 :type 'string)
4016 (defun org-format-latex-mathml-available-p ()
4017 "Return t if `org-latex-to-mathml-convert-command' is usable."
4018 (save-match-data
4019 (when (and (boundp 'org-latex-to-mathml-convert-command)
4020 org-latex-to-mathml-convert-command)
4021 (let ((executable (car (split-string
4022 org-latex-to-mathml-convert-command))))
4023 (when (executable-find executable)
4024 (if (string-match
4025 "%j" org-latex-to-mathml-convert-command)
4026 (file-readable-p org-latex-to-mathml-jar-file)
4027 t))))))
4029 (defcustom org-format-latex-header "\\documentclass{article}
4030 \\usepackage[usenames]{color}
4031 \[PACKAGES]
4032 \[DEFAULT-PACKAGES]
4033 \\pagestyle{empty} % do not remove
4034 % The settings below are copied from fullpage.sty
4035 \\setlength{\\textwidth}{\\paperwidth}
4036 \\addtolength{\\textwidth}{-3cm}
4037 \\setlength{\\oddsidemargin}{1.5cm}
4038 \\addtolength{\\oddsidemargin}{-2.54cm}
4039 \\setlength{\\evensidemargin}{\\oddsidemargin}
4040 \\setlength{\\textheight}{\\paperheight}
4041 \\addtolength{\\textheight}{-\\headheight}
4042 \\addtolength{\\textheight}{-\\headsep}
4043 \\addtolength{\\textheight}{-\\footskip}
4044 \\addtolength{\\textheight}{-3cm}
4045 \\setlength{\\topmargin}{1.5cm}
4046 \\addtolength{\\topmargin}{-2.54cm}"
4047 "The document header used for processing LaTeX fragments.
4048 It is imperative that this header make sure that no page number
4049 appears on the page. The package defined in the variables
4050 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4051 will either replace the placeholder \"[PACKAGES]\" in this
4052 header, or they will be appended."
4053 :group 'org-latex
4054 :type 'string)
4056 (defun org-set-packages-alist (var val)
4057 "Set the packages alist and make sure it has 3 elements per entry."
4058 (set var (mapcar (lambda (x)
4059 (if (and (consp x) (= (length x) 2))
4060 (list (car x) (nth 1 x) t)
4062 val)))
4064 (defun org-get-packages-alist (var)
4065 "Get the packages alist and make sure it has 3 elements per entry."
4066 (mapcar (lambda (x)
4067 (if (and (consp x) (= (length x) 2))
4068 (list (car x) (nth 1 x) t)
4070 (default-value var)))
4072 (defcustom org-latex-default-packages-alist
4073 '(("AUTO" "inputenc" t)
4074 ("T1" "fontenc" t)
4075 ("" "fixltx2e" nil)
4076 ("" "graphicx" t)
4077 ("" "longtable" nil)
4078 ("" "float" nil)
4079 ("" "wrapfig" nil)
4080 ("" "rotating" nil)
4081 ("normalem" "ulem" t)
4082 ("" "amsmath" t)
4083 ("" "textcomp" t)
4084 ("" "marvosym" t)
4085 ("" "wasysym" t)
4086 ("" "amssymb" t)
4087 ("" "capt-of" nil)
4088 ("" "hyperref" nil)
4089 "\\tolerance=1000")
4090 "Alist of default packages to be inserted in the header.
4092 Change this only if one of the packages here causes an
4093 incompatibility with another package you are using.
4095 The packages in this list are needed by one part or another of
4096 Org mode to function properly:
4098 - inputenc, fontenc: for basic font and character selection
4099 - fixltx2e: Important patches of LaTeX itself
4100 - graphicx: for including images
4101 - longtable: For multipage tables
4102 - float, wrapfig: for figure placement
4103 - rotating: for sideways figures and tables
4104 - ulem: for underline and strike-through
4105 - amsmath: for subscript and superscript and math environments
4106 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4107 for interpreting the entities in `org-entities'. You can skip
4108 some of these packages if you don't use any of their symbols.
4109 - capt-of: for captions outside of floats
4110 - hyperref: for cross references
4112 Therefore you should not modify this variable unless you know
4113 what you are doing. The one reason to change it anyway is that
4114 you might be loading some other package that conflicts with one
4115 of the default packages. Each element is either a cell or
4116 a string.
4118 A cell is of the format:
4120 \( \"options\" \"package\" SNIPPET-FLAG).
4122 If SNIPPET-FLAG is non-nil, the package also needs to be included
4123 when compiling LaTeX snippets into images for inclusion into
4124 non-LaTeX output.
4126 A string will be inserted as-is in the header of the document."
4127 :group 'org-latex
4128 :group 'org-export-latex
4129 :set 'org-set-packages-alist
4130 :get 'org-get-packages-alist
4131 :version "24.1"
4132 :type '(repeat
4133 (choice
4134 (list :tag "options/package pair"
4135 (string :tag "options")
4136 (string :tag "package")
4137 (boolean :tag "Snippet"))
4138 (string :tag "A line of LaTeX"))))
4140 (defcustom org-latex-packages-alist nil
4141 "Alist of packages to be inserted in every LaTeX header.
4143 These will be inserted after `org-latex-default-packages-alist'.
4144 Each element is either a cell or a string.
4146 A cell is of the format:
4148 \(\"options\" \"package\" SNIPPET-FLAG)
4150 SNIPPET-FLAG, when non-nil, indicates that this package is also
4151 needed when turning LaTeX snippets into images for inclusion into
4152 non-LaTeX output.
4154 A string will be inserted as-is in the header of the document.
4156 Make sure that you only list packages here which:
4158 - you want in every file;
4159 - do not conflict with the setup in `org-format-latex-header';
4160 - do not conflict with the default packages in
4161 `org-latex-default-packages-alist'."
4162 :group 'org-latex
4163 :group 'org-export-latex
4164 :set 'org-set-packages-alist
4165 :get 'org-get-packages-alist
4166 :type '(repeat
4167 (choice
4168 (list :tag "options/package pair"
4169 (string :tag "options")
4170 (string :tag "package")
4171 (boolean :tag "Snippet"))
4172 (string :tag "A line of LaTeX"))))
4174 (defgroup org-appearance nil
4175 "Settings for Org-mode appearance."
4176 :tag "Org Appearance"
4177 :group 'org)
4179 (defcustom org-level-color-stars-only nil
4180 "Non-nil means fontify only the stars in each headline.
4181 When nil, the entire headline is fontified.
4182 Changing it requires restart of `font-lock-mode' to become effective
4183 also in regions already fontified."
4184 :group 'org-appearance
4185 :type 'boolean)
4187 (defcustom org-hide-leading-stars nil
4188 "Non-nil means hide the first N-1 stars in a headline.
4189 This works by using the face `org-hide' for these stars. This
4190 face is white for a light background, and black for a dark
4191 background. You may have to customize the face `org-hide' to
4192 make this work.
4193 Changing it requires restart of `font-lock-mode' to become effective
4194 also in regions already fontified.
4195 You may also set this on a per-file basis by adding one of the following
4196 lines to the buffer:
4198 #+STARTUP: hidestars
4199 #+STARTUP: showstars"
4200 :group 'org-appearance
4201 :type 'boolean)
4203 (defcustom org-hidden-keywords nil
4204 "List of symbols corresponding to keywords to be hidden the org buffer.
4205 For example, a value '(title) for this list will make the document's title
4206 appear in the buffer without the initial #+TITLE: keyword."
4207 :group 'org-appearance
4208 :version "24.1"
4209 :type '(set (const :tag "#+AUTHOR" author)
4210 (const :tag "#+DATE" date)
4211 (const :tag "#+EMAIL" email)
4212 (const :tag "#+TITLE" title)))
4214 (defcustom org-custom-properties nil
4215 "List of properties (as strings) with a special meaning.
4216 The default use of these custom properties is to let the user
4217 hide them with `org-toggle-custom-properties-visibility'."
4218 :group 'org-properties
4219 :group 'org-appearance
4220 :version "24.3"
4221 :type '(repeat (string :tag "Property Name")))
4223 (defcustom org-fontify-done-headline nil
4224 "Non-nil means change the face of a headline if it is marked DONE.
4225 Normally, only the TODO/DONE keyword indicates the state of a headline.
4226 When this is non-nil, the headline after the keyword is set to the
4227 `org-headline-done' as an additional indication."
4228 :group 'org-appearance
4229 :type 'boolean)
4231 (defcustom org-fontify-emphasized-text t
4232 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4233 Changing this variable requires a restart of Emacs to take effect."
4234 :group 'org-appearance
4235 :type 'boolean)
4237 (defcustom org-fontify-whole-heading-line nil
4238 "Non-nil means fontify the whole line for headings.
4239 This is useful when setting a background color for the
4240 org-level-* faces."
4241 :group 'org-appearance
4242 :type 'boolean)
4244 (defcustom org-highlight-latex-and-related nil
4245 "Non-nil means highlight LaTeX related syntax in the buffer.
4246 When non nil, the value should be a list containing any of the
4247 following symbols:
4248 `latex' Highlight LaTeX snippets and environments.
4249 `script' Highlight subscript and superscript.
4250 `entities' Highlight entities."
4251 :group 'org-appearance
4252 :version "24.4"
4253 :package-version '(Org . "8.0")
4254 :type '(choice
4255 (const :tag "No highlighting" nil)
4256 (set :greedy t :tag "Highlight"
4257 (const :tag "LaTeX snippets and environments" latex)
4258 (const :tag "Subscript and superscript" script)
4259 (const :tag "Entities" entities))))
4261 (defcustom org-hide-emphasis-markers nil
4262 "Non-nil mean font-lock should hide the emphasis marker characters."
4263 :group 'org-appearance
4264 :type 'boolean)
4266 (defcustom org-hide-macro-markers nil
4267 "Non-nil mean font-lock should hide the brackets marking macro calls."
4268 :group 'org-appearance
4269 :type 'boolean)
4271 (defcustom org-pretty-entities nil
4272 "Non-nil means show entities as UTF8 characters.
4273 When nil, the \\name form remains in the buffer."
4274 :group 'org-appearance
4275 :version "24.1"
4276 :type 'boolean)
4278 (defcustom org-pretty-entities-include-sub-superscripts t
4279 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4280 :group 'org-appearance
4281 :version "24.1"
4282 :type 'boolean)
4284 (defvar org-emph-re nil
4285 "Regular expression for matching emphasis.
4286 After a match, the match groups contain these elements:
4287 0 The match of the full regular expression, including the characters
4288 before and after the proper match
4289 1 The character before the proper match, or empty at beginning of line
4290 2 The proper match, including the leading and trailing markers
4291 3 The leading marker like * or /, indicating the type of highlighting
4292 4 The text between the emphasis markers, not including the markers
4293 5 The character after the match, empty at the end of a line")
4294 (defvar org-verbatim-re nil
4295 "Regular expression for matching verbatim text.")
4296 (defvar org-emphasis-regexp-components) ; defined just below
4297 (defvar org-emphasis-alist) ; defined just below
4298 (defun org-set-emph-re (var val)
4299 "Set variable and compute the emphasis regular expression."
4300 (set var val)
4301 (when (and (boundp 'org-emphasis-alist)
4302 (boundp 'org-emphasis-regexp-components)
4303 org-emphasis-alist org-emphasis-regexp-components)
4304 (let* ((e org-emphasis-regexp-components)
4305 (pre (car e))
4306 (post (nth 1 e))
4307 (border (nth 2 e))
4308 (body (nth 3 e))
4309 (nl (nth 4 e))
4310 (body1 (concat body "*?"))
4311 (markers (mapconcat 'car org-emphasis-alist ""))
4312 (vmarkers (mapconcat
4313 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4314 org-emphasis-alist "")))
4315 ;; make sure special characters appear at the right position in the class
4316 (if (string-match "\\^" markers)
4317 (setq markers (concat (replace-match "" t t markers) "^")))
4318 (if (string-match "-" markers)
4319 (setq markers (concat (replace-match "" t t markers) "-")))
4320 (if (string-match "\\^" vmarkers)
4321 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4322 (if (string-match "-" vmarkers)
4323 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4324 (if (> nl 0)
4325 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4326 (int-to-string nl) "\\}")))
4327 ;; Make the regexp
4328 (setq org-emph-re
4329 (concat "\\([" pre "]\\|^\\)"
4330 "\\("
4331 "\\([" markers "]\\)"
4332 "\\("
4333 "[^" border "]\\|"
4334 "[^" border "]"
4335 body1
4336 "[^" border "]"
4337 "\\)"
4338 "\\3\\)"
4339 "\\([" post "]\\|$\\)"))
4340 (setq org-verbatim-re
4341 (concat "\\([" pre "]\\|^\\)"
4342 "\\("
4343 "\\([" vmarkers "]\\)"
4344 "\\("
4345 "[^" border "]\\|"
4346 "[^" border "]"
4347 body1
4348 "[^" border "]"
4349 "\\)"
4350 "\\3\\)"
4351 "\\([" post "]\\|$\\)")))))
4353 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4354 ;; set this option proved cumbersome. See this message/thread:
4355 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4356 (defvar org-emphasis-regexp-components
4357 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4358 "Components used to build the regular expression for emphasis.
4359 This is a list with five entries. Terminology: In an emphasis string
4360 like \" *strong word* \", we call the initial space PREMATCH, the final
4361 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4362 and \"trong wor\" is the body. The different components in this variable
4363 specify what is allowed/forbidden in each part:
4365 pre Chars allowed as prematch. Beginning of line will be allowed too.
4366 post Chars allowed as postmatch. End of line will be allowed too.
4367 border The chars *forbidden* as border characters.
4368 body-regexp A regexp like \".\" to match a body character. Don't use
4369 non-shy groups here, and don't allow newline here.
4370 newline The maximum number of newlines allowed in an emphasis exp.
4372 You need to reload Org or to restart Emacs after customizing this.")
4374 (defcustom org-emphasis-alist
4375 `(("*" bold)
4376 ("/" italic)
4377 ("_" underline)
4378 ("=" org-verbatim verbatim)
4379 ("~" org-code verbatim)
4380 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4381 "Alist of characters and faces to emphasize text.
4382 Text starting and ending with a special character will be emphasized,
4383 for example *bold*, _underlined_ and /italic/. This variable sets the
4384 marker characters and the face to be used by font-lock for highlighting
4385 in Org-mode Emacs buffers.
4387 You need to reload Org or to restart Emacs after customizing this."
4388 :group 'org-appearance
4389 :set 'org-set-emph-re
4390 :version "24.4"
4391 :package-version '(Org . "8.0")
4392 :type '(repeat
4393 (list
4394 (string :tag "Marker character")
4395 (choice
4396 (face :tag "Font-lock-face")
4397 (plist :tag "Face property list"))
4398 (option (const verbatim)))))
4400 (defvar org-protecting-blocks
4401 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4402 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4403 This is needed for font-lock setup.")
4405 ;;; Miscellaneous options
4407 (defgroup org-completion nil
4408 "Completion in Org-mode."
4409 :tag "Org Completion"
4410 :group 'org)
4412 (defcustom org-completion-use-ido nil
4413 "Non-nil means use ido completion wherever possible.
4414 Note that `ido-mode' must be active for this variable to be relevant.
4415 If you decide to turn this variable on, you might well want to turn off
4416 `org-outline-path-complete-in-steps'.
4417 See also `org-completion-use-iswitchb'."
4418 :group 'org-completion
4419 :type 'boolean)
4421 (defcustom org-completion-use-iswitchb nil
4422 "Non-nil means use iswitchb completion wherever possible.
4423 Note that `iswitchb-mode' must be active for this variable to be relevant.
4424 If you decide to turn this variable on, you might well want to turn off
4425 `org-outline-path-complete-in-steps'.
4426 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4427 :group 'org-completion
4428 :type 'boolean)
4430 (defcustom org-completion-fallback-command 'hippie-expand
4431 "The expansion command called by \\[pcomplete] in normal context.
4432 Normal means, no org-mode-specific context."
4433 :group 'org-completion
4434 :type 'function)
4436 ;;; Functions and variables from their packages
4437 ;; Declared here to avoid compiler warnings
4439 ;; XEmacs only
4440 (defvar outline-mode-menu-heading)
4441 (defvar outline-mode-menu-show)
4442 (defvar outline-mode-menu-hide)
4443 (defvar zmacs-regions) ; XEmacs regions
4445 ;; Emacs only
4446 (defvar mark-active)
4448 ;; Various packages
4449 (declare-function calendar-absolute-from-iso "cal-iso" (date))
4450 (declare-function calendar-forward-day "cal-move" (arg))
4451 (declare-function calendar-goto-date "cal-move" (date))
4452 (declare-function calendar-goto-today "cal-move" ())
4453 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4454 (defvar calc-embedded-close-formula)
4455 (defvar calc-embedded-open-formula)
4456 (declare-function cdlatex-tab "ext:cdlatex" ())
4457 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4458 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4459 (defvar font-lock-unfontify-region-function)
4460 (declare-function iswitchb-read-buffer "iswitchb"
4461 (prompt &optional default require-match start matches-set))
4462 (defvar iswitchb-temp-buflist)
4463 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4464 (defvar org-agenda-tags-todo-honor-ignore-options)
4465 (declare-function org-agenda-skip "org-agenda" ())
4466 (declare-function
4467 org-agenda-format-item "org-agenda"
4468 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4469 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4470 (declare-function org-agenda-change-all-lines "org-agenda"
4471 (newhead hdmarker &optional fixface just-this))
4472 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4473 (declare-function org-agenda-maybe-redo "org-agenda" ())
4474 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4475 (beg end))
4476 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4477 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4478 "org-agenda" (&optional end))
4479 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4480 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4481 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4482 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4483 (declare-function org-indent-mode "org-indent" (&optional arg))
4484 (declare-function parse-time-string "parse-time" (string))
4485 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4486 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4487 (defvar remember-data-file)
4488 (defvar texmathp-why)
4489 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4490 (declare-function table--at-cell-p "table" (position &optional object at-column))
4491 (declare-function calc-eval "calc" (str &optional separator &rest args))
4493 ;;;###autoload
4494 (defun turn-on-orgtbl ()
4495 "Unconditionally turn on `orgtbl-mode'."
4496 (require 'org-table)
4497 (orgtbl-mode 1))
4499 (defun org-at-table-p (&optional table-type)
4500 "Return t if the cursor is inside an org-type table.
4501 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4502 (if org-enable-table-editor
4503 (save-excursion
4504 (beginning-of-line 1)
4505 (looking-at (if table-type org-table-any-line-regexp
4506 org-table-line-regexp)))
4507 nil))
4508 (defsubst org-table-p () (org-at-table-p))
4510 (defun org-at-table.el-p ()
4511 "Return t if and only if we are at a table.el table."
4512 (and (org-at-table-p 'any)
4513 (save-excursion
4514 (goto-char (org-table-begin 'any))
4515 (looking-at org-table1-hline-regexp))))
4517 (defun org-table-recognize-table.el ()
4518 "If there is a table.el table nearby, recognize it and move into it."
4519 (if org-table-tab-recognizes-table.el
4520 (if (org-at-table.el-p)
4521 (progn
4522 (beginning-of-line 1)
4523 (if (looking-at org-table-dataline-regexp)
4525 (if (looking-at org-table1-hline-regexp)
4526 (progn
4527 (beginning-of-line 2)
4528 (if (looking-at org-table-any-border-regexp)
4529 (beginning-of-line -1)))))
4530 (if (re-search-forward "|" (org-table-end t) t)
4531 (progn
4532 (require 'table)
4533 (if (table--at-cell-p (point))
4535 (message "recognizing table.el table...")
4536 (table-recognize-table)
4537 (message "recognizing table.el table...done")))
4538 (error "This should not happen"))
4540 nil)
4541 nil))
4543 (defun org-at-table-hline-p ()
4544 "Return t if the cursor is inside a hline in a table."
4545 (if org-enable-table-editor
4546 (save-excursion
4547 (beginning-of-line 1)
4548 (looking-at org-table-hline-regexp))
4549 nil))
4551 (defun org-table-map-tables (function &optional quietly)
4552 "Apply FUNCTION to the start of all tables in the buffer."
4553 (save-excursion
4554 (save-restriction
4555 (widen)
4556 (goto-char (point-min))
4557 (while (re-search-forward org-table-any-line-regexp nil t)
4558 (unless quietly
4559 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4560 (beginning-of-line 1)
4561 (when (and (looking-at org-table-line-regexp)
4562 ;; Exclude tables in src/example/verbatim/clocktable blocks
4563 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4564 (save-excursion (funcall function))
4565 (or (looking-at org-table-line-regexp)
4566 (forward-char 1)))
4567 (re-search-forward org-table-any-border-regexp nil 1))))
4568 (unless quietly (message "Mapping tables: done")))
4570 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4571 (declare-function org-clock-update-mode-line "org-clock" ())
4572 (declare-function org-resolve-clocks "org-clock"
4573 (&optional also-non-dangling-p prompt last-valid))
4575 (defun org-at-TBLFM-p (&optional pos)
4576 "Return t when point (or POS) is in #+TBLFM line."
4577 (save-excursion
4578 (let ((pos pos)))
4579 (goto-char (or pos (point)))
4580 (beginning-of-line 1)
4581 (looking-at org-TBLFM-regexp)))
4583 (defvar org-clock-start-time)
4584 (defvar org-clock-marker (make-marker)
4585 "Marker recording the last clock-in.")
4586 (defvar org-clock-hd-marker (make-marker)
4587 "Marker recording the last clock-in, but the headline position.")
4588 (defvar org-clock-heading ""
4589 "The heading of the current clock entry.")
4590 (defun org-clock-is-active ()
4591 "Return the buffer where the clock is currently running.
4592 Return nil if no clock is running."
4593 (marker-buffer org-clock-marker))
4595 (defun org-check-running-clock ()
4596 "Check if the current buffer contains the running clock.
4597 If yes, offer to stop it and to save the buffer with the changes."
4598 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4599 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4600 (buffer-name))))
4601 (org-clock-out)
4602 (when (y-or-n-p "Save changed buffer?")
4603 (save-buffer))))
4605 (defun org-clocktable-try-shift (dir n)
4606 "Check if this line starts a clock table, if yes, shift the time block."
4607 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4608 (org-clocktable-shift dir n)))
4610 ;;;###autoload
4611 (defun org-clock-persistence-insinuate ()
4612 "Set up hooks for clock persistence."
4613 (require 'org-clock)
4614 (add-hook 'org-mode-hook 'org-clock-load)
4615 (add-hook 'kill-emacs-hook 'org-clock-save))
4617 (defgroup org-archive nil
4618 "Options concerning archiving in Org-mode."
4619 :tag "Org Archive"
4620 :group 'org-structure)
4622 (defcustom org-archive-location "%s_archive::"
4623 "The location where subtrees should be archived.
4625 The value of this variable is a string, consisting of two parts,
4626 separated by a double-colon. The first part is a filename and
4627 the second part is a headline.
4629 When the filename is omitted, archiving happens in the same file.
4630 %s in the filename will be replaced by the current file
4631 name (without the directory part). Archiving to a different file
4632 is useful to keep archived entries from contributing to the
4633 Org-mode Agenda.
4635 The archived entries will be filed as subtrees of the specified
4636 headline. When the headline is omitted, the subtrees are simply
4637 filed away at the end of the file, as top-level entries. Also in
4638 the heading you can use %s to represent the file name, this can be
4639 useful when using the same archive for a number of different files.
4641 Here are a few examples:
4642 \"%s_archive::\"
4643 If the current file is Projects.org, archive in file
4644 Projects.org_archive, as top-level trees. This is the default.
4646 \"::* Archived Tasks\"
4647 Archive in the current file, under the top-level headline
4648 \"* Archived Tasks\".
4650 \"~/org/archive.org::\"
4651 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4653 \"~/org/archive.org::* From %s\"
4654 Archive in file ~/org/archive.org (absolute path), under headlines
4655 \"From FILENAME\" where file name is the current file name.
4657 \"~/org/datetree.org::datetree/* Finished Tasks\"
4658 The \"datetree/\" string is special, signifying to archive
4659 items to the datetree. Items are placed in either the CLOSED
4660 date of the item, or the current date if there is no CLOSED date.
4661 The heading will be a subentry to the current date. There doesn't
4662 need to be a heading, but there always needs to be a slash after
4663 datetree. For example, to store archived items directly in the
4664 datetree, use \"~/org/datetree.org::datetree/\".
4666 \"basement::** Finished Tasks\"
4667 Archive in file ./basement (relative path), as level 3 trees
4668 below the level 2 heading \"** Finished Tasks\".
4670 You may set this option on a per-file basis by adding to the buffer a
4671 line like
4673 #+ARCHIVE: basement::** Finished Tasks
4675 You may also define it locally for a subtree by setting an ARCHIVE property
4676 in the entry. If such a property is found in an entry, or anywhere up
4677 the hierarchy, it will be used."
4678 :group 'org-archive
4679 :type 'string)
4681 (defcustom org-agenda-skip-archived-trees t
4682 "Non-nil means the agenda will skip any items located in archived trees.
4683 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4684 variable is no longer recommended, you should leave it at the value t.
4685 Instead, use the key `v' to cycle the archives-mode in the agenda."
4686 :group 'org-archive
4687 :group 'org-agenda-skip
4688 :type 'boolean)
4690 (defcustom org-columns-skip-archived-trees t
4691 "Non-nil means ignore archived trees when creating column view."
4692 :group 'org-archive
4693 :group 'org-properties
4694 :type 'boolean)
4696 (defcustom org-cycle-open-archived-trees nil
4697 "Non-nil means `org-cycle' will open archived trees.
4698 An archived tree is a tree marked with the tag ARCHIVE.
4699 When nil, archived trees will stay folded. You can still open them with
4700 normal outline commands like `show-all', but not with the cycling commands."
4701 :group 'org-archive
4702 :group 'org-cycle
4703 :type 'boolean)
4705 (defcustom org-sparse-tree-open-archived-trees nil
4706 "Non-nil means sparse tree construction shows matches in archived trees.
4707 When nil, matches in these trees are highlighted, but the trees are kept in
4708 collapsed state."
4709 :group 'org-archive
4710 :group 'org-sparse-trees
4711 :type 'boolean)
4713 (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
4714 "The default date type when building a sparse tree.
4715 When this is nil, a date is a scheduled or a deadline timestamp.
4716 Otherwise, these types are allowed:
4718 all: all timestamps
4719 active: only active timestamps (<...>)
4720 inactive: only inactive timestamps (<...)
4721 scheduled: only scheduled timestamps
4722 deadline: only deadline timestamps"
4723 :type '(choice (const :tag "Scheduled or deadline" scheduled-or-deadline)
4724 (const :tag "All timestamps" all)
4725 (const :tag "Only active timestamps" active)
4726 (const :tag "Only inactive timestamps" inactive)
4727 (const :tag "Only scheduled timestamps" scheduled)
4728 (const :tag "Only deadline timestamps" deadline)
4729 (const :tag "Only closed timestamps" closed))
4730 :version "24.3"
4731 :group 'org-sparse-trees)
4733 (defun org-cycle-hide-archived-subtrees (state)
4734 "Re-hide all archived subtrees after a visibility state change."
4735 (when (and (not org-cycle-open-archived-trees)
4736 (not (memq state '(overview folded))))
4737 (save-excursion
4738 (let* ((globalp (memq state '(contents all)))
4739 (beg (if globalp (point-min) (point)))
4740 (end (if globalp (point-max) (org-end-of-subtree t))))
4741 (org-hide-archived-subtrees beg end)
4742 (goto-char beg)
4743 (if (looking-at (concat ".*:" org-archive-tag ":"))
4744 (message "%s" (substitute-command-keys
4745 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4747 (defun org-force-cycle-archived ()
4748 "Cycle subtree even if it is archived."
4749 (interactive)
4750 (setq this-command 'org-cycle)
4751 (let ((org-cycle-open-archived-trees t))
4752 (call-interactively 'org-cycle)))
4754 (defun org-hide-archived-subtrees (beg end)
4755 "Re-hide all archived subtrees after a visibility state change."
4756 (save-excursion
4757 (let* ((re (concat ":" org-archive-tag ":")))
4758 (goto-char beg)
4759 (while (re-search-forward re end t)
4760 (when (org-at-heading-p)
4761 (org-flag-subtree t)
4762 (org-end-of-subtree t))))))
4764 (declare-function outline-end-of-heading "outline" ())
4765 (declare-function outline-flag-region "outline" (from to flag))
4766 (defun org-flag-subtree (flag)
4767 (save-excursion
4768 (org-back-to-heading t)
4769 (outline-end-of-heading)
4770 (outline-flag-region (point)
4771 (progn (org-end-of-subtree t) (point))
4772 flag)))
4774 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4776 ;; Declare Column View Code
4778 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4779 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4780 (declare-function org-columns-compute "org-colview" (property))
4782 ;; Declare ID code
4784 (declare-function org-id-store-link "org-id")
4785 (declare-function org-id-locations-load "org-id")
4786 (declare-function org-id-locations-save "org-id")
4787 (defvar org-id-track-globally)
4789 ;;; Variables for pre-computed regular expressions, all buffer local
4791 (defvar org-todo-regexp nil
4792 "Matches any of the TODO state keywords.")
4793 (make-variable-buffer-local 'org-todo-regexp)
4794 (defvar org-not-done-regexp nil
4795 "Matches any of the TODO state keywords except the last one.")
4796 (make-variable-buffer-local 'org-not-done-regexp)
4797 (defvar org-not-done-heading-regexp nil
4798 "Matches a TODO headline that is not done.")
4799 (make-variable-buffer-local 'org-not-done-regexp)
4800 (defvar org-todo-line-regexp nil
4801 "Matches a headline and puts TODO state into group 2 if present.")
4802 (make-variable-buffer-local 'org-todo-line-regexp)
4803 (defvar org-complex-heading-regexp nil
4804 "Matches a headline and puts everything into groups:
4805 group 1: the stars
4806 group 2: The todo keyword, maybe
4807 group 3: Priority cookie
4808 group 4: True headline
4809 group 5: Tags")
4810 (make-variable-buffer-local 'org-complex-heading-regexp)
4811 (defvar org-complex-heading-regexp-format nil
4812 "Printf format to make regexp to match an exact headline.
4813 This regexp will match the headline of any node which has the
4814 exact headline text that is put into the format, but may have any
4815 TODO state, priority and tags.")
4816 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4817 (defvar org-todo-line-tags-regexp nil
4818 "Matches a headline and puts TODO state into group 2 if present.
4819 Also put tags into group 4 if tags are present.")
4820 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4822 (defconst org-plain-time-of-day-regexp
4823 (concat
4824 "\\(\\<[012]?[0-9]"
4825 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4826 "\\(--?"
4827 "\\(\\<[012]?[0-9]"
4828 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4829 "\\)?")
4830 "Regular expression to match a plain time or time range.
4831 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4832 groups carry important information:
4833 0 the full match
4834 1 the first time, range or not
4835 8 the second time, if it is a range.")
4837 (defconst org-plain-time-extension-regexp
4838 (concat
4839 "\\(\\<[012]?[0-9]"
4840 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4841 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4842 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4843 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4844 groups carry important information:
4845 0 the full match
4846 7 hours of duration
4847 9 minutes of duration")
4849 (defconst org-stamp-time-of-day-regexp
4850 (concat
4851 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4852 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4853 "\\(--?"
4854 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4855 "Regular expression to match a timestamp time or time range.
4856 After a match, the following groups carry important information:
4857 0 the full match
4858 1 date plus weekday, for back referencing to make sure both times are on the same day
4859 2 the first time, range or not
4860 4 the second time, if it is a range.")
4862 (defconst org-startup-options
4863 '(("fold" org-startup-folded t)
4864 ("overview" org-startup-folded t)
4865 ("nofold" org-startup-folded nil)
4866 ("showall" org-startup-folded nil)
4867 ("showeverything" org-startup-folded showeverything)
4868 ("content" org-startup-folded content)
4869 ("indent" org-startup-indented t)
4870 ("noindent" org-startup-indented nil)
4871 ("hidestars" org-hide-leading-stars t)
4872 ("showstars" org-hide-leading-stars nil)
4873 ("odd" org-odd-levels-only t)
4874 ("oddeven" org-odd-levels-only nil)
4875 ("align" org-startup-align-all-tables t)
4876 ("noalign" org-startup-align-all-tables nil)
4877 ("inlineimages" org-startup-with-inline-images t)
4878 ("noinlineimages" org-startup-with-inline-images nil)
4879 ("latexpreview" org-startup-with-latex-preview t)
4880 ("nolatexpreview" org-startup-with-latex-preview nil)
4881 ("customtime" org-display-custom-times t)
4882 ("logdone" org-log-done time)
4883 ("lognotedone" org-log-done note)
4884 ("nologdone" org-log-done nil)
4885 ("lognoteclock-out" org-log-note-clock-out t)
4886 ("nolognoteclock-out" org-log-note-clock-out nil)
4887 ("logrepeat" org-log-repeat state)
4888 ("lognoterepeat" org-log-repeat note)
4889 ("logdrawer" org-log-into-drawer t)
4890 ("nologdrawer" org-log-into-drawer nil)
4891 ("logstatesreversed" org-log-states-order-reversed t)
4892 ("nologstatesreversed" org-log-states-order-reversed nil)
4893 ("nologrepeat" org-log-repeat nil)
4894 ("logreschedule" org-log-reschedule time)
4895 ("lognotereschedule" org-log-reschedule note)
4896 ("nologreschedule" org-log-reschedule nil)
4897 ("logredeadline" org-log-redeadline time)
4898 ("lognoteredeadline" org-log-redeadline note)
4899 ("nologredeadline" org-log-redeadline nil)
4900 ("logrefile" org-log-refile time)
4901 ("lognoterefile" org-log-refile note)
4902 ("nologrefile" org-log-refile nil)
4903 ("fninline" org-footnote-define-inline t)
4904 ("nofninline" org-footnote-define-inline nil)
4905 ("fnlocal" org-footnote-section nil)
4906 ("fnauto" org-footnote-auto-label t)
4907 ("fnprompt" org-footnote-auto-label nil)
4908 ("fnconfirm" org-footnote-auto-label confirm)
4909 ("fnplain" org-footnote-auto-label plain)
4910 ("fnadjust" org-footnote-auto-adjust t)
4911 ("nofnadjust" org-footnote-auto-adjust nil)
4912 ("constcgs" constants-unit-system cgs)
4913 ("constSI" constants-unit-system SI)
4914 ("noptag" org-tag-persistent-alist nil)
4915 ("hideblocks" org-hide-block-startup t)
4916 ("nohideblocks" org-hide-block-startup nil)
4917 ("beamer" org-startup-with-beamer-mode t)
4918 ("entitiespretty" org-pretty-entities t)
4919 ("entitiesplain" org-pretty-entities nil))
4920 "Variable associated with STARTUP options for org-mode.
4921 Each element is a list of three items: the startup options (as written
4922 in the #+STARTUP line), the corresponding variable, and the value to set
4923 this variable to if the option is found. An optional forth element PUSH
4924 means to push this value onto the list in the variable.")
4926 (defcustom org-group-tags t
4927 "When non-nil (the default), use group tags.
4928 This can be turned on/off through `org-toggle-tags-groups'."
4929 :group 'org-tags
4930 :group 'org-startup
4931 :type 'boolean)
4933 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4935 (defun org-toggle-tags-groups ()
4936 "Toggle support for group tags.
4937 Support for group tags is controlled by the option
4938 `org-group-tags', which is non-nil by default."
4939 (interactive)
4940 (setq org-group-tags (not org-group-tags))
4941 (cond ((and (derived-mode-p 'org-agenda-mode)
4942 org-group-tags)
4943 (org-agenda-redo))
4944 ((derived-mode-p 'org-mode)
4945 (let ((org-inhibit-startup t)) (org-mode))))
4946 (message "Groups tags support has been turned %s"
4947 (if org-group-tags "on" "off")))
4949 (defun org-set-regexps-and-options (&optional tags-only)
4950 "Precompute regular expressions used in the current buffer.
4951 When optional argument TAGS-ONLY is non-nil, only compute tags
4952 related expressions."
4953 (when (derived-mode-p 'org-mode)
4954 (let ((alist (org--setup-collect-keywords
4955 (org-make-options-regexp
4956 (append '("FILETAGS" "TAGS" "SETUPFILE")
4957 (and (not tags-only)
4958 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4959 "LINK" "PRIORITIES" "PROPERTY" "SEQ_TODO"
4960 "STARTUP" "TODO" "TYP_TODO")))))))
4961 (org--setup-process-tags
4962 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4963 (unless tags-only
4964 ;; File properties.
4965 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4966 ;; Archive location.
4967 (let ((archive (cdr (assq 'archive alist))))
4968 (when archive (org-set-local 'org-archive-location archive)))
4969 ;; Category.
4970 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4971 (when cat
4972 (org-set-local 'org-category (intern cat))
4973 (org-set-local 'org-file-properties
4974 (org--update-property-plist
4975 "CATEGORY" cat org-file-properties))))
4976 ;; Columns.
4977 (let ((column (cdr (assq 'columns alist))))
4978 (when column (org-set-local 'org-columns-default-format column)))
4979 ;; Constants.
4980 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4981 ;; Link abbreviations.
4982 (let ((links (cdr (assq 'link alist))))
4983 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4984 ;; Priorities.
4985 (let ((priorities (cdr (assq 'priorities alist))))
4986 (when priorities
4987 (org-set-local 'org-highest-priority (nth 0 priorities))
4988 (org-set-local 'org-lowest-priority (nth 1 priorities))
4989 (org-set-local 'org-default-priority (nth 2 priorities))))
4990 ;; Startup options.
4991 (let ((startup (cdr (assq 'startup alist))))
4992 (dolist (option startup)
4993 (let ((entry (assoc-string option org-startup-options t)))
4994 (when entry
4995 (let ((var (nth 1 entry))
4996 (val (nth 2 entry)))
4997 (if (not (nth 3 entry)) (org-set-local var val)
4998 (unless (listp (symbol-value var))
4999 (org-set-local var nil))
5000 (add-to-list var val)))))))
5001 ;; TODO keywords.
5002 (org-set-local 'org-todo-kwd-alist nil)
5003 (org-set-local 'org-todo-key-alist nil)
5004 (org-set-local 'org-todo-key-trigger nil)
5005 (org-set-local 'org-todo-keywords-1 nil)
5006 (org-set-local 'org-done-keywords nil)
5007 (org-set-local 'org-todo-heads nil)
5008 (org-set-local 'org-todo-sets nil)
5009 (org-set-local 'org-todo-log-states nil)
5010 (let ((todo-sequences
5011 (or (nreverse (cdr (assq 'todo alist)))
5012 (let ((d (default-value 'org-todo-keywords)))
5013 (if (not (stringp (car d))) d
5014 ;; XXX: Backward compatibility code.
5015 (list (cons org-todo-interpretation d)))))))
5016 (dolist (sequence todo-sequences)
5017 (let* ((sequence (or (run-hook-with-args-until-success
5018 'org-todo-setup-filter-hook sequence)
5019 sequence))
5020 (sequence-type (car sequence))
5021 (keywords (cdr sequence))
5022 (sep (member "|" keywords))
5023 names alist)
5024 (dolist (k (remove "|" keywords))
5025 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5027 (error "Invalid TODO keyword %s" k))
5028 (let ((name (match-string 1 k))
5029 (key (match-string 2 k))
5030 (log (org-extract-log-state-settings k)))
5031 (push name names)
5032 (push (cons name (and key (string-to-char key))) alist)
5033 (when log (push log org-todo-log-states))))
5034 (let* ((names (nreverse names))
5035 (done (if sep (org-remove-keyword-keys (cdr sep))
5036 (last names)))
5037 (head (car names))
5038 (tail (list sequence-type head (car done) (org-last done))))
5039 (add-to-list 'org-todo-heads head 'append)
5040 (push names org-todo-sets)
5041 (setq org-done-keywords (append org-done-keywords done nil))
5042 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5043 (setq org-todo-key-alist
5044 (append org-todo-key-alist
5045 (and alist
5046 (append '((:startgroup))
5047 (nreverse alist)
5048 '((:endgroup))))))
5049 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5050 (setq org-todo-sets (nreverse org-todo-sets)
5051 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5052 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5053 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5054 ;; Compute the regular expressions and other local variables.
5055 ;; Using `org-outline-regexp-bol' would complicate them much,
5056 ;; because of the fixed white space at the end of that string.
5057 (if (not org-done-keywords)
5058 (setq org-done-keywords
5059 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5060 (setq org-not-done-keywords
5061 (org-delete-all org-done-keywords
5062 (copy-sequence org-todo-keywords-1))
5063 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5064 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5065 org-not-done-heading-regexp
5066 (format org-heading-keyword-regexp-format org-not-done-regexp)
5067 org-todo-line-regexp
5068 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5069 org-complex-heading-regexp
5070 (concat "^\\(\\*+\\)"
5071 "\\(?: +" org-todo-regexp "\\)?"
5072 "\\(?: +\\(\\[#.\\]\\)\\)?"
5073 "\\(?: +\\(.*?\\)\\)??"
5074 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5075 "[ \t]*$")
5076 org-complex-heading-regexp-format
5077 (concat "^\\(\\*+\\)"
5078 "\\(?: +" org-todo-regexp "\\)?"
5079 "\\(?: +\\(\\[#.\\]\\)\\)?"
5080 "\\(?: +"
5081 ;; Stats cookies can be stuck to body.
5082 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5083 "\\(%s\\)"
5084 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5085 "\\)"
5086 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5087 "[ \t]*$")
5088 org-todo-line-tags-regexp
5089 (concat "^\\(\\*+\\)"
5090 "\\(?: +" org-todo-regexp "\\)?"
5091 "\\(?: +\\(.*?\\)\\)??"
5092 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5093 "[ \t]*$"))
5094 (org-compute-latex-and-related-regexp)))))
5096 (defun org--setup-collect-keywords (regexp &optional files alist)
5097 "Return setup keywords values as an alist.
5099 REGEXP matches a subset of setup keywords. FILES is a list of
5100 file names already visited. It is used to avoid circular setup
5101 files. ALIST, when non-nil, is the alist computed so far.
5103 Return value contains the following keys: `archive', `category',
5104 `columns', `constants', `filetags', `link', `priorities',
5105 `property', `startup', `tags' and `todo'."
5106 (org-with-wide-buffer
5107 (goto-char (point-min))
5108 (let ((case-fold-search t))
5109 (while (re-search-forward regexp nil t)
5110 (let ((element (org-element-at-point)))
5111 (when (eq (org-element-type element) 'keyword)
5112 (let ((key (org-element-property :key element))
5113 (value (org-element-property :value element)))
5114 (cond
5115 ((equal key "ARCHIVE")
5116 (when (org-string-nw-p value)
5117 (push (cons 'archive value) alist)))
5118 ((equal key "CATEGORY") (push (cons 'category value) alist))
5119 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5120 ((equal key "CONSTANTS")
5121 (let* ((constants (assq 'constants alist))
5122 (store (cdr constants)))
5123 (dolist (pair (org-split-string value))
5124 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5125 pair)
5126 (let* ((name (match-string 1 pair))
5127 (value (match-string 2 pair))
5128 (old (assoc name store)))
5129 (if old (setcdr old value)
5130 (push (cons name value) store)))))
5131 (if constants (setcdr constants store)
5132 (push (cons 'constants store) alist))))
5133 ((equal key "FILETAGS")
5134 (when (org-string-nw-p value)
5135 (let ((old (assq 'filetags alist))
5136 (new (apply #'nconc
5137 (mapcar (lambda (x) (org-split-string x ":"))
5138 (org-split-string value)))))
5139 (if old (setcdr old (append new (cdr old)))
5140 (push (cons 'filetags new) alist)))))
5141 ((equal key "LINK")
5142 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5143 (let ((links (assq 'link alist))
5144 (pair (cons (org-match-string-no-properties 1 value)
5145 (org-match-string-no-properties 2 value))))
5146 (if links (push pair (cdr links))
5147 (push (list 'link pair) alist)))))
5148 ((equal key "PRIORITIES")
5149 (push (cons 'priorities
5150 (let ((prio (org-split-string value)))
5151 (if (< (length prio) 3) '(?A ?C ?B)
5152 (mapcar #'string-to-char prio))))
5153 alist))
5154 ((equal key "PROPERTY")
5155 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5156 (let* ((property (assq 'property alist))
5157 (value (org--update-property-plist
5158 (org-match-string-no-properties 1 value)
5159 (org-match-string-no-properties 2 value)
5160 (cdr property))))
5161 (if property (setcdr property value)
5162 (push (cons 'property value) alist)))))
5163 ((equal key "STARTUP")
5164 (let ((startup (assq 'startup alist)))
5165 (if startup
5166 (setcdr startup
5167 (append (cdr startup) (org-split-string value)))
5168 (push (cons 'startup (org-split-string value)) alist))))
5169 ((equal key "TAGS")
5170 (let ((tag-cell (assq 'tags alist)))
5171 (if tag-cell
5172 (setcdr tag-cell
5173 (append (cdr tag-cell)
5174 '("\\n")
5175 (org-split-string value)))
5176 (push (cons 'tags (org-split-string value)) alist))))
5177 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5178 (let ((todo (assq 'todo alist))
5179 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5180 (org-split-string value))))
5181 (if todo (push value (cdr todo))
5182 (push (list 'todo value) alist))))
5183 ((equal key "SETUPFILE")
5184 (unless buffer-read-only ; Do not check in Gnus messages.
5185 (let ((f (and (org-string-nw-p value)
5186 (expand-file-name
5187 (org-remove-double-quotes value)))))
5188 (when (and f (file-readable-p f) (not (member f files)))
5189 (with-temp-buffer
5190 (insert-file-contents f)
5191 (setq alist
5192 ;; Fake Org mode to benefit from cache
5193 ;; without recurring needlessly.
5194 (let ((major-mode 'org-mode))
5195 (org--setup-collect-keywords
5196 regexp (cons f files) alist)))))))))))))))
5197 alist)
5199 (defun org--setup-process-tags (tags filetags)
5200 "Precompute variables used for tags.
5201 TAGS is a list of tags and tag group symbols, as strings.
5202 FILETAGS is a list of tags, as strings."
5203 ;; Process the file tags.
5204 (org-set-local 'org-file-tags
5205 (mapcar #'org-add-prop-inherited filetags))
5206 ;; Provide default tags if no local tags are found.
5207 (when (and (not tags) org-tag-alist)
5208 (setq tags
5209 (mapcar (lambda (tag)
5210 (case (car tag)
5211 (:startgroup "{")
5212 (:endgroup "}")
5213 (:grouptags ":")
5214 (:newline "\\n")
5215 (otherwise (concat (car tag)
5216 (and (characterp (cdr tag))
5217 (format "(%c)" (cdr tag)))))))
5218 org-tag-alist)))
5219 ;; Process the tags.
5220 (org-set-local 'org-tag-groups-alist nil)
5221 (org-set-local 'org-tag-alist nil)
5222 (let (group-flag)
5223 (while tags
5224 (let ((e (car tags)))
5225 (setq tags (cdr tags))
5226 (cond
5227 ((equal e "{")
5228 (push '(:startgroup) org-tag-alist)
5229 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5230 ((equal e "}")
5231 (push '(:endgroup) org-tag-alist)
5232 (setq group-flag nil))
5233 ((equal e ":")
5234 (push '(:grouptags) org-tag-alist)
5235 (setq group-flag 'append))
5236 ((equal e "\\n") (push '(:newline) org-tag-alist))
5237 ((string-match
5238 (org-re "\\`\\([[:alnum:]_@#%]+\\)\\(?:(\\(.\\))\\)?\\'") e)
5239 (let ((tag (match-string 1 e))
5240 (key (and (match-beginning 2)
5241 (string-to-char (match-string 2 e)))))
5242 (cond ((eq group-flag 'append)
5243 (setcar org-tag-groups-alist
5244 (append (car org-tag-groups-alist) (list tag))))
5245 (group-flag (push (list tag) org-tag-groups-alist)))
5246 (unless (assoc tag org-tag-alist)
5247 (push (cons tag key) org-tag-alist))))))))
5248 (setq org-tag-alist (nreverse org-tag-alist)))
5250 (defun org-file-contents (file &optional noerror)
5251 "Return the contents of FILE, as a string."
5252 (if (and file (file-readable-p file))
5253 (with-temp-buffer
5254 (insert-file-contents file)
5255 (buffer-string))
5256 (funcall (if noerror 'message 'error)
5257 "Cannot read file \"%s\"%s"
5258 file
5259 (let ((from (buffer-file-name (buffer-base-buffer))))
5260 (if from (concat " (referenced in file \"" from "\")") "")))))
5262 (defun org-extract-log-state-settings (x)
5263 "Extract the log state setting from a TODO keyword string.
5264 This will extract info from a string like \"WAIT(w@/!)\"."
5265 (let (kw key log1 log2)
5266 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5267 (setq kw (match-string 1 x)
5268 key (and (match-end 2) (match-string 2 x))
5269 log1 (and (match-end 3) (match-string 3 x))
5270 log2 (and (match-end 4) (match-string 4 x)))
5271 (and (or log1 log2)
5272 (list kw
5273 (and log1 (if (equal log1 "!") 'time 'note))
5274 (and log2 (if (equal log2 "!") 'time 'note)))))))
5276 (defun org-remove-keyword-keys (list)
5277 "Remove a pair of parenthesis at the end of each string in LIST."
5278 (mapcar (lambda (x)
5279 (if (string-match "(.*)$" x)
5280 (substring x 0 (match-beginning 0))
5282 list))
5284 (defun org-assign-fast-keys (alist)
5285 "Assign fast keys to a keyword-key alist.
5286 Respect keys that are already there."
5287 (let (new e (alt ?0))
5288 (while (setq e (pop alist))
5289 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5290 (cdr e)) ;; Key already assigned.
5291 (push e new)
5292 (let ((clist (string-to-list (downcase (car e))))
5293 (used (append new alist)))
5294 (when (= (car clist) ?@)
5295 (pop clist))
5296 (while (and clist (rassoc (car clist) used))
5297 (pop clist))
5298 (unless clist
5299 (while (rassoc alt used)
5300 (incf alt)))
5301 (push (cons (car e) (or (car clist) alt)) new))))
5302 (nreverse new)))
5304 ;;; Some variables used in various places
5306 (defvar org-window-configuration nil
5307 "Used in various places to store a window configuration.")
5308 (defvar org-selected-window nil
5309 "Used in various places to store a window configuration.")
5310 (defvar org-finish-function nil
5311 "Function to be called when `C-c C-c' is used.
5312 This is for getting out of special buffers like capture.")
5315 ;; FIXME: Occasionally check by commenting these, to make sure
5316 ;; no other functions uses these, forgetting to let-bind them.
5317 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5318 (defvar org-last-state)
5319 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5321 ;; Defined somewhere in this file, but used before definition.
5322 (defvar org-entities) ;; defined in org-entities.el
5323 (defvar org-struct-menu)
5324 (defvar org-org-menu)
5325 (defvar org-tbl-menu)
5327 ;;;; Define the Org-mode
5329 ;; We use a before-change function to check if a table might need
5330 ;; an update.
5331 (defvar org-table-may-need-update t
5332 "Indicates that a table might need an update.
5333 This variable is set by `org-before-change-function'.
5334 `org-table-align' sets it back to nil.")
5335 (defun org-before-change-function (beg end)
5336 "Every change indicates that a table might need an update."
5337 (setq org-table-may-need-update t))
5338 (defvar org-mode-map)
5339 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5340 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5341 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5342 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5343 (defvar org-table-buffer-is-an nil)
5345 (defvar bidi-paragraph-direction)
5346 (defvar buffer-face-mode-face)
5348 (require 'outline)
5349 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5350 (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"))
5351 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5353 ;; Other stuff we need.
5354 (require 'time-date)
5355 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5356 (require 'easymenu)
5357 (require 'overlay)
5359 ;; (require 'org-macs) moved higher up in the file before it is first used
5360 (require 'org-entities)
5361 ;; (require 'org-compat) moved higher up in the file before it is first used
5362 (require 'org-faces)
5363 (require 'org-list)
5364 (require 'org-pcomplete)
5365 (require 'org-src)
5366 (require 'org-footnote)
5367 (require 'org-macro)
5369 ;; babel
5370 (require 'ob)
5372 ;;;###autoload
5373 (define-derived-mode org-mode outline-mode "Org"
5374 "Outline-based notes management and organizer, alias
5375 \"Carsten's outline-mode for keeping track of everything.\"
5377 Org-mode develops organizational tasks around a NOTES file which
5378 contains information about projects as plain text. Org-mode is
5379 implemented on top of outline-mode, which is ideal to keep the content
5380 of large files well structured. It supports ToDo items, deadlines and
5381 time stamps, which magically appear in the diary listing of the Emacs
5382 calendar. Tables are easily created with a built-in table editor.
5383 Plain text URL-like links connect to websites, emails (VM), Usenet
5384 messages (Gnus), BBDB entries, and any files related to the project.
5385 For printing and sharing of notes, an Org-mode file (or a part of it)
5386 can be exported as a structured ASCII or HTML file.
5388 The following commands are available:
5390 \\{org-mode-map}"
5392 ;; Get rid of Outline menus, they are not needed
5393 ;; Need to do this here because define-derived-mode sets up
5394 ;; the keymap so late. Still, it is a waste to call this each time
5395 ;; we switch another buffer into org-mode.
5396 (if (featurep 'xemacs)
5397 (when (boundp 'outline-mode-menu-heading)
5398 ;; Assume this is Greg's port, it uses easymenu
5399 (easy-menu-remove outline-mode-menu-heading)
5400 (easy-menu-remove outline-mode-menu-show)
5401 (easy-menu-remove outline-mode-menu-hide))
5402 (define-key org-mode-map [menu-bar headings] 'undefined)
5403 (define-key org-mode-map [menu-bar hide] 'undefined)
5404 (define-key org-mode-map [menu-bar show] 'undefined))
5406 (org-load-modules-maybe)
5407 (easy-menu-add org-org-menu)
5408 (easy-menu-add org-tbl-menu)
5409 (org-install-agenda-files-menu)
5410 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5411 (add-to-invisibility-spec '(org-cwidth))
5412 (add-to-invisibility-spec '(org-hide-block . t))
5413 (when (featurep 'xemacs)
5414 (org-set-local 'line-move-ignore-invisible t))
5415 (org-set-local 'outline-regexp org-outline-regexp)
5416 (org-set-local 'outline-level 'org-outline-level)
5417 (setq bidi-paragraph-direction 'left-to-right)
5418 (when (and org-ellipsis
5419 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5420 (fboundp 'make-glyph-code))
5421 (unless org-display-table
5422 (setq org-display-table (make-display-table)))
5423 (set-display-table-slot
5424 org-display-table 4
5425 (vconcat (mapcar
5426 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5427 org-ellipsis)))
5428 (if (stringp org-ellipsis) org-ellipsis "..."))))
5429 (setq buffer-display-table org-display-table))
5430 (org-set-regexps-and-options)
5431 (org-set-font-lock-defaults)
5432 (when (and org-tag-faces (not org-tags-special-faces-re))
5433 ;; tag faces set outside customize.... force initialization.
5434 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5435 ;; Calc embedded
5436 (org-set-local 'calc-embedded-open-mode "# ")
5437 ;; Modify a few syntax entries
5438 (modify-syntax-entry ?@ "w")
5439 (modify-syntax-entry ?\" "\"")
5440 (modify-syntax-entry ?\\ "_")
5441 (modify-syntax-entry ?~ "_")
5442 (if org-startup-truncated (setq truncate-lines t))
5443 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5444 (org-set-local 'font-lock-unfontify-region-function
5445 'org-unfontify-region)
5446 ;; Activate before-change-function
5447 (org-set-local 'org-table-may-need-update t)
5448 (org-add-hook 'before-change-functions 'org-before-change-function nil
5449 'local)
5450 ;; Check for running clock before killing a buffer
5451 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5452 ;; Initialize macros templates.
5453 (org-macro-initialize-templates)
5454 ;; Initialize radio targets.
5455 (org-update-radio-target-regexp)
5456 ;; Indentation.
5457 (org-set-local 'indent-line-function 'org-indent-line)
5458 (org-set-local 'indent-region-function 'org-indent-region)
5459 ;; Filling and auto-filling.
5460 (org-setup-filling)
5461 ;; Comments.
5462 (org-setup-comments-handling)
5463 ;; Initialize cache.
5464 (org-element-cache-reset)
5465 ;; Beginning/end of defun
5466 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5467 (org-set-local 'end-of-defun-function
5468 (lambda ()
5469 (if (not (org-at-heading-p))
5470 (org-forward-element)
5471 (org-forward-element)
5472 (forward-char -1))))
5473 ;; Next error for sparse trees
5474 (org-set-local 'next-error-function 'org-occur-next-match)
5475 ;; Make sure dependence stuff works reliably, even for users who set it
5476 ;; too late :-(
5477 (if org-enforce-todo-dependencies
5478 (add-hook 'org-blocker-hook
5479 'org-block-todo-from-children-or-siblings-or-parent)
5480 (remove-hook 'org-blocker-hook
5481 'org-block-todo-from-children-or-siblings-or-parent))
5482 (if org-enforce-todo-checkbox-dependencies
5483 (add-hook 'org-blocker-hook
5484 'org-block-todo-from-checkboxes)
5485 (remove-hook 'org-blocker-hook
5486 'org-block-todo-from-checkboxes))
5488 ;; Align options lines
5489 (org-set-local
5490 'align-mode-rules-list
5491 '((org-in-buffer-settings
5492 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5493 (modes . '(org-mode)))))
5495 ;; Imenu
5496 (org-set-local 'imenu-create-index-function
5497 'org-imenu-get-tree)
5499 ;; Make isearch reveal context
5500 (if (or (featurep 'xemacs)
5501 (not (boundp 'outline-isearch-open-invisible-function)))
5502 ;; Emacs 21 and XEmacs make use of the hook
5503 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5504 ;; Emacs 22 deals with this through a special variable
5505 (org-set-local 'outline-isearch-open-invisible-function
5506 (lambda (&rest ignore) (org-show-context 'isearch))))
5508 ;; Setup the pcomplete hooks
5509 (set (make-local-variable 'pcomplete-command-completion-function)
5510 'org-pcomplete-initial)
5511 (set (make-local-variable 'pcomplete-command-name-function)
5512 'org-command-at-point)
5513 (set (make-local-variable 'pcomplete-default-completion-function)
5514 'ignore)
5515 (set (make-local-variable 'pcomplete-parse-arguments-function)
5516 'org-parse-arguments)
5517 (set (make-local-variable 'pcomplete-termination-string) "")
5518 (when (>= emacs-major-version 23)
5519 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5521 ;; If empty file that did not turn on org-mode automatically, make it to.
5522 (if (and org-insert-mode-line-in-empty-file
5523 (org-called-interactively-p 'any)
5524 (= (point-min) (point-max)))
5525 (insert "# -*- mode: org -*-\n\n"))
5526 (unless org-inhibit-startup
5527 (org-unmodified
5528 (and org-startup-with-beamer-mode (org-beamer-mode))
5529 (when org-startup-align-all-tables
5530 (org-table-map-tables 'org-table-align 'quietly))
5531 (when org-startup-with-inline-images
5532 (org-display-inline-images))
5533 (when org-startup-with-latex-preview
5534 (org-toggle-latex-fragment))
5535 (unless org-inhibit-startup-visibility-stuff
5536 (org-set-startup-visibility))
5537 (org-refresh-effort-properties)))
5538 ;; Try to set org-hide correctly
5539 (let ((foreground (org-find-invisible-foreground)))
5540 (if foreground
5541 (set-face-foreground 'org-hide foreground))))
5543 ;; Update `customize-package-emacs-version-alist'
5544 (add-to-list 'customize-package-emacs-version-alist
5545 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5546 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5547 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5549 (defvar org-mode-transpose-word-syntax-table
5550 (let ((st (make-syntax-table text-mode-syntax-table)))
5551 (mapc (lambda(c) (modify-syntax-entry
5552 (string-to-char (car c)) "w p" st))
5553 org-emphasis-alist)
5554 st))
5556 (when (fboundp 'abbrev-table-put)
5557 (abbrev-table-put org-mode-abbrev-table
5558 :parents (list text-mode-abbrev-table)))
5560 (defun org-find-invisible-foreground ()
5561 (let ((candidates (remove
5562 "unspecified-bg"
5563 (nconc
5564 (list (face-background 'default)
5565 (face-background 'org-default))
5566 (mapcar
5567 (lambda (alist)
5568 (when (boundp alist)
5569 (cdr (assoc 'background-color (symbol-value alist)))))
5570 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5571 (list (face-foreground 'org-hide))))))
5572 (car (remove nil candidates))))
5574 (defun org-current-time (&optional rounding-minutes past)
5575 "Current time, possibly rounded to ROUNDING-MINUTES.
5576 When ROUNDING-MINUTES is not an integer, fall back on the car of
5577 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5578 the rounding returns a past time."
5579 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5580 (car org-time-stamp-rounding-minutes)))
5581 (time (decode-time)) res)
5582 (if (< r 1)
5583 (current-time)
5584 (setq res
5585 (apply 'encode-time
5586 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5587 (nthcdr 2 time))))
5588 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5589 (seconds-to-time (- (org-float-time res) (* r 60)))
5590 res))))
5592 (defun org-today ()
5593 "Return today date, considering `org-extend-today-until'."
5594 (time-to-days
5595 (time-subtract (current-time)
5596 (list 0 (* 3600 org-extend-today-until) 0))))
5598 ;;;; Font-Lock stuff, including the activators
5600 (defvar org-mouse-map (make-sparse-keymap))
5601 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5602 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5603 (when org-mouse-1-follows-link
5604 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5605 (when org-tab-follows-link
5606 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5607 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5609 (require 'font-lock)
5611 (defconst org-non-link-chars "]\t\n\r<>")
5612 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5613 "file+sys" "news" "shell" "elisp" "doi" "message"
5614 "help"))
5615 (defvar org-link-types-re nil
5616 "Matches a link that has a url-like prefix like \"http:\"")
5617 (defvar org-link-re-with-space nil
5618 "Matches a link with spaces, optional angular brackets around it.")
5619 (defvar org-link-re-with-space2 nil
5620 "Matches a link with spaces, optional angular brackets around it.")
5621 (defvar org-link-re-with-space3 nil
5622 "Matches a link with spaces, only for internal part in bracket links.")
5623 (defvar org-angle-link-re nil
5624 "Matches link with angular brackets, spaces are allowed.")
5625 (defvar org-plain-link-re nil
5626 "Matches plain link, without spaces.")
5627 (defvar org-bracket-link-regexp nil
5628 "Matches a link in double brackets.")
5629 (defvar org-bracket-link-analytic-regexp nil
5630 "Regular expression used to analyze links.
5631 Here is what the match groups contain after a match:
5632 1: http:
5633 2: http
5634 3: path
5635 4: [desc]
5636 5: desc")
5637 (defvar org-bracket-link-analytic-regexp++ nil
5638 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5639 (defvar org-any-link-re nil
5640 "Regular expression matching any link.")
5642 (defconst org-match-sexp-depth 3
5643 "Number of stacked braces for sub/superscript matching.")
5645 (defun org-create-multibrace-regexp (left right n)
5646 "Create a regular expression which will match a balanced sexp.
5647 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5648 as single character strings.
5649 The regexp returned will match the entire expression including the
5650 delimiters. It will also define a single group which contains the
5651 match except for the outermost delimiters. The maximum depth of
5652 stacked delimiters is N. Escaping delimiters is not possible."
5653 (let* ((nothing (concat "[^" left right "]*?"))
5654 (or "\\|")
5655 (re nothing)
5656 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5657 (while (> n 1)
5658 (setq n (1- n)
5659 re (concat re or next)
5660 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5661 (concat left "\\(" re "\\)" right)))
5663 (defconst org-match-substring-regexp
5664 (concat
5665 "\\(\\S-\\)\\([_^]\\)\\("
5666 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5667 "\\|"
5668 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5669 "\\|"
5670 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5671 "The regular expression matching a sub- or superscript.")
5673 (defconst org-match-substring-with-braces-regexp
5674 (concat
5675 "\\(\\S-\\)\\([_^]\\)"
5676 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5677 "The regular expression matching a sub- or superscript, forcing braces.")
5679 (defun org-make-link-regexps ()
5680 "Update the link regular expressions.
5681 This should be called after the variable `org-link-types' has changed."
5682 (let ((types-re (regexp-opt org-link-types t)))
5683 (setq org-link-types-re
5684 (concat "\\`" types-re ":")
5685 org-link-re-with-space
5686 (concat "<?" types-re ":"
5687 "\\([^" org-non-link-chars " ]"
5688 "[^" org-non-link-chars "]*"
5689 "[^" org-non-link-chars " ]\\)>?")
5690 org-link-re-with-space2
5691 (concat "<?" types-re ":"
5692 "\\([^" org-non-link-chars " ]"
5693 "[^\t\n\r]*"
5694 "[^" org-non-link-chars " ]\\)>?")
5695 org-link-re-with-space3
5696 (concat "<?" types-re ":"
5697 "\\([^" org-non-link-chars " ]"
5698 "[^\t\n\r]*\\)")
5699 org-angle-link-re
5700 (concat "<" types-re ":"
5701 "\\([^" org-non-link-chars " ]"
5702 "[^" org-non-link-chars "]*"
5703 "\\)>")
5704 org-plain-link-re
5705 (concat
5706 "\\<" types-re ":"
5707 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5708 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5709 org-bracket-link-regexp
5710 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5711 org-bracket-link-analytic-regexp
5712 (concat
5713 "\\[\\["
5714 "\\(" types-re ":\\)?"
5715 "\\([^]]+\\)"
5716 "\\]"
5717 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5718 "\\]")
5719 org-bracket-link-analytic-regexp++
5720 (concat
5721 "\\[\\["
5722 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5723 "\\([^]]+\\)"
5724 "\\]"
5725 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5726 "\\]")
5727 org-any-link-re
5728 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5729 org-angle-link-re "\\)\\|\\("
5730 org-plain-link-re "\\)"))))
5732 (org-make-link-regexps)
5734 (defvar org-emph-face nil)
5736 (defun org-do-emphasis-faces (limit)
5737 "Run through the buffer and emphasize strings."
5738 (let (rtn a)
5739 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5740 (let* ((border (char-after (match-beginning 3)))
5741 (bre (regexp-quote (char-to-string border))))
5742 (if (and (not (= border (char-after (match-beginning 4))))
5743 (not (save-match-data
5744 (string-match (concat bre ".*" bre)
5745 (replace-regexp-in-string
5746 "\n" " "
5747 (substring (match-string 2) 1 -1))))))
5748 (progn
5749 (setq rtn t)
5750 (setq a (assoc (match-string 3) org-emphasis-alist))
5751 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5752 'face
5753 (nth 1 a))
5754 (and (nth 2 a)
5755 (org-remove-flyspell-overlays-in
5756 (match-beginning 0) (match-end 0)))
5757 (add-text-properties (match-beginning 2) (match-end 2)
5758 '(font-lock-multiline t org-emphasis t))
5759 (when org-hide-emphasis-markers
5760 (add-text-properties (match-end 4) (match-beginning 5)
5761 '(invisible org-link))
5762 (add-text-properties (match-beginning 3) (match-end 3)
5763 '(invisible org-link))))))
5764 (goto-char (1+ (match-beginning 0))))
5765 rtn))
5767 (defun org-emphasize (&optional char)
5768 "Insert or change an emphasis, i.e. a font like bold or italic.
5769 If there is an active region, change that region to a new emphasis.
5770 If there is no region, just insert the marker characters and position
5771 the cursor between them.
5772 CHAR should be the marker character. If it is a space, it means to
5773 remove the emphasis of the selected region.
5774 If CHAR is not given (for example in an interactive call) it will be
5775 prompted for."
5776 (interactive)
5777 (let ((erc org-emphasis-regexp-components)
5778 (prompt "")
5779 (string "") beg end move c s)
5780 (if (org-region-active-p)
5781 (setq beg (region-beginning) end (region-end)
5782 string (buffer-substring beg end))
5783 (setq move t))
5785 (unless char
5786 (message "Emphasis marker or tag: [%s]"
5787 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5788 (setq char (read-char-exclusive)))
5789 (if (equal char ?\ )
5790 (setq s "" move nil)
5791 (unless (assoc (char-to-string char) org-emphasis-alist)
5792 (user-error "No such emphasis marker: \"%c\"" char))
5793 (setq s (char-to-string char)))
5794 (while (and (> (length string) 1)
5795 (equal (substring string 0 1) (substring string -1))
5796 (assoc (substring string 0 1) org-emphasis-alist))
5797 (setq string (substring string 1 -1)))
5798 (setq string (concat s string s))
5799 (if beg (delete-region beg end))
5800 (unless (or (bolp)
5801 (string-match (concat "[" (nth 0 erc) "\n]")
5802 (char-to-string (char-before (point)))))
5803 (insert " "))
5804 (unless (or (eobp)
5805 (string-match (concat "[" (nth 1 erc) "\n]")
5806 (char-to-string (char-after (point)))))
5807 (insert " ") (backward-char 1))
5808 (insert string)
5809 (and move (backward-char 1))))
5811 (defconst org-nonsticky-props
5812 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5814 (defsubst org-rear-nonsticky-at (pos)
5815 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5817 (defun org-activate-plain-links (limit)
5818 "Add link properties for plain links."
5819 (let (f hl)
5820 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5821 (not (member 'org-tag
5822 (get-text-property (1- (match-beginning 0)) 'face)))
5823 (not (org-in-src-block-p)))
5824 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5825 (setq f (get-text-property (match-beginning 0) 'face))
5826 (setq hl (org-match-string-no-properties 0))
5827 (if (or (eq f 'org-tag)
5828 (and (listp f) (memq 'org-tag f)))
5830 (add-text-properties (match-beginning 0) (match-end 0)
5831 (list 'mouse-face 'highlight
5832 'face 'org-link
5833 'htmlize-link `(:uri ,hl)
5834 'keymap org-mouse-map))
5835 (org-rear-nonsticky-at (match-end 0)))
5836 t)))
5838 (defun org-activate-code (limit)
5839 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5840 (progn
5841 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5842 (remove-text-properties (match-beginning 0) (match-end 0)
5843 '(display t invisible t intangible t))
5844 t)))
5846 (defcustom org-src-fontify-natively t
5847 "When non-nil, fontify code in code blocks."
5848 :type 'boolean
5849 :version "24.4"
5850 :package-version '(Org . "8.3")
5851 :group 'org-appearance
5852 :group 'org-babel)
5854 (defcustom org-allow-promoting-top-level-subtree nil
5855 "When non-nil, allow promoting a top level subtree.
5856 The leading star of the top level headline will be replaced
5857 by a #."
5858 :type 'boolean
5859 :version "24.1"
5860 :group 'org-appearance)
5862 (defun org-fontify-meta-lines-and-blocks (limit)
5863 (condition-case nil
5864 (org-fontify-meta-lines-and-blocks-1 limit)
5865 (error (message "org-mode fontification error"))))
5867 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5868 "Fontify #+ lines and blocks."
5869 (let ((case-fold-search t))
5870 (if (re-search-forward
5871 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5872 limit t)
5873 (let ((beg (match-beginning 0))
5874 (block-start (match-end 0))
5875 (block-end nil)
5876 (lang (match-string 7))
5877 (beg1 (line-beginning-position 2))
5878 (dc1 (downcase (match-string 2)))
5879 (dc3 (downcase (match-string 3)))
5880 end end1 quoting block-type ovl)
5881 (cond
5882 ((member dc1 '("+html:" "+ascii:" "+latex:"))
5883 ;; a single line of backend-specific content
5884 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5885 (remove-text-properties (match-beginning 0) (match-end 0)
5886 '(display t invisible t intangible t))
5887 (add-text-properties (match-beginning 1) (match-end 3)
5888 '(font-lock-fontified t face org-meta-line))
5889 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5890 '(font-lock-fontified t face org-block))
5891 ; for backend-specific code
5893 ((and (match-end 4) (equal dc3 "+begin"))
5894 ;; Truly a block
5895 (setq block-type (downcase (match-string 5))
5896 quoting (member block-type org-protecting-blocks))
5897 (when (re-search-forward
5898 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5899 nil t) ;; on purpose, we look further than LIMIT
5900 (setq end (min (point-max) (match-end 0))
5901 end1 (min (point-max) (1- (match-beginning 0))))
5902 (setq block-end (match-beginning 0))
5903 (when quoting
5904 (org-remove-flyspell-overlays-in beg1 end1)
5905 (remove-text-properties beg end
5906 '(display t invisible t intangible t)))
5907 (add-text-properties
5908 beg end '(font-lock-fontified t font-lock-multiline t))
5909 (add-text-properties beg beg1 '(face org-meta-line))
5910 (org-remove-flyspell-overlays-in beg beg1)
5911 (add-text-properties ; For end_src
5912 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5913 (org-remove-flyspell-overlays-in end1 end)
5914 (cond
5915 ((and lang (not (string= lang "")) org-src-fontify-natively)
5916 (org-src-font-lock-fontify-block lang block-start block-end)
5917 (add-text-properties beg1 block-end '(src-block t)))
5918 (quoting
5919 (add-text-properties beg1 (min (point-max) (1+ end1))
5920 '(face org-block))) ; end of source block
5921 ((not org-fontify-quote-and-verse-blocks))
5922 ((string= block-type "quote")
5923 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5924 ((string= block-type "verse")
5925 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5926 (add-text-properties beg beg1 '(face org-block-begin-line))
5927 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5928 '(face org-block-end-line))
5930 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5931 (org-remove-flyspell-overlays-in
5932 (match-beginning 0)
5933 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5934 (add-text-properties
5935 beg (match-end 3)
5936 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5937 '(font-lock-fontified t invisible t)
5938 '(font-lock-fontified t face org-document-info-keyword)))
5939 (add-text-properties
5940 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5941 (if (string-equal dc1 "+title:")
5942 '(font-lock-fontified t face org-document-title)
5943 '(font-lock-fontified t face org-document-info))))
5944 ((or (equal dc1 "+results")
5945 (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
5946 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5947 "+call:" "+header:" "+headers:" "+name:"))
5948 (and (match-end 4) (equal dc3 "+attr")))
5949 (org-remove-flyspell-overlays-in
5950 (match-beginning 0)
5951 (if (equal "+caption:" dc1) (match-end 2) (match-end 0)))
5952 (add-text-properties
5953 beg (match-end 0)
5954 '(font-lock-fontified t face org-meta-line))
5956 ((member dc3 '(" " ""))
5957 (org-remove-flyspell-overlays-in beg (match-end 0))
5958 (add-text-properties
5959 beg (match-end 0)
5960 '(font-lock-fontified t face font-lock-comment-face)))
5961 (t ;; just any other in-buffer setting, but not indented
5962 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5963 (add-text-properties
5964 beg (match-end 0)
5965 '(font-lock-fontified t face org-meta-line))
5966 t))))))
5968 (defun org-fontify-drawers (limit)
5969 "Fontify drawers."
5970 (when (re-search-forward org-drawer-regexp limit t)
5971 (add-text-properties
5972 (match-beginning 0) (match-end 0)
5973 '(font-lock-fontified t face org-special-keyword))
5974 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5977 (defun org-fontify-macros (limit)
5978 "Fontify macros."
5979 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5980 (add-text-properties
5981 (match-beginning 0) (match-end 0)
5982 '(font-lock-fontified t face org-macro))
5983 (when org-hide-macro-markers
5984 (add-text-properties (match-end 2) (match-beginning 2)
5985 '(invisible t))
5986 (add-text-properties (match-beginning 1) (match-end 1)
5987 '(invisible t)))
5988 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5991 (defun org-activate-angle-links (limit)
5992 "Add text properties for angle links."
5993 (if (and (re-search-forward org-angle-link-re limit t)
5994 (not (org-in-src-block-p)))
5995 (progn
5996 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5997 (add-text-properties (match-beginning 0) (match-end 0)
5998 (list 'mouse-face 'highlight
5999 'keymap org-mouse-map))
6000 (org-rear-nonsticky-at (match-end 0))
6001 t)))
6003 (defun org-activate-footnote-links (limit)
6004 "Add text properties for footnotes."
6005 (let ((fn (org-footnote-next-reference-or-definition limit)))
6006 (when fn
6007 (let* ((beg (nth 1 fn))
6008 (end (nth 2 fn))
6009 (label (car fn))
6010 (referencep (/= (line-beginning-position) beg)))
6011 (when (and referencep (nth 3 fn))
6012 (save-excursion
6013 (goto-char beg)
6014 (search-forward (or label "fn:"))
6015 (org-remove-flyspell-overlays-in beg (match-end 0))))
6016 (add-text-properties beg end
6017 (list 'mouse-face 'highlight
6018 'keymap org-mouse-map
6019 'help-echo
6020 (if referencep "Footnote reference"
6021 "Footnote definition")
6022 'font-lock-fontified t
6023 'font-lock-multiline t
6024 'face 'org-footnote))))))
6026 (defun org-activate-bracket-links (limit)
6027 "Add text properties for bracketed links."
6028 (if (and (re-search-forward org-bracket-link-regexp limit t)
6029 (not (org-in-src-block-p)))
6030 (let* ((hl (org-match-string-no-properties 1))
6031 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6032 (ip (org-maybe-intangible
6033 (list 'invisible 'org-link
6034 'keymap org-mouse-map 'mouse-face 'highlight
6035 'font-lock-multiline t 'help-echo help
6036 'htmlize-link `(:uri ,hl))))
6037 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6038 'font-lock-multiline t 'help-echo help
6039 'htmlize-link `(:uri ,hl))))
6040 ;; We need to remove the invisible property here. Table narrowing
6041 ;; may have made some of this invisible.
6042 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6043 (remove-text-properties (match-beginning 0) (match-end 0)
6044 '(invisible nil))
6045 (if (match-end 3)
6046 (progn
6047 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6048 (org-rear-nonsticky-at (match-beginning 3))
6049 (add-text-properties (match-beginning 3) (match-end 3) vp)
6050 (org-rear-nonsticky-at (match-end 3))
6051 (add-text-properties (match-end 3) (match-end 0) ip)
6052 (org-rear-nonsticky-at (match-end 0)))
6053 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6054 (org-rear-nonsticky-at (match-beginning 1))
6055 (add-text-properties (match-beginning 1) (match-end 1) vp)
6056 (org-rear-nonsticky-at (match-end 1))
6057 (add-text-properties (match-end 1) (match-end 0) ip)
6058 (org-rear-nonsticky-at (match-end 0)))
6059 t)))
6061 (defun org-activate-dates (limit)
6062 "Add text properties for dates."
6063 (if (and (re-search-forward org-tsr-regexp-both limit t)
6064 (not (equal (char-before (match-beginning 0)) 91)))
6065 (progn
6066 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6067 (add-text-properties (match-beginning 0) (match-end 0)
6068 (list 'mouse-face 'highlight
6069 'keymap org-mouse-map))
6070 (org-rear-nonsticky-at (match-end 0))
6071 (when org-display-custom-times
6072 (if (match-end 3)
6073 (org-display-custom-time (match-beginning 3) (match-end 3)))
6074 (org-display-custom-time (match-beginning 1) (match-end 1)))
6075 t)))
6077 (defvar org-target-link-regexp nil
6078 "Regular expression matching radio targets in plain text.")
6079 (make-variable-buffer-local 'org-target-link-regexp)
6081 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6082 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6083 border border border))
6084 "Regular expression matching a link target.")
6086 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6087 "Regular expression matching a radio target.")
6089 (defconst org-any-target-regexp
6090 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6091 "Regular expression matching any target.")
6093 (defun org-activate-target-links (limit)
6094 "Add text properties for target matches."
6095 (when org-target-link-regexp
6096 (let ((case-fold-search t))
6097 (if (re-search-forward org-target-link-regexp limit t)
6098 (progn
6099 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6100 (add-text-properties (match-beginning 1) (match-end 1)
6101 (list 'mouse-face 'highlight
6102 'keymap org-mouse-map
6103 'help-echo "Radio target link"
6104 'org-linked-text t))
6105 (org-rear-nonsticky-at (match-end 1))
6106 t)))))
6108 (defun org-update-radio-target-regexp ()
6109 "Find all radio targets in this file and update the regular expression.
6110 Also refresh fontification if needed."
6111 (interactive)
6112 (let ((old-regexp org-target-link-regexp)
6113 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6114 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6115 (targets
6116 (org-with-wide-buffer
6117 (goto-char (point-min))
6118 (let (rtn)
6119 (while (re-search-forward org-radio-target-regexp nil t)
6120 ;; Make sure point is really within the object.
6121 (backward-char)
6122 (let ((obj (org-element-context)))
6123 (when (eq (org-element-type obj) 'radio-target)
6124 (add-to-list 'rtn (org-element-property :value obj)))))
6125 rtn))))
6126 (setq org-target-link-regexp
6127 (and targets
6128 (concat before-re
6129 (mapconcat
6130 (lambda (x)
6131 (replace-regexp-in-string
6132 " +" "\\s-+" (regexp-quote x) t t))
6133 targets
6134 "\\|")
6135 after-re)))
6136 (unless (equal old-regexp org-target-link-regexp)
6137 ;; Clean-up cache.
6138 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6139 ((not org-target-link-regexp) old-regexp)
6141 (concat before-re
6142 (mapconcat
6143 (lambda (re)
6144 (substring re (length before-re)
6145 (- (length after-re))))
6146 (list old-regexp org-target-link-regexp)
6147 "\\|")
6148 after-re)))))
6149 (org-with-wide-buffer
6150 (goto-char (point-min))
6151 (while (re-search-forward regexp nil t)
6152 (org-element-cache-refresh (match-beginning 1)))))
6153 ;; Re fontify buffer.
6154 (when (memq 'radio org-highlight-links)
6155 (org-restart-font-lock)))))
6157 (defun org-hide-wide-columns (limit)
6158 (let (s e)
6159 (setq s (text-property-any (point) (or limit (point-max))
6160 'org-cwidth t))
6161 (when s
6162 (setq e (next-single-property-change s 'org-cwidth))
6163 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6164 (goto-char e)
6165 t)))
6167 (defvar org-latex-and-related-regexp nil
6168 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6170 (defun org-compute-latex-and-related-regexp ()
6171 "Compute regular expression for LaTeX, entities and sub/superscript.
6172 Result depends on variable `org-highlight-latex-and-related'."
6173 (org-set-local
6174 'org-latex-and-related-regexp
6175 (let* ((re-sub
6176 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6177 ((eq org-use-sub-superscripts '{})
6178 (list org-match-substring-with-braces-regexp))
6179 (org-use-sub-superscripts (list org-match-substring-regexp))))
6180 (re-latex
6181 (when (memq 'latex org-highlight-latex-and-related)
6182 (let ((matchers (plist-get org-format-latex-options :matchers)))
6183 (delq nil
6184 (mapcar (lambda (x)
6185 (and (member (car x) matchers) (nth 1 x)))
6186 org-latex-regexps)))))
6187 (re-entities
6188 (when (memq 'entities org-highlight-latex-and-related)
6189 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6190 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6192 (defun org-do-latex-and-related (limit)
6193 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6194 LIMIT bounds the search for syntax to highlight. Stop at first
6195 highlighted object, if any. Return t if some highlighting was
6196 done, nil otherwise."
6197 (when (org-string-nw-p org-latex-and-related-regexp)
6198 (catch 'found
6199 (while (re-search-forward org-latex-and-related-regexp limit t)
6200 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6201 'face))
6202 '(org-code org-verbatim underline))
6203 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6204 '(?_ ?^))
6206 0)))
6207 (font-lock-prepend-text-property
6208 (+ offset (match-beginning 0)) (match-end 0)
6209 'face 'org-latex-and-related)
6210 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6211 '(font-lock-multiline t)))
6212 (throw 'found t)))
6213 nil)))
6215 (defun org-restart-font-lock ()
6216 "Restart `font-lock-mode', to force refontification."
6217 (when (and (boundp 'font-lock-mode) font-lock-mode)
6218 (font-lock-mode -1)
6219 (font-lock-mode 1)))
6221 (defun org-activate-tags (limit)
6222 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6223 (progn
6224 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6225 (add-text-properties (match-beginning 1) (match-end 1)
6226 (list 'mouse-face 'highlight
6227 'keymap org-mouse-map))
6228 (org-rear-nonsticky-at (match-end 1))
6229 t)))
6231 (defun org-outline-level ()
6232 "Compute the outline level of the heading at point.
6233 If this is called at a normal headline, the level is the number of stars.
6234 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6235 (save-excursion
6236 (if (not (ignore-errors (org-back-to-heading t)))
6238 (looking-at org-outline-regexp)
6239 (1- (- (match-end 0) (match-beginning 0))))))
6241 (defvar org-font-lock-keywords nil)
6243 (defsubst org-re-property (property &optional literal allow-null)
6244 "Return a regexp matching a PROPERTY line.
6246 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6247 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6248 non-nil, match properties even without a value.
6250 Match group 3 is set to the value when it exists. If there is no
6251 value and ALLOW-NULL is non-nil, it is set to the empty string."
6252 (concat
6253 "^\\(?4:[ \t]*\\)"
6254 (format "\\(?1::\\(?2:%s\\):\\)"
6255 (if literal property (regexp-quote property)))
6256 (if allow-null
6257 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$"
6258 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$")))
6260 (defconst org-property-re
6261 (org-re-property "\\S-+" 'literal t)
6262 "Regular expression matching a property line.
6263 There are four matching groups:
6264 1: :PROPKEY: including the leading and trailing colon,
6265 2: PROPKEY without the leading and trailing colon,
6266 3: PROPVAL without leading or trailing spaces,
6267 4: the indentation of the current line,
6268 5: trailing whitespace.")
6270 (defvar org-font-lock-hook nil
6271 "Functions to be called for special font lock stuff.")
6273 (defvar org-font-lock-set-keywords-hook nil
6274 "Functions that can manipulate `org-font-lock-extra-keywords'.
6275 This is called after `org-font-lock-extra-keywords' is defined, but before
6276 it is installed to be used by font lock. This can be useful if something
6277 needs to be inserted at a specific position in the font-lock sequence.")
6279 (defun org-font-lock-hook (limit)
6280 "Run `org-font-lock-hook' within LIMIT."
6281 (run-hook-with-args 'org-font-lock-hook limit))
6283 (defun org-set-font-lock-defaults ()
6284 "Set font lock defaults for the current buffer."
6285 (let* ((em org-fontify-emphasized-text)
6286 (lk org-highlight-links)
6287 (org-font-lock-extra-keywords
6288 (list
6289 ;; Call the hook
6290 '(org-font-lock-hook)
6291 ;; Headlines
6292 `(,(if org-fontify-whole-heading-line
6293 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6294 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6295 (1 (org-get-level-face 1))
6296 (2 (org-get-level-face 2))
6297 (3 (org-get-level-face 3)))
6298 ;; Table lines
6299 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6300 (1 'org-table t))
6301 ;; Table internals
6302 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6303 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6304 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6305 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6306 ;; Drawers
6307 '(org-fontify-drawers)
6308 ;; Properties
6309 (list org-property-re
6310 '(1 'org-special-keyword t)
6311 '(3 'org-property-value t))
6312 ;; Links
6313 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6314 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6315 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6316 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6317 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6318 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6319 (if (memq 'footnote lk) '(org-activate-footnote-links))
6320 ;; Targets.
6321 (list org-any-target-regexp '(0 'org-target t))
6322 ;; Diary sexps.
6323 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6324 ;; Macro
6325 '(org-fontify-macros)
6326 '(org-hide-wide-columns (0 nil append))
6327 ;; TODO keyword
6328 (list (format org-heading-keyword-regexp-format
6329 org-todo-regexp)
6330 '(2 (org-get-todo-face 2) t))
6331 ;; DONE
6332 (if org-fontify-done-headline
6333 (list (format org-heading-keyword-regexp-format
6334 (concat
6335 "\\(?:"
6336 (mapconcat 'regexp-quote org-done-keywords "\\|")
6337 "\\)"))
6338 '(2 'org-headline-done t))
6339 nil)
6340 ;; Priorities
6341 '(org-font-lock-add-priority-faces)
6342 ;; Tags
6343 '(org-font-lock-add-tag-faces)
6344 ;; Tags groups
6345 (if (and org-group-tags org-tag-groups-alist)
6346 (list (concat org-outline-regexp-bol ".+\\(:"
6347 (regexp-opt (mapcar 'car org-tag-groups-alist))
6348 ":\\).*$")
6349 '(1 'org-tag-group prepend)))
6350 ;; Special keywords
6351 (list (concat "\\<" org-comment-string) '(0 'org-special-keyword t))
6352 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6353 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6354 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6355 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6356 ;; Emphasis
6357 (if em
6358 (if (featurep 'xemacs)
6359 '(org-do-emphasis-faces (0 nil append))
6360 '(org-do-emphasis-faces)))
6361 ;; Checkboxes
6362 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6363 1 'org-checkbox prepend)
6364 (if (cdr (assq 'checkbox org-list-automatic-rules))
6365 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6366 (0 (org-get-checkbox-statistics-face) t)))
6367 ;; Description list items
6368 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6369 1 'org-list-dt prepend)
6370 ;; ARCHIVEd headings
6371 (list (concat
6372 org-outline-regexp-bol
6373 "\\(.*:" org-archive-tag ":.*\\)")
6374 '(1 'org-archived prepend))
6375 ;; Specials
6376 '(org-do-latex-and-related)
6377 '(org-fontify-entities)
6378 '(org-raise-scripts)
6379 ;; Code
6380 '(org-activate-code (1 'org-code t))
6381 ;; COMMENT
6382 (list (format
6383 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6384 org-todo-regexp
6385 org-comment-string)
6386 '(9 'org-special-keyword t))
6387 ;; Blocks and meta lines
6388 '(org-fontify-meta-lines-and-blocks))))
6389 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6390 (run-hooks 'org-font-lock-set-keywords-hook)
6391 ;; Now set the full font-lock-keywords
6392 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6393 (org-set-local 'font-lock-defaults
6394 '(org-font-lock-keywords t nil nil backward-paragraph))
6395 (kill-local-variable 'font-lock-keywords) nil))
6397 (defun org-toggle-pretty-entities ()
6398 "Toggle the composition display of entities as UTF8 characters."
6399 (interactive)
6400 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6401 (org-restart-font-lock)
6402 (if org-pretty-entities
6403 (message "Entities are now displayed as UTF8 characters")
6404 (save-restriction
6405 (widen)
6406 (org-decompose-region (point-min) (point-max))
6407 (message "Entities are now displayed as plain text"))))
6409 (defvar org-custom-properties-overlays nil
6410 "List of overlays used for custom properties.")
6411 (make-variable-buffer-local 'org-custom-properties-overlays)
6413 (defun org-toggle-custom-properties-visibility ()
6414 "Display or hide properties in `org-custom-properties'."
6415 (interactive)
6416 (if org-custom-properties-overlays
6417 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6418 (setq org-custom-properties-overlays nil))
6419 (when org-custom-properties
6420 (org-with-wide-buffer
6421 (goto-char (point-min))
6422 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6423 (while (re-search-forward regexp nil t)
6424 (let ((end (cdr (save-match-data (org-get-property-block)))))
6425 (when (and end (< (point) end))
6426 ;; Hide first custom property in current drawer.
6427 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6428 (overlay-put o 'invisible t)
6429 (overlay-put o 'org-custom-property t)
6430 (push o org-custom-properties-overlays))
6431 ;; Hide additional custom properties in the same drawer.
6432 (while (re-search-forward regexp end t)
6433 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6434 (overlay-put o 'invisible t)
6435 (overlay-put o 'org-custom-property t)
6436 (push o org-custom-properties-overlays)))))
6437 ;; Each entry is limited to a single property drawer.
6438 (outline-next-heading)))))))
6440 (defun org-fontify-entities (limit)
6441 "Find an entity to fontify."
6442 (let (ee)
6443 (when org-pretty-entities
6444 (catch 'match
6445 (while (re-search-forward
6446 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6447 limit t)
6448 (if (and (not (org-at-comment-p))
6449 (setq ee (org-entity-get (match-string 1)))
6450 (= (length (nth 6 ee)) 1))
6451 (let*
6452 ((end (if (equal (match-string 2) "{}")
6453 (match-end 2)
6454 (match-end 1))))
6455 (add-text-properties
6456 (match-beginning 0) end
6457 (list 'font-lock-fontified t))
6458 (compose-region (match-beginning 0) end
6459 (nth 6 ee) nil)
6460 (backward-char 1)
6461 (throw 'match t))))
6462 nil))))
6464 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6465 "Fontify string S like in Org-mode."
6466 (with-temp-buffer
6467 (insert s)
6468 (let ((org-odd-levels-only odd-levels))
6469 (org-mode)
6470 (font-lock-ensure)
6471 (buffer-string))))
6473 (defvar org-m nil)
6474 (defvar org-l nil)
6475 (defvar org-f nil)
6476 (defun org-get-level-face (n)
6477 "Get the right face for match N in font-lock matching of headlines."
6478 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6479 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6480 (if org-cycle-level-faces
6481 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6482 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6483 (cond
6484 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6485 ((eq n 2) org-f)
6486 (t (if org-level-color-stars-only nil org-f))))
6489 (defun org-get-todo-face (kwd)
6490 "Get the right face for a TODO keyword KWD.
6491 If KWD is a number, get the corresponding match group."
6492 (if (numberp kwd) (setq kwd (match-string kwd)))
6493 (or (org-face-from-face-or-color
6494 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6495 (and (member kwd org-done-keywords) 'org-done)
6496 'org-todo))
6498 (defun org-face-from-face-or-color (context inherit face-or-color)
6499 "Create a face list that inherits INHERIT, but sets the foreground color.
6500 When FACE-OR-COLOR is not a string, just return it."
6501 (if (stringp face-or-color)
6502 (list :inherit inherit
6503 (cdr (assoc context org-faces-easy-properties))
6504 face-or-color)
6505 face-or-color))
6507 (defun org-font-lock-add-tag-faces (limit)
6508 "Add the special tag faces."
6509 (when (and org-tag-faces org-tags-special-faces-re)
6510 (while (re-search-forward org-tags-special-faces-re limit t)
6511 (add-text-properties (match-beginning 1) (match-end 1)
6512 (list 'face (org-get-tag-face 1)
6513 'font-lock-fontified t))
6514 (backward-char 1))))
6516 (defun org-font-lock-add-priority-faces (limit)
6517 "Add the special priority faces."
6518 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6519 (when (save-match-data (org-at-heading-p))
6520 (add-text-properties
6521 (match-beginning 0) (match-end 0)
6522 (list 'face (or (org-face-from-face-or-color
6523 'priority 'org-priority
6524 (cdr (assoc (char-after (match-beginning 1))
6525 org-priority-faces)))
6526 'org-priority)
6527 'font-lock-fontified t)))))
6529 (defun org-get-tag-face (kwd)
6530 "Get the right face for a TODO keyword KWD.
6531 If KWD is a number, get the corresponding match group."
6532 (if (numberp kwd) (setq kwd (match-string kwd)))
6533 (or (org-face-from-face-or-color
6534 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6535 'org-tag))
6537 (defun org-unfontify-region (beg end &optional maybe_loudly)
6538 "Remove fontification and activation overlays from links."
6539 (font-lock-default-unfontify-region beg end)
6540 (let* ((buffer-undo-list t)
6541 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6542 (inhibit-modification-hooks t)
6543 deactivate-mark buffer-file-name buffer-file-truename)
6544 (org-decompose-region beg end)
6545 (remove-text-properties beg end
6546 '(mouse-face t keymap t org-linked-text t
6547 invisible t intangible t
6548 org-emphasis t))
6549 (org-remove-font-lock-display-properties beg end)))
6551 (defconst org-script-display '(((raise -0.3) (height 0.7))
6552 ((raise 0.3) (height 0.7))
6553 ((raise -0.5))
6554 ((raise 0.5)))
6555 "Display properties for showing superscripts and subscripts.")
6557 (defun org-remove-font-lock-display-properties (beg end)
6558 "Remove specific display properties that have been added by font lock.
6559 The will remove the raise properties that are used to show superscripts
6560 and subscripts."
6561 (let (next prop)
6562 (while (< beg end)
6563 (setq next (next-single-property-change beg 'display nil end)
6564 prop (get-text-property beg 'display))
6565 (if (member prop org-script-display)
6566 (put-text-property beg next 'display nil))
6567 (setq beg next))))
6569 (defun org-raise-scripts (limit)
6570 "Add raise properties to sub/superscripts."
6571 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6572 (if (re-search-forward
6573 (if (eq org-use-sub-superscripts t)
6574 org-match-substring-regexp
6575 org-match-substring-with-braces-regexp)
6576 limit t)
6577 (let* ((pos (point)) table-p comment-p
6578 (mpos (match-beginning 3))
6579 (emph-p (get-text-property mpos 'org-emphasis))
6580 (link-p (get-text-property mpos 'mouse-face))
6581 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6582 (goto-char (point-at-bol))
6583 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6584 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6585 (goto-char pos)
6586 ;; Handle a_b^c
6587 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6588 (if (or comment-p emph-p link-p keyw-p)
6590 (put-text-property (match-beginning 3) (match-end 0)
6591 'display
6592 (if (equal (char-after (match-beginning 2)) ?^)
6593 (nth (if table-p 3 1) org-script-display)
6594 (nth (if table-p 2 0) org-script-display)))
6595 (add-text-properties (match-beginning 2) (match-end 2)
6596 (list 'invisible t
6597 'org-dwidth t 'org-dwidth-n 1))
6598 (if (and (eq (char-after (match-beginning 3)) ?{)
6599 (eq (char-before (match-end 3)) ?}))
6600 (progn
6601 (add-text-properties
6602 (match-beginning 3) (1+ (match-beginning 3))
6603 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6604 (add-text-properties
6605 (1- (match-end 3)) (match-end 3)
6606 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6607 t)))))
6609 ;;;; Visibility cycling, including org-goto and indirect buffer
6611 ;;; Cycling
6613 (defvar org-cycle-global-status nil)
6614 (make-variable-buffer-local 'org-cycle-global-status)
6615 (put 'org-cycle-global-status 'org-state t)
6616 (defvar org-cycle-subtree-status nil)
6617 (make-variable-buffer-local 'org-cycle-subtree-status)
6618 (put 'org-cycle-subtree-status 'org-state t)
6620 (defvar org-inlinetask-min-level)
6622 (defun org-unlogged-message (&rest args)
6623 "Display a message, but avoid logging it in the *Messages* buffer."
6624 (let ((message-log-max nil))
6625 (apply 'message args)))
6627 ;;;###autoload
6628 (defun org-cycle (&optional arg)
6629 "TAB-action and visibility cycling for Org-mode.
6631 This is the command invoked in Org-mode by the TAB key. Its main purpose
6632 is outline visibility cycling, but it also invokes other actions
6633 in special contexts.
6635 - When this function is called with a prefix argument, rotate the entire
6636 buffer through 3 states (global cycling)
6637 1. OVERVIEW: Show only top-level headlines.
6638 2. CONTENTS: Show all headlines of all levels, but no body text.
6639 3. SHOW ALL: Show everything.
6640 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6641 determined by the variable `org-startup-folded', and by any VISIBILITY
6642 properties in the buffer.
6643 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6644 including any drawers.
6646 - When inside a table, re-align the table and move to the next field.
6648 - When point is at the beginning of a headline, rotate the subtree started
6649 by this line through 3 different states (local cycling)
6650 1. FOLDED: Only the main headline is shown.
6651 2. CHILDREN: The main headline and the direct children are shown.
6652 From this state, you can move to one of the children
6653 and zoom in further.
6654 3. SUBTREE: Show the entire subtree, including body text.
6655 If there is no subtree, switch directly from CHILDREN to FOLDED.
6657 - When point is at the beginning of an empty headline and the variable
6658 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6659 of the headline by demoting and promoting it to likely levels. This
6660 speeds up creation document structure by pressing TAB once or several
6661 times right after creating a new headline.
6663 - When there is a numeric prefix, go up to a heading with level ARG, do
6664 a `show-subtree' and return to the previous cursor position. If ARG
6665 is negative, go up that many levels.
6667 - When point is not at the beginning of a headline, execute the global
6668 binding for TAB, which is re-indenting the line. See the option
6669 `org-cycle-emulate-tab' for details.
6671 - Special case: if point is at the beginning of the buffer and there is
6672 no headline in line 1, this function will act as if called with prefix arg
6673 (C-u TAB, same as S-TAB) also when called without prefix arg.
6674 But only if also the variable `org-cycle-global-at-bob' is t."
6675 (interactive "P")
6676 (org-load-modules-maybe)
6677 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6678 (and org-cycle-level-after-item/entry-creation
6679 (or (org-cycle-level)
6680 (org-cycle-item-indentation))))
6681 (let* ((limit-level
6682 (or org-cycle-max-level
6683 (and (boundp 'org-inlinetask-min-level)
6684 org-inlinetask-min-level
6685 (1- org-inlinetask-min-level))))
6686 (nstars (and limit-level
6687 (if org-odd-levels-only
6688 (and limit-level (1- (* limit-level 2)))
6689 limit-level)))
6690 (org-outline-regexp
6691 (if (not (derived-mode-p 'org-mode))
6692 outline-regexp
6693 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6694 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6695 (not (looking-at org-outline-regexp))))
6696 (org-cycle-hook
6697 (if bob-special
6698 (delq 'org-optimize-window-after-visibility-change
6699 (copy-sequence org-cycle-hook))
6700 org-cycle-hook))
6701 (pos (point)))
6703 (if (or bob-special (equal arg '(4)))
6704 ;; special case: use global cycling
6705 (setq arg t))
6707 (cond
6709 ((equal arg '(16))
6710 (setq last-command 'dummy)
6711 (org-set-startup-visibility)
6712 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6714 ((equal arg '(64))
6715 (show-all)
6716 (org-unlogged-message "Entire buffer visible, including drawers"))
6718 ;; Try cdlatex TAB completion
6719 ((org-try-cdlatex-tab))
6721 ;; Table: enter it or move to the next field.
6722 ((org-at-table-p 'any)
6723 (if (org-at-table.el-p)
6724 (message "Use C-c ' to edit table.el tables")
6725 (if arg (org-table-edit-field t)
6726 (org-table-justify-field-maybe)
6727 (call-interactively 'org-table-next-field))))
6729 ((run-hook-with-args-until-success
6730 'org-tab-after-check-for-table-hook))
6732 ;; Global cycling: delegate to `org-cycle-internal-global'.
6733 ((eq arg t) (org-cycle-internal-global))
6735 ;; Drawers: delegate to `org-flag-drawer'.
6736 ((save-excursion
6737 (beginning-of-line 1)
6738 (looking-at org-drawer-regexp))
6739 (org-flag-drawer ; toggle block visibility
6740 (not (get-char-property (match-end 0) 'invisible))))
6742 ;; Show-subtree, ARG levels up from here.
6743 ((integerp arg)
6744 (save-excursion
6745 (org-back-to-heading)
6746 (outline-up-heading (if (< arg 0) (- arg)
6747 (- (funcall outline-level) arg)))
6748 (org-show-subtree)))
6750 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6751 ((and (featurep 'org-inlinetask)
6752 (org-inlinetask-at-task-p)
6753 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6754 (org-inlinetask-toggle-visibility))
6756 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6757 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6758 (save-excursion (beginning-of-line 1)
6759 (looking-at org-outline-regexp)))
6760 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6761 (org-cycle-internal-local))
6763 ;; From there: TAB emulation and template completion.
6764 (buffer-read-only (org-back-to-heading))
6766 ((run-hook-with-args-until-success
6767 'org-tab-after-check-for-cycling-hook))
6769 ((org-try-structure-completion))
6771 ((run-hook-with-args-until-success
6772 'org-tab-before-tab-emulation-hook))
6774 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6775 (or (not (bolp))
6776 (not (looking-at org-outline-regexp))))
6777 (call-interactively (global-key-binding "\t")))
6779 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6780 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6781 (or (and (eq org-cycle-emulate-tab 'white)
6782 (= (match-end 0) (point-at-eol)))
6783 (and (eq org-cycle-emulate-tab 'whitestart)
6784 (>= (match-end 0) pos))))
6786 (eq org-cycle-emulate-tab t))
6787 (call-interactively (global-key-binding "\t")))
6789 (t (save-excursion
6790 (org-back-to-heading)
6791 (org-cycle)))))))
6793 (defun org-cycle-internal-global ()
6794 "Do the global cycling action."
6795 ;; Hack to avoid display of messages for .org attachments in Gnus
6796 (let ((ga (string-match "\\*fontification" (buffer-name))))
6797 (cond
6798 ((and (eq last-command this-command)
6799 (eq org-cycle-global-status 'overview))
6800 ;; We just created the overview - now do table of contents
6801 ;; This can be slow in very large buffers, so indicate action
6802 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6803 (unless ga (org-unlogged-message "CONTENTS..."))
6804 (org-content)
6805 (unless ga (org-unlogged-message "CONTENTS...done"))
6806 (setq org-cycle-global-status 'contents)
6807 (run-hook-with-args 'org-cycle-hook 'contents))
6809 ((and (eq last-command this-command)
6810 (eq org-cycle-global-status 'contents))
6811 ;; We just showed the table of contents - now show everything
6812 (run-hook-with-args 'org-pre-cycle-hook 'all)
6813 (show-all)
6814 (unless ga (org-unlogged-message "SHOW ALL"))
6815 (setq org-cycle-global-status 'all)
6816 (run-hook-with-args 'org-cycle-hook 'all))
6819 ;; Default action: go to overview
6820 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6821 (org-overview)
6822 (unless ga (org-unlogged-message "OVERVIEW"))
6823 (setq org-cycle-global-status 'overview)
6824 (run-hook-with-args 'org-cycle-hook 'overview)))))
6826 (defvar org-called-with-limited-levels nil
6827 "Non-nil when `org-with-limited-levels' is currently active.")
6829 (defun org-cycle-internal-local ()
6830 "Do the local cycling action."
6831 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6832 ;; First, determine end of headline (EOH), end of subtree or item
6833 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6834 (save-excursion
6835 (if (org-at-item-p)
6836 (progn
6837 (beginning-of-line)
6838 (setq struct (org-list-struct))
6839 (setq eoh (point-at-eol))
6840 (setq eos (org-list-get-item-end-before-blank (point) struct))
6841 (setq has-children (org-list-has-child-p (point) struct)))
6842 (org-back-to-heading)
6843 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6844 (setq eos (save-excursion (org-end-of-subtree t t)
6845 (when (bolp) (backward-char)) (point)))
6846 (setq has-children
6847 (or (save-excursion
6848 (let ((level (funcall outline-level)))
6849 (outline-next-heading)
6850 (and (org-at-heading-p t)
6851 (> (funcall outline-level) level))))
6852 (save-excursion
6853 (org-list-search-forward (org-item-beginning-re) eos t)))))
6854 ;; Determine end invisible part of buffer (EOL)
6855 (beginning-of-line 2)
6856 ;; XEmacs doesn't have `next-single-char-property-change'
6857 (if (featurep 'xemacs)
6858 (while (and (not (eobp)) ;; this is like `next-line'
6859 (get-char-property (1- (point)) 'invisible))
6860 (beginning-of-line 2))
6861 (while (and (not (eobp)) ;; this is like `next-line'
6862 (get-char-property (1- (point)) 'invisible))
6863 (goto-char (next-single-char-property-change (point) 'invisible))
6864 (and (eolp) (beginning-of-line 2))))
6865 (setq eol (point)))
6866 ;; Find out what to do next and set `this-command'
6867 (cond
6868 ((= eos eoh)
6869 ;; Nothing is hidden behind this heading
6870 (unless (org-before-first-heading-p)
6871 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6872 (org-unlogged-message "EMPTY ENTRY")
6873 (setq org-cycle-subtree-status nil)
6874 (save-excursion
6875 (goto-char eos)
6876 (outline-next-heading)
6877 (if (outline-invisible-p) (org-flag-heading nil))))
6878 ((and (or (>= eol eos)
6879 (not (string-match "\\S-" (buffer-substring eol eos))))
6880 (or has-children
6881 (not (setq children-skipped
6882 org-cycle-skip-children-state-if-no-children))))
6883 ;; Entire subtree is hidden in one line: children view
6884 (unless (org-before-first-heading-p)
6885 (run-hook-with-args 'org-pre-cycle-hook 'children))
6886 (if (org-at-item-p)
6887 (org-list-set-item-visibility (point-at-bol) struct 'children)
6888 (org-show-entry)
6889 (org-with-limited-levels (show-children))
6890 ;; FIXME: This slows down the func way too much.
6891 ;; How keep drawers hidden in subtree anyway?
6892 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6893 ;; (org-cycle-hide-drawers 'subtree))
6895 ;; Fold every list in subtree to top-level items.
6896 (when (eq org-cycle-include-plain-lists 'integrate)
6897 (save-excursion
6898 (org-back-to-heading)
6899 (while (org-list-search-forward (org-item-beginning-re) eos t)
6900 (beginning-of-line 1)
6901 (let* ((struct (org-list-struct))
6902 (prevs (org-list-prevs-alist struct))
6903 (end (org-list-get-bottom-point struct)))
6904 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6905 (org-list-get-all-items (point) struct prevs))
6906 (goto-char (if (< end eos) end eos)))))))
6907 (org-unlogged-message "CHILDREN")
6908 (save-excursion
6909 (goto-char eos)
6910 (outline-next-heading)
6911 (if (outline-invisible-p) (org-flag-heading nil)))
6912 (setq org-cycle-subtree-status 'children)
6913 (unless (org-before-first-heading-p)
6914 (run-hook-with-args 'org-cycle-hook 'children)))
6915 ((or children-skipped
6916 (and (eq last-command this-command)
6917 (eq org-cycle-subtree-status 'children)))
6918 ;; We just showed the children, or no children are there,
6919 ;; now show everything.
6920 (unless (org-before-first-heading-p)
6921 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6922 (outline-flag-region eoh eos nil)
6923 (org-unlogged-message
6924 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6925 (setq org-cycle-subtree-status 'subtree)
6926 (unless (org-before-first-heading-p)
6927 (run-hook-with-args 'org-cycle-hook 'subtree)))
6929 ;; Default action: hide the subtree.
6930 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6931 (outline-flag-region eoh eos t)
6932 (org-unlogged-message "FOLDED")
6933 (setq org-cycle-subtree-status 'folded)
6934 (unless (org-before-first-heading-p)
6935 (run-hook-with-args 'org-cycle-hook 'folded))))))
6937 ;;;###autoload
6938 (defun org-global-cycle (&optional arg)
6939 "Cycle the global visibility. For details see `org-cycle'.
6940 With \\[universal-argument] prefix arg, switch to startup visibility.
6941 With a numeric prefix, show all headlines up to that level."
6942 (interactive "P")
6943 (let ((org-cycle-include-plain-lists
6944 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6945 (cond
6946 ((integerp arg)
6947 (show-all)
6948 (hide-sublevels arg)
6949 (setq org-cycle-global-status 'contents))
6950 ((equal arg '(4))
6951 (org-set-startup-visibility)
6952 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6954 (org-cycle '(4))))))
6956 (defun org-set-startup-visibility ()
6957 "Set the visibility required by startup options and properties."
6958 (cond
6959 ((eq org-startup-folded t)
6960 (org-overview))
6961 ((eq org-startup-folded 'content)
6962 (org-content))
6963 ((or (eq org-startup-folded 'showeverything)
6964 (eq org-startup-folded nil))
6965 (show-all)))
6966 (unless (eq org-startup-folded 'showeverything)
6967 (if org-hide-block-startup (org-hide-block-all))
6968 (org-set-visibility-according-to-property 'no-cleanup)
6969 (org-cycle-hide-archived-subtrees 'all)
6970 (org-cycle-hide-drawers 'all)
6971 (org-cycle-show-empty-lines t)))
6973 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6974 "Switch subtree visibilities according to :VISIBILITY: property."
6975 (interactive)
6976 (let (org-show-entry-below state)
6977 (save-excursion
6978 (goto-char (point-min))
6979 (while (re-search-forward
6980 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6981 nil t)
6982 (setq state (match-string 1))
6983 (save-excursion
6984 (org-back-to-heading t)
6985 (hide-subtree)
6986 (org-reveal)
6987 (cond
6988 ((equal state '("fold" "folded"))
6989 (hide-subtree))
6990 ((equal state "children")
6991 (org-show-hidden-entry)
6992 (show-children))
6993 ((equal state "content")
6994 (save-excursion
6995 (save-restriction
6996 (org-narrow-to-subtree)
6997 (org-content))))
6998 ((member state '("all" "showall"))
6999 (show-subtree)))))
7000 (unless no-cleanup
7001 (org-cycle-hide-archived-subtrees 'all)
7002 (org-cycle-hide-drawers 'all)
7003 (org-cycle-show-empty-lines 'all)))))
7005 ;; This function uses outline-regexp instead of the more fundamental
7006 ;; org-outline-regexp so that org-cycle-global works outside of Org
7007 ;; buffers, where outline-regexp is needed.
7008 (defun org-overview ()
7009 "Switch to overview mode, showing only top-level headlines.
7010 This shows all headlines with a level equal or greater than the level
7011 of the first headline in the buffer. This is important, because if the
7012 first headline is not level one, then (hide-sublevels 1) gives confusing
7013 results."
7014 (interactive)
7015 (save-excursion
7016 (let ((level
7017 (save-excursion
7018 (goto-char (point-min))
7019 (if (re-search-forward (concat "^" outline-regexp) nil t)
7020 (progn
7021 (goto-char (match-beginning 0))
7022 (funcall outline-level))))))
7023 (and level (hide-sublevels level)))))
7025 (defun org-content (&optional arg)
7026 "Show all headlines in the buffer, like a table of contents.
7027 With numerical argument N, show content up to level N."
7028 (interactive "P")
7029 (org-overview)
7030 (save-excursion
7031 ;; Visit all headings and show their offspring
7032 (and (integerp arg) (org-overview))
7033 (goto-char (point-max))
7034 (catch 'exit
7035 (while (and (progn (condition-case nil
7036 (outline-previous-visible-heading 1)
7037 (error (goto-char (point-min))))
7039 (looking-at org-outline-regexp))
7040 (if (integerp arg)
7041 (show-children (1- arg))
7042 (show-branches))
7043 (if (bobp) (throw 'exit nil))))))
7045 (defun org-optimize-window-after-visibility-change (state)
7046 "Adjust the window after a change in outline visibility.
7047 This function is the default value of the hook `org-cycle-hook'."
7048 (when (get-buffer-window (current-buffer))
7049 (cond
7050 ((eq state 'content) nil)
7051 ((eq state 'all) nil)
7052 ((eq state 'folded) nil)
7053 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7054 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7056 (defun org-remove-empty-overlays-at (pos)
7057 "Remove outline overlays that do not contain non-white stuff."
7058 (mapc
7059 (lambda (o)
7060 (and (eq 'outline (overlay-get o 'invisible))
7061 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7062 (overlay-end o))))
7063 (delete-overlay o)))
7064 (overlays-at pos)))
7066 (defun org-clean-visibility-after-subtree-move ()
7067 "Fix visibility issues after moving a subtree."
7068 ;; First, find a reasonable region to look at:
7069 ;; Start two siblings above, end three below
7070 (let* ((beg (save-excursion
7071 (and (org-get-last-sibling)
7072 (org-get-last-sibling))
7073 (point)))
7074 (end (save-excursion
7075 (and (org-get-next-sibling)
7076 (org-get-next-sibling)
7077 (org-get-next-sibling))
7078 (if (org-at-heading-p)
7079 (point-at-eol)
7080 (point))))
7081 (level (looking-at "\\*+"))
7082 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7083 (save-excursion
7084 (save-restriction
7085 (narrow-to-region beg end)
7086 (when re
7087 ;; Properly fold already folded siblings
7088 (goto-char (point-min))
7089 (while (re-search-forward re nil t)
7090 (if (and (not (outline-invisible-p))
7091 (save-excursion
7092 (goto-char (point-at-eol)) (outline-invisible-p)))
7093 (hide-entry))))
7094 (org-cycle-show-empty-lines 'overview)
7095 (org-cycle-hide-drawers 'overview)))))
7097 (defun org-cycle-show-empty-lines (state)
7098 "Show empty lines above all visible headlines.
7099 The region to be covered depends on STATE when called through
7100 `org-cycle-hook'. Lisp program can use t for STATE to get the
7101 entire buffer covered. Note that an empty line is only shown if there
7102 are at least `org-cycle-separator-lines' empty lines before the headline."
7103 (when (not (= org-cycle-separator-lines 0))
7104 (save-excursion
7105 (let* ((n (abs org-cycle-separator-lines))
7106 (re (cond
7107 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7108 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7109 (t (let ((ns (number-to-string (- n 2))))
7110 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7111 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7112 beg end b e)
7113 (cond
7114 ((memq state '(overview contents t))
7115 (setq beg (point-min) end (point-max)))
7116 ((memq state '(children folded))
7117 (setq beg (point) end (progn (org-end-of-subtree t t)
7118 (beginning-of-line 2)
7119 (point)))))
7120 (when beg
7121 (goto-char beg)
7122 (while (re-search-forward re end t)
7123 (unless (get-char-property (match-end 1) 'invisible)
7124 (setq e (match-end 1))
7125 (if (< org-cycle-separator-lines 0)
7126 (setq b (save-excursion
7127 (goto-char (match-beginning 0))
7128 (org-back-over-empty-lines)
7129 (if (save-excursion
7130 (goto-char (max (point-min) (1- (point))))
7131 (org-at-heading-p))
7132 (1- (point))
7133 (point))))
7134 (setq b (match-beginning 1)))
7135 (outline-flag-region b e nil)))))))
7136 ;; Never hide empty lines at the end of the file.
7137 (save-excursion
7138 (goto-char (point-max))
7139 (outline-previous-heading)
7140 (outline-end-of-heading)
7141 (if (and (looking-at "[ \t\n]+")
7142 (= (match-end 0) (point-max)))
7143 (outline-flag-region (point) (match-end 0) nil))))
7145 (defun org-show-empty-lines-in-parent ()
7146 "Move to the parent and re-show empty lines before visible headlines."
7147 (save-excursion
7148 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7149 (org-cycle-show-empty-lines context))))
7151 (defun org-files-list ()
7152 "Return `org-agenda-files' list, plus all open org-mode files.
7153 This is useful for operations that need to scan all of a user's
7154 open and agenda-wise Org files."
7155 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7156 (dolist (buf (buffer-list))
7157 (with-current-buffer buf
7158 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7159 (let ((file (expand-file-name (buffer-file-name))))
7160 (unless (member file files)
7161 (push file files))))))
7162 files))
7164 (defsubst org-entry-beginning-position ()
7165 "Return the beginning position of the current entry."
7166 (save-excursion (outline-back-to-heading t) (point)))
7168 (defsubst org-entry-end-position ()
7169 "Return the end position of the current entry."
7170 (save-excursion (outline-next-heading) (point)))
7172 (defun org-cycle-hide-drawers (state &optional exceptions)
7173 "Re-hide all drawers after a visibility state change.
7174 When non-nil, optional argument EXCEPTIONS is a list of strings
7175 specifying which drawers should not be hidden."
7176 (when (and (derived-mode-p 'org-mode)
7177 (not (memq state '(overview folded contents))))
7178 (save-excursion
7179 (let* ((globalp (memq state '(contents all)))
7180 (beg (if globalp (point-min) (point)))
7181 (end (if globalp (point-max)
7182 (if (eq state 'children)
7183 (save-excursion (outline-next-heading) (point))
7184 (org-end-of-subtree t)))))
7185 (goto-char beg)
7186 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7187 (unless (member-ignore-case (match-string 1) exceptions)
7188 (let ((drawer (org-element-at-point)))
7189 (when (memq (org-element-type drawer) '(drawer property-drawer))
7190 (org-flag-drawer t drawer)
7191 ;; Make sure to skip drawer entirely or we might flag
7192 ;; it another time when matching its ending line with
7193 ;; `org-drawer-regexp'.
7194 (goto-char (org-element-property :end drawer))))))))))
7196 (defun org-cycle-hide-inline-tasks (state)
7197 "Re-hide inline tasks when switching to 'contents or 'children
7198 visibility state."
7199 (case state
7200 (contents
7201 (when (org-bound-and-true-p org-inlinetask-min-level)
7202 (hide-sublevels (1- org-inlinetask-min-level))))
7203 (children
7204 (when (featurep 'org-inlinetask)
7205 (save-excursion
7206 (while (and (outline-next-heading)
7207 (org-inlinetask-at-task-p))
7208 (org-inlinetask-toggle-visibility)
7209 (org-inlinetask-goto-end)))))))
7211 (defun org-flag-drawer (flag &optional element)
7212 "When FLAG is non-nil, hide the drawer we are at.
7213 Otherwise make it visible. When optional argument ELEMENT is
7214 a parsed drawer, as returned by `org-element-at-point', hide or
7215 show that drawer instead."
7216 (when (save-excursion
7217 (beginning-of-line)
7218 (org-looking-at-p org-drawer-regexp))
7219 (let ((drawer (or element (org-element-at-point))))
7220 (when (memq (org-element-type drawer) '(drawer property-drawer))
7221 (let ((post (org-element-property :post-affiliated drawer)))
7222 (save-excursion
7223 (outline-flag-region
7224 (progn (goto-char post) (line-end-position))
7225 (progn (goto-char (org-element-property :end drawer))
7226 (skip-chars-backward " \r\t\n")
7227 (line-end-position))
7228 flag))
7229 ;; When the drawer is hidden away, make sure point lies in
7230 ;; a visible part of the buffer.
7231 (when (and flag (> (line-beginning-position) post))
7232 (goto-char post)))))))
7234 (defun org-subtree-end-visible-p ()
7235 "Is the end of the current subtree visible?"
7236 (pos-visible-in-window-p
7237 (save-excursion (org-end-of-subtree t) (point))))
7239 (defun org-first-headline-recenter ()
7240 "Move cursor to the first headline and recenter the headline."
7241 (goto-char (point-min))
7242 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7243 (set-window-start (selected-window) (point-at-bol))))
7245 ;;; Saving and restoring visibility
7247 (defun org-outline-overlay-data (&optional use-markers)
7248 "Return a list of the locations of all outline overlays.
7249 These are overlays with the `invisible' property value `outline'.
7250 The return value is a list of cons cells, with start and stop
7251 positions for each overlay.
7252 If USE-MARKERS is set, return the positions as markers."
7253 (let (beg end)
7254 (save-excursion
7255 (save-restriction
7256 (widen)
7257 (delq nil
7258 (mapcar (lambda (o)
7259 (when (eq (overlay-get o 'invisible) 'outline)
7260 (setq beg (overlay-start o)
7261 end (overlay-end o))
7262 (and beg end (> end beg)
7263 (if use-markers
7264 (cons (copy-marker beg)
7265 (copy-marker end t))
7266 (cons beg end)))))
7267 (overlays-in (point-min) (point-max))))))))
7269 (defun org-set-outline-overlay-data (data)
7270 "Create visibility overlays for all positions in DATA.
7271 DATA should have been made by `org-outline-overlay-data'."
7272 (let (o)
7273 (save-excursion
7274 (save-restriction
7275 (widen)
7276 (show-all)
7277 (mapc (lambda (c)
7278 (outline-flag-region (car c) (cdr c) t))
7279 data)))))
7281 ;;; Folding of blocks
7283 (defvar org-hide-block-overlays nil
7284 "Overlays hiding blocks.")
7285 (make-variable-buffer-local 'org-hide-block-overlays)
7287 (defun org-block-map (function &optional start end)
7288 "Call FUNCTION at the head of all source blocks in the current buffer.
7289 Optional arguments START and END can be used to limit the range."
7290 (let ((start (or start (point-min)))
7291 (end (or end (point-max))))
7292 (save-excursion
7293 (goto-char start)
7294 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7295 (save-excursion
7296 (save-match-data
7297 (goto-char (match-beginning 0))
7298 (funcall function)))))))
7300 (defun org-hide-block-toggle-all ()
7301 "Toggle the visibility of all blocks in the current buffer."
7302 (org-block-map 'org-hide-block-toggle))
7304 (defun org-hide-block-all ()
7305 "Fold all blocks in the current buffer."
7306 (interactive)
7307 (org-show-block-all)
7308 (org-block-map 'org-hide-block-toggle-maybe))
7310 (defun org-show-block-all ()
7311 "Unfold all blocks in the current buffer."
7312 (interactive)
7313 (mapc 'delete-overlay org-hide-block-overlays)
7314 (setq org-hide-block-overlays nil))
7316 (defun org-hide-block-toggle-maybe ()
7317 "Toggle visibility of block at point.
7318 Unlike to `org-hide-block-toggle', this function does not throw
7319 an error. Return a non-nil value when toggling is successful."
7320 (interactive)
7321 (ignore-errors (org-hide-block-toggle)))
7323 (defun org-hide-block-toggle (&optional force)
7324 "Toggle the visibility of the current block.
7325 When optional argument FORCE is `off', make block visible. If it
7326 is non-nil, hide it unconditionally. Throw an error when not at
7327 a block. Return a non-nil value when toggling is successful."
7328 (interactive)
7329 (let ((element (org-element-at-point)))
7330 (unless (memq (org-element-type element)
7331 '(center-block comment-block dynamic-block example-block
7332 export-block quote-block special-block
7333 src-block verse-block))
7334 (user-error "Not at a block"))
7335 (let* ((start (save-excursion
7336 (goto-char (org-element-property :post-affiliated element))
7337 (line-end-position)))
7338 (end (save-excursion
7339 (goto-char (org-element-property :end element))
7340 (skip-chars-backward " \r\t\n")
7341 (line-end-position)))
7342 (overlays (overlays-at start)))
7343 (cond
7344 ;; Do nothing when not before or at the block opening line or
7345 ;; at the block closing line.
7346 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7347 ((and (not (eq force 'off))
7348 (not (memq t (mapcar
7349 (lambda (o)
7350 (eq (overlay-get o 'invisible) 'org-hide-block))
7351 overlays))))
7352 (let ((ov (make-overlay start end)))
7353 (overlay-put ov 'invisible 'org-hide-block)
7354 ;; Make the block accessible to `isearch'.
7355 (overlay-put
7356 ov 'isearch-open-invisible
7357 (lambda (ov)
7358 (when (memq ov org-hide-block-overlays)
7359 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7360 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7361 (delete-overlay ov))))
7362 (push ov org-hide-block-overlays)
7363 ;; When the block is hidden away, make sure point is left in
7364 ;; a visible part of the buffer.
7365 (when (> (line-beginning-position) start)
7366 (goto-char start)
7367 (beginning-of-line))
7368 ;; Signal successful toggling.
7370 ((or (not force) (eq force 'off))
7371 (dolist (ov overlays t)
7372 (when (memq ov org-hide-block-overlays)
7373 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7374 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7375 (delete-overlay ov))))))))
7377 ;; org-tab-after-check-for-cycling-hook
7378 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7379 ;; Remove overlays when changing major mode
7380 (add-hook 'org-mode-hook
7381 (lambda () (org-add-hook 'change-major-mode-hook
7382 'org-show-block-all 'append 'local)))
7384 ;;; Org-goto
7386 (defvar org-goto-window-configuration nil)
7387 (defvar org-goto-marker nil)
7388 (defvar org-goto-map)
7389 (defun org-goto-map ()
7390 "Set the keymap `org-goto'."
7391 (setq org-goto-map
7392 (let ((map (make-sparse-keymap)))
7393 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7394 mouse-drag-region universal-argument org-occur))
7395 cmd)
7396 (while (setq cmd (pop cmds))
7397 (substitute-key-definition cmd cmd map global-map)))
7398 (suppress-keymap map)
7399 (org-defkey map "\C-m" 'org-goto-ret)
7400 (org-defkey map [(return)] 'org-goto-ret)
7401 (org-defkey map [(left)] 'org-goto-left)
7402 (org-defkey map [(right)] 'org-goto-right)
7403 (org-defkey map [(control ?g)] 'org-goto-quit)
7404 (org-defkey map "\C-i" 'org-cycle)
7405 (org-defkey map [(tab)] 'org-cycle)
7406 (org-defkey map [(down)] 'outline-next-visible-heading)
7407 (org-defkey map [(up)] 'outline-previous-visible-heading)
7408 (if org-goto-auto-isearch
7409 (if (fboundp 'define-key-after)
7410 (define-key-after map [t] 'org-goto-local-auto-isearch)
7411 nil)
7412 (org-defkey map "q" 'org-goto-quit)
7413 (org-defkey map "n" 'outline-next-visible-heading)
7414 (org-defkey map "p" 'outline-previous-visible-heading)
7415 (org-defkey map "f" 'outline-forward-same-level)
7416 (org-defkey map "b" 'outline-backward-same-level)
7417 (org-defkey map "u" 'outline-up-heading))
7418 (org-defkey map "/" 'org-occur)
7419 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7420 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7421 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7422 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7423 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7424 map)))
7426 (defconst org-goto-help
7427 "Browse buffer copy, to find location or copy text.%s
7428 RET=jump to location C-g=quit and return to previous location
7429 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7431 (defvar org-goto-start-pos) ; dynamically scoped parameter
7433 (defun org-goto (&optional alternative-interface)
7434 "Look up a different location in the current file, keeping current visibility.
7436 When you want look-up or go to a different location in a
7437 document, the fastest way is often to fold the entire buffer and
7438 then dive into the tree. This method has the disadvantage, that
7439 the previous location will be folded, which may not be what you
7440 want.
7442 This command works around this by showing a copy of the current
7443 buffer in an indirect buffer, in overview mode. You can dive
7444 into the tree in that copy, use org-occur and incremental search
7445 to find a location. When pressing RET or `Q', the command
7446 returns to the original buffer in which the visibility is still
7447 unchanged. After RET it will also jump to the location selected
7448 in the indirect buffer and expose the headline hierarchy above.
7450 With a prefix argument, use the alternative interface: e.g. if
7451 `org-goto-interface' is 'outline use 'outline-path-completion."
7452 (interactive "P")
7453 (org-goto-map)
7454 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7455 (org-refile-use-outline-path t)
7456 (org-refile-target-verify-function nil)
7457 (interface
7458 (if (not alternative-interface)
7459 org-goto-interface
7460 (if (eq org-goto-interface 'outline)
7461 'outline-path-completion
7462 'outline)))
7463 (org-goto-start-pos (point))
7464 (selected-point
7465 (if (eq interface 'outline)
7466 (car (org-get-location (current-buffer) org-goto-help))
7467 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7468 (org-refile-check-position pa)
7469 (nth 3 pa)))))
7470 (if selected-point
7471 (progn
7472 (org-mark-ring-push org-goto-start-pos)
7473 (goto-char selected-point)
7474 (if (or (outline-invisible-p) (org-invisible-p2))
7475 (org-show-context 'org-goto)))
7476 (message "Quit"))))
7478 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7479 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7480 (defvar org-goto-local-auto-isearch-map) ; defined below
7482 (defun org-get-location (buf help)
7483 "Let the user select a location in the Org-mode buffer BUF.
7484 This function uses a recursive edit. It returns the selected position
7485 or nil."
7486 (org-no-popups
7487 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7488 (isearch-hide-immediately nil)
7489 (isearch-search-fun-function
7490 (lambda () 'org-goto-local-search-headings))
7491 (org-goto-selected-point org-goto-exit-command))
7492 (save-excursion
7493 (save-window-excursion
7494 (delete-other-windows)
7495 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7496 (org-pop-to-buffer-same-window
7497 (condition-case nil
7498 (make-indirect-buffer (current-buffer) "*org-goto*")
7499 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7500 (with-output-to-temp-buffer "*Org Help*"
7501 (princ (format help (if org-goto-auto-isearch
7502 " Just type for auto-isearch."
7503 " n/p/f/b/u to navigate, q to quit."))))
7504 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7505 (setq buffer-read-only nil)
7506 (let ((org-startup-truncated t)
7507 (org-startup-folded nil)
7508 (org-startup-align-all-tables nil))
7509 (org-mode)
7510 (org-overview))
7511 (setq buffer-read-only t)
7512 (if (and (boundp 'org-goto-start-pos)
7513 (integer-or-marker-p org-goto-start-pos))
7514 (let ((org-show-hierarchy-above t)
7515 (org-show-siblings t)
7516 (org-show-following-heading t))
7517 (goto-char org-goto-start-pos)
7518 (and (outline-invisible-p) (org-show-context)))
7519 (goto-char (point-min)))
7520 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7521 (message "Select location and press RET")
7522 (use-local-map org-goto-map)
7523 (recursive-edit)))
7524 (kill-buffer "*org-goto*")
7525 (cons org-goto-selected-point org-goto-exit-command))))
7527 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7528 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7529 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7530 (if (fboundp 'isearch-other-control-char)
7531 (progn
7532 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7533 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7534 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7535 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7536 (define-key org-goto-local-auto-isearch-map [return] nil))
7538 (defun org-goto-local-search-headings (string bound noerror)
7539 "Search and make sure that any matches are in headlines."
7540 (catch 'return
7541 (while (if isearch-forward
7542 (search-forward string bound noerror)
7543 (search-backward string bound noerror))
7544 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7545 (and (member :headline context)
7546 (not (member :tags context))))
7547 (throw 'return (point))))))
7549 (defun org-goto-local-auto-isearch ()
7550 "Start isearch."
7551 (interactive)
7552 (goto-char (point-min))
7553 (let ((keys (this-command-keys)))
7554 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7555 (isearch-mode t)
7556 (isearch-process-search-char (string-to-char keys)))))
7558 (defun org-goto-ret (&optional arg)
7559 "Finish `org-goto' by going to the new location."
7560 (interactive "P")
7561 (setq org-goto-selected-point (point)
7562 org-goto-exit-command 'return)
7563 (throw 'exit nil))
7565 (defun org-goto-left ()
7566 "Finish `org-goto' by going to the new location."
7567 (interactive)
7568 (if (org-at-heading-p)
7569 (progn
7570 (beginning-of-line 1)
7571 (setq org-goto-selected-point (point)
7572 org-goto-exit-command 'left)
7573 (throw 'exit nil))
7574 (user-error "Not on a heading")))
7576 (defun org-goto-right ()
7577 "Finish `org-goto' by going to the new location."
7578 (interactive)
7579 (if (org-at-heading-p)
7580 (progn
7581 (setq org-goto-selected-point (point)
7582 org-goto-exit-command 'right)
7583 (throw 'exit nil))
7584 (user-error "Not on a heading")))
7586 (defun org-goto-quit ()
7587 "Finish `org-goto' without cursor motion."
7588 (interactive)
7589 (setq org-goto-selected-point nil)
7590 (setq org-goto-exit-command 'quit)
7591 (throw 'exit nil))
7593 ;;; Indirect buffer display of subtrees
7595 (defvar org-indirect-dedicated-frame nil
7596 "This is the frame being used for indirect tree display.")
7597 (defvar org-last-indirect-buffer nil)
7599 (defun org-tree-to-indirect-buffer (&optional arg)
7600 "Create indirect buffer and narrow it to current subtree.
7601 With a numerical prefix ARG, go up to this level and then take that tree.
7602 If ARG is negative, go up that many levels.
7604 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7605 indirect buffer previously made with this command, to avoid proliferation of
7606 indirect buffers. However, when you call the command with a \
7607 \\[universal-argument] prefix, or
7608 when `org-indirect-buffer-display' is `new-frame', the last buffer
7609 is kept so that you can work with several indirect buffers at the same time.
7610 If `org-indirect-buffer-display' is `dedicated-frame', the \
7611 \\[universal-argument] prefix also
7612 requests that a new frame be made for the new buffer, so that the dedicated
7613 frame is not changed."
7614 (interactive "P")
7615 (let ((cbuf (current-buffer))
7616 (cwin (selected-window))
7617 (pos (point))
7618 beg end level heading ibuf)
7619 (save-excursion
7620 (org-back-to-heading t)
7621 (when (numberp arg)
7622 (setq level (org-outline-level))
7623 (if (< arg 0) (setq arg (+ level arg)))
7624 (while (> (setq level (org-outline-level)) arg)
7625 (org-up-heading-safe)))
7626 (setq beg (point)
7627 heading (org-get-heading))
7628 (org-end-of-subtree t t)
7629 (if (org-at-heading-p) (backward-char 1))
7630 (setq end (point)))
7631 (if (and (buffer-live-p org-last-indirect-buffer)
7632 (not (eq org-indirect-buffer-display 'new-frame))
7633 (not arg))
7634 (kill-buffer org-last-indirect-buffer))
7635 (setq ibuf (org-get-indirect-buffer cbuf heading)
7636 org-last-indirect-buffer ibuf)
7637 (cond
7638 ((or (eq org-indirect-buffer-display 'new-frame)
7639 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7640 (select-frame (make-frame))
7641 (delete-other-windows)
7642 (org-pop-to-buffer-same-window ibuf)
7643 (org-set-frame-title heading))
7644 ((eq org-indirect-buffer-display 'dedicated-frame)
7645 (raise-frame
7646 (select-frame (or (and org-indirect-dedicated-frame
7647 (frame-live-p org-indirect-dedicated-frame)
7648 org-indirect-dedicated-frame)
7649 (setq org-indirect-dedicated-frame (make-frame)))))
7650 (delete-other-windows)
7651 (org-pop-to-buffer-same-window ibuf)
7652 (org-set-frame-title (concat "Indirect: " heading)))
7653 ((eq org-indirect-buffer-display 'current-window)
7654 (org-pop-to-buffer-same-window ibuf))
7655 ((eq org-indirect-buffer-display 'other-window)
7656 (pop-to-buffer ibuf))
7657 (t (error "Invalid value")))
7658 (if (featurep 'xemacs)
7659 (save-excursion (org-mode) (turn-on-font-lock)))
7660 (narrow-to-region beg end)
7661 (show-all)
7662 (goto-char pos)
7663 (run-hook-with-args 'org-cycle-hook 'all)
7664 (and (window-live-p cwin) (select-window cwin))))
7666 (defun org-get-indirect-buffer (&optional buffer heading)
7667 (setq buffer (or buffer (current-buffer)))
7668 (let ((n 1) (base (buffer-name buffer)) bname)
7669 (while (buffer-live-p
7670 (get-buffer
7671 (setq bname
7672 (concat base "-"
7673 (if heading (concat heading "-" (number-to-string n))
7674 (number-to-string n))))))
7675 (setq n (1+ n)))
7676 (condition-case nil
7677 (make-indirect-buffer buffer bname 'clone)
7678 (error (make-indirect-buffer buffer bname)))))
7680 (defun org-set-frame-title (title)
7681 "Set the title of the current frame to the string TITLE."
7682 ;; FIXME: how to name a single frame in XEmacs???
7683 (unless (featurep 'xemacs)
7684 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7686 ;;;; Structure editing
7688 ;;; Inserting headlines
7690 (defun org-previous-line-empty-p (&optional next)
7691 "Is the previous line a blank line?
7692 When NEXT is non-nil, check the next line instead."
7693 (save-excursion
7694 (and (not (bobp))
7695 (or (beginning-of-line (if next 2 0)) t)
7696 (save-match-data
7697 (looking-at "[ \t]*$")))))
7699 (defun org-insert-heading (&optional arg invisible-ok)
7700 "Insert a new heading or an item with the same depth at point.
7702 If point is at the beginning of a heading or a list item, insert
7703 a new heading or a new item above the current one. If point is
7704 at the beginning of a normal line, turn the line into a heading.
7706 If point is in the middle of a headline or a list item, split the
7707 headline or the item and create a new headline/item with the text
7708 in the current line after point \(see `org-M-RET-may-split-line'
7709 on how to modify this behavior).
7711 With one universal prefix argument, set the user option
7712 `org-insert-heading-respect-content' to t for the duration of
7713 the command. This modifies the behavior described above in this
7714 ways: on list items and at the beginning of normal lines, force
7715 the insertion of a heading after the current subtree.
7717 With two universal prefix arguments, insert the heading at the
7718 end of the grandparent subtree. For example, if point is within
7719 a 2nd-level heading, then it will insert a 2nd-level heading at
7720 the end of the 1st-level parent heading.
7722 If point is at the beginning of a headline, insert a sibling
7723 before the current headline. If point is not at the beginning,
7724 split the line and create a new headline with the text in the
7725 current line after point \(see `org-M-RET-may-split-line' on how
7726 to modify this behavior).
7728 If point is at the beginning of a normal line, turn this line
7729 into a heading.
7731 When INVISIBLE-OK is set, stop at invisible headlines when going
7732 back. This is important for non-interactive uses of the
7733 command."
7734 (interactive "P")
7735 (if (org-called-interactively-p 'any) (org-reveal))
7736 (let ((itemp (org-in-item-p))
7737 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7738 (respect-content (or org-insert-heading-respect-content
7739 (equal arg '(4))))
7740 (initial-content "")
7741 (adjust-empty-lines t))
7743 (cond
7745 ((or (= (buffer-size) 0)
7746 (and (not (save-excursion
7747 (and (ignore-errors (org-back-to-heading invisible-ok))
7748 (org-at-heading-p))))
7749 (or arg (not itemp))))
7750 ;; At beginning of buffer or so high up that only a heading
7751 ;; makes sense.
7752 (cond ((and (bolp) (not respect-content)) (insert "* "))
7753 ((not respect-content)
7754 (unless may-split (end-of-line))
7755 (insert "\n* "))
7756 ((re-search-forward org-outline-regexp-bol nil t)
7757 (beginning-of-line)
7758 (insert "* \n")
7759 (backward-char))
7760 (t (goto-char (point-max))
7761 (insert "\n* ")))
7762 (run-hooks 'org-insert-heading-hook))
7764 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7767 ;; Maybe move at the end of the subtree
7768 (when (equal arg '(16))
7769 (org-up-heading-safe)
7770 (org-end-of-subtree t))
7771 ;; Insert a heading
7772 (save-restriction
7773 (widen)
7774 (let* ((level nil)
7775 (on-heading (org-at-heading-p))
7776 (empty-line-p (if on-heading
7777 (org-previous-line-empty-p)
7778 ;; We will decide later
7779 nil))
7780 ;; Get a level string to fall back on
7781 (fix-level
7782 (if (org-before-first-heading-p) "*"
7783 (save-excursion
7784 (org-back-to-heading t)
7785 (if (org-previous-line-empty-p) (setq empty-line-p t))
7786 (looking-at org-outline-regexp)
7787 (make-string (1- (length (match-string 0))) ?*))))
7788 (stars
7789 (save-excursion
7790 (condition-case nil
7791 (progn
7792 (org-back-to-heading invisible-ok)
7793 (when (and (not on-heading)
7794 (featurep 'org-inlinetask)
7795 (integerp org-inlinetask-min-level)
7796 (>= (length (match-string 0))
7797 org-inlinetask-min-level))
7798 ;; Find a heading level before the inline task
7799 (while (and (setq level (org-up-heading-safe))
7800 (>= level org-inlinetask-min-level)))
7801 (if (org-at-heading-p)
7802 (org-back-to-heading invisible-ok)
7803 (error "This should not happen")))
7804 (unless (and (save-excursion
7805 (save-match-data
7806 (org-backward-heading-same-level
7807 1 invisible-ok))
7808 (= (point) (match-beginning 0)))
7809 (not (org-previous-line-empty-p t)))
7810 (setq empty-line-p (or empty-line-p
7811 (org-previous-line-empty-p))))
7812 (match-string 0))
7813 (error (or fix-level "* ")))))
7814 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7815 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7816 pos hide-previous previous-pos)
7818 ;; If we insert after content, move there and clean up whitespace
7819 (when (and respect-content
7820 (not (org-looking-at-p org-outline-regexp-bol)))
7821 (if (not (org-before-first-heading-p))
7822 (org-end-of-subtree nil t)
7823 (re-search-forward org-outline-regexp-bol)
7824 (beginning-of-line 0))
7825 (skip-chars-backward " \r\n")
7826 (and (not (looking-back "^\\*+"))
7827 (looking-at "[ \t]+") (replace-match ""))
7828 (unless (eobp) (forward-char 1))
7829 (when (looking-at "^\\*")
7830 (unless (bobp) (backward-char 1))
7831 (insert "\n")))
7833 ;; If we are splitting, grab the text that should be moved to the new headline
7834 (when may-split
7835 (if (org-on-heading-p)
7836 ;; This is a heading, we split intelligently (keeping tags)
7837 (let ((pos (point)))
7838 (goto-char (point-at-bol))
7839 (unless (looking-at org-complex-heading-regexp)
7840 (error "This should not happen"))
7841 (when (and (match-beginning 4)
7842 (> pos (match-beginning 4))
7843 (< pos (match-end 4)))
7844 (setq initial-content (buffer-substring pos (match-end 4)))
7845 (goto-char pos)
7846 (delete-region (point) (match-end 4))
7847 (if (looking-at "[ \t]*$")
7848 (replace-match "")
7849 (insert (make-string (length initial-content) ?\ )))
7850 (setq initial-content (org-trim initial-content)))
7851 (goto-char pos))
7852 ;; a normal line
7853 (setq initial-content
7854 (org-trim (buffer-substring (point) (point-at-eol))))
7855 (delete-region (point) (point-at-eol))))
7857 ;; If we are at the beginning of the line, insert before it. Else after
7858 (cond
7859 ((and (bolp) (looking-at "[ \t]*$")))
7860 ((and (bolp) (not (looking-at "[ \t]*$")))
7861 (open-line 1))
7863 (goto-char (point-at-eol))
7864 (insert "\n")))
7866 ;; Insert the new heading
7867 (insert stars)
7868 (just-one-space)
7869 (insert initial-content)
7870 (when adjust-empty-lines
7871 (if (or (not blank)
7872 (and blank (not (org-previous-line-empty-p))))
7873 (org-N-empty-lines-before-current (if blank 1 0))))
7874 (run-hooks 'org-insert-heading-hook)))))))
7876 (defun org-N-empty-lines-before-current (N)
7877 "Make the number of empty lines before current exactly N.
7878 So this will delete or add empty lines."
7879 (save-excursion
7880 (beginning-of-line)
7881 (let ((p (point)))
7882 (skip-chars-backward " \r\t\n")
7883 (unless (bolp) (forward-line))
7884 (delete-region (point) p))
7885 (when (> N 0) (insert (make-string N ?\n)))))
7887 (defun org-get-heading (&optional no-tags no-todo)
7888 "Return the heading of the current entry, without the stars.
7889 When NO-TAGS is non-nil, don't include tags.
7890 When NO-TODO is non-nil, don't include TODO keywords."
7891 (save-excursion
7892 (org-back-to-heading t)
7893 (cond
7894 ((and no-tags no-todo)
7895 (looking-at org-complex-heading-regexp)
7896 (match-string 4))
7897 (no-tags
7898 (looking-at (concat org-outline-regexp
7899 "\\(.*?\\)"
7900 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7901 (match-string 1))
7902 (no-todo
7903 (looking-at org-todo-line-regexp)
7904 (match-string 3))
7905 (t (looking-at org-heading-regexp)
7906 (match-string 2)))))
7908 (defvar orgstruct-mode) ; defined below
7910 (defun org-heading-components ()
7911 "Return the components of the current heading.
7912 This is a list with the following elements:
7913 - the level as an integer
7914 - the reduced level, different if `org-odd-levels-only' is set.
7915 - the TODO keyword, or nil
7916 - the priority character, like ?A, or nil if no priority is given
7917 - the headline text itself, or the tags string if no headline text
7918 - the tags string, or nil."
7919 (save-excursion
7920 (org-back-to-heading t)
7921 (if (let (case-fold-search)
7922 (looking-at
7923 (if orgstruct-mode
7924 org-heading-regexp
7925 org-complex-heading-regexp)))
7926 (if orgstruct-mode
7927 (list (length (match-string 1))
7928 (org-reduced-level (length (match-string 1)))
7931 (match-string 2)
7932 nil)
7933 (list (length (match-string 1))
7934 (org-reduced-level (length (match-string 1)))
7935 (org-match-string-no-properties 2)
7936 (and (match-end 3) (aref (match-string 3) 2))
7937 (org-match-string-no-properties 4)
7938 (org-match-string-no-properties 5))))))
7940 (defun org-get-entry ()
7941 "Get the entry text, after heading, entire subtree."
7942 (save-excursion
7943 (org-back-to-heading t)
7944 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7946 (defun org-insert-heading-after-current ()
7947 "Insert a new heading with same level as current, after current subtree."
7948 (interactive)
7949 (org-back-to-heading)
7950 (org-insert-heading)
7951 (org-move-subtree-down)
7952 (end-of-line 1))
7954 (defun org-insert-heading-respect-content (&optional invisible-ok)
7955 "Insert heading with `org-insert-heading-respect-content' set to t."
7956 (interactive)
7957 (org-insert-heading '(4) invisible-ok))
7959 (defun org-insert-todo-heading-respect-content (&optional force-state)
7960 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7961 (interactive)
7962 (org-insert-todo-heading force-state '(4)))
7964 (defun org-insert-todo-heading (arg &optional force-heading)
7965 "Insert a new heading with the same level and TODO state as current heading.
7966 If the heading has no TODO state, or if the state is DONE, use the first
7967 state (TODO by default). Also with one prefix arg, force first state. With
7968 two prefix args, force inserting at the end of the parent subtree."
7969 (interactive "P")
7970 (when (or force-heading (not (org-insert-item 'checkbox)))
7971 (org-insert-heading (or (and (equal arg '(16)) '(16))
7972 force-heading))
7973 (save-excursion
7974 (org-back-to-heading)
7975 (outline-previous-heading)
7976 (looking-at org-todo-line-regexp))
7977 (let*
7978 ((new-mark-x
7979 (if (or (equal arg '(4))
7980 (not (match-beginning 2))
7981 (member (match-string 2) org-done-keywords))
7982 (car org-todo-keywords-1)
7983 (match-string 2)))
7984 (new-mark
7986 (run-hook-with-args-until-success
7987 'org-todo-get-default-hook new-mark-x nil)
7988 new-mark-x)))
7989 (beginning-of-line 1)
7990 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7991 (if org-treat-insert-todo-heading-as-state-change
7992 (org-todo new-mark)
7993 (insert new-mark " "))))
7994 (when org-provide-todo-statistics
7995 (org-update-parent-todo-statistics))))
7997 (defun org-insert-subheading (arg)
7998 "Insert a new subheading and demote it.
7999 Works for outline headings and for plain lists alike."
8000 (interactive "P")
8001 (org-insert-heading arg)
8002 (cond
8003 ((org-at-heading-p) (org-do-demote))
8004 ((org-at-item-p) (org-indent-item))))
8006 (defun org-insert-todo-subheading (arg)
8007 "Insert a new subheading with TODO keyword or checkbox and demote it.
8008 Works for outline headings and for plain lists alike."
8009 (interactive "P")
8010 (org-insert-todo-heading arg)
8011 (cond
8012 ((org-at-heading-p) (org-do-demote))
8013 ((org-at-item-p) (org-indent-item))))
8015 ;;; Promotion and Demotion
8017 (defvar org-after-demote-entry-hook nil
8018 "Hook run after an entry has been demoted.
8019 The cursor will be at the beginning of the entry.
8020 When a subtree is being demoted, the hook will be called for each node.")
8022 (defvar org-after-promote-entry-hook nil
8023 "Hook run after an entry has been promoted.
8024 The cursor will be at the beginning of the entry.
8025 When a subtree is being promoted, the hook will be called for each node.")
8027 (defun org-promote-subtree ()
8028 "Promote the entire subtree.
8029 See also `org-promote'."
8030 (interactive)
8031 (save-excursion
8032 (org-with-limited-levels (org-map-tree 'org-promote)))
8033 (org-fix-position-after-promote))
8035 (defun org-demote-subtree ()
8036 "Demote the entire subtree. See `org-demote'.
8037 See also `org-promote'."
8038 (interactive)
8039 (save-excursion
8040 (org-with-limited-levels (org-map-tree 'org-demote)))
8041 (org-fix-position-after-promote))
8044 (defun org-do-promote ()
8045 "Promote the current heading higher up the tree.
8046 If the region is active in `transient-mark-mode', promote all headings
8047 in the region."
8048 (interactive)
8049 (save-excursion
8050 (if (org-region-active-p)
8051 (org-map-region 'org-promote (region-beginning) (region-end))
8052 (org-promote)))
8053 (org-fix-position-after-promote))
8055 (defun org-do-demote ()
8056 "Demote the current heading lower down the tree.
8057 If the region is active in `transient-mark-mode', demote all headings
8058 in the region."
8059 (interactive)
8060 (save-excursion
8061 (if (org-region-active-p)
8062 (org-map-region 'org-demote (region-beginning) (region-end))
8063 (org-demote)))
8064 (org-fix-position-after-promote))
8066 (defun org-fix-position-after-promote ()
8067 "Make sure that after pro/demotion cursor position is right."
8068 (let ((pos (point)))
8069 (when (save-excursion
8070 (beginning-of-line 1)
8071 (looking-at org-todo-line-regexp)
8072 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8073 (cond ((eobp) (insert " "))
8074 ((eolp) (insert " "))
8075 ((equal (char-after) ?\ ) (forward-char 1))))))
8077 (defun org-current-level ()
8078 "Return the level of the current entry, or nil if before the first headline.
8079 The level is the number of stars at the beginning of the headline."
8080 (save-excursion
8081 (org-with-limited-levels
8082 (if (ignore-errors (org-back-to-heading t))
8083 (funcall outline-level)))))
8085 (defun org-get-previous-line-level ()
8086 "Return the outline depth of the last headline before the current line.
8087 Returns 0 for the first headline in the buffer, and nil if before the
8088 first headline."
8089 (and (org-current-level)
8090 (or (and (/= (line-beginning-position) (point-min))
8091 (save-excursion (beginning-of-line 0) (org-current-level)))
8092 0)))
8094 (defun org-reduced-level (l)
8095 "Compute the effective level of a heading.
8096 This takes into account the setting of `org-odd-levels-only'."
8097 (cond
8098 ((zerop l) 0)
8099 (org-odd-levels-only (1+ (floor (/ l 2))))
8100 (t l)))
8102 (defun org-level-increment ()
8103 "Return the number of stars that will be added or removed at a
8104 time to headlines when structure editing, based on the value of
8105 `org-odd-levels-only'."
8106 (if org-odd-levels-only 2 1))
8108 (defun org-get-valid-level (level &optional change)
8109 "Rectify a level change under the influence of `org-odd-levels-only'
8110 LEVEL is a current level, CHANGE is by how much the level should be
8111 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8112 even level numbers will become the next higher odd number."
8113 (if org-odd-levels-only
8114 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8115 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8116 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8117 (max 1 (+ level (or change 0)))))
8119 (if (boundp 'define-obsolete-function-alias)
8120 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8121 (define-obsolete-function-alias 'org-get-legal-level
8122 'org-get-valid-level)
8123 (define-obsolete-function-alias 'org-get-legal-level
8124 'org-get-valid-level "23.1")))
8126 (defun org-promote ()
8127 "Promote the current heading higher up the tree."
8128 (org-with-wide-buffer
8129 (org-back-to-heading t)
8130 (let* ((after-change-functions (remq 'flyspell-after-change-function
8131 after-change-functions))
8132 (level (save-match-data (funcall outline-level)))
8133 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8134 (diff (abs (- level (length up-head) -1))))
8135 (cond
8136 ((and (= level 1) org-allow-promoting-top-level-subtree)
8137 (replace-match "# " nil t))
8138 ((= level 1)
8139 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8140 (t (replace-match up-head nil t)))
8141 (unless (= level 1)
8142 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8143 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8144 (run-hooks 'org-after-promote-entry-hook))))
8146 (defun org-demote ()
8147 "Demote the current heading lower down the tree."
8148 (org-with-wide-buffer
8149 (org-back-to-heading t)
8150 (let* ((after-change-functions (remq 'flyspell-after-change-function
8151 after-change-functions))
8152 (level (save-match-data (funcall outline-level)))
8153 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8154 (diff (abs (- level (length down-head) -1))))
8155 (replace-match down-head nil t)
8156 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8157 (when org-adapt-indentation (org-fixup-indentation diff))
8158 (run-hooks 'org-after-demote-entry-hook))))
8160 (defun org-cycle-level ()
8161 "Cycle the level of an empty headline through possible states.
8162 This goes first to child, then to parent, level, then up the hierarchy.
8163 After top level, it switches back to sibling level."
8164 (interactive)
8165 (let ((org-adapt-indentation nil))
8166 (when (org-point-at-end-of-empty-headline)
8167 (setq this-command 'org-cycle-level) ; Only needed for caching
8168 (let ((cur-level (org-current-level))
8169 (prev-level (org-get-previous-line-level)))
8170 (cond
8171 ;; If first headline in file, promote to top-level.
8172 ((= prev-level 0)
8173 (loop repeat (/ (- cur-level 1) (org-level-increment))
8174 do (org-do-promote)))
8175 ;; If same level as prev, demote one.
8176 ((= prev-level cur-level)
8177 (org-do-demote))
8178 ;; If parent is top-level, promote to top level if not already.
8179 ((= prev-level 1)
8180 (loop repeat (/ (- cur-level 1) (org-level-increment))
8181 do (org-do-promote)))
8182 ;; If top-level, return to prev-level.
8183 ((= cur-level 1)
8184 (loop repeat (/ (- prev-level 1) (org-level-increment))
8185 do (org-do-demote)))
8186 ;; If less than prev-level, promote one.
8187 ((< cur-level prev-level)
8188 (org-do-promote))
8189 ;; If deeper than prev-level, promote until higher than
8190 ;; prev-level.
8191 ((> cur-level prev-level)
8192 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8193 do (org-do-promote))))
8194 t))))
8196 (defun org-map-tree (fun)
8197 "Call FUN for every heading underneath the current one."
8198 (org-back-to-heading)
8199 (let ((level (funcall outline-level)))
8200 (save-excursion
8201 (funcall fun)
8202 (while (and (progn
8203 (outline-next-heading)
8204 (> (funcall outline-level) level))
8205 (not (eobp)))
8206 (funcall fun)))))
8208 (defun org-map-region (fun beg end)
8209 "Call FUN for every heading between BEG and END."
8210 (let ((org-ignore-region t))
8211 (save-excursion
8212 (setq end (copy-marker end))
8213 (goto-char beg)
8214 (if (and (re-search-forward org-outline-regexp-bol nil t)
8215 (< (point) end))
8216 (funcall fun))
8217 (while (and (progn
8218 (outline-next-heading)
8219 (< (point) end))
8220 (not (eobp)))
8221 (funcall fun)))))
8223 (defun org-fixup-indentation (diff)
8224 "Change the indentation in the current entry by DIFF.
8226 DIFF is an integer. Indentation is done according to the
8227 following rules:
8229 - Planning information and property drawers are always indented
8230 according to the new level of the headline;
8232 - Footnote definitions and their contents are ignored;
8234 - Inlinetasks' boundaries are not shifted;
8236 - Empty lines are ignored;
8238 - Other lines' indentation are shifted by DIFF columns, unless
8239 it would introduce a structural change in the document, in
8240 which case no shifting is done at all.
8242 Assume point is at a heading or an inlinetask beginning."
8243 (org-with-wide-buffer
8244 (narrow-to-region (line-beginning-position)
8245 (save-excursion
8246 (if (org-with-limited-levels (org-at-heading-p))
8247 (org-with-limited-levels (outline-next-heading))
8248 (org-inlinetask-goto-end))
8249 (point)))
8250 (forward-line)
8251 ;; Indent properly planning info and property drawer.
8252 (when (org-looking-at-p org-planning-line-re)
8253 (org-indent-line)
8254 (forward-line))
8255 (when (looking-at org-property-drawer-re)
8256 (goto-char (match-end 0))
8257 (forward-line)
8258 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8259 (catch 'no-shift
8260 (when (zerop diff) (throw 'no-shift nil))
8261 ;; If DIFF is negative, first check if a shift is possible at all
8262 ;; (e.g., it doesn't break structure). This can only happen if
8263 ;; some contents are not properly indented.
8264 (let ((case-fold-search t))
8265 (when (< diff 0)
8266 (let ((diff (- diff))
8267 (forbidden-re (concat org-outline-regexp
8268 "\\|"
8269 (substring org-footnote-definition-re 1))))
8270 (save-excursion
8271 (while (not (eobp))
8272 (cond
8273 ((org-looking-at-p "[ \t]*$") (forward-line))
8274 ((and (org-looking-at-p org-footnote-definition-re)
8275 (let ((e (org-element-at-point)))
8276 (and (eq (org-element-type e) 'footnote-definition)
8277 (goto-char (org-element-property :end e))))))
8278 ((org-looking-at-p org-outline-regexp) (forward-line))
8279 ;; Give up if shifting would move before column 0 or
8280 ;; if it would introduce a headline or a footnote
8281 ;; definition.
8283 (skip-chars-forward " \t")
8284 (let ((ind (current-column)))
8285 (when (or (< ind diff)
8286 (and (= ind diff) (org-looking-at-p forbidden-re)))
8287 (throw 'no-shift nil)))
8288 ;; Ignore contents of example blocks and source
8289 ;; blocks if their indentation is meant to be
8290 ;; preserved. Jump to block's closing line.
8291 (beginning-of-line)
8292 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8293 (let ((e (org-element-at-point)))
8294 (and (memq (org-element-type e)
8295 '(example-block src-block))
8296 (or org-src-preserve-indentation
8297 (org-element-property :preserve-indent e))
8298 (goto-char (org-element-property :end e))
8299 (progn (skip-chars-backward " \r\t\n")
8300 (beginning-of-line)
8301 t))))
8302 (forward-line))))))))
8303 ;; Shift lines but footnote definitions, inlinetasks boundaries
8304 ;; by DIFF. Also skip contents of source or example blocks
8305 ;; when indentation is meant to be preserved.
8306 (while (not (eobp))
8307 (cond
8308 ((and (org-looking-at-p org-footnote-definition-re)
8309 (let ((e (org-element-at-point)))
8310 (and (eq (org-element-type e) 'footnote-definition)
8311 (goto-char (org-element-property :end e))))))
8312 ((org-looking-at-p org-outline-regexp) (forward-line))
8313 ((org-looking-at-p "[ \t]*$") (forward-line))
8315 (org-indent-line-to (+ (org-get-indentation) diff))
8316 (beginning-of-line)
8317 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8318 (let ((e (org-element-at-point)))
8319 (and (memq (org-element-type e)
8320 '(example-block src-block))
8321 (or org-src-preserve-indentation
8322 (org-element-property :preserve-indent e))
8323 (goto-char (org-element-property :end e))
8324 (progn (skip-chars-backward " \r\t\n")
8325 (beginning-of-line)
8326 t))))
8327 (forward-line)))))))))
8329 (defun org-convert-to-odd-levels ()
8330 "Convert an org-mode file with all levels allowed to one with odd levels.
8331 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8332 level 5 etc."
8333 (interactive)
8334 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8335 (let ((outline-level 'org-outline-level)
8336 (org-odd-levels-only nil) n)
8337 (save-excursion
8338 (goto-char (point-min))
8339 (while (re-search-forward "^\\*\\*+ " nil t)
8340 (setq n (- (length (match-string 0)) 2))
8341 (while (>= (setq n (1- n)) 0)
8342 (org-demote))
8343 (end-of-line 1))))))
8345 (defun org-convert-to-oddeven-levels ()
8346 "Convert an org-mode file with only odd levels to one with odd/even levels.
8347 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8348 file contains a section with an even level, conversion would
8349 destroy the structure of the file. An error is signaled in this
8350 case."
8351 (interactive)
8352 (goto-char (point-min))
8353 ;; First check if there are no even levels
8354 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8355 (org-show-context t)
8356 (error "Not all levels are odd in this file. Conversion not possible"))
8357 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8358 (let ((outline-regexp org-outline-regexp)
8359 (outline-level 'org-outline-level)
8360 (org-odd-levels-only nil) n)
8361 (save-excursion
8362 (goto-char (point-min))
8363 (while (re-search-forward "^\\*\\*+ " nil t)
8364 (setq n (/ (1- (length (match-string 0))) 2))
8365 (while (>= (setq n (1- n)) 0)
8366 (org-promote))
8367 (end-of-line 1))))))
8369 (defun org-tr-level (n)
8370 "Make N odd if required."
8371 (if org-odd-levels-only (1+ (/ n 2)) n))
8373 ;;; Vertical tree motion, cutting and pasting of subtrees
8375 (defun org-move-subtree-up (&optional arg)
8376 "Move the current subtree up past ARG headlines of the same level."
8377 (interactive "p")
8378 (org-move-subtree-down (- (prefix-numeric-value arg))))
8380 (defun org-move-subtree-down (&optional arg)
8381 "Move the current subtree down past ARG headlines of the same level."
8382 (interactive "p")
8383 (setq arg (prefix-numeric-value arg))
8384 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8385 'org-get-last-sibling))
8386 (ins-point (make-marker))
8387 (cnt (abs arg))
8388 (col (current-column))
8389 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8390 ;; Select the tree
8391 (org-back-to-heading)
8392 (setq beg0 (point))
8393 (save-excursion
8394 (setq ne-beg (org-back-over-empty-lines))
8395 (setq beg (point)))
8396 (save-match-data
8397 (save-excursion (outline-end-of-heading)
8398 (setq folded (outline-invisible-p)))
8399 (progn (org-end-of-subtree nil t)
8400 (unless (eobp) (backward-char))))
8401 (outline-next-heading)
8402 (setq ne-end (org-back-over-empty-lines))
8403 (setq end (point))
8404 (goto-char beg0)
8405 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8406 ;; include less whitespace
8407 (save-excursion
8408 (goto-char beg)
8409 (forward-line (- ne-beg ne-end))
8410 (setq beg (point))))
8411 ;; Find insertion point, with error handling
8412 (while (> cnt 0)
8413 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8414 (progn (goto-char beg0)
8415 (user-error "Cannot move past superior level or buffer limit")))
8416 (setq cnt (1- cnt)))
8417 (if (> arg 0)
8418 ;; Moving forward - still need to move over subtree
8419 (progn (org-end-of-subtree t t)
8420 (save-excursion
8421 (org-back-over-empty-lines)
8422 (or (bolp) (newline)))))
8423 (setq ne-ins (org-back-over-empty-lines))
8424 (move-marker ins-point (point))
8425 (setq txt (buffer-substring beg end))
8426 (org-save-markers-in-region beg end)
8427 (delete-region beg end)
8428 (org-remove-empty-overlays-at beg)
8429 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8430 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8431 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8432 (let ((bbb (point)))
8433 (insert-before-markers txt)
8434 (org-reinstall-markers-in-region bbb)
8435 (move-marker ins-point bbb))
8436 (or (bolp) (insert "\n"))
8437 (setq ins-end (point))
8438 (goto-char ins-point)
8439 (org-skip-whitespace)
8440 (when (and (< arg 0)
8441 (org-first-sibling-p)
8442 (> ne-ins ne-beg))
8443 ;; Move whitespace back to beginning
8444 (save-excursion
8445 (goto-char ins-end)
8446 (let ((kill-whole-line t))
8447 (kill-line (- ne-ins ne-beg)) (point)))
8448 (insert (make-string (- ne-ins ne-beg) ?\n)))
8449 (move-marker ins-point nil)
8450 (if folded
8451 (hide-subtree)
8452 (org-show-entry)
8453 (show-children)
8454 (org-cycle-hide-drawers 'children))
8455 (org-clean-visibility-after-subtree-move)
8456 ;; move back to the initial column we were at
8457 (move-to-column col)))
8459 (defvar org-subtree-clip ""
8460 "Clipboard for cut and paste of subtrees.
8461 This is actually only a copy of the kill, because we use the normal kill
8462 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8464 (defvar org-subtree-clip-folded nil
8465 "Was the last copied subtree folded?
8466 This is used to fold the tree back after pasting.")
8468 (defun org-cut-subtree (&optional n)
8469 "Cut the current subtree into the clipboard.
8470 With prefix arg N, cut this many sequential subtrees.
8471 This is a short-hand for marking the subtree and then cutting it."
8472 (interactive "p")
8473 (org-copy-subtree n 'cut))
8475 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8476 "Copy the current subtree it in the clipboard.
8477 With prefix arg N, copy this many sequential subtrees.
8478 This is a short-hand for marking the subtree and then copying it.
8479 If CUT is non-nil, actually cut the subtree.
8480 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8481 of some markers in the region, even if CUT is non-nil. This is
8482 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8483 (interactive "p")
8484 (let (beg end folded (beg0 (point)))
8485 (if (org-called-interactively-p 'any)
8486 (org-back-to-heading nil) ; take what looks like a subtree
8487 (org-back-to-heading t)) ; take what is really there
8488 (setq beg (point))
8489 (skip-chars-forward " \t\r\n")
8490 (save-match-data
8491 (if nosubtrees
8492 (outline-next-heading)
8493 (save-excursion (outline-end-of-heading)
8494 (setq folded (outline-invisible-p)))
8495 (ignore-errors (org-forward-heading-same-level (1- n) t))
8496 (org-end-of-subtree t t)))
8497 (setq end (point))
8498 (goto-char beg0)
8499 (when (> end beg)
8500 (setq org-subtree-clip-folded folded)
8501 (when (or cut force-store-markers)
8502 (org-save-markers-in-region beg end))
8503 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8504 (setq org-subtree-clip (current-kill 0))
8505 (message "%s: Subtree(s) with %d characters"
8506 (if cut "Cut" "Copied")
8507 (length org-subtree-clip)))))
8509 (defun org-paste-subtree (&optional level tree for-yank remove)
8510 "Paste the clipboard as a subtree, with modification of headline level.
8511 The entire subtree is promoted or demoted in order to match a new headline
8512 level.
8514 If the cursor is at the beginning of a headline, the same level as
8515 that headline is used to paste the tree.
8517 If not, the new level is derived from the *visible* headings
8518 before and after the insertion point, and taken to be the inferior headline
8519 level of the two. So if the previous visible heading is level 3 and the
8520 next is level 4 (or vice versa), level 4 will be used for insertion.
8521 This makes sure that the subtree remains an independent subtree and does
8522 not swallow low level entries.
8524 You can also force a different level, either by using a numeric prefix
8525 argument, or by inserting the heading marker by hand. For example, if the
8526 cursor is after \"*****\", then the tree will be shifted to level 5.
8528 If optional TREE is given, use this text instead of the kill ring.
8530 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8531 move back over whitespace before inserting, and move point to the end of
8532 the inserted text when done.
8534 When REMOVE is non-nil, remove the subtree from the clipboard."
8535 (interactive "P")
8536 (setq tree (or tree (and kill-ring (current-kill 0))))
8537 (unless (org-kill-is-subtree-p tree)
8538 (user-error "%s"
8539 (substitute-command-keys
8540 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8541 (org-with-limited-levels
8542 (let* ((visp (not (outline-invisible-p)))
8543 (txt tree)
8544 (^re_ "\\(\\*+\\)[ \t]*")
8545 (old-level (if (string-match org-outline-regexp-bol txt)
8546 (- (match-end 0) (match-beginning 0) 1)
8547 -1))
8548 (force-level (cond (level (prefix-numeric-value level))
8549 ((and (looking-at "[ \t]*$")
8550 (string-match
8551 "^\\*+$" (buffer-substring
8552 (point-at-bol) (point))))
8553 (- (match-end 0) (match-beginning 0)))
8554 ((and (bolp)
8555 (looking-at org-outline-regexp))
8556 (- (match-end 0) (point) 1))))
8557 (previous-level (save-excursion
8558 (condition-case nil
8559 (progn
8560 (outline-previous-visible-heading 1)
8561 (if (looking-at ^re_)
8562 (- (match-end 0) (match-beginning 0) 1)
8564 (error 1))))
8565 (next-level (save-excursion
8566 (condition-case nil
8567 (progn
8568 (or (looking-at org-outline-regexp)
8569 (outline-next-visible-heading 1))
8570 (if (looking-at ^re_)
8571 (- (match-end 0) (match-beginning 0) 1)
8573 (error 1))))
8574 (new-level (or force-level (max previous-level next-level)))
8575 (shift (if (or (= old-level -1)
8576 (= new-level -1)
8577 (= old-level new-level))
8579 (- new-level old-level)))
8580 (delta (if (> shift 0) -1 1))
8581 (func (if (> shift 0) 'org-demote 'org-promote))
8582 (org-odd-levels-only nil)
8583 beg end newend)
8584 ;; Remove the forced level indicator
8585 (if force-level
8586 (delete-region (point-at-bol) (point)))
8587 ;; Paste
8588 (beginning-of-line (if (bolp) 1 2))
8589 (setq beg (point))
8590 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8591 (insert-before-markers txt)
8592 (unless (string-match "\n\\'" txt) (insert "\n"))
8593 (setq newend (point))
8594 (org-reinstall-markers-in-region beg)
8595 (setq end (point))
8596 (goto-char beg)
8597 (skip-chars-forward " \t\n\r")
8598 (setq beg (point))
8599 (if (and (outline-invisible-p) visp)
8600 (save-excursion (outline-show-heading)))
8601 ;; Shift if necessary
8602 (unless (= shift 0)
8603 (save-restriction
8604 (narrow-to-region beg end)
8605 (while (not (= shift 0))
8606 (org-map-region func (point-min) (point-max))
8607 (setq shift (+ delta shift)))
8608 (goto-char (point-min))
8609 (setq newend (point-max))))
8610 (when (or (org-called-interactively-p 'interactive) for-yank)
8611 (message "Clipboard pasted as level %d subtree" new-level))
8612 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8613 kill-ring
8614 (eq org-subtree-clip (current-kill 0))
8615 org-subtree-clip-folded)
8616 ;; The tree was folded before it was killed/copied
8617 (hide-subtree))
8618 (and for-yank (goto-char newend))
8619 (and remove (setq kill-ring (cdr kill-ring))))))
8621 (defun org-kill-is-subtree-p (&optional txt)
8622 "Check if the current kill is an outline subtree, or a set of trees.
8623 Returns nil if kill does not start with a headline, or if the first
8624 headline level is not the largest headline level in the tree.
8625 So this will actually accept several entries of equal levels as well,
8626 which is OK for `org-paste-subtree'.
8627 If optional TXT is given, check this string instead of the current kill."
8628 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8629 (re (org-get-limited-outline-regexp))
8630 (^re (concat "^" re))
8631 (start-level (and kill
8632 (string-match
8633 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8634 kill)
8635 (- (match-end 2) (match-beginning 2) 1)))
8636 (start (1+ (or (match-beginning 2) -1))))
8637 (if (not start-level)
8638 (progn
8639 nil) ;; does not even start with a heading
8640 (catch 'exit
8641 (while (setq start (string-match ^re kill (1+ start)))
8642 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8643 (throw 'exit nil)))
8644 t))))
8646 (defvar org-markers-to-move nil
8647 "Markers that should be moved with a cut-and-paste operation.
8648 Those markers are stored together with their positions relative to
8649 the start of the region.")
8651 (defun org-save-markers-in-region (beg end)
8652 "Check markers in region.
8653 If these markers are between BEG and END, record their position relative
8654 to BEG, so that after moving the block of text, we can put the markers back
8655 into place.
8656 This function gets called just before an entry or tree gets cut from the
8657 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8658 called immediately, to move the markers with the entries."
8659 (setq org-markers-to-move nil)
8660 (when (featurep 'org-clock)
8661 (org-clock-save-markers-for-cut-and-paste beg end))
8662 (when (featurep 'org-agenda)
8663 (org-agenda-save-markers-for-cut-and-paste beg end)))
8665 (defun org-check-and-save-marker (marker beg end)
8666 "Check if MARKER is between BEG and END.
8667 If yes, remember the marker and the distance to BEG."
8668 (when (and (marker-buffer marker)
8669 (equal (marker-buffer marker) (current-buffer)))
8670 (if (and (>= marker beg) (< marker end))
8671 (push (cons marker (- marker beg)) org-markers-to-move))))
8673 (defun org-reinstall-markers-in-region (beg)
8674 "Move all remembered markers to their position relative to BEG."
8675 (mapc (lambda (x)
8676 (move-marker (car x) (+ beg (cdr x))))
8677 org-markers-to-move)
8678 (setq org-markers-to-move nil))
8680 (defun org-narrow-to-subtree ()
8681 "Narrow buffer to the current subtree."
8682 (interactive)
8683 (save-excursion
8684 (save-match-data
8685 (org-with-limited-levels
8686 (narrow-to-region
8687 (progn (org-back-to-heading t) (point))
8688 (progn (org-end-of-subtree t t)
8689 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8690 (point)))))))
8692 (defun org-narrow-to-block ()
8693 "Narrow buffer to the current block."
8694 (interactive)
8695 (let* ((case-fold-search t)
8696 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8697 "^[ \t]*#\\+end_.*")))
8698 (if blockp
8699 (narrow-to-region (car blockp) (cdr blockp))
8700 (user-error "Not in a block"))))
8702 (defun org-clone-subtree-with-time-shift (n &optional shift)
8703 "Clone the task (subtree) at point N times.
8704 The clones will be inserted as siblings.
8706 In interactive use, the user will be prompted for the number of
8707 clones to be produced. If the entry has a timestamp, the user
8708 will also be prompted for a time shift, which may be a repeater
8709 as used in time stamps, for example `+3d'. To disable this,
8710 you can call the function with a universal prefix argument.
8712 When a valid repeater is given and the entry contains any time
8713 stamps, the clones will become a sequence in time, with time
8714 stamps in the subtree shifted for each clone produced. If SHIFT
8715 is nil or the empty string, time stamps will be left alone. The
8716 ID property of the original subtree is removed.
8718 If the original subtree did contain time stamps with a repeater,
8719 the following will happen:
8720 - the repeater will be removed in each clone
8721 - an additional clone will be produced, with the current, unshifted
8722 date(s) in the entry.
8723 - the original entry will be placed *after* all the clones, with
8724 repeater intact.
8725 - the start days in the repeater in the original entry will be shifted
8726 to past the last clone.
8727 In this way you can spell out a number of instances of a repeating task,
8728 and still retain the repeater to cover future instances of the task."
8729 (interactive "nNumber of clones to produce: ")
8730 (let ((shift
8731 (or shift
8732 (if (and (not (equal current-prefix-arg '(4)))
8733 (save-excursion
8734 (re-search-forward org-ts-regexp-both
8735 (save-excursion
8736 (org-end-of-subtree t)
8737 (point)) t)))
8738 (read-from-minibuffer
8739 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8740 ""))) ;; No time shift
8741 (n-no-remove -1)
8742 (drawer-re org-drawer-regexp)
8743 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8744 beg end template task idprop
8745 shift-n shift-what doshift nmin nmax)
8746 (if (not (and (integerp n) (> n 0)))
8747 (user-error "Invalid number of replications %s" n))
8748 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8749 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8750 shift)))
8751 (user-error "Invalid shift specification %s" shift))
8752 (when doshift
8753 (setq shift-n (string-to-number (match-string 1 shift))
8754 shift-what (cdr (assoc (match-string 2 shift)
8755 '(("d" . day) ("w" . week)
8756 ("m" . month) ("y" . year))))))
8757 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8758 (setq nmin 1 nmax n)
8759 (org-back-to-heading t)
8760 (setq beg (point))
8761 (setq idprop (org-entry-get nil "ID"))
8762 (org-end-of-subtree t t)
8763 (or (bolp) (insert "\n"))
8764 (setq end (point))
8765 (setq template (buffer-substring beg end))
8766 (when (and doshift
8767 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8768 (delete-region beg end)
8769 (setq end beg)
8770 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8771 (goto-char end)
8772 (loop for n from nmin to nmax do
8773 ;; prepare clone
8774 (with-temp-buffer
8775 (insert template)
8776 (org-mode)
8777 (goto-char (point-min))
8778 (org-show-subtree)
8779 (and idprop (if org-clone-delete-id
8780 (org-entry-delete nil "ID")
8781 (org-id-get-create t)))
8782 (unless (= n 0)
8783 (while (re-search-forward org-clock-re nil t)
8784 (kill-whole-line))
8785 (goto-char (point-min))
8786 (while (re-search-forward drawer-re nil t)
8787 (org-remove-empty-drawer-at (point))))
8788 (goto-char (point-min))
8789 (when doshift
8790 (while (re-search-forward org-ts-regexp-both nil t)
8791 (org-timestamp-change (* n shift-n) shift-what))
8792 (unless (= n n-no-remove)
8793 (goto-char (point-min))
8794 (while (re-search-forward org-ts-regexp nil t)
8795 (save-excursion
8796 (goto-char (match-beginning 0))
8797 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8798 (delete-region (match-beginning 1) (match-end 1)))))))
8799 (setq task (buffer-string)))
8800 (insert task))
8801 (goto-char beg)))
8803 ;;; Outline Sorting
8805 (defun org-sort (with-case)
8806 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8807 Optional argument WITH-CASE means sort case-sensitively."
8808 (interactive "P")
8809 (cond
8810 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8811 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8813 (org-call-with-arg 'org-sort-entries with-case))))
8815 (defun org-sort-remove-invisible (s)
8816 "Remove invisible links from string S."
8817 (remove-text-properties 0 (length s) org-rm-props s)
8818 (while (string-match org-bracket-link-regexp s)
8819 (setq s (replace-match (if (match-end 2)
8820 (match-string 3 s)
8821 (match-string 1 s)) t t s)))
8822 (let ((st (format " %s " s)))
8823 (while (string-match org-emph-re st)
8824 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8825 (setq s (substring st 1 -1)))
8828 (defvar org-priority-regexp) ; defined later in the file
8830 (defvar org-after-sorting-entries-or-items-hook nil
8831 "Hook that is run after a bunch of entries or items have been sorted.
8832 When children are sorted, the cursor is in the parent line when this
8833 hook gets called. When a region or a plain list is sorted, the cursor
8834 will be in the first entry of the sorted region/list.")
8836 (defun org-sort-entries
8837 (&optional with-case sorting-type getkey-func compare-func property)
8838 "Sort entries on a certain level of an outline tree.
8839 If there is an active region, the entries in the region are sorted.
8840 Else, if the cursor is before the first entry, sort the top-level items.
8841 Else, the children of the entry at point are sorted.
8843 Sorting can be alphabetically, numerically, by date/time as given by
8844 a time stamp, by a property, by priority order, or by a custom function.
8846 The command prompts for the sorting type unless it has been given to the
8847 function through the SORTING-TYPE argument, which needs to be a character,
8848 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8849 the precise meaning of each character:
8851 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8852 c By creation time, which is assumed to be the first inactive time stamp
8853 at the beginning of a line.
8854 d By deadline date/time.
8855 k By clocking time.
8856 n Numerically, by converting the beginning of the entry/item to a number.
8857 o By order of TODO keywords.
8858 p By priority according to the cookie.
8859 r By the value of a property.
8860 s By scheduled date/time.
8861 t By date/time, either the first active time stamp in the entry, or, if
8862 none exist, by the first inactive one.
8864 Capital letters will reverse the sort order.
8866 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8867 called with point at the beginning of the record. It must return either
8868 a string or a number that should serve as the sorting key for that record.
8870 Comparing entries ignores case by default. However, with an optional argument
8871 WITH-CASE, the sorting considers case as well.
8873 Sorting is done against the visible part of the headlines, it ignores hidden
8874 links.
8876 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8877 (interactive "P")
8878 (let ((case-func (if with-case 'identity 'downcase))
8879 (cmstr
8880 ;; The clock marker is lost when using `sort-subr', let's
8881 ;; store the clocking string.
8882 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8883 (save-excursion
8884 (goto-char org-clock-marker)
8885 (looking-back "^.*") (match-string-no-properties 0))))
8886 start beg end stars re re2
8887 txt what tmp)
8888 ;; Find beginning and end of region to sort
8889 (cond
8890 ((org-region-active-p)
8891 ;; we will sort the region
8892 (setq end (region-end)
8893 what "region")
8894 (goto-char (region-beginning))
8895 (if (not (org-at-heading-p)) (outline-next-heading))
8896 (setq start (point)))
8897 ((or (org-at-heading-p)
8898 (ignore-errors (progn (org-back-to-heading) t)))
8899 ;; we will sort the children of the current headline
8900 (org-back-to-heading)
8901 (setq start (point)
8902 end (progn (org-end-of-subtree t t)
8903 (or (bolp) (insert "\n"))
8904 (when (>= (org-back-over-empty-lines) 1)
8905 (forward-line 1))
8906 (point))
8907 what "children")
8908 (goto-char start)
8909 (show-subtree)
8910 (outline-next-heading))
8912 ;; we will sort the top-level entries in this file
8913 (goto-char (point-min))
8914 (or (org-at-heading-p) (outline-next-heading))
8915 (setq start (point))
8916 (goto-char (point-max))
8917 (beginning-of-line 1)
8918 (when (looking-at ".*?\\S-")
8919 ;; File ends in a non-white line
8920 (end-of-line 1)
8921 (insert "\n"))
8922 (setq end (point-max))
8923 (setq what "top-level")
8924 (goto-char start)
8925 (show-all)))
8927 (setq beg (point))
8928 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8930 (looking-at "\\(\\*+\\)")
8931 (setq stars (match-string 1)
8932 re (concat "^" (regexp-quote stars) " +")
8933 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8934 txt (buffer-substring beg end))
8935 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8936 (if (and (not (equal stars "*")) (string-match re2 txt))
8937 (user-error "Region to sort contains a level above the first entry"))
8939 (unless sorting-type
8940 (message
8941 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8942 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8943 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8944 what)
8945 (setq sorting-type (read-char-exclusive))
8947 (unless getkey-func
8948 (and (= (downcase sorting-type) ?f)
8949 (setq getkey-func
8950 (org-icompleting-read "Sort using function: "
8951 obarray 'fboundp t nil nil))
8952 (setq getkey-func (intern getkey-func))))
8954 (and (= (downcase sorting-type) ?r)
8955 (not property)
8956 (setq property
8957 (org-icompleting-read "Property: "
8958 (mapcar 'list (org-buffer-property-keys t))
8959 nil t))))
8961 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8962 (message "Sorting entries...")
8964 (save-restriction
8965 (narrow-to-region start end)
8966 (let ((dcst (downcase sorting-type))
8967 (case-fold-search nil)
8968 (now (current-time)))
8969 (sort-subr
8970 (/= dcst sorting-type)
8971 ;; This function moves to the beginning character of the "record" to
8972 ;; be sorted.
8973 (lambda nil
8974 (if (re-search-forward re nil t)
8975 (goto-char (match-beginning 0))
8976 (goto-char (point-max))))
8977 ;; This function moves to the last character of the "record" being
8978 ;; sorted.
8979 (lambda nil
8980 (save-match-data
8981 (condition-case nil
8982 (outline-forward-same-level 1)
8983 (error
8984 (goto-char (point-max))))))
8985 ;; This function returns the value that gets sorted against.
8986 (lambda nil
8987 (cond
8988 ((= dcst ?n)
8989 (if (looking-at org-complex-heading-regexp)
8990 (string-to-number (org-sort-remove-invisible (match-string 4)))
8991 nil))
8992 ((= dcst ?a)
8993 (if (looking-at org-complex-heading-regexp)
8994 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8995 nil))
8996 ((= dcst ?k)
8997 (or (get-text-property (point) :org-clock-minutes) 0))
8998 ((= dcst ?t)
8999 (let ((end (save-excursion (outline-next-heading) (point))))
9000 (if (or (re-search-forward org-ts-regexp end t)
9001 (re-search-forward org-ts-regexp-both end t))
9002 (org-time-string-to-seconds (match-string 0))
9003 (org-float-time now))))
9004 ((= dcst ?c)
9005 (let ((end (save-excursion (outline-next-heading) (point))))
9006 (if (re-search-forward
9007 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9008 end t)
9009 (org-time-string-to-seconds (match-string 0))
9010 (org-float-time now))))
9011 ((= dcst ?s)
9012 (let ((end (save-excursion (outline-next-heading) (point))))
9013 (if (re-search-forward org-scheduled-time-regexp end t)
9014 (org-time-string-to-seconds (match-string 1))
9015 (org-float-time now))))
9016 ((= dcst ?d)
9017 (let ((end (save-excursion (outline-next-heading) (point))))
9018 (if (re-search-forward org-deadline-time-regexp end t)
9019 (org-time-string-to-seconds (match-string 1))
9020 (org-float-time now))))
9021 ((= dcst ?p)
9022 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9023 (string-to-char (match-string 2))
9024 org-default-priority))
9025 ((= dcst ?r)
9026 (or (org-entry-get nil property) ""))
9027 ((= dcst ?o)
9028 (if (looking-at org-complex-heading-regexp)
9029 (let* ((m (match-string 2))
9030 (s (if (member m org-done-keywords) '- '+)))
9031 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9032 ((= dcst ?f)
9033 (if getkey-func
9034 (progn
9035 (setq tmp (funcall getkey-func))
9036 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9037 tmp)
9038 (error "Invalid key function `%s'" getkey-func)))
9039 (t (error "Invalid sorting type `%c'" sorting-type))))
9041 (cond
9042 ((= dcst ?a) 'string<)
9043 ((= dcst ?f) compare-func)
9044 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9045 (run-hooks 'org-after-sorting-entries-or-items-hook)
9046 ;; Reset the clock marker if needed
9047 (when cmstr
9048 (save-excursion
9049 (goto-char start)
9050 (search-forward cmstr nil t)
9051 (move-marker org-clock-marker (point))))
9052 (message "Sorting entries...done")))
9054 (defun org-do-sort (table what &optional with-case sorting-type)
9055 "Sort TABLE of WHAT according to SORTING-TYPE.
9056 The user will be prompted for the SORTING-TYPE if the call to this
9057 function does not specify it.
9058 WHAT is only for the prompt, to indicate what is being sorted.
9059 The sorting key will be extracted from the car of the elements of
9060 the table.
9061 If WITH-CASE is non-nil, the sorting will be case-sensitive."
9062 (unless sorting-type
9063 (message
9064 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
9065 what)
9066 (setq sorting-type (read-char-exclusive)))
9067 (let ((dcst (downcase sorting-type))
9068 extractfun comparefun)
9069 ;; Define the appropriate functions
9070 (cond
9071 ((= dcst ?n)
9072 (setq extractfun 'string-to-number
9073 comparefun (if (= dcst sorting-type) '< '>)))
9074 ((= dcst ?a)
9075 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
9076 (lambda(x) (downcase (org-sort-remove-invisible x))))
9077 comparefun (if (= dcst sorting-type)
9078 'string<
9079 (lambda (a b) (and (not (string< a b))
9080 (not (string= a b)))))))
9081 ((= dcst ?t)
9082 (setq extractfun
9083 (lambda (x)
9084 (cond ((or (string-match org-ts-regexp x)
9085 (string-match org-ts-regexp-both x))
9086 (org-float-time
9087 (org-time-string-to-time (match-string 0 x))))
9088 ((string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" x)
9089 (org-hh:mm-string-to-minutes x))
9090 (t 0)))
9091 comparefun (if (= dcst sorting-type) '< '>)))
9092 (t (error "Invalid sorting type `%c'" sorting-type)))
9094 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
9095 table)
9096 (lambda (a b) (funcall comparefun (car a) (car b))))))
9099 ;;; The orgstruct minor mode
9101 ;; Define a minor mode which can be used in other modes in order to
9102 ;; integrate the org-mode structure editing commands.
9104 ;; This is really a hack, because the org-mode structure commands use
9105 ;; keys which normally belong to the major mode. Here is how it
9106 ;; works: The minor mode defines all the keys necessary to operate the
9107 ;; structure commands, but wraps the commands into a function which
9108 ;; tests if the cursor is currently at a headline or a plain list
9109 ;; item. If that is the case, the structure command is used,
9110 ;; temporarily setting many Org-mode variables like regular
9111 ;; expressions for filling etc. However, when any of those keys is
9112 ;; used at a different location, function uses `key-binding' to look
9113 ;; up if the key has an associated command in another currently active
9114 ;; keymap (minor modes, major mode, global), and executes that
9115 ;; command. There might be problems if any of the keys is otherwise
9116 ;; used as a prefix key.
9118 (defcustom orgstruct-heading-prefix-regexp ""
9119 "Regexp that matches the custom prefix of Org headlines in
9120 orgstruct(++)-mode."
9121 :group 'org
9122 :version "24.4"
9123 :package-version '(Org . "8.3")
9124 :type 'regexp)
9125 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9127 (defcustom orgstruct-setup-hook nil
9128 "Hook run after orgstruct-mode-map is filled."
9129 :group 'org
9130 :version "24.4"
9131 :package-version '(Org . "8.0")
9132 :type 'hook)
9134 (defvar orgstruct-initialized nil)
9136 (defvar org-local-vars nil
9137 "List of local variables, for use by `orgstruct-mode'.")
9139 ;;;###autoload
9140 (define-minor-mode orgstruct-mode
9141 "Toggle the minor mode `orgstruct-mode'.
9142 This mode is for using Org-mode structure commands in other
9143 modes. The following keys behave as if Org-mode were active, if
9144 the cursor is on a headline, or on a plain list item (both as
9145 defined by Org-mode)."
9146 nil " OrgStruct" (make-sparse-keymap)
9147 (funcall (if orgstruct-mode
9148 'add-to-invisibility-spec
9149 'remove-from-invisibility-spec)
9150 '(outline . t))
9151 (when orgstruct-mode
9152 (org-load-modules-maybe)
9153 (unless orgstruct-initialized
9154 (orgstruct-setup)
9155 (setq orgstruct-initialized t))))
9157 ;;;###autoload
9158 (defun turn-on-orgstruct ()
9159 "Unconditionally turn on `orgstruct-mode'."
9160 (orgstruct-mode 1))
9162 (defvar org-fb-vars nil)
9163 (make-variable-buffer-local 'org-fb-vars)
9164 (defun orgstruct++-mode (&optional arg)
9165 "Toggle `orgstruct-mode', the enhanced version of it.
9166 In addition to setting orgstruct-mode, this also exports all
9167 indentation and autofilling variables from org-mode into the
9168 buffer. It will also recognize item context in multiline items."
9169 (interactive "P")
9170 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9171 (if (< arg 1)
9172 (progn (orgstruct-mode -1)
9173 (mapc (lambda(v)
9174 (org-set-local (car v)
9175 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9176 org-fb-vars))
9177 (orgstruct-mode 1)
9178 (setq org-fb-vars nil)
9179 (unless org-local-vars
9180 (setq org-local-vars (org-get-local-variables)))
9181 (let (var val)
9182 (mapc
9183 (lambda (x)
9184 (when (string-match
9185 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9186 (symbol-name (car x)))
9187 (setq var (car x) val (nth 1 x))
9188 (push (list var `(quote ,(eval var))) org-fb-vars)
9189 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9190 org-local-vars)
9191 (org-set-local 'orgstruct-is-++ t))))
9193 (defvar orgstruct-is-++ nil
9194 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9195 (make-variable-buffer-local 'orgstruct-is-++)
9197 ;;;###autoload
9198 (defun turn-on-orgstruct++ ()
9199 "Unconditionally turn on `orgstruct++-mode'."
9200 (orgstruct++-mode 1))
9202 (defun orgstruct-error ()
9203 "Error when there is no default binding for a structure key."
9204 (interactive)
9205 (funcall (if (fboundp 'user-error)
9206 'user-error
9207 'error)
9208 "This key has no function outside structure elements"))
9210 (defun orgstruct-setup ()
9211 "Setup orgstruct keymap."
9212 (dolist (cell '((org-demote . t)
9213 (org-metaleft . t)
9214 (org-metaright . t)
9215 (org-promote . t)
9216 (org-shiftmetaleft . t)
9217 (org-shiftmetaright . t)
9218 org-backward-element
9219 org-backward-heading-same-level
9220 org-ctrl-c-ret
9221 org-ctrl-c-minus
9222 org-ctrl-c-star
9223 org-cycle
9224 org-forward-heading-same-level
9225 org-insert-heading
9226 org-insert-heading-respect-content
9227 org-kill-note-or-show-branches
9228 org-mark-subtree
9229 org-meta-return
9230 org-metadown
9231 org-metaup
9232 org-narrow-to-subtree
9233 org-promote-subtree
9234 org-reveal
9235 org-shiftdown
9236 org-shiftleft
9237 org-shiftmetadown
9238 org-shiftmetaup
9239 org-shiftright
9240 org-shifttab
9241 org-shifttab
9242 org-shiftup
9243 org-show-subtree
9244 org-sort
9245 org-up-element
9246 outline-demote
9247 outline-next-visible-heading
9248 outline-previous-visible-heading
9249 outline-promote
9250 outline-up-heading
9251 show-children))
9252 (let ((f (or (car-safe cell) cell))
9253 (disable-when-heading-prefix (cdr-safe cell)))
9254 (when (fboundp f)
9255 (let ((new-bindings))
9256 (dolist (binding (nconc (where-is-internal f org-mode-map)
9257 (where-is-internal f outline-mode-map)))
9258 (push binding new-bindings)
9259 ;; TODO use local-function-key-map
9260 (dolist (rep '(("<tab>" . "TAB")
9261 ("<return>" . "RET")
9262 ("<escape>" . "ESC")
9263 ("<delete>" . "DEL")))
9264 (setq binding (read-kbd-macro
9265 (let ((case-fold-search))
9266 (replace-regexp-in-string
9267 (regexp-quote (cdr rep))
9268 (car rep)
9269 (key-description binding)))))
9270 (pushnew binding new-bindings :test 'equal)))
9271 (dolist (binding new-bindings)
9272 (let ((key (lookup-key orgstruct-mode-map binding)))
9273 (when (or (not key) (numberp key))
9274 (ignore-errors
9275 (org-defkey orgstruct-mode-map
9276 binding
9277 (orgstruct-make-binding
9278 f binding disable-when-heading-prefix))))))))))
9279 (run-hooks 'orgstruct-setup-hook))
9281 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9282 "Create a function for binding in the structure minor mode.
9283 FUN is the command to call inside a table. KEY is the key that
9284 should be checked in for a command to execute outside of tables.
9285 Non-nil `disable-when-heading-prefix' means to disable the command
9286 if `orgstruct-heading-prefix-regexp' is not empty."
9287 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9288 (let ((nname name)
9289 (i 0))
9290 (while (fboundp (intern nname))
9291 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9292 (setq name (intern nname)))
9293 (eval
9294 (let ((bindings '((org-heading-regexp
9295 (concat "^"
9296 orgstruct-heading-prefix-regexp
9297 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9298 (org-outline-regexp
9299 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9300 (org-outline-regexp-bol
9301 (concat "^" org-outline-regexp))
9302 (outline-regexp org-outline-regexp)
9303 (outline-heading-end-regexp "\n")
9304 (outline-level 'org-outline-level)
9305 (outline-heading-alist))))
9306 `(defun ,name (arg)
9307 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9308 "Outside of structure, run the binding of `"
9309 (key-description key) "'."
9310 (when disable-when-heading-prefix
9311 (concat
9312 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9313 "back to the default binding due to limitations of Org's implementation of\n"
9314 "`" (symbol-name fun) "'.")))
9315 (interactive "p")
9316 (let* ((disable
9317 ,(and disable-when-heading-prefix
9318 '(not (string= orgstruct-heading-prefix-regexp ""))))
9319 (fallback
9320 (or disable
9321 (not
9322 (let* ,bindings
9323 (org-context-p 'headline 'item
9324 ,(when (memq fun
9325 '(org-insert-heading
9326 org-insert-heading-respect-content
9327 org-meta-return))
9328 '(when orgstruct-is-++
9329 'item-body))))))))
9330 (if fallback
9331 (let* ((orgstruct-mode)
9332 (binding
9333 (let ((key ,key))
9334 (catch 'exit
9335 (dolist
9336 (rep
9337 '(nil
9338 ("<\\([^>]*\\)tab>" . "\\1TAB")
9339 ("<\\([^>]*\\)return>" . "\\1RET")
9340 ("<\\([^>]*\\)escape>" . "\\1ESC")
9341 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9342 nil)
9343 (when rep
9344 (setq key (read-kbd-macro
9345 (let ((case-fold-search))
9346 (replace-regexp-in-string
9347 (car rep)
9348 (cdr rep)
9349 (key-description key))))))
9350 (when (key-binding key)
9351 (throw 'exit (key-binding key))))))))
9352 (if (keymapp binding)
9353 (org-set-transient-map binding)
9354 (let ((func (or binding
9355 (unless disable
9356 'orgstruct-error))))
9357 (when func
9358 (call-interactively func)))))
9359 (org-run-like-in-org-mode
9360 (lambda ()
9361 (interactive)
9362 (let* ,bindings
9363 (call-interactively ',fun)))))))))
9364 name))
9366 (defun org-contextualize-keys (alist contexts)
9367 "Return valid elements in ALIST depending on CONTEXTS.
9369 `org-agenda-custom-commands' or `org-capture-templates' are the
9370 values used for ALIST, and `org-agenda-custom-commands-contexts'
9371 or `org-capture-templates-contexts' are the associated contexts
9372 definitions."
9373 (let ((contexts
9374 ;; normalize contexts
9375 (mapcar
9376 (lambda(c) (cond ((listp (cadr c))
9377 (list (car c) (car c) (cadr c)))
9378 ((string= "" (cadr c))
9379 (list (car c) (car c) (caddr c)))
9380 (t c))) contexts))
9381 (a alist) c r s)
9382 ;; loop over all commands or templates
9383 (while (setq c (pop a))
9384 (let (vrules repl)
9385 (cond
9386 ((not (assoc (car c) contexts))
9387 (push c r))
9388 ((and (assoc (car c) contexts)
9389 (setq vrules (org-contextualize-validate-key
9390 (car c) contexts)))
9391 (mapc (lambda (vr)
9392 (when (not (equal (car vr) (cadr vr)))
9393 (setq repl vr))) vrules)
9394 (if (not repl) (push c r)
9395 (push (cadr repl) s)
9396 (push
9397 (cons (car c)
9398 (cdr (or (assoc (cadr repl) alist)
9399 (error "Undefined key `%s' as contextual replacement for `%s'"
9400 (cadr repl) (car c)))))
9401 r))))))
9402 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9403 (delq
9405 (delete-dups
9406 (mapcar (lambda (x)
9407 (let ((tpl (car x)))
9408 (when (not (delq
9410 (mapcar (lambda(y)
9411 (equal y tpl)) s))) x)))
9412 (reverse r))))))
9414 (defun org-contextualize-validate-key (key contexts)
9415 "Check CONTEXTS for agenda or capture KEY."
9416 (let (r rr res)
9417 (while (setq r (pop contexts))
9418 (mapc
9419 (lambda (rr)
9420 (when
9421 (and (equal key (car r))
9422 (if (functionp rr) (funcall rr)
9423 (or (and (eq (car rr) 'in-file)
9424 (buffer-file-name)
9425 (string-match (cdr rr) (buffer-file-name)))
9426 (and (eq (car rr) 'in-mode)
9427 (string-match (cdr rr) (symbol-name major-mode)))
9428 (and (eq (car rr) 'in-buffer)
9429 (string-match (cdr rr) (buffer-name)))
9430 (when (and (eq (car rr) 'not-in-file)
9431 (buffer-file-name))
9432 (not (string-match (cdr rr) (buffer-file-name))))
9433 (when (eq (car rr) 'not-in-mode)
9434 (not (string-match (cdr rr) (symbol-name major-mode))))
9435 (when (eq (car rr) 'not-in-buffer)
9436 (not (string-match (cdr rr) (buffer-name)))))))
9437 (push r res)))
9438 (car (last r))))
9439 (delete-dups (delq nil res))))
9441 (defun org-context-p (&rest contexts)
9442 "Check if local context is any of CONTEXTS.
9443 Possible values in the list of contexts are `table', `headline', and `item'."
9444 (let ((pos (point)))
9445 (goto-char (point-at-bol))
9446 (prog1 (or (and (memq 'table contexts)
9447 (looking-at "[ \t]*|"))
9448 (and (memq 'headline contexts)
9449 (looking-at org-outline-regexp))
9450 (and (memq 'item contexts)
9451 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9452 (and (memq 'item-body contexts)
9453 (org-in-item-p)))
9454 (goto-char pos))))
9456 (defun org-get-local-variables ()
9457 "Return a list of all local variables in an Org mode buffer."
9458 (let (varlist)
9459 (with-current-buffer (get-buffer-create "*Org tmp*")
9460 (erase-buffer)
9461 (org-mode)
9462 (setq varlist (buffer-local-variables)))
9463 (kill-buffer "*Org tmp*")
9464 (delq nil
9465 (mapcar
9466 (lambda (x)
9467 (setq x
9468 (if (symbolp x)
9469 (list x)
9470 (list (car x) (cdr x))))
9471 (if (and (not (get (car x) 'org-state))
9472 (string-match
9473 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9474 (symbol-name (car x))))
9475 x nil))
9476 varlist))))
9478 (defun org-clone-local-variables (from-buffer &optional regexp)
9479 "Clone local variables from FROM-BUFFER.
9480 Optional argument REGEXP selects variables to clone."
9481 (mapc
9482 (lambda (pair)
9483 (and (symbolp (car pair))
9484 (or (null regexp)
9485 (string-match regexp (symbol-name (car pair))))
9486 (set (make-local-variable (car pair))
9487 (cdr pair))))
9488 (buffer-local-variables from-buffer)))
9490 ;;;###autoload
9491 (defun org-run-like-in-org-mode (cmd)
9492 "Run a command, pretending that the current buffer is in Org-mode.
9493 This will temporarily bind local variables that are typically bound in
9494 Org-mode to the values they have in Org-mode, and then interactively
9495 call CMD."
9496 (org-load-modules-maybe)
9497 (unless org-local-vars
9498 (setq org-local-vars (org-get-local-variables)))
9499 (let (binds)
9500 (dolist (var org-local-vars)
9501 (when (or (not (boundp (car var)))
9502 (eq (symbol-value (car var))
9503 (default-value (car var))))
9504 (push (list (car var) `(quote ,(cadr var))) binds)))
9505 (eval `(let ,binds
9506 (call-interactively (quote ,cmd))))))
9508 (defun org-get-category (&optional pos force-refresh)
9509 "Get the category applying to position POS."
9510 (save-match-data
9511 (if force-refresh (org-refresh-category-properties))
9512 (let ((pos (or pos (point))))
9513 (or (get-text-property pos 'org-category)
9514 (progn (org-refresh-category-properties)
9515 (get-text-property pos 'org-category))))))
9517 ;;; Refresh properties
9519 (defun org-refresh-properties (dprop tprop)
9520 "Refresh buffer text properties.
9521 DPROP is the drawer property and TPROP is either the
9522 corresponding text property to set, or an alist with each element
9523 being a text property (as a symbol) and a function to apply to
9524 the value of the drawer property."
9525 (let ((case-fold-search t)
9526 (inhibit-read-only t))
9527 (org-with-silent-modifications
9528 (save-excursion
9529 (save-restriction
9530 (widen)
9531 (goto-char (point-min))
9532 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9533 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9535 (defun org-refresh-property (tprop p)
9536 "Refresh the buffer text property TPROP from the drawer property P.
9537 The refresh happens only for the current tree (not subtree)."
9538 (save-excursion
9539 (org-back-to-heading t)
9540 ;; tprop is a text property symbol
9541 (if (symbolp tprop)
9542 (put-text-property
9543 (point) (or (outline-next-heading) (point-max)) tprop p)
9544 ;; tprop is an alist with (properties . function) elements
9545 (mapc (lambda(al)
9546 (save-excursion
9547 (put-text-property
9548 (point-at-bol) (or (outline-next-heading) (point-max))
9549 (car al)
9550 (funcall (cdr al) p))))
9551 tprop))))
9553 (defun org-refresh-category-properties ()
9554 "Refresh category text properties in the buffer."
9555 (let ((case-fold-search t)
9556 (inhibit-read-only t)
9557 (def-cat (cond
9558 ((null org-category)
9559 (if buffer-file-name
9560 (file-name-sans-extension
9561 (file-name-nondirectory buffer-file-name))
9562 "???"))
9563 ((symbolp org-category) (symbol-name org-category))
9564 (t org-category)))
9565 beg end cat pos optionp)
9566 (org-with-silent-modifications
9567 (save-excursion
9568 (save-restriction
9569 (widen)
9570 (goto-char (point-min))
9571 (put-text-property (point) (point-max) 'org-category def-cat)
9572 (while (re-search-forward
9573 "^[ \t]*\\(\\(?:#\\+\\|:\\)CATEGORY:\\)\\(.*\\)" nil t)
9574 (setq pos (match-end 0)
9575 optionp (equal (char-after (match-beginning 0)) ?#)
9576 cat (org-trim (match-string 2)))
9577 (if optionp
9578 (setq beg (point-at-bol) end (point-max))
9579 (org-back-to-heading t)
9580 (setq beg (point) end (org-end-of-subtree t t)))
9581 (put-text-property beg end 'org-category cat)
9582 (goto-char pos)))))))
9584 (defun org-refresh-stats-properties ()
9585 "Refresh stats text properties in the buffer."
9586 (let (stats)
9587 (org-with-silent-modifications
9588 (save-excursion
9589 (save-restriction
9590 (widen)
9591 (goto-char (point-min))
9592 (while (re-search-forward
9593 (concat org-outline-regexp-bol ".*"
9594 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9595 nil t)
9596 (setq stats (cond ((equal (match-string 3) "0") 0)
9597 ((match-string 2)
9598 (/ (* (string-to-number (match-string 2)) 100)
9599 (string-to-number (match-string 3))))
9600 (t (string-to-number (match-string 1)))))
9601 (org-back-to-heading t)
9602 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9603 'org-stats stats)))))))
9605 (defun org-refresh-effort-properties ()
9606 "Refresh effort properties"
9607 (org-refresh-properties
9608 org-effort-property
9609 '((effort . identity)
9610 (effort-minutes . org-duration-string-to-minutes))))
9612 ;;;; Link Stuff
9614 ;;; Link abbreviations
9616 (defun org-link-expand-abbrev (link)
9617 "Apply replacements as defined in `org-link-abbrev-alist'."
9618 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9619 (let* ((key (match-string 1 link))
9620 (as (or (assoc key org-link-abbrev-alist-local)
9621 (assoc key org-link-abbrev-alist)))
9622 (tag (and (match-end 2) (match-string 3 link)))
9623 rpl)
9624 (if (not as)
9625 link
9626 (setq rpl (cdr as))
9627 (cond
9628 ((symbolp rpl) (funcall rpl tag))
9629 ((string-match "%(\\([^)]+\\))" rpl)
9630 (replace-match
9631 (save-match-data
9632 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9633 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9634 ((string-match "%h" rpl)
9635 (replace-match (url-hexify-string (or tag "")) t t rpl))
9636 (t (concat rpl tag)))))
9637 link))
9639 ;;; Storing and inserting links
9641 (defvar org-insert-link-history nil
9642 "Minibuffer history for links inserted with `org-insert-link'.")
9644 (defvar org-stored-links nil
9645 "Contains the links stored with `org-store-link'.")
9647 (defvar org-store-link-plist nil
9648 "Plist with info about the most recently link created with `org-store-link'.")
9650 (defvar org-link-protocols nil
9651 "Link protocols added to Org-mode using `org-add-link-type'.")
9653 (defvar org-store-link-functions nil
9654 "List of functions that are called to create and store a link.
9655 Each function will be called in turn until one returns a non-nil
9656 value. Each function should check if it is responsible for creating
9657 this link (for example by looking at the major mode).
9658 If not, it must exit and return nil.
9659 If yes, it should return a non-nil value after a calling
9660 `org-store-link-props' with a list of properties and values.
9661 Special properties are:
9663 :type The link prefix, like \"http\". This must be given.
9664 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9665 This is obligatory as well.
9666 :description Optional default description for the second pair
9667 of brackets in an Org-mode link. The user can still change
9668 this when inserting this link into an Org-mode buffer.
9670 In addition to these, any additional properties can be specified
9671 and then used in capture templates.")
9673 (defun org-add-link-type (type &optional follow export)
9674 "Add TYPE to the list of `org-link-types'.
9675 Re-compute all regular expressions depending on `org-link-types'
9677 FOLLOW and EXPORT are two functions.
9679 FOLLOW should take the link path as the single argument and do whatever
9680 is necessary to follow the link, for example find a file or display
9681 a mail message.
9683 EXPORT should format the link path for export to one of the export formats.
9684 It should be a function accepting three arguments:
9686 path the path of the link, the text after the prefix (like \"http:\")
9687 desc the description of the link, if any, or a description added by
9688 org-export-normalize-links if there is none
9689 format the export format, a symbol like `html' or `latex' or `ascii'..
9691 The function may use the FORMAT information to return different values
9692 depending on the format. The return value will be put literally into
9693 the exported file. If the return value is nil, this means Org should
9694 do what it normally does with links which do not have EXPORT defined.
9696 Org mode has a built-in default for exporting links. If you are happy with
9697 this default, there is no need to define an export function for the link
9698 type. For a simple example of an export function, see `org-bbdb.el'."
9699 (add-to-list 'org-link-types type t)
9700 (org-make-link-regexps)
9701 (org-element-update-syntax)
9702 (if (assoc type org-link-protocols)
9703 (setcdr (assoc type org-link-protocols) (list follow export))
9704 (push (list type follow export) org-link-protocols)))
9706 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9707 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9709 ;;;###autoload
9710 (defun org-store-link (arg)
9711 "\\<org-mode-map>Store an org-link to the current location.
9712 This link is added to `org-stored-links' and can later be inserted
9713 into an org-buffer with \\[org-insert-link].
9715 For some link types, a prefix arg is interpreted.
9716 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9717 For file links, arg negates `org-context-in-file-links'.
9719 A double prefix arg force skipping storing functions that are not
9720 part of Org's core.
9722 A triple prefix arg force storing a link for each line in the
9723 active region."
9724 (interactive "P")
9725 (org-load-modules-maybe)
9726 (if (and (equal arg '(64)) (org-region-active-p))
9727 (save-excursion
9728 (let ((end (region-end)))
9729 (goto-char (region-beginning))
9730 (set-mark (point))
9731 (while (< (point-at-eol) end)
9732 (move-end-of-line 1) (activate-mark)
9733 (let (current-prefix-arg)
9734 (call-interactively 'org-store-link))
9735 (move-beginning-of-line 2)
9736 (set-mark (point)))))
9737 (org-with-limited-levels
9738 (setq org-store-link-plist nil)
9739 (let (link cpltxt desc description search
9740 txt custom-id agenda-link sfuns sfunsn)
9741 (cond
9743 ;; Store a link using an external link type
9744 ((and (not (equal arg '(16)))
9745 (setq sfuns
9746 (delq
9747 nil (mapcar (lambda (f)
9748 (let (fs) (if (funcall f) (push f fs))))
9749 org-store-link-functions))
9750 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9751 (or (and (cdr sfuns)
9752 (funcall (intern
9753 (completing-read
9754 "Which function for creating the link? "
9755 sfunsn nil t (car sfunsn)))))
9756 (funcall (caar sfuns)))
9757 (setq link (plist-get org-store-link-plist :link)
9758 desc (or (plist-get org-store-link-plist
9759 :description) link))))
9761 ;; Store a link from a source code buffer
9762 ((org-src-edit-buffer-p)
9763 (let (label gc)
9764 (while (or (not label)
9765 (save-excursion
9766 (save-restriction
9767 (widen)
9768 (goto-char (point-min))
9769 (re-search-forward
9770 (regexp-quote (format org-coderef-label-format label))
9771 nil t))))
9772 (when label (message "Label exists already") (sit-for 2))
9773 (setq label (read-string "Code line label: " label)))
9774 (end-of-line 1)
9775 (setq link (format org-coderef-label-format label))
9776 (setq gc (- 79 (length link)))
9777 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9778 (insert link)
9779 (setq link (concat "(" label ")") desc nil)))
9781 ;; We are in the agenda, link to referenced location
9782 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9783 (let ((m (or (get-text-property (point) 'org-hd-marker)
9784 (get-text-property (point) 'org-marker))))
9785 (when m
9786 (org-with-point-at m
9787 (setq agenda-link
9788 (if (org-called-interactively-p 'any)
9789 (call-interactively 'org-store-link)
9790 (org-store-link nil)))))))
9792 ((eq major-mode 'calendar-mode)
9793 (let ((cd (calendar-cursor-to-date)))
9794 (setq link
9795 (format-time-string
9796 (car org-time-stamp-formats)
9797 (apply 'encode-time
9798 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9799 nil nil nil))))
9800 (org-store-link-props :type "calendar" :date cd)))
9802 ((eq major-mode 'help-mode)
9803 (setq link (concat "help:" (save-excursion
9804 (goto-char (point-min))
9805 (looking-at "^[^ ]+")
9806 (match-string 0))))
9807 (org-store-link-props :type "help"))
9809 ((eq major-mode 'w3-mode)
9810 (setq cpltxt (if (and (buffer-name)
9811 (not (string-match "Untitled" (buffer-name))))
9812 (buffer-name)
9813 (url-view-url t))
9814 link (url-view-url t))
9815 (org-store-link-props :type "w3" :url (url-view-url t)))
9817 ((eq major-mode 'image-mode)
9818 (setq cpltxt (concat "file:"
9819 (abbreviate-file-name buffer-file-name))
9820 link cpltxt)
9821 (org-store-link-props :type "image" :file buffer-file-name))
9823 ;; In dired, store a link to the file of the current line
9824 ((derived-mode-p 'dired-mode)
9825 (let ((file (dired-get-filename nil t)))
9826 (setq file (if file
9827 (abbreviate-file-name
9828 (expand-file-name (dired-get-filename nil t)))
9829 ;; otherwise, no file so use current directory.
9830 default-directory))
9831 (setq cpltxt (concat "file:" file)
9832 link cpltxt)))
9834 ((setq search (run-hook-with-args-until-success
9835 'org-create-file-search-functions))
9836 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9837 "::" search))
9838 (setq cpltxt (or description link)))
9840 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9841 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9842 (cond
9843 ;; Store a link using the target at point
9844 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9845 (setq cpltxt
9846 (concat "file:"
9847 (abbreviate-file-name
9848 (buffer-file-name (buffer-base-buffer)))
9849 "::" (match-string 1))
9850 link cpltxt))
9851 ((and (featurep 'org-id)
9852 (or (eq org-id-link-to-org-use-id t)
9853 (and (org-called-interactively-p 'any)
9854 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9855 (and (eq org-id-link-to-org-use-id
9856 'create-if-interactive-and-no-custom-id)
9857 (not custom-id))))
9858 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9859 ;; Store a link using the ID at point
9860 (setq link (condition-case nil
9861 (prog1 (org-id-store-link)
9862 (setq desc (or (plist-get org-store-link-plist
9863 :description)
9864 "")))
9865 (error
9866 ;; Probably before first headline, link only to file
9867 (concat "file:"
9868 (abbreviate-file-name
9869 (buffer-file-name (buffer-base-buffer))))))))
9871 ;; Just link to current headline
9872 (setq cpltxt (concat "file:"
9873 (abbreviate-file-name
9874 (buffer-file-name (buffer-base-buffer)))))
9875 ;; Add a context search string
9876 (when (org-xor org-context-in-file-links arg)
9877 (let* ((ee (org-element-at-point))
9878 (et (org-element-type ee))
9879 (ev (plist-get (cadr ee) :value))
9880 (ek (plist-get (cadr ee) :key))
9881 (eok (and (stringp ek) (string-match "name" ek))))
9882 (setq txt (cond
9883 ((org-at-heading-p) nil)
9884 ((and (eq et 'keyword) eok) ev)
9885 ((org-region-active-p)
9886 (buffer-substring (region-beginning) (region-end)))))
9887 (when (or (null txt) (string-match "\\S-" txt))
9888 (setq cpltxt
9889 (concat cpltxt "::"
9890 (condition-case nil
9891 (org-make-org-heading-search-string txt)
9892 (error "")))
9893 desc (or (and (eq et 'keyword) eok ev)
9894 (nth 4 (ignore-errors (org-heading-components)))
9895 "NONE")))))
9896 (if (string-match "::\\'" cpltxt)
9897 (setq cpltxt (substring cpltxt 0 -2)))
9898 (setq link cpltxt))))
9900 ((buffer-file-name (buffer-base-buffer))
9901 ;; Just link to this file here.
9902 (setq cpltxt (concat "file:"
9903 (abbreviate-file-name
9904 (buffer-file-name (buffer-base-buffer)))))
9905 ;; Add a context string.
9906 (when (org-xor org-context-in-file-links arg)
9907 (setq txt (if (org-region-active-p)
9908 (buffer-substring (region-beginning) (region-end))
9909 (buffer-substring (point-at-bol) (point-at-eol))))
9910 ;; Only use search option if there is some text.
9911 (when (string-match "\\S-" txt)
9912 (setq cpltxt
9913 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9914 desc "NONE")))
9915 (setq link cpltxt))
9917 ((org-called-interactively-p 'interactive)
9918 (user-error "No method for storing a link from this buffer"))
9920 (t (setq link nil)))
9922 ;; We're done setting link and desc, clean up
9923 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9924 (setq link (or link cpltxt)
9925 desc (or desc cpltxt))
9926 (cond ((equal desc "NONE") (setq desc nil))
9927 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9928 (let ((d0 (match-string 3 desc))
9929 (p0 (match-string 5 desc)))
9930 (setq desc
9931 (replace-regexp-in-string
9932 org-bracket-link-regexp
9933 (concat (or p0 d0)
9934 (if (equal (length (match-string 0 desc))
9935 (length desc)) "*" "")) desc)))))
9937 ;; Return the link
9938 (if (not (and (or (org-called-interactively-p 'any)
9939 executing-kbd-macro) link))
9940 (or agenda-link (and link (org-make-link-string link desc)))
9941 (push (list link desc) org-stored-links)
9942 (message "Stored: %s" (or desc link))
9943 (when custom-id
9944 (setq link (concat "file:" (abbreviate-file-name
9945 (buffer-file-name)) "::#" custom-id))
9946 (push (list link desc) org-stored-links))
9947 (car org-stored-links))))))
9949 (defun org-store-link-props (&rest plist)
9950 "Store link properties, extract names and addresses."
9951 (let (x adr)
9952 (when (setq x (plist-get plist :from))
9953 (setq adr (mail-extract-address-components x))
9954 (setq plist (plist-put plist :fromname (car adr)))
9955 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9956 (when (setq x (plist-get plist :to))
9957 (setq adr (mail-extract-address-components x))
9958 (setq plist (plist-put plist :toname (car adr)))
9959 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9960 (let ((from (plist-get plist :from))
9961 (to (plist-get plist :to)))
9962 (when (and from to org-from-is-user-regexp)
9963 (setq plist
9964 (plist-put plist :fromto
9965 (if (string-match org-from-is-user-regexp from)
9966 (concat "to %t")
9967 (concat "from %f"))))))
9968 (setq org-store-link-plist plist))
9970 (defun org-add-link-props (&rest plist)
9971 "Add these properties to the link property list."
9972 (let (key value)
9973 (while plist
9974 (setq key (pop plist) value (pop plist))
9975 (setq org-store-link-plist
9976 (plist-put org-store-link-plist key value)))))
9978 (defun org-email-link-description (&optional fmt)
9979 "Return the description part of an email link.
9980 This takes information from `org-store-link-plist' and formats it
9981 according to FMT (default from `org-email-link-description-format')."
9982 (setq fmt (or fmt org-email-link-description-format))
9983 (let* ((p org-store-link-plist)
9984 (to (plist-get p :toaddress))
9985 (from (plist-get p :fromaddress))
9986 (table
9987 (list
9988 (cons "%c" (plist-get p :fromto))
9989 (cons "%F" (plist-get p :from))
9990 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9991 (cons "%T" (plist-get p :to))
9992 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9993 (cons "%s" (plist-get p :subject))
9994 (cons "%d" (plist-get p :date))
9995 (cons "%m" (plist-get p :message-id)))))
9996 (when (string-match "%c" fmt)
9997 ;; Check if the user wrote this message
9998 (if (and org-from-is-user-regexp from to
9999 (save-match-data (string-match org-from-is-user-regexp from)))
10000 (setq fmt (replace-match "to %t" t t fmt))
10001 (setq fmt (replace-match "from %f" t t fmt))))
10002 (org-replace-escapes fmt table)))
10004 (defun org-make-org-heading-search-string (&optional string)
10005 "Make search string for the current headline or STRING."
10006 (let ((s (or string
10007 (and (derived-mode-p 'org-mode)
10008 (save-excursion
10009 (org-back-to-heading t)
10010 (org-element-property :raw-value (org-element-at-point))))))
10011 (lines org-context-in-file-links))
10012 (or string (setq s (concat "*" s))) ; Add * for headlines
10013 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10014 (when (and string (integerp lines) (> lines 0))
10015 (let ((slines (org-split-string s "\n")))
10016 (when (< lines (length slines))
10017 (setq s (mapconcat
10018 'identity
10019 (reverse (nthcdr (- (length slines) lines)
10020 (reverse slines))) "\n")))))
10021 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10023 (defun org-make-link-string (link &optional description)
10024 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10025 (unless (string-match "\\S-" link)
10026 (error "Empty link"))
10027 (when (and description
10028 (stringp description)
10029 (not (string-match "\\S-" description)))
10030 (setq description nil))
10031 (when (stringp description)
10032 ;; Remove brackets from the description, they are fatal.
10033 (while (string-match "\\[" description)
10034 (setq description (replace-match "{" t t description)))
10035 (while (string-match "\\]" description)
10036 (setq description (replace-match "}" t t description))))
10037 (when (equal link description)
10038 ;; No description needed, it is identical
10039 (setq description nil))
10040 (when (and (not description)
10041 (not (string-match (org-image-file-name-regexp) link))
10042 (not (equal link (org-link-escape link))))
10043 (setq description (org-extract-attributes link)))
10044 (setq link
10045 (cond ((string-match (org-image-file-name-regexp) link) link)
10046 ((string-match org-link-types-re link)
10047 (concat (match-string 1 link)
10048 (org-link-escape (substring link (match-end 1)))))
10049 (t (org-link-escape link))))
10050 (concat "[[" link "]"
10051 (if description (concat "[" description "]") "")
10052 "]"))
10054 (defconst org-link-escape-chars
10055 ;;%20 %5B %5D
10056 '(?\ ?\[ ?\])
10057 "List of characters that should be escaped in a link when stored to Org.
10058 This is the list that is used for internal purposes.")
10060 (defconst org-link-escape-chars-browser
10061 ;;%20 %22
10062 '(?\ ?\")
10063 "List of characters to be escaped before handing over to the browser.
10064 If you consider using this constant then you probably want to use
10065 the function `org-link-escape-browser' instead. See there why
10066 this constant is a candidate to be removed once Org drops support
10067 for Emacs 24.1 and 24.2.")
10069 (defun org-link-escape (text &optional table merge)
10070 "Return percent escaped representation of TEXT.
10071 TEXT is a string with the text to escape.
10072 Optional argument TABLE is a list with characters that should be
10073 escaped. When nil, `org-link-escape-chars' is used.
10074 If optional argument MERGE is set, merge TABLE into
10075 `org-link-escape-chars'."
10076 ;; Don't escape chars in internal links
10077 (if (string-match "^\\*[[:alnum:]]+" text)
10078 text
10079 (cond
10080 ((and table merge)
10081 (mapc (lambda (defchr)
10082 (unless (member defchr table)
10083 (setq table (cons defchr table))))
10084 org-link-escape-chars))
10085 ((null table)
10086 (setq table org-link-escape-chars)))
10087 (mapconcat
10088 (lambda (char)
10089 (if (or (member char table)
10090 (and (or (< char 32) (= char ?\%) (> char 126))
10091 org-url-hexify-p))
10092 (mapconcat (lambda (sequence-element)
10093 (format "%%%.2X" sequence-element))
10094 (or (encode-coding-char char 'utf-8)
10095 (error "Unable to percent escape character: %s"
10096 (char-to-string char))) "")
10097 (char-to-string char))) text "")))
10099 (defun org-link-escape-browser (text)
10100 "Escape some characters before handing over to the browser.
10101 This function is a candidate to be removed together with the
10102 constant `org-link-escape-chars-browser' once Org drops support
10103 for Emacs 24.1 and 24.2. All calls to this function will have to
10104 be replaced with `url-encode-url' which is available since Emacs
10105 24.3.1."
10106 ;; Example with the Org link
10107 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10108 ;; to open the browser with +subject:"Release 8.2" filled into the
10109 ;; query field: In this case the variable TEXT contains the
10110 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10111 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10112 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10113 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10114 (if (fboundp 'url-encode-url)
10115 (url-encode-url text)
10116 (if (org-string-match-p
10117 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10118 text)
10119 (org-link-escape text org-link-escape-chars-browser)
10120 text)))
10122 (defun org-link-unescape (str)
10123 "Unhex hexified Unicode strings as returned from the JavaScript function
10124 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10125 (unless (and (null str) (string= "" str))
10126 (let ((pos 0) (case-fold-search t) unhexed)
10127 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10128 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10129 (setq str (replace-match unhexed t t str))
10130 (setq pos (+ pos (length unhexed))))))
10131 str)
10133 (defun org-link-unescape-compound (hex)
10134 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10135 Note: this function also decodes single byte encodings like
10136 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10137 (save-match-data
10138 (let* ((bytes (cdr (split-string hex "%")))
10139 (ret "")
10140 (eat 0)
10141 (sum 0))
10142 (while bytes
10143 (let* ((val (string-to-number (pop bytes) 16))
10144 (shift-xor
10145 (if (= 0 eat)
10146 (cond
10147 ((>= val 252) (cons 6 252))
10148 ((>= val 248) (cons 5 248))
10149 ((>= val 240) (cons 4 240))
10150 ((>= val 224) (cons 3 224))
10151 ((>= val 192) (cons 2 192))
10152 (t (cons 0 0)))
10153 (cons 6 128))))
10154 (if (>= val 192) (setq eat (car shift-xor)))
10155 (setq val (logxor val (cdr shift-xor)))
10156 (setq sum (+ (lsh sum (car shift-xor)) val))
10157 (if (> eat 0) (setq eat (- eat 1)))
10158 (cond
10159 ((= 0 eat) ;multi byte
10160 (setq ret (concat ret (org-char-to-string sum)))
10161 (setq sum 0))
10162 ((not bytes) ; single byte(s)
10163 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10164 ret)))
10166 (defun org-link-unescape-single-byte-sequence (hex)
10167 "Unhexify hex-encoded single byte character sequences."
10168 (mapconcat (lambda (byte)
10169 (char-to-string (string-to-number byte 16)))
10170 (cdr (split-string hex "%")) ""))
10172 (defun org-xor (a b)
10173 "Exclusive or."
10174 (if a (not b) b))
10176 (defun org-fixup-message-id-for-http (s)
10177 "Replace special characters in a message id, so it can be used in an http query."
10178 (when (string-match "%" s)
10179 (setq s (mapconcat (lambda (c)
10180 (if (eq c ?%)
10181 "%25"
10182 (char-to-string c)))
10183 s "")))
10184 (while (string-match "<" s)
10185 (setq s (replace-match "%3C" t t s)))
10186 (while (string-match ">" s)
10187 (setq s (replace-match "%3E" t t s)))
10188 (while (string-match "@" s)
10189 (setq s (replace-match "%40" t t s)))
10192 (defun org-link-prettify (link)
10193 "Return a human-readable representation of LINK.
10194 The car of LINK must be a raw link.
10195 The cdr of LINK must be either a link description or nil."
10196 (let ((desc (or (cadr link) "<no description>")))
10197 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10198 "<" (car link) ">")))
10200 ;;;###autoload
10201 (defun org-insert-link-global ()
10202 "Insert a link like Org-mode does.
10203 This command can be called in any mode to insert a link in Org-mode syntax."
10204 (interactive)
10205 (org-load-modules-maybe)
10206 (org-run-like-in-org-mode 'org-insert-link))
10208 (defun org-insert-all-links (arg &optional pre post)
10209 "Insert all links in `org-stored-links'.
10210 When a universal prefix, do not delete the links from `org-stored-links'.
10211 When `ARG' is a number, insert the last N link(s).
10212 `PRE' and `POST' are optional arguments to define a string to
10213 prepend or to append."
10214 (interactive "P")
10215 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10216 (links (copy-seq org-stored-links))
10217 (pr (or pre "- "))
10218 (po (or post "\n"))
10219 (cnt 1) l)
10220 (if (null org-stored-links)
10221 (message "No link to insert")
10222 (while (and (or (listp arg) (>= arg cnt))
10223 (setq l (if (listp arg)
10224 (pop links)
10225 (pop org-stored-links))))
10226 (setq cnt (1+ cnt))
10227 (insert pr)
10228 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10229 (insert po)))))
10231 (defun org-insert-last-stored-link (arg)
10232 "Insert the last link stored in `org-stored-links'."
10233 (interactive "p")
10234 (org-insert-all-links arg "" "\n"))
10236 (defun org-link-fontify-links-to-this-file ()
10237 "Fontify links to the current file in `org-stored-links'."
10238 (let ((f (buffer-file-name)) a b)
10239 (setq a (mapcar (lambda(l)
10240 (let ((ll (car l)))
10241 (when (and (string-match "^file:\\(.+\\)::" ll)
10242 (equal f (expand-file-name (match-string 1 ll))))
10243 ll)))
10244 org-stored-links))
10245 (when (featurep 'org-id)
10246 (setq b (mapcar (lambda(l)
10247 (let ((ll (car l)))
10248 (when (and (string-match "^id:\\(.+\\)$" ll)
10249 (equal f (expand-file-name
10250 (or (org-id-find-id-file
10251 (match-string 1 ll)) ""))))
10252 ll)))
10253 org-stored-links)))
10254 (mapcar (lambda(l)
10255 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10256 (delq nil (append a b)))))
10258 (defvar org-link-links-in-this-file nil)
10259 (defun org-insert-link (&optional complete-file link-location default-description)
10260 "Insert a link. At the prompt, enter the link.
10262 Completion can be used to insert any of the link protocol prefixes like
10263 http or ftp in use.
10265 The history can be used to select a link previously stored with
10266 `org-store-link'. When the empty string is entered (i.e. if you just
10267 press RET at the prompt), the link defaults to the most recently
10268 stored link. As SPC triggers completion in the minibuffer, you need to
10269 use M-SPC or C-q SPC to force the insertion of a space character.
10271 You will also be prompted for a description, and if one is given, it will
10272 be displayed in the buffer instead of the link.
10274 If there is already a link at point, this command will allow you to edit link
10275 and description parts.
10277 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10278 be selected using completion. The path to the file will be relative to the
10279 current directory if the file is in the current directory or a subdirectory.
10280 Otherwise, the link will be the absolute path as completed in the minibuffer
10281 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10282 option `org-link-file-path-type'.
10284 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10285 the current directory or below.
10287 With three \\[universal-argument] prefixes, negate the meaning of
10288 `org-keep-stored-link-after-insertion'.
10290 If `org-make-link-description-function' is non-nil, this function will be
10291 called with the link target, and the result will be the default
10292 link description.
10294 If the LINK-LOCATION parameter is non-nil, this value will be
10295 used as the link location instead of reading one interactively.
10297 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10298 be used as the default description."
10299 (interactive "P")
10300 (let* ((wcf (current-window-configuration))
10301 (origbuf (current-buffer))
10302 (region (if (org-region-active-p)
10303 (buffer-substring (region-beginning) (region-end))))
10304 (remove (and region (list (region-beginning) (region-end))))
10305 (desc region)
10306 tmphist ; byte-compile incorrectly complains about this
10307 (link link-location)
10308 (abbrevs org-link-abbrev-alist-local)
10309 entry file all-prefixes auto-desc)
10310 (cond
10311 (link-location) ; specified by arg, just use it.
10312 ((org-in-regexp org-bracket-link-regexp 1)
10313 ;; We do have a link at point, and we are going to edit it.
10314 (setq remove (list (match-beginning 0) (match-end 0)))
10315 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10316 (setq link (read-string "Link: "
10317 (org-link-unescape
10318 (org-match-string-no-properties 1)))))
10319 ((or (org-in-regexp org-angle-link-re)
10320 (org-in-regexp org-plain-link-re))
10321 ;; Convert to bracket link
10322 (setq remove (list (match-beginning 0) (match-end 0))
10323 link (read-string "Link: "
10324 (org-remove-angle-brackets (match-string 0)))))
10325 ((member complete-file '((4) (16)))
10326 ;; Completing read for file names.
10327 (setq link (org-file-complete-link complete-file)))
10329 ;; Read link, with completion for stored links.
10330 (org-link-fontify-links-to-this-file)
10331 (org-switch-to-buffer-other-window "*Org Links*")
10332 (with-current-buffer "*Org Links*"
10333 (erase-buffer)
10334 (insert "Insert a link.
10335 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10336 (when org-stored-links
10337 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10338 (insert (mapconcat 'org-link-prettify
10339 (reverse org-stored-links) "\n")))
10340 (goto-char (point-min)))
10341 (let ((cw (selected-window)))
10342 (select-window (get-buffer-window "*Org Links*" 'visible))
10343 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10344 (unless (pos-visible-in-window-p (point-max))
10345 (org-fit-window-to-buffer))
10346 (and (window-live-p cw) (select-window cw)))
10347 ;; Fake a link history, containing the stored links.
10348 (setq tmphist (append (mapcar 'car org-stored-links)
10349 org-insert-link-history))
10350 (setq all-prefixes (append (mapcar 'car abbrevs)
10351 (mapcar 'car org-link-abbrev-alist)
10352 org-link-types))
10353 (unwind-protect
10354 (progn
10355 (setq link
10356 (org-completing-read
10357 "Link: "
10358 (append
10359 (mapcar (lambda (x) (concat x ":"))
10360 all-prefixes)
10361 (mapcar 'car org-stored-links))
10362 nil nil nil
10363 'tmphist
10364 (caar org-stored-links)))
10365 (if (not (string-match "\\S-" link))
10366 (user-error "No link selected"))
10367 (mapc (lambda(l)
10368 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10369 org-stored-links)
10370 (if (or (member link all-prefixes)
10371 (and (equal ":" (substring link -1))
10372 (member (substring link 0 -1) all-prefixes)
10373 (setq link (substring link 0 -1))))
10374 (setq link (with-current-buffer origbuf
10375 (org-link-try-special-completion link)))))
10376 (set-window-configuration wcf)
10377 (kill-buffer "*Org Links*"))
10378 (setq entry (assoc link org-stored-links))
10379 (or entry (push link org-insert-link-history))
10380 (setq desc (or desc (nth 1 entry)))))
10382 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10383 (not org-keep-stored-link-after-insertion))
10384 (setq org-stored-links (delq (assoc link org-stored-links)
10385 org-stored-links)))
10387 (if (and (string-match org-plain-link-re link)
10388 (not (string-match org-ts-regexp link)))
10389 ;; URL-like link, normalize the use of angular brackets.
10390 (setq link (org-remove-angle-brackets link)))
10392 ;; Check if we are linking to the current file with a search
10393 ;; option If yes, simplify the link by using only the search
10394 ;; option.
10395 (when (and buffer-file-name
10396 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10397 (let* ((path (match-string 1 link))
10398 (case-fold-search nil)
10399 (search (match-string 2 link)))
10400 (save-match-data
10401 (if (equal (file-truename buffer-file-name) (file-truename path))
10402 ;; We are linking to this same file, with a search option
10403 (setq link search)))))
10405 ;; Check if we can/should use a relative path. If yes, simplify the link
10406 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10407 (let* ((type (match-string 1 link))
10408 (path (match-string 2 link))
10409 (origpath path)
10410 (case-fold-search nil))
10411 (cond
10412 ((or (eq org-link-file-path-type 'absolute)
10413 (equal complete-file '(16)))
10414 (setq path (abbreviate-file-name (expand-file-name path))))
10415 ((eq org-link-file-path-type 'noabbrev)
10416 (setq path (expand-file-name path)))
10417 ((eq org-link-file-path-type 'relative)
10418 (setq path (file-relative-name path)))
10420 (save-match-data
10421 (if (string-match (concat "^" (regexp-quote
10422 (expand-file-name
10423 (file-name-as-directory
10424 default-directory))))
10425 (expand-file-name path))
10426 ;; We are linking a file with relative path name.
10427 (setq path (substring (expand-file-name path)
10428 (match-end 0)))
10429 (setq path (abbreviate-file-name (expand-file-name path)))))))
10430 (setq link (concat type path))
10431 (if (equal desc origpath)
10432 (setq desc path))))
10434 (if org-make-link-description-function
10435 (setq desc
10436 (or (condition-case nil
10437 (funcall org-make-link-description-function link desc)
10438 (error (progn (message "Can't get link description from `%s'"
10439 (symbol-name org-make-link-description-function))
10440 (sit-for 2) nil)))
10441 (read-string "Description: " default-description)))
10442 (if default-description (setq desc default-description)
10443 (setq desc (or (and auto-desc desc)
10444 (read-string "Description: " desc)))))
10446 (unless (string-match "\\S-" desc) (setq desc nil))
10447 (if remove (apply 'delete-region remove))
10448 (insert (org-make-link-string link desc))))
10450 (defun org-link-try-special-completion (type)
10451 "If there is completion support for link type TYPE, offer it."
10452 (let ((fun (intern (concat "org-" type "-complete-link"))))
10453 (if (functionp fun)
10454 (funcall fun)
10455 (read-string "Link (no completion support): " (concat type ":")))))
10457 (defun org-file-complete-link (&optional arg)
10458 "Create a file link using completion."
10459 (let (file link)
10460 (setq file (org-iread-file-name "File: "))
10461 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10462 (pwd1 (file-name-as-directory (abbreviate-file-name
10463 (expand-file-name ".")))))
10464 (cond
10465 ((equal arg '(16))
10466 (setq link (concat
10467 "file:"
10468 (abbreviate-file-name (expand-file-name file)))))
10469 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10470 (setq link (concat "file:" (match-string 1 file))))
10471 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10472 (expand-file-name file))
10473 (setq link (concat
10474 "file:" (match-string 1 (expand-file-name file)))))
10475 (t (setq link (concat "file:" file)))))
10476 link))
10478 (defun org-iread-file-name (&rest args)
10479 "Read-file-name using `ido-mode' speedup if available.
10480 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10481 See `read-file-name' for a description of parameters."
10482 (org-without-partial-completion
10483 (if (and org-completion-use-ido
10484 (fboundp 'ido-read-file-name)
10485 (boundp 'ido-mode) ido-mode
10486 (listp (second args)))
10487 (let ((ido-enter-matching-directory nil))
10488 (apply 'ido-read-file-name args))
10489 (apply 'read-file-name args))))
10491 (defun org-completing-read (&rest args)
10492 "Completing-read with SPACE being a normal character."
10493 (let ((enable-recursive-minibuffers t)
10494 (minibuffer-local-completion-map
10495 (copy-keymap minibuffer-local-completion-map)))
10496 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10497 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10498 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10499 (apply 'org-icompleting-read args)))
10501 (defun org-completing-read-no-i (&rest args)
10502 (let (org-completion-use-ido org-completion-use-iswitchb)
10503 (apply 'org-completing-read args)))
10505 (defun org-iswitchb-completing-read (prompt choices &rest args)
10506 "Use iswitch as a completing-read replacement to choose from choices.
10507 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10508 from."
10509 (let* ((iswitchb-use-virtual-buffers nil)
10510 (iswitchb-make-buflist-hook
10511 (lambda ()
10512 (setq iswitchb-temp-buflist choices))))
10513 (iswitchb-read-buffer prompt)))
10515 (defun org-icompleting-read (&rest args)
10516 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10517 (org-without-partial-completion
10518 (if (and org-completion-use-ido
10519 (fboundp 'ido-completing-read)
10520 (boundp 'ido-mode) ido-mode
10521 (listp (second args)))
10522 (let ((ido-enter-matching-directory nil))
10523 (apply 'ido-completing-read (concat (car args))
10524 (if (consp (car (nth 1 args)))
10525 (mapcar 'car (nth 1 args))
10526 (nth 1 args))
10527 (cddr args)))
10528 (if (and org-completion-use-iswitchb
10529 (boundp 'iswitchb-mode) iswitchb-mode
10530 (listp (second args)))
10531 (apply 'org-iswitchb-completing-read (concat (car args))
10532 (if (consp (car (nth 1 args)))
10533 (mapcar 'car (nth 1 args))
10534 (nth 1 args))
10535 (cddr args))
10536 (apply 'completing-read args)))))
10538 (defun org-extract-attributes (s)
10539 "Extract the attributes cookie from a string and set as text property."
10540 (let (a attr (start 0) key value)
10541 (save-match-data
10542 (when (string-match "{{\\([^}]+\\)}}$" s)
10543 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10544 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10545 (setq key (match-string 1 a) value (match-string 2 a)
10546 start (match-end 0)
10547 attr (plist-put attr (intern key) value))))
10548 (org-add-props s nil 'org-attr attr))
10551 ;;; Opening/following a link
10553 (defvar org-link-search-failed nil)
10555 (defvar org-open-link-functions nil
10556 "Hook for functions finding a plain text link.
10557 These functions must take a single argument, the link content.
10558 They will be called for links that look like [[link text][description]]
10559 when LINK TEXT does not have a protocol like \"http:\" and does not look
10560 like a filename (e.g. \"./blue.png\").
10562 These functions will be called *before* Org attempts to resolve the
10563 link by doing text searches in the current buffer - so if you want a
10564 link \"[[target]]\" to still find \"<<target>>\", your function should
10565 handle this as a special case.
10567 When the function does handle the link, it must return a non-nil value.
10568 If it decides that it is not responsible for this link, it must return
10569 nil to indicate that that Org-mode can continue with other options
10570 like exact and fuzzy text search.")
10572 (defun org-next-link (&optional search-backward)
10573 "Move forward to the next link.
10574 If the link is in hidden text, expose it."
10575 (interactive "P")
10576 (when (and org-link-search-failed (eq this-command last-command))
10577 (goto-char (point-min))
10578 (message "Link search wrapped back to beginning of buffer"))
10579 (setq org-link-search-failed nil)
10580 (let* ((pos (point))
10581 (ct (org-context))
10582 (a (assoc :link ct))
10583 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10584 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10585 ((looking-at org-any-link-re)
10586 ;; Don't stay stuck at link without an org-link face
10587 (forward-char (if search-backward -1 1))))
10588 (if (funcall srch-fun org-any-link-re nil t)
10589 (progn
10590 (goto-char (match-beginning 0))
10591 (if (outline-invisible-p) (org-show-context)))
10592 (goto-char pos)
10593 (setq org-link-search-failed t)
10594 (message "No further link found"))))
10596 (defun org-previous-link ()
10597 "Move backward to the previous link.
10598 If the link is in hidden text, expose it."
10599 (interactive)
10600 (funcall 'org-next-link t))
10602 (defun org-translate-link (s)
10603 "Translate a link string if a translation function has been defined."
10604 (if (and org-link-translation-function
10605 (fboundp org-link-translation-function)
10606 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10607 (progn
10608 (setq s (funcall org-link-translation-function
10609 (match-string 1 s) (match-string 2 s)))
10610 (concat (car s) ":" (cdr s)))
10613 (defun org-translate-link-from-planner (type path)
10614 "Translate a link from Emacs Planner syntax so that Org can follow it.
10615 This is still an experimental function, your mileage may vary."
10616 (cond
10617 ((member type '("http" "https" "news" "ftp"))
10618 ;; standard Internet links are the same.
10619 nil)
10620 ((and (equal type "irc") (string-match "^//" path))
10621 ;; Planner has two / at the beginning of an irc link, we have 1.
10622 ;; We should have zero, actually....
10623 (setq path (substring path 1)))
10624 ((and (equal type "lisp") (string-match "^/" path))
10625 ;; Planner has a slash, we do not.
10626 (setq type "elisp" path (substring path 1)))
10627 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10628 ;; A typical message link. Planner has the id after the final slash,
10629 ;; we separate it with a hash mark
10630 (setq path (concat (match-string 1 path) "#"
10631 (org-remove-angle-brackets (match-string 2 path))))))
10632 (cons type path))
10634 (defun org-find-file-at-mouse (ev)
10635 "Open file link or URL at mouse."
10636 (interactive "e")
10637 (mouse-set-point ev)
10638 (org-open-at-point 'in-emacs))
10640 (defun org-open-at-mouse (ev)
10641 "Open file link or URL at mouse.
10642 See the docstring of `org-open-file' for details."
10643 (interactive "e")
10644 (mouse-set-point ev)
10645 (if (eq major-mode 'org-agenda-mode)
10646 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10647 (org-open-at-point))
10649 (defvar org-window-config-before-follow-link nil
10650 "The window configuration before following a link.
10651 This is saved in case the need arises to restore it.")
10653 (defvar org-open-link-marker (make-marker)
10654 "Marker pointing to the location where `org-open-at-point' was called.")
10656 ;;;###autoload
10657 (defun org-open-at-point-global ()
10658 "Follow a link like Org-mode does.
10659 This command can be called in any mode to follow a link that has
10660 Org-mode syntax."
10661 (interactive)
10662 (org-run-like-in-org-mode 'org-open-at-point))
10664 ;;;###autoload
10665 (defun org-open-link-from-string (s &optional arg reference-buffer)
10666 "Open a link in the string S, as if it was in Org-mode."
10667 (interactive "sLink: \nP")
10668 (let ((reference-buffer (or reference-buffer (current-buffer))))
10669 (with-temp-buffer
10670 (let ((org-inhibit-startup (not reference-buffer)))
10671 (org-mode)
10672 (insert s)
10673 (goto-char (point-min))
10674 (when reference-buffer
10675 (setq org-link-abbrev-alist-local
10676 (with-current-buffer reference-buffer
10677 org-link-abbrev-alist-local)))
10678 (org-open-at-point arg reference-buffer)))))
10680 (defvar org-open-at-point-functions nil
10681 "Hook that is run when following a link at point.
10683 Functions in this hook must return t if they identify and follow
10684 a link at point. If they don't find anything interesting at point,
10685 they must return nil.")
10687 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10688 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10689 (defun org-open-at-point (&optional arg reference-buffer)
10690 "Open link, timestamp, footnote or tags at point.
10692 When point is on a link, follow it. Normally, files will be
10693 opened by an appropriate application. If the optional prefix
10694 argument ARG is non-nil, Emacs will visit the file. With
10695 a double prefix argument, try to open outside of Emacs, in the
10696 application the system uses for this file type.
10698 When point is on a timestamp, open the agenda at the day
10699 specified.
10701 When point is a footnote definition, move to the first reference
10702 found. If it is on a reference, move to the associated
10703 definition.
10705 When point is on a headline, display a list of every link in the
10706 entry, so it is possible to pick one, or all, of them. If point
10707 is on a tag, call `org-tags-view' instead.
10709 When optional argument REFERENCE-BUFFER is non-nil, it should
10710 specify a buffer from where the link search should happen. This
10711 is used internally by `org-open-link-from-string'.
10713 On top of syntactically correct links, this function will open
10714 the link at point in comments or comment blocks and the first
10715 link in a property drawer line."
10716 (interactive "P")
10717 ;; On a code block, open block's results.
10718 (unless (call-interactively 'org-babel-open-src-block-result)
10719 (org-load-modules-maybe)
10720 (move-marker org-open-link-marker (point))
10721 (setq org-window-config-before-follow-link (current-window-configuration))
10722 (org-remove-occur-highlights nil nil t)
10723 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10724 (let* ((context (org-element-context)) type value)
10725 ;; On an unsupported type, check if point is contained within
10726 ;; a support one.
10727 (while (and (not (memq (setq type (org-element-type context))
10728 '(comment comment-block
10729 headline inlinetask link
10730 footnote-definition footnote-reference
10731 node-property timestamp)))
10732 (setq context (org-element-property :parent context))))
10733 (setq value (org-element-property :value context))
10734 (cond
10735 ;; Blank lines at the beginning of buffer: bail out.
10736 ((not context) (user-error "No link found"))
10737 ;; Exception n°1: links in property drawers
10738 ((eq type 'node-property)
10739 (org-open-link-from-string
10740 (and (string-match org-any-link-re value)
10741 (match-string-no-properties 0 value))))
10742 ;; Exception n°2: links in comments.
10743 ((memq type '(comment comment-block))
10744 (save-excursion
10745 (skip-chars-forward "\\S-" (point-at-eol))
10746 (let ((string-rear (replace-regexp-in-string
10747 "^[ \t]*# [ \t]*" ""
10748 (buffer-substring (point) (line-beginning-position))))
10749 (string-front (buffer-substring (point) (line-end-position))))
10750 (with-temp-buffer
10751 (let ((org-inhibit-startup t)) (org-mode))
10752 (insert value)
10753 (goto-char (point-min))
10754 (when (and (search-forward string-rear nil t)
10755 (search-forward string-front (line-end-position) t))
10756 (goto-char (match-beginning 0))
10757 (org-open-at-point)
10758 (when (string= string-rear "") (forward-char)))))))
10759 ;; On a headline or an inlinetask, but not on a timestamp,
10760 ;; a link, a footnote reference or on tags.
10761 ((and (memq type '(headline inlinetask))
10762 ;; Not on tags.
10763 (progn (save-excursion (beginning-of-line)
10764 (looking-at org-complex-heading-regexp))
10765 (or (not (match-beginning 5))
10766 (< (point) (match-beginning 5)))))
10767 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10768 (links (car data))
10769 (links-end (cdr data)))
10770 (if links
10771 (dolist (link (if (stringp links) (list links) links))
10772 (search-forward link nil links-end)
10773 (goto-char (match-beginning 0))
10774 (org-open-at-point))
10775 (require 'org-attach)
10776 (org-attach-reveal 'if-exists))))
10777 ;; Do nothing on white spaces after an object, unless point
10778 ;; is right after it.
10779 ((> (point)
10780 (save-excursion
10781 (goto-char (org-element-property :end context))
10782 (skip-chars-backward " \t")
10783 (point)))
10784 (user-error "No link found"))
10785 ((eq type 'timestamp) (org-follow-timestamp-link))
10786 ;; On tags within a headline or an inlinetask.
10787 ((and (memq type '(headline inlinetask))
10788 (progn (save-excursion (beginning-of-line)
10789 (looking-at org-complex-heading-regexp))
10790 (and (match-beginning 5)
10791 (>= (point) (match-beginning 5)))))
10792 (org-tags-view arg (substring (match-string 5) 0 -1)))
10793 ((eq type 'link)
10794 ;; When link is located within the description of another
10795 ;; link (e.g., an inline image), always open the parent
10796 ;; link.
10797 (let*((link (let ((up (org-element-property :parent context)))
10798 (if (eq (org-element-type up) 'link) up context)))
10799 (type (org-element-property :type link))
10800 (path (org-link-unescape (org-element-property :path link))))
10801 ;; Switch back to REFERENCE-BUFFER needed when called in
10802 ;; a temporary buffer through `org-open-link-from-string'.
10803 (with-current-buffer (or reference-buffer (current-buffer))
10804 (cond
10805 ((equal type "file")
10806 (if (string-match "[*?{]" (file-name-nondirectory path))
10807 (dired path)
10808 ;; Look into `org-link-protocols' in order to find
10809 ;; a DEDICATED-FUNCTION to open file. The function
10810 ;; will be applied on raw link instead of parsed
10811 ;; link due to the limitation in `org-add-link-type'
10812 ;; ("open" function called with a single argument).
10813 ;; If no such function is found, fallback to
10814 ;; `org-open-file'.
10816 ;; Note : "file+emacs" and "file+sys" types are
10817 ;; hard-coded in order to escape the previous
10818 ;; limitation.
10819 (let* ((option (org-element-property :search-option link))
10820 (app (org-element-property :application link))
10821 (dedicated-function
10822 (nth 1 (assoc app org-link-protocols))))
10823 (if dedicated-function
10824 (funcall dedicated-function
10825 (concat path
10826 (and option (concat "::" option))))
10827 (apply 'org-open-file
10828 path
10829 (cond (arg)
10830 ((equal app "emacs") 'emacs)
10831 ((equal app "sys") 'system))
10832 (cond ((not option) nil)
10833 ((org-string-match-p "\\`[0-9]+\\'" option)
10834 (list (string-to-number option)))
10835 (t (list nil
10836 (org-link-unescape option)))))))))
10837 ((assoc type org-link-protocols)
10838 (funcall (nth 1 (assoc type org-link-protocols)) path))
10839 ((equal type "help")
10840 (let ((f-or-v (intern path)))
10841 (cond ((fboundp f-or-v) (describe-function f-or-v))
10842 ((boundp f-or-v) (describe-variable f-or-v))
10843 (t (error "Not a known function or variable")))))
10844 ((member type '("http" "https" "ftp" "mailto" "news"))
10845 (browse-url (org-link-escape-browser (concat type ":" path))))
10846 ((equal type "doi")
10847 (browse-url
10848 (org-link-escape-browser (concat org-doi-server-url path))))
10849 ((equal type "message") (browse-url (concat type ":" path)))
10850 ((equal type "shell")
10851 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10852 (cmd path))
10853 (if (or (and (org-string-nw-p
10854 org-confirm-shell-link-not-regexp)
10855 (string-match
10856 org-confirm-shell-link-not-regexp cmd))
10857 (not org-confirm-shell-link-function)
10858 (funcall org-confirm-shell-link-function
10859 (format "Execute \"%s\" in shell? "
10860 (org-add-props cmd nil
10861 'face 'org-warning))))
10862 (progn
10863 (message "Executing %s" cmd)
10864 (shell-command cmd buf)
10865 (when (featurep 'midnight)
10866 (setq clean-buffer-list-kill-buffer-names
10867 (cons buf
10868 clean-buffer-list-kill-buffer-names))))
10869 (user-error "Abort"))))
10870 ((equal type "elisp")
10871 (let ((cmd path))
10872 (if (or (and (org-string-nw-p
10873 org-confirm-elisp-link-not-regexp)
10874 (org-string-match-p
10875 org-confirm-elisp-link-not-regexp cmd))
10876 (not org-confirm-elisp-link-function)
10877 (funcall org-confirm-elisp-link-function
10878 (format "Execute \"%s\" as elisp? "
10879 (org-add-props cmd nil
10880 'face 'org-warning))))
10881 (message "%s => %s" cmd
10882 (if (eq (string-to-char cmd) ?\()
10883 (eval (read cmd))
10884 (call-interactively (read cmd))))
10885 (user-error "Abort"))))
10886 ((equal type "id")
10887 (require 'ord-id)
10888 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10889 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10890 (unless (run-hook-with-args-until-success
10891 'org-open-link-functions path)
10892 (if (not arg) (org-mark-ring-push)
10893 (switch-to-buffer-other-window
10894 (org-get-buffer-for-internal-link (current-buffer))))
10895 (let ((cmd `(org-link-search
10896 ,(if (member type '("custom-id" "coderef"))
10897 (org-element-property :raw-link link)
10898 path)
10899 ,(cond ((equal arg '(4)) 'occur)
10900 ((equal arg '(16)) 'org-occur))
10901 ,(org-element-property :begin link))))
10902 (condition-case nil
10903 (let ((org-link-search-inhibit-query t))
10904 (eval cmd))
10905 (error (progn (widen) (eval cmd)))))))
10906 (t (browse-url-at-point))))))
10907 ;; On a footnote reference or at a footnote definition's label.
10908 ((or (eq type 'footnote-reference)
10909 (and (eq type 'footnote-definition)
10910 (save-excursion
10911 ;; Do not validate action when point is on the
10912 ;; spaces right after the footnote label, in
10913 ;; order to be on par with behaviour on links.
10914 (skip-chars-forward " \t")
10915 (let ((begin
10916 (org-element-property :contents-begin context)))
10917 (if begin (< (point) begin)
10918 (= (org-element-property :post-affiliated context)
10919 (line-beginning-position)))))))
10920 (org-footnote-action))
10921 (t (user-error "No link found")))))
10922 (move-marker org-open-link-marker nil)
10923 (run-hook-with-args 'org-follow-link-hook)))
10925 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10926 "Offer links in the current entry and return the selected link.
10927 If there is only one link, return it.
10928 If NTH is an integer, return the NTH link found.
10929 If ZERO is a string, check also this string for a link, and if
10930 there is one, return it."
10931 (with-current-buffer buffer
10932 (save-excursion
10933 (save-restriction
10934 (widen)
10935 (goto-char marker)
10936 (let ((cnt ?0)
10937 (in-emacs (if (integerp nth) nil nth))
10938 have-zero end links link c)
10939 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10940 (push (match-string 0 zero) links)
10941 (setq cnt (1- cnt) have-zero t))
10942 (save-excursion
10943 (org-back-to-heading t)
10944 (setq end (save-excursion (outline-next-heading) (point)))
10945 (while (re-search-forward org-any-link-re end t)
10946 (push (match-string 0) links))
10947 (setq links (org-uniquify (reverse links))))
10948 (cond
10949 ((null links)
10950 (message "No links"))
10951 ((equal (length links) 1)
10952 (setq link (car links)))
10953 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10954 (setq link (nth (if have-zero nth (1- nth)) links)))
10955 (t ; we have to select a link
10956 (save-excursion
10957 (save-window-excursion
10958 (delete-other-windows)
10959 (with-output-to-temp-buffer "*Select Link*"
10960 (mapc (lambda (l)
10961 (if (not (string-match org-bracket-link-regexp l))
10962 (princ (format "[%c] %s\n" (incf cnt)
10963 (org-remove-angle-brackets l)))
10964 (if (match-end 3)
10965 (princ (format "[%c] %s (%s)\n" (incf cnt)
10966 (match-string 3 l) (match-string 1 l)))
10967 (princ (format "[%c] %s\n" (incf cnt)
10968 (match-string 1 l))))))
10969 links))
10970 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10971 (message "Select link to open, RET to open all:")
10972 (setq c (read-char-exclusive))
10973 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10974 (when (equal c ?q) (user-error "Abort"))
10975 (if (equal c ?\C-m)
10976 (setq link links)
10977 (setq nth (- c ?0))
10978 (if have-zero (setq nth (1+ nth)))
10979 (unless (and (integerp nth) (>= (length links) nth))
10980 (user-error "Invalid link selection"))
10981 (setq link (nth (1- nth) links)))))
10982 (cons link end))))))
10984 ;; TODO: These functions are deprecated since `org-open-at-point'
10985 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10986 (defun org-open-file-with-system (path)
10987 "Open file at PATH using the system way of opening it."
10988 (org-open-file path 'system))
10989 (defun org-open-file-with-emacs (path)
10990 "Open file at PATH in Emacs."
10991 (org-open-file path 'emacs))
10994 ;;; File search
10996 (defvar org-create-file-search-functions nil
10997 "List of functions to construct the right search string for a file link.
10998 These functions are called in turn with point at the location to
10999 which the link should point.
11001 A function in the hook should first test if it would like to
11002 handle this file type, for example by checking the `major-mode'
11003 or the file extension. If it decides not to handle this file, it
11004 should just return nil to give other functions a chance. If it
11005 does handle the file, it must return the search string to be used
11006 when following the link. The search string will be part of the
11007 file link, given after a double colon, and `org-open-at-point'
11008 will automatically search for it. If special measures must be
11009 taken to make the search successful, another function should be
11010 added to the companion hook `org-execute-file-search-functions',
11011 which see.
11013 A function in this hook may also use `setq' to set the variable
11014 `description' to provide a suggestion for the descriptive text to
11015 be used for this link when it gets inserted into an Org-mode
11016 buffer with \\[org-insert-link].")
11018 (defvar org-execute-file-search-functions nil
11019 "List of functions to execute a file search triggered by a link.
11021 Functions added to this hook must accept a single argument, the
11022 search string that was part of the file link, the part after the
11023 double colon. The function must first check if it would like to
11024 handle this search, for example by checking the `major-mode' or
11025 the file extension. If it decides not to handle this search, it
11026 should just return nil to give other functions a chance. If it
11027 does handle the search, it must return a non-nil value to keep
11028 other functions from trying.
11030 Each function can access the current prefix argument through the
11031 variable `current-prefix-arg'. Note that a single prefix is used
11032 to force opening a link in Emacs, so it may be good to only use a
11033 numeric or double prefix to guide the search function.
11035 In case this is needed, a function in this hook can also restore
11036 the window configuration before `org-open-at-point' was called using:
11038 (set-window-configuration org-window-config-before-follow-link)")
11040 (defun org-link-search (s &optional type avoid-pos stealth)
11041 "Search for a link search option.
11042 If S is surrounded by forward slashes, it is interpreted as a
11043 regular expression. In org-mode files, this will create an `org-occur'
11044 sparse tree. In ordinary files, `occur' will be used to list matches.
11045 If the current buffer is in `dired-mode', grep will be used to search
11046 in all files. If AVOID-POS is given, ignore matches near that position.
11048 When optional argument STEALTH is non-nil, do not modify
11049 visibility around point, thus ignoring
11050 `org-show-hierarchy-above', `org-show-following-heading' and
11051 `org-show-siblings' variables."
11052 (let ((case-fold-search t)
11053 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
11054 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
11055 (append '(("") (" ") ("\t") ("\n"))
11056 org-emphasis-alist)
11057 "\\|") "\\)"))
11058 (pos (point))
11059 (pre nil) (post nil)
11060 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
11061 (cond
11062 ;; First check if there are any special search functions
11063 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11064 ;; Now try the builtin stuff
11065 ((and (equal (string-to-char s0) ?#)
11066 (> (length s0) 1)
11067 (save-excursion
11068 (goto-char (point-min))
11069 (and
11070 (re-search-forward
11071 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
11072 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
11073 (setq type 'dedicated
11074 pos (match-beginning 0))))
11075 ;; There is an exact target for this
11076 (goto-char pos)
11077 (org-back-to-heading t)))
11078 ((save-excursion
11079 (goto-char (point-min))
11080 (and
11081 (re-search-forward
11082 (concat "<<" (regexp-quote s0) ">>") nil t)
11083 (setq type 'dedicated
11084 pos (match-beginning 0))))
11085 ;; There is an exact target for this
11086 (goto-char pos))
11087 ((save-excursion
11088 (goto-char (point-min))
11089 (and
11090 (re-search-forward
11091 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11092 (setq type 'dedicated pos (match-beginning 0))))
11093 ;; Found an element with a matching #+name affiliated keyword.
11094 (goto-char pos))
11095 ((and (string-match "^(\\(.*\\))$" s0)
11096 (save-excursion
11097 (goto-char (point-min))
11098 (and
11099 (re-search-forward
11100 (concat "[^[]" (regexp-quote
11101 (format org-coderef-label-format
11102 (match-string 1 s0))))
11103 nil t)
11104 (setq type 'dedicated
11105 pos (1+ (match-beginning 0))))))
11106 ;; There is a coderef target for this
11107 (goto-char pos))
11108 ((string-match "^/\\(.*\\)/$" s)
11109 ;; A regular expression
11110 (cond
11111 ((derived-mode-p 'org-mode)
11112 (org-occur (match-string 1 s)))
11113 (t (org-do-occur (match-string 1 s)))))
11114 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
11115 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11116 (goto-char (point-min))
11117 (cond
11118 ((let (case-fold-search)
11119 (re-search-forward (format org-complex-heading-regexp-format
11120 (regexp-quote s))
11121 nil t))
11122 ;; OK, found a match
11123 (setq type 'dedicated)
11124 (goto-char (match-beginning 0)))
11125 ((and (not org-link-search-inhibit-query)
11126 (eq org-link-search-must-match-exact-headline 'query-to-create)
11127 (y-or-n-p "No match - create this as a new heading? "))
11128 (goto-char (point-max))
11129 (or (bolp) (newline))
11130 (insert "* " s "\n")
11131 (beginning-of-line 0))
11133 (goto-char pos)
11134 (error "No match"))))
11136 ;; A normal search string
11137 (when (equal (string-to-char s) ?*)
11138 ;; Anchor on headlines, post may include tags.
11139 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
11140 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
11141 s (substring s 1)))
11142 (remove-text-properties
11143 0 (length s)
11144 '(face nil mouse-face nil keymap nil fontified nil) s)
11145 ;; Make a series of regular expressions to find a match
11146 (setq words (org-split-string s "[ \n\r\t]+")
11148 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11149 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11150 "\\)" markers)
11151 re2a_ (concat "\\(" (mapconcat 'downcase words
11152 "[ \t\r\n]+") "\\)[ \t\r\n]")
11153 re2a (concat "[ \t\r\n]" re2a_)
11154 re4_ (concat "\\(" (mapconcat 'downcase words
11155 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11156 re4 (concat "[^a-zA-Z_]" re4_)
11158 re1 (concat pre re2 post)
11159 re3 (concat pre (if pre re4_ re4) post)
11160 re5 (concat pre ".*" re4)
11161 re2 (concat pre re2)
11162 re2a (concat pre (if pre re2a_ re2a))
11163 re4 (concat pre (if pre re4_ re4))
11164 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
11165 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
11166 re5 "\\)"))
11167 (cond
11168 ((eq type 'org-occur) (org-occur reall))
11169 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11170 (t (goto-char (point-min))
11171 (setq type 'fuzzy)
11172 (if (or (and (org-search-not-self 1 re0 nil t)
11173 (setq type 'dedicated))
11174 (org-search-not-self 1 re1 nil t)
11175 (org-search-not-self 1 re2 nil t)
11176 (org-search-not-self 1 re2a nil t)
11177 (org-search-not-self 1 re3 nil t)
11178 (org-search-not-self 1 re4 nil t)
11179 (org-search-not-self 1 re5 nil t))
11180 (goto-char (match-beginning 1))
11181 (goto-char pos)
11182 (error "No match"))))))
11183 (and (derived-mode-p 'org-mode)
11184 (not stealth)
11185 (org-show-context 'link-search))
11186 type))
11188 (defun org-search-not-self (group &rest args)
11189 "Execute `re-search-forward', but only accept matches that do not
11190 enclose the position of `org-open-link-marker'."
11191 (let ((m org-open-link-marker))
11192 (catch 'exit
11193 (while (apply 're-search-forward args)
11194 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11195 (goto-char (match-end group))
11196 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11197 (> (match-beginning 0) (marker-position m))
11198 (< (match-end 0) (marker-position m)))
11199 (save-match-data
11200 (or (not (org-in-regexp
11201 org-bracket-link-analytic-regexp 1))
11202 (not (match-end 4)) ; no description
11203 (and (<= (match-beginning 4) (point))
11204 (>= (match-end 4) (point))))))
11205 (throw 'exit (point))))))))
11207 (defun org-get-buffer-for-internal-link (buffer)
11208 "Return a buffer to be used for displaying the link target of internal links."
11209 (cond
11210 ((not org-display-internal-link-with-indirect-buffer)
11211 buffer)
11212 ((string-match "(Clone)$" (buffer-name buffer))
11213 (message "Buffer is already a clone, not making another one")
11214 ;; we also do not modify visibility in this case
11215 buffer)
11216 (t ; make a new indirect buffer for displaying the link
11217 (let* ((bn (buffer-name buffer))
11218 (ibn (concat bn "(Clone)"))
11219 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11220 (with-current-buffer ib (org-overview))
11221 ib))))
11223 (defun org-do-occur (regexp &optional cleanup)
11224 "Call the Emacs command `occur'.
11225 If CLEANUP is non-nil, remove the printout of the regular expression
11226 in the *Occur* buffer. This is useful if the regex is long and not useful
11227 to read."
11228 (occur regexp)
11229 (when cleanup
11230 (let ((cwin (selected-window)) win beg end)
11231 (when (setq win (get-buffer-window "*Occur*"))
11232 (select-window win))
11233 (goto-char (point-min))
11234 (when (re-search-forward "match[a-z]+" nil t)
11235 (setq beg (match-end 0))
11236 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11237 (setq end (1- (match-beginning 0)))))
11238 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11239 (goto-char (point-min))
11240 (select-window cwin))))
11242 ;;; The mark ring for links jumps
11244 (defvar org-mark-ring nil
11245 "Mark ring for positions before jumps in Org-mode.")
11246 (defvar org-mark-ring-last-goto nil
11247 "Last position in the mark ring used to go back.")
11248 ;; Fill and close the ring
11249 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11250 (loop for i from 1 to org-mark-ring-length do
11251 (push (make-marker) org-mark-ring))
11252 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11253 org-mark-ring)
11255 (defun org-mark-ring-push (&optional pos buffer)
11256 "Put the current position or POS into the mark ring and rotate it."
11257 (interactive)
11258 (setq pos (or pos (point)))
11259 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11260 (move-marker (car org-mark-ring)
11261 (or pos (point))
11262 (or buffer (current-buffer)))
11263 (message "%s"
11264 (substitute-command-keys
11265 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11267 (defun org-mark-ring-goto (&optional n)
11268 "Jump to the previous position in the mark ring.
11269 With prefix arg N, jump back that many stored positions. When
11270 called several times in succession, walk through the entire ring.
11271 Org-mode commands jumping to a different position in the current file,
11272 or to another Org-mode file, automatically push the old position
11273 onto the ring."
11274 (interactive "p")
11275 (let (p m)
11276 (if (eq last-command this-command)
11277 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11278 (setq p org-mark-ring))
11279 (setq org-mark-ring-last-goto p)
11280 (setq m (car p))
11281 (org-pop-to-buffer-same-window (marker-buffer m))
11282 (goto-char m)
11283 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11285 (defun org-remove-angle-brackets (s)
11286 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11287 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11289 (defun org-add-angle-brackets (s)
11290 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11291 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11293 (defun org-remove-double-quotes (s)
11294 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11295 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11298 ;;; Following specific links
11300 (defun org-follow-timestamp-link ()
11301 "Open an agenda view for the time-stamp date/range at point."
11302 (cond
11303 ((org-at-date-range-p t)
11304 (let ((org-agenda-start-on-weekday)
11305 (t1 (match-string 1))
11306 (t2 (match-string 2)) tt1 tt2)
11307 (setq tt1 (time-to-days (org-time-string-to-time t1))
11308 tt2 (time-to-days (org-time-string-to-time t2)))
11309 (let ((org-agenda-buffer-tmp-name
11310 (format "*Org Agenda(a:%s)"
11311 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11312 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11313 ((org-at-timestamp-p t)
11314 (let ((org-agenda-buffer-tmp-name
11315 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11316 (org-agenda-list nil (time-to-days (org-time-string-to-time
11317 (substring (match-string 1) 0 10)))
11318 1)))
11319 (t (error "This should not happen"))))
11322 ;;; Following file links
11323 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11324 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11325 (declare-function mailcap-mime-info
11326 "mailcap" (string &optional request no-decode))
11327 (defvar org-wait nil)
11328 (defun org-open-file (path &optional in-emacs line search)
11329 "Open the file at PATH.
11330 First, this expands any special file name abbreviations. Then the
11331 configuration variable `org-file-apps' is checked if it contains an
11332 entry for this file type, and if yes, the corresponding command is launched.
11334 If no application is found, Emacs simply visits the file.
11336 With optional prefix argument IN-EMACS, Emacs will visit the file.
11337 With a double \\[universal-argument] \\[universal-argument] \
11338 prefix arg, Org tries to avoid opening in Emacs
11339 and to use an external application to visit the file.
11341 Optional LINE specifies a line to go to, optional SEARCH a string
11342 to search for. If LINE or SEARCH is given, the file will be
11343 opened in Emacs, unless an entry from org-file-apps that makes
11344 use of groups in a regexp matches.
11346 If you want to change the way frames are used when following a
11347 link, please customize `org-link-frame-setup'.
11349 If the file does not exist, an error is thrown."
11350 (let* ((file (if (equal path "")
11351 buffer-file-name
11352 (substitute-in-file-name (expand-file-name path))))
11353 (file-apps (append org-file-apps (org-default-apps)))
11354 (apps (org-remove-if
11355 'org-file-apps-entry-match-against-dlink-p file-apps))
11356 (apps-dlink (org-remove-if-not
11357 'org-file-apps-entry-match-against-dlink-p file-apps))
11358 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11359 (dirp (if remp nil (file-directory-p file)))
11360 (file (if (and dirp org-open-directory-means-index-dot-org)
11361 (concat (file-name-as-directory file) "index.org")
11362 file))
11363 (a-m-a-p (assq 'auto-mode apps))
11364 (dfile (downcase file))
11365 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11366 (link (cond ((and (eq line nil)
11367 (eq search nil))
11368 file)
11369 (line
11370 (concat file "::" (number-to-string line)))
11371 (search
11372 (concat file "::" search))))
11373 (dlink (downcase link))
11374 (old-buffer (current-buffer))
11375 (old-pos (point))
11376 (old-mode major-mode)
11377 ext cmd link-match-data)
11378 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11379 (setq ext (match-string 1 dfile))
11380 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11381 (setq ext (match-string 1 dfile))))
11382 (cond
11383 ((member in-emacs '((16) system))
11384 (setq cmd (cdr (assoc 'system apps))))
11385 (in-emacs (setq cmd 'emacs))
11387 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11388 (and dirp (cdr (assoc 'directory apps)))
11389 ; first, try matching against apps-dlink
11390 ; if we get a match here, store the match data for later
11391 (let ((match (assoc-default dlink apps-dlink
11392 'string-match)))
11393 (if match
11394 (progn (setq link-match-data (match-data))
11395 match)
11396 (progn (setq in-emacs (or in-emacs line search))
11397 nil))) ; if we have no match in apps-dlink,
11398 ; always open the file in emacs if line or search
11399 ; is given (for backwards compatibility)
11400 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11401 'string-match)
11402 (cdr (assoc ext apps))
11403 (cdr (assoc t apps))))))
11404 (when (eq cmd 'system)
11405 (setq cmd (cdr (assoc 'system apps))))
11406 (when (eq cmd 'default)
11407 (setq cmd (cdr (assoc t apps))))
11408 (when (eq cmd 'mailcap)
11409 (require 'mailcap)
11410 (mailcap-parse-mailcaps)
11411 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11412 (command (mailcap-mime-info mime-type)))
11413 (if (stringp command)
11414 (setq cmd command)
11415 (setq cmd 'emacs))))
11416 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11417 (not (file-exists-p file))
11418 (not org-open-non-existing-files))
11419 (user-error "No such file: %s" file))
11420 (cond
11421 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11422 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11423 (while (string-match "['\"]%s['\"]" cmd)
11424 (setq cmd (replace-match "%s" t t cmd)))
11425 (while (string-match "%s" cmd)
11426 (setq cmd (replace-match
11427 (save-match-data
11428 (shell-quote-argument
11429 (convert-standard-filename file)))
11430 t t cmd)))
11432 ;; Replace "%1", "%2" etc. in command with group matches from regex
11433 (save-match-data
11434 (let ((match-index 1)
11435 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11436 (set-match-data link-match-data)
11437 (while (<= match-index number-of-groups)
11438 (let ((regex (concat "%" (number-to-string match-index)))
11439 (replace-with (match-string match-index dlink)))
11440 (while (string-match regex cmd)
11441 (setq cmd (replace-match replace-with t t cmd))))
11442 (setq match-index (+ match-index 1)))))
11444 (save-window-excursion
11445 (message "Running %s...done" cmd)
11446 (start-process-shell-command cmd nil cmd)
11447 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11448 ((or (stringp cmd)
11449 (eq cmd 'emacs))
11450 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11451 (widen)
11452 (if line (progn (org-goto-line line)
11453 (if (derived-mode-p 'org-mode)
11454 (org-reveal)))
11455 (if search (org-link-search search))))
11456 ((consp cmd)
11457 (let ((file (convert-standard-filename file)))
11458 (save-match-data
11459 (set-match-data link-match-data)
11460 (eval cmd))))
11461 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11462 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11463 (or (not (equal old-buffer (current-buffer)))
11464 (not (equal old-pos (point))))
11465 (org-mark-ring-push old-pos old-buffer))))
11467 (defun org-file-apps-entry-match-against-dlink-p (entry)
11468 "This function returns non-nil if `entry' uses a regular
11469 expression which should be matched against the whole link by
11470 org-open-file.
11472 It assumes that is the case when the entry uses a regular
11473 expression which has at least one grouping construct and the
11474 action is either a lisp form or a command string containing
11475 '%1', i.e. using at least one subexpression match as a
11476 parameter."
11477 (let ((selector (car entry))
11478 (action (cdr entry)))
11479 (if (stringp selector)
11480 (and (> (regexp-opt-depth selector) 0)
11481 (or (and (stringp action)
11482 (string-match "%[0-9]" action))
11483 (consp action)))
11484 nil)))
11486 (defun org-default-apps ()
11487 "Return the default applications for this operating system."
11488 (cond
11489 ((eq system-type 'darwin)
11490 org-file-apps-defaults-macosx)
11491 ((eq system-type 'windows-nt)
11492 org-file-apps-defaults-windowsnt)
11493 (t org-file-apps-defaults-gnu)))
11495 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11496 "Convert extensions to regular expressions in the cars of LIST.
11497 Also, weed out any non-string entries, because the return value is used
11498 only for regexp matching.
11499 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11500 point to the symbol `emacs', indicating that the file should
11501 be opened in Emacs."
11502 (append
11503 (delq nil
11504 (mapcar (lambda (x)
11505 (if (not (stringp (car x)))
11507 (if (string-match "\\W" (car x))
11509 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11510 list))
11511 (if add-auto-mode
11512 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11514 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11515 (defun org-file-remote-p (file)
11516 "Test whether FILE specifies a location on a remote system.
11517 Return non-nil if the location is indeed remote.
11519 For example, the filename \"/user@host:/foo\" specifies a location
11520 on the system \"/user@host:\"."
11521 (cond ((fboundp 'file-remote-p)
11522 (file-remote-p file))
11523 ((fboundp 'tramp-handle-file-remote-p)
11524 (tramp-handle-file-remote-p file))
11525 ((and (boundp 'ange-ftp-name-format)
11526 (string-match (car ange-ftp-name-format) file))
11527 t)))
11530 ;;;; Refiling
11532 (defun org-get-org-file ()
11533 "Read a filename, with default directory `org-directory'."
11534 (let ((default (or org-default-notes-file remember-data-file)))
11535 (read-file-name (format "File name [%s]: " default)
11536 (file-name-as-directory org-directory)
11537 default)))
11539 (defun org-notes-order-reversed-p ()
11540 "Check if the current file should receive notes in reversed order."
11541 (cond
11542 ((not org-reverse-note-order) nil)
11543 ((eq t org-reverse-note-order) t)
11544 ((not (listp org-reverse-note-order)) nil)
11545 (t (catch 'exit
11546 (let ((all org-reverse-note-order)
11547 entry)
11548 (while (setq entry (pop all))
11549 (if (string-match (car entry) buffer-file-name)
11550 (throw 'exit (cdr entry))))
11551 nil)))))
11553 (defvar org-refile-target-table nil
11554 "The list of refile targets, created by `org-refile'.")
11556 (defvar org-agenda-new-buffers nil
11557 "Buffers created to visit agenda files.")
11559 (defvar org-refile-cache nil
11560 "Cache for refile targets.")
11562 (defvar org-refile-markers nil
11563 "All the markers used for caching refile locations.")
11565 (defun org-refile-marker (pos)
11566 "Get a new refile marker, but only if caching is in use."
11567 (if (not org-refile-use-cache)
11569 (let ((m (make-marker)))
11570 (move-marker m pos)
11571 (push m org-refile-markers)
11572 m)))
11574 (defun org-refile-cache-clear ()
11575 "Clear the refile cache and disable all the markers."
11576 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11577 (setq org-refile-markers nil)
11578 (setq org-refile-cache nil)
11579 (message "Refile cache has been cleared"))
11581 (defun org-refile-cache-check-set (set)
11582 "Check if all the markers in the cache still have live buffers."
11583 (let (marker)
11584 (catch 'exit
11585 (while (and set (setq marker (nth 3 (pop set))))
11586 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11587 (when (and marker (null (marker-buffer marker)))
11588 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11589 (sit-for 3)
11590 (throw 'exit nil)))
11591 t)))
11593 (defun org-refile-cache-put (set &rest identifiers)
11594 "Push the refile targets SET into the cache, under IDENTIFIERS."
11595 (let* ((key (sha1 (prin1-to-string identifiers)))
11596 (entry (assoc key org-refile-cache)))
11597 (if entry
11598 (setcdr entry set)
11599 (push (cons key set) org-refile-cache))))
11601 (defun org-refile-cache-get (&rest identifiers)
11602 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11603 (cond
11604 ((not org-refile-cache) nil)
11605 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11607 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11608 org-refile-cache))))
11609 (and set (org-refile-cache-check-set set) set)))))
11611 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11612 "Produce a table with refile targets."
11613 (let ((case-fold-search nil)
11614 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11615 (entries (or org-refile-targets '((nil . (:level . 1)))))
11616 targets tgs txt re files f desc descre fast-path-p level pos0)
11617 (message "Getting targets...")
11618 (with-current-buffer (or default-buffer (current-buffer))
11619 (while (setq entry (pop entries))
11620 (setq files (car entry) desc (cdr entry))
11621 (setq fast-path-p nil)
11622 (cond
11623 ((null files) (setq files (list (current-buffer))))
11624 ((eq files 'org-agenda-files)
11625 (setq files (org-agenda-files 'unrestricted)))
11626 ((and (symbolp files) (fboundp files))
11627 (setq files (funcall files)))
11628 ((and (symbolp files) (boundp files))
11629 (setq files (symbol-value files))))
11630 (if (stringp files) (setq files (list files)))
11631 (cond
11632 ((eq (car desc) :tag)
11633 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11634 ((eq (car desc) :todo)
11635 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11636 ((eq (car desc) :regexp)
11637 (setq descre (cdr desc)))
11638 ((eq (car desc) :level)
11639 (setq descre (concat "^\\*\\{" (number-to-string
11640 (if org-odd-levels-only
11641 (1- (* 2 (cdr desc)))
11642 (cdr desc)))
11643 "\\}[ \t]")))
11644 ((eq (car desc) :maxlevel)
11645 (setq fast-path-p t)
11646 (setq descre (concat "^\\*\\{1," (number-to-string
11647 (if org-odd-levels-only
11648 (1- (* 2 (cdr desc)))
11649 (cdr desc)))
11650 "\\}[ \t]")))
11651 (t (error "Bad refiling target description %s" desc)))
11652 (while (setq f (pop files))
11653 (with-current-buffer
11654 (if (bufferp f) f (org-get-agenda-file-buffer f))
11656 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11657 (progn
11658 (if (bufferp f) (setq f (buffer-file-name
11659 (buffer-base-buffer f))))
11660 (setq f (and f (expand-file-name f)))
11661 (if (eq org-refile-use-outline-path 'file)
11662 (push (list (file-name-nondirectory f) f nil nil) tgs))
11663 (save-excursion
11664 (save-restriction
11665 (widen)
11666 (goto-char (point-min))
11667 (while (re-search-forward descre nil t)
11668 (goto-char (setq pos0 (point-at-bol)))
11669 (catch 'next
11670 (when org-refile-target-verify-function
11671 (save-match-data
11672 (or (funcall org-refile-target-verify-function)
11673 (throw 'next t))))
11674 (when (and (looking-at org-complex-heading-regexp)
11675 (not (member (match-string 4) excluded-entries))
11676 (match-string 4))
11677 (setq level (org-reduced-level
11678 (- (match-end 1) (match-beginning 1)))
11679 txt (org-link-display-format (match-string 4))
11680 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11681 re (format org-complex-heading-regexp-format
11682 (regexp-quote (match-string 4))))
11683 (when org-refile-use-outline-path
11684 (setq txt (mapconcat
11685 'org-protect-slash
11686 (append
11687 (if (eq org-refile-use-outline-path
11688 'file)
11689 (list (file-name-nondirectory
11690 (buffer-file-name
11691 (buffer-base-buffer))))
11692 (if (eq org-refile-use-outline-path
11693 'full-file-path)
11694 (list (buffer-file-name
11695 (buffer-base-buffer)))))
11696 (org-get-outline-path fast-path-p
11697 level txt)
11698 (list txt))
11699 "/")))
11700 (push (list txt f re (org-refile-marker (point)))
11701 tgs)))
11702 (when (= (point) pos0)
11703 ;; verification function has not moved point
11704 (goto-char (point-at-eol))))))))
11705 (when org-refile-use-cache
11706 (org-refile-cache-put tgs (buffer-file-name) descre))
11707 (setq targets (append tgs targets))))))
11708 (message "Getting targets...done")
11709 (nreverse targets)))
11711 (defun org-protect-slash (s)
11712 (while (string-match "/" s)
11713 (setq s (replace-match "\\" t t s)))
11716 (defvar org-olpa (make-vector 20 nil))
11718 (defun org-get-outline-path (&optional fastp level heading)
11719 "Return the outline path to the current entry, as a list.
11721 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11722 routine which makes outline path derivations for an entire file,
11723 avoiding backtracing. Refile target collection makes use of that."
11724 (if fastp
11725 (progn
11726 (if (> level 19)
11727 (error "Outline path failure, more than 19 levels"))
11728 (loop for i from level upto 19 do
11729 (aset org-olpa i nil))
11730 (prog1
11731 (delq nil (append org-olpa nil))
11732 (aset org-olpa level heading)))
11733 (let (rtn case-fold-search)
11734 (save-excursion
11735 (save-restriction
11736 (widen)
11737 (while (org-up-heading-safe)
11738 (when (looking-at org-complex-heading-regexp)
11739 (push (org-trim
11740 (replace-regexp-in-string
11741 ;; Remove statistical/checkboxes cookies
11742 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11743 (org-match-string-no-properties 4)))
11744 rtn)))
11745 rtn)))))
11747 (defun org-format-outline-path (path &optional width prefix separator)
11748 "Format the outline path PATH for display.
11749 WIDTH is the maximum number of characters that is available.
11750 PREFIX is a prefix to be included in the returned string,
11751 such as the file name.
11752 SEPARATOR is inserted between the different parts of the path,
11753 the default is \"/\"."
11754 (setq width (or width 79))
11755 (if prefix (setq width (- width (length prefix))))
11756 (if (not path)
11757 (or prefix "")
11758 (let* ((nsteps (length path))
11759 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11760 (maxwidth (if (<= total-width width)
11761 10000 ;; everything fits
11762 ;; we need to shorten the level headings
11763 (/ (- width nsteps) nsteps)))
11764 (org-odd-levels-only nil)
11765 (n 0)
11766 (total (1+ (length prefix))))
11767 (setq maxwidth (max maxwidth 10))
11768 (concat prefix
11769 (if prefix (or separator "/"))
11770 (mapconcat
11771 (lambda (h)
11772 (setq n (1+ n))
11773 (if (and (= n nsteps) (< maxwidth 10000))
11774 (setq maxwidth (- total-width total)))
11775 (if (< (length h) maxwidth)
11776 (progn (setq total (+ total (length h) 1)) h)
11777 (setq h (substring h 0 (- maxwidth 2))
11778 total (+ total maxwidth 1))
11779 (if (string-match "[ \t]+\\'" h)
11780 (setq h (substring h 0 (match-beginning 0))))
11781 (setq h (concat h "..")))
11782 (org-add-props h nil 'face
11783 (nth (% (1- n) org-n-level-faces)
11784 org-level-faces))
11786 path (or separator "/"))))))
11788 (defun org-display-outline-path (&optional file current separator just-return-string)
11789 "Display the current outline path in the echo area.
11791 If FILE is non-nil, prepend the output with the file name.
11792 If CURRENT is non-nil, append the current heading to the output.
11793 SEPARATOR is passed through to `org-format-outline-path'. It separates
11794 the different parts of the path and defaults to \"/\".
11795 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11796 (interactive "P")
11797 (let* (case-fold-search
11798 (bfn (buffer-file-name (buffer-base-buffer)))
11799 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11800 res)
11801 (if current (setq path (append path
11802 (save-excursion
11803 (org-back-to-heading t)
11804 (if (looking-at org-complex-heading-regexp)
11805 (list (match-string 4)))))))
11806 (setq res
11807 (org-format-outline-path
11808 path
11809 (1- (frame-width))
11810 (and file bfn (concat (file-name-nondirectory bfn) separator))
11811 separator))
11812 (if just-return-string
11813 (org-no-properties res)
11814 (org-unlogged-message "%s" res))))
11816 (defvar org-refile-history nil
11817 "History for refiling operations.")
11819 (defvar org-after-refile-insert-hook nil
11820 "Hook run after `org-refile' has inserted its stuff at the new location.
11821 Note that this is still *before* the stuff will be removed from
11822 the *old* location.")
11824 (defvar org-capture-last-stored-marker)
11825 (defvar org-refile-keep nil
11826 "Non-nil means `org-refile' will copy instead of refile.")
11828 (defun org-copy ()
11829 "Like `org-refile', but copy."
11830 (interactive)
11831 (let ((org-refile-keep t))
11832 (funcall 'org-refile nil nil nil "Copy")))
11834 (defun org-refile (&optional arg default-buffer rfloc msg)
11835 "Move the entry or entries at point to another heading.
11836 The list of target headings is compiled using the information in
11837 `org-refile-targets', which see.
11839 At the target location, the entry is filed as a subitem of the
11840 target heading. Depending on `org-reverse-note-order', the new
11841 subitem will either be the first or the last subitem.
11843 If there is an active region, all entries in that region will be
11844 refiled. However, the region must fulfill the requirement that
11845 the first heading sets the top-level of the moved text.
11847 With prefix arg ARG, the command will only visit the target
11848 location and not actually move anything.
11850 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11851 refiling operation has put the subtree.
11853 With a numeric prefix argument of `2', refile to the running clock.
11855 With a numeric prefix argument of `3', emulate `org-refile-keep'
11856 being set to `t' and copy to the target location, don't move it.
11857 Beware that keeping refiled entries may result in duplicated ID
11858 properties.
11860 RFLOC can be a refile location obtained in a different way.
11862 MSG is a string to replace \"Refile\" in the default prompt with
11863 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11865 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11867 If you are using target caching (see `org-refile-use-cache'), you
11868 have to clear the target cache in order to find new targets.
11869 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11870 prefix argument (`C-u C-u C-u C-c C-w')."
11871 (interactive "P")
11872 (if (member arg '(0 (64)))
11873 (org-refile-cache-clear)
11874 (let* ((actionmsg (cond (msg msg)
11875 ((equal arg 3) "Refile (and keep)")
11876 (t "Refile")))
11877 (cbuf (current-buffer))
11878 (regionp (org-region-active-p))
11879 (region-start (and regionp (region-beginning)))
11880 (region-end (and regionp (region-end)))
11881 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11882 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11883 pos it nbuf file re level reversed)
11884 (setq last-command nil)
11885 (when regionp
11886 (goto-char region-start)
11887 (or (bolp) (goto-char (point-at-bol)))
11888 (setq region-start (point))
11889 (unless (or (org-kill-is-subtree-p
11890 (buffer-substring region-start region-end))
11891 (prog1 org-refile-active-region-within-subtree
11892 (let ((s (point-at-eol)))
11893 (org-toggle-heading)
11894 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11895 (user-error "The region is not a (sequence of) subtree(s)")))
11896 (if (equal arg '(16))
11897 (org-refile-goto-last-stored)
11898 (when (or
11899 (and (equal arg 2)
11900 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11901 (prog1
11902 (setq it (list (or org-clock-heading "running clock")
11903 (buffer-file-name
11904 (marker-buffer org-clock-hd-marker))
11906 (marker-position org-clock-hd-marker)))
11907 (setq arg nil)))
11908 (setq it (or rfloc
11909 (let (heading-text)
11910 (save-excursion
11911 (unless (and arg (listp arg))
11912 (org-back-to-heading t)
11913 (setq heading-text
11914 (replace-regexp-in-string
11915 org-bracket-link-regexp
11916 "\\3"
11917 (nth 4 (org-heading-components)))))
11918 (org-refile-get-location
11919 (cond ((and arg (listp arg)) "Goto")
11920 (regionp (concat actionmsg " region to"))
11921 (t (concat actionmsg " subtree \""
11922 heading-text "\" to")))
11923 default-buffer
11924 (and (not (equal '(4) arg))
11925 org-refile-allow-creating-parent-nodes)
11926 arg))))))
11927 (setq file (nth 1 it)
11928 re (nth 2 it)
11929 pos (nth 3 it))
11930 (if (and (not arg)
11932 (equal (buffer-file-name) file)
11933 (if regionp
11934 (and (>= pos region-start)
11935 (<= pos region-end))
11936 (and (>= pos (point))
11937 (< pos (save-excursion
11938 (org-end-of-subtree t t))))))
11939 (error "Cannot refile to position inside the tree or region"))
11940 (setq nbuf (or (find-buffer-visiting file)
11941 (find-file-noselect file)))
11942 (if (and arg (not (equal arg 3)))
11943 (progn
11944 (org-pop-to-buffer-same-window nbuf)
11945 (goto-char pos)
11946 (org-show-context 'org-goto))
11947 (if regionp
11948 (progn
11949 (org-kill-new (buffer-substring region-start region-end))
11950 (org-save-markers-in-region region-start region-end))
11951 (org-copy-subtree 1 nil t))
11952 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11953 (find-file-noselect file)))
11954 (setq reversed (org-notes-order-reversed-p))
11955 (save-excursion
11956 (save-restriction
11957 (widen)
11958 (if pos
11959 (progn
11960 (goto-char pos)
11961 (looking-at org-outline-regexp)
11962 (setq level (org-get-valid-level (funcall outline-level) 1))
11963 (goto-char
11964 (if reversed
11965 (or (outline-next-heading) (point-max))
11966 (or (save-excursion (org-get-next-sibling))
11967 (org-end-of-subtree t t)
11968 (point-max)))))
11969 (setq level 1)
11970 (if (not reversed)
11971 (goto-char (point-max))
11972 (goto-char (point-min))
11973 (or (outline-next-heading) (goto-char (point-max)))))
11974 (if (not (bolp)) (newline))
11975 (org-paste-subtree level nil nil t)
11976 (when org-log-refile
11977 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11978 (unless (eq org-log-refile 'note)
11979 (save-excursion (org-add-log-note))))
11980 (and org-auto-align-tags
11981 (let ((org-loop-over-headlines-in-active-region nil))
11982 (org-set-tags nil t)))
11983 (let ((bookmark-name (plist-get org-bookmark-names-plist
11984 :last-refile)))
11985 (when bookmark-name
11986 (with-demoted-errors
11987 (bookmark-set bookmark-name))))
11988 ;; If we are refiling for capture, make sure that the
11989 ;; last-capture pointers point here
11990 (when (org-bound-and-true-p org-refile-for-capture)
11991 (let ((bookmark-name (plist-get org-bookmark-names-plist
11992 :last-capture-marker)))
11993 (when bookmark-name
11994 (with-demoted-errors
11995 (bookmark-set bookmark-name))))
11996 (move-marker org-capture-last-stored-marker (point)))
11997 (if (fboundp 'deactivate-mark) (deactivate-mark))
11998 (run-hooks 'org-after-refile-insert-hook))))
11999 (unless org-refile-keep
12000 (if regionp
12001 (delete-region (point) (+ (point) (- region-end region-start)))
12002 (delete-region
12003 (and (org-back-to-heading t) (point))
12004 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
12005 (when (featurep 'org-inlinetask)
12006 (org-inlinetask-remove-END-maybe))
12007 (setq org-markers-to-move nil)
12008 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
12010 (defun org-refile-goto-last-stored ()
12011 "Go to the location where the last refile was stored."
12012 (interactive)
12013 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
12014 (message "This is the location of the last refile"))
12016 (defun org-refile--get-location (refloc tbl)
12017 "When user refile to REFLOC, find the associated target in TBL.
12018 Also check `org-refile-target-table'."
12019 (car (delq
12021 (mapcar
12022 (lambda (r) (or (assoc r tbl)
12023 (assoc r org-refile-target-table)))
12024 (list (replace-regexp-in-string "/$" "" refloc)
12025 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12027 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
12028 no-exclude)
12029 "Prompt the user for a refile location, using PROMPT.
12030 PROMPT should not be suffixed with a colon and a space, because
12031 this function appends the default value from
12032 `org-refile-history' automatically, if that is not empty.
12033 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12034 this is used for the GOTO interface."
12035 (let ((org-refile-targets org-refile-targets)
12036 (org-refile-use-outline-path org-refile-use-outline-path)
12037 excluded-entries)
12038 (when (and (derived-mode-p 'org-mode)
12039 (not org-refile-use-cache)
12040 (not no-exclude))
12041 (org-map-tree
12042 (lambda()
12043 (setq excluded-entries
12044 (append excluded-entries (list (org-get-heading t t)))))))
12045 (setq org-refile-target-table
12046 (org-refile-get-targets default-buffer excluded-entries)))
12047 (unless org-refile-target-table
12048 (user-error "No refile targets"))
12049 (let* ((cbuf (current-buffer))
12050 (partial-completion-mode nil)
12051 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12052 (cfunc (if (and org-refile-use-outline-path
12053 org-outline-path-complete-in-steps)
12054 'org-olpath-completing-read
12055 'org-icompleting-read))
12056 (extra (if org-refile-use-outline-path "/" ""))
12057 (cbnex (concat (buffer-name) extra))
12058 (filename (and cfn (expand-file-name cfn)))
12059 (tbl (mapcar
12060 (lambda (x)
12061 (if (and (not (member org-refile-use-outline-path
12062 '(file full-file-path)))
12063 (not (equal filename (nth 1 x))))
12064 (cons (concat (car x) extra " ("
12065 (file-name-nondirectory (nth 1 x)) ")")
12066 (cdr x))
12067 (cons (concat (car x) extra) (cdr x))))
12068 org-refile-target-table))
12069 (completion-ignore-case t)
12070 cdef
12071 (prompt (concat prompt
12072 (or (and (car org-refile-history)
12073 (concat " (default " (car org-refile-history) ")"))
12074 (and (assoc cbnex tbl) (setq cdef cbnex)
12075 (concat " (default " cbnex ")"))) ": "))
12076 pa answ parent-target child parent old-hist)
12077 (setq old-hist org-refile-history)
12078 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12079 nil 'org-refile-history (or cdef (car org-refile-history))))
12080 (if (setq pa (org-refile--get-location answ tbl))
12081 (progn
12082 (org-refile-check-position pa)
12083 (when (or (not org-refile-history)
12084 (not (eq old-hist org-refile-history))
12085 (not (equal (car pa) (car org-refile-history))))
12086 (setq org-refile-history
12087 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12088 org-refile-history
12089 (cdr org-refile-history))))
12090 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12091 (pop org-refile-history)))
12093 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12094 (progn
12095 (setq parent (match-string 1 answ)
12096 child (match-string 2 answ))
12097 (setq parent-target (org-refile--get-location parent tbl))
12098 (when (and parent-target
12099 (or (eq new-nodes t)
12100 (and (eq new-nodes 'confirm)
12101 (y-or-n-p (format "Create new node \"%s\"? "
12102 child)))))
12103 (org-refile-new-child parent-target child)))
12104 (user-error "Invalid target location")))))
12106 (declare-function org-string-nw-p "org-macs" (s))
12107 (defun org-refile-check-position (refile-pointer)
12108 "Check if the refile pointer matches the headline to which it points."
12109 (let* ((file (nth 1 refile-pointer))
12110 (re (nth 2 refile-pointer))
12111 (pos (nth 3 refile-pointer))
12112 buffer)
12113 (if (and (not (markerp pos)) (not file))
12114 (user-error "Please indicate a target file in the refile path")
12115 (when (org-string-nw-p re)
12116 (setq buffer (if (markerp pos)
12117 (marker-buffer pos)
12118 (or (find-buffer-visiting file)
12119 (find-file-noselect file))))
12120 (with-current-buffer buffer
12121 (save-excursion
12122 (save-restriction
12123 (widen)
12124 (goto-char pos)
12125 (beginning-of-line 1)
12126 (unless (org-looking-at-p re)
12127 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12129 (defun org-refile-new-child (parent-target child)
12130 "Use refile target PARENT-TARGET to add new CHILD below it."
12131 (unless parent-target
12132 (error "Cannot find parent for new node"))
12133 (let ((file (nth 1 parent-target))
12134 (pos (nth 3 parent-target))
12135 level)
12136 (with-current-buffer (or (find-buffer-visiting file)
12137 (find-file-noselect file))
12138 (save-excursion
12139 (save-restriction
12140 (widen)
12141 (if pos
12142 (goto-char pos)
12143 (goto-char (point-max))
12144 (if (not (bolp)) (newline)))
12145 (when (looking-at org-outline-regexp)
12146 (setq level (funcall outline-level))
12147 (org-end-of-subtree t t))
12148 (org-back-over-empty-lines)
12149 (insert "\n" (make-string
12150 (if pos (org-get-valid-level level 1) 1) ?*)
12151 " " child "\n")
12152 (beginning-of-line 0)
12153 (list (concat (car parent-target) "/" child) file "" (point)))))))
12155 (defun org-olpath-completing-read (prompt collection &rest args)
12156 "Read an outline path like a file name."
12157 (let ((thetable collection)
12158 (org-completion-use-ido nil) ; does not work with ido.
12159 (org-completion-use-iswitchb nil)) ; or iswitchb
12160 (apply
12161 'org-icompleting-read prompt
12162 (lambda (string predicate &optional flag)
12163 (let (rtn r f (l (length string)))
12164 (cond
12165 ((eq flag nil)
12166 ;; try completion
12167 (try-completion string thetable))
12168 ((eq flag t)
12169 ;; all-completions
12170 (setq rtn (all-completions string thetable predicate))
12171 (mapcar
12172 (lambda (x)
12173 (setq r (substring x l))
12174 (if (string-match " ([^)]*)$" x)
12175 (setq f (match-string 0 x))
12176 (setq f ""))
12177 (if (string-match "/" r)
12178 (concat string (substring r 0 (match-end 0)) f)
12180 rtn))
12181 ((eq flag 'lambda)
12182 ;; exact match?
12183 (assoc string thetable)))))
12184 args)))
12186 ;;;; Dynamic blocks
12188 (defun org-find-dblock (name)
12189 "Find the first dynamic block with name NAME in the buffer.
12190 If not found, stay at current position and return nil."
12191 (let ((case-fold-search t) pos)
12192 (save-excursion
12193 (goto-char (point-min))
12194 (setq pos (and (re-search-forward
12195 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12196 (match-beginning 0))))
12197 (if pos (goto-char pos))
12198 pos))
12200 (defun org-create-dblock (plist)
12201 "Create a dynamic block section, with parameters taken from PLIST.
12202 PLIST must contain a :name entry which is used as the name of the block."
12203 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12204 (end-of-line 1)
12205 (newline))
12206 (let ((col (current-column))
12207 (name (plist-get plist :name)))
12208 (insert "#+BEGIN: " name)
12209 (while plist
12210 (if (eq (car plist) :name)
12211 (setq plist (cddr plist))
12212 (insert " " (prin1-to-string (pop plist)))))
12213 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12214 (beginning-of-line -2)))
12216 (defun org-prepare-dblock ()
12217 "Prepare dynamic block for refresh.
12218 This empties the block, puts the cursor at the insert position and returns
12219 the property list including an extra property :name with the block name."
12220 (unless (looking-at org-dblock-start-re)
12221 (user-error "Not at a dynamic block"))
12222 (let* ((begdel (1+ (match-end 0)))
12223 (name (org-no-properties (match-string 1)))
12224 (params (append (list :name name)
12225 (read (concat "(" (match-string 3) ")")))))
12226 (save-excursion
12227 (beginning-of-line 1)
12228 (skip-chars-forward " \t")
12229 (setq params (plist-put params :indentation-column (current-column))))
12230 (unless (re-search-forward org-dblock-end-re nil t)
12231 (error "Dynamic block not terminated"))
12232 (setq params
12233 (append params
12234 (list :content (buffer-substring
12235 begdel (match-beginning 0)))))
12236 (delete-region begdel (match-beginning 0))
12237 (goto-char begdel)
12238 (open-line 1)
12239 params))
12241 (defun org-map-dblocks (&optional command)
12242 "Apply COMMAND to all dynamic blocks in the current buffer.
12243 If COMMAND is not given, use `org-update-dblock'."
12244 (let ((cmd (or command 'org-update-dblock)))
12245 (save-excursion
12246 (goto-char (point-min))
12247 (while (re-search-forward org-dblock-start-re nil t)
12248 (goto-char (match-beginning 0))
12249 (save-excursion
12250 (condition-case nil
12251 (funcall cmd)
12252 (error (message "Error during update of dynamic block"))))
12253 (unless (re-search-forward org-dblock-end-re nil t)
12254 (error "Dynamic block not terminated"))))))
12256 (defun org-dblock-update (&optional arg)
12257 "User command for updating dynamic blocks.
12258 Update the dynamic block at point. With prefix ARG, update all dynamic
12259 blocks in the buffer."
12260 (interactive "P")
12261 (if arg
12262 (org-update-all-dblocks)
12263 (or (looking-at org-dblock-start-re)
12264 (org-beginning-of-dblock))
12265 (org-update-dblock)))
12267 (defun org-update-dblock ()
12268 "Update the dynamic block at point.
12269 This means to empty the block, parse for parameters and then call
12270 the correct writing function."
12271 (interactive)
12272 (save-excursion
12273 (let* ((win (selected-window))
12274 (pos (point))
12275 (line (org-current-line))
12276 (params (org-prepare-dblock))
12277 (name (plist-get params :name))
12278 (indent (plist-get params :indentation-column))
12279 (cmd (intern (concat "org-dblock-write:" name))))
12280 (message "Updating dynamic block `%s' at line %d..." name line)
12281 (funcall cmd params)
12282 (message "Updating dynamic block `%s' at line %d...done" name line)
12283 (goto-char pos)
12284 (when (and indent (> indent 0))
12285 (setq indent (make-string indent ?\ ))
12286 (save-excursion
12287 (select-window win)
12288 (org-beginning-of-dblock)
12289 (forward-line 1)
12290 (while (not (looking-at org-dblock-end-re))
12291 (insert indent)
12292 (beginning-of-line 2))
12293 (when (looking-at org-dblock-end-re)
12294 (and (looking-at "[ \t]+")
12295 (replace-match ""))
12296 (insert indent)))))))
12298 (defun org-beginning-of-dblock ()
12299 "Find the beginning of the dynamic block at point.
12300 Error if there is no such block at point."
12301 (let ((pos (point))
12302 beg)
12303 (end-of-line 1)
12304 (if (and (re-search-backward org-dblock-start-re nil t)
12305 (setq beg (match-beginning 0))
12306 (re-search-forward org-dblock-end-re nil t)
12307 (> (match-end 0) pos))
12308 (goto-char beg)
12309 (goto-char pos)
12310 (error "Not in a dynamic block"))))
12312 (defun org-update-all-dblocks ()
12313 "Update all dynamic blocks in the buffer.
12314 This function can be used in a hook."
12315 (interactive)
12316 (when (derived-mode-p 'org-mode)
12317 (org-map-dblocks 'org-update-dblock)))
12320 ;;;; Completion
12322 (declare-function org-export-backend-name "org-export" (cl-x))
12323 (declare-function org-export-backend-options "org-export" (cl-x))
12324 (defun org-get-export-keywords ()
12325 "Return a list of all currently understood export keywords.
12326 Export keywords include options, block names, attributes and
12327 keywords relative to each registered export back-end."
12328 (let (keywords)
12329 (dolist (backend
12330 (org-bound-and-true-p org-export--registered-backends)
12331 (delq nil keywords))
12332 ;; Back-end name (for keywords, like #+LATEX:)
12333 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12334 (dolist (option-entry (org-export-backend-options backend))
12335 ;; Back-end options.
12336 (push (nth 1 option-entry) keywords)))))
12338 (defconst org-options-keywords
12339 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12340 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12341 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12342 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12343 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12345 (defcustom org-structure-template-alist
12346 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12347 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12348 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12349 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12350 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12351 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12352 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12353 ("L" "#+LaTeX: ")
12354 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12355 ("H" "#+HTML: ")
12356 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12357 ("A" "#+ASCII: ")
12358 ("i" "#+INDEX: ?")
12359 ("I" "#+INCLUDE: %file ?"))
12360 "Structure completion elements.
12361 This is a list of abbreviation keys and values. The value gets inserted
12362 if you type `<' followed by the key and then press the completion key,
12363 usually `TAB'. %file will be replaced by a file name after prompting
12364 for the file using completion. The cursor will be placed at the position
12365 of the `?` in the template.
12366 There are two templates for each key, the first uses the original Org syntax,
12367 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12368 the default when the /org-mtags.el/ module has been loaded. See also the
12369 variable `org-mtags-prefer-muse-templates'."
12370 :group 'org-completion
12371 :type '(repeat
12372 (list
12373 (string :tag "Key")
12374 (string :tag "Template")))
12375 :version "25.1"
12376 :package-version '(Org . "8.3"))
12378 (defun org-try-structure-completion ()
12379 "Try to complete a structure template before point.
12380 This looks for strings like \"<e\" on an otherwise empty line and
12381 expands them."
12382 (let ((l (buffer-substring (point-at-bol) (point)))
12384 (when (and (looking-at "[ \t]*$")
12385 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12386 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12387 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12388 (match-beginning 1)) a)
12389 t)))
12391 (defun org-complete-expand-structure-template (start cell)
12392 "Expand a structure template."
12393 (let ((rpl (nth 1 cell))
12394 (ind ""))
12395 (delete-region start (point))
12396 (when (string-match "\\`[ \t]*#\\+" rpl)
12397 (cond
12398 ((bolp))
12399 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12400 (setq ind (buffer-substring (point-at-bol) (point))))
12401 (t (newline))))
12402 (setq start (point))
12403 (if (string-match "%file" rpl)
12404 (setq rpl (replace-match
12405 (concat
12406 "\""
12407 (save-match-data
12408 (abbreviate-file-name (read-file-name "Include file: ")))
12409 "\"")
12410 t t rpl)))
12411 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12412 (concat "\n" ind)))
12413 (insert rpl)
12414 (if (re-search-backward "\\?" start t) (delete-char 1))))
12416 ;;;; TODO, DEADLINE, Comments
12418 (defun org-toggle-comment ()
12419 "Change the COMMENT state of an entry."
12420 (interactive)
12421 (save-excursion
12422 (org-back-to-heading)
12423 (looking-at org-complex-heading-regexp)
12424 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12425 (skip-chars-forward " \t")
12426 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12427 (if (org-in-commented-heading-p t)
12428 (delete-region (point)
12429 (progn (search-forward " " (line-end-position) 'move)
12430 (skip-chars-forward " \t")
12431 (point)))
12432 (insert org-comment-string)
12433 (unless (eolp) (insert " ")))))
12435 (defvar org-last-todo-state-is-todo nil
12436 "This is non-nil when the last TODO state change led to a TODO state.
12437 If the last change removed the TODO tag or switched to DONE, then
12438 this is nil.")
12440 (defvar org-setting-tags nil) ; dynamically skipped
12442 (defvar org-todo-setup-filter-hook nil
12443 "Hook for functions that pre-filter todo specs.
12444 Each function takes a todo spec and returns either nil or the spec
12445 transformed into canonical form." )
12447 (defvar org-todo-get-default-hook nil
12448 "Hook for functions that get a default item for todo.
12449 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12450 nil or a string to be used for the todo mark." )
12452 (defvar org-agenda-headline-snapshot-before-repeat)
12454 (defun org-current-effective-time ()
12455 "Return current time adjusted for `org-extend-today-until' variable."
12456 (let* ((ct (org-current-time))
12457 (dct (decode-time ct))
12458 (ct1
12459 (cond
12460 (org-use-last-clock-out-time-as-effective-time
12461 (or (org-clock-get-last-clock-out-time) ct))
12462 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12463 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12464 (t ct))))
12465 ct1))
12467 (defun org-todo-yesterday (&optional arg)
12468 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12469 (interactive "P")
12470 (if (eq major-mode 'org-agenda-mode)
12471 (apply 'org-agenda-todo-yesterday arg)
12472 (let* ((hour (third (decode-time
12473 (org-current-time))))
12474 (org-extend-today-until (1+ hour)))
12475 (org-todo arg))))
12477 (defvar org-block-entry-blocking ""
12478 "First entry preventing the TODO state change.")
12480 (defun org-cancel-repeater ()
12481 "Cancel a repeater by setting its numeric value to zero."
12482 (interactive)
12483 (save-excursion
12484 (org-back-to-heading t)
12485 (let ((bound1 (point))
12486 (bound0 (save-excursion (outline-next-heading) (point))))
12487 (when (re-search-forward
12488 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12489 org-deadline-time-regexp "\\)\\|\\("
12490 org-ts-regexp "\\)")
12491 bound0 t)
12492 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12493 (replace-match "0" t nil nil 1))))))
12495 (defun org-todo (&optional arg)
12496 "Change the TODO state of an item.
12497 The state of an item is given by a keyword at the start of the heading,
12498 like
12499 *** TODO Write paper
12500 *** DONE Call mom
12502 The different keywords are specified in the variable `org-todo-keywords'.
12503 By default the available states are \"TODO\" and \"DONE\".
12504 So for this example: when the item starts with TODO, it is changed to DONE.
12505 When it starts with DONE, the DONE is removed. And when neither TODO nor
12506 DONE are present, add TODO at the beginning of the heading.
12508 With \\[universal-argument] prefix arg, use completion to determine the new \
12509 state.
12510 With numeric prefix arg, switch to that state.
12511 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12512 keywords (nextset).
12513 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12514 With a numeric prefix arg of 0, inhibit note taking for the change.
12515 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12517 When called through ELisp, arg is also interpreted in the following way:
12518 'none -> empty state
12519 \"\"(empty string) -> switch to empty state
12520 'done -> switch to DONE
12521 'nextset -> switch to the next set of keywords
12522 'previousset -> switch to the previous set of keywords
12523 \"WAITING\" -> switch to the specified keyword, but only if it
12524 really is a member of `org-todo-keywords'."
12525 (interactive "P")
12526 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12527 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12528 'region-start-level 'region))
12529 org-loop-over-headlines-in-active-region)
12530 (org-map-entries
12531 `(org-todo ,arg)
12532 org-loop-over-headlines-in-active-region
12533 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12534 (if (equal arg '(16)) (setq arg 'nextset))
12535 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12536 (let ((org-blocker-hook org-blocker-hook)
12537 commentp
12538 case-fold-search)
12539 (when (equal arg '(64))
12540 (setq arg nil org-blocker-hook nil))
12541 (when (and org-blocker-hook
12542 (or org-inhibit-blocking
12543 (org-entry-get nil "NOBLOCKING")))
12544 (setq org-blocker-hook nil))
12545 (save-excursion
12546 (catch 'exit
12547 (org-back-to-heading t)
12548 (when (org-in-commented-heading-p t)
12549 (org-toggle-comment)
12550 (setq commentp t))
12551 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12552 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12553 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12554 (let* ((match-data (match-data))
12555 (startpos (point-at-bol))
12556 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12557 (org-log-done org-log-done)
12558 (org-log-repeat org-log-repeat)
12559 (org-todo-log-states org-todo-log-states)
12560 (org-inhibit-logging
12561 (if (equal arg 0)
12562 (progn (setq arg nil) 'note) org-inhibit-logging))
12563 (this (match-string 1))
12564 (hl-pos (match-beginning 0))
12565 (head (org-get-todo-sequence-head this))
12566 (ass (assoc head org-todo-kwd-alist))
12567 (interpret (nth 1 ass))
12568 (done-word (nth 3 ass))
12569 (final-done-word (nth 4 ass))
12570 (org-last-state (or this ""))
12571 (completion-ignore-case t)
12572 (member (member this org-todo-keywords-1))
12573 (tail (cdr member))
12574 (org-state (cond
12575 ((and org-todo-key-trigger
12576 (or (and (equal arg '(4))
12577 (eq org-use-fast-todo-selection 'prefix))
12578 (and (not arg) org-use-fast-todo-selection
12579 (not (eq org-use-fast-todo-selection
12580 'prefix)))))
12581 ;; Use fast selection
12582 (org-fast-todo-selection))
12583 ((and (equal arg '(4))
12584 (or (not org-use-fast-todo-selection)
12585 (not org-todo-key-trigger)))
12586 ;; Read a state with completion
12587 (org-icompleting-read
12588 "State: " (mapcar 'list org-todo-keywords-1)
12589 nil t))
12590 ((eq arg 'right)
12591 (if this
12592 (if tail (car tail) nil)
12593 (car org-todo-keywords-1)))
12594 ((eq arg 'left)
12595 (if (equal member org-todo-keywords-1)
12597 (if this
12598 (nth (- (length org-todo-keywords-1)
12599 (length tail) 2)
12600 org-todo-keywords-1)
12601 (org-last org-todo-keywords-1))))
12602 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12603 (setq arg nil))) ; hack to fall back to cycling
12604 (arg
12605 ;; user or caller requests a specific state
12606 (cond
12607 ((equal arg "") nil)
12608 ((eq arg 'none) nil)
12609 ((eq arg 'done) (or done-word (car org-done-keywords)))
12610 ((eq arg 'nextset)
12611 (or (car (cdr (member head org-todo-heads)))
12612 (car org-todo-heads)))
12613 ((eq arg 'previousset)
12614 (let ((org-todo-heads (reverse org-todo-heads)))
12615 (or (car (cdr (member head org-todo-heads)))
12616 (car org-todo-heads))))
12617 ((car (member arg org-todo-keywords-1)))
12618 ((stringp arg)
12619 (user-error "State `%s' not valid in this file" arg))
12620 ((nth (1- (prefix-numeric-value arg))
12621 org-todo-keywords-1))))
12622 ((null member) (or head (car org-todo-keywords-1)))
12623 ((equal this final-done-word) nil) ;; -> make empty
12624 ((null tail) nil) ;; -> first entry
12625 ((memq interpret '(type priority))
12626 (if (eq this-command last-command)
12627 (car tail)
12628 (if (> (length tail) 0)
12629 (or done-word (car org-done-keywords))
12630 nil)))
12632 (car tail))))
12633 (org-state (or
12634 (run-hook-with-args-until-success
12635 'org-todo-get-default-hook org-state org-last-state)
12636 org-state))
12637 (next (if org-state (concat " " org-state " ") " "))
12638 (change-plist (list :type 'todo-state-change :from this :to org-state
12639 :position startpos))
12640 dolog now-done-p)
12641 (when org-blocker-hook
12642 (setq org-last-todo-state-is-todo
12643 (not (member this org-done-keywords)))
12644 (unless (save-excursion
12645 (save-match-data
12646 (org-with-wide-buffer
12647 (run-hook-with-args-until-failure
12648 'org-blocker-hook change-plist))))
12649 (if (org-called-interactively-p 'interactive)
12650 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12651 this org-state org-block-entry-blocking)
12652 ;; fail silently
12653 (message "TODO state change from %s to %s blocked (by \"%s\")"
12654 this org-state org-block-entry-blocking)
12655 (throw 'exit nil))))
12656 (store-match-data match-data)
12657 (replace-match next t t)
12658 (cond ((equal this org-state)
12659 (message "TODO state was already %s" (org-trim next)))
12660 ((pos-visible-in-window-p hl-pos)
12661 (message "TODO state changed to %s" (org-trim next))))
12662 (unless head
12663 (setq head (org-get-todo-sequence-head org-state)
12664 ass (assoc head org-todo-kwd-alist)
12665 interpret (nth 1 ass)
12666 done-word (nth 3 ass)
12667 final-done-word (nth 4 ass)))
12668 (when (memq arg '(nextset previousset))
12669 (message "Keyword-Set %d/%d: %s"
12670 (- (length org-todo-sets) -1
12671 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12672 (length org-todo-sets)
12673 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12674 (setq org-last-todo-state-is-todo
12675 (not (member org-state org-done-keywords)))
12676 (setq now-done-p (and (member org-state org-done-keywords)
12677 (not (member this org-done-keywords))))
12678 (and logging (org-local-logging logging))
12679 (when (and (or org-todo-log-states org-log-done)
12680 (not (eq org-inhibit-logging t))
12681 (not (memq arg '(nextset previousset))))
12682 ;; we need to look at recording a time and note
12683 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12684 (nth 2 (assoc this org-todo-log-states))))
12685 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12686 (setq dolog 'time))
12687 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12688 (and org-state
12689 (member org-state org-not-done-keywords)
12690 (not (member this org-not-done-keywords))))
12691 ;; This is now a todo state and was not one before
12692 ;; If there was a CLOSED time stamp, get rid of it.
12693 (org-add-planning-info nil nil 'closed))
12694 (when (and now-done-p org-log-done)
12695 ;; It is now done, and it was not done before
12696 (org-add-planning-info 'closed (org-current-effective-time))
12697 (if (and (not dolog) (eq 'note org-log-done))
12698 (org-add-log-setup 'done org-state this 'findpos 'note)))
12699 (when (and org-state dolog)
12700 ;; This is a non-nil state, and we need to log it
12701 (org-add-log-setup 'state org-state this 'findpos dolog)))
12702 ;; Fixup tag positioning
12703 (org-todo-trigger-tag-changes org-state)
12704 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12705 (when org-provide-todo-statistics
12706 (org-update-parent-todo-statistics))
12707 (run-hooks 'org-after-todo-state-change-hook)
12708 (if (and arg (not (member org-state org-done-keywords)))
12709 (setq head (org-get-todo-sequence-head org-state)))
12710 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12711 ;; Do we need to trigger a repeat?
12712 (when now-done-p
12713 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12714 ;; This is for the agenda, take a snapshot of the headline.
12715 (save-match-data
12716 (setq org-agenda-headline-snapshot-before-repeat
12717 (org-get-heading))))
12718 (org-auto-repeat-maybe org-state))
12719 ;; Fixup cursor location if close to the keyword
12720 (if (and (outline-on-heading-p)
12721 (not (bolp))
12722 (save-excursion (beginning-of-line 1)
12723 (looking-at org-todo-line-regexp))
12724 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12725 (progn
12726 (goto-char (or (match-end 2) (match-end 1)))
12727 (and (looking-at " ") (just-one-space))))
12728 (when org-trigger-hook
12729 (save-excursion
12730 (run-hook-with-args 'org-trigger-hook change-plist)))
12731 (when commentp (org-toggle-comment))))))))
12733 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12734 "Block turning an entry into a TODO, using the hierarchy.
12735 This checks whether the current task should be blocked from state
12736 changes. Such blocking occurs when:
12738 1. The task has children which are not all in a completed state.
12740 2. A task has a parent with the property :ORDERED:, and there
12741 are siblings prior to the current task with incomplete
12742 status.
12744 3. The parent of the task is blocked because it has siblings that should
12745 be done first, or is child of a block grandparent TODO entry."
12747 (if (not org-enforce-todo-dependencies)
12748 t ; if locally turned off don't block
12749 (catch 'dont-block
12750 ;; If this is not a todo state change, or if this entry is already DONE,
12751 ;; do not block
12752 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12753 (member (plist-get change-plist :from)
12754 (cons 'done org-done-keywords))
12755 (member (plist-get change-plist :to)
12756 (cons 'todo org-not-done-keywords))
12757 (not (plist-get change-plist :to)))
12758 (throw 'dont-block t))
12759 ;; If this task has children, and any are undone, it's blocked
12760 (save-excursion
12761 (org-back-to-heading t)
12762 (let ((this-level (funcall outline-level)))
12763 (outline-next-heading)
12764 (let ((child-level (funcall outline-level)))
12765 (while (and (not (eobp))
12766 (> child-level this-level))
12767 ;; this todo has children, check whether they are all
12768 ;; completed
12769 (if (and (not (org-entry-is-done-p))
12770 (org-entry-is-todo-p))
12771 (progn (setq org-block-entry-blocking (org-get-heading))
12772 (throw 'dont-block nil)))
12773 (outline-next-heading)
12774 (setq child-level (funcall outline-level))))))
12775 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12776 ;; any previous siblings are undone, it's blocked
12777 (save-excursion
12778 (org-back-to-heading t)
12779 (let* ((pos (point))
12780 (parent-pos (and (org-up-heading-safe) (point))))
12781 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12782 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12783 (forward-line 1)
12784 (re-search-forward org-not-done-heading-regexp pos t))
12785 (setq org-block-entry-blocking (match-string 0))
12786 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12787 ;; Search further up the hierarchy, to see if an ancestor is blocked
12788 (while t
12789 (goto-char parent-pos)
12790 (if (not (looking-at org-not-done-heading-regexp))
12791 (throw 'dont-block t)) ; do not block, parent is not a TODO
12792 (setq pos (point))
12793 (setq parent-pos (and (org-up-heading-safe) (point)))
12794 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12795 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12796 (forward-line 1)
12797 (re-search-forward org-not-done-heading-regexp pos t)
12798 (setq org-block-entry-blocking (org-get-heading)))
12799 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12801 (defcustom org-track-ordered-property-with-tag nil
12802 "Should the ORDERED property also be shown as a tag?
12803 The ORDERED property decides if an entry should require subtasks to be
12804 completed in sequence. Since a property is not very visible, setting
12805 this option means that toggling the ORDERED property with the command
12806 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12807 not relevant for the behavior, but it makes things more visible.
12809 Note that toggling the tag with tags commands will not change the property
12810 and therefore not influence behavior!
12812 This can be t, meaning the tag ORDERED should be used, It can also be a
12813 string to select a different tag for this task."
12814 :group 'org-todo
12815 :type '(choice
12816 (const :tag "No tracking" nil)
12817 (const :tag "Track with ORDERED tag" t)
12818 (string :tag "Use other tag")))
12820 (defun org-toggle-ordered-property ()
12821 "Toggle the ORDERED property of the current entry.
12822 For better visibility, you can track the value of this property with a tag.
12823 See variable `org-track-ordered-property-with-tag'."
12824 (interactive)
12825 (let* ((t1 org-track-ordered-property-with-tag)
12826 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12827 (save-excursion
12828 (org-back-to-heading)
12829 (if (org-entry-get nil "ORDERED")
12830 (progn
12831 (org-delete-property "ORDERED")
12832 (and tag (org-toggle-tag tag 'off))
12833 (message "Subtasks can be completed in arbitrary order"))
12834 (org-entry-put nil "ORDERED" "t")
12835 (and tag (org-toggle-tag tag 'on))
12836 (message "Subtasks must be completed in sequence")))))
12838 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12839 (defun org-block-todo-from-checkboxes (change-plist)
12840 "Block turning an entry into a TODO, using checkboxes.
12841 This checks whether the current task should be blocked from state
12842 changes because there are unchecked boxes in this entry."
12843 (if (not org-enforce-todo-checkbox-dependencies)
12844 t ; if locally turned off don't block
12845 (catch 'dont-block
12846 ;; If this is not a todo state change, or if this entry is already DONE,
12847 ;; do not block
12848 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12849 (member (plist-get change-plist :from)
12850 (cons 'done org-done-keywords))
12851 (member (plist-get change-plist :to)
12852 (cons 'todo org-not-done-keywords))
12853 (not (plist-get change-plist :to)))
12854 (throw 'dont-block t))
12855 ;; If this task has checkboxes that are not checked, it's blocked
12856 (save-excursion
12857 (org-back-to-heading t)
12858 (let ((beg (point)) end)
12859 (outline-next-heading)
12860 (setq end (point))
12861 (goto-char beg)
12862 (if (org-list-search-forward
12863 (concat (org-item-beginning-re)
12864 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12865 "\\[[- ]\\]")
12866 end t)
12867 (progn
12868 (if (boundp 'org-blocked-by-checkboxes)
12869 (setq org-blocked-by-checkboxes t))
12870 (throw 'dont-block nil)))))
12871 t))) ; do not block
12873 (defun org-entry-blocked-p ()
12874 "Is the current entry blocked?"
12875 (org-with-silent-modifications
12876 (if (org-entry-get nil "NOBLOCKING")
12877 nil ;; Never block this entry
12878 (not (run-hook-with-args-until-failure
12879 'org-blocker-hook
12880 (list :type 'todo-state-change
12881 :position (point)
12882 :from 'todo
12883 :to 'done))))))
12885 (defun org-update-statistics-cookies (all)
12886 "Update the statistics cookie, either from TODO or from checkboxes.
12887 This should be called with the cursor in a line with a statistics cookie."
12888 (interactive "P")
12889 (if all
12890 (progn
12891 (org-update-checkbox-count 'all)
12892 (org-map-entries 'org-update-parent-todo-statistics))
12893 (if (not (org-at-heading-p))
12894 (org-update-checkbox-count)
12895 (let ((pos (point-marker))
12896 end l1 l2)
12897 (ignore-errors (org-back-to-heading t))
12898 (if (not (org-at-heading-p))
12899 (org-update-checkbox-count)
12900 (setq l1 (org-outline-level))
12901 (setq end (save-excursion
12902 (outline-next-heading)
12903 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12904 (point)))
12905 (if (and (save-excursion
12906 (re-search-forward
12907 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12908 (not (save-excursion (re-search-forward
12909 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12910 (org-update-checkbox-count)
12911 (if (and l2 (> l2 l1))
12912 (progn
12913 (goto-char end)
12914 (org-update-parent-todo-statistics))
12915 (goto-char pos)
12916 (beginning-of-line 1)
12917 (while (re-search-forward
12918 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12919 (point-at-eol) t)
12920 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12921 (goto-char pos)
12922 (move-marker pos nil)))))
12924 (defvar org-entry-property-inherited-from) ;; defined below
12925 (defun org-update-parent-todo-statistics ()
12926 "Update any statistics cookie in the parent of the current headline.
12927 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12928 the entire subtree and this will travel up the hierarchy and update
12929 statistics everywhere."
12930 (let* ((prop (save-excursion (org-up-heading-safe)
12931 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12932 (recursive (or (not org-hierarchical-todo-statistics)
12933 (and prop (string-match "\\<recursive\\>" prop))))
12934 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12936 (first t)
12937 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12938 level ltoggle l1 new ndel
12939 (cnt-all 0) (cnt-done 0) is-percent kwd
12940 checkbox-beg ov ovs ove cookie-present)
12941 (catch 'exit
12942 (save-excursion
12943 (beginning-of-line 1)
12944 (setq ltoggle (funcall outline-level))
12945 ;; Three situations are to consider:
12947 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12948 ;; to the top-level ancestor on the headline;
12950 ;; 2. If parent has "recursive" property, repeat up to the
12951 ;; headline setting that property, taking inheritance into
12952 ;; account;
12954 ;; 3. Else, move up to direct parent and proceed only once.
12955 (while (and (setq level (org-up-heading-safe))
12956 (or recursive first)
12957 (>= (point) lim))
12958 (setq first nil cookie-present nil)
12959 (unless (and level
12960 (not (string-match
12961 "\\<checkbox\\>"
12962 (downcase (or (org-entry-get nil "COOKIE_DATA")
12963 "")))))
12964 (throw 'exit nil))
12965 (while (re-search-forward box-re (point-at-eol) t)
12966 (setq cnt-all 0 cnt-done 0 cookie-present t)
12967 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12968 (save-match-data
12969 (unless (outline-next-heading) (throw 'exit nil))
12970 (while (and (looking-at org-complex-heading-regexp)
12971 (> (setq l1 (length (match-string 1))) level))
12972 (setq kwd (and (or recursive (= l1 ltoggle))
12973 (match-string 2)))
12974 (if (or (eq org-provide-todo-statistics 'all-headlines)
12975 (and (eq org-provide-todo-statistics t)
12976 (or (member kwd org-done-keywords)))
12977 (and (listp org-provide-todo-statistics)
12978 (stringp (car org-provide-todo-statistics))
12979 (or (member kwd org-provide-todo-statistics)
12980 (member kwd org-done-keywords)))
12981 (and (listp org-provide-todo-statistics)
12982 (listp (car org-provide-todo-statistics))
12983 (or (member kwd (car org-provide-todo-statistics))
12984 (and (member kwd org-done-keywords)
12985 (member kwd (cadr org-provide-todo-statistics))))))
12986 (setq cnt-all (1+ cnt-all))
12987 (if (eq org-provide-todo-statistics t)
12988 (and kwd (setq cnt-all (1+ cnt-all)))))
12989 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12990 (member kwd org-done-keywords))
12991 (and (listp org-provide-todo-statistics)
12992 (listp (car org-provide-todo-statistics))
12993 (member kwd org-done-keywords)
12994 (member kwd (cadr org-provide-todo-statistics)))
12995 (and (listp org-provide-todo-statistics)
12996 (stringp (car org-provide-todo-statistics))
12997 (member kwd org-done-keywords)))
12998 (setq cnt-done (1+ cnt-done)))
12999 (outline-next-heading)))
13000 (setq new
13001 (if is-percent
13002 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
13003 (format "[%d/%d]" cnt-done cnt-all))
13004 ndel (- (match-end 0) checkbox-beg))
13005 ;; handle overlays when updating cookie from column view
13006 (when (setq ov (car (overlays-at checkbox-beg)))
13007 (setq ovs (overlay-start ov) ove (overlay-end ov))
13008 (delete-overlay ov))
13009 (goto-char checkbox-beg)
13010 (insert new)
13011 (delete-region (point) (+ (point) ndel))
13012 (when org-auto-align-tags (org-fix-tags-on-the-fly))
13013 (when ov (move-overlay ov ovs ove)))
13014 (when cookie-present
13015 (run-hook-with-args 'org-after-todo-statistics-hook
13016 cnt-done (- cnt-all cnt-done))))))
13017 (run-hooks 'org-todo-statistics-hook)))
13019 (defvar org-after-todo-statistics-hook nil
13020 "Hook that is called after a TODO statistics cookie has been updated.
13021 Each function is called with two arguments: the number of not-done entries
13022 and the number of done entries.
13024 For example, the following function, when added to this hook, will switch
13025 an entry to DONE when all children are done, and back to TODO when new
13026 entries are set to a TODO status. Note that this hook is only called
13027 when there is a statistics cookie in the headline!
13029 (defun org-summary-todo (n-done n-not-done)
13030 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13031 (let (org-log-done org-log-states) ; turn off logging
13032 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13035 (defvar org-todo-statistics-hook nil
13036 "Hook that is run whenever Org thinks TODO statistics should be updated.
13037 This hook runs even if there is no statistics cookie present, in which case
13038 `org-after-todo-statistics-hook' would not run.")
13040 (defun org-todo-trigger-tag-changes (state)
13041 "Apply the changes defined in `org-todo-state-tags-triggers'."
13042 (let ((l org-todo-state-tags-triggers)
13043 changes)
13044 (when (or (not state) (equal state ""))
13045 (setq changes (append changes (cdr (assoc "" l)))))
13046 (when (and (stringp state) (> (length state) 0))
13047 (setq changes (append changes (cdr (assoc state l)))))
13048 (when (member state org-not-done-keywords)
13049 (setq changes (append changes (cdr (assoc 'todo l)))))
13050 (when (member state org-done-keywords)
13051 (setq changes (append changes (cdr (assoc 'done l)))))
13052 (dolist (c changes)
13053 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13055 (defun org-local-logging (value)
13056 "Get logging settings from a property VALUE."
13057 (let* (words w a)
13058 ;; directly set the variables, they are already local.
13059 (setq org-log-done nil
13060 org-log-repeat nil
13061 org-todo-log-states nil)
13062 (setq words (org-split-string value))
13063 (while (setq w (pop words))
13064 (cond
13065 ((setq a (assoc w org-startup-options))
13066 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13067 (set (nth 1 a) (nth 2 a))))
13068 ((setq a (org-extract-log-state-settings w))
13069 (and (member (car a) org-todo-keywords-1)
13070 (push a org-todo-log-states)))))))
13072 (defun org-get-todo-sequence-head (kwd)
13073 "Return the head of the TODO sequence to which KWD belongs.
13074 If KWD is not set, check if there is a text property remembering the
13075 right sequence."
13076 (let (p)
13077 (cond
13078 ((not kwd)
13079 (or (get-text-property (point-at-bol) 'org-todo-head)
13080 (progn
13081 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13082 nil (point-at-eol)))
13083 (get-text-property p 'org-todo-head))))
13084 ((not (member kwd org-todo-keywords-1))
13085 (car org-todo-keywords-1))
13086 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13088 (defun org-fast-todo-selection ()
13089 "Fast TODO keyword selection with single keys.
13090 Returns the new TODO keyword, or nil if no state change should occur."
13091 (let* ((fulltable org-todo-key-alist)
13092 (done-keywords org-done-keywords) ;; needed for the faces.
13093 (maxlen (apply 'max (mapcar
13094 (lambda (x)
13095 (if (stringp (car x)) (string-width (car x)) 0))
13096 fulltable)))
13097 (expert nil)
13098 (fwidth (+ maxlen 3 1 3))
13099 (ncol (/ (- (window-width) 4) fwidth))
13100 tg cnt e c tbl
13101 groups ingroup)
13102 (save-excursion
13103 (save-window-excursion
13104 (if expert
13105 (set-buffer (get-buffer-create " *Org todo*"))
13106 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13107 (erase-buffer)
13108 (org-set-local 'org-done-keywords done-keywords)
13109 (setq tbl fulltable cnt 0)
13110 (while (setq e (pop tbl))
13111 (cond
13112 ((equal e '(:startgroup))
13113 (push '() groups) (setq ingroup t)
13114 (when (not (= cnt 0))
13115 (setq cnt 0)
13116 (insert "\n"))
13117 (insert "{ "))
13118 ((equal e '(:endgroup))
13119 (setq ingroup nil cnt 0)
13120 (insert "}\n"))
13121 ((equal e '(:newline))
13122 (when (not (= cnt 0))
13123 (setq cnt 0)
13124 (insert "\n")
13125 (setq e (car tbl))
13126 (while (equal (car tbl) '(:newline))
13127 (insert "\n")
13128 (setq tbl (cdr tbl)))))
13130 (setq tg (car e) c (cdr e))
13131 (if ingroup (push tg (car groups)))
13132 (setq tg (org-add-props tg nil 'face
13133 (org-get-todo-face tg)))
13134 (if (and (= cnt 0) (not ingroup)) (insert " "))
13135 (insert "[" c "] " tg (make-string
13136 (- fwidth 4 (length tg)) ?\ ))
13137 (when (= (setq cnt (1+ cnt)) ncol)
13138 (insert "\n")
13139 (if ingroup (insert " "))
13140 (setq cnt 0)))))
13141 (insert "\n")
13142 (goto-char (point-min))
13143 (if (not expert) (org-fit-window-to-buffer))
13144 (message "[a-z..]:Set [SPC]:clear")
13145 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13146 (cond
13147 ((or (= c ?\C-g)
13148 (and (= c ?q) (not (rassoc c fulltable))))
13149 (setq quit-flag t))
13150 ((= c ?\ ) nil)
13151 ((setq e (rassoc c fulltable) tg (car e))
13153 (t (setq quit-flag t)))))))
13155 (defun org-entry-is-todo-p ()
13156 (member (org-get-todo-state) org-not-done-keywords))
13158 (defun org-entry-is-done-p ()
13159 (member (org-get-todo-state) org-done-keywords))
13161 (defun org-get-todo-state ()
13162 "Return the TODO keyword of the current subtree."
13163 (save-excursion
13164 (org-back-to-heading t)
13165 (and (looking-at org-todo-line-regexp)
13166 (match-end 2)
13167 (match-string 2))))
13169 (defun org-at-date-range-p (&optional inactive-ok)
13170 "Is the cursor inside a date range?"
13171 (interactive)
13172 (save-excursion
13173 (catch 'exit
13174 (let ((pos (point)))
13175 (skip-chars-backward "^[<\r\n")
13176 (skip-chars-backward "<[")
13177 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13178 (>= (match-end 0) pos)
13179 (throw 'exit t))
13180 (skip-chars-backward "^<[\r\n")
13181 (skip-chars-backward "<[")
13182 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13183 (>= (match-end 0) pos)
13184 (throw 'exit t)))
13185 nil)))
13187 (defun org-get-repeat (&optional tagline)
13188 "Check if there is a deadline/schedule with repeater in this entry."
13189 (save-match-data
13190 (save-excursion
13191 (org-back-to-heading t)
13192 (and (re-search-forward (if tagline
13193 (concat tagline "\\s-*" org-repeat-re)
13194 org-repeat-re)
13195 (org-entry-end-position) t)
13196 (match-string-no-properties 1)))))
13198 (defvar org-last-changed-timestamp)
13199 (defvar org-last-inserted-timestamp)
13200 (defvar org-log-post-message)
13201 (defvar org-log-note-purpose)
13202 (defvar org-log-note-how nil)
13203 (defvar org-log-note-extra)
13204 (defun org-auto-repeat-maybe (done-word)
13205 "Check if the current headline contains a repeated deadline/schedule.
13206 If yes, set TODO state back to what it was and change the base date
13207 of repeating deadline/scheduled time stamps to new date.
13208 This function is run automatically after each state change to a DONE state."
13209 ;; last-state is dynamically scoped into this function
13210 (let* ((repeat (org-get-repeat))
13211 (aa (assoc org-last-state org-todo-kwd-alist))
13212 (interpret (nth 1 aa))
13213 (head (nth 2 aa))
13214 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13215 (msg "Entry repeats: ")
13216 (org-log-done nil)
13217 (org-todo-log-states nil)
13218 re type n what ts time to-state)
13219 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13220 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13221 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13222 org-todo-repeat-to-state))
13223 (unless (and to-state (member to-state org-todo-keywords-1))
13224 (setq to-state (if (eq interpret 'type) org-last-state head)))
13225 (org-todo to-state)
13226 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13227 (org-entry-put nil "LAST_REPEAT" (format-time-string
13228 (org-time-stamp-format t t))))
13229 (when org-log-repeat
13230 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13231 (memq 'org-add-log-note post-command-hook))
13232 ;; OK, we are already setup for some record
13233 (if (eq org-log-repeat 'note)
13234 ;; make sure we take a note, not only a time stamp
13235 (setq org-log-note-how 'note))
13236 ;; Set up for taking a record
13237 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13238 org-last-state
13239 'findpos org-log-repeat)))
13240 (org-back-to-heading t)
13241 (org-add-planning-info nil nil 'closed)
13242 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13243 org-deadline-time-regexp "\\)\\|\\("
13244 org-ts-regexp "\\)"))
13245 (while (re-search-forward
13246 re (save-excursion (outline-next-heading) (point)) t)
13247 (setq type (if (match-end 1) org-scheduled-string
13248 (if (match-end 3) org-deadline-string "Plain:"))
13249 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13250 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13251 (setq n (string-to-number (match-string 2 ts))
13252 what (match-string 3 ts))
13253 (if (equal what "w") (setq n (* n 7) what "d"))
13254 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13255 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13256 ;; Preparation, see if we need to modify the start date for the change
13257 (when (match-end 1)
13258 (setq time (save-match-data (org-time-string-to-time ts)))
13259 (cond
13260 ((equal (match-string 1 ts) ".")
13261 ;; Shift starting date to today
13262 (org-timestamp-change
13263 (- (org-today) (time-to-days time))
13264 'day))
13265 ((equal (match-string 1 ts) "+")
13266 (let ((nshiftmax 10) (nshift 0))
13267 (while (or (= nshift 0)
13268 (<= (time-to-days time)
13269 (time-to-days (current-time))))
13270 (when (= (incf nshift) nshiftmax)
13271 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13272 (user-error "Abort")))
13273 (org-timestamp-change n (cdr (assoc what whata)))
13274 (org-at-timestamp-p t)
13275 (setq ts (match-string 1))
13276 (setq time (save-match-data (org-time-string-to-time ts)))))
13277 (org-timestamp-change (- n) (cdr (assoc what whata)))
13278 ;; rematch, so that we have everything in place for the real shift
13279 (org-at-timestamp-p t)
13280 (setq ts (match-string 1))
13281 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13282 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13283 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13284 (setq org-log-post-message msg)
13285 (message "%s" msg))))
13287 (defun org-show-todo-tree (arg)
13288 "Make a compact tree which shows all headlines marked with TODO.
13289 The tree will show the lines where the regexp matches, and all higher
13290 headlines above the match.
13291 With a \\[universal-argument] prefix, prompt for a regexp to match.
13292 With a numeric prefix N, construct a sparse tree for the Nth element
13293 of `org-todo-keywords-1'."
13294 (interactive "P")
13295 (let ((case-fold-search nil)
13296 (kwd-re
13297 (cond ((null arg) org-not-done-regexp)
13298 ((equal arg '(4))
13299 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13300 (mapcar 'list org-todo-keywords-1))))
13301 (concat "\\("
13302 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13303 "\\)\\>")))
13304 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13305 (regexp-quote (nth (1- (prefix-numeric-value arg))
13306 org-todo-keywords-1)))
13307 (t (user-error "Invalid prefix argument: %s" arg)))))
13308 (message "%d TODO entries found"
13309 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13311 (defun org-deadline (arg &optional time)
13312 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13313 With one universal prefix argument, remove any deadline from the item.
13314 With two universal prefix arguments, prompt for a warning delay.
13315 With argument TIME, set the deadline at the corresponding date. TIME
13316 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13317 (interactive "P")
13318 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13319 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13320 'region-start-level 'region))
13321 org-loop-over-headlines-in-active-region)
13322 (org-map-entries
13323 `(org-deadline ',arg ,time)
13324 org-loop-over-headlines-in-active-region
13325 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13326 (let* ((old-date (org-entry-get nil "DEADLINE"))
13327 (old-date-time (if old-date (org-time-string-to-time old-date)))
13328 (repeater (and old-date
13329 (string-match
13330 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13331 old-date)
13332 (match-string 1 old-date))))
13333 (cond
13334 ((equal arg '(4))
13335 (when (and old-date org-log-redeadline)
13336 (org-add-log-setup 'deldeadline nil old-date 'findpos
13337 org-log-redeadline))
13338 (org-remove-timestamp-with-keyword org-deadline-string)
13339 (message "Item no longer has a deadline."))
13340 ((equal arg '(16))
13341 (save-excursion
13342 (org-back-to-heading t)
13343 (if (re-search-forward
13344 org-deadline-time-regexp
13345 (save-excursion (outline-next-heading) (point)) t)
13346 (let* ((rpl0 (match-string 1))
13347 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13348 (replace-match
13349 (concat org-deadline-string
13350 " <" rpl
13351 (format " -%dd"
13352 (abs
13353 (- (time-to-days
13354 (save-match-data
13355 (org-read-date nil t nil "Warn starting from" old-date-time)))
13356 (time-to-days old-date-time))))
13357 ">") t t))
13358 (user-error "No deadline information to update"))))
13360 (org-add-planning-info 'deadline time 'closed)
13361 (when (and old-date org-log-redeadline
13362 (not (equal old-date
13363 (substring org-last-inserted-timestamp 1 -1))))
13364 (org-add-log-setup 'redeadline nil old-date 'findpos
13365 org-log-redeadline))
13366 (when repeater
13367 (save-excursion
13368 (org-back-to-heading t)
13369 (when (re-search-forward (concat org-deadline-string " "
13370 org-last-inserted-timestamp)
13371 (save-excursion
13372 (outline-next-heading) (point)) t)
13373 (goto-char (1- (match-end 0)))
13374 (insert " " repeater)
13375 (setq org-last-inserted-timestamp
13376 (concat (substring org-last-inserted-timestamp 0 -1)
13377 " " repeater
13378 (substring org-last-inserted-timestamp -1))))))
13379 (message "Deadline on %s" org-last-inserted-timestamp))))))
13381 (defun org-schedule (arg &optional time)
13382 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13383 With one universal prefix argument, remove any scheduling date from the item.
13384 With two universal prefix arguments, prompt for a delay cookie.
13385 With argument TIME, scheduled at the corresponding date. TIME can
13386 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13387 (interactive "P")
13388 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13389 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13390 'region-start-level 'region))
13391 org-loop-over-headlines-in-active-region)
13392 (org-map-entries
13393 `(org-schedule ',arg ,time)
13394 org-loop-over-headlines-in-active-region
13395 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13396 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13397 (old-date-time (if old-date (org-time-string-to-time old-date)))
13398 (repeater (and old-date
13399 (string-match
13400 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13401 old-date)
13402 (match-string 1 old-date))))
13403 (cond
13404 ((equal arg '(4))
13405 (progn
13406 (when (and old-date org-log-reschedule)
13407 (org-add-log-setup 'delschedule nil old-date 'findpos
13408 org-log-reschedule))
13409 (org-remove-timestamp-with-keyword org-scheduled-string)
13410 (message "Item is no longer scheduled.")))
13411 ((equal arg '(16))
13412 (save-excursion
13413 (org-back-to-heading t)
13414 (if (re-search-forward
13415 org-scheduled-time-regexp
13416 (save-excursion (outline-next-heading) (point)) t)
13417 (let* ((rpl0 (match-string 1))
13418 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13419 (replace-match
13420 (concat org-scheduled-string
13421 " <" rpl
13422 (format " -%dd"
13423 (abs
13424 (- (time-to-days
13425 (save-match-data
13426 (org-read-date nil t nil "Delay until" old-date-time)))
13427 (time-to-days old-date-time))))
13428 ">") t t))
13429 (user-error "No scheduled information to update"))))
13431 (org-add-planning-info 'scheduled time 'closed)
13432 (when (and old-date org-log-reschedule
13433 (not (equal old-date
13434 (substring org-last-inserted-timestamp 1 -1))))
13435 (org-add-log-setup 'reschedule nil old-date 'findpos
13436 org-log-reschedule))
13437 (when repeater
13438 (save-excursion
13439 (org-back-to-heading t)
13440 (when (re-search-forward (concat org-scheduled-string " "
13441 org-last-inserted-timestamp)
13442 (save-excursion
13443 (outline-next-heading) (point)) t)
13444 (goto-char (1- (match-end 0)))
13445 (insert " " repeater)
13446 (setq org-last-inserted-timestamp
13447 (concat (substring org-last-inserted-timestamp 0 -1)
13448 " " repeater
13449 (substring org-last-inserted-timestamp -1))))))
13450 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13452 (defun org-get-scheduled-time (pom &optional inherit)
13453 "Get the scheduled time as a time tuple, of a format suitable
13454 for calling org-schedule with, or if there is no scheduling,
13455 returns nil."
13456 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13457 (when time
13458 (apply 'encode-time (org-parse-time-string time)))))
13460 (defun org-get-deadline-time (pom &optional inherit)
13461 "Get the deadline as a time tuple, of a format suitable for
13462 calling org-deadline with, or if there is no scheduling, returns
13463 nil."
13464 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13465 (when time
13466 (apply 'encode-time (org-parse-time-string time)))))
13468 (defun org-remove-timestamp-with-keyword (keyword)
13469 "Remove all time stamps with KEYWORD in the current entry."
13470 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13471 beg)
13472 (save-excursion
13473 (org-back-to-heading t)
13474 (setq beg (point))
13475 (outline-next-heading)
13476 (while (re-search-backward re beg t)
13477 (replace-match "")
13478 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13479 (equal (char-before) ?\ ))
13480 (backward-delete-char 1)
13481 (if (string-match "^[ \t]*$" (buffer-substring
13482 (point-at-bol) (point-at-eol)))
13483 (delete-region (point-at-bol)
13484 (min (point-max) (1+ (point-at-eol))))))))))
13486 (defvar org-time-was-given) ; dynamically scoped parameter
13487 (defvar org-end-time-was-given) ; dynamically scoped parameter
13489 (defun org-add-planning-info (what &optional time &rest remove)
13490 "Insert new timestamp with keyword in the line directly after the headline.
13491 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13492 If non is given, the user is prompted for a date.
13493 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13494 be removed."
13495 (interactive)
13496 (let (org-time-was-given org-end-time-was-given default-time default-input)
13497 (catch 'exit
13498 (when (and (memq what '(scheduled deadline))
13499 (or (not time)
13500 (and (stringp time)
13501 (string-match "^[-+]+[0-9]" time))))
13502 ;; Try to get a default date/time from existing timestamp
13503 (save-excursion
13504 (org-back-to-heading t)
13505 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13506 (when (re-search-forward (if (eq what 'scheduled)
13507 org-scheduled-time-regexp
13508 org-deadline-time-regexp)
13509 end t)
13510 (setq ts (match-string 1)
13511 default-time (apply 'encode-time (org-parse-time-string ts))
13512 default-input (and ts (org-get-compact-tod ts)))))))
13513 (when what
13514 (setq time
13515 (if (stringp time)
13516 ;; This is a string (relative or absolute), set proper date
13517 (apply 'encode-time
13518 (org-read-date-analyze
13519 time default-time (decode-time default-time)))
13520 ;; If necessary, get the time from the user
13521 (or time (org-read-date nil 'to-time nil nil
13522 default-time default-input)))))
13524 (when (and org-insert-labeled-timestamps-at-point
13525 (memq what '(scheduled deadline)))
13526 (insert
13527 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13528 (org-insert-time-stamp time org-time-was-given
13529 nil nil nil (list org-end-time-was-given))
13530 (setq what nil))
13531 (org-with-wide-buffer
13532 (let (col list elt ts buffer-invisibility-spec)
13533 (org-back-to-heading t)
13534 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
13535 (goto-char (match-end 1))
13536 (setq col (current-column))
13537 (goto-char (match-end 0))
13538 (if (eobp) (insert "\n") (forward-char 1))
13539 (unless (or what (org-looking-at-p org-planning-line-re))
13540 ;; Nothing to add, nothing to remove...... :-)
13541 (throw 'exit nil))
13542 (if (and (not (looking-at org-outline-regexp))
13543 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
13544 "[^\r\n]*"))
13545 (not (equal (match-string 1) org-clock-string)))
13546 (narrow-to-region (match-beginning 0) (match-end 0))
13547 (insert-before-markers "\n")
13548 (backward-char 1)
13549 (narrow-to-region (point) (point))
13550 (and org-adapt-indentation (org-indent-to-column col)))
13551 ;; Check if we have to remove something.
13552 (setq list (cons what remove))
13553 (while list
13554 (setq elt (pop list))
13555 (when (or (and (eq elt 'scheduled)
13556 (re-search-forward org-scheduled-time-regexp nil t))
13557 (and (eq elt 'deadline)
13558 (re-search-forward org-deadline-time-regexp nil t))
13559 (and (eq elt 'closed)
13560 (re-search-forward org-closed-time-regexp nil t)))
13561 (replace-match "")
13562 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13563 (and (looking-at "[ \t]+") (replace-match ""))
13564 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13565 (when what
13566 (insert
13567 (if (or (bolp) (eq (char-before) ?\s)) "" " ")
13568 (cond ((eq what 'scheduled) org-scheduled-string)
13569 ((eq what 'deadline) org-deadline-string)
13570 ((eq what 'closed) org-closed-string))
13571 " ")
13572 (setq ts (org-insert-time-stamp
13573 time
13574 (or org-time-was-given
13575 (and (eq what 'closed) org-log-done-with-time))
13576 (eq what 'closed)
13577 nil nil (list org-end-time-was-given)))
13578 (unless (or (bolp)
13579 (eq (char-before) ?\s)
13580 (memq (char-after) '(?\n ?\s))
13581 (eobp))
13582 (insert " "))
13583 (end-of-line 1))
13584 (goto-char (point-min))
13585 (widen)
13586 (when (and (looking-at "[ \t]*\n") (eq (char-before) ?\n))
13587 (delete-region (1- (point)) (line-end-position)))
13588 ts)))))
13590 (defvar org-log-note-marker (make-marker))
13591 (defvar org-log-note-purpose nil)
13592 (defvar org-log-note-state nil)
13593 (defvar org-log-note-previous-state nil)
13594 (defvar org-log-note-extra nil)
13595 (defvar org-log-note-window-configuration nil)
13596 (defvar org-log-note-return-to (make-marker))
13597 (defvar org-log-note-effective-time nil
13598 "Remembered current time so that dynamically scoped
13599 `org-extend-today-until' affects tha timestamps in state change
13600 log")
13602 (defvar org-log-post-message nil
13603 "Message to be displayed after a log note has been stored.
13604 The auto-repeater uses this.")
13606 (defun org-add-note ()
13607 "Add a note to the current entry.
13608 This is done in the same way as adding a state change note."
13609 (interactive)
13610 (org-add-log-setup 'note nil nil 'findpos nil))
13612 (defun org-log-beginning (&optional create)
13613 "Return expected start of log notes in current entry.
13614 When optional argument CREATE is non-nil, the function creates
13615 a drawer to store notes, if necessary. Returned position ignores
13616 narrowing."
13617 (org-with-wide-buffer
13618 (org-back-to-heading t)
13619 ;; Skip planning info and property drawer.
13620 (forward-line)
13621 (when (org-looking-at-p org-planning-line-re) (forward-line))
13622 (when (looking-at org-property-drawer-re)
13623 (goto-char (match-end 0))
13624 (forward-line))
13625 (if (org-at-heading-p) (point)
13626 (let ((end (save-excursion (outline-next-heading) (point)))
13627 (drawer (cond ((stringp org-log-into-drawer) org-log-into-drawer)
13628 (org-log-into-drawer "LOGBOOK"))))
13629 (cond
13630 (drawer
13631 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13632 (case-fold-search t))
13633 (catch 'exit
13634 ;; Try to find existing drawer.
13635 (while (re-search-forward regexp end t)
13636 (let ((element (org-element-at-point)))
13637 (when (eq (org-element-type element) 'drawer)
13638 (let ((cend (org-element-property :contents-end element)))
13639 (when (and (not org-log-states-order-reversed) cend)
13640 (goto-char cend)))
13641 (throw 'exit nil))))
13642 ;; No drawer found. Create one, if permitted.
13643 (when create
13644 (unless (bolp) (insert "\n"))
13645 (let ((beg (point)))
13646 (insert ":" drawer ":\n:END:\n")
13647 (org-indent-region beg (point)))
13648 (end-of-line -1)))))
13649 (org-log-state-notes-insert-after-drawers
13650 (while (and (looking-at org-drawer-regexp)
13651 (progn (goto-char (match-end 0))
13652 (re-search-forward org-property-end-re end t)))
13653 (forward-line)))))
13654 (if (bolp) (point) (line-beginning-position 2)))))
13656 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13657 "Set up the post command hook to take a note.
13658 If this is about to TODO state change, the new state is expected in STATE.
13659 When FINDPOS is non-nil, find the correct position for the note in
13660 the current entry. If not, assume that it can be inserted at point.
13661 HOW is an indicator what kind of note should be created.
13662 EXTRA is additional text that will be inserted into the notes buffer."
13663 (org-with-wide-buffer
13664 (when findpos
13665 (goto-char (org-log-beginning t))
13666 (unless org-log-states-order-reversed
13667 (org-skip-over-state-notes)
13668 (skip-chars-backward " \t\n\r")
13669 (forward-line)))
13670 (move-marker org-log-note-marker (point))
13671 (setq org-log-note-purpose purpose
13672 org-log-note-state state
13673 org-log-note-previous-state prev-state
13674 org-log-note-how how
13675 org-log-note-extra extra
13676 org-log-note-effective-time (org-current-effective-time))
13677 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13679 (defun org-skip-over-state-notes ()
13680 "Skip past the list of State notes in an entry."
13681 (when (ignore-errors (goto-char (org-in-item-p)))
13682 (let* ((struct (org-list-struct))
13683 (prevs (org-list-prevs-alist struct))
13684 (regexp
13685 (concat "[ \t]*- +"
13686 (replace-regexp-in-string
13687 " +" " +"
13688 (org-replace-escapes
13689 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13690 `(("%d" . ,org-ts-regexp-inactive)
13691 ("%D" . ,org-ts-regexp)
13692 ("%s" . "\"\\S-+\"")
13693 ("%S" . "\"\\S-+\"")
13694 ("%t" . ,org-ts-regexp-inactive)
13695 ("%T" . ,org-ts-regexp)
13696 ("%u" . ".*?")
13697 ("%U" . ".*?")))))))
13698 (while (org-looking-at-p regexp)
13699 (goto-char (or (org-list-get-next-item (point) struct prevs)
13700 (org-list-get-item-end (point) struct)))))))
13702 (defun org-add-log-note (&optional purpose)
13703 "Pop up a window for taking a note, and add this note later at point."
13704 (remove-hook 'post-command-hook 'org-add-log-note)
13705 (setq org-log-note-window-configuration (current-window-configuration))
13706 (delete-other-windows)
13707 (move-marker org-log-note-return-to (point))
13708 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13709 (goto-char org-log-note-marker)
13710 (org-switch-to-buffer-other-window "*Org Note*")
13711 (erase-buffer)
13712 (if (memq org-log-note-how '(time state))
13713 (let (current-prefix-arg) (org-store-log-note))
13714 (let ((org-inhibit-startup t)) (org-mode))
13715 (insert (format "# Insert note for %s.
13716 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13717 (cond
13718 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13719 ((eq org-log-note-purpose 'done) "closed todo item")
13720 ((eq org-log-note-purpose 'state)
13721 (format "state change from \"%s\" to \"%s\""
13722 (or org-log-note-previous-state "")
13723 (or org-log-note-state "")))
13724 ((eq org-log-note-purpose 'reschedule)
13725 "rescheduling")
13726 ((eq org-log-note-purpose 'delschedule)
13727 "no longer scheduled")
13728 ((eq org-log-note-purpose 'redeadline)
13729 "changing deadline")
13730 ((eq org-log-note-purpose 'deldeadline)
13731 "removing deadline")
13732 ((eq org-log-note-purpose 'refile)
13733 "refiling")
13734 ((eq org-log-note-purpose 'note)
13735 "this entry")
13736 (t (error "This should not happen")))))
13737 (if org-log-note-extra (insert org-log-note-extra))
13738 (org-set-local 'org-finish-function 'org-store-log-note)
13739 (run-hooks 'org-log-buffer-setup-hook)))
13741 (defvar org-note-abort nil) ; dynamically scoped
13742 (defun org-store-log-note ()
13743 "Finish taking a log note, and insert it to where it belongs."
13744 (let ((txt (buffer-string)))
13745 (kill-buffer (current-buffer))
13746 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13747 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13748 (setq txt (replace-match "" t t txt)))
13749 (if (string-match "\\s-+\\'" txt)
13750 (setq txt (replace-match "" t t txt)))
13751 (setq lines (org-split-string txt "\n"))
13752 (when (and note (string-match "\\S-" note))
13753 (setq note
13754 (org-replace-escapes
13755 note
13756 (list (cons "%u" (user-login-name))
13757 (cons "%U" user-full-name)
13758 (cons "%t" (format-time-string
13759 (org-time-stamp-format 'long 'inactive)
13760 org-log-note-effective-time))
13761 (cons "%T" (format-time-string
13762 (org-time-stamp-format 'long nil)
13763 org-log-note-effective-time))
13764 (cons "%d" (format-time-string
13765 (org-time-stamp-format nil 'inactive)
13766 org-log-note-effective-time))
13767 (cons "%D" (format-time-string
13768 (org-time-stamp-format nil nil)
13769 org-log-note-effective-time))
13770 (cons "%s" (if org-log-note-state
13771 (concat "\"" org-log-note-state "\"")
13772 ""))
13773 (cons "%S" (if org-log-note-previous-state
13774 (concat "\"" org-log-note-previous-state "\"")
13775 "\"\"")))))
13776 (when lines (setq note (concat note " \\\\")))
13777 (push note lines))
13778 (when (or current-prefix-arg org-note-abort)
13779 (when (org-log-into-drawer)
13780 (org-remove-empty-drawer-at org-log-note-marker))
13781 (setq lines nil))
13782 (when lines
13783 (with-current-buffer (marker-buffer org-log-note-marker)
13784 (save-excursion
13785 (goto-char org-log-note-marker)
13786 (move-marker org-log-note-marker nil)
13787 ;; Make sure point is at the beginning of an empty line.
13788 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13789 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13790 ;; In an existing list, add a new item at the top level.
13791 ;; Otherwise, indent line like a regular one.
13792 (let ((itemp (org-in-item-p)))
13793 (if itemp
13794 (org-indent-line-to
13795 (let ((struct (save-excursion
13796 (goto-char itemp) (org-list-struct))))
13797 (org-list-get-ind (org-list-get-top-point struct) struct)))
13798 (org-indent-line)))
13799 (insert (org-list-bullet-string "-") (pop lines))
13800 (let ((ind (org-list-item-body-column (line-beginning-position))))
13801 (dolist (line lines)
13802 (insert "\n")
13803 (org-indent-line-to ind)
13804 (insert line)))
13805 (message "Note stored")
13806 (org-back-to-heading t)
13807 (org-cycle-hide-drawers 'children))
13808 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13809 ;; from within `org-add-log-note' because `buffer-undo-list'
13810 ;; is then modified outside of `org-with-remote-undo'.
13811 (when (eq this-command 'org-agenda-todo)
13812 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13813 ;; Don't add undo information when called from `org-agenda-todo'
13814 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13815 (set-window-configuration org-log-note-window-configuration)
13816 (with-current-buffer (marker-buffer org-log-note-return-to)
13817 (goto-char org-log-note-return-to))
13818 (move-marker org-log-note-return-to nil)
13819 (and org-log-post-message (message "%s" org-log-post-message))))
13821 (defun org-remove-empty-drawer-at (pos)
13822 "Remove an empty drawer at position POS.
13823 POS may also be a marker."
13824 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13825 (org-with-wide-buffer
13826 (goto-char pos)
13827 (let ((drawer (org-element-at-point)))
13828 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13829 (not (org-element-property :contents-begin drawer)))
13830 (delete-region (org-element-property :begin drawer)
13831 (progn (goto-char (org-element-property :end drawer))
13832 (skip-chars-backward " \r\t\n")
13833 (forward-line)
13834 (point))))))))
13836 (defvar org-ts-type nil)
13837 (defun org-sparse-tree (&optional arg type)
13838 "Create a sparse tree, prompt for the details.
13839 This command can create sparse trees. You first need to select the type
13840 of match used to create the tree:
13842 t Show all TODO entries.
13843 T Show entries with a specific TODO keyword.
13844 m Show entries selected by a tags/property match.
13845 p Enter a property name and its value (both with completion on existing
13846 names/values) and show entries with that property.
13847 r Show entries matching a regular expression (`/' can be used as well).
13848 b Show deadlines and scheduled items before a date.
13849 a Show deadlines and scheduled items after a date.
13850 d Show deadlines due within `org-deadline-warning-days'.
13851 D Show deadlines and scheduled items between a date range."
13852 (interactive "P")
13853 (setq type (or type org-sparse-tree-default-date-type))
13854 (setq org-ts-type type)
13855 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13856 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13857 [c]ycle through date types: %s"
13858 (case type
13859 (all "all timestamps")
13860 (scheduled "only scheduled")
13861 (deadline "only deadline")
13862 (active "only active timestamps")
13863 (inactive "only inactive timestamps")
13864 (scheduled-or-deadline "scheduled/deadline")
13865 (closed "with a closed time-stamp")
13866 (otherwise "scheduled/deadline")))
13867 (let ((answer (read-char-exclusive)))
13868 (case answer
13870 (org-sparse-tree
13872 (cadr (memq type '(scheduled-or-deadline all scheduled deadline active
13873 inactive closed)))))
13874 (?d (call-interactively 'org-check-deadlines))
13875 (?b (call-interactively 'org-check-before-date))
13876 (?a (call-interactively 'org-check-after-date))
13877 (?D (call-interactively 'org-check-dates-range))
13878 (?t (call-interactively 'org-show-todo-tree))
13879 (?T (org-show-todo-tree '(4)))
13880 (?m (call-interactively 'org-match-sparse-tree))
13881 ((?p ?P)
13882 (let* ((kwd (org-icompleting-read
13883 "Property: " (mapcar 'list (org-buffer-property-keys))))
13884 (value (org-icompleting-read
13885 "Value: " (mapcar 'list (org-property-values kwd)))))
13886 (unless (string-match "\\`{.*}\\'" value)
13887 (setq value (concat "\"" value "\"")))
13888 (org-match-sparse-tree arg (concat kwd "=" value))))
13889 ((?r ?R ?/) (call-interactively 'org-occur))
13890 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13892 (defvar org-occur-highlights nil
13893 "List of overlays used for occur matches.")
13894 (make-variable-buffer-local 'org-occur-highlights)
13895 (defvar org-occur-parameters nil
13896 "Parameters of the active org-occur calls.
13897 This is a list, each call to org-occur pushes as cons cell,
13898 containing the regular expression and the callback, onto the list.
13899 The list can contain several entries if `org-occur' has been called
13900 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13901 will only contain one set of parameters. When the highlights are
13902 removed (for example with `C-c C-c', or with the next edit (depending
13903 on `org-remove-highlights-with-change'), this variable is emptied
13904 as well.")
13905 (make-variable-buffer-local 'org-occur-parameters)
13907 (defun org-occur (regexp &optional keep-previous callback)
13908 "Make a compact tree which shows all matches of REGEXP.
13909 The tree will show the lines where the regexp matches, and all higher
13910 headlines above the match. It will also show the heading after the match,
13911 to make sure editing the matching entry is easy.
13912 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13913 call to `org-occur' will be kept, to allow stacking of calls to this
13914 command.
13915 If CALLBACK is non-nil, it is a function which is called to confirm
13916 that the match should indeed be shown."
13917 (interactive "sRegexp: \nP")
13918 (when (equal regexp "")
13919 (user-error "Regexp cannot be empty"))
13920 (unless keep-previous
13921 (org-remove-occur-highlights nil nil t))
13922 (push (cons regexp callback) org-occur-parameters)
13923 (let ((cnt 0))
13924 (save-excursion
13925 (goto-char (point-min))
13926 (if (or (not keep-previous) ; do not want to keep
13927 (not org-occur-highlights)) ; no previous matches
13928 ;; hide everything
13929 (org-overview))
13930 (while (re-search-forward regexp nil t)
13931 (when (or (not callback)
13932 (save-match-data (funcall callback)))
13933 (setq cnt (1+ cnt))
13934 (when org-highlight-sparse-tree-matches
13935 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13936 (org-show-context 'occur-tree))))
13937 (when org-remove-highlights-with-change
13938 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13939 nil 'local))
13940 (unless org-sparse-tree-open-archived-trees
13941 (org-hide-archived-subtrees (point-min) (point-max)))
13942 (run-hooks 'org-occur-hook)
13943 (if (org-called-interactively-p 'interactive)
13944 (message "%d match(es) for regexp %s" cnt regexp))
13945 cnt))
13947 (defun org-occur-next-match (&optional n reset)
13948 "Function for `next-error-function' to find sparse tree matches.
13949 N is the number of matches to move, when negative move backwards.
13950 RESET is entirely ignored - this function always goes back to the
13951 starting point when no match is found."
13952 (let* ((limit (if (< n 0) (point-min) (point-max)))
13953 (search-func (if (< n 0)
13954 'previous-single-char-property-change
13955 'next-single-char-property-change))
13956 (n (abs n))
13957 (pos (point))
13959 (catch 'exit
13960 (while (setq p1 (funcall search-func (point) 'org-type))
13961 (when (equal p1 limit)
13962 (goto-char pos)
13963 (user-error "No more matches"))
13964 (when (equal (get-char-property p1 'org-type) 'org-occur)
13965 (setq n (1- n))
13966 (when (= n 0)
13967 (goto-char p1)
13968 (throw 'exit (point))))
13969 (goto-char p1))
13970 (goto-char p1)
13971 (user-error "No more matches"))))
13973 (defun org-show-context (&optional key)
13974 "Make sure point and context are visible.
13975 How much context is shown depends upon the variables
13976 `org-show-hierarchy-above', `org-show-following-heading',
13977 `org-show-entry-below' and `org-show-siblings'."
13978 (let ((heading-p (org-at-heading-p t))
13979 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13980 (following-p (org-get-alist-option org-show-following-heading key))
13981 (entry-p (org-get-alist-option org-show-entry-below key))
13982 (siblings-p (org-get-alist-option org-show-siblings key)))
13983 ;; Show heading or entry text
13984 (if (and heading-p (not entry-p))
13985 (org-flag-heading nil) ; only show the heading
13986 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13987 (org-show-hidden-entry))) ; show entire entry
13988 (when following-p
13989 ;; Show next sibling, or heading below text
13990 (save-excursion
13991 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13992 (org-flag-heading nil))))
13993 (when siblings-p (org-show-siblings))
13994 (when hierarchy-p
13995 ;; show all higher headings, possibly with siblings
13996 (save-excursion
13997 (while (and (ignore-errors (progn (org-up-heading-all 1) t))
13998 (not (bobp)))
13999 (org-flag-heading nil)
14000 (when siblings-p (org-show-siblings)))))))
14002 (defvar org-reveal-start-hook nil
14003 "Hook run before revealing a location.")
14005 (defun org-reveal (&optional siblings)
14006 "Show current entry, hierarchy above it, and the following headline.
14007 This can be used to show a consistent set of context around locations
14008 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
14009 not t for the search context.
14011 With optional argument SIBLINGS, on each level of the hierarchy all
14012 siblings are shown. This repairs the tree structure to what it would
14013 look like when opened with hierarchical calls to `org-cycle'.
14014 With double optional argument \\[universal-argument] \\[universal-argument], \
14015 go to the parent and show the
14016 entire tree."
14017 (interactive "P")
14018 (run-hooks 'org-reveal-start-hook)
14019 (let ((org-show-hierarchy-above t)
14020 (org-show-following-heading t)
14021 (org-show-siblings (if siblings t org-show-siblings)))
14022 (org-show-context nil))
14023 (when (equal siblings '(16))
14024 (save-excursion
14025 (when (org-up-heading-safe)
14026 (org-show-subtree)
14027 (run-hook-with-args 'org-cycle-hook 'subtree)))))
14029 (defun org-highlight-new-match (beg end)
14030 "Highlight from BEG to END and mark the highlight is an occur headline."
14031 (let ((ov (make-overlay beg end)))
14032 (overlay-put ov 'face 'secondary-selection)
14033 (overlay-put ov 'org-type 'org-occur)
14034 (push ov org-occur-highlights)))
14036 (defun org-remove-occur-highlights (&optional beg end noremove)
14037 "Remove the occur highlights from the buffer.
14038 BEG and END are ignored. If NOREMOVE is nil, remove this function
14039 from the `before-change-functions' in the current buffer."
14040 (interactive)
14041 (unless org-inhibit-highlight-removal
14042 (mapc 'delete-overlay org-occur-highlights)
14043 (setq org-occur-highlights nil)
14044 (setq org-occur-parameters nil)
14045 (unless noremove
14046 (remove-hook 'before-change-functions
14047 'org-remove-occur-highlights 'local))))
14049 ;;;; Priorities
14051 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14052 "Regular expression matching the priority indicator.")
14054 (defvar org-remove-priority-next-time nil)
14056 (defun org-priority-up ()
14057 "Increase the priority of the current item."
14058 (interactive)
14059 (org-priority 'up))
14061 (defun org-priority-down ()
14062 "Decrease the priority of the current item."
14063 (interactive)
14064 (org-priority 'down))
14066 (defun org-priority (&optional action show)
14067 "Change the priority of an item.
14068 ACTION can be `set', `up', `down', or a character."
14069 (interactive "P")
14070 (if (equal action '(4))
14071 (org-show-priority)
14072 (unless org-enable-priority-commands
14073 (user-error "Priority commands are disabled"))
14074 (setq action (or action 'set))
14075 (let (current new news have remove)
14076 (save-excursion
14077 (org-back-to-heading t)
14078 (if (looking-at org-priority-regexp)
14079 (setq current (string-to-char (match-string 2))
14080 have t))
14081 (cond
14082 ((eq action 'remove)
14083 (setq remove t new ?\ ))
14084 ((or (eq action 'set)
14085 (if (featurep 'xemacs) (characterp action) (integerp action)))
14086 (if (not (eq action 'set))
14087 (setq new action)
14088 (message "Priority %c-%c, SPC to remove: "
14089 org-highest-priority org-lowest-priority)
14090 (save-match-data
14091 (setq new (read-char-exclusive))))
14092 (if (and (= (upcase org-highest-priority) org-highest-priority)
14093 (= (upcase org-lowest-priority) org-lowest-priority))
14094 (setq new (upcase new)))
14095 (cond ((equal new ?\ ) (setq remove t))
14096 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14097 (user-error "Priority must be between `%c' and `%c'"
14098 org-highest-priority org-lowest-priority))))
14099 ((eq action 'up)
14100 (setq new (if have
14101 (1- current) ; normal cycling
14102 ;; last priority was empty
14103 (if (eq last-command this-command)
14104 org-lowest-priority ; wrap around empty to lowest
14105 ;; default
14106 (if org-priority-start-cycle-with-default
14107 org-default-priority
14108 (1- org-default-priority))))))
14109 ((eq action 'down)
14110 (setq new (if have
14111 (1+ current) ; normal cycling
14112 ;; last priority was empty
14113 (if (eq last-command this-command)
14114 org-highest-priority ; wrap around empty to highest
14115 ;; default
14116 (if org-priority-start-cycle-with-default
14117 org-default-priority
14118 (1+ org-default-priority))))))
14119 (t (user-error "Invalid action")))
14120 (if (or (< (upcase new) org-highest-priority)
14121 (> (upcase new) org-lowest-priority))
14122 (if (and (memq action '(up down))
14123 (not have) (not (eq last-command this-command)))
14124 ;; `new' is from default priority
14125 (error
14126 "The default can not be set, see `org-default-priority' why")
14127 ;; normal cycling: `new' is beyond highest/lowest priority
14128 ;; and is wrapped around to the empty priority
14129 (setq remove t)))
14130 (setq news (format "%c" new))
14131 (if have
14132 (if remove
14133 (replace-match "" t t nil 1)
14134 (replace-match news t t nil 2))
14135 (if remove
14136 (user-error "No priority cookie found in line")
14137 (let ((case-fold-search nil))
14138 (looking-at org-todo-line-regexp))
14139 (if (match-end 2)
14140 (progn
14141 (goto-char (match-end 2))
14142 (insert " [#" news "]"))
14143 (goto-char (match-beginning 3))
14144 (insert "[#" news "] "))))
14145 (org-set-tags nil 'align))
14146 (if remove
14147 (message "Priority removed")
14148 (message "Priority of current item set to %s" news)))))
14150 (defun org-show-priority ()
14151 "Show the priority of the current item.
14152 This priority is composed of the main priority given with the [#A] cookies,
14153 and by additional input from the age of a schedules or deadline entry."
14154 (interactive)
14155 (let ((pri (if (eq major-mode 'org-agenda-mode)
14156 (org-get-at-bol 'priority)
14157 (save-excursion
14158 (save-match-data
14159 (beginning-of-line)
14160 (and (looking-at org-heading-regexp)
14161 (org-get-priority (match-string 0))))))))
14162 (message "Priority is %d" (if pri pri -1000))))
14164 (defun org-get-priority (s)
14165 "Find priority cookie and return priority."
14166 (save-match-data
14167 (if (functionp org-get-priority-function)
14168 (funcall org-get-priority-function)
14169 (if (not (string-match org-priority-regexp s))
14170 (* 1000 (- org-lowest-priority org-default-priority))
14171 (* 1000 (- org-lowest-priority
14172 (string-to-char (match-string 2 s))))))))
14174 ;;;; Tags
14176 (defvar org-agenda-archives-mode)
14177 (defvar org-map-continue-from nil
14178 "Position from where mapping should continue.
14179 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14181 (defvar org-scanner-tags nil
14182 "The current tag list while the tags scanner is running.")
14183 (defvar org-trust-scanner-tags nil
14184 "Should `org-get-tags-at' use the tags for the scanner.
14185 This is for internal dynamical scoping only.
14186 When this is non-nil, the function `org-get-tags-at' will return the value
14187 of `org-scanner-tags' instead of building the list by itself. This
14188 can lead to large speed-ups when the tags scanner is used in a file with
14189 many entries, and when the list of tags is retrieved, for example to
14190 obtain a list of properties. Building the tags list for each entry in such
14191 a file becomes an N^2 operation - but with this variable set, it scales
14192 as N.")
14194 (defun org-scan-tags (action matcher todo-only &optional start-level)
14195 "Scan headline tags with inheritance and produce output ACTION.
14197 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14198 or `agenda' to produce an entry list for an agenda view. It can also be
14199 a Lisp form or a function that should be called at each matched headline, in
14200 this case the return value is a list of all return values from these calls.
14202 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14203 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14204 only lines with a not-done TODO keyword are included in the output.
14205 This should be the same variable that was scoped into
14206 and set by `org-make-tags-matcher' when it constructed MATCHER.
14208 START-LEVEL can be a string with asterisks, reducing the scope to
14209 headlines matching this string."
14210 (require 'org-agenda)
14211 (let* ((re (concat "^"
14212 (if start-level
14213 ;; Get the correct level to match
14214 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14215 org-outline-regexp)
14216 " *\\(\\<\\("
14217 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14218 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14219 (props (list 'face 'default
14220 'done-face 'org-agenda-done
14221 'undone-face 'default
14222 'mouse-face 'highlight
14223 'org-not-done-regexp org-not-done-regexp
14224 'org-todo-regexp org-todo-regexp
14225 'org-complex-heading-regexp org-complex-heading-regexp
14226 'help-echo
14227 (format "mouse-2 or RET jump to org file %s"
14228 (abbreviate-file-name
14229 (or (buffer-file-name (buffer-base-buffer))
14230 (buffer-name (buffer-base-buffer)))))))
14231 (org-map-continue-from nil)
14232 lspos tags tags-list
14233 (tags-alist (list (cons 0 org-file-tags)))
14234 (llast 0) rtn rtn1 level category i txt
14235 todo marker entry priority)
14236 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14237 (setq action (list 'lambda nil action)))
14238 (save-excursion
14239 (goto-char (point-min))
14240 (when (eq action 'sparse-tree)
14241 (org-overview)
14242 (org-remove-occur-highlights))
14243 (while (let (case-fold-search)
14244 (re-search-forward re nil t))
14245 (setq org-map-continue-from nil)
14246 (catch :skip
14247 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14248 tags (if (match-end 4) (org-match-string-no-properties 4)))
14249 (goto-char (setq lspos (match-beginning 0)))
14250 (setq level (org-reduced-level (org-outline-level))
14251 category (org-get-category))
14252 (setq i llast llast level)
14253 ;; remove tag lists from same and sublevels
14254 (while (>= i level)
14255 (when (setq entry (assoc i tags-alist))
14256 (setq tags-alist (delete entry tags-alist)))
14257 (setq i (1- i)))
14258 ;; add the next tags
14259 (when tags
14260 (setq tags (org-split-string tags ":")
14261 tags-alist
14262 (cons (cons level tags) tags-alist)))
14263 ;; compile tags for current headline
14264 (setq tags-list
14265 (if org-use-tag-inheritance
14266 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14267 tags)
14268 org-scanner-tags tags-list)
14269 (when org-use-tag-inheritance
14270 (setcdr (car tags-alist)
14271 (mapcar (lambda (x)
14272 (setq x (copy-sequence x))
14273 (org-add-prop-inherited x))
14274 (cdar tags-alist))))
14275 (when (and tags org-use-tag-inheritance
14276 (or (not (eq t org-use-tag-inheritance))
14277 org-tags-exclude-from-inheritance))
14278 ;; selective inheritance, remove uninherited ones
14279 (setcdr (car tags-alist)
14280 (org-remove-uninherited-tags (cdar tags-alist))))
14281 (when (and
14283 ;; eval matcher only when the todo condition is OK
14284 (and (or (not todo-only) (member todo org-not-done-keywords))
14285 (let ((case-fold-search t) (org-trust-scanner-tags t))
14286 (eval matcher)))
14288 ;; Call the skipper, but return t if it does not skip,
14289 ;; so that the `and' form continues evaluating
14290 (progn
14291 (unless (eq action 'sparse-tree) (org-agenda-skip))
14294 ;; Check if timestamps are deselecting this entry
14295 (or (not todo-only)
14296 (and (member todo org-not-done-keywords)
14297 (or (not org-agenda-tags-todo-honor-ignore-options)
14298 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14300 ;; select this headline
14301 (cond
14302 ((eq action 'sparse-tree)
14303 (and org-highlight-sparse-tree-matches
14304 (org-get-heading) (match-end 0)
14305 (org-highlight-new-match
14306 (match-beginning 1) (match-end 1)))
14307 (org-show-context 'tags-tree))
14308 ((eq action 'agenda)
14309 (setq txt (org-agenda-format-item
14311 (concat
14312 (if (eq org-tags-match-list-sublevels 'indented)
14313 (make-string (1- level) ?.) "")
14314 (org-get-heading))
14315 level category
14316 tags-list)
14317 priority (org-get-priority txt))
14318 (goto-char lspos)
14319 (setq marker (org-agenda-new-marker))
14320 (org-add-props txt props
14321 'org-marker marker 'org-hd-marker marker 'org-category category
14322 'todo-state todo
14323 'priority priority 'type "tagsmatch")
14324 (push txt rtn))
14325 ((functionp action)
14326 (setq org-map-continue-from nil)
14327 (save-excursion
14328 (setq rtn1 (funcall action))
14329 (push rtn1 rtn)))
14330 (t (user-error "Invalid action")))
14332 ;; if we are to skip sublevels, jump to end of subtree
14333 (unless org-tags-match-list-sublevels
14334 (org-end-of-subtree t)
14335 (backward-char 1))))
14336 ;; Get the correct position from where to continue
14337 (if org-map-continue-from
14338 (goto-char org-map-continue-from)
14339 (and (= (point) lspos) (end-of-line 1)))))
14340 (when (and (eq action 'sparse-tree)
14341 (not org-sparse-tree-open-archived-trees))
14342 (org-hide-archived-subtrees (point-min) (point-max)))
14343 (nreverse rtn)))
14345 (defun org-remove-uninherited-tags (tags)
14346 "Remove all tags that are not inherited from the list TAGS."
14347 (cond
14348 ((eq org-use-tag-inheritance t)
14349 (if org-tags-exclude-from-inheritance
14350 (org-delete-all org-tags-exclude-from-inheritance tags)
14351 tags))
14352 ((not org-use-tag-inheritance) nil)
14353 ((stringp org-use-tag-inheritance)
14354 (delq nil (mapcar
14355 (lambda (x)
14356 (if (and (string-match org-use-tag-inheritance x)
14357 (not (member x org-tags-exclude-from-inheritance)))
14358 x nil))
14359 tags)))
14360 ((listp org-use-tag-inheritance)
14361 (delq nil (mapcar
14362 (lambda (x)
14363 (if (member x org-use-tag-inheritance) x nil))
14364 tags)))))
14366 (defun org-match-sparse-tree (&optional todo-only match)
14367 "Create a sparse tree according to tags string MATCH.
14368 MATCH can contain positive and negative selection of tags, like
14369 \"+WORK+URGENT-WITHBOSS\".
14370 If optional argument TODO-ONLY is non-nil, only select lines that are
14371 also TODO lines."
14372 (interactive "P")
14373 (org-agenda-prepare-buffers (list (current-buffer)))
14374 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14376 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14378 (defvar org-cached-props nil)
14379 (defun org-cached-entry-get (pom property)
14380 (if (or (eq t org-use-property-inheritance)
14381 (and (stringp org-use-property-inheritance)
14382 (string-match org-use-property-inheritance property))
14383 (and (listp org-use-property-inheritance)
14384 (member property org-use-property-inheritance)))
14385 ;; Caching is not possible, check it directly
14386 (org-entry-get pom property 'inherit)
14387 ;; Get all properties, so that we can do complicated checks easily
14388 (cdr (assoc property (or org-cached-props
14389 (setq org-cached-props
14390 (org-entry-properties pom)))))))
14392 (defun org-global-tags-completion-table (&optional files)
14393 "Return the list of all tags in all agenda buffer/files.
14394 Optional FILES argument is a list of files which can be used
14395 instead of the agenda files."
14396 (save-excursion
14397 (org-uniquify
14398 (delq nil
14399 (apply 'append
14400 (mapcar
14401 (lambda (file)
14402 (set-buffer (find-file-noselect file))
14403 (append (org-get-buffer-tags)
14404 (mapcar (lambda (x) (if (stringp (car-safe x))
14405 (list (car-safe x)) nil))
14406 org-tag-alist)))
14407 (if (and files (car files))
14408 files
14409 (org-agenda-files))))))))
14411 (defun org-make-tags-matcher (match)
14412 "Create the TAGS/TODO matcher form for the selection string MATCH.
14414 The variable `todo-only' is scoped dynamically into this function.
14415 It will be set to t if the matcher restricts matching to TODO entries,
14416 otherwise will not be touched.
14418 Returns a cons of the selection string MATCH and the constructed
14419 lisp form implementing the matcher. The matcher is to be evaluated
14420 at an Org entry, with point on the headline, and returns t if the
14421 entry matches the selection string MATCH. The returned lisp form
14422 references two variables with information about the entry, which
14423 must be bound around the form's evaluation: todo, the TODO keyword
14424 at the entry (or nil of none); and tags-list, the list of all tags
14425 at the entry including inherited ones. Additionally, the category
14426 of the entry (if any) must be specified as the text property
14427 'org-category on the headline.
14429 See also `org-scan-tags'.
14431 (declare (special todo-only))
14432 (unless (boundp 'todo-only)
14433 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14434 (unless match
14435 ;; Get a new match request, with completion against the global
14436 ;; tags table and the local tags in current buffer
14437 (let ((org-last-tags-completion-table
14438 (org-uniquify
14439 (delq nil (append (org-get-buffer-tags)
14440 (org-global-tags-completion-table))))))
14441 (setq match (org-completing-read-no-i
14442 "Match: " 'org-tags-completion-function nil nil nil
14443 'org-tags-history))))
14445 ;; Parse the string and create a lisp form
14446 (let ((match0 match)
14447 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14448 minus tag mm
14449 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14450 orterms term orlist re-p str-p level-p level-op time-p
14451 prop-p pn pv po gv rest (start 0) (ss 0))
14452 ;; Expand group tags
14453 (setq match (org-tags-expand match))
14455 ;; Check if there is a TODO part of this match, which would be the
14456 ;; part after a "/". TO make sure that this slash is not part of
14457 ;; a property value to be matched against, we also check that there
14458 ;; is no " after that slash.
14459 ;; First, find the last slash
14460 (while (string-match "/+" match ss)
14461 (setq start (match-beginning 0) ss (match-end 0)))
14462 (if (and (string-match "/+" match start)
14463 (not (save-match-data (string-match "\"" match start))))
14464 ;; match contains also a todo-matching request
14465 (progn
14466 (setq tagsmatch (substring match 0 (match-beginning 0))
14467 todomatch (substring match (match-end 0)))
14468 (if (string-match "^!" todomatch)
14469 (setq todo-only t todomatch (substring todomatch 1)))
14470 (if (string-match "^\\s-*$" todomatch)
14471 (setq todomatch nil)))
14472 ;; only matching tags
14473 (setq tagsmatch match todomatch nil))
14475 ;; Make the tags matcher
14476 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14477 (setq tagsmatcher t)
14478 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14479 (while (setq term (pop orterms))
14480 (while (and (equal (substring term -1) "\\") orterms)
14481 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14482 (while (string-match re term)
14483 (setq rest (substring term (match-end 0))
14484 minus (and (match-end 1)
14485 (equal (match-string 1 term) "-"))
14486 tag (save-match-data (replace-regexp-in-string
14487 "\\\\-" "-"
14488 (match-string 2 term)))
14489 re-p (equal (string-to-char tag) ?{)
14490 level-p (match-end 4)
14491 prop-p (match-end 5)
14492 mm (cond
14493 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14494 (level-p
14495 (setq level-op (org-op-to-function (match-string 3 term)))
14496 `(,level-op level ,(string-to-number
14497 (match-string 4 term))))
14498 (prop-p
14499 (setq pn (match-string 5 term)
14500 po (match-string 6 term)
14501 pv (match-string 7 term)
14502 re-p (equal (string-to-char pv) ?{)
14503 str-p (equal (string-to-char pv) ?\")
14504 time-p (save-match-data
14505 (string-match "^\"[[<].*[]>]\"$" pv))
14506 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14507 (if time-p (setq pv (org-matcher-time pv)))
14508 (setq po (org-op-to-function po (if time-p 'time str-p)))
14509 (cond
14510 ((equal pn "CATEGORY")
14511 (setq gv '(get-text-property (point) 'org-category)))
14512 ((equal pn "TODO")
14513 (setq gv 'todo))
14515 (setq gv `(org-cached-entry-get nil ,pn))))
14516 (if re-p
14517 (if (eq po 'org<>)
14518 `(not (string-match ,pv (or ,gv "")))
14519 `(string-match ,pv (or ,gv "")))
14520 (if str-p
14521 `(,po (or ,gv "") ,pv)
14522 `(,po (string-to-number (or ,gv ""))
14523 ,(string-to-number pv) ))))
14524 (t `(member ,tag tags-list)))
14525 mm (if minus (list 'not mm) mm)
14526 term rest)
14527 (push mm tagsmatcher))
14528 (push (if (> (length tagsmatcher) 1)
14529 (cons 'and tagsmatcher)
14530 (car tagsmatcher))
14531 orlist)
14532 (setq tagsmatcher nil))
14533 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14534 (setq tagsmatcher
14535 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14536 ;; Make the todo matcher
14537 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14538 (setq todomatcher t)
14539 (setq orterms (org-split-string todomatch "|") orlist nil)
14540 (while (setq term (pop orterms))
14541 (while (string-match re term)
14542 (setq minus (and (match-end 1)
14543 (equal (match-string 1 term) "-"))
14544 kwd (match-string 2 term)
14545 re-p (equal (string-to-char kwd) ?{)
14546 term (substring term (match-end 0))
14547 mm (if re-p
14548 `(string-match ,(substring kwd 1 -1) todo)
14549 (list 'equal 'todo kwd))
14550 mm (if minus (list 'not mm) mm))
14551 (push mm todomatcher))
14552 (push (if (> (length todomatcher) 1)
14553 (cons 'and todomatcher)
14554 (car todomatcher))
14555 orlist)
14556 (setq todomatcher nil))
14557 (setq todomatcher (if (> (length orlist) 1)
14558 (cons 'or orlist) (car orlist))))
14560 ;; Return the string and lisp forms of the matcher
14561 (setq matcher (if todomatcher
14562 (list 'and tagsmatcher todomatcher)
14563 tagsmatcher))
14564 (when todo-only
14565 (setq matcher (list 'and '(member todo org-not-done-keywords)
14566 matcher)))
14567 (cons match0 matcher)))
14569 (defun org-tags-expand (match &optional single-as-list downcased)
14570 "Expand group tags in MATCH.
14572 This replaces every group tag in MATCH with a regexp tag search.
14573 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14574 will be replaced like this:
14576 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14577 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14578 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14580 Replacing by a regexp preserves the structure of the match.
14581 E.g., this expansion
14583 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14585 will match anything tagged with \"Lab\" and \"Home\", or tagged
14586 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14588 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14589 assumed to be a single group tag, and the function will return
14590 the list of tags in this group.
14592 When DOWNCASE is non-nil, expand downcased TAGS."
14593 (if org-group-tags
14594 (let* ((case-fold-search t)
14595 (stable org-mode-syntax-table)
14596 (tal (or org-tag-groups-alist-for-agenda
14597 org-tag-groups-alist))
14598 (tal (if downcased
14599 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14600 (tml (mapcar 'car tal))
14601 (rtnmatch match) rpl)
14602 ;; @ and _ are allowed as word-components in tags
14603 (modify-syntax-entry ?@ "w" stable)
14604 (modify-syntax-entry ?_ "w" stable)
14605 (while (and tml
14606 (with-syntax-table stable
14607 (string-match
14608 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14609 (regexp-opt tml) "\\>\\)") rtnmatch)))
14610 (let* ((dir (match-string 1 rtnmatch))
14611 (tag (match-string 2 rtnmatch))
14612 (tag (if downcased (downcase tag) tag)))
14613 (setq tml (delete tag tml))
14614 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14615 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14616 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14617 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14618 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14619 (if single-as-list
14620 (or (reverse rpl) (list rtnmatch))
14621 rtnmatch))
14622 (if single-as-list (list (if downcased (downcase match) match))
14623 match)))
14625 (defun org-op-to-function (op &optional stringp)
14626 "Turn an operator into the appropriate function."
14627 (setq op
14628 (cond
14629 ((equal op "<" ) '(< string< org-time<))
14630 ((equal op ">" ) '(> org-string> org-time>))
14631 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14632 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14633 ((member op '("=" "==")) '(= string= org-time=))
14634 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14635 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14637 (defun org<> (a b) (not (= a b)))
14638 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14639 (defun org-string>= (a b) (not (string< a b)))
14640 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14641 (defun org-string<> (a b) (not (string= a b)))
14642 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14643 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14644 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14645 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14646 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14647 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14648 (defun org-2ft (s)
14649 "Convert S to a floating point time.
14650 If S is already a number, just return it. If it is a string, parse
14651 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14652 (cond
14653 ((numberp s) s)
14654 ((stringp s)
14655 (condition-case nil
14656 (float-time (apply 'encode-time (org-parse-time-string s)))
14657 (error 0.)))
14658 (t 0.)))
14660 (defun org-time-today ()
14661 "Time in seconds today at 0:00.
14662 Returns the float number of seconds since the beginning of the
14663 epoch to the beginning of today (00:00)."
14664 (float-time (apply 'encode-time
14665 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14667 (defun org-matcher-time (s)
14668 "Interpret a time comparison value."
14669 (save-match-data
14670 (cond
14671 ((string= s "<now>") (float-time))
14672 ((string= s "<today>") (org-time-today))
14673 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14674 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14675 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14676 (+ (org-time-today)
14677 (* (string-to-number (match-string 1 s))
14678 (cdr (assoc (match-string 2 s)
14679 '(("d" . 86400.0) ("w" . 604800.0)
14680 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14681 (t (org-2ft s)))))
14683 (defun org-match-any-p (re list)
14684 "Does re match any element of list?"
14685 (setq list (mapcar (lambda (x) (string-match re x)) list))
14686 (delq nil list))
14688 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14689 (defvar org-tags-overlay (make-overlay 1 1))
14690 (org-detach-overlay org-tags-overlay)
14692 (defun org-get-local-tags-at (&optional pos)
14693 "Get a list of tags defined in the current headline."
14694 (org-get-tags-at pos 'local))
14696 (defun org-get-local-tags ()
14697 "Get a list of tags defined in the current headline."
14698 (org-get-tags-at nil 'local))
14700 (defun org-get-tags-at (&optional pos local)
14701 "Get a list of all headline tags applicable at POS.
14702 POS defaults to point. If tags are inherited, the list contains
14703 the targets in the same sequence as the headlines appear, i.e.
14704 the tags of the current headline come last.
14705 When LOCAL is non-nil, only return tags from the current headline,
14706 ignore inherited ones."
14707 (interactive)
14708 (if (and org-trust-scanner-tags
14709 (or (not pos) (equal pos (point)))
14710 (not local))
14711 org-scanner-tags
14712 (let (tags ltags lastpos parent)
14713 (save-excursion
14714 (save-restriction
14715 (widen)
14716 (goto-char (or pos (point)))
14717 (save-match-data
14718 (catch 'done
14719 (condition-case nil
14720 (progn
14721 (org-back-to-heading t)
14722 (while (not (equal lastpos (point)))
14723 (setq lastpos (point))
14724 (when (looking-at
14725 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14726 (setq ltags (org-split-string
14727 (org-match-string-no-properties 1) ":"))
14728 (when parent
14729 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14730 (setq tags (append
14731 (if parent
14732 (org-remove-uninherited-tags ltags)
14733 ltags)
14734 tags)))
14735 (or org-use-tag-inheritance (throw 'done t))
14736 (if local (throw 'done t))
14737 (or (org-up-heading-safe) (error nil))
14738 (setq parent t)))
14739 (error nil)))))
14740 (if local
14741 tags
14742 (reverse (delete-dups
14743 (reverse (append
14744 (org-remove-uninherited-tags
14745 org-file-tags) tags)))))))))
14747 (defun org-add-prop-inherited (s)
14748 (add-text-properties 0 (length s) '(inherited t) s)
14751 (defun org-toggle-tag (tag &optional onoff)
14752 "Toggle the tag TAG for the current line.
14753 If ONOFF is `on' or `off', don't toggle but set to this state."
14754 (let (res current)
14755 (save-excursion
14756 (org-back-to-heading t)
14757 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14758 (point-at-eol) t)
14759 (progn
14760 (setq current (match-string 1))
14761 (replace-match ""))
14762 (setq current ""))
14763 (setq current (nreverse (org-split-string current ":")))
14764 (cond
14765 ((eq onoff 'on)
14766 (setq res t)
14767 (or (member tag current) (push tag current)))
14768 ((eq onoff 'off)
14769 (or (not (member tag current)) (setq current (delete tag current))))
14770 (t (if (member tag current)
14771 (setq current (delete tag current))
14772 (setq res t)
14773 (push tag current))))
14774 (end-of-line 1)
14775 (if current
14776 (progn
14777 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14778 (org-set-tags nil t))
14779 (delete-horizontal-space))
14780 (run-hooks 'org-after-tags-change-hook))
14781 res))
14783 (defun org-align-tags-here (to-col)
14784 ;; Assumes that this is a headline
14785 "Align tags on the current headline to TO-COL."
14786 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14787 (beginning-of-line 1)
14788 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14789 (< pos (match-beginning 2)))
14790 (progn
14791 (setq tags-l (- (match-end 2) (match-beginning 2)))
14792 (goto-char (match-beginning 1))
14793 (insert " ")
14794 (delete-region (point) (1+ (match-beginning 2)))
14795 (setq ncol (max (current-column)
14796 (1+ col)
14797 (if (> to-col 0)
14798 to-col
14799 (- (abs to-col) tags-l))))
14800 (setq p (point))
14801 (insert (make-string (- ncol (current-column)) ?\ ))
14802 (setq ncol (current-column))
14803 (when indent-tabs-mode (tabify p (point-at-eol)))
14804 (org-move-to-column (min ncol col)))
14805 (goto-char pos))))
14807 (defun org-set-tags-command (&optional arg just-align)
14808 "Call the set-tags command for the current entry."
14809 (interactive "P")
14810 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14811 (org-set-tags arg just-align)
14812 (save-excursion
14813 (unless (and (org-region-active-p)
14814 org-loop-over-headlines-in-active-region)
14815 (org-back-to-heading t))
14816 (org-set-tags arg just-align))))
14818 (defun org-set-tags-to (data)
14819 "Set the tags of the current entry to DATA, replacing the current tags.
14820 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14821 If DATA is nil or the empty string, any tags will be removed."
14822 (interactive "sTags: ")
14823 (setq data
14824 (cond
14825 ((eq data nil) "")
14826 ((equal data "") "")
14827 ((stringp data)
14828 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14829 ":"))
14830 ((listp data)
14831 (concat ":" (mapconcat 'identity data ":") ":"))))
14832 (when data
14833 (save-excursion
14834 (org-back-to-heading t)
14835 (when (looking-at org-complex-heading-regexp)
14836 (if (match-end 5)
14837 (progn
14838 (goto-char (match-beginning 5))
14839 (insert data)
14840 (delete-region (point) (point-at-eol))
14841 (org-set-tags nil 'align))
14842 (goto-char (point-at-eol))
14843 (insert " " data)
14844 (org-set-tags nil 'align)))
14845 (beginning-of-line 1)
14846 (if (looking-at ".*?\\([ \t]+\\)$")
14847 (delete-region (match-beginning 1) (match-end 1))))))
14849 (defun org-align-all-tags ()
14850 "Align the tags i all headings."
14851 (interactive)
14852 (save-excursion
14853 (or (ignore-errors (org-back-to-heading t))
14854 (outline-next-heading))
14855 (if (org-at-heading-p)
14856 (org-set-tags t)
14857 (message "No headings"))))
14859 (defvar org-indent-indentation-per-level)
14860 (defun org-set-tags (&optional arg just-align)
14861 "Set the tags for the current headline.
14862 With prefix ARG, realign all tags in headings in the current buffer.
14863 When JUST-ALIGN is non-nil, only align tags."
14864 (interactive "P")
14865 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14866 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14867 'region-start-level 'region))
14868 org-loop-over-headlines-in-active-region)
14869 (org-map-entries
14870 ;; We don't use ARG and JUST-ALIGN here because these args
14871 ;; are not useful when looping over headlines.
14872 `(org-set-tags)
14873 org-loop-over-headlines-in-active-region
14874 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14875 (let* ((re org-outline-regexp-bol)
14876 (current (unless arg (org-get-tags-string)))
14877 (col (current-column))
14878 (org-setting-tags t)
14879 table current-tags inherited-tags ; computed below when needed
14880 tags p0 c0 c1 rpl di tc level)
14881 (if arg
14882 (save-excursion
14883 (goto-char (point-min))
14884 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14885 (while (re-search-forward re nil t)
14886 (org-set-tags nil t)
14887 (end-of-line 1)))
14888 (message "All tags realigned to column %d" org-tags-column))
14889 (if just-align
14890 (setq tags current)
14891 ;; Get a new set of tags from the user
14892 (save-excursion
14893 (setq table (append org-tag-persistent-alist
14894 (or org-tag-alist (org-get-buffer-tags))
14895 (and
14896 org-complete-tags-always-offer-all-agenda-tags
14897 (org-global-tags-completion-table
14898 (org-agenda-files))))
14899 org-last-tags-completion-table table
14900 current-tags (org-split-string current ":")
14901 inherited-tags (nreverse
14902 (nthcdr (length current-tags)
14903 (nreverse (org-get-tags-at))))
14904 tags
14905 (if (or (eq t org-use-fast-tag-selection)
14906 (and org-use-fast-tag-selection
14907 (delq nil (mapcar 'cdr table))))
14908 (org-fast-tag-selection
14909 current-tags inherited-tags table
14910 (if org-fast-tag-selection-include-todo
14911 org-todo-key-alist))
14912 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14913 (org-trim
14914 (org-icompleting-read "Tags: "
14915 'org-tags-completion-function
14916 nil nil current 'org-tags-history))))))
14917 (while (string-match "[-+&]+" tags)
14918 ;; No boolean logic, just a list
14919 (setq tags (replace-match ":" t t tags))))
14921 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14923 (if org-tags-sort-function
14924 (setq tags (mapconcat 'identity
14925 (sort (org-split-string
14926 tags (org-re "[^[:alnum:]_@#%]+"))
14927 org-tags-sort-function) ":")))
14929 (if (string-match "\\`[\t ]*\\'" tags)
14930 (setq tags "")
14931 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14932 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14934 ;; Insert new tags at the correct column
14935 (beginning-of-line 1)
14936 (setq level (or (and (looking-at org-outline-regexp)
14937 (- (match-end 0) (point) 1))
14939 (cond
14940 ((and (equal current "") (equal tags "")))
14941 ((re-search-forward
14942 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14943 (point-at-eol) t)
14944 (if (equal tags "")
14945 (setq rpl "")
14946 (goto-char (match-beginning 0))
14947 (setq c0 (current-column)
14948 ;; compute offset for the case of org-indent-mode active
14949 di (if (org-bound-and-true-p org-indent-mode)
14950 (* (1- org-indent-indentation-per-level) (1- level))
14952 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14953 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14954 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
14955 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14956 (replace-match rpl t t)
14957 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14958 tags)
14959 (t (error "Tags alignment failed")))
14960 (org-move-to-column col)
14961 (unless just-align
14962 (run-hooks 'org-after-tags-change-hook))))))
14964 (defun org-change-tag-in-region (beg end tag off)
14965 "Add or remove TAG for each entry in the region.
14966 This works in the agenda, and also in an org-mode buffer."
14967 (interactive
14968 (list (region-beginning) (region-end)
14969 (let ((org-last-tags-completion-table
14970 (if (derived-mode-p 'org-mode)
14971 (org-uniquify
14972 (delq nil (append (org-get-buffer-tags)
14973 (org-global-tags-completion-table))))
14974 (org-global-tags-completion-table))))
14975 (org-icompleting-read
14976 "Tag: " 'org-tags-completion-function nil nil nil
14977 'org-tags-history))
14978 (progn
14979 (message "[s]et or [r]emove? ")
14980 (equal (read-char-exclusive) ?r))))
14981 (if (fboundp 'deactivate-mark) (deactivate-mark))
14982 (let ((agendap (equal major-mode 'org-agenda-mode))
14983 l1 l2 m buf pos newhead (cnt 0))
14984 (goto-char end)
14985 (setq l2 (1- (org-current-line)))
14986 (goto-char beg)
14987 (setq l1 (org-current-line))
14988 (loop for l from l1 to l2 do
14989 (org-goto-line l)
14990 (setq m (get-text-property (point) 'org-hd-marker))
14991 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14992 (and agendap m))
14993 (setq buf (if agendap (marker-buffer m) (current-buffer))
14994 pos (if agendap m (point)))
14995 (with-current-buffer buf
14996 (save-excursion
14997 (save-restriction
14998 (goto-char pos)
14999 (setq cnt (1+ cnt))
15000 (org-toggle-tag tag (if off 'off 'on))
15001 (setq newhead (org-get-heading)))))
15002 (and agendap (org-agenda-change-all-lines newhead m))))
15003 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15005 (defun org-tags-completion-function (string predicate &optional flag)
15006 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15007 (confirm (lambda (x) (stringp (car x)))))
15008 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15009 (setq s1 (match-string 1 string)
15010 s2 (match-string 2 string))
15011 (setq s1 "" s2 string))
15012 (cond
15013 ((eq flag nil)
15014 ;; try completion
15015 (setq rtn (try-completion s2 ctable confirm))
15016 (if (stringp rtn)
15017 (setq rtn
15018 (concat s1 s2 (substring rtn (length s2))
15019 (if (and org-add-colon-after-tag-completion
15020 (assoc rtn ctable))
15021 ":" ""))))
15022 rtn)
15023 ((eq flag t)
15024 ;; all-completions
15025 (all-completions s2 ctable confirm))
15026 ((eq flag 'lambda)
15027 ;; exact match?
15028 (assoc s2 ctable)))))
15030 (defun org-fast-tag-insert (kwd tags face &optional end)
15031 "Insert KDW, and the TAGS, the latter with face FACE.
15032 Also insert END."
15033 (insert (format "%-12s" (concat kwd ":"))
15034 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15035 (or end "")))
15037 (defun org-fast-tag-show-exit (flag)
15038 (save-excursion
15039 (org-goto-line 3)
15040 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15041 (replace-match ""))
15042 (when flag
15043 (end-of-line 1)
15044 (org-move-to-column (- (window-width) 19) t)
15045 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15047 (defun org-set-current-tags-overlay (current prefix)
15048 "Add an overlay to CURRENT tag with PREFIX."
15049 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15050 (if (featurep 'xemacs)
15051 (org-overlay-display org-tags-overlay (concat prefix s)
15052 'secondary-selection)
15053 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15054 (org-overlay-display org-tags-overlay (concat prefix s)))))
15056 (defvar org-last-tag-selection-key nil)
15057 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15058 "Fast tag selection with single keys.
15059 CURRENT is the current list of tags in the headline, INHERITED is the
15060 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15061 possibly with grouping information. TODO-TABLE is a similar table with
15062 TODO keywords, should these have keys assigned to them.
15063 If the keys are nil, a-z are automatically assigned.
15064 Returns the new tags string, or nil to not change the current settings."
15065 (let* ((fulltable (append table todo-table))
15066 (maxlen (apply 'max (mapcar
15067 (lambda (x)
15068 (if (stringp (car x)) (string-width (car x)) 0))
15069 fulltable)))
15070 (buf (current-buffer))
15071 (expert (eq org-fast-tag-selection-single-key 'expert))
15072 (buffer-tags nil)
15073 (fwidth (+ maxlen 3 1 3))
15074 (ncol (/ (- (window-width) 4) fwidth))
15075 (i-face 'org-done)
15076 (c-face 'org-todo)
15077 tg cnt e c char c1 c2 ntable tbl rtn
15078 ov-start ov-end ov-prefix
15079 (exit-after-next org-fast-tag-selection-single-key)
15080 (done-keywords org-done-keywords)
15081 groups ingroup)
15082 (save-excursion
15083 (beginning-of-line 1)
15084 (if (looking-at
15085 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15086 (setq ov-start (match-beginning 1)
15087 ov-end (match-end 1)
15088 ov-prefix "")
15089 (setq ov-start (1- (point-at-eol))
15090 ov-end (1+ ov-start))
15091 (skip-chars-forward "^\n\r")
15092 (setq ov-prefix
15093 (concat
15094 (buffer-substring (1- (point)) (point))
15095 (if (> (current-column) org-tags-column)
15097 (make-string (- org-tags-column (current-column)) ?\ ))))))
15098 (move-overlay org-tags-overlay ov-start ov-end)
15099 (save-window-excursion
15100 (if expert
15101 (set-buffer (get-buffer-create " *Org tags*"))
15102 (delete-other-windows)
15103 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15104 (org-switch-to-buffer-other-window " *Org tags*"))
15105 (erase-buffer)
15106 (org-set-local 'org-done-keywords done-keywords)
15107 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15108 (org-fast-tag-insert "Current" current c-face "\n\n")
15109 (org-fast-tag-show-exit exit-after-next)
15110 (org-set-current-tags-overlay current ov-prefix)
15111 (setq tbl fulltable char ?a cnt 0)
15112 (while (setq e (pop tbl))
15113 (cond
15114 ((equal (car e) :startgroup)
15115 (push '() groups) (setq ingroup t)
15116 (when (not (= cnt 0))
15117 (setq cnt 0)
15118 (insert "\n"))
15119 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15120 ((equal (car e) :endgroup)
15121 (setq ingroup nil cnt 0)
15122 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15123 ((equal e '(:newline))
15124 (when (not (= cnt 0))
15125 (setq cnt 0)
15126 (insert "\n")
15127 (setq e (car tbl))
15128 (while (equal (car tbl) '(:newline))
15129 (insert "\n")
15130 (setq tbl (cdr tbl)))))
15131 ((equal e '(:grouptags)) nil)
15133 (setq tg (copy-sequence (car e)) c2 nil)
15134 (if (cdr e)
15135 (setq c (cdr e))
15136 ;; automatically assign a character.
15137 (setq c1 (string-to-char
15138 (downcase (substring
15139 tg (if (= (string-to-char tg) ?@) 1 0)))))
15140 (if (or (rassoc c1 ntable) (rassoc c1 table))
15141 (while (or (rassoc char ntable) (rassoc char table))
15142 (setq char (1+ char)))
15143 (setq c2 c1))
15144 (setq c (or c2 char)))
15145 (if ingroup (push tg (car groups)))
15146 (setq tg (org-add-props tg nil 'face
15147 (cond
15148 ((not (assoc tg table))
15149 (org-get-todo-face tg))
15150 ((member tg current) c-face)
15151 ((member tg inherited) i-face))))
15152 (if (equal (caar tbl) :grouptags)
15153 (org-add-props tg nil 'face 'org-tag-group))
15154 (if (and (= cnt 0) (not ingroup)) (insert " "))
15155 (insert "[" c "] " tg (make-string
15156 (- fwidth 4 (length tg)) ?\ ))
15157 (push (cons tg c) ntable)
15158 (when (= (setq cnt (1+ cnt)) ncol)
15159 (insert "\n")
15160 (if ingroup (insert " "))
15161 (setq cnt 0)))))
15162 (setq ntable (nreverse ntable))
15163 (insert "\n")
15164 (goto-char (point-min))
15165 (if (not expert) (org-fit-window-to-buffer))
15166 (setq rtn
15167 (catch 'exit
15168 (while t
15169 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15170 (if (not groups) "no " "")
15171 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15172 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15173 (setq org-last-tag-selection-key c)
15174 (cond
15175 ((= c ?\r) (throw 'exit t))
15176 ((= c ?!)
15177 (setq groups (not groups))
15178 (goto-char (point-min))
15179 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15180 ((= c ?\C-c)
15181 (if (not expert)
15182 (org-fast-tag-show-exit
15183 (setq exit-after-next (not exit-after-next)))
15184 (setq expert nil)
15185 (delete-other-windows)
15186 (set-window-buffer (split-window-vertically) " *Org tags*")
15187 (org-switch-to-buffer-other-window " *Org tags*")
15188 (org-fit-window-to-buffer)))
15189 ((or (= c ?\C-g)
15190 (and (= c ?q) (not (rassoc c ntable))))
15191 (org-detach-overlay org-tags-overlay)
15192 (setq quit-flag t))
15193 ((= c ?\ )
15194 (setq current nil)
15195 (if exit-after-next (setq exit-after-next 'now)))
15196 ((= c ?\t)
15197 (condition-case nil
15198 (setq tg (org-icompleting-read
15199 "Tag: "
15200 (or buffer-tags
15201 (with-current-buffer buf
15202 (org-get-buffer-tags)))))
15203 (quit (setq tg "")))
15204 (when (string-match "\\S-" tg)
15205 (add-to-list 'buffer-tags (list tg))
15206 (if (member tg current)
15207 (setq current (delete tg current))
15208 (push tg current)))
15209 (if exit-after-next (setq exit-after-next 'now)))
15210 ((setq e (rassoc c todo-table) tg (car e))
15211 (with-current-buffer buf
15212 (save-excursion (org-todo tg)))
15213 (if exit-after-next (setq exit-after-next 'now)))
15214 ((setq e (rassoc c ntable) tg (car e))
15215 (if (member tg current)
15216 (setq current (delete tg current))
15217 (loop for g in groups do
15218 (if (member tg g)
15219 (mapc (lambda (x)
15220 (setq current (delete x current)))
15221 g)))
15222 (push tg current))
15223 (if exit-after-next (setq exit-after-next 'now))))
15225 ;; Create a sorted list
15226 (setq current
15227 (sort current
15228 (lambda (a b)
15229 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15230 (if (eq exit-after-next 'now) (throw 'exit t))
15231 (goto-char (point-min))
15232 (beginning-of-line 2)
15233 (delete-region (point) (point-at-eol))
15234 (org-fast-tag-insert "Current" current c-face)
15235 (org-set-current-tags-overlay current ov-prefix)
15236 (while (re-search-forward
15237 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15238 (setq tg (match-string 1))
15239 (add-text-properties
15240 (match-beginning 1) (match-end 1)
15241 (list 'face
15242 (cond
15243 ((member tg current) c-face)
15244 ((member tg inherited) i-face)
15245 (t (get-text-property (match-beginning 1) 'face))))))
15246 (goto-char (point-min)))))
15247 (org-detach-overlay org-tags-overlay)
15248 (if rtn
15249 (mapconcat 'identity current ":")
15250 nil))))
15252 (defun org-get-tags-string ()
15253 "Get the TAGS string in the current headline."
15254 (unless (org-at-heading-p t)
15255 (user-error "Not on a heading"))
15256 (save-excursion
15257 (beginning-of-line 1)
15258 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15259 (org-match-string-no-properties 1)
15260 "")))
15262 (defun org-get-tags ()
15263 "Get the list of tags specified in the current headline."
15264 (org-split-string (org-get-tags-string) ":"))
15266 (defun org-get-buffer-tags ()
15267 "Get a table of all tags used in the buffer, for completion."
15268 (org-with-wide-buffer
15269 (goto-char (point-min))
15270 (let ((tag-re (concat org-outline-regexp-bol
15271 "\\(?:.*?[ \t]\\)?"
15272 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15273 tags)
15274 (while (re-search-forward tag-re nil t)
15275 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15276 (push tag tags)))
15277 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15279 ;;;; The mapping API
15281 (defun org-map-entries (func &optional match scope &rest skip)
15282 "Call FUNC at each headline selected by MATCH in SCOPE.
15284 FUNC is a function or a lisp form. The function will be called without
15285 arguments, with the cursor positioned at the beginning of the headline.
15286 The return values of all calls to the function will be collected and
15287 returned as a list.
15289 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15290 does not need to preserve point. After evaluation, the cursor will be
15291 moved to the end of the line (presumably of the headline of the
15292 processed entry) and search continues from there. Under some
15293 circumstances, this may not produce the wanted results. For example,
15294 if you have removed (e.g. archived) the current (sub)tree it could
15295 mean that the next entry will be skipped entirely. In such cases, you
15296 can specify the position from where search should continue by making
15297 FUNC set the variable `org-map-continue-from' to the desired buffer
15298 position.
15300 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15301 Only headlines that are matched by this query will be considered during
15302 the iteration. When MATCH is nil or t, all headlines will be
15303 visited by the iteration.
15305 SCOPE determines the scope of this command. It can be any of:
15307 nil The current buffer, respecting the restriction if any
15308 tree The subtree started with the entry at point
15309 region The entries within the active region, if any
15310 region-start-level
15311 The entries within the active region, but only those at
15312 the same level than the first one.
15313 file The current buffer, without restriction
15314 file-with-archives
15315 The current buffer, and any archives associated with it
15316 agenda All agenda files
15317 agenda-with-archives
15318 All agenda files with any archive files associated with them
15319 \(file1 file2 ...)
15320 If this is a list, all files in the list will be scanned
15322 The remaining args are treated as settings for the skipping facilities of
15323 the scanner. The following items can be given here:
15325 archive skip trees with the archive tag
15326 comment skip trees with the COMMENT keyword
15327 function or Emacs Lisp form:
15328 will be used as value for `org-agenda-skip-function', so
15329 whenever the function returns a position, FUNC will not be
15330 called for that entry and search will continue from the
15331 position returned
15333 If your function needs to retrieve the tags including inherited tags
15334 at the *current* entry, you can use the value of the variable
15335 `org-scanner-tags' which will be much faster than getting the value
15336 with `org-get-tags-at'. If your function gets properties with
15337 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15338 to t around the call to `org-entry-properties' to get the same speedup.
15339 Note that if your function moves around to retrieve tags and properties at
15340 a *different* entry, you cannot use these techniques."
15341 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15342 (not (org-region-active-p)))
15343 (let* ((org-agenda-archives-mode nil) ; just to make sure
15344 (org-agenda-skip-archived-trees (memq 'archive skip))
15345 (org-agenda-skip-comment-trees (memq 'comment skip))
15346 (org-agenda-skip-function
15347 (car (org-delete-all '(comment archive) skip)))
15348 (org-tags-match-list-sublevels t)
15349 (start-level (eq scope 'region-start-level))
15350 matcher file res
15351 org-todo-keywords-for-agenda
15352 org-done-keywords-for-agenda
15353 org-todo-keyword-alist-for-agenda
15354 org-tag-alist-for-agenda
15355 todo-only)
15357 (cond
15358 ((eq match t) (setq matcher t))
15359 ((eq match nil) (setq matcher t))
15360 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15362 (save-excursion
15363 (save-restriction
15364 (cond ((eq scope 'tree)
15365 (org-back-to-heading t)
15366 (org-narrow-to-subtree)
15367 (setq scope nil))
15368 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15369 (org-region-active-p))
15370 ;; If needed, set start-level to a string like "2"
15371 (when start-level
15372 (save-excursion
15373 (goto-char (region-beginning))
15374 (unless (org-at-heading-p) (outline-next-heading))
15375 (setq start-level (org-current-level))))
15376 (narrow-to-region (region-beginning)
15377 (save-excursion
15378 (goto-char (region-end))
15379 (unless (and (bolp) (org-at-heading-p))
15380 (outline-next-heading))
15381 (point)))
15382 (setq scope nil)))
15384 (if (not scope)
15385 (progn
15386 (org-agenda-prepare-buffers
15387 (list (buffer-file-name (current-buffer))))
15388 (setq res (org-scan-tags func matcher todo-only start-level)))
15389 ;; Get the right scope
15390 (cond
15391 ((and scope (listp scope) (symbolp (car scope)))
15392 (setq scope (eval scope)))
15393 ((eq scope 'agenda)
15394 (setq scope (org-agenda-files t)))
15395 ((eq scope 'agenda-with-archives)
15396 (setq scope (org-agenda-files t))
15397 (setq scope (org-add-archive-files scope)))
15398 ((eq scope 'file)
15399 (setq scope (list (buffer-file-name))))
15400 ((eq scope 'file-with-archives)
15401 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15402 (org-agenda-prepare-buffers scope)
15403 (while (setq file (pop scope))
15404 (with-current-buffer (org-find-base-buffer-visiting file)
15405 (save-excursion
15406 (save-restriction
15407 (widen)
15408 (goto-char (point-min))
15409 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15410 res)))
15412 ;;; Properties API
15414 (defconst org-special-properties
15415 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15416 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15417 "The special properties valid in Org mode.
15418 These are properties that are not defined in the property drawer,
15419 but in some other way.")
15421 (defconst org-default-properties
15422 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15423 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15424 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15425 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15426 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15427 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15428 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15429 "Some properties that are used by Org mode for various purposes.
15430 Being in this list makes sure that they are offered for completion.")
15432 (defun org--update-property-plist (key val props)
15433 "Associate KEY to VAL in alist PROPS.
15434 Modifications are made by side-effect. Return new alist."
15435 (let* ((appending (string= (substring key -1) "+"))
15436 (key (if appending (substring key 0 -1) key))
15437 (old (assoc-string key props t)))
15438 (if (not old) (cons (cons key val) props)
15439 (setcdr old (if appending (concat (cdr old) " " val) val))
15440 props)))
15442 (defun org-get-property-block (&optional beg force)
15443 "Return the (beg . end) range of the body of the property drawer.
15444 BEG is the beginning of the current subtree, or of the part
15445 before the first headline. If it is not given, it will be found.
15446 If the drawer does not exist, create it if FORCE is non-nil, or
15447 return nil."
15448 (org-with-wide-buffer
15449 (when beg (goto-char beg))
15450 (unless (org-before-first-heading-p)
15451 (let ((beg (cond (beg)
15452 ((or (not (featurep 'org-inlinetask))
15453 (org-inlinetask-in-task-p))
15454 (org-back-to-heading t))
15455 (t (org-with-limited-levels (org-back-to-heading t))))))
15456 (forward-line)
15457 (when (org-looking-at-p org-planning-line-re) (forward-line))
15458 (cond ((looking-at org-property-drawer-re)
15459 (forward-line)
15460 (cons (point) (progn (goto-char (match-end 0))
15461 (line-beginning-position))))
15462 (force
15463 (goto-char beg)
15464 (org-insert-property-drawer)
15465 (let ((pos (save-excursion (search-forward ":END:")
15466 (line-beginning-position))))
15467 (cons pos pos))))))))
15469 (defun org-at-property-p ()
15470 "Non-nil when point is inside a property drawer.
15471 See `org-property-re' for match data, if applicable."
15472 (save-excursion
15473 (beginning-of-line)
15474 (and (looking-at org-property-re)
15475 (let ((property-drawer (save-match-data (org-get-property-block))))
15476 (and property-drawer (< (point) (cdr property-drawer)))))))
15478 (defun org-property-action ()
15479 "Do an action on properties."
15480 (interactive)
15481 (unless (org-at-property-p) (user-error "Not at a property"))
15482 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15483 (let ((c (read-char-exclusive)))
15484 (case c
15485 (?s (call-interactively #'org-set-property))
15486 (?d (call-interactively #'org-delete-property))
15487 (?D (call-interactively #'org-delete-property-globally))
15488 (?c (call-interactively #'org-compute-property-at-point))
15489 (otherwise (user-error "No such property action %c" c)))))
15491 (defun org-inc-effort ()
15492 "Increment the value of the effort property in the current entry."
15493 (interactive)
15494 (org-set-effort nil t))
15496 (defvar org-clock-effort) ; Defined in org-clock.el.
15497 (defvar org-clock-current-task) ; Defined in org-clock.el.
15498 (defun org-set-effort (&optional value increment)
15499 "Set the effort property of the current entry.
15500 With numerical prefix arg, use the nth allowed value, 0 stands for the
15501 10th allowed value.
15503 When INCREMENT is non-nil, set the property to the next allowed value."
15504 (interactive "P")
15505 (if (equal value 0) (setq value 10))
15506 (let* ((completion-ignore-case t)
15507 (prop org-effort-property)
15508 (cur (org-entry-get nil prop))
15509 (allowed (org-property-get-allowed-values nil prop 'table))
15510 (existing (mapcar 'list (org-property-values prop)))
15511 (heading (nth 4 (org-heading-components)))
15513 (val (cond
15514 ((stringp value) value)
15515 ((and allowed (integerp value))
15516 (or (car (nth (1- value) allowed))
15517 (car (org-last allowed))))
15518 ((and allowed increment)
15519 (or (caadr (member (list cur) allowed))
15520 (user-error "Allowed effort values are not set")))
15521 (allowed
15522 (message "Select 1-9,0, [RET%s]: %s"
15523 (if cur (concat "=" cur) "")
15524 (mapconcat 'car allowed " "))
15525 (setq rpl (read-char-exclusive))
15526 (if (equal rpl ?\r)
15528 (setq rpl (- rpl ?0))
15529 (if (equal rpl 0) (setq rpl 10))
15530 (if (and (> rpl 0) (<= rpl (length allowed)))
15531 (car (nth (1- rpl) allowed))
15532 (org-completing-read "Effort: " allowed nil))))
15534 (let (org-completion-use-ido org-completion-use-iswitchb)
15535 (org-completing-read
15536 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15537 (concat "[" cur "]") "")
15538 ": ")
15539 existing nil nil "" nil cur))))))
15540 (unless (equal (org-entry-get nil prop) val)
15541 (org-entry-put nil prop val))
15542 (org-refresh-property
15543 '((effort . identity)
15544 (effort-minutes . org-duration-string-to-minutes))
15545 val)
15546 (when (string= heading org-clock-current-task)
15547 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15548 (org-clock-update-mode-line))
15549 (message "%s is now %s" prop val)))
15551 (defun org-entry-properties (&optional pom which)
15552 "Get all properties of the current entry.
15554 When POM is a buffer position, get all properties from the entry
15555 there instead.
15557 This includes the TODO keyword, the tags, time strings for
15558 deadline, scheduled, and clocking, and any additional properties
15559 defined in the entry.
15561 If WHICH is nil or `all', get all properties. If WHICH is
15562 `special' or `standard', only get that subclass. If WHICH is
15563 a string, only get that property.
15565 Return value is an alist. Keys are properties, as upcased
15566 strings."
15567 (org-with-point-at pom
15568 (when (and (derived-mode-p 'org-mode)
15569 (ignore-errors (org-back-to-heading t)))
15570 (catch 'exit
15571 (let* ((beg (point))
15572 (specific (and (stringp which) (upcase which)))
15573 (which (cond ((not specific) which)
15574 ((member specific org-special-properties) 'special)
15575 (t 'standard)))
15576 props)
15577 ;; Get the special properties, like TODO and TAGS.
15578 (when (memq which '(nil all special))
15579 (when (or (not specific) (string= specific "CLOCKSUM"))
15580 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15581 (when clocksum
15582 (push (cons "CLOCKSUM"
15583 (org-columns-number-to-string
15584 (/ (float clocksum) 60.) 'add_times))
15585 props)))
15586 (when specific (throw 'exit props)))
15587 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15588 (let ((clocksumt (get-text-property (point)
15589 :org-clock-minutes-today)))
15590 (when clocksumt
15591 (push (cons "CLOCKSUM_T"
15592 (org-columns-number-to-string
15593 (/ (float clocksumt) 60.) 'add_times))
15594 props)))
15595 (when specific (throw 'exit props)))
15596 (when (or (not specific) (string= specific "ITEM"))
15597 (when (looking-at org-complex-heading-regexp)
15598 (push (cons "ITEM"
15599 (concat
15600 (org-match-string-no-properties 1)
15601 (let ((title (org-match-string-no-properties 4)))
15602 (when (org-string-nw-p title)
15603 (concat " " (org-remove-tabs title))))))
15604 props))
15605 (when specific (throw 'exit props)))
15606 (when (or (not specific) (string= specific "TODO"))
15607 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15608 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15609 (when specific (throw 'exit props)))
15610 (when (or (not specific) (string= specific "PRIORITY"))
15611 (when (looking-at org-priority-regexp)
15612 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15613 (when specific (throw 'exit props)))
15614 (when (or (not specific) (string= specific "FILE"))
15615 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15616 props)
15617 (when specific (throw 'exit props)))
15618 (when (or (not specific) (string= specific "TAGS"))
15619 (let ((value (org-string-nw-p (org-get-tags-string))))
15620 (when value (push (cons "TAGS" value) props)))
15621 (when specific (throw 'exit props)))
15622 (when (or (not specific) (string= specific "ALLTAGS"))
15623 (let ((value (org-get-tags-at)))
15624 (when value
15625 (push (cons "ALLTAGS"
15626 (format ":%s:" (mapconcat #'identity value ":")))
15627 props)))
15628 (when specific (throw 'exit props)))
15629 (when (or (not specific) (string= specific "BLOCKED"))
15630 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15631 (when specific (throw 'exit props)))
15632 (when (or (not specific)
15633 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15634 (forward-line)
15635 (when (org-looking-at-p org-planning-line-re)
15636 (end-of-line)
15637 (let ((bol (line-beginning-position))
15638 ;; Backward compatibility: time keywords used to
15639 ;; be configurable (before 8.3). Make sure we
15640 ;; get the correct keyword.
15641 (key-assoc `(("CLOSED" . ,org-closed-string)
15642 ("DEADLINE" . ,org-deadline-string)
15643 ("SCHEDULED" . ,org-scheduled-string))))
15644 (dolist (pair (if specific (list (assoc specific key-assoc))
15645 key-assoc))
15646 (save-excursion
15647 (when (search-backward (cdr pair) bol t)
15648 (goto-char (match-end 0))
15649 (skip-chars-forward " \t")
15650 (and (looking-at org-ts-regexp-both)
15651 (push (cons (car pair)
15652 (org-match-string-no-properties 0))
15653 props)))))))
15654 (when specific (throw 'exit props)))
15655 (when (or (not specific)
15656 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15657 (let ((find-ts
15658 (lambda (end ts)
15659 (let ((regexp (if (or (string= specific "TIMESTAMP")
15660 (assoc "TIMESTAMP_IA" ts))
15661 org-ts-regexp
15662 org-ts-regexp-both)))
15663 (catch 'next
15664 (while (re-search-forward regexp end t)
15665 (backward-char)
15666 (let ((object (org-element-context)))
15667 ;; Accept to match timestamps in node
15668 ;; properties, too.
15669 (when (memq (org-element-type object)
15670 '(node-property timestamp))
15671 (let ((type
15672 (org-element-property :type object)))
15673 (cond
15674 ((and (memq type '(active active-range))
15675 (not (equal specific "TIMESTAMP_IA")))
15676 (unless (assoc "TIMESTAMP" ts)
15677 (push (cons "TIMESTAMP"
15678 (org-element-property
15679 :raw-value object))
15681 (when specific (throw 'exit ts))))
15682 ((and (memq type '(inactive inactive-range))
15683 (not (string= specific "TIMESTAMP")))
15684 (unless (assoc "TIMESTAMP_IA" ts)
15685 (push (cons "TIMESTAMP_IA"
15686 (org-element-property
15687 :raw-value object))
15689 (when specific (throw 'exit ts))))))
15690 ;; Both timestamp types are found,
15691 ;; move to next part.
15692 (when (= (length ts) 2) (throw 'next ts)))))
15693 ts)))))
15694 (goto-char beg)
15695 ;; First look for timestamps within headline.
15696 (let ((ts (funcall find-ts (line-end-position) nil)))
15697 (if (= (length ts) 2) (setq props (nconc ts props))
15698 (forward-line)
15699 ;; Then find timestamps in the section, skipping
15700 ;; planning line.
15701 (when (org-looking-at-p org-planning-line-re)
15702 (forward-line))
15703 (let ((end (save-excursion (outline-next-heading))))
15704 (setq props (nconc (funcall find-ts end ts) props))))))))
15705 ;; Get the standard properties, like :PROP:.
15706 (when (memq which '(nil all standard))
15707 ;; If we are looking after a specific property, delegate
15708 ;; to `org-entry-get', which is faster. However, make an
15709 ;; exception for "CATEGORY", since it can be also set
15710 ;; through keywords (i.e. #+CATEGORY).
15711 (if (and specific (not (equal specific "CATEGORY")))
15712 (let ((value (org-entry-get beg specific nil t)))
15713 (throw 'exit (and value (list (cons specific value)))))
15714 (let ((range (org-get-property-block beg)))
15715 (when range
15716 (let ((end (cdr range)) seen-base)
15717 (goto-char (car range))
15718 ;; Unlike to `org--update-property-plist', we
15719 ;; handle the case where base values is found
15720 ;; after its extension. We also forbid standard
15721 ;; properties to be named as special properties.
15722 (while (re-search-forward org-property-re end t)
15723 (let* ((key (upcase (org-match-string-no-properties 2)))
15724 (extendp (org-string-match-p "\\+\\'" key))
15725 (key-base (if extendp (substring key 0 -1) key))
15726 (value (org-match-string-no-properties 3)))
15727 (cond
15728 ((member-ignore-case key-base org-special-properties))
15729 (extendp
15730 (setq props
15731 (org--update-property-plist key value props)))
15732 ((member key seen-base))
15733 (t (push key seen-base)
15734 (let ((p (assoc-string key props t)))
15735 (if p (setcdr p (concat value " " (cdr p)))
15736 (push (cons key value) props))))))))))))
15737 (unless (assoc "CATEGORY" props)
15738 (push (cons "CATEGORY" (org-get-category beg)) props)
15739 (when (string= specific "CATEGORY") (throw 'exit props)))
15740 ;; Return value.
15741 (append (get-text-property beg 'org-summaries) props))))))
15743 (defun org-entry-get (pom property &optional inherit literal-nil)
15744 "Get value of PROPERTY for entry or content at point-or-marker POM.
15746 If INHERIT is non-nil and the entry does not have the property,
15747 then also check higher levels of the hierarchy. If INHERIT is
15748 the symbol `selective', use inheritance only if the setting in
15749 `org-use-property-inheritance' selects PROPERTY for inheritance.
15751 If the property is present but empty, the return value is the
15752 empty string. If the property is not present at all, nil is
15753 returned. In any other case, return the value as a string.
15754 Search is case-insensitive.
15756 If LITERAL-NIL is set, return the string value \"nil\" as
15757 a string, do not interpret it as the list atom nil. This is used
15758 for inheritance when a \"nil\" value can supersede a non-nil
15759 value higher up the hierarchy."
15760 (org-with-point-at pom
15761 (cond
15762 ((and inherit
15763 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15764 (org-entry-get-with-inheritance property literal-nil))
15765 ((member-ignore-case property org-special-properties)
15766 ;; We need a special property. Use `org-entry-properties' to
15767 ;; retrieve it, but specify the wanted property.
15768 (cdr (assoc-string property (org-entry-properties nil property))))
15770 (let ((range (org-get-property-block)))
15771 (when range
15772 (let* ((case-fold-search t)
15773 (end (cdr range))
15774 (props
15775 (let ((global
15776 (or (assoc-string property org-file-properties t)
15777 (assoc-string property org-global-properties t)
15778 (assoc-string
15779 property org-global-properties-fixed t))))
15780 ;; Make sure to not re-use GLOBAL as
15781 ;; `org--update-property-plist' would alter it by
15782 ;; side-effect.
15783 (and global (list (cons property (cdr global))))))
15784 (find-value
15785 (lambda (key)
15786 (when (re-search-forward (org-re-property key nil t) end t)
15787 (setq props
15788 (org--update-property-plist
15789 key (org-match-string-no-properties 3) props))))))
15790 (goto-char (car range))
15791 ;; Find base value.
15792 (save-excursion (funcall find-value property))
15793 ;; Find additional values.
15794 (let ((property+ (concat property "+")))
15795 (while (funcall find-value property+)))
15796 ;; Return final value.
15797 (let ((val (cdr (assoc-string property props t))))
15798 (if literal-nil val (org-not-nil val))))))))))
15800 (defun org-property-or-variable-value (var &optional inherit)
15801 "Check if there is a property fixing the value of VAR.
15802 If yes, return this value. If not, return the current value of the variable."
15803 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15804 (if (and prop (stringp prop) (string-match "\\S-" prop))
15805 (read prop)
15806 (symbol-value var))))
15808 (defun org-entry-delete (pom property)
15809 "Delete the property PROPERTY from entry at point-or-marker POM."
15810 (unless (member property org-special-properties)
15811 (org-with-point-at pom
15812 (let ((range (org-get-property-block)))
15813 (when range
15814 (let ((begin (car range))
15815 (end (copy-marker (cdr range))))
15816 (goto-char begin)
15817 (when (re-search-forward (org-re-property property nil t) end t)
15818 (delete-region (match-beginning 0) (line-beginning-position 2))
15819 ;; If drawer is empty, remove it altogether.
15820 (when (= begin end)
15821 (delete-region (line-beginning-position 0)
15822 (line-beginning-position 2)))
15823 (set-marker end nil))))))))
15825 ;; Multi-values properties are properties that contain multiple values
15826 ;; These values are assumed to be single words, separated by whitespace.
15827 (defun org-entry-add-to-multivalued-property (pom property value)
15828 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15829 (let* ((old (org-entry-get pom property))
15830 (values (and old (org-split-string old "[ \t]"))))
15831 (setq value (org-entry-protect-space value))
15832 (unless (member value values)
15833 (setq values (append values (list value)))
15834 (org-entry-put pom property
15835 (mapconcat 'identity values " ")))))
15837 (defun org-entry-remove-from-multivalued-property (pom property value)
15838 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15839 (let* ((old (org-entry-get pom property))
15840 (values (and old (org-split-string old "[ \t]"))))
15841 (setq value (org-entry-protect-space value))
15842 (when (member value values)
15843 (setq values (delete value values))
15844 (org-entry-put pom property
15845 (mapconcat 'identity values " ")))))
15847 (defun org-entry-member-in-multivalued-property (pom property value)
15848 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15849 (let* ((old (org-entry-get pom property))
15850 (values (and old (org-split-string old "[ \t]"))))
15851 (setq value (org-entry-protect-space value))
15852 (member value values)))
15854 (defun org-entry-get-multivalued-property (pom property)
15855 "Return a list of values in a multivalued property."
15856 (let* ((value (org-entry-get pom property))
15857 (values (and value (org-split-string value "[ \t]"))))
15858 (mapcar 'org-entry-restore-space values)))
15860 (defun org-entry-put-multivalued-property (pom property &rest values)
15861 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15862 VALUES should be a list of strings. Spaces will be protected."
15863 (org-entry-put pom property
15864 (mapconcat 'org-entry-protect-space values " "))
15865 (let* ((value (org-entry-get pom property))
15866 (values (and value (org-split-string value "[ \t]"))))
15867 (mapcar 'org-entry-restore-space values)))
15869 (defun org-entry-protect-space (s)
15870 "Protect spaces and newline in string S."
15871 (while (string-match " " s)
15872 (setq s (replace-match "%20" t t s)))
15873 (while (string-match "\n" s)
15874 (setq s (replace-match "%0A" t t s)))
15877 (defun org-entry-restore-space (s)
15878 "Restore spaces and newline in string S."
15879 (while (string-match "%20" s)
15880 (setq s (replace-match " " t t s)))
15881 (while (string-match "%0A" s)
15882 (setq s (replace-match "\n" t t s)))
15885 (defvar org-entry-property-inherited-from (make-marker)
15886 "Marker pointing to the entry from where a property was inherited.
15887 Each call to `org-entry-get-with-inheritance' will set this marker to the
15888 location of the entry where the inheritance search matched. If there was
15889 no match, the marker will point nowhere.
15890 Note that also `org-entry-get' calls this function, if the INHERIT flag
15891 is set.")
15893 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15894 "Get PROPERTY of entry or content at point, search higher levels if needed.
15895 The search will stop at the first ancestor which has the property defined.
15896 If the value found is \"nil\", return nil to show that the property
15897 should be considered as undefined (this is the meaning of nil here).
15898 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15899 (move-marker org-entry-property-inherited-from nil)
15900 (let (value)
15901 (org-with-wide-buffer
15902 (catch 'exit
15903 (while t
15904 (when (setq value (org-entry-get nil property nil literal-nil))
15905 (org-back-to-heading t)
15906 (move-marker org-entry-property-inherited-from (point))
15907 (throw 'exit nil))
15908 (or (org-up-heading-safe) (throw 'exit nil)))))
15909 (unless value
15910 (setq value
15911 (cdr (or (assoc-string property org-file-properties t)
15912 (assoc-string property org-global-properties t)
15913 (assoc-string property org-global-properties-fixed t)))))
15914 (if literal-nil value (org-not-nil value))))
15916 (defvar org-property-changed-functions nil
15917 "Hook called when the value of a property has changed.
15918 Each hook function should accept two arguments, the name of the property
15919 and the new value.")
15921 (defun org-entry-put (pom property value)
15922 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15924 If the value is `nil', it is converted to the empty string. If
15925 it is not a string, an error is raised.
15927 PROPERTY can be any regular property (see
15928 `org-special-properties'). It can also be \"TODO\",
15929 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
15931 For the last two properties, VALUE may have any of the special
15932 values \"earlier\" and \"later\". The function then increases or
15933 decreases scheduled or deadline date by one day."
15934 (cond ((null value) (setq value ""))
15935 ((not (stringp value)) (error "Properties values should be strings")))
15936 (org-with-point-at pom
15937 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
15938 (org-back-to-heading t)
15939 (org-with-limited-levels (org-back-to-heading t)))
15940 (let ((beg (point)))
15941 (cond
15942 ((equal property "TODO")
15943 (cond ((not (org-string-nw-p value)) (setq value 'none))
15944 ((not (member value org-todo-keywords-1))
15945 (user-error "\"%s\" is not a valid TODO state" value)))
15946 (org-todo value)
15947 (org-set-tags nil 'align))
15948 ((equal property "PRIORITY")
15949 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
15950 (org-set-tags nil 'align))
15951 ((equal property "SCHEDULED")
15952 (forward-line)
15953 (if (and (org-looking-at-p org-planning-line-re)
15954 (re-search-forward
15955 org-scheduled-time-regexp (line-end-position) t))
15956 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15957 ((string= value "later") (org-timestamp-change 1 'day))
15958 ((string= value "") (org-schedule '(4)))
15959 (t (org-schedule nil value)))
15960 (if (member value '("earlier" "later" ""))
15961 (call-interactively #'org-schedule)
15962 (org-schedule nil value))))
15963 ((equal property "DEADLINE")
15964 (forward-line)
15965 (if (and (org-looking-at-p org-planning-line-re)
15966 (re-search-forward
15967 org-deadline-time-regexp (line-end-position) t))
15968 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15969 ((string= value "later") (org-timestamp-change 1 'day))
15970 ((string= value "") (org-deadline '(4)))
15971 (t (org-deadline nil value)))
15972 (if (member value '("earlier" "later" ""))
15973 (call-interactively #'org-deadline)
15974 (org-deadline nil value))))
15975 ((member property org-special-properties)
15976 (error "The %s property cannot be set with `org-entry-put'" property))
15978 (let* ((range (org-get-property-block beg 'force))
15979 (end (cdr range))
15980 (case-fold-search t))
15981 (goto-char (car range))
15982 (if (re-search-forward (org-re-property property nil t) end t)
15983 (progn (delete-region (match-beginning 0) (match-end 0))
15984 (goto-char (match-beginning 0)))
15985 (goto-char end)
15986 (insert "\n")
15987 (backward-char))
15988 (insert ":" property ":")
15989 (when value (insert " " value))
15990 (org-indent-line)))))
15991 (run-hook-with-args 'org-property-changed-functions property value)))
15993 (defun org-buffer-property-keys (&optional specials defaults columns)
15994 "Get all property keys in the current buffer.
15996 When SPECIALS is non-nil, also list the special properties that
15997 reflect things like tags and TODO state.
15999 When DEFAULTS is non-nil, also include properties that has
16000 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16001 DESCRIPTION, LOCATION, and LOGGING and others.
16003 When COLUMNS in non-nil, also include property names given in
16004 COLUMN formats in the current buffer."
16005 (let ((case-fold-search t)
16006 (props (append
16007 (and specials org-special-properties)
16008 (and defaults (cons org-effort-property org-default-properties))
16009 nil)))
16010 (org-with-wide-buffer
16011 (goto-char (point-min))
16012 (while (re-search-forward org-property-start-re nil t)
16013 (let ((range (org-get-property-block)))
16014 (catch 'skip
16015 (unless range
16016 (when (and (not (org-before-first-heading-p))
16017 (y-or-n-p (format "Malformed drawer at %d, repair?"
16018 (line-beginning-position))))
16019 (org-get-property-block nil t))
16020 (throw 'skip nil))
16021 (goto-char (car range))
16022 (let ((begin (car range))
16023 (end (cdr range)))
16024 ;; Make sure that found property block is not located
16025 ;; before current point, as it would generate an infloop.
16026 ;; It can happen, for example, in the following
16027 ;; situation:
16029 ;; * Headline
16030 ;; :PROPERTIES:
16031 ;; ...
16032 ;; :END:
16033 ;; *************** Inlinetask
16034 ;; #+BEGIN_EXAMPLE
16035 ;; :PROPERTIES:
16036 ;; #+END_EXAMPLE
16038 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16039 (while (< (point) end)
16040 (let ((p (progn (looking-at org-property-re)
16041 (org-match-string-no-properties 2))))
16042 ;; Only add true property name, not extension symbol.
16043 (add-to-list 'props
16044 (if (not (org-string-match-p "\\+\\'" p)) p
16045 (substring p 0 -1))))
16046 (forward-line))))
16047 (outline-next-heading)))
16048 (when columns
16049 (goto-char (point-min))
16050 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16051 (let ((element (org-element-at-point)))
16052 (when (memq (org-element-type element) '(keyword node-property))
16053 (let ((value (org-element-property :value element))
16054 (start 0))
16055 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16056 (setq start (match-end 0))
16057 (let ((p (org-match-string-no-properties 1 value)))
16058 (unless (member-ignore-case p org-special-properties)
16059 (add-to-list 'props p))))))))))
16060 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16062 (defun org-property-values (key)
16063 "List all non-nil values of property KEY in current buffer."
16064 (org-with-wide-buffer
16065 (goto-char (point-min))
16066 (let ((case-fold-search t)
16067 (re (org-re-property key))
16068 values)
16069 (while (re-search-forward re nil t)
16070 (add-to-list 'values (org-entry-get (point) key)))
16071 values)))
16073 (defun org-insert-property-drawer ()
16074 "Insert a property drawer into the current entry."
16075 (org-with-wide-buffer
16076 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16077 (org-back-to-heading t)
16078 (org-with-limited-levels (org-back-to-heading t)))
16079 (forward-line)
16080 (when (org-looking-at-p org-planning-line-re) (forward-line))
16081 (unless (org-looking-at-p org-property-drawer-re)
16082 (let ((inhibit-read-only t))
16083 (unless (bolp) (insert "\n"))
16084 (let ((begin (point)))
16085 (insert ":PROPERTIES:\n:END:\n")
16086 (org-indent-region begin (point)))))))
16088 (defun org-insert-drawer (&optional arg drawer)
16089 "Insert a drawer at point.
16091 When optional argument ARG is non-nil, insert a property drawer.
16093 Optional argument DRAWER, when non-nil, is a string representing
16094 drawer's name. Otherwise, the user is prompted for a name.
16096 If a region is active, insert the drawer around that region
16097 instead.
16099 Point is left between drawer's boundaries."
16100 (interactive "P")
16101 (let* ((drawer (if arg "PROPERTIES"
16102 (or drawer (read-from-minibuffer "Drawer: ")))))
16103 (cond
16104 ;; With C-u, fall back on `org-insert-property-drawer'
16105 (arg (org-insert-property-drawer))
16106 ;; Check validity of suggested drawer's name.
16107 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16108 (user-error "Invalid drawer name"))
16109 ;; With an active region, insert a drawer at point.
16110 ((not (org-region-active-p))
16111 (progn
16112 (unless (bolp) (insert "\n"))
16113 (insert (format ":%s:\n\n:END:\n" drawer))
16114 (forward-line -2)))
16115 ;; Otherwise, insert the drawer at point
16117 (let ((rbeg (region-beginning))
16118 (rend (copy-marker (region-end))))
16119 (unwind-protect
16120 (progn
16121 (goto-char rbeg)
16122 (beginning-of-line)
16123 (when (save-excursion
16124 (re-search-forward org-outline-regexp-bol rend t))
16125 (user-error "Drawers cannot contain headlines"))
16126 ;; Position point at the beginning of the first
16127 ;; non-blank line in region. Insert drawer's opening
16128 ;; there, then indent it.
16129 (org-skip-whitespace)
16130 (beginning-of-line)
16131 (insert ":" drawer ":\n")
16132 (forward-line -1)
16133 (indent-for-tab-command)
16134 ;; Move point to the beginning of the first blank line
16135 ;; after the last non-blank line in region. Insert
16136 ;; drawer's closing, then indent it.
16137 (goto-char rend)
16138 (skip-chars-backward " \r\t\n")
16139 (insert "\n:END:")
16140 (deactivate-mark t)
16141 (indent-for-tab-command)
16142 (unless (eolp) (insert "\n")))
16143 ;; Clear marker, whatever the outcome of insertion is.
16144 (set-marker rend nil)))))))
16146 (defvar org-property-set-functions-alist nil
16147 "Property set function alist.
16148 Each entry should have the following format:
16150 (PROPERTY . READ-FUNCTION)
16152 The read function will be called with the same argument as
16153 `org-completing-read'.")
16155 (defun org-set-property-function (property)
16156 "Get the function that should be used to set PROPERTY.
16157 This is computed according to `org-property-set-functions-alist'."
16158 (or (cdr (assoc property org-property-set-functions-alist))
16159 'org-completing-read))
16161 (defun org-read-property-value (property)
16162 "Read PROPERTY value from user."
16163 (let* ((completion-ignore-case t)
16164 (allowed (org-property-get-allowed-values nil property 'table))
16165 (cur (org-entry-get nil property))
16166 (prompt (concat property " value"
16167 (if (and cur (string-match "\\S-" cur))
16168 (concat " [" cur "]") "") ": "))
16169 (set-function (org-set-property-function property))
16170 (val (if allowed
16171 (funcall set-function prompt allowed nil
16172 (not (get-text-property 0 'org-unrestricted
16173 (caar allowed))))
16174 (let (org-completion-use-ido org-completion-use-iswitchb)
16175 (funcall set-function prompt
16176 (mapcar 'list (org-property-values property))
16177 nil nil "" nil cur)))))
16178 (org-trim val)))
16180 (defvar org-last-set-property nil)
16181 (defvar org-last-set-property-value nil)
16182 (defun org-read-property-name ()
16183 "Read a property name."
16184 (let* ((completion-ignore-case t)
16185 (keys (org-buffer-property-keys nil t t))
16186 (default-prop (or (save-excursion
16187 (save-match-data
16188 (beginning-of-line)
16189 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
16190 (null (string= (match-string 1) "END"))
16191 (match-string 1))))
16192 org-last-set-property))
16193 (property (org-icompleting-read
16194 (concat "Property"
16195 (if default-prop (concat " [" default-prop "]") "")
16196 ": ")
16197 (mapcar 'list keys)
16198 nil nil nil nil
16199 default-prop)))
16200 (if (member property keys)
16201 property
16202 (or (cdr (assoc (downcase property)
16203 (mapcar (lambda (x) (cons (downcase x) x))
16204 keys)))
16205 property))))
16207 (defun org-set-property-and-value (use-last)
16208 "Allow to set [PROPERTY]: [value] direction from prompt.
16209 When use-default, don't even ask, just use the last
16210 \"[PROPERTY]: [value]\" string from the history."
16211 (interactive "P")
16212 (let* ((completion-ignore-case t)
16213 (pv (or (and use-last org-last-set-property-value)
16214 (org-completing-read
16215 "Enter a \"[Property]: [value]\" pair: "
16216 nil nil nil nil nil
16217 org-last-set-property-value)))
16218 prop val)
16219 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16220 (setq prop (match-string 1 pv)
16221 val (match-string 2 pv))
16222 (org-set-property prop val))))
16224 (defun org-set-property (property value)
16225 "In the current entry, set PROPERTY to VALUE.
16226 When called interactively, this will prompt for a property name, offering
16227 completion on existing and default properties. And then it will prompt
16228 for a value, offering completion either on allowed values (via an inherited
16229 xxx_ALL property) or on existing values in other instances of this property
16230 in the current file."
16231 (interactive (list nil nil))
16232 (let* ((property (or property (org-read-property-name)))
16233 (value (or value (org-read-property-value property)))
16234 (fn (cdr (assoc property org-properties-postprocess-alist))))
16235 (setq org-last-set-property property)
16236 (setq org-last-set-property-value (concat property ": " value))
16237 ;; Possibly postprocess the inserted value:
16238 (when fn (setq value (funcall fn value)))
16239 (unless (equal (org-entry-get nil property) value)
16240 (org-entry-put nil property value))))
16242 (defun org-delete-property (property)
16243 "In the current entry, delete PROPERTY."
16244 (interactive
16245 (let* ((completion-ignore-case t)
16246 (cat (org-entry-get (point) "CATEGORY"))
16247 (props0 (org-entry-properties nil 'standard))
16248 (props (if cat props0
16249 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16250 (prop (if (< 1 (length props))
16251 (org-icompleting-read "Property: " props nil t)
16252 (caar props))))
16253 (list prop)))
16254 (if (not property)
16255 (message "No property to delete in this entry")
16256 (org-entry-delete nil property)
16257 (message "Property \"%s\" deleted" property)))
16259 (defun org-delete-property-globally (property)
16260 "Remove PROPERTY globally, from all entries."
16261 (interactive
16262 (let* ((completion-ignore-case t)
16263 (prop (org-icompleting-read
16264 "Globally remove property: "
16265 (mapcar 'list (org-buffer-property-keys)))))
16266 (list prop)))
16267 (save-excursion
16268 (save-restriction
16269 (widen)
16270 (goto-char (point-min))
16271 (let ((cnt 0))
16272 (while (re-search-forward
16273 (org-re-property property)
16274 nil t)
16275 (setq cnt (1+ cnt))
16276 (delete-region (match-beginning 0) (1+ (point-at-eol))))
16277 (message "Property \"%s\" removed from %d entries" property cnt)))))
16279 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16281 (defun org-compute-property-at-point ()
16282 "Compute the property at point.
16283 This looks for an enclosing column format, extracts the operator and
16284 then applies it to the property in the column format's scope."
16285 (interactive)
16286 (unless (org-at-property-p)
16287 (user-error "Not at a property"))
16288 (let ((prop (org-match-string-no-properties 2)))
16289 (org-columns-get-format-and-top-level)
16290 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16291 (user-error "No operator defined for property %s" prop))
16292 (org-columns-compute prop)))
16294 (defvar org-property-allowed-value-functions nil
16295 "Hook for functions supplying allowed values for a specific property.
16296 The functions must take a single argument, the name of the property, and
16297 return a flat list of allowed values. If \":ETC\" is one of
16298 the values, this means that these values are intended as defaults for
16299 completion, but that other values should be allowed too.
16300 The functions must return nil if they are not responsible for this
16301 property.")
16303 (defun org-property-get-allowed-values (pom property &optional table)
16304 "Get allowed values for the property PROPERTY.
16305 When TABLE is non-nil, return an alist that can directly be used for
16306 completion."
16307 (let (vals)
16308 (cond
16309 ((equal property "TODO")
16310 (setq vals (org-with-point-at pom
16311 (append org-todo-keywords-1 '("")))))
16312 ((equal property "PRIORITY")
16313 (let ((n org-lowest-priority))
16314 (while (>= n org-highest-priority)
16315 (push (char-to-string n) vals)
16316 (setq n (1- n)))))
16317 ((member property org-special-properties))
16318 ((setq vals (run-hook-with-args-until-success
16319 'org-property-allowed-value-functions property)))
16321 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16322 (when (and vals (string-match "\\S-" vals))
16323 (setq vals (car (read-from-string (concat "(" vals ")"))))
16324 (setq vals (mapcar (lambda (x)
16325 (cond ((stringp x) x)
16326 ((numberp x) (number-to-string x))
16327 ((symbolp x) (symbol-name x))
16328 (t "???")))
16329 vals)))))
16330 (when (member ":ETC" vals)
16331 (setq vals (remove ":ETC" vals))
16332 (org-add-props (car vals) '(org-unrestricted t)))
16333 (if table (mapcar 'list vals) vals)))
16335 (defun org-property-previous-allowed-value (&optional previous)
16336 "Switch to the next allowed value for this property."
16337 (interactive)
16338 (org-property-next-allowed-value t))
16340 (defun org-property-next-allowed-value (&optional previous)
16341 "Switch to the next allowed value for this property."
16342 (interactive)
16343 (unless (org-at-property-p)
16344 (user-error "Not at a property"))
16345 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16346 (key (match-string 2))
16347 (value (match-string 3))
16348 (allowed (or (org-property-get-allowed-values (point) key)
16349 (and (member value '("[ ]" "[-]" "[X]"))
16350 '("[ ]" "[X]"))))
16351 (heading (save-match-data (nth 4 (org-heading-components))))
16352 nval)
16353 (unless allowed
16354 (user-error "Allowed values for this property have not been defined"))
16355 (if previous (setq allowed (reverse allowed)))
16356 (if (member value allowed)
16357 (setq nval (car (cdr (member value allowed)))))
16358 (setq nval (or nval (car allowed)))
16359 (if (equal nval value)
16360 (user-error "Only one allowed value for this property"))
16361 (org-at-property-p)
16362 (replace-match (concat " :" key ": " nval) t t)
16363 (org-indent-line)
16364 (beginning-of-line 1)
16365 (skip-chars-forward " \t")
16366 (when (equal prop org-effort-property)
16367 (org-refresh-property
16368 '((effort . identity)
16369 (effort-minutes . org-duration-string-to-minutes))
16370 nval)
16371 (when (string= org-clock-current-task heading)
16372 (setq org-clock-effort nval)
16373 (org-clock-update-mode-line)))
16374 (run-hook-with-args 'org-property-changed-functions key nval)))
16376 (defun org-find-olp (path &optional this-buffer)
16377 "Return a marker pointing to the entry at outline path OLP.
16378 If anything goes wrong, throw an error.
16379 You can wrap this call to catch the error like this:
16381 (condition-case msg
16382 (org-mobile-locate-entry (match-string 4))
16383 (error (nth 1 msg)))
16385 The return value will then be either a string with the error message,
16386 or a marker if everything is OK.
16388 If THIS-BUFFER is set, the outline path does not contain a file,
16389 only headings."
16390 (let* ((file (if this-buffer buffer-file-name (pop path)))
16391 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16392 (level 1)
16393 (lmin 1)
16394 (lmax 1)
16395 limit re end found pos heading cnt flevel)
16396 (unless buffer (error "File not found :%s" file))
16397 (with-current-buffer buffer
16398 (save-excursion
16399 (save-restriction
16400 (widen)
16401 (setq limit (point-max))
16402 (goto-char (point-min))
16403 (while (setq heading (pop path))
16404 (setq re (format org-complex-heading-regexp-format
16405 (regexp-quote heading)))
16406 (setq cnt 0 pos (point))
16407 (while (re-search-forward re end t)
16408 (setq level (- (match-end 1) (match-beginning 1)))
16409 (if (and (>= level lmin) (<= level lmax))
16410 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16411 (when (= cnt 0) (error "Heading not found on level %d: %s"
16412 lmax heading))
16413 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16414 lmax heading))
16415 (goto-char found)
16416 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16417 (setq end (save-excursion (org-end-of-subtree t t))))
16418 (when (org-at-heading-p)
16419 (point-marker)))))))
16421 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16422 "Find node HEADING in BUFFER.
16423 Return a marker to the heading if it was found, or nil if not.
16424 If POS-ONLY is set, return just the position instead of a marker.
16426 The heading text must match exact, but it may have a TODO keyword,
16427 a priority cookie and tags in the standard locations."
16428 (with-current-buffer (or buffer (current-buffer))
16429 (save-excursion
16430 (save-restriction
16431 (widen)
16432 (goto-char (point-min))
16433 (let (case-fold-search)
16434 (if (re-search-forward
16435 (format org-complex-heading-regexp-format
16436 (regexp-quote heading)) nil t)
16437 (if pos-only
16438 (match-beginning 0)
16439 (move-marker (make-marker) (match-beginning 0)))))))))
16441 (defun org-find-exact-heading-in-directory (heading &optional dir)
16442 "Find Org node headline HEADING in all .org files in directory DIR.
16443 When the target headline is found, return a marker to this location."
16444 (let ((files (directory-files (or dir default-directory)
16445 t "\\`[^.#].*\\.org\\'"))
16446 file visiting m buffer)
16447 (catch 'found
16448 (while (setq file (pop files))
16449 (message "trying %s" file)
16450 (setq visiting (org-find-base-buffer-visiting file))
16451 (setq buffer (or visiting (find-file-noselect file)))
16452 (setq m (org-find-exact-headline-in-buffer
16453 heading buffer))
16454 (when (and (not m) (not visiting)) (kill-buffer buffer))
16455 (and m (throw 'found m))))))
16457 (defun org-find-entry-with-id (ident)
16458 "Locate the entry that contains the ID property with exact value IDENT.
16459 IDENT can be a string, a symbol or a number, this function will search for
16460 the string representation of it.
16461 Return the position where this entry starts, or nil if there is no such entry."
16462 (interactive "sID: ")
16463 (let ((id (cond
16464 ((stringp ident) ident)
16465 ((symbol-name ident) (symbol-name ident))
16466 ((numberp ident) (number-to-string ident))
16467 (t (error "IDENT %s must be a string, symbol or number" ident))))
16468 (case-fold-search nil))
16469 (save-excursion
16470 (save-restriction
16471 (widen)
16472 (goto-char (point-min))
16473 (when (re-search-forward
16474 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16475 nil t)
16476 (org-back-to-heading t)
16477 (point))))))
16479 ;;;; Timestamps
16481 (defvar org-last-changed-timestamp nil)
16482 (defvar org-last-inserted-timestamp nil
16483 "The last time stamp inserted with `org-insert-time-stamp'.")
16484 (defvar org-ts-what) ; dynamically scoped parameter
16486 (defun org-time-stamp (arg &optional inactive)
16487 "Prompt for a date/time and insert a time stamp.
16488 If the user specifies a time like HH:MM or if this command is
16489 called with at least one prefix argument, the time stamp contains
16490 the date and the time. Otherwise, only the date is be included.
16492 All parts of a date not specified by the user is filled in from
16493 the current date/time. So if you just press return without
16494 typing anything, the time stamp will represent the current
16495 date/time.
16497 If there is already a timestamp at the cursor, it will be
16498 modified.
16500 With two universal prefix arguments, insert an active timestamp
16501 with the current time without prompting the user.
16503 When called from lisp, the timestamp is inactive if INACTIVE is
16504 non-nil."
16505 (interactive "P")
16506 (let* ((ts nil)
16507 (default-time
16508 ;; Default time is either today, or, when entering a range,
16509 ;; the range start.
16510 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16511 (save-excursion
16512 (re-search-backward
16513 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16514 (- (point) 20) t)))
16515 (apply 'encode-time (org-parse-time-string (match-string 1)))
16516 (current-time)))
16517 (default-input (and ts (org-get-compact-tod ts)))
16518 (repeater (save-excursion
16519 (save-match-data
16520 (beginning-of-line)
16521 (when (re-search-forward
16522 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16523 (save-excursion (progn (end-of-line) (point))) t)
16524 (match-string 0)))))
16525 org-time-was-given org-end-time-was-given time)
16526 (cond
16527 ((and (org-at-timestamp-p t)
16528 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16529 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16530 (insert "--")
16531 (setq time (let ((this-command this-command))
16532 (org-read-date arg 'totime nil nil
16533 default-time default-input inactive)))
16534 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16535 ((org-at-timestamp-p t)
16536 (setq time (let ((this-command this-command))
16537 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16538 (when (org-at-timestamp-p t) ; just to get the match data
16539 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16540 (replace-match "")
16541 (setq org-last-changed-timestamp
16542 (org-insert-time-stamp
16543 time (or org-time-was-given arg)
16544 inactive nil nil (list org-end-time-was-given)))
16545 (when repeater (goto-char (1- (point))) (insert " " repeater)
16546 (setq org-last-changed-timestamp
16547 (concat (substring org-last-inserted-timestamp 0 -1)
16548 " " repeater ">"))))
16549 (message "Timestamp updated"))
16550 ((equal arg '(16))
16551 (org-insert-time-stamp (current-time) t inactive))
16553 (setq time (let ((this-command this-command))
16554 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16555 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16556 nil nil (list org-end-time-was-given))))))
16558 ;; FIXME: can we use this for something else, like computing time differences?
16559 (defun org-get-compact-tod (s)
16560 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16561 (let* ((t1 (match-string 1 s))
16562 (h1 (string-to-number (match-string 2 s)))
16563 (m1 (string-to-number (match-string 3 s)))
16564 (t2 (and (match-end 4) (match-string 5 s)))
16565 (h2 (and t2 (string-to-number (match-string 6 s))))
16566 (m2 (and t2 (string-to-number (match-string 7 s))))
16567 dh dm)
16568 (if (not t2)
16570 (setq dh (- h2 h1) dm (- m2 m1))
16571 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16572 (concat t1 "+" (number-to-string dh)
16573 (and (/= 0 dm) (format ":%02d" dm)))))))
16575 (defun org-time-stamp-inactive (&optional arg)
16576 "Insert an inactive time stamp.
16577 An inactive time stamp is enclosed in square brackets instead of angle
16578 brackets. It is inactive in the sense that it does not trigger agenda entries,
16579 does not link to the calendar and cannot be changed with the S-cursor keys.
16580 So these are more for recording a certain time/date."
16581 (interactive "P")
16582 (org-time-stamp arg 'inactive))
16584 (defvar org-date-ovl (make-overlay 1 1))
16585 (overlay-put org-date-ovl 'face 'org-date-selected)
16586 (org-detach-overlay org-date-ovl)
16588 (defvar org-ans1) ; dynamically scoped parameter
16589 (defvar org-ans2) ; dynamically scoped parameter
16591 (defvar org-plain-time-of-day-regexp) ; defined below
16593 (defvar org-overriding-default-time nil) ; dynamically scoped
16594 (defvar org-read-date-overlay nil)
16595 (defvar org-dcst nil) ; dynamically scoped
16596 (defvar org-read-date-history nil)
16597 (defvar org-read-date-final-answer nil)
16598 (defvar org-read-date-analyze-futurep nil)
16599 (defvar org-read-date-analyze-forced-year nil)
16600 (defvar org-read-date-inactive)
16602 (defvar org-read-date-minibuffer-local-map
16603 (let* ((map (make-sparse-keymap)))
16604 (set-keymap-parent map minibuffer-local-map)
16605 (org-defkey map (kbd ".")
16606 (lambda () (interactive)
16607 ;; Are we at the beginning of the prompt?
16608 (if (looking-back "^[^:]+: ")
16609 (org-eval-in-calendar '(calendar-goto-today))
16610 (insert "."))))
16611 (org-defkey map (kbd "C-.")
16612 (lambda () (interactive)
16613 (org-eval-in-calendar '(calendar-goto-today))))
16614 (org-defkey map [(meta shift left)]
16615 (lambda () (interactive)
16616 (org-eval-in-calendar '(calendar-backward-month 1))))
16617 (org-defkey map [(meta shift right)]
16618 (lambda () (interactive)
16619 (org-eval-in-calendar '(calendar-forward-month 1))))
16620 (org-defkey map [(meta shift up)]
16621 (lambda () (interactive)
16622 (org-eval-in-calendar '(calendar-backward-year 1))))
16623 (org-defkey map [(meta shift down)]
16624 (lambda () (interactive)
16625 (org-eval-in-calendar '(calendar-forward-year 1))))
16626 (org-defkey map [?\e (shift left)]
16627 (lambda () (interactive)
16628 (org-eval-in-calendar '(calendar-backward-month 1))))
16629 (org-defkey map [?\e (shift right)]
16630 (lambda () (interactive)
16631 (org-eval-in-calendar '(calendar-forward-month 1))))
16632 (org-defkey map [?\e (shift up)]
16633 (lambda () (interactive)
16634 (org-eval-in-calendar '(calendar-backward-year 1))))
16635 (org-defkey map [?\e (shift down)]
16636 (lambda () (interactive)
16637 (org-eval-in-calendar '(calendar-forward-year 1))))
16638 (org-defkey map [(shift up)]
16639 (lambda () (interactive)
16640 (org-eval-in-calendar '(calendar-backward-week 1))))
16641 (org-defkey map [(shift down)]
16642 (lambda () (interactive)
16643 (org-eval-in-calendar '(calendar-forward-week 1))))
16644 (org-defkey map [(shift left)]
16645 (lambda () (interactive)
16646 (org-eval-in-calendar '(calendar-backward-day 1))))
16647 (org-defkey map [(shift right)]
16648 (lambda () (interactive)
16649 (org-eval-in-calendar '(calendar-forward-day 1))))
16650 (org-defkey map "!"
16651 (lambda () (interactive)
16652 (org-eval-in-calendar '(diary-view-entries))
16653 (message "")))
16654 (org-defkey map ">"
16655 (lambda () (interactive)
16656 (org-eval-in-calendar '(calendar-scroll-left 1))))
16657 (org-defkey map "<"
16658 (lambda () (interactive)
16659 (org-eval-in-calendar '(calendar-scroll-right 1))))
16660 (org-defkey map "\C-v"
16661 (lambda () (interactive)
16662 (org-eval-in-calendar
16663 '(calendar-scroll-left-three-months 1))))
16664 (org-defkey map "\M-v"
16665 (lambda () (interactive)
16666 (org-eval-in-calendar
16667 '(calendar-scroll-right-three-months 1))))
16668 map)
16669 "Keymap for minibuffer commands when using `org-read-date'.")
16671 (defvar org-def)
16672 (defvar org-defdecode)
16673 (defvar org-with-time)
16675 (defun org-read-date (&optional org-with-time to-time from-string prompt
16676 default-time default-input inactive)
16677 "Read a date, possibly a time, and make things smooth for the user.
16678 The prompt will suggest to enter an ISO date, but you can also enter anything
16679 which will at least partially be understood by `parse-time-string'.
16680 Unrecognized parts of the date will default to the current day, month, year,
16681 hour and minute. If this command is called to replace a timestamp at point,
16682 or to enter the second timestamp of a range, the default time is taken
16683 from the existing stamp. Furthermore, the command prefers the future,
16684 so if you are giving a date where the year is not given, and the day-month
16685 combination is already past in the current year, it will assume you
16686 mean next year. For details, see the manual. A few examples:
16688 3-2-5 --> 2003-02-05
16689 feb 15 --> currentyear-02-15
16690 2/15 --> currentyear-02-15
16691 sep 12 9 --> 2009-09-12
16692 12:45 --> today 12:45
16693 22 sept 0:34 --> currentyear-09-22 0:34
16694 12 --> currentyear-currentmonth-12
16695 Fri --> nearest Friday after today
16696 -Tue --> last Tuesday
16697 etc.
16699 Furthermore you can specify a relative date by giving, as the *first* thing
16700 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16701 change in days weeks, months, years.
16702 With a single plus or minus, the date is relative to today. With a double
16703 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16704 +4d --> four days from today
16705 +4 --> same as above
16706 +2w --> two weeks from today
16707 ++5 --> five days from default date
16709 The function understands only English month and weekday abbreviations.
16711 While prompting, a calendar is popped up - you can also select the
16712 date with the mouse (button 1). The calendar shows a period of three
16713 months. To scroll it to other months, use the keys `>' and `<'.
16714 If you don't like the calendar, turn it off with
16715 \(setq org-read-date-popup-calendar nil)
16717 With optional argument TO-TIME, the date will immediately be converted
16718 to an internal time.
16719 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16720 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16721 still enter a time, and this function will inform the calling routine
16722 about this change. The calling routine may then choose to change the
16723 format used to insert the time stamp into the buffer to include the time.
16724 With optional argument FROM-STRING, read from this string instead from
16725 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16726 the time/date that is used for everything that is not specified by the
16727 user."
16728 (require 'parse-time)
16729 (let* ((org-time-stamp-rounding-minutes
16730 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16731 (org-dcst org-display-custom-times)
16732 (ct (org-current-time))
16733 (org-def (or org-overriding-default-time default-time ct))
16734 (org-defdecode (decode-time org-def))
16735 (dummy (progn
16736 (when (< (nth 2 org-defdecode) org-extend-today-until)
16737 (setcar (nthcdr 2 org-defdecode) -1)
16738 (setcar (nthcdr 1 org-defdecode) 59)
16739 (setq org-def (apply 'encode-time org-defdecode)
16740 org-defdecode (decode-time org-def)))))
16741 (mouse-autoselect-window nil) ; Don't let the mouse jump
16742 (calendar-frame-setup nil)
16743 (calendar-setup nil)
16744 (calendar-move-hook nil)
16745 (calendar-view-diary-initially-flag nil)
16746 (calendar-view-holidays-initially-flag nil)
16747 (timestr (format-time-string
16748 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16749 (prompt (concat (if prompt (concat prompt " ") "")
16750 (format "Date+time [%s]: " timestr)))
16751 ans (org-ans0 "") org-ans1 org-ans2 final)
16753 (cond
16754 (from-string (setq ans from-string))
16755 (org-read-date-popup-calendar
16756 (save-excursion
16757 (save-window-excursion
16758 (calendar)
16759 (org-eval-in-calendar '(setq cursor-type nil) t)
16760 (unwind-protect
16761 (progn
16762 (calendar-forward-day (- (time-to-days org-def)
16763 (calendar-absolute-from-gregorian
16764 (calendar-current-date))))
16765 (org-eval-in-calendar nil t)
16766 (let* ((old-map (current-local-map))
16767 (map (copy-keymap calendar-mode-map))
16768 (minibuffer-local-map
16769 (copy-keymap org-read-date-minibuffer-local-map)))
16770 (org-defkey map (kbd "RET") 'org-calendar-select)
16771 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16772 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16773 (unwind-protect
16774 (progn
16775 (use-local-map map)
16776 (setq org-read-date-inactive inactive)
16777 (add-hook 'post-command-hook 'org-read-date-display)
16778 (setq org-ans0 (read-string prompt default-input
16779 'org-read-date-history nil))
16780 ;; org-ans0: from prompt
16781 ;; org-ans1: from mouse click
16782 ;; org-ans2: from calendar motion
16783 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16784 (remove-hook 'post-command-hook 'org-read-date-display)
16785 (use-local-map old-map)
16786 (when org-read-date-overlay
16787 (delete-overlay org-read-date-overlay)
16788 (setq org-read-date-overlay nil)))))
16789 (bury-buffer "*Calendar*")))))
16791 (t ; Naked prompt only
16792 (unwind-protect
16793 (setq ans (read-string prompt default-input
16794 'org-read-date-history timestr))
16795 (when org-read-date-overlay
16796 (delete-overlay org-read-date-overlay)
16797 (setq org-read-date-overlay nil)))))
16799 (setq final (org-read-date-analyze ans org-def org-defdecode))
16801 (when org-read-date-analyze-forced-year
16802 (message "Year was forced into %s"
16803 (if org-read-date-force-compatible-dates
16804 "compatible range (1970-2037)"
16805 "range representable on this machine"))
16806 (ding))
16808 ;; One round trip to get rid of 34th of August and stuff like that....
16809 (setq final (decode-time (apply 'encode-time final)))
16811 (setq org-read-date-final-answer ans)
16813 (if to-time
16814 (apply 'encode-time final)
16815 (if (and (boundp 'org-time-was-given) org-time-was-given)
16816 (format "%04d-%02d-%02d %02d:%02d"
16817 (nth 5 final) (nth 4 final) (nth 3 final)
16818 (nth 2 final) (nth 1 final))
16819 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16821 (defun org-read-date-display ()
16822 "Display the current date prompt interpretation in the minibuffer."
16823 (when org-read-date-display-live
16824 (when org-read-date-overlay
16825 (delete-overlay org-read-date-overlay))
16826 (when (minibufferp (current-buffer))
16827 (save-excursion
16828 (end-of-line 1)
16829 (while (not (equal (buffer-substring
16830 (max (point-min) (- (point) 4)) (point))
16831 " "))
16832 (insert " ")))
16833 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16834 " " (or org-ans1 org-ans2)))
16835 (org-end-time-was-given nil)
16836 (f (org-read-date-analyze ans org-def org-defdecode))
16837 (fmts (if org-dcst
16838 org-time-stamp-custom-formats
16839 org-time-stamp-formats))
16840 (fmt (if (or org-with-time
16841 (and (boundp 'org-time-was-given) org-time-was-given))
16842 (cdr fmts)
16843 (car fmts)))
16844 (txt (format-time-string fmt (apply 'encode-time f)))
16845 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16846 (txt (concat "=> " txt)))
16847 (when (and org-end-time-was-given
16848 (string-match org-plain-time-of-day-regexp txt))
16849 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16850 org-end-time-was-given
16851 (substring txt (match-end 0)))))
16852 (when org-read-date-analyze-futurep
16853 (setq txt (concat txt " (=>F)")))
16854 (setq org-read-date-overlay
16855 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16856 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16858 (defun org-read-date-analyze (ans org-def org-defdecode)
16859 "Analyze the combined answer of the date prompt."
16860 ;; FIXME: cleanup and comment
16861 (let ((nowdecode (decode-time (current-time)))
16862 delta deltan deltaw deltadef year month day
16863 hour minute second wday pm h2 m2 tl wday1
16864 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16865 (setq org-read-date-analyze-futurep nil
16866 org-read-date-analyze-forced-year nil)
16867 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16868 (setq ans "+0"))
16870 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16871 (setq ans (replace-match "" t t ans)
16872 deltan (car delta)
16873 deltaw (nth 1 delta)
16874 deltadef (nth 2 delta)))
16876 ;; Check if there is an iso week date in there. If yes, store the
16877 ;; info and postpone interpreting it until the rest of the parsing
16878 ;; is done.
16879 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16880 (setq iso-year (if (match-end 1)
16881 (org-small-year-to-year
16882 (string-to-number (match-string 1 ans))))
16883 iso-weekday (if (match-end 3)
16884 (string-to-number (match-string 3 ans)))
16885 iso-week (string-to-number (match-string 2 ans)))
16886 (setq ans (replace-match "" t t ans)))
16888 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16889 (when (string-match
16890 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16891 (setq year (if (match-end 2)
16892 (string-to-number (match-string 2 ans))
16893 (progn (setq kill-year t)
16894 (string-to-number (format-time-string "%Y"))))
16895 month (string-to-number (match-string 3 ans))
16896 day (string-to-number (match-string 4 ans)))
16897 (if (< year 100) (setq year (+ 2000 year)))
16898 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16899 t nil ans)))
16901 ;; Help matching dotted european dates
16902 (when (string-match
16903 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16904 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16905 (setq kill-year t)
16906 (string-to-number (format-time-string "%Y")))
16907 day (string-to-number (match-string 1 ans))
16908 month (string-to-number (match-string 2 ans))
16909 ans (replace-match (format "%04d-%02d-%02d" year month day)
16910 t nil ans)))
16912 ;; Help matching american dates, like 5/30 or 5/30/7
16913 (when (string-match
16914 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16915 (setq year (if (match-end 4)
16916 (string-to-number (match-string 4 ans))
16917 (progn (setq kill-year t)
16918 (string-to-number (format-time-string "%Y"))))
16919 month (string-to-number (match-string 1 ans))
16920 day (string-to-number (match-string 2 ans)))
16921 (if (< year 100) (setq year (+ 2000 year)))
16922 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16923 t nil ans)))
16924 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16925 ;; If there is a time with am/pm, and *no* time without it, we convert
16926 ;; so that matching will be successful.
16927 (loop for i from 1 to 2 do ; twice, for end time as well
16928 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16929 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16930 (setq hour (string-to-number (match-string 1 ans))
16931 minute (if (match-end 3)
16932 (string-to-number (match-string 3 ans))
16934 pm (equal ?p
16935 (string-to-char (downcase (match-string 4 ans)))))
16936 (if (and (= hour 12) (not pm))
16937 (setq hour 0)
16938 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16939 (setq ans (replace-match (format "%02d:%02d" hour minute)
16940 t t ans))))
16942 ;; Check if a time range is given as a duration
16943 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16944 (setq hour (string-to-number (match-string 1 ans))
16945 h2 (+ hour (string-to-number (match-string 3 ans)))
16946 minute (string-to-number (match-string 2 ans))
16947 m2 (+ minute (if (match-end 5) (string-to-number
16948 (match-string 5 ans))0)))
16949 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16950 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16951 t t ans)))
16953 ;; Check if there is a time range
16954 (when (boundp 'org-end-time-was-given)
16955 (setq org-time-was-given nil)
16956 (when (and (string-match org-plain-time-of-day-regexp ans)
16957 (match-end 8))
16958 (setq org-end-time-was-given (match-string 8 ans))
16959 (setq ans (concat (substring ans 0 (match-beginning 7))
16960 (substring ans (match-end 7))))))
16962 (setq tl (parse-time-string ans)
16963 day (or (nth 3 tl) (nth 3 org-defdecode))
16964 month (or (nth 4 tl)
16965 (if (and org-read-date-prefer-future
16966 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16967 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16968 (nth 4 org-defdecode)))
16969 year (or (and (not kill-year) (nth 5 tl))
16970 (if (and org-read-date-prefer-future
16971 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16972 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16973 (nth 5 org-defdecode)))
16974 hour (or (nth 2 tl) (nth 2 org-defdecode))
16975 minute (or (nth 1 tl) (nth 1 org-defdecode))
16976 second (or (nth 0 tl) 0)
16977 wday (nth 6 tl))
16979 (when (and (eq org-read-date-prefer-future 'time)
16980 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16981 (equal day (nth 3 nowdecode))
16982 (equal month (nth 4 nowdecode))
16983 (equal year (nth 5 nowdecode))
16984 (nth 2 tl)
16985 (or (< (nth 2 tl) (nth 2 nowdecode))
16986 (and (= (nth 2 tl) (nth 2 nowdecode))
16987 (nth 1 tl)
16988 (< (nth 1 tl) (nth 1 nowdecode)))))
16989 (setq day (1+ day)
16990 futurep t))
16992 ;; Special date definitions below
16993 (cond
16994 (iso-week
16995 ;; There was an iso week
16996 (require 'cal-iso)
16997 (setq futurep nil)
16998 (setq year (or iso-year year)
16999 day (or iso-weekday wday 1)
17000 wday nil ; to make sure that the trigger below does not match
17001 iso-date (calendar-gregorian-from-absolute
17002 (calendar-absolute-from-iso
17003 (list iso-week day year))))
17004 ; FIXME: Should we also push ISO weeks into the future?
17005 ; (when (and org-read-date-prefer-future
17006 ; (not iso-year)
17007 ; (< (calendar-absolute-from-gregorian iso-date)
17008 ; (time-to-days (current-time))))
17009 ; (setq year (1+ year)
17010 ; iso-date (calendar-gregorian-from-absolute
17011 ; (calendar-absolute-from-iso
17012 ; (list iso-week day year)))))
17013 (setq month (car iso-date)
17014 year (nth 2 iso-date)
17015 day (nth 1 iso-date)))
17016 (deltan
17017 (setq futurep nil)
17018 (unless deltadef
17019 (let ((now (decode-time (current-time))))
17020 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17021 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17022 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17023 ((equal deltaw "m") (setq month (+ month deltan)))
17024 ((equal deltaw "y") (setq year (+ year deltan)))))
17025 ((and wday (not (nth 3 tl)))
17026 ;; Weekday was given, but no day, so pick that day in the week
17027 ;; on or after the derived date.
17028 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17029 (unless (equal wday wday1)
17030 (setq day (+ day (% (- wday wday1 -7) 7))))))
17031 (if (and (boundp 'org-time-was-given)
17032 (nth 2 tl))
17033 (setq org-time-was-given t))
17034 (if (< year 100) (setq year (+ 2000 year)))
17035 ;; Check of the date is representable
17036 (if org-read-date-force-compatible-dates
17037 (progn
17038 (if (< year 1970)
17039 (setq year 1970 org-read-date-analyze-forced-year t))
17040 (if (> year 2037)
17041 (setq year 2037 org-read-date-analyze-forced-year t)))
17042 (condition-case nil
17043 (ignore (encode-time second minute hour day month year))
17044 (error
17045 (setq year (nth 5 org-defdecode))
17046 (setq org-read-date-analyze-forced-year t))))
17047 (setq org-read-date-analyze-futurep futurep)
17048 (list second minute hour day month year)))
17050 (defvar parse-time-weekdays)
17051 (defun org-read-date-get-relative (s today default)
17052 "Check string S for special relative date string.
17053 TODAY and DEFAULT are internal times, for today and for a default.
17054 Return shift list (N what def-flag)
17055 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17056 N is the number of WHATs to shift.
17057 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17058 the DEFAULT date rather than TODAY."
17059 (require 'parse-time)
17060 (when (and
17061 (string-match
17062 (concat
17063 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17064 "\\([0-9]+\\)?"
17065 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17066 "\\([ \t]\\|$\\)") s)
17067 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17068 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17069 (string-to-char (substring (match-string 1 s) -1))
17070 ?+))
17071 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17072 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17073 (what (if (match-end 3) (match-string 3 s) "d"))
17074 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17075 (date (if rel default today))
17076 (wday (nth 6 (decode-time date)))
17077 delta)
17078 (if wday1
17079 (progn
17080 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17081 (if (= delta 0) (setq delta 7))
17082 (if (= dir ?-)
17083 (progn
17084 (setq delta (- delta 7))
17085 (if (= delta 0) (setq delta -7))))
17086 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17087 (list delta "d" rel))
17088 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17090 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17091 "Turn a user-specified date into the internal representation.
17092 The internal representation needed by the calendar is (month day year).
17093 This is a wrapper to handle the brain-dead convention in calendar that
17094 user function argument order change dependent on argument order."
17095 (if (boundp 'calendar-date-style)
17096 (cond
17097 ((eq calendar-date-style 'american)
17098 (list arg1 arg2 arg3))
17099 ((eq calendar-date-style 'european)
17100 (list arg2 arg1 arg3))
17101 ((eq calendar-date-style 'iso)
17102 (list arg2 arg3 arg1)))
17103 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17104 (if (org-bound-and-true-p european-calendar-style)
17105 (list arg2 arg1 arg3)
17106 (list arg1 arg2 arg3)))))
17108 (defun org-eval-in-calendar (form &optional keepdate)
17109 "Eval FORM in the calendar window and return to current window.
17110 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17111 otherwise stick to the current value of `org-ans2'."
17112 (let ((sf (selected-frame))
17113 (sw (selected-window)))
17114 (select-window (get-buffer-window "*Calendar*" t))
17115 (eval form)
17116 (when (and (not keepdate) (calendar-cursor-to-date))
17117 (let* ((date (calendar-cursor-to-date))
17118 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17119 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17120 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17121 (select-window sw)
17122 (org-select-frame-set-input-focus sf)))
17124 (defun org-calendar-select ()
17125 "Return to `org-read-date' with the date currently selected.
17126 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17127 (interactive)
17128 (when (calendar-cursor-to-date)
17129 (let* ((date (calendar-cursor-to-date))
17130 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17131 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17132 (if (active-minibuffer-window) (exit-minibuffer))))
17134 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17135 "Insert a date stamp for the date given by the internal TIME.
17136 WITH-HM means use the stamp format that includes the time of the day.
17137 INACTIVE means use square brackets instead of angular ones, so that the
17138 stamp will not contribute to the agenda.
17139 PRE and POST are optional strings to be inserted before and after the
17140 stamp.
17141 The command returns the inserted time stamp."
17142 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17143 stamp)
17144 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17145 (insert-before-markers (or pre ""))
17146 (when (listp extra)
17147 (setq extra (car extra))
17148 (if (and (stringp extra)
17149 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17150 (setq extra (format "-%02d:%02d"
17151 (string-to-number (match-string 1 extra))
17152 (string-to-number (match-string 2 extra))))
17153 (setq extra nil)))
17154 (when extra
17155 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17156 (insert-before-markers (setq stamp (format-time-string fmt time)))
17157 (insert-before-markers (or post ""))
17158 (setq org-last-inserted-timestamp stamp)))
17160 (defun org-toggle-time-stamp-overlays ()
17161 "Toggle the use of custom time stamp formats."
17162 (interactive)
17163 (setq org-display-custom-times (not org-display-custom-times))
17164 (unless org-display-custom-times
17165 (let ((p (point-min)) (bmp (buffer-modified-p)))
17166 (while (setq p (next-single-property-change p 'display))
17167 (if (and (get-text-property p 'display)
17168 (eq (get-text-property p 'face) 'org-date))
17169 (remove-text-properties
17170 p (setq p (next-single-property-change p 'display))
17171 '(display t))))
17172 (set-buffer-modified-p bmp)))
17173 (if (featurep 'xemacs)
17174 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17175 (org-restart-font-lock)
17176 (setq org-table-may-need-update t)
17177 (if org-display-custom-times
17178 (message "Time stamps are overlaid with custom format")
17179 (message "Time stamp overlays removed")))
17181 (defun org-display-custom-time (beg end)
17182 "Overlay modified time stamp format over timestamp between BEG and END."
17183 (let* ((ts (buffer-substring beg end))
17184 t1 w1 with-hm tf time str w2 (off 0))
17185 (save-match-data
17186 (setq t1 (org-parse-time-string ts t))
17187 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17188 (setq off (- (match-end 0) (match-beginning 0)))))
17189 (setq end (- end off))
17190 (setq w1 (- end beg)
17191 with-hm (and (nth 1 t1) (nth 2 t1))
17192 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17193 time (org-fix-decoded-time t1)
17194 str (org-add-props
17195 (format-time-string
17196 (substring tf 1 -1) (apply 'encode-time time))
17197 nil 'mouse-face 'highlight)
17198 w2 (length str))
17199 (if (not (= w2 w1))
17200 (add-text-properties (1+ beg) (+ 2 beg)
17201 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17202 (if (featurep 'xemacs)
17203 (progn
17204 (put-text-property beg end 'invisible t)
17205 (put-text-property beg end 'end-glyph (make-glyph str)))
17206 (put-text-property beg end 'display str))))
17208 (defun org-translate-time (string)
17209 "Translate all timestamps in STRING to custom format.
17210 But do this only if the variable `org-display-custom-times' is set."
17211 (when org-display-custom-times
17212 (save-match-data
17213 (let* ((start 0)
17214 (re org-ts-regexp-both)
17215 t1 with-hm inactive tf time str beg end)
17216 (while (setq start (string-match re string start))
17217 (setq beg (match-beginning 0)
17218 end (match-end 0)
17219 t1 (save-match-data
17220 (org-parse-time-string (substring string beg end) t))
17221 with-hm (and (nth 1 t1) (nth 2 t1))
17222 inactive (equal (substring string beg (1+ beg)) "[")
17223 tf (funcall (if with-hm 'cdr 'car)
17224 org-time-stamp-custom-formats)
17225 time (org-fix-decoded-time t1)
17226 str (format-time-string
17227 (concat
17228 (if inactive "[" "<") (substring tf 1 -1)
17229 (if inactive "]" ">"))
17230 (apply 'encode-time time))
17231 string (replace-match str t t string)
17232 start (+ start (length str)))))))
17233 string)
17235 (defun org-fix-decoded-time (time)
17236 "Set 0 instead of nil for the first 6 elements of time.
17237 Don't touch the rest."
17238 (let ((n 0))
17239 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17241 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17243 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17244 "Difference between TIMESTAMP-STRING and now in days.
17245 If SECONDS is non-nil, return the difference in seconds."
17246 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17247 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17248 (funcall fdiff (current-time)))))
17250 (defun org-deadline-close (timestamp-string &optional ndays)
17251 "Is the time in TIMESTAMP-STRING close to the current date?"
17252 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17253 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17254 (not (org-entry-is-done-p))))
17256 (defun org-get-wdays (ts &optional delay zero-delay)
17257 "Get the deadline lead time appropriate for timestring TS.
17258 When DELAY is non-nil, get the delay time for scheduled items
17259 instead of the deadline lead time. When ZERO-DELAY is non-nil
17260 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17261 don't try to find the delay cookie in the scheduled timestamp."
17262 (let ((tv (if delay org-scheduled-delay-days
17263 org-deadline-warning-days)))
17264 (cond
17265 ((or (and delay (< tv 0))
17266 (and delay zero-delay (<= tv 0))
17267 (and (not delay) (<= tv 0)))
17268 ;; Enforce this value no matter what
17269 (- tv))
17270 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17271 ;; lead time is specified.
17272 (floor (* (string-to-number (match-string 1 ts))
17273 (cdr (assoc (match-string 2 ts)
17274 '(("d" . 1) ("w" . 7)
17275 ("m" . 30.4) ("y" . 365.25)
17276 ("h" . 0.041667)))))))
17277 ;; go for the default.
17278 (t tv))))
17280 (defun org-calendar-select-mouse (ev)
17281 "Return to `org-read-date' with the date currently selected.
17282 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17283 (interactive "e")
17284 (mouse-set-point ev)
17285 (when (calendar-cursor-to-date)
17286 (let* ((date (calendar-cursor-to-date))
17287 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17288 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17289 (if (active-minibuffer-window) (exit-minibuffer))))
17291 (defun org-check-deadlines (ndays)
17292 "Check if there are any deadlines due or past due.
17293 A deadline is considered due if it happens within `org-deadline-warning-days'
17294 days from today's date. If the deadline appears in an entry marked DONE,
17295 it is not shown. The prefix arg NDAYS can be used to test that many
17296 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17297 (interactive "P")
17298 (let* ((org-warn-days
17299 (cond
17300 ((equal ndays '(4)) 100000)
17301 (ndays (prefix-numeric-value ndays))
17302 (t (abs org-deadline-warning-days))))
17303 (case-fold-search nil)
17304 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17305 (callback
17306 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17308 (message "%d deadlines past-due or due within %d days"
17309 (org-occur regexp nil callback)
17310 org-warn-days)))
17312 (defsubst org-re-timestamp (type)
17313 "Return a regexp for timestamp TYPE.
17314 Allowed values for TYPE are:
17316 all: all timestamps
17317 active: only active timestamps (<...>)
17318 inactive: only inactive timestamps ([...])
17319 scheduled: only scheduled timestamps
17320 deadline: only deadline timestamps
17321 closed: only closed time-stamps
17323 When TYPE is nil, fall back on returning a regexp that matches
17324 both scheduled and deadline timestamps."
17325 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
17326 ((eq type 'active) org-ts-regexp)
17327 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
17328 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
17329 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17330 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
17331 ((eq type 'scheduled-or-deadline)
17332 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
17334 (defun org-check-before-date (date)
17335 "Check if there are deadlines or scheduled entries before DATE."
17336 (interactive (list (org-read-date)))
17337 (let ((case-fold-search nil)
17338 (regexp (org-re-timestamp org-ts-type))
17339 (callback
17340 (lambda () (time-less-p
17341 (org-time-string-to-time (match-string 1))
17342 (org-time-string-to-time date)))))
17343 (message "%d entries before %s"
17344 (org-occur regexp nil callback) date)))
17346 (defun org-check-after-date (date)
17347 "Check if there are deadlines or scheduled entries after DATE."
17348 (interactive (list (org-read-date)))
17349 (let ((case-fold-search nil)
17350 (regexp (org-re-timestamp org-ts-type))
17351 (callback
17352 (lambda () (not
17353 (time-less-p
17354 (org-time-string-to-time (match-string 1))
17355 (org-time-string-to-time date))))))
17356 (message "%d entries after %s"
17357 (org-occur regexp nil callback) date)))
17359 (defun org-check-dates-range (start-date end-date)
17360 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17361 (interactive (list (org-read-date nil nil nil "Range starts")
17362 (org-read-date nil nil nil "Range end")))
17363 (let ((case-fold-search nil)
17364 (regexp (org-re-timestamp org-ts-type))
17365 (callback
17366 (lambda ()
17367 (let ((match (match-string 1)))
17368 (and
17369 (not (time-less-p
17370 (org-time-string-to-time match)
17371 (org-time-string-to-time start-date)))
17372 (time-less-p
17373 (org-time-string-to-time match)
17374 (org-time-string-to-time end-date)))))))
17375 (message "%d entries between %s and %s"
17376 (org-occur regexp nil callback) start-date end-date)))
17378 (defun org-evaluate-time-range (&optional to-buffer)
17379 "Evaluate a time range by computing the difference between start and end.
17380 Normally the result is just printed in the echo area, but with prefix arg
17381 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17382 If the time range is actually in a table, the result is inserted into the
17383 next column.
17384 For time difference computation, a year is assumed to be exactly 365
17385 days in order to avoid rounding problems."
17386 (interactive "P")
17388 (org-clock-update-time-maybe)
17389 (save-excursion
17390 (unless (org-at-date-range-p t)
17391 (goto-char (point-at-bol))
17392 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17393 (if (not (org-at-date-range-p t))
17394 (user-error "Not at a time-stamp range, and none found in current line")))
17395 (let* ((ts1 (match-string 1))
17396 (ts2 (match-string 2))
17397 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17398 (match-end (match-end 0))
17399 (time1 (org-time-string-to-time ts1))
17400 (time2 (org-time-string-to-time ts2))
17401 (t1 (org-float-time time1))
17402 (t2 (org-float-time time2))
17403 (diff (abs (- t2 t1)))
17404 (negative (< (- t2 t1) 0))
17405 ;; (ys (floor (* 365 24 60 60)))
17406 (ds (* 24 60 60))
17407 (hs (* 60 60))
17408 (fy "%dy %dd %02d:%02d")
17409 (fy1 "%dy %dd")
17410 (fd "%dd %02d:%02d")
17411 (fd1 "%dd")
17412 (fh "%02d:%02d")
17413 y d h m align)
17414 (if havetime
17415 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17417 d (floor (/ diff ds)) diff (mod diff ds)
17418 h (floor (/ diff hs)) diff (mod diff hs)
17419 m (floor (/ diff 60)))
17420 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17422 d (floor (+ (/ diff ds) 0.5))
17423 h 0 m 0))
17424 (if (not to-buffer)
17425 (message "%s" (org-make-tdiff-string y d h m))
17426 (if (org-at-table-p)
17427 (progn
17428 (goto-char match-end)
17429 (setq align t)
17430 (and (looking-at " *|") (goto-char (match-end 0))))
17431 (goto-char match-end))
17432 (if (looking-at
17433 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17434 (replace-match ""))
17435 (if negative (insert " -"))
17436 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17437 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17438 (insert " " (format fh h m))))
17439 (if align (org-table-align))
17440 (message "Time difference inserted")))))
17442 (defun org-make-tdiff-string (y d h m)
17443 (let ((fmt "")
17444 (l nil))
17445 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17446 l (push y l)))
17447 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17448 l (push d l)))
17449 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17450 l (push h l)))
17451 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17452 l (push m l)))
17453 (apply 'format fmt (nreverse l))))
17455 (defun org-time-string-to-time (s &optional buffer pos)
17456 "Convert a timestamp string into internal time."
17457 (condition-case errdata
17458 (apply 'encode-time (org-parse-time-string s))
17459 (error (error "Bad timestamp `%s'%s\nError was: %s"
17460 s (if (not (and buffer pos))
17462 (format " at %d in buffer `%s'" pos buffer))
17463 (cdr errdata)))))
17465 (defun org-time-string-to-seconds (s)
17466 "Convert a timestamp string to a number of seconds."
17467 (org-float-time (org-time-string-to-time s)))
17469 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17470 "Convert a time stamp to an absolute day number.
17471 If there is a specifier for a cyclic time stamp, get the closest
17472 date to DAYNR.
17473 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17474 The variable `date' is bound by the calendar when this is called."
17475 (cond
17476 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17477 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17478 daynr
17479 (+ daynr 1000)))
17480 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17481 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17482 (time-to-days (current-time))) (match-string 0 s)
17483 prefer show-all))
17484 (t (time-to-days
17485 (condition-case errdata
17486 (apply 'encode-time (org-parse-time-string s))
17487 (error (error "Bad timestamp `%s'%s\nError was: %s"
17488 s (if (not (and buffer pos))
17490 (format " at %d in buffer `%s'" pos buffer))
17491 (cdr errdata))))))))
17493 (defun org-days-to-iso-week (days)
17494 "Return the iso week number."
17495 (require 'cal-iso)
17496 (car (calendar-iso-from-absolute days)))
17498 (defun org-small-year-to-year (year)
17499 "Convert 2-digit years into 4-digit years.
17500 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17501 The year 2000 cannot be abbreviated. Any year larger than 99
17502 is returned unchanged."
17503 (if (< year 38)
17504 (setq year (+ 2000 year))
17505 (if (< year 100)
17506 (setq year (+ 1900 year))))
17507 year)
17509 (defun org-time-from-absolute (d)
17510 "Return the time corresponding to date D.
17511 D may be an absolute day number, or a calendar-type list (month day year)."
17512 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17513 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17515 (defun org-calendar-holiday ()
17516 "List of holidays, for Diary display in Org-mode."
17517 (require 'holidays)
17518 (let ((hl (funcall
17519 (if (fboundp 'calendar-check-holidays)
17520 'calendar-check-holidays 'check-calendar-holidays) date)))
17521 (if hl (mapconcat 'identity hl "; "))))
17523 (defun org-diary-sexp-entry (sexp entry date)
17524 "Process a SEXP diary ENTRY for DATE."
17525 (require 'diary-lib)
17526 (let ((result (if calendar-debug-sexp
17527 (let ((stack-trace-on-error t))
17528 (eval (car (read-from-string sexp))))
17529 (condition-case nil
17530 (eval (car (read-from-string sexp)))
17531 (error
17532 (beep)
17533 (message "Bad sexp at line %d in %s: %s"
17534 (org-current-line)
17535 (buffer-file-name) sexp)
17536 (sleep-for 2))))))
17537 (cond ((stringp result) (split-string result "; "))
17538 ((and (consp result)
17539 (not (consp (cdr result)))
17540 (stringp (cdr result))) (cdr result))
17541 ((and (consp result)
17542 (stringp (car result))) result)
17543 (result entry))))
17545 (defun org-diary-to-ical-string (frombuf)
17546 "Get iCalendar entries from diary entries in buffer FROMBUF.
17547 This uses the icalendar.el library."
17548 (let* ((tmpdir (if (featurep 'xemacs)
17549 (temp-directory)
17550 temporary-file-directory))
17551 (tmpfile (make-temp-name
17552 (expand-file-name "orgics" tmpdir)))
17553 buf rtn b e)
17554 (with-current-buffer frombuf
17555 (icalendar-export-region (point-min) (point-max) tmpfile)
17556 (setq buf (find-buffer-visiting tmpfile))
17557 (set-buffer buf)
17558 (goto-char (point-min))
17559 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17560 (setq b (match-beginning 0)))
17561 (goto-char (point-max))
17562 (if (re-search-backward "^END:VEVENT" nil t)
17563 (setq e (match-end 0)))
17564 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17565 (kill-buffer buf)
17566 (delete-file tmpfile)
17567 rtn))
17569 (defun org-closest-date (start current change prefer show-all)
17570 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17571 When PREFER is `past', return a date that is either CURRENT or past.
17572 When PREFER is `future', return a date that is either CURRENT or future.
17573 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17574 ;; Make the proper lists from the dates
17575 (catch 'exit
17576 (let ((a1 '(("h" . hour)
17577 ("d" . day)
17578 ("w" . week)
17579 ("m" . month)
17580 ("y" . year)))
17581 (shour (nth 2 (org-parse-time-string start)))
17582 dn dw sday cday n1 n2 n0
17583 d m y y1 y2 date1 date2 nmonths nm ny m2)
17585 (setq start (org-date-to-gregorian start)
17586 current (org-date-to-gregorian
17587 (if show-all
17588 current
17589 (time-to-days (current-time))))
17590 sday (calendar-absolute-from-gregorian start)
17591 cday (calendar-absolute-from-gregorian current))
17593 (if (<= cday sday) (throw 'exit sday))
17595 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17596 (setq dn (string-to-number (match-string 1 change))
17597 dw (cdr (assoc (match-string 2 change) a1)))
17598 (user-error "Invalid change specifier: %s" change))
17599 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17600 (cond
17601 ((eq dw 'hour)
17602 (let ((missing-hours
17603 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17604 dn)))
17605 (setq n1 (if (zerop missing-hours) cday
17606 (- cday (1+ (floor (/ missing-hours 24)))))
17607 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17608 ((eq dw 'day)
17609 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17610 n2 (+ n1 dn)))
17611 ((eq dw 'year)
17612 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17613 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17614 (setq date1 (list m d y1)
17615 n1 (calendar-absolute-from-gregorian date1)
17616 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17617 n2 (calendar-absolute-from-gregorian date2)))
17618 ((eq dw 'month)
17619 ;; approx number of month between the two dates
17620 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17621 ;; How often does dn fit in there?
17622 (setq d (nth 1 start) m (car start) y (nth 2 start)
17623 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17624 m (+ m nm)
17625 ny (floor (/ m 12))
17626 y (+ y ny)
17627 m (- m (* ny 12)))
17628 (while (> m 12) (setq m (- m 12) y (1+ y)))
17629 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17630 (setq m2 (+ m dn) y2 y)
17631 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17632 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17633 (while (<= n2 cday)
17634 (setq n1 n2 m m2 y y2)
17635 (setq m2 (+ m dn) y2 y)
17636 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17637 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17638 ;; Make sure n1 is the earlier date
17639 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17640 (if show-all
17641 (cond
17642 ((eq prefer 'past) (if (= cday n2) n2 n1))
17643 ((eq prefer 'future) (if (= cday n1) n1 n2))
17644 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17645 (cond
17646 ((eq prefer 'past) (if (= cday n2) n2 n1))
17647 ((eq prefer 'future) (if (= cday n1) n1 n2))
17648 (t (if (= cday n1) n1 n2)))))))
17650 (defun org-date-to-gregorian (date)
17651 "Turn any specification of DATE into a Gregorian date for the calendar."
17652 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17653 ((and (listp date) (= (length date) 3)) date)
17654 ((stringp date)
17655 (setq date (org-parse-time-string date))
17656 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17657 ((listp date)
17658 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17660 (defun org-parse-time-string (s &optional nodefault)
17661 "Parse the standard Org-mode time string.
17662 This should be a lot faster than the normal `parse-time-string'.
17663 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17664 hour and minute fields will be nil if not given."
17665 (cond ((string-match org-ts-regexp0 s)
17666 (list 0
17667 (if (or (match-beginning 8) (not nodefault))
17668 (string-to-number (or (match-string 8 s) "0")))
17669 (if (or (match-beginning 7) (not nodefault))
17670 (string-to-number (or (match-string 7 s) "0")))
17671 (string-to-number (match-string 4 s))
17672 (string-to-number (match-string 3 s))
17673 (string-to-number (match-string 2 s))
17674 nil nil nil))
17675 ((string-match "^<[^>]+>$" s)
17676 (decode-time (seconds-to-time (org-matcher-time s))))
17677 (t (error "Not a standard Org-mode time string: %s" s))))
17679 (defun org-timestamp-up (&optional arg)
17680 "Increase the date item at the cursor by one.
17681 If the cursor is on the year, change the year. If it is on the month,
17682 the day or the time, change that.
17683 With prefix ARG, change by that many units."
17684 (interactive "p")
17685 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17687 (defun org-timestamp-down (&optional arg)
17688 "Decrease the date item at the cursor by one.
17689 If the cursor is on the year, change the year. If it is on the month,
17690 the day or the time, change that.
17691 With prefix ARG, change by that many units."
17692 (interactive "p")
17693 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17695 (defun org-timestamp-up-day (&optional arg)
17696 "Increase the date in the time stamp by one day.
17697 With prefix ARG, change that many days."
17698 (interactive "p")
17699 (if (and (not (org-at-timestamp-p t))
17700 (org-at-heading-p))
17701 (org-todo 'up)
17702 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17704 (defun org-timestamp-down-day (&optional arg)
17705 "Decrease the date in the time stamp by one day.
17706 With prefix ARG, change that many days."
17707 (interactive "p")
17708 (if (and (not (org-at-timestamp-p t))
17709 (org-at-heading-p))
17710 (org-todo 'down)
17711 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17713 (defun org-at-timestamp-p (&optional inactive-ok)
17714 "Determine if the cursor is in or at a timestamp."
17715 (interactive)
17716 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17717 (pos (point))
17718 (ans (or (looking-at tsr)
17719 (save-excursion
17720 (skip-chars-backward "^[<\n\r\t")
17721 (if (> (point) (point-min)) (backward-char 1))
17722 (and (looking-at tsr)
17723 (> (- (match-end 0) pos) -1))))))
17724 (and ans
17725 (boundp 'org-ts-what)
17726 (setq org-ts-what
17727 (cond
17728 ((= pos (match-beginning 0)) 'bracket)
17729 ;; Point is considered to be "on the bracket" whether
17730 ;; it's really on it or right after it.
17731 ((= pos (1- (match-end 0))) 'bracket)
17732 ((= pos (match-end 0)) 'after)
17733 ((org-pos-in-match-range pos 2) 'year)
17734 ((org-pos-in-match-range pos 3) 'month)
17735 ((org-pos-in-match-range pos 7) 'hour)
17736 ((org-pos-in-match-range pos 8) 'minute)
17737 ((or (org-pos-in-match-range pos 4)
17738 (org-pos-in-match-range pos 5)) 'day)
17739 ((and (> pos (or (match-end 8) (match-end 5)))
17740 (< pos (match-end 0)))
17741 (- pos (or (match-end 8) (match-end 5))))
17742 (t 'day))))
17743 ans))
17745 (defun org-toggle-timestamp-type ()
17746 "Toggle the type (<active> or [inactive]) of a time stamp."
17747 (interactive)
17748 (when (org-at-timestamp-p t)
17749 (let ((beg (match-beginning 0)) (end (match-end 0))
17750 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17751 (save-excursion
17752 (goto-char beg)
17753 (while (re-search-forward "[][<>]" end t)
17754 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17755 t t)))
17756 (message "Timestamp is now %sactive"
17757 (if (equal (char-after beg) ?<) "" "in")))))
17759 (defun org-at-clock-log-p nil
17760 "Is the cursor on the clock log line?"
17761 (save-excursion
17762 (move-beginning-of-line 1)
17763 (looking-at org-clock-line-re)))
17765 (defvar org-clock-history) ; defined in org-clock.el
17766 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17767 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17768 "Change the date in the time stamp at point.
17769 The date will be changed by N times WHAT. WHAT can be `day', `month',
17770 `year', `minute', `second'. If WHAT is not given, the cursor position
17771 in the timestamp determines what will be changed.
17772 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17773 (let ((origin (point)) origin-cat
17774 with-hm inactive
17775 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17776 org-ts-what
17777 extra rem
17778 ts time time0 fixnext clrgx)
17779 (if (not (org-at-timestamp-p t))
17780 (user-error "Not at a timestamp"))
17781 (if (and (not what) (eq org-ts-what 'bracket))
17782 (org-toggle-timestamp-type)
17783 ;; Point isn't on brackets. Remember the part of the time-stamp
17784 ;; the point was in. Indeed, size of time-stamps may change,
17785 ;; but point must be kept in the same category nonetheless.
17786 (setq origin-cat org-ts-what)
17787 (if (and (not what) (not (eq org-ts-what 'day))
17788 org-display-custom-times
17789 (get-text-property (point) 'display)
17790 (not (get-text-property (1- (point)) 'display)))
17791 (setq org-ts-what 'day))
17792 (setq org-ts-what (or what org-ts-what)
17793 inactive (= (char-after (match-beginning 0)) ?\[)
17794 ts (match-string 0))
17795 (replace-match "")
17796 (when (string-match
17797 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17799 (setq extra (match-string 1 ts))
17800 (if suppress-tmp-delay
17801 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17802 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17803 (setq with-hm t))
17804 (setq time0 (org-parse-time-string ts))
17805 (when (and updown
17806 (eq org-ts-what 'minute)
17807 (not current-prefix-arg))
17808 ;; This looks like s-up and s-down. Change by one rounding step.
17809 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17810 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17811 (setcar (cdr time0) (+ (nth 1 time0)
17812 (if (> n 0) (- rem) (- dm rem))))))
17813 (setq time
17814 (encode-time (or (car time0) 0)
17815 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17816 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17817 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17818 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17819 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17820 (nthcdr 6 time0)))
17821 (when (and (member org-ts-what '(hour minute))
17822 extra
17823 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17824 (setq extra (org-modify-ts-extra
17825 extra
17826 (if (eq org-ts-what 'hour) 2 5)
17827 n dm)))
17828 (when (integerp org-ts-what)
17829 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17830 (if (eq what 'calendar)
17831 (let ((cal-date (org-get-date-from-calendar)))
17832 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17833 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17834 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17835 (setcar time0 (or (car time0) 0))
17836 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17837 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17838 (setq time (apply 'encode-time time0))))
17839 ;; Insert the new time-stamp, and ensure point stays in the same
17840 ;; category as before (i.e. not after the last position in that
17841 ;; category).
17842 (let ((pos (point)))
17843 ;; Stay before inserted string. `save-excursion' is of no use.
17844 (setq org-last-changed-timestamp
17845 (org-insert-time-stamp time with-hm inactive nil nil extra))
17846 (goto-char pos))
17847 (save-match-data
17848 (looking-at org-ts-regexp3)
17849 (goto-char (cond
17850 ;; `day' category ends before `hour' if any, or at
17851 ;; the end of the day name.
17852 ((eq origin-cat 'day)
17853 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17854 ((eq origin-cat 'hour) (min (match-end 7) origin))
17855 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17856 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17857 ;; `year' and `month' have both fixed size: point
17858 ;; couldn't have moved into another part.
17859 (t origin))))
17860 ;; Update clock if on a CLOCK line.
17861 (org-clock-update-time-maybe)
17862 ;; Maybe adjust the closest clock in `org-clock-history'
17863 (when org-clock-adjust-closest
17864 (if (not (and (org-at-clock-log-p)
17865 (< 1 (length (delq nil (mapcar 'marker-position
17866 org-clock-history))))))
17867 (message "No clock to adjust")
17868 (cond ((save-excursion ; fix previous clock?
17869 (re-search-backward org-ts-regexp0 nil t)
17870 (org-looking-back (concat org-clock-string " \\[")))
17871 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17872 ((save-excursion ; fix next clock?
17873 (re-search-backward org-ts-regexp0 nil t)
17874 (looking-at (concat org-ts-regexp0 "\\] =>")))
17875 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17876 (save-window-excursion
17877 ;; Find closest clock to point, adjust the previous/next one in history
17878 (let* ((p (save-excursion (org-back-to-heading t)))
17879 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17880 (clfixnth
17881 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17882 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17883 (if (not clfixpos)
17884 (message "No clock to adjust")
17885 (save-excursion
17886 (org-goto-marker-or-bmk clfixpos)
17887 (org-show-subtree)
17888 (when (re-search-forward clrgx nil t)
17889 (goto-char (match-beginning 1))
17890 (let (org-clock-adjust-closest)
17891 (org-timestamp-change n org-ts-what updown))
17892 (message "Clock adjusted in %s for heading: %s"
17893 (file-name-nondirectory (buffer-file-name))
17894 (org-get-heading t t)))))))))
17895 ;; Try to recenter the calendar window, if any.
17896 (if (and org-calendar-follow-timestamp-change
17897 (get-buffer-window "*Calendar*" t)
17898 (memq org-ts-what '(day month year)))
17899 (org-recenter-calendar (time-to-days time))))))
17901 (defun org-modify-ts-extra (s pos n dm)
17902 "Change the different parts of the lead-time and repeat fields in timestamp."
17903 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17904 ng h m new rem)
17905 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17906 (cond
17907 ((or (org-pos-in-match-range pos 2)
17908 (org-pos-in-match-range pos 3))
17909 (setq m (string-to-number (match-string 3 s))
17910 h (string-to-number (match-string 2 s)))
17911 (if (org-pos-in-match-range pos 2)
17912 (setq h (+ h n))
17913 (setq n (* dm (org-no-warnings (signum n))))
17914 (when (not (= 0 (setq rem (% m dm))))
17915 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17916 (setq m (+ m n)))
17917 (if (< m 0) (setq m (+ m 60) h (1- h)))
17918 (if (> m 59) (setq m (- m 60) h (1+ h)))
17919 (setq h (min 24 (max 0 h)))
17920 (setq ng 1 new (format "-%02d:%02d" h m)))
17921 ((org-pos-in-match-range pos 6)
17922 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17923 ((org-pos-in-match-range pos 5)
17924 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17926 ((org-pos-in-match-range pos 9)
17927 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17928 ((org-pos-in-match-range pos 8)
17929 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17931 (when ng
17932 (setq s (concat
17933 (substring s 0 (match-beginning ng))
17935 (substring s (match-end ng))))))
17938 (defun org-recenter-calendar (date)
17939 "If the calendar is visible, recenter it to DATE."
17940 (let ((cwin (get-buffer-window "*Calendar*" t)))
17941 (when cwin
17942 (let ((calendar-move-hook nil))
17943 (with-selected-window cwin
17944 (calendar-goto-date (if (listp date) date
17945 (calendar-gregorian-from-absolute date))))))))
17947 (defun org-goto-calendar (&optional arg)
17948 "Go to the Emacs calendar at the current date.
17949 If there is a time stamp in the current line, go to that date.
17950 A prefix ARG can be used to force the current date."
17951 (interactive "P")
17952 (let ((tsr org-ts-regexp) diff
17953 (calendar-move-hook nil)
17954 (calendar-view-holidays-initially-flag nil)
17955 (calendar-view-diary-initially-flag nil))
17956 (if (or (org-at-timestamp-p)
17957 (save-excursion
17958 (beginning-of-line 1)
17959 (looking-at (concat ".*" tsr))))
17960 (let ((d1 (time-to-days (current-time)))
17961 (d2 (time-to-days
17962 (org-time-string-to-time (match-string 1)))))
17963 (setq diff (- d2 d1))))
17964 (calendar)
17965 (calendar-goto-today)
17966 (if (and diff (not arg)) (calendar-forward-day diff))))
17968 (defun org-get-date-from-calendar ()
17969 "Return a list (month day year) of date at point in calendar."
17970 (with-current-buffer "*Calendar*"
17971 (save-match-data
17972 (calendar-cursor-to-date))))
17974 (defun org-date-from-calendar ()
17975 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17976 If there is already a time stamp at the cursor position, update it."
17977 (interactive)
17978 (if (org-at-timestamp-p t)
17979 (org-timestamp-change 0 'calendar)
17980 (let ((cal-date (org-get-date-from-calendar)))
17981 (org-insert-time-stamp
17982 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17984 (defcustom org-effort-durations
17985 `(("min" . 1)
17986 ("h" . 60)
17987 ("d" . ,(* 60 8))
17988 ("w" . ,(* 60 8 5))
17989 ("m" . ,(* 60 8 5 4))
17990 ("y" . ,(* 60 8 5 40)))
17991 "Conversion factor to minutes for an effort modifier.
17993 Each entry has the form (MODIFIER . MINUTES).
17995 In an effort string, a number followed by MODIFIER is multiplied
17996 by the specified number of MINUTES to obtain an effort in
17997 minutes.
17999 For example, if the value of this variable is ((\"hours\" . 60)), then an
18000 effort string \"2hours\" is equivalent to 120 minutes."
18001 :group 'org-agenda
18002 :version "25.1"
18003 :package-version '(Org . "8.3")
18004 :type '(alist :key-type (string :tag "Modifier")
18005 :value-type (number :tag "Minutes")))
18007 (defun org-minutes-to-clocksum-string (m)
18008 "Format number of minutes as a clocksum string.
18009 The format is determined by `org-time-clocksum-format',
18010 `org-time-clocksum-use-fractional' and
18011 `org-time-clocksum-fractional-format' and
18012 `org-time-clocksum-use-effort-durations'."
18013 (let ((clocksum "")
18014 (m (round m)) ; Don't allow fractions of minutes
18015 h d w mo y fmt n)
18016 (setq h (if org-time-clocksum-use-effort-durations
18017 (cdr (assoc "h" org-effort-durations)) 60)
18018 d (if org-time-clocksum-use-effort-durations
18019 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18020 w (if org-time-clocksum-use-effort-durations
18021 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18022 mo (if org-time-clocksum-use-effort-durations
18023 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18024 y (if org-time-clocksum-use-effort-durations
18025 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18026 ;; fractional format
18027 (if org-time-clocksum-use-fractional
18028 (cond
18029 ;; single format string
18030 ((stringp org-time-clocksum-fractional-format)
18031 (format org-time-clocksum-fractional-format (/ m (float h))))
18032 ;; choice of fractional formats for different time units
18033 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18034 (> (/ (truncate m) (* y d h)) 0))
18035 (format fmt (/ m (* y d (float h)))))
18036 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18037 (> (/ (truncate m) (* mo d h)) 0))
18038 (format fmt (/ m (* mo d (float h)))))
18039 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18040 (> (/ (truncate m) (* w d h)) 0))
18041 (format fmt (/ m (* w d (float h)))))
18042 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18043 (> (/ (truncate m) (* d h)) 0))
18044 (format fmt (/ m (* d (float h)))))
18045 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18046 (> (/ (truncate m) h) 0))
18047 (format fmt (/ m (float h))))
18048 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18049 (format fmt m))
18050 ;; fall back to smallest time unit with a format
18051 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18052 (format fmt (/ m (float h))))
18053 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18054 (format fmt (/ m (* d (float h)))))
18055 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18056 (format fmt (/ m (* w d (float h)))))
18057 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18058 (format fmt (/ m (* mo d (float h)))))
18059 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18060 (format fmt (/ m (* y d (float h))))))
18061 ;; standard (non-fractional) format, with single format string
18062 (if (stringp org-time-clocksum-format)
18063 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18064 ;; separate formats components
18065 (and (setq fmt (plist-get org-time-clocksum-format :years))
18066 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18067 (plist-get org-time-clocksum-format :require-years))
18068 (setq clocksum (concat clocksum (format fmt n))
18069 m (- m (* n y d h))))
18070 (and (setq fmt (plist-get org-time-clocksum-format :months))
18071 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18072 (plist-get org-time-clocksum-format :require-months))
18073 (setq clocksum (concat clocksum (format fmt n))
18074 m (- m (* n mo d h))))
18075 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18076 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18077 (plist-get org-time-clocksum-format :require-weeks))
18078 (setq clocksum (concat clocksum (format fmt n))
18079 m (- m (* n w d h))))
18080 (and (setq fmt (plist-get org-time-clocksum-format :days))
18081 (or (> (setq n (/ (truncate m) (* d h))) 0)
18082 (plist-get org-time-clocksum-format :require-days))
18083 (setq clocksum (concat clocksum (format fmt n))
18084 m (- m (* n d h))))
18085 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18086 (or (> (setq n (/ (truncate m) h)) 0)
18087 (plist-get org-time-clocksum-format :require-hours))
18088 (setq clocksum (concat clocksum (format fmt n))
18089 m (- m (* n h))))
18090 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18091 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18092 (setq clocksum (concat clocksum (format fmt m))))
18093 ;; return formatted time duration
18094 clocksum))))
18096 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18097 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18098 "Org mode version 8.0")
18100 (defun org-hours-to-clocksum-string (n)
18101 (org-minutes-to-clocksum-string (* n 60)))
18103 (defun org-hh:mm-string-to-minutes (s)
18104 "Convert a string H:MM to a number of minutes.
18105 If the string is just a number, interpret it as minutes.
18106 In fact, the first hh:mm or number in the string will be taken,
18107 there can be extra stuff in the string.
18108 If no number is found, the return value is 0."
18109 (cond
18110 ((integerp s) s)
18111 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18112 (+ (* (string-to-number (match-string 1 s)) 60)
18113 (string-to-number (match-string 2 s))))
18114 ((string-match "\\([0-9]+\\)" s)
18115 (string-to-number (match-string 1 s)))
18116 (t 0)))
18118 (defcustom org-image-actual-width t
18119 "Should we use the actual width of images when inlining them?
18121 When set to `t', always use the image width.
18123 When set to a number, use imagemagick (when available) to set
18124 the image's width to this value.
18126 When set to a number in a list, try to get the width from any
18127 #+ATTR.* keyword if it matches a width specification like
18129 #+ATTR_HTML: :width 300px
18131 and fall back on that number if none is found.
18133 When set to nil, try to get the width from an #+ATTR.* keyword
18134 and fall back on the original width if none is found.
18136 This requires Emacs >= 24.1, build with imagemagick support."
18137 :group 'org-appearance
18138 :version "24.4"
18139 :package-version '(Org . "8.0")
18140 :type '(choice
18141 (const :tag "Use the image width" t)
18142 (integer :tag "Use a number of pixels")
18143 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18144 (const :tag "Use #+ATTR* or don't resize" nil)))
18146 (defcustom org-agenda-inhibit-startup nil
18147 "Inhibit startup when preparing agenda buffers.
18148 When this variable is `t', the initialization of the Org agenda
18149 buffers is inhibited: e.g. the visibility state is not set, the
18150 tables are not re-aligned, etc."
18151 :type 'boolean
18152 :version "24.3"
18153 :group 'org-agenda)
18155 (define-obsolete-variable-alias
18156 'org-agenda-ignore-drawer-properties
18157 'org-agenda-ignore-properties "25.1")
18159 (defcustom org-agenda-ignore-properties nil
18160 "Avoid updating text properties when building the agenda.
18161 Properties are used to prepare buffers for effort estimates,
18162 appointments, statistics and subtree-local categories.
18163 If you don't use these in the agenda, you can add them to this
18164 list and agenda building will be a bit faster.
18165 The value is a list, with zero or more of the symbols `effort', `appt',
18166 `stats' or `category'."
18167 :type '(set :greedy t
18168 (const effort)
18169 (const appt)
18170 (const stats)
18171 (const category))
18172 :version "25.1"
18173 :package-version '(Org . "8.3")
18174 :group 'org-agenda)
18176 (defun org-duration-string-to-minutes (s &optional output-to-string)
18177 "Convert a duration string S to minutes.
18179 A bare number is interpreted as minutes, modifiers can be set by
18180 customizing `org-effort-durations' (which see).
18182 Entries containing a colon are interpreted as H:MM by
18183 `org-hh:mm-string-to-minutes'."
18184 (let ((result 0)
18185 (re (concat "\\([0-9.]+\\) *\\("
18186 (regexp-opt (mapcar 'car org-effort-durations))
18187 "\\)")))
18188 (while (string-match re s)
18189 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18190 (string-to-number (match-string 1 s))))
18191 (setq s (replace-match "" nil t s)))
18192 (setq result (floor result))
18193 (incf result (org-hh:mm-string-to-minutes s))
18194 (if output-to-string (number-to-string result) result)))
18196 ;;;; Files
18198 (defun org-save-all-org-buffers ()
18199 "Save all Org-mode buffers without user confirmation."
18200 (interactive)
18201 (message "Saving all Org-mode buffers...")
18202 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18203 (when (featurep 'org-id) (org-id-locations-save))
18204 (message "Saving all Org-mode buffers... done"))
18206 (defun org-revert-all-org-buffers ()
18207 "Revert all Org-mode buffers.
18208 Prompt for confirmation when there are unsaved changes.
18209 Be sure you know what you are doing before letting this function
18210 overwrite your changes.
18212 This function is useful in a setup where one tracks org files
18213 with a version control system, to revert on one machine after pulling
18214 changes from another. I believe the procedure must be like this:
18216 1. M-x org-save-all-org-buffers
18217 2. Pull changes from the other machine, resolve conflicts
18218 3. M-x org-revert-all-org-buffers"
18219 (interactive)
18220 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18221 (user-error "Abort"))
18222 (save-excursion
18223 (save-window-excursion
18224 (mapc
18225 (lambda (b)
18226 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18227 (with-current-buffer b buffer-file-name))
18228 (org-pop-to-buffer-same-window b)
18229 (revert-buffer t 'no-confirm)))
18230 (buffer-list))
18231 (when (and (featurep 'org-id) org-id-track-globally)
18232 (org-id-locations-load)))))
18234 ;;;; Agenda files
18236 ;;;###autoload
18237 (defun org-switchb (&optional arg)
18238 "Switch between Org buffers.
18239 With one prefix argument, restrict available buffers to files.
18240 With two prefix arguments, restrict available buffers to agenda files.
18242 Defaults to `iswitchb' for buffer name completion.
18243 Set `org-completion-use-ido' to make it use ido instead."
18244 (interactive "P")
18245 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18246 ((equal arg '(16)) (org-buffer-list 'agenda))
18247 (t (org-buffer-list))))
18248 (org-completion-use-iswitchb org-completion-use-iswitchb)
18249 (org-completion-use-ido org-completion-use-ido))
18250 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18251 (setq org-completion-use-iswitchb t))
18252 (org-pop-to-buffer-same-window
18253 (org-icompleting-read "Org buffer: "
18254 (mapcar 'list (mapcar 'buffer-name blist))
18255 nil t))))
18257 ;;; Define some older names previously used for this functionality
18258 ;;;###autoload
18259 (defalias 'org-ido-switchb 'org-switchb)
18260 ;;;###autoload
18261 (defalias 'org-iswitchb 'org-switchb)
18263 (defun org-buffer-list (&optional predicate exclude-tmp)
18264 "Return a list of Org buffers.
18265 PREDICATE can be `export', `files' or `agenda'.
18267 export restrict the list to Export buffers.
18268 files restrict the list to buffers visiting Org files.
18269 agenda restrict the list to buffers visiting agenda files.
18271 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18272 (let* ((bfn nil)
18273 (agenda-files (and (eq predicate 'agenda)
18274 (mapcar 'file-truename (org-agenda-files t))))
18275 (filter
18276 (cond
18277 ((eq predicate 'files)
18278 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18279 ((eq predicate 'export)
18280 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18281 ((eq predicate 'agenda)
18282 (lambda (b)
18283 (with-current-buffer b
18284 (and (derived-mode-p 'org-mode)
18285 (setq bfn (buffer-file-name b))
18286 (member (file-truename bfn) agenda-files)))))
18287 (t (lambda (b) (with-current-buffer b
18288 (or (derived-mode-p 'org-mode)
18289 (string-match "\*Org .*Export"
18290 (buffer-name b)))))))))
18291 (delq nil
18292 (mapcar
18293 (lambda(b)
18294 (if (and (funcall filter b)
18295 (or (not exclude-tmp)
18296 (not (string-match "tmp" (buffer-name b)))))
18298 nil))
18299 (buffer-list)))))
18301 (defun org-agenda-files (&optional unrestricted archives)
18302 "Get the list of agenda files.
18303 Optional UNRESTRICTED means return the full list even if a restriction
18304 is currently in place.
18305 When ARCHIVES is t, include all archive files that are really being
18306 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18307 `org-agenda-archives-mode' is t."
18308 (let ((files
18309 (cond
18310 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18311 ((stringp org-agenda-files) (org-read-agenda-file-list))
18312 ((listp org-agenda-files) org-agenda-files)
18313 (t (error "Invalid value of `org-agenda-files'")))))
18314 (setq files (apply 'append
18315 (mapcar (lambda (f)
18316 (if (file-directory-p f)
18317 (directory-files
18318 f t org-agenda-file-regexp)
18319 (list f)))
18320 files)))
18321 (when org-agenda-skip-unavailable-files
18322 (setq files (delq nil
18323 (mapcar (function
18324 (lambda (file)
18325 (and (file-readable-p file) file)))
18326 files))))
18327 (when (or (eq archives t)
18328 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18329 (setq files (org-add-archive-files files)))
18330 files))
18332 (defun org-agenda-file-p (&optional file)
18333 "Return non-nil, if FILE is an agenda file.
18334 If FILE is omitted, use the file associated with the current
18335 buffer."
18336 (let ((fname (or file (buffer-file-name))))
18337 (and fname
18338 (member (file-truename fname)
18339 (mapcar #'file-truename (org-agenda-files t))))))
18341 (defun org-edit-agenda-file-list ()
18342 "Edit the list of agenda files.
18343 Depending on setup, this either uses customize to edit the variable
18344 `org-agenda-files', or it visits the file that is holding the list. In the
18345 latter case, the buffer is set up in a way that saving it automatically kills
18346 the buffer and restores the previous window configuration."
18347 (interactive)
18348 (if (stringp org-agenda-files)
18349 (let ((cw (current-window-configuration)))
18350 (find-file org-agenda-files)
18351 (org-set-local 'org-window-configuration cw)
18352 (org-add-hook 'after-save-hook
18353 (lambda ()
18354 (set-window-configuration
18355 (prog1 org-window-configuration
18356 (kill-buffer (current-buffer))))
18357 (org-install-agenda-files-menu)
18358 (message "New agenda file list installed"))
18359 nil 'local)
18360 (message "%s" (substitute-command-keys
18361 "Edit list and finish with \\[save-buffer]")))
18362 (customize-variable 'org-agenda-files)))
18364 (defun org-store-new-agenda-file-list (list)
18365 "Set new value for the agenda file list and save it correctly."
18366 (if (stringp org-agenda-files)
18367 (let ((fe (org-read-agenda-file-list t)) b u)
18368 (while (setq b (find-buffer-visiting org-agenda-files))
18369 (kill-buffer b))
18370 (with-temp-file org-agenda-files
18371 (insert
18372 (mapconcat
18373 (lambda (f) ;; Keep un-expanded entries.
18374 (if (setq u (assoc f fe))
18375 (cdr u)
18377 list "\n")
18378 "\n")))
18379 (let ((org-mode-hook nil) (org-inhibit-startup t)
18380 (org-insert-mode-line-in-empty-file nil))
18381 (setq org-agenda-files list)
18382 (customize-save-variable 'org-agenda-files org-agenda-files))))
18384 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18385 "Read the list of agenda files from a file.
18386 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18387 filenames, used by `org-store-new-agenda-file-list' to write back
18388 un-expanded file names."
18389 (when (file-directory-p org-agenda-files)
18390 (error "`org-agenda-files' cannot be a single directory"))
18391 (when (stringp org-agenda-files)
18392 (with-temp-buffer
18393 (insert-file-contents org-agenda-files)
18394 (mapcar
18395 (lambda (f)
18396 (let ((e (expand-file-name (substitute-in-file-name f)
18397 org-directory)))
18398 (if pair-with-expansion
18399 (cons e f)
18400 e)))
18401 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18403 ;;;###autoload
18404 (defun org-cycle-agenda-files ()
18405 "Cycle through the files in `org-agenda-files'.
18406 If the current buffer visits an agenda file, find the next one in the list.
18407 If the current buffer does not, find the first agenda file."
18408 (interactive)
18409 (let* ((fs (org-agenda-files t))
18410 (files (append fs (list (car fs))))
18411 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18412 file)
18413 (unless files (user-error "No agenda files"))
18414 (catch 'exit
18415 (while (setq file (pop files))
18416 (if (equal (file-truename file) tcf)
18417 (when (car files)
18418 (find-file (car files))
18419 (throw 'exit t))))
18420 (find-file (car fs)))
18421 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18423 (defun org-agenda-file-to-front (&optional to-end)
18424 "Move/add the current file to the top of the agenda file list.
18425 If the file is not present in the list, it is added to the front. If it is
18426 present, it is moved there. With optional argument TO-END, add/move to the
18427 end of the list."
18428 (interactive "P")
18429 (let ((org-agenda-skip-unavailable-files nil)
18430 (file-alist (mapcar (lambda (x)
18431 (cons (file-truename x) x))
18432 (org-agenda-files t)))
18433 (ctf (file-truename
18434 (or buffer-file-name
18435 (user-error "Please save the current buffer to a file"))))
18436 x had)
18437 (setq x (assoc ctf file-alist) had x)
18439 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18440 (if to-end
18441 (setq file-alist (append (delq x file-alist) (list x)))
18442 (setq file-alist (cons x (delq x file-alist))))
18443 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18444 (org-install-agenda-files-menu)
18445 (message "File %s to %s of agenda file list"
18446 (if had "moved" "added") (if to-end "end" "front"))))
18448 (defun org-remove-file (&optional file)
18449 "Remove current file from the list of files in variable `org-agenda-files'.
18450 These are the files which are being checked for agenda entries.
18451 Optional argument FILE means use this file instead of the current."
18452 (interactive)
18453 (let* ((org-agenda-skip-unavailable-files nil)
18454 (file (or file buffer-file-name
18455 (user-error "Current buffer does not visit a file")))
18456 (true-file (file-truename file))
18457 (afile (abbreviate-file-name file))
18458 (files (delq nil (mapcar
18459 (lambda (x)
18460 (if (equal true-file
18461 (file-truename x))
18462 nil x))
18463 (org-agenda-files t)))))
18464 (if (not (= (length files) (length (org-agenda-files t))))
18465 (progn
18466 (org-store-new-agenda-file-list files)
18467 (org-install-agenda-files-menu)
18468 (message "Removed file: %s" afile))
18469 (message "File was not in list: %s (not removed)" afile))))
18471 (defun org-file-menu-entry (file)
18472 (vector file (list 'find-file file) t))
18474 (defun org-check-agenda-file (file)
18475 "Make sure FILE exists. If not, ask user what to do."
18476 (when (not (file-exists-p file))
18477 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18478 (abbreviate-file-name file))
18479 (let ((r (downcase (read-char-exclusive))))
18480 (cond
18481 ((equal r ?r)
18482 (org-remove-file file)
18483 (throw 'nextfile t))
18484 (t (user-error "Abort"))))))
18486 (defun org-get-agenda-file-buffer (file)
18487 "Get an agenda buffer visiting FILE.
18488 If the buffer needs to be created, add it to the list of buffers
18489 which might be released later."
18490 (let ((buf (org-find-base-buffer-visiting file)))
18491 (if buf
18492 buf ; just return it
18493 ;; Make a new buffer and remember it
18494 (setq buf (find-file-noselect file))
18495 (if buf (push buf org-agenda-new-buffers))
18496 buf)))
18498 (defun org-release-buffers (blist)
18499 "Release all buffers in list, asking the user for confirmation when needed.
18500 When a buffer is unmodified, it is just killed. When modified, it is saved
18501 \(if the user agrees) and then killed."
18502 (let (buf file)
18503 (while (setq buf (pop blist))
18504 (setq file (buffer-file-name buf))
18505 (when (and (buffer-modified-p buf)
18506 file
18507 (y-or-n-p (format "Save file %s? " file)))
18508 (with-current-buffer buf (save-buffer)))
18509 (kill-buffer buf))))
18511 (defun org-agenda-prepare-buffers (files)
18512 "Create buffers for all agenda files, protect archived trees and comments."
18513 (interactive)
18514 (let ((pa '(:org-archived t))
18515 (pc '(:org-comment t))
18516 (pall '(:org-archived t :org-comment t))
18517 (inhibit-read-only t)
18518 (org-inhibit-startup org-agenda-inhibit-startup)
18519 (rea (concat ":" org-archive-tag ":"))
18520 file re pos)
18521 (setq org-tag-alist-for-agenda nil
18522 org-tag-groups-alist-for-agenda nil)
18523 (save-excursion
18524 (save-restriction
18525 (while (setq file (pop files))
18526 (catch 'nextfile
18527 (if (bufferp file)
18528 (set-buffer file)
18529 (org-check-agenda-file file)
18530 (set-buffer (org-get-agenda-file-buffer file)))
18531 (widen)
18532 (org-set-regexps-and-options 'tags-only)
18533 (setq pos (point))
18534 (or (memq 'category org-agenda-ignore-properties)
18535 (org-refresh-category-properties))
18536 (or (memq 'stats org-agenda-ignore-properties)
18537 (org-refresh-stats-properties))
18538 (or (memq 'effort org-agenda-ignore-properties)
18539 (org-refresh-effort-properties))
18540 (or (memq 'appt org-agenda-ignore-properties)
18541 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18542 (setq org-todo-keywords-for-agenda
18543 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18544 (setq org-done-keywords-for-agenda
18545 (append org-done-keywords-for-agenda org-done-keywords))
18546 (setq org-todo-keyword-alist-for-agenda
18547 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18548 (setq org-tag-alist-for-agenda
18549 (org-uniquify
18550 (append org-tag-alist-for-agenda
18551 org-tag-alist
18552 org-tag-persistent-alist)))
18553 (if org-group-tags
18554 (setq org-tag-groups-alist-for-agenda
18555 (org-uniquify-alist
18556 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18557 (org-with-silent-modifications
18558 (save-excursion
18559 (remove-text-properties (point-min) (point-max) pall)
18560 (when org-agenda-skip-archived-trees
18561 (goto-char (point-min))
18562 (while (re-search-forward rea nil t)
18563 (if (org-at-heading-p t)
18564 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18565 (goto-char (point-min))
18566 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18567 (while (re-search-forward re nil t)
18568 (when (save-match-data (org-in-commented-heading-p t))
18569 (add-text-properties
18570 (match-beginning 0) (org-end-of-subtree t) pc)))))
18571 (goto-char pos)))))
18572 (setq org-todo-keywords-for-agenda
18573 (org-uniquify org-todo-keywords-for-agenda))
18574 (setq org-todo-keyword-alist-for-agenda
18575 (org-uniquify org-todo-keyword-alist-for-agenda))))
18578 ;;;; CDLaTeX minor mode
18580 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18581 "Keymap for the minor `org-cdlatex-mode'.")
18583 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18584 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18585 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18586 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18587 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18589 (defvar org-cdlatex-texmathp-advice-is-done nil
18590 "Flag remembering if we have applied the advice to texmathp already.")
18592 (define-minor-mode org-cdlatex-mode
18593 "Toggle the minor `org-cdlatex-mode'.
18594 This mode supports entering LaTeX environment and math in LaTeX fragments
18595 in Org-mode.
18596 \\{org-cdlatex-mode-map}"
18597 nil " OCDL" nil
18598 (when org-cdlatex-mode
18599 (require 'cdlatex)
18600 (run-hooks 'cdlatex-mode-hook)
18601 (cdlatex-compute-tables))
18602 (unless org-cdlatex-texmathp-advice-is-done
18603 (setq org-cdlatex-texmathp-advice-is-done t)
18604 (defadvice texmathp (around org-math-always-on activate)
18605 "Always return t in org-mode buffers.
18606 This is because we want to insert math symbols without dollars even outside
18607 the LaTeX math segments. If Orgmode thinks that point is actually inside
18608 an embedded LaTeX fragment, let texmathp do its job.
18609 \\[org-cdlatex-mode-map]"
18610 (interactive)
18611 (let (p)
18612 (cond
18613 ((not (derived-mode-p 'org-mode)) ad-do-it)
18614 ((eq this-command 'cdlatex-math-symbol)
18615 (setq ad-return-value t
18616 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18618 (let ((p (org-inside-LaTeX-fragment-p)))
18619 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18620 (setq ad-return-value t
18621 texmathp-why '("Org-mode embedded math" . 0))
18622 (if p ad-do-it)))))))))
18624 (defun turn-on-org-cdlatex ()
18625 "Unconditionally turn on `org-cdlatex-mode'."
18626 (org-cdlatex-mode 1))
18628 (defun org-try-cdlatex-tab ()
18629 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18630 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18631 - inside a LaTeX fragment, or
18632 - after the first word in a line, where an abbreviation expansion could
18633 insert a LaTeX environment."
18634 (when org-cdlatex-mode
18635 (cond
18636 ;; Before any word on the line: No expansion possible.
18637 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18638 ;; Just after first word on the line: Expand it. Make sure it
18639 ;; cannot happen on headlines, though.
18640 ((save-excursion
18641 (skip-chars-backward "a-zA-Z0-9*")
18642 (skip-chars-backward " \t")
18643 (and (bolp) (not (org-at-heading-p))))
18644 (cdlatex-tab) t)
18645 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18647 (defun org-cdlatex-underscore-caret (&optional arg)
18648 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18649 Revert to the normal definition outside of these fragments."
18650 (interactive "P")
18651 (if (org-inside-LaTeX-fragment-p)
18652 (call-interactively 'cdlatex-sub-superscript)
18653 (let (org-cdlatex-mode)
18654 (call-interactively (key-binding (vector last-input-event))))))
18656 (defun org-cdlatex-math-modify (&optional arg)
18657 "Execute `cdlatex-math-modify' in LaTeX fragments.
18658 Revert to the normal definition outside of these fragments."
18659 (interactive "P")
18660 (if (org-inside-LaTeX-fragment-p)
18661 (call-interactively 'cdlatex-math-modify)
18662 (let (org-cdlatex-mode)
18663 (call-interactively (key-binding (vector last-input-event))))))
18665 (defun org-cdlatex-environment-indent (&optional environment item)
18666 "Execute `cdlatex-environment' and indent the inserted environment."
18667 (interactive)
18668 (cdlatex-environment environment item)
18669 (let ((element (org-element-at-point)))
18670 (org-indent-region (org-element-property :begin element)
18671 (org-element-property :end element))))
18674 ;;;; LaTeX fragments
18676 (defun org-inside-LaTeX-fragment-p ()
18677 "Test if point is inside a LaTeX fragment.
18678 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18679 sequence appearing also before point.
18680 Even though the matchers for math are configurable, this function assumes
18681 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18682 delimiters are skipped when they have been removed by customization.
18683 The return value is nil, or a cons cell with the delimiter and the
18684 position of this delimiter.
18686 This function does a reasonably good job, but can locally be fooled by
18687 for example currency specifications. For example it will assume being in
18688 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18689 fragments that are properly closed, but during editing, we have to live
18690 with the uncertainty caused by missing closing delimiters. This function
18691 looks only before point, not after."
18692 (catch 'exit
18693 (let ((pos (point))
18694 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18695 (lim (progn
18696 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18697 (point)))
18698 dd-on str (start 0) m re)
18699 (goto-char pos)
18700 (when dodollar
18701 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18702 re (nth 1 (assoc "$" org-latex-regexps)))
18703 (while (string-match re str start)
18704 (cond
18705 ((= (match-end 0) (length str))
18706 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18707 ((= (match-end 0) (- (length str) 5))
18708 (throw 'exit nil))
18709 (t (setq start (match-end 0))))))
18710 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18711 (goto-char pos)
18712 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18713 (and (match-beginning 2) (throw 'exit nil))
18714 ;; count $$
18715 (while (re-search-backward "\\$\\$" lim t)
18716 (setq dd-on (not dd-on)))
18717 (goto-char pos)
18718 (if dd-on (cons "$$" m))))))
18720 (defun org-inside-latex-macro-p ()
18721 "Is point inside a LaTeX macro or its arguments?"
18722 (save-match-data
18723 (org-in-regexp
18724 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18726 (defvar org-latex-fragment-image-overlays nil
18727 "List of overlays carrying the images of latex fragments.")
18728 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18730 (defun org-remove-latex-fragment-image-overlays ()
18731 "Remove all overlays with LaTeX fragment images in current buffer."
18732 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18733 (setq org-latex-fragment-image-overlays nil))
18735 (define-obsolete-function-alias
18736 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18737 (defun org-toggle-latex-fragment (&optional subtree)
18738 "Preview the LaTeX fragment at point, or all locally or globally.
18739 If the cursor is in a LaTeX fragment, create the image and overlay
18740 it over the source code. If there is no fragment at point, display
18741 all fragments in the current text, from one headline to the next. With
18742 prefix SUBTREE, display all fragments in the current subtree. With a
18743 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18744 the cursor is before the first headline,
18745 display all fragments in the buffer.
18746 The images can be removed again with \\[org-toggle-latex-fragment]."
18747 (interactive "P")
18748 (unless (buffer-file-name (buffer-base-buffer))
18749 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18750 (if org-latex-fragment-image-overlays
18751 (progn (org-remove-latex-fragment-image-overlays)
18752 (message "LaTeX fragments images removed"))
18753 (when (display-graphic-p)
18754 (org-remove-latex-fragment-image-overlays)
18755 (org-with-wide-buffer
18756 (let (beg end msg)
18757 (cond
18758 ((equal subtree '(16))
18759 (setq beg (point-min) end (point-max)
18760 msg "Creating images for buffer...%s"))
18761 ((equal subtree '(4))
18762 (org-back-to-heading)
18763 (setq beg (point) end (org-end-of-subtree t)
18764 msg "Creating images for subtree...%s"))
18765 ((let ((context (org-element-context)))
18766 (when (memq (org-element-type context)
18767 '(latex-environment latex-fragment))
18768 (setq beg (org-element-property :begin context)
18769 end (org-element-property :end context)
18770 msg "Creating image...%s"))))
18771 ((org-before-first-heading-p)
18772 (setq beg (point-min) end (point-max)
18773 msg "Creating images for buffer...%s"))
18775 (org-back-to-heading)
18776 (setq beg (point) end (progn (outline-next-heading) (point))
18777 msg "Creating images for entry...%s")))
18778 (message msg "")
18779 (narrow-to-region beg end)
18780 (goto-char beg)
18781 (org-format-latex
18782 (concat org-latex-preview-ltxpng-directory
18783 (file-name-sans-extension
18784 (file-name-nondirectory
18785 (buffer-file-name (buffer-base-buffer)))))
18786 default-directory 'overlays msg 'forbuffer
18787 org-latex-create-formula-image-program)
18788 (message msg "done. Use `C-c C-x C-l' to remove images."))))))
18790 (defun org-format-latex
18791 (prefix &optional dir overlays msg forbuffer processing-type)
18792 "Replace LaTeX fragments with links to an image, and produce images.
18793 Some of the options can be changed using the variable
18794 `org-format-latex-options'."
18795 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18796 (unless (eq processing-type 'verbatim)
18797 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
18798 (cnt 0)
18799 checkdir-flag)
18800 (goto-char (point-min))
18801 (while (re-search-forward math-regexp nil t)
18802 (unless (and overlays
18803 (eq (get-char-property (point) 'org-overlay-type)
18804 'org-latex-overlay))
18805 (let* ((context (org-element-context))
18806 (type (org-element-type context)))
18807 (when (memq type '(latex-environment latex-fragment))
18808 (let ((block-type (eq type 'latex-environment))
18809 (value (org-element-property :value context))
18810 (beg (org-element-property :begin context))
18811 (end (save-excursion
18812 (goto-char (org-element-property :end context))
18813 (skip-chars-backward " \r\t\n")
18814 (point))))
18815 (case processing-type
18816 (mathjax
18817 ;; Prepare for MathJax processing.
18818 (if (eq (char-after beg) ?$)
18819 (save-excursion
18820 (delete-region beg end)
18821 (insert "\\(" (substring value 1 -1) "\\)"))
18822 (goto-char end)))
18823 ((dvipng imagemagick)
18824 ;; Process to an image.
18825 (incf cnt)
18826 (goto-char beg)
18827 (let* ((face (face-at-point))
18828 ;; Get the colors from the face at point.
18830 (let ((color (plist-get org-format-latex-options
18831 :foreground)))
18832 (if (and forbuffer (eq color 'auto))
18833 (face-attribute face :foreground nil 'default)
18834 color)))
18836 (let ((color (plist-get org-format-latex-options
18837 :background)))
18838 (if (and forbuffer (eq color 'auto))
18839 (face-attribute face :background nil 'default)
18840 color)))
18841 (hash (sha1 (prin1-to-string
18842 (list org-format-latex-header
18843 org-latex-default-packages-alist
18844 org-latex-packages-alist
18845 org-format-latex-options
18846 forbuffer value fg bg))))
18847 (absprefix (expand-file-name prefix dir))
18848 (linkfile (format "%s_%s.png" prefix hash))
18849 (movefile (format "%s_%s.png" absprefix hash))
18850 (sep (and block-type "\n\n"))
18851 (link (concat sep "[[file:" linkfile "]]" sep))
18852 (options
18853 (org-combine-plists
18854 org-format-latex-options
18855 `(:foreground ,fg :background ,bg))))
18856 (when msg (message msg cnt))
18857 (unless checkdir-flag ; Ensure the directory exists.
18858 (setq checkdir-flag t)
18859 (let ((todir (file-name-directory absprefix)))
18860 (unless (file-directory-p todir)
18861 (make-directory todir t))))
18862 (unless (file-exists-p movefile)
18863 (org-create-formula-image
18864 value movefile options forbuffer processing-type))
18865 (if overlays
18866 (progn
18867 (dolist (o (overlays-in beg end))
18868 (when (eq (overlay-get o 'org-overlay-type)
18869 'org-latex-overlay)
18870 (delete-overlay o)))
18871 (let ((ov (make-overlay beg end)))
18872 (overlay-put ov
18873 'org-overlay-type
18874 'org-latex-overlay)
18875 (if (featurep 'xemacs)
18876 (progn
18877 (overlay-put ov 'invisible t)
18878 (overlay-put
18879 ov 'end-glyph
18880 (make-glyph
18881 (vector 'png :file movefile))))
18882 (overlay-put
18883 ov 'display
18884 (list 'image
18885 :type 'png
18886 :file movefile
18887 :ascent 'center)))
18888 (push ov org-latex-fragment-image-overlays))
18889 (goto-char end))
18890 (delete-region beg end)
18891 (insert
18892 (org-add-props link
18893 (list 'org-latex-src
18894 (replace-regexp-in-string "\"" "" value)
18895 'org-latex-src-embed-type
18896 (if block-type 'paragraph 'character)))))))
18897 (mathml
18898 ;; Process to MathML.
18899 (unless (org-format-latex-mathml-available-p)
18900 (user-error "LaTeX to MathML converter not configured"))
18901 (incf cnt)
18902 (when msg (message msg cnt))
18903 (goto-char beg)
18904 (delete-region beg end)
18905 (insert (org-format-latex-as-mathml
18906 value block-type prefix dir)))
18907 (otherwise
18908 (error "Unknown conversion type %s for LaTeX fragments"
18909 processing-type)))))))))))
18911 (defun org-create-math-formula (latex-frag &optional mathml-file)
18912 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18913 Use `org-latex-to-mathml-convert-command'. If the conversion is
18914 sucessful, return the portion between \"<math...> </math>\"
18915 elements otherwise return nil. When MATHML-FILE is specified,
18916 write the results in to that file. When invoked as an
18917 interactive command, prompt for LATEX-FRAG, with initial value
18918 set to the current active region and echo the results for user
18919 inspection."
18920 (interactive (list (let ((frag (when (org-region-active-p)
18921 (buffer-substring-no-properties
18922 (region-beginning) (region-end)))))
18923 (read-string "LaTeX Fragment: " frag nil frag))))
18924 (unless latex-frag (user-error "Invalid LaTeX fragment"))
18925 (let* ((tmp-in-file (file-relative-name
18926 (make-temp-name (expand-file-name "ltxmathml-in"))))
18927 (ignore (write-region latex-frag nil tmp-in-file))
18928 (tmp-out-file (file-relative-name
18929 (make-temp-name (expand-file-name "ltxmathml-out"))))
18930 (cmd (format-spec
18931 org-latex-to-mathml-convert-command
18932 `((?j . ,(shell-quote-argument
18933 (expand-file-name org-latex-to-mathml-jar-file)))
18934 (?I . ,(shell-quote-argument tmp-in-file))
18935 (?o . ,(shell-quote-argument tmp-out-file)))))
18936 mathml shell-command-output)
18937 (when (org-called-interactively-p 'any)
18938 (unless (org-format-latex-mathml-available-p)
18939 (user-error "LaTeX to MathML converter not configured")))
18940 (message "Running %s" cmd)
18941 (setq shell-command-output (shell-command-to-string cmd))
18942 (setq mathml
18943 (when (file-readable-p tmp-out-file)
18944 (with-current-buffer (find-file-noselect tmp-out-file t)
18945 (goto-char (point-min))
18946 (when (re-search-forward
18947 (concat
18948 (regexp-quote
18949 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18950 "\\(.\\|\n\\)*"
18951 (regexp-quote "</math>")) nil t)
18952 (prog1 (match-string 0) (kill-buffer))))))
18953 (cond
18954 (mathml
18955 (setq mathml
18956 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18957 (when mathml-file
18958 (write-region mathml nil mathml-file))
18959 (when (org-called-interactively-p 'any)
18960 (message mathml)))
18961 ((message "LaTeX to MathML conversion failed")
18962 (message shell-command-output)))
18963 (delete-file tmp-in-file)
18964 (when (file-exists-p tmp-out-file)
18965 (delete-file tmp-out-file))
18966 mathml))
18968 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18969 prefix &optional dir)
18970 "Use `org-create-math-formula' but check local cache first."
18971 (let* ((absprefix (expand-file-name prefix dir))
18972 (print-length nil) (print-level nil)
18973 (formula-id (concat
18974 "formula-"
18975 (sha1
18976 (prin1-to-string
18977 (list latex-frag
18978 org-latex-to-mathml-convert-command)))))
18979 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18980 (formula-cache-dir (file-name-directory formula-cache)))
18982 (unless (file-directory-p formula-cache-dir)
18983 (make-directory formula-cache-dir t))
18985 (unless (file-exists-p formula-cache)
18986 (org-create-math-formula latex-frag formula-cache))
18988 (if (file-exists-p formula-cache)
18989 ;; Successful conversion. Return the link to MathML file.
18990 (org-add-props
18991 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18992 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18993 'org-latex-src-embed-type (if latex-frag-type
18994 'paragraph 'character)))
18995 ;; Failed conversion. Return the LaTeX fragment verbatim
18996 latex-frag)))
18998 (defun org-create-formula-image (string tofile options buffer &optional type)
18999 "Create an image from LaTeX source using dvipng or convert.
19000 This function calls either `org-create-formula-image-with-dvipng'
19001 or `org-create-formula-image-with-imagemagick' depending on the
19002 value of `org-latex-create-formula-image-program' or on the value
19003 of the optional TYPE variable.
19005 Note: ultimately these two function should be combined as they
19006 share a good deal of logic."
19007 (org-check-external-command
19008 "latex" "needed to convert LaTeX fragments to images")
19009 (funcall
19010 (case (or type org-latex-create-formula-image-program)
19011 ('dvipng
19012 (org-check-external-command
19013 "dvipng" "needed to convert LaTeX fragments to images")
19014 'org-create-formula-image-with-dvipng)
19015 ('imagemagick
19016 (org-check-external-command
19017 "convert" "you need to install imagemagick")
19018 'org-create-formula-image-with-imagemagick)
19019 (t (error
19020 "Invalid value of `org-latex-create-formula-image-program'")))
19021 string tofile options buffer))
19023 (declare-function org-export-get-backend "ox" (name))
19024 (declare-function org-export--get-global-options "ox" (&optional backend))
19025 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19026 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19027 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19028 (defun org-create-formula--latex-header ()
19029 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19030 (let ((info (org-combine-plists (org-export--get-global-options
19031 (org-export-get-backend 'latex))
19032 (org-export--get-inbuffer-options
19033 (org-export-get-backend 'latex)))))
19034 (org-latex-guess-babel-language
19035 (org-latex-guess-inputenc
19036 (org-splice-latex-header
19037 org-format-latex-header
19038 org-latex-default-packages-alist
19039 org-latex-packages-alist t
19040 (plist-get info :latex-header)))
19041 info)))
19043 ;; This function borrows from Ganesh Swami's latex2png.el
19044 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19045 "This calls dvipng."
19046 (require 'ox-latex)
19047 (let* ((tmpdir (if (featurep 'xemacs)
19048 (temp-directory)
19049 temporary-file-directory))
19050 (texfilebase (make-temp-name
19051 (expand-file-name "orgtex" tmpdir)))
19052 (texfile (concat texfilebase ".tex"))
19053 (dvifile (concat texfilebase ".dvi"))
19054 (pngfile (concat texfilebase ".png"))
19055 (fnh (if (featurep 'xemacs)
19056 (font-height (face-font 'default))
19057 (face-attribute 'default :height nil)))
19058 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19059 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
19060 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19061 "Black"))
19062 (bg (or (plist-get options (if buffer :background :html-background))
19063 "Transparent")))
19064 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19065 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19066 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19067 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19068 (let ((latex-header (org-create-formula--latex-header)))
19069 (with-temp-file texfile
19070 (insert latex-header)
19071 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19072 (let ((dir default-directory))
19073 (ignore-errors
19074 (cd tmpdir)
19075 (call-process "latex" nil nil nil texfile))
19076 (cd dir))
19077 (if (not (file-exists-p dvifile))
19078 (progn (message "Failed to create dvi file from %s" texfile) nil)
19079 (ignore-errors
19080 (if (featurep 'xemacs)
19081 (call-process "dvipng" nil nil nil
19082 "-fg" fg "-bg" bg
19083 "-T" "tight"
19084 "-o" pngfile
19085 dvifile)
19086 (call-process "dvipng" nil nil nil
19087 "-fg" fg "-bg" bg
19088 "-D" dpi
19089 ;;"-x" scale "-y" scale
19090 "-T" "tight"
19091 "-o" pngfile
19092 dvifile)))
19093 (if (not (file-exists-p pngfile))
19094 (if org-format-latex-signal-error
19095 (error "Failed to create png file from %s" texfile)
19096 (message "Failed to create png file from %s" texfile)
19097 nil)
19098 ;; Use the requested file name and clean up
19099 (copy-file pngfile tofile 'replace)
19100 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19101 (if (file-exists-p (concat texfilebase e))
19102 (delete-file (concat texfilebase e))))
19103 pngfile))))
19105 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19106 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19107 "This calls convert, which is included into imagemagick."
19108 (require 'ox-latex)
19109 (let* ((tmpdir (if (featurep 'xemacs)
19110 (temp-directory)
19111 temporary-file-directory))
19112 (texfilebase (make-temp-name
19113 (expand-file-name "orgtex" tmpdir)))
19114 (texfile (concat texfilebase ".tex"))
19115 (pdffile (concat texfilebase ".pdf"))
19116 (pngfile (concat texfilebase ".png"))
19117 (fnh (if (featurep 'xemacs)
19118 (font-height (face-font 'default))
19119 (face-attribute 'default :height nil)))
19120 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19121 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
19122 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19123 "black"))
19124 (bg (or (plist-get options (if buffer :background :html-background))
19125 "white")))
19126 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19127 (setq fg (org-latex-color-format fg)))
19128 (if (eq bg 'default) (setq bg (org-latex-color :background))
19129 (setq bg (org-latex-color-format
19130 (if (string= bg "Transparent") "white" bg))))
19131 (let ((latex-header (org-create-formula--latex-header)))
19132 (with-temp-file texfile
19133 (insert latex-header)
19134 (insert "\n\\begin{document}\n"
19135 "\\definecolor{fg}{rgb}{" fg "}\n"
19136 "\\definecolor{bg}{rgb}{" bg "}\n"
19137 "\n\\pagecolor{bg}\n"
19138 "\n{\\color{fg}\n"
19139 string
19140 "\n}\n"
19141 "\n\\end{document}\n")))
19142 (org-latex-compile texfile t)
19143 (if (not (file-exists-p pdffile))
19144 (progn (message "Failed to create pdf file from %s" texfile) nil)
19145 (ignore-errors
19146 (if (featurep 'xemacs)
19147 (call-process "convert" nil nil nil
19148 "-density" "96"
19149 "-trim"
19150 "-antialias"
19151 pdffile
19152 "-quality" "100"
19153 ;; "-sharpen" "0x1.0"
19154 pngfile)
19155 (call-process "convert" nil nil nil
19156 "-density" dpi
19157 "-trim"
19158 "-antialias"
19159 pdffile
19160 "-quality" "100"
19161 ;; "-sharpen" "0x1.0"
19162 pngfile)))
19163 (if (not (file-exists-p pngfile))
19164 (if org-format-latex-signal-error
19165 (error "Failed to create png file from %s" texfile)
19166 (message "Failed to create png file from %s" texfile)
19167 nil)
19168 ;; Use the requested file name and clean up
19169 (copy-file pngfile tofile 'replace)
19170 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19171 (if (file-exists-p (concat texfilebase e))
19172 (delete-file (concat texfilebase e))))
19173 pngfile))))
19175 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19176 "Fill a LaTeX header template TPL.
19177 In the template, the following place holders will be recognized:
19179 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19180 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19181 [PACKAGES] \\usepackage statements for PKG
19182 [NO-PACKAGES] do not include PKG
19183 [EXTRA] the string EXTRA
19184 [NO-EXTRA] do not include EXTRA
19186 For backward compatibility, if both the positive and the negative place
19187 holder is missing, the positive one (without the \"NO-\") will be
19188 assumed to be present at the end of the template.
19189 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19190 EXTRA is a string.
19191 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19192 (let (rpl (end ""))
19193 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19194 (setq rpl (if (or (match-end 1) (not def-pkg))
19195 "" (org-latex-packages-to-string def-pkg snippets-p t))
19196 tpl (replace-match rpl t t tpl))
19197 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19199 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19200 (setq rpl (if (or (match-end 1) (not pkg))
19201 "" (org-latex-packages-to-string pkg snippets-p t))
19202 tpl (replace-match rpl t t tpl))
19203 (if pkg (setq end
19204 (concat end "\n"
19205 (org-latex-packages-to-string pkg snippets-p)))))
19207 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19208 (setq rpl (if (or (match-end 1) (not extra))
19209 "" (concat extra "\n"))
19210 tpl (replace-match rpl t t tpl))
19211 (if (and extra (string-match "\\S-" extra))
19212 (setq end (concat end "\n" extra))))
19214 (if (string-match "\\S-" end)
19215 (concat tpl "\n" end)
19216 tpl)))
19218 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19219 "Turn an alist of packages into a string with the \\usepackage macros."
19220 (setq pkg (mapconcat (lambda(p)
19221 (cond
19222 ((stringp p) p)
19223 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19224 (format "%% Package %s omitted" (cadr p)))
19225 ((equal "" (car p))
19226 (format "\\usepackage{%s}" (cadr p)))
19228 (format "\\usepackage[%s]{%s}"
19229 (car p) (cadr p)))))
19231 "\n"))
19232 (if newline (concat pkg "\n") pkg))
19234 (defun org-dvipng-color (attr)
19235 "Return a RGB color specification for dvipng."
19236 (apply 'format "rgb %s %s %s"
19237 (mapcar 'org-normalize-color
19238 (if (featurep 'xemacs)
19239 (color-rgb-components
19240 (face-property 'default
19241 (cond ((eq attr :foreground) 'foreground)
19242 ((eq attr :background) 'background))))
19243 (color-values (face-attribute 'default attr nil))))))
19245 (defun org-dvipng-color-format (color-name)
19246 "Convert COLOR-NAME to a RGB color value for dvipng."
19247 (apply 'format "rgb %s %s %s"
19248 (mapcar 'org-normalize-color
19249 (color-values color-name))))
19251 (defun org-latex-color (attr)
19252 "Return a RGB color for the LaTeX color package."
19253 (apply 'format "%s,%s,%s"
19254 (mapcar 'org-normalize-color
19255 (if (featurep 'xemacs)
19256 (color-rgb-components
19257 (face-property 'default
19258 (cond ((eq attr :foreground) 'foreground)
19259 ((eq attr :background) 'background))))
19260 (color-values (face-attribute 'default attr nil))))))
19262 (defun org-latex-color-format (color-name)
19263 "Convert COLOR-NAME to a RGB color value."
19264 (apply 'format "%s,%s,%s"
19265 (mapcar 'org-normalize-color
19266 (color-values color-name))))
19268 (defun org-normalize-color (value)
19269 "Return string to be used as color value for an RGB component."
19270 (format "%g" (/ value 65535.0)))
19274 ;; Image display
19276 (defvar org-inline-image-overlays nil)
19277 (make-variable-buffer-local 'org-inline-image-overlays)
19279 (defun org-toggle-inline-images (&optional include-linked)
19280 "Toggle the display of inline images.
19281 INCLUDE-LINKED is passed to `org-display-inline-images'."
19282 (interactive "P")
19283 (if org-inline-image-overlays
19284 (progn
19285 (org-remove-inline-images)
19286 (message "Inline image display turned off"))
19287 (org-display-inline-images include-linked)
19288 (if (and (org-called-interactively-p)
19289 org-inline-image-overlays)
19290 (message "%d images displayed inline"
19291 (length org-inline-image-overlays))
19292 (message "No images to display inline"))))
19294 (defun org-redisplay-inline-images ()
19295 "Refresh the display of inline images."
19296 (interactive)
19297 (if (not org-inline-image-overlays)
19298 (org-toggle-inline-images)
19299 (org-toggle-inline-images)
19300 (org-toggle-inline-images)))
19302 (defun org-display-inline-images (&optional include-linked refresh beg end)
19303 "Display inline images.
19305 An inline image is a link which follows either of these
19306 conventions:
19308 1. Its path is a file with an extension matching return value
19309 from `image-file-name-regexp' and it has no contents.
19311 2. Its description consists in a single link of the previous
19312 type.
19314 When optional argument INCLUDE-LINKED is non-nil, also links with
19315 a text description part will be inlined. This can be nice for
19316 a quick look at those images, but it does not reflect what
19317 exported files will look like.
19319 When optional argument REFRESH is non-nil, refresh existing
19320 images between BEG and END. This will create new image displays
19321 only if necessary. BEG and END default to the buffer
19322 boundaries."
19323 (interactive "P")
19324 (when (display-graphic-p)
19325 (unless refresh
19326 (org-remove-inline-images)
19327 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19328 (org-with-wide-buffer
19329 (goto-char (or beg (point-min)))
19330 (let ((case-fold-search t)
19331 (file-extension-re (org-image-file-name-regexp)))
19332 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19333 (let ((link (save-match-data (org-element-context))))
19334 ;; Check if we're at an inline image.
19335 (when (and (equal (org-element-property :type link) "file")
19336 (or include-linked
19337 (not (org-element-property :contents-begin link)))
19338 (let ((parent (org-element-property :parent link)))
19339 (or (not (eq (org-element-type parent) 'link))
19340 (not (cdr (org-element-contents parent)))))
19341 (org-string-match-p file-extension-re
19342 (org-element-property :path link)))
19343 (let ((file (expand-file-name (org-element-property :path link))))
19344 (when (file-exists-p file)
19345 (let ((width
19346 ;; Apply `org-image-actual-width' specifications.
19347 (cond
19348 ((not (image-type-available-p 'imagemagick)) nil)
19349 ((eq org-image-actual-width t) nil)
19350 ((listp org-image-actual-width)
19352 ;; First try to find a width among
19353 ;; attributes associated to the paragraph
19354 ;; containing link.
19355 (let ((paragraph
19356 (let ((e link))
19357 (while (and (setq e (org-element-property
19358 :parent e))
19359 (not (eq (org-element-type e)
19360 'paragraph))))
19361 e)))
19362 (when paragraph
19363 (save-excursion
19364 (goto-char (org-element-property :begin paragraph))
19365 (when
19366 (re-search-forward
19367 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19368 (org-element-property
19369 :post-affiliated paragraph)
19371 (string-to-number (match-string 1))))))
19372 ;; Otherwise, fall-back to provided number.
19373 (car org-image-actual-width)))
19374 ((numberp org-image-actual-width)
19375 org-image-actual-width)))
19376 (old (get-char-property-and-overlay
19377 (org-element-property :begin link)
19378 'org-image-overlay)))
19379 (if (and (car-safe old) refresh)
19380 (image-refresh (overlay-get (cdr old) 'display))
19381 (let ((image (create-image file
19382 (and width 'imagemagick)
19384 :width width)))
19385 (when image
19386 (let* ((link
19387 ;; If inline image is the description
19388 ;; of another link, be sure to
19389 ;; consider the latter as the one to
19390 ;; apply the overlay on.
19391 (let ((parent
19392 (org-element-property :parent link)))
19393 (if (eq (org-element-type parent) 'link)
19394 parent
19395 link)))
19396 (ov (make-overlay
19397 (org-element-property :begin link)
19398 (progn
19399 (goto-char
19400 (org-element-property :end link))
19401 (skip-chars-backward " \t")
19402 (point)))))
19403 (overlay-put ov 'display image)
19404 (overlay-put ov 'face 'default)
19405 (overlay-put ov 'org-image-overlay t)
19406 (overlay-put
19407 ov 'modification-hooks
19408 (list 'org-display-inline-remove-overlay))
19409 (push ov org-inline-image-overlays)))))))))))))))
19411 (define-obsolete-function-alias
19412 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19414 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19415 "Remove inline-display overlay if a corresponding region is modified."
19416 (let ((inhibit-modification-hooks t))
19417 (when (and ov after)
19418 (delete ov org-inline-image-overlays)
19419 (delete-overlay ov))))
19421 (defun org-remove-inline-images ()
19422 "Remove inline display of images."
19423 (interactive)
19424 (mapc 'delete-overlay org-inline-image-overlays)
19425 (setq org-inline-image-overlays nil))
19427 ;;;; Key bindings
19429 ;; Outline functions from `outline-mode-prefix-map'
19430 ;; that can be remapped in Org:
19431 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19432 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19433 (define-key org-mode-map [remap outline-forward-same-level]
19434 'org-forward-heading-same-level)
19435 (define-key org-mode-map [remap outline-backward-same-level]
19436 'org-backward-heading-same-level)
19437 (define-key org-mode-map [remap show-branches]
19438 'org-kill-note-or-show-branches)
19439 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19440 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19441 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19443 ;; Outline functions from `outline-mode-prefix-map' that can not
19444 ;; be remapped in Org:
19446 ;; - the column "key binding" shows whether the Outline function is still
19447 ;; available in Org mode on the same key that it has been bound to in
19448 ;; Outline mode:
19449 ;; - "overridden": key used for a different functionality in Org mode
19450 ;; - else: key still bound to the same Outline function in Org mode
19452 ;; | Outline function | key binding | Org replacement |
19453 ;; |------------------------------------+-------------+-----------------------|
19454 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
19455 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
19456 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19457 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19458 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19459 ;; | `show-entry' | overridden | no replacement |
19460 ;; | `show-children' | `C-c C-i' | visibility cycling |
19461 ;; | `show-branches' | `C-c C-k' | still same function |
19462 ;; | `show-subtree' | overridden | visibility cycling |
19463 ;; | `show-all' | overridden | no replacement |
19464 ;; | `hide-subtree' | overridden | visibility cycling |
19465 ;; | `hide-body' | overridden | no replacement |
19466 ;; | `hide-entry' | overridden | visibility cycling |
19467 ;; | `hide-leaves' | overridden | no replacement |
19468 ;; | `hide-sublevels' | overridden | no replacement |
19469 ;; | `hide-other' | overridden | no replacement |
19471 ;; Make `C-c C-x' a prefix key
19472 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19474 ;; TAB key with modifiers
19475 (org-defkey org-mode-map "\C-i" 'org-cycle)
19476 (org-defkey org-mode-map [(tab)] 'org-cycle)
19477 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19478 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19479 ;; The following line is necessary under Suse GNU/Linux
19480 (unless (featurep 'xemacs)
19481 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19482 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19483 (define-key org-mode-map [backtab] 'org-shifttab)
19485 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19486 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19487 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19489 ;; Cursor keys with modifiers
19490 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19491 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19492 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19493 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19495 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19496 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19497 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19498 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19499 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19500 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19502 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19503 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19504 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19505 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19507 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19508 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19509 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19510 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19512 ;; Babel keys
19513 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19514 (mapc (lambda (pair)
19515 (define-key org-babel-map (car pair) (cdr pair)))
19516 org-babel-key-bindings)
19518 ;;; Extra keys for tty access.
19519 ;; We only set them when really needed because otherwise the
19520 ;; menus don't show the simple keys
19522 (when (or org-use-extra-keys
19523 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19524 (not window-system))
19525 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19526 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19527 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19528 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19529 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19530 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19531 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19532 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19533 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19534 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19535 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19536 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19537 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19538 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19539 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19540 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19541 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19542 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19543 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19544 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19545 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19546 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19547 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19548 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19549 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19550 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19551 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19552 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19554 ;; All the other keys
19556 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19557 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19558 (if (boundp 'narrow-map)
19559 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19560 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19561 (if (boundp 'narrow-map)
19562 (org-defkey narrow-map "b" 'org-narrow-to-block)
19563 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19564 (if (boundp 'narrow-map)
19565 (org-defkey narrow-map "e" 'org-narrow-to-element)
19566 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19567 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19568 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19569 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19570 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19571 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19572 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19573 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19574 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19575 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19576 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19577 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19578 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19579 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19580 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19581 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19582 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19583 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19584 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19585 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19586 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19587 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19588 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19589 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19590 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19591 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19592 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19593 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19594 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19595 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19596 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19597 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19598 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19599 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19600 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19601 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19602 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19603 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19604 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19605 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19606 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19607 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19608 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19609 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19610 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19611 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19612 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19613 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19614 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19615 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19616 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19617 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19618 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19619 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19620 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19621 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19622 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19623 (org-defkey org-mode-map "\C-c^" 'org-sort)
19624 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19625 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19626 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19627 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19628 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19629 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19630 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19631 (org-defkey org-mode-map "\C-m" 'org-return)
19632 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19633 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19634 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19635 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19636 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19637 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19638 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19639 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19640 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19641 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19642 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19643 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19644 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19645 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19646 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19647 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19648 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19649 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19650 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19651 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19652 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19653 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19654 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19655 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19656 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19658 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19659 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19660 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19662 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19663 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19664 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19665 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19666 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19667 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19668 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19669 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19670 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19671 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19672 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19673 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19674 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19675 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19676 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19677 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19678 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19679 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19680 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19681 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19682 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19683 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19684 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19686 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19687 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19688 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19689 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19690 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19692 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19694 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19696 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19697 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19699 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19702 (when (featurep 'xemacs)
19703 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19706 (defconst org-speed-commands-default
19708 ("Outline Navigation")
19709 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19710 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19711 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19712 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19713 ("F" . org-next-block)
19714 ("B" . org-previous-block)
19715 ("u" . (org-speed-move-safe 'outline-up-heading))
19716 ("j" . org-goto)
19717 ("g" . (org-refile t))
19718 ("Outline Visibility")
19719 ("c" . org-cycle)
19720 ("C" . org-shifttab)
19721 (" " . org-display-outline-path)
19722 ("s" . org-narrow-to-subtree)
19723 ("=" . org-columns)
19724 ("Outline Structure Editing")
19725 ("U" . org-metaup)
19726 ("D" . org-metadown)
19727 ("r" . org-metaright)
19728 ("l" . org-metaleft)
19729 ("R" . org-shiftmetaright)
19730 ("L" . org-shiftmetaleft)
19731 ("i" . (progn (forward-char 1) (call-interactively
19732 'org-insert-heading-respect-content)))
19733 ("^" . org-sort)
19734 ("w" . org-refile)
19735 ("a" . org-archive-subtree-default-with-confirmation)
19736 ("@" . org-mark-subtree)
19737 ("#" . org-toggle-comment)
19738 ("Clock Commands")
19739 ("I" . org-clock-in)
19740 ("O" . org-clock-out)
19741 ("Meta Data Editing")
19742 ("t" . org-todo)
19743 ("," . (org-priority))
19744 ("0" . (org-priority ?\ ))
19745 ("1" . (org-priority ?A))
19746 ("2" . (org-priority ?B))
19747 ("3" . (org-priority ?C))
19748 (":" . org-set-tags-command)
19749 ("e" . org-set-effort)
19750 ("E" . org-inc-effort)
19751 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19752 (org-entry-put (point) "APPT_WARNTIME" m)))
19753 ("Agenda Views etc")
19754 ("v" . org-agenda)
19755 ("/" . org-sparse-tree)
19756 ("Misc")
19757 ("o" . org-open-at-point)
19758 ("?" . org-speed-command-help)
19759 ("<" . (org-agenda-set-restriction-lock 'subtree))
19760 (">" . (org-agenda-remove-restriction-lock))
19762 "The default speed commands.")
19764 (defun org-print-speed-command (e)
19765 (if (> (length (car e)) 1)
19766 (progn
19767 (princ "\n")
19768 (princ (car e))
19769 (princ "\n")
19770 (princ (make-string (length (car e)) ?-))
19771 (princ "\n"))
19772 (princ (car e))
19773 (princ " ")
19774 (if (symbolp (cdr e))
19775 (princ (symbol-name (cdr e)))
19776 (prin1 (cdr e)))
19777 (princ "\n")))
19779 (defun org-speed-command-help ()
19780 "Show the available speed commands."
19781 (interactive)
19782 (if (not org-use-speed-commands)
19783 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19784 (with-output-to-temp-buffer "*Help*"
19785 (princ "User-defined Speed commands\n===========================\n")
19786 (mapc 'org-print-speed-command org-speed-commands-user)
19787 (princ "\n")
19788 (princ "Built-in Speed commands\n=======================\n")
19789 (mapc 'org-print-speed-command org-speed-commands-default))
19790 (with-current-buffer "*Help*"
19791 (setq truncate-lines t))))
19793 (defun org-speed-move-safe (cmd)
19794 "Execute CMD, but make sure that the cursor always ends up in a headline.
19795 If not, return to the original position and throw an error."
19796 (interactive)
19797 (let ((pos (point)))
19798 (call-interactively cmd)
19799 (unless (and (bolp) (org-at-heading-p))
19800 (goto-char pos)
19801 (error "Boundary reached while executing %s" cmd))))
19803 (defvar org-self-insert-command-undo-counter 0)
19805 (defvar org-table-auto-blank-field) ; defined in org-table.el
19806 (defvar org-speed-command nil)
19808 (define-obsolete-function-alias
19809 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19811 (defun org-speed-command-activate (keys)
19812 "Hook for activating single-letter speed commands.
19813 `org-speed-commands-default' specifies a minimal command set.
19814 Use `org-speed-commands-user' for further customization."
19815 (when (or (and (bolp) (looking-at org-outline-regexp))
19816 (and (functionp org-use-speed-commands)
19817 (funcall org-use-speed-commands)))
19818 (cdr (assoc keys (append org-speed-commands-user
19819 org-speed-commands-default)))))
19821 (define-obsolete-function-alias
19822 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19824 (defun org-babel-speed-command-activate (keys)
19825 "Hook for activating single-letter code block commands."
19826 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19827 (cdr (assoc keys org-babel-key-bindings))))
19829 (defcustom org-speed-command-hook
19830 '(org-speed-command-default-hook org-babel-speed-command-hook)
19831 "Hook for activating speed commands at strategic locations.
19832 Hook functions are called in sequence until a valid handler is
19833 found.
19835 Each hook takes a single argument, a user-pressed command key
19836 which is also a `self-insert-command' from the global map.
19838 Within the hook, examine the cursor position and the command key
19839 and return nil or a valid handler as appropriate. Handler could
19840 be one of an interactive command, a function, or a form.
19842 Set `org-use-speed-commands' to non-nil value to enable this
19843 hook. The default setting is `org-speed-command-activate'."
19844 :group 'org-structure
19845 :version "24.1"
19846 :type 'hook)
19848 (defun org-self-insert-command (N)
19849 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19850 If the cursor is in a table looking at whitespace, the whitespace is
19851 overwritten, and the table is not marked as requiring realignment."
19852 (interactive "p")
19853 (org-check-before-invisible-edit 'insert)
19854 (cond
19855 ((and org-use-speed-commands
19856 (let ((kv (this-command-keys-vector)))
19857 (setq org-speed-command
19858 (run-hook-with-args-until-success
19859 'org-speed-command-hook
19860 (make-string 1 (aref kv (1- (length kv))))))))
19861 (cond
19862 ((commandp org-speed-command)
19863 (setq this-command org-speed-command)
19864 (call-interactively org-speed-command))
19865 ((functionp org-speed-command)
19866 (funcall org-speed-command))
19867 ((and org-speed-command (listp org-speed-command))
19868 (eval org-speed-command))
19869 (t (let (org-use-speed-commands)
19870 (call-interactively 'org-self-insert-command)))))
19871 ((and
19872 (org-table-p)
19873 (progn
19874 ;; check if we blank the field, and if that triggers align
19875 (and (featurep 'org-table) org-table-auto-blank-field
19876 (member last-command
19877 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas-expand))
19878 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19879 ;; got extra space, this field does not determine column width
19880 (let (org-table-may-need-update) (org-table-blank-field))
19881 ;; no extra space, this field may determine column width
19882 (org-table-blank-field)))
19884 (eq N 1)
19885 (looking-at "[^|\n]* |"))
19886 (let (org-table-may-need-update)
19887 (goto-char (1- (match-end 0)))
19888 (backward-delete-char 1)
19889 (goto-char (match-beginning 0))
19890 (self-insert-command N)))
19892 (setq org-table-may-need-update t)
19893 (self-insert-command N)
19894 (org-fix-tags-on-the-fly)
19895 (if org-self-insert-cluster-for-undo
19896 (if (not (eq last-command 'org-self-insert-command))
19897 (setq org-self-insert-command-undo-counter 1)
19898 (if (>= org-self-insert-command-undo-counter 20)
19899 (setq org-self-insert-command-undo-counter 1)
19900 (and (> org-self-insert-command-undo-counter 0)
19901 buffer-undo-list (listp buffer-undo-list)
19902 (not (cadr buffer-undo-list)) ; remove nil entry
19903 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19904 (setq org-self-insert-command-undo-counter
19905 (1+ org-self-insert-command-undo-counter))))))))
19907 (defun org-check-before-invisible-edit (kind)
19908 "Check is editing if kind KIND would be dangerous with invisible text around.
19909 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19910 ;; First, try to get out of here as quickly as possible, to reduce overhead
19911 (if (and org-catch-invisible-edits
19912 (or (not (boundp 'visible-mode)) (not visible-mode))
19913 (or (get-char-property (point) 'invisible)
19914 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19915 ;; OK, we need to take a closer look
19916 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19917 (invisible-before-point (if (bobp) nil (get-char-property
19918 (1- (point)) 'invisible)))
19919 (border-and-ok-direction
19921 ;; Check if we are acting predictably before invisible text
19922 (and invisible-at-point (not invisible-before-point)
19923 (memq kind '(insert delete-backward)))
19924 ;; Check if we are acting predictably after invisible text
19925 ;; This works not well, and I have turned it off. It seems
19926 ;; better to always show and stop after invisible text.
19927 ;; (and (not invisible-at-point) invisible-before-point
19928 ;; (memq kind '(insert delete)))
19930 (when (or (memq invisible-at-point '(outline org-hide-block t))
19931 (memq invisible-before-point '(outline org-hide-block t)))
19932 (if (eq org-catch-invisible-edits 'error)
19933 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19934 (if (and org-custom-properties-overlays
19935 (y-or-n-p "Display invisible properties in this buffer? "))
19936 (org-toggle-custom-properties-visibility)
19937 ;; Make the area visible
19938 (save-excursion
19939 (if invisible-before-point
19940 (goto-char (previous-single-char-property-change
19941 (point) 'invisible)))
19942 (show-subtree))
19943 (cond
19944 ((eq org-catch-invisible-edits 'show)
19945 ;; That's it, we do the edit after showing
19946 (message
19947 "Unfolding invisible region around point before editing")
19948 (sit-for 1))
19949 ((and (eq org-catch-invisible-edits 'smart)
19950 border-and-ok-direction)
19951 (message "Unfolding invisible region around point before editing"))
19953 ;; Don't do the edit, make the user repeat it in full visibility
19954 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19956 (defun org-fix-tags-on-the-fly ()
19957 (when (and (equal (char-after (point-at-bol)) ?*)
19958 (org-at-heading-p))
19959 (org-align-tags-here org-tags-column)))
19961 (defun org-delete-backward-char (N)
19962 "Like `delete-backward-char', insert whitespace at field end in tables.
19963 When deleting backwards, in tables this function will insert whitespace in
19964 front of the next \"|\" separator, to keep the table aligned. The table will
19965 still be marked for re-alignment if the field did fill the entire column,
19966 because, in this case the deletion might narrow the column."
19967 (interactive "p")
19968 (save-match-data
19969 (org-check-before-invisible-edit 'delete-backward)
19970 (if (and (org-table-p)
19971 (eq N 1)
19972 (string-match "|" (buffer-substring (point-at-bol) (point)))
19973 (looking-at ".*?|"))
19974 (let ((pos (point))
19975 (noalign (looking-at "[^|\n\r]* |"))
19976 (c org-table-may-need-update))
19977 (backward-delete-char N)
19978 (if (not overwrite-mode)
19979 (progn
19980 (skip-chars-forward "^|")
19981 (insert " ")
19982 (goto-char (1- pos))))
19983 ;; noalign: if there were two spaces at the end, this field
19984 ;; does not determine the width of the column.
19985 (if noalign (setq org-table-may-need-update c)))
19986 (backward-delete-char N)
19987 (org-fix-tags-on-the-fly))))
19989 (defun org-delete-char (N)
19990 "Like `delete-char', but insert whitespace at field end in tables.
19991 When deleting characters, in tables this function will insert whitespace in
19992 front of the next \"|\" separator, to keep the table aligned. The table will
19993 still be marked for re-alignment if the field did fill the entire column,
19994 because, in this case the deletion might narrow the column."
19995 (interactive "p")
19996 (save-match-data
19997 (org-check-before-invisible-edit 'delete)
19998 (if (and (org-table-p)
19999 (not (bolp))
20000 (not (= (char-after) ?|))
20001 (eq N 1))
20002 (if (looking-at ".*?|")
20003 (let ((pos (point))
20004 (noalign (looking-at "[^|\n\r]* |"))
20005 (c org-table-may-need-update))
20006 (replace-match
20007 (concat (substring (match-string 0) 1 -1) " |") nil t)
20008 (goto-char pos)
20009 ;; noalign: if there were two spaces at the end, this field
20010 ;; does not determine the width of the column.
20011 (if noalign (setq org-table-may-need-update c)))
20012 (delete-char N))
20013 (delete-char N)
20014 (org-fix-tags-on-the-fly))))
20016 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20017 (put 'org-self-insert-command 'delete-selection
20018 (lambda ()
20019 (not (run-hook-with-args-until-success
20020 'self-insert-uses-region-functions))))
20021 (put 'orgtbl-self-insert-command 'delete-selection
20022 (lambda ()
20023 (not (run-hook-with-args-until-success
20024 'self-insert-uses-region-functions))))
20025 (put 'org-delete-char 'delete-selection 'supersede)
20026 (put 'org-delete-backward-char 'delete-selection 'supersede)
20027 (put 'org-yank 'delete-selection 'yank)
20029 ;; Make `flyspell-mode' delay after some commands
20030 (put 'org-self-insert-command 'flyspell-delayed t)
20031 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20032 (put 'org-delete-char 'flyspell-delayed t)
20033 (put 'org-delete-backward-char 'flyspell-delayed t)
20035 ;; Make pabbrev-mode expand after org-mode commands
20036 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20037 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20039 (defun org-remap (map &rest commands)
20040 "In MAP, remap the functions given in COMMANDS.
20041 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20042 (let (new old)
20043 (while commands
20044 (setq old (pop commands) new (pop commands))
20045 (if (fboundp 'command-remapping)
20046 (org-defkey map (vector 'remap old) new)
20047 (substitute-key-definition old new map global-map)))))
20049 (defun org-transpose-words ()
20050 "Transpose words for Org.
20051 This uses the `org-mode-transpose-word-syntax-table' syntax
20052 table, which interprets characters in `org-emphasis-alist' as
20053 word constituents."
20054 (interactive)
20055 (with-syntax-table org-mode-transpose-word-syntax-table
20056 (call-interactively 'transpose-words)))
20057 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20059 (when (eq org-enable-table-editor 'optimized)
20060 ;; If the user wants maximum table support, we need to hijack
20061 ;; some standard editing functions
20062 (org-remap org-mode-map
20063 'self-insert-command 'org-self-insert-command
20064 'delete-char 'org-delete-char
20065 'delete-backward-char 'org-delete-backward-char)
20066 (org-defkey org-mode-map "|" 'org-force-self-insert))
20068 (defvar org-ctrl-c-ctrl-c-hook nil
20069 "Hook for functions attaching themselves to `C-c C-c'.
20071 This can be used to add additional functionality to the C-c C-c
20072 key which executes context-dependent commands. This hook is run
20073 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20074 run after the last test.
20076 Each function will be called with no arguments. The function
20077 must check if the context is appropriate for it to act. If yes,
20078 it should do its thing and then return a non-nil value. If the
20079 context is wrong, just do nothing and return nil.")
20081 (defvar org-ctrl-c-ctrl-c-final-hook nil
20082 "Hook for functions attaching themselves to `C-c C-c'.
20084 This can be used to add additional functionality to the C-c C-c
20085 key which executes context-dependent commands. This hook is run
20086 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20087 before the first test.
20089 Each function will be called with no arguments. The function
20090 must check if the context is appropriate for it to act. If yes,
20091 it should do its thing and then return a non-nil value. If the
20092 context is wrong, just do nothing and return nil.")
20094 (defvar org-tab-first-hook nil
20095 "Hook for functions to attach themselves to TAB.
20096 See `org-ctrl-c-ctrl-c-hook' for more information.
20097 This hook runs as the first action when TAB is pressed, even before
20098 `org-cycle' messes around with the `outline-regexp' to cater for
20099 inline tasks and plain list item folding.
20100 If any function in this hook returns t, any other actions that
20101 would have been caused by TAB (such as table field motion or visibility
20102 cycling) will not occur.")
20104 (defvar org-tab-after-check-for-table-hook nil
20105 "Hook for functions to attach themselves to TAB.
20106 See `org-ctrl-c-ctrl-c-hook' for more information.
20107 This hook runs after it has been established that the cursor is not in a
20108 table, but before checking if the cursor is in a headline or if global cycling
20109 should be done.
20110 If any function in this hook returns t, not other actions like visibility
20111 cycling will be done.")
20113 (defvar org-tab-after-check-for-cycling-hook nil
20114 "Hook for functions to attach themselves to TAB.
20115 See `org-ctrl-c-ctrl-c-hook' for more information.
20116 This hook runs after it has been established that not table field motion and
20117 not visibility should be done because of current context. This is probably
20118 the place where a package like yasnippets can hook in.")
20120 (defvar org-tab-before-tab-emulation-hook nil
20121 "Hook for functions to attach themselves to TAB.
20122 See `org-ctrl-c-ctrl-c-hook' for more information.
20123 This hook runs after every other options for TAB have been exhausted, but
20124 before indentation and \t insertion takes place.")
20126 (defvar org-metaleft-hook nil
20127 "Hook for functions attaching themselves to `M-left'.
20128 See `org-ctrl-c-ctrl-c-hook' for more information.")
20129 (defvar org-metaright-hook nil
20130 "Hook for functions attaching themselves to `M-right'.
20131 See `org-ctrl-c-ctrl-c-hook' for more information.")
20132 (defvar org-metaup-hook nil
20133 "Hook for functions attaching themselves to `M-up'.
20134 See `org-ctrl-c-ctrl-c-hook' for more information.")
20135 (defvar org-metadown-hook nil
20136 "Hook for functions attaching themselves to `M-down'.
20137 See `org-ctrl-c-ctrl-c-hook' for more information.")
20138 (defvar org-shiftmetaleft-hook nil
20139 "Hook for functions attaching themselves to `M-S-left'.
20140 See `org-ctrl-c-ctrl-c-hook' for more information.")
20141 (defvar org-shiftmetaright-hook nil
20142 "Hook for functions attaching themselves to `M-S-right'.
20143 See `org-ctrl-c-ctrl-c-hook' for more information.")
20144 (defvar org-shiftmetaup-hook nil
20145 "Hook for functions attaching themselves to `M-S-up'.
20146 See `org-ctrl-c-ctrl-c-hook' for more information.")
20147 (defvar org-shiftmetadown-hook nil
20148 "Hook for functions attaching themselves to `M-S-down'.
20149 See `org-ctrl-c-ctrl-c-hook' for more information.")
20150 (defvar org-metareturn-hook nil
20151 "Hook for functions attaching themselves to `M-RET'.
20152 See `org-ctrl-c-ctrl-c-hook' for more information.")
20153 (defvar org-shiftup-hook nil
20154 "Hook for functions attaching themselves to `S-up'.
20155 See `org-ctrl-c-ctrl-c-hook' for more information.")
20156 (defvar org-shiftup-final-hook nil
20157 "Hook for functions attaching themselves to `S-up'.
20158 This one runs after all other options except shift-select have been excluded.
20159 See `org-ctrl-c-ctrl-c-hook' for more information.")
20160 (defvar org-shiftdown-hook nil
20161 "Hook for functions attaching themselves to `S-down'.
20162 See `org-ctrl-c-ctrl-c-hook' for more information.")
20163 (defvar org-shiftdown-final-hook nil
20164 "Hook for functions attaching themselves to `S-down'.
20165 This one runs after all other options except shift-select have been excluded.
20166 See `org-ctrl-c-ctrl-c-hook' for more information.")
20167 (defvar org-shiftleft-hook nil
20168 "Hook for functions attaching themselves to `S-left'.
20169 See `org-ctrl-c-ctrl-c-hook' for more information.")
20170 (defvar org-shiftleft-final-hook nil
20171 "Hook for functions attaching themselves to `S-left'.
20172 This one runs after all other options except shift-select have been excluded.
20173 See `org-ctrl-c-ctrl-c-hook' for more information.")
20174 (defvar org-shiftright-hook nil
20175 "Hook for functions attaching themselves to `S-right'.
20176 See `org-ctrl-c-ctrl-c-hook' for more information.")
20177 (defvar org-shiftright-final-hook nil
20178 "Hook for functions attaching themselves to `S-right'.
20179 This one runs after all other options except shift-select have been excluded.
20180 See `org-ctrl-c-ctrl-c-hook' for more information.")
20182 (defun org-modifier-cursor-error ()
20183 "Throw an error, a modified cursor command was applied in wrong context."
20184 (user-error "This command is active in special context like tables, headlines or items"))
20186 (defun org-shiftselect-error ()
20187 "Throw an error because Shift-Cursor command was applied in wrong context."
20188 (if (and (boundp 'shift-select-mode) shift-select-mode)
20189 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20190 (user-error "This command works only in special context like headlines or timestamps")))
20192 (defun org-call-for-shift-select (cmd)
20193 (let ((this-command-keys-shift-translated t))
20194 (call-interactively cmd)))
20196 (defun org-shifttab (&optional arg)
20197 "Global visibility cycling or move to previous table field.
20198 Call `org-table-previous-field' within a table.
20199 When ARG is nil, cycle globally through visibility states.
20200 When ARG is a numeric prefix, show contents of this level."
20201 (interactive "P")
20202 (cond
20203 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20204 ((integerp arg)
20205 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20206 (message "Content view to level: %d" arg)
20207 (org-content (prefix-numeric-value arg2))
20208 (org-cycle-show-empty-lines t)
20209 (setq org-cycle-global-status 'overview)))
20210 (t (call-interactively 'org-global-cycle))))
20212 (defun org-shiftmetaleft ()
20213 "Promote subtree or delete table column.
20214 Calls `org-promote-subtree', `org-outdent-item-tree', or
20215 `org-table-delete-column', depending on context. See the
20216 individual commands for more information."
20217 (interactive)
20218 (cond
20219 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20220 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20221 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20222 ((if (not (org-region-active-p)) (org-at-item-p)
20223 (save-excursion (goto-char (region-beginning))
20224 (org-at-item-p)))
20225 (call-interactively 'org-outdent-item-tree))
20226 (t (org-modifier-cursor-error))))
20228 (defun org-shiftmetaright ()
20229 "Demote subtree or insert table column.
20230 Calls `org-demote-subtree', `org-indent-item-tree', or
20231 `org-table-insert-column', depending on context. See the
20232 individual commands for more information."
20233 (interactive)
20234 (cond
20235 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20236 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20237 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20238 ((if (not (org-region-active-p)) (org-at-item-p)
20239 (save-excursion (goto-char (region-beginning))
20240 (org-at-item-p)))
20241 (call-interactively 'org-indent-item-tree))
20242 (t (org-modifier-cursor-error))))
20244 (defun org-shiftmetaup (&optional arg)
20245 "Drag the line at point up.
20246 In a table, kill the current row.
20247 On a clock timestamp, update the value of the timestamp like `S-<up>'
20248 but also adjust the previous clocked item in the clock history.
20249 Everywhere else, drag the line at point up."
20250 (interactive "P")
20251 (cond
20252 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20253 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20254 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20255 (call-interactively 'org-timestamp-up)))
20256 (t (call-interactively 'org-drag-line-backward))))
20258 (defun org-shiftmetadown (&optional arg)
20259 "Drag the line at point down.
20260 In a table, insert an empty row at the current line.
20261 On a clock timestamp, update the value of the timestamp like `S-<down>'
20262 but also adjust the previous clocked item in the clock history.
20263 Everywhere else, drag the line at point down."
20264 (interactive "P")
20265 (cond
20266 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20267 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20268 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20269 (call-interactively 'org-timestamp-down)))
20270 (t (call-interactively 'org-drag-line-forward))))
20272 (defsubst org-hidden-tree-error ()
20273 (user-error
20274 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20276 (defun org-metaleft (&optional arg)
20277 "Promote heading or move table column to left.
20278 Calls `org-do-promote' or `org-table-move-column', depending on context.
20279 With no specific context, calls the Emacs default `backward-word'.
20280 See the individual commands for more information."
20281 (interactive "P")
20282 (cond
20283 ((run-hook-with-args-until-success 'org-metaleft-hook))
20284 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20285 ((org-with-limited-levels
20286 (or (org-at-heading-p)
20287 (and (org-region-active-p)
20288 (save-excursion
20289 (goto-char (region-beginning))
20290 (org-at-heading-p)))))
20291 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20292 (call-interactively 'org-do-promote))
20293 ;; At an inline task.
20294 ((org-at-heading-p)
20295 (call-interactively 'org-inlinetask-promote))
20296 ((or (org-at-item-p)
20297 (and (org-region-active-p)
20298 (save-excursion
20299 (goto-char (region-beginning))
20300 (org-at-item-p))))
20301 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20302 (call-interactively 'org-outdent-item))
20303 (t (call-interactively 'backward-word))))
20305 (defun org-metaright (&optional arg)
20306 "Demote a subtree, a list item or move table column to right.
20307 In front of a drawer or a block keyword, indent it correctly.
20308 With no specific context, calls the Emacs default `forward-word'.
20309 See the individual commands for more information."
20310 (interactive "P")
20311 (cond
20312 ((run-hook-with-args-until-success 'org-metaright-hook))
20313 ((org-at-table-p) (call-interactively 'org-table-move-column))
20314 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20315 ((org-at-block-p) (call-interactively 'org-indent-block))
20316 ((org-with-limited-levels
20317 (or (org-at-heading-p)
20318 (and (org-region-active-p)
20319 (save-excursion
20320 (goto-char (region-beginning))
20321 (org-at-heading-p)))))
20322 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20323 (call-interactively 'org-do-demote))
20324 ;; At an inline task.
20325 ((org-at-heading-p)
20326 (call-interactively 'org-inlinetask-demote))
20327 ((or (org-at-item-p)
20328 (and (org-region-active-p)
20329 (save-excursion
20330 (goto-char (region-beginning))
20331 (org-at-item-p))))
20332 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20333 (call-interactively 'org-indent-item))
20334 (t (call-interactively 'forward-word))))
20336 (defun org-check-for-hidden (what)
20337 "Check if there are hidden headlines/items in the current visual line.
20338 WHAT can be either `headlines' or `items'. If the current line is
20339 an outline or item heading and it has a folded subtree below it,
20340 this function returns t, nil otherwise."
20341 (let ((re (cond
20342 ((eq what 'headlines) org-outline-regexp-bol)
20343 ((eq what 'items) (org-item-beginning-re))
20344 (t (error "This should not happen"))))
20345 beg end)
20346 (save-excursion
20347 (catch 'exit
20348 (unless (org-region-active-p)
20349 (setq beg (point-at-bol))
20350 (beginning-of-line 2)
20351 (while (and (not (eobp)) ;; this is like `next-line'
20352 (get-char-property (1- (point)) 'invisible))
20353 (beginning-of-line 2))
20354 (setq end (point))
20355 (goto-char beg)
20356 (goto-char (point-at-eol))
20357 (setq end (max end (point)))
20358 (while (re-search-forward re end t)
20359 (if (get-char-property (match-beginning 0) 'invisible)
20360 (throw 'exit t))))
20361 nil))))
20363 (defun org-metaup (&optional arg)
20364 "Move subtree up or move table row up.
20365 Calls `org-move-subtree-up' or `org-table-move-row' or
20366 `org-move-item-up', depending on context. See the individual commands
20367 for more information."
20368 (interactive "P")
20369 (cond
20370 ((run-hook-with-args-until-success 'org-metaup-hook))
20371 ((org-region-active-p)
20372 (let* ((a (min (region-beginning) (region-end)))
20373 (b (1- (max (region-beginning) (region-end))))
20374 (c (save-excursion (goto-char a)
20375 (move-beginning-of-line 0)))
20376 (d (save-excursion (goto-char a)
20377 (move-end-of-line 0) (point))))
20378 (transpose-regions a b c d)
20379 (goto-char c)))
20380 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20381 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20382 ((org-at-item-p) (call-interactively 'org-move-item-up))
20383 (t (org-drag-element-backward))))
20385 (defun org-metadown (&optional arg)
20386 "Move subtree down or move table row down.
20387 Calls `org-move-subtree-down' or `org-table-move-row' or
20388 `org-move-item-down', depending on context. See the individual
20389 commands for more information."
20390 (interactive "P")
20391 (cond
20392 ((run-hook-with-args-until-success 'org-metadown-hook))
20393 ((org-region-active-p)
20394 (let* ((a (min (region-beginning) (region-end)))
20395 (b (max (region-beginning) (region-end)))
20396 (c (save-excursion (goto-char b)
20397 (move-beginning-of-line 1)))
20398 (d (save-excursion (goto-char b)
20399 (move-end-of-line 1) (1+ (point)))))
20400 (transpose-regions a b c d)
20401 (goto-char d)))
20402 ((org-at-table-p) (call-interactively 'org-table-move-row))
20403 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20404 ((org-at-item-p) (call-interactively 'org-move-item-down))
20405 (t (org-drag-element-forward))))
20407 (defun org-shiftup (&optional arg)
20408 "Increase item in timestamp or increase priority of current headline.
20409 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20410 depending on context. See the individual commands for more information."
20411 (interactive "P")
20412 (cond
20413 ((run-hook-with-args-until-success 'org-shiftup-hook))
20414 ((and org-support-shift-select (org-region-active-p))
20415 (org-call-for-shift-select 'previous-line))
20416 ((org-at-timestamp-p t)
20417 (call-interactively (if org-edit-timestamp-down-means-later
20418 'org-timestamp-down 'org-timestamp-up)))
20419 ((and (not (eq org-support-shift-select 'always))
20420 org-enable-priority-commands
20421 (org-at-heading-p))
20422 (call-interactively 'org-priority-up))
20423 ((and (not org-support-shift-select) (org-at-item-p))
20424 (call-interactively 'org-previous-item))
20425 ((org-clocktable-try-shift 'up arg))
20426 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20427 (org-support-shift-select
20428 (org-call-for-shift-select 'previous-line))
20429 (t (org-shiftselect-error))))
20431 (defun org-shiftdown (&optional arg)
20432 "Decrease item in timestamp or decrease priority of current headline.
20433 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20434 depending on context. See the individual commands for more information."
20435 (interactive "P")
20436 (cond
20437 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20438 ((and org-support-shift-select (org-region-active-p))
20439 (org-call-for-shift-select 'next-line))
20440 ((org-at-timestamp-p t)
20441 (call-interactively (if org-edit-timestamp-down-means-later
20442 'org-timestamp-up 'org-timestamp-down)))
20443 ((and (not (eq org-support-shift-select 'always))
20444 org-enable-priority-commands
20445 (org-at-heading-p))
20446 (call-interactively 'org-priority-down))
20447 ((and (not org-support-shift-select) (org-at-item-p))
20448 (call-interactively 'org-next-item))
20449 ((org-clocktable-try-shift 'down arg))
20450 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20451 (org-support-shift-select
20452 (org-call-for-shift-select 'next-line))
20453 (t (org-shiftselect-error))))
20455 (defun org-shiftright (&optional arg)
20456 "Cycle the thing at point or in the current line, depending on context.
20457 Depending on context, this does one of the following:
20459 - switch a timestamp at point one day into the future
20460 - on a headline, switch to the next TODO keyword.
20461 - on an item, switch entire list to the next bullet type
20462 - on a property line, switch to the next allowed value
20463 - on a clocktable definition line, move time block into the future"
20464 (interactive "P")
20465 (cond
20466 ((run-hook-with-args-until-success 'org-shiftright-hook))
20467 ((and org-support-shift-select (org-region-active-p))
20468 (org-call-for-shift-select 'forward-char))
20469 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20470 ((and (not (eq org-support-shift-select 'always))
20471 (org-at-heading-p))
20472 (let ((org-inhibit-logging
20473 (not org-treat-S-cursor-todo-selection-as-state-change))
20474 (org-inhibit-blocking
20475 (not org-treat-S-cursor-todo-selection-as-state-change)))
20476 (org-call-with-arg 'org-todo 'right)))
20477 ((or (and org-support-shift-select
20478 (not (eq org-support-shift-select 'always))
20479 (org-at-item-bullet-p))
20480 (and (not org-support-shift-select) (org-at-item-p)))
20481 (org-call-with-arg 'org-cycle-list-bullet nil))
20482 ((and (not (eq org-support-shift-select 'always))
20483 (org-at-property-p))
20484 (call-interactively 'org-property-next-allowed-value))
20485 ((org-clocktable-try-shift 'right arg))
20486 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20487 (org-support-shift-select
20488 (org-call-for-shift-select 'forward-char))
20489 (t (org-shiftselect-error))))
20491 (defun org-shiftleft (&optional arg)
20492 "Cycle the thing at point or in the current line, depending on context.
20493 Depending on context, this does one of the following:
20495 - switch a timestamp at point one day into the past
20496 - on a headline, switch to the previous TODO keyword.
20497 - on an item, switch entire list to the previous bullet type
20498 - on a property line, switch to the previous allowed value
20499 - on a clocktable definition line, move time block into the past"
20500 (interactive "P")
20501 (cond
20502 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20503 ((and org-support-shift-select (org-region-active-p))
20504 (org-call-for-shift-select 'backward-char))
20505 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20506 ((and (not (eq org-support-shift-select 'always))
20507 (org-at-heading-p))
20508 (let ((org-inhibit-logging
20509 (not org-treat-S-cursor-todo-selection-as-state-change))
20510 (org-inhibit-blocking
20511 (not org-treat-S-cursor-todo-selection-as-state-change)))
20512 (org-call-with-arg 'org-todo 'left)))
20513 ((or (and org-support-shift-select
20514 (not (eq org-support-shift-select 'always))
20515 (org-at-item-bullet-p))
20516 (and (not org-support-shift-select) (org-at-item-p)))
20517 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20518 ((and (not (eq org-support-shift-select 'always))
20519 (org-at-property-p))
20520 (call-interactively 'org-property-previous-allowed-value))
20521 ((org-clocktable-try-shift 'left arg))
20522 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20523 (org-support-shift-select
20524 (org-call-for-shift-select 'backward-char))
20525 (t (org-shiftselect-error))))
20527 (defun org-shiftcontrolright ()
20528 "Switch to next TODO set."
20529 (interactive)
20530 (cond
20531 ((and org-support-shift-select (org-region-active-p))
20532 (org-call-for-shift-select 'forward-word))
20533 ((and (not (eq org-support-shift-select 'always))
20534 (org-at-heading-p))
20535 (org-call-with-arg 'org-todo 'nextset))
20536 (org-support-shift-select
20537 (org-call-for-shift-select 'forward-word))
20538 (t (org-shiftselect-error))))
20540 (defun org-shiftcontrolleft ()
20541 "Switch to previous TODO set."
20542 (interactive)
20543 (cond
20544 ((and org-support-shift-select (org-region-active-p))
20545 (org-call-for-shift-select 'backward-word))
20546 ((and (not (eq org-support-shift-select 'always))
20547 (org-at-heading-p))
20548 (org-call-with-arg 'org-todo 'previousset))
20549 (org-support-shift-select
20550 (org-call-for-shift-select 'backward-word))
20551 (t (org-shiftselect-error))))
20553 (defun org-shiftcontrolup (&optional n)
20554 "Change timestamps synchronously up in CLOCK log lines.
20555 Optional argument N tells to change by that many units."
20556 (interactive "P")
20557 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20558 (let (org-support-shift-select)
20559 (org-clock-timestamps-up n))
20560 (user-error "Not at a clock log")))
20562 (defun org-shiftcontroldown (&optional n)
20563 "Change timestamps synchronously down in CLOCK log lines.
20564 Optional argument N tells to change by that many units."
20565 (interactive "P")
20566 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20567 (let (org-support-shift-select)
20568 (org-clock-timestamps-down n))
20569 (user-error "Not at a clock log")))
20571 (defun org-increase-number-at-point (&optional inc)
20572 "Increment the number at point.
20573 With an optional prefix numeric argument INC, increment using
20574 this numeric value."
20575 (interactive "p")
20576 (if (not (number-at-point))
20577 (user-error "Not on a number")
20578 (unless inc (setq inc 1))
20579 (let ((pos (point))
20580 (beg (skip-chars-backward "-+^/*0-9eE."))
20581 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20582 (setq nap (buffer-substring-no-properties
20583 (+ pos beg) (+ pos beg end)))
20584 (delete-region (+ pos beg) (+ pos beg end))
20585 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20586 (when (org-at-table-p)
20587 (org-table-align)
20588 (org-table-end-of-field 1))))
20590 (defun org-decrease-number-at-point (&optional inc)
20591 "Decrement the number at point.
20592 With an optional prefix numeric argument INC, decrement using
20593 this numeric value."
20594 (interactive "p")
20595 (org-increase-number-at-point (- inc)))
20597 (defun org-ctrl-c-ret ()
20598 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20599 (interactive)
20600 (cond
20601 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20602 (t (call-interactively 'org-insert-heading))))
20604 (defun org-find-visible ()
20605 (let ((s (point)))
20606 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20607 (get-char-property s 'invisible)))
20609 (defun org-find-invisible ()
20610 (let ((s (point)))
20611 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20612 (not (get-char-property s 'invisible))))
20615 (defun org-copy-visible (beg end)
20616 "Copy the visible parts of the region."
20617 (interactive "r")
20618 (let (snippets s)
20619 (save-excursion
20620 (save-restriction
20621 (narrow-to-region beg end)
20622 (setq s (goto-char (point-min)))
20623 (while (not (= (point) (point-max)))
20624 (goto-char (org-find-invisible))
20625 (push (buffer-substring s (point)) snippets)
20626 (setq s (goto-char (org-find-visible))))))
20627 (kill-new (apply 'concat (nreverse snippets)))))
20629 (defun org-copy-special ()
20630 "Copy region in table or copy current subtree.
20631 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20632 See the individual commands for more information."
20633 (interactive)
20634 (call-interactively
20635 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20637 (defun org-cut-special ()
20638 "Cut region in table or cut current subtree.
20639 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20640 See the individual commands for more information."
20641 (interactive)
20642 (call-interactively
20643 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20645 (defun org-paste-special (arg)
20646 "Paste rectangular region into table, or past subtree relative to level.
20647 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20648 See the individual commands for more information."
20649 (interactive "P")
20650 (if (org-at-table-p)
20651 (org-table-paste-rectangle)
20652 (org-paste-subtree arg)))
20654 (defsubst org-in-fixed-width-region-p ()
20655 "Is point in a fixed-width region?"
20656 (save-match-data
20657 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20659 (defun org-edit-special (&optional arg)
20660 "Call a special editor for the element at point.
20661 When at a table, call the formula editor with `org-table-edit-formulas'.
20662 When in a source code block, call `org-edit-src-code'.
20663 When in a fixed-width region, call `org-edit-fixed-width-region'.
20664 When at an #+INCLUDE keyword, visit the included file.
20665 On a link, call `ffap' to visit the link at point.
20666 Otherwise, return a user error."
20667 (interactive "P")
20668 (let ((element (org-element-at-point)))
20669 (assert (not buffer-read-only) nil
20670 "Buffer is read-only: %s" (buffer-name))
20671 (case (org-element-type element)
20672 (src-block
20673 (if (not arg) (org-edit-src-code)
20674 (let* ((info (org-babel-get-src-block-info))
20675 (lang (nth 0 info))
20676 (params (nth 2 info))
20677 (session (cdr (assq :session params))))
20678 (if (not session) (org-edit-src-code)
20679 ;; At a src-block with a session and function called with
20680 ;; an ARG: switch to the buffer related to the inferior
20681 ;; process.
20682 (switch-to-buffer
20683 (funcall (intern (concat "org-babel-prep-session:" lang))
20684 session params))))))
20685 (keyword
20686 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20687 (org-open-link-from-string
20688 (format "[[%s]]"
20689 (expand-file-name
20690 (let ((value (org-element-property :value element)))
20691 (cond ((not (org-string-nw-p value))
20692 (user-error "No file to edit"))
20693 ((string-match "\\`\"\\(.*?\\)\"" value)
20694 (match-string 1 value))
20695 ((string-match "\\`[^ \t\"]\\S-*" value)
20696 (match-string 0 value))
20697 (t (user-error "No valid file specified")))))))
20698 (user-error "No special environment to edit here")))
20699 (table
20700 (if (eq (org-element-property :type element) 'table.el)
20701 (org-edit-src-code)
20702 (call-interactively 'org-table-edit-formulas)))
20703 ;; Only Org tables contain `table-row' type elements.
20704 (table-row (call-interactively 'org-table-edit-formulas))
20705 ((example-block export-block) (org-edit-src-code))
20706 (fixed-width (org-edit-fixed-width-region))
20707 (otherwise
20708 ;; No notable element at point. Though, we may be at a link,
20709 ;; which is an object. Thus, scan deeper.
20710 (if (eq (org-element-type (org-element-context element)) 'link)
20711 (call-interactively 'ffap)
20712 (user-error "No special environment to edit here"))))))
20714 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20715 (defun org-ctrl-c-ctrl-c (&optional arg)
20716 "Set tags in headline, or update according to changed information at point.
20718 This command does many different things, depending on context:
20720 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20721 this is what we do.
20723 - If the cursor is on a statistics cookie, update it.
20725 - If the cursor is in a headline, prompt for tags and insert them
20726 into the current line, aligned to `org-tags-column'. When called
20727 with prefix arg, realign all tags in the current buffer.
20729 - If the cursor is in one of the special #+KEYWORD lines, this
20730 triggers scanning the buffer for these lines and updating the
20731 information.
20733 - If the cursor is inside a table, realign the table. This command
20734 works even if the automatic table editor has been turned off.
20736 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20737 the entire table.
20739 - If the cursor is at a footnote reference or definition, jump to
20740 the corresponding definition or references, respectively.
20742 - If the cursor is a the beginning of a dynamic block, update it.
20744 - If the current buffer is a capture buffer, close note and file it.
20746 - If the cursor is on a <<<target>>>, update radio targets and
20747 corresponding links in this buffer.
20749 - If the cursor is on a numbered item in a plain list, renumber the
20750 ordered list.
20752 - If the cursor is on a checkbox, toggle it.
20754 - If the cursor is on a code block, evaluate it. The variable
20755 `org-confirm-babel-evaluate' can be used to control prompting
20756 before code block evaluation, by default every code block
20757 evaluation requires confirmation. Code block evaluation can be
20758 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20759 (interactive "P")
20760 (cond
20761 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20762 org-occur-highlights)
20763 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20764 (org-remove-occur-highlights)
20765 (message "Temporary highlights/overlays removed from current buffer"))
20766 ((and (local-variable-p 'org-finish-function (current-buffer))
20767 (fboundp org-finish-function))
20768 (funcall org-finish-function))
20769 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20771 (let* ((context (org-element-context)) (type (org-element-type context)))
20772 ;; Test if point is within a blank line.
20773 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20774 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20775 (user-error "C-c C-c can do nothing useful at this location"))
20776 (case type
20777 ;; When at a link, act according to the parent instead.
20778 (link (setq context (org-element-property :parent context))
20779 (setq type (org-element-type context)))
20780 ;; Unsupported object types: refer to the first supported
20781 ;; element or object containing it.
20782 ((bold code entity export-snippet inline-babel-call inline-src-block
20783 italic latex-fragment line-break macro strike-through subscript
20784 superscript underline verbatim)
20785 (while (and (setq context (org-element-property :parent context))
20786 (not (memq (setq type (org-element-type context))
20787 '(radio-target paragraph verse-block
20788 table-cell)))))))
20789 ;; For convenience: at the first line of a paragraph on the
20790 ;; same line as an item, apply function on that item instead.
20791 (when (eq type 'paragraph)
20792 (let ((parent (org-element-property :parent context)))
20793 (when (and (eq (org-element-type parent) 'item)
20794 (= (point-at-bol) (org-element-property :begin parent)))
20795 (setq context parent type 'item))))
20796 ;; Act according to type of element or object at point.
20797 (case type
20798 (clock (org-clock-update-time-maybe))
20799 (dynamic-block
20800 (save-excursion
20801 (goto-char (org-element-property :post-affiliated context))
20802 (org-update-dblock)))
20803 (footnote-definition
20804 (goto-char (org-element-property :post-affiliated context))
20805 (call-interactively 'org-footnote-action))
20806 (footnote-reference (call-interactively 'org-footnote-action))
20807 ((headline inlinetask)
20808 (save-excursion (goto-char (org-element-property :begin context))
20809 (call-interactively 'org-set-tags)))
20810 (item
20811 ;; At an item: a double C-u set checkbox to "[-]"
20812 ;; unconditionally, whereas a single one will toggle its
20813 ;; presence. Without an universal argument, if the item
20814 ;; has a checkbox, toggle it. Otherwise repair the list.
20815 (let* ((box (org-element-property :checkbox context))
20816 (struct (org-element-property :structure context))
20817 (old-struct (copy-tree struct))
20818 (parents (org-list-parents-alist struct))
20819 (prevs (org-list-prevs-alist struct))
20820 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20821 (org-list-set-checkbox
20822 (org-element-property :begin context) struct
20823 (cond ((equal arg '(16)) "[-]")
20824 ((and (not box) (equal arg '(4))) "[ ]")
20825 ((or (not box) (equal arg '(4))) nil)
20826 ((eq box 'on) "[ ]")
20827 (t "[X]")))
20828 ;; Mimic `org-list-write-struct' but with grabbing
20829 ;; a return value from `org-list-struct-fix-box'.
20830 (org-list-struct-fix-ind struct parents 2)
20831 (org-list-struct-fix-item-end struct)
20832 (org-list-struct-fix-bul struct prevs)
20833 (org-list-struct-fix-ind struct parents)
20834 (let ((block-item
20835 (org-list-struct-fix-box struct parents prevs orderedp)))
20836 (if (and box (equal struct old-struct))
20837 (if (equal arg '(16))
20838 (message "Checkboxes already reset")
20839 (user-error "Cannot toggle this checkbox: %s"
20840 (if (eq box 'on)
20841 "all subitems checked"
20842 "unchecked subitems")))
20843 (org-list-struct-apply-struct struct old-struct)
20844 (org-update-checkbox-count-maybe))
20845 (when block-item
20846 (message "Checkboxes were removed due to empty box at line %d"
20847 (org-current-line block-item))))))
20848 (keyword
20849 (let ((org-inhibit-startup-visibility-stuff t)
20850 (org-startup-align-all-tables nil))
20851 (when (boundp 'org-table-coordinate-overlays)
20852 (mapc 'delete-overlay org-table-coordinate-overlays)
20853 (setq org-table-coordinate-overlays nil))
20854 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20855 (message "Local setup has been refreshed"))
20856 (plain-list
20857 ;; At a plain list, with a double C-u argument, set
20858 ;; checkboxes of each item to "[-]", whereas a single one
20859 ;; will toggle their presence according to the state of the
20860 ;; first item in the list. Without an argument, repair the
20861 ;; list.
20862 (let* ((begin (org-element-property :contents-begin context))
20863 (beginm (move-marker (make-marker) begin))
20864 (struct (org-element-property :structure context))
20865 (old-struct (copy-tree struct))
20866 (first-box (save-excursion
20867 (goto-char begin)
20868 (looking-at org-list-full-item-re)
20869 (match-string-no-properties 3)))
20870 (new-box (cond ((equal arg '(16)) "[-]")
20871 ((equal arg '(4)) (unless first-box "[ ]"))
20872 ((equal first-box "[X]") "[ ]")
20873 (t "[X]"))))
20874 (cond
20875 (arg
20876 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20877 (org-list-get-all-items
20878 begin struct (org-list-prevs-alist struct))))
20879 ((and first-box (eq (point) begin))
20880 ;; For convenience, when point is at bol on the first
20881 ;; item of the list and no argument is provided, simply
20882 ;; toggle checkbox of that item, if any.
20883 (org-list-set-checkbox begin struct new-box)))
20884 (org-list-write-struct
20885 struct (org-list-parents-alist struct) old-struct)
20886 (org-update-checkbox-count-maybe)
20887 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20888 ((property-drawer node-property)
20889 (call-interactively 'org-property-action))
20890 ((radio-target target)
20891 (call-interactively 'org-update-radio-target-regexp))
20892 (statistics-cookie
20893 (call-interactively 'org-update-statistics-cookies))
20894 ((table table-cell table-row)
20895 ;; At a table, recalculate every field and align it. Also
20896 ;; send the table if necessary. If the table has
20897 ;; a `table.el' type, just give up. At a table row or
20898 ;; cell, maybe recalculate line but always align table.
20899 (if (eq (org-element-property :type context) 'table.el)
20900 (message "Use C-c ' to edit table.el tables")
20901 (let ((org-enable-table-editor t))
20902 (if (or (eq type 'table)
20903 ;; Check if point is at a TBLFM line.
20904 (and (eq type 'table-row)
20905 (= (point) (org-element-property :end context))))
20906 (save-excursion
20907 (if (org-at-TBLFM-p)
20908 (progn (require 'org-table)
20909 (org-table-calc-current-TBLFM))
20910 (goto-char (org-element-property :contents-begin context))
20911 (org-call-with-arg 'org-table-recalculate (or arg t))
20912 (orgtbl-send-table 'maybe)))
20913 (org-table-maybe-eval-formula)
20914 (cond (arg (call-interactively 'org-table-recalculate))
20915 ((org-table-maybe-recalculate-line))
20916 (t (org-table-align)))))))
20917 (timestamp (org-timestamp-change 0 'day))
20918 (otherwise
20919 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20920 (user-error
20921 "C-c C-c can do nothing useful at this location")))))))))
20923 (defun org-mode-restart ()
20924 (interactive)
20925 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20926 (funcall major-mode)
20927 (hack-local-variables)
20928 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20929 (org-indent-mode -1)))
20930 (message "%s restarted" major-mode))
20932 (defun org-kill-note-or-show-branches ()
20933 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20934 (interactive)
20935 (if (not org-finish-function)
20936 (progn
20937 (hide-subtree)
20938 (call-interactively 'show-branches))
20939 (let ((org-note-abort t))
20940 (funcall org-finish-function))))
20942 (defun org-open-line (n)
20943 "Insert a new row in tables, call `open-line' elsewhere.
20944 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20945 (interactive "*p")
20946 (cond
20947 ((not org-special-ctrl-o)
20948 (open-line n))
20949 ((org-at-table-p)
20950 (org-table-insert-row))
20952 (open-line n))))
20954 (defun org-return (&optional indent)
20955 "Goto next table row or insert a newline.
20957 Calls `org-table-next-row' or `newline', depending on context.
20959 When optional INDENT argument is non-nil, call
20960 `newline-and-indent' instead of `newline'.
20962 When `org-return-follows-link' is non-nil and point is on
20963 a timestamp or a link, call `org-open-at-point'. However, it
20964 will not happen if point is in a table or on a \"dead\"
20965 object (e.g., within a comment). In these case, you need to use
20966 `org-open-at-point' directly."
20967 (interactive)
20968 (if (and (save-excursion
20969 (beginning-of-line)
20970 (looking-at org-todo-line-regexp))
20971 (match-beginning 3)
20972 (>= (point) (match-beginning 3)))
20973 ;; Point is on headline tags. Do not break them: add a newline
20974 ;; after the headline instead.
20975 (progn (org-show-entry)
20976 (end-of-line)
20977 (if indent (newline-and-indent) (newline)))
20978 (let* ((context (if org-return-follows-link (org-element-context)
20979 (org-element-at-point)))
20980 (type (org-element-type context)))
20981 (cond
20982 ;; In a table, call `org-table-next-row'.
20983 ((or (and (eq type 'table)
20984 (>= (point) (org-element-property :contents-begin context))
20985 (< (point) (org-element-property :contents-end context)))
20986 (org-element-lineage context '(table-row table-cell) t))
20987 (org-table-justify-field-maybe)
20988 (call-interactively #'org-table-next-row))
20989 ;; On a link or a timestamp but not on white spaces after it,
20990 ;; call `org-open-line' if `org-return-follows-link' allows it.
20991 ((and org-return-follows-link
20992 (memq type '(link timestamp))
20993 (< (point)
20994 (save-excursion (goto-char (org-element-property :end context))
20995 (skip-chars-backward " \t")
20996 (point))))
20997 (call-interactively #'org-open-at-point))
20998 ;; In a list, make sure indenting keeps trailing text within.
20999 ((and indent
21000 (not (eolp))
21001 (org-element-lineage context '(item plain-list) t))
21002 (let ((trailing-data
21003 (delete-and-extract-region (point) (line-end-position))))
21004 (newline-and-indent)
21005 (save-excursion (insert trailing-data))))
21006 (t (if indent (newline-and-indent) (newline)))))))
21008 (defun org-return-indent ()
21009 "Goto next table row or insert a newline and indent.
21010 Calls `org-table-next-row' or `newline-and-indent', depending on
21011 context. See the individual commands for more information."
21012 (interactive)
21013 (org-return t))
21015 (defun org-ctrl-c-star ()
21016 "Compute table, or change heading status of lines.
21017 Calls `org-table-recalculate' or `org-toggle-heading',
21018 depending on context."
21019 (interactive)
21020 (cond
21021 ((org-at-table-p)
21022 (call-interactively 'org-table-recalculate))
21024 ;; Convert all lines in region to list items
21025 (call-interactively 'org-toggle-heading))))
21027 (defun org-ctrl-c-minus ()
21028 "Insert separator line in table or modify bullet status of line.
21029 Also turns a plain line or a region of lines into list items.
21030 Calls `org-table-insert-hline', `org-toggle-item', or
21031 `org-cycle-list-bullet', depending on context."
21032 (interactive)
21033 (cond
21034 ((org-at-table-p)
21035 (call-interactively 'org-table-insert-hline))
21036 ((org-region-active-p)
21037 (call-interactively 'org-toggle-item))
21038 ((org-in-item-p)
21039 (call-interactively 'org-cycle-list-bullet))
21041 (call-interactively 'org-toggle-item))))
21043 (defun org-toggle-item (arg)
21044 "Convert headings or normal lines to items, items to normal lines.
21045 If there is no active region, only the current line is considered.
21047 If the first non blank line in the region is a headline, convert
21048 all headlines to items, shifting text accordingly.
21050 If it is an item, convert all items to normal lines.
21052 If it is normal text, change region into a list of items.
21053 With a prefix argument ARG, change the region in a single item."
21054 (interactive "P")
21055 (let ((shift-text
21056 (function
21057 ;; Shift text in current section to IND, from point to END.
21058 ;; The function leaves point to END line.
21059 (lambda (ind end)
21060 (let ((min-i 1000) (end (copy-marker end)))
21061 ;; First determine the minimum indentation (MIN-I) of
21062 ;; the text.
21063 (save-excursion
21064 (catch 'exit
21065 (while (< (point) end)
21066 (let ((i (org-get-indentation)))
21067 (cond
21068 ;; Skip blank lines and inline tasks.
21069 ((looking-at "^[ \t]*$"))
21070 ((looking-at org-outline-regexp-bol))
21071 ;; We can't find less than 0 indentation.
21072 ((zerop i) (throw 'exit (setq min-i 0)))
21073 ((< i min-i) (setq min-i i))))
21074 (forward-line))))
21075 ;; Then indent each line so that a line indented to
21076 ;; MIN-I becomes indented to IND. Ignore blank lines
21077 ;; and inline tasks in the process.
21078 (let ((delta (- ind min-i)))
21079 (while (< (point) end)
21080 (unless (or (looking-at "^[ \t]*$")
21081 (looking-at org-outline-regexp-bol))
21082 (org-indent-line-to (+ (org-get-indentation) delta)))
21083 (forward-line)))))))
21084 (skip-blanks
21085 (function
21086 ;; Return beginning of first non-blank line, starting from
21087 ;; line at POS.
21088 (lambda (pos)
21089 (save-excursion
21090 (goto-char pos)
21091 (skip-chars-forward " \r\t\n")
21092 (point-at-bol)))))
21093 beg end)
21094 ;; Determine boundaries of changes.
21095 (if (org-region-active-p)
21096 (setq beg (funcall skip-blanks (region-beginning))
21097 end (copy-marker (region-end)))
21098 (setq beg (funcall skip-blanks (point-at-bol))
21099 end (copy-marker (point-at-eol))))
21100 ;; Depending on the starting line, choose an action on the text
21101 ;; between BEG and END.
21102 (org-with-limited-levels
21103 (save-excursion
21104 (goto-char beg)
21105 (cond
21106 ;; Case 1. Start at an item: de-itemize. Note that it only
21107 ;; happens when a region is active: `org-ctrl-c-minus'
21108 ;; would call `org-cycle-list-bullet' otherwise.
21109 ((org-at-item-p)
21110 (while (< (point) end)
21111 (when (org-at-item-p)
21112 (skip-chars-forward " \t")
21113 (delete-region (point) (match-end 0)))
21114 (forward-line)))
21115 ;; Case 2. Start at an heading: convert to items.
21116 ((org-at-heading-p)
21117 (let* ((bul (org-list-bullet-string "-"))
21118 (bul-len (length bul))
21119 (done (org-entry-is-done-p))
21120 (todo (org-entry-is-todo-p))
21121 ;; Indentation of the first heading. It should be
21122 ;; relative to the indentation of its parent, if any.
21123 (start-ind (save-excursion
21124 (cond
21125 ((not org-adapt-indentation) 0)
21126 ((not (outline-previous-heading)) 0)
21127 (t (length (match-string 0))))))
21128 ;; Level of first heading. Further headings will be
21129 ;; compared to it to determine hierarchy in the list.
21130 (ref-level (org-reduced-level (org-outline-level))))
21131 (when (or done todo) (org-todo ""))
21132 (while (< (point) end)
21133 (let* ((level (org-reduced-level (org-outline-level)))
21134 (delta (max 0 (- level ref-level))))
21135 ;; If current headline is less indented than the first
21136 ;; one, set it as reference, in order to preserve
21137 ;; subtrees.
21138 (when (< level ref-level) (setq ref-level level))
21139 (replace-match bul t t)
21140 (org-indent-line-to (+ start-ind (* delta bul-len)))
21141 (when (or done todo)
21142 (let* ((struct (org-list-struct))
21143 (old (copy-tree struct)))
21144 (org-list-set-checkbox (line-beginning-position)
21145 struct
21146 (if done "[X]" "[ ]"))
21147 (org-list-write-struct struct
21148 (org-list-parents-alist struct)
21149 old)))
21150 ;; Ensure all text down to END (or SECTION-END) belongs
21151 ;; to the newly created item.
21152 (let ((section-end (save-excursion
21153 (or (outline-next-heading) (point)))))
21154 (forward-line)
21155 (funcall shift-text
21156 (+ start-ind (* (1+ delta) bul-len))
21157 (min end section-end)))))))
21158 ;; Case 3. Normal line with ARG: make the first line of region
21159 ;; an item, and shift indentation of others lines to
21160 ;; set them as item's body.
21161 (arg (let* ((bul (org-list-bullet-string "-"))
21162 (bul-len (length bul))
21163 (ref-ind (org-get-indentation)))
21164 (skip-chars-forward " \t")
21165 (insert bul)
21166 (forward-line)
21167 (while (< (point) end)
21168 ;; Ensure that lines less indented than first one
21169 ;; still get included in item body.
21170 (funcall shift-text
21171 (+ ref-ind bul-len)
21172 (min end (save-excursion (or (outline-next-heading)
21173 (point)))))
21174 (forward-line))))
21175 ;; Case 4. Normal line without ARG: turn each non-item line
21176 ;; into an item.
21178 (while (< (point) end)
21179 (unless (or (org-at-heading-p) (org-at-item-p))
21180 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21181 (replace-match
21182 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21183 (forward-line))))))))
21185 (defun org-toggle-heading (&optional nstars)
21186 "Convert headings to normal text, or items or text to headings.
21187 If there is no active region, only convert the current line.
21189 With a \\[universal-argument] prefix, convert the whole list at
21190 point into heading.
21192 In a region:
21194 - If the first non blank line is a headline, remove the stars
21195 from all headlines in the region.
21197 - If it is a normal line, turn each and every normal line (i.e.,
21198 not an heading or an item) in the region into headings. If you
21199 want to convert only the first line of this region, use one
21200 universal prefix argument.
21202 - If it is a plain list item, turn all plain list items into headings.
21204 When converting a line into a heading, the number of stars is chosen
21205 such that the lines become children of the current entry. However,
21206 when a numeric prefix argument is given, its value determines the
21207 number of stars to add."
21208 (interactive "P")
21209 (let ((skip-blanks
21210 (function
21211 ;; Return beginning of first non-blank line, starting from
21212 ;; line at POS.
21213 (lambda (pos)
21214 (save-excursion
21215 (goto-char pos)
21216 (while (org-at-comment-p) (forward-line))
21217 (skip-chars-forward " \r\t\n")
21218 (point-at-bol)))))
21219 beg end toggled)
21220 ;; Determine boundaries of changes. If a universal prefix has
21221 ;; been given, put the list in a region. If region ends at a bol,
21222 ;; do not consider the last line to be in the region.
21224 (when (and current-prefix-arg (org-at-item-p))
21225 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21226 (org-mark-element))
21228 (if (org-region-active-p)
21229 (setq beg (funcall skip-blanks (region-beginning))
21230 end (copy-marker (save-excursion
21231 (goto-char (region-end))
21232 (if (bolp) (point) (point-at-eol)))))
21233 (setq beg (funcall skip-blanks (point-at-bol))
21234 end (copy-marker (point-at-eol))))
21235 ;; Ensure inline tasks don't count as headings.
21236 (org-with-limited-levels
21237 (save-excursion
21238 (goto-char beg)
21239 (cond
21240 ;; Case 1. Started at an heading: de-star headings.
21241 ((org-at-heading-p)
21242 (while (< (point) end)
21243 (when (org-at-heading-p t)
21244 (looking-at org-outline-regexp) (replace-match "")
21245 (setq toggled t))
21246 (forward-line)))
21247 ;; Case 2. Started at an item: change items into headlines.
21248 ;; One star will be added by `org-list-to-subtree'.
21249 ((org-at-item-p)
21250 (let* ((stars (make-string
21251 ;; subtract the star that will be added again by
21252 ;; `org-list-to-subtree'
21253 (if (numberp nstars) (1- nstars)
21254 (or (org-current-level) 0))
21255 ?*))
21256 (add-stars
21257 (cond (nstars "") ; stars from prefix only
21258 ((equal stars "") "") ; before first heading
21259 (org-odd-levels-only "*") ; inside heading, odd
21260 (t "")))) ; inside heading, oddeven
21261 (while (< (point) end)
21262 (when (org-at-item-p)
21263 ;; Pay attention to cases when region ends before list.
21264 (let* ((struct (org-list-struct))
21265 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21266 (save-restriction
21267 (narrow-to-region (point) list-end)
21268 (insert
21269 (org-list-to-subtree
21270 (org-list-parse-list t)
21271 '(:istart (concat stars add-stars (funcall get-stars depth))
21272 :icount (concat stars add-stars (funcall get-stars depth)))))))
21273 (setq toggled t))
21274 (forward-line))))
21275 ;; Case 3. Started at normal text: make every line an heading,
21276 ;; skipping headlines and items.
21277 (t (let* ((stars
21278 (make-string
21279 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21280 (add-stars
21281 (cond (nstars "") ; stars from prefix only
21282 ((equal stars "") "*") ; before first heading
21283 (org-odd-levels-only "**") ; inside heading, odd
21284 (t "*"))) ; inside heading, oddeven
21285 (rpl (concat stars add-stars " "))
21286 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21287 (while (< (point) (if (equal nstars '(4)) lend end))
21288 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21289 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21290 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21291 (forward-line)))))))
21292 (unless toggled (message "Cannot toggle heading from here"))))
21294 (defun org-meta-return (&optional arg)
21295 "Insert a new heading or wrap a region in a table.
21296 Calls `org-insert-heading' or `org-table-wrap-region', depending
21297 on context. See the individual commands for more information."
21298 (interactive "P")
21299 (org-check-before-invisible-edit 'insert)
21300 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21301 (let* ((element (org-element-at-point))
21302 (type (org-element-type element)))
21303 (when (eq type 'table-row)
21304 (setq element (org-element-property :parent element))
21305 (setq type 'table))
21306 (if (and (eq type 'table)
21307 (eq (org-element-property :type element) 'org)
21308 (>= (point) (org-element-property :contents-begin element))
21309 (< (point) (org-element-property :contents-end element)))
21310 (call-interactively 'org-table-wrap-region)
21311 (call-interactively 'org-insert-heading)))))
21313 ;;; Menu entries
21315 (defsubst org-in-subtree-not-table-p ()
21316 "Are we in a subtree and not in a table?"
21317 (and (not (org-before-first-heading-p))
21318 (not (org-at-table-p))))
21320 ;; Define the Org-mode menus
21321 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21322 '("Tbl"
21323 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21324 ["Next Field" org-cycle (org-at-table-p)]
21325 ["Previous Field" org-shifttab (org-at-table-p)]
21326 ["Next Row" org-return (org-at-table-p)]
21327 "--"
21328 ["Blank Field" org-table-blank-field (org-at-table-p)]
21329 ["Edit Field" org-table-edit-field (org-at-table-p)]
21330 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21331 "--"
21332 ("Column"
21333 ["Move Column Left" org-metaleft (org-at-table-p)]
21334 ["Move Column Right" org-metaright (org-at-table-p)]
21335 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21336 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21337 ("Row"
21338 ["Move Row Up" org-metaup (org-at-table-p)]
21339 ["Move Row Down" org-metadown (org-at-table-p)]
21340 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21341 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21342 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21343 "--"
21344 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21345 ("Rectangle"
21346 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21347 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21348 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21349 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21350 "--"
21351 ("Calculate"
21352 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21353 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21354 ["Edit Formulas" org-edit-special (org-at-table-p)]
21355 "--"
21356 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21357 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21358 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21359 "--"
21360 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21361 "--"
21362 ["Sum Column/Rectangle" org-table-sum
21363 (or (org-at-table-p) (org-region-active-p))]
21364 ["Which Column?" org-table-current-column (org-at-table-p)])
21365 ["Debug Formulas"
21366 org-table-toggle-formula-debugger
21367 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21368 ["Show Col/Row Numbers"
21369 org-table-toggle-coordinate-overlays
21370 :style toggle
21371 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21372 "--"
21373 ["Create" org-table-create (and (not (org-at-table-p))
21374 org-enable-table-editor)]
21375 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21376 ["Import from File" org-table-import (not (org-at-table-p))]
21377 ["Export to File" org-table-export (org-at-table-p)]
21378 "--"
21379 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21380 "--"
21381 ("Plot"
21382 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21383 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21385 (easy-menu-define org-org-menu org-mode-map "Org menu"
21386 '("Org"
21387 ("Show/Hide"
21388 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21389 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21390 ["Sparse Tree..." org-sparse-tree t]
21391 ["Reveal Context" org-reveal t]
21392 ["Show All" show-all t]
21393 "--"
21394 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21395 "--"
21396 ["New Heading" org-insert-heading t]
21397 ("Navigate Headings"
21398 ["Up" outline-up-heading t]
21399 ["Next" outline-next-visible-heading t]
21400 ["Previous" outline-previous-visible-heading t]
21401 ["Next Same Level" outline-forward-same-level t]
21402 ["Previous Same Level" outline-backward-same-level t]
21403 "--"
21404 ["Jump" org-goto t])
21405 ("Edit Structure"
21406 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21407 "--"
21408 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21409 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21410 "--"
21411 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21412 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21413 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21414 "--"
21415 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21416 "--"
21417 ["Copy visible text" org-copy-visible t]
21418 "--"
21419 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21420 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21421 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21422 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21423 "--"
21424 ["Sort Region/Children" org-sort t]
21425 "--"
21426 ["Convert to odd levels" org-convert-to-odd-levels t]
21427 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21428 ("Editing"
21429 ["Emphasis..." org-emphasize t]
21430 ["Edit Source Example" org-edit-special t]
21431 "--"
21432 ["Footnote new/jump" org-footnote-action t]
21433 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21434 ("Archive"
21435 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21436 "--"
21437 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21438 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21439 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21441 "--"
21442 ("Hyperlinks"
21443 ["Store Link (Global)" org-store-link t]
21444 ["Find existing link to here" org-occur-link-in-agenda-files t]
21445 ["Insert Link" org-insert-link t]
21446 ["Follow Link" org-open-at-point t]
21447 "--"
21448 ["Next link" org-next-link t]
21449 ["Previous link" org-previous-link t]
21450 "--"
21451 ["Descriptive Links"
21452 org-toggle-link-display
21453 :style radio
21454 :selected org-descriptive-links
21456 ["Literal Links"
21457 org-toggle-link-display
21458 :style radio
21459 :selected (not org-descriptive-links)])
21460 "--"
21461 ("TODO Lists"
21462 ["TODO/DONE/-" org-todo t]
21463 ("Select keyword"
21464 ["Next keyword" org-shiftright (org-at-heading-p)]
21465 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21466 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21467 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21468 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21469 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21470 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21471 "--"
21472 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21473 :selected org-enforce-todo-dependencies :style toggle :active t]
21474 "Settings for tree at point"
21475 ["Do Children sequentially" org-toggle-ordered-property :style radio
21476 :selected (org-entry-get nil "ORDERED")
21477 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21478 ["Do Children parallel" org-toggle-ordered-property :style radio
21479 :selected (not (org-entry-get nil "ORDERED"))
21480 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21481 "--"
21482 ["Set Priority" org-priority t]
21483 ["Priority Up" org-shiftup t]
21484 ["Priority Down" org-shiftdown t]
21485 "--"
21486 ["Get news from all feeds" org-feed-update-all t]
21487 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21488 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21489 ("TAGS and Properties"
21490 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21491 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21492 "--"
21493 ["Set property" org-set-property (not (org-before-first-heading-p))]
21494 ["Column view of properties" org-columns t]
21495 ["Insert Column View DBlock" org-insert-columns-dblock t])
21496 ("Dates and Scheduling"
21497 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21498 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21499 ("Change Date"
21500 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21501 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21502 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21503 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21504 ["Compute Time Range" org-evaluate-time-range t]
21505 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21506 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21507 "--"
21508 ["Custom time format" org-toggle-time-stamp-overlays
21509 :style radio :selected org-display-custom-times]
21510 "--"
21511 ["Goto Calendar" org-goto-calendar t]
21512 ["Date from Calendar" org-date-from-calendar t]
21513 "--"
21514 ["Start/Restart Timer" org-timer-start t]
21515 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21516 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21517 ["Insert Timer String" org-timer t]
21518 ["Insert Timer Item" org-timer-item t])
21519 ("Logging work"
21520 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21521 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21522 ["Clock out" org-clock-out t]
21523 ["Clock cancel" org-clock-cancel t]
21524 "--"
21525 ["Mark as default task" org-clock-mark-default-task t]
21526 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21527 ["Goto running clock" org-clock-goto t]
21528 "--"
21529 ["Display times" org-clock-display t]
21530 ["Create clock table" org-clock-report t]
21531 "--"
21532 ["Record DONE time"
21533 (progn (setq org-log-done (not org-log-done))
21534 (message "Switching to %s will %s record a timestamp"
21535 (car org-done-keywords)
21536 (if org-log-done "automatically" "not")))
21537 :style toggle :selected org-log-done])
21538 "--"
21539 ["Agenda Command..." org-agenda t]
21540 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21541 ("File List for Agenda")
21542 ("Special views current file"
21543 ["TODO Tree" org-show-todo-tree t]
21544 ["Check Deadlines" org-check-deadlines t]
21545 ["Timeline" org-timeline t]
21546 ["Tags/Property tree" org-match-sparse-tree t])
21547 "--"
21548 ["Export/Publish..." org-export-dispatch t]
21549 ("LaTeX"
21550 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21551 :selected org-cdlatex-mode]
21552 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21553 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21554 ["Modify math symbol" org-cdlatex-math-modify
21555 (org-inside-LaTeX-fragment-p)]
21556 ["Insert citation" org-reftex-citation t]
21557 "--"
21558 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21559 "--"
21560 ("MobileOrg"
21561 ["Push Files and Views" org-mobile-push t]
21562 ["Get Captured and Flagged" org-mobile-pull t]
21563 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21564 "--"
21565 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21566 "--"
21567 ("Documentation"
21568 ["Show Version" org-version t]
21569 ["Info Documentation" org-info t])
21570 ("Customize"
21571 ["Browse Org Group" org-customize t]
21572 "--"
21573 ["Expand This Menu" org-create-customize-menu
21574 (fboundp 'customize-menu-create)])
21575 ["Send bug report" org-submit-bug-report t]
21576 "--"
21577 ("Refresh/Reload"
21578 ["Refresh setup current buffer" org-mode-restart t]
21579 ["Reload Org (after update)" org-reload t]
21580 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21583 (defun org-info (&optional node)
21584 "Read documentation for Org-mode in the info system.
21585 With optional NODE, go directly to that node."
21586 (interactive)
21587 (info (format "(org)%s" (or node ""))))
21589 ;;;###autoload
21590 (defun org-submit-bug-report ()
21591 "Submit a bug report on Org-mode via mail.
21593 Don't hesitate to report any problems or inaccurate documentation.
21595 If you don't have setup sending mail from (X)Emacs, please copy the
21596 output buffer into your mail program, as it gives us important
21597 information about your Org-mode version and configuration."
21598 (interactive)
21599 (require 'reporter)
21600 (org-load-modules-maybe)
21601 (org-require-autoloaded-modules)
21602 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21603 (reporter-submit-bug-report
21604 "emacs-orgmode@gnu.org"
21605 (org-version nil 'full)
21606 (let (list)
21607 (save-window-excursion
21608 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21609 (delete-other-windows)
21610 (erase-buffer)
21611 (insert "You are about to submit a bug report to the Org-mode mailing list.
21613 We would like to add your full Org-mode and Outline configuration to the
21614 bug report. This greatly simplifies the work of the maintainer and
21615 other experts on the mailing list.
21617 HOWEVER, some variables you have customized may contain private
21618 information. The names of customers, colleagues, or friends, might
21619 appear in the form of file names, tags, todo states, or search strings.
21620 If you answer yes to the prompt, you might want to check and remove
21621 such private information before sending the email.")
21622 (add-text-properties (point-min) (point-max) '(face org-warning))
21623 (when (yes-or-no-p "Include your Org-mode configuration ")
21624 (mapatoms
21625 (lambda (v)
21626 (and (boundp v)
21627 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21628 (or (and (symbol-value v)
21629 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21630 (and
21631 (get v 'custom-type) (get v 'standard-value)
21632 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21633 (push v list)))))
21634 (kill-buffer (get-buffer "*Warn about privacy*"))
21635 list))
21636 nil nil
21637 "Remember to cover the basics, that is, what you expected to happen and
21638 what in fact did happen. You don't know how to make a good report? See
21640 http://orgmode.org/manual/Feedback.html#Feedback
21642 Your bug report will be posted to the Org-mode mailing list.
21643 ------------------------------------------------------------------------")
21644 (save-excursion
21645 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21646 (replace-match "\\1Bug: \\3 [\\2]")))))
21649 (defun org-install-agenda-files-menu ()
21650 (let ((bl (buffer-list)))
21651 (save-excursion
21652 (while bl
21653 (set-buffer (pop bl))
21654 (if (derived-mode-p 'org-mode) (setq bl nil)))
21655 (when (derived-mode-p 'org-mode)
21656 (easy-menu-change
21657 '("Org") "File List for Agenda"
21658 (append
21659 (list
21660 ["Edit File List" (org-edit-agenda-file-list) t]
21661 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21662 ["Remove Current File from List" org-remove-file t]
21663 ["Cycle through agenda files" org-cycle-agenda-files t]
21664 ["Occur in all agenda files" org-occur-in-agenda-files t]
21665 "--")
21666 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21668 ;;;; Documentation
21670 (defun org-require-autoloaded-modules ()
21671 (interactive)
21672 (mapc 'require
21673 '(org-agenda org-archive org-attach org-clock org-colview org-id
21674 org-table org-timer)))
21676 ;;;###autoload
21677 (defun org-reload (&optional uncompiled)
21678 "Reload all org lisp files.
21679 With prefix arg UNCOMPILED, load the uncompiled versions."
21680 (interactive "P")
21681 (require 'loadhist)
21682 (let* ((org-dir (org-find-library-dir "org"))
21683 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21684 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21685 (remove-re (mapconcat 'identity
21686 (mapcar (lambda (f) (concat "^" f "$"))
21687 (list (if (featurep 'xemacs)
21688 "org-colview"
21689 "org-colview-xemacs")
21690 "org" "org-loaddefs" "org-version"))
21691 "\\|"))
21692 (feats (delete-dups
21693 (mapcar 'file-name-sans-extension
21694 (mapcar 'file-name-nondirectory
21695 (delq nil
21696 (mapcar 'feature-file
21697 features))))))
21698 (lfeat (append
21699 (sort
21700 (setq feats
21701 (delq nil (mapcar
21702 (lambda (f)
21703 (if (and (string-match feature-re f)
21704 (not (string-match remove-re f)))
21705 f nil))
21706 feats)))
21707 'string-lessp)
21708 (list "org-version" "org")))
21709 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21710 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21711 load-uncore load-misses)
21712 (setq load-misses
21713 (delq 't
21714 (mapcar (lambda (f)
21715 (or (org-load-noerror-mustsuffix (concat org-dir f))
21716 (and (string= org-dir contrib-dir)
21717 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21718 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21719 (add-to-list 'load-uncore f 'append)
21722 lfeat)))
21723 (if load-uncore
21724 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21725 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21726 (if load-misses
21727 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21728 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21729 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21731 ;;;###autoload
21732 (defun org-customize ()
21733 "Call the customize function with org as argument."
21734 (interactive)
21735 (org-load-modules-maybe)
21736 (org-require-autoloaded-modules)
21737 (customize-browse 'org))
21739 (defun org-create-customize-menu ()
21740 "Create a full customization menu for Org-mode, insert it into the menu."
21741 (interactive)
21742 (org-load-modules-maybe)
21743 (org-require-autoloaded-modules)
21744 (if (fboundp 'customize-menu-create)
21745 (progn
21746 (easy-menu-change
21747 '("Org") "Customize"
21748 `(["Browse Org group" org-customize t]
21749 "--"
21750 ,(customize-menu-create 'org)
21751 ["Set" Custom-set t]
21752 ["Save" Custom-save t]
21753 ["Reset to Current" Custom-reset-current t]
21754 ["Reset to Saved" Custom-reset-saved t]
21755 ["Reset to Standard Settings" Custom-reset-standard t]))
21756 (message "\"Org\"-menu now contains full customization menu"))
21757 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21759 ;;;; Miscellaneous stuff
21761 ;;; Generally useful functions
21763 (defsubst org-get-at-eol (property n)
21764 "Get text property PROPERTY at the end of line less N characters."
21765 (get-text-property (- (point-at-eol) n) property))
21767 (defun org-find-text-property-in-string (prop s)
21768 "Return the first non-nil value of property PROP in string S."
21769 (or (get-text-property 0 prop s)
21770 (get-text-property (or (next-single-property-change 0 prop s) 0)
21771 prop s)))
21773 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21774 "Display the given MESSAGE as a warning."
21775 (if (fboundp 'display-warning)
21776 (display-warning 'org message
21777 (if (featurep 'xemacs) 'warning :warning))
21778 (let ((buf (get-buffer-create "*Org warnings*")))
21779 (with-current-buffer buf
21780 (goto-char (point-max))
21781 (insert "Warning (Org): " message)
21782 (unless (bolp)
21783 (newline)))
21784 (display-buffer buf)
21785 (sit-for 0))))
21787 (defun org-eval (form)
21788 "Eval FORM and return result."
21789 (condition-case error
21790 (eval form)
21791 (error (format "%%![Error: %s]" error))))
21793 (defun org-in-clocktable-p ()
21794 "Check if the cursor is in a clocktable."
21795 (let ((pos (point)) start)
21796 (save-excursion
21797 (end-of-line 1)
21798 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21799 (setq start (match-beginning 0))
21800 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21801 (>= (match-end 0) pos)
21802 start))))
21804 (defun org-in-verbatim-emphasis ()
21805 (save-match-data
21806 (and (org-in-regexp org-emph-re 2)
21807 (>= (point) (match-beginning 3))
21808 (<= (point) (match-end 4))
21809 (member (match-string 3) '("=" "~")))))
21811 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21812 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21813 (if (and marker (marker-buffer marker)
21814 (buffer-live-p (marker-buffer marker)))
21815 (progn
21816 (org-pop-to-buffer-same-window (marker-buffer marker))
21817 (if (or (> marker (point-max)) (< marker (point-min)))
21818 (widen))
21819 (goto-char marker)
21820 (org-show-context 'org-goto))
21821 (if bookmark
21822 (bookmark-jump bookmark)
21823 (error "Cannot find location"))))
21825 (defun org-quote-csv-field (s)
21826 "Quote field for inclusion in CSV material."
21827 (if (string-match "[\",]" s)
21828 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21831 (defun org-force-self-insert (N)
21832 "Needed to enforce self-insert under remapping."
21833 (interactive "p")
21834 (self-insert-command N))
21836 (defun org-string-width (s)
21837 "Compute width of string, ignoring invisible characters.
21838 This ignores character with invisibility property `org-link', and also
21839 characters with property `org-cwidth', because these will become invisible
21840 upon the next fontification round."
21841 (let (b l)
21842 (when (or (eq t buffer-invisibility-spec)
21843 (assq 'org-link buffer-invisibility-spec))
21844 (while (setq b (text-property-any 0 (length s)
21845 'invisible 'org-link s))
21846 (setq s (concat (substring s 0 b)
21847 (substring s (or (next-single-property-change
21848 b 'invisible s) (length s)))))))
21849 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21850 (setq s (concat (substring s 0 b)
21851 (substring s (or (next-single-property-change
21852 b 'org-cwidth s) (length s))))))
21853 (setq l (string-width s) b -1)
21854 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21855 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21858 (defun org-shorten-string (s maxlength)
21859 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21860 If the string is shorter or has length MAXLENGTH, just return the
21861 original string. If it is longer, the functions finds a space in the
21862 string, breaks this string off at that locations and adds three dots
21863 as ellipsis. Including the ellipsis, the string will not be longer
21864 than MAXLENGTH. If finding a good breaking point in the string does
21865 not work, the string is just chopped off in the middle of a word
21866 if necessary."
21867 (if (<= (length s) maxlength)
21869 (let* ((n (max (- maxlength 4) 1))
21870 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21871 (if (string-match re s)
21872 (concat (match-string 1 s) "...")
21873 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21875 (defun org-get-indentation (&optional line)
21876 "Get the indentation of the current line, interpreting tabs.
21877 When LINE is given, assume it represents a line and compute its indentation."
21878 (if line
21879 (if (string-match "^ *" (org-remove-tabs line))
21880 (match-end 0))
21881 (save-excursion
21882 (beginning-of-line 1)
21883 (skip-chars-forward " \t")
21884 (current-column))))
21886 (defun org-get-string-indentation (s)
21887 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21888 (let ((n -1) (i 0) (w tab-width) c)
21889 (catch 'exit
21890 (while (< (setq n (1+ n)) (length s))
21891 (setq c (aref s n))
21892 (cond ((= c ?\ ) (setq i (1+ i)))
21893 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21894 (t (throw 'exit t)))))
21897 (defun org-remove-tabs (s &optional width)
21898 "Replace tabulators in S with spaces.
21899 Assumes that s is a single line, starting in column 0."
21900 (setq width (or width tab-width))
21901 (while (string-match "\t" s)
21902 (setq s (replace-match
21903 (make-string
21904 (- (* width (/ (+ (match-beginning 0) width) width))
21905 (match-beginning 0)) ?\ )
21906 t t s)))
21909 (defun org-fix-indentation (line ind)
21910 "Fix indentation in LINE.
21911 IND is a cons cell with target and minimum indentation.
21912 If the current indentation in LINE is smaller than the minimum,
21913 leave it alone. If it is larger than ind, set it to the target."
21914 (let* ((l (org-remove-tabs line))
21915 (i (org-get-indentation l))
21916 (i1 (car ind)) (i2 (cdr ind)))
21917 (if (>= i i2) (setq l (substring line i2)))
21918 (if (> i1 0)
21919 (concat (make-string i1 ?\ ) l)
21920 l)))
21922 (defun org-remove-indentation (code &optional n)
21923 "Remove the maximum common indentation from the lines in CODE.
21924 N may optionally be the number of spaces to remove."
21925 (with-temp-buffer
21926 (insert code)
21927 (org-do-remove-indentation n)
21928 (buffer-string)))
21930 (defun org-do-remove-indentation (&optional n)
21931 "Remove the maximum common indentation from the buffer."
21932 (untabify (point-min) (point-max))
21933 (let ((min 10000) re)
21934 (if n
21935 (setq min n)
21936 (goto-char (point-min))
21937 (while (re-search-forward "^ *[^ \n]" nil t)
21938 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21939 (unless (or (= min 0) (= min 10000))
21940 (setq re (format "^ \\{%d\\}" min))
21941 (goto-char (point-min))
21942 (while (re-search-forward re nil t)
21943 (replace-match "")
21944 (end-of-line 1))
21945 min)))
21947 (defun org-fill-template (template alist)
21948 "Find each %key of ALIST in TEMPLATE and replace it."
21949 (let ((case-fold-search nil)
21950 entry key value)
21951 (setq alist (sort (copy-sequence alist)
21952 (lambda (a b) (< (length (car a)) (length (car b))))))
21953 (while (setq entry (pop alist))
21954 (setq template
21955 (replace-regexp-in-string
21956 (concat "%" (regexp-quote (car entry)))
21957 (or (cdr entry) "") template t t)))
21958 template))
21960 (defun org-base-buffer (buffer)
21961 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21962 (if (not buffer)
21963 buffer
21964 (or (buffer-base-buffer buffer)
21965 buffer)))
21967 (defun org-wrap (string &optional width lines)
21968 "Wrap string to either a number of lines, or a width in characters.
21969 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21970 that costs. If there is a word longer than WIDTH, the text is actually
21971 wrapped to the length of that word.
21972 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21973 many lines, whatever width that takes.
21974 The return value is a list of lines, without newlines at the end."
21975 (let* ((words (org-split-string string "[ \t\n]+"))
21976 (maxword (apply 'max (mapcar 'org-string-width words)))
21977 w ll)
21978 (cond (width
21979 (org-do-wrap words (max maxword width)))
21980 (lines
21981 (setq w maxword)
21982 (setq ll (org-do-wrap words maxword))
21983 (if (<= (length ll) lines)
21985 (setq ll words)
21986 (while (> (length ll) lines)
21987 (setq w (1+ w))
21988 (setq ll (org-do-wrap words w)))
21989 ll))
21990 (t (error "Cannot wrap this")))))
21992 (defun org-do-wrap (words width)
21993 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21994 (let (lines line)
21995 (while words
21996 (setq line (pop words))
21997 (while (and words (< (+ (length line) (length (car words))) width))
21998 (setq line (concat line " " (pop words))))
21999 (setq lines (push line lines)))
22000 (nreverse lines)))
22002 (defun org-split-string (string &optional separators)
22003 "Splits STRING into substrings at SEPARATORS.
22004 No empty strings are returned if there are matches at the beginning
22005 and end of string."
22006 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
22007 (start 0)
22008 notfirst
22009 (list nil))
22010 (while (and (string-match rexp string
22011 (if (and notfirst
22012 (= start (match-beginning 0))
22013 (< start (length string)))
22014 (1+ start) start))
22015 (< (match-beginning 0) (length string)))
22016 (setq notfirst t)
22017 (or (eq (match-beginning 0) 0)
22018 (and (eq (match-beginning 0) (match-end 0))
22019 (eq (match-beginning 0) start))
22020 (setq list
22021 (cons (substring string start (match-beginning 0))
22022 list)))
22023 (setq start (match-end 0)))
22024 (or (eq start (length string))
22025 (setq list
22026 (cons (substring string start)
22027 list)))
22028 (nreverse list)))
22030 (defun org-quote-vert (s)
22031 "Replace \"|\" with \"\\vert\"."
22032 (while (string-match "|" s)
22033 (setq s (replace-match "\\vert" t t s)))
22036 (defun org-uuidgen-p (s)
22037 "Is S an ID created by UUIDGEN?"
22038 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22040 (defun org-in-src-block-p (&optional inside)
22041 "Whether point is in a code source block.
22042 When INSIDE is non-nil, don't consider we are within a src block
22043 when point is at #+BEGIN_SRC or #+END_SRC."
22044 (let ((case-fold-search t) ov)
22045 (or (and (eq (get-char-property (point) 'src-block) t))
22046 (and (not inside)
22047 (save-match-data
22048 (save-excursion
22049 (beginning-of-line)
22050 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22052 (defun org-context ()
22053 "Return a list of contexts of the current cursor position.
22054 If several contexts apply, all are returned.
22055 Each context entry is a list with a symbol naming the context, and
22056 two positions indicating start and end of the context. Possible
22057 contexts are:
22059 :headline anywhere in a headline
22060 :headline-stars on the leading stars in a headline
22061 :todo-keyword on a TODO keyword (including DONE) in a headline
22062 :tags on the TAGS in a headline
22063 :priority on the priority cookie in a headline
22064 :item on the first line of a plain list item
22065 :item-bullet on the bullet/number of a plain list item
22066 :checkbox on the checkbox in a plain list item
22067 :table in an org-mode table
22068 :table-special on a special filed in a table
22069 :table-table in a table.el table
22070 :clocktable in a clocktable
22071 :src-block in a source block
22072 :link on a hyperlink
22073 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22074 :target on a <<target>>
22075 :radio-target on a <<<radio-target>>>
22076 :latex-fragment on a LaTeX fragment
22077 :latex-preview on a LaTeX fragment with overlaid preview image
22079 This function expects the position to be visible because it uses font-lock
22080 faces as a help to recognize the following contexts: :table-special, :link,
22081 and :keyword."
22082 (let* ((f (get-text-property (point) 'face))
22083 (faces (if (listp f) f (list f)))
22084 (case-fold-search t)
22085 (p (point)) clist o)
22086 ;; First the large context
22087 (cond
22088 ((org-at-heading-p t)
22089 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22090 (when (progn
22091 (beginning-of-line 1)
22092 (looking-at org-todo-line-tags-regexp))
22093 (push (org-point-in-group p 1 :headline-stars) clist)
22094 (push (org-point-in-group p 2 :todo-keyword) clist)
22095 (push (org-point-in-group p 4 :tags) clist))
22096 (goto-char p)
22097 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22098 (if (looking-at "\\[#[A-Z0-9]\\]")
22099 (push (org-point-in-group p 0 :priority) clist)))
22101 ((org-at-item-p)
22102 (push (org-point-in-group p 2 :item-bullet) clist)
22103 (push (list :item (point-at-bol)
22104 (save-excursion (org-end-of-item) (point)))
22105 clist)
22106 (and (org-at-item-checkbox-p)
22107 (push (org-point-in-group p 0 :checkbox) clist)))
22109 ((org-at-table-p)
22110 (push (list :table (org-table-begin) (org-table-end)) clist)
22111 (if (memq 'org-formula faces)
22112 (push (list :table-special
22113 (previous-single-property-change p 'face)
22114 (next-single-property-change p 'face)) clist)))
22115 ((org-at-table-p 'any)
22116 (push (list :table-table) clist)))
22117 (goto-char p)
22119 (let ((case-fold-search t))
22120 ;; New the "medium" contexts: clocktables, source blocks
22121 (cond ((org-in-clocktable-p)
22122 (push (list :clocktable
22123 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22124 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22125 (match-beginning 1))
22126 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22127 (match-end 0))) clist))
22128 ((org-in-src-block-p)
22129 (push (list :src-block
22130 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22131 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22132 (match-beginning 1))
22133 (and (search-forward "#+END_SRC" nil t)
22134 (match-beginning 0))) clist))))
22135 (goto-char p)
22137 ;; Now the small context
22138 (cond
22139 ((org-at-timestamp-p)
22140 (push (org-point-in-group p 0 :timestamp) clist))
22141 ((memq 'org-link faces)
22142 (push (list :link
22143 (previous-single-property-change p 'face)
22144 (next-single-property-change p 'face)) clist))
22145 ((memq 'org-special-keyword faces)
22146 (push (list :keyword
22147 (previous-single-property-change p 'face)
22148 (next-single-property-change p 'face)) clist))
22149 ((org-at-target-p)
22150 (push (org-point-in-group p 0 :target) clist)
22151 (goto-char (1- (match-beginning 0)))
22152 (if (looking-at org-radio-target-regexp)
22153 (push (org-point-in-group p 0 :radio-target) clist))
22154 (goto-char p))
22155 ((setq o (car (delq nil
22156 (mapcar
22157 (lambda (x)
22158 (if (memq x org-latex-fragment-image-overlays) x))
22159 (overlays-at (point))))))
22160 (push (list :latex-fragment
22161 (overlay-start o) (overlay-end o)) clist)
22162 (push (list :latex-preview
22163 (overlay-start o) (overlay-end o)) clist))
22164 ((org-inside-LaTeX-fragment-p)
22165 ;; FIXME: positions wrong.
22166 (push (list :latex-fragment (point) (point)) clist)))
22168 (setq clist (nreverse (delq nil clist)))
22169 clist))
22171 ;; FIXME: Compare with at-regexp-p Do we need both?
22172 (defun org-in-regexp (re &optional nlines visually)
22173 "Check if point is inside a match of regexp.
22174 Normally only the current line is checked, but you can include NLINES extra
22175 lines both before and after point into the search.
22176 If VISUALLY is set, require that the cursor is not after the match but
22177 really on, so that the block visually is on the match."
22178 (catch 'exit
22179 (let ((pos (point))
22180 (eol (point-at-eol (+ 1 (or nlines 0))))
22181 (inc (if visually 1 0)))
22182 (save-excursion
22183 (beginning-of-line (- 1 (or nlines 0)))
22184 (while (re-search-forward re eol t)
22185 (if (and (<= (match-beginning 0) pos)
22186 (>= (+ inc (match-end 0)) pos))
22187 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22189 (defun org-at-regexp-p (regexp)
22190 "Is point inside a match of REGEXP in the current line?"
22191 (catch 'exit
22192 (save-excursion
22193 (let ((pos (point)) (end (point-at-eol)))
22194 (beginning-of-line 1)
22195 (while (re-search-forward regexp end t)
22196 (if (and (<= (match-beginning 0) pos)
22197 (>= (match-end 0) pos))
22198 (throw 'exit t)))
22199 nil))))
22201 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22202 "Non-nil when point is between matches of START-RE and END-RE.
22204 Also return a non-nil value when point is on one of the matches.
22206 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22207 buffer positions. Default values are the positions of headlines
22208 surrounding the point.
22210 The functions returns a cons cell whose car (resp. cdr) is the
22211 position before START-RE (resp. after END-RE)."
22212 (save-match-data
22213 (let ((pos (point))
22214 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22215 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22216 beg end)
22217 (save-excursion
22218 ;; Point is on a block when on START-RE or if START-RE can be
22219 ;; found before it...
22220 (and (or (org-at-regexp-p start-re)
22221 (re-search-backward start-re limit-up t))
22222 (setq beg (match-beginning 0))
22223 ;; ... and END-RE after it...
22224 (goto-char (match-end 0))
22225 (re-search-forward end-re limit-down t)
22226 (> (setq end (match-end 0)) pos)
22227 ;; ... without another START-RE in-between.
22228 (goto-char (match-beginning 0))
22229 (not (re-search-backward start-re (1+ beg) t))
22230 ;; Return value.
22231 (cons beg end))))))
22233 (defun org-in-block-p (names)
22234 "Non-nil when point belongs to a block whose name belongs to NAMES.
22236 NAMES is a list of strings containing names of blocks.
22238 Return first block name matched, or nil. Beware that in case of
22239 nested blocks, the returned name may not belong to the closest
22240 block from point."
22241 (save-match-data
22242 (catch 'exit
22243 (let ((case-fold-search t)
22244 (lim-up (save-excursion (outline-previous-heading)))
22245 (lim-down (save-excursion (outline-next-heading))))
22246 (mapc (lambda (name)
22247 (let ((n (regexp-quote name)))
22248 (when (org-between-regexps-p
22249 (concat "^[ \t]*#\\+begin_" n)
22250 (concat "^[ \t]*#\\+end_" n)
22251 lim-up lim-down)
22252 (throw 'exit n))))
22253 names))
22254 nil)))
22256 (defun org-in-drawer-p ()
22257 "Non-nil if point is within a drawer.
22258 If point is within a drawer, return it, as parsed data."
22259 (let ((element (save-match-data (org-element-at-point))))
22260 (while (and element (not (memq (org-element-type element)
22261 '(drawer property-drawer))))
22262 (setq element (org-element-property :parent element)))
22263 element))
22265 (defun org-occur-in-agenda-files (regexp &optional nlines)
22266 "Call `multi-occur' with buffers for all agenda files."
22267 (interactive "sOrg-files matching: \np")
22268 (let* ((files (org-agenda-files))
22269 (tnames (mapcar 'file-truename files))
22270 (extra org-agenda-text-search-extra-files)
22272 (when (eq (car extra) 'agenda-archives)
22273 (setq extra (cdr extra))
22274 (setq files (org-add-archive-files files)))
22275 (while (setq f (pop extra))
22276 (unless (member (file-truename f) tnames)
22277 (add-to-list 'files f 'append)
22278 (add-to-list 'tnames (file-truename f) 'append)))
22279 (multi-occur
22280 (mapcar (lambda (x)
22281 (with-current-buffer
22282 (or (get-file-buffer x) (find-file-noselect x))
22283 (widen)
22284 (current-buffer)))
22285 files)
22286 regexp)))
22288 (if (boundp 'occur-mode-find-occurrence-hook)
22289 ;; Emacs 23
22290 (add-hook 'occur-mode-find-occurrence-hook
22291 (lambda ()
22292 (when (derived-mode-p 'org-mode)
22293 (org-reveal))))
22294 ;; Emacs 22
22295 (defadvice occur-mode-goto-occurrence
22296 (after org-occur-reveal activate)
22297 (and (derived-mode-p 'org-mode) (org-reveal)))
22298 (defadvice occur-mode-goto-occurrence-other-window
22299 (after org-occur-reveal activate)
22300 (and (derived-mode-p 'org-mode) (org-reveal)))
22301 (defadvice occur-mode-display-occurrence
22302 (after org-occur-reveal activate)
22303 (when (derived-mode-p 'org-mode)
22304 (let ((pos (occur-mode-find-occurrence)))
22305 (with-current-buffer (marker-buffer pos)
22306 (save-excursion
22307 (goto-char pos)
22308 (org-reveal)))))))
22310 (defun org-occur-link-in-agenda-files ()
22311 "Create a link and search for it in the agendas.
22312 The link is not stored in `org-stored-links', it is just created
22313 for the search purpose."
22314 (interactive)
22315 (let ((link (condition-case nil
22316 (org-store-link nil)
22317 (error "Unable to create a link to here"))))
22318 (org-occur-in-agenda-files (regexp-quote link))))
22320 (defun org-reverse-string (string)
22321 "Return the reverse of STRING."
22322 (apply 'string (reverse (string-to-list string))))
22324 ;; defsubst org-uniquify must be defined before first use
22326 (defun org-uniquify-alist (alist)
22327 "Merge elements of ALIST with the same key.
22329 For example, in this alist:
22331 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22332 => '((a 1 3) (b 2))
22334 merge (a 1) and (a 3) into (a 1 3).
22336 The function returns the new ALIST."
22337 (let (rtn)
22338 (mapc
22339 (lambda (e)
22340 (let (n)
22341 (if (not (assoc (car e) rtn))
22342 (push e rtn)
22343 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22344 (setq rtn (assq-delete-all (car e) rtn))
22345 (push n rtn))))
22346 alist)
22347 rtn))
22349 (defun org-delete-all (elts list)
22350 "Remove all elements in ELTS from LIST."
22351 (while elts
22352 (setq list (delete (pop elts) list)))
22353 list)
22355 (defun org-count (cl-item cl-seq)
22356 "Count the number of occurrences of ITEM in SEQ.
22357 Taken from `count' in cl-seq.el with all keyword arguments removed."
22358 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22359 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22360 (while (< cl-start cl-end)
22361 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22362 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22363 (setq cl-start (1+ cl-start)))
22364 cl-count))
22366 (defun org-remove-if (predicate seq)
22367 "Remove everything from SEQ that fulfills PREDICATE."
22368 (let (res e)
22369 (while seq
22370 (setq e (pop seq))
22371 (if (not (funcall predicate e)) (push e res)))
22372 (nreverse res)))
22374 (defun org-remove-if-not (predicate seq)
22375 "Remove everything from SEQ that does not fulfill PREDICATE."
22376 (let (res e)
22377 (while seq
22378 (setq e (pop seq))
22379 (if (funcall predicate e) (push e res)))
22380 (nreverse res)))
22382 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22383 "Reduce two-argument FUNCTION across SEQ.
22384 Taken from `reduce' in cl-seq.el with all keyword arguments but
22385 \":initial-value\" removed."
22386 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22387 (cadr (memq :initial-value cl-keys)))
22388 (cl-seq (pop cl-seq))
22389 (t (funcall cl-func)))))
22390 (while cl-seq
22391 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22392 cl-accum))
22394 (defun org-every (pred seq)
22395 "Return true if PREDICATE is true of every element of SEQ.
22396 Adapted from `every' in cl.el."
22397 (catch 'org-every
22398 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22401 (defun org-some (pred seq)
22402 "Return true if PREDICATE is true of any element of SEQ.
22403 Adapted from `some' in cl.el."
22404 (catch 'org-some
22405 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22406 nil))
22408 (defun org-back-over-empty-lines ()
22409 "Move backwards over whitespace, to the beginning of the first empty line.
22410 Returns the number of empty lines passed."
22411 (let ((pos (point)))
22412 (if (cdr (assoc 'heading org-blank-before-new-entry))
22413 (skip-chars-backward " \t\n\r")
22414 (unless (eobp)
22415 (forward-line -1)))
22416 (beginning-of-line 2)
22417 (goto-char (min (point) pos))
22418 (count-lines (point) pos)))
22420 (defun org-skip-whitespace ()
22421 (skip-chars-forward " \t\n\r"))
22423 (defun org-point-in-group (point group &optional context)
22424 "Check if POINT is in match-group GROUP.
22425 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22426 match. If the match group does not exist or point is not inside it,
22427 return nil."
22428 (and (match-beginning group)
22429 (>= point (match-beginning group))
22430 (<= point (match-end group))
22431 (if context
22432 (list context (match-beginning group) (match-end group))
22433 t)))
22435 (defun org-switch-to-buffer-other-window (&rest args)
22436 "Switch to buffer in a second window on the current frame.
22437 In particular, do not allow pop-up frames.
22438 Returns the newly created buffer."
22439 (org-no-popups
22440 (apply 'switch-to-buffer-other-window args)))
22442 (defun org-combine-plists (&rest plists)
22443 "Create a single property list from all plists in PLISTS.
22444 The process starts by copying the first list, and then setting properties
22445 from the other lists. Settings in the last list are the most significant
22446 ones and overrule settings in the other lists."
22447 (let ((rtn (copy-sequence (pop plists)))
22448 p v ls)
22449 (while plists
22450 (setq ls (pop plists))
22451 (while ls
22452 (setq p (pop ls) v (pop ls))
22453 (setq rtn (plist-put rtn p v))))
22454 rtn))
22456 (defun org-replace-escapes (string table)
22457 "Replace %-escapes in STRING with values in TABLE.
22458 TABLE is an association list with keys like \"%a\" and string values.
22459 The sequences in STRING may contain normal field width and padding information,
22460 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22461 so values can contain further %-escapes if they are define later in TABLE."
22462 (let ((tbl (copy-alist table))
22463 (case-fold-search nil)
22464 (pchg 0)
22465 e re rpl)
22466 (while (setq e (pop tbl))
22467 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22468 (when (and (cdr e) (string-match re (cdr e)))
22469 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22470 (safe "SREF"))
22471 (add-text-properties 0 3 (list 'sref sref) safe)
22472 (setcdr e (replace-match safe t t (cdr e)))))
22473 (while (string-match re string)
22474 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22475 (cdr e)))
22476 (setq string (replace-match rpl t t string))))
22477 (while (setq pchg (next-property-change pchg string))
22478 (let ((sref (get-text-property pchg 'sref string)))
22479 (when (and sref (string-match "SREF" string pchg))
22480 (setq string (replace-match sref t t string)))))
22481 string))
22483 (defun org-sublist (list start end)
22484 "Return a section of LIST, from START to END.
22485 Counting starts at 1."
22486 (let (rtn (c start))
22487 (setq list (nthcdr (1- start) list))
22488 (while (and list (<= c end))
22489 (push (pop list) rtn)
22490 (setq c (1+ c)))
22491 (nreverse rtn)))
22493 (defun org-find-base-buffer-visiting (file)
22494 "Like `find-buffer-visiting' but always return the base buffer and
22495 not an indirect buffer."
22496 (let ((buf (or (get-file-buffer file)
22497 (find-buffer-visiting file))))
22498 (if buf
22499 (or (buffer-base-buffer buf) buf)
22500 nil)))
22502 (defun org-image-file-name-regexp (&optional extensions)
22503 "Return regexp matching the file names of images.
22504 If EXTENSIONS is given, only match these."
22505 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22506 (image-file-name-regexp)
22507 (let ((image-file-name-extensions
22508 (or extensions
22509 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22510 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22511 (concat "\\."
22512 (regexp-opt (nconc (mapcar 'upcase
22513 image-file-name-extensions)
22514 image-file-name-extensions)
22516 "\\'"))))
22518 (defun org-file-image-p (file &optional extensions)
22519 "Return non-nil if FILE is an image."
22520 (save-match-data
22521 (string-match (org-image-file-name-regexp extensions) file)))
22523 (defun org-get-cursor-date (&optional with-time)
22524 "Return the date at cursor in as a time.
22525 This works in the calendar and in the agenda, anywhere else it just
22526 returns the current time.
22527 If WITH-TIME is non-nil, returns the time of the event at point (in
22528 the agenda) or the current time of the day."
22529 (let (date day defd tp tm hod mod)
22530 (when with-time
22531 (setq tp (get-text-property (point) 'time))
22532 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22533 (setq hod (string-to-number (match-string 1 tp))
22534 mod (string-to-number (match-string 2 tp))))
22535 (or tp (setq hod (nth 2 (decode-time (current-time)))
22536 mod (nth 1 (decode-time (current-time))))))
22537 (cond
22538 ((eq major-mode 'calendar-mode)
22539 (setq date (calendar-cursor-to-date)
22540 defd (encode-time 0 (or mod 0) (or hod 0)
22541 (nth 1 date) (nth 0 date) (nth 2 date))))
22542 ((eq major-mode 'org-agenda-mode)
22543 (setq day (get-text-property (point) 'day))
22544 (if day
22545 (setq date (calendar-gregorian-from-absolute day)
22546 defd (encode-time 0 (or mod 0) (or hod 0)
22547 (nth 1 date) (nth 0 date) (nth 2 date))))))
22548 (or defd (current-time))))
22550 (defun org-mark-subtree (&optional up)
22551 "Mark the current subtree.
22552 This puts point at the start of the current subtree, and mark at
22553 the end. If a numeric prefix UP is given, move up into the
22554 hierarchy of headlines by UP levels before marking the subtree."
22555 (interactive "P")
22556 (org-with-limited-levels
22557 (cond ((org-at-heading-p) (beginning-of-line))
22558 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22559 (t (outline-previous-visible-heading 1))))
22560 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22561 (if (org-called-interactively-p 'any)
22562 (call-interactively 'org-mark-element)
22563 (org-mark-element)))
22566 ;;; Indentation
22568 (defun org--get-expected-indentation (element contentsp)
22569 "Expected indentation column for current line, according to ELEMENT.
22570 ELEMENT is an element containing point. CONTENTSP is non-nil
22571 when indentation is to be computed according to contents of
22572 ELEMENT."
22573 (let ((type (org-element-type element))
22574 (start (org-element-property :begin element)))
22575 (org-with-wide-buffer
22576 (cond
22577 (contentsp
22578 (case type
22579 (footnote-definition 0)
22580 ((headline inlinetask nil)
22581 (if (not org-adapt-indentation) 0
22582 (let ((level (org-current-level)))
22583 (if level (1+ level) 0))))
22584 (item
22585 (org-list-item-body-column
22586 (org-element-property :post-affiliated element)))
22587 (plain-list
22588 (save-excursion
22589 (goto-char (org-element-property :post-affiliated element))
22590 (org-get-indentation)))
22591 (otherwise
22592 (goto-char start)
22593 (org-get-indentation))))
22594 ((memq type '(headline inlinetask nil))
22595 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22596 (org--get-expected-indentation element t)
22598 ((eq type 'footnote-definition) 0)
22599 ;; First paragraph of a footnote definition or an item.
22600 ;; Indent like parent.
22601 ((< (line-beginning-position) start)
22602 (org--get-expected-indentation
22603 (org-element-property :parent element) t))
22604 ;; At first line: indent according to previous sibling, if any,
22605 ;; ignoring footnote definitions and inline tasks, or parent's
22606 ;; contents.
22607 ((= (line-beginning-position) start)
22608 (catch 'exit
22609 (while t
22610 (if (= (point-min) start) (throw 'exit 0)
22611 (goto-char (1- start))
22612 (let* ((previous (org-element-at-point))
22613 (parent previous))
22614 (while (and parent (<= (org-element-property :end parent) start))
22615 (setq previous parent
22616 parent (org-element-property :parent parent)))
22617 (cond
22618 ((not previous) (throw 'exit 0))
22619 ((> (org-element-property :end previous) start)
22620 (throw 'exit (org--get-expected-indentation previous t)))
22621 ((memq (org-element-type previous)
22622 '(footnote-definition inlinetask))
22623 (setq start (org-element-property :begin previous)))
22624 (t (goto-char (org-element-property :begin previous))
22625 (throw 'exit
22626 (if (bolp) (org-get-indentation)
22627 ;; At first paragraph in an item or
22628 ;; a footnote definition.
22629 (org--get-expected-indentation
22630 (org-element-property :parent previous) t))))))))))
22631 ;; Otherwise, move to the first non-blank line above.
22633 (beginning-of-line)
22634 (let ((pos (point)))
22635 (skip-chars-backward " \r\t\n")
22636 (cond
22637 ;; Two blank lines end a footnote definition or a plain
22638 ;; list. When we indent an empty line after them, the
22639 ;; containing list or footnote definition is over, so it
22640 ;; qualifies as a previous sibling. Therefore, we indent
22641 ;; like its first line.
22642 ((and (memq type '(footnote-definition plain-list))
22643 (> (count-lines (point) pos) 2))
22644 (goto-char start)
22645 (org-get-indentation))
22646 ;; Line above is the first one of a paragraph at the
22647 ;; beginning of an item or a footnote definition. Indent
22648 ;; like parent.
22649 ((< (line-beginning-position) start)
22650 (org--get-expected-indentation
22651 (org-element-property :parent element) t))
22652 ;; POS is after contents in a greater element. Indent like
22653 ;; the beginning of the element.
22655 ;; As a special case, if point is at the end of a footnote
22656 ;; definition or an item, indent like the very last element
22657 ;; within.
22658 ((and (not (eq type 'paragraph))
22659 (let ((cend (org-element-property :contents-end element)))
22660 (and cend (<= cend pos))))
22661 (if (memq type '(footnote-definition item plain-list))
22662 (org--get-expected-indentation (org-element-at-point) nil)
22663 (goto-char start)
22664 (org-get-indentation)))
22665 ;; In any other case, indent like the current line.
22666 (t (org-get-indentation)))))))))
22668 (defun org--align-node-property ()
22669 "Align node property at point.
22670 Alignment is done according to `org-property-format', which see."
22671 (when (save-excursion
22672 (beginning-of-line)
22673 (looking-at org-property-re))
22674 (replace-match
22675 (concat (match-string 4)
22676 (org-trim
22677 (format org-property-format (match-string 1) (match-string 3))))
22678 t t)))
22680 (defun org-indent-line ()
22681 "Indent line depending on context.
22683 Indentation is done according to the following rules:
22685 - Footnote definitions, headlines and inline tasks have to
22686 start at column 0.
22688 - On the very first line of an element, consider, in order, the
22689 next rules until one matches:
22691 1. If there's a sibling element before, ignoring footnote
22692 definitions and inline tasks, indent like its first line.
22694 2. If element has a parent, indent like its contents. More
22695 precisely, if parent is an item, indent after the
22696 description part, if any, or the bullet (see
22697 `org-list-description-max-indent'). Else, indent like
22698 parent's first line.
22700 3. Otherwise, indent relatively to current level, if
22701 `org-adapt-indentation' is non-nil, or to left margin.
22703 - On a blank line at the end of an element, indent according to
22704 the type of the element. More precisely
22706 1. If element is a plain list, an item, or a footnote
22707 definition, indent like the very last element within.
22709 2. If element is a paragraph, indent like its last non blank
22710 line.
22712 3. Otherwise, indent like its very first line.
22714 - In the code part of a source block, use language major mode
22715 to indent current line if `org-src-tab-acts-natively' is
22716 non-nil. If it is nil, do nothing.
22718 - Otherwise, indent like the first non-blank line above.
22720 The function doesn't indent an item as it could break the whole
22721 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22722 \\[org-shiftmetaright].
22724 Also align node properties according to `org-property-format'."
22725 (interactive)
22726 (cond
22727 (orgstruct-is-++
22728 (let ((indent-line-function
22729 (cadadr (assq 'indent-line-function org-fb-vars))))
22730 (indent-according-to-mode)))
22731 ((org-at-heading-p) 'noindent)
22733 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22734 (type (org-element-type element)))
22735 (cond ((and (memq type '(plain-list item))
22736 (= (line-beginning-position)
22737 (org-element-property :post-affiliated element)))
22738 'noindent)
22739 ((and (eq type 'src-block)
22740 org-src-tab-acts-natively
22741 (> (line-beginning-position)
22742 (org-element-property :post-affiliated element))
22743 (< (line-beginning-position)
22744 (org-with-wide-buffer
22745 (goto-char (org-element-property :end element))
22746 (skip-chars-backward " \r\t\n")
22747 (line-beginning-position))))
22748 (let ((org-src-strip-leading-and-trailing-blank-lines nil))
22749 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB"))))
22751 (let ((column (org--get-expected-indentation element nil)))
22752 ;; Preserve current column.
22753 (if (<= (current-column) (current-indentation))
22754 (org-indent-line-to column)
22755 (save-excursion (org-indent-line-to column))))
22756 ;; Align node property. Also preserve current column.
22757 (when (eq type 'node-property)
22758 (let ((column (current-column)))
22759 (org--align-node-property)
22760 (org-move-to-column column)))))))))
22762 (defun org-indent-region (start end)
22763 "Indent each non-blank line in the region.
22764 Called from a program, START and END specify the region to
22765 indent. The function will not indent contents of example blocks,
22766 verse blocks and export blocks as leading white spaces are
22767 assumed to be significant there."
22768 (interactive "r")
22769 (save-excursion
22770 (goto-char start)
22771 (skip-chars-forward " \r\t\n")
22772 (unless (eobp) (beginning-of-line))
22773 (let ((indent-to
22774 (lambda (ind pos)
22775 ;; Set IND as indentation for all lines between point and
22776 ;; POS or END, whichever comes first. Blank lines are
22777 ;; ignored. Leave point after POS once done.
22778 (let ((limit (copy-marker (min end pos))))
22779 (while (< (point) limit)
22780 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
22781 (forward-line))
22782 (set-marker limit nil))))
22783 (end (copy-marker end)))
22784 (while (< (point) end)
22785 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
22786 (let* ((element (org-element-at-point))
22787 (type (org-element-type element))
22788 (element-end (copy-marker (org-element-property :end element)))
22789 (ind (org--get-expected-indentation element nil)))
22790 (cond
22791 ((or (memq type '(paragraph table table-row))
22792 (not (or (org-element-property :contents-begin element)
22793 (memq type
22794 '(example-block export-block src-block)))))
22795 ;; Elements here are indented as a single block. Also
22796 ;; align node properties.
22797 (when (eq type 'node-property)
22798 (org--align-node-property)
22799 (beginning-of-line))
22800 (funcall indent-to ind element-end))
22802 ;; Elements in this category consist of three parts:
22803 ;; before the contents, the contents, and after the
22804 ;; contents. The contents are treated specially,
22805 ;; according to the element type, or not indented at
22806 ;; all. Other parts are indented as a single block.
22807 (let* ((post (copy-marker
22808 (org-element-property :post-affiliated element)))
22809 (cbeg
22810 (copy-marker
22811 (cond
22812 ((not (org-element-property :contents-begin element))
22813 ;; Fake contents for source blocks.
22814 (org-with-wide-buffer
22815 (goto-char post)
22816 (forward-line)
22817 (point)))
22818 ((memq type '(footnote-definition item plain-list))
22819 ;; Contents in these elements could start on
22820 ;; the same line as the beginning of the
22821 ;; element. Make sure we start indenting
22822 ;; from the second line.
22823 (org-with-wide-buffer
22824 (goto-char post)
22825 (end-of-line)
22826 (skip-chars-forward " \r\t\n")
22827 (if (eobp) (point) (line-beginning-position))))
22828 (t (org-element-property :contents-begin element)))))
22829 (cend (copy-marker
22830 (or (org-element-property :contents-end element)
22831 ;; Fake contents for source blocks.
22832 (org-with-wide-buffer
22833 (goto-char element-end)
22834 (skip-chars-backward " \r\t\n")
22835 (line-beginning-position))))))
22836 ;; Do not change items indentation individually as it
22837 ;; might break the list as a whole. On the other
22838 ;; hand, when at a plain list, indent it as a whole.
22839 (cond ((eq type 'plain-list)
22840 (let ((offset (- ind (org-get-indentation))))
22841 (unless (zerop offset)
22842 (indent-rigidly (org-element-property :begin element)
22843 (org-element-property :end element)
22844 offset))
22845 (goto-char cbeg)))
22846 ((eq type 'item) (goto-char cbeg))
22847 (t (funcall indent-to ind cbeg)))
22848 (when (< (point) end)
22849 (case type
22850 ((example-block export-block verse-block))
22851 (src-block
22852 ;; In a source block, indent source code
22853 ;; according to language major mode, but only if
22854 ;; `org-src-tab-acts-natively' is non-nil.
22855 (when (and (< (point) end) org-src-tab-acts-natively)
22856 (ignore-errors
22857 (let (org-src-strip-leading-and-trailing-blank-lines
22858 ;; Region boundaries in edit buffer.
22859 (start (1+ (- (point) cbeg)))
22860 (end (- (min cend end) cbeg)))
22861 (org-babel-do-in-edit-buffer
22862 (indent-region start end))))))
22863 (t (org-indent-region (point) (min cend end))))
22864 (goto-char (min cend end))
22865 (when (< (point) end) (funcall indent-to ind element-end)))
22866 (set-marker post nil)
22867 (set-marker cbeg nil)
22868 (set-marker cend nil))))
22869 (set-marker element-end nil))))
22870 (set-marker end nil))))
22872 (defun org-indent-drawer ()
22873 "Indent the drawer at point."
22874 (interactive)
22875 (unless (save-excursion
22876 (beginning-of-line)
22877 (org-looking-at-p org-drawer-regexp))
22878 (user-error "Not at a drawer"))
22879 (let ((element (org-element-at-point)))
22880 (unless (memq (org-element-type element) '(drawer property-drawer))
22881 (user-error "Not at a drawer"))
22882 (org-with-wide-buffer
22883 (org-indent-region (org-element-property :begin element)
22884 (org-element-property :end element))))
22885 (message "Drawer at point indented"))
22887 (defun org-indent-block ()
22888 "Indent the block at point."
22889 (interactive)
22890 (unless (save-excursion
22891 (beginning-of-line)
22892 (let ((case-fold-search t))
22893 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
22894 (user-error "Not at a block"))
22895 (let ((element (org-element-at-point)))
22896 (unless (memq (org-element-type element)
22897 '(comment-block center-block dynamic-block example-block
22898 export-block quote-block special-block
22899 src-block verse-block))
22900 (user-error "Not at a block"))
22901 (org-with-wide-buffer
22902 (org-indent-region (org-element-property :begin element)
22903 (org-element-property :end element))))
22904 (message "Block at point indented"))
22907 ;;; Filling
22909 ;; We use our own fill-paragraph and auto-fill functions.
22911 ;; `org-fill-paragraph' relies on adaptive filling and context
22912 ;; checking. Appropriate `fill-prefix' is computed with
22913 ;; `org-adaptive-fill-function'.
22915 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22916 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22917 ;; `org-adaptive-fill-function' value. Internally,
22918 ;; `org-comment-line-break-function' breaks the line.
22920 ;; `org-setup-filling' installs filling and auto-filling related
22921 ;; variables during `org-mode' initialization.
22923 (defvar org-element-paragraph-separate) ; org-element.el
22924 (defun org-setup-filling ()
22925 (require 'org-element)
22926 ;; Prevent auto-fill from inserting unwanted new items.
22927 (when (boundp 'fill-nobreak-predicate)
22928 (org-set-local
22929 'fill-nobreak-predicate
22930 (org-uniquify
22931 (append fill-nobreak-predicate
22932 '(org-fill-line-break-nobreak-p
22933 org-fill-paragraph-with-timestamp-nobreak-p)))))
22934 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22935 (org-set-local 'paragraph-start paragraph-ending)
22936 (org-set-local 'paragraph-separate paragraph-ending))
22937 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22938 (org-set-local 'auto-fill-inhibit-regexp nil)
22939 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22940 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22941 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22943 (defun org-fill-line-break-nobreak-p ()
22944 "Non-nil when a new line at point would create an Org line break."
22945 (save-excursion
22946 (skip-chars-backward "[ \t]")
22947 (skip-chars-backward "\\\\")
22948 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22950 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22951 "Non-nil when a new line at point would split a timestamp."
22952 (and (org-at-timestamp-p t)
22953 (not (looking-at org-ts-regexp-both))))
22955 (declare-function message-in-body-p "message" ())
22956 (defvar orgtbl-line-start-regexp) ; From org-table.el
22957 (defun org-adaptive-fill-function ()
22958 "Compute a fill prefix for the current line.
22959 Return fill prefix, as a string, or nil if current line isn't
22960 meant to be filled. For convenience, if `adaptive-fill-regexp'
22961 matches in paragraphs or comments, use it."
22962 (catch 'exit
22963 (when (derived-mode-p 'message-mode)
22964 (save-excursion
22965 (beginning-of-line)
22966 (cond ((or (not (message-in-body-p))
22967 (looking-at orgtbl-line-start-regexp))
22968 (throw 'exit nil))
22969 ((looking-at message-cite-prefix-regexp)
22970 (throw 'exit (match-string-no-properties 0)))
22971 ((looking-at org-outline-regexp)
22972 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
22973 (org-with-wide-buffer
22974 (unless (org-at-heading-p)
22975 (let* ((p (line-beginning-position))
22976 (element (save-excursion
22977 (beginning-of-line)
22978 (org-element-at-point)))
22979 (type (org-element-type element))
22980 (post-affiliated (org-element-property :post-affiliated element)))
22981 (unless (< p post-affiliated)
22982 (case type
22983 (comment
22984 (save-excursion
22985 (beginning-of-line)
22986 (looking-at "[ \t]*")
22987 (concat (match-string 0) "# ")))
22988 (footnote-definition "")
22989 ((item plain-list)
22990 (make-string (org-list-item-body-column post-affiliated) ?\s))
22991 (paragraph
22992 ;; Fill prefix is usually the same as the current line,
22993 ;; unless the paragraph is at the beginning of an item.
22994 (let ((parent (org-element-property :parent element)))
22995 (save-excursion
22996 (beginning-of-line)
22997 (cond ((eq (org-element-type parent) 'item)
22998 (make-string (org-list-item-body-column
22999 (org-element-property :begin parent))
23000 ?\s))
23001 ((and adaptive-fill-regexp
23002 ;; Locally disable
23003 ;; `adaptive-fill-function' to let
23004 ;; `fill-context-prefix' handle
23005 ;; `adaptive-fill-regexp' variable.
23006 (let (adaptive-fill-function)
23007 (fill-context-prefix
23008 post-affiliated
23009 (org-element-property :end element)))))
23010 ((looking-at "[ \t]+") (match-string 0))
23011 (t "")))))
23012 (comment-block
23013 ;; Only fill contents if P is within block boundaries.
23014 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23015 (forward-line)
23016 (point)))
23017 (cend (save-excursion
23018 (goto-char (org-element-property :end element))
23019 (skip-chars-backward " \r\t\n")
23020 (line-beginning-position))))
23021 (when (and (>= p cbeg) (< p cend))
23022 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23023 (match-string 0)
23024 "")))))))))))
23026 (declare-function message-goto-body "message" ())
23027 (defvar message-cite-prefix-regexp) ; From message.el
23028 (defun org-fill-paragraph (&optional justify)
23029 "Fill element at point, when applicable.
23031 This function only applies to comment blocks, comments, example
23032 blocks and paragraphs. Also, as a special case, re-align table
23033 when point is at one.
23035 If JUSTIFY is non-nil (interactively, with prefix argument),
23036 justify as well. If `sentence-end-double-space' is non-nil, then
23037 period followed by one space does not end a sentence, so don't
23038 break a line there. The variable `fill-column' controls the
23039 width for filling.
23041 For convenience, when point is at a plain list, an item or
23042 a footnote definition, try to fill the first paragraph within."
23043 (interactive)
23044 (if (and (derived-mode-p 'message-mode)
23045 (or (not (message-in-body-p))
23046 (save-excursion (move-beginning-of-line 1)
23047 (looking-at message-cite-prefix-regexp))))
23048 ;; First ensure filling is correct in message-mode.
23049 (let ((fill-paragraph-function
23050 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23051 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23052 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23053 (paragraph-separate
23054 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23055 (fill-paragraph nil))
23056 (with-syntax-table org-mode-transpose-word-syntax-table
23057 ;; Move to end of line in order to get the first paragraph
23058 ;; within a plain list or a footnote definition.
23059 (let ((element (save-excursion
23060 (end-of-line)
23061 (or (ignore-errors (org-element-at-point))
23062 (user-error "An element cannot be parsed line %d"
23063 (line-number-at-pos (point)))))))
23064 ;; First check if point is in a blank line at the beginning of
23065 ;; the buffer. In that case, ignore filling.
23066 (case (org-element-type element)
23067 ;; Use major mode filling function is src blocks.
23068 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23069 ;; Align Org tables, leave table.el tables as-is.
23070 (table-row (org-table-align) t)
23071 (table
23072 (when (eq (org-element-property :type element) 'org)
23073 (save-excursion
23074 (goto-char (org-element-property :post-affiliated element))
23075 (org-table-align)))
23077 (paragraph
23078 ;; Paragraphs may contain `line-break' type objects.
23079 (let ((beg (max (point-min)
23080 (org-element-property :contents-begin element)))
23081 (end (min (point-max)
23082 (org-element-property :contents-end element))))
23083 ;; Do nothing if point is at an affiliated keyword.
23084 (if (< (line-end-position) beg) t
23085 (when (derived-mode-p 'message-mode)
23086 ;; In `message-mode', do not fill following citation
23087 ;; in current paragraph nor text before message body.
23088 (let ((body-start (save-excursion (message-goto-body))))
23089 (when body-start (setq beg (max body-start beg))))
23090 (when (save-excursion
23091 (re-search-forward
23092 (concat "^" message-cite-prefix-regexp) end t))
23093 (setq end (match-beginning 0))))
23094 ;; Fill paragraph, taking line breaks into account.
23095 (save-excursion
23096 (goto-char beg)
23097 (let ((cuts (list beg)))
23098 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23099 (when (eq 'line-break
23100 (org-element-type
23101 (save-excursion (backward-char)
23102 (org-element-context))))
23103 (push (point) cuts)))
23104 (dolist (c (delq end cuts))
23105 (fill-region-as-paragraph c end justify)
23106 (setq end c))))
23107 t)))
23108 ;; Contents of `comment-block' type elements should be
23109 ;; filled as plain text, but only if point is within block
23110 ;; markers.
23111 (comment-block
23112 (let* ((case-fold-search t)
23113 (beg (save-excursion
23114 (goto-char (org-element-property :begin element))
23115 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23116 (forward-line)
23117 (point)))
23118 (end (save-excursion
23119 (goto-char (org-element-property :end element))
23120 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23121 (line-beginning-position))))
23122 (if (or (< (point) beg) (> (point) end)) t
23123 (fill-region-as-paragraph
23124 (save-excursion (end-of-line)
23125 (re-search-backward "^[ \t]*$" beg 'move)
23126 (line-beginning-position))
23127 (save-excursion (beginning-of-line)
23128 (re-search-forward "^[ \t]*$" end 'move)
23129 (line-beginning-position))
23130 justify))))
23131 ;; Fill comments.
23132 (comment
23133 (let ((begin (org-element-property :post-affiliated element))
23134 (end (org-element-property :end element)))
23135 (when (and (>= (point) begin) (<= (point) end))
23136 (let ((begin (save-excursion
23137 (end-of-line)
23138 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23139 (progn (forward-line) (point))
23140 begin)))
23141 (end (save-excursion
23142 (end-of-line)
23143 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23144 (1- (line-beginning-position))
23145 (skip-chars-backward " \r\t\n")
23146 (line-end-position)))))
23147 ;; Do not fill comments when at a blank line.
23148 (when (> end begin)
23149 (let ((fill-prefix
23150 (save-excursion
23151 (beginning-of-line)
23152 (looking-at "[ \t]*#")
23153 (let ((comment-prefix (match-string 0)))
23154 (goto-char (match-end 0))
23155 (if (looking-at adaptive-fill-regexp)
23156 (concat comment-prefix (match-string 0))
23157 (concat comment-prefix " "))))))
23158 (save-excursion
23159 (fill-region-as-paragraph begin end justify))))))
23161 ;; Ignore every other element.
23162 (otherwise t))))))
23164 (defun org-auto-fill-function ()
23165 "Auto-fill function."
23166 ;; Check if auto-filling is meaningful.
23167 (let ((fc (current-fill-column)))
23168 (when (and fc (> (current-column) fc))
23169 (let* ((fill-prefix (org-adaptive-fill-function))
23170 ;; Enforce empty fill prefix, if required. Otherwise, it
23171 ;; will be computed again.
23172 (adaptive-fill-mode (not (equal fill-prefix ""))))
23173 (when fill-prefix (do-auto-fill))))))
23175 (defun org-comment-line-break-function (&optional soft)
23176 "Break line at point and indent, continuing comment if within one.
23177 The inserted newline is marked hard if variable
23178 `use-hard-newlines' is true, unless optional argument SOFT is
23179 non-nil."
23180 (if soft (insert-and-inherit ?\n) (newline 1))
23181 (save-excursion (forward-char -1) (delete-horizontal-space))
23182 (delete-horizontal-space)
23183 (indent-to-left-margin)
23184 (insert-before-markers-and-inherit fill-prefix))
23187 ;;; Fixed Width Areas
23189 (defun org-toggle-fixed-width ()
23190 "Toggle fixed-width markup.
23192 Add or remove fixed-width markup on current line, whenever it
23193 makes sense. Return an error otherwise.
23195 If a region is active and if it contains only fixed-width areas
23196 or blank lines, remove all fixed-width markup in it. If the
23197 region contains anything else, convert all non-fixed-width lines
23198 to fixed-width ones.
23200 Blank lines at the end of the region are ignored unless the
23201 region only contains such lines."
23202 (interactive)
23203 (if (not (org-region-active-p))
23204 ;; No region:
23206 ;; Remove fixed width marker only in a fixed-with element.
23208 ;; Add fixed width maker in paragraphs, in blank lines after
23209 ;; elements or at the beginning of a headline or an inlinetask,
23210 ;; and before any one-line elements (e.g., a clock).
23211 (progn
23212 (beginning-of-line)
23213 (let* ((element (org-element-at-point))
23214 (type (org-element-type element)))
23215 (cond
23216 ((and (eq type 'fixed-width)
23217 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23218 (replace-match
23219 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23220 ((and (memq type '(babel-call clock comment diary-sexp headline
23221 horizontal-rule keyword paragraph
23222 planning))
23223 (<= (org-element-property :post-affiliated element) (point)))
23224 (skip-chars-forward " \t")
23225 (insert ": "))
23226 ((and (org-looking-at-p "[ \t]*$")
23227 (or (eq type 'inlinetask)
23228 (save-excursion
23229 (skip-chars-forward " \r\t\n")
23230 (<= (org-element-property :end element) (point)))))
23231 (delete-region (point) (line-end-position))
23232 (org-indent-line)
23233 (insert ": "))
23234 (t (user-error "Cannot insert a fixed-width line here")))))
23235 ;; Region active.
23236 (let* ((begin (save-excursion
23237 (goto-char (region-beginning))
23238 (line-beginning-position)))
23239 (end (copy-marker
23240 (save-excursion
23241 (goto-char (region-end))
23242 (unless (eolp) (beginning-of-line))
23243 (if (save-excursion (re-search-backward "\\S-" begin t))
23244 (progn (skip-chars-backward " \r\t\n") (point))
23245 (point)))))
23246 (all-fixed-width-p
23247 (catch 'not-all-p
23248 (save-excursion
23249 (goto-char begin)
23250 (skip-chars-forward " \r\t\n")
23251 (when (eobp) (throw 'not-all-p nil))
23252 (while (< (point) end)
23253 (let ((element (org-element-at-point)))
23254 (if (eq (org-element-type element) 'fixed-width)
23255 (goto-char (org-element-property :end element))
23256 (throw 'not-all-p nil))))
23257 t))))
23258 (if all-fixed-width-p
23259 (save-excursion
23260 (goto-char begin)
23261 (while (< (point) end)
23262 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23263 (replace-match
23264 "" nil nil nil
23265 (if (= (line-end-position) (match-end 0)) 0 1)))
23266 (forward-line)))
23267 (let ((min-ind (point-max)))
23268 ;; Find minimum indentation across all lines.
23269 (save-excursion
23270 (goto-char begin)
23271 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23272 (setq min-ind 0)
23273 (catch 'zerop
23274 (while (< (point) end)
23275 (unless (org-looking-at-p "[ \t]*$")
23276 (let ((ind (org-get-indentation)))
23277 (setq min-ind (min min-ind ind))
23278 (when (zerop ind) (throw 'zerop t))))
23279 (forward-line)))))
23280 ;; Loop over all lines and add fixed-width markup everywhere
23281 ;; but in fixed-width lines.
23282 (save-excursion
23283 (goto-char begin)
23284 (while (< (point) end)
23285 (cond
23286 ((org-at-heading-p)
23287 (insert ": ")
23288 (forward-line)
23289 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23290 (insert ":")
23291 (forward-line)))
23292 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23293 (let* ((element (org-element-at-point))
23294 (element-end (org-element-property :end element)))
23295 (if (eq (org-element-type element) 'fixed-width)
23296 (progn (goto-char element-end)
23297 (skip-chars-backward " \r\t\n")
23298 (forward-line))
23299 (let ((limit (min end element-end)))
23300 (while (< (point) limit)
23301 (org-move-to-column min-ind t)
23302 (insert ": ")
23303 (forward-line))))))
23305 (org-move-to-column min-ind t)
23306 (insert ": ")
23307 (forward-line)))))))
23308 (set-marker end nil))))
23311 ;;; Comments
23313 ;; Org comments syntax is quite complex. It requires the entire line
23314 ;; to be just a comment. Also, even with the right syntax at the
23315 ;; beginning of line, some some elements (i.e. verse-block or
23316 ;; example-block) don't accept comments. Usual Emacs comment commands
23317 ;; cannot cope with those requirements. Therefore, Org replaces them.
23319 ;; Org still relies on `comment-dwim', but cannot trust
23320 ;; `comment-only-p'. So, `comment-region-function' and
23321 ;; `uncomment-region-function' both point
23322 ;; to`org-comment-or-uncomment-region'. Eventually,
23323 ;; `org-insert-comment' takes care of insertion of comments at the
23324 ;; beginning of line.
23326 ;; `org-setup-comments-handling' install comments related variables
23327 ;; during `org-mode' initialization.
23329 (defun org-setup-comments-handling ()
23330 (interactive)
23331 (org-set-local 'comment-use-syntax nil)
23332 (org-set-local 'comment-start "# ")
23333 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23334 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23335 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23336 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23338 (defun org-insert-comment ()
23339 "Insert an empty comment above current line.
23340 If the line is empty, insert comment at its beginning. When
23341 point is within a source block, comment according to the related
23342 major mode."
23343 (if (let ((element (org-element-at-point)))
23344 (and (eq (org-element-type element) 'src-block)
23345 (< (save-excursion
23346 (goto-char (org-element-property :post-affiliated element))
23347 (line-end-position))
23348 (point))
23349 (> (save-excursion
23350 (goto-char (org-element-property :end element))
23351 (skip-chars-backward " \r\t\n")
23352 (line-beginning-position))
23353 (point))))
23354 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23355 (beginning-of-line)
23356 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23357 (open-line 1))
23358 (org-indent-line)
23359 (insert "# ")))
23361 (defvar comment-empty-lines) ; From newcomment.el.
23362 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23363 "Comment or uncomment each non-blank line in the region.
23364 Uncomment each non-blank line between BEG and END if it only
23365 contains commented lines. Otherwise, comment them. If region is
23366 strictly within a source block, use appropriate comment syntax."
23367 (if (let ((element (org-element-at-point)))
23368 (and (eq (org-element-type element) 'src-block)
23369 (< (save-excursion
23370 (goto-char (org-element-property :post-affiliated element))
23371 (line-end-position))
23372 beg)
23373 (>= (save-excursion
23374 (goto-char (org-element-property :end element))
23375 (skip-chars-backward " \r\t\n")
23376 (line-beginning-position))
23377 end)))
23378 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23379 (save-restriction
23380 ;; Restrict region
23381 (narrow-to-region (save-excursion (goto-char beg)
23382 (skip-chars-forward " \r\t\n" end)
23383 (line-beginning-position))
23384 (save-excursion (goto-char end)
23385 (skip-chars-backward " \r\t\n" beg)
23386 (line-end-position)))
23387 (let ((uncommentp
23388 ;; UNCOMMENTP is non-nil when every non blank line between
23389 ;; BEG and END is a comment.
23390 (save-excursion
23391 (goto-char (point-min))
23392 (while (and (not (eobp))
23393 (let ((element (org-element-at-point)))
23394 (and (eq (org-element-type element) 'comment)
23395 (goto-char (min (point-max)
23396 (org-element-property
23397 :end element)))))))
23398 (eobp))))
23399 (if uncommentp
23400 ;; Only blank lines and comments in region: uncomment it.
23401 (save-excursion
23402 (goto-char (point-min))
23403 (while (not (eobp))
23404 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23405 (replace-match "" nil nil nil 1))
23406 (forward-line)))
23407 ;; Comment each line in region.
23408 (let ((min-indent (point-max)))
23409 ;; First find the minimum indentation across all lines.
23410 (save-excursion
23411 (goto-char (point-min))
23412 (while (and (not (eobp)) (not (zerop min-indent)))
23413 (unless (looking-at "[ \t]*$")
23414 (setq min-indent (min min-indent (current-indentation))))
23415 (forward-line)))
23416 ;; Then loop over all lines.
23417 (save-excursion
23418 (goto-char (point-min))
23419 (while (not (eobp))
23420 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23421 ;; Don't get fooled by invisible text (e.g. link path)
23422 ;; when moving to column MIN-INDENT.
23423 (let ((buffer-invisibility-spec nil))
23424 (org-move-to-column min-indent t))
23425 (insert comment-start))
23426 (forward-line)))))))))
23428 (defun org-comment-dwim (arg)
23429 "Call `comment-dwim' within a source edit buffer if needed."
23430 (interactive "*P")
23431 (if (org-in-src-block-p)
23432 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23433 (call-interactively 'comment-dwim)))
23436 ;;; Planning
23438 ;; This section contains tools to operate on timestamp objects, as
23439 ;; returned by, e.g. `org-element-context'.
23441 (defun org-timestamp-has-time-p (timestamp)
23442 "Non-nil when TIMESTAMP has a time specified."
23443 (org-element-property :hour-start timestamp))
23445 (defun org-timestamp-format (timestamp format &optional end utc)
23446 "Format a TIMESTAMP element into a string.
23448 FORMAT is a format specifier to be passed to
23449 `format-time-string'.
23451 When optional argument END is non-nil, use end of date-range or
23452 time-range, if possible.
23454 When optional argument UTC is non-nil, time will be expressed as
23455 Universal Time."
23456 (format-time-string
23457 format
23458 (apply 'encode-time
23459 (cons 0
23460 (mapcar
23461 (lambda (prop) (or (org-element-property prop timestamp) 0))
23462 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23463 '(:minute-start :hour-start :day-start :month-start
23464 :year-start)))))
23465 utc))
23467 (defun org-timestamp-split-range (timestamp &optional end)
23468 "Extract a timestamp object from a date or time range.
23470 TIMESTAMP is a timestamp object. END, when non-nil, means extract
23471 the end of the range. Otherwise, extract its start.
23473 Return a new timestamp object sharing the same parent as
23474 TIMESTAMP."
23475 (let ((type (org-element-property :type timestamp)))
23476 (if (memq type '(active inactive diary)) timestamp
23477 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
23478 ;; Set new type.
23479 (org-element-put-property
23480 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23481 ;; Copy start properties over end properties if END is
23482 ;; non-nil. Otherwise, copy end properties over `start' ones.
23483 (let ((p-alist '((:minute-start . :minute-end)
23484 (:hour-start . :hour-end)
23485 (:day-start . :day-end)
23486 (:month-start . :month-end)
23487 (:year-start . :year-end))))
23488 (dolist (p-cell p-alist)
23489 (org-element-put-property
23490 split-ts
23491 (funcall (if end 'car 'cdr) p-cell)
23492 (org-element-property
23493 (funcall (if end 'cdr 'car) p-cell) split-ts)))
23494 ;; Eventually refresh `:raw-value'.
23495 (org-element-put-property split-ts :raw-value nil)
23496 (org-element-put-property
23497 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23499 (defun org-timestamp-translate (timestamp &optional boundary)
23500 "Apply `org-translate-time' on a TIMESTAMP object.
23501 When optional argument BOUNDARY is non-nil, it is either the
23502 symbol `start' or `end'. In this case, only translate the
23503 starting or ending part of TIMESTAMP if it is a date or time
23504 range. Otherwise, translate both parts."
23505 (if (and (not boundary)
23506 (memq (org-element-property :type timestamp)
23507 '(active-range inactive-range)))
23508 (concat
23509 (org-translate-time
23510 (org-element-property :raw-value
23511 (org-timestamp-split-range timestamp)))
23512 "--"
23513 (org-translate-time
23514 (org-element-property :raw-value
23515 (org-timestamp-split-range timestamp t))))
23516 (org-translate-time
23517 (org-element-property
23518 :raw-value
23519 (if (not boundary) timestamp
23520 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
23524 ;;; Other stuff.
23526 (defun org-reftex-citation ()
23527 "Use reftex-citation to insert a citation into the buffer.
23528 This looks for a line like
23530 #+BIBLIOGRAPHY: foo plain option:-d
23532 and derives from it that foo.bib is the bibliography file relevant
23533 for this document. It then installs the necessary environment for RefTeX
23534 to work in this buffer and calls `reftex-citation' to insert a citation
23535 into the buffer.
23537 Export of such citations to both LaTeX and HTML is handled by the contributed
23538 package ox-bibtex by Taru Karttunen."
23539 (interactive)
23540 (let ((reftex-docstruct-symbol 'rds)
23541 (reftex-cite-format "\\cite{%l}")
23542 rds bib)
23543 (save-excursion
23544 (save-restriction
23545 (widen)
23546 (let ((case-fold-search t)
23547 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23548 (if (not (save-excursion
23549 (or (re-search-forward re nil t)
23550 (re-search-backward re nil t))))
23551 (user-error "No bibliography defined in file")
23552 (setq bib (concat (match-string 1) ".bib")
23553 rds (list (list 'bib bib)))))))
23554 (call-interactively 'reftex-citation)))
23556 ;;;; Functions extending outline functionality
23558 (defun org-beginning-of-line (&optional arg)
23559 "Go to the beginning of the current line. If that is invisible, continue
23560 to a visible line beginning. This makes the function of C-a more intuitive.
23561 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23562 first attempt, and only move to after the tags when the cursor is already
23563 beyond the end of the headline."
23564 (interactive "P")
23565 (let ((pos (point))
23566 (special (if (consp org-special-ctrl-a/e)
23567 (car org-special-ctrl-a/e)
23568 org-special-ctrl-a/e))
23569 deactivate-mark refpos)
23570 (if (org-bound-and-true-p visual-line-mode)
23571 (beginning-of-visual-line 1)
23572 (beginning-of-line 1))
23573 (if (and arg (fboundp 'move-beginning-of-line))
23574 (call-interactively 'move-beginning-of-line)
23575 (if (bobp)
23577 (backward-char 1)
23578 (if (org-truely-invisible-p)
23579 (while (and (not (bobp)) (org-truely-invisible-p))
23580 (backward-char 1)
23581 (beginning-of-line 1))
23582 (forward-char 1))))
23583 (when special
23584 (cond
23585 ((and (looking-at org-complex-heading-regexp)
23586 (= (char-after (match-end 1)) ?\ ))
23587 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23588 (point-at-eol)))
23589 (goto-char
23590 (if (eq special t)
23591 (cond ((> pos refpos) refpos)
23592 ((= pos (point)) refpos)
23593 (t (point)))
23594 (cond ((> pos (point)) (point))
23595 ((not (eq last-command this-command)) (point))
23596 (t refpos)))))
23597 ((org-at-item-p)
23598 ;; Being at an item and not looking at an the item means point
23599 ;; was previously moved to beginning of a visual line, which
23600 ;; doesn't contain the item. Therefore, do nothing special,
23601 ;; just stay here.
23602 (when (looking-at org-list-full-item-re)
23603 ;; Set special position at first white space character after
23604 ;; bullet, and check-box, if any.
23605 (let ((after-bullet
23606 (let ((box (match-end 3)))
23607 (if (not box) (match-end 1)
23608 (let ((after (char-after box)))
23609 (if (and after (= after ? )) (1+ box) box))))))
23610 ;; Special case: Move point to special position when
23611 ;; currently after it or at beginning of line.
23612 (if (eq special t)
23613 (when (or (> pos after-bullet) (= (point) pos))
23614 (goto-char after-bullet))
23615 ;; Reversed case: Move point to special position when
23616 ;; point was already at beginning of line and command is
23617 ;; repeated.
23618 (when (and (= (point) pos) (eq last-command this-command))
23619 (goto-char after-bullet))))))))
23620 (org-no-warnings
23621 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23622 (setq disable-point-adjustment
23623 (or (not (invisible-p (point)))
23624 (not (invisible-p (max (point-min) (1- (point))))))))
23626 (defun org-end-of-line (&optional arg)
23627 "Go to the end of the line.
23628 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23629 tags on the first attempt, and only move to after the tags when
23630 the cursor is already beyond the end of the headline."
23631 (interactive "P")
23632 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23633 org-special-ctrl-a/e))
23634 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23635 'end-of-visual-line)
23636 ((fboundp 'move-end-of-line) 'move-end-of-line)
23637 (t 'end-of-line)))
23638 deactivate-mark)
23639 (if (or (not special) arg) (call-interactively move-fun)
23640 (let* ((element (save-excursion (beginning-of-line)
23641 (org-element-at-point)))
23642 (type (org-element-type element)))
23643 (cond
23644 ((memq type '(headline inlinetask))
23645 (let ((pos (point)))
23646 (beginning-of-line 1)
23647 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23648 (if (eq special t)
23649 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23650 (goto-char (match-beginning 1))
23651 (goto-char (match-end 0)))
23652 (if (or (< pos (match-end 0))
23653 (not (eq this-command last-command)))
23654 (goto-char (match-end 0))
23655 (goto-char (match-beginning 1))))
23656 (call-interactively move-fun))))
23657 ((outline-invisible-p (line-end-position))
23658 ;; If element is hidden, `move-end-of-line' would put point
23659 ;; after it. Use `end-of-line' to stay on current line.
23660 (call-interactively 'end-of-line))
23661 (t (call-interactively move-fun)))))
23662 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23663 (setq disable-point-adjustment
23664 (or (not (invisible-p (point)))
23665 (not (invisible-p (max (point-min) (1- (point))))))))
23667 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23668 (define-key org-mode-map "\C-e" 'org-end-of-line)
23670 (defun org-backward-sentence (&optional arg)
23671 "Go to beginning of sentence, or beginning of table field.
23672 This will call `backward-sentence' or `org-table-beginning-of-field',
23673 depending on context."
23674 (interactive "P")
23675 (cond
23676 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
23677 (t (call-interactively 'backward-sentence))))
23679 (defun org-forward-sentence (&optional arg)
23680 "Go to end of sentence, or end of table field.
23681 This will call `forward-sentence' or `org-table-end-of-field',
23682 depending on context."
23683 (interactive "P")
23684 (cond
23685 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
23686 (t (call-interactively 'forward-sentence))))
23688 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23689 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23691 (defun org-kill-line (&optional arg)
23692 "Kill line, to tags or end of line."
23693 (interactive "P")
23694 (cond
23695 ((or (not org-special-ctrl-k)
23696 (bolp)
23697 (not (org-at-heading-p)))
23698 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23699 org-ctrl-k-protect-subtree)
23700 (if (or (eq org-ctrl-k-protect-subtree 'error)
23701 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23702 (user-error "C-k aborted as it would kill a hidden subtree")))
23703 (call-interactively
23704 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23705 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23706 (kill-region (point) (match-beginning 1))
23707 (org-set-tags nil t))
23708 (t (kill-region (point) (point-at-eol)))))
23710 (define-key org-mode-map "\C-k" 'org-kill-line)
23712 (defun org-yank (&optional arg)
23713 "Yank. If the kill is a subtree, treat it specially.
23714 This command will look at the current kill and check if is a single
23715 subtree, or a series of subtrees[1]. If it passes the test, and if the
23716 cursor is at the beginning of a line or after the stars of a currently
23717 empty headline, then the yank is handled specially. How exactly depends
23718 on the value of the following variables, both set by default.
23720 `org-yank-folded-subtrees'
23721 When set, the subtree(s) will be folded after insertion, but only
23722 if doing so would now swallow text after the yanked text.
23724 `org-yank-adjusted-subtrees'
23725 When set, the subtree will be promoted or demoted in order to
23726 fit into the local outline tree structure, which means that the
23727 level will be adjusted so that it becomes the smaller one of the
23728 two *visible* surrounding headings.
23730 Any prefix to this command will cause `yank' to be called directly with
23731 no special treatment. In particular, a simple \\[universal-argument] prefix \
23732 will just
23733 plainly yank the text as it is.
23735 \[1] The test checks if the first non-white line is a heading
23736 and if there are no other headings with fewer stars."
23737 (interactive "P")
23738 (org-yank-generic 'yank arg))
23740 (defun org-yank-generic (command arg)
23741 "Perform some yank-like command.
23743 This function implements the behavior described in the `org-yank'
23744 documentation. However, it has been generalized to work for any
23745 interactive command with similar behavior."
23747 ;; pretend to be command COMMAND
23748 (setq this-command command)
23750 (if arg
23751 (call-interactively command)
23753 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23754 (and (org-kill-is-subtree-p)
23755 (or (bolp)
23756 (and (looking-at "[ \t]*$")
23757 (string-match
23758 "\\`\\*+\\'"
23759 (buffer-substring (point-at-bol) (point)))))))
23760 swallowp)
23761 (cond
23762 ((and subtreep org-yank-folded-subtrees)
23763 (let ((beg (point))
23764 end)
23765 (if (and subtreep org-yank-adjusted-subtrees)
23766 (org-paste-subtree nil nil 'for-yank)
23767 (call-interactively command))
23769 (setq end (point))
23770 (goto-char beg)
23771 (when (and (bolp) subtreep
23772 (not (setq swallowp
23773 (org-yank-folding-would-swallow-text beg end))))
23774 (org-with-limited-levels
23775 (or (looking-at org-outline-regexp)
23776 (re-search-forward org-outline-regexp-bol end t))
23777 (while (and (< (point) end) (looking-at org-outline-regexp))
23778 (hide-subtree)
23779 (org-cycle-show-empty-lines 'folded)
23780 (condition-case nil
23781 (outline-forward-same-level 1)
23782 (error (goto-char end))))))
23783 (when swallowp
23784 (message
23785 "Inserted text not folded because that would swallow text"))
23787 (goto-char end)
23788 (skip-chars-forward " \t\n\r")
23789 (beginning-of-line 1)
23790 (push-mark beg 'nomsg)))
23791 ((and subtreep org-yank-adjusted-subtrees)
23792 (let ((beg (point-at-bol)))
23793 (org-paste-subtree nil nil 'for-yank)
23794 (push-mark beg 'nomsg)))
23796 (call-interactively command))))))
23798 (defun org-yank-folding-would-swallow-text (beg end)
23799 "Would hide-subtree at BEG swallow any text after END?"
23800 (let (level)
23801 (org-with-limited-levels
23802 (save-excursion
23803 (goto-char beg)
23804 (when (or (looking-at org-outline-regexp)
23805 (re-search-forward org-outline-regexp-bol end t))
23806 (setq level (org-outline-level)))
23807 (goto-char end)
23808 (skip-chars-forward " \t\r\n\v\f")
23809 (if (or (eobp)
23810 (and (bolp) (looking-at org-outline-regexp)
23811 (<= (org-outline-level) level)))
23812 nil ; Nothing would be swallowed
23813 t))))) ; something would swallow
23815 (define-key org-mode-map "\C-y" 'org-yank)
23817 (defun org-truely-invisible-p ()
23818 "Check if point is at a character currently not visible.
23819 This version does not only check the character property, but also
23820 `visible-mode'."
23821 ;; Early versions of noutline don't have `outline-invisible-p'.
23822 (if (org-bound-and-true-p visible-mode)
23824 (outline-invisible-p)))
23826 (defun org-invisible-p2 ()
23827 "Check if point is at a character currently not visible."
23828 (save-excursion
23829 (if (and (eolp) (not (bobp))) (backward-char 1))
23830 ;; Early versions of noutline don't have `outline-invisible-p'.
23831 (outline-invisible-p)))
23833 (defun org-back-to-heading (&optional invisible-ok)
23834 "Call `outline-back-to-heading', but provide a better error message."
23835 (condition-case nil
23836 (outline-back-to-heading invisible-ok)
23837 (error (error "Before first headline at position %d in buffer %s"
23838 (point) (current-buffer)))))
23840 (defun org-before-first-heading-p ()
23841 "Before first heading?"
23842 (save-excursion
23843 (end-of-line)
23844 (null (re-search-backward org-outline-regexp-bol nil t))))
23846 (defun org-at-heading-p (&optional ignored)
23847 (outline-on-heading-p t))
23848 ;; Compatibility alias with Org versions < 7.8.03
23849 (defalias 'org-on-heading-p 'org-at-heading-p)
23851 (defun org-in-commented-heading-p (&optional no-inheritance)
23852 "Non-nil if point is under a commented heading.
23853 This function also checks ancestors of the current headline,
23854 unless optional argument NO-INHERITANCE is non-nil."
23855 (cond
23856 ((org-before-first-heading-p) nil)
23857 ((let ((headline (nth 4 (org-heading-components))))
23858 (and headline
23859 (let ((case-fold-search nil))
23860 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
23861 headline)))))
23862 (no-inheritance nil)
23864 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
23866 (defun org-at-comment-p nil
23867 "Is cursor in a commented line?"
23868 (save-excursion
23869 (save-match-data
23870 (beginning-of-line)
23871 (looking-at "^[ \t]*# "))))
23873 (defun org-at-drawer-p nil
23874 "Is cursor at a drawer keyword?"
23875 (save-excursion
23876 (move-beginning-of-line 1)
23877 (looking-at org-drawer-regexp)))
23879 (defun org-at-block-p nil
23880 "Is cursor at a block keyword?"
23881 (save-excursion
23882 (move-beginning-of-line 1)
23883 (looking-at org-block-regexp)))
23885 (defun org-point-at-end-of-empty-headline ()
23886 "If point is at the end of an empty headline, return t, else nil.
23887 If the heading only contains a TODO keyword, it is still still considered
23888 empty."
23889 (and (looking-at "[ \t]*$")
23890 (when org-todo-line-regexp
23891 (save-excursion
23892 (beginning-of-line 1)
23893 (let ((case-fold-search nil))
23894 (looking-at org-todo-line-regexp)
23895 (string= (match-string 3) ""))))))
23897 (defun org-at-heading-or-item-p ()
23898 (or (org-at-heading-p) (org-at-item-p)))
23900 (defun org-at-target-p ()
23901 (or (org-in-regexp org-radio-target-regexp)
23902 (org-in-regexp org-target-regexp)))
23903 ;; Compatibility alias with Org versions < 7.8.03
23904 (defalias 'org-on-target-p 'org-at-target-p)
23906 (defun org-up-heading-all (arg)
23907 "Move to the heading line of which the present line is a subheading.
23908 This function considers both visible and invisible heading lines.
23909 With argument, move up ARG levels."
23910 (if (fboundp 'outline-up-heading-all)
23911 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23912 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23914 (defun org-up-heading-safe ()
23915 "Move to the heading line of which the present line is a subheading.
23916 This version will not throw an error. It will return the level of the
23917 headline found, or nil if no higher level is found.
23919 Also, this function will be a lot faster than `outline-up-heading',
23920 because it relies on stars being the outline starters. This can really
23921 make a significant difference in outlines with very many siblings."
23922 (when (ignore-errors (org-back-to-heading t))
23923 (let ((level-up (1- (funcall outline-level))))
23924 (and (> level-up 0)
23925 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
23926 (funcall outline-level)))))
23928 (defun org-first-sibling-p ()
23929 "Is this heading the first child of its parents?"
23930 (interactive)
23931 (let ((re org-outline-regexp-bol)
23932 level l)
23933 (unless (org-at-heading-p t)
23934 (user-error "Not at a heading"))
23935 (setq level (funcall outline-level))
23936 (save-excursion
23937 (if (not (re-search-backward re nil t))
23939 (setq l (funcall outline-level))
23940 (< l level)))))
23942 (defun org-goto-sibling (&optional previous)
23943 "Goto the next sibling, even if it is invisible.
23944 When PREVIOUS is set, go to the previous sibling instead. Returns t
23945 when a sibling was found. When none is found, return nil and don't
23946 move point."
23947 (let ((fun (if previous 're-search-backward 're-search-forward))
23948 (pos (point))
23949 (re org-outline-regexp-bol)
23950 level l)
23951 (when (ignore-errors (org-back-to-heading t))
23952 (setq level (funcall outline-level))
23953 (catch 'exit
23954 (or previous (forward-char 1))
23955 (while (funcall fun re nil t)
23956 (setq l (funcall outline-level))
23957 (when (< l level) (goto-char pos) (throw 'exit nil))
23958 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23959 (goto-char pos)
23960 nil))))
23962 (defun org-show-siblings ()
23963 "Show all siblings of the current headline."
23964 (save-excursion
23965 (while (org-goto-sibling) (org-flag-heading nil)))
23966 (save-excursion
23967 (while (org-goto-sibling 'previous)
23968 (org-flag-heading nil))))
23970 (defun org-goto-first-child ()
23971 "Goto the first child, even if it is invisible.
23972 Return t when a child was found. Otherwise don't move point and
23973 return nil."
23974 (let (level (pos (point)) (re org-outline-regexp-bol))
23975 (when (ignore-errors (org-back-to-heading t))
23976 (setq level (outline-level))
23977 (forward-char 1)
23978 (if (and (re-search-forward re nil t) (> (outline-level) level))
23979 (progn (goto-char (match-beginning 0)) t)
23980 (goto-char pos) nil))))
23982 (defun org-show-hidden-entry ()
23983 "Show an entry where even the heading is hidden."
23984 (save-excursion
23985 (org-show-entry)))
23987 (defun org-flag-heading (flag &optional entry)
23988 "Flag the current heading. FLAG non-nil means make invisible.
23989 When ENTRY is non-nil, show the entire entry."
23990 (save-excursion
23991 (org-back-to-heading t)
23992 ;; Check if we should show the entire entry
23993 (if entry
23994 (progn
23995 (org-show-entry)
23996 (save-excursion
23997 (and (outline-next-heading)
23998 (org-flag-heading nil))))
23999 (outline-flag-region (max (point-min) (1- (point)))
24000 (save-excursion (outline-end-of-heading) (point))
24001 flag))))
24003 (defun org-get-next-sibling ()
24004 "Move to next heading of the same level, and return point.
24005 If there is no such heading, return nil.
24006 This is like outline-next-sibling, but invisible headings are ok."
24007 (let ((level (funcall outline-level)))
24008 (outline-next-heading)
24009 (while (and (not (eobp)) (> (funcall outline-level) level))
24010 (outline-next-heading))
24011 (if (or (eobp) (< (funcall outline-level) level))
24013 (point))))
24015 (defun org-get-last-sibling ()
24016 "Move to previous heading of the same level, and return point.
24017 If there is no such heading, return nil."
24018 (let ((opoint (point))
24019 (level (funcall outline-level)))
24020 (outline-previous-heading)
24021 (when (and (/= (point) opoint) (outline-on-heading-p t))
24022 (while (and (> (funcall outline-level) level)
24023 (not (bobp)))
24024 (outline-previous-heading))
24025 (if (< (funcall outline-level) level)
24027 (point)))))
24029 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24030 "Goto to the end of a subtree."
24031 ;; This contains an exact copy of the original function, but it uses
24032 ;; `org-back-to-heading', to make it work also in invisible
24033 ;; trees. And is uses an invisible-ok argument.
24034 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24035 ;; Furthermore, when used inside Org, finding the end of a large subtree
24036 ;; with many children and grandchildren etc, this can be much faster
24037 ;; than the outline version.
24038 (org-back-to-heading invisible-ok)
24039 (let ((first t)
24040 (level (funcall outline-level)))
24041 (if (and (derived-mode-p 'org-mode) (< level 1000))
24042 ;; A true heading (not a plain list item), in Org-mode
24043 ;; This means we can easily find the end by looking
24044 ;; only for the right number of stars. Using a regexp to do
24045 ;; this is so much faster than using a Lisp loop.
24046 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24047 (forward-char 1)
24048 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24049 ;; something else, do it the slow way
24050 (while (and (not (eobp))
24051 (or first (> (funcall outline-level) level)))
24052 (setq first nil)
24053 (outline-next-heading)))
24054 (unless to-heading
24055 (if (memq (preceding-char) '(?\n ?\^M))
24056 (progn
24057 ;; Go to end of line before heading
24058 (forward-char -1)
24059 (if (memq (preceding-char) '(?\n ?\^M))
24060 ;; leave blank line before heading
24061 (forward-char -1))))))
24062 (point))
24064 (defun org-end-of-meta-data-and-drawers ()
24065 "Jump to the first text after meta data and drawers in the current entry.
24066 This will move over empty lines, lines with planning time stamps,
24067 clocking lines, and drawers."
24068 (org-back-to-heading t)
24069 (let ((end (save-excursion (outline-next-heading) (point)))
24070 (re (concat "\\(" org-drawer-regexp "\\)"
24071 "\\|" "[ \t]*" org-keyword-time-regexp)))
24072 (forward-line 1)
24073 (while (re-search-forward re end t)
24074 (if (not (match-end 1))
24075 ;; empty or planning line
24076 (forward-line 1)
24077 ;; a drawer, find the end
24078 (re-search-forward "^[ \t]*:END:" end 'move)
24079 (forward-line 1)))
24080 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
24081 (point)))
24083 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24084 "Move forward to the ARG'th subheading at same level as this one.
24085 Stop at the first and last subheadings of a superior heading.
24086 Normally this only looks at visible headings, but when INVISIBLE-OK is
24087 non-nil it will also look at invisible ones."
24088 (interactive "p")
24089 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24090 (if (and arg (< arg 0))
24091 (goto-char (point-min))
24092 (outline-next-heading))
24093 (org-at-heading-p)
24094 (let ((level (- (match-end 0) (match-beginning 0) 1))
24095 (f (if (and arg (< arg 0))
24096 're-search-backward
24097 're-search-forward))
24098 (count (if arg (abs arg) 1))
24099 (result (point)))
24100 (while (and (prog1 (> count 0)
24101 (forward-char (if (and arg (< arg 0)) -1 1)))
24102 (funcall f org-outline-regexp-bol nil 'move))
24103 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24104 (cond ((< l level) (setq count 0))
24105 ((and (= l level)
24106 (or invisible-ok
24107 (progn
24108 (goto-char (line-beginning-position))
24109 (not (outline-invisible-p)))))
24110 (setq count (1- count))
24111 (when (eq l level)
24112 (setq result (point)))))))
24113 (goto-char result))
24114 (beginning-of-line 1)))
24116 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24117 "Move backward to the ARG'th subheading at same level as this one.
24118 Stop at the first and last subheadings of a superior heading."
24119 (interactive "p")
24120 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24122 (defun org-next-block (arg &optional backward block-regexp)
24123 "Jump to the next block.
24124 With a prefix argument ARG, jump forward ARG many source blocks.
24125 When BACKWARD is non-nil, jump to the previous block.
24126 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24127 (interactive "p")
24128 (let ((re (or block-regexp org-block-regexp))
24129 (re-search-fn (or (and backward 're-search-backward)
24130 're-search-forward)))
24131 (if (looking-at re) (forward-char 1))
24132 (condition-case nil
24133 (funcall re-search-fn re nil nil arg)
24134 (error (user-error "No %s code blocks"
24135 (if backward "previous" "further" ))))
24136 (goto-char (match-beginning 0)) (org-show-context)))
24138 (defun org-previous-block (arg &optional block-regexp)
24139 "Jump to the previous block.
24140 With a prefix argument ARG, jump backward ARG many source blocks.
24141 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24142 (interactive "p")
24143 (org-next-block arg t block-regexp))
24145 (defun org-forward-paragraph ()
24146 "Move forward to beginning of next paragraph or equivalent.
24148 The function moves point to the beginning of the next visible
24149 structural element, which can be a paragraph, a table, a list
24150 item, etc. It also provides some special moves for convenience:
24152 - On an affiliated keyword, jump to the beginning of the
24153 relative element.
24154 - On an item or a footnote definition, move to the second
24155 element inside, if any.
24156 - On a table or a property drawer, jump after it.
24157 - On a verse or source block, stop after blank lines."
24158 (interactive)
24159 (when (eobp) (user-error "Cannot move further down"))
24160 (let* ((deactivate-mark nil)
24161 (element (org-element-at-point))
24162 (type (org-element-type element))
24163 (post-affiliated (org-element-property :post-affiliated element))
24164 (contents-begin (org-element-property :contents-begin element))
24165 (contents-end (org-element-property :contents-end element))
24166 (end (let ((end (org-element-property :end element)) (parent element))
24167 (while (and (setq parent (org-element-property :parent parent))
24168 (= (org-element-property :contents-end parent) end))
24169 (setq end (org-element-property :end parent)))
24170 end)))
24171 (cond ((not element)
24172 (skip-chars-forward " \r\t\n")
24173 (or (eobp) (beginning-of-line)))
24174 ;; On affiliated keywords, move to element's beginning.
24175 ((< (point) post-affiliated)
24176 (goto-char post-affiliated))
24177 ;; At a table row, move to the end of the table. Similarly,
24178 ;; at a node property, move to the end of the property
24179 ;; drawer.
24180 ((memq type '(node-property table-row))
24181 (goto-char (org-element-property
24182 :end (org-element-property :parent element))))
24183 ((memq type '(property-drawer table)) (goto-char end))
24184 ;; Consider blank lines as separators in verse and source
24185 ;; blocks to ease editing.
24186 ((memq type '(src-block verse-block))
24187 (when (eq type 'src-block)
24188 (setq contents-end
24189 (save-excursion (goto-char end)
24190 (skip-chars-backward " \r\t\n")
24191 (line-beginning-position))))
24192 (beginning-of-line)
24193 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24194 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24195 (goto-char end)
24196 (skip-chars-forward " \r\t\n")
24197 (if (= (point) contents-end) (goto-char end)
24198 (beginning-of-line))))
24199 ;; With no contents, just skip element.
24200 ((not contents-begin) (goto-char end))
24201 ;; If contents are invisible, skip the element altogether.
24202 ((outline-invisible-p (line-end-position))
24203 (case type
24204 (headline
24205 (org-with-limited-levels (outline-next-visible-heading 1)))
24206 ;; At a plain list, make sure we move to the next item
24207 ;; instead of skipping the whole list.
24208 (plain-list (forward-char)
24209 (org-forward-paragraph))
24210 (otherwise (goto-char end))))
24211 ((>= (point) contents-end) (goto-char end))
24212 ((>= (point) contents-begin)
24213 ;; This can only happen on paragraphs and plain lists.
24214 (case type
24215 (paragraph (goto-char end))
24216 ;; At a plain list, try to move to second element in
24217 ;; first item, if possible.
24218 (plain-list (end-of-line)
24219 (org-forward-paragraph))))
24220 ;; When contents start on the middle of a line (e.g. in
24221 ;; items and footnote definitions), try to reach first
24222 ;; element starting after current line.
24223 ((> (line-end-position) contents-begin)
24224 (end-of-line)
24225 (org-forward-paragraph))
24226 (t (goto-char contents-begin)))))
24228 (defun org-backward-paragraph ()
24229 "Move backward to start of previous paragraph or equivalent.
24231 The function moves point to the beginning of the current
24232 structural element, which can be a paragraph, a table, a list
24233 item, etc., or to the beginning of the previous visible one if
24234 point is already there. It also provides some special moves for
24235 convenience:
24237 - On an affiliated keyword, jump to the first one.
24238 - On a table or a property drawer, move to its beginning.
24239 - On a verse or source block, stop before blank lines."
24240 (interactive)
24241 (when (bobp) (user-error "Cannot move further up"))
24242 (let* ((deactivate-mark nil)
24243 (element (org-element-at-point))
24244 (type (org-element-type element))
24245 (contents-begin (org-element-property :contents-begin element))
24246 (contents-end (org-element-property :contents-end element))
24247 (post-affiliated (org-element-property :post-affiliated element))
24248 (begin (org-element-property :begin element)))
24249 (cond
24250 ((not element) (goto-char (point-min)))
24251 ((= (point) begin)
24252 (backward-char)
24253 (org-backward-paragraph))
24254 ((<= (point) post-affiliated) (goto-char begin))
24255 ((memq type '(node-property table-row))
24256 (goto-char (org-element-property
24257 :post-affiliated (org-element-property :parent element))))
24258 ((memq type '(property-drawer table)) (goto-char begin))
24259 ((memq type '(src-block verse-block))
24260 (when (eq type 'src-block)
24261 (setq contents-begin
24262 (save-excursion (goto-char begin) (forward-line) (point))))
24263 (if (= (point) contents-begin) (goto-char post-affiliated)
24264 ;; Inside a verse block, see blank lines as paragraph
24265 ;; separators.
24266 (let ((origin (point)))
24267 (skip-chars-backward " \r\t\n" contents-begin)
24268 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24269 (skip-chars-forward " \r\t\n" origin)
24270 (if (= (point) origin) (goto-char contents-begin)
24271 (beginning-of-line))))))
24272 ((not contents-begin) (goto-char (or post-affiliated begin)))
24273 ((eq type 'paragraph)
24274 (goto-char contents-begin)
24275 ;; When at first paragraph in an item or a footnote definition,
24276 ;; move directly to beginning of line.
24277 (let ((parent-contents
24278 (org-element-property
24279 :contents-begin (org-element-property :parent element))))
24280 (when (and parent-contents (= parent-contents contents-begin))
24281 (beginning-of-line))))
24282 ;; At the end of a greater element, move to the beginning of the
24283 ;; last element within.
24284 ((>= (point) contents-end)
24285 (goto-char (1- contents-end))
24286 (org-backward-paragraph))
24287 (t (goto-char (or post-affiliated begin))))
24288 ;; Ensure we never leave point invisible.
24289 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24291 (defun org-forward-element ()
24292 "Move forward by one element.
24293 Move to the next element at the same level, when possible."
24294 (interactive)
24295 (cond ((eobp) (user-error "Cannot move further down"))
24296 ((org-with-limited-levels (org-at-heading-p))
24297 (let ((origin (point)))
24298 (goto-char (org-end-of-subtree nil t))
24299 (unless (org-with-limited-levels (org-at-heading-p))
24300 (goto-char origin)
24301 (user-error "Cannot move further down"))))
24303 (let* ((elem (org-element-at-point))
24304 (end (org-element-property :end elem))
24305 (parent (org-element-property :parent elem)))
24306 (cond ((and parent (= (org-element-property :contents-end parent) end))
24307 (goto-char (org-element-property :end parent)))
24308 ((integer-or-marker-p end) (goto-char end))
24309 (t (message "No element at point")))))))
24311 (defun org-backward-element ()
24312 "Move backward by one element.
24313 Move to the previous element at the same level, when possible."
24314 (interactive)
24315 (cond ((bobp) (user-error "Cannot move further up"))
24316 ((org-with-limited-levels (org-at-heading-p))
24317 ;; At a headline, move to the previous one, if any, or stay
24318 ;; here.
24319 (let ((origin (point)))
24320 (org-with-limited-levels (org-backward-heading-same-level 1))
24321 ;; When current headline has no sibling above, move to its
24322 ;; parent.
24323 (when (= (point) origin)
24324 (or (org-with-limited-levels (org-up-heading-safe))
24325 (progn (goto-char origin)
24326 (user-error "Cannot move further up"))))))
24328 (let* ((elem (org-element-at-point))
24329 (beg (org-element-property :begin elem)))
24330 (cond
24331 ;; Move to beginning of current element if point isn't
24332 ;; there already.
24333 ((null beg) (message "No element at point"))
24334 ((/= (point) beg) (goto-char beg))
24335 (t (goto-char beg)
24336 (skip-chars-backward " \r\t\n")
24337 (unless (bobp)
24338 (let ((prev (org-element-at-point)))
24339 (goto-char (org-element-property :begin prev))
24340 (while (and (setq prev (org-element-property :parent prev))
24341 (<= (org-element-property :end prev) beg))
24342 (goto-char (org-element-property :begin prev)))))))))))
24344 (defun org-up-element ()
24345 "Move to upper element."
24346 (interactive)
24347 (if (org-with-limited-levels (org-at-heading-p))
24348 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24349 (let* ((elem (org-element-at-point))
24350 (parent (org-element-property :parent elem)))
24351 (if parent (goto-char (org-element-property :begin parent))
24352 (if (org-with-limited-levels (org-before-first-heading-p))
24353 (user-error "No surrounding element")
24354 (org-with-limited-levels (org-back-to-heading)))))))
24356 (defvar org-element-greater-elements)
24357 (defun org-down-element ()
24358 "Move to inner element."
24359 (interactive)
24360 (let ((element (org-element-at-point)))
24361 (cond
24362 ((memq (org-element-type element) '(plain-list table))
24363 (goto-char (org-element-property :contents-begin element))
24364 (forward-char))
24365 ((memq (org-element-type element) org-element-greater-elements)
24366 ;; If contents are hidden, first disclose them.
24367 (when (outline-invisible-p (line-end-position)) (org-cycle))
24368 (goto-char (or (org-element-property :contents-begin element)
24369 (user-error "No content for this element"))))
24370 (t (user-error "No inner element")))))
24372 (defun org-drag-element-backward ()
24373 "Move backward element at point."
24374 (interactive)
24375 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24376 (let* ((elem (org-element-at-point))
24377 (prev-elem
24378 (save-excursion
24379 (goto-char (org-element-property :begin elem))
24380 (skip-chars-backward " \r\t\n")
24381 (unless (bobp)
24382 (let* ((beg (org-element-property :begin elem))
24383 (prev (org-element-at-point))
24384 (up prev))
24385 (while (and (setq up (org-element-property :parent up))
24386 (<= (org-element-property :end up) beg))
24387 (setq prev up))
24388 prev)))))
24389 ;; Error out if no previous element or previous element is
24390 ;; a parent of the current one.
24391 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24392 (user-error "Cannot drag element backward")
24393 (let ((pos (point)))
24394 (org-element-swap-A-B prev-elem elem)
24395 (goto-char (+ (org-element-property :begin prev-elem)
24396 (- pos (org-element-property :begin elem)))))))))
24398 (defun org-drag-element-forward ()
24399 "Move forward element at point."
24400 (interactive)
24401 (let* ((pos (point))
24402 (elem (org-element-at-point)))
24403 (when (= (point-max) (org-element-property :end elem))
24404 (user-error "Cannot drag element forward"))
24405 (goto-char (org-element-property :end elem))
24406 (let ((next-elem (org-element-at-point)))
24407 (when (or (org-element-nested-p elem next-elem)
24408 (and (eq (org-element-type next-elem) 'headline)
24409 (not (eq (org-element-type elem) 'headline))))
24410 (goto-char pos)
24411 (user-error "Cannot drag element forward"))
24412 ;; Compute new position of point: it's shifted by NEXT-ELEM
24413 ;; body's length (without final blanks) and by the length of
24414 ;; blanks between ELEM and NEXT-ELEM.
24415 (let ((size-next (- (save-excursion
24416 (goto-char (org-element-property :end next-elem))
24417 (skip-chars-backward " \r\t\n")
24418 (forward-line)
24419 ;; Small correction if buffer doesn't end
24420 ;; with a newline character.
24421 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24422 (org-element-property :begin next-elem)))
24423 (size-blank (- (org-element-property :end elem)
24424 (save-excursion
24425 (goto-char (org-element-property :end elem))
24426 (skip-chars-backward " \r\t\n")
24427 (forward-line)
24428 (point)))))
24429 (org-element-swap-A-B elem next-elem)
24430 (goto-char (+ pos size-next size-blank))))))
24432 (defun org-drag-line-forward (arg)
24433 "Drag the line at point ARG lines forward."
24434 (interactive "p")
24435 (dotimes (n (abs arg))
24436 (let ((c (current-column)))
24437 (if (< 0 arg)
24438 (progn
24439 (beginning-of-line 2)
24440 (transpose-lines 1)
24441 (beginning-of-line 0))
24442 (transpose-lines 1)
24443 (beginning-of-line -1))
24444 (org-move-to-column c))))
24446 (defun org-drag-line-backward (arg)
24447 "Drag the line at point ARG lines backward."
24448 (interactive "p")
24449 (org-drag-line-forward (- arg)))
24451 (defun org-mark-element ()
24452 "Put point at beginning of this element, mark at end.
24454 Interactively, if this command is repeated or (in Transient Mark
24455 mode) if the mark is active, it marks the next element after the
24456 ones already marked."
24457 (interactive)
24458 (let (deactivate-mark)
24459 (if (and (org-called-interactively-p 'any)
24460 (or (and (eq last-command this-command) (mark t))
24461 (and transient-mark-mode mark-active)))
24462 (set-mark
24463 (save-excursion
24464 (goto-char (mark))
24465 (goto-char (org-element-property :end (org-element-at-point)))))
24466 (let ((element (org-element-at-point)))
24467 (end-of-line)
24468 (push-mark (org-element-property :end element) t t)
24469 (goto-char (org-element-property :begin element))))))
24471 (defun org-narrow-to-element ()
24472 "Narrow buffer to current element."
24473 (interactive)
24474 (let ((elem (org-element-at-point)))
24475 (cond
24476 ((eq (car elem) 'headline)
24477 (narrow-to-region
24478 (org-element-property :begin elem)
24479 (org-element-property :end elem)))
24480 ((memq (car elem) org-element-greater-elements)
24481 (narrow-to-region
24482 (org-element-property :contents-begin elem)
24483 (org-element-property :contents-end elem)))
24485 (narrow-to-region
24486 (org-element-property :begin elem)
24487 (org-element-property :end elem))))))
24489 (defun org-transpose-element ()
24490 "Transpose current and previous elements, keeping blank lines between.
24491 Point is moved after both elements."
24492 (interactive)
24493 (org-skip-whitespace)
24494 (let ((end (org-element-property :end (org-element-at-point))))
24495 (org-drag-element-backward)
24496 (goto-char end)))
24498 (defun org-unindent-buffer ()
24499 "Un-indent the visible part of the buffer.
24500 Relative indentation (between items, inside blocks, etc.) isn't
24501 modified."
24502 (interactive)
24503 (unless (eq major-mode 'org-mode)
24504 (user-error "Cannot un-indent a buffer not in Org mode"))
24505 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24506 unindent-tree ; For byte-compiler.
24507 (unindent-tree
24508 (function
24509 (lambda (contents)
24510 (mapc
24511 (lambda (element)
24512 (if (memq (org-element-type element) '(headline section))
24513 (funcall unindent-tree (org-element-contents element))
24514 (save-excursion
24515 (save-restriction
24516 (narrow-to-region
24517 (org-element-property :begin element)
24518 (org-element-property :end element))
24519 (org-do-remove-indentation)))))
24520 (reverse contents))))))
24521 (funcall unindent-tree (org-element-contents parse-tree))))
24523 (defun org-show-subtree ()
24524 "Show everything after this heading at deeper levels."
24525 (interactive)
24526 (outline-flag-region
24527 (point)
24528 (save-excursion
24529 (org-end-of-subtree t t))
24530 nil))
24532 (defun org-show-entry ()
24533 "Show the body directly following this heading.
24534 Show the heading too, if it is currently invisible."
24535 (interactive)
24536 (save-excursion
24537 (ignore-errors
24538 (org-back-to-heading t)
24539 (outline-flag-region
24540 (max (point-min) (1- (point)))
24541 (save-excursion
24542 (if (re-search-forward
24543 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24544 (match-beginning 1)
24545 (point-max)))
24546 nil)
24547 (org-cycle-hide-drawers 'children))))
24549 (defun org-make-options-regexp (kwds &optional extra)
24550 "Make a regular expression for keyword lines.
24551 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24552 when non-nil, is a regexp matching keywords names."
24553 (concat "^[ \t]*#\\+\\("
24554 (regexp-opt kwds)
24555 (and extra (concat (and kwds "\\|") extra))
24556 "\\):[ \t]*\\(.*\\)"))
24558 ;; Make isearch reveal the necessary context
24559 (defun org-isearch-end ()
24560 "Reveal context after isearch exits."
24561 (when isearch-success ; only if search was successful
24562 (if (featurep 'xemacs)
24563 ;; Under XEmacs, the hook is run in the correct place,
24564 ;; we directly show the context.
24565 (org-show-context 'isearch)
24566 ;; In Emacs the hook runs *before* restoring the overlays.
24567 ;; So we have to use a one-time post-command-hook to do this.
24568 ;; (Emacs 22 has a special variable, see function `org-mode')
24569 (unless (and (boundp 'isearch-mode-end-hook-quit)
24570 isearch-mode-end-hook-quit)
24571 ;; Only when the isearch was not quitted.
24572 (org-add-hook 'post-command-hook 'org-isearch-post-command
24573 'append 'local)))))
24575 (defun org-isearch-post-command ()
24576 "Remove self from hook, and show context."
24577 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24578 (org-show-context 'isearch))
24581 ;;;; Integration with and fixes for other packages
24583 ;;; Imenu support
24585 (defvar org-imenu-markers nil
24586 "All markers currently used by Imenu.")
24587 (make-variable-buffer-local 'org-imenu-markers)
24589 (defun org-imenu-new-marker (&optional pos)
24590 "Return a new marker for use by Imenu, and remember the marker."
24591 (let ((m (make-marker)))
24592 (move-marker m (or pos (point)))
24593 (push m org-imenu-markers)
24596 (defun org-imenu-get-tree ()
24597 "Produce the index for Imenu."
24598 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24599 (setq org-imenu-markers nil)
24600 (let* ((n org-imenu-depth)
24601 (re (concat "^" (org-get-limited-outline-regexp)))
24602 (subs (make-vector (1+ n) nil))
24603 (last-level 0)
24604 m level head0 head)
24605 (save-excursion
24606 (save-restriction
24607 (widen)
24608 (goto-char (point-max))
24609 (while (re-search-backward re nil t)
24610 (setq level (org-reduced-level (funcall outline-level)))
24611 (when (and (<= level n)
24612 (looking-at org-complex-heading-regexp)
24613 (setq head0 (org-match-string-no-properties 4)))
24614 (setq head (org-link-display-format head0)
24615 m (org-imenu-new-marker))
24616 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24617 (if (>= level last-level)
24618 (push (cons head m) (aref subs level))
24619 (push (cons head (aref subs (1+ level))) (aref subs level))
24620 (loop for i from (1+ level) to n do (aset subs i nil)))
24621 (setq last-level level)))))
24622 (aref subs 1)))
24624 (eval-after-load "imenu"
24625 '(progn
24626 (add-hook 'imenu-after-jump-hook
24627 (lambda ()
24628 (if (derived-mode-p 'org-mode)
24629 (org-show-context 'org-goto))))))
24631 (defun org-link-display-format (link)
24632 "Replace a link with its the description.
24633 If there is no description, use the link target."
24634 (save-match-data
24635 (if (string-match org-bracket-link-analytic-regexp link)
24636 (replace-match (if (match-end 5)
24637 (match-string 5 link)
24638 (concat (match-string 1 link)
24639 (match-string 3 link)))
24640 nil t link)
24641 link)))
24643 (defun org-toggle-link-display ()
24644 "Toggle the literal or descriptive display of links."
24645 (interactive)
24646 (if org-descriptive-links
24647 (progn (org-remove-from-invisibility-spec '(org-link))
24648 (org-restart-font-lock)
24649 (setq org-descriptive-links nil))
24650 (progn (add-to-invisibility-spec '(org-link))
24651 (org-restart-font-lock)
24652 (setq org-descriptive-links t))))
24654 ;; Speedbar support
24656 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24657 "Overlay marking the agenda restriction line in speedbar.")
24658 (overlay-put org-speedbar-restriction-lock-overlay
24659 'face 'org-agenda-restriction-lock)
24660 (overlay-put org-speedbar-restriction-lock-overlay
24661 'help-echo "Agendas are currently limited to this item.")
24662 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24664 (defun org-speedbar-set-agenda-restriction ()
24665 "Restrict future agenda commands to the location at point in speedbar.
24666 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24667 (interactive)
24668 (require 'org-agenda)
24669 (let (p m tp np dir txt)
24670 (cond
24671 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24672 'org-imenu t))
24673 (setq m (get-text-property p 'org-imenu-marker))
24674 (with-current-buffer (marker-buffer m)
24675 (goto-char m)
24676 (org-agenda-set-restriction-lock 'subtree)))
24677 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24678 'speedbar-function 'speedbar-find-file))
24679 (setq tp (previous-single-property-change
24680 (1+ p) 'speedbar-function)
24681 np (next-single-property-change
24682 tp 'speedbar-function)
24683 dir (speedbar-line-directory)
24684 txt (buffer-substring-no-properties (or tp (point-min))
24685 (or np (point-max))))
24686 (with-current-buffer (find-file-noselect
24687 (let ((default-directory dir))
24688 (expand-file-name txt)))
24689 (unless (derived-mode-p 'org-mode)
24690 (user-error "Cannot restrict to non-Org-mode file"))
24691 (org-agenda-set-restriction-lock 'file)))
24692 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24693 (move-overlay org-speedbar-restriction-lock-overlay
24694 (point-at-bol) (point-at-eol))
24695 (setq current-prefix-arg nil)
24696 (org-agenda-maybe-redo)))
24698 (defvar speedbar-file-key-map)
24699 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24700 (eval-after-load "speedbar"
24701 '(progn
24702 (speedbar-add-supported-extension ".org")
24703 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24704 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24705 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24706 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24707 (add-hook 'speedbar-visiting-tag-hook
24708 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24710 ;;; Fixes and Hacks for problems with other packages
24712 (defun org--flyspell-object-check-p (element)
24713 "Non-nil when Flyspell can check object at point.
24714 ELEMENT is the element at point."
24715 (let ((object (save-excursion
24716 (when (org-looking-at-p "\\>") (backward-char))
24717 (org-element-context element))))
24718 (case (org-element-type object)
24719 ;; Prevent checks in links due to keybinding conflict with
24720 ;; Flyspell.
24721 ((code entity export-snippet inline-babel-call
24722 inline-src-block line-break latex-fragment link macro
24723 statistics-cookie target timestamp verbatim)
24724 nil)
24725 (footnote-reference
24726 ;; Only in inline footnotes, within the definition.
24727 (and (eq (org-element-property :type object) 'inline)
24728 (< (save-excursion
24729 (goto-char (org-element-property :begin object))
24730 (search-forward ":" nil t 2))
24731 (point))))
24732 (otherwise t))))
24734 (defun org-mode-flyspell-verify ()
24735 "Function used for `flyspell-generic-check-word-predicate'."
24736 (if (org-at-heading-p)
24737 ;; At a headline or an inlinetask, check title only. This is
24738 ;; faster than relying on `org-element-at-point'.
24739 (and (save-excursion (beginning-of-line)
24740 (and (let ((case-fold-search t))
24741 (not (looking-at "\\*+ END[ \t]*$")))
24742 (looking-at org-complex-heading-regexp)))
24743 (match-beginning 4)
24744 (>= (point) (match-beginning 4))
24745 (or (not (match-beginning 5))
24746 (< (point) (match-beginning 5))))
24747 (let* ((element (org-element-at-point))
24748 (post-affiliated (org-element-property :post-affiliated element)))
24749 (cond
24750 ;; Ignore checks in all affiliated keywords but captions.
24751 ((< (point) post-affiliated)
24752 (and (save-excursion
24753 (beginning-of-line)
24754 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24755 (> (point) (match-end 0))
24756 (org--flyspell-object-check-p element)))
24757 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24758 ((and org-log-into-drawer
24759 (let ((log (or (org-string-nw-p org-log-into-drawer) "LOGBOOK"))
24760 (parent element))
24761 (while (and parent (not (eq (org-element-type parent) 'drawer)))
24762 (setq parent (org-element-property :parent parent)))
24763 (and parent
24764 (eq (compare-strings
24765 log nil nil
24766 (org-element-property :drawer-name parent) nil nil t)
24767 t))))
24768 nil)
24770 (case (org-element-type element)
24771 ((comment quote-section) t)
24772 (comment-block
24773 ;; Allow checks between block markers, not on them.
24774 (and (> (line-beginning-position) post-affiliated)
24775 (save-excursion
24776 (end-of-line)
24777 (skip-chars-forward " \r\t\n")
24778 (< (point) (org-element-property :end element)))))
24779 ;; Arbitrary list of keywords where checks are meaningful.
24780 ;; Make sure point is on the value part of the element.
24781 (keyword
24782 (and (member (org-element-property :key element)
24783 '("DESCRIPTION" "TITLE"))
24784 (< (save-excursion
24785 (beginning-of-line) (search-forward ":") (point))
24786 (point))))
24787 ;; Check is globally allowed in paragraphs verse blocks and
24788 ;; table rows (after affiliated keywords) but some objects
24789 ;; must not be affected.
24790 ((paragraph table-row verse-block)
24791 (let ((cbeg (org-element-property :contents-begin element))
24792 (cend (org-element-property :contents-end element)))
24793 (and cbeg (>= (point) cbeg) (< (point) cend)
24794 (org--flyspell-object-check-p element))))))))))
24795 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
24797 (defun org-remove-flyspell-overlays-in (beg end)
24798 "Remove flyspell overlays in region."
24799 (and (org-bound-and-true-p flyspell-mode)
24800 (fboundp 'flyspell-delete-region-overlays)
24801 (flyspell-delete-region-overlays beg end)))
24803 (defvar flyspell-delayed-commands)
24804 (eval-after-load "flyspell"
24805 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
24807 ;; Make `bookmark-jump' shows the jump location if it was hidden.
24808 (eval-after-load "bookmark"
24809 '(if (boundp 'bookmark-after-jump-hook)
24810 ;; We can use the hook
24811 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
24812 ;; Hook not available, use advice
24813 (defadvice bookmark-jump (after org-make-visible activate)
24814 "Make the position visible."
24815 (org-bookmark-jump-unhide))))
24817 ;; Make sure saveplace shows the location if it was hidden
24818 (eval-after-load "saveplace"
24819 '(defadvice save-place-find-file-hook (after org-make-visible activate)
24820 "Make the position visible."
24821 (org-bookmark-jump-unhide)))
24823 ;; Make sure ecb shows the location if it was hidden
24824 (eval-after-load "ecb"
24825 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
24826 "Make hierarchy visible when jumping into location from ECB tree buffer."
24827 (if (derived-mode-p 'org-mode)
24828 (org-show-context))))
24830 (defun org-bookmark-jump-unhide ()
24831 "Unhide the current position, to show the bookmark location."
24832 (and (derived-mode-p 'org-mode)
24833 (or (outline-invisible-p)
24834 (save-excursion (goto-char (max (point-min) (1- (point))))
24835 (outline-invisible-p)))
24836 (org-show-context 'bookmark-jump)))
24838 (defun org-mark-jump-unhide ()
24839 "Make the point visible with `org-show-context' after jumping to the mark."
24840 (when (and (derived-mode-p 'org-mode)
24841 (outline-invisible-p))
24842 (org-show-context 'mark-goto)))
24844 (eval-after-load "simple"
24845 '(defadvice pop-to-mark-command (after org-make-visible activate)
24846 "Make the point visible with `org-show-context'."
24847 (org-mark-jump-unhide)))
24849 (eval-after-load "simple"
24850 '(defadvice exchange-point-and-mark (after org-make-visible activate)
24851 "Make the point visible with `org-show-context'."
24852 (org-mark-jump-unhide)))
24854 (eval-after-load "simple"
24855 '(defadvice pop-global-mark (after org-make-visible activate)
24856 "Make the point visible with `org-show-context'."
24857 (org-mark-jump-unhide)))
24859 ;; Make session.el ignore our circular variable
24860 (defvar session-globals-exclude)
24861 (eval-after-load "session"
24862 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24864 ;;;; Finish up
24866 (provide 'org)
24868 (run-hooks 'org-load-hook)
24870 ;;; org.el ends here