ob-latex: Define LaTeX-specific headers
[org-mode.git] / lisp / org.el
bloba69b2d6de24bf56224692c9309dd950aacdc78b5
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))
185 (declare-function org-element-update-syntax "org-element" ())
187 (defsubst org-uniquify (list)
188 "Non-destructively remove duplicate elements from LIST."
189 (let ((res (copy-sequence list))) (delete-dups res)))
191 (defsubst org-get-at-bol (property)
192 "Get text property PROPERTY at the beginning of line."
193 (get-text-property (point-at-bol) property))
195 (defsubst org-trim (s)
196 "Remove whitespace at the beginning and the end of string S."
197 (replace-regexp-in-string
198 "\\`[ \t\n\r]+" ""
199 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
201 ;; load languages based on value of `org-babel-load-languages'
202 (defvar org-babel-load-languages)
204 ;;;###autoload
205 (defun org-babel-do-load-languages (sym value)
206 "Load the languages defined in `org-babel-load-languages'."
207 (set-default sym value)
208 (mapc (lambda (pair)
209 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
210 (if active
211 (progn
212 (require (intern (concat "ob-" lang))))
213 (progn
214 (funcall 'fmakunbound
215 (intern (concat "org-babel-execute:" lang)))
216 (funcall 'fmakunbound
217 (intern (concat "org-babel-expand-body:" lang)))))))
218 org-babel-load-languages))
220 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
221 ;;;###autoload
222 (defun org-babel-load-file (file &optional compile)
223 "Load Emacs Lisp source code blocks in the Org-mode FILE.
224 This function exports the source code using `org-babel-tangle'
225 and then loads the resulting file using `load-file'. With prefix
226 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
227 file to byte-code before it is loaded."
228 (interactive "fFile to load: \nP")
229 (let* ((age (lambda (file)
230 (float-time
231 (time-subtract (current-time)
232 (nth 5 (or (file-attributes (file-truename file))
233 (file-attributes file)))))))
234 (base-name (file-name-sans-extension file))
235 (exported-file (concat base-name ".el")))
236 ;; tangle if the org-mode file is newer than the elisp file
237 (unless (and (file-exists-p exported-file)
238 (> (funcall age file) (funcall age exported-file)))
239 ;; Tangle-file traversal returns reversed list of tangled files
240 ;; and we want to evaluate the first target.
241 (setq exported-file
242 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
243 (message "%s %s"
244 (if compile
245 (progn (byte-compile-file exported-file 'load)
246 "Compiled and loaded")
247 (progn (load-file exported-file) "Loaded"))
248 exported-file)))
250 (defcustom org-babel-load-languages '((emacs-lisp . t))
251 "Languages which can be evaluated in Org-mode buffers.
252 This list can be used to load support for any of the languages
253 below, note that each language will depend on a different set of
254 system executables and/or Emacs modes. When a language is
255 \"loaded\", then code blocks in that language can be evaluated
256 with `org-babel-execute-src-block' bound by default to C-c
257 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
258 be set to remove code block evaluation from the C-c C-c
259 keybinding. By default only Emacs Lisp (which has no
260 requirements) is loaded."
261 :group 'org-babel
262 :set 'org-babel-do-load-languages
263 :version "24.1"
264 :type '(alist :tag "Babel Languages"
265 :key-type
266 (choice
267 (const :tag "Awk" awk)
268 (const :tag "C" C)
269 (const :tag "R" R)
270 (const :tag "Asymptote" asymptote)
271 (const :tag "Calc" calc)
272 (const :tag "Clojure" clojure)
273 (const :tag "CSS" css)
274 (const :tag "Ditaa" ditaa)
275 (const :tag "Dot" dot)
276 (const :tag "Emacs Lisp" emacs-lisp)
277 (const :tag "Forth" forth)
278 (const :tag "Fortran" fortran)
279 (const :tag "Gnuplot" gnuplot)
280 (const :tag "Haskell" haskell)
281 (const :tag "IO" io)
282 (const :tag "J" J)
283 (const :tag "Java" java)
284 (const :tag "Javascript" js)
285 (const :tag "LaTeX" latex)
286 (const :tag "Ledger" ledger)
287 (const :tag "Lilypond" lilypond)
288 (const :tag "Lisp" lisp)
289 (const :tag "Makefile" makefile)
290 (const :tag "Maxima" maxima)
291 (const :tag "Matlab" matlab)
292 (const :tag "Mscgen" mscgen)
293 (const :tag "Ocaml" ocaml)
294 (const :tag "Octave" octave)
295 (const :tag "Org" org)
296 (const :tag "Perl" perl)
297 (const :tag "Pico Lisp" picolisp)
298 (const :tag "PlantUML" plantuml)
299 (const :tag "Python" python)
300 (const :tag "Ruby" ruby)
301 (const :tag "Sass" sass)
302 (const :tag "Scala" scala)
303 (const :tag "Scheme" scheme)
304 (const :tag "Screen" screen)
305 (const :tag "Shell Script" shell)
306 (const :tag "Shen" shen)
307 (const :tag "Sql" sql)
308 (const :tag "Sqlite" sqlite)
309 (const :tag "ebnf2ps" ebnf2ps))
310 :value-type (boolean :tag "Activate" :value t)))
312 ;;;; Customization variables
313 (defcustom org-clone-delete-id nil
314 "Remove ID property of clones of a subtree.
315 When non-nil, clones of a subtree don't inherit the ID property.
316 Otherwise they inherit the ID property with a new unique
317 identifier."
318 :type 'boolean
319 :version "24.1"
320 :group 'org-id)
322 ;;; Version
323 (org-check-version)
325 ;;;###autoload
326 (defun org-version (&optional here full message)
327 "Show the org-mode version.
328 Interactively, or when MESSAGE is non-nil, show it in echo area.
329 With prefix argument, or when HERE is non-nil, insert it at point.
330 In non-interactive uses, a reduced version string is output unless
331 FULL is given."
332 (interactive (list current-prefix-arg t (not current-prefix-arg)))
333 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
334 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
335 (load-suffixes (list ".el"))
336 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
337 (org-trash (or
338 (and (fboundp 'org-release) (fboundp 'org-git-version))
339 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
340 (load-suffixes save-load-suffixes)
341 (org-version (org-release))
342 (git-version (org-git-version))
343 (version (format "Org-mode version %s (%s @ %s)"
344 org-version
345 git-version
346 (if org-install-dir
347 (if (string= org-dir org-install-dir)
348 org-install-dir
349 (concat "mixed installation! " org-install-dir " and " org-dir))
350 "org-loaddefs.el can not be found!")))
351 (version1 (if full version org-version)))
352 (when here (insert version1))
353 (when message (message "%s" version1))
354 version1))
356 (defconst org-version (org-version))
359 ;;; Syntax Constants
361 ;;;; Block
363 (defconst org-block-regexp
364 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
365 "Regular expression for hiding blocks.")
367 (defconst org-dblock-start-re
368 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
369 "Matches the start line of a dynamic block, with parameters.")
371 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
372 "Matches the end of a dynamic block.")
374 ;;;; Clock and Planning
376 (defconst org-clock-string "CLOCK:"
377 "String used as prefix for timestamps clocking work hours on an item.")
379 (defvar org-closed-string "CLOSED:"
380 "String used as the prefix for timestamps logging closing a TODO entry.")
382 (defvar org-deadline-string "DEADLINE:"
383 "String to mark deadline entries.
384 A deadline is this string, followed by a time stamp. Should be a word,
385 terminated by a colon. You can insert a schedule keyword and
386 a timestamp with \\[org-deadline].")
388 (defvar org-scheduled-string "SCHEDULED:"
389 "String to mark scheduled TODO entries.
390 A schedule is this string, followed by a time stamp. Should be a word,
391 terminated by a colon. You can insert a schedule keyword and
392 a timestamp with \\[org-schedule].")
394 (defconst org-ds-keyword-length
395 (+ 2
396 (apply #'max
397 (mapcar #'length
398 (list org-deadline-string org-scheduled-string
399 org-clock-string org-closed-string))))
400 "Maximum length of the DEADLINE and SCHEDULED keywords.")
402 (defconst org-planning-line-re
403 (concat "^[ \t]*"
404 (regexp-opt
405 (list org-closed-string org-deadline-string org-scheduled-string)
407 "Matches a line with planning info.
408 Matched keyword is in group 1.")
410 (defconst org-clock-line-re
411 (concat "^[ \t]*" org-clock-string)
412 "Matches a line with clock info.")
414 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
415 "Matches the DEADLINE keyword.")
417 (defconst org-deadline-time-regexp
418 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
419 "Matches the DEADLINE keyword together with a time stamp.")
421 (defconst org-deadline-time-hour-regexp
422 (concat "\\<" org-deadline-string
423 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
424 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
426 (defconst org-deadline-line-regexp
427 (concat "\\<\\(" org-deadline-string "\\).*")
428 "Matches the DEADLINE keyword and the rest of the line.")
430 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
431 "Matches the SCHEDULED keyword.")
433 (defconst org-scheduled-time-regexp
434 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
435 "Matches the SCHEDULED keyword together with a time stamp.")
437 (defconst org-scheduled-time-hour-regexp
438 (concat "\\<" org-scheduled-string
439 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
440 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
442 (defconst org-closed-time-regexp
443 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
444 "Matches the CLOSED keyword together with a time stamp.")
446 (defconst org-keyword-time-regexp
447 (concat "\\<"
448 (regexp-opt
449 (list org-scheduled-string org-deadline-string org-closed-string
450 org-clock-string)
452 " *[[<]\\([^]>]+\\)[]>]")
453 "Matches any of the 4 keywords, together with the time stamp.")
455 (defconst org-keyword-time-not-clock-regexp
456 (concat
457 "\\<"
458 (regexp-opt
459 (list org-scheduled-string org-deadline-string org-closed-string) t)
460 " *[[<]\\([^]>]+\\)[]>]")
461 "Matches any of the 3 keywords, together with the time stamp.")
463 (defconst org-maybe-keyword-time-regexp
464 (concat "\\(\\<"
465 (regexp-opt
466 (list org-scheduled-string org-deadline-string org-closed-string
467 org-clock-string)
469 "\\)?"
470 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
471 "\\|"
472 "<%%([^\r\n>]*>\\)")
473 "Matches a timestamp, possibly preceded by a keyword.")
475 (defconst org-all-time-keywords
476 (mapcar (lambda (w) (substring w 0 -1))
477 (list org-scheduled-string org-deadline-string
478 org-clock-string org-closed-string))
479 "List of time keywords.")
481 ;;;; Drawer
483 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
484 "Matches first or last line of a hidden block.
485 Group 1 contains drawer's name or \"END\".")
487 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
488 "Regular expression matching the first line of a property drawer.")
490 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
491 "Regular expression matching the last line of a property drawer.")
493 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
494 "Regular expression matching the first line of a clock drawer.")
496 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
497 "Regular expression matching the last line of a clock drawer.")
499 (defconst org-property-drawer-re
500 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
501 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
502 "[ \t]*:END:[ \t]*$")
503 "Matches an entire property drawer.")
505 (defconst org-clock-drawer-re
506 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
507 org-clock-drawer-end-re "\\)\n?")
508 "Matches an entire clock drawer.")
510 ;;;; Headline
512 (defconst org-heading-keyword-regexp-format
513 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
514 "Printf format for a regexp matching a headline with some keyword.
515 This regexp will match the headline of any node which has the
516 exact keyword that is put into the format. The keyword isn't in
517 any group by default, but the stars and the body are.")
519 (defconst org-heading-keyword-maybe-regexp-format
520 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
521 "Printf format for a regexp matching a headline, possibly with some keyword.
522 This regexp can match any headline with the specified keyword, or
523 without a keyword. The keyword isn't in any group by default,
524 but the stars and the body are.")
526 (defconst org-archive-tag "ARCHIVE"
527 "The tag that marks a subtree as archived.
528 An archived subtree does not open during visibility cycling, and does
529 not contribute to the agenda listings.")
531 (defconst org-comment-string "COMMENT"
532 "Entries starting with this keyword will never be exported.
533 An entry can be toggled between COMMENT and normal with
534 \\[org-toggle-comment].")
537 ;;;; LaTeX Environments and Fragments
539 (defconst org-latex-regexps
540 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
541 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
542 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
543 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
544 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
545 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
546 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
547 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
548 "Regular expressions for matching embedded LaTeX.")
550 ;;;; Node Property
552 (defconst org-effort-property "Effort"
553 "The property that is being used to keep track of effort estimates.
554 Effort estimates given in this property need to have the format H:MM.")
556 ;;;; Table
558 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
559 "Detect an org-type or table-type table.")
561 (defconst org-table-line-regexp "^[ \t]*|"
562 "Detect an org-type table line.")
564 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
565 "Detect an org-type table line.")
567 (defconst org-table-hline-regexp "^[ \t]*|-"
568 "Detect an org-type table hline.")
570 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
571 "Detect a table-type table hline.")
573 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
574 "Detect the first line outside a table when searching from within it.
575 This works for both table types.")
577 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
578 "Detect a #+TBLFM line.")
580 ;;;; Timestamp
582 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
583 "Regular expression for fast time stamp matching.")
585 (defconst org-ts-regexp-inactive
586 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
587 "Regular expression for fast inactive time stamp matching.")
589 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
590 "Regular expression for fast time stamp matching.")
592 (defconst org-ts-regexp0
593 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
594 "Regular expression matching time strings for analysis.
595 This one does not require the space after the date, so it can be used
596 on a string that terminates immediately after the date.")
598 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
599 "Regular expression matching time strings for analysis.")
601 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
602 "Regular expression matching time stamps, with groups.")
604 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
605 "Regular expression matching time stamps (also [..]), with groups.")
607 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
608 "Regular expression matching a time stamp range.")
610 (defconst org-tr-regexp-both
611 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
612 "Regular expression matching a time stamp range.")
614 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
615 org-ts-regexp "\\)?")
616 "Regular expression matching a time stamp or time stamp range.")
618 (defconst org-tsr-regexp-both
619 (concat org-ts-regexp-both "\\(--?-?"
620 org-ts-regexp-both "\\)?")
621 "Regular expression matching a time stamp or time stamp range.
622 The time stamps may be either active or inactive.")
624 (defconst org-repeat-re
625 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
626 "Regular expression for specifying repeated events.
627 After a match, group 1 contains the repeat expression.")
629 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
630 "Formats for `format-time-string' which are used for time stamps.")
633 ;;; The custom variables
635 (defgroup org nil
636 "Outline-based notes management and organizer."
637 :tag "Org"
638 :group 'outlines
639 :group 'calendar)
641 (defcustom org-mode-hook nil
642 "Mode hook for Org-mode, run after the mode was turned on."
643 :group 'org
644 :type 'hook)
646 (defcustom org-load-hook nil
647 "Hook that is run after org.el has been loaded."
648 :group 'org
649 :type 'hook)
651 (defcustom org-log-buffer-setup-hook nil
652 "Hook that is run after an Org log buffer is created."
653 :group 'org
654 :version "24.1"
655 :type 'hook)
657 (defvar org-modules) ; defined below
658 (defvar org-modules-loaded nil
659 "Have the modules been loaded already?")
661 (defun org-load-modules-maybe (&optional force)
662 "Load all extensions listed in `org-modules'."
663 (when (or force (not org-modules-loaded))
664 (mapc (lambda (ext)
665 (condition-case nil (require ext)
666 (error (message "Problems while trying to load feature `%s'" ext))))
667 org-modules)
668 (setq org-modules-loaded t)))
670 (defun org-set-modules (var value)
671 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
672 (set var value)
673 (when (featurep 'org)
674 (org-load-modules-maybe 'force)
675 (org-element-cache-reset 'all)))
677 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
678 "Modules that should always be loaded together with org.el.
680 If a description starts with <C>, the file is not part of Emacs
681 and loading it will require that you have downloaded and properly
682 installed the Org mode distribution.
684 You can also use this system to load external packages (i.e. neither Org
685 core modules, nor modules from the CONTRIB directory). Just add symbols
686 to the end of the list. If the package is called org-xyz.el, then you need
687 to add the symbol `xyz', and the package must have a call to:
689 \(provide 'org-xyz)
691 For export specific modules, see also `org-export-backends'."
692 :group 'org
693 :set 'org-set-modules
694 :version "24.4"
695 :package-version '(Org . "8.0")
696 :type
697 '(set :greedy t
698 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
699 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
700 (const :tag " crypt: Encryption of subtrees" org-crypt)
701 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
702 (const :tag " docview: Links to doc-view buffers" org-docview)
703 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
704 (const :tag " habit: Track your consistency with habits" org-habit)
705 (const :tag " id: Global IDs for identifying entries" org-id)
706 (const :tag " info: Links to Info nodes" org-info)
707 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
708 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
709 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
710 (const :tag " mouse: Additional mouse support" org-mouse)
711 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
712 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
713 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
715 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
716 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
717 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
718 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
719 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
720 (const :tag "C collector: Collect properties into tables" org-collector)
721 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
722 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
723 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
724 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
725 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
726 (const :tag "C eval: Include command output as text" org-eval)
727 (const :tag "C eww: Store link to url of eww" org-eww)
728 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
729 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
730 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
731 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
732 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
733 (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
734 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
735 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
736 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
737 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
738 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
739 (const :tag "C mew: Links to Mew folders/messages" org-mew)
740 (const :tag "C mtags: Support for muse-like tags" org-mtags)
741 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
742 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
743 (const :tag "C registry: A registry for Org-mode links" org-registry)
744 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
745 (const :tag "C secretary: Team management with org-mode" org-secretary)
746 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
747 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
748 (const :tag "C track: Keep up with Org-mode development" org-track)
749 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
750 (const :tag "C vm: Links to VM folders/messages" org-vm)
751 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
752 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
753 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
755 (defvar org-export-registered-backends) ; From ox.el.
756 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
757 (declare-function org-export-backend-name "ox" (backend))
758 (defcustom org-export-backends '(ascii html icalendar latex)
759 "List of export back-ends that should be always available.
761 If a description starts with <C>, the file is not part of Emacs
762 and loading it will require that you have downloaded and properly
763 installed the Org mode distribution.
765 Unlike to `org-modules', libraries in this list will not be
766 loaded along with Org, but only once the export framework is
767 needed.
769 This variable needs to be set before org.el is loaded. If you
770 need to make a change while Emacs is running, use the customize
771 interface or run the following code, where VAL stands for the new
772 value of the variable, after updating it:
774 \(progn
775 \(setq org-export-registered-backends
776 \(org-remove-if-not
777 \(lambda (backend)
778 \(let ((name (org-export-backend-name backend)))
779 \(or (memq name val)
780 \(catch 'parentp
781 \(dolist (b val)
782 \(and (org-export-derived-backend-p b name)
783 \(throw 'parentp t)))))))
784 org-export-registered-backends))
785 \(let ((new-list (mapcar #'org-export-backend-name
786 org-export-registered-backends)))
787 \(dolist (backend val)
788 \(cond
789 \((not (load (format \"ox-%s\" backend) t t))
790 \(message \"Problems while trying to load export back-end `%s'\"
791 backend))
792 \((not (memq backend new-list)) (push backend new-list))))
793 \(set-default 'org-export-backends new-list)))
795 Adding a back-end to this list will also pull the back-end it
796 depends on, if any."
797 :group 'org
798 :group 'org-export
799 :version "24.4"
800 :package-version '(Org . "8.0")
801 :initialize 'custom-initialize-set
802 :set (lambda (var val)
803 (if (not (featurep 'ox)) (set-default var val)
804 ;; Any back-end not required anymore (not present in VAL and not
805 ;; a parent of any back-end in the new value) is removed from the
806 ;; list of registered back-ends.
807 (setq org-export-registered-backends
808 (org-remove-if-not
809 (lambda (backend)
810 (let ((name (org-export-backend-name backend)))
811 (or (memq name val)
812 (catch 'parentp
813 (dolist (b val)
814 (and (org-export-derived-backend-p b name)
815 (throw 'parentp t)))))))
816 org-export-registered-backends))
817 ;; Now build NEW-LIST of both new back-ends and required
818 ;; parents.
819 (let ((new-list (mapcar #'org-export-backend-name
820 org-export-registered-backends)))
821 (dolist (backend val)
822 (cond
823 ((not (load (format "ox-%s" backend) t t))
824 (message "Problems while trying to load export back-end `%s'"
825 backend))
826 ((not (memq backend new-list)) (push backend new-list))))
827 ;; Set VAR to that list with fixed dependencies.
828 (set-default var new-list))))
829 :type '(set :greedy t
830 (const :tag " ascii Export buffer to ASCII format" ascii)
831 (const :tag " beamer Export buffer to Beamer presentation" beamer)
832 (const :tag " html Export buffer to HTML format" html)
833 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
834 (const :tag " latex Export buffer to LaTeX format" latex)
835 (const :tag " man Export buffer to MAN format" man)
836 (const :tag " md Export buffer to Markdown format" md)
837 (const :tag " odt Export buffer to ODT format" odt)
838 (const :tag " org Export buffer to Org format" org)
839 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
840 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
841 (const :tag "C deck Export buffer to deck.js presentations" deck)
842 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
843 (const :tag "C groff Export buffer to Groff format" groff)
844 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
845 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
846 (const :tag "C s5 Export buffer to s5 presentations" s5)
847 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
849 (eval-after-load 'ox
850 '(mapc
851 (lambda (backend)
852 (condition-case nil (require (intern (format "ox-%s" backend)))
853 (error (message "Problems while trying to load export back-end `%s'"
854 backend))))
855 org-export-backends))
857 (defcustom org-support-shift-select nil
858 "Non-nil means make shift-cursor commands select text when possible.
860 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
861 start selecting a region, or enlarge regions started in this way.
862 In Org-mode, in special contexts, these same keys are used for
863 other purposes, important enough to compete with shift selection.
864 Org tries to balance these needs by supporting `shift-select-mode'
865 outside these special contexts, under control of this variable.
867 The default of this variable is nil, to avoid confusing behavior. Shifted
868 cursor keys will then execute Org commands in the following contexts:
869 - on a headline, changing TODO state (left/right) and priority (up/down)
870 - on a time stamp, changing the time
871 - in a plain list item, changing the bullet type
872 - in a property definition line, switching between allowed values
873 - in the BEGIN line of a clock table (changing the time block).
874 Outside these contexts, the commands will throw an error.
876 When this variable is t and the cursor is not in a special
877 context, Org-mode will support shift-selection for making and
878 enlarging regions. To make this more effective, the bullet
879 cycling will no longer happen anywhere in an item line, but only
880 if the cursor is exactly on the bullet.
882 If you set this variable to the symbol `always', then the keys
883 will not be special in headlines, property lines, and item lines,
884 to make shift selection work there as well. If this is what you
885 want, you can use the following alternative commands: `C-c C-t'
886 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
887 can be used to switch TODO sets, `C-c -' to cycle item bullet
888 types, and properties can be edited by hand or in column view.
890 However, when the cursor is on a timestamp, shift-cursor commands
891 will still edit the time stamp - this is just too good to give up.
893 XEmacs user should have this variable set to nil, because
894 `shift-select-mode' is in Emacs 23 or later only."
895 :group 'org
896 :type '(choice
897 (const :tag "Never" nil)
898 (const :tag "When outside special context" t)
899 (const :tag "Everywhere except timestamps" always)))
901 (defcustom org-loop-over-headlines-in-active-region nil
902 "Shall some commands act upon headlines in the active region?
904 When set to `t', some commands will be performed in all headlines
905 within the active region.
907 When set to `start-level', some commands will be performed in all
908 headlines within the active region, provided that these headlines
909 are of the same level than the first one.
911 When set to a string, those commands will be performed on the
912 matching headlines within the active region. Such string must be
913 a tags/property/todo match as it is used in the agenda tags view.
915 The list of commands is: `org-schedule', `org-deadline',
916 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
917 `org-archive-to-archive-sibling'. The archiving commands skip
918 already archived entries."
919 :type '(choice (const :tag "Don't loop" nil)
920 (const :tag "All headlines in active region" t)
921 (const :tag "In active region, headlines at the same level than the first one" start-level)
922 (string :tag "Tags/Property/Todo matcher"))
923 :version "24.1"
924 :group 'org-todo
925 :group 'org-archive)
927 (defgroup org-startup nil
928 "Options concerning startup of Org-mode."
929 :tag "Org Startup"
930 :group 'org)
932 (defcustom org-startup-folded t
933 "Non-nil means entering Org-mode will switch to OVERVIEW.
934 This can also be configured on a per-file basis by adding one of
935 the following lines anywhere in the buffer:
937 #+STARTUP: fold (or `overview', this is equivalent)
938 #+STARTUP: nofold (or `showall', this is equivalent)
939 #+STARTUP: content
940 #+STARTUP: showeverything
942 By default, this option is ignored when Org opens agenda files
943 for the first time. If you want the agenda to honor the startup
944 option, set `org-agenda-inhibit-startup' to nil."
945 :group 'org-startup
946 :type '(choice
947 (const :tag "nofold: show all" nil)
948 (const :tag "fold: overview" t)
949 (const :tag "content: all headlines" content)
950 (const :tag "show everything, even drawers" showeverything)))
952 (defcustom org-startup-truncated t
953 "Non-nil means entering Org-mode will set `truncate-lines'.
954 This is useful since some lines containing links can be very long and
955 uninteresting. Also tables look terrible when wrapped."
956 :group 'org-startup
957 :type 'boolean)
959 (defcustom org-startup-indented nil
960 "Non-nil means turn on `org-indent-mode' on startup.
961 This can also be configured on a per-file basis by adding one of
962 the following lines anywhere in the buffer:
964 #+STARTUP: indent
965 #+STARTUP: noindent"
966 :group 'org-structure
967 :type '(choice
968 (const :tag "Not" nil)
969 (const :tag "Globally (slow on startup in large files)" t)))
971 (defcustom org-use-sub-superscripts t
972 "Non-nil means interpret \"_\" and \"^\" for display.
974 If you want to control how Org exports those characters, see
975 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
976 used to be an alias for `org-export-with-sub-superscripts' in
977 Org <8.0, it is not anymore.
979 When this option is turned on, you can use TeX-like syntax for
980 sub- and superscripts within the buffer. Several characters after
981 \"_\" or \"^\" will be considered as a single item - so grouping
982 with {} is normally not needed. For example, the following things
983 will be parsed as single sub- or superscripts:
985 10^24 or 10^tau several digits will be considered 1 item.
986 10^-12 or 10^-tau a leading sign with digits or a word
987 x^2-y^3 will be read as x^2 - y^3, because items are
988 terminated by almost any nonword/nondigit char.
989 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
991 Still, ambiguity is possible. So when in doubt, use {} to enclose
992 the sub/superscript. If you set this variable to the symbol `{}',
993 the braces are *required* in order to trigger interpretations as
994 sub/superscript. This can be helpful in documents that need \"_\"
995 frequently in plain text."
996 :group 'org-startup
997 :version "24.4"
998 :package-version '(Org . "8.0")
999 :type '(choice
1000 (const :tag "Always interpret" t)
1001 (const :tag "Only with braces" {})
1002 (const :tag "Never interpret" nil)))
1004 (defcustom org-startup-with-beamer-mode nil
1005 "Non-nil means turn on `org-beamer-mode' on startup.
1006 This can also be configured on a per-file basis by adding one of
1007 the following lines anywhere in the buffer:
1009 #+STARTUP: beamer"
1010 :group 'org-startup
1011 :version "24.1"
1012 :type 'boolean)
1014 (defcustom org-startup-align-all-tables nil
1015 "Non-nil means align all tables when visiting a file.
1016 This is useful when the column width in tables is forced with <N> cookies
1017 in table fields. Such tables will look correct only after the first re-align.
1018 This can also be configured on a per-file basis by adding one of
1019 the following lines anywhere in the buffer:
1020 #+STARTUP: align
1021 #+STARTUP: noalign"
1022 :group 'org-startup
1023 :type 'boolean)
1025 (defcustom org-startup-with-inline-images nil
1026 "Non-nil means show inline images when loading a new Org file.
1027 This can also be configured on a per-file basis by adding one of
1028 the following lines anywhere in the buffer:
1029 #+STARTUP: inlineimages
1030 #+STARTUP: noinlineimages"
1031 :group 'org-startup
1032 :version "24.1"
1033 :type 'boolean)
1035 (defcustom org-startup-with-latex-preview nil
1036 "Non-nil means preview LaTeX fragments when loading a new Org file.
1038 This can also be configured on a per-file basis by adding one of
1039 the following lines anywhere in the buffer:
1040 #+STARTUP: latexpreview
1041 #+STARTUP: nolatexpreview"
1042 :group 'org-startup
1043 :version "24.4"
1044 :package-version '(Org . "8.0")
1045 :type 'boolean)
1047 (defcustom org-insert-mode-line-in-empty-file nil
1048 "Non-nil means insert the first line setting Org-mode in empty files.
1049 When the function `org-mode' is called interactively in an empty file, this
1050 normally means that the file name does not automatically trigger Org-mode.
1051 To ensure that the file will always be in Org-mode in the future, a
1052 line enforcing Org-mode will be inserted into the buffer, if this option
1053 has been set."
1054 :group 'org-startup
1055 :type 'boolean)
1057 (defcustom org-replace-disputed-keys nil
1058 "Non-nil means use alternative key bindings for some keys.
1059 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1060 These keys are also used by other packages like shift-selection-mode'
1061 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1062 If you want to use Org-mode together with one of these other modes,
1063 or more generally if you would like to move some Org-mode commands to
1064 other keys, set this variable and configure the keys with the variable
1065 `org-disputed-keys'.
1067 This option is only relevant at load-time of Org-mode, and must be set
1068 *before* org.el is loaded. Changing it requires a restart of Emacs to
1069 become effective."
1070 :group 'org-startup
1071 :type 'boolean)
1073 (defcustom org-use-extra-keys nil
1074 "Non-nil means use extra key sequence definitions for certain commands.
1075 This happens automatically if you run XEmacs or if `window-system'
1076 is nil. This variable lets you do the same manually. You must
1077 set it before loading org.
1079 Example: on Carbon Emacs 22 running graphically, with an external
1080 keyboard on a Powerbook, the default way of setting M-left might
1081 not work for either Alt or ESC. Setting this variable will make
1082 it work for ESC."
1083 :group 'org-startup
1084 :type 'boolean)
1086 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1088 (defcustom org-disputed-keys
1089 '(([(shift up)] . [(meta p)])
1090 ([(shift down)] . [(meta n)])
1091 ([(shift left)] . [(meta -)])
1092 ([(shift right)] . [(meta +)])
1093 ([(control shift right)] . [(meta shift +)])
1094 ([(control shift left)] . [(meta shift -)]))
1095 "Keys for which Org-mode and other modes compete.
1096 This is an alist, cars are the default keys, second element specifies
1097 the alternative to use when `org-replace-disputed-keys' is t.
1099 Keys can be specified in any syntax supported by `define-key'.
1100 The value of this option takes effect only at Org-mode's startup,
1101 therefore you'll have to restart Emacs to apply it after changing."
1102 :group 'org-startup
1103 :type 'alist)
1105 (defun org-key (key)
1106 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1107 Or return the original if not disputed.
1108 Also apply the translations defined in `org-xemacs-key-equivalents'."
1109 (when org-replace-disputed-keys
1110 (let* ((nkey (key-description key))
1111 (x (org-find-if (lambda (x)
1112 (equal (key-description (car x)) nkey))
1113 org-disputed-keys)))
1114 (setq key (if x (cdr x) key))))
1115 (when (featurep 'xemacs)
1116 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1117 key)
1119 (defun org-find-if (predicate seq)
1120 (catch 'exit
1121 (while seq
1122 (if (funcall predicate (car seq))
1123 (throw 'exit (car seq))
1124 (pop seq)))))
1126 (defun org-defkey (keymap key def)
1127 "Define a key, possibly translated, as returned by `org-key'."
1128 (define-key keymap (org-key key) def))
1130 (defcustom org-ellipsis nil
1131 "The ellipsis to use in the Org-mode outline.
1132 When nil, just use the standard three dots.
1133 When a string, use that string instead.
1134 When a face, use the standard 3 dots, but with the specified face.
1135 The change affects only Org-mode (which will then use its own display table).
1136 Changing this requires executing \\[org-mode] in a buffer to become
1137 effective."
1138 :group 'org-startup
1139 :type '(choice (const :tag "Default" nil)
1140 (face :tag "Face" :value org-warning)
1141 (string :tag "String" :value "...#")))
1143 (defvar org-display-table nil
1144 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1146 (defgroup org-keywords nil
1147 "Keywords in Org-mode."
1148 :tag "Org Keywords"
1149 :group 'org)
1151 (defcustom org-closed-keep-when-no-todo nil
1152 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1153 :group 'org-todo
1154 :group 'org-keywords
1155 :version "24.4"
1156 :package-version '(Org . "8.0")
1157 :type 'boolean)
1159 (defgroup org-structure nil
1160 "Options concerning the general structure of Org-mode files."
1161 :tag "Org Structure"
1162 :group 'org)
1164 (defgroup org-reveal-location nil
1165 "Options about how to make context of a location visible."
1166 :tag "Org Reveal Location"
1167 :group 'org-structure)
1169 (defcustom org-show-context-detail '((isearch . lineage)
1170 (bookmark-jump . lineage)
1171 (default . ancestors))
1172 "Alist between context and visibility span when revealing a location.
1174 \\<org-mode-map>Some actions may move point into invisible
1175 locations. As a consequence, Org always expose a neighborhood
1176 around point. How much is shown depends on the initial action,
1177 or context. Valid contexts are
1179 agenda when exposing an entry from the agenda
1180 org-goto when using the command `org-goto' (\\[org-goto])
1181 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1182 tags-tree when constructing a sparse tree based on tags matches
1183 link-search when exposing search matches associated with a link
1184 mark-goto when exposing the jump goal of a mark
1185 bookmark-jump when exposing a bookmark location
1186 isearch when exiting from an incremental search
1187 default default for all contexts not set explicitly
1189 Allowed visibility spans are
1191 minimal show current headline; if point is not on headline,
1192 also show entry
1194 local show current headline, entry and next headline
1196 ancestors show current headline and its direct ancestors; if
1197 point is not on headline, also show entry
1199 lineage show current headline, its direct ancestors and all
1200 their children; if point is not on headline, also show
1201 entry and first child
1203 tree show current headline, its direct ancestors and all
1204 their children; if point is not on headline, also show
1205 entry and all children
1207 canonical show current headline, its direct ancestors along with
1208 their entries and children; if point is not located on
1209 the headline, also show current entry and all children
1211 As special cases, a nil or t value means show all contexts in
1212 `minimal' or `canonical' view, respectively.
1214 Some views can make displayed information very compact, but also
1215 make it harder to edit the location of the match. In such
1216 a case, use the command `org-reveal' (\\[org-reveal]) to show
1217 more context."
1218 :group 'org-reveal-location
1219 :version "25.1"
1220 :package-version '(Org . "8.3")
1221 :type '(choice
1222 (const :tag "Canonical" t)
1223 (const :tag "Minimal" nil)
1224 (repeat :greedy t :tag "Individual contexts"
1225 (cons
1226 (choice :tag "Context"
1227 (const agenda)
1228 (const org-goto)
1229 (const occur-tree)
1230 (const tags-tree)
1231 (const link-search)
1232 (const mark-goto)
1233 (const bookmark-jump)
1234 (const isearch)
1235 (const default))
1236 (choice :tag "Detail level"
1237 (const minimal)
1238 (const local)
1239 (const ancestors)
1240 (const lineage)
1241 (const tree)
1242 (const canonical))))))
1244 (defcustom org-indirect-buffer-display 'other-window
1245 "How should indirect tree buffers be displayed?
1246 This applies to indirect buffers created with the commands
1247 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1248 Valid values are:
1249 current-window Display in the current window
1250 other-window Just display in another window.
1251 dedicated-frame Create one new frame, and re-use it each time.
1252 new-frame Make a new frame each time. Note that in this case
1253 previously-made indirect buffers are kept, and you need to
1254 kill these buffers yourself."
1255 :group 'org-structure
1256 :group 'org-agenda-windows
1257 :type '(choice
1258 (const :tag "In current window" current-window)
1259 (const :tag "In current frame, other window" other-window)
1260 (const :tag "Each time a new frame" new-frame)
1261 (const :tag "One dedicated frame" dedicated-frame)))
1263 (defcustom org-use-speed-commands nil
1264 "Non-nil means activate single letter commands at beginning of a headline.
1265 This may also be a function to test for appropriate locations where speed
1266 commands should be active.
1268 For example, to activate speed commands when the point is on any
1269 star at the beginning of the headline, you can do this:
1271 (setq org-use-speed-commands
1272 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1273 :group 'org-structure
1274 :type '(choice
1275 (const :tag "Never" nil)
1276 (const :tag "At beginning of headline stars" t)
1277 (function)))
1279 (defcustom org-speed-commands-user nil
1280 "Alist of additional speed commands.
1281 This list will be checked before `org-speed-commands-default'
1282 when the variable `org-use-speed-commands' is non-nil
1283 and when the cursor is at the beginning of a headline.
1284 The car if each entry is a string with a single letter, which must
1285 be assigned to `self-insert-command' in the global map.
1286 The cdr is either a command to be called interactively, a function
1287 to be called, or a form to be evaluated.
1288 An entry that is just a list with a single string will be interpreted
1289 as a descriptive headline that will be added when listing the speed
1290 commands in the Help buffer using the `?' speed command."
1291 :group 'org-structure
1292 :type '(repeat :value ("k" . ignore)
1293 (choice :value ("k" . ignore)
1294 (list :tag "Descriptive Headline" (string :tag "Headline"))
1295 (cons :tag "Letter and Command"
1296 (string :tag "Command letter")
1297 (choice
1298 (function)
1299 (sexp))))))
1301 (defcustom org-bookmark-names-plist
1302 '(:last-capture "org-capture-last-stored"
1303 :last-refile "org-refile-last-stored"
1304 :last-capture-marker "org-capture-last-stored-marker")
1305 "Names for bookmarks automatically set by some Org commands.
1306 This can provide strings as names for a number of bookmarks Org sets
1307 automatically. The following keys are currently implemented:
1308 :last-capture
1309 :last-capture-marker
1310 :last-refile
1311 When a key does not show up in the property list, the corresponding bookmark
1312 is not set."
1313 :group 'org-structure
1314 :type 'plist)
1316 (defgroup org-cycle nil
1317 "Options concerning visibility cycling in Org-mode."
1318 :tag "Org Cycle"
1319 :group 'org-structure)
1321 (defcustom org-cycle-skip-children-state-if-no-children t
1322 "Non-nil means skip CHILDREN state in entries that don't have any."
1323 :group 'org-cycle
1324 :type 'boolean)
1326 (defcustom org-cycle-max-level nil
1327 "Maximum level which should still be subject to visibility cycling.
1328 Levels higher than this will, for cycling, be treated as text, not a headline.
1329 When `org-odd-levels-only' is set, a value of N in this variable actually
1330 means 2N-1 stars as the limiting headline.
1331 When nil, cycle all levels.
1332 Note that the limiting level of cycling is also influenced by
1333 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1334 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1335 than its value."
1336 :group 'org-cycle
1337 :type '(choice
1338 (const :tag "No limit" nil)
1339 (integer :tag "Maximum level")))
1341 (defcustom org-hide-block-startup nil
1342 "Non-nil means entering Org-mode will fold all blocks.
1343 This can also be set in on a per-file basis with
1345 #+STARTUP: hideblocks
1346 #+STARTUP: showblocks"
1347 :group 'org-startup
1348 :group 'org-cycle
1349 :type 'boolean)
1351 (defcustom org-cycle-global-at-bob nil
1352 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1353 This makes it possible to do global cycling without having to use S-TAB or
1354 \\[universal-argument] TAB. For this special case to work, the first line
1355 of the buffer must not be a headline -- it may be empty or some other text.
1356 When used in this way, `org-cycle-hook' is disabled temporarily to make
1357 sure the cursor stays at the beginning of the buffer. When this option is
1358 nil, don't do anything special at the beginning of the buffer."
1359 :group 'org-cycle
1360 :type 'boolean)
1362 (defcustom org-cycle-level-after-item/entry-creation t
1363 "Non-nil means cycle entry level or item indentation in new empty entries.
1365 When the cursor is at the end of an empty headline, i.e., with only stars
1366 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1367 and then all possible ancestor states, before returning to the original state.
1368 This makes data entry extremely fast: M-RET to create a new headline,
1369 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1371 When the cursor is at the end of an empty plain list item, one TAB will
1372 make it a subitem, two or more tabs will back up to make this an item
1373 higher up in the item hierarchy."
1374 :group 'org-cycle
1375 :type 'boolean)
1377 (defcustom org-cycle-emulate-tab t
1378 "Where should `org-cycle' emulate TAB.
1379 nil Never
1380 white Only in completely white lines
1381 whitestart Only at the beginning of lines, before the first non-white char
1382 t Everywhere except in headlines
1383 exc-hl-bol Everywhere except at the start of a headline
1384 If TAB is used in a place where it does not emulate TAB, the current subtree
1385 visibility is cycled."
1386 :group 'org-cycle
1387 :type '(choice (const :tag "Never" nil)
1388 (const :tag "Only in completely white lines" white)
1389 (const :tag "Before first char in a line" whitestart)
1390 (const :tag "Everywhere except in headlines" t)
1391 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1393 (defcustom org-cycle-separator-lines 2
1394 "Number of empty lines needed to keep an empty line between collapsed trees.
1395 If you leave an empty line between the end of a subtree and the following
1396 headline, this empty line is hidden when the subtree is folded.
1397 Org-mode will leave (exactly) one empty line visible if the number of
1398 empty lines is equal or larger to the number given in this variable.
1399 So the default 2 means at least 2 empty lines after the end of a subtree
1400 are needed to produce free space between a collapsed subtree and the
1401 following headline.
1403 If the number is negative, and the number of empty lines is at least -N,
1404 all empty lines are shown.
1406 Special case: when 0, never leave empty lines in collapsed view."
1407 :group 'org-cycle
1408 :type 'integer)
1409 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1411 (defcustom org-pre-cycle-hook nil
1412 "Hook that is run before visibility cycling is happening.
1413 The function(s) in this hook must accept a single argument which indicates
1414 the new state that will be set right after running this hook. The
1415 argument is a symbol. Before a global state change, it can have the values
1416 `overview', `content', or `all'. Before a local state change, it can have
1417 the values `folded', `children', or `subtree'."
1418 :group 'org-cycle
1419 :type 'hook)
1421 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1422 org-cycle-hide-drawers
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
1433 :version "25.1"
1434 :package-version '(Org . "8.3"))
1436 (defgroup org-edit-structure nil
1437 "Options concerning structure editing in Org-mode."
1438 :tag "Org Edit Structure"
1439 :group 'org-structure)
1441 (defcustom org-odd-levels-only nil
1442 "Non-nil means skip even levels and only use odd levels for the outline.
1443 This has the effect that two stars are being added/taken away in
1444 promotion/demotion commands. It also influences how levels are
1445 handled by the exporters.
1446 Changing it requires restart of `font-lock-mode' to become effective
1447 for fontification also in regions already fontified.
1448 You may also set this on a per-file basis by adding one of the following
1449 lines to the buffer:
1451 #+STARTUP: odd
1452 #+STARTUP: oddeven"
1453 :group 'org-edit-structure
1454 :group 'org-appearance
1455 :type 'boolean)
1457 (defcustom org-adapt-indentation t
1458 "Non-nil means adapt indentation to outline node level.
1460 When this variable is set, Org assumes that you write outlines by
1461 indenting text in each node to align with the headline (after the
1462 stars). The following issues are influenced by this variable:
1464 - The indentation is increased by one space in a demotion
1465 command, and decreased by one in a promotion command. However,
1466 in the latter case, if shifting some line in the entry body
1467 would alter document structure (e.g., insert a new headline),
1468 indentation is not changed at all.
1470 - Property drawers and planning information is inserted indented
1471 when this variable is set. When nil, they will not be indented.
1473 - TAB indents a line relative to current level. The lines below
1474 a headline will be indented when this variable is set.
1476 Note that this is all about true indentation, by adding and
1477 removing space characters. See also `org-indent.el' which does
1478 level-dependent indentation in a virtual way, i.e. at display
1479 time in Emacs."
1480 :group 'org-edit-structure
1481 :type 'boolean)
1483 (defcustom org-special-ctrl-a/e nil
1484 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1486 When t, `C-a' will bring back the cursor to the beginning of the
1487 headline text, i.e. after the stars and after a possible TODO
1488 keyword. In an item, this will be the position after bullet and
1489 check-box, if any. When the cursor is already at that position,
1490 another `C-a' will bring it to the beginning of the line.
1492 `C-e' will jump to the end of the headline, ignoring the presence
1493 of tags in the headline. A second `C-e' will then jump to the
1494 true end of the line, after any tags. This also means that, when
1495 this variable is non-nil, `C-e' also will never jump beyond the
1496 end of the heading of a folded section, i.e. not after the
1497 ellipses.
1499 When set to the symbol `reversed', the first `C-a' or `C-e' works
1500 normally, going to the true line boundary first. Only a directly
1501 following, identical keypress will bring the cursor to the
1502 special positions.
1504 This may also be a cons cell where the behavior for `C-a' and
1505 `C-e' is set separately."
1506 :group 'org-edit-structure
1507 :type '(choice
1508 (const :tag "off" nil)
1509 (const :tag "on: after stars/bullet and before tags first" t)
1510 (const :tag "reversed: true line boundary first" reversed)
1511 (cons :tag "Set C-a and C-e separately"
1512 (choice :tag "Special C-a"
1513 (const :tag "off" nil)
1514 (const :tag "on: after stars/bullet first" t)
1515 (const :tag "reversed: before stars/bullet first" reversed))
1516 (choice :tag "Special C-e"
1517 (const :tag "off" nil)
1518 (const :tag "on: before tags first" t)
1519 (const :tag "reversed: after tags first" reversed)))))
1520 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1522 (defcustom org-special-ctrl-k nil
1523 "Non-nil means `C-k' will behave specially in headlines.
1524 When nil, `C-k' will call the default `kill-line' command.
1525 When t, the following will happen while the cursor is in the headline:
1527 - When the cursor is at the beginning of a headline, kill the entire
1528 line and possible the folded subtree below the line.
1529 - When in the middle of the headline text, kill the headline up to the tags.
1530 - When after the headline text, kill the tags."
1531 :group 'org-edit-structure
1532 :type 'boolean)
1534 (defcustom org-ctrl-k-protect-subtree nil
1535 "Non-nil means, do not delete a hidden subtree with C-k.
1536 When set to the symbol `error', simply throw an error when C-k is
1537 used to kill (part-of) a headline that has hidden text behind it.
1538 Any other non-nil value will result in a query to the user, if it is
1539 OK to kill that hidden subtree. When nil, kill without remorse."
1540 :group 'org-edit-structure
1541 :version "24.1"
1542 :type '(choice
1543 (const :tag "Do not protect hidden subtrees" nil)
1544 (const :tag "Protect hidden subtrees with a security query" t)
1545 (const :tag "Never kill a hidden subtree with C-k" error)))
1547 (defcustom org-special-ctrl-o t
1548 "Non-nil means, make `C-o' insert a row in tables."
1549 :group 'org-edit-structure
1550 :type 'boolean)
1552 (defcustom org-catch-invisible-edits nil
1553 "Check if in invisible region before inserting or deleting a character.
1554 Valid values are:
1556 nil Do not check, so just do invisible edits.
1557 error Throw an error and do nothing.
1558 show Make point visible, and do the requested edit.
1559 show-and-error Make point visible, then throw an error and abort the edit.
1560 smart Make point visible, and do insertion/deletion if it is
1561 adjacent to visible text and the change feels predictable.
1562 Never delete a previously invisible character or add in the
1563 middle or right after an invisible region. Basically, this
1564 allows insertion and backward-delete right before ellipses.
1565 FIXME: maybe in this case we should not even show?"
1566 :group 'org-edit-structure
1567 :version "24.1"
1568 :type '(choice
1569 (const :tag "Do not check" nil)
1570 (const :tag "Throw error when trying to edit" error)
1571 (const :tag "Unhide, but do not do the edit" show-and-error)
1572 (const :tag "Show invisible part and do the edit" show)
1573 (const :tag "Be smart and do the right thing" smart)))
1575 (defcustom org-yank-folded-subtrees t
1576 "Non-nil means when yanking subtrees, fold them.
1577 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1578 it starts with a heading and all other headings in it are either children
1579 or siblings, then fold all the subtrees. However, do this only if no
1580 text after the yank would be swallowed into a folded tree by this action."
1581 :group 'org-edit-structure
1582 :type 'boolean)
1584 (defcustom org-yank-adjusted-subtrees nil
1585 "Non-nil means when yanking subtrees, adjust the level.
1586 With this setting, `org-paste-subtree' is used to insert the subtree, see
1587 this function for details."
1588 :group 'org-edit-structure
1589 :type 'boolean)
1591 (defcustom org-M-RET-may-split-line '((default . t))
1592 "Non-nil means M-RET will split the line at the cursor position.
1593 When nil, it will go to the end of the line before making a
1594 new line.
1595 You may also set this option in a different way for different
1596 contexts. Valid contexts are:
1598 headline when creating a new headline
1599 item when creating a new item
1600 table in a table field
1601 default the value to be used for all contexts not explicitly
1602 customized"
1603 :group 'org-structure
1604 :group 'org-table
1605 :type '(choice
1606 (const :tag "Always" t)
1607 (const :tag "Never" nil)
1608 (repeat :greedy t :tag "Individual contexts"
1609 (cons
1610 (choice :tag "Context"
1611 (const headline)
1612 (const item)
1613 (const table)
1614 (const default))
1615 (boolean)))))
1618 (defcustom org-insert-heading-respect-content nil
1619 "Non-nil means insert new headings after the current subtree.
1620 When nil, the new heading is created directly after the current line.
1621 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1622 this variable on for the duration of the command."
1623 :group 'org-structure
1624 :type 'boolean)
1626 (defcustom org-blank-before-new-entry '((heading . auto)
1627 (plain-list-item . auto))
1628 "Should `org-insert-heading' leave a blank line before new heading/item?
1629 The value is an alist, with `heading' and `plain-list-item' as CAR,
1630 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1631 which case Org will look at the surrounding headings/items and try to
1632 make an intelligent decision whether to insert a blank line or not.
1634 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1635 the setting here is ignored and no empty line is inserted to avoid breaking
1636 the list structure."
1637 :group 'org-edit-structure
1638 :type '(list
1639 (cons (const heading)
1640 (choice (const :tag "Never" nil)
1641 (const :tag "Always" t)
1642 (const :tag "Auto" auto)))
1643 (cons (const plain-list-item)
1644 (choice (const :tag "Never" nil)
1645 (const :tag "Always" t)
1646 (const :tag "Auto" auto)))))
1648 (defcustom org-insert-heading-hook nil
1649 "Hook being run after inserting a new heading."
1650 :group 'org-edit-structure
1651 :type 'hook)
1653 (defcustom org-enable-fixed-width-editor t
1654 "Non-nil means lines starting with \":\" are treated as fixed-width.
1655 This currently only means they are never auto-wrapped.
1656 When nil, such lines will be treated like ordinary lines."
1657 :group 'org-edit-structure
1658 :type 'boolean)
1660 (defcustom org-goto-auto-isearch t
1661 "Non-nil means typing characters in `org-goto' starts incremental search.
1662 When nil, you can use these keybindings to navigate the buffer:
1664 q Quit the org-goto interface
1665 n Go to the next visible heading
1666 p Go to the previous visible heading
1667 f Go one heading forward on same level
1668 b Go one heading backward on same level
1669 u Go one heading up"
1670 :group 'org-edit-structure
1671 :type 'boolean)
1673 (defgroup org-sparse-trees nil
1674 "Options concerning sparse trees in Org-mode."
1675 :tag "Org Sparse Trees"
1676 :group 'org-structure)
1678 (defcustom org-highlight-sparse-tree-matches t
1679 "Non-nil means highlight all matches that define a sparse tree.
1680 The highlights will automatically disappear the next time the buffer is
1681 changed by an edit command."
1682 :group 'org-sparse-trees
1683 :type 'boolean)
1685 (defcustom org-remove-highlights-with-change t
1686 "Non-nil means any change to the buffer will remove temporary highlights.
1687 Such highlights are created by `org-occur' and `org-clock-display'.
1688 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1689 The highlights created by `org-toggle-latex-fragment' always need
1690 `C-c C-x C-l' to be removed."
1691 :group 'org-sparse-trees
1692 :group 'org-time
1693 :type 'boolean)
1696 (defcustom org-occur-hook '(org-first-headline-recenter)
1697 "Hook that is run after `org-occur' has constructed a sparse tree.
1698 This can be used to recenter the window to show as much of the structure
1699 as possible."
1700 :group 'org-sparse-trees
1701 :type 'hook)
1703 (defgroup org-imenu-and-speedbar nil
1704 "Options concerning imenu and speedbar in Org-mode."
1705 :tag "Org Imenu and Speedbar"
1706 :group 'org-structure)
1708 (defcustom org-imenu-depth 2
1709 "The maximum level for Imenu access to Org-mode headlines.
1710 This also applied for speedbar access."
1711 :group 'org-imenu-and-speedbar
1712 :type 'integer)
1714 (defgroup org-table nil
1715 "Options concerning tables in Org-mode."
1716 :tag "Org Table"
1717 :group 'org)
1719 (defcustom org-enable-table-editor 'optimized
1720 "Non-nil means lines starting with \"|\" are handled by the table editor.
1721 When nil, such lines will be treated like ordinary lines.
1723 When equal to the symbol `optimized', the table editor will be optimized to
1724 do the following:
1725 - Automatic overwrite mode in front of whitespace in table fields.
1726 This makes the structure of the table stay in tact as long as the edited
1727 field does not exceed the column width.
1728 - Minimize the number of realigns. Normally, the table is aligned each time
1729 TAB or RET are pressed to move to another field. With optimization this
1730 happens only if changes to a field might have changed the column width.
1731 Optimization requires replacing the functions `self-insert-command',
1732 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1733 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1734 very good at guessing when a re-align will be necessary, but you can always
1735 force one with \\[org-ctrl-c-ctrl-c].
1737 If you would like to use the optimized version in Org-mode, but the
1738 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1740 This variable can be used to turn on and off the table editor during a session,
1741 but in order to toggle optimization, a restart is required.
1743 See also the variable `org-table-auto-blank-field'."
1744 :group 'org-table
1745 :type '(choice
1746 (const :tag "off" nil)
1747 (const :tag "on" t)
1748 (const :tag "on, optimized" optimized)))
1750 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1751 (version<= emacs-version "24.1"))
1752 "Non-nil means cluster self-insert commands for undo when possible.
1753 If this is set, then, like in the Emacs command loop, 20 consecutive
1754 characters will be undone together.
1755 This is configurable, because there is some impact on typing performance."
1756 :group 'org-table
1757 :type 'boolean)
1759 (defcustom org-table-tab-recognizes-table.el t
1760 "Non-nil means TAB will automatically notice a table.el table.
1761 When it sees such a table, it moves point into it and - if necessary -
1762 calls `table-recognize-table'."
1763 :group 'org-table-editing
1764 :type 'boolean)
1766 (defgroup org-link nil
1767 "Options concerning links in Org-mode."
1768 :tag "Org Link"
1769 :group 'org)
1771 (defvar org-link-abbrev-alist-local nil
1772 "Buffer-local version of `org-link-abbrev-alist', which see.
1773 The value of this is taken from the #+LINK lines.")
1774 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1776 (defcustom org-link-abbrev-alist nil
1777 "Alist of link abbreviations.
1778 The car of each element is a string, to be replaced at the start of a link.
1779 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1780 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1782 [[linkkey:tag][description]]
1784 The 'linkkey' must be a word word, starting with a letter, followed
1785 by letters, numbers, '-' or '_'.
1787 If REPLACE is a string, the tag will simply be appended to create the link.
1788 If the string contains \"%s\", the tag will be inserted there. If the string
1789 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1790 at that point (see the function `url-hexify-string'). If the string contains
1791 the specifier \"%(my-function)\", then the custom function `my-function' will
1792 be invoked: this function takes the tag as its only argument and must return
1793 a string.
1795 REPLACE may also be a function that will be called with the tag as the
1796 only argument to create the link, which should be returned as a string.
1798 See the manual for examples."
1799 :group 'org-link
1800 :type '(repeat
1801 (cons
1802 (string :tag "Protocol")
1803 (choice
1804 (string :tag "Format")
1805 (function)))))
1807 (defcustom org-descriptive-links t
1808 "Non-nil means Org will display descriptive links.
1809 E.g. [[http://orgmode.org][Org website]] will be displayed as
1810 \"Org Website\", hiding the link itself and just displaying its
1811 description. When set to `nil', Org will display the full links
1812 literally.
1814 You can interactively set the value of this variable by calling
1815 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1816 :group 'org-link
1817 :type 'boolean)
1819 (defcustom org-link-file-path-type 'adaptive
1820 "How the path name in file links should be stored.
1821 Valid values are:
1823 relative Relative to the current directory, i.e. the directory of the file
1824 into which the link is being inserted.
1825 absolute Absolute path, if possible with ~ for home directory.
1826 noabbrev Absolute path, no abbreviation of home directory.
1827 adaptive Use relative path for files in the current directory and sub-
1828 directories of it. For other files, use an absolute path."
1829 :group 'org-link
1830 :type '(choice
1831 (const relative)
1832 (const absolute)
1833 (const noabbrev)
1834 (const adaptive)))
1836 (defvaralias 'org-activate-links 'org-highlight-links)
1837 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1838 "Types of links that should be highlighted in Org-mode files.
1840 This is a list of symbols, each one of them leading to the
1841 highlighting of a certain link type.
1843 You can still open links that are not highlighted.
1845 In principle, it does not hurt to turn on highlighting for all
1846 link types. There may be a small gain when turning off unused
1847 link types. The types are:
1849 bracket The recommended [[link][description]] or [[link]] links with hiding.
1850 angle Links in angular brackets that may contain whitespace like
1851 <bbdb:Carsten Dominik>.
1852 plain Plain links in normal text, no whitespace, like http://google.com.
1853 radio Text that is matched by a radio target, see manual for details.
1854 tag Tag settings in a headline (link to tag search).
1855 date Time stamps (link to calendar).
1856 footnote Footnote labels.
1858 If you set this variable during an Emacs session, use `org-mode-restart'
1859 in the Org buffer so that the change takes effect."
1860 :group 'org-link
1861 :group 'org-appearance
1862 :type '(set :greedy t
1863 (const :tag "Double bracket links" bracket)
1864 (const :tag "Angular bracket links" angle)
1865 (const :tag "Plain text links" plain)
1866 (const :tag "Radio target matches" radio)
1867 (const :tag "Tags" tag)
1868 (const :tag "Timestamps" date)
1869 (const :tag "Footnotes" footnote)))
1871 (defcustom org-make-link-description-function nil
1872 "Function to use for generating link descriptions from links.
1873 When nil, the link location will be used. This function must take
1874 two parameters: the first one is the link, the second one is the
1875 description generated by `org-insert-link'. The function should
1876 return the description to use."
1877 :group 'org-link
1878 :type '(choice (const nil) (function)))
1880 (defgroup org-link-store nil
1881 "Options concerning storing links in Org-mode."
1882 :tag "Org Store Link"
1883 :group 'org-link)
1885 (defcustom org-url-hexify-p t
1886 "When non-nil, hexify URL when creating a link."
1887 :type 'boolean
1888 :version "24.3"
1889 :group 'org-link-store)
1891 (defcustom org-email-link-description-format "Email %c: %.30s"
1892 "Format of the description part of a link to an email or usenet message.
1893 The following %-escapes will be replaced by corresponding information:
1895 %F full \"From\" field
1896 %f name, taken from \"From\" field, address if no name
1897 %T full \"To\" field
1898 %t first name in \"To\" field, address if no name
1899 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1900 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1901 %s subject
1902 %d date
1903 %m message-id.
1905 You may use normal field width specification between the % and the letter.
1906 This is for example useful to limit the length of the subject.
1908 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1909 :group 'org-link-store
1910 :type 'string)
1912 (defcustom org-from-is-user-regexp
1913 (let (r1 r2)
1914 (when (and user-mail-address (not (string= user-mail-address "")))
1915 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1916 (when (and user-full-name (not (string= user-full-name "")))
1917 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1918 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1919 "Regexp matched against the \"From:\" header of an email or usenet message.
1920 It should match if the message is from the user him/herself."
1921 :group 'org-link-store
1922 :type 'regexp)
1924 (defcustom org-context-in-file-links t
1925 "Non-nil means file links from `org-store-link' contain context.
1926 A search string will be added to the file name with :: as separator and
1927 used to find the context when the link is activated by the command
1928 `org-open-at-point'. When this option is t, the entire active region
1929 will be placed in the search string of the file link. If set to a
1930 positive integer, only the first n lines of context will be stored.
1932 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1933 negates this setting for the duration of the command."
1934 :group 'org-link-store
1935 :type '(choice boolean integer))
1937 (defcustom org-keep-stored-link-after-insertion nil
1938 "Non-nil means keep link in list for entire session.
1940 The command `org-store-link' adds a link pointing to the current
1941 location to an internal list. These links accumulate during a session.
1942 The command `org-insert-link' can be used to insert links into any
1943 Org-mode file (offering completion for all stored links). When this
1944 option is nil, every link which has been inserted once using \\[org-insert-link]
1945 will be removed from the list, to make completing the unused links
1946 more efficient."
1947 :group 'org-link-store
1948 :type 'boolean)
1950 (defgroup org-link-follow nil
1951 "Options concerning following links in Org-mode."
1952 :tag "Org Follow Link"
1953 :group 'org-link)
1955 (defcustom org-link-translation-function nil
1956 "Function to translate links with different syntax to Org syntax.
1957 This can be used to translate links created for example by the Planner
1958 or emacs-wiki packages to Org syntax.
1959 The function must accept two parameters, a TYPE containing the link
1960 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1961 which is everything after the link protocol. It should return a cons
1962 with possibly modified values of type and path.
1963 Org contains a function for this, so if you set this variable to
1964 `org-translate-link-from-planner', you should be able follow many
1965 links created by planner."
1966 :group 'org-link-follow
1967 :type '(choice (const nil) (function)))
1969 (defcustom org-follow-link-hook nil
1970 "Hook that is run after a link has been followed."
1971 :group 'org-link-follow
1972 :type 'hook)
1974 (defcustom org-tab-follows-link nil
1975 "Non-nil means on links TAB will follow the link.
1976 Needs to be set before org.el is loaded.
1977 This really should not be used, it does not make sense, and the
1978 implementation is bad."
1979 :group 'org-link-follow
1980 :type 'boolean)
1982 (defcustom org-return-follows-link nil
1983 "Non-nil means on links RET will follow the link.
1984 In tables, the special behavior of RET has precedence."
1985 :group 'org-link-follow
1986 :type 'boolean)
1988 (defcustom org-mouse-1-follows-link
1989 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1990 "Non-nil means mouse-1 on a link will follow the link.
1991 A longer mouse click will still set point. Does not work on XEmacs.
1992 Needs to be set before org.el is loaded."
1993 :group 'org-link-follow
1994 :version "24.4"
1995 :package-version '(Org . "8.3")
1996 :type '(choice
1997 (const :tag "A double click follows the link" double)
1998 (const :tag "Unconditionally follow the link with mouse-1" t)
1999 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
2001 (defcustom org-mark-ring-length 4
2002 "Number of different positions to be recorded in the ring.
2003 Changing this requires a restart of Emacs to work correctly."
2004 :group 'org-link-follow
2005 :type 'integer)
2007 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2008 "Non-nil means internal links in Org files must exactly match a headline.
2009 When nil, the link search tries to match a phrase with all words
2010 in the search text."
2011 :group 'org-link-follow
2012 :version "24.1"
2013 :type '(choice
2014 (const :tag "Use fuzzy text search" nil)
2015 (const :tag "Match only exact headline" t)
2016 (const :tag "Match exact headline or query to create it"
2017 query-to-create)))
2019 (defcustom org-link-frame-setup
2020 '((vm . vm-visit-folder-other-frame)
2021 (vm-imap . vm-visit-imap-folder-other-frame)
2022 (gnus . org-gnus-no-new-news)
2023 (file . find-file-other-window)
2024 (wl . wl-other-frame))
2025 "Setup the frame configuration for following links.
2026 When following a link with Emacs, it may often be useful to display
2027 this link in another window or frame. This variable can be used to
2028 set this up for the different types of links.
2029 For VM, use any of
2030 `vm-visit-folder'
2031 `vm-visit-folder-other-window'
2032 `vm-visit-folder-other-frame'
2033 For Gnus, use any of
2034 `gnus'
2035 `gnus-other-frame'
2036 `org-gnus-no-new-news'
2037 For FILE, use any of
2038 `find-file'
2039 `find-file-other-window'
2040 `find-file-other-frame'
2041 For Wanderlust use any of
2042 `wl'
2043 `wl-other-frame'
2044 For the calendar, use the variable `calendar-setup'.
2045 For BBDB, it is currently only possible to display the matches in
2046 another window."
2047 :group 'org-link-follow
2048 :type '(list
2049 (cons (const vm)
2050 (choice
2051 (const vm-visit-folder)
2052 (const vm-visit-folder-other-window)
2053 (const vm-visit-folder-other-frame)))
2054 (cons (const vm-imap)
2055 (choice
2056 (const vm-visit-imap-folder)
2057 (const vm-visit-imap-folder-other-window)
2058 (const vm-visit-imap-folder-other-frame)))
2059 (cons (const gnus)
2060 (choice
2061 (const gnus)
2062 (const gnus-other-frame)
2063 (const org-gnus-no-new-news)))
2064 (cons (const file)
2065 (choice
2066 (const find-file)
2067 (const find-file-other-window)
2068 (const find-file-other-frame)))
2069 (cons (const wl)
2070 (choice
2071 (const wl)
2072 (const wl-other-frame)))))
2074 (defcustom org-display-internal-link-with-indirect-buffer nil
2075 "Non-nil means use indirect buffer to display infile links.
2076 Activating internal links (from one location in a file to another location
2077 in the same file) normally just jumps to the location. When the link is
2078 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2079 is displayed in
2080 another window. When this option is set, the other window actually displays
2081 an indirect buffer clone of the current buffer, to avoid any visibility
2082 changes to the current buffer."
2083 :group 'org-link-follow
2084 :type 'boolean)
2086 (defcustom org-open-non-existing-files nil
2087 "Non-nil means `org-open-file' will open non-existing files.
2088 When nil, an error will be generated.
2089 This variable applies only to external applications because they
2090 might choke on non-existing files. If the link is to a file that
2091 will be opened in Emacs, the variable is ignored."
2092 :group 'org-link-follow
2093 :type 'boolean)
2095 (defcustom org-open-directory-means-index-dot-org nil
2096 "Non-nil means a link to a directory really means to index.org.
2097 When nil, following a directory link will run dired or open a finder/explorer
2098 window on that directory."
2099 :group 'org-link-follow
2100 :type 'boolean)
2102 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2103 "Non-nil means ask for confirmation before executing shell links.
2104 Shell links can be dangerous: just think about a link
2106 [[shell:rm -rf ~/*][Google Search]]
2108 This link would show up in your Org-mode document as \"Google Search\",
2109 but really it would remove your entire home directory.
2110 Therefore we advise against setting this variable to nil.
2111 Just change it to `y-or-n-p' if you want to confirm with a
2112 single keystroke rather than having to type \"yes\"."
2113 :group 'org-link-follow
2114 :type '(choice
2115 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2116 (const :tag "with y-or-n (faster)" y-or-n-p)
2117 (const :tag "no confirmation (dangerous)" nil)))
2118 (put 'org-confirm-shell-link-function
2119 'safe-local-variable
2120 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2122 (defcustom org-confirm-shell-link-not-regexp ""
2123 "A regexp to skip confirmation for shell links."
2124 :group 'org-link-follow
2125 :version "24.1"
2126 :type 'regexp)
2128 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2129 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2130 Elisp links can be dangerous: just think about a link
2132 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2134 This link would show up in your Org-mode document as \"Google Search\",
2135 but really it would remove your entire home directory.
2136 Therefore we advise against setting this variable to nil.
2137 Just change it to `y-or-n-p' if you want to confirm with a
2138 single keystroke rather than having to type \"yes\"."
2139 :group 'org-link-follow
2140 :type '(choice
2141 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2142 (const :tag "with y-or-n (faster)" y-or-n-p)
2143 (const :tag "no confirmation (dangerous)" nil)))
2144 (put 'org-confirm-shell-link-function
2145 'safe-local-variable
2146 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2148 (defcustom org-confirm-elisp-link-not-regexp ""
2149 "A regexp to skip confirmation for Elisp links."
2150 :group 'org-link-follow
2151 :version "24.1"
2152 :type 'regexp)
2154 (defconst org-file-apps-defaults-gnu
2155 '((remote . emacs)
2156 (system . mailcap)
2157 (t . mailcap))
2158 "Default file applications on a UNIX or GNU/Linux system.
2159 See `org-file-apps'.")
2161 (defconst org-file-apps-defaults-macosx
2162 '((remote . emacs)
2163 (t . "open %s")
2164 (system . "open %s")
2165 ("ps.gz" . "gv %s")
2166 ("eps.gz" . "gv %s")
2167 ("dvi" . "xdvi %s")
2168 ("fig" . "xfig %s"))
2169 "Default file applications on a MacOS X system.
2170 The system \"open\" is known as a default, but we use X11 applications
2171 for some files for which the OS does not have a good default.
2172 See `org-file-apps'.")
2174 (defconst org-file-apps-defaults-windowsnt
2175 (list
2176 '(remote . emacs)
2177 (cons t
2178 (list (if (featurep 'xemacs)
2179 'mswindows-shell-execute
2180 'w32-shell-execute)
2181 "open" 'file))
2182 (cons 'system
2183 (list (if (featurep 'xemacs)
2184 'mswindows-shell-execute
2185 'w32-shell-execute)
2186 "open" 'file)))
2187 "Default file applications on a Windows NT system.
2188 The system \"open\" is used for most files.
2189 See `org-file-apps'.")
2191 (defcustom org-file-apps
2192 '((auto-mode . emacs)
2193 ("\\.mm\\'" . default)
2194 ("\\.x?html?\\'" . default)
2195 ("\\.pdf\\'" . default))
2196 "External applications for opening `file:path' items in a document.
2197 Org-mode uses system defaults for different file types, but
2198 you can use this variable to set the application for a given file
2199 extension. The entries in this list are cons cells where the car identifies
2200 files and the cdr the corresponding command. Possible values for the
2201 file identifier are
2202 \"string\" A string as a file identifier can be interpreted in different
2203 ways, depending on its contents:
2205 - Alphanumeric characters only:
2206 Match links with this file extension.
2207 Example: (\"pdf\" . \"evince %s\")
2208 to open PDFs with evince.
2210 - Regular expression: Match links where the
2211 filename matches the regexp. If you want to
2212 use groups here, use shy groups.
2214 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2215 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2216 to open *.html and *.xhtml with firefox.
2218 - Regular expression which contains (non-shy) groups:
2219 Match links where the whole link, including \"::\", and
2220 anything after that, matches the regexp.
2221 In a custom command string, %1, %2, etc. are replaced with
2222 the parts of the link that were matched by the groups.
2223 For backwards compatibility, if a command string is given
2224 that does not use any of the group matches, this case is
2225 handled identically to the second one (i.e. match against
2226 file name only).
2227 In a custom lisp form, you can access the group matches with
2228 (match-string n link).
2230 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2231 to open [[file:document.pdf::5]] with evince at page 5.
2233 `directory' Matches a directory
2234 `remote' Matches a remote file, accessible through tramp or efs.
2235 Remote files most likely should be visited through Emacs
2236 because external applications cannot handle such paths.
2237 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2238 so all files Emacs knows how to handle. Using this with
2239 command `emacs' will open most files in Emacs. Beware that this
2240 will also open html files inside Emacs, unless you add
2241 (\"html\" . default) to the list as well.
2242 t Default for files not matched by any of the other options.
2243 `system' The system command to open files, like `open' on Windows
2244 and Mac OS X, and mailcap under GNU/Linux. This is the command
2245 that will be selected if you call `C-c C-o' with a double
2246 \\[universal-argument] \\[universal-argument] prefix.
2248 Possible values for the command are:
2249 `emacs' The file will be visited by the current Emacs process.
2250 `default' Use the default application for this file type, which is the
2251 association for t in the list, most likely in the system-specific
2252 part.
2253 This can be used to overrule an unwanted setting in the
2254 system-specific variable.
2255 `system' Use the system command for opening files, like \"open\".
2256 This command is specified by the entry whose car is `system'.
2257 Most likely, the system-specific version of this variable
2258 does define this command, but you can overrule/replace it
2259 here.
2260 string A command to be executed by a shell; %s will be replaced
2261 by the path to the file.
2262 sexp A Lisp form which will be evaluated. The file path will
2263 be available in the Lisp variable `file'.
2264 For more examples, see the system specific constants
2265 `org-file-apps-defaults-macosx'
2266 `org-file-apps-defaults-windowsnt'
2267 `org-file-apps-defaults-gnu'."
2268 :group 'org-link-follow
2269 :type '(repeat
2270 (cons (choice :value ""
2271 (string :tag "Extension")
2272 (const :tag "System command to open files" system)
2273 (const :tag "Default for unrecognized files" t)
2274 (const :tag "Remote file" remote)
2275 (const :tag "Links to a directory" directory)
2276 (const :tag "Any files that have Emacs modes"
2277 auto-mode))
2278 (choice :value ""
2279 (const :tag "Visit with Emacs" emacs)
2280 (const :tag "Use default" default)
2281 (const :tag "Use the system command" system)
2282 (string :tag "Command")
2283 (sexp :tag "Lisp form")))))
2285 (defcustom org-doi-server-url "http://dx.doi.org/"
2286 "The URL of the DOI server."
2287 :type 'string
2288 :version "24.3"
2289 :group 'org-link-follow)
2291 (defgroup org-refile nil
2292 "Options concerning refiling entries in Org-mode."
2293 :tag "Org Refile"
2294 :group 'org)
2296 (defcustom org-directory "~/org"
2297 "Directory with org files.
2298 This is just a default location to look for Org files. There is no need
2299 at all to put your files into this directory. It is only used in the
2300 following situations:
2302 1. When a capture template specifies a target file that is not an
2303 absolute path. The path will then be interpreted relative to
2304 `org-directory'
2305 2. When a capture note is filed away in an interactive way (when exiting the
2306 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2307 with `org-directory' as the default path."
2308 :group 'org-refile
2309 :group 'org-capture
2310 :type 'directory)
2312 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2313 "Default target for storing notes.
2314 Used as a fall back file for org-capture.el, for templates that
2315 do not specify a target file."
2316 :group 'org-refile
2317 :group 'org-capture
2318 :type '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 in a single go, or it 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 "Start tag group, non distinct"
3486 (const :startgrouptag)
3487 (option (string :tag "Group description")))
3488 (list :tag "Group tags delimiter"
3489 (const :grouptags))
3490 (list :tag "End radio group"
3491 (const :endgroup)
3492 (option (string :tag "Group description")))
3493 (list :tag "End tag group, non distinct"
3494 (const :endgrouptag)
3495 (option (string :tag "Group description")))
3496 (const :tag "New line" (:newline)))))
3498 (defcustom org-tag-persistent-alist nil
3499 "List of tags that will always appear in all Org-mode files.
3500 This is in addition to any in buffer settings or customizations
3501 of `org-tag-alist'.
3502 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3503 The value of this variable is an alist, the car of each entry must be a
3504 keyword as a string, the cdr may be a character that is used to select
3505 that tag through the fast-tag-selection interface.
3506 See the manual for details.
3507 To disable these tags on a per-file basis, insert anywhere in the file:
3508 #+STARTUP: noptag"
3509 :group 'org-tags
3510 :type '(repeat
3511 (choice
3512 (cons (string :tag "Tag name")
3513 (character :tag "Access char"))
3514 (const :tag "Start radio group" (:startgroup))
3515 (const :tag "Group tags delimiter" (:grouptags))
3516 (const :tag "End radio group" (:endgroup))
3517 (const :tag "New line" (:newline)))))
3519 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3520 "If non-nil, always offer completion for all tags of all agenda files.
3521 Instead of customizing this variable directly, you might want to
3522 set it locally for capture buffers, because there no list of
3523 tags in that file can be created dynamically (there are none).
3525 (add-hook 'org-capture-mode-hook
3526 (lambda ()
3527 (set (make-local-variable
3528 'org-complete-tags-always-offer-all-agenda-tags)
3529 t)))"
3530 :group 'org-tags
3531 :version "24.1"
3532 :type 'boolean)
3534 (defvar org-file-tags nil
3535 "List of tags that can be inherited by all entries in the file.
3536 The tags will be inherited if the variable `org-use-tag-inheritance'
3537 says they should be.
3538 This variable is populated from #+FILETAGS lines.")
3540 (defcustom org-use-fast-tag-selection 'auto
3541 "Non-nil means use fast tag selection scheme.
3542 This is a special interface to select and deselect tags with single keys.
3543 When nil, fast selection is never used.
3544 When the symbol `auto', fast selection is used if and only if selection
3545 characters for tags have been configured, either through the variable
3546 `org-tag-alist' or through a #+TAGS line in the buffer.
3547 When t, fast selection is always used and selection keys are assigned
3548 automatically if necessary."
3549 :group 'org-tags
3550 :type '(choice
3551 (const :tag "Always" t)
3552 (const :tag "Never" nil)
3553 (const :tag "When selection characters are configured" auto)))
3555 (defcustom org-fast-tag-selection-single-key nil
3556 "Non-nil means fast tag selection exits after first change.
3557 When nil, you have to press RET to exit it.
3558 During fast tag selection, you can toggle this flag with `C-c'.
3559 This variable can also have the value `expert'. In this case, the window
3560 displaying the tags menu is not even shown, until you press C-c again."
3561 :group 'org-tags
3562 :type '(choice
3563 (const :tag "No" nil)
3564 (const :tag "Yes" t)
3565 (const :tag "Expert" expert)))
3567 (defvar org-fast-tag-selection-include-todo nil
3568 "Non-nil means fast tags selection interface will also offer TODO states.
3569 This is an undocumented feature, you should not rely on it.")
3571 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3572 "The column to which tags should be indented in a headline.
3573 If this number is positive, it specifies the column. If it is negative,
3574 it means that the tags should be flushright to that column. For example,
3575 -80 works well for a normal 80 character screen.
3576 When 0, place tags directly after headline text, with only one space in
3577 between."
3578 :group 'org-tags
3579 :type 'integer)
3581 (defcustom org-auto-align-tags t
3582 "Non-nil keeps tags aligned when modifying headlines.
3583 Some operations (i.e. demoting) change the length of a headline and
3584 therefore shift the tags around. With this option turned on, after
3585 each such operation the tags are again aligned to `org-tags-column'."
3586 :group 'org-tags
3587 :type 'boolean)
3589 (defcustom org-use-tag-inheritance t
3590 "Non-nil means tags in levels apply also for sublevels.
3591 When nil, only the tags directly given in a specific line apply there.
3592 This may also be a list of tags that should be inherited, or a regexp that
3593 matches tags that should be inherited. Additional control is possible
3594 with the variable `org-tags-exclude-from-inheritance' which gives an
3595 explicit list of tags to be excluded from inheritance, even if the value of
3596 `org-use-tag-inheritance' would select it for inheritance.
3598 If this option is t, a match early-on in a tree can lead to a large
3599 number of matches in the subtree when constructing the agenda or creating
3600 a sparse tree. If you only want to see the first match in a tree during
3601 a search, check out the variable `org-tags-match-list-sublevels'."
3602 :group 'org-tags
3603 :type '(choice
3604 (const :tag "Not" nil)
3605 (const :tag "Always" t)
3606 (repeat :tag "Specific tags" (string :tag "Tag"))
3607 (regexp :tag "Tags matched by regexp")))
3609 (defcustom org-tags-exclude-from-inheritance nil
3610 "List of tags that should never be inherited.
3611 This is a way to exclude a few tags from inheritance. For way to do
3612 the opposite, to actively allow inheritance for selected tags,
3613 see the variable `org-use-tag-inheritance'."
3614 :group 'org-tags
3615 :type '(repeat (string :tag "Tag")))
3617 (defun org-tag-inherit-p (tag)
3618 "Check if TAG is one that should be inherited."
3619 (cond
3620 ((member tag org-tags-exclude-from-inheritance) nil)
3621 ((eq org-use-tag-inheritance t) t)
3622 ((not org-use-tag-inheritance) nil)
3623 ((stringp org-use-tag-inheritance)
3624 (string-match org-use-tag-inheritance tag))
3625 ((listp org-use-tag-inheritance)
3626 (member tag org-use-tag-inheritance))
3627 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3629 (defcustom org-tags-match-list-sublevels t
3630 "Non-nil means list also sublevels of headlines matching a search.
3631 This variable applies to tags/property searches, and also to stuck
3632 projects because this search is based on a tags match as well.
3634 When set to the symbol `indented', sublevels are indented with
3635 leading dots.
3637 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3638 the sublevels of a headline matching a tag search often also match
3639 the same search. Listing all of them can create very long lists.
3640 Setting this variable to nil causes subtrees of a match to be skipped.
3642 This variable is semi-obsolete and probably should always be true. It
3643 is better to limit inheritance to certain tags using the variables
3644 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3645 :group 'org-tags
3646 :type '(choice
3647 (const :tag "No, don't list them" nil)
3648 (const :tag "Yes, do list them" t)
3649 (const :tag "List them, indented with leading dots" indented)))
3651 (defcustom org-tags-sort-function nil
3652 "When set, tags are sorted using this function as a comparator."
3653 :group 'org-tags
3654 :type '(choice
3655 (const :tag "No sorting" nil)
3656 (const :tag "Alphabetical" string<)
3657 (const :tag "Reverse alphabetical" string>)
3658 (function :tag "Custom function" nil)))
3660 (defvar org-tags-history nil
3661 "History of minibuffer reads for tags.")
3662 (defvar org-last-tags-completion-table nil
3663 "The last used completion table for tags.")
3664 (defvar org-after-tags-change-hook nil
3665 "Hook that is run after the tags in a line have changed.")
3667 (defgroup org-properties nil
3668 "Options concerning properties in Org-mode."
3669 :tag "Org Properties"
3670 :group 'org)
3672 (defcustom org-property-format "%-10s %s"
3673 "How property key/value pairs should be formatted by `indent-line'.
3674 When `indent-line' hits a property definition, it will format the line
3675 according to this format, mainly to make sure that the values are
3676 lined-up with respect to each other."
3677 :group 'org-properties
3678 :type 'string)
3680 (defcustom org-properties-postprocess-alist nil
3681 "Alist of properties and functions to adjust inserted values.
3682 Elements of this alist must be of the form
3684 ([string] [function])
3686 where [string] must be a property name and [function] must be a
3687 lambda expression: this lambda expression must take one argument,
3688 the value to adjust, and return the new value as a string.
3690 For example, this element will allow the property \"Remaining\"
3691 to be updated wrt the relation between the \"Effort\" property
3692 and the clock summary:
3694 ((\"Remaining\" (lambda(value)
3695 (let ((clocksum (org-clock-sum-current-item))
3696 (effort (org-duration-string-to-minutes
3697 (org-entry-get (point) \"Effort\"))))
3698 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3699 :group 'org-properties
3700 :version "24.1"
3701 :type '(alist :key-type (string :tag "Property")
3702 :value-type (function :tag "Function")))
3704 (defcustom org-use-property-inheritance nil
3705 "Non-nil means properties apply also for sublevels.
3707 This setting is chiefly used during property searches. Turning it on can
3708 cause significant overhead when doing a search, which is why it is not
3709 on by default.
3711 When nil, only the properties directly given in the current entry count.
3712 When t, every property is inherited. The value may also be a list of
3713 properties that should have inheritance, or a regular expression matching
3714 properties that should be inherited.
3716 However, note that some special properties use inheritance under special
3717 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3718 and the properties ending in \"_ALL\" when they are used as descriptor
3719 for valid values of a property.
3721 Note for programmers:
3722 When querying an entry with `org-entry-get', you can control if inheritance
3723 should be used. By default, `org-entry-get' looks only at the local
3724 properties. You can request inheritance by setting the inherit argument
3725 to t (to force inheritance) or to `selective' (to respect the setting
3726 in this variable)."
3727 :group 'org-properties
3728 :type '(choice
3729 (const :tag "Not" nil)
3730 (const :tag "Always" t)
3731 (repeat :tag "Specific properties" (string :tag "Property"))
3732 (regexp :tag "Properties matched by regexp")))
3734 (defun org-property-inherit-p (property)
3735 "Check if PROPERTY is one that should be inherited."
3736 (cond
3737 ((eq org-use-property-inheritance t) t)
3738 ((not org-use-property-inheritance) nil)
3739 ((stringp org-use-property-inheritance)
3740 (string-match org-use-property-inheritance property))
3741 ((listp org-use-property-inheritance)
3742 (member property org-use-property-inheritance))
3743 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3745 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3746 "The default column format, if no other format has been defined.
3747 This variable can be set on the per-file basis by inserting a line
3749 #+COLUMNS: %25ITEM ....."
3750 :group 'org-properties
3751 :type 'string)
3753 (defcustom org-columns-ellipses ".."
3754 "The ellipses to be used when a field in column view is truncated.
3755 When this is the empty string, as many characters as possible are shown,
3756 but then there will be no visual indication that the field has been truncated.
3757 When this is a string of length N, the last N characters of a truncated
3758 field are replaced by this string. If the column is narrower than the
3759 ellipses string, only part of the ellipses string will be shown."
3760 :group 'org-properties
3761 :type 'string)
3763 (defcustom org-columns-modify-value-for-display-function nil
3764 "Function that modifies values for display in column view.
3765 For example, it can be used to cut out a certain part from a time stamp.
3766 The function must take 2 arguments:
3768 column-title The title of the column (*not* the property name)
3769 value The value that should be modified.
3771 The function should return the value that should be displayed,
3772 or nil if the normal value should be used."
3773 :group 'org-properties
3774 :type '(choice (const nil) (function)))
3776 (defconst org-global-properties-fixed
3777 '(("VISIBILITY_ALL" . "folded children content all")
3778 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3779 "List of property/value pairs that can be inherited by any entry.
3781 These are fixed values, for the preset properties. The user variable
3782 that can be used to add to this list is `org-global-properties'.
3784 The entries in this list are cons cells where the car is a property
3785 name and cdr is a string with the value. If the value represents
3786 multiple items like an \"_ALL\" property, separate the items by
3787 spaces.")
3789 (defcustom org-global-properties nil
3790 "List of property/value pairs that can be inherited by any entry.
3792 This list will be combined with the constant `org-global-properties-fixed'.
3794 The entries in this list are cons cells where the car is a property
3795 name and cdr is a string with the value.
3797 You can set buffer-local values for the same purpose in the variable
3798 `org-file-properties' this by adding lines like
3800 #+PROPERTY: NAME VALUE"
3801 :group 'org-properties
3802 :type '(repeat
3803 (cons (string :tag "Property")
3804 (string :tag "Value"))))
3806 (defvar org-file-properties nil
3807 "List of property/value pairs that can be inherited by any entry.
3808 Valid for the current buffer.
3809 This variable is populated from #+PROPERTY lines.")
3810 (make-variable-buffer-local 'org-file-properties)
3812 (defgroup org-agenda nil
3813 "Options concerning agenda views in Org-mode."
3814 :tag "Org Agenda"
3815 :group 'org)
3817 (defvar org-category nil
3818 "Variable used by org files to set a category for agenda display.
3819 Such files should use a file variable to set it, for example
3821 # -*- mode: org; org-category: \"ELisp\"
3823 or contain a special line
3825 #+CATEGORY: ELisp
3827 If the file does not specify a category, then file's base name
3828 is used instead.")
3829 (make-variable-buffer-local 'org-category)
3830 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3832 (defcustom org-agenda-files nil
3833 "The files to be used for agenda display.
3834 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3835 \\[org-remove-file]. You can also use customize to edit the list.
3837 If an entry is a directory, all files in that directory that are matched by
3838 `org-agenda-file-regexp' will be part of the file list.
3840 If the value of the variable is not a list but a single file name, then
3841 the list of agenda files is actually stored and maintained in that file, one
3842 agenda file per line. In this file paths can be given relative to
3843 `org-directory'. Tilde expansion and environment variable substitution
3844 are also made."
3845 :group 'org-agenda
3846 :type '(choice
3847 (repeat :tag "List of files and directories" file)
3848 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3850 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3851 "Regular expression to match files for `org-agenda-files'.
3852 If any element in the list in that variable contains a directory instead
3853 of a normal file, all files in that directory that are matched by this
3854 regular expression will be included."
3855 :group 'org-agenda
3856 :type 'regexp)
3858 (defcustom org-agenda-text-search-extra-files nil
3859 "List of extra files to be searched by text search commands.
3860 These files will be searched in addition to the agenda files by the
3861 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3862 Note that these files will only be searched for text search commands,
3863 not for the other agenda views like todo lists, tag searches or the weekly
3864 agenda. This variable is intended to list notes and possibly archive files
3865 that should also be searched by these two commands.
3866 In fact, if the first element in the list is the symbol `agenda-archives',
3867 then all archive files of all agenda files will be added to the search
3868 scope."
3869 :group 'org-agenda
3870 :type '(set :greedy t
3871 (const :tag "Agenda Archives" agenda-archives)
3872 (repeat :inline t (file))))
3874 (org-defvaralias 'org-agenda-multi-occur-extra-files
3875 'org-agenda-text-search-extra-files)
3877 (defcustom org-agenda-skip-unavailable-files nil
3878 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3879 A nil value means to remove them, after a query, from the list."
3880 :group 'org-agenda
3881 :type 'boolean)
3883 (defcustom org-calendar-to-agenda-key [?c]
3884 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3885 The command `org-calendar-goto-agenda' will be bound to this key. The
3886 default is the character `c' because then `c' can be used to switch back and
3887 forth between agenda and calendar."
3888 :group 'org-agenda
3889 :type 'sexp)
3891 (defcustom org-calendar-insert-diary-entry-key [?i]
3892 "The key to be installed in `calendar-mode-map' for adding diary entries.
3893 This option is irrelevant until `org-agenda-diary-file' has been configured
3894 to point to an Org-mode file. When that is the case, the command
3895 `org-agenda-diary-entry' will be bound to the key given here, by default
3896 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3897 if you want to continue doing this, you need to change this to a different
3898 key."
3899 :group 'org-agenda
3900 :type 'sexp)
3902 (defcustom org-agenda-diary-file 'diary-file
3903 "File to which to add new entries with the `i' key in agenda and calendar.
3904 When this is the symbol `diary-file', the functionality in the Emacs
3905 calendar will be used to add entries to the `diary-file'. But when this
3906 points to a file, `org-agenda-diary-entry' will be used instead."
3907 :group 'org-agenda
3908 :type '(choice
3909 (const :tag "The standard Emacs diary file" diary-file)
3910 (file :tag "Special Org file diary entries")))
3912 (eval-after-load "calendar"
3913 '(progn
3914 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3915 'org-calendar-goto-agenda)
3916 (add-hook 'calendar-mode-hook
3917 (lambda ()
3918 (unless (eq org-agenda-diary-file 'diary-file)
3919 (define-key calendar-mode-map
3920 org-calendar-insert-diary-entry-key
3921 'org-agenda-diary-entry))))))
3923 (defgroup org-latex nil
3924 "Options for embedding LaTeX code into Org-mode."
3925 :tag "Org LaTeX"
3926 :group 'org)
3928 (defcustom org-format-latex-options
3929 '(:foreground default :background default :scale 1.0
3930 :html-foreground "Black" :html-background "Transparent"
3931 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3932 "Options for creating images from LaTeX fragments.
3933 This is a property list with the following properties:
3934 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3935 `default' means use the foreground of the default face.
3936 `auto' means use the foreground from the text face.
3937 :background the background color, or \"Transparent\".
3938 `default' means use the background of the default face.
3939 `auto' means use the background from the text face.
3940 :scale a scaling factor for the size of the images, to get more pixels
3941 :html-foreground, :html-background, :html-scale
3942 the same numbers for HTML export.
3943 :matchers a list indicating which matchers should be used to
3944 find LaTeX fragments. Valid members of this list are:
3945 \"begin\" find environments
3946 \"$1\" find single characters surrounded by $.$
3947 \"$\" find math expressions surrounded by $...$
3948 \"$$\" find math expressions surrounded by $$....$$
3949 \"\\(\" find math expressions surrounded by \\(...\\)
3950 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3951 :group 'org-latex
3952 :type 'plist)
3954 (defcustom org-format-latex-signal-error t
3955 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3956 When nil, just push out a message."
3957 :group 'org-latex
3958 :version "24.1"
3959 :type 'boolean)
3961 (defcustom org-latex-to-mathml-jar-file nil
3962 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3963 Use this to specify additional executable file say a jar file.
3965 When using MathToWeb as the converter, specify the full-path to
3966 your mathtoweb.jar file."
3967 :group 'org-latex
3968 :version "24.1"
3969 :type '(choice
3970 (const :tag "None" nil)
3971 (file :tag "JAR file" :must-match t)))
3973 (defcustom org-latex-to-mathml-convert-command nil
3974 "Command to convert LaTeX fragments to MathML.
3975 Replace format-specifiers in the command as noted below and use
3976 `shell-command' to convert LaTeX to MathML.
3977 %j: Executable file in fully expanded form as specified by
3978 `org-latex-to-mathml-jar-file'.
3979 %I: Input LaTeX file in fully expanded form.
3980 %i: The latex fragment to be converted.
3981 %o: Output MathML file.
3982 This command is used by `org-create-math-formula'.
3984 When using MathToWeb as the converter, set this to
3985 \"java -jar %j -unicode -force -df %o %I\".
3987 When using LaTeXML set this to
3988 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3989 :group 'org-latex
3990 :version "24.1"
3991 :type '(choice
3992 (const :tag "None" nil)
3993 (string :tag "\nShell command")))
3995 (defcustom org-latex-create-formula-image-program 'dvipng
3996 "Program to convert LaTeX fragments with.
3998 dvipng Process the LaTeX fragments to dvi file, then convert
3999 dvi files to png files using dvipng.
4000 This will also include processing of non-math environments.
4001 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
4002 to convert pdf files to png files"
4003 :group 'org-latex
4004 :version "24.1"
4005 :type '(choice
4006 (const :tag "dvipng" dvipng)
4007 (const :tag "imagemagick" imagemagick)))
4009 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4010 "Path to store latex preview images.
4011 A relative path here creates many directories relative to the
4012 processed org files paths. An absolute path puts all preview
4013 images at the same place."
4014 :group 'org-latex
4015 :version "24.3"
4016 :type 'string)
4018 (defun org-format-latex-mathml-available-p ()
4019 "Return t if `org-latex-to-mathml-convert-command' is usable."
4020 (save-match-data
4021 (when (and (boundp 'org-latex-to-mathml-convert-command)
4022 org-latex-to-mathml-convert-command)
4023 (let ((executable (car (split-string
4024 org-latex-to-mathml-convert-command))))
4025 (when (executable-find executable)
4026 (if (string-match
4027 "%j" org-latex-to-mathml-convert-command)
4028 (file-readable-p org-latex-to-mathml-jar-file)
4029 t))))))
4031 (defcustom org-format-latex-header "\\documentclass{article}
4032 \\usepackage[usenames]{color}
4033 \[PACKAGES]
4034 \[DEFAULT-PACKAGES]
4035 \\pagestyle{empty} % do not remove
4036 % The settings below are copied from fullpage.sty
4037 \\setlength{\\textwidth}{\\paperwidth}
4038 \\addtolength{\\textwidth}{-3cm}
4039 \\setlength{\\oddsidemargin}{1.5cm}
4040 \\addtolength{\\oddsidemargin}{-2.54cm}
4041 \\setlength{\\evensidemargin}{\\oddsidemargin}
4042 \\setlength{\\textheight}{\\paperheight}
4043 \\addtolength{\\textheight}{-\\headheight}
4044 \\addtolength{\\textheight}{-\\headsep}
4045 \\addtolength{\\textheight}{-\\footskip}
4046 \\addtolength{\\textheight}{-3cm}
4047 \\setlength{\\topmargin}{1.5cm}
4048 \\addtolength{\\topmargin}{-2.54cm}"
4049 "The document header used for processing LaTeX fragments.
4050 It is imperative that this header make sure that no page number
4051 appears on the page. The package defined in the variables
4052 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4053 will either replace the placeholder \"[PACKAGES]\" in this
4054 header, or they will be appended."
4055 :group 'org-latex
4056 :type 'string)
4058 (defun org-set-packages-alist (var val)
4059 "Set the packages alist and make sure it has 3 elements per entry."
4060 (set var (mapcar (lambda (x)
4061 (if (and (consp x) (= (length x) 2))
4062 (list (car x) (nth 1 x) t)
4064 val)))
4066 (defun org-get-packages-alist (var)
4067 "Get the packages alist and make sure it has 3 elements per entry."
4068 (mapcar (lambda (x)
4069 (if (and (consp x) (= (length x) 2))
4070 (list (car x) (nth 1 x) t)
4072 (default-value var)))
4074 (defcustom org-latex-default-packages-alist
4075 '(("AUTO" "inputenc" t)
4076 ("T1" "fontenc" t)
4077 ("" "fixltx2e" nil)
4078 ("" "graphicx" t)
4079 ("" "longtable" nil)
4080 ("" "float" nil)
4081 ("" "wrapfig" nil)
4082 ("" "rotating" nil)
4083 ("normalem" "ulem" t)
4084 ("" "amsmath" t)
4085 ("" "textcomp" t)
4086 ("" "marvosym" t)
4087 ("" "wasysym" t)
4088 ("" "amssymb" t)
4089 ("" "capt-of" nil)
4090 ("" "hyperref" nil)
4091 "\\tolerance=1000")
4092 "Alist of default packages to be inserted in the header.
4094 Change this only if one of the packages here causes an
4095 incompatibility with another package you are using.
4097 The packages in this list are needed by one part or another of
4098 Org mode to function properly:
4100 - inputenc, fontenc: for basic font and character selection
4101 - fixltx2e: Important patches of LaTeX itself
4102 - graphicx: for including images
4103 - longtable: For multipage tables
4104 - float, wrapfig: for figure placement
4105 - rotating: for sideways figures and tables
4106 - ulem: for underline and strike-through
4107 - amsmath: for subscript and superscript and math environments
4108 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4109 for interpreting the entities in `org-entities'. You can skip
4110 some of these packages if you don't use any of their symbols.
4111 - capt-of: for captions outside of floats
4112 - hyperref: for cross references
4114 Therefore you should not modify this variable unless you know
4115 what you are doing. The one reason to change it anyway is that
4116 you might be loading some other package that conflicts with one
4117 of the default packages. Each element is either a cell or
4118 a string.
4120 A cell is of the format:
4122 \( \"options\" \"package\" SNIPPET-FLAG).
4124 If SNIPPET-FLAG is non-nil, the package also needs to be included
4125 when compiling LaTeX snippets into images for inclusion into
4126 non-LaTeX output.
4128 A string will be inserted as-is in the header of the document."
4129 :group 'org-latex
4130 :group 'org-export-latex
4131 :set 'org-set-packages-alist
4132 :get 'org-get-packages-alist
4133 :version "24.1"
4134 :type '(repeat
4135 (choice
4136 (list :tag "options/package pair"
4137 (string :tag "options")
4138 (string :tag "package")
4139 (boolean :tag "Snippet"))
4140 (string :tag "A line of LaTeX"))))
4142 (defcustom org-latex-packages-alist nil
4143 "Alist of packages to be inserted in every LaTeX header.
4145 These will be inserted after `org-latex-default-packages-alist'.
4146 Each element is either a cell or a string.
4148 A cell is of the format:
4150 \(\"options\" \"package\" SNIPPET-FLAG)
4152 SNIPPET-FLAG, when non-nil, indicates that this package is also
4153 needed when turning LaTeX snippets into images for inclusion into
4154 non-LaTeX output.
4156 A string will be inserted as-is in the header of the document.
4158 Make sure that you only list packages here which:
4160 - you want in every file;
4161 - do not conflict with the setup in `org-format-latex-header';
4162 - do not conflict with the default packages in
4163 `org-latex-default-packages-alist'."
4164 :group 'org-latex
4165 :group 'org-export-latex
4166 :set 'org-set-packages-alist
4167 :get 'org-get-packages-alist
4168 :type '(repeat
4169 (choice
4170 (list :tag "options/package pair"
4171 (string :tag "options")
4172 (string :tag "package")
4173 (boolean :tag "Snippet"))
4174 (string :tag "A line of LaTeX"))))
4176 (defgroup org-appearance nil
4177 "Settings for Org-mode appearance."
4178 :tag "Org Appearance"
4179 :group 'org)
4181 (defcustom org-level-color-stars-only nil
4182 "Non-nil means fontify only the stars in each headline.
4183 When nil, the entire headline is fontified.
4184 Changing it requires restart of `font-lock-mode' to become effective
4185 also in regions already fontified."
4186 :group 'org-appearance
4187 :type 'boolean)
4189 (defcustom org-hide-leading-stars nil
4190 "Non-nil means hide the first N-1 stars in a headline.
4191 This works by using the face `org-hide' for these stars. This
4192 face is white for a light background, and black for a dark
4193 background. You may have to customize the face `org-hide' to
4194 make this work.
4195 Changing it requires restart of `font-lock-mode' to become effective
4196 also in regions already fontified.
4197 You may also set this on a per-file basis by adding one of the following
4198 lines to the buffer:
4200 #+STARTUP: hidestars
4201 #+STARTUP: showstars"
4202 :group 'org-appearance
4203 :type 'boolean)
4205 (defcustom org-hidden-keywords nil
4206 "List of symbols corresponding to keywords to be hidden the org buffer.
4207 For example, a value '(title) for this list will make the document's title
4208 appear in the buffer without the initial #+TITLE: keyword."
4209 :group 'org-appearance
4210 :version "24.1"
4211 :type '(set (const :tag "#+AUTHOR" author)
4212 (const :tag "#+DATE" date)
4213 (const :tag "#+EMAIL" email)
4214 (const :tag "#+TITLE" title)))
4216 (defcustom org-custom-properties nil
4217 "List of properties (as strings) with a special meaning.
4218 The default use of these custom properties is to let the user
4219 hide them with `org-toggle-custom-properties-visibility'."
4220 :group 'org-properties
4221 :group 'org-appearance
4222 :version "24.3"
4223 :type '(repeat (string :tag "Property Name")))
4225 (defcustom org-fontify-done-headline nil
4226 "Non-nil means change the face of a headline if it is marked DONE.
4227 Normally, only the TODO/DONE keyword indicates the state of a headline.
4228 When this is non-nil, the headline after the keyword is set to the
4229 `org-headline-done' as an additional indication."
4230 :group 'org-appearance
4231 :type 'boolean)
4233 (defcustom org-fontify-emphasized-text t
4234 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4235 Changing this variable requires a restart of Emacs to take effect."
4236 :group 'org-appearance
4237 :type 'boolean)
4239 (defcustom org-fontify-whole-heading-line nil
4240 "Non-nil means fontify the whole line for headings.
4241 This is useful when setting a background color for the
4242 org-level-* faces."
4243 :group 'org-appearance
4244 :type 'boolean)
4246 (defcustom org-highlight-latex-and-related nil
4247 "Non-nil means highlight LaTeX related syntax in the buffer.
4248 When non nil, the value should be a list containing any of the
4249 following symbols:
4250 `latex' Highlight LaTeX snippets and environments.
4251 `script' Highlight subscript and superscript.
4252 `entities' Highlight entities."
4253 :group 'org-appearance
4254 :version "24.4"
4255 :package-version '(Org . "8.0")
4256 :type '(choice
4257 (const :tag "No highlighting" nil)
4258 (set :greedy t :tag "Highlight"
4259 (const :tag "LaTeX snippets and environments" latex)
4260 (const :tag "Subscript and superscript" script)
4261 (const :tag "Entities" entities))))
4263 (defcustom org-hide-emphasis-markers nil
4264 "Non-nil mean font-lock should hide the emphasis marker characters."
4265 :group 'org-appearance
4266 :type 'boolean)
4268 (defcustom org-hide-macro-markers nil
4269 "Non-nil mean font-lock should hide the brackets marking macro calls."
4270 :group 'org-appearance
4271 :type 'boolean)
4273 (defcustom org-pretty-entities nil
4274 "Non-nil means show entities as UTF8 characters.
4275 When nil, the \\name form remains in the buffer."
4276 :group 'org-appearance
4277 :version "24.1"
4278 :type 'boolean)
4280 (defcustom org-pretty-entities-include-sub-superscripts t
4281 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4282 :group 'org-appearance
4283 :version "24.1"
4284 :type 'boolean)
4286 (defvar org-emph-re nil
4287 "Regular expression for matching emphasis.
4288 After a match, the match groups contain these elements:
4289 0 The match of the full regular expression, including the characters
4290 before and after the proper match
4291 1 The character before the proper match, or empty at beginning of line
4292 2 The proper match, including the leading and trailing markers
4293 3 The leading marker like * or /, indicating the type of highlighting
4294 4 The text between the emphasis markers, not including the markers
4295 5 The character after the match, empty at the end of a line")
4296 (defvar org-verbatim-re nil
4297 "Regular expression for matching verbatim text.")
4298 (defvar org-emphasis-regexp-components) ; defined just below
4299 (defvar org-emphasis-alist) ; defined just below
4300 (defun org-set-emph-re (var val)
4301 "Set variable and compute the emphasis regular expression."
4302 (set var val)
4303 (when (and (boundp 'org-emphasis-alist)
4304 (boundp 'org-emphasis-regexp-components)
4305 org-emphasis-alist org-emphasis-regexp-components)
4306 (let* ((e org-emphasis-regexp-components)
4307 (pre (car e))
4308 (post (nth 1 e))
4309 (border (nth 2 e))
4310 (body (nth 3 e))
4311 (nl (nth 4 e))
4312 (body1 (concat body "*?"))
4313 (markers (mapconcat 'car org-emphasis-alist ""))
4314 (vmarkers (mapconcat
4315 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4316 org-emphasis-alist "")))
4317 ;; make sure special characters appear at the right position in the class
4318 (if (string-match "\\^" markers)
4319 (setq markers (concat (replace-match "" t t markers) "^")))
4320 (if (string-match "-" markers)
4321 (setq markers (concat (replace-match "" t t markers) "-")))
4322 (if (string-match "\\^" vmarkers)
4323 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4324 (if (string-match "-" vmarkers)
4325 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4326 (if (> nl 0)
4327 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4328 (int-to-string nl) "\\}")))
4329 ;; Make the regexp
4330 (setq org-emph-re
4331 (concat "\\([" pre "]\\|^\\)"
4332 "\\("
4333 "\\([" markers "]\\)"
4334 "\\("
4335 "[^" border "]\\|"
4336 "[^" border "]"
4337 body1
4338 "[^" border "]"
4339 "\\)"
4340 "\\3\\)"
4341 "\\([" post "]\\|$\\)"))
4342 (setq org-verbatim-re
4343 (concat "\\([" pre "]\\|^\\)"
4344 "\\("
4345 "\\([" vmarkers "]\\)"
4346 "\\("
4347 "[^" border "]\\|"
4348 "[^" border "]"
4349 body1
4350 "[^" border "]"
4351 "\\)"
4352 "\\3\\)"
4353 "\\([" post "]\\|$\\)")))))
4355 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4356 ;; set this option proved cumbersome. See this message/thread:
4357 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4358 (defvar org-emphasis-regexp-components
4359 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4360 "Components used to build the regular expression for emphasis.
4361 This is a list with five entries. Terminology: In an emphasis string
4362 like \" *strong word* \", we call the initial space PREMATCH, the final
4363 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4364 and \"trong wor\" is the body. The different components in this variable
4365 specify what is allowed/forbidden in each part:
4367 pre Chars allowed as prematch. Beginning of line will be allowed too.
4368 post Chars allowed as postmatch. End of line will be allowed too.
4369 border The chars *forbidden* as border characters.
4370 body-regexp A regexp like \".\" to match a body character. Don't use
4371 non-shy groups here, and don't allow newline here.
4372 newline The maximum number of newlines allowed in an emphasis exp.
4374 You need to reload Org or to restart Emacs after customizing this.")
4376 (defcustom org-emphasis-alist
4377 `(("*" bold)
4378 ("/" italic)
4379 ("_" underline)
4380 ("=" org-verbatim verbatim)
4381 ("~" org-code verbatim)
4382 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4383 "Alist of characters and faces to emphasize text.
4384 Text starting and ending with a special character will be emphasized,
4385 for example *bold*, _underlined_ and /italic/. This variable sets the
4386 marker characters and the face to be used by font-lock for highlighting
4387 in Org-mode Emacs buffers.
4389 You need to reload Org or to restart Emacs after customizing this."
4390 :group 'org-appearance
4391 :set 'org-set-emph-re
4392 :version "24.4"
4393 :package-version '(Org . "8.0")
4394 :type '(repeat
4395 (list
4396 (string :tag "Marker character")
4397 (choice
4398 (face :tag "Font-lock-face")
4399 (plist :tag "Face property list"))
4400 (option (const verbatim)))))
4402 (defvar org-protecting-blocks
4403 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4404 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4405 This is needed for font-lock setup.")
4407 ;;; Miscellaneous options
4409 (defgroup org-completion nil
4410 "Completion in Org-mode."
4411 :tag "Org Completion"
4412 :group 'org)
4414 (defcustom org-completion-use-ido nil
4415 "Non-nil means use ido completion wherever possible.
4416 Note that `ido-mode' must be active for this variable to be relevant.
4417 If you decide to turn this variable on, you might well want to turn off
4418 `org-outline-path-complete-in-steps'.
4419 See also `org-completion-use-iswitchb'."
4420 :group 'org-completion
4421 :type 'boolean)
4423 (defcustom org-completion-use-iswitchb nil
4424 "Non-nil means use iswitchb completion wherever possible.
4425 Note that `iswitchb-mode' must be active for this variable to be relevant.
4426 If you decide to turn this variable on, you might well want to turn off
4427 `org-outline-path-complete-in-steps'.
4428 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4429 :group 'org-completion
4430 :type 'boolean)
4432 (defcustom org-completion-fallback-command 'hippie-expand
4433 "The expansion command called by \\[pcomplete] in normal context.
4434 Normal means, no org-mode-specific context."
4435 :group 'org-completion
4436 :type 'function)
4438 ;;; Functions and variables from their packages
4439 ;; Declared here to avoid compiler warnings
4441 ;; XEmacs only
4442 (defvar outline-mode-menu-heading)
4443 (defvar outline-mode-menu-show)
4444 (defvar outline-mode-menu-hide)
4445 (defvar zmacs-regions) ; XEmacs regions
4447 ;; Emacs only
4448 (defvar mark-active)
4450 ;; Various packages
4451 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4452 (declare-function calendar-forward-day "cal-move" (arg))
4453 (declare-function calendar-goto-date "cal-move" (date))
4454 (declare-function calendar-goto-today "cal-move" ())
4455 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4456 (defvar calc-embedded-close-formula)
4457 (defvar calc-embedded-open-formula)
4458 (declare-function cdlatex-tab "ext:cdlatex" ())
4459 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4460 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4461 (defvar font-lock-unfontify-region-function)
4462 (declare-function iswitchb-read-buffer "iswitchb"
4463 (prompt &optional default require-match start matches-set))
4464 (defvar iswitchb-temp-buflist)
4465 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4466 (defvar org-agenda-tags-todo-honor-ignore-options)
4467 (declare-function org-agenda-skip "org-agenda" ())
4468 (declare-function
4469 org-agenda-format-item "org-agenda"
4470 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4471 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4472 (declare-function org-agenda-change-all-lines "org-agenda"
4473 (newhead hdmarker &optional fixface just-this))
4474 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4475 (declare-function org-agenda-maybe-redo "org-agenda" ())
4476 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4477 (beg end))
4478 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4479 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4480 "org-agenda" (&optional end))
4481 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4482 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4483 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4484 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4485 (declare-function org-indent-mode "org-indent" (&optional arg))
4486 (declare-function parse-time-string "parse-time" (string))
4487 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4488 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4489 (defvar remember-data-file)
4490 (defvar texmathp-why)
4491 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4492 (declare-function table--at-cell-p "table" (position &optional object at-column))
4493 (declare-function calc-eval "calc" (str &optional separator &rest args))
4495 ;;;###autoload
4496 (defun turn-on-orgtbl ()
4497 "Unconditionally turn on `orgtbl-mode'."
4498 (require 'org-table)
4499 (orgtbl-mode 1))
4501 (defun org-at-table-p (&optional table-type)
4502 "Return t if the cursor is inside an org-type table.
4503 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4504 (if org-enable-table-editor
4505 (save-excursion
4506 (beginning-of-line 1)
4507 (looking-at (if table-type org-table-any-line-regexp
4508 org-table-line-regexp)))
4509 nil))
4510 (defsubst org-table-p () (org-at-table-p))
4512 (defun org-at-table.el-p ()
4513 "Return t if and only if we are at a table.el table."
4514 (and (org-at-table-p 'any)
4515 (save-excursion
4516 (goto-char (org-table-begin 'any))
4517 (looking-at org-table1-hline-regexp))))
4519 (defun org-table-recognize-table.el ()
4520 "If there is a table.el table nearby, recognize it and move into it."
4521 (if org-table-tab-recognizes-table.el
4522 (if (org-at-table.el-p)
4523 (progn
4524 (beginning-of-line 1)
4525 (if (looking-at org-table-dataline-regexp)
4527 (if (looking-at org-table1-hline-regexp)
4528 (progn
4529 (beginning-of-line 2)
4530 (if (looking-at org-table-any-border-regexp)
4531 (beginning-of-line -1)))))
4532 (if (re-search-forward "|" (org-table-end t) t)
4533 (progn
4534 (require 'table)
4535 (if (table--at-cell-p (point))
4537 (message "recognizing table.el table...")
4538 (table-recognize-table)
4539 (message "recognizing table.el table...done")))
4540 (error "This should not happen"))
4542 nil)
4543 nil))
4545 (defun org-at-table-hline-p ()
4546 "Return t if the cursor is inside a hline in a table."
4547 (if org-enable-table-editor
4548 (save-excursion
4549 (beginning-of-line 1)
4550 (looking-at org-table-hline-regexp))
4551 nil))
4553 (defun org-table-map-tables (function &optional quietly)
4554 "Apply FUNCTION to the start of all tables in the buffer."
4555 (save-excursion
4556 (save-restriction
4557 (widen)
4558 (goto-char (point-min))
4559 (while (re-search-forward org-table-any-line-regexp nil t)
4560 (unless quietly
4561 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4562 (beginning-of-line 1)
4563 (when (and (looking-at org-table-line-regexp)
4564 ;; Exclude tables in src/example/verbatim/clocktable blocks
4565 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4566 (save-excursion (funcall function))
4567 (or (looking-at org-table-line-regexp)
4568 (forward-char 1)))
4569 (re-search-forward org-table-any-border-regexp nil 1))))
4570 (unless quietly (message "Mapping tables: done")))
4572 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4573 (declare-function org-clock-update-mode-line "org-clock" ())
4574 (declare-function org-resolve-clocks "org-clock"
4575 (&optional also-non-dangling-p prompt last-valid))
4577 (defun org-at-TBLFM-p (&optional pos)
4578 "Non-nil when point (or POS) is in #+TBLFM line."
4579 (save-excursion
4580 (goto-char (or pos (point)))
4581 (beginning-of-line)
4582 (and (eq (org-element-type (org-element-at-point)) 'table)
4583 (looking-at org-TBLFM-regexp))))
4585 (defvar org-clock-start-time)
4586 (defvar org-clock-marker (make-marker)
4587 "Marker recording the last clock-in.")
4588 (defvar org-clock-hd-marker (make-marker)
4589 "Marker recording the last clock-in, but the headline position.")
4590 (defvar org-clock-heading ""
4591 "The heading of the current clock entry.")
4592 (defun org-clock-is-active ()
4593 "Return the buffer where the clock is currently running.
4594 Return nil if no clock is running."
4595 (marker-buffer org-clock-marker))
4597 (defun org-check-running-clock ()
4598 "Check if the current buffer contains the running clock.
4599 If yes, offer to stop it and to save the buffer with the changes."
4600 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4601 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4602 (buffer-name))))
4603 (org-clock-out)
4604 (when (y-or-n-p "Save changed buffer?")
4605 (save-buffer))))
4607 (defun org-clocktable-try-shift (dir n)
4608 "Check if this line starts a clock table, if yes, shift the time block."
4609 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4610 (org-clocktable-shift dir n)))
4612 ;;;###autoload
4613 (defun org-clock-persistence-insinuate ()
4614 "Set up hooks for clock persistence."
4615 (require 'org-clock)
4616 (add-hook 'org-mode-hook 'org-clock-load)
4617 (add-hook 'kill-emacs-hook 'org-clock-save))
4619 (defgroup org-archive nil
4620 "Options concerning archiving in Org-mode."
4621 :tag "Org Archive"
4622 :group 'org-structure)
4624 (defcustom org-archive-location "%s_archive::"
4625 "The location where subtrees should be archived.
4627 The value of this variable is a string, consisting of two parts,
4628 separated by a double-colon. The first part is a filename and
4629 the second part is a headline.
4631 When the filename is omitted, archiving happens in the same file.
4632 %s in the filename will be replaced by the current file
4633 name (without the directory part). Archiving to a different file
4634 is useful to keep archived entries from contributing to the
4635 Org-mode Agenda.
4637 The archived entries will be filed as subtrees of the specified
4638 headline. When the headline is omitted, the subtrees are simply
4639 filed away at the end of the file, as top-level entries. Also in
4640 the heading you can use %s to represent the file name, this can be
4641 useful when using the same archive for a number of different files.
4643 Here are a few examples:
4644 \"%s_archive::\"
4645 If the current file is Projects.org, archive in file
4646 Projects.org_archive, as top-level trees. This is the default.
4648 \"::* Archived Tasks\"
4649 Archive in the current file, under the top-level headline
4650 \"* Archived Tasks\".
4652 \"~/org/archive.org::\"
4653 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4655 \"~/org/archive.org::* From %s\"
4656 Archive in file ~/org/archive.org (absolute path), under headlines
4657 \"From FILENAME\" where file name is the current file name.
4659 \"~/org/datetree.org::datetree/* Finished Tasks\"
4660 The \"datetree/\" string is special, signifying to archive
4661 items to the datetree. Items are placed in either the CLOSED
4662 date of the item, or the current date if there is no CLOSED date.
4663 The heading will be a subentry to the current date. There doesn't
4664 need to be a heading, but there always needs to be a slash after
4665 datetree. For example, to store archived items directly in the
4666 datetree, use \"~/org/datetree.org::datetree/\".
4668 \"basement::** Finished Tasks\"
4669 Archive in file ./basement (relative path), as level 3 trees
4670 below the level 2 heading \"** Finished Tasks\".
4672 You may set this option on a per-file basis by adding to the buffer a
4673 line like
4675 #+ARCHIVE: basement::** Finished Tasks
4677 You may also define it locally for a subtree by setting an ARCHIVE property
4678 in the entry. If such a property is found in an entry, or anywhere up
4679 the hierarchy, it will be used."
4680 :group 'org-archive
4681 :type 'string)
4683 (defcustom org-agenda-skip-archived-trees t
4684 "Non-nil means the agenda will skip any items located in archived trees.
4685 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4686 variable is no longer recommended, you should leave it at the value t.
4687 Instead, use the key `v' to cycle the archives-mode in the agenda."
4688 :group 'org-archive
4689 :group 'org-agenda-skip
4690 :type 'boolean)
4692 (defcustom org-columns-skip-archived-trees t
4693 "Non-nil means ignore archived trees when creating column view."
4694 :group 'org-archive
4695 :group 'org-properties
4696 :type 'boolean)
4698 (defcustom org-cycle-open-archived-trees nil
4699 "Non-nil means `org-cycle' will open archived trees.
4700 An archived tree is a tree marked with the tag ARCHIVE.
4701 When nil, archived trees will stay folded. You can still open them with
4702 normal outline commands like `show-all', but not with the cycling commands."
4703 :group 'org-archive
4704 :group 'org-cycle
4705 :type 'boolean)
4707 (defcustom org-sparse-tree-open-archived-trees nil
4708 "Non-nil means sparse tree construction shows matches in archived trees.
4709 When nil, matches in these trees are highlighted, but the trees are kept in
4710 collapsed state."
4711 :group 'org-archive
4712 :group 'org-sparse-trees
4713 :type 'boolean)
4715 (defcustom org-sparse-tree-default-date-type nil
4716 "The default date type when building a sparse tree.
4717 When this is nil, a date is a scheduled or a deadline timestamp.
4718 Otherwise, these types are allowed:
4720 all: all timestamps
4721 active: only active timestamps (<...>)
4722 inactive: only inactive timestamps ([...])
4723 scheduled: only scheduled timestamps
4724 deadline: only deadline timestamps"
4725 :type '(choice (const :tag "Scheduled or deadline" nil)
4726 (const :tag "All timestamps" all)
4727 (const :tag "Only active timestamps" active)
4728 (const :tag "Only inactive timestamps" inactive)
4729 (const :tag "Only scheduled timestamps" scheduled)
4730 (const :tag "Only deadline timestamps" deadline)
4731 (const :tag "Only closed timestamps" closed))
4732 :version "25.1"
4733 :package-version '(Org . "8.3")
4734 :group 'org-sparse-trees)
4736 (defun org-cycle-hide-archived-subtrees (state)
4737 "Re-hide all archived subtrees after a visibility state change."
4738 (when (and (not org-cycle-open-archived-trees)
4739 (not (memq state '(overview folded))))
4740 (save-excursion
4741 (let* ((globalp (memq state '(contents all)))
4742 (beg (if globalp (point-min) (point)))
4743 (end (if globalp (point-max) (org-end-of-subtree t))))
4744 (org-hide-archived-subtrees beg end)
4745 (goto-char beg)
4746 (if (looking-at (concat ".*:" org-archive-tag ":"))
4747 (message "%s" (substitute-command-keys
4748 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4750 (defun org-force-cycle-archived ()
4751 "Cycle subtree even if it is archived."
4752 (interactive)
4753 (setq this-command 'org-cycle)
4754 (let ((org-cycle-open-archived-trees t))
4755 (call-interactively 'org-cycle)))
4757 (defun org-hide-archived-subtrees (beg end)
4758 "Re-hide all archived subtrees after a visibility state change."
4759 (org-with-wide-buffer
4760 (let ((case-fold-search nil)
4761 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4762 (goto-char beg)
4763 (while (and (< (point) end) (re-search-forward re end t))
4764 (when (member org-archive-tag (org-get-tags))
4765 (org-flag-subtree t)
4766 (org-end-of-subtree t))))))
4768 (declare-function outline-end-of-heading "outline" ())
4769 (declare-function outline-flag-region "outline" (from to flag))
4770 (defun org-flag-subtree (flag)
4771 (save-excursion
4772 (org-back-to-heading t)
4773 (outline-end-of-heading)
4774 (outline-flag-region (point)
4775 (progn (org-end-of-subtree t) (point))
4776 flag)))
4778 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4780 ;; Declare Column View Code
4782 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4783 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4784 (declare-function org-columns-compute "org-colview" (property))
4786 ;; Declare ID code
4788 (declare-function org-id-store-link "org-id")
4789 (declare-function org-id-locations-load "org-id")
4790 (declare-function org-id-locations-save "org-id")
4791 (defvar org-id-track-globally)
4793 ;;; Variables for pre-computed regular expressions, all buffer local
4795 (defvar org-todo-regexp nil
4796 "Matches any of the TODO state keywords.")
4797 (make-variable-buffer-local 'org-todo-regexp)
4798 (defvar org-not-done-regexp nil
4799 "Matches any of the TODO state keywords except the last one.")
4800 (make-variable-buffer-local 'org-not-done-regexp)
4801 (defvar org-not-done-heading-regexp nil
4802 "Matches a TODO headline that is not done.")
4803 (make-variable-buffer-local 'org-not-done-regexp)
4804 (defvar org-todo-line-regexp nil
4805 "Matches a headline and puts TODO state into group 2 if present.")
4806 (make-variable-buffer-local 'org-todo-line-regexp)
4807 (defvar org-complex-heading-regexp nil
4808 "Matches a headline and puts everything into groups:
4809 group 1: the stars
4810 group 2: The todo keyword, maybe
4811 group 3: Priority cookie
4812 group 4: True headline
4813 group 5: Tags")
4814 (make-variable-buffer-local 'org-complex-heading-regexp)
4815 (defvar org-complex-heading-regexp-format nil
4816 "Printf format to make regexp to match an exact headline.
4817 This regexp will match the headline of any node which has the
4818 exact headline text that is put into the format, but may have any
4819 TODO state, priority and tags.")
4820 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4821 (defvar org-todo-line-tags-regexp nil
4822 "Matches a headline and puts TODO state into group 2 if present.
4823 Also put tags into group 4 if tags are present.")
4824 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4826 (defconst org-plain-time-of-day-regexp
4827 (concat
4828 "\\(\\<[012]?[0-9]"
4829 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4830 "\\(--?"
4831 "\\(\\<[012]?[0-9]"
4832 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4833 "\\)?")
4834 "Regular expression to match a plain time or time range.
4835 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4836 groups carry important information:
4837 0 the full match
4838 1 the first time, range or not
4839 8 the second time, if it is a range.")
4841 (defconst org-plain-time-extension-regexp
4842 (concat
4843 "\\(\\<[012]?[0-9]"
4844 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4845 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4846 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4847 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4848 groups carry important information:
4849 0 the full match
4850 7 hours of duration
4851 9 minutes of duration")
4853 (defconst org-stamp-time-of-day-regexp
4854 (concat
4855 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4856 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4857 "\\(--?"
4858 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4859 "Regular expression to match a timestamp time or time range.
4860 After a match, the following groups carry important information:
4861 0 the full match
4862 1 date plus weekday, for back referencing to make sure both times are on the same day
4863 2 the first time, range or not
4864 4 the second time, if it is a range.")
4866 (defconst org-startup-options
4867 '(("fold" org-startup-folded t)
4868 ("overview" org-startup-folded t)
4869 ("nofold" org-startup-folded nil)
4870 ("showall" org-startup-folded nil)
4871 ("showeverything" org-startup-folded showeverything)
4872 ("content" org-startup-folded content)
4873 ("indent" org-startup-indented t)
4874 ("noindent" org-startup-indented nil)
4875 ("hidestars" org-hide-leading-stars t)
4876 ("showstars" org-hide-leading-stars nil)
4877 ("odd" org-odd-levels-only t)
4878 ("oddeven" org-odd-levels-only nil)
4879 ("align" org-startup-align-all-tables t)
4880 ("noalign" org-startup-align-all-tables nil)
4881 ("inlineimages" org-startup-with-inline-images t)
4882 ("noinlineimages" org-startup-with-inline-images nil)
4883 ("latexpreview" org-startup-with-latex-preview t)
4884 ("nolatexpreview" org-startup-with-latex-preview nil)
4885 ("customtime" org-display-custom-times t)
4886 ("logdone" org-log-done time)
4887 ("lognotedone" org-log-done note)
4888 ("nologdone" org-log-done nil)
4889 ("lognoteclock-out" org-log-note-clock-out t)
4890 ("nolognoteclock-out" org-log-note-clock-out nil)
4891 ("logrepeat" org-log-repeat state)
4892 ("lognoterepeat" org-log-repeat note)
4893 ("logdrawer" org-log-into-drawer t)
4894 ("nologdrawer" org-log-into-drawer nil)
4895 ("logstatesreversed" org-log-states-order-reversed t)
4896 ("nologstatesreversed" org-log-states-order-reversed nil)
4897 ("nologrepeat" org-log-repeat nil)
4898 ("logreschedule" org-log-reschedule time)
4899 ("lognotereschedule" org-log-reschedule note)
4900 ("nologreschedule" org-log-reschedule nil)
4901 ("logredeadline" org-log-redeadline time)
4902 ("lognoteredeadline" org-log-redeadline note)
4903 ("nologredeadline" org-log-redeadline nil)
4904 ("logrefile" org-log-refile time)
4905 ("lognoterefile" org-log-refile note)
4906 ("nologrefile" org-log-refile nil)
4907 ("fninline" org-footnote-define-inline t)
4908 ("nofninline" org-footnote-define-inline nil)
4909 ("fnlocal" org-footnote-section nil)
4910 ("fnauto" org-footnote-auto-label t)
4911 ("fnprompt" org-footnote-auto-label nil)
4912 ("fnconfirm" org-footnote-auto-label confirm)
4913 ("fnplain" org-footnote-auto-label plain)
4914 ("fnadjust" org-footnote-auto-adjust t)
4915 ("nofnadjust" org-footnote-auto-adjust nil)
4916 ("constcgs" constants-unit-system cgs)
4917 ("constSI" constants-unit-system SI)
4918 ("noptag" org-tag-persistent-alist nil)
4919 ("hideblocks" org-hide-block-startup t)
4920 ("nohideblocks" org-hide-block-startup nil)
4921 ("beamer" org-startup-with-beamer-mode t)
4922 ("entitiespretty" org-pretty-entities t)
4923 ("entitiesplain" org-pretty-entities nil))
4924 "Variable associated with STARTUP options for org-mode.
4925 Each element is a list of three items: the startup options (as written
4926 in the #+STARTUP line), the corresponding variable, and the value to set
4927 this variable to if the option is found. An optional forth element PUSH
4928 means to push this value onto the list in the variable.")
4930 (defcustom org-group-tags t
4931 "When non-nil (the default), use group tags.
4932 This can be turned on/off through `org-toggle-tags-groups'."
4933 :group 'org-tags
4934 :group 'org-startup
4935 :type 'boolean)
4937 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4939 (defun org-toggle-tags-groups ()
4940 "Toggle support for group tags.
4941 Support for group tags is controlled by the option
4942 `org-group-tags', which is non-nil by default."
4943 (interactive)
4944 (setq org-group-tags (not org-group-tags))
4945 (cond ((and (derived-mode-p 'org-agenda-mode)
4946 org-group-tags)
4947 (org-agenda-redo))
4948 ((derived-mode-p 'org-mode)
4949 (let ((org-inhibit-startup t)) (org-mode))))
4950 (message "Groups tags support has been turned %s"
4951 (if org-group-tags "on" "off")))
4953 (defun org-set-regexps-and-options (&optional tags-only)
4954 "Precompute regular expressions used in the current buffer.
4955 When optional argument TAGS-ONLY is non-nil, only compute tags
4956 related expressions."
4957 (when (derived-mode-p 'org-mode)
4958 (let ((alist (org--setup-collect-keywords
4959 (org-make-options-regexp
4960 (append '("FILETAGS" "TAGS" "SETUPFILE")
4961 (and (not tags-only)
4962 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4963 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4964 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4965 (org--setup-process-tags
4966 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4967 (unless tags-only
4968 ;; File properties.
4969 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4970 ;; Archive location.
4971 (let ((archive (cdr (assq 'archive alist))))
4972 (when archive (org-set-local 'org-archive-location archive)))
4973 ;; Category.
4974 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4975 (when cat
4976 (org-set-local 'org-category (intern cat))
4977 (org-set-local 'org-file-properties
4978 (org--update-property-plist
4979 "CATEGORY" cat org-file-properties))))
4980 ;; Columns.
4981 (let ((column (cdr (assq 'columns alist))))
4982 (when column (org-set-local 'org-columns-default-format column)))
4983 ;; Constants.
4984 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4985 ;; Link abbreviations.
4986 (let ((links (cdr (assq 'link alist))))
4987 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4988 ;; Priorities.
4989 (let ((priorities (cdr (assq 'priorities alist))))
4990 (when priorities
4991 (org-set-local 'org-highest-priority (nth 0 priorities))
4992 (org-set-local 'org-lowest-priority (nth 1 priorities))
4993 (org-set-local 'org-default-priority (nth 2 priorities))))
4994 ;; Scripts.
4995 (let ((scripts (assq 'scripts alist)))
4996 (when scripts
4997 (org-set-local 'org-use-sub-superscripts (cdr scripts))))
4998 ;; Startup options.
4999 (let ((startup (cdr (assq 'startup alist))))
5000 (dolist (option startup)
5001 (let ((entry (assoc-string option org-startup-options t)))
5002 (when entry
5003 (let ((var (nth 1 entry))
5004 (val (nth 2 entry)))
5005 (if (not (nth 3 entry)) (org-set-local var val)
5006 (unless (listp (symbol-value var))
5007 (org-set-local var nil))
5008 (add-to-list var val)))))))
5009 ;; TODO keywords.
5010 (org-set-local 'org-todo-kwd-alist nil)
5011 (org-set-local 'org-todo-key-alist nil)
5012 (org-set-local 'org-todo-key-trigger nil)
5013 (org-set-local 'org-todo-keywords-1 nil)
5014 (org-set-local 'org-done-keywords nil)
5015 (org-set-local 'org-todo-heads nil)
5016 (org-set-local 'org-todo-sets nil)
5017 (org-set-local 'org-todo-log-states nil)
5018 (let ((todo-sequences
5019 (or (nreverse (cdr (assq 'todo alist)))
5020 (let ((d (default-value 'org-todo-keywords)))
5021 (if (not (stringp (car d))) d
5022 ;; XXX: Backward compatibility code.
5023 (list (cons org-todo-interpretation d)))))))
5024 (dolist (sequence todo-sequences)
5025 (let* ((sequence (or (run-hook-with-args-until-success
5026 'org-todo-setup-filter-hook sequence)
5027 sequence))
5028 (sequence-type (car sequence))
5029 (keywords (cdr sequence))
5030 (sep (member "|" keywords))
5031 names alist)
5032 (dolist (k (remove "|" keywords))
5033 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5035 (error "Invalid TODO keyword %s" k))
5036 (let ((name (match-string 1 k))
5037 (key (match-string 2 k))
5038 (log (org-extract-log-state-settings k)))
5039 (push name names)
5040 (push (cons name (and key (string-to-char key))) alist)
5041 (when log (push log org-todo-log-states))))
5042 (let* ((names (nreverse names))
5043 (done (if sep (org-remove-keyword-keys (cdr sep))
5044 (last names)))
5045 (head (car names))
5046 (tail (list sequence-type head (car done) (org-last done))))
5047 (add-to-list 'org-todo-heads head 'append)
5048 (push names org-todo-sets)
5049 (setq org-done-keywords (append org-done-keywords done nil))
5050 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5051 (setq org-todo-key-alist
5052 (append org-todo-key-alist
5053 (and alist
5054 (append '((:startgroup))
5055 (nreverse alist)
5056 '((:endgroup))))))
5057 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5058 (setq org-todo-sets (nreverse org-todo-sets)
5059 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5060 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5061 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5062 ;; Compute the regular expressions and other local variables.
5063 ;; Using `org-outline-regexp-bol' would complicate them much,
5064 ;; because of the fixed white space at the end of that string.
5065 (if (not org-done-keywords)
5066 (setq org-done-keywords
5067 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5068 (setq org-not-done-keywords
5069 (org-delete-all org-done-keywords
5070 (copy-sequence org-todo-keywords-1))
5071 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5072 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5073 org-not-done-heading-regexp
5074 (format org-heading-keyword-regexp-format org-not-done-regexp)
5075 org-todo-line-regexp
5076 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5077 org-complex-heading-regexp
5078 (concat "^\\(\\*+\\)"
5079 "\\(?: +" org-todo-regexp "\\)?"
5080 "\\(?: +\\(\\[#.\\]\\)\\)?"
5081 "\\(?: +\\(.*?\\)\\)??"
5082 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5083 "[ \t]*$")
5084 org-complex-heading-regexp-format
5085 (concat "^\\(\\*+\\)"
5086 "\\(?: +" org-todo-regexp "\\)?"
5087 "\\(?: +\\(\\[#.\\]\\)\\)?"
5088 "\\(?: +"
5089 ;; Stats cookies can be stuck to body.
5090 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5091 "\\(%s\\)"
5092 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5093 "\\)"
5094 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5095 "[ \t]*$")
5096 org-todo-line-tags-regexp
5097 (concat "^\\(\\*+\\)"
5098 "\\(?: +" org-todo-regexp "\\)?"
5099 "\\(?: +\\(.*?\\)\\)??"
5100 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5101 "[ \t]*$"))
5102 (org-compute-latex-and-related-regexp)))))
5104 (defun org--setup-collect-keywords (regexp &optional files alist)
5105 "Return setup keywords values as an alist.
5107 REGEXP matches a subset of setup keywords. FILES is a list of
5108 file names already visited. It is used to avoid circular setup
5109 files. ALIST, when non-nil, is the alist computed so far.
5111 Return value contains the following keys: `archive', `category',
5112 `columns', `constants', `filetags', `link', `priorities',
5113 `property', `scripts', `startup', `tags' and `todo'."
5114 (org-with-wide-buffer
5115 (goto-char (point-min))
5116 (let ((case-fold-search t))
5117 (while (re-search-forward regexp nil t)
5118 (let ((element (org-element-at-point)))
5119 (when (eq (org-element-type element) 'keyword)
5120 (let ((key (org-element-property :key element))
5121 (value (org-element-property :value element)))
5122 (cond
5123 ((equal key "ARCHIVE")
5124 (when (org-string-nw-p value)
5125 (push (cons 'archive value) alist)))
5126 ((equal key "CATEGORY") (push (cons 'category value) alist))
5127 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5128 ((equal key "CONSTANTS")
5129 (let* ((constants (assq 'constants alist))
5130 (store (cdr constants)))
5131 (dolist (pair (org-split-string value))
5132 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5133 pair)
5134 (let* ((name (match-string 1 pair))
5135 (value (match-string 2 pair))
5136 (old (assoc name store)))
5137 (if old (setcdr old value)
5138 (push (cons name value) store)))))
5139 (if constants (setcdr constants store)
5140 (push (cons 'constants store) alist))))
5141 ((equal key "FILETAGS")
5142 (when (org-string-nw-p value)
5143 (let ((old (assq 'filetags alist))
5144 (new (apply #'nconc
5145 (mapcar (lambda (x) (org-split-string x ":"))
5146 (org-split-string value)))))
5147 (if old (setcdr old (append new (cdr old)))
5148 (push (cons 'filetags new) alist)))))
5149 ((equal key "LINK")
5150 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5151 (let ((links (assq 'link alist))
5152 (pair (cons (org-match-string-no-properties 1 value)
5153 (org-match-string-no-properties 2 value))))
5154 (if links (push pair (cdr links))
5155 (push (list 'link pair) alist)))))
5156 ((equal key "OPTIONS")
5157 (when (and (org-string-nw-p value)
5158 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5159 (push (cons 'scripts (read (match-string 1 value))) alist)))
5160 ((equal key "PRIORITIES")
5161 (push (cons 'priorities
5162 (let ((prio (org-split-string value)))
5163 (if (< (length prio) 3) '(?A ?C ?B)
5164 (mapcar #'string-to-char prio))))
5165 alist))
5166 ((equal key "PROPERTY")
5167 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5168 (let* ((property (assq 'property alist))
5169 (value (org--update-property-plist
5170 (org-match-string-no-properties 1 value)
5171 (org-match-string-no-properties 2 value)
5172 (cdr property))))
5173 (if property (setcdr property value)
5174 (push (cons 'property value) alist)))))
5175 ((equal key "STARTUP")
5176 (let ((startup (assq 'startup alist)))
5177 (if startup
5178 (setcdr startup
5179 (append (cdr startup) (org-split-string value)))
5180 (push (cons 'startup (org-split-string value)) alist))))
5181 ((equal key "TAGS")
5182 (let ((tag-cell (assq 'tags alist)))
5183 (if tag-cell
5184 (setcdr tag-cell
5185 (append (cdr tag-cell)
5186 '("\\n")
5187 (org-split-string value)))
5188 (push (cons 'tags (org-split-string value)) alist))))
5189 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5190 (let ((todo (assq 'todo alist))
5191 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5192 (org-split-string value))))
5193 (if todo (push value (cdr todo))
5194 (push (list 'todo value) alist))))
5195 ((equal key "SETUPFILE")
5196 (unless buffer-read-only ; Do not check in Gnus messages.
5197 (let ((f (and (org-string-nw-p value)
5198 (expand-file-name
5199 (org-remove-double-quotes value)))))
5200 (when (and f (file-readable-p f) (not (member f files)))
5201 (with-temp-buffer
5202 (insert-file-contents f)
5203 (setq alist
5204 ;; Fake Org mode to benefit from cache
5205 ;; without recurring needlessly.
5206 (let ((major-mode 'org-mode))
5207 (org--setup-collect-keywords
5208 regexp (cons f files) alist)))))))))))))))
5209 alist)
5211 (defun org--setup-process-tags (tags filetags)
5212 "Precompute variables used for tags.
5213 TAGS is a list of tags and tag group symbols, as strings.
5214 FILETAGS is a list of tags, as strings."
5215 ;; Process the file tags.
5216 (org-set-local 'org-file-tags
5217 (mapcar #'org-add-prop-inherited filetags))
5218 ;; Provide default tags if no local tags are found.
5219 (when (and (not tags) org-tag-alist)
5220 (setq tags
5221 (mapcar (lambda (tag)
5222 (case (car tag)
5223 (:startgroup "{")
5224 (:endgroup "}")
5225 (:startgrouptag "[")
5226 (:endgrouptag "]")
5227 (:grouptags ":")
5228 (:newline "\\n")
5229 (otherwise (concat (car tag)
5230 (and (characterp (cdr tag))
5231 (format "(%c)" (cdr tag)))))))
5232 org-tag-alist)))
5233 ;; Process the tags.
5234 (org-set-local 'org-tag-groups-alist nil)
5235 (org-set-local 'org-tag-alist nil)
5236 (let (group-flag)
5237 (while tags
5238 (let ((e (car tags)))
5239 (setq tags (cdr tags))
5240 (cond
5241 ((equal e "{")
5242 (push '(:startgroup) org-tag-alist)
5243 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5244 ((equal e "}")
5245 (push '(:endgroup) org-tag-alist)
5246 (setq group-flag nil))
5247 ((equal e "[")
5248 (push '(:startgrouptag) org-tag-alist)
5249 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5250 ((equal e "]")
5251 (push '(:endgrouptag) org-tag-alist)
5252 (setq group-flag nil))
5253 ((equal e ":")
5254 (push '(:grouptags) org-tag-alist)
5255 (setq group-flag 'append))
5256 ((equal e "\\n") (push '(:newline) org-tag-alist))
5257 ((string-match
5258 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5259 "\\|{.+?}\\)" ; regular expression
5260 "\\(?:(\\(.\\))\\)?\\'")) e)
5261 (let ((tag (match-string 1 e))
5262 (key (and (match-beginning 2)
5263 (string-to-char (match-string 2 e)))))
5264 (cond ((eq group-flag 'append)
5265 (setcar org-tag-groups-alist
5266 (append (car org-tag-groups-alist) (list tag))))
5267 (group-flag (push (list tag) org-tag-groups-alist)))
5268 ;; Push all tags in groups, no matter if they already exist.
5269 (unless (and (not group-flag) (assoc tag org-tag-alist))
5270 (push (cons tag key) org-tag-alist))))))))
5271 (setq org-tag-alist (nreverse org-tag-alist)))
5273 (defun org-file-contents (file &optional noerror)
5274 "Return the contents of FILE, as a string."
5275 (if (and file (file-readable-p file))
5276 (with-temp-buffer
5277 (insert-file-contents file)
5278 (buffer-string))
5279 (funcall (if noerror 'message 'error)
5280 "Cannot read file \"%s\"%s"
5281 file
5282 (let ((from (buffer-file-name (buffer-base-buffer))))
5283 (if from (concat " (referenced in file \"" from "\")") "")))))
5285 (defun org-extract-log-state-settings (x)
5286 "Extract the log state setting from a TODO keyword string.
5287 This will extract info from a string like \"WAIT(w@/!)\"."
5288 (let (kw key log1 log2)
5289 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5290 (setq kw (match-string 1 x)
5291 key (and (match-end 2) (match-string 2 x))
5292 log1 (and (match-end 3) (match-string 3 x))
5293 log2 (and (match-end 4) (match-string 4 x)))
5294 (and (or log1 log2)
5295 (list kw
5296 (and log1 (if (equal log1 "!") 'time 'note))
5297 (and log2 (if (equal log2 "!") 'time 'note)))))))
5299 (defun org-remove-keyword-keys (list)
5300 "Remove a pair of parenthesis at the end of each string in LIST."
5301 (mapcar (lambda (x)
5302 (if (string-match "(.*)$" x)
5303 (substring x 0 (match-beginning 0))
5305 list))
5307 (defun org-assign-fast-keys (alist)
5308 "Assign fast keys to a keyword-key alist.
5309 Respect keys that are already there."
5310 (let (new e (alt ?0))
5311 (while (setq e (pop alist))
5312 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5313 (cdr e)) ;; Key already assigned.
5314 (push e new)
5315 (let ((clist (string-to-list (downcase (car e))))
5316 (used (append new alist)))
5317 (when (= (car clist) ?@)
5318 (pop clist))
5319 (while (and clist (rassoc (car clist) used))
5320 (pop clist))
5321 (unless clist
5322 (while (rassoc alt used)
5323 (incf alt)))
5324 (push (cons (car e) (or (car clist) alt)) new))))
5325 (nreverse new)))
5327 ;;; Some variables used in various places
5329 (defvar org-window-configuration nil
5330 "Used in various places to store a window configuration.")
5331 (defvar org-selected-window nil
5332 "Used in various places to store a window configuration.")
5333 (defvar org-finish-function nil
5334 "Function to be called when `C-c C-c' is used.
5335 This is for getting out of special buffers like capture.")
5338 ;; FIXME: Occasionally check by commenting these, to make sure
5339 ;; no other functions uses these, forgetting to let-bind them.
5340 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5341 (defvar org-last-state)
5342 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5344 ;; Defined somewhere in this file, but used before definition.
5345 (defvar org-entities) ;; defined in org-entities.el
5346 (defvar org-struct-menu)
5347 (defvar org-org-menu)
5348 (defvar org-tbl-menu)
5350 ;;;; Define the Org-mode
5352 ;; We use a before-change function to check if a table might need
5353 ;; an update.
5354 (defvar org-table-may-need-update t
5355 "Indicates that a table might need an update.
5356 This variable is set by `org-before-change-function'.
5357 `org-table-align' sets it back to nil.")
5358 (defun org-before-change-function (beg end)
5359 "Every change indicates that a table might need an update."
5360 (setq org-table-may-need-update t))
5361 (defvar org-mode-map)
5362 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5363 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5364 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5365 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5366 (defvar org-table-buffer-is-an nil)
5368 (defvar bidi-paragraph-direction)
5369 (defvar buffer-face-mode-face)
5371 (require 'outline)
5372 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5373 (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"))
5374 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5376 ;; Other stuff we need.
5377 (require 'time-date)
5378 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5379 (require 'easymenu)
5380 (require 'overlay)
5382 ;; (require 'org-macs) moved higher up in the file before it is first used
5383 (require 'org-entities)
5384 ;; (require 'org-compat) moved higher up in the file before it is first used
5385 (require 'org-faces)
5386 (require 'org-list)
5387 (require 'org-pcomplete)
5388 (require 'org-src)
5389 (require 'org-footnote)
5390 (require 'org-macro)
5392 ;; babel
5393 (require 'ob)
5395 ;;;###autoload
5396 (define-derived-mode org-mode outline-mode "Org"
5397 "Outline-based notes management and organizer, alias
5398 \"Carsten's outline-mode for keeping track of everything.\"
5400 Org-mode develops organizational tasks around a NOTES file which
5401 contains information about projects as plain text. Org-mode is
5402 implemented on top of outline-mode, which is ideal to keep the content
5403 of large files well structured. It supports ToDo items, deadlines and
5404 time stamps, which magically appear in the diary listing of the Emacs
5405 calendar. Tables are easily created with a built-in table editor.
5406 Plain text URL-like links connect to websites, emails (VM), Usenet
5407 messages (Gnus), BBDB entries, and any files related to the project.
5408 For printing and sharing of notes, an Org-mode file (or a part of it)
5409 can be exported as a structured ASCII or HTML file.
5411 The following commands are available:
5413 \\{org-mode-map}"
5415 ;; Get rid of Outline menus, they are not needed
5416 ;; Need to do this here because define-derived-mode sets up
5417 ;; the keymap so late. Still, it is a waste to call this each time
5418 ;; we switch another buffer into org-mode.
5419 (if (featurep 'xemacs)
5420 (when (boundp 'outline-mode-menu-heading)
5421 ;; Assume this is Greg's port, it uses easymenu
5422 (easy-menu-remove outline-mode-menu-heading)
5423 (easy-menu-remove outline-mode-menu-show)
5424 (easy-menu-remove outline-mode-menu-hide))
5425 (define-key org-mode-map [menu-bar headings] 'undefined)
5426 (define-key org-mode-map [menu-bar hide] 'undefined)
5427 (define-key org-mode-map [menu-bar show] 'undefined))
5429 (org-load-modules-maybe)
5430 (easy-menu-add org-org-menu)
5431 (easy-menu-add org-tbl-menu)
5432 (org-install-agenda-files-menu)
5433 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5434 (add-to-invisibility-spec '(org-cwidth))
5435 (add-to-invisibility-spec '(org-hide-block . t))
5436 (when (featurep 'xemacs)
5437 (org-set-local 'line-move-ignore-invisible t))
5438 (org-set-local 'outline-regexp org-outline-regexp)
5439 (org-set-local 'outline-level 'org-outline-level)
5440 (setq bidi-paragraph-direction 'left-to-right)
5441 (when (and org-ellipsis
5442 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5443 (fboundp 'make-glyph-code))
5444 (unless org-display-table
5445 (setq org-display-table (make-display-table)))
5446 (set-display-table-slot
5447 org-display-table 4
5448 (vconcat (mapcar
5449 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5450 org-ellipsis)))
5451 (if (stringp org-ellipsis) org-ellipsis "..."))))
5452 (setq buffer-display-table org-display-table))
5453 (org-set-regexps-and-options)
5454 (org-set-font-lock-defaults)
5455 (when (and org-tag-faces (not org-tags-special-faces-re))
5456 ;; tag faces set outside customize.... force initialization.
5457 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5458 ;; Calc embedded
5459 (org-set-local 'calc-embedded-open-mode "# ")
5460 ;; Modify a few syntax entries
5461 (modify-syntax-entry ?@ "w")
5462 (modify-syntax-entry ?\" "\"")
5463 (modify-syntax-entry ?\\ "_")
5464 (modify-syntax-entry ?~ "_")
5465 (if org-startup-truncated (setq truncate-lines t))
5466 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5467 (org-set-local 'font-lock-unfontify-region-function
5468 'org-unfontify-region)
5469 ;; Activate before-change-function
5470 (org-set-local 'org-table-may-need-update t)
5471 (org-add-hook 'before-change-functions 'org-before-change-function nil
5472 'local)
5473 ;; Check for running clock before killing a buffer
5474 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5475 ;; Initialize macros templates.
5476 (org-macro-initialize-templates)
5477 ;; Initialize radio targets.
5478 (org-update-radio-target-regexp)
5479 ;; Indentation.
5480 (org-set-local 'indent-line-function 'org-indent-line)
5481 (org-set-local 'indent-region-function 'org-indent-region)
5482 ;; Filling and auto-filling.
5483 (org-setup-filling)
5484 ;; Comments.
5485 (org-setup-comments-handling)
5486 ;; Initialize cache.
5487 (org-element-cache-reset)
5488 ;; Beginning/end of defun
5489 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5490 (org-set-local 'end-of-defun-function
5491 (lambda ()
5492 (if (not (org-at-heading-p))
5493 (org-forward-element)
5494 (org-forward-element)
5495 (forward-char -1))))
5496 ;; Next error for sparse trees
5497 (org-set-local 'next-error-function 'org-occur-next-match)
5498 ;; Make sure dependence stuff works reliably, even for users who set it
5499 ;; too late :-(
5500 (if org-enforce-todo-dependencies
5501 (add-hook 'org-blocker-hook
5502 'org-block-todo-from-children-or-siblings-or-parent)
5503 (remove-hook 'org-blocker-hook
5504 'org-block-todo-from-children-or-siblings-or-parent))
5505 (if org-enforce-todo-checkbox-dependencies
5506 (add-hook 'org-blocker-hook
5507 'org-block-todo-from-checkboxes)
5508 (remove-hook 'org-blocker-hook
5509 'org-block-todo-from-checkboxes))
5511 ;; Align options lines
5512 (org-set-local
5513 'align-mode-rules-list
5514 '((org-in-buffer-settings
5515 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5516 (modes . '(org-mode)))))
5518 ;; Imenu
5519 (org-set-local 'imenu-create-index-function
5520 'org-imenu-get-tree)
5522 ;; Make isearch reveal context
5523 (if (or (featurep 'xemacs)
5524 (not (boundp 'outline-isearch-open-invisible-function)))
5525 ;; Emacs 21 and XEmacs make use of the hook
5526 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5527 ;; Emacs 22 deals with this through a special variable
5528 (org-set-local 'outline-isearch-open-invisible-function
5529 (lambda (&rest ignore) (org-show-context 'isearch))))
5531 ;; Setup the pcomplete hooks
5532 (set (make-local-variable 'pcomplete-command-completion-function)
5533 'org-pcomplete-initial)
5534 (set (make-local-variable 'pcomplete-command-name-function)
5535 'org-command-at-point)
5536 (set (make-local-variable 'pcomplete-default-completion-function)
5537 'ignore)
5538 (set (make-local-variable 'pcomplete-parse-arguments-function)
5539 'org-parse-arguments)
5540 (set (make-local-variable 'pcomplete-termination-string) "")
5541 (when (>= emacs-major-version 23)
5542 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5544 ;; If empty file that did not turn on org-mode automatically, make it to.
5545 (if (and org-insert-mode-line-in-empty-file
5546 (org-called-interactively-p 'any)
5547 (= (point-min) (point-max)))
5548 (insert "# -*- mode: org -*-\n\n"))
5549 (unless org-inhibit-startup
5550 (org-unmodified
5551 (and org-startup-with-beamer-mode (org-beamer-mode))
5552 (when org-startup-align-all-tables
5553 (org-table-map-tables 'org-table-align 'quietly))
5554 (when org-startup-with-inline-images
5555 (org-display-inline-images))
5556 (when org-startup-with-latex-preview
5557 (org-toggle-latex-fragment))
5558 (unless org-inhibit-startup-visibility-stuff
5559 (org-set-startup-visibility))
5560 (org-refresh-effort-properties)))
5561 ;; Try to set org-hide correctly
5562 (let ((foreground (org-find-invisible-foreground)))
5563 (if foreground
5564 (set-face-foreground 'org-hide foreground))))
5566 ;; Update `customize-package-emacs-version-alist'
5567 (add-to-list 'customize-package-emacs-version-alist
5568 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5569 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5570 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5572 (defvar org-mode-transpose-word-syntax-table
5573 (let ((st (make-syntax-table text-mode-syntax-table)))
5574 (mapc (lambda(c) (modify-syntax-entry
5575 (string-to-char (car c)) "w p" st))
5576 org-emphasis-alist)
5577 st))
5579 (when (fboundp 'abbrev-table-put)
5580 (abbrev-table-put org-mode-abbrev-table
5581 :parents (list text-mode-abbrev-table)))
5583 (defun org-find-invisible-foreground ()
5584 (let ((candidates (remove
5585 "unspecified-bg"
5586 (nconc
5587 (list (face-background 'default)
5588 (face-background 'org-default))
5589 (mapcar
5590 (lambda (alist)
5591 (when (boundp alist)
5592 (cdr (assoc 'background-color (symbol-value alist)))))
5593 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5594 (list (face-foreground 'org-hide))))))
5595 (car (remove nil candidates))))
5597 (defun org-current-time (&optional rounding-minutes past)
5598 "Current time, possibly rounded to ROUNDING-MINUTES.
5599 When ROUNDING-MINUTES is not an integer, fall back on the car of
5600 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5601 the rounding returns a past time."
5602 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5603 (car org-time-stamp-rounding-minutes)))
5604 (time (decode-time)) res)
5605 (if (< r 1)
5606 (current-time)
5607 (setq res
5608 (apply 'encode-time
5609 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5610 (nthcdr 2 time))))
5611 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5612 (seconds-to-time (- (org-float-time res) (* r 60)))
5613 res))))
5615 (defun org-today ()
5616 "Return today date, considering `org-extend-today-until'."
5617 (time-to-days
5618 (time-subtract (current-time)
5619 (list 0 (* 3600 org-extend-today-until) 0))))
5621 ;;;; Font-Lock stuff, including the activators
5623 (defvar org-mouse-map (make-sparse-keymap))
5624 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5625 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5626 (when org-mouse-1-follows-link
5627 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5628 (when org-tab-follows-link
5629 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5630 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5632 (require 'font-lock)
5634 (defconst org-non-link-chars "]\t\n\r<>")
5635 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5636 "file+sys" "news" "shell" "elisp" "doi" "message"
5637 "help"))
5638 (defvar org-link-types-re nil
5639 "Matches a link that has a url-like prefix like \"http:\"")
5640 (defvar org-link-re-with-space nil
5641 "Matches a link with spaces, optional angular brackets around it.")
5642 (defvar org-link-re-with-space2 nil
5643 "Matches a link with spaces, optional angular brackets around it.")
5644 (defvar org-link-re-with-space3 nil
5645 "Matches a link with spaces, only for internal part in bracket links.")
5646 (defvar org-angle-link-re nil
5647 "Matches link with angular brackets, spaces are allowed.")
5648 (defvar org-plain-link-re nil
5649 "Matches plain link, without spaces.")
5650 (defvar org-bracket-link-regexp nil
5651 "Matches a link in double brackets.")
5652 (defvar org-bracket-link-analytic-regexp nil
5653 "Regular expression used to analyze links.
5654 Here is what the match groups contain after a match:
5655 1: http:
5656 2: http
5657 3: path
5658 4: [desc]
5659 5: desc")
5660 (defvar org-bracket-link-analytic-regexp++ nil
5661 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5662 (defvar org-any-link-re nil
5663 "Regular expression matching any link.")
5665 (defconst org-match-sexp-depth 3
5666 "Number of stacked braces for sub/superscript matching.")
5668 (defun org-create-multibrace-regexp (left right n)
5669 "Create a regular expression which will match a balanced sexp.
5670 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5671 as single character strings.
5672 The regexp returned will match the entire expression including the
5673 delimiters. It will also define a single group which contains the
5674 match except for the outermost delimiters. The maximum depth of
5675 stacked delimiters is N. Escaping delimiters is not possible."
5676 (let* ((nothing (concat "[^" left right "]*?"))
5677 (or "\\|")
5678 (re nothing)
5679 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5680 (while (> n 1)
5681 (setq n (1- n)
5682 re (concat re or next)
5683 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5684 (concat left "\\(" re "\\)" right)))
5686 (defconst org-match-substring-regexp
5687 (concat
5688 "\\(\\S-\\)\\([_^]\\)\\("
5689 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5690 "\\|"
5691 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5692 "\\|"
5693 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5694 "The regular expression matching a sub- or superscript.")
5696 (defconst org-match-substring-with-braces-regexp
5697 (concat
5698 "\\(\\S-\\)\\([_^]\\)"
5699 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5700 "The regular expression matching a sub- or superscript, forcing braces.")
5702 (defun org-make-link-regexps ()
5703 "Update the link regular expressions.
5704 This should be called after the variable `org-link-types' has changed."
5705 (let ((types-re (regexp-opt org-link-types t)))
5706 (setq org-link-types-re
5707 (concat "\\`" types-re ":")
5708 org-link-re-with-space
5709 (concat "<?" types-re ":"
5710 "\\([^" org-non-link-chars " ]"
5711 "[^" org-non-link-chars "]*"
5712 "[^" org-non-link-chars " ]\\)>?")
5713 org-link-re-with-space2
5714 (concat "<?" types-re ":"
5715 "\\([^" org-non-link-chars " ]"
5716 "[^\t\n\r]*"
5717 "[^" org-non-link-chars " ]\\)>?")
5718 org-link-re-with-space3
5719 (concat "<?" types-re ":"
5720 "\\([^" org-non-link-chars " ]"
5721 "[^\t\n\r]*\\)")
5722 org-angle-link-re
5723 (concat "<" types-re ":"
5724 "\\([^" org-non-link-chars " ]"
5725 "[^" org-non-link-chars "]*"
5726 "\\)>")
5727 org-plain-link-re
5728 (concat
5729 "\\<" types-re ":"
5730 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5731 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5732 org-bracket-link-regexp
5733 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5734 org-bracket-link-analytic-regexp
5735 (concat
5736 "\\[\\["
5737 "\\(" types-re ":\\)?"
5738 "\\([^]]+\\)"
5739 "\\]"
5740 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5741 "\\]")
5742 org-bracket-link-analytic-regexp++
5743 (concat
5744 "\\[\\["
5745 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5746 "\\([^]]+\\)"
5747 "\\]"
5748 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5749 "\\]")
5750 org-any-link-re
5751 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5752 org-angle-link-re "\\)\\|\\("
5753 org-plain-link-re "\\)"))))
5755 (org-make-link-regexps)
5757 (defvar org-emph-face nil)
5759 (defun org-do-emphasis-faces (limit)
5760 "Run through the buffer and emphasize strings."
5761 (let (rtn a)
5762 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5763 (let* ((border (char-after (match-beginning 3)))
5764 (bre (regexp-quote (char-to-string border))))
5765 (if (and (not (= border (char-after (match-beginning 4))))
5766 (not (save-match-data
5767 (string-match (concat bre ".*" bre)
5768 (replace-regexp-in-string
5769 "\n" " "
5770 (substring (match-string 2) 1 -1))))))
5771 (progn
5772 (setq rtn t)
5773 (setq a (assoc (match-string 3) org-emphasis-alist))
5774 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5775 'face
5776 (nth 1 a))
5777 (and (nth 2 a)
5778 (org-remove-flyspell-overlays-in
5779 (match-beginning 0) (match-end 0)))
5780 (add-text-properties (match-beginning 2) (match-end 2)
5781 '(font-lock-multiline t org-emphasis t))
5782 (when org-hide-emphasis-markers
5783 (add-text-properties (match-end 4) (match-beginning 5)
5784 '(invisible org-link))
5785 (add-text-properties (match-beginning 3) (match-end 3)
5786 '(invisible org-link))))))
5787 (goto-char (1+ (match-beginning 0))))
5788 rtn))
5790 (defun org-emphasize (&optional char)
5791 "Insert or change an emphasis, i.e. a font like bold or italic.
5792 If there is an active region, change that region to a new emphasis.
5793 If there is no region, just insert the marker characters and position
5794 the cursor between them.
5795 CHAR should be the marker character. If it is a space, it means to
5796 remove the emphasis of the selected region.
5797 If CHAR is not given (for example in an interactive call) it will be
5798 prompted for."
5799 (interactive)
5800 (let ((erc org-emphasis-regexp-components)
5801 (prompt "")
5802 (string "") beg end move c s)
5803 (if (org-region-active-p)
5804 (setq beg (region-beginning) end (region-end)
5805 string (buffer-substring beg end))
5806 (setq move t))
5808 (unless char
5809 (message "Emphasis marker or tag: [%s]"
5810 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5811 (setq char (read-char-exclusive)))
5812 (if (equal char ?\ )
5813 (setq s "" move nil)
5814 (unless (assoc (char-to-string char) org-emphasis-alist)
5815 (user-error "No such emphasis marker: \"%c\"" char))
5816 (setq s (char-to-string char)))
5817 (while (and (> (length string) 1)
5818 (equal (substring string 0 1) (substring string -1))
5819 (assoc (substring string 0 1) org-emphasis-alist))
5820 (setq string (substring string 1 -1)))
5821 (setq string (concat s string s))
5822 (if beg (delete-region beg end))
5823 (unless (or (bolp)
5824 (string-match (concat "[" (nth 0 erc) "\n]")
5825 (char-to-string (char-before (point)))))
5826 (insert " "))
5827 (unless (or (eobp)
5828 (string-match (concat "[" (nth 1 erc) "\n]")
5829 (char-to-string (char-after (point)))))
5830 (insert " ") (backward-char 1))
5831 (insert string)
5832 (and move (backward-char 1))))
5834 (defconst org-nonsticky-props
5835 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5837 (defsubst org-rear-nonsticky-at (pos)
5838 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5840 (defun org-activate-plain-links (limit)
5841 "Add link properties for plain links."
5842 (let (f hl)
5843 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5844 (not (member 'org-tag
5845 (get-text-property (1- (match-beginning 0)) 'face)))
5846 (not (org-in-src-block-p)))
5847 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5848 (setq f (get-text-property (match-beginning 0) 'face))
5849 (setq hl (org-match-string-no-properties 0))
5850 (if (or (eq f 'org-tag)
5851 (and (listp f) (memq 'org-tag f)))
5853 (add-text-properties (match-beginning 0) (match-end 0)
5854 (list 'mouse-face 'highlight
5855 'face 'org-link
5856 'htmlize-link `(:uri ,hl)
5857 'keymap org-mouse-map))
5858 (org-rear-nonsticky-at (match-end 0)))
5859 t)))
5861 (defun org-activate-code (limit)
5862 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5863 (progn
5864 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5865 (remove-text-properties (match-beginning 0) (match-end 0)
5866 '(display t invisible t intangible t))
5867 t)))
5869 (defcustom org-src-fontify-natively t
5870 "When non-nil, fontify code in code blocks."
5871 :type 'boolean
5872 :version "24.4"
5873 :package-version '(Org . "8.3")
5874 :group 'org-appearance
5875 :group 'org-babel)
5877 (defcustom org-allow-promoting-top-level-subtree nil
5878 "When non-nil, allow promoting a top level subtree.
5879 The leading star of the top level headline will be replaced
5880 by a #."
5881 :type 'boolean
5882 :version "24.1"
5883 :group 'org-appearance)
5885 (defun org-fontify-meta-lines-and-blocks (limit)
5886 (condition-case nil
5887 (org-fontify-meta-lines-and-blocks-1 limit)
5888 (error (message "org-mode fontification error"))))
5890 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5891 "Fontify #+ lines and blocks."
5892 (let ((case-fold-search t))
5893 (if (re-search-forward
5894 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5895 limit t)
5896 (let ((beg (match-beginning 0))
5897 (block-start (match-end 0))
5898 (block-end nil)
5899 (lang (match-string 7))
5900 (beg1 (line-beginning-position 2))
5901 (dc1 (downcase (match-string 2)))
5902 (dc3 (downcase (match-string 3)))
5903 end end1 quoting block-type ovl)
5904 (cond
5905 ((and (match-end 4) (equal dc3 "+begin"))
5906 ;; Truly a block
5907 (setq block-type (downcase (match-string 5))
5908 quoting (member block-type org-protecting-blocks))
5909 (when (re-search-forward
5910 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5911 nil t) ;; on purpose, we look further than LIMIT
5912 (setq end (min (point-max) (match-end 0))
5913 end1 (min (point-max) (1- (match-beginning 0))))
5914 (setq block-end (match-beginning 0))
5915 (when quoting
5916 (org-remove-flyspell-overlays-in beg1 end1)
5917 (remove-text-properties beg end
5918 '(display t invisible t intangible t)))
5919 (add-text-properties
5920 beg end '(font-lock-fontified t font-lock-multiline t))
5921 (add-text-properties beg beg1 '(face org-meta-line))
5922 (org-remove-flyspell-overlays-in beg beg1)
5923 (add-text-properties ; For end_src
5924 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5925 (org-remove-flyspell-overlays-in end1 end)
5926 (cond
5927 ((and lang (not (string= lang "")) org-src-fontify-natively)
5928 (org-src-font-lock-fontify-block lang block-start block-end)
5929 (add-text-properties beg1 block-end '(src-block t)))
5930 (quoting
5931 (add-text-properties beg1 (min (point-max) (1+ end1))
5932 '(face org-block))) ; end of source block
5933 ((not org-fontify-quote-and-verse-blocks))
5934 ((string= block-type "quote")
5935 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5936 ((string= block-type "verse")
5937 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5938 (add-text-properties beg beg1 '(face org-block-begin-line))
5939 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5940 '(face org-block-end-line))
5942 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5943 (org-remove-flyspell-overlays-in
5944 (match-beginning 0)
5945 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5946 (add-text-properties
5947 beg (match-end 3)
5948 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5949 '(font-lock-fontified t invisible t)
5950 '(font-lock-fontified t face org-document-info-keyword)))
5951 (add-text-properties
5952 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5953 (if (string-equal dc1 "+title:")
5954 '(font-lock-fontified t face org-document-title)
5955 '(font-lock-fontified t face org-document-info))))
5956 ((equal dc1 "+caption:")
5957 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5958 (remove-text-properties (match-beginning 0) (match-end 0)
5959 '(display t invisible t intangible t))
5960 (add-text-properties (match-beginning 1) (match-end 3)
5961 '(font-lock-fontified t face org-meta-line))
5962 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5963 '(font-lock-fontified t face org-block))
5965 ((member dc3 '(" " ""))
5966 (org-remove-flyspell-overlays-in beg (match-end 0))
5967 (add-text-properties
5968 beg (match-end 0)
5969 '(font-lock-fontified t face font-lock-comment-face)))
5970 (t ;; just any other in-buffer setting, but not indented
5971 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5972 (remove-text-properties (match-beginning 0) (match-end 0)
5973 '(display t invisible t intangible t))
5974 (add-text-properties beg (match-end 0)
5975 '(font-lock-fontified t face org-meta-line))
5976 t))))))
5978 (defun org-fontify-drawers (limit)
5979 "Fontify drawers."
5980 (when (re-search-forward org-drawer-regexp limit t)
5981 (add-text-properties
5982 (match-beginning 0) (match-end 0)
5983 '(font-lock-fontified t face org-special-keyword))
5984 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5987 (defun org-fontify-macros (limit)
5988 "Fontify macros."
5989 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5990 (add-text-properties
5991 (match-beginning 0) (match-end 0)
5992 '(font-lock-fontified t face org-macro))
5993 (when org-hide-macro-markers
5994 (add-text-properties (match-end 2) (match-beginning 2)
5995 '(invisible t))
5996 (add-text-properties (match-beginning 1) (match-end 1)
5997 '(invisible t)))
5998 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6001 (defun org-activate-angle-links (limit)
6002 "Add text properties for angle links."
6003 (if (and (re-search-forward org-angle-link-re limit t)
6004 (not (org-in-src-block-p)))
6005 (progn
6006 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6007 (add-text-properties (match-beginning 0) (match-end 0)
6008 (list 'mouse-face 'highlight
6009 'keymap org-mouse-map))
6010 (org-rear-nonsticky-at (match-end 0))
6011 t)))
6013 (defun org-activate-footnote-links (limit)
6014 "Add text properties for footnotes."
6015 (let ((fn (org-footnote-next-reference-or-definition limit)))
6016 (when fn
6017 (let* ((beg (nth 1 fn))
6018 (end (nth 2 fn))
6019 (label (car fn))
6020 (referencep (/= (line-beginning-position) beg)))
6021 (when (and referencep (nth 3 fn))
6022 (save-excursion
6023 (goto-char beg)
6024 (search-forward (or label "fn:"))
6025 (org-remove-flyspell-overlays-in beg (match-end 0))))
6026 (add-text-properties beg end
6027 (list 'mouse-face 'highlight
6028 'keymap org-mouse-map
6029 'help-echo
6030 (if referencep "Footnote reference"
6031 "Footnote definition")
6032 'font-lock-fontified t
6033 'font-lock-multiline t
6034 'face 'org-footnote))))))
6036 (defun org-activate-bracket-links (limit)
6037 "Add text properties for bracketed links."
6038 (if (and (re-search-forward org-bracket-link-regexp limit t)
6039 (not (org-in-src-block-p)))
6040 (let* ((hl (org-match-string-no-properties 1))
6041 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6042 (ip (org-maybe-intangible
6043 (list 'invisible 'org-link
6044 'keymap org-mouse-map 'mouse-face 'highlight
6045 'font-lock-multiline t 'help-echo help
6046 'htmlize-link `(:uri ,hl))))
6047 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6048 'font-lock-multiline t 'help-echo help
6049 'htmlize-link `(:uri ,hl))))
6050 ;; We need to remove the invisible property here. Table narrowing
6051 ;; may have made some of this invisible.
6052 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6053 (remove-text-properties (match-beginning 0) (match-end 0)
6054 '(invisible nil))
6055 (if (match-end 3)
6056 (progn
6057 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6058 (org-rear-nonsticky-at (match-beginning 3))
6059 (add-text-properties (match-beginning 3) (match-end 3) vp)
6060 (org-rear-nonsticky-at (match-end 3))
6061 (add-text-properties (match-end 3) (match-end 0) ip)
6062 (org-rear-nonsticky-at (match-end 0)))
6063 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6064 (org-rear-nonsticky-at (match-beginning 1))
6065 (add-text-properties (match-beginning 1) (match-end 1) vp)
6066 (org-rear-nonsticky-at (match-end 1))
6067 (add-text-properties (match-end 1) (match-end 0) ip)
6068 (org-rear-nonsticky-at (match-end 0)))
6069 t)))
6071 (defun org-activate-dates (limit)
6072 "Add text properties for dates."
6073 (if (and (re-search-forward org-tsr-regexp-both limit t)
6074 (not (equal (char-before (match-beginning 0)) 91)))
6075 (progn
6076 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6077 (add-text-properties (match-beginning 0) (match-end 0)
6078 (list 'mouse-face 'highlight
6079 'keymap org-mouse-map))
6080 (org-rear-nonsticky-at (match-end 0))
6081 (when org-display-custom-times
6082 (if (match-end 3)
6083 (org-display-custom-time (match-beginning 3) (match-end 3)))
6084 (org-display-custom-time (match-beginning 1) (match-end 1)))
6085 t)))
6087 (defvar org-target-link-regexp nil
6088 "Regular expression matching radio targets in plain text.")
6089 (make-variable-buffer-local 'org-target-link-regexp)
6091 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6092 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6093 border border border))
6094 "Regular expression matching a link target.")
6096 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6097 "Regular expression matching a radio target.")
6099 (defconst org-any-target-regexp
6100 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6101 "Regular expression matching any target.")
6103 (defun org-activate-target-links (limit)
6104 "Add text properties for target matches."
6105 (when org-target-link-regexp
6106 (let ((case-fold-search t))
6107 (if (re-search-forward org-target-link-regexp limit t)
6108 (progn
6109 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6110 (add-text-properties (match-beginning 1) (match-end 1)
6111 (list 'mouse-face 'highlight
6112 'keymap org-mouse-map
6113 'help-echo "Radio target link"
6114 'org-linked-text t))
6115 (org-rear-nonsticky-at (match-end 1))
6116 t)))))
6118 (defun org-update-radio-target-regexp ()
6119 "Find all radio targets in this file and update the regular expression.
6120 Also refresh fontification if needed."
6121 (interactive)
6122 (let ((old-regexp org-target-link-regexp)
6123 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6124 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6125 (targets
6126 (org-with-wide-buffer
6127 (goto-char (point-min))
6128 (let (rtn)
6129 (while (re-search-forward org-radio-target-regexp nil t)
6130 ;; Make sure point is really within the object.
6131 (backward-char)
6132 (let ((obj (org-element-context)))
6133 (when (eq (org-element-type obj) 'radio-target)
6134 (add-to-list 'rtn (org-element-property :value obj)))))
6135 rtn))))
6136 (setq org-target-link-regexp
6137 (and targets
6138 (concat before-re
6139 (mapconcat
6140 (lambda (x)
6141 (replace-regexp-in-string
6142 " +" "\\s-+" (regexp-quote x) t t))
6143 targets
6144 "\\|")
6145 after-re)))
6146 (unless (equal old-regexp org-target-link-regexp)
6147 ;; Clean-up cache.
6148 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6149 ((not org-target-link-regexp) old-regexp)
6151 (concat before-re
6152 (mapconcat
6153 (lambda (re)
6154 (substring re (length before-re)
6155 (- (length after-re))))
6156 (list old-regexp org-target-link-regexp)
6157 "\\|")
6158 after-re)))))
6159 (org-with-wide-buffer
6160 (goto-char (point-min))
6161 (while (re-search-forward regexp nil t)
6162 (org-element-cache-refresh (match-beginning 1)))))
6163 ;; Re fontify buffer.
6164 (when (memq 'radio org-highlight-links)
6165 (org-restart-font-lock)))))
6167 (defun org-hide-wide-columns (limit)
6168 (let (s e)
6169 (setq s (text-property-any (point) (or limit (point-max))
6170 'org-cwidth t))
6171 (when s
6172 (setq e (next-single-property-change s 'org-cwidth))
6173 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6174 (goto-char e)
6175 t)))
6177 (defvar org-latex-and-related-regexp nil
6178 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6180 (defun org-compute-latex-and-related-regexp ()
6181 "Compute regular expression for LaTeX, entities and sub/superscript.
6182 Result depends on variable `org-highlight-latex-and-related'."
6183 (org-set-local
6184 'org-latex-and-related-regexp
6185 (let* ((re-sub
6186 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6187 ((eq org-use-sub-superscripts '{})
6188 (list org-match-substring-with-braces-regexp))
6189 (org-use-sub-superscripts (list org-match-substring-regexp))))
6190 (re-latex
6191 (when (memq 'latex org-highlight-latex-and-related)
6192 (let ((matchers (plist-get org-format-latex-options :matchers)))
6193 (delq nil
6194 (mapcar (lambda (x)
6195 (and (member (car x) matchers) (nth 1 x)))
6196 org-latex-regexps)))))
6197 (re-entities
6198 (when (memq 'entities org-highlight-latex-and-related)
6199 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6200 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6202 (defun org-do-latex-and-related (limit)
6203 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6204 LIMIT bounds the search for syntax to highlight. Stop at first
6205 highlighted object, if any. Return t if some highlighting was
6206 done, nil otherwise."
6207 (when (org-string-nw-p org-latex-and-related-regexp)
6208 (catch 'found
6209 (while (re-search-forward org-latex-and-related-regexp limit t)
6210 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6211 'face))
6212 '(org-code org-verbatim underline))
6213 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6214 '(?_ ?^))
6216 0)))
6217 (font-lock-prepend-text-property
6218 (+ offset (match-beginning 0)) (match-end 0)
6219 'face 'org-latex-and-related)
6220 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6221 '(font-lock-multiline t)))
6222 (throw 'found t)))
6223 nil)))
6225 (defun org-restart-font-lock ()
6226 "Restart `font-lock-mode', to force refontification."
6227 (when (and (boundp 'font-lock-mode) font-lock-mode)
6228 (font-lock-mode -1)
6229 (font-lock-mode 1)))
6231 (defun org-activate-tags (limit)
6232 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6233 (progn
6234 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6235 (add-text-properties (match-beginning 1) (match-end 1)
6236 (list 'mouse-face 'highlight
6237 'keymap org-mouse-map))
6238 (org-rear-nonsticky-at (match-end 1))
6239 t)))
6241 (defun org-outline-level ()
6242 "Compute the outline level of the heading at point.
6244 If this is called at a normal headline, the level is the number
6245 of stars. Use `org-reduced-level' to remove the effect of
6246 `org-odd-levels'. Unlike to `org-current-level', this function
6247 takes into consideration inlinetasks."
6248 (org-with-wide-buffer
6249 (end-of-line)
6250 (if (re-search-backward org-outline-regexp-bol nil t)
6251 (1- (- (match-end 0) (match-beginning 0)))
6252 0)))
6254 (defvar org-font-lock-keywords nil)
6256 (defsubst org-re-property (property &optional literal allow-null value)
6257 "Return a regexp matching a PROPERTY line.
6259 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6260 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6261 non-nil, match properties even without a value.
6263 Match group 3 is set to the value when it exists. If there is no
6264 value and ALLOW-NULL is non-nil, it is set to the empty string.
6266 With optional argument VALUE, match only property lines with
6267 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6268 unless LITERAL is non-nil."
6269 (concat
6270 "^\\(?4:[ \t]*\\)"
6271 (format "\\(?1::\\(?2:%s\\):\\)"
6272 (if literal property (regexp-quote property)))
6273 (cond (value
6274 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6275 (if literal value (regexp-quote value))))
6276 (allow-null
6277 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6279 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6281 (defconst org-property-re
6282 (org-re-property "\\S-+" 'literal t)
6283 "Regular expression matching a property line.
6284 There are four matching groups:
6285 1: :PROPKEY: including the leading and trailing colon,
6286 2: PROPKEY without the leading and trailing colon,
6287 3: PROPVAL without leading or trailing spaces,
6288 4: the indentation of the current line,
6289 5: trailing whitespace.")
6291 (defvar org-font-lock-hook nil
6292 "Functions to be called for special font lock stuff.")
6294 (defvar org-font-lock-set-keywords-hook nil
6295 "Functions that can manipulate `org-font-lock-extra-keywords'.
6296 This is called after `org-font-lock-extra-keywords' is defined, but before
6297 it is installed to be used by font lock. This can be useful if something
6298 needs to be inserted at a specific position in the font-lock sequence.")
6300 (defun org-font-lock-hook (limit)
6301 "Run `org-font-lock-hook' within LIMIT."
6302 (run-hook-with-args 'org-font-lock-hook limit))
6304 (defun org-set-font-lock-defaults ()
6305 "Set font lock defaults for the current buffer."
6306 (let* ((em org-fontify-emphasized-text)
6307 (lk org-highlight-links)
6308 (org-font-lock-extra-keywords
6309 (list
6310 ;; Call the hook
6311 '(org-font-lock-hook)
6312 ;; Headlines
6313 `(,(if org-fontify-whole-heading-line
6314 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6315 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6316 (1 (org-get-level-face 1))
6317 (2 (org-get-level-face 2))
6318 (3 (org-get-level-face 3)))
6319 ;; Table lines
6320 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6321 (1 'org-table t))
6322 ;; Table internals
6323 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6324 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6325 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6326 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6327 ;; Drawers
6328 '(org-fontify-drawers)
6329 ;; Properties
6330 (list org-property-re
6331 '(1 'org-special-keyword t)
6332 '(3 'org-property-value t))
6333 ;; Links
6334 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6335 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6336 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6337 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6338 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6339 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6340 (if (memq 'footnote lk) '(org-activate-footnote-links))
6341 ;; Targets.
6342 (list org-any-target-regexp '(0 'org-target t))
6343 ;; Diary sexps.
6344 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6345 ;; Macro
6346 '(org-fontify-macros)
6347 '(org-hide-wide-columns (0 nil append))
6348 ;; TODO keyword
6349 (list (format org-heading-keyword-regexp-format
6350 org-todo-regexp)
6351 '(2 (org-get-todo-face 2) t))
6352 ;; DONE
6353 (if org-fontify-done-headline
6354 (list (format org-heading-keyword-regexp-format
6355 (concat
6356 "\\(?:"
6357 (mapconcat 'regexp-quote org-done-keywords "\\|")
6358 "\\)"))
6359 '(2 'org-headline-done t))
6360 nil)
6361 ;; Priorities
6362 '(org-font-lock-add-priority-faces)
6363 ;; Tags
6364 '(org-font-lock-add-tag-faces)
6365 ;; Tags groups
6366 (if (and org-group-tags org-tag-groups-alist)
6367 (list (concat org-outline-regexp-bol ".+\\(:"
6368 (regexp-opt (mapcar 'car org-tag-groups-alist))
6369 ":\\).*$")
6370 '(1 'org-tag-group prepend)))
6371 ;; Special keywords
6372 (list (concat "\\<" org-comment-string) '(0 'org-special-keyword t))
6373 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6374 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6375 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6376 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6377 ;; Emphasis
6378 (if em
6379 (if (featurep 'xemacs)
6380 '(org-do-emphasis-faces (0 nil append))
6381 '(org-do-emphasis-faces)))
6382 ;; Checkboxes
6383 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6384 1 'org-checkbox prepend)
6385 (if (cdr (assq 'checkbox org-list-automatic-rules))
6386 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6387 (0 (org-get-checkbox-statistics-face) t)))
6388 ;; Description list items
6389 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6390 1 'org-list-dt prepend)
6391 ;; ARCHIVEd headings
6392 (list (concat
6393 org-outline-regexp-bol
6394 "\\(.*:" org-archive-tag ":.*\\)")
6395 '(1 'org-archived prepend))
6396 ;; Specials
6397 '(org-do-latex-and-related)
6398 '(org-fontify-entities)
6399 '(org-raise-scripts)
6400 ;; Code
6401 '(org-activate-code (1 'org-code t))
6402 ;; COMMENT
6403 (list (format
6404 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6405 org-todo-regexp
6406 org-comment-string)
6407 '(9 'org-special-keyword t))
6408 ;; Blocks and meta lines
6409 '(org-fontify-meta-lines-and-blocks))))
6410 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6411 (run-hooks 'org-font-lock-set-keywords-hook)
6412 ;; Now set the full font-lock-keywords
6413 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6414 (org-set-local 'font-lock-defaults
6415 '(org-font-lock-keywords t nil nil backward-paragraph))
6416 (kill-local-variable 'font-lock-keywords) nil))
6418 (defun org-toggle-pretty-entities ()
6419 "Toggle the composition display of entities as UTF8 characters."
6420 (interactive)
6421 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6422 (org-restart-font-lock)
6423 (if org-pretty-entities
6424 (message "Entities are now displayed as UTF8 characters")
6425 (save-restriction
6426 (widen)
6427 (org-decompose-region (point-min) (point-max))
6428 (message "Entities are now displayed as plain text"))))
6430 (defvar org-custom-properties-overlays nil
6431 "List of overlays used for custom properties.")
6432 (make-variable-buffer-local 'org-custom-properties-overlays)
6434 (defun org-toggle-custom-properties-visibility ()
6435 "Display or hide properties in `org-custom-properties'."
6436 (interactive)
6437 (if org-custom-properties-overlays
6438 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6439 (setq org-custom-properties-overlays nil))
6440 (when org-custom-properties
6441 (org-with-wide-buffer
6442 (goto-char (point-min))
6443 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6444 (while (re-search-forward regexp nil t)
6445 (let ((end (cdr (save-match-data (org-get-property-block)))))
6446 (when (and end (< (point) end))
6447 ;; Hide first custom property in current drawer.
6448 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6449 (overlay-put o 'invisible t)
6450 (overlay-put o 'org-custom-property t)
6451 (push o org-custom-properties-overlays))
6452 ;; Hide additional custom properties in the same drawer.
6453 (while (re-search-forward regexp end t)
6454 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6455 (overlay-put o 'invisible t)
6456 (overlay-put o 'org-custom-property t)
6457 (push o org-custom-properties-overlays)))))
6458 ;; Each entry is limited to a single property drawer.
6459 (outline-next-heading)))))))
6461 (defun org-fontify-entities (limit)
6462 "Find an entity to fontify."
6463 (let (ee)
6464 (when org-pretty-entities
6465 (catch 'match
6466 ;; "\_ "-family is left out on purpose. Only the first one,
6467 ;; i.e., "\_ ", could be fontified anyway, and it would be
6468 ;; confusing when adding a second white space character.
6469 (while (re-search-forward
6470 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6471 limit t)
6472 (if (and (not (org-at-comment-p))
6473 (setq ee (org-entity-get (match-string 1)))
6474 (= (length (nth 6 ee)) 1))
6475 (let*
6476 ((end (if (equal (match-string 2) "{}")
6477 (match-end 2)
6478 (match-end 1))))
6479 (add-text-properties
6480 (match-beginning 0) end
6481 (list 'font-lock-fontified t))
6482 (compose-region (match-beginning 0) end
6483 (nth 6 ee) nil)
6484 (backward-char 1)
6485 (throw 'match t))))
6486 nil))))
6488 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6489 "Fontify string S like in Org-mode."
6490 (with-temp-buffer
6491 (insert s)
6492 (let ((org-odd-levels-only odd-levels))
6493 (org-mode)
6494 (font-lock-ensure)
6495 (buffer-string))))
6497 (defvar org-m nil)
6498 (defvar org-l nil)
6499 (defvar org-f nil)
6500 (defun org-get-level-face (n)
6501 "Get the right face for match N in font-lock matching of headlines."
6502 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6503 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6504 (if org-cycle-level-faces
6505 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6506 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6507 (cond
6508 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6509 ((eq n 2) org-f)
6510 (t (if org-level-color-stars-only nil org-f))))
6513 (defun org-get-todo-face (kwd)
6514 "Get the right face for a TODO keyword KWD.
6515 If KWD is a number, get the corresponding match group."
6516 (if (numberp kwd) (setq kwd (match-string kwd)))
6517 (or (org-face-from-face-or-color
6518 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6519 (and (member kwd org-done-keywords) 'org-done)
6520 'org-todo))
6522 (defun org-face-from-face-or-color (context inherit face-or-color)
6523 "Create a face list that inherits INHERIT, but sets the foreground color.
6524 When FACE-OR-COLOR is not a string, just return it."
6525 (if (stringp face-or-color)
6526 (list :inherit inherit
6527 (cdr (assoc context org-faces-easy-properties))
6528 face-or-color)
6529 face-or-color))
6531 (defun org-font-lock-add-tag-faces (limit)
6532 "Add the special tag faces."
6533 (when (and org-tag-faces org-tags-special-faces-re)
6534 (while (re-search-forward org-tags-special-faces-re limit t)
6535 (add-text-properties (match-beginning 1) (match-end 1)
6536 (list 'face (org-get-tag-face 1)
6537 'font-lock-fontified t))
6538 (backward-char 1))))
6540 (defun org-font-lock-add-priority-faces (limit)
6541 "Add the special priority faces."
6542 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6543 (when (save-match-data (org-at-heading-p))
6544 (add-text-properties
6545 (match-beginning 0) (match-end 0)
6546 (list 'face (or (org-face-from-face-or-color
6547 'priority 'org-priority
6548 (cdr (assoc (char-after (match-beginning 1))
6549 org-priority-faces)))
6550 'org-priority)
6551 'font-lock-fontified t)))))
6553 (defun org-get-tag-face (kwd)
6554 "Get the right face for a TODO keyword KWD.
6555 If KWD is a number, get the corresponding match group."
6556 (if (numberp kwd) (setq kwd (match-string kwd)))
6557 (or (org-face-from-face-or-color
6558 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6559 'org-tag))
6561 (defun org-unfontify-region (beg end &optional maybe_loudly)
6562 "Remove fontification and activation overlays from links."
6563 (font-lock-default-unfontify-region beg end)
6564 (let* ((buffer-undo-list t)
6565 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6566 (inhibit-modification-hooks t)
6567 deactivate-mark buffer-file-name buffer-file-truename)
6568 (org-decompose-region beg end)
6569 (remove-text-properties beg end
6570 '(mouse-face t keymap t org-linked-text t
6571 invisible t intangible t
6572 org-emphasis t))
6573 (org-remove-font-lock-display-properties beg end)))
6575 (defconst org-script-display '(((raise -0.3) (height 0.7))
6576 ((raise 0.3) (height 0.7))
6577 ((raise -0.5))
6578 ((raise 0.5)))
6579 "Display properties for showing superscripts and subscripts.")
6581 (defun org-remove-font-lock-display-properties (beg end)
6582 "Remove specific display properties that have been added by font lock.
6583 The will remove the raise properties that are used to show superscripts
6584 and subscripts."
6585 (let (next prop)
6586 (while (< beg end)
6587 (setq next (next-single-property-change beg 'display nil end)
6588 prop (get-text-property beg 'display))
6589 (if (member prop org-script-display)
6590 (put-text-property beg next 'display nil))
6591 (setq beg next))))
6593 (defun org-raise-scripts (limit)
6594 "Add raise properties to sub/superscripts."
6595 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6596 (if (re-search-forward
6597 (if (eq org-use-sub-superscripts t)
6598 org-match-substring-regexp
6599 org-match-substring-with-braces-regexp)
6600 limit t)
6601 (let* ((pos (point)) table-p comment-p
6602 (mpos (match-beginning 3))
6603 (emph-p (get-text-property mpos 'org-emphasis))
6604 (link-p (get-text-property mpos 'mouse-face))
6605 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6606 (goto-char (point-at-bol))
6607 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6608 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6609 (goto-char pos)
6610 ;; Handle a_b^c
6611 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6612 (if (or comment-p emph-p link-p keyw-p)
6614 (put-text-property (match-beginning 3) (match-end 0)
6615 'display
6616 (if (equal (char-after (match-beginning 2)) ?^)
6617 (nth (if table-p 3 1) org-script-display)
6618 (nth (if table-p 2 0) org-script-display)))
6619 (add-text-properties (match-beginning 2) (match-end 2)
6620 (list 'invisible t
6621 'org-dwidth t 'org-dwidth-n 1))
6622 (if (and (eq (char-after (match-beginning 3)) ?{)
6623 (eq (char-before (match-end 3)) ?}))
6624 (progn
6625 (add-text-properties
6626 (match-beginning 3) (1+ (match-beginning 3))
6627 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6628 (add-text-properties
6629 (1- (match-end 3)) (match-end 3)
6630 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6631 t)))))
6633 ;;;; Visibility cycling, including org-goto and indirect buffer
6635 ;;; Cycling
6637 (defvar org-cycle-global-status nil)
6638 (make-variable-buffer-local 'org-cycle-global-status)
6639 (put 'org-cycle-global-status 'org-state t)
6640 (defvar org-cycle-subtree-status nil)
6641 (make-variable-buffer-local 'org-cycle-subtree-status)
6642 (put 'org-cycle-subtree-status 'org-state t)
6644 (defvar org-inlinetask-min-level)
6646 (defun org-unlogged-message (&rest args)
6647 "Display a message, but avoid logging it in the *Messages* buffer."
6648 (let ((message-log-max nil))
6649 (apply 'message args)))
6651 ;;;###autoload
6652 (defun org-cycle (&optional arg)
6653 "TAB-action and visibility cycling for Org-mode.
6655 This is the command invoked in Org-mode by the TAB key. Its main purpose
6656 is outline visibility cycling, but it also invokes other actions
6657 in special contexts.
6659 - When this function is called with a prefix argument, rotate the entire
6660 buffer through 3 states (global cycling)
6661 1. OVERVIEW: Show only top-level headlines.
6662 2. CONTENTS: Show all headlines of all levels, but no body text.
6663 3. SHOW ALL: Show everything.
6664 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6665 determined by the variable `org-startup-folded', and by any VISIBILITY
6666 properties in the buffer.
6667 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6668 including any drawers.
6670 - When inside a table, re-align the table and move to the next field.
6672 - When point is at the beginning of a headline, rotate the subtree started
6673 by this line through 3 different states (local cycling)
6674 1. FOLDED: Only the main headline is shown.
6675 2. CHILDREN: The main headline and the direct children are shown.
6676 From this state, you can move to one of the children
6677 and zoom in further.
6678 3. SUBTREE: Show the entire subtree, including body text.
6679 If there is no subtree, switch directly from CHILDREN to FOLDED.
6681 - When point is at the beginning of an empty headline and the variable
6682 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6683 of the headline by demoting and promoting it to likely levels. This
6684 speeds up creation document structure by pressing TAB once or several
6685 times right after creating a new headline.
6687 - When there is a numeric prefix, go up to a heading with level ARG, do
6688 a `show-subtree' and return to the previous cursor position. If ARG
6689 is negative, go up that many levels.
6691 - When point is not at the beginning of a headline, execute the global
6692 binding for TAB, which is re-indenting the line. See the option
6693 `org-cycle-emulate-tab' for details.
6695 - Special case: if point is at the beginning of the buffer and there is
6696 no headline in line 1, this function will act as if called with prefix arg
6697 (C-u TAB, same as S-TAB) also when called without prefix arg.
6698 But only if also the variable `org-cycle-global-at-bob' is t."
6699 (interactive "P")
6700 (org-load-modules-maybe)
6701 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6702 (and org-cycle-level-after-item/entry-creation
6703 (or (org-cycle-level)
6704 (org-cycle-item-indentation))))
6705 (let* ((limit-level
6706 (or org-cycle-max-level
6707 (and (boundp 'org-inlinetask-min-level)
6708 org-inlinetask-min-level
6709 (1- org-inlinetask-min-level))))
6710 (nstars (and limit-level
6711 (if org-odd-levels-only
6712 (and limit-level (1- (* limit-level 2)))
6713 limit-level)))
6714 (org-outline-regexp
6715 (if (not (derived-mode-p 'org-mode))
6716 outline-regexp
6717 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6718 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6719 (not (looking-at org-outline-regexp))))
6720 (org-cycle-hook
6721 (if bob-special
6722 (delq 'org-optimize-window-after-visibility-change
6723 (copy-sequence org-cycle-hook))
6724 org-cycle-hook))
6725 (pos (point)))
6727 (if (or bob-special (equal arg '(4)))
6728 ;; special case: use global cycling
6729 (setq arg t))
6731 (cond
6733 ((equal arg '(16))
6734 (setq last-command 'dummy)
6735 (org-set-startup-visibility)
6736 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6738 ((equal arg '(64))
6739 (show-all)
6740 (org-unlogged-message "Entire buffer visible, including drawers"))
6742 ;; Try cdlatex TAB completion
6743 ((org-try-cdlatex-tab))
6745 ;; Table: enter it or move to the next field.
6746 ((org-at-table-p 'any)
6747 (if (org-at-table.el-p)
6748 (message "Use C-c ' to edit table.el tables")
6749 (if arg (org-table-edit-field t)
6750 (org-table-justify-field-maybe)
6751 (call-interactively 'org-table-next-field))))
6753 ((run-hook-with-args-until-success
6754 'org-tab-after-check-for-table-hook))
6756 ;; Global cycling: delegate to `org-cycle-internal-global'.
6757 ((eq arg t) (org-cycle-internal-global))
6759 ;; Drawers: delegate to `org-flag-drawer'.
6760 ((save-excursion
6761 (beginning-of-line 1)
6762 (looking-at org-drawer-regexp))
6763 (org-flag-drawer ; toggle block visibility
6764 (not (get-char-property (match-end 0) 'invisible))))
6766 ;; Show-subtree, ARG levels up from here.
6767 ((integerp arg)
6768 (save-excursion
6769 (org-back-to-heading)
6770 (outline-up-heading (if (< arg 0) (- arg)
6771 (- (funcall outline-level) arg)))
6772 (org-show-subtree)))
6774 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6775 ((and (featurep 'org-inlinetask)
6776 (org-inlinetask-at-task-p)
6777 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6778 (org-inlinetask-toggle-visibility))
6780 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6781 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6782 (save-excursion (move-beginning-of-line 1)
6783 (looking-at org-outline-regexp)))
6784 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6785 (org-cycle-internal-local))
6787 ;; From there: TAB emulation and template completion.
6788 (buffer-read-only (org-back-to-heading))
6790 ((run-hook-with-args-until-success
6791 'org-tab-after-check-for-cycling-hook))
6793 ((org-try-structure-completion))
6795 ((run-hook-with-args-until-success
6796 'org-tab-before-tab-emulation-hook))
6798 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6799 (or (not (bolp))
6800 (not (looking-at org-outline-regexp))))
6801 (call-interactively (global-key-binding "\t")))
6803 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6804 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6805 (or (and (eq org-cycle-emulate-tab 'white)
6806 (= (match-end 0) (point-at-eol)))
6807 (and (eq org-cycle-emulate-tab 'whitestart)
6808 (>= (match-end 0) pos))))
6810 (eq org-cycle-emulate-tab t))
6811 (call-interactively (global-key-binding "\t")))
6813 (t (save-excursion
6814 (org-back-to-heading)
6815 (org-cycle)))))))
6817 (defun org-cycle-internal-global ()
6818 "Do the global cycling action."
6819 ;; Hack to avoid display of messages for .org attachments in Gnus
6820 (let ((ga (string-match "\\*fontification" (buffer-name))))
6821 (cond
6822 ((and (eq last-command this-command)
6823 (eq org-cycle-global-status 'overview))
6824 ;; We just created the overview - now do table of contents
6825 ;; This can be slow in very large buffers, so indicate action
6826 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6827 (unless ga (org-unlogged-message "CONTENTS..."))
6828 (org-content)
6829 (unless ga (org-unlogged-message "CONTENTS...done"))
6830 (setq org-cycle-global-status 'contents)
6831 (run-hook-with-args 'org-cycle-hook 'contents))
6833 ((and (eq last-command this-command)
6834 (eq org-cycle-global-status 'contents))
6835 ;; We just showed the table of contents - now show everything
6836 (run-hook-with-args 'org-pre-cycle-hook 'all)
6837 (show-all)
6838 (unless ga (org-unlogged-message "SHOW ALL"))
6839 (setq org-cycle-global-status 'all)
6840 (run-hook-with-args 'org-cycle-hook 'all))
6843 ;; Default action: go to overview
6844 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6845 (org-overview)
6846 (unless ga (org-unlogged-message "OVERVIEW"))
6847 (setq org-cycle-global-status 'overview)
6848 (run-hook-with-args 'org-cycle-hook 'overview)))))
6850 (defvar org-called-with-limited-levels nil
6851 "Non-nil when `org-with-limited-levels' is currently active.")
6853 (defun org-cycle-internal-local ()
6854 "Do the local cycling action."
6855 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6856 ;; First, determine end of headline (EOH), end of subtree or item
6857 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6858 (save-excursion
6859 (if (org-at-item-p)
6860 (progn
6861 (beginning-of-line)
6862 (setq struct (org-list-struct))
6863 (setq eoh (point-at-eol))
6864 (setq eos (org-list-get-item-end-before-blank (point) struct))
6865 (setq has-children (org-list-has-child-p (point) struct)))
6866 (org-back-to-heading)
6867 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6868 (setq eos (save-excursion (org-end-of-subtree t t)
6869 (when (bolp) (backward-char)) (point)))
6870 (setq has-children
6871 (or (save-excursion
6872 (let ((level (funcall outline-level)))
6873 (outline-next-heading)
6874 (and (org-at-heading-p t)
6875 (> (funcall outline-level) level))))
6876 (save-excursion
6877 (org-list-search-forward (org-item-beginning-re) eos t)))))
6878 ;; Determine end invisible part of buffer (EOL)
6879 (beginning-of-line 2)
6880 ;; XEmacs doesn't have `next-single-char-property-change'
6881 (if (featurep 'xemacs)
6882 (while (and (not (eobp)) ;; this is like `next-line'
6883 (get-char-property (1- (point)) 'invisible))
6884 (beginning-of-line 2))
6885 (while (and (not (eobp)) ;; this is like `next-line'
6886 (get-char-property (1- (point)) 'invisible))
6887 (goto-char (next-single-char-property-change (point) 'invisible))
6888 (and (eolp) (beginning-of-line 2))))
6889 (setq eol (point)))
6890 ;; Find out what to do next and set `this-command'
6891 (cond
6892 ((= eos eoh)
6893 ;; Nothing is hidden behind this heading
6894 (unless (org-before-first-heading-p)
6895 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6896 (org-unlogged-message "EMPTY ENTRY")
6897 (setq org-cycle-subtree-status nil)
6898 (save-excursion
6899 (goto-char eos)
6900 (outline-next-heading)
6901 (if (outline-invisible-p) (org-flag-heading nil))))
6902 ((and (or (>= eol eos)
6903 (not (string-match "\\S-" (buffer-substring eol eos))))
6904 (or has-children
6905 (not (setq children-skipped
6906 org-cycle-skip-children-state-if-no-children))))
6907 ;; Entire subtree is hidden in one line: children view
6908 (unless (org-before-first-heading-p)
6909 (run-hook-with-args 'org-pre-cycle-hook 'children))
6910 (if (org-at-item-p)
6911 (org-list-set-item-visibility (point-at-bol) struct 'children)
6912 (org-show-entry)
6913 (org-with-limited-levels (show-children))
6914 ;; FIXME: This slows down the func way too much.
6915 ;; How keep drawers hidden in subtree anyway?
6916 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6917 ;; (org-cycle-hide-drawers 'subtree))
6919 ;; Fold every list in subtree to top-level items.
6920 (when (eq org-cycle-include-plain-lists 'integrate)
6921 (save-excursion
6922 (org-back-to-heading)
6923 (while (org-list-search-forward (org-item-beginning-re) eos t)
6924 (beginning-of-line 1)
6925 (let* ((struct (org-list-struct))
6926 (prevs (org-list-prevs-alist struct))
6927 (end (org-list-get-bottom-point struct)))
6928 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6929 (org-list-get-all-items (point) struct prevs))
6930 (goto-char (if (< end eos) end eos)))))))
6931 (org-unlogged-message "CHILDREN")
6932 (save-excursion
6933 (goto-char eos)
6934 (outline-next-heading)
6935 (if (outline-invisible-p) (org-flag-heading nil)))
6936 (setq org-cycle-subtree-status 'children)
6937 (unless (org-before-first-heading-p)
6938 (run-hook-with-args 'org-cycle-hook 'children)))
6939 ((or children-skipped
6940 (and (eq last-command this-command)
6941 (eq org-cycle-subtree-status 'children)))
6942 ;; We just showed the children, or no children are there,
6943 ;; now show everything.
6944 (unless (org-before-first-heading-p)
6945 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6946 (outline-flag-region eoh eos nil)
6947 (org-unlogged-message
6948 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6949 (setq org-cycle-subtree-status 'subtree)
6950 (unless (org-before-first-heading-p)
6951 (run-hook-with-args 'org-cycle-hook 'subtree)))
6953 ;; Default action: hide the subtree.
6954 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6955 (outline-flag-region eoh eos t)
6956 (org-unlogged-message "FOLDED")
6957 (setq org-cycle-subtree-status 'folded)
6958 (unless (org-before-first-heading-p)
6959 (run-hook-with-args 'org-cycle-hook 'folded))))))
6961 ;;;###autoload
6962 (defun org-global-cycle (&optional arg)
6963 "Cycle the global visibility. For details see `org-cycle'.
6964 With \\[universal-argument] prefix arg, switch to startup visibility.
6965 With a numeric prefix, show all headlines up to that level."
6966 (interactive "P")
6967 (let ((org-cycle-include-plain-lists
6968 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6969 (cond
6970 ((integerp arg)
6971 (show-all)
6972 (hide-sublevels arg)
6973 (setq org-cycle-global-status 'contents))
6974 ((equal arg '(4))
6975 (org-set-startup-visibility)
6976 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6978 (org-cycle '(4))))))
6980 (defun org-set-startup-visibility ()
6981 "Set the visibility required by startup options and properties."
6982 (cond
6983 ((eq org-startup-folded t)
6984 (org-overview))
6985 ((eq org-startup-folded 'content)
6986 (org-content))
6987 ((or (eq org-startup-folded 'showeverything)
6988 (eq org-startup-folded nil))
6989 (show-all)))
6990 (unless (eq org-startup-folded 'showeverything)
6991 (if org-hide-block-startup (org-hide-block-all))
6992 (org-set-visibility-according-to-property 'no-cleanup)
6993 (org-cycle-hide-archived-subtrees 'all)
6994 (org-cycle-hide-drawers 'all)
6995 (org-cycle-show-empty-lines t)))
6997 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6998 "Switch subtree visibilities according to :VISIBILITY: property."
6999 (interactive)
7000 (let (org-show-entry-below)
7001 (org-with-wide-buffer
7002 (goto-char (point-min))
7003 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
7004 (if (not (org-at-property-p)) (outline-next-heading)
7005 (let ((state (match-string 3)))
7006 (save-excursion
7007 (org-back-to-heading t)
7008 (hide-subtree)
7009 (org-reveal)
7010 (cond
7011 ((equal state "folded")
7012 (hide-subtree))
7013 ((equal state "children")
7014 (org-show-hidden-entry)
7015 (show-children))
7016 ((equal state "content")
7017 (save-excursion
7018 (save-restriction
7019 (org-narrow-to-subtree)
7020 (org-content))))
7021 ((member state '("all" "showall"))
7022 (show-subtree)))))))
7023 (unless no-cleanup
7024 (org-cycle-hide-archived-subtrees 'all)
7025 (org-cycle-hide-drawers 'all)
7026 (org-cycle-show-empty-lines 'all)))))
7028 ;; This function uses outline-regexp instead of the more fundamental
7029 ;; org-outline-regexp so that org-cycle-global works outside of Org
7030 ;; buffers, where outline-regexp is needed.
7031 (defun org-overview ()
7032 "Switch to overview mode, showing only top-level headlines.
7033 This shows all headlines with a level equal or greater than the level
7034 of the first headline in the buffer. This is important, because if the
7035 first headline is not level one, then (hide-sublevels 1) gives confusing
7036 results."
7037 (interactive)
7038 (save-excursion
7039 (let ((level
7040 (save-excursion
7041 (goto-char (point-min))
7042 (if (re-search-forward (concat "^" outline-regexp) nil t)
7043 (progn
7044 (goto-char (match-beginning 0))
7045 (funcall outline-level))))))
7046 (and level (hide-sublevels level)))))
7048 (defun org-content (&optional arg)
7049 "Show all headlines in the buffer, like a table of contents.
7050 With numerical argument N, show content up to level N."
7051 (interactive "P")
7052 (org-overview)
7053 (save-excursion
7054 ;; Visit all headings and show their offspring
7055 (and (integerp arg) (org-overview))
7056 (goto-char (point-max))
7057 (catch 'exit
7058 (while (and (progn (condition-case nil
7059 (outline-previous-visible-heading 1)
7060 (error (goto-char (point-min))))
7062 (looking-at org-outline-regexp))
7063 (if (integerp arg)
7064 (show-children (1- arg))
7065 (show-branches))
7066 (if (bobp) (throw 'exit nil))))))
7068 (defun org-optimize-window-after-visibility-change (state)
7069 "Adjust the window after a change in outline visibility.
7070 This function is the default value of the hook `org-cycle-hook'."
7071 (when (get-buffer-window (current-buffer))
7072 (cond
7073 ((eq state 'content) nil)
7074 ((eq state 'all) nil)
7075 ((eq state 'folded) nil)
7076 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7077 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7079 (defun org-remove-empty-overlays-at (pos)
7080 "Remove outline overlays that do not contain non-white stuff."
7081 (mapc
7082 (lambda (o)
7083 (and (eq 'outline (overlay-get o 'invisible))
7084 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7085 (overlay-end o))))
7086 (delete-overlay o)))
7087 (overlays-at pos)))
7089 (defun org-clean-visibility-after-subtree-move ()
7090 "Fix visibility issues after moving a subtree."
7091 ;; First, find a reasonable region to look at:
7092 ;; Start two siblings above, end three below
7093 (let* ((beg (save-excursion
7094 (and (org-get-last-sibling)
7095 (org-get-last-sibling))
7096 (point)))
7097 (end (save-excursion
7098 (and (org-get-next-sibling)
7099 (org-get-next-sibling)
7100 (org-get-next-sibling))
7101 (if (org-at-heading-p)
7102 (point-at-eol)
7103 (point))))
7104 (level (looking-at "\\*+"))
7105 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7106 (save-excursion
7107 (save-restriction
7108 (narrow-to-region beg end)
7109 (when re
7110 ;; Properly fold already folded siblings
7111 (goto-char (point-min))
7112 (while (re-search-forward re nil t)
7113 (if (and (not (outline-invisible-p))
7114 (save-excursion
7115 (goto-char (point-at-eol)) (outline-invisible-p)))
7116 (hide-entry))))
7117 (org-cycle-show-empty-lines 'overview)
7118 (org-cycle-hide-drawers 'overview)))))
7120 (defun org-cycle-show-empty-lines (state)
7121 "Show empty lines above all visible headlines.
7122 The region to be covered depends on STATE when called through
7123 `org-cycle-hook'. Lisp program can use t for STATE to get the
7124 entire buffer covered. Note that an empty line is only shown if there
7125 are at least `org-cycle-separator-lines' empty lines before the headline."
7126 (when (/= org-cycle-separator-lines 0)
7127 (save-excursion
7128 (let* ((n (abs org-cycle-separator-lines))
7129 (re (cond
7130 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7131 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7132 (t (let ((ns (number-to-string (- n 2))))
7133 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7134 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7135 beg end)
7136 (cond
7137 ((memq state '(overview contents t))
7138 (setq beg (point-min) end (point-max)))
7139 ((memq state '(children folded))
7140 (setq beg (point)
7141 end (progn (org-end-of-subtree t t)
7142 (line-beginning-position 2)))))
7143 (when beg
7144 (goto-char beg)
7145 (while (re-search-forward re end t)
7146 (unless (get-char-property (match-end 1) 'invisible)
7147 (let ((e (match-end 1))
7148 (b (if (>= org-cycle-separator-lines 0)
7149 (match-beginning 1)
7150 (save-excursion
7151 (goto-char (match-beginning 0))
7152 (skip-chars-backward " \t\n")
7153 (line-end-position)))))
7154 (outline-flag-region b e nil))))))))
7155 ;; Never hide empty lines at the end of the file.
7156 (save-excursion
7157 (goto-char (point-max))
7158 (outline-previous-heading)
7159 (outline-end-of-heading)
7160 (if (and (looking-at "[ \t\n]+")
7161 (= (match-end 0) (point-max)))
7162 (outline-flag-region (point) (match-end 0) nil))))
7164 (defun org-show-empty-lines-in-parent ()
7165 "Move to the parent and re-show empty lines before visible headlines."
7166 (save-excursion
7167 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7168 (org-cycle-show-empty-lines context))))
7170 (defun org-files-list ()
7171 "Return `org-agenda-files' list, plus all open org-mode files.
7172 This is useful for operations that need to scan all of a user's
7173 open and agenda-wise Org files."
7174 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7175 (dolist (buf (buffer-list))
7176 (with-current-buffer buf
7177 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7178 (let ((file (expand-file-name (buffer-file-name))))
7179 (unless (member file files)
7180 (push file files))))))
7181 files))
7183 (defsubst org-entry-beginning-position ()
7184 "Return the beginning position of the current entry."
7185 (save-excursion (outline-back-to-heading t) (point)))
7187 (defsubst org-entry-end-position ()
7188 "Return the end position of the current entry."
7189 (save-excursion (outline-next-heading) (point)))
7191 (defun org-cycle-hide-drawers (state &optional exceptions)
7192 "Re-hide all drawers after a visibility state change.
7193 When non-nil, optional argument EXCEPTIONS is a list of strings
7194 specifying which drawers should not be hidden."
7195 (when (and (derived-mode-p 'org-mode)
7196 (not (memq state '(overview folded contents))))
7197 (save-excursion
7198 (let* ((globalp (memq state '(contents all)))
7199 (beg (if globalp (point-min) (point)))
7200 (end (if globalp (point-max)
7201 (if (eq state 'children)
7202 (save-excursion (outline-next-heading) (point))
7203 (org-end-of-subtree t)))))
7204 (goto-char beg)
7205 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7206 (unless (member-ignore-case (match-string 1) exceptions)
7207 (let ((drawer (org-element-at-point)))
7208 (when (memq (org-element-type drawer) '(drawer property-drawer))
7209 (org-flag-drawer t drawer)
7210 ;; Make sure to skip drawer entirely or we might flag
7211 ;; it another time when matching its ending line with
7212 ;; `org-drawer-regexp'.
7213 (goto-char (org-element-property :end drawer))))))))))
7215 (defun org-flag-drawer (flag &optional element)
7216 "When FLAG is non-nil, hide the drawer we are at.
7217 Otherwise make it visible. When optional argument ELEMENT is
7218 a parsed drawer, as returned by `org-element-at-point', hide or
7219 show that drawer instead."
7220 (when (save-excursion
7221 (beginning-of-line)
7222 (org-looking-at-p org-drawer-regexp))
7223 (let ((drawer (or element (org-element-at-point))))
7224 (when (memq (org-element-type drawer) '(drawer property-drawer))
7225 (let ((post (org-element-property :post-affiliated drawer)))
7226 (save-excursion
7227 (outline-flag-region
7228 (progn (goto-char post) (line-end-position))
7229 (progn (goto-char (org-element-property :end drawer))
7230 (skip-chars-backward " \r\t\n")
7231 (line-end-position))
7232 flag))
7233 ;; When the drawer is hidden away, make sure point lies in
7234 ;; a visible part of the buffer.
7235 (when (and flag (> (line-beginning-position) post))
7236 (goto-char post)))))))
7238 (defun org-subtree-end-visible-p ()
7239 "Is the end of the current subtree visible?"
7240 (pos-visible-in-window-p
7241 (save-excursion (org-end-of-subtree t) (point))))
7243 (defun org-first-headline-recenter ()
7244 "Move cursor to the first headline and recenter the headline."
7245 (goto-char (point-min))
7246 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7247 (set-window-start (selected-window) (point-at-bol))))
7249 ;;; Saving and restoring visibility
7251 (defun org-outline-overlay-data (&optional use-markers)
7252 "Return a list of the locations of all outline overlays.
7253 These are overlays with the `invisible' property value `outline'.
7254 The return value is a list of cons cells, with start and stop
7255 positions for each overlay.
7256 If USE-MARKERS is set, return the positions as markers."
7257 (let (beg end)
7258 (save-excursion
7259 (save-restriction
7260 (widen)
7261 (delq nil
7262 (mapcar (lambda (o)
7263 (when (eq (overlay-get o 'invisible) 'outline)
7264 (setq beg (overlay-start o)
7265 end (overlay-end o))
7266 (and beg end (> end beg)
7267 (if use-markers
7268 (cons (copy-marker beg)
7269 (copy-marker end t))
7270 (cons beg end)))))
7271 (overlays-in (point-min) (point-max))))))))
7273 (defun org-set-outline-overlay-data (data)
7274 "Create visibility overlays for all positions in DATA.
7275 DATA should have been made by `org-outline-overlay-data'."
7276 (let (o)
7277 (save-excursion
7278 (save-restriction
7279 (widen)
7280 (show-all)
7281 (mapc (lambda (c)
7282 (outline-flag-region (car c) (cdr c) t))
7283 data)))))
7285 ;;; Folding of blocks
7287 (defvar org-hide-block-overlays nil
7288 "Overlays hiding blocks.")
7289 (make-variable-buffer-local 'org-hide-block-overlays)
7291 (defun org-block-map (function &optional start end)
7292 "Call FUNCTION at the head of all source blocks in the current buffer.
7293 Optional arguments START and END can be used to limit the range."
7294 (let ((start (or start (point-min)))
7295 (end (or end (point-max))))
7296 (save-excursion
7297 (goto-char start)
7298 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7299 (save-excursion
7300 (save-match-data
7301 (goto-char (match-beginning 0))
7302 (funcall function)))))))
7304 (defun org-hide-block-toggle-all ()
7305 "Toggle the visibility of all blocks in the current buffer."
7306 (org-block-map 'org-hide-block-toggle))
7308 (defun org-hide-block-all ()
7309 "Fold all blocks in the current buffer."
7310 (interactive)
7311 (org-show-block-all)
7312 (org-block-map 'org-hide-block-toggle-maybe))
7314 (defun org-show-block-all ()
7315 "Unfold all blocks in the current buffer."
7316 (interactive)
7317 (mapc 'delete-overlay org-hide-block-overlays)
7318 (setq org-hide-block-overlays nil))
7320 (defun org-hide-block-toggle-maybe ()
7321 "Toggle visibility of block at point.
7322 Unlike to `org-hide-block-toggle', this function does not throw
7323 an error. Return a non-nil value when toggling is successful."
7324 (interactive)
7325 (ignore-errors (org-hide-block-toggle)))
7327 (defun org-hide-block-toggle (&optional force)
7328 "Toggle the visibility of the current block.
7329 When optional argument FORCE is `off', make block visible. If it
7330 is non-nil, hide it unconditionally. Throw an error when not at
7331 a block. Return a non-nil value when toggling is successful."
7332 (interactive)
7333 (let ((element (org-element-at-point)))
7334 (unless (memq (org-element-type element)
7335 '(center-block comment-block dynamic-block example-block
7336 export-block quote-block special-block
7337 src-block verse-block))
7338 (user-error "Not at a block"))
7339 (let* ((start (save-excursion
7340 (goto-char (org-element-property :post-affiliated element))
7341 (line-end-position)))
7342 (end (save-excursion
7343 (goto-char (org-element-property :end element))
7344 (skip-chars-backward " \r\t\n")
7345 (line-end-position)))
7346 (overlays (overlays-at start)))
7347 (cond
7348 ;; Do nothing when not before or at the block opening line or
7349 ;; at the block closing line.
7350 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7351 ((and (not (eq force 'off))
7352 (not (memq t (mapcar
7353 (lambda (o)
7354 (eq (overlay-get o 'invisible) 'org-hide-block))
7355 overlays))))
7356 (let ((ov (make-overlay start end)))
7357 (overlay-put ov 'invisible 'org-hide-block)
7358 ;; Make the block accessible to `isearch'.
7359 (overlay-put
7360 ov 'isearch-open-invisible
7361 (lambda (ov)
7362 (when (memq ov org-hide-block-overlays)
7363 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7364 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7365 (delete-overlay ov))))
7366 (push ov org-hide-block-overlays)
7367 ;; When the block is hidden away, make sure point is left in
7368 ;; a visible part of the buffer.
7369 (when (> (line-beginning-position) start)
7370 (goto-char start)
7371 (beginning-of-line))
7372 ;; Signal successful toggling.
7374 ((or (not force) (eq force 'off))
7375 (dolist (ov overlays t)
7376 (when (memq ov org-hide-block-overlays)
7377 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7378 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7379 (delete-overlay ov))))))))
7381 ;; org-tab-after-check-for-cycling-hook
7382 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7383 ;; Remove overlays when changing major mode
7384 (add-hook 'org-mode-hook
7385 (lambda () (org-add-hook 'change-major-mode-hook
7386 'org-show-block-all 'append 'local)))
7388 ;;; Org-goto
7390 (defvar org-goto-window-configuration nil)
7391 (defvar org-goto-marker nil)
7392 (defvar org-goto-map)
7393 (defun org-goto-map ()
7394 "Set the keymap `org-goto'."
7395 (setq org-goto-map
7396 (let ((map (make-sparse-keymap)))
7397 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7398 mouse-drag-region universal-argument org-occur))
7399 cmd)
7400 (while (setq cmd (pop cmds))
7401 (substitute-key-definition cmd cmd map global-map)))
7402 (suppress-keymap map)
7403 (org-defkey map "\C-m" 'org-goto-ret)
7404 (org-defkey map [(return)] 'org-goto-ret)
7405 (org-defkey map [(left)] 'org-goto-left)
7406 (org-defkey map [(right)] 'org-goto-right)
7407 (org-defkey map [(control ?g)] 'org-goto-quit)
7408 (org-defkey map "\C-i" 'org-cycle)
7409 (org-defkey map [(tab)] 'org-cycle)
7410 (org-defkey map [(down)] 'outline-next-visible-heading)
7411 (org-defkey map [(up)] 'outline-previous-visible-heading)
7412 (if org-goto-auto-isearch
7413 (if (fboundp 'define-key-after)
7414 (define-key-after map [t] 'org-goto-local-auto-isearch)
7415 nil)
7416 (org-defkey map "q" 'org-goto-quit)
7417 (org-defkey map "n" 'outline-next-visible-heading)
7418 (org-defkey map "p" 'outline-previous-visible-heading)
7419 (org-defkey map "f" 'outline-forward-same-level)
7420 (org-defkey map "b" 'outline-backward-same-level)
7421 (org-defkey map "u" 'outline-up-heading))
7422 (org-defkey map "/" 'org-occur)
7423 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7424 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7425 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7426 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7427 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7428 map)))
7430 (defconst org-goto-help
7431 "Browse buffer copy, to find location or copy text.%s
7432 RET=jump to location C-g=quit and return to previous location
7433 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7435 (defvar org-goto-start-pos) ; dynamically scoped parameter
7437 (defun org-goto (&optional alternative-interface)
7438 "Look up a different location in the current file, keeping current visibility.
7440 When you want look-up or go to a different location in a
7441 document, the fastest way is often to fold the entire buffer and
7442 then dive into the tree. This method has the disadvantage, that
7443 the previous location will be folded, which may not be what you
7444 want.
7446 This command works around this by showing a copy of the current
7447 buffer in an indirect buffer, in overview mode. You can dive
7448 into the tree in that copy, use org-occur and incremental search
7449 to find a location. When pressing RET or `Q', the command
7450 returns to the original buffer in which the visibility is still
7451 unchanged. After RET it will also jump to the location selected
7452 in the indirect buffer and expose the headline hierarchy above.
7454 With a prefix argument, use the alternative interface: e.g. if
7455 `org-goto-interface' is 'outline use 'outline-path-completion."
7456 (interactive "P")
7457 (org-goto-map)
7458 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7459 (org-refile-use-outline-path t)
7460 (org-refile-target-verify-function nil)
7461 (interface
7462 (if (not alternative-interface)
7463 org-goto-interface
7464 (if (eq org-goto-interface 'outline)
7465 'outline-path-completion
7466 'outline)))
7467 (org-goto-start-pos (point))
7468 (selected-point
7469 (if (eq interface 'outline)
7470 (car (org-get-location (current-buffer) org-goto-help))
7471 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7472 (org-refile-check-position pa)
7473 (nth 3 pa)))))
7474 (if selected-point
7475 (progn
7476 (org-mark-ring-push org-goto-start-pos)
7477 (goto-char selected-point)
7478 (if (or (outline-invisible-p) (org-invisible-p2))
7479 (org-show-context 'org-goto)))
7480 (message "Quit"))))
7482 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7483 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7484 (defvar org-goto-local-auto-isearch-map) ; defined below
7486 (defun org-get-location (buf help)
7487 "Let the user select a location in the Org-mode buffer BUF.
7488 This function uses a recursive edit. It returns the selected position
7489 or nil."
7490 (org-no-popups
7491 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7492 (isearch-hide-immediately nil)
7493 (isearch-search-fun-function
7494 (lambda () 'org-goto-local-search-headings))
7495 (org-goto-selected-point org-goto-exit-command))
7496 (save-excursion
7497 (save-window-excursion
7498 (delete-other-windows)
7499 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7500 (org-pop-to-buffer-same-window
7501 (condition-case nil
7502 (make-indirect-buffer (current-buffer) "*org-goto*")
7503 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7504 (with-output-to-temp-buffer "*Org Help*"
7505 (princ (format help (if org-goto-auto-isearch
7506 " Just type for auto-isearch."
7507 " n/p/f/b/u to navigate, q to quit."))))
7508 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7509 (setq buffer-read-only nil)
7510 (let ((org-startup-truncated t)
7511 (org-startup-folded nil)
7512 (org-startup-align-all-tables nil))
7513 (org-mode)
7514 (org-overview))
7515 (setq buffer-read-only t)
7516 (if (and (boundp 'org-goto-start-pos)
7517 (integer-or-marker-p org-goto-start-pos))
7518 (progn (goto-char org-goto-start-pos)
7519 (when (outline-invisible-p)
7520 (org-show-set-visibility 'lineage)))
7521 (goto-char (point-min)))
7522 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7523 (message "Select location and press RET")
7524 (use-local-map org-goto-map)
7525 (recursive-edit)))
7526 (kill-buffer "*org-goto*")
7527 (cons org-goto-selected-point org-goto-exit-command))))
7529 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7530 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7531 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7532 (if (fboundp 'isearch-other-control-char)
7533 (progn
7534 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7535 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7536 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7537 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7538 (define-key org-goto-local-auto-isearch-map [return] nil))
7540 (defun org-goto-local-search-headings (string bound noerror)
7541 "Search and make sure that any matches are in headlines."
7542 (catch 'return
7543 (while (if isearch-forward
7544 (search-forward string bound noerror)
7545 (search-backward string bound noerror))
7546 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7547 (and (member :headline context)
7548 (not (member :tags context))))
7549 (throw 'return (point))))))
7551 (defun org-goto-local-auto-isearch ()
7552 "Start isearch."
7553 (interactive)
7554 (goto-char (point-min))
7555 (let ((keys (this-command-keys)))
7556 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7557 (isearch-mode t)
7558 (isearch-process-search-char (string-to-char keys)))))
7560 (defun org-goto-ret (&optional arg)
7561 "Finish `org-goto' by going to the new location."
7562 (interactive "P")
7563 (setq org-goto-selected-point (point)
7564 org-goto-exit-command 'return)
7565 (throw 'exit nil))
7567 (defun org-goto-left ()
7568 "Finish `org-goto' by going to the new location."
7569 (interactive)
7570 (if (org-at-heading-p)
7571 (progn
7572 (beginning-of-line 1)
7573 (setq org-goto-selected-point (point)
7574 org-goto-exit-command 'left)
7575 (throw 'exit nil))
7576 (user-error "Not on a heading")))
7578 (defun org-goto-right ()
7579 "Finish `org-goto' by going to the new location."
7580 (interactive)
7581 (if (org-at-heading-p)
7582 (progn
7583 (setq org-goto-selected-point (point)
7584 org-goto-exit-command 'right)
7585 (throw 'exit nil))
7586 (user-error "Not on a heading")))
7588 (defun org-goto-quit ()
7589 "Finish `org-goto' without cursor motion."
7590 (interactive)
7591 (setq org-goto-selected-point nil)
7592 (setq org-goto-exit-command 'quit)
7593 (throw 'exit nil))
7595 ;;; Indirect buffer display of subtrees
7597 (defvar org-indirect-dedicated-frame nil
7598 "This is the frame being used for indirect tree display.")
7599 (defvar org-last-indirect-buffer nil)
7601 (defun org-tree-to-indirect-buffer (&optional arg)
7602 "Create indirect buffer and narrow it to current subtree.
7603 With a numerical prefix ARG, go up to this level and then take that tree.
7604 If ARG is negative, go up that many levels.
7606 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7607 indirect buffer previously made with this command, to avoid proliferation of
7608 indirect buffers. However, when you call the command with a \
7609 \\[universal-argument] prefix, or
7610 when `org-indirect-buffer-display' is `new-frame', the last buffer
7611 is kept so that you can work with several indirect buffers at the same time.
7612 If `org-indirect-buffer-display' is `dedicated-frame', the \
7613 \\[universal-argument] prefix also
7614 requests that a new frame be made for the new buffer, so that the dedicated
7615 frame is not changed."
7616 (interactive "P")
7617 (let ((cbuf (current-buffer))
7618 (cwin (selected-window))
7619 (pos (point))
7620 beg end level heading ibuf)
7621 (save-excursion
7622 (org-back-to-heading t)
7623 (when (numberp arg)
7624 (setq level (org-outline-level))
7625 (if (< arg 0) (setq arg (+ level arg)))
7626 (while (> (setq level (org-outline-level)) arg)
7627 (org-up-heading-safe)))
7628 (setq beg (point)
7629 heading (org-get-heading))
7630 (org-end-of-subtree t t)
7631 (if (org-at-heading-p) (backward-char 1))
7632 (setq end (point)))
7633 (if (and (buffer-live-p org-last-indirect-buffer)
7634 (not (eq org-indirect-buffer-display 'new-frame))
7635 (not arg))
7636 (kill-buffer org-last-indirect-buffer))
7637 (setq ibuf (org-get-indirect-buffer cbuf heading)
7638 org-last-indirect-buffer ibuf)
7639 (cond
7640 ((or (eq org-indirect-buffer-display 'new-frame)
7641 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7642 (select-frame (make-frame))
7643 (delete-other-windows)
7644 (org-pop-to-buffer-same-window ibuf)
7645 (org-set-frame-title heading))
7646 ((eq org-indirect-buffer-display 'dedicated-frame)
7647 (raise-frame
7648 (select-frame (or (and org-indirect-dedicated-frame
7649 (frame-live-p org-indirect-dedicated-frame)
7650 org-indirect-dedicated-frame)
7651 (setq org-indirect-dedicated-frame (make-frame)))))
7652 (delete-other-windows)
7653 (org-pop-to-buffer-same-window ibuf)
7654 (org-set-frame-title (concat "Indirect: " heading)))
7655 ((eq org-indirect-buffer-display 'current-window)
7656 (org-pop-to-buffer-same-window ibuf))
7657 ((eq org-indirect-buffer-display 'other-window)
7658 (pop-to-buffer ibuf))
7659 (t (error "Invalid value")))
7660 (if (featurep 'xemacs)
7661 (save-excursion (org-mode) (turn-on-font-lock)))
7662 (narrow-to-region beg end)
7663 (show-all)
7664 (goto-char pos)
7665 (run-hook-with-args 'org-cycle-hook 'all)
7666 (and (window-live-p cwin) (select-window cwin))))
7668 (defun org-get-indirect-buffer (&optional buffer heading)
7669 (setq buffer (or buffer (current-buffer)))
7670 (let ((n 1) (base (buffer-name buffer)) bname)
7671 (while (buffer-live-p
7672 (get-buffer
7673 (setq bname
7674 (concat base "-"
7675 (if heading (concat heading "-" (number-to-string n))
7676 (number-to-string n))))))
7677 (setq n (1+ n)))
7678 (condition-case nil
7679 (make-indirect-buffer buffer bname 'clone)
7680 (error (make-indirect-buffer buffer bname)))))
7682 (defun org-set-frame-title (title)
7683 "Set the title of the current frame to the string TITLE."
7684 ;; FIXME: how to name a single frame in XEmacs???
7685 (unless (featurep 'xemacs)
7686 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7688 ;;;; Structure editing
7690 ;;; Inserting headlines
7692 (defun org-previous-line-empty-p (&optional next)
7693 "Is the previous line a blank line?
7694 When NEXT is non-nil, check the next line instead."
7695 (save-excursion
7696 (and (not (bobp))
7697 (or (beginning-of-line (if next 2 0)) t)
7698 (save-match-data
7699 (looking-at "[ \t]*$")))))
7701 (defun org-insert-heading (&optional arg invisible-ok top-level)
7702 "Insert a new heading or an item with the same depth at point.
7704 If point is at the beginning of a heading or a list item, insert
7705 a new heading or a new item above the current one. If point is
7706 at the beginning of a normal line, turn the line into a heading.
7708 If point is in the middle of a headline or a list item, split the
7709 headline or the item and create a new headline/item with the text
7710 in the current line after point \(see `org-M-RET-may-split-line'
7711 on how to modify this behavior).
7713 With one universal prefix argument, set the user option
7714 `org-insert-heading-respect-content' to t for the duration of
7715 the command. This modifies the behavior described above in this
7716 ways: on list items and at the beginning of normal lines, force
7717 the insertion of a heading after the current subtree.
7719 With two universal prefix arguments, insert the heading at the
7720 end of the grandparent subtree. For example, if point is within
7721 a 2nd-level heading, then it will insert a 2nd-level heading at
7722 the end of the 1st-level parent heading.
7724 If point is at the beginning of a headline, insert a sibling
7725 before the current headline. If point is not at the beginning,
7726 split the line and create a new headline with the text in the
7727 current line after point \(see `org-M-RET-may-split-line' on how
7728 to modify this behavior).
7730 If point is at the beginning of a normal line, turn this line
7731 into a heading.
7733 When INVISIBLE-OK is set, stop at invisible headlines when going
7734 back. This is important for non-interactive uses of the
7735 command.
7737 When optional argument TOP-LEVEL is non-nil, insert a level 1
7738 heading, unconditionally."
7739 (interactive "P")
7740 (if (org-called-interactively-p 'any) (org-reveal))
7741 (let ((itemp (and (not top-level) (org-in-item-p)))
7742 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7743 (respect-content (or org-insert-heading-respect-content
7744 (equal arg '(4))))
7745 (initial-content ""))
7747 (cond
7749 ((or (= (buffer-size) 0)
7750 (and (not (save-excursion
7751 (and (ignore-errors (org-back-to-heading invisible-ok))
7752 (org-at-heading-p))))
7753 (or arg (not itemp))))
7754 ;; At beginning of buffer or so high up that only a heading
7755 ;; makes sense.
7756 (cond ((and (bolp) (not respect-content)) (insert "* "))
7757 ((not respect-content)
7758 (unless may-split (end-of-line))
7759 (insert "\n* "))
7760 ((re-search-forward org-outline-regexp-bol nil t)
7761 (beginning-of-line)
7762 (insert "* \n")
7763 (backward-char))
7764 (t (goto-char (point-max))
7765 (insert "\n* ")))
7766 (run-hooks 'org-insert-heading-hook))
7768 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7771 ;; Maybe move at the end of the subtree
7772 (when (equal arg '(16))
7773 (org-up-heading-safe)
7774 (org-end-of-subtree t))
7775 ;; Insert a heading
7776 (save-restriction
7777 (widen)
7778 (let* ((level nil)
7779 (on-heading (org-at-heading-p))
7780 (empty-line-p (if on-heading
7781 (org-previous-line-empty-p)
7782 ;; We will decide later
7783 nil))
7784 ;; Get a level string to fall back on.
7785 (fix-level
7786 (if (org-before-first-heading-p) "*"
7787 (save-excursion
7788 (org-back-to-heading t)
7789 (if (org-previous-line-empty-p) (setq empty-line-p t))
7790 (looking-at org-outline-regexp)
7791 (make-string (1- (length (match-string 0))) ?*))))
7792 (stars
7793 (save-excursion
7794 (condition-case nil
7795 (if top-level "* "
7796 (org-back-to-heading invisible-ok)
7797 (when (and (not on-heading)
7798 (featurep 'org-inlinetask)
7799 (integerp org-inlinetask-min-level)
7800 (>= (length (match-string 0))
7801 org-inlinetask-min-level))
7802 ;; Find a heading level before the inline
7803 ;; task.
7804 (while (and (setq level (org-up-heading-safe))
7805 (>= level org-inlinetask-min-level)))
7806 (if (org-at-heading-p)
7807 (org-back-to-heading invisible-ok)
7808 (error "This should not happen")))
7809 (unless (and (save-excursion
7810 (save-match-data
7811 (org-backward-heading-same-level
7812 1 invisible-ok))
7813 (= (point) (match-beginning 0)))
7814 (not (org-previous-line-empty-p t)))
7815 (setq empty-line-p (or empty-line-p
7816 (org-previous-line-empty-p))))
7817 (match-string 0))
7818 (error (or fix-level "* ")))))
7819 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7820 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7821 pos hide-previous previous-pos)
7823 ;; If we insert after content, move there and clean up
7824 ;; whitespace.
7825 (when (and respect-content
7826 (not (org-looking-at-p org-outline-regexp-bol)))
7827 (if (not (org-before-first-heading-p))
7828 (org-end-of-subtree nil t)
7829 (re-search-forward org-outline-regexp-bol)
7830 (beginning-of-line 0))
7831 (skip-chars-backward " \r\t\n")
7832 (and (not (looking-back "^\\*+"))
7833 (looking-at "[ \t]+") (replace-match ""))
7834 (unless (eobp) (forward-char 1))
7835 (when (looking-at "^\\*")
7836 (unless (bobp) (backward-char 1))
7837 (insert "\n")))
7839 ;; If we are splitting, grab the text that should be moved
7840 ;; to the new headline.
7841 (when may-split
7842 (if (org-on-heading-p)
7843 ;; This is a heading: split intelligently (keeping
7844 ;; tags).
7845 (let ((pos (point)))
7846 (beginning-of-line)
7847 (unless (looking-at org-complex-heading-regexp)
7848 (error "This should not happen"))
7849 (when (and (match-beginning 4)
7850 (> pos (match-beginning 4))
7851 (< pos (match-end 4)))
7852 (setq initial-content (buffer-substring pos (match-end 4)))
7853 (goto-char pos)
7854 (delete-region (point) (match-end 4))
7855 (if (looking-at "[ \t]*$")
7856 (replace-match "")
7857 (insert (make-string (length initial-content) ?\s)))
7858 (setq initial-content (org-trim initial-content)))
7859 (goto-char pos))
7860 ;; A normal line.
7861 (setq initial-content
7862 (org-trim
7863 (delete-and-extract-region (point) (line-end-position))))))
7865 ;; If we are at the beginning of the line, insert before it.
7866 ;; Otherwise, after it.
7867 (cond
7868 ((and (bolp) (looking-at "[ \t]*$")))
7869 ((bolp) (save-excursion (insert "\n")))
7870 (t (end-of-line)
7871 (insert "\n")))
7873 ;; Insert the new heading
7874 (insert stars)
7875 (just-one-space)
7876 (insert initial-content)
7877 (unless (and blank (org-previous-line-empty-p))
7878 (org-N-empty-lines-before-current (if blank 1 0)))
7879 ;; Adjust visibility, which may be messed up if we removed
7880 ;; blank lines while previous entry was hidden.
7881 (let ((bol (line-beginning-position)))
7882 (dolist (o (overlays-at (1- bol)))
7883 (when (and (eq (overlay-get o 'invisible) 'outline)
7884 (eq (overlay-end o) bol))
7885 (move-overlay o (overlay-start o) (1- bol)))))
7886 (run-hooks 'org-insert-heading-hook)))))))
7888 (defun org-N-empty-lines-before-current (N)
7889 "Make the number of empty lines before current exactly N.
7890 So this will delete or add empty lines."
7891 (save-excursion
7892 (beginning-of-line)
7893 (let ((p (point)))
7894 (skip-chars-backward " \r\t\n")
7895 (unless (bolp) (forward-line))
7896 (delete-region (point) p))
7897 (when (> N 0) (insert (make-string N ?\n)))))
7899 (defun org-get-heading (&optional no-tags no-todo)
7900 "Return the heading of the current entry, without the stars.
7901 When NO-TAGS is non-nil, don't include tags.
7902 When NO-TODO is non-nil, don't include TODO keywords."
7903 (save-excursion
7904 (org-back-to-heading t)
7905 (cond
7906 ((and no-tags no-todo)
7907 (looking-at org-complex-heading-regexp)
7908 (match-string 4))
7909 (no-tags
7910 (looking-at (concat org-outline-regexp
7911 "\\(.*?\\)"
7912 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7913 (match-string 1))
7914 (no-todo
7915 (looking-at org-todo-line-regexp)
7916 (match-string 3))
7917 (t (looking-at org-heading-regexp)
7918 (match-string 2)))))
7920 (defvar orgstruct-mode) ; defined below
7922 (defun org-heading-components ()
7923 "Return the components of the current heading.
7924 This is a list with the following elements:
7925 - the level as an integer
7926 - the reduced level, different if `org-odd-levels-only' is set.
7927 - the TODO keyword, or nil
7928 - the priority character, like ?A, or nil if no priority is given
7929 - the headline text itself, or the tags string if no headline text
7930 - the tags string, or nil."
7931 (save-excursion
7932 (org-back-to-heading t)
7933 (if (let (case-fold-search)
7934 (looking-at
7935 (if orgstruct-mode
7936 org-heading-regexp
7937 org-complex-heading-regexp)))
7938 (if orgstruct-mode
7939 (list (length (match-string 1))
7940 (org-reduced-level (length (match-string 1)))
7943 (match-string 2)
7944 nil)
7945 (list (length (match-string 1))
7946 (org-reduced-level (length (match-string 1)))
7947 (org-match-string-no-properties 2)
7948 (and (match-end 3) (aref (match-string 3) 2))
7949 (org-match-string-no-properties 4)
7950 (org-match-string-no-properties 5))))))
7952 (defun org-get-entry ()
7953 "Get the entry text, after heading, entire subtree."
7954 (save-excursion
7955 (org-back-to-heading t)
7956 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7958 (defun org-insert-heading-after-current ()
7959 "Insert a new heading with same level as current, after current subtree."
7960 (interactive)
7961 (org-back-to-heading)
7962 (org-insert-heading)
7963 (org-move-subtree-down)
7964 (end-of-line 1))
7966 (defun org-insert-heading-respect-content (&optional invisible-ok)
7967 "Insert heading with `org-insert-heading-respect-content' set to t."
7968 (interactive)
7969 (org-insert-heading '(4) invisible-ok))
7971 (defun org-insert-todo-heading-respect-content (&optional force-state)
7972 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7973 (interactive)
7974 (org-insert-todo-heading force-state '(4)))
7976 (defun org-insert-todo-heading (arg &optional force-heading)
7977 "Insert a new heading with the same level and TODO state as current heading.
7978 If the heading has no TODO state, or if the state is DONE, use the first
7979 state (TODO by default). Also with one prefix arg, force first state. With
7980 two prefix args, force inserting at the end of the parent subtree."
7981 (interactive "P")
7982 (when (or force-heading (not (org-insert-item 'checkbox)))
7983 (org-insert-heading (or (and (equal arg '(16)) '(16))
7984 force-heading))
7985 (save-excursion
7986 (org-back-to-heading)
7987 (outline-previous-heading)
7988 (looking-at org-todo-line-regexp))
7989 (let*
7990 ((new-mark-x
7991 (if (or (equal arg '(4))
7992 (not (match-beginning 2))
7993 (member (match-string 2) org-done-keywords))
7994 (car org-todo-keywords-1)
7995 (match-string 2)))
7996 (new-mark
7998 (run-hook-with-args-until-success
7999 'org-todo-get-default-hook new-mark-x nil)
8000 new-mark-x)))
8001 (beginning-of-line 1)
8002 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8003 (if org-treat-insert-todo-heading-as-state-change
8004 (org-todo new-mark)
8005 (insert new-mark " "))))
8006 (when org-provide-todo-statistics
8007 (org-update-parent-todo-statistics))))
8009 (defun org-insert-subheading (arg)
8010 "Insert a new subheading and demote it.
8011 Works for outline headings and for plain lists alike."
8012 (interactive "P")
8013 (org-insert-heading arg)
8014 (cond
8015 ((org-at-heading-p) (org-do-demote))
8016 ((org-at-item-p) (org-indent-item))))
8018 (defun org-insert-todo-subheading (arg)
8019 "Insert a new subheading with TODO keyword or checkbox and demote it.
8020 Works for outline headings and for plain lists alike."
8021 (interactive "P")
8022 (org-insert-todo-heading arg)
8023 (cond
8024 ((org-at-heading-p) (org-do-demote))
8025 ((org-at-item-p) (org-indent-item))))
8027 ;;; Promotion and Demotion
8029 (defvar org-after-demote-entry-hook nil
8030 "Hook run after an entry has been demoted.
8031 The cursor will be at the beginning of the entry.
8032 When a subtree is being demoted, the hook will be called for each node.")
8034 (defvar org-after-promote-entry-hook nil
8035 "Hook run after an entry has been promoted.
8036 The cursor will be at the beginning of the entry.
8037 When a subtree is being promoted, the hook will be called for each node.")
8039 (defun org-promote-subtree ()
8040 "Promote the entire subtree.
8041 See also `org-promote'."
8042 (interactive)
8043 (save-excursion
8044 (org-with-limited-levels (org-map-tree 'org-promote)))
8045 (org-fix-position-after-promote))
8047 (defun org-demote-subtree ()
8048 "Demote the entire subtree. See `org-demote'.
8049 See also `org-promote'."
8050 (interactive)
8051 (save-excursion
8052 (org-with-limited-levels (org-map-tree 'org-demote)))
8053 (org-fix-position-after-promote))
8056 (defun org-do-promote ()
8057 "Promote the current heading higher up the tree.
8058 If the region is active in `transient-mark-mode', promote all headings
8059 in the region."
8060 (interactive)
8061 (save-excursion
8062 (if (org-region-active-p)
8063 (org-map-region 'org-promote (region-beginning) (region-end))
8064 (org-promote)))
8065 (org-fix-position-after-promote))
8067 (defun org-do-demote ()
8068 "Demote the current heading lower down the tree.
8069 If the region is active in `transient-mark-mode', demote all headings
8070 in the region."
8071 (interactive)
8072 (save-excursion
8073 (if (org-region-active-p)
8074 (org-map-region 'org-demote (region-beginning) (region-end))
8075 (org-demote)))
8076 (org-fix-position-after-promote))
8078 (defun org-fix-position-after-promote ()
8079 "Make sure that after pro/demotion cursor position is right."
8080 (let ((pos (point)))
8081 (when (save-excursion
8082 (beginning-of-line 1)
8083 (looking-at org-todo-line-regexp)
8084 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8085 (cond ((eobp) (insert " "))
8086 ((eolp) (insert " "))
8087 ((equal (char-after) ?\ ) (forward-char 1))))))
8089 (defun org-current-level ()
8090 "Return the level of the current entry, or nil if before the first headline.
8091 The level is the number of stars at the beginning of the
8092 headline. Use `org-reduced-level' to remove the effect of
8093 `org-odd-levels'. Unlike to `org-outline-level', this function
8094 ignores inlinetasks."
8095 (let ((level (org-with-limited-levels (org-outline-level))))
8096 (and (> level 0) level)))
8098 (defun org-get-previous-line-level ()
8099 "Return the outline depth of the last headline before the current line.
8100 Returns 0 for the first headline in the buffer, and nil if before the
8101 first headline."
8102 (and (org-current-level)
8103 (or (and (/= (line-beginning-position) (point-min))
8104 (save-excursion (beginning-of-line 0) (org-current-level)))
8105 0)))
8107 (defun org-reduced-level (l)
8108 "Compute the effective level of a heading.
8109 This takes into account the setting of `org-odd-levels-only'."
8110 (cond
8111 ((zerop l) 0)
8112 (org-odd-levels-only (1+ (floor (/ l 2))))
8113 (t l)))
8115 (defun org-level-increment ()
8116 "Return the number of stars that will be added or removed at a
8117 time to headlines when structure editing, based on the value of
8118 `org-odd-levels-only'."
8119 (if org-odd-levels-only 2 1))
8121 (defun org-get-valid-level (level &optional change)
8122 "Rectify a level change under the influence of `org-odd-levels-only'
8123 LEVEL is a current level, CHANGE is by how much the level should be
8124 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8125 even level numbers will become the next higher odd number."
8126 (if org-odd-levels-only
8127 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8128 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8129 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8130 (max 1 (+ level (or change 0)))))
8132 (if (boundp 'define-obsolete-function-alias)
8133 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8134 (define-obsolete-function-alias 'org-get-legal-level
8135 'org-get-valid-level)
8136 (define-obsolete-function-alias 'org-get-legal-level
8137 'org-get-valid-level "23.1")))
8139 (defun org-promote ()
8140 "Promote the current heading higher up the tree."
8141 (org-with-wide-buffer
8142 (org-back-to-heading t)
8143 (let* ((after-change-functions (remq 'flyspell-after-change-function
8144 after-change-functions))
8145 (level (save-match-data (funcall outline-level)))
8146 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8147 (diff (abs (- level (length up-head) -1))))
8148 (cond
8149 ((and (= level 1) org-allow-promoting-top-level-subtree)
8150 (replace-match "# " nil t))
8151 ((= level 1)
8152 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8153 (t (replace-match up-head nil t)))
8154 (unless (= level 1)
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-promote-entry-hook))))
8159 (defun org-demote ()
8160 "Demote the current heading lower down the tree."
8161 (org-with-wide-buffer
8162 (org-back-to-heading t)
8163 (let* ((after-change-functions (remq 'flyspell-after-change-function
8164 after-change-functions))
8165 (level (save-match-data (funcall outline-level)))
8166 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8167 (diff (abs (- level (length down-head) -1))))
8168 (replace-match down-head nil t)
8169 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8170 (when org-adapt-indentation (org-fixup-indentation diff))
8171 (run-hooks 'org-after-demote-entry-hook))))
8173 (defun org-cycle-level ()
8174 "Cycle the level of an empty headline through possible states.
8175 This goes first to child, then to parent, level, then up the hierarchy.
8176 After top level, it switches back to sibling level."
8177 (interactive)
8178 (let ((org-adapt-indentation nil))
8179 (when (org-point-at-end-of-empty-headline)
8180 (setq this-command 'org-cycle-level) ; Only needed for caching
8181 (let ((cur-level (org-current-level))
8182 (prev-level (org-get-previous-line-level)))
8183 (cond
8184 ;; If first headline in file, promote to top-level.
8185 ((= prev-level 0)
8186 (loop repeat (/ (- cur-level 1) (org-level-increment))
8187 do (org-do-promote)))
8188 ;; If same level as prev, demote one.
8189 ((= prev-level cur-level)
8190 (org-do-demote))
8191 ;; If parent is top-level, promote to top level if not already.
8192 ((= prev-level 1)
8193 (loop repeat (/ (- cur-level 1) (org-level-increment))
8194 do (org-do-promote)))
8195 ;; If top-level, return to prev-level.
8196 ((= cur-level 1)
8197 (loop repeat (/ (- prev-level 1) (org-level-increment))
8198 do (org-do-demote)))
8199 ;; If less than prev-level, promote one.
8200 ((< cur-level prev-level)
8201 (org-do-promote))
8202 ;; If deeper than prev-level, promote until higher than
8203 ;; prev-level.
8204 ((> cur-level prev-level)
8205 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8206 do (org-do-promote))))
8207 t))))
8209 (defun org-map-tree (fun)
8210 "Call FUN for every heading underneath the current one."
8211 (org-back-to-heading)
8212 (let ((level (funcall outline-level)))
8213 (save-excursion
8214 (funcall fun)
8215 (while (and (progn
8216 (outline-next-heading)
8217 (> (funcall outline-level) level))
8218 (not (eobp)))
8219 (funcall fun)))))
8221 (defun org-map-region (fun beg end)
8222 "Call FUN for every heading between BEG and END."
8223 (let ((org-ignore-region t))
8224 (save-excursion
8225 (setq end (copy-marker end))
8226 (goto-char beg)
8227 (if (and (re-search-forward org-outline-regexp-bol nil t)
8228 (< (point) end))
8229 (funcall fun))
8230 (while (and (progn
8231 (outline-next-heading)
8232 (< (point) end))
8233 (not (eobp)))
8234 (funcall fun)))))
8236 (defun org-fixup-indentation (diff)
8237 "Change the indentation in the current entry by DIFF.
8239 DIFF is an integer. Indentation is done according to the
8240 following rules:
8242 - Planning information and property drawers are always indented
8243 according to the new level of the headline;
8245 - Footnote definitions and their contents are ignored;
8247 - Inlinetasks' boundaries are not shifted;
8249 - Empty lines are ignored;
8251 - Other lines' indentation are shifted by DIFF columns, unless
8252 it would introduce a structural change in the document, in
8253 which case no shifting is done at all.
8255 Assume point is at a heading or an inlinetask beginning."
8256 (org-with-wide-buffer
8257 (narrow-to-region (line-beginning-position)
8258 (save-excursion
8259 (if (org-with-limited-levels (org-at-heading-p))
8260 (org-with-limited-levels (outline-next-heading))
8261 (org-inlinetask-goto-end))
8262 (point)))
8263 (forward-line)
8264 ;; Indent properly planning info and property drawer.
8265 (when (org-looking-at-p org-planning-line-re)
8266 (org-indent-line)
8267 (forward-line))
8268 (when (looking-at org-property-drawer-re)
8269 (goto-char (match-end 0))
8270 (forward-line)
8271 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8272 (catch 'no-shift
8273 (when (zerop diff) (throw 'no-shift nil))
8274 ;; If DIFF is negative, first check if a shift is possible at all
8275 ;; (e.g., it doesn't break structure). This can only happen if
8276 ;; some contents are not properly indented.
8277 (let ((case-fold-search t))
8278 (when (< diff 0)
8279 (let ((diff (- diff))
8280 (forbidden-re (concat org-outline-regexp
8281 "\\|"
8282 (substring org-footnote-definition-re 1))))
8283 (save-excursion
8284 (while (not (eobp))
8285 (cond
8286 ((org-looking-at-p "[ \t]*$") (forward-line))
8287 ((and (org-looking-at-p org-footnote-definition-re)
8288 (let ((e (org-element-at-point)))
8289 (and (eq (org-element-type e) 'footnote-definition)
8290 (goto-char (org-element-property :end e))))))
8291 ((org-looking-at-p org-outline-regexp) (forward-line))
8292 ;; Give up if shifting would move before column 0 or
8293 ;; if it would introduce a headline or a footnote
8294 ;; definition.
8296 (skip-chars-forward " \t")
8297 (let ((ind (current-column)))
8298 (when (or (< ind diff)
8299 (and (= ind diff) (org-looking-at-p forbidden-re)))
8300 (throw 'no-shift nil)))
8301 ;; Ignore contents of example blocks and source
8302 ;; blocks if their indentation is meant to be
8303 ;; preserved. Jump to block's closing line.
8304 (beginning-of-line)
8305 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8306 (let ((e (org-element-at-point)))
8307 (and (memq (org-element-type e)
8308 '(example-block src-block))
8309 (or org-src-preserve-indentation
8310 (org-element-property :preserve-indent e))
8311 (goto-char (org-element-property :end e))
8312 (progn (skip-chars-backward " \r\t\n")
8313 (beginning-of-line)
8314 t))))
8315 (forward-line))))))))
8316 ;; Shift lines but footnote definitions, inlinetasks boundaries
8317 ;; by DIFF. Also skip contents of source or example blocks
8318 ;; when indentation is meant to be preserved.
8319 (while (not (eobp))
8320 (cond
8321 ((and (org-looking-at-p org-footnote-definition-re)
8322 (let ((e (org-element-at-point)))
8323 (and (eq (org-element-type e) 'footnote-definition)
8324 (goto-char (org-element-property :end e))))))
8325 ((org-looking-at-p org-outline-regexp) (forward-line))
8326 ((org-looking-at-p "[ \t]*$") (forward-line))
8328 (org-indent-line-to (+ (org-get-indentation) diff))
8329 (beginning-of-line)
8330 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8331 (let ((e (org-element-at-point)))
8332 (and (memq (org-element-type e)
8333 '(example-block src-block))
8334 (or org-src-preserve-indentation
8335 (org-element-property :preserve-indent e))
8336 (goto-char (org-element-property :end e))
8337 (progn (skip-chars-backward " \r\t\n")
8338 (beginning-of-line)
8339 t))))
8340 (forward-line)))))))))
8342 (defun org-convert-to-odd-levels ()
8343 "Convert an org-mode file with all levels allowed to one with odd levels.
8344 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8345 level 5 etc."
8346 (interactive)
8347 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8348 (let ((outline-level 'org-outline-level)
8349 (org-odd-levels-only nil) n)
8350 (save-excursion
8351 (goto-char (point-min))
8352 (while (re-search-forward "^\\*\\*+ " nil t)
8353 (setq n (- (length (match-string 0)) 2))
8354 (while (>= (setq n (1- n)) 0)
8355 (org-demote))
8356 (end-of-line 1))))))
8358 (defun org-convert-to-oddeven-levels ()
8359 "Convert an org-mode file with only odd levels to one with odd/even levels.
8360 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8361 file contains a section with an even level, conversion would
8362 destroy the structure of the file. An error is signaled in this
8363 case."
8364 (interactive)
8365 (goto-char (point-min))
8366 ;; First check if there are no even levels
8367 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8368 (org-show-set-visibility 'canonical)
8369 (error "Not all levels are odd in this file. Conversion not possible"))
8370 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8371 (let ((outline-regexp org-outline-regexp)
8372 (outline-level 'org-outline-level)
8373 (org-odd-levels-only nil) n)
8374 (save-excursion
8375 (goto-char (point-min))
8376 (while (re-search-forward "^\\*\\*+ " nil t)
8377 (setq n (/ (1- (length (match-string 0))) 2))
8378 (while (>= (setq n (1- n)) 0)
8379 (org-promote))
8380 (end-of-line 1))))))
8382 (defun org-tr-level (n)
8383 "Make N odd if required."
8384 (if org-odd-levels-only (1+ (/ n 2)) n))
8386 ;;; Vertical tree motion, cutting and pasting of subtrees
8388 (defun org-move-subtree-up (&optional arg)
8389 "Move the current subtree up past ARG headlines of the same level."
8390 (interactive "p")
8391 (org-move-subtree-down (- (prefix-numeric-value arg))))
8393 (defun org-move-subtree-down (&optional arg)
8394 "Move the current subtree down past ARG headlines of the same level."
8395 (interactive "p")
8396 (setq arg (prefix-numeric-value arg))
8397 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8398 'org-get-last-sibling))
8399 (ins-point (make-marker))
8400 (cnt (abs arg))
8401 (col (current-column))
8402 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8403 ;; Select the tree
8404 (org-back-to-heading)
8405 (setq beg0 (point))
8406 (save-excursion
8407 (setq ne-beg (org-back-over-empty-lines))
8408 (setq beg (point)))
8409 (save-match-data
8410 (save-excursion (outline-end-of-heading)
8411 (setq folded (outline-invisible-p)))
8412 (progn (org-end-of-subtree nil t)
8413 (unless (eobp) (backward-char))))
8414 (outline-next-heading)
8415 (setq ne-end (org-back-over-empty-lines))
8416 (setq end (point))
8417 (goto-char beg0)
8418 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8419 ;; include less whitespace
8420 (save-excursion
8421 (goto-char beg)
8422 (forward-line (- ne-beg ne-end))
8423 (setq beg (point))))
8424 ;; Find insertion point, with error handling
8425 (while (> cnt 0)
8426 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8427 (progn (goto-char beg0)
8428 (user-error "Cannot move past superior level or buffer limit")))
8429 (setq cnt (1- cnt)))
8430 (if (> arg 0)
8431 ;; Moving forward - still need to move over subtree
8432 (progn (org-end-of-subtree t t)
8433 (save-excursion
8434 (org-back-over-empty-lines)
8435 (or (bolp) (newline)))))
8436 (setq ne-ins (org-back-over-empty-lines))
8437 (move-marker ins-point (point))
8438 (setq txt (buffer-substring beg end))
8439 (org-save-markers-in-region beg end)
8440 (delete-region beg end)
8441 (org-remove-empty-overlays-at beg)
8442 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8443 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8444 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8445 (let ((bbb (point)))
8446 (insert-before-markers txt)
8447 (org-reinstall-markers-in-region bbb)
8448 (move-marker ins-point bbb))
8449 (or (bolp) (insert "\n"))
8450 (setq ins-end (point))
8451 (goto-char ins-point)
8452 (org-skip-whitespace)
8453 (when (and (< arg 0)
8454 (org-first-sibling-p)
8455 (> ne-ins ne-beg))
8456 ;; Move whitespace back to beginning
8457 (save-excursion
8458 (goto-char ins-end)
8459 (let ((kill-whole-line t))
8460 (kill-line (- ne-ins ne-beg)) (point)))
8461 (insert (make-string (- ne-ins ne-beg) ?\n)))
8462 (move-marker ins-point nil)
8463 (if folded
8464 (hide-subtree)
8465 (org-show-entry)
8466 (show-children)
8467 (org-cycle-hide-drawers 'children))
8468 (org-clean-visibility-after-subtree-move)
8469 ;; move back to the initial column we were at
8470 (move-to-column col)))
8472 (defvar org-subtree-clip ""
8473 "Clipboard for cut and paste of subtrees.
8474 This is actually only a copy of the kill, because we use the normal kill
8475 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8477 (defvar org-subtree-clip-folded nil
8478 "Was the last copied subtree folded?
8479 This is used to fold the tree back after pasting.")
8481 (defun org-cut-subtree (&optional n)
8482 "Cut the current subtree into the clipboard.
8483 With prefix arg N, cut this many sequential subtrees.
8484 This is a short-hand for marking the subtree and then cutting it."
8485 (interactive "p")
8486 (org-copy-subtree n 'cut))
8488 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8489 "Copy the current subtree it in the clipboard.
8490 With prefix arg N, copy this many sequential subtrees.
8491 This is a short-hand for marking the subtree and then copying it.
8492 If CUT is non-nil, actually cut the subtree.
8493 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8494 of some markers in the region, even if CUT is non-nil. This is
8495 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8496 (interactive "p")
8497 (let (beg end folded (beg0 (point)))
8498 (if (org-called-interactively-p 'any)
8499 (org-back-to-heading nil) ; take what looks like a subtree
8500 (org-back-to-heading t)) ; take what is really there
8501 (setq beg (point))
8502 (skip-chars-forward " \t\r\n")
8503 (save-match-data
8504 (if nosubtrees
8505 (outline-next-heading)
8506 (save-excursion (outline-end-of-heading)
8507 (setq folded (outline-invisible-p)))
8508 (ignore-errors (org-forward-heading-same-level (1- n) t))
8509 (org-end-of-subtree t t)))
8510 ;; Include the end of an inlinetask
8511 (when (and (featurep 'org-inlinetask)
8512 (looking-at-p (concat (org-inlinetask-outline-regexp)
8513 "END[ \t]*$")))
8514 (end-of-line))
8515 (setq end (point))
8516 (goto-char beg0)
8517 (when (> end beg)
8518 (setq org-subtree-clip-folded folded)
8519 (when (or cut force-store-markers)
8520 (org-save-markers-in-region beg end))
8521 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8522 (setq org-subtree-clip (current-kill 0))
8523 (message "%s: Subtree(s) with %d characters"
8524 (if cut "Cut" "Copied")
8525 (length org-subtree-clip)))))
8527 (defun org-paste-subtree (&optional level tree for-yank remove)
8528 "Paste the clipboard as a subtree, with modification of headline level.
8529 The entire subtree is promoted or demoted in order to match a new headline
8530 level.
8532 If the cursor is at the beginning of a headline, the same level as
8533 that headline is used to paste the tree.
8535 If not, the new level is derived from the *visible* headings
8536 before and after the insertion point, and taken to be the inferior headline
8537 level of the two. So if the previous visible heading is level 3 and the
8538 next is level 4 (or vice versa), level 4 will be used for insertion.
8539 This makes sure that the subtree remains an independent subtree and does
8540 not swallow low level entries.
8542 You can also force a different level, either by using a numeric prefix
8543 argument, or by inserting the heading marker by hand. For example, if the
8544 cursor is after \"*****\", then the tree will be shifted to level 5.
8546 If optional TREE is given, use this text instead of the kill ring.
8548 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8549 move back over whitespace before inserting, and move point to the end of
8550 the inserted text when done.
8552 When REMOVE is non-nil, remove the subtree from the clipboard."
8553 (interactive "P")
8554 (setq tree (or tree (and kill-ring (current-kill 0))))
8555 (unless (org-kill-is-subtree-p tree)
8556 (user-error "%s"
8557 (substitute-command-keys
8558 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8559 (org-with-limited-levels
8560 (let* ((visp (not (outline-invisible-p)))
8561 (txt tree)
8562 (^re_ "\\(\\*+\\)[ \t]*")
8563 (old-level (if (string-match org-outline-regexp-bol txt)
8564 (- (match-end 0) (match-beginning 0) 1)
8565 -1))
8566 (force-level (cond (level (prefix-numeric-value level))
8567 ((and (looking-at "[ \t]*$")
8568 (string-match
8569 "^\\*+$" (buffer-substring
8570 (point-at-bol) (point))))
8571 (- (match-end 0) (match-beginning 0)))
8572 ((and (bolp)
8573 (looking-at org-outline-regexp))
8574 (- (match-end 0) (point) 1))))
8575 (previous-level (save-excursion
8576 (condition-case nil
8577 (progn
8578 (outline-previous-visible-heading 1)
8579 (if (looking-at ^re_)
8580 (- (match-end 0) (match-beginning 0) 1)
8582 (error 1))))
8583 (next-level (save-excursion
8584 (condition-case nil
8585 (progn
8586 (or (looking-at org-outline-regexp)
8587 (outline-next-visible-heading 1))
8588 (if (looking-at ^re_)
8589 (- (match-end 0) (match-beginning 0) 1)
8591 (error 1))))
8592 (new-level (or force-level (max previous-level next-level)))
8593 (shift (if (or (= old-level -1)
8594 (= new-level -1)
8595 (= old-level new-level))
8597 (- new-level old-level)))
8598 (delta (if (> shift 0) -1 1))
8599 (func (if (> shift 0) 'org-demote 'org-promote))
8600 (org-odd-levels-only nil)
8601 beg end newend)
8602 ;; Remove the forced level indicator
8603 (if force-level
8604 (delete-region (point-at-bol) (point)))
8605 ;; Paste
8606 (beginning-of-line (if (bolp) 1 2))
8607 (setq beg (point))
8608 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8609 (insert-before-markers txt)
8610 (unless (string-match "\n\\'" txt) (insert "\n"))
8611 (setq newend (point))
8612 (org-reinstall-markers-in-region beg)
8613 (setq end (point))
8614 (goto-char beg)
8615 (skip-chars-forward " \t\n\r")
8616 (setq beg (point))
8617 (if (and (outline-invisible-p) visp)
8618 (save-excursion (outline-show-heading)))
8619 ;; Shift if necessary
8620 (unless (= shift 0)
8621 (save-restriction
8622 (narrow-to-region beg end)
8623 (while (not (= shift 0))
8624 (org-map-region func (point-min) (point-max))
8625 (setq shift (+ delta shift)))
8626 (goto-char (point-min))
8627 (setq newend (point-max))))
8628 (when (or (org-called-interactively-p 'interactive) for-yank)
8629 (message "Clipboard pasted as level %d subtree" new-level))
8630 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8631 kill-ring
8632 (eq org-subtree-clip (current-kill 0))
8633 org-subtree-clip-folded)
8634 ;; The tree was folded before it was killed/copied
8635 (hide-subtree))
8636 (and for-yank (goto-char newend))
8637 (and remove (setq kill-ring (cdr kill-ring))))))
8639 (defun org-kill-is-subtree-p (&optional txt)
8640 "Check if the current kill is an outline subtree, or a set of trees.
8641 Returns nil if kill does not start with a headline, or if the first
8642 headline level is not the largest headline level in the tree.
8643 So this will actually accept several entries of equal levels as well,
8644 which is OK for `org-paste-subtree'.
8645 If optional TXT is given, check this string instead of the current kill."
8646 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8647 (re (org-get-limited-outline-regexp))
8648 (^re (concat "^" re))
8649 (start-level (and kill
8650 (string-match
8651 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8652 kill)
8653 (- (match-end 2) (match-beginning 2) 1)))
8654 (start (1+ (or (match-beginning 2) -1))))
8655 (if (not start-level)
8656 (progn
8657 nil) ;; does not even start with a heading
8658 (catch 'exit
8659 (while (setq start (string-match ^re kill (1+ start)))
8660 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8661 (throw 'exit nil)))
8662 t))))
8664 (defvar org-markers-to-move nil
8665 "Markers that should be moved with a cut-and-paste operation.
8666 Those markers are stored together with their positions relative to
8667 the start of the region.")
8669 (defun org-save-markers-in-region (beg end)
8670 "Check markers in region.
8671 If these markers are between BEG and END, record their position relative
8672 to BEG, so that after moving the block of text, we can put the markers back
8673 into place.
8674 This function gets called just before an entry or tree gets cut from the
8675 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8676 called immediately, to move the markers with the entries."
8677 (setq org-markers-to-move nil)
8678 (when (featurep 'org-clock)
8679 (org-clock-save-markers-for-cut-and-paste beg end))
8680 (when (featurep 'org-agenda)
8681 (org-agenda-save-markers-for-cut-and-paste beg end)))
8683 (defun org-check-and-save-marker (marker beg end)
8684 "Check if MARKER is between BEG and END.
8685 If yes, remember the marker and the distance to BEG."
8686 (when (and (marker-buffer marker)
8687 (equal (marker-buffer marker) (current-buffer)))
8688 (if (and (>= marker beg) (< marker end))
8689 (push (cons marker (- marker beg)) org-markers-to-move))))
8691 (defun org-reinstall-markers-in-region (beg)
8692 "Move all remembered markers to their position relative to BEG."
8693 (mapc (lambda (x)
8694 (move-marker (car x) (+ beg (cdr x))))
8695 org-markers-to-move)
8696 (setq org-markers-to-move nil))
8698 (defun org-narrow-to-subtree ()
8699 "Narrow buffer to the current subtree."
8700 (interactive)
8701 (save-excursion
8702 (save-match-data
8703 (org-with-limited-levels
8704 (narrow-to-region
8705 (progn (org-back-to-heading t) (point))
8706 (progn (org-end-of-subtree t t)
8707 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8708 (point)))))))
8710 (defun org-narrow-to-block ()
8711 "Narrow buffer to the current block."
8712 (interactive)
8713 (let* ((case-fold-search t)
8714 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8715 "^[ \t]*#\\+end_.*")))
8716 (if blockp
8717 (narrow-to-region (car blockp) (cdr blockp))
8718 (user-error "Not in a block"))))
8720 (defun org-clone-subtree-with-time-shift (n &optional shift)
8721 "Clone the task (subtree) at point N times.
8722 The clones will be inserted as siblings.
8724 In interactive use, the user will be prompted for the number of
8725 clones to be produced. If the entry has a timestamp, the user
8726 will also be prompted for a time shift, which may be a repeater
8727 as used in time stamps, for example `+3d'. To disable this,
8728 you can call the function with a universal prefix argument.
8730 When a valid repeater is given and the entry contains any time
8731 stamps, the clones will become a sequence in time, with time
8732 stamps in the subtree shifted for each clone produced. If SHIFT
8733 is nil or the empty string, time stamps will be left alone. The
8734 ID property of the original subtree is removed.
8736 If the original subtree did contain time stamps with a repeater,
8737 the following will happen:
8738 - the repeater will be removed in each clone
8739 - an additional clone will be produced, with the current, unshifted
8740 date(s) in the entry.
8741 - the original entry will be placed *after* all the clones, with
8742 repeater intact.
8743 - the start days in the repeater in the original entry will be shifted
8744 to past the last clone.
8745 In this way you can spell out a number of instances of a repeating task,
8746 and still retain the repeater to cover future instances of the task."
8747 (interactive "nNumber of clones to produce: ")
8748 (let ((shift
8749 (or shift
8750 (if (and (not (equal current-prefix-arg '(4)))
8751 (save-excursion
8752 (re-search-forward org-ts-regexp-both
8753 (save-excursion
8754 (org-end-of-subtree t)
8755 (point)) t)))
8756 (read-from-minibuffer
8757 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8758 ""))) ;; No time shift
8759 (n-no-remove -1)
8760 (drawer-re org-drawer-regexp)
8761 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8762 beg end template task idprop
8763 shift-n shift-what doshift nmin nmax)
8764 (if (not (and (integerp n) (> n 0)))
8765 (user-error "Invalid number of replications %s" n))
8766 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8767 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8768 shift)))
8769 (user-error "Invalid shift specification %s" shift))
8770 (when doshift
8771 (setq shift-n (string-to-number (match-string 1 shift))
8772 shift-what (cdr (assoc (match-string 2 shift)
8773 '(("d" . day) ("w" . week)
8774 ("m" . month) ("y" . year))))))
8775 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8776 (setq nmin 1 nmax n)
8777 (org-back-to-heading t)
8778 (setq beg (point))
8779 (setq idprop (org-entry-get nil "ID"))
8780 (org-end-of-subtree t t)
8781 (or (bolp) (insert "\n"))
8782 (setq end (point))
8783 (setq template (buffer-substring beg end))
8784 (when (and doshift
8785 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8786 (delete-region beg end)
8787 (setq end beg)
8788 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8789 (goto-char end)
8790 (loop for n from nmin to nmax do
8791 ;; prepare clone
8792 (with-temp-buffer
8793 (insert template)
8794 (org-mode)
8795 (goto-char (point-min))
8796 (org-show-subtree)
8797 (and idprop (if org-clone-delete-id
8798 (org-entry-delete nil "ID")
8799 (org-id-get-create t)))
8800 (unless (= n 0)
8801 (while (re-search-forward org-clock-re nil t)
8802 (kill-whole-line))
8803 (goto-char (point-min))
8804 (while (re-search-forward drawer-re nil t)
8805 (org-remove-empty-drawer-at (point))))
8806 (goto-char (point-min))
8807 (when doshift
8808 (while (re-search-forward org-ts-regexp-both nil t)
8809 (org-timestamp-change (* n shift-n) shift-what))
8810 (unless (= n n-no-remove)
8811 (goto-char (point-min))
8812 (while (re-search-forward org-ts-regexp nil t)
8813 (save-excursion
8814 (goto-char (match-beginning 0))
8815 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8816 (delete-region (match-beginning 1) (match-end 1)))))))
8817 (setq task (buffer-string)))
8818 (insert task))
8819 (goto-char beg)))
8821 ;;; Outline Sorting
8823 (defun org-sort (with-case)
8824 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8825 Optional argument WITH-CASE means sort case-sensitively."
8826 (interactive "P")
8827 (cond
8828 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8829 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8831 (org-call-with-arg 'org-sort-entries with-case))))
8833 (defun org-sort-remove-invisible (s)
8834 "Remove invisible links from string S."
8835 (remove-text-properties 0 (length s) org-rm-props s)
8836 (while (string-match org-bracket-link-regexp s)
8837 (setq s (replace-match (if (match-end 2)
8838 (match-string 3 s)
8839 (match-string 1 s)) t t s)))
8840 (let ((st (format " %s " s)))
8841 (while (string-match org-emph-re st)
8842 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8843 (setq s (substring st 1 -1)))
8846 (defvar org-priority-regexp) ; defined later in the file
8848 (defvar org-after-sorting-entries-or-items-hook nil
8849 "Hook that is run after a bunch of entries or items have been sorted.
8850 When children are sorted, the cursor is in the parent line when this
8851 hook gets called. When a region or a plain list is sorted, the cursor
8852 will be in the first entry of the sorted region/list.")
8854 (defun org-sort-entries
8855 (&optional with-case sorting-type getkey-func compare-func property)
8856 "Sort entries on a certain level of an outline tree.
8857 If there is an active region, the entries in the region are sorted.
8858 Else, if the cursor is before the first entry, sort the top-level items.
8859 Else, the children of the entry at point are sorted.
8861 Sorting can be alphabetically, numerically, by date/time as given by
8862 a time stamp, by a property, by priority order, or by a custom function.
8864 The command prompts for the sorting type unless it has been given to the
8865 function through the SORTING-TYPE argument, which needs to be a character,
8866 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8867 the precise meaning of each character:
8869 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8870 c By creation time, which is assumed to be the first inactive time stamp
8871 at the beginning of a line.
8872 d By deadline date/time.
8873 k By clocking time.
8874 n Numerically, by converting the beginning of the entry/item to a number.
8875 o By order of TODO keywords.
8876 p By priority according to the cookie.
8877 r By the value of a property.
8878 s By scheduled date/time.
8879 t By date/time, either the first active time stamp in the entry, or, if
8880 none exist, by the first inactive one.
8882 Capital letters will reverse the sort order.
8884 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8885 called with point at the beginning of the record. It must return either
8886 a string or a number that should serve as the sorting key for that record.
8888 Comparing entries ignores case by default. However, with an optional argument
8889 WITH-CASE, the sorting considers case as well.
8891 Sorting is done against the visible part of the headlines, it ignores hidden
8892 links.
8894 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8895 (interactive "P")
8896 (let ((case-func (if with-case 'identity 'downcase))
8897 (cmstr
8898 ;; The clock marker is lost when using `sort-subr', let's
8899 ;; store the clocking string.
8900 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8901 (save-excursion
8902 (goto-char org-clock-marker)
8903 (looking-back "^.*") (match-string-no-properties 0))))
8904 start beg end stars re re2
8905 txt what tmp)
8906 ;; Find beginning and end of region to sort
8907 (cond
8908 ((org-region-active-p)
8909 ;; we will sort the region
8910 (setq end (region-end)
8911 what "region")
8912 (goto-char (region-beginning))
8913 (if (not (org-at-heading-p)) (outline-next-heading))
8914 (setq start (point)))
8915 ((or (org-at-heading-p)
8916 (ignore-errors (progn (org-back-to-heading) t)))
8917 ;; we will sort the children of the current headline
8918 (org-back-to-heading)
8919 (setq start (point)
8920 end (progn (org-end-of-subtree t t)
8921 (or (bolp) (insert "\n"))
8922 (when (>= (org-back-over-empty-lines) 1)
8923 (forward-line 1))
8924 (point))
8925 what "children")
8926 (goto-char start)
8927 (show-subtree)
8928 (outline-next-heading))
8930 ;; we will sort the top-level entries in this file
8931 (goto-char (point-min))
8932 (or (org-at-heading-p) (outline-next-heading))
8933 (setq start (point))
8934 (goto-char (point-max))
8935 (beginning-of-line 1)
8936 (when (looking-at ".*?\\S-")
8937 ;; File ends in a non-white line
8938 (end-of-line 1)
8939 (insert "\n"))
8940 (setq end (point-max))
8941 (setq what "top-level")
8942 (goto-char start)
8943 (show-all)))
8945 (setq beg (point))
8946 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8948 (looking-at "\\(\\*+\\)")
8949 (setq stars (match-string 1)
8950 re (concat "^" (regexp-quote stars) " +")
8951 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8952 txt (buffer-substring beg end))
8953 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8954 (if (and (not (equal stars "*")) (string-match re2 txt))
8955 (user-error "Region to sort contains a level above the first entry"))
8957 (unless sorting-type
8958 (message
8959 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8960 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8961 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8962 what)
8963 (setq sorting-type (read-char-exclusive))
8965 (unless getkey-func
8966 (and (= (downcase sorting-type) ?f)
8967 (setq getkey-func
8968 (org-icompleting-read "Sort using function: "
8969 obarray 'fboundp t nil nil))
8970 (setq getkey-func (intern getkey-func))))
8972 (and (= (downcase sorting-type) ?r)
8973 (not property)
8974 (setq property
8975 (org-icompleting-read "Property: "
8976 (mapcar 'list (org-buffer-property-keys t))
8977 nil t))))
8979 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8980 (message "Sorting entries...")
8982 (save-restriction
8983 (narrow-to-region start end)
8984 (let ((dcst (downcase sorting-type))
8985 (case-fold-search nil)
8986 (now (current-time)))
8987 (sort-subr
8988 (/= dcst sorting-type)
8989 ;; This function moves to the beginning character of the "record" to
8990 ;; be sorted.
8991 (lambda nil
8992 (if (re-search-forward re nil t)
8993 (goto-char (match-beginning 0))
8994 (goto-char (point-max))))
8995 ;; This function moves to the last character of the "record" being
8996 ;; sorted.
8997 (lambda nil
8998 (save-match-data
8999 (condition-case nil
9000 (outline-forward-same-level 1)
9001 (error
9002 (goto-char (point-max))))))
9003 ;; This function returns the value that gets sorted against.
9004 (lambda nil
9005 (cond
9006 ((= dcst ?n)
9007 (if (looking-at org-complex-heading-regexp)
9008 (string-to-number (org-sort-remove-invisible (match-string 4)))
9009 nil))
9010 ((= dcst ?a)
9011 (if (looking-at org-complex-heading-regexp)
9012 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9013 nil))
9014 ((= dcst ?k)
9015 (or (get-text-property (point) :org-clock-minutes) 0))
9016 ((= dcst ?t)
9017 (let ((end (save-excursion (outline-next-heading) (point))))
9018 (if (or (re-search-forward org-ts-regexp end t)
9019 (re-search-forward org-ts-regexp-both end t))
9020 (org-time-string-to-seconds (match-string 0))
9021 (org-float-time now))))
9022 ((= dcst ?c)
9023 (let ((end (save-excursion (outline-next-heading) (point))))
9024 (if (re-search-forward
9025 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9026 end t)
9027 (org-time-string-to-seconds (match-string 0))
9028 (org-float-time now))))
9029 ((= dcst ?s)
9030 (let ((end (save-excursion (outline-next-heading) (point))))
9031 (if (re-search-forward org-scheduled-time-regexp end t)
9032 (org-time-string-to-seconds (match-string 1))
9033 (org-float-time now))))
9034 ((= dcst ?d)
9035 (let ((end (save-excursion (outline-next-heading) (point))))
9036 (if (re-search-forward org-deadline-time-regexp end t)
9037 (org-time-string-to-seconds (match-string 1))
9038 (org-float-time now))))
9039 ((= dcst ?p)
9040 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9041 (string-to-char (match-string 2))
9042 org-default-priority))
9043 ((= dcst ?r)
9044 (or (org-entry-get nil property) ""))
9045 ((= dcst ?o)
9046 (if (looking-at org-complex-heading-regexp)
9047 (let* ((m (match-string 2))
9048 (s (if (member m org-done-keywords) '- '+)))
9049 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9050 ((= dcst ?f)
9051 (if getkey-func
9052 (progn
9053 (setq tmp (funcall getkey-func))
9054 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9055 tmp)
9056 (error "Invalid key function `%s'" getkey-func)))
9057 (t (error "Invalid sorting type `%c'" sorting-type))))
9059 (cond
9060 ((= dcst ?a) 'string<)
9061 ((= dcst ?f) compare-func)
9062 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9063 (run-hooks 'org-after-sorting-entries-or-items-hook)
9064 ;; Reset the clock marker if needed
9065 (when cmstr
9066 (save-excursion
9067 (goto-char start)
9068 (search-forward cmstr nil t)
9069 (move-marker org-clock-marker (point))))
9070 (message "Sorting entries...done")))
9072 ;;; The orgstruct minor mode
9074 ;; Define a minor mode which can be used in other modes in order to
9075 ;; integrate the org-mode structure editing commands.
9077 ;; This is really a hack, because the org-mode structure commands use
9078 ;; keys which normally belong to the major mode. Here is how it
9079 ;; works: The minor mode defines all the keys necessary to operate the
9080 ;; structure commands, but wraps the commands into a function which
9081 ;; tests if the cursor is currently at a headline or a plain list
9082 ;; item. If that is the case, the structure command is used,
9083 ;; temporarily setting many Org-mode variables like regular
9084 ;; expressions for filling etc. However, when any of those keys is
9085 ;; used at a different location, function uses `key-binding' to look
9086 ;; up if the key has an associated command in another currently active
9087 ;; keymap (minor modes, major mode, global), and executes that
9088 ;; command. There might be problems if any of the keys is otherwise
9089 ;; used as a prefix key.
9091 (defcustom orgstruct-heading-prefix-regexp ""
9092 "Regexp that matches the custom prefix of Org headlines in
9093 orgstruct(++)-mode."
9094 :group 'org
9095 :version "24.4"
9096 :package-version '(Org . "8.3")
9097 :type 'regexp)
9098 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9100 (defcustom orgstruct-setup-hook nil
9101 "Hook run after orgstruct-mode-map is filled."
9102 :group 'org
9103 :version "24.4"
9104 :package-version '(Org . "8.0")
9105 :type 'hook)
9107 (defvar orgstruct-initialized nil)
9109 (defvar org-local-vars nil
9110 "List of local variables, for use by `orgstruct-mode'.")
9112 ;;;###autoload
9113 (define-minor-mode orgstruct-mode
9114 "Toggle the minor mode `orgstruct-mode'.
9115 This mode is for using Org-mode structure commands in other
9116 modes. The following keys behave as if Org-mode were active, if
9117 the cursor is on a headline, or on a plain list item (both as
9118 defined by Org-mode)."
9119 nil " OrgStruct" (make-sparse-keymap)
9120 (funcall (if orgstruct-mode
9121 'add-to-invisibility-spec
9122 'remove-from-invisibility-spec)
9123 '(outline . t))
9124 (when orgstruct-mode
9125 (org-load-modules-maybe)
9126 (unless orgstruct-initialized
9127 (orgstruct-setup)
9128 (setq orgstruct-initialized t))))
9130 ;;;###autoload
9131 (defun turn-on-orgstruct ()
9132 "Unconditionally turn on `orgstruct-mode'."
9133 (orgstruct-mode 1))
9135 (defvar org-fb-vars nil)
9136 (make-variable-buffer-local 'org-fb-vars)
9137 (defun orgstruct++-mode (&optional arg)
9138 "Toggle `orgstruct-mode', the enhanced version of it.
9139 In addition to setting orgstruct-mode, this also exports all
9140 indentation and autofilling variables from org-mode into the
9141 buffer. It will also recognize item context in multiline items."
9142 (interactive "P")
9143 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9144 (if (< arg 1)
9145 (progn (orgstruct-mode -1)
9146 (mapc (lambda(v)
9147 (org-set-local (car v)
9148 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9149 org-fb-vars))
9150 (orgstruct-mode 1)
9151 (setq org-fb-vars nil)
9152 (unless org-local-vars
9153 (setq org-local-vars (org-get-local-variables)))
9154 (let (var val)
9155 (mapc
9156 (lambda (x)
9157 (when (string-match
9158 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9159 (symbol-name (car x)))
9160 (setq var (car x) val (nth 1 x))
9161 (push (list var `(quote ,(eval var))) org-fb-vars)
9162 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9163 org-local-vars)
9164 (org-set-local 'orgstruct-is-++ t))))
9166 (defvar orgstruct-is-++ nil
9167 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9168 (make-variable-buffer-local 'orgstruct-is-++)
9170 ;;;###autoload
9171 (defun turn-on-orgstruct++ ()
9172 "Unconditionally turn on `orgstruct++-mode'."
9173 (orgstruct++-mode 1))
9175 (defun orgstruct-error ()
9176 "Error when there is no default binding for a structure key."
9177 (interactive)
9178 (funcall (if (fboundp 'user-error)
9179 'user-error
9180 'error)
9181 "This key has no function outside structure elements"))
9183 (defun orgstruct-setup ()
9184 "Setup orgstruct keymap."
9185 (dolist (cell '((org-demote . t)
9186 (org-metaleft . t)
9187 (org-metaright . t)
9188 (org-promote . t)
9189 (org-shiftmetaleft . t)
9190 (org-shiftmetaright . t)
9191 org-backward-element
9192 org-backward-heading-same-level
9193 org-ctrl-c-ret
9194 org-ctrl-c-minus
9195 org-ctrl-c-star
9196 org-cycle
9197 org-forward-heading-same-level
9198 org-insert-heading
9199 org-insert-heading-respect-content
9200 org-kill-note-or-show-branches
9201 org-mark-subtree
9202 org-meta-return
9203 org-metadown
9204 org-metaup
9205 org-narrow-to-subtree
9206 org-promote-subtree
9207 org-reveal
9208 org-shiftdown
9209 org-shiftleft
9210 org-shiftmetadown
9211 org-shiftmetaup
9212 org-shiftright
9213 org-shifttab
9214 org-shifttab
9215 org-shiftup
9216 org-show-subtree
9217 org-sort
9218 org-up-element
9219 outline-demote
9220 outline-next-visible-heading
9221 outline-previous-visible-heading
9222 outline-promote
9223 outline-up-heading
9224 show-children))
9225 (let ((f (or (car-safe cell) cell))
9226 (disable-when-heading-prefix (cdr-safe cell)))
9227 (when (fboundp f)
9228 (let ((new-bindings))
9229 (dolist (binding (nconc (where-is-internal f org-mode-map)
9230 (where-is-internal f outline-mode-map)))
9231 (push binding new-bindings)
9232 ;; TODO use local-function-key-map
9233 (dolist (rep '(("<tab>" . "TAB")
9234 ("<return>" . "RET")
9235 ("<escape>" . "ESC")
9236 ("<delete>" . "DEL")))
9237 (setq binding (read-kbd-macro
9238 (let ((case-fold-search))
9239 (replace-regexp-in-string
9240 (regexp-quote (cdr rep))
9241 (car rep)
9242 (key-description binding)))))
9243 (pushnew binding new-bindings :test 'equal)))
9244 (dolist (binding new-bindings)
9245 (let ((key (lookup-key orgstruct-mode-map binding)))
9246 (when (or (not key) (numberp key))
9247 (ignore-errors
9248 (org-defkey orgstruct-mode-map
9249 binding
9250 (orgstruct-make-binding
9251 f binding disable-when-heading-prefix))))))))))
9252 (run-hooks 'orgstruct-setup-hook))
9254 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9255 "Create a function for binding in the structure minor mode.
9256 FUN is the command to call inside a table. KEY is the key that
9257 should be checked in for a command to execute outside of tables.
9258 Non-nil `disable-when-heading-prefix' means to disable the command
9259 if `orgstruct-heading-prefix-regexp' is not empty."
9260 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9261 (let ((nname name)
9262 (i 0))
9263 (while (fboundp (intern nname))
9264 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9265 (setq name (intern nname)))
9266 (eval
9267 (let ((bindings '((org-heading-regexp
9268 (concat "^"
9269 orgstruct-heading-prefix-regexp
9270 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9271 (org-outline-regexp
9272 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9273 (org-outline-regexp-bol
9274 (concat "^" org-outline-regexp))
9275 (outline-regexp org-outline-regexp)
9276 (outline-heading-end-regexp "\n")
9277 (outline-level 'org-outline-level)
9278 (outline-heading-alist))))
9279 `(defun ,name (arg)
9280 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9281 "Outside of structure, run the binding of `"
9282 (key-description key) "'."
9283 (when disable-when-heading-prefix
9284 (concat
9285 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9286 "back to the default binding due to limitations of Org's implementation of\n"
9287 "`" (symbol-name fun) "'.")))
9288 (interactive "p")
9289 (let* ((disable
9290 ,(and disable-when-heading-prefix
9291 '(not (string= orgstruct-heading-prefix-regexp ""))))
9292 (fallback
9293 (or disable
9294 (not
9295 (let* ,bindings
9296 (org-context-p 'headline 'item
9297 ,(when (memq fun
9298 '(org-insert-heading
9299 org-insert-heading-respect-content
9300 org-meta-return))
9301 '(when orgstruct-is-++
9302 'item-body))))))))
9303 (if fallback
9304 (let* ((orgstruct-mode)
9305 (binding
9306 (let ((key ,key))
9307 (catch 'exit
9308 (dolist
9309 (rep
9310 '(nil
9311 ("<\\([^>]*\\)tab>" . "\\1TAB")
9312 ("<\\([^>]*\\)return>" . "\\1RET")
9313 ("<\\([^>]*\\)escape>" . "\\1ESC")
9314 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9315 nil)
9316 (when rep
9317 (setq key (read-kbd-macro
9318 (let ((case-fold-search))
9319 (replace-regexp-in-string
9320 (car rep)
9321 (cdr rep)
9322 (key-description key))))))
9323 (when (key-binding key)
9324 (throw 'exit (key-binding key))))))))
9325 (if (keymapp binding)
9326 (org-set-transient-map binding)
9327 (let ((func (or binding
9328 (unless disable
9329 'orgstruct-error))))
9330 (when func
9331 (call-interactively func)))))
9332 (org-run-like-in-org-mode
9333 (lambda ()
9334 (interactive)
9335 (let* ,bindings
9336 (call-interactively ',fun)))))))))
9337 name))
9339 (defun org-contextualize-keys (alist contexts)
9340 "Return valid elements in ALIST depending on CONTEXTS.
9342 `org-agenda-custom-commands' or `org-capture-templates' are the
9343 values used for ALIST, and `org-agenda-custom-commands-contexts'
9344 or `org-capture-templates-contexts' are the associated contexts
9345 definitions."
9346 (let ((contexts
9347 ;; normalize contexts
9348 (mapcar
9349 (lambda(c) (cond ((listp (cadr c))
9350 (list (car c) (car c) (cadr c)))
9351 ((string= "" (cadr c))
9352 (list (car c) (car c) (caddr c)))
9353 (t c))) contexts))
9354 (a alist) c r s)
9355 ;; loop over all commands or templates
9356 (while (setq c (pop a))
9357 (let (vrules repl)
9358 (cond
9359 ((not (assoc (car c) contexts))
9360 (push c r))
9361 ((and (assoc (car c) contexts)
9362 (setq vrules (org-contextualize-validate-key
9363 (car c) contexts)))
9364 (mapc (lambda (vr)
9365 (when (not (equal (car vr) (cadr vr)))
9366 (setq repl vr))) vrules)
9367 (if (not repl) (push c r)
9368 (push (cadr repl) s)
9369 (push
9370 (cons (car c)
9371 (cdr (or (assoc (cadr repl) alist)
9372 (error "Undefined key `%s' as contextual replacement for `%s'"
9373 (cadr repl) (car c)))))
9374 r))))))
9375 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9376 (delq
9378 (delete-dups
9379 (mapcar (lambda (x)
9380 (let ((tpl (car x)))
9381 (when (not (delq
9383 (mapcar (lambda(y)
9384 (equal y tpl)) s))) x)))
9385 (reverse r))))))
9387 (defun org-contextualize-validate-key (key contexts)
9388 "Check CONTEXTS for agenda or capture KEY."
9389 (let (r rr res)
9390 (while (setq r (pop contexts))
9391 (mapc
9392 (lambda (rr)
9393 (when
9394 (and (equal key (car r))
9395 (if (functionp rr) (funcall rr)
9396 (or (and (eq (car rr) 'in-file)
9397 (buffer-file-name)
9398 (string-match (cdr rr) (buffer-file-name)))
9399 (and (eq (car rr) 'in-mode)
9400 (string-match (cdr rr) (symbol-name major-mode)))
9401 (and (eq (car rr) 'in-buffer)
9402 (string-match (cdr rr) (buffer-name)))
9403 (when (and (eq (car rr) 'not-in-file)
9404 (buffer-file-name))
9405 (not (string-match (cdr rr) (buffer-file-name))))
9406 (when (eq (car rr) 'not-in-mode)
9407 (not (string-match (cdr rr) (symbol-name major-mode))))
9408 (when (eq (car rr) 'not-in-buffer)
9409 (not (string-match (cdr rr) (buffer-name)))))))
9410 (push r res)))
9411 (car (last r))))
9412 (delete-dups (delq nil res))))
9414 (defun org-context-p (&rest contexts)
9415 "Check if local context is any of CONTEXTS.
9416 Possible values in the list of contexts are `table', `headline', and `item'."
9417 (let ((pos (point)))
9418 (goto-char (point-at-bol))
9419 (prog1 (or (and (memq 'table contexts)
9420 (looking-at "[ \t]*|"))
9421 (and (memq 'headline contexts)
9422 (looking-at org-outline-regexp))
9423 (and (memq 'item contexts)
9424 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9425 (and (memq 'item-body contexts)
9426 (org-in-item-p)))
9427 (goto-char pos))))
9429 (defun org-get-local-variables ()
9430 "Return a list of all local variables in an Org mode buffer."
9431 (let (varlist)
9432 (with-current-buffer (get-buffer-create "*Org tmp*")
9433 (erase-buffer)
9434 (org-mode)
9435 (setq varlist (buffer-local-variables)))
9436 (kill-buffer "*Org tmp*")
9437 (delq nil
9438 (mapcar
9439 (lambda (x)
9440 (setq x
9441 (if (symbolp x)
9442 (list x)
9443 (list (car x) (cdr x))))
9444 (if (and (not (get (car x) 'org-state))
9445 (string-match
9446 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9447 (symbol-name (car x))))
9448 x nil))
9449 varlist))))
9451 (defun org-clone-local-variables (from-buffer &optional regexp)
9452 "Clone local variables from FROM-BUFFER.
9453 Optional argument REGEXP selects variables to clone."
9454 (mapc
9455 (lambda (pair)
9456 (and (symbolp (car pair))
9457 (or (null regexp)
9458 (string-match regexp (symbol-name (car pair))))
9459 (set (make-local-variable (car pair))
9460 (cdr pair))))
9461 (buffer-local-variables from-buffer)))
9463 ;;;###autoload
9464 (defun org-run-like-in-org-mode (cmd)
9465 "Run a command, pretending that the current buffer is in Org-mode.
9466 This will temporarily bind local variables that are typically bound in
9467 Org-mode to the values they have in Org-mode, and then interactively
9468 call CMD."
9469 (org-load-modules-maybe)
9470 (unless org-local-vars
9471 (setq org-local-vars (org-get-local-variables)))
9472 (let (binds)
9473 (dolist (var org-local-vars)
9474 (when (or (not (boundp (car var)))
9475 (eq (symbol-value (car var))
9476 (default-value (car var))))
9477 (push (list (car var) `(quote ,(cadr var))) binds)))
9478 (eval `(let ,binds
9479 (call-interactively (quote ,cmd))))))
9481 (defun org-get-category (&optional pos force-refresh)
9482 "Get the category applying to position POS."
9483 (save-match-data
9484 (if force-refresh (org-refresh-category-properties))
9485 (let ((pos (or pos (point))))
9486 (or (get-text-property pos 'org-category)
9487 (progn (org-refresh-category-properties)
9488 (get-text-property pos 'org-category))))))
9490 ;;; Refresh properties
9492 (defun org-refresh-properties (dprop tprop)
9493 "Refresh buffer text properties.
9494 DPROP is the drawer property and TPROP is either the
9495 corresponding text property to set, or an alist with each element
9496 being a text property (as a symbol) and a function to apply to
9497 the value of the drawer property."
9498 (let ((case-fold-search t)
9499 (inhibit-read-only t))
9500 (org-with-silent-modifications
9501 (save-excursion
9502 (save-restriction
9503 (widen)
9504 (goto-char (point-min))
9505 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9506 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9508 (defun org-refresh-property (tprop p)
9509 "Refresh the buffer text property TPROP from the drawer property P.
9510 The refresh happens only for the current tree (not subtree)."
9511 (unless (org-before-first-heading-p)
9512 (save-excursion
9513 (org-back-to-heading t)
9514 (if (symbolp tprop)
9515 ;; TPROP is a text property symbol
9516 (put-text-property
9517 (point) (or (outline-next-heading) (point-max)) tprop p)
9518 ;; TPROP is an alist with (properties . function) elements
9519 (dolist (al tprop)
9520 (save-excursion
9521 (put-text-property
9522 (line-beginning-position) (or (outline-next-heading) (point-max))
9523 (car al)
9524 (funcall (cdr al) p))))))))
9526 (defun org-refresh-category-properties ()
9527 "Refresh category text properties in the buffer."
9528 (let ((case-fold-search t)
9529 (inhibit-read-only t)
9530 (default-category
9531 (cond ((null org-category)
9532 (if buffer-file-name
9533 (file-name-sans-extension
9534 (file-name-nondirectory buffer-file-name))
9535 "???"))
9536 ((symbolp org-category) (symbol-name org-category))
9537 (t org-category))))
9538 (org-with-silent-modifications
9539 (org-with-wide-buffer
9540 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9541 ;; This is the default category for the buffer. If none is
9542 ;; found, fall-back to `org-category' or buffer file name.
9543 (put-text-property
9544 (point-min) (point-max)
9545 'org-category
9546 (catch 'buffer-category
9547 (goto-char (point-max))
9548 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9549 (let ((element (org-element-at-point)))
9550 (when (eq (org-element-type element) 'keyword)
9551 (throw 'buffer-category
9552 (org-element-property :value element)))))
9553 default-category))
9554 ;; Set sub-tree specific categories.
9555 (goto-char (point-min))
9556 (let ((regexp (org-re-property "CATEGORY")))
9557 (while (re-search-forward regexp nil t)
9558 (let ((value (org-match-string-no-properties 3)))
9559 (when (org-at-property-p)
9560 (put-text-property
9561 (save-excursion (org-back-to-heading t) (point))
9562 (save-excursion (org-end-of-subtree t t) (point))
9563 'org-category
9564 value)))))))))
9566 (defun org-refresh-stats-properties ()
9567 "Refresh stats text properties in the buffer."
9568 (let (stats)
9569 (org-with-silent-modifications
9570 (save-excursion
9571 (save-restriction
9572 (widen)
9573 (goto-char (point-min))
9574 (while (re-search-forward
9575 (concat org-outline-regexp-bol ".*"
9576 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9577 nil t)
9578 (setq stats (cond ((equal (match-string 3) "0") 0)
9579 ((match-string 2)
9580 (/ (* (string-to-number (match-string 2)) 100)
9581 (string-to-number (match-string 3))))
9582 (t (string-to-number (match-string 1)))))
9583 (org-back-to-heading t)
9584 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9585 'org-stats stats)))))))
9587 (defun org-refresh-effort-properties ()
9588 "Refresh effort properties"
9589 (org-refresh-properties
9590 org-effort-property
9591 '((effort . identity)
9592 (effort-minutes . org-duration-string-to-minutes))))
9594 ;;;; Link Stuff
9596 ;;; Link abbreviations
9598 (defun org-link-expand-abbrev (link)
9599 "Apply replacements as defined in `org-link-abbrev-alist'."
9600 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9601 (let* ((key (match-string 1 link))
9602 (as (or (assoc key org-link-abbrev-alist-local)
9603 (assoc key org-link-abbrev-alist)))
9604 (tag (and (match-end 2) (match-string 3 link)))
9605 rpl)
9606 (if (not as)
9607 link
9608 (setq rpl (cdr as))
9609 (cond
9610 ((symbolp rpl) (funcall rpl tag))
9611 ((string-match "%(\\([^)]+\\))" rpl)
9612 (replace-match
9613 (save-match-data
9614 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9615 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9616 ((string-match "%h" rpl)
9617 (replace-match (url-hexify-string (or tag "")) t t rpl))
9618 (t (concat rpl tag)))))
9619 link))
9621 ;;; Storing and inserting links
9623 (defvar org-insert-link-history nil
9624 "Minibuffer history for links inserted with `org-insert-link'.")
9626 (defvar org-stored-links nil
9627 "Contains the links stored with `org-store-link'.")
9629 (defvar org-store-link-plist nil
9630 "Plist with info about the most recently link created with `org-store-link'.")
9632 (defvar org-link-protocols nil
9633 "Link protocols added to Org-mode using `org-add-link-type'.")
9635 (defvar org-store-link-functions nil
9636 "List of functions that are called to create and store a link.
9637 Each function will be called in turn until one returns a non-nil
9638 value. Each function should check if it is responsible for creating
9639 this link (for example by looking at the major mode).
9640 If not, it must exit and return nil.
9641 If yes, it should return a non-nil value after a calling
9642 `org-store-link-props' with a list of properties and values.
9643 Special properties are:
9645 :type The link prefix, like \"http\". This must be given.
9646 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9647 This is obligatory as well.
9648 :description Optional default description for the second pair
9649 of brackets in an Org-mode link. The user can still change
9650 this when inserting this link into an Org-mode buffer.
9652 In addition to these, any additional properties can be specified
9653 and then used in capture templates.")
9655 (defun org-add-link-type (type &optional follow export)
9656 "Add TYPE to the list of `org-link-types'.
9657 Re-compute all regular expressions depending on `org-link-types'
9659 FOLLOW and EXPORT are two functions.
9661 FOLLOW should take the link path as the single argument and do whatever
9662 is necessary to follow the link, for example find a file or display
9663 a mail message.
9665 EXPORT should format the link path for export to one of the export formats.
9666 It should be a function accepting three arguments:
9668 path the path of the link, the text after the prefix (like \"http:\")
9669 desc the description of the link, if any
9670 format the export format, a symbol like `html' or `latex' or `ascii'.
9672 The function may use the FORMAT information to return different values
9673 depending on the format. The return value will be put literally into
9674 the exported file. If the return value is nil, this means Org should
9675 do what it normally does with links which do not have EXPORT defined.
9677 Org mode has a built-in default for exporting links. If you are happy with
9678 this default, there is no need to define an export function for the link
9679 type. For a simple example of an export function, see `org-bbdb.el'."
9680 (add-to-list 'org-link-types type t)
9681 (org-make-link-regexps)
9682 (org-element-update-syntax)
9683 (if (assoc type org-link-protocols)
9684 (setcdr (assoc type org-link-protocols) (list follow export))
9685 (push (list type follow export) org-link-protocols)))
9687 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9688 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9690 ;;;###autoload
9691 (defun org-store-link (arg)
9692 "\\<org-mode-map>Store an org-link to the current location.
9693 This link is added to `org-stored-links' and can later be inserted
9694 into an org-buffer with \\[org-insert-link].
9696 For some link types, a prefix arg is interpreted.
9697 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9698 For file links, arg negates `org-context-in-file-links'.
9700 A double prefix arg force skipping storing functions that are not
9701 part of Org's core.
9703 A triple prefix arg force storing a link for each line in the
9704 active region."
9705 (interactive "P")
9706 (org-load-modules-maybe)
9707 (if (and (equal arg '(64)) (org-region-active-p))
9708 (save-excursion
9709 (let ((end (region-end)))
9710 (goto-char (region-beginning))
9711 (set-mark (point))
9712 (while (< (point-at-eol) end)
9713 (move-end-of-line 1) (activate-mark)
9714 (let (current-prefix-arg)
9715 (call-interactively 'org-store-link))
9716 (move-beginning-of-line 2)
9717 (set-mark (point)))))
9718 (org-with-limited-levels
9719 (setq org-store-link-plist nil)
9720 (let (link cpltxt desc description search
9721 txt custom-id agenda-link sfuns sfunsn)
9722 (cond
9724 ;; Store a link using an external link type
9725 ((and (not (equal arg '(16)))
9726 (setq sfuns
9727 (delq
9728 nil (mapcar (lambda (f)
9729 (let (fs) (if (funcall f) (push f fs))))
9730 org-store-link-functions))
9731 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9732 (or (and (cdr sfuns)
9733 (funcall (intern
9734 (completing-read
9735 "Which function for creating the link? "
9736 sfunsn nil t (car sfunsn)))))
9737 (funcall (caar sfuns)))
9738 (setq link (plist-get org-store-link-plist :link)
9739 desc (or (plist-get org-store-link-plist
9740 :description) link))))
9742 ;; Store a link from a source code buffer
9743 ((org-src-edit-buffer-p)
9744 (let (label gc)
9745 (while (or (not label)
9746 (save-excursion
9747 (save-restriction
9748 (widen)
9749 (goto-char (point-min))
9750 (re-search-forward
9751 (regexp-quote (format org-coderef-label-format label))
9752 nil t))))
9753 (when label (message "Label exists already") (sit-for 2))
9754 (setq label (read-string "Code line label: " label)))
9755 (end-of-line 1)
9756 (setq link (format org-coderef-label-format label))
9757 (setq gc (- 79 (length link)))
9758 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9759 (insert link)
9760 (setq link (concat "(" label ")") desc nil)))
9762 ;; We are in the agenda, link to referenced location
9763 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9764 (let ((m (or (get-text-property (point) 'org-hd-marker)
9765 (get-text-property (point) 'org-marker))))
9766 (when m
9767 (org-with-point-at m
9768 (setq agenda-link
9769 (if (org-called-interactively-p 'any)
9770 (call-interactively 'org-store-link)
9771 (org-store-link nil)))))))
9773 ((eq major-mode 'calendar-mode)
9774 (let ((cd (calendar-cursor-to-date)))
9775 (setq link
9776 (format-time-string
9777 (car org-time-stamp-formats)
9778 (apply 'encode-time
9779 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9780 nil nil nil))))
9781 (org-store-link-props :type "calendar" :date cd)))
9783 ((eq major-mode 'help-mode)
9784 (setq link (concat "help:" (save-excursion
9785 (goto-char (point-min))
9786 (looking-at "^[^ ]+")
9787 (match-string 0))))
9788 (org-store-link-props :type "help"))
9790 ((eq major-mode 'w3-mode)
9791 (setq cpltxt (if (and (buffer-name)
9792 (not (string-match "Untitled" (buffer-name))))
9793 (buffer-name)
9794 (url-view-url t))
9795 link (url-view-url t))
9796 (org-store-link-props :type "w3" :url (url-view-url t)))
9798 ((eq major-mode 'image-mode)
9799 (setq cpltxt (concat "file:"
9800 (abbreviate-file-name buffer-file-name))
9801 link cpltxt)
9802 (org-store-link-props :type "image" :file buffer-file-name))
9804 ;; In dired, store a link to the file of the current line
9805 ((derived-mode-p 'dired-mode)
9806 (let ((file (dired-get-filename nil t)))
9807 (setq file (if file
9808 (abbreviate-file-name
9809 (expand-file-name (dired-get-filename nil t)))
9810 ;; otherwise, no file so use current directory.
9811 default-directory))
9812 (setq cpltxt (concat "file:" file)
9813 link cpltxt)))
9815 ((setq search (run-hook-with-args-until-success
9816 'org-create-file-search-functions))
9817 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9818 "::" search))
9819 (setq cpltxt (or description link)))
9821 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9822 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9823 (cond
9824 ;; Store a link using the target at point
9825 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9826 (setq cpltxt
9827 (concat "file:"
9828 (abbreviate-file-name
9829 (buffer-file-name (buffer-base-buffer)))
9830 "::" (match-string 1))
9831 link cpltxt))
9832 ((and (featurep 'org-id)
9833 (or (eq org-id-link-to-org-use-id t)
9834 (and (org-called-interactively-p 'any)
9835 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9836 (and (eq org-id-link-to-org-use-id
9837 'create-if-interactive-and-no-custom-id)
9838 (not custom-id))))
9839 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9840 ;; Store a link using the ID at point
9841 (setq link (condition-case nil
9842 (prog1 (org-id-store-link)
9843 (setq desc (or (plist-get org-store-link-plist
9844 :description)
9845 "")))
9846 (error
9847 ;; Probably before first headline, link only to file
9848 (concat "file:"
9849 (abbreviate-file-name
9850 (buffer-file-name (buffer-base-buffer))))))))
9852 ;; Just link to current headline
9853 (setq cpltxt (concat "file:"
9854 (abbreviate-file-name
9855 (buffer-file-name (buffer-base-buffer)))))
9856 ;; Add a context search string
9857 (when (org-xor org-context-in-file-links arg)
9858 (let* ((ee (org-element-at-point))
9859 (et (org-element-type ee))
9860 (ev (plist-get (cadr ee) :value))
9861 (ek (plist-get (cadr ee) :key))
9862 (eok (and (stringp ek) (string-match "name" ek))))
9863 (setq txt (cond
9864 ((org-at-heading-p) nil)
9865 ((and (eq et 'keyword) eok) ev)
9866 ((org-region-active-p)
9867 (buffer-substring (region-beginning) (region-end)))))
9868 (when (or (null txt) (string-match "\\S-" txt))
9869 (setq cpltxt
9870 (concat cpltxt "::"
9871 (condition-case nil
9872 (org-make-org-heading-search-string txt)
9873 (error "")))
9874 desc (or (and (eq et 'keyword) eok ev)
9875 (nth 4 (ignore-errors (org-heading-components)))
9876 "NONE")))))
9877 (if (string-match "::\\'" cpltxt)
9878 (setq cpltxt (substring cpltxt 0 -2)))
9879 (setq link cpltxt))))
9881 ((buffer-file-name (buffer-base-buffer))
9882 ;; Just link to this file here.
9883 (setq cpltxt (concat "file:"
9884 (abbreviate-file-name
9885 (buffer-file-name (buffer-base-buffer)))))
9886 ;; Add a context string.
9887 (when (org-xor org-context-in-file-links arg)
9888 (setq txt (if (org-region-active-p)
9889 (buffer-substring (region-beginning) (region-end))
9890 (buffer-substring (point-at-bol) (point-at-eol))))
9891 ;; Only use search option if there is some text.
9892 (when (string-match "\\S-" txt)
9893 (setq cpltxt
9894 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9895 desc "NONE")))
9896 (setq link cpltxt))
9898 ((org-called-interactively-p 'interactive)
9899 (user-error "No method for storing a link from this buffer"))
9901 (t (setq link nil)))
9903 ;; We're done setting link and desc, clean up
9904 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9905 (setq link (or link cpltxt)
9906 desc (or desc cpltxt))
9907 (cond ((equal desc "NONE") (setq desc nil))
9908 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9909 (let ((d0 (match-string 3 desc))
9910 (p0 (match-string 5 desc)))
9911 (setq desc
9912 (replace-regexp-in-string
9913 org-bracket-link-regexp
9914 (concat (or p0 d0)
9915 (if (equal (length (match-string 0 desc))
9916 (length desc)) "*" "")) desc)))))
9918 ;; Return the link
9919 (if (not (and (or (org-called-interactively-p 'any)
9920 executing-kbd-macro) link))
9921 (or agenda-link (and link (org-make-link-string link desc)))
9922 (push (list link desc) org-stored-links)
9923 (message "Stored: %s" (or desc link))
9924 (when custom-id
9925 (setq link (concat "file:" (abbreviate-file-name
9926 (buffer-file-name)) "::#" custom-id))
9927 (push (list link desc) org-stored-links))
9928 (car org-stored-links))))))
9930 (defun org-store-link-props (&rest plist)
9931 "Store link properties, extract names and addresses."
9932 (let (x adr)
9933 (when (setq x (plist-get plist :from))
9934 (setq adr (mail-extract-address-components x))
9935 (setq plist (plist-put plist :fromname (car adr)))
9936 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9937 (when (setq x (plist-get plist :to))
9938 (setq adr (mail-extract-address-components x))
9939 (setq plist (plist-put plist :toname (car adr)))
9940 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9941 (let ((from (plist-get plist :from))
9942 (to (plist-get plist :to)))
9943 (when (and from to org-from-is-user-regexp)
9944 (setq plist
9945 (plist-put plist :fromto
9946 (if (string-match org-from-is-user-regexp from)
9947 (concat "to %t")
9948 (concat "from %f"))))))
9949 (setq org-store-link-plist plist))
9951 (defun org-add-link-props (&rest plist)
9952 "Add these properties to the link property list."
9953 (let (key value)
9954 (while plist
9955 (setq key (pop plist) value (pop plist))
9956 (setq org-store-link-plist
9957 (plist-put org-store-link-plist key value)))))
9959 (defun org-email-link-description (&optional fmt)
9960 "Return the description part of an email link.
9961 This takes information from `org-store-link-plist' and formats it
9962 according to FMT (default from `org-email-link-description-format')."
9963 (setq fmt (or fmt org-email-link-description-format))
9964 (let* ((p org-store-link-plist)
9965 (to (plist-get p :toaddress))
9966 (from (plist-get p :fromaddress))
9967 (table
9968 (list
9969 (cons "%c" (plist-get p :fromto))
9970 (cons "%F" (plist-get p :from))
9971 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9972 (cons "%T" (plist-get p :to))
9973 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9974 (cons "%s" (plist-get p :subject))
9975 (cons "%d" (plist-get p :date))
9976 (cons "%m" (plist-get p :message-id)))))
9977 (when (string-match "%c" fmt)
9978 ;; Check if the user wrote this message
9979 (if (and org-from-is-user-regexp from to
9980 (save-match-data (string-match org-from-is-user-regexp from)))
9981 (setq fmt (replace-match "to %t" t t fmt))
9982 (setq fmt (replace-match "from %f" t t fmt))))
9983 (org-replace-escapes fmt table)))
9985 (defun org-make-org-heading-search-string (&optional string)
9986 "Make search string for the current headline or STRING."
9987 (let ((s (or string
9988 (and (derived-mode-p 'org-mode)
9989 (save-excursion
9990 (org-back-to-heading t)
9991 (org-element-property :raw-value (org-element-at-point))))))
9992 (lines org-context-in-file-links))
9993 (or string (setq s (concat "*" s))) ; Add * for headlines
9994 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9995 (when (and string (integerp lines) (> lines 0))
9996 (let ((slines (org-split-string s "\n")))
9997 (when (< lines (length slines))
9998 (setq s (mapconcat
9999 'identity
10000 (reverse (nthcdr (- (length slines) lines)
10001 (reverse slines))) "\n")))))
10002 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10004 (defun org-make-link-string (link &optional description)
10005 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10006 (unless (string-match "\\S-" link)
10007 (error "Empty link"))
10008 (when (and description
10009 (stringp description)
10010 (not (string-match "\\S-" description)))
10011 (setq description nil))
10012 (when (stringp description)
10013 ;; Remove brackets from the description, they are fatal.
10014 (while (string-match "\\[" description)
10015 (setq description (replace-match "{" t t description)))
10016 (while (string-match "\\]" description)
10017 (setq description (replace-match "}" t t description))))
10018 (when (equal link description)
10019 ;; No description needed, it is identical
10020 (setq description nil))
10021 (when (and (not description)
10022 (not (string-match (org-image-file-name-regexp) link))
10023 (not (equal link (org-link-escape link))))
10024 (setq description (org-extract-attributes link)))
10025 (setq link
10026 (cond ((string-match (org-image-file-name-regexp) link) link)
10027 ((string-match org-link-types-re link)
10028 (concat (match-string 1 link)
10029 (org-link-escape (substring link (match-end 1)))))
10030 (t (org-link-escape link))))
10031 (concat "[[" link "]"
10032 (if description (concat "[" description "]") "")
10033 "]"))
10035 (defconst org-link-escape-chars
10036 ;;%20 %5B %5D
10037 '(?\ ?\[ ?\])
10038 "List of characters that should be escaped in a link when stored to Org.
10039 This is the list that is used for internal purposes.")
10041 (defconst org-link-escape-chars-browser
10042 ;;%20 %22
10043 '(?\ ?\")
10044 "List of characters to be escaped before handing over to the browser.
10045 If you consider using this constant then you probably want to use
10046 the function `org-link-escape-browser' instead. See there why
10047 this constant is a candidate to be removed once Org drops support
10048 for Emacs 24.1 and 24.2.")
10050 (defun org-link-escape (text &optional table merge)
10051 "Return percent escaped representation of TEXT.
10052 TEXT is a string with the text to escape.
10053 Optional argument TABLE is a list with characters that should be
10054 escaped. When nil, `org-link-escape-chars' is used.
10055 If optional argument MERGE is set, merge TABLE into
10056 `org-link-escape-chars'."
10057 ;; Don't escape chars in internal links
10058 (if (string-match "^\\*[[:alnum:]]+" text)
10059 text
10060 (cond
10061 ((and table merge)
10062 (mapc (lambda (defchr)
10063 (unless (member defchr table)
10064 (setq table (cons defchr table))))
10065 org-link-escape-chars))
10066 ((null table)
10067 (setq table org-link-escape-chars)))
10068 (mapconcat
10069 (lambda (char)
10070 (if (or (member char table)
10071 (and (or (< char 32) (= char ?\%) (> char 126))
10072 org-url-hexify-p))
10073 (mapconcat (lambda (sequence-element)
10074 (format "%%%.2X" sequence-element))
10075 (or (encode-coding-char char 'utf-8)
10076 (error "Unable to percent escape character: %s"
10077 (char-to-string char))) "")
10078 (char-to-string char))) text "")))
10080 (defun org-link-escape-browser (text)
10081 "Escape some characters before handing over to the browser.
10082 This function is a candidate to be removed together with the
10083 constant `org-link-escape-chars-browser' once Org drops support
10084 for Emacs 24.1 and 24.2. All calls to this function will have to
10085 be replaced with `url-encode-url' which is available since Emacs
10086 24.3.1."
10087 ;; Example with the Org link
10088 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10089 ;; to open the browser with +subject:"Release 8.2" filled into the
10090 ;; query field: In this case the variable TEXT contains the
10091 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10092 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10093 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10094 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10095 (if (fboundp 'url-encode-url)
10096 (url-encode-url text)
10097 (if (org-string-match-p
10098 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10099 text)
10100 (org-link-escape text org-link-escape-chars-browser)
10101 text)))
10103 (defun org-link-unescape (str)
10104 "Unhex hexified Unicode strings as returned from the JavaScript function
10105 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10106 (unless (and (null str) (string= "" str))
10107 (let ((pos 0) (case-fold-search t) unhexed)
10108 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10109 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10110 (setq str (replace-match unhexed t t str))
10111 (setq pos (+ pos (length unhexed))))))
10112 str)
10114 (defun org-link-unescape-compound (hex)
10115 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10116 Note: this function also decodes single byte encodings like
10117 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10118 (save-match-data
10119 (let* ((bytes (cdr (split-string hex "%")))
10120 (ret "")
10121 (eat 0)
10122 (sum 0))
10123 (while bytes
10124 (let* ((val (string-to-number (pop bytes) 16))
10125 (shift-xor
10126 (if (= 0 eat)
10127 (cond
10128 ((>= val 252) (cons 6 252))
10129 ((>= val 248) (cons 5 248))
10130 ((>= val 240) (cons 4 240))
10131 ((>= val 224) (cons 3 224))
10132 ((>= val 192) (cons 2 192))
10133 (t (cons 0 0)))
10134 (cons 6 128))))
10135 (if (>= val 192) (setq eat (car shift-xor)))
10136 (setq val (logxor val (cdr shift-xor)))
10137 (setq sum (+ (lsh sum (car shift-xor)) val))
10138 (if (> eat 0) (setq eat (- eat 1)))
10139 (cond
10140 ((= 0 eat) ;multi byte
10141 (setq ret (concat ret (org-char-to-string sum)))
10142 (setq sum 0))
10143 ((not bytes) ; single byte(s)
10144 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10145 ret)))
10147 (defun org-link-unescape-single-byte-sequence (hex)
10148 "Unhexify hex-encoded single byte character sequences."
10149 (mapconcat (lambda (byte)
10150 (char-to-string (string-to-number byte 16)))
10151 (cdr (split-string hex "%")) ""))
10153 (defun org-xor (a b)
10154 "Exclusive or."
10155 (if a (not b) b))
10157 (defun org-fixup-message-id-for-http (s)
10158 "Replace special characters in a message id, so it can be used in an http query."
10159 (when (string-match "%" s)
10160 (setq s (mapconcat (lambda (c)
10161 (if (eq c ?%)
10162 "%25"
10163 (char-to-string c)))
10164 s "")))
10165 (while (string-match "<" s)
10166 (setq s (replace-match "%3C" t t s)))
10167 (while (string-match ">" s)
10168 (setq s (replace-match "%3E" t t s)))
10169 (while (string-match "@" s)
10170 (setq s (replace-match "%40" t t s)))
10173 (defun org-link-prettify (link)
10174 "Return a human-readable representation of LINK.
10175 The car of LINK must be a raw link.
10176 The cdr of LINK must be either a link description or nil."
10177 (let ((desc (or (cadr link) "<no description>")))
10178 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10179 "<" (car link) ">")))
10181 ;;;###autoload
10182 (defun org-insert-link-global ()
10183 "Insert a link like Org-mode does.
10184 This command can be called in any mode to insert a link in Org-mode syntax."
10185 (interactive)
10186 (org-load-modules-maybe)
10187 (org-run-like-in-org-mode 'org-insert-link))
10189 (defun org-insert-all-links (arg &optional pre post)
10190 "Insert all links in `org-stored-links'.
10191 When a universal prefix, do not delete the links from `org-stored-links'.
10192 When `ARG' is a number, insert the last N link(s).
10193 `PRE' and `POST' are optional arguments to define a string to
10194 prepend or to append."
10195 (interactive "P")
10196 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10197 (links (copy-seq org-stored-links))
10198 (pr (or pre "- "))
10199 (po (or post "\n"))
10200 (cnt 1) l)
10201 (if (null org-stored-links)
10202 (message "No link to insert")
10203 (while (and (or (listp arg) (>= arg cnt))
10204 (setq l (if (listp arg)
10205 (pop links)
10206 (pop org-stored-links))))
10207 (setq cnt (1+ cnt))
10208 (insert pr)
10209 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10210 (insert po)))))
10212 (defun org-insert-last-stored-link (arg)
10213 "Insert the last link stored in `org-stored-links'."
10214 (interactive "p")
10215 (org-insert-all-links arg "" "\n"))
10217 (defun org-link-fontify-links-to-this-file ()
10218 "Fontify links to the current file in `org-stored-links'."
10219 (let ((f (buffer-file-name)) a b)
10220 (setq a (mapcar (lambda(l)
10221 (let ((ll (car l)))
10222 (when (and (string-match "^file:\\(.+\\)::" ll)
10223 (equal f (expand-file-name (match-string 1 ll))))
10224 ll)))
10225 org-stored-links))
10226 (when (featurep 'org-id)
10227 (setq b (mapcar (lambda(l)
10228 (let ((ll (car l)))
10229 (when (and (string-match "^id:\\(.+\\)$" ll)
10230 (equal f (expand-file-name
10231 (or (org-id-find-id-file
10232 (match-string 1 ll)) ""))))
10233 ll)))
10234 org-stored-links)))
10235 (mapcar (lambda(l)
10236 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10237 (delq nil (append a b)))))
10239 (defvar org-link-links-in-this-file nil)
10240 (defun org-insert-link (&optional complete-file link-location default-description)
10241 "Insert a link. At the prompt, enter the link.
10243 Completion can be used to insert any of the link protocol prefixes like
10244 http or ftp in use.
10246 The history can be used to select a link previously stored with
10247 `org-store-link'. When the empty string is entered (i.e. if you just
10248 press RET at the prompt), the link defaults to the most recently
10249 stored link. As SPC triggers completion in the minibuffer, you need to
10250 use M-SPC or C-q SPC to force the insertion of a space character.
10252 You will also be prompted for a description, and if one is given, it will
10253 be displayed in the buffer instead of the link.
10255 If there is already a link at point, this command will allow you to edit link
10256 and description parts.
10258 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10259 be selected using completion. The path to the file will be relative to the
10260 current directory if the file is in the current directory or a subdirectory.
10261 Otherwise, the link will be the absolute path as completed in the minibuffer
10262 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10263 option `org-link-file-path-type'.
10265 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10266 the current directory or below.
10268 With three \\[universal-argument] prefixes, negate the meaning of
10269 `org-keep-stored-link-after-insertion'.
10271 If `org-make-link-description-function' is non-nil, this function will be
10272 called with the link target, and the result will be the default
10273 link description.
10275 If the LINK-LOCATION parameter is non-nil, this value will be
10276 used as the link location instead of reading one interactively.
10278 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10279 be used as the default description."
10280 (interactive "P")
10281 (let* ((wcf (current-window-configuration))
10282 (origbuf (current-buffer))
10283 (region (if (org-region-active-p)
10284 (buffer-substring (region-beginning) (region-end))))
10285 (remove (and region (list (region-beginning) (region-end))))
10286 (desc region)
10287 tmphist ; byte-compile incorrectly complains about this
10288 (link link-location)
10289 (abbrevs org-link-abbrev-alist-local)
10290 entry file all-prefixes auto-desc)
10291 (cond
10292 (link-location) ; specified by arg, just use it.
10293 ((org-in-regexp org-bracket-link-regexp 1)
10294 ;; We do have a link at point, and we are going to edit it.
10295 (setq remove (list (match-beginning 0) (match-end 0)))
10296 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10297 (setq link (read-string "Link: "
10298 (org-link-unescape
10299 (org-match-string-no-properties 1)))))
10300 ((or (org-in-regexp org-angle-link-re)
10301 (org-in-regexp org-plain-link-re))
10302 ;; Convert to bracket link
10303 (setq remove (list (match-beginning 0) (match-end 0))
10304 link (read-string "Link: "
10305 (org-remove-angle-brackets (match-string 0)))))
10306 ((member complete-file '((4) (16)))
10307 ;; Completing read for file names.
10308 (setq link (org-file-complete-link complete-file)))
10310 ;; Read link, with completion for stored links.
10311 (org-link-fontify-links-to-this-file)
10312 (org-switch-to-buffer-other-window "*Org Links*")
10313 (with-current-buffer "*Org Links*"
10314 (erase-buffer)
10315 (insert "Insert a link.
10316 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10317 (when org-stored-links
10318 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10319 (insert (mapconcat 'org-link-prettify
10320 (reverse org-stored-links) "\n")))
10321 (goto-char (point-min)))
10322 (let ((cw (selected-window)))
10323 (select-window (get-buffer-window "*Org Links*" 'visible))
10324 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10325 (unless (pos-visible-in-window-p (point-max))
10326 (org-fit-window-to-buffer))
10327 (and (window-live-p cw) (select-window cw)))
10328 ;; Fake a link history, containing the stored links.
10329 (setq tmphist (append (mapcar 'car org-stored-links)
10330 org-insert-link-history))
10331 (setq all-prefixes (append (mapcar 'car abbrevs)
10332 (mapcar 'car org-link-abbrev-alist)
10333 org-link-types))
10334 (unwind-protect
10335 (progn
10336 (setq link
10337 (org-completing-read
10338 "Link: "
10339 (append
10340 (mapcar (lambda (x) (concat x ":"))
10341 all-prefixes)
10342 (mapcar 'car org-stored-links))
10343 nil nil nil
10344 'tmphist
10345 (caar org-stored-links)))
10346 (if (not (string-match "\\S-" link))
10347 (user-error "No link selected"))
10348 (mapc (lambda(l)
10349 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10350 org-stored-links)
10351 (if (or (member link all-prefixes)
10352 (and (equal ":" (substring link -1))
10353 (member (substring link 0 -1) all-prefixes)
10354 (setq link (substring link 0 -1))))
10355 (setq link (with-current-buffer origbuf
10356 (org-link-try-special-completion link)))))
10357 (set-window-configuration wcf)
10358 (kill-buffer "*Org Links*"))
10359 (setq entry (assoc link org-stored-links))
10360 (or entry (push link org-insert-link-history))
10361 (setq desc (or desc (nth 1 entry)))))
10363 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10364 (not org-keep-stored-link-after-insertion))
10365 (setq org-stored-links (delq (assoc link org-stored-links)
10366 org-stored-links)))
10368 (if (and (string-match org-plain-link-re link)
10369 (not (string-match org-ts-regexp link)))
10370 ;; URL-like link, normalize the use of angular brackets.
10371 (setq link (org-remove-angle-brackets link)))
10373 ;; Check if we are linking to the current file with a search
10374 ;; option If yes, simplify the link by using only the search
10375 ;; option.
10376 (when (and buffer-file-name
10377 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10378 (let* ((path (match-string 1 link))
10379 (case-fold-search nil)
10380 (search (match-string 2 link)))
10381 (save-match-data
10382 (if (equal (file-truename buffer-file-name) (file-truename path))
10383 ;; We are linking to this same file, with a search option
10384 (setq link search)))))
10386 ;; Check if we can/should use a relative path. If yes, simplify the link
10387 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10388 (let* ((type (match-string 1 link))
10389 (path (match-string 2 link))
10390 (origpath path)
10391 (case-fold-search nil))
10392 (cond
10393 ((or (eq org-link-file-path-type 'absolute)
10394 (equal complete-file '(16)))
10395 (setq path (abbreviate-file-name (expand-file-name path))))
10396 ((eq org-link-file-path-type 'noabbrev)
10397 (setq path (expand-file-name path)))
10398 ((eq org-link-file-path-type 'relative)
10399 (setq path (file-relative-name path)))
10401 (save-match-data
10402 (if (string-match (concat "^" (regexp-quote
10403 (expand-file-name
10404 (file-name-as-directory
10405 default-directory))))
10406 (expand-file-name path))
10407 ;; We are linking a file with relative path name.
10408 (setq path (substring (expand-file-name path)
10409 (match-end 0)))
10410 (setq path (abbreviate-file-name (expand-file-name path)))))))
10411 (setq link (concat type path))
10412 (if (equal desc origpath)
10413 (setq desc path))))
10415 (if org-make-link-description-function
10416 (setq desc
10417 (or (condition-case nil
10418 (funcall org-make-link-description-function link desc)
10419 (error (progn (message "Can't get link description from `%s'"
10420 (symbol-name org-make-link-description-function))
10421 (sit-for 2) nil)))
10422 (read-string "Description: " default-description)))
10423 (if default-description (setq desc default-description)
10424 (setq desc (or (and auto-desc desc)
10425 (read-string "Description: " desc)))))
10427 (unless (string-match "\\S-" desc) (setq desc nil))
10428 (if remove (apply 'delete-region remove))
10429 (insert (org-make-link-string link desc))))
10431 (defun org-link-try-special-completion (type)
10432 "If there is completion support for link type TYPE, offer it."
10433 (let ((fun (intern (concat "org-" type "-complete-link"))))
10434 (if (functionp fun)
10435 (funcall fun)
10436 (read-string "Link (no completion support): " (concat type ":")))))
10438 (defun org-file-complete-link (&optional arg)
10439 "Create a file link using completion."
10440 (let ((file (org-iread-file-name "File: "))
10441 (pwd (file-name-as-directory (expand-file-name ".")))
10442 (pwd1 (file-name-as-directory (abbreviate-file-name
10443 (expand-file-name ".")))))
10444 (cond ((equal arg '(16))
10445 (concat "file:"
10446 (abbreviate-file-name (expand-file-name file))))
10447 ((string-match
10448 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10449 (concat "file:" (match-string 1 file)))
10450 ((string-match
10451 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10452 (expand-file-name file))
10453 (concat "file:"
10454 (match-string 1 (expand-file-name file))))
10455 (t (concat "file:" file)))))
10457 (defun org-iread-file-name (&rest args)
10458 "Read-file-name using `ido-mode' speedup if available.
10459 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10460 See `read-file-name' for a description of parameters."
10461 (org-without-partial-completion
10462 (if (and org-completion-use-ido
10463 (fboundp 'ido-read-file-name)
10464 (org-bound-and-true-p ido-mode)
10465 (listp (nth 1 args)))
10466 (let ((ido-enter-matching-directory nil))
10467 (apply #'ido-read-file-name args))
10468 (apply #'read-file-name args))))
10470 (defun org-completing-read (&rest args)
10471 "Completing-read with SPACE being a normal character."
10472 (let ((enable-recursive-minibuffers t)
10473 (minibuffer-local-completion-map
10474 (copy-keymap minibuffer-local-completion-map)))
10475 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10476 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10477 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10478 (apply 'org-icompleting-read args)))
10480 (defun org-completing-read-no-i (&rest args)
10481 (let (org-completion-use-ido org-completion-use-iswitchb)
10482 (apply 'org-completing-read args)))
10484 (defun org-iswitchb-completing-read (prompt choices &rest args)
10485 "Use iswitch as a completing-read replacement to choose from choices.
10486 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10487 from."
10488 (let* ((iswitchb-use-virtual-buffers nil)
10489 (iswitchb-make-buflist-hook
10490 (lambda ()
10491 (setq iswitchb-temp-buflist choices))))
10492 (iswitchb-read-buffer prompt)))
10494 (defun org-icompleting-read (&rest args)
10495 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10496 Should be called like `completing-read'."
10497 (org-without-partial-completion
10498 (if (not (listp (nth 1 args)))
10499 ;; Ido only supports lists as the COLLECTION argument. Use
10500 ;; default completion function when second argument is not
10501 ;; a list.
10502 (apply #'completing-read args)
10503 (let ((ido-enter-matching-directory nil))
10504 (apply (cond ((and org-completion-use-ido
10505 (fboundp 'ido-completing-read)
10506 (org-bound-and-true-p ido-mode))
10507 #'ido-completing-read)
10508 ((and org-completion-use-iswitchb
10509 (org-bound-and-true-p iswitchb-mode))
10510 #'org-iswitchb-completing-read)
10511 (t #'completing-read))
10512 (pop args)
10513 (if (org-some #'consp (car args))
10514 (mapcar #'car (pop args))
10515 (pop args))
10516 args)))))
10518 (defun org-extract-attributes (s)
10519 "Extract the attributes cookie from a string and set as text property."
10520 (let (a attr (start 0) key value)
10521 (save-match-data
10522 (when (string-match "{{\\([^}]+\\)}}$" s)
10523 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10524 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10525 (setq key (match-string 1 a) value (match-string 2 a)
10526 start (match-end 0)
10527 attr (plist-put attr (intern key) value))))
10528 (org-add-props s nil 'org-attr attr))
10531 ;;; Opening/following a link
10533 (defvar org-link-search-failed nil)
10535 (defvar org-open-link-functions nil
10536 "Hook for functions finding a plain text link.
10537 These functions must take a single argument, the link content.
10538 They will be called for links that look like [[link text][description]]
10539 when LINK TEXT does not have a protocol like \"http:\" and does not look
10540 like a filename (e.g. \"./blue.png\").
10542 These functions will be called *before* Org attempts to resolve the
10543 link by doing text searches in the current buffer - so if you want a
10544 link \"[[target]]\" to still find \"<<target>>\", your function should
10545 handle this as a special case.
10547 When the function does handle the link, it must return a non-nil value.
10548 If it decides that it is not responsible for this link, it must return
10549 nil to indicate that that Org-mode can continue with other options
10550 like exact and fuzzy text search.")
10552 (defun org-next-link (&optional search-backward)
10553 "Move forward to the next link.
10554 If the link is in hidden text, expose it."
10555 (interactive "P")
10556 (when (and org-link-search-failed (eq this-command last-command))
10557 (goto-char (point-min))
10558 (message "Link search wrapped back to beginning of buffer"))
10559 (setq org-link-search-failed nil)
10560 (let* ((pos (point))
10561 (ct (org-context))
10562 (a (assoc :link ct))
10563 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10564 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10565 ((looking-at org-any-link-re)
10566 ;; Don't stay stuck at link without an org-link face
10567 (forward-char (if search-backward -1 1))))
10568 (if (funcall srch-fun org-any-link-re nil t)
10569 (progn
10570 (goto-char (match-beginning 0))
10571 (if (outline-invisible-p) (org-show-context)))
10572 (goto-char pos)
10573 (setq org-link-search-failed t)
10574 (message "No further link found"))))
10576 (defun org-previous-link ()
10577 "Move backward to the previous link.
10578 If the link is in hidden text, expose it."
10579 (interactive)
10580 (funcall 'org-next-link t))
10582 (defun org-translate-link (s)
10583 "Translate a link string if a translation function has been defined."
10584 (if (and org-link-translation-function
10585 (fboundp org-link-translation-function)
10586 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10587 (progn
10588 (setq s (funcall org-link-translation-function
10589 (match-string 1 s) (match-string 2 s)))
10590 (concat (car s) ":" (cdr s)))
10593 (defun org-translate-link-from-planner (type path)
10594 "Translate a link from Emacs Planner syntax so that Org can follow it.
10595 This is still an experimental function, your mileage may vary."
10596 (cond
10597 ((member type '("http" "https" "news" "ftp"))
10598 ;; standard Internet links are the same.
10599 nil)
10600 ((and (equal type "irc") (string-match "^//" path))
10601 ;; Planner has two / at the beginning of an irc link, we have 1.
10602 ;; We should have zero, actually....
10603 (setq path (substring path 1)))
10604 ((and (equal type "lisp") (string-match "^/" path))
10605 ;; Planner has a slash, we do not.
10606 (setq type "elisp" path (substring path 1)))
10607 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10608 ;; A typical message link. Planner has the id after the final slash,
10609 ;; we separate it with a hash mark
10610 (setq path (concat (match-string 1 path) "#"
10611 (org-remove-angle-brackets (match-string 2 path))))))
10612 (cons type path))
10614 (defun org-find-file-at-mouse (ev)
10615 "Open file link or URL at mouse."
10616 (interactive "e")
10617 (mouse-set-point ev)
10618 (org-open-at-point 'in-emacs))
10620 (defun org-open-at-mouse (ev)
10621 "Open file link or URL at mouse.
10622 See the docstring of `org-open-file' for details."
10623 (interactive "e")
10624 (mouse-set-point ev)
10625 (if (eq major-mode 'org-agenda-mode)
10626 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10627 (org-open-at-point))
10629 (defvar org-window-config-before-follow-link nil
10630 "The window configuration before following a link.
10631 This is saved in case the need arises to restore it.")
10633 (defvar org-open-link-marker (make-marker)
10634 "Marker pointing to the location where `org-open-at-point' was called.")
10636 ;;;###autoload
10637 (defun org-open-at-point-global ()
10638 "Follow a link like Org-mode does.
10639 This command can be called in any mode to follow a link that has
10640 Org-mode syntax."
10641 (interactive)
10642 (org-run-like-in-org-mode 'org-open-at-point))
10644 ;;;###autoload
10645 (defun org-open-link-from-string (s &optional arg reference-buffer)
10646 "Open a link in the string S, as if it was in Org-mode."
10647 (interactive "sLink: \nP")
10648 (let ((reference-buffer (or reference-buffer (current-buffer))))
10649 (with-temp-buffer
10650 (let ((org-inhibit-startup (not reference-buffer)))
10651 (org-mode)
10652 (insert s)
10653 (goto-char (point-min))
10654 (when reference-buffer
10655 (setq org-link-abbrev-alist-local
10656 (with-current-buffer reference-buffer
10657 org-link-abbrev-alist-local)))
10658 (org-open-at-point arg reference-buffer)))))
10660 (defvar org-open-at-point-functions nil
10661 "Hook that is run when following a link at point.
10663 Functions in this hook must return t if they identify and follow
10664 a link at point. If they don't find anything interesting at point,
10665 they must return nil.")
10667 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10668 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10669 (defun org-open-at-point (&optional arg reference-buffer)
10670 "Open link, timestamp, footnote or tags at point.
10672 When point is on a link, follow it. Normally, files will be
10673 opened by an appropriate application. If the optional prefix
10674 argument ARG is non-nil, Emacs will visit the file. With
10675 a double prefix argument, try to open outside of Emacs, in the
10676 application the system uses for this file type.
10678 When point is on a timestamp, open the agenda at the day
10679 specified.
10681 When point is a footnote definition, move to the first reference
10682 found. If it is on a reference, move to the associated
10683 definition.
10685 When point is on a headline, display a list of every link in the
10686 entry, so it is possible to pick one, or all, of them. If point
10687 is on a tag, call `org-tags-view' instead.
10689 When optional argument REFERENCE-BUFFER is non-nil, it should
10690 specify a buffer from where the link search should happen. This
10691 is used internally by `org-open-link-from-string'.
10693 On top of syntactically correct links, this function will open
10694 the link at point in comments or comment blocks and the first
10695 link in a property drawer line."
10696 (interactive "P")
10697 ;; On a code block, open block's results.
10698 (unless (call-interactively 'org-babel-open-src-block-result)
10699 (org-load-modules-maybe)
10700 (move-marker org-open-link-marker (point))
10701 (setq org-window-config-before-follow-link (current-window-configuration))
10702 (org-remove-occur-highlights nil nil t)
10703 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10704 (let* ((context
10705 ;; Only consider supported types, even if they are not
10706 ;; the closest one.
10707 (org-element-lineage
10708 (org-element-context)
10709 '(comment comment-block footnote-definition footnote-reference
10710 headline inlinetask keyword link node-property
10711 timestamp)
10713 (type (org-element-type context))
10714 (value (org-element-property :value context)))
10715 (cond
10716 ((not context) (user-error "No link found"))
10717 ;; Exception: open timestamps and links in properties
10718 ;; drawers, keywords and comments.
10719 ((memq type '(comment comment-block keyword node-property))
10720 (cond ((org-in-regexp org-any-link-re)
10721 (org-open-link-from-string (match-string-no-properties 0)))
10722 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10723 (org-follow-timestamp-link))
10724 (t (user-error "No link found"))))
10725 ;; On a headline or an inlinetask, but not on a timestamp,
10726 ;; a link, a footnote reference or on tags.
10727 ((and (memq type '(headline inlinetask))
10728 ;; Not on tags.
10729 (progn (save-excursion (beginning-of-line)
10730 (looking-at org-complex-heading-regexp))
10731 (or (not (match-beginning 5))
10732 (< (point) (match-beginning 5)))))
10733 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10734 (links (car data))
10735 (links-end (cdr data)))
10736 (if links
10737 (dolist (link (if (stringp links) (list links) links))
10738 (search-forward link nil links-end)
10739 (goto-char (match-beginning 0))
10740 (org-open-at-point))
10741 (require 'org-attach)
10742 (org-attach-reveal 'if-exists))))
10743 ;; Do nothing on white spaces after an object, unless point
10744 ;; is right after it.
10745 ((> (point)
10746 (save-excursion
10747 (goto-char (org-element-property :end context))
10748 (skip-chars-backward " \t")
10749 (point)))
10750 (user-error "No link found"))
10751 ((eq type 'timestamp) (org-follow-timestamp-link))
10752 ;; On tags within a headline or an inlinetask.
10753 ((and (memq type '(headline inlinetask))
10754 (progn (save-excursion (beginning-of-line)
10755 (looking-at org-complex-heading-regexp))
10756 (and (match-beginning 5)
10757 (>= (point) (match-beginning 5)))))
10758 (org-tags-view arg (substring (match-string 5) 0 -1)))
10759 ((eq type 'link)
10760 ;; When link is located within the description of another
10761 ;; link (e.g., an inline image), always open the parent
10762 ;; link.
10763 (let*((link (let ((up (org-element-property :parent context)))
10764 (if (eq (org-element-type up) 'link) up context)))
10765 (type (org-element-property :type link))
10766 (path (org-link-unescape (org-element-property :path link))))
10767 ;; Switch back to REFERENCE-BUFFER needed when called in
10768 ;; a temporary buffer through `org-open-link-from-string'.
10769 (with-current-buffer (or reference-buffer (current-buffer))
10770 (cond
10771 ((equal type "file")
10772 (if (string-match "[*?{]" (file-name-nondirectory path))
10773 (dired path)
10774 ;; Look into `org-link-protocols' in order to find
10775 ;; a DEDICATED-FUNCTION to open file. The function
10776 ;; will be applied on raw link instead of parsed
10777 ;; link due to the limitation in `org-add-link-type'
10778 ;; ("open" function called with a single argument).
10779 ;; If no such function is found, fallback to
10780 ;; `org-open-file'.
10782 ;; Note : "file+emacs" and "file+sys" types are
10783 ;; hard-coded in order to escape the previous
10784 ;; limitation.
10785 (let* ((option (org-element-property :search-option link))
10786 (app (org-element-property :application link))
10787 (dedicated-function
10788 (nth 1 (assoc app org-link-protocols))))
10789 (if dedicated-function
10790 (funcall dedicated-function
10791 (concat path
10792 (and option (concat "::" option))))
10793 (apply 'org-open-file
10794 path
10795 (cond (arg)
10796 ((equal app "emacs") 'emacs)
10797 ((equal app "sys") 'system))
10798 (cond ((not option) nil)
10799 ((org-string-match-p "\\`[0-9]+\\'" option)
10800 (list (string-to-number option)))
10801 (t (list nil
10802 (org-link-unescape option)))))))))
10803 ((assoc type org-link-protocols)
10804 (funcall (nth 1 (assoc type org-link-protocols)) path))
10805 ((equal type "help")
10806 (let ((f-or-v (intern path)))
10807 (cond ((fboundp f-or-v) (describe-function f-or-v))
10808 ((boundp f-or-v) (describe-variable f-or-v))
10809 (t (error "Not a known function or variable")))))
10810 ((member type '("http" "https" "ftp" "mailto" "news"))
10811 (browse-url (org-link-escape-browser (concat type ":" path))))
10812 ((equal type "doi")
10813 (browse-url
10814 (org-link-escape-browser (concat org-doi-server-url path))))
10815 ((equal type "message") (browse-url (concat type ":" path)))
10816 ((equal type "shell")
10817 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10818 (cmd path))
10819 (if (or (and (org-string-nw-p
10820 org-confirm-shell-link-not-regexp)
10821 (string-match
10822 org-confirm-shell-link-not-regexp cmd))
10823 (not org-confirm-shell-link-function)
10824 (funcall org-confirm-shell-link-function
10825 (format "Execute \"%s\" in shell? "
10826 (org-add-props cmd nil
10827 'face 'org-warning))))
10828 (progn
10829 (message "Executing %s" cmd)
10830 (shell-command cmd buf)
10831 (when (featurep 'midnight)
10832 (setq clean-buffer-list-kill-buffer-names
10833 (cons (buffer-name buf)
10834 clean-buffer-list-kill-buffer-names))))
10835 (user-error "Abort"))))
10836 ((equal type "elisp")
10837 (let ((cmd path))
10838 (if (or (and (org-string-nw-p
10839 org-confirm-elisp-link-not-regexp)
10840 (org-string-match-p
10841 org-confirm-elisp-link-not-regexp cmd))
10842 (not org-confirm-elisp-link-function)
10843 (funcall org-confirm-elisp-link-function
10844 (format "Execute \"%s\" as elisp? "
10845 (org-add-props cmd nil
10846 'face 'org-warning))))
10847 (message "%s => %s" cmd
10848 (if (eq (string-to-char cmd) ?\()
10849 (eval (read cmd))
10850 (call-interactively (read cmd))))
10851 (user-error "Abort"))))
10852 ((equal type "id")
10853 (require 'ord-id)
10854 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10855 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10856 (unless (run-hook-with-args-until-success
10857 'org-open-link-functions path)
10858 (if (not arg) (org-mark-ring-push)
10859 (switch-to-buffer-other-window
10860 (org-get-buffer-for-internal-link (current-buffer))))
10861 (let ((cmd `(org-link-search
10862 ,(if (member type '("custom-id" "coderef"))
10863 (org-element-property :raw-link link)
10864 path)
10865 ,(cond ((equal arg '(4)) 'occur)
10866 ((equal arg '(16)) 'org-occur))
10867 ,(org-element-property :begin link))))
10868 (condition-case nil
10869 (let ((org-link-search-inhibit-query t))
10870 (eval cmd))
10871 (error (progn (widen) (eval cmd)))))))
10872 (t (browse-url-at-point))))))
10873 ;; On a footnote reference or at a footnote definition's label.
10874 ((or (eq type 'footnote-reference)
10875 (and (eq type 'footnote-definition)
10876 (save-excursion
10877 ;; Do not validate action when point is on the
10878 ;; spaces right after the footnote label, in
10879 ;; order to be on par with behaviour on links.
10880 (skip-chars-forward " \t")
10881 (let ((begin
10882 (org-element-property :contents-begin context)))
10883 (if begin (< (point) begin)
10884 (= (org-element-property :post-affiliated context)
10885 (line-beginning-position)))))))
10886 (org-footnote-action))
10887 (t (user-error "No link found")))))
10888 (move-marker org-open-link-marker nil)
10889 (run-hook-with-args 'org-follow-link-hook)))
10891 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10892 "Offer links in the current entry and return the selected link.
10893 If there is only one link, return it.
10894 If NTH is an integer, return the NTH link found.
10895 If ZERO is a string, check also this string for a link, and if
10896 there is one, return it."
10897 (with-current-buffer buffer
10898 (save-excursion
10899 (save-restriction
10900 (widen)
10901 (goto-char marker)
10902 (let ((cnt ?0)
10903 (in-emacs (if (integerp nth) nil nth))
10904 have-zero end links link c)
10905 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10906 (push (match-string 0 zero) links)
10907 (setq cnt (1- cnt) have-zero t))
10908 (save-excursion
10909 (org-back-to-heading t)
10910 (setq end (save-excursion (outline-next-heading) (point)))
10911 (while (re-search-forward org-any-link-re end t)
10912 (push (match-string 0) links))
10913 (setq links (org-uniquify (reverse links))))
10914 (cond
10915 ((null links)
10916 (message "No links"))
10917 ((equal (length links) 1)
10918 (setq link (car links)))
10919 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10920 (setq link (nth (if have-zero nth (1- nth)) links)))
10921 (t ; we have to select a link
10922 (save-excursion
10923 (save-window-excursion
10924 (delete-other-windows)
10925 (with-output-to-temp-buffer "*Select Link*"
10926 (mapc (lambda (l)
10927 (if (not (string-match org-bracket-link-regexp l))
10928 (princ (format "[%c] %s\n" (incf cnt)
10929 (org-remove-angle-brackets l)))
10930 (if (match-end 3)
10931 (princ (format "[%c] %s (%s)\n" (incf cnt)
10932 (match-string 3 l) (match-string 1 l)))
10933 (princ (format "[%c] %s\n" (incf cnt)
10934 (match-string 1 l))))))
10935 links))
10936 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10937 (message "Select link to open, RET to open all:")
10938 (setq c (read-char-exclusive))
10939 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10940 (when (equal c ?q) (user-error "Abort"))
10941 (if (equal c ?\C-m)
10942 (setq link links)
10943 (setq nth (- c ?0))
10944 (if have-zero (setq nth (1+ nth)))
10945 (unless (and (integerp nth) (>= (length links) nth))
10946 (user-error "Invalid link selection"))
10947 (setq link (nth (1- nth) links)))))
10948 (cons link end))))))
10950 ;; TODO: These functions are deprecated since `org-open-at-point'
10951 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10952 (defun org-open-file-with-system (path)
10953 "Open file at PATH using the system way of opening it."
10954 (org-open-file path 'system))
10955 (defun org-open-file-with-emacs (path)
10956 "Open file at PATH in Emacs."
10957 (org-open-file path 'emacs))
10960 ;;; File search
10962 (defvar org-create-file-search-functions nil
10963 "List of functions to construct the right search string for a file link.
10964 These functions are called in turn with point at the location to
10965 which the link should point.
10967 A function in the hook should first test if it would like to
10968 handle this file type, for example by checking the `major-mode'
10969 or the file extension. If it decides not to handle this file, it
10970 should just return nil to give other functions a chance. If it
10971 does handle the file, it must return the search string to be used
10972 when following the link. The search string will be part of the
10973 file link, given after a double colon, and `org-open-at-point'
10974 will automatically search for it. If special measures must be
10975 taken to make the search successful, another function should be
10976 added to the companion hook `org-execute-file-search-functions',
10977 which see.
10979 A function in this hook may also use `setq' to set the variable
10980 `description' to provide a suggestion for the descriptive text to
10981 be used for this link when it gets inserted into an Org-mode
10982 buffer with \\[org-insert-link].")
10984 (defvar org-execute-file-search-functions nil
10985 "List of functions to execute a file search triggered by a link.
10987 Functions added to this hook must accept a single argument, the
10988 search string that was part of the file link, the part after the
10989 double colon. The function must first check if it would like to
10990 handle this search, for example by checking the `major-mode' or
10991 the file extension. If it decides not to handle this search, it
10992 should just return nil to give other functions a chance. If it
10993 does handle the search, it must return a non-nil value to keep
10994 other functions from trying.
10996 Each function can access the current prefix argument through the
10997 variable `current-prefix-arg'. Note that a single prefix is used
10998 to force opening a link in Emacs, so it may be good to only use a
10999 numeric or double prefix to guide the search function.
11001 In case this is needed, a function in this hook can also restore
11002 the window configuration before `org-open-at-point' was called using:
11004 (set-window-configuration org-window-config-before-follow-link)")
11006 (defun org-link-search (s &optional type avoid-pos stealth)
11007 "Search for a link search option.
11008 If S is surrounded by forward slashes, it is interpreted as a
11009 regular expression. In org-mode files, this will create an `org-occur'
11010 sparse tree. In ordinary files, `occur' will be used to list matches.
11011 If the current buffer is in `dired-mode', grep will be used to search
11012 in all files. If AVOID-POS is given, ignore matches near that position.
11014 When optional argument STEALTH is non-nil, do not modify
11015 visibility around point, thus ignoring `org-show-context-detail'
11016 variable."
11017 (let ((case-fold-search t)
11018 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
11019 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
11020 (append '(("") (" ") ("\t") ("\n"))
11021 org-emphasis-alist)
11022 "\\|") "\\)"))
11023 (pos (point))
11024 words re0 re2 re4_ re4 re5 re2a re2a_ reall)
11025 (cond
11026 ;; First check if there are any special search functions
11027 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11028 ;; Now try the builtin stuff
11029 ((and (eq (aref s0 0) ?#)
11030 (> (length s0) 1)
11031 (let ((match (org-find-property "CUSTOM_ID" (substring s0 1))))
11032 (and match (goto-char match) (setf type 'dedicated)))))
11033 ((save-excursion
11034 (goto-char (point-min))
11035 (and
11036 (re-search-forward
11037 (concat "<<" (regexp-quote s0) ">>") nil t)
11038 (setq type 'dedicated
11039 pos (match-beginning 0))))
11040 ;; There is an exact target for this
11041 (goto-char pos))
11042 ((save-excursion
11043 (goto-char (point-min))
11044 (and
11045 (re-search-forward
11046 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11047 (setq type 'dedicated pos (match-beginning 0))))
11048 ;; Found an element with a matching #+name affiliated keyword.
11049 (goto-char pos))
11050 ((and (string-match "^(\\(.*\\))$" s0)
11051 (save-excursion
11052 (goto-char (point-min))
11053 (and
11054 (re-search-forward
11055 (concat "[^[]" (regexp-quote
11056 (format org-coderef-label-format
11057 (match-string 1 s0))))
11058 nil t)
11059 (setq type 'dedicated
11060 pos (1+ (match-beginning 0))))))
11061 ;; There is a coderef target for this
11062 (goto-char pos))
11063 ((string-match "^/\\(.*\\)/$" s)
11064 ;; A regular expression
11065 (cond
11066 ((derived-mode-p 'org-mode)
11067 (org-occur (match-string 1 s)))
11068 (t (org-do-occur (match-string 1 s)))))
11069 ((and (derived-mode-p 'org-mode)
11070 (or (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11071 org-link-search-must-match-exact-headline))
11072 ;; Headline search.
11073 (goto-char (point-min))
11074 (cond
11075 ((let (case-fold-search)
11076 (re-search-forward
11077 (let* ((wspace "[ \t]")
11078 (wspaceopt (concat wspace "*"))
11079 (cookie (concat "\\(?:"
11080 wspaceopt
11081 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11082 wspaceopt
11083 "\\)"))
11084 (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)")))
11085 (concat
11086 org-outline-regexp-bol
11087 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11088 "\\(?:\\[#.\\][ \t]+\\)?"
11089 "\\(?:" org-comment-string "[ \t]+\\)?"
11090 sep "*"
11091 (mapconcat #'identity
11092 (org-split-string (regexp-quote s))
11093 (concat sep "+"))
11094 sep "*"
11095 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11096 "[ \t]*$"))
11097 nil t))
11098 ;; OK, found a match
11099 (setq type 'dedicated)
11100 (goto-char (match-beginning 0)))
11101 ((and (not org-link-search-inhibit-query)
11102 (eq org-link-search-must-match-exact-headline 'query-to-create)
11103 (y-or-n-p "No match - create this as a new heading? "))
11104 (goto-char (point-max))
11105 (unless (bolp) (newline))
11106 (org-insert-heading nil t t)
11107 (insert s "\n")
11108 (beginning-of-line 0))
11110 (goto-char pos)
11111 (error "No match"))))
11113 ;; A normal search string
11114 (remove-text-properties
11115 0 (length s)
11116 '(face nil mouse-face nil keymap nil fontified nil) s)
11117 ;; Make a series of regular expressions to find a match
11118 (setq words (org-split-string s "[ \n\r\t]+")
11120 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11121 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11122 "\\)" markers)
11123 re2a_ (concat "\\(" (mapconcat 'downcase words
11124 "[ \t\r\n]+") "\\)[ \t\r\n]")
11125 re2a (concat "[ \t\r\n]" re2a_)
11126 re4_ (concat "\\(" (mapconcat 'downcase words
11127 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11128 re4 (concat "[^a-zA-Z_]" re4_)
11130 re5 (concat ".*" re4)
11131 reall (concat "\\(" re0 "\\)\\|\\(" re2 "\\)\\|\\(" re4
11132 "\\)\\|\\(" re5 "\\)"))
11133 (cond
11134 ((eq type 'org-occur) (org-occur reall))
11135 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11136 (t (goto-char (point-min))
11137 (setq type 'fuzzy)
11138 (if (or (and (org-search-not-self 1 re0 nil t)
11139 (setq type 'dedicated))
11140 (org-search-not-self 1 re2 nil t)
11141 (org-search-not-self 1 re2a nil t)
11142 (org-search-not-self 1 re4 nil t)
11143 (org-search-not-self 1 re5 nil t))
11144 (goto-char (match-beginning 1))
11145 (goto-char pos)
11146 (error "No match"))))))
11147 (and (derived-mode-p 'org-mode)
11148 (not stealth)
11149 (org-show-context 'link-search))
11150 type))
11152 (defun org-search-not-self (group &rest args)
11153 "Execute `re-search-forward', but only accept matches that do not
11154 enclose the position of `org-open-link-marker'."
11155 (let ((m org-open-link-marker))
11156 (catch 'exit
11157 (while (apply 're-search-forward args)
11158 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11159 (goto-char (match-end group))
11160 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11161 (> (match-beginning 0) (marker-position m))
11162 (< (match-end 0) (marker-position m)))
11163 (save-match-data
11164 (or (not (org-in-regexp
11165 org-bracket-link-analytic-regexp 1))
11166 (not (match-end 4)) ; no description
11167 (and (<= (match-beginning 4) (point))
11168 (>= (match-end 4) (point))))))
11169 (throw 'exit (point))))))))
11171 (defun org-get-buffer-for-internal-link (buffer)
11172 "Return a buffer to be used for displaying the link target of internal links."
11173 (cond
11174 ((not org-display-internal-link-with-indirect-buffer)
11175 buffer)
11176 ((string-match "(Clone)$" (buffer-name buffer))
11177 (message "Buffer is already a clone, not making another one")
11178 ;; we also do not modify visibility in this case
11179 buffer)
11180 (t ; make a new indirect buffer for displaying the link
11181 (let* ((bn (buffer-name buffer))
11182 (ibn (concat bn "(Clone)"))
11183 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11184 (with-current-buffer ib (org-overview))
11185 ib))))
11187 (defun org-do-occur (regexp &optional cleanup)
11188 "Call the Emacs command `occur'.
11189 If CLEANUP is non-nil, remove the printout of the regular expression
11190 in the *Occur* buffer. This is useful if the regex is long and not useful
11191 to read."
11192 (occur regexp)
11193 (when cleanup
11194 (let ((cwin (selected-window)) win beg end)
11195 (when (setq win (get-buffer-window "*Occur*"))
11196 (select-window win))
11197 (goto-char (point-min))
11198 (when (re-search-forward "match[a-z]+" nil t)
11199 (setq beg (match-end 0))
11200 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11201 (setq end (1- (match-beginning 0)))))
11202 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11203 (goto-char (point-min))
11204 (select-window cwin))))
11206 ;;; The mark ring for links jumps
11208 (defvar org-mark-ring nil
11209 "Mark ring for positions before jumps in Org-mode.")
11210 (defvar org-mark-ring-last-goto nil
11211 "Last position in the mark ring used to go back.")
11212 ;; Fill and close the ring
11213 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11214 (loop for i from 1 to org-mark-ring-length do
11215 (push (make-marker) org-mark-ring))
11216 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11217 org-mark-ring)
11219 (defun org-mark-ring-push (&optional pos buffer)
11220 "Put the current position or POS into the mark ring and rotate it."
11221 (interactive)
11222 (setq pos (or pos (point)))
11223 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11224 (move-marker (car org-mark-ring)
11225 (or pos (point))
11226 (or buffer (current-buffer)))
11227 (message "%s"
11228 (substitute-command-keys
11229 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11231 (defun org-mark-ring-goto (&optional n)
11232 "Jump to the previous position in the mark ring.
11233 With prefix arg N, jump back that many stored positions. When
11234 called several times in succession, walk through the entire ring.
11235 Org-mode commands jumping to a different position in the current file,
11236 or to another Org-mode file, automatically push the old position
11237 onto the ring."
11238 (interactive "p")
11239 (let (p m)
11240 (if (eq last-command this-command)
11241 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11242 (setq p org-mark-ring))
11243 (setq org-mark-ring-last-goto p)
11244 (setq m (car p))
11245 (org-pop-to-buffer-same-window (marker-buffer m))
11246 (goto-char m)
11247 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11249 (defun org-remove-angle-brackets (s)
11250 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11251 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11253 (defun org-add-angle-brackets (s)
11254 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11255 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11257 (defun org-remove-double-quotes (s)
11258 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11259 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11262 ;;; Following specific links
11264 (defun org-follow-timestamp-link ()
11265 "Open an agenda view for the time-stamp date/range at point."
11266 (cond
11267 ((org-at-date-range-p t)
11268 (let ((org-agenda-start-on-weekday)
11269 (t1 (match-string 1))
11270 (t2 (match-string 2)) tt1 tt2)
11271 (setq tt1 (time-to-days (org-time-string-to-time t1))
11272 tt2 (time-to-days (org-time-string-to-time t2)))
11273 (let ((org-agenda-buffer-tmp-name
11274 (format "*Org Agenda(a:%s)"
11275 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11276 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11277 ((org-at-timestamp-p t)
11278 (let ((org-agenda-buffer-tmp-name
11279 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11280 (org-agenda-list nil (time-to-days (org-time-string-to-time
11281 (substring (match-string 1) 0 10)))
11282 1)))
11283 (t (error "This should not happen"))))
11286 ;;; Following file links
11287 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11288 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11289 (declare-function mailcap-mime-info
11290 "mailcap" (string &optional request no-decode))
11291 (defvar org-wait nil)
11292 (defun org-open-file (path &optional in-emacs line search)
11293 "Open the file at PATH.
11294 First, this expands any special file name abbreviations. Then the
11295 configuration variable `org-file-apps' is checked if it contains an
11296 entry for this file type, and if yes, the corresponding command is launched.
11298 If no application is found, Emacs simply visits the file.
11300 With optional prefix argument IN-EMACS, Emacs will visit the file.
11301 With a double \\[universal-argument] \\[universal-argument] \
11302 prefix arg, Org tries to avoid opening in Emacs
11303 and to use an external application to visit the file.
11305 Optional LINE specifies a line to go to, optional SEARCH a string
11306 to search for. If LINE or SEARCH is given, the file will be
11307 opened in Emacs, unless an entry from org-file-apps that makes
11308 use of groups in a regexp matches.
11310 If you want to change the way frames are used when following a
11311 link, please customize `org-link-frame-setup'.
11313 If the file does not exist, an error is thrown."
11314 (let* ((file (if (equal path "")
11315 buffer-file-name
11316 (substitute-in-file-name (expand-file-name path))))
11317 (file-apps (append org-file-apps (org-default-apps)))
11318 (apps (org-remove-if
11319 'org-file-apps-entry-match-against-dlink-p file-apps))
11320 (apps-dlink (org-remove-if-not
11321 'org-file-apps-entry-match-against-dlink-p file-apps))
11322 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11323 (dirp (if remp nil (file-directory-p file)))
11324 (file (if (and dirp org-open-directory-means-index-dot-org)
11325 (concat (file-name-as-directory file) "index.org")
11326 file))
11327 (a-m-a-p (assq 'auto-mode apps))
11328 (dfile (downcase file))
11329 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11330 (link (cond ((and (eq line nil)
11331 (eq search nil))
11332 file)
11333 (line
11334 (concat file "::" (number-to-string line)))
11335 (search
11336 (concat file "::" search))))
11337 (dlink (downcase link))
11338 (old-buffer (current-buffer))
11339 (old-pos (point))
11340 (old-mode major-mode)
11341 ext cmd link-match-data)
11342 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11343 (setq ext (match-string 1 dfile))
11344 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11345 (setq ext (match-string 1 dfile))))
11346 (cond
11347 ((member in-emacs '((16) system))
11348 (setq cmd (cdr (assoc 'system apps))))
11349 (in-emacs (setq cmd 'emacs))
11351 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11352 (and dirp (cdr (assoc 'directory apps)))
11353 ; first, try matching against apps-dlink
11354 ; if we get a match here, store the match data for later
11355 (let ((match (assoc-default dlink apps-dlink
11356 'string-match)))
11357 (if match
11358 (progn (setq link-match-data (match-data))
11359 match)
11360 (progn (setq in-emacs (or in-emacs line search))
11361 nil))) ; if we have no match in apps-dlink,
11362 ; always open the file in emacs if line or search
11363 ; is given (for backwards compatibility)
11364 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11365 'string-match)
11366 (cdr (assoc ext apps))
11367 (cdr (assoc t apps))))))
11368 (when (eq cmd 'system)
11369 (setq cmd (cdr (assoc 'system apps))))
11370 (when (eq cmd 'default)
11371 (setq cmd (cdr (assoc t apps))))
11372 (when (eq cmd 'mailcap)
11373 (require 'mailcap)
11374 (mailcap-parse-mailcaps)
11375 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11376 (command (mailcap-mime-info mime-type)))
11377 (if (stringp command)
11378 (setq cmd command)
11379 (setq cmd 'emacs))))
11380 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11381 (not (file-exists-p file))
11382 (not org-open-non-existing-files))
11383 (user-error "No such file: %s" file))
11384 (cond
11385 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11386 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11387 (while (string-match "['\"]%s['\"]" cmd)
11388 (setq cmd (replace-match "%s" t t cmd)))
11389 (while (string-match "%s" cmd)
11390 (setq cmd (replace-match
11391 (save-match-data
11392 (shell-quote-argument
11393 (convert-standard-filename file)))
11394 t t cmd)))
11396 ;; Replace "%1", "%2" etc. in command with group matches from regex
11397 (save-match-data
11398 (let ((match-index 1)
11399 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11400 (set-match-data link-match-data)
11401 (while (<= match-index number-of-groups)
11402 (let ((regex (concat "%" (number-to-string match-index)))
11403 (replace-with (match-string match-index dlink)))
11404 (while (string-match regex cmd)
11405 (setq cmd (replace-match replace-with t t cmd))))
11406 (setq match-index (+ match-index 1)))))
11408 (save-window-excursion
11409 (message "Running %s...done" cmd)
11410 (start-process-shell-command cmd nil cmd)
11411 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11412 ((or (stringp cmd)
11413 (eq cmd 'emacs))
11414 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11415 (widen)
11416 (if line (progn (org-goto-line line)
11417 (if (derived-mode-p 'org-mode)
11418 (org-reveal)))
11419 (if search (org-link-search search))))
11420 ((consp cmd)
11421 (let ((file (convert-standard-filename file)))
11422 (save-match-data
11423 (set-match-data link-match-data)
11424 (eval cmd))))
11425 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11426 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11427 (or (not (equal old-buffer (current-buffer)))
11428 (not (equal old-pos (point))))
11429 (org-mark-ring-push old-pos old-buffer))))
11431 (defun org-file-apps-entry-match-against-dlink-p (entry)
11432 "This function returns non-nil if `entry' uses a regular
11433 expression which should be matched against the whole link by
11434 org-open-file.
11436 It assumes that is the case when the entry uses a regular
11437 expression which has at least one grouping construct and the
11438 action is either a lisp form or a command string containing
11439 '%1', i.e. using at least one subexpression match as a
11440 parameter."
11441 (let ((selector (car entry))
11442 (action (cdr entry)))
11443 (if (stringp selector)
11444 (and (> (regexp-opt-depth selector) 0)
11445 (or (and (stringp action)
11446 (string-match "%[0-9]" action))
11447 (consp action)))
11448 nil)))
11450 (defun org-default-apps ()
11451 "Return the default applications for this operating system."
11452 (cond
11453 ((eq system-type 'darwin)
11454 org-file-apps-defaults-macosx)
11455 ((eq system-type 'windows-nt)
11456 org-file-apps-defaults-windowsnt)
11457 (t org-file-apps-defaults-gnu)))
11459 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11460 "Convert extensions to regular expressions in the cars of LIST.
11461 Also, weed out any non-string entries, because the return value is used
11462 only for regexp matching.
11463 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11464 point to the symbol `emacs', indicating that the file should
11465 be opened in Emacs."
11466 (append
11467 (delq nil
11468 (mapcar (lambda (x)
11469 (if (not (stringp (car x)))
11471 (if (string-match "\\W" (car x))
11473 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11474 list))
11475 (if add-auto-mode
11476 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11478 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11479 (defun org-file-remote-p (file)
11480 "Test whether FILE specifies a location on a remote system.
11481 Return non-nil if the location is indeed remote.
11483 For example, the filename \"/user@host:/foo\" specifies a location
11484 on the system \"/user@host:\"."
11485 (cond ((fboundp 'file-remote-p)
11486 (file-remote-p file))
11487 ((fboundp 'tramp-handle-file-remote-p)
11488 (tramp-handle-file-remote-p file))
11489 ((and (boundp 'ange-ftp-name-format)
11490 (string-match (car ange-ftp-name-format) file))
11491 t)))
11494 ;;;; Refiling
11496 (defun org-get-org-file ()
11497 "Read a filename, with default directory `org-directory'."
11498 (let ((default (or org-default-notes-file remember-data-file)))
11499 (read-file-name (format "File name [%s]: " default)
11500 (file-name-as-directory org-directory)
11501 default)))
11503 (defun org-notes-order-reversed-p ()
11504 "Check if the current file should receive notes in reversed order."
11505 (cond
11506 ((not org-reverse-note-order) nil)
11507 ((eq t org-reverse-note-order) t)
11508 ((not (listp org-reverse-note-order)) nil)
11509 (t (catch 'exit
11510 (let ((all org-reverse-note-order)
11511 entry)
11512 (while (setq entry (pop all))
11513 (if (string-match (car entry) buffer-file-name)
11514 (throw 'exit (cdr entry))))
11515 nil)))))
11517 (defvar org-refile-target-table nil
11518 "The list of refile targets, created by `org-refile'.")
11520 (defvar org-agenda-new-buffers nil
11521 "Buffers created to visit agenda files.")
11523 (defvar org-refile-cache nil
11524 "Cache for refile targets.")
11526 (defvar org-refile-markers nil
11527 "All the markers used for caching refile locations.")
11529 (defun org-refile-marker (pos)
11530 "Get a new refile marker, but only if caching is in use."
11531 (if (not org-refile-use-cache)
11533 (let ((m (make-marker)))
11534 (move-marker m pos)
11535 (push m org-refile-markers)
11536 m)))
11538 (defun org-refile-cache-clear ()
11539 "Clear the refile cache and disable all the markers."
11540 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11541 (setq org-refile-markers nil)
11542 (setq org-refile-cache nil)
11543 (message "Refile cache has been cleared"))
11545 (defun org-refile-cache-check-set (set)
11546 "Check if all the markers in the cache still have live buffers."
11547 (let (marker)
11548 (catch 'exit
11549 (while (and set (setq marker (nth 3 (pop set))))
11550 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11551 (when (and marker (null (marker-buffer marker)))
11552 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11553 (sit-for 3)
11554 (throw 'exit nil)))
11555 t)))
11557 (defun org-refile-cache-put (set &rest identifiers)
11558 "Push the refile targets SET into the cache, under IDENTIFIERS."
11559 (let* ((key (sha1 (prin1-to-string identifiers)))
11560 (entry (assoc key org-refile-cache)))
11561 (if entry
11562 (setcdr entry set)
11563 (push (cons key set) org-refile-cache))))
11565 (defun org-refile-cache-get (&rest identifiers)
11566 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11567 (cond
11568 ((not org-refile-cache) nil)
11569 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11571 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11572 org-refile-cache))))
11573 (and set (org-refile-cache-check-set set) set)))))
11575 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11576 "Produce a table with refile targets."
11577 (let ((case-fold-search nil)
11578 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11579 (entries (or org-refile-targets '((nil . (:level . 1)))))
11580 targets tgs txt re files f desc descre fast-path-p level pos0)
11581 (message "Getting targets...")
11582 (with-current-buffer (or default-buffer (current-buffer))
11583 (while (setq entry (pop entries))
11584 (setq files (car entry) desc (cdr entry))
11585 (setq fast-path-p nil)
11586 (cond
11587 ((null files) (setq files (list (current-buffer))))
11588 ((eq files 'org-agenda-files)
11589 (setq files (org-agenda-files 'unrestricted)))
11590 ((and (symbolp files) (fboundp files))
11591 (setq files (funcall files)))
11592 ((and (symbolp files) (boundp files))
11593 (setq files (symbol-value files))))
11594 (if (stringp files) (setq files (list files)))
11595 (cond
11596 ((eq (car desc) :tag)
11597 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11598 ((eq (car desc) :todo)
11599 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11600 ((eq (car desc) :regexp)
11601 (setq descre (cdr desc)))
11602 ((eq (car desc) :level)
11603 (setq descre (concat "^\\*\\{" (number-to-string
11604 (if org-odd-levels-only
11605 (1- (* 2 (cdr desc)))
11606 (cdr desc)))
11607 "\\}[ \t]")))
11608 ((eq (car desc) :maxlevel)
11609 (setq fast-path-p t)
11610 (setq descre (concat "^\\*\\{1," (number-to-string
11611 (if org-odd-levels-only
11612 (1- (* 2 (cdr desc)))
11613 (cdr desc)))
11614 "\\}[ \t]")))
11615 (t (error "Bad refiling target description %s" desc)))
11616 (while (setq f (pop files))
11617 (with-current-buffer
11618 (if (bufferp f) f (org-get-agenda-file-buffer f))
11620 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11621 (progn
11622 (if (bufferp f) (setq f (buffer-file-name
11623 (buffer-base-buffer f))))
11624 (setq f (and f (expand-file-name f)))
11625 (if (eq org-refile-use-outline-path 'file)
11626 (push (list (file-name-nondirectory f) f nil nil) tgs))
11627 (save-excursion
11628 (save-restriction
11629 (widen)
11630 (goto-char (point-min))
11631 (while (re-search-forward descre nil t)
11632 (goto-char (setq pos0 (point-at-bol)))
11633 (catch 'next
11634 (when org-refile-target-verify-function
11635 (save-match-data
11636 (or (funcall org-refile-target-verify-function)
11637 (throw 'next t))))
11638 (when (and (looking-at org-complex-heading-regexp)
11639 (not (member (match-string 4) excluded-entries))
11640 (match-string 4))
11641 (setq level (org-reduced-level
11642 (- (match-end 1) (match-beginning 1)))
11643 txt (org-link-display-format (match-string 4))
11644 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11645 re (format org-complex-heading-regexp-format
11646 (regexp-quote (match-string 4))))
11647 (when org-refile-use-outline-path
11648 (setq txt (mapconcat
11649 'org-protect-slash
11650 (append
11651 (if (eq org-refile-use-outline-path
11652 'file)
11653 (list (file-name-nondirectory
11654 (buffer-file-name
11655 (buffer-base-buffer))))
11656 (if (eq org-refile-use-outline-path
11657 'full-file-path)
11658 (list (buffer-file-name
11659 (buffer-base-buffer)))))
11660 (org-get-outline-path fast-path-p
11661 level txt)
11662 (list txt))
11663 "/")))
11664 (push (list txt f re (org-refile-marker (point)))
11665 tgs)))
11666 (when (= (point) pos0)
11667 ;; verification function has not moved point
11668 (goto-char (point-at-eol))))))))
11669 (when org-refile-use-cache
11670 (org-refile-cache-put tgs (buffer-file-name) descre))
11671 (setq targets (append tgs targets))))))
11672 (message "Getting targets...done")
11673 (nreverse targets)))
11675 (defun org-protect-slash (s)
11676 (while (string-match "/" s)
11677 (setq s (replace-match "\\" t t s)))
11680 (defvar org-olpa (make-vector 20 nil))
11682 (defun org-get-outline-path (&optional fastp level heading)
11683 "Return the outline path to the current entry, as a list.
11685 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11686 routine which makes outline path derivations for an entire file,
11687 avoiding backtracing. Refile target collection makes use of that."
11688 (if fastp
11689 (progn
11690 (if (> level 19)
11691 (error "Outline path failure, more than 19 levels"))
11692 (loop for i from level upto 19 do
11693 (aset org-olpa i nil))
11694 (prog1
11695 (delq nil (append org-olpa nil))
11696 (aset org-olpa level heading)))
11697 (let (rtn case-fold-search)
11698 (save-excursion
11699 (save-restriction
11700 (widen)
11701 (while (org-up-heading-safe)
11702 (when (looking-at org-complex-heading-regexp)
11703 (push (org-trim
11704 (replace-regexp-in-string
11705 ;; Remove statistical/checkboxes cookies
11706 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11707 (org-match-string-no-properties 4)))
11708 rtn)))
11709 rtn)))))
11711 (defun org-format-outline-path (path &optional width prefix separator)
11712 "Format the outline path PATH for display.
11713 WIDTH is the maximum number of characters that is available.
11714 PREFIX is a prefix to be included in the returned string,
11715 such as the file name.
11716 SEPARATOR is inserted between the different parts of the path,
11717 the default is \"/\"."
11718 (setq width (or width 79))
11719 (if prefix (setq width (- width (length prefix))))
11720 (if (not path)
11721 (or prefix "")
11722 (let* ((nsteps (length path))
11723 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11724 (maxwidth (if (<= total-width width)
11725 10000 ;; everything fits
11726 ;; we need to shorten the level headings
11727 (/ (- width nsteps) nsteps)))
11728 (org-odd-levels-only nil)
11729 (n 0)
11730 (total (1+ (length prefix))))
11731 (setq maxwidth (max maxwidth 10))
11732 (concat prefix
11733 (if prefix (or separator "/"))
11734 (mapconcat
11735 (lambda (h)
11736 (setq n (1+ n))
11737 (if (and (= n nsteps) (< maxwidth 10000))
11738 (setq maxwidth (- total-width total)))
11739 (if (< (length h) maxwidth)
11740 (progn (setq total (+ total (length h) 1)) h)
11741 (setq h (substring h 0 (- maxwidth 2))
11742 total (+ total maxwidth 1))
11743 (if (string-match "[ \t]+\\'" h)
11744 (setq h (substring h 0 (match-beginning 0))))
11745 (setq h (concat h "..")))
11746 (org-add-props h nil 'face
11747 (nth (% (1- n) org-n-level-faces)
11748 org-level-faces))
11750 path (or separator "/"))))))
11752 (defun org-display-outline-path (&optional file current separator just-return-string)
11753 "Display the current outline path in the echo area.
11755 If FILE is non-nil, prepend the output with the file name.
11756 If CURRENT is non-nil, append the current heading to the output.
11757 SEPARATOR is passed through to `org-format-outline-path'. It separates
11758 the different parts of the path and defaults to \"/\".
11759 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11760 (interactive "P")
11761 (let* (case-fold-search
11762 (bfn (buffer-file-name (buffer-base-buffer)))
11763 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11764 res)
11765 (if current (setq path (append path
11766 (save-excursion
11767 (org-back-to-heading t)
11768 (if (looking-at org-complex-heading-regexp)
11769 (list (match-string 4)))))))
11770 (setq res
11771 (org-format-outline-path
11772 path
11773 (1- (frame-width))
11774 (and file bfn (concat (file-name-nondirectory bfn) separator))
11775 separator))
11776 (if just-return-string
11777 (org-no-properties res)
11778 (org-unlogged-message "%s" res))))
11780 (defvar org-refile-history nil
11781 "History for refiling operations.")
11783 (defvar org-after-refile-insert-hook nil
11784 "Hook run after `org-refile' has inserted its stuff at the new location.
11785 Note that this is still *before* the stuff will be removed from
11786 the *old* location.")
11788 (defvar org-capture-last-stored-marker)
11789 (defvar org-refile-keep nil
11790 "Non-nil means `org-refile' will copy instead of refile.")
11792 (defun org-copy ()
11793 "Like `org-refile', but copy."
11794 (interactive)
11795 (let ((org-refile-keep t))
11796 (funcall 'org-refile nil nil nil "Copy")))
11798 (defun org-refile (&optional arg default-buffer rfloc msg)
11799 "Move the entry or entries at point to another heading.
11800 The list of target headings is compiled using the information in
11801 `org-refile-targets', which see.
11803 At the target location, the entry is filed as a subitem of the
11804 target heading. Depending on `org-reverse-note-order', the new
11805 subitem will either be the first or the last subitem.
11807 If there is an active region, all entries in that region will be
11808 refiled. However, the region must fulfill the requirement that
11809 the first heading sets the top-level of the moved text.
11811 With prefix arg ARG, the command will only visit the target
11812 location and not actually move anything.
11814 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11815 refiling operation has put the subtree.
11817 With a numeric prefix argument of `2', refile to the running clock.
11819 With a numeric prefix argument of `3', emulate `org-refile-keep'
11820 being set to `t' and copy to the target location, don't move it.
11821 Beware that keeping refiled entries may result in duplicated ID
11822 properties.
11824 RFLOC can be a refile location obtained in a different way.
11826 MSG is a string to replace \"Refile\" in the default prompt with
11827 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11829 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11831 If you are using target caching (see `org-refile-use-cache'), you
11832 have to clear the target cache in order to find new targets.
11833 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11834 prefix argument (`C-u C-u C-u C-c C-w')."
11835 (interactive "P")
11836 (if (member arg '(0 (64)))
11837 (org-refile-cache-clear)
11838 (let* ((actionmsg (cond (msg msg)
11839 ((equal arg 3) "Refile (and keep)")
11840 (t "Refile")))
11841 (cbuf (current-buffer))
11842 (regionp (org-region-active-p))
11843 (region-start (and regionp (region-beginning)))
11844 (region-end (and regionp (region-end)))
11845 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11846 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11847 pos it nbuf file re level reversed)
11848 (setq last-command nil)
11849 (when regionp
11850 (goto-char region-start)
11851 (or (bolp) (goto-char (point-at-bol)))
11852 (setq region-start (point))
11853 (unless (or (org-kill-is-subtree-p
11854 (buffer-substring region-start region-end))
11855 (prog1 org-refile-active-region-within-subtree
11856 (let ((s (point-at-eol)))
11857 (org-toggle-heading)
11858 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11859 (user-error "The region is not a (sequence of) subtree(s)")))
11860 (if (equal arg '(16))
11861 (org-refile-goto-last-stored)
11862 (when (or
11863 (and (equal arg 2)
11864 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11865 (prog1
11866 (setq it (list (or org-clock-heading "running clock")
11867 (buffer-file-name
11868 (marker-buffer org-clock-hd-marker))
11870 (marker-position org-clock-hd-marker)))
11871 (setq arg nil)))
11872 (setq it (or rfloc
11873 (let (heading-text)
11874 (save-excursion
11875 (unless (and arg (listp arg))
11876 (org-back-to-heading t)
11877 (setq heading-text
11878 (replace-regexp-in-string
11879 org-bracket-link-regexp
11880 "\\3"
11881 (nth 4 (org-heading-components)))))
11882 (org-refile-get-location
11883 (cond ((and arg (listp arg)) "Goto")
11884 (regionp (concat actionmsg " region to"))
11885 (t (concat actionmsg " subtree \""
11886 heading-text "\" to")))
11887 default-buffer
11888 (and (not (equal '(4) arg))
11889 org-refile-allow-creating-parent-nodes)
11890 arg))))))
11891 (setq file (nth 1 it)
11892 re (nth 2 it)
11893 pos (nth 3 it))
11894 (if (and (not arg)
11896 (equal (buffer-file-name) file)
11897 (if regionp
11898 (and (>= pos region-start)
11899 (<= pos region-end))
11900 (and (>= pos (point))
11901 (< pos (save-excursion
11902 (org-end-of-subtree t t))))))
11903 (error "Cannot refile to position inside the tree or region"))
11904 (setq nbuf (or (find-buffer-visiting file)
11905 (find-file-noselect file)))
11906 (if (and arg (not (equal arg 3)))
11907 (progn
11908 (org-pop-to-buffer-same-window nbuf)
11909 (goto-char pos)
11910 (org-show-context 'org-goto))
11911 (if regionp
11912 (progn
11913 (org-kill-new (buffer-substring region-start region-end))
11914 (org-save-markers-in-region region-start region-end))
11915 (org-copy-subtree 1 nil t))
11916 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11917 (find-file-noselect file)))
11918 (setq reversed (org-notes-order-reversed-p))
11919 (save-excursion
11920 (save-restriction
11921 (widen)
11922 (if pos
11923 (progn
11924 (goto-char pos)
11925 (looking-at org-outline-regexp)
11926 (setq level (org-get-valid-level (funcall outline-level) 1))
11927 (goto-char
11928 (if reversed
11929 (or (outline-next-heading) (point-max))
11930 (or (save-excursion (org-get-next-sibling))
11931 (org-end-of-subtree t t)
11932 (point-max)))))
11933 (setq level 1)
11934 (if (not reversed)
11935 (goto-char (point-max))
11936 (goto-char (point-min))
11937 (or (outline-next-heading) (goto-char (point-max)))))
11938 (if (not (bolp)) (newline))
11939 (org-paste-subtree level nil nil t)
11940 (when org-log-refile
11941 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11942 (unless (eq org-log-refile 'note)
11943 (save-excursion (org-add-log-note))))
11944 (and org-auto-align-tags
11945 (let ((org-loop-over-headlines-in-active-region nil))
11946 (org-set-tags nil t)))
11947 (let ((bookmark-name (plist-get org-bookmark-names-plist
11948 :last-refile)))
11949 (when bookmark-name
11950 (with-demoted-errors
11951 (bookmark-set bookmark-name))))
11952 ;; If we are refiling for capture, make sure that the
11953 ;; last-capture pointers point here
11954 (when (org-bound-and-true-p org-refile-for-capture)
11955 (let ((bookmark-name (plist-get org-bookmark-names-plist
11956 :last-capture-marker)))
11957 (when bookmark-name
11958 (with-demoted-errors
11959 (bookmark-set bookmark-name))))
11960 (move-marker org-capture-last-stored-marker (point)))
11961 (if (fboundp 'deactivate-mark) (deactivate-mark))
11962 (run-hooks 'org-after-refile-insert-hook))))
11963 (unless org-refile-keep
11964 (if regionp
11965 (delete-region (point) (+ (point) (- region-end region-start)))
11966 (delete-region
11967 (and (org-back-to-heading t) (point))
11968 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11969 (when (featurep 'org-inlinetask)
11970 (org-inlinetask-remove-END-maybe))
11971 (setq org-markers-to-move nil)
11972 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11974 (defun org-refile-goto-last-stored ()
11975 "Go to the location where the last refile was stored."
11976 (interactive)
11977 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11978 (message "This is the location of the last refile"))
11980 (defun org-refile--get-location (refloc tbl)
11981 "When user refile to REFLOC, find the associated target in TBL.
11982 Also check `org-refile-target-table'."
11983 (car (delq
11985 (mapcar
11986 (lambda (r) (or (assoc r tbl)
11987 (assoc r org-refile-target-table)))
11988 (list (replace-regexp-in-string "/$" "" refloc)
11989 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11991 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11992 no-exclude)
11993 "Prompt the user for a refile location, using PROMPT.
11994 PROMPT should not be suffixed with a colon and a space, because
11995 this function appends the default value from
11996 `org-refile-history' automatically, if that is not empty.
11997 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11998 this is used for the GOTO interface."
11999 (let ((org-refile-targets org-refile-targets)
12000 (org-refile-use-outline-path org-refile-use-outline-path)
12001 excluded-entries)
12002 (when (and (derived-mode-p 'org-mode)
12003 (not org-refile-use-cache)
12004 (not no-exclude))
12005 (org-map-tree
12006 (lambda()
12007 (setq excluded-entries
12008 (append excluded-entries (list (org-get-heading t t)))))))
12009 (setq org-refile-target-table
12010 (org-refile-get-targets default-buffer excluded-entries)))
12011 (unless org-refile-target-table
12012 (user-error "No refile targets"))
12013 (let* ((cbuf (current-buffer))
12014 (partial-completion-mode nil)
12015 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12016 (cfunc (if (and org-refile-use-outline-path
12017 org-outline-path-complete-in-steps)
12018 'org-olpath-completing-read
12019 'org-icompleting-read))
12020 (extra (if org-refile-use-outline-path "/" ""))
12021 (cbnex (concat (buffer-name) extra))
12022 (filename (and cfn (expand-file-name cfn)))
12023 (tbl (mapcar
12024 (lambda (x)
12025 (if (and (not (member org-refile-use-outline-path
12026 '(file full-file-path)))
12027 (not (equal filename (nth 1 x))))
12028 (cons (concat (car x) extra " ("
12029 (file-name-nondirectory (nth 1 x)) ")")
12030 (cdr x))
12031 (cons (concat (car x) extra) (cdr x))))
12032 org-refile-target-table))
12033 (completion-ignore-case t)
12034 cdef
12035 (prompt (concat prompt
12036 (or (and (car org-refile-history)
12037 (concat " (default " (car org-refile-history) ")"))
12038 (and (assoc cbnex tbl) (setq cdef cbnex)
12039 (concat " (default " cbnex ")"))) ": "))
12040 pa answ parent-target child parent old-hist)
12041 (setq old-hist org-refile-history)
12042 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12043 nil 'org-refile-history (or cdef (car org-refile-history))))
12044 (if (setq pa (org-refile--get-location answ tbl))
12045 (progn
12046 (org-refile-check-position pa)
12047 (when (or (not org-refile-history)
12048 (not (eq old-hist org-refile-history))
12049 (not (equal (car pa) (car org-refile-history))))
12050 (setq org-refile-history
12051 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12052 org-refile-history
12053 (cdr org-refile-history))))
12054 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12055 (pop org-refile-history)))
12057 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12058 (progn
12059 (setq parent (match-string 1 answ)
12060 child (match-string 2 answ))
12061 (setq parent-target (org-refile--get-location parent tbl))
12062 (when (and parent-target
12063 (or (eq new-nodes t)
12064 (and (eq new-nodes 'confirm)
12065 (y-or-n-p (format "Create new node \"%s\"? "
12066 child)))))
12067 (org-refile-new-child parent-target child)))
12068 (user-error "Invalid target location")))))
12070 (declare-function org-string-nw-p "org-macs" (s))
12071 (defun org-refile-check-position (refile-pointer)
12072 "Check if the refile pointer matches the headline to which it points."
12073 (let* ((file (nth 1 refile-pointer))
12074 (re (nth 2 refile-pointer))
12075 (pos (nth 3 refile-pointer))
12076 buffer)
12077 (if (and (not (markerp pos)) (not file))
12078 (user-error "Please indicate a target file in the refile path")
12079 (when (org-string-nw-p re)
12080 (setq buffer (if (markerp pos)
12081 (marker-buffer pos)
12082 (or (find-buffer-visiting file)
12083 (find-file-noselect file))))
12084 (with-current-buffer buffer
12085 (save-excursion
12086 (save-restriction
12087 (widen)
12088 (goto-char pos)
12089 (beginning-of-line 1)
12090 (unless (org-looking-at-p re)
12091 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12093 (defun org-refile-new-child (parent-target child)
12094 "Use refile target PARENT-TARGET to add new CHILD below it."
12095 (unless parent-target
12096 (error "Cannot find parent for new node"))
12097 (let ((file (nth 1 parent-target))
12098 (pos (nth 3 parent-target))
12099 level)
12100 (with-current-buffer (or (find-buffer-visiting file)
12101 (find-file-noselect file))
12102 (save-excursion
12103 (save-restriction
12104 (widen)
12105 (if pos
12106 (goto-char pos)
12107 (goto-char (point-max))
12108 (if (not (bolp)) (newline)))
12109 (when (looking-at org-outline-regexp)
12110 (setq level (funcall outline-level))
12111 (org-end-of-subtree t t))
12112 (org-back-over-empty-lines)
12113 (insert "\n" (make-string
12114 (if pos (org-get-valid-level level 1) 1) ?*)
12115 " " child "\n")
12116 (beginning-of-line 0)
12117 (list (concat (car parent-target) "/" child) file "" (point)))))))
12119 (defun org-olpath-completing-read (prompt collection &rest args)
12120 "Read an outline path like a file name."
12121 (let ((thetable collection)
12122 (org-completion-use-ido nil) ; does not work with ido.
12123 (org-completion-use-iswitchb nil)) ; or iswitchb
12124 (apply
12125 'org-icompleting-read prompt
12126 (lambda (string predicate &optional flag)
12127 (let (rtn r f (l (length string)))
12128 (cond
12129 ((eq flag nil)
12130 ;; try completion
12131 (try-completion string thetable))
12132 ((eq flag t)
12133 ;; all-completions
12134 (setq rtn (all-completions string thetable predicate))
12135 (mapcar
12136 (lambda (x)
12137 (setq r (substring x l))
12138 (if (string-match " ([^)]*)$" x)
12139 (setq f (match-string 0 x))
12140 (setq f ""))
12141 (if (string-match "/" r)
12142 (concat string (substring r 0 (match-end 0)) f)
12144 rtn))
12145 ((eq flag 'lambda)
12146 ;; exact match?
12147 (assoc string thetable)))))
12148 args)))
12150 ;;;; Dynamic blocks
12152 (defun org-find-dblock (name)
12153 "Find the first dynamic block with name NAME in the buffer.
12154 If not found, stay at current position and return nil."
12155 (let ((case-fold-search t) pos)
12156 (save-excursion
12157 (goto-char (point-min))
12158 (setq pos (and (re-search-forward
12159 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12160 (match-beginning 0))))
12161 (if pos (goto-char pos))
12162 pos))
12164 (defun org-create-dblock (plist)
12165 "Create a dynamic block section, with parameters taken from PLIST.
12166 PLIST must contain a :name entry which is used as the name of the block."
12167 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12168 (end-of-line 1)
12169 (newline))
12170 (let ((col (current-column))
12171 (name (plist-get plist :name)))
12172 (insert "#+BEGIN: " name)
12173 (while plist
12174 (if (eq (car plist) :name)
12175 (setq plist (cddr plist))
12176 (insert " " (prin1-to-string (pop plist)))))
12177 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12178 (beginning-of-line -2)))
12180 (defun org-prepare-dblock ()
12181 "Prepare dynamic block for refresh.
12182 This empties the block, puts the cursor at the insert position and returns
12183 the property list including an extra property :name with the block name."
12184 (unless (looking-at org-dblock-start-re)
12185 (user-error "Not at a dynamic block"))
12186 (let* ((begdel (1+ (match-end 0)))
12187 (name (org-no-properties (match-string 1)))
12188 (params (append (list :name name)
12189 (read (concat "(" (match-string 3) ")")))))
12190 (save-excursion
12191 (beginning-of-line 1)
12192 (skip-chars-forward " \t")
12193 (setq params (plist-put params :indentation-column (current-column))))
12194 (unless (re-search-forward org-dblock-end-re nil t)
12195 (error "Dynamic block not terminated"))
12196 (setq params
12197 (append params
12198 (list :content (buffer-substring
12199 begdel (match-beginning 0)))))
12200 (delete-region begdel (match-beginning 0))
12201 (goto-char begdel)
12202 (open-line 1)
12203 params))
12205 (defun org-map-dblocks (&optional command)
12206 "Apply COMMAND to all dynamic blocks in the current buffer.
12207 If COMMAND is not given, use `org-update-dblock'."
12208 (let ((cmd (or command 'org-update-dblock)))
12209 (save-excursion
12210 (goto-char (point-min))
12211 (while (re-search-forward org-dblock-start-re nil t)
12212 (goto-char (match-beginning 0))
12213 (save-excursion
12214 (condition-case nil
12215 (funcall cmd)
12216 (error (message "Error during update of dynamic block"))))
12217 (unless (re-search-forward org-dblock-end-re nil t)
12218 (error "Dynamic block not terminated"))))))
12220 (defun org-dblock-update (&optional arg)
12221 "User command for updating dynamic blocks.
12222 Update the dynamic block at point. With prefix ARG, update all dynamic
12223 blocks in the buffer."
12224 (interactive "P")
12225 (if arg
12226 (org-update-all-dblocks)
12227 (or (looking-at org-dblock-start-re)
12228 (org-beginning-of-dblock))
12229 (org-update-dblock)))
12231 (defun org-update-dblock ()
12232 "Update the dynamic block at point.
12233 This means to empty the block, parse for parameters and then call
12234 the correct writing function."
12235 (interactive)
12236 (save-excursion
12237 (let* ((win (selected-window))
12238 (pos (point))
12239 (line (org-current-line))
12240 (params (org-prepare-dblock))
12241 (name (plist-get params :name))
12242 (indent (plist-get params :indentation-column))
12243 (cmd (intern (concat "org-dblock-write:" name))))
12244 (message "Updating dynamic block `%s' at line %d..." name line)
12245 (funcall cmd params)
12246 (message "Updating dynamic block `%s' at line %d...done" name line)
12247 (goto-char pos)
12248 (when (and indent (> indent 0))
12249 (setq indent (make-string indent ?\ ))
12250 (save-excursion
12251 (select-window win)
12252 (org-beginning-of-dblock)
12253 (forward-line 1)
12254 (while (not (looking-at org-dblock-end-re))
12255 (insert indent)
12256 (beginning-of-line 2))
12257 (when (looking-at org-dblock-end-re)
12258 (and (looking-at "[ \t]+")
12259 (replace-match ""))
12260 (insert indent)))))))
12262 (defun org-beginning-of-dblock ()
12263 "Find the beginning of the dynamic block at point.
12264 Error if there is no such block at point."
12265 (let ((pos (point))
12266 beg)
12267 (end-of-line 1)
12268 (if (and (re-search-backward org-dblock-start-re nil t)
12269 (setq beg (match-beginning 0))
12270 (re-search-forward org-dblock-end-re nil t)
12271 (> (match-end 0) pos))
12272 (goto-char beg)
12273 (goto-char pos)
12274 (error "Not in a dynamic block"))))
12276 (defun org-update-all-dblocks ()
12277 "Update all dynamic blocks in the buffer.
12278 This function can be used in a hook."
12279 (interactive)
12280 (when (derived-mode-p 'org-mode)
12281 (org-map-dblocks 'org-update-dblock)))
12284 ;;;; Completion
12286 (declare-function org-export-backend-name "org-export" (cl-x))
12287 (declare-function org-export-backend-options "org-export" (cl-x))
12288 (defun org-get-export-keywords ()
12289 "Return a list of all currently understood export keywords.
12290 Export keywords include options, block names, attributes and
12291 keywords relative to each registered export back-end."
12292 (let (keywords)
12293 (dolist (backend
12294 (org-bound-and-true-p org-export-registered-backends)
12295 (delq nil keywords))
12296 ;; Back-end name (for keywords, like #+LATEX:)
12297 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12298 (dolist (option-entry (org-export-backend-options backend))
12299 ;; Back-end options.
12300 (push (nth 1 option-entry) keywords)))))
12302 (defconst org-options-keywords
12303 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12304 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12305 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12306 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12307 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12309 (defcustom org-structure-template-alist
12310 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12311 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12312 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12313 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12314 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12315 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12316 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12317 ("L" "#+LaTeX: ")
12318 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12319 ("H" "#+HTML: ")
12320 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12321 ("A" "#+ASCII: ")
12322 ("i" "#+INDEX: ?")
12323 ("I" "#+INCLUDE: %file ?"))
12324 "Structure completion elements.
12325 This is a list of abbreviation keys and values. The value gets inserted
12326 if you type `<' followed by the key and then press the completion key,
12327 usually `TAB'. %file will be replaced by a file name after prompting
12328 for the file using completion. The cursor will be placed at the position
12329 of the `?` in the template.
12330 There are two templates for each key, the first uses the original Org syntax,
12331 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12332 the default when the /org-mtags.el/ module has been loaded. See also the
12333 variable `org-mtags-prefer-muse-templates'."
12334 :group 'org-completion
12335 :type '(repeat
12336 (list
12337 (string :tag "Key")
12338 (string :tag "Template")))
12339 :version "25.1"
12340 :package-version '(Org . "8.3"))
12342 (defun org-try-structure-completion ()
12343 "Try to complete a structure template before point.
12344 This looks for strings like \"<e\" on an otherwise empty line and
12345 expands them."
12346 (let ((l (buffer-substring (point-at-bol) (point)))
12348 (when (and (looking-at "[ \t]*$")
12349 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12350 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12351 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12352 (match-beginning 1)) a)
12353 t)))
12355 (defun org-complete-expand-structure-template (start cell)
12356 "Expand a structure template."
12357 (let ((rpl (nth 1 cell))
12358 (ind ""))
12359 (delete-region start (point))
12360 (when (string-match "\\`[ \t]*#\\+" rpl)
12361 (cond
12362 ((bolp))
12363 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12364 (setq ind (buffer-substring (point-at-bol) (point))))
12365 (t (newline))))
12366 (setq start (point))
12367 (if (string-match "%file" rpl)
12368 (setq rpl (replace-match
12369 (concat
12370 "\""
12371 (save-match-data
12372 (abbreviate-file-name (read-file-name "Include file: ")))
12373 "\"")
12374 t t rpl)))
12375 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12376 (concat "\n" ind)))
12377 (insert rpl)
12378 (if (re-search-backward "\\?" start t) (delete-char 1))))
12380 ;;;; TODO, DEADLINE, Comments
12382 (defun org-toggle-comment ()
12383 "Change the COMMENT state of an entry."
12384 (interactive)
12385 (save-excursion
12386 (org-back-to-heading)
12387 (looking-at org-complex-heading-regexp)
12388 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12389 (skip-chars-forward " \t")
12390 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12391 (if (org-in-commented-heading-p t)
12392 (delete-region (point)
12393 (progn (search-forward " " (line-end-position) 'move)
12394 (skip-chars-forward " \t")
12395 (point)))
12396 (insert org-comment-string)
12397 (unless (eolp) (insert " ")))))
12399 (defvar org-last-todo-state-is-todo nil
12400 "This is non-nil when the last TODO state change led to a TODO state.
12401 If the last change removed the TODO tag or switched to DONE, then
12402 this is nil.")
12404 (defvar org-setting-tags nil) ; dynamically skipped
12406 (defvar org-todo-setup-filter-hook nil
12407 "Hook for functions that pre-filter todo specs.
12408 Each function takes a todo spec and returns either nil or the spec
12409 transformed into canonical form." )
12411 (defvar org-todo-get-default-hook nil
12412 "Hook for functions that get a default item for todo.
12413 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12414 nil or a string to be used for the todo mark." )
12416 (defvar org-agenda-headline-snapshot-before-repeat)
12418 (defun org-current-effective-time ()
12419 "Return current time adjusted for `org-extend-today-until' variable."
12420 (let* ((ct (org-current-time))
12421 (dct (decode-time ct))
12422 (ct1
12423 (cond
12424 (org-use-last-clock-out-time-as-effective-time
12425 (or (org-clock-get-last-clock-out-time) ct))
12426 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12427 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12428 (t ct))))
12429 ct1))
12431 (defun org-todo-yesterday (&optional arg)
12432 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12433 (interactive "P")
12434 (if (eq major-mode 'org-agenda-mode)
12435 (apply 'org-agenda-todo-yesterday arg)
12436 (let* ((org-use-effective-time t)
12437 (hour (third (decode-time
12438 (org-current-time))))
12439 (org-extend-today-until (1+ hour)))
12440 (org-todo arg))))
12442 (defvar org-block-entry-blocking ""
12443 "First entry preventing the TODO state change.")
12445 (defun org-cancel-repeater ()
12446 "Cancel a repeater by setting its numeric value to zero."
12447 (interactive)
12448 (save-excursion
12449 (org-back-to-heading t)
12450 (let ((bound1 (point))
12451 (bound0 (save-excursion (outline-next-heading) (point))))
12452 (when (re-search-forward
12453 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12454 org-deadline-time-regexp "\\)\\|\\("
12455 org-ts-regexp "\\)")
12456 bound0 t)
12457 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12458 (replace-match "0" t nil nil 1))))))
12460 (defun org-todo (&optional arg)
12461 "Change the TODO state of an item.
12462 The state of an item is given by a keyword at the start of the heading,
12463 like
12464 *** TODO Write paper
12465 *** DONE Call mom
12467 The different keywords are specified in the variable `org-todo-keywords'.
12468 By default the available states are \"TODO\" and \"DONE\".
12469 So for this example: when the item starts with TODO, it is changed to DONE.
12470 When it starts with DONE, the DONE is removed. And when neither TODO nor
12471 DONE are present, add TODO at the beginning of the heading.
12473 With \\[universal-argument] prefix arg, use completion to determine the new \
12474 state.
12475 With numeric prefix arg, switch to that state.
12476 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12477 keywords (nextset).
12478 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12479 With a numeric prefix arg of 0, inhibit note taking for the change.
12480 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12482 When called through ELisp, arg is also interpreted in the following way:
12483 'none -> empty state
12484 \"\"(empty string) -> switch to empty state
12485 'done -> switch to DONE
12486 'nextset -> switch to the next set of keywords
12487 'previousset -> switch to the previous set of keywords
12488 \"WAITING\" -> switch to the specified keyword, but only if it
12489 really is a member of `org-todo-keywords'."
12490 (interactive "P")
12491 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12492 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12493 'region-start-level 'region))
12494 org-loop-over-headlines-in-active-region)
12495 (org-map-entries
12496 `(org-todo ,arg)
12497 org-loop-over-headlines-in-active-region
12498 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12499 (if (equal arg '(16)) (setq arg 'nextset))
12500 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12501 (let ((org-blocker-hook org-blocker-hook)
12502 commentp
12503 case-fold-search)
12504 (when (equal arg '(64))
12505 (setq arg nil org-blocker-hook nil))
12506 (when (and org-blocker-hook
12507 (or org-inhibit-blocking
12508 (org-entry-get nil "NOBLOCKING")))
12509 (setq org-blocker-hook nil))
12510 (save-excursion
12511 (catch 'exit
12512 (org-back-to-heading t)
12513 (when (org-in-commented-heading-p t)
12514 (org-toggle-comment)
12515 (setq commentp t))
12516 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12517 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12518 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12519 (let* ((match-data (match-data))
12520 (startpos (point-at-bol))
12521 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12522 (org-log-done org-log-done)
12523 (org-log-repeat org-log-repeat)
12524 (org-todo-log-states org-todo-log-states)
12525 (org-inhibit-logging
12526 (if (equal arg 0)
12527 (progn (setq arg nil) 'note) org-inhibit-logging))
12528 (this (match-string 1))
12529 (hl-pos (match-beginning 0))
12530 (head (org-get-todo-sequence-head this))
12531 (ass (assoc head org-todo-kwd-alist))
12532 (interpret (nth 1 ass))
12533 (done-word (nth 3 ass))
12534 (final-done-word (nth 4 ass))
12535 (org-last-state (or this ""))
12536 (completion-ignore-case t)
12537 (member (member this org-todo-keywords-1))
12538 (tail (cdr member))
12539 (org-state (cond
12540 ((and org-todo-key-trigger
12541 (or (and (equal arg '(4))
12542 (eq org-use-fast-todo-selection 'prefix))
12543 (and (not arg) org-use-fast-todo-selection
12544 (not (eq org-use-fast-todo-selection
12545 'prefix)))))
12546 ;; Use fast selection
12547 (org-fast-todo-selection))
12548 ((and (equal arg '(4))
12549 (or (not org-use-fast-todo-selection)
12550 (not org-todo-key-trigger)))
12551 ;; Read a state with completion
12552 (org-icompleting-read
12553 "State: " (mapcar 'list org-todo-keywords-1)
12554 nil t))
12555 ((eq arg 'right)
12556 (if this
12557 (if tail (car tail) nil)
12558 (car org-todo-keywords-1)))
12559 ((eq arg 'left)
12560 (if (equal member org-todo-keywords-1)
12562 (if this
12563 (nth (- (length org-todo-keywords-1)
12564 (length tail) 2)
12565 org-todo-keywords-1)
12566 (org-last org-todo-keywords-1))))
12567 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12568 (setq arg nil))) ; hack to fall back to cycling
12569 (arg
12570 ;; user or caller requests a specific state
12571 (cond
12572 ((equal arg "") nil)
12573 ((eq arg 'none) nil)
12574 ((eq arg 'done) (or done-word (car org-done-keywords)))
12575 ((eq arg 'nextset)
12576 (or (car (cdr (member head org-todo-heads)))
12577 (car org-todo-heads)))
12578 ((eq arg 'previousset)
12579 (let ((org-todo-heads (reverse org-todo-heads)))
12580 (or (car (cdr (member head org-todo-heads)))
12581 (car org-todo-heads))))
12582 ((car (member arg org-todo-keywords-1)))
12583 ((stringp arg)
12584 (user-error "State `%s' not valid in this file" arg))
12585 ((nth (1- (prefix-numeric-value arg))
12586 org-todo-keywords-1))))
12587 ((null member) (or head (car org-todo-keywords-1)))
12588 ((equal this final-done-word) nil) ;; -> make empty
12589 ((null tail) nil) ;; -> first entry
12590 ((memq interpret '(type priority))
12591 (if (eq this-command last-command)
12592 (car tail)
12593 (if (> (length tail) 0)
12594 (or done-word (car org-done-keywords))
12595 nil)))
12597 (car tail))))
12598 (org-state (or
12599 (run-hook-with-args-until-success
12600 'org-todo-get-default-hook org-state org-last-state)
12601 org-state))
12602 (next (if org-state (concat " " org-state " ") " "))
12603 (change-plist (list :type 'todo-state-change :from this :to org-state
12604 :position startpos))
12605 dolog now-done-p)
12606 (when org-blocker-hook
12607 (setq org-last-todo-state-is-todo
12608 (not (member this org-done-keywords)))
12609 (unless (save-excursion
12610 (save-match-data
12611 (org-with-wide-buffer
12612 (run-hook-with-args-until-failure
12613 'org-blocker-hook change-plist))))
12614 (if (org-called-interactively-p 'interactive)
12615 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12616 this org-state org-block-entry-blocking)
12617 ;; fail silently
12618 (message "TODO state change from %s to %s blocked (by \"%s\")"
12619 this org-state org-block-entry-blocking)
12620 (throw 'exit nil))))
12621 (store-match-data match-data)
12622 (replace-match next t t)
12623 (cond ((equal this org-state)
12624 (message "TODO state was already %s" (org-trim next)))
12625 ((pos-visible-in-window-p hl-pos)
12626 (message "TODO state changed to %s" (org-trim next))))
12627 (unless head
12628 (setq head (org-get-todo-sequence-head org-state)
12629 ass (assoc head org-todo-kwd-alist)
12630 interpret (nth 1 ass)
12631 done-word (nth 3 ass)
12632 final-done-word (nth 4 ass)))
12633 (when (memq arg '(nextset previousset))
12634 (message "Keyword-Set %d/%d: %s"
12635 (- (length org-todo-sets) -1
12636 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12637 (length org-todo-sets)
12638 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12639 (setq org-last-todo-state-is-todo
12640 (not (member org-state org-done-keywords)))
12641 (setq now-done-p (and (member org-state org-done-keywords)
12642 (not (member this org-done-keywords))))
12643 (and logging (org-local-logging logging))
12644 (when (and (or org-todo-log-states org-log-done)
12645 (not (eq org-inhibit-logging t))
12646 (not (memq arg '(nextset previousset))))
12647 ;; we need to look at recording a time and note
12648 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12649 (nth 2 (assoc this org-todo-log-states))))
12650 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12651 (setq dolog 'time))
12652 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12653 (and org-state
12654 (member org-state org-not-done-keywords)
12655 (not (member this org-not-done-keywords))))
12656 ;; This is now a todo state and was not one before
12657 ;; If there was a CLOSED time stamp, get rid of it.
12658 (org-add-planning-info nil nil 'closed))
12659 (when (and now-done-p org-log-done)
12660 ;; It is now done, and it was not done before
12661 (org-add-planning-info 'closed (org-current-effective-time))
12662 (if (and (not dolog) (eq 'note org-log-done))
12663 (org-add-log-setup 'done org-state this 'findpos 'note)))
12664 (when (and org-state dolog)
12665 ;; This is a non-nil state, and we need to log it
12666 (org-add-log-setup 'state org-state this 'findpos dolog)))
12667 ;; Fixup tag positioning
12668 (org-todo-trigger-tag-changes org-state)
12669 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12670 (when org-provide-todo-statistics
12671 (org-update-parent-todo-statistics))
12672 (run-hooks 'org-after-todo-state-change-hook)
12673 (if (and arg (not (member org-state org-done-keywords)))
12674 (setq head (org-get-todo-sequence-head org-state)))
12675 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12676 ;; Do we need to trigger a repeat?
12677 (when now-done-p
12678 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12679 ;; This is for the agenda, take a snapshot of the headline.
12680 (save-match-data
12681 (setq org-agenda-headline-snapshot-before-repeat
12682 (org-get-heading))))
12683 (org-auto-repeat-maybe org-state))
12684 ;; Fixup cursor location if close to the keyword
12685 (if (and (outline-on-heading-p)
12686 (not (bolp))
12687 (save-excursion (beginning-of-line 1)
12688 (looking-at org-todo-line-regexp))
12689 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12690 (progn
12691 (goto-char (or (match-end 2) (match-end 1)))
12692 (and (looking-at " ") (just-one-space))))
12693 (when org-trigger-hook
12694 (save-excursion
12695 (run-hook-with-args 'org-trigger-hook change-plist)))
12696 (when commentp (org-toggle-comment))))))))
12698 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12699 "Block turning an entry into a TODO, using the hierarchy.
12700 This checks whether the current task should be blocked from state
12701 changes. Such blocking occurs when:
12703 1. The task has children which are not all in a completed state.
12705 2. A task has a parent with the property :ORDERED:, and there
12706 are siblings prior to the current task with incomplete
12707 status.
12709 3. The parent of the task is blocked because it has siblings that should
12710 be done first, or is child of a block grandparent TODO entry."
12712 (if (not org-enforce-todo-dependencies)
12713 t ; if locally turned off don't block
12714 (catch 'dont-block
12715 ;; If this is not a todo state change, or if this entry is already DONE,
12716 ;; do not block
12717 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12718 (member (plist-get change-plist :from)
12719 (cons 'done org-done-keywords))
12720 (member (plist-get change-plist :to)
12721 (cons 'todo org-not-done-keywords))
12722 (not (plist-get change-plist :to)))
12723 (throw 'dont-block t))
12724 ;; If this task has children, and any are undone, it's blocked
12725 (save-excursion
12726 (org-back-to-heading t)
12727 (let ((this-level (funcall outline-level)))
12728 (outline-next-heading)
12729 (let ((child-level (funcall outline-level)))
12730 (while (and (not (eobp))
12731 (> child-level this-level))
12732 ;; this todo has children, check whether they are all
12733 ;; completed
12734 (if (and (not (org-entry-is-done-p))
12735 (org-entry-is-todo-p))
12736 (progn (setq org-block-entry-blocking (org-get-heading))
12737 (throw 'dont-block nil)))
12738 (outline-next-heading)
12739 (setq child-level (funcall outline-level))))))
12740 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12741 ;; any previous siblings are undone, it's blocked
12742 (save-excursion
12743 (org-back-to-heading t)
12744 (let* ((pos (point))
12745 (parent-pos (and (org-up-heading-safe) (point))))
12746 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12747 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12748 (forward-line 1)
12749 (re-search-forward org-not-done-heading-regexp pos t))
12750 (setq org-block-entry-blocking (match-string 0))
12751 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12752 ;; Search further up the hierarchy, to see if an ancestor is blocked
12753 (while t
12754 (goto-char parent-pos)
12755 (if (not (looking-at org-not-done-heading-regexp))
12756 (throw 'dont-block t)) ; do not block, parent is not a TODO
12757 (setq pos (point))
12758 (setq parent-pos (and (org-up-heading-safe) (point)))
12759 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12760 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12761 (forward-line 1)
12762 (re-search-forward org-not-done-heading-regexp pos t)
12763 (setq org-block-entry-blocking (org-get-heading)))
12764 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12766 (defcustom org-track-ordered-property-with-tag nil
12767 "Should the ORDERED property also be shown as a tag?
12768 The ORDERED property decides if an entry should require subtasks to be
12769 completed in sequence. Since a property is not very visible, setting
12770 this option means that toggling the ORDERED property with the command
12771 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12772 not relevant for the behavior, but it makes things more visible.
12774 Note that toggling the tag with tags commands will not change the property
12775 and therefore not influence behavior!
12777 This can be t, meaning the tag ORDERED should be used, It can also be a
12778 string to select a different tag for this task."
12779 :group 'org-todo
12780 :type '(choice
12781 (const :tag "No tracking" nil)
12782 (const :tag "Track with ORDERED tag" t)
12783 (string :tag "Use other tag")))
12785 (defun org-toggle-ordered-property ()
12786 "Toggle the ORDERED property of the current entry.
12787 For better visibility, you can track the value of this property with a tag.
12788 See variable `org-track-ordered-property-with-tag'."
12789 (interactive)
12790 (let* ((t1 org-track-ordered-property-with-tag)
12791 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12792 (save-excursion
12793 (org-back-to-heading)
12794 (if (org-entry-get nil "ORDERED")
12795 (progn
12796 (org-delete-property "ORDERED")
12797 (and tag (org-toggle-tag tag 'off))
12798 (message "Subtasks can be completed in arbitrary order"))
12799 (org-entry-put nil "ORDERED" "t")
12800 (and tag (org-toggle-tag tag 'on))
12801 (message "Subtasks must be completed in sequence")))))
12803 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12804 (defun org-block-todo-from-checkboxes (change-plist)
12805 "Block turning an entry into a TODO, using checkboxes.
12806 This checks whether the current task should be blocked from state
12807 changes because there are unchecked boxes in this entry."
12808 (if (not org-enforce-todo-checkbox-dependencies)
12809 t ; if locally turned off don't block
12810 (catch 'dont-block
12811 ;; If this is not a todo state change, or if this entry is already DONE,
12812 ;; do not block
12813 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12814 (member (plist-get change-plist :from)
12815 (cons 'done org-done-keywords))
12816 (member (plist-get change-plist :to)
12817 (cons 'todo org-not-done-keywords))
12818 (not (plist-get change-plist :to)))
12819 (throw 'dont-block t))
12820 ;; If this task has checkboxes that are not checked, it's blocked
12821 (save-excursion
12822 (org-back-to-heading t)
12823 (let ((beg (point)) end)
12824 (outline-next-heading)
12825 (setq end (point))
12826 (goto-char beg)
12827 (if (org-list-search-forward
12828 (concat (org-item-beginning-re)
12829 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12830 "\\[[- ]\\]")
12831 end t)
12832 (progn
12833 (if (boundp 'org-blocked-by-checkboxes)
12834 (setq org-blocked-by-checkboxes t))
12835 (throw 'dont-block nil)))))
12836 t))) ; do not block
12838 (defun org-entry-blocked-p ()
12839 "Is the current entry blocked?"
12840 (org-with-silent-modifications
12841 (if (org-entry-get nil "NOBLOCKING")
12842 nil ;; Never block this entry
12843 (not (run-hook-with-args-until-failure
12844 'org-blocker-hook
12845 (list :type 'todo-state-change
12846 :position (point)
12847 :from 'todo
12848 :to 'done))))))
12850 (defun org-update-statistics-cookies (all)
12851 "Update the statistics cookie, either from TODO or from checkboxes.
12852 This should be called with the cursor in a line with a statistics cookie."
12853 (interactive "P")
12854 (if all
12855 (progn
12856 (org-update-checkbox-count 'all)
12857 (org-map-entries 'org-update-parent-todo-statistics))
12858 (if (not (org-at-heading-p))
12859 (org-update-checkbox-count)
12860 (let ((pos (point-marker))
12861 end l1 l2)
12862 (ignore-errors (org-back-to-heading t))
12863 (if (not (org-at-heading-p))
12864 (org-update-checkbox-count)
12865 (setq l1 (org-outline-level))
12866 (setq end (save-excursion
12867 (outline-next-heading)
12868 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12869 (point)))
12870 (if (and (save-excursion
12871 (re-search-forward
12872 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12873 (not (save-excursion (re-search-forward
12874 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12875 (org-update-checkbox-count)
12876 (if (and l2 (> l2 l1))
12877 (progn
12878 (goto-char end)
12879 (org-update-parent-todo-statistics))
12880 (goto-char pos)
12881 (beginning-of-line 1)
12882 (while (re-search-forward
12883 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12884 (point-at-eol) t)
12885 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12886 (goto-char pos)
12887 (move-marker pos nil)))))
12889 (defvar org-entry-property-inherited-from) ;; defined below
12890 (defun org-update-parent-todo-statistics ()
12891 "Update any statistics cookie in the parent of the current headline.
12892 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12893 the entire subtree and this will travel up the hierarchy and update
12894 statistics everywhere."
12895 (let* ((prop (save-excursion (org-up-heading-safe)
12896 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12897 (recursive (or (not org-hierarchical-todo-statistics)
12898 (and prop (string-match "\\<recursive\\>" prop))))
12899 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12901 (first t)
12902 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12903 level ltoggle l1 new ndel
12904 (cnt-all 0) (cnt-done 0) is-percent kwd
12905 checkbox-beg ov ovs ove cookie-present)
12906 (catch 'exit
12907 (save-excursion
12908 (beginning-of-line 1)
12909 (setq ltoggle (funcall outline-level))
12910 ;; Three situations are to consider:
12912 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12913 ;; to the top-level ancestor on the headline;
12915 ;; 2. If parent has "recursive" property, repeat up to the
12916 ;; headline setting that property, taking inheritance into
12917 ;; account;
12919 ;; 3. Else, move up to direct parent and proceed only once.
12920 (while (and (setq level (org-up-heading-safe))
12921 (or recursive first)
12922 (>= (point) lim))
12923 (setq first nil cookie-present nil)
12924 (unless (and level
12925 (not (string-match
12926 "\\<checkbox\\>"
12927 (downcase (or (org-entry-get nil "COOKIE_DATA")
12928 "")))))
12929 (throw 'exit nil))
12930 (while (re-search-forward box-re (point-at-eol) t)
12931 (setq cnt-all 0 cnt-done 0 cookie-present t)
12932 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12933 (save-match-data
12934 (unless (outline-next-heading) (throw 'exit nil))
12935 (while (and (looking-at org-complex-heading-regexp)
12936 (> (setq l1 (length (match-string 1))) level))
12937 (setq kwd (and (or recursive (= l1 ltoggle))
12938 (match-string 2)))
12939 (if (or (eq org-provide-todo-statistics 'all-headlines)
12940 (and (eq org-provide-todo-statistics t)
12941 (or (member kwd org-done-keywords)))
12942 (and (listp org-provide-todo-statistics)
12943 (stringp (car org-provide-todo-statistics))
12944 (or (member kwd org-provide-todo-statistics)
12945 (member kwd org-done-keywords)))
12946 (and (listp org-provide-todo-statistics)
12947 (listp (car org-provide-todo-statistics))
12948 (or (member kwd (car org-provide-todo-statistics))
12949 (and (member kwd org-done-keywords)
12950 (member kwd (cadr org-provide-todo-statistics))))))
12951 (setq cnt-all (1+ cnt-all))
12952 (if (eq org-provide-todo-statistics t)
12953 (and kwd (setq cnt-all (1+ cnt-all)))))
12954 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12955 (member kwd org-done-keywords))
12956 (and (listp org-provide-todo-statistics)
12957 (listp (car org-provide-todo-statistics))
12958 (member kwd org-done-keywords)
12959 (member kwd (cadr org-provide-todo-statistics)))
12960 (and (listp org-provide-todo-statistics)
12961 (stringp (car org-provide-todo-statistics))
12962 (member kwd org-done-keywords)))
12963 (setq cnt-done (1+ cnt-done)))
12964 (outline-next-heading)))
12965 (setq new
12966 (if is-percent
12967 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12968 (format "[%d/%d]" cnt-done cnt-all))
12969 ndel (- (match-end 0) checkbox-beg))
12970 ;; handle overlays when updating cookie from column view
12971 (when (setq ov (car (overlays-at checkbox-beg)))
12972 (setq ovs (overlay-start ov) ove (overlay-end ov))
12973 (delete-overlay ov))
12974 (goto-char checkbox-beg)
12975 (insert new)
12976 (delete-region (point) (+ (point) ndel))
12977 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12978 (when ov (move-overlay ov ovs ove)))
12979 (when cookie-present
12980 (run-hook-with-args 'org-after-todo-statistics-hook
12981 cnt-done (- cnt-all cnt-done))))))
12982 (run-hooks 'org-todo-statistics-hook)))
12984 (defvar org-after-todo-statistics-hook nil
12985 "Hook that is called after a TODO statistics cookie has been updated.
12986 Each function is called with two arguments: the number of not-done entries
12987 and the number of done entries.
12989 For example, the following function, when added to this hook, will switch
12990 an entry to DONE when all children are done, and back to TODO when new
12991 entries are set to a TODO status. Note that this hook is only called
12992 when there is a statistics cookie in the headline!
12994 (defun org-summary-todo (n-done n-not-done)
12995 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12996 (let (org-log-done org-log-states) ; turn off logging
12997 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13000 (defvar org-todo-statistics-hook nil
13001 "Hook that is run whenever Org thinks TODO statistics should be updated.
13002 This hook runs even if there is no statistics cookie present, in which case
13003 `org-after-todo-statistics-hook' would not run.")
13005 (defun org-todo-trigger-tag-changes (state)
13006 "Apply the changes defined in `org-todo-state-tags-triggers'."
13007 (let ((l org-todo-state-tags-triggers)
13008 changes)
13009 (when (or (not state) (equal state ""))
13010 (setq changes (append changes (cdr (assoc "" l)))))
13011 (when (and (stringp state) (> (length state) 0))
13012 (setq changes (append changes (cdr (assoc state l)))))
13013 (when (member state org-not-done-keywords)
13014 (setq changes (append changes (cdr (assoc 'todo l)))))
13015 (when (member state org-done-keywords)
13016 (setq changes (append changes (cdr (assoc 'done l)))))
13017 (dolist (c changes)
13018 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13020 (defun org-local-logging (value)
13021 "Get logging settings from a property VALUE."
13022 (let* (words w a)
13023 ;; directly set the variables, they are already local.
13024 (setq org-log-done nil
13025 org-log-repeat nil
13026 org-todo-log-states nil)
13027 (setq words (org-split-string value))
13028 (while (setq w (pop words))
13029 (cond
13030 ((setq a (assoc w org-startup-options))
13031 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13032 (set (nth 1 a) (nth 2 a))))
13033 ((setq a (org-extract-log-state-settings w))
13034 (and (member (car a) org-todo-keywords-1)
13035 (push a org-todo-log-states)))))))
13037 (defun org-get-todo-sequence-head (kwd)
13038 "Return the head of the TODO sequence to which KWD belongs.
13039 If KWD is not set, check if there is a text property remembering the
13040 right sequence."
13041 (let (p)
13042 (cond
13043 ((not kwd)
13044 (or (get-text-property (point-at-bol) 'org-todo-head)
13045 (progn
13046 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13047 nil (point-at-eol)))
13048 (get-text-property p 'org-todo-head))))
13049 ((not (member kwd org-todo-keywords-1))
13050 (car org-todo-keywords-1))
13051 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13053 (defun org-fast-todo-selection ()
13054 "Fast TODO keyword selection with single keys.
13055 Returns the new TODO keyword, or nil if no state change should occur."
13056 (let* ((fulltable org-todo-key-alist)
13057 (done-keywords org-done-keywords) ;; needed for the faces.
13058 (maxlen (apply 'max (mapcar
13059 (lambda (x)
13060 (if (stringp (car x)) (string-width (car x)) 0))
13061 fulltable)))
13062 (expert nil)
13063 (fwidth (+ maxlen 3 1 3))
13064 (ncol (/ (- (window-width) 4) fwidth))
13065 tg cnt e c tbl
13066 groups ingroup)
13067 (save-excursion
13068 (save-window-excursion
13069 (if expert
13070 (set-buffer (get-buffer-create " *Org todo*"))
13071 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13072 (erase-buffer)
13073 (org-set-local 'org-done-keywords done-keywords)
13074 (setq tbl fulltable cnt 0)
13075 (while (setq e (pop tbl))
13076 (cond
13077 ((equal e '(:startgroup))
13078 (push '() groups) (setq ingroup t)
13079 (when (not (= cnt 0))
13080 (setq cnt 0)
13081 (insert "\n"))
13082 (insert "{ "))
13083 ((equal e '(:endgroup))
13084 (setq ingroup nil cnt 0)
13085 (insert "}\n"))
13086 ((equal e '(:newline))
13087 (when (not (= cnt 0))
13088 (setq cnt 0)
13089 (insert "\n")
13090 (setq e (car tbl))
13091 (while (equal (car tbl) '(:newline))
13092 (insert "\n")
13093 (setq tbl (cdr tbl)))))
13095 (setq tg (car e) c (cdr e))
13096 (if ingroup (push tg (car groups)))
13097 (setq tg (org-add-props tg nil 'face
13098 (org-get-todo-face tg)))
13099 (if (and (= cnt 0) (not ingroup)) (insert " "))
13100 (insert "[" c "] " tg (make-string
13101 (- fwidth 4 (length tg)) ?\ ))
13102 (when (= (setq cnt (1+ cnt)) ncol)
13103 (insert "\n")
13104 (if ingroup (insert " "))
13105 (setq cnt 0)))))
13106 (insert "\n")
13107 (goto-char (point-min))
13108 (if (not expert) (org-fit-window-to-buffer))
13109 (message "[a-z..]:Set [SPC]:clear")
13110 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13111 (cond
13112 ((or (= c ?\C-g)
13113 (and (= c ?q) (not (rassoc c fulltable))))
13114 (setq quit-flag t))
13115 ((= c ?\ ) nil)
13116 ((setq e (rassoc c fulltable) tg (car e))
13118 (t (setq quit-flag t)))))))
13120 (defun org-entry-is-todo-p ()
13121 (member (org-get-todo-state) org-not-done-keywords))
13123 (defun org-entry-is-done-p ()
13124 (member (org-get-todo-state) org-done-keywords))
13126 (defun org-get-todo-state ()
13127 "Return the TODO keyword of the current subtree."
13128 (save-excursion
13129 (org-back-to-heading t)
13130 (and (looking-at org-todo-line-regexp)
13131 (match-end 2)
13132 (match-string 2))))
13134 (defun org-at-date-range-p (&optional inactive-ok)
13135 "Is the cursor inside a date range?"
13136 (interactive)
13137 (save-excursion
13138 (catch 'exit
13139 (let ((pos (point)))
13140 (skip-chars-backward "^[<\r\n")
13141 (skip-chars-backward "<[")
13142 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13143 (>= (match-end 0) pos)
13144 (throw 'exit t))
13145 (skip-chars-backward "^<[\r\n")
13146 (skip-chars-backward "<[")
13147 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13148 (>= (match-end 0) pos)
13149 (throw 'exit t)))
13150 nil)))
13152 (defun org-get-repeat (&optional tagline)
13153 "Check if there is a deadline/schedule with repeater in this entry."
13154 (save-match-data
13155 (save-excursion
13156 (org-back-to-heading t)
13157 (and (re-search-forward (if tagline
13158 (concat tagline "\\s-*" org-repeat-re)
13159 org-repeat-re)
13160 (org-entry-end-position) t)
13161 (match-string-no-properties 1)))))
13163 (defvar org-last-changed-timestamp)
13164 (defvar org-last-inserted-timestamp)
13165 (defvar org-log-post-message)
13166 (defvar org-log-note-purpose)
13167 (defvar org-log-note-how nil)
13168 (defvar org-log-note-extra)
13169 (defun org-auto-repeat-maybe (done-word)
13170 "Check if the current headline contains a repeated deadline/schedule.
13171 If yes, set TODO state back to what it was and change the base date
13172 of repeating deadline/scheduled time stamps to new date.
13173 This function is run automatically after each state change to a DONE state."
13174 ;; last-state is dynamically scoped into this function
13175 (let* ((repeat (org-get-repeat))
13176 (aa (assoc org-last-state org-todo-kwd-alist))
13177 (interpret (nth 1 aa))
13178 (head (nth 2 aa))
13179 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13180 (msg "Entry repeats: ")
13181 (org-log-done nil)
13182 (org-todo-log-states nil)
13183 re type n what ts time to-state)
13184 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13185 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13186 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13187 org-todo-repeat-to-state))
13188 (unless (and to-state (member to-state org-todo-keywords-1))
13189 (setq to-state (if (eq interpret 'type) org-last-state head)))
13190 (org-todo to-state)
13191 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13192 (org-entry-put nil "LAST_REPEAT" (format-time-string
13193 (org-time-stamp-format t t))))
13194 (when org-log-repeat
13195 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13196 (memq 'org-add-log-note post-command-hook))
13197 ;; OK, we are already setup for some record
13198 (if (eq org-log-repeat 'note)
13199 ;; make sure we take a note, not only a time stamp
13200 (setq org-log-note-how 'note))
13201 ;; Set up for taking a record
13202 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13203 org-last-state
13204 'findpos org-log-repeat)))
13205 (org-back-to-heading t)
13206 (org-add-planning-info nil nil 'closed)
13207 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13208 org-deadline-time-regexp "\\)\\|\\("
13209 org-ts-regexp "\\)"))
13210 (while (re-search-forward
13211 re (save-excursion (outline-next-heading) (point)) t)
13212 (setq type (if (match-end 1) org-scheduled-string
13213 (if (match-end 3) org-deadline-string "Plain:"))
13214 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13215 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13216 (setq n (string-to-number (match-string 2 ts))
13217 what (match-string 3 ts))
13218 (if (equal what "w") (setq n (* n 7) what "d"))
13219 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13220 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13221 ;; Preparation, see if we need to modify the start date for the change
13222 (when (match-end 1)
13223 (setq time (save-match-data (org-time-string-to-time ts)))
13224 (cond
13225 ((equal (match-string 1 ts) ".")
13226 ;; Shift starting date to today
13227 (org-timestamp-change
13228 (- (org-today) (time-to-days time))
13229 'day))
13230 ((equal (match-string 1 ts) "+")
13231 (let ((nshiftmax 10) (nshift 0))
13232 (while (or (= nshift 0)
13233 (<= (time-to-days time)
13234 (time-to-days (current-time))))
13235 (when (= (incf nshift) nshiftmax)
13236 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13237 (user-error "Abort")))
13238 (org-timestamp-change n (cdr (assoc what whata)))
13239 (org-at-timestamp-p t)
13240 (setq ts (match-string 1))
13241 (setq time (save-match-data (org-time-string-to-time ts)))))
13242 (org-timestamp-change (- n) (cdr (assoc what whata)))
13243 ;; rematch, so that we have everything in place for the real shift
13244 (org-at-timestamp-p t)
13245 (setq ts (match-string 1))
13246 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13247 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13248 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13249 (setq org-log-post-message msg)
13250 (message "%s" msg))))
13252 (defun org-show-todo-tree (arg)
13253 "Make a compact tree which shows all headlines marked with TODO.
13254 The tree will show the lines where the regexp matches, and all higher
13255 headlines above the match.
13256 With a \\[universal-argument] prefix, prompt for a regexp to match.
13257 With a numeric prefix N, construct a sparse tree for the Nth element
13258 of `org-todo-keywords-1'."
13259 (interactive "P")
13260 (let ((case-fold-search nil)
13261 (kwd-re
13262 (cond ((null arg) org-not-done-regexp)
13263 ((equal arg '(4))
13264 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13265 (mapcar 'list org-todo-keywords-1))))
13266 (concat "\\("
13267 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13268 "\\)\\>")))
13269 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13270 (regexp-quote (nth (1- (prefix-numeric-value arg))
13271 org-todo-keywords-1)))
13272 (t (user-error "Invalid prefix argument: %s" arg)))))
13273 (message "%d TODO entries found"
13274 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13276 (defun org-deadline (arg &optional time)
13277 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13278 With one universal prefix argument, remove any deadline from the item.
13279 With two universal prefix arguments, prompt for a warning delay.
13280 With argument TIME, set the deadline at the corresponding date. TIME
13281 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13282 (interactive "P")
13283 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13284 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13285 'region-start-level 'region))
13286 org-loop-over-headlines-in-active-region)
13287 (org-map-entries
13288 `(org-deadline ',arg ,time)
13289 org-loop-over-headlines-in-active-region
13290 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13291 (let* ((old-date (org-entry-get nil "DEADLINE"))
13292 (old-date-time (if old-date (org-time-string-to-time old-date)))
13293 (repeater (and old-date
13294 (string-match
13295 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13296 old-date)
13297 (match-string 1 old-date))))
13298 (cond
13299 ((equal arg '(4))
13300 (when (and old-date org-log-redeadline)
13301 (org-add-log-setup 'deldeadline nil old-date 'findpos
13302 org-log-redeadline))
13303 (org-remove-timestamp-with-keyword org-deadline-string)
13304 (message "Item no longer has a deadline."))
13305 ((equal arg '(16))
13306 (save-excursion
13307 (org-back-to-heading t)
13308 (if (re-search-forward
13309 org-deadline-time-regexp
13310 (save-excursion (outline-next-heading) (point)) t)
13311 (let* ((rpl0 (match-string 1))
13312 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13313 (replace-match
13314 (concat org-deadline-string
13315 " <" rpl
13316 (format " -%dd"
13317 (abs
13318 (- (time-to-days
13319 (save-match-data
13320 (org-read-date nil t nil "Warn starting from" old-date-time)))
13321 (time-to-days old-date-time))))
13322 ">") t t))
13323 (user-error "No deadline information to update"))))
13325 (org-add-planning-info 'deadline time 'closed)
13326 (when (and old-date org-log-redeadline
13327 (not (equal old-date
13328 (substring org-last-inserted-timestamp 1 -1))))
13329 (org-add-log-setup 'redeadline nil old-date 'findpos
13330 org-log-redeadline))
13331 (when repeater
13332 (save-excursion
13333 (org-back-to-heading t)
13334 (when (re-search-forward (concat org-deadline-string " "
13335 org-last-inserted-timestamp)
13336 (save-excursion
13337 (outline-next-heading) (point)) t)
13338 (goto-char (1- (match-end 0)))
13339 (insert " " repeater)
13340 (setq org-last-inserted-timestamp
13341 (concat (substring org-last-inserted-timestamp 0 -1)
13342 " " repeater
13343 (substring org-last-inserted-timestamp -1))))))
13344 (message "Deadline on %s" org-last-inserted-timestamp))))))
13346 (defun org-schedule (arg &optional time)
13347 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13348 With one universal prefix argument, remove any scheduling date from the item.
13349 With two universal prefix arguments, prompt for a delay cookie.
13350 With argument TIME, scheduled at the corresponding date. TIME can
13351 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13352 (interactive "P")
13353 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13354 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13355 'region-start-level 'region))
13356 org-loop-over-headlines-in-active-region)
13357 (org-map-entries
13358 `(org-schedule ',arg ,time)
13359 org-loop-over-headlines-in-active-region
13360 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13361 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13362 (old-date-time (if old-date (org-time-string-to-time old-date)))
13363 (repeater (and old-date
13364 (string-match
13365 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13366 old-date)
13367 (match-string 1 old-date))))
13368 (cond
13369 ((equal arg '(4))
13370 (progn
13371 (when (and old-date org-log-reschedule)
13372 (org-add-log-setup 'delschedule nil old-date 'findpos
13373 org-log-reschedule))
13374 (org-remove-timestamp-with-keyword org-scheduled-string)
13375 (message "Item is no longer scheduled.")))
13376 ((equal arg '(16))
13377 (save-excursion
13378 (org-back-to-heading t)
13379 (if (re-search-forward
13380 org-scheduled-time-regexp
13381 (save-excursion (outline-next-heading) (point)) t)
13382 (let* ((rpl0 (match-string 1))
13383 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13384 (replace-match
13385 (concat org-scheduled-string
13386 " <" rpl
13387 (format " -%dd"
13388 (abs
13389 (- (time-to-days
13390 (save-match-data
13391 (org-read-date nil t nil "Delay until" old-date-time)))
13392 (time-to-days old-date-time))))
13393 ">") t t))
13394 (user-error "No scheduled information to update"))))
13396 (org-add-planning-info 'scheduled time 'closed)
13397 (when (and old-date org-log-reschedule
13398 (not (equal old-date
13399 (substring org-last-inserted-timestamp 1 -1))))
13400 (org-add-log-setup 'reschedule nil old-date 'findpos
13401 org-log-reschedule))
13402 (when repeater
13403 (save-excursion
13404 (org-back-to-heading t)
13405 (when (re-search-forward (concat org-scheduled-string " "
13406 org-last-inserted-timestamp)
13407 (save-excursion
13408 (outline-next-heading) (point)) t)
13409 (goto-char (1- (match-end 0)))
13410 (insert " " repeater)
13411 (setq org-last-inserted-timestamp
13412 (concat (substring org-last-inserted-timestamp 0 -1)
13413 " " repeater
13414 (substring org-last-inserted-timestamp -1))))))
13415 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13417 (defun org-get-scheduled-time (pom &optional inherit)
13418 "Get the scheduled time as a time tuple, of a format suitable
13419 for calling org-schedule with, or if there is no scheduling,
13420 returns nil."
13421 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13422 (when time
13423 (apply 'encode-time (org-parse-time-string time)))))
13425 (defun org-get-deadline-time (pom &optional inherit)
13426 "Get the deadline as a time tuple, of a format suitable for
13427 calling org-deadline with, or if there is no scheduling, returns
13428 nil."
13429 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13430 (when time
13431 (apply 'encode-time (org-parse-time-string time)))))
13433 (defun org-remove-timestamp-with-keyword (keyword)
13434 "Remove all time stamps with KEYWORD in the current entry."
13435 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13436 beg)
13437 (save-excursion
13438 (org-back-to-heading t)
13439 (setq beg (point))
13440 (outline-next-heading)
13441 (while (re-search-backward re beg t)
13442 (replace-match "")
13443 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13444 (equal (char-before) ?\ ))
13445 (backward-delete-char 1)
13446 (if (string-match "^[ \t]*$" (buffer-substring
13447 (point-at-bol) (point-at-eol)))
13448 (delete-region (point-at-bol)
13449 (min (point-max) (1+ (point-at-eol))))))))))
13451 (defvar org-time-was-given) ; dynamically scoped parameter
13452 (defvar org-end-time-was-given) ; dynamically scoped parameter
13454 (defun org-at-planning-p ()
13455 "Non-nil when point is on a planning info line."
13456 ;; This is as accurate and faster than `org-element-at-point' since
13457 ;; planning info location is fixed in the section.
13458 (org-with-wide-buffer
13459 (beginning-of-line)
13460 (and (org-looking-at-p org-planning-line-re)
13461 (eq (point)
13462 (ignore-errors
13463 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13464 (org-back-to-heading t)
13465 (org-with-limited-levels (org-back-to-heading t)))
13466 (line-beginning-position 2))))))
13468 (defun org-add-planning-info (what &optional time &rest remove)
13469 "Insert new timestamp with keyword in the planning line.
13470 WHAT indicates what kind of time stamp to add. It is a symbol
13471 among `closed', `deadline', `scheduled' and nil. TIME indicates
13472 the time to use. If none is given, the user is prompted for
13473 a date. REMOVE indicates what kind of entries to remove. An old
13474 WHAT entry will also be removed."
13475 (let (org-time-was-given org-end-time-was-given default-time default-input)
13476 (catch 'exit
13477 (when (and (memq what '(scheduled deadline))
13478 (or (not time)
13479 (and (stringp time)
13480 (string-match "^[-+]+[0-9]" time))))
13481 ;; Try to get a default date/time from existing timestamp
13482 (save-excursion
13483 (org-back-to-heading t)
13484 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13485 (when (re-search-forward (if (eq what 'scheduled)
13486 org-scheduled-time-regexp
13487 org-deadline-time-regexp)
13488 end t)
13489 (setq ts (match-string 1)
13490 default-time (apply 'encode-time (org-parse-time-string ts))
13491 default-input (and ts (org-get-compact-tod ts)))))))
13492 (when what
13493 (setq time
13494 (if (stringp time)
13495 ;; This is a string (relative or absolute), set
13496 ;; proper date.
13497 (apply #'encode-time
13498 (org-read-date-analyze
13499 time default-time (decode-time default-time)))
13500 ;; If necessary, get the time from the user
13501 (or time (org-read-date nil 'to-time nil nil
13502 default-time default-input)))))
13504 (org-with-wide-buffer
13505 (org-back-to-heading t)
13506 (forward-line)
13507 (unless (bolp) (insert "\n"))
13508 (cond ((org-looking-at-p org-planning-line-re)
13509 ;; Move to current indentation.
13510 (skip-chars-forward " \t")
13511 ;; Check if we have to remove something.
13512 (dolist (type (if what (cons what remove) remove))
13513 (when (save-excursion
13514 (re-search-forward
13515 (case type
13516 (closed org-closed-time-regexp)
13517 (deadline org-deadline-time-regexp)
13518 (scheduled org-scheduled-time-regexp)
13519 (otherwise (error "Invalid planning type: %s" type)))
13520 (line-end-position) t))
13521 (replace-match "")
13522 (when (looking-at "--+<[^>]+>") (replace-match ""))
13523 (when (and (not what) (eq type 'closed))
13524 (save-excursion
13525 (beginning-of-line)
13526 (if (looking-at "[ \t]*$")
13527 (delete-region (point) (1+ (point-at-eol)))))))
13528 ;; Remove leading white spaces.
13529 (when (and (not (bolp)) (looking-at "[ \t]+")) (replace-match ""))))
13530 ((not what) (throw 'exit nil)) ; Nothing to do.
13531 (t (insert-before-markers "\n")
13532 (backward-char 1)
13533 (when org-adapt-indentation
13534 (org-indent-to-column (1+ (org-outline-level))))))
13535 (when what
13536 ;; Insert planning keyword.
13537 (insert (case what
13538 (closed org-closed-string)
13539 (deadline org-deadline-string)
13540 (scheduled org-scheduled-string)
13541 (otherwise (error "Invalid planning type: %s" what)))
13542 " ")
13543 ;; Insert associated timestamp.
13544 (let ((ts (org-insert-time-stamp
13545 time
13546 (or org-time-was-given
13547 (and (eq what 'closed) org-log-done-with-time))
13548 (eq what 'closed)
13549 nil nil (list org-end-time-was-given))))
13550 (unless (eolp) (insert " "))
13551 ts))))))
13553 (defvar org-log-note-marker (make-marker))
13554 (defvar org-log-note-purpose nil)
13555 (defvar org-log-note-state nil)
13556 (defvar org-log-note-previous-state nil)
13557 (defvar org-log-note-extra nil)
13558 (defvar org-log-note-window-configuration nil)
13559 (defvar org-log-note-return-to (make-marker))
13560 (defvar org-log-note-effective-time nil
13561 "Remembered current time so that dynamically scoped
13562 `org-extend-today-until' affects tha timestamps in state change
13563 log")
13565 (defvar org-log-post-message nil
13566 "Message to be displayed after a log note has been stored.
13567 The auto-repeater uses this.")
13569 (defun org-add-note ()
13570 "Add a note to the current entry.
13571 This is done in the same way as adding a state change note."
13572 (interactive)
13573 (org-add-log-setup 'note nil nil 'findpos nil))
13575 (defun org-log-beginning (&optional create)
13576 "Return expected start of log notes in current entry.
13577 When optional argument CREATE is non-nil, the function creates
13578 a drawer to store notes, if necessary. Returned position ignores
13579 narrowing."
13580 (org-with-wide-buffer
13581 (org-end-of-meta-data)
13582 (let ((end (if (org-at-heading-p) (point)
13583 (save-excursion (outline-next-heading) (point))))
13584 (drawer (org-log-into-drawer)))
13585 (cond
13586 (drawer
13587 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13588 (case-fold-search t))
13589 (catch 'exit
13590 ;; Try to find existing drawer.
13591 (while (re-search-forward regexp end t)
13592 (let ((element (org-element-at-point)))
13593 (when (eq (org-element-type element) 'drawer)
13594 (let ((cend (org-element-property :contents-end element)))
13595 (when (and (not org-log-states-order-reversed) cend)
13596 (goto-char cend)))
13597 (throw 'exit nil))))
13598 ;; No drawer found. Create one, if permitted.
13599 (when create
13600 (unless (bolp) (insert "\n"))
13601 (let ((beg (point)))
13602 (insert ":" drawer ":\n:END:\n")
13603 (org-indent-region beg (point)))
13604 (end-of-line -1)))))
13605 (org-log-state-notes-insert-after-drawers
13606 (while (and (looking-at org-drawer-regexp)
13607 (progn (goto-char (match-end 0))
13608 (re-search-forward org-property-end-re end t)))
13609 (forward-line)))))
13610 (if (bolp) (point) (line-beginning-position 2))))
13612 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13613 "Set up the post command hook to take a note.
13614 If this is about to TODO state change, the new state is expected in STATE.
13615 When FINDPOS is non-nil, find the correct position for the note in
13616 the current entry. If not, assume that it can be inserted at point.
13617 HOW is an indicator what kind of note should be created.
13618 EXTRA is additional text that will be inserted into the notes buffer."
13619 (org-with-wide-buffer
13620 (when findpos
13621 (goto-char (org-log-beginning t))
13622 (unless org-log-states-order-reversed
13623 (org-skip-over-state-notes)
13624 (skip-chars-backward " \t\n\r")
13625 (forward-line)))
13626 (move-marker org-log-note-marker (point))
13627 ;; Preserve position even if a property drawer is inserted in the
13628 ;; process.
13629 (set-marker-insertion-type org-log-note-marker t)
13630 (setq org-log-note-purpose purpose
13631 org-log-note-state state
13632 org-log-note-previous-state prev-state
13633 org-log-note-how how
13634 org-log-note-extra extra
13635 org-log-note-effective-time (org-current-effective-time))
13636 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13638 (defun org-skip-over-state-notes ()
13639 "Skip past the list of State notes in an entry."
13640 (when (ignore-errors (goto-char (org-in-item-p)))
13641 (let* ((struct (org-list-struct))
13642 (prevs (org-list-prevs-alist struct))
13643 (regexp
13644 (concat "[ \t]*- +"
13645 (replace-regexp-in-string
13646 " +" " +"
13647 (org-replace-escapes
13648 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13649 `(("%d" . ,org-ts-regexp-inactive)
13650 ("%D" . ,org-ts-regexp)
13651 ("%s" . "\"\\S-+\"")
13652 ("%S" . "\"\\S-+\"")
13653 ("%t" . ,org-ts-regexp-inactive)
13654 ("%T" . ,org-ts-regexp)
13655 ("%u" . ".*?")
13656 ("%U" . ".*?")))))))
13657 (while (org-looking-at-p regexp)
13658 (goto-char (or (org-list-get-next-item (point) struct prevs)
13659 (org-list-get-item-end (point) struct)))))))
13661 (defun org-add-log-note (&optional purpose)
13662 "Pop up a window for taking a note, and add this note later at point."
13663 (remove-hook 'post-command-hook 'org-add-log-note)
13664 (setq org-log-note-window-configuration (current-window-configuration))
13665 (delete-other-windows)
13666 (move-marker org-log-note-return-to (point))
13667 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13668 (goto-char org-log-note-marker)
13669 (org-switch-to-buffer-other-window "*Org Note*")
13670 (erase-buffer)
13671 (if (memq org-log-note-how '(time state))
13672 (let (current-prefix-arg) (org-store-log-note))
13673 (let ((org-inhibit-startup t)) (org-mode))
13674 (insert (format "# Insert note for %s.
13675 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13676 (cond
13677 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13678 ((eq org-log-note-purpose 'done) "closed todo item")
13679 ((eq org-log-note-purpose 'state)
13680 (format "state change from \"%s\" to \"%s\""
13681 (or org-log-note-previous-state "")
13682 (or org-log-note-state "")))
13683 ((eq org-log-note-purpose 'reschedule)
13684 "rescheduling")
13685 ((eq org-log-note-purpose 'delschedule)
13686 "no longer scheduled")
13687 ((eq org-log-note-purpose 'redeadline)
13688 "changing deadline")
13689 ((eq org-log-note-purpose 'deldeadline)
13690 "removing deadline")
13691 ((eq org-log-note-purpose 'refile)
13692 "refiling")
13693 ((eq org-log-note-purpose 'note)
13694 "this entry")
13695 (t (error "This should not happen")))))
13696 (if org-log-note-extra (insert org-log-note-extra))
13697 (org-set-local 'org-finish-function 'org-store-log-note)
13698 (run-hooks 'org-log-buffer-setup-hook)))
13700 (defvar org-note-abort nil) ; dynamically scoped
13701 (defun org-store-log-note ()
13702 "Finish taking a log note, and insert it to where it belongs."
13703 (let ((txt (buffer-string)))
13704 (kill-buffer (current-buffer))
13705 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13706 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13707 (setq txt (replace-match "" t t txt)))
13708 (if (string-match "\\s-+\\'" txt)
13709 (setq txt (replace-match "" t t txt)))
13710 (setq lines (org-split-string txt "\n"))
13711 (when (and note (string-match "\\S-" note))
13712 (setq note
13713 (org-replace-escapes
13714 note
13715 (list (cons "%u" (user-login-name))
13716 (cons "%U" user-full-name)
13717 (cons "%t" (format-time-string
13718 (org-time-stamp-format 'long 'inactive)
13719 org-log-note-effective-time))
13720 (cons "%T" (format-time-string
13721 (org-time-stamp-format 'long nil)
13722 org-log-note-effective-time))
13723 (cons "%d" (format-time-string
13724 (org-time-stamp-format nil 'inactive)
13725 org-log-note-effective-time))
13726 (cons "%D" (format-time-string
13727 (org-time-stamp-format nil nil)
13728 org-log-note-effective-time))
13729 (cons "%s" (if org-log-note-state
13730 (concat "\"" org-log-note-state "\"")
13731 ""))
13732 (cons "%S" (if org-log-note-previous-state
13733 (concat "\"" org-log-note-previous-state "\"")
13734 "\"\"")))))
13735 (when lines (setq note (concat note " \\\\")))
13736 (push note lines))
13737 (when (or current-prefix-arg org-note-abort)
13738 (when (org-log-into-drawer)
13739 (org-remove-empty-drawer-at org-log-note-marker))
13740 (setq lines nil))
13741 (when lines
13742 (with-current-buffer (marker-buffer org-log-note-marker)
13743 (save-excursion
13744 (goto-char org-log-note-marker)
13745 (move-marker org-log-note-marker nil)
13746 ;; Make sure point is at the beginning of an empty line.
13747 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13748 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13749 ;; In an existing list, add a new item at the top level.
13750 ;; Otherwise, indent line like a regular one.
13751 (let ((itemp (org-in-item-p)))
13752 (if itemp
13753 (org-indent-line-to
13754 (let ((struct (save-excursion
13755 (goto-char itemp) (org-list-struct))))
13756 (org-list-get-ind (org-list-get-top-point struct) struct)))
13757 (org-indent-line)))
13758 (insert (org-list-bullet-string "-") (pop lines))
13759 (let ((ind (org-list-item-body-column (line-beginning-position))))
13760 (dolist (line lines)
13761 (insert "\n")
13762 (org-indent-line-to ind)
13763 (insert line)))
13764 (message "Note stored")
13765 (org-back-to-heading t)
13766 (org-cycle-hide-drawers 'children))
13767 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13768 ;; from within `org-add-log-note' because `buffer-undo-list'
13769 ;; is then modified outside of `org-with-remote-undo'.
13770 (when (eq this-command 'org-agenda-todo)
13771 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13772 ;; Don't add undo information when called from `org-agenda-todo'
13773 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13774 (set-window-configuration org-log-note-window-configuration)
13775 (with-current-buffer (marker-buffer org-log-note-return-to)
13776 (goto-char org-log-note-return-to))
13777 (move-marker org-log-note-return-to nil)
13778 (and org-log-post-message (message "%s" org-log-post-message))))
13780 (defun org-remove-empty-drawer-at (pos)
13781 "Remove an empty drawer at position POS.
13782 POS may also be a marker."
13783 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13784 (org-with-wide-buffer
13785 (goto-char pos)
13786 (let ((drawer (org-element-at-point)))
13787 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13788 (not (org-element-property :contents-begin drawer)))
13789 (delete-region (org-element-property :begin drawer)
13790 (progn (goto-char (org-element-property :end drawer))
13791 (skip-chars-backward " \r\t\n")
13792 (forward-line)
13793 (point))))))))
13795 (defvar org-ts-type nil)
13796 (defun org-sparse-tree (&optional arg type)
13797 "Create a sparse tree, prompt for the details.
13798 This command can create sparse trees. You first need to select the type
13799 of match used to create the tree:
13801 t Show all TODO entries.
13802 T Show entries with a specific TODO keyword.
13803 m Show entries selected by a tags/property match.
13804 p Enter a property name and its value (both with completion on existing
13805 names/values) and show entries with that property.
13806 r Show entries matching a regular expression (`/' can be used as well).
13807 b Show deadlines and scheduled items before a date.
13808 a Show deadlines and scheduled items after a date.
13809 d Show deadlines due within `org-deadline-warning-days'.
13810 D Show deadlines and scheduled items between a date range."
13811 (interactive "P")
13812 (setq type (or type org-sparse-tree-default-date-type))
13813 (setq org-ts-type type)
13814 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13815 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13816 [c]ycle through date types: %s"
13817 (case type
13818 (all "all timestamps")
13819 (scheduled "only scheduled")
13820 (deadline "only deadline")
13821 (active "only active timestamps")
13822 (inactive "only inactive timestamps")
13823 (closed "with a closed time-stamp")
13824 (otherwise "scheduled/deadline")))
13825 (let ((answer (read-char-exclusive)))
13826 (case answer
13828 (org-sparse-tree
13830 (cadr
13831 (memq type '(nil all scheduled deadline active inactive closed)))))
13832 (?d (call-interactively 'org-check-deadlines))
13833 (?b (call-interactively 'org-check-before-date))
13834 (?a (call-interactively 'org-check-after-date))
13835 (?D (call-interactively 'org-check-dates-range))
13836 (?t (call-interactively 'org-show-todo-tree))
13837 (?T (org-show-todo-tree '(4)))
13838 (?m (call-interactively 'org-match-sparse-tree))
13839 ((?p ?P)
13840 (let* ((kwd (org-icompleting-read
13841 "Property: " (mapcar 'list (org-buffer-property-keys))))
13842 (value (org-icompleting-read
13843 "Value: " (mapcar 'list (org-property-values kwd)))))
13844 (unless (string-match "\\`{.*}\\'" value)
13845 (setq value (concat "\"" value "\"")))
13846 (org-match-sparse-tree arg (concat kwd "=" value))))
13847 ((?r ?R ?/) (call-interactively 'org-occur))
13848 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13850 (defvar org-occur-highlights nil
13851 "List of overlays used for occur matches.")
13852 (make-variable-buffer-local 'org-occur-highlights)
13853 (defvar org-occur-parameters nil
13854 "Parameters of the active org-occur calls.
13855 This is a list, each call to org-occur pushes as cons cell,
13856 containing the regular expression and the callback, onto the list.
13857 The list can contain several entries if `org-occur' has been called
13858 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13859 will only contain one set of parameters. When the highlights are
13860 removed (for example with `C-c C-c', or with the next edit (depending
13861 on `org-remove-highlights-with-change'), this variable is emptied
13862 as well.")
13863 (make-variable-buffer-local 'org-occur-parameters)
13865 (defun org-occur (regexp &optional keep-previous callback)
13866 "Make a compact tree which shows all matches of REGEXP.
13867 The tree will show the lines where the regexp matches, and all higher
13868 headlines above the match. It will also show the heading after the match,
13869 to make sure editing the matching entry is easy.
13870 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13871 call to `org-occur' will be kept, to allow stacking of calls to this
13872 command.
13873 If CALLBACK is non-nil, it is a function which is called to confirm
13874 that the match should indeed be shown."
13875 (interactive "sRegexp: \nP")
13876 (when (equal regexp "")
13877 (user-error "Regexp cannot be empty"))
13878 (unless keep-previous
13879 (org-remove-occur-highlights nil nil t))
13880 (push (cons regexp callback) org-occur-parameters)
13881 (let ((cnt 0))
13882 (save-excursion
13883 (goto-char (point-min))
13884 (if (or (not keep-previous) ; do not want to keep
13885 (not org-occur-highlights)) ; no previous matches
13886 ;; hide everything
13887 (org-overview))
13888 (while (re-search-forward regexp nil t)
13889 (when (or (not callback)
13890 (save-match-data (funcall callback)))
13891 (setq cnt (1+ cnt))
13892 (when org-highlight-sparse-tree-matches
13893 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13894 (org-show-context 'occur-tree))))
13895 (when org-remove-highlights-with-change
13896 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13897 nil 'local))
13898 (unless org-sparse-tree-open-archived-trees
13899 (org-hide-archived-subtrees (point-min) (point-max)))
13900 (run-hooks 'org-occur-hook)
13901 (if (org-called-interactively-p 'interactive)
13902 (message "%d match(es) for regexp %s" cnt regexp))
13903 cnt))
13905 (defun org-occur-next-match (&optional n reset)
13906 "Function for `next-error-function' to find sparse tree matches.
13907 N is the number of matches to move, when negative move backwards.
13908 RESET is entirely ignored - this function always goes back to the
13909 starting point when no match is found."
13910 (let* ((limit (if (< n 0) (point-min) (point-max)))
13911 (search-func (if (< n 0)
13912 'previous-single-char-property-change
13913 'next-single-char-property-change))
13914 (n (abs n))
13915 (pos (point))
13917 (catch 'exit
13918 (while (setq p1 (funcall search-func (point) 'org-type))
13919 (when (equal p1 limit)
13920 (goto-char pos)
13921 (user-error "No more matches"))
13922 (when (equal (get-char-property p1 'org-type) 'org-occur)
13923 (setq n (1- n))
13924 (when (= n 0)
13925 (goto-char p1)
13926 (throw 'exit (point))))
13927 (goto-char p1))
13928 (goto-char p1)
13929 (user-error "No more matches"))))
13931 (defun org-show-context (&optional key)
13932 "Make sure point and context are visible.
13933 Optional argument KEY, when non-nil, is a symbol. See
13934 `org-show-context-detail' for allowed values and how much is to
13935 be shown."
13936 (org-show-set-visibility
13937 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13938 ((cdr (assq key org-show-context-detail)))
13939 (t (cdr (assq 'default org-show-context-detail))))))
13941 (defun org-show-set-visibility (detail)
13942 "Set visibility around point according to DETAIL.
13943 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13944 `tree', `canonical' or t. See `org-show-context-detail' for more
13945 information."
13946 (unless (org-before-first-heading-p)
13947 ;; Show current heading and possibly its entry, following headline
13948 ;; or all children.
13949 (if (and (org-at-heading-p) (not (eq detail 'local)))
13950 (org-flag-heading nil)
13951 (org-show-entry)
13952 (org-with-limited-levels
13953 (case detail
13954 ((tree canonical t) (show-children))
13955 ((nil minimal ancestors))
13956 (t (save-excursion
13957 (outline-next-heading)
13958 (org-flag-heading nil))))))
13959 ;; Show all siblings.
13960 (when (eq detail 'lineage) (org-show-siblings))
13961 ;; Show ancestors, possibly with their children.
13962 (when (memq detail '(ancestors lineage tree canonical t))
13963 (save-excursion
13964 (while (org-up-heading-safe)
13965 (org-flag-heading nil)
13966 (when (memq detail '(canonical t)) (org-show-entry))
13967 (when (memq detail '(tree canonical t)) (show-children)))))))
13969 (defvar org-reveal-start-hook nil
13970 "Hook run before revealing a location.")
13972 (defun org-reveal (&optional siblings)
13973 "Show current entry, hierarchy above it, and the following headline.
13975 This can be used to show a consistent set of context around
13976 locations exposed with `org-show-context'.
13978 With optional argument SIBLINGS, on each level of the hierarchy all
13979 siblings are shown. This repairs the tree structure to what it would
13980 look like when opened with hierarchical calls to `org-cycle'.
13982 With double optional argument \\[universal-argument] \\[universal-argument], \
13983 go to the parent and show the
13984 entire tree."
13985 (interactive "P")
13986 (run-hooks 'org-reveal-start-hook)
13987 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
13988 ((equal siblings '(16))
13989 (save-excursion
13990 (when (org-up-heading-safe)
13991 (org-show-subtree)
13992 (run-hook-with-args 'org-cycle-hook 'subtree))))
13993 (t (org-show-set-visibility 'lineage))))
13995 (defun org-highlight-new-match (beg end)
13996 "Highlight from BEG to END and mark the highlight is an occur headline."
13997 (let ((ov (make-overlay beg end)))
13998 (overlay-put ov 'face 'secondary-selection)
13999 (overlay-put ov 'org-type 'org-occur)
14000 (push ov org-occur-highlights)))
14002 (defun org-remove-occur-highlights (&optional beg end noremove)
14003 "Remove the occur highlights from the buffer.
14004 BEG and END are ignored. If NOREMOVE is nil, remove this function
14005 from the `before-change-functions' in the current buffer."
14006 (interactive)
14007 (unless org-inhibit-highlight-removal
14008 (mapc 'delete-overlay org-occur-highlights)
14009 (setq org-occur-highlights nil)
14010 (setq org-occur-parameters nil)
14011 (unless noremove
14012 (remove-hook 'before-change-functions
14013 'org-remove-occur-highlights 'local))))
14015 ;;;; Priorities
14017 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14018 "Regular expression matching the priority indicator.")
14020 (defvar org-remove-priority-next-time nil)
14022 (defun org-priority-up ()
14023 "Increase the priority of the current item."
14024 (interactive)
14025 (org-priority 'up))
14027 (defun org-priority-down ()
14028 "Decrease the priority of the current item."
14029 (interactive)
14030 (org-priority 'down))
14032 (defun org-priority (&optional action show)
14033 "Change the priority of an item.
14034 ACTION can be `set', `up', `down', or a character."
14035 (interactive "P")
14036 (if (equal action '(4))
14037 (org-show-priority)
14038 (unless org-enable-priority-commands
14039 (user-error "Priority commands are disabled"))
14040 (setq action (or action 'set))
14041 (let (current new news have remove)
14042 (save-excursion
14043 (org-back-to-heading t)
14044 (if (looking-at org-priority-regexp)
14045 (setq current (string-to-char (match-string 2))
14046 have t))
14047 (cond
14048 ((eq action 'remove)
14049 (setq remove t new ?\ ))
14050 ((or (eq action 'set)
14051 (if (featurep 'xemacs) (characterp action) (integerp action)))
14052 (if (not (eq action 'set))
14053 (setq new action)
14054 (message "Priority %c-%c, SPC to remove: "
14055 org-highest-priority org-lowest-priority)
14056 (save-match-data
14057 (setq new (read-char-exclusive))))
14058 (if (and (= (upcase org-highest-priority) org-highest-priority)
14059 (= (upcase org-lowest-priority) org-lowest-priority))
14060 (setq new (upcase new)))
14061 (cond ((equal new ?\ ) (setq remove t))
14062 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14063 (user-error "Priority must be between `%c' and `%c'"
14064 org-highest-priority org-lowest-priority))))
14065 ((eq action 'up)
14066 (setq new (if have
14067 (1- current) ; normal cycling
14068 ;; last priority was empty
14069 (if (eq last-command this-command)
14070 org-lowest-priority ; wrap around empty to lowest
14071 ;; default
14072 (if org-priority-start-cycle-with-default
14073 org-default-priority
14074 (1- org-default-priority))))))
14075 ((eq action 'down)
14076 (setq new (if have
14077 (1+ current) ; normal cycling
14078 ;; last priority was empty
14079 (if (eq last-command this-command)
14080 org-highest-priority ; wrap around empty to highest
14081 ;; default
14082 (if org-priority-start-cycle-with-default
14083 org-default-priority
14084 (1+ org-default-priority))))))
14085 (t (user-error "Invalid action")))
14086 (if (or (< (upcase new) org-highest-priority)
14087 (> (upcase new) org-lowest-priority))
14088 (if (and (memq action '(up down))
14089 (not have) (not (eq last-command this-command)))
14090 ;; `new' is from default priority
14091 (error
14092 "The default can not be set, see `org-default-priority' why")
14093 ;; normal cycling: `new' is beyond highest/lowest priority
14094 ;; and is wrapped around to the empty priority
14095 (setq remove t)))
14096 (setq news (format "%c" new))
14097 (if have
14098 (if remove
14099 (replace-match "" t t nil 1)
14100 (replace-match news t t nil 2))
14101 (if remove
14102 (user-error "No priority cookie found in line")
14103 (let ((case-fold-search nil))
14104 (looking-at org-todo-line-regexp))
14105 (if (match-end 2)
14106 (progn
14107 (goto-char (match-end 2))
14108 (insert " [#" news "]"))
14109 (goto-char (match-beginning 3))
14110 (insert "[#" news "] "))))
14111 (org-set-tags nil 'align))
14112 (if remove
14113 (message "Priority removed")
14114 (message "Priority of current item set to %s" news)))))
14116 (defun org-show-priority ()
14117 "Show the priority of the current item.
14118 This priority is composed of the main priority given with the [#A] cookies,
14119 and by additional input from the age of a schedules or deadline entry."
14120 (interactive)
14121 (let ((pri (if (eq major-mode 'org-agenda-mode)
14122 (org-get-at-bol 'priority)
14123 (save-excursion
14124 (save-match-data
14125 (beginning-of-line)
14126 (and (looking-at org-heading-regexp)
14127 (org-get-priority (match-string 0))))))))
14128 (message "Priority is %d" (if pri pri -1000))))
14130 (defun org-get-priority (s)
14131 "Find priority cookie and return priority."
14132 (save-match-data
14133 (if (functionp org-get-priority-function)
14134 (funcall org-get-priority-function)
14135 (if (not (string-match org-priority-regexp s))
14136 (* 1000 (- org-lowest-priority org-default-priority))
14137 (* 1000 (- org-lowest-priority
14138 (string-to-char (match-string 2 s))))))))
14140 ;;;; Tags
14142 (defvar org-agenda-archives-mode)
14143 (defvar org-map-continue-from nil
14144 "Position from where mapping should continue.
14145 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14147 (defvar org-scanner-tags nil
14148 "The current tag list while the tags scanner is running.")
14149 (defvar org-trust-scanner-tags nil
14150 "Should `org-get-tags-at' use the tags for the scanner.
14151 This is for internal dynamical scoping only.
14152 When this is non-nil, the function `org-get-tags-at' will return the value
14153 of `org-scanner-tags' instead of building the list by itself. This
14154 can lead to large speed-ups when the tags scanner is used in a file with
14155 many entries, and when the list of tags is retrieved, for example to
14156 obtain a list of properties. Building the tags list for each entry in such
14157 a file becomes an N^2 operation - but with this variable set, it scales
14158 as N.")
14160 (defun org-scan-tags (action matcher todo-only &optional start-level)
14161 "Scan headline tags with inheritance and produce output ACTION.
14163 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14164 or `agenda' to produce an entry list for an agenda view. It can also be
14165 a Lisp form or a function that should be called at each matched headline, in
14166 this case the return value is a list of all return values from these calls.
14168 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14169 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14170 only lines with a not-done TODO keyword are included in the output.
14171 This should be the same variable that was scoped into
14172 and set by `org-make-tags-matcher' when it constructed MATCHER.
14174 START-LEVEL can be a string with asterisks, reducing the scope to
14175 headlines matching this string."
14176 (require 'org-agenda)
14177 (let* ((re (concat "^"
14178 (if start-level
14179 ;; Get the correct level to match
14180 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14181 org-outline-regexp)
14182 " *\\(\\<\\("
14183 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14184 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14185 (props (list 'face 'default
14186 'done-face 'org-agenda-done
14187 'undone-face 'default
14188 'mouse-face 'highlight
14189 'org-not-done-regexp org-not-done-regexp
14190 'org-todo-regexp org-todo-regexp
14191 'org-complex-heading-regexp org-complex-heading-regexp
14192 'help-echo
14193 (format "mouse-2 or RET jump to org file %s"
14194 (abbreviate-file-name
14195 (or (buffer-file-name (buffer-base-buffer))
14196 (buffer-name (buffer-base-buffer)))))))
14197 (org-map-continue-from nil)
14198 lspos tags tags-list
14199 (tags-alist (list (cons 0 org-file-tags)))
14200 (llast 0) rtn rtn1 level category i txt
14201 todo marker entry priority
14202 ts-date ts-date-type ts-date-pair)
14203 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14204 (setq action (list 'lambda nil action)))
14205 (save-excursion
14206 (goto-char (point-min))
14207 (when (eq action 'sparse-tree)
14208 (org-overview)
14209 (org-remove-occur-highlights))
14210 (while (let (case-fold-search)
14211 (re-search-forward re nil t))
14212 (setq org-map-continue-from nil)
14213 (catch :skip
14214 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14215 tags (if (match-end 4) (org-match-string-no-properties 4)))
14216 (goto-char (setq lspos (match-beginning 0)))
14217 (setq level (org-reduced-level (org-outline-level))
14218 category (org-get-category))
14219 (when (eq action 'agenda)
14220 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14221 ts-date (car ts-date-pair)
14222 ts-date-type (cdr ts-date-pair)))
14223 (setq i llast llast level)
14224 ;; remove tag lists from same and sublevels
14225 (while (>= i level)
14226 (when (setq entry (assoc i tags-alist))
14227 (setq tags-alist (delete entry tags-alist)))
14228 (setq i (1- i)))
14229 ;; add the next tags
14230 (when tags
14231 (setq tags (org-split-string tags ":")
14232 tags-alist
14233 (cons (cons level tags) tags-alist)))
14234 ;; compile tags for current headline
14235 (setq tags-list
14236 (if org-use-tag-inheritance
14237 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14238 tags)
14239 org-scanner-tags tags-list)
14240 (when org-use-tag-inheritance
14241 (setcdr (car tags-alist)
14242 (mapcar (lambda (x)
14243 (setq x (copy-sequence x))
14244 (org-add-prop-inherited x))
14245 (cdar tags-alist))))
14246 (when (and tags org-use-tag-inheritance
14247 (or (not (eq t org-use-tag-inheritance))
14248 org-tags-exclude-from-inheritance))
14249 ;; selective inheritance, remove uninherited ones
14250 (setcdr (car tags-alist)
14251 (org-remove-uninherited-tags (cdar tags-alist))))
14252 (when (and
14254 ;; eval matcher only when the todo condition is OK
14255 (and (or (not todo-only) (member todo org-not-done-keywords))
14256 (let ((case-fold-search t) (org-trust-scanner-tags t))
14257 (eval matcher)))
14259 ;; Call the skipper, but return t if it does not skip,
14260 ;; so that the `and' form continues evaluating
14261 (progn
14262 (unless (eq action 'sparse-tree) (org-agenda-skip))
14265 ;; Check if timestamps are deselecting this entry
14266 (or (not todo-only)
14267 (and (member todo org-not-done-keywords)
14268 (or (not org-agenda-tags-todo-honor-ignore-options)
14269 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14271 ;; select this headline
14272 (cond
14273 ((eq action 'sparse-tree)
14274 (and org-highlight-sparse-tree-matches
14275 (org-get-heading) (match-end 0)
14276 (org-highlight-new-match
14277 (match-beginning 1) (match-end 1)))
14278 (org-show-context 'tags-tree))
14279 ((eq action 'agenda)
14280 (setq txt (org-agenda-format-item
14282 (concat
14283 (if (eq org-tags-match-list-sublevels 'indented)
14284 (make-string (1- level) ?.) "")
14285 (org-get-heading))
14286 (make-string level ?\s)
14287 category
14288 tags-list)
14289 priority (org-get-priority txt))
14290 (goto-char lspos)
14291 (setq marker (org-agenda-new-marker))
14292 (org-add-props txt props
14293 'org-marker marker 'org-hd-marker marker 'org-category category
14294 'todo-state todo
14295 'ts-date ts-date
14296 'priority priority
14297 'type (concat "tagsmatch" ts-date-type))
14298 (push txt rtn))
14299 ((functionp action)
14300 (setq org-map-continue-from nil)
14301 (save-excursion
14302 (setq rtn1 (funcall action))
14303 (push rtn1 rtn)))
14304 (t (user-error "Invalid action")))
14306 ;; if we are to skip sublevels, jump to end of subtree
14307 (unless org-tags-match-list-sublevels
14308 (org-end-of-subtree t)
14309 (backward-char 1))))
14310 ;; Get the correct position from where to continue
14311 (if org-map-continue-from
14312 (goto-char org-map-continue-from)
14313 (and (= (point) lspos) (end-of-line 1)))))
14314 (when (and (eq action 'sparse-tree)
14315 (not org-sparse-tree-open-archived-trees))
14316 (org-hide-archived-subtrees (point-min) (point-max)))
14317 (nreverse rtn)))
14319 (defun org-remove-uninherited-tags (tags)
14320 "Remove all tags that are not inherited from the list TAGS."
14321 (cond
14322 ((eq org-use-tag-inheritance t)
14323 (if org-tags-exclude-from-inheritance
14324 (org-delete-all org-tags-exclude-from-inheritance tags)
14325 tags))
14326 ((not org-use-tag-inheritance) nil)
14327 ((stringp org-use-tag-inheritance)
14328 (delq nil (mapcar
14329 (lambda (x)
14330 (if (and (string-match org-use-tag-inheritance x)
14331 (not (member x org-tags-exclude-from-inheritance)))
14332 x nil))
14333 tags)))
14334 ((listp org-use-tag-inheritance)
14335 (delq nil (mapcar
14336 (lambda (x)
14337 (if (member x org-use-tag-inheritance) x nil))
14338 tags)))))
14340 (defun org-match-sparse-tree (&optional todo-only match)
14341 "Create a sparse tree according to tags string MATCH.
14342 MATCH can contain positive and negative selection of tags, like
14343 \"+WORK+URGENT-WITHBOSS\".
14344 If optional argument TODO-ONLY is non-nil, only select lines that are
14345 also TODO lines."
14346 (interactive "P")
14347 (org-agenda-prepare-buffers (list (current-buffer)))
14348 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14350 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14352 (defvar org-cached-props nil)
14353 (defun org-cached-entry-get (pom property)
14354 (if (or (eq t org-use-property-inheritance)
14355 (and (stringp org-use-property-inheritance)
14356 (let ((case-fold-search t))
14357 (org-string-match-p org-use-property-inheritance property)))
14358 (and (listp org-use-property-inheritance)
14359 (member-ignore-case property org-use-property-inheritance)))
14360 ;; Caching is not possible, check it directly.
14361 (org-entry-get pom property 'inherit)
14362 ;; Get all properties, so we can do complicated checks easily.
14363 (cdr (assoc-string property
14364 (or org-cached-props
14365 (setq org-cached-props (org-entry-properties pom)))
14366 t))))
14368 (defun org-global-tags-completion-table (&optional files)
14369 "Return the list of all tags in all agenda buffer/files.
14370 Optional FILES argument is a list of files which can be used
14371 instead of the agenda files."
14372 (save-excursion
14373 (org-uniquify
14374 (delq nil
14375 (apply 'append
14376 (mapcar
14377 (lambda (file)
14378 (set-buffer (find-file-noselect file))
14379 (append (org-get-buffer-tags)
14380 (mapcar (lambda (x) (if (stringp (car-safe x))
14381 (list (car-safe x)) nil))
14382 org-tag-alist)))
14383 (if (and files (car files))
14384 files
14385 (org-agenda-files))))))))
14387 (defun org-make-tags-matcher (match)
14388 "Create the TAGS/TODO matcher form for the selection string MATCH.
14390 The variable `todo-only' is scoped dynamically into this function.
14391 It will be set to t if the matcher restricts matching to TODO entries,
14392 otherwise will not be touched.
14394 Returns a cons of the selection string MATCH and the constructed
14395 lisp form implementing the matcher. The matcher is to be evaluated
14396 at an Org entry, with point on the headline, and returns t if the
14397 entry matches the selection string MATCH. The returned lisp form
14398 references two variables with information about the entry, which
14399 must be bound around the form's evaluation: todo, the TODO keyword
14400 at the entry (or nil of none); and tags-list, the list of all tags
14401 at the entry including inherited ones. Additionally, the category
14402 of the entry (if any) must be specified as the text property
14403 'org-category on the headline.
14405 See also `org-scan-tags'.
14407 (declare (special todo-only))
14408 (unless (boundp 'todo-only)
14409 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14410 (unless match
14411 ;; Get a new match request, with completion against the global
14412 ;; tags table and the local tags in current buffer
14413 (let ((org-last-tags-completion-table
14414 (org-uniquify
14415 (delq nil (append (org-get-buffer-tags)
14416 (org-global-tags-completion-table))))))
14417 (setq match (org-completing-read-no-i
14418 "Match: " 'org-tags-completion-function nil nil nil
14419 'org-tags-history))))
14421 ;; Parse the string and create a lisp form
14422 (let ((match0 match)
14423 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14424 minus tag mm
14425 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14426 orterms term orlist re-p str-p level-p level-op time-p
14427 prop-p pn pv po gv rest (start 0) (ss 0))
14428 ;; Expand group tags
14429 (setq match (org-tags-expand match))
14431 ;; Check if there is a TODO part of this match, which would be the
14432 ;; part after a "/". TO make sure that this slash is not part of
14433 ;; a property value to be matched against, we also check that there
14434 ;; is no " after that slash.
14435 ;; First, find the last slash
14436 (while (string-match "/+" match ss)
14437 (setq start (match-beginning 0) ss (match-end 0)))
14438 (if (and (string-match "/+" match start)
14439 (not (save-match-data (string-match "\"" match start))))
14440 ;; match contains also a todo-matching request
14441 (progn
14442 (setq tagsmatch (substring match 0 (match-beginning 0))
14443 todomatch (substring match (match-end 0)))
14444 (if (string-match "^!" todomatch)
14445 (setq todo-only t todomatch (substring todomatch 1)))
14446 (if (string-match "^\\s-*$" todomatch)
14447 (setq todomatch nil)))
14448 ;; only matching tags
14449 (setq tagsmatch match todomatch nil))
14451 ;; Make the tags matcher
14452 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14453 (setq tagsmatcher t)
14454 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14455 (while (setq term (pop orterms))
14456 (while (and (equal (substring term -1) "\\") orterms)
14457 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14458 (while (string-match re term)
14459 (setq rest (substring term (match-end 0))
14460 minus (and (match-end 1)
14461 (equal (match-string 1 term) "-"))
14462 tag (save-match-data (replace-regexp-in-string
14463 "\\\\-" "-"
14464 (match-string 2 term)))
14465 re-p (equal (string-to-char tag) ?{)
14466 level-p (match-end 4)
14467 prop-p (match-end 5)
14468 mm (cond
14469 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14470 (level-p
14471 (setq level-op (org-op-to-function (match-string 3 term)))
14472 `(,level-op level ,(string-to-number
14473 (match-string 4 term))))
14474 (prop-p
14475 (setq pn (match-string 5 term)
14476 po (match-string 6 term)
14477 pv (match-string 7 term)
14478 re-p (equal (string-to-char pv) ?{)
14479 str-p (equal (string-to-char pv) ?\")
14480 time-p (save-match-data
14481 (string-match "^\"[[<].*[]>]\"$" pv))
14482 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14483 (if time-p (setq pv (org-matcher-time pv)))
14484 (setq po (org-op-to-function po (if time-p 'time str-p)))
14485 (cond
14486 ((equal pn "CATEGORY")
14487 (setq gv '(get-text-property (point) 'org-category)))
14488 ((equal pn "TODO")
14489 (setq gv 'todo))
14491 (setq gv `(org-cached-entry-get nil ,pn))))
14492 (if re-p
14493 (if (eq po 'org<>)
14494 `(not (string-match ,pv (or ,gv "")))
14495 `(string-match ,pv (or ,gv "")))
14496 (if str-p
14497 `(,po (or ,gv "") ,pv)
14498 `(,po (string-to-number (or ,gv ""))
14499 ,(string-to-number pv) ))))
14500 (t `(member ,tag tags-list)))
14501 mm (if minus (list 'not mm) mm)
14502 term rest)
14503 (push mm tagsmatcher))
14504 (push (if (> (length tagsmatcher) 1)
14505 (cons 'and tagsmatcher)
14506 (car tagsmatcher))
14507 orlist)
14508 (setq tagsmatcher nil))
14509 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14510 (setq tagsmatcher
14511 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14512 ;; Make the todo matcher
14513 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14514 (setq todomatcher t)
14515 (setq orterms (org-split-string todomatch "|") orlist nil)
14516 (while (setq term (pop orterms))
14517 (while (string-match re term)
14518 (setq minus (and (match-end 1)
14519 (equal (match-string 1 term) "-"))
14520 kwd (match-string 2 term)
14521 re-p (equal (string-to-char kwd) ?{)
14522 term (substring term (match-end 0))
14523 mm (if re-p
14524 `(string-match ,(substring kwd 1 -1) todo)
14525 (list 'equal 'todo kwd))
14526 mm (if minus (list 'not mm) mm))
14527 (push mm todomatcher))
14528 (push (if (> (length todomatcher) 1)
14529 (cons 'and todomatcher)
14530 (car todomatcher))
14531 orlist)
14532 (setq todomatcher nil))
14533 (setq todomatcher (if (> (length orlist) 1)
14534 (cons 'or orlist) (car orlist))))
14536 ;; Return the string and lisp forms of the matcher
14537 (setq matcher (if todomatcher
14538 (list 'and tagsmatcher todomatcher)
14539 tagsmatcher))
14540 (when todo-only
14541 (setq matcher (list 'and '(member todo org-not-done-keywords)
14542 matcher)))
14543 (cons match0 matcher)))
14545 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14546 "Expand group tags in MATCH.
14548 This replaces every group tag in MATCH with a regexp tag search.
14549 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14550 will be replaced like this:
14552 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14553 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14554 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14556 Replacing by a regexp preserves the structure of the match.
14557 E.g., this expansion
14559 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14561 will match anything tagged with \"Lab\" and \"Home\", or tagged
14562 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14564 A group tag in MATCH can contain regular expressions of its own.
14565 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14566 will be replaced like this:
14568 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14570 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14571 assumed to be a single group tag, and the function will return
14572 the list of tags in this group.
14574 When DOWNCASE is non-nil, expand downcased TAGS."
14575 (if org-group-tags
14576 (let* ((case-fold-search t)
14577 (stable org-mode-syntax-table)
14578 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14579 (taggroups (if downcased
14580 (mapcar (lambda (tg) (mapcar #'downcase tg))
14581 taggroups)
14582 taggroups))
14583 (taggroups-keys (mapcar #'car taggroups))
14584 (return-match (if downcased (downcase match) match))
14585 (count 0)
14586 (work-already-expanded tags-already-expanded)
14587 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14588 ;; @ and _ are allowed as word-components in tags.
14589 (modify-syntax-entry ?@ "w" stable)
14590 (modify-syntax-entry ?_ "w" stable)
14591 ;; Temporarily replace regexp-expressions in the match-expression.
14592 (while (string-match "{.+?}" return-match)
14593 (incf count)
14594 (push (match-string 0 return-match) regexps-in-match)
14595 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14596 (while (and taggroups-keys
14597 (with-syntax-table stable
14598 (string-match
14599 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14600 (regexp-opt taggroups-keys) "\\>\\)") return-match)))
14601 (let* ((dir (match-string 1 return-match))
14602 (tag (match-string 2 return-match))
14603 (tag (if downcased (downcase tag) tag)))
14604 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14605 (member tag work-already-expanded))
14606 (setq tags-in-group (assoc tag taggroups))
14607 (push tag work-already-expanded)
14608 ;; Recursively expand each tag in the group, if the tag hasn't
14609 ;; already been expanded. Restore the match-data after all recursive calls.
14610 (save-match-data
14611 (let (tags-expanded)
14612 (dolist (x (cdr tags-in-group))
14613 (if (and (member x taggroups-keys)
14614 (not (member x work-already-expanded)))
14615 (setq tags-expanded
14616 (delete-dups
14617 (append
14618 (org-tags-expand x t downcased
14619 work-already-expanded)
14620 tags-expanded)))
14621 (setq tags-expanded
14622 (append (list x) tags-expanded)))
14623 (setq work-already-expanded
14624 (delete-dups
14625 (append tags-expanded
14626 work-already-expanded))))
14627 (setq tags-in-group
14628 (delete-dups (cons (car tags-in-group)
14629 tags-expanded)))))
14630 ;; Filter tag-regexps from tags.
14631 (setq regexp-in-group-escaped
14632 (delq nil (mapcar (lambda (x)
14633 (if (stringp x)
14634 (and (equal "{" (substring x 0 1))
14635 (equal "}" (substring x -1))
14638 tags-in-group))
14639 regexp-in-group
14640 (mapcar (lambda (x)
14641 (substring x 1 -1))
14642 regexp-in-group-escaped)
14643 tags-in-group
14644 (delq nil (mapcar (lambda (x)
14645 (if (stringp x)
14646 (and (not (equal "{" (substring x 0 1)))
14647 (not (equal "}" (substring x -1)))
14650 tags-in-group)))
14651 ;; If single-as-list, do no more in the while-loop.
14652 (if (not single-as-list)
14653 (progn
14654 (when regexp-in-group
14655 (setq regexp-in-group
14656 (concat "\\|"
14657 (mapconcat 'identity regexp-in-group
14658 "\\|"))))
14659 (setq tags-in-group
14660 (concat dir
14661 "{\\<"
14662 (regexp-opt tags-in-group)
14663 "\\>"
14664 regexp-in-group
14665 "}"))
14666 (when (stringp tags-in-group)
14667 (org-add-props tags-in-group '(grouptag t)))
14668 (setq return-match
14669 (replace-match tags-in-group t t return-match)))
14670 (setq tags-in-group
14671 (append regexp-in-group-escaped tags-in-group))))
14672 (setq taggroups-keys (delete tag taggroups-keys))))
14673 ;; Add the regular expressions back into the match-expression again.
14674 (while regexps-in-match
14675 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14676 (pop regexps-in-match)
14677 return-match t t))
14678 (decf count))
14679 (if single-as-list
14680 (if tags-in-group tags-in-group (list return-match))
14681 return-match))
14682 (if single-as-list
14683 (list (if downcased (downcase match) match))
14684 match)))
14686 (defun org-op-to-function (op &optional stringp)
14687 "Turn an operator into the appropriate function."
14688 (setq op
14689 (cond
14690 ((equal op "<" ) '(< string< org-time<))
14691 ((equal op ">" ) '(> org-string> org-time>))
14692 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14693 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14694 ((member op '("=" "==")) '(= string= org-time=))
14695 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14696 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14698 (defun org<> (a b) (not (= a b)))
14699 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14700 (defun org-string>= (a b) (not (string< a b)))
14701 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14702 (defun org-string<> (a b) (not (string= a b)))
14703 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14704 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14705 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14706 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14707 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14708 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14709 (defun org-2ft (s)
14710 "Convert S to a floating point time.
14711 If S is already a number, just return it. If it is a string, parse
14712 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14713 (cond
14714 ((numberp s) s)
14715 ((stringp s)
14716 (condition-case nil
14717 (float-time (apply 'encode-time (org-parse-time-string s)))
14718 (error 0.)))
14719 (t 0.)))
14721 (defun org-time-today ()
14722 "Time in seconds today at 0:00.
14723 Returns the float number of seconds since the beginning of the
14724 epoch to the beginning of today (00:00)."
14725 (float-time (apply 'encode-time
14726 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14728 (defun org-matcher-time (s)
14729 "Interpret a time comparison value."
14730 (save-match-data
14731 (cond
14732 ((string= s "<now>") (float-time))
14733 ((string= s "<today>") (org-time-today))
14734 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14735 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14736 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14737 (+ (org-time-today)
14738 (* (string-to-number (match-string 1 s))
14739 (cdr (assoc (match-string 2 s)
14740 '(("d" . 86400.0) ("w" . 604800.0)
14741 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14742 (t (org-2ft s)))))
14744 (defun org-match-any-p (re list)
14745 "Does re match any element of list?"
14746 (setq list (mapcar (lambda (x) (string-match re x)) list))
14747 (delq nil list))
14749 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14750 (defvar org-tags-overlay (make-overlay 1 1))
14751 (org-detach-overlay org-tags-overlay)
14753 (defun org-get-local-tags-at (&optional pos)
14754 "Get a list of tags defined in the current headline."
14755 (org-get-tags-at pos 'local))
14757 (defun org-get-local-tags ()
14758 "Get a list of tags defined in the current headline."
14759 (org-get-tags-at nil 'local))
14761 (defun org-get-tags-at (&optional pos local)
14762 "Get a list of all headline tags applicable at POS.
14763 POS defaults to point. If tags are inherited, the list contains
14764 the targets in the same sequence as the headlines appear, i.e.
14765 the tags of the current headline come last.
14766 When LOCAL is non-nil, only return tags from the current headline,
14767 ignore inherited ones."
14768 (interactive)
14769 (if (and org-trust-scanner-tags
14770 (or (not pos) (equal pos (point)))
14771 (not local))
14772 org-scanner-tags
14773 (let (tags ltags lastpos parent)
14774 (save-excursion
14775 (save-restriction
14776 (widen)
14777 (goto-char (or pos (point)))
14778 (save-match-data
14779 (catch 'done
14780 (condition-case nil
14781 (progn
14782 (org-back-to-heading t)
14783 (while (not (equal lastpos (point)))
14784 (setq lastpos (point))
14785 (when (looking-at
14786 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14787 (setq ltags (org-split-string
14788 (org-match-string-no-properties 1) ":"))
14789 (when parent
14790 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14791 (setq tags (append
14792 (if parent
14793 (org-remove-uninherited-tags ltags)
14794 ltags)
14795 tags)))
14796 (or org-use-tag-inheritance (throw 'done t))
14797 (if local (throw 'done t))
14798 (or (org-up-heading-safe) (error nil))
14799 (setq parent t)))
14800 (error nil)))))
14801 (if local
14802 tags
14803 (reverse (delete-dups
14804 (reverse (append
14805 (org-remove-uninherited-tags
14806 org-file-tags) tags)))))))))
14808 (defun org-add-prop-inherited (s)
14809 (add-text-properties 0 (length s) '(inherited t) s)
14812 (defun org-toggle-tag (tag &optional onoff)
14813 "Toggle the tag TAG for the current line.
14814 If ONOFF is `on' or `off', don't toggle but set to this state."
14815 (let (res current)
14816 (save-excursion
14817 (org-back-to-heading t)
14818 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14819 (point-at-eol) t)
14820 (progn
14821 (setq current (match-string 1))
14822 (replace-match ""))
14823 (setq current ""))
14824 (setq current (nreverse (org-split-string current ":")))
14825 (cond
14826 ((eq onoff 'on)
14827 (setq res t)
14828 (or (member tag current) (push tag current)))
14829 ((eq onoff 'off)
14830 (or (not (member tag current)) (setq current (delete tag current))))
14831 (t (if (member tag current)
14832 (setq current (delete tag current))
14833 (setq res t)
14834 (push tag current))))
14835 (end-of-line 1)
14836 (if current
14837 (progn
14838 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14839 (org-set-tags nil t))
14840 (delete-horizontal-space))
14841 (run-hooks 'org-after-tags-change-hook))
14842 res))
14844 (defun org-align-tags-here (to-col)
14845 ;; Assumes that this is a headline
14846 "Align tags on the current headline to TO-COL."
14847 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14848 (beginning-of-line 1)
14849 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14850 (< pos (match-beginning 2)))
14851 (progn
14852 (setq tags-l (- (match-end 2) (match-beginning 2)))
14853 (goto-char (match-beginning 1))
14854 (insert " ")
14855 (delete-region (point) (1+ (match-beginning 2)))
14856 (setq ncol (max (current-column)
14857 (1+ col)
14858 (if (> to-col 0)
14859 to-col
14860 (- (abs to-col) tags-l))))
14861 (setq p (point))
14862 (insert (make-string (- ncol (current-column)) ?\ ))
14863 (setq ncol (current-column))
14864 (when indent-tabs-mode (tabify p (point-at-eol)))
14865 (org-move-to-column (min ncol col)))
14866 (goto-char pos))))
14868 (defun org-set-tags-command (&optional arg just-align)
14869 "Call the set-tags command for the current entry."
14870 (interactive "P")
14871 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14872 (org-set-tags arg just-align)
14873 (save-excursion
14874 (unless (and (org-region-active-p)
14875 org-loop-over-headlines-in-active-region)
14876 (org-back-to-heading t))
14877 (org-set-tags arg just-align))))
14879 (defun org-set-tags-to (data)
14880 "Set the tags of the current entry to DATA, replacing the current tags.
14881 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14882 If DATA is nil or the empty string, any tags will be removed."
14883 (interactive "sTags: ")
14884 (setq data
14885 (cond
14886 ((eq data nil) "")
14887 ((equal data "") "")
14888 ((stringp data)
14889 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14890 ":"))
14891 ((listp data)
14892 (concat ":" (mapconcat 'identity data ":") ":"))))
14893 (when data
14894 (save-excursion
14895 (org-back-to-heading t)
14896 (when (looking-at org-complex-heading-regexp)
14897 (if (match-end 5)
14898 (progn
14899 (goto-char (match-beginning 5))
14900 (insert data)
14901 (delete-region (point) (point-at-eol))
14902 (org-set-tags nil 'align))
14903 (goto-char (point-at-eol))
14904 (insert " " data)
14905 (org-set-tags nil 'align)))
14906 (beginning-of-line 1)
14907 (if (looking-at ".*?\\([ \t]+\\)$")
14908 (delete-region (match-beginning 1) (match-end 1))))))
14910 (defun org-align-all-tags ()
14911 "Align the tags i all headings."
14912 (interactive)
14913 (save-excursion
14914 (or (ignore-errors (org-back-to-heading t))
14915 (outline-next-heading))
14916 (if (org-at-heading-p)
14917 (org-set-tags t)
14918 (message "No headings"))))
14920 (defvar org-indent-indentation-per-level)
14921 (defun org-set-tags (&optional arg just-align)
14922 "Set the tags for the current headline.
14923 With prefix ARG, realign all tags in headings in the current buffer.
14924 When JUST-ALIGN is non-nil, only align tags."
14925 (interactive "P")
14926 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14927 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14928 'region-start-level 'region))
14929 org-loop-over-headlines-in-active-region)
14930 (org-map-entries
14931 ;; We don't use ARG and JUST-ALIGN here because these args
14932 ;; are not useful when looping over headlines.
14933 `(org-set-tags)
14934 org-loop-over-headlines-in-active-region
14935 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14936 (let* ((re org-outline-regexp-bol)
14937 (current (unless arg (org-get-tags-string)))
14938 (col (current-column))
14939 (org-setting-tags t)
14940 table current-tags inherited-tags ; computed below when needed
14941 tags p0 c0 c1 rpl di tc level)
14942 (if arg
14943 (save-excursion
14944 (goto-char (point-min))
14945 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14946 (while (re-search-forward re nil t)
14947 (org-set-tags nil t)
14948 (end-of-line 1)))
14949 (message "All tags realigned to column %d" org-tags-column))
14950 (if just-align
14951 (setq tags current)
14952 ;; Get a new set of tags from the user
14953 (save-excursion
14954 (setq table (append org-tag-persistent-alist
14955 (or org-tag-alist (org-get-buffer-tags))
14956 (and
14957 org-complete-tags-always-offer-all-agenda-tags
14958 (org-global-tags-completion-table
14959 (org-agenda-files))))
14960 org-last-tags-completion-table table
14961 current-tags (org-split-string current ":")
14962 inherited-tags (nreverse
14963 (nthcdr (length current-tags)
14964 (nreverse (org-get-tags-at))))
14965 tags
14966 (if (or (eq t org-use-fast-tag-selection)
14967 (and org-use-fast-tag-selection
14968 (delq nil (mapcar 'cdr table))))
14969 (org-fast-tag-selection
14970 current-tags inherited-tags table
14971 (if org-fast-tag-selection-include-todo
14972 org-todo-key-alist))
14973 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14974 (org-trim
14975 (org-icompleting-read "Tags: "
14976 'org-tags-completion-function
14977 nil nil current 'org-tags-history))))))
14978 (while (string-match "[-+&]+" tags)
14979 ;; No boolean logic, just a list
14980 (setq tags (replace-match ":" t t tags))))
14982 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14984 (if org-tags-sort-function
14985 (setq tags (mapconcat 'identity
14986 (sort (org-split-string
14987 tags (org-re "[^[:alnum:]_@#%]+"))
14988 org-tags-sort-function) ":")))
14990 (if (string-match "\\`[\t ]*\\'" tags)
14991 (setq tags "")
14992 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14993 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14995 ;; Insert new tags at the correct column
14996 (beginning-of-line 1)
14997 (setq level (or (and (looking-at org-outline-regexp)
14998 (- (match-end 0) (point) 1))
15000 (cond
15001 ((and (equal current "") (equal tags "")))
15002 ((re-search-forward
15003 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15004 (point-at-eol) t)
15005 (if (equal tags "")
15006 (setq rpl "")
15007 (goto-char (match-beginning 0))
15008 (setq c0 (current-column)
15009 ;; compute offset for the case of org-indent-mode active
15010 di (if (org-bound-and-true-p org-indent-mode)
15011 (* (1- org-indent-indentation-per-level) (1- level))
15013 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
15014 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
15015 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
15016 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15017 (replace-match rpl t t)
15018 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15019 tags)
15020 (t (error "Tags alignment failed")))
15021 (org-move-to-column col)
15022 (unless just-align
15023 (run-hooks 'org-after-tags-change-hook))))))
15025 (defun org-change-tag-in-region (beg end tag off)
15026 "Add or remove TAG for each entry in the region.
15027 This works in the agenda, and also in an org-mode buffer."
15028 (interactive
15029 (list (region-beginning) (region-end)
15030 (let ((org-last-tags-completion-table
15031 (if (derived-mode-p 'org-mode)
15032 (org-uniquify
15033 (delq nil (append (org-get-buffer-tags)
15034 (org-global-tags-completion-table))))
15035 (org-global-tags-completion-table))))
15036 (org-icompleting-read
15037 "Tag: " 'org-tags-completion-function nil nil nil
15038 'org-tags-history))
15039 (progn
15040 (message "[s]et or [r]emove? ")
15041 (equal (read-char-exclusive) ?r))))
15042 (if (fboundp 'deactivate-mark) (deactivate-mark))
15043 (let ((agendap (equal major-mode 'org-agenda-mode))
15044 l1 l2 m buf pos newhead (cnt 0))
15045 (goto-char end)
15046 (setq l2 (1- (org-current-line)))
15047 (goto-char beg)
15048 (setq l1 (org-current-line))
15049 (loop for l from l1 to l2 do
15050 (org-goto-line l)
15051 (setq m (get-text-property (point) 'org-hd-marker))
15052 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15053 (and agendap m))
15054 (setq buf (if agendap (marker-buffer m) (current-buffer))
15055 pos (if agendap m (point)))
15056 (with-current-buffer buf
15057 (save-excursion
15058 (save-restriction
15059 (goto-char pos)
15060 (setq cnt (1+ cnt))
15061 (org-toggle-tag tag (if off 'off 'on))
15062 (setq newhead (org-get-heading)))))
15063 (and agendap (org-agenda-change-all-lines newhead m))))
15064 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15066 (defun org-tags-completion-function (string predicate &optional flag)
15067 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15068 (confirm (lambda (x) (stringp (car x)))))
15069 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15070 (setq s1 (match-string 1 string)
15071 s2 (match-string 2 string))
15072 (setq s1 "" s2 string))
15073 (cond
15074 ((eq flag nil)
15075 ;; try completion
15076 (setq rtn (try-completion s2 ctable confirm))
15077 (if (stringp rtn)
15078 (setq rtn
15079 (concat s1 s2 (substring rtn (length s2))
15080 (if (and org-add-colon-after-tag-completion
15081 (assoc rtn ctable))
15082 ":" ""))))
15083 rtn)
15084 ((eq flag t)
15085 ;; all-completions
15086 (all-completions s2 ctable confirm))
15087 ((eq flag 'lambda)
15088 ;; exact match?
15089 (assoc s2 ctable)))))
15091 (defun org-fast-tag-insert (kwd tags face &optional end)
15092 "Insert KDW, and the TAGS, the latter with face FACE.
15093 Also insert END."
15094 (insert (format "%-12s" (concat kwd ":"))
15095 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15096 (or end "")))
15098 (defun org-fast-tag-show-exit (flag)
15099 (save-excursion
15100 (org-goto-line 3)
15101 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15102 (replace-match ""))
15103 (when flag
15104 (end-of-line 1)
15105 (org-move-to-column (- (window-width) 19) t)
15106 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15108 (defun org-set-current-tags-overlay (current prefix)
15109 "Add an overlay to CURRENT tag with PREFIX."
15110 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15111 (if (featurep 'xemacs)
15112 (org-overlay-display org-tags-overlay (concat prefix s)
15113 'secondary-selection)
15114 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15115 (org-overlay-display org-tags-overlay (concat prefix s)))))
15117 (defvar org-last-tag-selection-key nil)
15118 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15119 "Fast tag selection with single keys.
15120 CURRENT is the current list of tags in the headline, INHERITED is the
15121 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15122 possibly with grouping information. TODO-TABLE is a similar table with
15123 TODO keywords, should these have keys assigned to them.
15124 If the keys are nil, a-z are automatically assigned.
15125 Returns the new tags string, or nil to not change the current settings."
15126 (let* ((fulltable (append table todo-table))
15127 (maxlen (apply 'max (mapcar
15128 (lambda (x)
15129 (if (stringp (car x)) (string-width (car x)) 0))
15130 fulltable)))
15131 (buf (current-buffer))
15132 (expert (eq org-fast-tag-selection-single-key 'expert))
15133 (buffer-tags nil)
15134 (fwidth (+ maxlen 3 1 3))
15135 (ncol (/ (- (window-width) 4) fwidth))
15136 (i-face 'org-done)
15137 (c-face 'org-todo)
15138 tg cnt e c char c1 c2 ntable tbl rtn
15139 ov-start ov-end ov-prefix
15140 (exit-after-next org-fast-tag-selection-single-key)
15141 (done-keywords org-done-keywords)
15142 groups ingroup intaggroup)
15143 (save-excursion
15144 (beginning-of-line 1)
15145 (if (looking-at
15146 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15147 (setq ov-start (match-beginning 1)
15148 ov-end (match-end 1)
15149 ov-prefix "")
15150 (setq ov-start (1- (point-at-eol))
15151 ov-end (1+ ov-start))
15152 (skip-chars-forward "^\n\r")
15153 (setq ov-prefix
15154 (concat
15155 (buffer-substring (1- (point)) (point))
15156 (if (> (current-column) org-tags-column)
15158 (make-string (- org-tags-column (current-column)) ?\ ))))))
15159 (move-overlay org-tags-overlay ov-start ov-end)
15160 (save-window-excursion
15161 (if expert
15162 (set-buffer (get-buffer-create " *Org tags*"))
15163 (delete-other-windows)
15164 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15165 (org-switch-to-buffer-other-window " *Org tags*"))
15166 (erase-buffer)
15167 (org-set-local 'org-done-keywords done-keywords)
15168 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15169 (org-fast-tag-insert "Current" current c-face "\n\n")
15170 (org-fast-tag-show-exit exit-after-next)
15171 (org-set-current-tags-overlay current ov-prefix)
15172 (setq tbl fulltable char ?a cnt 0)
15173 (while (setq e (pop tbl))
15174 (cond
15175 ((eq (car e) :startgroup)
15176 (push '() groups) (setq ingroup t)
15177 (unless (zerop cnt)
15178 (setq cnt 0)
15179 (insert "\n"))
15180 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15181 ((eq (car e) :endgroup)
15182 (setq ingroup nil cnt 0)
15183 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15184 ((eq (car e) :startgrouptag)
15185 (setq intaggroup t)
15186 (unless (zerop cnt)
15187 (setq cnt 0)
15188 (insert "\n"))
15189 (insert "[ "))
15190 ((eq (car e) :endgrouptag)
15191 (setq intaggroup nil cnt 0)
15192 (insert "]\n"))
15193 ((equal e '(:newline))
15194 (unless (zerop cnt)
15195 (setq cnt 0)
15196 (insert "\n")
15197 (setq e (car tbl))
15198 (while (equal (car tbl) '(:newline))
15199 (insert "\n")
15200 (setq tbl (cdr tbl)))))
15201 ((equal e '(:grouptags)) (insert " : "))
15203 (setq tg (copy-sequence (car e)) c2 nil)
15204 (if (cdr e)
15205 (setq c (cdr e))
15206 ;; automatically assign a character.
15207 (setq c1 (string-to-char
15208 (downcase (substring
15209 tg (if (= (string-to-char tg) ?@) 1 0)))))
15210 (if (or (rassoc c1 ntable) (rassoc c1 table))
15211 (while (or (rassoc char ntable) (rassoc char table))
15212 (setq char (1+ char)))
15213 (setq c2 c1))
15214 (setq c (or c2 char)))
15215 (when ingroup (push tg (car groups)))
15216 (setq tg (org-add-props tg nil 'face
15217 (cond
15218 ((not (assoc tg table))
15219 (org-get-todo-face tg))
15220 ((member tg current) c-face)
15221 ((member tg inherited) i-face))))
15222 (when (equal (caar tbl) :grouptags)
15223 (org-add-props tg nil 'face 'org-tag-group))
15224 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15225 (insert "[" c "] " tg (make-string
15226 (- fwidth 4 (length tg)) ?\ ))
15227 (push (cons tg c) ntable)
15228 (when (= (incf cnt) ncol)
15229 (insert "\n")
15230 (when (or ingroup intaggroup) (insert " "))
15231 (setq cnt 0)))))
15232 (setq ntable (nreverse ntable))
15233 (insert "\n")
15234 (goto-char (point-min))
15235 (unless expert (org-fit-window-to-buffer))
15236 (setq rtn
15237 (catch 'exit
15238 (while t
15239 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15240 (if (not groups) "no " "")
15241 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15242 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15243 (setq org-last-tag-selection-key c)
15244 (cond
15245 ((= c ?\r) (throw 'exit t))
15246 ((= c ?!)
15247 (setq groups (not groups))
15248 (goto-char (point-min))
15249 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15250 ((= c ?\C-c)
15251 (if (not expert)
15252 (org-fast-tag-show-exit
15253 (setq exit-after-next (not exit-after-next)))
15254 (setq expert nil)
15255 (delete-other-windows)
15256 (set-window-buffer (split-window-vertically) " *Org tags*")
15257 (org-switch-to-buffer-other-window " *Org tags*")
15258 (org-fit-window-to-buffer)))
15259 ((or (= c ?\C-g)
15260 (and (= c ?q) (not (rassoc c ntable))))
15261 (org-detach-overlay org-tags-overlay)
15262 (setq quit-flag t))
15263 ((= c ?\ )
15264 (setq current nil)
15265 (when exit-after-next (setq exit-after-next 'now)))
15266 ((= c ?\t)
15267 (condition-case nil
15268 (setq tg (org-icompleting-read
15269 "Tag: "
15270 (or buffer-tags
15271 (with-current-buffer buf
15272 (org-get-buffer-tags)))))
15273 (quit (setq tg "")))
15274 (when (string-match "\\S-" tg)
15275 (add-to-list 'buffer-tags (list tg))
15276 (if (member tg current)
15277 (setq current (delete tg current))
15278 (push tg current)))
15279 (when exit-after-next (setq exit-after-next 'now)))
15280 ((setq e (rassoc c todo-table) tg (car e))
15281 (with-current-buffer buf
15282 (save-excursion (org-todo tg)))
15283 (when exit-after-next (setq exit-after-next 'now)))
15284 ((setq e (rassoc c ntable) tg (car e))
15285 (if (member tg current)
15286 (setq current (delete tg current))
15287 (loop for g in groups do
15288 (when (member tg g)
15289 (dolist (x g) (setq current (delete x current)))))
15290 (push tg current))
15291 (when exit-after-next (setq exit-after-next 'now))))
15293 ;; Create a sorted list
15294 (setq current
15295 (sort current
15296 (lambda (a b)
15297 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15298 (when (eq exit-after-next 'now) (throw 'exit t))
15299 (goto-char (point-min))
15300 (beginning-of-line 2)
15301 (delete-region (point) (point-at-eol))
15302 (org-fast-tag-insert "Current" current c-face)
15303 (org-set-current-tags-overlay current ov-prefix)
15304 (while (re-search-forward
15305 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15306 (setq tg (match-string 1))
15307 (add-text-properties
15308 (match-beginning 1) (match-end 1)
15309 (list 'face
15310 (cond
15311 ((member tg current) c-face)
15312 ((member tg inherited) i-face)
15313 (t (get-text-property (match-beginning 1) 'face))))))
15314 (goto-char (point-min)))))
15315 (org-detach-overlay org-tags-overlay)
15316 (if rtn
15317 (mapconcat 'identity current ":")
15318 nil))))
15320 (defun org-get-tags-string ()
15321 "Get the TAGS string in the current headline."
15322 (unless (org-at-heading-p t)
15323 (user-error "Not on a heading"))
15324 (save-excursion
15325 (beginning-of-line 1)
15326 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15327 (org-match-string-no-properties 1)
15328 "")))
15330 (defun org-get-tags ()
15331 "Get the list of tags specified in the current headline."
15332 (org-split-string (org-get-tags-string) ":"))
15334 (defun org-get-buffer-tags ()
15335 "Get a table of all tags used in the buffer, for completion."
15336 (org-with-wide-buffer
15337 (goto-char (point-min))
15338 (let ((tag-re (concat org-outline-regexp-bol
15339 "\\(?:.*?[ \t]\\)?"
15340 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15341 tags)
15342 (while (re-search-forward tag-re nil t)
15343 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15344 (push tag tags)))
15345 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15347 ;;;; The mapping API
15349 (defun org-map-entries (func &optional match scope &rest skip)
15350 "Call FUNC at each headline selected by MATCH in SCOPE.
15352 FUNC is a function or a lisp form. The function will be called without
15353 arguments, with the cursor positioned at the beginning of the headline.
15354 The return values of all calls to the function will be collected and
15355 returned as a list.
15357 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15358 does not need to preserve point. After evaluation, the cursor will be
15359 moved to the end of the line (presumably of the headline of the
15360 processed entry) and search continues from there. Under some
15361 circumstances, this may not produce the wanted results. For example,
15362 if you have removed (e.g. archived) the current (sub)tree it could
15363 mean that the next entry will be skipped entirely. In such cases, you
15364 can specify the position from where search should continue by making
15365 FUNC set the variable `org-map-continue-from' to the desired buffer
15366 position.
15368 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15369 Only headlines that are matched by this query will be considered during
15370 the iteration. When MATCH is nil or t, all headlines will be
15371 visited by the iteration.
15373 SCOPE determines the scope of this command. It can be any of:
15375 nil The current buffer, respecting the restriction if any
15376 tree The subtree started with the entry at point
15377 region The entries within the active region, if any
15378 region-start-level
15379 The entries within the active region, but only those at
15380 the same level than the first one.
15381 file The current buffer, without restriction
15382 file-with-archives
15383 The current buffer, and any archives associated with it
15384 agenda All agenda files
15385 agenda-with-archives
15386 All agenda files with any archive files associated with them
15387 \(file1 file2 ...)
15388 If this is a list, all files in the list will be scanned
15390 The remaining args are treated as settings for the skipping facilities of
15391 the scanner. The following items can be given here:
15393 archive skip trees with the archive tag
15394 comment skip trees with the COMMENT keyword
15395 function or Emacs Lisp form:
15396 will be used as value for `org-agenda-skip-function', so
15397 whenever the function returns a position, FUNC will not be
15398 called for that entry and search will continue from the
15399 position returned
15401 If your function needs to retrieve the tags including inherited tags
15402 at the *current* entry, you can use the value of the variable
15403 `org-scanner-tags' which will be much faster than getting the value
15404 with `org-get-tags-at'. If your function gets properties with
15405 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15406 to t around the call to `org-entry-properties' to get the same speedup.
15407 Note that if your function moves around to retrieve tags and properties at
15408 a *different* entry, you cannot use these techniques."
15409 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15410 (not (org-region-active-p)))
15411 (let* ((org-agenda-archives-mode nil) ; just to make sure
15412 (org-agenda-skip-archived-trees (memq 'archive skip))
15413 (org-agenda-skip-comment-trees (memq 'comment skip))
15414 (org-agenda-skip-function
15415 (car (org-delete-all '(comment archive) skip)))
15416 (org-tags-match-list-sublevels t)
15417 (start-level (eq scope 'region-start-level))
15418 matcher file res
15419 org-todo-keywords-for-agenda
15420 org-done-keywords-for-agenda
15421 org-todo-keyword-alist-for-agenda
15422 org-tag-alist-for-agenda
15423 todo-only)
15425 (cond
15426 ((eq match t) (setq matcher t))
15427 ((eq match nil) (setq matcher t))
15428 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15430 (save-excursion
15431 (save-restriction
15432 (cond ((eq scope 'tree)
15433 (org-back-to-heading t)
15434 (org-narrow-to-subtree)
15435 (setq scope nil))
15436 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15437 (org-region-active-p))
15438 ;; If needed, set start-level to a string like "2"
15439 (when start-level
15440 (save-excursion
15441 (goto-char (region-beginning))
15442 (unless (org-at-heading-p) (outline-next-heading))
15443 (setq start-level (org-current-level))))
15444 (narrow-to-region (region-beginning)
15445 (save-excursion
15446 (goto-char (region-end))
15447 (unless (and (bolp) (org-at-heading-p))
15448 (outline-next-heading))
15449 (point)))
15450 (setq scope nil)))
15452 (if (not scope)
15453 (progn
15454 (org-agenda-prepare-buffers
15455 (list (buffer-file-name (current-buffer))))
15456 (setq res (org-scan-tags func matcher todo-only start-level)))
15457 ;; Get the right scope
15458 (cond
15459 ((and scope (listp scope) (symbolp (car scope)))
15460 (setq scope (eval scope)))
15461 ((eq scope 'agenda)
15462 (setq scope (org-agenda-files t)))
15463 ((eq scope 'agenda-with-archives)
15464 (setq scope (org-agenda-files t))
15465 (setq scope (org-add-archive-files scope)))
15466 ((eq scope 'file)
15467 (setq scope (list (buffer-file-name))))
15468 ((eq scope 'file-with-archives)
15469 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15470 (org-agenda-prepare-buffers scope)
15471 (while (setq file (pop scope))
15472 (with-current-buffer (org-find-base-buffer-visiting file)
15473 (save-excursion
15474 (save-restriction
15475 (widen)
15476 (goto-char (point-min))
15477 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15478 res)))
15480 ;;; Properties API
15482 (defconst org-special-properties
15483 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15484 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15485 "The special properties valid in Org mode.
15486 These are properties that are not defined in the property drawer,
15487 but in some other way.")
15489 (defconst org-default-properties
15490 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15491 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15492 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15493 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15494 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15495 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15496 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15497 "Some properties that are used by Org mode for various purposes.
15498 Being in this list makes sure that they are offered for completion.")
15500 (defun org--update-property-plist (key val props)
15501 "Associate KEY to VAL in alist PROPS.
15502 Modifications are made by side-effect. Return new alist."
15503 (let* ((appending (string= (substring key -1) "+"))
15504 (key (if appending (substring key 0 -1) key))
15505 (old (assoc-string key props t)))
15506 (if (not old) (cons (cons key val) props)
15507 (setcdr old (if appending (concat (cdr old) " " val) val))
15508 props)))
15510 (defun org-get-property-block (&optional beg force)
15511 "Return the (beg . end) range of the body of the property drawer.
15512 BEG is the beginning of the current subtree, or of the part
15513 before the first headline. If it is not given, it will be found.
15514 If the drawer does not exist, create it if FORCE is non-nil, or
15515 return nil."
15516 (org-with-wide-buffer
15517 (when beg (goto-char beg))
15518 (unless (org-before-first-heading-p)
15519 (let ((beg (cond (beg)
15520 ((or (not (featurep 'org-inlinetask))
15521 (org-inlinetask-in-task-p))
15522 (org-back-to-heading t))
15523 (t (org-with-limited-levels (org-back-to-heading t))))))
15524 (forward-line)
15525 (when (org-looking-at-p org-planning-line-re) (forward-line))
15526 (cond ((looking-at org-property-drawer-re)
15527 (forward-line)
15528 (cons (point) (progn (goto-char (match-end 0))
15529 (line-beginning-position))))
15530 (force
15531 (goto-char beg)
15532 (org-insert-property-drawer)
15533 (let ((pos (save-excursion (search-forward ":END:")
15534 (line-beginning-position))))
15535 (cons pos pos))))))))
15537 (defun org-at-property-p ()
15538 "Non-nil when point is inside a property drawer.
15539 See `org-property-re' for match data, if applicable."
15540 (save-excursion
15541 (beginning-of-line)
15542 (and (looking-at org-property-re)
15543 (let ((property-drawer (save-match-data (org-get-property-block))))
15544 (and property-drawer
15545 (>= (point) (car property-drawer))
15546 (< (point) (cdr property-drawer)))))))
15548 (defun org-property-action ()
15549 "Do an action on properties."
15550 (interactive)
15551 (unless (org-at-property-p) (user-error "Not at a property"))
15552 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15553 (let ((c (read-char-exclusive)))
15554 (case c
15555 (?s (call-interactively #'org-set-property))
15556 (?d (call-interactively #'org-delete-property))
15557 (?D (call-interactively #'org-delete-property-globally))
15558 (?c (call-interactively #'org-compute-property-at-point))
15559 (otherwise (user-error "No such property action %c" c)))))
15561 (defun org-inc-effort ()
15562 "Increment the value of the effort property in the current entry."
15563 (interactive)
15564 (org-set-effort nil t))
15566 (defvar org-clock-effort) ; Defined in org-clock.el.
15567 (defvar org-clock-current-task) ; Defined in org-clock.el.
15568 (defun org-set-effort (&optional value increment)
15569 "Set the effort property of the current entry.
15570 With numerical prefix arg, use the nth allowed value, 0 stands for the
15571 10th allowed value.
15573 When INCREMENT is non-nil, set the property to the next allowed value."
15574 (interactive "P")
15575 (if (equal value 0) (setq value 10))
15576 (let* ((completion-ignore-case t)
15577 (prop org-effort-property)
15578 (cur (org-entry-get nil prop))
15579 (allowed (org-property-get-allowed-values nil prop 'table))
15580 (existing (mapcar 'list (org-property-values prop)))
15581 (heading (nth 4 (org-heading-components)))
15583 (val (cond
15584 ((stringp value) value)
15585 ((and allowed (integerp value))
15586 (or (car (nth (1- value) allowed))
15587 (car (org-last allowed))))
15588 ((and allowed increment)
15589 (or (caadr (member (list cur) allowed))
15590 (user-error "Allowed effort values are not set")))
15591 (allowed
15592 (message "Select 1-9,0, [RET%s]: %s"
15593 (if cur (concat "=" cur) "")
15594 (mapconcat 'car allowed " "))
15595 (setq rpl (read-char-exclusive))
15596 (if (equal rpl ?\r)
15598 (setq rpl (- rpl ?0))
15599 (if (equal rpl 0) (setq rpl 10))
15600 (if (and (> rpl 0) (<= rpl (length allowed)))
15601 (car (nth (1- rpl) allowed))
15602 (org-completing-read "Effort: " allowed nil))))
15604 (let (org-completion-use-ido org-completion-use-iswitchb)
15605 (org-completing-read
15606 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15607 (concat "[" cur "]") "")
15608 ": ")
15609 existing nil nil "" nil cur))))))
15610 (unless (equal (org-entry-get nil prop) val)
15611 (org-entry-put nil prop val))
15612 (org-refresh-property
15613 '((effort . identity)
15614 (effort-minutes . org-duration-string-to-minutes))
15615 val)
15616 (when (string= heading org-clock-current-task)
15617 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15618 (org-clock-update-mode-line))
15619 (message "%s is now %s" prop val)))
15621 (defun org-entry-properties (&optional pom which)
15622 "Get all properties of the current entry.
15624 When POM is a buffer position, get all properties from the entry
15625 there instead.
15627 This includes the TODO keyword, the tags, time strings for
15628 deadline, scheduled, and clocking, and any additional properties
15629 defined in the entry.
15631 If WHICH is nil or `all', get all properties. If WHICH is
15632 `special' or `standard', only get that subclass. If WHICH is
15633 a string, only get that property.
15635 Return value is an alist. Keys are properties, as upcased
15636 strings."
15637 (org-with-point-at pom
15638 (when (and (derived-mode-p 'org-mode)
15639 (ignore-errors (org-back-to-heading t)))
15640 (catch 'exit
15641 (let* ((beg (point))
15642 (specific (and (stringp which) (upcase which)))
15643 (which (cond ((not specific) which)
15644 ((member specific org-special-properties) 'special)
15645 (t 'standard)))
15646 props)
15647 ;; Get the special properties, like TODO and TAGS.
15648 (when (memq which '(nil all special))
15649 (when (or (not specific) (string= specific "CLOCKSUM"))
15650 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15651 (when clocksum
15652 (push (cons "CLOCKSUM"
15653 (org-columns-number-to-string
15654 (/ (float clocksum) 60.) 'add_times))
15655 props)))
15656 (when specific (throw 'exit props)))
15657 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15658 (let ((clocksumt (get-text-property (point)
15659 :org-clock-minutes-today)))
15660 (when clocksumt
15661 (push (cons "CLOCKSUM_T"
15662 (org-columns-number-to-string
15663 (/ (float clocksumt) 60.) 'add_times))
15664 props)))
15665 (when specific (throw 'exit props)))
15666 (when (or (not specific) (string= specific "ITEM"))
15667 (when (looking-at org-complex-heading-regexp)
15668 (push (cons "ITEM"
15669 (concat
15670 (org-match-string-no-properties 1)
15671 (let ((title (org-match-string-no-properties 4)))
15672 (when (org-string-nw-p title)
15673 (concat " " (org-remove-tabs title))))))
15674 props))
15675 (when specific (throw 'exit props)))
15676 (when (or (not specific) (string= specific "TODO"))
15677 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15678 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15679 (when specific (throw 'exit props)))
15680 (when (or (not specific) (string= specific "PRIORITY"))
15681 (when (looking-at org-priority-regexp)
15682 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15683 (when specific (throw 'exit props)))
15684 (when (or (not specific) (string= specific "FILE"))
15685 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15686 props)
15687 (when specific (throw 'exit props)))
15688 (when (or (not specific) (string= specific "TAGS"))
15689 (let ((value (org-string-nw-p (org-get-tags-string))))
15690 (when value (push (cons "TAGS" value) props)))
15691 (when specific (throw 'exit props)))
15692 (when (or (not specific) (string= specific "ALLTAGS"))
15693 (let ((value (org-get-tags-at)))
15694 (when value
15695 (push (cons "ALLTAGS"
15696 (format ":%s:" (mapconcat #'identity value ":")))
15697 props)))
15698 (when specific (throw 'exit props)))
15699 (when (or (not specific) (string= specific "BLOCKED"))
15700 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15701 (when specific (throw 'exit props)))
15702 (when (or (not specific)
15703 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15704 (forward-line)
15705 (when (org-looking-at-p org-planning-line-re)
15706 (end-of-line)
15707 (let ((bol (line-beginning-position))
15708 ;; Backward compatibility: time keywords used to
15709 ;; be configurable (before 8.3). Make sure we
15710 ;; get the correct keyword.
15711 (key-assoc `(("CLOSED" . ,org-closed-string)
15712 ("DEADLINE" . ,org-deadline-string)
15713 ("SCHEDULED" . ,org-scheduled-string))))
15714 (dolist (pair (if specific (list (assoc specific key-assoc))
15715 key-assoc))
15716 (save-excursion
15717 (when (search-backward (cdr pair) bol t)
15718 (goto-char (match-end 0))
15719 (skip-chars-forward " \t")
15720 (and (looking-at org-ts-regexp-both)
15721 (push (cons (car pair)
15722 (org-match-string-no-properties 0))
15723 props)))))))
15724 (when specific (throw 'exit props)))
15725 (when (or (not specific)
15726 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15727 (let ((find-ts
15728 (lambda (end ts)
15729 (let ((regexp (if (or (string= specific "TIMESTAMP")
15730 (assoc "TIMESTAMP_IA" ts))
15731 org-ts-regexp
15732 org-ts-regexp-both)))
15733 (catch 'next
15734 (while (re-search-forward regexp end t)
15735 (backward-char)
15736 (let ((object (org-element-context)))
15737 ;; Accept to match timestamps in node
15738 ;; properties, too.
15739 (when (memq (org-element-type object)
15740 '(node-property timestamp))
15741 (let ((type
15742 (org-element-property :type object)))
15743 (cond
15744 ((and (memq type '(active active-range))
15745 (not (equal specific "TIMESTAMP_IA")))
15746 (unless (assoc "TIMESTAMP" ts)
15747 (push (cons "TIMESTAMP"
15748 (org-element-property
15749 :raw-value object))
15751 (when specific (throw 'exit ts))))
15752 ((and (memq type '(inactive inactive-range))
15753 (not (string= specific "TIMESTAMP")))
15754 (unless (assoc "TIMESTAMP_IA" ts)
15755 (push (cons "TIMESTAMP_IA"
15756 (org-element-property
15757 :raw-value object))
15759 (when specific (throw 'exit ts))))))
15760 ;; Both timestamp types are found,
15761 ;; move to next part.
15762 (when (= (length ts) 2) (throw 'next ts)))))
15763 ts)))))
15764 (goto-char beg)
15765 ;; First look for timestamps within headline.
15766 (let ((ts (funcall find-ts (line-end-position) nil)))
15767 (if (= (length ts) 2) (setq props (nconc ts props))
15768 (forward-line)
15769 ;; Then find timestamps in the section, skipping
15770 ;; planning line.
15771 (when (org-looking-at-p org-planning-line-re)
15772 (forward-line))
15773 (let ((end (save-excursion (outline-next-heading))))
15774 (setq props (nconc (funcall find-ts end ts) props))))))))
15775 ;; Get the standard properties, like :PROP:.
15776 (when (memq which '(nil all standard))
15777 ;; If we are looking after a specific property, delegate
15778 ;; to `org-entry-get', which is faster. However, make an
15779 ;; exception for "CATEGORY", since it can be also set
15780 ;; through keywords (i.e. #+CATEGORY).
15781 (if (and specific (not (equal specific "CATEGORY")))
15782 (let ((value (org-entry-get beg specific nil t)))
15783 (throw 'exit (and value (list (cons specific value)))))
15784 (let ((range (org-get-property-block beg)))
15785 (when range
15786 (let ((end (cdr range)) seen-base)
15787 (goto-char (car range))
15788 ;; Unlike to `org--update-property-plist', we
15789 ;; handle the case where base values is found
15790 ;; after its extension. We also forbid standard
15791 ;; properties to be named as special properties.
15792 (while (re-search-forward org-property-re end t)
15793 (let* ((key (upcase (org-match-string-no-properties 2)))
15794 (extendp (org-string-match-p "\\+\\'" key))
15795 (key-base (if extendp (substring key 0 -1) key))
15796 (value (org-match-string-no-properties 3)))
15797 (cond
15798 ((member-ignore-case key-base org-special-properties))
15799 (extendp
15800 (setq props
15801 (org--update-property-plist key value props)))
15802 ((member key seen-base))
15803 (t (push key seen-base)
15804 (let ((p (assoc-string key props t)))
15805 (if p (setcdr p (concat value " " (cdr p)))
15806 (push (cons key value) props))))))))))))
15807 (unless (assoc "CATEGORY" props)
15808 (push (cons "CATEGORY" (org-get-category beg)) props)
15809 (when (string= specific "CATEGORY") (throw 'exit props)))
15810 ;; Return value.
15811 (append (get-text-property beg 'org-summaries) props))))))
15813 (defun org-entry-get (pom property &optional inherit literal-nil)
15814 "Get value of PROPERTY for entry or content at point-or-marker POM.
15816 If INHERIT is non-nil and the entry does not have the property,
15817 then also check higher levels of the hierarchy. If INHERIT is
15818 the symbol `selective', use inheritance only if the setting in
15819 `org-use-property-inheritance' selects PROPERTY for inheritance.
15821 If the property is present but empty, the return value is the
15822 empty string. If the property is not present at all, nil is
15823 returned. In any other case, return the value as a string.
15824 Search is case-insensitive.
15826 If LITERAL-NIL is set, return the string value \"nil\" as
15827 a string, do not interpret it as the list atom nil. This is used
15828 for inheritance when a \"nil\" value can supersede a non-nil
15829 value higher up the hierarchy."
15830 (org-with-point-at pom
15831 (cond
15832 ((and inherit
15833 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15834 (org-entry-get-with-inheritance property literal-nil))
15835 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15836 ;; We need a special property. Use `org-entry-properties' to
15837 ;; retrieve it, but specify the wanted property.
15838 (cdr (assoc-string property (org-entry-properties nil property))))
15840 (let ((range (org-get-property-block)))
15841 (when range
15842 (let* ((case-fold-search t)
15843 (end (cdr range))
15844 (props
15845 (let ((global
15846 (or (assoc-string property org-file-properties t)
15847 (assoc-string property org-global-properties t)
15848 (assoc-string
15849 property org-global-properties-fixed t))))
15850 ;; Make sure to not re-use GLOBAL as
15851 ;; `org--update-property-plist' would alter it by
15852 ;; side-effect.
15853 (and global (list (cons property (cdr global))))))
15854 (find-value
15855 (lambda (key)
15856 (when (re-search-forward (org-re-property key nil t) end t)
15857 (setq props
15858 (org--update-property-plist
15859 key (org-match-string-no-properties 3) props))))))
15860 (goto-char (car range))
15861 ;; Find base value.
15862 (save-excursion (funcall find-value property))
15863 ;; Find additional values.
15864 (let ((property+ (concat property "+")))
15865 (while (funcall find-value property+)))
15866 ;; Return final value.
15867 (let ((val (cdr (assoc-string property props t))))
15868 (if literal-nil val (org-not-nil val))))))))))
15870 (defun org-property-or-variable-value (var &optional inherit)
15871 "Check if there is a property fixing the value of VAR.
15872 If yes, return this value. If not, return the current value of the variable."
15873 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15874 (if (and prop (stringp prop) (string-match "\\S-" prop))
15875 (read prop)
15876 (symbol-value var))))
15878 (defun org-entry-delete (pom property)
15879 "Delete PROPERTY from entry at point-or-marker POM.
15880 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15881 non-nil when a property was removed."
15882 (unless (member property org-special-properties)
15883 (org-with-point-at pom
15884 (let ((range (org-get-property-block)))
15885 (when range
15886 (let* ((begin (car range))
15887 (origin (cdr range))
15888 (end (copy-marker origin))
15889 (re (org-re-property
15890 (concat (regexp-quote property) "\\+?") t t)))
15891 (goto-char begin)
15892 (while (re-search-forward re end t)
15893 (delete-region (match-beginning 0) (line-beginning-position 2)))
15894 ;; If drawer is empty, remove it altogether.
15895 (when (= begin end)
15896 (delete-region (line-beginning-position 0)
15897 (line-beginning-position 2)))
15898 ;; Return non-nil if some property was removed.
15899 (prog1 (/= end origin) (set-marker end nil))))))))
15901 ;; Multi-values properties are properties that contain multiple values
15902 ;; These values are assumed to be single words, separated by whitespace.
15903 (defun org-entry-add-to-multivalued-property (pom property value)
15904 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15905 (let* ((old (org-entry-get pom property))
15906 (values (and old (org-split-string old "[ \t]"))))
15907 (setq value (org-entry-protect-space value))
15908 (unless (member value values)
15909 (setq values (append values (list value)))
15910 (org-entry-put pom property
15911 (mapconcat 'identity values " ")))))
15913 (defun org-entry-remove-from-multivalued-property (pom property value)
15914 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15915 (let* ((old (org-entry-get pom property))
15916 (values (and old (org-split-string old "[ \t]"))))
15917 (setq value (org-entry-protect-space value))
15918 (when (member value values)
15919 (setq values (delete value values))
15920 (org-entry-put pom property
15921 (mapconcat 'identity values " ")))))
15923 (defun org-entry-member-in-multivalued-property (pom property value)
15924 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15925 (let* ((old (org-entry-get pom property))
15926 (values (and old (org-split-string old "[ \t]"))))
15927 (setq value (org-entry-protect-space value))
15928 (member value values)))
15930 (defun org-entry-get-multivalued-property (pom property)
15931 "Return a list of values in a multivalued property."
15932 (let* ((value (org-entry-get pom property))
15933 (values (and value (org-split-string value "[ \t]"))))
15934 (mapcar 'org-entry-restore-space values)))
15936 (defun org-entry-put-multivalued-property (pom property &rest values)
15937 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15938 VALUES should be a list of strings. Spaces will be protected."
15939 (org-entry-put pom property
15940 (mapconcat 'org-entry-protect-space values " "))
15941 (let* ((value (org-entry-get pom property))
15942 (values (and value (org-split-string value "[ \t]"))))
15943 (mapcar 'org-entry-restore-space values)))
15945 (defun org-entry-protect-space (s)
15946 "Protect spaces and newline in string S."
15947 (while (string-match " " s)
15948 (setq s (replace-match "%20" t t s)))
15949 (while (string-match "\n" s)
15950 (setq s (replace-match "%0A" t t s)))
15953 (defun org-entry-restore-space (s)
15954 "Restore spaces and newline in string S."
15955 (while (string-match "%20" s)
15956 (setq s (replace-match " " t t s)))
15957 (while (string-match "%0A" s)
15958 (setq s (replace-match "\n" t t s)))
15961 (defvar org-entry-property-inherited-from (make-marker)
15962 "Marker pointing to the entry from where a property was inherited.
15963 Each call to `org-entry-get-with-inheritance' will set this marker to the
15964 location of the entry where the inheritance search matched. If there was
15965 no match, the marker will point nowhere.
15966 Note that also `org-entry-get' calls this function, if the INHERIT flag
15967 is set.")
15969 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15970 "Get PROPERTY of entry or content at point, search higher levels if needed.
15971 The search will stop at the first ancestor which has the property defined.
15972 If the value found is \"nil\", return nil to show that the property
15973 should be considered as undefined (this is the meaning of nil here).
15974 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15975 (move-marker org-entry-property-inherited-from nil)
15976 (let (value)
15977 (org-with-wide-buffer
15978 (catch 'exit
15979 (while t
15980 (when (setq value (org-entry-get nil property nil literal-nil))
15981 (org-back-to-heading t)
15982 (move-marker org-entry-property-inherited-from (point))
15983 (throw 'exit nil))
15984 (or (org-up-heading-safe) (throw 'exit nil)))))
15985 (unless value
15986 (setq value
15987 (cdr (or (assoc-string property org-file-properties t)
15988 (assoc-string property org-global-properties t)
15989 (assoc-string property org-global-properties-fixed t)))))
15990 (if literal-nil value (org-not-nil value))))
15992 (defvar org-property-changed-functions nil
15993 "Hook called when the value of a property has changed.
15994 Each hook function should accept two arguments, the name of the property
15995 and the new value.")
15997 (defun org-entry-put (pom property value)
15998 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16000 If the value is `nil', it is converted to the empty string. If
16001 it is not a string, an error is raised.
16003 PROPERTY can be any regular property (see
16004 `org-special-properties'). It can also be \"TODO\",
16005 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16007 For the last two properties, VALUE may have any of the special
16008 values \"earlier\" and \"later\". The function then increases or
16009 decreases scheduled or deadline date by one day."
16010 (cond ((null value) (setq value ""))
16011 ((not (stringp value)) (error "Properties values should be strings")))
16012 (org-with-point-at pom
16013 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16014 (org-back-to-heading t)
16015 (org-with-limited-levels (org-back-to-heading t)))
16016 (let ((beg (point)))
16017 (cond
16018 ((equal property "TODO")
16019 (cond ((not (org-string-nw-p value)) (setq value 'none))
16020 ((not (member value org-todo-keywords-1))
16021 (user-error "\"%s\" is not a valid TODO state" value)))
16022 (org-todo value)
16023 (org-set-tags nil 'align))
16024 ((equal property "PRIORITY")
16025 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16026 (org-set-tags nil 'align))
16027 ((equal property "SCHEDULED")
16028 (forward-line)
16029 (if (and (org-looking-at-p org-planning-line-re)
16030 (re-search-forward
16031 org-scheduled-time-regexp (line-end-position) t))
16032 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16033 ((string= value "later") (org-timestamp-change 1 'day))
16034 ((string= value "") (org-schedule '(4)))
16035 (t (org-schedule nil value)))
16036 (if (member value '("earlier" "later" ""))
16037 (call-interactively #'org-schedule)
16038 (org-schedule nil value))))
16039 ((equal property "DEADLINE")
16040 (forward-line)
16041 (if (and (org-looking-at-p org-planning-line-re)
16042 (re-search-forward
16043 org-deadline-time-regexp (line-end-position) t))
16044 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16045 ((string= value "later") (org-timestamp-change 1 'day))
16046 ((string= value "") (org-deadline '(4)))
16047 (t (org-deadline nil value)))
16048 (if (member value '("earlier" "later" ""))
16049 (call-interactively #'org-deadline)
16050 (org-deadline nil value))))
16051 ((member property org-special-properties)
16052 (error "The %s property cannot be set with `org-entry-put'" property))
16054 (let* ((range (org-get-property-block beg 'force))
16055 (end (cdr range))
16056 (case-fold-search t))
16057 (goto-char (car range))
16058 (if (re-search-forward (org-re-property property nil t) end t)
16059 (progn (delete-region (match-beginning 0) (match-end 0))
16060 (goto-char (match-beginning 0)))
16061 (goto-char end)
16062 (insert "\n")
16063 (backward-char))
16064 (insert ":" property ":")
16065 (when value (insert " " value))
16066 (org-indent-line)))))
16067 (run-hook-with-args 'org-property-changed-functions property value)))
16069 (defun org-buffer-property-keys (&optional specials defaults columns)
16070 "Get all property keys in the current buffer.
16072 When SPECIALS is non-nil, also list the special properties that
16073 reflect things like tags and TODO state.
16075 When DEFAULTS is non-nil, also include properties that has
16076 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16077 DESCRIPTION, LOCATION, and LOGGING and others.
16079 When COLUMNS in non-nil, also include property names given in
16080 COLUMN formats in the current buffer."
16081 (let ((case-fold-search t)
16082 (props (append
16083 (and specials org-special-properties)
16084 (and defaults (cons org-effort-property org-default-properties))
16085 nil)))
16086 (org-with-wide-buffer
16087 (goto-char (point-min))
16088 (while (re-search-forward org-property-start-re nil t)
16089 (let ((range (org-get-property-block)))
16090 (catch 'skip
16091 (unless range
16092 (when (and (not (org-before-first-heading-p))
16093 (y-or-n-p (format "Malformed drawer at %d, repair?"
16094 (line-beginning-position))))
16095 (org-get-property-block nil t))
16096 (throw 'skip nil))
16097 (goto-char (car range))
16098 (let ((begin (car range))
16099 (end (cdr range)))
16100 ;; Make sure that found property block is not located
16101 ;; before current point, as it would generate an infloop.
16102 ;; It can happen, for example, in the following
16103 ;; situation:
16105 ;; * Headline
16106 ;; :PROPERTIES:
16107 ;; ...
16108 ;; :END:
16109 ;; *************** Inlinetask
16110 ;; #+BEGIN_EXAMPLE
16111 ;; :PROPERTIES:
16112 ;; #+END_EXAMPLE
16114 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16115 (while (< (point) end)
16116 (let ((p (progn (looking-at org-property-re)
16117 (org-match-string-no-properties 2))))
16118 ;; Only add true property name, not extension symbol.
16119 (add-to-list 'props
16120 (if (not (org-string-match-p "\\+\\'" p)) p
16121 (substring p 0 -1))))
16122 (forward-line))))
16123 (outline-next-heading)))
16124 (when columns
16125 (goto-char (point-min))
16126 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16127 (let ((element (org-element-at-point)))
16128 (when (memq (org-element-type element) '(keyword node-property))
16129 (let ((value (org-element-property :value element))
16130 (start 0))
16131 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16132 (setq start (match-end 0))
16133 (let ((p (org-match-string-no-properties 1 value)))
16134 (unless (member-ignore-case p org-special-properties)
16135 (add-to-list 'props p))))))))))
16136 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16138 (defun org-property-values (key)
16139 "List all non-nil values of property KEY in current buffer."
16140 (org-with-wide-buffer
16141 (goto-char (point-min))
16142 (let ((case-fold-search t)
16143 (re (org-re-property key))
16144 values)
16145 (while (re-search-forward re nil t)
16146 (add-to-list 'values (org-entry-get (point) key)))
16147 values)))
16149 (defun org-insert-property-drawer ()
16150 "Insert a property drawer into the current entry."
16151 (org-with-wide-buffer
16152 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16153 (org-back-to-heading t)
16154 (org-with-limited-levels (org-back-to-heading t)))
16155 (forward-line)
16156 (when (org-looking-at-p org-planning-line-re) (forward-line))
16157 (unless (org-looking-at-p org-property-drawer-re)
16158 (let ((inhibit-read-only t))
16159 (unless (bolp) (insert "\n"))
16160 (let ((begin (point)))
16161 (insert ":PROPERTIES:\n:END:\n")
16162 (org-indent-region begin (point)))))))
16164 (defun org-insert-drawer (&optional arg drawer)
16165 "Insert a drawer at point.
16167 When optional argument ARG is non-nil, insert a property drawer.
16169 Optional argument DRAWER, when non-nil, is a string representing
16170 drawer's name. Otherwise, the user is prompted for a name.
16172 If a region is active, insert the drawer around that region
16173 instead.
16175 Point is left between drawer's boundaries."
16176 (interactive "P")
16177 (let* ((drawer (if arg "PROPERTIES"
16178 (or drawer (read-from-minibuffer "Drawer: ")))))
16179 (cond
16180 ;; With C-u, fall back on `org-insert-property-drawer'
16181 (arg (org-insert-property-drawer))
16182 ;; Check validity of suggested drawer's name.
16183 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16184 (user-error "Invalid drawer name"))
16185 ;; With an active region, insert a drawer at point.
16186 ((not (org-region-active-p))
16187 (progn
16188 (unless (bolp) (insert "\n"))
16189 (insert (format ":%s:\n\n:END:\n" drawer))
16190 (forward-line -2)))
16191 ;; Otherwise, insert the drawer at point
16193 (let ((rbeg (region-beginning))
16194 (rend (copy-marker (region-end))))
16195 (unwind-protect
16196 (progn
16197 (goto-char rbeg)
16198 (beginning-of-line)
16199 (when (save-excursion
16200 (re-search-forward org-outline-regexp-bol rend t))
16201 (user-error "Drawers cannot contain headlines"))
16202 ;; Position point at the beginning of the first
16203 ;; non-blank line in region. Insert drawer's opening
16204 ;; there, then indent it.
16205 (org-skip-whitespace)
16206 (beginning-of-line)
16207 (insert ":" drawer ":\n")
16208 (forward-line -1)
16209 (indent-for-tab-command)
16210 ;; Move point to the beginning of the first blank line
16211 ;; after the last non-blank line in region. Insert
16212 ;; drawer's closing, then indent it.
16213 (goto-char rend)
16214 (skip-chars-backward " \r\t\n")
16215 (insert "\n:END:")
16216 (deactivate-mark t)
16217 (indent-for-tab-command)
16218 (unless (eolp) (insert "\n")))
16219 ;; Clear marker, whatever the outcome of insertion is.
16220 (set-marker rend nil)))))))
16222 (defvar org-property-set-functions-alist nil
16223 "Property set function alist.
16224 Each entry should have the following format:
16226 (PROPERTY . READ-FUNCTION)
16228 The read function will be called with the same argument as
16229 `org-completing-read'.")
16231 (defun org-set-property-function (property)
16232 "Get the function that should be used to set PROPERTY.
16233 This is computed according to `org-property-set-functions-alist'."
16234 (or (cdr (assoc property org-property-set-functions-alist))
16235 'org-completing-read))
16237 (defun org-read-property-value (property)
16238 "Read PROPERTY value from user."
16239 (let* ((completion-ignore-case t)
16240 (allowed (org-property-get-allowed-values nil property 'table))
16241 (cur (org-entry-get nil property))
16242 (prompt (concat property " value"
16243 (if (and cur (string-match "\\S-" cur))
16244 (concat " [" cur "]") "") ": "))
16245 (set-function (org-set-property-function property))
16246 (val (if allowed
16247 (funcall set-function prompt allowed nil
16248 (not (get-text-property 0 'org-unrestricted
16249 (caar allowed))))
16250 (let (org-completion-use-ido org-completion-use-iswitchb)
16251 (funcall set-function prompt
16252 (mapcar 'list (org-property-values property))
16253 nil nil "" nil cur)))))
16254 (org-trim val)))
16256 (defvar org-last-set-property nil)
16257 (defvar org-last-set-property-value nil)
16258 (defun org-read-property-name ()
16259 "Read a property name."
16260 (let ((completion-ignore-case t)
16261 (default-prop (or (and (org-at-property-p)
16262 (org-match-string-no-properties 2))
16263 org-last-set-property)))
16264 (org-completing-read
16265 (concat "Property"
16266 (if default-prop (concat " [" default-prop "]") "")
16267 ": ")
16268 (mapcar #'list (org-buffer-property-keys nil t t))
16269 nil nil nil nil default-prop)))
16271 (defun org-set-property-and-value (use-last)
16272 "Allow to set [PROPERTY]: [value] direction from prompt.
16273 When use-default, don't even ask, just use the last
16274 \"[PROPERTY]: [value]\" string from the history."
16275 (interactive "P")
16276 (let* ((completion-ignore-case t)
16277 (pv (or (and use-last org-last-set-property-value)
16278 (org-completing-read
16279 "Enter a \"[Property]: [value]\" pair: "
16280 nil nil nil nil nil
16281 org-last-set-property-value)))
16282 prop val)
16283 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16284 (setq prop (match-string 1 pv)
16285 val (match-string 2 pv))
16286 (org-set-property prop val))))
16288 (defun org-set-property (property value)
16289 "In the current entry, set PROPERTY to VALUE.
16290 When called interactively, this will prompt for a property name, offering
16291 completion on existing and default properties. And then it will prompt
16292 for a value, offering completion either on allowed values (via an inherited
16293 xxx_ALL property) or on existing values in other instances of this property
16294 in the current file."
16295 (interactive (list nil nil))
16296 (let* ((property (or property (org-read-property-name)))
16297 (value (or value (org-read-property-value property)))
16298 (fn (cdr (assoc property org-properties-postprocess-alist))))
16299 (setq org-last-set-property property)
16300 (setq org-last-set-property-value (concat property ": " value))
16301 ;; Possibly postprocess the inserted value:
16302 (when fn (setq value (funcall fn value)))
16303 (unless (equal (org-entry-get nil property) value)
16304 (org-entry-put nil property value))))
16306 (defun org-find-property (property &optional value)
16307 "Find first entry in buffer that sets PROPERTY.
16309 When optional argument VALUE is non-nil, only consider an entry
16310 if it contains PROPERTY set to this value. If PROPERTY should be
16311 explicitly set to nil, use string \"nil\" for VALUE.
16313 Return position where the entry begins, or nil if there is no
16314 such entry. If narrowing is in effect, only search the visible
16315 part of the buffer."
16316 (save-excursion
16317 (goto-char (point-min))
16318 (let ((case-fold-search t)
16319 (re (org-re-property property nil (not value) value)))
16320 (catch 'exit
16321 (while (re-search-forward re nil t)
16322 (when (if value (org-at-property-p)
16323 (org-entry-get (point) property nil t))
16324 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16326 (defun org-delete-property (property)
16327 "In the current entry, delete PROPERTY."
16328 (interactive
16329 (let* ((completion-ignore-case t)
16330 (cat (org-entry-get (point) "CATEGORY"))
16331 (props0 (org-entry-properties nil 'standard))
16332 (props (if cat props0
16333 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16334 (prop (if (< 1 (length props))
16335 (org-icompleting-read "Property: " props nil t)
16336 (caar props))))
16337 (list prop)))
16338 (if (not property)
16339 (message "No property to delete in this entry")
16340 (org-entry-delete nil property)
16341 (message "Property \"%s\" deleted" property)))
16343 (defun org-delete-property-globally (property)
16344 "Remove PROPERTY globally, from all entries.
16345 This function ignores narrowing, if any."
16346 (interactive
16347 (let* ((completion-ignore-case t)
16348 (prop (org-icompleting-read
16349 "Globally remove property: "
16350 (mapcar #'list (org-buffer-property-keys)))))
16351 (list prop)))
16352 (org-with-wide-buffer
16353 (goto-char (point-min))
16354 (let ((count 0)
16355 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16356 (while (re-search-forward re nil t)
16357 (when (org-entry-delete (point) property) (incf count)))
16358 (message "Property \"%s\" removed from %d entries" property count))))
16360 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16362 (defun org-compute-property-at-point ()
16363 "Compute the property at point.
16364 This looks for an enclosing column format, extracts the operator and
16365 then applies it to the property in the column format's scope."
16366 (interactive)
16367 (unless (org-at-property-p)
16368 (user-error "Not at a property"))
16369 (let ((prop (org-match-string-no-properties 2)))
16370 (org-columns-get-format-and-top-level)
16371 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16372 (user-error "No operator defined for property %s" prop))
16373 (org-columns-compute prop)))
16375 (defvar org-property-allowed-value-functions nil
16376 "Hook for functions supplying allowed values for a specific property.
16377 The functions must take a single argument, the name of the property, and
16378 return a flat list of allowed values. If \":ETC\" is one of
16379 the values, this means that these values are intended as defaults for
16380 completion, but that other values should be allowed too.
16381 The functions must return nil if they are not responsible for this
16382 property.")
16384 (defun org-property-get-allowed-values (pom property &optional table)
16385 "Get allowed values for the property PROPERTY.
16386 When TABLE is non-nil, return an alist that can directly be used for
16387 completion."
16388 (let (vals)
16389 (cond
16390 ((equal property "TODO")
16391 (setq vals (org-with-point-at pom
16392 (append org-todo-keywords-1 '("")))))
16393 ((equal property "PRIORITY")
16394 (let ((n org-lowest-priority))
16395 (while (>= n org-highest-priority)
16396 (push (char-to-string n) vals)
16397 (setq n (1- n)))))
16398 ((equal property "CATEGORY"))
16399 ((member property org-special-properties))
16400 ((setq vals (run-hook-with-args-until-success
16401 'org-property-allowed-value-functions property)))
16403 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16404 (when (and vals (string-match "\\S-" vals))
16405 (setq vals (car (read-from-string (concat "(" vals ")"))))
16406 (setq vals (mapcar (lambda (x)
16407 (cond ((stringp x) x)
16408 ((numberp x) (number-to-string x))
16409 ((symbolp x) (symbol-name x))
16410 (t "???")))
16411 vals)))))
16412 (when (member ":ETC" vals)
16413 (setq vals (remove ":ETC" vals))
16414 (org-add-props (car vals) '(org-unrestricted t)))
16415 (if table (mapcar 'list vals) vals)))
16417 (defun org-property-previous-allowed-value (&optional previous)
16418 "Switch to the next allowed value for this property."
16419 (interactive)
16420 (org-property-next-allowed-value t))
16422 (defun org-property-next-allowed-value (&optional previous)
16423 "Switch to the next allowed value for this property."
16424 (interactive)
16425 (unless (org-at-property-p)
16426 (user-error "Not at a property"))
16427 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16428 (key (match-string 2))
16429 (value (match-string 3))
16430 (allowed (or (org-property-get-allowed-values (point) key)
16431 (and (member value '("[ ]" "[-]" "[X]"))
16432 '("[ ]" "[X]"))))
16433 (heading (save-match-data (nth 4 (org-heading-components))))
16434 nval)
16435 (unless allowed
16436 (user-error "Allowed values for this property have not been defined"))
16437 (if previous (setq allowed (reverse allowed)))
16438 (if (member value allowed)
16439 (setq nval (car (cdr (member value allowed)))))
16440 (setq nval (or nval (car allowed)))
16441 (if (equal nval value)
16442 (user-error "Only one allowed value for this property"))
16443 (org-at-property-p)
16444 (replace-match (concat " :" key ": " nval) t t)
16445 (org-indent-line)
16446 (beginning-of-line 1)
16447 (skip-chars-forward " \t")
16448 (when (equal prop org-effort-property)
16449 (org-refresh-property
16450 '((effort . identity)
16451 (effort-minutes . org-duration-string-to-minutes))
16452 nval)
16453 (when (string= org-clock-current-task heading)
16454 (setq org-clock-effort nval)
16455 (org-clock-update-mode-line)))
16456 (run-hook-with-args 'org-property-changed-functions key nval)))
16458 (defun org-find-olp (path &optional this-buffer)
16459 "Return a marker pointing to the entry at outline path OLP.
16460 If anything goes wrong, throw an error.
16461 You can wrap this call to catch the error like this:
16463 (condition-case msg
16464 (org-mobile-locate-entry (match-string 4))
16465 (error (nth 1 msg)))
16467 The return value will then be either a string with the error message,
16468 or a marker if everything is OK.
16470 If THIS-BUFFER is set, the outline path does not contain a file,
16471 only headings."
16472 (let* ((file (if this-buffer buffer-file-name (pop path)))
16473 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16474 (level 1)
16475 (lmin 1)
16476 (lmax 1)
16477 limit re end found pos heading cnt flevel)
16478 (unless buffer (error "File not found :%s" file))
16479 (with-current-buffer buffer
16480 (save-excursion
16481 (save-restriction
16482 (widen)
16483 (setq limit (point-max))
16484 (goto-char (point-min))
16485 (while (setq heading (pop path))
16486 (setq re (format org-complex-heading-regexp-format
16487 (regexp-quote heading)))
16488 (setq cnt 0 pos (point))
16489 (while (re-search-forward re end t)
16490 (setq level (- (match-end 1) (match-beginning 1)))
16491 (if (and (>= level lmin) (<= level lmax))
16492 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16493 (when (= cnt 0) (error "Heading not found on level %d: %s"
16494 lmax heading))
16495 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16496 lmax heading))
16497 (goto-char found)
16498 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16499 (setq end (save-excursion (org-end-of-subtree t t))))
16500 (when (org-at-heading-p)
16501 (point-marker)))))))
16503 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16504 "Find node HEADING in BUFFER.
16505 Return a marker to the heading if it was found, or nil if not.
16506 If POS-ONLY is set, return just the position instead of a marker.
16508 The heading text must match exact, but it may have a TODO keyword,
16509 a priority cookie and tags in the standard locations."
16510 (with-current-buffer (or buffer (current-buffer))
16511 (save-excursion
16512 (save-restriction
16513 (widen)
16514 (goto-char (point-min))
16515 (let (case-fold-search)
16516 (if (re-search-forward
16517 (format org-complex-heading-regexp-format
16518 (regexp-quote heading)) nil t)
16519 (if pos-only
16520 (match-beginning 0)
16521 (move-marker (make-marker) (match-beginning 0)))))))))
16523 (defun org-find-exact-heading-in-directory (heading &optional dir)
16524 "Find Org node headline HEADING in all .org files in directory DIR.
16525 When the target headline is found, return a marker to this location."
16526 (let ((files (directory-files (or dir default-directory)
16527 t "\\`[^.#].*\\.org\\'"))
16528 file visiting m buffer)
16529 (catch 'found
16530 (while (setq file (pop files))
16531 (message "trying %s" file)
16532 (setq visiting (org-find-base-buffer-visiting file))
16533 (setq buffer (or visiting (find-file-noselect file)))
16534 (setq m (org-find-exact-headline-in-buffer
16535 heading buffer))
16536 (when (and (not m) (not visiting)) (kill-buffer buffer))
16537 (and m (throw 'found m))))))
16539 (defun org-find-entry-with-id (ident)
16540 "Locate the entry that contains the ID property with exact value IDENT.
16541 IDENT can be a string, a symbol or a number, this function will search for
16542 the string representation of it.
16543 Return the position where this entry starts, or nil if there is no such entry."
16544 (interactive "sID: ")
16545 (let ((id (cond
16546 ((stringp ident) ident)
16547 ((symbolp ident) (symbol-name ident))
16548 ((numberp ident) (number-to-string ident))
16549 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16550 (org-with-wide-buffer (org-find-property "ID" id))))
16552 ;;;; Timestamps
16554 (defvar org-last-changed-timestamp nil)
16555 (defvar org-last-inserted-timestamp nil
16556 "The last time stamp inserted with `org-insert-time-stamp'.")
16557 (defvar org-ts-what) ; dynamically scoped parameter
16559 (defun org-time-stamp (arg &optional inactive)
16560 "Prompt for a date/time and insert a time stamp.
16562 If the user specifies a time like HH:MM or if this command is
16563 called with at least one prefix argument, the time stamp contains
16564 the date and the time. Otherwise, only the date is included.
16566 All parts of a date not specified by the user are filled in from
16567 the timestamp at point, if any, or the current date/time
16568 otherwise.
16570 If there is already a timestamp at the cursor, it is replaced.
16572 With two universal prefix arguments, insert an active timestamp
16573 with the current time without prompting the user.
16575 When called from lisp, the timestamp is inactive if INACTIVE is
16576 non-nil."
16577 (interactive "P")
16578 (let* ((ts
16579 (cond ((org-at-date-range-p t)
16580 (save-excursion
16581 (goto-char (match-beginning 0))
16582 (looking-at (if inactive org-ts-regexp-both org-ts-regexp)))
16583 (match-string 0))
16584 ((org-at-timestamp-p t) (match-string 0))))
16585 ;; Default time is either the timestamp at point or today.
16586 ;; When entering a range, only the range start is considered.
16587 (default-time (if (not ts) (current-time)
16588 (apply #'encode-time (org-parse-time-string ts))))
16589 (default-input (and ts (org-get-compact-tod ts)))
16590 (repeater (and ts
16591 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16592 (match-string 0 ts)))
16593 org-time-was-given
16594 org-end-time-was-given
16595 (time
16596 (and (if (equal arg '(16)) (current-time)
16597 ;; Preserve `this-command' and `last-command'.
16598 (let ((this-command this-command)
16599 (last-command last-command))
16600 (org-read-date
16601 arg 'totime nil nil default-time default-input
16602 inactive))))))
16603 (cond
16604 ((and ts
16605 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16606 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16607 (insert "--")
16608 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16610 ;; Make sure we're on a timestamp. When in the middle of a date
16611 ;; range, move arbitrarily to range end.
16612 (unless (org-at-timestamp-p t)
16613 (skip-chars-forward "-")
16614 (org-at-timestamp-p t))
16615 (replace-match "")
16616 (setq org-last-changed-timestamp
16617 (org-insert-time-stamp
16618 time (or org-time-was-given arg)
16619 inactive nil nil (list org-end-time-was-given)))
16620 (when repeater
16621 (backward-char)
16622 (insert " " repeater)
16623 (setq org-last-changed-timestamp
16624 (concat (substring org-last-inserted-timestamp 0 -1)
16625 " " repeater ">")))
16626 (message "Timestamp updated"))
16627 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16628 (t (org-insert-time-stamp
16629 time (or org-time-was-given arg) inactive nil nil
16630 (list org-end-time-was-given))))))
16632 ;; FIXME: can we use this for something else, like computing time differences?
16633 (defun org-get-compact-tod (s)
16634 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16635 (let* ((t1 (match-string 1 s))
16636 (h1 (string-to-number (match-string 2 s)))
16637 (m1 (string-to-number (match-string 3 s)))
16638 (t2 (and (match-end 4) (match-string 5 s)))
16639 (h2 (and t2 (string-to-number (match-string 6 s))))
16640 (m2 (and t2 (string-to-number (match-string 7 s))))
16641 dh dm)
16642 (if (not t2)
16644 (setq dh (- h2 h1) dm (- m2 m1))
16645 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16646 (concat t1 "+" (number-to-string dh)
16647 (and (/= 0 dm) (format ":%02d" dm)))))))
16649 (defun org-time-stamp-inactive (&optional arg)
16650 "Insert an inactive time stamp.
16651 An inactive time stamp is enclosed in square brackets instead of angle
16652 brackets. It is inactive in the sense that it does not trigger agenda entries,
16653 does not link to the calendar and cannot be changed with the S-cursor keys.
16654 So these are more for recording a certain time/date."
16655 (interactive "P")
16656 (org-time-stamp arg 'inactive))
16658 (defvar org-date-ovl (make-overlay 1 1))
16659 (overlay-put org-date-ovl 'face 'org-date-selected)
16660 (org-detach-overlay org-date-ovl)
16662 (defvar org-ans1) ; dynamically scoped parameter
16663 (defvar org-ans2) ; dynamically scoped parameter
16665 (defvar org-plain-time-of-day-regexp) ; defined below
16667 (defvar org-overriding-default-time nil) ; dynamically scoped
16668 (defvar org-read-date-overlay nil)
16669 (defvar org-dcst nil) ; dynamically scoped
16670 (defvar org-read-date-history nil)
16671 (defvar org-read-date-final-answer nil)
16672 (defvar org-read-date-analyze-futurep nil)
16673 (defvar org-read-date-analyze-forced-year nil)
16674 (defvar org-read-date-inactive)
16676 (defvar org-read-date-minibuffer-local-map
16677 (let* ((map (make-sparse-keymap)))
16678 (set-keymap-parent map minibuffer-local-map)
16679 (org-defkey map (kbd ".")
16680 (lambda () (interactive)
16681 ;; Are we at the beginning of the prompt?
16682 (if (looking-back "^[^:]+: ")
16683 (org-eval-in-calendar '(calendar-goto-today))
16684 (insert "."))))
16685 (org-defkey map (kbd "C-.")
16686 (lambda () (interactive)
16687 (org-eval-in-calendar '(calendar-goto-today))))
16688 (org-defkey map [(meta shift left)]
16689 (lambda () (interactive)
16690 (org-eval-in-calendar '(calendar-backward-month 1))))
16691 (org-defkey map [(meta shift right)]
16692 (lambda () (interactive)
16693 (org-eval-in-calendar '(calendar-forward-month 1))))
16694 (org-defkey map [(meta shift up)]
16695 (lambda () (interactive)
16696 (org-eval-in-calendar '(calendar-backward-year 1))))
16697 (org-defkey map [(meta shift down)]
16698 (lambda () (interactive)
16699 (org-eval-in-calendar '(calendar-forward-year 1))))
16700 (org-defkey map [?\e (shift left)]
16701 (lambda () (interactive)
16702 (org-eval-in-calendar '(calendar-backward-month 1))))
16703 (org-defkey map [?\e (shift right)]
16704 (lambda () (interactive)
16705 (org-eval-in-calendar '(calendar-forward-month 1))))
16706 (org-defkey map [?\e (shift up)]
16707 (lambda () (interactive)
16708 (org-eval-in-calendar '(calendar-backward-year 1))))
16709 (org-defkey map [?\e (shift down)]
16710 (lambda () (interactive)
16711 (org-eval-in-calendar '(calendar-forward-year 1))))
16712 (org-defkey map [(shift up)]
16713 (lambda () (interactive)
16714 (org-eval-in-calendar '(calendar-backward-week 1))))
16715 (org-defkey map [(shift down)]
16716 (lambda () (interactive)
16717 (org-eval-in-calendar '(calendar-forward-week 1))))
16718 (org-defkey map [(shift left)]
16719 (lambda () (interactive)
16720 (org-eval-in-calendar '(calendar-backward-day 1))))
16721 (org-defkey map [(shift right)]
16722 (lambda () (interactive)
16723 (org-eval-in-calendar '(calendar-forward-day 1))))
16724 (org-defkey map "!"
16725 (lambda () (interactive)
16726 (org-eval-in-calendar '(diary-view-entries))
16727 (message "")))
16728 (org-defkey map ">"
16729 (lambda () (interactive)
16730 (org-eval-in-calendar '(calendar-scroll-left 1))))
16731 (org-defkey map "<"
16732 (lambda () (interactive)
16733 (org-eval-in-calendar '(calendar-scroll-right 1))))
16734 (org-defkey map "\C-v"
16735 (lambda () (interactive)
16736 (org-eval-in-calendar
16737 '(calendar-scroll-left-three-months 1))))
16738 (org-defkey map "\M-v"
16739 (lambda () (interactive)
16740 (org-eval-in-calendar
16741 '(calendar-scroll-right-three-months 1))))
16742 map)
16743 "Keymap for minibuffer commands when using `org-read-date'.")
16745 (defvar org-def)
16746 (defvar org-defdecode)
16747 (defvar org-with-time)
16749 (defun org-read-date (&optional org-with-time to-time from-string prompt
16750 default-time default-input inactive)
16751 "Read a date, possibly a time, and make things smooth for the user.
16752 The prompt will suggest to enter an ISO date, but you can also enter anything
16753 which will at least partially be understood by `parse-time-string'.
16754 Unrecognized parts of the date will default to the current day, month, year,
16755 hour and minute. If this command is called to replace a timestamp at point,
16756 or to enter the second timestamp of a range, the default time is taken
16757 from the existing stamp. Furthermore, the command prefers the future,
16758 so if you are giving a date where the year is not given, and the day-month
16759 combination is already past in the current year, it will assume you
16760 mean next year. For details, see the manual. A few examples:
16762 3-2-5 --> 2003-02-05
16763 feb 15 --> currentyear-02-15
16764 2/15 --> currentyear-02-15
16765 sep 12 9 --> 2009-09-12
16766 12:45 --> today 12:45
16767 22 sept 0:34 --> currentyear-09-22 0:34
16768 12 --> currentyear-currentmonth-12
16769 Fri --> nearest Friday after today
16770 -Tue --> last Tuesday
16771 etc.
16773 Furthermore you can specify a relative date by giving, as the *first* thing
16774 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16775 change in days weeks, months, years.
16776 With a single plus or minus, the date is relative to today. With a double
16777 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16778 +4d --> four days from today
16779 +4 --> same as above
16780 +2w --> two weeks from today
16781 ++5 --> five days from default date
16783 The function understands only English month and weekday abbreviations.
16785 While prompting, a calendar is popped up - you can also select the
16786 date with the mouse (button 1). The calendar shows a period of three
16787 months. To scroll it to other months, use the keys `>' and `<'.
16788 If you don't like the calendar, turn it off with
16789 \(setq org-read-date-popup-calendar nil)
16791 With optional argument TO-TIME, the date will immediately be converted
16792 to an internal time.
16793 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16794 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16795 still enter a time, and this function will inform the calling routine
16796 about this change. The calling routine may then choose to change the
16797 format used to insert the time stamp into the buffer to include the time.
16798 With optional argument FROM-STRING, read from this string instead from
16799 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16800 the time/date that is used for everything that is not specified by the
16801 user."
16802 (require 'parse-time)
16803 (let* ((org-time-stamp-rounding-minutes
16804 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16805 (org-dcst org-display-custom-times)
16806 (ct (org-current-time))
16807 (org-def (or org-overriding-default-time default-time ct))
16808 (org-defdecode (decode-time org-def))
16809 (dummy (progn
16810 (when (< (nth 2 org-defdecode) org-extend-today-until)
16811 (setcar (nthcdr 2 org-defdecode) -1)
16812 (setcar (nthcdr 1 org-defdecode) 59)
16813 (setq org-def (apply 'encode-time org-defdecode)
16814 org-defdecode (decode-time org-def)))))
16815 (cur-frame (selected-frame))
16816 (mouse-autoselect-window nil) ; Don't let the mouse jump
16817 (calendar-frame-setup nil)
16818 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16819 (calendar-move-hook nil)
16820 (calendar-view-diary-initially-flag nil)
16821 (calendar-view-holidays-initially-flag nil)
16822 (timestr (format-time-string
16823 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16824 (prompt (concat (if prompt (concat prompt " ") "")
16825 (format "Date+time [%s]: " timestr)))
16826 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16828 (cond
16829 (from-string (setq ans from-string))
16830 (org-read-date-popup-calendar
16831 (save-excursion
16832 (save-window-excursion
16833 (calendar)
16834 (when (eq calendar-setup 'calendar-only)
16835 (setq cal-frame
16836 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16837 (select-frame cal-frame))
16838 (org-eval-in-calendar '(setq cursor-type nil) t)
16839 (unwind-protect
16840 (progn
16841 (calendar-forward-day (- (time-to-days org-def)
16842 (calendar-absolute-from-gregorian
16843 (calendar-current-date))))
16844 (org-eval-in-calendar nil t)
16845 (let* ((old-map (current-local-map))
16846 (map (copy-keymap calendar-mode-map))
16847 (minibuffer-local-map
16848 (copy-keymap org-read-date-minibuffer-local-map)))
16849 (org-defkey map (kbd "RET") 'org-calendar-select)
16850 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16851 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16852 (unwind-protect
16853 (progn
16854 (use-local-map map)
16855 (setq org-read-date-inactive inactive)
16856 (add-hook 'post-command-hook 'org-read-date-display)
16857 (setq org-ans0 (read-string prompt default-input
16858 'org-read-date-history nil))
16859 ;; org-ans0: from prompt
16860 ;; org-ans1: from mouse click
16861 ;; org-ans2: from calendar motion
16862 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16863 (remove-hook 'post-command-hook 'org-read-date-display)
16864 (use-local-map old-map)
16865 (when org-read-date-overlay
16866 (delete-overlay org-read-date-overlay)
16867 (setq org-read-date-overlay nil)))))
16868 (bury-buffer "*Calendar*")
16869 (when cal-frame
16870 (delete-frame cal-frame)
16871 (select-frame-set-input-focus cur-frame))))))
16873 (t ; Naked prompt only
16874 (unwind-protect
16875 (setq ans (read-string prompt default-input
16876 'org-read-date-history timestr))
16877 (when org-read-date-overlay
16878 (delete-overlay org-read-date-overlay)
16879 (setq org-read-date-overlay nil)))))
16881 (setq final (org-read-date-analyze ans org-def org-defdecode))
16883 (when org-read-date-analyze-forced-year
16884 (message "Year was forced into %s"
16885 (if org-read-date-force-compatible-dates
16886 "compatible range (1970-2037)"
16887 "range representable on this machine"))
16888 (ding))
16890 ;; One round trip to get rid of 34th of August and stuff like that....
16891 (setq final (decode-time (apply 'encode-time final)))
16893 (setq org-read-date-final-answer ans)
16895 (if to-time
16896 (apply 'encode-time final)
16897 (if (and (boundp 'org-time-was-given) org-time-was-given)
16898 (format "%04d-%02d-%02d %02d:%02d"
16899 (nth 5 final) (nth 4 final) (nth 3 final)
16900 (nth 2 final) (nth 1 final))
16901 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16903 (defun org-read-date-display ()
16904 "Display the current date prompt interpretation in the minibuffer."
16905 (when org-read-date-display-live
16906 (when org-read-date-overlay
16907 (delete-overlay org-read-date-overlay))
16908 (when (minibufferp (current-buffer))
16909 (save-excursion
16910 (end-of-line 1)
16911 (while (not (equal (buffer-substring
16912 (max (point-min) (- (point) 4)) (point))
16913 " "))
16914 (insert " ")))
16915 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16916 " " (or org-ans1 org-ans2)))
16917 (org-end-time-was-given nil)
16918 (f (org-read-date-analyze ans org-def org-defdecode))
16919 (fmts (if org-dcst
16920 org-time-stamp-custom-formats
16921 org-time-stamp-formats))
16922 (fmt (if (or org-with-time
16923 (and (boundp 'org-time-was-given) org-time-was-given))
16924 (cdr fmts)
16925 (car fmts)))
16926 (txt (format-time-string fmt (apply 'encode-time f)))
16927 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16928 (txt (concat "=> " txt)))
16929 (when (and org-end-time-was-given
16930 (string-match org-plain-time-of-day-regexp txt))
16931 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16932 org-end-time-was-given
16933 (substring txt (match-end 0)))))
16934 (when org-read-date-analyze-futurep
16935 (setq txt (concat txt " (=>F)")))
16936 (setq org-read-date-overlay
16937 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16938 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16940 (defun org-read-date-analyze (ans org-def org-defdecode)
16941 "Analyze the combined answer of the date prompt."
16942 ;; FIXME: cleanup and comment
16943 (let ((nowdecode (decode-time (current-time)))
16944 delta deltan deltaw deltadef year month day
16945 hour minute second wday pm h2 m2 tl wday1
16946 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16947 (setq org-read-date-analyze-futurep nil
16948 org-read-date-analyze-forced-year nil)
16949 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16950 (setq ans "+0"))
16952 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16953 (setq ans (replace-match "" t t ans)
16954 deltan (car delta)
16955 deltaw (nth 1 delta)
16956 deltadef (nth 2 delta)))
16958 ;; Check if there is an iso week date in there. If yes, store the
16959 ;; info and postpone interpreting it until the rest of the parsing
16960 ;; is done.
16961 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16962 (setq iso-year (if (match-end 1)
16963 (org-small-year-to-year
16964 (string-to-number (match-string 1 ans))))
16965 iso-weekday (if (match-end 3)
16966 (string-to-number (match-string 3 ans)))
16967 iso-week (string-to-number (match-string 2 ans)))
16968 (setq ans (replace-match "" t t ans)))
16970 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16971 (when (string-match
16972 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16973 (setq year (if (match-end 2)
16974 (string-to-number (match-string 2 ans))
16975 (progn (setq kill-year t)
16976 (string-to-number (format-time-string "%Y"))))
16977 month (string-to-number (match-string 3 ans))
16978 day (string-to-number (match-string 4 ans)))
16979 (if (< year 100) (setq year (+ 2000 year)))
16980 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16981 t nil ans)))
16983 ;; Help matching dotted european dates
16984 (when (string-match
16985 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16986 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16987 (setq kill-year t)
16988 (string-to-number (format-time-string "%Y")))
16989 day (string-to-number (match-string 1 ans))
16990 month (string-to-number (match-string 2 ans))
16991 ans (replace-match (format "%04d-%02d-%02d" year month day)
16992 t nil ans)))
16994 ;; Help matching american dates, like 5/30 or 5/30/7
16995 (when (string-match
16996 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16997 (setq year (if (match-end 4)
16998 (string-to-number (match-string 4 ans))
16999 (progn (setq kill-year t)
17000 (string-to-number (format-time-string "%Y"))))
17001 month (string-to-number (match-string 1 ans))
17002 day (string-to-number (match-string 2 ans)))
17003 (if (< year 100) (setq year (+ 2000 year)))
17004 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17005 t nil ans)))
17006 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17007 ;; If there is a time with am/pm, and *no* time without it, we convert
17008 ;; so that matching will be successful.
17009 (loop for i from 1 to 2 do ; twice, for end time as well
17010 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17011 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17012 (setq hour (string-to-number (match-string 1 ans))
17013 minute (if (match-end 3)
17014 (string-to-number (match-string 3 ans))
17016 pm (equal ?p
17017 (string-to-char (downcase (match-string 4 ans)))))
17018 (if (and (= hour 12) (not pm))
17019 (setq hour 0)
17020 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17021 (setq ans (replace-match (format "%02d:%02d" hour minute)
17022 t t ans))))
17024 ;; Check if a time range is given as a duration
17025 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17026 (setq hour (string-to-number (match-string 1 ans))
17027 h2 (+ hour (string-to-number (match-string 3 ans)))
17028 minute (string-to-number (match-string 2 ans))
17029 m2 (+ minute (if (match-end 5) (string-to-number
17030 (match-string 5 ans))0)))
17031 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17032 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17033 t t ans)))
17035 ;; Check if there is a time range
17036 (when (boundp 'org-end-time-was-given)
17037 (setq org-time-was-given nil)
17038 (when (and (string-match org-plain-time-of-day-regexp ans)
17039 (match-end 8))
17040 (setq org-end-time-was-given (match-string 8 ans))
17041 (setq ans (concat (substring ans 0 (match-beginning 7))
17042 (substring ans (match-end 7))))))
17044 (setq tl (parse-time-string ans)
17045 day (or (nth 3 tl) (nth 3 org-defdecode))
17046 month
17047 (cond ((nth 4 tl))
17048 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17049 ;; Day was specified. Make sure DAY+MONTH
17050 ;; combination happens in the future.
17051 ((nth 3 tl)
17052 (setq futurep t)
17053 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17054 (nth 4 nowdecode)))
17055 (t (nth 4 org-defdecode)))
17056 year
17057 (cond ((and (not kill-year) (nth 5 tl)))
17058 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17059 ;; Month was guessed in the future and is at least
17060 ;; equal to NOWDECODE's. Fix year accordingly.
17061 (futurep
17062 (if (or (> month (nth 4 nowdecode))
17063 (>= day (nth 3 nowdecode)))
17064 (nth 5 nowdecode)
17065 (1+ (nth 5 nowdecode))))
17066 ;; Month was specified. Make sure MONTH+YEAR
17067 ;; combination happens in the future.
17068 ((nth 4 tl)
17069 (setq futurep t)
17070 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17071 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17072 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17073 (t (nth 5 nowdecode))))
17074 (t (nth 5 org-defdecode)))
17075 hour (or (nth 2 tl) (nth 2 org-defdecode))
17076 minute (or (nth 1 tl) (nth 1 org-defdecode))
17077 second (or (nth 0 tl) 0)
17078 wday (nth 6 tl))
17080 (when (and (eq org-read-date-prefer-future 'time)
17081 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17082 (equal day (nth 3 nowdecode))
17083 (equal month (nth 4 nowdecode))
17084 (equal year (nth 5 nowdecode))
17085 (nth 2 tl)
17086 (or (< (nth 2 tl) (nth 2 nowdecode))
17087 (and (= (nth 2 tl) (nth 2 nowdecode))
17088 (nth 1 tl)
17089 (< (nth 1 tl) (nth 1 nowdecode)))))
17090 (setq day (1+ day)
17091 futurep t))
17093 ;; Special date definitions below
17094 (cond
17095 (iso-week
17096 ;; There was an iso week
17097 (require 'cal-iso)
17098 (setq futurep nil)
17099 (setq year (or iso-year year)
17100 day (or iso-weekday wday 1)
17101 wday nil ; to make sure that the trigger below does not match
17102 iso-date (calendar-gregorian-from-absolute
17103 (calendar-iso-to-absolute
17104 (list iso-week day year))))
17105 ; FIXME: Should we also push ISO weeks into the future?
17106 ; (when (and org-read-date-prefer-future
17107 ; (not iso-year)
17108 ; (< (calendar-absolute-from-gregorian iso-date)
17109 ; (time-to-days (current-time))))
17110 ; (setq year (1+ year)
17111 ; iso-date (calendar-gregorian-from-absolute
17112 ; (calendar-iso-to-absolute
17113 ; (list iso-week day year)))))
17114 (setq month (car iso-date)
17115 year (nth 2 iso-date)
17116 day (nth 1 iso-date)))
17117 (deltan
17118 (setq futurep nil)
17119 (unless deltadef
17120 (let ((now (decode-time (current-time))))
17121 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17122 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17123 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17124 ((equal deltaw "m") (setq month (+ month deltan)))
17125 ((equal deltaw "y") (setq year (+ year deltan)))))
17126 ((and wday (not (nth 3 tl)))
17127 ;; Weekday was given, but no day, so pick that day in the week
17128 ;; on or after the derived date.
17129 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17130 (unless (equal wday wday1)
17131 (setq day (+ day (% (- wday wday1 -7) 7))))))
17132 (if (and (boundp 'org-time-was-given)
17133 (nth 2 tl))
17134 (setq org-time-was-given t))
17135 (if (< year 100) (setq year (+ 2000 year)))
17136 ;; Check of the date is representable
17137 (if org-read-date-force-compatible-dates
17138 (progn
17139 (if (< year 1970)
17140 (setq year 1970 org-read-date-analyze-forced-year t))
17141 (if (> year 2037)
17142 (setq year 2037 org-read-date-analyze-forced-year t)))
17143 (condition-case nil
17144 (ignore (encode-time second minute hour day month year))
17145 (error
17146 (setq year (nth 5 org-defdecode))
17147 (setq org-read-date-analyze-forced-year t))))
17148 (setq org-read-date-analyze-futurep futurep)
17149 (list second minute hour day month year)))
17151 (defvar parse-time-weekdays)
17152 (defun org-read-date-get-relative (s today default)
17153 "Check string S for special relative date string.
17154 TODAY and DEFAULT are internal times, for today and for a default.
17155 Return shift list (N what def-flag)
17156 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17157 N is the number of WHATs to shift.
17158 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17159 the DEFAULT date rather than TODAY."
17160 (require 'parse-time)
17161 (when (and
17162 (string-match
17163 (concat
17164 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17165 "\\([0-9]+\\)?"
17166 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17167 "\\([ \t]\\|$\\)") s)
17168 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17169 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17170 (string-to-char (substring (match-string 1 s) -1))
17171 ?+))
17172 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17173 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17174 (what (if (match-end 3) (match-string 3 s) "d"))
17175 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17176 (date (if rel default today))
17177 (wday (nth 6 (decode-time date)))
17178 delta)
17179 (if wday1
17180 (progn
17181 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17182 (if (= delta 0) (setq delta 7))
17183 (if (= dir ?-)
17184 (progn
17185 (setq delta (- delta 7))
17186 (if (= delta 0) (setq delta -7))))
17187 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17188 (list delta "d" rel))
17189 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17191 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17192 "Turn a user-specified date into the internal representation.
17193 The internal representation needed by the calendar is (month day year).
17194 This is a wrapper to handle the brain-dead convention in calendar that
17195 user function argument order change dependent on argument order."
17196 (if (boundp 'calendar-date-style)
17197 (cond
17198 ((eq calendar-date-style 'american)
17199 (list arg1 arg2 arg3))
17200 ((eq calendar-date-style 'european)
17201 (list arg2 arg1 arg3))
17202 ((eq calendar-date-style 'iso)
17203 (list arg2 arg3 arg1)))
17204 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17205 (if (org-bound-and-true-p european-calendar-style)
17206 (list arg2 arg1 arg3)
17207 (list arg1 arg2 arg3)))))
17209 (defun org-eval-in-calendar (form &optional keepdate)
17210 "Eval FORM in the calendar window and return to current window.
17211 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17212 otherwise stick to the current value of `org-ans2'."
17213 (let ((sf (selected-frame))
17214 (sw (selected-window)))
17215 (select-window (get-buffer-window "*Calendar*" t))
17216 (eval form)
17217 (when (and (not keepdate) (calendar-cursor-to-date))
17218 (let* ((date (calendar-cursor-to-date))
17219 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17220 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17221 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17222 (select-window sw)
17223 (org-select-frame-set-input-focus sf)))
17225 (defun org-calendar-select ()
17226 "Return to `org-read-date' with the date currently selected.
17227 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17228 (interactive)
17229 (when (calendar-cursor-to-date)
17230 (let* ((date (calendar-cursor-to-date))
17231 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17232 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17233 (if (active-minibuffer-window) (exit-minibuffer))))
17235 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17236 "Insert a date stamp for the date given by the internal TIME.
17237 See `format-time-string' for the format of TIME.
17238 WITH-HM means use the stamp format that includes the time of the day.
17239 INACTIVE means use square brackets instead of angular ones, so that the
17240 stamp will not contribute to the agenda.
17241 PRE and POST are optional strings to be inserted before and after the
17242 stamp.
17243 The command returns the inserted time stamp."
17244 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17245 stamp)
17246 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17247 (insert-before-markers (or pre ""))
17248 (when (listp extra)
17249 (setq extra (car extra))
17250 (if (and (stringp extra)
17251 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17252 (setq extra (format "-%02d:%02d"
17253 (string-to-number (match-string 1 extra))
17254 (string-to-number (match-string 2 extra))))
17255 (setq extra nil)))
17256 (when extra
17257 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17258 (insert-before-markers (setq stamp (format-time-string fmt time)))
17259 (insert-before-markers (or post ""))
17260 (setq org-last-inserted-timestamp stamp)))
17262 (defun org-toggle-time-stamp-overlays ()
17263 "Toggle the use of custom time stamp formats."
17264 (interactive)
17265 (setq org-display-custom-times (not org-display-custom-times))
17266 (unless org-display-custom-times
17267 (let ((p (point-min)) (bmp (buffer-modified-p)))
17268 (while (setq p (next-single-property-change p 'display))
17269 (if (and (get-text-property p 'display)
17270 (eq (get-text-property p 'face) 'org-date))
17271 (remove-text-properties
17272 p (setq p (next-single-property-change p 'display))
17273 '(display t))))
17274 (set-buffer-modified-p bmp)))
17275 (if (featurep 'xemacs)
17276 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17277 (org-restart-font-lock)
17278 (setq org-table-may-need-update t)
17279 (if org-display-custom-times
17280 (message "Time stamps are overlaid with custom format")
17281 (message "Time stamp overlays removed")))
17283 (defun org-display-custom-time (beg end)
17284 "Overlay modified time stamp format over timestamp between BEG and END."
17285 (let* ((ts (buffer-substring beg end))
17286 t1 w1 with-hm tf time str w2 (off 0))
17287 (save-match-data
17288 (setq t1 (org-parse-time-string ts t))
17289 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17290 (setq off (- (match-end 0) (match-beginning 0)))))
17291 (setq end (- end off))
17292 (setq w1 (- end beg)
17293 with-hm (and (nth 1 t1) (nth 2 t1))
17294 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17295 time (org-fix-decoded-time t1)
17296 str (org-add-props
17297 (format-time-string
17298 (substring tf 1 -1) (apply 'encode-time time))
17299 nil 'mouse-face 'highlight)
17300 w2 (length str))
17301 (if (not (= w2 w1))
17302 (add-text-properties (1+ beg) (+ 2 beg)
17303 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17304 (if (featurep 'xemacs)
17305 (progn
17306 (put-text-property beg end 'invisible t)
17307 (put-text-property beg end 'end-glyph (make-glyph str)))
17308 (put-text-property beg end 'display str))))
17310 (defun org-fix-decoded-time (time)
17311 "Set 0 instead of nil for the first 6 elements of time.
17312 Don't touch the rest."
17313 (let ((n 0))
17314 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17316 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17318 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17319 "Difference between TIMESTAMP-STRING and now in days.
17320 If SECONDS is non-nil, return the difference in seconds."
17321 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17322 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17323 (funcall fdiff (current-time)))))
17325 (defun org-deadline-close (timestamp-string &optional ndays)
17326 "Is the time in TIMESTAMP-STRING close to the current date?"
17327 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17328 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17329 (not (org-entry-is-done-p))))
17331 (defun org-get-wdays (ts &optional delay zero-delay)
17332 "Get the deadline lead time appropriate for timestring TS.
17333 When DELAY is non-nil, get the delay time for scheduled items
17334 instead of the deadline lead time. When ZERO-DELAY is non-nil
17335 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17336 don't try to find the delay cookie in the scheduled timestamp."
17337 (let ((tv (if delay org-scheduled-delay-days
17338 org-deadline-warning-days)))
17339 (cond
17340 ((or (and delay (< tv 0))
17341 (and delay zero-delay (<= tv 0))
17342 (and (not delay) (<= tv 0)))
17343 ;; Enforce this value no matter what
17344 (- tv))
17345 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17346 ;; lead time is specified.
17347 (floor (* (string-to-number (match-string 1 ts))
17348 (cdr (assoc (match-string 2 ts)
17349 '(("d" . 1) ("w" . 7)
17350 ("m" . 30.4) ("y" . 365.25)
17351 ("h" . 0.041667)))))))
17352 ;; go for the default.
17353 (t tv))))
17355 (defun org-calendar-select-mouse (ev)
17356 "Return to `org-read-date' with the date currently selected.
17357 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17358 (interactive "e")
17359 (mouse-set-point ev)
17360 (when (calendar-cursor-to-date)
17361 (let* ((date (calendar-cursor-to-date))
17362 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17363 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17364 (if (active-minibuffer-window) (exit-minibuffer))))
17366 (defun org-check-deadlines (ndays)
17367 "Check if there are any deadlines due or past due.
17368 A deadline is considered due if it happens within `org-deadline-warning-days'
17369 days from today's date. If the deadline appears in an entry marked DONE,
17370 it is not shown. The prefix arg NDAYS can be used to test that many
17371 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17372 (interactive "P")
17373 (let* ((org-warn-days
17374 (cond
17375 ((equal ndays '(4)) 100000)
17376 (ndays (prefix-numeric-value ndays))
17377 (t (abs org-deadline-warning-days))))
17378 (case-fold-search nil)
17379 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17380 (callback
17381 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17383 (message "%d deadlines past-due or due within %d days"
17384 (org-occur regexp nil callback)
17385 org-warn-days)))
17387 (defsubst org-re-timestamp (type)
17388 "Return a regexp for timestamp TYPE.
17389 Allowed values for TYPE are:
17391 all: all timestamps
17392 active: only active timestamps (<...>)
17393 inactive: only inactive timestamps ([...])
17394 scheduled: only scheduled timestamps
17395 deadline: only deadline timestamps
17396 closed: only closed time-stamps
17398 When TYPE is nil, fall back on returning a regexp that matches
17399 both scheduled and deadline timestamps."
17400 (case type
17401 (all org-ts-regexp-both)
17402 (active org-ts-regexp)
17403 (inactive org-ts-regexp-inactive)
17404 (scheduled org-scheduled-time-regexp)
17405 (deadline org-deadline-time-regexp)
17406 (closed org-closed-time-regexp)
17407 (otherwise
17408 (concat "\\<"
17409 (regexp-opt (list org-deadline-string org-scheduled-string))
17410 " *<\\([^>]+\\)>"))))
17412 (defun org-check-before-date (date)
17413 "Check if there are deadlines or scheduled entries before DATE."
17414 (interactive (list (org-read-date)))
17415 (let ((case-fold-search nil)
17416 (regexp (org-re-timestamp org-ts-type))
17417 (callback
17418 `(lambda ()
17419 (and ,(if (memq org-ts-type '(active inactive all))
17420 '(eq (org-element-type (org-element-context) 'timestamp))
17421 '(org-at-planning-p))
17422 (time-less-p
17423 (org-time-string-to-time (match-string 1))
17424 (org-time-string-to-time date))))))
17425 (message "%d entries before %s"
17426 (org-occur regexp nil callback) date)))
17428 (defun org-check-after-date (date)
17429 "Check if there are deadlines or scheduled entries after DATE."
17430 (interactive (list (org-read-date)))
17431 (let ((case-fold-search nil)
17432 (regexp (org-re-timestamp org-ts-type))
17433 (callback
17434 `(lambda ()
17435 (and ,(if (memq org-ts-type '(active inactive all))
17436 '(eq (org-element-type (org-element-context) 'timestamp))
17437 '(org-at-planning-p))
17438 (not (time-less-p
17439 (org-time-string-to-time (match-string 1))
17440 (org-time-string-to-time date)))))))
17441 (message "%d entries after %s"
17442 (org-occur regexp nil callback) date)))
17444 (defun org-check-dates-range (start-date end-date)
17445 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17446 (interactive (list (org-read-date nil nil nil "Range starts")
17447 (org-read-date nil nil nil "Range end")))
17448 (let ((case-fold-search nil)
17449 (regexp (org-re-timestamp org-ts-type))
17450 (callback
17451 `(lambda ()
17452 (let ((match (match-string 1)))
17453 (and
17454 ,(if (memq org-ts-type '(active inactive all))
17455 '(eq (org-element-type (org-element-context) 'timestamp))
17456 '(org-at-planning-p))
17457 (not (time-less-p
17458 (org-time-string-to-time match)
17459 (org-time-string-to-time start-date)))
17460 (time-less-p
17461 (org-time-string-to-time match)
17462 (org-time-string-to-time end-date)))))))
17463 (message "%d entries between %s and %s"
17464 (org-occur regexp nil callback) start-date end-date)))
17466 (defun org-evaluate-time-range (&optional to-buffer)
17467 "Evaluate a time range by computing the difference between start and end.
17468 Normally the result is just printed in the echo area, but with prefix arg
17469 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17470 If the time range is actually in a table, the result is inserted into the
17471 next column.
17472 For time difference computation, a year is assumed to be exactly 365
17473 days in order to avoid rounding problems."
17474 (interactive "P")
17476 (org-clock-update-time-maybe)
17477 (save-excursion
17478 (unless (org-at-date-range-p t)
17479 (goto-char (point-at-bol))
17480 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17481 (if (not (org-at-date-range-p t))
17482 (user-error "Not at a time-stamp range, and none found in current line")))
17483 (let* ((ts1 (match-string 1))
17484 (ts2 (match-string 2))
17485 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17486 (match-end (match-end 0))
17487 (time1 (org-time-string-to-time ts1))
17488 (time2 (org-time-string-to-time ts2))
17489 (t1 (org-float-time time1))
17490 (t2 (org-float-time time2))
17491 (diff (abs (- t2 t1)))
17492 (negative (< (- t2 t1) 0))
17493 ;; (ys (floor (* 365 24 60 60)))
17494 (ds (* 24 60 60))
17495 (hs (* 60 60))
17496 (fy "%dy %dd %02d:%02d")
17497 (fy1 "%dy %dd")
17498 (fd "%dd %02d:%02d")
17499 (fd1 "%dd")
17500 (fh "%02d:%02d")
17501 y d h m align)
17502 (if havetime
17503 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17505 d (floor (/ diff ds)) diff (mod diff ds)
17506 h (floor (/ diff hs)) diff (mod diff hs)
17507 m (floor (/ diff 60)))
17508 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17510 d (floor (+ (/ diff ds) 0.5))
17511 h 0 m 0))
17512 (if (not to-buffer)
17513 (message "%s" (org-make-tdiff-string y d h m))
17514 (if (org-at-table-p)
17515 (progn
17516 (goto-char match-end)
17517 (setq align t)
17518 (and (looking-at " *|") (goto-char (match-end 0))))
17519 (goto-char match-end))
17520 (if (looking-at
17521 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17522 (replace-match ""))
17523 (if negative (insert " -"))
17524 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17525 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17526 (insert " " (format fh h m))))
17527 (if align (org-table-align))
17528 (message "Time difference inserted")))))
17530 (defun org-make-tdiff-string (y d h m)
17531 (let ((fmt "")
17532 (l nil))
17533 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17534 l (push y l)))
17535 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17536 l (push d l)))
17537 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17538 l (push h l)))
17539 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17540 l (push m l)))
17541 (apply 'format fmt (nreverse l))))
17543 (defun org-time-string-to-time (s &optional buffer pos)
17544 "Convert a timestamp string into internal time."
17545 (condition-case errdata
17546 (apply 'encode-time (org-parse-time-string s))
17547 (error (error "Bad timestamp `%s'%s\nError was: %s"
17548 s (if (not (and buffer pos))
17550 (format " at %d in buffer `%s'" pos buffer))
17551 (cdr errdata)))))
17553 (defun org-time-string-to-seconds (s)
17554 "Convert a timestamp string to a number of seconds."
17555 (org-float-time (org-time-string-to-time s)))
17557 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17558 "Convert a time stamp to an absolute day number.
17559 If there is a specifier for a cyclic time stamp, get the closest
17560 date to DAYNR.
17561 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17562 The variable `date' is bound by the calendar when this is called."
17563 (cond
17564 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17565 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17566 daynr
17567 (+ daynr 1000)))
17568 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17569 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17570 (time-to-days (current-time))) (match-string 0 s)
17571 prefer show-all))
17572 (t (time-to-days
17573 (condition-case errdata
17574 (apply 'encode-time (org-parse-time-string s))
17575 (error (error "Bad timestamp `%s'%s\nError was: %s"
17576 s (if (not (and buffer pos))
17578 (format " at %d in buffer `%s'" pos buffer))
17579 (cdr errdata))))))))
17581 (defun org-days-to-iso-week (days)
17582 "Return the iso week number."
17583 (require 'cal-iso)
17584 (car (calendar-iso-from-absolute days)))
17586 (defun org-small-year-to-year (year)
17587 "Convert 2-digit years into 4-digit years.
17588 YEAR is expanded into one of the 30 next years, if possible, or
17589 into a past one. Any year larger than 99 is returned unchanged."
17590 (if (>= year 100) year
17591 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17592 (century (/ current 100))
17593 (offset (- year (% current 100))))
17594 (cond ((> offset 30) (+ (* (1- century) 100) year))
17595 ((> offset -70) (+ (* century 100) year))
17596 (t (+ (* (1+ century) 100) year))))))
17598 (defun org-time-from-absolute (d)
17599 "Return the time corresponding to date D.
17600 D may be an absolute day number, or a calendar-type list (month day year)."
17601 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17602 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17604 (defun org-calendar-holiday ()
17605 "List of holidays, for Diary display in Org-mode."
17606 (require 'holidays)
17607 (let ((hl (funcall
17608 (if (fboundp 'calendar-check-holidays)
17609 'calendar-check-holidays 'check-calendar-holidays) date)))
17610 (if hl (mapconcat 'identity hl "; "))))
17612 (defun org-diary-sexp-entry (sexp entry date)
17613 "Process a SEXP diary ENTRY for DATE."
17614 (require 'diary-lib)
17615 (let ((result (if calendar-debug-sexp
17616 (let ((stack-trace-on-error t))
17617 (eval (car (read-from-string sexp))))
17618 (condition-case nil
17619 (eval (car (read-from-string sexp)))
17620 (error
17621 (beep)
17622 (message "Bad sexp at line %d in %s: %s"
17623 (org-current-line)
17624 (buffer-file-name) sexp)
17625 (sleep-for 2))))))
17626 (cond ((stringp result) (split-string result "; "))
17627 ((and (consp result)
17628 (not (consp (cdr result)))
17629 (stringp (cdr result))) (cdr result))
17630 ((and (consp result)
17631 (stringp (car result))) result)
17632 (result entry))))
17634 (defun org-diary-to-ical-string (frombuf)
17635 "Get iCalendar entries from diary entries in buffer FROMBUF.
17636 This uses the icalendar.el library."
17637 (let* ((tmpdir (if (featurep 'xemacs)
17638 (temp-directory)
17639 temporary-file-directory))
17640 (tmpfile (make-temp-name
17641 (expand-file-name "orgics" tmpdir)))
17642 buf rtn b e)
17643 (with-current-buffer frombuf
17644 (icalendar-export-region (point-min) (point-max) tmpfile)
17645 (setq buf (find-buffer-visiting tmpfile))
17646 (set-buffer buf)
17647 (goto-char (point-min))
17648 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17649 (setq b (match-beginning 0)))
17650 (goto-char (point-max))
17651 (if (re-search-backward "^END:VEVENT" nil t)
17652 (setq e (match-end 0)))
17653 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17654 (kill-buffer buf)
17655 (delete-file tmpfile)
17656 rtn))
17658 (defun org-closest-date (start current change prefer show-all)
17659 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17660 When PREFER is `past', return a date that is either CURRENT or past.
17661 When PREFER is `future', return a date that is either CURRENT or future.
17662 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17663 ;; Make the proper lists from the dates
17664 (catch 'exit
17665 (let ((a1 '(("h" . hour)
17666 ("d" . day)
17667 ("w" . week)
17668 ("m" . month)
17669 ("y" . year)))
17670 (shour (nth 2 (org-parse-time-string start)))
17671 dn dw sday cday n1 n2 n0
17672 d m y y1 y2 date1 date2 nmonths nm ny m2)
17674 (setq start (org-date-to-gregorian start)
17675 current (org-date-to-gregorian
17676 (if show-all
17677 current
17678 (time-to-days (current-time))))
17679 sday (calendar-absolute-from-gregorian start)
17680 cday (calendar-absolute-from-gregorian current))
17682 (if (<= cday sday) (throw 'exit sday))
17684 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17685 (setq dn (string-to-number (match-string 1 change))
17686 dw (cdr (assoc (match-string 2 change) a1)))
17687 (user-error "Invalid change specifier: %s" change))
17688 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17689 (cond
17690 ((eq dw 'hour)
17691 (let ((missing-hours
17692 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17693 dn)))
17694 (setq n1 (if (zerop missing-hours) cday
17695 (- cday (1+ (floor (/ missing-hours 24)))))
17696 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17697 ((eq dw 'day)
17698 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17699 n2 (+ n1 dn)))
17700 ((eq dw 'year)
17701 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17702 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17703 (setq date1 (list m d y1)
17704 n1 (calendar-absolute-from-gregorian date1)
17705 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17706 n2 (calendar-absolute-from-gregorian date2)))
17707 ((eq dw 'month)
17708 ;; approx number of month between the two dates
17709 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17710 ;; How often does dn fit in there?
17711 (setq d (nth 1 start) m (car start) y (nth 2 start)
17712 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17713 m (+ m nm)
17714 ny (floor (/ m 12))
17715 y (+ y ny)
17716 m (- m (* ny 12)))
17717 (while (> m 12) (setq m (- m 12) y (1+ y)))
17718 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17719 (setq m2 (+ m dn) y2 y)
17720 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17721 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17722 (while (<= n2 cday)
17723 (setq n1 n2 m m2 y y2)
17724 (setq m2 (+ m dn) y2 y)
17725 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17726 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17727 ;; Make sure n1 is the earlier date
17728 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17729 (if show-all
17730 (cond
17731 ((eq prefer 'past) (if (= cday n2) n2 n1))
17732 ((eq prefer 'future) (if (= cday n1) n1 n2))
17733 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17734 (cond
17735 ((eq prefer 'past) (if (= cday n2) n2 n1))
17736 ((eq prefer 'future) (if (= cday n1) n1 n2))
17737 (t (if (= cday n1) n1 n2)))))))
17739 (defun org-date-to-gregorian (date)
17740 "Turn any specification of DATE into a Gregorian date for the calendar."
17741 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17742 ((and (listp date) (= (length date) 3)) date)
17743 ((stringp date)
17744 (setq date (org-parse-time-string date))
17745 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17746 ((listp date)
17747 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17749 (defun org-parse-time-string (s &optional nodefault)
17750 "Parse the standard Org-mode time string.
17751 This should be a lot faster than the normal `parse-time-string'.
17752 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17753 hour and minute fields will be nil if not given."
17754 (cond ((string-match org-ts-regexp0 s)
17755 (list 0
17756 (if (or (match-beginning 8) (not nodefault))
17757 (string-to-number (or (match-string 8 s) "0")))
17758 (if (or (match-beginning 7) (not nodefault))
17759 (string-to-number (or (match-string 7 s) "0")))
17760 (string-to-number (match-string 4 s))
17761 (string-to-number (match-string 3 s))
17762 (string-to-number (match-string 2 s))
17763 nil nil nil))
17764 ((string-match "^<[^>]+>$" s)
17765 (decode-time (seconds-to-time (org-matcher-time s))))
17766 (t (error "Not a standard Org-mode time string: %s" s))))
17768 (defun org-timestamp-up (&optional arg)
17769 "Increase the date item at the cursor by one.
17770 If the cursor is on the year, change the year. If it is on the month,
17771 the day or the time, change that.
17772 With prefix ARG, change by that many units."
17773 (interactive "p")
17774 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17776 (defun org-timestamp-down (&optional arg)
17777 "Decrease the date item at the cursor by one.
17778 If the cursor is on the year, change the year. If it is on the month,
17779 the day or the time, change that.
17780 With prefix ARG, change by that many units."
17781 (interactive "p")
17782 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17784 (defun org-timestamp-up-day (&optional arg)
17785 "Increase the date in the time stamp by one day.
17786 With prefix ARG, change that many days."
17787 (interactive "p")
17788 (if (and (not (org-at-timestamp-p t))
17789 (org-at-heading-p))
17790 (org-todo 'up)
17791 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17793 (defun org-timestamp-down-day (&optional arg)
17794 "Decrease the date in the time stamp by one day.
17795 With prefix ARG, change that many days."
17796 (interactive "p")
17797 (if (and (not (org-at-timestamp-p t))
17798 (org-at-heading-p))
17799 (org-todo 'down)
17800 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17802 (defun org-at-timestamp-p (&optional inactive-ok)
17803 "Determine if the cursor is in or at a timestamp."
17804 (interactive)
17805 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17806 (pos (point))
17807 (ans (or (looking-at tsr)
17808 (save-excursion
17809 (skip-chars-backward "^[<\n\r\t")
17810 (if (> (point) (point-min)) (backward-char 1))
17811 (and (looking-at tsr)
17812 (> (- (match-end 0) pos) -1))))))
17813 (and ans
17814 (boundp 'org-ts-what)
17815 (setq org-ts-what
17816 (cond
17817 ((= pos (match-beginning 0)) 'bracket)
17818 ;; Point is considered to be "on the bracket" whether
17819 ;; it's really on it or right after it.
17820 ((= pos (1- (match-end 0))) 'bracket)
17821 ((= pos (match-end 0)) 'after)
17822 ((org-pos-in-match-range pos 2) 'year)
17823 ((org-pos-in-match-range pos 3) 'month)
17824 ((org-pos-in-match-range pos 7) 'hour)
17825 ((org-pos-in-match-range pos 8) 'minute)
17826 ((or (org-pos-in-match-range pos 4)
17827 (org-pos-in-match-range pos 5)) 'day)
17828 ((and (> pos (or (match-end 8) (match-end 5)))
17829 (< pos (match-end 0)))
17830 (- pos (or (match-end 8) (match-end 5))))
17831 (t 'day))))
17832 ans))
17834 (defun org-toggle-timestamp-type ()
17835 "Toggle the type (<active> or [inactive]) of a time stamp."
17836 (interactive)
17837 (when (org-at-timestamp-p t)
17838 (let ((beg (match-beginning 0)) (end (match-end 0))
17839 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17840 (save-excursion
17841 (goto-char beg)
17842 (while (re-search-forward "[][<>]" end t)
17843 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17844 t t)))
17845 (message "Timestamp is now %sactive"
17846 (if (equal (char-after beg) ?<) "" "in")))))
17848 (defun org-at-clock-log-p nil
17849 "Is the cursor on the clock log line?"
17850 (save-excursion
17851 (move-beginning-of-line 1)
17852 (looking-at org-clock-line-re)))
17854 (defvar org-clock-history) ; defined in org-clock.el
17855 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17856 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17857 "Change the date in the time stamp at point.
17858 The date will be changed by N times WHAT. WHAT can be `day', `month',
17859 `year', `minute', `second'. If WHAT is not given, the cursor position
17860 in the timestamp determines what will be changed.
17861 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17862 (let ((origin (point)) origin-cat
17863 with-hm inactive
17864 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17865 org-ts-what
17866 extra rem
17867 ts time time0 fixnext clrgx)
17868 (if (not (org-at-timestamp-p t))
17869 (user-error "Not at a timestamp"))
17870 (if (and (not what) (eq org-ts-what 'bracket))
17871 (org-toggle-timestamp-type)
17872 ;; Point isn't on brackets. Remember the part of the time-stamp
17873 ;; the point was in. Indeed, size of time-stamps may change,
17874 ;; but point must be kept in the same category nonetheless.
17875 (setq origin-cat org-ts-what)
17876 (if (and (not what) (not (eq org-ts-what 'day))
17877 org-display-custom-times
17878 (get-text-property (point) 'display)
17879 (not (get-text-property (1- (point)) 'display)))
17880 (setq org-ts-what 'day))
17881 (setq org-ts-what (or what org-ts-what)
17882 inactive (= (char-after (match-beginning 0)) ?\[)
17883 ts (match-string 0))
17884 (replace-match "")
17885 (when (string-match
17886 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17888 (setq extra (match-string 1 ts))
17889 (if suppress-tmp-delay
17890 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17891 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17892 (setq with-hm t))
17893 (setq time0 (org-parse-time-string ts))
17894 (when (and updown
17895 (eq org-ts-what 'minute)
17896 (not current-prefix-arg))
17897 ;; This looks like s-up and s-down. Change by one rounding step.
17898 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17899 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17900 (setcar (cdr time0) (+ (nth 1 time0)
17901 (if (> n 0) (- rem) (- dm rem))))))
17902 (setq time
17903 (encode-time (or (car time0) 0)
17904 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17905 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17906 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17907 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17908 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17909 (nthcdr 6 time0)))
17910 (when (and (member org-ts-what '(hour minute))
17911 extra
17912 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17913 (setq extra (org-modify-ts-extra
17914 extra
17915 (if (eq org-ts-what 'hour) 2 5)
17916 n dm)))
17917 (when (integerp org-ts-what)
17918 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17919 (if (eq what 'calendar)
17920 (let ((cal-date (org-get-date-from-calendar)))
17921 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17922 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17923 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17924 (setcar time0 (or (car time0) 0))
17925 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17926 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17927 (setq time (apply 'encode-time time0))))
17928 ;; Insert the new time-stamp, and ensure point stays in the same
17929 ;; category as before (i.e. not after the last position in that
17930 ;; category).
17931 (let ((pos (point)))
17932 ;; Stay before inserted string. `save-excursion' is of no use.
17933 (setq org-last-changed-timestamp
17934 (org-insert-time-stamp time with-hm inactive nil nil extra))
17935 (goto-char pos))
17936 (save-match-data
17937 (looking-at org-ts-regexp3)
17938 (goto-char (cond
17939 ;; `day' category ends before `hour' if any, or at
17940 ;; the end of the day name.
17941 ((eq origin-cat 'day)
17942 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17943 ((eq origin-cat 'hour) (min (match-end 7) origin))
17944 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17945 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17946 ;; `year' and `month' have both fixed size: point
17947 ;; couldn't have moved into another part.
17948 (t origin))))
17949 ;; Update clock if on a CLOCK line.
17950 (org-clock-update-time-maybe)
17951 ;; Maybe adjust the closest clock in `org-clock-history'
17952 (when org-clock-adjust-closest
17953 (if (not (and (org-at-clock-log-p)
17954 (< 1 (length (delq nil (mapcar 'marker-position
17955 org-clock-history))))))
17956 (message "No clock to adjust")
17957 (cond ((save-excursion ; fix previous clock?
17958 (re-search-backward org-ts-regexp0 nil t)
17959 (org-looking-back (concat org-clock-string " \\[")))
17960 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17961 ((save-excursion ; fix next clock?
17962 (re-search-backward org-ts-regexp0 nil t)
17963 (looking-at (concat org-ts-regexp0 "\\] =>")))
17964 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17965 (save-window-excursion
17966 ;; Find closest clock to point, adjust the previous/next one in history
17967 (let* ((p (save-excursion (org-back-to-heading t)))
17968 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17969 (clfixnth
17970 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17971 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17972 (if (not clfixpos)
17973 (message "No clock to adjust")
17974 (save-excursion
17975 (org-goto-marker-or-bmk clfixpos)
17976 (org-show-subtree)
17977 (when (re-search-forward clrgx nil t)
17978 (goto-char (match-beginning 1))
17979 (let (org-clock-adjust-closest)
17980 (org-timestamp-change n org-ts-what updown))
17981 (message "Clock adjusted in %s for heading: %s"
17982 (file-name-nondirectory (buffer-file-name))
17983 (org-get-heading t t)))))))))
17984 ;; Try to recenter the calendar window, if any.
17985 (if (and org-calendar-follow-timestamp-change
17986 (get-buffer-window "*Calendar*" t)
17987 (memq org-ts-what '(day month year)))
17988 (org-recenter-calendar (time-to-days time))))))
17990 (defun org-modify-ts-extra (s pos n dm)
17991 "Change the different parts of the lead-time and repeat fields in timestamp."
17992 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17993 ng h m new rem)
17994 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17995 (cond
17996 ((or (org-pos-in-match-range pos 2)
17997 (org-pos-in-match-range pos 3))
17998 (setq m (string-to-number (match-string 3 s))
17999 h (string-to-number (match-string 2 s)))
18000 (if (org-pos-in-match-range pos 2)
18001 (setq h (+ h n))
18002 (setq n (* dm (org-no-warnings (signum n))))
18003 (when (not (= 0 (setq rem (% m dm))))
18004 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18005 (setq m (+ m n)))
18006 (if (< m 0) (setq m (+ m 60) h (1- h)))
18007 (if (> m 59) (setq m (- m 60) h (1+ h)))
18008 (setq h (min 24 (max 0 h)))
18009 (setq ng 1 new (format "-%02d:%02d" h m)))
18010 ((org-pos-in-match-range pos 6)
18011 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18012 ((org-pos-in-match-range pos 5)
18013 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18015 ((org-pos-in-match-range pos 9)
18016 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18017 ((org-pos-in-match-range pos 8)
18018 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18020 (when ng
18021 (setq s (concat
18022 (substring s 0 (match-beginning ng))
18024 (substring s (match-end ng))))))
18027 (defun org-recenter-calendar (date)
18028 "If the calendar is visible, recenter it to DATE."
18029 (let ((cwin (get-buffer-window "*Calendar*" t)))
18030 (when cwin
18031 (let ((calendar-move-hook nil))
18032 (with-selected-window cwin
18033 (calendar-goto-date (if (listp date) date
18034 (calendar-gregorian-from-absolute date))))))))
18036 (defun org-goto-calendar (&optional arg)
18037 "Go to the Emacs calendar at the current date.
18038 If there is a time stamp in the current line, go to that date.
18039 A prefix ARG can be used to force the current date."
18040 (interactive "P")
18041 (let ((tsr org-ts-regexp) diff
18042 (calendar-move-hook nil)
18043 (calendar-view-holidays-initially-flag nil)
18044 (calendar-view-diary-initially-flag nil))
18045 (if (or (org-at-timestamp-p)
18046 (save-excursion
18047 (beginning-of-line 1)
18048 (looking-at (concat ".*" tsr))))
18049 (let ((d1 (time-to-days (current-time)))
18050 (d2 (time-to-days
18051 (org-time-string-to-time (match-string 1)))))
18052 (setq diff (- d2 d1))))
18053 (calendar)
18054 (calendar-goto-today)
18055 (if (and diff (not arg)) (calendar-forward-day diff))))
18057 (defun org-get-date-from-calendar ()
18058 "Return a list (month day year) of date at point in calendar."
18059 (with-current-buffer "*Calendar*"
18060 (save-match-data
18061 (calendar-cursor-to-date))))
18063 (defun org-date-from-calendar ()
18064 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18065 If there is already a time stamp at the cursor position, update it."
18066 (interactive)
18067 (if (org-at-timestamp-p t)
18068 (org-timestamp-change 0 'calendar)
18069 (let ((cal-date (org-get-date-from-calendar)))
18070 (org-insert-time-stamp
18071 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18073 (defcustom org-effort-durations
18074 `(("min" . 1)
18075 ("h" . 60)
18076 ("d" . ,(* 60 8))
18077 ("w" . ,(* 60 8 5))
18078 ("m" . ,(* 60 8 5 4))
18079 ("y" . ,(* 60 8 5 40)))
18080 "Conversion factor to minutes for an effort modifier.
18082 Each entry has the form (MODIFIER . MINUTES).
18084 In an effort string, a number followed by MODIFIER is multiplied
18085 by the specified number of MINUTES to obtain an effort in
18086 minutes.
18088 For example, if the value of this variable is ((\"hours\" . 60)), then an
18089 effort string \"2hours\" is equivalent to 120 minutes."
18090 :group 'org-agenda
18091 :version "25.1"
18092 :package-version '(Org . "8.3")
18093 :type '(alist :key-type (string :tag "Modifier")
18094 :value-type (number :tag "Minutes")))
18096 (defun org-minutes-to-clocksum-string (m)
18097 "Format number of minutes as a clocksum string.
18098 The format is determined by `org-time-clocksum-format',
18099 `org-time-clocksum-use-fractional' and
18100 `org-time-clocksum-fractional-format' and
18101 `org-time-clocksum-use-effort-durations'."
18102 (let ((clocksum "")
18103 (m (round m)) ; Don't allow fractions of minutes
18104 h d w mo y fmt n)
18105 (setq h (if org-time-clocksum-use-effort-durations
18106 (cdr (assoc "h" org-effort-durations)) 60)
18107 d (if org-time-clocksum-use-effort-durations
18108 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18109 w (if org-time-clocksum-use-effort-durations
18110 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18111 mo (if org-time-clocksum-use-effort-durations
18112 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18113 y (if org-time-clocksum-use-effort-durations
18114 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18115 ;; fractional format
18116 (if org-time-clocksum-use-fractional
18117 (cond
18118 ;; single format string
18119 ((stringp org-time-clocksum-fractional-format)
18120 (format org-time-clocksum-fractional-format (/ m (float h))))
18121 ;; choice of fractional formats for different time units
18122 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18123 (> (/ (truncate m) (* y d h)) 0))
18124 (format fmt (/ m (* y d (float h)))))
18125 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18126 (> (/ (truncate m) (* mo d h)) 0))
18127 (format fmt (/ m (* mo d (float h)))))
18128 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18129 (> (/ (truncate m) (* w d h)) 0))
18130 (format fmt (/ m (* w d (float h)))))
18131 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18132 (> (/ (truncate m) (* d h)) 0))
18133 (format fmt (/ m (* d (float h)))))
18134 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18135 (> (/ (truncate m) h) 0))
18136 (format fmt (/ m (float h))))
18137 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18138 (format fmt m))
18139 ;; fall back to smallest time unit with a format
18140 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18141 (format fmt (/ m (float h))))
18142 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18143 (format fmt (/ m (* d (float h)))))
18144 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18145 (format fmt (/ m (* w d (float h)))))
18146 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18147 (format fmt (/ m (* mo d (float h)))))
18148 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18149 (format fmt (/ m (* y d (float h))))))
18150 ;; standard (non-fractional) format, with single format string
18151 (if (stringp org-time-clocksum-format)
18152 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18153 ;; separate formats components
18154 (and (setq fmt (plist-get org-time-clocksum-format :years))
18155 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18156 (plist-get org-time-clocksum-format :require-years))
18157 (setq clocksum (concat clocksum (format fmt n))
18158 m (- m (* n y d h))))
18159 (and (setq fmt (plist-get org-time-clocksum-format :months))
18160 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18161 (plist-get org-time-clocksum-format :require-months))
18162 (setq clocksum (concat clocksum (format fmt n))
18163 m (- m (* n mo d h))))
18164 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18165 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18166 (plist-get org-time-clocksum-format :require-weeks))
18167 (setq clocksum (concat clocksum (format fmt n))
18168 m (- m (* n w d h))))
18169 (and (setq fmt (plist-get org-time-clocksum-format :days))
18170 (or (> (setq n (/ (truncate m) (* d h))) 0)
18171 (plist-get org-time-clocksum-format :require-days))
18172 (setq clocksum (concat clocksum (format fmt n))
18173 m (- m (* n d h))))
18174 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18175 (or (> (setq n (/ (truncate m) h)) 0)
18176 (plist-get org-time-clocksum-format :require-hours))
18177 (setq clocksum (concat clocksum (format fmt n))
18178 m (- m (* n h))))
18179 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18180 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18181 (setq clocksum (concat clocksum (format fmt m))))
18182 ;; return formatted time duration
18183 clocksum))))
18185 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18186 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18187 "Org mode version 8.0")
18189 (defun org-hours-to-clocksum-string (n)
18190 (org-minutes-to-clocksum-string (* n 60)))
18192 (defun org-hh:mm-string-to-minutes (s)
18193 "Convert a string H:MM to a number of minutes.
18194 If the string is just a number, interpret it as minutes.
18195 In fact, the first hh:mm or number in the string will be taken,
18196 there can be extra stuff in the string.
18197 If no number is found, the return value is 0."
18198 (cond
18199 ((integerp s) s)
18200 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18201 (+ (* (string-to-number (match-string 1 s)) 60)
18202 (string-to-number (match-string 2 s))))
18203 ((string-match "\\([0-9]+\\)" s)
18204 (string-to-number (match-string 1 s)))
18205 (t 0)))
18207 (defcustom org-image-actual-width t
18208 "Should we use the actual width of images when inlining them?
18210 When set to `t', always use the image width.
18212 When set to a number, use imagemagick (when available) to set
18213 the image's width to this value.
18215 When set to a number in a list, try to get the width from any
18216 #+ATTR.* keyword if it matches a width specification like
18218 #+ATTR_HTML: :width 300px
18220 and fall back on that number if none is found.
18222 When set to nil, try to get the width from an #+ATTR.* keyword
18223 and fall back on the original width if none is found.
18225 This requires Emacs >= 24.1, build with imagemagick support."
18226 :group 'org-appearance
18227 :version "24.4"
18228 :package-version '(Org . "8.0")
18229 :type '(choice
18230 (const :tag "Use the image width" t)
18231 (integer :tag "Use a number of pixels")
18232 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18233 (const :tag "Use #+ATTR* or don't resize" nil)))
18235 (defcustom org-agenda-inhibit-startup nil
18236 "Inhibit startup when preparing agenda buffers.
18237 When this variable is `t', the initialization of the Org agenda
18238 buffers is inhibited: e.g. the visibility state is not set, the
18239 tables are not re-aligned, etc."
18240 :type 'boolean
18241 :version "24.3"
18242 :group 'org-agenda)
18244 (define-obsolete-variable-alias
18245 'org-agenda-ignore-drawer-properties
18246 'org-agenda-ignore-properties "25.1")
18248 (defcustom org-agenda-ignore-properties nil
18249 "Avoid updating text properties when building the agenda.
18250 Properties are used to prepare buffers for effort estimates,
18251 appointments, statistics and subtree-local categories.
18252 If you don't use these in the agenda, you can add them to this
18253 list and agenda building will be a bit faster.
18254 The value is a list, with zero or more of the symbols `effort', `appt',
18255 `stats' or `category'."
18256 :type '(set :greedy t
18257 (const effort)
18258 (const appt)
18259 (const stats)
18260 (const category))
18261 :version "25.1"
18262 :package-version '(Org . "8.3")
18263 :group 'org-agenda)
18265 (defun org-duration-string-to-minutes (s &optional output-to-string)
18266 "Convert a duration string S to minutes.
18268 A bare number is interpreted as minutes, modifiers can be set by
18269 customizing `org-effort-durations' (which see).
18271 Entries containing a colon are interpreted as H:MM by
18272 `org-hh:mm-string-to-minutes'."
18273 (let ((result 0)
18274 (re (concat "\\([0-9.]+\\) *\\("
18275 (regexp-opt (mapcar 'car org-effort-durations))
18276 "\\)")))
18277 (while (string-match re s)
18278 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18279 (string-to-number (match-string 1 s))))
18280 (setq s (replace-match "" nil t s)))
18281 (setq result (floor result))
18282 (incf result (org-hh:mm-string-to-minutes s))
18283 (if output-to-string (number-to-string result) result)))
18285 ;;;; Files
18287 (defun org-save-all-org-buffers ()
18288 "Save all Org-mode buffers without user confirmation."
18289 (interactive)
18290 (message "Saving all Org-mode buffers...")
18291 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18292 (when (featurep 'org-id) (org-id-locations-save))
18293 (message "Saving all Org-mode buffers... done"))
18295 (defun org-revert-all-org-buffers ()
18296 "Revert all Org-mode buffers.
18297 Prompt for confirmation when there are unsaved changes.
18298 Be sure you know what you are doing before letting this function
18299 overwrite your changes.
18301 This function is useful in a setup where one tracks org files
18302 with a version control system, to revert on one machine after pulling
18303 changes from another. I believe the procedure must be like this:
18305 1. M-x org-save-all-org-buffers
18306 2. Pull changes from the other machine, resolve conflicts
18307 3. M-x org-revert-all-org-buffers"
18308 (interactive)
18309 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18310 (user-error "Abort"))
18311 (save-excursion
18312 (save-window-excursion
18313 (mapc
18314 (lambda (b)
18315 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18316 (with-current-buffer b buffer-file-name))
18317 (org-pop-to-buffer-same-window b)
18318 (revert-buffer t 'no-confirm)))
18319 (buffer-list))
18320 (when (and (featurep 'org-id) org-id-track-globally)
18321 (org-id-locations-load)))))
18323 ;;;; Agenda files
18325 ;;;###autoload
18326 (defun org-switchb (&optional arg)
18327 "Switch between Org buffers.
18328 With one prefix argument, restrict available buffers to files.
18329 With two prefix arguments, restrict available buffers to agenda files.
18331 Defaults to `iswitchb' for buffer name completion.
18332 Set `org-completion-use-ido' to make it use ido instead."
18333 (interactive "P")
18334 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18335 ((equal arg '(16)) (org-buffer-list 'agenda))
18336 (t (org-buffer-list))))
18337 (org-completion-use-iswitchb org-completion-use-iswitchb)
18338 (org-completion-use-ido org-completion-use-ido))
18339 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18340 (setq org-completion-use-iswitchb t))
18341 (org-pop-to-buffer-same-window
18342 (org-icompleting-read "Org buffer: "
18343 (mapcar 'list (mapcar 'buffer-name blist))
18344 nil t))))
18346 ;;; Define some older names previously used for this functionality
18347 ;;;###autoload
18348 (defalias 'org-ido-switchb 'org-switchb)
18349 ;;;###autoload
18350 (defalias 'org-iswitchb 'org-switchb)
18352 (defun org-buffer-list (&optional predicate exclude-tmp)
18353 "Return a list of Org buffers.
18354 PREDICATE can be `export', `files' or `agenda'.
18356 export restrict the list to Export buffers.
18357 files restrict the list to buffers visiting Org files.
18358 agenda restrict the list to buffers visiting agenda files.
18360 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18361 (let* ((bfn nil)
18362 (agenda-files (and (eq predicate 'agenda)
18363 (mapcar 'file-truename (org-agenda-files t))))
18364 (filter
18365 (cond
18366 ((eq predicate 'files)
18367 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18368 ((eq predicate 'export)
18369 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18370 ((eq predicate 'agenda)
18371 (lambda (b)
18372 (with-current-buffer b
18373 (and (derived-mode-p 'org-mode)
18374 (setq bfn (buffer-file-name b))
18375 (member (file-truename bfn) agenda-files)))))
18376 (t (lambda (b) (with-current-buffer b
18377 (or (derived-mode-p 'org-mode)
18378 (string-match "\*Org .*Export"
18379 (buffer-name b)))))))))
18380 (delq nil
18381 (mapcar
18382 (lambda(b)
18383 (if (and (funcall filter b)
18384 (or (not exclude-tmp)
18385 (not (string-match "tmp" (buffer-name b)))))
18387 nil))
18388 (buffer-list)))))
18390 (defun org-agenda-files (&optional unrestricted archives)
18391 "Get the list of agenda files.
18392 Optional UNRESTRICTED means return the full list even if a restriction
18393 is currently in place.
18394 When ARCHIVES is t, include all archive files that are really being
18395 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18396 `org-agenda-archives-mode' is t."
18397 (let ((files
18398 (cond
18399 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18400 ((stringp org-agenda-files) (org-read-agenda-file-list))
18401 ((listp org-agenda-files) org-agenda-files)
18402 (t (error "Invalid value of `org-agenda-files'")))))
18403 (setq files (apply 'append
18404 (mapcar (lambda (f)
18405 (if (file-directory-p f)
18406 (directory-files
18407 f t org-agenda-file-regexp)
18408 (list f)))
18409 files)))
18410 (when org-agenda-skip-unavailable-files
18411 (setq files (delq nil
18412 (mapcar (function
18413 (lambda (file)
18414 (and (file-readable-p file) file)))
18415 files))))
18416 (when (or (eq archives t)
18417 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18418 (setq files (org-add-archive-files files)))
18419 files))
18421 (defun org-agenda-file-p (&optional file)
18422 "Return non-nil, if FILE is an agenda file.
18423 If FILE is omitted, use the file associated with the current
18424 buffer."
18425 (let ((fname (or file (buffer-file-name))))
18426 (and fname
18427 (member (file-truename fname)
18428 (mapcar #'file-truename (org-agenda-files t))))))
18430 (defun org-edit-agenda-file-list ()
18431 "Edit the list of agenda files.
18432 Depending on setup, this either uses customize to edit the variable
18433 `org-agenda-files', or it visits the file that is holding the list. In the
18434 latter case, the buffer is set up in a way that saving it automatically kills
18435 the buffer and restores the previous window configuration."
18436 (interactive)
18437 (if (stringp org-agenda-files)
18438 (let ((cw (current-window-configuration)))
18439 (find-file org-agenda-files)
18440 (org-set-local 'org-window-configuration cw)
18441 (org-add-hook 'after-save-hook
18442 (lambda ()
18443 (set-window-configuration
18444 (prog1 org-window-configuration
18445 (kill-buffer (current-buffer))))
18446 (org-install-agenda-files-menu)
18447 (message "New agenda file list installed"))
18448 nil 'local)
18449 (message "%s" (substitute-command-keys
18450 "Edit list and finish with \\[save-buffer]")))
18451 (customize-variable 'org-agenda-files)))
18453 (defun org-store-new-agenda-file-list (list)
18454 "Set new value for the agenda file list and save it correctly."
18455 (if (stringp org-agenda-files)
18456 (let ((fe (org-read-agenda-file-list t)) b u)
18457 (while (setq b (find-buffer-visiting org-agenda-files))
18458 (kill-buffer b))
18459 (with-temp-file org-agenda-files
18460 (insert
18461 (mapconcat
18462 (lambda (f) ;; Keep un-expanded entries.
18463 (if (setq u (assoc f fe))
18464 (cdr u)
18466 list "\n")
18467 "\n")))
18468 (let ((org-mode-hook nil) (org-inhibit-startup t)
18469 (org-insert-mode-line-in-empty-file nil))
18470 (setq org-agenda-files list)
18471 (customize-save-variable 'org-agenda-files org-agenda-files))))
18473 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18474 "Read the list of agenda files from a file.
18475 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18476 filenames, used by `org-store-new-agenda-file-list' to write back
18477 un-expanded file names."
18478 (when (file-directory-p org-agenda-files)
18479 (error "`org-agenda-files' cannot be a single directory"))
18480 (when (stringp org-agenda-files)
18481 (with-temp-buffer
18482 (insert-file-contents org-agenda-files)
18483 (mapcar
18484 (lambda (f)
18485 (let ((e (expand-file-name (substitute-in-file-name f)
18486 org-directory)))
18487 (if pair-with-expansion
18488 (cons e f)
18489 e)))
18490 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18492 ;;;###autoload
18493 (defun org-cycle-agenda-files ()
18494 "Cycle through the files in `org-agenda-files'.
18495 If the current buffer visits an agenda file, find the next one in the list.
18496 If the current buffer does not, find the first agenda file."
18497 (interactive)
18498 (let* ((fs (org-agenda-files t))
18499 (files (append fs (list (car fs))))
18500 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18501 file)
18502 (unless files (user-error "No agenda files"))
18503 (catch 'exit
18504 (while (setq file (pop files))
18505 (if (equal (file-truename file) tcf)
18506 (when (car files)
18507 (find-file (car files))
18508 (throw 'exit t))))
18509 (find-file (car fs)))
18510 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18512 (defun org-agenda-file-to-front (&optional to-end)
18513 "Move/add the current file to the top of the agenda file list.
18514 If the file is not present in the list, it is added to the front. If it is
18515 present, it is moved there. With optional argument TO-END, add/move to the
18516 end of the list."
18517 (interactive "P")
18518 (let ((org-agenda-skip-unavailable-files nil)
18519 (file-alist (mapcar (lambda (x)
18520 (cons (file-truename x) x))
18521 (org-agenda-files t)))
18522 (ctf (file-truename
18523 (or buffer-file-name
18524 (user-error "Please save the current buffer to a file"))))
18525 x had)
18526 (setq x (assoc ctf file-alist) had x)
18528 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18529 (if to-end
18530 (setq file-alist (append (delq x file-alist) (list x)))
18531 (setq file-alist (cons x (delq x file-alist))))
18532 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18533 (org-install-agenda-files-menu)
18534 (message "File %s to %s of agenda file list"
18535 (if had "moved" "added") (if to-end "end" "front"))))
18537 (defun org-remove-file (&optional file)
18538 "Remove current file from the list of files in variable `org-agenda-files'.
18539 These are the files which are being checked for agenda entries.
18540 Optional argument FILE means use this file instead of the current."
18541 (interactive)
18542 (let* ((org-agenda-skip-unavailable-files nil)
18543 (file (or file buffer-file-name
18544 (user-error "Current buffer does not visit a file")))
18545 (true-file (file-truename file))
18546 (afile (abbreviate-file-name file))
18547 (files (delq nil (mapcar
18548 (lambda (x)
18549 (if (equal true-file
18550 (file-truename x))
18551 nil x))
18552 (org-agenda-files t)))))
18553 (if (not (= (length files) (length (org-agenda-files t))))
18554 (progn
18555 (org-store-new-agenda-file-list files)
18556 (org-install-agenda-files-menu)
18557 (message "Removed from Org Agenda list: %s" afile))
18558 (message "File was not in list: %s (not removed)" afile))))
18560 (defun org-file-menu-entry (file)
18561 (vector file (list 'find-file file) t))
18563 (defun org-check-agenda-file (file)
18564 "Make sure FILE exists. If not, ask user what to do."
18565 (when (not (file-exists-p file))
18566 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18567 (abbreviate-file-name file))
18568 (let ((r (downcase (read-char-exclusive))))
18569 (cond
18570 ((equal r ?r)
18571 (org-remove-file file)
18572 (throw 'nextfile t))
18573 (t (user-error "Abort"))))))
18575 (defun org-get-agenda-file-buffer (file)
18576 "Get an agenda buffer visiting FILE.
18577 If the buffer needs to be created, add it to the list of buffers
18578 which might be released later."
18579 (let ((buf (org-find-base-buffer-visiting file)))
18580 (if buf
18581 buf ; just return it
18582 ;; Make a new buffer and remember it
18583 (setq buf (find-file-noselect file))
18584 (if buf (push buf org-agenda-new-buffers))
18585 buf)))
18587 (defun org-release-buffers (blist)
18588 "Release all buffers in list, asking the user for confirmation when needed.
18589 When a buffer is unmodified, it is just killed. When modified, it is saved
18590 \(if the user agrees) and then killed."
18591 (let (buf file)
18592 (while (setq buf (pop blist))
18593 (setq file (buffer-file-name buf))
18594 (when (and (buffer-modified-p buf)
18595 file
18596 (y-or-n-p (format "Save file %s? " file)))
18597 (with-current-buffer buf (save-buffer)))
18598 (kill-buffer buf))))
18600 (defun org-agenda-prepare-buffers (files)
18601 "Create buffers for all agenda files, protect archived trees and comments."
18602 (interactive)
18603 (let ((pa '(:org-archived t))
18604 (pc '(:org-comment t))
18605 (pall '(:org-archived t :org-comment t))
18606 (inhibit-read-only t)
18607 (org-inhibit-startup org-agenda-inhibit-startup)
18608 (rea (concat ":" org-archive-tag ":"))
18609 file re pos)
18610 (setq org-tag-alist-for-agenda nil
18611 org-tag-groups-alist-for-agenda nil)
18612 (save-excursion
18613 (save-restriction
18614 (while (setq file (pop files))
18615 (catch 'nextfile
18616 (if (bufferp file)
18617 (set-buffer file)
18618 (org-check-agenda-file file)
18619 (set-buffer (org-get-agenda-file-buffer file)))
18620 (widen)
18621 (org-set-regexps-and-options 'tags-only)
18622 (setq pos (point))
18623 (or (memq 'category org-agenda-ignore-properties)
18624 (org-refresh-category-properties))
18625 (or (memq 'stats org-agenda-ignore-properties)
18626 (org-refresh-stats-properties))
18627 (or (memq 'effort org-agenda-ignore-properties)
18628 (org-refresh-effort-properties))
18629 (or (memq 'appt org-agenda-ignore-properties)
18630 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18631 (setq org-todo-keywords-for-agenda
18632 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18633 (setq org-done-keywords-for-agenda
18634 (append org-done-keywords-for-agenda org-done-keywords))
18635 (setq org-todo-keyword-alist-for-agenda
18636 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18637 (setq org-tag-alist-for-agenda
18638 (org-uniquify
18639 (append org-tag-alist-for-agenda
18640 org-tag-alist
18641 org-tag-persistent-alist)))
18642 (if org-group-tags
18643 (setq org-tag-groups-alist-for-agenda
18644 (org-uniquify-alist
18645 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18646 (org-with-silent-modifications
18647 (save-excursion
18648 (remove-text-properties (point-min) (point-max) pall)
18649 (when org-agenda-skip-archived-trees
18650 (goto-char (point-min))
18651 (while (re-search-forward rea nil t)
18652 (if (org-at-heading-p t)
18653 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18654 (goto-char (point-min))
18655 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18656 (while (re-search-forward re nil t)
18657 (when (save-match-data (org-in-commented-heading-p t))
18658 (add-text-properties
18659 (match-beginning 0) (org-end-of-subtree t) pc)))))
18660 (goto-char pos)))))
18661 (setq org-todo-keywords-for-agenda
18662 (org-uniquify org-todo-keywords-for-agenda))
18663 (setq org-todo-keyword-alist-for-agenda
18664 (org-uniquify org-todo-keyword-alist-for-agenda))))
18667 ;;;; CDLaTeX minor mode
18669 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18670 "Keymap for the minor `org-cdlatex-mode'.")
18672 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18673 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18674 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18675 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18676 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18678 (defvar org-cdlatex-texmathp-advice-is-done nil
18679 "Flag remembering if we have applied the advice to texmathp already.")
18681 (define-minor-mode org-cdlatex-mode
18682 "Toggle the minor `org-cdlatex-mode'.
18683 This mode supports entering LaTeX environment and math in LaTeX fragments
18684 in Org-mode.
18685 \\{org-cdlatex-mode-map}"
18686 nil " OCDL" nil
18687 (when org-cdlatex-mode
18688 (require 'cdlatex)
18689 (run-hooks 'cdlatex-mode-hook)
18690 (cdlatex-compute-tables))
18691 (unless org-cdlatex-texmathp-advice-is-done
18692 (setq org-cdlatex-texmathp-advice-is-done t)
18693 (defadvice texmathp (around org-math-always-on activate)
18694 "Always return t in org-mode buffers.
18695 This is because we want to insert math symbols without dollars even outside
18696 the LaTeX math segments. If Orgmode thinks that point is actually inside
18697 an embedded LaTeX fragment, let texmathp do its job.
18698 \\[org-cdlatex-mode-map]"
18699 (interactive)
18700 (let (p)
18701 (cond
18702 ((not (derived-mode-p 'org-mode)) ad-do-it)
18703 ((eq this-command 'cdlatex-math-symbol)
18704 (setq ad-return-value t
18705 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18707 (let ((p (org-inside-LaTeX-fragment-p)))
18708 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18709 (setq ad-return-value t
18710 texmathp-why '("Org-mode embedded math" . 0))
18711 (if p ad-do-it)))))))))
18713 (defun turn-on-org-cdlatex ()
18714 "Unconditionally turn on `org-cdlatex-mode'."
18715 (org-cdlatex-mode 1))
18717 (defun org-try-cdlatex-tab ()
18718 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18719 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18720 - inside a LaTeX fragment, or
18721 - after the first word in a line, where an abbreviation expansion could
18722 insert a LaTeX environment."
18723 (when org-cdlatex-mode
18724 (cond
18725 ;; Before any word on the line: No expansion possible.
18726 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18727 ;; Just after first word on the line: Expand it. Make sure it
18728 ;; cannot happen on headlines, though.
18729 ((save-excursion
18730 (skip-chars-backward "a-zA-Z0-9*")
18731 (skip-chars-backward " \t")
18732 (and (bolp) (not (org-at-heading-p))))
18733 (cdlatex-tab) t)
18734 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18736 (defun org-cdlatex-underscore-caret (&optional arg)
18737 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18738 Revert to the normal definition outside of these fragments."
18739 (interactive "P")
18740 (if (org-inside-LaTeX-fragment-p)
18741 (call-interactively 'cdlatex-sub-superscript)
18742 (let (org-cdlatex-mode)
18743 (call-interactively (key-binding (vector last-input-event))))))
18745 (defun org-cdlatex-math-modify (&optional arg)
18746 "Execute `cdlatex-math-modify' in LaTeX fragments.
18747 Revert to the normal definition outside of these fragments."
18748 (interactive "P")
18749 (if (org-inside-LaTeX-fragment-p)
18750 (call-interactively 'cdlatex-math-modify)
18751 (let (org-cdlatex-mode)
18752 (call-interactively (key-binding (vector last-input-event))))))
18754 (defun org-cdlatex-environment-indent (&optional environment item)
18755 "Execute `cdlatex-environment' and indent the inserted environment.
18757 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18759 The inserted environment is indented to current indentation
18760 unless point is at the beginning of the line, in which the
18761 environment remains unintended."
18762 (interactive)
18763 ;; cdlatex-environment always return nil. Therefore, capture output
18764 ;; first and determine if an environment was selected.
18765 (let* ((beg (point-marker))
18766 (end (copy-marker (point) t))
18767 (inserted (progn
18768 (ignore-errors (cdlatex-environment environment item))
18769 (< beg end)))
18770 ;; Figure out how many lines to move forward after the
18771 ;; environment has been inserted.
18772 (lines (when inserted
18773 (save-excursion
18774 (- (loop while (< beg (point))
18775 with x = 0
18776 do (forward-line -1)
18777 (incf x)
18778 finally return x)
18779 (if (progn (goto-char beg)
18780 (and (progn (skip-chars-forward " \t") (eolp))
18781 (progn (skip-chars-backward " \t") (bolp))))
18782 1 0)))))
18783 (env (org-trim (delete-and-extract-region beg end))))
18784 (when inserted
18785 ;; Get indentation of next line unless at column 0.
18786 (let ((ind (if (bolp) 0
18787 (save-excursion
18788 (org-return-indent)
18789 (prog1 (org-get-indentation)
18790 (when (progn (skip-chars-forward " \t") (eolp))
18791 (delete-region beg (point)))))))
18792 (bol (progn (skip-chars-backward " \t") (bolp))))
18793 ;; Insert a newline before environment unless at column zero
18794 ;; to "escape" the current line. Insert a newline if
18795 ;; something is one the same line as \end{ENVIRONMENT}.
18796 (insert
18797 (concat (unless bol "\n") env
18798 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18799 (unless (zerop ind)
18800 (save-excursion
18801 (goto-char beg)
18802 (while (< (point) end)
18803 (unless (eolp) (org-indent-line-to ind))
18804 (forward-line))))
18805 (goto-char beg)
18806 (forward-line lines)
18807 (org-indent-line-to ind)))
18808 (set-marker beg nil)
18809 (set-marker end nil)))
18812 ;;;; LaTeX fragments
18814 (defun org-inside-LaTeX-fragment-p ()
18815 "Test if point is inside a LaTeX fragment.
18816 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18817 sequence appearing also before point.
18818 Even though the matchers for math are configurable, this function assumes
18819 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18820 delimiters are skipped when they have been removed by customization.
18821 The return value is nil, or a cons cell with the delimiter and the
18822 position of this delimiter.
18824 This function does a reasonably good job, but can locally be fooled by
18825 for example currency specifications. For example it will assume being in
18826 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18827 fragments that are properly closed, but during editing, we have to live
18828 with the uncertainty caused by missing closing delimiters. This function
18829 looks only before point, not after."
18830 (catch 'exit
18831 (let ((pos (point))
18832 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18833 (lim (progn
18834 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18835 (point)))
18836 dd-on str (start 0) m re)
18837 (goto-char pos)
18838 (when dodollar
18839 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18840 re (nth 1 (assoc "$" org-latex-regexps)))
18841 (while (string-match re str start)
18842 (cond
18843 ((= (match-end 0) (length str))
18844 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18845 ((= (match-end 0) (- (length str) 5))
18846 (throw 'exit nil))
18847 (t (setq start (match-end 0))))))
18848 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18849 (goto-char pos)
18850 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18851 (and (match-beginning 2) (throw 'exit nil))
18852 ;; count $$
18853 (while (re-search-backward "\\$\\$" lim t)
18854 (setq dd-on (not dd-on)))
18855 (goto-char pos)
18856 (if dd-on (cons "$$" m))))))
18858 (defun org-inside-latex-macro-p ()
18859 "Is point inside a LaTeX macro or its arguments?"
18860 (save-match-data
18861 (org-in-regexp
18862 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18864 (defvar org-latex-fragment-image-overlays nil
18865 "List of overlays carrying the images of latex fragments.")
18866 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18868 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18869 "Remove all overlays with LaTeX fragment images in current buffer.
18870 When optional arguments BEG and END are non-nil, remove all
18871 overlays between them instead. Return t when some overlays were
18872 removed, nil otherwise."
18873 (let (removedp)
18874 (setq org-latex-fragment-image-overlays
18875 (let ((beg (or beg (point-min)))
18876 (end (or end (point-max))))
18877 (org-remove-if
18878 (lambda (o)
18879 (and (>= (overlay-start o) beg)
18880 (<= (overlay-end o) end)
18881 (progn (delete-overlay o)
18882 (or removedp (setq removedp t)))))
18883 org-latex-fragment-image-overlays)))
18884 removedp))
18886 (define-obsolete-function-alias
18887 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18888 (defun org-toggle-latex-fragment (&optional arg)
18889 "Preview the LaTeX fragment at point, or all locally or globally.
18891 If the cursor is on a LaTeX fragment, create the image and overlay
18892 it over the source code, if there is none. Remove it otherwise.
18893 If there is no fragment at point, display all fragments in the
18894 current section.
18896 With prefix ARG, preview or clear image for all fragments in the
18897 current subtree or in the whole buffer when used before the first
18898 headline. With a double prefix ARG \\[universal-argument] \
18899 \\[universal-argument] preview or clear images
18900 for all fragments in the buffer."
18901 (interactive "P")
18902 (unless (buffer-file-name (buffer-base-buffer))
18903 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18904 (when (display-graphic-p)
18905 (catch 'exit
18906 (save-excursion
18907 (let ((window-start (window-start)) msg)
18908 (save-restriction
18909 (cond
18910 ((or (equal arg '(16))
18911 (and (equal arg '(4))
18912 (org-with-limited-levels (org-before-first-heading-p))))
18913 (if (org-remove-latex-fragment-image-overlays)
18914 (progn (message "LaTeX fragments images removed from buffer")
18915 (throw 'exit nil))
18916 (setq msg "Creating images for buffer...")))
18917 ((equal arg '(4))
18918 (org-with-limited-levels (org-back-to-heading t))
18919 (let ((beg (point))
18920 (end (progn (org-end-of-subtree t) (point))))
18921 (if (org-remove-latex-fragment-image-overlays beg end)
18922 (progn
18923 (message "LaTeX fragment images removed from subtree")
18924 (throw 'exit nil))
18925 (setq msg "Creating images for subtree...")
18926 (narrow-to-region beg end))))
18927 ((let ((datum (org-element-context)))
18928 (when (memq (org-element-type datum)
18929 '(latex-environment latex-fragment))
18930 (let* ((beg (org-element-property :begin datum))
18931 (end (org-element-property :end datum)))
18932 (if (org-remove-latex-fragment-image-overlays beg end)
18933 (progn (message "LaTeX fragment image removed")
18934 (throw 'exit nil))
18935 (narrow-to-region beg end)
18936 (setq msg "Creating image..."))))))
18938 (org-with-limited-levels
18939 (let ((beg (if (org-at-heading-p) (line-beginning-position)
18940 (outline-previous-heading)
18941 (point)))
18942 (end (progn (outline-next-heading) (point))))
18943 (if (org-remove-latex-fragment-image-overlays beg end)
18944 (progn
18945 (message "LaTeX fragment images removed from section")
18946 (throw 'exit nil))
18947 (setq msg "Creating images for section...")
18948 (narrow-to-region beg end))))))
18949 (let ((file (buffer-file-name (buffer-base-buffer))))
18950 (org-format-latex
18951 (concat org-latex-preview-ltxpng-directory
18952 (file-name-sans-extension (file-name-nondirectory file)))
18953 ;; Emacs cannot overlay images from remote hosts.
18954 ;; Create it in `temporary-file-directory' instead.
18955 (if (file-remote-p file) temporary-file-directory
18956 default-directory)
18957 'overlays msg 'forbuffer
18958 org-latex-create-formula-image-program)))
18959 ;; Work around a bug that doesn't restore window's start
18960 ;; when widening back the buffer.
18961 (set-window-start nil window-start)
18962 (message (concat msg "done")))))))
18964 (defun org-format-latex
18965 (prefix &optional dir overlays msg forbuffer processing-type)
18966 "Replace LaTeX fragments with links to an image, and produce images.
18968 When optional argument OVERLAYS is non-nil, display the image on
18969 top of the fragment instead of replacing it.
18971 PROCESSING-TYPE is the conversion method to use, as a symbol.
18973 Some of the options can be changed using the variable
18974 `org-format-latex-options', which see."
18975 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18976 (unless (eq processing-type 'verbatim)
18977 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
18978 (cnt 0)
18979 checkdir-flag)
18980 (goto-char (point-min))
18981 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
18982 (when (and overlays (memq processing-type '(dvipng imagemagick)))
18983 (overlay-recenter (point-max)))
18984 (while (re-search-forward math-regexp nil t)
18985 (unless (and overlays
18986 (eq (get-char-property (point) 'org-overlay-type)
18987 'org-latex-overlay))
18988 (let* ((context (org-element-context))
18989 (type (org-element-type context)))
18990 (when (memq type '(latex-environment latex-fragment))
18991 (let ((block-type (eq type 'latex-environment))
18992 (value (org-element-property :value context))
18993 (beg (org-element-property :begin context))
18994 (end (save-excursion
18995 (goto-char (org-element-property :end context))
18996 (skip-chars-backward " \r\t\n")
18997 (point))))
18998 (case processing-type
18999 (mathjax
19000 ;; Prepare for MathJax processing.
19001 (if (eq (char-after beg) ?$)
19002 (save-excursion
19003 (delete-region beg end)
19004 (insert "\\(" (substring value 1 -1) "\\)"))
19005 (goto-char end)))
19006 ((dvipng imagemagick)
19007 ;; Process to an image.
19008 (incf cnt)
19009 (goto-char beg)
19010 (let* ((face (face-at-point))
19011 ;; Get the colors from the face at point.
19013 (let ((color (plist-get org-format-latex-options
19014 :foreground)))
19015 (if (and forbuffer (eq color 'auto))
19016 (face-attribute face :foreground nil 'default)
19017 color)))
19019 (let ((color (plist-get org-format-latex-options
19020 :background)))
19021 (if (and forbuffer (eq color 'auto))
19022 (face-attribute face :background nil 'default)
19023 color)))
19024 (hash (sha1 (prin1-to-string
19025 (list org-format-latex-header
19026 org-latex-default-packages-alist
19027 org-latex-packages-alist
19028 org-format-latex-options
19029 forbuffer value fg bg))))
19030 (absprefix (expand-file-name prefix dir))
19031 (linkfile (format "%s_%s.png" prefix hash))
19032 (movefile (format "%s_%s.png" absprefix hash))
19033 (sep (and block-type "\n\n"))
19034 (link (concat sep "[[file:" linkfile "]]" sep))
19035 (options
19036 (org-combine-plists
19037 org-format-latex-options
19038 `(:foreground ,fg :background ,bg))))
19039 (when msg (message msg cnt))
19040 (unless checkdir-flag ; Ensure the directory exists.
19041 (setq checkdir-flag t)
19042 (let ((todir (file-name-directory absprefix)))
19043 (unless (file-directory-p todir)
19044 (make-directory todir t))))
19045 (unless (file-exists-p movefile)
19046 (org-create-formula-image
19047 value movefile options forbuffer processing-type))
19048 (if overlays
19049 (progn
19050 (dolist (o (overlays-in beg end))
19051 (when (eq (overlay-get o 'org-overlay-type)
19052 'org-latex-overlay)
19053 (delete-overlay o)))
19054 (let ((ov (make-overlay beg end)))
19055 (overlay-put ov
19056 'org-overlay-type
19057 'org-latex-overlay)
19058 (overlay-put ov 'evaporate t)
19059 (if (featurep 'xemacs)
19060 (progn
19061 (overlay-put ov 'invisible t)
19062 (overlay-put
19063 ov 'end-glyph
19064 (make-glyph
19065 (vector 'png :file movefile))))
19066 (overlay-put
19067 ov 'display
19068 (list 'image
19069 :type 'png
19070 :file movefile
19071 :ascent 'center)))
19072 (push ov org-latex-fragment-image-overlays))
19073 (goto-char end))
19074 (delete-region beg end)
19075 (insert
19076 (org-add-props link
19077 (list 'org-latex-src
19078 (replace-regexp-in-string "\"" "" value)
19079 'org-latex-src-embed-type
19080 (if block-type 'paragraph 'character)))))))
19081 (mathml
19082 ;; Process to MathML.
19083 (unless (org-format-latex-mathml-available-p)
19084 (user-error "LaTeX to MathML converter not configured"))
19085 (incf cnt)
19086 (when msg (message msg cnt))
19087 (goto-char beg)
19088 (delete-region beg end)
19089 (insert (org-format-latex-as-mathml
19090 value block-type prefix dir)))
19091 (otherwise
19092 (error "Unknown conversion type %s for LaTeX fragments"
19093 processing-type)))))))))))
19095 (defun org-create-math-formula (latex-frag &optional mathml-file)
19096 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19097 Use `org-latex-to-mathml-convert-command'. If the conversion is
19098 sucessful, return the portion between \"<math...> </math>\"
19099 elements otherwise return nil. When MATHML-FILE is specified,
19100 write the results in to that file. When invoked as an
19101 interactive command, prompt for LATEX-FRAG, with initial value
19102 set to the current active region and echo the results for user
19103 inspection."
19104 (interactive (list (let ((frag (when (org-region-active-p)
19105 (buffer-substring-no-properties
19106 (region-beginning) (region-end)))))
19107 (read-string "LaTeX Fragment: " frag nil frag))))
19108 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19109 (let* ((tmp-in-file (file-relative-name
19110 (make-temp-name (expand-file-name "ltxmathml-in"))))
19111 (ignore (write-region latex-frag nil tmp-in-file))
19112 (tmp-out-file (file-relative-name
19113 (make-temp-name (expand-file-name "ltxmathml-out"))))
19114 (cmd (format-spec
19115 org-latex-to-mathml-convert-command
19116 `((?j . ,(and org-latex-to-mathml-jar-file
19117 (shell-quote-argument
19118 (expand-file-name
19119 org-latex-to-mathml-jar-file))))
19120 (?I . ,(shell-quote-argument tmp-in-file))
19121 (?i . ,latex-frag)
19122 (?o . ,(shell-quote-argument tmp-out-file)))))
19123 mathml shell-command-output)
19124 (when (org-called-interactively-p 'any)
19125 (unless (org-format-latex-mathml-available-p)
19126 (user-error "LaTeX to MathML converter not configured")))
19127 (message "Running %s" cmd)
19128 (setq shell-command-output (shell-command-to-string cmd))
19129 (setq mathml
19130 (when (file-readable-p tmp-out-file)
19131 (with-current-buffer (find-file-noselect tmp-out-file t)
19132 (goto-char (point-min))
19133 (when (re-search-forward
19134 (concat
19135 (regexp-quote
19136 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19137 "[^>]*?>"
19138 "\\(.\\|\n\\)*"
19139 "</math>")
19140 nil t)
19141 (prog1 (match-string 0) (kill-buffer))))))
19142 (cond
19143 (mathml
19144 (setq mathml
19145 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19146 (when mathml-file
19147 (write-region mathml nil mathml-file))
19148 (when (org-called-interactively-p 'any)
19149 (message mathml)))
19150 ((message "LaTeX to MathML conversion failed")
19151 (message shell-command-output)))
19152 (delete-file tmp-in-file)
19153 (when (file-exists-p tmp-out-file)
19154 (delete-file tmp-out-file))
19155 mathml))
19157 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19158 prefix &optional dir)
19159 "Use `org-create-math-formula' but check local cache first."
19160 (let* ((absprefix (expand-file-name prefix dir))
19161 (print-length nil) (print-level nil)
19162 (formula-id (concat
19163 "formula-"
19164 (sha1
19165 (prin1-to-string
19166 (list latex-frag
19167 org-latex-to-mathml-convert-command)))))
19168 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19169 (formula-cache-dir (file-name-directory formula-cache)))
19171 (unless (file-directory-p formula-cache-dir)
19172 (make-directory formula-cache-dir t))
19174 (unless (file-exists-p formula-cache)
19175 (org-create-math-formula latex-frag formula-cache))
19177 (if (file-exists-p formula-cache)
19178 ;; Successful conversion. Return the link to MathML file.
19179 (org-add-props
19180 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19181 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19182 'org-latex-src-embed-type (if latex-frag-type
19183 'paragraph 'character)))
19184 ;; Failed conversion. Return the LaTeX fragment verbatim
19185 latex-frag)))
19187 (defun org-create-formula-image (string tofile options buffer &optional type)
19188 "Create an image from LaTeX source using dvipng or convert.
19189 This function calls either `org-create-formula-image-with-dvipng'
19190 or `org-create-formula-image-with-imagemagick' depending on the
19191 value of `org-latex-create-formula-image-program' or on the value
19192 of the optional TYPE variable.
19194 Note: ultimately these two function should be combined as they
19195 share a good deal of logic."
19196 (org-check-external-command
19197 "latex" "needed to convert LaTeX fragments to images")
19198 (funcall
19199 (case (or type org-latex-create-formula-image-program)
19200 ('dvipng
19201 (org-check-external-command
19202 "dvipng" "needed to convert LaTeX fragments to images")
19203 'org-create-formula-image-with-dvipng)
19204 ('imagemagick
19205 (org-check-external-command
19206 "convert" "you need to install imagemagick")
19207 'org-create-formula-image-with-imagemagick)
19208 (t (error
19209 "Invalid value of `org-latex-create-formula-image-program'")))
19210 string tofile options buffer))
19212 (declare-function org-export-get-backend "ox" (name))
19213 (declare-function org-export--get-global-options "ox" (&optional backend))
19214 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19215 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19216 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19217 (defun org-create-formula--latex-header ()
19218 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19219 (let ((info (org-combine-plists (org-export--get-global-options
19220 (org-export-get-backend 'latex))
19221 (org-export--get-inbuffer-options
19222 (org-export-get-backend 'latex)))))
19223 (org-latex-guess-babel-language
19224 (org-latex-guess-inputenc
19225 (org-splice-latex-header
19226 org-format-latex-header
19227 org-latex-default-packages-alist
19228 org-latex-packages-alist t
19229 (plist-get info :latex-header)))
19230 info)))
19232 (defun org--get-display-dpi ()
19233 "Get the DPI of the display.
19235 Assumes that the display has the same pixel width in the
19236 horizontal and vertical directions."
19237 (if (display-graphic-p)
19238 (round (/ (display-pixel-height)
19239 (/ (display-mm-height) 25.4)))
19240 (error "Attempt to calculate the dpi of a non-graphic display")))
19242 ;; This function borrows from Ganesh Swami's latex2png.el
19243 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19244 "This calls dvipng."
19245 (require 'ox-latex)
19246 (let* ((tmpdir (if (featurep 'xemacs)
19247 (temp-directory)
19248 temporary-file-directory))
19249 (texfilebase (make-temp-name
19250 (expand-file-name "orgtex" tmpdir)))
19251 (texfile (concat texfilebase ".tex"))
19252 (dvifile (concat texfilebase ".dvi"))
19253 (pngfile (concat texfilebase ".png"))
19254 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19255 ;; This assumes that the display has the same pixel width in
19256 ;; the horizontal and vertical directions
19257 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19258 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19259 "Black"))
19260 (bg (or (plist-get options (if buffer :background :html-background))
19261 "Transparent")))
19262 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19263 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19264 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19265 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19266 (let ((latex-header (org-create-formula--latex-header)))
19267 (with-temp-file texfile
19268 (insert latex-header)
19269 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19270 (let ((dir default-directory))
19271 (ignore-errors
19272 (cd tmpdir)
19273 (call-process "latex" nil nil nil texfile))
19274 (cd dir))
19275 (if (not (file-exists-p dvifile))
19276 (progn (message "Failed to create dvi file from %s" texfile) nil)
19277 (ignore-errors
19278 (if (featurep 'xemacs)
19279 (call-process "dvipng" nil nil nil
19280 "-fg" fg "-bg" bg
19281 "-T" "tight"
19282 "-o" pngfile
19283 dvifile)
19284 (call-process "dvipng" nil nil nil
19285 "-fg" fg "-bg" bg
19286 "-D" dpi
19287 ;;"-x" scale "-y" scale
19288 "-T" "tight"
19289 "-o" pngfile
19290 dvifile)))
19291 (if (not (file-exists-p pngfile))
19292 (if org-format-latex-signal-error
19293 (error "Failed to create png file from %s" texfile)
19294 (message "Failed to create png file from %s" texfile)
19295 nil)
19296 ;; Use the requested file name and clean up
19297 (copy-file pngfile tofile 'replace)
19298 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19299 (if (file-exists-p (concat texfilebase e))
19300 (delete-file (concat texfilebase e))))
19301 pngfile))))
19303 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19304 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19305 "This calls convert, which is included into imagemagick."
19306 (require 'ox-latex)
19307 (let* ((tmpdir (if (featurep 'xemacs)
19308 (temp-directory)
19309 temporary-file-directory))
19310 (texfilebase (make-temp-name
19311 (expand-file-name "orgtex" tmpdir)))
19312 (texfile (concat texfilebase ".tex"))
19313 (pdffile (concat texfilebase ".pdf"))
19314 (pngfile (concat texfilebase ".png"))
19315 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19316 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19317 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19318 "black"))
19319 (bg (or (plist-get options (if buffer :background :html-background))
19320 "white")))
19321 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19322 (setq fg (org-latex-color-format fg)))
19323 (if (eq bg 'default) (setq bg (org-latex-color :background))
19324 (setq bg (org-latex-color-format
19325 (if (string= bg "Transparent") "white" bg))))
19326 (let ((latex-header (org-create-formula--latex-header)))
19327 (with-temp-file texfile
19328 (insert latex-header)
19329 (insert "\n\\begin{document}\n"
19330 "\\definecolor{fg}{rgb}{" fg "}\n"
19331 "\\definecolor{bg}{rgb}{" bg "}\n"
19332 "\n\\pagecolor{bg}\n"
19333 "\n{\\color{fg}\n"
19334 string
19335 "\n}\n"
19336 "\n\\end{document}\n")))
19337 (org-latex-compile texfile t)
19338 (if (not (file-exists-p pdffile))
19339 (progn (message "Failed to create pdf file from %s" texfile) nil)
19340 (ignore-errors
19341 (if (featurep 'xemacs)
19342 (call-process "convert" nil nil nil
19343 "-density" "96"
19344 "-trim"
19345 "-antialias"
19346 pdffile
19347 "-quality" "100"
19348 ;; "-sharpen" "0x1.0"
19349 pngfile)
19350 (call-process "convert" nil nil nil
19351 "-density" dpi
19352 "-trim"
19353 "-antialias"
19354 pdffile
19355 "-quality" "100"
19356 ;; "-sharpen" "0x1.0"
19357 pngfile)))
19358 (if (not (file-exists-p pngfile))
19359 (if org-format-latex-signal-error
19360 (error "Failed to create png file from %s" texfile)
19361 (message "Failed to create png file from %s" texfile)
19362 nil)
19363 ;; Use the requested file name and clean up
19364 (copy-file pngfile tofile 'replace)
19365 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19366 (if (file-exists-p (concat texfilebase e))
19367 (delete-file (concat texfilebase e))))
19368 pngfile))))
19370 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19371 "Fill a LaTeX header template TPL.
19372 In the template, the following place holders will be recognized:
19374 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19375 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19376 [PACKAGES] \\usepackage statements for PKG
19377 [NO-PACKAGES] do not include PKG
19378 [EXTRA] the string EXTRA
19379 [NO-EXTRA] do not include EXTRA
19381 For backward compatibility, if both the positive and the negative place
19382 holder is missing, the positive one (without the \"NO-\") will be
19383 assumed to be present at the end of the template.
19384 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19385 EXTRA is a string.
19386 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19387 (let (rpl (end ""))
19388 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19389 (setq rpl (if (or (match-end 1) (not def-pkg))
19390 "" (org-latex-packages-to-string def-pkg snippets-p t))
19391 tpl (replace-match rpl t t tpl))
19392 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19394 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19395 (setq rpl (if (or (match-end 1) (not pkg))
19396 "" (org-latex-packages-to-string pkg snippets-p t))
19397 tpl (replace-match rpl t t tpl))
19398 (if pkg (setq end
19399 (concat end "\n"
19400 (org-latex-packages-to-string pkg snippets-p)))))
19402 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19403 (setq rpl (if (or (match-end 1) (not extra))
19404 "" (concat extra "\n"))
19405 tpl (replace-match rpl t t tpl))
19406 (if (and extra (string-match "\\S-" extra))
19407 (setq end (concat end "\n" extra))))
19409 (if (string-match "\\S-" end)
19410 (concat tpl "\n" end)
19411 tpl)))
19413 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19414 "Turn an alist of packages into a string with the \\usepackage macros."
19415 (setq pkg (mapconcat (lambda(p)
19416 (cond
19417 ((stringp p) p)
19418 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19419 (format "%% Package %s omitted" (cadr p)))
19420 ((equal "" (car p))
19421 (format "\\usepackage{%s}" (cadr p)))
19423 (format "\\usepackage[%s]{%s}"
19424 (car p) (cadr p)))))
19426 "\n"))
19427 (if newline (concat pkg "\n") pkg))
19429 (defun org-dvipng-color (attr)
19430 "Return a RGB color specification for dvipng."
19431 (apply 'format "rgb %s %s %s"
19432 (mapcar 'org-normalize-color
19433 (if (featurep 'xemacs)
19434 (color-rgb-components
19435 (face-property 'default
19436 (cond ((eq attr :foreground) 'foreground)
19437 ((eq attr :background) 'background))))
19438 (color-values (face-attribute 'default attr nil))))))
19440 (defun org-dvipng-color-format (color-name)
19441 "Convert COLOR-NAME to a RGB color value for dvipng."
19442 (apply 'format "rgb %s %s %s"
19443 (mapcar 'org-normalize-color
19444 (color-values color-name))))
19446 (defun org-latex-color (attr)
19447 "Return a RGB color for the LaTeX color package."
19448 (apply 'format "%s,%s,%s"
19449 (mapcar 'org-normalize-color
19450 (if (featurep 'xemacs)
19451 (color-rgb-components
19452 (face-property 'default
19453 (cond ((eq attr :foreground) 'foreground)
19454 ((eq attr :background) 'background))))
19455 (color-values (face-attribute 'default attr nil))))))
19457 (defun org-latex-color-format (color-name)
19458 "Convert COLOR-NAME to a RGB color value."
19459 (apply 'format "%s,%s,%s"
19460 (mapcar 'org-normalize-color
19461 (color-values color-name))))
19463 (defun org-normalize-color (value)
19464 "Return string to be used as color value for an RGB component."
19465 (format "%g" (/ value 65535.0)))
19469 ;; Image display
19471 (defvar org-inline-image-overlays nil)
19472 (make-variable-buffer-local 'org-inline-image-overlays)
19474 (defun org-toggle-inline-images (&optional include-linked)
19475 "Toggle the display of inline images.
19476 INCLUDE-LINKED is passed to `org-display-inline-images'."
19477 (interactive "P")
19478 (if org-inline-image-overlays
19479 (progn
19480 (org-remove-inline-images)
19481 (when (org-called-interactively-p 'interactive)
19482 (message "Inline image display turned off")))
19483 (org-display-inline-images include-linked)
19484 (when (org-called-interactively-p 'interactive)
19485 (message (if org-inline-image-overlays
19486 (format "%d images displayed inline"
19487 (length org-inline-image-overlays))
19488 "No images to display inline")))))
19490 (defun org-redisplay-inline-images ()
19491 "Refresh the display of inline images."
19492 (interactive)
19493 (if (not org-inline-image-overlays)
19494 (org-toggle-inline-images)
19495 (org-toggle-inline-images)
19496 (org-toggle-inline-images)))
19498 (defun org-display-inline-images (&optional include-linked refresh beg end)
19499 "Display inline images.
19501 An inline image is a link which follows either of these
19502 conventions:
19504 1. Its path is a file with an extension matching return value
19505 from `image-file-name-regexp' and it has no contents.
19507 2. Its description consists in a single link of the previous
19508 type.
19510 When optional argument INCLUDE-LINKED is non-nil, also links with
19511 a text description part will be inlined. This can be nice for
19512 a quick look at those images, but it does not reflect what
19513 exported files will look like.
19515 When optional argument REFRESH is non-nil, refresh existing
19516 images between BEG and END. This will create new image displays
19517 only if necessary. BEG and END default to the buffer
19518 boundaries."
19519 (interactive "P")
19520 (when (display-graphic-p)
19521 (unless refresh
19522 (org-remove-inline-images)
19523 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19524 (org-with-wide-buffer
19525 (goto-char (or beg (point-min)))
19526 (let ((case-fold-search t)
19527 (file-extension-re (org-image-file-name-regexp)))
19528 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19529 (let ((link (save-match-data (org-element-context))))
19530 ;; Check if we're at an inline image.
19531 (when (and (equal (org-element-property :type link) "file")
19532 (or include-linked
19533 (not (org-element-property :contents-begin link)))
19534 (let ((parent (org-element-property :parent link)))
19535 (or (not (eq (org-element-type parent) 'link))
19536 (not (cdr (org-element-contents parent)))))
19537 (org-string-match-p file-extension-re
19538 (org-element-property :path link)))
19539 (let ((file (expand-file-name (org-element-property :path link))))
19540 (when (file-exists-p file)
19541 (let ((width
19542 ;; Apply `org-image-actual-width' specifications.
19543 (cond
19544 ((not (image-type-available-p 'imagemagick)) nil)
19545 ((eq org-image-actual-width t) nil)
19546 ((listp org-image-actual-width)
19548 ;; First try to find a width among
19549 ;; attributes associated to the paragraph
19550 ;; containing link.
19551 (let ((paragraph
19552 (let ((e link))
19553 (while (and (setq e (org-element-property
19554 :parent e))
19555 (not (eq (org-element-type e)
19556 'paragraph))))
19557 e)))
19558 (when paragraph
19559 (save-excursion
19560 (goto-char (org-element-property :begin paragraph))
19561 (when
19562 (re-search-forward
19563 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19564 (org-element-property
19565 :post-affiliated paragraph)
19567 (string-to-number (match-string 1))))))
19568 ;; Otherwise, fall-back to provided number.
19569 (car org-image-actual-width)))
19570 ((numberp org-image-actual-width)
19571 org-image-actual-width)))
19572 (old (get-char-property-and-overlay
19573 (org-element-property :begin link)
19574 'org-image-overlay)))
19575 (if (and (car-safe old) refresh)
19576 (image-refresh (overlay-get (cdr old) 'display))
19577 (let ((image (create-image file
19578 (and width 'imagemagick)
19580 :width width)))
19581 (when image
19582 (let* ((link
19583 ;; If inline image is the description
19584 ;; of another link, be sure to
19585 ;; consider the latter as the one to
19586 ;; apply the overlay on.
19587 (let ((parent
19588 (org-element-property :parent link)))
19589 (if (eq (org-element-type parent) 'link)
19590 parent
19591 link)))
19592 (ov (make-overlay
19593 (org-element-property :begin link)
19594 (progn
19595 (goto-char
19596 (org-element-property :end link))
19597 (skip-chars-backward " \t")
19598 (point)))))
19599 (overlay-put ov 'display image)
19600 (overlay-put ov 'face 'default)
19601 (overlay-put ov 'org-image-overlay t)
19602 (overlay-put
19603 ov 'modification-hooks
19604 (list 'org-display-inline-remove-overlay))
19605 (push ov org-inline-image-overlays)))))))))))))))
19607 (define-obsolete-function-alias
19608 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19610 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19611 "Remove inline-display overlay if a corresponding region is modified."
19612 (let ((inhibit-modification-hooks t))
19613 (when (and ov after)
19614 (delete ov org-inline-image-overlays)
19615 (delete-overlay ov))))
19617 (defun org-remove-inline-images ()
19618 "Remove inline display of images."
19619 (interactive)
19620 (mapc 'delete-overlay org-inline-image-overlays)
19621 (setq org-inline-image-overlays nil))
19623 ;;;; Key bindings
19625 ;; Outline functions from `outline-mode-prefix-map'
19626 ;; that can be remapped in Org:
19627 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19628 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19629 (define-key org-mode-map [remap outline-forward-same-level]
19630 'org-forward-heading-same-level)
19631 (define-key org-mode-map [remap outline-backward-same-level]
19632 'org-backward-heading-same-level)
19633 (define-key org-mode-map [remap show-branches]
19634 'org-kill-note-or-show-branches)
19635 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19636 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19637 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19638 (define-key org-mode-map [remap outline-next-visible-heading]
19639 'org-next-visible-heading)
19640 (define-key org-mode-map [remap outline-previous-visible-heading]
19641 'org-previous-visible-heading)
19643 ;; Outline functions from `outline-mode-prefix-map' that can not
19644 ;; be remapped in Org:
19646 ;; - the column "key binding" shows whether the Outline function is still
19647 ;; available in Org mode on the same key that it has been bound to in
19648 ;; Outline mode:
19649 ;; - "overridden": key used for a different functionality in Org mode
19650 ;; - else: key still bound to the same Outline function in Org mode
19652 ;; | Outline function | key binding | Org replacement |
19653 ;; |------------------------------------+-------------+--------------------------|
19654 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19655 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19656 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19657 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19658 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19659 ;; | `show-entry' | overridden | no replacement |
19660 ;; | `show-children' | `C-c C-i' | visibility cycling |
19661 ;; | `show-branches' | `C-c C-k' | still same function |
19662 ;; | `show-subtree' | overridden | visibility cycling |
19663 ;; | `show-all' | overridden | no replacement |
19664 ;; | `hide-subtree' | overridden | visibility cycling |
19665 ;; | `hide-body' | overridden | no replacement |
19666 ;; | `hide-entry' | overridden | visibility cycling |
19667 ;; | `hide-leaves' | overridden | no replacement |
19668 ;; | `hide-sublevels' | overridden | no replacement |
19669 ;; | `hide-other' | overridden | no replacement |
19671 ;; Make `C-c C-x' a prefix key
19672 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19674 ;; TAB key with modifiers
19675 (org-defkey org-mode-map "\C-i" 'org-cycle)
19676 (org-defkey org-mode-map [(tab)] 'org-cycle)
19677 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19678 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19679 ;; The following line is necessary under Suse GNU/Linux
19680 (unless (featurep 'xemacs)
19681 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19682 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19683 (define-key org-mode-map [backtab] 'org-shifttab)
19685 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19686 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19687 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19689 ;; Cursor keys with modifiers
19690 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19691 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19692 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19693 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19695 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19696 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19697 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19698 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19699 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19700 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19702 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19703 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19704 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19705 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19707 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19708 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19709 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19710 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19712 ;; Babel keys
19713 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19714 (mapc (lambda (pair)
19715 (define-key org-babel-map (car pair) (cdr pair)))
19716 org-babel-key-bindings)
19718 ;;; Extra keys for tty access.
19719 ;; We only set them when really needed because otherwise the
19720 ;; menus don't show the simple keys
19722 (when (or org-use-extra-keys
19723 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19724 (not window-system))
19725 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19726 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19727 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19728 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19729 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19730 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19731 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19732 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19733 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19734 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19735 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19736 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19737 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19738 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19739 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19740 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19741 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19742 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19743 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19744 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19745 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19746 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19747 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19748 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19749 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19750 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19751 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19752 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19754 ;; All the other keys
19756 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19757 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19758 (if (boundp 'narrow-map)
19759 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19760 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19761 (if (boundp 'narrow-map)
19762 (org-defkey narrow-map "b" 'org-narrow-to-block)
19763 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19764 (if (boundp 'narrow-map)
19765 (org-defkey narrow-map "e" 'org-narrow-to-element)
19766 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19767 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19768 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19769 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19770 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19771 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19772 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19773 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19774 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19775 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19776 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19777 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19778 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19779 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19780 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19781 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19782 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19783 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19784 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19785 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19786 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19787 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19788 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19789 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19790 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19791 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19792 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19793 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19794 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19795 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19796 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19797 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19798 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19799 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19800 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19801 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19802 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19803 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19804 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19805 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19806 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19807 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19808 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19809 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19810 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19811 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19812 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19813 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19814 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19815 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19816 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19817 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19818 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19819 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19820 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19821 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19822 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19823 (org-defkey org-mode-map "\C-c^" 'org-sort)
19824 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19825 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19826 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19827 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19828 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19829 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19830 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19831 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19832 (org-defkey org-mode-map "\C-m" 'org-return)
19833 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19834 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19835 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19836 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19837 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19838 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19839 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19840 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19841 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19842 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19843 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19844 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19845 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19846 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19847 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19848 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19849 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19850 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19851 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19852 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19853 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19854 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19855 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19856 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19857 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19859 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19860 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19861 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19863 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19864 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19865 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19866 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19867 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19868 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19869 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19870 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19871 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19872 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19873 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19874 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19875 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19876 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19877 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19878 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19879 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19880 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19881 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19882 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19883 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19884 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19886 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19887 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19888 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19889 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19890 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19892 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19894 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19896 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19897 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19899 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19902 (when (featurep 'xemacs)
19903 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19906 (defconst org-speed-commands-default
19908 ("Outline Navigation")
19909 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19910 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19911 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19912 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19913 ("F" . org-next-block)
19914 ("B" . org-previous-block)
19915 ("u" . (org-speed-move-safe 'outline-up-heading))
19916 ("j" . org-goto)
19917 ("g" . (org-refile t))
19918 ("Outline Visibility")
19919 ("c" . org-cycle)
19920 ("C" . org-shifttab)
19921 (" " . org-display-outline-path)
19922 ("s" . org-narrow-to-subtree)
19923 ("=" . org-columns)
19924 ("Outline Structure Editing")
19925 ("U" . org-metaup)
19926 ("D" . org-metadown)
19927 ("r" . org-metaright)
19928 ("l" . org-metaleft)
19929 ("R" . org-shiftmetaright)
19930 ("L" . org-shiftmetaleft)
19931 ("i" . (progn (forward-char 1) (call-interactively
19932 'org-insert-heading-respect-content)))
19933 ("^" . org-sort)
19934 ("w" . org-refile)
19935 ("a" . org-archive-subtree-default-with-confirmation)
19936 ("@" . org-mark-subtree)
19937 ("#" . org-toggle-comment)
19938 ("Clock Commands")
19939 ("I" . org-clock-in)
19940 ("O" . org-clock-out)
19941 ("Meta Data Editing")
19942 ("t" . org-todo)
19943 ("," . (org-priority))
19944 ("0" . (org-priority ?\ ))
19945 ("1" . (org-priority ?A))
19946 ("2" . (org-priority ?B))
19947 ("3" . (org-priority ?C))
19948 (":" . org-set-tags-command)
19949 ("e" . org-set-effort)
19950 ("E" . org-inc-effort)
19951 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19952 (org-entry-put (point) "APPT_WARNTIME" m)))
19953 ("Agenda Views etc")
19954 ("v" . org-agenda)
19955 ("/" . org-sparse-tree)
19956 ("Misc")
19957 ("o" . org-open-at-point)
19958 ("?" . org-speed-command-help)
19959 ("<" . (org-agenda-set-restriction-lock 'subtree))
19960 (">" . (org-agenda-remove-restriction-lock))
19962 "The default speed commands.")
19964 (defun org-print-speed-command (e)
19965 (if (> (length (car e)) 1)
19966 (progn
19967 (princ "\n")
19968 (princ (car e))
19969 (princ "\n")
19970 (princ (make-string (length (car e)) ?-))
19971 (princ "\n"))
19972 (princ (car e))
19973 (princ " ")
19974 (if (symbolp (cdr e))
19975 (princ (symbol-name (cdr e)))
19976 (prin1 (cdr e)))
19977 (princ "\n")))
19979 (defun org-speed-command-help ()
19980 "Show the available speed commands."
19981 (interactive)
19982 (if (not org-use-speed-commands)
19983 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19984 (with-output-to-temp-buffer "*Help*"
19985 (princ "User-defined Speed commands\n===========================\n")
19986 (mapc 'org-print-speed-command org-speed-commands-user)
19987 (princ "\n")
19988 (princ "Built-in Speed commands\n=======================\n")
19989 (mapc 'org-print-speed-command org-speed-commands-default))
19990 (with-current-buffer "*Help*"
19991 (setq truncate-lines t))))
19993 (defun org-speed-move-safe (cmd)
19994 "Execute CMD, but make sure that the cursor always ends up in a headline.
19995 If not, return to the original position and throw an error."
19996 (interactive)
19997 (let ((pos (point)))
19998 (call-interactively cmd)
19999 (unless (and (bolp) (org-at-heading-p))
20000 (goto-char pos)
20001 (error "Boundary reached while executing %s" cmd))))
20003 (defvar org-self-insert-command-undo-counter 0)
20005 (defvar org-table-auto-blank-field) ; defined in org-table.el
20006 (defvar org-speed-command nil)
20008 (define-obsolete-function-alias
20009 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20011 (defun org-speed-command-activate (keys)
20012 "Hook for activating single-letter speed commands.
20013 `org-speed-commands-default' specifies a minimal command set.
20014 Use `org-speed-commands-user' for further customization."
20015 (when (or (and (bolp) (looking-at org-outline-regexp))
20016 (and (functionp org-use-speed-commands)
20017 (funcall org-use-speed-commands)))
20018 (cdr (assoc keys (append org-speed-commands-user
20019 org-speed-commands-default)))))
20021 (define-obsolete-function-alias
20022 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20024 (defun org-babel-speed-command-activate (keys)
20025 "Hook for activating single-letter code block commands."
20026 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20027 (cdr (assoc keys org-babel-key-bindings))))
20029 (defcustom org-speed-command-hook
20030 '(org-speed-command-default-hook org-babel-speed-command-hook)
20031 "Hook for activating speed commands at strategic locations.
20032 Hook functions are called in sequence until a valid handler is
20033 found.
20035 Each hook takes a single argument, a user-pressed command key
20036 which is also a `self-insert-command' from the global map.
20038 Within the hook, examine the cursor position and the command key
20039 and return nil or a valid handler as appropriate. Handler could
20040 be one of an interactive command, a function, or a form.
20042 Set `org-use-speed-commands' to non-nil value to enable this
20043 hook. The default setting is `org-speed-command-activate'."
20044 :group 'org-structure
20045 :version "24.1"
20046 :type 'hook)
20048 (defun org-self-insert-command (N)
20049 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20050 If the cursor is in a table looking at whitespace, the whitespace is
20051 overwritten, and the table is not marked as requiring realignment."
20052 (interactive "p")
20053 (org-check-before-invisible-edit 'insert)
20054 (cond
20055 ((and org-use-speed-commands
20056 (let ((kv (this-command-keys-vector)))
20057 (setq org-speed-command
20058 (run-hook-with-args-until-success
20059 'org-speed-command-hook
20060 (make-string 1 (aref kv (1- (length kv))))))))
20061 (cond
20062 ((commandp org-speed-command)
20063 (setq this-command org-speed-command)
20064 (call-interactively org-speed-command))
20065 ((functionp org-speed-command)
20066 (funcall org-speed-command))
20067 ((and org-speed-command (listp org-speed-command))
20068 (eval org-speed-command))
20069 (t (let (org-use-speed-commands)
20070 (call-interactively 'org-self-insert-command)))))
20071 ((and
20072 (org-table-p)
20073 (progn
20074 ;; check if we blank the field, and if that triggers align
20075 (and (featurep 'org-table) org-table-auto-blank-field
20076 (memq last-command
20077 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20078 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20079 ;; got extra space, this field does not determine column width
20080 (let (org-table-may-need-update) (org-table-blank-field))
20081 ;; no extra space, this field may determine column width
20082 (org-table-blank-field)))
20084 (eq N 1)
20085 (looking-at "[^|\n]* |"))
20086 (let (org-table-may-need-update)
20087 (goto-char (1- (match-end 0)))
20088 (backward-delete-char 1)
20089 (goto-char (match-beginning 0))
20090 (self-insert-command N)))
20092 (setq org-table-may-need-update t)
20093 (self-insert-command N)
20094 (org-fix-tags-on-the-fly)
20095 (if org-self-insert-cluster-for-undo
20096 (if (not (eq last-command 'org-self-insert-command))
20097 (setq org-self-insert-command-undo-counter 1)
20098 (if (>= org-self-insert-command-undo-counter 20)
20099 (setq org-self-insert-command-undo-counter 1)
20100 (and (> org-self-insert-command-undo-counter 0)
20101 buffer-undo-list (listp buffer-undo-list)
20102 (not (cadr buffer-undo-list)) ; remove nil entry
20103 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20104 (setq org-self-insert-command-undo-counter
20105 (1+ org-self-insert-command-undo-counter))))))))
20107 (defun org-check-before-invisible-edit (kind)
20108 "Check is editing if kind KIND would be dangerous with invisible text around.
20109 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20110 ;; First, try to get out of here as quickly as possible, to reduce overhead
20111 (if (and org-catch-invisible-edits
20112 (or (not (boundp 'visible-mode)) (not visible-mode))
20113 (or (get-char-property (point) 'invisible)
20114 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20115 ;; OK, we need to take a closer look
20116 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20117 (invisible-before-point (if (bobp) nil (get-char-property
20118 (1- (point)) 'invisible)))
20119 (border-and-ok-direction
20121 ;; Check if we are acting predictably before invisible text
20122 (and invisible-at-point (not invisible-before-point)
20123 (memq kind '(insert delete-backward)))
20124 ;; Check if we are acting predictably after invisible text
20125 ;; This works not well, and I have turned it off. It seems
20126 ;; better to always show and stop after invisible text.
20127 ;; (and (not invisible-at-point) invisible-before-point
20128 ;; (memq kind '(insert delete)))
20130 (when (or (memq invisible-at-point '(outline org-hide-block t))
20131 (memq invisible-before-point '(outline org-hide-block t)))
20132 (if (eq org-catch-invisible-edits 'error)
20133 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20134 (if (and org-custom-properties-overlays
20135 (y-or-n-p "Display invisible properties in this buffer? "))
20136 (org-toggle-custom-properties-visibility)
20137 ;; Make the area visible
20138 (save-excursion
20139 (if invisible-before-point
20140 (goto-char (previous-single-char-property-change
20141 (point) 'invisible)))
20142 (show-subtree))
20143 (cond
20144 ((eq org-catch-invisible-edits 'show)
20145 ;; That's it, we do the edit after showing
20146 (message
20147 "Unfolding invisible region around point before editing")
20148 (sit-for 1))
20149 ((and (eq org-catch-invisible-edits 'smart)
20150 border-and-ok-direction)
20151 (message "Unfolding invisible region around point before editing"))
20153 ;; Don't do the edit, make the user repeat it in full visibility
20154 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20156 (defun org-fix-tags-on-the-fly ()
20157 (when (and (equal (char-after (point-at-bol)) ?*)
20158 (org-at-heading-p))
20159 (org-align-tags-here org-tags-column)))
20161 (defun org-delete-backward-char (N)
20162 "Like `delete-backward-char', insert whitespace at field end in tables.
20163 When deleting backwards, in tables this function will insert whitespace in
20164 front of the next \"|\" separator, to keep the table aligned. The table will
20165 still be marked for re-alignment if the field did fill the entire column,
20166 because, in this case the deletion might narrow the column."
20167 (interactive "p")
20168 (save-match-data
20169 (org-check-before-invisible-edit 'delete-backward)
20170 (if (and (org-table-p)
20171 (eq N 1)
20172 (string-match "|" (buffer-substring (point-at-bol) (point)))
20173 (looking-at ".*?|"))
20174 (let ((pos (point))
20175 (noalign (looking-at "[^|\n\r]* |"))
20176 (c org-table-may-need-update))
20177 (backward-delete-char N)
20178 (if (not overwrite-mode)
20179 (progn
20180 (skip-chars-forward "^|")
20181 (insert " ")
20182 (goto-char (1- pos))))
20183 ;; noalign: if there were two spaces at the end, this field
20184 ;; does not determine the width of the column.
20185 (if noalign (setq org-table-may-need-update c)))
20186 (backward-delete-char N)
20187 (org-fix-tags-on-the-fly))))
20189 (defun org-delete-char (N)
20190 "Like `delete-char', but insert whitespace at field end in tables.
20191 When deleting characters, in tables this function will insert whitespace in
20192 front of the next \"|\" separator, to keep the table aligned. The table will
20193 still be marked for re-alignment if the field did fill the entire column,
20194 because, in this case the deletion might narrow the column."
20195 (interactive "p")
20196 (save-match-data
20197 (org-check-before-invisible-edit 'delete)
20198 (if (and (org-table-p)
20199 (not (bolp))
20200 (not (= (char-after) ?|))
20201 (eq N 1))
20202 (if (looking-at ".*?|")
20203 (let ((pos (point))
20204 (noalign (looking-at "[^|\n\r]* |"))
20205 (c org-table-may-need-update))
20206 (replace-match
20207 (concat (substring (match-string 0) 1 -1) " |") nil t)
20208 (goto-char pos)
20209 ;; noalign: if there were two spaces at the end, this field
20210 ;; does not determine the width of the column.
20211 (if noalign (setq org-table-may-need-update c)))
20212 (delete-char N))
20213 (delete-char N)
20214 (org-fix-tags-on-the-fly))))
20216 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20217 (put 'org-self-insert-command 'delete-selection
20218 (lambda ()
20219 (not (run-hook-with-args-until-success
20220 'self-insert-uses-region-functions))))
20221 (put 'orgtbl-self-insert-command 'delete-selection
20222 (lambda ()
20223 (not (run-hook-with-args-until-success
20224 'self-insert-uses-region-functions))))
20225 (put 'org-delete-char 'delete-selection 'supersede)
20226 (put 'org-delete-backward-char 'delete-selection 'supersede)
20227 (put 'org-yank 'delete-selection 'yank)
20229 ;; Make `flyspell-mode' delay after some commands
20230 (put 'org-self-insert-command 'flyspell-delayed t)
20231 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20232 (put 'org-delete-char 'flyspell-delayed t)
20233 (put 'org-delete-backward-char 'flyspell-delayed t)
20235 ;; Make pabbrev-mode expand after org-mode commands
20236 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20237 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20239 (defun org-remap (map &rest commands)
20240 "In MAP, remap the functions given in COMMANDS.
20241 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20242 (let (new old)
20243 (while commands
20244 (setq old (pop commands) new (pop commands))
20245 (if (fboundp 'command-remapping)
20246 (org-defkey map (vector 'remap old) new)
20247 (substitute-key-definition old new map global-map)))))
20249 (defun org-transpose-words ()
20250 "Transpose words for Org.
20251 This uses the `org-mode-transpose-word-syntax-table' syntax
20252 table, which interprets characters in `org-emphasis-alist' as
20253 word constituents."
20254 (interactive)
20255 (with-syntax-table org-mode-transpose-word-syntax-table
20256 (call-interactively 'transpose-words)))
20257 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20259 (when (eq org-enable-table-editor 'optimized)
20260 ;; If the user wants maximum table support, we need to hijack
20261 ;; some standard editing functions
20262 (org-remap org-mode-map
20263 'self-insert-command 'org-self-insert-command
20264 'delete-char 'org-delete-char
20265 'delete-backward-char 'org-delete-backward-char)
20266 (org-defkey org-mode-map "|" 'org-force-self-insert))
20268 (defvar org-ctrl-c-ctrl-c-hook nil
20269 "Hook for functions attaching themselves to `C-c C-c'.
20271 This can be used to add additional functionality to the C-c C-c
20272 key which executes context-dependent commands. This hook is run
20273 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20274 run after the last test.
20276 Each function will be called with no arguments. The function
20277 must check if the context is appropriate for it to act. If yes,
20278 it should do its thing and then return a non-nil value. If the
20279 context is wrong, just do nothing and return nil.")
20281 (defvar org-ctrl-c-ctrl-c-final-hook nil
20282 "Hook for functions attaching themselves to `C-c C-c'.
20284 This can be used to add additional functionality to the C-c C-c
20285 key which executes context-dependent commands. This hook is run
20286 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20287 before the first test.
20289 Each function will be called with no arguments. The function
20290 must check if the context is appropriate for it to act. If yes,
20291 it should do its thing and then return a non-nil value. If the
20292 context is wrong, just do nothing and return nil.")
20294 (defvar org-tab-first-hook nil
20295 "Hook for functions to attach themselves to TAB.
20296 See `org-ctrl-c-ctrl-c-hook' for more information.
20297 This hook runs as the first action when TAB is pressed, even before
20298 `org-cycle' messes around with the `outline-regexp' to cater for
20299 inline tasks and plain list item folding.
20300 If any function in this hook returns t, any other actions that
20301 would have been caused by TAB (such as table field motion or visibility
20302 cycling) will not occur.")
20304 (defvar org-tab-after-check-for-table-hook nil
20305 "Hook for functions to attach themselves to TAB.
20306 See `org-ctrl-c-ctrl-c-hook' for more information.
20307 This hook runs after it has been established that the cursor is not in a
20308 table, but before checking if the cursor is in a headline or if global cycling
20309 should be done.
20310 If any function in this hook returns t, not other actions like visibility
20311 cycling will be done.")
20313 (defvar org-tab-after-check-for-cycling-hook nil
20314 "Hook for functions to attach themselves to TAB.
20315 See `org-ctrl-c-ctrl-c-hook' for more information.
20316 This hook runs after it has been established that not table field motion and
20317 not visibility should be done because of current context. This is probably
20318 the place where a package like yasnippets can hook in.")
20320 (defvar org-tab-before-tab-emulation-hook nil
20321 "Hook for functions to attach themselves to TAB.
20322 See `org-ctrl-c-ctrl-c-hook' for more information.
20323 This hook runs after every other options for TAB have been exhausted, but
20324 before indentation and \t insertion takes place.")
20326 (defvar org-metaleft-hook nil
20327 "Hook for functions attaching themselves to `M-left'.
20328 See `org-ctrl-c-ctrl-c-hook' for more information.")
20329 (defvar org-metaright-hook nil
20330 "Hook for functions attaching themselves to `M-right'.
20331 See `org-ctrl-c-ctrl-c-hook' for more information.")
20332 (defvar org-metaup-hook nil
20333 "Hook for functions attaching themselves to `M-up'.
20334 See `org-ctrl-c-ctrl-c-hook' for more information.")
20335 (defvar org-metadown-hook nil
20336 "Hook for functions attaching themselves to `M-down'.
20337 See `org-ctrl-c-ctrl-c-hook' for more information.")
20338 (defvar org-shiftmetaleft-hook nil
20339 "Hook for functions attaching themselves to `M-S-left'.
20340 See `org-ctrl-c-ctrl-c-hook' for more information.")
20341 (defvar org-shiftmetaright-hook nil
20342 "Hook for functions attaching themselves to `M-S-right'.
20343 See `org-ctrl-c-ctrl-c-hook' for more information.")
20344 (defvar org-shiftmetaup-hook nil
20345 "Hook for functions attaching themselves to `M-S-up'.
20346 See `org-ctrl-c-ctrl-c-hook' for more information.")
20347 (defvar org-shiftmetadown-hook nil
20348 "Hook for functions attaching themselves to `M-S-down'.
20349 See `org-ctrl-c-ctrl-c-hook' for more information.")
20350 (defvar org-metareturn-hook nil
20351 "Hook for functions attaching themselves to `M-RET'.
20352 See `org-ctrl-c-ctrl-c-hook' for more information.")
20353 (defvar org-shiftup-hook nil
20354 "Hook for functions attaching themselves to `S-up'.
20355 See `org-ctrl-c-ctrl-c-hook' for more information.")
20356 (defvar org-shiftup-final-hook nil
20357 "Hook for functions attaching themselves to `S-up'.
20358 This one runs after all other options except shift-select have been excluded.
20359 See `org-ctrl-c-ctrl-c-hook' for more information.")
20360 (defvar org-shiftdown-hook nil
20361 "Hook for functions attaching themselves to `S-down'.
20362 See `org-ctrl-c-ctrl-c-hook' for more information.")
20363 (defvar org-shiftdown-final-hook nil
20364 "Hook for functions attaching themselves to `S-down'.
20365 This one runs after all other options except shift-select have been excluded.
20366 See `org-ctrl-c-ctrl-c-hook' for more information.")
20367 (defvar org-shiftleft-hook nil
20368 "Hook for functions attaching themselves to `S-left'.
20369 See `org-ctrl-c-ctrl-c-hook' for more information.")
20370 (defvar org-shiftleft-final-hook nil
20371 "Hook for functions attaching themselves to `S-left'.
20372 This one runs after all other options except shift-select have been excluded.
20373 See `org-ctrl-c-ctrl-c-hook' for more information.")
20374 (defvar org-shiftright-hook nil
20375 "Hook for functions attaching themselves to `S-right'.
20376 See `org-ctrl-c-ctrl-c-hook' for more information.")
20377 (defvar org-shiftright-final-hook nil
20378 "Hook for functions attaching themselves to `S-right'.
20379 This one runs after all other options except shift-select have been excluded.
20380 See `org-ctrl-c-ctrl-c-hook' for more information.")
20382 (defun org-modifier-cursor-error ()
20383 "Throw an error, a modified cursor command was applied in wrong context."
20384 (user-error "This command is active in special context like tables, headlines or items"))
20386 (defun org-shiftselect-error ()
20387 "Throw an error because Shift-Cursor command was applied in wrong context."
20388 (if (and (boundp 'shift-select-mode) shift-select-mode)
20389 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20390 (user-error "This command works only in special context like headlines or timestamps")))
20392 (defun org-call-for-shift-select (cmd)
20393 (let ((this-command-keys-shift-translated t))
20394 (call-interactively cmd)))
20396 (defun org-shifttab (&optional arg)
20397 "Global visibility cycling or move to previous table field.
20398 Call `org-table-previous-field' within a table.
20399 When ARG is nil, cycle globally through visibility states.
20400 When ARG is a numeric prefix, show contents of this level."
20401 (interactive "P")
20402 (cond
20403 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20404 ((integerp arg)
20405 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20406 (message "Content view to level: %d" arg)
20407 (org-content (prefix-numeric-value arg2))
20408 (org-cycle-show-empty-lines t)
20409 (setq org-cycle-global-status 'overview)))
20410 (t (call-interactively 'org-global-cycle))))
20412 (defun org-shiftmetaleft ()
20413 "Promote subtree or delete table column.
20414 Calls `org-promote-subtree', `org-outdent-item-tree', or
20415 `org-table-delete-column', depending on context. See the
20416 individual commands for more information."
20417 (interactive)
20418 (cond
20419 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20420 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20421 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20422 ((if (not (org-region-active-p)) (org-at-item-p)
20423 (save-excursion (goto-char (region-beginning))
20424 (org-at-item-p)))
20425 (call-interactively 'org-outdent-item-tree))
20426 (t (org-modifier-cursor-error))))
20428 (defun org-shiftmetaright ()
20429 "Demote subtree or insert table column.
20430 Calls `org-demote-subtree', `org-indent-item-tree', or
20431 `org-table-insert-column', depending on context. See the
20432 individual commands for more information."
20433 (interactive)
20434 (cond
20435 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20436 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20437 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20438 ((if (not (org-region-active-p)) (org-at-item-p)
20439 (save-excursion (goto-char (region-beginning))
20440 (org-at-item-p)))
20441 (call-interactively 'org-indent-item-tree))
20442 (t (org-modifier-cursor-error))))
20444 (defun org-shiftmetaup (&optional arg)
20445 "Drag the line at point up.
20446 In a table, kill the current row.
20447 On a clock timestamp, update the value of the timestamp like `S-<up>'
20448 but also adjust the previous clocked item in the clock history.
20449 Everywhere else, drag the line at point up."
20450 (interactive "P")
20451 (cond
20452 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20453 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20454 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20455 (call-interactively 'org-timestamp-up)))
20456 (t (call-interactively 'org-drag-line-backward))))
20458 (defun org-shiftmetadown (&optional arg)
20459 "Drag the line at point down.
20460 In a table, insert an empty row at the current line.
20461 On a clock timestamp, update the value of the timestamp like `S-<down>'
20462 but also adjust the previous clocked item in the clock history.
20463 Everywhere else, drag the line at point down."
20464 (interactive "P")
20465 (cond
20466 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20467 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20468 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20469 (call-interactively 'org-timestamp-down)))
20470 (t (call-interactively 'org-drag-line-forward))))
20472 (defsubst org-hidden-tree-error ()
20473 (user-error
20474 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20476 (defun org-metaleft (&optional arg)
20477 "Promote heading, list item at point or move table column left.
20479 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20480 depending on context. With no specific context, calls the Emacs
20481 default `backward-word'. See the individual commands for more
20482 information.
20484 This function runs the hook `org-metaleft-hook' as a first step,
20485 and returns at first non-nil value."
20486 (interactive "P")
20487 (cond
20488 ((run-hook-with-args-until-success 'org-metaleft-hook))
20489 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20490 ((org-with-limited-levels
20491 (or (org-at-heading-p)
20492 (and (org-region-active-p)
20493 (save-excursion
20494 (goto-char (region-beginning))
20495 (org-at-heading-p)))))
20496 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20497 (call-interactively 'org-do-promote))
20498 ;; At an inline task.
20499 ((org-at-heading-p)
20500 (call-interactively 'org-inlinetask-promote))
20501 ((or (org-at-item-p)
20502 (and (org-region-active-p)
20503 (save-excursion
20504 (goto-char (region-beginning))
20505 (org-at-item-p))))
20506 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20507 (call-interactively 'org-outdent-item))
20508 (t (call-interactively 'backward-word))))
20510 (defun org-metaright (&optional arg)
20511 "Demote heading, list item at point or move table column right.
20513 In front of a drawer or a block keyword, indent it correctly.
20515 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20516 `org-indnet-drawer' or `org-indent-block' depending on context.
20517 With no specific context, calls the Emacs default `forward-word'.
20518 See the individual commands for more information.
20520 This function runs the hook `org-metaright-hook' as a first step,
20521 and returns at first non-nil value."
20522 (interactive "P")
20523 (cond
20524 ((run-hook-with-args-until-success 'org-metaright-hook))
20525 ((org-at-table-p) (call-interactively 'org-table-move-column))
20526 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20527 ((org-at-block-p) (call-interactively 'org-indent-block))
20528 ((org-with-limited-levels
20529 (or (org-at-heading-p)
20530 (and (org-region-active-p)
20531 (save-excursion
20532 (goto-char (region-beginning))
20533 (org-at-heading-p)))))
20534 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20535 (call-interactively 'org-do-demote))
20536 ;; At an inline task.
20537 ((org-at-heading-p)
20538 (call-interactively 'org-inlinetask-demote))
20539 ((or (org-at-item-p)
20540 (and (org-region-active-p)
20541 (save-excursion
20542 (goto-char (region-beginning))
20543 (org-at-item-p))))
20544 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20545 (call-interactively 'org-indent-item))
20546 (t (call-interactively 'forward-word))))
20548 (defun org-check-for-hidden (what)
20549 "Check if there are hidden headlines/items in the current visual line.
20550 WHAT can be either `headlines' or `items'. If the current line is
20551 an outline or item heading and it has a folded subtree below it,
20552 this function returns t, nil otherwise."
20553 (let ((re (cond
20554 ((eq what 'headlines) org-outline-regexp-bol)
20555 ((eq what 'items) (org-item-beginning-re))
20556 (t (error "This should not happen"))))
20557 beg end)
20558 (save-excursion
20559 (catch 'exit
20560 (unless (org-region-active-p)
20561 (setq beg (point-at-bol))
20562 (beginning-of-line 2)
20563 (while (and (not (eobp)) ;; this is like `next-line'
20564 (get-char-property (1- (point)) 'invisible))
20565 (beginning-of-line 2))
20566 (setq end (point))
20567 (goto-char beg)
20568 (goto-char (point-at-eol))
20569 (setq end (max end (point)))
20570 (while (re-search-forward re end t)
20571 (if (get-char-property (match-beginning 0) 'invisible)
20572 (throw 'exit t))))
20573 nil))))
20575 (defun org-metaup (&optional arg)
20576 "Move subtree up or move table row up.
20577 Calls `org-move-subtree-up' or `org-table-move-row' or
20578 `org-move-item-up', depending on context. See the individual commands
20579 for more information."
20580 (interactive "P")
20581 (cond
20582 ((run-hook-with-args-until-success 'org-metaup-hook))
20583 ((org-region-active-p)
20584 (let* ((a (min (region-beginning) (region-end)))
20585 (b (1- (max (region-beginning) (region-end))))
20586 (c (save-excursion (goto-char a)
20587 (move-beginning-of-line 0)))
20588 (d (save-excursion (goto-char a)
20589 (move-end-of-line 0) (point))))
20590 (transpose-regions a b c d)
20591 (goto-char c)))
20592 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20593 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20594 ((org-at-item-p) (call-interactively 'org-move-item-up))
20595 (t (org-drag-element-backward))))
20597 (defun org-metadown (&optional arg)
20598 "Move subtree down or move table row down.
20599 Calls `org-move-subtree-down' or `org-table-move-row' or
20600 `org-move-item-down', depending on context. See the individual
20601 commands for more information."
20602 (interactive "P")
20603 (cond
20604 ((run-hook-with-args-until-success 'org-metadown-hook))
20605 ((org-region-active-p)
20606 (let* ((a (min (region-beginning) (region-end)))
20607 (b (max (region-beginning) (region-end)))
20608 (c (save-excursion (goto-char b)
20609 (move-beginning-of-line 1)))
20610 (d (save-excursion (goto-char b)
20611 (move-end-of-line 1) (1+ (point)))))
20612 (transpose-regions a b c d)
20613 (goto-char d)))
20614 ((org-at-table-p) (call-interactively 'org-table-move-row))
20615 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20616 ((org-at-item-p) (call-interactively 'org-move-item-down))
20617 (t (org-drag-element-forward))))
20619 (defun org-shiftup (&optional arg)
20620 "Increase item in timestamp or increase priority of current headline.
20621 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20622 depending on context. See the individual commands for more information."
20623 (interactive "P")
20624 (cond
20625 ((run-hook-with-args-until-success 'org-shiftup-hook))
20626 ((and org-support-shift-select (org-region-active-p))
20627 (org-call-for-shift-select 'previous-line))
20628 ((org-at-timestamp-p t)
20629 (call-interactively (if org-edit-timestamp-down-means-later
20630 'org-timestamp-down 'org-timestamp-up)))
20631 ((and (not (eq org-support-shift-select 'always))
20632 org-enable-priority-commands
20633 (org-at-heading-p))
20634 (call-interactively 'org-priority-up))
20635 ((and (not org-support-shift-select) (org-at-item-p))
20636 (call-interactively 'org-previous-item))
20637 ((org-clocktable-try-shift 'up arg))
20638 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20639 (org-support-shift-select
20640 (org-call-for-shift-select 'previous-line))
20641 (t (org-shiftselect-error))))
20643 (defun org-shiftdown (&optional arg)
20644 "Decrease item in timestamp or decrease priority of current headline.
20645 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20646 depending on context. See the individual commands for more information."
20647 (interactive "P")
20648 (cond
20649 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20650 ((and org-support-shift-select (org-region-active-p))
20651 (org-call-for-shift-select 'next-line))
20652 ((org-at-timestamp-p t)
20653 (call-interactively (if org-edit-timestamp-down-means-later
20654 'org-timestamp-up 'org-timestamp-down)))
20655 ((and (not (eq org-support-shift-select 'always))
20656 org-enable-priority-commands
20657 (org-at-heading-p))
20658 (call-interactively 'org-priority-down))
20659 ((and (not org-support-shift-select) (org-at-item-p))
20660 (call-interactively 'org-next-item))
20661 ((org-clocktable-try-shift 'down arg))
20662 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20663 (org-support-shift-select
20664 (org-call-for-shift-select 'next-line))
20665 (t (org-shiftselect-error))))
20667 (defun org-shiftright (&optional arg)
20668 "Cycle the thing at point or in the current line, depending on context.
20669 Depending on context, this does one of the following:
20671 - switch a timestamp at point one day into the future
20672 - on a headline, switch to the next TODO keyword.
20673 - on an item, switch entire list to the next bullet type
20674 - on a property line, switch to the next allowed value
20675 - on a clocktable definition line, move time block into the future"
20676 (interactive "P")
20677 (cond
20678 ((run-hook-with-args-until-success 'org-shiftright-hook))
20679 ((and org-support-shift-select (org-region-active-p))
20680 (org-call-for-shift-select 'forward-char))
20681 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20682 ((and (not (eq org-support-shift-select 'always))
20683 (org-at-heading-p))
20684 (let ((org-inhibit-logging
20685 (not org-treat-S-cursor-todo-selection-as-state-change))
20686 (org-inhibit-blocking
20687 (not org-treat-S-cursor-todo-selection-as-state-change)))
20688 (org-call-with-arg 'org-todo 'right)))
20689 ((or (and org-support-shift-select
20690 (not (eq org-support-shift-select 'always))
20691 (org-at-item-bullet-p))
20692 (and (not org-support-shift-select) (org-at-item-p)))
20693 (org-call-with-arg 'org-cycle-list-bullet nil))
20694 ((and (not (eq org-support-shift-select 'always))
20695 (org-at-property-p))
20696 (call-interactively 'org-property-next-allowed-value))
20697 ((org-clocktable-try-shift 'right arg))
20698 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20699 (org-support-shift-select
20700 (org-call-for-shift-select 'forward-char))
20701 (t (org-shiftselect-error))))
20703 (defun org-shiftleft (&optional arg)
20704 "Cycle the thing at point or in the current line, depending on context.
20705 Depending on context, this does one of the following:
20707 - switch a timestamp at point one day into the past
20708 - on a headline, switch to the previous TODO keyword.
20709 - on an item, switch entire list to the previous bullet type
20710 - on a property line, switch to the previous allowed value
20711 - on a clocktable definition line, move time block into the past"
20712 (interactive "P")
20713 (cond
20714 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20715 ((and org-support-shift-select (org-region-active-p))
20716 (org-call-for-shift-select 'backward-char))
20717 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20718 ((and (not (eq org-support-shift-select 'always))
20719 (org-at-heading-p))
20720 (let ((org-inhibit-logging
20721 (not org-treat-S-cursor-todo-selection-as-state-change))
20722 (org-inhibit-blocking
20723 (not org-treat-S-cursor-todo-selection-as-state-change)))
20724 (org-call-with-arg 'org-todo 'left)))
20725 ((or (and org-support-shift-select
20726 (not (eq org-support-shift-select 'always))
20727 (org-at-item-bullet-p))
20728 (and (not org-support-shift-select) (org-at-item-p)))
20729 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20730 ((and (not (eq org-support-shift-select 'always))
20731 (org-at-property-p))
20732 (call-interactively 'org-property-previous-allowed-value))
20733 ((org-clocktable-try-shift 'left arg))
20734 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20735 (org-support-shift-select
20736 (org-call-for-shift-select 'backward-char))
20737 (t (org-shiftselect-error))))
20739 (defun org-shiftcontrolright ()
20740 "Switch to next TODO set."
20741 (interactive)
20742 (cond
20743 ((and org-support-shift-select (org-region-active-p))
20744 (org-call-for-shift-select 'forward-word))
20745 ((and (not (eq org-support-shift-select 'always))
20746 (org-at-heading-p))
20747 (org-call-with-arg 'org-todo 'nextset))
20748 (org-support-shift-select
20749 (org-call-for-shift-select 'forward-word))
20750 (t (org-shiftselect-error))))
20752 (defun org-shiftcontrolleft ()
20753 "Switch to previous TODO set."
20754 (interactive)
20755 (cond
20756 ((and org-support-shift-select (org-region-active-p))
20757 (org-call-for-shift-select 'backward-word))
20758 ((and (not (eq org-support-shift-select 'always))
20759 (org-at-heading-p))
20760 (org-call-with-arg 'org-todo 'previousset))
20761 (org-support-shift-select
20762 (org-call-for-shift-select 'backward-word))
20763 (t (org-shiftselect-error))))
20765 (defun org-shiftcontrolup (&optional n)
20766 "Change timestamps synchronously up in CLOCK log lines.
20767 Optional argument N tells to change by that many units."
20768 (interactive "P")
20769 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20770 (let (org-support-shift-select)
20771 (org-clock-timestamps-up n))
20772 (user-error "Not at a clock log")))
20774 (defun org-shiftcontroldown (&optional n)
20775 "Change timestamps synchronously down in CLOCK log lines.
20776 Optional argument N tells to change by that many units."
20777 (interactive "P")
20778 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20779 (let (org-support-shift-select)
20780 (org-clock-timestamps-down n))
20781 (user-error "Not at a clock log")))
20783 (defun org-increase-number-at-point (&optional inc)
20784 "Increment the number at point.
20785 With an optional prefix numeric argument INC, increment using
20786 this numeric value."
20787 (interactive "p")
20788 (if (not (number-at-point))
20789 (user-error "Not on a number")
20790 (unless inc (setq inc 1))
20791 (let ((pos (point))
20792 (beg (skip-chars-backward "-+^/*0-9eE."))
20793 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20794 (setq nap (buffer-substring-no-properties
20795 (+ pos beg) (+ pos beg end)))
20796 (delete-region (+ pos beg) (+ pos beg end))
20797 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20798 (when (org-at-table-p)
20799 (org-table-align)
20800 (org-table-end-of-field 1))))
20802 (defun org-decrease-number-at-point (&optional inc)
20803 "Decrement the number at point.
20804 With an optional prefix numeric argument INC, decrement using
20805 this numeric value."
20806 (interactive "p")
20807 (org-increase-number-at-point (- inc)))
20809 (defun org-ctrl-c-ret ()
20810 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20811 (interactive)
20812 (cond
20813 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20814 (t (call-interactively 'org-insert-heading))))
20816 (defun org-find-visible ()
20817 (let ((s (point)))
20818 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20819 (get-char-property s 'invisible)))
20821 (defun org-find-invisible ()
20822 (let ((s (point)))
20823 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20824 (not (get-char-property s 'invisible))))
20827 (defun org-copy-visible (beg end)
20828 "Copy the visible parts of the region."
20829 (interactive "r")
20830 (let (snippets s)
20831 (save-excursion
20832 (save-restriction
20833 (narrow-to-region beg end)
20834 (setq s (goto-char (point-min)))
20835 (while (not (= (point) (point-max)))
20836 (goto-char (org-find-invisible))
20837 (push (buffer-substring s (point)) snippets)
20838 (setq s (goto-char (org-find-visible))))))
20839 (kill-new (apply 'concat (nreverse snippets)))))
20841 (defun org-copy-special ()
20842 "Copy region in table or copy current subtree.
20843 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20844 See the individual commands for more information."
20845 (interactive)
20846 (call-interactively
20847 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20849 (defun org-cut-special ()
20850 "Cut region in table or cut current subtree.
20851 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20852 See the individual commands for more information."
20853 (interactive)
20854 (call-interactively
20855 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20857 (defun org-paste-special (arg)
20858 "Paste rectangular region into table, or past subtree relative to level.
20859 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20860 See the individual commands for more information."
20861 (interactive "P")
20862 (if (org-at-table-p)
20863 (org-table-paste-rectangle)
20864 (org-paste-subtree arg)))
20866 (defsubst org-in-fixed-width-region-p ()
20867 "Is point in a fixed-width region?"
20868 (save-match-data
20869 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20871 (defun org-edit-special (&optional arg)
20872 "Call a special editor for the element at point.
20873 When at a table, call the formula editor with `org-table-edit-formulas'.
20874 When in a source code block, call `org-edit-src-code'.
20875 When in a fixed-width region, call `org-edit-fixed-width-region'.
20876 When in an export block, call `org-edit-export-block'.
20877 When at an #+INCLUDE keyword, visit the included file.
20878 When at a footnote reference, call `org-edit-footnote-reference'
20879 On a link, call `ffap' to visit the link at point.
20880 Otherwise, return a user error."
20881 (interactive "P")
20882 (let ((element (org-element-at-point)))
20883 (assert (not buffer-read-only) nil
20884 "Buffer is read-only: %s" (buffer-name))
20885 (case (org-element-type element)
20886 (src-block
20887 (if (not arg) (org-edit-src-code)
20888 (let* ((info (org-babel-get-src-block-info))
20889 (lang (nth 0 info))
20890 (params (nth 2 info))
20891 (session (cdr (assq :session params))))
20892 (if (not session) (org-edit-src-code)
20893 ;; At a src-block with a session and function called with
20894 ;; an ARG: switch to the buffer related to the inferior
20895 ;; process.
20896 (switch-to-buffer
20897 (funcall (intern (concat "org-babel-prep-session:" lang))
20898 session params))))))
20899 (keyword
20900 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20901 (org-open-link-from-string
20902 (format "[[%s]]"
20903 (expand-file-name
20904 (let ((value (org-element-property :value element)))
20905 (cond ((not (org-string-nw-p value))
20906 (user-error "No file to edit"))
20907 ((string-match "\\`\"\\(.*?\\)\"" value)
20908 (match-string 1 value))
20909 ((string-match "\\`[^ \t\"]\\S-*" value)
20910 (match-string 0 value))
20911 (t (user-error "No valid file specified")))))))
20912 (user-error "No special environment to edit here")))
20913 (table
20914 (if (eq (org-element-property :type element) 'table.el)
20915 (org-edit-table.el)
20916 (call-interactively 'org-table-edit-formulas)))
20917 ;; Only Org tables contain `table-row' type elements.
20918 (table-row (call-interactively 'org-table-edit-formulas))
20919 (example-block (org-edit-src-code))
20920 (export-block (org-edit-export-block))
20921 (fixed-width (org-edit-fixed-width-region))
20922 (otherwise
20923 ;; No notable element at point. Though, we may be at a link or
20924 ;; a footnote reference, which are objects. Thus, scan deeper.
20925 (let ((context (org-element-context element)))
20926 (case (org-element-type context)
20927 (link (call-interactively #'ffap))
20928 (footnote-reference (org-edit-footnote-reference))
20929 (t (user-error "No special environment to edit here"))))))))
20931 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20932 (defun org-ctrl-c-ctrl-c (&optional arg)
20933 "Set tags in headline, or update according to changed information at point.
20935 This command does many different things, depending on context:
20937 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20938 this is what we do.
20940 - If the cursor is on a statistics cookie, update it.
20942 - If the cursor is in a headline, prompt for tags and insert them
20943 into the current line, aligned to `org-tags-column'. When called
20944 with prefix arg, realign all tags in the current buffer.
20946 - If the cursor is in one of the special #+KEYWORD lines, this
20947 triggers scanning the buffer for these lines and updating the
20948 information.
20950 - If the cursor is inside a table, realign the table. This command
20951 works even if the automatic table editor has been turned off.
20953 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20954 the entire table.
20956 - If the cursor is at a footnote reference or definition, jump to
20957 the corresponding definition or references, respectively.
20959 - If the cursor is a the beginning of a dynamic block, update it.
20961 - If the current buffer is a capture buffer, close note and file it.
20963 - If the cursor is on a <<<target>>>, update radio targets and
20964 corresponding links in this buffer.
20966 - If the cursor is on a numbered item in a plain list, renumber the
20967 ordered list.
20969 - If the cursor is on a checkbox, toggle it.
20971 - If the cursor is on a code block, evaluate it. The variable
20972 `org-confirm-babel-evaluate' can be used to control prompting
20973 before code block evaluation, by default every code block
20974 evaluation requires confirmation. Code block evaluation can be
20975 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20976 (interactive "P")
20977 (cond
20978 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20979 org-occur-highlights)
20980 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20981 (org-remove-occur-highlights)
20982 (message "Temporary highlights/overlays removed from current buffer"))
20983 ((and (local-variable-p 'org-finish-function (current-buffer))
20984 (fboundp org-finish-function))
20985 (funcall org-finish-function))
20986 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20988 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20989 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20990 (user-error "C-c C-c can do nothing useful at this location"))
20991 (let* ((context (org-element-context))
20992 (type (org-element-type context)))
20993 (case type
20994 ;; When at a link, act according to the parent instead.
20995 (link (setq context (org-element-property :parent context))
20996 (setq type (org-element-type context)))
20997 ;; Unsupported object types: refer to the first supported
20998 ;; element or object containing it.
20999 ((bold code entity export-snippet inline-babel-call inline-src-block
21000 italic latex-fragment line-break macro strike-through subscript
21001 superscript underline verbatim)
21002 (setq context
21003 (org-element-lineage
21004 context '(radio-target paragraph verse-block table-cell)))))
21005 ;; For convenience: at the first line of a paragraph on the
21006 ;; same line as an item, apply function on that item instead.
21007 (when (eq type 'paragraph)
21008 (let ((parent (org-element-property :parent context)))
21009 (when (and (eq (org-element-type parent) 'item)
21010 (= (line-beginning-position)
21011 (org-element-property :begin parent)))
21012 (setq context parent type 'item))))
21013 ;; Act according to type of element or object at point.
21014 (case type
21015 (clock (org-clock-update-time-maybe))
21016 (dynamic-block
21017 (save-excursion
21018 (goto-char (org-element-property :post-affiliated context))
21019 (org-update-dblock)))
21020 (footnote-definition
21021 (goto-char (org-element-property :post-affiliated context))
21022 (call-interactively 'org-footnote-action))
21023 (footnote-reference (call-interactively 'org-footnote-action))
21024 ((headline inlinetask)
21025 (save-excursion (goto-char (org-element-property :begin context))
21026 (call-interactively 'org-set-tags)))
21027 (item
21028 ;; At an item: a double C-u set checkbox to "[-]"
21029 ;; unconditionally, whereas a single one will toggle its
21030 ;; presence. Without an universal argument, if the item
21031 ;; has a checkbox, toggle it. Otherwise repair the list.
21032 (let* ((box (org-element-property :checkbox context))
21033 (struct (org-element-property :structure context))
21034 (old-struct (copy-tree struct))
21035 (parents (org-list-parents-alist struct))
21036 (prevs (org-list-prevs-alist struct))
21037 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21038 (org-list-set-checkbox
21039 (org-element-property :begin context) struct
21040 (cond ((equal arg '(16)) "[-]")
21041 ((and (not box) (equal arg '(4))) "[ ]")
21042 ((or (not box) (equal arg '(4))) nil)
21043 ((eq box 'on) "[ ]")
21044 (t "[X]")))
21045 ;; Mimic `org-list-write-struct' but with grabbing
21046 ;; a return value from `org-list-struct-fix-box'.
21047 (org-list-struct-fix-ind struct parents 2)
21048 (org-list-struct-fix-item-end struct)
21049 (org-list-struct-fix-bul struct prevs)
21050 (org-list-struct-fix-ind struct parents)
21051 (let ((block-item
21052 (org-list-struct-fix-box struct parents prevs orderedp)))
21053 (if (and box (equal struct old-struct))
21054 (if (equal arg '(16))
21055 (message "Checkboxes already reset")
21056 (user-error "Cannot toggle this checkbox: %s"
21057 (if (eq box 'on)
21058 "all subitems checked"
21059 "unchecked subitems")))
21060 (org-list-struct-apply-struct struct old-struct)
21061 (org-update-checkbox-count-maybe))
21062 (when block-item
21063 (message "Checkboxes were removed due to empty box at line %d"
21064 (org-current-line block-item))))))
21065 (keyword
21066 (let ((org-inhibit-startup-visibility-stuff t)
21067 (org-startup-align-all-tables nil))
21068 (when (boundp 'org-table-coordinate-overlays)
21069 (mapc 'delete-overlay org-table-coordinate-overlays)
21070 (setq org-table-coordinate-overlays nil))
21071 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21072 (message "Local setup has been refreshed"))
21073 (plain-list
21074 ;; At a plain list, with a double C-u argument, set
21075 ;; checkboxes of each item to "[-]", whereas a single one
21076 ;; will toggle their presence according to the state of the
21077 ;; first item in the list. Without an argument, repair the
21078 ;; list.
21079 (let* ((begin (org-element-property :contents-begin context))
21080 (beginm (move-marker (make-marker) begin))
21081 (struct (org-element-property :structure context))
21082 (old-struct (copy-tree struct))
21083 (first-box (save-excursion
21084 (goto-char begin)
21085 (looking-at org-list-full-item-re)
21086 (match-string-no-properties 3)))
21087 (new-box (cond ((equal arg '(16)) "[-]")
21088 ((equal arg '(4)) (unless first-box "[ ]"))
21089 ((equal first-box "[X]") "[ ]")
21090 (t "[X]"))))
21091 (cond
21092 (arg
21093 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21094 (org-list-get-all-items
21095 begin struct (org-list-prevs-alist struct))))
21096 ((and first-box (eq (point) begin))
21097 ;; For convenience, when point is at bol on the first
21098 ;; item of the list and no argument is provided, simply
21099 ;; toggle checkbox of that item, if any.
21100 (org-list-set-checkbox begin struct new-box)))
21101 (org-list-write-struct
21102 struct (org-list-parents-alist struct) old-struct)
21103 (org-update-checkbox-count-maybe)
21104 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21105 ((property-drawer node-property)
21106 (call-interactively 'org-property-action))
21107 ((radio-target target)
21108 (call-interactively 'org-update-radio-target-regexp))
21109 (statistics-cookie
21110 (call-interactively 'org-update-statistics-cookies))
21111 ((table table-cell table-row)
21112 ;; At a table, recalculate every field and align it. Also
21113 ;; send the table if necessary. If the table has
21114 ;; a `table.el' type, just give up. At a table row or
21115 ;; cell, maybe recalculate line but always align table.
21116 (if (eq (org-element-property :type context) 'table.el)
21117 (message "Use C-c ' to edit table.el tables")
21118 (let ((org-enable-table-editor t))
21119 (if (or (eq type 'table)
21120 ;; Check if point is at a TBLFM line.
21121 (and (eq type 'table-row)
21122 (= (point) (org-element-property :end context))))
21123 (save-excursion
21124 (if (org-at-TBLFM-p)
21125 (progn (require 'org-table)
21126 (org-table-calc-current-TBLFM))
21127 (goto-char (org-element-property :contents-begin context))
21128 (org-call-with-arg 'org-table-recalculate (or arg t))
21129 (orgtbl-send-table 'maybe)))
21130 (org-table-maybe-eval-formula)
21131 (cond (arg (call-interactively 'org-table-recalculate))
21132 ((org-table-maybe-recalculate-line))
21133 (t (org-table-align)))))))
21134 (timestamp (org-timestamp-change 0 'day))
21135 (otherwise
21136 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21137 (user-error
21138 "C-c C-c can do nothing useful at this location")))))))))
21140 (defun org-mode-restart ()
21141 (interactive)
21142 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21143 (funcall major-mode)
21144 (hack-local-variables)
21145 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21146 (org-indent-mode -1)))
21147 (message "%s restarted" major-mode))
21149 (defun org-kill-note-or-show-branches ()
21150 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21151 (interactive)
21152 (if (not org-finish-function)
21153 (progn
21154 (hide-subtree)
21155 (call-interactively 'show-branches))
21156 (let ((org-note-abort t))
21157 (funcall org-finish-function))))
21159 (defun org-delete-indentation (&optional ARG)
21160 "Join current line to previous and fix whitespace at join.
21162 If previous line is a headline add to headline title. Otherwise
21163 the function calls `delete-indentation'.
21165 With argument, join this line to following line."
21166 (interactive "*P")
21167 (if (save-excursion
21168 (if ARG (beginning-of-line)
21169 (forward-line -1))
21170 (looking-at org-complex-heading-regexp))
21171 ;; At headline.
21172 (let ((tags-column (when (match-beginning 5)
21173 (save-excursion (goto-char (match-beginning 5))
21174 (current-column))))
21175 (string (concat " " (progn (when ARG (forward-line 1))
21176 (org-trim (delete-and-extract-region
21177 (line-beginning-position)
21178 (line-end-position)))))))
21179 (unless (bobp) (delete-region (point) (1- (point))))
21180 (goto-char (or (match-end 4)
21181 (match-beginning 5)
21182 (match-end 0)))
21183 (skip-chars-backward " \t")
21184 (save-excursion (insert string))
21185 ;; Adjust alignment of tags.
21186 (when tags-column
21187 (org-align-tags-here (if org-auto-align-tags
21188 org-tags-column
21189 tags-column))))
21190 (delete-indentation ARG)))
21192 (defun org-open-line (n)
21193 "Insert a new row in tables, call `open-line' elsewhere.
21194 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21195 (interactive "*p")
21196 (cond
21197 ((not org-special-ctrl-o)
21198 (open-line n))
21199 ((org-at-table-p)
21200 (org-table-insert-row))
21202 (open-line n))))
21204 (defun org-return (&optional indent)
21205 "Goto next table row or insert a newline.
21207 Calls `org-table-next-row' or `newline', depending on context.
21209 When optional INDENT argument is non-nil, call
21210 `newline-and-indent' instead of `newline'.
21212 When `org-return-follows-link' is non-nil and point is on
21213 a timestamp or a link, call `org-open-at-point'. However, it
21214 will not happen if point is in a table or on a \"dead\"
21215 object (e.g., within a comment). In these case, you need to use
21216 `org-open-at-point' directly."
21217 (interactive)
21218 (if (and (not (bolp))
21219 (save-excursion (beginning-of-line)
21220 (looking-at org-complex-heading-regexp)))
21221 ;; At headline.
21222 (let ((tags-column (when (match-beginning 5)
21223 (save-excursion (goto-char (match-beginning 5))
21224 (current-column))))
21225 ;; Test if before or after headline title.
21226 (string (when (and (match-end 4)
21227 (not (or (< (point)
21228 (or (match-end 3)
21229 (match-end 2)
21230 (save-excursion
21231 (goto-char (match-beginning 4))
21232 (skip-chars-backward " \t")
21233 (point))))
21234 (and (match-beginning 5)
21235 (>= (point) (match-beginning 5))))))
21236 ;; Point is on headline keywords, tags or cookies. Do not break
21237 ;; them: add a newline after the headline instead.
21238 (org-string-nw-p
21239 (delete-and-extract-region (point) (match-end 4))))))
21240 ;; Adjust alignment of tags.
21241 (when (and tags-column string)
21242 (org-align-tags-here (if org-auto-align-tags
21243 org-tags-column
21244 tags-column)))
21245 (end-of-line)
21246 (org-show-entry)
21247 (if indent (newline-and-indent) (newline))
21248 (and string (save-excursion (insert (org-trim string)))))
21249 (let* ((context (if org-return-follows-link (org-element-context)
21250 (org-element-at-point)))
21251 (type (org-element-type context)))
21252 (cond
21253 ;; In a table, call `org-table-next-row'.
21254 ((or (and (eq type 'table)
21255 (>= (point) (org-element-property :contents-begin context))
21256 (< (point) (org-element-property :contents-end context)))
21257 (org-element-lineage context '(table-row table-cell) t))
21258 (org-table-justify-field-maybe)
21259 (call-interactively #'org-table-next-row))
21260 ;; On a link or a timestamp but not on white spaces after it,
21261 ;; call `org-open-line' if `org-return-follows-link' allows it.
21262 ((and org-return-follows-link
21263 (memq type '(link timestamp))
21264 (< (point)
21265 (save-excursion (goto-char (org-element-property :end context))
21266 (skip-chars-backward " \t")
21267 (point))))
21268 (call-interactively #'org-open-at-point))
21269 ;; In a list, make sure indenting keeps trailing text within.
21270 ((and indent
21271 (not (eolp))
21272 (org-element-lineage context '(item)))
21273 (let ((trailing-data
21274 (delete-and-extract-region (point) (line-end-position))))
21275 (newline-and-indent)
21276 (save-excursion (insert trailing-data))))
21277 (t (if indent (newline-and-indent) (newline)))))))
21279 (defun org-return-indent ()
21280 "Goto next table row or insert a newline and indent.
21281 Calls `org-table-next-row' or `newline-and-indent', depending on
21282 context. See the individual commands for more information."
21283 (interactive)
21284 (org-return t))
21286 (defun org-ctrl-c-star ()
21287 "Compute table, or change heading status of lines.
21288 Calls `org-table-recalculate' or `org-toggle-heading',
21289 depending on context."
21290 (interactive)
21291 (cond
21292 ((org-at-table-p)
21293 (call-interactively 'org-table-recalculate))
21295 ;; Convert all lines in region to list items
21296 (call-interactively 'org-toggle-heading))))
21298 (defun org-ctrl-c-minus ()
21299 "Insert separator line in table or modify bullet status of line.
21300 Also turns a plain line or a region of lines into list items.
21301 Calls `org-table-insert-hline', `org-toggle-item', or
21302 `org-cycle-list-bullet', depending on context."
21303 (interactive)
21304 (cond
21305 ((org-at-table-p)
21306 (call-interactively 'org-table-insert-hline))
21307 ((org-region-active-p)
21308 (call-interactively 'org-toggle-item))
21309 ((org-in-item-p)
21310 (call-interactively 'org-cycle-list-bullet))
21312 (call-interactively 'org-toggle-item))))
21314 (defun org-toggle-item (arg)
21315 "Convert headings or normal lines to items, items to normal lines.
21316 If there is no active region, only the current line is considered.
21318 If the first non blank line in the region is a headline, convert
21319 all headlines to items, shifting text accordingly.
21321 If it is an item, convert all items to normal lines.
21323 If it is normal text, change region into a list of items.
21324 With a prefix argument ARG, change the region in a single item."
21325 (interactive "P")
21326 (let ((shift-text
21327 (function
21328 ;; Shift text in current section to IND, from point to END.
21329 ;; The function leaves point to END line.
21330 (lambda (ind end)
21331 (let ((min-i 1000) (end (copy-marker end)))
21332 ;; First determine the minimum indentation (MIN-I) of
21333 ;; the text.
21334 (save-excursion
21335 (catch 'exit
21336 (while (< (point) end)
21337 (let ((i (org-get-indentation)))
21338 (cond
21339 ;; Skip blank lines and inline tasks.
21340 ((looking-at "^[ \t]*$"))
21341 ((looking-at org-outline-regexp-bol))
21342 ;; We can't find less than 0 indentation.
21343 ((zerop i) (throw 'exit (setq min-i 0)))
21344 ((< i min-i) (setq min-i i))))
21345 (forward-line))))
21346 ;; Then indent each line so that a line indented to
21347 ;; MIN-I becomes indented to IND. Ignore blank lines
21348 ;; and inline tasks in the process.
21349 (let ((delta (- ind min-i)))
21350 (while (< (point) end)
21351 (unless (or (looking-at "^[ \t]*$")
21352 (looking-at org-outline-regexp-bol))
21353 (org-indent-line-to (+ (org-get-indentation) delta)))
21354 (forward-line)))))))
21355 (skip-blanks
21356 (function
21357 ;; Return beginning of first non-blank line, starting from
21358 ;; line at POS.
21359 (lambda (pos)
21360 (save-excursion
21361 (goto-char pos)
21362 (skip-chars-forward " \r\t\n")
21363 (point-at-bol)))))
21364 beg end)
21365 ;; Determine boundaries of changes.
21366 (if (org-region-active-p)
21367 (setq beg (funcall skip-blanks (region-beginning))
21368 end (copy-marker (region-end)))
21369 (setq beg (funcall skip-blanks (point-at-bol))
21370 end (copy-marker (point-at-eol))))
21371 ;; Depending on the starting line, choose an action on the text
21372 ;; between BEG and END.
21373 (org-with-limited-levels
21374 (save-excursion
21375 (goto-char beg)
21376 (cond
21377 ;; Case 1. Start at an item: de-itemize. Note that it only
21378 ;; happens when a region is active: `org-ctrl-c-minus'
21379 ;; would call `org-cycle-list-bullet' otherwise.
21380 ((org-at-item-p)
21381 (while (< (point) end)
21382 (when (org-at-item-p)
21383 (skip-chars-forward " \t")
21384 (delete-region (point) (match-end 0)))
21385 (forward-line)))
21386 ;; Case 2. Start at an heading: convert to items.
21387 ((org-at-heading-p)
21388 (let* ((bul (org-list-bullet-string "-"))
21389 (bul-len (length bul))
21390 (done (org-entry-is-done-p))
21391 (todo (org-entry-is-todo-p))
21392 ;; Indentation of the first heading. It should be
21393 ;; relative to the indentation of its parent, if any.
21394 (start-ind (save-excursion
21395 (cond
21396 ((not org-adapt-indentation) 0)
21397 ((not (outline-previous-heading)) 0)
21398 (t (length (match-string 0))))))
21399 ;; Level of first heading. Further headings will be
21400 ;; compared to it to determine hierarchy in the list.
21401 (ref-level (org-reduced-level (org-outline-level))))
21402 (when (or done todo) (org-todo ""))
21403 (while (< (point) end)
21404 (let* ((level (org-reduced-level (org-outline-level)))
21405 (delta (max 0 (- level ref-level))))
21406 ;; If current headline is less indented than the first
21407 ;; one, set it as reference, in order to preserve
21408 ;; subtrees.
21409 (when (< level ref-level) (setq ref-level level))
21410 (replace-match bul t t)
21411 (org-indent-line-to (+ start-ind (* delta bul-len)))
21412 (when (or done todo)
21413 (let* ((struct (org-list-struct))
21414 (old (copy-tree struct)))
21415 (org-list-set-checkbox (line-beginning-position)
21416 struct
21417 (if done "[X]" "[ ]"))
21418 (org-list-write-struct struct
21419 (org-list-parents-alist struct)
21420 old)))
21421 ;; Ensure all text down to END (or SECTION-END) belongs
21422 ;; to the newly created item.
21423 (let ((section-end (save-excursion
21424 (or (outline-next-heading) (point)))))
21425 (forward-line)
21426 (funcall shift-text
21427 (+ start-ind (* (1+ delta) bul-len))
21428 (min end section-end)))))))
21429 ;; Case 3. Normal line with ARG: make the first line of region
21430 ;; an item, and shift indentation of others lines to
21431 ;; set them as item's body.
21432 (arg (let* ((bul (org-list-bullet-string "-"))
21433 (bul-len (length bul))
21434 (ref-ind (org-get-indentation)))
21435 (skip-chars-forward " \t")
21436 (insert bul)
21437 (forward-line)
21438 (while (< (point) end)
21439 ;; Ensure that lines less indented than first one
21440 ;; still get included in item body.
21441 (funcall shift-text
21442 (+ ref-ind bul-len)
21443 (min end (save-excursion (or (outline-next-heading)
21444 (point)))))
21445 (forward-line))))
21446 ;; Case 4. Normal line without ARG: turn each non-item line
21447 ;; into an item.
21449 (while (< (point) end)
21450 (unless (or (org-at-heading-p) (org-at-item-p))
21451 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21452 (replace-match
21453 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21454 (forward-line))))))))
21456 (defun org-toggle-heading (&optional nstars)
21457 "Convert headings to normal text, or items or text to headings.
21458 If there is no active region, only convert the current line.
21460 With a \\[universal-argument] prefix, convert the whole list at
21461 point into heading.
21463 In a region:
21465 - If the first non blank line is a headline, remove the stars
21466 from all headlines in the region.
21468 - If it is a normal line, turn each and every normal line (i.e.,
21469 not an heading or an item) in the region into headings. If you
21470 want to convert only the first line of this region, use one
21471 universal prefix argument.
21473 - If it is a plain list item, turn all plain list items into headings.
21475 When converting a line into a heading, the number of stars is chosen
21476 such that the lines become children of the current entry. However,
21477 when a numeric prefix argument is given, its value determines the
21478 number of stars to add."
21479 (interactive "P")
21480 (let ((skip-blanks
21481 (function
21482 ;; Return beginning of first non-blank line, starting from
21483 ;; line at POS.
21484 (lambda (pos)
21485 (save-excursion
21486 (goto-char pos)
21487 (while (org-at-comment-p) (forward-line))
21488 (skip-chars-forward " \r\t\n")
21489 (point-at-bol)))))
21490 beg end toggled)
21491 ;; Determine boundaries of changes. If a universal prefix has
21492 ;; been given, put the list in a region. If region ends at a bol,
21493 ;; do not consider the last line to be in the region.
21495 (when (and current-prefix-arg (org-at-item-p))
21496 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21497 (org-mark-element))
21499 (if (org-region-active-p)
21500 (setq beg (funcall skip-blanks (region-beginning))
21501 end (copy-marker (save-excursion
21502 (goto-char (region-end))
21503 (if (bolp) (point) (point-at-eol)))))
21504 (setq beg (funcall skip-blanks (point-at-bol))
21505 end (copy-marker (point-at-eol))))
21506 ;; Ensure inline tasks don't count as headings.
21507 (org-with-limited-levels
21508 (save-excursion
21509 (goto-char beg)
21510 (cond
21511 ;; Case 1. Started at an heading: de-star headings.
21512 ((org-at-heading-p)
21513 (while (< (point) end)
21514 (when (org-at-heading-p t)
21515 (looking-at org-outline-regexp) (replace-match "")
21516 (setq toggled t))
21517 (forward-line)))
21518 ;; Case 2. Started at an item: change items into headlines.
21519 ;; One star will be added by `org-list-to-subtree'.
21520 ((org-at-item-p)
21521 (while (< (point) end)
21522 (when (org-at-item-p)
21523 ;; Pay attention to cases when region ends before list.
21524 (let* ((struct (org-list-struct))
21525 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21526 (save-restriction
21527 (narrow-to-region (point) list-end)
21528 (insert (org-list-to-subtree (org-list-parse-list t)))))
21529 (setq toggled t))
21530 (forward-line)))
21531 ;; Case 3. Started at normal text: make every line an heading,
21532 ;; skipping headlines and items.
21533 (t (let* ((stars
21534 (make-string
21535 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21536 (add-stars
21537 (cond (nstars "") ; stars from prefix only
21538 ((equal stars "") "*") ; before first heading
21539 (org-odd-levels-only "**") ; inside heading, odd
21540 (t "*"))) ; inside heading, oddeven
21541 (rpl (concat stars add-stars " "))
21542 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21543 (while (< (point) (if (equal nstars '(4)) lend end))
21544 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21545 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21546 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21547 (forward-line)))))))
21548 (unless toggled (message "Cannot toggle heading from here"))))
21550 (defun org-meta-return (&optional arg)
21551 "Insert a new heading or wrap a region in a table.
21552 Calls `org-insert-heading' or `org-table-wrap-region', depending
21553 on context. See the individual commands for more information."
21554 (interactive "P")
21555 (org-check-before-invisible-edit 'insert)
21556 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21557 (let* ((element (org-element-at-point))
21558 (type (org-element-type element)))
21559 (when (eq type 'table-row)
21560 (setq element (org-element-property :parent element))
21561 (setq type 'table))
21562 (if (and (eq type 'table)
21563 (eq (org-element-property :type element) 'org)
21564 (>= (point) (org-element-property :contents-begin element))
21565 (< (point) (org-element-property :contents-end element)))
21566 (call-interactively 'org-table-wrap-region)
21567 (call-interactively 'org-insert-heading)))))
21569 ;;; Menu entries
21571 (defsubst org-in-subtree-not-table-p ()
21572 "Are we in a subtree and not in a table?"
21573 (and (not (org-before-first-heading-p))
21574 (not (org-at-table-p))))
21576 ;; Define the Org-mode menus
21577 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21578 '("Tbl"
21579 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21580 ["Next Field" org-cycle (org-at-table-p)]
21581 ["Previous Field" org-shifttab (org-at-table-p)]
21582 ["Next Row" org-return (org-at-table-p)]
21583 "--"
21584 ["Blank Field" org-table-blank-field (org-at-table-p)]
21585 ["Edit Field" org-table-edit-field (org-at-table-p)]
21586 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21587 "--"
21588 ("Column"
21589 ["Move Column Left" org-metaleft (org-at-table-p)]
21590 ["Move Column Right" org-metaright (org-at-table-p)]
21591 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21592 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21593 ("Row"
21594 ["Move Row Up" org-metaup (org-at-table-p)]
21595 ["Move Row Down" org-metadown (org-at-table-p)]
21596 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21597 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21598 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21599 "--"
21600 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21601 ("Rectangle"
21602 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21603 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21604 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21605 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21606 "--"
21607 ("Calculate"
21608 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21609 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21610 ["Edit Formulas" org-edit-special (org-at-table-p)]
21611 "--"
21612 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21613 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21614 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21615 "--"
21616 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21617 "--"
21618 ["Sum Column/Rectangle" org-table-sum
21619 (or (org-at-table-p) (org-region-active-p))]
21620 ["Which Column?" org-table-current-column (org-at-table-p)])
21621 ["Debug Formulas"
21622 org-table-toggle-formula-debugger
21623 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21624 ["Show Col/Row Numbers"
21625 org-table-toggle-coordinate-overlays
21626 :style toggle
21627 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21628 "--"
21629 ["Create" org-table-create (and (not (org-at-table-p))
21630 org-enable-table-editor)]
21631 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21632 ["Import from File" org-table-import (not (org-at-table-p))]
21633 ["Export to File" org-table-export (org-at-table-p)]
21634 "--"
21635 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21636 "--"
21637 ("Plot"
21638 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21639 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21641 (easy-menu-define org-org-menu org-mode-map "Org menu"
21642 '("Org"
21643 ("Show/Hide"
21644 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21645 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21646 ["Sparse Tree..." org-sparse-tree t]
21647 ["Reveal Context" org-reveal t]
21648 ["Show All" show-all t]
21649 "--"
21650 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21651 "--"
21652 ["New Heading" org-insert-heading t]
21653 ("Navigate Headings"
21654 ["Up" outline-up-heading t]
21655 ["Next" outline-next-visible-heading t]
21656 ["Previous" outline-previous-visible-heading t]
21657 ["Next Same Level" outline-forward-same-level t]
21658 ["Previous Same Level" outline-backward-same-level t]
21659 "--"
21660 ["Jump" org-goto t])
21661 ("Edit Structure"
21662 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21663 "--"
21664 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21665 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21666 "--"
21667 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21668 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21669 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21670 "--"
21671 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21672 "--"
21673 ["Copy visible text" org-copy-visible t]
21674 "--"
21675 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21676 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21677 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21678 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21679 "--"
21680 ["Sort Region/Children" org-sort t]
21681 "--"
21682 ["Convert to odd levels" org-convert-to-odd-levels t]
21683 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21684 ("Editing"
21685 ["Emphasis..." org-emphasize t]
21686 ["Edit Source Example" org-edit-special t]
21687 "--"
21688 ["Footnote new/jump" org-footnote-action t]
21689 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21690 ("Archive"
21691 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21692 "--"
21693 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21694 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21695 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21697 "--"
21698 ("Hyperlinks"
21699 ["Store Link (Global)" org-store-link t]
21700 ["Find existing link to here" org-occur-link-in-agenda-files t]
21701 ["Insert Link" org-insert-link t]
21702 ["Follow Link" org-open-at-point t]
21703 "--"
21704 ["Next link" org-next-link t]
21705 ["Previous link" org-previous-link t]
21706 "--"
21707 ["Descriptive Links"
21708 org-toggle-link-display
21709 :style radio
21710 :selected org-descriptive-links
21712 ["Literal Links"
21713 org-toggle-link-display
21714 :style radio
21715 :selected (not org-descriptive-links)])
21716 "--"
21717 ("TODO Lists"
21718 ["TODO/DONE/-" org-todo t]
21719 ("Select keyword"
21720 ["Next keyword" org-shiftright (org-at-heading-p)]
21721 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21722 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21723 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21724 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21725 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21726 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21727 "--"
21728 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21729 :selected org-enforce-todo-dependencies :style toggle :active t]
21730 "Settings for tree at point"
21731 ["Do Children sequentially" org-toggle-ordered-property :style radio
21732 :selected (org-entry-get nil "ORDERED")
21733 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21734 ["Do Children parallel" org-toggle-ordered-property :style radio
21735 :selected (not (org-entry-get nil "ORDERED"))
21736 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21737 "--"
21738 ["Set Priority" org-priority t]
21739 ["Priority Up" org-shiftup t]
21740 ["Priority Down" org-shiftdown t]
21741 "--"
21742 ["Get news from all feeds" org-feed-update-all t]
21743 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21744 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21745 ("TAGS and Properties"
21746 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21747 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21748 "--"
21749 ["Set property" org-set-property (not (org-before-first-heading-p))]
21750 ["Column view of properties" org-columns t]
21751 ["Insert Column View DBlock" org-insert-columns-dblock t])
21752 ("Dates and Scheduling"
21753 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21754 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21755 ("Change Date"
21756 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21757 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21758 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21759 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21760 ["Compute Time Range" org-evaluate-time-range t]
21761 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21762 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21763 "--"
21764 ["Custom time format" org-toggle-time-stamp-overlays
21765 :style radio :selected org-display-custom-times]
21766 "--"
21767 ["Goto Calendar" org-goto-calendar t]
21768 ["Date from Calendar" org-date-from-calendar t]
21769 "--"
21770 ["Start/Restart Timer" org-timer-start t]
21771 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21772 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21773 ["Insert Timer String" org-timer t]
21774 ["Insert Timer Item" org-timer-item t])
21775 ("Logging work"
21776 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21777 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21778 ["Clock out" org-clock-out t]
21779 ["Clock cancel" org-clock-cancel t]
21780 "--"
21781 ["Mark as default task" org-clock-mark-default-task t]
21782 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21783 ["Goto running clock" org-clock-goto t]
21784 "--"
21785 ["Display times" org-clock-display t]
21786 ["Create clock table" org-clock-report t]
21787 "--"
21788 ["Record DONE time"
21789 (progn (setq org-log-done (not org-log-done))
21790 (message "Switching to %s will %s record a timestamp"
21791 (car org-done-keywords)
21792 (if org-log-done "automatically" "not")))
21793 :style toggle :selected org-log-done])
21794 "--"
21795 ["Agenda Command..." org-agenda t]
21796 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21797 ("File List for Agenda")
21798 ("Special views current file"
21799 ["TODO Tree" org-show-todo-tree t]
21800 ["Check Deadlines" org-check-deadlines t]
21801 ["Timeline" org-timeline t]
21802 ["Tags/Property tree" org-match-sparse-tree t])
21803 "--"
21804 ["Export/Publish..." org-export-dispatch t]
21805 ("LaTeX"
21806 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21807 :selected org-cdlatex-mode]
21808 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21809 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21810 ["Modify math symbol" org-cdlatex-math-modify
21811 (org-inside-LaTeX-fragment-p)]
21812 ["Insert citation" org-reftex-citation t]
21813 "--"
21814 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21815 "--"
21816 ("MobileOrg"
21817 ["Push Files and Views" org-mobile-push t]
21818 ["Get Captured and Flagged" org-mobile-pull t]
21819 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21820 "--"
21821 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21822 "--"
21823 ("Documentation"
21824 ["Show Version" org-version t]
21825 ["Info Documentation" org-info t])
21826 ("Customize"
21827 ["Browse Org Group" org-customize t]
21828 "--"
21829 ["Expand This Menu" org-create-customize-menu
21830 (fboundp 'customize-menu-create)])
21831 ["Send bug report" org-submit-bug-report t]
21832 "--"
21833 ("Refresh/Reload"
21834 ["Refresh setup current buffer" org-mode-restart t]
21835 ["Reload Org (after update)" org-reload t]
21836 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21839 (defun org-info (&optional node)
21840 "Read documentation for Org-mode in the info system.
21841 With optional NODE, go directly to that node."
21842 (interactive)
21843 (info (format "(org)%s" (or node ""))))
21845 ;;;###autoload
21846 (defun org-submit-bug-report ()
21847 "Submit a bug report on Org-mode via mail.
21849 Don't hesitate to report any problems or inaccurate documentation.
21851 If you don't have setup sending mail from (X)Emacs, please copy the
21852 output buffer into your mail program, as it gives us important
21853 information about your Org-mode version and configuration."
21854 (interactive)
21855 (require 'reporter)
21856 (org-load-modules-maybe)
21857 (org-require-autoloaded-modules)
21858 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21859 (reporter-submit-bug-report
21860 "emacs-orgmode@gnu.org"
21861 (org-version nil 'full)
21862 (let (list)
21863 (save-window-excursion
21864 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21865 (delete-other-windows)
21866 (erase-buffer)
21867 (insert "You are about to submit a bug report to the Org-mode mailing list.
21869 We would like to add your full Org-mode and Outline configuration to the
21870 bug report. This greatly simplifies the work of the maintainer and
21871 other experts on the mailing list.
21873 HOWEVER, some variables you have customized may contain private
21874 information. The names of customers, colleagues, or friends, might
21875 appear in the form of file names, tags, todo states, or search strings.
21876 If you answer yes to the prompt, you might want to check and remove
21877 such private information before sending the email.")
21878 (add-text-properties (point-min) (point-max) '(face org-warning))
21879 (when (yes-or-no-p "Include your Org-mode configuration ")
21880 (mapatoms
21881 (lambda (v)
21882 (and (boundp v)
21883 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21884 (or (and (symbol-value v)
21885 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21886 (and
21887 (get v 'custom-type) (get v 'standard-value)
21888 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21889 (push v list)))))
21890 (kill-buffer (get-buffer "*Warn about privacy*"))
21891 list))
21892 nil nil
21893 "Remember to cover the basics, that is, what you expected to happen and
21894 what in fact did happen. You don't know how to make a good report? See
21896 http://orgmode.org/manual/Feedback.html#Feedback
21898 Your bug report will be posted to the Org-mode mailing list.
21899 ------------------------------------------------------------------------")
21900 (save-excursion
21901 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21902 (replace-match "\\1Bug: \\3 [\\2]")))))
21905 (defun org-install-agenda-files-menu ()
21906 (let ((bl (buffer-list)))
21907 (save-excursion
21908 (while bl
21909 (set-buffer (pop bl))
21910 (if (derived-mode-p 'org-mode) (setq bl nil)))
21911 (when (derived-mode-p 'org-mode)
21912 (easy-menu-change
21913 '("Org") "File List for Agenda"
21914 (append
21915 (list
21916 ["Edit File List" (org-edit-agenda-file-list) t]
21917 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21918 ["Remove Current File from List" org-remove-file t]
21919 ["Cycle through agenda files" org-cycle-agenda-files t]
21920 ["Occur in all agenda files" org-occur-in-agenda-files t]
21921 "--")
21922 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21924 ;;;; Documentation
21926 (defun org-require-autoloaded-modules ()
21927 (interactive)
21928 (mapc 'require
21929 '(org-agenda org-archive org-attach org-clock org-colview org-id
21930 org-table org-timer)))
21932 ;;;###autoload
21933 (defun org-reload (&optional uncompiled)
21934 "Reload all org lisp files.
21935 With prefix arg UNCOMPILED, load the uncompiled versions."
21936 (interactive "P")
21937 (require 'loadhist)
21938 (let* ((org-dir (org-find-library-dir "org"))
21939 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21940 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21941 (remove-re (mapconcat 'identity
21942 (mapcar (lambda (f) (concat "^" f "$"))
21943 (list (if (featurep 'xemacs)
21944 "org-colview"
21945 "org-colview-xemacs")
21946 "org" "org-loaddefs" "org-version"))
21947 "\\|"))
21948 (feats (delete-dups
21949 (mapcar 'file-name-sans-extension
21950 (mapcar 'file-name-nondirectory
21951 (delq nil
21952 (mapcar 'feature-file
21953 features))))))
21954 (lfeat (append
21955 (sort
21956 (setq feats
21957 (delq nil (mapcar
21958 (lambda (f)
21959 (if (and (string-match feature-re f)
21960 (not (string-match remove-re f)))
21961 f nil))
21962 feats)))
21963 'string-lessp)
21964 (list "org-version" "org")))
21965 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21966 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21967 load-uncore load-misses)
21968 (setq load-misses
21969 (delq 't
21970 (mapcar (lambda (f)
21971 (or (org-load-noerror-mustsuffix (concat org-dir f))
21972 (and (string= org-dir contrib-dir)
21973 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21974 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21975 (add-to-list 'load-uncore f 'append)
21978 lfeat)))
21979 (if load-uncore
21980 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21981 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21982 (if load-misses
21983 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21984 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21985 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21987 ;;;###autoload
21988 (defun org-customize ()
21989 "Call the customize function with org as argument."
21990 (interactive)
21991 (org-load-modules-maybe)
21992 (org-require-autoloaded-modules)
21993 (customize-browse 'org))
21995 (defun org-create-customize-menu ()
21996 "Create a full customization menu for Org-mode, insert it into the menu."
21997 (interactive)
21998 (org-load-modules-maybe)
21999 (org-require-autoloaded-modules)
22000 (if (fboundp 'customize-menu-create)
22001 (progn
22002 (easy-menu-change
22003 '("Org") "Customize"
22004 `(["Browse Org group" org-customize t]
22005 "--"
22006 ,(customize-menu-create 'org)
22007 ["Set" Custom-set t]
22008 ["Save" Custom-save t]
22009 ["Reset to Current" Custom-reset-current t]
22010 ["Reset to Saved" Custom-reset-saved t]
22011 ["Reset to Standard Settings" Custom-reset-standard t]))
22012 (message "\"Org\"-menu now contains full customization menu"))
22013 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22015 ;;;; Miscellaneous stuff
22017 ;;; Generally useful functions
22019 (defsubst org-get-at-eol (property n)
22020 "Get text property PROPERTY at the end of line less N characters."
22021 (get-text-property (- (point-at-eol) n) property))
22023 (defun org-find-text-property-in-string (prop s)
22024 "Return the first non-nil value of property PROP in string S."
22025 (or (get-text-property 0 prop s)
22026 (get-text-property (or (next-single-property-change 0 prop s) 0)
22027 prop s)))
22029 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22030 "Display the given MESSAGE as a warning."
22031 (if (fboundp 'display-warning)
22032 (display-warning 'org message
22033 (if (featurep 'xemacs) 'warning :warning))
22034 (let ((buf (get-buffer-create "*Org warnings*")))
22035 (with-current-buffer buf
22036 (goto-char (point-max))
22037 (insert "Warning (Org): " message)
22038 (unless (bolp)
22039 (newline)))
22040 (display-buffer buf)
22041 (sit-for 0))))
22043 (defun org-eval (form)
22044 "Eval FORM and return result."
22045 (condition-case error
22046 (eval form)
22047 (error (format "%%![Error: %s]" error))))
22049 (defun org-in-clocktable-p ()
22050 "Check if the cursor is in a clocktable."
22051 (let ((pos (point)) start)
22052 (save-excursion
22053 (end-of-line 1)
22054 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22055 (setq start (match-beginning 0))
22056 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22057 (>= (match-end 0) pos)
22058 start))))
22060 (defun org-in-verbatim-emphasis ()
22061 (save-match-data
22062 (and (org-in-regexp org-emph-re 2)
22063 (>= (point) (match-beginning 3))
22064 (<= (point) (match-end 4))
22065 (member (match-string 3) '("=" "~")))))
22067 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22068 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22069 (if (and marker (marker-buffer marker)
22070 (buffer-live-p (marker-buffer marker)))
22071 (progn
22072 (org-pop-to-buffer-same-window (marker-buffer marker))
22073 (if (or (> marker (point-max)) (< marker (point-min)))
22074 (widen))
22075 (goto-char marker)
22076 (org-show-context 'org-goto))
22077 (if bookmark
22078 (bookmark-jump bookmark)
22079 (error "Cannot find location"))))
22081 (defun org-quote-csv-field (s)
22082 "Quote field for inclusion in CSV material."
22083 (if (string-match "[\",]" s)
22084 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22087 (defun org-force-self-insert (N)
22088 "Needed to enforce self-insert under remapping."
22089 (interactive "p")
22090 (self-insert-command N))
22092 (defun org-string-width (s)
22093 "Compute width of string, ignoring invisible characters.
22094 This ignores character with invisibility property `org-link', and also
22095 characters with property `org-cwidth', because these will become invisible
22096 upon the next fontification round."
22097 (let (b l)
22098 (when (or (eq t buffer-invisibility-spec)
22099 (assq 'org-link buffer-invisibility-spec))
22100 (while (setq b (text-property-any 0 (length s)
22101 'invisible 'org-link s))
22102 (setq s (concat (substring s 0 b)
22103 (substring s (or (next-single-property-change
22104 b 'invisible s) (length s)))))))
22105 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22106 (setq s (concat (substring s 0 b)
22107 (substring s (or (next-single-property-change
22108 b 'org-cwidth s) (length s))))))
22109 (setq l (string-width s) b -1)
22110 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22111 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22114 (defun org-shorten-string (s maxlength)
22115 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22116 If the string is shorter or has length MAXLENGTH, just return the
22117 original string. If it is longer, the functions finds a space in the
22118 string, breaks this string off at that locations and adds three dots
22119 as ellipsis. Including the ellipsis, the string will not be longer
22120 than MAXLENGTH. If finding a good breaking point in the string does
22121 not work, the string is just chopped off in the middle of a word
22122 if necessary."
22123 (if (<= (length s) maxlength)
22125 (let* ((n (max (- maxlength 4) 1))
22126 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22127 (if (string-match re s)
22128 (concat (match-string 1 s) "...")
22129 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22131 (defun org-get-indentation (&optional line)
22132 "Get the indentation of the current line, interpreting tabs.
22133 When LINE is given, assume it represents a line and compute its indentation."
22134 (if line
22135 (if (string-match "^ *" (org-remove-tabs line))
22136 (match-end 0))
22137 (save-excursion
22138 (beginning-of-line 1)
22139 (skip-chars-forward " \t")
22140 (current-column))))
22142 (defun org-get-string-indentation (s)
22143 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22144 (let ((n -1) (i 0) (w tab-width) c)
22145 (catch 'exit
22146 (while (< (setq n (1+ n)) (length s))
22147 (setq c (aref s n))
22148 (cond ((= c ?\ ) (setq i (1+ i)))
22149 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22150 (t (throw 'exit t)))))
22153 (defun org-remove-tabs (s &optional width)
22154 "Replace tabulators in S with spaces.
22155 Assumes that s is a single line, starting in column 0."
22156 (setq width (or width tab-width))
22157 (while (string-match "\t" s)
22158 (setq s (replace-match
22159 (make-string
22160 (- (* width (/ (+ (match-beginning 0) width) width))
22161 (match-beginning 0)) ?\ )
22162 t t s)))
22165 (defun org-fix-indentation (line ind)
22166 "Fix indentation in LINE.
22167 IND is a cons cell with target and minimum indentation.
22168 If the current indentation in LINE is smaller than the minimum,
22169 leave it alone. If it is larger than ind, set it to the target."
22170 (let* ((l (org-remove-tabs line))
22171 (i (org-get-indentation l))
22172 (i1 (car ind)) (i2 (cdr ind)))
22173 (if (>= i i2) (setq l (substring line i2)))
22174 (if (> i1 0)
22175 (concat (make-string i1 ?\ ) l)
22176 l)))
22178 (defun org-remove-indentation (code &optional n)
22179 "Remove the maximum common indentation from the lines in CODE.
22180 N may optionally be the number of spaces to remove."
22181 (with-temp-buffer
22182 (insert code)
22183 (org-do-remove-indentation n)
22184 (buffer-string)))
22186 (defun org-do-remove-indentation (&optional n)
22187 "Remove the maximum common indentation from the buffer."
22188 (untabify (point-min) (point-max))
22189 (let ((min 10000) re)
22190 (if n
22191 (setq min n)
22192 (goto-char (point-min))
22193 (while (re-search-forward "^ *[^ \n]" nil t)
22194 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22195 (unless (or (= min 0) (= min 10000))
22196 (setq re (format "^ \\{%d\\}" min))
22197 (goto-char (point-min))
22198 (while (re-search-forward re nil t)
22199 (replace-match "")
22200 (end-of-line 1))
22201 min)))
22203 (defun org-fill-template (template alist)
22204 "Find each %key of ALIST in TEMPLATE and replace it."
22205 (let ((case-fold-search nil)
22206 entry key value)
22207 (setq alist (sort (copy-sequence alist)
22208 (lambda (a b) (< (length (car a)) (length (car b))))))
22209 (while (setq entry (pop alist))
22210 (setq template
22211 (replace-regexp-in-string
22212 (concat "%" (regexp-quote (car entry)))
22213 (or (cdr entry) "") template t t)))
22214 template))
22216 (defun org-base-buffer (buffer)
22217 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22218 (if (not buffer)
22219 buffer
22220 (or (buffer-base-buffer buffer)
22221 buffer)))
22223 (defun org-wrap (string &optional width lines)
22224 "Wrap string to either a number of lines, or a width in characters.
22225 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22226 that costs. If there is a word longer than WIDTH, the text is actually
22227 wrapped to the length of that word.
22228 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22229 many lines, whatever width that takes.
22230 The return value is a list of lines, without newlines at the end."
22231 (let* ((words (org-split-string string "[ \t\n]+"))
22232 (maxword (apply 'max (mapcar 'org-string-width words)))
22233 w ll)
22234 (cond (width
22235 (org-do-wrap words (max maxword width)))
22236 (lines
22237 (setq w maxword)
22238 (setq ll (org-do-wrap words maxword))
22239 (if (<= (length ll) lines)
22241 (setq ll words)
22242 (while (> (length ll) lines)
22243 (setq w (1+ w))
22244 (setq ll (org-do-wrap words w)))
22245 ll))
22246 (t (error "Cannot wrap this")))))
22248 (defun org-do-wrap (words width)
22249 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22250 (let (lines line)
22251 (while words
22252 (setq line (pop words))
22253 (while (and words (< (+ (length line) (length (car words))) width))
22254 (setq line (concat line " " (pop words))))
22255 (setq lines (push line lines)))
22256 (nreverse lines)))
22258 (defun org-split-string (string &optional separators)
22259 "Splits STRING into substrings at SEPARATORS.
22260 No empty strings are returned if there are matches at the beginning
22261 and end of string."
22262 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
22263 (start 0)
22264 notfirst
22265 (list nil))
22266 (while (and (string-match rexp string
22267 (if (and notfirst
22268 (= start (match-beginning 0))
22269 (< start (length string)))
22270 (1+ start) start))
22271 (< (match-beginning 0) (length string)))
22272 (setq notfirst t)
22273 (or (eq (match-beginning 0) 0)
22274 (and (eq (match-beginning 0) (match-end 0))
22275 (eq (match-beginning 0) start))
22276 (setq list
22277 (cons (substring string start (match-beginning 0))
22278 list)))
22279 (setq start (match-end 0)))
22280 (or (eq start (length string))
22281 (setq list
22282 (cons (substring string start)
22283 list)))
22284 (nreverse list)))
22286 (defun org-quote-vert (s)
22287 "Replace \"|\" with \"\\vert\"."
22288 (while (string-match "|" s)
22289 (setq s (replace-match "\\vert" t t s)))
22292 (defun org-uuidgen-p (s)
22293 "Is S an ID created by UUIDGEN?"
22294 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22296 (defun org-in-src-block-p (&optional inside)
22297 "Whether point is in a code source block.
22298 When INSIDE is non-nil, don't consider we are within a src block
22299 when point is at #+BEGIN_SRC or #+END_SRC."
22300 (let ((case-fold-search t) ov)
22301 (or (and (eq (get-char-property (point) 'src-block) t))
22302 (and (not inside)
22303 (save-match-data
22304 (save-excursion
22305 (beginning-of-line)
22306 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22308 (defun org-context ()
22309 "Return a list of contexts of the current cursor position.
22310 If several contexts apply, all are returned.
22311 Each context entry is a list with a symbol naming the context, and
22312 two positions indicating start and end of the context. Possible
22313 contexts are:
22315 :headline anywhere in a headline
22316 :headline-stars on the leading stars in a headline
22317 :todo-keyword on a TODO keyword (including DONE) in a headline
22318 :tags on the TAGS in a headline
22319 :priority on the priority cookie in a headline
22320 :item on the first line of a plain list item
22321 :item-bullet on the bullet/number of a plain list item
22322 :checkbox on the checkbox in a plain list item
22323 :table in an org-mode table
22324 :table-special on a special filed in a table
22325 :table-table in a table.el table
22326 :clocktable in a clocktable
22327 :src-block in a source block
22328 :link on a hyperlink
22329 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22330 :target on a <<target>>
22331 :radio-target on a <<<radio-target>>>
22332 :latex-fragment on a LaTeX fragment
22333 :latex-preview on a LaTeX fragment with overlaid preview image
22335 This function expects the position to be visible because it uses font-lock
22336 faces as a help to recognize the following contexts: :table-special, :link,
22337 and :keyword."
22338 (let* ((f (get-text-property (point) 'face))
22339 (faces (if (listp f) f (list f)))
22340 (case-fold-search t)
22341 (p (point)) clist o)
22342 ;; First the large context
22343 (cond
22344 ((org-at-heading-p t)
22345 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22346 (when (progn
22347 (beginning-of-line 1)
22348 (looking-at org-todo-line-tags-regexp))
22349 (push (org-point-in-group p 1 :headline-stars) clist)
22350 (push (org-point-in-group p 2 :todo-keyword) clist)
22351 (push (org-point-in-group p 4 :tags) clist))
22352 (goto-char p)
22353 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22354 (if (looking-at "\\[#[A-Z0-9]\\]")
22355 (push (org-point-in-group p 0 :priority) clist)))
22357 ((org-at-item-p)
22358 (push (org-point-in-group p 2 :item-bullet) clist)
22359 (push (list :item (point-at-bol)
22360 (save-excursion (org-end-of-item) (point)))
22361 clist)
22362 (and (org-at-item-checkbox-p)
22363 (push (org-point-in-group p 0 :checkbox) clist)))
22365 ((org-at-table-p)
22366 (push (list :table (org-table-begin) (org-table-end)) clist)
22367 (if (memq 'org-formula faces)
22368 (push (list :table-special
22369 (previous-single-property-change p 'face)
22370 (next-single-property-change p 'face)) clist)))
22371 ((org-at-table-p 'any)
22372 (push (list :table-table) clist)))
22373 (goto-char p)
22375 (let ((case-fold-search t))
22376 ;; New the "medium" contexts: clocktables, source blocks
22377 (cond ((org-in-clocktable-p)
22378 (push (list :clocktable
22379 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22380 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22381 (match-beginning 1))
22382 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22383 (match-end 0))) clist))
22384 ((org-in-src-block-p)
22385 (push (list :src-block
22386 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22387 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22388 (match-beginning 1))
22389 (and (search-forward "#+END_SRC" nil t)
22390 (match-beginning 0))) clist))))
22391 (goto-char p)
22393 ;; Now the small context
22394 (cond
22395 ((org-at-timestamp-p)
22396 (push (org-point-in-group p 0 :timestamp) clist))
22397 ((memq 'org-link faces)
22398 (push (list :link
22399 (previous-single-property-change p 'face)
22400 (next-single-property-change p 'face)) clist))
22401 ((memq 'org-special-keyword faces)
22402 (push (list :keyword
22403 (previous-single-property-change p 'face)
22404 (next-single-property-change p 'face)) clist))
22405 ((org-at-target-p)
22406 (push (org-point-in-group p 0 :target) clist)
22407 (goto-char (1- (match-beginning 0)))
22408 (if (looking-at org-radio-target-regexp)
22409 (push (org-point-in-group p 0 :radio-target) clist))
22410 (goto-char p))
22411 ((setq o (car (delq nil
22412 (mapcar
22413 (lambda (x)
22414 (if (memq x org-latex-fragment-image-overlays) x))
22415 (overlays-at (point))))))
22416 (push (list :latex-fragment
22417 (overlay-start o) (overlay-end o)) clist)
22418 (push (list :latex-preview
22419 (overlay-start o) (overlay-end o)) clist))
22420 ((org-inside-LaTeX-fragment-p)
22421 ;; FIXME: positions wrong.
22422 (push (list :latex-fragment (point) (point)) clist)))
22424 (setq clist (nreverse (delq nil clist)))
22425 clist))
22427 (defun org-in-regexp (re &optional nlines visually)
22428 "Check if point is inside a match of RE.
22430 Normally only the current line is checked, but you can include
22431 NLINES extra lines after point into the search. If VISUALLY is
22432 set, require that the cursor is not after the match but really
22433 on, so that the block visually is on the match."
22434 (catch 'exit
22435 (let ((pos (point))
22436 (eol (point-at-eol (+ 1 (or nlines 0))))
22437 (inc (if visually 1 0)))
22438 (save-excursion
22439 (beginning-of-line (- 1 (or nlines 0)))
22440 (while (re-search-forward re eol t)
22441 (if (and (<= (match-beginning 0) pos)
22442 (>= (+ inc (match-end 0)) pos))
22443 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22444 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22445 "Org mode 8.3")
22447 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22448 "Non-nil when point is between matches of START-RE and END-RE.
22450 Also return a non-nil value when point is on one of the matches.
22452 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22453 buffer positions. Default values are the positions of headlines
22454 surrounding the point.
22456 The functions returns a cons cell whose car (resp. cdr) is the
22457 position before START-RE (resp. after END-RE)."
22458 (save-match-data
22459 (let ((pos (point))
22460 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22461 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22462 beg end)
22463 (save-excursion
22464 ;; Point is on a block when on START-RE or if START-RE can be
22465 ;; found before it...
22466 (and (or (org-in-regexp start-re)
22467 (re-search-backward start-re limit-up t))
22468 (setq beg (match-beginning 0))
22469 ;; ... and END-RE after it...
22470 (goto-char (match-end 0))
22471 (re-search-forward end-re limit-down t)
22472 (> (setq end (match-end 0)) pos)
22473 ;; ... without another START-RE in-between.
22474 (goto-char (match-beginning 0))
22475 (not (re-search-backward start-re (1+ beg) t))
22476 ;; Return value.
22477 (cons beg end))))))
22479 (defun org-in-block-p (names)
22480 "Non-nil when point belongs to a block whose name belongs to NAMES.
22482 NAMES is a list of strings containing names of blocks.
22484 Return first block name matched, or nil. Beware that in case of
22485 nested blocks, the returned name may not belong to the closest
22486 block from point."
22487 (save-match-data
22488 (catch 'exit
22489 (let ((case-fold-search t)
22490 (lim-up (save-excursion (outline-previous-heading)))
22491 (lim-down (save-excursion (outline-next-heading))))
22492 (mapc (lambda (name)
22493 (let ((n (regexp-quote name)))
22494 (when (org-between-regexps-p
22495 (concat "^[ \t]*#\\+begin_" n)
22496 (concat "^[ \t]*#\\+end_" n)
22497 lim-up lim-down)
22498 (throw 'exit n))))
22499 names))
22500 nil)))
22502 (defun org-occur-in-agenda-files (regexp &optional nlines)
22503 "Call `multi-occur' with buffers for all agenda files."
22504 (interactive "sOrg-files matching: \np")
22505 (let* ((files (org-agenda-files))
22506 (tnames (mapcar 'file-truename files))
22507 (extra org-agenda-text-search-extra-files)
22509 (when (eq (car extra) 'agenda-archives)
22510 (setq extra (cdr extra))
22511 (setq files (org-add-archive-files files)))
22512 (while (setq f (pop extra))
22513 (unless (member (file-truename f) tnames)
22514 (add-to-list 'files f 'append)
22515 (add-to-list 'tnames (file-truename f) 'append)))
22516 (multi-occur
22517 (mapcar (lambda (x)
22518 (with-current-buffer
22519 (or (get-file-buffer x) (find-file-noselect x))
22520 (widen)
22521 (current-buffer)))
22522 files)
22523 regexp)))
22525 (if (boundp 'occur-mode-find-occurrence-hook)
22526 ;; Emacs 23
22527 (add-hook 'occur-mode-find-occurrence-hook
22528 (lambda ()
22529 (when (derived-mode-p 'org-mode)
22530 (org-reveal))))
22531 ;; Emacs 22
22532 (defadvice occur-mode-goto-occurrence
22533 (after org-occur-reveal activate)
22534 (and (derived-mode-p 'org-mode) (org-reveal)))
22535 (defadvice occur-mode-goto-occurrence-other-window
22536 (after org-occur-reveal activate)
22537 (and (derived-mode-p 'org-mode) (org-reveal)))
22538 (defadvice occur-mode-display-occurrence
22539 (after org-occur-reveal activate)
22540 (when (derived-mode-p 'org-mode)
22541 (let ((pos (occur-mode-find-occurrence)))
22542 (with-current-buffer (marker-buffer pos)
22543 (save-excursion
22544 (goto-char pos)
22545 (org-reveal)))))))
22547 (defun org-occur-link-in-agenda-files ()
22548 "Create a link and search for it in the agendas.
22549 The link is not stored in `org-stored-links', it is just created
22550 for the search purpose."
22551 (interactive)
22552 (let ((link (condition-case nil
22553 (org-store-link nil)
22554 (error "Unable to create a link to here"))))
22555 (org-occur-in-agenda-files (regexp-quote link))))
22557 (defun org-reverse-string (string)
22558 "Return the reverse of STRING."
22559 (apply 'string (reverse (string-to-list string))))
22561 ;; defsubst org-uniquify must be defined before first use
22563 (defun org-uniquify-alist (alist)
22564 "Merge elements of ALIST with the same key.
22566 For example, in this alist:
22568 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22569 => '((a 1 3) (b 2))
22571 merge (a 1) and (a 3) into (a 1 3).
22573 The function returns the new ALIST."
22574 (let (rtn)
22575 (mapc
22576 (lambda (e)
22577 (let (n)
22578 (if (not (assoc (car e) rtn))
22579 (push e rtn)
22580 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22581 (setq rtn (assq-delete-all (car e) rtn))
22582 (push n rtn))))
22583 alist)
22584 rtn))
22586 (defun org-delete-all (elts list)
22587 "Remove all elements in ELTS from LIST."
22588 (while elts
22589 (setq list (delete (pop elts) list)))
22590 list)
22592 (defun org-count (cl-item cl-seq)
22593 "Count the number of occurrences of ITEM in SEQ.
22594 Taken from `count' in cl-seq.el with all keyword arguments removed."
22595 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22596 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22597 (while (< cl-start cl-end)
22598 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22599 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22600 (setq cl-start (1+ cl-start)))
22601 cl-count))
22603 (defun org-remove-if (predicate seq)
22604 "Remove everything from SEQ that fulfills PREDICATE."
22605 (let (res e)
22606 (while seq
22607 (setq e (pop seq))
22608 (if (not (funcall predicate e)) (push e res)))
22609 (nreverse res)))
22611 (defun org-remove-if-not (predicate seq)
22612 "Remove everything from SEQ that does not fulfill PREDICATE."
22613 (let (res e)
22614 (while seq
22615 (setq e (pop seq))
22616 (if (funcall predicate e) (push e res)))
22617 (nreverse res)))
22619 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22620 "Reduce two-argument FUNCTION across SEQ.
22621 Taken from `reduce' in cl-seq.el with all keyword arguments but
22622 \":initial-value\" removed."
22623 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22624 (cadr (memq :initial-value cl-keys)))
22625 (cl-seq (pop cl-seq))
22626 (t (funcall cl-func)))))
22627 (while cl-seq
22628 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22629 cl-accum))
22631 (defun org-every (pred seq)
22632 "Return true if PREDICATE is true of every element of SEQ.
22633 Adapted from `every' in cl.el."
22634 (catch 'org-every
22635 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22638 (defun org-some (pred seq)
22639 "Return true if PREDICATE is true of any element of SEQ.
22640 Adapted from `some' in cl.el."
22641 (catch 'org-some
22642 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22643 nil))
22645 (defun org-back-over-empty-lines ()
22646 "Move backwards over whitespace, to the beginning of the first empty line.
22647 Returns the number of empty lines passed."
22648 (let ((pos (point)))
22649 (if (cdr (assoc 'heading org-blank-before-new-entry))
22650 (skip-chars-backward " \t\n\r")
22651 (unless (eobp)
22652 (forward-line -1)))
22653 (beginning-of-line 2)
22654 (goto-char (min (point) pos))
22655 (count-lines (point) pos)))
22657 (defun org-skip-whitespace ()
22658 (skip-chars-forward " \t\n\r"))
22660 (defun org-point-in-group (point group &optional context)
22661 "Check if POINT is in match-group GROUP.
22662 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22663 match. If the match group does not exist or point is not inside it,
22664 return nil."
22665 (and (match-beginning group)
22666 (>= point (match-beginning group))
22667 (<= point (match-end group))
22668 (if context
22669 (list context (match-beginning group) (match-end group))
22670 t)))
22672 (defun org-switch-to-buffer-other-window (&rest args)
22673 "Switch to buffer in a second window on the current frame.
22674 In particular, do not allow pop-up frames.
22675 Returns the newly created buffer."
22676 (org-no-popups
22677 (apply 'switch-to-buffer-other-window args)))
22679 (defun org-combine-plists (&rest plists)
22680 "Create a single property list from all plists in PLISTS.
22681 The process starts by copying the first list, and then setting properties
22682 from the other lists. Settings in the last list are the most significant
22683 ones and overrule settings in the other lists."
22684 (let ((rtn (copy-sequence (pop plists)))
22685 p v ls)
22686 (while plists
22687 (setq ls (pop plists))
22688 (while ls
22689 (setq p (pop ls) v (pop ls))
22690 (setq rtn (plist-put rtn p v))))
22691 rtn))
22693 (defun org-replace-escapes (string table)
22694 "Replace %-escapes in STRING with values in TABLE.
22695 TABLE is an association list with keys like \"%a\" and string values.
22696 The sequences in STRING may contain normal field width and padding information,
22697 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22698 so values can contain further %-escapes if they are define later in TABLE."
22699 (let ((tbl (copy-alist table))
22700 (case-fold-search nil)
22701 (pchg 0)
22702 e re rpl)
22703 (while (setq e (pop tbl))
22704 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22705 (when (and (cdr e) (string-match re (cdr e)))
22706 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22707 (safe "SREF"))
22708 (add-text-properties 0 3 (list 'sref sref) safe)
22709 (setcdr e (replace-match safe t t (cdr e)))))
22710 (while (string-match re string)
22711 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22712 (cdr e)))
22713 (setq string (replace-match rpl t t string))))
22714 (while (setq pchg (next-property-change pchg string))
22715 (let ((sref (get-text-property pchg 'sref string)))
22716 (when (and sref (string-match "SREF" string pchg))
22717 (setq string (replace-match sref t t string)))))
22718 string))
22720 (defun org-sublist (list start end)
22721 "Return a section of LIST, from START to END.
22722 Counting starts at 1."
22723 (let (rtn (c start))
22724 (setq list (nthcdr (1- start) list))
22725 (while (and list (<= c end))
22726 (push (pop list) rtn)
22727 (setq c (1+ c)))
22728 (nreverse rtn)))
22730 (defun org-find-base-buffer-visiting (file)
22731 "Like `find-buffer-visiting' but always return the base buffer and
22732 not an indirect buffer."
22733 (let ((buf (or (get-file-buffer file)
22734 (find-buffer-visiting file))))
22735 (if buf
22736 (or (buffer-base-buffer buf) buf)
22737 nil)))
22739 (defun org-image-file-name-regexp (&optional extensions)
22740 "Return regexp matching the file names of images.
22741 If EXTENSIONS is given, only match these."
22742 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22743 (image-file-name-regexp)
22744 (let ((image-file-name-extensions
22745 (or extensions
22746 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22747 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22748 (concat "\\."
22749 (regexp-opt (nconc (mapcar 'upcase
22750 image-file-name-extensions)
22751 image-file-name-extensions)
22753 "\\'"))))
22755 (defun org-file-image-p (file &optional extensions)
22756 "Return non-nil if FILE is an image."
22757 (save-match-data
22758 (string-match (org-image-file-name-regexp extensions) file)))
22760 (defun org-get-cursor-date (&optional with-time)
22761 "Return the date at cursor in as a time.
22762 This works in the calendar and in the agenda, anywhere else it just
22763 returns the current time.
22764 If WITH-TIME is non-nil, returns the time of the event at point (in
22765 the agenda) or the current time of the day."
22766 (let (date day defd tp tm hod mod)
22767 (when with-time
22768 (setq tp (get-text-property (point) 'time))
22769 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22770 (setq hod (string-to-number (match-string 1 tp))
22771 mod (string-to-number (match-string 2 tp))))
22772 (or tp (setq hod (nth 2 (decode-time (current-time)))
22773 mod (nth 1 (decode-time (current-time))))))
22774 (cond
22775 ((eq major-mode 'calendar-mode)
22776 (setq date (calendar-cursor-to-date)
22777 defd (encode-time 0 (or mod 0) (or hod 0)
22778 (nth 1 date) (nth 0 date) (nth 2 date))))
22779 ((eq major-mode 'org-agenda-mode)
22780 (setq day (get-text-property (point) 'day))
22781 (if day
22782 (setq date (calendar-gregorian-from-absolute day)
22783 defd (encode-time 0 (or mod 0) (or hod 0)
22784 (nth 1 date) (nth 0 date) (nth 2 date))))))
22785 (or defd (current-time))))
22787 (defun org-mark-subtree (&optional up)
22788 "Mark the current subtree.
22789 This puts point at the start of the current subtree, and mark at
22790 the end. If a numeric prefix UP is given, move up into the
22791 hierarchy of headlines by UP levels before marking the subtree."
22792 (interactive "P")
22793 (org-with-limited-levels
22794 (cond ((org-at-heading-p) (beginning-of-line))
22795 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22796 (t (outline-previous-visible-heading 1))))
22797 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22798 (if (org-called-interactively-p 'any)
22799 (call-interactively 'org-mark-element)
22800 (org-mark-element)))
22803 ;;; Indentation
22805 (defun org--get-expected-indentation (element contentsp)
22806 "Expected indentation column for current line, according to ELEMENT.
22807 ELEMENT is an element containing point. CONTENTSP is non-nil
22808 when indentation is to be computed according to contents of
22809 ELEMENT."
22810 (let ((type (org-element-type element))
22811 (start (org-element-property :begin element))
22812 (post-affiliated (org-element-property :post-affiliated element)))
22813 (org-with-wide-buffer
22814 (cond
22815 (contentsp
22816 (case type
22817 ((diary-sexp footnote-definition) 0)
22818 ((headline inlinetask nil)
22819 (if (not org-adapt-indentation) 0
22820 (let ((level (org-current-level)))
22821 (if level (1+ level) 0))))
22822 ((item plain-list) (org-list-item-body-column post-affiliated))
22824 (goto-char start)
22825 (org-get-indentation))))
22826 ((memq type '(headline inlinetask nil))
22827 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22828 (org--get-expected-indentation element t)
22830 ((memq type '(diary-sexp footnote-definition)) 0)
22831 ;; First paragraph of a footnote definition or an item.
22832 ;; Indent like parent.
22833 ((< (line-beginning-position) start)
22834 (org--get-expected-indentation
22835 (org-element-property :parent element) t))
22836 ;; At first line: indent according to previous sibling, if any,
22837 ;; ignoring footnote definitions and inline tasks, or parent's
22838 ;; contents.
22839 ((= (line-beginning-position) start)
22840 (catch 'exit
22841 (while t
22842 (if (= (point-min) start) (throw 'exit 0)
22843 (goto-char (1- start))
22844 (let* ((previous (org-element-at-point))
22845 (parent previous))
22846 (while (and parent (<= (org-element-property :end parent) start))
22847 (setq previous parent
22848 parent (org-element-property :parent parent)))
22849 (cond
22850 ((not previous) (throw 'exit 0))
22851 ((> (org-element-property :end previous) start)
22852 (throw 'exit (org--get-expected-indentation previous t)))
22853 ((memq (org-element-type previous)
22854 '(footnote-definition inlinetask))
22855 (setq start (org-element-property :begin previous)))
22856 (t (goto-char (org-element-property :begin previous))
22857 (throw 'exit
22858 (if (bolp) (org-get-indentation)
22859 ;; At first paragraph in an item or
22860 ;; a footnote definition.
22861 (org--get-expected-indentation
22862 (org-element-property :parent previous) t))))))))))
22863 ;; Otherwise, move to the first non-blank line above.
22865 (beginning-of-line)
22866 (let ((pos (point)))
22867 (skip-chars-backward " \r\t\n")
22868 (cond
22869 ;; Two blank lines end a footnote definition or a plain
22870 ;; list. When we indent an empty line after them, the
22871 ;; containing list or footnote definition is over, so it
22872 ;; qualifies as a previous sibling. Therefore, we indent
22873 ;; like its first line.
22874 ((and (memq type '(footnote-definition plain-list))
22875 (> (count-lines (point) pos) 2))
22876 (goto-char start)
22877 (org-get-indentation))
22878 ;; Line above is the first one of a paragraph at the
22879 ;; beginning of an item or a footnote definition. Indent
22880 ;; like parent.
22881 ((< (line-beginning-position) start)
22882 (org--get-expected-indentation
22883 (org-element-property :parent element) t))
22884 ;; Line above is the beginning of an element, i.e., point
22885 ;; was originally on the blank lines between element's start
22886 ;; and contents.
22887 ((= (line-beginning-position) post-affiliated)
22888 (org--get-expected-indentation element t))
22889 ;; POS is after contents in a greater element. Indent like
22890 ;; the beginning of the element.
22892 ;; As a special case, if point is at the end of a footnote
22893 ;; definition or an item, indent like the very last element
22894 ;; within.
22895 ((and (not (eq type 'paragraph))
22896 (let ((cend (org-element-property :contents-end element)))
22897 (and cend (<= cend pos))))
22898 (if (memq type '(footnote-definition item plain-list))
22899 (let ((last (org-element-at-point)))
22900 (org--get-expected-indentation
22901 last
22902 (memq (org-element-type last)
22903 '(footnote-definition item plain-list))))
22904 (goto-char start)
22905 (org-get-indentation)))
22906 ;; In any other case, indent like the current line.
22907 (t (org-get-indentation)))))))))
22909 (defun org--align-node-property ()
22910 "Align node property at point.
22911 Alignment is done according to `org-property-format', which see."
22912 (when (save-excursion
22913 (beginning-of-line)
22914 (looking-at org-property-re))
22915 (replace-match
22916 (concat (match-string 4)
22917 (org-trim
22918 (format org-property-format (match-string 1) (match-string 3))))
22919 t t)))
22921 (defun org-indent-line ()
22922 "Indent line depending on context.
22924 Indentation is done according to the following rules:
22926 - Footnote definitions, diary sexps, headlines and inline tasks
22927 have to start at column 0.
22929 - On the very first line of an element, consider, in order, the
22930 next rules until one matches:
22932 1. If there's a sibling element before, ignoring footnote
22933 definitions and inline tasks, indent like its first line.
22935 2. If element has a parent, indent like its contents. More
22936 precisely, if parent is an item, indent after the
22937 description part, if any, or the bullet (see
22938 `org-list-description-max-indent'). Else, indent like
22939 parent's first line.
22941 3. Otherwise, indent relatively to current level, if
22942 `org-adapt-indentation' is non-nil, or to left margin.
22944 - On a blank line at the end of an element, indent according to
22945 the type of the element. More precisely
22947 1. If element is a plain list, an item, or a footnote
22948 definition, indent like the very last element within.
22950 2. If element is a paragraph, indent like its last non blank
22951 line.
22953 3. Otherwise, indent like its very first line.
22955 - In the code part of a source block, use language major mode
22956 to indent current line if `org-src-tab-acts-natively' is
22957 non-nil. If it is nil, do nothing.
22959 - Otherwise, indent like the first non-blank line above.
22961 The function doesn't indent an item as it could break the whole
22962 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22963 \\[org-shiftmetaright].
22965 Also align node properties according to `org-property-format'."
22966 (interactive)
22967 (cond
22968 (orgstruct-is-++
22969 (let ((indent-line-function
22970 (cadadr (assq 'indent-line-function org-fb-vars))))
22971 (indent-according-to-mode)))
22972 ((org-at-heading-p) 'noindent)
22974 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22975 (type (org-element-type element)))
22976 (cond ((and (memq type '(plain-list item))
22977 (= (line-beginning-position)
22978 (org-element-property :post-affiliated element)))
22979 'noindent)
22980 ((and (eq type 'src-block)
22981 org-src-tab-acts-natively
22982 (> (line-beginning-position)
22983 (org-element-property :post-affiliated element))
22984 (< (line-beginning-position)
22985 (org-with-wide-buffer
22986 (goto-char (org-element-property :end element))
22987 (skip-chars-backward " \r\t\n")
22988 (line-beginning-position))))
22989 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22991 (let ((column (org--get-expected-indentation element nil)))
22992 ;; Preserve current column.
22993 (if (<= (current-column) (current-indentation))
22994 (org-indent-line-to column)
22995 (save-excursion (org-indent-line-to column))))
22996 ;; Align node property. Also preserve current column.
22997 (when (eq type 'node-property)
22998 (let ((column (current-column)))
22999 (org--align-node-property)
23000 (org-move-to-column column)))))))))
23002 (defun org-indent-region (start end)
23003 "Indent each non-blank line in the region.
23004 Called from a program, START and END specify the region to
23005 indent. The function will not indent contents of example blocks,
23006 verse blocks and export blocks as leading white spaces are
23007 assumed to be significant there."
23008 (interactive "r")
23009 (save-excursion
23010 (goto-char start)
23011 (skip-chars-forward " \r\t\n")
23012 (unless (eobp) (beginning-of-line))
23013 (let ((indent-to
23014 (lambda (ind pos)
23015 ;; Set IND as indentation for all lines between point and
23016 ;; POS or END, whichever comes first. Blank lines are
23017 ;; ignored. Leave point after POS once done.
23018 (let ((limit (copy-marker (min end pos))))
23019 (while (< (point) limit)
23020 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23021 (forward-line))
23022 (set-marker limit nil))))
23023 (end (copy-marker end)))
23024 (while (< (point) end)
23025 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23026 (let* ((element (org-element-at-point))
23027 (type (org-element-type element))
23028 (element-end (copy-marker (org-element-property :end element)))
23029 (ind (org--get-expected-indentation element nil)))
23030 (cond
23031 ((or (memq type '(paragraph table table-row))
23032 (not (or (org-element-property :contents-begin element)
23033 (memq type
23034 '(example-block export-block src-block)))))
23035 ;; Elements here are indented as a single block. Also
23036 ;; align node properties.
23037 (when (eq type 'node-property)
23038 (org--align-node-property)
23039 (beginning-of-line))
23040 (funcall indent-to ind element-end))
23042 ;; Elements in this category consist of three parts:
23043 ;; before the contents, the contents, and after the
23044 ;; contents. The contents are treated specially,
23045 ;; according to the element type, or not indented at
23046 ;; all. Other parts are indented as a single block.
23047 (let* ((post (copy-marker
23048 (org-element-property :post-affiliated element)))
23049 (cbeg
23050 (copy-marker
23051 (cond
23052 ((not (org-element-property :contents-begin element))
23053 ;; Fake contents for source blocks.
23054 (org-with-wide-buffer
23055 (goto-char post)
23056 (forward-line)
23057 (point)))
23058 ((memq type '(footnote-definition item plain-list))
23059 ;; Contents in these elements could start on
23060 ;; the same line as the beginning of the
23061 ;; element. Make sure we start indenting
23062 ;; from the second line.
23063 (org-with-wide-buffer
23064 (goto-char post)
23065 (end-of-line)
23066 (skip-chars-forward " \r\t\n")
23067 (if (eobp) (point) (line-beginning-position))))
23068 (t (org-element-property :contents-begin element)))))
23069 (cend (copy-marker
23070 (or (org-element-property :contents-end element)
23071 ;; Fake contents for source blocks.
23072 (org-with-wide-buffer
23073 (goto-char element-end)
23074 (skip-chars-backward " \r\t\n")
23075 (line-beginning-position)))
23076 t)))
23077 ;; Do not change items indentation individually as it
23078 ;; might break the list as a whole. On the other
23079 ;; hand, when at a plain list, indent it as a whole.
23080 (cond ((eq type 'plain-list)
23081 (let ((offset (- ind (org-get-indentation))))
23082 (unless (zerop offset)
23083 (indent-rigidly (org-element-property :begin element)
23084 (org-element-property :end element)
23085 offset))
23086 (goto-char cbeg)))
23087 ((eq type 'item) (goto-char cbeg))
23088 (t (funcall indent-to ind cbeg)))
23089 (when (< (point) end)
23090 (case type
23091 ((example-block export-block verse-block))
23092 (src-block
23093 ;; In a source block, indent source code
23094 ;; according to language major mode, but only if
23095 ;; `org-src-tab-acts-natively' is non-nil.
23096 (when (and (< (point) end) org-src-tab-acts-natively)
23097 (ignore-errors
23098 (org-babel-do-in-edit-buffer
23099 (indent-region (point-min) (point-max))))))
23100 (t (org-indent-region (point) (min cend end))))
23101 (goto-char (min cend end))
23102 (when (< (point) end) (funcall indent-to ind element-end)))
23103 (set-marker post nil)
23104 (set-marker cbeg nil)
23105 (set-marker cend nil))))
23106 (set-marker element-end nil))))
23107 (set-marker end nil))))
23109 (defun org-indent-drawer ()
23110 "Indent the drawer at point."
23111 (interactive)
23112 (unless (save-excursion
23113 (beginning-of-line)
23114 (org-looking-at-p org-drawer-regexp))
23115 (user-error "Not at a drawer"))
23116 (let ((element (org-element-at-point)))
23117 (unless (memq (org-element-type element) '(drawer property-drawer))
23118 (user-error "Not at a drawer"))
23119 (org-with-wide-buffer
23120 (org-indent-region (org-element-property :begin element)
23121 (org-element-property :end element))))
23122 (message "Drawer at point indented"))
23124 (defun org-indent-block ()
23125 "Indent the block at point."
23126 (interactive)
23127 (unless (save-excursion
23128 (beginning-of-line)
23129 (let ((case-fold-search t))
23130 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23131 (user-error "Not at a block"))
23132 (let ((element (org-element-at-point)))
23133 (unless (memq (org-element-type element)
23134 '(comment-block center-block dynamic-block example-block
23135 export-block quote-block special-block
23136 src-block verse-block))
23137 (user-error "Not at a block"))
23138 (org-with-wide-buffer
23139 (org-indent-region (org-element-property :begin element)
23140 (org-element-property :end element))))
23141 (message "Block at point indented"))
23144 ;;; Filling
23146 ;; We use our own fill-paragraph and auto-fill functions.
23148 ;; `org-fill-paragraph' relies on adaptive filling and context
23149 ;; checking. Appropriate `fill-prefix' is computed with
23150 ;; `org-adaptive-fill-function'.
23152 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23153 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23154 ;; `org-adaptive-fill-function' value. Internally,
23155 ;; `org-comment-line-break-function' breaks the line.
23157 ;; `org-setup-filling' installs filling and auto-filling related
23158 ;; variables during `org-mode' initialization.
23160 (defvar org-element-paragraph-separate) ; org-element.el
23161 (defun org-setup-filling ()
23162 (require 'org-element)
23163 ;; Prevent auto-fill from inserting unwanted new items.
23164 (when (boundp 'fill-nobreak-predicate)
23165 (org-set-local
23166 'fill-nobreak-predicate
23167 (org-uniquify
23168 (append fill-nobreak-predicate
23169 '(org-fill-line-break-nobreak-p
23170 org-fill-paragraph-with-timestamp-nobreak-p)))))
23171 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23172 (org-set-local 'paragraph-start paragraph-ending)
23173 (org-set-local 'paragraph-separate paragraph-ending))
23174 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23175 (org-set-local 'auto-fill-inhibit-regexp nil)
23176 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23177 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23178 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23180 (defun org-fill-line-break-nobreak-p ()
23181 "Non-nil when a new line at point would create an Org line break."
23182 (save-excursion
23183 (skip-chars-backward "[ \t]")
23184 (skip-chars-backward "\\\\")
23185 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23187 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23188 "Non-nil when a new line at point would split a timestamp."
23189 (and (org-at-timestamp-p t)
23190 (not (looking-at org-ts-regexp-both))))
23192 (declare-function message-in-body-p "message" ())
23193 (defvar orgtbl-line-start-regexp) ; From org-table.el
23194 (defun org-adaptive-fill-function ()
23195 "Compute a fill prefix for the current line.
23196 Return fill prefix, as a string, or nil if current line isn't
23197 meant to be filled. For convenience, if `adaptive-fill-regexp'
23198 matches in paragraphs or comments, use it."
23199 (catch 'exit
23200 (when (derived-mode-p 'message-mode)
23201 (save-excursion
23202 (beginning-of-line)
23203 (cond ((not (message-in-body-p)) (throw 'exit nil))
23204 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23205 ((looking-at message-cite-prefix-regexp)
23206 (throw 'exit (match-string-no-properties 0)))
23207 ((looking-at org-outline-regexp)
23208 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23209 (org-with-wide-buffer
23210 (unless (org-at-heading-p)
23211 (let* ((p (line-beginning-position))
23212 (element (save-excursion
23213 (beginning-of-line)
23214 (org-element-at-point)))
23215 (type (org-element-type element))
23216 (post-affiliated (org-element-property :post-affiliated element)))
23217 (unless (< p post-affiliated)
23218 (case type
23219 (comment
23220 (save-excursion
23221 (beginning-of-line)
23222 (looking-at "[ \t]*")
23223 (concat (match-string 0) "# ")))
23224 (footnote-definition "")
23225 ((item plain-list)
23226 (make-string (org-list-item-body-column post-affiliated) ?\s))
23227 (paragraph
23228 ;; Fill prefix is usually the same as the current line,
23229 ;; unless the paragraph is at the beginning of an item.
23230 (let ((parent (org-element-property :parent element)))
23231 (save-excursion
23232 (beginning-of-line)
23233 (cond ((eq (org-element-type parent) 'item)
23234 (make-string (org-list-item-body-column
23235 (org-element-property :begin parent))
23236 ?\s))
23237 ((and adaptive-fill-regexp
23238 ;; Locally disable
23239 ;; `adaptive-fill-function' to let
23240 ;; `fill-context-prefix' handle
23241 ;; `adaptive-fill-regexp' variable.
23242 (let (adaptive-fill-function)
23243 (fill-context-prefix
23244 post-affiliated
23245 (org-element-property :end element)))))
23246 ((looking-at "[ \t]+") (match-string 0))
23247 (t "")))))
23248 (comment-block
23249 ;; Only fill contents if P is within block boundaries.
23250 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23251 (forward-line)
23252 (point)))
23253 (cend (save-excursion
23254 (goto-char (org-element-property :end element))
23255 (skip-chars-backward " \r\t\n")
23256 (line-beginning-position))))
23257 (when (and (>= p cbeg) (< p cend))
23258 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23259 (match-string 0)
23260 "")))))))))))
23262 (declare-function message-goto-body "message" ())
23263 (defvar message-cite-prefix-regexp) ; From message.el
23264 (defun org-fill-paragraph (&optional justify)
23265 "Fill element at point, when applicable.
23267 This function only applies to comment blocks, comments, example
23268 blocks and paragraphs. Also, as a special case, re-align table
23269 when point is at one.
23271 If JUSTIFY is non-nil (interactively, with prefix argument),
23272 justify as well. If `sentence-end-double-space' is non-nil, then
23273 period followed by one space does not end a sentence, so don't
23274 break a line there. The variable `fill-column' controls the
23275 width for filling.
23277 For convenience, when point is at a plain list, an item or
23278 a footnote definition, try to fill the first paragraph within."
23279 (interactive)
23280 (if (and (derived-mode-p 'message-mode)
23281 (or (not (message-in-body-p))
23282 (save-excursion (move-beginning-of-line 1)
23283 (looking-at message-cite-prefix-regexp))))
23284 ;; First ensure filling is correct in message-mode.
23285 (let ((fill-paragraph-function
23286 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23287 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23288 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23289 (paragraph-separate
23290 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23291 (fill-paragraph nil))
23292 (with-syntax-table org-mode-transpose-word-syntax-table
23293 ;; Move to end of line in order to get the first paragraph
23294 ;; within a plain list or a footnote definition.
23295 (let ((element (save-excursion
23296 (end-of-line)
23297 (or (ignore-errors (org-element-at-point))
23298 (user-error "An element cannot be parsed line %d"
23299 (line-number-at-pos (point)))))))
23300 ;; First check if point is in a blank line at the beginning of
23301 ;; the buffer. In that case, ignore filling.
23302 (case (org-element-type element)
23303 ;; Use major mode filling function is src blocks.
23304 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23305 ;; Align Org tables, leave table.el tables as-is.
23306 (table-row (org-table-align) t)
23307 (table
23308 (when (eq (org-element-property :type element) 'org)
23309 (save-excursion
23310 (goto-char (org-element-property :post-affiliated element))
23311 (org-table-align)))
23313 (paragraph
23314 ;; Paragraphs may contain `line-break' type objects.
23315 (let ((beg (max (point-min)
23316 (org-element-property :contents-begin element)))
23317 (end (min (point-max)
23318 (org-element-property :contents-end element))))
23319 ;; Do nothing if point is at an affiliated keyword.
23320 (if (< (line-end-position) beg) t
23321 (when (derived-mode-p 'message-mode)
23322 ;; In `message-mode', do not fill following citation
23323 ;; in current paragraph nor text before message body.
23324 (let ((body-start (save-excursion (message-goto-body))))
23325 (when body-start (setq beg (max body-start beg))))
23326 (when (save-excursion
23327 (re-search-forward
23328 (concat "^" message-cite-prefix-regexp) end t))
23329 (setq end (match-beginning 0))))
23330 ;; Fill paragraph, taking line breaks into account.
23331 (save-excursion
23332 (goto-char beg)
23333 (let ((cuts (list beg)))
23334 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23335 (when (eq 'line-break
23336 (org-element-type
23337 (save-excursion (backward-char)
23338 (org-element-context))))
23339 (push (point) cuts)))
23340 (dolist (c (delq end cuts))
23341 (fill-region-as-paragraph c end justify)
23342 (setq end c))))
23343 t)))
23344 ;; Contents of `comment-block' type elements should be
23345 ;; filled as plain text, but only if point is within block
23346 ;; markers.
23347 (comment-block
23348 (let* ((case-fold-search t)
23349 (beg (save-excursion
23350 (goto-char (org-element-property :begin element))
23351 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23352 (forward-line)
23353 (point)))
23354 (end (save-excursion
23355 (goto-char (org-element-property :end element))
23356 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23357 (line-beginning-position))))
23358 (if (or (< (point) beg) (> (point) end)) t
23359 (fill-region-as-paragraph
23360 (save-excursion (end-of-line)
23361 (re-search-backward "^[ \t]*$" beg 'move)
23362 (line-beginning-position))
23363 (save-excursion (beginning-of-line)
23364 (re-search-forward "^[ \t]*$" end 'move)
23365 (line-beginning-position))
23366 justify))))
23367 ;; Fill comments.
23368 (comment
23369 (let ((begin (org-element-property :post-affiliated element))
23370 (end (org-element-property :end element)))
23371 (when (and (>= (point) begin) (<= (point) end))
23372 (let ((begin (save-excursion
23373 (end-of-line)
23374 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23375 (progn (forward-line) (point))
23376 begin)))
23377 (end (save-excursion
23378 (end-of-line)
23379 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23380 (1- (line-beginning-position))
23381 (skip-chars-backward " \r\t\n")
23382 (line-end-position)))))
23383 ;; Do not fill comments when at a blank line.
23384 (when (> end begin)
23385 (let ((fill-prefix
23386 (save-excursion
23387 (beginning-of-line)
23388 (looking-at "[ \t]*#")
23389 (let ((comment-prefix (match-string 0)))
23390 (goto-char (match-end 0))
23391 (if (looking-at adaptive-fill-regexp)
23392 (concat comment-prefix (match-string 0))
23393 (concat comment-prefix " "))))))
23394 (save-excursion
23395 (fill-region-as-paragraph begin end justify))))))
23397 ;; Ignore every other element.
23398 (otherwise t))))))
23400 (defun org-auto-fill-function ()
23401 "Auto-fill function."
23402 ;; Check if auto-filling is meaningful.
23403 (let ((fc (current-fill-column)))
23404 (when (and fc (> (current-column) fc))
23405 (let* ((fill-prefix (org-adaptive-fill-function))
23406 ;; Enforce empty fill prefix, if required. Otherwise, it
23407 ;; will be computed again.
23408 (adaptive-fill-mode (not (equal fill-prefix ""))))
23409 (when fill-prefix (do-auto-fill))))))
23411 (defun org-comment-line-break-function (&optional soft)
23412 "Break line at point and indent, continuing comment if within one.
23413 The inserted newline is marked hard if variable
23414 `use-hard-newlines' is true, unless optional argument SOFT is
23415 non-nil."
23416 (if soft (insert-and-inherit ?\n) (newline 1))
23417 (save-excursion (forward-char -1) (delete-horizontal-space))
23418 (delete-horizontal-space)
23419 (indent-to-left-margin)
23420 (insert-before-markers-and-inherit fill-prefix))
23423 ;;; Fixed Width Areas
23425 (defun org-toggle-fixed-width ()
23426 "Toggle fixed-width markup.
23428 Add or remove fixed-width markup on current line, whenever it
23429 makes sense. Return an error otherwise.
23431 If a region is active and if it contains only fixed-width areas
23432 or blank lines, remove all fixed-width markup in it. If the
23433 region contains anything else, convert all non-fixed-width lines
23434 to fixed-width ones.
23436 Blank lines at the end of the region are ignored unless the
23437 region only contains such lines."
23438 (interactive)
23439 (if (not (org-region-active-p))
23440 ;; No region:
23442 ;; Remove fixed width marker only in a fixed-with element.
23444 ;; Add fixed width maker in paragraphs, in blank lines after
23445 ;; elements or at the beginning of a headline or an inlinetask,
23446 ;; and before any one-line elements (e.g., a clock).
23447 (progn
23448 (beginning-of-line)
23449 (let* ((element (org-element-at-point))
23450 (type (org-element-type element)))
23451 (cond
23452 ((and (eq type 'fixed-width)
23453 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23454 (replace-match
23455 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23456 ((and (memq type '(babel-call clock comment diary-sexp headline
23457 horizontal-rule keyword paragraph
23458 planning))
23459 (<= (org-element-property :post-affiliated element) (point)))
23460 (skip-chars-forward " \t")
23461 (insert ": "))
23462 ((and (org-looking-at-p "[ \t]*$")
23463 (or (eq type 'inlinetask)
23464 (save-excursion
23465 (skip-chars-forward " \r\t\n")
23466 (<= (org-element-property :end element) (point)))))
23467 (delete-region (point) (line-end-position))
23468 (org-indent-line)
23469 (insert ": "))
23470 (t (user-error "Cannot insert a fixed-width line here")))))
23471 ;; Region active.
23472 (let* ((begin (save-excursion
23473 (goto-char (region-beginning))
23474 (line-beginning-position)))
23475 (end (copy-marker
23476 (save-excursion
23477 (goto-char (region-end))
23478 (unless (eolp) (beginning-of-line))
23479 (if (save-excursion (re-search-backward "\\S-" begin t))
23480 (progn (skip-chars-backward " \r\t\n") (point))
23481 (point)))))
23482 (all-fixed-width-p
23483 (catch 'not-all-p
23484 (save-excursion
23485 (goto-char begin)
23486 (skip-chars-forward " \r\t\n")
23487 (when (eobp) (throw 'not-all-p nil))
23488 (while (< (point) end)
23489 (let ((element (org-element-at-point)))
23490 (if (eq (org-element-type element) 'fixed-width)
23491 (goto-char (org-element-property :end element))
23492 (throw 'not-all-p nil))))
23493 t))))
23494 (if all-fixed-width-p
23495 (save-excursion
23496 (goto-char begin)
23497 (while (< (point) end)
23498 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23499 (replace-match
23500 "" nil nil nil
23501 (if (= (line-end-position) (match-end 0)) 0 1)))
23502 (forward-line)))
23503 (let ((min-ind (point-max)))
23504 ;; Find minimum indentation across all lines.
23505 (save-excursion
23506 (goto-char begin)
23507 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23508 (setq min-ind 0)
23509 (catch 'zerop
23510 (while (< (point) end)
23511 (unless (org-looking-at-p "[ \t]*$")
23512 (let ((ind (org-get-indentation)))
23513 (setq min-ind (min min-ind ind))
23514 (when (zerop ind) (throw 'zerop t))))
23515 (forward-line)))))
23516 ;; Loop over all lines and add fixed-width markup everywhere
23517 ;; but in fixed-width lines.
23518 (save-excursion
23519 (goto-char begin)
23520 (while (< (point) end)
23521 (cond
23522 ((org-at-heading-p)
23523 (insert ": ")
23524 (forward-line)
23525 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23526 (insert ":")
23527 (forward-line)))
23528 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23529 (let* ((element (org-element-at-point))
23530 (element-end (org-element-property :end element)))
23531 (if (eq (org-element-type element) 'fixed-width)
23532 (progn (goto-char element-end)
23533 (skip-chars-backward " \r\t\n")
23534 (forward-line))
23535 (let ((limit (min end element-end)))
23536 (while (< (point) limit)
23537 (org-move-to-column min-ind t)
23538 (insert ": ")
23539 (forward-line))))))
23541 (org-move-to-column min-ind t)
23542 (insert ": ")
23543 (forward-line)))))))
23544 (set-marker end nil))))
23547 ;;; Comments
23549 ;; Org comments syntax is quite complex. It requires the entire line
23550 ;; to be just a comment. Also, even with the right syntax at the
23551 ;; beginning of line, some some elements (i.e. verse-block or
23552 ;; example-block) don't accept comments. Usual Emacs comment commands
23553 ;; cannot cope with those requirements. Therefore, Org replaces them.
23555 ;; Org still relies on `comment-dwim', but cannot trust
23556 ;; `comment-only-p'. So, `comment-region-function' and
23557 ;; `uncomment-region-function' both point
23558 ;; to`org-comment-or-uncomment-region'. Eventually,
23559 ;; `org-insert-comment' takes care of insertion of comments at the
23560 ;; beginning of line.
23562 ;; `org-setup-comments-handling' install comments related variables
23563 ;; during `org-mode' initialization.
23565 (defun org-setup-comments-handling ()
23566 (interactive)
23567 (org-set-local 'comment-use-syntax nil)
23568 (org-set-local 'comment-start "# ")
23569 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23570 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23571 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23572 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23574 (defun org-insert-comment ()
23575 "Insert an empty comment above current line.
23576 If the line is empty, insert comment at its beginning. When
23577 point is within a source block, comment according to the related
23578 major mode."
23579 (if (let ((element (org-element-at-point)))
23580 (and (eq (org-element-type element) 'src-block)
23581 (< (save-excursion
23582 (goto-char (org-element-property :post-affiliated element))
23583 (line-end-position))
23584 (point))
23585 (> (save-excursion
23586 (goto-char (org-element-property :end element))
23587 (skip-chars-backward " \r\t\n")
23588 (line-beginning-position))
23589 (point))))
23590 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23591 (beginning-of-line)
23592 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23593 (open-line 1))
23594 (org-indent-line)
23595 (insert "# ")))
23597 (defvar comment-empty-lines) ; From newcomment.el.
23598 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23599 "Comment or uncomment each non-blank line in the region.
23600 Uncomment each non-blank line between BEG and END if it only
23601 contains commented lines. Otherwise, comment them. If region is
23602 strictly within a source block, use appropriate comment syntax."
23603 (if (let ((element (org-element-at-point)))
23604 (and (eq (org-element-type element) 'src-block)
23605 (< (save-excursion
23606 (goto-char (org-element-property :post-affiliated element))
23607 (line-end-position))
23608 beg)
23609 (>= (save-excursion
23610 (goto-char (org-element-property :end element))
23611 (skip-chars-backward " \r\t\n")
23612 (line-beginning-position))
23613 end)))
23614 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23615 (save-restriction
23616 ;; Restrict region
23617 (narrow-to-region (save-excursion (goto-char beg)
23618 (skip-chars-forward " \r\t\n" end)
23619 (line-beginning-position))
23620 (save-excursion (goto-char end)
23621 (skip-chars-backward " \r\t\n" beg)
23622 (line-end-position)))
23623 (let ((uncommentp
23624 ;; UNCOMMENTP is non-nil when every non blank line between
23625 ;; BEG and END is a comment.
23626 (save-excursion
23627 (goto-char (point-min))
23628 (while (and (not (eobp))
23629 (let ((element (org-element-at-point)))
23630 (and (eq (org-element-type element) 'comment)
23631 (goto-char (min (point-max)
23632 (org-element-property
23633 :end element)))))))
23634 (eobp))))
23635 (if uncommentp
23636 ;; Only blank lines and comments in region: uncomment it.
23637 (save-excursion
23638 (goto-char (point-min))
23639 (while (not (eobp))
23640 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23641 (replace-match "" nil nil nil 1))
23642 (forward-line)))
23643 ;; Comment each line in region.
23644 (let ((min-indent (point-max)))
23645 ;; First find the minimum indentation across all lines.
23646 (save-excursion
23647 (goto-char (point-min))
23648 (while (and (not (eobp)) (not (zerop min-indent)))
23649 (unless (looking-at "[ \t]*$")
23650 (setq min-indent (min min-indent (current-indentation))))
23651 (forward-line)))
23652 ;; Then loop over all lines.
23653 (save-excursion
23654 (goto-char (point-min))
23655 (while (not (eobp))
23656 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23657 ;; Don't get fooled by invisible text (e.g. link path)
23658 ;; when moving to column MIN-INDENT.
23659 (let ((buffer-invisibility-spec nil))
23660 (org-move-to-column min-indent t))
23661 (insert comment-start))
23662 (forward-line)))))))))
23664 (defun org-comment-dwim (arg)
23665 "Call `comment-dwim' within a source edit buffer if needed."
23666 (interactive "*P")
23667 (if (org-in-src-block-p)
23668 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23669 (call-interactively 'comment-dwim)))
23672 ;;; Timestamps API
23674 ;; This section contains tools to operate on timestamp objects, as
23675 ;; returned by, e.g. `org-element-context'.
23677 (defun org-timestamp--to-internal-time (timestamp &optional end)
23678 "Encode TIMESTAMP object into Emacs internal time.
23679 Use end of date range or time range when END is non-nil."
23680 (apply #'encode-time
23681 (cons 0
23682 (mapcar
23683 (lambda (prop) (or (org-element-property prop timestamp) 0))
23684 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23685 '(:minute-start :hour-start :day-start :month-start
23686 :year-start))))))
23688 (defun org-timestamp-has-time-p (timestamp)
23689 "Non-nil when TIMESTAMP has a time specified."
23690 (org-element-property :hour-start timestamp))
23692 (defun org-timestamp-format (timestamp format &optional end utc)
23693 "Format a TIMESTAMP object into a string.
23695 FORMAT is a format specifier to be passed to
23696 `format-time-string'.
23698 When optional argument END is non-nil, use end of date-range or
23699 time-range, if possible.
23701 When optional argument UTC is non-nil, time will be expressed as
23702 Universal Time."
23703 (format-time-string
23704 format (org-timestamp--to-internal-time timestamp end) utc))
23706 (defun org-timestamp-split-range (timestamp &optional end)
23707 "Extract a TIMESTAMP object from a date or time range.
23709 END, when non-nil, means extract the end of the range.
23710 Otherwise, extract its start.
23712 Return a new timestamp object."
23713 (let ((type (org-element-property :type timestamp)))
23714 (if (memq type '(active inactive diary)) timestamp
23715 (let ((split-ts (org-element-copy timestamp)))
23716 ;; Set new type.
23717 (org-element-put-property
23718 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23719 ;; Copy start properties over end properties if END is
23720 ;; non-nil. Otherwise, copy end properties over `start' ones.
23721 (let ((p-alist '((:minute-start . :minute-end)
23722 (:hour-start . :hour-end)
23723 (:day-start . :day-end)
23724 (:month-start . :month-end)
23725 (:year-start . :year-end))))
23726 (dolist (p-cell p-alist)
23727 (org-element-put-property
23728 split-ts
23729 (funcall (if end #'car #'cdr) p-cell)
23730 (org-element-property
23731 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23732 ;; Eventually refresh `:raw-value'.
23733 (org-element-put-property split-ts :raw-value nil)
23734 (org-element-put-property
23735 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23737 (defun org-timestamp-translate (timestamp &optional boundary)
23738 "Translate TIMESTAMP object to custom format.
23740 Format string is defined in `org-time-stamp-custom-formats',
23741 which see.
23743 When optional argument BOUNDARY is non-nil, it is either the
23744 symbol `start' or `end'. In this case, only translate the
23745 starting or ending part of TIMESTAMP if it is a date or time
23746 range. Otherwise, translate both parts.
23748 Return timestamp as-is if `org-display-custom-times' is nil or if
23749 it has a `diary' type."
23750 (let ((type (org-element-property :type timestamp)))
23751 (if (or (not org-display-custom-times) (eq type 'diary))
23752 (org-element-interpret-data timestamp)
23753 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23754 org-time-stamp-custom-formats)))
23755 (if (and (not boundary) (memq type '(active-range inactive-range)))
23756 (concat (org-timestamp-format timestamp fmt)
23757 "--"
23758 (org-timestamp-format timestamp fmt t))
23759 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23763 ;;; Other stuff.
23765 (defun org-reftex-citation ()
23766 "Use reftex-citation to insert a citation into the buffer.
23767 This looks for a line like
23769 #+BIBLIOGRAPHY: foo plain option:-d
23771 and derives from it that foo.bib is the bibliography file relevant
23772 for this document. It then installs the necessary environment for RefTeX
23773 to work in this buffer and calls `reftex-citation' to insert a citation
23774 into the buffer.
23776 Export of such citations to both LaTeX and HTML is handled by the contributed
23777 package ox-bibtex by Taru Karttunen."
23778 (interactive)
23779 (let ((reftex-docstruct-symbol 'rds)
23780 (reftex-cite-format "\\cite{%l}")
23781 rds bib)
23782 (save-excursion
23783 (save-restriction
23784 (widen)
23785 (let ((case-fold-search t)
23786 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23787 (if (not (save-excursion
23788 (or (re-search-forward re nil t)
23789 (re-search-backward re nil t))))
23790 (user-error "No bibliography defined in file")
23791 (setq bib (concat (match-string 1) ".bib")
23792 rds (list (list 'bib bib)))))))
23793 (call-interactively 'reftex-citation)))
23795 ;;;; Functions extending outline functionality
23797 (defun org-beginning-of-line (&optional arg)
23798 "Go to the beginning of the current line. If that is invisible, continue
23799 to a visible line beginning. This makes the function of C-a more intuitive.
23800 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23801 first attempt, and only move to after the tags when the cursor is already
23802 beyond the end of the headline."
23803 (interactive "P")
23804 (let ((pos (point))
23805 (special (if (consp org-special-ctrl-a/e)
23806 (car org-special-ctrl-a/e)
23807 org-special-ctrl-a/e))
23808 deactivate-mark refpos)
23809 (if (org-bound-and-true-p visual-line-mode)
23810 (beginning-of-visual-line 1)
23811 (beginning-of-line 1))
23812 (if (and arg (fboundp 'move-beginning-of-line))
23813 (call-interactively 'move-beginning-of-line)
23814 (if (bobp)
23816 (backward-char 1)
23817 (if (org-truely-invisible-p)
23818 (while (and (not (bobp)) (org-truely-invisible-p))
23819 (backward-char 1)
23820 (beginning-of-line 1))
23821 (forward-char 1))))
23822 (when special
23823 (cond
23824 ((and (looking-at org-complex-heading-regexp)
23825 (= (char-after (match-end 1)) ?\ ))
23826 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23827 (point-at-eol)))
23828 (goto-char
23829 (if (eq special t)
23830 (cond ((> pos refpos) refpos)
23831 ((= pos (point)) refpos)
23832 (t (point)))
23833 (cond ((> pos (point)) (point))
23834 ((not (eq last-command this-command)) (point))
23835 (t refpos)))))
23836 ((org-at-item-p)
23837 ;; Being at an item and not looking at an the item means point
23838 ;; was previously moved to beginning of a visual line, which
23839 ;; doesn't contain the item. Therefore, do nothing special,
23840 ;; just stay here.
23841 (when (looking-at org-list-full-item-re)
23842 ;; Set special position at first white space character after
23843 ;; bullet, and check-box, if any.
23844 (let ((after-bullet
23845 (let ((box (match-end 3)))
23846 (if (not box) (match-end 1)
23847 (let ((after (char-after box)))
23848 (if (and after (= after ? )) (1+ box) box))))))
23849 ;; Special case: Move point to special position when
23850 ;; currently after it or at beginning of line.
23851 (if (eq special t)
23852 (when (or (> pos after-bullet) (= (point) pos))
23853 (goto-char after-bullet))
23854 ;; Reversed case: Move point to special position when
23855 ;; point was already at beginning of line and command is
23856 ;; repeated.
23857 (when (and (= (point) pos) (eq last-command this-command))
23858 (goto-char after-bullet))))))))
23859 (org-no-warnings
23860 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23861 (setq disable-point-adjustment
23862 (or (not (invisible-p (point)))
23863 (not (invisible-p (max (point-min) (1- (point))))))))
23865 (defun org-end-of-line (&optional arg)
23866 "Go to the end of the line.
23867 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23868 tags on the first attempt, and only move to after the tags when
23869 the cursor is already beyond the end of the headline."
23870 (interactive "P")
23871 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23872 org-special-ctrl-a/e))
23873 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23874 'end-of-visual-line)
23875 ((fboundp 'move-end-of-line) 'move-end-of-line)
23876 (t 'end-of-line)))
23877 deactivate-mark)
23878 (if (or (not special) arg) (call-interactively move-fun)
23879 (let* ((element (save-excursion (beginning-of-line)
23880 (org-element-at-point)))
23881 (type (org-element-type element)))
23882 (cond
23883 ((memq type '(headline inlinetask))
23884 (let ((pos (point)))
23885 (beginning-of-line 1)
23886 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23887 (if (eq special t)
23888 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23889 (goto-char (match-beginning 1))
23890 (goto-char (match-end 0)))
23891 (if (or (< pos (match-end 0))
23892 (not (eq this-command last-command)))
23893 (goto-char (match-end 0))
23894 (goto-char (match-beginning 1))))
23895 (call-interactively move-fun))))
23896 ((outline-invisible-p (line-end-position))
23897 ;; If element is hidden, `move-end-of-line' would put point
23898 ;; after it. Use `end-of-line' to stay on current line.
23899 (call-interactively 'end-of-line))
23900 (t (call-interactively move-fun)))))
23901 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23902 (setq disable-point-adjustment
23903 (or (not (invisible-p (point)))
23904 (not (invisible-p (max (point-min) (1- (point))))))))
23906 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23907 (define-key org-mode-map "\C-e" 'org-end-of-line)
23909 (defun org-backward-sentence (&optional arg)
23910 "Go to beginning of sentence, or beginning of table field.
23911 This will call `backward-sentence' or `org-table-beginning-of-field',
23912 depending on context."
23913 (interactive "P")
23914 (let* ((element (org-element-at-point))
23915 (contents-begin (org-element-property :contents-begin element))
23916 (table (org-element-lineage element '(table) t)))
23917 (if (and table
23918 (> (point) contents-begin)
23919 (<= (point) (org-element-property :contents-end table)))
23920 (call-interactively #'org-table-beginning-of-field)
23921 (save-restriction
23922 (when (and contents-begin
23923 (< (point-min) contents-begin)
23924 (> (point) contents-begin))
23925 (narrow-to-region contents-begin
23926 (org-element-property :contents-end element)))
23927 (call-interactively #'backward-sentence)))))
23929 (defun org-forward-sentence (&optional arg)
23930 "Go to end of sentence, or end of table field.
23931 This will call `forward-sentence' or `org-table-end-of-field',
23932 depending on context."
23933 (interactive "P")
23934 (let* ((element (org-element-at-point))
23935 (contents-end (org-element-property :contents-end element))
23936 (table (org-element-lineage element '(table) t)))
23937 (if (and table
23938 (>= (point) (org-element-property :contents-begin table))
23939 (< (point) contents-end))
23940 (call-interactively #'org-table-end-of-field)
23941 (save-restriction
23942 (when (and contents-end
23943 (> (point-max) contents-end)
23944 ;; Skip blank lines between elements.
23945 (< (org-element-property :end element)
23946 (save-excursion (goto-char contents-end)
23947 (skip-chars-forward " \r\t\n"))))
23948 (narrow-to-region (org-element-property :contents-begin element)
23949 contents-end))
23950 (call-interactively #'forward-sentence)))))
23952 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23953 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23955 (defun org-kill-line (&optional arg)
23956 "Kill line, to tags or end of line."
23957 (interactive "P")
23958 (cond
23959 ((or (not org-special-ctrl-k)
23960 (bolp)
23961 (not (org-at-heading-p)))
23962 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23963 org-ctrl-k-protect-subtree)
23964 (if (or (eq org-ctrl-k-protect-subtree 'error)
23965 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23966 (user-error "C-k aborted as it would kill a hidden subtree")))
23967 (call-interactively
23968 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23969 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23970 (kill-region (point) (match-beginning 1))
23971 (org-set-tags nil t))
23972 (t (kill-region (point) (point-at-eol)))))
23974 (define-key org-mode-map "\C-k" 'org-kill-line)
23976 (defun org-yank (&optional arg)
23977 "Yank. If the kill is a subtree, treat it specially.
23978 This command will look at the current kill and check if is a single
23979 subtree, or a series of subtrees[1]. If it passes the test, and if the
23980 cursor is at the beginning of a line or after the stars of a currently
23981 empty headline, then the yank is handled specially. How exactly depends
23982 on the value of the following variables, both set by default.
23984 `org-yank-folded-subtrees'
23985 When set, the subtree(s) will be folded after insertion, but only
23986 if doing so would now swallow text after the yanked text.
23988 `org-yank-adjusted-subtrees'
23989 When set, the subtree will be promoted or demoted in order to
23990 fit into the local outline tree structure, which means that the
23991 level will be adjusted so that it becomes the smaller one of the
23992 two *visible* surrounding headings.
23994 Any prefix to this command will cause `yank' to be called directly with
23995 no special treatment. In particular, a simple \\[universal-argument] prefix \
23996 will just
23997 plainly yank the text as it is.
23999 \[1] The test checks if the first non-white line is a heading
24000 and if there are no other headings with fewer stars."
24001 (interactive "P")
24002 (org-yank-generic 'yank arg))
24004 (defun org-yank-generic (command arg)
24005 "Perform some yank-like command.
24007 This function implements the behavior described in the `org-yank'
24008 documentation. However, it has been generalized to work for any
24009 interactive command with similar behavior."
24011 ;; pretend to be command COMMAND
24012 (setq this-command command)
24014 (if arg
24015 (call-interactively command)
24017 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24018 (and (org-kill-is-subtree-p)
24019 (or (bolp)
24020 (and (looking-at "[ \t]*$")
24021 (string-match
24022 "\\`\\*+\\'"
24023 (buffer-substring (point-at-bol) (point)))))))
24024 swallowp)
24025 (cond
24026 ((and subtreep org-yank-folded-subtrees)
24027 (let ((beg (point))
24028 end)
24029 (if (and subtreep org-yank-adjusted-subtrees)
24030 (org-paste-subtree nil nil 'for-yank)
24031 (call-interactively command))
24033 (setq end (point))
24034 (goto-char beg)
24035 (when (and (bolp) subtreep
24036 (not (setq swallowp
24037 (org-yank-folding-would-swallow-text beg end))))
24038 (org-with-limited-levels
24039 (or (looking-at org-outline-regexp)
24040 (re-search-forward org-outline-regexp-bol end t))
24041 (while (and (< (point) end) (looking-at org-outline-regexp))
24042 (hide-subtree)
24043 (org-cycle-show-empty-lines 'folded)
24044 (condition-case nil
24045 (outline-forward-same-level 1)
24046 (error (goto-char end))))))
24047 (when swallowp
24048 (message
24049 "Inserted text not folded because that would swallow text"))
24051 (goto-char end)
24052 (skip-chars-forward " \t\n\r")
24053 (beginning-of-line 1)
24054 (push-mark beg 'nomsg)))
24055 ((and subtreep org-yank-adjusted-subtrees)
24056 (let ((beg (point-at-bol)))
24057 (org-paste-subtree nil nil 'for-yank)
24058 (push-mark beg 'nomsg)))
24060 (call-interactively command))))))
24062 (defun org-yank-folding-would-swallow-text (beg end)
24063 "Would hide-subtree at BEG swallow any text after END?"
24064 (let (level)
24065 (org-with-limited-levels
24066 (save-excursion
24067 (goto-char beg)
24068 (when (or (looking-at org-outline-regexp)
24069 (re-search-forward org-outline-regexp-bol end t))
24070 (setq level (org-outline-level)))
24071 (goto-char end)
24072 (skip-chars-forward " \t\r\n\v\f")
24073 (if (or (eobp)
24074 (and (bolp) (looking-at org-outline-regexp)
24075 (<= (org-outline-level) level)))
24076 nil ; Nothing would be swallowed
24077 t))))) ; something would swallow
24079 (define-key org-mode-map "\C-y" 'org-yank)
24081 (defun org-truely-invisible-p ()
24082 "Check if point is at a character currently not visible.
24083 This version does not only check the character property, but also
24084 `visible-mode'."
24085 ;; Early versions of noutline don't have `outline-invisible-p'.
24086 (if (org-bound-and-true-p visible-mode)
24088 (outline-invisible-p)))
24090 (defun org-invisible-p2 ()
24091 "Check if point is at a character currently not visible."
24092 (save-excursion
24093 (if (and (eolp) (not (bobp))) (backward-char 1))
24094 ;; Early versions of noutline don't have `outline-invisible-p'.
24095 (outline-invisible-p)))
24097 (defun org-back-to-heading (&optional invisible-ok)
24098 "Call `outline-back-to-heading', but provide a better error message."
24099 (condition-case nil
24100 (outline-back-to-heading invisible-ok)
24101 (error (error "Before first headline at position %d in buffer %s"
24102 (point) (current-buffer)))))
24104 (defun org-before-first-heading-p ()
24105 "Before first heading?"
24106 (save-excursion
24107 (end-of-line)
24108 (null (re-search-backward org-outline-regexp-bol nil t))))
24110 (defun org-at-heading-p (&optional ignored)
24111 (outline-on-heading-p t))
24112 ;; Compatibility alias with Org versions < 7.8.03
24113 (defalias 'org-on-heading-p 'org-at-heading-p)
24115 (defun org-in-commented-heading-p (&optional no-inheritance)
24116 "Non-nil if point is under a commented heading.
24117 This function also checks ancestors of the current headline,
24118 unless optional argument NO-INHERITANCE is non-nil."
24119 (cond
24120 ((org-before-first-heading-p) nil)
24121 ((let ((headline (nth 4 (org-heading-components))))
24122 (and headline
24123 (let ((case-fold-search nil))
24124 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24125 headline)))))
24126 (no-inheritance nil)
24128 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24130 (defun org-at-comment-p nil
24131 "Is cursor in a commented line?"
24132 (save-excursion
24133 (save-match-data
24134 (beginning-of-line)
24135 (looking-at "^[ \t]*# "))))
24137 (defun org-at-drawer-p nil
24138 "Is cursor at a drawer keyword?"
24139 (save-excursion
24140 (move-beginning-of-line 1)
24141 (looking-at org-drawer-regexp)))
24143 (defun org-at-block-p nil
24144 "Is cursor at a block keyword?"
24145 (save-excursion
24146 (move-beginning-of-line 1)
24147 (looking-at org-block-regexp)))
24149 (defun org-point-at-end-of-empty-headline ()
24150 "If point is at the end of an empty headline, return t, else nil.
24151 If the heading only contains a TODO keyword, it is still still considered
24152 empty."
24153 (and (looking-at "[ \t]*$")
24154 (when org-todo-line-regexp
24155 (save-excursion
24156 (beginning-of-line 1)
24157 (let ((case-fold-search nil))
24158 (looking-at org-todo-line-regexp)
24159 (string= (match-string 3) ""))))))
24161 (defun org-at-heading-or-item-p ()
24162 (or (org-at-heading-p) (org-at-item-p)))
24164 (defun org-at-target-p ()
24165 (or (org-in-regexp org-radio-target-regexp)
24166 (org-in-regexp org-target-regexp)))
24167 ;; Compatibility alias with Org versions < 7.8.03
24168 (defalias 'org-on-target-p 'org-at-target-p)
24170 (defun org-up-heading-all (arg)
24171 "Move to the heading line of which the present line is a subheading.
24172 This function considers both visible and invisible heading lines.
24173 With argument, move up ARG levels."
24174 (if (fboundp 'outline-up-heading-all)
24175 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24176 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24178 (defun org-up-heading-safe ()
24179 "Move to the heading line of which the present line is a subheading.
24180 This version will not throw an error. It will return the level of the
24181 headline found, or nil if no higher level is found.
24183 Also, this function will be a lot faster than `outline-up-heading',
24184 because it relies on stars being the outline starters. This can really
24185 make a significant difference in outlines with very many siblings."
24186 (when (ignore-errors (org-back-to-heading t))
24187 (let ((level-up (1- (funcall outline-level))))
24188 (and (> level-up 0)
24189 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24190 (funcall outline-level)))))
24192 (defun org-first-sibling-p ()
24193 "Is this heading the first child of its parents?"
24194 (interactive)
24195 (let ((re org-outline-regexp-bol)
24196 level l)
24197 (unless (org-at-heading-p t)
24198 (user-error "Not at a heading"))
24199 (setq level (funcall outline-level))
24200 (save-excursion
24201 (if (not (re-search-backward re nil t))
24203 (setq l (funcall outline-level))
24204 (< l level)))))
24206 (defun org-goto-sibling (&optional previous)
24207 "Goto the next sibling, even if it is invisible.
24208 When PREVIOUS is set, go to the previous sibling instead. Returns t
24209 when a sibling was found. When none is found, return nil and don't
24210 move point."
24211 (let ((fun (if previous 're-search-backward 're-search-forward))
24212 (pos (point))
24213 (re org-outline-regexp-bol)
24214 level l)
24215 (when (ignore-errors (org-back-to-heading t))
24216 (setq level (funcall outline-level))
24217 (catch 'exit
24218 (or previous (forward-char 1))
24219 (while (funcall fun re nil t)
24220 (setq l (funcall outline-level))
24221 (when (< l level) (goto-char pos) (throw 'exit nil))
24222 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24223 (goto-char pos)
24224 nil))))
24226 (defun org-show-siblings ()
24227 "Show all siblings of the current headline."
24228 (save-excursion
24229 (while (org-goto-sibling) (org-flag-heading nil)))
24230 (save-excursion
24231 (while (org-goto-sibling 'previous)
24232 (org-flag-heading nil))))
24234 (defun org-goto-first-child ()
24235 "Goto the first child, even if it is invisible.
24236 Return t when a child was found. Otherwise don't move point and
24237 return nil."
24238 (let (level (pos (point)) (re org-outline-regexp-bol))
24239 (when (ignore-errors (org-back-to-heading t))
24240 (setq level (outline-level))
24241 (forward-char 1)
24242 (if (and (re-search-forward re nil t) (> (outline-level) level))
24243 (progn (goto-char (match-beginning 0)) t)
24244 (goto-char pos) nil))))
24246 (defun org-show-hidden-entry ()
24247 "Show an entry where even the heading is hidden."
24248 (save-excursion
24249 (org-show-entry)))
24251 (defun org-flag-heading (flag &optional entry)
24252 "Flag the current heading. FLAG non-nil means make invisible.
24253 When ENTRY is non-nil, show the entire entry."
24254 (save-excursion
24255 (org-back-to-heading t)
24256 ;; Check if we should show the entire entry
24257 (if entry
24258 (progn
24259 (org-show-entry)
24260 (save-excursion
24261 (and (outline-next-heading)
24262 (org-flag-heading nil))))
24263 (outline-flag-region (max (point-min) (1- (point)))
24264 (save-excursion (outline-end-of-heading) (point))
24265 flag))))
24267 (defun org-get-next-sibling ()
24268 "Move to next heading of the same level, and return point.
24269 If there is no such heading, return nil.
24270 This is like outline-next-sibling, but invisible headings are ok."
24271 (let ((level (funcall outline-level)))
24272 (outline-next-heading)
24273 (while (and (not (eobp)) (> (funcall outline-level) level))
24274 (outline-next-heading))
24275 (if (or (eobp) (< (funcall outline-level) level))
24277 (point))))
24279 (defun org-get-last-sibling ()
24280 "Move to previous heading of the same level, and return point.
24281 If there is no such heading, return nil."
24282 (let ((opoint (point))
24283 (level (funcall outline-level)))
24284 (outline-previous-heading)
24285 (when (and (/= (point) opoint) (outline-on-heading-p t))
24286 (while (and (> (funcall outline-level) level)
24287 (not (bobp)))
24288 (outline-previous-heading))
24289 (if (< (funcall outline-level) level)
24291 (point)))))
24293 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24294 "Goto to the end of a subtree."
24295 ;; This contains an exact copy of the original function, but it uses
24296 ;; `org-back-to-heading', to make it work also in invisible
24297 ;; trees. And is uses an invisible-ok argument.
24298 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24299 ;; Furthermore, when used inside Org, finding the end of a large subtree
24300 ;; with many children and grandchildren etc, this can be much faster
24301 ;; than the outline version.
24302 (org-back-to-heading invisible-ok)
24303 (let ((first t)
24304 (level (funcall outline-level)))
24305 (if (and (derived-mode-p 'org-mode) (< level 1000))
24306 ;; A true heading (not a plain list item), in Org-mode
24307 ;; This means we can easily find the end by looking
24308 ;; only for the right number of stars. Using a regexp to do
24309 ;; this is so much faster than using a Lisp loop.
24310 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24311 (forward-char 1)
24312 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24313 ;; something else, do it the slow way
24314 (while (and (not (eobp))
24315 (or first (> (funcall outline-level) level)))
24316 (setq first nil)
24317 (outline-next-heading)))
24318 (unless to-heading
24319 (if (memq (preceding-char) '(?\n ?\^M))
24320 (progn
24321 ;; Go to end of line before heading
24322 (forward-char -1)
24323 (if (memq (preceding-char) '(?\n ?\^M))
24324 ;; leave blank line before heading
24325 (forward-char -1))))))
24326 (point))
24328 (defun org-end-of-meta-data (&optional full)
24329 "Skip planning line and properties drawer in current entry.
24330 When optional argument FULL is non-nil, also skip empty lines,
24331 clocking lines and regular drawers at the beginning of the
24332 entry."
24333 (org-back-to-heading t)
24334 (forward-line)
24335 (when (org-looking-at-p org-planning-line-re) (forward-line))
24336 (when (looking-at org-property-drawer-re)
24337 (goto-char (match-end 0))
24338 (forward-line))
24339 (when (and full (not (org-at-heading-p)))
24340 (catch 'exit
24341 (let ((end (save-excursion (outline-next-heading) (point)))
24342 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24343 (while (not (eobp))
24344 (cond ((org-looking-at-p org-drawer-regexp)
24345 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24346 (forward-line)
24347 (throw 'exit t)))
24348 ((org-looking-at-p re) (forward-line))
24349 (t (throw 'exit t))))))))
24351 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24352 "Move forward to the ARG'th subheading at same level as this one.
24353 Stop at the first and last subheadings of a superior heading.
24354 Normally this only looks at visible headings, but when INVISIBLE-OK is
24355 non-nil it will also look at invisible ones."
24356 (interactive "p")
24357 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24358 (if (and arg (< arg 0))
24359 (goto-char (point-min))
24360 (outline-next-heading))
24361 (org-at-heading-p)
24362 (let ((level (- (match-end 0) (match-beginning 0) 1))
24363 (f (if (and arg (< arg 0))
24364 're-search-backward
24365 're-search-forward))
24366 (count (if arg (abs arg) 1))
24367 (result (point)))
24368 (while (and (prog1 (> count 0)
24369 (forward-char (if (and arg (< arg 0)) -1 1)))
24370 (funcall f org-outline-regexp-bol nil 'move))
24371 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24372 (cond ((< l level) (setq count 0))
24373 ((and (= l level)
24374 (or invisible-ok
24375 (progn
24376 (goto-char (line-beginning-position))
24377 (not (outline-invisible-p)))))
24378 (setq count (1- count))
24379 (when (eq l level)
24380 (setq result (point)))))))
24381 (goto-char result))
24382 (beginning-of-line 1)))
24384 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24385 "Move backward to the ARG'th subheading at same level as this one.
24386 Stop at the first and last subheadings of a superior heading."
24387 (interactive "p")
24388 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24390 (defun org-next-visible-heading (arg)
24391 "Move to the next visible heading.
24393 This function wraps `outline-next-visible-heading' with
24394 `org-with-limited-levels' in order to skip over inline tasks and
24395 respect customization of `org-odd-levels-only'."
24396 (interactive "p")
24397 (org-with-limited-levels
24398 (outline-next-visible-heading arg)))
24400 (defun org-previous-visible-heading (arg)
24401 "Move to the next visible heading.
24403 This function wraps `outline-previous-visible-heading' with
24404 `org-with-limited-levels' in order to skip over inline tasks and
24405 respect customization of `org-odd-levels-only'."
24406 (interactive "p")
24407 (org-with-limited-levels
24408 (outline-previous-visible-heading arg)))
24410 (defun org-next-block (arg &optional backward block-regexp)
24411 "Jump to the next block.
24413 With a prefix argument ARG, jump forward ARG many blocks.
24415 When BACKWARD is non-nil, jump to the previous block.
24417 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24418 Match data is set according to this regexp when the function
24419 returns.
24421 Return point at beginning of the opening line of found block.
24422 Throw an error if no block is found."
24423 (interactive "p")
24424 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24425 (case-fold-search t)
24426 (search-fn (if backward #'re-search-backward #'re-search-forward))
24427 (count (or arg 1))
24428 (origin (point))
24429 last-element)
24430 (if backward (beginning-of-line) (end-of-line))
24431 (while (and (> count 0) (funcall search-fn re nil t))
24432 (let ((element (save-excursion
24433 (goto-char (match-beginning 0))
24434 (save-match-data (org-element-at-point)))))
24435 (when (and (memq (org-element-type element)
24436 '(center-block comment-block dynamic-block
24437 example-block export-block quote-block
24438 special-block src-block verse-block))
24439 (<= (match-beginning 0)
24440 (org-element-property :post-affiliated element)))
24441 (setq last-element element)
24442 (decf count))))
24443 (if (= count 0)
24444 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24445 (save-match-data (org-show-context)))
24446 (goto-char origin)
24447 (user-error "No %s code blocks" (if backward "previous" "further")))))
24449 (defun org-previous-block (arg &optional block-regexp)
24450 "Jump to the previous block.
24451 With a prefix argument ARG, jump backward ARG many source blocks.
24452 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24453 (interactive "p")
24454 (org-next-block arg t block-regexp))
24456 (defun org-forward-paragraph ()
24457 "Move forward to beginning of next paragraph or equivalent.
24459 The function moves point to the beginning of the next visible
24460 structural element, which can be a paragraph, a table, a list
24461 item, etc. It also provides some special moves for convenience:
24463 - On an affiliated keyword, jump to the beginning of the
24464 relative element.
24465 - On an item or a footnote definition, move to the second
24466 element inside, if any.
24467 - On a table or a property drawer, jump after it.
24468 - On a verse or source block, stop after blank lines."
24469 (interactive)
24470 (when (eobp) (user-error "Cannot move further down"))
24471 (let* ((deactivate-mark nil)
24472 (element (org-element-at-point))
24473 (type (org-element-type element))
24474 (post-affiliated (org-element-property :post-affiliated element))
24475 (contents-begin (org-element-property :contents-begin element))
24476 (contents-end (org-element-property :contents-end element))
24477 (end (let ((end (org-element-property :end element)) (parent element))
24478 (while (and (setq parent (org-element-property :parent parent))
24479 (= (org-element-property :contents-end parent) end))
24480 (setq end (org-element-property :end parent)))
24481 end)))
24482 (cond ((not element)
24483 (skip-chars-forward " \r\t\n")
24484 (or (eobp) (beginning-of-line)))
24485 ;; On affiliated keywords, move to element's beginning.
24486 ((< (point) post-affiliated)
24487 (goto-char post-affiliated))
24488 ;; At a table row, move to the end of the table. Similarly,
24489 ;; at a node property, move to the end of the property
24490 ;; drawer.
24491 ((memq type '(node-property table-row))
24492 (goto-char (org-element-property
24493 :end (org-element-property :parent element))))
24494 ((memq type '(property-drawer table)) (goto-char end))
24495 ;; Consider blank lines as separators in verse and source
24496 ;; blocks to ease editing.
24497 ((memq type '(src-block verse-block))
24498 (when (eq type 'src-block)
24499 (setq contents-end
24500 (save-excursion (goto-char end)
24501 (skip-chars-backward " \r\t\n")
24502 (line-beginning-position))))
24503 (beginning-of-line)
24504 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24505 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24506 (goto-char end)
24507 (skip-chars-forward " \r\t\n")
24508 (if (= (point) contents-end) (goto-char end)
24509 (beginning-of-line))))
24510 ;; With no contents, just skip element.
24511 ((not contents-begin) (goto-char end))
24512 ;; If contents are invisible, skip the element altogether.
24513 ((outline-invisible-p (line-end-position))
24514 (case type
24515 (headline
24516 (org-with-limited-levels (outline-next-visible-heading 1)))
24517 ;; At a plain list, make sure we move to the next item
24518 ;; instead of skipping the whole list.
24519 (plain-list (forward-char)
24520 (org-forward-paragraph))
24521 (otherwise (goto-char end))))
24522 ((>= (point) contents-end) (goto-char end))
24523 ((>= (point) contents-begin)
24524 ;; This can only happen on paragraphs and plain lists.
24525 (case type
24526 (paragraph (goto-char end))
24527 ;; At a plain list, try to move to second element in
24528 ;; first item, if possible.
24529 (plain-list (end-of-line)
24530 (org-forward-paragraph))))
24531 ;; When contents start on the middle of a line (e.g. in
24532 ;; items and footnote definitions), try to reach first
24533 ;; element starting after current line.
24534 ((> (line-end-position) contents-begin)
24535 (end-of-line)
24536 (org-forward-paragraph))
24537 (t (goto-char contents-begin)))))
24539 (defun org-backward-paragraph ()
24540 "Move backward to start of previous paragraph or equivalent.
24542 The function moves point to the beginning of the current
24543 structural element, which can be a paragraph, a table, a list
24544 item, etc., or to the beginning of the previous visible one if
24545 point is already there. It also provides some special moves for
24546 convenience:
24548 - On an affiliated keyword, jump to the first one.
24549 - On a table or a property drawer, move to its beginning.
24550 - On a verse or source block, stop before blank lines."
24551 (interactive)
24552 (when (bobp) (user-error "Cannot move further up"))
24553 (let* ((deactivate-mark nil)
24554 (element (org-element-at-point))
24555 (type (org-element-type element))
24556 (contents-begin (org-element-property :contents-begin element))
24557 (contents-end (org-element-property :contents-end element))
24558 (post-affiliated (org-element-property :post-affiliated element))
24559 (begin (org-element-property :begin element)))
24560 (cond
24561 ((not element) (goto-char (point-min)))
24562 ((= (point) begin)
24563 (backward-char)
24564 (org-backward-paragraph))
24565 ((<= (point) post-affiliated) (goto-char begin))
24566 ((memq type '(node-property table-row))
24567 (goto-char (org-element-property
24568 :post-affiliated (org-element-property :parent element))))
24569 ((memq type '(property-drawer table)) (goto-char begin))
24570 ((memq type '(src-block verse-block))
24571 (when (eq type 'src-block)
24572 (setq contents-begin
24573 (save-excursion (goto-char begin) (forward-line) (point))))
24574 (if (= (point) contents-begin) (goto-char post-affiliated)
24575 ;; Inside a verse block, see blank lines as paragraph
24576 ;; separators.
24577 (let ((origin (point)))
24578 (skip-chars-backward " \r\t\n" contents-begin)
24579 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24580 (skip-chars-forward " \r\t\n" origin)
24581 (if (= (point) origin) (goto-char contents-begin)
24582 (beginning-of-line))))))
24583 ((not contents-begin) (goto-char (or post-affiliated begin)))
24584 ((eq type 'paragraph)
24585 (goto-char contents-begin)
24586 ;; When at first paragraph in an item or a footnote definition,
24587 ;; move directly to beginning of line.
24588 (let ((parent-contents
24589 (org-element-property
24590 :contents-begin (org-element-property :parent element))))
24591 (when (and parent-contents (= parent-contents contents-begin))
24592 (beginning-of-line))))
24593 ;; At the end of a greater element, move to the beginning of the
24594 ;; last element within.
24595 ((>= (point) contents-end)
24596 (goto-char (1- contents-end))
24597 (org-backward-paragraph))
24598 (t (goto-char (or post-affiliated begin))))
24599 ;; Ensure we never leave point invisible.
24600 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24602 (defun org-forward-element ()
24603 "Move forward by one element.
24604 Move to the next element at the same level, when possible."
24605 (interactive)
24606 (cond ((eobp) (user-error "Cannot move further down"))
24607 ((org-with-limited-levels (org-at-heading-p))
24608 (let ((origin (point)))
24609 (goto-char (org-end-of-subtree nil t))
24610 (unless (org-with-limited-levels (org-at-heading-p))
24611 (goto-char origin)
24612 (user-error "Cannot move further down"))))
24614 (let* ((elem (org-element-at-point))
24615 (end (org-element-property :end elem))
24616 (parent (org-element-property :parent elem)))
24617 (cond ((and parent (= (org-element-property :contents-end parent) end))
24618 (goto-char (org-element-property :end parent)))
24619 ((integer-or-marker-p end) (goto-char end))
24620 (t (message "No element at point")))))))
24622 (defun org-backward-element ()
24623 "Move backward by one element.
24624 Move to the previous element at the same level, when possible."
24625 (interactive)
24626 (cond ((bobp) (user-error "Cannot move further up"))
24627 ((org-with-limited-levels (org-at-heading-p))
24628 ;; At a headline, move to the previous one, if any, or stay
24629 ;; here.
24630 (let ((origin (point)))
24631 (org-with-limited-levels (org-backward-heading-same-level 1))
24632 ;; When current headline has no sibling above, move to its
24633 ;; parent.
24634 (when (= (point) origin)
24635 (or (org-with-limited-levels (org-up-heading-safe))
24636 (progn (goto-char origin)
24637 (user-error "Cannot move further up"))))))
24639 (let* ((elem (org-element-at-point))
24640 (beg (org-element-property :begin elem)))
24641 (cond
24642 ;; Move to beginning of current element if point isn't
24643 ;; there already.
24644 ((null beg) (message "No element at point"))
24645 ((/= (point) beg) (goto-char beg))
24646 (t (goto-char beg)
24647 (skip-chars-backward " \r\t\n")
24648 (unless (bobp)
24649 (let ((prev (org-element-at-point)))
24650 (goto-char (org-element-property :begin prev))
24651 (while (and (setq prev (org-element-property :parent prev))
24652 (<= (org-element-property :end prev) beg))
24653 (goto-char (org-element-property :begin prev)))))))))))
24655 (defun org-up-element ()
24656 "Move to upper element."
24657 (interactive)
24658 (if (org-with-limited-levels (org-at-heading-p))
24659 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24660 (let* ((elem (org-element-at-point))
24661 (parent (org-element-property :parent elem)))
24662 (if parent (goto-char (org-element-property :begin parent))
24663 (if (org-with-limited-levels (org-before-first-heading-p))
24664 (user-error "No surrounding element")
24665 (org-with-limited-levels (org-back-to-heading)))))))
24667 (defvar org-element-greater-elements)
24668 (defun org-down-element ()
24669 "Move to inner element."
24670 (interactive)
24671 (let ((element (org-element-at-point)))
24672 (cond
24673 ((memq (org-element-type element) '(plain-list table))
24674 (goto-char (org-element-property :contents-begin element))
24675 (forward-char))
24676 ((memq (org-element-type element) org-element-greater-elements)
24677 ;; If contents are hidden, first disclose them.
24678 (when (outline-invisible-p (line-end-position)) (org-cycle))
24679 (goto-char (or (org-element-property :contents-begin element)
24680 (user-error "No content for this element"))))
24681 (t (user-error "No inner element")))))
24683 (defun org-drag-element-backward ()
24684 "Move backward element at point."
24685 (interactive)
24686 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24687 (let* ((elem (org-element-at-point))
24688 (prev-elem
24689 (save-excursion
24690 (goto-char (org-element-property :begin elem))
24691 (skip-chars-backward " \r\t\n")
24692 (unless (bobp)
24693 (let* ((beg (org-element-property :begin elem))
24694 (prev (org-element-at-point))
24695 (up prev))
24696 (while (and (setq up (org-element-property :parent up))
24697 (<= (org-element-property :end up) beg))
24698 (setq prev up))
24699 prev)))))
24700 ;; Error out if no previous element or previous element is
24701 ;; a parent of the current one.
24702 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24703 (user-error "Cannot drag element backward")
24704 (let ((pos (point)))
24705 (org-element-swap-A-B prev-elem elem)
24706 (goto-char (+ (org-element-property :begin prev-elem)
24707 (- pos (org-element-property :begin elem)))))))))
24709 (defun org-drag-element-forward ()
24710 "Move forward element at point."
24711 (interactive)
24712 (let* ((pos (point))
24713 (elem (org-element-at-point)))
24714 (when (= (point-max) (org-element-property :end elem))
24715 (user-error "Cannot drag element forward"))
24716 (goto-char (org-element-property :end elem))
24717 (let ((next-elem (org-element-at-point)))
24718 (when (or (org-element-nested-p elem next-elem)
24719 (and (eq (org-element-type next-elem) 'headline)
24720 (not (eq (org-element-type elem) 'headline))))
24721 (goto-char pos)
24722 (user-error "Cannot drag element forward"))
24723 ;; Compute new position of point: it's shifted by NEXT-ELEM
24724 ;; body's length (without final blanks) and by the length of
24725 ;; blanks between ELEM and NEXT-ELEM.
24726 (let ((size-next (- (save-excursion
24727 (goto-char (org-element-property :end next-elem))
24728 (skip-chars-backward " \r\t\n")
24729 (forward-line)
24730 ;; Small correction if buffer doesn't end
24731 ;; with a newline character.
24732 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24733 (org-element-property :begin next-elem)))
24734 (size-blank (- (org-element-property :end elem)
24735 (save-excursion
24736 (goto-char (org-element-property :end elem))
24737 (skip-chars-backward " \r\t\n")
24738 (forward-line)
24739 (point)))))
24740 (org-element-swap-A-B elem next-elem)
24741 (goto-char (+ pos size-next size-blank))))))
24743 (defun org-drag-line-forward (arg)
24744 "Drag the line at point ARG lines forward."
24745 (interactive "p")
24746 (dotimes (n (abs arg))
24747 (let ((c (current-column)))
24748 (if (< 0 arg)
24749 (progn
24750 (beginning-of-line 2)
24751 (transpose-lines 1)
24752 (beginning-of-line 0))
24753 (transpose-lines 1)
24754 (beginning-of-line -1))
24755 (org-move-to-column c))))
24757 (defun org-drag-line-backward (arg)
24758 "Drag the line at point ARG lines backward."
24759 (interactive "p")
24760 (org-drag-line-forward (- arg)))
24762 (defun org-mark-element ()
24763 "Put point at beginning of this element, mark at end.
24765 Interactively, if this command is repeated or (in Transient Mark
24766 mode) if the mark is active, it marks the next element after the
24767 ones already marked."
24768 (interactive)
24769 (let (deactivate-mark)
24770 (if (and (org-called-interactively-p 'any)
24771 (or (and (eq last-command this-command) (mark t))
24772 (and transient-mark-mode mark-active)))
24773 (set-mark
24774 (save-excursion
24775 (goto-char (mark))
24776 (goto-char (org-element-property :end (org-element-at-point)))))
24777 (let ((element (org-element-at-point)))
24778 (end-of-line)
24779 (push-mark (org-element-property :end element) t t)
24780 (goto-char (org-element-property :begin element))))))
24782 (defun org-narrow-to-element ()
24783 "Narrow buffer to current element."
24784 (interactive)
24785 (let ((elem (org-element-at-point)))
24786 (cond
24787 ((eq (car elem) 'headline)
24788 (narrow-to-region
24789 (org-element-property :begin elem)
24790 (org-element-property :end elem)))
24791 ((memq (car elem) org-element-greater-elements)
24792 (narrow-to-region
24793 (org-element-property :contents-begin elem)
24794 (org-element-property :contents-end elem)))
24796 (narrow-to-region
24797 (org-element-property :begin elem)
24798 (org-element-property :end elem))))))
24800 (defun org-transpose-element ()
24801 "Transpose current and previous elements, keeping blank lines between.
24802 Point is moved after both elements."
24803 (interactive)
24804 (org-skip-whitespace)
24805 (let ((end (org-element-property :end (org-element-at-point))))
24806 (org-drag-element-backward)
24807 (goto-char end)))
24809 (defun org-unindent-buffer ()
24810 "Un-indent the visible part of the buffer.
24811 Relative indentation (between items, inside blocks, etc.) isn't
24812 modified."
24813 (interactive)
24814 (unless (eq major-mode 'org-mode)
24815 (user-error "Cannot un-indent a buffer not in Org mode"))
24816 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24817 unindent-tree ; For byte-compiler.
24818 (unindent-tree
24819 (function
24820 (lambda (contents)
24821 (mapc
24822 (lambda (element)
24823 (if (memq (org-element-type element) '(headline section))
24824 (funcall unindent-tree (org-element-contents element))
24825 (save-excursion
24826 (save-restriction
24827 (narrow-to-region
24828 (org-element-property :begin element)
24829 (org-element-property :end element))
24830 (org-do-remove-indentation)))))
24831 (reverse contents))))))
24832 (funcall unindent-tree (org-element-contents parse-tree))))
24834 (defun org-show-subtree ()
24835 "Show everything after this heading at deeper levels."
24836 (interactive)
24837 (outline-flag-region
24838 (point)
24839 (save-excursion
24840 (org-end-of-subtree t t))
24841 nil))
24843 (defun org-show-entry ()
24844 "Show the body directly following this heading.
24845 Show the heading too, if it is currently invisible."
24846 (interactive)
24847 (save-excursion
24848 (ignore-errors
24849 (org-back-to-heading t)
24850 (outline-flag-region
24851 (max (point-min) (1- (point)))
24852 (save-excursion
24853 (if (re-search-forward
24854 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24855 (match-beginning 1)
24856 (point-max)))
24857 nil)
24858 (org-cycle-hide-drawers 'children))))
24860 (defun org-make-options-regexp (kwds &optional extra)
24861 "Make a regular expression for keyword lines.
24862 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24863 when non-nil, is a regexp matching keywords names."
24864 (concat "^[ \t]*#\\+\\("
24865 (regexp-opt kwds)
24866 (and extra (concat (and kwds "\\|") extra))
24867 "\\):[ \t]*\\(.*\\)"))
24869 ;; Make isearch reveal the necessary context
24870 (defun org-isearch-end ()
24871 "Reveal context after isearch exits."
24872 (when isearch-success ; only if search was successful
24873 (if (featurep 'xemacs)
24874 ;; Under XEmacs, the hook is run in the correct place,
24875 ;; we directly show the context.
24876 (org-show-context 'isearch)
24877 ;; In Emacs the hook runs *before* restoring the overlays.
24878 ;; So we have to use a one-time post-command-hook to do this.
24879 ;; (Emacs 22 has a special variable, see function `org-mode')
24880 (unless (and (boundp 'isearch-mode-end-hook-quit)
24881 isearch-mode-end-hook-quit)
24882 ;; Only when the isearch was not quitted.
24883 (org-add-hook 'post-command-hook 'org-isearch-post-command
24884 'append 'local)))))
24886 (defun org-isearch-post-command ()
24887 "Remove self from hook, and show context."
24888 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24889 (org-show-context 'isearch))
24892 ;;;; Integration with and fixes for other packages
24894 ;;; Imenu support
24896 (defvar org-imenu-markers nil
24897 "All markers currently used by Imenu.")
24898 (make-variable-buffer-local 'org-imenu-markers)
24900 (defun org-imenu-new-marker (&optional pos)
24901 "Return a new marker for use by Imenu, and remember the marker."
24902 (let ((m (make-marker)))
24903 (move-marker m (or pos (point)))
24904 (push m org-imenu-markers)
24907 (defun org-imenu-get-tree ()
24908 "Produce the index for Imenu."
24909 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24910 (setq org-imenu-markers nil)
24911 (let* ((n org-imenu-depth)
24912 (re (concat "^" (org-get-limited-outline-regexp)))
24913 (subs (make-vector (1+ n) nil))
24914 (last-level 0)
24915 m level head0 head)
24916 (save-excursion
24917 (save-restriction
24918 (widen)
24919 (goto-char (point-max))
24920 (while (re-search-backward re nil t)
24921 (setq level (org-reduced-level (funcall outline-level)))
24922 (when (and (<= level n)
24923 (looking-at org-complex-heading-regexp)
24924 (setq head0 (org-match-string-no-properties 4)))
24925 (setq head (org-link-display-format head0)
24926 m (org-imenu-new-marker))
24927 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24928 (if (>= level last-level)
24929 (push (cons head m) (aref subs level))
24930 (push (cons head (aref subs (1+ level))) (aref subs level))
24931 (loop for i from (1+ level) to n do (aset subs i nil)))
24932 (setq last-level level)))))
24933 (aref subs 1)))
24935 (eval-after-load "imenu"
24936 '(progn
24937 (add-hook 'imenu-after-jump-hook
24938 (lambda ()
24939 (if (derived-mode-p 'org-mode)
24940 (org-show-context 'org-goto))))))
24942 (defun org-link-display-format (link)
24943 "Replace a link with its the description.
24944 If there is no description, use the link target."
24945 (save-match-data
24946 (if (string-match org-bracket-link-analytic-regexp link)
24947 (replace-match (if (match-end 5)
24948 (match-string 5 link)
24949 (concat (match-string 1 link)
24950 (match-string 3 link)))
24951 nil t link)
24952 link)))
24954 (defun org-toggle-link-display ()
24955 "Toggle the literal or descriptive display of links."
24956 (interactive)
24957 (if org-descriptive-links
24958 (progn (org-remove-from-invisibility-spec '(org-link))
24959 (org-restart-font-lock)
24960 (setq org-descriptive-links nil))
24961 (progn (add-to-invisibility-spec '(org-link))
24962 (org-restart-font-lock)
24963 (setq org-descriptive-links t))))
24965 ;; Speedbar support
24967 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24968 "Overlay marking the agenda restriction line in speedbar.")
24969 (overlay-put org-speedbar-restriction-lock-overlay
24970 'face 'org-agenda-restriction-lock)
24971 (overlay-put org-speedbar-restriction-lock-overlay
24972 'help-echo "Agendas are currently limited to this item.")
24973 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24975 (defun org-speedbar-set-agenda-restriction ()
24976 "Restrict future agenda commands to the location at point in speedbar.
24977 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24978 (interactive)
24979 (require 'org-agenda)
24980 (let (p m tp np dir txt)
24981 (cond
24982 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24983 'org-imenu t))
24984 (setq m (get-text-property p 'org-imenu-marker))
24985 (with-current-buffer (marker-buffer m)
24986 (goto-char m)
24987 (org-agenda-set-restriction-lock 'subtree)))
24988 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24989 'speedbar-function 'speedbar-find-file))
24990 (setq tp (previous-single-property-change
24991 (1+ p) 'speedbar-function)
24992 np (next-single-property-change
24993 tp 'speedbar-function)
24994 dir (speedbar-line-directory)
24995 txt (buffer-substring-no-properties (or tp (point-min))
24996 (or np (point-max))))
24997 (with-current-buffer (find-file-noselect
24998 (let ((default-directory dir))
24999 (expand-file-name txt)))
25000 (unless (derived-mode-p 'org-mode)
25001 (user-error "Cannot restrict to non-Org-mode file"))
25002 (org-agenda-set-restriction-lock 'file)))
25003 (t (user-error "Don't know how to restrict Org-mode's agenda")))
25004 (move-overlay org-speedbar-restriction-lock-overlay
25005 (point-at-bol) (point-at-eol))
25006 (setq current-prefix-arg nil)
25007 (org-agenda-maybe-redo)))
25009 (defvar speedbar-file-key-map)
25010 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25011 (eval-after-load "speedbar"
25012 '(progn
25013 (speedbar-add-supported-extension ".org")
25014 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25015 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25016 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25017 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25018 (add-hook 'speedbar-visiting-tag-hook
25019 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25021 ;;; Fixes and Hacks for problems with other packages
25023 (defun org--flyspell-object-check-p (element)
25024 "Non-nil when Flyspell can check object at point.
25025 ELEMENT is the element at point."
25026 (let ((object (save-excursion
25027 (when (org-looking-at-p "\\>") (backward-char))
25028 (org-element-context element))))
25029 (case (org-element-type object)
25030 ;; Prevent checks in links due to keybinding conflict with
25031 ;; Flyspell.
25032 ((code entity export-snippet inline-babel-call
25033 inline-src-block line-break latex-fragment link macro
25034 statistics-cookie target timestamp verbatim)
25035 nil)
25036 (footnote-reference
25037 ;; Only in inline footnotes, within the definition.
25038 (and (eq (org-element-property :type object) 'inline)
25039 (< (save-excursion
25040 (goto-char (org-element-property :begin object))
25041 (search-forward ":" nil t 2))
25042 (point))))
25043 (otherwise t))))
25045 (defun org-mode-flyspell-verify ()
25046 "Function used for `flyspell-generic-check-word-predicate'."
25047 (if (org-at-heading-p)
25048 ;; At a headline or an inlinetask, check title only. This is
25049 ;; faster than relying on `org-element-at-point'.
25050 (and (save-excursion (beginning-of-line)
25051 (and (let ((case-fold-search t))
25052 (not (looking-at "\\*+ END[ \t]*$")))
25053 (looking-at org-complex-heading-regexp)))
25054 (match-beginning 4)
25055 (>= (point) (match-beginning 4))
25056 (or (not (match-beginning 5))
25057 (< (point) (match-beginning 5))))
25058 (let* ((element (org-element-at-point))
25059 (post-affiliated (org-element-property :post-affiliated element)))
25060 (cond
25061 ;; Ignore checks in all affiliated keywords but captions.
25062 ((< (point) post-affiliated)
25063 (and (save-excursion
25064 (beginning-of-line)
25065 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25066 (> (point) (match-end 0))
25067 (org--flyspell-object-check-p element)))
25068 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25069 ((let ((log (org-log-into-drawer)))
25070 (and log
25071 (let ((drawer (org-element-lineage element '(drawer))))
25072 (and drawer
25073 (eq (compare-strings
25074 log nil nil
25075 (org-element-property :drawer-name drawer) nil nil t)
25076 t)))))
25077 nil)
25079 (case (org-element-type element)
25080 ((comment quote-section) t)
25081 (comment-block
25082 ;; Allow checks between block markers, not on them.
25083 (and (> (line-beginning-position) post-affiliated)
25084 (save-excursion
25085 (end-of-line)
25086 (skip-chars-forward " \r\t\n")
25087 (< (point) (org-element-property :end element)))))
25088 ;; Arbitrary list of keywords where checks are meaningful.
25089 ;; Make sure point is on the value part of the element.
25090 (keyword
25091 (and (member (org-element-property :key element)
25092 '("DESCRIPTION" "TITLE"))
25093 (save-excursion
25094 (search-backward ":" (line-beginning-position) t))))
25095 ;; Check is globally allowed in paragraphs verse blocks and
25096 ;; table rows (after affiliated keywords) but some objects
25097 ;; must not be affected.
25098 ((paragraph table-row verse-block)
25099 (let ((cbeg (org-element-property :contents-begin element))
25100 (cend (org-element-property :contents-end element)))
25101 (and cbeg (>= (point) cbeg) (< (point) cend)
25102 (org--flyspell-object-check-p element))))))))))
25103 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25105 (defun org-remove-flyspell-overlays-in (beg end)
25106 "Remove flyspell overlays in region."
25107 (and (org-bound-and-true-p flyspell-mode)
25108 (fboundp 'flyspell-delete-region-overlays)
25109 (flyspell-delete-region-overlays beg end)))
25111 (defvar flyspell-delayed-commands)
25112 (eval-after-load "flyspell"
25113 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25115 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25116 (eval-after-load "bookmark"
25117 '(if (boundp 'bookmark-after-jump-hook)
25118 ;; We can use the hook
25119 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25120 ;; Hook not available, use advice
25121 (defadvice bookmark-jump (after org-make-visible activate)
25122 "Make the position visible."
25123 (org-bookmark-jump-unhide))))
25125 ;; Make sure saveplace shows the location if it was hidden
25126 (eval-after-load "saveplace"
25127 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25128 "Make the position visible."
25129 (org-bookmark-jump-unhide)))
25131 ;; Make sure ecb shows the location if it was hidden
25132 (eval-after-load "ecb"
25133 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25134 "Make hierarchy visible when jumping into location from ECB tree buffer."
25135 (if (derived-mode-p 'org-mode)
25136 (org-show-context))))
25138 (defun org-bookmark-jump-unhide ()
25139 "Unhide the current position, to show the bookmark location."
25140 (and (derived-mode-p 'org-mode)
25141 (or (outline-invisible-p)
25142 (save-excursion (goto-char (max (point-min) (1- (point))))
25143 (outline-invisible-p)))
25144 (org-show-context 'bookmark-jump)))
25146 (defun org-mark-jump-unhide ()
25147 "Make the point visible with `org-show-context' after jumping to the mark."
25148 (when (and (derived-mode-p 'org-mode)
25149 (outline-invisible-p))
25150 (org-show-context 'mark-goto)))
25152 (eval-after-load "simple"
25153 '(defadvice pop-to-mark-command (after org-make-visible activate)
25154 "Make the point visible with `org-show-context'."
25155 (org-mark-jump-unhide)))
25157 (eval-after-load "simple"
25158 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25159 "Make the point visible with `org-show-context'."
25160 (org-mark-jump-unhide)))
25162 (eval-after-load "simple"
25163 '(defadvice pop-global-mark (after org-make-visible activate)
25164 "Make the point visible with `org-show-context'."
25165 (org-mark-jump-unhide)))
25167 ;; Make session.el ignore our circular variable
25168 (defvar session-globals-exclude)
25169 (eval-after-load "session"
25170 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25172 ;;;; Finish up
25174 (provide 'org)
25176 (run-hooks 'org-load-hook)
25178 ;;; org.el ends here