Tiny refactoring
[org-mode/org-tableheadings.git] / lisp / org.el
blobc566152e877ea575d8d891a8aa2d06a814cd9e46
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
44 ;; linked webpages.
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
50 ;; http://orgmode.org/org.html#Installation
52 ;; Documentation
53 ;; -------------
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
63 ;;; Code:
65 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
66 (defvar org-table-formula-constants-local nil
67 "Local version of `org-table-formula-constants'.")
68 (make-variable-buffer-local 'org-table-formula-constants-local)
70 ;;;; Require other packages
72 (eval-when-compile
73 (require 'cl)
74 (require 'gnus-sum))
76 (require 'calendar)
77 (require 'find-func)
78 (require 'format-spec)
80 (or (equal this-command 'eval-buffer)
81 (condition-case nil
82 (load (concat (file-name-directory load-file-name)
83 "org-loaddefs.el")
84 nil t t t)
85 (error
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
87 (sit-for 3)
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
89 (sit-for 3))))
91 (require 'org-macs)
92 (require 'org-compat)
94 (declare-function cdlatex-environment "ext:cdlatex" (environment item))
96 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
97 ;; some places -- e.g. see the macro `org-with-limited-levels'.
99 ;; In Org buffers, the value of `outline-regexp' is that of
100 ;; `org-outline-regexp'. The only function still directly relying on
101 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
102 ;; job when `orgstruct-mode' is active.
103 (defvar org-outline-regexp "\\*+ "
104 "Regexp to match Org headlines.")
106 (defvar org-outline-regexp-bol "^\\*+ "
107 "Regexp to match Org headlines.
108 This is similar to `org-outline-regexp' but additionally makes
109 sure that we are at the beginning of the line.")
111 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
112 "Matches a headline, putting stars and text into groups.
113 Stars are put in group 1 and the trimmed body in group 2.")
115 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
116 (unless (boundp 'calendar-view-holidays-initially-flag)
117 (org-defvaralias 'calendar-view-holidays-initially-flag
118 'view-calendar-holidays-initially))
119 (unless (boundp 'calendar-view-diary-initially-flag)
120 (org-defvaralias 'calendar-view-diary-initially-flag
121 'view-diary-entries-initially))
122 (unless (boundp 'diary-fancy-buffer)
123 (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
125 (declare-function org-add-archive-files "org-archive" (files))
127 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
128 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
129 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
130 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
131 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
132 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
133 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
134 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
135 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
136 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
137 (declare-function org-clock-update-time-maybe "org-clock" ())
138 (declare-function org-clocktable-shift "org-clock" (dir n))
140 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
141 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body))
142 (declare-function orgtbl-mode "org-table" (&optional arg))
143 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
144 (declare-function org-beamer-mode "ox-beamer" ())
145 (declare-function org-table-blank-field "org-table" ())
146 (declare-function org-table-edit-field "org-table" (arg))
147 (declare-function org-table-insert-row "org-table" (&optional arg))
148 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
149 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
150 (declare-function org-id-get-create "org-id" (&optional force))
151 (declare-function org-add-archive-files "org-archive" (files))
152 (declare-function org-id-find-id-file "org-id" (id))
153 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
154 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
155 (declare-function org-agenda-redo "org-agenda" (&optional all))
156 (declare-function org-table-align "org-table" ())
157 (declare-function org-table-begin "org-table" (&optional table-type))
158 (declare-function org-table-blank-field "org-table" ())
159 (declare-function org-table-end "org-table" (&optional table-type))
160 (declare-function org-table-end-of-field "org-table" (&optional n))
161 (declare-function org-table-insert-row "org-table" (&optional arg))
162 (declare-function org-table-paste-rectangle "org-table" ())
163 (declare-function org-table-maybe-eval-formula "org-table" ())
164 (declare-function org-table-maybe-recalculate-line "org-table" ())
165 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
166 (declare-function org-plot/gnuplot "org-plot" (&optional params))
168 (declare-function org-element-at-point "org-element" ())
169 (declare-function org-element-cache-reset "org-element" (&optional all))
170 (declare-function org-element-cache-refresh "org-element" (pos))
171 (declare-function org-element-contents "org-element" (element))
172 (declare-function org-element-context "org-element" (&optional element))
173 (declare-function org-element-interpret-data "org-element"
174 (data &optional parent))
175 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
176 (declare-function org-element-parse-buffer "org-element"
177 (&optional granularity visible-only))
178 (declare-function org-element-property "org-element" (property element))
179 (declare-function org-element-put-property "org-element"
180 (element property value))
181 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
182 (declare-function org-element-parse-buffer "org-element"
183 (&optional granularity visible-only))
184 (declare-function org-element-type "org-element" (element))
186 (defsubst org-uniquify (list)
187 "Non-destructively remove duplicate elements from LIST."
188 (let ((res (copy-sequence list))) (delete-dups res)))
190 (defsubst org-get-at-bol (property)
191 "Get text property PROPERTY at the beginning of line."
192 (get-text-property (point-at-bol) property))
194 (defsubst org-trim (s)
195 "Remove whitespace at the beginning and the end of string S."
196 (replace-regexp-in-string
197 "\\`[ \t\n\r]+" ""
198 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
200 ;; load languages based on value of `org-babel-load-languages'
201 (defvar org-babel-load-languages)
203 ;;;###autoload
204 (defun org-babel-do-load-languages (sym value)
205 "Load the languages defined in `org-babel-load-languages'."
206 (set-default sym value)
207 (mapc (lambda (pair)
208 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
209 (if active
210 (progn
211 (require (intern (concat "ob-" lang))))
212 (progn
213 (funcall 'fmakunbound
214 (intern (concat "org-babel-execute:" lang)))
215 (funcall 'fmakunbound
216 (intern (concat "org-babel-expand-body:" lang)))))))
217 org-babel-load-languages))
219 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
220 ;;;###autoload
221 (defun org-babel-load-file (file &optional compile)
222 "Load Emacs Lisp source code blocks in the Org-mode FILE.
223 This function exports the source code using `org-babel-tangle'
224 and then loads the resulting file using `load-file'. With prefix
225 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
226 file to byte-code before it is loaded."
227 (interactive "fFile to load: \nP")
228 (let* ((age (lambda (file)
229 (float-time
230 (time-subtract (current-time)
231 (nth 5 (or (file-attributes (file-truename file))
232 (file-attributes file)))))))
233 (base-name (file-name-sans-extension file))
234 (exported-file (concat base-name ".el")))
235 ;; tangle if the org-mode file is newer than the elisp file
236 (unless (and (file-exists-p exported-file)
237 (> (funcall age file) (funcall age exported-file)))
238 ;; Tangle-file traversal returns reversed list of tangled files
239 ;; and we want to evaluate the first target.
240 (setq exported-file
241 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
242 (message "%s %s"
243 (if compile
244 (progn (byte-compile-file exported-file 'load)
245 "Compiled and loaded")
246 (progn (load-file exported-file) "Loaded"))
247 exported-file)))
249 (defcustom org-babel-load-languages '((emacs-lisp . t))
250 "Languages which can be evaluated in Org-mode buffers.
251 This list can be used to load support for any of the languages
252 below, note that each language will depend on a different set of
253 system executables and/or Emacs modes. When a language is
254 \"loaded\", then code blocks in that language can be evaluated
255 with `org-babel-execute-src-block' bound by default to C-c
256 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
257 be set to remove code block evaluation from the C-c C-c
258 keybinding. By default only Emacs Lisp (which has no
259 requirements) is loaded."
260 :group 'org-babel
261 :set 'org-babel-do-load-languages
262 :version "24.1"
263 :type '(alist :tag "Babel Languages"
264 :key-type
265 (choice
266 (const :tag "Awk" awk)
267 (const :tag "C" C)
268 (const :tag "R" R)
269 (const :tag "Asymptote" asymptote)
270 (const :tag "Calc" calc)
271 (const :tag "Clojure" clojure)
272 (const :tag "CSS" css)
273 (const :tag "Ditaa" ditaa)
274 (const :tag "Dot" dot)
275 (const :tag "Emacs Lisp" emacs-lisp)
276 (const :tag "Forth" forth)
277 (const :tag "Fortran" fortran)
278 (const :tag "Gnuplot" gnuplot)
279 (const :tag "Haskell" haskell)
280 (const :tag "IO" io)
281 (const :tag "J" J)
282 (const :tag "Java" java)
283 (const :tag "Javascript" js)
284 (const :tag "LaTeX" latex)
285 (const :tag "Ledger" ledger)
286 (const :tag "Lilypond" lilypond)
287 (const :tag "Lisp" lisp)
288 (const :tag "Makefile" makefile)
289 (const :tag "Maxima" maxima)
290 (const :tag "Matlab" matlab)
291 (const :tag "Mscgen" mscgen)
292 (const :tag "Ocaml" ocaml)
293 (const :tag "Octave" octave)
294 (const :tag "Org" org)
295 (const :tag "Perl" perl)
296 (const :tag "Pico Lisp" picolisp)
297 (const :tag "PlantUML" plantuml)
298 (const :tag "Python" python)
299 (const :tag "Ruby" ruby)
300 (const :tag "Sass" sass)
301 (const :tag "Scala" scala)
302 (const :tag "Scheme" scheme)
303 (const :tag "Screen" screen)
304 (const :tag "Shell Script" shell)
305 (const :tag "Shen" shen)
306 (const :tag "Sql" sql)
307 (const :tag "Sqlite" sqlite)
308 (const :tag "ebnf2ps" ebnf2ps))
309 :value-type (boolean :tag "Activate" :value t)))
311 ;;;; Customization variables
312 (defcustom org-clone-delete-id nil
313 "Remove ID property of clones of a subtree.
314 When non-nil, clones of a subtree don't inherit the ID property.
315 Otherwise they inherit the ID property with a new unique
316 identifier."
317 :type 'boolean
318 :version "24.1"
319 :group 'org-id)
321 ;;; Version
322 (org-check-version)
324 ;;;###autoload
325 (defun org-version (&optional here full message)
326 "Show the org-mode version.
327 Interactively, or when MESSAGE is non-nil, show it in echo area.
328 With prefix argument, or when HERE is non-nil, insert it at point.
329 In non-interactive uses, a reduced version string is output unless
330 FULL is given."
331 (interactive (list current-prefix-arg t (not current-prefix-arg)))
332 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
333 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
334 (load-suffixes (list ".el"))
335 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
336 (org-trash (or
337 (and (fboundp 'org-release) (fboundp 'org-git-version))
338 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
339 (load-suffixes save-load-suffixes)
340 (org-version (org-release))
341 (git-version (org-git-version))
342 (version (format "Org-mode version %s (%s @ %s)"
343 org-version
344 git-version
345 (if org-install-dir
346 (if (string= org-dir org-install-dir)
347 org-install-dir
348 (concat "mixed installation! " org-install-dir " and " org-dir))
349 "org-loaddefs.el can not be found!")))
350 (version1 (if full version org-version)))
351 (when here (insert version1))
352 (when message (message "%s" version1))
353 version1))
355 (defconst org-version (org-version))
358 ;;; Syntax Constants
360 ;;;; Block
362 (defconst org-block-regexp
363 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
364 "Regular expression for hiding blocks.")
366 (defconst org-dblock-start-re
367 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
368 "Matches the start line of a dynamic block, with parameters.")
370 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
371 "Matches the end of a dynamic block.")
373 ;;;; Clock and Planning
375 (defconst org-clock-string "CLOCK:"
376 "String used as prefix for timestamps clocking work hours on an item.")
378 (defvar org-closed-string "CLOSED:"
379 "String used as the prefix for timestamps logging closing a TODO entry.")
381 (defvar org-deadline-string "DEADLINE:"
382 "String to mark deadline entries.
383 A deadline is this string, followed by a time stamp. Should be a word,
384 terminated by a colon. You can insert a schedule keyword and
385 a timestamp with \\[org-deadline].")
387 (defvar org-scheduled-string "SCHEDULED:"
388 "String to mark scheduled TODO entries.
389 A schedule is this string, followed by a time stamp. Should be a word,
390 terminated by a colon. You can insert a schedule keyword and
391 a timestamp with \\[org-schedule].")
393 (defconst org-ds-keyword-length
394 (+ 2
395 (apply #'max
396 (mapcar #'length
397 (list org-deadline-string org-scheduled-string
398 org-clock-string org-closed-string))))
399 "Maximum length of the DEADLINE and SCHEDULED keywords.")
401 (defconst org-planning-line-re
402 (concat "^[ \t]*"
403 (regexp-opt
404 (list org-closed-string org-deadline-string org-scheduled-string)
406 "Matches a line with planning info.
407 Matched keyword is in group 1.")
409 (defconst org-clock-line-re
410 (concat "^[ \t]*" org-clock-string)
411 "Matches a line with clock info.")
413 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
414 "Matches the DEADLINE keyword.")
416 (defconst org-deadline-time-regexp
417 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
418 "Matches the DEADLINE keyword together with a time stamp.")
420 (defconst org-deadline-time-hour-regexp
421 (concat "\\<" org-deadline-string
422 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
423 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
425 (defconst org-deadline-line-regexp
426 (concat "\\<\\(" org-deadline-string "\\).*")
427 "Matches the DEADLINE keyword and the rest of the line.")
429 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
430 "Matches the SCHEDULED keyword.")
432 (defconst org-scheduled-time-regexp
433 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
434 "Matches the SCHEDULED keyword together with a time stamp.")
436 (defconst org-scheduled-time-hour-regexp
437 (concat "\\<" org-scheduled-string
438 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
439 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
441 (defconst org-closed-time-regexp
442 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
443 "Matches the CLOSED keyword together with a time stamp.")
445 (defconst org-keyword-time-regexp
446 (concat "\\<"
447 (regexp-opt
448 (list org-scheduled-string org-deadline-string org-closed-string
449 org-clock-string)
451 " *[[<]\\([^]>]+\\)[]>]")
452 "Matches any of the 4 keywords, together with the time stamp.")
454 (defconst org-keyword-time-not-clock-regexp
455 (concat
456 "\\<"
457 (regexp-opt
458 (list org-scheduled-string org-deadline-string org-closed-string) t)
459 " *[[<]\\([^]>]+\\)[]>]")
460 "Matches any of the 3 keywords, together with the time stamp.")
462 (defconst org-maybe-keyword-time-regexp
463 (concat "\\(\\<"
464 (regexp-opt
465 (list org-scheduled-string org-deadline-string org-closed-string
466 org-clock-string)
468 "\\)?"
469 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
470 "\\|"
471 "<%%([^\r\n>]*>\\)")
472 "Matches a timestamp, possibly preceded by a keyword.")
474 (defconst org-all-time-keywords
475 (mapcar (lambda (w) (substring w 0 -1))
476 (list org-scheduled-string org-deadline-string
477 org-clock-string org-closed-string))
478 "List of time keywords.")
480 ;;;; Drawer
482 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
483 "Matches first or last line of a hidden block.
484 Group 1 contains drawer's name or \"END\".")
486 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
487 "Regular expression matching the first line of a property drawer.")
489 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
490 "Regular expression matching the last line of a property drawer.")
492 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
493 "Regular expression matching the first line of a clock drawer.")
495 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
496 "Regular expression matching the last line of a clock drawer.")
498 (defconst org-property-drawer-re
499 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
500 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
501 "[ \t]*:END:[ \t]*$")
502 "Matches an entire property drawer.")
504 (defconst org-clock-drawer-re
505 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
506 org-clock-drawer-end-re "\\)\n?")
507 "Matches an entire clock drawer.")
509 ;;;; Headline
511 (defconst org-heading-keyword-regexp-format
512 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
513 "Printf format for a regexp matching a headline with some keyword.
514 This regexp will match the headline of any node which has the
515 exact keyword that is put into the format. The keyword isn't in
516 any group by default, but the stars and the body are.")
518 (defconst org-heading-keyword-maybe-regexp-format
519 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
520 "Printf format for a regexp matching a headline, possibly with some keyword.
521 This regexp can match any headline with the specified keyword, or
522 without a keyword. The keyword isn't in any group by default,
523 but the stars and the body are.")
525 (defconst org-archive-tag "ARCHIVE"
526 "The tag that marks a subtree as archived.
527 An archived subtree does not open during visibility cycling, and does
528 not contribute to the agenda listings.")
530 (defconst org-comment-string "COMMENT"
531 "Entries starting with this keyword will never be exported.
532 An entry can be toggled between COMMENT and normal with
533 \\[org-toggle-comment].")
536 ;;;; LaTeX Environments and Fragments
538 (defconst org-latex-regexps
539 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
540 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
541 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
542 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
543 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
544 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
545 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
546 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
547 "Regular expressions for matching embedded LaTeX.")
549 ;;;; Node Property
551 (defconst org-effort-property "Effort"
552 "The property that is being used to keep track of effort estimates.
553 Effort estimates given in this property need to have the format H:MM.")
555 ;;;; Table
557 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
558 "Detect an org-type or table-type table.")
560 (defconst org-table-line-regexp "^[ \t]*|"
561 "Detect an org-type table line.")
563 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
564 "Detect an org-type table line.")
566 (defconst org-table-hline-regexp "^[ \t]*|-"
567 "Detect an org-type table hline.")
569 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
570 "Detect a table-type table hline.")
572 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
573 "Detect the first line outside a table when searching from within it.
574 This works for both table types.")
576 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
577 "Detect a #+TBLFM line.")
579 ;;;; Timestamp
581 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
582 "Regular expression for fast time stamp matching.")
584 (defconst org-ts-regexp-inactive
585 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
586 "Regular expression for fast inactive time stamp matching.")
588 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
589 "Regular expression for fast time stamp matching.")
591 (defconst org-ts-regexp0
592 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
593 "Regular expression matching time strings for analysis.
594 This one does not require the space after the date, so it can be used
595 on a string that terminates immediately after the date.")
597 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
598 "Regular expression matching time strings for analysis.")
600 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
601 "Regular expression matching time stamps, with groups.")
603 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
604 "Regular expression matching time stamps (also [..]), with groups.")
606 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
607 "Regular expression matching a time stamp range.")
609 (defconst org-tr-regexp-both
610 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
611 "Regular expression matching a time stamp range.")
613 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
614 org-ts-regexp "\\)?")
615 "Regular expression matching a time stamp or time stamp range.")
617 (defconst org-tsr-regexp-both
618 (concat org-ts-regexp-both "\\(--?-?"
619 org-ts-regexp-both "\\)?")
620 "Regular expression matching a time stamp or time stamp range.
621 The time stamps may be either active or inactive.")
623 (defconst org-repeat-re
624 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
625 "Regular expression for specifying repeated events.
626 After a match, group 1 contains the repeat expression.")
628 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
629 "Formats for `format-time-string' which are used for time stamps.")
632 ;;; The custom variables
634 (defgroup org nil
635 "Outline-based notes management and organizer."
636 :tag "Org"
637 :group 'outlines
638 :group 'calendar)
640 (defcustom org-mode-hook nil
641 "Mode hook for Org-mode, run after the mode was turned on."
642 :group 'org
643 :type 'hook)
645 (defcustom org-load-hook nil
646 "Hook that is run after org.el has been loaded."
647 :group 'org
648 :type 'hook)
650 (defcustom org-log-buffer-setup-hook nil
651 "Hook that is run after an Org log buffer is created."
652 :group 'org
653 :version "24.1"
654 :type 'hook)
656 (defvar org-modules) ; defined below
657 (defvar org-modules-loaded nil
658 "Have the modules been loaded already?")
660 (defun org-load-modules-maybe (&optional force)
661 "Load all extensions listed in `org-modules'."
662 (when (or force (not org-modules-loaded))
663 (mapc (lambda (ext)
664 (condition-case nil (require ext)
665 (error (message "Problems while trying to load feature `%s'" ext))))
666 org-modules)
667 (setq org-modules-loaded t)))
669 (defun org-set-modules (var value)
670 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
671 (set var value)
672 (when (featurep 'org)
673 (org-load-modules-maybe 'force)
674 (org-element-cache-reset 'all)))
676 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
677 "Modules that should always be loaded together with org.el.
679 If a description starts with <C>, the file is not part of Emacs
680 and loading it will require that you have downloaded and properly
681 installed the Org mode distribution.
683 You can also use this system to load external packages (i.e. neither Org
684 core modules, nor modules from the CONTRIB directory). Just add symbols
685 to the end of the list. If the package is called org-xyz.el, then you need
686 to add the symbol `xyz', and the package must have a call to:
688 \(provide 'org-xyz)
690 For export specific modules, see also `org-export-backends'."
691 :group 'org
692 :set 'org-set-modules
693 :version "24.4"
694 :package-version '(Org . "8.0")
695 :type
696 '(set :greedy t
697 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
698 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
699 (const :tag " crypt: Encryption of subtrees" org-crypt)
700 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
701 (const :tag " docview: Links to doc-view buffers" org-docview)
702 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
703 (const :tag " habit: Track your consistency with habits" org-habit)
704 (const :tag " id: Global IDs for identifying entries" org-id)
705 (const :tag " info: Links to Info nodes" org-info)
706 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
707 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
708 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
709 (const :tag " mouse: Additional mouse support" org-mouse)
710 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
711 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
712 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
714 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
715 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
716 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
717 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
718 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
719 (const :tag "C collector: Collect properties into tables" org-collector)
720 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
721 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
722 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
723 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
724 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
725 (const :tag "C eval: Include command output as text" org-eval)
726 (const :tag "C eww: Store link to url of eww" org-eww)
727 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
728 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
729 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
730 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
731 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
732 (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
733 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
734 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
735 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
736 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
737 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
738 (const :tag "C mew: Links to Mew folders/messages" org-mew)
739 (const :tag "C mtags: Support for muse-like tags" org-mtags)
740 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
741 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
742 (const :tag "C registry: A registry for Org-mode links" org-registry)
743 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
744 (const :tag "C secretary: Team management with org-mode" org-secretary)
745 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
746 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
747 (const :tag "C track: Keep up with Org-mode development" org-track)
748 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
749 (const :tag "C vm: Links to VM folders/messages" org-vm)
750 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
751 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
752 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
754 (defvar org-export--registered-backends) ; From ox.el.
755 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
756 (declare-function org-export-backend-name "ox" (backend))
757 (defcustom org-export-backends '(ascii html icalendar latex)
758 "List of export back-ends that should be always available.
760 If a description starts with <C>, the file is not part of Emacs
761 and loading it will require that you have downloaded and properly
762 installed the Org mode distribution.
764 Unlike to `org-modules', libraries in this list will not be
765 loaded along with Org, but only once the export framework is
766 needed.
768 This variable needs to be set before org.el is loaded. If you
769 need to make a change while Emacs is running, use the customize
770 interface or run the following code, where VAL stands for the new
771 value of the variable, after updating it:
773 \(progn
774 \(setq org-export--registered-backends
775 \(org-remove-if-not
776 \(lambda (backend)
777 \(let ((name (org-export-backend-name backend)))
778 \(or (memq name val)
779 \(catch 'parentp
780 \(dolist (b val)
781 \(and (org-export-derived-backend-p b name)
782 \(throw 'parentp t)))))))
783 org-export--registered-backends))
784 \(let ((new-list (mapcar 'org-export-backend-name
785 org-export--registered-backends)))
786 \(dolist (backend val)
787 \(cond
788 \((not (load (format \"ox-%s\" backend) t t))
789 \(message \"Problems while trying to load export back-end `%s'\"
790 backend))
791 \((not (memq backend new-list)) (push backend new-list))))
792 \(set-default 'org-export-backends new-list)))
794 Adding a back-end to this list will also pull the back-end it
795 depends on, if any."
796 :group 'org
797 :group 'org-export
798 :version "24.4"
799 :package-version '(Org . "8.0")
800 :initialize 'custom-initialize-set
801 :set (lambda (var val)
802 (if (not (featurep 'ox)) (set-default var val)
803 ;; Any back-end not required anymore (not present in VAL and not
804 ;; a parent of any back-end in the new value) is removed from the
805 ;; list of registered back-ends.
806 (setq org-export--registered-backends
807 (org-remove-if-not
808 (lambda (backend)
809 (let ((name (org-export-backend-name backend)))
810 (or (memq name val)
811 (catch 'parentp
812 (dolist (b val)
813 (and (org-export-derived-backend-p b name)
814 (throw 'parentp t)))))))
815 org-export--registered-backends))
816 ;; Now build NEW-LIST of both new back-ends and required
817 ;; parents.
818 (let ((new-list (mapcar 'org-export-backend-name
819 org-export--registered-backends)))
820 (dolist (backend val)
821 (cond
822 ((not (load (format "ox-%s" backend) t t))
823 (message "Problems while trying to load export back-end `%s'"
824 backend))
825 ((not (memq backend new-list)) (push backend new-list))))
826 ;; Set VAR to that list with fixed dependencies.
827 (set-default var new-list))))
828 :type '(set :greedy t
829 (const :tag " ascii Export buffer to ASCII format" ascii)
830 (const :tag " beamer Export buffer to Beamer presentation" beamer)
831 (const :tag " html Export buffer to HTML format" html)
832 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
833 (const :tag " latex Export buffer to LaTeX format" latex)
834 (const :tag " man Export buffer to MAN format" man)
835 (const :tag " md Export buffer to Markdown format" md)
836 (const :tag " odt Export buffer to ODT format" odt)
837 (const :tag " org Export buffer to Org format" org)
838 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
839 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
840 (const :tag "C deck Export buffer to deck.js presentations" deck)
841 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
842 (const :tag "C groff Export buffer to Groff format" groff)
843 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
844 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
845 (const :tag "C s5 Export buffer to s5 presentations" s5)
846 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
848 (eval-after-load 'ox
849 '(mapc
850 (lambda (backend)
851 (condition-case nil (require (intern (format "ox-%s" backend)))
852 (error (message "Problems while trying to load export back-end `%s'"
853 backend))))
854 org-export-backends))
856 (defcustom org-support-shift-select nil
857 "Non-nil means make shift-cursor commands select text when possible.
859 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
860 start selecting a region, or enlarge regions started in this way.
861 In Org-mode, in special contexts, these same keys are used for
862 other purposes, important enough to compete with shift selection.
863 Org tries to balance these needs by supporting `shift-select-mode'
864 outside these special contexts, under control of this variable.
866 The default of this variable is nil, to avoid confusing behavior. Shifted
867 cursor keys will then execute Org commands in the following contexts:
868 - on a headline, changing TODO state (left/right) and priority (up/down)
869 - on a time stamp, changing the time
870 - in a plain list item, changing the bullet type
871 - in a property definition line, switching between allowed values
872 - in the BEGIN line of a clock table (changing the time block).
873 Outside these contexts, the commands will throw an error.
875 When this variable is t and the cursor is not in a special
876 context, Org-mode will support shift-selection for making and
877 enlarging regions. To make this more effective, the bullet
878 cycling will no longer happen anywhere in an item line, but only
879 if the cursor is exactly on the bullet.
881 If you set this variable to the symbol `always', then the keys
882 will not be special in headlines, property lines, and item lines,
883 to make shift selection work there as well. If this is what you
884 want, you can use the following alternative commands: `C-c C-t'
885 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
886 can be used to switch TODO sets, `C-c -' to cycle item bullet
887 types, and properties can be edited by hand or in column view.
889 However, when the cursor is on a timestamp, shift-cursor commands
890 will still edit the time stamp - this is just too good to give up.
892 XEmacs user should have this variable set to nil, because
893 `shift-select-mode' is in Emacs 23 or later only."
894 :group 'org
895 :type '(choice
896 (const :tag "Never" nil)
897 (const :tag "When outside special context" t)
898 (const :tag "Everywhere except timestamps" always)))
900 (defcustom org-loop-over-headlines-in-active-region nil
901 "Shall some commands act upon headlines in the active region?
903 When set to `t', some commands will be performed in all headlines
904 within the active region.
906 When set to `start-level', some commands will be performed in all
907 headlines within the active region, provided that these headlines
908 are of the same level than the first one.
910 When set to a string, those commands will be performed on the
911 matching headlines within the active region. Such string must be
912 a tags/property/todo match as it is used in the agenda tags view.
914 The list of commands is: `org-schedule', `org-deadline',
915 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
916 `org-archive-to-archive-sibling'. The archiving commands skip
917 already archived entries."
918 :type '(choice (const :tag "Don't loop" nil)
919 (const :tag "All headlines in active region" t)
920 (const :tag "In active region, headlines at the same level than the first one" start-level)
921 (string :tag "Tags/Property/Todo matcher"))
922 :version "24.1"
923 :group 'org-todo
924 :group 'org-archive)
926 (defgroup org-startup nil
927 "Options concerning startup of Org-mode."
928 :tag "Org Startup"
929 :group 'org)
931 (defcustom org-startup-folded t
932 "Non-nil means entering Org-mode will switch to OVERVIEW.
933 This can also be configured on a per-file basis by adding one of
934 the following lines anywhere in the buffer:
936 #+STARTUP: fold (or `overview', this is equivalent)
937 #+STARTUP: nofold (or `showall', this is equivalent)
938 #+STARTUP: content
939 #+STARTUP: showeverything
941 By default, this option is ignored when Org opens agenda files
942 for the first time. If you want the agenda to honor the startup
943 option, set `org-agenda-inhibit-startup' to nil."
944 :group 'org-startup
945 :type '(choice
946 (const :tag "nofold: show all" nil)
947 (const :tag "fold: overview" t)
948 (const :tag "content: all headlines" content)
949 (const :tag "show everything, even drawers" showeverything)))
951 (defcustom org-startup-truncated t
952 "Non-nil means entering Org-mode will set `truncate-lines'.
953 This is useful since some lines containing links can be very long and
954 uninteresting. Also tables look terrible when wrapped."
955 :group 'org-startup
956 :type 'boolean)
958 (defcustom org-startup-indented nil
959 "Non-nil means turn on `org-indent-mode' on startup.
960 This can also be configured on a per-file basis by adding one of
961 the following lines anywhere in the buffer:
963 #+STARTUP: indent
964 #+STARTUP: noindent"
965 :group 'org-structure
966 :type '(choice
967 (const :tag "Not" nil)
968 (const :tag "Globally (slow on startup in large files)" t)))
970 (defcustom org-use-sub-superscripts t
971 "Non-nil means interpret \"_\" and \"^\" for display.
973 If you want to control how Org exports those characters, see
974 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
975 used to be an alias for `org-export-with-sub-superscripts' in
976 Org <8.0, it is not anymore.
978 When this option is turned on, you can use TeX-like syntax for
979 sub- and superscripts within the buffer. Several characters after
980 \"_\" or \"^\" will be considered as a single item - so grouping
981 with {} is normally not needed. For example, the following things
982 will be parsed as single sub- or superscripts:
984 10^24 or 10^tau several digits will be considered 1 item.
985 10^-12 or 10^-tau a leading sign with digits or a word
986 x^2-y^3 will be read as x^2 - y^3, because items are
987 terminated by almost any nonword/nondigit char.
988 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
990 Still, ambiguity is possible. So when in doubt, use {} to enclose
991 the sub/superscript. If you set this variable to the symbol `{}',
992 the braces are *required* in order to trigger interpretations as
993 sub/superscript. This can be helpful in documents that need \"_\"
994 frequently in plain text."
995 :group 'org-startup
996 :version "24.4"
997 :package-version '(Org . "8.0")
998 :type '(choice
999 (const :tag "Always interpret" t)
1000 (const :tag "Only with braces" {})
1001 (const :tag "Never interpret" nil)))
1003 (defcustom org-startup-with-beamer-mode nil
1004 "Non-nil means turn on `org-beamer-mode' on startup.
1005 This can also be configured on a per-file basis by adding one of
1006 the following lines anywhere in the buffer:
1008 #+STARTUP: beamer"
1009 :group 'org-startup
1010 :version "24.1"
1011 :type 'boolean)
1013 (defcustom org-startup-align-all-tables nil
1014 "Non-nil means align all tables when visiting a file.
1015 This is useful when the column width in tables is forced with <N> cookies
1016 in table fields. Such tables will look correct only after the first re-align.
1017 This can also be configured on a per-file basis by adding one of
1018 the following lines anywhere in the buffer:
1019 #+STARTUP: align
1020 #+STARTUP: noalign"
1021 :group 'org-startup
1022 :type 'boolean)
1024 (defcustom org-startup-with-inline-images nil
1025 "Non-nil means show inline images when loading a new Org file.
1026 This can also be configured on a per-file basis by adding one of
1027 the following lines anywhere in the buffer:
1028 #+STARTUP: inlineimages
1029 #+STARTUP: noinlineimages"
1030 :group 'org-startup
1031 :version "24.1"
1032 :type 'boolean)
1034 (defcustom org-startup-with-latex-preview nil
1035 "Non-nil means preview LaTeX fragments when loading a new Org file.
1037 This can also be configured on a per-file basis by adding one of
1038 the following lines anywhere in the buffer:
1039 #+STARTUP: latexpreview
1040 #+STARTUP: nolatexpreview"
1041 :group 'org-startup
1042 :version "24.4"
1043 :package-version '(Org . "8.0")
1044 :type 'boolean)
1046 (defcustom org-insert-mode-line-in-empty-file nil
1047 "Non-nil means insert the first line setting Org-mode in empty files.
1048 When the function `org-mode' is called interactively in an empty file, this
1049 normally means that the file name does not automatically trigger Org-mode.
1050 To ensure that the file will always be in Org-mode in the future, a
1051 line enforcing Org-mode will be inserted into the buffer, if this option
1052 has been set."
1053 :group 'org-startup
1054 :type 'boolean)
1056 (defcustom org-replace-disputed-keys nil
1057 "Non-nil means use alternative key bindings for some keys.
1058 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1059 These keys are also used by other packages like shift-selection-mode'
1060 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1061 If you want to use Org-mode together with one of these other modes,
1062 or more generally if you would like to move some Org-mode commands to
1063 other keys, set this variable and configure the keys with the variable
1064 `org-disputed-keys'.
1066 This option is only relevant at load-time of Org-mode, and must be set
1067 *before* org.el is loaded. Changing it requires a restart of Emacs to
1068 become effective."
1069 :group 'org-startup
1070 :type 'boolean)
1072 (defcustom org-use-extra-keys nil
1073 "Non-nil means use extra key sequence definitions for certain commands.
1074 This happens automatically if you run XEmacs or if `window-system'
1075 is nil. This variable lets you do the same manually. You must
1076 set it before loading org.
1078 Example: on Carbon Emacs 22 running graphically, with an external
1079 keyboard on a Powerbook, the default way of setting M-left might
1080 not work for either Alt or ESC. Setting this variable will make
1081 it work for ESC."
1082 :group 'org-startup
1083 :type 'boolean)
1085 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1087 (defcustom org-disputed-keys
1088 '(([(shift up)] . [(meta p)])
1089 ([(shift down)] . [(meta n)])
1090 ([(shift left)] . [(meta -)])
1091 ([(shift right)] . [(meta +)])
1092 ([(control shift right)] . [(meta shift +)])
1093 ([(control shift left)] . [(meta shift -)]))
1094 "Keys for which Org-mode and other modes compete.
1095 This is an alist, cars are the default keys, second element specifies
1096 the alternative to use when `org-replace-disputed-keys' is t.
1098 Keys can be specified in any syntax supported by `define-key'.
1099 The value of this option takes effect only at Org-mode's startup,
1100 therefore you'll have to restart Emacs to apply it after changing."
1101 :group 'org-startup
1102 :type 'alist)
1104 (defun org-key (key)
1105 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1106 Or return the original if not disputed.
1107 Also apply the translations defined in `org-xemacs-key-equivalents'."
1108 (when org-replace-disputed-keys
1109 (let* ((nkey (key-description key))
1110 (x (org-find-if (lambda (x)
1111 (equal (key-description (car x)) nkey))
1112 org-disputed-keys)))
1113 (setq key (if x (cdr x) key))))
1114 (when (featurep 'xemacs)
1115 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1116 key)
1118 (defun org-find-if (predicate seq)
1119 (catch 'exit
1120 (while seq
1121 (if (funcall predicate (car seq))
1122 (throw 'exit (car seq))
1123 (pop seq)))))
1125 (defun org-defkey (keymap key def)
1126 "Define a key, possibly translated, as returned by `org-key'."
1127 (define-key keymap (org-key key) def))
1129 (defcustom org-ellipsis nil
1130 "The ellipsis to use in the Org-mode outline.
1131 When nil, just use the standard three dots.
1132 When a string, use that string instead.
1133 When a face, use the standard 3 dots, but with the specified face.
1134 The change affects only Org-mode (which will then use its own display table).
1135 Changing this requires executing \\[org-mode] in a buffer to become
1136 effective."
1137 :group 'org-startup
1138 :type '(choice (const :tag "Default" nil)
1139 (face :tag "Face" :value org-warning)
1140 (string :tag "String" :value "...#")))
1142 (defvar org-display-table nil
1143 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1145 (defgroup org-keywords nil
1146 "Keywords in Org-mode."
1147 :tag "Org Keywords"
1148 :group 'org)
1150 (defcustom org-closed-keep-when-no-todo nil
1151 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1152 :group 'org-todo
1153 :group 'org-keywords
1154 :version "24.4"
1155 :package-version '(Org . "8.0")
1156 :type 'boolean)
1158 (defgroup org-structure nil
1159 "Options concerning the general structure of Org-mode files."
1160 :tag "Org Structure"
1161 :group 'org)
1163 (defgroup org-reveal-location nil
1164 "Options about how to make context of a location visible."
1165 :tag "Org Reveal Location"
1166 :group 'org-structure)
1168 (defcustom org-show-context-detail '((isearch . lineage)
1169 (bookmark-jump . lineage)
1170 (default . ancestors))
1171 "Alist between context and visibility span when revealing a location.
1173 \\<org-mode-map>Some actions may move point into invisible
1174 locations. As a consequence, Org always expose a neighborhood
1175 around point. How much is shown depends on the initial action,
1176 or context. Valid contexts are
1178 agenda when exposing an entry from the agenda
1179 org-goto when using the command `org-goto' (\\[org-goto])
1180 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1181 tags-tree when constructing a sparse tree based on tags matches
1182 link-search when exposing search matches associated with a link
1183 mark-goto when exposing the jump goal of a mark
1184 bookmark-jump when exposing a bookmark location
1185 isearch when exiting from an incremental search
1186 default default for all contexts not set explicitly
1188 Allowed visibility spans are
1190 minimal show current headline; if point is not on headline,
1191 also show entry
1193 local show current headline, entry and next headline
1195 ancestors show current headline and its direct ancestors; if
1196 point is not on headline, also show entry
1198 lineage show current headline, its direct ancestors and all
1199 their children; if point is not on headline, also show
1200 entry and first child
1202 tree show current headline, its direct ancestors and all
1203 their children; if point is not on headline, also show
1204 entry and all children
1206 canonical show current headline, its direct ancestors along with
1207 their entries and children; if point is not located on
1208 the headline, also show current entry and all children
1210 As special cases, a nil or t value means show all contexts in
1211 `minimal' or `canonical' view, respectively.
1213 Some views can make displayed information very compact, but also
1214 make it harder to edit the location of the match. In such
1215 a case, use the command `org-reveal' (\\[org-reveal]) to show
1216 more context."
1217 :group 'org-reveal-location
1218 :version "25.1"
1219 :package-version '(Org . "8.3")
1220 :type '(choice
1221 (const :tag "Canonical" t)
1222 (const :tag "Minimal" nil)
1223 (repeat :greedy t :tag "Individual contexts"
1224 (cons
1225 (choice :tag "Context"
1226 (const agenda)
1227 (const org-goto)
1228 (const occur-tree)
1229 (const tags-tree)
1230 (const link-search)
1231 (const mark-goto)
1232 (const bookmark-jump)
1233 (const isearch)
1234 (const default))
1235 (choice :tag "Detail level"
1236 (const minimal)
1237 (const local)
1238 (const ancestors)
1239 (const lineage)
1240 (const tree)
1241 (const canonical))))))
1243 (defcustom org-indirect-buffer-display 'other-window
1244 "How should indirect tree buffers be displayed?
1245 This applies to indirect buffers created with the commands
1246 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1247 Valid values are:
1248 current-window Display in the current window
1249 other-window Just display in another window.
1250 dedicated-frame Create one new frame, and re-use it each time.
1251 new-frame Make a new frame each time. Note that in this case
1252 previously-made indirect buffers are kept, and you need to
1253 kill these buffers yourself."
1254 :group 'org-structure
1255 :group 'org-agenda-windows
1256 :type '(choice
1257 (const :tag "In current window" current-window)
1258 (const :tag "In current frame, other window" other-window)
1259 (const :tag "Each time a new frame" new-frame)
1260 (const :tag "One dedicated frame" dedicated-frame)))
1262 (defcustom org-use-speed-commands nil
1263 "Non-nil means activate single letter commands at beginning of a headline.
1264 This may also be a function to test for appropriate locations where speed
1265 commands should be active.
1267 For example, to activate speed commands when the point is on any
1268 star at the beginning of the headline, you can do this:
1270 (setq org-use-speed-commands
1271 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1272 :group 'org-structure
1273 :type '(choice
1274 (const :tag "Never" nil)
1275 (const :tag "At beginning of headline stars" t)
1276 (function)))
1278 (defcustom org-speed-commands-user nil
1279 "Alist of additional speed commands.
1280 This list will be checked before `org-speed-commands-default'
1281 when the variable `org-use-speed-commands' is non-nil
1282 and when the cursor is at the beginning of a headline.
1283 The car if each entry is a string with a single letter, which must
1284 be assigned to `self-insert-command' in the global map.
1285 The cdr is either a command to be called interactively, a function
1286 to be called, or a form to be evaluated.
1287 An entry that is just a list with a single string will be interpreted
1288 as a descriptive headline that will be added when listing the speed
1289 commands in the Help buffer using the `?' speed command."
1290 :group 'org-structure
1291 :type '(repeat :value ("k" . ignore)
1292 (choice :value ("k" . ignore)
1293 (list :tag "Descriptive Headline" (string :tag "Headline"))
1294 (cons :tag "Letter and Command"
1295 (string :tag "Command letter")
1296 (choice
1297 (function)
1298 (sexp))))))
1300 (defcustom org-bookmark-names-plist
1301 '(:last-capture "org-capture-last-stored"
1302 :last-refile "org-refile-last-stored"
1303 :last-capture-marker "org-capture-last-stored-marker")
1304 "Names for bookmarks automatically set by some Org commands.
1305 This can provide strings as names for a number of bookmarks Org sets
1306 automatically. The following keys are currently implemented:
1307 :last-capture
1308 :last-capture-marker
1309 :last-refile
1310 When a key does not show up in the property list, the corresponding bookmark
1311 is not set."
1312 :group 'org-structure
1313 :type 'plist)
1315 (defgroup org-cycle nil
1316 "Options concerning visibility cycling in Org-mode."
1317 :tag "Org Cycle"
1318 :group 'org-structure)
1320 (defcustom org-cycle-skip-children-state-if-no-children t
1321 "Non-nil means skip CHILDREN state in entries that don't have any."
1322 :group 'org-cycle
1323 :type 'boolean)
1325 (defcustom org-cycle-max-level nil
1326 "Maximum level which should still be subject to visibility cycling.
1327 Levels higher than this will, for cycling, be treated as text, not a headline.
1328 When `org-odd-levels-only' is set, a value of N in this variable actually
1329 means 2N-1 stars as the limiting headline.
1330 When nil, cycle all levels.
1331 Note that the limiting level of cycling is also influenced by
1332 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1333 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1334 than its value."
1335 :group 'org-cycle
1336 :type '(choice
1337 (const :tag "No limit" nil)
1338 (integer :tag "Maximum level")))
1340 (defcustom org-hide-block-startup nil
1341 "Non-nil means entering Org-mode will fold all blocks.
1342 This can also be set in on a per-file basis with
1344 #+STARTUP: hideblocks
1345 #+STARTUP: showblocks"
1346 :group 'org-startup
1347 :group 'org-cycle
1348 :type 'boolean)
1350 (defcustom org-cycle-global-at-bob nil
1351 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1352 This makes it possible to do global cycling without having to use S-TAB or
1353 \\[universal-argument] TAB. For this special case to work, the first line
1354 of the buffer must not be a headline -- it may be empty or some other text.
1355 When used in this way, `org-cycle-hook' is disabled temporarily to make
1356 sure the cursor stays at the beginning of the buffer. When this option is
1357 nil, don't do anything special at the beginning of the buffer."
1358 :group 'org-cycle
1359 :type 'boolean)
1361 (defcustom org-cycle-level-after-item/entry-creation t
1362 "Non-nil means cycle entry level or item indentation in new empty entries.
1364 When the cursor is at the end of an empty headline, i.e., with only stars
1365 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1366 and then all possible ancestor states, before returning to the original state.
1367 This makes data entry extremely fast: M-RET to create a new headline,
1368 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1370 When the cursor is at the end of an empty plain list item, one TAB will
1371 make it a subitem, two or more tabs will back up to make this an item
1372 higher up in the item hierarchy."
1373 :group 'org-cycle
1374 :type 'boolean)
1376 (defcustom org-cycle-emulate-tab t
1377 "Where should `org-cycle' emulate TAB.
1378 nil Never
1379 white Only in completely white lines
1380 whitestart Only at the beginning of lines, before the first non-white char
1381 t Everywhere except in headlines
1382 exc-hl-bol Everywhere except at the start of a headline
1383 If TAB is used in a place where it does not emulate TAB, the current subtree
1384 visibility is cycled."
1385 :group 'org-cycle
1386 :type '(choice (const :tag "Never" nil)
1387 (const :tag "Only in completely white lines" white)
1388 (const :tag "Before first char in a line" whitestart)
1389 (const :tag "Everywhere except in headlines" t)
1390 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1392 (defcustom org-cycle-separator-lines 2
1393 "Number of empty lines needed to keep an empty line between collapsed trees.
1394 If you leave an empty line between the end of a subtree and the following
1395 headline, this empty line is hidden when the subtree is folded.
1396 Org-mode will leave (exactly) one empty line visible if the number of
1397 empty lines is equal or larger to the number given in this variable.
1398 So the default 2 means at least 2 empty lines after the end of a subtree
1399 are needed to produce free space between a collapsed subtree and the
1400 following headline.
1402 If the number is negative, and the number of empty lines is at least -N,
1403 all empty lines are shown.
1405 Special case: when 0, never leave empty lines in collapsed view."
1406 :group 'org-cycle
1407 :type 'integer)
1408 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1410 (defcustom org-pre-cycle-hook nil
1411 "Hook that is run before visibility cycling is happening.
1412 The function(s) in this hook must accept a single argument which indicates
1413 the new state that will be set right after running this hook. The
1414 argument is a symbol. Before a global state change, it can have the values
1415 `overview', `content', or `all'. Before a local state change, it can have
1416 the values `folded', `children', or `subtree'."
1417 :group 'org-cycle
1418 :type 'hook)
1420 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1421 org-cycle-hide-drawers
1422 org-cycle-hide-inline-tasks
1423 org-cycle-show-empty-lines
1424 org-optimize-window-after-visibility-change)
1425 "Hook that is run after `org-cycle' has changed the buffer visibility.
1426 The function(s) in this hook must accept a single argument which indicates
1427 the new state that was set by the most recent `org-cycle' command. The
1428 argument is a symbol. After a global state change, it can have the values
1429 `overview', `contents', or `all'. After a local state change, it can have
1430 the values `folded', `children', or `subtree'."
1431 :group 'org-cycle
1432 :type 'hook)
1434 (defgroup org-edit-structure nil
1435 "Options concerning structure editing in Org-mode."
1436 :tag "Org Edit Structure"
1437 :group 'org-structure)
1439 (defcustom org-odd-levels-only nil
1440 "Non-nil means skip even levels and only use odd levels for the outline.
1441 This has the effect that two stars are being added/taken away in
1442 promotion/demotion commands. It also influences how levels are
1443 handled by the exporters.
1444 Changing it requires restart of `font-lock-mode' to become effective
1445 for fontification also in regions already fontified.
1446 You may also set this on a per-file basis by adding one of the following
1447 lines to the buffer:
1449 #+STARTUP: odd
1450 #+STARTUP: oddeven"
1451 :group 'org-edit-structure
1452 :group 'org-appearance
1453 :type 'boolean)
1455 (defcustom org-adapt-indentation t
1456 "Non-nil means adapt indentation to outline node level.
1458 When this variable is set, Org assumes that you write outlines by
1459 indenting text in each node to align with the headline (after the
1460 stars). The following issues are influenced by this variable:
1462 - The indentation is increased by one space in a demotion
1463 command, and decreased by one in a promotion command. However,
1464 in the latter case, if shifting some line in the entry body
1465 would alter document structure (e.g., insert a new headline),
1466 indentation is not changed at all.
1468 - Property drawers and planning information is inserted indented
1469 when this variable is set. When nil, they will not be indented.
1471 - TAB indents a line relative to current level. The lines below
1472 a headline will be indented when this variable is set.
1474 Note that this is all about true indentation, by adding and
1475 removing space characters. See also `org-indent.el' which does
1476 level-dependent indentation in a virtual way, i.e. at display
1477 time in Emacs."
1478 :group 'org-edit-structure
1479 :type 'boolean)
1481 (defcustom org-special-ctrl-a/e nil
1482 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1484 When t, `C-a' will bring back the cursor to the beginning of the
1485 headline text, i.e. after the stars and after a possible TODO
1486 keyword. In an item, this will be the position after bullet and
1487 check-box, if any. When the cursor is already at that position,
1488 another `C-a' will bring it to the beginning of the line.
1490 `C-e' will jump to the end of the headline, ignoring the presence
1491 of tags in the headline. A second `C-e' will then jump to the
1492 true end of the line, after any tags. This also means that, when
1493 this variable is non-nil, `C-e' also will never jump beyond the
1494 end of the heading of a folded section, i.e. not after the
1495 ellipses.
1497 When set to the symbol `reversed', the first `C-a' or `C-e' works
1498 normally, going to the true line boundary first. Only a directly
1499 following, identical keypress will bring the cursor to the
1500 special positions.
1502 This may also be a cons cell where the behavior for `C-a' and
1503 `C-e' is set separately."
1504 :group 'org-edit-structure
1505 :type '(choice
1506 (const :tag "off" nil)
1507 (const :tag "on: after stars/bullet and before tags first" t)
1508 (const :tag "reversed: true line boundary first" reversed)
1509 (cons :tag "Set C-a and C-e separately"
1510 (choice :tag "Special C-a"
1511 (const :tag "off" nil)
1512 (const :tag "on: after stars/bullet first" t)
1513 (const :tag "reversed: before stars/bullet first" reversed))
1514 (choice :tag "Special C-e"
1515 (const :tag "off" nil)
1516 (const :tag "on: before tags first" t)
1517 (const :tag "reversed: after tags first" reversed)))))
1518 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1520 (defcustom org-special-ctrl-k nil
1521 "Non-nil means `C-k' will behave specially in headlines.
1522 When nil, `C-k' will call the default `kill-line' command.
1523 When t, the following will happen while the cursor is in the headline:
1525 - When the cursor is at the beginning of a headline, kill the entire
1526 line and possible the folded subtree below the line.
1527 - When in the middle of the headline text, kill the headline up to the tags.
1528 - When after the headline text, kill the tags."
1529 :group 'org-edit-structure
1530 :type 'boolean)
1532 (defcustom org-ctrl-k-protect-subtree nil
1533 "Non-nil means, do not delete a hidden subtree with C-k.
1534 When set to the symbol `error', simply throw an error when C-k is
1535 used to kill (part-of) a headline that has hidden text behind it.
1536 Any other non-nil value will result in a query to the user, if it is
1537 OK to kill that hidden subtree. When nil, kill without remorse."
1538 :group 'org-edit-structure
1539 :version "24.1"
1540 :type '(choice
1541 (const :tag "Do not protect hidden subtrees" nil)
1542 (const :tag "Protect hidden subtrees with a security query" t)
1543 (const :tag "Never kill a hidden subtree with C-k" error)))
1545 (defcustom org-special-ctrl-o t
1546 "Non-nil means, make `C-o' insert a row in tables."
1547 :group 'org-edit-structure
1548 :type 'boolean)
1550 (defcustom org-catch-invisible-edits nil
1551 "Check if in invisible region before inserting or deleting a character.
1552 Valid values are:
1554 nil Do not check, so just do invisible edits.
1555 error Throw an error and do nothing.
1556 show Make point visible, and do the requested edit.
1557 show-and-error Make point visible, then throw an error and abort the edit.
1558 smart Make point visible, and do insertion/deletion if it is
1559 adjacent to visible text and the change feels predictable.
1560 Never delete a previously invisible character or add in the
1561 middle or right after an invisible region. Basically, this
1562 allows insertion and backward-delete right before ellipses.
1563 FIXME: maybe in this case we should not even show?"
1564 :group 'org-edit-structure
1565 :version "24.1"
1566 :type '(choice
1567 (const :tag "Do not check" nil)
1568 (const :tag "Throw error when trying to edit" error)
1569 (const :tag "Unhide, but do not do the edit" show-and-error)
1570 (const :tag "Show invisible part and do the edit" show)
1571 (const :tag "Be smart and do the right thing" smart)))
1573 (defcustom org-yank-folded-subtrees t
1574 "Non-nil means when yanking subtrees, fold them.
1575 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1576 it starts with a heading and all other headings in it are either children
1577 or siblings, then fold all the subtrees. However, do this only if no
1578 text after the yank would be swallowed into a folded tree by this action."
1579 :group 'org-edit-structure
1580 :type 'boolean)
1582 (defcustom org-yank-adjusted-subtrees nil
1583 "Non-nil means when yanking subtrees, adjust the level.
1584 With this setting, `org-paste-subtree' is used to insert the subtree, see
1585 this function for details."
1586 :group 'org-edit-structure
1587 :type 'boolean)
1589 (defcustom org-M-RET-may-split-line '((default . t))
1590 "Non-nil means M-RET will split the line at the cursor position.
1591 When nil, it will go to the end of the line before making a
1592 new line.
1593 You may also set this option in a different way for different
1594 contexts. Valid contexts are:
1596 headline when creating a new headline
1597 item when creating a new item
1598 table in a table field
1599 default the value to be used for all contexts not explicitly
1600 customized"
1601 :group 'org-structure
1602 :group 'org-table
1603 :type '(choice
1604 (const :tag "Always" t)
1605 (const :tag "Never" nil)
1606 (repeat :greedy t :tag "Individual contexts"
1607 (cons
1608 (choice :tag "Context"
1609 (const headline)
1610 (const item)
1611 (const table)
1612 (const default))
1613 (boolean)))))
1616 (defcustom org-insert-heading-respect-content nil
1617 "Non-nil means insert new headings after the current subtree.
1618 When nil, the new heading is created directly after the current line.
1619 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1620 this variable on for the duration of the command."
1621 :group 'org-structure
1622 :type 'boolean)
1624 (defcustom org-blank-before-new-entry '((heading . auto)
1625 (plain-list-item . auto))
1626 "Should `org-insert-heading' leave a blank line before new heading/item?
1627 The value is an alist, with `heading' and `plain-list-item' as CAR,
1628 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1629 which case Org will look at the surrounding headings/items and try to
1630 make an intelligent decision whether to insert a blank line or not.
1632 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1633 the setting here is ignored and no empty line is inserted to avoid breaking
1634 the list structure."
1635 :group 'org-edit-structure
1636 :type '(list
1637 (cons (const heading)
1638 (choice (const :tag "Never" nil)
1639 (const :tag "Always" t)
1640 (const :tag "Auto" auto)))
1641 (cons (const plain-list-item)
1642 (choice (const :tag "Never" nil)
1643 (const :tag "Always" t)
1644 (const :tag "Auto" auto)))))
1646 (defcustom org-insert-heading-hook nil
1647 "Hook being run after inserting a new heading."
1648 :group 'org-edit-structure
1649 :type 'hook)
1651 (defcustom org-enable-fixed-width-editor t
1652 "Non-nil means lines starting with \":\" are treated as fixed-width.
1653 This currently only means they are never auto-wrapped.
1654 When nil, such lines will be treated like ordinary lines."
1655 :group 'org-edit-structure
1656 :type 'boolean)
1658 (defcustom org-goto-auto-isearch t
1659 "Non-nil means typing characters in `org-goto' starts incremental search.
1660 When nil, you can use these keybindings to navigate the buffer:
1662 q Quit the org-goto interface
1663 n Go to the next visible heading
1664 p Go to the previous visible heading
1665 f Go one heading forward on same level
1666 b Go one heading backward on same level
1667 u Go one heading up"
1668 :group 'org-edit-structure
1669 :type 'boolean)
1671 (defgroup org-sparse-trees nil
1672 "Options concerning sparse trees in Org-mode."
1673 :tag "Org Sparse Trees"
1674 :group 'org-structure)
1676 (defcustom org-highlight-sparse-tree-matches t
1677 "Non-nil means highlight all matches that define a sparse tree.
1678 The highlights will automatically disappear the next time the buffer is
1679 changed by an edit command."
1680 :group 'org-sparse-trees
1681 :type 'boolean)
1683 (defcustom org-remove-highlights-with-change t
1684 "Non-nil means any change to the buffer will remove temporary highlights.
1685 Such highlights are created by `org-occur' and `org-clock-display'.
1686 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1687 The highlights created by `org-toggle-latex-fragment' always need
1688 `C-c C-x C-l' to be removed."
1689 :group 'org-sparse-trees
1690 :group 'org-time
1691 :type 'boolean)
1694 (defcustom org-occur-hook '(org-first-headline-recenter)
1695 "Hook that is run after `org-occur' has constructed a sparse tree.
1696 This can be used to recenter the window to show as much of the structure
1697 as possible."
1698 :group 'org-sparse-trees
1699 :type 'hook)
1701 (defgroup org-imenu-and-speedbar nil
1702 "Options concerning imenu and speedbar in Org-mode."
1703 :tag "Org Imenu and Speedbar"
1704 :group 'org-structure)
1706 (defcustom org-imenu-depth 2
1707 "The maximum level for Imenu access to Org-mode headlines.
1708 This also applied for speedbar access."
1709 :group 'org-imenu-and-speedbar
1710 :type 'integer)
1712 (defgroup org-table nil
1713 "Options concerning tables in Org-mode."
1714 :tag "Org Table"
1715 :group 'org)
1717 (defcustom org-enable-table-editor 'optimized
1718 "Non-nil means lines starting with \"|\" are handled by the table editor.
1719 When nil, such lines will be treated like ordinary lines.
1721 When equal to the symbol `optimized', the table editor will be optimized to
1722 do the following:
1723 - Automatic overwrite mode in front of whitespace in table fields.
1724 This makes the structure of the table stay in tact as long as the edited
1725 field does not exceed the column width.
1726 - Minimize the number of realigns. Normally, the table is aligned each time
1727 TAB or RET are pressed to move to another field. With optimization this
1728 happens only if changes to a field might have changed the column width.
1729 Optimization requires replacing the functions `self-insert-command',
1730 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1731 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1732 very good at guessing when a re-align will be necessary, but you can always
1733 force one with \\[org-ctrl-c-ctrl-c].
1735 If you would like to use the optimized version in Org-mode, but the
1736 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1738 This variable can be used to turn on and off the table editor during a session,
1739 but in order to toggle optimization, a restart is required.
1741 See also the variable `org-table-auto-blank-field'."
1742 :group 'org-table
1743 :type '(choice
1744 (const :tag "off" nil)
1745 (const :tag "on" t)
1746 (const :tag "on, optimized" optimized)))
1748 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1749 (version<= emacs-version "24.1"))
1750 "Non-nil means cluster self-insert commands for undo when possible.
1751 If this is set, then, like in the Emacs command loop, 20 consecutive
1752 characters will be undone together.
1753 This is configurable, because there is some impact on typing performance."
1754 :group 'org-table
1755 :type 'boolean)
1757 (defcustom org-table-tab-recognizes-table.el t
1758 "Non-nil means TAB will automatically notice a table.el table.
1759 When it sees such a table, it moves point into it and - if necessary -
1760 calls `table-recognize-table'."
1761 :group 'org-table-editing
1762 :type 'boolean)
1764 (defgroup org-link nil
1765 "Options concerning links in Org-mode."
1766 :tag "Org Link"
1767 :group 'org)
1769 (defvar org-link-abbrev-alist-local nil
1770 "Buffer-local version of `org-link-abbrev-alist', which see.
1771 The value of this is taken from the #+LINK lines.")
1772 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1774 (defcustom org-link-abbrev-alist nil
1775 "Alist of link abbreviations.
1776 The car of each element is a string, to be replaced at the start of a link.
1777 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1778 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1780 [[linkkey:tag][description]]
1782 The 'linkkey' must be a word word, starting with a letter, followed
1783 by letters, numbers, '-' or '_'.
1785 If REPLACE is a string, the tag will simply be appended to create the link.
1786 If the string contains \"%s\", the tag will be inserted there. If the string
1787 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1788 at that point (see the function `url-hexify-string'). If the string contains
1789 the specifier \"%(my-function)\", then the custom function `my-function' will
1790 be invoked: this function takes the tag as its only argument and must return
1791 a string.
1793 REPLACE may also be a function that will be called with the tag as the
1794 only argument to create the link, which should be returned as a string.
1796 See the manual for examples."
1797 :group 'org-link
1798 :type '(repeat
1799 (cons
1800 (string :tag "Protocol")
1801 (choice
1802 (string :tag "Format")
1803 (function)))))
1805 (defcustom org-descriptive-links t
1806 "Non-nil means Org will display descriptive links.
1807 E.g. [[http://orgmode.org][Org website]] will be displayed as
1808 \"Org Website\", hiding the link itself and just displaying its
1809 description. When set to `nil', Org will display the full links
1810 literally.
1812 You can interactively set the value of this variable by calling
1813 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1814 :group 'org-link
1815 :type 'boolean)
1817 (defcustom org-link-file-path-type 'adaptive
1818 "How the path name in file links should be stored.
1819 Valid values are:
1821 relative Relative to the current directory, i.e. the directory of the file
1822 into which the link is being inserted.
1823 absolute Absolute path, if possible with ~ for home directory.
1824 noabbrev Absolute path, no abbreviation of home directory.
1825 adaptive Use relative path for files in the current directory and sub-
1826 directories of it. For other files, use an absolute path."
1827 :group 'org-link
1828 :type '(choice
1829 (const relative)
1830 (const absolute)
1831 (const noabbrev)
1832 (const adaptive)))
1834 (defvaralias 'org-activate-links 'org-highlight-links)
1835 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1836 "Types of links that should be highlighted in Org-mode files.
1838 This is a list of symbols, each one of them leading to the
1839 highlighting of a certain link type.
1841 You can still open links that are not highlighted.
1843 In principle, it does not hurt to turn on highlighting for all
1844 link types. There may be a small gain when turning off unused
1845 link types. The types are:
1847 bracket The recommended [[link][description]] or [[link]] links with hiding.
1848 angle Links in angular brackets that may contain whitespace like
1849 <bbdb:Carsten Dominik>.
1850 plain Plain links in normal text, no whitespace, like http://google.com.
1851 radio Text that is matched by a radio target, see manual for details.
1852 tag Tag settings in a headline (link to tag search).
1853 date Time stamps (link to calendar).
1854 footnote Footnote labels.
1856 If you set this variable during an Emacs session, use `org-mode-restart'
1857 in the Org buffer so that the change takes effect."
1858 :group 'org-link
1859 :group 'org-appearance
1860 :type '(set :greedy t
1861 (const :tag "Double bracket links" bracket)
1862 (const :tag "Angular bracket links" angle)
1863 (const :tag "Plain text links" plain)
1864 (const :tag "Radio target matches" radio)
1865 (const :tag "Tags" tag)
1866 (const :tag "Timestamps" date)
1867 (const :tag "Footnotes" footnote)))
1869 (defcustom org-make-link-description-function nil
1870 "Function to use for generating link descriptions from links.
1871 When nil, the link location will be used. This function must take
1872 two parameters: the first one is the link, the second one is the
1873 description generated by `org-insert-link'. The function should
1874 return the description to use."
1875 :group 'org-link
1876 :type '(choice (const nil) (function)))
1878 (defgroup org-link-store nil
1879 "Options concerning storing links in Org-mode."
1880 :tag "Org Store Link"
1881 :group 'org-link)
1883 (defcustom org-url-hexify-p t
1884 "When non-nil, hexify URL when creating a link."
1885 :type 'boolean
1886 :version "24.3"
1887 :group 'org-link-store)
1889 (defcustom org-email-link-description-format "Email %c: %.30s"
1890 "Format of the description part of a link to an email or usenet message.
1891 The following %-escapes will be replaced by corresponding information:
1893 %F full \"From\" field
1894 %f name, taken from \"From\" field, address if no name
1895 %T full \"To\" field
1896 %t first name in \"To\" field, address if no name
1897 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1898 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1899 %s subject
1900 %d date
1901 %m message-id.
1903 You may use normal field width specification between the % and the letter.
1904 This is for example useful to limit the length of the subject.
1906 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1907 :group 'org-link-store
1908 :type 'string)
1910 (defcustom org-from-is-user-regexp
1911 (let (r1 r2)
1912 (when (and user-mail-address (not (string= user-mail-address "")))
1913 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1914 (when (and user-full-name (not (string= user-full-name "")))
1915 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1916 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1917 "Regexp matched against the \"From:\" header of an email or usenet message.
1918 It should match if the message is from the user him/herself."
1919 :group 'org-link-store
1920 :type 'regexp)
1922 (defcustom org-context-in-file-links t
1923 "Non-nil means file links from `org-store-link' contain context.
1924 A search string will be added to the file name with :: as separator and
1925 used to find the context when the link is activated by the command
1926 `org-open-at-point'. When this option is t, the entire active region
1927 will be placed in the search string of the file link. If set to a
1928 positive integer, only the first n lines of context will be stored.
1930 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1931 negates this setting for the duration of the command."
1932 :group 'org-link-store
1933 :type '(choice boolean integer))
1935 (defcustom org-keep-stored-link-after-insertion nil
1936 "Non-nil means keep link in list for entire session.
1938 The command `org-store-link' adds a link pointing to the current
1939 location to an internal list. These links accumulate during a session.
1940 The command `org-insert-link' can be used to insert links into any
1941 Org-mode file (offering completion for all stored links). When this
1942 option is nil, every link which has been inserted once using \\[org-insert-link]
1943 will be removed from the list, to make completing the unused links
1944 more efficient."
1945 :group 'org-link-store
1946 :type 'boolean)
1948 (defgroup org-link-follow nil
1949 "Options concerning following links in Org-mode."
1950 :tag "Org Follow Link"
1951 :group 'org-link)
1953 (defcustom org-link-translation-function nil
1954 "Function to translate links with different syntax to Org syntax.
1955 This can be used to translate links created for example by the Planner
1956 or emacs-wiki packages to Org syntax.
1957 The function must accept two parameters, a TYPE containing the link
1958 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1959 which is everything after the link protocol. It should return a cons
1960 with possibly modified values of type and path.
1961 Org contains a function for this, so if you set this variable to
1962 `org-translate-link-from-planner', you should be able follow many
1963 links created by planner."
1964 :group 'org-link-follow
1965 :type '(choice (const nil) (function)))
1967 (defcustom org-follow-link-hook nil
1968 "Hook that is run after a link has been followed."
1969 :group 'org-link-follow
1970 :type 'hook)
1972 (defcustom org-tab-follows-link nil
1973 "Non-nil means on links TAB will follow the link.
1974 Needs to be set before org.el is loaded.
1975 This really should not be used, it does not make sense, and the
1976 implementation is bad."
1977 :group 'org-link-follow
1978 :type 'boolean)
1980 (defcustom org-return-follows-link nil
1981 "Non-nil means on links RET will follow the link.
1982 In tables, the special behavior of RET has precedence."
1983 :group 'org-link-follow
1984 :type 'boolean)
1986 (defcustom org-mouse-1-follows-link
1987 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1988 "Non-nil means mouse-1 on a link will follow the link.
1989 A longer mouse click will still set point. Does not work on XEmacs.
1990 Needs to be set before org.el is loaded."
1991 :group 'org-link-follow
1992 :version "24.4"
1993 :package-version '(Org . "8.3")
1994 :type '(choice
1995 (const :tag "A double click follows the link" double)
1996 (const :tag "Unconditionally follow the link with mouse-1" t)
1997 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1999 (defcustom org-mark-ring-length 4
2000 "Number of different positions to be recorded in the ring.
2001 Changing this requires a restart of Emacs to work correctly."
2002 :group 'org-link-follow
2003 :type 'integer)
2005 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2006 "Non-nil means internal links in Org files must exactly match a headline.
2007 When nil, the link search tries to match a phrase with all words
2008 in the search text."
2009 :group 'org-link-follow
2010 :version "24.1"
2011 :type '(choice
2012 (const :tag "Use fuzzy text search" nil)
2013 (const :tag "Match only exact headline" t)
2014 (const :tag "Match exact headline or query to create it"
2015 query-to-create)))
2017 (defcustom org-link-frame-setup
2018 '((vm . vm-visit-folder-other-frame)
2019 (vm-imap . vm-visit-imap-folder-other-frame)
2020 (gnus . org-gnus-no-new-news)
2021 (file . find-file-other-window)
2022 (wl . wl-other-frame))
2023 "Setup the frame configuration for following links.
2024 When following a link with Emacs, it may often be useful to display
2025 this link in another window or frame. This variable can be used to
2026 set this up for the different types of links.
2027 For VM, use any of
2028 `vm-visit-folder'
2029 `vm-visit-folder-other-window'
2030 `vm-visit-folder-other-frame'
2031 For Gnus, use any of
2032 `gnus'
2033 `gnus-other-frame'
2034 `org-gnus-no-new-news'
2035 For FILE, use any of
2036 `find-file'
2037 `find-file-other-window'
2038 `find-file-other-frame'
2039 For Wanderlust use any of
2040 `wl'
2041 `wl-other-frame'
2042 For the calendar, use the variable `calendar-setup'.
2043 For BBDB, it is currently only possible to display the matches in
2044 another window."
2045 :group 'org-link-follow
2046 :type '(list
2047 (cons (const vm)
2048 (choice
2049 (const vm-visit-folder)
2050 (const vm-visit-folder-other-window)
2051 (const vm-visit-folder-other-frame)))
2052 (cons (const vm-imap)
2053 (choice
2054 (const vm-visit-imap-folder)
2055 (const vm-visit-imap-folder-other-window)
2056 (const vm-visit-imap-folder-other-frame)))
2057 (cons (const gnus)
2058 (choice
2059 (const gnus)
2060 (const gnus-other-frame)
2061 (const org-gnus-no-new-news)))
2062 (cons (const file)
2063 (choice
2064 (const find-file)
2065 (const find-file-other-window)
2066 (const find-file-other-frame)))
2067 (cons (const wl)
2068 (choice
2069 (const wl)
2070 (const wl-other-frame)))))
2072 (defcustom org-display-internal-link-with-indirect-buffer nil
2073 "Non-nil means use indirect buffer to display infile links.
2074 Activating internal links (from one location in a file to another location
2075 in the same file) normally just jumps to the location. When the link is
2076 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2077 is displayed in
2078 another window. When this option is set, the other window actually displays
2079 an indirect buffer clone of the current buffer, to avoid any visibility
2080 changes to the current buffer."
2081 :group 'org-link-follow
2082 :type 'boolean)
2084 (defcustom org-open-non-existing-files nil
2085 "Non-nil means `org-open-file' will open non-existing files.
2086 When nil, an error will be generated.
2087 This variable applies only to external applications because they
2088 might choke on non-existing files. If the link is to a file that
2089 will be opened in Emacs, the variable is ignored."
2090 :group 'org-link-follow
2091 :type 'boolean)
2093 (defcustom org-open-directory-means-index-dot-org nil
2094 "Non-nil means a link to a directory really means to index.org.
2095 When nil, following a directory link will run dired or open a finder/explorer
2096 window on that directory."
2097 :group 'org-link-follow
2098 :type 'boolean)
2100 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2101 "Non-nil means ask for confirmation before executing shell links.
2102 Shell links can be dangerous: just think about a link
2104 [[shell:rm -rf ~/*][Google Search]]
2106 This link would show up in your Org-mode document as \"Google Search\",
2107 but really it would remove your entire home directory.
2108 Therefore we advise against setting this variable to nil.
2109 Just change it to `y-or-n-p' if you want to confirm with a
2110 single keystroke rather than having to type \"yes\"."
2111 :group 'org-link-follow
2112 :type '(choice
2113 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2114 (const :tag "with y-or-n (faster)" y-or-n-p)
2115 (const :tag "no confirmation (dangerous)" nil)))
2116 (put 'org-confirm-shell-link-function
2117 'safe-local-variable
2118 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2120 (defcustom org-confirm-shell-link-not-regexp ""
2121 "A regexp to skip confirmation for shell links."
2122 :group 'org-link-follow
2123 :version "24.1"
2124 :type 'regexp)
2126 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2127 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2128 Elisp links can be dangerous: just think about a link
2130 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2132 This link would show up in your Org-mode document as \"Google Search\",
2133 but really it would remove your entire home directory.
2134 Therefore we advise against setting this variable to nil.
2135 Just change it to `y-or-n-p' if you want to confirm with a
2136 single keystroke rather than having to type \"yes\"."
2137 :group 'org-link-follow
2138 :type '(choice
2139 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2140 (const :tag "with y-or-n (faster)" y-or-n-p)
2141 (const :tag "no confirmation (dangerous)" nil)))
2142 (put 'org-confirm-shell-link-function
2143 'safe-local-variable
2144 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2146 (defcustom org-confirm-elisp-link-not-regexp ""
2147 "A regexp to skip confirmation for Elisp links."
2148 :group 'org-link-follow
2149 :version "24.1"
2150 :type 'regexp)
2152 (defconst org-file-apps-defaults-gnu
2153 '((remote . emacs)
2154 (system . mailcap)
2155 (t . mailcap))
2156 "Default file applications on a UNIX or GNU/Linux system.
2157 See `org-file-apps'.")
2159 (defconst org-file-apps-defaults-macosx
2160 '((remote . emacs)
2161 (t . "open %s")
2162 (system . "open %s")
2163 ("ps.gz" . "gv %s")
2164 ("eps.gz" . "gv %s")
2165 ("dvi" . "xdvi %s")
2166 ("fig" . "xfig %s"))
2167 "Default file applications on a MacOS X system.
2168 The system \"open\" is known as a default, but we use X11 applications
2169 for some files for which the OS does not have a good default.
2170 See `org-file-apps'.")
2172 (defconst org-file-apps-defaults-windowsnt
2173 (list
2174 '(remote . emacs)
2175 (cons t
2176 (list (if (featurep 'xemacs)
2177 'mswindows-shell-execute
2178 'w32-shell-execute)
2179 "open" 'file))
2180 (cons 'system
2181 (list (if (featurep 'xemacs)
2182 'mswindows-shell-execute
2183 'w32-shell-execute)
2184 "open" 'file)))
2185 "Default file applications on a Windows NT system.
2186 The system \"open\" is used for most files.
2187 See `org-file-apps'.")
2189 (defcustom org-file-apps
2190 '((auto-mode . emacs)
2191 ("\\.mm\\'" . default)
2192 ("\\.x?html?\\'" . default)
2193 ("\\.pdf\\'" . default))
2194 "External applications for opening `file:path' items in a document.
2195 Org-mode uses system defaults for different file types, but
2196 you can use this variable to set the application for a given file
2197 extension. The entries in this list are cons cells where the car identifies
2198 files and the cdr the corresponding command. Possible values for the
2199 file identifier are
2200 \"string\" A string as a file identifier can be interpreted in different
2201 ways, depending on its contents:
2203 - Alphanumeric characters only:
2204 Match links with this file extension.
2205 Example: (\"pdf\" . \"evince %s\")
2206 to open PDFs with evince.
2208 - Regular expression: Match links where the
2209 filename matches the regexp. If you want to
2210 use groups here, use shy groups.
2212 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2213 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2214 to open *.html and *.xhtml with firefox.
2216 - Regular expression which contains (non-shy) groups:
2217 Match links where the whole link, including \"::\", and
2218 anything after that, matches the regexp.
2219 In a custom command string, %1, %2, etc. are replaced with
2220 the parts of the link that were matched by the groups.
2221 For backwards compatibility, if a command string is given
2222 that does not use any of the group matches, this case is
2223 handled identically to the second one (i.e. match against
2224 file name only).
2225 In a custom lisp form, you can access the group matches with
2226 (match-string n link).
2228 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2229 to open [[file:document.pdf::5]] with evince at page 5.
2231 `directory' Matches a directory
2232 `remote' Matches a remote file, accessible through tramp or efs.
2233 Remote files most likely should be visited through Emacs
2234 because external applications cannot handle such paths.
2235 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2236 so all files Emacs knows how to handle. Using this with
2237 command `emacs' will open most files in Emacs. Beware that this
2238 will also open html files inside Emacs, unless you add
2239 (\"html\" . default) to the list as well.
2240 t Default for files not matched by any of the other options.
2241 `system' The system command to open files, like `open' on Windows
2242 and Mac OS X, and mailcap under GNU/Linux. This is the command
2243 that will be selected if you call `C-c C-o' with a double
2244 \\[universal-argument] \\[universal-argument] prefix.
2246 Possible values for the command are:
2247 `emacs' The file will be visited by the current Emacs process.
2248 `default' Use the default application for this file type, which is the
2249 association for t in the list, most likely in the system-specific
2250 part.
2251 This can be used to overrule an unwanted setting in the
2252 system-specific variable.
2253 `system' Use the system command for opening files, like \"open\".
2254 This command is specified by the entry whose car is `system'.
2255 Most likely, the system-specific version of this variable
2256 does define this command, but you can overrule/replace it
2257 here.
2258 string A command to be executed by a shell; %s will be replaced
2259 by the path to the file.
2260 sexp A Lisp form which will be evaluated. The file path will
2261 be available in the Lisp variable `file'.
2262 For more examples, see the system specific constants
2263 `org-file-apps-defaults-macosx'
2264 `org-file-apps-defaults-windowsnt'
2265 `org-file-apps-defaults-gnu'."
2266 :group 'org-link-follow
2267 :type '(repeat
2268 (cons (choice :value ""
2269 (string :tag "Extension")
2270 (const :tag "System command to open files" system)
2271 (const :tag "Default for unrecognized files" t)
2272 (const :tag "Remote file" remote)
2273 (const :tag "Links to a directory" directory)
2274 (const :tag "Any files that have Emacs modes"
2275 auto-mode))
2276 (choice :value ""
2277 (const :tag "Visit with Emacs" emacs)
2278 (const :tag "Use default" default)
2279 (const :tag "Use the system command" system)
2280 (string :tag "Command")
2281 (sexp :tag "Lisp form")))))
2283 (defcustom org-doi-server-url "http://dx.doi.org/"
2284 "The URL of the DOI server."
2285 :type 'string
2286 :version "24.3"
2287 :group 'org-link-follow)
2289 (defgroup org-refile nil
2290 "Options concerning refiling entries in Org-mode."
2291 :tag "Org Refile"
2292 :group 'org)
2294 (defcustom org-directory "~/org"
2295 "Directory with org files.
2296 This is just a default location to look for Org files. There is no need
2297 at all to put your files into this directory. It is only used in the
2298 following situations:
2300 1. When a capture template specifies a target file that is not an
2301 absolute path. The path will then be interpreted relative to
2302 `org-directory'
2303 2. When a capture note is filed away in an interactive way (when exiting the
2304 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2305 with `org-directory' as the default path."
2306 :group 'org-refile
2307 :group 'org-capture
2308 :type 'directory)
2310 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2311 "Default target for storing notes.
2312 Used as a fall back file for org-capture.el, for templates that
2313 do not specify a target file."
2314 :group 'org-refile
2315 :group 'org-capture
2316 :type '(choice
2317 (const :tag "Default from remember-data-file" nil)
2318 file))
2320 (defcustom org-goto-interface 'outline
2321 "The default interface to be used for `org-goto'.
2322 Allowed values are:
2323 outline The interface shows an outline of the relevant file
2324 and the correct heading is found by moving through
2325 the outline or by searching with incremental search.
2326 outline-path-completion Headlines in the current buffer are offered via
2327 completion. This is the interface also used by
2328 the refile command."
2329 :group 'org-refile
2330 :type '(choice
2331 (const :tag "Outline" outline)
2332 (const :tag "Outline-path-completion" outline-path-completion)))
2334 (defcustom org-goto-max-level 5
2335 "Maximum target level when running `org-goto' with refile interface."
2336 :group 'org-refile
2337 :type 'integer)
2339 (defcustom org-reverse-note-order nil
2340 "Non-nil means store new notes at the beginning of a file or entry.
2341 When nil, new notes will be filed to the end of a file or entry.
2342 This can also be a list with cons cells of regular expressions that
2343 are matched against file names, and values."
2344 :group 'org-capture
2345 :group 'org-refile
2346 :type '(choice
2347 (const :tag "Reverse always" t)
2348 (const :tag "Reverse never" nil)
2349 (repeat :tag "By file name regexp"
2350 (cons regexp boolean))))
2352 (defcustom org-log-refile nil
2353 "Information to record when a task is refiled.
2355 Possible values are:
2357 nil Don't add anything
2358 time Add a time stamp to the task
2359 note Prompt for a note and add it with template `org-log-note-headings'
2361 This option can also be set with on a per-file-basis with
2363 #+STARTUP: nologrefile
2364 #+STARTUP: logrefile
2365 #+STARTUP: lognoterefile
2367 You can have local logging settings for a subtree by setting the LOGGING
2368 property to one or more of these keywords.
2370 When bulk-refiling from the agenda, the value `note' is forbidden and
2371 will temporarily be changed to `time'."
2372 :group 'org-refile
2373 :group 'org-progress
2374 :version "24.1"
2375 :type '(choice
2376 (const :tag "No logging" nil)
2377 (const :tag "Record timestamp" time)
2378 (const :tag "Record timestamp with note." note)))
2380 (defcustom org-refile-targets nil
2381 "Targets for refiling entries with \\[org-refile].
2382 This is a list of cons cells. Each cell contains:
2383 - a specification of the files to be considered, either a list of files,
2384 or a symbol whose function or variable value will be used to retrieve
2385 a file name or a list of file names. If you use `org-agenda-files' for
2386 that, all agenda files will be scanned for targets. Nil means consider
2387 headings in the current buffer.
2388 - A specification of how to find candidate refile targets. This may be
2389 any of:
2390 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2391 This tag has to be present in all target headlines, inheritance will
2392 not be considered.
2393 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2394 todo keyword.
2395 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2396 headlines that are refiling targets.
2397 - a cons cell (:level . N). Any headline of level N is considered a target.
2398 Note that, when `org-odd-levels-only' is set, level corresponds to
2399 order in hierarchy, not to the number of stars.
2400 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2401 Note that, when `org-odd-levels-only' is set, level corresponds to
2402 order in hierarchy, not to the number of stars.
2404 Each element of this list generates a set of possible targets.
2405 The union of these sets is presented (with completion) to
2406 the user by `org-refile'.
2408 You can set the variable `org-refile-target-verify-function' to a function
2409 to verify each headline found by the simple criteria above.
2411 When this variable is nil, all top-level headlines in the current buffer
2412 are used, equivalent to the value `((nil . (:level . 1))'."
2413 :group 'org-refile
2414 :type '(repeat
2415 (cons
2416 (choice :value org-agenda-files
2417 (const :tag "All agenda files" org-agenda-files)
2418 (const :tag "Current buffer" nil)
2419 (function) (variable) (file))
2420 (choice :tag "Identify target headline by"
2421 (cons :tag "Specific tag" (const :value :tag) (string))
2422 (cons :tag "TODO keyword" (const :value :todo) (string))
2423 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2424 (cons :tag "Level number" (const :value :level) (integer))
2425 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2427 (defcustom org-refile-target-verify-function nil
2428 "Function to verify if the headline at point should be a refile target.
2429 The function will be called without arguments, with point at the
2430 beginning of the headline. It should return t and leave point
2431 where it is if the headline is a valid target for refiling.
2433 If the target should not be selected, the function must return nil.
2434 In addition to this, it may move point to a place from where the search
2435 should be continued. For example, the function may decide that the entire
2436 subtree of the current entry should be excluded and move point to the end
2437 of the subtree."
2438 :group 'org-refile
2439 :type '(choice
2440 (const nil)
2441 (function)))
2443 (defcustom org-refile-use-cache nil
2444 "Non-nil means cache refile targets to speed up the process.
2445 The cache for a particular file will be updated automatically when
2446 the buffer has been killed, or when any of the marker used for flagging
2447 refile targets no longer points at a live buffer.
2448 If you have added new entries to a buffer that might themselves be targets,
2449 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2450 find that easier, `C-u C-u C-u C-c C-w'."
2451 :group 'org-refile
2452 :version "24.1"
2453 :type 'boolean)
2455 (defcustom org-refile-use-outline-path nil
2456 "Non-nil means provide refile targets as paths.
2457 So a level 3 headline will be available as level1/level2/level3.
2459 When the value is `file', also include the file name (without directory)
2460 into the path. In this case, you can also stop the completion after
2461 the file name, to get entries inserted as top level in the file.
2463 When `full-file-path', include the full file path."
2464 :group 'org-refile
2465 :type '(choice
2466 (const :tag "Not" nil)
2467 (const :tag "Yes" t)
2468 (const :tag "Start with file name" file)
2469 (const :tag "Start with full file path" full-file-path)))
2471 (defcustom org-outline-path-complete-in-steps t
2472 "Non-nil means complete the outline path in hierarchical steps.
2473 When Org-mode uses the refile interface to select an outline path
2474 \(see variable `org-refile-use-outline-path'), the completion of
2475 the path can be done is a single go, or if can be done in steps down
2476 the headline hierarchy. Going in steps is probably the best if you
2477 do not use a special completion package like `ido' or `icicles'.
2478 However, when using these packages, going in one step can be very
2479 fast, while still showing the whole path to the entry."
2480 :group 'org-refile
2481 :type 'boolean)
2483 (defcustom org-refile-allow-creating-parent-nodes nil
2484 "Non-nil means allow to create new nodes as refile targets.
2485 New nodes are then created by adding \"/new node name\" to the completion
2486 of an existing node. When the value of this variable is `confirm',
2487 new node creation must be confirmed by the user (recommended).
2488 When nil, the completion must match an existing entry.
2490 Note that, if the new heading is not seen by the criteria
2491 listed in `org-refile-targets', multiple instances of the same
2492 heading would be created by trying again to file under the new
2493 heading."
2494 :group 'org-refile
2495 :type '(choice
2496 (const :tag "Never" nil)
2497 (const :tag "Always" t)
2498 (const :tag "Prompt for confirmation" confirm)))
2500 (defcustom org-refile-active-region-within-subtree nil
2501 "Non-nil means also refile active region within a subtree.
2503 By default `org-refile' doesn't allow refiling regions if they
2504 don't contain a set of subtrees, but it might be convenient to
2505 do so sometimes: in that case, the first line of the region is
2506 converted to a headline before refiling."
2507 :group 'org-refile
2508 :version "24.1"
2509 :type 'boolean)
2511 (defgroup org-todo nil
2512 "Options concerning TODO items in Org-mode."
2513 :tag "Org TODO"
2514 :group 'org)
2516 (defgroup org-progress nil
2517 "Options concerning Progress logging in Org-mode."
2518 :tag "Org Progress"
2519 :group 'org-time)
2521 (defvar org-todo-interpretation-widgets
2522 '((:tag "Sequence (cycling hits every state)" sequence)
2523 (:tag "Type (cycling directly to DONE)" type))
2524 "The available interpretation symbols for customizing `org-todo-keywords'.
2525 Interested libraries should add to this list.")
2527 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2528 "List of TODO entry keyword sequences and their interpretation.
2529 \\<org-mode-map>This is a list of sequences.
2531 Each sequence starts with a symbol, either `sequence' or `type',
2532 indicating if the keywords should be interpreted as a sequence of
2533 action steps, or as different types of TODO items. The first
2534 keywords are states requiring action - these states will select a headline
2535 for inclusion into the global TODO list Org-mode produces. If one of
2536 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2537 signify that no further action is necessary. If \"|\" is not found,
2538 the last keyword is treated as the only DONE state of the sequence.
2540 The command \\[org-todo] cycles an entry through these states, and one
2541 additional state where no keyword is present. For details about this
2542 cycling, see the manual.
2544 TODO keywords and interpretation can also be set on a per-file basis with
2545 the special #+SEQ_TODO and #+TYP_TODO lines.
2547 Each keyword can optionally specify a character for fast state selection
2548 \(in combination with the variable `org-use-fast-todo-selection')
2549 and specifiers for state change logging, using the same syntax that
2550 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2551 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2552 indicates to record a time stamp each time this state is selected.
2554 Each keyword may also specify if a timestamp or a note should be
2555 recorded when entering or leaving the state, by adding additional
2556 characters in the parenthesis after the keyword. This looks like this:
2557 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2558 record only the time of the state change. With X and Y being either
2559 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2560 Y when leaving the state if and only if the *target* state does not
2561 define X. You may omit any of the fast-selection key or X or /Y,
2562 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2564 For backward compatibility, this variable may also be just a list
2565 of keywords. In this case the interpretation (sequence or type) will be
2566 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2567 :group 'org-todo
2568 :group 'org-keywords
2569 :type '(choice
2570 (repeat :tag "Old syntax, just keywords"
2571 (string :tag "Keyword"))
2572 (repeat :tag "New syntax"
2573 (cons
2574 (choice
2575 :tag "Interpretation"
2576 ;;Quick and dirty way to see
2577 ;;`org-todo-interpretations'. This takes the
2578 ;;place of item arguments
2579 :convert-widget
2580 (lambda (widget)
2581 (widget-put widget
2582 :args (mapcar
2583 (lambda (x)
2584 (widget-convert
2585 (cons 'const x)))
2586 org-todo-interpretation-widgets))
2587 widget))
2588 (repeat
2589 (string :tag "Keyword"))))))
2591 (defvar org-todo-keywords-1 nil
2592 "All TODO and DONE keywords active in a buffer.")
2593 (make-variable-buffer-local 'org-todo-keywords-1)
2594 (defvar org-todo-keywords-for-agenda nil)
2595 (defvar org-done-keywords-for-agenda nil)
2596 (defvar org-todo-keyword-alist-for-agenda nil)
2597 (defvar org-tag-alist-for-agenda nil
2598 "Alist of all tags from all agenda files.")
2599 (defvar org-tag-groups-alist-for-agenda nil
2600 "Alist of all groups tags from all current agenda files.")
2601 (defvar org-tag-groups-alist nil)
2602 (make-variable-buffer-local 'org-tag-groups-alist)
2603 (defvar org-agenda-contributing-files nil)
2604 (defvar org-not-done-keywords nil)
2605 (make-variable-buffer-local 'org-not-done-keywords)
2606 (defvar org-done-keywords nil)
2607 (make-variable-buffer-local 'org-done-keywords)
2608 (defvar org-todo-heads nil)
2609 (make-variable-buffer-local 'org-todo-heads)
2610 (defvar org-todo-sets nil)
2611 (make-variable-buffer-local 'org-todo-sets)
2612 (defvar org-todo-log-states nil)
2613 (make-variable-buffer-local 'org-todo-log-states)
2614 (defvar org-todo-kwd-alist nil)
2615 (make-variable-buffer-local 'org-todo-kwd-alist)
2616 (defvar org-todo-key-alist nil)
2617 (make-variable-buffer-local 'org-todo-key-alist)
2618 (defvar org-todo-key-trigger nil)
2619 (make-variable-buffer-local 'org-todo-key-trigger)
2621 (defcustom org-todo-interpretation 'sequence
2622 "Controls how TODO keywords are interpreted.
2623 This variable is in principle obsolete and is only used for
2624 backward compatibility, if the interpretation of todo keywords is
2625 not given already in `org-todo-keywords'. See that variable for
2626 more information."
2627 :group 'org-todo
2628 :group 'org-keywords
2629 :type '(choice (const sequence)
2630 (const type)))
2632 (defcustom org-use-fast-todo-selection t
2633 "Non-nil means use the fast todo selection scheme with C-c C-t.
2634 This variable describes if and under what circumstances the cycling
2635 mechanism for TODO keywords will be replaced by a single-key, direct
2636 selection scheme.
2638 When nil, fast selection is never used.
2640 When the symbol `prefix', it will be used when `org-todo' is called
2641 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2642 `C-u t' in an agenda buffer.
2644 When t, fast selection is used by default. In this case, the prefix
2645 argument forces cycling instead.
2647 In all cases, the special interface is only used if access keys have
2648 actually been assigned by the user, i.e. if keywords in the configuration
2649 are followed by a letter in parenthesis, like TODO(t)."
2650 :group 'org-todo
2651 :type '(choice
2652 (const :tag "Never" nil)
2653 (const :tag "By default" t)
2654 (const :tag "Only with C-u C-c C-t" prefix)))
2656 (defcustom org-provide-todo-statistics t
2657 "Non-nil means update todo statistics after insert and toggle.
2658 ALL-HEADLINES means update todo statistics by including headlines
2659 with no TODO keyword as well, counting them as not done.
2660 A list of TODO keywords means the same, but skip keywords that are
2661 not in this list.
2662 When set to a list of two lists, the first list contains keywords
2663 to consider as TODO keywords, the second list contains keywords
2664 to consider as DONE keywords.
2666 When this is set, todo statistics is updated in the parent of the
2667 current entry each time a todo state is changed."
2668 :group 'org-todo
2669 :type '(choice
2670 (const :tag "Yes, only for TODO entries" t)
2671 (const :tag "Yes, including all entries" all-headlines)
2672 (repeat :tag "Yes, for TODOs in this list"
2673 (string :tag "TODO keyword"))
2674 (list :tag "Yes, for TODOs and DONEs in these lists"
2675 (repeat (string :tag "TODO keyword"))
2676 (repeat (string :tag "DONE keyword")))
2677 (other :tag "No TODO statistics" nil)))
2679 (defcustom org-hierarchical-todo-statistics t
2680 "Non-nil means TODO statistics covers just direct children.
2681 When nil, all entries in the subtree are considered.
2682 This has only an effect if `org-provide-todo-statistics' is set.
2683 To set this to nil for only a single subtree, use a COOKIE_DATA
2684 property and include the word \"recursive\" into the value."
2685 :group 'org-todo
2686 :type 'boolean)
2688 (defcustom org-after-todo-state-change-hook nil
2689 "Hook which is run after the state of a TODO item was changed.
2690 The new state (a string with a TODO keyword, or nil) is available in the
2691 Lisp variable `org-state'."
2692 :group 'org-todo
2693 :type 'hook)
2695 (defvar org-blocker-hook nil
2696 "Hook for functions that are allowed to block a state change.
2698 Functions in this hook should not modify the buffer.
2699 Each function gets as its single argument a property list,
2700 see `org-trigger-hook' for more information about this list.
2702 If any of the functions in this hook returns nil, the state change
2703 is blocked.")
2705 (defvar org-trigger-hook nil
2706 "Hook for functions that are triggered by a state change.
2708 Each function gets as its single argument a property list with at
2709 least the following elements:
2711 (:type type-of-change :position pos-at-entry-start
2712 :from old-state :to new-state)
2714 Depending on the type, more properties may be present.
2716 This mechanism is currently implemented for:
2718 TODO state changes
2719 ------------------
2720 :type todo-state-change
2721 :from previous state (keyword as a string), or nil, or a symbol
2722 'todo' or 'done', to indicate the general type of state.
2723 :to new state, like in :from")
2725 (defcustom org-enforce-todo-dependencies nil
2726 "Non-nil means undone TODO entries will block switching the parent to DONE.
2727 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2728 be blocked if any prior sibling is not yet done.
2729 Finally, if the parent is blocked because of ordered siblings of its own,
2730 the child will also be blocked."
2731 :set (lambda (var val)
2732 (set var val)
2733 (if val
2734 (add-hook 'org-blocker-hook
2735 'org-block-todo-from-children-or-siblings-or-parent)
2736 (remove-hook 'org-blocker-hook
2737 'org-block-todo-from-children-or-siblings-or-parent)))
2738 :group 'org-todo
2739 :type 'boolean)
2741 (defcustom org-enforce-todo-checkbox-dependencies nil
2742 "Non-nil means unchecked boxes will block switching the parent to DONE.
2743 When this is nil, checkboxes have no influence on switching TODO states.
2744 When non-nil, you first need to check off all check boxes before the TODO
2745 entry can be switched to DONE.
2746 This variable needs to be set before org.el is loaded, and you need to
2747 restart Emacs after a change to make the change effective. The only way
2748 to change is while Emacs is running is through the customize interface."
2749 :set (lambda (var val)
2750 (set var val)
2751 (if val
2752 (add-hook 'org-blocker-hook
2753 'org-block-todo-from-checkboxes)
2754 (remove-hook 'org-blocker-hook
2755 'org-block-todo-from-checkboxes)))
2756 :group 'org-todo
2757 :type 'boolean)
2759 (defcustom org-treat-insert-todo-heading-as-state-change nil
2760 "Non-nil means inserting a TODO heading is treated as state change.
2761 So when the command \\[org-insert-todo-heading] is used, state change
2762 logging will apply if appropriate. When nil, the new TODO item will
2763 be inserted directly, and no logging will take place."
2764 :group 'org-todo
2765 :type 'boolean)
2767 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2768 "Non-nil means switching TODO states with S-cursor counts as state change.
2769 This is the default behavior. However, setting this to nil allows a
2770 convenient way to select a TODO state and bypass any logging associated
2771 with that."
2772 :group 'org-todo
2773 :type 'boolean)
2775 (defcustom org-todo-state-tags-triggers nil
2776 "Tag changes that should be triggered by TODO state changes.
2777 This is a list. Each entry is
2779 (state-change (tag . flag) .......)
2781 State-change can be a string with a state, and empty string to indicate the
2782 state that has no TODO keyword, or it can be one of the symbols `todo'
2783 or `done', meaning any not-done or done state, respectively."
2784 :group 'org-todo
2785 :group 'org-tags
2786 :type '(repeat
2787 (cons (choice :tag "When changing to"
2788 (const :tag "Not-done state" todo)
2789 (const :tag "Done state" done)
2790 (string :tag "State"))
2791 (repeat
2792 (cons :tag "Tag action"
2793 (string :tag "Tag")
2794 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2796 (defcustom org-log-done nil
2797 "Information to record when a task moves to the DONE state.
2799 Possible values are:
2801 nil Don't add anything, just change the keyword
2802 time Add a time stamp to the task
2803 note Prompt for a note and add it with template `org-log-note-headings'
2805 This option can also be set with on a per-file-basis with
2807 #+STARTUP: nologdone
2808 #+STARTUP: logdone
2809 #+STARTUP: lognotedone
2811 You can have local logging settings for a subtree by setting the LOGGING
2812 property to one or more of these keywords."
2813 :group 'org-todo
2814 :group 'org-progress
2815 :type '(choice
2816 (const :tag "No logging" nil)
2817 (const :tag "Record CLOSED timestamp" time)
2818 (const :tag "Record CLOSED timestamp with note." note)))
2820 ;; Normalize old uses of org-log-done.
2821 (cond
2822 ((eq org-log-done t) (setq org-log-done 'time))
2823 ((and (listp org-log-done) (memq 'done org-log-done))
2824 (setq org-log-done 'note)))
2826 (defcustom org-log-reschedule nil
2827 "Information to record when the scheduling date of a tasks is modified.
2829 Possible values are:
2831 nil Don't add anything, just change the date
2832 time Add a time stamp to the task
2833 note Prompt for a note and add it with template `org-log-note-headings'
2835 This option can also be set with on a per-file-basis with
2837 #+STARTUP: nologreschedule
2838 #+STARTUP: logreschedule
2839 #+STARTUP: lognotereschedule"
2840 :group 'org-todo
2841 :group 'org-progress
2842 :type '(choice
2843 (const :tag "No logging" nil)
2844 (const :tag "Record timestamp" time)
2845 (const :tag "Record timestamp with note." note)))
2847 (defcustom org-log-redeadline nil
2848 "Information to record when the deadline date of a tasks is modified.
2850 Possible values are:
2852 nil Don't add anything, just change the date
2853 time Add a time stamp to the task
2854 note Prompt for a note and add it with template `org-log-note-headings'
2856 This option can also be set with on a per-file-basis with
2858 #+STARTUP: nologredeadline
2859 #+STARTUP: logredeadline
2860 #+STARTUP: lognoteredeadline
2862 You can have local logging settings for a subtree by setting the LOGGING
2863 property to one or more of these keywords."
2864 :group 'org-todo
2865 :group 'org-progress
2866 :type '(choice
2867 (const :tag "No logging" nil)
2868 (const :tag "Record timestamp" time)
2869 (const :tag "Record timestamp with note." note)))
2871 (defcustom org-log-note-clock-out nil
2872 "Non-nil means record a note when clocking out of an item.
2873 This can also be configured on a per-file basis by adding one of
2874 the following lines anywhere in the buffer:
2876 #+STARTUP: lognoteclock-out
2877 #+STARTUP: nolognoteclock-out"
2878 :group 'org-todo
2879 :group 'org-progress
2880 :type 'boolean)
2882 (defcustom org-log-done-with-time t
2883 "Non-nil means the CLOSED time stamp will contain date and time.
2884 When nil, only the date will be recorded."
2885 :group 'org-progress
2886 :type 'boolean)
2888 (defcustom org-log-note-headings
2889 '((done . "CLOSING NOTE %t")
2890 (state . "State %-12s from %-12S %t")
2891 (note . "Note taken on %t")
2892 (reschedule . "Rescheduled from %S on %t")
2893 (delschedule . "Not scheduled, was %S on %t")
2894 (redeadline . "New deadline from %S on %t")
2895 (deldeadline . "Removed deadline, was %S on %t")
2896 (refile . "Refiled on %t")
2897 (clock-out . ""))
2898 "Headings for notes added to entries.
2899 The value is an alist, with the car being a symbol indicating the note
2900 context, and the cdr is the heading to be used. The heading may also be the
2901 empty string.
2902 %t in the heading will be replaced by a time stamp.
2903 %T will be an active time stamp instead the default inactive one
2904 %d will be replaced by a short-format time stamp.
2905 %D will be replaced by an active short-format time stamp.
2906 %s will be replaced by the new TODO state, in double quotes.
2907 %S will be replaced by the old TODO state, in double quotes.
2908 %u will be replaced by the user name.
2909 %U will be replaced by the full user name.
2911 In fact, it is not a good idea to change the `state' entry, because
2912 agenda log mode depends on the format of these entries."
2913 :group 'org-todo
2914 :group 'org-progress
2915 :type '(list :greedy t
2916 (cons (const :tag "Heading when closing an item" done) string)
2917 (cons (const :tag
2918 "Heading when changing todo state (todo sequence only)"
2919 state) string)
2920 (cons (const :tag "Heading when just taking a note" note) string)
2921 (cons (const :tag "Heading when rescheduling" reschedule) string)
2922 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2923 (cons (const :tag "Heading when changing deadline" redeadline) string)
2924 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2925 (cons (const :tag "Heading when refiling" refile) string)
2926 (cons (const :tag "Heading when clocking out" clock-out) string)))
2928 (unless (assq 'note org-log-note-headings)
2929 (push '(note . "%t") org-log-note-headings))
2931 (defcustom org-log-into-drawer nil
2932 "Non-nil means insert state change notes and time stamps into a drawer.
2933 When nil, state changes notes will be inserted after the headline and
2934 any scheduling and clock lines, but not inside a drawer.
2936 The value of this variable should be the name of the drawer to use.
2937 LOGBOOK is proposed as the default drawer for this purpose, you can
2938 also set this to a string to define the drawer of your choice.
2940 A value of t is also allowed, representing \"LOGBOOK\".
2942 A value of t or nil can also be set with on a per-file-basis with
2944 #+STARTUP: logdrawer
2945 #+STARTUP: nologdrawer
2947 If this variable is set, `org-log-state-notes-insert-after-drawers'
2948 will be ignored.
2950 You can set the property LOG_INTO_DRAWER to overrule this setting for
2951 a subtree.
2953 Do not check directly this variable in a Lisp program. Call
2954 function `org-log-into-drawer' instead."
2955 :group 'org-todo
2956 :group 'org-progress
2957 :type '(choice
2958 (const :tag "Not into a drawer" nil)
2959 (const :tag "LOGBOOK" t)
2960 (string :tag "Other")))
2962 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2964 (defun org-log-into-drawer ()
2965 "Name of the log drawer, as a string, or nil.
2966 This is the value of `org-log-into-drawer'. However, if the
2967 current entry has or inherits a LOG_INTO_DRAWER property, it will
2968 be used instead of the default value."
2969 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2970 (cond ((equal p "nil") nil)
2971 ((equal p "t") "LOGBOOK")
2972 ((stringp p) p)
2973 (p "LOGBOOK")
2974 ((stringp org-log-into-drawer) org-log-into-drawer)
2975 (org-log-into-drawer "LOGBOOK"))))
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-time-stamp-rounding-minutes '(0 5)
3104 "Number of minutes to round time stamps to.
3105 These are two values, the first applies when first creating a time stamp.
3106 The second applies when changing it with the commands `S-up' and `S-down'.
3107 When changing the time stamp, this means that it will change in steps
3108 of N minutes, as given by the second value.
3110 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3111 numbers should be factors of 60, so for example 5, 10, 15.
3113 When this is larger than 1, you can still force an exact time stamp by using
3114 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3115 and by using a prefix arg to `S-up/down' to specify the exact number
3116 of minutes to shift."
3117 :group 'org-time
3118 :get (lambda (var) ; Make sure both elements are there
3119 (if (integerp (default-value var))
3120 (list (default-value var) 5)
3121 (default-value var)))
3122 :type '(list
3123 (integer :tag "when inserting times")
3124 (integer :tag "when modifying times")))
3126 ;; Normalize old customizations of this variable.
3127 (when (integerp org-time-stamp-rounding-minutes)
3128 (setq org-time-stamp-rounding-minutes
3129 (list org-time-stamp-rounding-minutes
3130 org-time-stamp-rounding-minutes)))
3132 (defcustom org-display-custom-times nil
3133 "Non-nil means overlay custom formats over all time stamps.
3134 The formats are defined through the variable `org-time-stamp-custom-formats'.
3135 To turn this on on a per-file basis, insert anywhere in the file:
3136 #+STARTUP: customtime"
3137 :group 'org-time
3138 :set 'set-default
3139 :type 'sexp)
3140 (make-variable-buffer-local 'org-display-custom-times)
3142 (defcustom org-time-stamp-custom-formats
3143 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3144 "Custom formats for time stamps. See `format-time-string' for the syntax.
3145 These are overlaid over the default ISO format if the variable
3146 `org-display-custom-times' is set. Time like %H:%M should be at the
3147 end of the second format. The custom formats are also honored by export
3148 commands, if custom time display is turned on at the time of export."
3149 :group 'org-time
3150 :type 'sexp)
3152 (defun org-time-stamp-format (&optional long inactive)
3153 "Get the right format for a time string."
3154 (let ((f (if long (cdr org-time-stamp-formats)
3155 (car org-time-stamp-formats))))
3156 (if inactive
3157 (concat "[" (substring f 1 -1) "]")
3158 f)))
3160 (defcustom org-time-clocksum-format
3161 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3162 "The format string used when creating CLOCKSUM lines.
3163 This is also used when Org mode generates a time duration.
3165 The value can be a single format string containing two
3166 %-sequences, which will be filled with the number of hours and
3167 minutes in that order.
3169 Alternatively, the value can be a plist associating any of the
3170 keys :years, :months, :weeks, :days, :hours or :minutes with
3171 format strings. The time duration is formatted using only the
3172 time components that are needed and concatenating the results.
3173 If a time unit in absent, it falls back to the next smallest
3174 unit.
3176 The keys :require-years, :require-months, :require-days,
3177 :require-weeks, :require-hours, :require-minutes are also
3178 meaningful. A non-nil value for these keys indicates that the
3179 corresponding time component should always be included, even if
3180 its value is 0.
3183 For example,
3185 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3186 :require-minutes t)
3188 means durations longer than a day will be expressed in days,
3189 hours and minutes, and durations less than a day will always be
3190 expressed in hours and minutes (even for durations less than an
3191 hour).
3193 The value
3195 \(:days \"%dd\" :minutes \"%dm\")
3197 means durations longer than a day will be expressed in days and
3198 minutes, and durations less than a day will be expressed entirely
3199 in minutes (even for durations longer than an hour)."
3200 :group 'org-time
3201 :group 'org-clock
3202 :version "24.4"
3203 :package-version '(Org . "8.0")
3204 :type '(choice (string :tag "Format string")
3205 (set :tag "Plist"
3206 (group :inline t (const :tag "Years" :years)
3207 (string :tag "Format string"))
3208 (group :inline t
3209 (const :tag "Always show years" :require-years)
3210 (const t))
3211 (group :inline t (const :tag "Months" :months)
3212 (string :tag "Format string"))
3213 (group :inline t
3214 (const :tag "Always show months" :require-months)
3215 (const t))
3216 (group :inline t (const :tag "Weeks" :weeks)
3217 (string :tag "Format string"))
3218 (group :inline t
3219 (const :tag "Always show weeks" :require-weeks)
3220 (const t))
3221 (group :inline t (const :tag "Days" :days)
3222 (string :tag "Format string"))
3223 (group :inline t
3224 (const :tag "Always show days" :require-days)
3225 (const t))
3226 (group :inline t (const :tag "Hours" :hours)
3227 (string :tag "Format string"))
3228 (group :inline t
3229 (const :tag "Always show hours" :require-hours)
3230 (const t))
3231 (group :inline t (const :tag "Minutes" :minutes)
3232 (string :tag "Format string"))
3233 (group :inline t
3234 (const :tag "Always show minutes" :require-minutes)
3235 (const t)))))
3237 (defcustom org-time-clocksum-use-fractional nil
3238 "When non-nil, \\[org-clock-display] uses fractional times.
3239 See `org-time-clocksum-format' for more on time clock formats."
3240 :group 'org-time
3241 :group 'org-clock
3242 :version "24.3"
3243 :type 'boolean)
3245 (defcustom org-time-clocksum-use-effort-durations nil
3246 "When non-nil, \\[org-clock-display] uses effort durations.
3247 E.g. by default, one day is considered to be a 8 hours effort,
3248 so a task that has been clocked for 16 hours will be displayed
3249 as during 2 days in the clock display or in the clocktable.
3251 See `org-effort-durations' on how to set effort durations
3252 and `org-time-clocksum-format' for more on time clock formats."
3253 :group 'org-time
3254 :group 'org-clock
3255 :version "24.4"
3256 :package-version '(Org . "8.0")
3257 :type 'boolean)
3259 (defcustom org-time-clocksum-fractional-format "%.2f"
3260 "The format string used when creating CLOCKSUM lines,
3261 or when Org mode generates a time duration, if
3262 `org-time-clocksum-use-fractional' is enabled.
3264 The value can be a single format string containing one
3265 %-sequence, which will be filled with the number of hours as
3266 a float.
3268 Alternatively, the value can be a plist associating any of the
3269 keys :years, :months, :weeks, :days, :hours or :minutes with
3270 a format string. The time duration is formatted using the
3271 largest time unit which gives a non-zero integer part. If all
3272 specified formats have zero integer part, the smallest time unit
3273 is used."
3274 :group 'org-time
3275 :type '(choice (string :tag "Format string")
3276 (set (group :inline t (const :tag "Years" :years)
3277 (string :tag "Format string"))
3278 (group :inline t (const :tag "Months" :months)
3279 (string :tag "Format string"))
3280 (group :inline t (const :tag "Weeks" :weeks)
3281 (string :tag "Format string"))
3282 (group :inline t (const :tag "Days" :days)
3283 (string :tag "Format string"))
3284 (group :inline t (const :tag "Hours" :hours)
3285 (string :tag "Format string"))
3286 (group :inline t (const :tag "Minutes" :minutes)
3287 (string :tag "Format string")))))
3289 (defcustom org-deadline-warning-days 14
3290 "Number of days before expiration during which a deadline becomes active.
3291 This variable governs the display in sparse trees and in the agenda.
3292 When 0 or negative, it means use this number (the absolute value of it)
3293 even if a deadline has a different individual lead time specified.
3295 Custom commands can set this variable in the options section."
3296 :group 'org-time
3297 :group 'org-agenda-daily/weekly
3298 :type 'integer)
3300 (defcustom org-scheduled-delay-days 0
3301 "Number of days before a scheduled item becomes active.
3302 This variable governs the display in sparse trees and in the agenda.
3303 The default value (i.e. 0) means: don't delay scheduled item.
3304 When negative, it means use this number (the absolute value of it)
3305 even if a scheduled item has a different individual delay time
3306 specified.
3308 Custom commands can set this variable in the options section."
3309 :group 'org-time
3310 :group 'org-agenda-daily/weekly
3311 :version "24.4"
3312 :package-version '(Org . "8.0")
3313 :type 'integer)
3315 (defcustom org-read-date-prefer-future t
3316 "Non-nil means assume future for incomplete date input from user.
3317 This affects the following situations:
3318 1. The user gives a month but not a year.
3319 For example, if it is April and you enter \"feb 2\", this will be read
3320 as Feb 2, *next* year. \"May 5\", however, will be this year.
3321 2. The user gives a day, but no month.
3322 For example, if today is the 15th, and you enter \"3\", Org-mode will
3323 read this as the third of *next* month. However, if you enter \"17\",
3324 it will be considered as *this* month.
3326 If you set this variable to the symbol `time', then also the following
3327 will work:
3329 3. If the user gives a time.
3330 If the time is before now, it will be interpreted as tomorrow.
3332 Currently none of this works for ISO week specifications.
3334 When this option is nil, the current day, month and year will always be
3335 used as defaults.
3337 See also `org-agenda-jump-prefer-future'."
3338 :group 'org-time
3339 :type '(choice
3340 (const :tag "Never" nil)
3341 (const :tag "Check month and day" t)
3342 (const :tag "Check month, day, and time" time)))
3344 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3345 "Should the agenda jump command prefer the future for incomplete dates?
3346 The default is to do the same as configured in `org-read-date-prefer-future'.
3347 But you can also set a deviating value here.
3348 This may t or nil, or the symbol `org-read-date-prefer-future'."
3349 :group 'org-agenda
3350 :group 'org-time
3351 :version "24.1"
3352 :type '(choice
3353 (const :tag "Use org-read-date-prefer-future"
3354 org-read-date-prefer-future)
3355 (const :tag "Never" nil)
3356 (const :tag "Always" t)))
3358 (defcustom org-read-date-force-compatible-dates t
3359 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3361 Depending on the system Emacs is running on, certain dates cannot
3362 be represented with the type used internally to represent time.
3363 Dates between 1970-1-1 and 2038-1-1 can always be represented
3364 correctly. Some systems allow for earlier dates, some for later,
3365 some for both. One way to find out it to insert any date into an
3366 Org buffer, putting the cursor on the year and hitting S-up and
3367 S-down to test the range.
3369 When this variable is set to t, the date/time prompt will not let
3370 you specify dates outside the 1970-2037 range, so it is certain that
3371 these dates will work in whatever version of Emacs you are
3372 running, and also that you can move a file from one Emacs implementation
3373 to another. WHenever Org is forcing the year for you, it will display
3374 a message and beep.
3376 When this variable is nil, Org will check if the date is
3377 representable in the specific Emacs implementation you are using.
3378 If not, it will force a year, usually the current year, and beep
3379 to remind you. Currently this setting is not recommended because
3380 the likelihood that you will open your Org files in an Emacs that
3381 has limited date range is not negligible.
3383 A workaround for this problem is to use diary sexp dates for time
3384 stamps outside of this range."
3385 :group 'org-time
3386 :version "24.1"
3387 :type 'boolean)
3389 (defcustom org-read-date-display-live t
3390 "Non-nil means display current interpretation of date prompt live.
3391 This display will be in an overlay, in the minibuffer."
3392 :group 'org-time
3393 :type 'boolean)
3395 (defcustom org-read-date-popup-calendar t
3396 "Non-nil means pop up a calendar when prompting for a date.
3397 In the calendar, the date can be selected with mouse-1. However, the
3398 minibuffer will also be active, and you can simply enter the date as well.
3399 When nil, only the minibuffer will be available."
3400 :group 'org-time
3401 :type 'boolean)
3402 (org-defvaralias 'org-popup-calendar-for-date-prompt
3403 'org-read-date-popup-calendar)
3405 (make-obsolete-variable
3406 'org-read-date-minibuffer-setup-hook
3407 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3408 (defcustom org-read-date-minibuffer-setup-hook nil
3409 "Hook to be used to set up keys for the date/time interface.
3410 Add key definitions to `minibuffer-local-map', which will be a
3411 temporary copy.
3413 WARNING: This option is obsolete, you should use
3414 `org-read-date-minibuffer-local-map' to set up keys."
3415 :group 'org-time
3416 :type 'hook)
3418 (defcustom org-extend-today-until 0
3419 "The hour when your day really ends. Must be an integer.
3420 This has influence for the following applications:
3421 - When switching the agenda to \"today\". It it is still earlier than
3422 the time given here, the day recognized as TODAY is actually yesterday.
3423 - When a date is read from the user and it is still before the time given
3424 here, the current date and time will be assumed to be yesterday, 23:59.
3425 Also, timestamps inserted in capture templates follow this rule.
3427 IMPORTANT: This is a feature whose implementation is and likely will
3428 remain incomplete. Really, it is only here because past midnight seems to
3429 be the favorite working time of John Wiegley :-)"
3430 :group 'org-time
3431 :type 'integer)
3433 (defcustom org-use-effective-time nil
3434 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3435 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3436 \"effective time\" of any timestamps between midnight and 8am will be
3437 23:59 of the previous day."
3438 :group 'org-time
3439 :version "24.1"
3440 :type 'boolean)
3442 (defcustom org-use-last-clock-out-time-as-effective-time nil
3443 "When non-nil, use the last clock out time for `org-todo'.
3444 Note that this option has precedence over the combined use of
3445 `org-use-effective-time' and `org-extend-today-until'."
3446 :group 'org-time
3447 :version "24.4"
3448 :package-version '(Org . "8.0")
3449 :type 'boolean)
3451 (defcustom org-edit-timestamp-down-means-later nil
3452 "Non-nil means S-down will increase the time in a time stamp.
3453 When nil, S-up will increase."
3454 :group 'org-time
3455 :type 'boolean)
3457 (defcustom org-calendar-follow-timestamp-change t
3458 "Non-nil means make the calendar window follow timestamp changes.
3459 When a timestamp is modified and the calendar window is visible, it will be
3460 moved to the new date."
3461 :group 'org-time
3462 :type 'boolean)
3464 (defgroup org-tags nil
3465 "Options concerning tags in Org-mode."
3466 :tag "Org Tags"
3467 :group 'org)
3469 (defcustom org-tag-alist nil
3470 "List of tags allowed in Org-mode files.
3471 When this list is nil, Org-mode will base TAG input on what is already in the
3472 buffer.
3473 The value of this variable is an alist, the car of each entry must be a
3474 keyword as a string, the cdr may be a character that is used to select
3475 that tag through the fast-tag-selection interface.
3476 See the manual for details."
3477 :group 'org-tags
3478 :type '(repeat
3479 (choice
3480 (cons (string :tag "Tag name")
3481 (character :tag "Access char"))
3482 (list :tag "Start radio group"
3483 (const :startgroup)
3484 (option (string :tag "Group description")))
3485 (list :tag "Group tags delimiter"
3486 (const :grouptags))
3487 (list :tag "End radio group"
3488 (const :endgroup)
3489 (option (string :tag "Group description")))
3490 (const :tag "New line" (:newline)))))
3492 (defcustom org-tag-persistent-alist nil
3493 "List of tags that will always appear in all Org-mode files.
3494 This is in addition to any in buffer settings or customizations
3495 of `org-tag-alist'.
3496 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3497 The value of this variable is an alist, the car of each entry must be a
3498 keyword as a string, the cdr may be a character that is used to select
3499 that tag through the fast-tag-selection interface.
3500 See the manual for details.
3501 To disable these tags on a per-file basis, insert anywhere in the file:
3502 #+STARTUP: noptag"
3503 :group 'org-tags
3504 :type '(repeat
3505 (choice
3506 (cons (string :tag "Tag name")
3507 (character :tag "Access char"))
3508 (const :tag "Start radio group" (:startgroup))
3509 (const :tag "Group tags delimiter" (:grouptags))
3510 (const :tag "End radio group" (:endgroup))
3511 (const :tag "New line" (:newline)))))
3513 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3514 "If non-nil, always offer completion for all tags of all agenda files.
3515 Instead of customizing this variable directly, you might want to
3516 set it locally for capture buffers, because there no list of
3517 tags in that file can be created dynamically (there are none).
3519 (add-hook 'org-capture-mode-hook
3520 (lambda ()
3521 (set (make-local-variable
3522 'org-complete-tags-always-offer-all-agenda-tags)
3523 t)))"
3524 :group 'org-tags
3525 :version "24.1"
3526 :type 'boolean)
3528 (defvar org-file-tags nil
3529 "List of tags that can be inherited by all entries in the file.
3530 The tags will be inherited if the variable `org-use-tag-inheritance'
3531 says they should be.
3532 This variable is populated from #+FILETAGS lines.")
3534 (defcustom org-use-fast-tag-selection 'auto
3535 "Non-nil means use fast tag selection scheme.
3536 This is a special interface to select and deselect tags with single keys.
3537 When nil, fast selection is never used.
3538 When the symbol `auto', fast selection is used if and only if selection
3539 characters for tags have been configured, either through the variable
3540 `org-tag-alist' or through a #+TAGS line in the buffer.
3541 When t, fast selection is always used and selection keys are assigned
3542 automatically if necessary."
3543 :group 'org-tags
3544 :type '(choice
3545 (const :tag "Always" t)
3546 (const :tag "Never" nil)
3547 (const :tag "When selection characters are configured" auto)))
3549 (defcustom org-fast-tag-selection-single-key nil
3550 "Non-nil means fast tag selection exits after first change.
3551 When nil, you have to press RET to exit it.
3552 During fast tag selection, you can toggle this flag with `C-c'.
3553 This variable can also have the value `expert'. In this case, the window
3554 displaying the tags menu is not even shown, until you press C-c again."
3555 :group 'org-tags
3556 :type '(choice
3557 (const :tag "No" nil)
3558 (const :tag "Yes" t)
3559 (const :tag "Expert" expert)))
3561 (defvar org-fast-tag-selection-include-todo nil
3562 "Non-nil means fast tags selection interface will also offer TODO states.
3563 This is an undocumented feature, you should not rely on it.")
3565 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3566 "The column to which tags should be indented in a headline.
3567 If this number is positive, it specifies the column. If it is negative,
3568 it means that the tags should be flushright to that column. For example,
3569 -80 works well for a normal 80 character screen.
3570 When 0, place tags directly after headline text, with only one space in
3571 between."
3572 :group 'org-tags
3573 :type 'integer)
3575 (defcustom org-auto-align-tags t
3576 "Non-nil keeps tags aligned when modifying headlines.
3577 Some operations (i.e. demoting) change the length of a headline and
3578 therefore shift the tags around. With this option turned on, after
3579 each such operation the tags are again aligned to `org-tags-column'."
3580 :group 'org-tags
3581 :type 'boolean)
3583 (defcustom org-use-tag-inheritance t
3584 "Non-nil means tags in levels apply also for sublevels.
3585 When nil, only the tags directly given in a specific line apply there.
3586 This may also be a list of tags that should be inherited, or a regexp that
3587 matches tags that should be inherited. Additional control is possible
3588 with the variable `org-tags-exclude-from-inheritance' which gives an
3589 explicit list of tags to be excluded from inheritance, even if the value of
3590 `org-use-tag-inheritance' would select it for inheritance.
3592 If this option is t, a match early-on in a tree can lead to a large
3593 number of matches in the subtree when constructing the agenda or creating
3594 a sparse tree. If you only want to see the first match in a tree during
3595 a search, check out the variable `org-tags-match-list-sublevels'."
3596 :group 'org-tags
3597 :type '(choice
3598 (const :tag "Not" nil)
3599 (const :tag "Always" t)
3600 (repeat :tag "Specific tags" (string :tag "Tag"))
3601 (regexp :tag "Tags matched by regexp")))
3603 (defcustom org-tags-exclude-from-inheritance nil
3604 "List of tags that should never be inherited.
3605 This is a way to exclude a few tags from inheritance. For way to do
3606 the opposite, to actively allow inheritance for selected tags,
3607 see the variable `org-use-tag-inheritance'."
3608 :group 'org-tags
3609 :type '(repeat (string :tag "Tag")))
3611 (defun org-tag-inherit-p (tag)
3612 "Check if TAG is one that should be inherited."
3613 (cond
3614 ((member tag org-tags-exclude-from-inheritance) nil)
3615 ((eq org-use-tag-inheritance t) t)
3616 ((not org-use-tag-inheritance) nil)
3617 ((stringp org-use-tag-inheritance)
3618 (string-match org-use-tag-inheritance tag))
3619 ((listp org-use-tag-inheritance)
3620 (member tag org-use-tag-inheritance))
3621 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3623 (defcustom org-tags-match-list-sublevels t
3624 "Non-nil means list also sublevels of headlines matching a search.
3625 This variable applies to tags/property searches, and also to stuck
3626 projects because this search is based on a tags match as well.
3628 When set to the symbol `indented', sublevels are indented with
3629 leading dots.
3631 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3632 the sublevels of a headline matching a tag search often also match
3633 the same search. Listing all of them can create very long lists.
3634 Setting this variable to nil causes subtrees of a match to be skipped.
3636 This variable is semi-obsolete and probably should always be true. It
3637 is better to limit inheritance to certain tags using the variables
3638 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3639 :group 'org-tags
3640 :type '(choice
3641 (const :tag "No, don't list them" nil)
3642 (const :tag "Yes, do list them" t)
3643 (const :tag "List them, indented with leading dots" indented)))
3645 (defcustom org-tags-sort-function nil
3646 "When set, tags are sorted using this function as a comparator."
3647 :group 'org-tags
3648 :type '(choice
3649 (const :tag "No sorting" nil)
3650 (const :tag "Alphabetical" string<)
3651 (const :tag "Reverse alphabetical" string>)
3652 (function :tag "Custom function" nil)))
3654 (defvar org-tags-history nil
3655 "History of minibuffer reads for tags.")
3656 (defvar org-last-tags-completion-table nil
3657 "The last used completion table for tags.")
3658 (defvar org-after-tags-change-hook nil
3659 "Hook that is run after the tags in a line have changed.")
3661 (defgroup org-properties nil
3662 "Options concerning properties in Org-mode."
3663 :tag "Org Properties"
3664 :group 'org)
3666 (defcustom org-property-format "%-10s %s"
3667 "How property key/value pairs should be formatted by `indent-line'.
3668 When `indent-line' hits a property definition, it will format the line
3669 according to this format, mainly to make sure that the values are
3670 lined-up with respect to each other."
3671 :group 'org-properties
3672 :type 'string)
3674 (defcustom org-properties-postprocess-alist nil
3675 "Alist of properties and functions to adjust inserted values.
3676 Elements of this alist must be of the form
3678 ([string] [function])
3680 where [string] must be a property name and [function] must be a
3681 lambda expression: this lambda expression must take one argument,
3682 the value to adjust, and return the new value as a string.
3684 For example, this element will allow the property \"Remaining\"
3685 to be updated wrt the relation between the \"Effort\" property
3686 and the clock summary:
3688 ((\"Remaining\" (lambda(value)
3689 (let ((clocksum (org-clock-sum-current-item))
3690 (effort (org-duration-string-to-minutes
3691 (org-entry-get (point) \"Effort\"))))
3692 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3693 :group 'org-properties
3694 :version "24.1"
3695 :type '(alist :key-type (string :tag "Property")
3696 :value-type (function :tag "Function")))
3698 (defcustom org-use-property-inheritance nil
3699 "Non-nil means properties apply also for sublevels.
3701 This setting is chiefly used during property searches. Turning it on can
3702 cause significant overhead when doing a search, which is why it is not
3703 on by default.
3705 When nil, only the properties directly given in the current entry count.
3706 When t, every property is inherited. The value may also be a list of
3707 properties that should have inheritance, or a regular expression matching
3708 properties that should be inherited.
3710 However, note that some special properties use inheritance under special
3711 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3712 and the properties ending in \"_ALL\" when they are used as descriptor
3713 for valid values of a property.
3715 Note for programmers:
3716 When querying an entry with `org-entry-get', you can control if inheritance
3717 should be used. By default, `org-entry-get' looks only at the local
3718 properties. You can request inheritance by setting the inherit argument
3719 to t (to force inheritance) or to `selective' (to respect the setting
3720 in this variable)."
3721 :group 'org-properties
3722 :type '(choice
3723 (const :tag "Not" nil)
3724 (const :tag "Always" t)
3725 (repeat :tag "Specific properties" (string :tag "Property"))
3726 (regexp :tag "Properties matched by regexp")))
3728 (defun org-property-inherit-p (property)
3729 "Check if PROPERTY is one that should be inherited."
3730 (cond
3731 ((eq org-use-property-inheritance t) t)
3732 ((not org-use-property-inheritance) nil)
3733 ((stringp org-use-property-inheritance)
3734 (string-match org-use-property-inheritance property))
3735 ((listp org-use-property-inheritance)
3736 (member property org-use-property-inheritance))
3737 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3739 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3740 "The default column format, if no other format has been defined.
3741 This variable can be set on the per-file basis by inserting a line
3743 #+COLUMNS: %25ITEM ....."
3744 :group 'org-properties
3745 :type 'string)
3747 (defcustom org-columns-ellipses ".."
3748 "The ellipses to be used when a field in column view is truncated.
3749 When this is the empty string, as many characters as possible are shown,
3750 but then there will be no visual indication that the field has been truncated.
3751 When this is a string of length N, the last N characters of a truncated
3752 field are replaced by this string. If the column is narrower than the
3753 ellipses string, only part of the ellipses string will be shown."
3754 :group 'org-properties
3755 :type 'string)
3757 (defcustom org-columns-modify-value-for-display-function nil
3758 "Function that modifies values for display in column view.
3759 For example, it can be used to cut out a certain part from a time stamp.
3760 The function must take 2 arguments:
3762 column-title The title of the column (*not* the property name)
3763 value The value that should be modified.
3765 The function should return the value that should be displayed,
3766 or nil if the normal value should be used."
3767 :group 'org-properties
3768 :type '(choice (const nil) (function)))
3770 (defconst org-global-properties-fixed
3771 '(("VISIBILITY_ALL" . "folded children content all")
3772 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3773 "List of property/value pairs that can be inherited by any entry.
3775 These are fixed values, for the preset properties. The user variable
3776 that can be used to add to this list is `org-global-properties'.
3778 The entries in this list are cons cells where the car is a property
3779 name and cdr is a string with the value. If the value represents
3780 multiple items like an \"_ALL\" property, separate the items by
3781 spaces.")
3783 (defcustom org-global-properties nil
3784 "List of property/value pairs that can be inherited by any entry.
3786 This list will be combined with the constant `org-global-properties-fixed'.
3788 The entries in this list are cons cells where the car is a property
3789 name and cdr is a string with the value.
3791 You can set buffer-local values for the same purpose in the variable
3792 `org-file-properties' this by adding lines like
3794 #+PROPERTY: NAME VALUE"
3795 :group 'org-properties
3796 :type '(repeat
3797 (cons (string :tag "Property")
3798 (string :tag "Value"))))
3800 (defvar org-file-properties nil
3801 "List of property/value pairs that can be inherited by any entry.
3802 Valid for the current buffer.
3803 This variable is populated from #+PROPERTY lines.")
3804 (make-variable-buffer-local 'org-file-properties)
3806 (defgroup org-agenda nil
3807 "Options concerning agenda views in Org-mode."
3808 :tag "Org Agenda"
3809 :group 'org)
3811 (defvar org-category nil
3812 "Variable used by org files to set a category for agenda display.
3813 Such files should use a file variable to set it, for example
3815 # -*- mode: org; org-category: \"ELisp\"
3817 or contain a special line
3819 #+CATEGORY: ELisp
3821 If the file does not specify a category, then file's base name
3822 is used instead.")
3823 (make-variable-buffer-local 'org-category)
3824 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3826 (defcustom org-agenda-files nil
3827 "The files to be used for agenda display.
3828 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3829 \\[org-remove-file]. You can also use customize to edit the list.
3831 If an entry is a directory, all files in that directory that are matched by
3832 `org-agenda-file-regexp' will be part of the file list.
3834 If the value of the variable is not a list but a single file name, then
3835 the list of agenda files is actually stored and maintained in that file, one
3836 agenda file per line. In this file paths can be given relative to
3837 `org-directory'. Tilde expansion and environment variable substitution
3838 are also made."
3839 :group 'org-agenda
3840 :type '(choice
3841 (repeat :tag "List of files and directories" file)
3842 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3844 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3845 "Regular expression to match files for `org-agenda-files'.
3846 If any element in the list in that variable contains a directory instead
3847 of a normal file, all files in that directory that are matched by this
3848 regular expression will be included."
3849 :group 'org-agenda
3850 :type 'regexp)
3852 (defcustom org-agenda-text-search-extra-files nil
3853 "List of extra files to be searched by text search commands.
3854 These files will be searched in addition to the agenda files by the
3855 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3856 Note that these files will only be searched for text search commands,
3857 not for the other agenda views like todo lists, tag searches or the weekly
3858 agenda. This variable is intended to list notes and possibly archive files
3859 that should also be searched by these two commands.
3860 In fact, if the first element in the list is the symbol `agenda-archives',
3861 then all archive files of all agenda files will be added to the search
3862 scope."
3863 :group 'org-agenda
3864 :type '(set :greedy t
3865 (const :tag "Agenda Archives" agenda-archives)
3866 (repeat :inline t (file))))
3868 (org-defvaralias 'org-agenda-multi-occur-extra-files
3869 'org-agenda-text-search-extra-files)
3871 (defcustom org-agenda-skip-unavailable-files nil
3872 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3873 A nil value means to remove them, after a query, from the list."
3874 :group 'org-agenda
3875 :type 'boolean)
3877 (defcustom org-calendar-to-agenda-key [?c]
3878 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3879 The command `org-calendar-goto-agenda' will be bound to this key. The
3880 default is the character `c' because then `c' can be used to switch back and
3881 forth between agenda and calendar."
3882 :group 'org-agenda
3883 :type 'sexp)
3885 (defcustom org-calendar-insert-diary-entry-key [?i]
3886 "The key to be installed in `calendar-mode-map' for adding diary entries.
3887 This option is irrelevant until `org-agenda-diary-file' has been configured
3888 to point to an Org-mode file. When that is the case, the command
3889 `org-agenda-diary-entry' will be bound to the key given here, by default
3890 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3891 if you want to continue doing this, you need to change this to a different
3892 key."
3893 :group 'org-agenda
3894 :type 'sexp)
3896 (defcustom org-agenda-diary-file 'diary-file
3897 "File to which to add new entries with the `i' key in agenda and calendar.
3898 When this is the symbol `diary-file', the functionality in the Emacs
3899 calendar will be used to add entries to the `diary-file'. But when this
3900 points to a file, `org-agenda-diary-entry' will be used instead."
3901 :group 'org-agenda
3902 :type '(choice
3903 (const :tag "The standard Emacs diary file" diary-file)
3904 (file :tag "Special Org file diary entries")))
3906 (eval-after-load "calendar"
3907 '(progn
3908 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3909 'org-calendar-goto-agenda)
3910 (add-hook 'calendar-mode-hook
3911 (lambda ()
3912 (unless (eq org-agenda-diary-file 'diary-file)
3913 (define-key calendar-mode-map
3914 org-calendar-insert-diary-entry-key
3915 'org-agenda-diary-entry))))))
3917 (defgroup org-latex nil
3918 "Options for embedding LaTeX code into Org-mode."
3919 :tag "Org LaTeX"
3920 :group 'org)
3922 (defcustom org-format-latex-options
3923 '(:foreground default :background default :scale 1.0
3924 :html-foreground "Black" :html-background "Transparent"
3925 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3926 "Options for creating images from LaTeX fragments.
3927 This is a property list with the following properties:
3928 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3929 `default' means use the foreground of the default face.
3930 `auto' means use the foreground from the text face.
3931 :background the background color, or \"Transparent\".
3932 `default' means use the background of the default face.
3933 `auto' means use the background from the text face.
3934 :scale a scaling factor for the size of the images, to get more pixels
3935 :html-foreground, :html-background, :html-scale
3936 the same numbers for HTML export.
3937 :matchers a list indicating which matchers should be used to
3938 find LaTeX fragments. Valid members of this list are:
3939 \"begin\" find environments
3940 \"$1\" find single characters surrounded by $.$
3941 \"$\" find math expressions surrounded by $...$
3942 \"$$\" find math expressions surrounded by $$....$$
3943 \"\\(\" find math expressions surrounded by \\(...\\)
3944 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3945 :group 'org-latex
3946 :type 'plist)
3948 (defcustom org-format-latex-signal-error t
3949 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3950 When nil, just push out a message."
3951 :group 'org-latex
3952 :version "24.1"
3953 :type 'boolean)
3955 (defcustom org-latex-to-mathml-jar-file nil
3956 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3957 Use this to specify additional executable file say a jar file.
3959 When using MathToWeb as the converter, specify the full-path to
3960 your mathtoweb.jar file."
3961 :group 'org-latex
3962 :version "24.1"
3963 :type '(choice
3964 (const :tag "None" nil)
3965 (file :tag "JAR file" :must-match t)))
3967 (defcustom org-latex-to-mathml-convert-command nil
3968 "Command to convert LaTeX fragments to MathML.
3969 Replace format-specifiers in the command as noted below and use
3970 `shell-command' to convert LaTeX to MathML.
3971 %j: Executable file in fully expanded form as specified by
3972 `org-latex-to-mathml-jar-file'.
3973 %I: Input LaTeX file in fully expanded form.
3974 %i: The latex fragment to be converted.
3975 %o: Output MathML file.
3976 This command is used by `org-create-math-formula'.
3978 When using MathToWeb as the converter, set this to
3979 \"java -jar %j -unicode -force -df %o %I\".
3981 When using LaTeXML set this to
3982 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3983 :group 'org-latex
3984 :version "24.1"
3985 :type '(choice
3986 (const :tag "None" nil)
3987 (string :tag "\nShell command")))
3989 (defcustom org-latex-create-formula-image-program 'dvipng
3990 "Program to convert LaTeX fragments with.
3992 dvipng Process the LaTeX fragments to dvi file, then convert
3993 dvi files to png files using dvipng.
3994 This will also include processing of non-math environments.
3995 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3996 to convert pdf files to png files"
3997 :group 'org-latex
3998 :version "24.1"
3999 :type '(choice
4000 (const :tag "dvipng" dvipng)
4001 (const :tag "imagemagick" imagemagick)))
4003 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4004 "Path to store latex preview images.
4005 A relative path here creates many directories relative to the
4006 processed org files paths. An absolute path puts all preview
4007 images at the same place."
4008 :group 'org-latex
4009 :version "24.3"
4010 :type 'string)
4012 (defun org-format-latex-mathml-available-p ()
4013 "Return t if `org-latex-to-mathml-convert-command' is usable."
4014 (save-match-data
4015 (when (and (boundp 'org-latex-to-mathml-convert-command)
4016 org-latex-to-mathml-convert-command)
4017 (let ((executable (car (split-string
4018 org-latex-to-mathml-convert-command))))
4019 (when (executable-find executable)
4020 (if (string-match
4021 "%j" org-latex-to-mathml-convert-command)
4022 (file-readable-p org-latex-to-mathml-jar-file)
4023 t))))))
4025 (defcustom org-format-latex-header "\\documentclass{article}
4026 \\usepackage[usenames]{color}
4027 \[PACKAGES]
4028 \[DEFAULT-PACKAGES]
4029 \\pagestyle{empty} % do not remove
4030 % The settings below are copied from fullpage.sty
4031 \\setlength{\\textwidth}{\\paperwidth}
4032 \\addtolength{\\textwidth}{-3cm}
4033 \\setlength{\\oddsidemargin}{1.5cm}
4034 \\addtolength{\\oddsidemargin}{-2.54cm}
4035 \\setlength{\\evensidemargin}{\\oddsidemargin}
4036 \\setlength{\\textheight}{\\paperheight}
4037 \\addtolength{\\textheight}{-\\headheight}
4038 \\addtolength{\\textheight}{-\\headsep}
4039 \\addtolength{\\textheight}{-\\footskip}
4040 \\addtolength{\\textheight}{-3cm}
4041 \\setlength{\\topmargin}{1.5cm}
4042 \\addtolength{\\topmargin}{-2.54cm}"
4043 "The document header used for processing LaTeX fragments.
4044 It is imperative that this header make sure that no page number
4045 appears on the page. The package defined in the variables
4046 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4047 will either replace the placeholder \"[PACKAGES]\" in this
4048 header, or they will be appended."
4049 :group 'org-latex
4050 :type 'string)
4052 (defun org-set-packages-alist (var val)
4053 "Set the packages alist and make sure it has 3 elements per entry."
4054 (set var (mapcar (lambda (x)
4055 (if (and (consp x) (= (length x) 2))
4056 (list (car x) (nth 1 x) t)
4058 val)))
4060 (defun org-get-packages-alist (var)
4061 "Get the packages alist and make sure it has 3 elements per entry."
4062 (mapcar (lambda (x)
4063 (if (and (consp x) (= (length x) 2))
4064 (list (car x) (nth 1 x) t)
4066 (default-value var)))
4068 (defcustom org-latex-default-packages-alist
4069 '(("AUTO" "inputenc" t)
4070 ("T1" "fontenc" t)
4071 ("" "fixltx2e" nil)
4072 ("" "graphicx" t)
4073 ("" "longtable" nil)
4074 ("" "float" nil)
4075 ("" "wrapfig" nil)
4076 ("" "rotating" nil)
4077 ("normalem" "ulem" t)
4078 ("" "amsmath" t)
4079 ("" "textcomp" t)
4080 ("" "marvosym" t)
4081 ("" "wasysym" t)
4082 ("" "amssymb" t)
4083 ("" "capt-of" nil)
4084 ("" "hyperref" nil)
4085 "\\tolerance=1000")
4086 "Alist of default packages to be inserted in the header.
4088 Change this only if one of the packages here causes an
4089 incompatibility with another package you are using.
4091 The packages in this list are needed by one part or another of
4092 Org mode to function properly:
4094 - inputenc, fontenc: for basic font and character selection
4095 - fixltx2e: Important patches of LaTeX itself
4096 - graphicx: for including images
4097 - longtable: For multipage tables
4098 - float, wrapfig: for figure placement
4099 - rotating: for sideways figures and tables
4100 - ulem: for underline and strike-through
4101 - amsmath: for subscript and superscript and math environments
4102 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4103 for interpreting the entities in `org-entities'. You can skip
4104 some of these packages if you don't use any of their symbols.
4105 - capt-of: for captions outside of floats
4106 - hyperref: for cross references
4108 Therefore you should not modify this variable unless you know
4109 what you are doing. The one reason to change it anyway is that
4110 you might be loading some other package that conflicts with one
4111 of the default packages. Each element is either a cell or
4112 a string.
4114 A cell is of the format:
4116 \( \"options\" \"package\" SNIPPET-FLAG).
4118 If SNIPPET-FLAG is non-nil, the package also needs to be included
4119 when compiling LaTeX snippets into images for inclusion into
4120 non-LaTeX output.
4122 A string will be inserted as-is in the header of the document."
4123 :group 'org-latex
4124 :group 'org-export-latex
4125 :set 'org-set-packages-alist
4126 :get 'org-get-packages-alist
4127 :version "24.1"
4128 :type '(repeat
4129 (choice
4130 (list :tag "options/package pair"
4131 (string :tag "options")
4132 (string :tag "package")
4133 (boolean :tag "Snippet"))
4134 (string :tag "A line of LaTeX"))))
4136 (defcustom org-latex-packages-alist nil
4137 "Alist of packages to be inserted in every LaTeX header.
4139 These will be inserted after `org-latex-default-packages-alist'.
4140 Each element is either a cell or a string.
4142 A cell is of the format:
4144 \(\"options\" \"package\" SNIPPET-FLAG)
4146 SNIPPET-FLAG, when non-nil, indicates that this package is also
4147 needed when turning LaTeX snippets into images for inclusion into
4148 non-LaTeX output.
4150 A string will be inserted as-is in the header of the document.
4152 Make sure that you only list packages here which:
4154 - you want in every file;
4155 - do not conflict with the setup in `org-format-latex-header';
4156 - do not conflict with the default packages in
4157 `org-latex-default-packages-alist'."
4158 :group 'org-latex
4159 :group 'org-export-latex
4160 :set 'org-set-packages-alist
4161 :get 'org-get-packages-alist
4162 :type '(repeat
4163 (choice
4164 (list :tag "options/package pair"
4165 (string :tag "options")
4166 (string :tag "package")
4167 (boolean :tag "Snippet"))
4168 (string :tag "A line of LaTeX"))))
4170 (defgroup org-appearance nil
4171 "Settings for Org-mode appearance."
4172 :tag "Org Appearance"
4173 :group 'org)
4175 (defcustom org-level-color-stars-only nil
4176 "Non-nil means fontify only the stars in each headline.
4177 When nil, the entire headline is fontified.
4178 Changing it requires restart of `font-lock-mode' to become effective
4179 also in regions already fontified."
4180 :group 'org-appearance
4181 :type 'boolean)
4183 (defcustom org-hide-leading-stars nil
4184 "Non-nil means hide the first N-1 stars in a headline.
4185 This works by using the face `org-hide' for these stars. This
4186 face is white for a light background, and black for a dark
4187 background. You may have to customize the face `org-hide' to
4188 make this work.
4189 Changing it requires restart of `font-lock-mode' to become effective
4190 also in regions already fontified.
4191 You may also set this on a per-file basis by adding one of the following
4192 lines to the buffer:
4194 #+STARTUP: hidestars
4195 #+STARTUP: showstars"
4196 :group 'org-appearance
4197 :type 'boolean)
4199 (defcustom org-hidden-keywords nil
4200 "List of symbols corresponding to keywords to be hidden the org buffer.
4201 For example, a value '(title) for this list will make the document's title
4202 appear in the buffer without the initial #+TITLE: keyword."
4203 :group 'org-appearance
4204 :version "24.1"
4205 :type '(set (const :tag "#+AUTHOR" author)
4206 (const :tag "#+DATE" date)
4207 (const :tag "#+EMAIL" email)
4208 (const :tag "#+TITLE" title)))
4210 (defcustom org-custom-properties nil
4211 "List of properties (as strings) with a special meaning.
4212 The default use of these custom properties is to let the user
4213 hide them with `org-toggle-custom-properties-visibility'."
4214 :group 'org-properties
4215 :group 'org-appearance
4216 :version "24.3"
4217 :type '(repeat (string :tag "Property Name")))
4219 (defcustom org-fontify-done-headline nil
4220 "Non-nil means change the face of a headline if it is marked DONE.
4221 Normally, only the TODO/DONE keyword indicates the state of a headline.
4222 When this is non-nil, the headline after the keyword is set to the
4223 `org-headline-done' as an additional indication."
4224 :group 'org-appearance
4225 :type 'boolean)
4227 (defcustom org-fontify-emphasized-text t
4228 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4229 Changing this variable requires a restart of Emacs to take effect."
4230 :group 'org-appearance
4231 :type 'boolean)
4233 (defcustom org-fontify-whole-heading-line nil
4234 "Non-nil means fontify the whole line for headings.
4235 This is useful when setting a background color for the
4236 org-level-* faces."
4237 :group 'org-appearance
4238 :type 'boolean)
4240 (defcustom org-highlight-latex-and-related nil
4241 "Non-nil means highlight LaTeX related syntax in the buffer.
4242 When non nil, the value should be a list containing any of the
4243 following symbols:
4244 `latex' Highlight LaTeX snippets and environments.
4245 `script' Highlight subscript and superscript.
4246 `entities' Highlight entities."
4247 :group 'org-appearance
4248 :version "24.4"
4249 :package-version '(Org . "8.0")
4250 :type '(choice
4251 (const :tag "No highlighting" nil)
4252 (set :greedy t :tag "Highlight"
4253 (const :tag "LaTeX snippets and environments" latex)
4254 (const :tag "Subscript and superscript" script)
4255 (const :tag "Entities" entities))))
4257 (defcustom org-hide-emphasis-markers nil
4258 "Non-nil mean font-lock should hide the emphasis marker characters."
4259 :group 'org-appearance
4260 :type 'boolean)
4262 (defcustom org-hide-macro-markers nil
4263 "Non-nil mean font-lock should hide the brackets marking macro calls."
4264 :group 'org-appearance
4265 :type 'boolean)
4267 (defcustom org-pretty-entities nil
4268 "Non-nil means show entities as UTF8 characters.
4269 When nil, the \\name form remains in the buffer."
4270 :group 'org-appearance
4271 :version "24.1"
4272 :type 'boolean)
4274 (defcustom org-pretty-entities-include-sub-superscripts t
4275 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4276 :group 'org-appearance
4277 :version "24.1"
4278 :type 'boolean)
4280 (defvar org-emph-re nil
4281 "Regular expression for matching emphasis.
4282 After a match, the match groups contain these elements:
4283 0 The match of the full regular expression, including the characters
4284 before and after the proper match
4285 1 The character before the proper match, or empty at beginning of line
4286 2 The proper match, including the leading and trailing markers
4287 3 The leading marker like * or /, indicating the type of highlighting
4288 4 The text between the emphasis markers, not including the markers
4289 5 The character after the match, empty at the end of a line")
4290 (defvar org-verbatim-re nil
4291 "Regular expression for matching verbatim text.")
4292 (defvar org-emphasis-regexp-components) ; defined just below
4293 (defvar org-emphasis-alist) ; defined just below
4294 (defun org-set-emph-re (var val)
4295 "Set variable and compute the emphasis regular expression."
4296 (set var val)
4297 (when (and (boundp 'org-emphasis-alist)
4298 (boundp 'org-emphasis-regexp-components)
4299 org-emphasis-alist org-emphasis-regexp-components)
4300 (let* ((e org-emphasis-regexp-components)
4301 (pre (car e))
4302 (post (nth 1 e))
4303 (border (nth 2 e))
4304 (body (nth 3 e))
4305 (nl (nth 4 e))
4306 (body1 (concat body "*?"))
4307 (markers (mapconcat 'car org-emphasis-alist ""))
4308 (vmarkers (mapconcat
4309 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4310 org-emphasis-alist "")))
4311 ;; make sure special characters appear at the right position in the class
4312 (if (string-match "\\^" markers)
4313 (setq markers (concat (replace-match "" t t markers) "^")))
4314 (if (string-match "-" markers)
4315 (setq markers (concat (replace-match "" t t markers) "-")))
4316 (if (string-match "\\^" vmarkers)
4317 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4318 (if (string-match "-" vmarkers)
4319 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4320 (if (> nl 0)
4321 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4322 (int-to-string nl) "\\}")))
4323 ;; Make the regexp
4324 (setq org-emph-re
4325 (concat "\\([" pre "]\\|^\\)"
4326 "\\("
4327 "\\([" markers "]\\)"
4328 "\\("
4329 "[^" border "]\\|"
4330 "[^" border "]"
4331 body1
4332 "[^" border "]"
4333 "\\)"
4334 "\\3\\)"
4335 "\\([" post "]\\|$\\)"))
4336 (setq org-verbatim-re
4337 (concat "\\([" pre "]\\|^\\)"
4338 "\\("
4339 "\\([" vmarkers "]\\)"
4340 "\\("
4341 "[^" border "]\\|"
4342 "[^" border "]"
4343 body1
4344 "[^" border "]"
4345 "\\)"
4346 "\\3\\)"
4347 "\\([" post "]\\|$\\)")))))
4349 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4350 ;; set this option proved cumbersome. See this message/thread:
4351 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4352 (defvar org-emphasis-regexp-components
4353 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4354 "Components used to build the regular expression for emphasis.
4355 This is a list with five entries. Terminology: In an emphasis string
4356 like \" *strong word* \", we call the initial space PREMATCH, the final
4357 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4358 and \"trong wor\" is the body. The different components in this variable
4359 specify what is allowed/forbidden in each part:
4361 pre Chars allowed as prematch. Beginning of line will be allowed too.
4362 post Chars allowed as postmatch. End of line will be allowed too.
4363 border The chars *forbidden* as border characters.
4364 body-regexp A regexp like \".\" to match a body character. Don't use
4365 non-shy groups here, and don't allow newline here.
4366 newline The maximum number of newlines allowed in an emphasis exp.
4368 You need to reload Org or to restart Emacs after customizing this.")
4370 (defcustom org-emphasis-alist
4371 `(("*" bold)
4372 ("/" italic)
4373 ("_" underline)
4374 ("=" org-verbatim verbatim)
4375 ("~" org-code verbatim)
4376 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4377 "Alist of characters and faces to emphasize text.
4378 Text starting and ending with a special character will be emphasized,
4379 for example *bold*, _underlined_ and /italic/. This variable sets the
4380 marker characters and the face to be used by font-lock for highlighting
4381 in Org-mode Emacs buffers.
4383 You need to reload Org or to restart Emacs after customizing this."
4384 :group 'org-appearance
4385 :set 'org-set-emph-re
4386 :version "24.4"
4387 :package-version '(Org . "8.0")
4388 :type '(repeat
4389 (list
4390 (string :tag "Marker character")
4391 (choice
4392 (face :tag "Font-lock-face")
4393 (plist :tag "Face property list"))
4394 (option (const verbatim)))))
4396 (defvar org-protecting-blocks
4397 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4398 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4399 This is needed for font-lock setup.")
4401 ;;; Miscellaneous options
4403 (defgroup org-completion nil
4404 "Completion in Org-mode."
4405 :tag "Org Completion"
4406 :group 'org)
4408 (defcustom org-completion-use-ido nil
4409 "Non-nil means use ido completion wherever possible.
4410 Note that `ido-mode' must be active for this variable to be relevant.
4411 If you decide to turn this variable on, you might well want to turn off
4412 `org-outline-path-complete-in-steps'.
4413 See also `org-completion-use-iswitchb'."
4414 :group 'org-completion
4415 :type 'boolean)
4417 (defcustom org-completion-use-iswitchb nil
4418 "Non-nil means use iswitchb completion wherever possible.
4419 Note that `iswitchb-mode' must be active for this variable to be relevant.
4420 If you decide to turn this variable on, you might well want to turn off
4421 `org-outline-path-complete-in-steps'.
4422 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4423 :group 'org-completion
4424 :type 'boolean)
4426 (defcustom org-completion-fallback-command 'hippie-expand
4427 "The expansion command called by \\[pcomplete] in normal context.
4428 Normal means, no org-mode-specific context."
4429 :group 'org-completion
4430 :type 'function)
4432 ;;; Functions and variables from their packages
4433 ;; Declared here to avoid compiler warnings
4435 ;; XEmacs only
4436 (defvar outline-mode-menu-heading)
4437 (defvar outline-mode-menu-show)
4438 (defvar outline-mode-menu-hide)
4439 (defvar zmacs-regions) ; XEmacs regions
4441 ;; Emacs only
4442 (defvar mark-active)
4444 ;; Various packages
4445 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4446 (declare-function calendar-forward-day "cal-move" (arg))
4447 (declare-function calendar-goto-date "cal-move" (date))
4448 (declare-function calendar-goto-today "cal-move" ())
4449 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4450 (defvar calc-embedded-close-formula)
4451 (defvar calc-embedded-open-formula)
4452 (declare-function cdlatex-tab "ext:cdlatex" ())
4453 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4454 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4455 (defvar font-lock-unfontify-region-function)
4456 (declare-function iswitchb-read-buffer "iswitchb"
4457 (prompt &optional default require-match start matches-set))
4458 (defvar iswitchb-temp-buflist)
4459 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4460 (defvar org-agenda-tags-todo-honor-ignore-options)
4461 (declare-function org-agenda-skip "org-agenda" ())
4462 (declare-function
4463 org-agenda-format-item "org-agenda"
4464 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4465 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4466 (declare-function org-agenda-change-all-lines "org-agenda"
4467 (newhead hdmarker &optional fixface just-this))
4468 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4469 (declare-function org-agenda-maybe-redo "org-agenda" ())
4470 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4471 (beg end))
4472 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4473 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4474 "org-agenda" (&optional end))
4475 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4476 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4477 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4478 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4479 (declare-function org-indent-mode "org-indent" (&optional arg))
4480 (declare-function parse-time-string "parse-time" (string))
4481 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4482 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4483 (defvar remember-data-file)
4484 (defvar texmathp-why)
4485 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4486 (declare-function table--at-cell-p "table" (position &optional object at-column))
4487 (declare-function calc-eval "calc" (str &optional separator &rest args))
4489 ;;;###autoload
4490 (defun turn-on-orgtbl ()
4491 "Unconditionally turn on `orgtbl-mode'."
4492 (require 'org-table)
4493 (orgtbl-mode 1))
4495 (defun org-at-table-p (&optional table-type)
4496 "Return t if the cursor is inside an org-type table.
4497 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4498 (if org-enable-table-editor
4499 (save-excursion
4500 (beginning-of-line 1)
4501 (looking-at (if table-type org-table-any-line-regexp
4502 org-table-line-regexp)))
4503 nil))
4504 (defsubst org-table-p () (org-at-table-p))
4506 (defun org-at-table.el-p ()
4507 "Return t if and only if we are at a table.el table."
4508 (and (org-at-table-p 'any)
4509 (save-excursion
4510 (goto-char (org-table-begin 'any))
4511 (looking-at org-table1-hline-regexp))))
4513 (defun org-table-recognize-table.el ()
4514 "If there is a table.el table nearby, recognize it and move into it."
4515 (if org-table-tab-recognizes-table.el
4516 (if (org-at-table.el-p)
4517 (progn
4518 (beginning-of-line 1)
4519 (if (looking-at org-table-dataline-regexp)
4521 (if (looking-at org-table1-hline-regexp)
4522 (progn
4523 (beginning-of-line 2)
4524 (if (looking-at org-table-any-border-regexp)
4525 (beginning-of-line -1)))))
4526 (if (re-search-forward "|" (org-table-end t) t)
4527 (progn
4528 (require 'table)
4529 (if (table--at-cell-p (point))
4531 (message "recognizing table.el table...")
4532 (table-recognize-table)
4533 (message "recognizing table.el table...done")))
4534 (error "This should not happen"))
4536 nil)
4537 nil))
4539 (defun org-at-table-hline-p ()
4540 "Return t if the cursor is inside a hline in a table."
4541 (if org-enable-table-editor
4542 (save-excursion
4543 (beginning-of-line 1)
4544 (looking-at org-table-hline-regexp))
4545 nil))
4547 (defun org-table-map-tables (function &optional quietly)
4548 "Apply FUNCTION to the start of all tables in the buffer."
4549 (save-excursion
4550 (save-restriction
4551 (widen)
4552 (goto-char (point-min))
4553 (while (re-search-forward org-table-any-line-regexp nil t)
4554 (unless quietly
4555 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4556 (beginning-of-line 1)
4557 (when (and (looking-at org-table-line-regexp)
4558 ;; Exclude tables in src/example/verbatim/clocktable blocks
4559 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4560 (save-excursion (funcall function))
4561 (or (looking-at org-table-line-regexp)
4562 (forward-char 1)))
4563 (re-search-forward org-table-any-border-regexp nil 1))))
4564 (unless quietly (message "Mapping tables: done")))
4566 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4567 (declare-function org-clock-update-mode-line "org-clock" ())
4568 (declare-function org-resolve-clocks "org-clock"
4569 (&optional also-non-dangling-p prompt last-valid))
4571 (defun org-at-TBLFM-p (&optional pos)
4572 "Return t when point (or POS) is in #+TBLFM line."
4573 (save-excursion
4574 (let ((pos pos)))
4575 (goto-char (or pos (point)))
4576 (beginning-of-line 1)
4577 (looking-at org-TBLFM-regexp)))
4579 (defvar org-clock-start-time)
4580 (defvar org-clock-marker (make-marker)
4581 "Marker recording the last clock-in.")
4582 (defvar org-clock-hd-marker (make-marker)
4583 "Marker recording the last clock-in, but the headline position.")
4584 (defvar org-clock-heading ""
4585 "The heading of the current clock entry.")
4586 (defun org-clock-is-active ()
4587 "Return the buffer where the clock is currently running.
4588 Return nil if no clock is running."
4589 (marker-buffer org-clock-marker))
4591 (defun org-check-running-clock ()
4592 "Check if the current buffer contains the running clock.
4593 If yes, offer to stop it and to save the buffer with the changes."
4594 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4595 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4596 (buffer-name))))
4597 (org-clock-out)
4598 (when (y-or-n-p "Save changed buffer?")
4599 (save-buffer))))
4601 (defun org-clocktable-try-shift (dir n)
4602 "Check if this line starts a clock table, if yes, shift the time block."
4603 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4604 (org-clocktable-shift dir n)))
4606 ;;;###autoload
4607 (defun org-clock-persistence-insinuate ()
4608 "Set up hooks for clock persistence."
4609 (require 'org-clock)
4610 (add-hook 'org-mode-hook 'org-clock-load)
4611 (add-hook 'kill-emacs-hook 'org-clock-save))
4613 (defgroup org-archive nil
4614 "Options concerning archiving in Org-mode."
4615 :tag "Org Archive"
4616 :group 'org-structure)
4618 (defcustom org-archive-location "%s_archive::"
4619 "The location where subtrees should be archived.
4621 The value of this variable is a string, consisting of two parts,
4622 separated by a double-colon. The first part is a filename and
4623 the second part is a headline.
4625 When the filename is omitted, archiving happens in the same file.
4626 %s in the filename will be replaced by the current file
4627 name (without the directory part). Archiving to a different file
4628 is useful to keep archived entries from contributing to the
4629 Org-mode Agenda.
4631 The archived entries will be filed as subtrees of the specified
4632 headline. When the headline is omitted, the subtrees are simply
4633 filed away at the end of the file, as top-level entries. Also in
4634 the heading you can use %s to represent the file name, this can be
4635 useful when using the same archive for a number of different files.
4637 Here are a few examples:
4638 \"%s_archive::\"
4639 If the current file is Projects.org, archive in file
4640 Projects.org_archive, as top-level trees. This is the default.
4642 \"::* Archived Tasks\"
4643 Archive in the current file, under the top-level headline
4644 \"* Archived Tasks\".
4646 \"~/org/archive.org::\"
4647 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4649 \"~/org/archive.org::* From %s\"
4650 Archive in file ~/org/archive.org (absolute path), under headlines
4651 \"From FILENAME\" where file name is the current file name.
4653 \"~/org/datetree.org::datetree/* Finished Tasks\"
4654 The \"datetree/\" string is special, signifying to archive
4655 items to the datetree. Items are placed in either the CLOSED
4656 date of the item, or the current date if there is no CLOSED date.
4657 The heading will be a subentry to the current date. There doesn't
4658 need to be a heading, but there always needs to be a slash after
4659 datetree. For example, to store archived items directly in the
4660 datetree, use \"~/org/datetree.org::datetree/\".
4662 \"basement::** Finished Tasks\"
4663 Archive in file ./basement (relative path), as level 3 trees
4664 below the level 2 heading \"** Finished Tasks\".
4666 You may set this option on a per-file basis by adding to the buffer a
4667 line like
4669 #+ARCHIVE: basement::** Finished Tasks
4671 You may also define it locally for a subtree by setting an ARCHIVE property
4672 in the entry. If such a property is found in an entry, or anywhere up
4673 the hierarchy, it will be used."
4674 :group 'org-archive
4675 :type 'string)
4677 (defcustom org-agenda-skip-archived-trees t
4678 "Non-nil means the agenda will skip any items located in archived trees.
4679 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4680 variable is no longer recommended, you should leave it at the value t.
4681 Instead, use the key `v' to cycle the archives-mode in the agenda."
4682 :group 'org-archive
4683 :group 'org-agenda-skip
4684 :type 'boolean)
4686 (defcustom org-columns-skip-archived-trees t
4687 "Non-nil means ignore archived trees when creating column view."
4688 :group 'org-archive
4689 :group 'org-properties
4690 :type 'boolean)
4692 (defcustom org-cycle-open-archived-trees nil
4693 "Non-nil means `org-cycle' will open archived trees.
4694 An archived tree is a tree marked with the tag ARCHIVE.
4695 When nil, archived trees will stay folded. You can still open them with
4696 normal outline commands like `show-all', but not with the cycling commands."
4697 :group 'org-archive
4698 :group 'org-cycle
4699 :type 'boolean)
4701 (defcustom org-sparse-tree-open-archived-trees nil
4702 "Non-nil means sparse tree construction shows matches in archived trees.
4703 When nil, matches in these trees are highlighted, but the trees are kept in
4704 collapsed state."
4705 :group 'org-archive
4706 :group 'org-sparse-trees
4707 :type 'boolean)
4709 (defcustom org-sparse-tree-default-date-type nil
4710 "The default date type when building a sparse tree.
4711 When this is nil, a date is a scheduled or a deadline timestamp.
4712 Otherwise, these types are allowed:
4714 all: all timestamps
4715 active: only active timestamps (<...>)
4716 inactive: only inactive timestamps ([...])
4717 scheduled: only scheduled timestamps
4718 deadline: only deadline timestamps"
4719 :type '(choice (const :tag "Scheduled or deadline" nil)
4720 (const :tag "All timestamps" all)
4721 (const :tag "Only active timestamps" active)
4722 (const :tag "Only inactive timestamps" inactive)
4723 (const :tag "Only scheduled timestamps" scheduled)
4724 (const :tag "Only deadline timestamps" deadline)
4725 (const :tag "Only closed timestamps" closed))
4726 :version "25.1"
4727 :package-version '(Org . "8.3")
4728 :group 'org-sparse-trees)
4730 (defun org-cycle-hide-archived-subtrees (state)
4731 "Re-hide all archived subtrees after a visibility state change."
4732 (when (and (not org-cycle-open-archived-trees)
4733 (not (memq state '(overview folded))))
4734 (save-excursion
4735 (let* ((globalp (memq state '(contents all)))
4736 (beg (if globalp (point-min) (point)))
4737 (end (if globalp (point-max) (org-end-of-subtree t))))
4738 (org-hide-archived-subtrees beg end)
4739 (goto-char beg)
4740 (if (looking-at (concat ".*:" org-archive-tag ":"))
4741 (message "%s" (substitute-command-keys
4742 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4744 (defun org-force-cycle-archived ()
4745 "Cycle subtree even if it is archived."
4746 (interactive)
4747 (setq this-command 'org-cycle)
4748 (let ((org-cycle-open-archived-trees t))
4749 (call-interactively 'org-cycle)))
4751 (defun org-hide-archived-subtrees (beg end)
4752 "Re-hide all archived subtrees after a visibility state change."
4753 (org-with-wide-buffer
4754 (let ((case-fold-search nil)
4755 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4756 (goto-char beg)
4757 (while (and (< (point) end) (re-search-forward re end t))
4758 (when (member org-archive-tag (org-get-tags))
4759 (org-flag-subtree t)
4760 (org-end-of-subtree t))))))
4762 (declare-function outline-end-of-heading "outline" ())
4763 (declare-function outline-flag-region "outline" (from to flag))
4764 (defun org-flag-subtree (flag)
4765 (save-excursion
4766 (org-back-to-heading t)
4767 (outline-end-of-heading)
4768 (outline-flag-region (point)
4769 (progn (org-end-of-subtree t) (point))
4770 flag)))
4772 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4774 ;; Declare Column View Code
4776 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4777 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4778 (declare-function org-columns-compute "org-colview" (property))
4780 ;; Declare ID code
4782 (declare-function org-id-store-link "org-id")
4783 (declare-function org-id-locations-load "org-id")
4784 (declare-function org-id-locations-save "org-id")
4785 (defvar org-id-track-globally)
4787 ;;; Variables for pre-computed regular expressions, all buffer local
4789 (defvar org-todo-regexp nil
4790 "Matches any of the TODO state keywords.")
4791 (make-variable-buffer-local 'org-todo-regexp)
4792 (defvar org-not-done-regexp nil
4793 "Matches any of the TODO state keywords except the last one.")
4794 (make-variable-buffer-local 'org-not-done-regexp)
4795 (defvar org-not-done-heading-regexp nil
4796 "Matches a TODO headline that is not done.")
4797 (make-variable-buffer-local 'org-not-done-regexp)
4798 (defvar org-todo-line-regexp nil
4799 "Matches a headline and puts TODO state into group 2 if present.")
4800 (make-variable-buffer-local 'org-todo-line-regexp)
4801 (defvar org-complex-heading-regexp nil
4802 "Matches a headline and puts everything into groups:
4803 group 1: the stars
4804 group 2: The todo keyword, maybe
4805 group 3: Priority cookie
4806 group 4: True headline
4807 group 5: Tags")
4808 (make-variable-buffer-local 'org-complex-heading-regexp)
4809 (defvar org-complex-heading-regexp-format nil
4810 "Printf format to make regexp to match an exact headline.
4811 This regexp will match the headline of any node which has the
4812 exact headline text that is put into the format, but may have any
4813 TODO state, priority and tags.")
4814 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4815 (defvar org-todo-line-tags-regexp nil
4816 "Matches a headline and puts TODO state into group 2 if present.
4817 Also put tags into group 4 if tags are present.")
4818 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4820 (defconst org-plain-time-of-day-regexp
4821 (concat
4822 "\\(\\<[012]?[0-9]"
4823 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4824 "\\(--?"
4825 "\\(\\<[012]?[0-9]"
4826 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4827 "\\)?")
4828 "Regular expression to match a plain time or time range.
4829 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4830 groups carry important information:
4831 0 the full match
4832 1 the first time, range or not
4833 8 the second time, if it is a range.")
4835 (defconst org-plain-time-extension-regexp
4836 (concat
4837 "\\(\\<[012]?[0-9]"
4838 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4839 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4840 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4841 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4842 groups carry important information:
4843 0 the full match
4844 7 hours of duration
4845 9 minutes of duration")
4847 (defconst org-stamp-time-of-day-regexp
4848 (concat
4849 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4850 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4851 "\\(--?"
4852 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4853 "Regular expression to match a timestamp time or time range.
4854 After a match, the following groups carry important information:
4855 0 the full match
4856 1 date plus weekday, for back referencing to make sure both times are on the same day
4857 2 the first time, range or not
4858 4 the second time, if it is a range.")
4860 (defconst org-startup-options
4861 '(("fold" org-startup-folded t)
4862 ("overview" org-startup-folded t)
4863 ("nofold" org-startup-folded nil)
4864 ("showall" org-startup-folded nil)
4865 ("showeverything" org-startup-folded showeverything)
4866 ("content" org-startup-folded content)
4867 ("indent" org-startup-indented t)
4868 ("noindent" org-startup-indented nil)
4869 ("hidestars" org-hide-leading-stars t)
4870 ("showstars" org-hide-leading-stars nil)
4871 ("odd" org-odd-levels-only t)
4872 ("oddeven" org-odd-levels-only nil)
4873 ("align" org-startup-align-all-tables t)
4874 ("noalign" org-startup-align-all-tables nil)
4875 ("inlineimages" org-startup-with-inline-images t)
4876 ("noinlineimages" org-startup-with-inline-images nil)
4877 ("latexpreview" org-startup-with-latex-preview t)
4878 ("nolatexpreview" org-startup-with-latex-preview nil)
4879 ("customtime" org-display-custom-times t)
4880 ("logdone" org-log-done time)
4881 ("lognotedone" org-log-done note)
4882 ("nologdone" org-log-done nil)
4883 ("lognoteclock-out" org-log-note-clock-out t)
4884 ("nolognoteclock-out" org-log-note-clock-out nil)
4885 ("logrepeat" org-log-repeat state)
4886 ("lognoterepeat" org-log-repeat note)
4887 ("logdrawer" org-log-into-drawer t)
4888 ("nologdrawer" org-log-into-drawer nil)
4889 ("logstatesreversed" org-log-states-order-reversed t)
4890 ("nologstatesreversed" org-log-states-order-reversed nil)
4891 ("nologrepeat" org-log-repeat nil)
4892 ("logreschedule" org-log-reschedule time)
4893 ("lognotereschedule" org-log-reschedule note)
4894 ("nologreschedule" org-log-reschedule nil)
4895 ("logredeadline" org-log-redeadline time)
4896 ("lognoteredeadline" org-log-redeadline note)
4897 ("nologredeadline" org-log-redeadline nil)
4898 ("logrefile" org-log-refile time)
4899 ("lognoterefile" org-log-refile note)
4900 ("nologrefile" org-log-refile nil)
4901 ("fninline" org-footnote-define-inline t)
4902 ("nofninline" org-footnote-define-inline nil)
4903 ("fnlocal" org-footnote-section nil)
4904 ("fnauto" org-footnote-auto-label t)
4905 ("fnprompt" org-footnote-auto-label nil)
4906 ("fnconfirm" org-footnote-auto-label confirm)
4907 ("fnplain" org-footnote-auto-label plain)
4908 ("fnadjust" org-footnote-auto-adjust t)
4909 ("nofnadjust" org-footnote-auto-adjust nil)
4910 ("constcgs" constants-unit-system cgs)
4911 ("constSI" constants-unit-system SI)
4912 ("noptag" org-tag-persistent-alist nil)
4913 ("hideblocks" org-hide-block-startup t)
4914 ("nohideblocks" org-hide-block-startup nil)
4915 ("beamer" org-startup-with-beamer-mode t)
4916 ("entitiespretty" org-pretty-entities t)
4917 ("entitiesplain" org-pretty-entities nil))
4918 "Variable associated with STARTUP options for org-mode.
4919 Each element is a list of three items: the startup options (as written
4920 in the #+STARTUP line), the corresponding variable, and the value to set
4921 this variable to if the option is found. An optional forth element PUSH
4922 means to push this value onto the list in the variable.")
4924 (defcustom org-group-tags t
4925 "When non-nil (the default), use group tags.
4926 This can be turned on/off through `org-toggle-tags-groups'."
4927 :group 'org-tags
4928 :group 'org-startup
4929 :type 'boolean)
4931 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4933 (defun org-toggle-tags-groups ()
4934 "Toggle support for group tags.
4935 Support for group tags is controlled by the option
4936 `org-group-tags', which is non-nil by default."
4937 (interactive)
4938 (setq org-group-tags (not org-group-tags))
4939 (cond ((and (derived-mode-p 'org-agenda-mode)
4940 org-group-tags)
4941 (org-agenda-redo))
4942 ((derived-mode-p 'org-mode)
4943 (let ((org-inhibit-startup t)) (org-mode))))
4944 (message "Groups tags support has been turned %s"
4945 (if org-group-tags "on" "off")))
4947 (defun org-set-regexps-and-options (&optional tags-only)
4948 "Precompute regular expressions used in the current buffer.
4949 When optional argument TAGS-ONLY is non-nil, only compute tags
4950 related expressions."
4951 (when (derived-mode-p 'org-mode)
4952 (let ((alist (org--setup-collect-keywords
4953 (org-make-options-regexp
4954 (append '("FILETAGS" "TAGS" "SETUPFILE")
4955 (and (not tags-only)
4956 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4957 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4958 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4959 (org--setup-process-tags
4960 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4961 (unless tags-only
4962 ;; File properties.
4963 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4964 ;; Archive location.
4965 (let ((archive (cdr (assq 'archive alist))))
4966 (when archive (org-set-local 'org-archive-location archive)))
4967 ;; Category.
4968 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4969 (when cat
4970 (org-set-local 'org-category (intern cat))
4971 (org-set-local 'org-file-properties
4972 (org--update-property-plist
4973 "CATEGORY" cat org-file-properties))))
4974 ;; Columns.
4975 (let ((column (cdr (assq 'columns alist))))
4976 (when column (org-set-local 'org-columns-default-format column)))
4977 ;; Constants.
4978 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4979 ;; Link abbreviations.
4980 (let ((links (cdr (assq 'link alist))))
4981 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4982 ;; Priorities.
4983 (let ((priorities (cdr (assq 'priorities alist))))
4984 (when priorities
4985 (org-set-local 'org-highest-priority (nth 0 priorities))
4986 (org-set-local 'org-lowest-priority (nth 1 priorities))
4987 (org-set-local 'org-default-priority (nth 2 priorities))))
4988 ;; Scripts.
4989 (let ((scripts (assq 'scripts alist)))
4990 (when scripts
4991 (org-set-local 'org-use-sub-superscripts (cdr scripts))))
4992 ;; Startup options.
4993 (let ((startup (cdr (assq 'startup alist))))
4994 (dolist (option startup)
4995 (let ((entry (assoc-string option org-startup-options t)))
4996 (when entry
4997 (let ((var (nth 1 entry))
4998 (val (nth 2 entry)))
4999 (if (not (nth 3 entry)) (org-set-local var val)
5000 (unless (listp (symbol-value var))
5001 (org-set-local var nil))
5002 (add-to-list var val)))))))
5003 ;; TODO keywords.
5004 (org-set-local 'org-todo-kwd-alist nil)
5005 (org-set-local 'org-todo-key-alist nil)
5006 (org-set-local 'org-todo-key-trigger nil)
5007 (org-set-local 'org-todo-keywords-1 nil)
5008 (org-set-local 'org-done-keywords nil)
5009 (org-set-local 'org-todo-heads nil)
5010 (org-set-local 'org-todo-sets nil)
5011 (org-set-local 'org-todo-log-states nil)
5012 (let ((todo-sequences
5013 (or (nreverse (cdr (assq 'todo alist)))
5014 (let ((d (default-value 'org-todo-keywords)))
5015 (if (not (stringp (car d))) d
5016 ;; XXX: Backward compatibility code.
5017 (list (cons org-todo-interpretation d)))))))
5018 (dolist (sequence todo-sequences)
5019 (let* ((sequence (or (run-hook-with-args-until-success
5020 'org-todo-setup-filter-hook sequence)
5021 sequence))
5022 (sequence-type (car sequence))
5023 (keywords (cdr sequence))
5024 (sep (member "|" keywords))
5025 names alist)
5026 (dolist (k (remove "|" keywords))
5027 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5029 (error "Invalid TODO keyword %s" k))
5030 (let ((name (match-string 1 k))
5031 (key (match-string 2 k))
5032 (log (org-extract-log-state-settings k)))
5033 (push name names)
5034 (push (cons name (and key (string-to-char key))) alist)
5035 (when log (push log org-todo-log-states))))
5036 (let* ((names (nreverse names))
5037 (done (if sep (org-remove-keyword-keys (cdr sep))
5038 (last names)))
5039 (head (car names))
5040 (tail (list sequence-type head (car done) (org-last done))))
5041 (add-to-list 'org-todo-heads head 'append)
5042 (push names org-todo-sets)
5043 (setq org-done-keywords (append org-done-keywords done nil))
5044 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5045 (setq org-todo-key-alist
5046 (append org-todo-key-alist
5047 (and alist
5048 (append '((:startgroup))
5049 (nreverse alist)
5050 '((:endgroup))))))
5051 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5052 (setq org-todo-sets (nreverse org-todo-sets)
5053 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5054 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5055 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5056 ;; Compute the regular expressions and other local variables.
5057 ;; Using `org-outline-regexp-bol' would complicate them much,
5058 ;; because of the fixed white space at the end of that string.
5059 (if (not org-done-keywords)
5060 (setq org-done-keywords
5061 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5062 (setq org-not-done-keywords
5063 (org-delete-all org-done-keywords
5064 (copy-sequence org-todo-keywords-1))
5065 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5066 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5067 org-not-done-heading-regexp
5068 (format org-heading-keyword-regexp-format org-not-done-regexp)
5069 org-todo-line-regexp
5070 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5071 org-complex-heading-regexp
5072 (concat "^\\(\\*+\\)"
5073 "\\(?: +" org-todo-regexp "\\)?"
5074 "\\(?: +\\(\\[#.\\]\\)\\)?"
5075 "\\(?: +\\(.*?\\)\\)??"
5076 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5077 "[ \t]*$")
5078 org-complex-heading-regexp-format
5079 (concat "^\\(\\*+\\)"
5080 "\\(?: +" org-todo-regexp "\\)?"
5081 "\\(?: +\\(\\[#.\\]\\)\\)?"
5082 "\\(?: +"
5083 ;; Stats cookies can be stuck to body.
5084 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5085 "\\(%s\\)"
5086 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5087 "\\)"
5088 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5089 "[ \t]*$")
5090 org-todo-line-tags-regexp
5091 (concat "^\\(\\*+\\)"
5092 "\\(?: +" org-todo-regexp "\\)?"
5093 "\\(?: +\\(.*?\\)\\)??"
5094 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5095 "[ \t]*$"))
5096 (org-compute-latex-and-related-regexp)))))
5098 (defun org--setup-collect-keywords (regexp &optional files alist)
5099 "Return setup keywords values as an alist.
5101 REGEXP matches a subset of setup keywords. FILES is a list of
5102 file names already visited. It is used to avoid circular setup
5103 files. ALIST, when non-nil, is the alist computed so far.
5105 Return value contains the following keys: `archive', `category',
5106 `columns', `constants', `filetags', `link', `priorities',
5107 `property', `scripts', `startup', `tags' and `todo'."
5108 (org-with-wide-buffer
5109 (goto-char (point-min))
5110 (let ((case-fold-search t))
5111 (while (re-search-forward regexp nil t)
5112 (let ((element (org-element-at-point)))
5113 (when (eq (org-element-type element) 'keyword)
5114 (let ((key (org-element-property :key element))
5115 (value (org-element-property :value element)))
5116 (cond
5117 ((equal key "ARCHIVE")
5118 (when (org-string-nw-p value)
5119 (push (cons 'archive value) alist)))
5120 ((equal key "CATEGORY") (push (cons 'category value) alist))
5121 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5122 ((equal key "CONSTANTS")
5123 (let* ((constants (assq 'constants alist))
5124 (store (cdr constants)))
5125 (dolist (pair (org-split-string value))
5126 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5127 pair)
5128 (let* ((name (match-string 1 pair))
5129 (value (match-string 2 pair))
5130 (old (assoc name store)))
5131 (if old (setcdr old value)
5132 (push (cons name value) store)))))
5133 (if constants (setcdr constants store)
5134 (push (cons 'constants store) alist))))
5135 ((equal key "FILETAGS")
5136 (when (org-string-nw-p value)
5137 (let ((old (assq 'filetags alist))
5138 (new (apply #'nconc
5139 (mapcar (lambda (x) (org-split-string x ":"))
5140 (org-split-string value)))))
5141 (if old (setcdr old (append new (cdr old)))
5142 (push (cons 'filetags new) alist)))))
5143 ((equal key "LINK")
5144 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5145 (let ((links (assq 'link alist))
5146 (pair (cons (org-match-string-no-properties 1 value)
5147 (org-match-string-no-properties 2 value))))
5148 (if links (push pair (cdr links))
5149 (push (list 'link pair) alist)))))
5150 ((equal key "OPTIONS")
5151 (when (and (org-string-nw-p value)
5152 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5153 (push (cons 'scripts (read (match-string 1 value))) alist)))
5154 ((equal key "PRIORITIES")
5155 (push (cons 'priorities
5156 (let ((prio (org-split-string value)))
5157 (if (< (length prio) 3) '(?A ?C ?B)
5158 (mapcar #'string-to-char prio))))
5159 alist))
5160 ((equal key "PROPERTY")
5161 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5162 (let* ((property (assq 'property alist))
5163 (value (org--update-property-plist
5164 (org-match-string-no-properties 1 value)
5165 (org-match-string-no-properties 2 value)
5166 (cdr property))))
5167 (if property (setcdr property value)
5168 (push (cons 'property value) alist)))))
5169 ((equal key "STARTUP")
5170 (let ((startup (assq 'startup alist)))
5171 (if startup
5172 (setcdr startup
5173 (append (cdr startup) (org-split-string value)))
5174 (push (cons 'startup (org-split-string value)) alist))))
5175 ((equal key "TAGS")
5176 (let ((tag-cell (assq 'tags alist)))
5177 (if tag-cell
5178 (setcdr tag-cell
5179 (append (cdr tag-cell)
5180 '("\\n")
5181 (org-split-string value)))
5182 (push (cons 'tags (org-split-string value)) alist))))
5183 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5184 (let ((todo (assq 'todo alist))
5185 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5186 (org-split-string value))))
5187 (if todo (push value (cdr todo))
5188 (push (list 'todo value) alist))))
5189 ((equal key "SETUPFILE")
5190 (unless buffer-read-only ; Do not check in Gnus messages.
5191 (let ((f (and (org-string-nw-p value)
5192 (expand-file-name
5193 (org-remove-double-quotes value)))))
5194 (when (and f (file-readable-p f) (not (member f files)))
5195 (with-temp-buffer
5196 (insert-file-contents f)
5197 (setq alist
5198 ;; Fake Org mode to benefit from cache
5199 ;; without recurring needlessly.
5200 (let ((major-mode 'org-mode))
5201 (org--setup-collect-keywords
5202 regexp (cons f files) alist)))))))))))))))
5203 alist)
5205 (defun org--setup-process-tags (tags filetags)
5206 "Precompute variables used for tags.
5207 TAGS is a list of tags and tag group symbols, as strings.
5208 FILETAGS is a list of tags, as strings."
5209 ;; Process the file tags.
5210 (org-set-local 'org-file-tags
5211 (mapcar #'org-add-prop-inherited filetags))
5212 ;; Provide default tags if no local tags are found.
5213 (when (and (not tags) org-tag-alist)
5214 (setq tags
5215 (mapcar (lambda (tag)
5216 (case (car tag)
5217 (:startgroup "{")
5218 (:endgroup "}")
5219 (:grouptags ":")
5220 (:newline "\\n")
5221 (otherwise (concat (car tag)
5222 (and (characterp (cdr tag))
5223 (format "(%c)" (cdr tag)))))))
5224 org-tag-alist)))
5225 ;; Process the tags.
5226 (org-set-local 'org-tag-groups-alist nil)
5227 (org-set-local 'org-tag-alist nil)
5228 (let (group-flag)
5229 (while tags
5230 (let ((e (car tags)))
5231 (setq tags (cdr tags))
5232 (cond
5233 ((equal e "{")
5234 (push '(:startgroup) org-tag-alist)
5235 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5236 ((equal e "}")
5237 (push '(:endgroup) org-tag-alist)
5238 (setq group-flag nil))
5239 ((equal e ":")
5240 (push '(:grouptags) org-tag-alist)
5241 (setq group-flag 'append))
5242 ((equal e "\\n") (push '(:newline) org-tag-alist))
5243 ((string-match
5244 (org-re "\\`\\([[:alnum:]_@#%]+\\)\\(?:(\\(.\\))\\)?\\'") e)
5245 (let ((tag (match-string 1 e))
5246 (key (and (match-beginning 2)
5247 (string-to-char (match-string 2 e)))))
5248 (cond ((eq group-flag 'append)
5249 (setcar org-tag-groups-alist
5250 (append (car org-tag-groups-alist) (list tag))))
5251 (group-flag (push (list tag) org-tag-groups-alist)))
5252 (unless (assoc tag org-tag-alist)
5253 (push (cons tag key) org-tag-alist))))))))
5254 (setq org-tag-alist (nreverse org-tag-alist)))
5256 (defun org-file-contents (file &optional noerror)
5257 "Return the contents of FILE, as a string."
5258 (if (and file (file-readable-p file))
5259 (with-temp-buffer
5260 (insert-file-contents file)
5261 (buffer-string))
5262 (funcall (if noerror 'message 'error)
5263 "Cannot read file \"%s\"%s"
5264 file
5265 (let ((from (buffer-file-name (buffer-base-buffer))))
5266 (if from (concat " (referenced in file \"" from "\")") "")))))
5268 (defun org-extract-log-state-settings (x)
5269 "Extract the log state setting from a TODO keyword string.
5270 This will extract info from a string like \"WAIT(w@/!)\"."
5271 (let (kw key log1 log2)
5272 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5273 (setq kw (match-string 1 x)
5274 key (and (match-end 2) (match-string 2 x))
5275 log1 (and (match-end 3) (match-string 3 x))
5276 log2 (and (match-end 4) (match-string 4 x)))
5277 (and (or log1 log2)
5278 (list kw
5279 (and log1 (if (equal log1 "!") 'time 'note))
5280 (and log2 (if (equal log2 "!") 'time 'note)))))))
5282 (defun org-remove-keyword-keys (list)
5283 "Remove a pair of parenthesis at the end of each string in LIST."
5284 (mapcar (lambda (x)
5285 (if (string-match "(.*)$" x)
5286 (substring x 0 (match-beginning 0))
5288 list))
5290 (defun org-assign-fast-keys (alist)
5291 "Assign fast keys to a keyword-key alist.
5292 Respect keys that are already there."
5293 (let (new e (alt ?0))
5294 (while (setq e (pop alist))
5295 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5296 (cdr e)) ;; Key already assigned.
5297 (push e new)
5298 (let ((clist (string-to-list (downcase (car e))))
5299 (used (append new alist)))
5300 (when (= (car clist) ?@)
5301 (pop clist))
5302 (while (and clist (rassoc (car clist) used))
5303 (pop clist))
5304 (unless clist
5305 (while (rassoc alt used)
5306 (incf alt)))
5307 (push (cons (car e) (or (car clist) alt)) new))))
5308 (nreverse new)))
5310 ;;; Some variables used in various places
5312 (defvar org-window-configuration nil
5313 "Used in various places to store a window configuration.")
5314 (defvar org-selected-window nil
5315 "Used in various places to store a window configuration.")
5316 (defvar org-finish-function nil
5317 "Function to be called when `C-c C-c' is used.
5318 This is for getting out of special buffers like capture.")
5321 ;; FIXME: Occasionally check by commenting these, to make sure
5322 ;; no other functions uses these, forgetting to let-bind them.
5323 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5324 (defvar org-last-state)
5325 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5327 ;; Defined somewhere in this file, but used before definition.
5328 (defvar org-entities) ;; defined in org-entities.el
5329 (defvar org-struct-menu)
5330 (defvar org-org-menu)
5331 (defvar org-tbl-menu)
5333 ;;;; Define the Org-mode
5335 ;; We use a before-change function to check if a table might need
5336 ;; an update.
5337 (defvar org-table-may-need-update t
5338 "Indicates that a table might need an update.
5339 This variable is set by `org-before-change-function'.
5340 `org-table-align' sets it back to nil.")
5341 (defun org-before-change-function (beg end)
5342 "Every change indicates that a table might need an update."
5343 (setq org-table-may-need-update t))
5344 (defvar org-mode-map)
5345 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5346 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5347 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5348 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5349 (defvar org-table-buffer-is-an nil)
5351 (defvar bidi-paragraph-direction)
5352 (defvar buffer-face-mode-face)
5354 (require 'outline)
5355 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5356 (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"))
5357 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5359 ;; Other stuff we need.
5360 (require 'time-date)
5361 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5362 (require 'easymenu)
5363 (require 'overlay)
5365 ;; (require 'org-macs) moved higher up in the file before it is first used
5366 (require 'org-entities)
5367 ;; (require 'org-compat) moved higher up in the file before it is first used
5368 (require 'org-faces)
5369 (require 'org-list)
5370 (require 'org-pcomplete)
5371 (require 'org-src)
5372 (require 'org-footnote)
5373 (require 'org-macro)
5375 ;; babel
5376 (require 'ob)
5378 ;;;###autoload
5379 (define-derived-mode org-mode outline-mode "Org"
5380 "Outline-based notes management and organizer, alias
5381 \"Carsten's outline-mode for keeping track of everything.\"
5383 Org-mode develops organizational tasks around a NOTES file which
5384 contains information about projects as plain text. Org-mode is
5385 implemented on top of outline-mode, which is ideal to keep the content
5386 of large files well structured. It supports ToDo items, deadlines and
5387 time stamps, which magically appear in the diary listing of the Emacs
5388 calendar. Tables are easily created with a built-in table editor.
5389 Plain text URL-like links connect to websites, emails (VM), Usenet
5390 messages (Gnus), BBDB entries, and any files related to the project.
5391 For printing and sharing of notes, an Org-mode file (or a part of it)
5392 can be exported as a structured ASCII or HTML file.
5394 The following commands are available:
5396 \\{org-mode-map}"
5398 ;; Get rid of Outline menus, they are not needed
5399 ;; Need to do this here because define-derived-mode sets up
5400 ;; the keymap so late. Still, it is a waste to call this each time
5401 ;; we switch another buffer into org-mode.
5402 (if (featurep 'xemacs)
5403 (when (boundp 'outline-mode-menu-heading)
5404 ;; Assume this is Greg's port, it uses easymenu
5405 (easy-menu-remove outline-mode-menu-heading)
5406 (easy-menu-remove outline-mode-menu-show)
5407 (easy-menu-remove outline-mode-menu-hide))
5408 (define-key org-mode-map [menu-bar headings] 'undefined)
5409 (define-key org-mode-map [menu-bar hide] 'undefined)
5410 (define-key org-mode-map [menu-bar show] 'undefined))
5412 (org-load-modules-maybe)
5413 (easy-menu-add org-org-menu)
5414 (easy-menu-add org-tbl-menu)
5415 (org-install-agenda-files-menu)
5416 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5417 (add-to-invisibility-spec '(org-cwidth))
5418 (add-to-invisibility-spec '(org-hide-block . t))
5419 (when (featurep 'xemacs)
5420 (org-set-local 'line-move-ignore-invisible t))
5421 (org-set-local 'outline-regexp org-outline-regexp)
5422 (org-set-local 'outline-level 'org-outline-level)
5423 (setq bidi-paragraph-direction 'left-to-right)
5424 (when (and org-ellipsis
5425 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5426 (fboundp 'make-glyph-code))
5427 (unless org-display-table
5428 (setq org-display-table (make-display-table)))
5429 (set-display-table-slot
5430 org-display-table 4
5431 (vconcat (mapcar
5432 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5433 org-ellipsis)))
5434 (if (stringp org-ellipsis) org-ellipsis "..."))))
5435 (setq buffer-display-table org-display-table))
5436 (org-set-regexps-and-options)
5437 (org-set-font-lock-defaults)
5438 (when (and org-tag-faces (not org-tags-special-faces-re))
5439 ;; tag faces set outside customize.... force initialization.
5440 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5441 ;; Calc embedded
5442 (org-set-local 'calc-embedded-open-mode "# ")
5443 ;; Modify a few syntax entries
5444 (modify-syntax-entry ?@ "w")
5445 (modify-syntax-entry ?\" "\"")
5446 (modify-syntax-entry ?\\ "_")
5447 (modify-syntax-entry ?~ "_")
5448 (if org-startup-truncated (setq truncate-lines t))
5449 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5450 (org-set-local 'font-lock-unfontify-region-function
5451 'org-unfontify-region)
5452 ;; Activate before-change-function
5453 (org-set-local 'org-table-may-need-update t)
5454 (org-add-hook 'before-change-functions 'org-before-change-function nil
5455 'local)
5456 ;; Check for running clock before killing a buffer
5457 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5458 ;; Initialize macros templates.
5459 (org-macro-initialize-templates)
5460 ;; Initialize radio targets.
5461 (org-update-radio-target-regexp)
5462 ;; Indentation.
5463 (org-set-local 'indent-line-function 'org-indent-line)
5464 (org-set-local 'indent-region-function 'org-indent-region)
5465 ;; Filling and auto-filling.
5466 (org-setup-filling)
5467 ;; Comments.
5468 (org-setup-comments-handling)
5469 ;; Initialize cache.
5470 (org-element-cache-reset)
5471 ;; Beginning/end of defun
5472 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5473 (org-set-local 'end-of-defun-function
5474 (lambda ()
5475 (if (not (org-at-heading-p))
5476 (org-forward-element)
5477 (org-forward-element)
5478 (forward-char -1))))
5479 ;; Next error for sparse trees
5480 (org-set-local 'next-error-function 'org-occur-next-match)
5481 ;; Make sure dependence stuff works reliably, even for users who set it
5482 ;; too late :-(
5483 (if org-enforce-todo-dependencies
5484 (add-hook 'org-blocker-hook
5485 'org-block-todo-from-children-or-siblings-or-parent)
5486 (remove-hook 'org-blocker-hook
5487 'org-block-todo-from-children-or-siblings-or-parent))
5488 (if org-enforce-todo-checkbox-dependencies
5489 (add-hook 'org-blocker-hook
5490 'org-block-todo-from-checkboxes)
5491 (remove-hook 'org-blocker-hook
5492 'org-block-todo-from-checkboxes))
5494 ;; Align options lines
5495 (org-set-local
5496 'align-mode-rules-list
5497 '((org-in-buffer-settings
5498 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5499 (modes . '(org-mode)))))
5501 ;; Imenu
5502 (org-set-local 'imenu-create-index-function
5503 'org-imenu-get-tree)
5505 ;; Make isearch reveal context
5506 (if (or (featurep 'xemacs)
5507 (not (boundp 'outline-isearch-open-invisible-function)))
5508 ;; Emacs 21 and XEmacs make use of the hook
5509 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5510 ;; Emacs 22 deals with this through a special variable
5511 (org-set-local 'outline-isearch-open-invisible-function
5512 (lambda (&rest ignore) (org-show-context 'isearch))))
5514 ;; Setup the pcomplete hooks
5515 (set (make-local-variable 'pcomplete-command-completion-function)
5516 'org-pcomplete-initial)
5517 (set (make-local-variable 'pcomplete-command-name-function)
5518 'org-command-at-point)
5519 (set (make-local-variable 'pcomplete-default-completion-function)
5520 'ignore)
5521 (set (make-local-variable 'pcomplete-parse-arguments-function)
5522 'org-parse-arguments)
5523 (set (make-local-variable 'pcomplete-termination-string) "")
5524 (when (>= emacs-major-version 23)
5525 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5527 ;; If empty file that did not turn on org-mode automatically, make it to.
5528 (if (and org-insert-mode-line-in-empty-file
5529 (org-called-interactively-p 'any)
5530 (= (point-min) (point-max)))
5531 (insert "# -*- mode: org -*-\n\n"))
5532 (unless org-inhibit-startup
5533 (org-unmodified
5534 (and org-startup-with-beamer-mode (org-beamer-mode))
5535 (when org-startup-align-all-tables
5536 (org-table-map-tables 'org-table-align 'quietly))
5537 (when org-startup-with-inline-images
5538 (org-display-inline-images))
5539 (when org-startup-with-latex-preview
5540 (org-toggle-latex-fragment))
5541 (unless org-inhibit-startup-visibility-stuff
5542 (org-set-startup-visibility))
5543 (org-refresh-effort-properties)))
5544 ;; Try to set org-hide correctly
5545 (let ((foreground (org-find-invisible-foreground)))
5546 (if foreground
5547 (set-face-foreground 'org-hide foreground))))
5549 ;; Update `customize-package-emacs-version-alist'
5550 (add-to-list 'customize-package-emacs-version-alist
5551 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5552 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5553 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5555 (defvar org-mode-transpose-word-syntax-table
5556 (let ((st (make-syntax-table text-mode-syntax-table)))
5557 (mapc (lambda(c) (modify-syntax-entry
5558 (string-to-char (car c)) "w p" st))
5559 org-emphasis-alist)
5560 st))
5562 (when (fboundp 'abbrev-table-put)
5563 (abbrev-table-put org-mode-abbrev-table
5564 :parents (list text-mode-abbrev-table)))
5566 (defun org-find-invisible-foreground ()
5567 (let ((candidates (remove
5568 "unspecified-bg"
5569 (nconc
5570 (list (face-background 'default)
5571 (face-background 'org-default))
5572 (mapcar
5573 (lambda (alist)
5574 (when (boundp alist)
5575 (cdr (assoc 'background-color (symbol-value alist)))))
5576 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5577 (list (face-foreground 'org-hide))))))
5578 (car (remove nil candidates))))
5580 (defun org-current-time (&optional rounding-minutes past)
5581 "Current time, possibly rounded to ROUNDING-MINUTES.
5582 When ROUNDING-MINUTES is not an integer, fall back on the car of
5583 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5584 the rounding returns a past time."
5585 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5586 (car org-time-stamp-rounding-minutes)))
5587 (time (decode-time)) res)
5588 (if (< r 1)
5589 (current-time)
5590 (setq res
5591 (apply 'encode-time
5592 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5593 (nthcdr 2 time))))
5594 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5595 (seconds-to-time (- (org-float-time res) (* r 60)))
5596 res))))
5598 (defun org-today ()
5599 "Return today date, considering `org-extend-today-until'."
5600 (time-to-days
5601 (time-subtract (current-time)
5602 (list 0 (* 3600 org-extend-today-until) 0))))
5604 ;;;; Font-Lock stuff, including the activators
5606 (defvar org-mouse-map (make-sparse-keymap))
5607 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5608 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5609 (when org-mouse-1-follows-link
5610 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5611 (when org-tab-follows-link
5612 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5613 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5615 (require 'font-lock)
5617 (defconst org-non-link-chars "]\t\n\r<>")
5618 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5619 "file+sys" "news" "shell" "elisp" "doi" "message"
5620 "help"))
5621 (defvar org-link-types-re nil
5622 "Matches a link that has a url-like prefix like \"http:\"")
5623 (defvar org-link-re-with-space nil
5624 "Matches a link with spaces, optional angular brackets around it.")
5625 (defvar org-link-re-with-space2 nil
5626 "Matches a link with spaces, optional angular brackets around it.")
5627 (defvar org-link-re-with-space3 nil
5628 "Matches a link with spaces, only for internal part in bracket links.")
5629 (defvar org-angle-link-re nil
5630 "Matches link with angular brackets, spaces are allowed.")
5631 (defvar org-plain-link-re nil
5632 "Matches plain link, without spaces.")
5633 (defvar org-bracket-link-regexp nil
5634 "Matches a link in double brackets.")
5635 (defvar org-bracket-link-analytic-regexp nil
5636 "Regular expression used to analyze links.
5637 Here is what the match groups contain after a match:
5638 1: http:
5639 2: http
5640 3: path
5641 4: [desc]
5642 5: desc")
5643 (defvar org-bracket-link-analytic-regexp++ nil
5644 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5645 (defvar org-any-link-re nil
5646 "Regular expression matching any link.")
5648 (defconst org-match-sexp-depth 3
5649 "Number of stacked braces for sub/superscript matching.")
5651 (defun org-create-multibrace-regexp (left right n)
5652 "Create a regular expression which will match a balanced sexp.
5653 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5654 as single character strings.
5655 The regexp returned will match the entire expression including the
5656 delimiters. It will also define a single group which contains the
5657 match except for the outermost delimiters. The maximum depth of
5658 stacked delimiters is N. Escaping delimiters is not possible."
5659 (let* ((nothing (concat "[^" left right "]*?"))
5660 (or "\\|")
5661 (re nothing)
5662 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5663 (while (> n 1)
5664 (setq n (1- n)
5665 re (concat re or next)
5666 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5667 (concat left "\\(" re "\\)" right)))
5669 (defconst org-match-substring-regexp
5670 (concat
5671 "\\(\\S-\\)\\([_^]\\)\\("
5672 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5673 "\\|"
5674 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5675 "\\|"
5676 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5677 "The regular expression matching a sub- or superscript.")
5679 (defconst org-match-substring-with-braces-regexp
5680 (concat
5681 "\\(\\S-\\)\\([_^]\\)"
5682 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5683 "The regular expression matching a sub- or superscript, forcing braces.")
5685 (defun org-make-link-regexps ()
5686 "Update the link regular expressions.
5687 This should be called after the variable `org-link-types' has changed."
5688 (let ((types-re (regexp-opt org-link-types t)))
5689 (setq org-link-types-re
5690 (concat "\\`" types-re ":")
5691 org-link-re-with-space
5692 (concat "<?" types-re ":"
5693 "\\([^" org-non-link-chars " ]"
5694 "[^" org-non-link-chars "]*"
5695 "[^" org-non-link-chars " ]\\)>?")
5696 org-link-re-with-space2
5697 (concat "<?" types-re ":"
5698 "\\([^" org-non-link-chars " ]"
5699 "[^\t\n\r]*"
5700 "[^" org-non-link-chars " ]\\)>?")
5701 org-link-re-with-space3
5702 (concat "<?" types-re ":"
5703 "\\([^" org-non-link-chars " ]"
5704 "[^\t\n\r]*\\)")
5705 org-angle-link-re
5706 (concat "<" types-re ":"
5707 "\\([^" org-non-link-chars " ]"
5708 "[^" org-non-link-chars "]*"
5709 "\\)>")
5710 org-plain-link-re
5711 (concat
5712 "\\<" types-re ":"
5713 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5714 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5715 org-bracket-link-regexp
5716 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5717 org-bracket-link-analytic-regexp
5718 (concat
5719 "\\[\\["
5720 "\\(" types-re ":\\)?"
5721 "\\([^]]+\\)"
5722 "\\]"
5723 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5724 "\\]")
5725 org-bracket-link-analytic-regexp++
5726 (concat
5727 "\\[\\["
5728 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5729 "\\([^]]+\\)"
5730 "\\]"
5731 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5732 "\\]")
5733 org-any-link-re
5734 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5735 org-angle-link-re "\\)\\|\\("
5736 org-plain-link-re "\\)"))))
5738 (org-make-link-regexps)
5740 (defvar org-emph-face nil)
5742 (defun org-do-emphasis-faces (limit)
5743 "Run through the buffer and emphasize strings."
5744 (let (rtn a)
5745 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5746 (let* ((border (char-after (match-beginning 3)))
5747 (bre (regexp-quote (char-to-string border))))
5748 (if (and (not (= border (char-after (match-beginning 4))))
5749 (not (save-match-data
5750 (string-match (concat bre ".*" bre)
5751 (replace-regexp-in-string
5752 "\n" " "
5753 (substring (match-string 2) 1 -1))))))
5754 (progn
5755 (setq rtn t)
5756 (setq a (assoc (match-string 3) org-emphasis-alist))
5757 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5758 'face
5759 (nth 1 a))
5760 (and (nth 2 a)
5761 (org-remove-flyspell-overlays-in
5762 (match-beginning 0) (match-end 0)))
5763 (add-text-properties (match-beginning 2) (match-end 2)
5764 '(font-lock-multiline t org-emphasis t))
5765 (when org-hide-emphasis-markers
5766 (add-text-properties (match-end 4) (match-beginning 5)
5767 '(invisible org-link))
5768 (add-text-properties (match-beginning 3) (match-end 3)
5769 '(invisible org-link))))))
5770 (goto-char (1+ (match-beginning 0))))
5771 rtn))
5773 (defun org-emphasize (&optional char)
5774 "Insert or change an emphasis, i.e. a font like bold or italic.
5775 If there is an active region, change that region to a new emphasis.
5776 If there is no region, just insert the marker characters and position
5777 the cursor between them.
5778 CHAR should be the marker character. If it is a space, it means to
5779 remove the emphasis of the selected region.
5780 If CHAR is not given (for example in an interactive call) it will be
5781 prompted for."
5782 (interactive)
5783 (let ((erc org-emphasis-regexp-components)
5784 (prompt "")
5785 (string "") beg end move c s)
5786 (if (org-region-active-p)
5787 (setq beg (region-beginning) end (region-end)
5788 string (buffer-substring beg end))
5789 (setq move t))
5791 (unless char
5792 (message "Emphasis marker or tag: [%s]"
5793 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5794 (setq char (read-char-exclusive)))
5795 (if (equal char ?\ )
5796 (setq s "" move nil)
5797 (unless (assoc (char-to-string char) org-emphasis-alist)
5798 (user-error "No such emphasis marker: \"%c\"" char))
5799 (setq s (char-to-string char)))
5800 (while (and (> (length string) 1)
5801 (equal (substring string 0 1) (substring string -1))
5802 (assoc (substring string 0 1) org-emphasis-alist))
5803 (setq string (substring string 1 -1)))
5804 (setq string (concat s string s))
5805 (if beg (delete-region beg end))
5806 (unless (or (bolp)
5807 (string-match (concat "[" (nth 0 erc) "\n]")
5808 (char-to-string (char-before (point)))))
5809 (insert " "))
5810 (unless (or (eobp)
5811 (string-match (concat "[" (nth 1 erc) "\n]")
5812 (char-to-string (char-after (point)))))
5813 (insert " ") (backward-char 1))
5814 (insert string)
5815 (and move (backward-char 1))))
5817 (defconst org-nonsticky-props
5818 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5820 (defsubst org-rear-nonsticky-at (pos)
5821 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5823 (defun org-activate-plain-links (limit)
5824 "Add link properties for plain links."
5825 (let (f hl)
5826 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5827 (not (member 'org-tag
5828 (get-text-property (1- (match-beginning 0)) 'face)))
5829 (not (org-in-src-block-p)))
5830 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5831 (setq f (get-text-property (match-beginning 0) 'face))
5832 (setq hl (org-match-string-no-properties 0))
5833 (if (or (eq f 'org-tag)
5834 (and (listp f) (memq 'org-tag f)))
5836 (add-text-properties (match-beginning 0) (match-end 0)
5837 (list 'mouse-face 'highlight
5838 'face 'org-link
5839 'htmlize-link `(:uri ,hl)
5840 'keymap org-mouse-map))
5841 (org-rear-nonsticky-at (match-end 0)))
5842 t)))
5844 (defun org-activate-code (limit)
5845 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5846 (progn
5847 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5848 (remove-text-properties (match-beginning 0) (match-end 0)
5849 '(display t invisible t intangible t))
5850 t)))
5852 (defcustom org-src-fontify-natively t
5853 "When non-nil, fontify code in code blocks."
5854 :type 'boolean
5855 :version "24.4"
5856 :package-version '(Org . "8.3")
5857 :group 'org-appearance
5858 :group 'org-babel)
5860 (defcustom org-allow-promoting-top-level-subtree nil
5861 "When non-nil, allow promoting a top level subtree.
5862 The leading star of the top level headline will be replaced
5863 by a #."
5864 :type 'boolean
5865 :version "24.1"
5866 :group 'org-appearance)
5868 (defun org-fontify-meta-lines-and-blocks (limit)
5869 (condition-case nil
5870 (org-fontify-meta-lines-and-blocks-1 limit)
5871 (error (message "org-mode fontification error"))))
5873 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5874 "Fontify #+ lines and blocks."
5875 (let ((case-fold-search t))
5876 (if (re-search-forward
5877 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5878 limit t)
5879 (let ((beg (match-beginning 0))
5880 (block-start (match-end 0))
5881 (block-end nil)
5882 (lang (match-string 7))
5883 (beg1 (line-beginning-position 2))
5884 (dc1 (downcase (match-string 2)))
5885 (dc3 (downcase (match-string 3)))
5886 end end1 quoting block-type ovl)
5887 (cond
5888 ((and (match-end 4) (equal dc3 "+begin"))
5889 ;; Truly a block
5890 (setq block-type (downcase (match-string 5))
5891 quoting (member block-type org-protecting-blocks))
5892 (when (re-search-forward
5893 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5894 nil t) ;; on purpose, we look further than LIMIT
5895 (setq end (min (point-max) (match-end 0))
5896 end1 (min (point-max) (1- (match-beginning 0))))
5897 (setq block-end (match-beginning 0))
5898 (when quoting
5899 (org-remove-flyspell-overlays-in beg1 end1)
5900 (remove-text-properties beg end
5901 '(display t invisible t intangible t)))
5902 (add-text-properties
5903 beg end '(font-lock-fontified t font-lock-multiline t))
5904 (add-text-properties beg beg1 '(face org-meta-line))
5905 (org-remove-flyspell-overlays-in beg beg1)
5906 (add-text-properties ; For end_src
5907 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5908 (org-remove-flyspell-overlays-in end1 end)
5909 (cond
5910 ((and lang (not (string= lang "")) org-src-fontify-natively)
5911 (org-src-font-lock-fontify-block lang block-start block-end)
5912 (add-text-properties beg1 block-end '(src-block t)))
5913 (quoting
5914 (add-text-properties beg1 (min (point-max) (1+ end1))
5915 '(face org-block))) ; end of source block
5916 ((not org-fontify-quote-and-verse-blocks))
5917 ((string= block-type "quote")
5918 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5919 ((string= block-type "verse")
5920 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5921 (add-text-properties beg beg1 '(face org-block-begin-line))
5922 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5923 '(face org-block-end-line))
5925 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5926 (org-remove-flyspell-overlays-in
5927 (match-beginning 0)
5928 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5929 (add-text-properties
5930 beg (match-end 3)
5931 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5932 '(font-lock-fontified t invisible t)
5933 '(font-lock-fontified t face org-document-info-keyword)))
5934 (add-text-properties
5935 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5936 (if (string-equal dc1 "+title:")
5937 '(font-lock-fontified t face org-document-title)
5938 '(font-lock-fontified t face org-document-info))))
5939 ((equal dc1 "+caption:")
5940 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5941 (remove-text-properties (match-beginning 0) (match-end 0)
5942 '(display t invisible t intangible t))
5943 (add-text-properties (match-beginning 1) (match-end 3)
5944 '(font-lock-fontified t face org-meta-line))
5945 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5946 '(font-lock-fontified t face org-block))
5948 ((member dc3 '(" " ""))
5949 (org-remove-flyspell-overlays-in beg (match-end 0))
5950 (add-text-properties
5951 beg (match-end 0)
5952 '(font-lock-fontified t face font-lock-comment-face)))
5953 (t ;; just any other in-buffer setting, but not indented
5954 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5955 (remove-text-properties (match-beginning 0) (match-end 0)
5956 '(display t invisible t intangible t))
5957 (add-text-properties beg (match-end 0)
5958 '(font-lock-fontified t face org-meta-line))
5959 t))))))
5961 (defun org-fontify-drawers (limit)
5962 "Fontify drawers."
5963 (when (re-search-forward org-drawer-regexp limit t)
5964 (add-text-properties
5965 (match-beginning 0) (match-end 0)
5966 '(font-lock-fontified t face org-special-keyword))
5967 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5970 (defun org-fontify-macros (limit)
5971 "Fontify macros."
5972 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5973 (add-text-properties
5974 (match-beginning 0) (match-end 0)
5975 '(font-lock-fontified t face org-macro))
5976 (when org-hide-macro-markers
5977 (add-text-properties (match-end 2) (match-beginning 2)
5978 '(invisible t))
5979 (add-text-properties (match-beginning 1) (match-end 1)
5980 '(invisible t)))
5981 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5984 (defun org-activate-angle-links (limit)
5985 "Add text properties for angle links."
5986 (if (and (re-search-forward org-angle-link-re limit t)
5987 (not (org-in-src-block-p)))
5988 (progn
5989 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5990 (add-text-properties (match-beginning 0) (match-end 0)
5991 (list 'mouse-face 'highlight
5992 'keymap org-mouse-map))
5993 (org-rear-nonsticky-at (match-end 0))
5994 t)))
5996 (defun org-activate-footnote-links (limit)
5997 "Add text properties for footnotes."
5998 (let ((fn (org-footnote-next-reference-or-definition limit)))
5999 (when fn
6000 (let* ((beg (nth 1 fn))
6001 (end (nth 2 fn))
6002 (label (car fn))
6003 (referencep (/= (line-beginning-position) beg)))
6004 (when (and referencep (nth 3 fn))
6005 (save-excursion
6006 (goto-char beg)
6007 (search-forward (or label "fn:"))
6008 (org-remove-flyspell-overlays-in beg (match-end 0))))
6009 (add-text-properties beg end
6010 (list 'mouse-face 'highlight
6011 'keymap org-mouse-map
6012 'help-echo
6013 (if referencep "Footnote reference"
6014 "Footnote definition")
6015 'font-lock-fontified t
6016 'font-lock-multiline t
6017 'face 'org-footnote))))))
6019 (defun org-activate-bracket-links (limit)
6020 "Add text properties for bracketed links."
6021 (if (and (re-search-forward org-bracket-link-regexp limit t)
6022 (not (org-in-src-block-p)))
6023 (let* ((hl (org-match-string-no-properties 1))
6024 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6025 (ip (org-maybe-intangible
6026 (list 'invisible 'org-link
6027 'keymap org-mouse-map 'mouse-face 'highlight
6028 'font-lock-multiline t 'help-echo help
6029 'htmlize-link `(:uri ,hl))))
6030 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6031 'font-lock-multiline t 'help-echo help
6032 'htmlize-link `(:uri ,hl))))
6033 ;; We need to remove the invisible property here. Table narrowing
6034 ;; may have made some of this invisible.
6035 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6036 (remove-text-properties (match-beginning 0) (match-end 0)
6037 '(invisible nil))
6038 (if (match-end 3)
6039 (progn
6040 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6041 (org-rear-nonsticky-at (match-beginning 3))
6042 (add-text-properties (match-beginning 3) (match-end 3) vp)
6043 (org-rear-nonsticky-at (match-end 3))
6044 (add-text-properties (match-end 3) (match-end 0) ip)
6045 (org-rear-nonsticky-at (match-end 0)))
6046 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6047 (org-rear-nonsticky-at (match-beginning 1))
6048 (add-text-properties (match-beginning 1) (match-end 1) vp)
6049 (org-rear-nonsticky-at (match-end 1))
6050 (add-text-properties (match-end 1) (match-end 0) ip)
6051 (org-rear-nonsticky-at (match-end 0)))
6052 t)))
6054 (defun org-activate-dates (limit)
6055 "Add text properties for dates."
6056 (if (and (re-search-forward org-tsr-regexp-both limit t)
6057 (not (equal (char-before (match-beginning 0)) 91)))
6058 (progn
6059 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6060 (add-text-properties (match-beginning 0) (match-end 0)
6061 (list 'mouse-face 'highlight
6062 'keymap org-mouse-map))
6063 (org-rear-nonsticky-at (match-end 0))
6064 (when org-display-custom-times
6065 (if (match-end 3)
6066 (org-display-custom-time (match-beginning 3) (match-end 3)))
6067 (org-display-custom-time (match-beginning 1) (match-end 1)))
6068 t)))
6070 (defvar org-target-link-regexp nil
6071 "Regular expression matching radio targets in plain text.")
6072 (make-variable-buffer-local 'org-target-link-regexp)
6074 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6075 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6076 border border border))
6077 "Regular expression matching a link target.")
6079 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6080 "Regular expression matching a radio target.")
6082 (defconst org-any-target-regexp
6083 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6084 "Regular expression matching any target.")
6086 (defun org-activate-target-links (limit)
6087 "Add text properties for target matches."
6088 (when org-target-link-regexp
6089 (let ((case-fold-search t))
6090 (if (re-search-forward org-target-link-regexp limit t)
6091 (progn
6092 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6093 (add-text-properties (match-beginning 1) (match-end 1)
6094 (list 'mouse-face 'highlight
6095 'keymap org-mouse-map
6096 'help-echo "Radio target link"
6097 'org-linked-text t))
6098 (org-rear-nonsticky-at (match-end 1))
6099 t)))))
6101 (defun org-update-radio-target-regexp ()
6102 "Find all radio targets in this file and update the regular expression.
6103 Also refresh fontification if needed."
6104 (interactive)
6105 (let ((old-regexp org-target-link-regexp)
6106 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6107 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6108 (targets
6109 (org-with-wide-buffer
6110 (goto-char (point-min))
6111 (let (rtn)
6112 (while (re-search-forward org-radio-target-regexp nil t)
6113 ;; Make sure point is really within the object.
6114 (backward-char)
6115 (let ((obj (org-element-context)))
6116 (when (eq (org-element-type obj) 'radio-target)
6117 (add-to-list 'rtn (org-element-property :value obj)))))
6118 rtn))))
6119 (setq org-target-link-regexp
6120 (and targets
6121 (concat before-re
6122 (mapconcat
6123 (lambda (x)
6124 (replace-regexp-in-string
6125 " +" "\\s-+" (regexp-quote x) t t))
6126 targets
6127 "\\|")
6128 after-re)))
6129 (unless (equal old-regexp org-target-link-regexp)
6130 ;; Clean-up cache.
6131 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6132 ((not org-target-link-regexp) old-regexp)
6134 (concat before-re
6135 (mapconcat
6136 (lambda (re)
6137 (substring re (length before-re)
6138 (- (length after-re))))
6139 (list old-regexp org-target-link-regexp)
6140 "\\|")
6141 after-re)))))
6142 (org-with-wide-buffer
6143 (goto-char (point-min))
6144 (while (re-search-forward regexp nil t)
6145 (org-element-cache-refresh (match-beginning 1)))))
6146 ;; Re fontify buffer.
6147 (when (memq 'radio org-highlight-links)
6148 (org-restart-font-lock)))))
6150 (defun org-hide-wide-columns (limit)
6151 (let (s e)
6152 (setq s (text-property-any (point) (or limit (point-max))
6153 'org-cwidth t))
6154 (when s
6155 (setq e (next-single-property-change s 'org-cwidth))
6156 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6157 (goto-char e)
6158 t)))
6160 (defvar org-latex-and-related-regexp nil
6161 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6163 (defun org-compute-latex-and-related-regexp ()
6164 "Compute regular expression for LaTeX, entities and sub/superscript.
6165 Result depends on variable `org-highlight-latex-and-related'."
6166 (org-set-local
6167 'org-latex-and-related-regexp
6168 (let* ((re-sub
6169 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6170 ((eq org-use-sub-superscripts '{})
6171 (list org-match-substring-with-braces-regexp))
6172 (org-use-sub-superscripts (list org-match-substring-regexp))))
6173 (re-latex
6174 (when (memq 'latex org-highlight-latex-and-related)
6175 (let ((matchers (plist-get org-format-latex-options :matchers)))
6176 (delq nil
6177 (mapcar (lambda (x)
6178 (and (member (car x) matchers) (nth 1 x)))
6179 org-latex-regexps)))))
6180 (re-entities
6181 (when (memq 'entities org-highlight-latex-and-related)
6182 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6183 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6185 (defun org-do-latex-and-related (limit)
6186 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6187 LIMIT bounds the search for syntax to highlight. Stop at first
6188 highlighted object, if any. Return t if some highlighting was
6189 done, nil otherwise."
6190 (when (org-string-nw-p org-latex-and-related-regexp)
6191 (catch 'found
6192 (while (re-search-forward org-latex-and-related-regexp limit t)
6193 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6194 'face))
6195 '(org-code org-verbatim underline))
6196 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6197 '(?_ ?^))
6199 0)))
6200 (font-lock-prepend-text-property
6201 (+ offset (match-beginning 0)) (match-end 0)
6202 'face 'org-latex-and-related)
6203 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6204 '(font-lock-multiline t)))
6205 (throw 'found t)))
6206 nil)))
6208 (defun org-restart-font-lock ()
6209 "Restart `font-lock-mode', to force refontification."
6210 (when (and (boundp 'font-lock-mode) font-lock-mode)
6211 (font-lock-mode -1)
6212 (font-lock-mode 1)))
6214 (defun org-activate-tags (limit)
6215 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6216 (progn
6217 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6218 (add-text-properties (match-beginning 1) (match-end 1)
6219 (list 'mouse-face 'highlight
6220 'keymap org-mouse-map))
6221 (org-rear-nonsticky-at (match-end 1))
6222 t)))
6224 (defun org-outline-level ()
6225 "Compute the outline level of the heading at point.
6227 If this is called at a normal headline, the level is the number
6228 of stars. Use `org-reduced-level' to remove the effect of
6229 `org-odd-levels'. Unlike to `org-current-level', this function
6230 takes into consideration inlinetasks."
6231 (org-with-wide-buffer
6232 (end-of-line)
6233 (if (re-search-backward org-outline-regexp-bol nil t)
6234 (1- (- (match-end 0) (match-beginning 0)))
6235 0)))
6237 (defvar org-font-lock-keywords nil)
6239 (defsubst org-re-property (property &optional literal allow-null)
6240 "Return a regexp matching a PROPERTY line.
6242 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6243 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6244 non-nil, match properties even without a value.
6246 Match group 3 is set to the value when it exists. If there is no
6247 value and ALLOW-NULL is non-nil, it is set to the empty string."
6248 (concat
6249 "^\\(?4:[ \t]*\\)"
6250 (format "\\(?1::\\(?2:%s\\):\\)"
6251 (if literal property (regexp-quote property)))
6252 (if allow-null
6253 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$"
6254 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$")))
6256 (defconst org-property-re
6257 (org-re-property "\\S-+" 'literal t)
6258 "Regular expression matching a property line.
6259 There are four matching groups:
6260 1: :PROPKEY: including the leading and trailing colon,
6261 2: PROPKEY without the leading and trailing colon,
6262 3: PROPVAL without leading or trailing spaces,
6263 4: the indentation of the current line,
6264 5: trailing whitespace.")
6266 (defvar org-font-lock-hook nil
6267 "Functions to be called for special font lock stuff.")
6269 (defvar org-font-lock-set-keywords-hook nil
6270 "Functions that can manipulate `org-font-lock-extra-keywords'.
6271 This is called after `org-font-lock-extra-keywords' is defined, but before
6272 it is installed to be used by font lock. This can be useful if something
6273 needs to be inserted at a specific position in the font-lock sequence.")
6275 (defun org-font-lock-hook (limit)
6276 "Run `org-font-lock-hook' within LIMIT."
6277 (run-hook-with-args 'org-font-lock-hook limit))
6279 (defun org-set-font-lock-defaults ()
6280 "Set font lock defaults for the current buffer."
6281 (let* ((em org-fontify-emphasized-text)
6282 (lk org-highlight-links)
6283 (org-font-lock-extra-keywords
6284 (list
6285 ;; Call the hook
6286 '(org-font-lock-hook)
6287 ;; Headlines
6288 `(,(if org-fontify-whole-heading-line
6289 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6290 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6291 (1 (org-get-level-face 1))
6292 (2 (org-get-level-face 2))
6293 (3 (org-get-level-face 3)))
6294 ;; Table lines
6295 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6296 (1 'org-table t))
6297 ;; Table internals
6298 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6299 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6300 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6301 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6302 ;; Drawers
6303 '(org-fontify-drawers)
6304 ;; Properties
6305 (list org-property-re
6306 '(1 'org-special-keyword t)
6307 '(3 'org-property-value t))
6308 ;; Links
6309 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6310 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6311 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6312 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6313 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6314 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6315 (if (memq 'footnote lk) '(org-activate-footnote-links))
6316 ;; Targets.
6317 (list org-any-target-regexp '(0 'org-target t))
6318 ;; Diary sexps.
6319 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6320 ;; Macro
6321 '(org-fontify-macros)
6322 '(org-hide-wide-columns (0 nil append))
6323 ;; TODO keyword
6324 (list (format org-heading-keyword-regexp-format
6325 org-todo-regexp)
6326 '(2 (org-get-todo-face 2) t))
6327 ;; DONE
6328 (if org-fontify-done-headline
6329 (list (format org-heading-keyword-regexp-format
6330 (concat
6331 "\\(?:"
6332 (mapconcat 'regexp-quote org-done-keywords "\\|")
6333 "\\)"))
6334 '(2 'org-headline-done t))
6335 nil)
6336 ;; Priorities
6337 '(org-font-lock-add-priority-faces)
6338 ;; Tags
6339 '(org-font-lock-add-tag-faces)
6340 ;; Tags groups
6341 (if (and org-group-tags org-tag-groups-alist)
6342 (list (concat org-outline-regexp-bol ".+\\(:"
6343 (regexp-opt (mapcar 'car org-tag-groups-alist))
6344 ":\\).*$")
6345 '(1 'org-tag-group prepend)))
6346 ;; Special keywords
6347 (list (concat "\\<" org-comment-string) '(0 'org-special-keyword t))
6348 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6349 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6350 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6351 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6352 ;; Emphasis
6353 (if em
6354 (if (featurep 'xemacs)
6355 '(org-do-emphasis-faces (0 nil append))
6356 '(org-do-emphasis-faces)))
6357 ;; Checkboxes
6358 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6359 1 'org-checkbox prepend)
6360 (if (cdr (assq 'checkbox org-list-automatic-rules))
6361 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6362 (0 (org-get-checkbox-statistics-face) t)))
6363 ;; Description list items
6364 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6365 1 'org-list-dt prepend)
6366 ;; ARCHIVEd headings
6367 (list (concat
6368 org-outline-regexp-bol
6369 "\\(.*:" org-archive-tag ":.*\\)")
6370 '(1 'org-archived prepend))
6371 ;; Specials
6372 '(org-do-latex-and-related)
6373 '(org-fontify-entities)
6374 '(org-raise-scripts)
6375 ;; Code
6376 '(org-activate-code (1 'org-code t))
6377 ;; COMMENT
6378 (list (format
6379 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6380 org-todo-regexp
6381 org-comment-string)
6382 '(9 'org-special-keyword t))
6383 ;; Blocks and meta lines
6384 '(org-fontify-meta-lines-and-blocks))))
6385 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6386 (run-hooks 'org-font-lock-set-keywords-hook)
6387 ;; Now set the full font-lock-keywords
6388 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6389 (org-set-local 'font-lock-defaults
6390 '(org-font-lock-keywords t nil nil backward-paragraph))
6391 (kill-local-variable 'font-lock-keywords) nil))
6393 (defun org-toggle-pretty-entities ()
6394 "Toggle the composition display of entities as UTF8 characters."
6395 (interactive)
6396 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6397 (org-restart-font-lock)
6398 (if org-pretty-entities
6399 (message "Entities are now displayed as UTF8 characters")
6400 (save-restriction
6401 (widen)
6402 (org-decompose-region (point-min) (point-max))
6403 (message "Entities are now displayed as plain text"))))
6405 (defvar org-custom-properties-overlays nil
6406 "List of overlays used for custom properties.")
6407 (make-variable-buffer-local 'org-custom-properties-overlays)
6409 (defun org-toggle-custom-properties-visibility ()
6410 "Display or hide properties in `org-custom-properties'."
6411 (interactive)
6412 (if org-custom-properties-overlays
6413 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6414 (setq org-custom-properties-overlays nil))
6415 (when org-custom-properties
6416 (org-with-wide-buffer
6417 (goto-char (point-min))
6418 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6419 (while (re-search-forward regexp nil t)
6420 (let ((end (cdr (save-match-data (org-get-property-block)))))
6421 (when (and end (< (point) end))
6422 ;; Hide first custom property in current drawer.
6423 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6424 (overlay-put o 'invisible t)
6425 (overlay-put o 'org-custom-property t)
6426 (push o org-custom-properties-overlays))
6427 ;; Hide additional custom properties in the same drawer.
6428 (while (re-search-forward regexp end t)
6429 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6430 (overlay-put o 'invisible t)
6431 (overlay-put o 'org-custom-property t)
6432 (push o org-custom-properties-overlays)))))
6433 ;; Each entry is limited to a single property drawer.
6434 (outline-next-heading)))))))
6436 (defun org-fontify-entities (limit)
6437 "Find an entity to fontify."
6438 (let (ee)
6439 (when org-pretty-entities
6440 (catch 'match
6441 (while (re-search-forward
6442 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6443 limit t)
6444 (if (and (not (org-at-comment-p))
6445 (setq ee (org-entity-get (match-string 1)))
6446 (= (length (nth 6 ee)) 1))
6447 (let*
6448 ((end (if (equal (match-string 2) "{}")
6449 (match-end 2)
6450 (match-end 1))))
6451 (add-text-properties
6452 (match-beginning 0) end
6453 (list 'font-lock-fontified t))
6454 (compose-region (match-beginning 0) end
6455 (nth 6 ee) nil)
6456 (backward-char 1)
6457 (throw 'match t))))
6458 nil))))
6460 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6461 "Fontify string S like in Org-mode."
6462 (with-temp-buffer
6463 (insert s)
6464 (let ((org-odd-levels-only odd-levels))
6465 (org-mode)
6466 (font-lock-ensure)
6467 (buffer-string))))
6469 (defvar org-m nil)
6470 (defvar org-l nil)
6471 (defvar org-f nil)
6472 (defun org-get-level-face (n)
6473 "Get the right face for match N in font-lock matching of headlines."
6474 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6475 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6476 (if org-cycle-level-faces
6477 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6478 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6479 (cond
6480 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6481 ((eq n 2) org-f)
6482 (t (if org-level-color-stars-only nil org-f))))
6485 (defun org-get-todo-face (kwd)
6486 "Get the right face for a TODO keyword KWD.
6487 If KWD is a number, get the corresponding match group."
6488 (if (numberp kwd) (setq kwd (match-string kwd)))
6489 (or (org-face-from-face-or-color
6490 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6491 (and (member kwd org-done-keywords) 'org-done)
6492 'org-todo))
6494 (defun org-face-from-face-or-color (context inherit face-or-color)
6495 "Create a face list that inherits INHERIT, but sets the foreground color.
6496 When FACE-OR-COLOR is not a string, just return it."
6497 (if (stringp face-or-color)
6498 (list :inherit inherit
6499 (cdr (assoc context org-faces-easy-properties))
6500 face-or-color)
6501 face-or-color))
6503 (defun org-font-lock-add-tag-faces (limit)
6504 "Add the special tag faces."
6505 (when (and org-tag-faces org-tags-special-faces-re)
6506 (while (re-search-forward org-tags-special-faces-re limit t)
6507 (add-text-properties (match-beginning 1) (match-end 1)
6508 (list 'face (org-get-tag-face 1)
6509 'font-lock-fontified t))
6510 (backward-char 1))))
6512 (defun org-font-lock-add-priority-faces (limit)
6513 "Add the special priority faces."
6514 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6515 (when (save-match-data (org-at-heading-p))
6516 (add-text-properties
6517 (match-beginning 0) (match-end 0)
6518 (list 'face (or (org-face-from-face-or-color
6519 'priority 'org-priority
6520 (cdr (assoc (char-after (match-beginning 1))
6521 org-priority-faces)))
6522 'org-priority)
6523 'font-lock-fontified t)))))
6525 (defun org-get-tag-face (kwd)
6526 "Get the right face for a TODO keyword KWD.
6527 If KWD is a number, get the corresponding match group."
6528 (if (numberp kwd) (setq kwd (match-string kwd)))
6529 (or (org-face-from-face-or-color
6530 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6531 'org-tag))
6533 (defun org-unfontify-region (beg end &optional maybe_loudly)
6534 "Remove fontification and activation overlays from links."
6535 (font-lock-default-unfontify-region beg end)
6536 (let* ((buffer-undo-list t)
6537 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6538 (inhibit-modification-hooks t)
6539 deactivate-mark buffer-file-name buffer-file-truename)
6540 (org-decompose-region beg end)
6541 (remove-text-properties beg end
6542 '(mouse-face t keymap t org-linked-text t
6543 invisible t intangible t
6544 org-emphasis t))
6545 (org-remove-font-lock-display-properties beg end)))
6547 (defconst org-script-display '(((raise -0.3) (height 0.7))
6548 ((raise 0.3) (height 0.7))
6549 ((raise -0.5))
6550 ((raise 0.5)))
6551 "Display properties for showing superscripts and subscripts.")
6553 (defun org-remove-font-lock-display-properties (beg end)
6554 "Remove specific display properties that have been added by font lock.
6555 The will remove the raise properties that are used to show superscripts
6556 and subscripts."
6557 (let (next prop)
6558 (while (< beg end)
6559 (setq next (next-single-property-change beg 'display nil end)
6560 prop (get-text-property beg 'display))
6561 (if (member prop org-script-display)
6562 (put-text-property beg next 'display nil))
6563 (setq beg next))))
6565 (defun org-raise-scripts (limit)
6566 "Add raise properties to sub/superscripts."
6567 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6568 (if (re-search-forward
6569 (if (eq org-use-sub-superscripts t)
6570 org-match-substring-regexp
6571 org-match-substring-with-braces-regexp)
6572 limit t)
6573 (let* ((pos (point)) table-p comment-p
6574 (mpos (match-beginning 3))
6575 (emph-p (get-text-property mpos 'org-emphasis))
6576 (link-p (get-text-property mpos 'mouse-face))
6577 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6578 (goto-char (point-at-bol))
6579 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6580 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6581 (goto-char pos)
6582 ;; Handle a_b^c
6583 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6584 (if (or comment-p emph-p link-p keyw-p)
6586 (put-text-property (match-beginning 3) (match-end 0)
6587 'display
6588 (if (equal (char-after (match-beginning 2)) ?^)
6589 (nth (if table-p 3 1) org-script-display)
6590 (nth (if table-p 2 0) org-script-display)))
6591 (add-text-properties (match-beginning 2) (match-end 2)
6592 (list 'invisible t
6593 'org-dwidth t 'org-dwidth-n 1))
6594 (if (and (eq (char-after (match-beginning 3)) ?{)
6595 (eq (char-before (match-end 3)) ?}))
6596 (progn
6597 (add-text-properties
6598 (match-beginning 3) (1+ (match-beginning 3))
6599 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6600 (add-text-properties
6601 (1- (match-end 3)) (match-end 3)
6602 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6603 t)))))
6605 ;;;; Visibility cycling, including org-goto and indirect buffer
6607 ;;; Cycling
6609 (defvar org-cycle-global-status nil)
6610 (make-variable-buffer-local 'org-cycle-global-status)
6611 (put 'org-cycle-global-status 'org-state t)
6612 (defvar org-cycle-subtree-status nil)
6613 (make-variable-buffer-local 'org-cycle-subtree-status)
6614 (put 'org-cycle-subtree-status 'org-state t)
6616 (defvar org-inlinetask-min-level)
6618 (defun org-unlogged-message (&rest args)
6619 "Display a message, but avoid logging it in the *Messages* buffer."
6620 (let ((message-log-max nil))
6621 (apply 'message args)))
6623 ;;;###autoload
6624 (defun org-cycle (&optional arg)
6625 "TAB-action and visibility cycling for Org-mode.
6627 This is the command invoked in Org-mode by the TAB key. Its main purpose
6628 is outline visibility cycling, but it also invokes other actions
6629 in special contexts.
6631 - When this function is called with a prefix argument, rotate the entire
6632 buffer through 3 states (global cycling)
6633 1. OVERVIEW: Show only top-level headlines.
6634 2. CONTENTS: Show all headlines of all levels, but no body text.
6635 3. SHOW ALL: Show everything.
6636 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6637 determined by the variable `org-startup-folded', and by any VISIBILITY
6638 properties in the buffer.
6639 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6640 including any drawers.
6642 - When inside a table, re-align the table and move to the next field.
6644 - When point is at the beginning of a headline, rotate the subtree started
6645 by this line through 3 different states (local cycling)
6646 1. FOLDED: Only the main headline is shown.
6647 2. CHILDREN: The main headline and the direct children are shown.
6648 From this state, you can move to one of the children
6649 and zoom in further.
6650 3. SUBTREE: Show the entire subtree, including body text.
6651 If there is no subtree, switch directly from CHILDREN to FOLDED.
6653 - When point is at the beginning of an empty headline and the variable
6654 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6655 of the headline by demoting and promoting it to likely levels. This
6656 speeds up creation document structure by pressing TAB once or several
6657 times right after creating a new headline.
6659 - When there is a numeric prefix, go up to a heading with level ARG, do
6660 a `show-subtree' and return to the previous cursor position. If ARG
6661 is negative, go up that many levels.
6663 - When point is not at the beginning of a headline, execute the global
6664 binding for TAB, which is re-indenting the line. See the option
6665 `org-cycle-emulate-tab' for details.
6667 - Special case: if point is at the beginning of the buffer and there is
6668 no headline in line 1, this function will act as if called with prefix arg
6669 (C-u TAB, same as S-TAB) also when called without prefix arg.
6670 But only if also the variable `org-cycle-global-at-bob' is t."
6671 (interactive "P")
6672 (org-load-modules-maybe)
6673 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6674 (and org-cycle-level-after-item/entry-creation
6675 (or (org-cycle-level)
6676 (org-cycle-item-indentation))))
6677 (let* ((limit-level
6678 (or org-cycle-max-level
6679 (and (boundp 'org-inlinetask-min-level)
6680 org-inlinetask-min-level
6681 (1- org-inlinetask-min-level))))
6682 (nstars (and limit-level
6683 (if org-odd-levels-only
6684 (and limit-level (1- (* limit-level 2)))
6685 limit-level)))
6686 (org-outline-regexp
6687 (if (not (derived-mode-p 'org-mode))
6688 outline-regexp
6689 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6690 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6691 (not (looking-at org-outline-regexp))))
6692 (org-cycle-hook
6693 (if bob-special
6694 (delq 'org-optimize-window-after-visibility-change
6695 (copy-sequence org-cycle-hook))
6696 org-cycle-hook))
6697 (pos (point)))
6699 (if (or bob-special (equal arg '(4)))
6700 ;; special case: use global cycling
6701 (setq arg t))
6703 (cond
6705 ((equal arg '(16))
6706 (setq last-command 'dummy)
6707 (org-set-startup-visibility)
6708 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6710 ((equal arg '(64))
6711 (show-all)
6712 (org-unlogged-message "Entire buffer visible, including drawers"))
6714 ;; Try cdlatex TAB completion
6715 ((org-try-cdlatex-tab))
6717 ;; Table: enter it or move to the next field.
6718 ((org-at-table-p 'any)
6719 (if (org-at-table.el-p)
6720 (message "Use C-c ' to edit table.el tables")
6721 (if arg (org-table-edit-field t)
6722 (org-table-justify-field-maybe)
6723 (call-interactively 'org-table-next-field))))
6725 ((run-hook-with-args-until-success
6726 'org-tab-after-check-for-table-hook))
6728 ;; Global cycling: delegate to `org-cycle-internal-global'.
6729 ((eq arg t) (org-cycle-internal-global))
6731 ;; Drawers: delegate to `org-flag-drawer'.
6732 ((save-excursion
6733 (beginning-of-line 1)
6734 (looking-at org-drawer-regexp))
6735 (org-flag-drawer ; toggle block visibility
6736 (not (get-char-property (match-end 0) 'invisible))))
6738 ;; Show-subtree, ARG levels up from here.
6739 ((integerp arg)
6740 (save-excursion
6741 (org-back-to-heading)
6742 (outline-up-heading (if (< arg 0) (- arg)
6743 (- (funcall outline-level) arg)))
6744 (org-show-subtree)))
6746 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6747 ((and (featurep 'org-inlinetask)
6748 (org-inlinetask-at-task-p)
6749 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6750 (org-inlinetask-toggle-visibility))
6752 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6753 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6754 (save-excursion (beginning-of-line 1)
6755 (looking-at org-outline-regexp)))
6756 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6757 (org-cycle-internal-local))
6759 ;; From there: TAB emulation and template completion.
6760 (buffer-read-only (org-back-to-heading))
6762 ((run-hook-with-args-until-success
6763 'org-tab-after-check-for-cycling-hook))
6765 ((org-try-structure-completion))
6767 ((run-hook-with-args-until-success
6768 'org-tab-before-tab-emulation-hook))
6770 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6771 (or (not (bolp))
6772 (not (looking-at org-outline-regexp))))
6773 (call-interactively (global-key-binding "\t")))
6775 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6776 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6777 (or (and (eq org-cycle-emulate-tab 'white)
6778 (= (match-end 0) (point-at-eol)))
6779 (and (eq org-cycle-emulate-tab 'whitestart)
6780 (>= (match-end 0) pos))))
6782 (eq org-cycle-emulate-tab t))
6783 (call-interactively (global-key-binding "\t")))
6785 (t (save-excursion
6786 (org-back-to-heading)
6787 (org-cycle)))))))
6789 (defun org-cycle-internal-global ()
6790 "Do the global cycling action."
6791 ;; Hack to avoid display of messages for .org attachments in Gnus
6792 (let ((ga (string-match "\\*fontification" (buffer-name))))
6793 (cond
6794 ((and (eq last-command this-command)
6795 (eq org-cycle-global-status 'overview))
6796 ;; We just created the overview - now do table of contents
6797 ;; This can be slow in very large buffers, so indicate action
6798 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6799 (unless ga (org-unlogged-message "CONTENTS..."))
6800 (org-content)
6801 (unless ga (org-unlogged-message "CONTENTS...done"))
6802 (setq org-cycle-global-status 'contents)
6803 (run-hook-with-args 'org-cycle-hook 'contents))
6805 ((and (eq last-command this-command)
6806 (eq org-cycle-global-status 'contents))
6807 ;; We just showed the table of contents - now show everything
6808 (run-hook-with-args 'org-pre-cycle-hook 'all)
6809 (show-all)
6810 (unless ga (org-unlogged-message "SHOW ALL"))
6811 (setq org-cycle-global-status 'all)
6812 (run-hook-with-args 'org-cycle-hook 'all))
6815 ;; Default action: go to overview
6816 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6817 (org-overview)
6818 (unless ga (org-unlogged-message "OVERVIEW"))
6819 (setq org-cycle-global-status 'overview)
6820 (run-hook-with-args 'org-cycle-hook 'overview)))))
6822 (defvar org-called-with-limited-levels nil
6823 "Non-nil when `org-with-limited-levels' is currently active.")
6825 (defun org-cycle-internal-local ()
6826 "Do the local cycling action."
6827 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6828 ;; First, determine end of headline (EOH), end of subtree or item
6829 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6830 (save-excursion
6831 (if (org-at-item-p)
6832 (progn
6833 (beginning-of-line)
6834 (setq struct (org-list-struct))
6835 (setq eoh (point-at-eol))
6836 (setq eos (org-list-get-item-end-before-blank (point) struct))
6837 (setq has-children (org-list-has-child-p (point) struct)))
6838 (org-back-to-heading)
6839 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6840 (setq eos (save-excursion (org-end-of-subtree t t)
6841 (when (bolp) (backward-char)) (point)))
6842 (setq has-children
6843 (or (save-excursion
6844 (let ((level (funcall outline-level)))
6845 (outline-next-heading)
6846 (and (org-at-heading-p t)
6847 (> (funcall outline-level) level))))
6848 (save-excursion
6849 (org-list-search-forward (org-item-beginning-re) eos t)))))
6850 ;; Determine end invisible part of buffer (EOL)
6851 (beginning-of-line 2)
6852 ;; XEmacs doesn't have `next-single-char-property-change'
6853 (if (featurep 'xemacs)
6854 (while (and (not (eobp)) ;; this is like `next-line'
6855 (get-char-property (1- (point)) 'invisible))
6856 (beginning-of-line 2))
6857 (while (and (not (eobp)) ;; this is like `next-line'
6858 (get-char-property (1- (point)) 'invisible))
6859 (goto-char (next-single-char-property-change (point) 'invisible))
6860 (and (eolp) (beginning-of-line 2))))
6861 (setq eol (point)))
6862 ;; Find out what to do next and set `this-command'
6863 (cond
6864 ((= eos eoh)
6865 ;; Nothing is hidden behind this heading
6866 (unless (org-before-first-heading-p)
6867 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6868 (org-unlogged-message "EMPTY ENTRY")
6869 (setq org-cycle-subtree-status nil)
6870 (save-excursion
6871 (goto-char eos)
6872 (outline-next-heading)
6873 (if (outline-invisible-p) (org-flag-heading nil))))
6874 ((and (or (>= eol eos)
6875 (not (string-match "\\S-" (buffer-substring eol eos))))
6876 (or has-children
6877 (not (setq children-skipped
6878 org-cycle-skip-children-state-if-no-children))))
6879 ;; Entire subtree is hidden in one line: children view
6880 (unless (org-before-first-heading-p)
6881 (run-hook-with-args 'org-pre-cycle-hook 'children))
6882 (if (org-at-item-p)
6883 (org-list-set-item-visibility (point-at-bol) struct 'children)
6884 (org-show-entry)
6885 (org-with-limited-levels (show-children))
6886 ;; FIXME: This slows down the func way too much.
6887 ;; How keep drawers hidden in subtree anyway?
6888 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6889 ;; (org-cycle-hide-drawers 'subtree))
6891 ;; Fold every list in subtree to top-level items.
6892 (when (eq org-cycle-include-plain-lists 'integrate)
6893 (save-excursion
6894 (org-back-to-heading)
6895 (while (org-list-search-forward (org-item-beginning-re) eos t)
6896 (beginning-of-line 1)
6897 (let* ((struct (org-list-struct))
6898 (prevs (org-list-prevs-alist struct))
6899 (end (org-list-get-bottom-point struct)))
6900 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6901 (org-list-get-all-items (point) struct prevs))
6902 (goto-char (if (< end eos) end eos)))))))
6903 (org-unlogged-message "CHILDREN")
6904 (save-excursion
6905 (goto-char eos)
6906 (outline-next-heading)
6907 (if (outline-invisible-p) (org-flag-heading nil)))
6908 (setq org-cycle-subtree-status 'children)
6909 (unless (org-before-first-heading-p)
6910 (run-hook-with-args 'org-cycle-hook 'children)))
6911 ((or children-skipped
6912 (and (eq last-command this-command)
6913 (eq org-cycle-subtree-status 'children)))
6914 ;; We just showed the children, or no children are there,
6915 ;; now show everything.
6916 (unless (org-before-first-heading-p)
6917 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6918 (outline-flag-region eoh eos nil)
6919 (org-unlogged-message
6920 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6921 (setq org-cycle-subtree-status 'subtree)
6922 (unless (org-before-first-heading-p)
6923 (run-hook-with-args 'org-cycle-hook 'subtree)))
6925 ;; Default action: hide the subtree.
6926 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6927 (outline-flag-region eoh eos t)
6928 (org-unlogged-message "FOLDED")
6929 (setq org-cycle-subtree-status 'folded)
6930 (unless (org-before-first-heading-p)
6931 (run-hook-with-args 'org-cycle-hook 'folded))))))
6933 ;;;###autoload
6934 (defun org-global-cycle (&optional arg)
6935 "Cycle the global visibility. For details see `org-cycle'.
6936 With \\[universal-argument] prefix arg, switch to startup visibility.
6937 With a numeric prefix, show all headlines up to that level."
6938 (interactive "P")
6939 (let ((org-cycle-include-plain-lists
6940 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6941 (cond
6942 ((integerp arg)
6943 (show-all)
6944 (hide-sublevels arg)
6945 (setq org-cycle-global-status 'contents))
6946 ((equal arg '(4))
6947 (org-set-startup-visibility)
6948 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6950 (org-cycle '(4))))))
6952 (defun org-set-startup-visibility ()
6953 "Set the visibility required by startup options and properties."
6954 (cond
6955 ((eq org-startup-folded t)
6956 (org-overview))
6957 ((eq org-startup-folded 'content)
6958 (org-content))
6959 ((or (eq org-startup-folded 'showeverything)
6960 (eq org-startup-folded nil))
6961 (show-all)))
6962 (unless (eq org-startup-folded 'showeverything)
6963 (if org-hide-block-startup (org-hide-block-all))
6964 (org-set-visibility-according-to-property 'no-cleanup)
6965 (org-cycle-hide-archived-subtrees 'all)
6966 (org-cycle-hide-drawers 'all)
6967 (org-cycle-show-empty-lines t)))
6969 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6970 "Switch subtree visibilities according to :VISIBILITY: property."
6971 (interactive)
6972 (let (org-show-entry-below)
6973 (org-with-wide-buffer
6974 (goto-char (point-min))
6975 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
6976 (if (not (org-at-property-p)) (outline-next-heading)
6977 (let ((state (match-string 3)))
6978 (save-excursion
6979 (org-back-to-heading t)
6980 (hide-subtree)
6981 (org-reveal)
6982 (cond
6983 ((equal state "folded")
6984 (hide-subtree))
6985 ((equal state "children")
6986 (org-show-hidden-entry)
6987 (show-children))
6988 ((equal state "content")
6989 (save-excursion
6990 (save-restriction
6991 (org-narrow-to-subtree)
6992 (org-content))))
6993 ((member state '("all" "showall"))
6994 (show-subtree)))))))
6995 (unless no-cleanup
6996 (org-cycle-hide-archived-subtrees 'all)
6997 (org-cycle-hide-drawers 'all)
6998 (org-cycle-show-empty-lines 'all)))))
7000 ;; This function uses outline-regexp instead of the more fundamental
7001 ;; org-outline-regexp so that org-cycle-global works outside of Org
7002 ;; buffers, where outline-regexp is needed.
7003 (defun org-overview ()
7004 "Switch to overview mode, showing only top-level headlines.
7005 This shows all headlines with a level equal or greater than the level
7006 of the first headline in the buffer. This is important, because if the
7007 first headline is not level one, then (hide-sublevels 1) gives confusing
7008 results."
7009 (interactive)
7010 (save-excursion
7011 (let ((level
7012 (save-excursion
7013 (goto-char (point-min))
7014 (if (re-search-forward (concat "^" outline-regexp) nil t)
7015 (progn
7016 (goto-char (match-beginning 0))
7017 (funcall outline-level))))))
7018 (and level (hide-sublevels level)))))
7020 (defun org-content (&optional arg)
7021 "Show all headlines in the buffer, like a table of contents.
7022 With numerical argument N, show content up to level N."
7023 (interactive "P")
7024 (org-overview)
7025 (save-excursion
7026 ;; Visit all headings and show their offspring
7027 (and (integerp arg) (org-overview))
7028 (goto-char (point-max))
7029 (catch 'exit
7030 (while (and (progn (condition-case nil
7031 (outline-previous-visible-heading 1)
7032 (error (goto-char (point-min))))
7034 (looking-at org-outline-regexp))
7035 (if (integerp arg)
7036 (show-children (1- arg))
7037 (show-branches))
7038 (if (bobp) (throw 'exit nil))))))
7040 (defun org-optimize-window-after-visibility-change (state)
7041 "Adjust the window after a change in outline visibility.
7042 This function is the default value of the hook `org-cycle-hook'."
7043 (when (get-buffer-window (current-buffer))
7044 (cond
7045 ((eq state 'content) nil)
7046 ((eq state 'all) nil)
7047 ((eq state 'folded) nil)
7048 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7049 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7051 (defun org-remove-empty-overlays-at (pos)
7052 "Remove outline overlays that do not contain non-white stuff."
7053 (mapc
7054 (lambda (o)
7055 (and (eq 'outline (overlay-get o 'invisible))
7056 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7057 (overlay-end o))))
7058 (delete-overlay o)))
7059 (overlays-at pos)))
7061 (defun org-clean-visibility-after-subtree-move ()
7062 "Fix visibility issues after moving a subtree."
7063 ;; First, find a reasonable region to look at:
7064 ;; Start two siblings above, end three below
7065 (let* ((beg (save-excursion
7066 (and (org-get-last-sibling)
7067 (org-get-last-sibling))
7068 (point)))
7069 (end (save-excursion
7070 (and (org-get-next-sibling)
7071 (org-get-next-sibling)
7072 (org-get-next-sibling))
7073 (if (org-at-heading-p)
7074 (point-at-eol)
7075 (point))))
7076 (level (looking-at "\\*+"))
7077 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7078 (save-excursion
7079 (save-restriction
7080 (narrow-to-region beg end)
7081 (when re
7082 ;; Properly fold already folded siblings
7083 (goto-char (point-min))
7084 (while (re-search-forward re nil t)
7085 (if (and (not (outline-invisible-p))
7086 (save-excursion
7087 (goto-char (point-at-eol)) (outline-invisible-p)))
7088 (hide-entry))))
7089 (org-cycle-show-empty-lines 'overview)
7090 (org-cycle-hide-drawers 'overview)))))
7092 (defun org-cycle-show-empty-lines (state)
7093 "Show empty lines above all visible headlines.
7094 The region to be covered depends on STATE when called through
7095 `org-cycle-hook'. Lisp program can use t for STATE to get the
7096 entire buffer covered. Note that an empty line is only shown if there
7097 are at least `org-cycle-separator-lines' empty lines before the headline."
7098 (when (not (= org-cycle-separator-lines 0))
7099 (save-excursion
7100 (let* ((n (abs org-cycle-separator-lines))
7101 (re (cond
7102 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7103 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7104 (t (let ((ns (number-to-string (- n 2))))
7105 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7106 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7107 beg end b e)
7108 (cond
7109 ((memq state '(overview contents t))
7110 (setq beg (point-min) end (point-max)))
7111 ((memq state '(children folded))
7112 (setq beg (point) end (progn (org-end-of-subtree t t)
7113 (beginning-of-line 2)
7114 (point)))))
7115 (when beg
7116 (goto-char beg)
7117 (while (re-search-forward re end t)
7118 (unless (get-char-property (match-end 1) 'invisible)
7119 (setq e (match-end 1))
7120 (if (< org-cycle-separator-lines 0)
7121 (setq b (save-excursion
7122 (goto-char (match-beginning 0))
7123 (org-back-over-empty-lines)
7124 (if (save-excursion
7125 (goto-char (max (point-min) (1- (point))))
7126 (org-at-heading-p))
7127 (1- (point))
7128 (point))))
7129 (setq b (match-beginning 1)))
7130 (outline-flag-region b e nil)))))))
7131 ;; Never hide empty lines at the end of the file.
7132 (save-excursion
7133 (goto-char (point-max))
7134 (outline-previous-heading)
7135 (outline-end-of-heading)
7136 (if (and (looking-at "[ \t\n]+")
7137 (= (match-end 0) (point-max)))
7138 (outline-flag-region (point) (match-end 0) nil))))
7140 (defun org-show-empty-lines-in-parent ()
7141 "Move to the parent and re-show empty lines before visible headlines."
7142 (save-excursion
7143 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7144 (org-cycle-show-empty-lines context))))
7146 (defun org-files-list ()
7147 "Return `org-agenda-files' list, plus all open org-mode files.
7148 This is useful for operations that need to scan all of a user's
7149 open and agenda-wise Org files."
7150 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7151 (dolist (buf (buffer-list))
7152 (with-current-buffer buf
7153 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7154 (let ((file (expand-file-name (buffer-file-name))))
7155 (unless (member file files)
7156 (push file files))))))
7157 files))
7159 (defsubst org-entry-beginning-position ()
7160 "Return the beginning position of the current entry."
7161 (save-excursion (outline-back-to-heading t) (point)))
7163 (defsubst org-entry-end-position ()
7164 "Return the end position of the current entry."
7165 (save-excursion (outline-next-heading) (point)))
7167 (defun org-cycle-hide-drawers (state &optional exceptions)
7168 "Re-hide all drawers after a visibility state change.
7169 When non-nil, optional argument EXCEPTIONS is a list of strings
7170 specifying which drawers should not be hidden."
7171 (when (and (derived-mode-p 'org-mode)
7172 (not (memq state '(overview folded contents))))
7173 (save-excursion
7174 (let* ((globalp (memq state '(contents all)))
7175 (beg (if globalp (point-min) (point)))
7176 (end (if globalp (point-max)
7177 (if (eq state 'children)
7178 (save-excursion (outline-next-heading) (point))
7179 (org-end-of-subtree t)))))
7180 (goto-char beg)
7181 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7182 (unless (member-ignore-case (match-string 1) exceptions)
7183 (let ((drawer (org-element-at-point)))
7184 (when (memq (org-element-type drawer) '(drawer property-drawer))
7185 (org-flag-drawer t drawer)
7186 ;; Make sure to skip drawer entirely or we might flag
7187 ;; it another time when matching its ending line with
7188 ;; `org-drawer-regexp'.
7189 (goto-char (org-element-property :end drawer))))))))))
7191 (defun org-cycle-hide-inline-tasks (state)
7192 "Re-hide inline tasks when switching to 'contents or 'children
7193 visibility state."
7194 (case state
7195 (contents
7196 (when (org-bound-and-true-p org-inlinetask-min-level)
7197 (hide-sublevels (1- org-inlinetask-min-level))))
7198 (children
7199 (when (featurep 'org-inlinetask)
7200 (save-excursion
7201 (while (and (outline-next-heading)
7202 (org-inlinetask-at-task-p))
7203 (org-inlinetask-toggle-visibility)
7204 (org-inlinetask-goto-end)))))))
7206 (defun org-flag-drawer (flag &optional element)
7207 "When FLAG is non-nil, hide the drawer we are at.
7208 Otherwise make it visible. When optional argument ELEMENT is
7209 a parsed drawer, as returned by `org-element-at-point', hide or
7210 show that drawer instead."
7211 (when (save-excursion
7212 (beginning-of-line)
7213 (org-looking-at-p org-drawer-regexp))
7214 (let ((drawer (or element (org-element-at-point))))
7215 (when (memq (org-element-type drawer) '(drawer property-drawer))
7216 (let ((post (org-element-property :post-affiliated drawer)))
7217 (save-excursion
7218 (outline-flag-region
7219 (progn (goto-char post) (line-end-position))
7220 (progn (goto-char (org-element-property :end drawer))
7221 (skip-chars-backward " \r\t\n")
7222 (line-end-position))
7223 flag))
7224 ;; When the drawer is hidden away, make sure point lies in
7225 ;; a visible part of the buffer.
7226 (when (and flag (> (line-beginning-position) post))
7227 (goto-char post)))))))
7229 (defun org-subtree-end-visible-p ()
7230 "Is the end of the current subtree visible?"
7231 (pos-visible-in-window-p
7232 (save-excursion (org-end-of-subtree t) (point))))
7234 (defun org-first-headline-recenter ()
7235 "Move cursor to the first headline and recenter the headline."
7236 (goto-char (point-min))
7237 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7238 (set-window-start (selected-window) (point-at-bol))))
7240 ;;; Saving and restoring visibility
7242 (defun org-outline-overlay-data (&optional use-markers)
7243 "Return a list of the locations of all outline overlays.
7244 These are overlays with the `invisible' property value `outline'.
7245 The return value is a list of cons cells, with start and stop
7246 positions for each overlay.
7247 If USE-MARKERS is set, return the positions as markers."
7248 (let (beg end)
7249 (save-excursion
7250 (save-restriction
7251 (widen)
7252 (delq nil
7253 (mapcar (lambda (o)
7254 (when (eq (overlay-get o 'invisible) 'outline)
7255 (setq beg (overlay-start o)
7256 end (overlay-end o))
7257 (and beg end (> end beg)
7258 (if use-markers
7259 (cons (copy-marker beg)
7260 (copy-marker end t))
7261 (cons beg end)))))
7262 (overlays-in (point-min) (point-max))))))))
7264 (defun org-set-outline-overlay-data (data)
7265 "Create visibility overlays for all positions in DATA.
7266 DATA should have been made by `org-outline-overlay-data'."
7267 (let (o)
7268 (save-excursion
7269 (save-restriction
7270 (widen)
7271 (show-all)
7272 (mapc (lambda (c)
7273 (outline-flag-region (car c) (cdr c) t))
7274 data)))))
7276 ;;; Folding of blocks
7278 (defvar org-hide-block-overlays nil
7279 "Overlays hiding blocks.")
7280 (make-variable-buffer-local 'org-hide-block-overlays)
7282 (defun org-block-map (function &optional start end)
7283 "Call FUNCTION at the head of all source blocks in the current buffer.
7284 Optional arguments START and END can be used to limit the range."
7285 (let ((start (or start (point-min)))
7286 (end (or end (point-max))))
7287 (save-excursion
7288 (goto-char start)
7289 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7290 (save-excursion
7291 (save-match-data
7292 (goto-char (match-beginning 0))
7293 (funcall function)))))))
7295 (defun org-hide-block-toggle-all ()
7296 "Toggle the visibility of all blocks in the current buffer."
7297 (org-block-map 'org-hide-block-toggle))
7299 (defun org-hide-block-all ()
7300 "Fold all blocks in the current buffer."
7301 (interactive)
7302 (org-show-block-all)
7303 (org-block-map 'org-hide-block-toggle-maybe))
7305 (defun org-show-block-all ()
7306 "Unfold all blocks in the current buffer."
7307 (interactive)
7308 (mapc 'delete-overlay org-hide-block-overlays)
7309 (setq org-hide-block-overlays nil))
7311 (defun org-hide-block-toggle-maybe ()
7312 "Toggle visibility of block at point.
7313 Unlike to `org-hide-block-toggle', this function does not throw
7314 an error. Return a non-nil value when toggling is successful."
7315 (interactive)
7316 (ignore-errors (org-hide-block-toggle)))
7318 (defun org-hide-block-toggle (&optional force)
7319 "Toggle the visibility of the current block.
7320 When optional argument FORCE is `off', make block visible. If it
7321 is non-nil, hide it unconditionally. Throw an error when not at
7322 a block. Return a non-nil value when toggling is successful."
7323 (interactive)
7324 (let ((element (org-element-at-point)))
7325 (unless (memq (org-element-type element)
7326 '(center-block comment-block dynamic-block example-block
7327 export-block quote-block special-block
7328 src-block verse-block))
7329 (user-error "Not at a block"))
7330 (let* ((start (save-excursion
7331 (goto-char (org-element-property :post-affiliated element))
7332 (line-end-position)))
7333 (end (save-excursion
7334 (goto-char (org-element-property :end element))
7335 (skip-chars-backward " \r\t\n")
7336 (line-end-position)))
7337 (overlays (overlays-at start)))
7338 (cond
7339 ;; Do nothing when not before or at the block opening line or
7340 ;; at the block closing line.
7341 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7342 ((and (not (eq force 'off))
7343 (not (memq t (mapcar
7344 (lambda (o)
7345 (eq (overlay-get o 'invisible) 'org-hide-block))
7346 overlays))))
7347 (let ((ov (make-overlay start end)))
7348 (overlay-put ov 'invisible 'org-hide-block)
7349 ;; Make the block accessible to `isearch'.
7350 (overlay-put
7351 ov 'isearch-open-invisible
7352 (lambda (ov)
7353 (when (memq ov org-hide-block-overlays)
7354 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7355 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7356 (delete-overlay ov))))
7357 (push ov org-hide-block-overlays)
7358 ;; When the block is hidden away, make sure point is left in
7359 ;; a visible part of the buffer.
7360 (when (> (line-beginning-position) start)
7361 (goto-char start)
7362 (beginning-of-line))
7363 ;; Signal successful toggling.
7365 ((or (not force) (eq force 'off))
7366 (dolist (ov overlays t)
7367 (when (memq ov org-hide-block-overlays)
7368 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7369 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7370 (delete-overlay ov))))))))
7372 ;; org-tab-after-check-for-cycling-hook
7373 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7374 ;; Remove overlays when changing major mode
7375 (add-hook 'org-mode-hook
7376 (lambda () (org-add-hook 'change-major-mode-hook
7377 'org-show-block-all 'append 'local)))
7379 ;;; Org-goto
7381 (defvar org-goto-window-configuration nil)
7382 (defvar org-goto-marker nil)
7383 (defvar org-goto-map)
7384 (defun org-goto-map ()
7385 "Set the keymap `org-goto'."
7386 (setq org-goto-map
7387 (let ((map (make-sparse-keymap)))
7388 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7389 mouse-drag-region universal-argument org-occur))
7390 cmd)
7391 (while (setq cmd (pop cmds))
7392 (substitute-key-definition cmd cmd map global-map)))
7393 (suppress-keymap map)
7394 (org-defkey map "\C-m" 'org-goto-ret)
7395 (org-defkey map [(return)] 'org-goto-ret)
7396 (org-defkey map [(left)] 'org-goto-left)
7397 (org-defkey map [(right)] 'org-goto-right)
7398 (org-defkey map [(control ?g)] 'org-goto-quit)
7399 (org-defkey map "\C-i" 'org-cycle)
7400 (org-defkey map [(tab)] 'org-cycle)
7401 (org-defkey map [(down)] 'outline-next-visible-heading)
7402 (org-defkey map [(up)] 'outline-previous-visible-heading)
7403 (if org-goto-auto-isearch
7404 (if (fboundp 'define-key-after)
7405 (define-key-after map [t] 'org-goto-local-auto-isearch)
7406 nil)
7407 (org-defkey map "q" 'org-goto-quit)
7408 (org-defkey map "n" 'outline-next-visible-heading)
7409 (org-defkey map "p" 'outline-previous-visible-heading)
7410 (org-defkey map "f" 'outline-forward-same-level)
7411 (org-defkey map "b" 'outline-backward-same-level)
7412 (org-defkey map "u" 'outline-up-heading))
7413 (org-defkey map "/" 'org-occur)
7414 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7415 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7416 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7417 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7418 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7419 map)))
7421 (defconst org-goto-help
7422 "Browse buffer copy, to find location or copy text.%s
7423 RET=jump to location C-g=quit and return to previous location
7424 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7426 (defvar org-goto-start-pos) ; dynamically scoped parameter
7428 (defun org-goto (&optional alternative-interface)
7429 "Look up a different location in the current file, keeping current visibility.
7431 When you want look-up or go to a different location in a
7432 document, the fastest way is often to fold the entire buffer and
7433 then dive into the tree. This method has the disadvantage, that
7434 the previous location will be folded, which may not be what you
7435 want.
7437 This command works around this by showing a copy of the current
7438 buffer in an indirect buffer, in overview mode. You can dive
7439 into the tree in that copy, use org-occur and incremental search
7440 to find a location. When pressing RET or `Q', the command
7441 returns to the original buffer in which the visibility is still
7442 unchanged. After RET it will also jump to the location selected
7443 in the indirect buffer and expose the headline hierarchy above.
7445 With a prefix argument, use the alternative interface: e.g. if
7446 `org-goto-interface' is 'outline use 'outline-path-completion."
7447 (interactive "P")
7448 (org-goto-map)
7449 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7450 (org-refile-use-outline-path t)
7451 (org-refile-target-verify-function nil)
7452 (interface
7453 (if (not alternative-interface)
7454 org-goto-interface
7455 (if (eq org-goto-interface 'outline)
7456 'outline-path-completion
7457 'outline)))
7458 (org-goto-start-pos (point))
7459 (selected-point
7460 (if (eq interface 'outline)
7461 (car (org-get-location (current-buffer) org-goto-help))
7462 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7463 (org-refile-check-position pa)
7464 (nth 3 pa)))))
7465 (if selected-point
7466 (progn
7467 (org-mark-ring-push org-goto-start-pos)
7468 (goto-char selected-point)
7469 (if (or (outline-invisible-p) (org-invisible-p2))
7470 (org-show-context 'org-goto)))
7471 (message "Quit"))))
7473 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7474 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7475 (defvar org-goto-local-auto-isearch-map) ; defined below
7477 (defun org-get-location (buf help)
7478 "Let the user select a location in the Org-mode buffer BUF.
7479 This function uses a recursive edit. It returns the selected position
7480 or nil."
7481 (org-no-popups
7482 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7483 (isearch-hide-immediately nil)
7484 (isearch-search-fun-function
7485 (lambda () 'org-goto-local-search-headings))
7486 (org-goto-selected-point org-goto-exit-command))
7487 (save-excursion
7488 (save-window-excursion
7489 (delete-other-windows)
7490 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7491 (org-pop-to-buffer-same-window
7492 (condition-case nil
7493 (make-indirect-buffer (current-buffer) "*org-goto*")
7494 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7495 (with-output-to-temp-buffer "*Org Help*"
7496 (princ (format help (if org-goto-auto-isearch
7497 " Just type for auto-isearch."
7498 " n/p/f/b/u to navigate, q to quit."))))
7499 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7500 (setq buffer-read-only nil)
7501 (let ((org-startup-truncated t)
7502 (org-startup-folded nil)
7503 (org-startup-align-all-tables nil))
7504 (org-mode)
7505 (org-overview))
7506 (setq buffer-read-only t)
7507 (if (and (boundp 'org-goto-start-pos)
7508 (integer-or-marker-p org-goto-start-pos))
7509 (progn (goto-char org-goto-start-pos)
7510 (when (outline-invisible-p)
7511 (org-show-set-visibility 'lineage)))
7512 (goto-char (point-min)))
7513 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7514 (message "Select location and press RET")
7515 (use-local-map org-goto-map)
7516 (recursive-edit)))
7517 (kill-buffer "*org-goto*")
7518 (cons org-goto-selected-point org-goto-exit-command))))
7520 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7521 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7522 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7523 (if (fboundp 'isearch-other-control-char)
7524 (progn
7525 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7526 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7527 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7528 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7529 (define-key org-goto-local-auto-isearch-map [return] nil))
7531 (defun org-goto-local-search-headings (string bound noerror)
7532 "Search and make sure that any matches are in headlines."
7533 (catch 'return
7534 (while (if isearch-forward
7535 (search-forward string bound noerror)
7536 (search-backward string bound noerror))
7537 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7538 (and (member :headline context)
7539 (not (member :tags context))))
7540 (throw 'return (point))))))
7542 (defun org-goto-local-auto-isearch ()
7543 "Start isearch."
7544 (interactive)
7545 (goto-char (point-min))
7546 (let ((keys (this-command-keys)))
7547 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7548 (isearch-mode t)
7549 (isearch-process-search-char (string-to-char keys)))))
7551 (defun org-goto-ret (&optional arg)
7552 "Finish `org-goto' by going to the new location."
7553 (interactive "P")
7554 (setq org-goto-selected-point (point)
7555 org-goto-exit-command 'return)
7556 (throw 'exit nil))
7558 (defun org-goto-left ()
7559 "Finish `org-goto' by going to the new location."
7560 (interactive)
7561 (if (org-at-heading-p)
7562 (progn
7563 (beginning-of-line 1)
7564 (setq org-goto-selected-point (point)
7565 org-goto-exit-command 'left)
7566 (throw 'exit nil))
7567 (user-error "Not on a heading")))
7569 (defun org-goto-right ()
7570 "Finish `org-goto' by going to the new location."
7571 (interactive)
7572 (if (org-at-heading-p)
7573 (progn
7574 (setq org-goto-selected-point (point)
7575 org-goto-exit-command 'right)
7576 (throw 'exit nil))
7577 (user-error "Not on a heading")))
7579 (defun org-goto-quit ()
7580 "Finish `org-goto' without cursor motion."
7581 (interactive)
7582 (setq org-goto-selected-point nil)
7583 (setq org-goto-exit-command 'quit)
7584 (throw 'exit nil))
7586 ;;; Indirect buffer display of subtrees
7588 (defvar org-indirect-dedicated-frame nil
7589 "This is the frame being used for indirect tree display.")
7590 (defvar org-last-indirect-buffer nil)
7592 (defun org-tree-to-indirect-buffer (&optional arg)
7593 "Create indirect buffer and narrow it to current subtree.
7594 With a numerical prefix ARG, go up to this level and then take that tree.
7595 If ARG is negative, go up that many levels.
7597 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7598 indirect buffer previously made with this command, to avoid proliferation of
7599 indirect buffers. However, when you call the command with a \
7600 \\[universal-argument] prefix, or
7601 when `org-indirect-buffer-display' is `new-frame', the last buffer
7602 is kept so that you can work with several indirect buffers at the same time.
7603 If `org-indirect-buffer-display' is `dedicated-frame', the \
7604 \\[universal-argument] prefix also
7605 requests that a new frame be made for the new buffer, so that the dedicated
7606 frame is not changed."
7607 (interactive "P")
7608 (let ((cbuf (current-buffer))
7609 (cwin (selected-window))
7610 (pos (point))
7611 beg end level heading ibuf)
7612 (save-excursion
7613 (org-back-to-heading t)
7614 (when (numberp arg)
7615 (setq level (org-outline-level))
7616 (if (< arg 0) (setq arg (+ level arg)))
7617 (while (> (setq level (org-outline-level)) arg)
7618 (org-up-heading-safe)))
7619 (setq beg (point)
7620 heading (org-get-heading))
7621 (org-end-of-subtree t t)
7622 (if (org-at-heading-p) (backward-char 1))
7623 (setq end (point)))
7624 (if (and (buffer-live-p org-last-indirect-buffer)
7625 (not (eq org-indirect-buffer-display 'new-frame))
7626 (not arg))
7627 (kill-buffer org-last-indirect-buffer))
7628 (setq ibuf (org-get-indirect-buffer cbuf heading)
7629 org-last-indirect-buffer ibuf)
7630 (cond
7631 ((or (eq org-indirect-buffer-display 'new-frame)
7632 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7633 (select-frame (make-frame))
7634 (delete-other-windows)
7635 (org-pop-to-buffer-same-window ibuf)
7636 (org-set-frame-title heading))
7637 ((eq org-indirect-buffer-display 'dedicated-frame)
7638 (raise-frame
7639 (select-frame (or (and org-indirect-dedicated-frame
7640 (frame-live-p org-indirect-dedicated-frame)
7641 org-indirect-dedicated-frame)
7642 (setq org-indirect-dedicated-frame (make-frame)))))
7643 (delete-other-windows)
7644 (org-pop-to-buffer-same-window ibuf)
7645 (org-set-frame-title (concat "Indirect: " heading)))
7646 ((eq org-indirect-buffer-display 'current-window)
7647 (org-pop-to-buffer-same-window ibuf))
7648 ((eq org-indirect-buffer-display 'other-window)
7649 (pop-to-buffer ibuf))
7650 (t (error "Invalid value")))
7651 (if (featurep 'xemacs)
7652 (save-excursion (org-mode) (turn-on-font-lock)))
7653 (narrow-to-region beg end)
7654 (show-all)
7655 (goto-char pos)
7656 (run-hook-with-args 'org-cycle-hook 'all)
7657 (and (window-live-p cwin) (select-window cwin))))
7659 (defun org-get-indirect-buffer (&optional buffer heading)
7660 (setq buffer (or buffer (current-buffer)))
7661 (let ((n 1) (base (buffer-name buffer)) bname)
7662 (while (buffer-live-p
7663 (get-buffer
7664 (setq bname
7665 (concat base "-"
7666 (if heading (concat heading "-" (number-to-string n))
7667 (number-to-string n))))))
7668 (setq n (1+ n)))
7669 (condition-case nil
7670 (make-indirect-buffer buffer bname 'clone)
7671 (error (make-indirect-buffer buffer bname)))))
7673 (defun org-set-frame-title (title)
7674 "Set the title of the current frame to the string TITLE."
7675 ;; FIXME: how to name a single frame in XEmacs???
7676 (unless (featurep 'xemacs)
7677 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7679 ;;;; Structure editing
7681 ;;; Inserting headlines
7683 (defun org-previous-line-empty-p (&optional next)
7684 "Is the previous line a blank line?
7685 When NEXT is non-nil, check the next line instead."
7686 (save-excursion
7687 (and (not (bobp))
7688 (or (beginning-of-line (if next 2 0)) t)
7689 (save-match-data
7690 (looking-at "[ \t]*$")))))
7692 (defun org-insert-heading (&optional arg invisible-ok top-level)
7693 "Insert a new heading or an item with the same depth at point.
7695 If point is at the beginning of a heading or a list item, insert
7696 a new heading or a new item above the current one. If point is
7697 at the beginning of a normal line, turn the line into a heading.
7699 If point is in the middle of a headline or a list item, split the
7700 headline or the item and create a new headline/item with the text
7701 in the current line after point \(see `org-M-RET-may-split-line'
7702 on how to modify this behavior).
7704 With one universal prefix argument, set the user option
7705 `org-insert-heading-respect-content' to t for the duration of
7706 the command. This modifies the behavior described above in this
7707 ways: on list items and at the beginning of normal lines, force
7708 the insertion of a heading after the current subtree.
7710 With two universal prefix arguments, insert the heading at the
7711 end of the grandparent subtree. For example, if point is within
7712 a 2nd-level heading, then it will insert a 2nd-level heading at
7713 the end of the 1st-level parent heading.
7715 If point is at the beginning of a headline, insert a sibling
7716 before the current headline. If point is not at the beginning,
7717 split the line and create a new headline with the text in the
7718 current line after point \(see `org-M-RET-may-split-line' on how
7719 to modify this behavior).
7721 If point is at the beginning of a normal line, turn this line
7722 into a heading.
7724 When INVISIBLE-OK is set, stop at invisible headlines when going
7725 back. This is important for non-interactive uses of the
7726 command.
7728 When optional argument TOP-LEVEL is non-nil, insert a level 1
7729 heading, unconditionally."
7730 (interactive "P")
7731 (if (org-called-interactively-p 'any) (org-reveal))
7732 (let ((itemp (and (not top-level) (org-in-item-p)))
7733 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7734 (respect-content (or org-insert-heading-respect-content
7735 (equal arg '(4))))
7736 (initial-content "")
7737 (adjust-empty-lines t))
7739 (cond
7741 ((or (= (buffer-size) 0)
7742 (and (not (save-excursion
7743 (and (ignore-errors (org-back-to-heading invisible-ok))
7744 (org-at-heading-p))))
7745 (or arg (not itemp))))
7746 ;; At beginning of buffer or so high up that only a heading
7747 ;; makes sense.
7748 (cond ((and (bolp) (not respect-content)) (insert "* "))
7749 ((not respect-content)
7750 (unless may-split (end-of-line))
7751 (insert "\n* "))
7752 ((re-search-forward org-outline-regexp-bol nil t)
7753 (beginning-of-line)
7754 (insert "* \n")
7755 (backward-char))
7756 (t (goto-char (point-max))
7757 (insert "\n* ")))
7758 (run-hooks 'org-insert-heading-hook))
7760 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7763 ;; Maybe move at the end of the subtree
7764 (when (equal arg '(16))
7765 (org-up-heading-safe)
7766 (org-end-of-subtree t))
7767 ;; Insert a heading
7768 (save-restriction
7769 (widen)
7770 (let* ((level nil)
7771 (on-heading (org-at-heading-p))
7772 (empty-line-p (if on-heading
7773 (org-previous-line-empty-p)
7774 ;; We will decide later
7775 nil))
7776 ;; Get a level string to fall back on.
7777 (fix-level
7778 (if (org-before-first-heading-p) "*"
7779 (save-excursion
7780 (org-back-to-heading t)
7781 (if (org-previous-line-empty-p) (setq empty-line-p t))
7782 (looking-at org-outline-regexp)
7783 (make-string (1- (length (match-string 0))) ?*))))
7784 (stars
7785 (save-excursion
7786 (condition-case nil
7787 (if top-level "* "
7788 (org-back-to-heading invisible-ok)
7789 (when (and (not on-heading)
7790 (featurep 'org-inlinetask)
7791 (integerp org-inlinetask-min-level)
7792 (>= (length (match-string 0))
7793 org-inlinetask-min-level))
7794 ;; Find a heading level before the inline
7795 ;; task.
7796 (while (and (setq level (org-up-heading-safe))
7797 (>= level org-inlinetask-min-level)))
7798 (if (org-at-heading-p)
7799 (org-back-to-heading invisible-ok)
7800 (error "This should not happen")))
7801 (unless (and (save-excursion
7802 (save-match-data
7803 (org-backward-heading-same-level
7804 1 invisible-ok))
7805 (= (point) (match-beginning 0)))
7806 (not (org-previous-line-empty-p t)))
7807 (setq empty-line-p (or empty-line-p
7808 (org-previous-line-empty-p))))
7809 (match-string 0))
7810 (error (or fix-level "* ")))))
7811 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7812 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7813 pos hide-previous previous-pos)
7815 ;; If we insert after content, move there and clean up
7816 ;; whitespace.
7817 (when (and respect-content
7818 (not (org-looking-at-p org-outline-regexp-bol)))
7819 (if (not (org-before-first-heading-p))
7820 (org-end-of-subtree nil t)
7821 (re-search-forward org-outline-regexp-bol)
7822 (beginning-of-line 0))
7823 (skip-chars-backward " \r\t\n")
7824 (and (not (looking-back "^\\*+"))
7825 (looking-at "[ \t]+") (replace-match ""))
7826 (unless (eobp) (forward-char 1))
7827 (when (looking-at "^\\*")
7828 (unless (bobp) (backward-char 1))
7829 (insert "\n")))
7831 ;; If we are splitting, grab the text that should be moved
7832 ;; to the new headline.
7833 (when may-split
7834 (if (org-on-heading-p)
7835 ;; This is a heading: split intelligently (keeping
7836 ;; tags).
7837 (let ((pos (point)))
7838 (beginning-of-line)
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) ?\s)))
7850 (setq initial-content (org-trim initial-content)))
7851 (goto-char pos))
7852 ;; A normal line.
7853 (setq initial-content
7854 (org-trim
7855 (delete-and-extract-region (point) (line-end-position))))))
7857 ;; If we are at the beginning of the line, insert before it.
7858 ;; Otherwise, after it.
7859 (cond
7860 ((and (bolp) (looking-at "[ \t]*$")))
7861 ((bolp) (open-line 1))
7862 (t (end-of-line)
7863 (insert "\n")))
7865 ;; Insert the new heading
7866 (insert stars)
7867 (just-one-space)
7868 (insert initial-content)
7869 (when (and adjust-empty-lines
7870 (not (and blank (org-previous-line-empty-p))))
7871 (org-N-empty-lines-before-current (if blank 1 0)))
7872 (run-hooks 'org-insert-heading-hook)))))))
7874 (defun org-N-empty-lines-before-current (N)
7875 "Make the number of empty lines before current exactly N.
7876 So this will delete or add empty lines."
7877 (save-excursion
7878 (beginning-of-line)
7879 (let ((p (point)))
7880 (skip-chars-backward " \r\t\n")
7881 (unless (bolp) (forward-line))
7882 (delete-region (point) p))
7883 (when (> N 0) (insert (make-string N ?\n)))))
7885 (defun org-get-heading (&optional no-tags no-todo)
7886 "Return the heading of the current entry, without the stars.
7887 When NO-TAGS is non-nil, don't include tags.
7888 When NO-TODO is non-nil, don't include TODO keywords."
7889 (save-excursion
7890 (org-back-to-heading t)
7891 (cond
7892 ((and no-tags no-todo)
7893 (looking-at org-complex-heading-regexp)
7894 (match-string 4))
7895 (no-tags
7896 (looking-at (concat org-outline-regexp
7897 "\\(.*?\\)"
7898 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7899 (match-string 1))
7900 (no-todo
7901 (looking-at org-todo-line-regexp)
7902 (match-string 3))
7903 (t (looking-at org-heading-regexp)
7904 (match-string 2)))))
7906 (defvar orgstruct-mode) ; defined below
7908 (defun org-heading-components ()
7909 "Return the components of the current heading.
7910 This is a list with the following elements:
7911 - the level as an integer
7912 - the reduced level, different if `org-odd-levels-only' is set.
7913 - the TODO keyword, or nil
7914 - the priority character, like ?A, or nil if no priority is given
7915 - the headline text itself, or the tags string if no headline text
7916 - the tags string, or nil."
7917 (save-excursion
7918 (org-back-to-heading t)
7919 (if (let (case-fold-search)
7920 (looking-at
7921 (if orgstruct-mode
7922 org-heading-regexp
7923 org-complex-heading-regexp)))
7924 (if orgstruct-mode
7925 (list (length (match-string 1))
7926 (org-reduced-level (length (match-string 1)))
7929 (match-string 2)
7930 nil)
7931 (list (length (match-string 1))
7932 (org-reduced-level (length (match-string 1)))
7933 (org-match-string-no-properties 2)
7934 (and (match-end 3) (aref (match-string 3) 2))
7935 (org-match-string-no-properties 4)
7936 (org-match-string-no-properties 5))))))
7938 (defun org-get-entry ()
7939 "Get the entry text, after heading, entire subtree."
7940 (save-excursion
7941 (org-back-to-heading t)
7942 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7944 (defun org-insert-heading-after-current ()
7945 "Insert a new heading with same level as current, after current subtree."
7946 (interactive)
7947 (org-back-to-heading)
7948 (org-insert-heading)
7949 (org-move-subtree-down)
7950 (end-of-line 1))
7952 (defun org-insert-heading-respect-content (&optional invisible-ok)
7953 "Insert heading with `org-insert-heading-respect-content' set to t."
7954 (interactive)
7955 (org-insert-heading '(4) invisible-ok))
7957 (defun org-insert-todo-heading-respect-content (&optional force-state)
7958 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7959 (interactive)
7960 (org-insert-todo-heading force-state '(4)))
7962 (defun org-insert-todo-heading (arg &optional force-heading)
7963 "Insert a new heading with the same level and TODO state as current heading.
7964 If the heading has no TODO state, or if the state is DONE, use the first
7965 state (TODO by default). Also with one prefix arg, force first state. With
7966 two prefix args, force inserting at the end of the parent subtree."
7967 (interactive "P")
7968 (when (or force-heading (not (org-insert-item 'checkbox)))
7969 (org-insert-heading (or (and (equal arg '(16)) '(16))
7970 force-heading))
7971 (save-excursion
7972 (org-back-to-heading)
7973 (outline-previous-heading)
7974 (looking-at org-todo-line-regexp))
7975 (let*
7976 ((new-mark-x
7977 (if (or (equal arg '(4))
7978 (not (match-beginning 2))
7979 (member (match-string 2) org-done-keywords))
7980 (car org-todo-keywords-1)
7981 (match-string 2)))
7982 (new-mark
7984 (run-hook-with-args-until-success
7985 'org-todo-get-default-hook new-mark-x nil)
7986 new-mark-x)))
7987 (beginning-of-line 1)
7988 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7989 (if org-treat-insert-todo-heading-as-state-change
7990 (org-todo new-mark)
7991 (insert new-mark " "))))
7992 (when org-provide-todo-statistics
7993 (org-update-parent-todo-statistics))))
7995 (defun org-insert-subheading (arg)
7996 "Insert a new subheading and demote it.
7997 Works for outline headings and for plain lists alike."
7998 (interactive "P")
7999 (org-insert-heading arg)
8000 (cond
8001 ((org-at-heading-p) (org-do-demote))
8002 ((org-at-item-p) (org-indent-item))))
8004 (defun org-insert-todo-subheading (arg)
8005 "Insert a new subheading with TODO keyword or checkbox and demote it.
8006 Works for outline headings and for plain lists alike."
8007 (interactive "P")
8008 (org-insert-todo-heading arg)
8009 (cond
8010 ((org-at-heading-p) (org-do-demote))
8011 ((org-at-item-p) (org-indent-item))))
8013 ;;; Promotion and Demotion
8015 (defvar org-after-demote-entry-hook nil
8016 "Hook run after an entry has been demoted.
8017 The cursor will be at the beginning of the entry.
8018 When a subtree is being demoted, the hook will be called for each node.")
8020 (defvar org-after-promote-entry-hook nil
8021 "Hook run after an entry has been promoted.
8022 The cursor will be at the beginning of the entry.
8023 When a subtree is being promoted, the hook will be called for each node.")
8025 (defun org-promote-subtree ()
8026 "Promote the entire subtree.
8027 See also `org-promote'."
8028 (interactive)
8029 (save-excursion
8030 (org-with-limited-levels (org-map-tree 'org-promote)))
8031 (org-fix-position-after-promote))
8033 (defun org-demote-subtree ()
8034 "Demote the entire subtree. See `org-demote'.
8035 See also `org-promote'."
8036 (interactive)
8037 (save-excursion
8038 (org-with-limited-levels (org-map-tree 'org-demote)))
8039 (org-fix-position-after-promote))
8042 (defun org-do-promote ()
8043 "Promote the current heading higher up the tree.
8044 If the region is active in `transient-mark-mode', promote all headings
8045 in the region."
8046 (interactive)
8047 (save-excursion
8048 (if (org-region-active-p)
8049 (org-map-region 'org-promote (region-beginning) (region-end))
8050 (org-promote)))
8051 (org-fix-position-after-promote))
8053 (defun org-do-demote ()
8054 "Demote the current heading lower down the tree.
8055 If the region is active in `transient-mark-mode', demote all headings
8056 in the region."
8057 (interactive)
8058 (save-excursion
8059 (if (org-region-active-p)
8060 (org-map-region 'org-demote (region-beginning) (region-end))
8061 (org-demote)))
8062 (org-fix-position-after-promote))
8064 (defun org-fix-position-after-promote ()
8065 "Make sure that after pro/demotion cursor position is right."
8066 (let ((pos (point)))
8067 (when (save-excursion
8068 (beginning-of-line 1)
8069 (looking-at org-todo-line-regexp)
8070 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8071 (cond ((eobp) (insert " "))
8072 ((eolp) (insert " "))
8073 ((equal (char-after) ?\ ) (forward-char 1))))))
8075 (defun org-current-level ()
8076 "Return the level of the current entry, or nil if before the first headline.
8077 The level is the number of stars at the beginning of the
8078 headline. Use `org-reduced-level' to remove the effect of
8079 `org-odd-levels'. Unlike to `org-outline-level', this function
8080 ignores inlinetasks."
8081 (let ((level (org-with-limited-levels (org-outline-level))))
8082 (and (> level 0) level)))
8084 (defun org-get-previous-line-level ()
8085 "Return the outline depth of the last headline before the current line.
8086 Returns 0 for the first headline in the buffer, and nil if before the
8087 first headline."
8088 (and (org-current-level)
8089 (or (and (/= (line-beginning-position) (point-min))
8090 (save-excursion (beginning-of-line 0) (org-current-level)))
8091 0)))
8093 (defun org-reduced-level (l)
8094 "Compute the effective level of a heading.
8095 This takes into account the setting of `org-odd-levels-only'."
8096 (cond
8097 ((zerop l) 0)
8098 (org-odd-levels-only (1+ (floor (/ l 2))))
8099 (t l)))
8101 (defun org-level-increment ()
8102 "Return the number of stars that will be added or removed at a
8103 time to headlines when structure editing, based on the value of
8104 `org-odd-levels-only'."
8105 (if org-odd-levels-only 2 1))
8107 (defun org-get-valid-level (level &optional change)
8108 "Rectify a level change under the influence of `org-odd-levels-only'
8109 LEVEL is a current level, CHANGE is by how much the level should be
8110 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8111 even level numbers will become the next higher odd number."
8112 (if org-odd-levels-only
8113 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8114 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8115 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8116 (max 1 (+ level (or change 0)))))
8118 (if (boundp 'define-obsolete-function-alias)
8119 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8120 (define-obsolete-function-alias 'org-get-legal-level
8121 'org-get-valid-level)
8122 (define-obsolete-function-alias 'org-get-legal-level
8123 'org-get-valid-level "23.1")))
8125 (defun org-promote ()
8126 "Promote the current heading higher up the tree."
8127 (org-with-wide-buffer
8128 (org-back-to-heading t)
8129 (let* ((after-change-functions (remq 'flyspell-after-change-function
8130 after-change-functions))
8131 (level (save-match-data (funcall outline-level)))
8132 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8133 (diff (abs (- level (length up-head) -1))))
8134 (cond
8135 ((and (= level 1) org-allow-promoting-top-level-subtree)
8136 (replace-match "# " nil t))
8137 ((= level 1)
8138 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8139 (t (replace-match up-head nil t)))
8140 (unless (= level 1)
8141 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8142 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8143 (run-hooks 'org-after-promote-entry-hook))))
8145 (defun org-demote ()
8146 "Demote the current heading lower down the tree."
8147 (org-with-wide-buffer
8148 (org-back-to-heading t)
8149 (let* ((after-change-functions (remq 'flyspell-after-change-function
8150 after-change-functions))
8151 (level (save-match-data (funcall outline-level)))
8152 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8153 (diff (abs (- level (length down-head) -1))))
8154 (replace-match down-head nil t)
8155 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8156 (when org-adapt-indentation (org-fixup-indentation diff))
8157 (run-hooks 'org-after-demote-entry-hook))))
8159 (defun org-cycle-level ()
8160 "Cycle the level of an empty headline through possible states.
8161 This goes first to child, then to parent, level, then up the hierarchy.
8162 After top level, it switches back to sibling level."
8163 (interactive)
8164 (let ((org-adapt-indentation nil))
8165 (when (org-point-at-end-of-empty-headline)
8166 (setq this-command 'org-cycle-level) ; Only needed for caching
8167 (let ((cur-level (org-current-level))
8168 (prev-level (org-get-previous-line-level)))
8169 (cond
8170 ;; If first headline in file, promote to top-level.
8171 ((= prev-level 0)
8172 (loop repeat (/ (- cur-level 1) (org-level-increment))
8173 do (org-do-promote)))
8174 ;; If same level as prev, demote one.
8175 ((= prev-level cur-level)
8176 (org-do-demote))
8177 ;; If parent is top-level, promote to top level if not already.
8178 ((= prev-level 1)
8179 (loop repeat (/ (- cur-level 1) (org-level-increment))
8180 do (org-do-promote)))
8181 ;; If top-level, return to prev-level.
8182 ((= cur-level 1)
8183 (loop repeat (/ (- prev-level 1) (org-level-increment))
8184 do (org-do-demote)))
8185 ;; If less than prev-level, promote one.
8186 ((< cur-level prev-level)
8187 (org-do-promote))
8188 ;; If deeper than prev-level, promote until higher than
8189 ;; prev-level.
8190 ((> cur-level prev-level)
8191 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8192 do (org-do-promote))))
8193 t))))
8195 (defun org-map-tree (fun)
8196 "Call FUN for every heading underneath the current one."
8197 (org-back-to-heading)
8198 (let ((level (funcall outline-level)))
8199 (save-excursion
8200 (funcall fun)
8201 (while (and (progn
8202 (outline-next-heading)
8203 (> (funcall outline-level) level))
8204 (not (eobp)))
8205 (funcall fun)))))
8207 (defun org-map-region (fun beg end)
8208 "Call FUN for every heading between BEG and END."
8209 (let ((org-ignore-region t))
8210 (save-excursion
8211 (setq end (copy-marker end))
8212 (goto-char beg)
8213 (if (and (re-search-forward org-outline-regexp-bol nil t)
8214 (< (point) end))
8215 (funcall fun))
8216 (while (and (progn
8217 (outline-next-heading)
8218 (< (point) end))
8219 (not (eobp)))
8220 (funcall fun)))))
8222 (defun org-fixup-indentation (diff)
8223 "Change the indentation in the current entry by DIFF.
8225 DIFF is an integer. Indentation is done according to the
8226 following rules:
8228 - Planning information and property drawers are always indented
8229 according to the new level of the headline;
8231 - Footnote definitions and their contents are ignored;
8233 - Inlinetasks' boundaries are not shifted;
8235 - Empty lines are ignored;
8237 - Other lines' indentation are shifted by DIFF columns, unless
8238 it would introduce a structural change in the document, in
8239 which case no shifting is done at all.
8241 Assume point is at a heading or an inlinetask beginning."
8242 (org-with-wide-buffer
8243 (narrow-to-region (line-beginning-position)
8244 (save-excursion
8245 (if (org-with-limited-levels (org-at-heading-p))
8246 (org-with-limited-levels (outline-next-heading))
8247 (org-inlinetask-goto-end))
8248 (point)))
8249 (forward-line)
8250 ;; Indent properly planning info and property drawer.
8251 (when (org-looking-at-p org-planning-line-re)
8252 (org-indent-line)
8253 (forward-line))
8254 (when (looking-at org-property-drawer-re)
8255 (goto-char (match-end 0))
8256 (forward-line)
8257 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8258 (catch 'no-shift
8259 (when (zerop diff) (throw 'no-shift nil))
8260 ;; If DIFF is negative, first check if a shift is possible at all
8261 ;; (e.g., it doesn't break structure). This can only happen if
8262 ;; some contents are not properly indented.
8263 (let ((case-fold-search t))
8264 (when (< diff 0)
8265 (let ((diff (- diff))
8266 (forbidden-re (concat org-outline-regexp
8267 "\\|"
8268 (substring org-footnote-definition-re 1))))
8269 (save-excursion
8270 (while (not (eobp))
8271 (cond
8272 ((org-looking-at-p "[ \t]*$") (forward-line))
8273 ((and (org-looking-at-p org-footnote-definition-re)
8274 (let ((e (org-element-at-point)))
8275 (and (eq (org-element-type e) 'footnote-definition)
8276 (goto-char (org-element-property :end e))))))
8277 ((org-looking-at-p org-outline-regexp) (forward-line))
8278 ;; Give up if shifting would move before column 0 or
8279 ;; if it would introduce a headline or a footnote
8280 ;; definition.
8282 (skip-chars-forward " \t")
8283 (let ((ind (current-column)))
8284 (when (or (< ind diff)
8285 (and (= ind diff) (org-looking-at-p forbidden-re)))
8286 (throw 'no-shift nil)))
8287 ;; Ignore contents of example blocks and source
8288 ;; blocks if their indentation is meant to be
8289 ;; preserved. Jump to block's closing line.
8290 (beginning-of-line)
8291 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8292 (let ((e (org-element-at-point)))
8293 (and (memq (org-element-type e)
8294 '(example-block src-block))
8295 (or org-src-preserve-indentation
8296 (org-element-property :preserve-indent e))
8297 (goto-char (org-element-property :end e))
8298 (progn (skip-chars-backward " \r\t\n")
8299 (beginning-of-line)
8300 t))))
8301 (forward-line))))))))
8302 ;; Shift lines but footnote definitions, inlinetasks boundaries
8303 ;; by DIFF. Also skip contents of source or example blocks
8304 ;; when indentation is meant to be preserved.
8305 (while (not (eobp))
8306 (cond
8307 ((and (org-looking-at-p org-footnote-definition-re)
8308 (let ((e (org-element-at-point)))
8309 (and (eq (org-element-type e) 'footnote-definition)
8310 (goto-char (org-element-property :end e))))))
8311 ((org-looking-at-p org-outline-regexp) (forward-line))
8312 ((org-looking-at-p "[ \t]*$") (forward-line))
8314 (org-indent-line-to (+ (org-get-indentation) diff))
8315 (beginning-of-line)
8316 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8317 (let ((e (org-element-at-point)))
8318 (and (memq (org-element-type e)
8319 '(example-block src-block))
8320 (or org-src-preserve-indentation
8321 (org-element-property :preserve-indent e))
8322 (goto-char (org-element-property :end e))
8323 (progn (skip-chars-backward " \r\t\n")
8324 (beginning-of-line)
8325 t))))
8326 (forward-line)))))))))
8328 (defun org-convert-to-odd-levels ()
8329 "Convert an org-mode file with all levels allowed to one with odd levels.
8330 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8331 level 5 etc."
8332 (interactive)
8333 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8334 (let ((outline-level 'org-outline-level)
8335 (org-odd-levels-only nil) n)
8336 (save-excursion
8337 (goto-char (point-min))
8338 (while (re-search-forward "^\\*\\*+ " nil t)
8339 (setq n (- (length (match-string 0)) 2))
8340 (while (>= (setq n (1- n)) 0)
8341 (org-demote))
8342 (end-of-line 1))))))
8344 (defun org-convert-to-oddeven-levels ()
8345 "Convert an org-mode file with only odd levels to one with odd/even levels.
8346 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8347 file contains a section with an even level, conversion would
8348 destroy the structure of the file. An error is signaled in this
8349 case."
8350 (interactive)
8351 (goto-char (point-min))
8352 ;; First check if there are no even levels
8353 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8354 (org-show-set-visibility 'canonical)
8355 (error "Not all levels are odd in this file. Conversion not possible"))
8356 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8357 (let ((outline-regexp org-outline-regexp)
8358 (outline-level 'org-outline-level)
8359 (org-odd-levels-only nil) n)
8360 (save-excursion
8361 (goto-char (point-min))
8362 (while (re-search-forward "^\\*\\*+ " nil t)
8363 (setq n (/ (1- (length (match-string 0))) 2))
8364 (while (>= (setq n (1- n)) 0)
8365 (org-promote))
8366 (end-of-line 1))))))
8368 (defun org-tr-level (n)
8369 "Make N odd if required."
8370 (if org-odd-levels-only (1+ (/ n 2)) n))
8372 ;;; Vertical tree motion, cutting and pasting of subtrees
8374 (defun org-move-subtree-up (&optional arg)
8375 "Move the current subtree up past ARG headlines of the same level."
8376 (interactive "p")
8377 (org-move-subtree-down (- (prefix-numeric-value arg))))
8379 (defun org-move-subtree-down (&optional arg)
8380 "Move the current subtree down past ARG headlines of the same level."
8381 (interactive "p")
8382 (setq arg (prefix-numeric-value arg))
8383 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8384 'org-get-last-sibling))
8385 (ins-point (make-marker))
8386 (cnt (abs arg))
8387 (col (current-column))
8388 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8389 ;; Select the tree
8390 (org-back-to-heading)
8391 (setq beg0 (point))
8392 (save-excursion
8393 (setq ne-beg (org-back-over-empty-lines))
8394 (setq beg (point)))
8395 (save-match-data
8396 (save-excursion (outline-end-of-heading)
8397 (setq folded (outline-invisible-p)))
8398 (progn (org-end-of-subtree nil t)
8399 (unless (eobp) (backward-char))))
8400 (outline-next-heading)
8401 (setq ne-end (org-back-over-empty-lines))
8402 (setq end (point))
8403 (goto-char beg0)
8404 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8405 ;; include less whitespace
8406 (save-excursion
8407 (goto-char beg)
8408 (forward-line (- ne-beg ne-end))
8409 (setq beg (point))))
8410 ;; Find insertion point, with error handling
8411 (while (> cnt 0)
8412 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8413 (progn (goto-char beg0)
8414 (user-error "Cannot move past superior level or buffer limit")))
8415 (setq cnt (1- cnt)))
8416 (if (> arg 0)
8417 ;; Moving forward - still need to move over subtree
8418 (progn (org-end-of-subtree t t)
8419 (save-excursion
8420 (org-back-over-empty-lines)
8421 (or (bolp) (newline)))))
8422 (setq ne-ins (org-back-over-empty-lines))
8423 (move-marker ins-point (point))
8424 (setq txt (buffer-substring beg end))
8425 (org-save-markers-in-region beg end)
8426 (delete-region beg end)
8427 (org-remove-empty-overlays-at beg)
8428 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8429 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8430 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8431 (let ((bbb (point)))
8432 (insert-before-markers txt)
8433 (org-reinstall-markers-in-region bbb)
8434 (move-marker ins-point bbb))
8435 (or (bolp) (insert "\n"))
8436 (setq ins-end (point))
8437 (goto-char ins-point)
8438 (org-skip-whitespace)
8439 (when (and (< arg 0)
8440 (org-first-sibling-p)
8441 (> ne-ins ne-beg))
8442 ;; Move whitespace back to beginning
8443 (save-excursion
8444 (goto-char ins-end)
8445 (let ((kill-whole-line t))
8446 (kill-line (- ne-ins ne-beg)) (point)))
8447 (insert (make-string (- ne-ins ne-beg) ?\n)))
8448 (move-marker ins-point nil)
8449 (if folded
8450 (hide-subtree)
8451 (org-show-entry)
8452 (show-children)
8453 (org-cycle-hide-drawers 'children))
8454 (org-clean-visibility-after-subtree-move)
8455 ;; move back to the initial column we were at
8456 (move-to-column col)))
8458 (defvar org-subtree-clip ""
8459 "Clipboard for cut and paste of subtrees.
8460 This is actually only a copy of the kill, because we use the normal kill
8461 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8463 (defvar org-subtree-clip-folded nil
8464 "Was the last copied subtree folded?
8465 This is used to fold the tree back after pasting.")
8467 (defun org-cut-subtree (&optional n)
8468 "Cut the current subtree into the clipboard.
8469 With prefix arg N, cut this many sequential subtrees.
8470 This is a short-hand for marking the subtree and then cutting it."
8471 (interactive "p")
8472 (org-copy-subtree n 'cut))
8474 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8475 "Copy the current subtree it in the clipboard.
8476 With prefix arg N, copy this many sequential subtrees.
8477 This is a short-hand for marking the subtree and then copying it.
8478 If CUT is non-nil, actually cut the subtree.
8479 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8480 of some markers in the region, even if CUT is non-nil. This is
8481 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8482 (interactive "p")
8483 (let (beg end folded (beg0 (point)))
8484 (if (org-called-interactively-p 'any)
8485 (org-back-to-heading nil) ; take what looks like a subtree
8486 (org-back-to-heading t)) ; take what is really there
8487 (setq beg (point))
8488 (skip-chars-forward " \t\r\n")
8489 (save-match-data
8490 (if nosubtrees
8491 (outline-next-heading)
8492 (save-excursion (outline-end-of-heading)
8493 (setq folded (outline-invisible-p)))
8494 (ignore-errors (org-forward-heading-same-level (1- n) t))
8495 (org-end-of-subtree t t)))
8496 (setq end (point))
8497 (goto-char beg0)
8498 (when (> end beg)
8499 (setq org-subtree-clip-folded folded)
8500 (when (or cut force-store-markers)
8501 (org-save-markers-in-region beg end))
8502 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8503 (setq org-subtree-clip (current-kill 0))
8504 (message "%s: Subtree(s) with %d characters"
8505 (if cut "Cut" "Copied")
8506 (length org-subtree-clip)))))
8508 (defun org-paste-subtree (&optional level tree for-yank remove)
8509 "Paste the clipboard as a subtree, with modification of headline level.
8510 The entire subtree is promoted or demoted in order to match a new headline
8511 level.
8513 If the cursor is at the beginning of a headline, the same level as
8514 that headline is used to paste the tree.
8516 If not, the new level is derived from the *visible* headings
8517 before and after the insertion point, and taken to be the inferior headline
8518 level of the two. So if the previous visible heading is level 3 and the
8519 next is level 4 (or vice versa), level 4 will be used for insertion.
8520 This makes sure that the subtree remains an independent subtree and does
8521 not swallow low level entries.
8523 You can also force a different level, either by using a numeric prefix
8524 argument, or by inserting the heading marker by hand. For example, if the
8525 cursor is after \"*****\", then the tree will be shifted to level 5.
8527 If optional TREE is given, use this text instead of the kill ring.
8529 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8530 move back over whitespace before inserting, and move point to the end of
8531 the inserted text when done.
8533 When REMOVE is non-nil, remove the subtree from the clipboard."
8534 (interactive "P")
8535 (setq tree (or tree (and kill-ring (current-kill 0))))
8536 (unless (org-kill-is-subtree-p tree)
8537 (user-error "%s"
8538 (substitute-command-keys
8539 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8540 (org-with-limited-levels
8541 (let* ((visp (not (outline-invisible-p)))
8542 (txt tree)
8543 (^re_ "\\(\\*+\\)[ \t]*")
8544 (old-level (if (string-match org-outline-regexp-bol txt)
8545 (- (match-end 0) (match-beginning 0) 1)
8546 -1))
8547 (force-level (cond (level (prefix-numeric-value level))
8548 ((and (looking-at "[ \t]*$")
8549 (string-match
8550 "^\\*+$" (buffer-substring
8551 (point-at-bol) (point))))
8552 (- (match-end 0) (match-beginning 0)))
8553 ((and (bolp)
8554 (looking-at org-outline-regexp))
8555 (- (match-end 0) (point) 1))))
8556 (previous-level (save-excursion
8557 (condition-case nil
8558 (progn
8559 (outline-previous-visible-heading 1)
8560 (if (looking-at ^re_)
8561 (- (match-end 0) (match-beginning 0) 1)
8563 (error 1))))
8564 (next-level (save-excursion
8565 (condition-case nil
8566 (progn
8567 (or (looking-at org-outline-regexp)
8568 (outline-next-visible-heading 1))
8569 (if (looking-at ^re_)
8570 (- (match-end 0) (match-beginning 0) 1)
8572 (error 1))))
8573 (new-level (or force-level (max previous-level next-level)))
8574 (shift (if (or (= old-level -1)
8575 (= new-level -1)
8576 (= old-level new-level))
8578 (- new-level old-level)))
8579 (delta (if (> shift 0) -1 1))
8580 (func (if (> shift 0) 'org-demote 'org-promote))
8581 (org-odd-levels-only nil)
8582 beg end newend)
8583 ;; Remove the forced level indicator
8584 (if force-level
8585 (delete-region (point-at-bol) (point)))
8586 ;; Paste
8587 (beginning-of-line (if (bolp) 1 2))
8588 (setq beg (point))
8589 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8590 (insert-before-markers txt)
8591 (unless (string-match "\n\\'" txt) (insert "\n"))
8592 (setq newend (point))
8593 (org-reinstall-markers-in-region beg)
8594 (setq end (point))
8595 (goto-char beg)
8596 (skip-chars-forward " \t\n\r")
8597 (setq beg (point))
8598 (if (and (outline-invisible-p) visp)
8599 (save-excursion (outline-show-heading)))
8600 ;; Shift if necessary
8601 (unless (= shift 0)
8602 (save-restriction
8603 (narrow-to-region beg end)
8604 (while (not (= shift 0))
8605 (org-map-region func (point-min) (point-max))
8606 (setq shift (+ delta shift)))
8607 (goto-char (point-min))
8608 (setq newend (point-max))))
8609 (when (or (org-called-interactively-p 'interactive) for-yank)
8610 (message "Clipboard pasted as level %d subtree" new-level))
8611 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8612 kill-ring
8613 (eq org-subtree-clip (current-kill 0))
8614 org-subtree-clip-folded)
8615 ;; The tree was folded before it was killed/copied
8616 (hide-subtree))
8617 (and for-yank (goto-char newend))
8618 (and remove (setq kill-ring (cdr kill-ring))))))
8620 (defun org-kill-is-subtree-p (&optional txt)
8621 "Check if the current kill is an outline subtree, or a set of trees.
8622 Returns nil if kill does not start with a headline, or if the first
8623 headline level is not the largest headline level in the tree.
8624 So this will actually accept several entries of equal levels as well,
8625 which is OK for `org-paste-subtree'.
8626 If optional TXT is given, check this string instead of the current kill."
8627 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8628 (re (org-get-limited-outline-regexp))
8629 (^re (concat "^" re))
8630 (start-level (and kill
8631 (string-match
8632 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8633 kill)
8634 (- (match-end 2) (match-beginning 2) 1)))
8635 (start (1+ (or (match-beginning 2) -1))))
8636 (if (not start-level)
8637 (progn
8638 nil) ;; does not even start with a heading
8639 (catch 'exit
8640 (while (setq start (string-match ^re kill (1+ start)))
8641 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8642 (throw 'exit nil)))
8643 t))))
8645 (defvar org-markers-to-move nil
8646 "Markers that should be moved with a cut-and-paste operation.
8647 Those markers are stored together with their positions relative to
8648 the start of the region.")
8650 (defun org-save-markers-in-region (beg end)
8651 "Check markers in region.
8652 If these markers are between BEG and END, record their position relative
8653 to BEG, so that after moving the block of text, we can put the markers back
8654 into place.
8655 This function gets called just before an entry or tree gets cut from the
8656 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8657 called immediately, to move the markers with the entries."
8658 (setq org-markers-to-move nil)
8659 (when (featurep 'org-clock)
8660 (org-clock-save-markers-for-cut-and-paste beg end))
8661 (when (featurep 'org-agenda)
8662 (org-agenda-save-markers-for-cut-and-paste beg end)))
8664 (defun org-check-and-save-marker (marker beg end)
8665 "Check if MARKER is between BEG and END.
8666 If yes, remember the marker and the distance to BEG."
8667 (when (and (marker-buffer marker)
8668 (equal (marker-buffer marker) (current-buffer)))
8669 (if (and (>= marker beg) (< marker end))
8670 (push (cons marker (- marker beg)) org-markers-to-move))))
8672 (defun org-reinstall-markers-in-region (beg)
8673 "Move all remembered markers to their position relative to BEG."
8674 (mapc (lambda (x)
8675 (move-marker (car x) (+ beg (cdr x))))
8676 org-markers-to-move)
8677 (setq org-markers-to-move nil))
8679 (defun org-narrow-to-subtree ()
8680 "Narrow buffer to the current subtree."
8681 (interactive)
8682 (save-excursion
8683 (save-match-data
8684 (org-with-limited-levels
8685 (narrow-to-region
8686 (progn (org-back-to-heading t) (point))
8687 (progn (org-end-of-subtree t t)
8688 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8689 (point)))))))
8691 (defun org-narrow-to-block ()
8692 "Narrow buffer to the current block."
8693 (interactive)
8694 (let* ((case-fold-search t)
8695 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8696 "^[ \t]*#\\+end_.*")))
8697 (if blockp
8698 (narrow-to-region (car blockp) (cdr blockp))
8699 (user-error "Not in a block"))))
8701 (defun org-clone-subtree-with-time-shift (n &optional shift)
8702 "Clone the task (subtree) at point N times.
8703 The clones will be inserted as siblings.
8705 In interactive use, the user will be prompted for the number of
8706 clones to be produced. If the entry has a timestamp, the user
8707 will also be prompted for a time shift, which may be a repeater
8708 as used in time stamps, for example `+3d'. To disable this,
8709 you can call the function with a universal prefix argument.
8711 When a valid repeater is given and the entry contains any time
8712 stamps, the clones will become a sequence in time, with time
8713 stamps in the subtree shifted for each clone produced. If SHIFT
8714 is nil or the empty string, time stamps will be left alone. The
8715 ID property of the original subtree is removed.
8717 If the original subtree did contain time stamps with a repeater,
8718 the following will happen:
8719 - the repeater will be removed in each clone
8720 - an additional clone will be produced, with the current, unshifted
8721 date(s) in the entry.
8722 - the original entry will be placed *after* all the clones, with
8723 repeater intact.
8724 - the start days in the repeater in the original entry will be shifted
8725 to past the last clone.
8726 In this way you can spell out a number of instances of a repeating task,
8727 and still retain the repeater to cover future instances of the task."
8728 (interactive "nNumber of clones to produce: ")
8729 (let ((shift
8730 (or shift
8731 (if (and (not (equal current-prefix-arg '(4)))
8732 (save-excursion
8733 (re-search-forward org-ts-regexp-both
8734 (save-excursion
8735 (org-end-of-subtree t)
8736 (point)) t)))
8737 (read-from-minibuffer
8738 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8739 ""))) ;; No time shift
8740 (n-no-remove -1)
8741 (drawer-re org-drawer-regexp)
8742 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8743 beg end template task idprop
8744 shift-n shift-what doshift nmin nmax)
8745 (if (not (and (integerp n) (> n 0)))
8746 (user-error "Invalid number of replications %s" n))
8747 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8748 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8749 shift)))
8750 (user-error "Invalid shift specification %s" shift))
8751 (when doshift
8752 (setq shift-n (string-to-number (match-string 1 shift))
8753 shift-what (cdr (assoc (match-string 2 shift)
8754 '(("d" . day) ("w" . week)
8755 ("m" . month) ("y" . year))))))
8756 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8757 (setq nmin 1 nmax n)
8758 (org-back-to-heading t)
8759 (setq beg (point))
8760 (setq idprop (org-entry-get nil "ID"))
8761 (org-end-of-subtree t t)
8762 (or (bolp) (insert "\n"))
8763 (setq end (point))
8764 (setq template (buffer-substring beg end))
8765 (when (and doshift
8766 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8767 (delete-region beg end)
8768 (setq end beg)
8769 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8770 (goto-char end)
8771 (loop for n from nmin to nmax do
8772 ;; prepare clone
8773 (with-temp-buffer
8774 (insert template)
8775 (org-mode)
8776 (goto-char (point-min))
8777 (org-show-subtree)
8778 (and idprop (if org-clone-delete-id
8779 (org-entry-delete nil "ID")
8780 (org-id-get-create t)))
8781 (unless (= n 0)
8782 (while (re-search-forward org-clock-re nil t)
8783 (kill-whole-line))
8784 (goto-char (point-min))
8785 (while (re-search-forward drawer-re nil t)
8786 (org-remove-empty-drawer-at (point))))
8787 (goto-char (point-min))
8788 (when doshift
8789 (while (re-search-forward org-ts-regexp-both nil t)
8790 (org-timestamp-change (* n shift-n) shift-what))
8791 (unless (= n n-no-remove)
8792 (goto-char (point-min))
8793 (while (re-search-forward org-ts-regexp nil t)
8794 (save-excursion
8795 (goto-char (match-beginning 0))
8796 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8797 (delete-region (match-beginning 1) (match-end 1)))))))
8798 (setq task (buffer-string)))
8799 (insert task))
8800 (goto-char beg)))
8802 ;;; Outline Sorting
8804 (defun org-sort (with-case)
8805 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8806 Optional argument WITH-CASE means sort case-sensitively."
8807 (interactive "P")
8808 (cond
8809 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8810 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8812 (org-call-with-arg 'org-sort-entries with-case))))
8814 (defun org-sort-remove-invisible (s)
8815 "Remove invisible links from string S."
8816 (remove-text-properties 0 (length s) org-rm-props s)
8817 (while (string-match org-bracket-link-regexp s)
8818 (setq s (replace-match (if (match-end 2)
8819 (match-string 3 s)
8820 (match-string 1 s)) t t s)))
8821 (let ((st (format " %s " s)))
8822 (while (string-match org-emph-re st)
8823 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8824 (setq s (substring st 1 -1)))
8827 (defvar org-priority-regexp) ; defined later in the file
8829 (defvar org-after-sorting-entries-or-items-hook nil
8830 "Hook that is run after a bunch of entries or items have been sorted.
8831 When children are sorted, the cursor is in the parent line when this
8832 hook gets called. When a region or a plain list is sorted, the cursor
8833 will be in the first entry of the sorted region/list.")
8835 (defun org-sort-entries
8836 (&optional with-case sorting-type getkey-func compare-func property)
8837 "Sort entries on a certain level of an outline tree.
8838 If there is an active region, the entries in the region are sorted.
8839 Else, if the cursor is before the first entry, sort the top-level items.
8840 Else, the children of the entry at point are sorted.
8842 Sorting can be alphabetically, numerically, by date/time as given by
8843 a time stamp, by a property, by priority order, or by a custom function.
8845 The command prompts for the sorting type unless it has been given to the
8846 function through the SORTING-TYPE argument, which needs to be a character,
8847 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8848 the precise meaning of each character:
8850 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8851 c By creation time, which is assumed to be the first inactive time stamp
8852 at the beginning of a line.
8853 d By deadline date/time.
8854 k By clocking time.
8855 n Numerically, by converting the beginning of the entry/item to a number.
8856 o By order of TODO keywords.
8857 p By priority according to the cookie.
8858 r By the value of a property.
8859 s By scheduled date/time.
8860 t By date/time, either the first active time stamp in the entry, or, if
8861 none exist, by the first inactive one.
8863 Capital letters will reverse the sort order.
8865 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8866 called with point at the beginning of the record. It must return either
8867 a string or a number that should serve as the sorting key for that record.
8869 Comparing entries ignores case by default. However, with an optional argument
8870 WITH-CASE, the sorting considers case as well.
8872 Sorting is done against the visible part of the headlines, it ignores hidden
8873 links.
8875 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8876 (interactive "P")
8877 (let ((case-func (if with-case 'identity 'downcase))
8878 (cmstr
8879 ;; The clock marker is lost when using `sort-subr', let's
8880 ;; store the clocking string.
8881 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8882 (save-excursion
8883 (goto-char org-clock-marker)
8884 (looking-back "^.*") (match-string-no-properties 0))))
8885 start beg end stars re re2
8886 txt what tmp)
8887 ;; Find beginning and end of region to sort
8888 (cond
8889 ((org-region-active-p)
8890 ;; we will sort the region
8891 (setq end (region-end)
8892 what "region")
8893 (goto-char (region-beginning))
8894 (if (not (org-at-heading-p)) (outline-next-heading))
8895 (setq start (point)))
8896 ((or (org-at-heading-p)
8897 (ignore-errors (progn (org-back-to-heading) t)))
8898 ;; we will sort the children of the current headline
8899 (org-back-to-heading)
8900 (setq start (point)
8901 end (progn (org-end-of-subtree t t)
8902 (or (bolp) (insert "\n"))
8903 (when (>= (org-back-over-empty-lines) 1)
8904 (forward-line 1))
8905 (point))
8906 what "children")
8907 (goto-char start)
8908 (show-subtree)
8909 (outline-next-heading))
8911 ;; we will sort the top-level entries in this file
8912 (goto-char (point-min))
8913 (or (org-at-heading-p) (outline-next-heading))
8914 (setq start (point))
8915 (goto-char (point-max))
8916 (beginning-of-line 1)
8917 (when (looking-at ".*?\\S-")
8918 ;; File ends in a non-white line
8919 (end-of-line 1)
8920 (insert "\n"))
8921 (setq end (point-max))
8922 (setq what "top-level")
8923 (goto-char start)
8924 (show-all)))
8926 (setq beg (point))
8927 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8929 (looking-at "\\(\\*+\\)")
8930 (setq stars (match-string 1)
8931 re (concat "^" (regexp-quote stars) " +")
8932 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8933 txt (buffer-substring beg end))
8934 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8935 (if (and (not (equal stars "*")) (string-match re2 txt))
8936 (user-error "Region to sort contains a level above the first entry"))
8938 (unless sorting-type
8939 (message
8940 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8941 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8942 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8943 what)
8944 (setq sorting-type (read-char-exclusive))
8946 (unless getkey-func
8947 (and (= (downcase sorting-type) ?f)
8948 (setq getkey-func
8949 (org-icompleting-read "Sort using function: "
8950 obarray 'fboundp t nil nil))
8951 (setq getkey-func (intern getkey-func))))
8953 (and (= (downcase sorting-type) ?r)
8954 (not property)
8955 (setq property
8956 (org-icompleting-read "Property: "
8957 (mapcar 'list (org-buffer-property-keys t))
8958 nil t))))
8960 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8961 (message "Sorting entries...")
8963 (save-restriction
8964 (narrow-to-region start end)
8965 (let ((dcst (downcase sorting-type))
8966 (case-fold-search nil)
8967 (now (current-time)))
8968 (sort-subr
8969 (/= dcst sorting-type)
8970 ;; This function moves to the beginning character of the "record" to
8971 ;; be sorted.
8972 (lambda nil
8973 (if (re-search-forward re nil t)
8974 (goto-char (match-beginning 0))
8975 (goto-char (point-max))))
8976 ;; This function moves to the last character of the "record" being
8977 ;; sorted.
8978 (lambda nil
8979 (save-match-data
8980 (condition-case nil
8981 (outline-forward-same-level 1)
8982 (error
8983 (goto-char (point-max))))))
8984 ;; This function returns the value that gets sorted against.
8985 (lambda nil
8986 (cond
8987 ((= dcst ?n)
8988 (if (looking-at org-complex-heading-regexp)
8989 (string-to-number (org-sort-remove-invisible (match-string 4)))
8990 nil))
8991 ((= dcst ?a)
8992 (if (looking-at org-complex-heading-regexp)
8993 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8994 nil))
8995 ((= dcst ?k)
8996 (or (get-text-property (point) :org-clock-minutes) 0))
8997 ((= dcst ?t)
8998 (let ((end (save-excursion (outline-next-heading) (point))))
8999 (if (or (re-search-forward org-ts-regexp end t)
9000 (re-search-forward org-ts-regexp-both end t))
9001 (org-time-string-to-seconds (match-string 0))
9002 (org-float-time now))))
9003 ((= dcst ?c)
9004 (let ((end (save-excursion (outline-next-heading) (point))))
9005 (if (re-search-forward
9006 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9007 end t)
9008 (org-time-string-to-seconds (match-string 0))
9009 (org-float-time now))))
9010 ((= dcst ?s)
9011 (let ((end (save-excursion (outline-next-heading) (point))))
9012 (if (re-search-forward org-scheduled-time-regexp end t)
9013 (org-time-string-to-seconds (match-string 1))
9014 (org-float-time now))))
9015 ((= dcst ?d)
9016 (let ((end (save-excursion (outline-next-heading) (point))))
9017 (if (re-search-forward org-deadline-time-regexp end t)
9018 (org-time-string-to-seconds (match-string 1))
9019 (org-float-time now))))
9020 ((= dcst ?p)
9021 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9022 (string-to-char (match-string 2))
9023 org-default-priority))
9024 ((= dcst ?r)
9025 (or (org-entry-get nil property) ""))
9026 ((= dcst ?o)
9027 (if (looking-at org-complex-heading-regexp)
9028 (let* ((m (match-string 2))
9029 (s (if (member m org-done-keywords) '- '+)))
9030 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9031 ((= dcst ?f)
9032 (if getkey-func
9033 (progn
9034 (setq tmp (funcall getkey-func))
9035 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9036 tmp)
9037 (error "Invalid key function `%s'" getkey-func)))
9038 (t (error "Invalid sorting type `%c'" sorting-type))))
9040 (cond
9041 ((= dcst ?a) 'string<)
9042 ((= dcst ?f) compare-func)
9043 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9044 (run-hooks 'org-after-sorting-entries-or-items-hook)
9045 ;; Reset the clock marker if needed
9046 (when cmstr
9047 (save-excursion
9048 (goto-char start)
9049 (search-forward cmstr nil t)
9050 (move-marker org-clock-marker (point))))
9051 (message "Sorting entries...done")))
9053 ;;; The orgstruct minor mode
9055 ;; Define a minor mode which can be used in other modes in order to
9056 ;; integrate the org-mode structure editing commands.
9058 ;; This is really a hack, because the org-mode structure commands use
9059 ;; keys which normally belong to the major mode. Here is how it
9060 ;; works: The minor mode defines all the keys necessary to operate the
9061 ;; structure commands, but wraps the commands into a function which
9062 ;; tests if the cursor is currently at a headline or a plain list
9063 ;; item. If that is the case, the structure command is used,
9064 ;; temporarily setting many Org-mode variables like regular
9065 ;; expressions for filling etc. However, when any of those keys is
9066 ;; used at a different location, function uses `key-binding' to look
9067 ;; up if the key has an associated command in another currently active
9068 ;; keymap (minor modes, major mode, global), and executes that
9069 ;; command. There might be problems if any of the keys is otherwise
9070 ;; used as a prefix key.
9072 (defcustom orgstruct-heading-prefix-regexp ""
9073 "Regexp that matches the custom prefix of Org headlines in
9074 orgstruct(++)-mode."
9075 :group 'org
9076 :version "24.4"
9077 :package-version '(Org . "8.3")
9078 :type 'regexp)
9079 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9081 (defcustom orgstruct-setup-hook nil
9082 "Hook run after orgstruct-mode-map is filled."
9083 :group 'org
9084 :version "24.4"
9085 :package-version '(Org . "8.0")
9086 :type 'hook)
9088 (defvar orgstruct-initialized nil)
9090 (defvar org-local-vars nil
9091 "List of local variables, for use by `orgstruct-mode'.")
9093 ;;;###autoload
9094 (define-minor-mode orgstruct-mode
9095 "Toggle the minor mode `orgstruct-mode'.
9096 This mode is for using Org-mode structure commands in other
9097 modes. The following keys behave as if Org-mode were active, if
9098 the cursor is on a headline, or on a plain list item (both as
9099 defined by Org-mode)."
9100 nil " OrgStruct" (make-sparse-keymap)
9101 (funcall (if orgstruct-mode
9102 'add-to-invisibility-spec
9103 'remove-from-invisibility-spec)
9104 '(outline . t))
9105 (when orgstruct-mode
9106 (org-load-modules-maybe)
9107 (unless orgstruct-initialized
9108 (orgstruct-setup)
9109 (setq orgstruct-initialized t))))
9111 ;;;###autoload
9112 (defun turn-on-orgstruct ()
9113 "Unconditionally turn on `orgstruct-mode'."
9114 (orgstruct-mode 1))
9116 (defvar org-fb-vars nil)
9117 (make-variable-buffer-local 'org-fb-vars)
9118 (defun orgstruct++-mode (&optional arg)
9119 "Toggle `orgstruct-mode', the enhanced version of it.
9120 In addition to setting orgstruct-mode, this also exports all
9121 indentation and autofilling variables from org-mode into the
9122 buffer. It will also recognize item context in multiline items."
9123 (interactive "P")
9124 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9125 (if (< arg 1)
9126 (progn (orgstruct-mode -1)
9127 (mapc (lambda(v)
9128 (org-set-local (car v)
9129 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9130 org-fb-vars))
9131 (orgstruct-mode 1)
9132 (setq org-fb-vars nil)
9133 (unless org-local-vars
9134 (setq org-local-vars (org-get-local-variables)))
9135 (let (var val)
9136 (mapc
9137 (lambda (x)
9138 (when (string-match
9139 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9140 (symbol-name (car x)))
9141 (setq var (car x) val (nth 1 x))
9142 (push (list var `(quote ,(eval var))) org-fb-vars)
9143 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9144 org-local-vars)
9145 (org-set-local 'orgstruct-is-++ t))))
9147 (defvar orgstruct-is-++ nil
9148 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9149 (make-variable-buffer-local 'orgstruct-is-++)
9151 ;;;###autoload
9152 (defun turn-on-orgstruct++ ()
9153 "Unconditionally turn on `orgstruct++-mode'."
9154 (orgstruct++-mode 1))
9156 (defun orgstruct-error ()
9157 "Error when there is no default binding for a structure key."
9158 (interactive)
9159 (funcall (if (fboundp 'user-error)
9160 'user-error
9161 'error)
9162 "This key has no function outside structure elements"))
9164 (defun orgstruct-setup ()
9165 "Setup orgstruct keymap."
9166 (dolist (cell '((org-demote . t)
9167 (org-metaleft . t)
9168 (org-metaright . t)
9169 (org-promote . t)
9170 (org-shiftmetaleft . t)
9171 (org-shiftmetaright . t)
9172 org-backward-element
9173 org-backward-heading-same-level
9174 org-ctrl-c-ret
9175 org-ctrl-c-minus
9176 org-ctrl-c-star
9177 org-cycle
9178 org-forward-heading-same-level
9179 org-insert-heading
9180 org-insert-heading-respect-content
9181 org-kill-note-or-show-branches
9182 org-mark-subtree
9183 org-meta-return
9184 org-metadown
9185 org-metaup
9186 org-narrow-to-subtree
9187 org-promote-subtree
9188 org-reveal
9189 org-shiftdown
9190 org-shiftleft
9191 org-shiftmetadown
9192 org-shiftmetaup
9193 org-shiftright
9194 org-shifttab
9195 org-shifttab
9196 org-shiftup
9197 org-show-subtree
9198 org-sort
9199 org-up-element
9200 outline-demote
9201 outline-next-visible-heading
9202 outline-previous-visible-heading
9203 outline-promote
9204 outline-up-heading
9205 show-children))
9206 (let ((f (or (car-safe cell) cell))
9207 (disable-when-heading-prefix (cdr-safe cell)))
9208 (when (fboundp f)
9209 (let ((new-bindings))
9210 (dolist (binding (nconc (where-is-internal f org-mode-map)
9211 (where-is-internal f outline-mode-map)))
9212 (push binding new-bindings)
9213 ;; TODO use local-function-key-map
9214 (dolist (rep '(("<tab>" . "TAB")
9215 ("<return>" . "RET")
9216 ("<escape>" . "ESC")
9217 ("<delete>" . "DEL")))
9218 (setq binding (read-kbd-macro
9219 (let ((case-fold-search))
9220 (replace-regexp-in-string
9221 (regexp-quote (cdr rep))
9222 (car rep)
9223 (key-description binding)))))
9224 (pushnew binding new-bindings :test 'equal)))
9225 (dolist (binding new-bindings)
9226 (let ((key (lookup-key orgstruct-mode-map binding)))
9227 (when (or (not key) (numberp key))
9228 (ignore-errors
9229 (org-defkey orgstruct-mode-map
9230 binding
9231 (orgstruct-make-binding
9232 f binding disable-when-heading-prefix))))))))))
9233 (run-hooks 'orgstruct-setup-hook))
9235 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9236 "Create a function for binding in the structure minor mode.
9237 FUN is the command to call inside a table. KEY is the key that
9238 should be checked in for a command to execute outside of tables.
9239 Non-nil `disable-when-heading-prefix' means to disable the command
9240 if `orgstruct-heading-prefix-regexp' is not empty."
9241 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9242 (let ((nname name)
9243 (i 0))
9244 (while (fboundp (intern nname))
9245 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9246 (setq name (intern nname)))
9247 (eval
9248 (let ((bindings '((org-heading-regexp
9249 (concat "^"
9250 orgstruct-heading-prefix-regexp
9251 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9252 (org-outline-regexp
9253 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9254 (org-outline-regexp-bol
9255 (concat "^" org-outline-regexp))
9256 (outline-regexp org-outline-regexp)
9257 (outline-heading-end-regexp "\n")
9258 (outline-level 'org-outline-level)
9259 (outline-heading-alist))))
9260 `(defun ,name (arg)
9261 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9262 "Outside of structure, run the binding of `"
9263 (key-description key) "'."
9264 (when disable-when-heading-prefix
9265 (concat
9266 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9267 "back to the default binding due to limitations of Org's implementation of\n"
9268 "`" (symbol-name fun) "'.")))
9269 (interactive "p")
9270 (let* ((disable
9271 ,(and disable-when-heading-prefix
9272 '(not (string= orgstruct-heading-prefix-regexp ""))))
9273 (fallback
9274 (or disable
9275 (not
9276 (let* ,bindings
9277 (org-context-p 'headline 'item
9278 ,(when (memq fun
9279 '(org-insert-heading
9280 org-insert-heading-respect-content
9281 org-meta-return))
9282 '(when orgstruct-is-++
9283 'item-body))))))))
9284 (if fallback
9285 (let* ((orgstruct-mode)
9286 (binding
9287 (let ((key ,key))
9288 (catch 'exit
9289 (dolist
9290 (rep
9291 '(nil
9292 ("<\\([^>]*\\)tab>" . "\\1TAB")
9293 ("<\\([^>]*\\)return>" . "\\1RET")
9294 ("<\\([^>]*\\)escape>" . "\\1ESC")
9295 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9296 nil)
9297 (when rep
9298 (setq key (read-kbd-macro
9299 (let ((case-fold-search))
9300 (replace-regexp-in-string
9301 (car rep)
9302 (cdr rep)
9303 (key-description key))))))
9304 (when (key-binding key)
9305 (throw 'exit (key-binding key))))))))
9306 (if (keymapp binding)
9307 (org-set-transient-map binding)
9308 (let ((func (or binding
9309 (unless disable
9310 'orgstruct-error))))
9311 (when func
9312 (call-interactively func)))))
9313 (org-run-like-in-org-mode
9314 (lambda ()
9315 (interactive)
9316 (let* ,bindings
9317 (call-interactively ',fun)))))))))
9318 name))
9320 (defun org-contextualize-keys (alist contexts)
9321 "Return valid elements in ALIST depending on CONTEXTS.
9323 `org-agenda-custom-commands' or `org-capture-templates' are the
9324 values used for ALIST, and `org-agenda-custom-commands-contexts'
9325 or `org-capture-templates-contexts' are the associated contexts
9326 definitions."
9327 (let ((contexts
9328 ;; normalize contexts
9329 (mapcar
9330 (lambda(c) (cond ((listp (cadr c))
9331 (list (car c) (car c) (cadr c)))
9332 ((string= "" (cadr c))
9333 (list (car c) (car c) (caddr c)))
9334 (t c))) contexts))
9335 (a alist) c r s)
9336 ;; loop over all commands or templates
9337 (while (setq c (pop a))
9338 (let (vrules repl)
9339 (cond
9340 ((not (assoc (car c) contexts))
9341 (push c r))
9342 ((and (assoc (car c) contexts)
9343 (setq vrules (org-contextualize-validate-key
9344 (car c) contexts)))
9345 (mapc (lambda (vr)
9346 (when (not (equal (car vr) (cadr vr)))
9347 (setq repl vr))) vrules)
9348 (if (not repl) (push c r)
9349 (push (cadr repl) s)
9350 (push
9351 (cons (car c)
9352 (cdr (or (assoc (cadr repl) alist)
9353 (error "Undefined key `%s' as contextual replacement for `%s'"
9354 (cadr repl) (car c)))))
9355 r))))))
9356 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9357 (delq
9359 (delete-dups
9360 (mapcar (lambda (x)
9361 (let ((tpl (car x)))
9362 (when (not (delq
9364 (mapcar (lambda(y)
9365 (equal y tpl)) s))) x)))
9366 (reverse r))))))
9368 (defun org-contextualize-validate-key (key contexts)
9369 "Check CONTEXTS for agenda or capture KEY."
9370 (let (r rr res)
9371 (while (setq r (pop contexts))
9372 (mapc
9373 (lambda (rr)
9374 (when
9375 (and (equal key (car r))
9376 (if (functionp rr) (funcall rr)
9377 (or (and (eq (car rr) 'in-file)
9378 (buffer-file-name)
9379 (string-match (cdr rr) (buffer-file-name)))
9380 (and (eq (car rr) 'in-mode)
9381 (string-match (cdr rr) (symbol-name major-mode)))
9382 (and (eq (car rr) 'in-buffer)
9383 (string-match (cdr rr) (buffer-name)))
9384 (when (and (eq (car rr) 'not-in-file)
9385 (buffer-file-name))
9386 (not (string-match (cdr rr) (buffer-file-name))))
9387 (when (eq (car rr) 'not-in-mode)
9388 (not (string-match (cdr rr) (symbol-name major-mode))))
9389 (when (eq (car rr) 'not-in-buffer)
9390 (not (string-match (cdr rr) (buffer-name)))))))
9391 (push r res)))
9392 (car (last r))))
9393 (delete-dups (delq nil res))))
9395 (defun org-context-p (&rest contexts)
9396 "Check if local context is any of CONTEXTS.
9397 Possible values in the list of contexts are `table', `headline', and `item'."
9398 (let ((pos (point)))
9399 (goto-char (point-at-bol))
9400 (prog1 (or (and (memq 'table contexts)
9401 (looking-at "[ \t]*|"))
9402 (and (memq 'headline contexts)
9403 (looking-at org-outline-regexp))
9404 (and (memq 'item contexts)
9405 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9406 (and (memq 'item-body contexts)
9407 (org-in-item-p)))
9408 (goto-char pos))))
9410 (defun org-get-local-variables ()
9411 "Return a list of all local variables in an Org mode buffer."
9412 (let (varlist)
9413 (with-current-buffer (get-buffer-create "*Org tmp*")
9414 (erase-buffer)
9415 (org-mode)
9416 (setq varlist (buffer-local-variables)))
9417 (kill-buffer "*Org tmp*")
9418 (delq nil
9419 (mapcar
9420 (lambda (x)
9421 (setq x
9422 (if (symbolp x)
9423 (list x)
9424 (list (car x) (cdr x))))
9425 (if (and (not (get (car x) 'org-state))
9426 (string-match
9427 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9428 (symbol-name (car x))))
9429 x nil))
9430 varlist))))
9432 (defun org-clone-local-variables (from-buffer &optional regexp)
9433 "Clone local variables from FROM-BUFFER.
9434 Optional argument REGEXP selects variables to clone."
9435 (mapc
9436 (lambda (pair)
9437 (and (symbolp (car pair))
9438 (or (null regexp)
9439 (string-match regexp (symbol-name (car pair))))
9440 (set (make-local-variable (car pair))
9441 (cdr pair))))
9442 (buffer-local-variables from-buffer)))
9444 ;;;###autoload
9445 (defun org-run-like-in-org-mode (cmd)
9446 "Run a command, pretending that the current buffer is in Org-mode.
9447 This will temporarily bind local variables that are typically bound in
9448 Org-mode to the values they have in Org-mode, and then interactively
9449 call CMD."
9450 (org-load-modules-maybe)
9451 (unless org-local-vars
9452 (setq org-local-vars (org-get-local-variables)))
9453 (let (binds)
9454 (dolist (var org-local-vars)
9455 (when (or (not (boundp (car var)))
9456 (eq (symbol-value (car var))
9457 (default-value (car var))))
9458 (push (list (car var) `(quote ,(cadr var))) binds)))
9459 (eval `(let ,binds
9460 (call-interactively (quote ,cmd))))))
9462 (defun org-get-category (&optional pos force-refresh)
9463 "Get the category applying to position POS."
9464 (save-match-data
9465 (if force-refresh (org-refresh-category-properties))
9466 (let ((pos (or pos (point))))
9467 (or (get-text-property pos 'org-category)
9468 (progn (org-refresh-category-properties)
9469 (get-text-property pos 'org-category))))))
9471 ;;; Refresh properties
9473 (defun org-refresh-properties (dprop tprop)
9474 "Refresh buffer text properties.
9475 DPROP is the drawer property and TPROP is either the
9476 corresponding text property to set, or an alist with each element
9477 being a text property (as a symbol) and a function to apply to
9478 the value of the drawer property."
9479 (let ((case-fold-search t)
9480 (inhibit-read-only t))
9481 (org-with-silent-modifications
9482 (save-excursion
9483 (save-restriction
9484 (widen)
9485 (goto-char (point-min))
9486 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9487 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9489 (defun org-refresh-property (tprop p)
9490 "Refresh the buffer text property TPROP from the drawer property P.
9491 The refresh happens only for the current tree (not subtree)."
9492 (save-excursion
9493 (org-back-to-heading t)
9494 ;; tprop is a text property symbol
9495 (if (symbolp tprop)
9496 (put-text-property
9497 (point) (or (outline-next-heading) (point-max)) tprop p)
9498 ;; tprop is an alist with (properties . function) elements
9499 (mapc (lambda(al)
9500 (save-excursion
9501 (put-text-property
9502 (point-at-bol) (or (outline-next-heading) (point-max))
9503 (car al)
9504 (funcall (cdr al) p))))
9505 tprop))))
9507 (defun org-refresh-category-properties ()
9508 "Refresh category text properties in the buffer."
9509 (let ((case-fold-search t)
9510 (inhibit-read-only t)
9511 (def-cat (cond
9512 ((null org-category)
9513 (if buffer-file-name
9514 (file-name-sans-extension
9515 (file-name-nondirectory buffer-file-name))
9516 "???"))
9517 ((symbolp org-category) (symbol-name org-category))
9518 (t org-category)))
9519 beg end cat pos optionp)
9520 (org-with-silent-modifications
9521 (save-excursion
9522 (save-restriction
9523 (widen)
9524 (goto-char (point-min))
9525 (put-text-property (point) (point-max) 'org-category def-cat)
9526 (while (re-search-forward
9527 "^[ \t]*\\(\\(?:#\\+\\|:\\)CATEGORY:\\)\\(.*\\)" nil t)
9528 (setq pos (match-end 0)
9529 optionp (equal (char-after (match-beginning 0)) ?#)
9530 cat (org-trim (match-string 2)))
9531 (if optionp
9532 (setq beg (point-at-bol) end (point-max))
9533 (org-back-to-heading t)
9534 (setq beg (point) end (org-end-of-subtree t t)))
9535 (put-text-property beg end 'org-category cat)
9536 (goto-char pos)))))))
9538 (defun org-refresh-stats-properties ()
9539 "Refresh stats text properties in the buffer."
9540 (let (stats)
9541 (org-with-silent-modifications
9542 (save-excursion
9543 (save-restriction
9544 (widen)
9545 (goto-char (point-min))
9546 (while (re-search-forward
9547 (concat org-outline-regexp-bol ".*"
9548 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9549 nil t)
9550 (setq stats (cond ((equal (match-string 3) "0") 0)
9551 ((match-string 2)
9552 (/ (* (string-to-number (match-string 2)) 100)
9553 (string-to-number (match-string 3))))
9554 (t (string-to-number (match-string 1)))))
9555 (org-back-to-heading t)
9556 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9557 'org-stats stats)))))))
9559 (defun org-refresh-effort-properties ()
9560 "Refresh effort properties"
9561 (org-refresh-properties
9562 org-effort-property
9563 '((effort . identity)
9564 (effort-minutes . org-duration-string-to-minutes))))
9566 ;;;; Link Stuff
9568 ;;; Link abbreviations
9570 (defun org-link-expand-abbrev (link)
9571 "Apply replacements as defined in `org-link-abbrev-alist'."
9572 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9573 (let* ((key (match-string 1 link))
9574 (as (or (assoc key org-link-abbrev-alist-local)
9575 (assoc key org-link-abbrev-alist)))
9576 (tag (and (match-end 2) (match-string 3 link)))
9577 rpl)
9578 (if (not as)
9579 link
9580 (setq rpl (cdr as))
9581 (cond
9582 ((symbolp rpl) (funcall rpl tag))
9583 ((string-match "%(\\([^)]+\\))" rpl)
9584 (replace-match
9585 (save-match-data
9586 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9587 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9588 ((string-match "%h" rpl)
9589 (replace-match (url-hexify-string (or tag "")) t t rpl))
9590 (t (concat rpl tag)))))
9591 link))
9593 ;;; Storing and inserting links
9595 (defvar org-insert-link-history nil
9596 "Minibuffer history for links inserted with `org-insert-link'.")
9598 (defvar org-stored-links nil
9599 "Contains the links stored with `org-store-link'.")
9601 (defvar org-store-link-plist nil
9602 "Plist with info about the most recently link created with `org-store-link'.")
9604 (defvar org-link-protocols nil
9605 "Link protocols added to Org-mode using `org-add-link-type'.")
9607 (defvar org-store-link-functions nil
9608 "List of functions that are called to create and store a link.
9609 Each function will be called in turn until one returns a non-nil
9610 value. Each function should check if it is responsible for creating
9611 this link (for example by looking at the major mode).
9612 If not, it must exit and return nil.
9613 If yes, it should return a non-nil value after a calling
9614 `org-store-link-props' with a list of properties and values.
9615 Special properties are:
9617 :type The link prefix, like \"http\". This must be given.
9618 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9619 This is obligatory as well.
9620 :description Optional default description for the second pair
9621 of brackets in an Org-mode link. The user can still change
9622 this when inserting this link into an Org-mode buffer.
9624 In addition to these, any additional properties can be specified
9625 and then used in capture templates.")
9627 (defun org-add-link-type (type &optional follow export)
9628 "Add TYPE to the list of `org-link-types'.
9629 Re-compute all regular expressions depending on `org-link-types'
9631 FOLLOW and EXPORT are two functions.
9633 FOLLOW should take the link path as the single argument and do whatever
9634 is necessary to follow the link, for example find a file or display
9635 a mail message.
9637 EXPORT should format the link path for export to one of the export formats.
9638 It should be a function accepting three arguments:
9640 path the path of the link, the text after the prefix (like \"http:\")
9641 desc the description of the link, if any
9642 format the export format, a symbol like `html' or `latex' or `ascii'.
9644 The function may use the FORMAT information to return different values
9645 depending on the format. The return value will be put literally into
9646 the exported file. If the return value is nil, this means Org should
9647 do what it normally does with links which do not have EXPORT defined.
9649 Org mode has a built-in default for exporting links. If you are happy with
9650 this default, there is no need to define an export function for the link
9651 type. For a simple example of an export function, see `org-bbdb.el'."
9652 (add-to-list 'org-link-types type t)
9653 (org-make-link-regexps)
9654 (org-element-update-syntax)
9655 (if (assoc type org-link-protocols)
9656 (setcdr (assoc type org-link-protocols) (list follow export))
9657 (push (list type follow export) org-link-protocols)))
9659 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9660 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9662 ;;;###autoload
9663 (defun org-store-link (arg)
9664 "\\<org-mode-map>Store an org-link to the current location.
9665 This link is added to `org-stored-links' and can later be inserted
9666 into an org-buffer with \\[org-insert-link].
9668 For some link types, a prefix arg is interpreted.
9669 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9670 For file links, arg negates `org-context-in-file-links'.
9672 A double prefix arg force skipping storing functions that are not
9673 part of Org's core.
9675 A triple prefix arg force storing a link for each line in the
9676 active region."
9677 (interactive "P")
9678 (org-load-modules-maybe)
9679 (if (and (equal arg '(64)) (org-region-active-p))
9680 (save-excursion
9681 (let ((end (region-end)))
9682 (goto-char (region-beginning))
9683 (set-mark (point))
9684 (while (< (point-at-eol) end)
9685 (move-end-of-line 1) (activate-mark)
9686 (let (current-prefix-arg)
9687 (call-interactively 'org-store-link))
9688 (move-beginning-of-line 2)
9689 (set-mark (point)))))
9690 (org-with-limited-levels
9691 (setq org-store-link-plist nil)
9692 (let (link cpltxt desc description search
9693 txt custom-id agenda-link sfuns sfunsn)
9694 (cond
9696 ;; Store a link using an external link type
9697 ((and (not (equal arg '(16)))
9698 (setq sfuns
9699 (delq
9700 nil (mapcar (lambda (f)
9701 (let (fs) (if (funcall f) (push f fs))))
9702 org-store-link-functions))
9703 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9704 (or (and (cdr sfuns)
9705 (funcall (intern
9706 (completing-read
9707 "Which function for creating the link? "
9708 sfunsn nil t (car sfunsn)))))
9709 (funcall (caar sfuns)))
9710 (setq link (plist-get org-store-link-plist :link)
9711 desc (or (plist-get org-store-link-plist
9712 :description) link))))
9714 ;; Store a link from a source code buffer
9715 ((org-src-edit-buffer-p)
9716 (let (label gc)
9717 (while (or (not label)
9718 (save-excursion
9719 (save-restriction
9720 (widen)
9721 (goto-char (point-min))
9722 (re-search-forward
9723 (regexp-quote (format org-coderef-label-format label))
9724 nil t))))
9725 (when label (message "Label exists already") (sit-for 2))
9726 (setq label (read-string "Code line label: " label)))
9727 (end-of-line 1)
9728 (setq link (format org-coderef-label-format label))
9729 (setq gc (- 79 (length link)))
9730 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9731 (insert link)
9732 (setq link (concat "(" label ")") desc nil)))
9734 ;; We are in the agenda, link to referenced location
9735 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9736 (let ((m (or (get-text-property (point) 'org-hd-marker)
9737 (get-text-property (point) 'org-marker))))
9738 (when m
9739 (org-with-point-at m
9740 (setq agenda-link
9741 (if (org-called-interactively-p 'any)
9742 (call-interactively 'org-store-link)
9743 (org-store-link nil)))))))
9745 ((eq major-mode 'calendar-mode)
9746 (let ((cd (calendar-cursor-to-date)))
9747 (setq link
9748 (format-time-string
9749 (car org-time-stamp-formats)
9750 (apply 'encode-time
9751 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9752 nil nil nil))))
9753 (org-store-link-props :type "calendar" :date cd)))
9755 ((eq major-mode 'help-mode)
9756 (setq link (concat "help:" (save-excursion
9757 (goto-char (point-min))
9758 (looking-at "^[^ ]+")
9759 (match-string 0))))
9760 (org-store-link-props :type "help"))
9762 ((eq major-mode 'w3-mode)
9763 (setq cpltxt (if (and (buffer-name)
9764 (not (string-match "Untitled" (buffer-name))))
9765 (buffer-name)
9766 (url-view-url t))
9767 link (url-view-url t))
9768 (org-store-link-props :type "w3" :url (url-view-url t)))
9770 ((eq major-mode 'image-mode)
9771 (setq cpltxt (concat "file:"
9772 (abbreviate-file-name buffer-file-name))
9773 link cpltxt)
9774 (org-store-link-props :type "image" :file buffer-file-name))
9776 ;; In dired, store a link to the file of the current line
9777 ((derived-mode-p 'dired-mode)
9778 (let ((file (dired-get-filename nil t)))
9779 (setq file (if file
9780 (abbreviate-file-name
9781 (expand-file-name (dired-get-filename nil t)))
9782 ;; otherwise, no file so use current directory.
9783 default-directory))
9784 (setq cpltxt (concat "file:" file)
9785 link cpltxt)))
9787 ((setq search (run-hook-with-args-until-success
9788 'org-create-file-search-functions))
9789 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9790 "::" search))
9791 (setq cpltxt (or description link)))
9793 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9794 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9795 (cond
9796 ;; Store a link using the target at point
9797 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9798 (setq cpltxt
9799 (concat "file:"
9800 (abbreviate-file-name
9801 (buffer-file-name (buffer-base-buffer)))
9802 "::" (match-string 1))
9803 link cpltxt))
9804 ((and (featurep 'org-id)
9805 (or (eq org-id-link-to-org-use-id t)
9806 (and (org-called-interactively-p 'any)
9807 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9808 (and (eq org-id-link-to-org-use-id
9809 'create-if-interactive-and-no-custom-id)
9810 (not custom-id))))
9811 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9812 ;; Store a link using the ID at point
9813 (setq link (condition-case nil
9814 (prog1 (org-id-store-link)
9815 (setq desc (or (plist-get org-store-link-plist
9816 :description)
9817 "")))
9818 (error
9819 ;; Probably before first headline, link only to file
9820 (concat "file:"
9821 (abbreviate-file-name
9822 (buffer-file-name (buffer-base-buffer))))))))
9824 ;; Just link to current headline
9825 (setq cpltxt (concat "file:"
9826 (abbreviate-file-name
9827 (buffer-file-name (buffer-base-buffer)))))
9828 ;; Add a context search string
9829 (when (org-xor org-context-in-file-links arg)
9830 (let* ((ee (org-element-at-point))
9831 (et (org-element-type ee))
9832 (ev (plist-get (cadr ee) :value))
9833 (ek (plist-get (cadr ee) :key))
9834 (eok (and (stringp ek) (string-match "name" ek))))
9835 (setq txt (cond
9836 ((org-at-heading-p) nil)
9837 ((and (eq et 'keyword) eok) ev)
9838 ((org-region-active-p)
9839 (buffer-substring (region-beginning) (region-end)))))
9840 (when (or (null txt) (string-match "\\S-" txt))
9841 (setq cpltxt
9842 (concat cpltxt "::"
9843 (condition-case nil
9844 (org-make-org-heading-search-string txt)
9845 (error "")))
9846 desc (or (and (eq et 'keyword) eok ev)
9847 (nth 4 (ignore-errors (org-heading-components)))
9848 "NONE")))))
9849 (if (string-match "::\\'" cpltxt)
9850 (setq cpltxt (substring cpltxt 0 -2)))
9851 (setq link cpltxt))))
9853 ((buffer-file-name (buffer-base-buffer))
9854 ;; Just link to this file here.
9855 (setq cpltxt (concat "file:"
9856 (abbreviate-file-name
9857 (buffer-file-name (buffer-base-buffer)))))
9858 ;; Add a context string.
9859 (when (org-xor org-context-in-file-links arg)
9860 (setq txt (if (org-region-active-p)
9861 (buffer-substring (region-beginning) (region-end))
9862 (buffer-substring (point-at-bol) (point-at-eol))))
9863 ;; Only use search option if there is some text.
9864 (when (string-match "\\S-" txt)
9865 (setq cpltxt
9866 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9867 desc "NONE")))
9868 (setq link cpltxt))
9870 ((org-called-interactively-p 'interactive)
9871 (user-error "No method for storing a link from this buffer"))
9873 (t (setq link nil)))
9875 ;; We're done setting link and desc, clean up
9876 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9877 (setq link (or link cpltxt)
9878 desc (or desc cpltxt))
9879 (cond ((equal desc "NONE") (setq desc nil))
9880 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9881 (let ((d0 (match-string 3 desc))
9882 (p0 (match-string 5 desc)))
9883 (setq desc
9884 (replace-regexp-in-string
9885 org-bracket-link-regexp
9886 (concat (or p0 d0)
9887 (if (equal (length (match-string 0 desc))
9888 (length desc)) "*" "")) desc)))))
9890 ;; Return the link
9891 (if (not (and (or (org-called-interactively-p 'any)
9892 executing-kbd-macro) link))
9893 (or agenda-link (and link (org-make-link-string link desc)))
9894 (push (list link desc) org-stored-links)
9895 (message "Stored: %s" (or desc link))
9896 (when custom-id
9897 (setq link (concat "file:" (abbreviate-file-name
9898 (buffer-file-name)) "::#" custom-id))
9899 (push (list link desc) org-stored-links))
9900 (car org-stored-links))))))
9902 (defun org-store-link-props (&rest plist)
9903 "Store link properties, extract names and addresses."
9904 (let (x adr)
9905 (when (setq x (plist-get plist :from))
9906 (setq adr (mail-extract-address-components x))
9907 (setq plist (plist-put plist :fromname (car adr)))
9908 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9909 (when (setq x (plist-get plist :to))
9910 (setq adr (mail-extract-address-components x))
9911 (setq plist (plist-put plist :toname (car adr)))
9912 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9913 (let ((from (plist-get plist :from))
9914 (to (plist-get plist :to)))
9915 (when (and from to org-from-is-user-regexp)
9916 (setq plist
9917 (plist-put plist :fromto
9918 (if (string-match org-from-is-user-regexp from)
9919 (concat "to %t")
9920 (concat "from %f"))))))
9921 (setq org-store-link-plist plist))
9923 (defun org-add-link-props (&rest plist)
9924 "Add these properties to the link property list."
9925 (let (key value)
9926 (while plist
9927 (setq key (pop plist) value (pop plist))
9928 (setq org-store-link-plist
9929 (plist-put org-store-link-plist key value)))))
9931 (defun org-email-link-description (&optional fmt)
9932 "Return the description part of an email link.
9933 This takes information from `org-store-link-plist' and formats it
9934 according to FMT (default from `org-email-link-description-format')."
9935 (setq fmt (or fmt org-email-link-description-format))
9936 (let* ((p org-store-link-plist)
9937 (to (plist-get p :toaddress))
9938 (from (plist-get p :fromaddress))
9939 (table
9940 (list
9941 (cons "%c" (plist-get p :fromto))
9942 (cons "%F" (plist-get p :from))
9943 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9944 (cons "%T" (plist-get p :to))
9945 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9946 (cons "%s" (plist-get p :subject))
9947 (cons "%d" (plist-get p :date))
9948 (cons "%m" (plist-get p :message-id)))))
9949 (when (string-match "%c" fmt)
9950 ;; Check if the user wrote this message
9951 (if (and org-from-is-user-regexp from to
9952 (save-match-data (string-match org-from-is-user-regexp from)))
9953 (setq fmt (replace-match "to %t" t t fmt))
9954 (setq fmt (replace-match "from %f" t t fmt))))
9955 (org-replace-escapes fmt table)))
9957 (defun org-make-org-heading-search-string (&optional string)
9958 "Make search string for the current headline or STRING."
9959 (let ((s (or string
9960 (and (derived-mode-p 'org-mode)
9961 (save-excursion
9962 (org-back-to-heading t)
9963 (org-element-property :raw-value (org-element-at-point))))))
9964 (lines org-context-in-file-links))
9965 (or string (setq s (concat "*" s))) ; Add * for headlines
9966 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9967 (when (and string (integerp lines) (> lines 0))
9968 (let ((slines (org-split-string s "\n")))
9969 (when (< lines (length slines))
9970 (setq s (mapconcat
9971 'identity
9972 (reverse (nthcdr (- (length slines) lines)
9973 (reverse slines))) "\n")))))
9974 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9976 (defun org-make-link-string (link &optional description)
9977 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9978 (unless (string-match "\\S-" link)
9979 (error "Empty link"))
9980 (when (and description
9981 (stringp description)
9982 (not (string-match "\\S-" description)))
9983 (setq description nil))
9984 (when (stringp description)
9985 ;; Remove brackets from the description, they are fatal.
9986 (while (string-match "\\[" description)
9987 (setq description (replace-match "{" t t description)))
9988 (while (string-match "\\]" description)
9989 (setq description (replace-match "}" t t description))))
9990 (when (equal link description)
9991 ;; No description needed, it is identical
9992 (setq description nil))
9993 (when (and (not description)
9994 (not (string-match (org-image-file-name-regexp) link))
9995 (not (equal link (org-link-escape link))))
9996 (setq description (org-extract-attributes link)))
9997 (setq link
9998 (cond ((string-match (org-image-file-name-regexp) link) link)
9999 ((string-match org-link-types-re link)
10000 (concat (match-string 1 link)
10001 (org-link-escape (substring link (match-end 1)))))
10002 (t (org-link-escape link))))
10003 (concat "[[" link "]"
10004 (if description (concat "[" description "]") "")
10005 "]"))
10007 (defconst org-link-escape-chars
10008 ;;%20 %5B %5D
10009 '(?\ ?\[ ?\])
10010 "List of characters that should be escaped in a link when stored to Org.
10011 This is the list that is used for internal purposes.")
10013 (defconst org-link-escape-chars-browser
10014 ;;%20 %22
10015 '(?\ ?\")
10016 "List of characters to be escaped before handing over to the browser.
10017 If you consider using this constant then you probably want to use
10018 the function `org-link-escape-browser' instead. See there why
10019 this constant is a candidate to be removed once Org drops support
10020 for Emacs 24.1 and 24.2.")
10022 (defun org-link-escape (text &optional table merge)
10023 "Return percent escaped representation of TEXT.
10024 TEXT is a string with the text to escape.
10025 Optional argument TABLE is a list with characters that should be
10026 escaped. When nil, `org-link-escape-chars' is used.
10027 If optional argument MERGE is set, merge TABLE into
10028 `org-link-escape-chars'."
10029 ;; Don't escape chars in internal links
10030 (if (string-match "^\\*[[:alnum:]]+" text)
10031 text
10032 (cond
10033 ((and table merge)
10034 (mapc (lambda (defchr)
10035 (unless (member defchr table)
10036 (setq table (cons defchr table))))
10037 org-link-escape-chars))
10038 ((null table)
10039 (setq table org-link-escape-chars)))
10040 (mapconcat
10041 (lambda (char)
10042 (if (or (member char table)
10043 (and (or (< char 32) (= char ?\%) (> char 126))
10044 org-url-hexify-p))
10045 (mapconcat (lambda (sequence-element)
10046 (format "%%%.2X" sequence-element))
10047 (or (encode-coding-char char 'utf-8)
10048 (error "Unable to percent escape character: %s"
10049 (char-to-string char))) "")
10050 (char-to-string char))) text "")))
10052 (defun org-link-escape-browser (text)
10053 "Escape some characters before handing over to the browser.
10054 This function is a candidate to be removed together with the
10055 constant `org-link-escape-chars-browser' once Org drops support
10056 for Emacs 24.1 and 24.2. All calls to this function will have to
10057 be replaced with `url-encode-url' which is available since Emacs
10058 24.3.1."
10059 ;; Example with the Org link
10060 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10061 ;; to open the browser with +subject:"Release 8.2" filled into the
10062 ;; query field: In this case the variable TEXT contains the
10063 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10064 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10065 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10066 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10067 (if (fboundp 'url-encode-url)
10068 (url-encode-url text)
10069 (if (org-string-match-p
10070 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10071 text)
10072 (org-link-escape text org-link-escape-chars-browser)
10073 text)))
10075 (defun org-link-unescape (str)
10076 "Unhex hexified Unicode strings as returned from the JavaScript function
10077 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10078 (unless (and (null str) (string= "" str))
10079 (let ((pos 0) (case-fold-search t) unhexed)
10080 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10081 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10082 (setq str (replace-match unhexed t t str))
10083 (setq pos (+ pos (length unhexed))))))
10084 str)
10086 (defun org-link-unescape-compound (hex)
10087 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10088 Note: this function also decodes single byte encodings like
10089 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10090 (save-match-data
10091 (let* ((bytes (cdr (split-string hex "%")))
10092 (ret "")
10093 (eat 0)
10094 (sum 0))
10095 (while bytes
10096 (let* ((val (string-to-number (pop bytes) 16))
10097 (shift-xor
10098 (if (= 0 eat)
10099 (cond
10100 ((>= val 252) (cons 6 252))
10101 ((>= val 248) (cons 5 248))
10102 ((>= val 240) (cons 4 240))
10103 ((>= val 224) (cons 3 224))
10104 ((>= val 192) (cons 2 192))
10105 (t (cons 0 0)))
10106 (cons 6 128))))
10107 (if (>= val 192) (setq eat (car shift-xor)))
10108 (setq val (logxor val (cdr shift-xor)))
10109 (setq sum (+ (lsh sum (car shift-xor)) val))
10110 (if (> eat 0) (setq eat (- eat 1)))
10111 (cond
10112 ((= 0 eat) ;multi byte
10113 (setq ret (concat ret (org-char-to-string sum)))
10114 (setq sum 0))
10115 ((not bytes) ; single byte(s)
10116 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10117 ret)))
10119 (defun org-link-unescape-single-byte-sequence (hex)
10120 "Unhexify hex-encoded single byte character sequences."
10121 (mapconcat (lambda (byte)
10122 (char-to-string (string-to-number byte 16)))
10123 (cdr (split-string hex "%")) ""))
10125 (defun org-xor (a b)
10126 "Exclusive or."
10127 (if a (not b) b))
10129 (defun org-fixup-message-id-for-http (s)
10130 "Replace special characters in a message id, so it can be used in an http query."
10131 (when (string-match "%" s)
10132 (setq s (mapconcat (lambda (c)
10133 (if (eq c ?%)
10134 "%25"
10135 (char-to-string c)))
10136 s "")))
10137 (while (string-match "<" s)
10138 (setq s (replace-match "%3C" t t s)))
10139 (while (string-match ">" s)
10140 (setq s (replace-match "%3E" t t s)))
10141 (while (string-match "@" s)
10142 (setq s (replace-match "%40" t t s)))
10145 (defun org-link-prettify (link)
10146 "Return a human-readable representation of LINK.
10147 The car of LINK must be a raw link.
10148 The cdr of LINK must be either a link description or nil."
10149 (let ((desc (or (cadr link) "<no description>")))
10150 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10151 "<" (car link) ">")))
10153 ;;;###autoload
10154 (defun org-insert-link-global ()
10155 "Insert a link like Org-mode does.
10156 This command can be called in any mode to insert a link in Org-mode syntax."
10157 (interactive)
10158 (org-load-modules-maybe)
10159 (org-run-like-in-org-mode 'org-insert-link))
10161 (defun org-insert-all-links (arg &optional pre post)
10162 "Insert all links in `org-stored-links'.
10163 When a universal prefix, do not delete the links from `org-stored-links'.
10164 When `ARG' is a number, insert the last N link(s).
10165 `PRE' and `POST' are optional arguments to define a string to
10166 prepend or to append."
10167 (interactive "P")
10168 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10169 (links (copy-seq org-stored-links))
10170 (pr (or pre "- "))
10171 (po (or post "\n"))
10172 (cnt 1) l)
10173 (if (null org-stored-links)
10174 (message "No link to insert")
10175 (while (and (or (listp arg) (>= arg cnt))
10176 (setq l (if (listp arg)
10177 (pop links)
10178 (pop org-stored-links))))
10179 (setq cnt (1+ cnt))
10180 (insert pr)
10181 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10182 (insert po)))))
10184 (defun org-insert-last-stored-link (arg)
10185 "Insert the last link stored in `org-stored-links'."
10186 (interactive "p")
10187 (org-insert-all-links arg "" "\n"))
10189 (defun org-link-fontify-links-to-this-file ()
10190 "Fontify links to the current file in `org-stored-links'."
10191 (let ((f (buffer-file-name)) a b)
10192 (setq a (mapcar (lambda(l)
10193 (let ((ll (car l)))
10194 (when (and (string-match "^file:\\(.+\\)::" ll)
10195 (equal f (expand-file-name (match-string 1 ll))))
10196 ll)))
10197 org-stored-links))
10198 (when (featurep 'org-id)
10199 (setq b (mapcar (lambda(l)
10200 (let ((ll (car l)))
10201 (when (and (string-match "^id:\\(.+\\)$" ll)
10202 (equal f (expand-file-name
10203 (or (org-id-find-id-file
10204 (match-string 1 ll)) ""))))
10205 ll)))
10206 org-stored-links)))
10207 (mapcar (lambda(l)
10208 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10209 (delq nil (append a b)))))
10211 (defvar org-link-links-in-this-file nil)
10212 (defun org-insert-link (&optional complete-file link-location default-description)
10213 "Insert a link. At the prompt, enter the link.
10215 Completion can be used to insert any of the link protocol prefixes like
10216 http or ftp in use.
10218 The history can be used to select a link previously stored with
10219 `org-store-link'. When the empty string is entered (i.e. if you just
10220 press RET at the prompt), the link defaults to the most recently
10221 stored link. As SPC triggers completion in the minibuffer, you need to
10222 use M-SPC or C-q SPC to force the insertion of a space character.
10224 You will also be prompted for a description, and if one is given, it will
10225 be displayed in the buffer instead of the link.
10227 If there is already a link at point, this command will allow you to edit link
10228 and description parts.
10230 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10231 be selected using completion. The path to the file will be relative to the
10232 current directory if the file is in the current directory or a subdirectory.
10233 Otherwise, the link will be the absolute path as completed in the minibuffer
10234 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10235 option `org-link-file-path-type'.
10237 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10238 the current directory or below.
10240 With three \\[universal-argument] prefixes, negate the meaning of
10241 `org-keep-stored-link-after-insertion'.
10243 If `org-make-link-description-function' is non-nil, this function will be
10244 called with the link target, and the result will be the default
10245 link description.
10247 If the LINK-LOCATION parameter is non-nil, this value will be
10248 used as the link location instead of reading one interactively.
10250 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10251 be used as the default description."
10252 (interactive "P")
10253 (let* ((wcf (current-window-configuration))
10254 (origbuf (current-buffer))
10255 (region (if (org-region-active-p)
10256 (buffer-substring (region-beginning) (region-end))))
10257 (remove (and region (list (region-beginning) (region-end))))
10258 (desc region)
10259 tmphist ; byte-compile incorrectly complains about this
10260 (link link-location)
10261 (abbrevs org-link-abbrev-alist-local)
10262 entry file all-prefixes auto-desc)
10263 (cond
10264 (link-location) ; specified by arg, just use it.
10265 ((org-in-regexp org-bracket-link-regexp 1)
10266 ;; We do have a link at point, and we are going to edit it.
10267 (setq remove (list (match-beginning 0) (match-end 0)))
10268 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10269 (setq link (read-string "Link: "
10270 (org-link-unescape
10271 (org-match-string-no-properties 1)))))
10272 ((or (org-in-regexp org-angle-link-re)
10273 (org-in-regexp org-plain-link-re))
10274 ;; Convert to bracket link
10275 (setq remove (list (match-beginning 0) (match-end 0))
10276 link (read-string "Link: "
10277 (org-remove-angle-brackets (match-string 0)))))
10278 ((member complete-file '((4) (16)))
10279 ;; Completing read for file names.
10280 (setq link (org-file-complete-link complete-file)))
10282 ;; Read link, with completion for stored links.
10283 (org-link-fontify-links-to-this-file)
10284 (org-switch-to-buffer-other-window "*Org Links*")
10285 (with-current-buffer "*Org Links*"
10286 (erase-buffer)
10287 (insert "Insert a link.
10288 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10289 (when org-stored-links
10290 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10291 (insert (mapconcat 'org-link-prettify
10292 (reverse org-stored-links) "\n")))
10293 (goto-char (point-min)))
10294 (let ((cw (selected-window)))
10295 (select-window (get-buffer-window "*Org Links*" 'visible))
10296 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10297 (unless (pos-visible-in-window-p (point-max))
10298 (org-fit-window-to-buffer))
10299 (and (window-live-p cw) (select-window cw)))
10300 ;; Fake a link history, containing the stored links.
10301 (setq tmphist (append (mapcar 'car org-stored-links)
10302 org-insert-link-history))
10303 (setq all-prefixes (append (mapcar 'car abbrevs)
10304 (mapcar 'car org-link-abbrev-alist)
10305 org-link-types))
10306 (unwind-protect
10307 (progn
10308 (setq link
10309 (org-completing-read
10310 "Link: "
10311 (append
10312 (mapcar (lambda (x) (concat x ":"))
10313 all-prefixes)
10314 (mapcar 'car org-stored-links))
10315 nil nil nil
10316 'tmphist
10317 (caar org-stored-links)))
10318 (if (not (string-match "\\S-" link))
10319 (user-error "No link selected"))
10320 (mapc (lambda(l)
10321 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10322 org-stored-links)
10323 (if (or (member link all-prefixes)
10324 (and (equal ":" (substring link -1))
10325 (member (substring link 0 -1) all-prefixes)
10326 (setq link (substring link 0 -1))))
10327 (setq link (with-current-buffer origbuf
10328 (org-link-try-special-completion link)))))
10329 (set-window-configuration wcf)
10330 (kill-buffer "*Org Links*"))
10331 (setq entry (assoc link org-stored-links))
10332 (or entry (push link org-insert-link-history))
10333 (setq desc (or desc (nth 1 entry)))))
10335 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10336 (not org-keep-stored-link-after-insertion))
10337 (setq org-stored-links (delq (assoc link org-stored-links)
10338 org-stored-links)))
10340 (if (and (string-match org-plain-link-re link)
10341 (not (string-match org-ts-regexp link)))
10342 ;; URL-like link, normalize the use of angular brackets.
10343 (setq link (org-remove-angle-brackets link)))
10345 ;; Check if we are linking to the current file with a search
10346 ;; option If yes, simplify the link by using only the search
10347 ;; option.
10348 (when (and buffer-file-name
10349 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10350 (let* ((path (match-string 1 link))
10351 (case-fold-search nil)
10352 (search (match-string 2 link)))
10353 (save-match-data
10354 (if (equal (file-truename buffer-file-name) (file-truename path))
10355 ;; We are linking to this same file, with a search option
10356 (setq link search)))))
10358 ;; Check if we can/should use a relative path. If yes, simplify the link
10359 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10360 (let* ((type (match-string 1 link))
10361 (path (match-string 2 link))
10362 (origpath path)
10363 (case-fold-search nil))
10364 (cond
10365 ((or (eq org-link-file-path-type 'absolute)
10366 (equal complete-file '(16)))
10367 (setq path (abbreviate-file-name (expand-file-name path))))
10368 ((eq org-link-file-path-type 'noabbrev)
10369 (setq path (expand-file-name path)))
10370 ((eq org-link-file-path-type 'relative)
10371 (setq path (file-relative-name path)))
10373 (save-match-data
10374 (if (string-match (concat "^" (regexp-quote
10375 (expand-file-name
10376 (file-name-as-directory
10377 default-directory))))
10378 (expand-file-name path))
10379 ;; We are linking a file with relative path name.
10380 (setq path (substring (expand-file-name path)
10381 (match-end 0)))
10382 (setq path (abbreviate-file-name (expand-file-name path)))))))
10383 (setq link (concat type path))
10384 (if (equal desc origpath)
10385 (setq desc path))))
10387 (if org-make-link-description-function
10388 (setq desc
10389 (or (condition-case nil
10390 (funcall org-make-link-description-function link desc)
10391 (error (progn (message "Can't get link description from `%s'"
10392 (symbol-name org-make-link-description-function))
10393 (sit-for 2) nil)))
10394 (read-string "Description: " default-description)))
10395 (if default-description (setq desc default-description)
10396 (setq desc (or (and auto-desc desc)
10397 (read-string "Description: " desc)))))
10399 (unless (string-match "\\S-" desc) (setq desc nil))
10400 (if remove (apply 'delete-region remove))
10401 (insert (org-make-link-string link desc))))
10403 (defun org-link-try-special-completion (type)
10404 "If there is completion support for link type TYPE, offer it."
10405 (let ((fun (intern (concat "org-" type "-complete-link"))))
10406 (if (functionp fun)
10407 (funcall fun)
10408 (read-string "Link (no completion support): " (concat type ":")))))
10410 (defun org-file-complete-link (&optional arg)
10411 "Create a file link using completion."
10412 (let (file link)
10413 (setq file (org-iread-file-name "File: "))
10414 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10415 (pwd1 (file-name-as-directory (abbreviate-file-name
10416 (expand-file-name ".")))))
10417 (cond
10418 ((equal arg '(16))
10419 (setq link (concat
10420 "file:"
10421 (abbreviate-file-name (expand-file-name file)))))
10422 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10423 (setq link (concat "file:" (match-string 1 file))))
10424 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10425 (expand-file-name file))
10426 (setq link (concat
10427 "file:" (match-string 1 (expand-file-name file)))))
10428 (t (setq link (concat "file:" file)))))
10429 link))
10431 (defun org-iread-file-name (&rest args)
10432 "Read-file-name using `ido-mode' speedup if available.
10433 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10434 See `read-file-name' for a description of parameters."
10435 (org-without-partial-completion
10436 (if (and org-completion-use-ido
10437 (fboundp 'ido-read-file-name)
10438 (boundp 'ido-mode) ido-mode
10439 (listp (second args)))
10440 (let ((ido-enter-matching-directory nil))
10441 (apply 'ido-read-file-name args))
10442 (apply 'read-file-name args))))
10444 (defun org-completing-read (&rest args)
10445 "Completing-read with SPACE being a normal character."
10446 (let ((enable-recursive-minibuffers t)
10447 (minibuffer-local-completion-map
10448 (copy-keymap minibuffer-local-completion-map)))
10449 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10450 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10451 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10452 (apply 'org-icompleting-read args)))
10454 (defun org-completing-read-no-i (&rest args)
10455 (let (org-completion-use-ido org-completion-use-iswitchb)
10456 (apply 'org-completing-read args)))
10458 (defun org-iswitchb-completing-read (prompt choices &rest args)
10459 "Use iswitch as a completing-read replacement to choose from choices.
10460 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10461 from."
10462 (let* ((iswitchb-use-virtual-buffers nil)
10463 (iswitchb-make-buflist-hook
10464 (lambda ()
10465 (setq iswitchb-temp-buflist choices))))
10466 (iswitchb-read-buffer prompt)))
10468 (defun org-icompleting-read (&rest args)
10469 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10470 (org-without-partial-completion
10471 (if (and org-completion-use-ido
10472 (fboundp 'ido-completing-read)
10473 (boundp 'ido-mode) ido-mode
10474 (listp (second args)))
10475 (let ((ido-enter-matching-directory nil))
10476 (apply 'ido-completing-read (concat (car args))
10477 (if (consp (car (nth 1 args)))
10478 (mapcar 'car (nth 1 args))
10479 (nth 1 args))
10480 (cddr args)))
10481 (if (and org-completion-use-iswitchb
10482 (boundp 'iswitchb-mode) iswitchb-mode
10483 (listp (second args)))
10484 (apply 'org-iswitchb-completing-read (concat (car args))
10485 (if (consp (car (nth 1 args)))
10486 (mapcar 'car (nth 1 args))
10487 (nth 1 args))
10488 (cddr args))
10489 (apply 'completing-read args)))))
10491 (defun org-extract-attributes (s)
10492 "Extract the attributes cookie from a string and set as text property."
10493 (let (a attr (start 0) key value)
10494 (save-match-data
10495 (when (string-match "{{\\([^}]+\\)}}$" s)
10496 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10497 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10498 (setq key (match-string 1 a) value (match-string 2 a)
10499 start (match-end 0)
10500 attr (plist-put attr (intern key) value))))
10501 (org-add-props s nil 'org-attr attr))
10504 ;;; Opening/following a link
10506 (defvar org-link-search-failed nil)
10508 (defvar org-open-link-functions nil
10509 "Hook for functions finding a plain text link.
10510 These functions must take a single argument, the link content.
10511 They will be called for links that look like [[link text][description]]
10512 when LINK TEXT does not have a protocol like \"http:\" and does not look
10513 like a filename (e.g. \"./blue.png\").
10515 These functions will be called *before* Org attempts to resolve the
10516 link by doing text searches in the current buffer - so if you want a
10517 link \"[[target]]\" to still find \"<<target>>\", your function should
10518 handle this as a special case.
10520 When the function does handle the link, it must return a non-nil value.
10521 If it decides that it is not responsible for this link, it must return
10522 nil to indicate that that Org-mode can continue with other options
10523 like exact and fuzzy text search.")
10525 (defun org-next-link (&optional search-backward)
10526 "Move forward to the next link.
10527 If the link is in hidden text, expose it."
10528 (interactive "P")
10529 (when (and org-link-search-failed (eq this-command last-command))
10530 (goto-char (point-min))
10531 (message "Link search wrapped back to beginning of buffer"))
10532 (setq org-link-search-failed nil)
10533 (let* ((pos (point))
10534 (ct (org-context))
10535 (a (assoc :link ct))
10536 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10537 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10538 ((looking-at org-any-link-re)
10539 ;; Don't stay stuck at link without an org-link face
10540 (forward-char (if search-backward -1 1))))
10541 (if (funcall srch-fun org-any-link-re nil t)
10542 (progn
10543 (goto-char (match-beginning 0))
10544 (if (outline-invisible-p) (org-show-context)))
10545 (goto-char pos)
10546 (setq org-link-search-failed t)
10547 (message "No further link found"))))
10549 (defun org-previous-link ()
10550 "Move backward to the previous link.
10551 If the link is in hidden text, expose it."
10552 (interactive)
10553 (funcall 'org-next-link t))
10555 (defun org-translate-link (s)
10556 "Translate a link string if a translation function has been defined."
10557 (if (and org-link-translation-function
10558 (fboundp org-link-translation-function)
10559 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10560 (progn
10561 (setq s (funcall org-link-translation-function
10562 (match-string 1 s) (match-string 2 s)))
10563 (concat (car s) ":" (cdr s)))
10566 (defun org-translate-link-from-planner (type path)
10567 "Translate a link from Emacs Planner syntax so that Org can follow it.
10568 This is still an experimental function, your mileage may vary."
10569 (cond
10570 ((member type '("http" "https" "news" "ftp"))
10571 ;; standard Internet links are the same.
10572 nil)
10573 ((and (equal type "irc") (string-match "^//" path))
10574 ;; Planner has two / at the beginning of an irc link, we have 1.
10575 ;; We should have zero, actually....
10576 (setq path (substring path 1)))
10577 ((and (equal type "lisp") (string-match "^/" path))
10578 ;; Planner has a slash, we do not.
10579 (setq type "elisp" path (substring path 1)))
10580 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10581 ;; A typical message link. Planner has the id after the final slash,
10582 ;; we separate it with a hash mark
10583 (setq path (concat (match-string 1 path) "#"
10584 (org-remove-angle-brackets (match-string 2 path))))))
10585 (cons type path))
10587 (defun org-find-file-at-mouse (ev)
10588 "Open file link or URL at mouse."
10589 (interactive "e")
10590 (mouse-set-point ev)
10591 (org-open-at-point 'in-emacs))
10593 (defun org-open-at-mouse (ev)
10594 "Open file link or URL at mouse.
10595 See the docstring of `org-open-file' for details."
10596 (interactive "e")
10597 (mouse-set-point ev)
10598 (if (eq major-mode 'org-agenda-mode)
10599 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10600 (org-open-at-point))
10602 (defvar org-window-config-before-follow-link nil
10603 "The window configuration before following a link.
10604 This is saved in case the need arises to restore it.")
10606 (defvar org-open-link-marker (make-marker)
10607 "Marker pointing to the location where `org-open-at-point' was called.")
10609 ;;;###autoload
10610 (defun org-open-at-point-global ()
10611 "Follow a link like Org-mode does.
10612 This command can be called in any mode to follow a link that has
10613 Org-mode syntax."
10614 (interactive)
10615 (org-run-like-in-org-mode 'org-open-at-point))
10617 ;;;###autoload
10618 (defun org-open-link-from-string (s &optional arg reference-buffer)
10619 "Open a link in the string S, as if it was in Org-mode."
10620 (interactive "sLink: \nP")
10621 (let ((reference-buffer (or reference-buffer (current-buffer))))
10622 (with-temp-buffer
10623 (let ((org-inhibit-startup (not reference-buffer)))
10624 (org-mode)
10625 (insert s)
10626 (goto-char (point-min))
10627 (when reference-buffer
10628 (setq org-link-abbrev-alist-local
10629 (with-current-buffer reference-buffer
10630 org-link-abbrev-alist-local)))
10631 (org-open-at-point arg reference-buffer)))))
10633 (defvar org-open-at-point-functions nil
10634 "Hook that is run when following a link at point.
10636 Functions in this hook must return t if they identify and follow
10637 a link at point. If they don't find anything interesting at point,
10638 they must return nil.")
10640 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10641 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10642 (defun org-open-at-point (&optional arg reference-buffer)
10643 "Open link, timestamp, footnote or tags at point.
10645 When point is on a link, follow it. Normally, files will be
10646 opened by an appropriate application. If the optional prefix
10647 argument ARG is non-nil, Emacs will visit the file. With
10648 a double prefix argument, try to open outside of Emacs, in the
10649 application the system uses for this file type.
10651 When point is on a timestamp, open the agenda at the day
10652 specified.
10654 When point is a footnote definition, move to the first reference
10655 found. If it is on a reference, move to the associated
10656 definition.
10658 When point is on a headline, display a list of every link in the
10659 entry, so it is possible to pick one, or all, of them. If point
10660 is on a tag, call `org-tags-view' instead.
10662 When optional argument REFERENCE-BUFFER is non-nil, it should
10663 specify a buffer from where the link search should happen. This
10664 is used internally by `org-open-link-from-string'.
10666 On top of syntactically correct links, this function will open
10667 the link at point in comments or comment blocks and the first
10668 link in a property drawer line."
10669 (interactive "P")
10670 ;; On a code block, open block's results.
10671 (unless (call-interactively 'org-babel-open-src-block-result)
10672 (org-load-modules-maybe)
10673 (move-marker org-open-link-marker (point))
10674 (setq org-window-config-before-follow-link (current-window-configuration))
10675 (org-remove-occur-highlights nil nil t)
10676 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10677 (let* ((context
10678 ;; Only consider supported types, even if they are not
10679 ;; the closest one.
10680 (org-element-lineage
10681 (org-element-context)
10682 '(comment comment-block footnote-definition footnote-reference
10683 headline inlinetask link node-property timestamp)
10685 (type (org-element-type context))
10686 (value (org-element-property :value context)))
10687 (cond
10688 ((not context) (user-error "No link found"))
10689 ;; Exception: open timestamps and links in properties drawers
10690 ;; and comments.
10691 ((memq type '(comment comment-block node-property))
10692 (cond ((org-in-regexp org-any-link-re)
10693 (org-open-link-from-string (match-string-no-properties 0)))
10694 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10695 (org-follow-timestamp-link))
10696 (t (user-error "No link found"))))
10697 ;; On a headline or an inlinetask, but not on a timestamp,
10698 ;; a link, a footnote reference or on tags.
10699 ((and (memq type '(headline inlinetask))
10700 ;; Not on tags.
10701 (progn (save-excursion (beginning-of-line)
10702 (looking-at org-complex-heading-regexp))
10703 (or (not (match-beginning 5))
10704 (< (point) (match-beginning 5)))))
10705 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10706 (links (car data))
10707 (links-end (cdr data)))
10708 (if links
10709 (dolist (link (if (stringp links) (list links) links))
10710 (search-forward link nil links-end)
10711 (goto-char (match-beginning 0))
10712 (org-open-at-point))
10713 (require 'org-attach)
10714 (org-attach-reveal 'if-exists))))
10715 ;; Do nothing on white spaces after an object, unless point
10716 ;; is right after it.
10717 ((> (point)
10718 (save-excursion
10719 (goto-char (org-element-property :end context))
10720 (skip-chars-backward " \t")
10721 (point)))
10722 (user-error "No link found"))
10723 ((eq type 'timestamp) (org-follow-timestamp-link))
10724 ;; On tags within a headline or an inlinetask.
10725 ((and (memq type '(headline inlinetask))
10726 (progn (save-excursion (beginning-of-line)
10727 (looking-at org-complex-heading-regexp))
10728 (and (match-beginning 5)
10729 (>= (point) (match-beginning 5)))))
10730 (org-tags-view arg (substring (match-string 5) 0 -1)))
10731 ((eq type 'link)
10732 ;; When link is located within the description of another
10733 ;; link (e.g., an inline image), always open the parent
10734 ;; link.
10735 (let*((link (let ((up (org-element-property :parent context)))
10736 (if (eq (org-element-type up) 'link) up context)))
10737 (type (org-element-property :type link))
10738 (path (org-link-unescape (org-element-property :path link))))
10739 ;; Switch back to REFERENCE-BUFFER needed when called in
10740 ;; a temporary buffer through `org-open-link-from-string'.
10741 (with-current-buffer (or reference-buffer (current-buffer))
10742 (cond
10743 ((equal type "file")
10744 (if (string-match "[*?{]" (file-name-nondirectory path))
10745 (dired path)
10746 ;; Look into `org-link-protocols' in order to find
10747 ;; a DEDICATED-FUNCTION to open file. The function
10748 ;; will be applied on raw link instead of parsed
10749 ;; link due to the limitation in `org-add-link-type'
10750 ;; ("open" function called with a single argument).
10751 ;; If no such function is found, fallback to
10752 ;; `org-open-file'.
10754 ;; Note : "file+emacs" and "file+sys" types are
10755 ;; hard-coded in order to escape the previous
10756 ;; limitation.
10757 (let* ((option (org-element-property :search-option link))
10758 (app (org-element-property :application link))
10759 (dedicated-function
10760 (nth 1 (assoc app org-link-protocols))))
10761 (if dedicated-function
10762 (funcall dedicated-function
10763 (concat path
10764 (and option (concat "::" option))))
10765 (apply 'org-open-file
10766 path
10767 (cond (arg)
10768 ((equal app "emacs") 'emacs)
10769 ((equal app "sys") 'system))
10770 (cond ((not option) nil)
10771 ((org-string-match-p "\\`[0-9]+\\'" option)
10772 (list (string-to-number option)))
10773 (t (list nil
10774 (org-link-unescape option)))))))))
10775 ((assoc type org-link-protocols)
10776 (funcall (nth 1 (assoc type org-link-protocols)) path))
10777 ((equal type "help")
10778 (let ((f-or-v (intern path)))
10779 (cond ((fboundp f-or-v) (describe-function f-or-v))
10780 ((boundp f-or-v) (describe-variable f-or-v))
10781 (t (error "Not a known function or variable")))))
10782 ((member type '("http" "https" "ftp" "mailto" "news"))
10783 (browse-url (org-link-escape-browser (concat type ":" path))))
10784 ((equal type "doi")
10785 (browse-url
10786 (org-link-escape-browser (concat org-doi-server-url path))))
10787 ((equal type "message") (browse-url (concat type ":" path)))
10788 ((equal type "shell")
10789 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10790 (cmd path))
10791 (if (or (and (org-string-nw-p
10792 org-confirm-shell-link-not-regexp)
10793 (string-match
10794 org-confirm-shell-link-not-regexp cmd))
10795 (not org-confirm-shell-link-function)
10796 (funcall org-confirm-shell-link-function
10797 (format "Execute \"%s\" in shell? "
10798 (org-add-props cmd nil
10799 'face 'org-warning))))
10800 (progn
10801 (message "Executing %s" cmd)
10802 (shell-command cmd buf)
10803 (when (featurep 'midnight)
10804 (setq clean-buffer-list-kill-buffer-names
10805 (cons buf
10806 clean-buffer-list-kill-buffer-names))))
10807 (user-error "Abort"))))
10808 ((equal type "elisp")
10809 (let ((cmd path))
10810 (if (or (and (org-string-nw-p
10811 org-confirm-elisp-link-not-regexp)
10812 (org-string-match-p
10813 org-confirm-elisp-link-not-regexp cmd))
10814 (not org-confirm-elisp-link-function)
10815 (funcall org-confirm-elisp-link-function
10816 (format "Execute \"%s\" as elisp? "
10817 (org-add-props cmd nil
10818 'face 'org-warning))))
10819 (message "%s => %s" cmd
10820 (if (eq (string-to-char cmd) ?\()
10821 (eval (read cmd))
10822 (call-interactively (read cmd))))
10823 (user-error "Abort"))))
10824 ((equal type "id")
10825 (require 'ord-id)
10826 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10827 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10828 (unless (run-hook-with-args-until-success
10829 'org-open-link-functions path)
10830 (if (not arg) (org-mark-ring-push)
10831 (switch-to-buffer-other-window
10832 (org-get-buffer-for-internal-link (current-buffer))))
10833 (let ((cmd `(org-link-search
10834 ,(if (member type '("custom-id" "coderef"))
10835 (org-element-property :raw-link link)
10836 path)
10837 ,(cond ((equal arg '(4)) 'occur)
10838 ((equal arg '(16)) 'org-occur))
10839 ,(org-element-property :begin link))))
10840 (condition-case nil
10841 (let ((org-link-search-inhibit-query t))
10842 (eval cmd))
10843 (error (progn (widen) (eval cmd)))))))
10844 (t (browse-url-at-point))))))
10845 ;; On a footnote reference or at a footnote definition's label.
10846 ((or (eq type 'footnote-reference)
10847 (and (eq type 'footnote-definition)
10848 (save-excursion
10849 ;; Do not validate action when point is on the
10850 ;; spaces right after the footnote label, in
10851 ;; order to be on par with behaviour on links.
10852 (skip-chars-forward " \t")
10853 (let ((begin
10854 (org-element-property :contents-begin context)))
10855 (if begin (< (point) begin)
10856 (= (org-element-property :post-affiliated context)
10857 (line-beginning-position)))))))
10858 (org-footnote-action))
10859 (t (user-error "No link found")))))
10860 (move-marker org-open-link-marker nil)
10861 (run-hook-with-args 'org-follow-link-hook)))
10863 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10864 "Offer links in the current entry and return the selected link.
10865 If there is only one link, return it.
10866 If NTH is an integer, return the NTH link found.
10867 If ZERO is a string, check also this string for a link, and if
10868 there is one, return it."
10869 (with-current-buffer buffer
10870 (save-excursion
10871 (save-restriction
10872 (widen)
10873 (goto-char marker)
10874 (let ((cnt ?0)
10875 (in-emacs (if (integerp nth) nil nth))
10876 have-zero end links link c)
10877 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10878 (push (match-string 0 zero) links)
10879 (setq cnt (1- cnt) have-zero t))
10880 (save-excursion
10881 (org-back-to-heading t)
10882 (setq end (save-excursion (outline-next-heading) (point)))
10883 (while (re-search-forward org-any-link-re end t)
10884 (push (match-string 0) links))
10885 (setq links (org-uniquify (reverse links))))
10886 (cond
10887 ((null links)
10888 (message "No links"))
10889 ((equal (length links) 1)
10890 (setq link (car links)))
10891 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10892 (setq link (nth (if have-zero nth (1- nth)) links)))
10893 (t ; we have to select a link
10894 (save-excursion
10895 (save-window-excursion
10896 (delete-other-windows)
10897 (with-output-to-temp-buffer "*Select Link*"
10898 (mapc (lambda (l)
10899 (if (not (string-match org-bracket-link-regexp l))
10900 (princ (format "[%c] %s\n" (incf cnt)
10901 (org-remove-angle-brackets l)))
10902 (if (match-end 3)
10903 (princ (format "[%c] %s (%s)\n" (incf cnt)
10904 (match-string 3 l) (match-string 1 l)))
10905 (princ (format "[%c] %s\n" (incf cnt)
10906 (match-string 1 l))))))
10907 links))
10908 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10909 (message "Select link to open, RET to open all:")
10910 (setq c (read-char-exclusive))
10911 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10912 (when (equal c ?q) (user-error "Abort"))
10913 (if (equal c ?\C-m)
10914 (setq link links)
10915 (setq nth (- c ?0))
10916 (if have-zero (setq nth (1+ nth)))
10917 (unless (and (integerp nth) (>= (length links) nth))
10918 (user-error "Invalid link selection"))
10919 (setq link (nth (1- nth) links)))))
10920 (cons link end))))))
10922 ;; TODO: These functions are deprecated since `org-open-at-point'
10923 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10924 (defun org-open-file-with-system (path)
10925 "Open file at PATH using the system way of opening it."
10926 (org-open-file path 'system))
10927 (defun org-open-file-with-emacs (path)
10928 "Open file at PATH in Emacs."
10929 (org-open-file path 'emacs))
10932 ;;; File search
10934 (defvar org-create-file-search-functions nil
10935 "List of functions to construct the right search string for a file link.
10936 These functions are called in turn with point at the location to
10937 which the link should point.
10939 A function in the hook should first test if it would like to
10940 handle this file type, for example by checking the `major-mode'
10941 or the file extension. If it decides not to handle this file, it
10942 should just return nil to give other functions a chance. If it
10943 does handle the file, it must return the search string to be used
10944 when following the link. The search string will be part of the
10945 file link, given after a double colon, and `org-open-at-point'
10946 will automatically search for it. If special measures must be
10947 taken to make the search successful, another function should be
10948 added to the companion hook `org-execute-file-search-functions',
10949 which see.
10951 A function in this hook may also use `setq' to set the variable
10952 `description' to provide a suggestion for the descriptive text to
10953 be used for this link when it gets inserted into an Org-mode
10954 buffer with \\[org-insert-link].")
10956 (defvar org-execute-file-search-functions nil
10957 "List of functions to execute a file search triggered by a link.
10959 Functions added to this hook must accept a single argument, the
10960 search string that was part of the file link, the part after the
10961 double colon. The function must first check if it would like to
10962 handle this search, for example by checking the `major-mode' or
10963 the file extension. If it decides not to handle this search, it
10964 should just return nil to give other functions a chance. If it
10965 does handle the search, it must return a non-nil value to keep
10966 other functions from trying.
10968 Each function can access the current prefix argument through the
10969 variable `current-prefix-arg'. Note that a single prefix is used
10970 to force opening a link in Emacs, so it may be good to only use a
10971 numeric or double prefix to guide the search function.
10973 In case this is needed, a function in this hook can also restore
10974 the window configuration before `org-open-at-point' was called using:
10976 (set-window-configuration org-window-config-before-follow-link)")
10978 (defun org-link-search (s &optional type avoid-pos stealth)
10979 "Search for a link search option.
10980 If S is surrounded by forward slashes, it is interpreted as a
10981 regular expression. In org-mode files, this will create an `org-occur'
10982 sparse tree. In ordinary files, `occur' will be used to list matches.
10983 If the current buffer is in `dired-mode', grep will be used to search
10984 in all files. If AVOID-POS is given, ignore matches near that position.
10986 When optional argument STEALTH is non-nil, do not modify
10987 visibility around point, thus ignoring `org-show-context-detail'
10988 variable."
10989 (let ((case-fold-search t)
10990 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
10991 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
10992 (append '(("") (" ") ("\t") ("\n"))
10993 org-emphasis-alist)
10994 "\\|") "\\)"))
10995 (pos (point))
10996 words re0 re2 re4_ re4 re5 re2a re2a_ reall)
10997 (cond
10998 ;; First check if there are any special search functions
10999 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11000 ;; Now try the builtin stuff
11001 ((and (equal (string-to-char s0) ?#)
11002 (> (length s0) 1)
11003 (save-excursion
11004 (goto-char (point-min))
11005 (and
11006 (re-search-forward
11007 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
11008 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
11009 (setq type 'dedicated
11010 pos (match-beginning 0))))
11011 ;; There is an exact target for this
11012 (goto-char pos)
11013 (org-back-to-heading t)))
11014 ((save-excursion
11015 (goto-char (point-min))
11016 (and
11017 (re-search-forward
11018 (concat "<<" (regexp-quote s0) ">>") nil t)
11019 (setq type 'dedicated
11020 pos (match-beginning 0))))
11021 ;; There is an exact target for this
11022 (goto-char pos))
11023 ((save-excursion
11024 (goto-char (point-min))
11025 (and
11026 (re-search-forward
11027 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11028 (setq type 'dedicated pos (match-beginning 0))))
11029 ;; Found an element with a matching #+name affiliated keyword.
11030 (goto-char pos))
11031 ((and (string-match "^(\\(.*\\))$" s0)
11032 (save-excursion
11033 (goto-char (point-min))
11034 (and
11035 (re-search-forward
11036 (concat "[^[]" (regexp-quote
11037 (format org-coderef-label-format
11038 (match-string 1 s0))))
11039 nil t)
11040 (setq type 'dedicated
11041 pos (1+ (match-beginning 0))))))
11042 ;; There is a coderef target for this
11043 (goto-char pos))
11044 ((string-match "^/\\(.*\\)/$" s)
11045 ;; A regular expression
11046 (cond
11047 ((derived-mode-p 'org-mode)
11048 (org-occur (match-string 1 s)))
11049 (t (org-do-occur (match-string 1 s)))))
11050 ((and (derived-mode-p 'org-mode)
11051 (or (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11052 org-link-search-must-match-exact-headline))
11053 ;; Headline search.
11054 (goto-char (point-min))
11055 (cond
11056 ((let (case-fold-search)
11057 (re-search-forward
11058 (let* ((wspace "[ \t]")
11059 (wspaceopt (concat wspace "*"))
11060 (cookie (concat "\\(?:"
11061 wspaceopt
11062 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11063 wspaceopt
11064 "\\)"))
11065 (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)")))
11066 (concat
11067 org-outline-regexp-bol
11068 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11069 "\\(?:\\[#.\\][ \t]+\\)?"
11070 sep "*"
11071 (mapconcat #'identity
11072 (org-split-string (regexp-quote s))
11073 (concat sep "+"))
11074 sep "*"
11075 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11076 "[ \t]*$"))
11077 nil t))
11078 ;; OK, found a match
11079 (setq type 'dedicated)
11080 (goto-char (match-beginning 0)))
11081 ((and (not org-link-search-inhibit-query)
11082 (eq org-link-search-must-match-exact-headline 'query-to-create)
11083 (y-or-n-p "No match - create this as a new heading? "))
11084 (goto-char (point-max))
11085 (unless (bolp) (newline))
11086 (org-insert-heading nil t t)
11087 (insert s "\n")
11088 (beginning-of-line 0))
11090 (goto-char pos)
11091 (error "No match"))))
11093 ;; A normal search string
11094 (remove-text-properties
11095 0 (length s)
11096 '(face nil mouse-face nil keymap nil fontified nil) s)
11097 ;; Make a series of regular expressions to find a match
11098 (setq words (org-split-string s "[ \n\r\t]+")
11100 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11101 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11102 "\\)" markers)
11103 re2a_ (concat "\\(" (mapconcat 'downcase words
11104 "[ \t\r\n]+") "\\)[ \t\r\n]")
11105 re2a (concat "[ \t\r\n]" re2a_)
11106 re4_ (concat "\\(" (mapconcat 'downcase words
11107 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11108 re4 (concat "[^a-zA-Z_]" re4_)
11110 re5 (concat ".*" re4)
11111 reall (concat "\\(" re0 "\\)\\|\\(" re2 "\\)\\|\\(" re4
11112 "\\)\\|\\(" re5 "\\)"))
11113 (cond
11114 ((eq type 'org-occur) (org-occur reall))
11115 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11116 (t (goto-char (point-min))
11117 (setq type 'fuzzy)
11118 (if (or (and (org-search-not-self 1 re0 nil t)
11119 (setq type 'dedicated))
11120 (org-search-not-self 1 re2 nil t)
11121 (org-search-not-self 1 re2a nil t)
11122 (org-search-not-self 1 re4 nil t)
11123 (org-search-not-self 1 re5 nil t))
11124 (goto-char (match-beginning 1))
11125 (goto-char pos)
11126 (error "No match"))))))
11127 (and (derived-mode-p 'org-mode)
11128 (not stealth)
11129 (org-show-context 'link-search))
11130 type))
11132 (defun org-search-not-self (group &rest args)
11133 "Execute `re-search-forward', but only accept matches that do not
11134 enclose the position of `org-open-link-marker'."
11135 (let ((m org-open-link-marker))
11136 (catch 'exit
11137 (while (apply 're-search-forward args)
11138 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11139 (goto-char (match-end group))
11140 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11141 (> (match-beginning 0) (marker-position m))
11142 (< (match-end 0) (marker-position m)))
11143 (save-match-data
11144 (or (not (org-in-regexp
11145 org-bracket-link-analytic-regexp 1))
11146 (not (match-end 4)) ; no description
11147 (and (<= (match-beginning 4) (point))
11148 (>= (match-end 4) (point))))))
11149 (throw 'exit (point))))))))
11151 (defun org-get-buffer-for-internal-link (buffer)
11152 "Return a buffer to be used for displaying the link target of internal links."
11153 (cond
11154 ((not org-display-internal-link-with-indirect-buffer)
11155 buffer)
11156 ((string-match "(Clone)$" (buffer-name buffer))
11157 (message "Buffer is already a clone, not making another one")
11158 ;; we also do not modify visibility in this case
11159 buffer)
11160 (t ; make a new indirect buffer for displaying the link
11161 (let* ((bn (buffer-name buffer))
11162 (ibn (concat bn "(Clone)"))
11163 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11164 (with-current-buffer ib (org-overview))
11165 ib))))
11167 (defun org-do-occur (regexp &optional cleanup)
11168 "Call the Emacs command `occur'.
11169 If CLEANUP is non-nil, remove the printout of the regular expression
11170 in the *Occur* buffer. This is useful if the regex is long and not useful
11171 to read."
11172 (occur regexp)
11173 (when cleanup
11174 (let ((cwin (selected-window)) win beg end)
11175 (when (setq win (get-buffer-window "*Occur*"))
11176 (select-window win))
11177 (goto-char (point-min))
11178 (when (re-search-forward "match[a-z]+" nil t)
11179 (setq beg (match-end 0))
11180 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11181 (setq end (1- (match-beginning 0)))))
11182 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11183 (goto-char (point-min))
11184 (select-window cwin))))
11186 ;;; The mark ring for links jumps
11188 (defvar org-mark-ring nil
11189 "Mark ring for positions before jumps in Org-mode.")
11190 (defvar org-mark-ring-last-goto nil
11191 "Last position in the mark ring used to go back.")
11192 ;; Fill and close the ring
11193 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11194 (loop for i from 1 to org-mark-ring-length do
11195 (push (make-marker) org-mark-ring))
11196 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11197 org-mark-ring)
11199 (defun org-mark-ring-push (&optional pos buffer)
11200 "Put the current position or POS into the mark ring and rotate it."
11201 (interactive)
11202 (setq pos (or pos (point)))
11203 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11204 (move-marker (car org-mark-ring)
11205 (or pos (point))
11206 (or buffer (current-buffer)))
11207 (message "%s"
11208 (substitute-command-keys
11209 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11211 (defun org-mark-ring-goto (&optional n)
11212 "Jump to the previous position in the mark ring.
11213 With prefix arg N, jump back that many stored positions. When
11214 called several times in succession, walk through the entire ring.
11215 Org-mode commands jumping to a different position in the current file,
11216 or to another Org-mode file, automatically push the old position
11217 onto the ring."
11218 (interactive "p")
11219 (let (p m)
11220 (if (eq last-command this-command)
11221 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11222 (setq p org-mark-ring))
11223 (setq org-mark-ring-last-goto p)
11224 (setq m (car p))
11225 (org-pop-to-buffer-same-window (marker-buffer m))
11226 (goto-char m)
11227 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11229 (defun org-remove-angle-brackets (s)
11230 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11231 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11233 (defun org-add-angle-brackets (s)
11234 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11235 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11237 (defun org-remove-double-quotes (s)
11238 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11239 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11242 ;;; Following specific links
11244 (defun org-follow-timestamp-link ()
11245 "Open an agenda view for the time-stamp date/range at point."
11246 (cond
11247 ((org-at-date-range-p t)
11248 (let ((org-agenda-start-on-weekday)
11249 (t1 (match-string 1))
11250 (t2 (match-string 2)) tt1 tt2)
11251 (setq tt1 (time-to-days (org-time-string-to-time t1))
11252 tt2 (time-to-days (org-time-string-to-time t2)))
11253 (let ((org-agenda-buffer-tmp-name
11254 (format "*Org Agenda(a:%s)"
11255 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11256 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11257 ((org-at-timestamp-p t)
11258 (let ((org-agenda-buffer-tmp-name
11259 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11260 (org-agenda-list nil (time-to-days (org-time-string-to-time
11261 (substring (match-string 1) 0 10)))
11262 1)))
11263 (t (error "This should not happen"))))
11266 ;;; Following file links
11267 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11268 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11269 (declare-function mailcap-mime-info
11270 "mailcap" (string &optional request no-decode))
11271 (defvar org-wait nil)
11272 (defun org-open-file (path &optional in-emacs line search)
11273 "Open the file at PATH.
11274 First, this expands any special file name abbreviations. Then the
11275 configuration variable `org-file-apps' is checked if it contains an
11276 entry for this file type, and if yes, the corresponding command is launched.
11278 If no application is found, Emacs simply visits the file.
11280 With optional prefix argument IN-EMACS, Emacs will visit the file.
11281 With a double \\[universal-argument] \\[universal-argument] \
11282 prefix arg, Org tries to avoid opening in Emacs
11283 and to use an external application to visit the file.
11285 Optional LINE specifies a line to go to, optional SEARCH a string
11286 to search for. If LINE or SEARCH is given, the file will be
11287 opened in Emacs, unless an entry from org-file-apps that makes
11288 use of groups in a regexp matches.
11290 If you want to change the way frames are used when following a
11291 link, please customize `org-link-frame-setup'.
11293 If the file does not exist, an error is thrown."
11294 (let* ((file (if (equal path "")
11295 buffer-file-name
11296 (substitute-in-file-name (expand-file-name path))))
11297 (file-apps (append org-file-apps (org-default-apps)))
11298 (apps (org-remove-if
11299 'org-file-apps-entry-match-against-dlink-p file-apps))
11300 (apps-dlink (org-remove-if-not
11301 'org-file-apps-entry-match-against-dlink-p file-apps))
11302 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11303 (dirp (if remp nil (file-directory-p file)))
11304 (file (if (and dirp org-open-directory-means-index-dot-org)
11305 (concat (file-name-as-directory file) "index.org")
11306 file))
11307 (a-m-a-p (assq 'auto-mode apps))
11308 (dfile (downcase file))
11309 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11310 (link (cond ((and (eq line nil)
11311 (eq search nil))
11312 file)
11313 (line
11314 (concat file "::" (number-to-string line)))
11315 (search
11316 (concat file "::" search))))
11317 (dlink (downcase link))
11318 (old-buffer (current-buffer))
11319 (old-pos (point))
11320 (old-mode major-mode)
11321 ext cmd link-match-data)
11322 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11323 (setq ext (match-string 1 dfile))
11324 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11325 (setq ext (match-string 1 dfile))))
11326 (cond
11327 ((member in-emacs '((16) system))
11328 (setq cmd (cdr (assoc 'system apps))))
11329 (in-emacs (setq cmd 'emacs))
11331 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11332 (and dirp (cdr (assoc 'directory apps)))
11333 ; first, try matching against apps-dlink
11334 ; if we get a match here, store the match data for later
11335 (let ((match (assoc-default dlink apps-dlink
11336 'string-match)))
11337 (if match
11338 (progn (setq link-match-data (match-data))
11339 match)
11340 (progn (setq in-emacs (or in-emacs line search))
11341 nil))) ; if we have no match in apps-dlink,
11342 ; always open the file in emacs if line or search
11343 ; is given (for backwards compatibility)
11344 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11345 'string-match)
11346 (cdr (assoc ext apps))
11347 (cdr (assoc t apps))))))
11348 (when (eq cmd 'system)
11349 (setq cmd (cdr (assoc 'system apps))))
11350 (when (eq cmd 'default)
11351 (setq cmd (cdr (assoc t apps))))
11352 (when (eq cmd 'mailcap)
11353 (require 'mailcap)
11354 (mailcap-parse-mailcaps)
11355 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11356 (command (mailcap-mime-info mime-type)))
11357 (if (stringp command)
11358 (setq cmd command)
11359 (setq cmd 'emacs))))
11360 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11361 (not (file-exists-p file))
11362 (not org-open-non-existing-files))
11363 (user-error "No such file: %s" file))
11364 (cond
11365 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11366 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11367 (while (string-match "['\"]%s['\"]" cmd)
11368 (setq cmd (replace-match "%s" t t cmd)))
11369 (while (string-match "%s" cmd)
11370 (setq cmd (replace-match
11371 (save-match-data
11372 (shell-quote-argument
11373 (convert-standard-filename file)))
11374 t t cmd)))
11376 ;; Replace "%1", "%2" etc. in command with group matches from regex
11377 (save-match-data
11378 (let ((match-index 1)
11379 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11380 (set-match-data link-match-data)
11381 (while (<= match-index number-of-groups)
11382 (let ((regex (concat "%" (number-to-string match-index)))
11383 (replace-with (match-string match-index dlink)))
11384 (while (string-match regex cmd)
11385 (setq cmd (replace-match replace-with t t cmd))))
11386 (setq match-index (+ match-index 1)))))
11388 (save-window-excursion
11389 (message "Running %s...done" cmd)
11390 (start-process-shell-command cmd nil cmd)
11391 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11392 ((or (stringp cmd)
11393 (eq cmd 'emacs))
11394 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11395 (widen)
11396 (if line (progn (org-goto-line line)
11397 (if (derived-mode-p 'org-mode)
11398 (org-reveal)))
11399 (if search (org-link-search search))))
11400 ((consp cmd)
11401 (let ((file (convert-standard-filename file)))
11402 (save-match-data
11403 (set-match-data link-match-data)
11404 (eval cmd))))
11405 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11406 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11407 (or (not (equal old-buffer (current-buffer)))
11408 (not (equal old-pos (point))))
11409 (org-mark-ring-push old-pos old-buffer))))
11411 (defun org-file-apps-entry-match-against-dlink-p (entry)
11412 "This function returns non-nil if `entry' uses a regular
11413 expression which should be matched against the whole link by
11414 org-open-file.
11416 It assumes that is the case when the entry uses a regular
11417 expression which has at least one grouping construct and the
11418 action is either a lisp form or a command string containing
11419 '%1', i.e. using at least one subexpression match as a
11420 parameter."
11421 (let ((selector (car entry))
11422 (action (cdr entry)))
11423 (if (stringp selector)
11424 (and (> (regexp-opt-depth selector) 0)
11425 (or (and (stringp action)
11426 (string-match "%[0-9]" action))
11427 (consp action)))
11428 nil)))
11430 (defun org-default-apps ()
11431 "Return the default applications for this operating system."
11432 (cond
11433 ((eq system-type 'darwin)
11434 org-file-apps-defaults-macosx)
11435 ((eq system-type 'windows-nt)
11436 org-file-apps-defaults-windowsnt)
11437 (t org-file-apps-defaults-gnu)))
11439 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11440 "Convert extensions to regular expressions in the cars of LIST.
11441 Also, weed out any non-string entries, because the return value is used
11442 only for regexp matching.
11443 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11444 point to the symbol `emacs', indicating that the file should
11445 be opened in Emacs."
11446 (append
11447 (delq nil
11448 (mapcar (lambda (x)
11449 (if (not (stringp (car x)))
11451 (if (string-match "\\W" (car x))
11453 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11454 list))
11455 (if add-auto-mode
11456 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11458 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11459 (defun org-file-remote-p (file)
11460 "Test whether FILE specifies a location on a remote system.
11461 Return non-nil if the location is indeed remote.
11463 For example, the filename \"/user@host:/foo\" specifies a location
11464 on the system \"/user@host:\"."
11465 (cond ((fboundp 'file-remote-p)
11466 (file-remote-p file))
11467 ((fboundp 'tramp-handle-file-remote-p)
11468 (tramp-handle-file-remote-p file))
11469 ((and (boundp 'ange-ftp-name-format)
11470 (string-match (car ange-ftp-name-format) file))
11471 t)))
11474 ;;;; Refiling
11476 (defun org-get-org-file ()
11477 "Read a filename, with default directory `org-directory'."
11478 (let ((default (or org-default-notes-file remember-data-file)))
11479 (read-file-name (format "File name [%s]: " default)
11480 (file-name-as-directory org-directory)
11481 default)))
11483 (defun org-notes-order-reversed-p ()
11484 "Check if the current file should receive notes in reversed order."
11485 (cond
11486 ((not org-reverse-note-order) nil)
11487 ((eq t org-reverse-note-order) t)
11488 ((not (listp org-reverse-note-order)) nil)
11489 (t (catch 'exit
11490 (let ((all org-reverse-note-order)
11491 entry)
11492 (while (setq entry (pop all))
11493 (if (string-match (car entry) buffer-file-name)
11494 (throw 'exit (cdr entry))))
11495 nil)))))
11497 (defvar org-refile-target-table nil
11498 "The list of refile targets, created by `org-refile'.")
11500 (defvar org-agenda-new-buffers nil
11501 "Buffers created to visit agenda files.")
11503 (defvar org-refile-cache nil
11504 "Cache for refile targets.")
11506 (defvar org-refile-markers nil
11507 "All the markers used for caching refile locations.")
11509 (defun org-refile-marker (pos)
11510 "Get a new refile marker, but only if caching is in use."
11511 (if (not org-refile-use-cache)
11513 (let ((m (make-marker)))
11514 (move-marker m pos)
11515 (push m org-refile-markers)
11516 m)))
11518 (defun org-refile-cache-clear ()
11519 "Clear the refile cache and disable all the markers."
11520 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11521 (setq org-refile-markers nil)
11522 (setq org-refile-cache nil)
11523 (message "Refile cache has been cleared"))
11525 (defun org-refile-cache-check-set (set)
11526 "Check if all the markers in the cache still have live buffers."
11527 (let (marker)
11528 (catch 'exit
11529 (while (and set (setq marker (nth 3 (pop set))))
11530 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11531 (when (and marker (null (marker-buffer marker)))
11532 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11533 (sit-for 3)
11534 (throw 'exit nil)))
11535 t)))
11537 (defun org-refile-cache-put (set &rest identifiers)
11538 "Push the refile targets SET into the cache, under IDENTIFIERS."
11539 (let* ((key (sha1 (prin1-to-string identifiers)))
11540 (entry (assoc key org-refile-cache)))
11541 (if entry
11542 (setcdr entry set)
11543 (push (cons key set) org-refile-cache))))
11545 (defun org-refile-cache-get (&rest identifiers)
11546 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11547 (cond
11548 ((not org-refile-cache) nil)
11549 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11551 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11552 org-refile-cache))))
11553 (and set (org-refile-cache-check-set set) set)))))
11555 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11556 "Produce a table with refile targets."
11557 (let ((case-fold-search nil)
11558 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11559 (entries (or org-refile-targets '((nil . (:level . 1)))))
11560 targets tgs txt re files f desc descre fast-path-p level pos0)
11561 (message "Getting targets...")
11562 (with-current-buffer (or default-buffer (current-buffer))
11563 (while (setq entry (pop entries))
11564 (setq files (car entry) desc (cdr entry))
11565 (setq fast-path-p nil)
11566 (cond
11567 ((null files) (setq files (list (current-buffer))))
11568 ((eq files 'org-agenda-files)
11569 (setq files (org-agenda-files 'unrestricted)))
11570 ((and (symbolp files) (fboundp files))
11571 (setq files (funcall files)))
11572 ((and (symbolp files) (boundp files))
11573 (setq files (symbol-value files))))
11574 (if (stringp files) (setq files (list files)))
11575 (cond
11576 ((eq (car desc) :tag)
11577 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11578 ((eq (car desc) :todo)
11579 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11580 ((eq (car desc) :regexp)
11581 (setq descre (cdr desc)))
11582 ((eq (car desc) :level)
11583 (setq descre (concat "^\\*\\{" (number-to-string
11584 (if org-odd-levels-only
11585 (1- (* 2 (cdr desc)))
11586 (cdr desc)))
11587 "\\}[ \t]")))
11588 ((eq (car desc) :maxlevel)
11589 (setq fast-path-p t)
11590 (setq descre (concat "^\\*\\{1," (number-to-string
11591 (if org-odd-levels-only
11592 (1- (* 2 (cdr desc)))
11593 (cdr desc)))
11594 "\\}[ \t]")))
11595 (t (error "Bad refiling target description %s" desc)))
11596 (while (setq f (pop files))
11597 (with-current-buffer
11598 (if (bufferp f) f (org-get-agenda-file-buffer f))
11600 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11601 (progn
11602 (if (bufferp f) (setq f (buffer-file-name
11603 (buffer-base-buffer f))))
11604 (setq f (and f (expand-file-name f)))
11605 (if (eq org-refile-use-outline-path 'file)
11606 (push (list (file-name-nondirectory f) f nil nil) tgs))
11607 (save-excursion
11608 (save-restriction
11609 (widen)
11610 (goto-char (point-min))
11611 (while (re-search-forward descre nil t)
11612 (goto-char (setq pos0 (point-at-bol)))
11613 (catch 'next
11614 (when org-refile-target-verify-function
11615 (save-match-data
11616 (or (funcall org-refile-target-verify-function)
11617 (throw 'next t))))
11618 (when (and (looking-at org-complex-heading-regexp)
11619 (not (member (match-string 4) excluded-entries))
11620 (match-string 4))
11621 (setq level (org-reduced-level
11622 (- (match-end 1) (match-beginning 1)))
11623 txt (org-link-display-format (match-string 4))
11624 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11625 re (format org-complex-heading-regexp-format
11626 (regexp-quote (match-string 4))))
11627 (when org-refile-use-outline-path
11628 (setq txt (mapconcat
11629 'org-protect-slash
11630 (append
11631 (if (eq org-refile-use-outline-path
11632 'file)
11633 (list (file-name-nondirectory
11634 (buffer-file-name
11635 (buffer-base-buffer))))
11636 (if (eq org-refile-use-outline-path
11637 'full-file-path)
11638 (list (buffer-file-name
11639 (buffer-base-buffer)))))
11640 (org-get-outline-path fast-path-p
11641 level txt)
11642 (list txt))
11643 "/")))
11644 (push (list txt f re (org-refile-marker (point)))
11645 tgs)))
11646 (when (= (point) pos0)
11647 ;; verification function has not moved point
11648 (goto-char (point-at-eol))))))))
11649 (when org-refile-use-cache
11650 (org-refile-cache-put tgs (buffer-file-name) descre))
11651 (setq targets (append tgs targets))))))
11652 (message "Getting targets...done")
11653 (nreverse targets)))
11655 (defun org-protect-slash (s)
11656 (while (string-match "/" s)
11657 (setq s (replace-match "\\" t t s)))
11660 (defvar org-olpa (make-vector 20 nil))
11662 (defun org-get-outline-path (&optional fastp level heading)
11663 "Return the outline path to the current entry, as a list.
11665 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11666 routine which makes outline path derivations for an entire file,
11667 avoiding backtracing. Refile target collection makes use of that."
11668 (if fastp
11669 (progn
11670 (if (> level 19)
11671 (error "Outline path failure, more than 19 levels"))
11672 (loop for i from level upto 19 do
11673 (aset org-olpa i nil))
11674 (prog1
11675 (delq nil (append org-olpa nil))
11676 (aset org-olpa level heading)))
11677 (let (rtn case-fold-search)
11678 (save-excursion
11679 (save-restriction
11680 (widen)
11681 (while (org-up-heading-safe)
11682 (when (looking-at org-complex-heading-regexp)
11683 (push (org-trim
11684 (replace-regexp-in-string
11685 ;; Remove statistical/checkboxes cookies
11686 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11687 (org-match-string-no-properties 4)))
11688 rtn)))
11689 rtn)))))
11691 (defun org-format-outline-path (path &optional width prefix separator)
11692 "Format the outline path PATH for display.
11693 WIDTH is the maximum number of characters that is available.
11694 PREFIX is a prefix to be included in the returned string,
11695 such as the file name.
11696 SEPARATOR is inserted between the different parts of the path,
11697 the default is \"/\"."
11698 (setq width (or width 79))
11699 (if prefix (setq width (- width (length prefix))))
11700 (if (not path)
11701 (or prefix "")
11702 (let* ((nsteps (length path))
11703 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11704 (maxwidth (if (<= total-width width)
11705 10000 ;; everything fits
11706 ;; we need to shorten the level headings
11707 (/ (- width nsteps) nsteps)))
11708 (org-odd-levels-only nil)
11709 (n 0)
11710 (total (1+ (length prefix))))
11711 (setq maxwidth (max maxwidth 10))
11712 (concat prefix
11713 (if prefix (or separator "/"))
11714 (mapconcat
11715 (lambda (h)
11716 (setq n (1+ n))
11717 (if (and (= n nsteps) (< maxwidth 10000))
11718 (setq maxwidth (- total-width total)))
11719 (if (< (length h) maxwidth)
11720 (progn (setq total (+ total (length h) 1)) h)
11721 (setq h (substring h 0 (- maxwidth 2))
11722 total (+ total maxwidth 1))
11723 (if (string-match "[ \t]+\\'" h)
11724 (setq h (substring h 0 (match-beginning 0))))
11725 (setq h (concat h "..")))
11726 (org-add-props h nil 'face
11727 (nth (% (1- n) org-n-level-faces)
11728 org-level-faces))
11730 path (or separator "/"))))))
11732 (defun org-display-outline-path (&optional file current separator just-return-string)
11733 "Display the current outline path in the echo area.
11735 If FILE is non-nil, prepend the output with the file name.
11736 If CURRENT is non-nil, append the current heading to the output.
11737 SEPARATOR is passed through to `org-format-outline-path'. It separates
11738 the different parts of the path and defaults to \"/\".
11739 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11740 (interactive "P")
11741 (let* (case-fold-search
11742 (bfn (buffer-file-name (buffer-base-buffer)))
11743 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11744 res)
11745 (if current (setq path (append path
11746 (save-excursion
11747 (org-back-to-heading t)
11748 (if (looking-at org-complex-heading-regexp)
11749 (list (match-string 4)))))))
11750 (setq res
11751 (org-format-outline-path
11752 path
11753 (1- (frame-width))
11754 (and file bfn (concat (file-name-nondirectory bfn) separator))
11755 separator))
11756 (if just-return-string
11757 (org-no-properties res)
11758 (org-unlogged-message "%s" res))))
11760 (defvar org-refile-history nil
11761 "History for refiling operations.")
11763 (defvar org-after-refile-insert-hook nil
11764 "Hook run after `org-refile' has inserted its stuff at the new location.
11765 Note that this is still *before* the stuff will be removed from
11766 the *old* location.")
11768 (defvar org-capture-last-stored-marker)
11769 (defvar org-refile-keep nil
11770 "Non-nil means `org-refile' will copy instead of refile.")
11772 (defun org-copy ()
11773 "Like `org-refile', but copy."
11774 (interactive)
11775 (let ((org-refile-keep t))
11776 (funcall 'org-refile nil nil nil "Copy")))
11778 (defun org-refile (&optional arg default-buffer rfloc msg)
11779 "Move the entry or entries at point to another heading.
11780 The list of target headings is compiled using the information in
11781 `org-refile-targets', which see.
11783 At the target location, the entry is filed as a subitem of the
11784 target heading. Depending on `org-reverse-note-order', the new
11785 subitem will either be the first or the last subitem.
11787 If there is an active region, all entries in that region will be
11788 refiled. However, the region must fulfill the requirement that
11789 the first heading sets the top-level of the moved text.
11791 With prefix arg ARG, the command will only visit the target
11792 location and not actually move anything.
11794 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11795 refiling operation has put the subtree.
11797 With a numeric prefix argument of `2', refile to the running clock.
11799 With a numeric prefix argument of `3', emulate `org-refile-keep'
11800 being set to `t' and copy to the target location, don't move it.
11801 Beware that keeping refiled entries may result in duplicated ID
11802 properties.
11804 RFLOC can be a refile location obtained in a different way.
11806 MSG is a string to replace \"Refile\" in the default prompt with
11807 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11809 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11811 If you are using target caching (see `org-refile-use-cache'), you
11812 have to clear the target cache in order to find new targets.
11813 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11814 prefix argument (`C-u C-u C-u C-c C-w')."
11815 (interactive "P")
11816 (if (member arg '(0 (64)))
11817 (org-refile-cache-clear)
11818 (let* ((actionmsg (cond (msg msg)
11819 ((equal arg 3) "Refile (and keep)")
11820 (t "Refile")))
11821 (cbuf (current-buffer))
11822 (regionp (org-region-active-p))
11823 (region-start (and regionp (region-beginning)))
11824 (region-end (and regionp (region-end)))
11825 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11826 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11827 pos it nbuf file re level reversed)
11828 (setq last-command nil)
11829 (when regionp
11830 (goto-char region-start)
11831 (or (bolp) (goto-char (point-at-bol)))
11832 (setq region-start (point))
11833 (unless (or (org-kill-is-subtree-p
11834 (buffer-substring region-start region-end))
11835 (prog1 org-refile-active-region-within-subtree
11836 (let ((s (point-at-eol)))
11837 (org-toggle-heading)
11838 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11839 (user-error "The region is not a (sequence of) subtree(s)")))
11840 (if (equal arg '(16))
11841 (org-refile-goto-last-stored)
11842 (when (or
11843 (and (equal arg 2)
11844 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11845 (prog1
11846 (setq it (list (or org-clock-heading "running clock")
11847 (buffer-file-name
11848 (marker-buffer org-clock-hd-marker))
11850 (marker-position org-clock-hd-marker)))
11851 (setq arg nil)))
11852 (setq it (or rfloc
11853 (let (heading-text)
11854 (save-excursion
11855 (unless (and arg (listp arg))
11856 (org-back-to-heading t)
11857 (setq heading-text
11858 (replace-regexp-in-string
11859 org-bracket-link-regexp
11860 "\\3"
11861 (nth 4 (org-heading-components)))))
11862 (org-refile-get-location
11863 (cond ((and arg (listp arg)) "Goto")
11864 (regionp (concat actionmsg " region to"))
11865 (t (concat actionmsg " subtree \""
11866 heading-text "\" to")))
11867 default-buffer
11868 (and (not (equal '(4) arg))
11869 org-refile-allow-creating-parent-nodes)
11870 arg))))))
11871 (setq file (nth 1 it)
11872 re (nth 2 it)
11873 pos (nth 3 it))
11874 (if (and (not arg)
11876 (equal (buffer-file-name) file)
11877 (if regionp
11878 (and (>= pos region-start)
11879 (<= pos region-end))
11880 (and (>= pos (point))
11881 (< pos (save-excursion
11882 (org-end-of-subtree t t))))))
11883 (error "Cannot refile to position inside the tree or region"))
11884 (setq nbuf (or (find-buffer-visiting file)
11885 (find-file-noselect file)))
11886 (if (and arg (not (equal arg 3)))
11887 (progn
11888 (org-pop-to-buffer-same-window nbuf)
11889 (goto-char pos)
11890 (org-show-context 'org-goto))
11891 (if regionp
11892 (progn
11893 (org-kill-new (buffer-substring region-start region-end))
11894 (org-save-markers-in-region region-start region-end))
11895 (org-copy-subtree 1 nil t))
11896 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11897 (find-file-noselect file)))
11898 (setq reversed (org-notes-order-reversed-p))
11899 (save-excursion
11900 (save-restriction
11901 (widen)
11902 (if pos
11903 (progn
11904 (goto-char pos)
11905 (looking-at org-outline-regexp)
11906 (setq level (org-get-valid-level (funcall outline-level) 1))
11907 (goto-char
11908 (if reversed
11909 (or (outline-next-heading) (point-max))
11910 (or (save-excursion (org-get-next-sibling))
11911 (org-end-of-subtree t t)
11912 (point-max)))))
11913 (setq level 1)
11914 (if (not reversed)
11915 (goto-char (point-max))
11916 (goto-char (point-min))
11917 (or (outline-next-heading) (goto-char (point-max)))))
11918 (if (not (bolp)) (newline))
11919 (org-paste-subtree level nil nil t)
11920 (when org-log-refile
11921 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11922 (unless (eq org-log-refile 'note)
11923 (save-excursion (org-add-log-note))))
11924 (and org-auto-align-tags
11925 (let ((org-loop-over-headlines-in-active-region nil))
11926 (org-set-tags nil t)))
11927 (let ((bookmark-name (plist-get org-bookmark-names-plist
11928 :last-refile)))
11929 (when bookmark-name
11930 (with-demoted-errors
11931 (bookmark-set bookmark-name))))
11932 ;; If we are refiling for capture, make sure that the
11933 ;; last-capture pointers point here
11934 (when (org-bound-and-true-p org-refile-for-capture)
11935 (let ((bookmark-name (plist-get org-bookmark-names-plist
11936 :last-capture-marker)))
11937 (when bookmark-name
11938 (with-demoted-errors
11939 (bookmark-set bookmark-name))))
11940 (move-marker org-capture-last-stored-marker (point)))
11941 (if (fboundp 'deactivate-mark) (deactivate-mark))
11942 (run-hooks 'org-after-refile-insert-hook))))
11943 (unless org-refile-keep
11944 (if regionp
11945 (delete-region (point) (+ (point) (- region-end region-start)))
11946 (delete-region
11947 (and (org-back-to-heading t) (point))
11948 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11949 (when (featurep 'org-inlinetask)
11950 (org-inlinetask-remove-END-maybe))
11951 (setq org-markers-to-move nil)
11952 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11954 (defun org-refile-goto-last-stored ()
11955 "Go to the location where the last refile was stored."
11956 (interactive)
11957 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11958 (message "This is the location of the last refile"))
11960 (defun org-refile--get-location (refloc tbl)
11961 "When user refile to REFLOC, find the associated target in TBL.
11962 Also check `org-refile-target-table'."
11963 (car (delq
11965 (mapcar
11966 (lambda (r) (or (assoc r tbl)
11967 (assoc r org-refile-target-table)))
11968 (list (replace-regexp-in-string "/$" "" refloc)
11969 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11971 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11972 no-exclude)
11973 "Prompt the user for a refile location, using PROMPT.
11974 PROMPT should not be suffixed with a colon and a space, because
11975 this function appends the default value from
11976 `org-refile-history' automatically, if that is not empty.
11977 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11978 this is used for the GOTO interface."
11979 (let ((org-refile-targets org-refile-targets)
11980 (org-refile-use-outline-path org-refile-use-outline-path)
11981 excluded-entries)
11982 (when (and (derived-mode-p 'org-mode)
11983 (not org-refile-use-cache)
11984 (not no-exclude))
11985 (org-map-tree
11986 (lambda()
11987 (setq excluded-entries
11988 (append excluded-entries (list (org-get-heading t t)))))))
11989 (setq org-refile-target-table
11990 (org-refile-get-targets default-buffer excluded-entries)))
11991 (unless org-refile-target-table
11992 (user-error "No refile targets"))
11993 (let* ((cbuf (current-buffer))
11994 (partial-completion-mode nil)
11995 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11996 (cfunc (if (and org-refile-use-outline-path
11997 org-outline-path-complete-in-steps)
11998 'org-olpath-completing-read
11999 'org-icompleting-read))
12000 (extra (if org-refile-use-outline-path "/" ""))
12001 (cbnex (concat (buffer-name) extra))
12002 (filename (and cfn (expand-file-name cfn)))
12003 (tbl (mapcar
12004 (lambda (x)
12005 (if (and (not (member org-refile-use-outline-path
12006 '(file full-file-path)))
12007 (not (equal filename (nth 1 x))))
12008 (cons (concat (car x) extra " ("
12009 (file-name-nondirectory (nth 1 x)) ")")
12010 (cdr x))
12011 (cons (concat (car x) extra) (cdr x))))
12012 org-refile-target-table))
12013 (completion-ignore-case t)
12014 cdef
12015 (prompt (concat prompt
12016 (or (and (car org-refile-history)
12017 (concat " (default " (car org-refile-history) ")"))
12018 (and (assoc cbnex tbl) (setq cdef cbnex)
12019 (concat " (default " cbnex ")"))) ": "))
12020 pa answ parent-target child parent old-hist)
12021 (setq old-hist org-refile-history)
12022 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12023 nil 'org-refile-history (or cdef (car org-refile-history))))
12024 (if (setq pa (org-refile--get-location answ tbl))
12025 (progn
12026 (org-refile-check-position pa)
12027 (when (or (not org-refile-history)
12028 (not (eq old-hist org-refile-history))
12029 (not (equal (car pa) (car org-refile-history))))
12030 (setq org-refile-history
12031 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12032 org-refile-history
12033 (cdr org-refile-history))))
12034 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12035 (pop org-refile-history)))
12037 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12038 (progn
12039 (setq parent (match-string 1 answ)
12040 child (match-string 2 answ))
12041 (setq parent-target (org-refile--get-location parent tbl))
12042 (when (and parent-target
12043 (or (eq new-nodes t)
12044 (and (eq new-nodes 'confirm)
12045 (y-or-n-p (format "Create new node \"%s\"? "
12046 child)))))
12047 (org-refile-new-child parent-target child)))
12048 (user-error "Invalid target location")))))
12050 (declare-function org-string-nw-p "org-macs" (s))
12051 (defun org-refile-check-position (refile-pointer)
12052 "Check if the refile pointer matches the headline to which it points."
12053 (let* ((file (nth 1 refile-pointer))
12054 (re (nth 2 refile-pointer))
12055 (pos (nth 3 refile-pointer))
12056 buffer)
12057 (if (and (not (markerp pos)) (not file))
12058 (user-error "Please indicate a target file in the refile path")
12059 (when (org-string-nw-p re)
12060 (setq buffer (if (markerp pos)
12061 (marker-buffer pos)
12062 (or (find-buffer-visiting file)
12063 (find-file-noselect file))))
12064 (with-current-buffer buffer
12065 (save-excursion
12066 (save-restriction
12067 (widen)
12068 (goto-char pos)
12069 (beginning-of-line 1)
12070 (unless (org-looking-at-p re)
12071 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12073 (defun org-refile-new-child (parent-target child)
12074 "Use refile target PARENT-TARGET to add new CHILD below it."
12075 (unless parent-target
12076 (error "Cannot find parent for new node"))
12077 (let ((file (nth 1 parent-target))
12078 (pos (nth 3 parent-target))
12079 level)
12080 (with-current-buffer (or (find-buffer-visiting file)
12081 (find-file-noselect file))
12082 (save-excursion
12083 (save-restriction
12084 (widen)
12085 (if pos
12086 (goto-char pos)
12087 (goto-char (point-max))
12088 (if (not (bolp)) (newline)))
12089 (when (looking-at org-outline-regexp)
12090 (setq level (funcall outline-level))
12091 (org-end-of-subtree t t))
12092 (org-back-over-empty-lines)
12093 (insert "\n" (make-string
12094 (if pos (org-get-valid-level level 1) 1) ?*)
12095 " " child "\n")
12096 (beginning-of-line 0)
12097 (list (concat (car parent-target) "/" child) file "" (point)))))))
12099 (defun org-olpath-completing-read (prompt collection &rest args)
12100 "Read an outline path like a file name."
12101 (let ((thetable collection)
12102 (org-completion-use-ido nil) ; does not work with ido.
12103 (org-completion-use-iswitchb nil)) ; or iswitchb
12104 (apply
12105 'org-icompleting-read prompt
12106 (lambda (string predicate &optional flag)
12107 (let (rtn r f (l (length string)))
12108 (cond
12109 ((eq flag nil)
12110 ;; try completion
12111 (try-completion string thetable))
12112 ((eq flag t)
12113 ;; all-completions
12114 (setq rtn (all-completions string thetable predicate))
12115 (mapcar
12116 (lambda (x)
12117 (setq r (substring x l))
12118 (if (string-match " ([^)]*)$" x)
12119 (setq f (match-string 0 x))
12120 (setq f ""))
12121 (if (string-match "/" r)
12122 (concat string (substring r 0 (match-end 0)) f)
12124 rtn))
12125 ((eq flag 'lambda)
12126 ;; exact match?
12127 (assoc string thetable)))))
12128 args)))
12130 ;;;; Dynamic blocks
12132 (defun org-find-dblock (name)
12133 "Find the first dynamic block with name NAME in the buffer.
12134 If not found, stay at current position and return nil."
12135 (let ((case-fold-search t) pos)
12136 (save-excursion
12137 (goto-char (point-min))
12138 (setq pos (and (re-search-forward
12139 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12140 (match-beginning 0))))
12141 (if pos (goto-char pos))
12142 pos))
12144 (defun org-create-dblock (plist)
12145 "Create a dynamic block section, with parameters taken from PLIST.
12146 PLIST must contain a :name entry which is used as the name of the block."
12147 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12148 (end-of-line 1)
12149 (newline))
12150 (let ((col (current-column))
12151 (name (plist-get plist :name)))
12152 (insert "#+BEGIN: " name)
12153 (while plist
12154 (if (eq (car plist) :name)
12155 (setq plist (cddr plist))
12156 (insert " " (prin1-to-string (pop plist)))))
12157 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12158 (beginning-of-line -2)))
12160 (defun org-prepare-dblock ()
12161 "Prepare dynamic block for refresh.
12162 This empties the block, puts the cursor at the insert position and returns
12163 the property list including an extra property :name with the block name."
12164 (unless (looking-at org-dblock-start-re)
12165 (user-error "Not at a dynamic block"))
12166 (let* ((begdel (1+ (match-end 0)))
12167 (name (org-no-properties (match-string 1)))
12168 (params (append (list :name name)
12169 (read (concat "(" (match-string 3) ")")))))
12170 (save-excursion
12171 (beginning-of-line 1)
12172 (skip-chars-forward " \t")
12173 (setq params (plist-put params :indentation-column (current-column))))
12174 (unless (re-search-forward org-dblock-end-re nil t)
12175 (error "Dynamic block not terminated"))
12176 (setq params
12177 (append params
12178 (list :content (buffer-substring
12179 begdel (match-beginning 0)))))
12180 (delete-region begdel (match-beginning 0))
12181 (goto-char begdel)
12182 (open-line 1)
12183 params))
12185 (defun org-map-dblocks (&optional command)
12186 "Apply COMMAND to all dynamic blocks in the current buffer.
12187 If COMMAND is not given, use `org-update-dblock'."
12188 (let ((cmd (or command 'org-update-dblock)))
12189 (save-excursion
12190 (goto-char (point-min))
12191 (while (re-search-forward org-dblock-start-re nil t)
12192 (goto-char (match-beginning 0))
12193 (save-excursion
12194 (condition-case nil
12195 (funcall cmd)
12196 (error (message "Error during update of dynamic block"))))
12197 (unless (re-search-forward org-dblock-end-re nil t)
12198 (error "Dynamic block not terminated"))))))
12200 (defun org-dblock-update (&optional arg)
12201 "User command for updating dynamic blocks.
12202 Update the dynamic block at point. With prefix ARG, update all dynamic
12203 blocks in the buffer."
12204 (interactive "P")
12205 (if arg
12206 (org-update-all-dblocks)
12207 (or (looking-at org-dblock-start-re)
12208 (org-beginning-of-dblock))
12209 (org-update-dblock)))
12211 (defun org-update-dblock ()
12212 "Update the dynamic block at point.
12213 This means to empty the block, parse for parameters and then call
12214 the correct writing function."
12215 (interactive)
12216 (save-excursion
12217 (let* ((win (selected-window))
12218 (pos (point))
12219 (line (org-current-line))
12220 (params (org-prepare-dblock))
12221 (name (plist-get params :name))
12222 (indent (plist-get params :indentation-column))
12223 (cmd (intern (concat "org-dblock-write:" name))))
12224 (message "Updating dynamic block `%s' at line %d..." name line)
12225 (funcall cmd params)
12226 (message "Updating dynamic block `%s' at line %d...done" name line)
12227 (goto-char pos)
12228 (when (and indent (> indent 0))
12229 (setq indent (make-string indent ?\ ))
12230 (save-excursion
12231 (select-window win)
12232 (org-beginning-of-dblock)
12233 (forward-line 1)
12234 (while (not (looking-at org-dblock-end-re))
12235 (insert indent)
12236 (beginning-of-line 2))
12237 (when (looking-at org-dblock-end-re)
12238 (and (looking-at "[ \t]+")
12239 (replace-match ""))
12240 (insert indent)))))))
12242 (defun org-beginning-of-dblock ()
12243 "Find the beginning of the dynamic block at point.
12244 Error if there is no such block at point."
12245 (let ((pos (point))
12246 beg)
12247 (end-of-line 1)
12248 (if (and (re-search-backward org-dblock-start-re nil t)
12249 (setq beg (match-beginning 0))
12250 (re-search-forward org-dblock-end-re nil t)
12251 (> (match-end 0) pos))
12252 (goto-char beg)
12253 (goto-char pos)
12254 (error "Not in a dynamic block"))))
12256 (defun org-update-all-dblocks ()
12257 "Update all dynamic blocks in the buffer.
12258 This function can be used in a hook."
12259 (interactive)
12260 (when (derived-mode-p 'org-mode)
12261 (org-map-dblocks 'org-update-dblock)))
12264 ;;;; Completion
12266 (declare-function org-export-backend-name "org-export" (cl-x))
12267 (declare-function org-export-backend-options "org-export" (cl-x))
12268 (defun org-get-export-keywords ()
12269 "Return a list of all currently understood export keywords.
12270 Export keywords include options, block names, attributes and
12271 keywords relative to each registered export back-end."
12272 (let (keywords)
12273 (dolist (backend
12274 (org-bound-and-true-p org-export--registered-backends)
12275 (delq nil keywords))
12276 ;; Back-end name (for keywords, like #+LATEX:)
12277 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12278 (dolist (option-entry (org-export-backend-options backend))
12279 ;; Back-end options.
12280 (push (nth 1 option-entry) keywords)))))
12282 (defconst org-options-keywords
12283 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12284 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12285 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12286 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12287 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12289 (defcustom org-structure-template-alist
12290 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12291 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12292 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12293 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12294 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12295 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12296 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12297 ("L" "#+LaTeX: ")
12298 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12299 ("H" "#+HTML: ")
12300 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12301 ("A" "#+ASCII: ")
12302 ("i" "#+INDEX: ?")
12303 ("I" "#+INCLUDE: %file ?"))
12304 "Structure completion elements.
12305 This is a list of abbreviation keys and values. The value gets inserted
12306 if you type `<' followed by the key and then press the completion key,
12307 usually `TAB'. %file will be replaced by a file name after prompting
12308 for the file using completion. The cursor will be placed at the position
12309 of the `?` in the template.
12310 There are two templates for each key, the first uses the original Org syntax,
12311 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12312 the default when the /org-mtags.el/ module has been loaded. See also the
12313 variable `org-mtags-prefer-muse-templates'."
12314 :group 'org-completion
12315 :type '(repeat
12316 (list
12317 (string :tag "Key")
12318 (string :tag "Template")))
12319 :version "25.1"
12320 :package-version '(Org . "8.3"))
12322 (defun org-try-structure-completion ()
12323 "Try to complete a structure template before point.
12324 This looks for strings like \"<e\" on an otherwise empty line and
12325 expands them."
12326 (let ((l (buffer-substring (point-at-bol) (point)))
12328 (when (and (looking-at "[ \t]*$")
12329 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12330 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12331 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12332 (match-beginning 1)) a)
12333 t)))
12335 (defun org-complete-expand-structure-template (start cell)
12336 "Expand a structure template."
12337 (let ((rpl (nth 1 cell))
12338 (ind ""))
12339 (delete-region start (point))
12340 (when (string-match "\\`[ \t]*#\\+" rpl)
12341 (cond
12342 ((bolp))
12343 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12344 (setq ind (buffer-substring (point-at-bol) (point))))
12345 (t (newline))))
12346 (setq start (point))
12347 (if (string-match "%file" rpl)
12348 (setq rpl (replace-match
12349 (concat
12350 "\""
12351 (save-match-data
12352 (abbreviate-file-name (read-file-name "Include file: ")))
12353 "\"")
12354 t t rpl)))
12355 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12356 (concat "\n" ind)))
12357 (insert rpl)
12358 (if (re-search-backward "\\?" start t) (delete-char 1))))
12360 ;;;; TODO, DEADLINE, Comments
12362 (defun org-toggle-comment ()
12363 "Change the COMMENT state of an entry."
12364 (interactive)
12365 (save-excursion
12366 (org-back-to-heading)
12367 (looking-at org-complex-heading-regexp)
12368 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12369 (skip-chars-forward " \t")
12370 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12371 (if (org-in-commented-heading-p t)
12372 (delete-region (point)
12373 (progn (search-forward " " (line-end-position) 'move)
12374 (skip-chars-forward " \t")
12375 (point)))
12376 (insert org-comment-string)
12377 (unless (eolp) (insert " ")))))
12379 (defvar org-last-todo-state-is-todo nil
12380 "This is non-nil when the last TODO state change led to a TODO state.
12381 If the last change removed the TODO tag or switched to DONE, then
12382 this is nil.")
12384 (defvar org-setting-tags nil) ; dynamically skipped
12386 (defvar org-todo-setup-filter-hook nil
12387 "Hook for functions that pre-filter todo specs.
12388 Each function takes a todo spec and returns either nil or the spec
12389 transformed into canonical form." )
12391 (defvar org-todo-get-default-hook nil
12392 "Hook for functions that get a default item for todo.
12393 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12394 nil or a string to be used for the todo mark." )
12396 (defvar org-agenda-headline-snapshot-before-repeat)
12398 (defun org-current-effective-time ()
12399 "Return current time adjusted for `org-extend-today-until' variable."
12400 (let* ((ct (org-current-time))
12401 (dct (decode-time ct))
12402 (ct1
12403 (cond
12404 (org-use-last-clock-out-time-as-effective-time
12405 (or (org-clock-get-last-clock-out-time) ct))
12406 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12407 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12408 (t ct))))
12409 ct1))
12411 (defun org-todo-yesterday (&optional arg)
12412 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12413 (interactive "P")
12414 (if (eq major-mode 'org-agenda-mode)
12415 (apply 'org-agenda-todo-yesterday arg)
12416 (let* ((org-use-effective-time t)
12417 (hour (third (decode-time
12418 (org-current-time))))
12419 (org-extend-today-until (1+ hour)))
12420 (org-todo arg))))
12422 (defvar org-block-entry-blocking ""
12423 "First entry preventing the TODO state change.")
12425 (defun org-cancel-repeater ()
12426 "Cancel a repeater by setting its numeric value to zero."
12427 (interactive)
12428 (save-excursion
12429 (org-back-to-heading t)
12430 (let ((bound1 (point))
12431 (bound0 (save-excursion (outline-next-heading) (point))))
12432 (when (re-search-forward
12433 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12434 org-deadline-time-regexp "\\)\\|\\("
12435 org-ts-regexp "\\)")
12436 bound0 t)
12437 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12438 (replace-match "0" t nil nil 1))))))
12440 (defun org-todo (&optional arg)
12441 "Change the TODO state of an item.
12442 The state of an item is given by a keyword at the start of the heading,
12443 like
12444 *** TODO Write paper
12445 *** DONE Call mom
12447 The different keywords are specified in the variable `org-todo-keywords'.
12448 By default the available states are \"TODO\" and \"DONE\".
12449 So for this example: when the item starts with TODO, it is changed to DONE.
12450 When it starts with DONE, the DONE is removed. And when neither TODO nor
12451 DONE are present, add TODO at the beginning of the heading.
12453 With \\[universal-argument] prefix arg, use completion to determine the new \
12454 state.
12455 With numeric prefix arg, switch to that state.
12456 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12457 keywords (nextset).
12458 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12459 With a numeric prefix arg of 0, inhibit note taking for the change.
12460 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12462 When called through ELisp, arg is also interpreted in the following way:
12463 'none -> empty state
12464 \"\"(empty string) -> switch to empty state
12465 'done -> switch to DONE
12466 'nextset -> switch to the next set of keywords
12467 'previousset -> switch to the previous set of keywords
12468 \"WAITING\" -> switch to the specified keyword, but only if it
12469 really is a member of `org-todo-keywords'."
12470 (interactive "P")
12471 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12472 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12473 'region-start-level 'region))
12474 org-loop-over-headlines-in-active-region)
12475 (org-map-entries
12476 `(org-todo ,arg)
12477 org-loop-over-headlines-in-active-region
12478 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12479 (if (equal arg '(16)) (setq arg 'nextset))
12480 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12481 (let ((org-blocker-hook org-blocker-hook)
12482 commentp
12483 case-fold-search)
12484 (when (equal arg '(64))
12485 (setq arg nil org-blocker-hook nil))
12486 (when (and org-blocker-hook
12487 (or org-inhibit-blocking
12488 (org-entry-get nil "NOBLOCKING")))
12489 (setq org-blocker-hook nil))
12490 (save-excursion
12491 (catch 'exit
12492 (org-back-to-heading t)
12493 (when (org-in-commented-heading-p t)
12494 (org-toggle-comment)
12495 (setq commentp t))
12496 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12497 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12498 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12499 (let* ((match-data (match-data))
12500 (startpos (point-at-bol))
12501 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12502 (org-log-done org-log-done)
12503 (org-log-repeat org-log-repeat)
12504 (org-todo-log-states org-todo-log-states)
12505 (org-inhibit-logging
12506 (if (equal arg 0)
12507 (progn (setq arg nil) 'note) org-inhibit-logging))
12508 (this (match-string 1))
12509 (hl-pos (match-beginning 0))
12510 (head (org-get-todo-sequence-head this))
12511 (ass (assoc head org-todo-kwd-alist))
12512 (interpret (nth 1 ass))
12513 (done-word (nth 3 ass))
12514 (final-done-word (nth 4 ass))
12515 (org-last-state (or this ""))
12516 (completion-ignore-case t)
12517 (member (member this org-todo-keywords-1))
12518 (tail (cdr member))
12519 (org-state (cond
12520 ((and org-todo-key-trigger
12521 (or (and (equal arg '(4))
12522 (eq org-use-fast-todo-selection 'prefix))
12523 (and (not arg) org-use-fast-todo-selection
12524 (not (eq org-use-fast-todo-selection
12525 'prefix)))))
12526 ;; Use fast selection
12527 (org-fast-todo-selection))
12528 ((and (equal arg '(4))
12529 (or (not org-use-fast-todo-selection)
12530 (not org-todo-key-trigger)))
12531 ;; Read a state with completion
12532 (org-icompleting-read
12533 "State: " (mapcar 'list org-todo-keywords-1)
12534 nil t))
12535 ((eq arg 'right)
12536 (if this
12537 (if tail (car tail) nil)
12538 (car org-todo-keywords-1)))
12539 ((eq arg 'left)
12540 (if (equal member org-todo-keywords-1)
12542 (if this
12543 (nth (- (length org-todo-keywords-1)
12544 (length tail) 2)
12545 org-todo-keywords-1)
12546 (org-last org-todo-keywords-1))))
12547 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12548 (setq arg nil))) ; hack to fall back to cycling
12549 (arg
12550 ;; user or caller requests a specific state
12551 (cond
12552 ((equal arg "") nil)
12553 ((eq arg 'none) nil)
12554 ((eq arg 'done) (or done-word (car org-done-keywords)))
12555 ((eq arg 'nextset)
12556 (or (car (cdr (member head org-todo-heads)))
12557 (car org-todo-heads)))
12558 ((eq arg 'previousset)
12559 (let ((org-todo-heads (reverse org-todo-heads)))
12560 (or (car (cdr (member head org-todo-heads)))
12561 (car org-todo-heads))))
12562 ((car (member arg org-todo-keywords-1)))
12563 ((stringp arg)
12564 (user-error "State `%s' not valid in this file" arg))
12565 ((nth (1- (prefix-numeric-value arg))
12566 org-todo-keywords-1))))
12567 ((null member) (or head (car org-todo-keywords-1)))
12568 ((equal this final-done-word) nil) ;; -> make empty
12569 ((null tail) nil) ;; -> first entry
12570 ((memq interpret '(type priority))
12571 (if (eq this-command last-command)
12572 (car tail)
12573 (if (> (length tail) 0)
12574 (or done-word (car org-done-keywords))
12575 nil)))
12577 (car tail))))
12578 (org-state (or
12579 (run-hook-with-args-until-success
12580 'org-todo-get-default-hook org-state org-last-state)
12581 org-state))
12582 (next (if org-state (concat " " org-state " ") " "))
12583 (change-plist (list :type 'todo-state-change :from this :to org-state
12584 :position startpos))
12585 dolog now-done-p)
12586 (when org-blocker-hook
12587 (setq org-last-todo-state-is-todo
12588 (not (member this org-done-keywords)))
12589 (unless (save-excursion
12590 (save-match-data
12591 (org-with-wide-buffer
12592 (run-hook-with-args-until-failure
12593 'org-blocker-hook change-plist))))
12594 (if (org-called-interactively-p 'interactive)
12595 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12596 this org-state org-block-entry-blocking)
12597 ;; fail silently
12598 (message "TODO state change from %s to %s blocked (by \"%s\")"
12599 this org-state org-block-entry-blocking)
12600 (throw 'exit nil))))
12601 (store-match-data match-data)
12602 (replace-match next t t)
12603 (cond ((equal this org-state)
12604 (message "TODO state was already %s" (org-trim next)))
12605 ((pos-visible-in-window-p hl-pos)
12606 (message "TODO state changed to %s" (org-trim next))))
12607 (unless head
12608 (setq head (org-get-todo-sequence-head org-state)
12609 ass (assoc head org-todo-kwd-alist)
12610 interpret (nth 1 ass)
12611 done-word (nth 3 ass)
12612 final-done-word (nth 4 ass)))
12613 (when (memq arg '(nextset previousset))
12614 (message "Keyword-Set %d/%d: %s"
12615 (- (length org-todo-sets) -1
12616 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12617 (length org-todo-sets)
12618 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12619 (setq org-last-todo-state-is-todo
12620 (not (member org-state org-done-keywords)))
12621 (setq now-done-p (and (member org-state org-done-keywords)
12622 (not (member this org-done-keywords))))
12623 (and logging (org-local-logging logging))
12624 (when (and (or org-todo-log-states org-log-done)
12625 (not (eq org-inhibit-logging t))
12626 (not (memq arg '(nextset previousset))))
12627 ;; we need to look at recording a time and note
12628 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12629 (nth 2 (assoc this org-todo-log-states))))
12630 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12631 (setq dolog 'time))
12632 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12633 (and org-state
12634 (member org-state org-not-done-keywords)
12635 (not (member this org-not-done-keywords))))
12636 ;; This is now a todo state and was not one before
12637 ;; If there was a CLOSED time stamp, get rid of it.
12638 (org-add-planning-info nil nil 'closed))
12639 (when (and now-done-p org-log-done)
12640 ;; It is now done, and it was not done before
12641 (org-add-planning-info 'closed (org-current-effective-time))
12642 (if (and (not dolog) (eq 'note org-log-done))
12643 (org-add-log-setup 'done org-state this 'findpos 'note)))
12644 (when (and org-state dolog)
12645 ;; This is a non-nil state, and we need to log it
12646 (org-add-log-setup 'state org-state this 'findpos dolog)))
12647 ;; Fixup tag positioning
12648 (org-todo-trigger-tag-changes org-state)
12649 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12650 (when org-provide-todo-statistics
12651 (org-update-parent-todo-statistics))
12652 (run-hooks 'org-after-todo-state-change-hook)
12653 (if (and arg (not (member org-state org-done-keywords)))
12654 (setq head (org-get-todo-sequence-head org-state)))
12655 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12656 ;; Do we need to trigger a repeat?
12657 (when now-done-p
12658 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12659 ;; This is for the agenda, take a snapshot of the headline.
12660 (save-match-data
12661 (setq org-agenda-headline-snapshot-before-repeat
12662 (org-get-heading))))
12663 (org-auto-repeat-maybe org-state))
12664 ;; Fixup cursor location if close to the keyword
12665 (if (and (outline-on-heading-p)
12666 (not (bolp))
12667 (save-excursion (beginning-of-line 1)
12668 (looking-at org-todo-line-regexp))
12669 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12670 (progn
12671 (goto-char (or (match-end 2) (match-end 1)))
12672 (and (looking-at " ") (just-one-space))))
12673 (when org-trigger-hook
12674 (save-excursion
12675 (run-hook-with-args 'org-trigger-hook change-plist)))
12676 (when commentp (org-toggle-comment))))))))
12678 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12679 "Block turning an entry into a TODO, using the hierarchy.
12680 This checks whether the current task should be blocked from state
12681 changes. Such blocking occurs when:
12683 1. The task has children which are not all in a completed state.
12685 2. A task has a parent with the property :ORDERED:, and there
12686 are siblings prior to the current task with incomplete
12687 status.
12689 3. The parent of the task is blocked because it has siblings that should
12690 be done first, or is child of a block grandparent TODO entry."
12692 (if (not org-enforce-todo-dependencies)
12693 t ; if locally turned off don't block
12694 (catch 'dont-block
12695 ;; If this is not a todo state change, or if this entry is already DONE,
12696 ;; do not block
12697 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12698 (member (plist-get change-plist :from)
12699 (cons 'done org-done-keywords))
12700 (member (plist-get change-plist :to)
12701 (cons 'todo org-not-done-keywords))
12702 (not (plist-get change-plist :to)))
12703 (throw 'dont-block t))
12704 ;; If this task has children, and any are undone, it's blocked
12705 (save-excursion
12706 (org-back-to-heading t)
12707 (let ((this-level (funcall outline-level)))
12708 (outline-next-heading)
12709 (let ((child-level (funcall outline-level)))
12710 (while (and (not (eobp))
12711 (> child-level this-level))
12712 ;; this todo has children, check whether they are all
12713 ;; completed
12714 (if (and (not (org-entry-is-done-p))
12715 (org-entry-is-todo-p))
12716 (progn (setq org-block-entry-blocking (org-get-heading))
12717 (throw 'dont-block nil)))
12718 (outline-next-heading)
12719 (setq child-level (funcall outline-level))))))
12720 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12721 ;; any previous siblings are undone, it's blocked
12722 (save-excursion
12723 (org-back-to-heading t)
12724 (let* ((pos (point))
12725 (parent-pos (and (org-up-heading-safe) (point))))
12726 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12727 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12728 (forward-line 1)
12729 (re-search-forward org-not-done-heading-regexp pos t))
12730 (setq org-block-entry-blocking (match-string 0))
12731 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12732 ;; Search further up the hierarchy, to see if an ancestor is blocked
12733 (while t
12734 (goto-char parent-pos)
12735 (if (not (looking-at org-not-done-heading-regexp))
12736 (throw 'dont-block t)) ; do not block, parent is not a TODO
12737 (setq pos (point))
12738 (setq parent-pos (and (org-up-heading-safe) (point)))
12739 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12740 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12741 (forward-line 1)
12742 (re-search-forward org-not-done-heading-regexp pos t)
12743 (setq org-block-entry-blocking (org-get-heading)))
12744 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12746 (defcustom org-track-ordered-property-with-tag nil
12747 "Should the ORDERED property also be shown as a tag?
12748 The ORDERED property decides if an entry should require subtasks to be
12749 completed in sequence. Since a property is not very visible, setting
12750 this option means that toggling the ORDERED property with the command
12751 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12752 not relevant for the behavior, but it makes things more visible.
12754 Note that toggling the tag with tags commands will not change the property
12755 and therefore not influence behavior!
12757 This can be t, meaning the tag ORDERED should be used, It can also be a
12758 string to select a different tag for this task."
12759 :group 'org-todo
12760 :type '(choice
12761 (const :tag "No tracking" nil)
12762 (const :tag "Track with ORDERED tag" t)
12763 (string :tag "Use other tag")))
12765 (defun org-toggle-ordered-property ()
12766 "Toggle the ORDERED property of the current entry.
12767 For better visibility, you can track the value of this property with a tag.
12768 See variable `org-track-ordered-property-with-tag'."
12769 (interactive)
12770 (let* ((t1 org-track-ordered-property-with-tag)
12771 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12772 (save-excursion
12773 (org-back-to-heading)
12774 (if (org-entry-get nil "ORDERED")
12775 (progn
12776 (org-delete-property "ORDERED")
12777 (and tag (org-toggle-tag tag 'off))
12778 (message "Subtasks can be completed in arbitrary order"))
12779 (org-entry-put nil "ORDERED" "t")
12780 (and tag (org-toggle-tag tag 'on))
12781 (message "Subtasks must be completed in sequence")))))
12783 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12784 (defun org-block-todo-from-checkboxes (change-plist)
12785 "Block turning an entry into a TODO, using checkboxes.
12786 This checks whether the current task should be blocked from state
12787 changes because there are unchecked boxes in this entry."
12788 (if (not org-enforce-todo-checkbox-dependencies)
12789 t ; if locally turned off don't block
12790 (catch 'dont-block
12791 ;; If this is not a todo state change, or if this entry is already DONE,
12792 ;; do not block
12793 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12794 (member (plist-get change-plist :from)
12795 (cons 'done org-done-keywords))
12796 (member (plist-get change-plist :to)
12797 (cons 'todo org-not-done-keywords))
12798 (not (plist-get change-plist :to)))
12799 (throw 'dont-block t))
12800 ;; If this task has checkboxes that are not checked, it's blocked
12801 (save-excursion
12802 (org-back-to-heading t)
12803 (let ((beg (point)) end)
12804 (outline-next-heading)
12805 (setq end (point))
12806 (goto-char beg)
12807 (if (org-list-search-forward
12808 (concat (org-item-beginning-re)
12809 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12810 "\\[[- ]\\]")
12811 end t)
12812 (progn
12813 (if (boundp 'org-blocked-by-checkboxes)
12814 (setq org-blocked-by-checkboxes t))
12815 (throw 'dont-block nil)))))
12816 t))) ; do not block
12818 (defun org-entry-blocked-p ()
12819 "Is the current entry blocked?"
12820 (org-with-silent-modifications
12821 (if (org-entry-get nil "NOBLOCKING")
12822 nil ;; Never block this entry
12823 (not (run-hook-with-args-until-failure
12824 'org-blocker-hook
12825 (list :type 'todo-state-change
12826 :position (point)
12827 :from 'todo
12828 :to 'done))))))
12830 (defun org-update-statistics-cookies (all)
12831 "Update the statistics cookie, either from TODO or from checkboxes.
12832 This should be called with the cursor in a line with a statistics cookie."
12833 (interactive "P")
12834 (if all
12835 (progn
12836 (org-update-checkbox-count 'all)
12837 (org-map-entries 'org-update-parent-todo-statistics))
12838 (if (not (org-at-heading-p))
12839 (org-update-checkbox-count)
12840 (let ((pos (point-marker))
12841 end l1 l2)
12842 (ignore-errors (org-back-to-heading t))
12843 (if (not (org-at-heading-p))
12844 (org-update-checkbox-count)
12845 (setq l1 (org-outline-level))
12846 (setq end (save-excursion
12847 (outline-next-heading)
12848 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12849 (point)))
12850 (if (and (save-excursion
12851 (re-search-forward
12852 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12853 (not (save-excursion (re-search-forward
12854 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12855 (org-update-checkbox-count)
12856 (if (and l2 (> l2 l1))
12857 (progn
12858 (goto-char end)
12859 (org-update-parent-todo-statistics))
12860 (goto-char pos)
12861 (beginning-of-line 1)
12862 (while (re-search-forward
12863 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12864 (point-at-eol) t)
12865 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12866 (goto-char pos)
12867 (move-marker pos nil)))))
12869 (defvar org-entry-property-inherited-from) ;; defined below
12870 (defun org-update-parent-todo-statistics ()
12871 "Update any statistics cookie in the parent of the current headline.
12872 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12873 the entire subtree and this will travel up the hierarchy and update
12874 statistics everywhere."
12875 (let* ((prop (save-excursion (org-up-heading-safe)
12876 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12877 (recursive (or (not org-hierarchical-todo-statistics)
12878 (and prop (string-match "\\<recursive\\>" prop))))
12879 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12881 (first t)
12882 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12883 level ltoggle l1 new ndel
12884 (cnt-all 0) (cnt-done 0) is-percent kwd
12885 checkbox-beg ov ovs ove cookie-present)
12886 (catch 'exit
12887 (save-excursion
12888 (beginning-of-line 1)
12889 (setq ltoggle (funcall outline-level))
12890 ;; Three situations are to consider:
12892 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12893 ;; to the top-level ancestor on the headline;
12895 ;; 2. If parent has "recursive" property, repeat up to the
12896 ;; headline setting that property, taking inheritance into
12897 ;; account;
12899 ;; 3. Else, move up to direct parent and proceed only once.
12900 (while (and (setq level (org-up-heading-safe))
12901 (or recursive first)
12902 (>= (point) lim))
12903 (setq first nil cookie-present nil)
12904 (unless (and level
12905 (not (string-match
12906 "\\<checkbox\\>"
12907 (downcase (or (org-entry-get nil "COOKIE_DATA")
12908 "")))))
12909 (throw 'exit nil))
12910 (while (re-search-forward box-re (point-at-eol) t)
12911 (setq cnt-all 0 cnt-done 0 cookie-present t)
12912 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12913 (save-match-data
12914 (unless (outline-next-heading) (throw 'exit nil))
12915 (while (and (looking-at org-complex-heading-regexp)
12916 (> (setq l1 (length (match-string 1))) level))
12917 (setq kwd (and (or recursive (= l1 ltoggle))
12918 (match-string 2)))
12919 (if (or (eq org-provide-todo-statistics 'all-headlines)
12920 (and (eq org-provide-todo-statistics t)
12921 (or (member kwd org-done-keywords)))
12922 (and (listp org-provide-todo-statistics)
12923 (stringp (car org-provide-todo-statistics))
12924 (or (member kwd org-provide-todo-statistics)
12925 (member kwd org-done-keywords)))
12926 (and (listp org-provide-todo-statistics)
12927 (listp (car org-provide-todo-statistics))
12928 (or (member kwd (car org-provide-todo-statistics))
12929 (and (member kwd org-done-keywords)
12930 (member kwd (cadr org-provide-todo-statistics))))))
12931 (setq cnt-all (1+ cnt-all))
12932 (if (eq org-provide-todo-statistics t)
12933 (and kwd (setq cnt-all (1+ cnt-all)))))
12934 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12935 (member kwd org-done-keywords))
12936 (and (listp org-provide-todo-statistics)
12937 (listp (car org-provide-todo-statistics))
12938 (member kwd org-done-keywords)
12939 (member kwd (cadr org-provide-todo-statistics)))
12940 (and (listp org-provide-todo-statistics)
12941 (stringp (car org-provide-todo-statistics))
12942 (member kwd org-done-keywords)))
12943 (setq cnt-done (1+ cnt-done)))
12944 (outline-next-heading)))
12945 (setq new
12946 (if is-percent
12947 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12948 (format "[%d/%d]" cnt-done cnt-all))
12949 ndel (- (match-end 0) checkbox-beg))
12950 ;; handle overlays when updating cookie from column view
12951 (when (setq ov (car (overlays-at checkbox-beg)))
12952 (setq ovs (overlay-start ov) ove (overlay-end ov))
12953 (delete-overlay ov))
12954 (goto-char checkbox-beg)
12955 (insert new)
12956 (delete-region (point) (+ (point) ndel))
12957 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12958 (when ov (move-overlay ov ovs ove)))
12959 (when cookie-present
12960 (run-hook-with-args 'org-after-todo-statistics-hook
12961 cnt-done (- cnt-all cnt-done))))))
12962 (run-hooks 'org-todo-statistics-hook)))
12964 (defvar org-after-todo-statistics-hook nil
12965 "Hook that is called after a TODO statistics cookie has been updated.
12966 Each function is called with two arguments: the number of not-done entries
12967 and the number of done entries.
12969 For example, the following function, when added to this hook, will switch
12970 an entry to DONE when all children are done, and back to TODO when new
12971 entries are set to a TODO status. Note that this hook is only called
12972 when there is a statistics cookie in the headline!
12974 (defun org-summary-todo (n-done n-not-done)
12975 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12976 (let (org-log-done org-log-states) ; turn off logging
12977 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12980 (defvar org-todo-statistics-hook nil
12981 "Hook that is run whenever Org thinks TODO statistics should be updated.
12982 This hook runs even if there is no statistics cookie present, in which case
12983 `org-after-todo-statistics-hook' would not run.")
12985 (defun org-todo-trigger-tag-changes (state)
12986 "Apply the changes defined in `org-todo-state-tags-triggers'."
12987 (let ((l org-todo-state-tags-triggers)
12988 changes)
12989 (when (or (not state) (equal state ""))
12990 (setq changes (append changes (cdr (assoc "" l)))))
12991 (when (and (stringp state) (> (length state) 0))
12992 (setq changes (append changes (cdr (assoc state l)))))
12993 (when (member state org-not-done-keywords)
12994 (setq changes (append changes (cdr (assoc 'todo l)))))
12995 (when (member state org-done-keywords)
12996 (setq changes (append changes (cdr (assoc 'done l)))))
12997 (dolist (c changes)
12998 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13000 (defun org-local-logging (value)
13001 "Get logging settings from a property VALUE."
13002 (let* (words w a)
13003 ;; directly set the variables, they are already local.
13004 (setq org-log-done nil
13005 org-log-repeat nil
13006 org-todo-log-states nil)
13007 (setq words (org-split-string value))
13008 (while (setq w (pop words))
13009 (cond
13010 ((setq a (assoc w org-startup-options))
13011 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13012 (set (nth 1 a) (nth 2 a))))
13013 ((setq a (org-extract-log-state-settings w))
13014 (and (member (car a) org-todo-keywords-1)
13015 (push a org-todo-log-states)))))))
13017 (defun org-get-todo-sequence-head (kwd)
13018 "Return the head of the TODO sequence to which KWD belongs.
13019 If KWD is not set, check if there is a text property remembering the
13020 right sequence."
13021 (let (p)
13022 (cond
13023 ((not kwd)
13024 (or (get-text-property (point-at-bol) 'org-todo-head)
13025 (progn
13026 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13027 nil (point-at-eol)))
13028 (get-text-property p 'org-todo-head))))
13029 ((not (member kwd org-todo-keywords-1))
13030 (car org-todo-keywords-1))
13031 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13033 (defun org-fast-todo-selection ()
13034 "Fast TODO keyword selection with single keys.
13035 Returns the new TODO keyword, or nil if no state change should occur."
13036 (let* ((fulltable org-todo-key-alist)
13037 (done-keywords org-done-keywords) ;; needed for the faces.
13038 (maxlen (apply 'max (mapcar
13039 (lambda (x)
13040 (if (stringp (car x)) (string-width (car x)) 0))
13041 fulltable)))
13042 (expert nil)
13043 (fwidth (+ maxlen 3 1 3))
13044 (ncol (/ (- (window-width) 4) fwidth))
13045 tg cnt e c tbl
13046 groups ingroup)
13047 (save-excursion
13048 (save-window-excursion
13049 (if expert
13050 (set-buffer (get-buffer-create " *Org todo*"))
13051 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13052 (erase-buffer)
13053 (org-set-local 'org-done-keywords done-keywords)
13054 (setq tbl fulltable cnt 0)
13055 (while (setq e (pop tbl))
13056 (cond
13057 ((equal e '(:startgroup))
13058 (push '() groups) (setq ingroup t)
13059 (when (not (= cnt 0))
13060 (setq cnt 0)
13061 (insert "\n"))
13062 (insert "{ "))
13063 ((equal e '(:endgroup))
13064 (setq ingroup nil cnt 0)
13065 (insert "}\n"))
13066 ((equal e '(:newline))
13067 (when (not (= cnt 0))
13068 (setq cnt 0)
13069 (insert "\n")
13070 (setq e (car tbl))
13071 (while (equal (car tbl) '(:newline))
13072 (insert "\n")
13073 (setq tbl (cdr tbl)))))
13075 (setq tg (car e) c (cdr e))
13076 (if ingroup (push tg (car groups)))
13077 (setq tg (org-add-props tg nil 'face
13078 (org-get-todo-face tg)))
13079 (if (and (= cnt 0) (not ingroup)) (insert " "))
13080 (insert "[" c "] " tg (make-string
13081 (- fwidth 4 (length tg)) ?\ ))
13082 (when (= (setq cnt (1+ cnt)) ncol)
13083 (insert "\n")
13084 (if ingroup (insert " "))
13085 (setq cnt 0)))))
13086 (insert "\n")
13087 (goto-char (point-min))
13088 (if (not expert) (org-fit-window-to-buffer))
13089 (message "[a-z..]:Set [SPC]:clear")
13090 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13091 (cond
13092 ((or (= c ?\C-g)
13093 (and (= c ?q) (not (rassoc c fulltable))))
13094 (setq quit-flag t))
13095 ((= c ?\ ) nil)
13096 ((setq e (rassoc c fulltable) tg (car e))
13098 (t (setq quit-flag t)))))))
13100 (defun org-entry-is-todo-p ()
13101 (member (org-get-todo-state) org-not-done-keywords))
13103 (defun org-entry-is-done-p ()
13104 (member (org-get-todo-state) org-done-keywords))
13106 (defun org-get-todo-state ()
13107 "Return the TODO keyword of the current subtree."
13108 (save-excursion
13109 (org-back-to-heading t)
13110 (and (looking-at org-todo-line-regexp)
13111 (match-end 2)
13112 (match-string 2))))
13114 (defun org-at-date-range-p (&optional inactive-ok)
13115 "Is the cursor inside a date range?"
13116 (interactive)
13117 (save-excursion
13118 (catch 'exit
13119 (let ((pos (point)))
13120 (skip-chars-backward "^[<\r\n")
13121 (skip-chars-backward "<[")
13122 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13123 (>= (match-end 0) pos)
13124 (throw 'exit t))
13125 (skip-chars-backward "^<[\r\n")
13126 (skip-chars-backward "<[")
13127 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13128 (>= (match-end 0) pos)
13129 (throw 'exit t)))
13130 nil)))
13132 (defun org-get-repeat (&optional tagline)
13133 "Check if there is a deadline/schedule with repeater in this entry."
13134 (save-match-data
13135 (save-excursion
13136 (org-back-to-heading t)
13137 (and (re-search-forward (if tagline
13138 (concat tagline "\\s-*" org-repeat-re)
13139 org-repeat-re)
13140 (org-entry-end-position) t)
13141 (match-string-no-properties 1)))))
13143 (defvar org-last-changed-timestamp)
13144 (defvar org-last-inserted-timestamp)
13145 (defvar org-log-post-message)
13146 (defvar org-log-note-purpose)
13147 (defvar org-log-note-how nil)
13148 (defvar org-log-note-extra)
13149 (defun org-auto-repeat-maybe (done-word)
13150 "Check if the current headline contains a repeated deadline/schedule.
13151 If yes, set TODO state back to what it was and change the base date
13152 of repeating deadline/scheduled time stamps to new date.
13153 This function is run automatically after each state change to a DONE state."
13154 ;; last-state is dynamically scoped into this function
13155 (let* ((repeat (org-get-repeat))
13156 (aa (assoc org-last-state org-todo-kwd-alist))
13157 (interpret (nth 1 aa))
13158 (head (nth 2 aa))
13159 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13160 (msg "Entry repeats: ")
13161 (org-log-done nil)
13162 (org-todo-log-states nil)
13163 re type n what ts time to-state)
13164 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13165 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13166 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13167 org-todo-repeat-to-state))
13168 (unless (and to-state (member to-state org-todo-keywords-1))
13169 (setq to-state (if (eq interpret 'type) org-last-state head)))
13170 (org-todo to-state)
13171 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13172 (org-entry-put nil "LAST_REPEAT" (format-time-string
13173 (org-time-stamp-format t t))))
13174 (when org-log-repeat
13175 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13176 (memq 'org-add-log-note post-command-hook))
13177 ;; OK, we are already setup for some record
13178 (if (eq org-log-repeat 'note)
13179 ;; make sure we take a note, not only a time stamp
13180 (setq org-log-note-how 'note))
13181 ;; Set up for taking a record
13182 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13183 org-last-state
13184 'findpos org-log-repeat)))
13185 (org-back-to-heading t)
13186 (org-add-planning-info nil nil 'closed)
13187 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13188 org-deadline-time-regexp "\\)\\|\\("
13189 org-ts-regexp "\\)"))
13190 (while (re-search-forward
13191 re (save-excursion (outline-next-heading) (point)) t)
13192 (setq type (if (match-end 1) org-scheduled-string
13193 (if (match-end 3) org-deadline-string "Plain:"))
13194 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13195 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13196 (setq n (string-to-number (match-string 2 ts))
13197 what (match-string 3 ts))
13198 (if (equal what "w") (setq n (* n 7) what "d"))
13199 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13200 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13201 ;; Preparation, see if we need to modify the start date for the change
13202 (when (match-end 1)
13203 (setq time (save-match-data (org-time-string-to-time ts)))
13204 (cond
13205 ((equal (match-string 1 ts) ".")
13206 ;; Shift starting date to today
13207 (org-timestamp-change
13208 (- (org-today) (time-to-days time))
13209 'day))
13210 ((equal (match-string 1 ts) "+")
13211 (let ((nshiftmax 10) (nshift 0))
13212 (while (or (= nshift 0)
13213 (<= (time-to-days time)
13214 (time-to-days (current-time))))
13215 (when (= (incf nshift) nshiftmax)
13216 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13217 (user-error "Abort")))
13218 (org-timestamp-change n (cdr (assoc what whata)))
13219 (org-at-timestamp-p t)
13220 (setq ts (match-string 1))
13221 (setq time (save-match-data (org-time-string-to-time ts)))))
13222 (org-timestamp-change (- n) (cdr (assoc what whata)))
13223 ;; rematch, so that we have everything in place for the real shift
13224 (org-at-timestamp-p t)
13225 (setq ts (match-string 1))
13226 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13227 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13228 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13229 (setq org-log-post-message msg)
13230 (message "%s" msg))))
13232 (defun org-show-todo-tree (arg)
13233 "Make a compact tree which shows all headlines marked with TODO.
13234 The tree will show the lines where the regexp matches, and all higher
13235 headlines above the match.
13236 With a \\[universal-argument] prefix, prompt for a regexp to match.
13237 With a numeric prefix N, construct a sparse tree for the Nth element
13238 of `org-todo-keywords-1'."
13239 (interactive "P")
13240 (let ((case-fold-search nil)
13241 (kwd-re
13242 (cond ((null arg) org-not-done-regexp)
13243 ((equal arg '(4))
13244 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13245 (mapcar 'list org-todo-keywords-1))))
13246 (concat "\\("
13247 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13248 "\\)\\>")))
13249 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13250 (regexp-quote (nth (1- (prefix-numeric-value arg))
13251 org-todo-keywords-1)))
13252 (t (user-error "Invalid prefix argument: %s" arg)))))
13253 (message "%d TODO entries found"
13254 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13256 (defun org-deadline (arg &optional time)
13257 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13258 With one universal prefix argument, remove any deadline from the item.
13259 With two universal prefix arguments, prompt for a warning delay.
13260 With argument TIME, set the deadline at the corresponding date. TIME
13261 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13262 (interactive "P")
13263 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13264 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13265 'region-start-level 'region))
13266 org-loop-over-headlines-in-active-region)
13267 (org-map-entries
13268 `(org-deadline ',arg ,time)
13269 org-loop-over-headlines-in-active-region
13270 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13271 (let* ((old-date (org-entry-get nil "DEADLINE"))
13272 (old-date-time (if old-date (org-time-string-to-time old-date)))
13273 (repeater (and old-date
13274 (string-match
13275 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13276 old-date)
13277 (match-string 1 old-date))))
13278 (cond
13279 ((equal arg '(4))
13280 (when (and old-date org-log-redeadline)
13281 (org-add-log-setup 'deldeadline nil old-date 'findpos
13282 org-log-redeadline))
13283 (org-remove-timestamp-with-keyword org-deadline-string)
13284 (message "Item no longer has a deadline."))
13285 ((equal arg '(16))
13286 (save-excursion
13287 (org-back-to-heading t)
13288 (if (re-search-forward
13289 org-deadline-time-regexp
13290 (save-excursion (outline-next-heading) (point)) t)
13291 (let* ((rpl0 (match-string 1))
13292 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13293 (replace-match
13294 (concat org-deadline-string
13295 " <" rpl
13296 (format " -%dd"
13297 (abs
13298 (- (time-to-days
13299 (save-match-data
13300 (org-read-date nil t nil "Warn starting from" old-date-time)))
13301 (time-to-days old-date-time))))
13302 ">") t t))
13303 (user-error "No deadline information to update"))))
13305 (org-add-planning-info 'deadline time 'closed)
13306 (when (and old-date org-log-redeadline
13307 (not (equal old-date
13308 (substring org-last-inserted-timestamp 1 -1))))
13309 (org-add-log-setup 'redeadline nil old-date 'findpos
13310 org-log-redeadline))
13311 (when repeater
13312 (save-excursion
13313 (org-back-to-heading t)
13314 (when (re-search-forward (concat org-deadline-string " "
13315 org-last-inserted-timestamp)
13316 (save-excursion
13317 (outline-next-heading) (point)) t)
13318 (goto-char (1- (match-end 0)))
13319 (insert " " repeater)
13320 (setq org-last-inserted-timestamp
13321 (concat (substring org-last-inserted-timestamp 0 -1)
13322 " " repeater
13323 (substring org-last-inserted-timestamp -1))))))
13324 (message "Deadline on %s" org-last-inserted-timestamp))))))
13326 (defun org-schedule (arg &optional time)
13327 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13328 With one universal prefix argument, remove any scheduling date from the item.
13329 With two universal prefix arguments, prompt for a delay cookie.
13330 With argument TIME, scheduled at the corresponding date. TIME can
13331 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13332 (interactive "P")
13333 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13334 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13335 'region-start-level 'region))
13336 org-loop-over-headlines-in-active-region)
13337 (org-map-entries
13338 `(org-schedule ',arg ,time)
13339 org-loop-over-headlines-in-active-region
13340 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13341 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13342 (old-date-time (if old-date (org-time-string-to-time old-date)))
13343 (repeater (and old-date
13344 (string-match
13345 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13346 old-date)
13347 (match-string 1 old-date))))
13348 (cond
13349 ((equal arg '(4))
13350 (progn
13351 (when (and old-date org-log-reschedule)
13352 (org-add-log-setup 'delschedule nil old-date 'findpos
13353 org-log-reschedule))
13354 (org-remove-timestamp-with-keyword org-scheduled-string)
13355 (message "Item is no longer scheduled.")))
13356 ((equal arg '(16))
13357 (save-excursion
13358 (org-back-to-heading t)
13359 (if (re-search-forward
13360 org-scheduled-time-regexp
13361 (save-excursion (outline-next-heading) (point)) t)
13362 (let* ((rpl0 (match-string 1))
13363 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13364 (replace-match
13365 (concat org-scheduled-string
13366 " <" rpl
13367 (format " -%dd"
13368 (abs
13369 (- (time-to-days
13370 (save-match-data
13371 (org-read-date nil t nil "Delay until" old-date-time)))
13372 (time-to-days old-date-time))))
13373 ">") t t))
13374 (user-error "No scheduled information to update"))))
13376 (org-add-planning-info 'scheduled time 'closed)
13377 (when (and old-date org-log-reschedule
13378 (not (equal old-date
13379 (substring org-last-inserted-timestamp 1 -1))))
13380 (org-add-log-setup 'reschedule nil old-date 'findpos
13381 org-log-reschedule))
13382 (when repeater
13383 (save-excursion
13384 (org-back-to-heading t)
13385 (when (re-search-forward (concat org-scheduled-string " "
13386 org-last-inserted-timestamp)
13387 (save-excursion
13388 (outline-next-heading) (point)) t)
13389 (goto-char (1- (match-end 0)))
13390 (insert " " repeater)
13391 (setq org-last-inserted-timestamp
13392 (concat (substring org-last-inserted-timestamp 0 -1)
13393 " " repeater
13394 (substring org-last-inserted-timestamp -1))))))
13395 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13397 (defun org-get-scheduled-time (pom &optional inherit)
13398 "Get the scheduled time as a time tuple, of a format suitable
13399 for calling org-schedule with, or if there is no scheduling,
13400 returns nil."
13401 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13402 (when time
13403 (apply 'encode-time (org-parse-time-string time)))))
13405 (defun org-get-deadline-time (pom &optional inherit)
13406 "Get the deadline as a time tuple, of a format suitable for
13407 calling org-deadline with, or if there is no scheduling, returns
13408 nil."
13409 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13410 (when time
13411 (apply 'encode-time (org-parse-time-string time)))))
13413 (defun org-remove-timestamp-with-keyword (keyword)
13414 "Remove all time stamps with KEYWORD in the current entry."
13415 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13416 beg)
13417 (save-excursion
13418 (org-back-to-heading t)
13419 (setq beg (point))
13420 (outline-next-heading)
13421 (while (re-search-backward re beg t)
13422 (replace-match "")
13423 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13424 (equal (char-before) ?\ ))
13425 (backward-delete-char 1)
13426 (if (string-match "^[ \t]*$" (buffer-substring
13427 (point-at-bol) (point-at-eol)))
13428 (delete-region (point-at-bol)
13429 (min (point-max) (1+ (point-at-eol))))))))))
13431 (defvar org-time-was-given) ; dynamically scoped parameter
13432 (defvar org-end-time-was-given) ; dynamically scoped parameter
13434 (defun org-at-planning-p ()
13435 "Non-nil when point is on a planning info line."
13436 ;; This is as accurate and faster than `org-element-at-point' since
13437 ;; planning info location is fixed in the section.
13438 (org-with-wide-buffer
13439 (beginning-of-line)
13440 (and (org-looking-at-p org-planning-line-re)
13441 (eq (point)
13442 (ignore-errors
13443 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13444 (org-back-to-heading t)
13445 (org-with-limited-levels (org-back-to-heading t)))
13446 (line-beginning-position 2))))))
13448 (defun org-add-planning-info (what &optional time &rest remove)
13449 "Insert new timestamp with keyword in the planning line.
13450 WHAT indicates what kind of time stamp to add. It is a symbol
13451 among `closed', `deadline', `scheduled' and nil. TIME indicates
13452 the time to use. If none is given, the user is prompted for
13453 a date. REMOVE indicates what kind of entries to remove. An old
13454 WHAT entry will also be removed."
13455 (let (org-time-was-given org-end-time-was-given default-time default-input)
13456 (catch 'exit
13457 (when (and (memq what '(scheduled deadline))
13458 (or (not time)
13459 (and (stringp time)
13460 (string-match "^[-+]+[0-9]" time))))
13461 ;; Try to get a default date/time from existing timestamp
13462 (save-excursion
13463 (org-back-to-heading t)
13464 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13465 (when (re-search-forward (if (eq what 'scheduled)
13466 org-scheduled-time-regexp
13467 org-deadline-time-regexp)
13468 end t)
13469 (setq ts (match-string 1)
13470 default-time (apply 'encode-time (org-parse-time-string ts))
13471 default-input (and ts (org-get-compact-tod ts)))))))
13472 (when what
13473 (setq time
13474 (if (stringp time)
13475 ;; This is a string (relative or absolute), set
13476 ;; proper date.
13477 (apply #'encode-time
13478 (org-read-date-analyze
13479 time default-time (decode-time default-time)))
13480 ;; If necessary, get the time from the user
13481 (or time (org-read-date nil 'to-time nil nil
13482 default-time default-input)))))
13484 (org-with-wide-buffer
13485 (org-back-to-heading t)
13486 (forward-line)
13487 (unless (bolp) (insert "\n"))
13488 (cond ((org-looking-at-p org-planning-line-re)
13489 ;; Move to current indentation.
13490 (skip-chars-forward " \t")
13491 ;; Check if we have to remove something.
13492 (dolist (type (if what (cons what remove) remove))
13493 (when (save-excursion
13494 (re-search-forward
13495 (case type
13496 (closed org-closed-time-regexp)
13497 (deadline org-deadline-time-regexp)
13498 (scheduled org-scheduled-time-regexp)
13499 (otherwise (error "Invalid planning type: %s" type)))
13500 (line-end-position) t))
13501 (replace-match "")
13502 (when (looking-at "--+<[^>]+>") (replace-match ""))
13503 (when (and (not what) (eq type 'closed))
13504 (save-excursion
13505 (beginning-of-line)
13506 (if (looking-at "[ \t]*$")
13507 (delete-region (point) (1+ (point-at-eol)))))))
13508 ;; Remove leading white spaces.
13509 (when (and (not (bolp)) (looking-at "[ \t]+")) (replace-match ""))))
13510 ((not what) (throw 'exit nil)) ; Nothing to do.
13511 (t (insert-before-markers "\n")
13512 (backward-char 1)
13513 (when org-adapt-indentation
13514 (org-indent-to-column (1+ (org-outline-level))))))
13515 (when what
13516 ;; Insert planning keyword.
13517 (insert (case what
13518 (closed org-closed-string)
13519 (deadline org-deadline-string)
13520 (scheduled org-scheduled-string)
13521 (otherwise (error "Invalid planning type: %s" what)))
13522 " ")
13523 ;; Insert associated timestamp.
13524 (let ((ts (org-insert-time-stamp
13525 time
13526 (or org-time-was-given
13527 (and (eq what 'closed) org-log-done-with-time))
13528 (eq what 'closed)
13529 nil nil (list org-end-time-was-given))))
13530 (unless (eolp) (insert " "))
13531 ts))))))
13533 (defvar org-log-note-marker (make-marker))
13534 (defvar org-log-note-purpose nil)
13535 (defvar org-log-note-state nil)
13536 (defvar org-log-note-previous-state nil)
13537 (defvar org-log-note-extra nil)
13538 (defvar org-log-note-window-configuration nil)
13539 (defvar org-log-note-return-to (make-marker))
13540 (defvar org-log-note-effective-time nil
13541 "Remembered current time so that dynamically scoped
13542 `org-extend-today-until' affects tha timestamps in state change
13543 log")
13545 (defvar org-log-post-message nil
13546 "Message to be displayed after a log note has been stored.
13547 The auto-repeater uses this.")
13549 (defun org-add-note ()
13550 "Add a note to the current entry.
13551 This is done in the same way as adding a state change note."
13552 (interactive)
13553 (org-add-log-setup 'note nil nil 'findpos nil))
13555 (defun org-log-beginning (&optional create)
13556 "Return expected start of log notes in current entry.
13557 When optional argument CREATE is non-nil, the function creates
13558 a drawer to store notes, if necessary. Returned position ignores
13559 narrowing."
13560 (org-with-wide-buffer
13561 (org-end-of-meta-data)
13562 (let ((end (if (org-at-heading-p) (point)
13563 (save-excursion (outline-next-heading) (point))))
13564 (drawer (org-log-into-drawer)))
13565 (cond
13566 (drawer
13567 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13568 (case-fold-search t))
13569 (catch 'exit
13570 ;; Try to find existing drawer.
13571 (while (re-search-forward regexp end t)
13572 (let ((element (org-element-at-point)))
13573 (when (eq (org-element-type element) 'drawer)
13574 (let ((cend (org-element-property :contents-end element)))
13575 (when (and (not org-log-states-order-reversed) cend)
13576 (goto-char cend)))
13577 (throw 'exit nil))))
13578 ;; No drawer found. Create one, if permitted.
13579 (when create
13580 (unless (bolp) (insert "\n"))
13581 (let ((beg (point)))
13582 (insert ":" drawer ":\n:END:\n")
13583 (org-indent-region beg (point)))
13584 (end-of-line -1)))))
13585 (org-log-state-notes-insert-after-drawers
13586 (while (and (looking-at org-drawer-regexp)
13587 (progn (goto-char (match-end 0))
13588 (re-search-forward org-property-end-re end t)))
13589 (forward-line)))))
13590 (if (bolp) (point) (line-beginning-position 2))))
13592 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13593 "Set up the post command hook to take a note.
13594 If this is about to TODO state change, the new state is expected in STATE.
13595 When FINDPOS is non-nil, find the correct position for the note in
13596 the current entry. If not, assume that it can be inserted at point.
13597 HOW is an indicator what kind of note should be created.
13598 EXTRA is additional text that will be inserted into the notes buffer."
13599 (org-with-wide-buffer
13600 (when findpos
13601 (goto-char (org-log-beginning t))
13602 (unless org-log-states-order-reversed
13603 (org-skip-over-state-notes)
13604 (skip-chars-backward " \t\n\r")
13605 (forward-line)))
13606 (move-marker org-log-note-marker (point))
13607 ;; Preserve position even if a property drawer is inserted in the
13608 ;; process.
13609 (set-marker-insertion-type org-log-note-marker t)
13610 (setq org-log-note-purpose purpose
13611 org-log-note-state state
13612 org-log-note-previous-state prev-state
13613 org-log-note-how how
13614 org-log-note-extra extra
13615 org-log-note-effective-time (org-current-effective-time))
13616 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13618 (defun org-skip-over-state-notes ()
13619 "Skip past the list of State notes in an entry."
13620 (when (ignore-errors (goto-char (org-in-item-p)))
13621 (let* ((struct (org-list-struct))
13622 (prevs (org-list-prevs-alist struct))
13623 (regexp
13624 (concat "[ \t]*- +"
13625 (replace-regexp-in-string
13626 " +" " +"
13627 (org-replace-escapes
13628 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13629 `(("%d" . ,org-ts-regexp-inactive)
13630 ("%D" . ,org-ts-regexp)
13631 ("%s" . "\"\\S-+\"")
13632 ("%S" . "\"\\S-+\"")
13633 ("%t" . ,org-ts-regexp-inactive)
13634 ("%T" . ,org-ts-regexp)
13635 ("%u" . ".*?")
13636 ("%U" . ".*?")))))))
13637 (while (org-looking-at-p regexp)
13638 (goto-char (or (org-list-get-next-item (point) struct prevs)
13639 (org-list-get-item-end (point) struct)))))))
13641 (defun org-add-log-note (&optional purpose)
13642 "Pop up a window for taking a note, and add this note later at point."
13643 (remove-hook 'post-command-hook 'org-add-log-note)
13644 (setq org-log-note-window-configuration (current-window-configuration))
13645 (delete-other-windows)
13646 (move-marker org-log-note-return-to (point))
13647 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13648 (goto-char org-log-note-marker)
13649 (org-switch-to-buffer-other-window "*Org Note*")
13650 (erase-buffer)
13651 (if (memq org-log-note-how '(time state))
13652 (let (current-prefix-arg) (org-store-log-note))
13653 (let ((org-inhibit-startup t)) (org-mode))
13654 (insert (format "# Insert note for %s.
13655 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13656 (cond
13657 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13658 ((eq org-log-note-purpose 'done) "closed todo item")
13659 ((eq org-log-note-purpose 'state)
13660 (format "state change from \"%s\" to \"%s\""
13661 (or org-log-note-previous-state "")
13662 (or org-log-note-state "")))
13663 ((eq org-log-note-purpose 'reschedule)
13664 "rescheduling")
13665 ((eq org-log-note-purpose 'delschedule)
13666 "no longer scheduled")
13667 ((eq org-log-note-purpose 'redeadline)
13668 "changing deadline")
13669 ((eq org-log-note-purpose 'deldeadline)
13670 "removing deadline")
13671 ((eq org-log-note-purpose 'refile)
13672 "refiling")
13673 ((eq org-log-note-purpose 'note)
13674 "this entry")
13675 (t (error "This should not happen")))))
13676 (if org-log-note-extra (insert org-log-note-extra))
13677 (org-set-local 'org-finish-function 'org-store-log-note)
13678 (run-hooks 'org-log-buffer-setup-hook)))
13680 (defvar org-note-abort nil) ; dynamically scoped
13681 (defun org-store-log-note ()
13682 "Finish taking a log note, and insert it to where it belongs."
13683 (let ((txt (buffer-string)))
13684 (kill-buffer (current-buffer))
13685 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13686 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13687 (setq txt (replace-match "" t t txt)))
13688 (if (string-match "\\s-+\\'" txt)
13689 (setq txt (replace-match "" t t txt)))
13690 (setq lines (org-split-string txt "\n"))
13691 (when (and note (string-match "\\S-" note))
13692 (setq note
13693 (org-replace-escapes
13694 note
13695 (list (cons "%u" (user-login-name))
13696 (cons "%U" user-full-name)
13697 (cons "%t" (format-time-string
13698 (org-time-stamp-format 'long 'inactive)
13699 org-log-note-effective-time))
13700 (cons "%T" (format-time-string
13701 (org-time-stamp-format 'long nil)
13702 org-log-note-effective-time))
13703 (cons "%d" (format-time-string
13704 (org-time-stamp-format nil 'inactive)
13705 org-log-note-effective-time))
13706 (cons "%D" (format-time-string
13707 (org-time-stamp-format nil nil)
13708 org-log-note-effective-time))
13709 (cons "%s" (if org-log-note-state
13710 (concat "\"" org-log-note-state "\"")
13711 ""))
13712 (cons "%S" (if org-log-note-previous-state
13713 (concat "\"" org-log-note-previous-state "\"")
13714 "\"\"")))))
13715 (when lines (setq note (concat note " \\\\")))
13716 (push note lines))
13717 (when (or current-prefix-arg org-note-abort)
13718 (when (org-log-into-drawer)
13719 (org-remove-empty-drawer-at org-log-note-marker))
13720 (setq lines nil))
13721 (when lines
13722 (with-current-buffer (marker-buffer org-log-note-marker)
13723 (save-excursion
13724 (goto-char org-log-note-marker)
13725 (move-marker org-log-note-marker nil)
13726 ;; Make sure point is at the beginning of an empty line.
13727 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13728 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13729 ;; In an existing list, add a new item at the top level.
13730 ;; Otherwise, indent line like a regular one.
13731 (let ((itemp (org-in-item-p)))
13732 (if itemp
13733 (org-indent-line-to
13734 (let ((struct (save-excursion
13735 (goto-char itemp) (org-list-struct))))
13736 (org-list-get-ind (org-list-get-top-point struct) struct)))
13737 (org-indent-line)))
13738 (insert (org-list-bullet-string "-") (pop lines))
13739 (let ((ind (org-list-item-body-column (line-beginning-position))))
13740 (dolist (line lines)
13741 (insert "\n")
13742 (org-indent-line-to ind)
13743 (insert line)))
13744 (message "Note stored")
13745 (org-back-to-heading t)
13746 (org-cycle-hide-drawers 'children))
13747 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13748 ;; from within `org-add-log-note' because `buffer-undo-list'
13749 ;; is then modified outside of `org-with-remote-undo'.
13750 (when (eq this-command 'org-agenda-todo)
13751 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13752 ;; Don't add undo information when called from `org-agenda-todo'
13753 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13754 (set-window-configuration org-log-note-window-configuration)
13755 (with-current-buffer (marker-buffer org-log-note-return-to)
13756 (goto-char org-log-note-return-to))
13757 (move-marker org-log-note-return-to nil)
13758 (and org-log-post-message (message "%s" org-log-post-message))))
13760 (defun org-remove-empty-drawer-at (pos)
13761 "Remove an empty drawer at position POS.
13762 POS may also be a marker."
13763 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13764 (org-with-wide-buffer
13765 (goto-char pos)
13766 (let ((drawer (org-element-at-point)))
13767 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13768 (not (org-element-property :contents-begin drawer)))
13769 (delete-region (org-element-property :begin drawer)
13770 (progn (goto-char (org-element-property :end drawer))
13771 (skip-chars-backward " \r\t\n")
13772 (forward-line)
13773 (point))))))))
13775 (defvar org-ts-type nil)
13776 (defun org-sparse-tree (&optional arg type)
13777 "Create a sparse tree, prompt for the details.
13778 This command can create sparse trees. You first need to select the type
13779 of match used to create the tree:
13781 t Show all TODO entries.
13782 T Show entries with a specific TODO keyword.
13783 m Show entries selected by a tags/property match.
13784 p Enter a property name and its value (both with completion on existing
13785 names/values) and show entries with that property.
13786 r Show entries matching a regular expression (`/' can be used as well).
13787 b Show deadlines and scheduled items before a date.
13788 a Show deadlines and scheduled items after a date.
13789 d Show deadlines due within `org-deadline-warning-days'.
13790 D Show deadlines and scheduled items between a date range."
13791 (interactive "P")
13792 (setq type (or type org-sparse-tree-default-date-type))
13793 (setq org-ts-type type)
13794 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13795 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13796 [c]ycle through date types: %s"
13797 (case type
13798 (all "all timestamps")
13799 (scheduled "only scheduled")
13800 (deadline "only deadline")
13801 (active "only active timestamps")
13802 (inactive "only inactive timestamps")
13803 (closed "with a closed time-stamp")
13804 (otherwise "scheduled/deadline")))
13805 (let ((answer (read-char-exclusive)))
13806 (case answer
13808 (org-sparse-tree
13810 (cadr
13811 (memq type '(nil all scheduled deadline active inactive closed)))))
13812 (?d (call-interactively 'org-check-deadlines))
13813 (?b (call-interactively 'org-check-before-date))
13814 (?a (call-interactively 'org-check-after-date))
13815 (?D (call-interactively 'org-check-dates-range))
13816 (?t (call-interactively 'org-show-todo-tree))
13817 (?T (org-show-todo-tree '(4)))
13818 (?m (call-interactively 'org-match-sparse-tree))
13819 ((?p ?P)
13820 (let* ((kwd (org-icompleting-read
13821 "Property: " (mapcar 'list (org-buffer-property-keys))))
13822 (value (org-icompleting-read
13823 "Value: " (mapcar 'list (org-property-values kwd)))))
13824 (unless (string-match "\\`{.*}\\'" value)
13825 (setq value (concat "\"" value "\"")))
13826 (org-match-sparse-tree arg (concat kwd "=" value))))
13827 ((?r ?R ?/) (call-interactively 'org-occur))
13828 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13830 (defvar org-occur-highlights nil
13831 "List of overlays used for occur matches.")
13832 (make-variable-buffer-local 'org-occur-highlights)
13833 (defvar org-occur-parameters nil
13834 "Parameters of the active org-occur calls.
13835 This is a list, each call to org-occur pushes as cons cell,
13836 containing the regular expression and the callback, onto the list.
13837 The list can contain several entries if `org-occur' has been called
13838 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13839 will only contain one set of parameters. When the highlights are
13840 removed (for example with `C-c C-c', or with the next edit (depending
13841 on `org-remove-highlights-with-change'), this variable is emptied
13842 as well.")
13843 (make-variable-buffer-local 'org-occur-parameters)
13845 (defun org-occur (regexp &optional keep-previous callback)
13846 "Make a compact tree which shows all matches of REGEXP.
13847 The tree will show the lines where the regexp matches, and all higher
13848 headlines above the match. It will also show the heading after the match,
13849 to make sure editing the matching entry is easy.
13850 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13851 call to `org-occur' will be kept, to allow stacking of calls to this
13852 command.
13853 If CALLBACK is non-nil, it is a function which is called to confirm
13854 that the match should indeed be shown."
13855 (interactive "sRegexp: \nP")
13856 (when (equal regexp "")
13857 (user-error "Regexp cannot be empty"))
13858 (unless keep-previous
13859 (org-remove-occur-highlights nil nil t))
13860 (push (cons regexp callback) org-occur-parameters)
13861 (let ((cnt 0))
13862 (save-excursion
13863 (goto-char (point-min))
13864 (if (or (not keep-previous) ; do not want to keep
13865 (not org-occur-highlights)) ; no previous matches
13866 ;; hide everything
13867 (org-overview))
13868 (while (re-search-forward regexp nil t)
13869 (when (or (not callback)
13870 (save-match-data (funcall callback)))
13871 (setq cnt (1+ cnt))
13872 (when org-highlight-sparse-tree-matches
13873 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13874 (org-show-context 'occur-tree))))
13875 (when org-remove-highlights-with-change
13876 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13877 nil 'local))
13878 (unless org-sparse-tree-open-archived-trees
13879 (org-hide-archived-subtrees (point-min) (point-max)))
13880 (run-hooks 'org-occur-hook)
13881 (if (org-called-interactively-p 'interactive)
13882 (message "%d match(es) for regexp %s" cnt regexp))
13883 cnt))
13885 (defun org-occur-next-match (&optional n reset)
13886 "Function for `next-error-function' to find sparse tree matches.
13887 N is the number of matches to move, when negative move backwards.
13888 RESET is entirely ignored - this function always goes back to the
13889 starting point when no match is found."
13890 (let* ((limit (if (< n 0) (point-min) (point-max)))
13891 (search-func (if (< n 0)
13892 'previous-single-char-property-change
13893 'next-single-char-property-change))
13894 (n (abs n))
13895 (pos (point))
13897 (catch 'exit
13898 (while (setq p1 (funcall search-func (point) 'org-type))
13899 (when (equal p1 limit)
13900 (goto-char pos)
13901 (user-error "No more matches"))
13902 (when (equal (get-char-property p1 'org-type) 'org-occur)
13903 (setq n (1- n))
13904 (when (= n 0)
13905 (goto-char p1)
13906 (throw 'exit (point))))
13907 (goto-char p1))
13908 (goto-char p1)
13909 (user-error "No more matches"))))
13911 (defun org-show-context (&optional key)
13912 "Make sure point and context are visible.
13913 Optional argument KEY, when non-nil, is a symbol. See
13914 `org-show-context-detail' for allowed values and how much is to
13915 be shown."
13916 (org-show-set-visibility
13917 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13918 ((cdr (assq key org-show-context-detail)))
13919 (t (cdr (assq 'default org-show-context-detail))))))
13921 (defun org-show-set-visibility (detail)
13922 "Set visibility around point according to DETAIL.
13923 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13924 `tree', `canonical' or t. See `org-show-context-detail' for more
13925 information."
13926 (unless (org-before-first-heading-p)
13927 ;; Show current heading and possibly its entry, following headline
13928 ;; or all children.
13929 (if (and (org-at-heading-p) (not (eq detail 'local)))
13930 (org-flag-heading nil)
13931 (org-show-entry)
13932 (org-with-limited-levels
13933 (case detail
13934 ((tree canonical t) (show-children))
13935 ((nil minimal ancestors))
13936 (t (save-excursion
13937 (outline-next-heading)
13938 (org-flag-heading nil))))))
13939 ;; Show all siblings.
13940 (when (eq detail 'lineage) (org-show-siblings))
13941 ;; Show ancestors, possibly with their children.
13942 (when (memq detail '(ancestors lineage tree canonical t))
13943 (save-excursion
13944 (while (org-up-heading-safe)
13945 (org-flag-heading nil)
13946 (when (memq detail '(canonical t)) (org-show-entry))
13947 (when (memq detail '(tree canonical t)) (show-children)))))))
13949 (defvar org-reveal-start-hook nil
13950 "Hook run before revealing a location.")
13952 (defun org-reveal (&optional siblings)
13953 "Show current entry, hierarchy above it, and the following headline.
13955 This can be used to show a consistent set of context around
13956 locations exposed with `org-show-context'.
13958 With optional argument SIBLINGS, on each level of the hierarchy all
13959 siblings are shown. This repairs the tree structure to what it would
13960 look like when opened with hierarchical calls to `org-cycle'.
13962 With double optional argument \\[universal-argument] \\[universal-argument], \
13963 go to the parent and show the
13964 entire tree."
13965 (interactive "P")
13966 (run-hooks 'org-reveal-start-hook)
13967 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
13968 ((equal siblings '(16))
13969 (save-excursion
13970 (when (org-up-heading-safe)
13971 (org-show-subtree)
13972 (run-hook-with-args 'org-cycle-hook 'subtree))))
13973 (t (org-show-set-visibility 'lineage))))
13975 (defun org-highlight-new-match (beg end)
13976 "Highlight from BEG to END and mark the highlight is an occur headline."
13977 (let ((ov (make-overlay beg end)))
13978 (overlay-put ov 'face 'secondary-selection)
13979 (overlay-put ov 'org-type 'org-occur)
13980 (push ov org-occur-highlights)))
13982 (defun org-remove-occur-highlights (&optional beg end noremove)
13983 "Remove the occur highlights from the buffer.
13984 BEG and END are ignored. If NOREMOVE is nil, remove this function
13985 from the `before-change-functions' in the current buffer."
13986 (interactive)
13987 (unless org-inhibit-highlight-removal
13988 (mapc 'delete-overlay org-occur-highlights)
13989 (setq org-occur-highlights nil)
13990 (setq org-occur-parameters nil)
13991 (unless noremove
13992 (remove-hook 'before-change-functions
13993 'org-remove-occur-highlights 'local))))
13995 ;;;; Priorities
13997 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
13998 "Regular expression matching the priority indicator.")
14000 (defvar org-remove-priority-next-time nil)
14002 (defun org-priority-up ()
14003 "Increase the priority of the current item."
14004 (interactive)
14005 (org-priority 'up))
14007 (defun org-priority-down ()
14008 "Decrease the priority of the current item."
14009 (interactive)
14010 (org-priority 'down))
14012 (defun org-priority (&optional action show)
14013 "Change the priority of an item.
14014 ACTION can be `set', `up', `down', or a character."
14015 (interactive "P")
14016 (if (equal action '(4))
14017 (org-show-priority)
14018 (unless org-enable-priority-commands
14019 (user-error "Priority commands are disabled"))
14020 (setq action (or action 'set))
14021 (let (current new news have remove)
14022 (save-excursion
14023 (org-back-to-heading t)
14024 (if (looking-at org-priority-regexp)
14025 (setq current (string-to-char (match-string 2))
14026 have t))
14027 (cond
14028 ((eq action 'remove)
14029 (setq remove t new ?\ ))
14030 ((or (eq action 'set)
14031 (if (featurep 'xemacs) (characterp action) (integerp action)))
14032 (if (not (eq action 'set))
14033 (setq new action)
14034 (message "Priority %c-%c, SPC to remove: "
14035 org-highest-priority org-lowest-priority)
14036 (save-match-data
14037 (setq new (read-char-exclusive))))
14038 (if (and (= (upcase org-highest-priority) org-highest-priority)
14039 (= (upcase org-lowest-priority) org-lowest-priority))
14040 (setq new (upcase new)))
14041 (cond ((equal new ?\ ) (setq remove t))
14042 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14043 (user-error "Priority must be between `%c' and `%c'"
14044 org-highest-priority org-lowest-priority))))
14045 ((eq action 'up)
14046 (setq new (if have
14047 (1- current) ; normal cycling
14048 ;; last priority was empty
14049 (if (eq last-command this-command)
14050 org-lowest-priority ; wrap around empty to lowest
14051 ;; default
14052 (if org-priority-start-cycle-with-default
14053 org-default-priority
14054 (1- org-default-priority))))))
14055 ((eq action 'down)
14056 (setq new (if have
14057 (1+ current) ; normal cycling
14058 ;; last priority was empty
14059 (if (eq last-command this-command)
14060 org-highest-priority ; wrap around empty to highest
14061 ;; default
14062 (if org-priority-start-cycle-with-default
14063 org-default-priority
14064 (1+ org-default-priority))))))
14065 (t (user-error "Invalid action")))
14066 (if (or (< (upcase new) org-highest-priority)
14067 (> (upcase new) org-lowest-priority))
14068 (if (and (memq action '(up down))
14069 (not have) (not (eq last-command this-command)))
14070 ;; `new' is from default priority
14071 (error
14072 "The default can not be set, see `org-default-priority' why")
14073 ;; normal cycling: `new' is beyond highest/lowest priority
14074 ;; and is wrapped around to the empty priority
14075 (setq remove t)))
14076 (setq news (format "%c" new))
14077 (if have
14078 (if remove
14079 (replace-match "" t t nil 1)
14080 (replace-match news t t nil 2))
14081 (if remove
14082 (user-error "No priority cookie found in line")
14083 (let ((case-fold-search nil))
14084 (looking-at org-todo-line-regexp))
14085 (if (match-end 2)
14086 (progn
14087 (goto-char (match-end 2))
14088 (insert " [#" news "]"))
14089 (goto-char (match-beginning 3))
14090 (insert "[#" news "] "))))
14091 (org-set-tags nil 'align))
14092 (if remove
14093 (message "Priority removed")
14094 (message "Priority of current item set to %s" news)))))
14096 (defun org-show-priority ()
14097 "Show the priority of the current item.
14098 This priority is composed of the main priority given with the [#A] cookies,
14099 and by additional input from the age of a schedules or deadline entry."
14100 (interactive)
14101 (let ((pri (if (eq major-mode 'org-agenda-mode)
14102 (org-get-at-bol 'priority)
14103 (save-excursion
14104 (save-match-data
14105 (beginning-of-line)
14106 (and (looking-at org-heading-regexp)
14107 (org-get-priority (match-string 0))))))))
14108 (message "Priority is %d" (if pri pri -1000))))
14110 (defun org-get-priority (s)
14111 "Find priority cookie and return priority."
14112 (save-match-data
14113 (if (functionp org-get-priority-function)
14114 (funcall org-get-priority-function)
14115 (if (not (string-match org-priority-regexp s))
14116 (* 1000 (- org-lowest-priority org-default-priority))
14117 (* 1000 (- org-lowest-priority
14118 (string-to-char (match-string 2 s))))))))
14120 ;;;; Tags
14122 (defvar org-agenda-archives-mode)
14123 (defvar org-map-continue-from nil
14124 "Position from where mapping should continue.
14125 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14127 (defvar org-scanner-tags nil
14128 "The current tag list while the tags scanner is running.")
14129 (defvar org-trust-scanner-tags nil
14130 "Should `org-get-tags-at' use the tags for the scanner.
14131 This is for internal dynamical scoping only.
14132 When this is non-nil, the function `org-get-tags-at' will return the value
14133 of `org-scanner-tags' instead of building the list by itself. This
14134 can lead to large speed-ups when the tags scanner is used in a file with
14135 many entries, and when the list of tags is retrieved, for example to
14136 obtain a list of properties. Building the tags list for each entry in such
14137 a file becomes an N^2 operation - but with this variable set, it scales
14138 as N.")
14140 (defun org-scan-tags (action matcher todo-only &optional start-level)
14141 "Scan headline tags with inheritance and produce output ACTION.
14143 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14144 or `agenda' to produce an entry list for an agenda view. It can also be
14145 a Lisp form or a function that should be called at each matched headline, in
14146 this case the return value is a list of all return values from these calls.
14148 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14149 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14150 only lines with a not-done TODO keyword are included in the output.
14151 This should be the same variable that was scoped into
14152 and set by `org-make-tags-matcher' when it constructed MATCHER.
14154 START-LEVEL can be a string with asterisks, reducing the scope to
14155 headlines matching this string."
14156 (require 'org-agenda)
14157 (let* ((re (concat "^"
14158 (if start-level
14159 ;; Get the correct level to match
14160 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14161 org-outline-regexp)
14162 " *\\(\\<\\("
14163 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14164 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14165 (props (list 'face 'default
14166 'done-face 'org-agenda-done
14167 'undone-face 'default
14168 'mouse-face 'highlight
14169 'org-not-done-regexp org-not-done-regexp
14170 'org-todo-regexp org-todo-regexp
14171 'org-complex-heading-regexp org-complex-heading-regexp
14172 'help-echo
14173 (format "mouse-2 or RET jump to org file %s"
14174 (abbreviate-file-name
14175 (or (buffer-file-name (buffer-base-buffer))
14176 (buffer-name (buffer-base-buffer)))))))
14177 (org-map-continue-from nil)
14178 lspos tags tags-list
14179 (tags-alist (list (cons 0 org-file-tags)))
14180 (llast 0) rtn rtn1 level category i txt
14181 todo marker entry priority
14182 ts-date ts-date-type ts-date-pair)
14183 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14184 (setq action (list 'lambda nil action)))
14185 (save-excursion
14186 (goto-char (point-min))
14187 (when (eq action 'sparse-tree)
14188 (org-overview)
14189 (org-remove-occur-highlights))
14190 (while (let (case-fold-search)
14191 (re-search-forward re nil t))
14192 (setq org-map-continue-from nil)
14193 (catch :skip
14194 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14195 tags (if (match-end 4) (org-match-string-no-properties 4)))
14196 (goto-char (setq lspos (match-beginning 0)))
14197 (setq level (org-reduced-level (org-outline-level))
14198 category (org-get-category))
14199 (when (eq action 'agenda)
14200 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14201 ts-date (car ts-date-pair)
14202 ts-date-type (cdr ts-date-pair)))
14203 (setq i llast llast level)
14204 ;; remove tag lists from same and sublevels
14205 (while (>= i level)
14206 (when (setq entry (assoc i tags-alist))
14207 (setq tags-alist (delete entry tags-alist)))
14208 (setq i (1- i)))
14209 ;; add the next tags
14210 (when tags
14211 (setq tags (org-split-string tags ":")
14212 tags-alist
14213 (cons (cons level tags) tags-alist)))
14214 ;; compile tags for current headline
14215 (setq tags-list
14216 (if org-use-tag-inheritance
14217 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14218 tags)
14219 org-scanner-tags tags-list)
14220 (when org-use-tag-inheritance
14221 (setcdr (car tags-alist)
14222 (mapcar (lambda (x)
14223 (setq x (copy-sequence x))
14224 (org-add-prop-inherited x))
14225 (cdar tags-alist))))
14226 (when (and tags org-use-tag-inheritance
14227 (or (not (eq t org-use-tag-inheritance))
14228 org-tags-exclude-from-inheritance))
14229 ;; selective inheritance, remove uninherited ones
14230 (setcdr (car tags-alist)
14231 (org-remove-uninherited-tags (cdar tags-alist))))
14232 (when (and
14234 ;; eval matcher only when the todo condition is OK
14235 (and (or (not todo-only) (member todo org-not-done-keywords))
14236 (let ((case-fold-search t) (org-trust-scanner-tags t))
14237 (eval matcher)))
14239 ;; Call the skipper, but return t if it does not skip,
14240 ;; so that the `and' form continues evaluating
14241 (progn
14242 (unless (eq action 'sparse-tree) (org-agenda-skip))
14245 ;; Check if timestamps are deselecting this entry
14246 (or (not todo-only)
14247 (and (member todo org-not-done-keywords)
14248 (or (not org-agenda-tags-todo-honor-ignore-options)
14249 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14251 ;; select this headline
14252 (cond
14253 ((eq action 'sparse-tree)
14254 (and org-highlight-sparse-tree-matches
14255 (org-get-heading) (match-end 0)
14256 (org-highlight-new-match
14257 (match-beginning 1) (match-end 1)))
14258 (org-show-context 'tags-tree))
14259 ((eq action 'agenda)
14260 (setq txt (org-agenda-format-item
14262 (concat
14263 (if (eq org-tags-match-list-sublevels 'indented)
14264 (make-string (1- level) ?.) "")
14265 (org-get-heading))
14266 level category
14267 tags-list)
14268 priority (org-get-priority txt))
14269 (goto-char lspos)
14270 (setq marker (org-agenda-new-marker))
14271 (org-add-props txt props
14272 'org-marker marker 'org-hd-marker marker 'org-category category
14273 'todo-state todo
14274 'ts-date ts-date
14275 'priority priority
14276 'type (concat "tagsmatch" ts-date-type))
14277 (push txt rtn))
14278 ((functionp action)
14279 (setq org-map-continue-from nil)
14280 (save-excursion
14281 (setq rtn1 (funcall action))
14282 (push rtn1 rtn)))
14283 (t (user-error "Invalid action")))
14285 ;; if we are to skip sublevels, jump to end of subtree
14286 (unless org-tags-match-list-sublevels
14287 (org-end-of-subtree t)
14288 (backward-char 1))))
14289 ;; Get the correct position from where to continue
14290 (if org-map-continue-from
14291 (goto-char org-map-continue-from)
14292 (and (= (point) lspos) (end-of-line 1)))))
14293 (when (and (eq action 'sparse-tree)
14294 (not org-sparse-tree-open-archived-trees))
14295 (org-hide-archived-subtrees (point-min) (point-max)))
14296 (nreverse rtn)))
14298 (defun org-remove-uninherited-tags (tags)
14299 "Remove all tags that are not inherited from the list TAGS."
14300 (cond
14301 ((eq org-use-tag-inheritance t)
14302 (if org-tags-exclude-from-inheritance
14303 (org-delete-all org-tags-exclude-from-inheritance tags)
14304 tags))
14305 ((not org-use-tag-inheritance) nil)
14306 ((stringp org-use-tag-inheritance)
14307 (delq nil (mapcar
14308 (lambda (x)
14309 (if (and (string-match org-use-tag-inheritance x)
14310 (not (member x org-tags-exclude-from-inheritance)))
14311 x nil))
14312 tags)))
14313 ((listp org-use-tag-inheritance)
14314 (delq nil (mapcar
14315 (lambda (x)
14316 (if (member x org-use-tag-inheritance) x nil))
14317 tags)))))
14319 (defun org-match-sparse-tree (&optional todo-only match)
14320 "Create a sparse tree according to tags string MATCH.
14321 MATCH can contain positive and negative selection of tags, like
14322 \"+WORK+URGENT-WITHBOSS\".
14323 If optional argument TODO-ONLY is non-nil, only select lines that are
14324 also TODO lines."
14325 (interactive "P")
14326 (org-agenda-prepare-buffers (list (current-buffer)))
14327 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14329 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14331 (defvar org-cached-props nil)
14332 (defun org-cached-entry-get (pom property)
14333 (if (or (eq t org-use-property-inheritance)
14334 (and (stringp org-use-property-inheritance)
14335 (let ((case-fold-search t))
14336 (org-string-match-p org-use-property-inheritance property)))
14337 (and (listp org-use-property-inheritance)
14338 (member-ignore-case property org-use-property-inheritance)))
14339 ;; Caching is not possible, check it directly.
14340 (org-entry-get pom property 'inherit)
14341 ;; Get all properties, so we can do complicated checks easily.
14342 (cdr (assoc-string property
14343 (or org-cached-props
14344 (setq org-cached-props (org-entry-properties pom)))
14345 t))))
14347 (defun org-global-tags-completion-table (&optional files)
14348 "Return the list of all tags in all agenda buffer/files.
14349 Optional FILES argument is a list of files which can be used
14350 instead of the agenda files."
14351 (save-excursion
14352 (org-uniquify
14353 (delq nil
14354 (apply 'append
14355 (mapcar
14356 (lambda (file)
14357 (set-buffer (find-file-noselect file))
14358 (append (org-get-buffer-tags)
14359 (mapcar (lambda (x) (if (stringp (car-safe x))
14360 (list (car-safe x)) nil))
14361 org-tag-alist)))
14362 (if (and files (car files))
14363 files
14364 (org-agenda-files))))))))
14366 (defun org-make-tags-matcher (match)
14367 "Create the TAGS/TODO matcher form for the selection string MATCH.
14369 The variable `todo-only' is scoped dynamically into this function.
14370 It will be set to t if the matcher restricts matching to TODO entries,
14371 otherwise will not be touched.
14373 Returns a cons of the selection string MATCH and the constructed
14374 lisp form implementing the matcher. The matcher is to be evaluated
14375 at an Org entry, with point on the headline, and returns t if the
14376 entry matches the selection string MATCH. The returned lisp form
14377 references two variables with information about the entry, which
14378 must be bound around the form's evaluation: todo, the TODO keyword
14379 at the entry (or nil of none); and tags-list, the list of all tags
14380 at the entry including inherited ones. Additionally, the category
14381 of the entry (if any) must be specified as the text property
14382 'org-category on the headline.
14384 See also `org-scan-tags'.
14386 (declare (special todo-only))
14387 (unless (boundp 'todo-only)
14388 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14389 (unless match
14390 ;; Get a new match request, with completion against the global
14391 ;; tags table and the local tags in current buffer
14392 (let ((org-last-tags-completion-table
14393 (org-uniquify
14394 (delq nil (append (org-get-buffer-tags)
14395 (org-global-tags-completion-table))))))
14396 (setq match (org-completing-read-no-i
14397 "Match: " 'org-tags-completion-function nil nil nil
14398 'org-tags-history))))
14400 ;; Parse the string and create a lisp form
14401 (let ((match0 match)
14402 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14403 minus tag mm
14404 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14405 orterms term orlist re-p str-p level-p level-op time-p
14406 prop-p pn pv po gv rest (start 0) (ss 0))
14407 ;; Expand group tags
14408 (setq match (org-tags-expand match))
14410 ;; Check if there is a TODO part of this match, which would be the
14411 ;; part after a "/". TO make sure that this slash is not part of
14412 ;; a property value to be matched against, we also check that there
14413 ;; is no " after that slash.
14414 ;; First, find the last slash
14415 (while (string-match "/+" match ss)
14416 (setq start (match-beginning 0) ss (match-end 0)))
14417 (if (and (string-match "/+" match start)
14418 (not (save-match-data (string-match "\"" match start))))
14419 ;; match contains also a todo-matching request
14420 (progn
14421 (setq tagsmatch (substring match 0 (match-beginning 0))
14422 todomatch (substring match (match-end 0)))
14423 (if (string-match "^!" todomatch)
14424 (setq todo-only t todomatch (substring todomatch 1)))
14425 (if (string-match "^\\s-*$" todomatch)
14426 (setq todomatch nil)))
14427 ;; only matching tags
14428 (setq tagsmatch match todomatch nil))
14430 ;; Make the tags matcher
14431 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14432 (setq tagsmatcher t)
14433 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14434 (while (setq term (pop orterms))
14435 (while (and (equal (substring term -1) "\\") orterms)
14436 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14437 (while (string-match re term)
14438 (setq rest (substring term (match-end 0))
14439 minus (and (match-end 1)
14440 (equal (match-string 1 term) "-"))
14441 tag (save-match-data (replace-regexp-in-string
14442 "\\\\-" "-"
14443 (match-string 2 term)))
14444 re-p (equal (string-to-char tag) ?{)
14445 level-p (match-end 4)
14446 prop-p (match-end 5)
14447 mm (cond
14448 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14449 (level-p
14450 (setq level-op (org-op-to-function (match-string 3 term)))
14451 `(,level-op level ,(string-to-number
14452 (match-string 4 term))))
14453 (prop-p
14454 (setq pn (match-string 5 term)
14455 po (match-string 6 term)
14456 pv (match-string 7 term)
14457 re-p (equal (string-to-char pv) ?{)
14458 str-p (equal (string-to-char pv) ?\")
14459 time-p (save-match-data
14460 (string-match "^\"[[<].*[]>]\"$" pv))
14461 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14462 (if time-p (setq pv (org-matcher-time pv)))
14463 (setq po (org-op-to-function po (if time-p 'time str-p)))
14464 (cond
14465 ((equal pn "CATEGORY")
14466 (setq gv '(get-text-property (point) 'org-category)))
14467 ((equal pn "TODO")
14468 (setq gv 'todo))
14470 (setq gv `(org-cached-entry-get nil ,pn))))
14471 (if re-p
14472 (if (eq po 'org<>)
14473 `(not (string-match ,pv (or ,gv "")))
14474 `(string-match ,pv (or ,gv "")))
14475 (if str-p
14476 `(,po (or ,gv "") ,pv)
14477 `(,po (string-to-number (or ,gv ""))
14478 ,(string-to-number pv) ))))
14479 (t `(member ,tag tags-list)))
14480 mm (if minus (list 'not mm) mm)
14481 term rest)
14482 (push mm tagsmatcher))
14483 (push (if (> (length tagsmatcher) 1)
14484 (cons 'and tagsmatcher)
14485 (car tagsmatcher))
14486 orlist)
14487 (setq tagsmatcher nil))
14488 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14489 (setq tagsmatcher
14490 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14491 ;; Make the todo matcher
14492 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14493 (setq todomatcher t)
14494 (setq orterms (org-split-string todomatch "|") orlist nil)
14495 (while (setq term (pop orterms))
14496 (while (string-match re term)
14497 (setq minus (and (match-end 1)
14498 (equal (match-string 1 term) "-"))
14499 kwd (match-string 2 term)
14500 re-p (equal (string-to-char kwd) ?{)
14501 term (substring term (match-end 0))
14502 mm (if re-p
14503 `(string-match ,(substring kwd 1 -1) todo)
14504 (list 'equal 'todo kwd))
14505 mm (if minus (list 'not mm) mm))
14506 (push mm todomatcher))
14507 (push (if (> (length todomatcher) 1)
14508 (cons 'and todomatcher)
14509 (car todomatcher))
14510 orlist)
14511 (setq todomatcher nil))
14512 (setq todomatcher (if (> (length orlist) 1)
14513 (cons 'or orlist) (car orlist))))
14515 ;; Return the string and lisp forms of the matcher
14516 (setq matcher (if todomatcher
14517 (list 'and tagsmatcher todomatcher)
14518 tagsmatcher))
14519 (when todo-only
14520 (setq matcher (list 'and '(member todo org-not-done-keywords)
14521 matcher)))
14522 (cons match0 matcher)))
14524 (defun org-tags-expand (match &optional single-as-list downcased)
14525 "Expand group tags in MATCH.
14527 This replaces every group tag in MATCH with a regexp tag search.
14528 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14529 will be replaced like this:
14531 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14532 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14533 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14535 Replacing by a regexp preserves the structure of the match.
14536 E.g., this expansion
14538 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14540 will match anything tagged with \"Lab\" and \"Home\", or tagged
14541 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14543 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14544 assumed to be a single group tag, and the function will return
14545 the list of tags in this group.
14547 When DOWNCASE is non-nil, expand downcased TAGS."
14548 (if org-group-tags
14549 (let* ((case-fold-search t)
14550 (stable org-mode-syntax-table)
14551 (tal (or org-tag-groups-alist-for-agenda
14552 org-tag-groups-alist))
14553 (tal (if downcased
14554 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14555 (tml (mapcar 'car tal))
14556 (rtnmatch match) rpl)
14557 ;; @ and _ are allowed as word-components in tags
14558 (modify-syntax-entry ?@ "w" stable)
14559 (modify-syntax-entry ?_ "w" stable)
14560 (while (and tml
14561 (with-syntax-table stable
14562 (string-match
14563 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14564 (regexp-opt tml) "\\>\\)") rtnmatch)))
14565 (let* ((dir (match-string 1 rtnmatch))
14566 (tag (match-string 2 rtnmatch))
14567 (tag (if downcased (downcase tag) tag)))
14568 (setq tml (delete tag tml))
14569 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14570 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14571 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14572 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14573 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14574 (if single-as-list
14575 (or (reverse rpl) (list rtnmatch))
14576 rtnmatch))
14577 (if single-as-list (list (if downcased (downcase match) match))
14578 match)))
14580 (defun org-op-to-function (op &optional stringp)
14581 "Turn an operator into the appropriate function."
14582 (setq op
14583 (cond
14584 ((equal op "<" ) '(< string< org-time<))
14585 ((equal op ">" ) '(> org-string> org-time>))
14586 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14587 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14588 ((member op '("=" "==")) '(= string= org-time=))
14589 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14590 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14592 (defun org<> (a b) (not (= a b)))
14593 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14594 (defun org-string>= (a b) (not (string< a b)))
14595 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14596 (defun org-string<> (a b) (not (string= a b)))
14597 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14598 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14599 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14600 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14601 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14602 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14603 (defun org-2ft (s)
14604 "Convert S to a floating point time.
14605 If S is already a number, just return it. If it is a string, parse
14606 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14607 (cond
14608 ((numberp s) s)
14609 ((stringp s)
14610 (condition-case nil
14611 (float-time (apply 'encode-time (org-parse-time-string s)))
14612 (error 0.)))
14613 (t 0.)))
14615 (defun org-time-today ()
14616 "Time in seconds today at 0:00.
14617 Returns the float number of seconds since the beginning of the
14618 epoch to the beginning of today (00:00)."
14619 (float-time (apply 'encode-time
14620 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14622 (defun org-matcher-time (s)
14623 "Interpret a time comparison value."
14624 (save-match-data
14625 (cond
14626 ((string= s "<now>") (float-time))
14627 ((string= s "<today>") (org-time-today))
14628 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14629 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14630 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14631 (+ (org-time-today)
14632 (* (string-to-number (match-string 1 s))
14633 (cdr (assoc (match-string 2 s)
14634 '(("d" . 86400.0) ("w" . 604800.0)
14635 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14636 (t (org-2ft s)))))
14638 (defun org-match-any-p (re list)
14639 "Does re match any element of list?"
14640 (setq list (mapcar (lambda (x) (string-match re x)) list))
14641 (delq nil list))
14643 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14644 (defvar org-tags-overlay (make-overlay 1 1))
14645 (org-detach-overlay org-tags-overlay)
14647 (defun org-get-local-tags-at (&optional pos)
14648 "Get a list of tags defined in the current headline."
14649 (org-get-tags-at pos 'local))
14651 (defun org-get-local-tags ()
14652 "Get a list of tags defined in the current headline."
14653 (org-get-tags-at nil 'local))
14655 (defun org-get-tags-at (&optional pos local)
14656 "Get a list of all headline tags applicable at POS.
14657 POS defaults to point. If tags are inherited, the list contains
14658 the targets in the same sequence as the headlines appear, i.e.
14659 the tags of the current headline come last.
14660 When LOCAL is non-nil, only return tags from the current headline,
14661 ignore inherited ones."
14662 (interactive)
14663 (if (and org-trust-scanner-tags
14664 (or (not pos) (equal pos (point)))
14665 (not local))
14666 org-scanner-tags
14667 (let (tags ltags lastpos parent)
14668 (save-excursion
14669 (save-restriction
14670 (widen)
14671 (goto-char (or pos (point)))
14672 (save-match-data
14673 (catch 'done
14674 (condition-case nil
14675 (progn
14676 (org-back-to-heading t)
14677 (while (not (equal lastpos (point)))
14678 (setq lastpos (point))
14679 (when (looking-at
14680 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14681 (setq ltags (org-split-string
14682 (org-match-string-no-properties 1) ":"))
14683 (when parent
14684 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14685 (setq tags (append
14686 (if parent
14687 (org-remove-uninherited-tags ltags)
14688 ltags)
14689 tags)))
14690 (or org-use-tag-inheritance (throw 'done t))
14691 (if local (throw 'done t))
14692 (or (org-up-heading-safe) (error nil))
14693 (setq parent t)))
14694 (error nil)))))
14695 (if local
14696 tags
14697 (reverse (delete-dups
14698 (reverse (append
14699 (org-remove-uninherited-tags
14700 org-file-tags) tags)))))))))
14702 (defun org-add-prop-inherited (s)
14703 (add-text-properties 0 (length s) '(inherited t) s)
14706 (defun org-toggle-tag (tag &optional onoff)
14707 "Toggle the tag TAG for the current line.
14708 If ONOFF is `on' or `off', don't toggle but set to this state."
14709 (let (res current)
14710 (save-excursion
14711 (org-back-to-heading t)
14712 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14713 (point-at-eol) t)
14714 (progn
14715 (setq current (match-string 1))
14716 (replace-match ""))
14717 (setq current ""))
14718 (setq current (nreverse (org-split-string current ":")))
14719 (cond
14720 ((eq onoff 'on)
14721 (setq res t)
14722 (or (member tag current) (push tag current)))
14723 ((eq onoff 'off)
14724 (or (not (member tag current)) (setq current (delete tag current))))
14725 (t (if (member tag current)
14726 (setq current (delete tag current))
14727 (setq res t)
14728 (push tag current))))
14729 (end-of-line 1)
14730 (if current
14731 (progn
14732 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14733 (org-set-tags nil t))
14734 (delete-horizontal-space))
14735 (run-hooks 'org-after-tags-change-hook))
14736 res))
14738 (defun org-align-tags-here (to-col)
14739 ;; Assumes that this is a headline
14740 "Align tags on the current headline to TO-COL."
14741 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14742 (beginning-of-line 1)
14743 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14744 (< pos (match-beginning 2)))
14745 (progn
14746 (setq tags-l (- (match-end 2) (match-beginning 2)))
14747 (goto-char (match-beginning 1))
14748 (insert " ")
14749 (delete-region (point) (1+ (match-beginning 2)))
14750 (setq ncol (max (current-column)
14751 (1+ col)
14752 (if (> to-col 0)
14753 to-col
14754 (- (abs to-col) tags-l))))
14755 (setq p (point))
14756 (insert (make-string (- ncol (current-column)) ?\ ))
14757 (setq ncol (current-column))
14758 (when indent-tabs-mode (tabify p (point-at-eol)))
14759 (org-move-to-column (min ncol col)))
14760 (goto-char pos))))
14762 (defun org-set-tags-command (&optional arg just-align)
14763 "Call the set-tags command for the current entry."
14764 (interactive "P")
14765 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14766 (org-set-tags arg just-align)
14767 (save-excursion
14768 (unless (and (org-region-active-p)
14769 org-loop-over-headlines-in-active-region)
14770 (org-back-to-heading t))
14771 (org-set-tags arg just-align))))
14773 (defun org-set-tags-to (data)
14774 "Set the tags of the current entry to DATA, replacing the current tags.
14775 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14776 If DATA is nil or the empty string, any tags will be removed."
14777 (interactive "sTags: ")
14778 (setq data
14779 (cond
14780 ((eq data nil) "")
14781 ((equal data "") "")
14782 ((stringp data)
14783 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14784 ":"))
14785 ((listp data)
14786 (concat ":" (mapconcat 'identity data ":") ":"))))
14787 (when data
14788 (save-excursion
14789 (org-back-to-heading t)
14790 (when (looking-at org-complex-heading-regexp)
14791 (if (match-end 5)
14792 (progn
14793 (goto-char (match-beginning 5))
14794 (insert data)
14795 (delete-region (point) (point-at-eol))
14796 (org-set-tags nil 'align))
14797 (goto-char (point-at-eol))
14798 (insert " " data)
14799 (org-set-tags nil 'align)))
14800 (beginning-of-line 1)
14801 (if (looking-at ".*?\\([ \t]+\\)$")
14802 (delete-region (match-beginning 1) (match-end 1))))))
14804 (defun org-align-all-tags ()
14805 "Align the tags i all headings."
14806 (interactive)
14807 (save-excursion
14808 (or (ignore-errors (org-back-to-heading t))
14809 (outline-next-heading))
14810 (if (org-at-heading-p)
14811 (org-set-tags t)
14812 (message "No headings"))))
14814 (defvar org-indent-indentation-per-level)
14815 (defun org-set-tags (&optional arg just-align)
14816 "Set the tags for the current headline.
14817 With prefix ARG, realign all tags in headings in the current buffer.
14818 When JUST-ALIGN is non-nil, only align tags."
14819 (interactive "P")
14820 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14821 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14822 'region-start-level 'region))
14823 org-loop-over-headlines-in-active-region)
14824 (org-map-entries
14825 ;; We don't use ARG and JUST-ALIGN here because these args
14826 ;; are not useful when looping over headlines.
14827 `(org-set-tags)
14828 org-loop-over-headlines-in-active-region
14829 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14830 (let* ((re org-outline-regexp-bol)
14831 (current (unless arg (org-get-tags-string)))
14832 (col (current-column))
14833 (org-setting-tags t)
14834 table current-tags inherited-tags ; computed below when needed
14835 tags p0 c0 c1 rpl di tc level)
14836 (if arg
14837 (save-excursion
14838 (goto-char (point-min))
14839 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14840 (while (re-search-forward re nil t)
14841 (org-set-tags nil t)
14842 (end-of-line 1)))
14843 (message "All tags realigned to column %d" org-tags-column))
14844 (if just-align
14845 (setq tags current)
14846 ;; Get a new set of tags from the user
14847 (save-excursion
14848 (setq table (append org-tag-persistent-alist
14849 (or org-tag-alist (org-get-buffer-tags))
14850 (and
14851 org-complete-tags-always-offer-all-agenda-tags
14852 (org-global-tags-completion-table
14853 (org-agenda-files))))
14854 org-last-tags-completion-table table
14855 current-tags (org-split-string current ":")
14856 inherited-tags (nreverse
14857 (nthcdr (length current-tags)
14858 (nreverse (org-get-tags-at))))
14859 tags
14860 (if (or (eq t org-use-fast-tag-selection)
14861 (and org-use-fast-tag-selection
14862 (delq nil (mapcar 'cdr table))))
14863 (org-fast-tag-selection
14864 current-tags inherited-tags table
14865 (if org-fast-tag-selection-include-todo
14866 org-todo-key-alist))
14867 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14868 (org-trim
14869 (org-icompleting-read "Tags: "
14870 'org-tags-completion-function
14871 nil nil current 'org-tags-history))))))
14872 (while (string-match "[-+&]+" tags)
14873 ;; No boolean logic, just a list
14874 (setq tags (replace-match ":" t t tags))))
14876 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14878 (if org-tags-sort-function
14879 (setq tags (mapconcat 'identity
14880 (sort (org-split-string
14881 tags (org-re "[^[:alnum:]_@#%]+"))
14882 org-tags-sort-function) ":")))
14884 (if (string-match "\\`[\t ]*\\'" tags)
14885 (setq tags "")
14886 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14887 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14889 ;; Insert new tags at the correct column
14890 (beginning-of-line 1)
14891 (setq level (or (and (looking-at org-outline-regexp)
14892 (- (match-end 0) (point) 1))
14894 (cond
14895 ((and (equal current "") (equal tags "")))
14896 ((re-search-forward
14897 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14898 (point-at-eol) t)
14899 (if (equal tags "")
14900 (setq rpl "")
14901 (goto-char (match-beginning 0))
14902 (setq c0 (current-column)
14903 ;; compute offset for the case of org-indent-mode active
14904 di (if (org-bound-and-true-p org-indent-mode)
14905 (* (1- org-indent-indentation-per-level) (1- level))
14907 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14908 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14909 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
14910 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14911 (replace-match rpl t t)
14912 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14913 tags)
14914 (t (error "Tags alignment failed")))
14915 (org-move-to-column col)
14916 (unless just-align
14917 (run-hooks 'org-after-tags-change-hook))))))
14919 (defun org-change-tag-in-region (beg end tag off)
14920 "Add or remove TAG for each entry in the region.
14921 This works in the agenda, and also in an org-mode buffer."
14922 (interactive
14923 (list (region-beginning) (region-end)
14924 (let ((org-last-tags-completion-table
14925 (if (derived-mode-p 'org-mode)
14926 (org-uniquify
14927 (delq nil (append (org-get-buffer-tags)
14928 (org-global-tags-completion-table))))
14929 (org-global-tags-completion-table))))
14930 (org-icompleting-read
14931 "Tag: " 'org-tags-completion-function nil nil nil
14932 'org-tags-history))
14933 (progn
14934 (message "[s]et or [r]emove? ")
14935 (equal (read-char-exclusive) ?r))))
14936 (if (fboundp 'deactivate-mark) (deactivate-mark))
14937 (let ((agendap (equal major-mode 'org-agenda-mode))
14938 l1 l2 m buf pos newhead (cnt 0))
14939 (goto-char end)
14940 (setq l2 (1- (org-current-line)))
14941 (goto-char beg)
14942 (setq l1 (org-current-line))
14943 (loop for l from l1 to l2 do
14944 (org-goto-line l)
14945 (setq m (get-text-property (point) 'org-hd-marker))
14946 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14947 (and agendap m))
14948 (setq buf (if agendap (marker-buffer m) (current-buffer))
14949 pos (if agendap m (point)))
14950 (with-current-buffer buf
14951 (save-excursion
14952 (save-restriction
14953 (goto-char pos)
14954 (setq cnt (1+ cnt))
14955 (org-toggle-tag tag (if off 'off 'on))
14956 (setq newhead (org-get-heading)))))
14957 (and agendap (org-agenda-change-all-lines newhead m))))
14958 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14960 (defun org-tags-completion-function (string predicate &optional flag)
14961 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14962 (confirm (lambda (x) (stringp (car x)))))
14963 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14964 (setq s1 (match-string 1 string)
14965 s2 (match-string 2 string))
14966 (setq s1 "" s2 string))
14967 (cond
14968 ((eq flag nil)
14969 ;; try completion
14970 (setq rtn (try-completion s2 ctable confirm))
14971 (if (stringp rtn)
14972 (setq rtn
14973 (concat s1 s2 (substring rtn (length s2))
14974 (if (and org-add-colon-after-tag-completion
14975 (assoc rtn ctable))
14976 ":" ""))))
14977 rtn)
14978 ((eq flag t)
14979 ;; all-completions
14980 (all-completions s2 ctable confirm))
14981 ((eq flag 'lambda)
14982 ;; exact match?
14983 (assoc s2 ctable)))))
14985 (defun org-fast-tag-insert (kwd tags face &optional end)
14986 "Insert KDW, and the TAGS, the latter with face FACE.
14987 Also insert END."
14988 (insert (format "%-12s" (concat kwd ":"))
14989 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14990 (or end "")))
14992 (defun org-fast-tag-show-exit (flag)
14993 (save-excursion
14994 (org-goto-line 3)
14995 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
14996 (replace-match ""))
14997 (when flag
14998 (end-of-line 1)
14999 (org-move-to-column (- (window-width) 19) t)
15000 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15002 (defun org-set-current-tags-overlay (current prefix)
15003 "Add an overlay to CURRENT tag with PREFIX."
15004 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15005 (if (featurep 'xemacs)
15006 (org-overlay-display org-tags-overlay (concat prefix s)
15007 'secondary-selection)
15008 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15009 (org-overlay-display org-tags-overlay (concat prefix s)))))
15011 (defvar org-last-tag-selection-key nil)
15012 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15013 "Fast tag selection with single keys.
15014 CURRENT is the current list of tags in the headline, INHERITED is the
15015 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15016 possibly with grouping information. TODO-TABLE is a similar table with
15017 TODO keywords, should these have keys assigned to them.
15018 If the keys are nil, a-z are automatically assigned.
15019 Returns the new tags string, or nil to not change the current settings."
15020 (let* ((fulltable (append table todo-table))
15021 (maxlen (apply 'max (mapcar
15022 (lambda (x)
15023 (if (stringp (car x)) (string-width (car x)) 0))
15024 fulltable)))
15025 (buf (current-buffer))
15026 (expert (eq org-fast-tag-selection-single-key 'expert))
15027 (buffer-tags nil)
15028 (fwidth (+ maxlen 3 1 3))
15029 (ncol (/ (- (window-width) 4) fwidth))
15030 (i-face 'org-done)
15031 (c-face 'org-todo)
15032 tg cnt e c char c1 c2 ntable tbl rtn
15033 ov-start ov-end ov-prefix
15034 (exit-after-next org-fast-tag-selection-single-key)
15035 (done-keywords org-done-keywords)
15036 groups ingroup)
15037 (save-excursion
15038 (beginning-of-line 1)
15039 (if (looking-at
15040 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15041 (setq ov-start (match-beginning 1)
15042 ov-end (match-end 1)
15043 ov-prefix "")
15044 (setq ov-start (1- (point-at-eol))
15045 ov-end (1+ ov-start))
15046 (skip-chars-forward "^\n\r")
15047 (setq ov-prefix
15048 (concat
15049 (buffer-substring (1- (point)) (point))
15050 (if (> (current-column) org-tags-column)
15052 (make-string (- org-tags-column (current-column)) ?\ ))))))
15053 (move-overlay org-tags-overlay ov-start ov-end)
15054 (save-window-excursion
15055 (if expert
15056 (set-buffer (get-buffer-create " *Org tags*"))
15057 (delete-other-windows)
15058 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15059 (org-switch-to-buffer-other-window " *Org tags*"))
15060 (erase-buffer)
15061 (org-set-local 'org-done-keywords done-keywords)
15062 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15063 (org-fast-tag-insert "Current" current c-face "\n\n")
15064 (org-fast-tag-show-exit exit-after-next)
15065 (org-set-current-tags-overlay current ov-prefix)
15066 (setq tbl fulltable char ?a cnt 0)
15067 (while (setq e (pop tbl))
15068 (cond
15069 ((equal (car e) :startgroup)
15070 (push '() groups) (setq ingroup t)
15071 (when (not (= cnt 0))
15072 (setq cnt 0)
15073 (insert "\n"))
15074 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15075 ((equal (car e) :endgroup)
15076 (setq ingroup nil cnt 0)
15077 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15078 ((equal e '(:newline))
15079 (when (not (= cnt 0))
15080 (setq cnt 0)
15081 (insert "\n")
15082 (setq e (car tbl))
15083 (while (equal (car tbl) '(:newline))
15084 (insert "\n")
15085 (setq tbl (cdr tbl)))))
15086 ((equal e '(:grouptags)) nil)
15088 (setq tg (copy-sequence (car e)) c2 nil)
15089 (if (cdr e)
15090 (setq c (cdr e))
15091 ;; automatically assign a character.
15092 (setq c1 (string-to-char
15093 (downcase (substring
15094 tg (if (= (string-to-char tg) ?@) 1 0)))))
15095 (if (or (rassoc c1 ntable) (rassoc c1 table))
15096 (while (or (rassoc char ntable) (rassoc char table))
15097 (setq char (1+ char)))
15098 (setq c2 c1))
15099 (setq c (or c2 char)))
15100 (if ingroup (push tg (car groups)))
15101 (setq tg (org-add-props tg nil 'face
15102 (cond
15103 ((not (assoc tg table))
15104 (org-get-todo-face tg))
15105 ((member tg current) c-face)
15106 ((member tg inherited) i-face))))
15107 (if (equal (caar tbl) :grouptags)
15108 (org-add-props tg nil 'face 'org-tag-group))
15109 (if (and (= cnt 0) (not ingroup)) (insert " "))
15110 (insert "[" c "] " tg (make-string
15111 (- fwidth 4 (length tg)) ?\ ))
15112 (push (cons tg c) ntable)
15113 (when (= (setq cnt (1+ cnt)) ncol)
15114 (insert "\n")
15115 (if ingroup (insert " "))
15116 (setq cnt 0)))))
15117 (setq ntable (nreverse ntable))
15118 (insert "\n")
15119 (goto-char (point-min))
15120 (if (not expert) (org-fit-window-to-buffer))
15121 (setq rtn
15122 (catch 'exit
15123 (while t
15124 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15125 (if (not groups) "no " "")
15126 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15127 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15128 (setq org-last-tag-selection-key c)
15129 (cond
15130 ((= c ?\r) (throw 'exit t))
15131 ((= c ?!)
15132 (setq groups (not groups))
15133 (goto-char (point-min))
15134 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15135 ((= c ?\C-c)
15136 (if (not expert)
15137 (org-fast-tag-show-exit
15138 (setq exit-after-next (not exit-after-next)))
15139 (setq expert nil)
15140 (delete-other-windows)
15141 (set-window-buffer (split-window-vertically) " *Org tags*")
15142 (org-switch-to-buffer-other-window " *Org tags*")
15143 (org-fit-window-to-buffer)))
15144 ((or (= c ?\C-g)
15145 (and (= c ?q) (not (rassoc c ntable))))
15146 (org-detach-overlay org-tags-overlay)
15147 (setq quit-flag t))
15148 ((= c ?\ )
15149 (setq current nil)
15150 (if exit-after-next (setq exit-after-next 'now)))
15151 ((= c ?\t)
15152 (condition-case nil
15153 (setq tg (org-icompleting-read
15154 "Tag: "
15155 (or buffer-tags
15156 (with-current-buffer buf
15157 (org-get-buffer-tags)))))
15158 (quit (setq tg "")))
15159 (when (string-match "\\S-" tg)
15160 (add-to-list 'buffer-tags (list tg))
15161 (if (member tg current)
15162 (setq current (delete tg current))
15163 (push tg current)))
15164 (if exit-after-next (setq exit-after-next 'now)))
15165 ((setq e (rassoc c todo-table) tg (car e))
15166 (with-current-buffer buf
15167 (save-excursion (org-todo tg)))
15168 (if exit-after-next (setq exit-after-next 'now)))
15169 ((setq e (rassoc c ntable) tg (car e))
15170 (if (member tg current)
15171 (setq current (delete tg current))
15172 (loop for g in groups do
15173 (if (member tg g)
15174 (mapc (lambda (x)
15175 (setq current (delete x current)))
15176 g)))
15177 (push tg current))
15178 (if exit-after-next (setq exit-after-next 'now))))
15180 ;; Create a sorted list
15181 (setq current
15182 (sort current
15183 (lambda (a b)
15184 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15185 (if (eq exit-after-next 'now) (throw 'exit t))
15186 (goto-char (point-min))
15187 (beginning-of-line 2)
15188 (delete-region (point) (point-at-eol))
15189 (org-fast-tag-insert "Current" current c-face)
15190 (org-set-current-tags-overlay current ov-prefix)
15191 (while (re-search-forward
15192 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15193 (setq tg (match-string 1))
15194 (add-text-properties
15195 (match-beginning 1) (match-end 1)
15196 (list 'face
15197 (cond
15198 ((member tg current) c-face)
15199 ((member tg inherited) i-face)
15200 (t (get-text-property (match-beginning 1) 'face))))))
15201 (goto-char (point-min)))))
15202 (org-detach-overlay org-tags-overlay)
15203 (if rtn
15204 (mapconcat 'identity current ":")
15205 nil))))
15207 (defun org-get-tags-string ()
15208 "Get the TAGS string in the current headline."
15209 (unless (org-at-heading-p t)
15210 (user-error "Not on a heading"))
15211 (save-excursion
15212 (beginning-of-line 1)
15213 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15214 (org-match-string-no-properties 1)
15215 "")))
15217 (defun org-get-tags ()
15218 "Get the list of tags specified in the current headline."
15219 (org-split-string (org-get-tags-string) ":"))
15221 (defun org-get-buffer-tags ()
15222 "Get a table of all tags used in the buffer, for completion."
15223 (org-with-wide-buffer
15224 (goto-char (point-min))
15225 (let ((tag-re (concat org-outline-regexp-bol
15226 "\\(?:.*?[ \t]\\)?"
15227 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15228 tags)
15229 (while (re-search-forward tag-re nil t)
15230 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15231 (push tag tags)))
15232 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15234 ;;;; The mapping API
15236 (defun org-map-entries (func &optional match scope &rest skip)
15237 "Call FUNC at each headline selected by MATCH in SCOPE.
15239 FUNC is a function or a lisp form. The function will be called without
15240 arguments, with the cursor positioned at the beginning of the headline.
15241 The return values of all calls to the function will be collected and
15242 returned as a list.
15244 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15245 does not need to preserve point. After evaluation, the cursor will be
15246 moved to the end of the line (presumably of the headline of the
15247 processed entry) and search continues from there. Under some
15248 circumstances, this may not produce the wanted results. For example,
15249 if you have removed (e.g. archived) the current (sub)tree it could
15250 mean that the next entry will be skipped entirely. In such cases, you
15251 can specify the position from where search should continue by making
15252 FUNC set the variable `org-map-continue-from' to the desired buffer
15253 position.
15255 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15256 Only headlines that are matched by this query will be considered during
15257 the iteration. When MATCH is nil or t, all headlines will be
15258 visited by the iteration.
15260 SCOPE determines the scope of this command. It can be any of:
15262 nil The current buffer, respecting the restriction if any
15263 tree The subtree started with the entry at point
15264 region The entries within the active region, if any
15265 region-start-level
15266 The entries within the active region, but only those at
15267 the same level than the first one.
15268 file The current buffer, without restriction
15269 file-with-archives
15270 The current buffer, and any archives associated with it
15271 agenda All agenda files
15272 agenda-with-archives
15273 All agenda files with any archive files associated with them
15274 \(file1 file2 ...)
15275 If this is a list, all files in the list will be scanned
15277 The remaining args are treated as settings for the skipping facilities of
15278 the scanner. The following items can be given here:
15280 archive skip trees with the archive tag
15281 comment skip trees with the COMMENT keyword
15282 function or Emacs Lisp form:
15283 will be used as value for `org-agenda-skip-function', so
15284 whenever the function returns a position, FUNC will not be
15285 called for that entry and search will continue from the
15286 position returned
15288 If your function needs to retrieve the tags including inherited tags
15289 at the *current* entry, you can use the value of the variable
15290 `org-scanner-tags' which will be much faster than getting the value
15291 with `org-get-tags-at'. If your function gets properties with
15292 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15293 to t around the call to `org-entry-properties' to get the same speedup.
15294 Note that if your function moves around to retrieve tags and properties at
15295 a *different* entry, you cannot use these techniques."
15296 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15297 (not (org-region-active-p)))
15298 (let* ((org-agenda-archives-mode nil) ; just to make sure
15299 (org-agenda-skip-archived-trees (memq 'archive skip))
15300 (org-agenda-skip-comment-trees (memq 'comment skip))
15301 (org-agenda-skip-function
15302 (car (org-delete-all '(comment archive) skip)))
15303 (org-tags-match-list-sublevels t)
15304 (start-level (eq scope 'region-start-level))
15305 matcher file res
15306 org-todo-keywords-for-agenda
15307 org-done-keywords-for-agenda
15308 org-todo-keyword-alist-for-agenda
15309 org-tag-alist-for-agenda
15310 todo-only)
15312 (cond
15313 ((eq match t) (setq matcher t))
15314 ((eq match nil) (setq matcher t))
15315 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15317 (save-excursion
15318 (save-restriction
15319 (cond ((eq scope 'tree)
15320 (org-back-to-heading t)
15321 (org-narrow-to-subtree)
15322 (setq scope nil))
15323 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15324 (org-region-active-p))
15325 ;; If needed, set start-level to a string like "2"
15326 (when start-level
15327 (save-excursion
15328 (goto-char (region-beginning))
15329 (unless (org-at-heading-p) (outline-next-heading))
15330 (setq start-level (org-current-level))))
15331 (narrow-to-region (region-beginning)
15332 (save-excursion
15333 (goto-char (region-end))
15334 (unless (and (bolp) (org-at-heading-p))
15335 (outline-next-heading))
15336 (point)))
15337 (setq scope nil)))
15339 (if (not scope)
15340 (progn
15341 (org-agenda-prepare-buffers
15342 (list (buffer-file-name (current-buffer))))
15343 (setq res (org-scan-tags func matcher todo-only start-level)))
15344 ;; Get the right scope
15345 (cond
15346 ((and scope (listp scope) (symbolp (car scope)))
15347 (setq scope (eval scope)))
15348 ((eq scope 'agenda)
15349 (setq scope (org-agenda-files t)))
15350 ((eq scope 'agenda-with-archives)
15351 (setq scope (org-agenda-files t))
15352 (setq scope (org-add-archive-files scope)))
15353 ((eq scope 'file)
15354 (setq scope (list (buffer-file-name))))
15355 ((eq scope 'file-with-archives)
15356 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15357 (org-agenda-prepare-buffers scope)
15358 (while (setq file (pop scope))
15359 (with-current-buffer (org-find-base-buffer-visiting file)
15360 (save-excursion
15361 (save-restriction
15362 (widen)
15363 (goto-char (point-min))
15364 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15365 res)))
15367 ;;; Properties API
15369 (defconst org-special-properties
15370 '("ALLTAGS" "BLOCKED" "CATEGORY" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE"
15371 "FILE" "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA"
15372 "TODO")
15373 "The special properties valid in Org mode.
15374 These are properties that are not defined in the property drawer,
15375 but in some other way.")
15377 (defconst org-default-properties
15378 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15379 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15380 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15381 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15382 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15383 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15384 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15385 "Some properties that are used by Org mode for various purposes.
15386 Being in this list makes sure that they are offered for completion.")
15388 (defun org--update-property-plist (key val props)
15389 "Associate KEY to VAL in alist PROPS.
15390 Modifications are made by side-effect. Return new alist."
15391 (let* ((appending (string= (substring key -1) "+"))
15392 (key (if appending (substring key 0 -1) key))
15393 (old (assoc-string key props t)))
15394 (if (not old) (cons (cons key val) props)
15395 (setcdr old (if appending (concat (cdr old) " " val) val))
15396 props)))
15398 (defun org-get-property-block (&optional beg force)
15399 "Return the (beg . end) range of the body of the property drawer.
15400 BEG is the beginning of the current subtree, or of the part
15401 before the first headline. If it is not given, it will be found.
15402 If the drawer does not exist, create it if FORCE is non-nil, or
15403 return nil."
15404 (org-with-wide-buffer
15405 (when beg (goto-char beg))
15406 (unless (org-before-first-heading-p)
15407 (let ((beg (cond (beg)
15408 ((or (not (featurep 'org-inlinetask))
15409 (org-inlinetask-in-task-p))
15410 (org-back-to-heading t))
15411 (t (org-with-limited-levels (org-back-to-heading t))))))
15412 (forward-line)
15413 (when (org-looking-at-p org-planning-line-re) (forward-line))
15414 (cond ((looking-at org-property-drawer-re)
15415 (forward-line)
15416 (cons (point) (progn (goto-char (match-end 0))
15417 (line-beginning-position))))
15418 (force
15419 (goto-char beg)
15420 (org-insert-property-drawer)
15421 (let ((pos (save-excursion (search-forward ":END:")
15422 (line-beginning-position))))
15423 (cons pos pos))))))))
15425 (defun org-at-property-p ()
15426 "Non-nil when point is inside a property drawer.
15427 See `org-property-re' for match data, if applicable."
15428 (save-excursion
15429 (beginning-of-line)
15430 (and (looking-at org-property-re)
15431 (let ((property-drawer (save-match-data (org-get-property-block))))
15432 (and property-drawer (< (point) (cdr property-drawer)))))))
15434 (defun org-property-action ()
15435 "Do an action on properties."
15436 (interactive)
15437 (unless (org-at-property-p) (user-error "Not at a property"))
15438 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15439 (let ((c (read-char-exclusive)))
15440 (case c
15441 (?s (call-interactively #'org-set-property))
15442 (?d (call-interactively #'org-delete-property))
15443 (?D (call-interactively #'org-delete-property-globally))
15444 (?c (call-interactively #'org-compute-property-at-point))
15445 (otherwise (user-error "No such property action %c" c)))))
15447 (defun org-inc-effort ()
15448 "Increment the value of the effort property in the current entry."
15449 (interactive)
15450 (org-set-effort nil t))
15452 (defvar org-clock-effort) ; Defined in org-clock.el.
15453 (defvar org-clock-current-task) ; Defined in org-clock.el.
15454 (defun org-set-effort (&optional value increment)
15455 "Set the effort property of the current entry.
15456 With numerical prefix arg, use the nth allowed value, 0 stands for the
15457 10th allowed value.
15459 When INCREMENT is non-nil, set the property to the next allowed value."
15460 (interactive "P")
15461 (if (equal value 0) (setq value 10))
15462 (let* ((completion-ignore-case t)
15463 (prop org-effort-property)
15464 (cur (org-entry-get nil prop))
15465 (allowed (org-property-get-allowed-values nil prop 'table))
15466 (existing (mapcar 'list (org-property-values prop)))
15467 (heading (nth 4 (org-heading-components)))
15469 (val (cond
15470 ((stringp value) value)
15471 ((and allowed (integerp value))
15472 (or (car (nth (1- value) allowed))
15473 (car (org-last allowed))))
15474 ((and allowed increment)
15475 (or (caadr (member (list cur) allowed))
15476 (user-error "Allowed effort values are not set")))
15477 (allowed
15478 (message "Select 1-9,0, [RET%s]: %s"
15479 (if cur (concat "=" cur) "")
15480 (mapconcat 'car allowed " "))
15481 (setq rpl (read-char-exclusive))
15482 (if (equal rpl ?\r)
15484 (setq rpl (- rpl ?0))
15485 (if (equal rpl 0) (setq rpl 10))
15486 (if (and (> rpl 0) (<= rpl (length allowed)))
15487 (car (nth (1- rpl) allowed))
15488 (org-completing-read "Effort: " allowed nil))))
15490 (let (org-completion-use-ido org-completion-use-iswitchb)
15491 (org-completing-read
15492 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15493 (concat "[" cur "]") "")
15494 ": ")
15495 existing nil nil "" nil cur))))))
15496 (unless (equal (org-entry-get nil prop) val)
15497 (org-entry-put nil prop val))
15498 (org-refresh-property
15499 '((effort . identity)
15500 (effort-minutes . org-duration-string-to-minutes))
15501 val)
15502 (when (string= heading org-clock-current-task)
15503 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15504 (org-clock-update-mode-line))
15505 (message "%s is now %s" prop val)))
15507 (defun org-entry-properties (&optional pom which)
15508 "Get all properties of the current entry.
15510 When POM is a buffer position, get all properties from the entry
15511 there instead.
15513 This includes the TODO keyword, the tags, time strings for
15514 deadline, scheduled, and clocking, and any additional properties
15515 defined in the entry.
15517 If WHICH is nil or `all', get all properties. If WHICH is
15518 `special' or `standard', only get that subclass. If WHICH is
15519 a string, only get that property.
15521 Return value is an alist. Keys are properties, as upcased
15522 strings."
15523 (org-with-point-at pom
15524 (when (and (derived-mode-p 'org-mode)
15525 (ignore-errors (org-back-to-heading t)))
15526 (catch 'exit
15527 (let* ((beg (point))
15528 (specific (and (stringp which) (upcase which)))
15529 (which (cond ((not specific) which)
15530 ((member specific org-special-properties) 'special)
15531 (t 'standard)))
15532 props)
15533 ;; Get the special properties, like TODO and TAGS.
15534 (when (memq which '(nil all special))
15535 (when (or (not specific) (string= specific "CLOCKSUM"))
15536 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15537 (when clocksum
15538 (push (cons "CLOCKSUM"
15539 (org-columns-number-to-string
15540 (/ (float clocksum) 60.) 'add_times))
15541 props)))
15542 (when specific (throw 'exit props)))
15543 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15544 (let ((clocksumt (get-text-property (point)
15545 :org-clock-minutes-today)))
15546 (when clocksumt
15547 (push (cons "CLOCKSUM_T"
15548 (org-columns-number-to-string
15549 (/ (float clocksumt) 60.) 'add_times))
15550 props)))
15551 (when specific (throw 'exit props)))
15552 (when (or (not specific) (string= specific "ITEM"))
15553 (when (looking-at org-complex-heading-regexp)
15554 (push (cons "ITEM"
15555 (concat
15556 (org-match-string-no-properties 1)
15557 (let ((title (org-match-string-no-properties 4)))
15558 (when (org-string-nw-p title)
15559 (concat " " (org-remove-tabs title))))))
15560 props))
15561 (when specific (throw 'exit props)))
15562 (when (or (not specific) (string= specific "TODO"))
15563 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15564 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15565 (when specific (throw 'exit props)))
15566 (when (or (not specific) (string= specific "PRIORITY"))
15567 (when (looking-at org-priority-regexp)
15568 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15569 (when specific (throw 'exit props)))
15570 (when (or (not specific) (string= specific "FILE"))
15571 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15572 props)
15573 (when specific (throw 'exit props)))
15574 (when (or (not specific) (string= specific "TAGS"))
15575 (let ((value (org-string-nw-p (org-get-tags-string))))
15576 (when value (push (cons "TAGS" value) props)))
15577 (when specific (throw 'exit props)))
15578 (when (or (not specific) (string= specific "ALLTAGS"))
15579 (let ((value (org-get-tags-at)))
15580 (when value
15581 (push (cons "ALLTAGS"
15582 (format ":%s:" (mapconcat #'identity value ":")))
15583 props)))
15584 (when specific (throw 'exit props)))
15585 (when (or (not specific) (string= specific "BLOCKED"))
15586 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15587 (when specific (throw 'exit props)))
15588 (when (or (not specific)
15589 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15590 (forward-line)
15591 (when (org-looking-at-p org-planning-line-re)
15592 (end-of-line)
15593 (let ((bol (line-beginning-position))
15594 ;; Backward compatibility: time keywords used to
15595 ;; be configurable (before 8.3). Make sure we
15596 ;; get the correct keyword.
15597 (key-assoc `(("CLOSED" . ,org-closed-string)
15598 ("DEADLINE" . ,org-deadline-string)
15599 ("SCHEDULED" . ,org-scheduled-string))))
15600 (dolist (pair (if specific (list (assoc specific key-assoc))
15601 key-assoc))
15602 (save-excursion
15603 (when (search-backward (cdr pair) bol t)
15604 (goto-char (match-end 0))
15605 (skip-chars-forward " \t")
15606 (and (looking-at org-ts-regexp-both)
15607 (push (cons (car pair)
15608 (org-match-string-no-properties 0))
15609 props)))))))
15610 (when specific (throw 'exit props)))
15611 (when (or (not specific)
15612 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15613 (let ((find-ts
15614 (lambda (end ts)
15615 (let ((regexp (if (or (string= specific "TIMESTAMP")
15616 (assoc "TIMESTAMP_IA" ts))
15617 org-ts-regexp
15618 org-ts-regexp-both)))
15619 (catch 'next
15620 (while (re-search-forward regexp end t)
15621 (backward-char)
15622 (let ((object (org-element-context)))
15623 ;; Accept to match timestamps in node
15624 ;; properties, too.
15625 (when (memq (org-element-type object)
15626 '(node-property timestamp))
15627 (let ((type
15628 (org-element-property :type object)))
15629 (cond
15630 ((and (memq type '(active active-range))
15631 (not (equal specific "TIMESTAMP_IA")))
15632 (unless (assoc "TIMESTAMP" ts)
15633 (push (cons "TIMESTAMP"
15634 (org-element-property
15635 :raw-value object))
15637 (when specific (throw 'exit ts))))
15638 ((and (memq type '(inactive inactive-range))
15639 (not (string= specific "TIMESTAMP")))
15640 (unless (assoc "TIMESTAMP_IA" ts)
15641 (push (cons "TIMESTAMP_IA"
15642 (org-element-property
15643 :raw-value object))
15645 (when specific (throw 'exit ts))))))
15646 ;; Both timestamp types are found,
15647 ;; move to next part.
15648 (when (= (length ts) 2) (throw 'next ts)))))
15649 ts)))))
15650 (goto-char beg)
15651 ;; First look for timestamps within headline.
15652 (let ((ts (funcall find-ts (line-end-position) nil)))
15653 (if (= (length ts) 2) (setq props (nconc ts props))
15654 (forward-line)
15655 ;; Then find timestamps in the section, skipping
15656 ;; planning line.
15657 (when (org-looking-at-p org-planning-line-re)
15658 (forward-line))
15659 (let ((end (save-excursion (outline-next-heading))))
15660 (setq props (nconc (funcall find-ts end ts) props))))))))
15661 ;; Get the standard properties, like :PROP:.
15662 (when (memq which '(nil all standard))
15663 ;; If we are looking after a specific property, delegate
15664 ;; to `org-entry-get', which is faster. However, make an
15665 ;; exception for "CATEGORY", since it can be also set
15666 ;; through keywords (i.e. #+CATEGORY).
15667 (if (and specific (not (equal specific "CATEGORY")))
15668 (let ((value (org-entry-get beg specific nil t)))
15669 (throw 'exit (and value (list (cons specific value)))))
15670 (let ((range (org-get-property-block beg)))
15671 (when range
15672 (let ((end (cdr range)) seen-base)
15673 (goto-char (car range))
15674 ;; Unlike to `org--update-property-plist', we
15675 ;; handle the case where base values is found
15676 ;; after its extension. We also forbid standard
15677 ;; properties to be named as special properties.
15678 (while (re-search-forward org-property-re end t)
15679 (let* ((key (upcase (org-match-string-no-properties 2)))
15680 (extendp (org-string-match-p "\\+\\'" key))
15681 (key-base (if extendp (substring key 0 -1) key))
15682 (value (org-match-string-no-properties 3)))
15683 (cond
15684 ((member-ignore-case key-base org-special-properties))
15685 (extendp
15686 (setq props
15687 (org--update-property-plist key value props)))
15688 ((member key seen-base))
15689 (t (push key seen-base)
15690 (let ((p (assoc-string key props t)))
15691 (if p (setcdr p (concat value " " (cdr p)))
15692 (push (cons key value) props))))))))))))
15693 (unless (assoc "CATEGORY" props)
15694 (push (cons "CATEGORY" (org-get-category beg)) props)
15695 (when (string= specific "CATEGORY") (throw 'exit props)))
15696 ;; Return value.
15697 (append (get-text-property beg 'org-summaries) props))))))
15699 (defun org-entry-get (pom property &optional inherit literal-nil)
15700 "Get value of PROPERTY for entry or content at point-or-marker POM.
15702 If INHERIT is non-nil and the entry does not have the property,
15703 then also check higher levels of the hierarchy. If INHERIT is
15704 the symbol `selective', use inheritance only if the setting in
15705 `org-use-property-inheritance' selects PROPERTY for inheritance.
15707 If the property is present but empty, the return value is the
15708 empty string. If the property is not present at all, nil is
15709 returned. In any other case, return the value as a string.
15710 Search is case-insensitive.
15712 If LITERAL-NIL is set, return the string value \"nil\" as
15713 a string, do not interpret it as the list atom nil. This is used
15714 for inheritance when a \"nil\" value can supersede a non-nil
15715 value higher up the hierarchy."
15716 (org-with-point-at pom
15717 (cond
15718 ((and inherit
15719 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15720 (org-entry-get-with-inheritance property literal-nil))
15721 ((member-ignore-case property org-special-properties)
15722 ;; We need a special property. Use `org-entry-properties' to
15723 ;; retrieve it, but specify the wanted property.
15724 (cdr (assoc-string property (org-entry-properties nil property))))
15726 (let ((range (org-get-property-block)))
15727 (when range
15728 (let* ((case-fold-search t)
15729 (end (cdr range))
15730 (props
15731 (let ((global
15732 (or (assoc-string property org-file-properties t)
15733 (assoc-string property org-global-properties t)
15734 (assoc-string
15735 property org-global-properties-fixed t))))
15736 ;; Make sure to not re-use GLOBAL as
15737 ;; `org--update-property-plist' would alter it by
15738 ;; side-effect.
15739 (and global (list (cons property (cdr global))))))
15740 (find-value
15741 (lambda (key)
15742 (when (re-search-forward (org-re-property key nil t) end t)
15743 (setq props
15744 (org--update-property-plist
15745 key (org-match-string-no-properties 3) props))))))
15746 (goto-char (car range))
15747 ;; Find base value.
15748 (save-excursion (funcall find-value property))
15749 ;; Find additional values.
15750 (let ((property+ (concat property "+")))
15751 (while (funcall find-value property+)))
15752 ;; Return final value.
15753 (let ((val (cdr (assoc-string property props t))))
15754 (if literal-nil val (org-not-nil val))))))))))
15756 (defun org-property-or-variable-value (var &optional inherit)
15757 "Check if there is a property fixing the value of VAR.
15758 If yes, return this value. If not, return the current value of the variable."
15759 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15760 (if (and prop (stringp prop) (string-match "\\S-" prop))
15761 (read prop)
15762 (symbol-value var))))
15764 (defun org-entry-delete (pom property)
15765 "Delete the property PROPERTY from entry at point-or-marker POM."
15766 (unless (member property org-special-properties)
15767 (org-with-point-at pom
15768 (let ((range (org-get-property-block)))
15769 (when range
15770 (let ((begin (car range))
15771 (end (copy-marker (cdr range))))
15772 (goto-char begin)
15773 (when (re-search-forward (org-re-property property nil t) end t)
15774 (delete-region (match-beginning 0) (line-beginning-position 2))
15775 ;; If drawer is empty, remove it altogether.
15776 (when (= begin end)
15777 (delete-region (line-beginning-position 0)
15778 (line-beginning-position 2)))
15779 (set-marker end nil))))))))
15781 ;; Multi-values properties are properties that contain multiple values
15782 ;; These values are assumed to be single words, separated by whitespace.
15783 (defun org-entry-add-to-multivalued-property (pom property value)
15784 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15785 (let* ((old (org-entry-get pom property))
15786 (values (and old (org-split-string old "[ \t]"))))
15787 (setq value (org-entry-protect-space value))
15788 (unless (member value values)
15789 (setq values (append values (list value)))
15790 (org-entry-put pom property
15791 (mapconcat 'identity values " ")))))
15793 (defun org-entry-remove-from-multivalued-property (pom property value)
15794 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15795 (let* ((old (org-entry-get pom property))
15796 (values (and old (org-split-string old "[ \t]"))))
15797 (setq value (org-entry-protect-space value))
15798 (when (member value values)
15799 (setq values (delete value values))
15800 (org-entry-put pom property
15801 (mapconcat 'identity values " ")))))
15803 (defun org-entry-member-in-multivalued-property (pom property value)
15804 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15805 (let* ((old (org-entry-get pom property))
15806 (values (and old (org-split-string old "[ \t]"))))
15807 (setq value (org-entry-protect-space value))
15808 (member value values)))
15810 (defun org-entry-get-multivalued-property (pom property)
15811 "Return a list of values in a multivalued property."
15812 (let* ((value (org-entry-get pom property))
15813 (values (and value (org-split-string value "[ \t]"))))
15814 (mapcar 'org-entry-restore-space values)))
15816 (defun org-entry-put-multivalued-property (pom property &rest values)
15817 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15818 VALUES should be a list of strings. Spaces will be protected."
15819 (org-entry-put pom property
15820 (mapconcat 'org-entry-protect-space values " "))
15821 (let* ((value (org-entry-get pom property))
15822 (values (and value (org-split-string value "[ \t]"))))
15823 (mapcar 'org-entry-restore-space values)))
15825 (defun org-entry-protect-space (s)
15826 "Protect spaces and newline in string S."
15827 (while (string-match " " s)
15828 (setq s (replace-match "%20" t t s)))
15829 (while (string-match "\n" s)
15830 (setq s (replace-match "%0A" t t s)))
15833 (defun org-entry-restore-space (s)
15834 "Restore spaces and newline in string S."
15835 (while (string-match "%20" s)
15836 (setq s (replace-match " " t t s)))
15837 (while (string-match "%0A" s)
15838 (setq s (replace-match "\n" t t s)))
15841 (defvar org-entry-property-inherited-from (make-marker)
15842 "Marker pointing to the entry from where a property was inherited.
15843 Each call to `org-entry-get-with-inheritance' will set this marker to the
15844 location of the entry where the inheritance search matched. If there was
15845 no match, the marker will point nowhere.
15846 Note that also `org-entry-get' calls this function, if the INHERIT flag
15847 is set.")
15849 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15850 "Get PROPERTY of entry or content at point, search higher levels if needed.
15851 The search will stop at the first ancestor which has the property defined.
15852 If the value found is \"nil\", return nil to show that the property
15853 should be considered as undefined (this is the meaning of nil here).
15854 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15855 (move-marker org-entry-property-inherited-from nil)
15856 (let (value)
15857 (org-with-wide-buffer
15858 (catch 'exit
15859 (while t
15860 (when (setq value (org-entry-get nil property nil literal-nil))
15861 (org-back-to-heading t)
15862 (move-marker org-entry-property-inherited-from (point))
15863 (throw 'exit nil))
15864 (or (org-up-heading-safe) (throw 'exit nil)))))
15865 (unless value
15866 (setq value
15867 (cdr (or (assoc-string property org-file-properties t)
15868 (assoc-string property org-global-properties t)
15869 (assoc-string property org-global-properties-fixed t)))))
15870 (if literal-nil value (org-not-nil value))))
15872 (defvar org-property-changed-functions nil
15873 "Hook called when the value of a property has changed.
15874 Each hook function should accept two arguments, the name of the property
15875 and the new value.")
15877 (defun org-entry-put (pom property value)
15878 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15880 If the value is `nil', it is converted to the empty string. If
15881 it is not a string, an error is raised.
15883 PROPERTY can be any regular property (see
15884 `org-special-properties'). It can also be \"TODO\",
15885 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
15887 For the last two properties, VALUE may have any of the special
15888 values \"earlier\" and \"later\". The function then increases or
15889 decreases scheduled or deadline date by one day."
15890 (cond ((null value) (setq value ""))
15891 ((not (stringp value)) (error "Properties values should be strings")))
15892 (org-with-point-at pom
15893 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
15894 (org-back-to-heading t)
15895 (org-with-limited-levels (org-back-to-heading t)))
15896 (let ((beg (point)))
15897 (cond
15898 ((equal property "TODO")
15899 (cond ((not (org-string-nw-p value)) (setq value 'none))
15900 ((not (member value org-todo-keywords-1))
15901 (user-error "\"%s\" is not a valid TODO state" value)))
15902 (org-todo value)
15903 (org-set-tags nil 'align))
15904 ((equal property "PRIORITY")
15905 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
15906 (org-set-tags nil 'align))
15907 ((equal property "SCHEDULED")
15908 (forward-line)
15909 (if (and (org-looking-at-p org-planning-line-re)
15910 (re-search-forward
15911 org-scheduled-time-regexp (line-end-position) t))
15912 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15913 ((string= value "later") (org-timestamp-change 1 'day))
15914 ((string= value "") (org-schedule '(4)))
15915 (t (org-schedule nil value)))
15916 (if (member value '("earlier" "later" ""))
15917 (call-interactively #'org-schedule)
15918 (org-schedule nil value))))
15919 ((equal property "DEADLINE")
15920 (forward-line)
15921 (if (and (org-looking-at-p org-planning-line-re)
15922 (re-search-forward
15923 org-deadline-time-regexp (line-end-position) t))
15924 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15925 ((string= value "later") (org-timestamp-change 1 'day))
15926 ((string= value "") (org-deadline '(4)))
15927 (t (org-deadline nil value)))
15928 (if (member value '("earlier" "later" ""))
15929 (call-interactively #'org-deadline)
15930 (org-deadline nil value))))
15931 ((member property org-special-properties)
15932 (error "The %s property cannot be set with `org-entry-put'" property))
15934 (let* ((range (org-get-property-block beg 'force))
15935 (end (cdr range))
15936 (case-fold-search t))
15937 (goto-char (car range))
15938 (if (re-search-forward (org-re-property property nil t) end t)
15939 (progn (delete-region (match-beginning 0) (match-end 0))
15940 (goto-char (match-beginning 0)))
15941 (goto-char end)
15942 (insert "\n")
15943 (backward-char))
15944 (insert ":" property ":")
15945 (when value (insert " " value))
15946 (org-indent-line)))))
15947 (run-hook-with-args 'org-property-changed-functions property value)))
15949 (defun org-buffer-property-keys (&optional specials defaults columns)
15950 "Get all property keys in the current buffer.
15952 When SPECIALS is non-nil, also list the special properties that
15953 reflect things like tags and TODO state.
15955 When DEFAULTS is non-nil, also include properties that has
15956 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
15957 DESCRIPTION, LOCATION, and LOGGING and others.
15959 When COLUMNS in non-nil, also include property names given in
15960 COLUMN formats in the current buffer."
15961 (let ((case-fold-search t)
15962 (props (append
15963 (and specials org-special-properties)
15964 (and defaults (cons org-effort-property org-default-properties))
15965 nil)))
15966 (org-with-wide-buffer
15967 (goto-char (point-min))
15968 (while (re-search-forward org-property-start-re nil t)
15969 (let ((range (org-get-property-block)))
15970 (catch 'skip
15971 (unless range
15972 (when (and (not (org-before-first-heading-p))
15973 (y-or-n-p (format "Malformed drawer at %d, repair?"
15974 (line-beginning-position))))
15975 (org-get-property-block nil t))
15976 (throw 'skip nil))
15977 (goto-char (car range))
15978 (let ((begin (car range))
15979 (end (cdr range)))
15980 ;; Make sure that found property block is not located
15981 ;; before current point, as it would generate an infloop.
15982 ;; It can happen, for example, in the following
15983 ;; situation:
15985 ;; * Headline
15986 ;; :PROPERTIES:
15987 ;; ...
15988 ;; :END:
15989 ;; *************** Inlinetask
15990 ;; #+BEGIN_EXAMPLE
15991 ;; :PROPERTIES:
15992 ;; #+END_EXAMPLE
15994 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
15995 (while (< (point) end)
15996 (let ((p (progn (looking-at org-property-re)
15997 (org-match-string-no-properties 2))))
15998 ;; Only add true property name, not extension symbol.
15999 (add-to-list 'props
16000 (if (not (org-string-match-p "\\+\\'" p)) p
16001 (substring p 0 -1))))
16002 (forward-line))))
16003 (outline-next-heading)))
16004 (when columns
16005 (goto-char (point-min))
16006 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16007 (let ((element (org-element-at-point)))
16008 (when (memq (org-element-type element) '(keyword node-property))
16009 (let ((value (org-element-property :value element))
16010 (start 0))
16011 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16012 (setq start (match-end 0))
16013 (let ((p (org-match-string-no-properties 1 value)))
16014 (unless (member-ignore-case p org-special-properties)
16015 (add-to-list 'props p))))))))))
16016 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16018 (defun org-property-values (key)
16019 "List all non-nil values of property KEY in current buffer."
16020 (org-with-wide-buffer
16021 (goto-char (point-min))
16022 (let ((case-fold-search t)
16023 (re (org-re-property key))
16024 values)
16025 (while (re-search-forward re nil t)
16026 (add-to-list 'values (org-entry-get (point) key)))
16027 values)))
16029 (defun org-insert-property-drawer ()
16030 "Insert a property drawer into the current entry."
16031 (org-with-wide-buffer
16032 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16033 (org-back-to-heading t)
16034 (org-with-limited-levels (org-back-to-heading t)))
16035 (forward-line)
16036 (when (org-looking-at-p org-planning-line-re) (forward-line))
16037 (unless (org-looking-at-p org-property-drawer-re)
16038 (let ((inhibit-read-only t))
16039 (unless (bolp) (insert "\n"))
16040 (let ((begin (point)))
16041 (insert ":PROPERTIES:\n:END:\n")
16042 (org-indent-region begin (point)))))))
16044 (defun org-insert-drawer (&optional arg drawer)
16045 "Insert a drawer at point.
16047 When optional argument ARG is non-nil, insert a property drawer.
16049 Optional argument DRAWER, when non-nil, is a string representing
16050 drawer's name. Otherwise, the user is prompted for a name.
16052 If a region is active, insert the drawer around that region
16053 instead.
16055 Point is left between drawer's boundaries."
16056 (interactive "P")
16057 (let* ((drawer (if arg "PROPERTIES"
16058 (or drawer (read-from-minibuffer "Drawer: ")))))
16059 (cond
16060 ;; With C-u, fall back on `org-insert-property-drawer'
16061 (arg (org-insert-property-drawer))
16062 ;; Check validity of suggested drawer's name.
16063 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16064 (user-error "Invalid drawer name"))
16065 ;; With an active region, insert a drawer at point.
16066 ((not (org-region-active-p))
16067 (progn
16068 (unless (bolp) (insert "\n"))
16069 (insert (format ":%s:\n\n:END:\n" drawer))
16070 (forward-line -2)))
16071 ;; Otherwise, insert the drawer at point
16073 (let ((rbeg (region-beginning))
16074 (rend (copy-marker (region-end))))
16075 (unwind-protect
16076 (progn
16077 (goto-char rbeg)
16078 (beginning-of-line)
16079 (when (save-excursion
16080 (re-search-forward org-outline-regexp-bol rend t))
16081 (user-error "Drawers cannot contain headlines"))
16082 ;; Position point at the beginning of the first
16083 ;; non-blank line in region. Insert drawer's opening
16084 ;; there, then indent it.
16085 (org-skip-whitespace)
16086 (beginning-of-line)
16087 (insert ":" drawer ":\n")
16088 (forward-line -1)
16089 (indent-for-tab-command)
16090 ;; Move point to the beginning of the first blank line
16091 ;; after the last non-blank line in region. Insert
16092 ;; drawer's closing, then indent it.
16093 (goto-char rend)
16094 (skip-chars-backward " \r\t\n")
16095 (insert "\n:END:")
16096 (deactivate-mark t)
16097 (indent-for-tab-command)
16098 (unless (eolp) (insert "\n")))
16099 ;; Clear marker, whatever the outcome of insertion is.
16100 (set-marker rend nil)))))))
16102 (defvar org-property-set-functions-alist nil
16103 "Property set function alist.
16104 Each entry should have the following format:
16106 (PROPERTY . READ-FUNCTION)
16108 The read function will be called with the same argument as
16109 `org-completing-read'.")
16111 (defun org-set-property-function (property)
16112 "Get the function that should be used to set PROPERTY.
16113 This is computed according to `org-property-set-functions-alist'."
16114 (or (cdr (assoc property org-property-set-functions-alist))
16115 'org-completing-read))
16117 (defun org-read-property-value (property)
16118 "Read PROPERTY value from user."
16119 (let* ((completion-ignore-case t)
16120 (allowed (org-property-get-allowed-values nil property 'table))
16121 (cur (org-entry-get nil property))
16122 (prompt (concat property " value"
16123 (if (and cur (string-match "\\S-" cur))
16124 (concat " [" cur "]") "") ": "))
16125 (set-function (org-set-property-function property))
16126 (val (if allowed
16127 (funcall set-function prompt allowed nil
16128 (not (get-text-property 0 'org-unrestricted
16129 (caar allowed))))
16130 (let (org-completion-use-ido org-completion-use-iswitchb)
16131 (funcall set-function prompt
16132 (mapcar 'list (org-property-values property))
16133 nil nil "" nil cur)))))
16134 (org-trim val)))
16136 (defvar org-last-set-property nil)
16137 (defvar org-last-set-property-value nil)
16138 (defun org-read-property-name ()
16139 "Read a property name."
16140 (let* ((completion-ignore-case t)
16141 (keys (org-buffer-property-keys nil t t))
16142 (default-prop (or (save-excursion
16143 (save-match-data
16144 (beginning-of-line)
16145 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
16146 (null (string= (match-string 1) "END"))
16147 (match-string 1))))
16148 org-last-set-property))
16149 (property (org-icompleting-read
16150 (concat "Property"
16151 (if default-prop (concat " [" default-prop "]") "")
16152 ": ")
16153 (mapcar 'list keys)
16154 nil nil nil nil
16155 default-prop)))
16156 (if (member property keys)
16157 property
16158 (or (cdr (assoc (downcase property)
16159 (mapcar (lambda (x) (cons (downcase x) x))
16160 keys)))
16161 property))))
16163 (defun org-set-property-and-value (use-last)
16164 "Allow to set [PROPERTY]: [value] direction from prompt.
16165 When use-default, don't even ask, just use the last
16166 \"[PROPERTY]: [value]\" string from the history."
16167 (interactive "P")
16168 (let* ((completion-ignore-case t)
16169 (pv (or (and use-last org-last-set-property-value)
16170 (org-completing-read
16171 "Enter a \"[Property]: [value]\" pair: "
16172 nil nil nil nil nil
16173 org-last-set-property-value)))
16174 prop val)
16175 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16176 (setq prop (match-string 1 pv)
16177 val (match-string 2 pv))
16178 (org-set-property prop val))))
16180 (defun org-set-property (property value)
16181 "In the current entry, set PROPERTY to VALUE.
16182 When called interactively, this will prompt for a property name, offering
16183 completion on existing and default properties. And then it will prompt
16184 for a value, offering completion either on allowed values (via an inherited
16185 xxx_ALL property) or on existing values in other instances of this property
16186 in the current file."
16187 (interactive (list nil nil))
16188 (let* ((property (or property (org-read-property-name)))
16189 (value (or value (org-read-property-value property)))
16190 (fn (cdr (assoc property org-properties-postprocess-alist))))
16191 (setq org-last-set-property property)
16192 (setq org-last-set-property-value (concat property ": " value))
16193 ;; Possibly postprocess the inserted value:
16194 (when fn (setq value (funcall fn value)))
16195 (unless (equal (org-entry-get nil property) value)
16196 (org-entry-put nil property value))))
16198 (defun org-delete-property (property)
16199 "In the current entry, delete PROPERTY."
16200 (interactive
16201 (let* ((completion-ignore-case t)
16202 (cat (org-entry-get (point) "CATEGORY"))
16203 (props0 (org-entry-properties nil 'standard))
16204 (props (if cat props0
16205 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16206 (prop (if (< 1 (length props))
16207 (org-icompleting-read "Property: " props nil t)
16208 (caar props))))
16209 (list prop)))
16210 (if (not property)
16211 (message "No property to delete in this entry")
16212 (org-entry-delete nil property)
16213 (message "Property \"%s\" deleted" property)))
16215 (defun org-delete-property-globally (property)
16216 "Remove PROPERTY globally, from all entries."
16217 (interactive
16218 (let* ((completion-ignore-case t)
16219 (prop (org-icompleting-read
16220 "Globally remove property: "
16221 (mapcar 'list (org-buffer-property-keys)))))
16222 (list prop)))
16223 (save-excursion
16224 (save-restriction
16225 (widen)
16226 (goto-char (point-min))
16227 (let ((cnt 0))
16228 (while (re-search-forward
16229 (org-re-property property)
16230 nil t)
16231 (setq cnt (1+ cnt))
16232 (delete-region (match-beginning 0) (1+ (point-at-eol))))
16233 (message "Property \"%s\" removed from %d entries" property cnt)))))
16235 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16237 (defun org-compute-property-at-point ()
16238 "Compute the property at point.
16239 This looks for an enclosing column format, extracts the operator and
16240 then applies it to the property in the column format's scope."
16241 (interactive)
16242 (unless (org-at-property-p)
16243 (user-error "Not at a property"))
16244 (let ((prop (org-match-string-no-properties 2)))
16245 (org-columns-get-format-and-top-level)
16246 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16247 (user-error "No operator defined for property %s" prop))
16248 (org-columns-compute prop)))
16250 (defvar org-property-allowed-value-functions nil
16251 "Hook for functions supplying allowed values for a specific property.
16252 The functions must take a single argument, the name of the property, and
16253 return a flat list of allowed values. If \":ETC\" is one of
16254 the values, this means that these values are intended as defaults for
16255 completion, but that other values should be allowed too.
16256 The functions must return nil if they are not responsible for this
16257 property.")
16259 (defun org-property-get-allowed-values (pom property &optional table)
16260 "Get allowed values for the property PROPERTY.
16261 When TABLE is non-nil, return an alist that can directly be used for
16262 completion."
16263 (let (vals)
16264 (cond
16265 ((equal property "TODO")
16266 (setq vals (org-with-point-at pom
16267 (append org-todo-keywords-1 '("")))))
16268 ((equal property "PRIORITY")
16269 (let ((n org-lowest-priority))
16270 (while (>= n org-highest-priority)
16271 (push (char-to-string n) vals)
16272 (setq n (1- n)))))
16273 ((member property org-special-properties))
16274 ((setq vals (run-hook-with-args-until-success
16275 'org-property-allowed-value-functions property)))
16277 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16278 (when (and vals (string-match "\\S-" vals))
16279 (setq vals (car (read-from-string (concat "(" vals ")"))))
16280 (setq vals (mapcar (lambda (x)
16281 (cond ((stringp x) x)
16282 ((numberp x) (number-to-string x))
16283 ((symbolp x) (symbol-name x))
16284 (t "???")))
16285 vals)))))
16286 (when (member ":ETC" vals)
16287 (setq vals (remove ":ETC" vals))
16288 (org-add-props (car vals) '(org-unrestricted t)))
16289 (if table (mapcar 'list vals) vals)))
16291 (defun org-property-previous-allowed-value (&optional previous)
16292 "Switch to the next allowed value for this property."
16293 (interactive)
16294 (org-property-next-allowed-value t))
16296 (defun org-property-next-allowed-value (&optional previous)
16297 "Switch to the next allowed value for this property."
16298 (interactive)
16299 (unless (org-at-property-p)
16300 (user-error "Not at a property"))
16301 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16302 (key (match-string 2))
16303 (value (match-string 3))
16304 (allowed (or (org-property-get-allowed-values (point) key)
16305 (and (member value '("[ ]" "[-]" "[X]"))
16306 '("[ ]" "[X]"))))
16307 (heading (save-match-data (nth 4 (org-heading-components))))
16308 nval)
16309 (unless allowed
16310 (user-error "Allowed values for this property have not been defined"))
16311 (if previous (setq allowed (reverse allowed)))
16312 (if (member value allowed)
16313 (setq nval (car (cdr (member value allowed)))))
16314 (setq nval (or nval (car allowed)))
16315 (if (equal nval value)
16316 (user-error "Only one allowed value for this property"))
16317 (org-at-property-p)
16318 (replace-match (concat " :" key ": " nval) t t)
16319 (org-indent-line)
16320 (beginning-of-line 1)
16321 (skip-chars-forward " \t")
16322 (when (equal prop org-effort-property)
16323 (org-refresh-property
16324 '((effort . identity)
16325 (effort-minutes . org-duration-string-to-minutes))
16326 nval)
16327 (when (string= org-clock-current-task heading)
16328 (setq org-clock-effort nval)
16329 (org-clock-update-mode-line)))
16330 (run-hook-with-args 'org-property-changed-functions key nval)))
16332 (defun org-find-olp (path &optional this-buffer)
16333 "Return a marker pointing to the entry at outline path OLP.
16334 If anything goes wrong, throw an error.
16335 You can wrap this call to catch the error like this:
16337 (condition-case msg
16338 (org-mobile-locate-entry (match-string 4))
16339 (error (nth 1 msg)))
16341 The return value will then be either a string with the error message,
16342 or a marker if everything is OK.
16344 If THIS-BUFFER is set, the outline path does not contain a file,
16345 only headings."
16346 (let* ((file (if this-buffer buffer-file-name (pop path)))
16347 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16348 (level 1)
16349 (lmin 1)
16350 (lmax 1)
16351 limit re end found pos heading cnt flevel)
16352 (unless buffer (error "File not found :%s" file))
16353 (with-current-buffer buffer
16354 (save-excursion
16355 (save-restriction
16356 (widen)
16357 (setq limit (point-max))
16358 (goto-char (point-min))
16359 (while (setq heading (pop path))
16360 (setq re (format org-complex-heading-regexp-format
16361 (regexp-quote heading)))
16362 (setq cnt 0 pos (point))
16363 (while (re-search-forward re end t)
16364 (setq level (- (match-end 1) (match-beginning 1)))
16365 (if (and (>= level lmin) (<= level lmax))
16366 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16367 (when (= cnt 0) (error "Heading not found on level %d: %s"
16368 lmax heading))
16369 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16370 lmax heading))
16371 (goto-char found)
16372 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16373 (setq end (save-excursion (org-end-of-subtree t t))))
16374 (when (org-at-heading-p)
16375 (point-marker)))))))
16377 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16378 "Find node HEADING in BUFFER.
16379 Return a marker to the heading if it was found, or nil if not.
16380 If POS-ONLY is set, return just the position instead of a marker.
16382 The heading text must match exact, but it may have a TODO keyword,
16383 a priority cookie and tags in the standard locations."
16384 (with-current-buffer (or buffer (current-buffer))
16385 (save-excursion
16386 (save-restriction
16387 (widen)
16388 (goto-char (point-min))
16389 (let (case-fold-search)
16390 (if (re-search-forward
16391 (format org-complex-heading-regexp-format
16392 (regexp-quote heading)) nil t)
16393 (if pos-only
16394 (match-beginning 0)
16395 (move-marker (make-marker) (match-beginning 0)))))))))
16397 (defun org-find-exact-heading-in-directory (heading &optional dir)
16398 "Find Org node headline HEADING in all .org files in directory DIR.
16399 When the target headline is found, return a marker to this location."
16400 (let ((files (directory-files (or dir default-directory)
16401 t "\\`[^.#].*\\.org\\'"))
16402 file visiting m buffer)
16403 (catch 'found
16404 (while (setq file (pop files))
16405 (message "trying %s" file)
16406 (setq visiting (org-find-base-buffer-visiting file))
16407 (setq buffer (or visiting (find-file-noselect file)))
16408 (setq m (org-find-exact-headline-in-buffer
16409 heading buffer))
16410 (when (and (not m) (not visiting)) (kill-buffer buffer))
16411 (and m (throw 'found m))))))
16413 (defun org-find-entry-with-id (ident)
16414 "Locate the entry that contains the ID property with exact value IDENT.
16415 IDENT can be a string, a symbol or a number, this function will search for
16416 the string representation of it.
16417 Return the position where this entry starts, or nil if there is no such entry."
16418 (interactive "sID: ")
16419 (let ((id (cond
16420 ((stringp ident) ident)
16421 ((symbol-name ident) (symbol-name ident))
16422 ((numberp ident) (number-to-string ident))
16423 (t (error "IDENT %s must be a string, symbol or number" ident))))
16424 (case-fold-search nil))
16425 (save-excursion
16426 (save-restriction
16427 (widen)
16428 (goto-char (point-min))
16429 (when (re-search-forward
16430 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16431 nil t)
16432 (org-back-to-heading t)
16433 (point))))))
16435 ;;;; Timestamps
16437 (defvar org-last-changed-timestamp nil)
16438 (defvar org-last-inserted-timestamp nil
16439 "The last time stamp inserted with `org-insert-time-stamp'.")
16440 (defvar org-ts-what) ; dynamically scoped parameter
16442 (defun org-time-stamp (arg &optional inactive)
16443 "Prompt for a date/time and insert a time stamp.
16445 If the user specifies a time like HH:MM or if this command is
16446 called with at least one prefix argument, the time stamp contains
16447 the date and the time. Otherwise, only the date is included.
16449 All parts of a date not specified by the user are filled in from
16450 the timestamp at point, if any, or the current date/time
16451 otherwise.
16453 If there is already a timestamp at the cursor, it is replaced.
16455 With two universal prefix arguments, insert an active timestamp
16456 with the current time without prompting the user.
16458 When called from lisp, the timestamp is inactive if INACTIVE is
16459 non-nil."
16460 (interactive "P")
16461 (let* ((ts
16462 (cond ((org-at-date-range-p t)
16463 (save-excursion
16464 (goto-char (match-beginning 0))
16465 (looking-at (if inactive org-ts-regexp-both org-ts-regexp)))
16466 (match-string 0))
16467 ((org-at-timestamp-p t) (match-string 0))))
16468 ;; Default time is either the timestamp at point or today.
16469 ;; When entering a range, only the range start is considered.
16470 (default-time (if (not ts) (current-time)
16471 (apply #'encode-time (org-parse-time-string ts))))
16472 (default-input (and ts (org-get-compact-tod ts)))
16473 (repeater (and ts
16474 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16475 (match-string 0 ts)))
16476 org-time-was-given
16477 org-end-time-was-given
16478 (time
16479 (and (if (equal arg '(16)) (current-time)
16480 ;; Preserve `this-command' and `last-command'.
16481 (let ((this-command this-command)
16482 (last-command last-command))
16483 (org-read-date
16484 arg 'totime nil nil default-time default-input
16485 inactive))))))
16486 (cond
16487 ((and ts
16488 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16489 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16490 (insert "--")
16491 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16493 ;; Make sure we're on a timestamp. When in the middle of a date
16494 ;; range, move arbitrarily to range end.
16495 (unless (org-at-timestamp-p t)
16496 (skip-chars-forward "-")
16497 (org-at-timestamp-p t))
16498 (replace-match "")
16499 (setq org-last-changed-timestamp
16500 (org-insert-time-stamp
16501 time (or org-time-was-given arg)
16502 inactive nil nil (list org-end-time-was-given)))
16503 (when repeater
16504 (backward-char)
16505 (insert " " repeater)
16506 (setq org-last-changed-timestamp
16507 (concat (substring org-last-inserted-timestamp 0 -1)
16508 " " repeater ">")))
16509 (message "Timestamp updated"))
16510 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16511 (t (org-insert-time-stamp
16512 time (or org-time-was-given arg) inactive nil nil
16513 (list org-end-time-was-given))))))
16515 ;; FIXME: can we use this for something else, like computing time differences?
16516 (defun org-get-compact-tod (s)
16517 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16518 (let* ((t1 (match-string 1 s))
16519 (h1 (string-to-number (match-string 2 s)))
16520 (m1 (string-to-number (match-string 3 s)))
16521 (t2 (and (match-end 4) (match-string 5 s)))
16522 (h2 (and t2 (string-to-number (match-string 6 s))))
16523 (m2 (and t2 (string-to-number (match-string 7 s))))
16524 dh dm)
16525 (if (not t2)
16527 (setq dh (- h2 h1) dm (- m2 m1))
16528 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16529 (concat t1 "+" (number-to-string dh)
16530 (and (/= 0 dm) (format ":%02d" dm)))))))
16532 (defun org-time-stamp-inactive (&optional arg)
16533 "Insert an inactive time stamp.
16534 An inactive time stamp is enclosed in square brackets instead of angle
16535 brackets. It is inactive in the sense that it does not trigger agenda entries,
16536 does not link to the calendar and cannot be changed with the S-cursor keys.
16537 So these are more for recording a certain time/date."
16538 (interactive "P")
16539 (org-time-stamp arg 'inactive))
16541 (defvar org-date-ovl (make-overlay 1 1))
16542 (overlay-put org-date-ovl 'face 'org-date-selected)
16543 (org-detach-overlay org-date-ovl)
16545 (defvar org-ans1) ; dynamically scoped parameter
16546 (defvar org-ans2) ; dynamically scoped parameter
16548 (defvar org-plain-time-of-day-regexp) ; defined below
16550 (defvar org-overriding-default-time nil) ; dynamically scoped
16551 (defvar org-read-date-overlay nil)
16552 (defvar org-dcst nil) ; dynamically scoped
16553 (defvar org-read-date-history nil)
16554 (defvar org-read-date-final-answer nil)
16555 (defvar org-read-date-analyze-futurep nil)
16556 (defvar org-read-date-analyze-forced-year nil)
16557 (defvar org-read-date-inactive)
16559 (defvar org-read-date-minibuffer-local-map
16560 (let* ((map (make-sparse-keymap)))
16561 (set-keymap-parent map minibuffer-local-map)
16562 (org-defkey map (kbd ".")
16563 (lambda () (interactive)
16564 ;; Are we at the beginning of the prompt?
16565 (if (looking-back "^[^:]+: ")
16566 (org-eval-in-calendar '(calendar-goto-today))
16567 (insert "."))))
16568 (org-defkey map (kbd "C-.")
16569 (lambda () (interactive)
16570 (org-eval-in-calendar '(calendar-goto-today))))
16571 (org-defkey map [(meta shift left)]
16572 (lambda () (interactive)
16573 (org-eval-in-calendar '(calendar-backward-month 1))))
16574 (org-defkey map [(meta shift right)]
16575 (lambda () (interactive)
16576 (org-eval-in-calendar '(calendar-forward-month 1))))
16577 (org-defkey map [(meta shift up)]
16578 (lambda () (interactive)
16579 (org-eval-in-calendar '(calendar-backward-year 1))))
16580 (org-defkey map [(meta shift down)]
16581 (lambda () (interactive)
16582 (org-eval-in-calendar '(calendar-forward-year 1))))
16583 (org-defkey map [?\e (shift left)]
16584 (lambda () (interactive)
16585 (org-eval-in-calendar '(calendar-backward-month 1))))
16586 (org-defkey map [?\e (shift right)]
16587 (lambda () (interactive)
16588 (org-eval-in-calendar '(calendar-forward-month 1))))
16589 (org-defkey map [?\e (shift up)]
16590 (lambda () (interactive)
16591 (org-eval-in-calendar '(calendar-backward-year 1))))
16592 (org-defkey map [?\e (shift down)]
16593 (lambda () (interactive)
16594 (org-eval-in-calendar '(calendar-forward-year 1))))
16595 (org-defkey map [(shift up)]
16596 (lambda () (interactive)
16597 (org-eval-in-calendar '(calendar-backward-week 1))))
16598 (org-defkey map [(shift down)]
16599 (lambda () (interactive)
16600 (org-eval-in-calendar '(calendar-forward-week 1))))
16601 (org-defkey map [(shift left)]
16602 (lambda () (interactive)
16603 (org-eval-in-calendar '(calendar-backward-day 1))))
16604 (org-defkey map [(shift right)]
16605 (lambda () (interactive)
16606 (org-eval-in-calendar '(calendar-forward-day 1))))
16607 (org-defkey map "!"
16608 (lambda () (interactive)
16609 (org-eval-in-calendar '(diary-view-entries))
16610 (message "")))
16611 (org-defkey map ">"
16612 (lambda () (interactive)
16613 (org-eval-in-calendar '(calendar-scroll-left 1))))
16614 (org-defkey map "<"
16615 (lambda () (interactive)
16616 (org-eval-in-calendar '(calendar-scroll-right 1))))
16617 (org-defkey map "\C-v"
16618 (lambda () (interactive)
16619 (org-eval-in-calendar
16620 '(calendar-scroll-left-three-months 1))))
16621 (org-defkey map "\M-v"
16622 (lambda () (interactive)
16623 (org-eval-in-calendar
16624 '(calendar-scroll-right-three-months 1))))
16625 map)
16626 "Keymap for minibuffer commands when using `org-read-date'.")
16628 (defvar org-def)
16629 (defvar org-defdecode)
16630 (defvar org-with-time)
16632 (defun org-read-date (&optional org-with-time to-time from-string prompt
16633 default-time default-input inactive)
16634 "Read a date, possibly a time, and make things smooth for the user.
16635 The prompt will suggest to enter an ISO date, but you can also enter anything
16636 which will at least partially be understood by `parse-time-string'.
16637 Unrecognized parts of the date will default to the current day, month, year,
16638 hour and minute. If this command is called to replace a timestamp at point,
16639 or to enter the second timestamp of a range, the default time is taken
16640 from the existing stamp. Furthermore, the command prefers the future,
16641 so if you are giving a date where the year is not given, and the day-month
16642 combination is already past in the current year, it will assume you
16643 mean next year. For details, see the manual. A few examples:
16645 3-2-5 --> 2003-02-05
16646 feb 15 --> currentyear-02-15
16647 2/15 --> currentyear-02-15
16648 sep 12 9 --> 2009-09-12
16649 12:45 --> today 12:45
16650 22 sept 0:34 --> currentyear-09-22 0:34
16651 12 --> currentyear-currentmonth-12
16652 Fri --> nearest Friday after today
16653 -Tue --> last Tuesday
16654 etc.
16656 Furthermore you can specify a relative date by giving, as the *first* thing
16657 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16658 change in days weeks, months, years.
16659 With a single plus or minus, the date is relative to today. With a double
16660 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16661 +4d --> four days from today
16662 +4 --> same as above
16663 +2w --> two weeks from today
16664 ++5 --> five days from default date
16666 The function understands only English month and weekday abbreviations.
16668 While prompting, a calendar is popped up - you can also select the
16669 date with the mouse (button 1). The calendar shows a period of three
16670 months. To scroll it to other months, use the keys `>' and `<'.
16671 If you don't like the calendar, turn it off with
16672 \(setq org-read-date-popup-calendar nil)
16674 With optional argument TO-TIME, the date will immediately be converted
16675 to an internal time.
16676 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16677 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16678 still enter a time, and this function will inform the calling routine
16679 about this change. The calling routine may then choose to change the
16680 format used to insert the time stamp into the buffer to include the time.
16681 With optional argument FROM-STRING, read from this string instead from
16682 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16683 the time/date that is used for everything that is not specified by the
16684 user."
16685 (require 'parse-time)
16686 (let* ((org-time-stamp-rounding-minutes
16687 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16688 (org-dcst org-display-custom-times)
16689 (ct (org-current-time))
16690 (org-def (or org-overriding-default-time default-time ct))
16691 (org-defdecode (decode-time org-def))
16692 (dummy (progn
16693 (when (< (nth 2 org-defdecode) org-extend-today-until)
16694 (setcar (nthcdr 2 org-defdecode) -1)
16695 (setcar (nthcdr 1 org-defdecode) 59)
16696 (setq org-def (apply 'encode-time org-defdecode)
16697 org-defdecode (decode-time org-def)))))
16698 (cur-frame (selected-frame))
16699 (mouse-autoselect-window nil) ; Don't let the mouse jump
16700 (calendar-frame-setup nil)
16701 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16702 (calendar-move-hook nil)
16703 (calendar-view-diary-initially-flag nil)
16704 (calendar-view-holidays-initially-flag nil)
16705 (timestr (format-time-string
16706 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16707 (prompt (concat (if prompt (concat prompt " ") "")
16708 (format "Date+time [%s]: " timestr)))
16709 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16711 (cond
16712 (from-string (setq ans from-string))
16713 (org-read-date-popup-calendar
16714 (save-excursion
16715 (save-window-excursion
16716 (calendar)
16717 (when (eq calendar-setup 'calendar-only)
16718 (setq cal-frame
16719 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16720 (select-frame cal-frame))
16721 (org-eval-in-calendar '(setq cursor-type nil) t)
16722 (unwind-protect
16723 (progn
16724 (calendar-forward-day (- (time-to-days org-def)
16725 (calendar-absolute-from-gregorian
16726 (calendar-current-date))))
16727 (org-eval-in-calendar nil t)
16728 (let* ((old-map (current-local-map))
16729 (map (copy-keymap calendar-mode-map))
16730 (minibuffer-local-map
16731 (copy-keymap org-read-date-minibuffer-local-map)))
16732 (org-defkey map (kbd "RET") 'org-calendar-select)
16733 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16734 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16735 (unwind-protect
16736 (progn
16737 (use-local-map map)
16738 (setq org-read-date-inactive inactive)
16739 (add-hook 'post-command-hook 'org-read-date-display)
16740 (setq org-ans0 (read-string prompt default-input
16741 'org-read-date-history nil))
16742 ;; org-ans0: from prompt
16743 ;; org-ans1: from mouse click
16744 ;; org-ans2: from calendar motion
16745 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16746 (remove-hook 'post-command-hook 'org-read-date-display)
16747 (use-local-map old-map)
16748 (when org-read-date-overlay
16749 (delete-overlay org-read-date-overlay)
16750 (setq org-read-date-overlay nil)))))
16751 (bury-buffer "*Calendar*")
16752 (when cal-frame
16753 (delete-frame cal-frame)
16754 (select-frame-set-input-focus cur-frame))))))
16756 (t ; Naked prompt only
16757 (unwind-protect
16758 (setq ans (read-string prompt default-input
16759 'org-read-date-history timestr))
16760 (when org-read-date-overlay
16761 (delete-overlay org-read-date-overlay)
16762 (setq org-read-date-overlay nil)))))
16764 (setq final (org-read-date-analyze ans org-def org-defdecode))
16766 (when org-read-date-analyze-forced-year
16767 (message "Year was forced into %s"
16768 (if org-read-date-force-compatible-dates
16769 "compatible range (1970-2037)"
16770 "range representable on this machine"))
16771 (ding))
16773 ;; One round trip to get rid of 34th of August and stuff like that....
16774 (setq final (decode-time (apply 'encode-time final)))
16776 (setq org-read-date-final-answer ans)
16778 (if to-time
16779 (apply 'encode-time final)
16780 (if (and (boundp 'org-time-was-given) org-time-was-given)
16781 (format "%04d-%02d-%02d %02d:%02d"
16782 (nth 5 final) (nth 4 final) (nth 3 final)
16783 (nth 2 final) (nth 1 final))
16784 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16786 (defun org-read-date-display ()
16787 "Display the current date prompt interpretation in the minibuffer."
16788 (when org-read-date-display-live
16789 (when org-read-date-overlay
16790 (delete-overlay org-read-date-overlay))
16791 (when (minibufferp (current-buffer))
16792 (save-excursion
16793 (end-of-line 1)
16794 (while (not (equal (buffer-substring
16795 (max (point-min) (- (point) 4)) (point))
16796 " "))
16797 (insert " ")))
16798 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16799 " " (or org-ans1 org-ans2)))
16800 (org-end-time-was-given nil)
16801 (f (org-read-date-analyze ans org-def org-defdecode))
16802 (fmts (if org-dcst
16803 org-time-stamp-custom-formats
16804 org-time-stamp-formats))
16805 (fmt (if (or org-with-time
16806 (and (boundp 'org-time-was-given) org-time-was-given))
16807 (cdr fmts)
16808 (car fmts)))
16809 (txt (format-time-string fmt (apply 'encode-time f)))
16810 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16811 (txt (concat "=> " txt)))
16812 (when (and org-end-time-was-given
16813 (string-match org-plain-time-of-day-regexp txt))
16814 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16815 org-end-time-was-given
16816 (substring txt (match-end 0)))))
16817 (when org-read-date-analyze-futurep
16818 (setq txt (concat txt " (=>F)")))
16819 (setq org-read-date-overlay
16820 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16821 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16823 (defun org-read-date-analyze (ans org-def org-defdecode)
16824 "Analyze the combined answer of the date prompt."
16825 ;; FIXME: cleanup and comment
16826 (let ((nowdecode (decode-time (current-time)))
16827 delta deltan deltaw deltadef year month day
16828 hour minute second wday pm h2 m2 tl wday1
16829 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16830 (setq org-read-date-analyze-futurep nil
16831 org-read-date-analyze-forced-year nil)
16832 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16833 (setq ans "+0"))
16835 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16836 (setq ans (replace-match "" t t ans)
16837 deltan (car delta)
16838 deltaw (nth 1 delta)
16839 deltadef (nth 2 delta)))
16841 ;; Check if there is an iso week date in there. If yes, store the
16842 ;; info and postpone interpreting it until the rest of the parsing
16843 ;; is done.
16844 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16845 (setq iso-year (if (match-end 1)
16846 (org-small-year-to-year
16847 (string-to-number (match-string 1 ans))))
16848 iso-weekday (if (match-end 3)
16849 (string-to-number (match-string 3 ans)))
16850 iso-week (string-to-number (match-string 2 ans)))
16851 (setq ans (replace-match "" t t ans)))
16853 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16854 (when (string-match
16855 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16856 (setq year (if (match-end 2)
16857 (string-to-number (match-string 2 ans))
16858 (progn (setq kill-year t)
16859 (string-to-number (format-time-string "%Y"))))
16860 month (string-to-number (match-string 3 ans))
16861 day (string-to-number (match-string 4 ans)))
16862 (if (< year 100) (setq year (+ 2000 year)))
16863 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16864 t nil ans)))
16866 ;; Help matching dotted european dates
16867 (when (string-match
16868 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16869 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16870 (setq kill-year t)
16871 (string-to-number (format-time-string "%Y")))
16872 day (string-to-number (match-string 1 ans))
16873 month (string-to-number (match-string 2 ans))
16874 ans (replace-match (format "%04d-%02d-%02d" year month day)
16875 t nil ans)))
16877 ;; Help matching american dates, like 5/30 or 5/30/7
16878 (when (string-match
16879 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16880 (setq year (if (match-end 4)
16881 (string-to-number (match-string 4 ans))
16882 (progn (setq kill-year t)
16883 (string-to-number (format-time-string "%Y"))))
16884 month (string-to-number (match-string 1 ans))
16885 day (string-to-number (match-string 2 ans)))
16886 (if (< year 100) (setq year (+ 2000 year)))
16887 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16888 t nil ans)))
16889 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16890 ;; If there is a time with am/pm, and *no* time without it, we convert
16891 ;; so that matching will be successful.
16892 (loop for i from 1 to 2 do ; twice, for end time as well
16893 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16894 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16895 (setq hour (string-to-number (match-string 1 ans))
16896 minute (if (match-end 3)
16897 (string-to-number (match-string 3 ans))
16899 pm (equal ?p
16900 (string-to-char (downcase (match-string 4 ans)))))
16901 (if (and (= hour 12) (not pm))
16902 (setq hour 0)
16903 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16904 (setq ans (replace-match (format "%02d:%02d" hour minute)
16905 t t ans))))
16907 ;; Check if a time range is given as a duration
16908 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16909 (setq hour (string-to-number (match-string 1 ans))
16910 h2 (+ hour (string-to-number (match-string 3 ans)))
16911 minute (string-to-number (match-string 2 ans))
16912 m2 (+ minute (if (match-end 5) (string-to-number
16913 (match-string 5 ans))0)))
16914 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16915 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16916 t t ans)))
16918 ;; Check if there is a time range
16919 (when (boundp 'org-end-time-was-given)
16920 (setq org-time-was-given nil)
16921 (when (and (string-match org-plain-time-of-day-regexp ans)
16922 (match-end 8))
16923 (setq org-end-time-was-given (match-string 8 ans))
16924 (setq ans (concat (substring ans 0 (match-beginning 7))
16925 (substring ans (match-end 7))))))
16927 (setq tl (parse-time-string ans)
16928 day (or (nth 3 tl) (nth 3 org-defdecode))
16929 month
16930 (cond ((nth 4 tl))
16931 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
16932 ;; Day was specified. Make sure DAY+MONTH
16933 ;; combination happens in the future.
16934 ((nth 3 tl)
16935 (setq futurep t)
16936 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
16937 (nth 4 nowdecode)))
16938 (t (nth 4 org-defdecode)))
16939 year
16940 (cond ((and (not kill-year) (nth 5 tl)))
16941 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
16942 ;; Month was guessed in the future and is at least
16943 ;; equal to NOWDECODE's. Fix year accordingly.
16944 (futurep
16945 (if (or (> month (nth 4 nowdecode))
16946 (>= day (nth 3 nowdecode)))
16947 (nth 5 nowdecode)
16948 (1+ (nth 5 nowdecode))))
16949 ;; Month was specified. Make sure MONTH+YEAR
16950 ;; combination happens in the future.
16951 ((nth 4 tl)
16952 (setq futurep t)
16953 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
16954 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
16955 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
16956 (t (nth 5 nowdecode))))
16957 (t (nth 5 org-defdecode)))
16958 hour (or (nth 2 tl) (nth 2 org-defdecode))
16959 minute (or (nth 1 tl) (nth 1 org-defdecode))
16960 second (or (nth 0 tl) 0)
16961 wday (nth 6 tl))
16963 (when (and (eq org-read-date-prefer-future 'time)
16964 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16965 (equal day (nth 3 nowdecode))
16966 (equal month (nth 4 nowdecode))
16967 (equal year (nth 5 nowdecode))
16968 (nth 2 tl)
16969 (or (< (nth 2 tl) (nth 2 nowdecode))
16970 (and (= (nth 2 tl) (nth 2 nowdecode))
16971 (nth 1 tl)
16972 (< (nth 1 tl) (nth 1 nowdecode)))))
16973 (setq day (1+ day)
16974 futurep t))
16976 ;; Special date definitions below
16977 (cond
16978 (iso-week
16979 ;; There was an iso week
16980 (require 'cal-iso)
16981 (setq futurep nil)
16982 (setq year (or iso-year year)
16983 day (or iso-weekday wday 1)
16984 wday nil ; to make sure that the trigger below does not match
16985 iso-date (calendar-gregorian-from-absolute
16986 (calendar-iso-to-absolute
16987 (list iso-week day year))))
16988 ; FIXME: Should we also push ISO weeks into the future?
16989 ; (when (and org-read-date-prefer-future
16990 ; (not iso-year)
16991 ; (< (calendar-absolute-from-gregorian iso-date)
16992 ; (time-to-days (current-time))))
16993 ; (setq year (1+ year)
16994 ; iso-date (calendar-gregorian-from-absolute
16995 ; (calendar-iso-to-absolute
16996 ; (list iso-week day year)))))
16997 (setq month (car iso-date)
16998 year (nth 2 iso-date)
16999 day (nth 1 iso-date)))
17000 (deltan
17001 (setq futurep nil)
17002 (unless deltadef
17003 (let ((now (decode-time (current-time))))
17004 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17005 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17006 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17007 ((equal deltaw "m") (setq month (+ month deltan)))
17008 ((equal deltaw "y") (setq year (+ year deltan)))))
17009 ((and wday (not (nth 3 tl)))
17010 ;; Weekday was given, but no day, so pick that day in the week
17011 ;; on or after the derived date.
17012 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17013 (unless (equal wday wday1)
17014 (setq day (+ day (% (- wday wday1 -7) 7))))))
17015 (if (and (boundp 'org-time-was-given)
17016 (nth 2 tl))
17017 (setq org-time-was-given t))
17018 (if (< year 100) (setq year (+ 2000 year)))
17019 ;; Check of the date is representable
17020 (if org-read-date-force-compatible-dates
17021 (progn
17022 (if (< year 1970)
17023 (setq year 1970 org-read-date-analyze-forced-year t))
17024 (if (> year 2037)
17025 (setq year 2037 org-read-date-analyze-forced-year t)))
17026 (condition-case nil
17027 (ignore (encode-time second minute hour day month year))
17028 (error
17029 (setq year (nth 5 org-defdecode))
17030 (setq org-read-date-analyze-forced-year t))))
17031 (setq org-read-date-analyze-futurep futurep)
17032 (list second minute hour day month year)))
17034 (defvar parse-time-weekdays)
17035 (defun org-read-date-get-relative (s today default)
17036 "Check string S for special relative date string.
17037 TODAY and DEFAULT are internal times, for today and for a default.
17038 Return shift list (N what def-flag)
17039 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17040 N is the number of WHATs to shift.
17041 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17042 the DEFAULT date rather than TODAY."
17043 (require 'parse-time)
17044 (when (and
17045 (string-match
17046 (concat
17047 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17048 "\\([0-9]+\\)?"
17049 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17050 "\\([ \t]\\|$\\)") s)
17051 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17052 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17053 (string-to-char (substring (match-string 1 s) -1))
17054 ?+))
17055 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17056 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17057 (what (if (match-end 3) (match-string 3 s) "d"))
17058 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17059 (date (if rel default today))
17060 (wday (nth 6 (decode-time date)))
17061 delta)
17062 (if wday1
17063 (progn
17064 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17065 (if (= delta 0) (setq delta 7))
17066 (if (= dir ?-)
17067 (progn
17068 (setq delta (- delta 7))
17069 (if (= delta 0) (setq delta -7))))
17070 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17071 (list delta "d" rel))
17072 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17074 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17075 "Turn a user-specified date into the internal representation.
17076 The internal representation needed by the calendar is (month day year).
17077 This is a wrapper to handle the brain-dead convention in calendar that
17078 user function argument order change dependent on argument order."
17079 (if (boundp 'calendar-date-style)
17080 (cond
17081 ((eq calendar-date-style 'american)
17082 (list arg1 arg2 arg3))
17083 ((eq calendar-date-style 'european)
17084 (list arg2 arg1 arg3))
17085 ((eq calendar-date-style 'iso)
17086 (list arg2 arg3 arg1)))
17087 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17088 (if (org-bound-and-true-p european-calendar-style)
17089 (list arg2 arg1 arg3)
17090 (list arg1 arg2 arg3)))))
17092 (defun org-eval-in-calendar (form &optional keepdate)
17093 "Eval FORM in the calendar window and return to current window.
17094 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17095 otherwise stick to the current value of `org-ans2'."
17096 (let ((sf (selected-frame))
17097 (sw (selected-window)))
17098 (select-window (get-buffer-window "*Calendar*" t))
17099 (eval form)
17100 (when (and (not keepdate) (calendar-cursor-to-date))
17101 (let* ((date (calendar-cursor-to-date))
17102 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17103 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17104 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17105 (select-window sw)
17106 (org-select-frame-set-input-focus sf)))
17108 (defun org-calendar-select ()
17109 "Return to `org-read-date' with the date currently selected.
17110 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17111 (interactive)
17112 (when (calendar-cursor-to-date)
17113 (let* ((date (calendar-cursor-to-date))
17114 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17115 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17116 (if (active-minibuffer-window) (exit-minibuffer))))
17118 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17119 "Insert a date stamp for the date given by the internal TIME.
17120 See `format-time-string' for the format of TIME.
17121 WITH-HM means use the stamp format that includes the time of the day.
17122 INACTIVE means use square brackets instead of angular ones, so that the
17123 stamp will not contribute to the agenda.
17124 PRE and POST are optional strings to be inserted before and after the
17125 stamp.
17126 The command returns the inserted time stamp."
17127 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17128 stamp)
17129 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17130 (insert-before-markers (or pre ""))
17131 (when (listp extra)
17132 (setq extra (car extra))
17133 (if (and (stringp extra)
17134 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17135 (setq extra (format "-%02d:%02d"
17136 (string-to-number (match-string 1 extra))
17137 (string-to-number (match-string 2 extra))))
17138 (setq extra nil)))
17139 (when extra
17140 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17141 (insert-before-markers (setq stamp (format-time-string fmt time)))
17142 (insert-before-markers (or post ""))
17143 (setq org-last-inserted-timestamp stamp)))
17145 (defun org-toggle-time-stamp-overlays ()
17146 "Toggle the use of custom time stamp formats."
17147 (interactive)
17148 (setq org-display-custom-times (not org-display-custom-times))
17149 (unless org-display-custom-times
17150 (let ((p (point-min)) (bmp (buffer-modified-p)))
17151 (while (setq p (next-single-property-change p 'display))
17152 (if (and (get-text-property p 'display)
17153 (eq (get-text-property p 'face) 'org-date))
17154 (remove-text-properties
17155 p (setq p (next-single-property-change p 'display))
17156 '(display t))))
17157 (set-buffer-modified-p bmp)))
17158 (if (featurep 'xemacs)
17159 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17160 (org-restart-font-lock)
17161 (setq org-table-may-need-update t)
17162 (if org-display-custom-times
17163 (message "Time stamps are overlaid with custom format")
17164 (message "Time stamp overlays removed")))
17166 (defun org-display-custom-time (beg end)
17167 "Overlay modified time stamp format over timestamp between BEG and END."
17168 (let* ((ts (buffer-substring beg end))
17169 t1 w1 with-hm tf time str w2 (off 0))
17170 (save-match-data
17171 (setq t1 (org-parse-time-string ts t))
17172 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17173 (setq off (- (match-end 0) (match-beginning 0)))))
17174 (setq end (- end off))
17175 (setq w1 (- end beg)
17176 with-hm (and (nth 1 t1) (nth 2 t1))
17177 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17178 time (org-fix-decoded-time t1)
17179 str (org-add-props
17180 (format-time-string
17181 (substring tf 1 -1) (apply 'encode-time time))
17182 nil 'mouse-face 'highlight)
17183 w2 (length str))
17184 (if (not (= w2 w1))
17185 (add-text-properties (1+ beg) (+ 2 beg)
17186 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17187 (if (featurep 'xemacs)
17188 (progn
17189 (put-text-property beg end 'invisible t)
17190 (put-text-property beg end 'end-glyph (make-glyph str)))
17191 (put-text-property beg end 'display str))))
17193 (defun org-fix-decoded-time (time)
17194 "Set 0 instead of nil for the first 6 elements of time.
17195 Don't touch the rest."
17196 (let ((n 0))
17197 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17199 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17201 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17202 "Difference between TIMESTAMP-STRING and now in days.
17203 If SECONDS is non-nil, return the difference in seconds."
17204 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17205 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17206 (funcall fdiff (current-time)))))
17208 (defun org-deadline-close (timestamp-string &optional ndays)
17209 "Is the time in TIMESTAMP-STRING close to the current date?"
17210 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17211 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17212 (not (org-entry-is-done-p))))
17214 (defun org-get-wdays (ts &optional delay zero-delay)
17215 "Get the deadline lead time appropriate for timestring TS.
17216 When DELAY is non-nil, get the delay time for scheduled items
17217 instead of the deadline lead time. When ZERO-DELAY is non-nil
17218 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17219 don't try to find the delay cookie in the scheduled timestamp."
17220 (let ((tv (if delay org-scheduled-delay-days
17221 org-deadline-warning-days)))
17222 (cond
17223 ((or (and delay (< tv 0))
17224 (and delay zero-delay (<= tv 0))
17225 (and (not delay) (<= tv 0)))
17226 ;; Enforce this value no matter what
17227 (- tv))
17228 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17229 ;; lead time is specified.
17230 (floor (* (string-to-number (match-string 1 ts))
17231 (cdr (assoc (match-string 2 ts)
17232 '(("d" . 1) ("w" . 7)
17233 ("m" . 30.4) ("y" . 365.25)
17234 ("h" . 0.041667)))))))
17235 ;; go for the default.
17236 (t tv))))
17238 (defun org-calendar-select-mouse (ev)
17239 "Return to `org-read-date' with the date currently selected.
17240 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17241 (interactive "e")
17242 (mouse-set-point ev)
17243 (when (calendar-cursor-to-date)
17244 (let* ((date (calendar-cursor-to-date))
17245 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17246 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17247 (if (active-minibuffer-window) (exit-minibuffer))))
17249 (defun org-check-deadlines (ndays)
17250 "Check if there are any deadlines due or past due.
17251 A deadline is considered due if it happens within `org-deadline-warning-days'
17252 days from today's date. If the deadline appears in an entry marked DONE,
17253 it is not shown. The prefix arg NDAYS can be used to test that many
17254 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17255 (interactive "P")
17256 (let* ((org-warn-days
17257 (cond
17258 ((equal ndays '(4)) 100000)
17259 (ndays (prefix-numeric-value ndays))
17260 (t (abs org-deadline-warning-days))))
17261 (case-fold-search nil)
17262 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17263 (callback
17264 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17266 (message "%d deadlines past-due or due within %d days"
17267 (org-occur regexp nil callback)
17268 org-warn-days)))
17270 (defsubst org-re-timestamp (type)
17271 "Return a regexp for timestamp TYPE.
17272 Allowed values for TYPE are:
17274 all: all timestamps
17275 active: only active timestamps (<...>)
17276 inactive: only inactive timestamps ([...])
17277 scheduled: only scheduled timestamps
17278 deadline: only deadline timestamps
17279 closed: only closed time-stamps
17281 When TYPE is nil, fall back on returning a regexp that matches
17282 both scheduled and deadline timestamps."
17283 (case type
17284 (all org-ts-regexp-both)
17285 (active org-ts-regexp)
17286 (inactive org-ts-regexp-inactive)
17287 (scheduled org-scheduled-time-regexp)
17288 (deadline org-deadline-time-regexp)
17289 (closed org-closed-time-regexp)
17290 (otherwise
17291 (concat "\\<"
17292 (regexp-opt (list org-deadline-string org-scheduled-string))
17293 " *<\\([^>]+\\)>"))))
17295 (defun org-check-before-date (date)
17296 "Check if there are deadlines or scheduled entries before DATE."
17297 (interactive (list (org-read-date)))
17298 (let ((case-fold-search nil)
17299 (regexp (org-re-timestamp org-ts-type))
17300 (callback
17301 `(lambda ()
17302 (and ,(if (memq org-ts-type '(active inactive all))
17303 '(eq (org-element-type (org-element-context) 'timestamp))
17304 '(org-at-planning-p))
17305 (time-less-p
17306 (org-time-string-to-time (match-string 1))
17307 (org-time-string-to-time date))))))
17308 (message "%d entries before %s"
17309 (org-occur regexp nil callback) date)))
17311 (defun org-check-after-date (date)
17312 "Check if there are deadlines or scheduled entries after DATE."
17313 (interactive (list (org-read-date)))
17314 (let ((case-fold-search nil)
17315 (regexp (org-re-timestamp org-ts-type))
17316 (callback
17317 `(lambda ()
17318 (and ,(if (memq org-ts-type '(active inactive all))
17319 '(eq (org-element-type (org-element-context) 'timestamp))
17320 '(org-at-planning-p))
17321 (not (time-less-p
17322 (org-time-string-to-time (match-string 1))
17323 (org-time-string-to-time date)))))))
17324 (message "%d entries after %s"
17325 (org-occur regexp nil callback) date)))
17327 (defun org-check-dates-range (start-date end-date)
17328 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17329 (interactive (list (org-read-date nil nil nil "Range starts")
17330 (org-read-date nil nil nil "Range end")))
17331 (let ((case-fold-search nil)
17332 (regexp (org-re-timestamp org-ts-type))
17333 (callback
17334 `(lambda ()
17335 (let ((match (match-string 1)))
17336 (and
17337 ,(if (memq org-ts-type '(active inactive all))
17338 '(eq (org-element-type (org-element-context) 'timestamp))
17339 '(org-at-planning-p))
17340 (not (time-less-p
17341 (org-time-string-to-time match)
17342 (org-time-string-to-time start-date)))
17343 (time-less-p
17344 (org-time-string-to-time match)
17345 (org-time-string-to-time end-date)))))))
17346 (message "%d entries between %s and %s"
17347 (org-occur regexp nil callback) start-date end-date)))
17349 (defun org-evaluate-time-range (&optional to-buffer)
17350 "Evaluate a time range by computing the difference between start and end.
17351 Normally the result is just printed in the echo area, but with prefix arg
17352 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17353 If the time range is actually in a table, the result is inserted into the
17354 next column.
17355 For time difference computation, a year is assumed to be exactly 365
17356 days in order to avoid rounding problems."
17357 (interactive "P")
17359 (org-clock-update-time-maybe)
17360 (save-excursion
17361 (unless (org-at-date-range-p t)
17362 (goto-char (point-at-bol))
17363 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17364 (if (not (org-at-date-range-p t))
17365 (user-error "Not at a time-stamp range, and none found in current line")))
17366 (let* ((ts1 (match-string 1))
17367 (ts2 (match-string 2))
17368 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17369 (match-end (match-end 0))
17370 (time1 (org-time-string-to-time ts1))
17371 (time2 (org-time-string-to-time ts2))
17372 (t1 (org-float-time time1))
17373 (t2 (org-float-time time2))
17374 (diff (abs (- t2 t1)))
17375 (negative (< (- t2 t1) 0))
17376 ;; (ys (floor (* 365 24 60 60)))
17377 (ds (* 24 60 60))
17378 (hs (* 60 60))
17379 (fy "%dy %dd %02d:%02d")
17380 (fy1 "%dy %dd")
17381 (fd "%dd %02d:%02d")
17382 (fd1 "%dd")
17383 (fh "%02d:%02d")
17384 y d h m align)
17385 (if havetime
17386 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17388 d (floor (/ diff ds)) diff (mod diff ds)
17389 h (floor (/ diff hs)) diff (mod diff hs)
17390 m (floor (/ diff 60)))
17391 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17393 d (floor (+ (/ diff ds) 0.5))
17394 h 0 m 0))
17395 (if (not to-buffer)
17396 (message "%s" (org-make-tdiff-string y d h m))
17397 (if (org-at-table-p)
17398 (progn
17399 (goto-char match-end)
17400 (setq align t)
17401 (and (looking-at " *|") (goto-char (match-end 0))))
17402 (goto-char match-end))
17403 (if (looking-at
17404 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17405 (replace-match ""))
17406 (if negative (insert " -"))
17407 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17408 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17409 (insert " " (format fh h m))))
17410 (if align (org-table-align))
17411 (message "Time difference inserted")))))
17413 (defun org-make-tdiff-string (y d h m)
17414 (let ((fmt "")
17415 (l nil))
17416 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17417 l (push y l)))
17418 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17419 l (push d l)))
17420 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17421 l (push h l)))
17422 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17423 l (push m l)))
17424 (apply 'format fmt (nreverse l))))
17426 (defun org-time-string-to-time (s &optional buffer pos)
17427 "Convert a timestamp string into internal time."
17428 (condition-case errdata
17429 (apply 'encode-time (org-parse-time-string s))
17430 (error (error "Bad timestamp `%s'%s\nError was: %s"
17431 s (if (not (and buffer pos))
17433 (format " at %d in buffer `%s'" pos buffer))
17434 (cdr errdata)))))
17436 (defun org-time-string-to-seconds (s)
17437 "Convert a timestamp string to a number of seconds."
17438 (org-float-time (org-time-string-to-time s)))
17440 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17441 "Convert a time stamp to an absolute day number.
17442 If there is a specifier for a cyclic time stamp, get the closest
17443 date to DAYNR.
17444 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17445 The variable `date' is bound by the calendar when this is called."
17446 (cond
17447 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17448 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17449 daynr
17450 (+ daynr 1000)))
17451 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17452 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17453 (time-to-days (current-time))) (match-string 0 s)
17454 prefer show-all))
17455 (t (time-to-days
17456 (condition-case errdata
17457 (apply 'encode-time (org-parse-time-string s))
17458 (error (error "Bad timestamp `%s'%s\nError was: %s"
17459 s (if (not (and buffer pos))
17461 (format " at %d in buffer `%s'" pos buffer))
17462 (cdr errdata))))))))
17464 (defun org-days-to-iso-week (days)
17465 "Return the iso week number."
17466 (require 'cal-iso)
17467 (car (calendar-iso-from-absolute days)))
17469 (defun org-small-year-to-year (year)
17470 "Convert 2-digit years into 4-digit years.
17471 YEAR is expanded into one of the 30 next years, if possible, or
17472 into a past one. Any year larger than 99 is returned unchanged."
17473 (if (>= year 100) year
17474 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17475 (century (/ current 100))
17476 (offset (- year (% current 100))))
17477 (cond ((> offset 30) (+ (* (1- century) 100) year))
17478 ((> offset -70) (+ (* century 100) year))
17479 (t (+ (* (1+ century) 100) year))))))
17481 (defun org-time-from-absolute (d)
17482 "Return the time corresponding to date D.
17483 D may be an absolute day number, or a calendar-type list (month day year)."
17484 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17485 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17487 (defun org-calendar-holiday ()
17488 "List of holidays, for Diary display in Org-mode."
17489 (require 'holidays)
17490 (let ((hl (funcall
17491 (if (fboundp 'calendar-check-holidays)
17492 'calendar-check-holidays 'check-calendar-holidays) date)))
17493 (if hl (mapconcat 'identity hl "; "))))
17495 (defun org-diary-sexp-entry (sexp entry date)
17496 "Process a SEXP diary ENTRY for DATE."
17497 (require 'diary-lib)
17498 (let ((result (if calendar-debug-sexp
17499 (let ((stack-trace-on-error t))
17500 (eval (car (read-from-string sexp))))
17501 (condition-case nil
17502 (eval (car (read-from-string sexp)))
17503 (error
17504 (beep)
17505 (message "Bad sexp at line %d in %s: %s"
17506 (org-current-line)
17507 (buffer-file-name) sexp)
17508 (sleep-for 2))))))
17509 (cond ((stringp result) (split-string result "; "))
17510 ((and (consp result)
17511 (not (consp (cdr result)))
17512 (stringp (cdr result))) (cdr result))
17513 ((and (consp result)
17514 (stringp (car result))) result)
17515 (result entry))))
17517 (defun org-diary-to-ical-string (frombuf)
17518 "Get iCalendar entries from diary entries in buffer FROMBUF.
17519 This uses the icalendar.el library."
17520 (let* ((tmpdir (if (featurep 'xemacs)
17521 (temp-directory)
17522 temporary-file-directory))
17523 (tmpfile (make-temp-name
17524 (expand-file-name "orgics" tmpdir)))
17525 buf rtn b e)
17526 (with-current-buffer frombuf
17527 (icalendar-export-region (point-min) (point-max) tmpfile)
17528 (setq buf (find-buffer-visiting tmpfile))
17529 (set-buffer buf)
17530 (goto-char (point-min))
17531 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17532 (setq b (match-beginning 0)))
17533 (goto-char (point-max))
17534 (if (re-search-backward "^END:VEVENT" nil t)
17535 (setq e (match-end 0)))
17536 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17537 (kill-buffer buf)
17538 (delete-file tmpfile)
17539 rtn))
17541 (defun org-closest-date (start current change prefer show-all)
17542 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17543 When PREFER is `past', return a date that is either CURRENT or past.
17544 When PREFER is `future', return a date that is either CURRENT or future.
17545 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17546 ;; Make the proper lists from the dates
17547 (catch 'exit
17548 (let ((a1 '(("h" . hour)
17549 ("d" . day)
17550 ("w" . week)
17551 ("m" . month)
17552 ("y" . year)))
17553 (shour (nth 2 (org-parse-time-string start)))
17554 dn dw sday cday n1 n2 n0
17555 d m y y1 y2 date1 date2 nmonths nm ny m2)
17557 (setq start (org-date-to-gregorian start)
17558 current (org-date-to-gregorian
17559 (if show-all
17560 current
17561 (time-to-days (current-time))))
17562 sday (calendar-absolute-from-gregorian start)
17563 cday (calendar-absolute-from-gregorian current))
17565 (if (<= cday sday) (throw 'exit sday))
17567 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17568 (setq dn (string-to-number (match-string 1 change))
17569 dw (cdr (assoc (match-string 2 change) a1)))
17570 (user-error "Invalid change specifier: %s" change))
17571 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17572 (cond
17573 ((eq dw 'hour)
17574 (let ((missing-hours
17575 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17576 dn)))
17577 (setq n1 (if (zerop missing-hours) cday
17578 (- cday (1+ (floor (/ missing-hours 24)))))
17579 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17580 ((eq dw 'day)
17581 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17582 n2 (+ n1 dn)))
17583 ((eq dw 'year)
17584 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17585 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17586 (setq date1 (list m d y1)
17587 n1 (calendar-absolute-from-gregorian date1)
17588 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17589 n2 (calendar-absolute-from-gregorian date2)))
17590 ((eq dw 'month)
17591 ;; approx number of month between the two dates
17592 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17593 ;; How often does dn fit in there?
17594 (setq d (nth 1 start) m (car start) y (nth 2 start)
17595 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17596 m (+ m nm)
17597 ny (floor (/ m 12))
17598 y (+ y ny)
17599 m (- m (* ny 12)))
17600 (while (> m 12) (setq m (- m 12) y (1+ y)))
17601 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17602 (setq m2 (+ m dn) y2 y)
17603 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17604 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17605 (while (<= n2 cday)
17606 (setq n1 n2 m m2 y y2)
17607 (setq m2 (+ m dn) y2 y)
17608 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17609 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17610 ;; Make sure n1 is the earlier date
17611 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17612 (if show-all
17613 (cond
17614 ((eq prefer 'past) (if (= cday n2) n2 n1))
17615 ((eq prefer 'future) (if (= cday n1) n1 n2))
17616 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17617 (cond
17618 ((eq prefer 'past) (if (= cday n2) n2 n1))
17619 ((eq prefer 'future) (if (= cday n1) n1 n2))
17620 (t (if (= cday n1) n1 n2)))))))
17622 (defun org-date-to-gregorian (date)
17623 "Turn any specification of DATE into a Gregorian date for the calendar."
17624 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17625 ((and (listp date) (= (length date) 3)) date)
17626 ((stringp date)
17627 (setq date (org-parse-time-string date))
17628 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17629 ((listp date)
17630 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17632 (defun org-parse-time-string (s &optional nodefault)
17633 "Parse the standard Org-mode time string.
17634 This should be a lot faster than the normal `parse-time-string'.
17635 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17636 hour and minute fields will be nil if not given."
17637 (cond ((string-match org-ts-regexp0 s)
17638 (list 0
17639 (if (or (match-beginning 8) (not nodefault))
17640 (string-to-number (or (match-string 8 s) "0")))
17641 (if (or (match-beginning 7) (not nodefault))
17642 (string-to-number (or (match-string 7 s) "0")))
17643 (string-to-number (match-string 4 s))
17644 (string-to-number (match-string 3 s))
17645 (string-to-number (match-string 2 s))
17646 nil nil nil))
17647 ((string-match "^<[^>]+>$" s)
17648 (decode-time (seconds-to-time (org-matcher-time s))))
17649 (t (error "Not a standard Org-mode time string: %s" s))))
17651 (defun org-timestamp-up (&optional arg)
17652 "Increase the date item at the cursor by one.
17653 If the cursor is on the year, change the year. If it is on the month,
17654 the day or the time, change that.
17655 With prefix ARG, change by that many units."
17656 (interactive "p")
17657 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17659 (defun org-timestamp-down (&optional arg)
17660 "Decrease the date item at the cursor by one.
17661 If the cursor is on the year, change the year. If it is on the month,
17662 the day or the time, change that.
17663 With prefix ARG, change by that many units."
17664 (interactive "p")
17665 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17667 (defun org-timestamp-up-day (&optional arg)
17668 "Increase the date in the time stamp by one day.
17669 With prefix ARG, change that many days."
17670 (interactive "p")
17671 (if (and (not (org-at-timestamp-p t))
17672 (org-at-heading-p))
17673 (org-todo 'up)
17674 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17676 (defun org-timestamp-down-day (&optional arg)
17677 "Decrease the date in the time stamp by one day.
17678 With prefix ARG, change that many days."
17679 (interactive "p")
17680 (if (and (not (org-at-timestamp-p t))
17681 (org-at-heading-p))
17682 (org-todo 'down)
17683 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17685 (defun org-at-timestamp-p (&optional inactive-ok)
17686 "Determine if the cursor is in or at a timestamp."
17687 (interactive)
17688 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17689 (pos (point))
17690 (ans (or (looking-at tsr)
17691 (save-excursion
17692 (skip-chars-backward "^[<\n\r\t")
17693 (if (> (point) (point-min)) (backward-char 1))
17694 (and (looking-at tsr)
17695 (> (- (match-end 0) pos) -1))))))
17696 (and ans
17697 (boundp 'org-ts-what)
17698 (setq org-ts-what
17699 (cond
17700 ((= pos (match-beginning 0)) 'bracket)
17701 ;; Point is considered to be "on the bracket" whether
17702 ;; it's really on it or right after it.
17703 ((= pos (1- (match-end 0))) 'bracket)
17704 ((= pos (match-end 0)) 'after)
17705 ((org-pos-in-match-range pos 2) 'year)
17706 ((org-pos-in-match-range pos 3) 'month)
17707 ((org-pos-in-match-range pos 7) 'hour)
17708 ((org-pos-in-match-range pos 8) 'minute)
17709 ((or (org-pos-in-match-range pos 4)
17710 (org-pos-in-match-range pos 5)) 'day)
17711 ((and (> pos (or (match-end 8) (match-end 5)))
17712 (< pos (match-end 0)))
17713 (- pos (or (match-end 8) (match-end 5))))
17714 (t 'day))))
17715 ans))
17717 (defun org-toggle-timestamp-type ()
17718 "Toggle the type (<active> or [inactive]) of a time stamp."
17719 (interactive)
17720 (when (org-at-timestamp-p t)
17721 (let ((beg (match-beginning 0)) (end (match-end 0))
17722 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17723 (save-excursion
17724 (goto-char beg)
17725 (while (re-search-forward "[][<>]" end t)
17726 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17727 t t)))
17728 (message "Timestamp is now %sactive"
17729 (if (equal (char-after beg) ?<) "" "in")))))
17731 (defun org-at-clock-log-p nil
17732 "Is the cursor on the clock log line?"
17733 (save-excursion
17734 (move-beginning-of-line 1)
17735 (looking-at org-clock-line-re)))
17737 (defvar org-clock-history) ; defined in org-clock.el
17738 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17739 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17740 "Change the date in the time stamp at point.
17741 The date will be changed by N times WHAT. WHAT can be `day', `month',
17742 `year', `minute', `second'. If WHAT is not given, the cursor position
17743 in the timestamp determines what will be changed.
17744 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17745 (let ((origin (point)) origin-cat
17746 with-hm inactive
17747 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17748 org-ts-what
17749 extra rem
17750 ts time time0 fixnext clrgx)
17751 (if (not (org-at-timestamp-p t))
17752 (user-error "Not at a timestamp"))
17753 (if (and (not what) (eq org-ts-what 'bracket))
17754 (org-toggle-timestamp-type)
17755 ;; Point isn't on brackets. Remember the part of the time-stamp
17756 ;; the point was in. Indeed, size of time-stamps may change,
17757 ;; but point must be kept in the same category nonetheless.
17758 (setq origin-cat org-ts-what)
17759 (if (and (not what) (not (eq org-ts-what 'day))
17760 org-display-custom-times
17761 (get-text-property (point) 'display)
17762 (not (get-text-property (1- (point)) 'display)))
17763 (setq org-ts-what 'day))
17764 (setq org-ts-what (or what org-ts-what)
17765 inactive (= (char-after (match-beginning 0)) ?\[)
17766 ts (match-string 0))
17767 (replace-match "")
17768 (when (string-match
17769 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17771 (setq extra (match-string 1 ts))
17772 (if suppress-tmp-delay
17773 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17774 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17775 (setq with-hm t))
17776 (setq time0 (org-parse-time-string ts))
17777 (when (and updown
17778 (eq org-ts-what 'minute)
17779 (not current-prefix-arg))
17780 ;; This looks like s-up and s-down. Change by one rounding step.
17781 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17782 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17783 (setcar (cdr time0) (+ (nth 1 time0)
17784 (if (> n 0) (- rem) (- dm rem))))))
17785 (setq time
17786 (encode-time (or (car time0) 0)
17787 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17788 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17789 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17790 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17791 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17792 (nthcdr 6 time0)))
17793 (when (and (member org-ts-what '(hour minute))
17794 extra
17795 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17796 (setq extra (org-modify-ts-extra
17797 extra
17798 (if (eq org-ts-what 'hour) 2 5)
17799 n dm)))
17800 (when (integerp org-ts-what)
17801 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17802 (if (eq what 'calendar)
17803 (let ((cal-date (org-get-date-from-calendar)))
17804 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17805 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17806 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17807 (setcar time0 (or (car time0) 0))
17808 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17809 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17810 (setq time (apply 'encode-time time0))))
17811 ;; Insert the new time-stamp, and ensure point stays in the same
17812 ;; category as before (i.e. not after the last position in that
17813 ;; category).
17814 (let ((pos (point)))
17815 ;; Stay before inserted string. `save-excursion' is of no use.
17816 (setq org-last-changed-timestamp
17817 (org-insert-time-stamp time with-hm inactive nil nil extra))
17818 (goto-char pos))
17819 (save-match-data
17820 (looking-at org-ts-regexp3)
17821 (goto-char (cond
17822 ;; `day' category ends before `hour' if any, or at
17823 ;; the end of the day name.
17824 ((eq origin-cat 'day)
17825 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17826 ((eq origin-cat 'hour) (min (match-end 7) origin))
17827 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17828 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17829 ;; `year' and `month' have both fixed size: point
17830 ;; couldn't have moved into another part.
17831 (t origin))))
17832 ;; Update clock if on a CLOCK line.
17833 (org-clock-update-time-maybe)
17834 ;; Maybe adjust the closest clock in `org-clock-history'
17835 (when org-clock-adjust-closest
17836 (if (not (and (org-at-clock-log-p)
17837 (< 1 (length (delq nil (mapcar 'marker-position
17838 org-clock-history))))))
17839 (message "No clock to adjust")
17840 (cond ((save-excursion ; fix previous clock?
17841 (re-search-backward org-ts-regexp0 nil t)
17842 (org-looking-back (concat org-clock-string " \\[")))
17843 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17844 ((save-excursion ; fix next clock?
17845 (re-search-backward org-ts-regexp0 nil t)
17846 (looking-at (concat org-ts-regexp0 "\\] =>")))
17847 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17848 (save-window-excursion
17849 ;; Find closest clock to point, adjust the previous/next one in history
17850 (let* ((p (save-excursion (org-back-to-heading t)))
17851 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17852 (clfixnth
17853 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17854 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17855 (if (not clfixpos)
17856 (message "No clock to adjust")
17857 (save-excursion
17858 (org-goto-marker-or-bmk clfixpos)
17859 (org-show-subtree)
17860 (when (re-search-forward clrgx nil t)
17861 (goto-char (match-beginning 1))
17862 (let (org-clock-adjust-closest)
17863 (org-timestamp-change n org-ts-what updown))
17864 (message "Clock adjusted in %s for heading: %s"
17865 (file-name-nondirectory (buffer-file-name))
17866 (org-get-heading t t)))))))))
17867 ;; Try to recenter the calendar window, if any.
17868 (if (and org-calendar-follow-timestamp-change
17869 (get-buffer-window "*Calendar*" t)
17870 (memq org-ts-what '(day month year)))
17871 (org-recenter-calendar (time-to-days time))))))
17873 (defun org-modify-ts-extra (s pos n dm)
17874 "Change the different parts of the lead-time and repeat fields in timestamp."
17875 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17876 ng h m new rem)
17877 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17878 (cond
17879 ((or (org-pos-in-match-range pos 2)
17880 (org-pos-in-match-range pos 3))
17881 (setq m (string-to-number (match-string 3 s))
17882 h (string-to-number (match-string 2 s)))
17883 (if (org-pos-in-match-range pos 2)
17884 (setq h (+ h n))
17885 (setq n (* dm (org-no-warnings (signum n))))
17886 (when (not (= 0 (setq rem (% m dm))))
17887 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17888 (setq m (+ m n)))
17889 (if (< m 0) (setq m (+ m 60) h (1- h)))
17890 (if (> m 59) (setq m (- m 60) h (1+ h)))
17891 (setq h (min 24 (max 0 h)))
17892 (setq ng 1 new (format "-%02d:%02d" h m)))
17893 ((org-pos-in-match-range pos 6)
17894 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17895 ((org-pos-in-match-range pos 5)
17896 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17898 ((org-pos-in-match-range pos 9)
17899 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17900 ((org-pos-in-match-range pos 8)
17901 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17903 (when ng
17904 (setq s (concat
17905 (substring s 0 (match-beginning ng))
17907 (substring s (match-end ng))))))
17910 (defun org-recenter-calendar (date)
17911 "If the calendar is visible, recenter it to DATE."
17912 (let ((cwin (get-buffer-window "*Calendar*" t)))
17913 (when cwin
17914 (let ((calendar-move-hook nil))
17915 (with-selected-window cwin
17916 (calendar-goto-date (if (listp date) date
17917 (calendar-gregorian-from-absolute date))))))))
17919 (defun org-goto-calendar (&optional arg)
17920 "Go to the Emacs calendar at the current date.
17921 If there is a time stamp in the current line, go to that date.
17922 A prefix ARG can be used to force the current date."
17923 (interactive "P")
17924 (let ((tsr org-ts-regexp) diff
17925 (calendar-move-hook nil)
17926 (calendar-view-holidays-initially-flag nil)
17927 (calendar-view-diary-initially-flag nil))
17928 (if (or (org-at-timestamp-p)
17929 (save-excursion
17930 (beginning-of-line 1)
17931 (looking-at (concat ".*" tsr))))
17932 (let ((d1 (time-to-days (current-time)))
17933 (d2 (time-to-days
17934 (org-time-string-to-time (match-string 1)))))
17935 (setq diff (- d2 d1))))
17936 (calendar)
17937 (calendar-goto-today)
17938 (if (and diff (not arg)) (calendar-forward-day diff))))
17940 (defun org-get-date-from-calendar ()
17941 "Return a list (month day year) of date at point in calendar."
17942 (with-current-buffer "*Calendar*"
17943 (save-match-data
17944 (calendar-cursor-to-date))))
17946 (defun org-date-from-calendar ()
17947 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17948 If there is already a time stamp at the cursor position, update it."
17949 (interactive)
17950 (if (org-at-timestamp-p t)
17951 (org-timestamp-change 0 'calendar)
17952 (let ((cal-date (org-get-date-from-calendar)))
17953 (org-insert-time-stamp
17954 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17956 (defcustom org-effort-durations
17957 `(("min" . 1)
17958 ("h" . 60)
17959 ("d" . ,(* 60 8))
17960 ("w" . ,(* 60 8 5))
17961 ("m" . ,(* 60 8 5 4))
17962 ("y" . ,(* 60 8 5 40)))
17963 "Conversion factor to minutes for an effort modifier.
17965 Each entry has the form (MODIFIER . MINUTES).
17967 In an effort string, a number followed by MODIFIER is multiplied
17968 by the specified number of MINUTES to obtain an effort in
17969 minutes.
17971 For example, if the value of this variable is ((\"hours\" . 60)), then an
17972 effort string \"2hours\" is equivalent to 120 minutes."
17973 :group 'org-agenda
17974 :version "25.1"
17975 :package-version '(Org . "8.3")
17976 :type '(alist :key-type (string :tag "Modifier")
17977 :value-type (number :tag "Minutes")))
17979 (defun org-minutes-to-clocksum-string (m)
17980 "Format number of minutes as a clocksum string.
17981 The format is determined by `org-time-clocksum-format',
17982 `org-time-clocksum-use-fractional' and
17983 `org-time-clocksum-fractional-format' and
17984 `org-time-clocksum-use-effort-durations'."
17985 (let ((clocksum "")
17986 (m (round m)) ; Don't allow fractions of minutes
17987 h d w mo y fmt n)
17988 (setq h (if org-time-clocksum-use-effort-durations
17989 (cdr (assoc "h" org-effort-durations)) 60)
17990 d (if org-time-clocksum-use-effort-durations
17991 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17992 w (if org-time-clocksum-use-effort-durations
17993 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17994 mo (if org-time-clocksum-use-effort-durations
17995 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17996 y (if org-time-clocksum-use-effort-durations
17997 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17998 ;; fractional format
17999 (if org-time-clocksum-use-fractional
18000 (cond
18001 ;; single format string
18002 ((stringp org-time-clocksum-fractional-format)
18003 (format org-time-clocksum-fractional-format (/ m (float h))))
18004 ;; choice of fractional formats for different time units
18005 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18006 (> (/ (truncate m) (* y d h)) 0))
18007 (format fmt (/ m (* y d (float h)))))
18008 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18009 (> (/ (truncate m) (* mo d h)) 0))
18010 (format fmt (/ m (* mo d (float h)))))
18011 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18012 (> (/ (truncate m) (* w d h)) 0))
18013 (format fmt (/ m (* w d (float h)))))
18014 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18015 (> (/ (truncate m) (* d h)) 0))
18016 (format fmt (/ m (* d (float h)))))
18017 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18018 (> (/ (truncate m) h) 0))
18019 (format fmt (/ m (float h))))
18020 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18021 (format fmt m))
18022 ;; fall back to smallest time unit with a format
18023 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18024 (format fmt (/ m (float h))))
18025 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18026 (format fmt (/ m (* d (float h)))))
18027 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18028 (format fmt (/ m (* w d (float h)))))
18029 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18030 (format fmt (/ m (* mo d (float h)))))
18031 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18032 (format fmt (/ m (* y d (float h))))))
18033 ;; standard (non-fractional) format, with single format string
18034 (if (stringp org-time-clocksum-format)
18035 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18036 ;; separate formats components
18037 (and (setq fmt (plist-get org-time-clocksum-format :years))
18038 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18039 (plist-get org-time-clocksum-format :require-years))
18040 (setq clocksum (concat clocksum (format fmt n))
18041 m (- m (* n y d h))))
18042 (and (setq fmt (plist-get org-time-clocksum-format :months))
18043 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18044 (plist-get org-time-clocksum-format :require-months))
18045 (setq clocksum (concat clocksum (format fmt n))
18046 m (- m (* n mo d h))))
18047 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18048 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18049 (plist-get org-time-clocksum-format :require-weeks))
18050 (setq clocksum (concat clocksum (format fmt n))
18051 m (- m (* n w d h))))
18052 (and (setq fmt (plist-get org-time-clocksum-format :days))
18053 (or (> (setq n (/ (truncate m) (* d h))) 0)
18054 (plist-get org-time-clocksum-format :require-days))
18055 (setq clocksum (concat clocksum (format fmt n))
18056 m (- m (* n d h))))
18057 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18058 (or (> (setq n (/ (truncate m) h)) 0)
18059 (plist-get org-time-clocksum-format :require-hours))
18060 (setq clocksum (concat clocksum (format fmt n))
18061 m (- m (* n h))))
18062 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18063 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18064 (setq clocksum (concat clocksum (format fmt m))))
18065 ;; return formatted time duration
18066 clocksum))))
18068 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18069 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18070 "Org mode version 8.0")
18072 (defun org-hours-to-clocksum-string (n)
18073 (org-minutes-to-clocksum-string (* n 60)))
18075 (defun org-hh:mm-string-to-minutes (s)
18076 "Convert a string H:MM to a number of minutes.
18077 If the string is just a number, interpret it as minutes.
18078 In fact, the first hh:mm or number in the string will be taken,
18079 there can be extra stuff in the string.
18080 If no number is found, the return value is 0."
18081 (cond
18082 ((integerp s) s)
18083 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18084 (+ (* (string-to-number (match-string 1 s)) 60)
18085 (string-to-number (match-string 2 s))))
18086 ((string-match "\\([0-9]+\\)" s)
18087 (string-to-number (match-string 1 s)))
18088 (t 0)))
18090 (defcustom org-image-actual-width t
18091 "Should we use the actual width of images when inlining them?
18093 When set to `t', always use the image width.
18095 When set to a number, use imagemagick (when available) to set
18096 the image's width to this value.
18098 When set to a number in a list, try to get the width from any
18099 #+ATTR.* keyword if it matches a width specification like
18101 #+ATTR_HTML: :width 300px
18103 and fall back on that number if none is found.
18105 When set to nil, try to get the width from an #+ATTR.* keyword
18106 and fall back on the original width if none is found.
18108 This requires Emacs >= 24.1, build with imagemagick support."
18109 :group 'org-appearance
18110 :version "24.4"
18111 :package-version '(Org . "8.0")
18112 :type '(choice
18113 (const :tag "Use the image width" t)
18114 (integer :tag "Use a number of pixels")
18115 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18116 (const :tag "Use #+ATTR* or don't resize" nil)))
18118 (defcustom org-agenda-inhibit-startup nil
18119 "Inhibit startup when preparing agenda buffers.
18120 When this variable is `t', the initialization of the Org agenda
18121 buffers is inhibited: e.g. the visibility state is not set, the
18122 tables are not re-aligned, etc."
18123 :type 'boolean
18124 :version "24.3"
18125 :group 'org-agenda)
18127 (define-obsolete-variable-alias
18128 'org-agenda-ignore-drawer-properties
18129 'org-agenda-ignore-properties "25.1")
18131 (defcustom org-agenda-ignore-properties nil
18132 "Avoid updating text properties when building the agenda.
18133 Properties are used to prepare buffers for effort estimates,
18134 appointments, statistics and subtree-local categories.
18135 If you don't use these in the agenda, you can add them to this
18136 list and agenda building will be a bit faster.
18137 The value is a list, with zero or more of the symbols `effort', `appt',
18138 `stats' or `category'."
18139 :type '(set :greedy t
18140 (const effort)
18141 (const appt)
18142 (const stats)
18143 (const category))
18144 :version "25.1"
18145 :package-version '(Org . "8.3")
18146 :group 'org-agenda)
18148 (defun org-duration-string-to-minutes (s &optional output-to-string)
18149 "Convert a duration string S to minutes.
18151 A bare number is interpreted as minutes, modifiers can be set by
18152 customizing `org-effort-durations' (which see).
18154 Entries containing a colon are interpreted as H:MM by
18155 `org-hh:mm-string-to-minutes'."
18156 (let ((result 0)
18157 (re (concat "\\([0-9.]+\\) *\\("
18158 (regexp-opt (mapcar 'car org-effort-durations))
18159 "\\)")))
18160 (while (string-match re s)
18161 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18162 (string-to-number (match-string 1 s))))
18163 (setq s (replace-match "" nil t s)))
18164 (setq result (floor result))
18165 (incf result (org-hh:mm-string-to-minutes s))
18166 (if output-to-string (number-to-string result) result)))
18168 ;;;; Files
18170 (defun org-save-all-org-buffers ()
18171 "Save all Org-mode buffers without user confirmation."
18172 (interactive)
18173 (message "Saving all Org-mode buffers...")
18174 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18175 (when (featurep 'org-id) (org-id-locations-save))
18176 (message "Saving all Org-mode buffers... done"))
18178 (defun org-revert-all-org-buffers ()
18179 "Revert all Org-mode buffers.
18180 Prompt for confirmation when there are unsaved changes.
18181 Be sure you know what you are doing before letting this function
18182 overwrite your changes.
18184 This function is useful in a setup where one tracks org files
18185 with a version control system, to revert on one machine after pulling
18186 changes from another. I believe the procedure must be like this:
18188 1. M-x org-save-all-org-buffers
18189 2. Pull changes from the other machine, resolve conflicts
18190 3. M-x org-revert-all-org-buffers"
18191 (interactive)
18192 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18193 (user-error "Abort"))
18194 (save-excursion
18195 (save-window-excursion
18196 (mapc
18197 (lambda (b)
18198 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18199 (with-current-buffer b buffer-file-name))
18200 (org-pop-to-buffer-same-window b)
18201 (revert-buffer t 'no-confirm)))
18202 (buffer-list))
18203 (when (and (featurep 'org-id) org-id-track-globally)
18204 (org-id-locations-load)))))
18206 ;;;; Agenda files
18208 ;;;###autoload
18209 (defun org-switchb (&optional arg)
18210 "Switch between Org buffers.
18211 With one prefix argument, restrict available buffers to files.
18212 With two prefix arguments, restrict available buffers to agenda files.
18214 Defaults to `iswitchb' for buffer name completion.
18215 Set `org-completion-use-ido' to make it use ido instead."
18216 (interactive "P")
18217 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18218 ((equal arg '(16)) (org-buffer-list 'agenda))
18219 (t (org-buffer-list))))
18220 (org-completion-use-iswitchb org-completion-use-iswitchb)
18221 (org-completion-use-ido org-completion-use-ido))
18222 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18223 (setq org-completion-use-iswitchb t))
18224 (org-pop-to-buffer-same-window
18225 (org-icompleting-read "Org buffer: "
18226 (mapcar 'list (mapcar 'buffer-name blist))
18227 nil t))))
18229 ;;; Define some older names previously used for this functionality
18230 ;;;###autoload
18231 (defalias 'org-ido-switchb 'org-switchb)
18232 ;;;###autoload
18233 (defalias 'org-iswitchb 'org-switchb)
18235 (defun org-buffer-list (&optional predicate exclude-tmp)
18236 "Return a list of Org buffers.
18237 PREDICATE can be `export', `files' or `agenda'.
18239 export restrict the list to Export buffers.
18240 files restrict the list to buffers visiting Org files.
18241 agenda restrict the list to buffers visiting agenda files.
18243 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18244 (let* ((bfn nil)
18245 (agenda-files (and (eq predicate 'agenda)
18246 (mapcar 'file-truename (org-agenda-files t))))
18247 (filter
18248 (cond
18249 ((eq predicate 'files)
18250 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18251 ((eq predicate 'export)
18252 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18253 ((eq predicate 'agenda)
18254 (lambda (b)
18255 (with-current-buffer b
18256 (and (derived-mode-p 'org-mode)
18257 (setq bfn (buffer-file-name b))
18258 (member (file-truename bfn) agenda-files)))))
18259 (t (lambda (b) (with-current-buffer b
18260 (or (derived-mode-p 'org-mode)
18261 (string-match "\*Org .*Export"
18262 (buffer-name b)))))))))
18263 (delq nil
18264 (mapcar
18265 (lambda(b)
18266 (if (and (funcall filter b)
18267 (or (not exclude-tmp)
18268 (not (string-match "tmp" (buffer-name b)))))
18270 nil))
18271 (buffer-list)))))
18273 (defun org-agenda-files (&optional unrestricted archives)
18274 "Get the list of agenda files.
18275 Optional UNRESTRICTED means return the full list even if a restriction
18276 is currently in place.
18277 When ARCHIVES is t, include all archive files that are really being
18278 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18279 `org-agenda-archives-mode' is t."
18280 (let ((files
18281 (cond
18282 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18283 ((stringp org-agenda-files) (org-read-agenda-file-list))
18284 ((listp org-agenda-files) org-agenda-files)
18285 (t (error "Invalid value of `org-agenda-files'")))))
18286 (setq files (apply 'append
18287 (mapcar (lambda (f)
18288 (if (file-directory-p f)
18289 (directory-files
18290 f t org-agenda-file-regexp)
18291 (list f)))
18292 files)))
18293 (when org-agenda-skip-unavailable-files
18294 (setq files (delq nil
18295 (mapcar (function
18296 (lambda (file)
18297 (and (file-readable-p file) file)))
18298 files))))
18299 (when (or (eq archives t)
18300 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18301 (setq files (org-add-archive-files files)))
18302 files))
18304 (defun org-agenda-file-p (&optional file)
18305 "Return non-nil, if FILE is an agenda file.
18306 If FILE is omitted, use the file associated with the current
18307 buffer."
18308 (let ((fname (or file (buffer-file-name))))
18309 (and fname
18310 (member (file-truename fname)
18311 (mapcar #'file-truename (org-agenda-files t))))))
18313 (defun org-edit-agenda-file-list ()
18314 "Edit the list of agenda files.
18315 Depending on setup, this either uses customize to edit the variable
18316 `org-agenda-files', or it visits the file that is holding the list. In the
18317 latter case, the buffer is set up in a way that saving it automatically kills
18318 the buffer and restores the previous window configuration."
18319 (interactive)
18320 (if (stringp org-agenda-files)
18321 (let ((cw (current-window-configuration)))
18322 (find-file org-agenda-files)
18323 (org-set-local 'org-window-configuration cw)
18324 (org-add-hook 'after-save-hook
18325 (lambda ()
18326 (set-window-configuration
18327 (prog1 org-window-configuration
18328 (kill-buffer (current-buffer))))
18329 (org-install-agenda-files-menu)
18330 (message "New agenda file list installed"))
18331 nil 'local)
18332 (message "%s" (substitute-command-keys
18333 "Edit list and finish with \\[save-buffer]")))
18334 (customize-variable 'org-agenda-files)))
18336 (defun org-store-new-agenda-file-list (list)
18337 "Set new value for the agenda file list and save it correctly."
18338 (if (stringp org-agenda-files)
18339 (let ((fe (org-read-agenda-file-list t)) b u)
18340 (while (setq b (find-buffer-visiting org-agenda-files))
18341 (kill-buffer b))
18342 (with-temp-file org-agenda-files
18343 (insert
18344 (mapconcat
18345 (lambda (f) ;; Keep un-expanded entries.
18346 (if (setq u (assoc f fe))
18347 (cdr u)
18349 list "\n")
18350 "\n")))
18351 (let ((org-mode-hook nil) (org-inhibit-startup t)
18352 (org-insert-mode-line-in-empty-file nil))
18353 (setq org-agenda-files list)
18354 (customize-save-variable 'org-agenda-files org-agenda-files))))
18356 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18357 "Read the list of agenda files from a file.
18358 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18359 filenames, used by `org-store-new-agenda-file-list' to write back
18360 un-expanded file names."
18361 (when (file-directory-p org-agenda-files)
18362 (error "`org-agenda-files' cannot be a single directory"))
18363 (when (stringp org-agenda-files)
18364 (with-temp-buffer
18365 (insert-file-contents org-agenda-files)
18366 (mapcar
18367 (lambda (f)
18368 (let ((e (expand-file-name (substitute-in-file-name f)
18369 org-directory)))
18370 (if pair-with-expansion
18371 (cons e f)
18372 e)))
18373 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18375 ;;;###autoload
18376 (defun org-cycle-agenda-files ()
18377 "Cycle through the files in `org-agenda-files'.
18378 If the current buffer visits an agenda file, find the next one in the list.
18379 If the current buffer does not, find the first agenda file."
18380 (interactive)
18381 (let* ((fs (org-agenda-files t))
18382 (files (append fs (list (car fs))))
18383 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18384 file)
18385 (unless files (user-error "No agenda files"))
18386 (catch 'exit
18387 (while (setq file (pop files))
18388 (if (equal (file-truename file) tcf)
18389 (when (car files)
18390 (find-file (car files))
18391 (throw 'exit t))))
18392 (find-file (car fs)))
18393 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18395 (defun org-agenda-file-to-front (&optional to-end)
18396 "Move/add the current file to the top of the agenda file list.
18397 If the file is not present in the list, it is added to the front. If it is
18398 present, it is moved there. With optional argument TO-END, add/move to the
18399 end of the list."
18400 (interactive "P")
18401 (let ((org-agenda-skip-unavailable-files nil)
18402 (file-alist (mapcar (lambda (x)
18403 (cons (file-truename x) x))
18404 (org-agenda-files t)))
18405 (ctf (file-truename
18406 (or buffer-file-name
18407 (user-error "Please save the current buffer to a file"))))
18408 x had)
18409 (setq x (assoc ctf file-alist) had x)
18411 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18412 (if to-end
18413 (setq file-alist (append (delq x file-alist) (list x)))
18414 (setq file-alist (cons x (delq x file-alist))))
18415 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18416 (org-install-agenda-files-menu)
18417 (message "File %s to %s of agenda file list"
18418 (if had "moved" "added") (if to-end "end" "front"))))
18420 (defun org-remove-file (&optional file)
18421 "Remove current file from the list of files in variable `org-agenda-files'.
18422 These are the files which are being checked for agenda entries.
18423 Optional argument FILE means use this file instead of the current."
18424 (interactive)
18425 (let* ((org-agenda-skip-unavailable-files nil)
18426 (file (or file buffer-file-name
18427 (user-error "Current buffer does not visit a file")))
18428 (true-file (file-truename file))
18429 (afile (abbreviate-file-name file))
18430 (files (delq nil (mapcar
18431 (lambda (x)
18432 (if (equal true-file
18433 (file-truename x))
18434 nil x))
18435 (org-agenda-files t)))))
18436 (if (not (= (length files) (length (org-agenda-files t))))
18437 (progn
18438 (org-store-new-agenda-file-list files)
18439 (org-install-agenda-files-menu)
18440 (message "Removed from Org Agenda list: %s" afile))
18441 (message "File was not in list: %s (not removed)" afile))))
18443 (defun org-file-menu-entry (file)
18444 (vector file (list 'find-file file) t))
18446 (defun org-check-agenda-file (file)
18447 "Make sure FILE exists. If not, ask user what to do."
18448 (when (not (file-exists-p file))
18449 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18450 (abbreviate-file-name file))
18451 (let ((r (downcase (read-char-exclusive))))
18452 (cond
18453 ((equal r ?r)
18454 (org-remove-file file)
18455 (throw 'nextfile t))
18456 (t (user-error "Abort"))))))
18458 (defun org-get-agenda-file-buffer (file)
18459 "Get an agenda buffer visiting FILE.
18460 If the buffer needs to be created, add it to the list of buffers
18461 which might be released later."
18462 (let ((buf (org-find-base-buffer-visiting file)))
18463 (if buf
18464 buf ; just return it
18465 ;; Make a new buffer and remember it
18466 (setq buf (find-file-noselect file))
18467 (if buf (push buf org-agenda-new-buffers))
18468 buf)))
18470 (defun org-release-buffers (blist)
18471 "Release all buffers in list, asking the user for confirmation when needed.
18472 When a buffer is unmodified, it is just killed. When modified, it is saved
18473 \(if the user agrees) and then killed."
18474 (let (buf file)
18475 (while (setq buf (pop blist))
18476 (setq file (buffer-file-name buf))
18477 (when (and (buffer-modified-p buf)
18478 file
18479 (y-or-n-p (format "Save file %s? " file)))
18480 (with-current-buffer buf (save-buffer)))
18481 (kill-buffer buf))))
18483 (defun org-agenda-prepare-buffers (files)
18484 "Create buffers for all agenda files, protect archived trees and comments."
18485 (interactive)
18486 (let ((pa '(:org-archived t))
18487 (pc '(:org-comment t))
18488 (pall '(:org-archived t :org-comment t))
18489 (inhibit-read-only t)
18490 (org-inhibit-startup org-agenda-inhibit-startup)
18491 (rea (concat ":" org-archive-tag ":"))
18492 file re pos)
18493 (setq org-tag-alist-for-agenda nil
18494 org-tag-groups-alist-for-agenda nil)
18495 (save-excursion
18496 (save-restriction
18497 (while (setq file (pop files))
18498 (catch 'nextfile
18499 (if (bufferp file)
18500 (set-buffer file)
18501 (org-check-agenda-file file)
18502 (set-buffer (org-get-agenda-file-buffer file)))
18503 (widen)
18504 (org-set-regexps-and-options 'tags-only)
18505 (setq pos (point))
18506 (or (memq 'category org-agenda-ignore-properties)
18507 (org-refresh-category-properties))
18508 (or (memq 'stats org-agenda-ignore-properties)
18509 (org-refresh-stats-properties))
18510 (or (memq 'effort org-agenda-ignore-properties)
18511 (org-refresh-effort-properties))
18512 (or (memq 'appt org-agenda-ignore-properties)
18513 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18514 (setq org-todo-keywords-for-agenda
18515 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18516 (setq org-done-keywords-for-agenda
18517 (append org-done-keywords-for-agenda org-done-keywords))
18518 (setq org-todo-keyword-alist-for-agenda
18519 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18520 (setq org-tag-alist-for-agenda
18521 (org-uniquify
18522 (append org-tag-alist-for-agenda
18523 org-tag-alist
18524 org-tag-persistent-alist)))
18525 (if org-group-tags
18526 (setq org-tag-groups-alist-for-agenda
18527 (org-uniquify-alist
18528 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18529 (org-with-silent-modifications
18530 (save-excursion
18531 (remove-text-properties (point-min) (point-max) pall)
18532 (when org-agenda-skip-archived-trees
18533 (goto-char (point-min))
18534 (while (re-search-forward rea nil t)
18535 (if (org-at-heading-p t)
18536 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18537 (goto-char (point-min))
18538 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18539 (while (re-search-forward re nil t)
18540 (when (save-match-data (org-in-commented-heading-p t))
18541 (add-text-properties
18542 (match-beginning 0) (org-end-of-subtree t) pc)))))
18543 (goto-char pos)))))
18544 (setq org-todo-keywords-for-agenda
18545 (org-uniquify org-todo-keywords-for-agenda))
18546 (setq org-todo-keyword-alist-for-agenda
18547 (org-uniquify org-todo-keyword-alist-for-agenda))))
18550 ;;;; CDLaTeX minor mode
18552 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18553 "Keymap for the minor `org-cdlatex-mode'.")
18555 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18556 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18557 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18558 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18559 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18561 (defvar org-cdlatex-texmathp-advice-is-done nil
18562 "Flag remembering if we have applied the advice to texmathp already.")
18564 (define-minor-mode org-cdlatex-mode
18565 "Toggle the minor `org-cdlatex-mode'.
18566 This mode supports entering LaTeX environment and math in LaTeX fragments
18567 in Org-mode.
18568 \\{org-cdlatex-mode-map}"
18569 nil " OCDL" nil
18570 (when org-cdlatex-mode
18571 (require 'cdlatex)
18572 (run-hooks 'cdlatex-mode-hook)
18573 (cdlatex-compute-tables))
18574 (unless org-cdlatex-texmathp-advice-is-done
18575 (setq org-cdlatex-texmathp-advice-is-done t)
18576 (defadvice texmathp (around org-math-always-on activate)
18577 "Always return t in org-mode buffers.
18578 This is because we want to insert math symbols without dollars even outside
18579 the LaTeX math segments. If Orgmode thinks that point is actually inside
18580 an embedded LaTeX fragment, let texmathp do its job.
18581 \\[org-cdlatex-mode-map]"
18582 (interactive)
18583 (let (p)
18584 (cond
18585 ((not (derived-mode-p 'org-mode)) ad-do-it)
18586 ((eq this-command 'cdlatex-math-symbol)
18587 (setq ad-return-value t
18588 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18590 (let ((p (org-inside-LaTeX-fragment-p)))
18591 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18592 (setq ad-return-value t
18593 texmathp-why '("Org-mode embedded math" . 0))
18594 (if p ad-do-it)))))))))
18596 (defun turn-on-org-cdlatex ()
18597 "Unconditionally turn on `org-cdlatex-mode'."
18598 (org-cdlatex-mode 1))
18600 (defun org-try-cdlatex-tab ()
18601 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18602 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18603 - inside a LaTeX fragment, or
18604 - after the first word in a line, where an abbreviation expansion could
18605 insert a LaTeX environment."
18606 (when org-cdlatex-mode
18607 (cond
18608 ;; Before any word on the line: No expansion possible.
18609 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18610 ;; Just after first word on the line: Expand it. Make sure it
18611 ;; cannot happen on headlines, though.
18612 ((save-excursion
18613 (skip-chars-backward "a-zA-Z0-9*")
18614 (skip-chars-backward " \t")
18615 (and (bolp) (not (org-at-heading-p))))
18616 (cdlatex-tab) t)
18617 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18619 (defun org-cdlatex-underscore-caret (&optional arg)
18620 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18621 Revert to the normal definition outside of these fragments."
18622 (interactive "P")
18623 (if (org-inside-LaTeX-fragment-p)
18624 (call-interactively 'cdlatex-sub-superscript)
18625 (let (org-cdlatex-mode)
18626 (call-interactively (key-binding (vector last-input-event))))))
18628 (defun org-cdlatex-math-modify (&optional arg)
18629 "Execute `cdlatex-math-modify' in LaTeX fragments.
18630 Revert to the normal definition outside of these fragments."
18631 (interactive "P")
18632 (if (org-inside-LaTeX-fragment-p)
18633 (call-interactively 'cdlatex-math-modify)
18634 (let (org-cdlatex-mode)
18635 (call-interactively (key-binding (vector last-input-event))))))
18637 (defun org-cdlatex-environment-indent (&optional environment item)
18638 "Execute `cdlatex-environment' and indent the inserted environment.
18640 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18642 The inserted environment is indented to current indentation
18643 unless point is at the beginning of the line, in which the
18644 environment remains unintended."
18645 (interactive)
18646 ;; cdlatex-environment always return nil. Therefore, capture output
18647 ;; first and determine if an environment was selected.
18648 (let* ((beg (point-marker))
18649 (end (copy-marker (point) t))
18650 (inserted (progn
18651 (ignore-errors (cdlatex-environment environment item))
18652 (< beg end)))
18653 ;; Figure out how many lines to move forward after the
18654 ;; environment has been inserted.
18655 (lines (when inserted
18656 (save-excursion
18657 (- (loop while (< beg (point))
18658 with x = 0
18659 do (forward-line -1)
18660 (incf x)
18661 finally return x)
18662 (if (progn (goto-char beg)
18663 (and (progn (skip-chars-forward " \t") (eolp))
18664 (progn (skip-chars-backward " \t") (bolp))))
18665 1 0)))))
18666 (env (org-trim (delete-and-extract-region beg end))))
18667 (when inserted
18668 ;; Get indentation of next line unless at column 0.
18669 (let ((ind (if (bolp) 0
18670 (save-excursion
18671 (org-return-indent)
18672 (prog1 (org-get-indentation)
18673 (when (progn (skip-chars-forward " \t") (eolp))
18674 (delete-region beg (point)))))))
18675 (bol (progn (skip-chars-backward " \t") (bolp))))
18676 ;; Insert a newline before environment unless at column zero
18677 ;; to "escape" the current line. Insert a newline if
18678 ;; something is one the same line as \end{ENVIRONMENT}.
18679 (insert
18680 (concat (unless bol "\n") env
18681 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18682 (unless (zerop ind)
18683 (save-excursion
18684 (goto-char beg)
18685 (while (< (point) end)
18686 (unless (eolp) (org-indent-line-to ind))
18687 (forward-line))))
18688 (goto-char beg)
18689 (forward-line lines)
18690 (org-indent-line-to ind)))
18691 (set-marker beg nil)
18692 (set-marker end nil)))
18695 ;;;; LaTeX fragments
18697 (defun org-inside-LaTeX-fragment-p ()
18698 "Test if point is inside a LaTeX fragment.
18699 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18700 sequence appearing also before point.
18701 Even though the matchers for math are configurable, this function assumes
18702 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18703 delimiters are skipped when they have been removed by customization.
18704 The return value is nil, or a cons cell with the delimiter and the
18705 position of this delimiter.
18707 This function does a reasonably good job, but can locally be fooled by
18708 for example currency specifications. For example it will assume being in
18709 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18710 fragments that are properly closed, but during editing, we have to live
18711 with the uncertainty caused by missing closing delimiters. This function
18712 looks only before point, not after."
18713 (catch 'exit
18714 (let ((pos (point))
18715 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18716 (lim (progn
18717 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18718 (point)))
18719 dd-on str (start 0) m re)
18720 (goto-char pos)
18721 (when dodollar
18722 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18723 re (nth 1 (assoc "$" org-latex-regexps)))
18724 (while (string-match re str start)
18725 (cond
18726 ((= (match-end 0) (length str))
18727 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18728 ((= (match-end 0) (- (length str) 5))
18729 (throw 'exit nil))
18730 (t (setq start (match-end 0))))))
18731 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18732 (goto-char pos)
18733 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18734 (and (match-beginning 2) (throw 'exit nil))
18735 ;; count $$
18736 (while (re-search-backward "\\$\\$" lim t)
18737 (setq dd-on (not dd-on)))
18738 (goto-char pos)
18739 (if dd-on (cons "$$" m))))))
18741 (defun org-inside-latex-macro-p ()
18742 "Is point inside a LaTeX macro or its arguments?"
18743 (save-match-data
18744 (org-in-regexp
18745 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18747 (defvar org-latex-fragment-image-overlays nil
18748 "List of overlays carrying the images of latex fragments.")
18749 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18751 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18752 "Remove all overlays with LaTeX fragment images in current buffer.
18753 When optional arguments BEG and END are non-nil, remove all
18754 overlays between them instead. Return t when some overlays were
18755 removed, nil otherwise."
18756 (let (removedp)
18757 (setq org-latex-fragment-image-overlays
18758 (let ((beg (or beg (point-min)))
18759 (end (or end (point-max))))
18760 (org-remove-if
18761 (lambda (o)
18762 (and (>= (overlay-start o) beg)
18763 (<= (overlay-end o) end)
18764 (progn (delete-overlay o)
18765 (or removedp (setq removedp t)))))
18766 org-latex-fragment-image-overlays)))
18767 removedp))
18769 (define-obsolete-function-alias
18770 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18771 (defun org-toggle-latex-fragment (&optional arg)
18772 "Preview the LaTeX fragment at point, or all locally or globally.
18774 If the cursor is on a LaTeX fragment, create the image and overlay
18775 it over the source code, if there is none. Remove it otherwise.
18776 If there is no fragment at point, display all fragments in the
18777 current section.
18779 With prefix ARG, preview or clear image for all fragments in the
18780 current subtree or in the whole buffer when used before the first
18781 headline. With a double prefix ARG \\[universal-argument] \
18782 \\[universal-argument] preview or clear images
18783 for all fragments in the buffer."
18784 (interactive "P")
18785 (unless (buffer-file-name (buffer-base-buffer))
18786 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18787 (when (display-graphic-p)
18788 (catch 'exit
18789 (save-excursion
18790 (let ((window-start (window-start)) msg)
18791 (save-restriction
18792 (cond
18793 ((or (equal arg '(16))
18794 (and (equal arg '(4))
18795 (org-with-limited-levels (org-before-first-heading-p))))
18796 (if (org-remove-latex-fragment-image-overlays)
18797 (progn (message "LaTeX fragments images removed from buffer")
18798 (throw 'exit nil))
18799 (setq msg "Creating images for buffer...")))
18800 ((equal arg '(4))
18801 (org-with-limited-levels (org-back-to-heading t))
18802 (let ((beg (point))
18803 (end (progn (org-end-of-subtree t) (point))))
18804 (if (org-remove-latex-fragment-image-overlays beg end)
18805 (progn
18806 (message "LaTeX fragment images removed from subtree")
18807 (throw 'exit nil))
18808 (setq msg "Creating images for subtree...")
18809 (narrow-to-region beg end))))
18810 ((let ((datum (org-element-context)))
18811 (when (memq (org-element-type datum)
18812 '(latex-environment latex-fragment))
18813 (let* ((beg (org-element-property :begin datum))
18814 (end (org-element-property :end datum)))
18815 (if (org-remove-latex-fragment-image-overlays beg end)
18816 (progn (message "LaTeX fragment image removed")
18817 (throw 'exit nil))
18818 (narrow-to-region beg end)
18819 (setq msg "Creating image..."))))))
18821 (org-with-limited-levels
18822 (let ((beg (if (org-at-heading-p) (line-beginning-position)
18823 (outline-previous-heading)
18824 (point)))
18825 (end (progn (outline-next-heading) (point))))
18826 (if (org-remove-latex-fragment-image-overlays beg end)
18827 (progn
18828 (message "LaTeX fragment images removed from section")
18829 (throw 'exit nil))
18830 (setq msg "Creating images for section...")
18831 (narrow-to-region beg end))))))
18832 (let ((file (buffer-file-name (buffer-base-buffer))))
18833 (org-format-latex
18834 (concat org-latex-preview-ltxpng-directory
18835 (file-name-sans-extension (file-name-nondirectory file)))
18836 ;; Emacs cannot overlay images from remote hosts.
18837 ;; Create it in `temporary-file-directory' instead.
18838 (if (file-remote-p file) temporary-file-directory
18839 default-directory)
18840 'overlays msg 'forbuffer
18841 org-latex-create-formula-image-program)))
18842 ;; Work around a bug that doesn't restore window's start
18843 ;; when widening back the buffer.
18844 (set-window-start nil window-start)
18845 (message (concat msg "done")))))))
18847 (defun org-format-latex
18848 (prefix &optional dir overlays msg forbuffer processing-type)
18849 "Replace LaTeX fragments with links to an image, and produce images.
18851 When optional argument OVERLAYS is non-nil, display the image on
18852 top of the fragment instead of replacing it.
18854 PROCESSING-TYPE is the conversion method to use, as a symbol.
18856 Some of the options can be changed using the variable
18857 `org-format-latex-options', which see."
18858 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18859 (unless (eq processing-type 'verbatim)
18860 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
18861 (cnt 0)
18862 checkdir-flag)
18863 (goto-char (point-min))
18864 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
18865 (when (and overlays (memq processing-type '(dvipng imagemagick)))
18866 (overlay-recenter (point-max)))
18867 (while (re-search-forward math-regexp nil t)
18868 (unless (and overlays
18869 (eq (get-char-property (point) 'org-overlay-type)
18870 'org-latex-overlay))
18871 (let* ((context (org-element-context))
18872 (type (org-element-type context)))
18873 (when (memq type '(latex-environment latex-fragment))
18874 (let ((block-type (eq type 'latex-environment))
18875 (value (org-element-property :value context))
18876 (beg (org-element-property :begin context))
18877 (end (save-excursion
18878 (goto-char (org-element-property :end context))
18879 (skip-chars-backward " \r\t\n")
18880 (point))))
18881 (case processing-type
18882 (mathjax
18883 ;; Prepare for MathJax processing.
18884 (if (eq (char-after beg) ?$)
18885 (save-excursion
18886 (delete-region beg end)
18887 (insert "\\(" (substring value 1 -1) "\\)"))
18888 (goto-char end)))
18889 ((dvipng imagemagick)
18890 ;; Process to an image.
18891 (incf cnt)
18892 (goto-char beg)
18893 (let* ((face (face-at-point))
18894 ;; Get the colors from the face at point.
18896 (let ((color (plist-get org-format-latex-options
18897 :foreground)))
18898 (if (and forbuffer (eq color 'auto))
18899 (face-attribute face :foreground nil 'default)
18900 color)))
18902 (let ((color (plist-get org-format-latex-options
18903 :background)))
18904 (if (and forbuffer (eq color 'auto))
18905 (face-attribute face :background nil 'default)
18906 color)))
18907 (hash (sha1 (prin1-to-string
18908 (list org-format-latex-header
18909 org-latex-default-packages-alist
18910 org-latex-packages-alist
18911 org-format-latex-options
18912 forbuffer value fg bg))))
18913 (absprefix (expand-file-name prefix dir))
18914 (linkfile (format "%s_%s.png" prefix hash))
18915 (movefile (format "%s_%s.png" absprefix hash))
18916 (sep (and block-type "\n\n"))
18917 (link (concat sep "[[file:" linkfile "]]" sep))
18918 (options
18919 (org-combine-plists
18920 org-format-latex-options
18921 `(:foreground ,fg :background ,bg))))
18922 (when msg (message msg cnt))
18923 (unless checkdir-flag ; Ensure the directory exists.
18924 (setq checkdir-flag t)
18925 (let ((todir (file-name-directory absprefix)))
18926 (unless (file-directory-p todir)
18927 (make-directory todir t))))
18928 (unless (file-exists-p movefile)
18929 (org-create-formula-image
18930 value movefile options forbuffer processing-type))
18931 (if overlays
18932 (progn
18933 (dolist (o (overlays-in beg end))
18934 (when (eq (overlay-get o 'org-overlay-type)
18935 'org-latex-overlay)
18936 (delete-overlay o)))
18937 (let ((ov (make-overlay beg end)))
18938 (overlay-put ov
18939 'org-overlay-type
18940 'org-latex-overlay)
18941 (overlay-put ov 'evaporate t)
18942 (if (featurep 'xemacs)
18943 (progn
18944 (overlay-put ov 'invisible t)
18945 (overlay-put
18946 ov 'end-glyph
18947 (make-glyph
18948 (vector 'png :file movefile))))
18949 (overlay-put
18950 ov 'display
18951 (list 'image
18952 :type 'png
18953 :file movefile
18954 :ascent 'center)))
18955 (push ov org-latex-fragment-image-overlays))
18956 (goto-char end))
18957 (delete-region beg end)
18958 (insert
18959 (org-add-props link
18960 (list 'org-latex-src
18961 (replace-regexp-in-string "\"" "" value)
18962 'org-latex-src-embed-type
18963 (if block-type 'paragraph 'character)))))))
18964 (mathml
18965 ;; Process to MathML.
18966 (unless (org-format-latex-mathml-available-p)
18967 (user-error "LaTeX to MathML converter not configured"))
18968 (incf cnt)
18969 (when msg (message msg cnt))
18970 (goto-char beg)
18971 (delete-region beg end)
18972 (insert (org-format-latex-as-mathml
18973 value block-type prefix dir)))
18974 (otherwise
18975 (error "Unknown conversion type %s for LaTeX fragments"
18976 processing-type)))))))))))
18978 (defun org-create-math-formula (latex-frag &optional mathml-file)
18979 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18980 Use `org-latex-to-mathml-convert-command'. If the conversion is
18981 sucessful, return the portion between \"<math...> </math>\"
18982 elements otherwise return nil. When MATHML-FILE is specified,
18983 write the results in to that file. When invoked as an
18984 interactive command, prompt for LATEX-FRAG, with initial value
18985 set to the current active region and echo the results for user
18986 inspection."
18987 (interactive (list (let ((frag (when (org-region-active-p)
18988 (buffer-substring-no-properties
18989 (region-beginning) (region-end)))))
18990 (read-string "LaTeX Fragment: " frag nil frag))))
18991 (unless latex-frag (user-error "Invalid LaTeX fragment"))
18992 (let* ((tmp-in-file (file-relative-name
18993 (make-temp-name (expand-file-name "ltxmathml-in"))))
18994 (ignore (write-region latex-frag nil tmp-in-file))
18995 (tmp-out-file (file-relative-name
18996 (make-temp-name (expand-file-name "ltxmathml-out"))))
18997 (cmd (format-spec
18998 org-latex-to-mathml-convert-command
18999 `((?j . ,(shell-quote-argument
19000 (expand-file-name org-latex-to-mathml-jar-file)))
19001 (?I . ,(shell-quote-argument tmp-in-file))
19002 (?i . ,latex-frag)
19003 (?o . ,(shell-quote-argument tmp-out-file)))))
19004 mathml shell-command-output)
19005 (when (org-called-interactively-p 'any)
19006 (unless (org-format-latex-mathml-available-p)
19007 (user-error "LaTeX to MathML converter not configured")))
19008 (message "Running %s" cmd)
19009 (setq shell-command-output (shell-command-to-string cmd))
19010 (setq mathml
19011 (when (file-readable-p tmp-out-file)
19012 (with-current-buffer (find-file-noselect tmp-out-file t)
19013 (goto-char (point-min))
19014 (when (re-search-forward
19015 (concat
19016 (regexp-quote
19017 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19018 "[^>]*?>"
19019 "\\(.\\|\n\\)*"
19020 "</math>")
19021 nil t)
19022 (prog1 (match-string 0) (kill-buffer))))))
19023 (cond
19024 (mathml
19025 (setq mathml
19026 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19027 (when mathml-file
19028 (write-region mathml nil mathml-file))
19029 (when (org-called-interactively-p 'any)
19030 (message mathml)))
19031 ((message "LaTeX to MathML conversion failed")
19032 (message shell-command-output)))
19033 (delete-file tmp-in-file)
19034 (when (file-exists-p tmp-out-file)
19035 (delete-file tmp-out-file))
19036 mathml))
19038 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19039 prefix &optional dir)
19040 "Use `org-create-math-formula' but check local cache first."
19041 (let* ((absprefix (expand-file-name prefix dir))
19042 (print-length nil) (print-level nil)
19043 (formula-id (concat
19044 "formula-"
19045 (sha1
19046 (prin1-to-string
19047 (list latex-frag
19048 org-latex-to-mathml-convert-command)))))
19049 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19050 (formula-cache-dir (file-name-directory formula-cache)))
19052 (unless (file-directory-p formula-cache-dir)
19053 (make-directory formula-cache-dir t))
19055 (unless (file-exists-p formula-cache)
19056 (org-create-math-formula latex-frag formula-cache))
19058 (if (file-exists-p formula-cache)
19059 ;; Successful conversion. Return the link to MathML file.
19060 (org-add-props
19061 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19062 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19063 'org-latex-src-embed-type (if latex-frag-type
19064 'paragraph 'character)))
19065 ;; Failed conversion. Return the LaTeX fragment verbatim
19066 latex-frag)))
19068 (defun org-create-formula-image (string tofile options buffer &optional type)
19069 "Create an image from LaTeX source using dvipng or convert.
19070 This function calls either `org-create-formula-image-with-dvipng'
19071 or `org-create-formula-image-with-imagemagick' depending on the
19072 value of `org-latex-create-formula-image-program' or on the value
19073 of the optional TYPE variable.
19075 Note: ultimately these two function should be combined as they
19076 share a good deal of logic."
19077 (org-check-external-command
19078 "latex" "needed to convert LaTeX fragments to images")
19079 (funcall
19080 (case (or type org-latex-create-formula-image-program)
19081 ('dvipng
19082 (org-check-external-command
19083 "dvipng" "needed to convert LaTeX fragments to images")
19084 'org-create-formula-image-with-dvipng)
19085 ('imagemagick
19086 (org-check-external-command
19087 "convert" "you need to install imagemagick")
19088 'org-create-formula-image-with-imagemagick)
19089 (t (error
19090 "Invalid value of `org-latex-create-formula-image-program'")))
19091 string tofile options buffer))
19093 (declare-function org-export-get-backend "ox" (name))
19094 (declare-function org-export--get-global-options "ox" (&optional backend))
19095 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19096 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19097 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19098 (defun org-create-formula--latex-header ()
19099 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19100 (let ((info (org-combine-plists (org-export--get-global-options
19101 (org-export-get-backend 'latex))
19102 (org-export--get-inbuffer-options
19103 (org-export-get-backend 'latex)))))
19104 (org-latex-guess-babel-language
19105 (org-latex-guess-inputenc
19106 (org-splice-latex-header
19107 org-format-latex-header
19108 org-latex-default-packages-alist
19109 org-latex-packages-alist t
19110 (plist-get info :latex-header)))
19111 info)))
19113 (defun org--get-display-dpi ()
19114 "Get the DPI of the display.
19116 Assumes that the display has the same pixel width in the
19117 horizontal and vertical directions."
19118 (if (display-graphic-p)
19119 (round (/ (display-pixel-height)
19120 (/ (display-mm-height) 25.4)))
19121 (error "Attempt to calculate the dpi of a non-graphic display")))
19123 ;; This function borrows from Ganesh Swami's latex2png.el
19124 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19125 "This calls dvipng."
19126 (require 'ox-latex)
19127 (let* ((tmpdir (if (featurep 'xemacs)
19128 (temp-directory)
19129 temporary-file-directory))
19130 (texfilebase (make-temp-name
19131 (expand-file-name "orgtex" tmpdir)))
19132 (texfile (concat texfilebase ".tex"))
19133 (dvifile (concat texfilebase ".dvi"))
19134 (pngfile (concat texfilebase ".png"))
19135 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19136 ;; This assumes that the display has the same pixel width in
19137 ;; the horizontal and vertical directions
19138 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19139 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19140 "Black"))
19141 (bg (or (plist-get options (if buffer :background :html-background))
19142 "Transparent")))
19143 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19144 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19145 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19146 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19147 (let ((latex-header (org-create-formula--latex-header)))
19148 (with-temp-file texfile
19149 (insert latex-header)
19150 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19151 (let ((dir default-directory))
19152 (ignore-errors
19153 (cd tmpdir)
19154 (call-process "latex" nil nil nil texfile))
19155 (cd dir))
19156 (if (not (file-exists-p dvifile))
19157 (progn (message "Failed to create dvi file from %s" texfile) nil)
19158 (ignore-errors
19159 (if (featurep 'xemacs)
19160 (call-process "dvipng" nil nil nil
19161 "-fg" fg "-bg" bg
19162 "-T" "tight"
19163 "-o" pngfile
19164 dvifile)
19165 (call-process "dvipng" nil nil nil
19166 "-fg" fg "-bg" bg
19167 "-D" dpi
19168 ;;"-x" scale "-y" scale
19169 "-T" "tight"
19170 "-o" pngfile
19171 dvifile)))
19172 (if (not (file-exists-p pngfile))
19173 (if org-format-latex-signal-error
19174 (error "Failed to create png file from %s" texfile)
19175 (message "Failed to create png file from %s" texfile)
19176 nil)
19177 ;; Use the requested file name and clean up
19178 (copy-file pngfile tofile 'replace)
19179 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19180 (if (file-exists-p (concat texfilebase e))
19181 (delete-file (concat texfilebase e))))
19182 pngfile))))
19184 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19185 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19186 "This calls convert, which is included into imagemagick."
19187 (require 'ox-latex)
19188 (let* ((tmpdir (if (featurep 'xemacs)
19189 (temp-directory)
19190 temporary-file-directory))
19191 (texfilebase (make-temp-name
19192 (expand-file-name "orgtex" tmpdir)))
19193 (texfile (concat texfilebase ".tex"))
19194 (pdffile (concat texfilebase ".pdf"))
19195 (pngfile (concat texfilebase ".png"))
19196 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19197 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19198 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19199 "black"))
19200 (bg (or (plist-get options (if buffer :background :html-background))
19201 "white")))
19202 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19203 (setq fg (org-latex-color-format fg)))
19204 (if (eq bg 'default) (setq bg (org-latex-color :background))
19205 (setq bg (org-latex-color-format
19206 (if (string= bg "Transparent") "white" bg))))
19207 (let ((latex-header (org-create-formula--latex-header)))
19208 (with-temp-file texfile
19209 (insert latex-header)
19210 (insert "\n\\begin{document}\n"
19211 "\\definecolor{fg}{rgb}{" fg "}\n"
19212 "\\definecolor{bg}{rgb}{" bg "}\n"
19213 "\n\\pagecolor{bg}\n"
19214 "\n{\\color{fg}\n"
19215 string
19216 "\n}\n"
19217 "\n\\end{document}\n")))
19218 (org-latex-compile texfile t)
19219 (if (not (file-exists-p pdffile))
19220 (progn (message "Failed to create pdf file from %s" texfile) nil)
19221 (ignore-errors
19222 (if (featurep 'xemacs)
19223 (call-process "convert" nil nil nil
19224 "-density" "96"
19225 "-trim"
19226 "-antialias"
19227 pdffile
19228 "-quality" "100"
19229 ;; "-sharpen" "0x1.0"
19230 pngfile)
19231 (call-process "convert" nil nil nil
19232 "-density" dpi
19233 "-trim"
19234 "-antialias"
19235 pdffile
19236 "-quality" "100"
19237 ;; "-sharpen" "0x1.0"
19238 pngfile)))
19239 (if (not (file-exists-p pngfile))
19240 (if org-format-latex-signal-error
19241 (error "Failed to create png file from %s" texfile)
19242 (message "Failed to create png file from %s" texfile)
19243 nil)
19244 ;; Use the requested file name and clean up
19245 (copy-file pngfile tofile 'replace)
19246 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19247 (if (file-exists-p (concat texfilebase e))
19248 (delete-file (concat texfilebase e))))
19249 pngfile))))
19251 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19252 "Fill a LaTeX header template TPL.
19253 In the template, the following place holders will be recognized:
19255 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19256 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19257 [PACKAGES] \\usepackage statements for PKG
19258 [NO-PACKAGES] do not include PKG
19259 [EXTRA] the string EXTRA
19260 [NO-EXTRA] do not include EXTRA
19262 For backward compatibility, if both the positive and the negative place
19263 holder is missing, the positive one (without the \"NO-\") will be
19264 assumed to be present at the end of the template.
19265 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19266 EXTRA is a string.
19267 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19268 (let (rpl (end ""))
19269 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19270 (setq rpl (if (or (match-end 1) (not def-pkg))
19271 "" (org-latex-packages-to-string def-pkg snippets-p t))
19272 tpl (replace-match rpl t t tpl))
19273 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19275 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19276 (setq rpl (if (or (match-end 1) (not pkg))
19277 "" (org-latex-packages-to-string pkg snippets-p t))
19278 tpl (replace-match rpl t t tpl))
19279 (if pkg (setq end
19280 (concat end "\n"
19281 (org-latex-packages-to-string pkg snippets-p)))))
19283 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19284 (setq rpl (if (or (match-end 1) (not extra))
19285 "" (concat extra "\n"))
19286 tpl (replace-match rpl t t tpl))
19287 (if (and extra (string-match "\\S-" extra))
19288 (setq end (concat end "\n" extra))))
19290 (if (string-match "\\S-" end)
19291 (concat tpl "\n" end)
19292 tpl)))
19294 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19295 "Turn an alist of packages into a string with the \\usepackage macros."
19296 (setq pkg (mapconcat (lambda(p)
19297 (cond
19298 ((stringp p) p)
19299 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19300 (format "%% Package %s omitted" (cadr p)))
19301 ((equal "" (car p))
19302 (format "\\usepackage{%s}" (cadr p)))
19304 (format "\\usepackage[%s]{%s}"
19305 (car p) (cadr p)))))
19307 "\n"))
19308 (if newline (concat pkg "\n") pkg))
19310 (defun org-dvipng-color (attr)
19311 "Return a RGB color specification for dvipng."
19312 (apply 'format "rgb %s %s %s"
19313 (mapcar 'org-normalize-color
19314 (if (featurep 'xemacs)
19315 (color-rgb-components
19316 (face-property 'default
19317 (cond ((eq attr :foreground) 'foreground)
19318 ((eq attr :background) 'background))))
19319 (color-values (face-attribute 'default attr nil))))))
19321 (defun org-dvipng-color-format (color-name)
19322 "Convert COLOR-NAME to a RGB color value for dvipng."
19323 (apply 'format "rgb %s %s %s"
19324 (mapcar 'org-normalize-color
19325 (color-values color-name))))
19327 (defun org-latex-color (attr)
19328 "Return a RGB color for the LaTeX color package."
19329 (apply 'format "%s,%s,%s"
19330 (mapcar 'org-normalize-color
19331 (if (featurep 'xemacs)
19332 (color-rgb-components
19333 (face-property 'default
19334 (cond ((eq attr :foreground) 'foreground)
19335 ((eq attr :background) 'background))))
19336 (color-values (face-attribute 'default attr nil))))))
19338 (defun org-latex-color-format (color-name)
19339 "Convert COLOR-NAME to a RGB color value."
19340 (apply 'format "%s,%s,%s"
19341 (mapcar 'org-normalize-color
19342 (color-values color-name))))
19344 (defun org-normalize-color (value)
19345 "Return string to be used as color value for an RGB component."
19346 (format "%g" (/ value 65535.0)))
19350 ;; Image display
19352 (defvar org-inline-image-overlays nil)
19353 (make-variable-buffer-local 'org-inline-image-overlays)
19355 (defun org-toggle-inline-images (&optional include-linked)
19356 "Toggle the display of inline images.
19357 INCLUDE-LINKED is passed to `org-display-inline-images'."
19358 (interactive "P")
19359 (if org-inline-image-overlays
19360 (progn
19361 (org-remove-inline-images)
19362 (when (org-called-interactively-p 'interactive)
19363 (message "Inline image display turned off")))
19364 (org-display-inline-images include-linked)
19365 (when (org-called-interactively-p 'interactive)
19366 (message (if org-inline-image-overlays
19367 (format "%d images displayed inline"
19368 (length org-inline-image-overlays))
19369 "No images to display inline")))))
19371 (defun org-redisplay-inline-images ()
19372 "Refresh the display of inline images."
19373 (interactive)
19374 (if (not org-inline-image-overlays)
19375 (org-toggle-inline-images)
19376 (org-toggle-inline-images)
19377 (org-toggle-inline-images)))
19379 (defun org-display-inline-images (&optional include-linked refresh beg end)
19380 "Display inline images.
19382 An inline image is a link which follows either of these
19383 conventions:
19385 1. Its path is a file with an extension matching return value
19386 from `image-file-name-regexp' and it has no contents.
19388 2. Its description consists in a single link of the previous
19389 type.
19391 When optional argument INCLUDE-LINKED is non-nil, also links with
19392 a text description part will be inlined. This can be nice for
19393 a quick look at those images, but it does not reflect what
19394 exported files will look like.
19396 When optional argument REFRESH is non-nil, refresh existing
19397 images between BEG and END. This will create new image displays
19398 only if necessary. BEG and END default to the buffer
19399 boundaries."
19400 (interactive "P")
19401 (when (display-graphic-p)
19402 (unless refresh
19403 (org-remove-inline-images)
19404 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19405 (org-with-wide-buffer
19406 (goto-char (or beg (point-min)))
19407 (let ((case-fold-search t)
19408 (file-extension-re (org-image-file-name-regexp)))
19409 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19410 (let ((link (save-match-data (org-element-context))))
19411 ;; Check if we're at an inline image.
19412 (when (and (equal (org-element-property :type link) "file")
19413 (or include-linked
19414 (not (org-element-property :contents-begin link)))
19415 (let ((parent (org-element-property :parent link)))
19416 (or (not (eq (org-element-type parent) 'link))
19417 (not (cdr (org-element-contents parent)))))
19418 (org-string-match-p file-extension-re
19419 (org-element-property :path link)))
19420 (let ((file (expand-file-name (org-element-property :path link))))
19421 (when (file-exists-p file)
19422 (let ((width
19423 ;; Apply `org-image-actual-width' specifications.
19424 (cond
19425 ((not (image-type-available-p 'imagemagick)) nil)
19426 ((eq org-image-actual-width t) nil)
19427 ((listp org-image-actual-width)
19429 ;; First try to find a width among
19430 ;; attributes associated to the paragraph
19431 ;; containing link.
19432 (let ((paragraph
19433 (let ((e link))
19434 (while (and (setq e (org-element-property
19435 :parent e))
19436 (not (eq (org-element-type e)
19437 'paragraph))))
19438 e)))
19439 (when paragraph
19440 (save-excursion
19441 (goto-char (org-element-property :begin paragraph))
19442 (when
19443 (re-search-forward
19444 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19445 (org-element-property
19446 :post-affiliated paragraph)
19448 (string-to-number (match-string 1))))))
19449 ;; Otherwise, fall-back to provided number.
19450 (car org-image-actual-width)))
19451 ((numberp org-image-actual-width)
19452 org-image-actual-width)))
19453 (old (get-char-property-and-overlay
19454 (org-element-property :begin link)
19455 'org-image-overlay)))
19456 (if (and (car-safe old) refresh)
19457 (image-refresh (overlay-get (cdr old) 'display))
19458 (let ((image (create-image file
19459 (and width 'imagemagick)
19461 :width width)))
19462 (when image
19463 (let* ((link
19464 ;; If inline image is the description
19465 ;; of another link, be sure to
19466 ;; consider the latter as the one to
19467 ;; apply the overlay on.
19468 (let ((parent
19469 (org-element-property :parent link)))
19470 (if (eq (org-element-type parent) 'link)
19471 parent
19472 link)))
19473 (ov (make-overlay
19474 (org-element-property :begin link)
19475 (progn
19476 (goto-char
19477 (org-element-property :end link))
19478 (skip-chars-backward " \t")
19479 (point)))))
19480 (overlay-put ov 'display image)
19481 (overlay-put ov 'face 'default)
19482 (overlay-put ov 'org-image-overlay t)
19483 (overlay-put
19484 ov 'modification-hooks
19485 (list 'org-display-inline-remove-overlay))
19486 (push ov org-inline-image-overlays)))))))))))))))
19488 (define-obsolete-function-alias
19489 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19491 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19492 "Remove inline-display overlay if a corresponding region is modified."
19493 (let ((inhibit-modification-hooks t))
19494 (when (and ov after)
19495 (delete ov org-inline-image-overlays)
19496 (delete-overlay ov))))
19498 (defun org-remove-inline-images ()
19499 "Remove inline display of images."
19500 (interactive)
19501 (mapc 'delete-overlay org-inline-image-overlays)
19502 (setq org-inline-image-overlays nil))
19504 ;;;; Key bindings
19506 ;; Outline functions from `outline-mode-prefix-map'
19507 ;; that can be remapped in Org:
19508 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19509 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19510 (define-key org-mode-map [remap outline-forward-same-level]
19511 'org-forward-heading-same-level)
19512 (define-key org-mode-map [remap outline-backward-same-level]
19513 'org-backward-heading-same-level)
19514 (define-key org-mode-map [remap show-branches]
19515 'org-kill-note-or-show-branches)
19516 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19517 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19518 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19519 (define-key org-mode-map [remap outline-next-visible-heading]
19520 'org-next-visible-heading)
19521 (define-key org-mode-map [remap outline-previous-visible-heading]
19522 'org-previous-visible-heading)
19524 ;; Outline functions from `outline-mode-prefix-map' that can not
19525 ;; be remapped in Org:
19527 ;; - the column "key binding" shows whether the Outline function is still
19528 ;; available in Org mode on the same key that it has been bound to in
19529 ;; Outline mode:
19530 ;; - "overridden": key used for a different functionality in Org mode
19531 ;; - else: key still bound to the same Outline function in Org mode
19533 ;; | Outline function | key binding | Org replacement |
19534 ;; |------------------------------------+-------------+--------------------------|
19535 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19536 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19537 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19538 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19539 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19540 ;; | `show-entry' | overridden | no replacement |
19541 ;; | `show-children' | `C-c C-i' | visibility cycling |
19542 ;; | `show-branches' | `C-c C-k' | still same function |
19543 ;; | `show-subtree' | overridden | visibility cycling |
19544 ;; | `show-all' | overridden | no replacement |
19545 ;; | `hide-subtree' | overridden | visibility cycling |
19546 ;; | `hide-body' | overridden | no replacement |
19547 ;; | `hide-entry' | overridden | visibility cycling |
19548 ;; | `hide-leaves' | overridden | no replacement |
19549 ;; | `hide-sublevels' | overridden | no replacement |
19550 ;; | `hide-other' | overridden | no replacement |
19552 ;; Make `C-c C-x' a prefix key
19553 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19555 ;; TAB key with modifiers
19556 (org-defkey org-mode-map "\C-i" 'org-cycle)
19557 (org-defkey org-mode-map [(tab)] 'org-cycle)
19558 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19559 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19560 ;; The following line is necessary under Suse GNU/Linux
19561 (unless (featurep 'xemacs)
19562 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19563 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19564 (define-key org-mode-map [backtab] 'org-shifttab)
19566 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19567 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19568 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19570 ;; Cursor keys with modifiers
19571 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19572 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19573 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19574 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19576 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19577 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19578 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19579 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19580 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19581 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19583 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19584 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19585 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19586 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19588 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19589 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19590 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19591 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19593 ;; Babel keys
19594 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19595 (mapc (lambda (pair)
19596 (define-key org-babel-map (car pair) (cdr pair)))
19597 org-babel-key-bindings)
19599 ;;; Extra keys for tty access.
19600 ;; We only set them when really needed because otherwise the
19601 ;; menus don't show the simple keys
19603 (when (or org-use-extra-keys
19604 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19605 (not window-system))
19606 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19607 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19608 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19609 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19610 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19611 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19612 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19613 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19614 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19615 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19616 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19617 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19618 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19619 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19620 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19621 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19622 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19623 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19624 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19625 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19626 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19627 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19628 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19629 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19630 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19631 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19632 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19633 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19635 ;; All the other keys
19637 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19638 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19639 (if (boundp 'narrow-map)
19640 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19641 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19642 (if (boundp 'narrow-map)
19643 (org-defkey narrow-map "b" 'org-narrow-to-block)
19644 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19645 (if (boundp 'narrow-map)
19646 (org-defkey narrow-map "e" 'org-narrow-to-element)
19647 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19648 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19649 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19650 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19651 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19652 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19653 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19654 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19655 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19656 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19657 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19658 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19659 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19660 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19661 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19662 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19663 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19664 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19665 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19666 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19667 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19668 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19669 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19670 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19671 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19672 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19673 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19674 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19675 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19676 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19677 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19678 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19679 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19680 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19681 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19682 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19683 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19684 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19685 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19686 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19687 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19688 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19689 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19690 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19691 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19692 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19693 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19694 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19695 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19696 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19697 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19698 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19699 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19700 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19701 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19702 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19703 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19704 (org-defkey org-mode-map "\C-c^" 'org-sort)
19705 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19706 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19707 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19708 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19709 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19710 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19711 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19712 (org-defkey org-mode-map "\C-m" 'org-return)
19713 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19714 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19715 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19716 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19717 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19718 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19719 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19720 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19721 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19722 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19723 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19724 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19725 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19726 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19727 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19728 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19729 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19730 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19731 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19732 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19733 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19734 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19735 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19736 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19737 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19739 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19740 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19741 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19743 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19744 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19745 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19746 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19747 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19748 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19749 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19750 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19751 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19752 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19753 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19754 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19755 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19756 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19757 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19758 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19759 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19760 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19761 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19762 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19763 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19764 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19765 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19767 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19768 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19769 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19770 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19771 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19773 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19775 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19777 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19778 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19780 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19783 (when (featurep 'xemacs)
19784 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19787 (defconst org-speed-commands-default
19789 ("Outline Navigation")
19790 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19791 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19792 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19793 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19794 ("F" . org-next-block)
19795 ("B" . org-previous-block)
19796 ("u" . (org-speed-move-safe 'outline-up-heading))
19797 ("j" . org-goto)
19798 ("g" . (org-refile t))
19799 ("Outline Visibility")
19800 ("c" . org-cycle)
19801 ("C" . org-shifttab)
19802 (" " . org-display-outline-path)
19803 ("s" . org-narrow-to-subtree)
19804 ("=" . org-columns)
19805 ("Outline Structure Editing")
19806 ("U" . org-metaup)
19807 ("D" . org-metadown)
19808 ("r" . org-metaright)
19809 ("l" . org-metaleft)
19810 ("R" . org-shiftmetaright)
19811 ("L" . org-shiftmetaleft)
19812 ("i" . (progn (forward-char 1) (call-interactively
19813 'org-insert-heading-respect-content)))
19814 ("^" . org-sort)
19815 ("w" . org-refile)
19816 ("a" . org-archive-subtree-default-with-confirmation)
19817 ("@" . org-mark-subtree)
19818 ("#" . org-toggle-comment)
19819 ("Clock Commands")
19820 ("I" . org-clock-in)
19821 ("O" . org-clock-out)
19822 ("Meta Data Editing")
19823 ("t" . org-todo)
19824 ("," . (org-priority))
19825 ("0" . (org-priority ?\ ))
19826 ("1" . (org-priority ?A))
19827 ("2" . (org-priority ?B))
19828 ("3" . (org-priority ?C))
19829 (":" . org-set-tags-command)
19830 ("e" . org-set-effort)
19831 ("E" . org-inc-effort)
19832 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19833 (org-entry-put (point) "APPT_WARNTIME" m)))
19834 ("Agenda Views etc")
19835 ("v" . org-agenda)
19836 ("/" . org-sparse-tree)
19837 ("Misc")
19838 ("o" . org-open-at-point)
19839 ("?" . org-speed-command-help)
19840 ("<" . (org-agenda-set-restriction-lock 'subtree))
19841 (">" . (org-agenda-remove-restriction-lock))
19843 "The default speed commands.")
19845 (defun org-print-speed-command (e)
19846 (if (> (length (car e)) 1)
19847 (progn
19848 (princ "\n")
19849 (princ (car e))
19850 (princ "\n")
19851 (princ (make-string (length (car e)) ?-))
19852 (princ "\n"))
19853 (princ (car e))
19854 (princ " ")
19855 (if (symbolp (cdr e))
19856 (princ (symbol-name (cdr e)))
19857 (prin1 (cdr e)))
19858 (princ "\n")))
19860 (defun org-speed-command-help ()
19861 "Show the available speed commands."
19862 (interactive)
19863 (if (not org-use-speed-commands)
19864 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19865 (with-output-to-temp-buffer "*Help*"
19866 (princ "User-defined Speed commands\n===========================\n")
19867 (mapc 'org-print-speed-command org-speed-commands-user)
19868 (princ "\n")
19869 (princ "Built-in Speed commands\n=======================\n")
19870 (mapc 'org-print-speed-command org-speed-commands-default))
19871 (with-current-buffer "*Help*"
19872 (setq truncate-lines t))))
19874 (defun org-speed-move-safe (cmd)
19875 "Execute CMD, but make sure that the cursor always ends up in a headline.
19876 If not, return to the original position and throw an error."
19877 (interactive)
19878 (let ((pos (point)))
19879 (call-interactively cmd)
19880 (unless (and (bolp) (org-at-heading-p))
19881 (goto-char pos)
19882 (error "Boundary reached while executing %s" cmd))))
19884 (defvar org-self-insert-command-undo-counter 0)
19886 (defvar org-table-auto-blank-field) ; defined in org-table.el
19887 (defvar org-speed-command nil)
19889 (define-obsolete-function-alias
19890 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19892 (defun org-speed-command-activate (keys)
19893 "Hook for activating single-letter speed commands.
19894 `org-speed-commands-default' specifies a minimal command set.
19895 Use `org-speed-commands-user' for further customization."
19896 (when (or (and (bolp) (looking-at org-outline-regexp))
19897 (and (functionp org-use-speed-commands)
19898 (funcall org-use-speed-commands)))
19899 (cdr (assoc keys (append org-speed-commands-user
19900 org-speed-commands-default)))))
19902 (define-obsolete-function-alias
19903 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19905 (defun org-babel-speed-command-activate (keys)
19906 "Hook for activating single-letter code block commands."
19907 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19908 (cdr (assoc keys org-babel-key-bindings))))
19910 (defcustom org-speed-command-hook
19911 '(org-speed-command-default-hook org-babel-speed-command-hook)
19912 "Hook for activating speed commands at strategic locations.
19913 Hook functions are called in sequence until a valid handler is
19914 found.
19916 Each hook takes a single argument, a user-pressed command key
19917 which is also a `self-insert-command' from the global map.
19919 Within the hook, examine the cursor position and the command key
19920 and return nil or a valid handler as appropriate. Handler could
19921 be one of an interactive command, a function, or a form.
19923 Set `org-use-speed-commands' to non-nil value to enable this
19924 hook. The default setting is `org-speed-command-activate'."
19925 :group 'org-structure
19926 :version "24.1"
19927 :type 'hook)
19929 (defun org-self-insert-command (N)
19930 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19931 If the cursor is in a table looking at whitespace, the whitespace is
19932 overwritten, and the table is not marked as requiring realignment."
19933 (interactive "p")
19934 (org-check-before-invisible-edit 'insert)
19935 (cond
19936 ((and org-use-speed-commands
19937 (let ((kv (this-command-keys-vector)))
19938 (setq org-speed-command
19939 (run-hook-with-args-until-success
19940 'org-speed-command-hook
19941 (make-string 1 (aref kv (1- (length kv))))))))
19942 (cond
19943 ((commandp org-speed-command)
19944 (setq this-command org-speed-command)
19945 (call-interactively org-speed-command))
19946 ((functionp org-speed-command)
19947 (funcall org-speed-command))
19948 ((and org-speed-command (listp org-speed-command))
19949 (eval org-speed-command))
19950 (t (let (org-use-speed-commands)
19951 (call-interactively 'org-self-insert-command)))))
19952 ((and
19953 (org-table-p)
19954 (progn
19955 ;; check if we blank the field, and if that triggers align
19956 (and (featurep 'org-table) org-table-auto-blank-field
19957 (memq last-command
19958 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
19959 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19960 ;; got extra space, this field does not determine column width
19961 (let (org-table-may-need-update) (org-table-blank-field))
19962 ;; no extra space, this field may determine column width
19963 (org-table-blank-field)))
19965 (eq N 1)
19966 (looking-at "[^|\n]* |"))
19967 (let (org-table-may-need-update)
19968 (goto-char (1- (match-end 0)))
19969 (backward-delete-char 1)
19970 (goto-char (match-beginning 0))
19971 (self-insert-command N)))
19973 (setq org-table-may-need-update t)
19974 (self-insert-command N)
19975 (org-fix-tags-on-the-fly)
19976 (if org-self-insert-cluster-for-undo
19977 (if (not (eq last-command 'org-self-insert-command))
19978 (setq org-self-insert-command-undo-counter 1)
19979 (if (>= org-self-insert-command-undo-counter 20)
19980 (setq org-self-insert-command-undo-counter 1)
19981 (and (> org-self-insert-command-undo-counter 0)
19982 buffer-undo-list (listp buffer-undo-list)
19983 (not (cadr buffer-undo-list)) ; remove nil entry
19984 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19985 (setq org-self-insert-command-undo-counter
19986 (1+ org-self-insert-command-undo-counter))))))))
19988 (defun org-check-before-invisible-edit (kind)
19989 "Check is editing if kind KIND would be dangerous with invisible text around.
19990 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19991 ;; First, try to get out of here as quickly as possible, to reduce overhead
19992 (if (and org-catch-invisible-edits
19993 (or (not (boundp 'visible-mode)) (not visible-mode))
19994 (or (get-char-property (point) 'invisible)
19995 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19996 ;; OK, we need to take a closer look
19997 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19998 (invisible-before-point (if (bobp) nil (get-char-property
19999 (1- (point)) 'invisible)))
20000 (border-and-ok-direction
20002 ;; Check if we are acting predictably before invisible text
20003 (and invisible-at-point (not invisible-before-point)
20004 (memq kind '(insert delete-backward)))
20005 ;; Check if we are acting predictably after invisible text
20006 ;; This works not well, and I have turned it off. It seems
20007 ;; better to always show and stop after invisible text.
20008 ;; (and (not invisible-at-point) invisible-before-point
20009 ;; (memq kind '(insert delete)))
20011 (when (or (memq invisible-at-point '(outline org-hide-block t))
20012 (memq invisible-before-point '(outline org-hide-block t)))
20013 (if (eq org-catch-invisible-edits 'error)
20014 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20015 (if (and org-custom-properties-overlays
20016 (y-or-n-p "Display invisible properties in this buffer? "))
20017 (org-toggle-custom-properties-visibility)
20018 ;; Make the area visible
20019 (save-excursion
20020 (if invisible-before-point
20021 (goto-char (previous-single-char-property-change
20022 (point) 'invisible)))
20023 (show-subtree))
20024 (cond
20025 ((eq org-catch-invisible-edits 'show)
20026 ;; That's it, we do the edit after showing
20027 (message
20028 "Unfolding invisible region around point before editing")
20029 (sit-for 1))
20030 ((and (eq org-catch-invisible-edits 'smart)
20031 border-and-ok-direction)
20032 (message "Unfolding invisible region around point before editing"))
20034 ;; Don't do the edit, make the user repeat it in full visibility
20035 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20037 (defun org-fix-tags-on-the-fly ()
20038 (when (and (equal (char-after (point-at-bol)) ?*)
20039 (org-at-heading-p))
20040 (org-align-tags-here org-tags-column)))
20042 (defun org-delete-backward-char (N)
20043 "Like `delete-backward-char', insert whitespace at field end in tables.
20044 When deleting backwards, in tables this function will insert whitespace in
20045 front of the next \"|\" separator, to keep the table aligned. The table will
20046 still be marked for re-alignment if the field did fill the entire column,
20047 because, in this case the deletion might narrow the column."
20048 (interactive "p")
20049 (save-match-data
20050 (org-check-before-invisible-edit 'delete-backward)
20051 (if (and (org-table-p)
20052 (eq N 1)
20053 (string-match "|" (buffer-substring (point-at-bol) (point)))
20054 (looking-at ".*?|"))
20055 (let ((pos (point))
20056 (noalign (looking-at "[^|\n\r]* |"))
20057 (c org-table-may-need-update))
20058 (backward-delete-char N)
20059 (if (not overwrite-mode)
20060 (progn
20061 (skip-chars-forward "^|")
20062 (insert " ")
20063 (goto-char (1- pos))))
20064 ;; noalign: if there were two spaces at the end, this field
20065 ;; does not determine the width of the column.
20066 (if noalign (setq org-table-may-need-update c)))
20067 (backward-delete-char N)
20068 (org-fix-tags-on-the-fly))))
20070 (defun org-delete-char (N)
20071 "Like `delete-char', but insert whitespace at field end in tables.
20072 When deleting characters, in tables this function will insert whitespace in
20073 front of the next \"|\" separator, to keep the table aligned. The table will
20074 still be marked for re-alignment if the field did fill the entire column,
20075 because, in this case the deletion might narrow the column."
20076 (interactive "p")
20077 (save-match-data
20078 (org-check-before-invisible-edit 'delete)
20079 (if (and (org-table-p)
20080 (not (bolp))
20081 (not (= (char-after) ?|))
20082 (eq N 1))
20083 (if (looking-at ".*?|")
20084 (let ((pos (point))
20085 (noalign (looking-at "[^|\n\r]* |"))
20086 (c org-table-may-need-update))
20087 (replace-match
20088 (concat (substring (match-string 0) 1 -1) " |") nil t)
20089 (goto-char pos)
20090 ;; noalign: if there were two spaces at the end, this field
20091 ;; does not determine the width of the column.
20092 (if noalign (setq org-table-may-need-update c)))
20093 (delete-char N))
20094 (delete-char N)
20095 (org-fix-tags-on-the-fly))))
20097 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20098 (put 'org-self-insert-command 'delete-selection
20099 (lambda ()
20100 (not (run-hook-with-args-until-success
20101 'self-insert-uses-region-functions))))
20102 (put 'orgtbl-self-insert-command 'delete-selection
20103 (lambda ()
20104 (not (run-hook-with-args-until-success
20105 'self-insert-uses-region-functions))))
20106 (put 'org-delete-char 'delete-selection 'supersede)
20107 (put 'org-delete-backward-char 'delete-selection 'supersede)
20108 (put 'org-yank 'delete-selection 'yank)
20110 ;; Make `flyspell-mode' delay after some commands
20111 (put 'org-self-insert-command 'flyspell-delayed t)
20112 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20113 (put 'org-delete-char 'flyspell-delayed t)
20114 (put 'org-delete-backward-char 'flyspell-delayed t)
20116 ;; Make pabbrev-mode expand after org-mode commands
20117 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20118 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20120 (defun org-remap (map &rest commands)
20121 "In MAP, remap the functions given in COMMANDS.
20122 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20123 (let (new old)
20124 (while commands
20125 (setq old (pop commands) new (pop commands))
20126 (if (fboundp 'command-remapping)
20127 (org-defkey map (vector 'remap old) new)
20128 (substitute-key-definition old new map global-map)))))
20130 (defun org-transpose-words ()
20131 "Transpose words for Org.
20132 This uses the `org-mode-transpose-word-syntax-table' syntax
20133 table, which interprets characters in `org-emphasis-alist' as
20134 word constituents."
20135 (interactive)
20136 (with-syntax-table org-mode-transpose-word-syntax-table
20137 (call-interactively 'transpose-words)))
20138 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20140 (when (eq org-enable-table-editor 'optimized)
20141 ;; If the user wants maximum table support, we need to hijack
20142 ;; some standard editing functions
20143 (org-remap org-mode-map
20144 'self-insert-command 'org-self-insert-command
20145 'delete-char 'org-delete-char
20146 'delete-backward-char 'org-delete-backward-char)
20147 (org-defkey org-mode-map "|" 'org-force-self-insert))
20149 (defvar org-ctrl-c-ctrl-c-hook nil
20150 "Hook for functions attaching themselves to `C-c C-c'.
20152 This can be used to add additional functionality to the C-c C-c
20153 key which executes context-dependent commands. This hook is run
20154 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20155 run after the last test.
20157 Each function will be called with no arguments. The function
20158 must check if the context is appropriate for it to act. If yes,
20159 it should do its thing and then return a non-nil value. If the
20160 context is wrong, just do nothing and return nil.")
20162 (defvar org-ctrl-c-ctrl-c-final-hook nil
20163 "Hook for functions attaching themselves to `C-c C-c'.
20165 This can be used to add additional functionality to the C-c C-c
20166 key which executes context-dependent commands. This hook is run
20167 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20168 before the first test.
20170 Each function will be called with no arguments. The function
20171 must check if the context is appropriate for it to act. If yes,
20172 it should do its thing and then return a non-nil value. If the
20173 context is wrong, just do nothing and return nil.")
20175 (defvar org-tab-first-hook nil
20176 "Hook for functions to attach themselves to TAB.
20177 See `org-ctrl-c-ctrl-c-hook' for more information.
20178 This hook runs as the first action when TAB is pressed, even before
20179 `org-cycle' messes around with the `outline-regexp' to cater for
20180 inline tasks and plain list item folding.
20181 If any function in this hook returns t, any other actions that
20182 would have been caused by TAB (such as table field motion or visibility
20183 cycling) will not occur.")
20185 (defvar org-tab-after-check-for-table-hook nil
20186 "Hook for functions to attach themselves to TAB.
20187 See `org-ctrl-c-ctrl-c-hook' for more information.
20188 This hook runs after it has been established that the cursor is not in a
20189 table, but before checking if the cursor is in a headline or if global cycling
20190 should be done.
20191 If any function in this hook returns t, not other actions like visibility
20192 cycling will be done.")
20194 (defvar org-tab-after-check-for-cycling-hook nil
20195 "Hook for functions to attach themselves to TAB.
20196 See `org-ctrl-c-ctrl-c-hook' for more information.
20197 This hook runs after it has been established that not table field motion and
20198 not visibility should be done because of current context. This is probably
20199 the place where a package like yasnippets can hook in.")
20201 (defvar org-tab-before-tab-emulation-hook nil
20202 "Hook for functions to attach themselves to TAB.
20203 See `org-ctrl-c-ctrl-c-hook' for more information.
20204 This hook runs after every other options for TAB have been exhausted, but
20205 before indentation and \t insertion takes place.")
20207 (defvar org-metaleft-hook nil
20208 "Hook for functions attaching themselves to `M-left'.
20209 See `org-ctrl-c-ctrl-c-hook' for more information.")
20210 (defvar org-metaright-hook nil
20211 "Hook for functions attaching themselves to `M-right'.
20212 See `org-ctrl-c-ctrl-c-hook' for more information.")
20213 (defvar org-metaup-hook nil
20214 "Hook for functions attaching themselves to `M-up'.
20215 See `org-ctrl-c-ctrl-c-hook' for more information.")
20216 (defvar org-metadown-hook nil
20217 "Hook for functions attaching themselves to `M-down'.
20218 See `org-ctrl-c-ctrl-c-hook' for more information.")
20219 (defvar org-shiftmetaleft-hook nil
20220 "Hook for functions attaching themselves to `M-S-left'.
20221 See `org-ctrl-c-ctrl-c-hook' for more information.")
20222 (defvar org-shiftmetaright-hook nil
20223 "Hook for functions attaching themselves to `M-S-right'.
20224 See `org-ctrl-c-ctrl-c-hook' for more information.")
20225 (defvar org-shiftmetaup-hook nil
20226 "Hook for functions attaching themselves to `M-S-up'.
20227 See `org-ctrl-c-ctrl-c-hook' for more information.")
20228 (defvar org-shiftmetadown-hook nil
20229 "Hook for functions attaching themselves to `M-S-down'.
20230 See `org-ctrl-c-ctrl-c-hook' for more information.")
20231 (defvar org-metareturn-hook nil
20232 "Hook for functions attaching themselves to `M-RET'.
20233 See `org-ctrl-c-ctrl-c-hook' for more information.")
20234 (defvar org-shiftup-hook nil
20235 "Hook for functions attaching themselves to `S-up'.
20236 See `org-ctrl-c-ctrl-c-hook' for more information.")
20237 (defvar org-shiftup-final-hook nil
20238 "Hook for functions attaching themselves to `S-up'.
20239 This one runs after all other options except shift-select have been excluded.
20240 See `org-ctrl-c-ctrl-c-hook' for more information.")
20241 (defvar org-shiftdown-hook nil
20242 "Hook for functions attaching themselves to `S-down'.
20243 See `org-ctrl-c-ctrl-c-hook' for more information.")
20244 (defvar org-shiftdown-final-hook nil
20245 "Hook for functions attaching themselves to `S-down'.
20246 This one runs after all other options except shift-select have been excluded.
20247 See `org-ctrl-c-ctrl-c-hook' for more information.")
20248 (defvar org-shiftleft-hook nil
20249 "Hook for functions attaching themselves to `S-left'.
20250 See `org-ctrl-c-ctrl-c-hook' for more information.")
20251 (defvar org-shiftleft-final-hook nil
20252 "Hook for functions attaching themselves to `S-left'.
20253 This one runs after all other options except shift-select have been excluded.
20254 See `org-ctrl-c-ctrl-c-hook' for more information.")
20255 (defvar org-shiftright-hook nil
20256 "Hook for functions attaching themselves to `S-right'.
20257 See `org-ctrl-c-ctrl-c-hook' for more information.")
20258 (defvar org-shiftright-final-hook nil
20259 "Hook for functions attaching themselves to `S-right'.
20260 This one runs after all other options except shift-select have been excluded.
20261 See `org-ctrl-c-ctrl-c-hook' for more information.")
20263 (defun org-modifier-cursor-error ()
20264 "Throw an error, a modified cursor command was applied in wrong context."
20265 (user-error "This command is active in special context like tables, headlines or items"))
20267 (defun org-shiftselect-error ()
20268 "Throw an error because Shift-Cursor command was applied in wrong context."
20269 (if (and (boundp 'shift-select-mode) shift-select-mode)
20270 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20271 (user-error "This command works only in special context like headlines or timestamps")))
20273 (defun org-call-for-shift-select (cmd)
20274 (let ((this-command-keys-shift-translated t))
20275 (call-interactively cmd)))
20277 (defun org-shifttab (&optional arg)
20278 "Global visibility cycling or move to previous table field.
20279 Call `org-table-previous-field' within a table.
20280 When ARG is nil, cycle globally through visibility states.
20281 When ARG is a numeric prefix, show contents of this level."
20282 (interactive "P")
20283 (cond
20284 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20285 ((integerp arg)
20286 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20287 (message "Content view to level: %d" arg)
20288 (org-content (prefix-numeric-value arg2))
20289 (org-cycle-show-empty-lines t)
20290 (setq org-cycle-global-status 'overview)))
20291 (t (call-interactively 'org-global-cycle))))
20293 (defun org-shiftmetaleft ()
20294 "Promote subtree or delete table column.
20295 Calls `org-promote-subtree', `org-outdent-item-tree', or
20296 `org-table-delete-column', depending on context. See the
20297 individual commands for more information."
20298 (interactive)
20299 (cond
20300 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20301 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20302 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20303 ((if (not (org-region-active-p)) (org-at-item-p)
20304 (save-excursion (goto-char (region-beginning))
20305 (org-at-item-p)))
20306 (call-interactively 'org-outdent-item-tree))
20307 (t (org-modifier-cursor-error))))
20309 (defun org-shiftmetaright ()
20310 "Demote subtree or insert table column.
20311 Calls `org-demote-subtree', `org-indent-item-tree', or
20312 `org-table-insert-column', depending on context. See the
20313 individual commands for more information."
20314 (interactive)
20315 (cond
20316 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20317 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20318 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20319 ((if (not (org-region-active-p)) (org-at-item-p)
20320 (save-excursion (goto-char (region-beginning))
20321 (org-at-item-p)))
20322 (call-interactively 'org-indent-item-tree))
20323 (t (org-modifier-cursor-error))))
20325 (defun org-shiftmetaup (&optional arg)
20326 "Drag the line at point up.
20327 In a table, kill the current row.
20328 On a clock timestamp, update the value of the timestamp like `S-<up>'
20329 but also adjust the previous clocked item in the clock history.
20330 Everywhere else, drag the line at point up."
20331 (interactive "P")
20332 (cond
20333 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20334 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20335 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20336 (call-interactively 'org-timestamp-up)))
20337 (t (call-interactively 'org-drag-line-backward))))
20339 (defun org-shiftmetadown (&optional arg)
20340 "Drag the line at point down.
20341 In a table, insert an empty row at the current line.
20342 On a clock timestamp, update the value of the timestamp like `S-<down>'
20343 but also adjust the previous clocked item in the clock history.
20344 Everywhere else, drag the line at point down."
20345 (interactive "P")
20346 (cond
20347 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20348 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20349 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20350 (call-interactively 'org-timestamp-down)))
20351 (t (call-interactively 'org-drag-line-forward))))
20353 (defsubst org-hidden-tree-error ()
20354 (user-error
20355 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20357 (defun org-metaleft (&optional arg)
20358 "Promote heading or move table column to left.
20359 Calls `org-do-promote' or `org-table-move-column', depending on context.
20360 With no specific context, calls the Emacs default `backward-word'.
20361 See the individual commands for more information."
20362 (interactive "P")
20363 (cond
20364 ((run-hook-with-args-until-success 'org-metaleft-hook))
20365 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20366 ((org-with-limited-levels
20367 (or (org-at-heading-p)
20368 (and (org-region-active-p)
20369 (save-excursion
20370 (goto-char (region-beginning))
20371 (org-at-heading-p)))))
20372 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20373 (call-interactively 'org-do-promote))
20374 ;; At an inline task.
20375 ((org-at-heading-p)
20376 (call-interactively 'org-inlinetask-promote))
20377 ((or (org-at-item-p)
20378 (and (org-region-active-p)
20379 (save-excursion
20380 (goto-char (region-beginning))
20381 (org-at-item-p))))
20382 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20383 (call-interactively 'org-outdent-item))
20384 (t (call-interactively 'backward-word))))
20386 (defun org-metaright (&optional arg)
20387 "Demote a subtree, a list item or move table column to right.
20388 In front of a drawer or a block keyword, indent it correctly.
20389 With no specific context, calls the Emacs default `forward-word'.
20390 See the individual commands for more information."
20391 (interactive "P")
20392 (cond
20393 ((run-hook-with-args-until-success 'org-metaright-hook))
20394 ((org-at-table-p) (call-interactively 'org-table-move-column))
20395 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20396 ((org-at-block-p) (call-interactively 'org-indent-block))
20397 ((org-with-limited-levels
20398 (or (org-at-heading-p)
20399 (and (org-region-active-p)
20400 (save-excursion
20401 (goto-char (region-beginning))
20402 (org-at-heading-p)))))
20403 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20404 (call-interactively 'org-do-demote))
20405 ;; At an inline task.
20406 ((org-at-heading-p)
20407 (call-interactively 'org-inlinetask-demote))
20408 ((or (org-at-item-p)
20409 (and (org-region-active-p)
20410 (save-excursion
20411 (goto-char (region-beginning))
20412 (org-at-item-p))))
20413 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20414 (call-interactively 'org-indent-item))
20415 (t (call-interactively 'forward-word))))
20417 (defun org-check-for-hidden (what)
20418 "Check if there are hidden headlines/items in the current visual line.
20419 WHAT can be either `headlines' or `items'. If the current line is
20420 an outline or item heading and it has a folded subtree below it,
20421 this function returns t, nil otherwise."
20422 (let ((re (cond
20423 ((eq what 'headlines) org-outline-regexp-bol)
20424 ((eq what 'items) (org-item-beginning-re))
20425 (t (error "This should not happen"))))
20426 beg end)
20427 (save-excursion
20428 (catch 'exit
20429 (unless (org-region-active-p)
20430 (setq beg (point-at-bol))
20431 (beginning-of-line 2)
20432 (while (and (not (eobp)) ;; this is like `next-line'
20433 (get-char-property (1- (point)) 'invisible))
20434 (beginning-of-line 2))
20435 (setq end (point))
20436 (goto-char beg)
20437 (goto-char (point-at-eol))
20438 (setq end (max end (point)))
20439 (while (re-search-forward re end t)
20440 (if (get-char-property (match-beginning 0) 'invisible)
20441 (throw 'exit t))))
20442 nil))))
20444 (defun org-metaup (&optional arg)
20445 "Move subtree up or move table row up.
20446 Calls `org-move-subtree-up' or `org-table-move-row' or
20447 `org-move-item-up', depending on context. See the individual commands
20448 for more information."
20449 (interactive "P")
20450 (cond
20451 ((run-hook-with-args-until-success 'org-metaup-hook))
20452 ((org-region-active-p)
20453 (let* ((a (min (region-beginning) (region-end)))
20454 (b (1- (max (region-beginning) (region-end))))
20455 (c (save-excursion (goto-char a)
20456 (move-beginning-of-line 0)))
20457 (d (save-excursion (goto-char a)
20458 (move-end-of-line 0) (point))))
20459 (transpose-regions a b c d)
20460 (goto-char c)))
20461 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20462 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20463 ((org-at-item-p) (call-interactively 'org-move-item-up))
20464 (t (org-drag-element-backward))))
20466 (defun org-metadown (&optional arg)
20467 "Move subtree down or move table row down.
20468 Calls `org-move-subtree-down' or `org-table-move-row' or
20469 `org-move-item-down', depending on context. See the individual
20470 commands for more information."
20471 (interactive "P")
20472 (cond
20473 ((run-hook-with-args-until-success 'org-metadown-hook))
20474 ((org-region-active-p)
20475 (let* ((a (min (region-beginning) (region-end)))
20476 (b (max (region-beginning) (region-end)))
20477 (c (save-excursion (goto-char b)
20478 (move-beginning-of-line 1)))
20479 (d (save-excursion (goto-char b)
20480 (move-end-of-line 1) (1+ (point)))))
20481 (transpose-regions a b c d)
20482 (goto-char d)))
20483 ((org-at-table-p) (call-interactively 'org-table-move-row))
20484 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20485 ((org-at-item-p) (call-interactively 'org-move-item-down))
20486 (t (org-drag-element-forward))))
20488 (defun org-shiftup (&optional arg)
20489 "Increase item in timestamp or increase priority of current headline.
20490 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20491 depending on context. See the individual commands for more information."
20492 (interactive "P")
20493 (cond
20494 ((run-hook-with-args-until-success 'org-shiftup-hook))
20495 ((and org-support-shift-select (org-region-active-p))
20496 (org-call-for-shift-select 'previous-line))
20497 ((org-at-timestamp-p t)
20498 (call-interactively (if org-edit-timestamp-down-means-later
20499 'org-timestamp-down 'org-timestamp-up)))
20500 ((and (not (eq org-support-shift-select 'always))
20501 org-enable-priority-commands
20502 (org-at-heading-p))
20503 (call-interactively 'org-priority-up))
20504 ((and (not org-support-shift-select) (org-at-item-p))
20505 (call-interactively 'org-previous-item))
20506 ((org-clocktable-try-shift 'up arg))
20507 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20508 (org-support-shift-select
20509 (org-call-for-shift-select 'previous-line))
20510 (t (org-shiftselect-error))))
20512 (defun org-shiftdown (&optional arg)
20513 "Decrease item in timestamp or decrease priority of current headline.
20514 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20515 depending on context. See the individual commands for more information."
20516 (interactive "P")
20517 (cond
20518 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20519 ((and org-support-shift-select (org-region-active-p))
20520 (org-call-for-shift-select 'next-line))
20521 ((org-at-timestamp-p t)
20522 (call-interactively (if org-edit-timestamp-down-means-later
20523 'org-timestamp-up 'org-timestamp-down)))
20524 ((and (not (eq org-support-shift-select 'always))
20525 org-enable-priority-commands
20526 (org-at-heading-p))
20527 (call-interactively 'org-priority-down))
20528 ((and (not org-support-shift-select) (org-at-item-p))
20529 (call-interactively 'org-next-item))
20530 ((org-clocktable-try-shift 'down arg))
20531 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20532 (org-support-shift-select
20533 (org-call-for-shift-select 'next-line))
20534 (t (org-shiftselect-error))))
20536 (defun org-shiftright (&optional arg)
20537 "Cycle the thing at point or in the current line, depending on context.
20538 Depending on context, this does one of the following:
20540 - switch a timestamp at point one day into the future
20541 - on a headline, switch to the next TODO keyword.
20542 - on an item, switch entire list to the next bullet type
20543 - on a property line, switch to the next allowed value
20544 - on a clocktable definition line, move time block into the future"
20545 (interactive "P")
20546 (cond
20547 ((run-hook-with-args-until-success 'org-shiftright-hook))
20548 ((and org-support-shift-select (org-region-active-p))
20549 (org-call-for-shift-select 'forward-char))
20550 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20551 ((and (not (eq org-support-shift-select 'always))
20552 (org-at-heading-p))
20553 (let ((org-inhibit-logging
20554 (not org-treat-S-cursor-todo-selection-as-state-change))
20555 (org-inhibit-blocking
20556 (not org-treat-S-cursor-todo-selection-as-state-change)))
20557 (org-call-with-arg 'org-todo 'right)))
20558 ((or (and org-support-shift-select
20559 (not (eq org-support-shift-select 'always))
20560 (org-at-item-bullet-p))
20561 (and (not org-support-shift-select) (org-at-item-p)))
20562 (org-call-with-arg 'org-cycle-list-bullet nil))
20563 ((and (not (eq org-support-shift-select 'always))
20564 (org-at-property-p))
20565 (call-interactively 'org-property-next-allowed-value))
20566 ((org-clocktable-try-shift 'right arg))
20567 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20568 (org-support-shift-select
20569 (org-call-for-shift-select 'forward-char))
20570 (t (org-shiftselect-error))))
20572 (defun org-shiftleft (&optional arg)
20573 "Cycle the thing at point or in the current line, depending on context.
20574 Depending on context, this does one of the following:
20576 - switch a timestamp at point one day into the past
20577 - on a headline, switch to the previous TODO keyword.
20578 - on an item, switch entire list to the previous bullet type
20579 - on a property line, switch to the previous allowed value
20580 - on a clocktable definition line, move time block into the past"
20581 (interactive "P")
20582 (cond
20583 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20584 ((and org-support-shift-select (org-region-active-p))
20585 (org-call-for-shift-select 'backward-char))
20586 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20587 ((and (not (eq org-support-shift-select 'always))
20588 (org-at-heading-p))
20589 (let ((org-inhibit-logging
20590 (not org-treat-S-cursor-todo-selection-as-state-change))
20591 (org-inhibit-blocking
20592 (not org-treat-S-cursor-todo-selection-as-state-change)))
20593 (org-call-with-arg 'org-todo 'left)))
20594 ((or (and org-support-shift-select
20595 (not (eq org-support-shift-select 'always))
20596 (org-at-item-bullet-p))
20597 (and (not org-support-shift-select) (org-at-item-p)))
20598 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20599 ((and (not (eq org-support-shift-select 'always))
20600 (org-at-property-p))
20601 (call-interactively 'org-property-previous-allowed-value))
20602 ((org-clocktable-try-shift 'left arg))
20603 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20604 (org-support-shift-select
20605 (org-call-for-shift-select 'backward-char))
20606 (t (org-shiftselect-error))))
20608 (defun org-shiftcontrolright ()
20609 "Switch to next TODO set."
20610 (interactive)
20611 (cond
20612 ((and org-support-shift-select (org-region-active-p))
20613 (org-call-for-shift-select 'forward-word))
20614 ((and (not (eq org-support-shift-select 'always))
20615 (org-at-heading-p))
20616 (org-call-with-arg 'org-todo 'nextset))
20617 (org-support-shift-select
20618 (org-call-for-shift-select 'forward-word))
20619 (t (org-shiftselect-error))))
20621 (defun org-shiftcontrolleft ()
20622 "Switch to previous TODO set."
20623 (interactive)
20624 (cond
20625 ((and org-support-shift-select (org-region-active-p))
20626 (org-call-for-shift-select 'backward-word))
20627 ((and (not (eq org-support-shift-select 'always))
20628 (org-at-heading-p))
20629 (org-call-with-arg 'org-todo 'previousset))
20630 (org-support-shift-select
20631 (org-call-for-shift-select 'backward-word))
20632 (t (org-shiftselect-error))))
20634 (defun org-shiftcontrolup (&optional n)
20635 "Change timestamps synchronously up in CLOCK log lines.
20636 Optional argument N tells to change by that many units."
20637 (interactive "P")
20638 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20639 (let (org-support-shift-select)
20640 (org-clock-timestamps-up n))
20641 (user-error "Not at a clock log")))
20643 (defun org-shiftcontroldown (&optional n)
20644 "Change timestamps synchronously down in CLOCK log lines.
20645 Optional argument N tells to change by that many units."
20646 (interactive "P")
20647 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20648 (let (org-support-shift-select)
20649 (org-clock-timestamps-down n))
20650 (user-error "Not at a clock log")))
20652 (defun org-increase-number-at-point (&optional inc)
20653 "Increment the number at point.
20654 With an optional prefix numeric argument INC, increment using
20655 this numeric value."
20656 (interactive "p")
20657 (if (not (number-at-point))
20658 (user-error "Not on a number")
20659 (unless inc (setq inc 1))
20660 (let ((pos (point))
20661 (beg (skip-chars-backward "-+^/*0-9eE."))
20662 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20663 (setq nap (buffer-substring-no-properties
20664 (+ pos beg) (+ pos beg end)))
20665 (delete-region (+ pos beg) (+ pos beg end))
20666 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20667 (when (org-at-table-p)
20668 (org-table-align)
20669 (org-table-end-of-field 1))))
20671 (defun org-decrease-number-at-point (&optional inc)
20672 "Decrement the number at point.
20673 With an optional prefix numeric argument INC, decrement using
20674 this numeric value."
20675 (interactive "p")
20676 (org-increase-number-at-point (- inc)))
20678 (defun org-ctrl-c-ret ()
20679 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20680 (interactive)
20681 (cond
20682 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20683 (t (call-interactively 'org-insert-heading))))
20685 (defun org-find-visible ()
20686 (let ((s (point)))
20687 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20688 (get-char-property s 'invisible)))
20690 (defun org-find-invisible ()
20691 (let ((s (point)))
20692 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20693 (not (get-char-property s 'invisible))))
20696 (defun org-copy-visible (beg end)
20697 "Copy the visible parts of the region."
20698 (interactive "r")
20699 (let (snippets s)
20700 (save-excursion
20701 (save-restriction
20702 (narrow-to-region beg end)
20703 (setq s (goto-char (point-min)))
20704 (while (not (= (point) (point-max)))
20705 (goto-char (org-find-invisible))
20706 (push (buffer-substring s (point)) snippets)
20707 (setq s (goto-char (org-find-visible))))))
20708 (kill-new (apply 'concat (nreverse snippets)))))
20710 (defun org-copy-special ()
20711 "Copy region in table or copy current subtree.
20712 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20713 See the individual commands for more information."
20714 (interactive)
20715 (call-interactively
20716 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20718 (defun org-cut-special ()
20719 "Cut region in table or cut current subtree.
20720 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20721 See the individual commands for more information."
20722 (interactive)
20723 (call-interactively
20724 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20726 (defun org-paste-special (arg)
20727 "Paste rectangular region into table, or past subtree relative to level.
20728 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20729 See the individual commands for more information."
20730 (interactive "P")
20731 (if (org-at-table-p)
20732 (org-table-paste-rectangle)
20733 (org-paste-subtree arg)))
20735 (defsubst org-in-fixed-width-region-p ()
20736 "Is point in a fixed-width region?"
20737 (save-match-data
20738 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20740 (defun org-edit-special (&optional arg)
20741 "Call a special editor for the element at point.
20742 When at a table, call the formula editor with `org-table-edit-formulas'.
20743 When in a source code block, call `org-edit-src-code'.
20744 When in a fixed-width region, call `org-edit-fixed-width-region'.
20745 When in an export block, call `org-edit-export-block'.
20746 When at an #+INCLUDE keyword, visit the included file.
20747 On a link, call `ffap' to visit the link at point.
20748 Otherwise, return a user error."
20749 (interactive "P")
20750 (let ((element (org-element-at-point)))
20751 (assert (not buffer-read-only) nil
20752 "Buffer is read-only: %s" (buffer-name))
20753 (case (org-element-type element)
20754 (src-block
20755 (if (not arg) (org-edit-src-code)
20756 (let* ((info (org-babel-get-src-block-info))
20757 (lang (nth 0 info))
20758 (params (nth 2 info))
20759 (session (cdr (assq :session params))))
20760 (if (not session) (org-edit-src-code)
20761 ;; At a src-block with a session and function called with
20762 ;; an ARG: switch to the buffer related to the inferior
20763 ;; process.
20764 (switch-to-buffer
20765 (funcall (intern (concat "org-babel-prep-session:" lang))
20766 session params))))))
20767 (keyword
20768 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20769 (org-open-link-from-string
20770 (format "[[%s]]"
20771 (expand-file-name
20772 (let ((value (org-element-property :value element)))
20773 (cond ((not (org-string-nw-p value))
20774 (user-error "No file to edit"))
20775 ((string-match "\\`\"\\(.*?\\)\"" value)
20776 (match-string 1 value))
20777 ((string-match "\\`[^ \t\"]\\S-*" value)
20778 (match-string 0 value))
20779 (t (user-error "No valid file specified")))))))
20780 (user-error "No special environment to edit here")))
20781 (table
20782 (if (eq (org-element-property :type element) 'table.el)
20783 (org-edit-table.el)
20784 (call-interactively 'org-table-edit-formulas)))
20785 ;; Only Org tables contain `table-row' type elements.
20786 (table-row (call-interactively 'org-table-edit-formulas))
20787 ((example-block src-block) (org-edit-src-code))
20788 (export-block (org-edit-export-block))
20789 (fixed-width (org-edit-fixed-width-region))
20790 (otherwise
20791 ;; No notable element at point. Though, we may be at a link,
20792 ;; which is an object. Thus, scan deeper.
20793 (if (eq (org-element-type (org-element-context element)) 'link)
20794 (call-interactively 'ffap)
20795 (user-error "No special environment to edit here"))))))
20797 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20798 (defun org-ctrl-c-ctrl-c (&optional arg)
20799 "Set tags in headline, or update according to changed information at point.
20801 This command does many different things, depending on context:
20803 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20804 this is what we do.
20806 - If the cursor is on a statistics cookie, update it.
20808 - If the cursor is in a headline, prompt for tags and insert them
20809 into the current line, aligned to `org-tags-column'. When called
20810 with prefix arg, realign all tags in the current buffer.
20812 - If the cursor is in one of the special #+KEYWORD lines, this
20813 triggers scanning the buffer for these lines and updating the
20814 information.
20816 - If the cursor is inside a table, realign the table. This command
20817 works even if the automatic table editor has been turned off.
20819 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20820 the entire table.
20822 - If the cursor is at a footnote reference or definition, jump to
20823 the corresponding definition or references, respectively.
20825 - If the cursor is a the beginning of a dynamic block, update it.
20827 - If the current buffer is a capture buffer, close note and file it.
20829 - If the cursor is on a <<<target>>>, update radio targets and
20830 corresponding links in this buffer.
20832 - If the cursor is on a numbered item in a plain list, renumber the
20833 ordered list.
20835 - If the cursor is on a checkbox, toggle it.
20837 - If the cursor is on a code block, evaluate it. The variable
20838 `org-confirm-babel-evaluate' can be used to control prompting
20839 before code block evaluation, by default every code block
20840 evaluation requires confirmation. Code block evaluation can be
20841 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20842 (interactive "P")
20843 (cond
20844 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20845 org-occur-highlights)
20846 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20847 (org-remove-occur-highlights)
20848 (message "Temporary highlights/overlays removed from current buffer"))
20849 ((and (local-variable-p 'org-finish-function (current-buffer))
20850 (fboundp org-finish-function))
20851 (funcall org-finish-function))
20852 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20854 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20855 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20856 (user-error "C-c C-c can do nothing useful at this location"))
20857 (let* ((context (org-element-context))
20858 (type (org-element-type context)))
20859 (case type
20860 ;; When at a link, act according to the parent instead.
20861 (link (setq context (org-element-property :parent context))
20862 (setq type (org-element-type context)))
20863 ;; Unsupported object types: refer to the first supported
20864 ;; element or object containing it.
20865 ((bold code entity export-snippet inline-babel-call inline-src-block
20866 italic latex-fragment line-break macro strike-through subscript
20867 superscript underline verbatim)
20868 (setq context
20869 (org-element-lineage
20870 context '(radio-target paragraph verse-block table-cell)))))
20871 ;; For convenience: at the first line of a paragraph on the
20872 ;; same line as an item, apply function on that item instead.
20873 (when (eq type 'paragraph)
20874 (let ((parent (org-element-property :parent context)))
20875 (when (and (eq (org-element-type parent) 'item)
20876 (= (line-beginning-position)
20877 (org-element-property :begin parent)))
20878 (setq context parent type 'item))))
20879 ;; Act according to type of element or object at point.
20880 (case type
20881 (clock (org-clock-update-time-maybe))
20882 (dynamic-block
20883 (save-excursion
20884 (goto-char (org-element-property :post-affiliated context))
20885 (org-update-dblock)))
20886 (footnote-definition
20887 (goto-char (org-element-property :post-affiliated context))
20888 (call-interactively 'org-footnote-action))
20889 (footnote-reference (call-interactively 'org-footnote-action))
20890 ((headline inlinetask)
20891 (save-excursion (goto-char (org-element-property :begin context))
20892 (call-interactively 'org-set-tags)))
20893 (item
20894 ;; At an item: a double C-u set checkbox to "[-]"
20895 ;; unconditionally, whereas a single one will toggle its
20896 ;; presence. Without an universal argument, if the item
20897 ;; has a checkbox, toggle it. Otherwise repair the list.
20898 (let* ((box (org-element-property :checkbox context))
20899 (struct (org-element-property :structure context))
20900 (old-struct (copy-tree struct))
20901 (parents (org-list-parents-alist struct))
20902 (prevs (org-list-prevs-alist struct))
20903 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20904 (org-list-set-checkbox
20905 (org-element-property :begin context) struct
20906 (cond ((equal arg '(16)) "[-]")
20907 ((and (not box) (equal arg '(4))) "[ ]")
20908 ((or (not box) (equal arg '(4))) nil)
20909 ((eq box 'on) "[ ]")
20910 (t "[X]")))
20911 ;; Mimic `org-list-write-struct' but with grabbing
20912 ;; a return value from `org-list-struct-fix-box'.
20913 (org-list-struct-fix-ind struct parents 2)
20914 (org-list-struct-fix-item-end struct)
20915 (org-list-struct-fix-bul struct prevs)
20916 (org-list-struct-fix-ind struct parents)
20917 (let ((block-item
20918 (org-list-struct-fix-box struct parents prevs orderedp)))
20919 (if (and box (equal struct old-struct))
20920 (if (equal arg '(16))
20921 (message "Checkboxes already reset")
20922 (user-error "Cannot toggle this checkbox: %s"
20923 (if (eq box 'on)
20924 "all subitems checked"
20925 "unchecked subitems")))
20926 (org-list-struct-apply-struct struct old-struct)
20927 (org-update-checkbox-count-maybe))
20928 (when block-item
20929 (message "Checkboxes were removed due to empty box at line %d"
20930 (org-current-line block-item))))))
20931 (keyword
20932 (let ((org-inhibit-startup-visibility-stuff t)
20933 (org-startup-align-all-tables nil))
20934 (when (boundp 'org-table-coordinate-overlays)
20935 (mapc 'delete-overlay org-table-coordinate-overlays)
20936 (setq org-table-coordinate-overlays nil))
20937 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20938 (message "Local setup has been refreshed"))
20939 (plain-list
20940 ;; At a plain list, with a double C-u argument, set
20941 ;; checkboxes of each item to "[-]", whereas a single one
20942 ;; will toggle their presence according to the state of the
20943 ;; first item in the list. Without an argument, repair the
20944 ;; list.
20945 (let* ((begin (org-element-property :contents-begin context))
20946 (beginm (move-marker (make-marker) begin))
20947 (struct (org-element-property :structure context))
20948 (old-struct (copy-tree struct))
20949 (first-box (save-excursion
20950 (goto-char begin)
20951 (looking-at org-list-full-item-re)
20952 (match-string-no-properties 3)))
20953 (new-box (cond ((equal arg '(16)) "[-]")
20954 ((equal arg '(4)) (unless first-box "[ ]"))
20955 ((equal first-box "[X]") "[ ]")
20956 (t "[X]"))))
20957 (cond
20958 (arg
20959 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20960 (org-list-get-all-items
20961 begin struct (org-list-prevs-alist struct))))
20962 ((and first-box (eq (point) begin))
20963 ;; For convenience, when point is at bol on the first
20964 ;; item of the list and no argument is provided, simply
20965 ;; toggle checkbox of that item, if any.
20966 (org-list-set-checkbox begin struct new-box)))
20967 (org-list-write-struct
20968 struct (org-list-parents-alist struct) old-struct)
20969 (org-update-checkbox-count-maybe)
20970 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20971 ((property-drawer node-property)
20972 (call-interactively 'org-property-action))
20973 ((radio-target target)
20974 (call-interactively 'org-update-radio-target-regexp))
20975 (statistics-cookie
20976 (call-interactively 'org-update-statistics-cookies))
20977 ((table table-cell table-row)
20978 ;; At a table, recalculate every field and align it. Also
20979 ;; send the table if necessary. If the table has
20980 ;; a `table.el' type, just give up. At a table row or
20981 ;; cell, maybe recalculate line but always align table.
20982 (if (eq (org-element-property :type context) 'table.el)
20983 (message "Use C-c ' to edit table.el tables")
20984 (let ((org-enable-table-editor t))
20985 (if (or (eq type 'table)
20986 ;; Check if point is at a TBLFM line.
20987 (and (eq type 'table-row)
20988 (= (point) (org-element-property :end context))))
20989 (save-excursion
20990 (if (org-at-TBLFM-p)
20991 (progn (require 'org-table)
20992 (org-table-calc-current-TBLFM))
20993 (goto-char (org-element-property :contents-begin context))
20994 (org-call-with-arg 'org-table-recalculate (or arg t))
20995 (orgtbl-send-table 'maybe)))
20996 (org-table-maybe-eval-formula)
20997 (cond (arg (call-interactively 'org-table-recalculate))
20998 ((org-table-maybe-recalculate-line))
20999 (t (org-table-align)))))))
21000 (timestamp (org-timestamp-change 0 'day))
21001 (otherwise
21002 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21003 (user-error
21004 "C-c C-c can do nothing useful at this location")))))))))
21006 (defun org-mode-restart ()
21007 (interactive)
21008 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21009 (funcall major-mode)
21010 (hack-local-variables)
21011 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21012 (org-indent-mode -1)))
21013 (message "%s restarted" major-mode))
21015 (defun org-kill-note-or-show-branches ()
21016 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21017 (interactive)
21018 (if (not org-finish-function)
21019 (progn
21020 (hide-subtree)
21021 (call-interactively 'show-branches))
21022 (let ((org-note-abort t))
21023 (funcall org-finish-function))))
21025 (defun org-open-line (n)
21026 "Insert a new row in tables, call `open-line' elsewhere.
21027 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21028 (interactive "*p")
21029 (cond
21030 ((not org-special-ctrl-o)
21031 (open-line n))
21032 ((org-at-table-p)
21033 (org-table-insert-row))
21035 (open-line n))))
21037 (defun org-return (&optional indent)
21038 "Goto next table row or insert a newline.
21040 Calls `org-table-next-row' or `newline', depending on context.
21042 When optional INDENT argument is non-nil, call
21043 `newline-and-indent' instead of `newline'.
21045 When `org-return-follows-link' is non-nil and point is on
21046 a timestamp or a link, call `org-open-at-point'. However, it
21047 will not happen if point is in a table or on a \"dead\"
21048 object (e.g., within a comment). In these case, you need to use
21049 `org-open-at-point' directly."
21050 (interactive)
21051 (if (and (save-excursion
21052 (beginning-of-line)
21053 (looking-at org-todo-line-regexp))
21054 (match-beginning 3)
21055 (>= (point) (match-beginning 3)))
21056 ;; Point is on headline tags. Do not break them: add a newline
21057 ;; after the headline instead.
21058 (progn (org-show-entry)
21059 (end-of-line)
21060 (if indent (newline-and-indent) (newline)))
21061 (let* ((context (if org-return-follows-link (org-element-context)
21062 (org-element-at-point)))
21063 (type (org-element-type context)))
21064 (cond
21065 ;; In a table, call `org-table-next-row'.
21066 ((or (and (eq type 'table)
21067 (>= (point) (org-element-property :contents-begin context))
21068 (< (point) (org-element-property :contents-end context)))
21069 (org-element-lineage context '(table-row table-cell) t))
21070 (org-table-justify-field-maybe)
21071 (call-interactively #'org-table-next-row))
21072 ;; On a link or a timestamp but not on white spaces after it,
21073 ;; call `org-open-line' if `org-return-follows-link' allows it.
21074 ((and org-return-follows-link
21075 (memq type '(link timestamp))
21076 (< (point)
21077 (save-excursion (goto-char (org-element-property :end context))
21078 (skip-chars-backward " \t")
21079 (point))))
21080 (call-interactively #'org-open-at-point))
21081 ;; In a list, make sure indenting keeps trailing text within.
21082 ((and indent
21083 (not (eolp))
21084 (org-element-lineage context '(item)))
21085 (let ((trailing-data
21086 (delete-and-extract-region (point) (line-end-position))))
21087 (newline-and-indent)
21088 (save-excursion (insert trailing-data))))
21089 (t (if indent (newline-and-indent) (newline)))))))
21091 (defun org-return-indent ()
21092 "Goto next table row or insert a newline and indent.
21093 Calls `org-table-next-row' or `newline-and-indent', depending on
21094 context. See the individual commands for more information."
21095 (interactive)
21096 (org-return t))
21098 (defun org-ctrl-c-star ()
21099 "Compute table, or change heading status of lines.
21100 Calls `org-table-recalculate' or `org-toggle-heading',
21101 depending on context."
21102 (interactive)
21103 (cond
21104 ((org-at-table-p)
21105 (call-interactively 'org-table-recalculate))
21107 ;; Convert all lines in region to list items
21108 (call-interactively 'org-toggle-heading))))
21110 (defun org-ctrl-c-minus ()
21111 "Insert separator line in table or modify bullet status of line.
21112 Also turns a plain line or a region of lines into list items.
21113 Calls `org-table-insert-hline', `org-toggle-item', or
21114 `org-cycle-list-bullet', depending on context."
21115 (interactive)
21116 (cond
21117 ((org-at-table-p)
21118 (call-interactively 'org-table-insert-hline))
21119 ((org-region-active-p)
21120 (call-interactively 'org-toggle-item))
21121 ((org-in-item-p)
21122 (call-interactively 'org-cycle-list-bullet))
21124 (call-interactively 'org-toggle-item))))
21126 (defun org-toggle-item (arg)
21127 "Convert headings or normal lines to items, items to normal lines.
21128 If there is no active region, only the current line is considered.
21130 If the first non blank line in the region is a headline, convert
21131 all headlines to items, shifting text accordingly.
21133 If it is an item, convert all items to normal lines.
21135 If it is normal text, change region into a list of items.
21136 With a prefix argument ARG, change the region in a single item."
21137 (interactive "P")
21138 (let ((shift-text
21139 (function
21140 ;; Shift text in current section to IND, from point to END.
21141 ;; The function leaves point to END line.
21142 (lambda (ind end)
21143 (let ((min-i 1000) (end (copy-marker end)))
21144 ;; First determine the minimum indentation (MIN-I) of
21145 ;; the text.
21146 (save-excursion
21147 (catch 'exit
21148 (while (< (point) end)
21149 (let ((i (org-get-indentation)))
21150 (cond
21151 ;; Skip blank lines and inline tasks.
21152 ((looking-at "^[ \t]*$"))
21153 ((looking-at org-outline-regexp-bol))
21154 ;; We can't find less than 0 indentation.
21155 ((zerop i) (throw 'exit (setq min-i 0)))
21156 ((< i min-i) (setq min-i i))))
21157 (forward-line))))
21158 ;; Then indent each line so that a line indented to
21159 ;; MIN-I becomes indented to IND. Ignore blank lines
21160 ;; and inline tasks in the process.
21161 (let ((delta (- ind min-i)))
21162 (while (< (point) end)
21163 (unless (or (looking-at "^[ \t]*$")
21164 (looking-at org-outline-regexp-bol))
21165 (org-indent-line-to (+ (org-get-indentation) delta)))
21166 (forward-line)))))))
21167 (skip-blanks
21168 (function
21169 ;; Return beginning of first non-blank line, starting from
21170 ;; line at POS.
21171 (lambda (pos)
21172 (save-excursion
21173 (goto-char pos)
21174 (skip-chars-forward " \r\t\n")
21175 (point-at-bol)))))
21176 beg end)
21177 ;; Determine boundaries of changes.
21178 (if (org-region-active-p)
21179 (setq beg (funcall skip-blanks (region-beginning))
21180 end (copy-marker (region-end)))
21181 (setq beg (funcall skip-blanks (point-at-bol))
21182 end (copy-marker (point-at-eol))))
21183 ;; Depending on the starting line, choose an action on the text
21184 ;; between BEG and END.
21185 (org-with-limited-levels
21186 (save-excursion
21187 (goto-char beg)
21188 (cond
21189 ;; Case 1. Start at an item: de-itemize. Note that it only
21190 ;; happens when a region is active: `org-ctrl-c-minus'
21191 ;; would call `org-cycle-list-bullet' otherwise.
21192 ((org-at-item-p)
21193 (while (< (point) end)
21194 (when (org-at-item-p)
21195 (skip-chars-forward " \t")
21196 (delete-region (point) (match-end 0)))
21197 (forward-line)))
21198 ;; Case 2. Start at an heading: convert to items.
21199 ((org-at-heading-p)
21200 (let* ((bul (org-list-bullet-string "-"))
21201 (bul-len (length bul))
21202 (done (org-entry-is-done-p))
21203 (todo (org-entry-is-todo-p))
21204 ;; Indentation of the first heading. It should be
21205 ;; relative to the indentation of its parent, if any.
21206 (start-ind (save-excursion
21207 (cond
21208 ((not org-adapt-indentation) 0)
21209 ((not (outline-previous-heading)) 0)
21210 (t (length (match-string 0))))))
21211 ;; Level of first heading. Further headings will be
21212 ;; compared to it to determine hierarchy in the list.
21213 (ref-level (org-reduced-level (org-outline-level))))
21214 (when (or done todo) (org-todo ""))
21215 (while (< (point) end)
21216 (let* ((level (org-reduced-level (org-outline-level)))
21217 (delta (max 0 (- level ref-level))))
21218 ;; If current headline is less indented than the first
21219 ;; one, set it as reference, in order to preserve
21220 ;; subtrees.
21221 (when (< level ref-level) (setq ref-level level))
21222 (replace-match bul t t)
21223 (org-indent-line-to (+ start-ind (* delta bul-len)))
21224 (when (or done todo)
21225 (let* ((struct (org-list-struct))
21226 (old (copy-tree struct)))
21227 (org-list-set-checkbox (line-beginning-position)
21228 struct
21229 (if done "[X]" "[ ]"))
21230 (org-list-write-struct struct
21231 (org-list-parents-alist struct)
21232 old)))
21233 ;; Ensure all text down to END (or SECTION-END) belongs
21234 ;; to the newly created item.
21235 (let ((section-end (save-excursion
21236 (or (outline-next-heading) (point)))))
21237 (forward-line)
21238 (funcall shift-text
21239 (+ start-ind (* (1+ delta) bul-len))
21240 (min end section-end)))))))
21241 ;; Case 3. Normal line with ARG: make the first line of region
21242 ;; an item, and shift indentation of others lines to
21243 ;; set them as item's body.
21244 (arg (let* ((bul (org-list-bullet-string "-"))
21245 (bul-len (length bul))
21246 (ref-ind (org-get-indentation)))
21247 (skip-chars-forward " \t")
21248 (insert bul)
21249 (forward-line)
21250 (while (< (point) end)
21251 ;; Ensure that lines less indented than first one
21252 ;; still get included in item body.
21253 (funcall shift-text
21254 (+ ref-ind bul-len)
21255 (min end (save-excursion (or (outline-next-heading)
21256 (point)))))
21257 (forward-line))))
21258 ;; Case 4. Normal line without ARG: turn each non-item line
21259 ;; into an item.
21261 (while (< (point) end)
21262 (unless (or (org-at-heading-p) (org-at-item-p))
21263 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21264 (replace-match
21265 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21266 (forward-line))))))))
21268 (defun org-toggle-heading (&optional nstars)
21269 "Convert headings to normal text, or items or text to headings.
21270 If there is no active region, only convert the current line.
21272 With a \\[universal-argument] prefix, convert the whole list at
21273 point into heading.
21275 In a region:
21277 - If the first non blank line is a headline, remove the stars
21278 from all headlines in the region.
21280 - If it is a normal line, turn each and every normal line (i.e.,
21281 not an heading or an item) in the region into headings. If you
21282 want to convert only the first line of this region, use one
21283 universal prefix argument.
21285 - If it is a plain list item, turn all plain list items into headings.
21287 When converting a line into a heading, the number of stars is chosen
21288 such that the lines become children of the current entry. However,
21289 when a numeric prefix argument is given, its value determines the
21290 number of stars to add."
21291 (interactive "P")
21292 (let ((skip-blanks
21293 (function
21294 ;; Return beginning of first non-blank line, starting from
21295 ;; line at POS.
21296 (lambda (pos)
21297 (save-excursion
21298 (goto-char pos)
21299 (while (org-at-comment-p) (forward-line))
21300 (skip-chars-forward " \r\t\n")
21301 (point-at-bol)))))
21302 beg end toggled)
21303 ;; Determine boundaries of changes. If a universal prefix has
21304 ;; been given, put the list in a region. If region ends at a bol,
21305 ;; do not consider the last line to be in the region.
21307 (when (and current-prefix-arg (org-at-item-p))
21308 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21309 (org-mark-element))
21311 (if (org-region-active-p)
21312 (setq beg (funcall skip-blanks (region-beginning))
21313 end (copy-marker (save-excursion
21314 (goto-char (region-end))
21315 (if (bolp) (point) (point-at-eol)))))
21316 (setq beg (funcall skip-blanks (point-at-bol))
21317 end (copy-marker (point-at-eol))))
21318 ;; Ensure inline tasks don't count as headings.
21319 (org-with-limited-levels
21320 (save-excursion
21321 (goto-char beg)
21322 (cond
21323 ;; Case 1. Started at an heading: de-star headings.
21324 ((org-at-heading-p)
21325 (while (< (point) end)
21326 (when (org-at-heading-p t)
21327 (looking-at org-outline-regexp) (replace-match "")
21328 (setq toggled t))
21329 (forward-line)))
21330 ;; Case 2. Started at an item: change items into headlines.
21331 ;; One star will be added by `org-list-to-subtree'.
21332 ((org-at-item-p)
21333 (while (< (point) end)
21334 (when (org-at-item-p)
21335 ;; Pay attention to cases when region ends before list.
21336 (let* ((struct (org-list-struct))
21337 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21338 (save-restriction
21339 (narrow-to-region (point) list-end)
21340 (insert (org-list-to-subtree (org-list-parse-list t)))))
21341 (setq toggled t))
21342 (forward-line)))
21343 ;; Case 3. Started at normal text: make every line an heading,
21344 ;; skipping headlines and items.
21345 (t (let* ((stars
21346 (make-string
21347 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21348 (add-stars
21349 (cond (nstars "") ; stars from prefix only
21350 ((equal stars "") "*") ; before first heading
21351 (org-odd-levels-only "**") ; inside heading, odd
21352 (t "*"))) ; inside heading, oddeven
21353 (rpl (concat stars add-stars " "))
21354 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21355 (while (< (point) (if (equal nstars '(4)) lend end))
21356 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21357 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21358 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21359 (forward-line)))))))
21360 (unless toggled (message "Cannot toggle heading from here"))))
21362 (defun org-meta-return (&optional arg)
21363 "Insert a new heading or wrap a region in a table.
21364 Calls `org-insert-heading' or `org-table-wrap-region', depending
21365 on context. See the individual commands for more information."
21366 (interactive "P")
21367 (org-check-before-invisible-edit 'insert)
21368 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21369 (let* ((element (org-element-at-point))
21370 (type (org-element-type element)))
21371 (when (eq type 'table-row)
21372 (setq element (org-element-property :parent element))
21373 (setq type 'table))
21374 (if (and (eq type 'table)
21375 (eq (org-element-property :type element) 'org)
21376 (>= (point) (org-element-property :contents-begin element))
21377 (< (point) (org-element-property :contents-end element)))
21378 (call-interactively 'org-table-wrap-region)
21379 (call-interactively 'org-insert-heading)))))
21381 ;;; Menu entries
21383 (defsubst org-in-subtree-not-table-p ()
21384 "Are we in a subtree and not in a table?"
21385 (and (not (org-before-first-heading-p))
21386 (not (org-at-table-p))))
21388 ;; Define the Org-mode menus
21389 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21390 '("Tbl"
21391 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21392 ["Next Field" org-cycle (org-at-table-p)]
21393 ["Previous Field" org-shifttab (org-at-table-p)]
21394 ["Next Row" org-return (org-at-table-p)]
21395 "--"
21396 ["Blank Field" org-table-blank-field (org-at-table-p)]
21397 ["Edit Field" org-table-edit-field (org-at-table-p)]
21398 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21399 "--"
21400 ("Column"
21401 ["Move Column Left" org-metaleft (org-at-table-p)]
21402 ["Move Column Right" org-metaright (org-at-table-p)]
21403 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21404 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21405 ("Row"
21406 ["Move Row Up" org-metaup (org-at-table-p)]
21407 ["Move Row Down" org-metadown (org-at-table-p)]
21408 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21409 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21410 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21411 "--"
21412 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21413 ("Rectangle"
21414 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21415 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21416 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21417 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21418 "--"
21419 ("Calculate"
21420 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21421 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21422 ["Edit Formulas" org-edit-special (org-at-table-p)]
21423 "--"
21424 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21425 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21426 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21427 "--"
21428 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21429 "--"
21430 ["Sum Column/Rectangle" org-table-sum
21431 (or (org-at-table-p) (org-region-active-p))]
21432 ["Which Column?" org-table-current-column (org-at-table-p)])
21433 ["Debug Formulas"
21434 org-table-toggle-formula-debugger
21435 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21436 ["Show Col/Row Numbers"
21437 org-table-toggle-coordinate-overlays
21438 :style toggle
21439 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21440 "--"
21441 ["Create" org-table-create (and (not (org-at-table-p))
21442 org-enable-table-editor)]
21443 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21444 ["Import from File" org-table-import (not (org-at-table-p))]
21445 ["Export to File" org-table-export (org-at-table-p)]
21446 "--"
21447 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21448 "--"
21449 ("Plot"
21450 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21451 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21453 (easy-menu-define org-org-menu org-mode-map "Org menu"
21454 '("Org"
21455 ("Show/Hide"
21456 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21457 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21458 ["Sparse Tree..." org-sparse-tree t]
21459 ["Reveal Context" org-reveal t]
21460 ["Show All" show-all t]
21461 "--"
21462 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21463 "--"
21464 ["New Heading" org-insert-heading t]
21465 ("Navigate Headings"
21466 ["Up" outline-up-heading t]
21467 ["Next" outline-next-visible-heading t]
21468 ["Previous" outline-previous-visible-heading t]
21469 ["Next Same Level" outline-forward-same-level t]
21470 ["Previous Same Level" outline-backward-same-level t]
21471 "--"
21472 ["Jump" org-goto t])
21473 ("Edit Structure"
21474 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21475 "--"
21476 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21477 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21478 "--"
21479 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21480 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21481 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21482 "--"
21483 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21484 "--"
21485 ["Copy visible text" org-copy-visible t]
21486 "--"
21487 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21488 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21489 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21490 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21491 "--"
21492 ["Sort Region/Children" org-sort t]
21493 "--"
21494 ["Convert to odd levels" org-convert-to-odd-levels t]
21495 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21496 ("Editing"
21497 ["Emphasis..." org-emphasize t]
21498 ["Edit Source Example" org-edit-special t]
21499 "--"
21500 ["Footnote new/jump" org-footnote-action t]
21501 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21502 ("Archive"
21503 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21504 "--"
21505 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21506 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21507 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21509 "--"
21510 ("Hyperlinks"
21511 ["Store Link (Global)" org-store-link t]
21512 ["Find existing link to here" org-occur-link-in-agenda-files t]
21513 ["Insert Link" org-insert-link t]
21514 ["Follow Link" org-open-at-point t]
21515 "--"
21516 ["Next link" org-next-link t]
21517 ["Previous link" org-previous-link t]
21518 "--"
21519 ["Descriptive Links"
21520 org-toggle-link-display
21521 :style radio
21522 :selected org-descriptive-links
21524 ["Literal Links"
21525 org-toggle-link-display
21526 :style radio
21527 :selected (not org-descriptive-links)])
21528 "--"
21529 ("TODO Lists"
21530 ["TODO/DONE/-" org-todo t]
21531 ("Select keyword"
21532 ["Next keyword" org-shiftright (org-at-heading-p)]
21533 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21534 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21535 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21536 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21537 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21538 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21539 "--"
21540 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21541 :selected org-enforce-todo-dependencies :style toggle :active t]
21542 "Settings for tree at point"
21543 ["Do Children sequentially" org-toggle-ordered-property :style radio
21544 :selected (org-entry-get nil "ORDERED")
21545 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21546 ["Do Children parallel" org-toggle-ordered-property :style radio
21547 :selected (not (org-entry-get nil "ORDERED"))
21548 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21549 "--"
21550 ["Set Priority" org-priority t]
21551 ["Priority Up" org-shiftup t]
21552 ["Priority Down" org-shiftdown t]
21553 "--"
21554 ["Get news from all feeds" org-feed-update-all t]
21555 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21556 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21557 ("TAGS and Properties"
21558 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21559 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21560 "--"
21561 ["Set property" org-set-property (not (org-before-first-heading-p))]
21562 ["Column view of properties" org-columns t]
21563 ["Insert Column View DBlock" org-insert-columns-dblock t])
21564 ("Dates and Scheduling"
21565 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21566 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21567 ("Change Date"
21568 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21569 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21570 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21571 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21572 ["Compute Time Range" org-evaluate-time-range t]
21573 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21574 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21575 "--"
21576 ["Custom time format" org-toggle-time-stamp-overlays
21577 :style radio :selected org-display-custom-times]
21578 "--"
21579 ["Goto Calendar" org-goto-calendar t]
21580 ["Date from Calendar" org-date-from-calendar t]
21581 "--"
21582 ["Start/Restart Timer" org-timer-start t]
21583 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21584 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21585 ["Insert Timer String" org-timer t]
21586 ["Insert Timer Item" org-timer-item t])
21587 ("Logging work"
21588 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21589 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21590 ["Clock out" org-clock-out t]
21591 ["Clock cancel" org-clock-cancel t]
21592 "--"
21593 ["Mark as default task" org-clock-mark-default-task t]
21594 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21595 ["Goto running clock" org-clock-goto t]
21596 "--"
21597 ["Display times" org-clock-display t]
21598 ["Create clock table" org-clock-report t]
21599 "--"
21600 ["Record DONE time"
21601 (progn (setq org-log-done (not org-log-done))
21602 (message "Switching to %s will %s record a timestamp"
21603 (car org-done-keywords)
21604 (if org-log-done "automatically" "not")))
21605 :style toggle :selected org-log-done])
21606 "--"
21607 ["Agenda Command..." org-agenda t]
21608 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21609 ("File List for Agenda")
21610 ("Special views current file"
21611 ["TODO Tree" org-show-todo-tree t]
21612 ["Check Deadlines" org-check-deadlines t]
21613 ["Timeline" org-timeline t]
21614 ["Tags/Property tree" org-match-sparse-tree t])
21615 "--"
21616 ["Export/Publish..." org-export-dispatch t]
21617 ("LaTeX"
21618 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21619 :selected org-cdlatex-mode]
21620 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21621 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21622 ["Modify math symbol" org-cdlatex-math-modify
21623 (org-inside-LaTeX-fragment-p)]
21624 ["Insert citation" org-reftex-citation t]
21625 "--"
21626 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21627 "--"
21628 ("MobileOrg"
21629 ["Push Files and Views" org-mobile-push t]
21630 ["Get Captured and Flagged" org-mobile-pull t]
21631 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21632 "--"
21633 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21634 "--"
21635 ("Documentation"
21636 ["Show Version" org-version t]
21637 ["Info Documentation" org-info t])
21638 ("Customize"
21639 ["Browse Org Group" org-customize t]
21640 "--"
21641 ["Expand This Menu" org-create-customize-menu
21642 (fboundp 'customize-menu-create)])
21643 ["Send bug report" org-submit-bug-report t]
21644 "--"
21645 ("Refresh/Reload"
21646 ["Refresh setup current buffer" org-mode-restart t]
21647 ["Reload Org (after update)" org-reload t]
21648 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21651 (defun org-info (&optional node)
21652 "Read documentation for Org-mode in the info system.
21653 With optional NODE, go directly to that node."
21654 (interactive)
21655 (info (format "(org)%s" (or node ""))))
21657 ;;;###autoload
21658 (defun org-submit-bug-report ()
21659 "Submit a bug report on Org-mode via mail.
21661 Don't hesitate to report any problems or inaccurate documentation.
21663 If you don't have setup sending mail from (X)Emacs, please copy the
21664 output buffer into your mail program, as it gives us important
21665 information about your Org-mode version and configuration."
21666 (interactive)
21667 (require 'reporter)
21668 (org-load-modules-maybe)
21669 (org-require-autoloaded-modules)
21670 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21671 (reporter-submit-bug-report
21672 "emacs-orgmode@gnu.org"
21673 (org-version nil 'full)
21674 (let (list)
21675 (save-window-excursion
21676 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21677 (delete-other-windows)
21678 (erase-buffer)
21679 (insert "You are about to submit a bug report to the Org-mode mailing list.
21681 We would like to add your full Org-mode and Outline configuration to the
21682 bug report. This greatly simplifies the work of the maintainer and
21683 other experts on the mailing list.
21685 HOWEVER, some variables you have customized may contain private
21686 information. The names of customers, colleagues, or friends, might
21687 appear in the form of file names, tags, todo states, or search strings.
21688 If you answer yes to the prompt, you might want to check and remove
21689 such private information before sending the email.")
21690 (add-text-properties (point-min) (point-max) '(face org-warning))
21691 (when (yes-or-no-p "Include your Org-mode configuration ")
21692 (mapatoms
21693 (lambda (v)
21694 (and (boundp v)
21695 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21696 (or (and (symbol-value v)
21697 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21698 (and
21699 (get v 'custom-type) (get v 'standard-value)
21700 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21701 (push v list)))))
21702 (kill-buffer (get-buffer "*Warn about privacy*"))
21703 list))
21704 nil nil
21705 "Remember to cover the basics, that is, what you expected to happen and
21706 what in fact did happen. You don't know how to make a good report? See
21708 http://orgmode.org/manual/Feedback.html#Feedback
21710 Your bug report will be posted to the Org-mode mailing list.
21711 ------------------------------------------------------------------------")
21712 (save-excursion
21713 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21714 (replace-match "\\1Bug: \\3 [\\2]")))))
21717 (defun org-install-agenda-files-menu ()
21718 (let ((bl (buffer-list)))
21719 (save-excursion
21720 (while bl
21721 (set-buffer (pop bl))
21722 (if (derived-mode-p 'org-mode) (setq bl nil)))
21723 (when (derived-mode-p 'org-mode)
21724 (easy-menu-change
21725 '("Org") "File List for Agenda"
21726 (append
21727 (list
21728 ["Edit File List" (org-edit-agenda-file-list) t]
21729 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21730 ["Remove Current File from List" org-remove-file t]
21731 ["Cycle through agenda files" org-cycle-agenda-files t]
21732 ["Occur in all agenda files" org-occur-in-agenda-files t]
21733 "--")
21734 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21736 ;;;; Documentation
21738 (defun org-require-autoloaded-modules ()
21739 (interactive)
21740 (mapc 'require
21741 '(org-agenda org-archive org-attach org-clock org-colview org-id
21742 org-table org-timer)))
21744 ;;;###autoload
21745 (defun org-reload (&optional uncompiled)
21746 "Reload all org lisp files.
21747 With prefix arg UNCOMPILED, load the uncompiled versions."
21748 (interactive "P")
21749 (require 'loadhist)
21750 (let* ((org-dir (org-find-library-dir "org"))
21751 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21752 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21753 (remove-re (mapconcat 'identity
21754 (mapcar (lambda (f) (concat "^" f "$"))
21755 (list (if (featurep 'xemacs)
21756 "org-colview"
21757 "org-colview-xemacs")
21758 "org" "org-loaddefs" "org-version"))
21759 "\\|"))
21760 (feats (delete-dups
21761 (mapcar 'file-name-sans-extension
21762 (mapcar 'file-name-nondirectory
21763 (delq nil
21764 (mapcar 'feature-file
21765 features))))))
21766 (lfeat (append
21767 (sort
21768 (setq feats
21769 (delq nil (mapcar
21770 (lambda (f)
21771 (if (and (string-match feature-re f)
21772 (not (string-match remove-re f)))
21773 f nil))
21774 feats)))
21775 'string-lessp)
21776 (list "org-version" "org")))
21777 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21778 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21779 load-uncore load-misses)
21780 (setq load-misses
21781 (delq 't
21782 (mapcar (lambda (f)
21783 (or (org-load-noerror-mustsuffix (concat org-dir f))
21784 (and (string= org-dir contrib-dir)
21785 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21786 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21787 (add-to-list 'load-uncore f 'append)
21790 lfeat)))
21791 (if load-uncore
21792 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21793 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21794 (if load-misses
21795 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21796 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21797 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21799 ;;;###autoload
21800 (defun org-customize ()
21801 "Call the customize function with org as argument."
21802 (interactive)
21803 (org-load-modules-maybe)
21804 (org-require-autoloaded-modules)
21805 (customize-browse 'org))
21807 (defun org-create-customize-menu ()
21808 "Create a full customization menu for Org-mode, insert it into the menu."
21809 (interactive)
21810 (org-load-modules-maybe)
21811 (org-require-autoloaded-modules)
21812 (if (fboundp 'customize-menu-create)
21813 (progn
21814 (easy-menu-change
21815 '("Org") "Customize"
21816 `(["Browse Org group" org-customize t]
21817 "--"
21818 ,(customize-menu-create 'org)
21819 ["Set" Custom-set t]
21820 ["Save" Custom-save t]
21821 ["Reset to Current" Custom-reset-current t]
21822 ["Reset to Saved" Custom-reset-saved t]
21823 ["Reset to Standard Settings" Custom-reset-standard t]))
21824 (message "\"Org\"-menu now contains full customization menu"))
21825 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21827 ;;;; Miscellaneous stuff
21829 ;;; Generally useful functions
21831 (defsubst org-get-at-eol (property n)
21832 "Get text property PROPERTY at the end of line less N characters."
21833 (get-text-property (- (point-at-eol) n) property))
21835 (defun org-find-text-property-in-string (prop s)
21836 "Return the first non-nil value of property PROP in string S."
21837 (or (get-text-property 0 prop s)
21838 (get-text-property (or (next-single-property-change 0 prop s) 0)
21839 prop s)))
21841 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21842 "Display the given MESSAGE as a warning."
21843 (if (fboundp 'display-warning)
21844 (display-warning 'org message
21845 (if (featurep 'xemacs) 'warning :warning))
21846 (let ((buf (get-buffer-create "*Org warnings*")))
21847 (with-current-buffer buf
21848 (goto-char (point-max))
21849 (insert "Warning (Org): " message)
21850 (unless (bolp)
21851 (newline)))
21852 (display-buffer buf)
21853 (sit-for 0))))
21855 (defun org-eval (form)
21856 "Eval FORM and return result."
21857 (condition-case error
21858 (eval form)
21859 (error (format "%%![Error: %s]" error))))
21861 (defun org-in-clocktable-p ()
21862 "Check if the cursor is in a clocktable."
21863 (let ((pos (point)) start)
21864 (save-excursion
21865 (end-of-line 1)
21866 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21867 (setq start (match-beginning 0))
21868 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21869 (>= (match-end 0) pos)
21870 start))))
21872 (defun org-in-verbatim-emphasis ()
21873 (save-match-data
21874 (and (org-in-regexp org-emph-re 2)
21875 (>= (point) (match-beginning 3))
21876 (<= (point) (match-end 4))
21877 (member (match-string 3) '("=" "~")))))
21879 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21880 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21881 (if (and marker (marker-buffer marker)
21882 (buffer-live-p (marker-buffer marker)))
21883 (progn
21884 (org-pop-to-buffer-same-window (marker-buffer marker))
21885 (if (or (> marker (point-max)) (< marker (point-min)))
21886 (widen))
21887 (goto-char marker)
21888 (org-show-context 'org-goto))
21889 (if bookmark
21890 (bookmark-jump bookmark)
21891 (error "Cannot find location"))))
21893 (defun org-quote-csv-field (s)
21894 "Quote field for inclusion in CSV material."
21895 (if (string-match "[\",]" s)
21896 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21899 (defun org-force-self-insert (N)
21900 "Needed to enforce self-insert under remapping."
21901 (interactive "p")
21902 (self-insert-command N))
21904 (defun org-string-width (s)
21905 "Compute width of string, ignoring invisible characters.
21906 This ignores character with invisibility property `org-link', and also
21907 characters with property `org-cwidth', because these will become invisible
21908 upon the next fontification round."
21909 (let (b l)
21910 (when (or (eq t buffer-invisibility-spec)
21911 (assq 'org-link buffer-invisibility-spec))
21912 (while (setq b (text-property-any 0 (length s)
21913 'invisible 'org-link s))
21914 (setq s (concat (substring s 0 b)
21915 (substring s (or (next-single-property-change
21916 b 'invisible s) (length s)))))))
21917 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21918 (setq s (concat (substring s 0 b)
21919 (substring s (or (next-single-property-change
21920 b 'org-cwidth s) (length s))))))
21921 (setq l (string-width s) b -1)
21922 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21923 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21926 (defun org-shorten-string (s maxlength)
21927 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21928 If the string is shorter or has length MAXLENGTH, just return the
21929 original string. If it is longer, the functions finds a space in the
21930 string, breaks this string off at that locations and adds three dots
21931 as ellipsis. Including the ellipsis, the string will not be longer
21932 than MAXLENGTH. If finding a good breaking point in the string does
21933 not work, the string is just chopped off in the middle of a word
21934 if necessary."
21935 (if (<= (length s) maxlength)
21937 (let* ((n (max (- maxlength 4) 1))
21938 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21939 (if (string-match re s)
21940 (concat (match-string 1 s) "...")
21941 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21943 (defun org-get-indentation (&optional line)
21944 "Get the indentation of the current line, interpreting tabs.
21945 When LINE is given, assume it represents a line and compute its indentation."
21946 (if line
21947 (if (string-match "^ *" (org-remove-tabs line))
21948 (match-end 0))
21949 (save-excursion
21950 (beginning-of-line 1)
21951 (skip-chars-forward " \t")
21952 (current-column))))
21954 (defun org-get-string-indentation (s)
21955 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21956 (let ((n -1) (i 0) (w tab-width) c)
21957 (catch 'exit
21958 (while (< (setq n (1+ n)) (length s))
21959 (setq c (aref s n))
21960 (cond ((= c ?\ ) (setq i (1+ i)))
21961 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21962 (t (throw 'exit t)))))
21965 (defun org-remove-tabs (s &optional width)
21966 "Replace tabulators in S with spaces.
21967 Assumes that s is a single line, starting in column 0."
21968 (setq width (or width tab-width))
21969 (while (string-match "\t" s)
21970 (setq s (replace-match
21971 (make-string
21972 (- (* width (/ (+ (match-beginning 0) width) width))
21973 (match-beginning 0)) ?\ )
21974 t t s)))
21977 (defun org-fix-indentation (line ind)
21978 "Fix indentation in LINE.
21979 IND is a cons cell with target and minimum indentation.
21980 If the current indentation in LINE is smaller than the minimum,
21981 leave it alone. If it is larger than ind, set it to the target."
21982 (let* ((l (org-remove-tabs line))
21983 (i (org-get-indentation l))
21984 (i1 (car ind)) (i2 (cdr ind)))
21985 (if (>= i i2) (setq l (substring line i2)))
21986 (if (> i1 0)
21987 (concat (make-string i1 ?\ ) l)
21988 l)))
21990 (defun org-remove-indentation (code &optional n)
21991 "Remove the maximum common indentation from the lines in CODE.
21992 N may optionally be the number of spaces to remove."
21993 (with-temp-buffer
21994 (insert code)
21995 (org-do-remove-indentation n)
21996 (buffer-string)))
21998 (defun org-do-remove-indentation (&optional n)
21999 "Remove the maximum common indentation from the buffer."
22000 (untabify (point-min) (point-max))
22001 (let ((min 10000) re)
22002 (if n
22003 (setq min n)
22004 (goto-char (point-min))
22005 (while (re-search-forward "^ *[^ \n]" nil t)
22006 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22007 (unless (or (= min 0) (= min 10000))
22008 (setq re (format "^ \\{%d\\}" min))
22009 (goto-char (point-min))
22010 (while (re-search-forward re nil t)
22011 (replace-match "")
22012 (end-of-line 1))
22013 min)))
22015 (defun org-fill-template (template alist)
22016 "Find each %key of ALIST in TEMPLATE and replace it."
22017 (let ((case-fold-search nil)
22018 entry key value)
22019 (setq alist (sort (copy-sequence alist)
22020 (lambda (a b) (< (length (car a)) (length (car b))))))
22021 (while (setq entry (pop alist))
22022 (setq template
22023 (replace-regexp-in-string
22024 (concat "%" (regexp-quote (car entry)))
22025 (or (cdr entry) "") template t t)))
22026 template))
22028 (defun org-base-buffer (buffer)
22029 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22030 (if (not buffer)
22031 buffer
22032 (or (buffer-base-buffer buffer)
22033 buffer)))
22035 (defun org-wrap (string &optional width lines)
22036 "Wrap string to either a number of lines, or a width in characters.
22037 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22038 that costs. If there is a word longer than WIDTH, the text is actually
22039 wrapped to the length of that word.
22040 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22041 many lines, whatever width that takes.
22042 The return value is a list of lines, without newlines at the end."
22043 (let* ((words (org-split-string string "[ \t\n]+"))
22044 (maxword (apply 'max (mapcar 'org-string-width words)))
22045 w ll)
22046 (cond (width
22047 (org-do-wrap words (max maxword width)))
22048 (lines
22049 (setq w maxword)
22050 (setq ll (org-do-wrap words maxword))
22051 (if (<= (length ll) lines)
22053 (setq ll words)
22054 (while (> (length ll) lines)
22055 (setq w (1+ w))
22056 (setq ll (org-do-wrap words w)))
22057 ll))
22058 (t (error "Cannot wrap this")))))
22060 (defun org-do-wrap (words width)
22061 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22062 (let (lines line)
22063 (while words
22064 (setq line (pop words))
22065 (while (and words (< (+ (length line) (length (car words))) width))
22066 (setq line (concat line " " (pop words))))
22067 (setq lines (push line lines)))
22068 (nreverse lines)))
22070 (defun org-split-string (string &optional separators)
22071 "Splits STRING into substrings at SEPARATORS.
22072 No empty strings are returned if there are matches at the beginning
22073 and end of string."
22074 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
22075 (start 0)
22076 notfirst
22077 (list nil))
22078 (while (and (string-match rexp string
22079 (if (and notfirst
22080 (= start (match-beginning 0))
22081 (< start (length string)))
22082 (1+ start) start))
22083 (< (match-beginning 0) (length string)))
22084 (setq notfirst t)
22085 (or (eq (match-beginning 0) 0)
22086 (and (eq (match-beginning 0) (match-end 0))
22087 (eq (match-beginning 0) start))
22088 (setq list
22089 (cons (substring string start (match-beginning 0))
22090 list)))
22091 (setq start (match-end 0)))
22092 (or (eq start (length string))
22093 (setq list
22094 (cons (substring string start)
22095 list)))
22096 (nreverse list)))
22098 (defun org-quote-vert (s)
22099 "Replace \"|\" with \"\\vert\"."
22100 (while (string-match "|" s)
22101 (setq s (replace-match "\\vert" t t s)))
22104 (defun org-uuidgen-p (s)
22105 "Is S an ID created by UUIDGEN?"
22106 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22108 (defun org-in-src-block-p (&optional inside)
22109 "Whether point is in a code source block.
22110 When INSIDE is non-nil, don't consider we are within a src block
22111 when point is at #+BEGIN_SRC or #+END_SRC."
22112 (let ((case-fold-search t) ov)
22113 (or (and (eq (get-char-property (point) 'src-block) t))
22114 (and (not inside)
22115 (save-match-data
22116 (save-excursion
22117 (beginning-of-line)
22118 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22120 (defun org-context ()
22121 "Return a list of contexts of the current cursor position.
22122 If several contexts apply, all are returned.
22123 Each context entry is a list with a symbol naming the context, and
22124 two positions indicating start and end of the context. Possible
22125 contexts are:
22127 :headline anywhere in a headline
22128 :headline-stars on the leading stars in a headline
22129 :todo-keyword on a TODO keyword (including DONE) in a headline
22130 :tags on the TAGS in a headline
22131 :priority on the priority cookie in a headline
22132 :item on the first line of a plain list item
22133 :item-bullet on the bullet/number of a plain list item
22134 :checkbox on the checkbox in a plain list item
22135 :table in an org-mode table
22136 :table-special on a special filed in a table
22137 :table-table in a table.el table
22138 :clocktable in a clocktable
22139 :src-block in a source block
22140 :link on a hyperlink
22141 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22142 :target on a <<target>>
22143 :radio-target on a <<<radio-target>>>
22144 :latex-fragment on a LaTeX fragment
22145 :latex-preview on a LaTeX fragment with overlaid preview image
22147 This function expects the position to be visible because it uses font-lock
22148 faces as a help to recognize the following contexts: :table-special, :link,
22149 and :keyword."
22150 (let* ((f (get-text-property (point) 'face))
22151 (faces (if (listp f) f (list f)))
22152 (case-fold-search t)
22153 (p (point)) clist o)
22154 ;; First the large context
22155 (cond
22156 ((org-at-heading-p t)
22157 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22158 (when (progn
22159 (beginning-of-line 1)
22160 (looking-at org-todo-line-tags-regexp))
22161 (push (org-point-in-group p 1 :headline-stars) clist)
22162 (push (org-point-in-group p 2 :todo-keyword) clist)
22163 (push (org-point-in-group p 4 :tags) clist))
22164 (goto-char p)
22165 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22166 (if (looking-at "\\[#[A-Z0-9]\\]")
22167 (push (org-point-in-group p 0 :priority) clist)))
22169 ((org-at-item-p)
22170 (push (org-point-in-group p 2 :item-bullet) clist)
22171 (push (list :item (point-at-bol)
22172 (save-excursion (org-end-of-item) (point)))
22173 clist)
22174 (and (org-at-item-checkbox-p)
22175 (push (org-point-in-group p 0 :checkbox) clist)))
22177 ((org-at-table-p)
22178 (push (list :table (org-table-begin) (org-table-end)) clist)
22179 (if (memq 'org-formula faces)
22180 (push (list :table-special
22181 (previous-single-property-change p 'face)
22182 (next-single-property-change p 'face)) clist)))
22183 ((org-at-table-p 'any)
22184 (push (list :table-table) clist)))
22185 (goto-char p)
22187 (let ((case-fold-search t))
22188 ;; New the "medium" contexts: clocktables, source blocks
22189 (cond ((org-in-clocktable-p)
22190 (push (list :clocktable
22191 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22192 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22193 (match-beginning 1))
22194 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22195 (match-end 0))) clist))
22196 ((org-in-src-block-p)
22197 (push (list :src-block
22198 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22199 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22200 (match-beginning 1))
22201 (and (search-forward "#+END_SRC" nil t)
22202 (match-beginning 0))) clist))))
22203 (goto-char p)
22205 ;; Now the small context
22206 (cond
22207 ((org-at-timestamp-p)
22208 (push (org-point-in-group p 0 :timestamp) clist))
22209 ((memq 'org-link faces)
22210 (push (list :link
22211 (previous-single-property-change p 'face)
22212 (next-single-property-change p 'face)) clist))
22213 ((memq 'org-special-keyword faces)
22214 (push (list :keyword
22215 (previous-single-property-change p 'face)
22216 (next-single-property-change p 'face)) clist))
22217 ((org-at-target-p)
22218 (push (org-point-in-group p 0 :target) clist)
22219 (goto-char (1- (match-beginning 0)))
22220 (if (looking-at org-radio-target-regexp)
22221 (push (org-point-in-group p 0 :radio-target) clist))
22222 (goto-char p))
22223 ((setq o (car (delq nil
22224 (mapcar
22225 (lambda (x)
22226 (if (memq x org-latex-fragment-image-overlays) x))
22227 (overlays-at (point))))))
22228 (push (list :latex-fragment
22229 (overlay-start o) (overlay-end o)) clist)
22230 (push (list :latex-preview
22231 (overlay-start o) (overlay-end o)) clist))
22232 ((org-inside-LaTeX-fragment-p)
22233 ;; FIXME: positions wrong.
22234 (push (list :latex-fragment (point) (point)) clist)))
22236 (setq clist (nreverse (delq nil clist)))
22237 clist))
22239 (defun org-in-regexp (re &optional nlines visually)
22240 "Check if point is inside a match of RE.
22242 Normally only the current line is checked, but you can include
22243 NLINES extra lines after point into the search. If VISUALLY is
22244 set, require that the cursor is not after the match but really
22245 on, so that the block visually is on the match."
22246 (catch 'exit
22247 (let ((pos (point))
22248 (eol (point-at-eol (+ 1 (or nlines 0))))
22249 (inc (if visually 1 0)))
22250 (save-excursion
22251 (beginning-of-line (- 1 (or nlines 0)))
22252 (while (re-search-forward re eol t)
22253 (if (and (<= (match-beginning 0) pos)
22254 (>= (+ inc (match-end 0)) pos))
22255 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22256 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22257 "Org mode 8.3")
22259 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22260 "Non-nil when point is between matches of START-RE and END-RE.
22262 Also return a non-nil value when point is on one of the matches.
22264 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22265 buffer positions. Default values are the positions of headlines
22266 surrounding the point.
22268 The functions returns a cons cell whose car (resp. cdr) is the
22269 position before START-RE (resp. after END-RE)."
22270 (save-match-data
22271 (let ((pos (point))
22272 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22273 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22274 beg end)
22275 (save-excursion
22276 ;; Point is on a block when on START-RE or if START-RE can be
22277 ;; found before it...
22278 (and (or (org-in-regexp start-re)
22279 (re-search-backward start-re limit-up t))
22280 (setq beg (match-beginning 0))
22281 ;; ... and END-RE after it...
22282 (goto-char (match-end 0))
22283 (re-search-forward end-re limit-down t)
22284 (> (setq end (match-end 0)) pos)
22285 ;; ... without another START-RE in-between.
22286 (goto-char (match-beginning 0))
22287 (not (re-search-backward start-re (1+ beg) t))
22288 ;; Return value.
22289 (cons beg end))))))
22291 (defun org-in-block-p (names)
22292 "Non-nil when point belongs to a block whose name belongs to NAMES.
22294 NAMES is a list of strings containing names of blocks.
22296 Return first block name matched, or nil. Beware that in case of
22297 nested blocks, the returned name may not belong to the closest
22298 block from point."
22299 (save-match-data
22300 (catch 'exit
22301 (let ((case-fold-search t)
22302 (lim-up (save-excursion (outline-previous-heading)))
22303 (lim-down (save-excursion (outline-next-heading))))
22304 (mapc (lambda (name)
22305 (let ((n (regexp-quote name)))
22306 (when (org-between-regexps-p
22307 (concat "^[ \t]*#\\+begin_" n)
22308 (concat "^[ \t]*#\\+end_" n)
22309 lim-up lim-down)
22310 (throw 'exit n))))
22311 names))
22312 nil)))
22314 (defun org-occur-in-agenda-files (regexp &optional nlines)
22315 "Call `multi-occur' with buffers for all agenda files."
22316 (interactive "sOrg-files matching: \np")
22317 (let* ((files (org-agenda-files))
22318 (tnames (mapcar 'file-truename files))
22319 (extra org-agenda-text-search-extra-files)
22321 (when (eq (car extra) 'agenda-archives)
22322 (setq extra (cdr extra))
22323 (setq files (org-add-archive-files files)))
22324 (while (setq f (pop extra))
22325 (unless (member (file-truename f) tnames)
22326 (add-to-list 'files f 'append)
22327 (add-to-list 'tnames (file-truename f) 'append)))
22328 (multi-occur
22329 (mapcar (lambda (x)
22330 (with-current-buffer
22331 (or (get-file-buffer x) (find-file-noselect x))
22332 (widen)
22333 (current-buffer)))
22334 files)
22335 regexp)))
22337 (if (boundp 'occur-mode-find-occurrence-hook)
22338 ;; Emacs 23
22339 (add-hook 'occur-mode-find-occurrence-hook
22340 (lambda ()
22341 (when (derived-mode-p 'org-mode)
22342 (org-reveal))))
22343 ;; Emacs 22
22344 (defadvice occur-mode-goto-occurrence
22345 (after org-occur-reveal activate)
22346 (and (derived-mode-p 'org-mode) (org-reveal)))
22347 (defadvice occur-mode-goto-occurrence-other-window
22348 (after org-occur-reveal activate)
22349 (and (derived-mode-p 'org-mode) (org-reveal)))
22350 (defadvice occur-mode-display-occurrence
22351 (after org-occur-reveal activate)
22352 (when (derived-mode-p 'org-mode)
22353 (let ((pos (occur-mode-find-occurrence)))
22354 (with-current-buffer (marker-buffer pos)
22355 (save-excursion
22356 (goto-char pos)
22357 (org-reveal)))))))
22359 (defun org-occur-link-in-agenda-files ()
22360 "Create a link and search for it in the agendas.
22361 The link is not stored in `org-stored-links', it is just created
22362 for the search purpose."
22363 (interactive)
22364 (let ((link (condition-case nil
22365 (org-store-link nil)
22366 (error "Unable to create a link to here"))))
22367 (org-occur-in-agenda-files (regexp-quote link))))
22369 (defun org-reverse-string (string)
22370 "Return the reverse of STRING."
22371 (apply 'string (reverse (string-to-list string))))
22373 ;; defsubst org-uniquify must be defined before first use
22375 (defun org-uniquify-alist (alist)
22376 "Merge elements of ALIST with the same key.
22378 For example, in this alist:
22380 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22381 => '((a 1 3) (b 2))
22383 merge (a 1) and (a 3) into (a 1 3).
22385 The function returns the new ALIST."
22386 (let (rtn)
22387 (mapc
22388 (lambda (e)
22389 (let (n)
22390 (if (not (assoc (car e) rtn))
22391 (push e rtn)
22392 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22393 (setq rtn (assq-delete-all (car e) rtn))
22394 (push n rtn))))
22395 alist)
22396 rtn))
22398 (defun org-delete-all (elts list)
22399 "Remove all elements in ELTS from LIST."
22400 (while elts
22401 (setq list (delete (pop elts) list)))
22402 list)
22404 (defun org-count (cl-item cl-seq)
22405 "Count the number of occurrences of ITEM in SEQ.
22406 Taken from `count' in cl-seq.el with all keyword arguments removed."
22407 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22408 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22409 (while (< cl-start cl-end)
22410 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22411 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22412 (setq cl-start (1+ cl-start)))
22413 cl-count))
22415 (defun org-remove-if (predicate seq)
22416 "Remove everything from SEQ that fulfills PREDICATE."
22417 (let (res e)
22418 (while seq
22419 (setq e (pop seq))
22420 (if (not (funcall predicate e)) (push e res)))
22421 (nreverse res)))
22423 (defun org-remove-if-not (predicate seq)
22424 "Remove everything from SEQ that does not fulfill PREDICATE."
22425 (let (res e)
22426 (while seq
22427 (setq e (pop seq))
22428 (if (funcall predicate e) (push e res)))
22429 (nreverse res)))
22431 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22432 "Reduce two-argument FUNCTION across SEQ.
22433 Taken from `reduce' in cl-seq.el with all keyword arguments but
22434 \":initial-value\" removed."
22435 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22436 (cadr (memq :initial-value cl-keys)))
22437 (cl-seq (pop cl-seq))
22438 (t (funcall cl-func)))))
22439 (while cl-seq
22440 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22441 cl-accum))
22443 (defun org-every (pred seq)
22444 "Return true if PREDICATE is true of every element of SEQ.
22445 Adapted from `every' in cl.el."
22446 (catch 'org-every
22447 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22450 (defun org-some (pred seq)
22451 "Return true if PREDICATE is true of any element of SEQ.
22452 Adapted from `some' in cl.el."
22453 (catch 'org-some
22454 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22455 nil))
22457 (defun org-back-over-empty-lines ()
22458 "Move backwards over whitespace, to the beginning of the first empty line.
22459 Returns the number of empty lines passed."
22460 (let ((pos (point)))
22461 (if (cdr (assoc 'heading org-blank-before-new-entry))
22462 (skip-chars-backward " \t\n\r")
22463 (unless (eobp)
22464 (forward-line -1)))
22465 (beginning-of-line 2)
22466 (goto-char (min (point) pos))
22467 (count-lines (point) pos)))
22469 (defun org-skip-whitespace ()
22470 (skip-chars-forward " \t\n\r"))
22472 (defun org-point-in-group (point group &optional context)
22473 "Check if POINT is in match-group GROUP.
22474 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22475 match. If the match group does not exist or point is not inside it,
22476 return nil."
22477 (and (match-beginning group)
22478 (>= point (match-beginning group))
22479 (<= point (match-end group))
22480 (if context
22481 (list context (match-beginning group) (match-end group))
22482 t)))
22484 (defun org-switch-to-buffer-other-window (&rest args)
22485 "Switch to buffer in a second window on the current frame.
22486 In particular, do not allow pop-up frames.
22487 Returns the newly created buffer."
22488 (org-no-popups
22489 (apply 'switch-to-buffer-other-window args)))
22491 (defun org-combine-plists (&rest plists)
22492 "Create a single property list from all plists in PLISTS.
22493 The process starts by copying the first list, and then setting properties
22494 from the other lists. Settings in the last list are the most significant
22495 ones and overrule settings in the other lists."
22496 (let ((rtn (copy-sequence (pop plists)))
22497 p v ls)
22498 (while plists
22499 (setq ls (pop plists))
22500 (while ls
22501 (setq p (pop ls) v (pop ls))
22502 (setq rtn (plist-put rtn p v))))
22503 rtn))
22505 (defun org-replace-escapes (string table)
22506 "Replace %-escapes in STRING with values in TABLE.
22507 TABLE is an association list with keys like \"%a\" and string values.
22508 The sequences in STRING may contain normal field width and padding information,
22509 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22510 so values can contain further %-escapes if they are define later in TABLE."
22511 (let ((tbl (copy-alist table))
22512 (case-fold-search nil)
22513 (pchg 0)
22514 e re rpl)
22515 (while (setq e (pop tbl))
22516 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22517 (when (and (cdr e) (string-match re (cdr e)))
22518 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22519 (safe "SREF"))
22520 (add-text-properties 0 3 (list 'sref sref) safe)
22521 (setcdr e (replace-match safe t t (cdr e)))))
22522 (while (string-match re string)
22523 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22524 (cdr e)))
22525 (setq string (replace-match rpl t t string))))
22526 (while (setq pchg (next-property-change pchg string))
22527 (let ((sref (get-text-property pchg 'sref string)))
22528 (when (and sref (string-match "SREF" string pchg))
22529 (setq string (replace-match sref t t string)))))
22530 string))
22532 (defun org-sublist (list start end)
22533 "Return a section of LIST, from START to END.
22534 Counting starts at 1."
22535 (let (rtn (c start))
22536 (setq list (nthcdr (1- start) list))
22537 (while (and list (<= c end))
22538 (push (pop list) rtn)
22539 (setq c (1+ c)))
22540 (nreverse rtn)))
22542 (defun org-find-base-buffer-visiting (file)
22543 "Like `find-buffer-visiting' but always return the base buffer and
22544 not an indirect buffer."
22545 (let ((buf (or (get-file-buffer file)
22546 (find-buffer-visiting file))))
22547 (if buf
22548 (or (buffer-base-buffer buf) buf)
22549 nil)))
22551 (defun org-image-file-name-regexp (&optional extensions)
22552 "Return regexp matching the file names of images.
22553 If EXTENSIONS is given, only match these."
22554 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22555 (image-file-name-regexp)
22556 (let ((image-file-name-extensions
22557 (or extensions
22558 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22559 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22560 (concat "\\."
22561 (regexp-opt (nconc (mapcar 'upcase
22562 image-file-name-extensions)
22563 image-file-name-extensions)
22565 "\\'"))))
22567 (defun org-file-image-p (file &optional extensions)
22568 "Return non-nil if FILE is an image."
22569 (save-match-data
22570 (string-match (org-image-file-name-regexp extensions) file)))
22572 (defun org-get-cursor-date (&optional with-time)
22573 "Return the date at cursor in as a time.
22574 This works in the calendar and in the agenda, anywhere else it just
22575 returns the current time.
22576 If WITH-TIME is non-nil, returns the time of the event at point (in
22577 the agenda) or the current time of the day."
22578 (let (date day defd tp tm hod mod)
22579 (when with-time
22580 (setq tp (get-text-property (point) 'time))
22581 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22582 (setq hod (string-to-number (match-string 1 tp))
22583 mod (string-to-number (match-string 2 tp))))
22584 (or tp (setq hod (nth 2 (decode-time (current-time)))
22585 mod (nth 1 (decode-time (current-time))))))
22586 (cond
22587 ((eq major-mode 'calendar-mode)
22588 (setq date (calendar-cursor-to-date)
22589 defd (encode-time 0 (or mod 0) (or hod 0)
22590 (nth 1 date) (nth 0 date) (nth 2 date))))
22591 ((eq major-mode 'org-agenda-mode)
22592 (setq day (get-text-property (point) 'day))
22593 (if day
22594 (setq date (calendar-gregorian-from-absolute day)
22595 defd (encode-time 0 (or mod 0) (or hod 0)
22596 (nth 1 date) (nth 0 date) (nth 2 date))))))
22597 (or defd (current-time))))
22599 (defun org-mark-subtree (&optional up)
22600 "Mark the current subtree.
22601 This puts point at the start of the current subtree, and mark at
22602 the end. If a numeric prefix UP is given, move up into the
22603 hierarchy of headlines by UP levels before marking the subtree."
22604 (interactive "P")
22605 (org-with-limited-levels
22606 (cond ((org-at-heading-p) (beginning-of-line))
22607 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22608 (t (outline-previous-visible-heading 1))))
22609 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22610 (if (org-called-interactively-p 'any)
22611 (call-interactively 'org-mark-element)
22612 (org-mark-element)))
22615 ;;; Indentation
22617 (defun org--get-expected-indentation (element contentsp)
22618 "Expected indentation column for current line, according to ELEMENT.
22619 ELEMENT is an element containing point. CONTENTSP is non-nil
22620 when indentation is to be computed according to contents of
22621 ELEMENT."
22622 (let ((type (org-element-type element))
22623 (start (org-element-property :begin element)))
22624 (org-with-wide-buffer
22625 (cond
22626 (contentsp
22627 (case type
22628 (footnote-definition 0)
22629 ((headline inlinetask nil)
22630 (if (not org-adapt-indentation) 0
22631 (let ((level (org-current-level)))
22632 (if level (1+ level) 0))))
22633 (item
22634 (org-list-item-body-column
22635 (org-element-property :post-affiliated element)))
22636 (plain-list
22637 (save-excursion
22638 (goto-char (org-element-property :post-affiliated element))
22639 (org-get-indentation)))
22640 (otherwise
22641 (goto-char start)
22642 (org-get-indentation))))
22643 ((memq type '(headline inlinetask nil))
22644 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22645 (org--get-expected-indentation element t)
22647 ((eq type 'footnote-definition) 0)
22648 ;; First paragraph of a footnote definition or an item.
22649 ;; Indent like parent.
22650 ((< (line-beginning-position) start)
22651 (org--get-expected-indentation
22652 (org-element-property :parent element) t))
22653 ;; At first line: indent according to previous sibling, if any,
22654 ;; ignoring footnote definitions and inline tasks, or parent's
22655 ;; contents.
22656 ((= (line-beginning-position) start)
22657 (catch 'exit
22658 (while t
22659 (if (= (point-min) start) (throw 'exit 0)
22660 (goto-char (1- start))
22661 (let* ((previous (org-element-at-point))
22662 (parent previous))
22663 (while (and parent (<= (org-element-property :end parent) start))
22664 (setq previous parent
22665 parent (org-element-property :parent parent)))
22666 (cond
22667 ((not previous) (throw 'exit 0))
22668 ((> (org-element-property :end previous) start)
22669 (throw 'exit (org--get-expected-indentation previous t)))
22670 ((memq (org-element-type previous)
22671 '(footnote-definition inlinetask))
22672 (setq start (org-element-property :begin previous)))
22673 (t (goto-char (org-element-property :begin previous))
22674 (throw 'exit
22675 (if (bolp) (org-get-indentation)
22676 ;; At first paragraph in an item or
22677 ;; a footnote definition.
22678 (org--get-expected-indentation
22679 (org-element-property :parent previous) t))))))))))
22680 ;; Otherwise, move to the first non-blank line above.
22682 (beginning-of-line)
22683 (let ((pos (point)))
22684 (skip-chars-backward " \r\t\n")
22685 (cond
22686 ;; Two blank lines end a footnote definition or a plain
22687 ;; list. When we indent an empty line after them, the
22688 ;; containing list or footnote definition is over, so it
22689 ;; qualifies as a previous sibling. Therefore, we indent
22690 ;; like its first line.
22691 ((and (memq type '(footnote-definition plain-list))
22692 (> (count-lines (point) pos) 2))
22693 (goto-char start)
22694 (org-get-indentation))
22695 ;; Line above is the first one of a paragraph at the
22696 ;; beginning of an item or a footnote definition. Indent
22697 ;; like parent.
22698 ((< (line-beginning-position) start)
22699 (org--get-expected-indentation
22700 (org-element-property :parent element) t))
22701 ;; POS is after contents in a greater element. Indent like
22702 ;; the beginning of the element.
22704 ;; As a special case, if point is at the end of a footnote
22705 ;; definition or an item, indent like the very last element
22706 ;; within.
22707 ((and (not (eq type 'paragraph))
22708 (let ((cend (org-element-property :contents-end element)))
22709 (and cend (<= cend pos))))
22710 (if (memq type '(footnote-definition item plain-list))
22711 (org--get-expected-indentation (org-element-at-point) nil)
22712 (goto-char start)
22713 (org-get-indentation)))
22714 ;; In any other case, indent like the current line.
22715 (t (org-get-indentation)))))))))
22717 (defun org--align-node-property ()
22718 "Align node property at point.
22719 Alignment is done according to `org-property-format', which see."
22720 (when (save-excursion
22721 (beginning-of-line)
22722 (looking-at org-property-re))
22723 (replace-match
22724 (concat (match-string 4)
22725 (org-trim
22726 (format org-property-format (match-string 1) (match-string 3))))
22727 t t)))
22729 (defun org-indent-line ()
22730 "Indent line depending on context.
22732 Indentation is done according to the following rules:
22734 - Footnote definitions, headlines and inline tasks have to
22735 start at column 0.
22737 - On the very first line of an element, consider, in order, the
22738 next rules until one matches:
22740 1. If there's a sibling element before, ignoring footnote
22741 definitions and inline tasks, indent like its first line.
22743 2. If element has a parent, indent like its contents. More
22744 precisely, if parent is an item, indent after the
22745 description part, if any, or the bullet (see
22746 `org-list-description-max-indent'). Else, indent like
22747 parent's first line.
22749 3. Otherwise, indent relatively to current level, if
22750 `org-adapt-indentation' is non-nil, or to left margin.
22752 - On a blank line at the end of an element, indent according to
22753 the type of the element. More precisely
22755 1. If element is a plain list, an item, or a footnote
22756 definition, indent like the very last element within.
22758 2. If element is a paragraph, indent like its last non blank
22759 line.
22761 3. Otherwise, indent like its very first line.
22763 - In the code part of a source block, use language major mode
22764 to indent current line if `org-src-tab-acts-natively' is
22765 non-nil. If it is nil, do nothing.
22767 - Otherwise, indent like the first non-blank line above.
22769 The function doesn't indent an item as it could break the whole
22770 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22771 \\[org-shiftmetaright].
22773 Also align node properties according to `org-property-format'."
22774 (interactive)
22775 (cond
22776 (orgstruct-is-++
22777 (let ((indent-line-function
22778 (cadadr (assq 'indent-line-function org-fb-vars))))
22779 (indent-according-to-mode)))
22780 ((org-at-heading-p) 'noindent)
22782 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22783 (type (org-element-type element)))
22784 (cond ((and (memq type '(plain-list item))
22785 (= (line-beginning-position)
22786 (org-element-property :post-affiliated element)))
22787 'noindent)
22788 ((and (eq type 'src-block)
22789 org-src-tab-acts-natively
22790 (> (line-beginning-position)
22791 (org-element-property :post-affiliated element))
22792 (< (line-beginning-position)
22793 (org-with-wide-buffer
22794 (goto-char (org-element-property :end element))
22795 (skip-chars-backward " \r\t\n")
22796 (line-beginning-position))))
22797 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22799 (let ((column (org--get-expected-indentation element nil)))
22800 ;; Preserve current column.
22801 (if (<= (current-column) (current-indentation))
22802 (org-indent-line-to column)
22803 (save-excursion (org-indent-line-to column))))
22804 ;; Align node property. Also preserve current column.
22805 (when (eq type 'node-property)
22806 (let ((column (current-column)))
22807 (org--align-node-property)
22808 (org-move-to-column column)))))))))
22810 (defun org-indent-region (start end)
22811 "Indent each non-blank line in the region.
22812 Called from a program, START and END specify the region to
22813 indent. The function will not indent contents of example blocks,
22814 verse blocks and export blocks as leading white spaces are
22815 assumed to be significant there."
22816 (interactive "r")
22817 (save-excursion
22818 (goto-char start)
22819 (skip-chars-forward " \r\t\n")
22820 (unless (eobp) (beginning-of-line))
22821 (let ((indent-to
22822 (lambda (ind pos)
22823 ;; Set IND as indentation for all lines between point and
22824 ;; POS or END, whichever comes first. Blank lines are
22825 ;; ignored. Leave point after POS once done.
22826 (let ((limit (copy-marker (min end pos))))
22827 (while (< (point) limit)
22828 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
22829 (forward-line))
22830 (set-marker limit nil))))
22831 (end (copy-marker end)))
22832 (while (< (point) end)
22833 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
22834 (let* ((element (org-element-at-point))
22835 (type (org-element-type element))
22836 (element-end (copy-marker (org-element-property :end element)))
22837 (ind (org--get-expected-indentation element nil)))
22838 (cond
22839 ((or (memq type '(paragraph table table-row))
22840 (not (or (org-element-property :contents-begin element)
22841 (memq type
22842 '(example-block export-block src-block)))))
22843 ;; Elements here are indented as a single block. Also
22844 ;; align node properties.
22845 (when (eq type 'node-property)
22846 (org--align-node-property)
22847 (beginning-of-line))
22848 (funcall indent-to ind element-end))
22850 ;; Elements in this category consist of three parts:
22851 ;; before the contents, the contents, and after the
22852 ;; contents. The contents are treated specially,
22853 ;; according to the element type, or not indented at
22854 ;; all. Other parts are indented as a single block.
22855 (let* ((post (copy-marker
22856 (org-element-property :post-affiliated element)))
22857 (cbeg
22858 (copy-marker
22859 (cond
22860 ((not (org-element-property :contents-begin element))
22861 ;; Fake contents for source blocks.
22862 (org-with-wide-buffer
22863 (goto-char post)
22864 (forward-line)
22865 (point)))
22866 ((memq type '(footnote-definition item plain-list))
22867 ;; Contents in these elements could start on
22868 ;; the same line as the beginning of the
22869 ;; element. Make sure we start indenting
22870 ;; from the second line.
22871 (org-with-wide-buffer
22872 (goto-char post)
22873 (end-of-line)
22874 (skip-chars-forward " \r\t\n")
22875 (if (eobp) (point) (line-beginning-position))))
22876 (t (org-element-property :contents-begin element)))))
22877 (cend (copy-marker
22878 (or (org-element-property :contents-end element)
22879 ;; Fake contents for source blocks.
22880 (org-with-wide-buffer
22881 (goto-char element-end)
22882 (skip-chars-backward " \r\t\n")
22883 (line-beginning-position)))
22884 t)))
22885 ;; Do not change items indentation individually as it
22886 ;; might break the list as a whole. On the other
22887 ;; hand, when at a plain list, indent it as a whole.
22888 (cond ((eq type 'plain-list)
22889 (let ((offset (- ind (org-get-indentation))))
22890 (unless (zerop offset)
22891 (indent-rigidly (org-element-property :begin element)
22892 (org-element-property :end element)
22893 offset))
22894 (goto-char cbeg)))
22895 ((eq type 'item) (goto-char cbeg))
22896 (t (funcall indent-to ind cbeg)))
22897 (when (< (point) end)
22898 (case type
22899 ((example-block export-block verse-block))
22900 (src-block
22901 ;; In a source block, indent source code
22902 ;; according to language major mode, but only if
22903 ;; `org-src-tab-acts-natively' is non-nil.
22904 (when (and (< (point) end) org-src-tab-acts-natively)
22905 (ignore-errors
22906 (org-babel-do-in-edit-buffer
22907 (indent-region (point-min) (point-max))))))
22908 (t (org-indent-region (point) (min cend end))))
22909 (goto-char (min cend end))
22910 (when (< (point) end) (funcall indent-to ind element-end)))
22911 (set-marker post nil)
22912 (set-marker cbeg nil)
22913 (set-marker cend nil))))
22914 (set-marker element-end nil))))
22915 (set-marker end nil))))
22917 (defun org-indent-drawer ()
22918 "Indent the drawer at point."
22919 (interactive)
22920 (unless (save-excursion
22921 (beginning-of-line)
22922 (org-looking-at-p org-drawer-regexp))
22923 (user-error "Not at a drawer"))
22924 (let ((element (org-element-at-point)))
22925 (unless (memq (org-element-type element) '(drawer property-drawer))
22926 (user-error "Not at a drawer"))
22927 (org-with-wide-buffer
22928 (org-indent-region (org-element-property :begin element)
22929 (org-element-property :end element))))
22930 (message "Drawer at point indented"))
22932 (defun org-indent-block ()
22933 "Indent the block at point."
22934 (interactive)
22935 (unless (save-excursion
22936 (beginning-of-line)
22937 (let ((case-fold-search t))
22938 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
22939 (user-error "Not at a block"))
22940 (let ((element (org-element-at-point)))
22941 (unless (memq (org-element-type element)
22942 '(comment-block center-block dynamic-block example-block
22943 export-block quote-block special-block
22944 src-block verse-block))
22945 (user-error "Not at a block"))
22946 (org-with-wide-buffer
22947 (org-indent-region (org-element-property :begin element)
22948 (org-element-property :end element))))
22949 (message "Block at point indented"))
22952 ;;; Filling
22954 ;; We use our own fill-paragraph and auto-fill functions.
22956 ;; `org-fill-paragraph' relies on adaptive filling and context
22957 ;; checking. Appropriate `fill-prefix' is computed with
22958 ;; `org-adaptive-fill-function'.
22960 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22961 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22962 ;; `org-adaptive-fill-function' value. Internally,
22963 ;; `org-comment-line-break-function' breaks the line.
22965 ;; `org-setup-filling' installs filling and auto-filling related
22966 ;; variables during `org-mode' initialization.
22968 (defvar org-element-paragraph-separate) ; org-element.el
22969 (defun org-setup-filling ()
22970 (require 'org-element)
22971 ;; Prevent auto-fill from inserting unwanted new items.
22972 (when (boundp 'fill-nobreak-predicate)
22973 (org-set-local
22974 'fill-nobreak-predicate
22975 (org-uniquify
22976 (append fill-nobreak-predicate
22977 '(org-fill-line-break-nobreak-p
22978 org-fill-paragraph-with-timestamp-nobreak-p)))))
22979 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22980 (org-set-local 'paragraph-start paragraph-ending)
22981 (org-set-local 'paragraph-separate paragraph-ending))
22982 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22983 (org-set-local 'auto-fill-inhibit-regexp nil)
22984 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22985 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22986 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22988 (defun org-fill-line-break-nobreak-p ()
22989 "Non-nil when a new line at point would create an Org line break."
22990 (save-excursion
22991 (skip-chars-backward "[ \t]")
22992 (skip-chars-backward "\\\\")
22993 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22995 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22996 "Non-nil when a new line at point would split a timestamp."
22997 (and (org-at-timestamp-p t)
22998 (not (looking-at org-ts-regexp-both))))
23000 (declare-function message-in-body-p "message" ())
23001 (defvar orgtbl-line-start-regexp) ; From org-table.el
23002 (defun org-adaptive-fill-function ()
23003 "Compute a fill prefix for the current line.
23004 Return fill prefix, as a string, or nil if current line isn't
23005 meant to be filled. For convenience, if `adaptive-fill-regexp'
23006 matches in paragraphs or comments, use it."
23007 (catch 'exit
23008 (when (derived-mode-p 'message-mode)
23009 (save-excursion
23010 (beginning-of-line)
23011 (cond ((not (message-in-body-p)) (throw 'exit nil))
23012 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23013 ((looking-at message-cite-prefix-regexp)
23014 (throw 'exit (match-string-no-properties 0)))
23015 ((looking-at org-outline-regexp)
23016 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23017 (org-with-wide-buffer
23018 (unless (org-at-heading-p)
23019 (let* ((p (line-beginning-position))
23020 (element (save-excursion
23021 (beginning-of-line)
23022 (org-element-at-point)))
23023 (type (org-element-type element))
23024 (post-affiliated (org-element-property :post-affiliated element)))
23025 (unless (< p post-affiliated)
23026 (case type
23027 (comment
23028 (save-excursion
23029 (beginning-of-line)
23030 (looking-at "[ \t]*")
23031 (concat (match-string 0) "# ")))
23032 (footnote-definition "")
23033 ((item plain-list)
23034 (make-string (org-list-item-body-column post-affiliated) ?\s))
23035 (paragraph
23036 ;; Fill prefix is usually the same as the current line,
23037 ;; unless the paragraph is at the beginning of an item.
23038 (let ((parent (org-element-property :parent element)))
23039 (save-excursion
23040 (beginning-of-line)
23041 (cond ((eq (org-element-type parent) 'item)
23042 (make-string (org-list-item-body-column
23043 (org-element-property :begin parent))
23044 ?\s))
23045 ((and adaptive-fill-regexp
23046 ;; Locally disable
23047 ;; `adaptive-fill-function' to let
23048 ;; `fill-context-prefix' handle
23049 ;; `adaptive-fill-regexp' variable.
23050 (let (adaptive-fill-function)
23051 (fill-context-prefix
23052 post-affiliated
23053 (org-element-property :end element)))))
23054 ((looking-at "[ \t]+") (match-string 0))
23055 (t "")))))
23056 (comment-block
23057 ;; Only fill contents if P is within block boundaries.
23058 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23059 (forward-line)
23060 (point)))
23061 (cend (save-excursion
23062 (goto-char (org-element-property :end element))
23063 (skip-chars-backward " \r\t\n")
23064 (line-beginning-position))))
23065 (when (and (>= p cbeg) (< p cend))
23066 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23067 (match-string 0)
23068 "")))))))))))
23070 (declare-function message-goto-body "message" ())
23071 (defvar message-cite-prefix-regexp) ; From message.el
23072 (defun org-fill-paragraph (&optional justify)
23073 "Fill element at point, when applicable.
23075 This function only applies to comment blocks, comments, example
23076 blocks and paragraphs. Also, as a special case, re-align table
23077 when point is at one.
23079 If JUSTIFY is non-nil (interactively, with prefix argument),
23080 justify as well. If `sentence-end-double-space' is non-nil, then
23081 period followed by one space does not end a sentence, so don't
23082 break a line there. The variable `fill-column' controls the
23083 width for filling.
23085 For convenience, when point is at a plain list, an item or
23086 a footnote definition, try to fill the first paragraph within."
23087 (interactive)
23088 (if (and (derived-mode-p 'message-mode)
23089 (or (not (message-in-body-p))
23090 (save-excursion (move-beginning-of-line 1)
23091 (looking-at message-cite-prefix-regexp))))
23092 ;; First ensure filling is correct in message-mode.
23093 (let ((fill-paragraph-function
23094 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23095 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23096 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23097 (paragraph-separate
23098 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23099 (fill-paragraph nil))
23100 (with-syntax-table org-mode-transpose-word-syntax-table
23101 ;; Move to end of line in order to get the first paragraph
23102 ;; within a plain list or a footnote definition.
23103 (let ((element (save-excursion
23104 (end-of-line)
23105 (or (ignore-errors (org-element-at-point))
23106 (user-error "An element cannot be parsed line %d"
23107 (line-number-at-pos (point)))))))
23108 ;; First check if point is in a blank line at the beginning of
23109 ;; the buffer. In that case, ignore filling.
23110 (case (org-element-type element)
23111 ;; Use major mode filling function is src blocks.
23112 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23113 ;; Align Org tables, leave table.el tables as-is.
23114 (table-row (org-table-align) t)
23115 (table
23116 (when (eq (org-element-property :type element) 'org)
23117 (save-excursion
23118 (goto-char (org-element-property :post-affiliated element))
23119 (org-table-align)))
23121 (paragraph
23122 ;; Paragraphs may contain `line-break' type objects.
23123 (let ((beg (max (point-min)
23124 (org-element-property :contents-begin element)))
23125 (end (min (point-max)
23126 (org-element-property :contents-end element))))
23127 ;; Do nothing if point is at an affiliated keyword.
23128 (if (< (line-end-position) beg) t
23129 (when (derived-mode-p 'message-mode)
23130 ;; In `message-mode', do not fill following citation
23131 ;; in current paragraph nor text before message body.
23132 (let ((body-start (save-excursion (message-goto-body))))
23133 (when body-start (setq beg (max body-start beg))))
23134 (when (save-excursion
23135 (re-search-forward
23136 (concat "^" message-cite-prefix-regexp) end t))
23137 (setq end (match-beginning 0))))
23138 ;; Fill paragraph, taking line breaks into account.
23139 (save-excursion
23140 (goto-char beg)
23141 (let ((cuts (list beg)))
23142 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23143 (when (eq 'line-break
23144 (org-element-type
23145 (save-excursion (backward-char)
23146 (org-element-context))))
23147 (push (point) cuts)))
23148 (dolist (c (delq end cuts))
23149 (fill-region-as-paragraph c end justify)
23150 (setq end c))))
23151 t)))
23152 ;; Contents of `comment-block' type elements should be
23153 ;; filled as plain text, but only if point is within block
23154 ;; markers.
23155 (comment-block
23156 (let* ((case-fold-search t)
23157 (beg (save-excursion
23158 (goto-char (org-element-property :begin element))
23159 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23160 (forward-line)
23161 (point)))
23162 (end (save-excursion
23163 (goto-char (org-element-property :end element))
23164 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23165 (line-beginning-position))))
23166 (if (or (< (point) beg) (> (point) end)) t
23167 (fill-region-as-paragraph
23168 (save-excursion (end-of-line)
23169 (re-search-backward "^[ \t]*$" beg 'move)
23170 (line-beginning-position))
23171 (save-excursion (beginning-of-line)
23172 (re-search-forward "^[ \t]*$" end 'move)
23173 (line-beginning-position))
23174 justify))))
23175 ;; Fill comments.
23176 (comment
23177 (let ((begin (org-element-property :post-affiliated element))
23178 (end (org-element-property :end element)))
23179 (when (and (>= (point) begin) (<= (point) end))
23180 (let ((begin (save-excursion
23181 (end-of-line)
23182 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23183 (progn (forward-line) (point))
23184 begin)))
23185 (end (save-excursion
23186 (end-of-line)
23187 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23188 (1- (line-beginning-position))
23189 (skip-chars-backward " \r\t\n")
23190 (line-end-position)))))
23191 ;; Do not fill comments when at a blank line.
23192 (when (> end begin)
23193 (let ((fill-prefix
23194 (save-excursion
23195 (beginning-of-line)
23196 (looking-at "[ \t]*#")
23197 (let ((comment-prefix (match-string 0)))
23198 (goto-char (match-end 0))
23199 (if (looking-at adaptive-fill-regexp)
23200 (concat comment-prefix (match-string 0))
23201 (concat comment-prefix " "))))))
23202 (save-excursion
23203 (fill-region-as-paragraph begin end justify))))))
23205 ;; Ignore every other element.
23206 (otherwise t))))))
23208 (defun org-auto-fill-function ()
23209 "Auto-fill function."
23210 ;; Check if auto-filling is meaningful.
23211 (let ((fc (current-fill-column)))
23212 (when (and fc (> (current-column) fc))
23213 (let* ((fill-prefix (org-adaptive-fill-function))
23214 ;; Enforce empty fill prefix, if required. Otherwise, it
23215 ;; will be computed again.
23216 (adaptive-fill-mode (not (equal fill-prefix ""))))
23217 (when fill-prefix (do-auto-fill))))))
23219 (defun org-comment-line-break-function (&optional soft)
23220 "Break line at point and indent, continuing comment if within one.
23221 The inserted newline is marked hard if variable
23222 `use-hard-newlines' is true, unless optional argument SOFT is
23223 non-nil."
23224 (if soft (insert-and-inherit ?\n) (newline 1))
23225 (save-excursion (forward-char -1) (delete-horizontal-space))
23226 (delete-horizontal-space)
23227 (indent-to-left-margin)
23228 (insert-before-markers-and-inherit fill-prefix))
23231 ;;; Fixed Width Areas
23233 (defun org-toggle-fixed-width ()
23234 "Toggle fixed-width markup.
23236 Add or remove fixed-width markup on current line, whenever it
23237 makes sense. Return an error otherwise.
23239 If a region is active and if it contains only fixed-width areas
23240 or blank lines, remove all fixed-width markup in it. If the
23241 region contains anything else, convert all non-fixed-width lines
23242 to fixed-width ones.
23244 Blank lines at the end of the region are ignored unless the
23245 region only contains such lines."
23246 (interactive)
23247 (if (not (org-region-active-p))
23248 ;; No region:
23250 ;; Remove fixed width marker only in a fixed-with element.
23252 ;; Add fixed width maker in paragraphs, in blank lines after
23253 ;; elements or at the beginning of a headline or an inlinetask,
23254 ;; and before any one-line elements (e.g., a clock).
23255 (progn
23256 (beginning-of-line)
23257 (let* ((element (org-element-at-point))
23258 (type (org-element-type element)))
23259 (cond
23260 ((and (eq type 'fixed-width)
23261 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23262 (replace-match
23263 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23264 ((and (memq type '(babel-call clock comment diary-sexp headline
23265 horizontal-rule keyword paragraph
23266 planning))
23267 (<= (org-element-property :post-affiliated element) (point)))
23268 (skip-chars-forward " \t")
23269 (insert ": "))
23270 ((and (org-looking-at-p "[ \t]*$")
23271 (or (eq type 'inlinetask)
23272 (save-excursion
23273 (skip-chars-forward " \r\t\n")
23274 (<= (org-element-property :end element) (point)))))
23275 (delete-region (point) (line-end-position))
23276 (org-indent-line)
23277 (insert ": "))
23278 (t (user-error "Cannot insert a fixed-width line here")))))
23279 ;; Region active.
23280 (let* ((begin (save-excursion
23281 (goto-char (region-beginning))
23282 (line-beginning-position)))
23283 (end (copy-marker
23284 (save-excursion
23285 (goto-char (region-end))
23286 (unless (eolp) (beginning-of-line))
23287 (if (save-excursion (re-search-backward "\\S-" begin t))
23288 (progn (skip-chars-backward " \r\t\n") (point))
23289 (point)))))
23290 (all-fixed-width-p
23291 (catch 'not-all-p
23292 (save-excursion
23293 (goto-char begin)
23294 (skip-chars-forward " \r\t\n")
23295 (when (eobp) (throw 'not-all-p nil))
23296 (while (< (point) end)
23297 (let ((element (org-element-at-point)))
23298 (if (eq (org-element-type element) 'fixed-width)
23299 (goto-char (org-element-property :end element))
23300 (throw 'not-all-p nil))))
23301 t))))
23302 (if all-fixed-width-p
23303 (save-excursion
23304 (goto-char begin)
23305 (while (< (point) end)
23306 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23307 (replace-match
23308 "" nil nil nil
23309 (if (= (line-end-position) (match-end 0)) 0 1)))
23310 (forward-line)))
23311 (let ((min-ind (point-max)))
23312 ;; Find minimum indentation across all lines.
23313 (save-excursion
23314 (goto-char begin)
23315 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23316 (setq min-ind 0)
23317 (catch 'zerop
23318 (while (< (point) end)
23319 (unless (org-looking-at-p "[ \t]*$")
23320 (let ((ind (org-get-indentation)))
23321 (setq min-ind (min min-ind ind))
23322 (when (zerop ind) (throw 'zerop t))))
23323 (forward-line)))))
23324 ;; Loop over all lines and add fixed-width markup everywhere
23325 ;; but in fixed-width lines.
23326 (save-excursion
23327 (goto-char begin)
23328 (while (< (point) end)
23329 (cond
23330 ((org-at-heading-p)
23331 (insert ": ")
23332 (forward-line)
23333 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23334 (insert ":")
23335 (forward-line)))
23336 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23337 (let* ((element (org-element-at-point))
23338 (element-end (org-element-property :end element)))
23339 (if (eq (org-element-type element) 'fixed-width)
23340 (progn (goto-char element-end)
23341 (skip-chars-backward " \r\t\n")
23342 (forward-line))
23343 (let ((limit (min end element-end)))
23344 (while (< (point) limit)
23345 (org-move-to-column min-ind t)
23346 (insert ": ")
23347 (forward-line))))))
23349 (org-move-to-column min-ind t)
23350 (insert ": ")
23351 (forward-line)))))))
23352 (set-marker end nil))))
23355 ;;; Comments
23357 ;; Org comments syntax is quite complex. It requires the entire line
23358 ;; to be just a comment. Also, even with the right syntax at the
23359 ;; beginning of line, some some elements (i.e. verse-block or
23360 ;; example-block) don't accept comments. Usual Emacs comment commands
23361 ;; cannot cope with those requirements. Therefore, Org replaces them.
23363 ;; Org still relies on `comment-dwim', but cannot trust
23364 ;; `comment-only-p'. So, `comment-region-function' and
23365 ;; `uncomment-region-function' both point
23366 ;; to`org-comment-or-uncomment-region'. Eventually,
23367 ;; `org-insert-comment' takes care of insertion of comments at the
23368 ;; beginning of line.
23370 ;; `org-setup-comments-handling' install comments related variables
23371 ;; during `org-mode' initialization.
23373 (defun org-setup-comments-handling ()
23374 (interactive)
23375 (org-set-local 'comment-use-syntax nil)
23376 (org-set-local 'comment-start "# ")
23377 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23378 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23379 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23380 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23382 (defun org-insert-comment ()
23383 "Insert an empty comment above current line.
23384 If the line is empty, insert comment at its beginning. When
23385 point is within a source block, comment according to the related
23386 major mode."
23387 (if (let ((element (org-element-at-point)))
23388 (and (eq (org-element-type element) 'src-block)
23389 (< (save-excursion
23390 (goto-char (org-element-property :post-affiliated element))
23391 (line-end-position))
23392 (point))
23393 (> (save-excursion
23394 (goto-char (org-element-property :end element))
23395 (skip-chars-backward " \r\t\n")
23396 (line-beginning-position))
23397 (point))))
23398 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23399 (beginning-of-line)
23400 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23401 (open-line 1))
23402 (org-indent-line)
23403 (insert "# ")))
23405 (defvar comment-empty-lines) ; From newcomment.el.
23406 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23407 "Comment or uncomment each non-blank line in the region.
23408 Uncomment each non-blank line between BEG and END if it only
23409 contains commented lines. Otherwise, comment them. If region is
23410 strictly within a source block, use appropriate comment syntax."
23411 (if (let ((element (org-element-at-point)))
23412 (and (eq (org-element-type element) 'src-block)
23413 (< (save-excursion
23414 (goto-char (org-element-property :post-affiliated element))
23415 (line-end-position))
23416 beg)
23417 (>= (save-excursion
23418 (goto-char (org-element-property :end element))
23419 (skip-chars-backward " \r\t\n")
23420 (line-beginning-position))
23421 end)))
23422 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23423 (save-restriction
23424 ;; Restrict region
23425 (narrow-to-region (save-excursion (goto-char beg)
23426 (skip-chars-forward " \r\t\n" end)
23427 (line-beginning-position))
23428 (save-excursion (goto-char end)
23429 (skip-chars-backward " \r\t\n" beg)
23430 (line-end-position)))
23431 (let ((uncommentp
23432 ;; UNCOMMENTP is non-nil when every non blank line between
23433 ;; BEG and END is a comment.
23434 (save-excursion
23435 (goto-char (point-min))
23436 (while (and (not (eobp))
23437 (let ((element (org-element-at-point)))
23438 (and (eq (org-element-type element) 'comment)
23439 (goto-char (min (point-max)
23440 (org-element-property
23441 :end element)))))))
23442 (eobp))))
23443 (if uncommentp
23444 ;; Only blank lines and comments in region: uncomment it.
23445 (save-excursion
23446 (goto-char (point-min))
23447 (while (not (eobp))
23448 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23449 (replace-match "" nil nil nil 1))
23450 (forward-line)))
23451 ;; Comment each line in region.
23452 (let ((min-indent (point-max)))
23453 ;; First find the minimum indentation across all lines.
23454 (save-excursion
23455 (goto-char (point-min))
23456 (while (and (not (eobp)) (not (zerop min-indent)))
23457 (unless (looking-at "[ \t]*$")
23458 (setq min-indent (min min-indent (current-indentation))))
23459 (forward-line)))
23460 ;; Then loop over all lines.
23461 (save-excursion
23462 (goto-char (point-min))
23463 (while (not (eobp))
23464 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23465 ;; Don't get fooled by invisible text (e.g. link path)
23466 ;; when moving to column MIN-INDENT.
23467 (let ((buffer-invisibility-spec nil))
23468 (org-move-to-column min-indent t))
23469 (insert comment-start))
23470 (forward-line)))))))))
23472 (defun org-comment-dwim (arg)
23473 "Call `comment-dwim' within a source edit buffer if needed."
23474 (interactive "*P")
23475 (if (org-in-src-block-p)
23476 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23477 (call-interactively 'comment-dwim)))
23480 ;;; Timestamps API
23482 ;; This section contains tools to operate on timestamp objects, as
23483 ;; returned by, e.g. `org-element-context'.
23485 (defun org-timestamp--to-internal-time (timestamp &optional end)
23486 "Encode TIMESTAMP object into Emacs internal time.
23487 Use end of date range or time range when END is non-nil."
23488 (apply #'encode-time
23489 (cons 0
23490 (mapcar
23491 (lambda (prop) (or (org-element-property prop timestamp) 0))
23492 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23493 '(:minute-start :hour-start :day-start :month-start
23494 :year-start))))))
23496 (defun org-timestamp-has-time-p (timestamp)
23497 "Non-nil when TIMESTAMP has a time specified."
23498 (org-element-property :hour-start timestamp))
23500 (defun org-timestamp-format (timestamp format &optional end utc)
23501 "Format a TIMESTAMP object into a string.
23503 FORMAT is a format specifier to be passed to
23504 `format-time-string'.
23506 When optional argument END is non-nil, use end of date-range or
23507 time-range, if possible.
23509 When optional argument UTC is non-nil, time will be expressed as
23510 Universal Time."
23511 (format-time-string
23512 format (org-timestamp--to-internal-time timestamp end) utc))
23514 (defun org-timestamp-split-range (timestamp &optional end)
23515 "Extract a TIMESTAMP object from a date or time range.
23517 END, when non-nil, means extract the end of the range.
23518 Otherwise, extract its start.
23520 Return a new timestamp object."
23521 (let ((type (org-element-property :type timestamp)))
23522 (if (memq type '(active inactive diary)) timestamp
23523 (let ((split-ts (org-element-copy timestamp)))
23524 ;; Set new type.
23525 (org-element-put-property
23526 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23527 ;; Copy start properties over end properties if END is
23528 ;; non-nil. Otherwise, copy end properties over `start' ones.
23529 (let ((p-alist '((:minute-start . :minute-end)
23530 (:hour-start . :hour-end)
23531 (:day-start . :day-end)
23532 (:month-start . :month-end)
23533 (:year-start . :year-end))))
23534 (dolist (p-cell p-alist)
23535 (org-element-put-property
23536 split-ts
23537 (funcall (if end #'car #'cdr) p-cell)
23538 (org-element-property
23539 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23540 ;; Eventually refresh `:raw-value'.
23541 (org-element-put-property split-ts :raw-value nil)
23542 (org-element-put-property
23543 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23545 (defun org-timestamp-translate (timestamp &optional boundary)
23546 "Translate TIMESTAMP object to custom format.
23548 Format string is defined in `org-time-stamp-custom-formats',
23549 which see.
23551 When optional argument BOUNDARY is non-nil, it is either the
23552 symbol `start' or `end'. In this case, only translate the
23553 starting or ending part of TIMESTAMP if it is a date or time
23554 range. Otherwise, translate both parts.
23556 Return timestamp as-is if `org-display-custom-times' is nil or if
23557 it has a `diary' type."
23558 (let ((type (org-element-property :type timestamp)))
23559 (if (or (not org-display-custom-times) (eq type 'diary))
23560 (org-element-interpret-data timestamp)
23561 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23562 org-time-stamp-custom-formats)))
23563 (if (and (not boundary) (memq type '(active-range inactive-range)))
23564 (concat (org-timestamp-format timestamp fmt)
23565 "--"
23566 (org-timestamp-format timestamp fmt t))
23567 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23571 ;;; Other stuff.
23573 (defun org-reftex-citation ()
23574 "Use reftex-citation to insert a citation into the buffer.
23575 This looks for a line like
23577 #+BIBLIOGRAPHY: foo plain option:-d
23579 and derives from it that foo.bib is the bibliography file relevant
23580 for this document. It then installs the necessary environment for RefTeX
23581 to work in this buffer and calls `reftex-citation' to insert a citation
23582 into the buffer.
23584 Export of such citations to both LaTeX and HTML is handled by the contributed
23585 package ox-bibtex by Taru Karttunen."
23586 (interactive)
23587 (let ((reftex-docstruct-symbol 'rds)
23588 (reftex-cite-format "\\cite{%l}")
23589 rds bib)
23590 (save-excursion
23591 (save-restriction
23592 (widen)
23593 (let ((case-fold-search t)
23594 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23595 (if (not (save-excursion
23596 (or (re-search-forward re nil t)
23597 (re-search-backward re nil t))))
23598 (user-error "No bibliography defined in file")
23599 (setq bib (concat (match-string 1) ".bib")
23600 rds (list (list 'bib bib)))))))
23601 (call-interactively 'reftex-citation)))
23603 ;;;; Functions extending outline functionality
23605 (defun org-beginning-of-line (&optional arg)
23606 "Go to the beginning of the current line. If that is invisible, continue
23607 to a visible line beginning. This makes the function of C-a more intuitive.
23608 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23609 first attempt, and only move to after the tags when the cursor is already
23610 beyond the end of the headline."
23611 (interactive "P")
23612 (let ((pos (point))
23613 (special (if (consp org-special-ctrl-a/e)
23614 (car org-special-ctrl-a/e)
23615 org-special-ctrl-a/e))
23616 deactivate-mark refpos)
23617 (if (org-bound-and-true-p visual-line-mode)
23618 (beginning-of-visual-line 1)
23619 (beginning-of-line 1))
23620 (if (and arg (fboundp 'move-beginning-of-line))
23621 (call-interactively 'move-beginning-of-line)
23622 (if (bobp)
23624 (backward-char 1)
23625 (if (org-truely-invisible-p)
23626 (while (and (not (bobp)) (org-truely-invisible-p))
23627 (backward-char 1)
23628 (beginning-of-line 1))
23629 (forward-char 1))))
23630 (when special
23631 (cond
23632 ((and (looking-at org-complex-heading-regexp)
23633 (= (char-after (match-end 1)) ?\ ))
23634 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23635 (point-at-eol)))
23636 (goto-char
23637 (if (eq special t)
23638 (cond ((> pos refpos) refpos)
23639 ((= pos (point)) refpos)
23640 (t (point)))
23641 (cond ((> pos (point)) (point))
23642 ((not (eq last-command this-command)) (point))
23643 (t refpos)))))
23644 ((org-at-item-p)
23645 ;; Being at an item and not looking at an the item means point
23646 ;; was previously moved to beginning of a visual line, which
23647 ;; doesn't contain the item. Therefore, do nothing special,
23648 ;; just stay here.
23649 (when (looking-at org-list-full-item-re)
23650 ;; Set special position at first white space character after
23651 ;; bullet, and check-box, if any.
23652 (let ((after-bullet
23653 (let ((box (match-end 3)))
23654 (if (not box) (match-end 1)
23655 (let ((after (char-after box)))
23656 (if (and after (= after ? )) (1+ box) box))))))
23657 ;; Special case: Move point to special position when
23658 ;; currently after it or at beginning of line.
23659 (if (eq special t)
23660 (when (or (> pos after-bullet) (= (point) pos))
23661 (goto-char after-bullet))
23662 ;; Reversed case: Move point to special position when
23663 ;; point was already at beginning of line and command is
23664 ;; repeated.
23665 (when (and (= (point) pos) (eq last-command this-command))
23666 (goto-char after-bullet))))))))
23667 (org-no-warnings
23668 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23669 (setq disable-point-adjustment
23670 (or (not (invisible-p (point)))
23671 (not (invisible-p (max (point-min) (1- (point))))))))
23673 (defun org-end-of-line (&optional arg)
23674 "Go to the end of the line.
23675 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23676 tags on the first attempt, and only move to after the tags when
23677 the cursor is already beyond the end of the headline."
23678 (interactive "P")
23679 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23680 org-special-ctrl-a/e))
23681 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23682 'end-of-visual-line)
23683 ((fboundp 'move-end-of-line) 'move-end-of-line)
23684 (t 'end-of-line)))
23685 deactivate-mark)
23686 (if (or (not special) arg) (call-interactively move-fun)
23687 (let* ((element (save-excursion (beginning-of-line)
23688 (org-element-at-point)))
23689 (type (org-element-type element)))
23690 (cond
23691 ((memq type '(headline inlinetask))
23692 (let ((pos (point)))
23693 (beginning-of-line 1)
23694 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23695 (if (eq special t)
23696 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23697 (goto-char (match-beginning 1))
23698 (goto-char (match-end 0)))
23699 (if (or (< pos (match-end 0))
23700 (not (eq this-command last-command)))
23701 (goto-char (match-end 0))
23702 (goto-char (match-beginning 1))))
23703 (call-interactively move-fun))))
23704 ((outline-invisible-p (line-end-position))
23705 ;; If element is hidden, `move-end-of-line' would put point
23706 ;; after it. Use `end-of-line' to stay on current line.
23707 (call-interactively 'end-of-line))
23708 (t (call-interactively move-fun)))))
23709 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23710 (setq disable-point-adjustment
23711 (or (not (invisible-p (point)))
23712 (not (invisible-p (max (point-min) (1- (point))))))))
23714 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23715 (define-key org-mode-map "\C-e" 'org-end-of-line)
23717 (defun org-backward-sentence (&optional arg)
23718 "Go to beginning of sentence, or beginning of table field.
23719 This will call `backward-sentence' or `org-table-beginning-of-field',
23720 depending on context."
23721 (interactive "P")
23722 (cond
23723 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
23724 (t (call-interactively 'backward-sentence))))
23726 (defun org-forward-sentence (&optional arg)
23727 "Go to end of sentence, or end of table field.
23728 This will call `forward-sentence' or `org-table-end-of-field',
23729 depending on context."
23730 (interactive "P")
23731 (cond
23732 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
23733 (t (call-interactively 'forward-sentence))))
23735 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23736 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23738 (defun org-kill-line (&optional arg)
23739 "Kill line, to tags or end of line."
23740 (interactive "P")
23741 (cond
23742 ((or (not org-special-ctrl-k)
23743 (bolp)
23744 (not (org-at-heading-p)))
23745 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23746 org-ctrl-k-protect-subtree)
23747 (if (or (eq org-ctrl-k-protect-subtree 'error)
23748 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23749 (user-error "C-k aborted as it would kill a hidden subtree")))
23750 (call-interactively
23751 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23752 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23753 (kill-region (point) (match-beginning 1))
23754 (org-set-tags nil t))
23755 (t (kill-region (point) (point-at-eol)))))
23757 (define-key org-mode-map "\C-k" 'org-kill-line)
23759 (defun org-yank (&optional arg)
23760 "Yank. If the kill is a subtree, treat it specially.
23761 This command will look at the current kill and check if is a single
23762 subtree, or a series of subtrees[1]. If it passes the test, and if the
23763 cursor is at the beginning of a line or after the stars of a currently
23764 empty headline, then the yank is handled specially. How exactly depends
23765 on the value of the following variables, both set by default.
23767 `org-yank-folded-subtrees'
23768 When set, the subtree(s) will be folded after insertion, but only
23769 if doing so would now swallow text after the yanked text.
23771 `org-yank-adjusted-subtrees'
23772 When set, the subtree will be promoted or demoted in order to
23773 fit into the local outline tree structure, which means that the
23774 level will be adjusted so that it becomes the smaller one of the
23775 two *visible* surrounding headings.
23777 Any prefix to this command will cause `yank' to be called directly with
23778 no special treatment. In particular, a simple \\[universal-argument] prefix \
23779 will just
23780 plainly yank the text as it is.
23782 \[1] The test checks if the first non-white line is a heading
23783 and if there are no other headings with fewer stars."
23784 (interactive "P")
23785 (org-yank-generic 'yank arg))
23787 (defun org-yank-generic (command arg)
23788 "Perform some yank-like command.
23790 This function implements the behavior described in the `org-yank'
23791 documentation. However, it has been generalized to work for any
23792 interactive command with similar behavior."
23794 ;; pretend to be command COMMAND
23795 (setq this-command command)
23797 (if arg
23798 (call-interactively command)
23800 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23801 (and (org-kill-is-subtree-p)
23802 (or (bolp)
23803 (and (looking-at "[ \t]*$")
23804 (string-match
23805 "\\`\\*+\\'"
23806 (buffer-substring (point-at-bol) (point)))))))
23807 swallowp)
23808 (cond
23809 ((and subtreep org-yank-folded-subtrees)
23810 (let ((beg (point))
23811 end)
23812 (if (and subtreep org-yank-adjusted-subtrees)
23813 (org-paste-subtree nil nil 'for-yank)
23814 (call-interactively command))
23816 (setq end (point))
23817 (goto-char beg)
23818 (when (and (bolp) subtreep
23819 (not (setq swallowp
23820 (org-yank-folding-would-swallow-text beg end))))
23821 (org-with-limited-levels
23822 (or (looking-at org-outline-regexp)
23823 (re-search-forward org-outline-regexp-bol end t))
23824 (while (and (< (point) end) (looking-at org-outline-regexp))
23825 (hide-subtree)
23826 (org-cycle-show-empty-lines 'folded)
23827 (condition-case nil
23828 (outline-forward-same-level 1)
23829 (error (goto-char end))))))
23830 (when swallowp
23831 (message
23832 "Inserted text not folded because that would swallow text"))
23834 (goto-char end)
23835 (skip-chars-forward " \t\n\r")
23836 (beginning-of-line 1)
23837 (push-mark beg 'nomsg)))
23838 ((and subtreep org-yank-adjusted-subtrees)
23839 (let ((beg (point-at-bol)))
23840 (org-paste-subtree nil nil 'for-yank)
23841 (push-mark beg 'nomsg)))
23843 (call-interactively command))))))
23845 (defun org-yank-folding-would-swallow-text (beg end)
23846 "Would hide-subtree at BEG swallow any text after END?"
23847 (let (level)
23848 (org-with-limited-levels
23849 (save-excursion
23850 (goto-char beg)
23851 (when (or (looking-at org-outline-regexp)
23852 (re-search-forward org-outline-regexp-bol end t))
23853 (setq level (org-outline-level)))
23854 (goto-char end)
23855 (skip-chars-forward " \t\r\n\v\f")
23856 (if (or (eobp)
23857 (and (bolp) (looking-at org-outline-regexp)
23858 (<= (org-outline-level) level)))
23859 nil ; Nothing would be swallowed
23860 t))))) ; something would swallow
23862 (define-key org-mode-map "\C-y" 'org-yank)
23864 (defun org-truely-invisible-p ()
23865 "Check if point is at a character currently not visible.
23866 This version does not only check the character property, but also
23867 `visible-mode'."
23868 ;; Early versions of noutline don't have `outline-invisible-p'.
23869 (if (org-bound-and-true-p visible-mode)
23871 (outline-invisible-p)))
23873 (defun org-invisible-p2 ()
23874 "Check if point is at a character currently not visible."
23875 (save-excursion
23876 (if (and (eolp) (not (bobp))) (backward-char 1))
23877 ;; Early versions of noutline don't have `outline-invisible-p'.
23878 (outline-invisible-p)))
23880 (defun org-back-to-heading (&optional invisible-ok)
23881 "Call `outline-back-to-heading', but provide a better error message."
23882 (condition-case nil
23883 (outline-back-to-heading invisible-ok)
23884 (error (error "Before first headline at position %d in buffer %s"
23885 (point) (current-buffer)))))
23887 (defun org-before-first-heading-p ()
23888 "Before first heading?"
23889 (save-excursion
23890 (end-of-line)
23891 (null (re-search-backward org-outline-regexp-bol nil t))))
23893 (defun org-at-heading-p (&optional ignored)
23894 (outline-on-heading-p t))
23895 ;; Compatibility alias with Org versions < 7.8.03
23896 (defalias 'org-on-heading-p 'org-at-heading-p)
23898 (defun org-in-commented-heading-p (&optional no-inheritance)
23899 "Non-nil if point is under a commented heading.
23900 This function also checks ancestors of the current headline,
23901 unless optional argument NO-INHERITANCE is non-nil."
23902 (cond
23903 ((org-before-first-heading-p) nil)
23904 ((let ((headline (nth 4 (org-heading-components))))
23905 (and headline
23906 (let ((case-fold-search nil))
23907 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
23908 headline)))))
23909 (no-inheritance nil)
23911 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
23913 (defun org-at-comment-p nil
23914 "Is cursor in a commented line?"
23915 (save-excursion
23916 (save-match-data
23917 (beginning-of-line)
23918 (looking-at "^[ \t]*# "))))
23920 (defun org-at-drawer-p nil
23921 "Is cursor at a drawer keyword?"
23922 (save-excursion
23923 (move-beginning-of-line 1)
23924 (looking-at org-drawer-regexp)))
23926 (defun org-at-block-p nil
23927 "Is cursor at a block keyword?"
23928 (save-excursion
23929 (move-beginning-of-line 1)
23930 (looking-at org-block-regexp)))
23932 (defun org-point-at-end-of-empty-headline ()
23933 "If point is at the end of an empty headline, return t, else nil.
23934 If the heading only contains a TODO keyword, it is still still considered
23935 empty."
23936 (and (looking-at "[ \t]*$")
23937 (when org-todo-line-regexp
23938 (save-excursion
23939 (beginning-of-line 1)
23940 (let ((case-fold-search nil))
23941 (looking-at org-todo-line-regexp)
23942 (string= (match-string 3) ""))))))
23944 (defun org-at-heading-or-item-p ()
23945 (or (org-at-heading-p) (org-at-item-p)))
23947 (defun org-at-target-p ()
23948 (or (org-in-regexp org-radio-target-regexp)
23949 (org-in-regexp org-target-regexp)))
23950 ;; Compatibility alias with Org versions < 7.8.03
23951 (defalias 'org-on-target-p 'org-at-target-p)
23953 (defun org-up-heading-all (arg)
23954 "Move to the heading line of which the present line is a subheading.
23955 This function considers both visible and invisible heading lines.
23956 With argument, move up ARG levels."
23957 (if (fboundp 'outline-up-heading-all)
23958 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23959 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23961 (defun org-up-heading-safe ()
23962 "Move to the heading line of which the present line is a subheading.
23963 This version will not throw an error. It will return the level of the
23964 headline found, or nil if no higher level is found.
23966 Also, this function will be a lot faster than `outline-up-heading',
23967 because it relies on stars being the outline starters. This can really
23968 make a significant difference in outlines with very many siblings."
23969 (when (ignore-errors (org-back-to-heading t))
23970 (let ((level-up (1- (funcall outline-level))))
23971 (and (> level-up 0)
23972 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
23973 (funcall outline-level)))))
23975 (defun org-first-sibling-p ()
23976 "Is this heading the first child of its parents?"
23977 (interactive)
23978 (let ((re org-outline-regexp-bol)
23979 level l)
23980 (unless (org-at-heading-p t)
23981 (user-error "Not at a heading"))
23982 (setq level (funcall outline-level))
23983 (save-excursion
23984 (if (not (re-search-backward re nil t))
23986 (setq l (funcall outline-level))
23987 (< l level)))))
23989 (defun org-goto-sibling (&optional previous)
23990 "Goto the next sibling, even if it is invisible.
23991 When PREVIOUS is set, go to the previous sibling instead. Returns t
23992 when a sibling was found. When none is found, return nil and don't
23993 move point."
23994 (let ((fun (if previous 're-search-backward 're-search-forward))
23995 (pos (point))
23996 (re org-outline-regexp-bol)
23997 level l)
23998 (when (ignore-errors (org-back-to-heading t))
23999 (setq level (funcall outline-level))
24000 (catch 'exit
24001 (or previous (forward-char 1))
24002 (while (funcall fun re nil t)
24003 (setq l (funcall outline-level))
24004 (when (< l level) (goto-char pos) (throw 'exit nil))
24005 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24006 (goto-char pos)
24007 nil))))
24009 (defun org-show-siblings ()
24010 "Show all siblings of the current headline."
24011 (save-excursion
24012 (while (org-goto-sibling) (org-flag-heading nil)))
24013 (save-excursion
24014 (while (org-goto-sibling 'previous)
24015 (org-flag-heading nil))))
24017 (defun org-goto-first-child ()
24018 "Goto the first child, even if it is invisible.
24019 Return t when a child was found. Otherwise don't move point and
24020 return nil."
24021 (let (level (pos (point)) (re org-outline-regexp-bol))
24022 (when (ignore-errors (org-back-to-heading t))
24023 (setq level (outline-level))
24024 (forward-char 1)
24025 (if (and (re-search-forward re nil t) (> (outline-level) level))
24026 (progn (goto-char (match-beginning 0)) t)
24027 (goto-char pos) nil))))
24029 (defun org-show-hidden-entry ()
24030 "Show an entry where even the heading is hidden."
24031 (save-excursion
24032 (org-show-entry)))
24034 (defun org-flag-heading (flag &optional entry)
24035 "Flag the current heading. FLAG non-nil means make invisible.
24036 When ENTRY is non-nil, show the entire entry."
24037 (save-excursion
24038 (org-back-to-heading t)
24039 ;; Check if we should show the entire entry
24040 (if entry
24041 (progn
24042 (org-show-entry)
24043 (save-excursion
24044 (and (outline-next-heading)
24045 (org-flag-heading nil))))
24046 (outline-flag-region (max (point-min) (1- (point)))
24047 (save-excursion (outline-end-of-heading) (point))
24048 flag))))
24050 (defun org-get-next-sibling ()
24051 "Move to next heading of the same level, and return point.
24052 If there is no such heading, return nil.
24053 This is like outline-next-sibling, but invisible headings are ok."
24054 (let ((level (funcall outline-level)))
24055 (outline-next-heading)
24056 (while (and (not (eobp)) (> (funcall outline-level) level))
24057 (outline-next-heading))
24058 (if (or (eobp) (< (funcall outline-level) level))
24060 (point))))
24062 (defun org-get-last-sibling ()
24063 "Move to previous heading of the same level, and return point.
24064 If there is no such heading, return nil."
24065 (let ((opoint (point))
24066 (level (funcall outline-level)))
24067 (outline-previous-heading)
24068 (when (and (/= (point) opoint) (outline-on-heading-p t))
24069 (while (and (> (funcall outline-level) level)
24070 (not (bobp)))
24071 (outline-previous-heading))
24072 (if (< (funcall outline-level) level)
24074 (point)))))
24076 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24077 "Goto to the end of a subtree."
24078 ;; This contains an exact copy of the original function, but it uses
24079 ;; `org-back-to-heading', to make it work also in invisible
24080 ;; trees. And is uses an invisible-ok argument.
24081 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24082 ;; Furthermore, when used inside Org, finding the end of a large subtree
24083 ;; with many children and grandchildren etc, this can be much faster
24084 ;; than the outline version.
24085 (org-back-to-heading invisible-ok)
24086 (let ((first t)
24087 (level (funcall outline-level)))
24088 (if (and (derived-mode-p 'org-mode) (< level 1000))
24089 ;; A true heading (not a plain list item), in Org-mode
24090 ;; This means we can easily find the end by looking
24091 ;; only for the right number of stars. Using a regexp to do
24092 ;; this is so much faster than using a Lisp loop.
24093 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24094 (forward-char 1)
24095 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24096 ;; something else, do it the slow way
24097 (while (and (not (eobp))
24098 (or first (> (funcall outline-level) level)))
24099 (setq first nil)
24100 (outline-next-heading)))
24101 (unless to-heading
24102 (if (memq (preceding-char) '(?\n ?\^M))
24103 (progn
24104 ;; Go to end of line before heading
24105 (forward-char -1)
24106 (if (memq (preceding-char) '(?\n ?\^M))
24107 ;; leave blank line before heading
24108 (forward-char -1))))))
24109 (point))
24111 (defun org-end-of-meta-data (&optional full)
24112 "Skip planning line and properties drawer in current entry.
24113 When optional argument FULL is non-nil, also skip empty lines,
24114 clocking lines and regular drawers at the beginning of the
24115 entry."
24116 (org-back-to-heading t)
24117 (forward-line)
24118 (when (org-looking-at-p org-planning-line-re) (forward-line))
24119 (when (looking-at org-property-drawer-re)
24120 (goto-char (match-end 0))
24121 (forward-line))
24122 (when (and full (not (org-at-heading-p)))
24123 (catch 'exit
24124 (let ((end (save-excursion (outline-next-heading) (point)))
24125 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24126 (while (not (eobp))
24127 (cond ((org-looking-at-p org-drawer-regexp)
24128 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24129 (forward-line)
24130 (throw 'exit t)))
24131 ((org-looking-at-p re) (forward-line))
24132 (t (throw 'exit t))))))))
24134 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24135 "Move forward to the ARG'th subheading at same level as this one.
24136 Stop at the first and last subheadings of a superior heading.
24137 Normally this only looks at visible headings, but when INVISIBLE-OK is
24138 non-nil it will also look at invisible ones."
24139 (interactive "p")
24140 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24141 (if (and arg (< arg 0))
24142 (goto-char (point-min))
24143 (outline-next-heading))
24144 (org-at-heading-p)
24145 (let ((level (- (match-end 0) (match-beginning 0) 1))
24146 (f (if (and arg (< arg 0))
24147 're-search-backward
24148 're-search-forward))
24149 (count (if arg (abs arg) 1))
24150 (result (point)))
24151 (while (and (prog1 (> count 0)
24152 (forward-char (if (and arg (< arg 0)) -1 1)))
24153 (funcall f org-outline-regexp-bol nil 'move))
24154 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24155 (cond ((< l level) (setq count 0))
24156 ((and (= l level)
24157 (or invisible-ok
24158 (progn
24159 (goto-char (line-beginning-position))
24160 (not (outline-invisible-p)))))
24161 (setq count (1- count))
24162 (when (eq l level)
24163 (setq result (point)))))))
24164 (goto-char result))
24165 (beginning-of-line 1)))
24167 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24168 "Move backward to the ARG'th subheading at same level as this one.
24169 Stop at the first and last subheadings of a superior heading."
24170 (interactive "p")
24171 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24173 (defun org-next-visible-heading (arg)
24174 "Move to the next visible heading.
24176 This function wraps `outline-next-visible-heading' with
24177 `org-with-limited-levels' in order to skip over inline tasks and
24178 respect customization of `org-odd-levels-only'."
24179 (interactive "p")
24180 (org-with-limited-levels
24181 (outline-next-visible-heading arg)))
24183 (defun org-previous-visible-heading (arg)
24184 "Move to the next visible heading.
24186 This function wraps `outline-previous-visible-heading' with
24187 `org-with-limited-levels' in order to skip over inline tasks and
24188 respect customization of `org-odd-levels-only'."
24189 (interactive "p")
24190 (org-with-limited-levels
24191 (outline-previous-visible-heading arg)))
24193 (defun org-next-block (arg &optional backward block-regexp)
24194 "Jump to the next block.
24195 With a prefix argument ARG, jump forward ARG many source blocks.
24196 When BACKWARD is non-nil, jump to the previous block.
24197 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24198 (interactive "p")
24199 (let ((re (or block-regexp org-block-regexp))
24200 (re-search-fn (or (and backward 're-search-backward)
24201 're-search-forward)))
24202 (if (looking-at re) (forward-char 1))
24203 (condition-case nil
24204 (funcall re-search-fn re nil nil arg)
24205 (error (user-error "No %s code blocks"
24206 (if backward "previous" "further" ))))
24207 (goto-char (match-beginning 0)) (org-show-context)))
24209 (defun org-previous-block (arg &optional block-regexp)
24210 "Jump to the previous block.
24211 With a prefix argument ARG, jump backward ARG many source blocks.
24212 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24213 (interactive "p")
24214 (org-next-block arg t block-regexp))
24216 (defun org-forward-paragraph ()
24217 "Move forward to beginning of next paragraph or equivalent.
24219 The function moves point to the beginning of the next visible
24220 structural element, which can be a paragraph, a table, a list
24221 item, etc. It also provides some special moves for convenience:
24223 - On an affiliated keyword, jump to the beginning of the
24224 relative element.
24225 - On an item or a footnote definition, move to the second
24226 element inside, if any.
24227 - On a table or a property drawer, jump after it.
24228 - On a verse or source block, stop after blank lines."
24229 (interactive)
24230 (when (eobp) (user-error "Cannot move further down"))
24231 (let* ((deactivate-mark nil)
24232 (element (org-element-at-point))
24233 (type (org-element-type element))
24234 (post-affiliated (org-element-property :post-affiliated element))
24235 (contents-begin (org-element-property :contents-begin element))
24236 (contents-end (org-element-property :contents-end element))
24237 (end (let ((end (org-element-property :end element)) (parent element))
24238 (while (and (setq parent (org-element-property :parent parent))
24239 (= (org-element-property :contents-end parent) end))
24240 (setq end (org-element-property :end parent)))
24241 end)))
24242 (cond ((not element)
24243 (skip-chars-forward " \r\t\n")
24244 (or (eobp) (beginning-of-line)))
24245 ;; On affiliated keywords, move to element's beginning.
24246 ((< (point) post-affiliated)
24247 (goto-char post-affiliated))
24248 ;; At a table row, move to the end of the table. Similarly,
24249 ;; at a node property, move to the end of the property
24250 ;; drawer.
24251 ((memq type '(node-property table-row))
24252 (goto-char (org-element-property
24253 :end (org-element-property :parent element))))
24254 ((memq type '(property-drawer table)) (goto-char end))
24255 ;; Consider blank lines as separators in verse and source
24256 ;; blocks to ease editing.
24257 ((memq type '(src-block verse-block))
24258 (when (eq type 'src-block)
24259 (setq contents-end
24260 (save-excursion (goto-char end)
24261 (skip-chars-backward " \r\t\n")
24262 (line-beginning-position))))
24263 (beginning-of-line)
24264 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24265 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24266 (goto-char end)
24267 (skip-chars-forward " \r\t\n")
24268 (if (= (point) contents-end) (goto-char end)
24269 (beginning-of-line))))
24270 ;; With no contents, just skip element.
24271 ((not contents-begin) (goto-char end))
24272 ;; If contents are invisible, skip the element altogether.
24273 ((outline-invisible-p (line-end-position))
24274 (case type
24275 (headline
24276 (org-with-limited-levels (outline-next-visible-heading 1)))
24277 ;; At a plain list, make sure we move to the next item
24278 ;; instead of skipping the whole list.
24279 (plain-list (forward-char)
24280 (org-forward-paragraph))
24281 (otherwise (goto-char end))))
24282 ((>= (point) contents-end) (goto-char end))
24283 ((>= (point) contents-begin)
24284 ;; This can only happen on paragraphs and plain lists.
24285 (case type
24286 (paragraph (goto-char end))
24287 ;; At a plain list, try to move to second element in
24288 ;; first item, if possible.
24289 (plain-list (end-of-line)
24290 (org-forward-paragraph))))
24291 ;; When contents start on the middle of a line (e.g. in
24292 ;; items and footnote definitions), try to reach first
24293 ;; element starting after current line.
24294 ((> (line-end-position) contents-begin)
24295 (end-of-line)
24296 (org-forward-paragraph))
24297 (t (goto-char contents-begin)))))
24299 (defun org-backward-paragraph ()
24300 "Move backward to start of previous paragraph or equivalent.
24302 The function moves point to the beginning of the current
24303 structural element, which can be a paragraph, a table, a list
24304 item, etc., or to the beginning of the previous visible one if
24305 point is already there. It also provides some special moves for
24306 convenience:
24308 - On an affiliated keyword, jump to the first one.
24309 - On a table or a property drawer, move to its beginning.
24310 - On a verse or source block, stop before blank lines."
24311 (interactive)
24312 (when (bobp) (user-error "Cannot move further up"))
24313 (let* ((deactivate-mark nil)
24314 (element (org-element-at-point))
24315 (type (org-element-type element))
24316 (contents-begin (org-element-property :contents-begin element))
24317 (contents-end (org-element-property :contents-end element))
24318 (post-affiliated (org-element-property :post-affiliated element))
24319 (begin (org-element-property :begin element)))
24320 (cond
24321 ((not element) (goto-char (point-min)))
24322 ((= (point) begin)
24323 (backward-char)
24324 (org-backward-paragraph))
24325 ((<= (point) post-affiliated) (goto-char begin))
24326 ((memq type '(node-property table-row))
24327 (goto-char (org-element-property
24328 :post-affiliated (org-element-property :parent element))))
24329 ((memq type '(property-drawer table)) (goto-char begin))
24330 ((memq type '(src-block verse-block))
24331 (when (eq type 'src-block)
24332 (setq contents-begin
24333 (save-excursion (goto-char begin) (forward-line) (point))))
24334 (if (= (point) contents-begin) (goto-char post-affiliated)
24335 ;; Inside a verse block, see blank lines as paragraph
24336 ;; separators.
24337 (let ((origin (point)))
24338 (skip-chars-backward " \r\t\n" contents-begin)
24339 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24340 (skip-chars-forward " \r\t\n" origin)
24341 (if (= (point) origin) (goto-char contents-begin)
24342 (beginning-of-line))))))
24343 ((not contents-begin) (goto-char (or post-affiliated begin)))
24344 ((eq type 'paragraph)
24345 (goto-char contents-begin)
24346 ;; When at first paragraph in an item or a footnote definition,
24347 ;; move directly to beginning of line.
24348 (let ((parent-contents
24349 (org-element-property
24350 :contents-begin (org-element-property :parent element))))
24351 (when (and parent-contents (= parent-contents contents-begin))
24352 (beginning-of-line))))
24353 ;; At the end of a greater element, move to the beginning of the
24354 ;; last element within.
24355 ((>= (point) contents-end)
24356 (goto-char (1- contents-end))
24357 (org-backward-paragraph))
24358 (t (goto-char (or post-affiliated begin))))
24359 ;; Ensure we never leave point invisible.
24360 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24362 (defun org-forward-element ()
24363 "Move forward by one element.
24364 Move to the next element at the same level, when possible."
24365 (interactive)
24366 (cond ((eobp) (user-error "Cannot move further down"))
24367 ((org-with-limited-levels (org-at-heading-p))
24368 (let ((origin (point)))
24369 (goto-char (org-end-of-subtree nil t))
24370 (unless (org-with-limited-levels (org-at-heading-p))
24371 (goto-char origin)
24372 (user-error "Cannot move further down"))))
24374 (let* ((elem (org-element-at-point))
24375 (end (org-element-property :end elem))
24376 (parent (org-element-property :parent elem)))
24377 (cond ((and parent (= (org-element-property :contents-end parent) end))
24378 (goto-char (org-element-property :end parent)))
24379 ((integer-or-marker-p end) (goto-char end))
24380 (t (message "No element at point")))))))
24382 (defun org-backward-element ()
24383 "Move backward by one element.
24384 Move to the previous element at the same level, when possible."
24385 (interactive)
24386 (cond ((bobp) (user-error "Cannot move further up"))
24387 ((org-with-limited-levels (org-at-heading-p))
24388 ;; At a headline, move to the previous one, if any, or stay
24389 ;; here.
24390 (let ((origin (point)))
24391 (org-with-limited-levels (org-backward-heading-same-level 1))
24392 ;; When current headline has no sibling above, move to its
24393 ;; parent.
24394 (when (= (point) origin)
24395 (or (org-with-limited-levels (org-up-heading-safe))
24396 (progn (goto-char origin)
24397 (user-error "Cannot move further up"))))))
24399 (let* ((elem (org-element-at-point))
24400 (beg (org-element-property :begin elem)))
24401 (cond
24402 ;; Move to beginning of current element if point isn't
24403 ;; there already.
24404 ((null beg) (message "No element at point"))
24405 ((/= (point) beg) (goto-char beg))
24406 (t (goto-char beg)
24407 (skip-chars-backward " \r\t\n")
24408 (unless (bobp)
24409 (let ((prev (org-element-at-point)))
24410 (goto-char (org-element-property :begin prev))
24411 (while (and (setq prev (org-element-property :parent prev))
24412 (<= (org-element-property :end prev) beg))
24413 (goto-char (org-element-property :begin prev)))))))))))
24415 (defun org-up-element ()
24416 "Move to upper element."
24417 (interactive)
24418 (if (org-with-limited-levels (org-at-heading-p))
24419 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24420 (let* ((elem (org-element-at-point))
24421 (parent (org-element-property :parent elem)))
24422 (if parent (goto-char (org-element-property :begin parent))
24423 (if (org-with-limited-levels (org-before-first-heading-p))
24424 (user-error "No surrounding element")
24425 (org-with-limited-levels (org-back-to-heading)))))))
24427 (defvar org-element-greater-elements)
24428 (defun org-down-element ()
24429 "Move to inner element."
24430 (interactive)
24431 (let ((element (org-element-at-point)))
24432 (cond
24433 ((memq (org-element-type element) '(plain-list table))
24434 (goto-char (org-element-property :contents-begin element))
24435 (forward-char))
24436 ((memq (org-element-type element) org-element-greater-elements)
24437 ;; If contents are hidden, first disclose them.
24438 (when (outline-invisible-p (line-end-position)) (org-cycle))
24439 (goto-char (or (org-element-property :contents-begin element)
24440 (user-error "No content for this element"))))
24441 (t (user-error "No inner element")))))
24443 (defun org-drag-element-backward ()
24444 "Move backward element at point."
24445 (interactive)
24446 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24447 (let* ((elem (org-element-at-point))
24448 (prev-elem
24449 (save-excursion
24450 (goto-char (org-element-property :begin elem))
24451 (skip-chars-backward " \r\t\n")
24452 (unless (bobp)
24453 (let* ((beg (org-element-property :begin elem))
24454 (prev (org-element-at-point))
24455 (up prev))
24456 (while (and (setq up (org-element-property :parent up))
24457 (<= (org-element-property :end up) beg))
24458 (setq prev up))
24459 prev)))))
24460 ;; Error out if no previous element or previous element is
24461 ;; a parent of the current one.
24462 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24463 (user-error "Cannot drag element backward")
24464 (let ((pos (point)))
24465 (org-element-swap-A-B prev-elem elem)
24466 (goto-char (+ (org-element-property :begin prev-elem)
24467 (- pos (org-element-property :begin elem)))))))))
24469 (defun org-drag-element-forward ()
24470 "Move forward element at point."
24471 (interactive)
24472 (let* ((pos (point))
24473 (elem (org-element-at-point)))
24474 (when (= (point-max) (org-element-property :end elem))
24475 (user-error "Cannot drag element forward"))
24476 (goto-char (org-element-property :end elem))
24477 (let ((next-elem (org-element-at-point)))
24478 (when (or (org-element-nested-p elem next-elem)
24479 (and (eq (org-element-type next-elem) 'headline)
24480 (not (eq (org-element-type elem) 'headline))))
24481 (goto-char pos)
24482 (user-error "Cannot drag element forward"))
24483 ;; Compute new position of point: it's shifted by NEXT-ELEM
24484 ;; body's length (without final blanks) and by the length of
24485 ;; blanks between ELEM and NEXT-ELEM.
24486 (let ((size-next (- (save-excursion
24487 (goto-char (org-element-property :end next-elem))
24488 (skip-chars-backward " \r\t\n")
24489 (forward-line)
24490 ;; Small correction if buffer doesn't end
24491 ;; with a newline character.
24492 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24493 (org-element-property :begin next-elem)))
24494 (size-blank (- (org-element-property :end elem)
24495 (save-excursion
24496 (goto-char (org-element-property :end elem))
24497 (skip-chars-backward " \r\t\n")
24498 (forward-line)
24499 (point)))))
24500 (org-element-swap-A-B elem next-elem)
24501 (goto-char (+ pos size-next size-blank))))))
24503 (defun org-drag-line-forward (arg)
24504 "Drag the line at point ARG lines forward."
24505 (interactive "p")
24506 (dotimes (n (abs arg))
24507 (let ((c (current-column)))
24508 (if (< 0 arg)
24509 (progn
24510 (beginning-of-line 2)
24511 (transpose-lines 1)
24512 (beginning-of-line 0))
24513 (transpose-lines 1)
24514 (beginning-of-line -1))
24515 (org-move-to-column c))))
24517 (defun org-drag-line-backward (arg)
24518 "Drag the line at point ARG lines backward."
24519 (interactive "p")
24520 (org-drag-line-forward (- arg)))
24522 (defun org-mark-element ()
24523 "Put point at beginning of this element, mark at end.
24525 Interactively, if this command is repeated or (in Transient Mark
24526 mode) if the mark is active, it marks the next element after the
24527 ones already marked."
24528 (interactive)
24529 (let (deactivate-mark)
24530 (if (and (org-called-interactively-p 'any)
24531 (or (and (eq last-command this-command) (mark t))
24532 (and transient-mark-mode mark-active)))
24533 (set-mark
24534 (save-excursion
24535 (goto-char (mark))
24536 (goto-char (org-element-property :end (org-element-at-point)))))
24537 (let ((element (org-element-at-point)))
24538 (end-of-line)
24539 (push-mark (org-element-property :end element) t t)
24540 (goto-char (org-element-property :begin element))))))
24542 (defun org-narrow-to-element ()
24543 "Narrow buffer to current element."
24544 (interactive)
24545 (let ((elem (org-element-at-point)))
24546 (cond
24547 ((eq (car elem) 'headline)
24548 (narrow-to-region
24549 (org-element-property :begin elem)
24550 (org-element-property :end elem)))
24551 ((memq (car elem) org-element-greater-elements)
24552 (narrow-to-region
24553 (org-element-property :contents-begin elem)
24554 (org-element-property :contents-end elem)))
24556 (narrow-to-region
24557 (org-element-property :begin elem)
24558 (org-element-property :end elem))))))
24560 (defun org-transpose-element ()
24561 "Transpose current and previous elements, keeping blank lines between.
24562 Point is moved after both elements."
24563 (interactive)
24564 (org-skip-whitespace)
24565 (let ((end (org-element-property :end (org-element-at-point))))
24566 (org-drag-element-backward)
24567 (goto-char end)))
24569 (defun org-unindent-buffer ()
24570 "Un-indent the visible part of the buffer.
24571 Relative indentation (between items, inside blocks, etc.) isn't
24572 modified."
24573 (interactive)
24574 (unless (eq major-mode 'org-mode)
24575 (user-error "Cannot un-indent a buffer not in Org mode"))
24576 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24577 unindent-tree ; For byte-compiler.
24578 (unindent-tree
24579 (function
24580 (lambda (contents)
24581 (mapc
24582 (lambda (element)
24583 (if (memq (org-element-type element) '(headline section))
24584 (funcall unindent-tree (org-element-contents element))
24585 (save-excursion
24586 (save-restriction
24587 (narrow-to-region
24588 (org-element-property :begin element)
24589 (org-element-property :end element))
24590 (org-do-remove-indentation)))))
24591 (reverse contents))))))
24592 (funcall unindent-tree (org-element-contents parse-tree))))
24594 (defun org-show-subtree ()
24595 "Show everything after this heading at deeper levels."
24596 (interactive)
24597 (outline-flag-region
24598 (point)
24599 (save-excursion
24600 (org-end-of-subtree t t))
24601 nil))
24603 (defun org-show-entry ()
24604 "Show the body directly following this heading.
24605 Show the heading too, if it is currently invisible."
24606 (interactive)
24607 (save-excursion
24608 (ignore-errors
24609 (org-back-to-heading t)
24610 (outline-flag-region
24611 (max (point-min) (1- (point)))
24612 (save-excursion
24613 (if (re-search-forward
24614 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24615 (match-beginning 1)
24616 (point-max)))
24617 nil)
24618 (org-cycle-hide-drawers 'children))))
24620 (defun org-make-options-regexp (kwds &optional extra)
24621 "Make a regular expression for keyword lines.
24622 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24623 when non-nil, is a regexp matching keywords names."
24624 (concat "^[ \t]*#\\+\\("
24625 (regexp-opt kwds)
24626 (and extra (concat (and kwds "\\|") extra))
24627 "\\):[ \t]*\\(.*\\)"))
24629 ;; Make isearch reveal the necessary context
24630 (defun org-isearch-end ()
24631 "Reveal context after isearch exits."
24632 (when isearch-success ; only if search was successful
24633 (if (featurep 'xemacs)
24634 ;; Under XEmacs, the hook is run in the correct place,
24635 ;; we directly show the context.
24636 (org-show-context 'isearch)
24637 ;; In Emacs the hook runs *before* restoring the overlays.
24638 ;; So we have to use a one-time post-command-hook to do this.
24639 ;; (Emacs 22 has a special variable, see function `org-mode')
24640 (unless (and (boundp 'isearch-mode-end-hook-quit)
24641 isearch-mode-end-hook-quit)
24642 ;; Only when the isearch was not quitted.
24643 (org-add-hook 'post-command-hook 'org-isearch-post-command
24644 'append 'local)))))
24646 (defun org-isearch-post-command ()
24647 "Remove self from hook, and show context."
24648 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24649 (org-show-context 'isearch))
24652 ;;;; Integration with and fixes for other packages
24654 ;;; Imenu support
24656 (defvar org-imenu-markers nil
24657 "All markers currently used by Imenu.")
24658 (make-variable-buffer-local 'org-imenu-markers)
24660 (defun org-imenu-new-marker (&optional pos)
24661 "Return a new marker for use by Imenu, and remember the marker."
24662 (let ((m (make-marker)))
24663 (move-marker m (or pos (point)))
24664 (push m org-imenu-markers)
24667 (defun org-imenu-get-tree ()
24668 "Produce the index for Imenu."
24669 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24670 (setq org-imenu-markers nil)
24671 (let* ((n org-imenu-depth)
24672 (re (concat "^" (org-get-limited-outline-regexp)))
24673 (subs (make-vector (1+ n) nil))
24674 (last-level 0)
24675 m level head0 head)
24676 (save-excursion
24677 (save-restriction
24678 (widen)
24679 (goto-char (point-max))
24680 (while (re-search-backward re nil t)
24681 (setq level (org-reduced-level (funcall outline-level)))
24682 (when (and (<= level n)
24683 (looking-at org-complex-heading-regexp)
24684 (setq head0 (org-match-string-no-properties 4)))
24685 (setq head (org-link-display-format head0)
24686 m (org-imenu-new-marker))
24687 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24688 (if (>= level last-level)
24689 (push (cons head m) (aref subs level))
24690 (push (cons head (aref subs (1+ level))) (aref subs level))
24691 (loop for i from (1+ level) to n do (aset subs i nil)))
24692 (setq last-level level)))))
24693 (aref subs 1)))
24695 (eval-after-load "imenu"
24696 '(progn
24697 (add-hook 'imenu-after-jump-hook
24698 (lambda ()
24699 (if (derived-mode-p 'org-mode)
24700 (org-show-context 'org-goto))))))
24702 (defun org-link-display-format (link)
24703 "Replace a link with its the description.
24704 If there is no description, use the link target."
24705 (save-match-data
24706 (if (string-match org-bracket-link-analytic-regexp link)
24707 (replace-match (if (match-end 5)
24708 (match-string 5 link)
24709 (concat (match-string 1 link)
24710 (match-string 3 link)))
24711 nil t link)
24712 link)))
24714 (defun org-toggle-link-display ()
24715 "Toggle the literal or descriptive display of links."
24716 (interactive)
24717 (if org-descriptive-links
24718 (progn (org-remove-from-invisibility-spec '(org-link))
24719 (org-restart-font-lock)
24720 (setq org-descriptive-links nil))
24721 (progn (add-to-invisibility-spec '(org-link))
24722 (org-restart-font-lock)
24723 (setq org-descriptive-links t))))
24725 ;; Speedbar support
24727 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24728 "Overlay marking the agenda restriction line in speedbar.")
24729 (overlay-put org-speedbar-restriction-lock-overlay
24730 'face 'org-agenda-restriction-lock)
24731 (overlay-put org-speedbar-restriction-lock-overlay
24732 'help-echo "Agendas are currently limited to this item.")
24733 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24735 (defun org-speedbar-set-agenda-restriction ()
24736 "Restrict future agenda commands to the location at point in speedbar.
24737 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24738 (interactive)
24739 (require 'org-agenda)
24740 (let (p m tp np dir txt)
24741 (cond
24742 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24743 'org-imenu t))
24744 (setq m (get-text-property p 'org-imenu-marker))
24745 (with-current-buffer (marker-buffer m)
24746 (goto-char m)
24747 (org-agenda-set-restriction-lock 'subtree)))
24748 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24749 'speedbar-function 'speedbar-find-file))
24750 (setq tp (previous-single-property-change
24751 (1+ p) 'speedbar-function)
24752 np (next-single-property-change
24753 tp 'speedbar-function)
24754 dir (speedbar-line-directory)
24755 txt (buffer-substring-no-properties (or tp (point-min))
24756 (or np (point-max))))
24757 (with-current-buffer (find-file-noselect
24758 (let ((default-directory dir))
24759 (expand-file-name txt)))
24760 (unless (derived-mode-p 'org-mode)
24761 (user-error "Cannot restrict to non-Org-mode file"))
24762 (org-agenda-set-restriction-lock 'file)))
24763 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24764 (move-overlay org-speedbar-restriction-lock-overlay
24765 (point-at-bol) (point-at-eol))
24766 (setq current-prefix-arg nil)
24767 (org-agenda-maybe-redo)))
24769 (defvar speedbar-file-key-map)
24770 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24771 (eval-after-load "speedbar"
24772 '(progn
24773 (speedbar-add-supported-extension ".org")
24774 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24775 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24776 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24777 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24778 (add-hook 'speedbar-visiting-tag-hook
24779 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24781 ;;; Fixes and Hacks for problems with other packages
24783 (defun org--flyspell-object-check-p (element)
24784 "Non-nil when Flyspell can check object at point.
24785 ELEMENT is the element at point."
24786 (let ((object (save-excursion
24787 (when (org-looking-at-p "\\>") (backward-char))
24788 (org-element-context element))))
24789 (case (org-element-type object)
24790 ;; Prevent checks in links due to keybinding conflict with
24791 ;; Flyspell.
24792 ((code entity export-snippet inline-babel-call
24793 inline-src-block line-break latex-fragment link macro
24794 statistics-cookie target timestamp verbatim)
24795 nil)
24796 (footnote-reference
24797 ;; Only in inline footnotes, within the definition.
24798 (and (eq (org-element-property :type object) 'inline)
24799 (< (save-excursion
24800 (goto-char (org-element-property :begin object))
24801 (search-forward ":" nil t 2))
24802 (point))))
24803 (otherwise t))))
24805 (defun org-mode-flyspell-verify ()
24806 "Function used for `flyspell-generic-check-word-predicate'."
24807 (if (org-at-heading-p)
24808 ;; At a headline or an inlinetask, check title only. This is
24809 ;; faster than relying on `org-element-at-point'.
24810 (and (save-excursion (beginning-of-line)
24811 (and (let ((case-fold-search t))
24812 (not (looking-at "\\*+ END[ \t]*$")))
24813 (looking-at org-complex-heading-regexp)))
24814 (match-beginning 4)
24815 (>= (point) (match-beginning 4))
24816 (or (not (match-beginning 5))
24817 (< (point) (match-beginning 5))))
24818 (let* ((element (org-element-at-point))
24819 (post-affiliated (org-element-property :post-affiliated element)))
24820 (cond
24821 ;; Ignore checks in all affiliated keywords but captions.
24822 ((< (point) post-affiliated)
24823 (and (save-excursion
24824 (beginning-of-line)
24825 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24826 (> (point) (match-end 0))
24827 (org--flyspell-object-check-p element)))
24828 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24829 ((let ((log (org-log-into-drawer)))
24830 (and log
24831 (let ((drawer (org-element-lineage element '(drawer))))
24832 (and drawer
24833 (eq (compare-strings
24834 log nil nil
24835 (org-element-property :drawer-name drawer) nil nil t)
24836 t)))))
24837 nil)
24839 (case (org-element-type element)
24840 ((comment quote-section) t)
24841 (comment-block
24842 ;; Allow checks between block markers, not on them.
24843 (and (> (line-beginning-position) post-affiliated)
24844 (save-excursion
24845 (end-of-line)
24846 (skip-chars-forward " \r\t\n")
24847 (< (point) (org-element-property :end element)))))
24848 ;; Arbitrary list of keywords where checks are meaningful.
24849 ;; Make sure point is on the value part of the element.
24850 (keyword
24851 (and (member (org-element-property :key element)
24852 '("DESCRIPTION" "TITLE"))
24853 (save-excursion
24854 (search-backward ":" (line-beginning-position) t))))
24855 ;; Check is globally allowed in paragraphs verse blocks and
24856 ;; table rows (after affiliated keywords) but some objects
24857 ;; must not be affected.
24858 ((paragraph table-row verse-block)
24859 (let ((cbeg (org-element-property :contents-begin element))
24860 (cend (org-element-property :contents-end element)))
24861 (and cbeg (>= (point) cbeg) (< (point) cend)
24862 (org--flyspell-object-check-p element))))))))))
24863 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
24865 (defun org-remove-flyspell-overlays-in (beg end)
24866 "Remove flyspell overlays in region."
24867 (and (org-bound-and-true-p flyspell-mode)
24868 (fboundp 'flyspell-delete-region-overlays)
24869 (flyspell-delete-region-overlays beg end)))
24871 (defvar flyspell-delayed-commands)
24872 (eval-after-load "flyspell"
24873 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
24875 ;; Make `bookmark-jump' shows the jump location if it was hidden.
24876 (eval-after-load "bookmark"
24877 '(if (boundp 'bookmark-after-jump-hook)
24878 ;; We can use the hook
24879 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
24880 ;; Hook not available, use advice
24881 (defadvice bookmark-jump (after org-make-visible activate)
24882 "Make the position visible."
24883 (org-bookmark-jump-unhide))))
24885 ;; Make sure saveplace shows the location if it was hidden
24886 (eval-after-load "saveplace"
24887 '(defadvice save-place-find-file-hook (after org-make-visible activate)
24888 "Make the position visible."
24889 (org-bookmark-jump-unhide)))
24891 ;; Make sure ecb shows the location if it was hidden
24892 (eval-after-load "ecb"
24893 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
24894 "Make hierarchy visible when jumping into location from ECB tree buffer."
24895 (if (derived-mode-p 'org-mode)
24896 (org-show-context))))
24898 (defun org-bookmark-jump-unhide ()
24899 "Unhide the current position, to show the bookmark location."
24900 (and (derived-mode-p 'org-mode)
24901 (or (outline-invisible-p)
24902 (save-excursion (goto-char (max (point-min) (1- (point))))
24903 (outline-invisible-p)))
24904 (org-show-context 'bookmark-jump)))
24906 (defun org-mark-jump-unhide ()
24907 "Make the point visible with `org-show-context' after jumping to the mark."
24908 (when (and (derived-mode-p 'org-mode)
24909 (outline-invisible-p))
24910 (org-show-context 'mark-goto)))
24912 (eval-after-load "simple"
24913 '(defadvice pop-to-mark-command (after org-make-visible activate)
24914 "Make the point visible with `org-show-context'."
24915 (org-mark-jump-unhide)))
24917 (eval-after-load "simple"
24918 '(defadvice exchange-point-and-mark (after org-make-visible activate)
24919 "Make the point visible with `org-show-context'."
24920 (org-mark-jump-unhide)))
24922 (eval-after-load "simple"
24923 '(defadvice pop-global-mark (after org-make-visible activate)
24924 "Make the point visible with `org-show-context'."
24925 (org-mark-jump-unhide)))
24927 ;; Make session.el ignore our circular variable
24928 (defvar session-globals-exclude)
24929 (eval-after-load "session"
24930 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24932 ;;;; Finish up
24934 (provide 'org)
24936 (run-hooks 'org-load-hook)
24938 ;;; org.el ends here