Allow searching for specific property value
[org-mode.git] / lisp / org.el
blob4f611230b838fcc92029745b2861be3919870bd6
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,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
544 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\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-hide-inline-tasks
1424 org-cycle-show-empty-lines
1425 org-optimize-window-after-visibility-change)
1426 "Hook that is run after `org-cycle' has changed the buffer visibility.
1427 The function(s) in this hook must accept a single argument which indicates
1428 the new state that was set by the most recent `org-cycle' command. The
1429 argument is a symbol. After a global state change, it can have the values
1430 `overview', `contents', or `all'. After a local state change, it can have
1431 the values `folded', `children', or `subtree'."
1432 :group 'org-cycle
1433 :type 'hook)
1435 (defgroup org-edit-structure nil
1436 "Options concerning structure editing in Org-mode."
1437 :tag "Org Edit Structure"
1438 :group 'org-structure)
1440 (defcustom org-odd-levels-only nil
1441 "Non-nil means skip even levels and only use odd levels for the outline.
1442 This has the effect that two stars are being added/taken away in
1443 promotion/demotion commands. It also influences how levels are
1444 handled by the exporters.
1445 Changing it requires restart of `font-lock-mode' to become effective
1446 for fontification also in regions already fontified.
1447 You may also set this on a per-file basis by adding one of the following
1448 lines to the buffer:
1450 #+STARTUP: odd
1451 #+STARTUP: oddeven"
1452 :group 'org-edit-structure
1453 :group 'org-appearance
1454 :type 'boolean)
1456 (defcustom org-adapt-indentation t
1457 "Non-nil means adapt indentation to outline node level.
1459 When this variable is set, Org assumes that you write outlines by
1460 indenting text in each node to align with the headline (after the
1461 stars). The following issues are influenced by this variable:
1463 - The indentation is increased by one space in a demotion
1464 command, and decreased by one in a promotion command. However,
1465 in the latter case, if shifting some line in the entry body
1466 would alter document structure (e.g., insert a new headline),
1467 indentation is not changed at all.
1469 - Property drawers and planning information is inserted indented
1470 when this variable is set. When nil, they will not be indented.
1472 - TAB indents a line relative to current level. The lines below
1473 a headline will be indented when this variable is set.
1475 Note that this is all about true indentation, by adding and
1476 removing space characters. See also `org-indent.el' which does
1477 level-dependent indentation in a virtual way, i.e. at display
1478 time in Emacs."
1479 :group 'org-edit-structure
1480 :type 'boolean)
1482 (defcustom org-special-ctrl-a/e nil
1483 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1485 When t, `C-a' will bring back the cursor to the beginning of the
1486 headline text, i.e. after the stars and after a possible TODO
1487 keyword. In an item, this will be the position after bullet and
1488 check-box, if any. When the cursor is already at that position,
1489 another `C-a' will bring it to the beginning of the line.
1491 `C-e' will jump to the end of the headline, ignoring the presence
1492 of tags in the headline. A second `C-e' will then jump to the
1493 true end of the line, after any tags. This also means that, when
1494 this variable is non-nil, `C-e' also will never jump beyond the
1495 end of the heading of a folded section, i.e. not after the
1496 ellipses.
1498 When set to the symbol `reversed', the first `C-a' or `C-e' works
1499 normally, going to the true line boundary first. Only a directly
1500 following, identical keypress will bring the cursor to the
1501 special positions.
1503 This may also be a cons cell where the behavior for `C-a' and
1504 `C-e' is set separately."
1505 :group 'org-edit-structure
1506 :type '(choice
1507 (const :tag "off" nil)
1508 (const :tag "on: after stars/bullet and before tags first" t)
1509 (const :tag "reversed: true line boundary first" reversed)
1510 (cons :tag "Set C-a and C-e separately"
1511 (choice :tag "Special C-a"
1512 (const :tag "off" nil)
1513 (const :tag "on: after stars/bullet first" t)
1514 (const :tag "reversed: before stars/bullet first" reversed))
1515 (choice :tag "Special C-e"
1516 (const :tag "off" nil)
1517 (const :tag "on: before tags first" t)
1518 (const :tag "reversed: after tags first" reversed)))))
1519 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1521 (defcustom org-special-ctrl-k nil
1522 "Non-nil means `C-k' will behave specially in headlines.
1523 When nil, `C-k' will call the default `kill-line' command.
1524 When t, the following will happen while the cursor is in the headline:
1526 - When the cursor is at the beginning of a headline, kill the entire
1527 line and possible the folded subtree below the line.
1528 - When in the middle of the headline text, kill the headline up to the tags.
1529 - When after the headline text, kill the tags."
1530 :group 'org-edit-structure
1531 :type 'boolean)
1533 (defcustom org-ctrl-k-protect-subtree nil
1534 "Non-nil means, do not delete a hidden subtree with C-k.
1535 When set to the symbol `error', simply throw an error when C-k is
1536 used to kill (part-of) a headline that has hidden text behind it.
1537 Any other non-nil value will result in a query to the user, if it is
1538 OK to kill that hidden subtree. When nil, kill without remorse."
1539 :group 'org-edit-structure
1540 :version "24.1"
1541 :type '(choice
1542 (const :tag "Do not protect hidden subtrees" nil)
1543 (const :tag "Protect hidden subtrees with a security query" t)
1544 (const :tag "Never kill a hidden subtree with C-k" error)))
1546 (defcustom org-special-ctrl-o t
1547 "Non-nil means, make `C-o' insert a row in tables."
1548 :group 'org-edit-structure
1549 :type 'boolean)
1551 (defcustom org-catch-invisible-edits nil
1552 "Check if in invisible region before inserting or deleting a character.
1553 Valid values are:
1555 nil Do not check, so just do invisible edits.
1556 error Throw an error and do nothing.
1557 show Make point visible, and do the requested edit.
1558 show-and-error Make point visible, then throw an error and abort the edit.
1559 smart Make point visible, and do insertion/deletion if it is
1560 adjacent to visible text and the change feels predictable.
1561 Never delete a previously invisible character or add in the
1562 middle or right after an invisible region. Basically, this
1563 allows insertion and backward-delete right before ellipses.
1564 FIXME: maybe in this case we should not even show?"
1565 :group 'org-edit-structure
1566 :version "24.1"
1567 :type '(choice
1568 (const :tag "Do not check" nil)
1569 (const :tag "Throw error when trying to edit" error)
1570 (const :tag "Unhide, but do not do the edit" show-and-error)
1571 (const :tag "Show invisible part and do the edit" show)
1572 (const :tag "Be smart and do the right thing" smart)))
1574 (defcustom org-yank-folded-subtrees t
1575 "Non-nil means when yanking subtrees, fold them.
1576 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1577 it starts with a heading and all other headings in it are either children
1578 or siblings, then fold all the subtrees. However, do this only if no
1579 text after the yank would be swallowed into a folded tree by this action."
1580 :group 'org-edit-structure
1581 :type 'boolean)
1583 (defcustom org-yank-adjusted-subtrees nil
1584 "Non-nil means when yanking subtrees, adjust the level.
1585 With this setting, `org-paste-subtree' is used to insert the subtree, see
1586 this function for details."
1587 :group 'org-edit-structure
1588 :type 'boolean)
1590 (defcustom org-M-RET-may-split-line '((default . t))
1591 "Non-nil means M-RET will split the line at the cursor position.
1592 When nil, it will go to the end of the line before making a
1593 new line.
1594 You may also set this option in a different way for different
1595 contexts. Valid contexts are:
1597 headline when creating a new headline
1598 item when creating a new item
1599 table in a table field
1600 default the value to be used for all contexts not explicitly
1601 customized"
1602 :group 'org-structure
1603 :group 'org-table
1604 :type '(choice
1605 (const :tag "Always" t)
1606 (const :tag "Never" nil)
1607 (repeat :greedy t :tag "Individual contexts"
1608 (cons
1609 (choice :tag "Context"
1610 (const headline)
1611 (const item)
1612 (const table)
1613 (const default))
1614 (boolean)))))
1617 (defcustom org-insert-heading-respect-content nil
1618 "Non-nil means insert new headings after the current subtree.
1619 When nil, the new heading is created directly after the current line.
1620 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1621 this variable on for the duration of the command."
1622 :group 'org-structure
1623 :type 'boolean)
1625 (defcustom org-blank-before-new-entry '((heading . auto)
1626 (plain-list-item . auto))
1627 "Should `org-insert-heading' leave a blank line before new heading/item?
1628 The value is an alist, with `heading' and `plain-list-item' as CAR,
1629 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1630 which case Org will look at the surrounding headings/items and try to
1631 make an intelligent decision whether to insert a blank line or not.
1633 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1634 the setting here is ignored and no empty line is inserted to avoid breaking
1635 the list structure."
1636 :group 'org-edit-structure
1637 :type '(list
1638 (cons (const heading)
1639 (choice (const :tag "Never" nil)
1640 (const :tag "Always" t)
1641 (const :tag "Auto" auto)))
1642 (cons (const plain-list-item)
1643 (choice (const :tag "Never" nil)
1644 (const :tag "Always" t)
1645 (const :tag "Auto" auto)))))
1647 (defcustom org-insert-heading-hook nil
1648 "Hook being run after inserting a new heading."
1649 :group 'org-edit-structure
1650 :type 'hook)
1652 (defcustom org-enable-fixed-width-editor t
1653 "Non-nil means lines starting with \":\" are treated as fixed-width.
1654 This currently only means they are never auto-wrapped.
1655 When nil, such lines will be treated like ordinary lines."
1656 :group 'org-edit-structure
1657 :type 'boolean)
1659 (defcustom org-goto-auto-isearch t
1660 "Non-nil means typing characters in `org-goto' starts incremental search.
1661 When nil, you can use these keybindings to navigate the buffer:
1663 q Quit the org-goto interface
1664 n Go to the next visible heading
1665 p Go to the previous visible heading
1666 f Go one heading forward on same level
1667 b Go one heading backward on same level
1668 u Go one heading up"
1669 :group 'org-edit-structure
1670 :type 'boolean)
1672 (defgroup org-sparse-trees nil
1673 "Options concerning sparse trees in Org-mode."
1674 :tag "Org Sparse Trees"
1675 :group 'org-structure)
1677 (defcustom org-highlight-sparse-tree-matches t
1678 "Non-nil means highlight all matches that define a sparse tree.
1679 The highlights will automatically disappear the next time the buffer is
1680 changed by an edit command."
1681 :group 'org-sparse-trees
1682 :type 'boolean)
1684 (defcustom org-remove-highlights-with-change t
1685 "Non-nil means any change to the buffer will remove temporary highlights.
1686 Such highlights are created by `org-occur' and `org-clock-display'.
1687 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1688 The highlights created by `org-toggle-latex-fragment' always need
1689 `C-c C-x C-l' to be removed."
1690 :group 'org-sparse-trees
1691 :group 'org-time
1692 :type 'boolean)
1695 (defcustom org-occur-hook '(org-first-headline-recenter)
1696 "Hook that is run after `org-occur' has constructed a sparse tree.
1697 This can be used to recenter the window to show as much of the structure
1698 as possible."
1699 :group 'org-sparse-trees
1700 :type 'hook)
1702 (defgroup org-imenu-and-speedbar nil
1703 "Options concerning imenu and speedbar in Org-mode."
1704 :tag "Org Imenu and Speedbar"
1705 :group 'org-structure)
1707 (defcustom org-imenu-depth 2
1708 "The maximum level for Imenu access to Org-mode headlines.
1709 This also applied for speedbar access."
1710 :group 'org-imenu-and-speedbar
1711 :type 'integer)
1713 (defgroup org-table nil
1714 "Options concerning tables in Org-mode."
1715 :tag "Org Table"
1716 :group 'org)
1718 (defcustom org-enable-table-editor 'optimized
1719 "Non-nil means lines starting with \"|\" are handled by the table editor.
1720 When nil, such lines will be treated like ordinary lines.
1722 When equal to the symbol `optimized', the table editor will be optimized to
1723 do the following:
1724 - Automatic overwrite mode in front of whitespace in table fields.
1725 This makes the structure of the table stay in tact as long as the edited
1726 field does not exceed the column width.
1727 - Minimize the number of realigns. Normally, the table is aligned each time
1728 TAB or RET are pressed to move to another field. With optimization this
1729 happens only if changes to a field might have changed the column width.
1730 Optimization requires replacing the functions `self-insert-command',
1731 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1732 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1733 very good at guessing when a re-align will be necessary, but you can always
1734 force one with \\[org-ctrl-c-ctrl-c].
1736 If you would like to use the optimized version in Org-mode, but the
1737 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1739 This variable can be used to turn on and off the table editor during a session,
1740 but in order to toggle optimization, a restart is required.
1742 See also the variable `org-table-auto-blank-field'."
1743 :group 'org-table
1744 :type '(choice
1745 (const :tag "off" nil)
1746 (const :tag "on" t)
1747 (const :tag "on, optimized" optimized)))
1749 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1750 (version<= emacs-version "24.1"))
1751 "Non-nil means cluster self-insert commands for undo when possible.
1752 If this is set, then, like in the Emacs command loop, 20 consecutive
1753 characters will be undone together.
1754 This is configurable, because there is some impact on typing performance."
1755 :group 'org-table
1756 :type 'boolean)
1758 (defcustom org-table-tab-recognizes-table.el t
1759 "Non-nil means TAB will automatically notice a table.el table.
1760 When it sees such a table, it moves point into it and - if necessary -
1761 calls `table-recognize-table'."
1762 :group 'org-table-editing
1763 :type 'boolean)
1765 (defgroup org-link nil
1766 "Options concerning links in Org-mode."
1767 :tag "Org Link"
1768 :group 'org)
1770 (defvar org-link-abbrev-alist-local nil
1771 "Buffer-local version of `org-link-abbrev-alist', which see.
1772 The value of this is taken from the #+LINK lines.")
1773 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1775 (defcustom org-link-abbrev-alist nil
1776 "Alist of link abbreviations.
1777 The car of each element is a string, to be replaced at the start of a link.
1778 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1779 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1781 [[linkkey:tag][description]]
1783 The 'linkkey' must be a word word, starting with a letter, followed
1784 by letters, numbers, '-' or '_'.
1786 If REPLACE is a string, the tag will simply be appended to create the link.
1787 If the string contains \"%s\", the tag will be inserted there. If the string
1788 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1789 at that point (see the function `url-hexify-string'). If the string contains
1790 the specifier \"%(my-function)\", then the custom function `my-function' will
1791 be invoked: this function takes the tag as its only argument and must return
1792 a string.
1794 REPLACE may also be a function that will be called with the tag as the
1795 only argument to create the link, which should be returned as a string.
1797 See the manual for examples."
1798 :group 'org-link
1799 :type '(repeat
1800 (cons
1801 (string :tag "Protocol")
1802 (choice
1803 (string :tag "Format")
1804 (function)))))
1806 (defcustom org-descriptive-links t
1807 "Non-nil means Org will display descriptive links.
1808 E.g. [[http://orgmode.org][Org website]] will be displayed as
1809 \"Org Website\", hiding the link itself and just displaying its
1810 description. When set to `nil', Org will display the full links
1811 literally.
1813 You can interactively set the value of this variable by calling
1814 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1815 :group 'org-link
1816 :type 'boolean)
1818 (defcustom org-link-file-path-type 'adaptive
1819 "How the path name in file links should be stored.
1820 Valid values are:
1822 relative Relative to the current directory, i.e. the directory of the file
1823 into which the link is being inserted.
1824 absolute Absolute path, if possible with ~ for home directory.
1825 noabbrev Absolute path, no abbreviation of home directory.
1826 adaptive Use relative path for files in the current directory and sub-
1827 directories of it. For other files, use an absolute path."
1828 :group 'org-link
1829 :type '(choice
1830 (const relative)
1831 (const absolute)
1832 (const noabbrev)
1833 (const adaptive)))
1835 (defvaralias 'org-activate-links 'org-highlight-links)
1836 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1837 "Types of links that should be highlighted in Org-mode files.
1839 This is a list of symbols, each one of them leading to the
1840 highlighting of a certain link type.
1842 You can still open links that are not highlighted.
1844 In principle, it does not hurt to turn on highlighting for all
1845 link types. There may be a small gain when turning off unused
1846 link types. The types are:
1848 bracket The recommended [[link][description]] or [[link]] links with hiding.
1849 angle Links in angular brackets that may contain whitespace like
1850 <bbdb:Carsten Dominik>.
1851 plain Plain links in normal text, no whitespace, like http://google.com.
1852 radio Text that is matched by a radio target, see manual for details.
1853 tag Tag settings in a headline (link to tag search).
1854 date Time stamps (link to calendar).
1855 footnote Footnote labels.
1857 If you set this variable during an Emacs session, use `org-mode-restart'
1858 in the Org buffer so that the change takes effect."
1859 :group 'org-link
1860 :group 'org-appearance
1861 :type '(set :greedy t
1862 (const :tag "Double bracket links" bracket)
1863 (const :tag "Angular bracket links" angle)
1864 (const :tag "Plain text links" plain)
1865 (const :tag "Radio target matches" radio)
1866 (const :tag "Tags" tag)
1867 (const :tag "Timestamps" date)
1868 (const :tag "Footnotes" footnote)))
1870 (defcustom org-make-link-description-function nil
1871 "Function to use for generating link descriptions from links.
1872 When nil, the link location will be used. This function must take
1873 two parameters: the first one is the link, the second one is the
1874 description generated by `org-insert-link'. The function should
1875 return the description to use."
1876 :group 'org-link
1877 :type '(choice (const nil) (function)))
1879 (defgroup org-link-store nil
1880 "Options concerning storing links in Org-mode."
1881 :tag "Org Store Link"
1882 :group 'org-link)
1884 (defcustom org-url-hexify-p t
1885 "When non-nil, hexify URL when creating a link."
1886 :type 'boolean
1887 :version "24.3"
1888 :group 'org-link-store)
1890 (defcustom org-email-link-description-format "Email %c: %.30s"
1891 "Format of the description part of a link to an email or usenet message.
1892 The following %-escapes will be replaced by corresponding information:
1894 %F full \"From\" field
1895 %f name, taken from \"From\" field, address if no name
1896 %T full \"To\" field
1897 %t first name in \"To\" field, address if no name
1898 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1899 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1900 %s subject
1901 %d date
1902 %m message-id.
1904 You may use normal field width specification between the % and the letter.
1905 This is for example useful to limit the length of the subject.
1907 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1908 :group 'org-link-store
1909 :type 'string)
1911 (defcustom org-from-is-user-regexp
1912 (let (r1 r2)
1913 (when (and user-mail-address (not (string= user-mail-address "")))
1914 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1915 (when (and user-full-name (not (string= user-full-name "")))
1916 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1917 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1918 "Regexp matched against the \"From:\" header of an email or usenet message.
1919 It should match if the message is from the user him/herself."
1920 :group 'org-link-store
1921 :type 'regexp)
1923 (defcustom org-context-in-file-links t
1924 "Non-nil means file links from `org-store-link' contain context.
1925 A search string will be added to the file name with :: as separator and
1926 used to find the context when the link is activated by the command
1927 `org-open-at-point'. When this option is t, the entire active region
1928 will be placed in the search string of the file link. If set to a
1929 positive integer, only the first n lines of context will be stored.
1931 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1932 negates this setting for the duration of the command."
1933 :group 'org-link-store
1934 :type '(choice boolean integer))
1936 (defcustom org-keep-stored-link-after-insertion nil
1937 "Non-nil means keep link in list for entire session.
1939 The command `org-store-link' adds a link pointing to the current
1940 location to an internal list. These links accumulate during a session.
1941 The command `org-insert-link' can be used to insert links into any
1942 Org-mode file (offering completion for all stored links). When this
1943 option is nil, every link which has been inserted once using \\[org-insert-link]
1944 will be removed from the list, to make completing the unused links
1945 more efficient."
1946 :group 'org-link-store
1947 :type 'boolean)
1949 (defgroup org-link-follow nil
1950 "Options concerning following links in Org-mode."
1951 :tag "Org Follow Link"
1952 :group 'org-link)
1954 (defcustom org-link-translation-function nil
1955 "Function to translate links with different syntax to Org syntax.
1956 This can be used to translate links created for example by the Planner
1957 or emacs-wiki packages to Org syntax.
1958 The function must accept two parameters, a TYPE containing the link
1959 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1960 which is everything after the link protocol. It should return a cons
1961 with possibly modified values of type and path.
1962 Org contains a function for this, so if you set this variable to
1963 `org-translate-link-from-planner', you should be able follow many
1964 links created by planner."
1965 :group 'org-link-follow
1966 :type '(choice (const nil) (function)))
1968 (defcustom org-follow-link-hook nil
1969 "Hook that is run after a link has been followed."
1970 :group 'org-link-follow
1971 :type 'hook)
1973 (defcustom org-tab-follows-link nil
1974 "Non-nil means on links TAB will follow the link.
1975 Needs to be set before org.el is loaded.
1976 This really should not be used, it does not make sense, and the
1977 implementation is bad."
1978 :group 'org-link-follow
1979 :type 'boolean)
1981 (defcustom org-return-follows-link nil
1982 "Non-nil means on links RET will follow the link.
1983 In tables, the special behavior of RET has precedence."
1984 :group 'org-link-follow
1985 :type 'boolean)
1987 (defcustom org-mouse-1-follows-link
1988 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1989 "Non-nil means mouse-1 on a link will follow the link.
1990 A longer mouse click will still set point. Does not work on XEmacs.
1991 Needs to be set before org.el is loaded."
1992 :group 'org-link-follow
1993 :version "24.4"
1994 :package-version '(Org . "8.3")
1995 :type '(choice
1996 (const :tag "A double click follows the link" double)
1997 (const :tag "Unconditionally follow the link with mouse-1" t)
1998 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
2000 (defcustom org-mark-ring-length 4
2001 "Number of different positions to be recorded in the ring.
2002 Changing this requires a restart of Emacs to work correctly."
2003 :group 'org-link-follow
2004 :type 'integer)
2006 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2007 "Non-nil means internal links in Org files must exactly match a headline.
2008 When nil, the link search tries to match a phrase with all words
2009 in the search text."
2010 :group 'org-link-follow
2011 :version "24.1"
2012 :type '(choice
2013 (const :tag "Use fuzzy text search" nil)
2014 (const :tag "Match only exact headline" t)
2015 (const :tag "Match exact headline or query to create it"
2016 query-to-create)))
2018 (defcustom org-link-frame-setup
2019 '((vm . vm-visit-folder-other-frame)
2020 (vm-imap . vm-visit-imap-folder-other-frame)
2021 (gnus . org-gnus-no-new-news)
2022 (file . find-file-other-window)
2023 (wl . wl-other-frame))
2024 "Setup the frame configuration for following links.
2025 When following a link with Emacs, it may often be useful to display
2026 this link in another window or frame. This variable can be used to
2027 set this up for the different types of links.
2028 For VM, use any of
2029 `vm-visit-folder'
2030 `vm-visit-folder-other-window'
2031 `vm-visit-folder-other-frame'
2032 For Gnus, use any of
2033 `gnus'
2034 `gnus-other-frame'
2035 `org-gnus-no-new-news'
2036 For FILE, use any of
2037 `find-file'
2038 `find-file-other-window'
2039 `find-file-other-frame'
2040 For Wanderlust use any of
2041 `wl'
2042 `wl-other-frame'
2043 For the calendar, use the variable `calendar-setup'.
2044 For BBDB, it is currently only possible to display the matches in
2045 another window."
2046 :group 'org-link-follow
2047 :type '(list
2048 (cons (const vm)
2049 (choice
2050 (const vm-visit-folder)
2051 (const vm-visit-folder-other-window)
2052 (const vm-visit-folder-other-frame)))
2053 (cons (const vm-imap)
2054 (choice
2055 (const vm-visit-imap-folder)
2056 (const vm-visit-imap-folder-other-window)
2057 (const vm-visit-imap-folder-other-frame)))
2058 (cons (const gnus)
2059 (choice
2060 (const gnus)
2061 (const gnus-other-frame)
2062 (const org-gnus-no-new-news)))
2063 (cons (const file)
2064 (choice
2065 (const find-file)
2066 (const find-file-other-window)
2067 (const find-file-other-frame)))
2068 (cons (const wl)
2069 (choice
2070 (const wl)
2071 (const wl-other-frame)))))
2073 (defcustom org-display-internal-link-with-indirect-buffer nil
2074 "Non-nil means use indirect buffer to display infile links.
2075 Activating internal links (from one location in a file to another location
2076 in the same file) normally just jumps to the location. When the link is
2077 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2078 is displayed in
2079 another window. When this option is set, the other window actually displays
2080 an indirect buffer clone of the current buffer, to avoid any visibility
2081 changes to the current buffer."
2082 :group 'org-link-follow
2083 :type 'boolean)
2085 (defcustom org-open-non-existing-files nil
2086 "Non-nil means `org-open-file' will open non-existing files.
2087 When nil, an error will be generated.
2088 This variable applies only to external applications because they
2089 might choke on non-existing files. If the link is to a file that
2090 will be opened in Emacs, the variable is ignored."
2091 :group 'org-link-follow
2092 :type 'boolean)
2094 (defcustom org-open-directory-means-index-dot-org nil
2095 "Non-nil means a link to a directory really means to index.org.
2096 When nil, following a directory link will run dired or open a finder/explorer
2097 window on that directory."
2098 :group 'org-link-follow
2099 :type 'boolean)
2101 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2102 "Non-nil means ask for confirmation before executing shell links.
2103 Shell links can be dangerous: just think about a link
2105 [[shell:rm -rf ~/*][Google Search]]
2107 This link would show up in your Org-mode document as \"Google Search\",
2108 but really it would remove your entire home directory.
2109 Therefore we advise against setting this variable to nil.
2110 Just change it to `y-or-n-p' if you want to confirm with a
2111 single keystroke rather than having to type \"yes\"."
2112 :group 'org-link-follow
2113 :type '(choice
2114 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2115 (const :tag "with y-or-n (faster)" y-or-n-p)
2116 (const :tag "no confirmation (dangerous)" nil)))
2117 (put 'org-confirm-shell-link-function
2118 'safe-local-variable
2119 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2121 (defcustom org-confirm-shell-link-not-regexp ""
2122 "A regexp to skip confirmation for shell links."
2123 :group 'org-link-follow
2124 :version "24.1"
2125 :type 'regexp)
2127 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2128 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2129 Elisp links can be dangerous: just think about a link
2131 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2133 This link would show up in your Org-mode document as \"Google Search\",
2134 but really it would remove your entire home directory.
2135 Therefore we advise against setting this variable to nil.
2136 Just change it to `y-or-n-p' if you want to confirm with a
2137 single keystroke rather than having to type \"yes\"."
2138 :group 'org-link-follow
2139 :type '(choice
2140 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2141 (const :tag "with y-or-n (faster)" y-or-n-p)
2142 (const :tag "no confirmation (dangerous)" nil)))
2143 (put 'org-confirm-shell-link-function
2144 'safe-local-variable
2145 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2147 (defcustom org-confirm-elisp-link-not-regexp ""
2148 "A regexp to skip confirmation for Elisp links."
2149 :group 'org-link-follow
2150 :version "24.1"
2151 :type 'regexp)
2153 (defconst org-file-apps-defaults-gnu
2154 '((remote . emacs)
2155 (system . mailcap)
2156 (t . mailcap))
2157 "Default file applications on a UNIX or GNU/Linux system.
2158 See `org-file-apps'.")
2160 (defconst org-file-apps-defaults-macosx
2161 '((remote . emacs)
2162 (t . "open %s")
2163 (system . "open %s")
2164 ("ps.gz" . "gv %s")
2165 ("eps.gz" . "gv %s")
2166 ("dvi" . "xdvi %s")
2167 ("fig" . "xfig %s"))
2168 "Default file applications on a MacOS X system.
2169 The system \"open\" is known as a default, but we use X11 applications
2170 for some files for which the OS does not have a good default.
2171 See `org-file-apps'.")
2173 (defconst org-file-apps-defaults-windowsnt
2174 (list
2175 '(remote . emacs)
2176 (cons t
2177 (list (if (featurep 'xemacs)
2178 'mswindows-shell-execute
2179 'w32-shell-execute)
2180 "open" 'file))
2181 (cons 'system
2182 (list (if (featurep 'xemacs)
2183 'mswindows-shell-execute
2184 'w32-shell-execute)
2185 "open" 'file)))
2186 "Default file applications on a Windows NT system.
2187 The system \"open\" is used for most files.
2188 See `org-file-apps'.")
2190 (defcustom org-file-apps
2191 '((auto-mode . emacs)
2192 ("\\.mm\\'" . default)
2193 ("\\.x?html?\\'" . default)
2194 ("\\.pdf\\'" . default))
2195 "External applications for opening `file:path' items in a document.
2196 Org-mode uses system defaults for different file types, but
2197 you can use this variable to set the application for a given file
2198 extension. The entries in this list are cons cells where the car identifies
2199 files and the cdr the corresponding command. Possible values for the
2200 file identifier are
2201 \"string\" A string as a file identifier can be interpreted in different
2202 ways, depending on its contents:
2204 - Alphanumeric characters only:
2205 Match links with this file extension.
2206 Example: (\"pdf\" . \"evince %s\")
2207 to open PDFs with evince.
2209 - Regular expression: Match links where the
2210 filename matches the regexp. If you want to
2211 use groups here, use shy groups.
2213 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2214 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2215 to open *.html and *.xhtml with firefox.
2217 - Regular expression which contains (non-shy) groups:
2218 Match links where the whole link, including \"::\", and
2219 anything after that, matches the regexp.
2220 In a custom command string, %1, %2, etc. are replaced with
2221 the parts of the link that were matched by the groups.
2222 For backwards compatibility, if a command string is given
2223 that does not use any of the group matches, this case is
2224 handled identically to the second one (i.e. match against
2225 file name only).
2226 In a custom lisp form, you can access the group matches with
2227 (match-string n link).
2229 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2230 to open [[file:document.pdf::5]] with evince at page 5.
2232 `directory' Matches a directory
2233 `remote' Matches a remote file, accessible through tramp or efs.
2234 Remote files most likely should be visited through Emacs
2235 because external applications cannot handle such paths.
2236 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2237 so all files Emacs knows how to handle. Using this with
2238 command `emacs' will open most files in Emacs. Beware that this
2239 will also open html files inside Emacs, unless you add
2240 (\"html\" . default) to the list as well.
2241 t Default for files not matched by any of the other options.
2242 `system' The system command to open files, like `open' on Windows
2243 and Mac OS X, and mailcap under GNU/Linux. This is the command
2244 that will be selected if you call `C-c C-o' with a double
2245 \\[universal-argument] \\[universal-argument] prefix.
2247 Possible values for the command are:
2248 `emacs' The file will be visited by the current Emacs process.
2249 `default' Use the default application for this file type, which is the
2250 association for t in the list, most likely in the system-specific
2251 part.
2252 This can be used to overrule an unwanted setting in the
2253 system-specific variable.
2254 `system' Use the system command for opening files, like \"open\".
2255 This command is specified by the entry whose car is `system'.
2256 Most likely, the system-specific version of this variable
2257 does define this command, but you can overrule/replace it
2258 here.
2259 string A command to be executed by a shell; %s will be replaced
2260 by the path to the file.
2261 sexp A Lisp form which will be evaluated. The file path will
2262 be available in the Lisp variable `file'.
2263 For more examples, see the system specific constants
2264 `org-file-apps-defaults-macosx'
2265 `org-file-apps-defaults-windowsnt'
2266 `org-file-apps-defaults-gnu'."
2267 :group 'org-link-follow
2268 :type '(repeat
2269 (cons (choice :value ""
2270 (string :tag "Extension")
2271 (const :tag "System command to open files" system)
2272 (const :tag "Default for unrecognized files" t)
2273 (const :tag "Remote file" remote)
2274 (const :tag "Links to a directory" directory)
2275 (const :tag "Any files that have Emacs modes"
2276 auto-mode))
2277 (choice :value ""
2278 (const :tag "Visit with Emacs" emacs)
2279 (const :tag "Use default" default)
2280 (const :tag "Use the system command" system)
2281 (string :tag "Command")
2282 (sexp :tag "Lisp form")))))
2284 (defcustom org-doi-server-url "http://dx.doi.org/"
2285 "The URL of the DOI server."
2286 :type 'string
2287 :version "24.3"
2288 :group 'org-link-follow)
2290 (defgroup org-refile nil
2291 "Options concerning refiling entries in Org-mode."
2292 :tag "Org Refile"
2293 :group 'org)
2295 (defcustom org-directory "~/org"
2296 "Directory with org files.
2297 This is just a default location to look for Org files. There is no need
2298 at all to put your files into this directory. It is only used in the
2299 following situations:
2301 1. When a capture template specifies a target file that is not an
2302 absolute path. The path will then be interpreted relative to
2303 `org-directory'
2304 2. When a capture note is filed away in an interactive way (when exiting the
2305 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2306 with `org-directory' as the default path."
2307 :group 'org-refile
2308 :group 'org-capture
2309 :type 'directory)
2311 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2312 "Default target for storing notes.
2313 Used as a fall back file for org-capture.el, for templates that
2314 do not specify a target file."
2315 :group 'org-refile
2316 :group 'org-capture
2317 :type '(choice
2318 (const :tag "Default from remember-data-file" nil)
2319 file))
2321 (defcustom org-goto-interface 'outline
2322 "The default interface to be used for `org-goto'.
2323 Allowed values are:
2324 outline The interface shows an outline of the relevant file
2325 and the correct heading is found by moving through
2326 the outline or by searching with incremental search.
2327 outline-path-completion Headlines in the current buffer are offered via
2328 completion. This is the interface also used by
2329 the refile command."
2330 :group 'org-refile
2331 :type '(choice
2332 (const :tag "Outline" outline)
2333 (const :tag "Outline-path-completion" outline-path-completion)))
2335 (defcustom org-goto-max-level 5
2336 "Maximum target level when running `org-goto' with refile interface."
2337 :group 'org-refile
2338 :type 'integer)
2340 (defcustom org-reverse-note-order nil
2341 "Non-nil means store new notes at the beginning of a file or entry.
2342 When nil, new notes will be filed to the end of a file or entry.
2343 This can also be a list with cons cells of regular expressions that
2344 are matched against file names, and values."
2345 :group 'org-capture
2346 :group 'org-refile
2347 :type '(choice
2348 (const :tag "Reverse always" t)
2349 (const :tag "Reverse never" nil)
2350 (repeat :tag "By file name regexp"
2351 (cons regexp boolean))))
2353 (defcustom org-log-refile nil
2354 "Information to record when a task is refiled.
2356 Possible values are:
2358 nil Don't add anything
2359 time Add a time stamp to the task
2360 note Prompt for a note and add it with template `org-log-note-headings'
2362 This option can also be set with on a per-file-basis with
2364 #+STARTUP: nologrefile
2365 #+STARTUP: logrefile
2366 #+STARTUP: lognoterefile
2368 You can have local logging settings for a subtree by setting the LOGGING
2369 property to one or more of these keywords.
2371 When bulk-refiling from the agenda, the value `note' is forbidden and
2372 will temporarily be changed to `time'."
2373 :group 'org-refile
2374 :group 'org-progress
2375 :version "24.1"
2376 :type '(choice
2377 (const :tag "No logging" nil)
2378 (const :tag "Record timestamp" time)
2379 (const :tag "Record timestamp with note." note)))
2381 (defcustom org-refile-targets nil
2382 "Targets for refiling entries with \\[org-refile].
2383 This is a list of cons cells. Each cell contains:
2384 - a specification of the files to be considered, either a list of files,
2385 or a symbol whose function or variable value will be used to retrieve
2386 a file name or a list of file names. If you use `org-agenda-files' for
2387 that, all agenda files will be scanned for targets. Nil means consider
2388 headings in the current buffer.
2389 - A specification of how to find candidate refile targets. This may be
2390 any of:
2391 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2392 This tag has to be present in all target headlines, inheritance will
2393 not be considered.
2394 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2395 todo keyword.
2396 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2397 headlines that are refiling targets.
2398 - a cons cell (:level . N). Any headline of level N is considered a target.
2399 Note that, when `org-odd-levels-only' is set, level corresponds to
2400 order in hierarchy, not to the number of stars.
2401 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2402 Note that, when `org-odd-levels-only' is set, level corresponds to
2403 order in hierarchy, not to the number of stars.
2405 Each element of this list generates a set of possible targets.
2406 The union of these sets is presented (with completion) to
2407 the user by `org-refile'.
2409 You can set the variable `org-refile-target-verify-function' to a function
2410 to verify each headline found by the simple criteria above.
2412 When this variable is nil, all top-level headlines in the current buffer
2413 are used, equivalent to the value `((nil . (:level . 1))'."
2414 :group 'org-refile
2415 :type '(repeat
2416 (cons
2417 (choice :value org-agenda-files
2418 (const :tag "All agenda files" org-agenda-files)
2419 (const :tag "Current buffer" nil)
2420 (function) (variable) (file))
2421 (choice :tag "Identify target headline by"
2422 (cons :tag "Specific tag" (const :value :tag) (string))
2423 (cons :tag "TODO keyword" (const :value :todo) (string))
2424 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2425 (cons :tag "Level number" (const :value :level) (integer))
2426 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2428 (defcustom org-refile-target-verify-function nil
2429 "Function to verify if the headline at point should be a refile target.
2430 The function will be called without arguments, with point at the
2431 beginning of the headline. It should return t and leave point
2432 where it is if the headline is a valid target for refiling.
2434 If the target should not be selected, the function must return nil.
2435 In addition to this, it may move point to a place from where the search
2436 should be continued. For example, the function may decide that the entire
2437 subtree of the current entry should be excluded and move point to the end
2438 of the subtree."
2439 :group 'org-refile
2440 :type '(choice
2441 (const nil)
2442 (function)))
2444 (defcustom org-refile-use-cache nil
2445 "Non-nil means cache refile targets to speed up the process.
2446 The cache for a particular file will be updated automatically when
2447 the buffer has been killed, or when any of the marker used for flagging
2448 refile targets no longer points at a live buffer.
2449 If you have added new entries to a buffer that might themselves be targets,
2450 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2451 find that easier, `C-u C-u C-u C-c C-w'."
2452 :group 'org-refile
2453 :version "24.1"
2454 :type 'boolean)
2456 (defcustom org-refile-use-outline-path nil
2457 "Non-nil means provide refile targets as paths.
2458 So a level 3 headline will be available as level1/level2/level3.
2460 When the value is `file', also include the file name (without directory)
2461 into the path. In this case, you can also stop the completion after
2462 the file name, to get entries inserted as top level in the file.
2464 When `full-file-path', include the full file path."
2465 :group 'org-refile
2466 :type '(choice
2467 (const :tag "Not" nil)
2468 (const :tag "Yes" t)
2469 (const :tag "Start with file name" file)
2470 (const :tag "Start with full file path" full-file-path)))
2472 (defcustom org-outline-path-complete-in-steps t
2473 "Non-nil means complete the outline path in hierarchical steps.
2474 When Org-mode uses the refile interface to select an outline path
2475 \(see variable `org-refile-use-outline-path'), the completion of
2476 the path can be done is a single go, or if can be done in steps down
2477 the headline hierarchy. Going in steps is probably the best if you
2478 do not use a special completion package like `ido' or `icicles'.
2479 However, when using these packages, going in one step can be very
2480 fast, while still showing the whole path to the entry."
2481 :group 'org-refile
2482 :type 'boolean)
2484 (defcustom org-refile-allow-creating-parent-nodes nil
2485 "Non-nil means allow to create new nodes as refile targets.
2486 New nodes are then created by adding \"/new node name\" to the completion
2487 of an existing node. When the value of this variable is `confirm',
2488 new node creation must be confirmed by the user (recommended).
2489 When nil, the completion must match an existing entry.
2491 Note that, if the new heading is not seen by the criteria
2492 listed in `org-refile-targets', multiple instances of the same
2493 heading would be created by trying again to file under the new
2494 heading."
2495 :group 'org-refile
2496 :type '(choice
2497 (const :tag "Never" nil)
2498 (const :tag "Always" t)
2499 (const :tag "Prompt for confirmation" confirm)))
2501 (defcustom org-refile-active-region-within-subtree nil
2502 "Non-nil means also refile active region within a subtree.
2504 By default `org-refile' doesn't allow refiling regions if they
2505 don't contain a set of subtrees, but it might be convenient to
2506 do so sometimes: in that case, the first line of the region is
2507 converted to a headline before refiling."
2508 :group 'org-refile
2509 :version "24.1"
2510 :type 'boolean)
2512 (defgroup org-todo nil
2513 "Options concerning TODO items in Org-mode."
2514 :tag "Org TODO"
2515 :group 'org)
2517 (defgroup org-progress nil
2518 "Options concerning Progress logging in Org-mode."
2519 :tag "Org Progress"
2520 :group 'org-time)
2522 (defvar org-todo-interpretation-widgets
2523 '((:tag "Sequence (cycling hits every state)" sequence)
2524 (:tag "Type (cycling directly to DONE)" type))
2525 "The available interpretation symbols for customizing `org-todo-keywords'.
2526 Interested libraries should add to this list.")
2528 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2529 "List of TODO entry keyword sequences and their interpretation.
2530 \\<org-mode-map>This is a list of sequences.
2532 Each sequence starts with a symbol, either `sequence' or `type',
2533 indicating if the keywords should be interpreted as a sequence of
2534 action steps, or as different types of TODO items. The first
2535 keywords are states requiring action - these states will select a headline
2536 for inclusion into the global TODO list Org-mode produces. If one of
2537 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2538 signify that no further action is necessary. If \"|\" is not found,
2539 the last keyword is treated as the only DONE state of the sequence.
2541 The command \\[org-todo] cycles an entry through these states, and one
2542 additional state where no keyword is present. For details about this
2543 cycling, see the manual.
2545 TODO keywords and interpretation can also be set on a per-file basis with
2546 the special #+SEQ_TODO and #+TYP_TODO lines.
2548 Each keyword can optionally specify a character for fast state selection
2549 \(in combination with the variable `org-use-fast-todo-selection')
2550 and specifiers for state change logging, using the same syntax that
2551 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2552 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2553 indicates to record a time stamp each time this state is selected.
2555 Each keyword may also specify if a timestamp or a note should be
2556 recorded when entering or leaving the state, by adding additional
2557 characters in the parenthesis after the keyword. This looks like this:
2558 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2559 record only the time of the state change. With X and Y being either
2560 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2561 Y when leaving the state if and only if the *target* state does not
2562 define X. You may omit any of the fast-selection key or X or /Y,
2563 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2565 For backward compatibility, this variable may also be just a list
2566 of keywords. In this case the interpretation (sequence or type) will be
2567 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2568 :group 'org-todo
2569 :group 'org-keywords
2570 :type '(choice
2571 (repeat :tag "Old syntax, just keywords"
2572 (string :tag "Keyword"))
2573 (repeat :tag "New syntax"
2574 (cons
2575 (choice
2576 :tag "Interpretation"
2577 ;;Quick and dirty way to see
2578 ;;`org-todo-interpretations'. This takes the
2579 ;;place of item arguments
2580 :convert-widget
2581 (lambda (widget)
2582 (widget-put widget
2583 :args (mapcar
2584 (lambda (x)
2585 (widget-convert
2586 (cons 'const x)))
2587 org-todo-interpretation-widgets))
2588 widget))
2589 (repeat
2590 (string :tag "Keyword"))))))
2592 (defvar org-todo-keywords-1 nil
2593 "All TODO and DONE keywords active in a buffer.")
2594 (make-variable-buffer-local 'org-todo-keywords-1)
2595 (defvar org-todo-keywords-for-agenda nil)
2596 (defvar org-done-keywords-for-agenda nil)
2597 (defvar org-todo-keyword-alist-for-agenda nil)
2598 (defvar org-tag-alist-for-agenda nil
2599 "Alist of all tags from all agenda files.")
2600 (defvar org-tag-groups-alist-for-agenda nil
2601 "Alist of all groups tags from all current agenda files.")
2602 (defvar org-tag-groups-alist nil)
2603 (make-variable-buffer-local 'org-tag-groups-alist)
2604 (defvar org-agenda-contributing-files nil)
2605 (defvar org-not-done-keywords nil)
2606 (make-variable-buffer-local 'org-not-done-keywords)
2607 (defvar org-done-keywords nil)
2608 (make-variable-buffer-local 'org-done-keywords)
2609 (defvar org-todo-heads nil)
2610 (make-variable-buffer-local 'org-todo-heads)
2611 (defvar org-todo-sets nil)
2612 (make-variable-buffer-local 'org-todo-sets)
2613 (defvar org-todo-log-states nil)
2614 (make-variable-buffer-local 'org-todo-log-states)
2615 (defvar org-todo-kwd-alist nil)
2616 (make-variable-buffer-local 'org-todo-kwd-alist)
2617 (defvar org-todo-key-alist nil)
2618 (make-variable-buffer-local 'org-todo-key-alist)
2619 (defvar org-todo-key-trigger nil)
2620 (make-variable-buffer-local 'org-todo-key-trigger)
2622 (defcustom org-todo-interpretation 'sequence
2623 "Controls how TODO keywords are interpreted.
2624 This variable is in principle obsolete and is only used for
2625 backward compatibility, if the interpretation of todo keywords is
2626 not given already in `org-todo-keywords'. See that variable for
2627 more information."
2628 :group 'org-todo
2629 :group 'org-keywords
2630 :type '(choice (const sequence)
2631 (const type)))
2633 (defcustom org-use-fast-todo-selection t
2634 "Non-nil means use the fast todo selection scheme with C-c C-t.
2635 This variable describes if and under what circumstances the cycling
2636 mechanism for TODO keywords will be replaced by a single-key, direct
2637 selection scheme.
2639 When nil, fast selection is never used.
2641 When the symbol `prefix', it will be used when `org-todo' is called
2642 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2643 `C-u t' in an agenda buffer.
2645 When t, fast selection is used by default. In this case, the prefix
2646 argument forces cycling instead.
2648 In all cases, the special interface is only used if access keys have
2649 actually been assigned by the user, i.e. if keywords in the configuration
2650 are followed by a letter in parenthesis, like TODO(t)."
2651 :group 'org-todo
2652 :type '(choice
2653 (const :tag "Never" nil)
2654 (const :tag "By default" t)
2655 (const :tag "Only with C-u C-c C-t" prefix)))
2657 (defcustom org-provide-todo-statistics t
2658 "Non-nil means update todo statistics after insert and toggle.
2659 ALL-HEADLINES means update todo statistics by including headlines
2660 with no TODO keyword as well, counting them as not done.
2661 A list of TODO keywords means the same, but skip keywords that are
2662 not in this list.
2663 When set to a list of two lists, the first list contains keywords
2664 to consider as TODO keywords, the second list contains keywords
2665 to consider as DONE keywords.
2667 When this is set, todo statistics is updated in the parent of the
2668 current entry each time a todo state is changed."
2669 :group 'org-todo
2670 :type '(choice
2671 (const :tag "Yes, only for TODO entries" t)
2672 (const :tag "Yes, including all entries" all-headlines)
2673 (repeat :tag "Yes, for TODOs in this list"
2674 (string :tag "TODO keyword"))
2675 (list :tag "Yes, for TODOs and DONEs in these lists"
2676 (repeat (string :tag "TODO keyword"))
2677 (repeat (string :tag "DONE keyword")))
2678 (other :tag "No TODO statistics" nil)))
2680 (defcustom org-hierarchical-todo-statistics t
2681 "Non-nil means TODO statistics covers just direct children.
2682 When nil, all entries in the subtree are considered.
2683 This has only an effect if `org-provide-todo-statistics' is set.
2684 To set this to nil for only a single subtree, use a COOKIE_DATA
2685 property and include the word \"recursive\" into the value."
2686 :group 'org-todo
2687 :type 'boolean)
2689 (defcustom org-after-todo-state-change-hook nil
2690 "Hook which is run after the state of a TODO item was changed.
2691 The new state (a string with a TODO keyword, or nil) is available in the
2692 Lisp variable `org-state'."
2693 :group 'org-todo
2694 :type 'hook)
2696 (defvar org-blocker-hook nil
2697 "Hook for functions that are allowed to block a state change.
2699 Functions in this hook should not modify the buffer.
2700 Each function gets as its single argument a property list,
2701 see `org-trigger-hook' for more information about this list.
2703 If any of the functions in this hook returns nil, the state change
2704 is blocked.")
2706 (defvar org-trigger-hook nil
2707 "Hook for functions that are triggered by a state change.
2709 Each function gets as its single argument a property list with at
2710 least the following elements:
2712 (:type type-of-change :position pos-at-entry-start
2713 :from old-state :to new-state)
2715 Depending on the type, more properties may be present.
2717 This mechanism is currently implemented for:
2719 TODO state changes
2720 ------------------
2721 :type todo-state-change
2722 :from previous state (keyword as a string), or nil, or a symbol
2723 'todo' or 'done', to indicate the general type of state.
2724 :to new state, like in :from")
2726 (defcustom org-enforce-todo-dependencies nil
2727 "Non-nil means undone TODO entries will block switching the parent to DONE.
2728 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2729 be blocked if any prior sibling is not yet done.
2730 Finally, if the parent is blocked because of ordered siblings of its own,
2731 the child will also be blocked."
2732 :set (lambda (var val)
2733 (set var val)
2734 (if val
2735 (add-hook 'org-blocker-hook
2736 'org-block-todo-from-children-or-siblings-or-parent)
2737 (remove-hook 'org-blocker-hook
2738 'org-block-todo-from-children-or-siblings-or-parent)))
2739 :group 'org-todo
2740 :type 'boolean)
2742 (defcustom org-enforce-todo-checkbox-dependencies nil
2743 "Non-nil means unchecked boxes will block switching the parent to DONE.
2744 When this is nil, checkboxes have no influence on switching TODO states.
2745 When non-nil, you first need to check off all check boxes before the TODO
2746 entry can be switched to DONE.
2747 This variable needs to be set before org.el is loaded, and you need to
2748 restart Emacs after a change to make the change effective. The only way
2749 to change is while Emacs is running is through the customize interface."
2750 :set (lambda (var val)
2751 (set var val)
2752 (if val
2753 (add-hook 'org-blocker-hook
2754 'org-block-todo-from-checkboxes)
2755 (remove-hook 'org-blocker-hook
2756 'org-block-todo-from-checkboxes)))
2757 :group 'org-todo
2758 :type 'boolean)
2760 (defcustom org-treat-insert-todo-heading-as-state-change nil
2761 "Non-nil means inserting a TODO heading is treated as state change.
2762 So when the command \\[org-insert-todo-heading] is used, state change
2763 logging will apply if appropriate. When nil, the new TODO item will
2764 be inserted directly, and no logging will take place."
2765 :group 'org-todo
2766 :type 'boolean)
2768 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2769 "Non-nil means switching TODO states with S-cursor counts as state change.
2770 This is the default behavior. However, setting this to nil allows a
2771 convenient way to select a TODO state and bypass any logging associated
2772 with that."
2773 :group 'org-todo
2774 :type 'boolean)
2776 (defcustom org-todo-state-tags-triggers nil
2777 "Tag changes that should be triggered by TODO state changes.
2778 This is a list. Each entry is
2780 (state-change (tag . flag) .......)
2782 State-change can be a string with a state, and empty string to indicate the
2783 state that has no TODO keyword, or it can be one of the symbols `todo'
2784 or `done', meaning any not-done or done state, respectively."
2785 :group 'org-todo
2786 :group 'org-tags
2787 :type '(repeat
2788 (cons (choice :tag "When changing to"
2789 (const :tag "Not-done state" todo)
2790 (const :tag "Done state" done)
2791 (string :tag "State"))
2792 (repeat
2793 (cons :tag "Tag action"
2794 (string :tag "Tag")
2795 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2797 (defcustom org-log-done nil
2798 "Information to record when a task moves to the DONE state.
2800 Possible values are:
2802 nil Don't add anything, just change the keyword
2803 time Add a time stamp to the task
2804 note Prompt for a note and add it with template `org-log-note-headings'
2806 This option can also be set with on a per-file-basis with
2808 #+STARTUP: nologdone
2809 #+STARTUP: logdone
2810 #+STARTUP: lognotedone
2812 You can have local logging settings for a subtree by setting the LOGGING
2813 property to one or more of these keywords."
2814 :group 'org-todo
2815 :group 'org-progress
2816 :type '(choice
2817 (const :tag "No logging" nil)
2818 (const :tag "Record CLOSED timestamp" time)
2819 (const :tag "Record CLOSED timestamp with note." note)))
2821 ;; Normalize old uses of org-log-done.
2822 (cond
2823 ((eq org-log-done t) (setq org-log-done 'time))
2824 ((and (listp org-log-done) (memq 'done org-log-done))
2825 (setq org-log-done 'note)))
2827 (defcustom org-log-reschedule nil
2828 "Information to record when the scheduling date of a tasks is modified.
2830 Possible values are:
2832 nil Don't add anything, just change the date
2833 time Add a time stamp to the task
2834 note Prompt for a note and add it with template `org-log-note-headings'
2836 This option can also be set with on a per-file-basis with
2838 #+STARTUP: nologreschedule
2839 #+STARTUP: logreschedule
2840 #+STARTUP: lognotereschedule"
2841 :group 'org-todo
2842 :group 'org-progress
2843 :type '(choice
2844 (const :tag "No logging" nil)
2845 (const :tag "Record timestamp" time)
2846 (const :tag "Record timestamp with note." note)))
2848 (defcustom org-log-redeadline nil
2849 "Information to record when the deadline date of a tasks is modified.
2851 Possible values are:
2853 nil Don't add anything, just change the date
2854 time Add a time stamp to the task
2855 note Prompt for a note and add it with template `org-log-note-headings'
2857 This option can also be set with on a per-file-basis with
2859 #+STARTUP: nologredeadline
2860 #+STARTUP: logredeadline
2861 #+STARTUP: lognoteredeadline
2863 You can have local logging settings for a subtree by setting the LOGGING
2864 property to one or more of these keywords."
2865 :group 'org-todo
2866 :group 'org-progress
2867 :type '(choice
2868 (const :tag "No logging" nil)
2869 (const :tag "Record timestamp" time)
2870 (const :tag "Record timestamp with note." note)))
2872 (defcustom org-log-note-clock-out nil
2873 "Non-nil means record a note when clocking out of an item.
2874 This can also be configured on a per-file basis by adding one of
2875 the following lines anywhere in the buffer:
2877 #+STARTUP: lognoteclock-out
2878 #+STARTUP: nolognoteclock-out"
2879 :group 'org-todo
2880 :group 'org-progress
2881 :type 'boolean)
2883 (defcustom org-log-done-with-time t
2884 "Non-nil means the CLOSED time stamp will contain date and time.
2885 When nil, only the date will be recorded."
2886 :group 'org-progress
2887 :type 'boolean)
2889 (defcustom org-log-note-headings
2890 '((done . "CLOSING NOTE %t")
2891 (state . "State %-12s from %-12S %t")
2892 (note . "Note taken on %t")
2893 (reschedule . "Rescheduled from %S on %t")
2894 (delschedule . "Not scheduled, was %S on %t")
2895 (redeadline . "New deadline from %S on %t")
2896 (deldeadline . "Removed deadline, was %S on %t")
2897 (refile . "Refiled on %t")
2898 (clock-out . ""))
2899 "Headings for notes added to entries.
2900 The value is an alist, with the car being a symbol indicating the note
2901 context, and the cdr is the heading to be used. The heading may also be the
2902 empty string.
2903 %t in the heading will be replaced by a time stamp.
2904 %T will be an active time stamp instead the default inactive one
2905 %d will be replaced by a short-format time stamp.
2906 %D will be replaced by an active short-format time stamp.
2907 %s will be replaced by the new TODO state, in double quotes.
2908 %S will be replaced by the old TODO state, in double quotes.
2909 %u will be replaced by the user name.
2910 %U will be replaced by the full user name.
2912 In fact, it is not a good idea to change the `state' entry, because
2913 agenda log mode depends on the format of these entries."
2914 :group 'org-todo
2915 :group 'org-progress
2916 :type '(list :greedy t
2917 (cons (const :tag "Heading when closing an item" done) string)
2918 (cons (const :tag
2919 "Heading when changing todo state (todo sequence only)"
2920 state) string)
2921 (cons (const :tag "Heading when just taking a note" note) string)
2922 (cons (const :tag "Heading when rescheduling" reschedule) string)
2923 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2924 (cons (const :tag "Heading when changing deadline" redeadline) string)
2925 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2926 (cons (const :tag "Heading when refiling" refile) string)
2927 (cons (const :tag "Heading when clocking out" clock-out) string)))
2929 (unless (assq 'note org-log-note-headings)
2930 (push '(note . "%t") org-log-note-headings))
2932 (defcustom org-log-into-drawer nil
2933 "Non-nil means insert state change notes and time stamps into a drawer.
2934 When nil, state changes notes will be inserted after the headline and
2935 any scheduling and clock lines, but not inside a drawer.
2937 The value of this variable should be the name of the drawer to use.
2938 LOGBOOK is proposed as the default drawer for this purpose, you can
2939 also set this to a string to define the drawer of your choice.
2941 A value of t is also allowed, representing \"LOGBOOK\".
2943 A value of t or nil can also be set with on a per-file-basis with
2945 #+STARTUP: logdrawer
2946 #+STARTUP: nologdrawer
2948 If this variable is set, `org-log-state-notes-insert-after-drawers'
2949 will be ignored.
2951 You can set the property LOG_INTO_DRAWER to overrule this setting for
2952 a subtree.
2954 Do not check directly this variable in a Lisp program. Call
2955 function `org-log-into-drawer' instead."
2956 :group 'org-todo
2957 :group 'org-progress
2958 :type '(choice
2959 (const :tag "Not into a drawer" nil)
2960 (const :tag "LOGBOOK" t)
2961 (string :tag "Other")))
2963 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2965 (defun org-log-into-drawer ()
2966 "Name of the log drawer, as a string, or nil.
2967 This is the value of `org-log-into-drawer'. However, if the
2968 current entry has or inherits a LOG_INTO_DRAWER property, it will
2969 be used instead of the default value."
2970 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2971 (cond ((equal p "nil") nil)
2972 ((equal p "t") "LOGBOOK")
2973 ((stringp p) p)
2974 (p "LOGBOOK")
2975 ((stringp org-log-into-drawer) org-log-into-drawer)
2976 (org-log-into-drawer "LOGBOOK"))))
2978 (defcustom org-log-state-notes-insert-after-drawers nil
2979 "Non-nil means insert state change notes after any drawers in entry.
2980 Only the drawers that *immediately* follow the headline and the
2981 deadline/scheduled line are skipped.
2982 When nil, insert notes right after the heading and perhaps the line
2983 with deadline/scheduling if present.
2985 This variable will have no effect if `org-log-into-drawer' is
2986 set."
2987 :group 'org-todo
2988 :group 'org-progress
2989 :type 'boolean)
2991 (defcustom org-log-states-order-reversed t
2992 "Non-nil means the latest state note will be directly after heading.
2993 When nil, the state change notes will be ordered according to time.
2995 This option can also be set with on a per-file-basis with
2997 #+STARTUP: logstatesreversed
2998 #+STARTUP: nologstatesreversed"
2999 :group 'org-todo
3000 :group 'org-progress
3001 :type 'boolean)
3003 (defcustom org-todo-repeat-to-state nil
3004 "The TODO state to which a repeater should return the repeating task.
3005 By default this is the first task in a TODO sequence, or the previous state
3006 in a TODO_TYP set. But you can specify another task here.
3007 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3008 :group 'org-todo
3009 :version "24.1"
3010 :type '(choice (const :tag "Head of sequence" nil)
3011 (string :tag "Specific state")))
3013 (defcustom org-log-repeat 'time
3014 "Non-nil means record moving through the DONE state when triggering repeat.
3015 An auto-repeating task is immediately switched back to TODO when
3016 marked DONE. If you are not logging state changes (by adding \"@\"
3017 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3018 record a closing note, there will be no record of the task moving
3019 through DONE. This variable forces taking a note anyway.
3021 nil Don't force a record
3022 time Record a time stamp
3023 note Prompt for a note and add it with template `org-log-note-headings'
3025 This option can also be set with on a per-file-basis with
3027 #+STARTUP: nologrepeat
3028 #+STARTUP: logrepeat
3029 #+STARTUP: lognoterepeat
3031 You can have local logging settings for a subtree by setting the LOGGING
3032 property to one or more of these keywords."
3033 :group 'org-todo
3034 :group 'org-progress
3035 :type '(choice
3036 (const :tag "Don't force a record" nil)
3037 (const :tag "Force recording the DONE state" time)
3038 (const :tag "Force recording a note with the DONE state" note)))
3041 (defgroup org-priorities nil
3042 "Priorities in Org-mode."
3043 :tag "Org Priorities"
3044 :group 'org-todo)
3046 (defcustom org-enable-priority-commands t
3047 "Non-nil means priority commands are active.
3048 When nil, these commands will be disabled, so that you never accidentally
3049 set a priority."
3050 :group 'org-priorities
3051 :type 'boolean)
3053 (defcustom org-highest-priority ?A
3054 "The highest priority of TODO items. A character like ?A, ?B etc.
3055 Must have a smaller ASCII number than `org-lowest-priority'."
3056 :group 'org-priorities
3057 :type 'character)
3059 (defcustom org-lowest-priority ?C
3060 "The lowest priority of TODO items. A character like ?A, ?B etc.
3061 Must have a larger ASCII number than `org-highest-priority'."
3062 :group 'org-priorities
3063 :type 'character)
3065 (defcustom org-default-priority ?B
3066 "The default priority of TODO items.
3067 This is the priority an item gets if no explicit priority is given.
3068 When starting to cycle on an empty priority the first step in the cycle
3069 depends on `org-priority-start-cycle-with-default'. The resulting first
3070 step priority must not exceed the range from `org-highest-priority' to
3071 `org-lowest-priority' which means that `org-default-priority' has to be
3072 in this range exclusive or inclusive the range boundaries. Else the
3073 first step refuses to set the default and the second will fall back
3074 to (depending on the command used) the highest or lowest priority."
3075 :group 'org-priorities
3076 :type 'character)
3078 (defcustom org-priority-start-cycle-with-default t
3079 "Non-nil means start with default priority when starting to cycle.
3080 When this is nil, the first step in the cycle will be (depending on the
3081 command used) one higher or lower than the default priority.
3082 See also `org-default-priority'."
3083 :group 'org-priorities
3084 :type 'boolean)
3086 (defcustom org-get-priority-function nil
3087 "Function to extract the priority from a string.
3088 The string is normally the headline. If this is nil Org computes the
3089 priority from the priority cookie like [#A] in the headline. It returns
3090 an integer, increasing by 1000 for each priority level.
3091 The user can set a different function here, which should take a string
3092 as an argument and return the numeric priority."
3093 :group 'org-priorities
3094 :version "24.1"
3095 :type '(choice
3096 (const nil)
3097 (function)))
3099 (defgroup org-time nil
3100 "Options concerning time stamps and deadlines in Org-mode."
3101 :tag "Org Time"
3102 :group 'org)
3104 (defcustom org-time-stamp-rounding-minutes '(0 5)
3105 "Number of minutes to round time stamps to.
3106 These are two values, the first applies when first creating a time stamp.
3107 The second applies when changing it with the commands `S-up' and `S-down'.
3108 When changing the time stamp, this means that it will change in steps
3109 of N minutes, as given by the second value.
3111 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3112 numbers should be factors of 60, so for example 5, 10, 15.
3114 When this is larger than 1, you can still force an exact time stamp by using
3115 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3116 and by using a prefix arg to `S-up/down' to specify the exact number
3117 of minutes to shift."
3118 :group 'org-time
3119 :get (lambda (var) ; Make sure both elements are there
3120 (if (integerp (default-value var))
3121 (list (default-value var) 5)
3122 (default-value var)))
3123 :type '(list
3124 (integer :tag "when inserting times")
3125 (integer :tag "when modifying times")))
3127 ;; Normalize old customizations of this variable.
3128 (when (integerp org-time-stamp-rounding-minutes)
3129 (setq org-time-stamp-rounding-minutes
3130 (list org-time-stamp-rounding-minutes
3131 org-time-stamp-rounding-minutes)))
3133 (defcustom org-display-custom-times nil
3134 "Non-nil means overlay custom formats over all time stamps.
3135 The formats are defined through the variable `org-time-stamp-custom-formats'.
3136 To turn this on on a per-file basis, insert anywhere in the file:
3137 #+STARTUP: customtime"
3138 :group 'org-time
3139 :set 'set-default
3140 :type 'sexp)
3141 (make-variable-buffer-local 'org-display-custom-times)
3143 (defcustom org-time-stamp-custom-formats
3144 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3145 "Custom formats for time stamps. See `format-time-string' for the syntax.
3146 These are overlaid over the default ISO format if the variable
3147 `org-display-custom-times' is set. Time like %H:%M should be at the
3148 end of the second format. The custom formats are also honored by export
3149 commands, if custom time display is turned on at the time of export."
3150 :group 'org-time
3151 :type 'sexp)
3153 (defun org-time-stamp-format (&optional long inactive)
3154 "Get the right format for a time string."
3155 (let ((f (if long (cdr org-time-stamp-formats)
3156 (car org-time-stamp-formats))))
3157 (if inactive
3158 (concat "[" (substring f 1 -1) "]")
3159 f)))
3161 (defcustom org-time-clocksum-format
3162 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3163 "The format string used when creating CLOCKSUM lines.
3164 This is also used when Org mode generates a time duration.
3166 The value can be a single format string containing two
3167 %-sequences, which will be filled with the number of hours and
3168 minutes in that order.
3170 Alternatively, the value can be a plist associating any of the
3171 keys :years, :months, :weeks, :days, :hours or :minutes with
3172 format strings. The time duration is formatted using only the
3173 time components that are needed and concatenating the results.
3174 If a time unit in absent, it falls back to the next smallest
3175 unit.
3177 The keys :require-years, :require-months, :require-days,
3178 :require-weeks, :require-hours, :require-minutes are also
3179 meaningful. A non-nil value for these keys indicates that the
3180 corresponding time component should always be included, even if
3181 its value is 0.
3184 For example,
3186 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3187 :require-minutes t)
3189 means durations longer than a day will be expressed in days,
3190 hours and minutes, and durations less than a day will always be
3191 expressed in hours and minutes (even for durations less than an
3192 hour).
3194 The value
3196 \(:days \"%dd\" :minutes \"%dm\")
3198 means durations longer than a day will be expressed in days and
3199 minutes, and durations less than a day will be expressed entirely
3200 in minutes (even for durations longer than an hour)."
3201 :group 'org-time
3202 :group 'org-clock
3203 :version "24.4"
3204 :package-version '(Org . "8.0")
3205 :type '(choice (string :tag "Format string")
3206 (set :tag "Plist"
3207 (group :inline t (const :tag "Years" :years)
3208 (string :tag "Format string"))
3209 (group :inline t
3210 (const :tag "Always show years" :require-years)
3211 (const t))
3212 (group :inline t (const :tag "Months" :months)
3213 (string :tag "Format string"))
3214 (group :inline t
3215 (const :tag "Always show months" :require-months)
3216 (const t))
3217 (group :inline t (const :tag "Weeks" :weeks)
3218 (string :tag "Format string"))
3219 (group :inline t
3220 (const :tag "Always show weeks" :require-weeks)
3221 (const t))
3222 (group :inline t (const :tag "Days" :days)
3223 (string :tag "Format string"))
3224 (group :inline t
3225 (const :tag "Always show days" :require-days)
3226 (const t))
3227 (group :inline t (const :tag "Hours" :hours)
3228 (string :tag "Format string"))
3229 (group :inline t
3230 (const :tag "Always show hours" :require-hours)
3231 (const t))
3232 (group :inline t (const :tag "Minutes" :minutes)
3233 (string :tag "Format string"))
3234 (group :inline t
3235 (const :tag "Always show minutes" :require-minutes)
3236 (const t)))))
3238 (defcustom org-time-clocksum-use-fractional nil
3239 "When non-nil, \\[org-clock-display] uses fractional times.
3240 See `org-time-clocksum-format' for more on time clock formats."
3241 :group 'org-time
3242 :group 'org-clock
3243 :version "24.3"
3244 :type 'boolean)
3246 (defcustom org-time-clocksum-use-effort-durations nil
3247 "When non-nil, \\[org-clock-display] uses effort durations.
3248 E.g. by default, one day is considered to be a 8 hours effort,
3249 so a task that has been clocked for 16 hours will be displayed
3250 as during 2 days in the clock display or in the clocktable.
3252 See `org-effort-durations' on how to set effort durations
3253 and `org-time-clocksum-format' for more on time clock formats."
3254 :group 'org-time
3255 :group 'org-clock
3256 :version "24.4"
3257 :package-version '(Org . "8.0")
3258 :type 'boolean)
3260 (defcustom org-time-clocksum-fractional-format "%.2f"
3261 "The format string used when creating CLOCKSUM lines,
3262 or when Org mode generates a time duration, if
3263 `org-time-clocksum-use-fractional' is enabled.
3265 The value can be a single format string containing one
3266 %-sequence, which will be filled with the number of hours as
3267 a float.
3269 Alternatively, the value can be a plist associating any of the
3270 keys :years, :months, :weeks, :days, :hours or :minutes with
3271 a format string. The time duration is formatted using the
3272 largest time unit which gives a non-zero integer part. If all
3273 specified formats have zero integer part, the smallest time unit
3274 is used."
3275 :group 'org-time
3276 :type '(choice (string :tag "Format string")
3277 (set (group :inline t (const :tag "Years" :years)
3278 (string :tag "Format string"))
3279 (group :inline t (const :tag "Months" :months)
3280 (string :tag "Format string"))
3281 (group :inline t (const :tag "Weeks" :weeks)
3282 (string :tag "Format string"))
3283 (group :inline t (const :tag "Days" :days)
3284 (string :tag "Format string"))
3285 (group :inline t (const :tag "Hours" :hours)
3286 (string :tag "Format string"))
3287 (group :inline t (const :tag "Minutes" :minutes)
3288 (string :tag "Format string")))))
3290 (defcustom org-deadline-warning-days 14
3291 "Number of days before expiration during which a deadline becomes active.
3292 This variable governs the display in sparse trees and in the agenda.
3293 When 0 or negative, it means use this number (the absolute value of it)
3294 even if a deadline has a different individual lead time specified.
3296 Custom commands can set this variable in the options section."
3297 :group 'org-time
3298 :group 'org-agenda-daily/weekly
3299 :type 'integer)
3301 (defcustom org-scheduled-delay-days 0
3302 "Number of days before a scheduled item becomes active.
3303 This variable governs the display in sparse trees and in the agenda.
3304 The default value (i.e. 0) means: don't delay scheduled item.
3305 When negative, it means use this number (the absolute value of it)
3306 even if a scheduled item has a different individual delay time
3307 specified.
3309 Custom commands can set this variable in the options section."
3310 :group 'org-time
3311 :group 'org-agenda-daily/weekly
3312 :version "24.4"
3313 :package-version '(Org . "8.0")
3314 :type 'integer)
3316 (defcustom org-read-date-prefer-future t
3317 "Non-nil means assume future for incomplete date input from user.
3318 This affects the following situations:
3319 1. The user gives a month but not a year.
3320 For example, if it is April and you enter \"feb 2\", this will be read
3321 as Feb 2, *next* year. \"May 5\", however, will be this year.
3322 2. The user gives a day, but no month.
3323 For example, if today is the 15th, and you enter \"3\", Org-mode will
3324 read this as the third of *next* month. However, if you enter \"17\",
3325 it will be considered as *this* month.
3327 If you set this variable to the symbol `time', then also the following
3328 will work:
3330 3. If the user gives a time.
3331 If the time is before now, it will be interpreted as tomorrow.
3333 Currently none of this works for ISO week specifications.
3335 When this option is nil, the current day, month and year will always be
3336 used as defaults.
3338 See also `org-agenda-jump-prefer-future'."
3339 :group 'org-time
3340 :type '(choice
3341 (const :tag "Never" nil)
3342 (const :tag "Check month and day" t)
3343 (const :tag "Check month, day, and time" time)))
3345 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3346 "Should the agenda jump command prefer the future for incomplete dates?
3347 The default is to do the same as configured in `org-read-date-prefer-future'.
3348 But you can also set a deviating value here.
3349 This may t or nil, or the symbol `org-read-date-prefer-future'."
3350 :group 'org-agenda
3351 :group 'org-time
3352 :version "24.1"
3353 :type '(choice
3354 (const :tag "Use org-read-date-prefer-future"
3355 org-read-date-prefer-future)
3356 (const :tag "Never" nil)
3357 (const :tag "Always" t)))
3359 (defcustom org-read-date-force-compatible-dates t
3360 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3362 Depending on the system Emacs is running on, certain dates cannot
3363 be represented with the type used internally to represent time.
3364 Dates between 1970-1-1 and 2038-1-1 can always be represented
3365 correctly. Some systems allow for earlier dates, some for later,
3366 some for both. One way to find out it to insert any date into an
3367 Org buffer, putting the cursor on the year and hitting S-up and
3368 S-down to test the range.
3370 When this variable is set to t, the date/time prompt will not let
3371 you specify dates outside the 1970-2037 range, so it is certain that
3372 these dates will work in whatever version of Emacs you are
3373 running, and also that you can move a file from one Emacs implementation
3374 to another. WHenever Org is forcing the year for you, it will display
3375 a message and beep.
3377 When this variable is nil, Org will check if the date is
3378 representable in the specific Emacs implementation you are using.
3379 If not, it will force a year, usually the current year, and beep
3380 to remind you. Currently this setting is not recommended because
3381 the likelihood that you will open your Org files in an Emacs that
3382 has limited date range is not negligible.
3384 A workaround for this problem is to use diary sexp dates for time
3385 stamps outside of this range."
3386 :group 'org-time
3387 :version "24.1"
3388 :type 'boolean)
3390 (defcustom org-read-date-display-live t
3391 "Non-nil means display current interpretation of date prompt live.
3392 This display will be in an overlay, in the minibuffer."
3393 :group 'org-time
3394 :type 'boolean)
3396 (defcustom org-read-date-popup-calendar t
3397 "Non-nil means pop up a calendar when prompting for a date.
3398 In the calendar, the date can be selected with mouse-1. However, the
3399 minibuffer will also be active, and you can simply enter the date as well.
3400 When nil, only the minibuffer will be available."
3401 :group 'org-time
3402 :type 'boolean)
3403 (org-defvaralias 'org-popup-calendar-for-date-prompt
3404 'org-read-date-popup-calendar)
3406 (make-obsolete-variable
3407 'org-read-date-minibuffer-setup-hook
3408 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3409 (defcustom org-read-date-minibuffer-setup-hook nil
3410 "Hook to be used to set up keys for the date/time interface.
3411 Add key definitions to `minibuffer-local-map', which will be a
3412 temporary copy.
3414 WARNING: This option is obsolete, you should use
3415 `org-read-date-minibuffer-local-map' to set up keys."
3416 :group 'org-time
3417 :type 'hook)
3419 (defcustom org-extend-today-until 0
3420 "The hour when your day really ends. Must be an integer.
3421 This has influence for the following applications:
3422 - When switching the agenda to \"today\". It it is still earlier than
3423 the time given here, the day recognized as TODAY is actually yesterday.
3424 - When a date is read from the user and it is still before the time given
3425 here, the current date and time will be assumed to be yesterday, 23:59.
3426 Also, timestamps inserted in capture templates follow this rule.
3428 IMPORTANT: This is a feature whose implementation is and likely will
3429 remain incomplete. Really, it is only here because past midnight seems to
3430 be the favorite working time of John Wiegley :-)"
3431 :group 'org-time
3432 :type 'integer)
3434 (defcustom org-use-effective-time nil
3435 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3436 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3437 \"effective time\" of any timestamps between midnight and 8am will be
3438 23:59 of the previous day."
3439 :group 'org-time
3440 :version "24.1"
3441 :type 'boolean)
3443 (defcustom org-use-last-clock-out-time-as-effective-time nil
3444 "When non-nil, use the last clock out time for `org-todo'.
3445 Note that this option has precedence over the combined use of
3446 `org-use-effective-time' and `org-extend-today-until'."
3447 :group 'org-time
3448 :version "24.4"
3449 :package-version '(Org . "8.0")
3450 :type 'boolean)
3452 (defcustom org-edit-timestamp-down-means-later nil
3453 "Non-nil means S-down will increase the time in a time stamp.
3454 When nil, S-up will increase."
3455 :group 'org-time
3456 :type 'boolean)
3458 (defcustom org-calendar-follow-timestamp-change t
3459 "Non-nil means make the calendar window follow timestamp changes.
3460 When a timestamp is modified and the calendar window is visible, it will be
3461 moved to the new date."
3462 :group 'org-time
3463 :type 'boolean)
3465 (defgroup org-tags nil
3466 "Options concerning tags in Org-mode."
3467 :tag "Org Tags"
3468 :group 'org)
3470 (defcustom org-tag-alist nil
3471 "List of tags allowed in Org-mode files.
3472 When this list is nil, Org-mode will base TAG input on what is already in the
3473 buffer.
3474 The value of this variable is an alist, the car of each entry must be a
3475 keyword as a string, the cdr may be a character that is used to select
3476 that tag through the fast-tag-selection interface.
3477 See the manual for details."
3478 :group 'org-tags
3479 :type '(repeat
3480 (choice
3481 (cons (string :tag "Tag name")
3482 (character :tag "Access char"))
3483 (list :tag "Start radio group"
3484 (const :startgroup)
3485 (option (string :tag "Group description")))
3486 (list :tag "Start tag group, non distinct"
3487 (const :startgrouptag)
3488 (option (string :tag "Group description")))
3489 (list :tag "Group tags delimiter"
3490 (const :grouptags))
3491 (list :tag "End radio group"
3492 (const :endgroup)
3493 (option (string :tag "Group description")))
3494 (list :tag "End tag group, non distinct"
3495 (const :endgrouptag)
3496 (option (string :tag "Group description")))
3497 (const :tag "New line" (:newline)))))
3499 (defcustom org-tag-persistent-alist nil
3500 "List of tags that will always appear in all Org-mode files.
3501 This is in addition to any in buffer settings or customizations
3502 of `org-tag-alist'.
3503 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3504 The value of this variable is an alist, the car of each entry must be a
3505 keyword as a string, the cdr may be a character that is used to select
3506 that tag through the fast-tag-selection interface.
3507 See the manual for details.
3508 To disable these tags on a per-file basis, insert anywhere in the file:
3509 #+STARTUP: noptag"
3510 :group 'org-tags
3511 :type '(repeat
3512 (choice
3513 (cons (string :tag "Tag name")
3514 (character :tag "Access char"))
3515 (const :tag "Start radio group" (:startgroup))
3516 (const :tag "Group tags delimiter" (:grouptags))
3517 (const :tag "End radio group" (:endgroup))
3518 (const :tag "New line" (:newline)))))
3520 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3521 "If non-nil, always offer completion for all tags of all agenda files.
3522 Instead of customizing this variable directly, you might want to
3523 set it locally for capture buffers, because there no list of
3524 tags in that file can be created dynamically (there are none).
3526 (add-hook 'org-capture-mode-hook
3527 (lambda ()
3528 (set (make-local-variable
3529 'org-complete-tags-always-offer-all-agenda-tags)
3530 t)))"
3531 :group 'org-tags
3532 :version "24.1"
3533 :type 'boolean)
3535 (defvar org-file-tags nil
3536 "List of tags that can be inherited by all entries in the file.
3537 The tags will be inherited if the variable `org-use-tag-inheritance'
3538 says they should be.
3539 This variable is populated from #+FILETAGS lines.")
3541 (defcustom org-use-fast-tag-selection 'auto
3542 "Non-nil means use fast tag selection scheme.
3543 This is a special interface to select and deselect tags with single keys.
3544 When nil, fast selection is never used.
3545 When the symbol `auto', fast selection is used if and only if selection
3546 characters for tags have been configured, either through the variable
3547 `org-tag-alist' or through a #+TAGS line in the buffer.
3548 When t, fast selection is always used and selection keys are assigned
3549 automatically if necessary."
3550 :group 'org-tags
3551 :type '(choice
3552 (const :tag "Always" t)
3553 (const :tag "Never" nil)
3554 (const :tag "When selection characters are configured" auto)))
3556 (defcustom org-fast-tag-selection-single-key nil
3557 "Non-nil means fast tag selection exits after first change.
3558 When nil, you have to press RET to exit it.
3559 During fast tag selection, you can toggle this flag with `C-c'.
3560 This variable can also have the value `expert'. In this case, the window
3561 displaying the tags menu is not even shown, until you press C-c again."
3562 :group 'org-tags
3563 :type '(choice
3564 (const :tag "No" nil)
3565 (const :tag "Yes" t)
3566 (const :tag "Expert" expert)))
3568 (defvar org-fast-tag-selection-include-todo nil
3569 "Non-nil means fast tags selection interface will also offer TODO states.
3570 This is an undocumented feature, you should not rely on it.")
3572 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3573 "The column to which tags should be indented in a headline.
3574 If this number is positive, it specifies the column. If it is negative,
3575 it means that the tags should be flushright to that column. For example,
3576 -80 works well for a normal 80 character screen.
3577 When 0, place tags directly after headline text, with only one space in
3578 between."
3579 :group 'org-tags
3580 :type 'integer)
3582 (defcustom org-auto-align-tags t
3583 "Non-nil keeps tags aligned when modifying headlines.
3584 Some operations (i.e. demoting) change the length of a headline and
3585 therefore shift the tags around. With this option turned on, after
3586 each such operation the tags are again aligned to `org-tags-column'."
3587 :group 'org-tags
3588 :type 'boolean)
3590 (defcustom org-use-tag-inheritance t
3591 "Non-nil means tags in levels apply also for sublevels.
3592 When nil, only the tags directly given in a specific line apply there.
3593 This may also be a list of tags that should be inherited, or a regexp that
3594 matches tags that should be inherited. Additional control is possible
3595 with the variable `org-tags-exclude-from-inheritance' which gives an
3596 explicit list of tags to be excluded from inheritance, even if the value of
3597 `org-use-tag-inheritance' would select it for inheritance.
3599 If this option is t, a match early-on in a tree can lead to a large
3600 number of matches in the subtree when constructing the agenda or creating
3601 a sparse tree. If you only want to see the first match in a tree during
3602 a search, check out the variable `org-tags-match-list-sublevels'."
3603 :group 'org-tags
3604 :type '(choice
3605 (const :tag "Not" nil)
3606 (const :tag "Always" t)
3607 (repeat :tag "Specific tags" (string :tag "Tag"))
3608 (regexp :tag "Tags matched by regexp")))
3610 (defcustom org-tags-exclude-from-inheritance nil
3611 "List of tags that should never be inherited.
3612 This is a way to exclude a few tags from inheritance. For way to do
3613 the opposite, to actively allow inheritance for selected tags,
3614 see the variable `org-use-tag-inheritance'."
3615 :group 'org-tags
3616 :type '(repeat (string :tag "Tag")))
3618 (defun org-tag-inherit-p (tag)
3619 "Check if TAG is one that should be inherited."
3620 (cond
3621 ((member tag org-tags-exclude-from-inheritance) nil)
3622 ((eq org-use-tag-inheritance t) t)
3623 ((not org-use-tag-inheritance) nil)
3624 ((stringp org-use-tag-inheritance)
3625 (string-match org-use-tag-inheritance tag))
3626 ((listp org-use-tag-inheritance)
3627 (member tag org-use-tag-inheritance))
3628 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3630 (defcustom org-tags-match-list-sublevels t
3631 "Non-nil means list also sublevels of headlines matching a search.
3632 This variable applies to tags/property searches, and also to stuck
3633 projects because this search is based on a tags match as well.
3635 When set to the symbol `indented', sublevels are indented with
3636 leading dots.
3638 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3639 the sublevels of a headline matching a tag search often also match
3640 the same search. Listing all of them can create very long lists.
3641 Setting this variable to nil causes subtrees of a match to be skipped.
3643 This variable is semi-obsolete and probably should always be true. It
3644 is better to limit inheritance to certain tags using the variables
3645 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3646 :group 'org-tags
3647 :type '(choice
3648 (const :tag "No, don't list them" nil)
3649 (const :tag "Yes, do list them" t)
3650 (const :tag "List them, indented with leading dots" indented)))
3652 (defcustom org-tags-sort-function nil
3653 "When set, tags are sorted using this function as a comparator."
3654 :group 'org-tags
3655 :type '(choice
3656 (const :tag "No sorting" nil)
3657 (const :tag "Alphabetical" string<)
3658 (const :tag "Reverse alphabetical" string>)
3659 (function :tag "Custom function" nil)))
3661 (defvar org-tags-history nil
3662 "History of minibuffer reads for tags.")
3663 (defvar org-last-tags-completion-table nil
3664 "The last used completion table for tags.")
3665 (defvar org-after-tags-change-hook nil
3666 "Hook that is run after the tags in a line have changed.")
3668 (defgroup org-properties nil
3669 "Options concerning properties in Org-mode."
3670 :tag "Org Properties"
3671 :group 'org)
3673 (defcustom org-property-format "%-10s %s"
3674 "How property key/value pairs should be formatted by `indent-line'.
3675 When `indent-line' hits a property definition, it will format the line
3676 according to this format, mainly to make sure that the values are
3677 lined-up with respect to each other."
3678 :group 'org-properties
3679 :type 'string)
3681 (defcustom org-properties-postprocess-alist nil
3682 "Alist of properties and functions to adjust inserted values.
3683 Elements of this alist must be of the form
3685 ([string] [function])
3687 where [string] must be a property name and [function] must be a
3688 lambda expression: this lambda expression must take one argument,
3689 the value to adjust, and return the new value as a string.
3691 For example, this element will allow the property \"Remaining\"
3692 to be updated wrt the relation between the \"Effort\" property
3693 and the clock summary:
3695 ((\"Remaining\" (lambda(value)
3696 (let ((clocksum (org-clock-sum-current-item))
3697 (effort (org-duration-string-to-minutes
3698 (org-entry-get (point) \"Effort\"))))
3699 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3700 :group 'org-properties
3701 :version "24.1"
3702 :type '(alist :key-type (string :tag "Property")
3703 :value-type (function :tag "Function")))
3705 (defcustom org-use-property-inheritance nil
3706 "Non-nil means properties apply also for sublevels.
3708 This setting is chiefly used during property searches. Turning it on can
3709 cause significant overhead when doing a search, which is why it is not
3710 on by default.
3712 When nil, only the properties directly given in the current entry count.
3713 When t, every property is inherited. The value may also be a list of
3714 properties that should have inheritance, or a regular expression matching
3715 properties that should be inherited.
3717 However, note that some special properties use inheritance under special
3718 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3719 and the properties ending in \"_ALL\" when they are used as descriptor
3720 for valid values of a property.
3722 Note for programmers:
3723 When querying an entry with `org-entry-get', you can control if inheritance
3724 should be used. By default, `org-entry-get' looks only at the local
3725 properties. You can request inheritance by setting the inherit argument
3726 to t (to force inheritance) or to `selective' (to respect the setting
3727 in this variable)."
3728 :group 'org-properties
3729 :type '(choice
3730 (const :tag "Not" nil)
3731 (const :tag "Always" t)
3732 (repeat :tag "Specific properties" (string :tag "Property"))
3733 (regexp :tag "Properties matched by regexp")))
3735 (defun org-property-inherit-p (property)
3736 "Check if PROPERTY is one that should be inherited."
3737 (cond
3738 ((eq org-use-property-inheritance t) t)
3739 ((not org-use-property-inheritance) nil)
3740 ((stringp org-use-property-inheritance)
3741 (string-match org-use-property-inheritance property))
3742 ((listp org-use-property-inheritance)
3743 (member property org-use-property-inheritance))
3744 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3746 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3747 "The default column format, if no other format has been defined.
3748 This variable can be set on the per-file basis by inserting a line
3750 #+COLUMNS: %25ITEM ....."
3751 :group 'org-properties
3752 :type 'string)
3754 (defcustom org-columns-ellipses ".."
3755 "The ellipses to be used when a field in column view is truncated.
3756 When this is the empty string, as many characters as possible are shown,
3757 but then there will be no visual indication that the field has been truncated.
3758 When this is a string of length N, the last N characters of a truncated
3759 field are replaced by this string. If the column is narrower than the
3760 ellipses string, only part of the ellipses string will be shown."
3761 :group 'org-properties
3762 :type 'string)
3764 (defcustom org-columns-modify-value-for-display-function nil
3765 "Function that modifies values for display in column view.
3766 For example, it can be used to cut out a certain part from a time stamp.
3767 The function must take 2 arguments:
3769 column-title The title of the column (*not* the property name)
3770 value The value that should be modified.
3772 The function should return the value that should be displayed,
3773 or nil if the normal value should be used."
3774 :group 'org-properties
3775 :type '(choice (const nil) (function)))
3777 (defconst org-global-properties-fixed
3778 '(("VISIBILITY_ALL" . "folded children content all")
3779 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3780 "List of property/value pairs that can be inherited by any entry.
3782 These are fixed values, for the preset properties. The user variable
3783 that can be used to add to this list is `org-global-properties'.
3785 The entries in this list are cons cells where the car is a property
3786 name and cdr is a string with the value. If the value represents
3787 multiple items like an \"_ALL\" property, separate the items by
3788 spaces.")
3790 (defcustom org-global-properties nil
3791 "List of property/value pairs that can be inherited by any entry.
3793 This list will be combined with the constant `org-global-properties-fixed'.
3795 The entries in this list are cons cells where the car is a property
3796 name and cdr is a string with the value.
3798 You can set buffer-local values for the same purpose in the variable
3799 `org-file-properties' this by adding lines like
3801 #+PROPERTY: NAME VALUE"
3802 :group 'org-properties
3803 :type '(repeat
3804 (cons (string :tag "Property")
3805 (string :tag "Value"))))
3807 (defvar org-file-properties nil
3808 "List of property/value pairs that can be inherited by any entry.
3809 Valid for the current buffer.
3810 This variable is populated from #+PROPERTY lines.")
3811 (make-variable-buffer-local 'org-file-properties)
3813 (defgroup org-agenda nil
3814 "Options concerning agenda views in Org-mode."
3815 :tag "Org Agenda"
3816 :group 'org)
3818 (defvar org-category nil
3819 "Variable used by org files to set a category for agenda display.
3820 Such files should use a file variable to set it, for example
3822 # -*- mode: org; org-category: \"ELisp\"
3824 or contain a special line
3826 #+CATEGORY: ELisp
3828 If the file does not specify a category, then file's base name
3829 is used instead.")
3830 (make-variable-buffer-local 'org-category)
3831 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3833 (defcustom org-agenda-files nil
3834 "The files to be used for agenda display.
3835 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3836 \\[org-remove-file]. You can also use customize to edit the list.
3838 If an entry is a directory, all files in that directory that are matched by
3839 `org-agenda-file-regexp' will be part of the file list.
3841 If the value of the variable is not a list but a single file name, then
3842 the list of agenda files is actually stored and maintained in that file, one
3843 agenda file per line. In this file paths can be given relative to
3844 `org-directory'. Tilde expansion and environment variable substitution
3845 are also made."
3846 :group 'org-agenda
3847 :type '(choice
3848 (repeat :tag "List of files and directories" file)
3849 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3851 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3852 "Regular expression to match files for `org-agenda-files'.
3853 If any element in the list in that variable contains a directory instead
3854 of a normal file, all files in that directory that are matched by this
3855 regular expression will be included."
3856 :group 'org-agenda
3857 :type 'regexp)
3859 (defcustom org-agenda-text-search-extra-files nil
3860 "List of extra files to be searched by text search commands.
3861 These files will be searched in addition to the agenda files by the
3862 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3863 Note that these files will only be searched for text search commands,
3864 not for the other agenda views like todo lists, tag searches or the weekly
3865 agenda. This variable is intended to list notes and possibly archive files
3866 that should also be searched by these two commands.
3867 In fact, if the first element in the list is the symbol `agenda-archives',
3868 then all archive files of all agenda files will be added to the search
3869 scope."
3870 :group 'org-agenda
3871 :type '(set :greedy t
3872 (const :tag "Agenda Archives" agenda-archives)
3873 (repeat :inline t (file))))
3875 (org-defvaralias 'org-agenda-multi-occur-extra-files
3876 'org-agenda-text-search-extra-files)
3878 (defcustom org-agenda-skip-unavailable-files nil
3879 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3880 A nil value means to remove them, after a query, from the list."
3881 :group 'org-agenda
3882 :type 'boolean)
3884 (defcustom org-calendar-to-agenda-key [?c]
3885 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3886 The command `org-calendar-goto-agenda' will be bound to this key. The
3887 default is the character `c' because then `c' can be used to switch back and
3888 forth between agenda and calendar."
3889 :group 'org-agenda
3890 :type 'sexp)
3892 (defcustom org-calendar-insert-diary-entry-key [?i]
3893 "The key to be installed in `calendar-mode-map' for adding diary entries.
3894 This option is irrelevant until `org-agenda-diary-file' has been configured
3895 to point to an Org-mode file. When that is the case, the command
3896 `org-agenda-diary-entry' will be bound to the key given here, by default
3897 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3898 if you want to continue doing this, you need to change this to a different
3899 key."
3900 :group 'org-agenda
3901 :type 'sexp)
3903 (defcustom org-agenda-diary-file 'diary-file
3904 "File to which to add new entries with the `i' key in agenda and calendar.
3905 When this is the symbol `diary-file', the functionality in the Emacs
3906 calendar will be used to add entries to the `diary-file'. But when this
3907 points to a file, `org-agenda-diary-entry' will be used instead."
3908 :group 'org-agenda
3909 :type '(choice
3910 (const :tag "The standard Emacs diary file" diary-file)
3911 (file :tag "Special Org file diary entries")))
3913 (eval-after-load "calendar"
3914 '(progn
3915 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3916 'org-calendar-goto-agenda)
3917 (add-hook 'calendar-mode-hook
3918 (lambda ()
3919 (unless (eq org-agenda-diary-file 'diary-file)
3920 (define-key calendar-mode-map
3921 org-calendar-insert-diary-entry-key
3922 'org-agenda-diary-entry))))))
3924 (defgroup org-latex nil
3925 "Options for embedding LaTeX code into Org-mode."
3926 :tag "Org LaTeX"
3927 :group 'org)
3929 (defcustom org-format-latex-options
3930 '(:foreground default :background default :scale 1.0
3931 :html-foreground "Black" :html-background "Transparent"
3932 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3933 "Options for creating images from LaTeX fragments.
3934 This is a property list with the following properties:
3935 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3936 `default' means use the foreground of the default face.
3937 `auto' means use the foreground from the text face.
3938 :background the background color, or \"Transparent\".
3939 `default' means use the background of the default face.
3940 `auto' means use the background from the text face.
3941 :scale a scaling factor for the size of the images, to get more pixels
3942 :html-foreground, :html-background, :html-scale
3943 the same numbers for HTML export.
3944 :matchers a list indicating which matchers should be used to
3945 find LaTeX fragments. Valid members of this list are:
3946 \"begin\" find environments
3947 \"$1\" find single characters surrounded by $.$
3948 \"$\" find math expressions surrounded by $...$
3949 \"$$\" find math expressions surrounded by $$....$$
3950 \"\\(\" find math expressions surrounded by \\(...\\)
3951 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3952 :group 'org-latex
3953 :type 'plist)
3955 (defcustom org-format-latex-signal-error t
3956 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3957 When nil, just push out a message."
3958 :group 'org-latex
3959 :version "24.1"
3960 :type 'boolean)
3962 (defcustom org-latex-to-mathml-jar-file nil
3963 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3964 Use this to specify additional executable file say a jar file.
3966 When using MathToWeb as the converter, specify the full-path to
3967 your mathtoweb.jar file."
3968 :group 'org-latex
3969 :version "24.1"
3970 :type '(choice
3971 (const :tag "None" nil)
3972 (file :tag "JAR file" :must-match t)))
3974 (defcustom org-latex-to-mathml-convert-command nil
3975 "Command to convert LaTeX fragments to MathML.
3976 Replace format-specifiers in the command as noted below and use
3977 `shell-command' to convert LaTeX to MathML.
3978 %j: Executable file in fully expanded form as specified by
3979 `org-latex-to-mathml-jar-file'.
3980 %I: Input LaTeX file in fully expanded form.
3981 %i: The latex fragment to be converted.
3982 %o: Output MathML file.
3983 This command is used by `org-create-math-formula'.
3985 When using MathToWeb as the converter, set this to
3986 \"java -jar %j -unicode -force -df %o %I\".
3988 When using LaTeXML set this to
3989 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3990 :group 'org-latex
3991 :version "24.1"
3992 :type '(choice
3993 (const :tag "None" nil)
3994 (string :tag "\nShell command")))
3996 (defcustom org-latex-create-formula-image-program 'dvipng
3997 "Program to convert LaTeX fragments with.
3999 dvipng Process the LaTeX fragments to dvi file, then convert
4000 dvi files to png files using dvipng.
4001 This will also include processing of non-math environments.
4002 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
4003 to convert pdf files to png files"
4004 :group 'org-latex
4005 :version "24.1"
4006 :type '(choice
4007 (const :tag "dvipng" dvipng)
4008 (const :tag "imagemagick" imagemagick)))
4010 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4011 "Path to store latex preview images.
4012 A relative path here creates many directories relative to the
4013 processed org files paths. An absolute path puts all preview
4014 images at the same place."
4015 :group 'org-latex
4016 :version "24.3"
4017 :type 'string)
4019 (defun org-format-latex-mathml-available-p ()
4020 "Return t if `org-latex-to-mathml-convert-command' is usable."
4021 (save-match-data
4022 (when (and (boundp 'org-latex-to-mathml-convert-command)
4023 org-latex-to-mathml-convert-command)
4024 (let ((executable (car (split-string
4025 org-latex-to-mathml-convert-command))))
4026 (when (executable-find executable)
4027 (if (string-match
4028 "%j" org-latex-to-mathml-convert-command)
4029 (file-readable-p org-latex-to-mathml-jar-file)
4030 t))))))
4032 (defcustom org-format-latex-header "\\documentclass{article}
4033 \\usepackage[usenames]{color}
4034 \[PACKAGES]
4035 \[DEFAULT-PACKAGES]
4036 \\pagestyle{empty} % do not remove
4037 % The settings below are copied from fullpage.sty
4038 \\setlength{\\textwidth}{\\paperwidth}
4039 \\addtolength{\\textwidth}{-3cm}
4040 \\setlength{\\oddsidemargin}{1.5cm}
4041 \\addtolength{\\oddsidemargin}{-2.54cm}
4042 \\setlength{\\evensidemargin}{\\oddsidemargin}
4043 \\setlength{\\textheight}{\\paperheight}
4044 \\addtolength{\\textheight}{-\\headheight}
4045 \\addtolength{\\textheight}{-\\headsep}
4046 \\addtolength{\\textheight}{-\\footskip}
4047 \\addtolength{\\textheight}{-3cm}
4048 \\setlength{\\topmargin}{1.5cm}
4049 \\addtolength{\\topmargin}{-2.54cm}"
4050 "The document header used for processing LaTeX fragments.
4051 It is imperative that this header make sure that no page number
4052 appears on the page. The package defined in the variables
4053 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4054 will either replace the placeholder \"[PACKAGES]\" in this
4055 header, or they will be appended."
4056 :group 'org-latex
4057 :type 'string)
4059 (defun org-set-packages-alist (var val)
4060 "Set the packages alist and make sure it has 3 elements per entry."
4061 (set var (mapcar (lambda (x)
4062 (if (and (consp x) (= (length x) 2))
4063 (list (car x) (nth 1 x) t)
4065 val)))
4067 (defun org-get-packages-alist (var)
4068 "Get the packages alist and make sure it has 3 elements per entry."
4069 (mapcar (lambda (x)
4070 (if (and (consp x) (= (length x) 2))
4071 (list (car x) (nth 1 x) t)
4073 (default-value var)))
4075 (defcustom org-latex-default-packages-alist
4076 '(("AUTO" "inputenc" t)
4077 ("T1" "fontenc" t)
4078 ("" "fixltx2e" nil)
4079 ("" "graphicx" t)
4080 ("" "longtable" nil)
4081 ("" "float" nil)
4082 ("" "wrapfig" nil)
4083 ("" "rotating" nil)
4084 ("normalem" "ulem" t)
4085 ("" "amsmath" t)
4086 ("" "textcomp" t)
4087 ("" "marvosym" t)
4088 ("" "wasysym" t)
4089 ("" "amssymb" t)
4090 ("" "capt-of" nil)
4091 ("" "hyperref" nil)
4092 "\\tolerance=1000")
4093 "Alist of default packages to be inserted in the header.
4095 Change this only if one of the packages here causes an
4096 incompatibility with another package you are using.
4098 The packages in this list are needed by one part or another of
4099 Org mode to function properly:
4101 - inputenc, fontenc: for basic font and character selection
4102 - fixltx2e: Important patches of LaTeX itself
4103 - graphicx: for including images
4104 - longtable: For multipage tables
4105 - float, wrapfig: for figure placement
4106 - rotating: for sideways figures and tables
4107 - ulem: for underline and strike-through
4108 - amsmath: for subscript and superscript and math environments
4109 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4110 for interpreting the entities in `org-entities'. You can skip
4111 some of these packages if you don't use any of their symbols.
4112 - capt-of: for captions outside of floats
4113 - hyperref: for cross references
4115 Therefore you should not modify this variable unless you know
4116 what you are doing. The one reason to change it anyway is that
4117 you might be loading some other package that conflicts with one
4118 of the default packages. Each element is either a cell or
4119 a string.
4121 A cell is of the format:
4123 \( \"options\" \"package\" SNIPPET-FLAG).
4125 If SNIPPET-FLAG is non-nil, the package also needs to be included
4126 when compiling LaTeX snippets into images for inclusion into
4127 non-LaTeX output.
4129 A string will be inserted as-is in the header of the document."
4130 :group 'org-latex
4131 :group 'org-export-latex
4132 :set 'org-set-packages-alist
4133 :get 'org-get-packages-alist
4134 :version "24.1"
4135 :type '(repeat
4136 (choice
4137 (list :tag "options/package pair"
4138 (string :tag "options")
4139 (string :tag "package")
4140 (boolean :tag "Snippet"))
4141 (string :tag "A line of LaTeX"))))
4143 (defcustom org-latex-packages-alist nil
4144 "Alist of packages to be inserted in every LaTeX header.
4146 These will be inserted after `org-latex-default-packages-alist'.
4147 Each element is either a cell or a string.
4149 A cell is of the format:
4151 \(\"options\" \"package\" SNIPPET-FLAG)
4153 SNIPPET-FLAG, when non-nil, indicates that this package is also
4154 needed when turning LaTeX snippets into images for inclusion into
4155 non-LaTeX output.
4157 A string will be inserted as-is in the header of the document.
4159 Make sure that you only list packages here which:
4161 - you want in every file;
4162 - do not conflict with the setup in `org-format-latex-header';
4163 - do not conflict with the default packages in
4164 `org-latex-default-packages-alist'."
4165 :group 'org-latex
4166 :group 'org-export-latex
4167 :set 'org-set-packages-alist
4168 :get 'org-get-packages-alist
4169 :type '(repeat
4170 (choice
4171 (list :tag "options/package pair"
4172 (string :tag "options")
4173 (string :tag "package")
4174 (boolean :tag "Snippet"))
4175 (string :tag "A line of LaTeX"))))
4177 (defgroup org-appearance nil
4178 "Settings for Org-mode appearance."
4179 :tag "Org Appearance"
4180 :group 'org)
4182 (defcustom org-level-color-stars-only nil
4183 "Non-nil means fontify only the stars in each headline.
4184 When nil, the entire headline is fontified.
4185 Changing it requires restart of `font-lock-mode' to become effective
4186 also in regions already fontified."
4187 :group 'org-appearance
4188 :type 'boolean)
4190 (defcustom org-hide-leading-stars nil
4191 "Non-nil means hide the first N-1 stars in a headline.
4192 This works by using the face `org-hide' for these stars. This
4193 face is white for a light background, and black for a dark
4194 background. You may have to customize the face `org-hide' to
4195 make this work.
4196 Changing it requires restart of `font-lock-mode' to become effective
4197 also in regions already fontified.
4198 You may also set this on a per-file basis by adding one of the following
4199 lines to the buffer:
4201 #+STARTUP: hidestars
4202 #+STARTUP: showstars"
4203 :group 'org-appearance
4204 :type 'boolean)
4206 (defcustom org-hidden-keywords nil
4207 "List of symbols corresponding to keywords to be hidden the org buffer.
4208 For example, a value '(title) for this list will make the document's title
4209 appear in the buffer without the initial #+TITLE: keyword."
4210 :group 'org-appearance
4211 :version "24.1"
4212 :type '(set (const :tag "#+AUTHOR" author)
4213 (const :tag "#+DATE" date)
4214 (const :tag "#+EMAIL" email)
4215 (const :tag "#+TITLE" title)))
4217 (defcustom org-custom-properties nil
4218 "List of properties (as strings) with a special meaning.
4219 The default use of these custom properties is to let the user
4220 hide them with `org-toggle-custom-properties-visibility'."
4221 :group 'org-properties
4222 :group 'org-appearance
4223 :version "24.3"
4224 :type '(repeat (string :tag "Property Name")))
4226 (defcustom org-fontify-done-headline nil
4227 "Non-nil means change the face of a headline if it is marked DONE.
4228 Normally, only the TODO/DONE keyword indicates the state of a headline.
4229 When this is non-nil, the headline after the keyword is set to the
4230 `org-headline-done' as an additional indication."
4231 :group 'org-appearance
4232 :type 'boolean)
4234 (defcustom org-fontify-emphasized-text t
4235 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4236 Changing this variable requires a restart of Emacs to take effect."
4237 :group 'org-appearance
4238 :type 'boolean)
4240 (defcustom org-fontify-whole-heading-line nil
4241 "Non-nil means fontify the whole line for headings.
4242 This is useful when setting a background color for the
4243 org-level-* faces."
4244 :group 'org-appearance
4245 :type 'boolean)
4247 (defcustom org-highlight-latex-and-related nil
4248 "Non-nil means highlight LaTeX related syntax in the buffer.
4249 When non nil, the value should be a list containing any of the
4250 following symbols:
4251 `latex' Highlight LaTeX snippets and environments.
4252 `script' Highlight subscript and superscript.
4253 `entities' Highlight entities."
4254 :group 'org-appearance
4255 :version "24.4"
4256 :package-version '(Org . "8.0")
4257 :type '(choice
4258 (const :tag "No highlighting" nil)
4259 (set :greedy t :tag "Highlight"
4260 (const :tag "LaTeX snippets and environments" latex)
4261 (const :tag "Subscript and superscript" script)
4262 (const :tag "Entities" entities))))
4264 (defcustom org-hide-emphasis-markers nil
4265 "Non-nil mean font-lock should hide the emphasis marker characters."
4266 :group 'org-appearance
4267 :type 'boolean)
4269 (defcustom org-hide-macro-markers nil
4270 "Non-nil mean font-lock should hide the brackets marking macro calls."
4271 :group 'org-appearance
4272 :type 'boolean)
4274 (defcustom org-pretty-entities nil
4275 "Non-nil means show entities as UTF8 characters.
4276 When nil, the \\name form remains in the buffer."
4277 :group 'org-appearance
4278 :version "24.1"
4279 :type 'boolean)
4281 (defcustom org-pretty-entities-include-sub-superscripts t
4282 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4283 :group 'org-appearance
4284 :version "24.1"
4285 :type 'boolean)
4287 (defvar org-emph-re nil
4288 "Regular expression for matching emphasis.
4289 After a match, the match groups contain these elements:
4290 0 The match of the full regular expression, including the characters
4291 before and after the proper match
4292 1 The character before the proper match, or empty at beginning of line
4293 2 The proper match, including the leading and trailing markers
4294 3 The leading marker like * or /, indicating the type of highlighting
4295 4 The text between the emphasis markers, not including the markers
4296 5 The character after the match, empty at the end of a line")
4297 (defvar org-verbatim-re nil
4298 "Regular expression for matching verbatim text.")
4299 (defvar org-emphasis-regexp-components) ; defined just below
4300 (defvar org-emphasis-alist) ; defined just below
4301 (defun org-set-emph-re (var val)
4302 "Set variable and compute the emphasis regular expression."
4303 (set var val)
4304 (when (and (boundp 'org-emphasis-alist)
4305 (boundp 'org-emphasis-regexp-components)
4306 org-emphasis-alist org-emphasis-regexp-components)
4307 (let* ((e org-emphasis-regexp-components)
4308 (pre (car e))
4309 (post (nth 1 e))
4310 (border (nth 2 e))
4311 (body (nth 3 e))
4312 (nl (nth 4 e))
4313 (body1 (concat body "*?"))
4314 (markers (mapconcat 'car org-emphasis-alist ""))
4315 (vmarkers (mapconcat
4316 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4317 org-emphasis-alist "")))
4318 ;; make sure special characters appear at the right position in the class
4319 (if (string-match "\\^" markers)
4320 (setq markers (concat (replace-match "" t t markers) "^")))
4321 (if (string-match "-" markers)
4322 (setq markers (concat (replace-match "" t t markers) "-")))
4323 (if (string-match "\\^" vmarkers)
4324 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4325 (if (string-match "-" vmarkers)
4326 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4327 (if (> nl 0)
4328 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4329 (int-to-string nl) "\\}")))
4330 ;; Make the regexp
4331 (setq org-emph-re
4332 (concat "\\([" pre "]\\|^\\)"
4333 "\\("
4334 "\\([" markers "]\\)"
4335 "\\("
4336 "[^" border "]\\|"
4337 "[^" border "]"
4338 body1
4339 "[^" border "]"
4340 "\\)"
4341 "\\3\\)"
4342 "\\([" post "]\\|$\\)"))
4343 (setq org-verbatim-re
4344 (concat "\\([" pre "]\\|^\\)"
4345 "\\("
4346 "\\([" vmarkers "]\\)"
4347 "\\("
4348 "[^" border "]\\|"
4349 "[^" border "]"
4350 body1
4351 "[^" border "]"
4352 "\\)"
4353 "\\3\\)"
4354 "\\([" post "]\\|$\\)")))))
4356 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4357 ;; set this option proved cumbersome. See this message/thread:
4358 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4359 (defvar org-emphasis-regexp-components
4360 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4361 "Components used to build the regular expression for emphasis.
4362 This is a list with five entries. Terminology: In an emphasis string
4363 like \" *strong word* \", we call the initial space PREMATCH, the final
4364 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4365 and \"trong wor\" is the body. The different components in this variable
4366 specify what is allowed/forbidden in each part:
4368 pre Chars allowed as prematch. Beginning of line will be allowed too.
4369 post Chars allowed as postmatch. End of line will be allowed too.
4370 border The chars *forbidden* as border characters.
4371 body-regexp A regexp like \".\" to match a body character. Don't use
4372 non-shy groups here, and don't allow newline here.
4373 newline The maximum number of newlines allowed in an emphasis exp.
4375 You need to reload Org or to restart Emacs after customizing this.")
4377 (defcustom org-emphasis-alist
4378 `(("*" bold)
4379 ("/" italic)
4380 ("_" underline)
4381 ("=" org-verbatim verbatim)
4382 ("~" org-code verbatim)
4383 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4384 "Alist of characters and faces to emphasize text.
4385 Text starting and ending with a special character will be emphasized,
4386 for example *bold*, _underlined_ and /italic/. This variable sets the
4387 marker characters and the face to be used by font-lock for highlighting
4388 in Org-mode Emacs buffers.
4390 You need to reload Org or to restart Emacs after customizing this."
4391 :group 'org-appearance
4392 :set 'org-set-emph-re
4393 :version "24.4"
4394 :package-version '(Org . "8.0")
4395 :type '(repeat
4396 (list
4397 (string :tag "Marker character")
4398 (choice
4399 (face :tag "Font-lock-face")
4400 (plist :tag "Face property list"))
4401 (option (const verbatim)))))
4403 (defvar org-protecting-blocks
4404 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4405 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4406 This is needed for font-lock setup.")
4408 ;;; Miscellaneous options
4410 (defgroup org-completion nil
4411 "Completion in Org-mode."
4412 :tag "Org Completion"
4413 :group 'org)
4415 (defcustom org-completion-use-ido nil
4416 "Non-nil means use ido completion wherever possible.
4417 Note that `ido-mode' must be active for this variable to be relevant.
4418 If you decide to turn this variable on, you might well want to turn off
4419 `org-outline-path-complete-in-steps'.
4420 See also `org-completion-use-iswitchb'."
4421 :group 'org-completion
4422 :type 'boolean)
4424 (defcustom org-completion-use-iswitchb nil
4425 "Non-nil means use iswitchb completion wherever possible.
4426 Note that `iswitchb-mode' must be active for this variable to be relevant.
4427 If you decide to turn this variable on, you might well want to turn off
4428 `org-outline-path-complete-in-steps'.
4429 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4430 :group 'org-completion
4431 :type 'boolean)
4433 (defcustom org-completion-fallback-command 'hippie-expand
4434 "The expansion command called by \\[pcomplete] in normal context.
4435 Normal means, no org-mode-specific context."
4436 :group 'org-completion
4437 :type 'function)
4439 ;;; Functions and variables from their packages
4440 ;; Declared here to avoid compiler warnings
4442 ;; XEmacs only
4443 (defvar outline-mode-menu-heading)
4444 (defvar outline-mode-menu-show)
4445 (defvar outline-mode-menu-hide)
4446 (defvar zmacs-regions) ; XEmacs regions
4448 ;; Emacs only
4449 (defvar mark-active)
4451 ;; Various packages
4452 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4453 (declare-function calendar-forward-day "cal-move" (arg))
4454 (declare-function calendar-goto-date "cal-move" (date))
4455 (declare-function calendar-goto-today "cal-move" ())
4456 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4457 (defvar calc-embedded-close-formula)
4458 (defvar calc-embedded-open-formula)
4459 (declare-function cdlatex-tab "ext:cdlatex" ())
4460 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4461 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4462 (defvar font-lock-unfontify-region-function)
4463 (declare-function iswitchb-read-buffer "iswitchb"
4464 (prompt &optional default require-match start matches-set))
4465 (defvar iswitchb-temp-buflist)
4466 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4467 (defvar org-agenda-tags-todo-honor-ignore-options)
4468 (declare-function org-agenda-skip "org-agenda" ())
4469 (declare-function
4470 org-agenda-format-item "org-agenda"
4471 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4472 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4473 (declare-function org-agenda-change-all-lines "org-agenda"
4474 (newhead hdmarker &optional fixface just-this))
4475 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4476 (declare-function org-agenda-maybe-redo "org-agenda" ())
4477 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4478 (beg end))
4479 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4480 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4481 "org-agenda" (&optional end))
4482 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4483 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4484 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4485 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4486 (declare-function org-indent-mode "org-indent" (&optional arg))
4487 (declare-function parse-time-string "parse-time" (string))
4488 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4489 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4490 (defvar remember-data-file)
4491 (defvar texmathp-why)
4492 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4493 (declare-function table--at-cell-p "table" (position &optional object at-column))
4494 (declare-function calc-eval "calc" (str &optional separator &rest args))
4496 ;;;###autoload
4497 (defun turn-on-orgtbl ()
4498 "Unconditionally turn on `orgtbl-mode'."
4499 (require 'org-table)
4500 (orgtbl-mode 1))
4502 (defun org-at-table-p (&optional table-type)
4503 "Return t if the cursor is inside an org-type table.
4504 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4505 (if org-enable-table-editor
4506 (save-excursion
4507 (beginning-of-line 1)
4508 (looking-at (if table-type org-table-any-line-regexp
4509 org-table-line-regexp)))
4510 nil))
4511 (defsubst org-table-p () (org-at-table-p))
4513 (defun org-at-table.el-p ()
4514 "Return t if and only if we are at a table.el table."
4515 (and (org-at-table-p 'any)
4516 (save-excursion
4517 (goto-char (org-table-begin 'any))
4518 (looking-at org-table1-hline-regexp))))
4520 (defun org-table-recognize-table.el ()
4521 "If there is a table.el table nearby, recognize it and move into it."
4522 (if org-table-tab-recognizes-table.el
4523 (if (org-at-table.el-p)
4524 (progn
4525 (beginning-of-line 1)
4526 (if (looking-at org-table-dataline-regexp)
4528 (if (looking-at org-table1-hline-regexp)
4529 (progn
4530 (beginning-of-line 2)
4531 (if (looking-at org-table-any-border-regexp)
4532 (beginning-of-line -1)))))
4533 (if (re-search-forward "|" (org-table-end t) t)
4534 (progn
4535 (require 'table)
4536 (if (table--at-cell-p (point))
4538 (message "recognizing table.el table...")
4539 (table-recognize-table)
4540 (message "recognizing table.el table...done")))
4541 (error "This should not happen"))
4543 nil)
4544 nil))
4546 (defun org-at-table-hline-p ()
4547 "Return t if the cursor is inside a hline in a table."
4548 (if org-enable-table-editor
4549 (save-excursion
4550 (beginning-of-line 1)
4551 (looking-at org-table-hline-regexp))
4552 nil))
4554 (defun org-table-map-tables (function &optional quietly)
4555 "Apply FUNCTION to the start of all tables in the buffer."
4556 (save-excursion
4557 (save-restriction
4558 (widen)
4559 (goto-char (point-min))
4560 (while (re-search-forward org-table-any-line-regexp nil t)
4561 (unless quietly
4562 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4563 (beginning-of-line 1)
4564 (when (and (looking-at org-table-line-regexp)
4565 ;; Exclude tables in src/example/verbatim/clocktable blocks
4566 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4567 (save-excursion (funcall function))
4568 (or (looking-at org-table-line-regexp)
4569 (forward-char 1)))
4570 (re-search-forward org-table-any-border-regexp nil 1))))
4571 (unless quietly (message "Mapping tables: done")))
4573 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4574 (declare-function org-clock-update-mode-line "org-clock" ())
4575 (declare-function org-resolve-clocks "org-clock"
4576 (&optional also-non-dangling-p prompt last-valid))
4578 (defun org-at-TBLFM-p (&optional pos)
4579 "Return t when point (or POS) is in #+TBLFM line."
4580 (save-excursion
4581 (let ((pos pos)))
4582 (goto-char (or pos (point)))
4583 (beginning-of-line 1)
4584 (looking-at org-TBLFM-regexp)))
4586 (defvar org-clock-start-time)
4587 (defvar org-clock-marker (make-marker)
4588 "Marker recording the last clock-in.")
4589 (defvar org-clock-hd-marker (make-marker)
4590 "Marker recording the last clock-in, but the headline position.")
4591 (defvar org-clock-heading ""
4592 "The heading of the current clock entry.")
4593 (defun org-clock-is-active ()
4594 "Return the buffer where the clock is currently running.
4595 Return nil if no clock is running."
4596 (marker-buffer org-clock-marker))
4598 (defun org-check-running-clock ()
4599 "Check if the current buffer contains the running clock.
4600 If yes, offer to stop it and to save the buffer with the changes."
4601 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4602 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4603 (buffer-name))))
4604 (org-clock-out)
4605 (when (y-or-n-p "Save changed buffer?")
4606 (save-buffer))))
4608 (defun org-clocktable-try-shift (dir n)
4609 "Check if this line starts a clock table, if yes, shift the time block."
4610 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4611 (org-clocktable-shift dir n)))
4613 ;;;###autoload
4614 (defun org-clock-persistence-insinuate ()
4615 "Set up hooks for clock persistence."
4616 (require 'org-clock)
4617 (add-hook 'org-mode-hook 'org-clock-load)
4618 (add-hook 'kill-emacs-hook 'org-clock-save))
4620 (defgroup org-archive nil
4621 "Options concerning archiving in Org-mode."
4622 :tag "Org Archive"
4623 :group 'org-structure)
4625 (defcustom org-archive-location "%s_archive::"
4626 "The location where subtrees should be archived.
4628 The value of this variable is a string, consisting of two parts,
4629 separated by a double-colon. The first part is a filename and
4630 the second part is a headline.
4632 When the filename is omitted, archiving happens in the same file.
4633 %s in the filename will be replaced by the current file
4634 name (without the directory part). Archiving to a different file
4635 is useful to keep archived entries from contributing to the
4636 Org-mode Agenda.
4638 The archived entries will be filed as subtrees of the specified
4639 headline. When the headline is omitted, the subtrees are simply
4640 filed away at the end of the file, as top-level entries. Also in
4641 the heading you can use %s to represent the file name, this can be
4642 useful when using the same archive for a number of different files.
4644 Here are a few examples:
4645 \"%s_archive::\"
4646 If the current file is Projects.org, archive in file
4647 Projects.org_archive, as top-level trees. This is the default.
4649 \"::* Archived Tasks\"
4650 Archive in the current file, under the top-level headline
4651 \"* Archived Tasks\".
4653 \"~/org/archive.org::\"
4654 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4656 \"~/org/archive.org::* From %s\"
4657 Archive in file ~/org/archive.org (absolute path), under headlines
4658 \"From FILENAME\" where file name is the current file name.
4660 \"~/org/datetree.org::datetree/* Finished Tasks\"
4661 The \"datetree/\" string is special, signifying to archive
4662 items to the datetree. Items are placed in either the CLOSED
4663 date of the item, or the current date if there is no CLOSED date.
4664 The heading will be a subentry to the current date. There doesn't
4665 need to be a heading, but there always needs to be a slash after
4666 datetree. For example, to store archived items directly in the
4667 datetree, use \"~/org/datetree.org::datetree/\".
4669 \"basement::** Finished Tasks\"
4670 Archive in file ./basement (relative path), as level 3 trees
4671 below the level 2 heading \"** Finished Tasks\".
4673 You may set this option on a per-file basis by adding to the buffer a
4674 line like
4676 #+ARCHIVE: basement::** Finished Tasks
4678 You may also define it locally for a subtree by setting an ARCHIVE property
4679 in the entry. If such a property is found in an entry, or anywhere up
4680 the hierarchy, it will be used."
4681 :group 'org-archive
4682 :type 'string)
4684 (defcustom org-agenda-skip-archived-trees t
4685 "Non-nil means the agenda will skip any items located in archived trees.
4686 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4687 variable is no longer recommended, you should leave it at the value t.
4688 Instead, use the key `v' to cycle the archives-mode in the agenda."
4689 :group 'org-archive
4690 :group 'org-agenda-skip
4691 :type 'boolean)
4693 (defcustom org-columns-skip-archived-trees t
4694 "Non-nil means ignore archived trees when creating column view."
4695 :group 'org-archive
4696 :group 'org-properties
4697 :type 'boolean)
4699 (defcustom org-cycle-open-archived-trees nil
4700 "Non-nil means `org-cycle' will open archived trees.
4701 An archived tree is a tree marked with the tag ARCHIVE.
4702 When nil, archived trees will stay folded. You can still open them with
4703 normal outline commands like `show-all', but not with the cycling commands."
4704 :group 'org-archive
4705 :group 'org-cycle
4706 :type 'boolean)
4708 (defcustom org-sparse-tree-open-archived-trees nil
4709 "Non-nil means sparse tree construction shows matches in archived trees.
4710 When nil, matches in these trees are highlighted, but the trees are kept in
4711 collapsed state."
4712 :group 'org-archive
4713 :group 'org-sparse-trees
4714 :type 'boolean)
4716 (defcustom org-sparse-tree-default-date-type nil
4717 "The default date type when building a sparse tree.
4718 When this is nil, a date is a scheduled or a deadline timestamp.
4719 Otherwise, these types are allowed:
4721 all: all timestamps
4722 active: only active timestamps (<...>)
4723 inactive: only inactive timestamps ([...])
4724 scheduled: only scheduled timestamps
4725 deadline: only deadline timestamps"
4726 :type '(choice (const :tag "Scheduled or deadline" nil)
4727 (const :tag "All timestamps" all)
4728 (const :tag "Only active timestamps" active)
4729 (const :tag "Only inactive timestamps" inactive)
4730 (const :tag "Only scheduled timestamps" scheduled)
4731 (const :tag "Only deadline timestamps" deadline)
4732 (const :tag "Only closed timestamps" closed))
4733 :version "25.1"
4734 :package-version '(Org . "8.3")
4735 :group 'org-sparse-trees)
4737 (defun org-cycle-hide-archived-subtrees (state)
4738 "Re-hide all archived subtrees after a visibility state change."
4739 (when (and (not org-cycle-open-archived-trees)
4740 (not (memq state '(overview folded))))
4741 (save-excursion
4742 (let* ((globalp (memq state '(contents all)))
4743 (beg (if globalp (point-min) (point)))
4744 (end (if globalp (point-max) (org-end-of-subtree t))))
4745 (org-hide-archived-subtrees beg end)
4746 (goto-char beg)
4747 (if (looking-at (concat ".*:" org-archive-tag ":"))
4748 (message "%s" (substitute-command-keys
4749 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4751 (defun org-force-cycle-archived ()
4752 "Cycle subtree even if it is archived."
4753 (interactive)
4754 (setq this-command 'org-cycle)
4755 (let ((org-cycle-open-archived-trees t))
4756 (call-interactively 'org-cycle)))
4758 (defun org-hide-archived-subtrees (beg end)
4759 "Re-hide all archived subtrees after a visibility state change."
4760 (org-with-wide-buffer
4761 (let ((case-fold-search nil)
4762 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4763 (goto-char beg)
4764 (while (and (< (point) end) (re-search-forward re end t))
4765 (when (member org-archive-tag (org-get-tags))
4766 (org-flag-subtree t)
4767 (org-end-of-subtree t))))))
4769 (declare-function outline-end-of-heading "outline" ())
4770 (declare-function outline-flag-region "outline" (from to flag))
4771 (defun org-flag-subtree (flag)
4772 (save-excursion
4773 (org-back-to-heading t)
4774 (outline-end-of-heading)
4775 (outline-flag-region (point)
4776 (progn (org-end-of-subtree t) (point))
4777 flag)))
4779 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4781 ;; Declare Column View Code
4783 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4784 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4785 (declare-function org-columns-compute "org-colview" (property))
4787 ;; Declare ID code
4789 (declare-function org-id-store-link "org-id")
4790 (declare-function org-id-locations-load "org-id")
4791 (declare-function org-id-locations-save "org-id")
4792 (defvar org-id-track-globally)
4794 ;;; Variables for pre-computed regular expressions, all buffer local
4796 (defvar org-todo-regexp nil
4797 "Matches any of the TODO state keywords.")
4798 (make-variable-buffer-local 'org-todo-regexp)
4799 (defvar org-not-done-regexp nil
4800 "Matches any of the TODO state keywords except the last one.")
4801 (make-variable-buffer-local 'org-not-done-regexp)
4802 (defvar org-not-done-heading-regexp nil
4803 "Matches a TODO headline that is not done.")
4804 (make-variable-buffer-local 'org-not-done-regexp)
4805 (defvar org-todo-line-regexp nil
4806 "Matches a headline and puts TODO state into group 2 if present.")
4807 (make-variable-buffer-local 'org-todo-line-regexp)
4808 (defvar org-complex-heading-regexp nil
4809 "Matches a headline and puts everything into groups:
4810 group 1: the stars
4811 group 2: The todo keyword, maybe
4812 group 3: Priority cookie
4813 group 4: True headline
4814 group 5: Tags")
4815 (make-variable-buffer-local 'org-complex-heading-regexp)
4816 (defvar org-complex-heading-regexp-format nil
4817 "Printf format to make regexp to match an exact headline.
4818 This regexp will match the headline of any node which has the
4819 exact headline text that is put into the format, but may have any
4820 TODO state, priority and tags.")
4821 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4822 (defvar org-todo-line-tags-regexp nil
4823 "Matches a headline and puts TODO state into group 2 if present.
4824 Also put tags into group 4 if tags are present.")
4825 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4827 (defconst org-plain-time-of-day-regexp
4828 (concat
4829 "\\(\\<[012]?[0-9]"
4830 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4831 "\\(--?"
4832 "\\(\\<[012]?[0-9]"
4833 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4834 "\\)?")
4835 "Regular expression to match a plain time or time range.
4836 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4837 groups carry important information:
4838 0 the full match
4839 1 the first time, range or not
4840 8 the second time, if it is a range.")
4842 (defconst org-plain-time-extension-regexp
4843 (concat
4844 "\\(\\<[012]?[0-9]"
4845 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4846 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4847 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4848 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4849 groups carry important information:
4850 0 the full match
4851 7 hours of duration
4852 9 minutes of duration")
4854 (defconst org-stamp-time-of-day-regexp
4855 (concat
4856 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4857 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4858 "\\(--?"
4859 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4860 "Regular expression to match a timestamp time or time range.
4861 After a match, the following groups carry important information:
4862 0 the full match
4863 1 date plus weekday, for back referencing to make sure both times are on the same day
4864 2 the first time, range or not
4865 4 the second time, if it is a range.")
4867 (defconst org-startup-options
4868 '(("fold" org-startup-folded t)
4869 ("overview" org-startup-folded t)
4870 ("nofold" org-startup-folded nil)
4871 ("showall" org-startup-folded nil)
4872 ("showeverything" org-startup-folded showeverything)
4873 ("content" org-startup-folded content)
4874 ("indent" org-startup-indented t)
4875 ("noindent" org-startup-indented nil)
4876 ("hidestars" org-hide-leading-stars t)
4877 ("showstars" org-hide-leading-stars nil)
4878 ("odd" org-odd-levels-only t)
4879 ("oddeven" org-odd-levels-only nil)
4880 ("align" org-startup-align-all-tables t)
4881 ("noalign" org-startup-align-all-tables nil)
4882 ("inlineimages" org-startup-with-inline-images t)
4883 ("noinlineimages" org-startup-with-inline-images nil)
4884 ("latexpreview" org-startup-with-latex-preview t)
4885 ("nolatexpreview" org-startup-with-latex-preview nil)
4886 ("customtime" org-display-custom-times t)
4887 ("logdone" org-log-done time)
4888 ("lognotedone" org-log-done note)
4889 ("nologdone" org-log-done nil)
4890 ("lognoteclock-out" org-log-note-clock-out t)
4891 ("nolognoteclock-out" org-log-note-clock-out nil)
4892 ("logrepeat" org-log-repeat state)
4893 ("lognoterepeat" org-log-repeat note)
4894 ("logdrawer" org-log-into-drawer t)
4895 ("nologdrawer" org-log-into-drawer nil)
4896 ("logstatesreversed" org-log-states-order-reversed t)
4897 ("nologstatesreversed" org-log-states-order-reversed nil)
4898 ("nologrepeat" org-log-repeat nil)
4899 ("logreschedule" org-log-reschedule time)
4900 ("lognotereschedule" org-log-reschedule note)
4901 ("nologreschedule" org-log-reschedule nil)
4902 ("logredeadline" org-log-redeadline time)
4903 ("lognoteredeadline" org-log-redeadline note)
4904 ("nologredeadline" org-log-redeadline nil)
4905 ("logrefile" org-log-refile time)
4906 ("lognoterefile" org-log-refile note)
4907 ("nologrefile" org-log-refile nil)
4908 ("fninline" org-footnote-define-inline t)
4909 ("nofninline" org-footnote-define-inline nil)
4910 ("fnlocal" org-footnote-section nil)
4911 ("fnauto" org-footnote-auto-label t)
4912 ("fnprompt" org-footnote-auto-label nil)
4913 ("fnconfirm" org-footnote-auto-label confirm)
4914 ("fnplain" org-footnote-auto-label plain)
4915 ("fnadjust" org-footnote-auto-adjust t)
4916 ("nofnadjust" org-footnote-auto-adjust nil)
4917 ("constcgs" constants-unit-system cgs)
4918 ("constSI" constants-unit-system SI)
4919 ("noptag" org-tag-persistent-alist nil)
4920 ("hideblocks" org-hide-block-startup t)
4921 ("nohideblocks" org-hide-block-startup nil)
4922 ("beamer" org-startup-with-beamer-mode t)
4923 ("entitiespretty" org-pretty-entities t)
4924 ("entitiesplain" org-pretty-entities nil))
4925 "Variable associated with STARTUP options for org-mode.
4926 Each element is a list of three items: the startup options (as written
4927 in the #+STARTUP line), the corresponding variable, and the value to set
4928 this variable to if the option is found. An optional forth element PUSH
4929 means to push this value onto the list in the variable.")
4931 (defcustom org-group-tags t
4932 "When non-nil (the default), use group tags.
4933 This can be turned on/off through `org-toggle-tags-groups'."
4934 :group 'org-tags
4935 :group 'org-startup
4936 :type 'boolean)
4938 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4940 (defun org-toggle-tags-groups ()
4941 "Toggle support for group tags.
4942 Support for group tags is controlled by the option
4943 `org-group-tags', which is non-nil by default."
4944 (interactive)
4945 (setq org-group-tags (not org-group-tags))
4946 (cond ((and (derived-mode-p 'org-agenda-mode)
4947 org-group-tags)
4948 (org-agenda-redo))
4949 ((derived-mode-p 'org-mode)
4950 (let ((org-inhibit-startup t)) (org-mode))))
4951 (message "Groups tags support has been turned %s"
4952 (if org-group-tags "on" "off")))
4954 (defun org-set-regexps-and-options (&optional tags-only)
4955 "Precompute regular expressions used in the current buffer.
4956 When optional argument TAGS-ONLY is non-nil, only compute tags
4957 related expressions."
4958 (when (derived-mode-p 'org-mode)
4959 (let ((alist (org--setup-collect-keywords
4960 (org-make-options-regexp
4961 (append '("FILETAGS" "TAGS" "SETUPFILE")
4962 (and (not tags-only)
4963 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4964 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4965 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4966 (org--setup-process-tags
4967 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4968 (unless tags-only
4969 ;; File properties.
4970 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4971 ;; Archive location.
4972 (let ((archive (cdr (assq 'archive alist))))
4973 (when archive (org-set-local 'org-archive-location archive)))
4974 ;; Category.
4975 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4976 (when cat
4977 (org-set-local 'org-category (intern cat))
4978 (org-set-local 'org-file-properties
4979 (org--update-property-plist
4980 "CATEGORY" cat org-file-properties))))
4981 ;; Columns.
4982 (let ((column (cdr (assq 'columns alist))))
4983 (when column (org-set-local 'org-columns-default-format column)))
4984 ;; Constants.
4985 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4986 ;; Link abbreviations.
4987 (let ((links (cdr (assq 'link alist))))
4988 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4989 ;; Priorities.
4990 (let ((priorities (cdr (assq 'priorities alist))))
4991 (when priorities
4992 (org-set-local 'org-highest-priority (nth 0 priorities))
4993 (org-set-local 'org-lowest-priority (nth 1 priorities))
4994 (org-set-local 'org-default-priority (nth 2 priorities))))
4995 ;; Scripts.
4996 (let ((scripts (assq 'scripts alist)))
4997 (when scripts
4998 (org-set-local 'org-use-sub-superscripts (cdr scripts))))
4999 ;; Startup options.
5000 (let ((startup (cdr (assq 'startup alist))))
5001 (dolist (option startup)
5002 (let ((entry (assoc-string option org-startup-options t)))
5003 (when entry
5004 (let ((var (nth 1 entry))
5005 (val (nth 2 entry)))
5006 (if (not (nth 3 entry)) (org-set-local var val)
5007 (unless (listp (symbol-value var))
5008 (org-set-local var nil))
5009 (add-to-list var val)))))))
5010 ;; TODO keywords.
5011 (org-set-local 'org-todo-kwd-alist nil)
5012 (org-set-local 'org-todo-key-alist nil)
5013 (org-set-local 'org-todo-key-trigger nil)
5014 (org-set-local 'org-todo-keywords-1 nil)
5015 (org-set-local 'org-done-keywords nil)
5016 (org-set-local 'org-todo-heads nil)
5017 (org-set-local 'org-todo-sets nil)
5018 (org-set-local 'org-todo-log-states nil)
5019 (let ((todo-sequences
5020 (or (nreverse (cdr (assq 'todo alist)))
5021 (let ((d (default-value 'org-todo-keywords)))
5022 (if (not (stringp (car d))) d
5023 ;; XXX: Backward compatibility code.
5024 (list (cons org-todo-interpretation d)))))))
5025 (dolist (sequence todo-sequences)
5026 (let* ((sequence (or (run-hook-with-args-until-success
5027 'org-todo-setup-filter-hook sequence)
5028 sequence))
5029 (sequence-type (car sequence))
5030 (keywords (cdr sequence))
5031 (sep (member "|" keywords))
5032 names alist)
5033 (dolist (k (remove "|" keywords))
5034 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5036 (error "Invalid TODO keyword %s" k))
5037 (let ((name (match-string 1 k))
5038 (key (match-string 2 k))
5039 (log (org-extract-log-state-settings k)))
5040 (push name names)
5041 (push (cons name (and key (string-to-char key))) alist)
5042 (when log (push log org-todo-log-states))))
5043 (let* ((names (nreverse names))
5044 (done (if sep (org-remove-keyword-keys (cdr sep))
5045 (last names)))
5046 (head (car names))
5047 (tail (list sequence-type head (car done) (org-last done))))
5048 (add-to-list 'org-todo-heads head 'append)
5049 (push names org-todo-sets)
5050 (setq org-done-keywords (append org-done-keywords done nil))
5051 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5052 (setq org-todo-key-alist
5053 (append org-todo-key-alist
5054 (and alist
5055 (append '((:startgroup))
5056 (nreverse alist)
5057 '((:endgroup))))))
5058 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5059 (setq org-todo-sets (nreverse org-todo-sets)
5060 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5061 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5062 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5063 ;; Compute the regular expressions and other local variables.
5064 ;; Using `org-outline-regexp-bol' would complicate them much,
5065 ;; because of the fixed white space at the end of that string.
5066 (if (not org-done-keywords)
5067 (setq org-done-keywords
5068 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5069 (setq org-not-done-keywords
5070 (org-delete-all org-done-keywords
5071 (copy-sequence org-todo-keywords-1))
5072 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5073 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5074 org-not-done-heading-regexp
5075 (format org-heading-keyword-regexp-format org-not-done-regexp)
5076 org-todo-line-regexp
5077 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5078 org-complex-heading-regexp
5079 (concat "^\\(\\*+\\)"
5080 "\\(?: +" org-todo-regexp "\\)?"
5081 "\\(?: +\\(\\[#.\\]\\)\\)?"
5082 "\\(?: +\\(.*?\\)\\)??"
5083 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5084 "[ \t]*$")
5085 org-complex-heading-regexp-format
5086 (concat "^\\(\\*+\\)"
5087 "\\(?: +" org-todo-regexp "\\)?"
5088 "\\(?: +\\(\\[#.\\]\\)\\)?"
5089 "\\(?: +"
5090 ;; Stats cookies can be stuck to body.
5091 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5092 "\\(%s\\)"
5093 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5094 "\\)"
5095 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5096 "[ \t]*$")
5097 org-todo-line-tags-regexp
5098 (concat "^\\(\\*+\\)"
5099 "\\(?: +" org-todo-regexp "\\)?"
5100 "\\(?: +\\(.*?\\)\\)??"
5101 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5102 "[ \t]*$"))
5103 (org-compute-latex-and-related-regexp)))))
5105 (defun org--setup-collect-keywords (regexp &optional files alist)
5106 "Return setup keywords values as an alist.
5108 REGEXP matches a subset of setup keywords. FILES is a list of
5109 file names already visited. It is used to avoid circular setup
5110 files. ALIST, when non-nil, is the alist computed so far.
5112 Return value contains the following keys: `archive', `category',
5113 `columns', `constants', `filetags', `link', `priorities',
5114 `property', `scripts', `startup', `tags' and `todo'."
5115 (org-with-wide-buffer
5116 (goto-char (point-min))
5117 (let ((case-fold-search t))
5118 (while (re-search-forward regexp nil t)
5119 (let ((element (org-element-at-point)))
5120 (when (eq (org-element-type element) 'keyword)
5121 (let ((key (org-element-property :key element))
5122 (value (org-element-property :value element)))
5123 (cond
5124 ((equal key "ARCHIVE")
5125 (when (org-string-nw-p value)
5126 (push (cons 'archive value) alist)))
5127 ((equal key "CATEGORY") (push (cons 'category value) alist))
5128 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5129 ((equal key "CONSTANTS")
5130 (let* ((constants (assq 'constants alist))
5131 (store (cdr constants)))
5132 (dolist (pair (org-split-string value))
5133 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5134 pair)
5135 (let* ((name (match-string 1 pair))
5136 (value (match-string 2 pair))
5137 (old (assoc name store)))
5138 (if old (setcdr old value)
5139 (push (cons name value) store)))))
5140 (if constants (setcdr constants store)
5141 (push (cons 'constants store) alist))))
5142 ((equal key "FILETAGS")
5143 (when (org-string-nw-p value)
5144 (let ((old (assq 'filetags alist))
5145 (new (apply #'nconc
5146 (mapcar (lambda (x) (org-split-string x ":"))
5147 (org-split-string value)))))
5148 (if old (setcdr old (append new (cdr old)))
5149 (push (cons 'filetags new) alist)))))
5150 ((equal key "LINK")
5151 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5152 (let ((links (assq 'link alist))
5153 (pair (cons (org-match-string-no-properties 1 value)
5154 (org-match-string-no-properties 2 value))))
5155 (if links (push pair (cdr links))
5156 (push (list 'link pair) alist)))))
5157 ((equal key "OPTIONS")
5158 (when (and (org-string-nw-p value)
5159 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5160 (push (cons 'scripts (read (match-string 1 value))) alist)))
5161 ((equal key "PRIORITIES")
5162 (push (cons 'priorities
5163 (let ((prio (org-split-string value)))
5164 (if (< (length prio) 3) '(?A ?C ?B)
5165 (mapcar #'string-to-char prio))))
5166 alist))
5167 ((equal key "PROPERTY")
5168 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5169 (let* ((property (assq 'property alist))
5170 (value (org--update-property-plist
5171 (org-match-string-no-properties 1 value)
5172 (org-match-string-no-properties 2 value)
5173 (cdr property))))
5174 (if property (setcdr property value)
5175 (push (cons 'property value) alist)))))
5176 ((equal key "STARTUP")
5177 (let ((startup (assq 'startup alist)))
5178 (if startup
5179 (setcdr startup
5180 (append (cdr startup) (org-split-string value)))
5181 (push (cons 'startup (org-split-string value)) alist))))
5182 ((equal key "TAGS")
5183 (let ((tag-cell (assq 'tags alist)))
5184 (if tag-cell
5185 (setcdr tag-cell
5186 (append (cdr tag-cell)
5187 '("\\n")
5188 (org-split-string value)))
5189 (push (cons 'tags (org-split-string value)) alist))))
5190 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5191 (let ((todo (assq 'todo alist))
5192 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5193 (org-split-string value))))
5194 (if todo (push value (cdr todo))
5195 (push (list 'todo value) alist))))
5196 ((equal key "SETUPFILE")
5197 (unless buffer-read-only ; Do not check in Gnus messages.
5198 (let ((f (and (org-string-nw-p value)
5199 (expand-file-name
5200 (org-remove-double-quotes value)))))
5201 (when (and f (file-readable-p f) (not (member f files)))
5202 (with-temp-buffer
5203 (insert-file-contents f)
5204 (setq alist
5205 ;; Fake Org mode to benefit from cache
5206 ;; without recurring needlessly.
5207 (let ((major-mode 'org-mode))
5208 (org--setup-collect-keywords
5209 regexp (cons f files) alist)))))))))))))))
5210 alist)
5212 (defun org--setup-process-tags (tags filetags)
5213 "Precompute variables used for tags.
5214 TAGS is a list of tags and tag group symbols, as strings.
5215 FILETAGS is a list of tags, as strings."
5216 ;; Process the file tags.
5217 (org-set-local 'org-file-tags
5218 (mapcar #'org-add-prop-inherited filetags))
5219 ;; Provide default tags if no local tags are found.
5220 (when (and (not tags) org-tag-alist)
5221 (setq tags
5222 (mapcar (lambda (tag)
5223 (case (car tag)
5224 (:startgroup "{")
5225 (:endgroup "}")
5226 (:startgrouptag "[")
5227 (:endgrouptag "]")
5228 (:grouptags ":")
5229 (:newline "\\n")
5230 (otherwise (concat (car tag)
5231 (and (characterp (cdr tag))
5232 (format "(%c)" (cdr tag)))))))
5233 org-tag-alist)))
5234 ;; Process the tags.
5235 (org-set-local 'org-tag-groups-alist nil)
5236 (org-set-local 'org-tag-alist nil)
5237 (let (group-flag)
5238 (while tags
5239 (let ((e (car tags)))
5240 (setq tags (cdr tags))
5241 (cond
5242 ((equal e "{")
5243 (push '(:startgroup) org-tag-alist)
5244 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5245 ((equal e "}")
5246 (push '(:endgroup) org-tag-alist)
5247 (setq group-flag nil))
5248 ((equal e "[")
5249 (push '(:startgrouptag) org-tag-alist)
5250 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5251 ((equal e "]")
5252 (push '(:endgrouptag) org-tag-alist)
5253 (setq group-flag nil))
5254 ((equal e ":")
5255 (push '(:grouptags) org-tag-alist)
5256 (setq group-flag 'append))
5257 ((equal e "\\n") (push '(:newline) org-tag-alist))
5258 ((string-match
5259 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5260 "\\|{.+?}\\)" ; regular expression
5261 "\\(?:(\\(.\\))\\)?\\'")) e)
5262 (let ((tag (match-string 1 e))
5263 (key (and (match-beginning 2)
5264 (string-to-char (match-string 2 e)))))
5265 (cond ((eq group-flag 'append)
5266 (setcar org-tag-groups-alist
5267 (append (car org-tag-groups-alist) (list tag))))
5268 (group-flag (push (list tag) org-tag-groups-alist)))
5269 ;; Push all tags in groups, no matter if they already exist.
5270 (unless (and (not group-flag) (assoc tag org-tag-alist))
5271 (push (cons tag key) org-tag-alist))))))))
5272 (setq org-tag-alist (nreverse org-tag-alist)))
5274 (defun org-file-contents (file &optional noerror)
5275 "Return the contents of FILE, as a string."
5276 (if (and file (file-readable-p file))
5277 (with-temp-buffer
5278 (insert-file-contents file)
5279 (buffer-string))
5280 (funcall (if noerror 'message 'error)
5281 "Cannot read file \"%s\"%s"
5282 file
5283 (let ((from (buffer-file-name (buffer-base-buffer))))
5284 (if from (concat " (referenced in file \"" from "\")") "")))))
5286 (defun org-extract-log-state-settings (x)
5287 "Extract the log state setting from a TODO keyword string.
5288 This will extract info from a string like \"WAIT(w@/!)\"."
5289 (let (kw key log1 log2)
5290 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5291 (setq kw (match-string 1 x)
5292 key (and (match-end 2) (match-string 2 x))
5293 log1 (and (match-end 3) (match-string 3 x))
5294 log2 (and (match-end 4) (match-string 4 x)))
5295 (and (or log1 log2)
5296 (list kw
5297 (and log1 (if (equal log1 "!") 'time 'note))
5298 (and log2 (if (equal log2 "!") 'time 'note)))))))
5300 (defun org-remove-keyword-keys (list)
5301 "Remove a pair of parenthesis at the end of each string in LIST."
5302 (mapcar (lambda (x)
5303 (if (string-match "(.*)$" x)
5304 (substring x 0 (match-beginning 0))
5306 list))
5308 (defun org-assign-fast-keys (alist)
5309 "Assign fast keys to a keyword-key alist.
5310 Respect keys that are already there."
5311 (let (new e (alt ?0))
5312 (while (setq e (pop alist))
5313 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5314 (cdr e)) ;; Key already assigned.
5315 (push e new)
5316 (let ((clist (string-to-list (downcase (car e))))
5317 (used (append new alist)))
5318 (when (= (car clist) ?@)
5319 (pop clist))
5320 (while (and clist (rassoc (car clist) used))
5321 (pop clist))
5322 (unless clist
5323 (while (rassoc alt used)
5324 (incf alt)))
5325 (push (cons (car e) (or (car clist) alt)) new))))
5326 (nreverse new)))
5328 ;;; Some variables used in various places
5330 (defvar org-window-configuration nil
5331 "Used in various places to store a window configuration.")
5332 (defvar org-selected-window nil
5333 "Used in various places to store a window configuration.")
5334 (defvar org-finish-function nil
5335 "Function to be called when `C-c C-c' is used.
5336 This is for getting out of special buffers like capture.")
5339 ;; FIXME: Occasionally check by commenting these, to make sure
5340 ;; no other functions uses these, forgetting to let-bind them.
5341 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5342 (defvar org-last-state)
5343 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5345 ;; Defined somewhere in this file, but used before definition.
5346 (defvar org-entities) ;; defined in org-entities.el
5347 (defvar org-struct-menu)
5348 (defvar org-org-menu)
5349 (defvar org-tbl-menu)
5351 ;;;; Define the Org-mode
5353 ;; We use a before-change function to check if a table might need
5354 ;; an update.
5355 (defvar org-table-may-need-update t
5356 "Indicates that a table might need an update.
5357 This variable is set by `org-before-change-function'.
5358 `org-table-align' sets it back to nil.")
5359 (defun org-before-change-function (beg end)
5360 "Every change indicates that a table might need an update."
5361 (setq org-table-may-need-update t))
5362 (defvar org-mode-map)
5363 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5364 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5365 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5366 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5367 (defvar org-table-buffer-is-an nil)
5369 (defvar bidi-paragraph-direction)
5370 (defvar buffer-face-mode-face)
5372 (require 'outline)
5373 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5374 (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"))
5375 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5377 ;; Other stuff we need.
5378 (require 'time-date)
5379 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5380 (require 'easymenu)
5381 (require 'overlay)
5383 ;; (require 'org-macs) moved higher up in the file before it is first used
5384 (require 'org-entities)
5385 ;; (require 'org-compat) moved higher up in the file before it is first used
5386 (require 'org-faces)
5387 (require 'org-list)
5388 (require 'org-pcomplete)
5389 (require 'org-src)
5390 (require 'org-footnote)
5391 (require 'org-macro)
5393 ;; babel
5394 (require 'ob)
5396 ;;;###autoload
5397 (define-derived-mode org-mode outline-mode "Org"
5398 "Outline-based notes management and organizer, alias
5399 \"Carsten's outline-mode for keeping track of everything.\"
5401 Org-mode develops organizational tasks around a NOTES file which
5402 contains information about projects as plain text. Org-mode is
5403 implemented on top of outline-mode, which is ideal to keep the content
5404 of large files well structured. It supports ToDo items, deadlines and
5405 time stamps, which magically appear in the diary listing of the Emacs
5406 calendar. Tables are easily created with a built-in table editor.
5407 Plain text URL-like links connect to websites, emails (VM), Usenet
5408 messages (Gnus), BBDB entries, and any files related to the project.
5409 For printing and sharing of notes, an Org-mode file (or a part of it)
5410 can be exported as a structured ASCII or HTML file.
5412 The following commands are available:
5414 \\{org-mode-map}"
5416 ;; Get rid of Outline menus, they are not needed
5417 ;; Need to do this here because define-derived-mode sets up
5418 ;; the keymap so late. Still, it is a waste to call this each time
5419 ;; we switch another buffer into org-mode.
5420 (if (featurep 'xemacs)
5421 (when (boundp 'outline-mode-menu-heading)
5422 ;; Assume this is Greg's port, it uses easymenu
5423 (easy-menu-remove outline-mode-menu-heading)
5424 (easy-menu-remove outline-mode-menu-show)
5425 (easy-menu-remove outline-mode-menu-hide))
5426 (define-key org-mode-map [menu-bar headings] 'undefined)
5427 (define-key org-mode-map [menu-bar hide] 'undefined)
5428 (define-key org-mode-map [menu-bar show] 'undefined))
5430 (org-load-modules-maybe)
5431 (easy-menu-add org-org-menu)
5432 (easy-menu-add org-tbl-menu)
5433 (org-install-agenda-files-menu)
5434 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5435 (add-to-invisibility-spec '(org-cwidth))
5436 (add-to-invisibility-spec '(org-hide-block . t))
5437 (when (featurep 'xemacs)
5438 (org-set-local 'line-move-ignore-invisible t))
5439 (org-set-local 'outline-regexp org-outline-regexp)
5440 (org-set-local 'outline-level 'org-outline-level)
5441 (setq bidi-paragraph-direction 'left-to-right)
5442 (when (and org-ellipsis
5443 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5444 (fboundp 'make-glyph-code))
5445 (unless org-display-table
5446 (setq org-display-table (make-display-table)))
5447 (set-display-table-slot
5448 org-display-table 4
5449 (vconcat (mapcar
5450 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5451 org-ellipsis)))
5452 (if (stringp org-ellipsis) org-ellipsis "..."))))
5453 (setq buffer-display-table org-display-table))
5454 (org-set-regexps-and-options)
5455 (org-set-font-lock-defaults)
5456 (when (and org-tag-faces (not org-tags-special-faces-re))
5457 ;; tag faces set outside customize.... force initialization.
5458 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5459 ;; Calc embedded
5460 (org-set-local 'calc-embedded-open-mode "# ")
5461 ;; Modify a few syntax entries
5462 (modify-syntax-entry ?@ "w")
5463 (modify-syntax-entry ?\" "\"")
5464 (modify-syntax-entry ?\\ "_")
5465 (modify-syntax-entry ?~ "_")
5466 (if org-startup-truncated (setq truncate-lines t))
5467 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5468 (org-set-local 'font-lock-unfontify-region-function
5469 'org-unfontify-region)
5470 ;; Activate before-change-function
5471 (org-set-local 'org-table-may-need-update t)
5472 (org-add-hook 'before-change-functions 'org-before-change-function nil
5473 'local)
5474 ;; Check for running clock before killing a buffer
5475 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5476 ;; Initialize macros templates.
5477 (org-macro-initialize-templates)
5478 ;; Initialize radio targets.
5479 (org-update-radio-target-regexp)
5480 ;; Indentation.
5481 (org-set-local 'indent-line-function 'org-indent-line)
5482 (org-set-local 'indent-region-function 'org-indent-region)
5483 ;; Filling and auto-filling.
5484 (org-setup-filling)
5485 ;; Comments.
5486 (org-setup-comments-handling)
5487 ;; Initialize cache.
5488 (org-element-cache-reset)
5489 ;; Beginning/end of defun
5490 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5491 (org-set-local 'end-of-defun-function
5492 (lambda ()
5493 (if (not (org-at-heading-p))
5494 (org-forward-element)
5495 (org-forward-element)
5496 (forward-char -1))))
5497 ;; Next error for sparse trees
5498 (org-set-local 'next-error-function 'org-occur-next-match)
5499 ;; Make sure dependence stuff works reliably, even for users who set it
5500 ;; too late :-(
5501 (if org-enforce-todo-dependencies
5502 (add-hook 'org-blocker-hook
5503 'org-block-todo-from-children-or-siblings-or-parent)
5504 (remove-hook 'org-blocker-hook
5505 'org-block-todo-from-children-or-siblings-or-parent))
5506 (if org-enforce-todo-checkbox-dependencies
5507 (add-hook 'org-blocker-hook
5508 'org-block-todo-from-checkboxes)
5509 (remove-hook 'org-blocker-hook
5510 'org-block-todo-from-checkboxes))
5512 ;; Align options lines
5513 (org-set-local
5514 'align-mode-rules-list
5515 '((org-in-buffer-settings
5516 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5517 (modes . '(org-mode)))))
5519 ;; Imenu
5520 (org-set-local 'imenu-create-index-function
5521 'org-imenu-get-tree)
5523 ;; Make isearch reveal context
5524 (if (or (featurep 'xemacs)
5525 (not (boundp 'outline-isearch-open-invisible-function)))
5526 ;; Emacs 21 and XEmacs make use of the hook
5527 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5528 ;; Emacs 22 deals with this through a special variable
5529 (org-set-local 'outline-isearch-open-invisible-function
5530 (lambda (&rest ignore) (org-show-context 'isearch))))
5532 ;; Setup the pcomplete hooks
5533 (set (make-local-variable 'pcomplete-command-completion-function)
5534 'org-pcomplete-initial)
5535 (set (make-local-variable 'pcomplete-command-name-function)
5536 'org-command-at-point)
5537 (set (make-local-variable 'pcomplete-default-completion-function)
5538 'ignore)
5539 (set (make-local-variable 'pcomplete-parse-arguments-function)
5540 'org-parse-arguments)
5541 (set (make-local-variable 'pcomplete-termination-string) "")
5542 (when (>= emacs-major-version 23)
5543 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5545 ;; If empty file that did not turn on org-mode automatically, make it to.
5546 (if (and org-insert-mode-line-in-empty-file
5547 (org-called-interactively-p 'any)
5548 (= (point-min) (point-max)))
5549 (insert "# -*- mode: org -*-\n\n"))
5550 (unless org-inhibit-startup
5551 (org-unmodified
5552 (and org-startup-with-beamer-mode (org-beamer-mode))
5553 (when org-startup-align-all-tables
5554 (org-table-map-tables 'org-table-align 'quietly))
5555 (when org-startup-with-inline-images
5556 (org-display-inline-images))
5557 (when org-startup-with-latex-preview
5558 (org-toggle-latex-fragment))
5559 (unless org-inhibit-startup-visibility-stuff
5560 (org-set-startup-visibility))
5561 (org-refresh-effort-properties)))
5562 ;; Try to set org-hide correctly
5563 (let ((foreground (org-find-invisible-foreground)))
5564 (if foreground
5565 (set-face-foreground 'org-hide foreground))))
5567 ;; Update `customize-package-emacs-version-alist'
5568 (add-to-list 'customize-package-emacs-version-alist
5569 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5570 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5571 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5573 (defvar org-mode-transpose-word-syntax-table
5574 (let ((st (make-syntax-table text-mode-syntax-table)))
5575 (mapc (lambda(c) (modify-syntax-entry
5576 (string-to-char (car c)) "w p" st))
5577 org-emphasis-alist)
5578 st))
5580 (when (fboundp 'abbrev-table-put)
5581 (abbrev-table-put org-mode-abbrev-table
5582 :parents (list text-mode-abbrev-table)))
5584 (defun org-find-invisible-foreground ()
5585 (let ((candidates (remove
5586 "unspecified-bg"
5587 (nconc
5588 (list (face-background 'default)
5589 (face-background 'org-default))
5590 (mapcar
5591 (lambda (alist)
5592 (when (boundp alist)
5593 (cdr (assoc 'background-color (symbol-value alist)))))
5594 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5595 (list (face-foreground 'org-hide))))))
5596 (car (remove nil candidates))))
5598 (defun org-current-time (&optional rounding-minutes past)
5599 "Current time, possibly rounded to ROUNDING-MINUTES.
5600 When ROUNDING-MINUTES is not an integer, fall back on the car of
5601 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5602 the rounding returns a past time."
5603 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5604 (car org-time-stamp-rounding-minutes)))
5605 (time (decode-time)) res)
5606 (if (< r 1)
5607 (current-time)
5608 (setq res
5609 (apply 'encode-time
5610 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5611 (nthcdr 2 time))))
5612 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5613 (seconds-to-time (- (org-float-time res) (* r 60)))
5614 res))))
5616 (defun org-today ()
5617 "Return today date, considering `org-extend-today-until'."
5618 (time-to-days
5619 (time-subtract (current-time)
5620 (list 0 (* 3600 org-extend-today-until) 0))))
5622 ;;;; Font-Lock stuff, including the activators
5624 (defvar org-mouse-map (make-sparse-keymap))
5625 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5626 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5627 (when org-mouse-1-follows-link
5628 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5629 (when org-tab-follows-link
5630 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5631 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5633 (require 'font-lock)
5635 (defconst org-non-link-chars "]\t\n\r<>")
5636 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5637 "file+sys" "news" "shell" "elisp" "doi" "message"
5638 "help"))
5639 (defvar org-link-types-re nil
5640 "Matches a link that has a url-like prefix like \"http:\"")
5641 (defvar org-link-re-with-space nil
5642 "Matches a link with spaces, optional angular brackets around it.")
5643 (defvar org-link-re-with-space2 nil
5644 "Matches a link with spaces, optional angular brackets around it.")
5645 (defvar org-link-re-with-space3 nil
5646 "Matches a link with spaces, only for internal part in bracket links.")
5647 (defvar org-angle-link-re nil
5648 "Matches link with angular brackets, spaces are allowed.")
5649 (defvar org-plain-link-re nil
5650 "Matches plain link, without spaces.")
5651 (defvar org-bracket-link-regexp nil
5652 "Matches a link in double brackets.")
5653 (defvar org-bracket-link-analytic-regexp nil
5654 "Regular expression used to analyze links.
5655 Here is what the match groups contain after a match:
5656 1: http:
5657 2: http
5658 3: path
5659 4: [desc]
5660 5: desc")
5661 (defvar org-bracket-link-analytic-regexp++ nil
5662 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5663 (defvar org-any-link-re nil
5664 "Regular expression matching any link.")
5666 (defconst org-match-sexp-depth 3
5667 "Number of stacked braces for sub/superscript matching.")
5669 (defun org-create-multibrace-regexp (left right n)
5670 "Create a regular expression which will match a balanced sexp.
5671 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5672 as single character strings.
5673 The regexp returned will match the entire expression including the
5674 delimiters. It will also define a single group which contains the
5675 match except for the outermost delimiters. The maximum depth of
5676 stacked delimiters is N. Escaping delimiters is not possible."
5677 (let* ((nothing (concat "[^" left right "]*?"))
5678 (or "\\|")
5679 (re nothing)
5680 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5681 (while (> n 1)
5682 (setq n (1- n)
5683 re (concat re or next)
5684 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5685 (concat left "\\(" re "\\)" right)))
5687 (defconst org-match-substring-regexp
5688 (concat
5689 "\\(\\S-\\)\\([_^]\\)\\("
5690 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5691 "\\|"
5692 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5693 "\\|"
5694 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5695 "The regular expression matching a sub- or superscript.")
5697 (defconst org-match-substring-with-braces-regexp
5698 (concat
5699 "\\(\\S-\\)\\([_^]\\)"
5700 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5701 "The regular expression matching a sub- or superscript, forcing braces.")
5703 (defun org-make-link-regexps ()
5704 "Update the link regular expressions.
5705 This should be called after the variable `org-link-types' has changed."
5706 (let ((types-re (regexp-opt org-link-types t)))
5707 (setq org-link-types-re
5708 (concat "\\`" types-re ":")
5709 org-link-re-with-space
5710 (concat "<?" types-re ":"
5711 "\\([^" org-non-link-chars " ]"
5712 "[^" org-non-link-chars "]*"
5713 "[^" org-non-link-chars " ]\\)>?")
5714 org-link-re-with-space2
5715 (concat "<?" types-re ":"
5716 "\\([^" org-non-link-chars " ]"
5717 "[^\t\n\r]*"
5718 "[^" org-non-link-chars " ]\\)>?")
5719 org-link-re-with-space3
5720 (concat "<?" types-re ":"
5721 "\\([^" org-non-link-chars " ]"
5722 "[^\t\n\r]*\\)")
5723 org-angle-link-re
5724 (concat "<" types-re ":"
5725 "\\([^" org-non-link-chars " ]"
5726 "[^" org-non-link-chars "]*"
5727 "\\)>")
5728 org-plain-link-re
5729 (concat
5730 "\\<" types-re ":"
5731 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5732 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5733 org-bracket-link-regexp
5734 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5735 org-bracket-link-analytic-regexp
5736 (concat
5737 "\\[\\["
5738 "\\(" types-re ":\\)?"
5739 "\\([^]]+\\)"
5740 "\\]"
5741 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5742 "\\]")
5743 org-bracket-link-analytic-regexp++
5744 (concat
5745 "\\[\\["
5746 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5747 "\\([^]]+\\)"
5748 "\\]"
5749 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5750 "\\]")
5751 org-any-link-re
5752 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5753 org-angle-link-re "\\)\\|\\("
5754 org-plain-link-re "\\)"))))
5756 (org-make-link-regexps)
5758 (defvar org-emph-face nil)
5760 (defun org-do-emphasis-faces (limit)
5761 "Run through the buffer and emphasize strings."
5762 (let (rtn a)
5763 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5764 (let* ((border (char-after (match-beginning 3)))
5765 (bre (regexp-quote (char-to-string border))))
5766 (if (and (not (= border (char-after (match-beginning 4))))
5767 (not (save-match-data
5768 (string-match (concat bre ".*" bre)
5769 (replace-regexp-in-string
5770 "\n" " "
5771 (substring (match-string 2) 1 -1))))))
5772 (progn
5773 (setq rtn t)
5774 (setq a (assoc (match-string 3) org-emphasis-alist))
5775 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5776 'face
5777 (nth 1 a))
5778 (and (nth 2 a)
5779 (org-remove-flyspell-overlays-in
5780 (match-beginning 0) (match-end 0)))
5781 (add-text-properties (match-beginning 2) (match-end 2)
5782 '(font-lock-multiline t org-emphasis t))
5783 (when org-hide-emphasis-markers
5784 (add-text-properties (match-end 4) (match-beginning 5)
5785 '(invisible org-link))
5786 (add-text-properties (match-beginning 3) (match-end 3)
5787 '(invisible org-link))))))
5788 (goto-char (1+ (match-beginning 0))))
5789 rtn))
5791 (defun org-emphasize (&optional char)
5792 "Insert or change an emphasis, i.e. a font like bold or italic.
5793 If there is an active region, change that region to a new emphasis.
5794 If there is no region, just insert the marker characters and position
5795 the cursor between them.
5796 CHAR should be the marker character. If it is a space, it means to
5797 remove the emphasis of the selected region.
5798 If CHAR is not given (for example in an interactive call) it will be
5799 prompted for."
5800 (interactive)
5801 (let ((erc org-emphasis-regexp-components)
5802 (prompt "")
5803 (string "") beg end move c s)
5804 (if (org-region-active-p)
5805 (setq beg (region-beginning) end (region-end)
5806 string (buffer-substring beg end))
5807 (setq move t))
5809 (unless char
5810 (message "Emphasis marker or tag: [%s]"
5811 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5812 (setq char (read-char-exclusive)))
5813 (if (equal char ?\ )
5814 (setq s "" move nil)
5815 (unless (assoc (char-to-string char) org-emphasis-alist)
5816 (user-error "No such emphasis marker: \"%c\"" char))
5817 (setq s (char-to-string char)))
5818 (while (and (> (length string) 1)
5819 (equal (substring string 0 1) (substring string -1))
5820 (assoc (substring string 0 1) org-emphasis-alist))
5821 (setq string (substring string 1 -1)))
5822 (setq string (concat s string s))
5823 (if beg (delete-region beg end))
5824 (unless (or (bolp)
5825 (string-match (concat "[" (nth 0 erc) "\n]")
5826 (char-to-string (char-before (point)))))
5827 (insert " "))
5828 (unless (or (eobp)
5829 (string-match (concat "[" (nth 1 erc) "\n]")
5830 (char-to-string (char-after (point)))))
5831 (insert " ") (backward-char 1))
5832 (insert string)
5833 (and move (backward-char 1))))
5835 (defconst org-nonsticky-props
5836 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5838 (defsubst org-rear-nonsticky-at (pos)
5839 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5841 (defun org-activate-plain-links (limit)
5842 "Add link properties for plain links."
5843 (let (f hl)
5844 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5845 (not (member 'org-tag
5846 (get-text-property (1- (match-beginning 0)) 'face)))
5847 (not (org-in-src-block-p)))
5848 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5849 (setq f (get-text-property (match-beginning 0) 'face))
5850 (setq hl (org-match-string-no-properties 0))
5851 (if (or (eq f 'org-tag)
5852 (and (listp f) (memq 'org-tag f)))
5854 (add-text-properties (match-beginning 0) (match-end 0)
5855 (list 'mouse-face 'highlight
5856 'face 'org-link
5857 'htmlize-link `(:uri ,hl)
5858 'keymap org-mouse-map))
5859 (org-rear-nonsticky-at (match-end 0)))
5860 t)))
5862 (defun org-activate-code (limit)
5863 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5864 (progn
5865 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5866 (remove-text-properties (match-beginning 0) (match-end 0)
5867 '(display t invisible t intangible t))
5868 t)))
5870 (defcustom org-src-fontify-natively t
5871 "When non-nil, fontify code in code blocks."
5872 :type 'boolean
5873 :version "24.4"
5874 :package-version '(Org . "8.3")
5875 :group 'org-appearance
5876 :group 'org-babel)
5878 (defcustom org-allow-promoting-top-level-subtree nil
5879 "When non-nil, allow promoting a top level subtree.
5880 The leading star of the top level headline will be replaced
5881 by a #."
5882 :type 'boolean
5883 :version "24.1"
5884 :group 'org-appearance)
5886 (defun org-fontify-meta-lines-and-blocks (limit)
5887 (condition-case nil
5888 (org-fontify-meta-lines-and-blocks-1 limit)
5889 (error (message "org-mode fontification error"))))
5891 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5892 "Fontify #+ lines and blocks."
5893 (let ((case-fold-search t))
5894 (if (re-search-forward
5895 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5896 limit t)
5897 (let ((beg (match-beginning 0))
5898 (block-start (match-end 0))
5899 (block-end nil)
5900 (lang (match-string 7))
5901 (beg1 (line-beginning-position 2))
5902 (dc1 (downcase (match-string 2)))
5903 (dc3 (downcase (match-string 3)))
5904 end end1 quoting block-type ovl)
5905 (cond
5906 ((and (match-end 4) (equal dc3 "+begin"))
5907 ;; Truly a block
5908 (setq block-type (downcase (match-string 5))
5909 quoting (member block-type org-protecting-blocks))
5910 (when (re-search-forward
5911 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5912 nil t) ;; on purpose, we look further than LIMIT
5913 (setq end (min (point-max) (match-end 0))
5914 end1 (min (point-max) (1- (match-beginning 0))))
5915 (setq block-end (match-beginning 0))
5916 (when quoting
5917 (org-remove-flyspell-overlays-in beg1 end1)
5918 (remove-text-properties beg end
5919 '(display t invisible t intangible t)))
5920 (add-text-properties
5921 beg end '(font-lock-fontified t font-lock-multiline t))
5922 (add-text-properties beg beg1 '(face org-meta-line))
5923 (org-remove-flyspell-overlays-in beg beg1)
5924 (add-text-properties ; For end_src
5925 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5926 (org-remove-flyspell-overlays-in end1 end)
5927 (cond
5928 ((and lang (not (string= lang "")) org-src-fontify-natively)
5929 (org-src-font-lock-fontify-block lang block-start block-end)
5930 (add-text-properties beg1 block-end '(src-block t)))
5931 (quoting
5932 (add-text-properties beg1 (min (point-max) (1+ end1))
5933 '(face org-block))) ; end of source block
5934 ((not org-fontify-quote-and-verse-blocks))
5935 ((string= block-type "quote")
5936 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5937 ((string= block-type "verse")
5938 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5939 (add-text-properties beg beg1 '(face org-block-begin-line))
5940 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5941 '(face org-block-end-line))
5943 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5944 (org-remove-flyspell-overlays-in
5945 (match-beginning 0)
5946 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5947 (add-text-properties
5948 beg (match-end 3)
5949 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5950 '(font-lock-fontified t invisible t)
5951 '(font-lock-fontified t face org-document-info-keyword)))
5952 (add-text-properties
5953 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5954 (if (string-equal dc1 "+title:")
5955 '(font-lock-fontified t face org-document-title)
5956 '(font-lock-fontified t face org-document-info))))
5957 ((equal dc1 "+caption:")
5958 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5959 (remove-text-properties (match-beginning 0) (match-end 0)
5960 '(display t invisible t intangible t))
5961 (add-text-properties (match-beginning 1) (match-end 3)
5962 '(font-lock-fontified t face org-meta-line))
5963 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5964 '(font-lock-fontified t face org-block))
5966 ((member dc3 '(" " ""))
5967 (org-remove-flyspell-overlays-in beg (match-end 0))
5968 (add-text-properties
5969 beg (match-end 0)
5970 '(font-lock-fontified t face font-lock-comment-face)))
5971 (t ;; just any other in-buffer setting, but not indented
5972 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5973 (remove-text-properties (match-beginning 0) (match-end 0)
5974 '(display t invisible t intangible t))
5975 (add-text-properties beg (match-end 0)
5976 '(font-lock-fontified t face org-meta-line))
5977 t))))))
5979 (defun org-fontify-drawers (limit)
5980 "Fontify drawers."
5981 (when (re-search-forward org-drawer-regexp limit t)
5982 (add-text-properties
5983 (match-beginning 0) (match-end 0)
5984 '(font-lock-fontified t face org-special-keyword))
5985 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5988 (defun org-fontify-macros (limit)
5989 "Fontify macros."
5990 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5991 (add-text-properties
5992 (match-beginning 0) (match-end 0)
5993 '(font-lock-fontified t face org-macro))
5994 (when org-hide-macro-markers
5995 (add-text-properties (match-end 2) (match-beginning 2)
5996 '(invisible t))
5997 (add-text-properties (match-beginning 1) (match-end 1)
5998 '(invisible t)))
5999 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6002 (defun org-activate-angle-links (limit)
6003 "Add text properties for angle links."
6004 (if (and (re-search-forward org-angle-link-re limit t)
6005 (not (org-in-src-block-p)))
6006 (progn
6007 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6008 (add-text-properties (match-beginning 0) (match-end 0)
6009 (list 'mouse-face 'highlight
6010 'keymap org-mouse-map))
6011 (org-rear-nonsticky-at (match-end 0))
6012 t)))
6014 (defun org-activate-footnote-links (limit)
6015 "Add text properties for footnotes."
6016 (let ((fn (org-footnote-next-reference-or-definition limit)))
6017 (when fn
6018 (let* ((beg (nth 1 fn))
6019 (end (nth 2 fn))
6020 (label (car fn))
6021 (referencep (/= (line-beginning-position) beg)))
6022 (when (and referencep (nth 3 fn))
6023 (save-excursion
6024 (goto-char beg)
6025 (search-forward (or label "fn:"))
6026 (org-remove-flyspell-overlays-in beg (match-end 0))))
6027 (add-text-properties beg end
6028 (list 'mouse-face 'highlight
6029 'keymap org-mouse-map
6030 'help-echo
6031 (if referencep "Footnote reference"
6032 "Footnote definition")
6033 'font-lock-fontified t
6034 'font-lock-multiline t
6035 'face 'org-footnote))))))
6037 (defun org-activate-bracket-links (limit)
6038 "Add text properties for bracketed links."
6039 (if (and (re-search-forward org-bracket-link-regexp limit t)
6040 (not (org-in-src-block-p)))
6041 (let* ((hl (org-match-string-no-properties 1))
6042 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6043 (ip (org-maybe-intangible
6044 (list 'invisible 'org-link
6045 'keymap org-mouse-map 'mouse-face 'highlight
6046 'font-lock-multiline t 'help-echo help
6047 'htmlize-link `(:uri ,hl))))
6048 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6049 'font-lock-multiline t 'help-echo help
6050 'htmlize-link `(:uri ,hl))))
6051 ;; We need to remove the invisible property here. Table narrowing
6052 ;; may have made some of this invisible.
6053 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6054 (remove-text-properties (match-beginning 0) (match-end 0)
6055 '(invisible nil))
6056 (if (match-end 3)
6057 (progn
6058 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6059 (org-rear-nonsticky-at (match-beginning 3))
6060 (add-text-properties (match-beginning 3) (match-end 3) vp)
6061 (org-rear-nonsticky-at (match-end 3))
6062 (add-text-properties (match-end 3) (match-end 0) ip)
6063 (org-rear-nonsticky-at (match-end 0)))
6064 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6065 (org-rear-nonsticky-at (match-beginning 1))
6066 (add-text-properties (match-beginning 1) (match-end 1) vp)
6067 (org-rear-nonsticky-at (match-end 1))
6068 (add-text-properties (match-end 1) (match-end 0) ip)
6069 (org-rear-nonsticky-at (match-end 0)))
6070 t)))
6072 (defun org-activate-dates (limit)
6073 "Add text properties for dates."
6074 (if (and (re-search-forward org-tsr-regexp-both limit t)
6075 (not (equal (char-before (match-beginning 0)) 91)))
6076 (progn
6077 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6078 (add-text-properties (match-beginning 0) (match-end 0)
6079 (list 'mouse-face 'highlight
6080 'keymap org-mouse-map))
6081 (org-rear-nonsticky-at (match-end 0))
6082 (when org-display-custom-times
6083 (if (match-end 3)
6084 (org-display-custom-time (match-beginning 3) (match-end 3)))
6085 (org-display-custom-time (match-beginning 1) (match-end 1)))
6086 t)))
6088 (defvar org-target-link-regexp nil
6089 "Regular expression matching radio targets in plain text.")
6090 (make-variable-buffer-local 'org-target-link-regexp)
6092 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6093 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6094 border border border))
6095 "Regular expression matching a link target.")
6097 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6098 "Regular expression matching a radio target.")
6100 (defconst org-any-target-regexp
6101 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6102 "Regular expression matching any target.")
6104 (defun org-activate-target-links (limit)
6105 "Add text properties for target matches."
6106 (when org-target-link-regexp
6107 (let ((case-fold-search t))
6108 (if (re-search-forward org-target-link-regexp limit t)
6109 (progn
6110 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6111 (add-text-properties (match-beginning 1) (match-end 1)
6112 (list 'mouse-face 'highlight
6113 'keymap org-mouse-map
6114 'help-echo "Radio target link"
6115 'org-linked-text t))
6116 (org-rear-nonsticky-at (match-end 1))
6117 t)))))
6119 (defun org-update-radio-target-regexp ()
6120 "Find all radio targets in this file and update the regular expression.
6121 Also refresh fontification if needed."
6122 (interactive)
6123 (let ((old-regexp org-target-link-regexp)
6124 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6125 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6126 (targets
6127 (org-with-wide-buffer
6128 (goto-char (point-min))
6129 (let (rtn)
6130 (while (re-search-forward org-radio-target-regexp nil t)
6131 ;; Make sure point is really within the object.
6132 (backward-char)
6133 (let ((obj (org-element-context)))
6134 (when (eq (org-element-type obj) 'radio-target)
6135 (add-to-list 'rtn (org-element-property :value obj)))))
6136 rtn))))
6137 (setq org-target-link-regexp
6138 (and targets
6139 (concat before-re
6140 (mapconcat
6141 (lambda (x)
6142 (replace-regexp-in-string
6143 " +" "\\s-+" (regexp-quote x) t t))
6144 targets
6145 "\\|")
6146 after-re)))
6147 (unless (equal old-regexp org-target-link-regexp)
6148 ;; Clean-up cache.
6149 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6150 ((not org-target-link-regexp) old-regexp)
6152 (concat before-re
6153 (mapconcat
6154 (lambda (re)
6155 (substring re (length before-re)
6156 (- (length after-re))))
6157 (list old-regexp org-target-link-regexp)
6158 "\\|")
6159 after-re)))))
6160 (org-with-wide-buffer
6161 (goto-char (point-min))
6162 (while (re-search-forward regexp nil t)
6163 (org-element-cache-refresh (match-beginning 1)))))
6164 ;; Re fontify buffer.
6165 (when (memq 'radio org-highlight-links)
6166 (org-restart-font-lock)))))
6168 (defun org-hide-wide-columns (limit)
6169 (let (s e)
6170 (setq s (text-property-any (point) (or limit (point-max))
6171 'org-cwidth t))
6172 (when s
6173 (setq e (next-single-property-change s 'org-cwidth))
6174 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6175 (goto-char e)
6176 t)))
6178 (defvar org-latex-and-related-regexp nil
6179 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6181 (defun org-compute-latex-and-related-regexp ()
6182 "Compute regular expression for LaTeX, entities and sub/superscript.
6183 Result depends on variable `org-highlight-latex-and-related'."
6184 (org-set-local
6185 'org-latex-and-related-regexp
6186 (let* ((re-sub
6187 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6188 ((eq org-use-sub-superscripts '{})
6189 (list org-match-substring-with-braces-regexp))
6190 (org-use-sub-superscripts (list org-match-substring-regexp))))
6191 (re-latex
6192 (when (memq 'latex org-highlight-latex-and-related)
6193 (let ((matchers (plist-get org-format-latex-options :matchers)))
6194 (delq nil
6195 (mapcar (lambda (x)
6196 (and (member (car x) matchers) (nth 1 x)))
6197 org-latex-regexps)))))
6198 (re-entities
6199 (when (memq 'entities org-highlight-latex-and-related)
6200 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6201 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6203 (defun org-do-latex-and-related (limit)
6204 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6205 LIMIT bounds the search for syntax to highlight. Stop at first
6206 highlighted object, if any. Return t if some highlighting was
6207 done, nil otherwise."
6208 (when (org-string-nw-p org-latex-and-related-regexp)
6209 (catch 'found
6210 (while (re-search-forward org-latex-and-related-regexp limit t)
6211 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6212 'face))
6213 '(org-code org-verbatim underline))
6214 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6215 '(?_ ?^))
6217 0)))
6218 (font-lock-prepend-text-property
6219 (+ offset (match-beginning 0)) (match-end 0)
6220 'face 'org-latex-and-related)
6221 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6222 '(font-lock-multiline t)))
6223 (throw 'found t)))
6224 nil)))
6226 (defun org-restart-font-lock ()
6227 "Restart `font-lock-mode', to force refontification."
6228 (when (and (boundp 'font-lock-mode) font-lock-mode)
6229 (font-lock-mode -1)
6230 (font-lock-mode 1)))
6232 (defun org-activate-tags (limit)
6233 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6234 (progn
6235 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6236 (add-text-properties (match-beginning 1) (match-end 1)
6237 (list 'mouse-face 'highlight
6238 'keymap org-mouse-map))
6239 (org-rear-nonsticky-at (match-end 1))
6240 t)))
6242 (defun org-outline-level ()
6243 "Compute the outline level of the heading at point.
6245 If this is called at a normal headline, the level is the number
6246 of stars. Use `org-reduced-level' to remove the effect of
6247 `org-odd-levels'. Unlike to `org-current-level', this function
6248 takes into consideration inlinetasks."
6249 (org-with-wide-buffer
6250 (end-of-line)
6251 (if (re-search-backward org-outline-regexp-bol nil t)
6252 (1- (- (match-end 0) (match-beginning 0)))
6253 0)))
6255 (defvar org-font-lock-keywords nil)
6257 (defsubst org-re-property (property &optional literal allow-null value)
6258 "Return a regexp matching a PROPERTY line.
6260 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6261 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6262 non-nil, match properties even without a value.
6264 Match group 3 is set to the value when it exists. If there is no
6265 value and ALLOW-NULL is non-nil, it is set to the empty string.
6267 With optional argument VALUE, match only property lines with
6268 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6269 unless LITERAL is non-nil."
6270 (concat
6271 "^\\(?4:[ \t]*\\)"
6272 (format "\\(?1::\\(?2:%s\\):\\)"
6273 (if literal property (regexp-quote property)))
6274 (cond (value
6275 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6276 (if literal value (regexp-quote value))))
6277 (allow-null
6278 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6280 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6282 (defconst org-property-re
6283 (org-re-property "\\S-+" 'literal t)
6284 "Regular expression matching a property line.
6285 There are four matching groups:
6286 1: :PROPKEY: including the leading and trailing colon,
6287 2: PROPKEY without the leading and trailing colon,
6288 3: PROPVAL without leading or trailing spaces,
6289 4: the indentation of the current line,
6290 5: trailing whitespace.")
6292 (defvar org-font-lock-hook nil
6293 "Functions to be called for special font lock stuff.")
6295 (defvar org-font-lock-set-keywords-hook nil
6296 "Functions that can manipulate `org-font-lock-extra-keywords'.
6297 This is called after `org-font-lock-extra-keywords' is defined, but before
6298 it is installed to be used by font lock. This can be useful if something
6299 needs to be inserted at a specific position in the font-lock sequence.")
6301 (defun org-font-lock-hook (limit)
6302 "Run `org-font-lock-hook' within LIMIT."
6303 (run-hook-with-args 'org-font-lock-hook limit))
6305 (defun org-set-font-lock-defaults ()
6306 "Set font lock defaults for the current buffer."
6307 (let* ((em org-fontify-emphasized-text)
6308 (lk org-highlight-links)
6309 (org-font-lock-extra-keywords
6310 (list
6311 ;; Call the hook
6312 '(org-font-lock-hook)
6313 ;; Headlines
6314 `(,(if org-fontify-whole-heading-line
6315 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6316 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6317 (1 (org-get-level-face 1))
6318 (2 (org-get-level-face 2))
6319 (3 (org-get-level-face 3)))
6320 ;; Table lines
6321 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6322 (1 'org-table t))
6323 ;; Table internals
6324 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6325 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6326 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6327 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6328 ;; Drawers
6329 '(org-fontify-drawers)
6330 ;; Properties
6331 (list org-property-re
6332 '(1 'org-special-keyword t)
6333 '(3 'org-property-value t))
6334 ;; Links
6335 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6336 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6337 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6338 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6339 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6340 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6341 (if (memq 'footnote lk) '(org-activate-footnote-links))
6342 ;; Targets.
6343 (list org-any-target-regexp '(0 'org-target t))
6344 ;; Diary sexps.
6345 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6346 ;; Macro
6347 '(org-fontify-macros)
6348 '(org-hide-wide-columns (0 nil append))
6349 ;; TODO keyword
6350 (list (format org-heading-keyword-regexp-format
6351 org-todo-regexp)
6352 '(2 (org-get-todo-face 2) t))
6353 ;; DONE
6354 (if org-fontify-done-headline
6355 (list (format org-heading-keyword-regexp-format
6356 (concat
6357 "\\(?:"
6358 (mapconcat 'regexp-quote org-done-keywords "\\|")
6359 "\\)"))
6360 '(2 'org-headline-done t))
6361 nil)
6362 ;; Priorities
6363 '(org-font-lock-add-priority-faces)
6364 ;; Tags
6365 '(org-font-lock-add-tag-faces)
6366 ;; Tags groups
6367 (if (and org-group-tags org-tag-groups-alist)
6368 (list (concat org-outline-regexp-bol ".+\\(:"
6369 (regexp-opt (mapcar 'car org-tag-groups-alist))
6370 ":\\).*$")
6371 '(1 'org-tag-group prepend)))
6372 ;; Special keywords
6373 (list (concat "\\<" org-comment-string) '(0 'org-special-keyword t))
6374 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6375 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6376 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6377 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6378 ;; Emphasis
6379 (if em
6380 (if (featurep 'xemacs)
6381 '(org-do-emphasis-faces (0 nil append))
6382 '(org-do-emphasis-faces)))
6383 ;; Checkboxes
6384 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6385 1 'org-checkbox prepend)
6386 (if (cdr (assq 'checkbox org-list-automatic-rules))
6387 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6388 (0 (org-get-checkbox-statistics-face) t)))
6389 ;; Description list items
6390 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6391 1 'org-list-dt prepend)
6392 ;; ARCHIVEd headings
6393 (list (concat
6394 org-outline-regexp-bol
6395 "\\(.*:" org-archive-tag ":.*\\)")
6396 '(1 'org-archived prepend))
6397 ;; Specials
6398 '(org-do-latex-and-related)
6399 '(org-fontify-entities)
6400 '(org-raise-scripts)
6401 ;; Code
6402 '(org-activate-code (1 'org-code t))
6403 ;; COMMENT
6404 (list (format
6405 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6406 org-todo-regexp
6407 org-comment-string)
6408 '(9 'org-special-keyword t))
6409 ;; Blocks and meta lines
6410 '(org-fontify-meta-lines-and-blocks))))
6411 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6412 (run-hooks 'org-font-lock-set-keywords-hook)
6413 ;; Now set the full font-lock-keywords
6414 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6415 (org-set-local 'font-lock-defaults
6416 '(org-font-lock-keywords t nil nil backward-paragraph))
6417 (kill-local-variable 'font-lock-keywords) nil))
6419 (defun org-toggle-pretty-entities ()
6420 "Toggle the composition display of entities as UTF8 characters."
6421 (interactive)
6422 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6423 (org-restart-font-lock)
6424 (if org-pretty-entities
6425 (message "Entities are now displayed as UTF8 characters")
6426 (save-restriction
6427 (widen)
6428 (org-decompose-region (point-min) (point-max))
6429 (message "Entities are now displayed as plain text"))))
6431 (defvar org-custom-properties-overlays nil
6432 "List of overlays used for custom properties.")
6433 (make-variable-buffer-local 'org-custom-properties-overlays)
6435 (defun org-toggle-custom-properties-visibility ()
6436 "Display or hide properties in `org-custom-properties'."
6437 (interactive)
6438 (if org-custom-properties-overlays
6439 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6440 (setq org-custom-properties-overlays nil))
6441 (when org-custom-properties
6442 (org-with-wide-buffer
6443 (goto-char (point-min))
6444 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6445 (while (re-search-forward regexp nil t)
6446 (let ((end (cdr (save-match-data (org-get-property-block)))))
6447 (when (and end (< (point) end))
6448 ;; Hide first custom property in current drawer.
6449 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6450 (overlay-put o 'invisible t)
6451 (overlay-put o 'org-custom-property t)
6452 (push o org-custom-properties-overlays))
6453 ;; Hide additional custom properties in the same drawer.
6454 (while (re-search-forward regexp end t)
6455 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6456 (overlay-put o 'invisible t)
6457 (overlay-put o 'org-custom-property t)
6458 (push o org-custom-properties-overlays)))))
6459 ;; Each entry is limited to a single property drawer.
6460 (outline-next-heading)))))))
6462 (defun org-fontify-entities (limit)
6463 "Find an entity to fontify."
6464 (let (ee)
6465 (when org-pretty-entities
6466 (catch 'match
6467 ;; "\_ "-family is left out on purpose. Only the first one,
6468 ;; i.e., "\_ ", could be fontified anyway, and it would be
6469 ;; confusing when adding a second white space character.
6470 (while (re-search-forward
6471 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6472 limit t)
6473 (if (and (not (org-at-comment-p))
6474 (setq ee (org-entity-get (match-string 1)))
6475 (= (length (nth 6 ee)) 1))
6476 (let*
6477 ((end (if (equal (match-string 2) "{}")
6478 (match-end 2)
6479 (match-end 1))))
6480 (add-text-properties
6481 (match-beginning 0) end
6482 (list 'font-lock-fontified t))
6483 (compose-region (match-beginning 0) end
6484 (nth 6 ee) nil)
6485 (backward-char 1)
6486 (throw 'match t))))
6487 nil))))
6489 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6490 "Fontify string S like in Org-mode."
6491 (with-temp-buffer
6492 (insert s)
6493 (let ((org-odd-levels-only odd-levels))
6494 (org-mode)
6495 (font-lock-ensure)
6496 (buffer-string))))
6498 (defvar org-m nil)
6499 (defvar org-l nil)
6500 (defvar org-f nil)
6501 (defun org-get-level-face (n)
6502 "Get the right face for match N in font-lock matching of headlines."
6503 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6504 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6505 (if org-cycle-level-faces
6506 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6507 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6508 (cond
6509 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6510 ((eq n 2) org-f)
6511 (t (if org-level-color-stars-only nil org-f))))
6514 (defun org-get-todo-face (kwd)
6515 "Get the right face for a TODO keyword KWD.
6516 If KWD is a number, get the corresponding match group."
6517 (if (numberp kwd) (setq kwd (match-string kwd)))
6518 (or (org-face-from-face-or-color
6519 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6520 (and (member kwd org-done-keywords) 'org-done)
6521 'org-todo))
6523 (defun org-face-from-face-or-color (context inherit face-or-color)
6524 "Create a face list that inherits INHERIT, but sets the foreground color.
6525 When FACE-OR-COLOR is not a string, just return it."
6526 (if (stringp face-or-color)
6527 (list :inherit inherit
6528 (cdr (assoc context org-faces-easy-properties))
6529 face-or-color)
6530 face-or-color))
6532 (defun org-font-lock-add-tag-faces (limit)
6533 "Add the special tag faces."
6534 (when (and org-tag-faces org-tags-special-faces-re)
6535 (while (re-search-forward org-tags-special-faces-re limit t)
6536 (add-text-properties (match-beginning 1) (match-end 1)
6537 (list 'face (org-get-tag-face 1)
6538 'font-lock-fontified t))
6539 (backward-char 1))))
6541 (defun org-font-lock-add-priority-faces (limit)
6542 "Add the special priority faces."
6543 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6544 (when (save-match-data (org-at-heading-p))
6545 (add-text-properties
6546 (match-beginning 0) (match-end 0)
6547 (list 'face (or (org-face-from-face-or-color
6548 'priority 'org-priority
6549 (cdr (assoc (char-after (match-beginning 1))
6550 org-priority-faces)))
6551 'org-priority)
6552 'font-lock-fontified t)))))
6554 (defun org-get-tag-face (kwd)
6555 "Get the right face for a TODO keyword KWD.
6556 If KWD is a number, get the corresponding match group."
6557 (if (numberp kwd) (setq kwd (match-string kwd)))
6558 (or (org-face-from-face-or-color
6559 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6560 'org-tag))
6562 (defun org-unfontify-region (beg end &optional maybe_loudly)
6563 "Remove fontification and activation overlays from links."
6564 (font-lock-default-unfontify-region beg end)
6565 (let* ((buffer-undo-list t)
6566 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6567 (inhibit-modification-hooks t)
6568 deactivate-mark buffer-file-name buffer-file-truename)
6569 (org-decompose-region beg end)
6570 (remove-text-properties beg end
6571 '(mouse-face t keymap t org-linked-text t
6572 invisible t intangible t
6573 org-emphasis t))
6574 (org-remove-font-lock-display-properties beg end)))
6576 (defconst org-script-display '(((raise -0.3) (height 0.7))
6577 ((raise 0.3) (height 0.7))
6578 ((raise -0.5))
6579 ((raise 0.5)))
6580 "Display properties for showing superscripts and subscripts.")
6582 (defun org-remove-font-lock-display-properties (beg end)
6583 "Remove specific display properties that have been added by font lock.
6584 The will remove the raise properties that are used to show superscripts
6585 and subscripts."
6586 (let (next prop)
6587 (while (< beg end)
6588 (setq next (next-single-property-change beg 'display nil end)
6589 prop (get-text-property beg 'display))
6590 (if (member prop org-script-display)
6591 (put-text-property beg next 'display nil))
6592 (setq beg next))))
6594 (defun org-raise-scripts (limit)
6595 "Add raise properties to sub/superscripts."
6596 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6597 (if (re-search-forward
6598 (if (eq org-use-sub-superscripts t)
6599 org-match-substring-regexp
6600 org-match-substring-with-braces-regexp)
6601 limit t)
6602 (let* ((pos (point)) table-p comment-p
6603 (mpos (match-beginning 3))
6604 (emph-p (get-text-property mpos 'org-emphasis))
6605 (link-p (get-text-property mpos 'mouse-face))
6606 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6607 (goto-char (point-at-bol))
6608 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6609 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6610 (goto-char pos)
6611 ;; Handle a_b^c
6612 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6613 (if (or comment-p emph-p link-p keyw-p)
6615 (put-text-property (match-beginning 3) (match-end 0)
6616 'display
6617 (if (equal (char-after (match-beginning 2)) ?^)
6618 (nth (if table-p 3 1) org-script-display)
6619 (nth (if table-p 2 0) org-script-display)))
6620 (add-text-properties (match-beginning 2) (match-end 2)
6621 (list 'invisible t
6622 'org-dwidth t 'org-dwidth-n 1))
6623 (if (and (eq (char-after (match-beginning 3)) ?{)
6624 (eq (char-before (match-end 3)) ?}))
6625 (progn
6626 (add-text-properties
6627 (match-beginning 3) (1+ (match-beginning 3))
6628 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6629 (add-text-properties
6630 (1- (match-end 3)) (match-end 3)
6631 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6632 t)))))
6634 ;;;; Visibility cycling, including org-goto and indirect buffer
6636 ;;; Cycling
6638 (defvar org-cycle-global-status nil)
6639 (make-variable-buffer-local 'org-cycle-global-status)
6640 (put 'org-cycle-global-status 'org-state t)
6641 (defvar org-cycle-subtree-status nil)
6642 (make-variable-buffer-local 'org-cycle-subtree-status)
6643 (put 'org-cycle-subtree-status 'org-state t)
6645 (defvar org-inlinetask-min-level)
6647 (defun org-unlogged-message (&rest args)
6648 "Display a message, but avoid logging it in the *Messages* buffer."
6649 (let ((message-log-max nil))
6650 (apply 'message args)))
6652 ;;;###autoload
6653 (defun org-cycle (&optional arg)
6654 "TAB-action and visibility cycling for Org-mode.
6656 This is the command invoked in Org-mode by the TAB key. Its main purpose
6657 is outline visibility cycling, but it also invokes other actions
6658 in special contexts.
6660 - When this function is called with a prefix argument, rotate the entire
6661 buffer through 3 states (global cycling)
6662 1. OVERVIEW: Show only top-level headlines.
6663 2. CONTENTS: Show all headlines of all levels, but no body text.
6664 3. SHOW ALL: Show everything.
6665 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6666 determined by the variable `org-startup-folded', and by any VISIBILITY
6667 properties in the buffer.
6668 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6669 including any drawers.
6671 - When inside a table, re-align the table and move to the next field.
6673 - When point is at the beginning of a headline, rotate the subtree started
6674 by this line through 3 different states (local cycling)
6675 1. FOLDED: Only the main headline is shown.
6676 2. CHILDREN: The main headline and the direct children are shown.
6677 From this state, you can move to one of the children
6678 and zoom in further.
6679 3. SUBTREE: Show the entire subtree, including body text.
6680 If there is no subtree, switch directly from CHILDREN to FOLDED.
6682 - When point is at the beginning of an empty headline and the variable
6683 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6684 of the headline by demoting and promoting it to likely levels. This
6685 speeds up creation document structure by pressing TAB once or several
6686 times right after creating a new headline.
6688 - When there is a numeric prefix, go up to a heading with level ARG, do
6689 a `show-subtree' and return to the previous cursor position. If ARG
6690 is negative, go up that many levels.
6692 - When point is not at the beginning of a headline, execute the global
6693 binding for TAB, which is re-indenting the line. See the option
6694 `org-cycle-emulate-tab' for details.
6696 - Special case: if point is at the beginning of the buffer and there is
6697 no headline in line 1, this function will act as if called with prefix arg
6698 (C-u TAB, same as S-TAB) also when called without prefix arg.
6699 But only if also the variable `org-cycle-global-at-bob' is t."
6700 (interactive "P")
6701 (org-load-modules-maybe)
6702 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6703 (and org-cycle-level-after-item/entry-creation
6704 (or (org-cycle-level)
6705 (org-cycle-item-indentation))))
6706 (let* ((limit-level
6707 (or org-cycle-max-level
6708 (and (boundp 'org-inlinetask-min-level)
6709 org-inlinetask-min-level
6710 (1- org-inlinetask-min-level))))
6711 (nstars (and limit-level
6712 (if org-odd-levels-only
6713 (and limit-level (1- (* limit-level 2)))
6714 limit-level)))
6715 (org-outline-regexp
6716 (if (not (derived-mode-p 'org-mode))
6717 outline-regexp
6718 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6719 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6720 (not (looking-at org-outline-regexp))))
6721 (org-cycle-hook
6722 (if bob-special
6723 (delq 'org-optimize-window-after-visibility-change
6724 (copy-sequence org-cycle-hook))
6725 org-cycle-hook))
6726 (pos (point)))
6728 (if (or bob-special (equal arg '(4)))
6729 ;; special case: use global cycling
6730 (setq arg t))
6732 (cond
6734 ((equal arg '(16))
6735 (setq last-command 'dummy)
6736 (org-set-startup-visibility)
6737 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6739 ((equal arg '(64))
6740 (show-all)
6741 (org-unlogged-message "Entire buffer visible, including drawers"))
6743 ;; Try cdlatex TAB completion
6744 ((org-try-cdlatex-tab))
6746 ;; Table: enter it or move to the next field.
6747 ((org-at-table-p 'any)
6748 (if (org-at-table.el-p)
6749 (message "Use C-c ' to edit table.el tables")
6750 (if arg (org-table-edit-field t)
6751 (org-table-justify-field-maybe)
6752 (call-interactively 'org-table-next-field))))
6754 ((run-hook-with-args-until-success
6755 'org-tab-after-check-for-table-hook))
6757 ;; Global cycling: delegate to `org-cycle-internal-global'.
6758 ((eq arg t) (org-cycle-internal-global))
6760 ;; Drawers: delegate to `org-flag-drawer'.
6761 ((save-excursion
6762 (beginning-of-line 1)
6763 (looking-at org-drawer-regexp))
6764 (org-flag-drawer ; toggle block visibility
6765 (not (get-char-property (match-end 0) 'invisible))))
6767 ;; Show-subtree, ARG levels up from here.
6768 ((integerp arg)
6769 (save-excursion
6770 (org-back-to-heading)
6771 (outline-up-heading (if (< arg 0) (- arg)
6772 (- (funcall outline-level) arg)))
6773 (org-show-subtree)))
6775 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6776 ((and (featurep 'org-inlinetask)
6777 (org-inlinetask-at-task-p)
6778 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6779 (org-inlinetask-toggle-visibility))
6781 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6782 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6783 (save-excursion (beginning-of-line 1)
6784 (looking-at org-outline-regexp)))
6785 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6786 (org-cycle-internal-local))
6788 ;; From there: TAB emulation and template completion.
6789 (buffer-read-only (org-back-to-heading))
6791 ((run-hook-with-args-until-success
6792 'org-tab-after-check-for-cycling-hook))
6794 ((org-try-structure-completion))
6796 ((run-hook-with-args-until-success
6797 'org-tab-before-tab-emulation-hook))
6799 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6800 (or (not (bolp))
6801 (not (looking-at org-outline-regexp))))
6802 (call-interactively (global-key-binding "\t")))
6804 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6805 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6806 (or (and (eq org-cycle-emulate-tab 'white)
6807 (= (match-end 0) (point-at-eol)))
6808 (and (eq org-cycle-emulate-tab 'whitestart)
6809 (>= (match-end 0) pos))))
6811 (eq org-cycle-emulate-tab t))
6812 (call-interactively (global-key-binding "\t")))
6814 (t (save-excursion
6815 (org-back-to-heading)
6816 (org-cycle)))))))
6818 (defun org-cycle-internal-global ()
6819 "Do the global cycling action."
6820 ;; Hack to avoid display of messages for .org attachments in Gnus
6821 (let ((ga (string-match "\\*fontification" (buffer-name))))
6822 (cond
6823 ((and (eq last-command this-command)
6824 (eq org-cycle-global-status 'overview))
6825 ;; We just created the overview - now do table of contents
6826 ;; This can be slow in very large buffers, so indicate action
6827 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6828 (unless ga (org-unlogged-message "CONTENTS..."))
6829 (org-content)
6830 (unless ga (org-unlogged-message "CONTENTS...done"))
6831 (setq org-cycle-global-status 'contents)
6832 (run-hook-with-args 'org-cycle-hook 'contents))
6834 ((and (eq last-command this-command)
6835 (eq org-cycle-global-status 'contents))
6836 ;; We just showed the table of contents - now show everything
6837 (run-hook-with-args 'org-pre-cycle-hook 'all)
6838 (show-all)
6839 (unless ga (org-unlogged-message "SHOW ALL"))
6840 (setq org-cycle-global-status 'all)
6841 (run-hook-with-args 'org-cycle-hook 'all))
6844 ;; Default action: go to overview
6845 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6846 (org-overview)
6847 (unless ga (org-unlogged-message "OVERVIEW"))
6848 (setq org-cycle-global-status 'overview)
6849 (run-hook-with-args 'org-cycle-hook 'overview)))))
6851 (defvar org-called-with-limited-levels nil
6852 "Non-nil when `org-with-limited-levels' is currently active.")
6854 (defun org-cycle-internal-local ()
6855 "Do the local cycling action."
6856 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6857 ;; First, determine end of headline (EOH), end of subtree or item
6858 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6859 (save-excursion
6860 (if (org-at-item-p)
6861 (progn
6862 (beginning-of-line)
6863 (setq struct (org-list-struct))
6864 (setq eoh (point-at-eol))
6865 (setq eos (org-list-get-item-end-before-blank (point) struct))
6866 (setq has-children (org-list-has-child-p (point) struct)))
6867 (org-back-to-heading)
6868 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6869 (setq eos (save-excursion (org-end-of-subtree t t)
6870 (when (bolp) (backward-char)) (point)))
6871 (setq has-children
6872 (or (save-excursion
6873 (let ((level (funcall outline-level)))
6874 (outline-next-heading)
6875 (and (org-at-heading-p t)
6876 (> (funcall outline-level) level))))
6877 (save-excursion
6878 (org-list-search-forward (org-item-beginning-re) eos t)))))
6879 ;; Determine end invisible part of buffer (EOL)
6880 (beginning-of-line 2)
6881 ;; XEmacs doesn't have `next-single-char-property-change'
6882 (if (featurep 'xemacs)
6883 (while (and (not (eobp)) ;; this is like `next-line'
6884 (get-char-property (1- (point)) 'invisible))
6885 (beginning-of-line 2))
6886 (while (and (not (eobp)) ;; this is like `next-line'
6887 (get-char-property (1- (point)) 'invisible))
6888 (goto-char (next-single-char-property-change (point) 'invisible))
6889 (and (eolp) (beginning-of-line 2))))
6890 (setq eol (point)))
6891 ;; Find out what to do next and set `this-command'
6892 (cond
6893 ((= eos eoh)
6894 ;; Nothing is hidden behind this heading
6895 (unless (org-before-first-heading-p)
6896 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6897 (org-unlogged-message "EMPTY ENTRY")
6898 (setq org-cycle-subtree-status nil)
6899 (save-excursion
6900 (goto-char eos)
6901 (outline-next-heading)
6902 (if (outline-invisible-p) (org-flag-heading nil))))
6903 ((and (or (>= eol eos)
6904 (not (string-match "\\S-" (buffer-substring eol eos))))
6905 (or has-children
6906 (not (setq children-skipped
6907 org-cycle-skip-children-state-if-no-children))))
6908 ;; Entire subtree is hidden in one line: children view
6909 (unless (org-before-first-heading-p)
6910 (run-hook-with-args 'org-pre-cycle-hook 'children))
6911 (if (org-at-item-p)
6912 (org-list-set-item-visibility (point-at-bol) struct 'children)
6913 (org-show-entry)
6914 (org-with-limited-levels (show-children))
6915 ;; FIXME: This slows down the func way too much.
6916 ;; How keep drawers hidden in subtree anyway?
6917 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6918 ;; (org-cycle-hide-drawers 'subtree))
6920 ;; Fold every list in subtree to top-level items.
6921 (when (eq org-cycle-include-plain-lists 'integrate)
6922 (save-excursion
6923 (org-back-to-heading)
6924 (while (org-list-search-forward (org-item-beginning-re) eos t)
6925 (beginning-of-line 1)
6926 (let* ((struct (org-list-struct))
6927 (prevs (org-list-prevs-alist struct))
6928 (end (org-list-get-bottom-point struct)))
6929 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6930 (org-list-get-all-items (point) struct prevs))
6931 (goto-char (if (< end eos) end eos)))))))
6932 (org-unlogged-message "CHILDREN")
6933 (save-excursion
6934 (goto-char eos)
6935 (outline-next-heading)
6936 (if (outline-invisible-p) (org-flag-heading nil)))
6937 (setq org-cycle-subtree-status 'children)
6938 (unless (org-before-first-heading-p)
6939 (run-hook-with-args 'org-cycle-hook 'children)))
6940 ((or children-skipped
6941 (and (eq last-command this-command)
6942 (eq org-cycle-subtree-status 'children)))
6943 ;; We just showed the children, or no children are there,
6944 ;; now show everything.
6945 (unless (org-before-first-heading-p)
6946 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6947 (outline-flag-region eoh eos nil)
6948 (org-unlogged-message
6949 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6950 (setq org-cycle-subtree-status 'subtree)
6951 (unless (org-before-first-heading-p)
6952 (run-hook-with-args 'org-cycle-hook 'subtree)))
6954 ;; Default action: hide the subtree.
6955 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6956 (outline-flag-region eoh eos t)
6957 (org-unlogged-message "FOLDED")
6958 (setq org-cycle-subtree-status 'folded)
6959 (unless (org-before-first-heading-p)
6960 (run-hook-with-args 'org-cycle-hook 'folded))))))
6962 ;;;###autoload
6963 (defun org-global-cycle (&optional arg)
6964 "Cycle the global visibility. For details see `org-cycle'.
6965 With \\[universal-argument] prefix arg, switch to startup visibility.
6966 With a numeric prefix, show all headlines up to that level."
6967 (interactive "P")
6968 (let ((org-cycle-include-plain-lists
6969 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6970 (cond
6971 ((integerp arg)
6972 (show-all)
6973 (hide-sublevels arg)
6974 (setq org-cycle-global-status 'contents))
6975 ((equal arg '(4))
6976 (org-set-startup-visibility)
6977 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6979 (org-cycle '(4))))))
6981 (defun org-set-startup-visibility ()
6982 "Set the visibility required by startup options and properties."
6983 (cond
6984 ((eq org-startup-folded t)
6985 (org-overview))
6986 ((eq org-startup-folded 'content)
6987 (org-content))
6988 ((or (eq org-startup-folded 'showeverything)
6989 (eq org-startup-folded nil))
6990 (show-all)))
6991 (unless (eq org-startup-folded 'showeverything)
6992 (if org-hide-block-startup (org-hide-block-all))
6993 (org-set-visibility-according-to-property 'no-cleanup)
6994 (org-cycle-hide-archived-subtrees 'all)
6995 (org-cycle-hide-drawers 'all)
6996 (org-cycle-show-empty-lines t)))
6998 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6999 "Switch subtree visibilities according to :VISIBILITY: property."
7000 (interactive)
7001 (let (org-show-entry-below)
7002 (org-with-wide-buffer
7003 (goto-char (point-min))
7004 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
7005 (if (not (org-at-property-p)) (outline-next-heading)
7006 (let ((state (match-string 3)))
7007 (save-excursion
7008 (org-back-to-heading t)
7009 (hide-subtree)
7010 (org-reveal)
7011 (cond
7012 ((equal state "folded")
7013 (hide-subtree))
7014 ((equal state "children")
7015 (org-show-hidden-entry)
7016 (show-children))
7017 ((equal state "content")
7018 (save-excursion
7019 (save-restriction
7020 (org-narrow-to-subtree)
7021 (org-content))))
7022 ((member state '("all" "showall"))
7023 (show-subtree)))))))
7024 (unless no-cleanup
7025 (org-cycle-hide-archived-subtrees 'all)
7026 (org-cycle-hide-drawers 'all)
7027 (org-cycle-show-empty-lines 'all)))))
7029 ;; This function uses outline-regexp instead of the more fundamental
7030 ;; org-outline-regexp so that org-cycle-global works outside of Org
7031 ;; buffers, where outline-regexp is needed.
7032 (defun org-overview ()
7033 "Switch to overview mode, showing only top-level headlines.
7034 This shows all headlines with a level equal or greater than the level
7035 of the first headline in the buffer. This is important, because if the
7036 first headline is not level one, then (hide-sublevels 1) gives confusing
7037 results."
7038 (interactive)
7039 (save-excursion
7040 (let ((level
7041 (save-excursion
7042 (goto-char (point-min))
7043 (if (re-search-forward (concat "^" outline-regexp) nil t)
7044 (progn
7045 (goto-char (match-beginning 0))
7046 (funcall outline-level))))))
7047 (and level (hide-sublevels level)))))
7049 (defun org-content (&optional arg)
7050 "Show all headlines in the buffer, like a table of contents.
7051 With numerical argument N, show content up to level N."
7052 (interactive "P")
7053 (org-overview)
7054 (save-excursion
7055 ;; Visit all headings and show their offspring
7056 (and (integerp arg) (org-overview))
7057 (goto-char (point-max))
7058 (catch 'exit
7059 (while (and (progn (condition-case nil
7060 (outline-previous-visible-heading 1)
7061 (error (goto-char (point-min))))
7063 (looking-at org-outline-regexp))
7064 (if (integerp arg)
7065 (show-children (1- arg))
7066 (show-branches))
7067 (if (bobp) (throw 'exit nil))))))
7069 (defun org-optimize-window-after-visibility-change (state)
7070 "Adjust the window after a change in outline visibility.
7071 This function is the default value of the hook `org-cycle-hook'."
7072 (when (get-buffer-window (current-buffer))
7073 (cond
7074 ((eq state 'content) nil)
7075 ((eq state 'all) nil)
7076 ((eq state 'folded) nil)
7077 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7078 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7080 (defun org-remove-empty-overlays-at (pos)
7081 "Remove outline overlays that do not contain non-white stuff."
7082 (mapc
7083 (lambda (o)
7084 (and (eq 'outline (overlay-get o 'invisible))
7085 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7086 (overlay-end o))))
7087 (delete-overlay o)))
7088 (overlays-at pos)))
7090 (defun org-clean-visibility-after-subtree-move ()
7091 "Fix visibility issues after moving a subtree."
7092 ;; First, find a reasonable region to look at:
7093 ;; Start two siblings above, end three below
7094 (let* ((beg (save-excursion
7095 (and (org-get-last-sibling)
7096 (org-get-last-sibling))
7097 (point)))
7098 (end (save-excursion
7099 (and (org-get-next-sibling)
7100 (org-get-next-sibling)
7101 (org-get-next-sibling))
7102 (if (org-at-heading-p)
7103 (point-at-eol)
7104 (point))))
7105 (level (looking-at "\\*+"))
7106 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7107 (save-excursion
7108 (save-restriction
7109 (narrow-to-region beg end)
7110 (when re
7111 ;; Properly fold already folded siblings
7112 (goto-char (point-min))
7113 (while (re-search-forward re nil t)
7114 (if (and (not (outline-invisible-p))
7115 (save-excursion
7116 (goto-char (point-at-eol)) (outline-invisible-p)))
7117 (hide-entry))))
7118 (org-cycle-show-empty-lines 'overview)
7119 (org-cycle-hide-drawers 'overview)))))
7121 (defun org-cycle-show-empty-lines (state)
7122 "Show empty lines above all visible headlines.
7123 The region to be covered depends on STATE when called through
7124 `org-cycle-hook'. Lisp program can use t for STATE to get the
7125 entire buffer covered. Note that an empty line is only shown if there
7126 are at least `org-cycle-separator-lines' empty lines before the headline."
7127 (when (not (= org-cycle-separator-lines 0))
7128 (save-excursion
7129 (let* ((n (abs org-cycle-separator-lines))
7130 (re (cond
7131 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7132 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7133 (t (let ((ns (number-to-string (- n 2))))
7134 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7135 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7136 beg end b e)
7137 (cond
7138 ((memq state '(overview contents t))
7139 (setq beg (point-min) end (point-max)))
7140 ((memq state '(children folded))
7141 (setq beg (point) end (progn (org-end-of-subtree t t)
7142 (beginning-of-line 2)
7143 (point)))))
7144 (when beg
7145 (goto-char beg)
7146 (while (re-search-forward re end t)
7147 (unless (get-char-property (match-end 1) 'invisible)
7148 (setq e (match-end 1))
7149 (if (< org-cycle-separator-lines 0)
7150 (setq b (save-excursion
7151 (goto-char (match-beginning 0))
7152 (org-back-over-empty-lines)
7153 (if (save-excursion
7154 (goto-char (max (point-min) (1- (point))))
7155 (org-at-heading-p))
7156 (1- (point))
7157 (point))))
7158 (setq b (match-beginning 1)))
7159 (outline-flag-region b e nil)))))))
7160 ;; Never hide empty lines at the end of the file.
7161 (save-excursion
7162 (goto-char (point-max))
7163 (outline-previous-heading)
7164 (outline-end-of-heading)
7165 (if (and (looking-at "[ \t\n]+")
7166 (= (match-end 0) (point-max)))
7167 (outline-flag-region (point) (match-end 0) nil))))
7169 (defun org-show-empty-lines-in-parent ()
7170 "Move to the parent and re-show empty lines before visible headlines."
7171 (save-excursion
7172 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7173 (org-cycle-show-empty-lines context))))
7175 (defun org-files-list ()
7176 "Return `org-agenda-files' list, plus all open org-mode files.
7177 This is useful for operations that need to scan all of a user's
7178 open and agenda-wise Org files."
7179 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7180 (dolist (buf (buffer-list))
7181 (with-current-buffer buf
7182 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7183 (let ((file (expand-file-name (buffer-file-name))))
7184 (unless (member file files)
7185 (push file files))))))
7186 files))
7188 (defsubst org-entry-beginning-position ()
7189 "Return the beginning position of the current entry."
7190 (save-excursion (outline-back-to-heading t) (point)))
7192 (defsubst org-entry-end-position ()
7193 "Return the end position of the current entry."
7194 (save-excursion (outline-next-heading) (point)))
7196 (defun org-cycle-hide-drawers (state &optional exceptions)
7197 "Re-hide all drawers after a visibility state change.
7198 When non-nil, optional argument EXCEPTIONS is a list of strings
7199 specifying which drawers should not be hidden."
7200 (when (and (derived-mode-p 'org-mode)
7201 (not (memq state '(overview folded contents))))
7202 (save-excursion
7203 (let* ((globalp (memq state '(contents all)))
7204 (beg (if globalp (point-min) (point)))
7205 (end (if globalp (point-max)
7206 (if (eq state 'children)
7207 (save-excursion (outline-next-heading) (point))
7208 (org-end-of-subtree t)))))
7209 (goto-char beg)
7210 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7211 (unless (member-ignore-case (match-string 1) exceptions)
7212 (let ((drawer (org-element-at-point)))
7213 (when (memq (org-element-type drawer) '(drawer property-drawer))
7214 (org-flag-drawer t drawer)
7215 ;; Make sure to skip drawer entirely or we might flag
7216 ;; it another time when matching its ending line with
7217 ;; `org-drawer-regexp'.
7218 (goto-char (org-element-property :end drawer))))))))))
7220 (defun org-cycle-hide-inline-tasks (state)
7221 "Re-hide inline tasks when switching to 'contents or 'children
7222 visibility state."
7223 (case state
7224 (contents
7225 (when (org-bound-and-true-p org-inlinetask-min-level)
7226 (hide-sublevels (1- org-inlinetask-min-level))))
7227 (children
7228 (when (featurep 'org-inlinetask)
7229 (save-excursion
7230 (while (and (outline-next-heading)
7231 (org-inlinetask-at-task-p))
7232 (org-inlinetask-toggle-visibility)
7233 (org-inlinetask-goto-end)))))))
7235 (defun org-flag-drawer (flag &optional element)
7236 "When FLAG is non-nil, hide the drawer we are at.
7237 Otherwise make it visible. When optional argument ELEMENT is
7238 a parsed drawer, as returned by `org-element-at-point', hide or
7239 show that drawer instead."
7240 (when (save-excursion
7241 (beginning-of-line)
7242 (org-looking-at-p org-drawer-regexp))
7243 (let ((drawer (or element (org-element-at-point))))
7244 (when (memq (org-element-type drawer) '(drawer property-drawer))
7245 (let ((post (org-element-property :post-affiliated drawer)))
7246 (save-excursion
7247 (outline-flag-region
7248 (progn (goto-char post) (line-end-position))
7249 (progn (goto-char (org-element-property :end drawer))
7250 (skip-chars-backward " \r\t\n")
7251 (line-end-position))
7252 flag))
7253 ;; When the drawer is hidden away, make sure point lies in
7254 ;; a visible part of the buffer.
7255 (when (and flag (> (line-beginning-position) post))
7256 (goto-char post)))))))
7258 (defun org-subtree-end-visible-p ()
7259 "Is the end of the current subtree visible?"
7260 (pos-visible-in-window-p
7261 (save-excursion (org-end-of-subtree t) (point))))
7263 (defun org-first-headline-recenter ()
7264 "Move cursor to the first headline and recenter the headline."
7265 (goto-char (point-min))
7266 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7267 (set-window-start (selected-window) (point-at-bol))))
7269 ;;; Saving and restoring visibility
7271 (defun org-outline-overlay-data (&optional use-markers)
7272 "Return a list of the locations of all outline overlays.
7273 These are overlays with the `invisible' property value `outline'.
7274 The return value is a list of cons cells, with start and stop
7275 positions for each overlay.
7276 If USE-MARKERS is set, return the positions as markers."
7277 (let (beg end)
7278 (save-excursion
7279 (save-restriction
7280 (widen)
7281 (delq nil
7282 (mapcar (lambda (o)
7283 (when (eq (overlay-get o 'invisible) 'outline)
7284 (setq beg (overlay-start o)
7285 end (overlay-end o))
7286 (and beg end (> end beg)
7287 (if use-markers
7288 (cons (copy-marker beg)
7289 (copy-marker end t))
7290 (cons beg end)))))
7291 (overlays-in (point-min) (point-max))))))))
7293 (defun org-set-outline-overlay-data (data)
7294 "Create visibility overlays for all positions in DATA.
7295 DATA should have been made by `org-outline-overlay-data'."
7296 (let (o)
7297 (save-excursion
7298 (save-restriction
7299 (widen)
7300 (show-all)
7301 (mapc (lambda (c)
7302 (outline-flag-region (car c) (cdr c) t))
7303 data)))))
7305 ;;; Folding of blocks
7307 (defvar org-hide-block-overlays nil
7308 "Overlays hiding blocks.")
7309 (make-variable-buffer-local 'org-hide-block-overlays)
7311 (defun org-block-map (function &optional start end)
7312 "Call FUNCTION at the head of all source blocks in the current buffer.
7313 Optional arguments START and END can be used to limit the range."
7314 (let ((start (or start (point-min)))
7315 (end (or end (point-max))))
7316 (save-excursion
7317 (goto-char start)
7318 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7319 (save-excursion
7320 (save-match-data
7321 (goto-char (match-beginning 0))
7322 (funcall function)))))))
7324 (defun org-hide-block-toggle-all ()
7325 "Toggle the visibility of all blocks in the current buffer."
7326 (org-block-map 'org-hide-block-toggle))
7328 (defun org-hide-block-all ()
7329 "Fold all blocks in the current buffer."
7330 (interactive)
7331 (org-show-block-all)
7332 (org-block-map 'org-hide-block-toggle-maybe))
7334 (defun org-show-block-all ()
7335 "Unfold all blocks in the current buffer."
7336 (interactive)
7337 (mapc 'delete-overlay org-hide-block-overlays)
7338 (setq org-hide-block-overlays nil))
7340 (defun org-hide-block-toggle-maybe ()
7341 "Toggle visibility of block at point.
7342 Unlike to `org-hide-block-toggle', this function does not throw
7343 an error. Return a non-nil value when toggling is successful."
7344 (interactive)
7345 (ignore-errors (org-hide-block-toggle)))
7347 (defun org-hide-block-toggle (&optional force)
7348 "Toggle the visibility of the current block.
7349 When optional argument FORCE is `off', make block visible. If it
7350 is non-nil, hide it unconditionally. Throw an error when not at
7351 a block. Return a non-nil value when toggling is successful."
7352 (interactive)
7353 (let ((element (org-element-at-point)))
7354 (unless (memq (org-element-type element)
7355 '(center-block comment-block dynamic-block example-block
7356 export-block quote-block special-block
7357 src-block verse-block))
7358 (user-error "Not at a block"))
7359 (let* ((start (save-excursion
7360 (goto-char (org-element-property :post-affiliated element))
7361 (line-end-position)))
7362 (end (save-excursion
7363 (goto-char (org-element-property :end element))
7364 (skip-chars-backward " \r\t\n")
7365 (line-end-position)))
7366 (overlays (overlays-at start)))
7367 (cond
7368 ;; Do nothing when not before or at the block opening line or
7369 ;; at the block closing line.
7370 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7371 ((and (not (eq force 'off))
7372 (not (memq t (mapcar
7373 (lambda (o)
7374 (eq (overlay-get o 'invisible) 'org-hide-block))
7375 overlays))))
7376 (let ((ov (make-overlay start end)))
7377 (overlay-put ov 'invisible 'org-hide-block)
7378 ;; Make the block accessible to `isearch'.
7379 (overlay-put
7380 ov 'isearch-open-invisible
7381 (lambda (ov)
7382 (when (memq ov org-hide-block-overlays)
7383 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7384 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7385 (delete-overlay ov))))
7386 (push ov org-hide-block-overlays)
7387 ;; When the block is hidden away, make sure point is left in
7388 ;; a visible part of the buffer.
7389 (when (> (line-beginning-position) start)
7390 (goto-char start)
7391 (beginning-of-line))
7392 ;; Signal successful toggling.
7394 ((or (not force) (eq force 'off))
7395 (dolist (ov overlays t)
7396 (when (memq ov org-hide-block-overlays)
7397 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7398 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7399 (delete-overlay ov))))))))
7401 ;; org-tab-after-check-for-cycling-hook
7402 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7403 ;; Remove overlays when changing major mode
7404 (add-hook 'org-mode-hook
7405 (lambda () (org-add-hook 'change-major-mode-hook
7406 'org-show-block-all 'append 'local)))
7408 ;;; Org-goto
7410 (defvar org-goto-window-configuration nil)
7411 (defvar org-goto-marker nil)
7412 (defvar org-goto-map)
7413 (defun org-goto-map ()
7414 "Set the keymap `org-goto'."
7415 (setq org-goto-map
7416 (let ((map (make-sparse-keymap)))
7417 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7418 mouse-drag-region universal-argument org-occur))
7419 cmd)
7420 (while (setq cmd (pop cmds))
7421 (substitute-key-definition cmd cmd map global-map)))
7422 (suppress-keymap map)
7423 (org-defkey map "\C-m" 'org-goto-ret)
7424 (org-defkey map [(return)] 'org-goto-ret)
7425 (org-defkey map [(left)] 'org-goto-left)
7426 (org-defkey map [(right)] 'org-goto-right)
7427 (org-defkey map [(control ?g)] 'org-goto-quit)
7428 (org-defkey map "\C-i" 'org-cycle)
7429 (org-defkey map [(tab)] 'org-cycle)
7430 (org-defkey map [(down)] 'outline-next-visible-heading)
7431 (org-defkey map [(up)] 'outline-previous-visible-heading)
7432 (if org-goto-auto-isearch
7433 (if (fboundp 'define-key-after)
7434 (define-key-after map [t] 'org-goto-local-auto-isearch)
7435 nil)
7436 (org-defkey map "q" 'org-goto-quit)
7437 (org-defkey map "n" 'outline-next-visible-heading)
7438 (org-defkey map "p" 'outline-previous-visible-heading)
7439 (org-defkey map "f" 'outline-forward-same-level)
7440 (org-defkey map "b" 'outline-backward-same-level)
7441 (org-defkey map "u" 'outline-up-heading))
7442 (org-defkey map "/" 'org-occur)
7443 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7444 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7445 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7446 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7447 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7448 map)))
7450 (defconst org-goto-help
7451 "Browse buffer copy, to find location or copy text.%s
7452 RET=jump to location C-g=quit and return to previous location
7453 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7455 (defvar org-goto-start-pos) ; dynamically scoped parameter
7457 (defun org-goto (&optional alternative-interface)
7458 "Look up a different location in the current file, keeping current visibility.
7460 When you want look-up or go to a different location in a
7461 document, the fastest way is often to fold the entire buffer and
7462 then dive into the tree. This method has the disadvantage, that
7463 the previous location will be folded, which may not be what you
7464 want.
7466 This command works around this by showing a copy of the current
7467 buffer in an indirect buffer, in overview mode. You can dive
7468 into the tree in that copy, use org-occur and incremental search
7469 to find a location. When pressing RET or `Q', the command
7470 returns to the original buffer in which the visibility is still
7471 unchanged. After RET it will also jump to the location selected
7472 in the indirect buffer and expose the headline hierarchy above.
7474 With a prefix argument, use the alternative interface: e.g. if
7475 `org-goto-interface' is 'outline use 'outline-path-completion."
7476 (interactive "P")
7477 (org-goto-map)
7478 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7479 (org-refile-use-outline-path t)
7480 (org-refile-target-verify-function nil)
7481 (interface
7482 (if (not alternative-interface)
7483 org-goto-interface
7484 (if (eq org-goto-interface 'outline)
7485 'outline-path-completion
7486 'outline)))
7487 (org-goto-start-pos (point))
7488 (selected-point
7489 (if (eq interface 'outline)
7490 (car (org-get-location (current-buffer) org-goto-help))
7491 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7492 (org-refile-check-position pa)
7493 (nth 3 pa)))))
7494 (if selected-point
7495 (progn
7496 (org-mark-ring-push org-goto-start-pos)
7497 (goto-char selected-point)
7498 (if (or (outline-invisible-p) (org-invisible-p2))
7499 (org-show-context 'org-goto)))
7500 (message "Quit"))))
7502 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7503 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7504 (defvar org-goto-local-auto-isearch-map) ; defined below
7506 (defun org-get-location (buf help)
7507 "Let the user select a location in the Org-mode buffer BUF.
7508 This function uses a recursive edit. It returns the selected position
7509 or nil."
7510 (org-no-popups
7511 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7512 (isearch-hide-immediately nil)
7513 (isearch-search-fun-function
7514 (lambda () 'org-goto-local-search-headings))
7515 (org-goto-selected-point org-goto-exit-command))
7516 (save-excursion
7517 (save-window-excursion
7518 (delete-other-windows)
7519 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7520 (org-pop-to-buffer-same-window
7521 (condition-case nil
7522 (make-indirect-buffer (current-buffer) "*org-goto*")
7523 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7524 (with-output-to-temp-buffer "*Org Help*"
7525 (princ (format help (if org-goto-auto-isearch
7526 " Just type for auto-isearch."
7527 " n/p/f/b/u to navigate, q to quit."))))
7528 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7529 (setq buffer-read-only nil)
7530 (let ((org-startup-truncated t)
7531 (org-startup-folded nil)
7532 (org-startup-align-all-tables nil))
7533 (org-mode)
7534 (org-overview))
7535 (setq buffer-read-only t)
7536 (if (and (boundp 'org-goto-start-pos)
7537 (integer-or-marker-p org-goto-start-pos))
7538 (progn (goto-char org-goto-start-pos)
7539 (when (outline-invisible-p)
7540 (org-show-set-visibility 'lineage)))
7541 (goto-char (point-min)))
7542 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7543 (message "Select location and press RET")
7544 (use-local-map org-goto-map)
7545 (recursive-edit)))
7546 (kill-buffer "*org-goto*")
7547 (cons org-goto-selected-point org-goto-exit-command))))
7549 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7550 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7551 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7552 (if (fboundp 'isearch-other-control-char)
7553 (progn
7554 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7555 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7556 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7557 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7558 (define-key org-goto-local-auto-isearch-map [return] nil))
7560 (defun org-goto-local-search-headings (string bound noerror)
7561 "Search and make sure that any matches are in headlines."
7562 (catch 'return
7563 (while (if isearch-forward
7564 (search-forward string bound noerror)
7565 (search-backward string bound noerror))
7566 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7567 (and (member :headline context)
7568 (not (member :tags context))))
7569 (throw 'return (point))))))
7571 (defun org-goto-local-auto-isearch ()
7572 "Start isearch."
7573 (interactive)
7574 (goto-char (point-min))
7575 (let ((keys (this-command-keys)))
7576 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7577 (isearch-mode t)
7578 (isearch-process-search-char (string-to-char keys)))))
7580 (defun org-goto-ret (&optional arg)
7581 "Finish `org-goto' by going to the new location."
7582 (interactive "P")
7583 (setq org-goto-selected-point (point)
7584 org-goto-exit-command 'return)
7585 (throw 'exit nil))
7587 (defun org-goto-left ()
7588 "Finish `org-goto' by going to the new location."
7589 (interactive)
7590 (if (org-at-heading-p)
7591 (progn
7592 (beginning-of-line 1)
7593 (setq org-goto-selected-point (point)
7594 org-goto-exit-command 'left)
7595 (throw 'exit nil))
7596 (user-error "Not on a heading")))
7598 (defun org-goto-right ()
7599 "Finish `org-goto' by going to the new location."
7600 (interactive)
7601 (if (org-at-heading-p)
7602 (progn
7603 (setq org-goto-selected-point (point)
7604 org-goto-exit-command 'right)
7605 (throw 'exit nil))
7606 (user-error "Not on a heading")))
7608 (defun org-goto-quit ()
7609 "Finish `org-goto' without cursor motion."
7610 (interactive)
7611 (setq org-goto-selected-point nil)
7612 (setq org-goto-exit-command 'quit)
7613 (throw 'exit nil))
7615 ;;; Indirect buffer display of subtrees
7617 (defvar org-indirect-dedicated-frame nil
7618 "This is the frame being used for indirect tree display.")
7619 (defvar org-last-indirect-buffer nil)
7621 (defun org-tree-to-indirect-buffer (&optional arg)
7622 "Create indirect buffer and narrow it to current subtree.
7623 With a numerical prefix ARG, go up to this level and then take that tree.
7624 If ARG is negative, go up that many levels.
7626 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7627 indirect buffer previously made with this command, to avoid proliferation of
7628 indirect buffers. However, when you call the command with a \
7629 \\[universal-argument] prefix, or
7630 when `org-indirect-buffer-display' is `new-frame', the last buffer
7631 is kept so that you can work with several indirect buffers at the same time.
7632 If `org-indirect-buffer-display' is `dedicated-frame', the \
7633 \\[universal-argument] prefix also
7634 requests that a new frame be made for the new buffer, so that the dedicated
7635 frame is not changed."
7636 (interactive "P")
7637 (let ((cbuf (current-buffer))
7638 (cwin (selected-window))
7639 (pos (point))
7640 beg end level heading ibuf)
7641 (save-excursion
7642 (org-back-to-heading t)
7643 (when (numberp arg)
7644 (setq level (org-outline-level))
7645 (if (< arg 0) (setq arg (+ level arg)))
7646 (while (> (setq level (org-outline-level)) arg)
7647 (org-up-heading-safe)))
7648 (setq beg (point)
7649 heading (org-get-heading))
7650 (org-end-of-subtree t t)
7651 (if (org-at-heading-p) (backward-char 1))
7652 (setq end (point)))
7653 (if (and (buffer-live-p org-last-indirect-buffer)
7654 (not (eq org-indirect-buffer-display 'new-frame))
7655 (not arg))
7656 (kill-buffer org-last-indirect-buffer))
7657 (setq ibuf (org-get-indirect-buffer cbuf heading)
7658 org-last-indirect-buffer ibuf)
7659 (cond
7660 ((or (eq org-indirect-buffer-display 'new-frame)
7661 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7662 (select-frame (make-frame))
7663 (delete-other-windows)
7664 (org-pop-to-buffer-same-window ibuf)
7665 (org-set-frame-title heading))
7666 ((eq org-indirect-buffer-display 'dedicated-frame)
7667 (raise-frame
7668 (select-frame (or (and org-indirect-dedicated-frame
7669 (frame-live-p org-indirect-dedicated-frame)
7670 org-indirect-dedicated-frame)
7671 (setq org-indirect-dedicated-frame (make-frame)))))
7672 (delete-other-windows)
7673 (org-pop-to-buffer-same-window ibuf)
7674 (org-set-frame-title (concat "Indirect: " heading)))
7675 ((eq org-indirect-buffer-display 'current-window)
7676 (org-pop-to-buffer-same-window ibuf))
7677 ((eq org-indirect-buffer-display 'other-window)
7678 (pop-to-buffer ibuf))
7679 (t (error "Invalid value")))
7680 (if (featurep 'xemacs)
7681 (save-excursion (org-mode) (turn-on-font-lock)))
7682 (narrow-to-region beg end)
7683 (show-all)
7684 (goto-char pos)
7685 (run-hook-with-args 'org-cycle-hook 'all)
7686 (and (window-live-p cwin) (select-window cwin))))
7688 (defun org-get-indirect-buffer (&optional buffer heading)
7689 (setq buffer (or buffer (current-buffer)))
7690 (let ((n 1) (base (buffer-name buffer)) bname)
7691 (while (buffer-live-p
7692 (get-buffer
7693 (setq bname
7694 (concat base "-"
7695 (if heading (concat heading "-" (number-to-string n))
7696 (number-to-string n))))))
7697 (setq n (1+ n)))
7698 (condition-case nil
7699 (make-indirect-buffer buffer bname 'clone)
7700 (error (make-indirect-buffer buffer bname)))))
7702 (defun org-set-frame-title (title)
7703 "Set the title of the current frame to the string TITLE."
7704 ;; FIXME: how to name a single frame in XEmacs???
7705 (unless (featurep 'xemacs)
7706 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7708 ;;;; Structure editing
7710 ;;; Inserting headlines
7712 (defun org-previous-line-empty-p (&optional next)
7713 "Is the previous line a blank line?
7714 When NEXT is non-nil, check the next line instead."
7715 (save-excursion
7716 (and (not (bobp))
7717 (or (beginning-of-line (if next 2 0)) t)
7718 (save-match-data
7719 (looking-at "[ \t]*$")))))
7721 (defun org-insert-heading (&optional arg invisible-ok top-level)
7722 "Insert a new heading or an item with the same depth at point.
7724 If point is at the beginning of a heading or a list item, insert
7725 a new heading or a new item above the current one. If point is
7726 at the beginning of a normal line, turn the line into a heading.
7728 If point is in the middle of a headline or a list item, split the
7729 headline or the item and create a new headline/item with the text
7730 in the current line after point \(see `org-M-RET-may-split-line'
7731 on how to modify this behavior).
7733 With one universal prefix argument, set the user option
7734 `org-insert-heading-respect-content' to t for the duration of
7735 the command. This modifies the behavior described above in this
7736 ways: on list items and at the beginning of normal lines, force
7737 the insertion of a heading after the current subtree.
7739 With two universal prefix arguments, insert the heading at the
7740 end of the grandparent subtree. For example, if point is within
7741 a 2nd-level heading, then it will insert a 2nd-level heading at
7742 the end of the 1st-level parent heading.
7744 If point is at the beginning of a headline, insert a sibling
7745 before the current headline. If point is not at the beginning,
7746 split the line and create a new headline with the text in the
7747 current line after point \(see `org-M-RET-may-split-line' on how
7748 to modify this behavior).
7750 If point is at the beginning of a normal line, turn this line
7751 into a heading.
7753 When INVISIBLE-OK is set, stop at invisible headlines when going
7754 back. This is important for non-interactive uses of the
7755 command.
7757 When optional argument TOP-LEVEL is non-nil, insert a level 1
7758 heading, unconditionally."
7759 (interactive "P")
7760 (if (org-called-interactively-p 'any) (org-reveal))
7761 (let ((itemp (and (not top-level) (org-in-item-p)))
7762 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7763 (respect-content (or org-insert-heading-respect-content
7764 (equal arg '(4))))
7765 (initial-content "")
7766 (adjust-empty-lines t))
7768 (cond
7770 ((or (= (buffer-size) 0)
7771 (and (not (save-excursion
7772 (and (ignore-errors (org-back-to-heading invisible-ok))
7773 (org-at-heading-p))))
7774 (or arg (not itemp))))
7775 ;; At beginning of buffer or so high up that only a heading
7776 ;; makes sense.
7777 (cond ((and (bolp) (not respect-content)) (insert "* "))
7778 ((not respect-content)
7779 (unless may-split (end-of-line))
7780 (insert "\n* "))
7781 ((re-search-forward org-outline-regexp-bol nil t)
7782 (beginning-of-line)
7783 (insert "* \n")
7784 (backward-char))
7785 (t (goto-char (point-max))
7786 (insert "\n* ")))
7787 (run-hooks 'org-insert-heading-hook))
7789 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7792 ;; Maybe move at the end of the subtree
7793 (when (equal arg '(16))
7794 (org-up-heading-safe)
7795 (org-end-of-subtree t))
7796 ;; Insert a heading
7797 (save-restriction
7798 (widen)
7799 (let* ((level nil)
7800 (on-heading (org-at-heading-p))
7801 (empty-line-p (if on-heading
7802 (org-previous-line-empty-p)
7803 ;; We will decide later
7804 nil))
7805 ;; Get a level string to fall back on.
7806 (fix-level
7807 (if (org-before-first-heading-p) "*"
7808 (save-excursion
7809 (org-back-to-heading t)
7810 (if (org-previous-line-empty-p) (setq empty-line-p t))
7811 (looking-at org-outline-regexp)
7812 (make-string (1- (length (match-string 0))) ?*))))
7813 (stars
7814 (save-excursion
7815 (condition-case nil
7816 (if top-level "* "
7817 (org-back-to-heading invisible-ok)
7818 (when (and (not on-heading)
7819 (featurep 'org-inlinetask)
7820 (integerp org-inlinetask-min-level)
7821 (>= (length (match-string 0))
7822 org-inlinetask-min-level))
7823 ;; Find a heading level before the inline
7824 ;; task.
7825 (while (and (setq level (org-up-heading-safe))
7826 (>= level org-inlinetask-min-level)))
7827 (if (org-at-heading-p)
7828 (org-back-to-heading invisible-ok)
7829 (error "This should not happen")))
7830 (unless (and (save-excursion
7831 (save-match-data
7832 (org-backward-heading-same-level
7833 1 invisible-ok))
7834 (= (point) (match-beginning 0)))
7835 (not (org-previous-line-empty-p t)))
7836 (setq empty-line-p (or empty-line-p
7837 (org-previous-line-empty-p))))
7838 (match-string 0))
7839 (error (or fix-level "* ")))))
7840 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7841 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7842 pos hide-previous previous-pos)
7844 ;; If we insert after content, move there and clean up
7845 ;; whitespace.
7846 (when (and respect-content
7847 (not (org-looking-at-p org-outline-regexp-bol)))
7848 (if (not (org-before-first-heading-p))
7849 (org-end-of-subtree nil t)
7850 (re-search-forward org-outline-regexp-bol)
7851 (beginning-of-line 0))
7852 (skip-chars-backward " \r\t\n")
7853 (and (not (looking-back "^\\*+"))
7854 (looking-at "[ \t]+") (replace-match ""))
7855 (unless (eobp) (forward-char 1))
7856 (when (looking-at "^\\*")
7857 (unless (bobp) (backward-char 1))
7858 (insert "\n")))
7860 ;; If we are splitting, grab the text that should be moved
7861 ;; to the new headline.
7862 (when may-split
7863 (if (org-on-heading-p)
7864 ;; This is a heading: split intelligently (keeping
7865 ;; tags).
7866 (let ((pos (point)))
7867 (beginning-of-line)
7868 (unless (looking-at org-complex-heading-regexp)
7869 (error "This should not happen"))
7870 (when (and (match-beginning 4)
7871 (> pos (match-beginning 4))
7872 (< pos (match-end 4)))
7873 (setq initial-content (buffer-substring pos (match-end 4)))
7874 (goto-char pos)
7875 (delete-region (point) (match-end 4))
7876 (if (looking-at "[ \t]*$")
7877 (replace-match "")
7878 (insert (make-string (length initial-content) ?\s)))
7879 (setq initial-content (org-trim initial-content)))
7880 (goto-char pos))
7881 ;; A normal line.
7882 (setq initial-content
7883 (org-trim
7884 (delete-and-extract-region (point) (line-end-position))))))
7886 ;; If we are at the beginning of the line, insert before it.
7887 ;; Otherwise, after it.
7888 (cond
7889 ((and (bolp) (looking-at "[ \t]*$")))
7890 ((bolp) (open-line 1))
7891 (t (end-of-line)
7892 (insert "\n")))
7894 ;; Insert the new heading
7895 (insert stars)
7896 (just-one-space)
7897 (insert initial-content)
7898 (when (and adjust-empty-lines
7899 (not (and blank (org-previous-line-empty-p))))
7900 (org-N-empty-lines-before-current (if blank 1 0)))
7901 (run-hooks 'org-insert-heading-hook)))))))
7903 (defun org-N-empty-lines-before-current (N)
7904 "Make the number of empty lines before current exactly N.
7905 So this will delete or add empty lines."
7906 (save-excursion
7907 (beginning-of-line)
7908 (let ((p (point)))
7909 (skip-chars-backward " \r\t\n")
7910 (unless (bolp) (forward-line))
7911 (delete-region (point) p))
7912 (when (> N 0) (insert (make-string N ?\n)))))
7914 (defun org-get-heading (&optional no-tags no-todo)
7915 "Return the heading of the current entry, without the stars.
7916 When NO-TAGS is non-nil, don't include tags.
7917 When NO-TODO is non-nil, don't include TODO keywords."
7918 (save-excursion
7919 (org-back-to-heading t)
7920 (cond
7921 ((and no-tags no-todo)
7922 (looking-at org-complex-heading-regexp)
7923 (match-string 4))
7924 (no-tags
7925 (looking-at (concat org-outline-regexp
7926 "\\(.*?\\)"
7927 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7928 (match-string 1))
7929 (no-todo
7930 (looking-at org-todo-line-regexp)
7931 (match-string 3))
7932 (t (looking-at org-heading-regexp)
7933 (match-string 2)))))
7935 (defvar orgstruct-mode) ; defined below
7937 (defun org-heading-components ()
7938 "Return the components of the current heading.
7939 This is a list with the following elements:
7940 - the level as an integer
7941 - the reduced level, different if `org-odd-levels-only' is set.
7942 - the TODO keyword, or nil
7943 - the priority character, like ?A, or nil if no priority is given
7944 - the headline text itself, or the tags string if no headline text
7945 - the tags string, or nil."
7946 (save-excursion
7947 (org-back-to-heading t)
7948 (if (let (case-fold-search)
7949 (looking-at
7950 (if orgstruct-mode
7951 org-heading-regexp
7952 org-complex-heading-regexp)))
7953 (if orgstruct-mode
7954 (list (length (match-string 1))
7955 (org-reduced-level (length (match-string 1)))
7958 (match-string 2)
7959 nil)
7960 (list (length (match-string 1))
7961 (org-reduced-level (length (match-string 1)))
7962 (org-match-string-no-properties 2)
7963 (and (match-end 3) (aref (match-string 3) 2))
7964 (org-match-string-no-properties 4)
7965 (org-match-string-no-properties 5))))))
7967 (defun org-get-entry ()
7968 "Get the entry text, after heading, entire subtree."
7969 (save-excursion
7970 (org-back-to-heading t)
7971 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7973 (defun org-insert-heading-after-current ()
7974 "Insert a new heading with same level as current, after current subtree."
7975 (interactive)
7976 (org-back-to-heading)
7977 (org-insert-heading)
7978 (org-move-subtree-down)
7979 (end-of-line 1))
7981 (defun org-insert-heading-respect-content (&optional invisible-ok)
7982 "Insert heading with `org-insert-heading-respect-content' set to t."
7983 (interactive)
7984 (org-insert-heading '(4) invisible-ok))
7986 (defun org-insert-todo-heading-respect-content (&optional force-state)
7987 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7988 (interactive)
7989 (org-insert-todo-heading force-state '(4)))
7991 (defun org-insert-todo-heading (arg &optional force-heading)
7992 "Insert a new heading with the same level and TODO state as current heading.
7993 If the heading has no TODO state, or if the state is DONE, use the first
7994 state (TODO by default). Also with one prefix arg, force first state. With
7995 two prefix args, force inserting at the end of the parent subtree."
7996 (interactive "P")
7997 (when (or force-heading (not (org-insert-item 'checkbox)))
7998 (org-insert-heading (or (and (equal arg '(16)) '(16))
7999 force-heading))
8000 (save-excursion
8001 (org-back-to-heading)
8002 (outline-previous-heading)
8003 (looking-at org-todo-line-regexp))
8004 (let*
8005 ((new-mark-x
8006 (if (or (equal arg '(4))
8007 (not (match-beginning 2))
8008 (member (match-string 2) org-done-keywords))
8009 (car org-todo-keywords-1)
8010 (match-string 2)))
8011 (new-mark
8013 (run-hook-with-args-until-success
8014 'org-todo-get-default-hook new-mark-x nil)
8015 new-mark-x)))
8016 (beginning-of-line 1)
8017 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8018 (if org-treat-insert-todo-heading-as-state-change
8019 (org-todo new-mark)
8020 (insert new-mark " "))))
8021 (when org-provide-todo-statistics
8022 (org-update-parent-todo-statistics))))
8024 (defun org-insert-subheading (arg)
8025 "Insert a new subheading and demote it.
8026 Works for outline headings and for plain lists alike."
8027 (interactive "P")
8028 (org-insert-heading arg)
8029 (cond
8030 ((org-at-heading-p) (org-do-demote))
8031 ((org-at-item-p) (org-indent-item))))
8033 (defun org-insert-todo-subheading (arg)
8034 "Insert a new subheading with TODO keyword or checkbox and demote it.
8035 Works for outline headings and for plain lists alike."
8036 (interactive "P")
8037 (org-insert-todo-heading arg)
8038 (cond
8039 ((org-at-heading-p) (org-do-demote))
8040 ((org-at-item-p) (org-indent-item))))
8042 ;;; Promotion and Demotion
8044 (defvar org-after-demote-entry-hook nil
8045 "Hook run after an entry has been demoted.
8046 The cursor will be at the beginning of the entry.
8047 When a subtree is being demoted, the hook will be called for each node.")
8049 (defvar org-after-promote-entry-hook nil
8050 "Hook run after an entry has been promoted.
8051 The cursor will be at the beginning of the entry.
8052 When a subtree is being promoted, the hook will be called for each node.")
8054 (defun org-promote-subtree ()
8055 "Promote the entire subtree.
8056 See also `org-promote'."
8057 (interactive)
8058 (save-excursion
8059 (org-with-limited-levels (org-map-tree 'org-promote)))
8060 (org-fix-position-after-promote))
8062 (defun org-demote-subtree ()
8063 "Demote the entire subtree. See `org-demote'.
8064 See also `org-promote'."
8065 (interactive)
8066 (save-excursion
8067 (org-with-limited-levels (org-map-tree 'org-demote)))
8068 (org-fix-position-after-promote))
8071 (defun org-do-promote ()
8072 "Promote the current heading higher up the tree.
8073 If the region is active in `transient-mark-mode', promote all headings
8074 in the region."
8075 (interactive)
8076 (save-excursion
8077 (if (org-region-active-p)
8078 (org-map-region 'org-promote (region-beginning) (region-end))
8079 (org-promote)))
8080 (org-fix-position-after-promote))
8082 (defun org-do-demote ()
8083 "Demote the current heading lower down the tree.
8084 If the region is active in `transient-mark-mode', demote all headings
8085 in the region."
8086 (interactive)
8087 (save-excursion
8088 (if (org-region-active-p)
8089 (org-map-region 'org-demote (region-beginning) (region-end))
8090 (org-demote)))
8091 (org-fix-position-after-promote))
8093 (defun org-fix-position-after-promote ()
8094 "Make sure that after pro/demotion cursor position is right."
8095 (let ((pos (point)))
8096 (when (save-excursion
8097 (beginning-of-line 1)
8098 (looking-at org-todo-line-regexp)
8099 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8100 (cond ((eobp) (insert " "))
8101 ((eolp) (insert " "))
8102 ((equal (char-after) ?\ ) (forward-char 1))))))
8104 (defun org-current-level ()
8105 "Return the level of the current entry, or nil if before the first headline.
8106 The level is the number of stars at the beginning of the
8107 headline. Use `org-reduced-level' to remove the effect of
8108 `org-odd-levels'. Unlike to `org-outline-level', this function
8109 ignores inlinetasks."
8110 (let ((level (org-with-limited-levels (org-outline-level))))
8111 (and (> level 0) level)))
8113 (defun org-get-previous-line-level ()
8114 "Return the outline depth of the last headline before the current line.
8115 Returns 0 for the first headline in the buffer, and nil if before the
8116 first headline."
8117 (and (org-current-level)
8118 (or (and (/= (line-beginning-position) (point-min))
8119 (save-excursion (beginning-of-line 0) (org-current-level)))
8120 0)))
8122 (defun org-reduced-level (l)
8123 "Compute the effective level of a heading.
8124 This takes into account the setting of `org-odd-levels-only'."
8125 (cond
8126 ((zerop l) 0)
8127 (org-odd-levels-only (1+ (floor (/ l 2))))
8128 (t l)))
8130 (defun org-level-increment ()
8131 "Return the number of stars that will be added or removed at a
8132 time to headlines when structure editing, based on the value of
8133 `org-odd-levels-only'."
8134 (if org-odd-levels-only 2 1))
8136 (defun org-get-valid-level (level &optional change)
8137 "Rectify a level change under the influence of `org-odd-levels-only'
8138 LEVEL is a current level, CHANGE is by how much the level should be
8139 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8140 even level numbers will become the next higher odd number."
8141 (if org-odd-levels-only
8142 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8143 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8144 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8145 (max 1 (+ level (or change 0)))))
8147 (if (boundp 'define-obsolete-function-alias)
8148 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8149 (define-obsolete-function-alias 'org-get-legal-level
8150 'org-get-valid-level)
8151 (define-obsolete-function-alias 'org-get-legal-level
8152 'org-get-valid-level "23.1")))
8154 (defun org-promote ()
8155 "Promote the current heading higher up the tree."
8156 (org-with-wide-buffer
8157 (org-back-to-heading t)
8158 (let* ((after-change-functions (remq 'flyspell-after-change-function
8159 after-change-functions))
8160 (level (save-match-data (funcall outline-level)))
8161 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8162 (diff (abs (- level (length up-head) -1))))
8163 (cond
8164 ((and (= level 1) org-allow-promoting-top-level-subtree)
8165 (replace-match "# " nil t))
8166 ((= level 1)
8167 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8168 (t (replace-match up-head nil t)))
8169 (unless (= level 1)
8170 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8171 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8172 (run-hooks 'org-after-promote-entry-hook))))
8174 (defun org-demote ()
8175 "Demote the current heading lower down the tree."
8176 (org-with-wide-buffer
8177 (org-back-to-heading t)
8178 (let* ((after-change-functions (remq 'flyspell-after-change-function
8179 after-change-functions))
8180 (level (save-match-data (funcall outline-level)))
8181 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8182 (diff (abs (- level (length down-head) -1))))
8183 (replace-match down-head nil t)
8184 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8185 (when org-adapt-indentation (org-fixup-indentation diff))
8186 (run-hooks 'org-after-demote-entry-hook))))
8188 (defun org-cycle-level ()
8189 "Cycle the level of an empty headline through possible states.
8190 This goes first to child, then to parent, level, then up the hierarchy.
8191 After top level, it switches back to sibling level."
8192 (interactive)
8193 (let ((org-adapt-indentation nil))
8194 (when (org-point-at-end-of-empty-headline)
8195 (setq this-command 'org-cycle-level) ; Only needed for caching
8196 (let ((cur-level (org-current-level))
8197 (prev-level (org-get-previous-line-level)))
8198 (cond
8199 ;; If first headline in file, promote to top-level.
8200 ((= prev-level 0)
8201 (loop repeat (/ (- cur-level 1) (org-level-increment))
8202 do (org-do-promote)))
8203 ;; If same level as prev, demote one.
8204 ((= prev-level cur-level)
8205 (org-do-demote))
8206 ;; If parent is top-level, promote to top level if not already.
8207 ((= prev-level 1)
8208 (loop repeat (/ (- cur-level 1) (org-level-increment))
8209 do (org-do-promote)))
8210 ;; If top-level, return to prev-level.
8211 ((= cur-level 1)
8212 (loop repeat (/ (- prev-level 1) (org-level-increment))
8213 do (org-do-demote)))
8214 ;; If less than prev-level, promote one.
8215 ((< cur-level prev-level)
8216 (org-do-promote))
8217 ;; If deeper than prev-level, promote until higher than
8218 ;; prev-level.
8219 ((> cur-level prev-level)
8220 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8221 do (org-do-promote))))
8222 t))))
8224 (defun org-map-tree (fun)
8225 "Call FUN for every heading underneath the current one."
8226 (org-back-to-heading)
8227 (let ((level (funcall outline-level)))
8228 (save-excursion
8229 (funcall fun)
8230 (while (and (progn
8231 (outline-next-heading)
8232 (> (funcall outline-level) level))
8233 (not (eobp)))
8234 (funcall fun)))))
8236 (defun org-map-region (fun beg end)
8237 "Call FUN for every heading between BEG and END."
8238 (let ((org-ignore-region t))
8239 (save-excursion
8240 (setq end (copy-marker end))
8241 (goto-char beg)
8242 (if (and (re-search-forward org-outline-regexp-bol nil t)
8243 (< (point) end))
8244 (funcall fun))
8245 (while (and (progn
8246 (outline-next-heading)
8247 (< (point) end))
8248 (not (eobp)))
8249 (funcall fun)))))
8251 (defun org-fixup-indentation (diff)
8252 "Change the indentation in the current entry by DIFF.
8254 DIFF is an integer. Indentation is done according to the
8255 following rules:
8257 - Planning information and property drawers are always indented
8258 according to the new level of the headline;
8260 - Footnote definitions and their contents are ignored;
8262 - Inlinetasks' boundaries are not shifted;
8264 - Empty lines are ignored;
8266 - Other lines' indentation are shifted by DIFF columns, unless
8267 it would introduce a structural change in the document, in
8268 which case no shifting is done at all.
8270 Assume point is at a heading or an inlinetask beginning."
8271 (org-with-wide-buffer
8272 (narrow-to-region (line-beginning-position)
8273 (save-excursion
8274 (if (org-with-limited-levels (org-at-heading-p))
8275 (org-with-limited-levels (outline-next-heading))
8276 (org-inlinetask-goto-end))
8277 (point)))
8278 (forward-line)
8279 ;; Indent properly planning info and property drawer.
8280 (when (org-looking-at-p org-planning-line-re)
8281 (org-indent-line)
8282 (forward-line))
8283 (when (looking-at org-property-drawer-re)
8284 (goto-char (match-end 0))
8285 (forward-line)
8286 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8287 (catch 'no-shift
8288 (when (zerop diff) (throw 'no-shift nil))
8289 ;; If DIFF is negative, first check if a shift is possible at all
8290 ;; (e.g., it doesn't break structure). This can only happen if
8291 ;; some contents are not properly indented.
8292 (let ((case-fold-search t))
8293 (when (< diff 0)
8294 (let ((diff (- diff))
8295 (forbidden-re (concat org-outline-regexp
8296 "\\|"
8297 (substring org-footnote-definition-re 1))))
8298 (save-excursion
8299 (while (not (eobp))
8300 (cond
8301 ((org-looking-at-p "[ \t]*$") (forward-line))
8302 ((and (org-looking-at-p org-footnote-definition-re)
8303 (let ((e (org-element-at-point)))
8304 (and (eq (org-element-type e) 'footnote-definition)
8305 (goto-char (org-element-property :end e))))))
8306 ((org-looking-at-p org-outline-regexp) (forward-line))
8307 ;; Give up if shifting would move before column 0 or
8308 ;; if it would introduce a headline or a footnote
8309 ;; definition.
8311 (skip-chars-forward " \t")
8312 (let ((ind (current-column)))
8313 (when (or (< ind diff)
8314 (and (= ind diff) (org-looking-at-p forbidden-re)))
8315 (throw 'no-shift nil)))
8316 ;; Ignore contents of example blocks and source
8317 ;; blocks if their indentation is meant to be
8318 ;; preserved. Jump to block's closing line.
8319 (beginning-of-line)
8320 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8321 (let ((e (org-element-at-point)))
8322 (and (memq (org-element-type e)
8323 '(example-block src-block))
8324 (or org-src-preserve-indentation
8325 (org-element-property :preserve-indent e))
8326 (goto-char (org-element-property :end e))
8327 (progn (skip-chars-backward " \r\t\n")
8328 (beginning-of-line)
8329 t))))
8330 (forward-line))))))))
8331 ;; Shift lines but footnote definitions, inlinetasks boundaries
8332 ;; by DIFF. Also skip contents of source or example blocks
8333 ;; when indentation is meant to be preserved.
8334 (while (not (eobp))
8335 (cond
8336 ((and (org-looking-at-p org-footnote-definition-re)
8337 (let ((e (org-element-at-point)))
8338 (and (eq (org-element-type e) 'footnote-definition)
8339 (goto-char (org-element-property :end e))))))
8340 ((org-looking-at-p org-outline-regexp) (forward-line))
8341 ((org-looking-at-p "[ \t]*$") (forward-line))
8343 (org-indent-line-to (+ (org-get-indentation) diff))
8344 (beginning-of-line)
8345 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8346 (let ((e (org-element-at-point)))
8347 (and (memq (org-element-type e)
8348 '(example-block src-block))
8349 (or org-src-preserve-indentation
8350 (org-element-property :preserve-indent e))
8351 (goto-char (org-element-property :end e))
8352 (progn (skip-chars-backward " \r\t\n")
8353 (beginning-of-line)
8354 t))))
8355 (forward-line)))))))))
8357 (defun org-convert-to-odd-levels ()
8358 "Convert an org-mode file with all levels allowed to one with odd levels.
8359 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8360 level 5 etc."
8361 (interactive)
8362 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8363 (let ((outline-level 'org-outline-level)
8364 (org-odd-levels-only nil) n)
8365 (save-excursion
8366 (goto-char (point-min))
8367 (while (re-search-forward "^\\*\\*+ " nil t)
8368 (setq n (- (length (match-string 0)) 2))
8369 (while (>= (setq n (1- n)) 0)
8370 (org-demote))
8371 (end-of-line 1))))))
8373 (defun org-convert-to-oddeven-levels ()
8374 "Convert an org-mode file with only odd levels to one with odd/even levels.
8375 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8376 file contains a section with an even level, conversion would
8377 destroy the structure of the file. An error is signaled in this
8378 case."
8379 (interactive)
8380 (goto-char (point-min))
8381 ;; First check if there are no even levels
8382 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8383 (org-show-set-visibility 'canonical)
8384 (error "Not all levels are odd in this file. Conversion not possible"))
8385 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8386 (let ((outline-regexp org-outline-regexp)
8387 (outline-level 'org-outline-level)
8388 (org-odd-levels-only nil) n)
8389 (save-excursion
8390 (goto-char (point-min))
8391 (while (re-search-forward "^\\*\\*+ " nil t)
8392 (setq n (/ (1- (length (match-string 0))) 2))
8393 (while (>= (setq n (1- n)) 0)
8394 (org-promote))
8395 (end-of-line 1))))))
8397 (defun org-tr-level (n)
8398 "Make N odd if required."
8399 (if org-odd-levels-only (1+ (/ n 2)) n))
8401 ;;; Vertical tree motion, cutting and pasting of subtrees
8403 (defun org-move-subtree-up (&optional arg)
8404 "Move the current subtree up past ARG headlines of the same level."
8405 (interactive "p")
8406 (org-move-subtree-down (- (prefix-numeric-value arg))))
8408 (defun org-move-subtree-down (&optional arg)
8409 "Move the current subtree down past ARG headlines of the same level."
8410 (interactive "p")
8411 (setq arg (prefix-numeric-value arg))
8412 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8413 'org-get-last-sibling))
8414 (ins-point (make-marker))
8415 (cnt (abs arg))
8416 (col (current-column))
8417 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8418 ;; Select the tree
8419 (org-back-to-heading)
8420 (setq beg0 (point))
8421 (save-excursion
8422 (setq ne-beg (org-back-over-empty-lines))
8423 (setq beg (point)))
8424 (save-match-data
8425 (save-excursion (outline-end-of-heading)
8426 (setq folded (outline-invisible-p)))
8427 (progn (org-end-of-subtree nil t)
8428 (unless (eobp) (backward-char))))
8429 (outline-next-heading)
8430 (setq ne-end (org-back-over-empty-lines))
8431 (setq end (point))
8432 (goto-char beg0)
8433 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8434 ;; include less whitespace
8435 (save-excursion
8436 (goto-char beg)
8437 (forward-line (- ne-beg ne-end))
8438 (setq beg (point))))
8439 ;; Find insertion point, with error handling
8440 (while (> cnt 0)
8441 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8442 (progn (goto-char beg0)
8443 (user-error "Cannot move past superior level or buffer limit")))
8444 (setq cnt (1- cnt)))
8445 (if (> arg 0)
8446 ;; Moving forward - still need to move over subtree
8447 (progn (org-end-of-subtree t t)
8448 (save-excursion
8449 (org-back-over-empty-lines)
8450 (or (bolp) (newline)))))
8451 (setq ne-ins (org-back-over-empty-lines))
8452 (move-marker ins-point (point))
8453 (setq txt (buffer-substring beg end))
8454 (org-save-markers-in-region beg end)
8455 (delete-region beg end)
8456 (org-remove-empty-overlays-at beg)
8457 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8458 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8459 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8460 (let ((bbb (point)))
8461 (insert-before-markers txt)
8462 (org-reinstall-markers-in-region bbb)
8463 (move-marker ins-point bbb))
8464 (or (bolp) (insert "\n"))
8465 (setq ins-end (point))
8466 (goto-char ins-point)
8467 (org-skip-whitespace)
8468 (when (and (< arg 0)
8469 (org-first-sibling-p)
8470 (> ne-ins ne-beg))
8471 ;; Move whitespace back to beginning
8472 (save-excursion
8473 (goto-char ins-end)
8474 (let ((kill-whole-line t))
8475 (kill-line (- ne-ins ne-beg)) (point)))
8476 (insert (make-string (- ne-ins ne-beg) ?\n)))
8477 (move-marker ins-point nil)
8478 (if folded
8479 (hide-subtree)
8480 (org-show-entry)
8481 (show-children)
8482 (org-cycle-hide-drawers 'children))
8483 (org-clean-visibility-after-subtree-move)
8484 ;; move back to the initial column we were at
8485 (move-to-column col)))
8487 (defvar org-subtree-clip ""
8488 "Clipboard for cut and paste of subtrees.
8489 This is actually only a copy of the kill, because we use the normal kill
8490 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8492 (defvar org-subtree-clip-folded nil
8493 "Was the last copied subtree folded?
8494 This is used to fold the tree back after pasting.")
8496 (defun org-cut-subtree (&optional n)
8497 "Cut the current subtree into the clipboard.
8498 With prefix arg N, cut this many sequential subtrees.
8499 This is a short-hand for marking the subtree and then cutting it."
8500 (interactive "p")
8501 (org-copy-subtree n 'cut))
8503 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8504 "Copy the current subtree it in the clipboard.
8505 With prefix arg N, copy this many sequential subtrees.
8506 This is a short-hand for marking the subtree and then copying it.
8507 If CUT is non-nil, actually cut the subtree.
8508 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8509 of some markers in the region, even if CUT is non-nil. This is
8510 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8511 (interactive "p")
8512 (let (beg end folded (beg0 (point)))
8513 (if (org-called-interactively-p 'any)
8514 (org-back-to-heading nil) ; take what looks like a subtree
8515 (org-back-to-heading t)) ; take what is really there
8516 (setq beg (point))
8517 (skip-chars-forward " \t\r\n")
8518 (save-match-data
8519 (if nosubtrees
8520 (outline-next-heading)
8521 (save-excursion (outline-end-of-heading)
8522 (setq folded (outline-invisible-p)))
8523 (ignore-errors (org-forward-heading-same-level (1- n) t))
8524 (org-end-of-subtree t t)))
8525 ;; Include the end of an inlinetask
8526 (when (and (featurep 'org-inlinetask)
8527 (looking-at-p (concat (org-inlinetask-outline-regexp)
8528 "END[ \t]*$")))
8529 (end-of-line))
8530 (setq end (point))
8531 (goto-char beg0)
8532 (when (> end beg)
8533 (setq org-subtree-clip-folded folded)
8534 (when (or cut force-store-markers)
8535 (org-save-markers-in-region beg end))
8536 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8537 (setq org-subtree-clip (current-kill 0))
8538 (message "%s: Subtree(s) with %d characters"
8539 (if cut "Cut" "Copied")
8540 (length org-subtree-clip)))))
8542 (defun org-paste-subtree (&optional level tree for-yank remove)
8543 "Paste the clipboard as a subtree, with modification of headline level.
8544 The entire subtree is promoted or demoted in order to match a new headline
8545 level.
8547 If the cursor is at the beginning of a headline, the same level as
8548 that headline is used to paste the tree.
8550 If not, the new level is derived from the *visible* headings
8551 before and after the insertion point, and taken to be the inferior headline
8552 level of the two. So if the previous visible heading is level 3 and the
8553 next is level 4 (or vice versa), level 4 will be used for insertion.
8554 This makes sure that the subtree remains an independent subtree and does
8555 not swallow low level entries.
8557 You can also force a different level, either by using a numeric prefix
8558 argument, or by inserting the heading marker by hand. For example, if the
8559 cursor is after \"*****\", then the tree will be shifted to level 5.
8561 If optional TREE is given, use this text instead of the kill ring.
8563 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8564 move back over whitespace before inserting, and move point to the end of
8565 the inserted text when done.
8567 When REMOVE is non-nil, remove the subtree from the clipboard."
8568 (interactive "P")
8569 (setq tree (or tree (and kill-ring (current-kill 0))))
8570 (unless (org-kill-is-subtree-p tree)
8571 (user-error "%s"
8572 (substitute-command-keys
8573 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8574 (org-with-limited-levels
8575 (let* ((visp (not (outline-invisible-p)))
8576 (txt tree)
8577 (^re_ "\\(\\*+\\)[ \t]*")
8578 (old-level (if (string-match org-outline-regexp-bol txt)
8579 (- (match-end 0) (match-beginning 0) 1)
8580 -1))
8581 (force-level (cond (level (prefix-numeric-value level))
8582 ((and (looking-at "[ \t]*$")
8583 (string-match
8584 "^\\*+$" (buffer-substring
8585 (point-at-bol) (point))))
8586 (- (match-end 0) (match-beginning 0)))
8587 ((and (bolp)
8588 (looking-at org-outline-regexp))
8589 (- (match-end 0) (point) 1))))
8590 (previous-level (save-excursion
8591 (condition-case nil
8592 (progn
8593 (outline-previous-visible-heading 1)
8594 (if (looking-at ^re_)
8595 (- (match-end 0) (match-beginning 0) 1)
8597 (error 1))))
8598 (next-level (save-excursion
8599 (condition-case nil
8600 (progn
8601 (or (looking-at org-outline-regexp)
8602 (outline-next-visible-heading 1))
8603 (if (looking-at ^re_)
8604 (- (match-end 0) (match-beginning 0) 1)
8606 (error 1))))
8607 (new-level (or force-level (max previous-level next-level)))
8608 (shift (if (or (= old-level -1)
8609 (= new-level -1)
8610 (= old-level new-level))
8612 (- new-level old-level)))
8613 (delta (if (> shift 0) -1 1))
8614 (func (if (> shift 0) 'org-demote 'org-promote))
8615 (org-odd-levels-only nil)
8616 beg end newend)
8617 ;; Remove the forced level indicator
8618 (if force-level
8619 (delete-region (point-at-bol) (point)))
8620 ;; Paste
8621 (beginning-of-line (if (bolp) 1 2))
8622 (setq beg (point))
8623 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8624 (insert-before-markers txt)
8625 (unless (string-match "\n\\'" txt) (insert "\n"))
8626 (setq newend (point))
8627 (org-reinstall-markers-in-region beg)
8628 (setq end (point))
8629 (goto-char beg)
8630 (skip-chars-forward " \t\n\r")
8631 (setq beg (point))
8632 (if (and (outline-invisible-p) visp)
8633 (save-excursion (outline-show-heading)))
8634 ;; Shift if necessary
8635 (unless (= shift 0)
8636 (save-restriction
8637 (narrow-to-region beg end)
8638 (while (not (= shift 0))
8639 (org-map-region func (point-min) (point-max))
8640 (setq shift (+ delta shift)))
8641 (goto-char (point-min))
8642 (setq newend (point-max))))
8643 (when (or (org-called-interactively-p 'interactive) for-yank)
8644 (message "Clipboard pasted as level %d subtree" new-level))
8645 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8646 kill-ring
8647 (eq org-subtree-clip (current-kill 0))
8648 org-subtree-clip-folded)
8649 ;; The tree was folded before it was killed/copied
8650 (hide-subtree))
8651 (and for-yank (goto-char newend))
8652 (and remove (setq kill-ring (cdr kill-ring))))))
8654 (defun org-kill-is-subtree-p (&optional txt)
8655 "Check if the current kill is an outline subtree, or a set of trees.
8656 Returns nil if kill does not start with a headline, or if the first
8657 headline level is not the largest headline level in the tree.
8658 So this will actually accept several entries of equal levels as well,
8659 which is OK for `org-paste-subtree'.
8660 If optional TXT is given, check this string instead of the current kill."
8661 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8662 (re (org-get-limited-outline-regexp))
8663 (^re (concat "^" re))
8664 (start-level (and kill
8665 (string-match
8666 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8667 kill)
8668 (- (match-end 2) (match-beginning 2) 1)))
8669 (start (1+ (or (match-beginning 2) -1))))
8670 (if (not start-level)
8671 (progn
8672 nil) ;; does not even start with a heading
8673 (catch 'exit
8674 (while (setq start (string-match ^re kill (1+ start)))
8675 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8676 (throw 'exit nil)))
8677 t))))
8679 (defvar org-markers-to-move nil
8680 "Markers that should be moved with a cut-and-paste operation.
8681 Those markers are stored together with their positions relative to
8682 the start of the region.")
8684 (defun org-save-markers-in-region (beg end)
8685 "Check markers in region.
8686 If these markers are between BEG and END, record their position relative
8687 to BEG, so that after moving the block of text, we can put the markers back
8688 into place.
8689 This function gets called just before an entry or tree gets cut from the
8690 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8691 called immediately, to move the markers with the entries."
8692 (setq org-markers-to-move nil)
8693 (when (featurep 'org-clock)
8694 (org-clock-save-markers-for-cut-and-paste beg end))
8695 (when (featurep 'org-agenda)
8696 (org-agenda-save-markers-for-cut-and-paste beg end)))
8698 (defun org-check-and-save-marker (marker beg end)
8699 "Check if MARKER is between BEG and END.
8700 If yes, remember the marker and the distance to BEG."
8701 (when (and (marker-buffer marker)
8702 (equal (marker-buffer marker) (current-buffer)))
8703 (if (and (>= marker beg) (< marker end))
8704 (push (cons marker (- marker beg)) org-markers-to-move))))
8706 (defun org-reinstall-markers-in-region (beg)
8707 "Move all remembered markers to their position relative to BEG."
8708 (mapc (lambda (x)
8709 (move-marker (car x) (+ beg (cdr x))))
8710 org-markers-to-move)
8711 (setq org-markers-to-move nil))
8713 (defun org-narrow-to-subtree ()
8714 "Narrow buffer to the current subtree."
8715 (interactive)
8716 (save-excursion
8717 (save-match-data
8718 (org-with-limited-levels
8719 (narrow-to-region
8720 (progn (org-back-to-heading t) (point))
8721 (progn (org-end-of-subtree t t)
8722 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8723 (point)))))))
8725 (defun org-narrow-to-block ()
8726 "Narrow buffer to the current block."
8727 (interactive)
8728 (let* ((case-fold-search t)
8729 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8730 "^[ \t]*#\\+end_.*")))
8731 (if blockp
8732 (narrow-to-region (car blockp) (cdr blockp))
8733 (user-error "Not in a block"))))
8735 (defun org-clone-subtree-with-time-shift (n &optional shift)
8736 "Clone the task (subtree) at point N times.
8737 The clones will be inserted as siblings.
8739 In interactive use, the user will be prompted for the number of
8740 clones to be produced. If the entry has a timestamp, the user
8741 will also be prompted for a time shift, which may be a repeater
8742 as used in time stamps, for example `+3d'. To disable this,
8743 you can call the function with a universal prefix argument.
8745 When a valid repeater is given and the entry contains any time
8746 stamps, the clones will become a sequence in time, with time
8747 stamps in the subtree shifted for each clone produced. If SHIFT
8748 is nil or the empty string, time stamps will be left alone. The
8749 ID property of the original subtree is removed.
8751 If the original subtree did contain time stamps with a repeater,
8752 the following will happen:
8753 - the repeater will be removed in each clone
8754 - an additional clone will be produced, with the current, unshifted
8755 date(s) in the entry.
8756 - the original entry will be placed *after* all the clones, with
8757 repeater intact.
8758 - the start days in the repeater in the original entry will be shifted
8759 to past the last clone.
8760 In this way you can spell out a number of instances of a repeating task,
8761 and still retain the repeater to cover future instances of the task."
8762 (interactive "nNumber of clones to produce: ")
8763 (let ((shift
8764 (or shift
8765 (if (and (not (equal current-prefix-arg '(4)))
8766 (save-excursion
8767 (re-search-forward org-ts-regexp-both
8768 (save-excursion
8769 (org-end-of-subtree t)
8770 (point)) t)))
8771 (read-from-minibuffer
8772 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8773 ""))) ;; No time shift
8774 (n-no-remove -1)
8775 (drawer-re org-drawer-regexp)
8776 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8777 beg end template task idprop
8778 shift-n shift-what doshift nmin nmax)
8779 (if (not (and (integerp n) (> n 0)))
8780 (user-error "Invalid number of replications %s" n))
8781 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8782 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8783 shift)))
8784 (user-error "Invalid shift specification %s" shift))
8785 (when doshift
8786 (setq shift-n (string-to-number (match-string 1 shift))
8787 shift-what (cdr (assoc (match-string 2 shift)
8788 '(("d" . day) ("w" . week)
8789 ("m" . month) ("y" . year))))))
8790 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8791 (setq nmin 1 nmax n)
8792 (org-back-to-heading t)
8793 (setq beg (point))
8794 (setq idprop (org-entry-get nil "ID"))
8795 (org-end-of-subtree t t)
8796 (or (bolp) (insert "\n"))
8797 (setq end (point))
8798 (setq template (buffer-substring beg end))
8799 (when (and doshift
8800 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8801 (delete-region beg end)
8802 (setq end beg)
8803 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8804 (goto-char end)
8805 (loop for n from nmin to nmax do
8806 ;; prepare clone
8807 (with-temp-buffer
8808 (insert template)
8809 (org-mode)
8810 (goto-char (point-min))
8811 (org-show-subtree)
8812 (and idprop (if org-clone-delete-id
8813 (org-entry-delete nil "ID")
8814 (org-id-get-create t)))
8815 (unless (= n 0)
8816 (while (re-search-forward org-clock-re nil t)
8817 (kill-whole-line))
8818 (goto-char (point-min))
8819 (while (re-search-forward drawer-re nil t)
8820 (org-remove-empty-drawer-at (point))))
8821 (goto-char (point-min))
8822 (when doshift
8823 (while (re-search-forward org-ts-regexp-both nil t)
8824 (org-timestamp-change (* n shift-n) shift-what))
8825 (unless (= n n-no-remove)
8826 (goto-char (point-min))
8827 (while (re-search-forward org-ts-regexp nil t)
8828 (save-excursion
8829 (goto-char (match-beginning 0))
8830 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8831 (delete-region (match-beginning 1) (match-end 1)))))))
8832 (setq task (buffer-string)))
8833 (insert task))
8834 (goto-char beg)))
8836 ;;; Outline Sorting
8838 (defun org-sort (with-case)
8839 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8840 Optional argument WITH-CASE means sort case-sensitively."
8841 (interactive "P")
8842 (cond
8843 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8844 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8846 (org-call-with-arg 'org-sort-entries with-case))))
8848 (defun org-sort-remove-invisible (s)
8849 "Remove invisible links from string S."
8850 (remove-text-properties 0 (length s) org-rm-props s)
8851 (while (string-match org-bracket-link-regexp s)
8852 (setq s (replace-match (if (match-end 2)
8853 (match-string 3 s)
8854 (match-string 1 s)) t t s)))
8855 (let ((st (format " %s " s)))
8856 (while (string-match org-emph-re st)
8857 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8858 (setq s (substring st 1 -1)))
8861 (defvar org-priority-regexp) ; defined later in the file
8863 (defvar org-after-sorting-entries-or-items-hook nil
8864 "Hook that is run after a bunch of entries or items have been sorted.
8865 When children are sorted, the cursor is in the parent line when this
8866 hook gets called. When a region or a plain list is sorted, the cursor
8867 will be in the first entry of the sorted region/list.")
8869 (defun org-sort-entries
8870 (&optional with-case sorting-type getkey-func compare-func property)
8871 "Sort entries on a certain level of an outline tree.
8872 If there is an active region, the entries in the region are sorted.
8873 Else, if the cursor is before the first entry, sort the top-level items.
8874 Else, the children of the entry at point are sorted.
8876 Sorting can be alphabetically, numerically, by date/time as given by
8877 a time stamp, by a property, by priority order, or by a custom function.
8879 The command prompts for the sorting type unless it has been given to the
8880 function through the SORTING-TYPE argument, which needs to be a character,
8881 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8882 the precise meaning of each character:
8884 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8885 c By creation time, which is assumed to be the first inactive time stamp
8886 at the beginning of a line.
8887 d By deadline date/time.
8888 k By clocking time.
8889 n Numerically, by converting the beginning of the entry/item to a number.
8890 o By order of TODO keywords.
8891 p By priority according to the cookie.
8892 r By the value of a property.
8893 s By scheduled date/time.
8894 t By date/time, either the first active time stamp in the entry, or, if
8895 none exist, by the first inactive one.
8897 Capital letters will reverse the sort order.
8899 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8900 called with point at the beginning of the record. It must return either
8901 a string or a number that should serve as the sorting key for that record.
8903 Comparing entries ignores case by default. However, with an optional argument
8904 WITH-CASE, the sorting considers case as well.
8906 Sorting is done against the visible part of the headlines, it ignores hidden
8907 links.
8909 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8910 (interactive "P")
8911 (let ((case-func (if with-case 'identity 'downcase))
8912 (cmstr
8913 ;; The clock marker is lost when using `sort-subr', let's
8914 ;; store the clocking string.
8915 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8916 (save-excursion
8917 (goto-char org-clock-marker)
8918 (looking-back "^.*") (match-string-no-properties 0))))
8919 start beg end stars re re2
8920 txt what tmp)
8921 ;; Find beginning and end of region to sort
8922 (cond
8923 ((org-region-active-p)
8924 ;; we will sort the region
8925 (setq end (region-end)
8926 what "region")
8927 (goto-char (region-beginning))
8928 (if (not (org-at-heading-p)) (outline-next-heading))
8929 (setq start (point)))
8930 ((or (org-at-heading-p)
8931 (ignore-errors (progn (org-back-to-heading) t)))
8932 ;; we will sort the children of the current headline
8933 (org-back-to-heading)
8934 (setq start (point)
8935 end (progn (org-end-of-subtree t t)
8936 (or (bolp) (insert "\n"))
8937 (when (>= (org-back-over-empty-lines) 1)
8938 (forward-line 1))
8939 (point))
8940 what "children")
8941 (goto-char start)
8942 (show-subtree)
8943 (outline-next-heading))
8945 ;; we will sort the top-level entries in this file
8946 (goto-char (point-min))
8947 (or (org-at-heading-p) (outline-next-heading))
8948 (setq start (point))
8949 (goto-char (point-max))
8950 (beginning-of-line 1)
8951 (when (looking-at ".*?\\S-")
8952 ;; File ends in a non-white line
8953 (end-of-line 1)
8954 (insert "\n"))
8955 (setq end (point-max))
8956 (setq what "top-level")
8957 (goto-char start)
8958 (show-all)))
8960 (setq beg (point))
8961 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8963 (looking-at "\\(\\*+\\)")
8964 (setq stars (match-string 1)
8965 re (concat "^" (regexp-quote stars) " +")
8966 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8967 txt (buffer-substring beg end))
8968 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8969 (if (and (not (equal stars "*")) (string-match re2 txt))
8970 (user-error "Region to sort contains a level above the first entry"))
8972 (unless sorting-type
8973 (message
8974 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8975 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8976 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8977 what)
8978 (setq sorting-type (read-char-exclusive))
8980 (unless getkey-func
8981 (and (= (downcase sorting-type) ?f)
8982 (setq getkey-func
8983 (org-icompleting-read "Sort using function: "
8984 obarray 'fboundp t nil nil))
8985 (setq getkey-func (intern getkey-func))))
8987 (and (= (downcase sorting-type) ?r)
8988 (not property)
8989 (setq property
8990 (org-icompleting-read "Property: "
8991 (mapcar 'list (org-buffer-property-keys t))
8992 nil t))))
8994 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8995 (message "Sorting entries...")
8997 (save-restriction
8998 (narrow-to-region start end)
8999 (let ((dcst (downcase sorting-type))
9000 (case-fold-search nil)
9001 (now (current-time)))
9002 (sort-subr
9003 (/= dcst sorting-type)
9004 ;; This function moves to the beginning character of the "record" to
9005 ;; be sorted.
9006 (lambda nil
9007 (if (re-search-forward re nil t)
9008 (goto-char (match-beginning 0))
9009 (goto-char (point-max))))
9010 ;; This function moves to the last character of the "record" being
9011 ;; sorted.
9012 (lambda nil
9013 (save-match-data
9014 (condition-case nil
9015 (outline-forward-same-level 1)
9016 (error
9017 (goto-char (point-max))))))
9018 ;; This function returns the value that gets sorted against.
9019 (lambda nil
9020 (cond
9021 ((= dcst ?n)
9022 (if (looking-at org-complex-heading-regexp)
9023 (string-to-number (org-sort-remove-invisible (match-string 4)))
9024 nil))
9025 ((= dcst ?a)
9026 (if (looking-at org-complex-heading-regexp)
9027 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9028 nil))
9029 ((= dcst ?k)
9030 (or (get-text-property (point) :org-clock-minutes) 0))
9031 ((= dcst ?t)
9032 (let ((end (save-excursion (outline-next-heading) (point))))
9033 (if (or (re-search-forward org-ts-regexp end t)
9034 (re-search-forward org-ts-regexp-both end t))
9035 (org-time-string-to-seconds (match-string 0))
9036 (org-float-time now))))
9037 ((= dcst ?c)
9038 (let ((end (save-excursion (outline-next-heading) (point))))
9039 (if (re-search-forward
9040 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9041 end t)
9042 (org-time-string-to-seconds (match-string 0))
9043 (org-float-time now))))
9044 ((= dcst ?s)
9045 (let ((end (save-excursion (outline-next-heading) (point))))
9046 (if (re-search-forward org-scheduled-time-regexp end t)
9047 (org-time-string-to-seconds (match-string 1))
9048 (org-float-time now))))
9049 ((= dcst ?d)
9050 (let ((end (save-excursion (outline-next-heading) (point))))
9051 (if (re-search-forward org-deadline-time-regexp end t)
9052 (org-time-string-to-seconds (match-string 1))
9053 (org-float-time now))))
9054 ((= dcst ?p)
9055 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9056 (string-to-char (match-string 2))
9057 org-default-priority))
9058 ((= dcst ?r)
9059 (or (org-entry-get nil property) ""))
9060 ((= dcst ?o)
9061 (if (looking-at org-complex-heading-regexp)
9062 (let* ((m (match-string 2))
9063 (s (if (member m org-done-keywords) '- '+)))
9064 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9065 ((= dcst ?f)
9066 (if getkey-func
9067 (progn
9068 (setq tmp (funcall getkey-func))
9069 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9070 tmp)
9071 (error "Invalid key function `%s'" getkey-func)))
9072 (t (error "Invalid sorting type `%c'" sorting-type))))
9074 (cond
9075 ((= dcst ?a) 'string<)
9076 ((= dcst ?f) compare-func)
9077 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9078 (run-hooks 'org-after-sorting-entries-or-items-hook)
9079 ;; Reset the clock marker if needed
9080 (when cmstr
9081 (save-excursion
9082 (goto-char start)
9083 (search-forward cmstr nil t)
9084 (move-marker org-clock-marker (point))))
9085 (message "Sorting entries...done")))
9087 ;;; The orgstruct minor mode
9089 ;; Define a minor mode which can be used in other modes in order to
9090 ;; integrate the org-mode structure editing commands.
9092 ;; This is really a hack, because the org-mode structure commands use
9093 ;; keys which normally belong to the major mode. Here is how it
9094 ;; works: The minor mode defines all the keys necessary to operate the
9095 ;; structure commands, but wraps the commands into a function which
9096 ;; tests if the cursor is currently at a headline or a plain list
9097 ;; item. If that is the case, the structure command is used,
9098 ;; temporarily setting many Org-mode variables like regular
9099 ;; expressions for filling etc. However, when any of those keys is
9100 ;; used at a different location, function uses `key-binding' to look
9101 ;; up if the key has an associated command in another currently active
9102 ;; keymap (minor modes, major mode, global), and executes that
9103 ;; command. There might be problems if any of the keys is otherwise
9104 ;; used as a prefix key.
9106 (defcustom orgstruct-heading-prefix-regexp ""
9107 "Regexp that matches the custom prefix of Org headlines in
9108 orgstruct(++)-mode."
9109 :group 'org
9110 :version "24.4"
9111 :package-version '(Org . "8.3")
9112 :type 'regexp)
9113 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9115 (defcustom orgstruct-setup-hook nil
9116 "Hook run after orgstruct-mode-map is filled."
9117 :group 'org
9118 :version "24.4"
9119 :package-version '(Org . "8.0")
9120 :type 'hook)
9122 (defvar orgstruct-initialized nil)
9124 (defvar org-local-vars nil
9125 "List of local variables, for use by `orgstruct-mode'.")
9127 ;;;###autoload
9128 (define-minor-mode orgstruct-mode
9129 "Toggle the minor mode `orgstruct-mode'.
9130 This mode is for using Org-mode structure commands in other
9131 modes. The following keys behave as if Org-mode were active, if
9132 the cursor is on a headline, or on a plain list item (both as
9133 defined by Org-mode)."
9134 nil " OrgStruct" (make-sparse-keymap)
9135 (funcall (if orgstruct-mode
9136 'add-to-invisibility-spec
9137 'remove-from-invisibility-spec)
9138 '(outline . t))
9139 (when orgstruct-mode
9140 (org-load-modules-maybe)
9141 (unless orgstruct-initialized
9142 (orgstruct-setup)
9143 (setq orgstruct-initialized t))))
9145 ;;;###autoload
9146 (defun turn-on-orgstruct ()
9147 "Unconditionally turn on `orgstruct-mode'."
9148 (orgstruct-mode 1))
9150 (defvar org-fb-vars nil)
9151 (make-variable-buffer-local 'org-fb-vars)
9152 (defun orgstruct++-mode (&optional arg)
9153 "Toggle `orgstruct-mode', the enhanced version of it.
9154 In addition to setting orgstruct-mode, this also exports all
9155 indentation and autofilling variables from org-mode into the
9156 buffer. It will also recognize item context in multiline items."
9157 (interactive "P")
9158 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9159 (if (< arg 1)
9160 (progn (orgstruct-mode -1)
9161 (mapc (lambda(v)
9162 (org-set-local (car v)
9163 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9164 org-fb-vars))
9165 (orgstruct-mode 1)
9166 (setq org-fb-vars nil)
9167 (unless org-local-vars
9168 (setq org-local-vars (org-get-local-variables)))
9169 (let (var val)
9170 (mapc
9171 (lambda (x)
9172 (when (string-match
9173 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9174 (symbol-name (car x)))
9175 (setq var (car x) val (nth 1 x))
9176 (push (list var `(quote ,(eval var))) org-fb-vars)
9177 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9178 org-local-vars)
9179 (org-set-local 'orgstruct-is-++ t))))
9181 (defvar orgstruct-is-++ nil
9182 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9183 (make-variable-buffer-local 'orgstruct-is-++)
9185 ;;;###autoload
9186 (defun turn-on-orgstruct++ ()
9187 "Unconditionally turn on `orgstruct++-mode'."
9188 (orgstruct++-mode 1))
9190 (defun orgstruct-error ()
9191 "Error when there is no default binding for a structure key."
9192 (interactive)
9193 (funcall (if (fboundp 'user-error)
9194 'user-error
9195 'error)
9196 "This key has no function outside structure elements"))
9198 (defun orgstruct-setup ()
9199 "Setup orgstruct keymap."
9200 (dolist (cell '((org-demote . t)
9201 (org-metaleft . t)
9202 (org-metaright . t)
9203 (org-promote . t)
9204 (org-shiftmetaleft . t)
9205 (org-shiftmetaright . t)
9206 org-backward-element
9207 org-backward-heading-same-level
9208 org-ctrl-c-ret
9209 org-ctrl-c-minus
9210 org-ctrl-c-star
9211 org-cycle
9212 org-forward-heading-same-level
9213 org-insert-heading
9214 org-insert-heading-respect-content
9215 org-kill-note-or-show-branches
9216 org-mark-subtree
9217 org-meta-return
9218 org-metadown
9219 org-metaup
9220 org-narrow-to-subtree
9221 org-promote-subtree
9222 org-reveal
9223 org-shiftdown
9224 org-shiftleft
9225 org-shiftmetadown
9226 org-shiftmetaup
9227 org-shiftright
9228 org-shifttab
9229 org-shifttab
9230 org-shiftup
9231 org-show-subtree
9232 org-sort
9233 org-up-element
9234 outline-demote
9235 outline-next-visible-heading
9236 outline-previous-visible-heading
9237 outline-promote
9238 outline-up-heading
9239 show-children))
9240 (let ((f (or (car-safe cell) cell))
9241 (disable-when-heading-prefix (cdr-safe cell)))
9242 (when (fboundp f)
9243 (let ((new-bindings))
9244 (dolist (binding (nconc (where-is-internal f org-mode-map)
9245 (where-is-internal f outline-mode-map)))
9246 (push binding new-bindings)
9247 ;; TODO use local-function-key-map
9248 (dolist (rep '(("<tab>" . "TAB")
9249 ("<return>" . "RET")
9250 ("<escape>" . "ESC")
9251 ("<delete>" . "DEL")))
9252 (setq binding (read-kbd-macro
9253 (let ((case-fold-search))
9254 (replace-regexp-in-string
9255 (regexp-quote (cdr rep))
9256 (car rep)
9257 (key-description binding)))))
9258 (pushnew binding new-bindings :test 'equal)))
9259 (dolist (binding new-bindings)
9260 (let ((key (lookup-key orgstruct-mode-map binding)))
9261 (when (or (not key) (numberp key))
9262 (ignore-errors
9263 (org-defkey orgstruct-mode-map
9264 binding
9265 (orgstruct-make-binding
9266 f binding disable-when-heading-prefix))))))))))
9267 (run-hooks 'orgstruct-setup-hook))
9269 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9270 "Create a function for binding in the structure minor mode.
9271 FUN is the command to call inside a table. KEY is the key that
9272 should be checked in for a command to execute outside of tables.
9273 Non-nil `disable-when-heading-prefix' means to disable the command
9274 if `orgstruct-heading-prefix-regexp' is not empty."
9275 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9276 (let ((nname name)
9277 (i 0))
9278 (while (fboundp (intern nname))
9279 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9280 (setq name (intern nname)))
9281 (eval
9282 (let ((bindings '((org-heading-regexp
9283 (concat "^"
9284 orgstruct-heading-prefix-regexp
9285 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9286 (org-outline-regexp
9287 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9288 (org-outline-regexp-bol
9289 (concat "^" org-outline-regexp))
9290 (outline-regexp org-outline-regexp)
9291 (outline-heading-end-regexp "\n")
9292 (outline-level 'org-outline-level)
9293 (outline-heading-alist))))
9294 `(defun ,name (arg)
9295 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9296 "Outside of structure, run the binding of `"
9297 (key-description key) "'."
9298 (when disable-when-heading-prefix
9299 (concat
9300 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9301 "back to the default binding due to limitations of Org's implementation of\n"
9302 "`" (symbol-name fun) "'.")))
9303 (interactive "p")
9304 (let* ((disable
9305 ,(and disable-when-heading-prefix
9306 '(not (string= orgstruct-heading-prefix-regexp ""))))
9307 (fallback
9308 (or disable
9309 (not
9310 (let* ,bindings
9311 (org-context-p 'headline 'item
9312 ,(when (memq fun
9313 '(org-insert-heading
9314 org-insert-heading-respect-content
9315 org-meta-return))
9316 '(when orgstruct-is-++
9317 'item-body))))))))
9318 (if fallback
9319 (let* ((orgstruct-mode)
9320 (binding
9321 (let ((key ,key))
9322 (catch 'exit
9323 (dolist
9324 (rep
9325 '(nil
9326 ("<\\([^>]*\\)tab>" . "\\1TAB")
9327 ("<\\([^>]*\\)return>" . "\\1RET")
9328 ("<\\([^>]*\\)escape>" . "\\1ESC")
9329 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9330 nil)
9331 (when rep
9332 (setq key (read-kbd-macro
9333 (let ((case-fold-search))
9334 (replace-regexp-in-string
9335 (car rep)
9336 (cdr rep)
9337 (key-description key))))))
9338 (when (key-binding key)
9339 (throw 'exit (key-binding key))))))))
9340 (if (keymapp binding)
9341 (org-set-transient-map binding)
9342 (let ((func (or binding
9343 (unless disable
9344 'orgstruct-error))))
9345 (when func
9346 (call-interactively func)))))
9347 (org-run-like-in-org-mode
9348 (lambda ()
9349 (interactive)
9350 (let* ,bindings
9351 (call-interactively ',fun)))))))))
9352 name))
9354 (defun org-contextualize-keys (alist contexts)
9355 "Return valid elements in ALIST depending on CONTEXTS.
9357 `org-agenda-custom-commands' or `org-capture-templates' are the
9358 values used for ALIST, and `org-agenda-custom-commands-contexts'
9359 or `org-capture-templates-contexts' are the associated contexts
9360 definitions."
9361 (let ((contexts
9362 ;; normalize contexts
9363 (mapcar
9364 (lambda(c) (cond ((listp (cadr c))
9365 (list (car c) (car c) (cadr c)))
9366 ((string= "" (cadr c))
9367 (list (car c) (car c) (caddr c)))
9368 (t c))) contexts))
9369 (a alist) c r s)
9370 ;; loop over all commands or templates
9371 (while (setq c (pop a))
9372 (let (vrules repl)
9373 (cond
9374 ((not (assoc (car c) contexts))
9375 (push c r))
9376 ((and (assoc (car c) contexts)
9377 (setq vrules (org-contextualize-validate-key
9378 (car c) contexts)))
9379 (mapc (lambda (vr)
9380 (when (not (equal (car vr) (cadr vr)))
9381 (setq repl vr))) vrules)
9382 (if (not repl) (push c r)
9383 (push (cadr repl) s)
9384 (push
9385 (cons (car c)
9386 (cdr (or (assoc (cadr repl) alist)
9387 (error "Undefined key `%s' as contextual replacement for `%s'"
9388 (cadr repl) (car c)))))
9389 r))))))
9390 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9391 (delq
9393 (delete-dups
9394 (mapcar (lambda (x)
9395 (let ((tpl (car x)))
9396 (when (not (delq
9398 (mapcar (lambda(y)
9399 (equal y tpl)) s))) x)))
9400 (reverse r))))))
9402 (defun org-contextualize-validate-key (key contexts)
9403 "Check CONTEXTS for agenda or capture KEY."
9404 (let (r rr res)
9405 (while (setq r (pop contexts))
9406 (mapc
9407 (lambda (rr)
9408 (when
9409 (and (equal key (car r))
9410 (if (functionp rr) (funcall rr)
9411 (or (and (eq (car rr) 'in-file)
9412 (buffer-file-name)
9413 (string-match (cdr rr) (buffer-file-name)))
9414 (and (eq (car rr) 'in-mode)
9415 (string-match (cdr rr) (symbol-name major-mode)))
9416 (and (eq (car rr) 'in-buffer)
9417 (string-match (cdr rr) (buffer-name)))
9418 (when (and (eq (car rr) 'not-in-file)
9419 (buffer-file-name))
9420 (not (string-match (cdr rr) (buffer-file-name))))
9421 (when (eq (car rr) 'not-in-mode)
9422 (not (string-match (cdr rr) (symbol-name major-mode))))
9423 (when (eq (car rr) 'not-in-buffer)
9424 (not (string-match (cdr rr) (buffer-name)))))))
9425 (push r res)))
9426 (car (last r))))
9427 (delete-dups (delq nil res))))
9429 (defun org-context-p (&rest contexts)
9430 "Check if local context is any of CONTEXTS.
9431 Possible values in the list of contexts are `table', `headline', and `item'."
9432 (let ((pos (point)))
9433 (goto-char (point-at-bol))
9434 (prog1 (or (and (memq 'table contexts)
9435 (looking-at "[ \t]*|"))
9436 (and (memq 'headline contexts)
9437 (looking-at org-outline-regexp))
9438 (and (memq 'item contexts)
9439 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9440 (and (memq 'item-body contexts)
9441 (org-in-item-p)))
9442 (goto-char pos))))
9444 (defun org-get-local-variables ()
9445 "Return a list of all local variables in an Org mode buffer."
9446 (let (varlist)
9447 (with-current-buffer (get-buffer-create "*Org tmp*")
9448 (erase-buffer)
9449 (org-mode)
9450 (setq varlist (buffer-local-variables)))
9451 (kill-buffer "*Org tmp*")
9452 (delq nil
9453 (mapcar
9454 (lambda (x)
9455 (setq x
9456 (if (symbolp x)
9457 (list x)
9458 (list (car x) (cdr x))))
9459 (if (and (not (get (car x) 'org-state))
9460 (string-match
9461 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9462 (symbol-name (car x))))
9463 x nil))
9464 varlist))))
9466 (defun org-clone-local-variables (from-buffer &optional regexp)
9467 "Clone local variables from FROM-BUFFER.
9468 Optional argument REGEXP selects variables to clone."
9469 (mapc
9470 (lambda (pair)
9471 (and (symbolp (car pair))
9472 (or (null regexp)
9473 (string-match regexp (symbol-name (car pair))))
9474 (set (make-local-variable (car pair))
9475 (cdr pair))))
9476 (buffer-local-variables from-buffer)))
9478 ;;;###autoload
9479 (defun org-run-like-in-org-mode (cmd)
9480 "Run a command, pretending that the current buffer is in Org-mode.
9481 This will temporarily bind local variables that are typically bound in
9482 Org-mode to the values they have in Org-mode, and then interactively
9483 call CMD."
9484 (org-load-modules-maybe)
9485 (unless org-local-vars
9486 (setq org-local-vars (org-get-local-variables)))
9487 (let (binds)
9488 (dolist (var org-local-vars)
9489 (when (or (not (boundp (car var)))
9490 (eq (symbol-value (car var))
9491 (default-value (car var))))
9492 (push (list (car var) `(quote ,(cadr var))) binds)))
9493 (eval `(let ,binds
9494 (call-interactively (quote ,cmd))))))
9496 (defun org-get-category (&optional pos force-refresh)
9497 "Get the category applying to position POS."
9498 (save-match-data
9499 (if force-refresh (org-refresh-category-properties))
9500 (let ((pos (or pos (point))))
9501 (or (get-text-property pos 'org-category)
9502 (progn (org-refresh-category-properties)
9503 (get-text-property pos 'org-category))))))
9505 ;;; Refresh properties
9507 (defun org-refresh-properties (dprop tprop)
9508 "Refresh buffer text properties.
9509 DPROP is the drawer property and TPROP is either the
9510 corresponding text property to set, or an alist with each element
9511 being a text property (as a symbol) and a function to apply to
9512 the value of the drawer property."
9513 (let ((case-fold-search t)
9514 (inhibit-read-only t))
9515 (org-with-silent-modifications
9516 (save-excursion
9517 (save-restriction
9518 (widen)
9519 (goto-char (point-min))
9520 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9521 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9523 (defun org-refresh-property (tprop p)
9524 "Refresh the buffer text property TPROP from the drawer property P.
9525 The refresh happens only for the current tree (not subtree)."
9526 (save-excursion
9527 (org-back-to-heading t)
9528 ;; tprop is a text property symbol
9529 (if (symbolp tprop)
9530 (put-text-property
9531 (point) (or (outline-next-heading) (point-max)) tprop p)
9532 ;; tprop is an alist with (properties . function) elements
9533 (mapc (lambda(al)
9534 (save-excursion
9535 (put-text-property
9536 (point-at-bol) (or (outline-next-heading) (point-max))
9537 (car al)
9538 (funcall (cdr al) p))))
9539 tprop))))
9541 (defun org-refresh-category-properties ()
9542 "Refresh category text properties in the buffer."
9543 (let ((case-fold-search t)
9544 (inhibit-read-only t)
9545 (def-cat (cond
9546 ((null org-category)
9547 (if buffer-file-name
9548 (file-name-sans-extension
9549 (file-name-nondirectory buffer-file-name))
9550 "???"))
9551 ((symbolp org-category) (symbol-name org-category))
9552 (t org-category)))
9553 beg end cat pos optionp)
9554 (org-with-silent-modifications
9555 (save-excursion
9556 (save-restriction
9557 (widen)
9558 (goto-char (point-min))
9559 (put-text-property (point) (point-max) 'org-category def-cat)
9560 (while (re-search-forward
9561 "^[ \t]*\\(\\(?:#\\+\\|:\\)CATEGORY:\\)\\(.*\\)" nil t)
9562 (setq pos (match-end 0)
9563 optionp (equal (char-after (match-beginning 0)) ?#)
9564 cat (org-trim (match-string 2)))
9565 (if optionp
9566 (setq beg (point-at-bol) end (point-max))
9567 (org-back-to-heading t)
9568 (setq beg (point) end (org-end-of-subtree t t)))
9569 (put-text-property beg end 'org-category cat)
9570 (goto-char pos)))))))
9572 (defun org-refresh-stats-properties ()
9573 "Refresh stats text properties in the buffer."
9574 (let (stats)
9575 (org-with-silent-modifications
9576 (save-excursion
9577 (save-restriction
9578 (widen)
9579 (goto-char (point-min))
9580 (while (re-search-forward
9581 (concat org-outline-regexp-bol ".*"
9582 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9583 nil t)
9584 (setq stats (cond ((equal (match-string 3) "0") 0)
9585 ((match-string 2)
9586 (/ (* (string-to-number (match-string 2)) 100)
9587 (string-to-number (match-string 3))))
9588 (t (string-to-number (match-string 1)))))
9589 (org-back-to-heading t)
9590 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9591 'org-stats stats)))))))
9593 (defun org-refresh-effort-properties ()
9594 "Refresh effort properties"
9595 (org-refresh-properties
9596 org-effort-property
9597 '((effort . identity)
9598 (effort-minutes . org-duration-string-to-minutes))))
9600 ;;;; Link Stuff
9602 ;;; Link abbreviations
9604 (defun org-link-expand-abbrev (link)
9605 "Apply replacements as defined in `org-link-abbrev-alist'."
9606 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9607 (let* ((key (match-string 1 link))
9608 (as (or (assoc key org-link-abbrev-alist-local)
9609 (assoc key org-link-abbrev-alist)))
9610 (tag (and (match-end 2) (match-string 3 link)))
9611 rpl)
9612 (if (not as)
9613 link
9614 (setq rpl (cdr as))
9615 (cond
9616 ((symbolp rpl) (funcall rpl tag))
9617 ((string-match "%(\\([^)]+\\))" rpl)
9618 (replace-match
9619 (save-match-data
9620 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9621 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9622 ((string-match "%h" rpl)
9623 (replace-match (url-hexify-string (or tag "")) t t rpl))
9624 (t (concat rpl tag)))))
9625 link))
9627 ;;; Storing and inserting links
9629 (defvar org-insert-link-history nil
9630 "Minibuffer history for links inserted with `org-insert-link'.")
9632 (defvar org-stored-links nil
9633 "Contains the links stored with `org-store-link'.")
9635 (defvar org-store-link-plist nil
9636 "Plist with info about the most recently link created with `org-store-link'.")
9638 (defvar org-link-protocols nil
9639 "Link protocols added to Org-mode using `org-add-link-type'.")
9641 (defvar org-store-link-functions nil
9642 "List of functions that are called to create and store a link.
9643 Each function will be called in turn until one returns a non-nil
9644 value. Each function should check if it is responsible for creating
9645 this link (for example by looking at the major mode).
9646 If not, it must exit and return nil.
9647 If yes, it should return a non-nil value after a calling
9648 `org-store-link-props' with a list of properties and values.
9649 Special properties are:
9651 :type The link prefix, like \"http\". This must be given.
9652 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9653 This is obligatory as well.
9654 :description Optional default description for the second pair
9655 of brackets in an Org-mode link. The user can still change
9656 this when inserting this link into an Org-mode buffer.
9658 In addition to these, any additional properties can be specified
9659 and then used in capture templates.")
9661 (defun org-add-link-type (type &optional follow export)
9662 "Add TYPE to the list of `org-link-types'.
9663 Re-compute all regular expressions depending on `org-link-types'
9665 FOLLOW and EXPORT are two functions.
9667 FOLLOW should take the link path as the single argument and do whatever
9668 is necessary to follow the link, for example find a file or display
9669 a mail message.
9671 EXPORT should format the link path for export to one of the export formats.
9672 It should be a function accepting three arguments:
9674 path the path of the link, the text after the prefix (like \"http:\")
9675 desc the description of the link, if any
9676 format the export format, a symbol like `html' or `latex' or `ascii'.
9678 The function may use the FORMAT information to return different values
9679 depending on the format. The return value will be put literally into
9680 the exported file. If the return value is nil, this means Org should
9681 do what it normally does with links which do not have EXPORT defined.
9683 Org mode has a built-in default for exporting links. If you are happy with
9684 this default, there is no need to define an export function for the link
9685 type. For a simple example of an export function, see `org-bbdb.el'."
9686 (add-to-list 'org-link-types type t)
9687 (org-make-link-regexps)
9688 (org-element-update-syntax)
9689 (if (assoc type org-link-protocols)
9690 (setcdr (assoc type org-link-protocols) (list follow export))
9691 (push (list type follow export) org-link-protocols)))
9693 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9694 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9696 ;;;###autoload
9697 (defun org-store-link (arg)
9698 "\\<org-mode-map>Store an org-link to the current location.
9699 This link is added to `org-stored-links' and can later be inserted
9700 into an org-buffer with \\[org-insert-link].
9702 For some link types, a prefix arg is interpreted.
9703 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9704 For file links, arg negates `org-context-in-file-links'.
9706 A double prefix arg force skipping storing functions that are not
9707 part of Org's core.
9709 A triple prefix arg force storing a link for each line in the
9710 active region."
9711 (interactive "P")
9712 (org-load-modules-maybe)
9713 (if (and (equal arg '(64)) (org-region-active-p))
9714 (save-excursion
9715 (let ((end (region-end)))
9716 (goto-char (region-beginning))
9717 (set-mark (point))
9718 (while (< (point-at-eol) end)
9719 (move-end-of-line 1) (activate-mark)
9720 (let (current-prefix-arg)
9721 (call-interactively 'org-store-link))
9722 (move-beginning-of-line 2)
9723 (set-mark (point)))))
9724 (org-with-limited-levels
9725 (setq org-store-link-plist nil)
9726 (let (link cpltxt desc description search
9727 txt custom-id agenda-link sfuns sfunsn)
9728 (cond
9730 ;; Store a link using an external link type
9731 ((and (not (equal arg '(16)))
9732 (setq sfuns
9733 (delq
9734 nil (mapcar (lambda (f)
9735 (let (fs) (if (funcall f) (push f fs))))
9736 org-store-link-functions))
9737 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9738 (or (and (cdr sfuns)
9739 (funcall (intern
9740 (completing-read
9741 "Which function for creating the link? "
9742 sfunsn nil t (car sfunsn)))))
9743 (funcall (caar sfuns)))
9744 (setq link (plist-get org-store-link-plist :link)
9745 desc (or (plist-get org-store-link-plist
9746 :description) link))))
9748 ;; Store a link from a source code buffer
9749 ((org-src-edit-buffer-p)
9750 (let (label gc)
9751 (while (or (not label)
9752 (save-excursion
9753 (save-restriction
9754 (widen)
9755 (goto-char (point-min))
9756 (re-search-forward
9757 (regexp-quote (format org-coderef-label-format label))
9758 nil t))))
9759 (when label (message "Label exists already") (sit-for 2))
9760 (setq label (read-string "Code line label: " label)))
9761 (end-of-line 1)
9762 (setq link (format org-coderef-label-format label))
9763 (setq gc (- 79 (length link)))
9764 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9765 (insert link)
9766 (setq link (concat "(" label ")") desc nil)))
9768 ;; We are in the agenda, link to referenced location
9769 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9770 (let ((m (or (get-text-property (point) 'org-hd-marker)
9771 (get-text-property (point) 'org-marker))))
9772 (when m
9773 (org-with-point-at m
9774 (setq agenda-link
9775 (if (org-called-interactively-p 'any)
9776 (call-interactively 'org-store-link)
9777 (org-store-link nil)))))))
9779 ((eq major-mode 'calendar-mode)
9780 (let ((cd (calendar-cursor-to-date)))
9781 (setq link
9782 (format-time-string
9783 (car org-time-stamp-formats)
9784 (apply 'encode-time
9785 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9786 nil nil nil))))
9787 (org-store-link-props :type "calendar" :date cd)))
9789 ((eq major-mode 'help-mode)
9790 (setq link (concat "help:" (save-excursion
9791 (goto-char (point-min))
9792 (looking-at "^[^ ]+")
9793 (match-string 0))))
9794 (org-store-link-props :type "help"))
9796 ((eq major-mode 'w3-mode)
9797 (setq cpltxt (if (and (buffer-name)
9798 (not (string-match "Untitled" (buffer-name))))
9799 (buffer-name)
9800 (url-view-url t))
9801 link (url-view-url t))
9802 (org-store-link-props :type "w3" :url (url-view-url t)))
9804 ((eq major-mode 'image-mode)
9805 (setq cpltxt (concat "file:"
9806 (abbreviate-file-name buffer-file-name))
9807 link cpltxt)
9808 (org-store-link-props :type "image" :file buffer-file-name))
9810 ;; In dired, store a link to the file of the current line
9811 ((derived-mode-p 'dired-mode)
9812 (let ((file (dired-get-filename nil t)))
9813 (setq file (if file
9814 (abbreviate-file-name
9815 (expand-file-name (dired-get-filename nil t)))
9816 ;; otherwise, no file so use current directory.
9817 default-directory))
9818 (setq cpltxt (concat "file:" file)
9819 link cpltxt)))
9821 ((setq search (run-hook-with-args-until-success
9822 'org-create-file-search-functions))
9823 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9824 "::" search))
9825 (setq cpltxt (or description link)))
9827 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9828 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9829 (cond
9830 ;; Store a link using the target at point
9831 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9832 (setq cpltxt
9833 (concat "file:"
9834 (abbreviate-file-name
9835 (buffer-file-name (buffer-base-buffer)))
9836 "::" (match-string 1))
9837 link cpltxt))
9838 ((and (featurep 'org-id)
9839 (or (eq org-id-link-to-org-use-id t)
9840 (and (org-called-interactively-p 'any)
9841 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9842 (and (eq org-id-link-to-org-use-id
9843 'create-if-interactive-and-no-custom-id)
9844 (not custom-id))))
9845 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9846 ;; Store a link using the ID at point
9847 (setq link (condition-case nil
9848 (prog1 (org-id-store-link)
9849 (setq desc (or (plist-get org-store-link-plist
9850 :description)
9851 "")))
9852 (error
9853 ;; Probably before first headline, link only to file
9854 (concat "file:"
9855 (abbreviate-file-name
9856 (buffer-file-name (buffer-base-buffer))))))))
9858 ;; Just link to current headline
9859 (setq cpltxt (concat "file:"
9860 (abbreviate-file-name
9861 (buffer-file-name (buffer-base-buffer)))))
9862 ;; Add a context search string
9863 (when (org-xor org-context-in-file-links arg)
9864 (let* ((ee (org-element-at-point))
9865 (et (org-element-type ee))
9866 (ev (plist-get (cadr ee) :value))
9867 (ek (plist-get (cadr ee) :key))
9868 (eok (and (stringp ek) (string-match "name" ek))))
9869 (setq txt (cond
9870 ((org-at-heading-p) nil)
9871 ((and (eq et 'keyword) eok) ev)
9872 ((org-region-active-p)
9873 (buffer-substring (region-beginning) (region-end)))))
9874 (when (or (null txt) (string-match "\\S-" txt))
9875 (setq cpltxt
9876 (concat cpltxt "::"
9877 (condition-case nil
9878 (org-make-org-heading-search-string txt)
9879 (error "")))
9880 desc (or (and (eq et 'keyword) eok ev)
9881 (nth 4 (ignore-errors (org-heading-components)))
9882 "NONE")))))
9883 (if (string-match "::\\'" cpltxt)
9884 (setq cpltxt (substring cpltxt 0 -2)))
9885 (setq link cpltxt))))
9887 ((buffer-file-name (buffer-base-buffer))
9888 ;; Just link to this file here.
9889 (setq cpltxt (concat "file:"
9890 (abbreviate-file-name
9891 (buffer-file-name (buffer-base-buffer)))))
9892 ;; Add a context string.
9893 (when (org-xor org-context-in-file-links arg)
9894 (setq txt (if (org-region-active-p)
9895 (buffer-substring (region-beginning) (region-end))
9896 (buffer-substring (point-at-bol) (point-at-eol))))
9897 ;; Only use search option if there is some text.
9898 (when (string-match "\\S-" txt)
9899 (setq cpltxt
9900 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9901 desc "NONE")))
9902 (setq link cpltxt))
9904 ((org-called-interactively-p 'interactive)
9905 (user-error "No method for storing a link from this buffer"))
9907 (t (setq link nil)))
9909 ;; We're done setting link and desc, clean up
9910 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9911 (setq link (or link cpltxt)
9912 desc (or desc cpltxt))
9913 (cond ((equal desc "NONE") (setq desc nil))
9914 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9915 (let ((d0 (match-string 3 desc))
9916 (p0 (match-string 5 desc)))
9917 (setq desc
9918 (replace-regexp-in-string
9919 org-bracket-link-regexp
9920 (concat (or p0 d0)
9921 (if (equal (length (match-string 0 desc))
9922 (length desc)) "*" "")) desc)))))
9924 ;; Return the link
9925 (if (not (and (or (org-called-interactively-p 'any)
9926 executing-kbd-macro) link))
9927 (or agenda-link (and link (org-make-link-string link desc)))
9928 (push (list link desc) org-stored-links)
9929 (message "Stored: %s" (or desc link))
9930 (when custom-id
9931 (setq link (concat "file:" (abbreviate-file-name
9932 (buffer-file-name)) "::#" custom-id))
9933 (push (list link desc) org-stored-links))
9934 (car org-stored-links))))))
9936 (defun org-store-link-props (&rest plist)
9937 "Store link properties, extract names and addresses."
9938 (let (x adr)
9939 (when (setq x (plist-get plist :from))
9940 (setq adr (mail-extract-address-components x))
9941 (setq plist (plist-put plist :fromname (car adr)))
9942 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9943 (when (setq x (plist-get plist :to))
9944 (setq adr (mail-extract-address-components x))
9945 (setq plist (plist-put plist :toname (car adr)))
9946 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9947 (let ((from (plist-get plist :from))
9948 (to (plist-get plist :to)))
9949 (when (and from to org-from-is-user-regexp)
9950 (setq plist
9951 (plist-put plist :fromto
9952 (if (string-match org-from-is-user-regexp from)
9953 (concat "to %t")
9954 (concat "from %f"))))))
9955 (setq org-store-link-plist plist))
9957 (defun org-add-link-props (&rest plist)
9958 "Add these properties to the link property list."
9959 (let (key value)
9960 (while plist
9961 (setq key (pop plist) value (pop plist))
9962 (setq org-store-link-plist
9963 (plist-put org-store-link-plist key value)))))
9965 (defun org-email-link-description (&optional fmt)
9966 "Return the description part of an email link.
9967 This takes information from `org-store-link-plist' and formats it
9968 according to FMT (default from `org-email-link-description-format')."
9969 (setq fmt (or fmt org-email-link-description-format))
9970 (let* ((p org-store-link-plist)
9971 (to (plist-get p :toaddress))
9972 (from (plist-get p :fromaddress))
9973 (table
9974 (list
9975 (cons "%c" (plist-get p :fromto))
9976 (cons "%F" (plist-get p :from))
9977 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9978 (cons "%T" (plist-get p :to))
9979 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9980 (cons "%s" (plist-get p :subject))
9981 (cons "%d" (plist-get p :date))
9982 (cons "%m" (plist-get p :message-id)))))
9983 (when (string-match "%c" fmt)
9984 ;; Check if the user wrote this message
9985 (if (and org-from-is-user-regexp from to
9986 (save-match-data (string-match org-from-is-user-regexp from)))
9987 (setq fmt (replace-match "to %t" t t fmt))
9988 (setq fmt (replace-match "from %f" t t fmt))))
9989 (org-replace-escapes fmt table)))
9991 (defun org-make-org-heading-search-string (&optional string)
9992 "Make search string for the current headline or STRING."
9993 (let ((s (or string
9994 (and (derived-mode-p 'org-mode)
9995 (save-excursion
9996 (org-back-to-heading t)
9997 (org-element-property :raw-value (org-element-at-point))))))
9998 (lines org-context-in-file-links))
9999 (or string (setq s (concat "*" s))) ; Add * for headlines
10000 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10001 (when (and string (integerp lines) (> lines 0))
10002 (let ((slines (org-split-string s "\n")))
10003 (when (< lines (length slines))
10004 (setq s (mapconcat
10005 'identity
10006 (reverse (nthcdr (- (length slines) lines)
10007 (reverse slines))) "\n")))))
10008 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10010 (defun org-make-link-string (link &optional description)
10011 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10012 (unless (string-match "\\S-" link)
10013 (error "Empty link"))
10014 (when (and description
10015 (stringp description)
10016 (not (string-match "\\S-" description)))
10017 (setq description nil))
10018 (when (stringp description)
10019 ;; Remove brackets from the description, they are fatal.
10020 (while (string-match "\\[" description)
10021 (setq description (replace-match "{" t t description)))
10022 (while (string-match "\\]" description)
10023 (setq description (replace-match "}" t t description))))
10024 (when (equal link description)
10025 ;; No description needed, it is identical
10026 (setq description nil))
10027 (when (and (not description)
10028 (not (string-match (org-image-file-name-regexp) link))
10029 (not (equal link (org-link-escape link))))
10030 (setq description (org-extract-attributes link)))
10031 (setq link
10032 (cond ((string-match (org-image-file-name-regexp) link) link)
10033 ((string-match org-link-types-re link)
10034 (concat (match-string 1 link)
10035 (org-link-escape (substring link (match-end 1)))))
10036 (t (org-link-escape link))))
10037 (concat "[[" link "]"
10038 (if description (concat "[" description "]") "")
10039 "]"))
10041 (defconst org-link-escape-chars
10042 ;;%20 %5B %5D
10043 '(?\ ?\[ ?\])
10044 "List of characters that should be escaped in a link when stored to Org.
10045 This is the list that is used for internal purposes.")
10047 (defconst org-link-escape-chars-browser
10048 ;;%20 %22
10049 '(?\ ?\")
10050 "List of characters to be escaped before handing over to the browser.
10051 If you consider using this constant then you probably want to use
10052 the function `org-link-escape-browser' instead. See there why
10053 this constant is a candidate to be removed once Org drops support
10054 for Emacs 24.1 and 24.2.")
10056 (defun org-link-escape (text &optional table merge)
10057 "Return percent escaped representation of TEXT.
10058 TEXT is a string with the text to escape.
10059 Optional argument TABLE is a list with characters that should be
10060 escaped. When nil, `org-link-escape-chars' is used.
10061 If optional argument MERGE is set, merge TABLE into
10062 `org-link-escape-chars'."
10063 ;; Don't escape chars in internal links
10064 (if (string-match "^\\*[[:alnum:]]+" text)
10065 text
10066 (cond
10067 ((and table merge)
10068 (mapc (lambda (defchr)
10069 (unless (member defchr table)
10070 (setq table (cons defchr table))))
10071 org-link-escape-chars))
10072 ((null table)
10073 (setq table org-link-escape-chars)))
10074 (mapconcat
10075 (lambda (char)
10076 (if (or (member char table)
10077 (and (or (< char 32) (= char ?\%) (> char 126))
10078 org-url-hexify-p))
10079 (mapconcat (lambda (sequence-element)
10080 (format "%%%.2X" sequence-element))
10081 (or (encode-coding-char char 'utf-8)
10082 (error "Unable to percent escape character: %s"
10083 (char-to-string char))) "")
10084 (char-to-string char))) text "")))
10086 (defun org-link-escape-browser (text)
10087 "Escape some characters before handing over to the browser.
10088 This function is a candidate to be removed together with the
10089 constant `org-link-escape-chars-browser' once Org drops support
10090 for Emacs 24.1 and 24.2. All calls to this function will have to
10091 be replaced with `url-encode-url' which is available since Emacs
10092 24.3.1."
10093 ;; Example with the Org link
10094 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10095 ;; to open the browser with +subject:"Release 8.2" filled into the
10096 ;; query field: In this case the variable TEXT contains the
10097 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10098 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10099 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10100 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10101 (if (fboundp 'url-encode-url)
10102 (url-encode-url text)
10103 (if (org-string-match-p
10104 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10105 text)
10106 (org-link-escape text org-link-escape-chars-browser)
10107 text)))
10109 (defun org-link-unescape (str)
10110 "Unhex hexified Unicode strings as returned from the JavaScript function
10111 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10112 (unless (and (null str) (string= "" str))
10113 (let ((pos 0) (case-fold-search t) unhexed)
10114 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10115 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10116 (setq str (replace-match unhexed t t str))
10117 (setq pos (+ pos (length unhexed))))))
10118 str)
10120 (defun org-link-unescape-compound (hex)
10121 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10122 Note: this function also decodes single byte encodings like
10123 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10124 (save-match-data
10125 (let* ((bytes (cdr (split-string hex "%")))
10126 (ret "")
10127 (eat 0)
10128 (sum 0))
10129 (while bytes
10130 (let* ((val (string-to-number (pop bytes) 16))
10131 (shift-xor
10132 (if (= 0 eat)
10133 (cond
10134 ((>= val 252) (cons 6 252))
10135 ((>= val 248) (cons 5 248))
10136 ((>= val 240) (cons 4 240))
10137 ((>= val 224) (cons 3 224))
10138 ((>= val 192) (cons 2 192))
10139 (t (cons 0 0)))
10140 (cons 6 128))))
10141 (if (>= val 192) (setq eat (car shift-xor)))
10142 (setq val (logxor val (cdr shift-xor)))
10143 (setq sum (+ (lsh sum (car shift-xor)) val))
10144 (if (> eat 0) (setq eat (- eat 1)))
10145 (cond
10146 ((= 0 eat) ;multi byte
10147 (setq ret (concat ret (org-char-to-string sum)))
10148 (setq sum 0))
10149 ((not bytes) ; single byte(s)
10150 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10151 ret)))
10153 (defun org-link-unescape-single-byte-sequence (hex)
10154 "Unhexify hex-encoded single byte character sequences."
10155 (mapconcat (lambda (byte)
10156 (char-to-string (string-to-number byte 16)))
10157 (cdr (split-string hex "%")) ""))
10159 (defun org-xor (a b)
10160 "Exclusive or."
10161 (if a (not b) b))
10163 (defun org-fixup-message-id-for-http (s)
10164 "Replace special characters in a message id, so it can be used in an http query."
10165 (when (string-match "%" s)
10166 (setq s (mapconcat (lambda (c)
10167 (if (eq c ?%)
10168 "%25"
10169 (char-to-string c)))
10170 s "")))
10171 (while (string-match "<" s)
10172 (setq s (replace-match "%3C" t t s)))
10173 (while (string-match ">" s)
10174 (setq s (replace-match "%3E" t t s)))
10175 (while (string-match "@" s)
10176 (setq s (replace-match "%40" t t s)))
10179 (defun org-link-prettify (link)
10180 "Return a human-readable representation of LINK.
10181 The car of LINK must be a raw link.
10182 The cdr of LINK must be either a link description or nil."
10183 (let ((desc (or (cadr link) "<no description>")))
10184 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10185 "<" (car link) ">")))
10187 ;;;###autoload
10188 (defun org-insert-link-global ()
10189 "Insert a link like Org-mode does.
10190 This command can be called in any mode to insert a link in Org-mode syntax."
10191 (interactive)
10192 (org-load-modules-maybe)
10193 (org-run-like-in-org-mode 'org-insert-link))
10195 (defun org-insert-all-links (arg &optional pre post)
10196 "Insert all links in `org-stored-links'.
10197 When a universal prefix, do not delete the links from `org-stored-links'.
10198 When `ARG' is a number, insert the last N link(s).
10199 `PRE' and `POST' are optional arguments to define a string to
10200 prepend or to append."
10201 (interactive "P")
10202 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10203 (links (copy-seq org-stored-links))
10204 (pr (or pre "- "))
10205 (po (or post "\n"))
10206 (cnt 1) l)
10207 (if (null org-stored-links)
10208 (message "No link to insert")
10209 (while (and (or (listp arg) (>= arg cnt))
10210 (setq l (if (listp arg)
10211 (pop links)
10212 (pop org-stored-links))))
10213 (setq cnt (1+ cnt))
10214 (insert pr)
10215 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10216 (insert po)))))
10218 (defun org-insert-last-stored-link (arg)
10219 "Insert the last link stored in `org-stored-links'."
10220 (interactive "p")
10221 (org-insert-all-links arg "" "\n"))
10223 (defun org-link-fontify-links-to-this-file ()
10224 "Fontify links to the current file in `org-stored-links'."
10225 (let ((f (buffer-file-name)) a b)
10226 (setq a (mapcar (lambda(l)
10227 (let ((ll (car l)))
10228 (when (and (string-match "^file:\\(.+\\)::" ll)
10229 (equal f (expand-file-name (match-string 1 ll))))
10230 ll)))
10231 org-stored-links))
10232 (when (featurep 'org-id)
10233 (setq b (mapcar (lambda(l)
10234 (let ((ll (car l)))
10235 (when (and (string-match "^id:\\(.+\\)$" ll)
10236 (equal f (expand-file-name
10237 (or (org-id-find-id-file
10238 (match-string 1 ll)) ""))))
10239 ll)))
10240 org-stored-links)))
10241 (mapcar (lambda(l)
10242 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10243 (delq nil (append a b)))))
10245 (defvar org-link-links-in-this-file nil)
10246 (defun org-insert-link (&optional complete-file link-location default-description)
10247 "Insert a link. At the prompt, enter the link.
10249 Completion can be used to insert any of the link protocol prefixes like
10250 http or ftp in use.
10252 The history can be used to select a link previously stored with
10253 `org-store-link'. When the empty string is entered (i.e. if you just
10254 press RET at the prompt), the link defaults to the most recently
10255 stored link. As SPC triggers completion in the minibuffer, you need to
10256 use M-SPC or C-q SPC to force the insertion of a space character.
10258 You will also be prompted for a description, and if one is given, it will
10259 be displayed in the buffer instead of the link.
10261 If there is already a link at point, this command will allow you to edit link
10262 and description parts.
10264 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10265 be selected using completion. The path to the file will be relative to the
10266 current directory if the file is in the current directory or a subdirectory.
10267 Otherwise, the link will be the absolute path as completed in the minibuffer
10268 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10269 option `org-link-file-path-type'.
10271 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10272 the current directory or below.
10274 With three \\[universal-argument] prefixes, negate the meaning of
10275 `org-keep-stored-link-after-insertion'.
10277 If `org-make-link-description-function' is non-nil, this function will be
10278 called with the link target, and the result will be the default
10279 link description.
10281 If the LINK-LOCATION parameter is non-nil, this value will be
10282 used as the link location instead of reading one interactively.
10284 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10285 be used as the default description."
10286 (interactive "P")
10287 (let* ((wcf (current-window-configuration))
10288 (origbuf (current-buffer))
10289 (region (if (org-region-active-p)
10290 (buffer-substring (region-beginning) (region-end))))
10291 (remove (and region (list (region-beginning) (region-end))))
10292 (desc region)
10293 tmphist ; byte-compile incorrectly complains about this
10294 (link link-location)
10295 (abbrevs org-link-abbrev-alist-local)
10296 entry file all-prefixes auto-desc)
10297 (cond
10298 (link-location) ; specified by arg, just use it.
10299 ((org-in-regexp org-bracket-link-regexp 1)
10300 ;; We do have a link at point, and we are going to edit it.
10301 (setq remove (list (match-beginning 0) (match-end 0)))
10302 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10303 (setq link (read-string "Link: "
10304 (org-link-unescape
10305 (org-match-string-no-properties 1)))))
10306 ((or (org-in-regexp org-angle-link-re)
10307 (org-in-regexp org-plain-link-re))
10308 ;; Convert to bracket link
10309 (setq remove (list (match-beginning 0) (match-end 0))
10310 link (read-string "Link: "
10311 (org-remove-angle-brackets (match-string 0)))))
10312 ((member complete-file '((4) (16)))
10313 ;; Completing read for file names.
10314 (setq link (org-file-complete-link complete-file)))
10316 ;; Read link, with completion for stored links.
10317 (org-link-fontify-links-to-this-file)
10318 (org-switch-to-buffer-other-window "*Org Links*")
10319 (with-current-buffer "*Org Links*"
10320 (erase-buffer)
10321 (insert "Insert a link.
10322 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10323 (when org-stored-links
10324 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10325 (insert (mapconcat 'org-link-prettify
10326 (reverse org-stored-links) "\n")))
10327 (goto-char (point-min)))
10328 (let ((cw (selected-window)))
10329 (select-window (get-buffer-window "*Org Links*" 'visible))
10330 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10331 (unless (pos-visible-in-window-p (point-max))
10332 (org-fit-window-to-buffer))
10333 (and (window-live-p cw) (select-window cw)))
10334 ;; Fake a link history, containing the stored links.
10335 (setq tmphist (append (mapcar 'car org-stored-links)
10336 org-insert-link-history))
10337 (setq all-prefixes (append (mapcar 'car abbrevs)
10338 (mapcar 'car org-link-abbrev-alist)
10339 org-link-types))
10340 (unwind-protect
10341 (progn
10342 (setq link
10343 (org-completing-read
10344 "Link: "
10345 (append
10346 (mapcar (lambda (x) (concat x ":"))
10347 all-prefixes)
10348 (mapcar 'car org-stored-links))
10349 nil nil nil
10350 'tmphist
10351 (caar org-stored-links)))
10352 (if (not (string-match "\\S-" link))
10353 (user-error "No link selected"))
10354 (mapc (lambda(l)
10355 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10356 org-stored-links)
10357 (if (or (member link all-prefixes)
10358 (and (equal ":" (substring link -1))
10359 (member (substring link 0 -1) all-prefixes)
10360 (setq link (substring link 0 -1))))
10361 (setq link (with-current-buffer origbuf
10362 (org-link-try-special-completion link)))))
10363 (set-window-configuration wcf)
10364 (kill-buffer "*Org Links*"))
10365 (setq entry (assoc link org-stored-links))
10366 (or entry (push link org-insert-link-history))
10367 (setq desc (or desc (nth 1 entry)))))
10369 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10370 (not org-keep-stored-link-after-insertion))
10371 (setq org-stored-links (delq (assoc link org-stored-links)
10372 org-stored-links)))
10374 (if (and (string-match org-plain-link-re link)
10375 (not (string-match org-ts-regexp link)))
10376 ;; URL-like link, normalize the use of angular brackets.
10377 (setq link (org-remove-angle-brackets link)))
10379 ;; Check if we are linking to the current file with a search
10380 ;; option If yes, simplify the link by using only the search
10381 ;; option.
10382 (when (and buffer-file-name
10383 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10384 (let* ((path (match-string 1 link))
10385 (case-fold-search nil)
10386 (search (match-string 2 link)))
10387 (save-match-data
10388 (if (equal (file-truename buffer-file-name) (file-truename path))
10389 ;; We are linking to this same file, with a search option
10390 (setq link search)))))
10392 ;; Check if we can/should use a relative path. If yes, simplify the link
10393 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10394 (let* ((type (match-string 1 link))
10395 (path (match-string 2 link))
10396 (origpath path)
10397 (case-fold-search nil))
10398 (cond
10399 ((or (eq org-link-file-path-type 'absolute)
10400 (equal complete-file '(16)))
10401 (setq path (abbreviate-file-name (expand-file-name path))))
10402 ((eq org-link-file-path-type 'noabbrev)
10403 (setq path (expand-file-name path)))
10404 ((eq org-link-file-path-type 'relative)
10405 (setq path (file-relative-name path)))
10407 (save-match-data
10408 (if (string-match (concat "^" (regexp-quote
10409 (expand-file-name
10410 (file-name-as-directory
10411 default-directory))))
10412 (expand-file-name path))
10413 ;; We are linking a file with relative path name.
10414 (setq path (substring (expand-file-name path)
10415 (match-end 0)))
10416 (setq path (abbreviate-file-name (expand-file-name path)))))))
10417 (setq link (concat type path))
10418 (if (equal desc origpath)
10419 (setq desc path))))
10421 (if org-make-link-description-function
10422 (setq desc
10423 (or (condition-case nil
10424 (funcall org-make-link-description-function link desc)
10425 (error (progn (message "Can't get link description from `%s'"
10426 (symbol-name org-make-link-description-function))
10427 (sit-for 2) nil)))
10428 (read-string "Description: " default-description)))
10429 (if default-description (setq desc default-description)
10430 (setq desc (or (and auto-desc desc)
10431 (read-string "Description: " desc)))))
10433 (unless (string-match "\\S-" desc) (setq desc nil))
10434 (if remove (apply 'delete-region remove))
10435 (insert (org-make-link-string link desc))))
10437 (defun org-link-try-special-completion (type)
10438 "If there is completion support for link type TYPE, offer it."
10439 (let ((fun (intern (concat "org-" type "-complete-link"))))
10440 (if (functionp fun)
10441 (funcall fun)
10442 (read-string "Link (no completion support): " (concat type ":")))))
10444 (defun org-file-complete-link (&optional arg)
10445 "Create a file link using completion."
10446 (let (file link)
10447 (setq file (org-iread-file-name "File: "))
10448 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10449 (pwd1 (file-name-as-directory (abbreviate-file-name
10450 (expand-file-name ".")))))
10451 (cond
10452 ((equal arg '(16))
10453 (setq link (concat
10454 "file:"
10455 (abbreviate-file-name (expand-file-name file)))))
10456 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10457 (setq link (concat "file:" (match-string 1 file))))
10458 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10459 (expand-file-name file))
10460 (setq link (concat
10461 "file:" (match-string 1 (expand-file-name file)))))
10462 (t (setq link (concat "file:" file)))))
10463 link))
10465 (defun org-iread-file-name (&rest args)
10466 "Read-file-name using `ido-mode' speedup if available.
10467 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10468 See `read-file-name' for a description of parameters."
10469 (org-without-partial-completion
10470 (if (and org-completion-use-ido
10471 (fboundp 'ido-read-file-name)
10472 (boundp 'ido-mode) ido-mode
10473 (listp (second args)))
10474 (let ((ido-enter-matching-directory nil))
10475 (apply 'ido-read-file-name args))
10476 (apply 'read-file-name args))))
10478 (defun org-completing-read (&rest args)
10479 "Completing-read with SPACE being a normal character."
10480 (let ((enable-recursive-minibuffers t)
10481 (minibuffer-local-completion-map
10482 (copy-keymap minibuffer-local-completion-map)))
10483 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10484 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10485 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10486 (apply 'org-icompleting-read args)))
10488 (defun org-completing-read-no-i (&rest args)
10489 (let (org-completion-use-ido org-completion-use-iswitchb)
10490 (apply 'org-completing-read args)))
10492 (defun org-iswitchb-completing-read (prompt choices &rest args)
10493 "Use iswitch as a completing-read replacement to choose from choices.
10494 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10495 from."
10496 (let* ((iswitchb-use-virtual-buffers nil)
10497 (iswitchb-make-buflist-hook
10498 (lambda ()
10499 (setq iswitchb-temp-buflist choices))))
10500 (iswitchb-read-buffer prompt)))
10502 (defun org-icompleting-read (&rest args)
10503 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10504 (org-without-partial-completion
10505 (if (and org-completion-use-ido
10506 (fboundp 'ido-completing-read)
10507 (boundp 'ido-mode) ido-mode
10508 (listp (second args)))
10509 (let ((ido-enter-matching-directory nil))
10510 (apply 'ido-completing-read (concat (car args))
10511 (if (consp (car (nth 1 args)))
10512 (mapcar 'car (nth 1 args))
10513 (nth 1 args))
10514 (cddr args)))
10515 (if (and org-completion-use-iswitchb
10516 (boundp 'iswitchb-mode) iswitchb-mode
10517 (listp (second args)))
10518 (apply 'org-iswitchb-completing-read (concat (car args))
10519 (if (consp (car (nth 1 args)))
10520 (mapcar 'car (nth 1 args))
10521 (nth 1 args))
10522 (cddr args))
10523 (apply 'completing-read args)))))
10525 (defun org-extract-attributes (s)
10526 "Extract the attributes cookie from a string and set as text property."
10527 (let (a attr (start 0) key value)
10528 (save-match-data
10529 (when (string-match "{{\\([^}]+\\)}}$" s)
10530 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10531 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10532 (setq key (match-string 1 a) value (match-string 2 a)
10533 start (match-end 0)
10534 attr (plist-put attr (intern key) value))))
10535 (org-add-props s nil 'org-attr attr))
10538 ;;; Opening/following a link
10540 (defvar org-link-search-failed nil)
10542 (defvar org-open-link-functions nil
10543 "Hook for functions finding a plain text link.
10544 These functions must take a single argument, the link content.
10545 They will be called for links that look like [[link text][description]]
10546 when LINK TEXT does not have a protocol like \"http:\" and does not look
10547 like a filename (e.g. \"./blue.png\").
10549 These functions will be called *before* Org attempts to resolve the
10550 link by doing text searches in the current buffer - so if you want a
10551 link \"[[target]]\" to still find \"<<target>>\", your function should
10552 handle this as a special case.
10554 When the function does handle the link, it must return a non-nil value.
10555 If it decides that it is not responsible for this link, it must return
10556 nil to indicate that that Org-mode can continue with other options
10557 like exact and fuzzy text search.")
10559 (defun org-next-link (&optional search-backward)
10560 "Move forward to the next link.
10561 If the link is in hidden text, expose it."
10562 (interactive "P")
10563 (when (and org-link-search-failed (eq this-command last-command))
10564 (goto-char (point-min))
10565 (message "Link search wrapped back to beginning of buffer"))
10566 (setq org-link-search-failed nil)
10567 (let* ((pos (point))
10568 (ct (org-context))
10569 (a (assoc :link ct))
10570 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10571 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10572 ((looking-at org-any-link-re)
10573 ;; Don't stay stuck at link without an org-link face
10574 (forward-char (if search-backward -1 1))))
10575 (if (funcall srch-fun org-any-link-re nil t)
10576 (progn
10577 (goto-char (match-beginning 0))
10578 (if (outline-invisible-p) (org-show-context)))
10579 (goto-char pos)
10580 (setq org-link-search-failed t)
10581 (message "No further link found"))))
10583 (defun org-previous-link ()
10584 "Move backward to the previous link.
10585 If the link is in hidden text, expose it."
10586 (interactive)
10587 (funcall 'org-next-link t))
10589 (defun org-translate-link (s)
10590 "Translate a link string if a translation function has been defined."
10591 (if (and org-link-translation-function
10592 (fboundp org-link-translation-function)
10593 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10594 (progn
10595 (setq s (funcall org-link-translation-function
10596 (match-string 1 s) (match-string 2 s)))
10597 (concat (car s) ":" (cdr s)))
10600 (defun org-translate-link-from-planner (type path)
10601 "Translate a link from Emacs Planner syntax so that Org can follow it.
10602 This is still an experimental function, your mileage may vary."
10603 (cond
10604 ((member type '("http" "https" "news" "ftp"))
10605 ;; standard Internet links are the same.
10606 nil)
10607 ((and (equal type "irc") (string-match "^//" path))
10608 ;; Planner has two / at the beginning of an irc link, we have 1.
10609 ;; We should have zero, actually....
10610 (setq path (substring path 1)))
10611 ((and (equal type "lisp") (string-match "^/" path))
10612 ;; Planner has a slash, we do not.
10613 (setq type "elisp" path (substring path 1)))
10614 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10615 ;; A typical message link. Planner has the id after the final slash,
10616 ;; we separate it with a hash mark
10617 (setq path (concat (match-string 1 path) "#"
10618 (org-remove-angle-brackets (match-string 2 path))))))
10619 (cons type path))
10621 (defun org-find-file-at-mouse (ev)
10622 "Open file link or URL at mouse."
10623 (interactive "e")
10624 (mouse-set-point ev)
10625 (org-open-at-point 'in-emacs))
10627 (defun org-open-at-mouse (ev)
10628 "Open file link or URL at mouse.
10629 See the docstring of `org-open-file' for details."
10630 (interactive "e")
10631 (mouse-set-point ev)
10632 (if (eq major-mode 'org-agenda-mode)
10633 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10634 (org-open-at-point))
10636 (defvar org-window-config-before-follow-link nil
10637 "The window configuration before following a link.
10638 This is saved in case the need arises to restore it.")
10640 (defvar org-open-link-marker (make-marker)
10641 "Marker pointing to the location where `org-open-at-point' was called.")
10643 ;;;###autoload
10644 (defun org-open-at-point-global ()
10645 "Follow a link like Org-mode does.
10646 This command can be called in any mode to follow a link that has
10647 Org-mode syntax."
10648 (interactive)
10649 (org-run-like-in-org-mode 'org-open-at-point))
10651 ;;;###autoload
10652 (defun org-open-link-from-string (s &optional arg reference-buffer)
10653 "Open a link in the string S, as if it was in Org-mode."
10654 (interactive "sLink: \nP")
10655 (let ((reference-buffer (or reference-buffer (current-buffer))))
10656 (with-temp-buffer
10657 (let ((org-inhibit-startup (not reference-buffer)))
10658 (org-mode)
10659 (insert s)
10660 (goto-char (point-min))
10661 (when reference-buffer
10662 (setq org-link-abbrev-alist-local
10663 (with-current-buffer reference-buffer
10664 org-link-abbrev-alist-local)))
10665 (org-open-at-point arg reference-buffer)))))
10667 (defvar org-open-at-point-functions nil
10668 "Hook that is run when following a link at point.
10670 Functions in this hook must return t if they identify and follow
10671 a link at point. If they don't find anything interesting at point,
10672 they must return nil.")
10674 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10675 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10676 (defun org-open-at-point (&optional arg reference-buffer)
10677 "Open link, timestamp, footnote or tags at point.
10679 When point is on a link, follow it. Normally, files will be
10680 opened by an appropriate application. If the optional prefix
10681 argument ARG is non-nil, Emacs will visit the file. With
10682 a double prefix argument, try to open outside of Emacs, in the
10683 application the system uses for this file type.
10685 When point is on a timestamp, open the agenda at the day
10686 specified.
10688 When point is a footnote definition, move to the first reference
10689 found. If it is on a reference, move to the associated
10690 definition.
10692 When point is on a headline, display a list of every link in the
10693 entry, so it is possible to pick one, or all, of them. If point
10694 is on a tag, call `org-tags-view' instead.
10696 When optional argument REFERENCE-BUFFER is non-nil, it should
10697 specify a buffer from where the link search should happen. This
10698 is used internally by `org-open-link-from-string'.
10700 On top of syntactically correct links, this function will open
10701 the link at point in comments or comment blocks and the first
10702 link in a property drawer line."
10703 (interactive "P")
10704 ;; On a code block, open block's results.
10705 (unless (call-interactively 'org-babel-open-src-block-result)
10706 (org-load-modules-maybe)
10707 (move-marker org-open-link-marker (point))
10708 (setq org-window-config-before-follow-link (current-window-configuration))
10709 (org-remove-occur-highlights nil nil t)
10710 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10711 (let* ((context
10712 ;; Only consider supported types, even if they are not
10713 ;; the closest one.
10714 (org-element-lineage
10715 (org-element-context)
10716 '(comment comment-block footnote-definition footnote-reference
10717 headline inlinetask link node-property timestamp)
10719 (type (org-element-type context))
10720 (value (org-element-property :value context)))
10721 (cond
10722 ((not context) (user-error "No link found"))
10723 ;; Exception: open timestamps and links in properties drawers
10724 ;; and comments.
10725 ((memq type '(comment comment-block node-property))
10726 (cond ((org-in-regexp org-any-link-re)
10727 (org-open-link-from-string (match-string-no-properties 0)))
10728 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10729 (org-follow-timestamp-link))
10730 (t (user-error "No link found"))))
10731 ;; On a headline or an inlinetask, but not on a timestamp,
10732 ;; a link, a footnote reference or on tags.
10733 ((and (memq type '(headline inlinetask))
10734 ;; Not on tags.
10735 (progn (save-excursion (beginning-of-line)
10736 (looking-at org-complex-heading-regexp))
10737 (or (not (match-beginning 5))
10738 (< (point) (match-beginning 5)))))
10739 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10740 (links (car data))
10741 (links-end (cdr data)))
10742 (if links
10743 (dolist (link (if (stringp links) (list links) links))
10744 (search-forward link nil links-end)
10745 (goto-char (match-beginning 0))
10746 (org-open-at-point))
10747 (require 'org-attach)
10748 (org-attach-reveal 'if-exists))))
10749 ;; Do nothing on white spaces after an object, unless point
10750 ;; is right after it.
10751 ((> (point)
10752 (save-excursion
10753 (goto-char (org-element-property :end context))
10754 (skip-chars-backward " \t")
10755 (point)))
10756 (user-error "No link found"))
10757 ((eq type 'timestamp) (org-follow-timestamp-link))
10758 ;; On tags within a headline or an inlinetask.
10759 ((and (memq type '(headline inlinetask))
10760 (progn (save-excursion (beginning-of-line)
10761 (looking-at org-complex-heading-regexp))
10762 (and (match-beginning 5)
10763 (>= (point) (match-beginning 5)))))
10764 (org-tags-view arg (substring (match-string 5) 0 -1)))
10765 ((eq type 'link)
10766 ;; When link is located within the description of another
10767 ;; link (e.g., an inline image), always open the parent
10768 ;; link.
10769 (let*((link (let ((up (org-element-property :parent context)))
10770 (if (eq (org-element-type up) 'link) up context)))
10771 (type (org-element-property :type link))
10772 (path (org-link-unescape (org-element-property :path link))))
10773 ;; Switch back to REFERENCE-BUFFER needed when called in
10774 ;; a temporary buffer through `org-open-link-from-string'.
10775 (with-current-buffer (or reference-buffer (current-buffer))
10776 (cond
10777 ((equal type "file")
10778 (if (string-match "[*?{]" (file-name-nondirectory path))
10779 (dired path)
10780 ;; Look into `org-link-protocols' in order to find
10781 ;; a DEDICATED-FUNCTION to open file. The function
10782 ;; will be applied on raw link instead of parsed
10783 ;; link due to the limitation in `org-add-link-type'
10784 ;; ("open" function called with a single argument).
10785 ;; If no such function is found, fallback to
10786 ;; `org-open-file'.
10788 ;; Note : "file+emacs" and "file+sys" types are
10789 ;; hard-coded in order to escape the previous
10790 ;; limitation.
10791 (let* ((option (org-element-property :search-option link))
10792 (app (org-element-property :application link))
10793 (dedicated-function
10794 (nth 1 (assoc app org-link-protocols))))
10795 (if dedicated-function
10796 (funcall dedicated-function
10797 (concat path
10798 (and option (concat "::" option))))
10799 (apply 'org-open-file
10800 path
10801 (cond (arg)
10802 ((equal app "emacs") 'emacs)
10803 ((equal app "sys") 'system))
10804 (cond ((not option) nil)
10805 ((org-string-match-p "\\`[0-9]+\\'" option)
10806 (list (string-to-number option)))
10807 (t (list nil
10808 (org-link-unescape option)))))))))
10809 ((assoc type org-link-protocols)
10810 (funcall (nth 1 (assoc type org-link-protocols)) path))
10811 ((equal type "help")
10812 (let ((f-or-v (intern path)))
10813 (cond ((fboundp f-or-v) (describe-function f-or-v))
10814 ((boundp f-or-v) (describe-variable f-or-v))
10815 (t (error "Not a known function or variable")))))
10816 ((member type '("http" "https" "ftp" "mailto" "news"))
10817 (browse-url (org-link-escape-browser (concat type ":" path))))
10818 ((equal type "doi")
10819 (browse-url
10820 (org-link-escape-browser (concat org-doi-server-url path))))
10821 ((equal type "message") (browse-url (concat type ":" path)))
10822 ((equal type "shell")
10823 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10824 (cmd path))
10825 (if (or (and (org-string-nw-p
10826 org-confirm-shell-link-not-regexp)
10827 (string-match
10828 org-confirm-shell-link-not-regexp cmd))
10829 (not org-confirm-shell-link-function)
10830 (funcall org-confirm-shell-link-function
10831 (format "Execute \"%s\" in shell? "
10832 (org-add-props cmd nil
10833 'face 'org-warning))))
10834 (progn
10835 (message "Executing %s" cmd)
10836 (shell-command cmd buf)
10837 (when (featurep 'midnight)
10838 (setq clean-buffer-list-kill-buffer-names
10839 (cons buf
10840 clean-buffer-list-kill-buffer-names))))
10841 (user-error "Abort"))))
10842 ((equal type "elisp")
10843 (let ((cmd path))
10844 (if (or (and (org-string-nw-p
10845 org-confirm-elisp-link-not-regexp)
10846 (org-string-match-p
10847 org-confirm-elisp-link-not-regexp cmd))
10848 (not org-confirm-elisp-link-function)
10849 (funcall org-confirm-elisp-link-function
10850 (format "Execute \"%s\" as elisp? "
10851 (org-add-props cmd nil
10852 'face 'org-warning))))
10853 (message "%s => %s" cmd
10854 (if (eq (string-to-char cmd) ?\()
10855 (eval (read cmd))
10856 (call-interactively (read cmd))))
10857 (user-error "Abort"))))
10858 ((equal type "id")
10859 (require 'ord-id)
10860 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10861 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10862 (unless (run-hook-with-args-until-success
10863 'org-open-link-functions path)
10864 (if (not arg) (org-mark-ring-push)
10865 (switch-to-buffer-other-window
10866 (org-get-buffer-for-internal-link (current-buffer))))
10867 (let ((cmd `(org-link-search
10868 ,(if (member type '("custom-id" "coderef"))
10869 (org-element-property :raw-link link)
10870 path)
10871 ,(cond ((equal arg '(4)) 'occur)
10872 ((equal arg '(16)) 'org-occur))
10873 ,(org-element-property :begin link))))
10874 (condition-case nil
10875 (let ((org-link-search-inhibit-query t))
10876 (eval cmd))
10877 (error (progn (widen) (eval cmd)))))))
10878 (t (browse-url-at-point))))))
10879 ;; On a footnote reference or at a footnote definition's label.
10880 ((or (eq type 'footnote-reference)
10881 (and (eq type 'footnote-definition)
10882 (save-excursion
10883 ;; Do not validate action when point is on the
10884 ;; spaces right after the footnote label, in
10885 ;; order to be on par with behaviour on links.
10886 (skip-chars-forward " \t")
10887 (let ((begin
10888 (org-element-property :contents-begin context)))
10889 (if begin (< (point) begin)
10890 (= (org-element-property :post-affiliated context)
10891 (line-beginning-position)))))))
10892 (org-footnote-action))
10893 (t (user-error "No link found")))))
10894 (move-marker org-open-link-marker nil)
10895 (run-hook-with-args 'org-follow-link-hook)))
10897 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10898 "Offer links in the current entry and return the selected link.
10899 If there is only one link, return it.
10900 If NTH is an integer, return the NTH link found.
10901 If ZERO is a string, check also this string for a link, and if
10902 there is one, return it."
10903 (with-current-buffer buffer
10904 (save-excursion
10905 (save-restriction
10906 (widen)
10907 (goto-char marker)
10908 (let ((cnt ?0)
10909 (in-emacs (if (integerp nth) nil nth))
10910 have-zero end links link c)
10911 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10912 (push (match-string 0 zero) links)
10913 (setq cnt (1- cnt) have-zero t))
10914 (save-excursion
10915 (org-back-to-heading t)
10916 (setq end (save-excursion (outline-next-heading) (point)))
10917 (while (re-search-forward org-any-link-re end t)
10918 (push (match-string 0) links))
10919 (setq links (org-uniquify (reverse links))))
10920 (cond
10921 ((null links)
10922 (message "No links"))
10923 ((equal (length links) 1)
10924 (setq link (car links)))
10925 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10926 (setq link (nth (if have-zero nth (1- nth)) links)))
10927 (t ; we have to select a link
10928 (save-excursion
10929 (save-window-excursion
10930 (delete-other-windows)
10931 (with-output-to-temp-buffer "*Select Link*"
10932 (mapc (lambda (l)
10933 (if (not (string-match org-bracket-link-regexp l))
10934 (princ (format "[%c] %s\n" (incf cnt)
10935 (org-remove-angle-brackets l)))
10936 (if (match-end 3)
10937 (princ (format "[%c] %s (%s)\n" (incf cnt)
10938 (match-string 3 l) (match-string 1 l)))
10939 (princ (format "[%c] %s\n" (incf cnt)
10940 (match-string 1 l))))))
10941 links))
10942 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10943 (message "Select link to open, RET to open all:")
10944 (setq c (read-char-exclusive))
10945 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10946 (when (equal c ?q) (user-error "Abort"))
10947 (if (equal c ?\C-m)
10948 (setq link links)
10949 (setq nth (- c ?0))
10950 (if have-zero (setq nth (1+ nth)))
10951 (unless (and (integerp nth) (>= (length links) nth))
10952 (user-error "Invalid link selection"))
10953 (setq link (nth (1- nth) links)))))
10954 (cons link end))))))
10956 ;; TODO: These functions are deprecated since `org-open-at-point'
10957 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10958 (defun org-open-file-with-system (path)
10959 "Open file at PATH using the system way of opening it."
10960 (org-open-file path 'system))
10961 (defun org-open-file-with-emacs (path)
10962 "Open file at PATH in Emacs."
10963 (org-open-file path 'emacs))
10966 ;;; File search
10968 (defvar org-create-file-search-functions nil
10969 "List of functions to construct the right search string for a file link.
10970 These functions are called in turn with point at the location to
10971 which the link should point.
10973 A function in the hook should first test if it would like to
10974 handle this file type, for example by checking the `major-mode'
10975 or the file extension. If it decides not to handle this file, it
10976 should just return nil to give other functions a chance. If it
10977 does handle the file, it must return the search string to be used
10978 when following the link. The search string will be part of the
10979 file link, given after a double colon, and `org-open-at-point'
10980 will automatically search for it. If special measures must be
10981 taken to make the search successful, another function should be
10982 added to the companion hook `org-execute-file-search-functions',
10983 which see.
10985 A function in this hook may also use `setq' to set the variable
10986 `description' to provide a suggestion for the descriptive text to
10987 be used for this link when it gets inserted into an Org-mode
10988 buffer with \\[org-insert-link].")
10990 (defvar org-execute-file-search-functions nil
10991 "List of functions to execute a file search triggered by a link.
10993 Functions added to this hook must accept a single argument, the
10994 search string that was part of the file link, the part after the
10995 double colon. The function must first check if it would like to
10996 handle this search, for example by checking the `major-mode' or
10997 the file extension. If it decides not to handle this search, it
10998 should just return nil to give other functions a chance. If it
10999 does handle the search, it must return a non-nil value to keep
11000 other functions from trying.
11002 Each function can access the current prefix argument through the
11003 variable `current-prefix-arg'. Note that a single prefix is used
11004 to force opening a link in Emacs, so it may be good to only use a
11005 numeric or double prefix to guide the search function.
11007 In case this is needed, a function in this hook can also restore
11008 the window configuration before `org-open-at-point' was called using:
11010 (set-window-configuration org-window-config-before-follow-link)")
11012 (defun org-link-search (s &optional type avoid-pos stealth)
11013 "Search for a link search option.
11014 If S is surrounded by forward slashes, it is interpreted as a
11015 regular expression. In org-mode files, this will create an `org-occur'
11016 sparse tree. In ordinary files, `occur' will be used to list matches.
11017 If the current buffer is in `dired-mode', grep will be used to search
11018 in all files. If AVOID-POS is given, ignore matches near that position.
11020 When optional argument STEALTH is non-nil, do not modify
11021 visibility around point, thus ignoring `org-show-context-detail'
11022 variable."
11023 (let ((case-fold-search t)
11024 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
11025 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
11026 (append '(("") (" ") ("\t") ("\n"))
11027 org-emphasis-alist)
11028 "\\|") "\\)"))
11029 (pos (point))
11030 words re0 re2 re4_ re4 re5 re2a re2a_ reall)
11031 (cond
11032 ;; First check if there are any special search functions
11033 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11034 ;; Now try the builtin stuff
11035 ((and (eq (aref s0 0) ?#)
11036 (> (length s0) 1)
11037 (let ((match (org-find-property "CUSTOM_ID" (substring s0 1))))
11038 (and match (goto-char match) (setf type 'dedicated)))))
11039 ((save-excursion
11040 (goto-char (point-min))
11041 (and
11042 (re-search-forward
11043 (concat "<<" (regexp-quote s0) ">>") nil t)
11044 (setq type 'dedicated
11045 pos (match-beginning 0))))
11046 ;; There is an exact target for this
11047 (goto-char pos))
11048 ((save-excursion
11049 (goto-char (point-min))
11050 (and
11051 (re-search-forward
11052 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11053 (setq type 'dedicated pos (match-beginning 0))))
11054 ;; Found an element with a matching #+name affiliated keyword.
11055 (goto-char pos))
11056 ((and (string-match "^(\\(.*\\))$" s0)
11057 (save-excursion
11058 (goto-char (point-min))
11059 (and
11060 (re-search-forward
11061 (concat "[^[]" (regexp-quote
11062 (format org-coderef-label-format
11063 (match-string 1 s0))))
11064 nil t)
11065 (setq type 'dedicated
11066 pos (1+ (match-beginning 0))))))
11067 ;; There is a coderef target for this
11068 (goto-char pos))
11069 ((string-match "^/\\(.*\\)/$" s)
11070 ;; A regular expression
11071 (cond
11072 ((derived-mode-p 'org-mode)
11073 (org-occur (match-string 1 s)))
11074 (t (org-do-occur (match-string 1 s)))))
11075 ((and (derived-mode-p 'org-mode)
11076 (or (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11077 org-link-search-must-match-exact-headline))
11078 ;; Headline search.
11079 (goto-char (point-min))
11080 (cond
11081 ((let (case-fold-search)
11082 (re-search-forward
11083 (let* ((wspace "[ \t]")
11084 (wspaceopt (concat wspace "*"))
11085 (cookie (concat "\\(?:"
11086 wspaceopt
11087 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11088 wspaceopt
11089 "\\)"))
11090 (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)")))
11091 (concat
11092 org-outline-regexp-bol
11093 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11094 "\\(?:\\[#.\\][ \t]+\\)?"
11095 "\\(?:" org-comment-string "[ \t]+\\)?"
11096 sep "*"
11097 (mapconcat #'identity
11098 (org-split-string (regexp-quote s))
11099 (concat sep "+"))
11100 sep "*"
11101 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11102 "[ \t]*$"))
11103 nil t))
11104 ;; OK, found a match
11105 (setq type 'dedicated)
11106 (goto-char (match-beginning 0)))
11107 ((and (not org-link-search-inhibit-query)
11108 (eq org-link-search-must-match-exact-headline 'query-to-create)
11109 (y-or-n-p "No match - create this as a new heading? "))
11110 (goto-char (point-max))
11111 (unless (bolp) (newline))
11112 (org-insert-heading nil t t)
11113 (insert s "\n")
11114 (beginning-of-line 0))
11116 (goto-char pos)
11117 (error "No match"))))
11119 ;; A normal search string
11120 (remove-text-properties
11121 0 (length s)
11122 '(face nil mouse-face nil keymap nil fontified nil) s)
11123 ;; Make a series of regular expressions to find a match
11124 (setq words (org-split-string s "[ \n\r\t]+")
11126 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11127 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11128 "\\)" markers)
11129 re2a_ (concat "\\(" (mapconcat 'downcase words
11130 "[ \t\r\n]+") "\\)[ \t\r\n]")
11131 re2a (concat "[ \t\r\n]" re2a_)
11132 re4_ (concat "\\(" (mapconcat 'downcase words
11133 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11134 re4 (concat "[^a-zA-Z_]" re4_)
11136 re5 (concat ".*" re4)
11137 reall (concat "\\(" re0 "\\)\\|\\(" re2 "\\)\\|\\(" re4
11138 "\\)\\|\\(" re5 "\\)"))
11139 (cond
11140 ((eq type 'org-occur) (org-occur reall))
11141 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11142 (t (goto-char (point-min))
11143 (setq type 'fuzzy)
11144 (if (or (and (org-search-not-self 1 re0 nil t)
11145 (setq type 'dedicated))
11146 (org-search-not-self 1 re2 nil t)
11147 (org-search-not-self 1 re2a nil t)
11148 (org-search-not-self 1 re4 nil t)
11149 (org-search-not-self 1 re5 nil t))
11150 (goto-char (match-beginning 1))
11151 (goto-char pos)
11152 (error "No match"))))))
11153 (and (derived-mode-p 'org-mode)
11154 (not stealth)
11155 (org-show-context 'link-search))
11156 type))
11158 (defun org-search-not-self (group &rest args)
11159 "Execute `re-search-forward', but only accept matches that do not
11160 enclose the position of `org-open-link-marker'."
11161 (let ((m org-open-link-marker))
11162 (catch 'exit
11163 (while (apply 're-search-forward args)
11164 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11165 (goto-char (match-end group))
11166 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11167 (> (match-beginning 0) (marker-position m))
11168 (< (match-end 0) (marker-position m)))
11169 (save-match-data
11170 (or (not (org-in-regexp
11171 org-bracket-link-analytic-regexp 1))
11172 (not (match-end 4)) ; no description
11173 (and (<= (match-beginning 4) (point))
11174 (>= (match-end 4) (point))))))
11175 (throw 'exit (point))))))))
11177 (defun org-get-buffer-for-internal-link (buffer)
11178 "Return a buffer to be used for displaying the link target of internal links."
11179 (cond
11180 ((not org-display-internal-link-with-indirect-buffer)
11181 buffer)
11182 ((string-match "(Clone)$" (buffer-name buffer))
11183 (message "Buffer is already a clone, not making another one")
11184 ;; we also do not modify visibility in this case
11185 buffer)
11186 (t ; make a new indirect buffer for displaying the link
11187 (let* ((bn (buffer-name buffer))
11188 (ibn (concat bn "(Clone)"))
11189 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11190 (with-current-buffer ib (org-overview))
11191 ib))))
11193 (defun org-do-occur (regexp &optional cleanup)
11194 "Call the Emacs command `occur'.
11195 If CLEANUP is non-nil, remove the printout of the regular expression
11196 in the *Occur* buffer. This is useful if the regex is long and not useful
11197 to read."
11198 (occur regexp)
11199 (when cleanup
11200 (let ((cwin (selected-window)) win beg end)
11201 (when (setq win (get-buffer-window "*Occur*"))
11202 (select-window win))
11203 (goto-char (point-min))
11204 (when (re-search-forward "match[a-z]+" nil t)
11205 (setq beg (match-end 0))
11206 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11207 (setq end (1- (match-beginning 0)))))
11208 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11209 (goto-char (point-min))
11210 (select-window cwin))))
11212 ;;; The mark ring for links jumps
11214 (defvar org-mark-ring nil
11215 "Mark ring for positions before jumps in Org-mode.")
11216 (defvar org-mark-ring-last-goto nil
11217 "Last position in the mark ring used to go back.")
11218 ;; Fill and close the ring
11219 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11220 (loop for i from 1 to org-mark-ring-length do
11221 (push (make-marker) org-mark-ring))
11222 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11223 org-mark-ring)
11225 (defun org-mark-ring-push (&optional pos buffer)
11226 "Put the current position or POS into the mark ring and rotate it."
11227 (interactive)
11228 (setq pos (or pos (point)))
11229 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11230 (move-marker (car org-mark-ring)
11231 (or pos (point))
11232 (or buffer (current-buffer)))
11233 (message "%s"
11234 (substitute-command-keys
11235 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11237 (defun org-mark-ring-goto (&optional n)
11238 "Jump to the previous position in the mark ring.
11239 With prefix arg N, jump back that many stored positions. When
11240 called several times in succession, walk through the entire ring.
11241 Org-mode commands jumping to a different position in the current file,
11242 or to another Org-mode file, automatically push the old position
11243 onto the ring."
11244 (interactive "p")
11245 (let (p m)
11246 (if (eq last-command this-command)
11247 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11248 (setq p org-mark-ring))
11249 (setq org-mark-ring-last-goto p)
11250 (setq m (car p))
11251 (org-pop-to-buffer-same-window (marker-buffer m))
11252 (goto-char m)
11253 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11255 (defun org-remove-angle-brackets (s)
11256 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11257 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11259 (defun org-add-angle-brackets (s)
11260 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11261 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11263 (defun org-remove-double-quotes (s)
11264 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11265 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11268 ;;; Following specific links
11270 (defun org-follow-timestamp-link ()
11271 "Open an agenda view for the time-stamp date/range at point."
11272 (cond
11273 ((org-at-date-range-p t)
11274 (let ((org-agenda-start-on-weekday)
11275 (t1 (match-string 1))
11276 (t2 (match-string 2)) tt1 tt2)
11277 (setq tt1 (time-to-days (org-time-string-to-time t1))
11278 tt2 (time-to-days (org-time-string-to-time t2)))
11279 (let ((org-agenda-buffer-tmp-name
11280 (format "*Org Agenda(a:%s)"
11281 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11282 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11283 ((org-at-timestamp-p t)
11284 (let ((org-agenda-buffer-tmp-name
11285 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11286 (org-agenda-list nil (time-to-days (org-time-string-to-time
11287 (substring (match-string 1) 0 10)))
11288 1)))
11289 (t (error "This should not happen"))))
11292 ;;; Following file links
11293 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11294 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11295 (declare-function mailcap-mime-info
11296 "mailcap" (string &optional request no-decode))
11297 (defvar org-wait nil)
11298 (defun org-open-file (path &optional in-emacs line search)
11299 "Open the file at PATH.
11300 First, this expands any special file name abbreviations. Then the
11301 configuration variable `org-file-apps' is checked if it contains an
11302 entry for this file type, and if yes, the corresponding command is launched.
11304 If no application is found, Emacs simply visits the file.
11306 With optional prefix argument IN-EMACS, Emacs will visit the file.
11307 With a double \\[universal-argument] \\[universal-argument] \
11308 prefix arg, Org tries to avoid opening in Emacs
11309 and to use an external application to visit the file.
11311 Optional LINE specifies a line to go to, optional SEARCH a string
11312 to search for. If LINE or SEARCH is given, the file will be
11313 opened in Emacs, unless an entry from org-file-apps that makes
11314 use of groups in a regexp matches.
11316 If you want to change the way frames are used when following a
11317 link, please customize `org-link-frame-setup'.
11319 If the file does not exist, an error is thrown."
11320 (let* ((file (if (equal path "")
11321 buffer-file-name
11322 (substitute-in-file-name (expand-file-name path))))
11323 (file-apps (append org-file-apps (org-default-apps)))
11324 (apps (org-remove-if
11325 'org-file-apps-entry-match-against-dlink-p file-apps))
11326 (apps-dlink (org-remove-if-not
11327 'org-file-apps-entry-match-against-dlink-p file-apps))
11328 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11329 (dirp (if remp nil (file-directory-p file)))
11330 (file (if (and dirp org-open-directory-means-index-dot-org)
11331 (concat (file-name-as-directory file) "index.org")
11332 file))
11333 (a-m-a-p (assq 'auto-mode apps))
11334 (dfile (downcase file))
11335 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11336 (link (cond ((and (eq line nil)
11337 (eq search nil))
11338 file)
11339 (line
11340 (concat file "::" (number-to-string line)))
11341 (search
11342 (concat file "::" search))))
11343 (dlink (downcase link))
11344 (old-buffer (current-buffer))
11345 (old-pos (point))
11346 (old-mode major-mode)
11347 ext cmd link-match-data)
11348 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11349 (setq ext (match-string 1 dfile))
11350 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11351 (setq ext (match-string 1 dfile))))
11352 (cond
11353 ((member in-emacs '((16) system))
11354 (setq cmd (cdr (assoc 'system apps))))
11355 (in-emacs (setq cmd 'emacs))
11357 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11358 (and dirp (cdr (assoc 'directory apps)))
11359 ; first, try matching against apps-dlink
11360 ; if we get a match here, store the match data for later
11361 (let ((match (assoc-default dlink apps-dlink
11362 'string-match)))
11363 (if match
11364 (progn (setq link-match-data (match-data))
11365 match)
11366 (progn (setq in-emacs (or in-emacs line search))
11367 nil))) ; if we have no match in apps-dlink,
11368 ; always open the file in emacs if line or search
11369 ; is given (for backwards compatibility)
11370 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11371 'string-match)
11372 (cdr (assoc ext apps))
11373 (cdr (assoc t apps))))))
11374 (when (eq cmd 'system)
11375 (setq cmd (cdr (assoc 'system apps))))
11376 (when (eq cmd 'default)
11377 (setq cmd (cdr (assoc t apps))))
11378 (when (eq cmd 'mailcap)
11379 (require 'mailcap)
11380 (mailcap-parse-mailcaps)
11381 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11382 (command (mailcap-mime-info mime-type)))
11383 (if (stringp command)
11384 (setq cmd command)
11385 (setq cmd 'emacs))))
11386 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11387 (not (file-exists-p file))
11388 (not org-open-non-existing-files))
11389 (user-error "No such file: %s" file))
11390 (cond
11391 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11392 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11393 (while (string-match "['\"]%s['\"]" cmd)
11394 (setq cmd (replace-match "%s" t t cmd)))
11395 (while (string-match "%s" cmd)
11396 (setq cmd (replace-match
11397 (save-match-data
11398 (shell-quote-argument
11399 (convert-standard-filename file)))
11400 t t cmd)))
11402 ;; Replace "%1", "%2" etc. in command with group matches from regex
11403 (save-match-data
11404 (let ((match-index 1)
11405 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11406 (set-match-data link-match-data)
11407 (while (<= match-index number-of-groups)
11408 (let ((regex (concat "%" (number-to-string match-index)))
11409 (replace-with (match-string match-index dlink)))
11410 (while (string-match regex cmd)
11411 (setq cmd (replace-match replace-with t t cmd))))
11412 (setq match-index (+ match-index 1)))))
11414 (save-window-excursion
11415 (message "Running %s...done" cmd)
11416 (start-process-shell-command cmd nil cmd)
11417 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11418 ((or (stringp cmd)
11419 (eq cmd 'emacs))
11420 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11421 (widen)
11422 (if line (progn (org-goto-line line)
11423 (if (derived-mode-p 'org-mode)
11424 (org-reveal)))
11425 (if search (org-link-search search))))
11426 ((consp cmd)
11427 (let ((file (convert-standard-filename file)))
11428 (save-match-data
11429 (set-match-data link-match-data)
11430 (eval cmd))))
11431 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11432 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11433 (or (not (equal old-buffer (current-buffer)))
11434 (not (equal old-pos (point))))
11435 (org-mark-ring-push old-pos old-buffer))))
11437 (defun org-file-apps-entry-match-against-dlink-p (entry)
11438 "This function returns non-nil if `entry' uses a regular
11439 expression which should be matched against the whole link by
11440 org-open-file.
11442 It assumes that is the case when the entry uses a regular
11443 expression which has at least one grouping construct and the
11444 action is either a lisp form or a command string containing
11445 '%1', i.e. using at least one subexpression match as a
11446 parameter."
11447 (let ((selector (car entry))
11448 (action (cdr entry)))
11449 (if (stringp selector)
11450 (and (> (regexp-opt-depth selector) 0)
11451 (or (and (stringp action)
11452 (string-match "%[0-9]" action))
11453 (consp action)))
11454 nil)))
11456 (defun org-default-apps ()
11457 "Return the default applications for this operating system."
11458 (cond
11459 ((eq system-type 'darwin)
11460 org-file-apps-defaults-macosx)
11461 ((eq system-type 'windows-nt)
11462 org-file-apps-defaults-windowsnt)
11463 (t org-file-apps-defaults-gnu)))
11465 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11466 "Convert extensions to regular expressions in the cars of LIST.
11467 Also, weed out any non-string entries, because the return value is used
11468 only for regexp matching.
11469 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11470 point to the symbol `emacs', indicating that the file should
11471 be opened in Emacs."
11472 (append
11473 (delq nil
11474 (mapcar (lambda (x)
11475 (if (not (stringp (car x)))
11477 (if (string-match "\\W" (car x))
11479 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11480 list))
11481 (if add-auto-mode
11482 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11484 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11485 (defun org-file-remote-p (file)
11486 "Test whether FILE specifies a location on a remote system.
11487 Return non-nil if the location is indeed remote.
11489 For example, the filename \"/user@host:/foo\" specifies a location
11490 on the system \"/user@host:\"."
11491 (cond ((fboundp 'file-remote-p)
11492 (file-remote-p file))
11493 ((fboundp 'tramp-handle-file-remote-p)
11494 (tramp-handle-file-remote-p file))
11495 ((and (boundp 'ange-ftp-name-format)
11496 (string-match (car ange-ftp-name-format) file))
11497 t)))
11500 ;;;; Refiling
11502 (defun org-get-org-file ()
11503 "Read a filename, with default directory `org-directory'."
11504 (let ((default (or org-default-notes-file remember-data-file)))
11505 (read-file-name (format "File name [%s]: " default)
11506 (file-name-as-directory org-directory)
11507 default)))
11509 (defun org-notes-order-reversed-p ()
11510 "Check if the current file should receive notes in reversed order."
11511 (cond
11512 ((not org-reverse-note-order) nil)
11513 ((eq t org-reverse-note-order) t)
11514 ((not (listp org-reverse-note-order)) nil)
11515 (t (catch 'exit
11516 (let ((all org-reverse-note-order)
11517 entry)
11518 (while (setq entry (pop all))
11519 (if (string-match (car entry) buffer-file-name)
11520 (throw 'exit (cdr entry))))
11521 nil)))))
11523 (defvar org-refile-target-table nil
11524 "The list of refile targets, created by `org-refile'.")
11526 (defvar org-agenda-new-buffers nil
11527 "Buffers created to visit agenda files.")
11529 (defvar org-refile-cache nil
11530 "Cache for refile targets.")
11532 (defvar org-refile-markers nil
11533 "All the markers used for caching refile locations.")
11535 (defun org-refile-marker (pos)
11536 "Get a new refile marker, but only if caching is in use."
11537 (if (not org-refile-use-cache)
11539 (let ((m (make-marker)))
11540 (move-marker m pos)
11541 (push m org-refile-markers)
11542 m)))
11544 (defun org-refile-cache-clear ()
11545 "Clear the refile cache and disable all the markers."
11546 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11547 (setq org-refile-markers nil)
11548 (setq org-refile-cache nil)
11549 (message "Refile cache has been cleared"))
11551 (defun org-refile-cache-check-set (set)
11552 "Check if all the markers in the cache still have live buffers."
11553 (let (marker)
11554 (catch 'exit
11555 (while (and set (setq marker (nth 3 (pop set))))
11556 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11557 (when (and marker (null (marker-buffer marker)))
11558 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11559 (sit-for 3)
11560 (throw 'exit nil)))
11561 t)))
11563 (defun org-refile-cache-put (set &rest identifiers)
11564 "Push the refile targets SET into the cache, under IDENTIFIERS."
11565 (let* ((key (sha1 (prin1-to-string identifiers)))
11566 (entry (assoc key org-refile-cache)))
11567 (if entry
11568 (setcdr entry set)
11569 (push (cons key set) org-refile-cache))))
11571 (defun org-refile-cache-get (&rest identifiers)
11572 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11573 (cond
11574 ((not org-refile-cache) nil)
11575 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11577 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11578 org-refile-cache))))
11579 (and set (org-refile-cache-check-set set) set)))))
11581 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11582 "Produce a table with refile targets."
11583 (let ((case-fold-search nil)
11584 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11585 (entries (or org-refile-targets '((nil . (:level . 1)))))
11586 targets tgs txt re files f desc descre fast-path-p level pos0)
11587 (message "Getting targets...")
11588 (with-current-buffer (or default-buffer (current-buffer))
11589 (while (setq entry (pop entries))
11590 (setq files (car entry) desc (cdr entry))
11591 (setq fast-path-p nil)
11592 (cond
11593 ((null files) (setq files (list (current-buffer))))
11594 ((eq files 'org-agenda-files)
11595 (setq files (org-agenda-files 'unrestricted)))
11596 ((and (symbolp files) (fboundp files))
11597 (setq files (funcall files)))
11598 ((and (symbolp files) (boundp files))
11599 (setq files (symbol-value files))))
11600 (if (stringp files) (setq files (list files)))
11601 (cond
11602 ((eq (car desc) :tag)
11603 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11604 ((eq (car desc) :todo)
11605 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11606 ((eq (car desc) :regexp)
11607 (setq descre (cdr desc)))
11608 ((eq (car desc) :level)
11609 (setq descre (concat "^\\*\\{" (number-to-string
11610 (if org-odd-levels-only
11611 (1- (* 2 (cdr desc)))
11612 (cdr desc)))
11613 "\\}[ \t]")))
11614 ((eq (car desc) :maxlevel)
11615 (setq fast-path-p t)
11616 (setq descre (concat "^\\*\\{1," (number-to-string
11617 (if org-odd-levels-only
11618 (1- (* 2 (cdr desc)))
11619 (cdr desc)))
11620 "\\}[ \t]")))
11621 (t (error "Bad refiling target description %s" desc)))
11622 (while (setq f (pop files))
11623 (with-current-buffer
11624 (if (bufferp f) f (org-get-agenda-file-buffer f))
11626 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11627 (progn
11628 (if (bufferp f) (setq f (buffer-file-name
11629 (buffer-base-buffer f))))
11630 (setq f (and f (expand-file-name f)))
11631 (if (eq org-refile-use-outline-path 'file)
11632 (push (list (file-name-nondirectory f) f nil nil) tgs))
11633 (save-excursion
11634 (save-restriction
11635 (widen)
11636 (goto-char (point-min))
11637 (while (re-search-forward descre nil t)
11638 (goto-char (setq pos0 (point-at-bol)))
11639 (catch 'next
11640 (when org-refile-target-verify-function
11641 (save-match-data
11642 (or (funcall org-refile-target-verify-function)
11643 (throw 'next t))))
11644 (when (and (looking-at org-complex-heading-regexp)
11645 (not (member (match-string 4) excluded-entries))
11646 (match-string 4))
11647 (setq level (org-reduced-level
11648 (- (match-end 1) (match-beginning 1)))
11649 txt (org-link-display-format (match-string 4))
11650 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11651 re (format org-complex-heading-regexp-format
11652 (regexp-quote (match-string 4))))
11653 (when org-refile-use-outline-path
11654 (setq txt (mapconcat
11655 'org-protect-slash
11656 (append
11657 (if (eq org-refile-use-outline-path
11658 'file)
11659 (list (file-name-nondirectory
11660 (buffer-file-name
11661 (buffer-base-buffer))))
11662 (if (eq org-refile-use-outline-path
11663 'full-file-path)
11664 (list (buffer-file-name
11665 (buffer-base-buffer)))))
11666 (org-get-outline-path fast-path-p
11667 level txt)
11668 (list txt))
11669 "/")))
11670 (push (list txt f re (org-refile-marker (point)))
11671 tgs)))
11672 (when (= (point) pos0)
11673 ;; verification function has not moved point
11674 (goto-char (point-at-eol))))))))
11675 (when org-refile-use-cache
11676 (org-refile-cache-put tgs (buffer-file-name) descre))
11677 (setq targets (append tgs targets))))))
11678 (message "Getting targets...done")
11679 (nreverse targets)))
11681 (defun org-protect-slash (s)
11682 (while (string-match "/" s)
11683 (setq s (replace-match "\\" t t s)))
11686 (defvar org-olpa (make-vector 20 nil))
11688 (defun org-get-outline-path (&optional fastp level heading)
11689 "Return the outline path to the current entry, as a list.
11691 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11692 routine which makes outline path derivations for an entire file,
11693 avoiding backtracing. Refile target collection makes use of that."
11694 (if fastp
11695 (progn
11696 (if (> level 19)
11697 (error "Outline path failure, more than 19 levels"))
11698 (loop for i from level upto 19 do
11699 (aset org-olpa i nil))
11700 (prog1
11701 (delq nil (append org-olpa nil))
11702 (aset org-olpa level heading)))
11703 (let (rtn case-fold-search)
11704 (save-excursion
11705 (save-restriction
11706 (widen)
11707 (while (org-up-heading-safe)
11708 (when (looking-at org-complex-heading-regexp)
11709 (push (org-trim
11710 (replace-regexp-in-string
11711 ;; Remove statistical/checkboxes cookies
11712 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11713 (org-match-string-no-properties 4)))
11714 rtn)))
11715 rtn)))))
11717 (defun org-format-outline-path (path &optional width prefix separator)
11718 "Format the outline path PATH for display.
11719 WIDTH is the maximum number of characters that is available.
11720 PREFIX is a prefix to be included in the returned string,
11721 such as the file name.
11722 SEPARATOR is inserted between the different parts of the path,
11723 the default is \"/\"."
11724 (setq width (or width 79))
11725 (if prefix (setq width (- width (length prefix))))
11726 (if (not path)
11727 (or prefix "")
11728 (let* ((nsteps (length path))
11729 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11730 (maxwidth (if (<= total-width width)
11731 10000 ;; everything fits
11732 ;; we need to shorten the level headings
11733 (/ (- width nsteps) nsteps)))
11734 (org-odd-levels-only nil)
11735 (n 0)
11736 (total (1+ (length prefix))))
11737 (setq maxwidth (max maxwidth 10))
11738 (concat prefix
11739 (if prefix (or separator "/"))
11740 (mapconcat
11741 (lambda (h)
11742 (setq n (1+ n))
11743 (if (and (= n nsteps) (< maxwidth 10000))
11744 (setq maxwidth (- total-width total)))
11745 (if (< (length h) maxwidth)
11746 (progn (setq total (+ total (length h) 1)) h)
11747 (setq h (substring h 0 (- maxwidth 2))
11748 total (+ total maxwidth 1))
11749 (if (string-match "[ \t]+\\'" h)
11750 (setq h (substring h 0 (match-beginning 0))))
11751 (setq h (concat h "..")))
11752 (org-add-props h nil 'face
11753 (nth (% (1- n) org-n-level-faces)
11754 org-level-faces))
11756 path (or separator "/"))))))
11758 (defun org-display-outline-path (&optional file current separator just-return-string)
11759 "Display the current outline path in the echo area.
11761 If FILE is non-nil, prepend the output with the file name.
11762 If CURRENT is non-nil, append the current heading to the output.
11763 SEPARATOR is passed through to `org-format-outline-path'. It separates
11764 the different parts of the path and defaults to \"/\".
11765 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11766 (interactive "P")
11767 (let* (case-fold-search
11768 (bfn (buffer-file-name (buffer-base-buffer)))
11769 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11770 res)
11771 (if current (setq path (append path
11772 (save-excursion
11773 (org-back-to-heading t)
11774 (if (looking-at org-complex-heading-regexp)
11775 (list (match-string 4)))))))
11776 (setq res
11777 (org-format-outline-path
11778 path
11779 (1- (frame-width))
11780 (and file bfn (concat (file-name-nondirectory bfn) separator))
11781 separator))
11782 (if just-return-string
11783 (org-no-properties res)
11784 (org-unlogged-message "%s" res))))
11786 (defvar org-refile-history nil
11787 "History for refiling operations.")
11789 (defvar org-after-refile-insert-hook nil
11790 "Hook run after `org-refile' has inserted its stuff at the new location.
11791 Note that this is still *before* the stuff will be removed from
11792 the *old* location.")
11794 (defvar org-capture-last-stored-marker)
11795 (defvar org-refile-keep nil
11796 "Non-nil means `org-refile' will copy instead of refile.")
11798 (defun org-copy ()
11799 "Like `org-refile', but copy."
11800 (interactive)
11801 (let ((org-refile-keep t))
11802 (funcall 'org-refile nil nil nil "Copy")))
11804 (defun org-refile (&optional arg default-buffer rfloc msg)
11805 "Move the entry or entries at point to another heading.
11806 The list of target headings is compiled using the information in
11807 `org-refile-targets', which see.
11809 At the target location, the entry is filed as a subitem of the
11810 target heading. Depending on `org-reverse-note-order', the new
11811 subitem will either be the first or the last subitem.
11813 If there is an active region, all entries in that region will be
11814 refiled. However, the region must fulfill the requirement that
11815 the first heading sets the top-level of the moved text.
11817 With prefix arg ARG, the command will only visit the target
11818 location and not actually move anything.
11820 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11821 refiling operation has put the subtree.
11823 With a numeric prefix argument of `2', refile to the running clock.
11825 With a numeric prefix argument of `3', emulate `org-refile-keep'
11826 being set to `t' and copy to the target location, don't move it.
11827 Beware that keeping refiled entries may result in duplicated ID
11828 properties.
11830 RFLOC can be a refile location obtained in a different way.
11832 MSG is a string to replace \"Refile\" in the default prompt with
11833 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11835 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11837 If you are using target caching (see `org-refile-use-cache'), you
11838 have to clear the target cache in order to find new targets.
11839 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11840 prefix argument (`C-u C-u C-u C-c C-w')."
11841 (interactive "P")
11842 (if (member arg '(0 (64)))
11843 (org-refile-cache-clear)
11844 (let* ((actionmsg (cond (msg msg)
11845 ((equal arg 3) "Refile (and keep)")
11846 (t "Refile")))
11847 (cbuf (current-buffer))
11848 (regionp (org-region-active-p))
11849 (region-start (and regionp (region-beginning)))
11850 (region-end (and regionp (region-end)))
11851 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11852 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11853 pos it nbuf file re level reversed)
11854 (setq last-command nil)
11855 (when regionp
11856 (goto-char region-start)
11857 (or (bolp) (goto-char (point-at-bol)))
11858 (setq region-start (point))
11859 (unless (or (org-kill-is-subtree-p
11860 (buffer-substring region-start region-end))
11861 (prog1 org-refile-active-region-within-subtree
11862 (let ((s (point-at-eol)))
11863 (org-toggle-heading)
11864 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11865 (user-error "The region is not a (sequence of) subtree(s)")))
11866 (if (equal arg '(16))
11867 (org-refile-goto-last-stored)
11868 (when (or
11869 (and (equal arg 2)
11870 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11871 (prog1
11872 (setq it (list (or org-clock-heading "running clock")
11873 (buffer-file-name
11874 (marker-buffer org-clock-hd-marker))
11876 (marker-position org-clock-hd-marker)))
11877 (setq arg nil)))
11878 (setq it (or rfloc
11879 (let (heading-text)
11880 (save-excursion
11881 (unless (and arg (listp arg))
11882 (org-back-to-heading t)
11883 (setq heading-text
11884 (replace-regexp-in-string
11885 org-bracket-link-regexp
11886 "\\3"
11887 (nth 4 (org-heading-components)))))
11888 (org-refile-get-location
11889 (cond ((and arg (listp arg)) "Goto")
11890 (regionp (concat actionmsg " region to"))
11891 (t (concat actionmsg " subtree \""
11892 heading-text "\" to")))
11893 default-buffer
11894 (and (not (equal '(4) arg))
11895 org-refile-allow-creating-parent-nodes)
11896 arg))))))
11897 (setq file (nth 1 it)
11898 re (nth 2 it)
11899 pos (nth 3 it))
11900 (if (and (not arg)
11902 (equal (buffer-file-name) file)
11903 (if regionp
11904 (and (>= pos region-start)
11905 (<= pos region-end))
11906 (and (>= pos (point))
11907 (< pos (save-excursion
11908 (org-end-of-subtree t t))))))
11909 (error "Cannot refile to position inside the tree or region"))
11910 (setq nbuf (or (find-buffer-visiting file)
11911 (find-file-noselect file)))
11912 (if (and arg (not (equal arg 3)))
11913 (progn
11914 (org-pop-to-buffer-same-window nbuf)
11915 (goto-char pos)
11916 (org-show-context 'org-goto))
11917 (if regionp
11918 (progn
11919 (org-kill-new (buffer-substring region-start region-end))
11920 (org-save-markers-in-region region-start region-end))
11921 (org-copy-subtree 1 nil t))
11922 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11923 (find-file-noselect file)))
11924 (setq reversed (org-notes-order-reversed-p))
11925 (save-excursion
11926 (save-restriction
11927 (widen)
11928 (if pos
11929 (progn
11930 (goto-char pos)
11931 (looking-at org-outline-regexp)
11932 (setq level (org-get-valid-level (funcall outline-level) 1))
11933 (goto-char
11934 (if reversed
11935 (or (outline-next-heading) (point-max))
11936 (or (save-excursion (org-get-next-sibling))
11937 (org-end-of-subtree t t)
11938 (point-max)))))
11939 (setq level 1)
11940 (if (not reversed)
11941 (goto-char (point-max))
11942 (goto-char (point-min))
11943 (or (outline-next-heading) (goto-char (point-max)))))
11944 (if (not (bolp)) (newline))
11945 (org-paste-subtree level nil nil t)
11946 (when org-log-refile
11947 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11948 (unless (eq org-log-refile 'note)
11949 (save-excursion (org-add-log-note))))
11950 (and org-auto-align-tags
11951 (let ((org-loop-over-headlines-in-active-region nil))
11952 (org-set-tags nil t)))
11953 (let ((bookmark-name (plist-get org-bookmark-names-plist
11954 :last-refile)))
11955 (when bookmark-name
11956 (with-demoted-errors
11957 (bookmark-set bookmark-name))))
11958 ;; If we are refiling for capture, make sure that the
11959 ;; last-capture pointers point here
11960 (when (org-bound-and-true-p org-refile-for-capture)
11961 (let ((bookmark-name (plist-get org-bookmark-names-plist
11962 :last-capture-marker)))
11963 (when bookmark-name
11964 (with-demoted-errors
11965 (bookmark-set bookmark-name))))
11966 (move-marker org-capture-last-stored-marker (point)))
11967 (if (fboundp 'deactivate-mark) (deactivate-mark))
11968 (run-hooks 'org-after-refile-insert-hook))))
11969 (unless org-refile-keep
11970 (if regionp
11971 (delete-region (point) (+ (point) (- region-end region-start)))
11972 (delete-region
11973 (and (org-back-to-heading t) (point))
11974 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11975 (when (featurep 'org-inlinetask)
11976 (org-inlinetask-remove-END-maybe))
11977 (setq org-markers-to-move nil)
11978 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11980 (defun org-refile-goto-last-stored ()
11981 "Go to the location where the last refile was stored."
11982 (interactive)
11983 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11984 (message "This is the location of the last refile"))
11986 (defun org-refile--get-location (refloc tbl)
11987 "When user refile to REFLOC, find the associated target in TBL.
11988 Also check `org-refile-target-table'."
11989 (car (delq
11991 (mapcar
11992 (lambda (r) (or (assoc r tbl)
11993 (assoc r org-refile-target-table)))
11994 (list (replace-regexp-in-string "/$" "" refloc)
11995 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11997 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11998 no-exclude)
11999 "Prompt the user for a refile location, using PROMPT.
12000 PROMPT should not be suffixed with a colon and a space, because
12001 this function appends the default value from
12002 `org-refile-history' automatically, if that is not empty.
12003 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12004 this is used for the GOTO interface."
12005 (let ((org-refile-targets org-refile-targets)
12006 (org-refile-use-outline-path org-refile-use-outline-path)
12007 excluded-entries)
12008 (when (and (derived-mode-p 'org-mode)
12009 (not org-refile-use-cache)
12010 (not no-exclude))
12011 (org-map-tree
12012 (lambda()
12013 (setq excluded-entries
12014 (append excluded-entries (list (org-get-heading t t)))))))
12015 (setq org-refile-target-table
12016 (org-refile-get-targets default-buffer excluded-entries)))
12017 (unless org-refile-target-table
12018 (user-error "No refile targets"))
12019 (let* ((cbuf (current-buffer))
12020 (partial-completion-mode nil)
12021 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12022 (cfunc (if (and org-refile-use-outline-path
12023 org-outline-path-complete-in-steps)
12024 'org-olpath-completing-read
12025 'org-icompleting-read))
12026 (extra (if org-refile-use-outline-path "/" ""))
12027 (cbnex (concat (buffer-name) extra))
12028 (filename (and cfn (expand-file-name cfn)))
12029 (tbl (mapcar
12030 (lambda (x)
12031 (if (and (not (member org-refile-use-outline-path
12032 '(file full-file-path)))
12033 (not (equal filename (nth 1 x))))
12034 (cons (concat (car x) extra " ("
12035 (file-name-nondirectory (nth 1 x)) ")")
12036 (cdr x))
12037 (cons (concat (car x) extra) (cdr x))))
12038 org-refile-target-table))
12039 (completion-ignore-case t)
12040 cdef
12041 (prompt (concat prompt
12042 (or (and (car org-refile-history)
12043 (concat " (default " (car org-refile-history) ")"))
12044 (and (assoc cbnex tbl) (setq cdef cbnex)
12045 (concat " (default " cbnex ")"))) ": "))
12046 pa answ parent-target child parent old-hist)
12047 (setq old-hist org-refile-history)
12048 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12049 nil 'org-refile-history (or cdef (car org-refile-history))))
12050 (if (setq pa (org-refile--get-location answ tbl))
12051 (progn
12052 (org-refile-check-position pa)
12053 (when (or (not org-refile-history)
12054 (not (eq old-hist org-refile-history))
12055 (not (equal (car pa) (car org-refile-history))))
12056 (setq org-refile-history
12057 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12058 org-refile-history
12059 (cdr org-refile-history))))
12060 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12061 (pop org-refile-history)))
12063 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12064 (progn
12065 (setq parent (match-string 1 answ)
12066 child (match-string 2 answ))
12067 (setq parent-target (org-refile--get-location parent tbl))
12068 (when (and parent-target
12069 (or (eq new-nodes t)
12070 (and (eq new-nodes 'confirm)
12071 (y-or-n-p (format "Create new node \"%s\"? "
12072 child)))))
12073 (org-refile-new-child parent-target child)))
12074 (user-error "Invalid target location")))))
12076 (declare-function org-string-nw-p "org-macs" (s))
12077 (defun org-refile-check-position (refile-pointer)
12078 "Check if the refile pointer matches the headline to which it points."
12079 (let* ((file (nth 1 refile-pointer))
12080 (re (nth 2 refile-pointer))
12081 (pos (nth 3 refile-pointer))
12082 buffer)
12083 (if (and (not (markerp pos)) (not file))
12084 (user-error "Please indicate a target file in the refile path")
12085 (when (org-string-nw-p re)
12086 (setq buffer (if (markerp pos)
12087 (marker-buffer pos)
12088 (or (find-buffer-visiting file)
12089 (find-file-noselect file))))
12090 (with-current-buffer buffer
12091 (save-excursion
12092 (save-restriction
12093 (widen)
12094 (goto-char pos)
12095 (beginning-of-line 1)
12096 (unless (org-looking-at-p re)
12097 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12099 (defun org-refile-new-child (parent-target child)
12100 "Use refile target PARENT-TARGET to add new CHILD below it."
12101 (unless parent-target
12102 (error "Cannot find parent for new node"))
12103 (let ((file (nth 1 parent-target))
12104 (pos (nth 3 parent-target))
12105 level)
12106 (with-current-buffer (or (find-buffer-visiting file)
12107 (find-file-noselect file))
12108 (save-excursion
12109 (save-restriction
12110 (widen)
12111 (if pos
12112 (goto-char pos)
12113 (goto-char (point-max))
12114 (if (not (bolp)) (newline)))
12115 (when (looking-at org-outline-regexp)
12116 (setq level (funcall outline-level))
12117 (org-end-of-subtree t t))
12118 (org-back-over-empty-lines)
12119 (insert "\n" (make-string
12120 (if pos (org-get-valid-level level 1) 1) ?*)
12121 " " child "\n")
12122 (beginning-of-line 0)
12123 (list (concat (car parent-target) "/" child) file "" (point)))))))
12125 (defun org-olpath-completing-read (prompt collection &rest args)
12126 "Read an outline path like a file name."
12127 (let ((thetable collection)
12128 (org-completion-use-ido nil) ; does not work with ido.
12129 (org-completion-use-iswitchb nil)) ; or iswitchb
12130 (apply
12131 'org-icompleting-read prompt
12132 (lambda (string predicate &optional flag)
12133 (let (rtn r f (l (length string)))
12134 (cond
12135 ((eq flag nil)
12136 ;; try completion
12137 (try-completion string thetable))
12138 ((eq flag t)
12139 ;; all-completions
12140 (setq rtn (all-completions string thetable predicate))
12141 (mapcar
12142 (lambda (x)
12143 (setq r (substring x l))
12144 (if (string-match " ([^)]*)$" x)
12145 (setq f (match-string 0 x))
12146 (setq f ""))
12147 (if (string-match "/" r)
12148 (concat string (substring r 0 (match-end 0)) f)
12150 rtn))
12151 ((eq flag 'lambda)
12152 ;; exact match?
12153 (assoc string thetable)))))
12154 args)))
12156 ;;;; Dynamic blocks
12158 (defun org-find-dblock (name)
12159 "Find the first dynamic block with name NAME in the buffer.
12160 If not found, stay at current position and return nil."
12161 (let ((case-fold-search t) pos)
12162 (save-excursion
12163 (goto-char (point-min))
12164 (setq pos (and (re-search-forward
12165 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12166 (match-beginning 0))))
12167 (if pos (goto-char pos))
12168 pos))
12170 (defun org-create-dblock (plist)
12171 "Create a dynamic block section, with parameters taken from PLIST.
12172 PLIST must contain a :name entry which is used as the name of the block."
12173 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12174 (end-of-line 1)
12175 (newline))
12176 (let ((col (current-column))
12177 (name (plist-get plist :name)))
12178 (insert "#+BEGIN: " name)
12179 (while plist
12180 (if (eq (car plist) :name)
12181 (setq plist (cddr plist))
12182 (insert " " (prin1-to-string (pop plist)))))
12183 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12184 (beginning-of-line -2)))
12186 (defun org-prepare-dblock ()
12187 "Prepare dynamic block for refresh.
12188 This empties the block, puts the cursor at the insert position and returns
12189 the property list including an extra property :name with the block name."
12190 (unless (looking-at org-dblock-start-re)
12191 (user-error "Not at a dynamic block"))
12192 (let* ((begdel (1+ (match-end 0)))
12193 (name (org-no-properties (match-string 1)))
12194 (params (append (list :name name)
12195 (read (concat "(" (match-string 3) ")")))))
12196 (save-excursion
12197 (beginning-of-line 1)
12198 (skip-chars-forward " \t")
12199 (setq params (plist-put params :indentation-column (current-column))))
12200 (unless (re-search-forward org-dblock-end-re nil t)
12201 (error "Dynamic block not terminated"))
12202 (setq params
12203 (append params
12204 (list :content (buffer-substring
12205 begdel (match-beginning 0)))))
12206 (delete-region begdel (match-beginning 0))
12207 (goto-char begdel)
12208 (open-line 1)
12209 params))
12211 (defun org-map-dblocks (&optional command)
12212 "Apply COMMAND to all dynamic blocks in the current buffer.
12213 If COMMAND is not given, use `org-update-dblock'."
12214 (let ((cmd (or command 'org-update-dblock)))
12215 (save-excursion
12216 (goto-char (point-min))
12217 (while (re-search-forward org-dblock-start-re nil t)
12218 (goto-char (match-beginning 0))
12219 (save-excursion
12220 (condition-case nil
12221 (funcall cmd)
12222 (error (message "Error during update of dynamic block"))))
12223 (unless (re-search-forward org-dblock-end-re nil t)
12224 (error "Dynamic block not terminated"))))))
12226 (defun org-dblock-update (&optional arg)
12227 "User command for updating dynamic blocks.
12228 Update the dynamic block at point. With prefix ARG, update all dynamic
12229 blocks in the buffer."
12230 (interactive "P")
12231 (if arg
12232 (org-update-all-dblocks)
12233 (or (looking-at org-dblock-start-re)
12234 (org-beginning-of-dblock))
12235 (org-update-dblock)))
12237 (defun org-update-dblock ()
12238 "Update the dynamic block at point.
12239 This means to empty the block, parse for parameters and then call
12240 the correct writing function."
12241 (interactive)
12242 (save-excursion
12243 (let* ((win (selected-window))
12244 (pos (point))
12245 (line (org-current-line))
12246 (params (org-prepare-dblock))
12247 (name (plist-get params :name))
12248 (indent (plist-get params :indentation-column))
12249 (cmd (intern (concat "org-dblock-write:" name))))
12250 (message "Updating dynamic block `%s' at line %d..." name line)
12251 (funcall cmd params)
12252 (message "Updating dynamic block `%s' at line %d...done" name line)
12253 (goto-char pos)
12254 (when (and indent (> indent 0))
12255 (setq indent (make-string indent ?\ ))
12256 (save-excursion
12257 (select-window win)
12258 (org-beginning-of-dblock)
12259 (forward-line 1)
12260 (while (not (looking-at org-dblock-end-re))
12261 (insert indent)
12262 (beginning-of-line 2))
12263 (when (looking-at org-dblock-end-re)
12264 (and (looking-at "[ \t]+")
12265 (replace-match ""))
12266 (insert indent)))))))
12268 (defun org-beginning-of-dblock ()
12269 "Find the beginning of the dynamic block at point.
12270 Error if there is no such block at point."
12271 (let ((pos (point))
12272 beg)
12273 (end-of-line 1)
12274 (if (and (re-search-backward org-dblock-start-re nil t)
12275 (setq beg (match-beginning 0))
12276 (re-search-forward org-dblock-end-re nil t)
12277 (> (match-end 0) pos))
12278 (goto-char beg)
12279 (goto-char pos)
12280 (error "Not in a dynamic block"))))
12282 (defun org-update-all-dblocks ()
12283 "Update all dynamic blocks in the buffer.
12284 This function can be used in a hook."
12285 (interactive)
12286 (when (derived-mode-p 'org-mode)
12287 (org-map-dblocks 'org-update-dblock)))
12290 ;;;; Completion
12292 (declare-function org-export-backend-name "org-export" (cl-x))
12293 (declare-function org-export-backend-options "org-export" (cl-x))
12294 (defun org-get-export-keywords ()
12295 "Return a list of all currently understood export keywords.
12296 Export keywords include options, block names, attributes and
12297 keywords relative to each registered export back-end."
12298 (let (keywords)
12299 (dolist (backend
12300 (org-bound-and-true-p org-export--registered-backends)
12301 (delq nil keywords))
12302 ;; Back-end name (for keywords, like #+LATEX:)
12303 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12304 (dolist (option-entry (org-export-backend-options backend))
12305 ;; Back-end options.
12306 (push (nth 1 option-entry) keywords)))))
12308 (defconst org-options-keywords
12309 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12310 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12311 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12312 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12313 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12315 (defcustom org-structure-template-alist
12316 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12317 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12318 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12319 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12320 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12321 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12322 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12323 ("L" "#+LaTeX: ")
12324 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12325 ("H" "#+HTML: ")
12326 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12327 ("A" "#+ASCII: ")
12328 ("i" "#+INDEX: ?")
12329 ("I" "#+INCLUDE: %file ?"))
12330 "Structure completion elements.
12331 This is a list of abbreviation keys and values. The value gets inserted
12332 if you type `<' followed by the key and then press the completion key,
12333 usually `TAB'. %file will be replaced by a file name after prompting
12334 for the file using completion. The cursor will be placed at the position
12335 of the `?` in the template.
12336 There are two templates for each key, the first uses the original Org syntax,
12337 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12338 the default when the /org-mtags.el/ module has been loaded. See also the
12339 variable `org-mtags-prefer-muse-templates'."
12340 :group 'org-completion
12341 :type '(repeat
12342 (list
12343 (string :tag "Key")
12344 (string :tag "Template")))
12345 :version "25.1"
12346 :package-version '(Org . "8.3"))
12348 (defun org-try-structure-completion ()
12349 "Try to complete a structure template before point.
12350 This looks for strings like \"<e\" on an otherwise empty line and
12351 expands them."
12352 (let ((l (buffer-substring (point-at-bol) (point)))
12354 (when (and (looking-at "[ \t]*$")
12355 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12356 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12357 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12358 (match-beginning 1)) a)
12359 t)))
12361 (defun org-complete-expand-structure-template (start cell)
12362 "Expand a structure template."
12363 (let ((rpl (nth 1 cell))
12364 (ind ""))
12365 (delete-region start (point))
12366 (when (string-match "\\`[ \t]*#\\+" rpl)
12367 (cond
12368 ((bolp))
12369 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12370 (setq ind (buffer-substring (point-at-bol) (point))))
12371 (t (newline))))
12372 (setq start (point))
12373 (if (string-match "%file" rpl)
12374 (setq rpl (replace-match
12375 (concat
12376 "\""
12377 (save-match-data
12378 (abbreviate-file-name (read-file-name "Include file: ")))
12379 "\"")
12380 t t rpl)))
12381 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12382 (concat "\n" ind)))
12383 (insert rpl)
12384 (if (re-search-backward "\\?" start t) (delete-char 1))))
12386 ;;;; TODO, DEADLINE, Comments
12388 (defun org-toggle-comment ()
12389 "Change the COMMENT state of an entry."
12390 (interactive)
12391 (save-excursion
12392 (org-back-to-heading)
12393 (looking-at org-complex-heading-regexp)
12394 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12395 (skip-chars-forward " \t")
12396 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12397 (if (org-in-commented-heading-p t)
12398 (delete-region (point)
12399 (progn (search-forward " " (line-end-position) 'move)
12400 (skip-chars-forward " \t")
12401 (point)))
12402 (insert org-comment-string)
12403 (unless (eolp) (insert " ")))))
12405 (defvar org-last-todo-state-is-todo nil
12406 "This is non-nil when the last TODO state change led to a TODO state.
12407 If the last change removed the TODO tag or switched to DONE, then
12408 this is nil.")
12410 (defvar org-setting-tags nil) ; dynamically skipped
12412 (defvar org-todo-setup-filter-hook nil
12413 "Hook for functions that pre-filter todo specs.
12414 Each function takes a todo spec and returns either nil or the spec
12415 transformed into canonical form." )
12417 (defvar org-todo-get-default-hook nil
12418 "Hook for functions that get a default item for todo.
12419 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12420 nil or a string to be used for the todo mark." )
12422 (defvar org-agenda-headline-snapshot-before-repeat)
12424 (defun org-current-effective-time ()
12425 "Return current time adjusted for `org-extend-today-until' variable."
12426 (let* ((ct (org-current-time))
12427 (dct (decode-time ct))
12428 (ct1
12429 (cond
12430 (org-use-last-clock-out-time-as-effective-time
12431 (or (org-clock-get-last-clock-out-time) ct))
12432 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12433 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12434 (t ct))))
12435 ct1))
12437 (defun org-todo-yesterday (&optional arg)
12438 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12439 (interactive "P")
12440 (if (eq major-mode 'org-agenda-mode)
12441 (apply 'org-agenda-todo-yesterday arg)
12442 (let* ((org-use-effective-time t)
12443 (hour (third (decode-time
12444 (org-current-time))))
12445 (org-extend-today-until (1+ hour)))
12446 (org-todo arg))))
12448 (defvar org-block-entry-blocking ""
12449 "First entry preventing the TODO state change.")
12451 (defun org-cancel-repeater ()
12452 "Cancel a repeater by setting its numeric value to zero."
12453 (interactive)
12454 (save-excursion
12455 (org-back-to-heading t)
12456 (let ((bound1 (point))
12457 (bound0 (save-excursion (outline-next-heading) (point))))
12458 (when (re-search-forward
12459 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12460 org-deadline-time-regexp "\\)\\|\\("
12461 org-ts-regexp "\\)")
12462 bound0 t)
12463 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12464 (replace-match "0" t nil nil 1))))))
12466 (defun org-todo (&optional arg)
12467 "Change the TODO state of an item.
12468 The state of an item is given by a keyword at the start of the heading,
12469 like
12470 *** TODO Write paper
12471 *** DONE Call mom
12473 The different keywords are specified in the variable `org-todo-keywords'.
12474 By default the available states are \"TODO\" and \"DONE\".
12475 So for this example: when the item starts with TODO, it is changed to DONE.
12476 When it starts with DONE, the DONE is removed. And when neither TODO nor
12477 DONE are present, add TODO at the beginning of the heading.
12479 With \\[universal-argument] prefix arg, use completion to determine the new \
12480 state.
12481 With numeric prefix arg, switch to that state.
12482 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12483 keywords (nextset).
12484 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12485 With a numeric prefix arg of 0, inhibit note taking for the change.
12486 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12488 When called through ELisp, arg is also interpreted in the following way:
12489 'none -> empty state
12490 \"\"(empty string) -> switch to empty state
12491 'done -> switch to DONE
12492 'nextset -> switch to the next set of keywords
12493 'previousset -> switch to the previous set of keywords
12494 \"WAITING\" -> switch to the specified keyword, but only if it
12495 really is a member of `org-todo-keywords'."
12496 (interactive "P")
12497 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12498 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12499 'region-start-level 'region))
12500 org-loop-over-headlines-in-active-region)
12501 (org-map-entries
12502 `(org-todo ,arg)
12503 org-loop-over-headlines-in-active-region
12504 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12505 (if (equal arg '(16)) (setq arg 'nextset))
12506 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12507 (let ((org-blocker-hook org-blocker-hook)
12508 commentp
12509 case-fold-search)
12510 (when (equal arg '(64))
12511 (setq arg nil org-blocker-hook nil))
12512 (when (and org-blocker-hook
12513 (or org-inhibit-blocking
12514 (org-entry-get nil "NOBLOCKING")))
12515 (setq org-blocker-hook nil))
12516 (save-excursion
12517 (catch 'exit
12518 (org-back-to-heading t)
12519 (when (org-in-commented-heading-p t)
12520 (org-toggle-comment)
12521 (setq commentp t))
12522 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12523 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12524 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12525 (let* ((match-data (match-data))
12526 (startpos (point-at-bol))
12527 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12528 (org-log-done org-log-done)
12529 (org-log-repeat org-log-repeat)
12530 (org-todo-log-states org-todo-log-states)
12531 (org-inhibit-logging
12532 (if (equal arg 0)
12533 (progn (setq arg nil) 'note) org-inhibit-logging))
12534 (this (match-string 1))
12535 (hl-pos (match-beginning 0))
12536 (head (org-get-todo-sequence-head this))
12537 (ass (assoc head org-todo-kwd-alist))
12538 (interpret (nth 1 ass))
12539 (done-word (nth 3 ass))
12540 (final-done-word (nth 4 ass))
12541 (org-last-state (or this ""))
12542 (completion-ignore-case t)
12543 (member (member this org-todo-keywords-1))
12544 (tail (cdr member))
12545 (org-state (cond
12546 ((and org-todo-key-trigger
12547 (or (and (equal arg '(4))
12548 (eq org-use-fast-todo-selection 'prefix))
12549 (and (not arg) org-use-fast-todo-selection
12550 (not (eq org-use-fast-todo-selection
12551 'prefix)))))
12552 ;; Use fast selection
12553 (org-fast-todo-selection))
12554 ((and (equal arg '(4))
12555 (or (not org-use-fast-todo-selection)
12556 (not org-todo-key-trigger)))
12557 ;; Read a state with completion
12558 (org-icompleting-read
12559 "State: " (mapcar 'list org-todo-keywords-1)
12560 nil t))
12561 ((eq arg 'right)
12562 (if this
12563 (if tail (car tail) nil)
12564 (car org-todo-keywords-1)))
12565 ((eq arg 'left)
12566 (if (equal member org-todo-keywords-1)
12568 (if this
12569 (nth (- (length org-todo-keywords-1)
12570 (length tail) 2)
12571 org-todo-keywords-1)
12572 (org-last org-todo-keywords-1))))
12573 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12574 (setq arg nil))) ; hack to fall back to cycling
12575 (arg
12576 ;; user or caller requests a specific state
12577 (cond
12578 ((equal arg "") nil)
12579 ((eq arg 'none) nil)
12580 ((eq arg 'done) (or done-word (car org-done-keywords)))
12581 ((eq arg 'nextset)
12582 (or (car (cdr (member head org-todo-heads)))
12583 (car org-todo-heads)))
12584 ((eq arg 'previousset)
12585 (let ((org-todo-heads (reverse org-todo-heads)))
12586 (or (car (cdr (member head org-todo-heads)))
12587 (car org-todo-heads))))
12588 ((car (member arg org-todo-keywords-1)))
12589 ((stringp arg)
12590 (user-error "State `%s' not valid in this file" arg))
12591 ((nth (1- (prefix-numeric-value arg))
12592 org-todo-keywords-1))))
12593 ((null member) (or head (car org-todo-keywords-1)))
12594 ((equal this final-done-word) nil) ;; -> make empty
12595 ((null tail) nil) ;; -> first entry
12596 ((memq interpret '(type priority))
12597 (if (eq this-command last-command)
12598 (car tail)
12599 (if (> (length tail) 0)
12600 (or done-word (car org-done-keywords))
12601 nil)))
12603 (car tail))))
12604 (org-state (or
12605 (run-hook-with-args-until-success
12606 'org-todo-get-default-hook org-state org-last-state)
12607 org-state))
12608 (next (if org-state (concat " " org-state " ") " "))
12609 (change-plist (list :type 'todo-state-change :from this :to org-state
12610 :position startpos))
12611 dolog now-done-p)
12612 (when org-blocker-hook
12613 (setq org-last-todo-state-is-todo
12614 (not (member this org-done-keywords)))
12615 (unless (save-excursion
12616 (save-match-data
12617 (org-with-wide-buffer
12618 (run-hook-with-args-until-failure
12619 'org-blocker-hook change-plist))))
12620 (if (org-called-interactively-p 'interactive)
12621 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12622 this org-state org-block-entry-blocking)
12623 ;; fail silently
12624 (message "TODO state change from %s to %s blocked (by \"%s\")"
12625 this org-state org-block-entry-blocking)
12626 (throw 'exit nil))))
12627 (store-match-data match-data)
12628 (replace-match next t t)
12629 (cond ((equal this org-state)
12630 (message "TODO state was already %s" (org-trim next)))
12631 ((pos-visible-in-window-p hl-pos)
12632 (message "TODO state changed to %s" (org-trim next))))
12633 (unless head
12634 (setq head (org-get-todo-sequence-head org-state)
12635 ass (assoc head org-todo-kwd-alist)
12636 interpret (nth 1 ass)
12637 done-word (nth 3 ass)
12638 final-done-word (nth 4 ass)))
12639 (when (memq arg '(nextset previousset))
12640 (message "Keyword-Set %d/%d: %s"
12641 (- (length org-todo-sets) -1
12642 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12643 (length org-todo-sets)
12644 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12645 (setq org-last-todo-state-is-todo
12646 (not (member org-state org-done-keywords)))
12647 (setq now-done-p (and (member org-state org-done-keywords)
12648 (not (member this org-done-keywords))))
12649 (and logging (org-local-logging logging))
12650 (when (and (or org-todo-log-states org-log-done)
12651 (not (eq org-inhibit-logging t))
12652 (not (memq arg '(nextset previousset))))
12653 ;; we need to look at recording a time and note
12654 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12655 (nth 2 (assoc this org-todo-log-states))))
12656 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12657 (setq dolog 'time))
12658 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12659 (and org-state
12660 (member org-state org-not-done-keywords)
12661 (not (member this org-not-done-keywords))))
12662 ;; This is now a todo state and was not one before
12663 ;; If there was a CLOSED time stamp, get rid of it.
12664 (org-add-planning-info nil nil 'closed))
12665 (when (and now-done-p org-log-done)
12666 ;; It is now done, and it was not done before
12667 (org-add-planning-info 'closed (org-current-effective-time))
12668 (if (and (not dolog) (eq 'note org-log-done))
12669 (org-add-log-setup 'done org-state this 'findpos 'note)))
12670 (when (and org-state dolog)
12671 ;; This is a non-nil state, and we need to log it
12672 (org-add-log-setup 'state org-state this 'findpos dolog)))
12673 ;; Fixup tag positioning
12674 (org-todo-trigger-tag-changes org-state)
12675 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12676 (when org-provide-todo-statistics
12677 (org-update-parent-todo-statistics))
12678 (run-hooks 'org-after-todo-state-change-hook)
12679 (if (and arg (not (member org-state org-done-keywords)))
12680 (setq head (org-get-todo-sequence-head org-state)))
12681 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12682 ;; Do we need to trigger a repeat?
12683 (when now-done-p
12684 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12685 ;; This is for the agenda, take a snapshot of the headline.
12686 (save-match-data
12687 (setq org-agenda-headline-snapshot-before-repeat
12688 (org-get-heading))))
12689 (org-auto-repeat-maybe org-state))
12690 ;; Fixup cursor location if close to the keyword
12691 (if (and (outline-on-heading-p)
12692 (not (bolp))
12693 (save-excursion (beginning-of-line 1)
12694 (looking-at org-todo-line-regexp))
12695 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12696 (progn
12697 (goto-char (or (match-end 2) (match-end 1)))
12698 (and (looking-at " ") (just-one-space))))
12699 (when org-trigger-hook
12700 (save-excursion
12701 (run-hook-with-args 'org-trigger-hook change-plist)))
12702 (when commentp (org-toggle-comment))))))))
12704 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12705 "Block turning an entry into a TODO, using the hierarchy.
12706 This checks whether the current task should be blocked from state
12707 changes. Such blocking occurs when:
12709 1. The task has children which are not all in a completed state.
12711 2. A task has a parent with the property :ORDERED:, and there
12712 are siblings prior to the current task with incomplete
12713 status.
12715 3. The parent of the task is blocked because it has siblings that should
12716 be done first, or is child of a block grandparent TODO entry."
12718 (if (not org-enforce-todo-dependencies)
12719 t ; if locally turned off don't block
12720 (catch 'dont-block
12721 ;; If this is not a todo state change, or if this entry is already DONE,
12722 ;; do not block
12723 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12724 (member (plist-get change-plist :from)
12725 (cons 'done org-done-keywords))
12726 (member (plist-get change-plist :to)
12727 (cons 'todo org-not-done-keywords))
12728 (not (plist-get change-plist :to)))
12729 (throw 'dont-block t))
12730 ;; If this task has children, and any are undone, it's blocked
12731 (save-excursion
12732 (org-back-to-heading t)
12733 (let ((this-level (funcall outline-level)))
12734 (outline-next-heading)
12735 (let ((child-level (funcall outline-level)))
12736 (while (and (not (eobp))
12737 (> child-level this-level))
12738 ;; this todo has children, check whether they are all
12739 ;; completed
12740 (if (and (not (org-entry-is-done-p))
12741 (org-entry-is-todo-p))
12742 (progn (setq org-block-entry-blocking (org-get-heading))
12743 (throw 'dont-block nil)))
12744 (outline-next-heading)
12745 (setq child-level (funcall outline-level))))))
12746 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12747 ;; any previous siblings are undone, it's blocked
12748 (save-excursion
12749 (org-back-to-heading t)
12750 (let* ((pos (point))
12751 (parent-pos (and (org-up-heading-safe) (point))))
12752 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12753 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12754 (forward-line 1)
12755 (re-search-forward org-not-done-heading-regexp pos t))
12756 (setq org-block-entry-blocking (match-string 0))
12757 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12758 ;; Search further up the hierarchy, to see if an ancestor is blocked
12759 (while t
12760 (goto-char parent-pos)
12761 (if (not (looking-at org-not-done-heading-regexp))
12762 (throw 'dont-block t)) ; do not block, parent is not a TODO
12763 (setq pos (point))
12764 (setq parent-pos (and (org-up-heading-safe) (point)))
12765 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12766 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12767 (forward-line 1)
12768 (re-search-forward org-not-done-heading-regexp pos t)
12769 (setq org-block-entry-blocking (org-get-heading)))
12770 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12772 (defcustom org-track-ordered-property-with-tag nil
12773 "Should the ORDERED property also be shown as a tag?
12774 The ORDERED property decides if an entry should require subtasks to be
12775 completed in sequence. Since a property is not very visible, setting
12776 this option means that toggling the ORDERED property with the command
12777 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12778 not relevant for the behavior, but it makes things more visible.
12780 Note that toggling the tag with tags commands will not change the property
12781 and therefore not influence behavior!
12783 This can be t, meaning the tag ORDERED should be used, It can also be a
12784 string to select a different tag for this task."
12785 :group 'org-todo
12786 :type '(choice
12787 (const :tag "No tracking" nil)
12788 (const :tag "Track with ORDERED tag" t)
12789 (string :tag "Use other tag")))
12791 (defun org-toggle-ordered-property ()
12792 "Toggle the ORDERED property of the current entry.
12793 For better visibility, you can track the value of this property with a tag.
12794 See variable `org-track-ordered-property-with-tag'."
12795 (interactive)
12796 (let* ((t1 org-track-ordered-property-with-tag)
12797 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12798 (save-excursion
12799 (org-back-to-heading)
12800 (if (org-entry-get nil "ORDERED")
12801 (progn
12802 (org-delete-property "ORDERED")
12803 (and tag (org-toggle-tag tag 'off))
12804 (message "Subtasks can be completed in arbitrary order"))
12805 (org-entry-put nil "ORDERED" "t")
12806 (and tag (org-toggle-tag tag 'on))
12807 (message "Subtasks must be completed in sequence")))))
12809 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12810 (defun org-block-todo-from-checkboxes (change-plist)
12811 "Block turning an entry into a TODO, using checkboxes.
12812 This checks whether the current task should be blocked from state
12813 changes because there are unchecked boxes in this entry."
12814 (if (not org-enforce-todo-checkbox-dependencies)
12815 t ; if locally turned off don't block
12816 (catch 'dont-block
12817 ;; If this is not a todo state change, or if this entry is already DONE,
12818 ;; do not block
12819 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12820 (member (plist-get change-plist :from)
12821 (cons 'done org-done-keywords))
12822 (member (plist-get change-plist :to)
12823 (cons 'todo org-not-done-keywords))
12824 (not (plist-get change-plist :to)))
12825 (throw 'dont-block t))
12826 ;; If this task has checkboxes that are not checked, it's blocked
12827 (save-excursion
12828 (org-back-to-heading t)
12829 (let ((beg (point)) end)
12830 (outline-next-heading)
12831 (setq end (point))
12832 (goto-char beg)
12833 (if (org-list-search-forward
12834 (concat (org-item-beginning-re)
12835 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12836 "\\[[- ]\\]")
12837 end t)
12838 (progn
12839 (if (boundp 'org-blocked-by-checkboxes)
12840 (setq org-blocked-by-checkboxes t))
12841 (throw 'dont-block nil)))))
12842 t))) ; do not block
12844 (defun org-entry-blocked-p ()
12845 "Is the current entry blocked?"
12846 (org-with-silent-modifications
12847 (if (org-entry-get nil "NOBLOCKING")
12848 nil ;; Never block this entry
12849 (not (run-hook-with-args-until-failure
12850 'org-blocker-hook
12851 (list :type 'todo-state-change
12852 :position (point)
12853 :from 'todo
12854 :to 'done))))))
12856 (defun org-update-statistics-cookies (all)
12857 "Update the statistics cookie, either from TODO or from checkboxes.
12858 This should be called with the cursor in a line with a statistics cookie."
12859 (interactive "P")
12860 (if all
12861 (progn
12862 (org-update-checkbox-count 'all)
12863 (org-map-entries 'org-update-parent-todo-statistics))
12864 (if (not (org-at-heading-p))
12865 (org-update-checkbox-count)
12866 (let ((pos (point-marker))
12867 end l1 l2)
12868 (ignore-errors (org-back-to-heading t))
12869 (if (not (org-at-heading-p))
12870 (org-update-checkbox-count)
12871 (setq l1 (org-outline-level))
12872 (setq end (save-excursion
12873 (outline-next-heading)
12874 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12875 (point)))
12876 (if (and (save-excursion
12877 (re-search-forward
12878 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12879 (not (save-excursion (re-search-forward
12880 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12881 (org-update-checkbox-count)
12882 (if (and l2 (> l2 l1))
12883 (progn
12884 (goto-char end)
12885 (org-update-parent-todo-statistics))
12886 (goto-char pos)
12887 (beginning-of-line 1)
12888 (while (re-search-forward
12889 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12890 (point-at-eol) t)
12891 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12892 (goto-char pos)
12893 (move-marker pos nil)))))
12895 (defvar org-entry-property-inherited-from) ;; defined below
12896 (defun org-update-parent-todo-statistics ()
12897 "Update any statistics cookie in the parent of the current headline.
12898 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12899 the entire subtree and this will travel up the hierarchy and update
12900 statistics everywhere."
12901 (let* ((prop (save-excursion (org-up-heading-safe)
12902 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12903 (recursive (or (not org-hierarchical-todo-statistics)
12904 (and prop (string-match "\\<recursive\\>" prop))))
12905 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12907 (first t)
12908 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12909 level ltoggle l1 new ndel
12910 (cnt-all 0) (cnt-done 0) is-percent kwd
12911 checkbox-beg ov ovs ove cookie-present)
12912 (catch 'exit
12913 (save-excursion
12914 (beginning-of-line 1)
12915 (setq ltoggle (funcall outline-level))
12916 ;; Three situations are to consider:
12918 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12919 ;; to the top-level ancestor on the headline;
12921 ;; 2. If parent has "recursive" property, repeat up to the
12922 ;; headline setting that property, taking inheritance into
12923 ;; account;
12925 ;; 3. Else, move up to direct parent and proceed only once.
12926 (while (and (setq level (org-up-heading-safe))
12927 (or recursive first)
12928 (>= (point) lim))
12929 (setq first nil cookie-present nil)
12930 (unless (and level
12931 (not (string-match
12932 "\\<checkbox\\>"
12933 (downcase (or (org-entry-get nil "COOKIE_DATA")
12934 "")))))
12935 (throw 'exit nil))
12936 (while (re-search-forward box-re (point-at-eol) t)
12937 (setq cnt-all 0 cnt-done 0 cookie-present t)
12938 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12939 (save-match-data
12940 (unless (outline-next-heading) (throw 'exit nil))
12941 (while (and (looking-at org-complex-heading-regexp)
12942 (> (setq l1 (length (match-string 1))) level))
12943 (setq kwd (and (or recursive (= l1 ltoggle))
12944 (match-string 2)))
12945 (if (or (eq org-provide-todo-statistics 'all-headlines)
12946 (and (eq org-provide-todo-statistics t)
12947 (or (member kwd org-done-keywords)))
12948 (and (listp org-provide-todo-statistics)
12949 (stringp (car org-provide-todo-statistics))
12950 (or (member kwd org-provide-todo-statistics)
12951 (member kwd org-done-keywords)))
12952 (and (listp org-provide-todo-statistics)
12953 (listp (car org-provide-todo-statistics))
12954 (or (member kwd (car org-provide-todo-statistics))
12955 (and (member kwd org-done-keywords)
12956 (member kwd (cadr org-provide-todo-statistics))))))
12957 (setq cnt-all (1+ cnt-all))
12958 (if (eq org-provide-todo-statistics t)
12959 (and kwd (setq cnt-all (1+ cnt-all)))))
12960 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12961 (member kwd org-done-keywords))
12962 (and (listp org-provide-todo-statistics)
12963 (listp (car org-provide-todo-statistics))
12964 (member kwd org-done-keywords)
12965 (member kwd (cadr org-provide-todo-statistics)))
12966 (and (listp org-provide-todo-statistics)
12967 (stringp (car org-provide-todo-statistics))
12968 (member kwd org-done-keywords)))
12969 (setq cnt-done (1+ cnt-done)))
12970 (outline-next-heading)))
12971 (setq new
12972 (if is-percent
12973 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12974 (format "[%d/%d]" cnt-done cnt-all))
12975 ndel (- (match-end 0) checkbox-beg))
12976 ;; handle overlays when updating cookie from column view
12977 (when (setq ov (car (overlays-at checkbox-beg)))
12978 (setq ovs (overlay-start ov) ove (overlay-end ov))
12979 (delete-overlay ov))
12980 (goto-char checkbox-beg)
12981 (insert new)
12982 (delete-region (point) (+ (point) ndel))
12983 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12984 (when ov (move-overlay ov ovs ove)))
12985 (when cookie-present
12986 (run-hook-with-args 'org-after-todo-statistics-hook
12987 cnt-done (- cnt-all cnt-done))))))
12988 (run-hooks 'org-todo-statistics-hook)))
12990 (defvar org-after-todo-statistics-hook nil
12991 "Hook that is called after a TODO statistics cookie has been updated.
12992 Each function is called with two arguments: the number of not-done entries
12993 and the number of done entries.
12995 For example, the following function, when added to this hook, will switch
12996 an entry to DONE when all children are done, and back to TODO when new
12997 entries are set to a TODO status. Note that this hook is only called
12998 when there is a statistics cookie in the headline!
13000 (defun org-summary-todo (n-done n-not-done)
13001 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13002 (let (org-log-done org-log-states) ; turn off logging
13003 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13006 (defvar org-todo-statistics-hook nil
13007 "Hook that is run whenever Org thinks TODO statistics should be updated.
13008 This hook runs even if there is no statistics cookie present, in which case
13009 `org-after-todo-statistics-hook' would not run.")
13011 (defun org-todo-trigger-tag-changes (state)
13012 "Apply the changes defined in `org-todo-state-tags-triggers'."
13013 (let ((l org-todo-state-tags-triggers)
13014 changes)
13015 (when (or (not state) (equal state ""))
13016 (setq changes (append changes (cdr (assoc "" l)))))
13017 (when (and (stringp state) (> (length state) 0))
13018 (setq changes (append changes (cdr (assoc state l)))))
13019 (when (member state org-not-done-keywords)
13020 (setq changes (append changes (cdr (assoc 'todo l)))))
13021 (when (member state org-done-keywords)
13022 (setq changes (append changes (cdr (assoc 'done l)))))
13023 (dolist (c changes)
13024 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13026 (defun org-local-logging (value)
13027 "Get logging settings from a property VALUE."
13028 (let* (words w a)
13029 ;; directly set the variables, they are already local.
13030 (setq org-log-done nil
13031 org-log-repeat nil
13032 org-todo-log-states nil)
13033 (setq words (org-split-string value))
13034 (while (setq w (pop words))
13035 (cond
13036 ((setq a (assoc w org-startup-options))
13037 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13038 (set (nth 1 a) (nth 2 a))))
13039 ((setq a (org-extract-log-state-settings w))
13040 (and (member (car a) org-todo-keywords-1)
13041 (push a org-todo-log-states)))))))
13043 (defun org-get-todo-sequence-head (kwd)
13044 "Return the head of the TODO sequence to which KWD belongs.
13045 If KWD is not set, check if there is a text property remembering the
13046 right sequence."
13047 (let (p)
13048 (cond
13049 ((not kwd)
13050 (or (get-text-property (point-at-bol) 'org-todo-head)
13051 (progn
13052 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13053 nil (point-at-eol)))
13054 (get-text-property p 'org-todo-head))))
13055 ((not (member kwd org-todo-keywords-1))
13056 (car org-todo-keywords-1))
13057 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13059 (defun org-fast-todo-selection ()
13060 "Fast TODO keyword selection with single keys.
13061 Returns the new TODO keyword, or nil if no state change should occur."
13062 (let* ((fulltable org-todo-key-alist)
13063 (done-keywords org-done-keywords) ;; needed for the faces.
13064 (maxlen (apply 'max (mapcar
13065 (lambda (x)
13066 (if (stringp (car x)) (string-width (car x)) 0))
13067 fulltable)))
13068 (expert nil)
13069 (fwidth (+ maxlen 3 1 3))
13070 (ncol (/ (- (window-width) 4) fwidth))
13071 tg cnt e c tbl
13072 groups ingroup)
13073 (save-excursion
13074 (save-window-excursion
13075 (if expert
13076 (set-buffer (get-buffer-create " *Org todo*"))
13077 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13078 (erase-buffer)
13079 (org-set-local 'org-done-keywords done-keywords)
13080 (setq tbl fulltable cnt 0)
13081 (while (setq e (pop tbl))
13082 (cond
13083 ((equal e '(:startgroup))
13084 (push '() groups) (setq ingroup t)
13085 (when (not (= cnt 0))
13086 (setq cnt 0)
13087 (insert "\n"))
13088 (insert "{ "))
13089 ((equal e '(:endgroup))
13090 (setq ingroup nil cnt 0)
13091 (insert "}\n"))
13092 ((equal e '(:newline))
13093 (when (not (= cnt 0))
13094 (setq cnt 0)
13095 (insert "\n")
13096 (setq e (car tbl))
13097 (while (equal (car tbl) '(:newline))
13098 (insert "\n")
13099 (setq tbl (cdr tbl)))))
13101 (setq tg (car e) c (cdr e))
13102 (if ingroup (push tg (car groups)))
13103 (setq tg (org-add-props tg nil 'face
13104 (org-get-todo-face tg)))
13105 (if (and (= cnt 0) (not ingroup)) (insert " "))
13106 (insert "[" c "] " tg (make-string
13107 (- fwidth 4 (length tg)) ?\ ))
13108 (when (= (setq cnt (1+ cnt)) ncol)
13109 (insert "\n")
13110 (if ingroup (insert " "))
13111 (setq cnt 0)))))
13112 (insert "\n")
13113 (goto-char (point-min))
13114 (if (not expert) (org-fit-window-to-buffer))
13115 (message "[a-z..]:Set [SPC]:clear")
13116 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13117 (cond
13118 ((or (= c ?\C-g)
13119 (and (= c ?q) (not (rassoc c fulltable))))
13120 (setq quit-flag t))
13121 ((= c ?\ ) nil)
13122 ((setq e (rassoc c fulltable) tg (car e))
13124 (t (setq quit-flag t)))))))
13126 (defun org-entry-is-todo-p ()
13127 (member (org-get-todo-state) org-not-done-keywords))
13129 (defun org-entry-is-done-p ()
13130 (member (org-get-todo-state) org-done-keywords))
13132 (defun org-get-todo-state ()
13133 "Return the TODO keyword of the current subtree."
13134 (save-excursion
13135 (org-back-to-heading t)
13136 (and (looking-at org-todo-line-regexp)
13137 (match-end 2)
13138 (match-string 2))))
13140 (defun org-at-date-range-p (&optional inactive-ok)
13141 "Is the cursor inside a date range?"
13142 (interactive)
13143 (save-excursion
13144 (catch 'exit
13145 (let ((pos (point)))
13146 (skip-chars-backward "^[<\r\n")
13147 (skip-chars-backward "<[")
13148 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13149 (>= (match-end 0) pos)
13150 (throw 'exit t))
13151 (skip-chars-backward "^<[\r\n")
13152 (skip-chars-backward "<[")
13153 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13154 (>= (match-end 0) pos)
13155 (throw 'exit t)))
13156 nil)))
13158 (defun org-get-repeat (&optional tagline)
13159 "Check if there is a deadline/schedule with repeater in this entry."
13160 (save-match-data
13161 (save-excursion
13162 (org-back-to-heading t)
13163 (and (re-search-forward (if tagline
13164 (concat tagline "\\s-*" org-repeat-re)
13165 org-repeat-re)
13166 (org-entry-end-position) t)
13167 (match-string-no-properties 1)))))
13169 (defvar org-last-changed-timestamp)
13170 (defvar org-last-inserted-timestamp)
13171 (defvar org-log-post-message)
13172 (defvar org-log-note-purpose)
13173 (defvar org-log-note-how nil)
13174 (defvar org-log-note-extra)
13175 (defun org-auto-repeat-maybe (done-word)
13176 "Check if the current headline contains a repeated deadline/schedule.
13177 If yes, set TODO state back to what it was and change the base date
13178 of repeating deadline/scheduled time stamps to new date.
13179 This function is run automatically after each state change to a DONE state."
13180 ;; last-state is dynamically scoped into this function
13181 (let* ((repeat (org-get-repeat))
13182 (aa (assoc org-last-state org-todo-kwd-alist))
13183 (interpret (nth 1 aa))
13184 (head (nth 2 aa))
13185 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13186 (msg "Entry repeats: ")
13187 (org-log-done nil)
13188 (org-todo-log-states nil)
13189 re type n what ts time to-state)
13190 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13191 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13192 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13193 org-todo-repeat-to-state))
13194 (unless (and to-state (member to-state org-todo-keywords-1))
13195 (setq to-state (if (eq interpret 'type) org-last-state head)))
13196 (org-todo to-state)
13197 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13198 (org-entry-put nil "LAST_REPEAT" (format-time-string
13199 (org-time-stamp-format t t))))
13200 (when org-log-repeat
13201 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13202 (memq 'org-add-log-note post-command-hook))
13203 ;; OK, we are already setup for some record
13204 (if (eq org-log-repeat 'note)
13205 ;; make sure we take a note, not only a time stamp
13206 (setq org-log-note-how 'note))
13207 ;; Set up for taking a record
13208 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13209 org-last-state
13210 'findpos org-log-repeat)))
13211 (org-back-to-heading t)
13212 (org-add-planning-info nil nil 'closed)
13213 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13214 org-deadline-time-regexp "\\)\\|\\("
13215 org-ts-regexp "\\)"))
13216 (while (re-search-forward
13217 re (save-excursion (outline-next-heading) (point)) t)
13218 (setq type (if (match-end 1) org-scheduled-string
13219 (if (match-end 3) org-deadline-string "Plain:"))
13220 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13221 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13222 (setq n (string-to-number (match-string 2 ts))
13223 what (match-string 3 ts))
13224 (if (equal what "w") (setq n (* n 7) what "d"))
13225 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13226 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13227 ;; Preparation, see if we need to modify the start date for the change
13228 (when (match-end 1)
13229 (setq time (save-match-data (org-time-string-to-time ts)))
13230 (cond
13231 ((equal (match-string 1 ts) ".")
13232 ;; Shift starting date to today
13233 (org-timestamp-change
13234 (- (org-today) (time-to-days time))
13235 'day))
13236 ((equal (match-string 1 ts) "+")
13237 (let ((nshiftmax 10) (nshift 0))
13238 (while (or (= nshift 0)
13239 (<= (time-to-days time)
13240 (time-to-days (current-time))))
13241 (when (= (incf nshift) nshiftmax)
13242 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13243 (user-error "Abort")))
13244 (org-timestamp-change n (cdr (assoc what whata)))
13245 (org-at-timestamp-p t)
13246 (setq ts (match-string 1))
13247 (setq time (save-match-data (org-time-string-to-time ts)))))
13248 (org-timestamp-change (- n) (cdr (assoc what whata)))
13249 ;; rematch, so that we have everything in place for the real shift
13250 (org-at-timestamp-p t)
13251 (setq ts (match-string 1))
13252 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13253 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13254 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13255 (setq org-log-post-message msg)
13256 (message "%s" msg))))
13258 (defun org-show-todo-tree (arg)
13259 "Make a compact tree which shows all headlines marked with TODO.
13260 The tree will show the lines where the regexp matches, and all higher
13261 headlines above the match.
13262 With a \\[universal-argument] prefix, prompt for a regexp to match.
13263 With a numeric prefix N, construct a sparse tree for the Nth element
13264 of `org-todo-keywords-1'."
13265 (interactive "P")
13266 (let ((case-fold-search nil)
13267 (kwd-re
13268 (cond ((null arg) org-not-done-regexp)
13269 ((equal arg '(4))
13270 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13271 (mapcar 'list org-todo-keywords-1))))
13272 (concat "\\("
13273 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13274 "\\)\\>")))
13275 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13276 (regexp-quote (nth (1- (prefix-numeric-value arg))
13277 org-todo-keywords-1)))
13278 (t (user-error "Invalid prefix argument: %s" arg)))))
13279 (message "%d TODO entries found"
13280 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13282 (defun org-deadline (arg &optional time)
13283 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13284 With one universal prefix argument, remove any deadline from the item.
13285 With two universal prefix arguments, prompt for a warning delay.
13286 With argument TIME, set the deadline at the corresponding date. TIME
13287 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13288 (interactive "P")
13289 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13290 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13291 'region-start-level 'region))
13292 org-loop-over-headlines-in-active-region)
13293 (org-map-entries
13294 `(org-deadline ',arg ,time)
13295 org-loop-over-headlines-in-active-region
13296 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13297 (let* ((old-date (org-entry-get nil "DEADLINE"))
13298 (old-date-time (if old-date (org-time-string-to-time old-date)))
13299 (repeater (and old-date
13300 (string-match
13301 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13302 old-date)
13303 (match-string 1 old-date))))
13304 (cond
13305 ((equal arg '(4))
13306 (when (and old-date org-log-redeadline)
13307 (org-add-log-setup 'deldeadline nil old-date 'findpos
13308 org-log-redeadline))
13309 (org-remove-timestamp-with-keyword org-deadline-string)
13310 (message "Item no longer has a deadline."))
13311 ((equal arg '(16))
13312 (save-excursion
13313 (org-back-to-heading t)
13314 (if (re-search-forward
13315 org-deadline-time-regexp
13316 (save-excursion (outline-next-heading) (point)) t)
13317 (let* ((rpl0 (match-string 1))
13318 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13319 (replace-match
13320 (concat org-deadline-string
13321 " <" rpl
13322 (format " -%dd"
13323 (abs
13324 (- (time-to-days
13325 (save-match-data
13326 (org-read-date nil t nil "Warn starting from" old-date-time)))
13327 (time-to-days old-date-time))))
13328 ">") t t))
13329 (user-error "No deadline information to update"))))
13331 (org-add-planning-info 'deadline time 'closed)
13332 (when (and old-date org-log-redeadline
13333 (not (equal old-date
13334 (substring org-last-inserted-timestamp 1 -1))))
13335 (org-add-log-setup 'redeadline nil old-date 'findpos
13336 org-log-redeadline))
13337 (when repeater
13338 (save-excursion
13339 (org-back-to-heading t)
13340 (when (re-search-forward (concat org-deadline-string " "
13341 org-last-inserted-timestamp)
13342 (save-excursion
13343 (outline-next-heading) (point)) t)
13344 (goto-char (1- (match-end 0)))
13345 (insert " " repeater)
13346 (setq org-last-inserted-timestamp
13347 (concat (substring org-last-inserted-timestamp 0 -1)
13348 " " repeater
13349 (substring org-last-inserted-timestamp -1))))))
13350 (message "Deadline on %s" org-last-inserted-timestamp))))))
13352 (defun org-schedule (arg &optional time)
13353 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13354 With one universal prefix argument, remove any scheduling date from the item.
13355 With two universal prefix arguments, prompt for a delay cookie.
13356 With argument TIME, scheduled at the corresponding date. TIME can
13357 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13358 (interactive "P")
13359 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13360 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13361 'region-start-level 'region))
13362 org-loop-over-headlines-in-active-region)
13363 (org-map-entries
13364 `(org-schedule ',arg ,time)
13365 org-loop-over-headlines-in-active-region
13366 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13367 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13368 (old-date-time (if old-date (org-time-string-to-time old-date)))
13369 (repeater (and old-date
13370 (string-match
13371 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13372 old-date)
13373 (match-string 1 old-date))))
13374 (cond
13375 ((equal arg '(4))
13376 (progn
13377 (when (and old-date org-log-reschedule)
13378 (org-add-log-setup 'delschedule nil old-date 'findpos
13379 org-log-reschedule))
13380 (org-remove-timestamp-with-keyword org-scheduled-string)
13381 (message "Item is no longer scheduled.")))
13382 ((equal arg '(16))
13383 (save-excursion
13384 (org-back-to-heading t)
13385 (if (re-search-forward
13386 org-scheduled-time-regexp
13387 (save-excursion (outline-next-heading) (point)) t)
13388 (let* ((rpl0 (match-string 1))
13389 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13390 (replace-match
13391 (concat org-scheduled-string
13392 " <" rpl
13393 (format " -%dd"
13394 (abs
13395 (- (time-to-days
13396 (save-match-data
13397 (org-read-date nil t nil "Delay until" old-date-time)))
13398 (time-to-days old-date-time))))
13399 ">") t t))
13400 (user-error "No scheduled information to update"))))
13402 (org-add-planning-info 'scheduled time 'closed)
13403 (when (and old-date org-log-reschedule
13404 (not (equal old-date
13405 (substring org-last-inserted-timestamp 1 -1))))
13406 (org-add-log-setup 'reschedule nil old-date 'findpos
13407 org-log-reschedule))
13408 (when repeater
13409 (save-excursion
13410 (org-back-to-heading t)
13411 (when (re-search-forward (concat org-scheduled-string " "
13412 org-last-inserted-timestamp)
13413 (save-excursion
13414 (outline-next-heading) (point)) t)
13415 (goto-char (1- (match-end 0)))
13416 (insert " " repeater)
13417 (setq org-last-inserted-timestamp
13418 (concat (substring org-last-inserted-timestamp 0 -1)
13419 " " repeater
13420 (substring org-last-inserted-timestamp -1))))))
13421 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13423 (defun org-get-scheduled-time (pom &optional inherit)
13424 "Get the scheduled time as a time tuple, of a format suitable
13425 for calling org-schedule with, or if there is no scheduling,
13426 returns nil."
13427 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13428 (when time
13429 (apply 'encode-time (org-parse-time-string time)))))
13431 (defun org-get-deadline-time (pom &optional inherit)
13432 "Get the deadline as a time tuple, of a format suitable for
13433 calling org-deadline with, or if there is no scheduling, returns
13434 nil."
13435 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13436 (when time
13437 (apply 'encode-time (org-parse-time-string time)))))
13439 (defun org-remove-timestamp-with-keyword (keyword)
13440 "Remove all time stamps with KEYWORD in the current entry."
13441 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13442 beg)
13443 (save-excursion
13444 (org-back-to-heading t)
13445 (setq beg (point))
13446 (outline-next-heading)
13447 (while (re-search-backward re beg t)
13448 (replace-match "")
13449 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13450 (equal (char-before) ?\ ))
13451 (backward-delete-char 1)
13452 (if (string-match "^[ \t]*$" (buffer-substring
13453 (point-at-bol) (point-at-eol)))
13454 (delete-region (point-at-bol)
13455 (min (point-max) (1+ (point-at-eol))))))))))
13457 (defvar org-time-was-given) ; dynamically scoped parameter
13458 (defvar org-end-time-was-given) ; dynamically scoped parameter
13460 (defun org-at-planning-p ()
13461 "Non-nil when point is on a planning info line."
13462 ;; This is as accurate and faster than `org-element-at-point' since
13463 ;; planning info location is fixed in the section.
13464 (org-with-wide-buffer
13465 (beginning-of-line)
13466 (and (org-looking-at-p org-planning-line-re)
13467 (eq (point)
13468 (ignore-errors
13469 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13470 (org-back-to-heading t)
13471 (org-with-limited-levels (org-back-to-heading t)))
13472 (line-beginning-position 2))))))
13474 (defun org-add-planning-info (what &optional time &rest remove)
13475 "Insert new timestamp with keyword in the planning line.
13476 WHAT indicates what kind of time stamp to add. It is a symbol
13477 among `closed', `deadline', `scheduled' and nil. TIME indicates
13478 the time to use. If none is given, the user is prompted for
13479 a date. REMOVE indicates what kind of entries to remove. An old
13480 WHAT entry will also be removed."
13481 (let (org-time-was-given org-end-time-was-given default-time default-input)
13482 (catch 'exit
13483 (when (and (memq what '(scheduled deadline))
13484 (or (not time)
13485 (and (stringp time)
13486 (string-match "^[-+]+[0-9]" time))))
13487 ;; Try to get a default date/time from existing timestamp
13488 (save-excursion
13489 (org-back-to-heading t)
13490 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13491 (when (re-search-forward (if (eq what 'scheduled)
13492 org-scheduled-time-regexp
13493 org-deadline-time-regexp)
13494 end t)
13495 (setq ts (match-string 1)
13496 default-time (apply 'encode-time (org-parse-time-string ts))
13497 default-input (and ts (org-get-compact-tod ts)))))))
13498 (when what
13499 (setq time
13500 (if (stringp time)
13501 ;; This is a string (relative or absolute), set
13502 ;; proper date.
13503 (apply #'encode-time
13504 (org-read-date-analyze
13505 time default-time (decode-time default-time)))
13506 ;; If necessary, get the time from the user
13507 (or time (org-read-date nil 'to-time nil nil
13508 default-time default-input)))))
13510 (org-with-wide-buffer
13511 (org-back-to-heading t)
13512 (forward-line)
13513 (unless (bolp) (insert "\n"))
13514 (cond ((org-looking-at-p org-planning-line-re)
13515 ;; Move to current indentation.
13516 (skip-chars-forward " \t")
13517 ;; Check if we have to remove something.
13518 (dolist (type (if what (cons what remove) remove))
13519 (when (save-excursion
13520 (re-search-forward
13521 (case type
13522 (closed org-closed-time-regexp)
13523 (deadline org-deadline-time-regexp)
13524 (scheduled org-scheduled-time-regexp)
13525 (otherwise (error "Invalid planning type: %s" type)))
13526 (line-end-position) t))
13527 (replace-match "")
13528 (when (looking-at "--+<[^>]+>") (replace-match ""))
13529 (when (and (not what) (eq type 'closed))
13530 (save-excursion
13531 (beginning-of-line)
13532 (if (looking-at "[ \t]*$")
13533 (delete-region (point) (1+ (point-at-eol)))))))
13534 ;; Remove leading white spaces.
13535 (when (and (not (bolp)) (looking-at "[ \t]+")) (replace-match ""))))
13536 ((not what) (throw 'exit nil)) ; Nothing to do.
13537 (t (insert-before-markers "\n")
13538 (backward-char 1)
13539 (when org-adapt-indentation
13540 (org-indent-to-column (1+ (org-outline-level))))))
13541 (when what
13542 ;; Insert planning keyword.
13543 (insert (case what
13544 (closed org-closed-string)
13545 (deadline org-deadline-string)
13546 (scheduled org-scheduled-string)
13547 (otherwise (error "Invalid planning type: %s" what)))
13548 " ")
13549 ;; Insert associated timestamp.
13550 (let ((ts (org-insert-time-stamp
13551 time
13552 (or org-time-was-given
13553 (and (eq what 'closed) org-log-done-with-time))
13554 (eq what 'closed)
13555 nil nil (list org-end-time-was-given))))
13556 (unless (eolp) (insert " "))
13557 ts))))))
13559 (defvar org-log-note-marker (make-marker))
13560 (defvar org-log-note-purpose nil)
13561 (defvar org-log-note-state nil)
13562 (defvar org-log-note-previous-state nil)
13563 (defvar org-log-note-extra nil)
13564 (defvar org-log-note-window-configuration nil)
13565 (defvar org-log-note-return-to (make-marker))
13566 (defvar org-log-note-effective-time nil
13567 "Remembered current time so that dynamically scoped
13568 `org-extend-today-until' affects tha timestamps in state change
13569 log")
13571 (defvar org-log-post-message nil
13572 "Message to be displayed after a log note has been stored.
13573 The auto-repeater uses this.")
13575 (defun org-add-note ()
13576 "Add a note to the current entry.
13577 This is done in the same way as adding a state change note."
13578 (interactive)
13579 (org-add-log-setup 'note nil nil 'findpos nil))
13581 (defun org-log-beginning (&optional create)
13582 "Return expected start of log notes in current entry.
13583 When optional argument CREATE is non-nil, the function creates
13584 a drawer to store notes, if necessary. Returned position ignores
13585 narrowing."
13586 (org-with-wide-buffer
13587 (org-end-of-meta-data)
13588 (let ((end (if (org-at-heading-p) (point)
13589 (save-excursion (outline-next-heading) (point))))
13590 (drawer (org-log-into-drawer)))
13591 (cond
13592 (drawer
13593 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13594 (case-fold-search t))
13595 (catch 'exit
13596 ;; Try to find existing drawer.
13597 (while (re-search-forward regexp end t)
13598 (let ((element (org-element-at-point)))
13599 (when (eq (org-element-type element) 'drawer)
13600 (let ((cend (org-element-property :contents-end element)))
13601 (when (and (not org-log-states-order-reversed) cend)
13602 (goto-char cend)))
13603 (throw 'exit nil))))
13604 ;; No drawer found. Create one, if permitted.
13605 (when create
13606 (unless (bolp) (insert "\n"))
13607 (let ((beg (point)))
13608 (insert ":" drawer ":\n:END:\n")
13609 (org-indent-region beg (point)))
13610 (end-of-line -1)))))
13611 (org-log-state-notes-insert-after-drawers
13612 (while (and (looking-at org-drawer-regexp)
13613 (progn (goto-char (match-end 0))
13614 (re-search-forward org-property-end-re end t)))
13615 (forward-line)))))
13616 (if (bolp) (point) (line-beginning-position 2))))
13618 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13619 "Set up the post command hook to take a note.
13620 If this is about to TODO state change, the new state is expected in STATE.
13621 When FINDPOS is non-nil, find the correct position for the note in
13622 the current entry. If not, assume that it can be inserted at point.
13623 HOW is an indicator what kind of note should be created.
13624 EXTRA is additional text that will be inserted into the notes buffer."
13625 (org-with-wide-buffer
13626 (when findpos
13627 (goto-char (org-log-beginning t))
13628 (unless org-log-states-order-reversed
13629 (org-skip-over-state-notes)
13630 (skip-chars-backward " \t\n\r")
13631 (forward-line)))
13632 (move-marker org-log-note-marker (point))
13633 ;; Preserve position even if a property drawer is inserted in the
13634 ;; process.
13635 (set-marker-insertion-type org-log-note-marker t)
13636 (setq org-log-note-purpose purpose
13637 org-log-note-state state
13638 org-log-note-previous-state prev-state
13639 org-log-note-how how
13640 org-log-note-extra extra
13641 org-log-note-effective-time (org-current-effective-time))
13642 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13644 (defun org-skip-over-state-notes ()
13645 "Skip past the list of State notes in an entry."
13646 (when (ignore-errors (goto-char (org-in-item-p)))
13647 (let* ((struct (org-list-struct))
13648 (prevs (org-list-prevs-alist struct))
13649 (regexp
13650 (concat "[ \t]*- +"
13651 (replace-regexp-in-string
13652 " +" " +"
13653 (org-replace-escapes
13654 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13655 `(("%d" . ,org-ts-regexp-inactive)
13656 ("%D" . ,org-ts-regexp)
13657 ("%s" . "\"\\S-+\"")
13658 ("%S" . "\"\\S-+\"")
13659 ("%t" . ,org-ts-regexp-inactive)
13660 ("%T" . ,org-ts-regexp)
13661 ("%u" . ".*?")
13662 ("%U" . ".*?")))))))
13663 (while (org-looking-at-p regexp)
13664 (goto-char (or (org-list-get-next-item (point) struct prevs)
13665 (org-list-get-item-end (point) struct)))))))
13667 (defun org-add-log-note (&optional purpose)
13668 "Pop up a window for taking a note, and add this note later at point."
13669 (remove-hook 'post-command-hook 'org-add-log-note)
13670 (setq org-log-note-window-configuration (current-window-configuration))
13671 (delete-other-windows)
13672 (move-marker org-log-note-return-to (point))
13673 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13674 (goto-char org-log-note-marker)
13675 (org-switch-to-buffer-other-window "*Org Note*")
13676 (erase-buffer)
13677 (if (memq org-log-note-how '(time state))
13678 (let (current-prefix-arg) (org-store-log-note))
13679 (let ((org-inhibit-startup t)) (org-mode))
13680 (insert (format "# Insert note for %s.
13681 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13682 (cond
13683 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13684 ((eq org-log-note-purpose 'done) "closed todo item")
13685 ((eq org-log-note-purpose 'state)
13686 (format "state change from \"%s\" to \"%s\""
13687 (or org-log-note-previous-state "")
13688 (or org-log-note-state "")))
13689 ((eq org-log-note-purpose 'reschedule)
13690 "rescheduling")
13691 ((eq org-log-note-purpose 'delschedule)
13692 "no longer scheduled")
13693 ((eq org-log-note-purpose 'redeadline)
13694 "changing deadline")
13695 ((eq org-log-note-purpose 'deldeadline)
13696 "removing deadline")
13697 ((eq org-log-note-purpose 'refile)
13698 "refiling")
13699 ((eq org-log-note-purpose 'note)
13700 "this entry")
13701 (t (error "This should not happen")))))
13702 (if org-log-note-extra (insert org-log-note-extra))
13703 (org-set-local 'org-finish-function 'org-store-log-note)
13704 (run-hooks 'org-log-buffer-setup-hook)))
13706 (defvar org-note-abort nil) ; dynamically scoped
13707 (defun org-store-log-note ()
13708 "Finish taking a log note, and insert it to where it belongs."
13709 (let ((txt (buffer-string)))
13710 (kill-buffer (current-buffer))
13711 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13712 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13713 (setq txt (replace-match "" t t txt)))
13714 (if (string-match "\\s-+\\'" txt)
13715 (setq txt (replace-match "" t t txt)))
13716 (setq lines (org-split-string txt "\n"))
13717 (when (and note (string-match "\\S-" note))
13718 (setq note
13719 (org-replace-escapes
13720 note
13721 (list (cons "%u" (user-login-name))
13722 (cons "%U" user-full-name)
13723 (cons "%t" (format-time-string
13724 (org-time-stamp-format 'long 'inactive)
13725 org-log-note-effective-time))
13726 (cons "%T" (format-time-string
13727 (org-time-stamp-format 'long nil)
13728 org-log-note-effective-time))
13729 (cons "%d" (format-time-string
13730 (org-time-stamp-format nil 'inactive)
13731 org-log-note-effective-time))
13732 (cons "%D" (format-time-string
13733 (org-time-stamp-format nil nil)
13734 org-log-note-effective-time))
13735 (cons "%s" (if org-log-note-state
13736 (concat "\"" org-log-note-state "\"")
13737 ""))
13738 (cons "%S" (if org-log-note-previous-state
13739 (concat "\"" org-log-note-previous-state "\"")
13740 "\"\"")))))
13741 (when lines (setq note (concat note " \\\\")))
13742 (push note lines))
13743 (when (or current-prefix-arg org-note-abort)
13744 (when (org-log-into-drawer)
13745 (org-remove-empty-drawer-at org-log-note-marker))
13746 (setq lines nil))
13747 (when lines
13748 (with-current-buffer (marker-buffer org-log-note-marker)
13749 (save-excursion
13750 (goto-char org-log-note-marker)
13751 (move-marker org-log-note-marker nil)
13752 ;; Make sure point is at the beginning of an empty line.
13753 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13754 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13755 ;; In an existing list, add a new item at the top level.
13756 ;; Otherwise, indent line like a regular one.
13757 (let ((itemp (org-in-item-p)))
13758 (if itemp
13759 (org-indent-line-to
13760 (let ((struct (save-excursion
13761 (goto-char itemp) (org-list-struct))))
13762 (org-list-get-ind (org-list-get-top-point struct) struct)))
13763 (org-indent-line)))
13764 (insert (org-list-bullet-string "-") (pop lines))
13765 (let ((ind (org-list-item-body-column (line-beginning-position))))
13766 (dolist (line lines)
13767 (insert "\n")
13768 (org-indent-line-to ind)
13769 (insert line)))
13770 (message "Note stored")
13771 (org-back-to-heading t)
13772 (org-cycle-hide-drawers 'children))
13773 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13774 ;; from within `org-add-log-note' because `buffer-undo-list'
13775 ;; is then modified outside of `org-with-remote-undo'.
13776 (when (eq this-command 'org-agenda-todo)
13777 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13778 ;; Don't add undo information when called from `org-agenda-todo'
13779 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13780 (set-window-configuration org-log-note-window-configuration)
13781 (with-current-buffer (marker-buffer org-log-note-return-to)
13782 (goto-char org-log-note-return-to))
13783 (move-marker org-log-note-return-to nil)
13784 (and org-log-post-message (message "%s" org-log-post-message))))
13786 (defun org-remove-empty-drawer-at (pos)
13787 "Remove an empty drawer at position POS.
13788 POS may also be a marker."
13789 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13790 (org-with-wide-buffer
13791 (goto-char pos)
13792 (let ((drawer (org-element-at-point)))
13793 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13794 (not (org-element-property :contents-begin drawer)))
13795 (delete-region (org-element-property :begin drawer)
13796 (progn (goto-char (org-element-property :end drawer))
13797 (skip-chars-backward " \r\t\n")
13798 (forward-line)
13799 (point))))))))
13801 (defvar org-ts-type nil)
13802 (defun org-sparse-tree (&optional arg type)
13803 "Create a sparse tree, prompt for the details.
13804 This command can create sparse trees. You first need to select the type
13805 of match used to create the tree:
13807 t Show all TODO entries.
13808 T Show entries with a specific TODO keyword.
13809 m Show entries selected by a tags/property match.
13810 p Enter a property name and its value (both with completion on existing
13811 names/values) and show entries with that property.
13812 r Show entries matching a regular expression (`/' can be used as well).
13813 b Show deadlines and scheduled items before a date.
13814 a Show deadlines and scheduled items after a date.
13815 d Show deadlines due within `org-deadline-warning-days'.
13816 D Show deadlines and scheduled items between a date range."
13817 (interactive "P")
13818 (setq type (or type org-sparse-tree-default-date-type))
13819 (setq org-ts-type type)
13820 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13821 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13822 [c]ycle through date types: %s"
13823 (case type
13824 (all "all timestamps")
13825 (scheduled "only scheduled")
13826 (deadline "only deadline")
13827 (active "only active timestamps")
13828 (inactive "only inactive timestamps")
13829 (closed "with a closed time-stamp")
13830 (otherwise "scheduled/deadline")))
13831 (let ((answer (read-char-exclusive)))
13832 (case answer
13834 (org-sparse-tree
13836 (cadr
13837 (memq type '(nil all scheduled deadline active inactive closed)))))
13838 (?d (call-interactively 'org-check-deadlines))
13839 (?b (call-interactively 'org-check-before-date))
13840 (?a (call-interactively 'org-check-after-date))
13841 (?D (call-interactively 'org-check-dates-range))
13842 (?t (call-interactively 'org-show-todo-tree))
13843 (?T (org-show-todo-tree '(4)))
13844 (?m (call-interactively 'org-match-sparse-tree))
13845 ((?p ?P)
13846 (let* ((kwd (org-icompleting-read
13847 "Property: " (mapcar 'list (org-buffer-property-keys))))
13848 (value (org-icompleting-read
13849 "Value: " (mapcar 'list (org-property-values kwd)))))
13850 (unless (string-match "\\`{.*}\\'" value)
13851 (setq value (concat "\"" value "\"")))
13852 (org-match-sparse-tree arg (concat kwd "=" value))))
13853 ((?r ?R ?/) (call-interactively 'org-occur))
13854 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13856 (defvar org-occur-highlights nil
13857 "List of overlays used for occur matches.")
13858 (make-variable-buffer-local 'org-occur-highlights)
13859 (defvar org-occur-parameters nil
13860 "Parameters of the active org-occur calls.
13861 This is a list, each call to org-occur pushes as cons cell,
13862 containing the regular expression and the callback, onto the list.
13863 The list can contain several entries if `org-occur' has been called
13864 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13865 will only contain one set of parameters. When the highlights are
13866 removed (for example with `C-c C-c', or with the next edit (depending
13867 on `org-remove-highlights-with-change'), this variable is emptied
13868 as well.")
13869 (make-variable-buffer-local 'org-occur-parameters)
13871 (defun org-occur (regexp &optional keep-previous callback)
13872 "Make a compact tree which shows all matches of REGEXP.
13873 The tree will show the lines where the regexp matches, and all higher
13874 headlines above the match. It will also show the heading after the match,
13875 to make sure editing the matching entry is easy.
13876 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13877 call to `org-occur' will be kept, to allow stacking of calls to this
13878 command.
13879 If CALLBACK is non-nil, it is a function which is called to confirm
13880 that the match should indeed be shown."
13881 (interactive "sRegexp: \nP")
13882 (when (equal regexp "")
13883 (user-error "Regexp cannot be empty"))
13884 (unless keep-previous
13885 (org-remove-occur-highlights nil nil t))
13886 (push (cons regexp callback) org-occur-parameters)
13887 (let ((cnt 0))
13888 (save-excursion
13889 (goto-char (point-min))
13890 (if (or (not keep-previous) ; do not want to keep
13891 (not org-occur-highlights)) ; no previous matches
13892 ;; hide everything
13893 (org-overview))
13894 (while (re-search-forward regexp nil t)
13895 (when (or (not callback)
13896 (save-match-data (funcall callback)))
13897 (setq cnt (1+ cnt))
13898 (when org-highlight-sparse-tree-matches
13899 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13900 (org-show-context 'occur-tree))))
13901 (when org-remove-highlights-with-change
13902 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13903 nil 'local))
13904 (unless org-sparse-tree-open-archived-trees
13905 (org-hide-archived-subtrees (point-min) (point-max)))
13906 (run-hooks 'org-occur-hook)
13907 (if (org-called-interactively-p 'interactive)
13908 (message "%d match(es) for regexp %s" cnt regexp))
13909 cnt))
13911 (defun org-occur-next-match (&optional n reset)
13912 "Function for `next-error-function' to find sparse tree matches.
13913 N is the number of matches to move, when negative move backwards.
13914 RESET is entirely ignored - this function always goes back to the
13915 starting point when no match is found."
13916 (let* ((limit (if (< n 0) (point-min) (point-max)))
13917 (search-func (if (< n 0)
13918 'previous-single-char-property-change
13919 'next-single-char-property-change))
13920 (n (abs n))
13921 (pos (point))
13923 (catch 'exit
13924 (while (setq p1 (funcall search-func (point) 'org-type))
13925 (when (equal p1 limit)
13926 (goto-char pos)
13927 (user-error "No more matches"))
13928 (when (equal (get-char-property p1 'org-type) 'org-occur)
13929 (setq n (1- n))
13930 (when (= n 0)
13931 (goto-char p1)
13932 (throw 'exit (point))))
13933 (goto-char p1))
13934 (goto-char p1)
13935 (user-error "No more matches"))))
13937 (defun org-show-context (&optional key)
13938 "Make sure point and context are visible.
13939 Optional argument KEY, when non-nil, is a symbol. See
13940 `org-show-context-detail' for allowed values and how much is to
13941 be shown."
13942 (org-show-set-visibility
13943 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13944 ((cdr (assq key org-show-context-detail)))
13945 (t (cdr (assq 'default org-show-context-detail))))))
13947 (defun org-show-set-visibility (detail)
13948 "Set visibility around point according to DETAIL.
13949 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13950 `tree', `canonical' or t. See `org-show-context-detail' for more
13951 information."
13952 (unless (org-before-first-heading-p)
13953 ;; Show current heading and possibly its entry, following headline
13954 ;; or all children.
13955 (if (and (org-at-heading-p) (not (eq detail 'local)))
13956 (org-flag-heading nil)
13957 (org-show-entry)
13958 (org-with-limited-levels
13959 (case detail
13960 ((tree canonical t) (show-children))
13961 ((nil minimal ancestors))
13962 (t (save-excursion
13963 (outline-next-heading)
13964 (org-flag-heading nil))))))
13965 ;; Show all siblings.
13966 (when (eq detail 'lineage) (org-show-siblings))
13967 ;; Show ancestors, possibly with their children.
13968 (when (memq detail '(ancestors lineage tree canonical t))
13969 (save-excursion
13970 (while (org-up-heading-safe)
13971 (org-flag-heading nil)
13972 (when (memq detail '(canonical t)) (org-show-entry))
13973 (when (memq detail '(tree canonical t)) (show-children)))))))
13975 (defvar org-reveal-start-hook nil
13976 "Hook run before revealing a location.")
13978 (defun org-reveal (&optional siblings)
13979 "Show current entry, hierarchy above it, and the following headline.
13981 This can be used to show a consistent set of context around
13982 locations exposed with `org-show-context'.
13984 With optional argument SIBLINGS, on each level of the hierarchy all
13985 siblings are shown. This repairs the tree structure to what it would
13986 look like when opened with hierarchical calls to `org-cycle'.
13988 With double optional argument \\[universal-argument] \\[universal-argument], \
13989 go to the parent and show the
13990 entire tree."
13991 (interactive "P")
13992 (run-hooks 'org-reveal-start-hook)
13993 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
13994 ((equal siblings '(16))
13995 (save-excursion
13996 (when (org-up-heading-safe)
13997 (org-show-subtree)
13998 (run-hook-with-args 'org-cycle-hook 'subtree))))
13999 (t (org-show-set-visibility 'lineage))))
14001 (defun org-highlight-new-match (beg end)
14002 "Highlight from BEG to END and mark the highlight is an occur headline."
14003 (let ((ov (make-overlay beg end)))
14004 (overlay-put ov 'face 'secondary-selection)
14005 (overlay-put ov 'org-type 'org-occur)
14006 (push ov org-occur-highlights)))
14008 (defun org-remove-occur-highlights (&optional beg end noremove)
14009 "Remove the occur highlights from the buffer.
14010 BEG and END are ignored. If NOREMOVE is nil, remove this function
14011 from the `before-change-functions' in the current buffer."
14012 (interactive)
14013 (unless org-inhibit-highlight-removal
14014 (mapc 'delete-overlay org-occur-highlights)
14015 (setq org-occur-highlights nil)
14016 (setq org-occur-parameters nil)
14017 (unless noremove
14018 (remove-hook 'before-change-functions
14019 'org-remove-occur-highlights 'local))))
14021 ;;;; Priorities
14023 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14024 "Regular expression matching the priority indicator.")
14026 (defvar org-remove-priority-next-time nil)
14028 (defun org-priority-up ()
14029 "Increase the priority of the current item."
14030 (interactive)
14031 (org-priority 'up))
14033 (defun org-priority-down ()
14034 "Decrease the priority of the current item."
14035 (interactive)
14036 (org-priority 'down))
14038 (defun org-priority (&optional action show)
14039 "Change the priority of an item.
14040 ACTION can be `set', `up', `down', or a character."
14041 (interactive "P")
14042 (if (equal action '(4))
14043 (org-show-priority)
14044 (unless org-enable-priority-commands
14045 (user-error "Priority commands are disabled"))
14046 (setq action (or action 'set))
14047 (let (current new news have remove)
14048 (save-excursion
14049 (org-back-to-heading t)
14050 (if (looking-at org-priority-regexp)
14051 (setq current (string-to-char (match-string 2))
14052 have t))
14053 (cond
14054 ((eq action 'remove)
14055 (setq remove t new ?\ ))
14056 ((or (eq action 'set)
14057 (if (featurep 'xemacs) (characterp action) (integerp action)))
14058 (if (not (eq action 'set))
14059 (setq new action)
14060 (message "Priority %c-%c, SPC to remove: "
14061 org-highest-priority org-lowest-priority)
14062 (save-match-data
14063 (setq new (read-char-exclusive))))
14064 (if (and (= (upcase org-highest-priority) org-highest-priority)
14065 (= (upcase org-lowest-priority) org-lowest-priority))
14066 (setq new (upcase new)))
14067 (cond ((equal new ?\ ) (setq remove t))
14068 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14069 (user-error "Priority must be between `%c' and `%c'"
14070 org-highest-priority org-lowest-priority))))
14071 ((eq action 'up)
14072 (setq new (if have
14073 (1- current) ; normal cycling
14074 ;; last priority was empty
14075 (if (eq last-command this-command)
14076 org-lowest-priority ; wrap around empty to lowest
14077 ;; default
14078 (if org-priority-start-cycle-with-default
14079 org-default-priority
14080 (1- org-default-priority))))))
14081 ((eq action 'down)
14082 (setq new (if have
14083 (1+ current) ; normal cycling
14084 ;; last priority was empty
14085 (if (eq last-command this-command)
14086 org-highest-priority ; wrap around empty to highest
14087 ;; default
14088 (if org-priority-start-cycle-with-default
14089 org-default-priority
14090 (1+ org-default-priority))))))
14091 (t (user-error "Invalid action")))
14092 (if (or (< (upcase new) org-highest-priority)
14093 (> (upcase new) org-lowest-priority))
14094 (if (and (memq action '(up down))
14095 (not have) (not (eq last-command this-command)))
14096 ;; `new' is from default priority
14097 (error
14098 "The default can not be set, see `org-default-priority' why")
14099 ;; normal cycling: `new' is beyond highest/lowest priority
14100 ;; and is wrapped around to the empty priority
14101 (setq remove t)))
14102 (setq news (format "%c" new))
14103 (if have
14104 (if remove
14105 (replace-match "" t t nil 1)
14106 (replace-match news t t nil 2))
14107 (if remove
14108 (user-error "No priority cookie found in line")
14109 (let ((case-fold-search nil))
14110 (looking-at org-todo-line-regexp))
14111 (if (match-end 2)
14112 (progn
14113 (goto-char (match-end 2))
14114 (insert " [#" news "]"))
14115 (goto-char (match-beginning 3))
14116 (insert "[#" news "] "))))
14117 (org-set-tags nil 'align))
14118 (if remove
14119 (message "Priority removed")
14120 (message "Priority of current item set to %s" news)))))
14122 (defun org-show-priority ()
14123 "Show the priority of the current item.
14124 This priority is composed of the main priority given with the [#A] cookies,
14125 and by additional input from the age of a schedules or deadline entry."
14126 (interactive)
14127 (let ((pri (if (eq major-mode 'org-agenda-mode)
14128 (org-get-at-bol 'priority)
14129 (save-excursion
14130 (save-match-data
14131 (beginning-of-line)
14132 (and (looking-at org-heading-regexp)
14133 (org-get-priority (match-string 0))))))))
14134 (message "Priority is %d" (if pri pri -1000))))
14136 (defun org-get-priority (s)
14137 "Find priority cookie and return priority."
14138 (save-match-data
14139 (if (functionp org-get-priority-function)
14140 (funcall org-get-priority-function)
14141 (if (not (string-match org-priority-regexp s))
14142 (* 1000 (- org-lowest-priority org-default-priority))
14143 (* 1000 (- org-lowest-priority
14144 (string-to-char (match-string 2 s))))))))
14146 ;;;; Tags
14148 (defvar org-agenda-archives-mode)
14149 (defvar org-map-continue-from nil
14150 "Position from where mapping should continue.
14151 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14153 (defvar org-scanner-tags nil
14154 "The current tag list while the tags scanner is running.")
14155 (defvar org-trust-scanner-tags nil
14156 "Should `org-get-tags-at' use the tags for the scanner.
14157 This is for internal dynamical scoping only.
14158 When this is non-nil, the function `org-get-tags-at' will return the value
14159 of `org-scanner-tags' instead of building the list by itself. This
14160 can lead to large speed-ups when the tags scanner is used in a file with
14161 many entries, and when the list of tags is retrieved, for example to
14162 obtain a list of properties. Building the tags list for each entry in such
14163 a file becomes an N^2 operation - but with this variable set, it scales
14164 as N.")
14166 (defun org-scan-tags (action matcher todo-only &optional start-level)
14167 "Scan headline tags with inheritance and produce output ACTION.
14169 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14170 or `agenda' to produce an entry list for an agenda view. It can also be
14171 a Lisp form or a function that should be called at each matched headline, in
14172 this case the return value is a list of all return values from these calls.
14174 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14175 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14176 only lines with a not-done TODO keyword are included in the output.
14177 This should be the same variable that was scoped into
14178 and set by `org-make-tags-matcher' when it constructed MATCHER.
14180 START-LEVEL can be a string with asterisks, reducing the scope to
14181 headlines matching this string."
14182 (require 'org-agenda)
14183 (let* ((re (concat "^"
14184 (if start-level
14185 ;; Get the correct level to match
14186 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14187 org-outline-regexp)
14188 " *\\(\\<\\("
14189 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14190 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14191 (props (list 'face 'default
14192 'done-face 'org-agenda-done
14193 'undone-face 'default
14194 'mouse-face 'highlight
14195 'org-not-done-regexp org-not-done-regexp
14196 'org-todo-regexp org-todo-regexp
14197 'org-complex-heading-regexp org-complex-heading-regexp
14198 'help-echo
14199 (format "mouse-2 or RET jump to org file %s"
14200 (abbreviate-file-name
14201 (or (buffer-file-name (buffer-base-buffer))
14202 (buffer-name (buffer-base-buffer)))))))
14203 (org-map-continue-from nil)
14204 lspos tags tags-list
14205 (tags-alist (list (cons 0 org-file-tags)))
14206 (llast 0) rtn rtn1 level category i txt
14207 todo marker entry priority
14208 ts-date ts-date-type ts-date-pair)
14209 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14210 (setq action (list 'lambda nil action)))
14211 (save-excursion
14212 (goto-char (point-min))
14213 (when (eq action 'sparse-tree)
14214 (org-overview)
14215 (org-remove-occur-highlights))
14216 (while (let (case-fold-search)
14217 (re-search-forward re nil t))
14218 (setq org-map-continue-from nil)
14219 (catch :skip
14220 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14221 tags (if (match-end 4) (org-match-string-no-properties 4)))
14222 (goto-char (setq lspos (match-beginning 0)))
14223 (setq level (org-reduced-level (org-outline-level))
14224 category (org-get-category))
14225 (when (eq action 'agenda)
14226 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14227 ts-date (car ts-date-pair)
14228 ts-date-type (cdr ts-date-pair)))
14229 (setq i llast llast level)
14230 ;; remove tag lists from same and sublevels
14231 (while (>= i level)
14232 (when (setq entry (assoc i tags-alist))
14233 (setq tags-alist (delete entry tags-alist)))
14234 (setq i (1- i)))
14235 ;; add the next tags
14236 (when tags
14237 (setq tags (org-split-string tags ":")
14238 tags-alist
14239 (cons (cons level tags) tags-alist)))
14240 ;; compile tags for current headline
14241 (setq tags-list
14242 (if org-use-tag-inheritance
14243 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14244 tags)
14245 org-scanner-tags tags-list)
14246 (when org-use-tag-inheritance
14247 (setcdr (car tags-alist)
14248 (mapcar (lambda (x)
14249 (setq x (copy-sequence x))
14250 (org-add-prop-inherited x))
14251 (cdar tags-alist))))
14252 (when (and tags org-use-tag-inheritance
14253 (or (not (eq t org-use-tag-inheritance))
14254 org-tags-exclude-from-inheritance))
14255 ;; selective inheritance, remove uninherited ones
14256 (setcdr (car tags-alist)
14257 (org-remove-uninherited-tags (cdar tags-alist))))
14258 (when (and
14260 ;; eval matcher only when the todo condition is OK
14261 (and (or (not todo-only) (member todo org-not-done-keywords))
14262 (let ((case-fold-search t) (org-trust-scanner-tags t))
14263 (eval matcher)))
14265 ;; Call the skipper, but return t if it does not skip,
14266 ;; so that the `and' form continues evaluating
14267 (progn
14268 (unless (eq action 'sparse-tree) (org-agenda-skip))
14271 ;; Check if timestamps are deselecting this entry
14272 (or (not todo-only)
14273 (and (member todo org-not-done-keywords)
14274 (or (not org-agenda-tags-todo-honor-ignore-options)
14275 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14277 ;; select this headline
14278 (cond
14279 ((eq action 'sparse-tree)
14280 (and org-highlight-sparse-tree-matches
14281 (org-get-heading) (match-end 0)
14282 (org-highlight-new-match
14283 (match-beginning 1) (match-end 1)))
14284 (org-show-context 'tags-tree))
14285 ((eq action 'agenda)
14286 (setq txt (org-agenda-format-item
14288 (concat
14289 (if (eq org-tags-match-list-sublevels 'indented)
14290 (make-string (1- level) ?.) "")
14291 (org-get-heading))
14292 level category
14293 tags-list)
14294 priority (org-get-priority txt))
14295 (goto-char lspos)
14296 (setq marker (org-agenda-new-marker))
14297 (org-add-props txt props
14298 'org-marker marker 'org-hd-marker marker 'org-category category
14299 'todo-state todo
14300 'ts-date ts-date
14301 'priority priority
14302 'type (concat "tagsmatch" ts-date-type))
14303 (push txt rtn))
14304 ((functionp action)
14305 (setq org-map-continue-from nil)
14306 (save-excursion
14307 (setq rtn1 (funcall action))
14308 (push rtn1 rtn)))
14309 (t (user-error "Invalid action")))
14311 ;; if we are to skip sublevels, jump to end of subtree
14312 (unless org-tags-match-list-sublevels
14313 (org-end-of-subtree t)
14314 (backward-char 1))))
14315 ;; Get the correct position from where to continue
14316 (if org-map-continue-from
14317 (goto-char org-map-continue-from)
14318 (and (= (point) lspos) (end-of-line 1)))))
14319 (when (and (eq action 'sparse-tree)
14320 (not org-sparse-tree-open-archived-trees))
14321 (org-hide-archived-subtrees (point-min) (point-max)))
14322 (nreverse rtn)))
14324 (defun org-remove-uninherited-tags (tags)
14325 "Remove all tags that are not inherited from the list TAGS."
14326 (cond
14327 ((eq org-use-tag-inheritance t)
14328 (if org-tags-exclude-from-inheritance
14329 (org-delete-all org-tags-exclude-from-inheritance tags)
14330 tags))
14331 ((not org-use-tag-inheritance) nil)
14332 ((stringp org-use-tag-inheritance)
14333 (delq nil (mapcar
14334 (lambda (x)
14335 (if (and (string-match org-use-tag-inheritance x)
14336 (not (member x org-tags-exclude-from-inheritance)))
14337 x nil))
14338 tags)))
14339 ((listp org-use-tag-inheritance)
14340 (delq nil (mapcar
14341 (lambda (x)
14342 (if (member x org-use-tag-inheritance) x nil))
14343 tags)))))
14345 (defun org-match-sparse-tree (&optional todo-only match)
14346 "Create a sparse tree according to tags string MATCH.
14347 MATCH can contain positive and negative selection of tags, like
14348 \"+WORK+URGENT-WITHBOSS\".
14349 If optional argument TODO-ONLY is non-nil, only select lines that are
14350 also TODO lines."
14351 (interactive "P")
14352 (org-agenda-prepare-buffers (list (current-buffer)))
14353 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14355 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14357 (defvar org-cached-props nil)
14358 (defun org-cached-entry-get (pom property)
14359 (if (or (eq t org-use-property-inheritance)
14360 (and (stringp org-use-property-inheritance)
14361 (let ((case-fold-search t))
14362 (org-string-match-p org-use-property-inheritance property)))
14363 (and (listp org-use-property-inheritance)
14364 (member-ignore-case property org-use-property-inheritance)))
14365 ;; Caching is not possible, check it directly.
14366 (org-entry-get pom property 'inherit)
14367 ;; Get all properties, so we can do complicated checks easily.
14368 (cdr (assoc-string property
14369 (or org-cached-props
14370 (setq org-cached-props (org-entry-properties pom)))
14371 t))))
14373 (defun org-global-tags-completion-table (&optional files)
14374 "Return the list of all tags in all agenda buffer/files.
14375 Optional FILES argument is a list of files which can be used
14376 instead of the agenda files."
14377 (save-excursion
14378 (org-uniquify
14379 (delq nil
14380 (apply 'append
14381 (mapcar
14382 (lambda (file)
14383 (set-buffer (find-file-noselect file))
14384 (append (org-get-buffer-tags)
14385 (mapcar (lambda (x) (if (stringp (car-safe x))
14386 (list (car-safe x)) nil))
14387 org-tag-alist)))
14388 (if (and files (car files))
14389 files
14390 (org-agenda-files))))))))
14392 (defun org-make-tags-matcher (match)
14393 "Create the TAGS/TODO matcher form for the selection string MATCH.
14395 The variable `todo-only' is scoped dynamically into this function.
14396 It will be set to t if the matcher restricts matching to TODO entries,
14397 otherwise will not be touched.
14399 Returns a cons of the selection string MATCH and the constructed
14400 lisp form implementing the matcher. The matcher is to be evaluated
14401 at an Org entry, with point on the headline, and returns t if the
14402 entry matches the selection string MATCH. The returned lisp form
14403 references two variables with information about the entry, which
14404 must be bound around the form's evaluation: todo, the TODO keyword
14405 at the entry (or nil of none); and tags-list, the list of all tags
14406 at the entry including inherited ones. Additionally, the category
14407 of the entry (if any) must be specified as the text property
14408 'org-category on the headline.
14410 See also `org-scan-tags'.
14412 (declare (special todo-only))
14413 (unless (boundp 'todo-only)
14414 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14415 (unless match
14416 ;; Get a new match request, with completion against the global
14417 ;; tags table and the local tags in current buffer
14418 (let ((org-last-tags-completion-table
14419 (org-uniquify
14420 (delq nil (append (org-get-buffer-tags)
14421 (org-global-tags-completion-table))))))
14422 (setq match (org-completing-read-no-i
14423 "Match: " 'org-tags-completion-function nil nil nil
14424 'org-tags-history))))
14426 ;; Parse the string and create a lisp form
14427 (let ((match0 match)
14428 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14429 minus tag mm
14430 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14431 orterms term orlist re-p str-p level-p level-op time-p
14432 prop-p pn pv po gv rest (start 0) (ss 0))
14433 ;; Expand group tags
14434 (setq match (org-tags-expand match))
14436 ;; Check if there is a TODO part of this match, which would be the
14437 ;; part after a "/". TO make sure that this slash is not part of
14438 ;; a property value to be matched against, we also check that there
14439 ;; is no " after that slash.
14440 ;; First, find the last slash
14441 (while (string-match "/+" match ss)
14442 (setq start (match-beginning 0) ss (match-end 0)))
14443 (if (and (string-match "/+" match start)
14444 (not (save-match-data (string-match "\"" match start))))
14445 ;; match contains also a todo-matching request
14446 (progn
14447 (setq tagsmatch (substring match 0 (match-beginning 0))
14448 todomatch (substring match (match-end 0)))
14449 (if (string-match "^!" todomatch)
14450 (setq todo-only t todomatch (substring todomatch 1)))
14451 (if (string-match "^\\s-*$" todomatch)
14452 (setq todomatch nil)))
14453 ;; only matching tags
14454 (setq tagsmatch match todomatch nil))
14456 ;; Make the tags matcher
14457 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14458 (setq tagsmatcher t)
14459 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14460 (while (setq term (pop orterms))
14461 (while (and (equal (substring term -1) "\\") orterms)
14462 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14463 (while (string-match re term)
14464 (setq rest (substring term (match-end 0))
14465 minus (and (match-end 1)
14466 (equal (match-string 1 term) "-"))
14467 tag (save-match-data (replace-regexp-in-string
14468 "\\\\-" "-"
14469 (match-string 2 term)))
14470 re-p (equal (string-to-char tag) ?{)
14471 level-p (match-end 4)
14472 prop-p (match-end 5)
14473 mm (cond
14474 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14475 (level-p
14476 (setq level-op (org-op-to-function (match-string 3 term)))
14477 `(,level-op level ,(string-to-number
14478 (match-string 4 term))))
14479 (prop-p
14480 (setq pn (match-string 5 term)
14481 po (match-string 6 term)
14482 pv (match-string 7 term)
14483 re-p (equal (string-to-char pv) ?{)
14484 str-p (equal (string-to-char pv) ?\")
14485 time-p (save-match-data
14486 (string-match "^\"[[<].*[]>]\"$" pv))
14487 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14488 (if time-p (setq pv (org-matcher-time pv)))
14489 (setq po (org-op-to-function po (if time-p 'time str-p)))
14490 (cond
14491 ((equal pn "CATEGORY")
14492 (setq gv '(get-text-property (point) 'org-category)))
14493 ((equal pn "TODO")
14494 (setq gv 'todo))
14496 (setq gv `(org-cached-entry-get nil ,pn))))
14497 (if re-p
14498 (if (eq po 'org<>)
14499 `(not (string-match ,pv (or ,gv "")))
14500 `(string-match ,pv (or ,gv "")))
14501 (if str-p
14502 `(,po (or ,gv "") ,pv)
14503 `(,po (string-to-number (or ,gv ""))
14504 ,(string-to-number pv) ))))
14505 (t `(member ,tag tags-list)))
14506 mm (if minus (list 'not mm) mm)
14507 term rest)
14508 (push mm tagsmatcher))
14509 (push (if (> (length tagsmatcher) 1)
14510 (cons 'and tagsmatcher)
14511 (car tagsmatcher))
14512 orlist)
14513 (setq tagsmatcher nil))
14514 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14515 (setq tagsmatcher
14516 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14517 ;; Make the todo matcher
14518 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14519 (setq todomatcher t)
14520 (setq orterms (org-split-string todomatch "|") orlist nil)
14521 (while (setq term (pop orterms))
14522 (while (string-match re term)
14523 (setq minus (and (match-end 1)
14524 (equal (match-string 1 term) "-"))
14525 kwd (match-string 2 term)
14526 re-p (equal (string-to-char kwd) ?{)
14527 term (substring term (match-end 0))
14528 mm (if re-p
14529 `(string-match ,(substring kwd 1 -1) todo)
14530 (list 'equal 'todo kwd))
14531 mm (if minus (list 'not mm) mm))
14532 (push mm todomatcher))
14533 (push (if (> (length todomatcher) 1)
14534 (cons 'and todomatcher)
14535 (car todomatcher))
14536 orlist)
14537 (setq todomatcher nil))
14538 (setq todomatcher (if (> (length orlist) 1)
14539 (cons 'or orlist) (car orlist))))
14541 ;; Return the string and lisp forms of the matcher
14542 (setq matcher (if todomatcher
14543 (list 'and tagsmatcher todomatcher)
14544 tagsmatcher))
14545 (when todo-only
14546 (setq matcher (list 'and '(member todo org-not-done-keywords)
14547 matcher)))
14548 (cons match0 matcher)))
14550 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14551 "Expand group tags in MATCH.
14553 This replaces every group tag in MATCH with a regexp tag search.
14554 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14555 will be replaced like this:
14557 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14558 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14559 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14561 Replacing by a regexp preserves the structure of the match.
14562 E.g., this expansion
14564 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14566 will match anything tagged with \"Lab\" and \"Home\", or tagged
14567 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14569 A group tag in MATCH can contain regular expressions of its own.
14570 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14571 will be replaced like this:
14573 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14575 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14576 assumed to be a single group tag, and the function will return
14577 the list of tags in this group.
14579 When DOWNCASE is non-nil, expand downcased TAGS."
14580 (if org-group-tags
14581 (let* ((case-fold-search t)
14582 (stable org-mode-syntax-table)
14583 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14584 (taggroups (if downcased
14585 (mapcar (lambda (tg) (mapcar #'downcase tg))
14586 taggroups)
14587 taggroups))
14588 (taggroups-keys (mapcar #'car taggroups))
14589 (return-match (if downcased (downcase match) match))
14590 (count 0)
14591 (work-already-expanded tags-already-expanded)
14592 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14593 ;; @ and _ are allowed as word-components in tags.
14594 (modify-syntax-entry ?@ "w" stable)
14595 (modify-syntax-entry ?_ "w" stable)
14596 ;; Temporarily replace regexp-expressions in the match-expression.
14597 (while (string-match "{.+?}" return-match)
14598 (incf count)
14599 (push (match-string 0 return-match) regexps-in-match)
14600 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14601 (while (and taggroups-keys
14602 (with-syntax-table stable
14603 (string-match
14604 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14605 (regexp-opt taggroups-keys) "\\>\\)") return-match)))
14606 (let* ((dir (match-string 1 return-match))
14607 (tag (match-string 2 return-match))
14608 (tag (if downcased (downcase tag) tag)))
14609 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14610 (member tag work-already-expanded))
14611 (setq tags-in-group (assoc tag taggroups))
14612 (push tag work-already-expanded)
14613 ;; Recursively expand each tag in the group, if the tag hasn't
14614 ;; already been expanded. Restore the match-data after all recursive calls.
14615 (save-match-data
14616 (let (tags-expanded)
14617 (dolist (x (cdr tags-in-group))
14618 (if (and (member x taggroups-keys)
14619 (not (member x work-already-expanded)))
14620 (setq tags-expanded
14621 (delete-dups
14622 (append
14623 (org-tags-expand x t downcased
14624 work-already-expanded)
14625 tags-expanded)))
14626 (setq tags-expanded
14627 (append (list x) tags-expanded)))
14628 (setq work-already-expanded
14629 (delete-dups
14630 (append tags-expanded
14631 work-already-expanded))))
14632 (setq tags-in-group
14633 (delete-dups (cons (car tags-in-group)
14634 tags-expanded)))))
14635 ;; Filter tag-regexps from tags.
14636 (setq regexp-in-group-escaped
14637 (delq nil (mapcar (lambda (x)
14638 (if (stringp x)
14639 (and (equal "{" (substring x 0 1))
14640 (equal "}" (substring x -1))
14643 tags-in-group))
14644 regexp-in-group
14645 (mapcar (lambda (x)
14646 (substring x 1 -1))
14647 regexp-in-group-escaped)
14648 tags-in-group
14649 (delq nil (mapcar (lambda (x)
14650 (if (stringp x)
14651 (and (not (equal "{" (substring x 0 1)))
14652 (not (equal "}" (substring x -1)))
14655 tags-in-group)))
14656 ;; If single-as-list, do no more in the while-loop.
14657 (if (not single-as-list)
14658 (progn
14659 (when regexp-in-group
14660 (setq regexp-in-group
14661 (concat "\\|"
14662 (mapconcat 'identity regexp-in-group
14663 "\\|"))))
14664 (setq tags-in-group
14665 (concat dir
14666 "{\\<"
14667 (regexp-opt tags-in-group)
14668 "\\>"
14669 regexp-in-group
14670 "}"))
14671 (when (stringp tags-in-group)
14672 (org-add-props tags-in-group '(grouptag t)))
14673 (setq return-match
14674 (replace-match tags-in-group t t return-match)))
14675 (setq tags-in-group
14676 (append regexp-in-group-escaped tags-in-group))))
14677 (setq taggroups-keys (delete tag taggroups-keys))))
14678 ;; Add the regular expressions back into the match-expression again.
14679 (while regexps-in-match
14680 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14681 (pop regexps-in-match)
14682 return-match t t))
14683 (decf count))
14684 (if single-as-list
14685 (if tags-in-group tags-in-group (list return-match))
14686 return-match))
14687 (if single-as-list
14688 (list (if downcased (downcase match) match))
14689 match)))
14691 (defun org-op-to-function (op &optional stringp)
14692 "Turn an operator into the appropriate function."
14693 (setq op
14694 (cond
14695 ((equal op "<" ) '(< string< org-time<))
14696 ((equal op ">" ) '(> org-string> org-time>))
14697 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14698 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14699 ((member op '("=" "==")) '(= string= org-time=))
14700 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14701 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14703 (defun org<> (a b) (not (= a b)))
14704 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14705 (defun org-string>= (a b) (not (string< a b)))
14706 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14707 (defun org-string<> (a b) (not (string= a b)))
14708 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14709 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14710 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14711 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14712 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14713 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14714 (defun org-2ft (s)
14715 "Convert S to a floating point time.
14716 If S is already a number, just return it. If it is a string, parse
14717 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14718 (cond
14719 ((numberp s) s)
14720 ((stringp s)
14721 (condition-case nil
14722 (float-time (apply 'encode-time (org-parse-time-string s)))
14723 (error 0.)))
14724 (t 0.)))
14726 (defun org-time-today ()
14727 "Time in seconds today at 0:00.
14728 Returns the float number of seconds since the beginning of the
14729 epoch to the beginning of today (00:00)."
14730 (float-time (apply 'encode-time
14731 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14733 (defun org-matcher-time (s)
14734 "Interpret a time comparison value."
14735 (save-match-data
14736 (cond
14737 ((string= s "<now>") (float-time))
14738 ((string= s "<today>") (org-time-today))
14739 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14740 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14741 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14742 (+ (org-time-today)
14743 (* (string-to-number (match-string 1 s))
14744 (cdr (assoc (match-string 2 s)
14745 '(("d" . 86400.0) ("w" . 604800.0)
14746 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14747 (t (org-2ft s)))))
14749 (defun org-match-any-p (re list)
14750 "Does re match any element of list?"
14751 (setq list (mapcar (lambda (x) (string-match re x)) list))
14752 (delq nil list))
14754 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14755 (defvar org-tags-overlay (make-overlay 1 1))
14756 (org-detach-overlay org-tags-overlay)
14758 (defun org-get-local-tags-at (&optional pos)
14759 "Get a list of tags defined in the current headline."
14760 (org-get-tags-at pos 'local))
14762 (defun org-get-local-tags ()
14763 "Get a list of tags defined in the current headline."
14764 (org-get-tags-at nil 'local))
14766 (defun org-get-tags-at (&optional pos local)
14767 "Get a list of all headline tags applicable at POS.
14768 POS defaults to point. If tags are inherited, the list contains
14769 the targets in the same sequence as the headlines appear, i.e.
14770 the tags of the current headline come last.
14771 When LOCAL is non-nil, only return tags from the current headline,
14772 ignore inherited ones."
14773 (interactive)
14774 (if (and org-trust-scanner-tags
14775 (or (not pos) (equal pos (point)))
14776 (not local))
14777 org-scanner-tags
14778 (let (tags ltags lastpos parent)
14779 (save-excursion
14780 (save-restriction
14781 (widen)
14782 (goto-char (or pos (point)))
14783 (save-match-data
14784 (catch 'done
14785 (condition-case nil
14786 (progn
14787 (org-back-to-heading t)
14788 (while (not (equal lastpos (point)))
14789 (setq lastpos (point))
14790 (when (looking-at
14791 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14792 (setq ltags (org-split-string
14793 (org-match-string-no-properties 1) ":"))
14794 (when parent
14795 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14796 (setq tags (append
14797 (if parent
14798 (org-remove-uninherited-tags ltags)
14799 ltags)
14800 tags)))
14801 (or org-use-tag-inheritance (throw 'done t))
14802 (if local (throw 'done t))
14803 (or (org-up-heading-safe) (error nil))
14804 (setq parent t)))
14805 (error nil)))))
14806 (if local
14807 tags
14808 (reverse (delete-dups
14809 (reverse (append
14810 (org-remove-uninherited-tags
14811 org-file-tags) tags)))))))))
14813 (defun org-add-prop-inherited (s)
14814 (add-text-properties 0 (length s) '(inherited t) s)
14817 (defun org-toggle-tag (tag &optional onoff)
14818 "Toggle the tag TAG for the current line.
14819 If ONOFF is `on' or `off', don't toggle but set to this state."
14820 (let (res current)
14821 (save-excursion
14822 (org-back-to-heading t)
14823 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14824 (point-at-eol) t)
14825 (progn
14826 (setq current (match-string 1))
14827 (replace-match ""))
14828 (setq current ""))
14829 (setq current (nreverse (org-split-string current ":")))
14830 (cond
14831 ((eq onoff 'on)
14832 (setq res t)
14833 (or (member tag current) (push tag current)))
14834 ((eq onoff 'off)
14835 (or (not (member tag current)) (setq current (delete tag current))))
14836 (t (if (member tag current)
14837 (setq current (delete tag current))
14838 (setq res t)
14839 (push tag current))))
14840 (end-of-line 1)
14841 (if current
14842 (progn
14843 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14844 (org-set-tags nil t))
14845 (delete-horizontal-space))
14846 (run-hooks 'org-after-tags-change-hook))
14847 res))
14849 (defun org-align-tags-here (to-col)
14850 ;; Assumes that this is a headline
14851 "Align tags on the current headline to TO-COL."
14852 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14853 (beginning-of-line 1)
14854 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14855 (< pos (match-beginning 2)))
14856 (progn
14857 (setq tags-l (- (match-end 2) (match-beginning 2)))
14858 (goto-char (match-beginning 1))
14859 (insert " ")
14860 (delete-region (point) (1+ (match-beginning 2)))
14861 (setq ncol (max (current-column)
14862 (1+ col)
14863 (if (> to-col 0)
14864 to-col
14865 (- (abs to-col) tags-l))))
14866 (setq p (point))
14867 (insert (make-string (- ncol (current-column)) ?\ ))
14868 (setq ncol (current-column))
14869 (when indent-tabs-mode (tabify p (point-at-eol)))
14870 (org-move-to-column (min ncol col)))
14871 (goto-char pos))))
14873 (defun org-set-tags-command (&optional arg just-align)
14874 "Call the set-tags command for the current entry."
14875 (interactive "P")
14876 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14877 (org-set-tags arg just-align)
14878 (save-excursion
14879 (unless (and (org-region-active-p)
14880 org-loop-over-headlines-in-active-region)
14881 (org-back-to-heading t))
14882 (org-set-tags arg just-align))))
14884 (defun org-set-tags-to (data)
14885 "Set the tags of the current entry to DATA, replacing the current tags.
14886 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14887 If DATA is nil or the empty string, any tags will be removed."
14888 (interactive "sTags: ")
14889 (setq data
14890 (cond
14891 ((eq data nil) "")
14892 ((equal data "") "")
14893 ((stringp data)
14894 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14895 ":"))
14896 ((listp data)
14897 (concat ":" (mapconcat 'identity data ":") ":"))))
14898 (when data
14899 (save-excursion
14900 (org-back-to-heading t)
14901 (when (looking-at org-complex-heading-regexp)
14902 (if (match-end 5)
14903 (progn
14904 (goto-char (match-beginning 5))
14905 (insert data)
14906 (delete-region (point) (point-at-eol))
14907 (org-set-tags nil 'align))
14908 (goto-char (point-at-eol))
14909 (insert " " data)
14910 (org-set-tags nil 'align)))
14911 (beginning-of-line 1)
14912 (if (looking-at ".*?\\([ \t]+\\)$")
14913 (delete-region (match-beginning 1) (match-end 1))))))
14915 (defun org-align-all-tags ()
14916 "Align the tags i all headings."
14917 (interactive)
14918 (save-excursion
14919 (or (ignore-errors (org-back-to-heading t))
14920 (outline-next-heading))
14921 (if (org-at-heading-p)
14922 (org-set-tags t)
14923 (message "No headings"))))
14925 (defvar org-indent-indentation-per-level)
14926 (defun org-set-tags (&optional arg just-align)
14927 "Set the tags for the current headline.
14928 With prefix ARG, realign all tags in headings in the current buffer.
14929 When JUST-ALIGN is non-nil, only align tags."
14930 (interactive "P")
14931 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14932 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14933 'region-start-level 'region))
14934 org-loop-over-headlines-in-active-region)
14935 (org-map-entries
14936 ;; We don't use ARG and JUST-ALIGN here because these args
14937 ;; are not useful when looping over headlines.
14938 `(org-set-tags)
14939 org-loop-over-headlines-in-active-region
14940 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14941 (let* ((re org-outline-regexp-bol)
14942 (current (unless arg (org-get-tags-string)))
14943 (col (current-column))
14944 (org-setting-tags t)
14945 table current-tags inherited-tags ; computed below when needed
14946 tags p0 c0 c1 rpl di tc level)
14947 (if arg
14948 (save-excursion
14949 (goto-char (point-min))
14950 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14951 (while (re-search-forward re nil t)
14952 (org-set-tags nil t)
14953 (end-of-line 1)))
14954 (message "All tags realigned to column %d" org-tags-column))
14955 (if just-align
14956 (setq tags current)
14957 ;; Get a new set of tags from the user
14958 (save-excursion
14959 (setq table (append org-tag-persistent-alist
14960 (or org-tag-alist (org-get-buffer-tags))
14961 (and
14962 org-complete-tags-always-offer-all-agenda-tags
14963 (org-global-tags-completion-table
14964 (org-agenda-files))))
14965 org-last-tags-completion-table table
14966 current-tags (org-split-string current ":")
14967 inherited-tags (nreverse
14968 (nthcdr (length current-tags)
14969 (nreverse (org-get-tags-at))))
14970 tags
14971 (if (or (eq t org-use-fast-tag-selection)
14972 (and org-use-fast-tag-selection
14973 (delq nil (mapcar 'cdr table))))
14974 (org-fast-tag-selection
14975 current-tags inherited-tags table
14976 (if org-fast-tag-selection-include-todo
14977 org-todo-key-alist))
14978 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14979 (org-trim
14980 (org-icompleting-read "Tags: "
14981 'org-tags-completion-function
14982 nil nil current 'org-tags-history))))))
14983 (while (string-match "[-+&]+" tags)
14984 ;; No boolean logic, just a list
14985 (setq tags (replace-match ":" t t tags))))
14987 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14989 (if org-tags-sort-function
14990 (setq tags (mapconcat 'identity
14991 (sort (org-split-string
14992 tags (org-re "[^[:alnum:]_@#%]+"))
14993 org-tags-sort-function) ":")))
14995 (if (string-match "\\`[\t ]*\\'" tags)
14996 (setq tags "")
14997 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14998 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15000 ;; Insert new tags at the correct column
15001 (beginning-of-line 1)
15002 (setq level (or (and (looking-at org-outline-regexp)
15003 (- (match-end 0) (point) 1))
15005 (cond
15006 ((and (equal current "") (equal tags "")))
15007 ((re-search-forward
15008 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15009 (point-at-eol) t)
15010 (if (equal tags "")
15011 (setq rpl "")
15012 (goto-char (match-beginning 0))
15013 (setq c0 (current-column)
15014 ;; compute offset for the case of org-indent-mode active
15015 di (if (org-bound-and-true-p org-indent-mode)
15016 (* (1- org-indent-indentation-per-level) (1- level))
15018 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
15019 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
15020 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
15021 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15022 (replace-match rpl t t)
15023 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15024 tags)
15025 (t (error "Tags alignment failed")))
15026 (org-move-to-column col)
15027 (unless just-align
15028 (run-hooks 'org-after-tags-change-hook))))))
15030 (defun org-change-tag-in-region (beg end tag off)
15031 "Add or remove TAG for each entry in the region.
15032 This works in the agenda, and also in an org-mode buffer."
15033 (interactive
15034 (list (region-beginning) (region-end)
15035 (let ((org-last-tags-completion-table
15036 (if (derived-mode-p 'org-mode)
15037 (org-uniquify
15038 (delq nil (append (org-get-buffer-tags)
15039 (org-global-tags-completion-table))))
15040 (org-global-tags-completion-table))))
15041 (org-icompleting-read
15042 "Tag: " 'org-tags-completion-function nil nil nil
15043 'org-tags-history))
15044 (progn
15045 (message "[s]et or [r]emove? ")
15046 (equal (read-char-exclusive) ?r))))
15047 (if (fboundp 'deactivate-mark) (deactivate-mark))
15048 (let ((agendap (equal major-mode 'org-agenda-mode))
15049 l1 l2 m buf pos newhead (cnt 0))
15050 (goto-char end)
15051 (setq l2 (1- (org-current-line)))
15052 (goto-char beg)
15053 (setq l1 (org-current-line))
15054 (loop for l from l1 to l2 do
15055 (org-goto-line l)
15056 (setq m (get-text-property (point) 'org-hd-marker))
15057 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15058 (and agendap m))
15059 (setq buf (if agendap (marker-buffer m) (current-buffer))
15060 pos (if agendap m (point)))
15061 (with-current-buffer buf
15062 (save-excursion
15063 (save-restriction
15064 (goto-char pos)
15065 (setq cnt (1+ cnt))
15066 (org-toggle-tag tag (if off 'off 'on))
15067 (setq newhead (org-get-heading)))))
15068 (and agendap (org-agenda-change-all-lines newhead m))))
15069 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15071 (defun org-tags-completion-function (string predicate &optional flag)
15072 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15073 (confirm (lambda (x) (stringp (car x)))))
15074 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15075 (setq s1 (match-string 1 string)
15076 s2 (match-string 2 string))
15077 (setq s1 "" s2 string))
15078 (cond
15079 ((eq flag nil)
15080 ;; try completion
15081 (setq rtn (try-completion s2 ctable confirm))
15082 (if (stringp rtn)
15083 (setq rtn
15084 (concat s1 s2 (substring rtn (length s2))
15085 (if (and org-add-colon-after-tag-completion
15086 (assoc rtn ctable))
15087 ":" ""))))
15088 rtn)
15089 ((eq flag t)
15090 ;; all-completions
15091 (all-completions s2 ctable confirm))
15092 ((eq flag 'lambda)
15093 ;; exact match?
15094 (assoc s2 ctable)))))
15096 (defun org-fast-tag-insert (kwd tags face &optional end)
15097 "Insert KDW, and the TAGS, the latter with face FACE.
15098 Also insert END."
15099 (insert (format "%-12s" (concat kwd ":"))
15100 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15101 (or end "")))
15103 (defun org-fast-tag-show-exit (flag)
15104 (save-excursion
15105 (org-goto-line 3)
15106 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15107 (replace-match ""))
15108 (when flag
15109 (end-of-line 1)
15110 (org-move-to-column (- (window-width) 19) t)
15111 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15113 (defun org-set-current-tags-overlay (current prefix)
15114 "Add an overlay to CURRENT tag with PREFIX."
15115 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15116 (if (featurep 'xemacs)
15117 (org-overlay-display org-tags-overlay (concat prefix s)
15118 'secondary-selection)
15119 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15120 (org-overlay-display org-tags-overlay (concat prefix s)))))
15122 (defvar org-last-tag-selection-key nil)
15123 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15124 "Fast tag selection with single keys.
15125 CURRENT is the current list of tags in the headline, INHERITED is the
15126 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15127 possibly with grouping information. TODO-TABLE is a similar table with
15128 TODO keywords, should these have keys assigned to them.
15129 If the keys are nil, a-z are automatically assigned.
15130 Returns the new tags string, or nil to not change the current settings."
15131 (let* ((fulltable (append table todo-table))
15132 (maxlen (apply 'max (mapcar
15133 (lambda (x)
15134 (if (stringp (car x)) (string-width (car x)) 0))
15135 fulltable)))
15136 (buf (current-buffer))
15137 (expert (eq org-fast-tag-selection-single-key 'expert))
15138 (buffer-tags nil)
15139 (fwidth (+ maxlen 3 1 3))
15140 (ncol (/ (- (window-width) 4) fwidth))
15141 (i-face 'org-done)
15142 (c-face 'org-todo)
15143 tg cnt e c char c1 c2 ntable tbl rtn
15144 ov-start ov-end ov-prefix
15145 (exit-after-next org-fast-tag-selection-single-key)
15146 (done-keywords org-done-keywords)
15147 groups ingroup intaggroup)
15148 (save-excursion
15149 (beginning-of-line 1)
15150 (if (looking-at
15151 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15152 (setq ov-start (match-beginning 1)
15153 ov-end (match-end 1)
15154 ov-prefix "")
15155 (setq ov-start (1- (point-at-eol))
15156 ov-end (1+ ov-start))
15157 (skip-chars-forward "^\n\r")
15158 (setq ov-prefix
15159 (concat
15160 (buffer-substring (1- (point)) (point))
15161 (if (> (current-column) org-tags-column)
15163 (make-string (- org-tags-column (current-column)) ?\ ))))))
15164 (move-overlay org-tags-overlay ov-start ov-end)
15165 (save-window-excursion
15166 (if expert
15167 (set-buffer (get-buffer-create " *Org tags*"))
15168 (delete-other-windows)
15169 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15170 (org-switch-to-buffer-other-window " *Org tags*"))
15171 (erase-buffer)
15172 (org-set-local 'org-done-keywords done-keywords)
15173 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15174 (org-fast-tag-insert "Current" current c-face "\n\n")
15175 (org-fast-tag-show-exit exit-after-next)
15176 (org-set-current-tags-overlay current ov-prefix)
15177 (setq tbl fulltable char ?a cnt 0)
15178 (while (setq e (pop tbl))
15179 (cond
15180 ((eq (car e) :startgroup)
15181 (push '() groups) (setq ingroup t)
15182 (unless (zerop cnt)
15183 (setq cnt 0)
15184 (insert "\n"))
15185 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15186 ((eq (car e) :endgroup)
15187 (setq ingroup nil cnt 0)
15188 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15189 ((eq (car e) :startgrouptag)
15190 (setq intaggroup t)
15191 (unless (zerop cnt)
15192 (setq cnt 0)
15193 (insert "\n"))
15194 (insert "[ "))
15195 ((eq (car e) :endgrouptag)
15196 (setq intaggroup nil cnt 0)
15197 (insert "]\n"))
15198 ((equal e '(:newline))
15199 (unless (zerop cnt)
15200 (setq cnt 0)
15201 (insert "\n")
15202 (setq e (car tbl))
15203 (while (equal (car tbl) '(:newline))
15204 (insert "\n")
15205 (setq tbl (cdr tbl)))))
15206 ((equal e '(:grouptags)) (insert " : "))
15208 (setq tg (copy-sequence (car e)) c2 nil)
15209 (if (cdr e)
15210 (setq c (cdr e))
15211 ;; automatically assign a character.
15212 (setq c1 (string-to-char
15213 (downcase (substring
15214 tg (if (= (string-to-char tg) ?@) 1 0)))))
15215 (if (or (rassoc c1 ntable) (rassoc c1 table))
15216 (while (or (rassoc char ntable) (rassoc char table))
15217 (setq char (1+ char)))
15218 (setq c2 c1))
15219 (setq c (or c2 char)))
15220 (when ingroup (push tg (car groups)))
15221 (setq tg (org-add-props tg nil 'face
15222 (cond
15223 ((not (assoc tg table))
15224 (org-get-todo-face tg))
15225 ((member tg current) c-face)
15226 ((member tg inherited) i-face))))
15227 (when (equal (caar tbl) :grouptags)
15228 (org-add-props tg nil 'face 'org-tag-group))
15229 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15230 (insert "[" c "] " tg (make-string
15231 (- fwidth 4 (length tg)) ?\ ))
15232 (push (cons tg c) ntable)
15233 (when (= (incf cnt) ncol)
15234 (insert "\n")
15235 (when (or ingroup intaggroup) (insert " "))
15236 (setq cnt 0)))))
15237 (setq ntable (nreverse ntable))
15238 (insert "\n")
15239 (goto-char (point-min))
15240 (unless expert (org-fit-window-to-buffer))
15241 (setq rtn
15242 (catch 'exit
15243 (while t
15244 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15245 (if (not groups) "no " "")
15246 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15247 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15248 (setq org-last-tag-selection-key c)
15249 (cond
15250 ((= c ?\r) (throw 'exit t))
15251 ((= c ?!)
15252 (setq groups (not groups))
15253 (goto-char (point-min))
15254 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15255 ((= c ?\C-c)
15256 (if (not expert)
15257 (org-fast-tag-show-exit
15258 (setq exit-after-next (not exit-after-next)))
15259 (setq expert nil)
15260 (delete-other-windows)
15261 (set-window-buffer (split-window-vertically) " *Org tags*")
15262 (org-switch-to-buffer-other-window " *Org tags*")
15263 (org-fit-window-to-buffer)))
15264 ((or (= c ?\C-g)
15265 (and (= c ?q) (not (rassoc c ntable))))
15266 (org-detach-overlay org-tags-overlay)
15267 (setq quit-flag t))
15268 ((= c ?\ )
15269 (setq current nil)
15270 (when exit-after-next (setq exit-after-next 'now)))
15271 ((= c ?\t)
15272 (condition-case nil
15273 (setq tg (org-icompleting-read
15274 "Tag: "
15275 (or buffer-tags
15276 (with-current-buffer buf
15277 (org-get-buffer-tags)))))
15278 (quit (setq tg "")))
15279 (when (string-match "\\S-" tg)
15280 (add-to-list 'buffer-tags (list tg))
15281 (if (member tg current)
15282 (setq current (delete tg current))
15283 (push tg current)))
15284 (when exit-after-next (setq exit-after-next 'now)))
15285 ((setq e (rassoc c todo-table) tg (car e))
15286 (with-current-buffer buf
15287 (save-excursion (org-todo tg)))
15288 (when exit-after-next (setq exit-after-next 'now)))
15289 ((setq e (rassoc c ntable) tg (car e))
15290 (if (member tg current)
15291 (setq current (delete tg current))
15292 (loop for g in groups do
15293 (when (member tg g)
15294 (dolist (x g) (setq current (delete x current)))))
15295 (push tg current))
15296 (when exit-after-next (setq exit-after-next 'now))))
15298 ;; Create a sorted list
15299 (setq current
15300 (sort current
15301 (lambda (a b)
15302 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15303 (when (eq exit-after-next 'now) (throw 'exit t))
15304 (goto-char (point-min))
15305 (beginning-of-line 2)
15306 (delete-region (point) (point-at-eol))
15307 (org-fast-tag-insert "Current" current c-face)
15308 (org-set-current-tags-overlay current ov-prefix)
15309 (while (re-search-forward
15310 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15311 (setq tg (match-string 1))
15312 (add-text-properties
15313 (match-beginning 1) (match-end 1)
15314 (list 'face
15315 (cond
15316 ((member tg current) c-face)
15317 ((member tg inherited) i-face)
15318 (t (get-text-property (match-beginning 1) 'face))))))
15319 (goto-char (point-min)))))
15320 (org-detach-overlay org-tags-overlay)
15321 (if rtn
15322 (mapconcat 'identity current ":")
15323 nil))))
15325 (defun org-get-tags-string ()
15326 "Get the TAGS string in the current headline."
15327 (unless (org-at-heading-p t)
15328 (user-error "Not on a heading"))
15329 (save-excursion
15330 (beginning-of-line 1)
15331 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15332 (org-match-string-no-properties 1)
15333 "")))
15335 (defun org-get-tags ()
15336 "Get the list of tags specified in the current headline."
15337 (org-split-string (org-get-tags-string) ":"))
15339 (defun org-get-buffer-tags ()
15340 "Get a table of all tags used in the buffer, for completion."
15341 (org-with-wide-buffer
15342 (goto-char (point-min))
15343 (let ((tag-re (concat org-outline-regexp-bol
15344 "\\(?:.*?[ \t]\\)?"
15345 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15346 tags)
15347 (while (re-search-forward tag-re nil t)
15348 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15349 (push tag tags)))
15350 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15352 ;;;; The mapping API
15354 (defun org-map-entries (func &optional match scope &rest skip)
15355 "Call FUNC at each headline selected by MATCH in SCOPE.
15357 FUNC is a function or a lisp form. The function will be called without
15358 arguments, with the cursor positioned at the beginning of the headline.
15359 The return values of all calls to the function will be collected and
15360 returned as a list.
15362 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15363 does not need to preserve point. After evaluation, the cursor will be
15364 moved to the end of the line (presumably of the headline of the
15365 processed entry) and search continues from there. Under some
15366 circumstances, this may not produce the wanted results. For example,
15367 if you have removed (e.g. archived) the current (sub)tree it could
15368 mean that the next entry will be skipped entirely. In such cases, you
15369 can specify the position from where search should continue by making
15370 FUNC set the variable `org-map-continue-from' to the desired buffer
15371 position.
15373 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15374 Only headlines that are matched by this query will be considered during
15375 the iteration. When MATCH is nil or t, all headlines will be
15376 visited by the iteration.
15378 SCOPE determines the scope of this command. It can be any of:
15380 nil The current buffer, respecting the restriction if any
15381 tree The subtree started with the entry at point
15382 region The entries within the active region, if any
15383 region-start-level
15384 The entries within the active region, but only those at
15385 the same level than the first one.
15386 file The current buffer, without restriction
15387 file-with-archives
15388 The current buffer, and any archives associated with it
15389 agenda All agenda files
15390 agenda-with-archives
15391 All agenda files with any archive files associated with them
15392 \(file1 file2 ...)
15393 If this is a list, all files in the list will be scanned
15395 The remaining args are treated as settings for the skipping facilities of
15396 the scanner. The following items can be given here:
15398 archive skip trees with the archive tag
15399 comment skip trees with the COMMENT keyword
15400 function or Emacs Lisp form:
15401 will be used as value for `org-agenda-skip-function', so
15402 whenever the function returns a position, FUNC will not be
15403 called for that entry and search will continue from the
15404 position returned
15406 If your function needs to retrieve the tags including inherited tags
15407 at the *current* entry, you can use the value of the variable
15408 `org-scanner-tags' which will be much faster than getting the value
15409 with `org-get-tags-at'. If your function gets properties with
15410 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15411 to t around the call to `org-entry-properties' to get the same speedup.
15412 Note that if your function moves around to retrieve tags and properties at
15413 a *different* entry, you cannot use these techniques."
15414 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15415 (not (org-region-active-p)))
15416 (let* ((org-agenda-archives-mode nil) ; just to make sure
15417 (org-agenda-skip-archived-trees (memq 'archive skip))
15418 (org-agenda-skip-comment-trees (memq 'comment skip))
15419 (org-agenda-skip-function
15420 (car (org-delete-all '(comment archive) skip)))
15421 (org-tags-match-list-sublevels t)
15422 (start-level (eq scope 'region-start-level))
15423 matcher file res
15424 org-todo-keywords-for-agenda
15425 org-done-keywords-for-agenda
15426 org-todo-keyword-alist-for-agenda
15427 org-tag-alist-for-agenda
15428 todo-only)
15430 (cond
15431 ((eq match t) (setq matcher t))
15432 ((eq match nil) (setq matcher t))
15433 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15435 (save-excursion
15436 (save-restriction
15437 (cond ((eq scope 'tree)
15438 (org-back-to-heading t)
15439 (org-narrow-to-subtree)
15440 (setq scope nil))
15441 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15442 (org-region-active-p))
15443 ;; If needed, set start-level to a string like "2"
15444 (when start-level
15445 (save-excursion
15446 (goto-char (region-beginning))
15447 (unless (org-at-heading-p) (outline-next-heading))
15448 (setq start-level (org-current-level))))
15449 (narrow-to-region (region-beginning)
15450 (save-excursion
15451 (goto-char (region-end))
15452 (unless (and (bolp) (org-at-heading-p))
15453 (outline-next-heading))
15454 (point)))
15455 (setq scope nil)))
15457 (if (not scope)
15458 (progn
15459 (org-agenda-prepare-buffers
15460 (list (buffer-file-name (current-buffer))))
15461 (setq res (org-scan-tags func matcher todo-only start-level)))
15462 ;; Get the right scope
15463 (cond
15464 ((and scope (listp scope) (symbolp (car scope)))
15465 (setq scope (eval scope)))
15466 ((eq scope 'agenda)
15467 (setq scope (org-agenda-files t)))
15468 ((eq scope 'agenda-with-archives)
15469 (setq scope (org-agenda-files t))
15470 (setq scope (org-add-archive-files scope)))
15471 ((eq scope 'file)
15472 (setq scope (list (buffer-file-name))))
15473 ((eq scope 'file-with-archives)
15474 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15475 (org-agenda-prepare-buffers scope)
15476 (while (setq file (pop scope))
15477 (with-current-buffer (org-find-base-buffer-visiting file)
15478 (save-excursion
15479 (save-restriction
15480 (widen)
15481 (goto-char (point-min))
15482 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15483 res)))
15485 ;;; Properties API
15487 (defconst org-special-properties
15488 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15489 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15490 "The special properties valid in Org mode.
15491 These are properties that are not defined in the property drawer,
15492 but in some other way.")
15494 (defconst org-default-properties
15495 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15496 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15497 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15498 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15499 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15500 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15501 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15502 "Some properties that are used by Org mode for various purposes.
15503 Being in this list makes sure that they are offered for completion.")
15505 (defun org--update-property-plist (key val props)
15506 "Associate KEY to VAL in alist PROPS.
15507 Modifications are made by side-effect. Return new alist."
15508 (let* ((appending (string= (substring key -1) "+"))
15509 (key (if appending (substring key 0 -1) key))
15510 (old (assoc-string key props t)))
15511 (if (not old) (cons (cons key val) props)
15512 (setcdr old (if appending (concat (cdr old) " " val) val))
15513 props)))
15515 (defun org-get-property-block (&optional beg force)
15516 "Return the (beg . end) range of the body of the property drawer.
15517 BEG is the beginning of the current subtree, or of the part
15518 before the first headline. If it is not given, it will be found.
15519 If the drawer does not exist, create it if FORCE is non-nil, or
15520 return nil."
15521 (org-with-wide-buffer
15522 (when beg (goto-char beg))
15523 (unless (org-before-first-heading-p)
15524 (let ((beg (cond (beg)
15525 ((or (not (featurep 'org-inlinetask))
15526 (org-inlinetask-in-task-p))
15527 (org-back-to-heading t))
15528 (t (org-with-limited-levels (org-back-to-heading t))))))
15529 (forward-line)
15530 (when (org-looking-at-p org-planning-line-re) (forward-line))
15531 (cond ((looking-at org-property-drawer-re)
15532 (forward-line)
15533 (cons (point) (progn (goto-char (match-end 0))
15534 (line-beginning-position))))
15535 (force
15536 (goto-char beg)
15537 (org-insert-property-drawer)
15538 (let ((pos (save-excursion (search-forward ":END:")
15539 (line-beginning-position))))
15540 (cons pos pos))))))))
15542 (defun org-at-property-p ()
15543 "Non-nil when point is inside a property drawer.
15544 See `org-property-re' for match data, if applicable."
15545 (save-excursion
15546 (beginning-of-line)
15547 (and (looking-at org-property-re)
15548 (let ((property-drawer (save-match-data (org-get-property-block))))
15549 (and property-drawer (< (point) (cdr property-drawer)))))))
15551 (defun org-property-action ()
15552 "Do an action on properties."
15553 (interactive)
15554 (unless (org-at-property-p) (user-error "Not at a property"))
15555 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15556 (let ((c (read-char-exclusive)))
15557 (case c
15558 (?s (call-interactively #'org-set-property))
15559 (?d (call-interactively #'org-delete-property))
15560 (?D (call-interactively #'org-delete-property-globally))
15561 (?c (call-interactively #'org-compute-property-at-point))
15562 (otherwise (user-error "No such property action %c" c)))))
15564 (defun org-inc-effort ()
15565 "Increment the value of the effort property in the current entry."
15566 (interactive)
15567 (org-set-effort nil t))
15569 (defvar org-clock-effort) ; Defined in org-clock.el.
15570 (defvar org-clock-current-task) ; Defined in org-clock.el.
15571 (defun org-set-effort (&optional value increment)
15572 "Set the effort property of the current entry.
15573 With numerical prefix arg, use the nth allowed value, 0 stands for the
15574 10th allowed value.
15576 When INCREMENT is non-nil, set the property to the next allowed value."
15577 (interactive "P")
15578 (if (equal value 0) (setq value 10))
15579 (let* ((completion-ignore-case t)
15580 (prop org-effort-property)
15581 (cur (org-entry-get nil prop))
15582 (allowed (org-property-get-allowed-values nil prop 'table))
15583 (existing (mapcar 'list (org-property-values prop)))
15584 (heading (nth 4 (org-heading-components)))
15586 (val (cond
15587 ((stringp value) value)
15588 ((and allowed (integerp value))
15589 (or (car (nth (1- value) allowed))
15590 (car (org-last allowed))))
15591 ((and allowed increment)
15592 (or (caadr (member (list cur) allowed))
15593 (user-error "Allowed effort values are not set")))
15594 (allowed
15595 (message "Select 1-9,0, [RET%s]: %s"
15596 (if cur (concat "=" cur) "")
15597 (mapconcat 'car allowed " "))
15598 (setq rpl (read-char-exclusive))
15599 (if (equal rpl ?\r)
15601 (setq rpl (- rpl ?0))
15602 (if (equal rpl 0) (setq rpl 10))
15603 (if (and (> rpl 0) (<= rpl (length allowed)))
15604 (car (nth (1- rpl) allowed))
15605 (org-completing-read "Effort: " allowed nil))))
15607 (let (org-completion-use-ido org-completion-use-iswitchb)
15608 (org-completing-read
15609 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15610 (concat "[" cur "]") "")
15611 ": ")
15612 existing nil nil "" nil cur))))))
15613 (unless (equal (org-entry-get nil prop) val)
15614 (org-entry-put nil prop val))
15615 (org-refresh-property
15616 '((effort . identity)
15617 (effort-minutes . org-duration-string-to-minutes))
15618 val)
15619 (when (string= heading org-clock-current-task)
15620 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15621 (org-clock-update-mode-line))
15622 (message "%s is now %s" prop val)))
15624 (defun org-entry-properties (&optional pom which)
15625 "Get all properties of the current entry.
15627 When POM is a buffer position, get all properties from the entry
15628 there instead.
15630 This includes the TODO keyword, the tags, time strings for
15631 deadline, scheduled, and clocking, and any additional properties
15632 defined in the entry.
15634 If WHICH is nil or `all', get all properties. If WHICH is
15635 `special' or `standard', only get that subclass. If WHICH is
15636 a string, only get that property.
15638 Return value is an alist. Keys are properties, as upcased
15639 strings."
15640 (org-with-point-at pom
15641 (when (and (derived-mode-p 'org-mode)
15642 (ignore-errors (org-back-to-heading t)))
15643 (catch 'exit
15644 (let* ((beg (point))
15645 (specific (and (stringp which) (upcase which)))
15646 (which (cond ((not specific) which)
15647 ((member specific org-special-properties) 'special)
15648 (t 'standard)))
15649 props)
15650 ;; Get the special properties, like TODO and TAGS.
15651 (when (memq which '(nil all special))
15652 (when (or (not specific) (string= specific "CLOCKSUM"))
15653 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15654 (when clocksum
15655 (push (cons "CLOCKSUM"
15656 (org-columns-number-to-string
15657 (/ (float clocksum) 60.) 'add_times))
15658 props)))
15659 (when specific (throw 'exit props)))
15660 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15661 (let ((clocksumt (get-text-property (point)
15662 :org-clock-minutes-today)))
15663 (when clocksumt
15664 (push (cons "CLOCKSUM_T"
15665 (org-columns-number-to-string
15666 (/ (float clocksumt) 60.) 'add_times))
15667 props)))
15668 (when specific (throw 'exit props)))
15669 (when (or (not specific) (string= specific "ITEM"))
15670 (when (looking-at org-complex-heading-regexp)
15671 (push (cons "ITEM"
15672 (concat
15673 (org-match-string-no-properties 1)
15674 (let ((title (org-match-string-no-properties 4)))
15675 (when (org-string-nw-p title)
15676 (concat " " (org-remove-tabs title))))))
15677 props))
15678 (when specific (throw 'exit props)))
15679 (when (or (not specific) (string= specific "TODO"))
15680 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15681 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15682 (when specific (throw 'exit props)))
15683 (when (or (not specific) (string= specific "PRIORITY"))
15684 (when (looking-at org-priority-regexp)
15685 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15686 (when specific (throw 'exit props)))
15687 (when (or (not specific) (string= specific "FILE"))
15688 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15689 props)
15690 (when specific (throw 'exit props)))
15691 (when (or (not specific) (string= specific "TAGS"))
15692 (let ((value (org-string-nw-p (org-get-tags-string))))
15693 (when value (push (cons "TAGS" value) props)))
15694 (when specific (throw 'exit props)))
15695 (when (or (not specific) (string= specific "ALLTAGS"))
15696 (let ((value (org-get-tags-at)))
15697 (when value
15698 (push (cons "ALLTAGS"
15699 (format ":%s:" (mapconcat #'identity value ":")))
15700 props)))
15701 (when specific (throw 'exit props)))
15702 (when (or (not specific) (string= specific "BLOCKED"))
15703 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15704 (when specific (throw 'exit props)))
15705 (when (or (not specific)
15706 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15707 (forward-line)
15708 (when (org-looking-at-p org-planning-line-re)
15709 (end-of-line)
15710 (let ((bol (line-beginning-position))
15711 ;; Backward compatibility: time keywords used to
15712 ;; be configurable (before 8.3). Make sure we
15713 ;; get the correct keyword.
15714 (key-assoc `(("CLOSED" . ,org-closed-string)
15715 ("DEADLINE" . ,org-deadline-string)
15716 ("SCHEDULED" . ,org-scheduled-string))))
15717 (dolist (pair (if specific (list (assoc specific key-assoc))
15718 key-assoc))
15719 (save-excursion
15720 (when (search-backward (cdr pair) bol t)
15721 (goto-char (match-end 0))
15722 (skip-chars-forward " \t")
15723 (and (looking-at org-ts-regexp-both)
15724 (push (cons (car pair)
15725 (org-match-string-no-properties 0))
15726 props)))))))
15727 (when specific (throw 'exit props)))
15728 (when (or (not specific)
15729 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15730 (let ((find-ts
15731 (lambda (end ts)
15732 (let ((regexp (if (or (string= specific "TIMESTAMP")
15733 (assoc "TIMESTAMP_IA" ts))
15734 org-ts-regexp
15735 org-ts-regexp-both)))
15736 (catch 'next
15737 (while (re-search-forward regexp end t)
15738 (backward-char)
15739 (let ((object (org-element-context)))
15740 ;; Accept to match timestamps in node
15741 ;; properties, too.
15742 (when (memq (org-element-type object)
15743 '(node-property timestamp))
15744 (let ((type
15745 (org-element-property :type object)))
15746 (cond
15747 ((and (memq type '(active active-range))
15748 (not (equal specific "TIMESTAMP_IA")))
15749 (unless (assoc "TIMESTAMP" ts)
15750 (push (cons "TIMESTAMP"
15751 (org-element-property
15752 :raw-value object))
15754 (when specific (throw 'exit ts))))
15755 ((and (memq type '(inactive inactive-range))
15756 (not (string= specific "TIMESTAMP")))
15757 (unless (assoc "TIMESTAMP_IA" ts)
15758 (push (cons "TIMESTAMP_IA"
15759 (org-element-property
15760 :raw-value object))
15762 (when specific (throw 'exit ts))))))
15763 ;; Both timestamp types are found,
15764 ;; move to next part.
15765 (when (= (length ts) 2) (throw 'next ts)))))
15766 ts)))))
15767 (goto-char beg)
15768 ;; First look for timestamps within headline.
15769 (let ((ts (funcall find-ts (line-end-position) nil)))
15770 (if (= (length ts) 2) (setq props (nconc ts props))
15771 (forward-line)
15772 ;; Then find timestamps in the section, skipping
15773 ;; planning line.
15774 (when (org-looking-at-p org-planning-line-re)
15775 (forward-line))
15776 (let ((end (save-excursion (outline-next-heading))))
15777 (setq props (nconc (funcall find-ts end ts) props))))))))
15778 ;; Get the standard properties, like :PROP:.
15779 (when (memq which '(nil all standard))
15780 ;; If we are looking after a specific property, delegate
15781 ;; to `org-entry-get', which is faster. However, make an
15782 ;; exception for "CATEGORY", since it can be also set
15783 ;; through keywords (i.e. #+CATEGORY).
15784 (if (and specific (not (equal specific "CATEGORY")))
15785 (let ((value (org-entry-get beg specific nil t)))
15786 (throw 'exit (and value (list (cons specific value)))))
15787 (let ((range (org-get-property-block beg)))
15788 (when range
15789 (let ((end (cdr range)) seen-base)
15790 (goto-char (car range))
15791 ;; Unlike to `org--update-property-plist', we
15792 ;; handle the case where base values is found
15793 ;; after its extension. We also forbid standard
15794 ;; properties to be named as special properties.
15795 (while (re-search-forward org-property-re end t)
15796 (let* ((key (upcase (org-match-string-no-properties 2)))
15797 (extendp (org-string-match-p "\\+\\'" key))
15798 (key-base (if extendp (substring key 0 -1) key))
15799 (value (org-match-string-no-properties 3)))
15800 (cond
15801 ((member-ignore-case key-base org-special-properties))
15802 (extendp
15803 (setq props
15804 (org--update-property-plist key value props)))
15805 ((member key seen-base))
15806 (t (push key seen-base)
15807 (let ((p (assoc-string key props t)))
15808 (if p (setcdr p (concat value " " (cdr p)))
15809 (push (cons key value) props))))))))))))
15810 (unless (assoc "CATEGORY" props)
15811 (push (cons "CATEGORY" (org-get-category beg)) props)
15812 (when (string= specific "CATEGORY") (throw 'exit props)))
15813 ;; Return value.
15814 (append (get-text-property beg 'org-summaries) props))))))
15816 (defun org-entry-get (pom property &optional inherit literal-nil)
15817 "Get value of PROPERTY for entry or content at point-or-marker POM.
15819 If INHERIT is non-nil and the entry does not have the property,
15820 then also check higher levels of the hierarchy. If INHERIT is
15821 the symbol `selective', use inheritance only if the setting in
15822 `org-use-property-inheritance' selects PROPERTY for inheritance.
15824 If the property is present but empty, the return value is the
15825 empty string. If the property is not present at all, nil is
15826 returned. In any other case, return the value as a string.
15827 Search is case-insensitive.
15829 If LITERAL-NIL is set, return the string value \"nil\" as
15830 a string, do not interpret it as the list atom nil. This is used
15831 for inheritance when a \"nil\" value can supersede a non-nil
15832 value higher up the hierarchy."
15833 (org-with-point-at pom
15834 (cond
15835 ((and inherit
15836 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15837 (org-entry-get-with-inheritance property literal-nil))
15838 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15839 ;; We need a special property. Use `org-entry-properties' to
15840 ;; retrieve it, but specify the wanted property.
15841 (cdr (assoc-string property (org-entry-properties nil property))))
15843 (let ((range (org-get-property-block)))
15844 (when range
15845 (let* ((case-fold-search t)
15846 (end (cdr range))
15847 (props
15848 (let ((global
15849 (or (assoc-string property org-file-properties t)
15850 (assoc-string property org-global-properties t)
15851 (assoc-string
15852 property org-global-properties-fixed t))))
15853 ;; Make sure to not re-use GLOBAL as
15854 ;; `org--update-property-plist' would alter it by
15855 ;; side-effect.
15856 (and global (list (cons property (cdr global))))))
15857 (find-value
15858 (lambda (key)
15859 (when (re-search-forward (org-re-property key nil t) end t)
15860 (setq props
15861 (org--update-property-plist
15862 key (org-match-string-no-properties 3) props))))))
15863 (goto-char (car range))
15864 ;; Find base value.
15865 (save-excursion (funcall find-value property))
15866 ;; Find additional values.
15867 (let ((property+ (concat property "+")))
15868 (while (funcall find-value property+)))
15869 ;; Return final value.
15870 (let ((val (cdr (assoc-string property props t))))
15871 (if literal-nil val (org-not-nil val))))))))))
15873 (defun org-property-or-variable-value (var &optional inherit)
15874 "Check if there is a property fixing the value of VAR.
15875 If yes, return this value. If not, return the current value of the variable."
15876 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15877 (if (and prop (stringp prop) (string-match "\\S-" prop))
15878 (read prop)
15879 (symbol-value var))))
15881 (defun org-entry-delete (pom property)
15882 "Delete PROPERTY from entry at point-or-marker POM.
15883 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15884 non-nil when a property was removed."
15885 (unless (member property org-special-properties)
15886 (org-with-point-at pom
15887 (let ((range (org-get-property-block)))
15888 (when range
15889 (let* ((begin (car range))
15890 (origin (cdr range))
15891 (end (copy-marker origin))
15892 (re (org-re-property
15893 (concat (regexp-quote property) "\\+?") t t)))
15894 (goto-char begin)
15895 (while (re-search-forward re end t)
15896 (delete-region (match-beginning 0) (line-beginning-position 2)))
15897 ;; If drawer is empty, remove it altogether.
15898 (when (= begin end)
15899 (delete-region (line-beginning-position 0)
15900 (line-beginning-position 2)))
15901 ;; Return non-nil if some property was removed.
15902 (prog1 (/= end origin) (set-marker end nil))))))))
15904 ;; Multi-values properties are properties that contain multiple values
15905 ;; These values are assumed to be single words, separated by whitespace.
15906 (defun org-entry-add-to-multivalued-property (pom property value)
15907 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15908 (let* ((old (org-entry-get pom property))
15909 (values (and old (org-split-string old "[ \t]"))))
15910 (setq value (org-entry-protect-space value))
15911 (unless (member value values)
15912 (setq values (append values (list value)))
15913 (org-entry-put pom property
15914 (mapconcat 'identity values " ")))))
15916 (defun org-entry-remove-from-multivalued-property (pom property value)
15917 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15918 (let* ((old (org-entry-get pom property))
15919 (values (and old (org-split-string old "[ \t]"))))
15920 (setq value (org-entry-protect-space value))
15921 (when (member value values)
15922 (setq values (delete value values))
15923 (org-entry-put pom property
15924 (mapconcat 'identity values " ")))))
15926 (defun org-entry-member-in-multivalued-property (pom property value)
15927 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15928 (let* ((old (org-entry-get pom property))
15929 (values (and old (org-split-string old "[ \t]"))))
15930 (setq value (org-entry-protect-space value))
15931 (member value values)))
15933 (defun org-entry-get-multivalued-property (pom property)
15934 "Return a list of values in a multivalued property."
15935 (let* ((value (org-entry-get pom property))
15936 (values (and value (org-split-string value "[ \t]"))))
15937 (mapcar 'org-entry-restore-space values)))
15939 (defun org-entry-put-multivalued-property (pom property &rest values)
15940 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15941 VALUES should be a list of strings. Spaces will be protected."
15942 (org-entry-put pom property
15943 (mapconcat 'org-entry-protect-space values " "))
15944 (let* ((value (org-entry-get pom property))
15945 (values (and value (org-split-string value "[ \t]"))))
15946 (mapcar 'org-entry-restore-space values)))
15948 (defun org-entry-protect-space (s)
15949 "Protect spaces and newline in string S."
15950 (while (string-match " " s)
15951 (setq s (replace-match "%20" t t s)))
15952 (while (string-match "\n" s)
15953 (setq s (replace-match "%0A" t t s)))
15956 (defun org-entry-restore-space (s)
15957 "Restore spaces and newline in string S."
15958 (while (string-match "%20" s)
15959 (setq s (replace-match " " t t s)))
15960 (while (string-match "%0A" s)
15961 (setq s (replace-match "\n" t t s)))
15964 (defvar org-entry-property-inherited-from (make-marker)
15965 "Marker pointing to the entry from where a property was inherited.
15966 Each call to `org-entry-get-with-inheritance' will set this marker to the
15967 location of the entry where the inheritance search matched. If there was
15968 no match, the marker will point nowhere.
15969 Note that also `org-entry-get' calls this function, if the INHERIT flag
15970 is set.")
15972 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15973 "Get PROPERTY of entry or content at point, search higher levels if needed.
15974 The search will stop at the first ancestor which has the property defined.
15975 If the value found is \"nil\", return nil to show that the property
15976 should be considered as undefined (this is the meaning of nil here).
15977 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15978 (move-marker org-entry-property-inherited-from nil)
15979 (let (value)
15980 (org-with-wide-buffer
15981 (catch 'exit
15982 (while t
15983 (when (setq value (org-entry-get nil property nil literal-nil))
15984 (org-back-to-heading t)
15985 (move-marker org-entry-property-inherited-from (point))
15986 (throw 'exit nil))
15987 (or (org-up-heading-safe) (throw 'exit nil)))))
15988 (unless value
15989 (setq value
15990 (cdr (or (assoc-string property org-file-properties t)
15991 (assoc-string property org-global-properties t)
15992 (assoc-string property org-global-properties-fixed t)))))
15993 (if literal-nil value (org-not-nil value))))
15995 (defvar org-property-changed-functions nil
15996 "Hook called when the value of a property has changed.
15997 Each hook function should accept two arguments, the name of the property
15998 and the new value.")
16000 (defun org-entry-put (pom property value)
16001 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16003 If the value is `nil', it is converted to the empty string. If
16004 it is not a string, an error is raised.
16006 PROPERTY can be any regular property (see
16007 `org-special-properties'). It can also be \"TODO\",
16008 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16010 For the last two properties, VALUE may have any of the special
16011 values \"earlier\" and \"later\". The function then increases or
16012 decreases scheduled or deadline date by one day."
16013 (cond ((null value) (setq value ""))
16014 ((not (stringp value)) (error "Properties values should be strings")))
16015 (org-with-point-at pom
16016 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16017 (org-back-to-heading t)
16018 (org-with-limited-levels (org-back-to-heading t)))
16019 (let ((beg (point)))
16020 (cond
16021 ((equal property "TODO")
16022 (cond ((not (org-string-nw-p value)) (setq value 'none))
16023 ((not (member value org-todo-keywords-1))
16024 (user-error "\"%s\" is not a valid TODO state" value)))
16025 (org-todo value)
16026 (org-set-tags nil 'align))
16027 ((equal property "PRIORITY")
16028 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16029 (org-set-tags nil 'align))
16030 ((equal property "SCHEDULED")
16031 (forward-line)
16032 (if (and (org-looking-at-p org-planning-line-re)
16033 (re-search-forward
16034 org-scheduled-time-regexp (line-end-position) t))
16035 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16036 ((string= value "later") (org-timestamp-change 1 'day))
16037 ((string= value "") (org-schedule '(4)))
16038 (t (org-schedule nil value)))
16039 (if (member value '("earlier" "later" ""))
16040 (call-interactively #'org-schedule)
16041 (org-schedule nil value))))
16042 ((equal property "DEADLINE")
16043 (forward-line)
16044 (if (and (org-looking-at-p org-planning-line-re)
16045 (re-search-forward
16046 org-deadline-time-regexp (line-end-position) t))
16047 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16048 ((string= value "later") (org-timestamp-change 1 'day))
16049 ((string= value "") (org-deadline '(4)))
16050 (t (org-deadline nil value)))
16051 (if (member value '("earlier" "later" ""))
16052 (call-interactively #'org-deadline)
16053 (org-deadline nil value))))
16054 ((member property org-special-properties)
16055 (error "The %s property cannot be set with `org-entry-put'" property))
16057 (let* ((range (org-get-property-block beg 'force))
16058 (end (cdr range))
16059 (case-fold-search t))
16060 (goto-char (car range))
16061 (if (re-search-forward (org-re-property property nil t) end t)
16062 (progn (delete-region (match-beginning 0) (match-end 0))
16063 (goto-char (match-beginning 0)))
16064 (goto-char end)
16065 (insert "\n")
16066 (backward-char))
16067 (insert ":" property ":")
16068 (when value (insert " " value))
16069 (org-indent-line)))))
16070 (run-hook-with-args 'org-property-changed-functions property value)))
16072 (defun org-buffer-property-keys (&optional specials defaults columns)
16073 "Get all property keys in the current buffer.
16075 When SPECIALS is non-nil, also list the special properties that
16076 reflect things like tags and TODO state.
16078 When DEFAULTS is non-nil, also include properties that has
16079 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16080 DESCRIPTION, LOCATION, and LOGGING and others.
16082 When COLUMNS in non-nil, also include property names given in
16083 COLUMN formats in the current buffer."
16084 (let ((case-fold-search t)
16085 (props (append
16086 (and specials org-special-properties)
16087 (and defaults (cons org-effort-property org-default-properties))
16088 nil)))
16089 (org-with-wide-buffer
16090 (goto-char (point-min))
16091 (while (re-search-forward org-property-start-re nil t)
16092 (let ((range (org-get-property-block)))
16093 (catch 'skip
16094 (unless range
16095 (when (and (not (org-before-first-heading-p))
16096 (y-or-n-p (format "Malformed drawer at %d, repair?"
16097 (line-beginning-position))))
16098 (org-get-property-block nil t))
16099 (throw 'skip nil))
16100 (goto-char (car range))
16101 (let ((begin (car range))
16102 (end (cdr range)))
16103 ;; Make sure that found property block is not located
16104 ;; before current point, as it would generate an infloop.
16105 ;; It can happen, for example, in the following
16106 ;; situation:
16108 ;; * Headline
16109 ;; :PROPERTIES:
16110 ;; ...
16111 ;; :END:
16112 ;; *************** Inlinetask
16113 ;; #+BEGIN_EXAMPLE
16114 ;; :PROPERTIES:
16115 ;; #+END_EXAMPLE
16117 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16118 (while (< (point) end)
16119 (let ((p (progn (looking-at org-property-re)
16120 (org-match-string-no-properties 2))))
16121 ;; Only add true property name, not extension symbol.
16122 (add-to-list 'props
16123 (if (not (org-string-match-p "\\+\\'" p)) p
16124 (substring p 0 -1))))
16125 (forward-line))))
16126 (outline-next-heading)))
16127 (when columns
16128 (goto-char (point-min))
16129 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16130 (let ((element (org-element-at-point)))
16131 (when (memq (org-element-type element) '(keyword node-property))
16132 (let ((value (org-element-property :value element))
16133 (start 0))
16134 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16135 (setq start (match-end 0))
16136 (let ((p (org-match-string-no-properties 1 value)))
16137 (unless (member-ignore-case p org-special-properties)
16138 (add-to-list 'props p))))))))))
16139 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16141 (defun org-property-values (key)
16142 "List all non-nil values of property KEY in current buffer."
16143 (org-with-wide-buffer
16144 (goto-char (point-min))
16145 (let ((case-fold-search t)
16146 (re (org-re-property key))
16147 values)
16148 (while (re-search-forward re nil t)
16149 (add-to-list 'values (org-entry-get (point) key)))
16150 values)))
16152 (defun org-insert-property-drawer ()
16153 "Insert a property drawer into the current entry."
16154 (org-with-wide-buffer
16155 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16156 (org-back-to-heading t)
16157 (org-with-limited-levels (org-back-to-heading t)))
16158 (forward-line)
16159 (when (org-looking-at-p org-planning-line-re) (forward-line))
16160 (unless (org-looking-at-p org-property-drawer-re)
16161 (let ((inhibit-read-only t))
16162 (unless (bolp) (insert "\n"))
16163 (let ((begin (point)))
16164 (insert ":PROPERTIES:\n:END:\n")
16165 (org-indent-region begin (point)))))))
16167 (defun org-insert-drawer (&optional arg drawer)
16168 "Insert a drawer at point.
16170 When optional argument ARG is non-nil, insert a property drawer.
16172 Optional argument DRAWER, when non-nil, is a string representing
16173 drawer's name. Otherwise, the user is prompted for a name.
16175 If a region is active, insert the drawer around that region
16176 instead.
16178 Point is left between drawer's boundaries."
16179 (interactive "P")
16180 (let* ((drawer (if arg "PROPERTIES"
16181 (or drawer (read-from-minibuffer "Drawer: ")))))
16182 (cond
16183 ;; With C-u, fall back on `org-insert-property-drawer'
16184 (arg (org-insert-property-drawer))
16185 ;; Check validity of suggested drawer's name.
16186 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16187 (user-error "Invalid drawer name"))
16188 ;; With an active region, insert a drawer at point.
16189 ((not (org-region-active-p))
16190 (progn
16191 (unless (bolp) (insert "\n"))
16192 (insert (format ":%s:\n\n:END:\n" drawer))
16193 (forward-line -2)))
16194 ;; Otherwise, insert the drawer at point
16196 (let ((rbeg (region-beginning))
16197 (rend (copy-marker (region-end))))
16198 (unwind-protect
16199 (progn
16200 (goto-char rbeg)
16201 (beginning-of-line)
16202 (when (save-excursion
16203 (re-search-forward org-outline-regexp-bol rend t))
16204 (user-error "Drawers cannot contain headlines"))
16205 ;; Position point at the beginning of the first
16206 ;; non-blank line in region. Insert drawer's opening
16207 ;; there, then indent it.
16208 (org-skip-whitespace)
16209 (beginning-of-line)
16210 (insert ":" drawer ":\n")
16211 (forward-line -1)
16212 (indent-for-tab-command)
16213 ;; Move point to the beginning of the first blank line
16214 ;; after the last non-blank line in region. Insert
16215 ;; drawer's closing, then indent it.
16216 (goto-char rend)
16217 (skip-chars-backward " \r\t\n")
16218 (insert "\n:END:")
16219 (deactivate-mark t)
16220 (indent-for-tab-command)
16221 (unless (eolp) (insert "\n")))
16222 ;; Clear marker, whatever the outcome of insertion is.
16223 (set-marker rend nil)))))))
16225 (defvar org-property-set-functions-alist nil
16226 "Property set function alist.
16227 Each entry should have the following format:
16229 (PROPERTY . READ-FUNCTION)
16231 The read function will be called with the same argument as
16232 `org-completing-read'.")
16234 (defun org-set-property-function (property)
16235 "Get the function that should be used to set PROPERTY.
16236 This is computed according to `org-property-set-functions-alist'."
16237 (or (cdr (assoc property org-property-set-functions-alist))
16238 'org-completing-read))
16240 (defun org-read-property-value (property)
16241 "Read PROPERTY value from user."
16242 (let* ((completion-ignore-case t)
16243 (allowed (org-property-get-allowed-values nil property 'table))
16244 (cur (org-entry-get nil property))
16245 (prompt (concat property " value"
16246 (if (and cur (string-match "\\S-" cur))
16247 (concat " [" cur "]") "") ": "))
16248 (set-function (org-set-property-function property))
16249 (val (if allowed
16250 (funcall set-function prompt allowed nil
16251 (not (get-text-property 0 'org-unrestricted
16252 (caar allowed))))
16253 (let (org-completion-use-ido org-completion-use-iswitchb)
16254 (funcall set-function prompt
16255 (mapcar 'list (org-property-values property))
16256 nil nil "" nil cur)))))
16257 (org-trim val)))
16259 (defvar org-last-set-property nil)
16260 (defvar org-last-set-property-value nil)
16261 (defun org-read-property-name ()
16262 "Read a property name."
16263 (let* ((completion-ignore-case t)
16264 (keys (org-buffer-property-keys nil t t))
16265 (default-prop (or (save-excursion
16266 (save-match-data
16267 (beginning-of-line)
16268 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
16269 (null (string= (match-string 1) "END"))
16270 (match-string 1))))
16271 org-last-set-property))
16272 (property (org-icompleting-read
16273 (concat "Property"
16274 (if default-prop (concat " [" default-prop "]") "")
16275 ": ")
16276 (mapcar 'list keys)
16277 nil nil nil nil
16278 default-prop)))
16279 (if (member property keys)
16280 property
16281 (or (cdr (assoc (downcase property)
16282 (mapcar (lambda (x) (cons (downcase x) x))
16283 keys)))
16284 property))))
16286 (defun org-set-property-and-value (use-last)
16287 "Allow to set [PROPERTY]: [value] direction from prompt.
16288 When use-default, don't even ask, just use the last
16289 \"[PROPERTY]: [value]\" string from the history."
16290 (interactive "P")
16291 (let* ((completion-ignore-case t)
16292 (pv (or (and use-last org-last-set-property-value)
16293 (org-completing-read
16294 "Enter a \"[Property]: [value]\" pair: "
16295 nil nil nil nil nil
16296 org-last-set-property-value)))
16297 prop val)
16298 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16299 (setq prop (match-string 1 pv)
16300 val (match-string 2 pv))
16301 (org-set-property prop val))))
16303 (defun org-set-property (property value)
16304 "In the current entry, set PROPERTY to VALUE.
16305 When called interactively, this will prompt for a property name, offering
16306 completion on existing and default properties. And then it will prompt
16307 for a value, offering completion either on allowed values (via an inherited
16308 xxx_ALL property) or on existing values in other instances of this property
16309 in the current file."
16310 (interactive (list nil nil))
16311 (let* ((property (or property (org-read-property-name)))
16312 (value (or value (org-read-property-value property)))
16313 (fn (cdr (assoc property org-properties-postprocess-alist))))
16314 (setq org-last-set-property property)
16315 (setq org-last-set-property-value (concat property ": " value))
16316 ;; Possibly postprocess the inserted value:
16317 (when fn (setq value (funcall fn value)))
16318 (unless (equal (org-entry-get nil property) value)
16319 (org-entry-put nil property value))))
16321 (defun org-find-property (property &optional value)
16322 "Find first entry in buffer that sets PROPERTY.
16324 When optional argument VALUE is non-nil, only consider an entry
16325 if it contains PROPERTY set to this value. If PROPERTY should be
16326 explicitly set to nil, use string \"nil\" for VALUE.
16328 Return position where the entry begins, or nil if there is no
16329 such entry. If narrowing is in effect, only search the visible
16330 part of the buffer."
16331 (save-excursion
16332 (goto-char (point-min))
16333 (let ((case-fold-search t)
16334 (re (org-re-property property nil (not value) value)))
16335 (catch 'exit
16336 (while (re-search-forward re nil t)
16337 (when (if value (equal value (org-entry-get (point) property nil t))
16338 (org-entry-get (point) property nil t))
16339 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16341 (defun org-delete-property (property)
16342 "In the current entry, delete PROPERTY."
16343 (interactive
16344 (let* ((completion-ignore-case t)
16345 (cat (org-entry-get (point) "CATEGORY"))
16346 (props0 (org-entry-properties nil 'standard))
16347 (props (if cat props0
16348 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16349 (prop (if (< 1 (length props))
16350 (org-icompleting-read "Property: " props nil t)
16351 (caar props))))
16352 (list prop)))
16353 (if (not property)
16354 (message "No property to delete in this entry")
16355 (org-entry-delete nil property)
16356 (message "Property \"%s\" deleted" property)))
16358 (defun org-delete-property-globally (property)
16359 "Remove PROPERTY globally, from all entries.
16360 This function ignores narrowing, if any."
16361 (interactive
16362 (let* ((completion-ignore-case t)
16363 (prop (org-icompleting-read
16364 "Globally remove property: "
16365 (mapcar #'list (org-buffer-property-keys)))))
16366 (list prop)))
16367 (org-with-wide-buffer
16368 (goto-char (point-min))
16369 (let ((count 0)
16370 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16371 (while (re-search-forward re nil t)
16372 (when (org-entry-delete (point) property) (incf count)))
16373 (message "Property \"%s\" removed from %d entries" property count))))
16375 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16377 (defun org-compute-property-at-point ()
16378 "Compute the property at point.
16379 This looks for an enclosing column format, extracts the operator and
16380 then applies it to the property in the column format's scope."
16381 (interactive)
16382 (unless (org-at-property-p)
16383 (user-error "Not at a property"))
16384 (let ((prop (org-match-string-no-properties 2)))
16385 (org-columns-get-format-and-top-level)
16386 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16387 (user-error "No operator defined for property %s" prop))
16388 (org-columns-compute prop)))
16390 (defvar org-property-allowed-value-functions nil
16391 "Hook for functions supplying allowed values for a specific property.
16392 The functions must take a single argument, the name of the property, and
16393 return a flat list of allowed values. If \":ETC\" is one of
16394 the values, this means that these values are intended as defaults for
16395 completion, but that other values should be allowed too.
16396 The functions must return nil if they are not responsible for this
16397 property.")
16399 (defun org-property-get-allowed-values (pom property &optional table)
16400 "Get allowed values for the property PROPERTY.
16401 When TABLE is non-nil, return an alist that can directly be used for
16402 completion."
16403 (let (vals)
16404 (cond
16405 ((equal property "TODO")
16406 (setq vals (org-with-point-at pom
16407 (append org-todo-keywords-1 '("")))))
16408 ((equal property "PRIORITY")
16409 (let ((n org-lowest-priority))
16410 (while (>= n org-highest-priority)
16411 (push (char-to-string n) vals)
16412 (setq n (1- n)))))
16413 ((equal property "CATEGORY"))
16414 ((member property org-special-properties))
16415 ((setq vals (run-hook-with-args-until-success
16416 'org-property-allowed-value-functions property)))
16418 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16419 (when (and vals (string-match "\\S-" vals))
16420 (setq vals (car (read-from-string (concat "(" vals ")"))))
16421 (setq vals (mapcar (lambda (x)
16422 (cond ((stringp x) x)
16423 ((numberp x) (number-to-string x))
16424 ((symbolp x) (symbol-name x))
16425 (t "???")))
16426 vals)))))
16427 (when (member ":ETC" vals)
16428 (setq vals (remove ":ETC" vals))
16429 (org-add-props (car vals) '(org-unrestricted t)))
16430 (if table (mapcar 'list vals) vals)))
16432 (defun org-property-previous-allowed-value (&optional previous)
16433 "Switch to the next allowed value for this property."
16434 (interactive)
16435 (org-property-next-allowed-value t))
16437 (defun org-property-next-allowed-value (&optional previous)
16438 "Switch to the next allowed value for this property."
16439 (interactive)
16440 (unless (org-at-property-p)
16441 (user-error "Not at a property"))
16442 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16443 (key (match-string 2))
16444 (value (match-string 3))
16445 (allowed (or (org-property-get-allowed-values (point) key)
16446 (and (member value '("[ ]" "[-]" "[X]"))
16447 '("[ ]" "[X]"))))
16448 (heading (save-match-data (nth 4 (org-heading-components))))
16449 nval)
16450 (unless allowed
16451 (user-error "Allowed values for this property have not been defined"))
16452 (if previous (setq allowed (reverse allowed)))
16453 (if (member value allowed)
16454 (setq nval (car (cdr (member value allowed)))))
16455 (setq nval (or nval (car allowed)))
16456 (if (equal nval value)
16457 (user-error "Only one allowed value for this property"))
16458 (org-at-property-p)
16459 (replace-match (concat " :" key ": " nval) t t)
16460 (org-indent-line)
16461 (beginning-of-line 1)
16462 (skip-chars-forward " \t")
16463 (when (equal prop org-effort-property)
16464 (org-refresh-property
16465 '((effort . identity)
16466 (effort-minutes . org-duration-string-to-minutes))
16467 nval)
16468 (when (string= org-clock-current-task heading)
16469 (setq org-clock-effort nval)
16470 (org-clock-update-mode-line)))
16471 (run-hook-with-args 'org-property-changed-functions key nval)))
16473 (defun org-find-olp (path &optional this-buffer)
16474 "Return a marker pointing to the entry at outline path OLP.
16475 If anything goes wrong, throw an error.
16476 You can wrap this call to catch the error like this:
16478 (condition-case msg
16479 (org-mobile-locate-entry (match-string 4))
16480 (error (nth 1 msg)))
16482 The return value will then be either a string with the error message,
16483 or a marker if everything is OK.
16485 If THIS-BUFFER is set, the outline path does not contain a file,
16486 only headings."
16487 (let* ((file (if this-buffer buffer-file-name (pop path)))
16488 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16489 (level 1)
16490 (lmin 1)
16491 (lmax 1)
16492 limit re end found pos heading cnt flevel)
16493 (unless buffer (error "File not found :%s" file))
16494 (with-current-buffer buffer
16495 (save-excursion
16496 (save-restriction
16497 (widen)
16498 (setq limit (point-max))
16499 (goto-char (point-min))
16500 (while (setq heading (pop path))
16501 (setq re (format org-complex-heading-regexp-format
16502 (regexp-quote heading)))
16503 (setq cnt 0 pos (point))
16504 (while (re-search-forward re end t)
16505 (setq level (- (match-end 1) (match-beginning 1)))
16506 (if (and (>= level lmin) (<= level lmax))
16507 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16508 (when (= cnt 0) (error "Heading not found on level %d: %s"
16509 lmax heading))
16510 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16511 lmax heading))
16512 (goto-char found)
16513 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16514 (setq end (save-excursion (org-end-of-subtree t t))))
16515 (when (org-at-heading-p)
16516 (point-marker)))))))
16518 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16519 "Find node HEADING in BUFFER.
16520 Return a marker to the heading if it was found, or nil if not.
16521 If POS-ONLY is set, return just the position instead of a marker.
16523 The heading text must match exact, but it may have a TODO keyword,
16524 a priority cookie and tags in the standard locations."
16525 (with-current-buffer (or buffer (current-buffer))
16526 (save-excursion
16527 (save-restriction
16528 (widen)
16529 (goto-char (point-min))
16530 (let (case-fold-search)
16531 (if (re-search-forward
16532 (format org-complex-heading-regexp-format
16533 (regexp-quote heading)) nil t)
16534 (if pos-only
16535 (match-beginning 0)
16536 (move-marker (make-marker) (match-beginning 0)))))))))
16538 (defun org-find-exact-heading-in-directory (heading &optional dir)
16539 "Find Org node headline HEADING in all .org files in directory DIR.
16540 When the target headline is found, return a marker to this location."
16541 (let ((files (directory-files (or dir default-directory)
16542 t "\\`[^.#].*\\.org\\'"))
16543 file visiting m buffer)
16544 (catch 'found
16545 (while (setq file (pop files))
16546 (message "trying %s" file)
16547 (setq visiting (org-find-base-buffer-visiting file))
16548 (setq buffer (or visiting (find-file-noselect file)))
16549 (setq m (org-find-exact-headline-in-buffer
16550 heading buffer))
16551 (when (and (not m) (not visiting)) (kill-buffer buffer))
16552 (and m (throw 'found m))))))
16554 (defun org-find-entry-with-id (ident)
16555 "Locate the entry that contains the ID property with exact value IDENT.
16556 IDENT can be a string, a symbol or a number, this function will search for
16557 the string representation of it.
16558 Return the position where this entry starts, or nil if there is no such entry."
16559 (interactive "sID: ")
16560 (let ((id (cond
16561 ((stringp ident) ident)
16562 ((symbolp ident) (symbol-name ident))
16563 ((numberp ident) (number-to-string ident))
16564 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16565 (org-with-wide-buffer (org-find-property "ID" id))))
16567 ;;;; Timestamps
16569 (defvar org-last-changed-timestamp nil)
16570 (defvar org-last-inserted-timestamp nil
16571 "The last time stamp inserted with `org-insert-time-stamp'.")
16572 (defvar org-ts-what) ; dynamically scoped parameter
16574 (defun org-time-stamp (arg &optional inactive)
16575 "Prompt for a date/time and insert a time stamp.
16577 If the user specifies a time like HH:MM or if this command is
16578 called with at least one prefix argument, the time stamp contains
16579 the date and the time. Otherwise, only the date is included.
16581 All parts of a date not specified by the user are filled in from
16582 the timestamp at point, if any, or the current date/time
16583 otherwise.
16585 If there is already a timestamp at the cursor, it is replaced.
16587 With two universal prefix arguments, insert an active timestamp
16588 with the current time without prompting the user.
16590 When called from lisp, the timestamp is inactive if INACTIVE is
16591 non-nil."
16592 (interactive "P")
16593 (let* ((ts
16594 (cond ((org-at-date-range-p t)
16595 (save-excursion
16596 (goto-char (match-beginning 0))
16597 (looking-at (if inactive org-ts-regexp-both org-ts-regexp)))
16598 (match-string 0))
16599 ((org-at-timestamp-p t) (match-string 0))))
16600 ;; Default time is either the timestamp at point or today.
16601 ;; When entering a range, only the range start is considered.
16602 (default-time (if (not ts) (current-time)
16603 (apply #'encode-time (org-parse-time-string ts))))
16604 (default-input (and ts (org-get-compact-tod ts)))
16605 (repeater (and ts
16606 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16607 (match-string 0 ts)))
16608 org-time-was-given
16609 org-end-time-was-given
16610 (time
16611 (and (if (equal arg '(16)) (current-time)
16612 ;; Preserve `this-command' and `last-command'.
16613 (let ((this-command this-command)
16614 (last-command last-command))
16615 (org-read-date
16616 arg 'totime nil nil default-time default-input
16617 inactive))))))
16618 (cond
16619 ((and ts
16620 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16621 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16622 (insert "--")
16623 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16625 ;; Make sure we're on a timestamp. When in the middle of a date
16626 ;; range, move arbitrarily to range end.
16627 (unless (org-at-timestamp-p t)
16628 (skip-chars-forward "-")
16629 (org-at-timestamp-p t))
16630 (replace-match "")
16631 (setq org-last-changed-timestamp
16632 (org-insert-time-stamp
16633 time (or org-time-was-given arg)
16634 inactive nil nil (list org-end-time-was-given)))
16635 (when repeater
16636 (backward-char)
16637 (insert " " repeater)
16638 (setq org-last-changed-timestamp
16639 (concat (substring org-last-inserted-timestamp 0 -1)
16640 " " repeater ">")))
16641 (message "Timestamp updated"))
16642 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16643 (t (org-insert-time-stamp
16644 time (or org-time-was-given arg) inactive nil nil
16645 (list org-end-time-was-given))))))
16647 ;; FIXME: can we use this for something else, like computing time differences?
16648 (defun org-get-compact-tod (s)
16649 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16650 (let* ((t1 (match-string 1 s))
16651 (h1 (string-to-number (match-string 2 s)))
16652 (m1 (string-to-number (match-string 3 s)))
16653 (t2 (and (match-end 4) (match-string 5 s)))
16654 (h2 (and t2 (string-to-number (match-string 6 s))))
16655 (m2 (and t2 (string-to-number (match-string 7 s))))
16656 dh dm)
16657 (if (not t2)
16659 (setq dh (- h2 h1) dm (- m2 m1))
16660 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16661 (concat t1 "+" (number-to-string dh)
16662 (and (/= 0 dm) (format ":%02d" dm)))))))
16664 (defun org-time-stamp-inactive (&optional arg)
16665 "Insert an inactive time stamp.
16666 An inactive time stamp is enclosed in square brackets instead of angle
16667 brackets. It is inactive in the sense that it does not trigger agenda entries,
16668 does not link to the calendar and cannot be changed with the S-cursor keys.
16669 So these are more for recording a certain time/date."
16670 (interactive "P")
16671 (org-time-stamp arg 'inactive))
16673 (defvar org-date-ovl (make-overlay 1 1))
16674 (overlay-put org-date-ovl 'face 'org-date-selected)
16675 (org-detach-overlay org-date-ovl)
16677 (defvar org-ans1) ; dynamically scoped parameter
16678 (defvar org-ans2) ; dynamically scoped parameter
16680 (defvar org-plain-time-of-day-regexp) ; defined below
16682 (defvar org-overriding-default-time nil) ; dynamically scoped
16683 (defvar org-read-date-overlay nil)
16684 (defvar org-dcst nil) ; dynamically scoped
16685 (defvar org-read-date-history nil)
16686 (defvar org-read-date-final-answer nil)
16687 (defvar org-read-date-analyze-futurep nil)
16688 (defvar org-read-date-analyze-forced-year nil)
16689 (defvar org-read-date-inactive)
16691 (defvar org-read-date-minibuffer-local-map
16692 (let* ((map (make-sparse-keymap)))
16693 (set-keymap-parent map minibuffer-local-map)
16694 (org-defkey map (kbd ".")
16695 (lambda () (interactive)
16696 ;; Are we at the beginning of the prompt?
16697 (if (looking-back "^[^:]+: ")
16698 (org-eval-in-calendar '(calendar-goto-today))
16699 (insert "."))))
16700 (org-defkey map (kbd "C-.")
16701 (lambda () (interactive)
16702 (org-eval-in-calendar '(calendar-goto-today))))
16703 (org-defkey map [(meta shift left)]
16704 (lambda () (interactive)
16705 (org-eval-in-calendar '(calendar-backward-month 1))))
16706 (org-defkey map [(meta shift right)]
16707 (lambda () (interactive)
16708 (org-eval-in-calendar '(calendar-forward-month 1))))
16709 (org-defkey map [(meta shift up)]
16710 (lambda () (interactive)
16711 (org-eval-in-calendar '(calendar-backward-year 1))))
16712 (org-defkey map [(meta shift down)]
16713 (lambda () (interactive)
16714 (org-eval-in-calendar '(calendar-forward-year 1))))
16715 (org-defkey map [?\e (shift left)]
16716 (lambda () (interactive)
16717 (org-eval-in-calendar '(calendar-backward-month 1))))
16718 (org-defkey map [?\e (shift right)]
16719 (lambda () (interactive)
16720 (org-eval-in-calendar '(calendar-forward-month 1))))
16721 (org-defkey map [?\e (shift up)]
16722 (lambda () (interactive)
16723 (org-eval-in-calendar '(calendar-backward-year 1))))
16724 (org-defkey map [?\e (shift down)]
16725 (lambda () (interactive)
16726 (org-eval-in-calendar '(calendar-forward-year 1))))
16727 (org-defkey map [(shift up)]
16728 (lambda () (interactive)
16729 (org-eval-in-calendar '(calendar-backward-week 1))))
16730 (org-defkey map [(shift down)]
16731 (lambda () (interactive)
16732 (org-eval-in-calendar '(calendar-forward-week 1))))
16733 (org-defkey map [(shift left)]
16734 (lambda () (interactive)
16735 (org-eval-in-calendar '(calendar-backward-day 1))))
16736 (org-defkey map [(shift right)]
16737 (lambda () (interactive)
16738 (org-eval-in-calendar '(calendar-forward-day 1))))
16739 (org-defkey map "!"
16740 (lambda () (interactive)
16741 (org-eval-in-calendar '(diary-view-entries))
16742 (message "")))
16743 (org-defkey map ">"
16744 (lambda () (interactive)
16745 (org-eval-in-calendar '(calendar-scroll-left 1))))
16746 (org-defkey map "<"
16747 (lambda () (interactive)
16748 (org-eval-in-calendar '(calendar-scroll-right 1))))
16749 (org-defkey map "\C-v"
16750 (lambda () (interactive)
16751 (org-eval-in-calendar
16752 '(calendar-scroll-left-three-months 1))))
16753 (org-defkey map "\M-v"
16754 (lambda () (interactive)
16755 (org-eval-in-calendar
16756 '(calendar-scroll-right-three-months 1))))
16757 map)
16758 "Keymap for minibuffer commands when using `org-read-date'.")
16760 (defvar org-def)
16761 (defvar org-defdecode)
16762 (defvar org-with-time)
16764 (defun org-read-date (&optional org-with-time to-time from-string prompt
16765 default-time default-input inactive)
16766 "Read a date, possibly a time, and make things smooth for the user.
16767 The prompt will suggest to enter an ISO date, but you can also enter anything
16768 which will at least partially be understood by `parse-time-string'.
16769 Unrecognized parts of the date will default to the current day, month, year,
16770 hour and minute. If this command is called to replace a timestamp at point,
16771 or to enter the second timestamp of a range, the default time is taken
16772 from the existing stamp. Furthermore, the command prefers the future,
16773 so if you are giving a date where the year is not given, and the day-month
16774 combination is already past in the current year, it will assume you
16775 mean next year. For details, see the manual. A few examples:
16777 3-2-5 --> 2003-02-05
16778 feb 15 --> currentyear-02-15
16779 2/15 --> currentyear-02-15
16780 sep 12 9 --> 2009-09-12
16781 12:45 --> today 12:45
16782 22 sept 0:34 --> currentyear-09-22 0:34
16783 12 --> currentyear-currentmonth-12
16784 Fri --> nearest Friday after today
16785 -Tue --> last Tuesday
16786 etc.
16788 Furthermore you can specify a relative date by giving, as the *first* thing
16789 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16790 change in days weeks, months, years.
16791 With a single plus or minus, the date is relative to today. With a double
16792 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16793 +4d --> four days from today
16794 +4 --> same as above
16795 +2w --> two weeks from today
16796 ++5 --> five days from default date
16798 The function understands only English month and weekday abbreviations.
16800 While prompting, a calendar is popped up - you can also select the
16801 date with the mouse (button 1). The calendar shows a period of three
16802 months. To scroll it to other months, use the keys `>' and `<'.
16803 If you don't like the calendar, turn it off with
16804 \(setq org-read-date-popup-calendar nil)
16806 With optional argument TO-TIME, the date will immediately be converted
16807 to an internal time.
16808 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16809 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16810 still enter a time, and this function will inform the calling routine
16811 about this change. The calling routine may then choose to change the
16812 format used to insert the time stamp into the buffer to include the time.
16813 With optional argument FROM-STRING, read from this string instead from
16814 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16815 the time/date that is used for everything that is not specified by the
16816 user."
16817 (require 'parse-time)
16818 (let* ((org-time-stamp-rounding-minutes
16819 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16820 (org-dcst org-display-custom-times)
16821 (ct (org-current-time))
16822 (org-def (or org-overriding-default-time default-time ct))
16823 (org-defdecode (decode-time org-def))
16824 (dummy (progn
16825 (when (< (nth 2 org-defdecode) org-extend-today-until)
16826 (setcar (nthcdr 2 org-defdecode) -1)
16827 (setcar (nthcdr 1 org-defdecode) 59)
16828 (setq org-def (apply 'encode-time org-defdecode)
16829 org-defdecode (decode-time org-def)))))
16830 (cur-frame (selected-frame))
16831 (mouse-autoselect-window nil) ; Don't let the mouse jump
16832 (calendar-frame-setup nil)
16833 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16834 (calendar-move-hook nil)
16835 (calendar-view-diary-initially-flag nil)
16836 (calendar-view-holidays-initially-flag nil)
16837 (timestr (format-time-string
16838 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16839 (prompt (concat (if prompt (concat prompt " ") "")
16840 (format "Date+time [%s]: " timestr)))
16841 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16843 (cond
16844 (from-string (setq ans from-string))
16845 (org-read-date-popup-calendar
16846 (save-excursion
16847 (save-window-excursion
16848 (calendar)
16849 (when (eq calendar-setup 'calendar-only)
16850 (setq cal-frame
16851 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16852 (select-frame cal-frame))
16853 (org-eval-in-calendar '(setq cursor-type nil) t)
16854 (unwind-protect
16855 (progn
16856 (calendar-forward-day (- (time-to-days org-def)
16857 (calendar-absolute-from-gregorian
16858 (calendar-current-date))))
16859 (org-eval-in-calendar nil t)
16860 (let* ((old-map (current-local-map))
16861 (map (copy-keymap calendar-mode-map))
16862 (minibuffer-local-map
16863 (copy-keymap org-read-date-minibuffer-local-map)))
16864 (org-defkey map (kbd "RET") 'org-calendar-select)
16865 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16866 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16867 (unwind-protect
16868 (progn
16869 (use-local-map map)
16870 (setq org-read-date-inactive inactive)
16871 (add-hook 'post-command-hook 'org-read-date-display)
16872 (setq org-ans0 (read-string prompt default-input
16873 'org-read-date-history nil))
16874 ;; org-ans0: from prompt
16875 ;; org-ans1: from mouse click
16876 ;; org-ans2: from calendar motion
16877 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16878 (remove-hook 'post-command-hook 'org-read-date-display)
16879 (use-local-map old-map)
16880 (when org-read-date-overlay
16881 (delete-overlay org-read-date-overlay)
16882 (setq org-read-date-overlay nil)))))
16883 (bury-buffer "*Calendar*")
16884 (when cal-frame
16885 (delete-frame cal-frame)
16886 (select-frame-set-input-focus cur-frame))))))
16888 (t ; Naked prompt only
16889 (unwind-protect
16890 (setq ans (read-string prompt default-input
16891 'org-read-date-history timestr))
16892 (when org-read-date-overlay
16893 (delete-overlay org-read-date-overlay)
16894 (setq org-read-date-overlay nil)))))
16896 (setq final (org-read-date-analyze ans org-def org-defdecode))
16898 (when org-read-date-analyze-forced-year
16899 (message "Year was forced into %s"
16900 (if org-read-date-force-compatible-dates
16901 "compatible range (1970-2037)"
16902 "range representable on this machine"))
16903 (ding))
16905 ;; One round trip to get rid of 34th of August and stuff like that....
16906 (setq final (decode-time (apply 'encode-time final)))
16908 (setq org-read-date-final-answer ans)
16910 (if to-time
16911 (apply 'encode-time final)
16912 (if (and (boundp 'org-time-was-given) org-time-was-given)
16913 (format "%04d-%02d-%02d %02d:%02d"
16914 (nth 5 final) (nth 4 final) (nth 3 final)
16915 (nth 2 final) (nth 1 final))
16916 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16918 (defun org-read-date-display ()
16919 "Display the current date prompt interpretation in the minibuffer."
16920 (when org-read-date-display-live
16921 (when org-read-date-overlay
16922 (delete-overlay org-read-date-overlay))
16923 (when (minibufferp (current-buffer))
16924 (save-excursion
16925 (end-of-line 1)
16926 (while (not (equal (buffer-substring
16927 (max (point-min) (- (point) 4)) (point))
16928 " "))
16929 (insert " ")))
16930 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16931 " " (or org-ans1 org-ans2)))
16932 (org-end-time-was-given nil)
16933 (f (org-read-date-analyze ans org-def org-defdecode))
16934 (fmts (if org-dcst
16935 org-time-stamp-custom-formats
16936 org-time-stamp-formats))
16937 (fmt (if (or org-with-time
16938 (and (boundp 'org-time-was-given) org-time-was-given))
16939 (cdr fmts)
16940 (car fmts)))
16941 (txt (format-time-string fmt (apply 'encode-time f)))
16942 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16943 (txt (concat "=> " txt)))
16944 (when (and org-end-time-was-given
16945 (string-match org-plain-time-of-day-regexp txt))
16946 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16947 org-end-time-was-given
16948 (substring txt (match-end 0)))))
16949 (when org-read-date-analyze-futurep
16950 (setq txt (concat txt " (=>F)")))
16951 (setq org-read-date-overlay
16952 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16953 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16955 (defun org-read-date-analyze (ans org-def org-defdecode)
16956 "Analyze the combined answer of the date prompt."
16957 ;; FIXME: cleanup and comment
16958 (let ((nowdecode (decode-time (current-time)))
16959 delta deltan deltaw deltadef year month day
16960 hour minute second wday pm h2 m2 tl wday1
16961 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16962 (setq org-read-date-analyze-futurep nil
16963 org-read-date-analyze-forced-year nil)
16964 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16965 (setq ans "+0"))
16967 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16968 (setq ans (replace-match "" t t ans)
16969 deltan (car delta)
16970 deltaw (nth 1 delta)
16971 deltadef (nth 2 delta)))
16973 ;; Check if there is an iso week date in there. If yes, store the
16974 ;; info and postpone interpreting it until the rest of the parsing
16975 ;; is done.
16976 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16977 (setq iso-year (if (match-end 1)
16978 (org-small-year-to-year
16979 (string-to-number (match-string 1 ans))))
16980 iso-weekday (if (match-end 3)
16981 (string-to-number (match-string 3 ans)))
16982 iso-week (string-to-number (match-string 2 ans)))
16983 (setq ans (replace-match "" t t ans)))
16985 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16986 (when (string-match
16987 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16988 (setq year (if (match-end 2)
16989 (string-to-number (match-string 2 ans))
16990 (progn (setq kill-year t)
16991 (string-to-number (format-time-string "%Y"))))
16992 month (string-to-number (match-string 3 ans))
16993 day (string-to-number (match-string 4 ans)))
16994 (if (< year 100) (setq year (+ 2000 year)))
16995 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16996 t nil ans)))
16998 ;; Help matching dotted european dates
16999 (when (string-match
17000 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17001 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17002 (setq kill-year t)
17003 (string-to-number (format-time-string "%Y")))
17004 day (string-to-number (match-string 1 ans))
17005 month (string-to-number (match-string 2 ans))
17006 ans (replace-match (format "%04d-%02d-%02d" year month day)
17007 t nil ans)))
17009 ;; Help matching american dates, like 5/30 or 5/30/7
17010 (when (string-match
17011 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17012 (setq year (if (match-end 4)
17013 (string-to-number (match-string 4 ans))
17014 (progn (setq kill-year t)
17015 (string-to-number (format-time-string "%Y"))))
17016 month (string-to-number (match-string 1 ans))
17017 day (string-to-number (match-string 2 ans)))
17018 (if (< year 100) (setq year (+ 2000 year)))
17019 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17020 t nil ans)))
17021 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17022 ;; If there is a time with am/pm, and *no* time without it, we convert
17023 ;; so that matching will be successful.
17024 (loop for i from 1 to 2 do ; twice, for end time as well
17025 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17026 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17027 (setq hour (string-to-number (match-string 1 ans))
17028 minute (if (match-end 3)
17029 (string-to-number (match-string 3 ans))
17031 pm (equal ?p
17032 (string-to-char (downcase (match-string 4 ans)))))
17033 (if (and (= hour 12) (not pm))
17034 (setq hour 0)
17035 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17036 (setq ans (replace-match (format "%02d:%02d" hour minute)
17037 t t ans))))
17039 ;; Check if a time range is given as a duration
17040 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17041 (setq hour (string-to-number (match-string 1 ans))
17042 h2 (+ hour (string-to-number (match-string 3 ans)))
17043 minute (string-to-number (match-string 2 ans))
17044 m2 (+ minute (if (match-end 5) (string-to-number
17045 (match-string 5 ans))0)))
17046 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17047 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17048 t t ans)))
17050 ;; Check if there is a time range
17051 (when (boundp 'org-end-time-was-given)
17052 (setq org-time-was-given nil)
17053 (when (and (string-match org-plain-time-of-day-regexp ans)
17054 (match-end 8))
17055 (setq org-end-time-was-given (match-string 8 ans))
17056 (setq ans (concat (substring ans 0 (match-beginning 7))
17057 (substring ans (match-end 7))))))
17059 (setq tl (parse-time-string ans)
17060 day (or (nth 3 tl) (nth 3 org-defdecode))
17061 month
17062 (cond ((nth 4 tl))
17063 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17064 ;; Day was specified. Make sure DAY+MONTH
17065 ;; combination happens in the future.
17066 ((nth 3 tl)
17067 (setq futurep t)
17068 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17069 (nth 4 nowdecode)))
17070 (t (nth 4 org-defdecode)))
17071 year
17072 (cond ((and (not kill-year) (nth 5 tl)))
17073 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17074 ;; Month was guessed in the future and is at least
17075 ;; equal to NOWDECODE's. Fix year accordingly.
17076 (futurep
17077 (if (or (> month (nth 4 nowdecode))
17078 (>= day (nth 3 nowdecode)))
17079 (nth 5 nowdecode)
17080 (1+ (nth 5 nowdecode))))
17081 ;; Month was specified. Make sure MONTH+YEAR
17082 ;; combination happens in the future.
17083 ((nth 4 tl)
17084 (setq futurep t)
17085 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17086 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17087 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17088 (t (nth 5 nowdecode))))
17089 (t (nth 5 org-defdecode)))
17090 hour (or (nth 2 tl) (nth 2 org-defdecode))
17091 minute (or (nth 1 tl) (nth 1 org-defdecode))
17092 second (or (nth 0 tl) 0)
17093 wday (nth 6 tl))
17095 (when (and (eq org-read-date-prefer-future 'time)
17096 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17097 (equal day (nth 3 nowdecode))
17098 (equal month (nth 4 nowdecode))
17099 (equal year (nth 5 nowdecode))
17100 (nth 2 tl)
17101 (or (< (nth 2 tl) (nth 2 nowdecode))
17102 (and (= (nth 2 tl) (nth 2 nowdecode))
17103 (nth 1 tl)
17104 (< (nth 1 tl) (nth 1 nowdecode)))))
17105 (setq day (1+ day)
17106 futurep t))
17108 ;; Special date definitions below
17109 (cond
17110 (iso-week
17111 ;; There was an iso week
17112 (require 'cal-iso)
17113 (setq futurep nil)
17114 (setq year (or iso-year year)
17115 day (or iso-weekday wday 1)
17116 wday nil ; to make sure that the trigger below does not match
17117 iso-date (calendar-gregorian-from-absolute
17118 (calendar-iso-to-absolute
17119 (list iso-week day year))))
17120 ; FIXME: Should we also push ISO weeks into the future?
17121 ; (when (and org-read-date-prefer-future
17122 ; (not iso-year)
17123 ; (< (calendar-absolute-from-gregorian iso-date)
17124 ; (time-to-days (current-time))))
17125 ; (setq year (1+ year)
17126 ; iso-date (calendar-gregorian-from-absolute
17127 ; (calendar-iso-to-absolute
17128 ; (list iso-week day year)))))
17129 (setq month (car iso-date)
17130 year (nth 2 iso-date)
17131 day (nth 1 iso-date)))
17132 (deltan
17133 (setq futurep nil)
17134 (unless deltadef
17135 (let ((now (decode-time (current-time))))
17136 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17137 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17138 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17139 ((equal deltaw "m") (setq month (+ month deltan)))
17140 ((equal deltaw "y") (setq year (+ year deltan)))))
17141 ((and wday (not (nth 3 tl)))
17142 ;; Weekday was given, but no day, so pick that day in the week
17143 ;; on or after the derived date.
17144 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17145 (unless (equal wday wday1)
17146 (setq day (+ day (% (- wday wday1 -7) 7))))))
17147 (if (and (boundp 'org-time-was-given)
17148 (nth 2 tl))
17149 (setq org-time-was-given t))
17150 (if (< year 100) (setq year (+ 2000 year)))
17151 ;; Check of the date is representable
17152 (if org-read-date-force-compatible-dates
17153 (progn
17154 (if (< year 1970)
17155 (setq year 1970 org-read-date-analyze-forced-year t))
17156 (if (> year 2037)
17157 (setq year 2037 org-read-date-analyze-forced-year t)))
17158 (condition-case nil
17159 (ignore (encode-time second minute hour day month year))
17160 (error
17161 (setq year (nth 5 org-defdecode))
17162 (setq org-read-date-analyze-forced-year t))))
17163 (setq org-read-date-analyze-futurep futurep)
17164 (list second minute hour day month year)))
17166 (defvar parse-time-weekdays)
17167 (defun org-read-date-get-relative (s today default)
17168 "Check string S for special relative date string.
17169 TODAY and DEFAULT are internal times, for today and for a default.
17170 Return shift list (N what def-flag)
17171 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17172 N is the number of WHATs to shift.
17173 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17174 the DEFAULT date rather than TODAY."
17175 (require 'parse-time)
17176 (when (and
17177 (string-match
17178 (concat
17179 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17180 "\\([0-9]+\\)?"
17181 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17182 "\\([ \t]\\|$\\)") s)
17183 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17184 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17185 (string-to-char (substring (match-string 1 s) -1))
17186 ?+))
17187 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17188 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17189 (what (if (match-end 3) (match-string 3 s) "d"))
17190 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17191 (date (if rel default today))
17192 (wday (nth 6 (decode-time date)))
17193 delta)
17194 (if wday1
17195 (progn
17196 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17197 (if (= delta 0) (setq delta 7))
17198 (if (= dir ?-)
17199 (progn
17200 (setq delta (- delta 7))
17201 (if (= delta 0) (setq delta -7))))
17202 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17203 (list delta "d" rel))
17204 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17206 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17207 "Turn a user-specified date into the internal representation.
17208 The internal representation needed by the calendar is (month day year).
17209 This is a wrapper to handle the brain-dead convention in calendar that
17210 user function argument order change dependent on argument order."
17211 (if (boundp 'calendar-date-style)
17212 (cond
17213 ((eq calendar-date-style 'american)
17214 (list arg1 arg2 arg3))
17215 ((eq calendar-date-style 'european)
17216 (list arg2 arg1 arg3))
17217 ((eq calendar-date-style 'iso)
17218 (list arg2 arg3 arg1)))
17219 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17220 (if (org-bound-and-true-p european-calendar-style)
17221 (list arg2 arg1 arg3)
17222 (list arg1 arg2 arg3)))))
17224 (defun org-eval-in-calendar (form &optional keepdate)
17225 "Eval FORM in the calendar window and return to current window.
17226 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17227 otherwise stick to the current value of `org-ans2'."
17228 (let ((sf (selected-frame))
17229 (sw (selected-window)))
17230 (select-window (get-buffer-window "*Calendar*" t))
17231 (eval form)
17232 (when (and (not keepdate) (calendar-cursor-to-date))
17233 (let* ((date (calendar-cursor-to-date))
17234 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17235 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17236 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17237 (select-window sw)
17238 (org-select-frame-set-input-focus sf)))
17240 (defun org-calendar-select ()
17241 "Return to `org-read-date' with the date currently selected.
17242 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17243 (interactive)
17244 (when (calendar-cursor-to-date)
17245 (let* ((date (calendar-cursor-to-date))
17246 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17247 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17248 (if (active-minibuffer-window) (exit-minibuffer))))
17250 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17251 "Insert a date stamp for the date given by the internal TIME.
17252 See `format-time-string' for the format of TIME.
17253 WITH-HM means use the stamp format that includes the time of the day.
17254 INACTIVE means use square brackets instead of angular ones, so that the
17255 stamp will not contribute to the agenda.
17256 PRE and POST are optional strings to be inserted before and after the
17257 stamp.
17258 The command returns the inserted time stamp."
17259 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17260 stamp)
17261 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17262 (insert-before-markers (or pre ""))
17263 (when (listp extra)
17264 (setq extra (car extra))
17265 (if (and (stringp extra)
17266 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17267 (setq extra (format "-%02d:%02d"
17268 (string-to-number (match-string 1 extra))
17269 (string-to-number (match-string 2 extra))))
17270 (setq extra nil)))
17271 (when extra
17272 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17273 (insert-before-markers (setq stamp (format-time-string fmt time)))
17274 (insert-before-markers (or post ""))
17275 (setq org-last-inserted-timestamp stamp)))
17277 (defun org-toggle-time-stamp-overlays ()
17278 "Toggle the use of custom time stamp formats."
17279 (interactive)
17280 (setq org-display-custom-times (not org-display-custom-times))
17281 (unless org-display-custom-times
17282 (let ((p (point-min)) (bmp (buffer-modified-p)))
17283 (while (setq p (next-single-property-change p 'display))
17284 (if (and (get-text-property p 'display)
17285 (eq (get-text-property p 'face) 'org-date))
17286 (remove-text-properties
17287 p (setq p (next-single-property-change p 'display))
17288 '(display t))))
17289 (set-buffer-modified-p bmp)))
17290 (if (featurep 'xemacs)
17291 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17292 (org-restart-font-lock)
17293 (setq org-table-may-need-update t)
17294 (if org-display-custom-times
17295 (message "Time stamps are overlaid with custom format")
17296 (message "Time stamp overlays removed")))
17298 (defun org-display-custom-time (beg end)
17299 "Overlay modified time stamp format over timestamp between BEG and END."
17300 (let* ((ts (buffer-substring beg end))
17301 t1 w1 with-hm tf time str w2 (off 0))
17302 (save-match-data
17303 (setq t1 (org-parse-time-string ts t))
17304 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17305 (setq off (- (match-end 0) (match-beginning 0)))))
17306 (setq end (- end off))
17307 (setq w1 (- end beg)
17308 with-hm (and (nth 1 t1) (nth 2 t1))
17309 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17310 time (org-fix-decoded-time t1)
17311 str (org-add-props
17312 (format-time-string
17313 (substring tf 1 -1) (apply 'encode-time time))
17314 nil 'mouse-face 'highlight)
17315 w2 (length str))
17316 (if (not (= w2 w1))
17317 (add-text-properties (1+ beg) (+ 2 beg)
17318 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17319 (if (featurep 'xemacs)
17320 (progn
17321 (put-text-property beg end 'invisible t)
17322 (put-text-property beg end 'end-glyph (make-glyph str)))
17323 (put-text-property beg end 'display str))))
17325 (defun org-fix-decoded-time (time)
17326 "Set 0 instead of nil for the first 6 elements of time.
17327 Don't touch the rest."
17328 (let ((n 0))
17329 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17331 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17333 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17334 "Difference between TIMESTAMP-STRING and now in days.
17335 If SECONDS is non-nil, return the difference in seconds."
17336 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17337 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17338 (funcall fdiff (current-time)))))
17340 (defun org-deadline-close (timestamp-string &optional ndays)
17341 "Is the time in TIMESTAMP-STRING close to the current date?"
17342 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17343 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17344 (not (org-entry-is-done-p))))
17346 (defun org-get-wdays (ts &optional delay zero-delay)
17347 "Get the deadline lead time appropriate for timestring TS.
17348 When DELAY is non-nil, get the delay time for scheduled items
17349 instead of the deadline lead time. When ZERO-DELAY is non-nil
17350 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17351 don't try to find the delay cookie in the scheduled timestamp."
17352 (let ((tv (if delay org-scheduled-delay-days
17353 org-deadline-warning-days)))
17354 (cond
17355 ((or (and delay (< tv 0))
17356 (and delay zero-delay (<= tv 0))
17357 (and (not delay) (<= tv 0)))
17358 ;; Enforce this value no matter what
17359 (- tv))
17360 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17361 ;; lead time is specified.
17362 (floor (* (string-to-number (match-string 1 ts))
17363 (cdr (assoc (match-string 2 ts)
17364 '(("d" . 1) ("w" . 7)
17365 ("m" . 30.4) ("y" . 365.25)
17366 ("h" . 0.041667)))))))
17367 ;; go for the default.
17368 (t tv))))
17370 (defun org-calendar-select-mouse (ev)
17371 "Return to `org-read-date' with the date currently selected.
17372 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17373 (interactive "e")
17374 (mouse-set-point ev)
17375 (when (calendar-cursor-to-date)
17376 (let* ((date (calendar-cursor-to-date))
17377 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17378 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17379 (if (active-minibuffer-window) (exit-minibuffer))))
17381 (defun org-check-deadlines (ndays)
17382 "Check if there are any deadlines due or past due.
17383 A deadline is considered due if it happens within `org-deadline-warning-days'
17384 days from today's date. If the deadline appears in an entry marked DONE,
17385 it is not shown. The prefix arg NDAYS can be used to test that many
17386 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17387 (interactive "P")
17388 (let* ((org-warn-days
17389 (cond
17390 ((equal ndays '(4)) 100000)
17391 (ndays (prefix-numeric-value ndays))
17392 (t (abs org-deadline-warning-days))))
17393 (case-fold-search nil)
17394 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17395 (callback
17396 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17398 (message "%d deadlines past-due or due within %d days"
17399 (org-occur regexp nil callback)
17400 org-warn-days)))
17402 (defsubst org-re-timestamp (type)
17403 "Return a regexp for timestamp TYPE.
17404 Allowed values for TYPE are:
17406 all: all timestamps
17407 active: only active timestamps (<...>)
17408 inactive: only inactive timestamps ([...])
17409 scheduled: only scheduled timestamps
17410 deadline: only deadline timestamps
17411 closed: only closed time-stamps
17413 When TYPE is nil, fall back on returning a regexp that matches
17414 both scheduled and deadline timestamps."
17415 (case type
17416 (all org-ts-regexp-both)
17417 (active org-ts-regexp)
17418 (inactive org-ts-regexp-inactive)
17419 (scheduled org-scheduled-time-regexp)
17420 (deadline org-deadline-time-regexp)
17421 (closed org-closed-time-regexp)
17422 (otherwise
17423 (concat "\\<"
17424 (regexp-opt (list org-deadline-string org-scheduled-string))
17425 " *<\\([^>]+\\)>"))))
17427 (defun org-check-before-date (date)
17428 "Check if there are deadlines or scheduled entries before DATE."
17429 (interactive (list (org-read-date)))
17430 (let ((case-fold-search nil)
17431 (regexp (org-re-timestamp org-ts-type))
17432 (callback
17433 `(lambda ()
17434 (and ,(if (memq org-ts-type '(active inactive all))
17435 '(eq (org-element-type (org-element-context) 'timestamp))
17436 '(org-at-planning-p))
17437 (time-less-p
17438 (org-time-string-to-time (match-string 1))
17439 (org-time-string-to-time date))))))
17440 (message "%d entries before %s"
17441 (org-occur regexp nil callback) date)))
17443 (defun org-check-after-date (date)
17444 "Check if there are deadlines or scheduled entries after DATE."
17445 (interactive (list (org-read-date)))
17446 (let ((case-fold-search nil)
17447 (regexp (org-re-timestamp org-ts-type))
17448 (callback
17449 `(lambda ()
17450 (and ,(if (memq org-ts-type '(active inactive all))
17451 '(eq (org-element-type (org-element-context) 'timestamp))
17452 '(org-at-planning-p))
17453 (not (time-less-p
17454 (org-time-string-to-time (match-string 1))
17455 (org-time-string-to-time date)))))))
17456 (message "%d entries after %s"
17457 (org-occur regexp nil callback) date)))
17459 (defun org-check-dates-range (start-date end-date)
17460 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17461 (interactive (list (org-read-date nil nil nil "Range starts")
17462 (org-read-date nil nil nil "Range end")))
17463 (let ((case-fold-search nil)
17464 (regexp (org-re-timestamp org-ts-type))
17465 (callback
17466 `(lambda ()
17467 (let ((match (match-string 1)))
17468 (and
17469 ,(if (memq org-ts-type '(active inactive all))
17470 '(eq (org-element-type (org-element-context) 'timestamp))
17471 '(org-at-planning-p))
17472 (not (time-less-p
17473 (org-time-string-to-time match)
17474 (org-time-string-to-time start-date)))
17475 (time-less-p
17476 (org-time-string-to-time match)
17477 (org-time-string-to-time end-date)))))))
17478 (message "%d entries between %s and %s"
17479 (org-occur regexp nil callback) start-date end-date)))
17481 (defun org-evaluate-time-range (&optional to-buffer)
17482 "Evaluate a time range by computing the difference between start and end.
17483 Normally the result is just printed in the echo area, but with prefix arg
17484 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17485 If the time range is actually in a table, the result is inserted into the
17486 next column.
17487 For time difference computation, a year is assumed to be exactly 365
17488 days in order to avoid rounding problems."
17489 (interactive "P")
17491 (org-clock-update-time-maybe)
17492 (save-excursion
17493 (unless (org-at-date-range-p t)
17494 (goto-char (point-at-bol))
17495 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17496 (if (not (org-at-date-range-p t))
17497 (user-error "Not at a time-stamp range, and none found in current line")))
17498 (let* ((ts1 (match-string 1))
17499 (ts2 (match-string 2))
17500 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17501 (match-end (match-end 0))
17502 (time1 (org-time-string-to-time ts1))
17503 (time2 (org-time-string-to-time ts2))
17504 (t1 (org-float-time time1))
17505 (t2 (org-float-time time2))
17506 (diff (abs (- t2 t1)))
17507 (negative (< (- t2 t1) 0))
17508 ;; (ys (floor (* 365 24 60 60)))
17509 (ds (* 24 60 60))
17510 (hs (* 60 60))
17511 (fy "%dy %dd %02d:%02d")
17512 (fy1 "%dy %dd")
17513 (fd "%dd %02d:%02d")
17514 (fd1 "%dd")
17515 (fh "%02d:%02d")
17516 y d h m align)
17517 (if havetime
17518 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17520 d (floor (/ diff ds)) diff (mod diff ds)
17521 h (floor (/ diff hs)) diff (mod diff hs)
17522 m (floor (/ diff 60)))
17523 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17525 d (floor (+ (/ diff ds) 0.5))
17526 h 0 m 0))
17527 (if (not to-buffer)
17528 (message "%s" (org-make-tdiff-string y d h m))
17529 (if (org-at-table-p)
17530 (progn
17531 (goto-char match-end)
17532 (setq align t)
17533 (and (looking-at " *|") (goto-char (match-end 0))))
17534 (goto-char match-end))
17535 (if (looking-at
17536 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17537 (replace-match ""))
17538 (if negative (insert " -"))
17539 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17540 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17541 (insert " " (format fh h m))))
17542 (if align (org-table-align))
17543 (message "Time difference inserted")))))
17545 (defun org-make-tdiff-string (y d h m)
17546 (let ((fmt "")
17547 (l nil))
17548 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17549 l (push y l)))
17550 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17551 l (push d l)))
17552 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17553 l (push h l)))
17554 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17555 l (push m l)))
17556 (apply 'format fmt (nreverse l))))
17558 (defun org-time-string-to-time (s &optional buffer pos)
17559 "Convert a timestamp string into internal time."
17560 (condition-case errdata
17561 (apply 'encode-time (org-parse-time-string s))
17562 (error (error "Bad timestamp `%s'%s\nError was: %s"
17563 s (if (not (and buffer pos))
17565 (format " at %d in buffer `%s'" pos buffer))
17566 (cdr errdata)))))
17568 (defun org-time-string-to-seconds (s)
17569 "Convert a timestamp string to a number of seconds."
17570 (org-float-time (org-time-string-to-time s)))
17572 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17573 "Convert a time stamp to an absolute day number.
17574 If there is a specifier for a cyclic time stamp, get the closest
17575 date to DAYNR.
17576 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17577 The variable `date' is bound by the calendar when this is called."
17578 (cond
17579 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17580 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17581 daynr
17582 (+ daynr 1000)))
17583 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17584 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17585 (time-to-days (current-time))) (match-string 0 s)
17586 prefer show-all))
17587 (t (time-to-days
17588 (condition-case errdata
17589 (apply 'encode-time (org-parse-time-string s))
17590 (error (error "Bad timestamp `%s'%s\nError was: %s"
17591 s (if (not (and buffer pos))
17593 (format " at %d in buffer `%s'" pos buffer))
17594 (cdr errdata))))))))
17596 (defun org-days-to-iso-week (days)
17597 "Return the iso week number."
17598 (require 'cal-iso)
17599 (car (calendar-iso-from-absolute days)))
17601 (defun org-small-year-to-year (year)
17602 "Convert 2-digit years into 4-digit years.
17603 YEAR is expanded into one of the 30 next years, if possible, or
17604 into a past one. Any year larger than 99 is returned unchanged."
17605 (if (>= year 100) year
17606 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17607 (century (/ current 100))
17608 (offset (- year (% current 100))))
17609 (cond ((> offset 30) (+ (* (1- century) 100) year))
17610 ((> offset -70) (+ (* century 100) year))
17611 (t (+ (* (1+ century) 100) year))))))
17613 (defun org-time-from-absolute (d)
17614 "Return the time corresponding to date D.
17615 D may be an absolute day number, or a calendar-type list (month day year)."
17616 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17617 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17619 (defun org-calendar-holiday ()
17620 "List of holidays, for Diary display in Org-mode."
17621 (require 'holidays)
17622 (let ((hl (funcall
17623 (if (fboundp 'calendar-check-holidays)
17624 'calendar-check-holidays 'check-calendar-holidays) date)))
17625 (if hl (mapconcat 'identity hl "; "))))
17627 (defun org-diary-sexp-entry (sexp entry date)
17628 "Process a SEXP diary ENTRY for DATE."
17629 (require 'diary-lib)
17630 (let ((result (if calendar-debug-sexp
17631 (let ((stack-trace-on-error t))
17632 (eval (car (read-from-string sexp))))
17633 (condition-case nil
17634 (eval (car (read-from-string sexp)))
17635 (error
17636 (beep)
17637 (message "Bad sexp at line %d in %s: %s"
17638 (org-current-line)
17639 (buffer-file-name) sexp)
17640 (sleep-for 2))))))
17641 (cond ((stringp result) (split-string result "; "))
17642 ((and (consp result)
17643 (not (consp (cdr result)))
17644 (stringp (cdr result))) (cdr result))
17645 ((and (consp result)
17646 (stringp (car result))) result)
17647 (result entry))))
17649 (defun org-diary-to-ical-string (frombuf)
17650 "Get iCalendar entries from diary entries in buffer FROMBUF.
17651 This uses the icalendar.el library."
17652 (let* ((tmpdir (if (featurep 'xemacs)
17653 (temp-directory)
17654 temporary-file-directory))
17655 (tmpfile (make-temp-name
17656 (expand-file-name "orgics" tmpdir)))
17657 buf rtn b e)
17658 (with-current-buffer frombuf
17659 (icalendar-export-region (point-min) (point-max) tmpfile)
17660 (setq buf (find-buffer-visiting tmpfile))
17661 (set-buffer buf)
17662 (goto-char (point-min))
17663 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17664 (setq b (match-beginning 0)))
17665 (goto-char (point-max))
17666 (if (re-search-backward "^END:VEVENT" nil t)
17667 (setq e (match-end 0)))
17668 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17669 (kill-buffer buf)
17670 (delete-file tmpfile)
17671 rtn))
17673 (defun org-closest-date (start current change prefer show-all)
17674 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17675 When PREFER is `past', return a date that is either CURRENT or past.
17676 When PREFER is `future', return a date that is either CURRENT or future.
17677 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17678 ;; Make the proper lists from the dates
17679 (catch 'exit
17680 (let ((a1 '(("h" . hour)
17681 ("d" . day)
17682 ("w" . week)
17683 ("m" . month)
17684 ("y" . year)))
17685 (shour (nth 2 (org-parse-time-string start)))
17686 dn dw sday cday n1 n2 n0
17687 d m y y1 y2 date1 date2 nmonths nm ny m2)
17689 (setq start (org-date-to-gregorian start)
17690 current (org-date-to-gregorian
17691 (if show-all
17692 current
17693 (time-to-days (current-time))))
17694 sday (calendar-absolute-from-gregorian start)
17695 cday (calendar-absolute-from-gregorian current))
17697 (if (<= cday sday) (throw 'exit sday))
17699 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17700 (setq dn (string-to-number (match-string 1 change))
17701 dw (cdr (assoc (match-string 2 change) a1)))
17702 (user-error "Invalid change specifier: %s" change))
17703 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17704 (cond
17705 ((eq dw 'hour)
17706 (let ((missing-hours
17707 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17708 dn)))
17709 (setq n1 (if (zerop missing-hours) cday
17710 (- cday (1+ (floor (/ missing-hours 24)))))
17711 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17712 ((eq dw 'day)
17713 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17714 n2 (+ n1 dn)))
17715 ((eq dw 'year)
17716 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17717 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17718 (setq date1 (list m d y1)
17719 n1 (calendar-absolute-from-gregorian date1)
17720 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17721 n2 (calendar-absolute-from-gregorian date2)))
17722 ((eq dw 'month)
17723 ;; approx number of month between the two dates
17724 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17725 ;; How often does dn fit in there?
17726 (setq d (nth 1 start) m (car start) y (nth 2 start)
17727 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17728 m (+ m nm)
17729 ny (floor (/ m 12))
17730 y (+ y ny)
17731 m (- m (* ny 12)))
17732 (while (> m 12) (setq m (- m 12) y (1+ y)))
17733 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17734 (setq m2 (+ m dn) y2 y)
17735 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17736 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17737 (while (<= n2 cday)
17738 (setq n1 n2 m m2 y y2)
17739 (setq m2 (+ m dn) y2 y)
17740 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17741 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17742 ;; Make sure n1 is the earlier date
17743 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17744 (if show-all
17745 (cond
17746 ((eq prefer 'past) (if (= cday n2) n2 n1))
17747 ((eq prefer 'future) (if (= cday n1) n1 n2))
17748 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17749 (cond
17750 ((eq prefer 'past) (if (= cday n2) n2 n1))
17751 ((eq prefer 'future) (if (= cday n1) n1 n2))
17752 (t (if (= cday n1) n1 n2)))))))
17754 (defun org-date-to-gregorian (date)
17755 "Turn any specification of DATE into a Gregorian date for the calendar."
17756 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17757 ((and (listp date) (= (length date) 3)) date)
17758 ((stringp date)
17759 (setq date (org-parse-time-string date))
17760 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17761 ((listp date)
17762 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17764 (defun org-parse-time-string (s &optional nodefault)
17765 "Parse the standard Org-mode time string.
17766 This should be a lot faster than the normal `parse-time-string'.
17767 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17768 hour and minute fields will be nil if not given."
17769 (cond ((string-match org-ts-regexp0 s)
17770 (list 0
17771 (if (or (match-beginning 8) (not nodefault))
17772 (string-to-number (or (match-string 8 s) "0")))
17773 (if (or (match-beginning 7) (not nodefault))
17774 (string-to-number (or (match-string 7 s) "0")))
17775 (string-to-number (match-string 4 s))
17776 (string-to-number (match-string 3 s))
17777 (string-to-number (match-string 2 s))
17778 nil nil nil))
17779 ((string-match "^<[^>]+>$" s)
17780 (decode-time (seconds-to-time (org-matcher-time s))))
17781 (t (error "Not a standard Org-mode time string: %s" s))))
17783 (defun org-timestamp-up (&optional arg)
17784 "Increase the date item at the cursor by one.
17785 If the cursor is on the year, change the year. If it is on the month,
17786 the day or the time, change that.
17787 With prefix ARG, change by that many units."
17788 (interactive "p")
17789 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17791 (defun org-timestamp-down (&optional arg)
17792 "Decrease the date item at the cursor by one.
17793 If the cursor is on the year, change the year. If it is on the month,
17794 the day or the time, change that.
17795 With prefix ARG, change by that many units."
17796 (interactive "p")
17797 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17799 (defun org-timestamp-up-day (&optional arg)
17800 "Increase the date in the time stamp by one day.
17801 With prefix ARG, change that many days."
17802 (interactive "p")
17803 (if (and (not (org-at-timestamp-p t))
17804 (org-at-heading-p))
17805 (org-todo 'up)
17806 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17808 (defun org-timestamp-down-day (&optional arg)
17809 "Decrease the date in the time stamp by one day.
17810 With prefix ARG, change that many days."
17811 (interactive "p")
17812 (if (and (not (org-at-timestamp-p t))
17813 (org-at-heading-p))
17814 (org-todo 'down)
17815 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17817 (defun org-at-timestamp-p (&optional inactive-ok)
17818 "Determine if the cursor is in or at a timestamp."
17819 (interactive)
17820 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17821 (pos (point))
17822 (ans (or (looking-at tsr)
17823 (save-excursion
17824 (skip-chars-backward "^[<\n\r\t")
17825 (if (> (point) (point-min)) (backward-char 1))
17826 (and (looking-at tsr)
17827 (> (- (match-end 0) pos) -1))))))
17828 (and ans
17829 (boundp 'org-ts-what)
17830 (setq org-ts-what
17831 (cond
17832 ((= pos (match-beginning 0)) 'bracket)
17833 ;; Point is considered to be "on the bracket" whether
17834 ;; it's really on it or right after it.
17835 ((= pos (1- (match-end 0))) 'bracket)
17836 ((= pos (match-end 0)) 'after)
17837 ((org-pos-in-match-range pos 2) 'year)
17838 ((org-pos-in-match-range pos 3) 'month)
17839 ((org-pos-in-match-range pos 7) 'hour)
17840 ((org-pos-in-match-range pos 8) 'minute)
17841 ((or (org-pos-in-match-range pos 4)
17842 (org-pos-in-match-range pos 5)) 'day)
17843 ((and (> pos (or (match-end 8) (match-end 5)))
17844 (< pos (match-end 0)))
17845 (- pos (or (match-end 8) (match-end 5))))
17846 (t 'day))))
17847 ans))
17849 (defun org-toggle-timestamp-type ()
17850 "Toggle the type (<active> or [inactive]) of a time stamp."
17851 (interactive)
17852 (when (org-at-timestamp-p t)
17853 (let ((beg (match-beginning 0)) (end (match-end 0))
17854 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17855 (save-excursion
17856 (goto-char beg)
17857 (while (re-search-forward "[][<>]" end t)
17858 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17859 t t)))
17860 (message "Timestamp is now %sactive"
17861 (if (equal (char-after beg) ?<) "" "in")))))
17863 (defun org-at-clock-log-p nil
17864 "Is the cursor on the clock log line?"
17865 (save-excursion
17866 (move-beginning-of-line 1)
17867 (looking-at org-clock-line-re)))
17869 (defvar org-clock-history) ; defined in org-clock.el
17870 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17871 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17872 "Change the date in the time stamp at point.
17873 The date will be changed by N times WHAT. WHAT can be `day', `month',
17874 `year', `minute', `second'. If WHAT is not given, the cursor position
17875 in the timestamp determines what will be changed.
17876 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17877 (let ((origin (point)) origin-cat
17878 with-hm inactive
17879 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17880 org-ts-what
17881 extra rem
17882 ts time time0 fixnext clrgx)
17883 (if (not (org-at-timestamp-p t))
17884 (user-error "Not at a timestamp"))
17885 (if (and (not what) (eq org-ts-what 'bracket))
17886 (org-toggle-timestamp-type)
17887 ;; Point isn't on brackets. Remember the part of the time-stamp
17888 ;; the point was in. Indeed, size of time-stamps may change,
17889 ;; but point must be kept in the same category nonetheless.
17890 (setq origin-cat org-ts-what)
17891 (if (and (not what) (not (eq org-ts-what 'day))
17892 org-display-custom-times
17893 (get-text-property (point) 'display)
17894 (not (get-text-property (1- (point)) 'display)))
17895 (setq org-ts-what 'day))
17896 (setq org-ts-what (or what org-ts-what)
17897 inactive (= (char-after (match-beginning 0)) ?\[)
17898 ts (match-string 0))
17899 (replace-match "")
17900 (when (string-match
17901 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17903 (setq extra (match-string 1 ts))
17904 (if suppress-tmp-delay
17905 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17906 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17907 (setq with-hm t))
17908 (setq time0 (org-parse-time-string ts))
17909 (when (and updown
17910 (eq org-ts-what 'minute)
17911 (not current-prefix-arg))
17912 ;; This looks like s-up and s-down. Change by one rounding step.
17913 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17914 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17915 (setcar (cdr time0) (+ (nth 1 time0)
17916 (if (> n 0) (- rem) (- dm rem))))))
17917 (setq time
17918 (encode-time (or (car time0) 0)
17919 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17920 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17921 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17922 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17923 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17924 (nthcdr 6 time0)))
17925 (when (and (member org-ts-what '(hour minute))
17926 extra
17927 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17928 (setq extra (org-modify-ts-extra
17929 extra
17930 (if (eq org-ts-what 'hour) 2 5)
17931 n dm)))
17932 (when (integerp org-ts-what)
17933 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17934 (if (eq what 'calendar)
17935 (let ((cal-date (org-get-date-from-calendar)))
17936 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17937 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17938 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17939 (setcar time0 (or (car time0) 0))
17940 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17941 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17942 (setq time (apply 'encode-time time0))))
17943 ;; Insert the new time-stamp, and ensure point stays in the same
17944 ;; category as before (i.e. not after the last position in that
17945 ;; category).
17946 (let ((pos (point)))
17947 ;; Stay before inserted string. `save-excursion' is of no use.
17948 (setq org-last-changed-timestamp
17949 (org-insert-time-stamp time with-hm inactive nil nil extra))
17950 (goto-char pos))
17951 (save-match-data
17952 (looking-at org-ts-regexp3)
17953 (goto-char (cond
17954 ;; `day' category ends before `hour' if any, or at
17955 ;; the end of the day name.
17956 ((eq origin-cat 'day)
17957 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17958 ((eq origin-cat 'hour) (min (match-end 7) origin))
17959 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17960 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17961 ;; `year' and `month' have both fixed size: point
17962 ;; couldn't have moved into another part.
17963 (t origin))))
17964 ;; Update clock if on a CLOCK line.
17965 (org-clock-update-time-maybe)
17966 ;; Maybe adjust the closest clock in `org-clock-history'
17967 (when org-clock-adjust-closest
17968 (if (not (and (org-at-clock-log-p)
17969 (< 1 (length (delq nil (mapcar 'marker-position
17970 org-clock-history))))))
17971 (message "No clock to adjust")
17972 (cond ((save-excursion ; fix previous clock?
17973 (re-search-backward org-ts-regexp0 nil t)
17974 (org-looking-back (concat org-clock-string " \\[")))
17975 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17976 ((save-excursion ; fix next clock?
17977 (re-search-backward org-ts-regexp0 nil t)
17978 (looking-at (concat org-ts-regexp0 "\\] =>")))
17979 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17980 (save-window-excursion
17981 ;; Find closest clock to point, adjust the previous/next one in history
17982 (let* ((p (save-excursion (org-back-to-heading t)))
17983 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17984 (clfixnth
17985 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17986 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17987 (if (not clfixpos)
17988 (message "No clock to adjust")
17989 (save-excursion
17990 (org-goto-marker-or-bmk clfixpos)
17991 (org-show-subtree)
17992 (when (re-search-forward clrgx nil t)
17993 (goto-char (match-beginning 1))
17994 (let (org-clock-adjust-closest)
17995 (org-timestamp-change n org-ts-what updown))
17996 (message "Clock adjusted in %s for heading: %s"
17997 (file-name-nondirectory (buffer-file-name))
17998 (org-get-heading t t)))))))))
17999 ;; Try to recenter the calendar window, if any.
18000 (if (and org-calendar-follow-timestamp-change
18001 (get-buffer-window "*Calendar*" t)
18002 (memq org-ts-what '(day month year)))
18003 (org-recenter-calendar (time-to-days time))))))
18005 (defun org-modify-ts-extra (s pos n dm)
18006 "Change the different parts of the lead-time and repeat fields in timestamp."
18007 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18008 ng h m new rem)
18009 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18010 (cond
18011 ((or (org-pos-in-match-range pos 2)
18012 (org-pos-in-match-range pos 3))
18013 (setq m (string-to-number (match-string 3 s))
18014 h (string-to-number (match-string 2 s)))
18015 (if (org-pos-in-match-range pos 2)
18016 (setq h (+ h n))
18017 (setq n (* dm (org-no-warnings (signum n))))
18018 (when (not (= 0 (setq rem (% m dm))))
18019 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18020 (setq m (+ m n)))
18021 (if (< m 0) (setq m (+ m 60) h (1- h)))
18022 (if (> m 59) (setq m (- m 60) h (1+ h)))
18023 (setq h (min 24 (max 0 h)))
18024 (setq ng 1 new (format "-%02d:%02d" h m)))
18025 ((org-pos-in-match-range pos 6)
18026 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18027 ((org-pos-in-match-range pos 5)
18028 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18030 ((org-pos-in-match-range pos 9)
18031 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18032 ((org-pos-in-match-range pos 8)
18033 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18035 (when ng
18036 (setq s (concat
18037 (substring s 0 (match-beginning ng))
18039 (substring s (match-end ng))))))
18042 (defun org-recenter-calendar (date)
18043 "If the calendar is visible, recenter it to DATE."
18044 (let ((cwin (get-buffer-window "*Calendar*" t)))
18045 (when cwin
18046 (let ((calendar-move-hook nil))
18047 (with-selected-window cwin
18048 (calendar-goto-date (if (listp date) date
18049 (calendar-gregorian-from-absolute date))))))))
18051 (defun org-goto-calendar (&optional arg)
18052 "Go to the Emacs calendar at the current date.
18053 If there is a time stamp in the current line, go to that date.
18054 A prefix ARG can be used to force the current date."
18055 (interactive "P")
18056 (let ((tsr org-ts-regexp) diff
18057 (calendar-move-hook nil)
18058 (calendar-view-holidays-initially-flag nil)
18059 (calendar-view-diary-initially-flag nil))
18060 (if (or (org-at-timestamp-p)
18061 (save-excursion
18062 (beginning-of-line 1)
18063 (looking-at (concat ".*" tsr))))
18064 (let ((d1 (time-to-days (current-time)))
18065 (d2 (time-to-days
18066 (org-time-string-to-time (match-string 1)))))
18067 (setq diff (- d2 d1))))
18068 (calendar)
18069 (calendar-goto-today)
18070 (if (and diff (not arg)) (calendar-forward-day diff))))
18072 (defun org-get-date-from-calendar ()
18073 "Return a list (month day year) of date at point in calendar."
18074 (with-current-buffer "*Calendar*"
18075 (save-match-data
18076 (calendar-cursor-to-date))))
18078 (defun org-date-from-calendar ()
18079 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18080 If there is already a time stamp at the cursor position, update it."
18081 (interactive)
18082 (if (org-at-timestamp-p t)
18083 (org-timestamp-change 0 'calendar)
18084 (let ((cal-date (org-get-date-from-calendar)))
18085 (org-insert-time-stamp
18086 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18088 (defcustom org-effort-durations
18089 `(("min" . 1)
18090 ("h" . 60)
18091 ("d" . ,(* 60 8))
18092 ("w" . ,(* 60 8 5))
18093 ("m" . ,(* 60 8 5 4))
18094 ("y" . ,(* 60 8 5 40)))
18095 "Conversion factor to minutes for an effort modifier.
18097 Each entry has the form (MODIFIER . MINUTES).
18099 In an effort string, a number followed by MODIFIER is multiplied
18100 by the specified number of MINUTES to obtain an effort in
18101 minutes.
18103 For example, if the value of this variable is ((\"hours\" . 60)), then an
18104 effort string \"2hours\" is equivalent to 120 minutes."
18105 :group 'org-agenda
18106 :version "25.1"
18107 :package-version '(Org . "8.3")
18108 :type '(alist :key-type (string :tag "Modifier")
18109 :value-type (number :tag "Minutes")))
18111 (defun org-minutes-to-clocksum-string (m)
18112 "Format number of minutes as a clocksum string.
18113 The format is determined by `org-time-clocksum-format',
18114 `org-time-clocksum-use-fractional' and
18115 `org-time-clocksum-fractional-format' and
18116 `org-time-clocksum-use-effort-durations'."
18117 (let ((clocksum "")
18118 (m (round m)) ; Don't allow fractions of minutes
18119 h d w mo y fmt n)
18120 (setq h (if org-time-clocksum-use-effort-durations
18121 (cdr (assoc "h" org-effort-durations)) 60)
18122 d (if org-time-clocksum-use-effort-durations
18123 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18124 w (if org-time-clocksum-use-effort-durations
18125 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18126 mo (if org-time-clocksum-use-effort-durations
18127 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18128 y (if org-time-clocksum-use-effort-durations
18129 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18130 ;; fractional format
18131 (if org-time-clocksum-use-fractional
18132 (cond
18133 ;; single format string
18134 ((stringp org-time-clocksum-fractional-format)
18135 (format org-time-clocksum-fractional-format (/ m (float h))))
18136 ;; choice of fractional formats for different time units
18137 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18138 (> (/ (truncate m) (* y d h)) 0))
18139 (format fmt (/ m (* y d (float h)))))
18140 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18141 (> (/ (truncate m) (* mo d h)) 0))
18142 (format fmt (/ m (* mo d (float h)))))
18143 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18144 (> (/ (truncate m) (* w d h)) 0))
18145 (format fmt (/ m (* w d (float h)))))
18146 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18147 (> (/ (truncate m) (* d h)) 0))
18148 (format fmt (/ m (* d (float h)))))
18149 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18150 (> (/ (truncate m) h) 0))
18151 (format fmt (/ m (float h))))
18152 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18153 (format fmt m))
18154 ;; fall back to smallest time unit with a format
18155 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18156 (format fmt (/ m (float h))))
18157 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18158 (format fmt (/ m (* d (float h)))))
18159 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18160 (format fmt (/ m (* w d (float h)))))
18161 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18162 (format fmt (/ m (* mo d (float h)))))
18163 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18164 (format fmt (/ m (* y d (float h))))))
18165 ;; standard (non-fractional) format, with single format string
18166 (if (stringp org-time-clocksum-format)
18167 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18168 ;; separate formats components
18169 (and (setq fmt (plist-get org-time-clocksum-format :years))
18170 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18171 (plist-get org-time-clocksum-format :require-years))
18172 (setq clocksum (concat clocksum (format fmt n))
18173 m (- m (* n y d h))))
18174 (and (setq fmt (plist-get org-time-clocksum-format :months))
18175 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18176 (plist-get org-time-clocksum-format :require-months))
18177 (setq clocksum (concat clocksum (format fmt n))
18178 m (- m (* n mo d h))))
18179 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18180 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18181 (plist-get org-time-clocksum-format :require-weeks))
18182 (setq clocksum (concat clocksum (format fmt n))
18183 m (- m (* n w d h))))
18184 (and (setq fmt (plist-get org-time-clocksum-format :days))
18185 (or (> (setq n (/ (truncate m) (* d h))) 0)
18186 (plist-get org-time-clocksum-format :require-days))
18187 (setq clocksum (concat clocksum (format fmt n))
18188 m (- m (* n d h))))
18189 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18190 (or (> (setq n (/ (truncate m) h)) 0)
18191 (plist-get org-time-clocksum-format :require-hours))
18192 (setq clocksum (concat clocksum (format fmt n))
18193 m (- m (* n h))))
18194 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18195 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18196 (setq clocksum (concat clocksum (format fmt m))))
18197 ;; return formatted time duration
18198 clocksum))))
18200 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18201 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18202 "Org mode version 8.0")
18204 (defun org-hours-to-clocksum-string (n)
18205 (org-minutes-to-clocksum-string (* n 60)))
18207 (defun org-hh:mm-string-to-minutes (s)
18208 "Convert a string H:MM to a number of minutes.
18209 If the string is just a number, interpret it as minutes.
18210 In fact, the first hh:mm or number in the string will be taken,
18211 there can be extra stuff in the string.
18212 If no number is found, the return value is 0."
18213 (cond
18214 ((integerp s) s)
18215 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18216 (+ (* (string-to-number (match-string 1 s)) 60)
18217 (string-to-number (match-string 2 s))))
18218 ((string-match "\\([0-9]+\\)" s)
18219 (string-to-number (match-string 1 s)))
18220 (t 0)))
18222 (defcustom org-image-actual-width t
18223 "Should we use the actual width of images when inlining them?
18225 When set to `t', always use the image width.
18227 When set to a number, use imagemagick (when available) to set
18228 the image's width to this value.
18230 When set to a number in a list, try to get the width from any
18231 #+ATTR.* keyword if it matches a width specification like
18233 #+ATTR_HTML: :width 300px
18235 and fall back on that number if none is found.
18237 When set to nil, try to get the width from an #+ATTR.* keyword
18238 and fall back on the original width if none is found.
18240 This requires Emacs >= 24.1, build with imagemagick support."
18241 :group 'org-appearance
18242 :version "24.4"
18243 :package-version '(Org . "8.0")
18244 :type '(choice
18245 (const :tag "Use the image width" t)
18246 (integer :tag "Use a number of pixels")
18247 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18248 (const :tag "Use #+ATTR* or don't resize" nil)))
18250 (defcustom org-agenda-inhibit-startup nil
18251 "Inhibit startup when preparing agenda buffers.
18252 When this variable is `t', the initialization of the Org agenda
18253 buffers is inhibited: e.g. the visibility state is not set, the
18254 tables are not re-aligned, etc."
18255 :type 'boolean
18256 :version "24.3"
18257 :group 'org-agenda)
18259 (define-obsolete-variable-alias
18260 'org-agenda-ignore-drawer-properties
18261 'org-agenda-ignore-properties "25.1")
18263 (defcustom org-agenda-ignore-properties nil
18264 "Avoid updating text properties when building the agenda.
18265 Properties are used to prepare buffers for effort estimates,
18266 appointments, statistics and subtree-local categories.
18267 If you don't use these in the agenda, you can add them to this
18268 list and agenda building will be a bit faster.
18269 The value is a list, with zero or more of the symbols `effort', `appt',
18270 `stats' or `category'."
18271 :type '(set :greedy t
18272 (const effort)
18273 (const appt)
18274 (const stats)
18275 (const category))
18276 :version "25.1"
18277 :package-version '(Org . "8.3")
18278 :group 'org-agenda)
18280 (defun org-duration-string-to-minutes (s &optional output-to-string)
18281 "Convert a duration string S to minutes.
18283 A bare number is interpreted as minutes, modifiers can be set by
18284 customizing `org-effort-durations' (which see).
18286 Entries containing a colon are interpreted as H:MM by
18287 `org-hh:mm-string-to-minutes'."
18288 (let ((result 0)
18289 (re (concat "\\([0-9.]+\\) *\\("
18290 (regexp-opt (mapcar 'car org-effort-durations))
18291 "\\)")))
18292 (while (string-match re s)
18293 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18294 (string-to-number (match-string 1 s))))
18295 (setq s (replace-match "" nil t s)))
18296 (setq result (floor result))
18297 (incf result (org-hh:mm-string-to-minutes s))
18298 (if output-to-string (number-to-string result) result)))
18300 ;;;; Files
18302 (defun org-save-all-org-buffers ()
18303 "Save all Org-mode buffers without user confirmation."
18304 (interactive)
18305 (message "Saving all Org-mode buffers...")
18306 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18307 (when (featurep 'org-id) (org-id-locations-save))
18308 (message "Saving all Org-mode buffers... done"))
18310 (defun org-revert-all-org-buffers ()
18311 "Revert all Org-mode buffers.
18312 Prompt for confirmation when there are unsaved changes.
18313 Be sure you know what you are doing before letting this function
18314 overwrite your changes.
18316 This function is useful in a setup where one tracks org files
18317 with a version control system, to revert on one machine after pulling
18318 changes from another. I believe the procedure must be like this:
18320 1. M-x org-save-all-org-buffers
18321 2. Pull changes from the other machine, resolve conflicts
18322 3. M-x org-revert-all-org-buffers"
18323 (interactive)
18324 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18325 (user-error "Abort"))
18326 (save-excursion
18327 (save-window-excursion
18328 (mapc
18329 (lambda (b)
18330 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18331 (with-current-buffer b buffer-file-name))
18332 (org-pop-to-buffer-same-window b)
18333 (revert-buffer t 'no-confirm)))
18334 (buffer-list))
18335 (when (and (featurep 'org-id) org-id-track-globally)
18336 (org-id-locations-load)))))
18338 ;;;; Agenda files
18340 ;;;###autoload
18341 (defun org-switchb (&optional arg)
18342 "Switch between Org buffers.
18343 With one prefix argument, restrict available buffers to files.
18344 With two prefix arguments, restrict available buffers to agenda files.
18346 Defaults to `iswitchb' for buffer name completion.
18347 Set `org-completion-use-ido' to make it use ido instead."
18348 (interactive "P")
18349 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18350 ((equal arg '(16)) (org-buffer-list 'agenda))
18351 (t (org-buffer-list))))
18352 (org-completion-use-iswitchb org-completion-use-iswitchb)
18353 (org-completion-use-ido org-completion-use-ido))
18354 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18355 (setq org-completion-use-iswitchb t))
18356 (org-pop-to-buffer-same-window
18357 (org-icompleting-read "Org buffer: "
18358 (mapcar 'list (mapcar 'buffer-name blist))
18359 nil t))))
18361 ;;; Define some older names previously used for this functionality
18362 ;;;###autoload
18363 (defalias 'org-ido-switchb 'org-switchb)
18364 ;;;###autoload
18365 (defalias 'org-iswitchb 'org-switchb)
18367 (defun org-buffer-list (&optional predicate exclude-tmp)
18368 "Return a list of Org buffers.
18369 PREDICATE can be `export', `files' or `agenda'.
18371 export restrict the list to Export buffers.
18372 files restrict the list to buffers visiting Org files.
18373 agenda restrict the list to buffers visiting agenda files.
18375 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18376 (let* ((bfn nil)
18377 (agenda-files (and (eq predicate 'agenda)
18378 (mapcar 'file-truename (org-agenda-files t))))
18379 (filter
18380 (cond
18381 ((eq predicate 'files)
18382 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18383 ((eq predicate 'export)
18384 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18385 ((eq predicate 'agenda)
18386 (lambda (b)
18387 (with-current-buffer b
18388 (and (derived-mode-p 'org-mode)
18389 (setq bfn (buffer-file-name b))
18390 (member (file-truename bfn) agenda-files)))))
18391 (t (lambda (b) (with-current-buffer b
18392 (or (derived-mode-p 'org-mode)
18393 (string-match "\*Org .*Export"
18394 (buffer-name b)))))))))
18395 (delq nil
18396 (mapcar
18397 (lambda(b)
18398 (if (and (funcall filter b)
18399 (or (not exclude-tmp)
18400 (not (string-match "tmp" (buffer-name b)))))
18402 nil))
18403 (buffer-list)))))
18405 (defun org-agenda-files (&optional unrestricted archives)
18406 "Get the list of agenda files.
18407 Optional UNRESTRICTED means return the full list even if a restriction
18408 is currently in place.
18409 When ARCHIVES is t, include all archive files that are really being
18410 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18411 `org-agenda-archives-mode' is t."
18412 (let ((files
18413 (cond
18414 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18415 ((stringp org-agenda-files) (org-read-agenda-file-list))
18416 ((listp org-agenda-files) org-agenda-files)
18417 (t (error "Invalid value of `org-agenda-files'")))))
18418 (setq files (apply 'append
18419 (mapcar (lambda (f)
18420 (if (file-directory-p f)
18421 (directory-files
18422 f t org-agenda-file-regexp)
18423 (list f)))
18424 files)))
18425 (when org-agenda-skip-unavailable-files
18426 (setq files (delq nil
18427 (mapcar (function
18428 (lambda (file)
18429 (and (file-readable-p file) file)))
18430 files))))
18431 (when (or (eq archives t)
18432 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18433 (setq files (org-add-archive-files files)))
18434 files))
18436 (defun org-agenda-file-p (&optional file)
18437 "Return non-nil, if FILE is an agenda file.
18438 If FILE is omitted, use the file associated with the current
18439 buffer."
18440 (let ((fname (or file (buffer-file-name))))
18441 (and fname
18442 (member (file-truename fname)
18443 (mapcar #'file-truename (org-agenda-files t))))))
18445 (defun org-edit-agenda-file-list ()
18446 "Edit the list of agenda files.
18447 Depending on setup, this either uses customize to edit the variable
18448 `org-agenda-files', or it visits the file that is holding the list. In the
18449 latter case, the buffer is set up in a way that saving it automatically kills
18450 the buffer and restores the previous window configuration."
18451 (interactive)
18452 (if (stringp org-agenda-files)
18453 (let ((cw (current-window-configuration)))
18454 (find-file org-agenda-files)
18455 (org-set-local 'org-window-configuration cw)
18456 (org-add-hook 'after-save-hook
18457 (lambda ()
18458 (set-window-configuration
18459 (prog1 org-window-configuration
18460 (kill-buffer (current-buffer))))
18461 (org-install-agenda-files-menu)
18462 (message "New agenda file list installed"))
18463 nil 'local)
18464 (message "%s" (substitute-command-keys
18465 "Edit list and finish with \\[save-buffer]")))
18466 (customize-variable 'org-agenda-files)))
18468 (defun org-store-new-agenda-file-list (list)
18469 "Set new value for the agenda file list and save it correctly."
18470 (if (stringp org-agenda-files)
18471 (let ((fe (org-read-agenda-file-list t)) b u)
18472 (while (setq b (find-buffer-visiting org-agenda-files))
18473 (kill-buffer b))
18474 (with-temp-file org-agenda-files
18475 (insert
18476 (mapconcat
18477 (lambda (f) ;; Keep un-expanded entries.
18478 (if (setq u (assoc f fe))
18479 (cdr u)
18481 list "\n")
18482 "\n")))
18483 (let ((org-mode-hook nil) (org-inhibit-startup t)
18484 (org-insert-mode-line-in-empty-file nil))
18485 (setq org-agenda-files list)
18486 (customize-save-variable 'org-agenda-files org-agenda-files))))
18488 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18489 "Read the list of agenda files from a file.
18490 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18491 filenames, used by `org-store-new-agenda-file-list' to write back
18492 un-expanded file names."
18493 (when (file-directory-p org-agenda-files)
18494 (error "`org-agenda-files' cannot be a single directory"))
18495 (when (stringp org-agenda-files)
18496 (with-temp-buffer
18497 (insert-file-contents org-agenda-files)
18498 (mapcar
18499 (lambda (f)
18500 (let ((e (expand-file-name (substitute-in-file-name f)
18501 org-directory)))
18502 (if pair-with-expansion
18503 (cons e f)
18504 e)))
18505 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18507 ;;;###autoload
18508 (defun org-cycle-agenda-files ()
18509 "Cycle through the files in `org-agenda-files'.
18510 If the current buffer visits an agenda file, find the next one in the list.
18511 If the current buffer does not, find the first agenda file."
18512 (interactive)
18513 (let* ((fs (org-agenda-files t))
18514 (files (append fs (list (car fs))))
18515 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18516 file)
18517 (unless files (user-error "No agenda files"))
18518 (catch 'exit
18519 (while (setq file (pop files))
18520 (if (equal (file-truename file) tcf)
18521 (when (car files)
18522 (find-file (car files))
18523 (throw 'exit t))))
18524 (find-file (car fs)))
18525 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18527 (defun org-agenda-file-to-front (&optional to-end)
18528 "Move/add the current file to the top of the agenda file list.
18529 If the file is not present in the list, it is added to the front. If it is
18530 present, it is moved there. With optional argument TO-END, add/move to the
18531 end of the list."
18532 (interactive "P")
18533 (let ((org-agenda-skip-unavailable-files nil)
18534 (file-alist (mapcar (lambda (x)
18535 (cons (file-truename x) x))
18536 (org-agenda-files t)))
18537 (ctf (file-truename
18538 (or buffer-file-name
18539 (user-error "Please save the current buffer to a file"))))
18540 x had)
18541 (setq x (assoc ctf file-alist) had x)
18543 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18544 (if to-end
18545 (setq file-alist (append (delq x file-alist) (list x)))
18546 (setq file-alist (cons x (delq x file-alist))))
18547 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18548 (org-install-agenda-files-menu)
18549 (message "File %s to %s of agenda file list"
18550 (if had "moved" "added") (if to-end "end" "front"))))
18552 (defun org-remove-file (&optional file)
18553 "Remove current file from the list of files in variable `org-agenda-files'.
18554 These are the files which are being checked for agenda entries.
18555 Optional argument FILE means use this file instead of the current."
18556 (interactive)
18557 (let* ((org-agenda-skip-unavailable-files nil)
18558 (file (or file buffer-file-name
18559 (user-error "Current buffer does not visit a file")))
18560 (true-file (file-truename file))
18561 (afile (abbreviate-file-name file))
18562 (files (delq nil (mapcar
18563 (lambda (x)
18564 (if (equal true-file
18565 (file-truename x))
18566 nil x))
18567 (org-agenda-files t)))))
18568 (if (not (= (length files) (length (org-agenda-files t))))
18569 (progn
18570 (org-store-new-agenda-file-list files)
18571 (org-install-agenda-files-menu)
18572 (message "Removed from Org Agenda list: %s" afile))
18573 (message "File was not in list: %s (not removed)" afile))))
18575 (defun org-file-menu-entry (file)
18576 (vector file (list 'find-file file) t))
18578 (defun org-check-agenda-file (file)
18579 "Make sure FILE exists. If not, ask user what to do."
18580 (when (not (file-exists-p file))
18581 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18582 (abbreviate-file-name file))
18583 (let ((r (downcase (read-char-exclusive))))
18584 (cond
18585 ((equal r ?r)
18586 (org-remove-file file)
18587 (throw 'nextfile t))
18588 (t (user-error "Abort"))))))
18590 (defun org-get-agenda-file-buffer (file)
18591 "Get an agenda buffer visiting FILE.
18592 If the buffer needs to be created, add it to the list of buffers
18593 which might be released later."
18594 (let ((buf (org-find-base-buffer-visiting file)))
18595 (if buf
18596 buf ; just return it
18597 ;; Make a new buffer and remember it
18598 (setq buf (find-file-noselect file))
18599 (if buf (push buf org-agenda-new-buffers))
18600 buf)))
18602 (defun org-release-buffers (blist)
18603 "Release all buffers in list, asking the user for confirmation when needed.
18604 When a buffer is unmodified, it is just killed. When modified, it is saved
18605 \(if the user agrees) and then killed."
18606 (let (buf file)
18607 (while (setq buf (pop blist))
18608 (setq file (buffer-file-name buf))
18609 (when (and (buffer-modified-p buf)
18610 file
18611 (y-or-n-p (format "Save file %s? " file)))
18612 (with-current-buffer buf (save-buffer)))
18613 (kill-buffer buf))))
18615 (defun org-agenda-prepare-buffers (files)
18616 "Create buffers for all agenda files, protect archived trees and comments."
18617 (interactive)
18618 (let ((pa '(:org-archived t))
18619 (pc '(:org-comment t))
18620 (pall '(:org-archived t :org-comment t))
18621 (inhibit-read-only t)
18622 (org-inhibit-startup org-agenda-inhibit-startup)
18623 (rea (concat ":" org-archive-tag ":"))
18624 file re pos)
18625 (setq org-tag-alist-for-agenda nil
18626 org-tag-groups-alist-for-agenda nil)
18627 (save-excursion
18628 (save-restriction
18629 (while (setq file (pop files))
18630 (catch 'nextfile
18631 (if (bufferp file)
18632 (set-buffer file)
18633 (org-check-agenda-file file)
18634 (set-buffer (org-get-agenda-file-buffer file)))
18635 (widen)
18636 (org-set-regexps-and-options 'tags-only)
18637 (setq pos (point))
18638 (or (memq 'category org-agenda-ignore-properties)
18639 (org-refresh-category-properties))
18640 (or (memq 'stats org-agenda-ignore-properties)
18641 (org-refresh-stats-properties))
18642 (or (memq 'effort org-agenda-ignore-properties)
18643 (org-refresh-effort-properties))
18644 (or (memq 'appt org-agenda-ignore-properties)
18645 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18646 (setq org-todo-keywords-for-agenda
18647 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18648 (setq org-done-keywords-for-agenda
18649 (append org-done-keywords-for-agenda org-done-keywords))
18650 (setq org-todo-keyword-alist-for-agenda
18651 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18652 (setq org-tag-alist-for-agenda
18653 (org-uniquify
18654 (append org-tag-alist-for-agenda
18655 org-tag-alist
18656 org-tag-persistent-alist)))
18657 (if org-group-tags
18658 (setq org-tag-groups-alist-for-agenda
18659 (org-uniquify-alist
18660 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18661 (org-with-silent-modifications
18662 (save-excursion
18663 (remove-text-properties (point-min) (point-max) pall)
18664 (when org-agenda-skip-archived-trees
18665 (goto-char (point-min))
18666 (while (re-search-forward rea nil t)
18667 (if (org-at-heading-p t)
18668 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18669 (goto-char (point-min))
18670 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18671 (while (re-search-forward re nil t)
18672 (when (save-match-data (org-in-commented-heading-p t))
18673 (add-text-properties
18674 (match-beginning 0) (org-end-of-subtree t) pc)))))
18675 (goto-char pos)))))
18676 (setq org-todo-keywords-for-agenda
18677 (org-uniquify org-todo-keywords-for-agenda))
18678 (setq org-todo-keyword-alist-for-agenda
18679 (org-uniquify org-todo-keyword-alist-for-agenda))))
18682 ;;;; CDLaTeX minor mode
18684 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18685 "Keymap for the minor `org-cdlatex-mode'.")
18687 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18688 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18689 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18690 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18691 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18693 (defvar org-cdlatex-texmathp-advice-is-done nil
18694 "Flag remembering if we have applied the advice to texmathp already.")
18696 (define-minor-mode org-cdlatex-mode
18697 "Toggle the minor `org-cdlatex-mode'.
18698 This mode supports entering LaTeX environment and math in LaTeX fragments
18699 in Org-mode.
18700 \\{org-cdlatex-mode-map}"
18701 nil " OCDL" nil
18702 (when org-cdlatex-mode
18703 (require 'cdlatex)
18704 (run-hooks 'cdlatex-mode-hook)
18705 (cdlatex-compute-tables))
18706 (unless org-cdlatex-texmathp-advice-is-done
18707 (setq org-cdlatex-texmathp-advice-is-done t)
18708 (defadvice texmathp (around org-math-always-on activate)
18709 "Always return t in org-mode buffers.
18710 This is because we want to insert math symbols without dollars even outside
18711 the LaTeX math segments. If Orgmode thinks that point is actually inside
18712 an embedded LaTeX fragment, let texmathp do its job.
18713 \\[org-cdlatex-mode-map]"
18714 (interactive)
18715 (let (p)
18716 (cond
18717 ((not (derived-mode-p 'org-mode)) ad-do-it)
18718 ((eq this-command 'cdlatex-math-symbol)
18719 (setq ad-return-value t
18720 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18722 (let ((p (org-inside-LaTeX-fragment-p)))
18723 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18724 (setq ad-return-value t
18725 texmathp-why '("Org-mode embedded math" . 0))
18726 (if p ad-do-it)))))))))
18728 (defun turn-on-org-cdlatex ()
18729 "Unconditionally turn on `org-cdlatex-mode'."
18730 (org-cdlatex-mode 1))
18732 (defun org-try-cdlatex-tab ()
18733 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18734 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18735 - inside a LaTeX fragment, or
18736 - after the first word in a line, where an abbreviation expansion could
18737 insert a LaTeX environment."
18738 (when org-cdlatex-mode
18739 (cond
18740 ;; Before any word on the line: No expansion possible.
18741 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18742 ;; Just after first word on the line: Expand it. Make sure it
18743 ;; cannot happen on headlines, though.
18744 ((save-excursion
18745 (skip-chars-backward "a-zA-Z0-9*")
18746 (skip-chars-backward " \t")
18747 (and (bolp) (not (org-at-heading-p))))
18748 (cdlatex-tab) t)
18749 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18751 (defun org-cdlatex-underscore-caret (&optional arg)
18752 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18753 Revert to the normal definition outside of these fragments."
18754 (interactive "P")
18755 (if (org-inside-LaTeX-fragment-p)
18756 (call-interactively 'cdlatex-sub-superscript)
18757 (let (org-cdlatex-mode)
18758 (call-interactively (key-binding (vector last-input-event))))))
18760 (defun org-cdlatex-math-modify (&optional arg)
18761 "Execute `cdlatex-math-modify' in LaTeX fragments.
18762 Revert to the normal definition outside of these fragments."
18763 (interactive "P")
18764 (if (org-inside-LaTeX-fragment-p)
18765 (call-interactively 'cdlatex-math-modify)
18766 (let (org-cdlatex-mode)
18767 (call-interactively (key-binding (vector last-input-event))))))
18769 (defun org-cdlatex-environment-indent (&optional environment item)
18770 "Execute `cdlatex-environment' and indent the inserted environment.
18772 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18774 The inserted environment is indented to current indentation
18775 unless point is at the beginning of the line, in which the
18776 environment remains unintended."
18777 (interactive)
18778 ;; cdlatex-environment always return nil. Therefore, capture output
18779 ;; first and determine if an environment was selected.
18780 (let* ((beg (point-marker))
18781 (end (copy-marker (point) t))
18782 (inserted (progn
18783 (ignore-errors (cdlatex-environment environment item))
18784 (< beg end)))
18785 ;; Figure out how many lines to move forward after the
18786 ;; environment has been inserted.
18787 (lines (when inserted
18788 (save-excursion
18789 (- (loop while (< beg (point))
18790 with x = 0
18791 do (forward-line -1)
18792 (incf x)
18793 finally return x)
18794 (if (progn (goto-char beg)
18795 (and (progn (skip-chars-forward " \t") (eolp))
18796 (progn (skip-chars-backward " \t") (bolp))))
18797 1 0)))))
18798 (env (org-trim (delete-and-extract-region beg end))))
18799 (when inserted
18800 ;; Get indentation of next line unless at column 0.
18801 (let ((ind (if (bolp) 0
18802 (save-excursion
18803 (org-return-indent)
18804 (prog1 (org-get-indentation)
18805 (when (progn (skip-chars-forward " \t") (eolp))
18806 (delete-region beg (point)))))))
18807 (bol (progn (skip-chars-backward " \t") (bolp))))
18808 ;; Insert a newline before environment unless at column zero
18809 ;; to "escape" the current line. Insert a newline if
18810 ;; something is one the same line as \end{ENVIRONMENT}.
18811 (insert
18812 (concat (unless bol "\n") env
18813 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18814 (unless (zerop ind)
18815 (save-excursion
18816 (goto-char beg)
18817 (while (< (point) end)
18818 (unless (eolp) (org-indent-line-to ind))
18819 (forward-line))))
18820 (goto-char beg)
18821 (forward-line lines)
18822 (org-indent-line-to ind)))
18823 (set-marker beg nil)
18824 (set-marker end nil)))
18827 ;;;; LaTeX fragments
18829 (defun org-inside-LaTeX-fragment-p ()
18830 "Test if point is inside a LaTeX fragment.
18831 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18832 sequence appearing also before point.
18833 Even though the matchers for math are configurable, this function assumes
18834 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18835 delimiters are skipped when they have been removed by customization.
18836 The return value is nil, or a cons cell with the delimiter and the
18837 position of this delimiter.
18839 This function does a reasonably good job, but can locally be fooled by
18840 for example currency specifications. For example it will assume being in
18841 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18842 fragments that are properly closed, but during editing, we have to live
18843 with the uncertainty caused by missing closing delimiters. This function
18844 looks only before point, not after."
18845 (catch 'exit
18846 (let ((pos (point))
18847 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18848 (lim (progn
18849 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18850 (point)))
18851 dd-on str (start 0) m re)
18852 (goto-char pos)
18853 (when dodollar
18854 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18855 re (nth 1 (assoc "$" org-latex-regexps)))
18856 (while (string-match re str start)
18857 (cond
18858 ((= (match-end 0) (length str))
18859 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18860 ((= (match-end 0) (- (length str) 5))
18861 (throw 'exit nil))
18862 (t (setq start (match-end 0))))))
18863 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18864 (goto-char pos)
18865 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18866 (and (match-beginning 2) (throw 'exit nil))
18867 ;; count $$
18868 (while (re-search-backward "\\$\\$" lim t)
18869 (setq dd-on (not dd-on)))
18870 (goto-char pos)
18871 (if dd-on (cons "$$" m))))))
18873 (defun org-inside-latex-macro-p ()
18874 "Is point inside a LaTeX macro or its arguments?"
18875 (save-match-data
18876 (org-in-regexp
18877 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18879 (defvar org-latex-fragment-image-overlays nil
18880 "List of overlays carrying the images of latex fragments.")
18881 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18883 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18884 "Remove all overlays with LaTeX fragment images in current buffer.
18885 When optional arguments BEG and END are non-nil, remove all
18886 overlays between them instead. Return t when some overlays were
18887 removed, nil otherwise."
18888 (let (removedp)
18889 (setq org-latex-fragment-image-overlays
18890 (let ((beg (or beg (point-min)))
18891 (end (or end (point-max))))
18892 (org-remove-if
18893 (lambda (o)
18894 (and (>= (overlay-start o) beg)
18895 (<= (overlay-end o) end)
18896 (progn (delete-overlay o)
18897 (or removedp (setq removedp t)))))
18898 org-latex-fragment-image-overlays)))
18899 removedp))
18901 (define-obsolete-function-alias
18902 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18903 (defun org-toggle-latex-fragment (&optional arg)
18904 "Preview the LaTeX fragment at point, or all locally or globally.
18906 If the cursor is on a LaTeX fragment, create the image and overlay
18907 it over the source code, if there is none. Remove it otherwise.
18908 If there is no fragment at point, display all fragments in the
18909 current section.
18911 With prefix ARG, preview or clear image for all fragments in the
18912 current subtree or in the whole buffer when used before the first
18913 headline. With a double prefix ARG \\[universal-argument] \
18914 \\[universal-argument] preview or clear images
18915 for all fragments in the buffer."
18916 (interactive "P")
18917 (unless (buffer-file-name (buffer-base-buffer))
18918 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18919 (when (display-graphic-p)
18920 (catch 'exit
18921 (save-excursion
18922 (let ((window-start (window-start)) msg)
18923 (save-restriction
18924 (cond
18925 ((or (equal arg '(16))
18926 (and (equal arg '(4))
18927 (org-with-limited-levels (org-before-first-heading-p))))
18928 (if (org-remove-latex-fragment-image-overlays)
18929 (progn (message "LaTeX fragments images removed from buffer")
18930 (throw 'exit nil))
18931 (setq msg "Creating images for buffer...")))
18932 ((equal arg '(4))
18933 (org-with-limited-levels (org-back-to-heading t))
18934 (let ((beg (point))
18935 (end (progn (org-end-of-subtree t) (point))))
18936 (if (org-remove-latex-fragment-image-overlays beg end)
18937 (progn
18938 (message "LaTeX fragment images removed from subtree")
18939 (throw 'exit nil))
18940 (setq msg "Creating images for subtree...")
18941 (narrow-to-region beg end))))
18942 ((let ((datum (org-element-context)))
18943 (when (memq (org-element-type datum)
18944 '(latex-environment latex-fragment))
18945 (let* ((beg (org-element-property :begin datum))
18946 (end (org-element-property :end datum)))
18947 (if (org-remove-latex-fragment-image-overlays beg end)
18948 (progn (message "LaTeX fragment image removed")
18949 (throw 'exit nil))
18950 (narrow-to-region beg end)
18951 (setq msg "Creating image..."))))))
18953 (org-with-limited-levels
18954 (let ((beg (if (org-at-heading-p) (line-beginning-position)
18955 (outline-previous-heading)
18956 (point)))
18957 (end (progn (outline-next-heading) (point))))
18958 (if (org-remove-latex-fragment-image-overlays beg end)
18959 (progn
18960 (message "LaTeX fragment images removed from section")
18961 (throw 'exit nil))
18962 (setq msg "Creating images for section...")
18963 (narrow-to-region beg end))))))
18964 (let ((file (buffer-file-name (buffer-base-buffer))))
18965 (org-format-latex
18966 (concat org-latex-preview-ltxpng-directory
18967 (file-name-sans-extension (file-name-nondirectory file)))
18968 ;; Emacs cannot overlay images from remote hosts.
18969 ;; Create it in `temporary-file-directory' instead.
18970 (if (file-remote-p file) temporary-file-directory
18971 default-directory)
18972 'overlays msg 'forbuffer
18973 org-latex-create-formula-image-program)))
18974 ;; Work around a bug that doesn't restore window's start
18975 ;; when widening back the buffer.
18976 (set-window-start nil window-start)
18977 (message (concat msg "done")))))))
18979 (defun org-format-latex
18980 (prefix &optional dir overlays msg forbuffer processing-type)
18981 "Replace LaTeX fragments with links to an image, and produce images.
18983 When optional argument OVERLAYS is non-nil, display the image on
18984 top of the fragment instead of replacing it.
18986 PROCESSING-TYPE is the conversion method to use, as a symbol.
18988 Some of the options can be changed using the variable
18989 `org-format-latex-options', which see."
18990 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18991 (unless (eq processing-type 'verbatim)
18992 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
18993 (cnt 0)
18994 checkdir-flag)
18995 (goto-char (point-min))
18996 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
18997 (when (and overlays (memq processing-type '(dvipng imagemagick)))
18998 (overlay-recenter (point-max)))
18999 (while (re-search-forward math-regexp nil t)
19000 (unless (and overlays
19001 (eq (get-char-property (point) 'org-overlay-type)
19002 'org-latex-overlay))
19003 (let* ((context (org-element-context))
19004 (type (org-element-type context)))
19005 (when (memq type '(latex-environment latex-fragment))
19006 (let ((block-type (eq type 'latex-environment))
19007 (value (org-element-property :value context))
19008 (beg (org-element-property :begin context))
19009 (end (save-excursion
19010 (goto-char (org-element-property :end context))
19011 (skip-chars-backward " \r\t\n")
19012 (point))))
19013 (case processing-type
19014 (mathjax
19015 ;; Prepare for MathJax processing.
19016 (if (eq (char-after beg) ?$)
19017 (save-excursion
19018 (delete-region beg end)
19019 (insert "\\(" (substring value 1 -1) "\\)"))
19020 (goto-char end)))
19021 ((dvipng imagemagick)
19022 ;; Process to an image.
19023 (incf cnt)
19024 (goto-char beg)
19025 (let* ((face (face-at-point))
19026 ;; Get the colors from the face at point.
19028 (let ((color (plist-get org-format-latex-options
19029 :foreground)))
19030 (if (and forbuffer (eq color 'auto))
19031 (face-attribute face :foreground nil 'default)
19032 color)))
19034 (let ((color (plist-get org-format-latex-options
19035 :background)))
19036 (if (and forbuffer (eq color 'auto))
19037 (face-attribute face :background nil 'default)
19038 color)))
19039 (hash (sha1 (prin1-to-string
19040 (list org-format-latex-header
19041 org-latex-default-packages-alist
19042 org-latex-packages-alist
19043 org-format-latex-options
19044 forbuffer value fg bg))))
19045 (absprefix (expand-file-name prefix dir))
19046 (linkfile (format "%s_%s.png" prefix hash))
19047 (movefile (format "%s_%s.png" absprefix hash))
19048 (sep (and block-type "\n\n"))
19049 (link (concat sep "[[file:" linkfile "]]" sep))
19050 (options
19051 (org-combine-plists
19052 org-format-latex-options
19053 `(:foreground ,fg :background ,bg))))
19054 (when msg (message msg cnt))
19055 (unless checkdir-flag ; Ensure the directory exists.
19056 (setq checkdir-flag t)
19057 (let ((todir (file-name-directory absprefix)))
19058 (unless (file-directory-p todir)
19059 (make-directory todir t))))
19060 (unless (file-exists-p movefile)
19061 (org-create-formula-image
19062 value movefile options forbuffer processing-type))
19063 (if overlays
19064 (progn
19065 (dolist (o (overlays-in beg end))
19066 (when (eq (overlay-get o 'org-overlay-type)
19067 'org-latex-overlay)
19068 (delete-overlay o)))
19069 (let ((ov (make-overlay beg end)))
19070 (overlay-put ov
19071 'org-overlay-type
19072 'org-latex-overlay)
19073 (overlay-put ov 'evaporate t)
19074 (if (featurep 'xemacs)
19075 (progn
19076 (overlay-put ov 'invisible t)
19077 (overlay-put
19078 ov 'end-glyph
19079 (make-glyph
19080 (vector 'png :file movefile))))
19081 (overlay-put
19082 ov 'display
19083 (list 'image
19084 :type 'png
19085 :file movefile
19086 :ascent 'center)))
19087 (push ov org-latex-fragment-image-overlays))
19088 (goto-char end))
19089 (delete-region beg end)
19090 (insert
19091 (org-add-props link
19092 (list 'org-latex-src
19093 (replace-regexp-in-string "\"" "" value)
19094 'org-latex-src-embed-type
19095 (if block-type 'paragraph 'character)))))))
19096 (mathml
19097 ;; Process to MathML.
19098 (unless (org-format-latex-mathml-available-p)
19099 (user-error "LaTeX to MathML converter not configured"))
19100 (incf cnt)
19101 (when msg (message msg cnt))
19102 (goto-char beg)
19103 (delete-region beg end)
19104 (insert (org-format-latex-as-mathml
19105 value block-type prefix dir)))
19106 (otherwise
19107 (error "Unknown conversion type %s for LaTeX fragments"
19108 processing-type)))))))))))
19110 (defun org-create-math-formula (latex-frag &optional mathml-file)
19111 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19112 Use `org-latex-to-mathml-convert-command'. If the conversion is
19113 sucessful, return the portion between \"<math...> </math>\"
19114 elements otherwise return nil. When MATHML-FILE is specified,
19115 write the results in to that file. When invoked as an
19116 interactive command, prompt for LATEX-FRAG, with initial value
19117 set to the current active region and echo the results for user
19118 inspection."
19119 (interactive (list (let ((frag (when (org-region-active-p)
19120 (buffer-substring-no-properties
19121 (region-beginning) (region-end)))))
19122 (read-string "LaTeX Fragment: " frag nil frag))))
19123 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19124 (let* ((tmp-in-file (file-relative-name
19125 (make-temp-name (expand-file-name "ltxmathml-in"))))
19126 (ignore (write-region latex-frag nil tmp-in-file))
19127 (tmp-out-file (file-relative-name
19128 (make-temp-name (expand-file-name "ltxmathml-out"))))
19129 (cmd (format-spec
19130 org-latex-to-mathml-convert-command
19131 `((?j . ,(shell-quote-argument
19132 (expand-file-name org-latex-to-mathml-jar-file)))
19133 (?I . ,(shell-quote-argument tmp-in-file))
19134 (?i . ,latex-frag)
19135 (?o . ,(shell-quote-argument tmp-out-file)))))
19136 mathml shell-command-output)
19137 (when (org-called-interactively-p 'any)
19138 (unless (org-format-latex-mathml-available-p)
19139 (user-error "LaTeX to MathML converter not configured")))
19140 (message "Running %s" cmd)
19141 (setq shell-command-output (shell-command-to-string cmd))
19142 (setq mathml
19143 (when (file-readable-p tmp-out-file)
19144 (with-current-buffer (find-file-noselect tmp-out-file t)
19145 (goto-char (point-min))
19146 (when (re-search-forward
19147 (concat
19148 (regexp-quote
19149 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19150 "[^>]*?>"
19151 "\\(.\\|\n\\)*"
19152 "</math>")
19153 nil t)
19154 (prog1 (match-string 0) (kill-buffer))))))
19155 (cond
19156 (mathml
19157 (setq mathml
19158 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19159 (when mathml-file
19160 (write-region mathml nil mathml-file))
19161 (when (org-called-interactively-p 'any)
19162 (message mathml)))
19163 ((message "LaTeX to MathML conversion failed")
19164 (message shell-command-output)))
19165 (delete-file tmp-in-file)
19166 (when (file-exists-p tmp-out-file)
19167 (delete-file tmp-out-file))
19168 mathml))
19170 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19171 prefix &optional dir)
19172 "Use `org-create-math-formula' but check local cache first."
19173 (let* ((absprefix (expand-file-name prefix dir))
19174 (print-length nil) (print-level nil)
19175 (formula-id (concat
19176 "formula-"
19177 (sha1
19178 (prin1-to-string
19179 (list latex-frag
19180 org-latex-to-mathml-convert-command)))))
19181 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19182 (formula-cache-dir (file-name-directory formula-cache)))
19184 (unless (file-directory-p formula-cache-dir)
19185 (make-directory formula-cache-dir t))
19187 (unless (file-exists-p formula-cache)
19188 (org-create-math-formula latex-frag formula-cache))
19190 (if (file-exists-p formula-cache)
19191 ;; Successful conversion. Return the link to MathML file.
19192 (org-add-props
19193 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19194 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19195 'org-latex-src-embed-type (if latex-frag-type
19196 'paragraph 'character)))
19197 ;; Failed conversion. Return the LaTeX fragment verbatim
19198 latex-frag)))
19200 (defun org-create-formula-image (string tofile options buffer &optional type)
19201 "Create an image from LaTeX source using dvipng or convert.
19202 This function calls either `org-create-formula-image-with-dvipng'
19203 or `org-create-formula-image-with-imagemagick' depending on the
19204 value of `org-latex-create-formula-image-program' or on the value
19205 of the optional TYPE variable.
19207 Note: ultimately these two function should be combined as they
19208 share a good deal of logic."
19209 (org-check-external-command
19210 "latex" "needed to convert LaTeX fragments to images")
19211 (funcall
19212 (case (or type org-latex-create-formula-image-program)
19213 ('dvipng
19214 (org-check-external-command
19215 "dvipng" "needed to convert LaTeX fragments to images")
19216 'org-create-formula-image-with-dvipng)
19217 ('imagemagick
19218 (org-check-external-command
19219 "convert" "you need to install imagemagick")
19220 'org-create-formula-image-with-imagemagick)
19221 (t (error
19222 "Invalid value of `org-latex-create-formula-image-program'")))
19223 string tofile options buffer))
19225 (declare-function org-export-get-backend "ox" (name))
19226 (declare-function org-export--get-global-options "ox" (&optional backend))
19227 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19228 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19229 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19230 (defun org-create-formula--latex-header ()
19231 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19232 (let ((info (org-combine-plists (org-export--get-global-options
19233 (org-export-get-backend 'latex))
19234 (org-export--get-inbuffer-options
19235 (org-export-get-backend 'latex)))))
19236 (org-latex-guess-babel-language
19237 (org-latex-guess-inputenc
19238 (org-splice-latex-header
19239 org-format-latex-header
19240 org-latex-default-packages-alist
19241 org-latex-packages-alist t
19242 (plist-get info :latex-header)))
19243 info)))
19245 (defun org--get-display-dpi ()
19246 "Get the DPI of the display.
19248 Assumes that the display has the same pixel width in the
19249 horizontal and vertical directions."
19250 (if (display-graphic-p)
19251 (round (/ (display-pixel-height)
19252 (/ (display-mm-height) 25.4)))
19253 (error "Attempt to calculate the dpi of a non-graphic display")))
19255 ;; This function borrows from Ganesh Swami's latex2png.el
19256 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19257 "This calls dvipng."
19258 (require 'ox-latex)
19259 (let* ((tmpdir (if (featurep 'xemacs)
19260 (temp-directory)
19261 temporary-file-directory))
19262 (texfilebase (make-temp-name
19263 (expand-file-name "orgtex" tmpdir)))
19264 (texfile (concat texfilebase ".tex"))
19265 (dvifile (concat texfilebase ".dvi"))
19266 (pngfile (concat texfilebase ".png"))
19267 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19268 ;; This assumes that the display has the same pixel width in
19269 ;; the horizontal and vertical directions
19270 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19271 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19272 "Black"))
19273 (bg (or (plist-get options (if buffer :background :html-background))
19274 "Transparent")))
19275 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19276 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19277 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19278 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19279 (let ((latex-header (org-create-formula--latex-header)))
19280 (with-temp-file texfile
19281 (insert latex-header)
19282 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19283 (let ((dir default-directory))
19284 (ignore-errors
19285 (cd tmpdir)
19286 (call-process "latex" nil nil nil texfile))
19287 (cd dir))
19288 (if (not (file-exists-p dvifile))
19289 (progn (message "Failed to create dvi file from %s" texfile) nil)
19290 (ignore-errors
19291 (if (featurep 'xemacs)
19292 (call-process "dvipng" nil nil nil
19293 "-fg" fg "-bg" bg
19294 "-T" "tight"
19295 "-o" pngfile
19296 dvifile)
19297 (call-process "dvipng" nil nil nil
19298 "-fg" fg "-bg" bg
19299 "-D" dpi
19300 ;;"-x" scale "-y" scale
19301 "-T" "tight"
19302 "-o" pngfile
19303 dvifile)))
19304 (if (not (file-exists-p pngfile))
19305 (if org-format-latex-signal-error
19306 (error "Failed to create png file from %s" texfile)
19307 (message "Failed to create png file from %s" texfile)
19308 nil)
19309 ;; Use the requested file name and clean up
19310 (copy-file pngfile tofile 'replace)
19311 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19312 (if (file-exists-p (concat texfilebase e))
19313 (delete-file (concat texfilebase e))))
19314 pngfile))))
19316 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19317 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19318 "This calls convert, which is included into imagemagick."
19319 (require 'ox-latex)
19320 (let* ((tmpdir (if (featurep 'xemacs)
19321 (temp-directory)
19322 temporary-file-directory))
19323 (texfilebase (make-temp-name
19324 (expand-file-name "orgtex" tmpdir)))
19325 (texfile (concat texfilebase ".tex"))
19326 (pdffile (concat texfilebase ".pdf"))
19327 (pngfile (concat texfilebase ".png"))
19328 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19329 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19330 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19331 "black"))
19332 (bg (or (plist-get options (if buffer :background :html-background))
19333 "white")))
19334 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19335 (setq fg (org-latex-color-format fg)))
19336 (if (eq bg 'default) (setq bg (org-latex-color :background))
19337 (setq bg (org-latex-color-format
19338 (if (string= bg "Transparent") "white" bg))))
19339 (let ((latex-header (org-create-formula--latex-header)))
19340 (with-temp-file texfile
19341 (insert latex-header)
19342 (insert "\n\\begin{document}\n"
19343 "\\definecolor{fg}{rgb}{" fg "}\n"
19344 "\\definecolor{bg}{rgb}{" bg "}\n"
19345 "\n\\pagecolor{bg}\n"
19346 "\n{\\color{fg}\n"
19347 string
19348 "\n}\n"
19349 "\n\\end{document}\n")))
19350 (org-latex-compile texfile t)
19351 (if (not (file-exists-p pdffile))
19352 (progn (message "Failed to create pdf file from %s" texfile) nil)
19353 (ignore-errors
19354 (if (featurep 'xemacs)
19355 (call-process "convert" nil nil nil
19356 "-density" "96"
19357 "-trim"
19358 "-antialias"
19359 pdffile
19360 "-quality" "100"
19361 ;; "-sharpen" "0x1.0"
19362 pngfile)
19363 (call-process "convert" nil nil nil
19364 "-density" dpi
19365 "-trim"
19366 "-antialias"
19367 pdffile
19368 "-quality" "100"
19369 ;; "-sharpen" "0x1.0"
19370 pngfile)))
19371 (if (not (file-exists-p pngfile))
19372 (if org-format-latex-signal-error
19373 (error "Failed to create png file from %s" texfile)
19374 (message "Failed to create png file from %s" texfile)
19375 nil)
19376 ;; Use the requested file name and clean up
19377 (copy-file pngfile tofile 'replace)
19378 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19379 (if (file-exists-p (concat texfilebase e))
19380 (delete-file (concat texfilebase e))))
19381 pngfile))))
19383 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19384 "Fill a LaTeX header template TPL.
19385 In the template, the following place holders will be recognized:
19387 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19388 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19389 [PACKAGES] \\usepackage statements for PKG
19390 [NO-PACKAGES] do not include PKG
19391 [EXTRA] the string EXTRA
19392 [NO-EXTRA] do not include EXTRA
19394 For backward compatibility, if both the positive and the negative place
19395 holder is missing, the positive one (without the \"NO-\") will be
19396 assumed to be present at the end of the template.
19397 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19398 EXTRA is a string.
19399 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19400 (let (rpl (end ""))
19401 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19402 (setq rpl (if (or (match-end 1) (not def-pkg))
19403 "" (org-latex-packages-to-string def-pkg snippets-p t))
19404 tpl (replace-match rpl t t tpl))
19405 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19407 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19408 (setq rpl (if (or (match-end 1) (not pkg))
19409 "" (org-latex-packages-to-string pkg snippets-p t))
19410 tpl (replace-match rpl t t tpl))
19411 (if pkg (setq end
19412 (concat end "\n"
19413 (org-latex-packages-to-string pkg snippets-p)))))
19415 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19416 (setq rpl (if (or (match-end 1) (not extra))
19417 "" (concat extra "\n"))
19418 tpl (replace-match rpl t t tpl))
19419 (if (and extra (string-match "\\S-" extra))
19420 (setq end (concat end "\n" extra))))
19422 (if (string-match "\\S-" end)
19423 (concat tpl "\n" end)
19424 tpl)))
19426 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19427 "Turn an alist of packages into a string with the \\usepackage macros."
19428 (setq pkg (mapconcat (lambda(p)
19429 (cond
19430 ((stringp p) p)
19431 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19432 (format "%% Package %s omitted" (cadr p)))
19433 ((equal "" (car p))
19434 (format "\\usepackage{%s}" (cadr p)))
19436 (format "\\usepackage[%s]{%s}"
19437 (car p) (cadr p)))))
19439 "\n"))
19440 (if newline (concat pkg "\n") pkg))
19442 (defun org-dvipng-color (attr)
19443 "Return a RGB color specification for dvipng."
19444 (apply 'format "rgb %s %s %s"
19445 (mapcar 'org-normalize-color
19446 (if (featurep 'xemacs)
19447 (color-rgb-components
19448 (face-property 'default
19449 (cond ((eq attr :foreground) 'foreground)
19450 ((eq attr :background) 'background))))
19451 (color-values (face-attribute 'default attr nil))))))
19453 (defun org-dvipng-color-format (color-name)
19454 "Convert COLOR-NAME to a RGB color value for dvipng."
19455 (apply 'format "rgb %s %s %s"
19456 (mapcar 'org-normalize-color
19457 (color-values color-name))))
19459 (defun org-latex-color (attr)
19460 "Return a RGB color for the LaTeX color package."
19461 (apply 'format "%s,%s,%s"
19462 (mapcar 'org-normalize-color
19463 (if (featurep 'xemacs)
19464 (color-rgb-components
19465 (face-property 'default
19466 (cond ((eq attr :foreground) 'foreground)
19467 ((eq attr :background) 'background))))
19468 (color-values (face-attribute 'default attr nil))))))
19470 (defun org-latex-color-format (color-name)
19471 "Convert COLOR-NAME to a RGB color value."
19472 (apply 'format "%s,%s,%s"
19473 (mapcar 'org-normalize-color
19474 (color-values color-name))))
19476 (defun org-normalize-color (value)
19477 "Return string to be used as color value for an RGB component."
19478 (format "%g" (/ value 65535.0)))
19482 ;; Image display
19484 (defvar org-inline-image-overlays nil)
19485 (make-variable-buffer-local 'org-inline-image-overlays)
19487 (defun org-toggle-inline-images (&optional include-linked)
19488 "Toggle the display of inline images.
19489 INCLUDE-LINKED is passed to `org-display-inline-images'."
19490 (interactive "P")
19491 (if org-inline-image-overlays
19492 (progn
19493 (org-remove-inline-images)
19494 (when (org-called-interactively-p 'interactive)
19495 (message "Inline image display turned off")))
19496 (org-display-inline-images include-linked)
19497 (when (org-called-interactively-p 'interactive)
19498 (message (if org-inline-image-overlays
19499 (format "%d images displayed inline"
19500 (length org-inline-image-overlays))
19501 "No images to display inline")))))
19503 (defun org-redisplay-inline-images ()
19504 "Refresh the display of inline images."
19505 (interactive)
19506 (if (not org-inline-image-overlays)
19507 (org-toggle-inline-images)
19508 (org-toggle-inline-images)
19509 (org-toggle-inline-images)))
19511 (defun org-display-inline-images (&optional include-linked refresh beg end)
19512 "Display inline images.
19514 An inline image is a link which follows either of these
19515 conventions:
19517 1. Its path is a file with an extension matching return value
19518 from `image-file-name-regexp' and it has no contents.
19520 2. Its description consists in a single link of the previous
19521 type.
19523 When optional argument INCLUDE-LINKED is non-nil, also links with
19524 a text description part will be inlined. This can be nice for
19525 a quick look at those images, but it does not reflect what
19526 exported files will look like.
19528 When optional argument REFRESH is non-nil, refresh existing
19529 images between BEG and END. This will create new image displays
19530 only if necessary. BEG and END default to the buffer
19531 boundaries."
19532 (interactive "P")
19533 (when (display-graphic-p)
19534 (unless refresh
19535 (org-remove-inline-images)
19536 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19537 (org-with-wide-buffer
19538 (goto-char (or beg (point-min)))
19539 (let ((case-fold-search t)
19540 (file-extension-re (org-image-file-name-regexp)))
19541 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19542 (let ((link (save-match-data (org-element-context))))
19543 ;; Check if we're at an inline image.
19544 (when (and (equal (org-element-property :type link) "file")
19545 (or include-linked
19546 (not (org-element-property :contents-begin link)))
19547 (let ((parent (org-element-property :parent link)))
19548 (or (not (eq (org-element-type parent) 'link))
19549 (not (cdr (org-element-contents parent)))))
19550 (org-string-match-p file-extension-re
19551 (org-element-property :path link)))
19552 (let ((file (expand-file-name (org-element-property :path link))))
19553 (when (file-exists-p file)
19554 (let ((width
19555 ;; Apply `org-image-actual-width' specifications.
19556 (cond
19557 ((not (image-type-available-p 'imagemagick)) nil)
19558 ((eq org-image-actual-width t) nil)
19559 ((listp org-image-actual-width)
19561 ;; First try to find a width among
19562 ;; attributes associated to the paragraph
19563 ;; containing link.
19564 (let ((paragraph
19565 (let ((e link))
19566 (while (and (setq e (org-element-property
19567 :parent e))
19568 (not (eq (org-element-type e)
19569 'paragraph))))
19570 e)))
19571 (when paragraph
19572 (save-excursion
19573 (goto-char (org-element-property :begin paragraph))
19574 (when
19575 (re-search-forward
19576 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19577 (org-element-property
19578 :post-affiliated paragraph)
19580 (string-to-number (match-string 1))))))
19581 ;; Otherwise, fall-back to provided number.
19582 (car org-image-actual-width)))
19583 ((numberp org-image-actual-width)
19584 org-image-actual-width)))
19585 (old (get-char-property-and-overlay
19586 (org-element-property :begin link)
19587 'org-image-overlay)))
19588 (if (and (car-safe old) refresh)
19589 (image-refresh (overlay-get (cdr old) 'display))
19590 (let ((image (create-image file
19591 (and width 'imagemagick)
19593 :width width)))
19594 (when image
19595 (let* ((link
19596 ;; If inline image is the description
19597 ;; of another link, be sure to
19598 ;; consider the latter as the one to
19599 ;; apply the overlay on.
19600 (let ((parent
19601 (org-element-property :parent link)))
19602 (if (eq (org-element-type parent) 'link)
19603 parent
19604 link)))
19605 (ov (make-overlay
19606 (org-element-property :begin link)
19607 (progn
19608 (goto-char
19609 (org-element-property :end link))
19610 (skip-chars-backward " \t")
19611 (point)))))
19612 (overlay-put ov 'display image)
19613 (overlay-put ov 'face 'default)
19614 (overlay-put ov 'org-image-overlay t)
19615 (overlay-put
19616 ov 'modification-hooks
19617 (list 'org-display-inline-remove-overlay))
19618 (push ov org-inline-image-overlays)))))))))))))))
19620 (define-obsolete-function-alias
19621 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19623 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19624 "Remove inline-display overlay if a corresponding region is modified."
19625 (let ((inhibit-modification-hooks t))
19626 (when (and ov after)
19627 (delete ov org-inline-image-overlays)
19628 (delete-overlay ov))))
19630 (defun org-remove-inline-images ()
19631 "Remove inline display of images."
19632 (interactive)
19633 (mapc 'delete-overlay org-inline-image-overlays)
19634 (setq org-inline-image-overlays nil))
19636 ;;;; Key bindings
19638 ;; Outline functions from `outline-mode-prefix-map'
19639 ;; that can be remapped in Org:
19640 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19641 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19642 (define-key org-mode-map [remap outline-forward-same-level]
19643 'org-forward-heading-same-level)
19644 (define-key org-mode-map [remap outline-backward-same-level]
19645 'org-backward-heading-same-level)
19646 (define-key org-mode-map [remap show-branches]
19647 'org-kill-note-or-show-branches)
19648 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19649 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19650 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19651 (define-key org-mode-map [remap outline-next-visible-heading]
19652 'org-next-visible-heading)
19653 (define-key org-mode-map [remap outline-previous-visible-heading]
19654 'org-previous-visible-heading)
19656 ;; Outline functions from `outline-mode-prefix-map' that can not
19657 ;; be remapped in Org:
19659 ;; - the column "key binding" shows whether the Outline function is still
19660 ;; available in Org mode on the same key that it has been bound to in
19661 ;; Outline mode:
19662 ;; - "overridden": key used for a different functionality in Org mode
19663 ;; - else: key still bound to the same Outline function in Org mode
19665 ;; | Outline function | key binding | Org replacement |
19666 ;; |------------------------------------+-------------+--------------------------|
19667 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19668 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19669 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19670 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19671 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19672 ;; | `show-entry' | overridden | no replacement |
19673 ;; | `show-children' | `C-c C-i' | visibility cycling |
19674 ;; | `show-branches' | `C-c C-k' | still same function |
19675 ;; | `show-subtree' | overridden | visibility cycling |
19676 ;; | `show-all' | overridden | no replacement |
19677 ;; | `hide-subtree' | overridden | visibility cycling |
19678 ;; | `hide-body' | overridden | no replacement |
19679 ;; | `hide-entry' | overridden | visibility cycling |
19680 ;; | `hide-leaves' | overridden | no replacement |
19681 ;; | `hide-sublevels' | overridden | no replacement |
19682 ;; | `hide-other' | overridden | no replacement |
19684 ;; Make `C-c C-x' a prefix key
19685 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19687 ;; TAB key with modifiers
19688 (org-defkey org-mode-map "\C-i" 'org-cycle)
19689 (org-defkey org-mode-map [(tab)] 'org-cycle)
19690 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19691 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19692 ;; The following line is necessary under Suse GNU/Linux
19693 (unless (featurep 'xemacs)
19694 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19695 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19696 (define-key org-mode-map [backtab] 'org-shifttab)
19698 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19699 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19700 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19702 ;; Cursor keys with modifiers
19703 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19704 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19705 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19706 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19708 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19709 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19710 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19711 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19712 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19713 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19715 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19716 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19717 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19718 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19720 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19721 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19722 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19723 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19725 ;; Babel keys
19726 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19727 (mapc (lambda (pair)
19728 (define-key org-babel-map (car pair) (cdr pair)))
19729 org-babel-key-bindings)
19731 ;;; Extra keys for tty access.
19732 ;; We only set them when really needed because otherwise the
19733 ;; menus don't show the simple keys
19735 (when (or org-use-extra-keys
19736 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19737 (not window-system))
19738 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19739 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19740 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19741 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19742 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19743 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19744 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19745 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19746 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19747 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19748 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19749 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19750 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19751 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19752 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19753 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19754 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19755 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19756 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19757 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19758 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19759 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19760 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19761 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19762 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19763 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19764 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19765 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19767 ;; All the other keys
19769 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19770 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19771 (if (boundp 'narrow-map)
19772 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19773 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19774 (if (boundp 'narrow-map)
19775 (org-defkey narrow-map "b" 'org-narrow-to-block)
19776 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19777 (if (boundp 'narrow-map)
19778 (org-defkey narrow-map "e" 'org-narrow-to-element)
19779 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19780 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19781 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19782 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19783 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19784 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19785 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19786 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19787 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19788 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19789 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19790 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19791 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19792 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19793 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19794 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19795 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19796 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19797 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19798 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19799 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19800 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19801 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19802 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19803 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19804 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19805 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19806 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19807 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19808 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19809 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19810 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19811 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19812 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19813 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19814 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19815 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19816 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19817 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19818 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19819 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19820 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19821 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19822 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19823 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19824 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19825 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19826 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19827 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19828 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19829 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19830 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19831 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19832 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19833 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19834 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19835 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19836 (org-defkey org-mode-map "\C-c^" 'org-sort)
19837 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19838 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19839 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19840 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19841 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19842 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19843 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19844 (org-defkey org-mode-map "\C-m" 'org-return)
19845 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19846 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19847 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19848 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19849 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19850 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19851 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19852 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19853 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19854 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19855 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19856 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19857 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19858 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19859 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19860 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19861 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19862 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19863 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19864 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19865 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19866 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19867 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19868 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19869 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19871 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19872 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19873 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19875 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19876 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19877 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19878 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19879 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19880 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19881 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19882 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19883 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19884 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19885 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19886 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19887 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19888 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19889 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19890 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19891 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19892 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19893 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19894 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19895 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19896 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19897 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19899 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19900 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19901 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19902 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19903 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19905 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19907 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19909 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19910 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19912 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19915 (when (featurep 'xemacs)
19916 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19919 (defconst org-speed-commands-default
19921 ("Outline Navigation")
19922 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19923 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19924 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19925 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19926 ("F" . org-next-block)
19927 ("B" . org-previous-block)
19928 ("u" . (org-speed-move-safe 'outline-up-heading))
19929 ("j" . org-goto)
19930 ("g" . (org-refile t))
19931 ("Outline Visibility")
19932 ("c" . org-cycle)
19933 ("C" . org-shifttab)
19934 (" " . org-display-outline-path)
19935 ("s" . org-narrow-to-subtree)
19936 ("=" . org-columns)
19937 ("Outline Structure Editing")
19938 ("U" . org-metaup)
19939 ("D" . org-metadown)
19940 ("r" . org-metaright)
19941 ("l" . org-metaleft)
19942 ("R" . org-shiftmetaright)
19943 ("L" . org-shiftmetaleft)
19944 ("i" . (progn (forward-char 1) (call-interactively
19945 'org-insert-heading-respect-content)))
19946 ("^" . org-sort)
19947 ("w" . org-refile)
19948 ("a" . org-archive-subtree-default-with-confirmation)
19949 ("@" . org-mark-subtree)
19950 ("#" . org-toggle-comment)
19951 ("Clock Commands")
19952 ("I" . org-clock-in)
19953 ("O" . org-clock-out)
19954 ("Meta Data Editing")
19955 ("t" . org-todo)
19956 ("," . (org-priority))
19957 ("0" . (org-priority ?\ ))
19958 ("1" . (org-priority ?A))
19959 ("2" . (org-priority ?B))
19960 ("3" . (org-priority ?C))
19961 (":" . org-set-tags-command)
19962 ("e" . org-set-effort)
19963 ("E" . org-inc-effort)
19964 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19965 (org-entry-put (point) "APPT_WARNTIME" m)))
19966 ("Agenda Views etc")
19967 ("v" . org-agenda)
19968 ("/" . org-sparse-tree)
19969 ("Misc")
19970 ("o" . org-open-at-point)
19971 ("?" . org-speed-command-help)
19972 ("<" . (org-agenda-set-restriction-lock 'subtree))
19973 (">" . (org-agenda-remove-restriction-lock))
19975 "The default speed commands.")
19977 (defun org-print-speed-command (e)
19978 (if (> (length (car e)) 1)
19979 (progn
19980 (princ "\n")
19981 (princ (car e))
19982 (princ "\n")
19983 (princ (make-string (length (car e)) ?-))
19984 (princ "\n"))
19985 (princ (car e))
19986 (princ " ")
19987 (if (symbolp (cdr e))
19988 (princ (symbol-name (cdr e)))
19989 (prin1 (cdr e)))
19990 (princ "\n")))
19992 (defun org-speed-command-help ()
19993 "Show the available speed commands."
19994 (interactive)
19995 (if (not org-use-speed-commands)
19996 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19997 (with-output-to-temp-buffer "*Help*"
19998 (princ "User-defined Speed commands\n===========================\n")
19999 (mapc 'org-print-speed-command org-speed-commands-user)
20000 (princ "\n")
20001 (princ "Built-in Speed commands\n=======================\n")
20002 (mapc 'org-print-speed-command org-speed-commands-default))
20003 (with-current-buffer "*Help*"
20004 (setq truncate-lines t))))
20006 (defun org-speed-move-safe (cmd)
20007 "Execute CMD, but make sure that the cursor always ends up in a headline.
20008 If not, return to the original position and throw an error."
20009 (interactive)
20010 (let ((pos (point)))
20011 (call-interactively cmd)
20012 (unless (and (bolp) (org-at-heading-p))
20013 (goto-char pos)
20014 (error "Boundary reached while executing %s" cmd))))
20016 (defvar org-self-insert-command-undo-counter 0)
20018 (defvar org-table-auto-blank-field) ; defined in org-table.el
20019 (defvar org-speed-command nil)
20021 (define-obsolete-function-alias
20022 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20024 (defun org-speed-command-activate (keys)
20025 "Hook for activating single-letter speed commands.
20026 `org-speed-commands-default' specifies a minimal command set.
20027 Use `org-speed-commands-user' for further customization."
20028 (when (or (and (bolp) (looking-at org-outline-regexp))
20029 (and (functionp org-use-speed-commands)
20030 (funcall org-use-speed-commands)))
20031 (cdr (assoc keys (append org-speed-commands-user
20032 org-speed-commands-default)))))
20034 (define-obsolete-function-alias
20035 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20037 (defun org-babel-speed-command-activate (keys)
20038 "Hook for activating single-letter code block commands."
20039 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20040 (cdr (assoc keys org-babel-key-bindings))))
20042 (defcustom org-speed-command-hook
20043 '(org-speed-command-default-hook org-babel-speed-command-hook)
20044 "Hook for activating speed commands at strategic locations.
20045 Hook functions are called in sequence until a valid handler is
20046 found.
20048 Each hook takes a single argument, a user-pressed command key
20049 which is also a `self-insert-command' from the global map.
20051 Within the hook, examine the cursor position and the command key
20052 and return nil or a valid handler as appropriate. Handler could
20053 be one of an interactive command, a function, or a form.
20055 Set `org-use-speed-commands' to non-nil value to enable this
20056 hook. The default setting is `org-speed-command-activate'."
20057 :group 'org-structure
20058 :version "24.1"
20059 :type 'hook)
20061 (defun org-self-insert-command (N)
20062 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20063 If the cursor is in a table looking at whitespace, the whitespace is
20064 overwritten, and the table is not marked as requiring realignment."
20065 (interactive "p")
20066 (org-check-before-invisible-edit 'insert)
20067 (cond
20068 ((and org-use-speed-commands
20069 (let ((kv (this-command-keys-vector)))
20070 (setq org-speed-command
20071 (run-hook-with-args-until-success
20072 'org-speed-command-hook
20073 (make-string 1 (aref kv (1- (length kv))))))))
20074 (cond
20075 ((commandp org-speed-command)
20076 (setq this-command org-speed-command)
20077 (call-interactively org-speed-command))
20078 ((functionp org-speed-command)
20079 (funcall org-speed-command))
20080 ((and org-speed-command (listp org-speed-command))
20081 (eval org-speed-command))
20082 (t (let (org-use-speed-commands)
20083 (call-interactively 'org-self-insert-command)))))
20084 ((and
20085 (org-table-p)
20086 (progn
20087 ;; check if we blank the field, and if that triggers align
20088 (and (featurep 'org-table) org-table-auto-blank-field
20089 (memq last-command
20090 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20091 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20092 ;; got extra space, this field does not determine column width
20093 (let (org-table-may-need-update) (org-table-blank-field))
20094 ;; no extra space, this field may determine column width
20095 (org-table-blank-field)))
20097 (eq N 1)
20098 (looking-at "[^|\n]* |"))
20099 (let (org-table-may-need-update)
20100 (goto-char (1- (match-end 0)))
20101 (backward-delete-char 1)
20102 (goto-char (match-beginning 0))
20103 (self-insert-command N)))
20105 (setq org-table-may-need-update t)
20106 (self-insert-command N)
20107 (org-fix-tags-on-the-fly)
20108 (if org-self-insert-cluster-for-undo
20109 (if (not (eq last-command 'org-self-insert-command))
20110 (setq org-self-insert-command-undo-counter 1)
20111 (if (>= org-self-insert-command-undo-counter 20)
20112 (setq org-self-insert-command-undo-counter 1)
20113 (and (> org-self-insert-command-undo-counter 0)
20114 buffer-undo-list (listp buffer-undo-list)
20115 (not (cadr buffer-undo-list)) ; remove nil entry
20116 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20117 (setq org-self-insert-command-undo-counter
20118 (1+ org-self-insert-command-undo-counter))))))))
20120 (defun org-check-before-invisible-edit (kind)
20121 "Check is editing if kind KIND would be dangerous with invisible text around.
20122 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20123 ;; First, try to get out of here as quickly as possible, to reduce overhead
20124 (if (and org-catch-invisible-edits
20125 (or (not (boundp 'visible-mode)) (not visible-mode))
20126 (or (get-char-property (point) 'invisible)
20127 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20128 ;; OK, we need to take a closer look
20129 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20130 (invisible-before-point (if (bobp) nil (get-char-property
20131 (1- (point)) 'invisible)))
20132 (border-and-ok-direction
20134 ;; Check if we are acting predictably before invisible text
20135 (and invisible-at-point (not invisible-before-point)
20136 (memq kind '(insert delete-backward)))
20137 ;; Check if we are acting predictably after invisible text
20138 ;; This works not well, and I have turned it off. It seems
20139 ;; better to always show and stop after invisible text.
20140 ;; (and (not invisible-at-point) invisible-before-point
20141 ;; (memq kind '(insert delete)))
20143 (when (or (memq invisible-at-point '(outline org-hide-block t))
20144 (memq invisible-before-point '(outline org-hide-block t)))
20145 (if (eq org-catch-invisible-edits 'error)
20146 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20147 (if (and org-custom-properties-overlays
20148 (y-or-n-p "Display invisible properties in this buffer? "))
20149 (org-toggle-custom-properties-visibility)
20150 ;; Make the area visible
20151 (save-excursion
20152 (if invisible-before-point
20153 (goto-char (previous-single-char-property-change
20154 (point) 'invisible)))
20155 (show-subtree))
20156 (cond
20157 ((eq org-catch-invisible-edits 'show)
20158 ;; That's it, we do the edit after showing
20159 (message
20160 "Unfolding invisible region around point before editing")
20161 (sit-for 1))
20162 ((and (eq org-catch-invisible-edits 'smart)
20163 border-and-ok-direction)
20164 (message "Unfolding invisible region around point before editing"))
20166 ;; Don't do the edit, make the user repeat it in full visibility
20167 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20169 (defun org-fix-tags-on-the-fly ()
20170 (when (and (equal (char-after (point-at-bol)) ?*)
20171 (org-at-heading-p))
20172 (org-align-tags-here org-tags-column)))
20174 (defun org-delete-backward-char (N)
20175 "Like `delete-backward-char', insert whitespace at field end in tables.
20176 When deleting backwards, in tables this function will insert whitespace in
20177 front of the next \"|\" separator, to keep the table aligned. The table will
20178 still be marked for re-alignment if the field did fill the entire column,
20179 because, in this case the deletion might narrow the column."
20180 (interactive "p")
20181 (save-match-data
20182 (org-check-before-invisible-edit 'delete-backward)
20183 (if (and (org-table-p)
20184 (eq N 1)
20185 (string-match "|" (buffer-substring (point-at-bol) (point)))
20186 (looking-at ".*?|"))
20187 (let ((pos (point))
20188 (noalign (looking-at "[^|\n\r]* |"))
20189 (c org-table-may-need-update))
20190 (backward-delete-char N)
20191 (if (not overwrite-mode)
20192 (progn
20193 (skip-chars-forward "^|")
20194 (insert " ")
20195 (goto-char (1- pos))))
20196 ;; noalign: if there were two spaces at the end, this field
20197 ;; does not determine the width of the column.
20198 (if noalign (setq org-table-may-need-update c)))
20199 (backward-delete-char N)
20200 (org-fix-tags-on-the-fly))))
20202 (defun org-delete-char (N)
20203 "Like `delete-char', but insert whitespace at field end in tables.
20204 When deleting characters, in tables this function will insert whitespace in
20205 front of the next \"|\" separator, to keep the table aligned. The table will
20206 still be marked for re-alignment if the field did fill the entire column,
20207 because, in this case the deletion might narrow the column."
20208 (interactive "p")
20209 (save-match-data
20210 (org-check-before-invisible-edit 'delete)
20211 (if (and (org-table-p)
20212 (not (bolp))
20213 (not (= (char-after) ?|))
20214 (eq N 1))
20215 (if (looking-at ".*?|")
20216 (let ((pos (point))
20217 (noalign (looking-at "[^|\n\r]* |"))
20218 (c org-table-may-need-update))
20219 (replace-match
20220 (concat (substring (match-string 0) 1 -1) " |") nil t)
20221 (goto-char pos)
20222 ;; noalign: if there were two spaces at the end, this field
20223 ;; does not determine the width of the column.
20224 (if noalign (setq org-table-may-need-update c)))
20225 (delete-char N))
20226 (delete-char N)
20227 (org-fix-tags-on-the-fly))))
20229 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20230 (put 'org-self-insert-command 'delete-selection
20231 (lambda ()
20232 (not (run-hook-with-args-until-success
20233 'self-insert-uses-region-functions))))
20234 (put 'orgtbl-self-insert-command 'delete-selection
20235 (lambda ()
20236 (not (run-hook-with-args-until-success
20237 'self-insert-uses-region-functions))))
20238 (put 'org-delete-char 'delete-selection 'supersede)
20239 (put 'org-delete-backward-char 'delete-selection 'supersede)
20240 (put 'org-yank 'delete-selection 'yank)
20242 ;; Make `flyspell-mode' delay after some commands
20243 (put 'org-self-insert-command 'flyspell-delayed t)
20244 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20245 (put 'org-delete-char 'flyspell-delayed t)
20246 (put 'org-delete-backward-char 'flyspell-delayed t)
20248 ;; Make pabbrev-mode expand after org-mode commands
20249 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20250 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20252 (defun org-remap (map &rest commands)
20253 "In MAP, remap the functions given in COMMANDS.
20254 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20255 (let (new old)
20256 (while commands
20257 (setq old (pop commands) new (pop commands))
20258 (if (fboundp 'command-remapping)
20259 (org-defkey map (vector 'remap old) new)
20260 (substitute-key-definition old new map global-map)))))
20262 (defun org-transpose-words ()
20263 "Transpose words for Org.
20264 This uses the `org-mode-transpose-word-syntax-table' syntax
20265 table, which interprets characters in `org-emphasis-alist' as
20266 word constituents."
20267 (interactive)
20268 (with-syntax-table org-mode-transpose-word-syntax-table
20269 (call-interactively 'transpose-words)))
20270 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20272 (when (eq org-enable-table-editor 'optimized)
20273 ;; If the user wants maximum table support, we need to hijack
20274 ;; some standard editing functions
20275 (org-remap org-mode-map
20276 'self-insert-command 'org-self-insert-command
20277 'delete-char 'org-delete-char
20278 'delete-backward-char 'org-delete-backward-char)
20279 (org-defkey org-mode-map "|" 'org-force-self-insert))
20281 (defvar org-ctrl-c-ctrl-c-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 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20287 run after the last 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-ctrl-c-ctrl-c-final-hook nil
20295 "Hook for functions attaching themselves to `C-c C-c'.
20297 This can be used to add additional functionality to the C-c C-c
20298 key which executes context-dependent commands. This hook is run
20299 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20300 before the first test.
20302 Each function will be called with no arguments. The function
20303 must check if the context is appropriate for it to act. If yes,
20304 it should do its thing and then return a non-nil value. If the
20305 context is wrong, just do nothing and return nil.")
20307 (defvar org-tab-first-hook nil
20308 "Hook for functions to attach themselves to TAB.
20309 See `org-ctrl-c-ctrl-c-hook' for more information.
20310 This hook runs as the first action when TAB is pressed, even before
20311 `org-cycle' messes around with the `outline-regexp' to cater for
20312 inline tasks and plain list item folding.
20313 If any function in this hook returns t, any other actions that
20314 would have been caused by TAB (such as table field motion or visibility
20315 cycling) will not occur.")
20317 (defvar org-tab-after-check-for-table-hook nil
20318 "Hook for functions to attach themselves to TAB.
20319 See `org-ctrl-c-ctrl-c-hook' for more information.
20320 This hook runs after it has been established that the cursor is not in a
20321 table, but before checking if the cursor is in a headline or if global cycling
20322 should be done.
20323 If any function in this hook returns t, not other actions like visibility
20324 cycling will be done.")
20326 (defvar org-tab-after-check-for-cycling-hook nil
20327 "Hook for functions to attach themselves to TAB.
20328 See `org-ctrl-c-ctrl-c-hook' for more information.
20329 This hook runs after it has been established that not table field motion and
20330 not visibility should be done because of current context. This is probably
20331 the place where a package like yasnippets can hook in.")
20333 (defvar org-tab-before-tab-emulation-hook nil
20334 "Hook for functions to attach themselves to TAB.
20335 See `org-ctrl-c-ctrl-c-hook' for more information.
20336 This hook runs after every other options for TAB have been exhausted, but
20337 before indentation and \t insertion takes place.")
20339 (defvar org-metaleft-hook nil
20340 "Hook for functions attaching themselves to `M-left'.
20341 See `org-ctrl-c-ctrl-c-hook' for more information.")
20342 (defvar org-metaright-hook nil
20343 "Hook for functions attaching themselves to `M-right'.
20344 See `org-ctrl-c-ctrl-c-hook' for more information.")
20345 (defvar org-metaup-hook nil
20346 "Hook for functions attaching themselves to `M-up'.
20347 See `org-ctrl-c-ctrl-c-hook' for more information.")
20348 (defvar org-metadown-hook nil
20349 "Hook for functions attaching themselves to `M-down'.
20350 See `org-ctrl-c-ctrl-c-hook' for more information.")
20351 (defvar org-shiftmetaleft-hook nil
20352 "Hook for functions attaching themselves to `M-S-left'.
20353 See `org-ctrl-c-ctrl-c-hook' for more information.")
20354 (defvar org-shiftmetaright-hook nil
20355 "Hook for functions attaching themselves to `M-S-right'.
20356 See `org-ctrl-c-ctrl-c-hook' for more information.")
20357 (defvar org-shiftmetaup-hook nil
20358 "Hook for functions attaching themselves to `M-S-up'.
20359 See `org-ctrl-c-ctrl-c-hook' for more information.")
20360 (defvar org-shiftmetadown-hook nil
20361 "Hook for functions attaching themselves to `M-S-down'.
20362 See `org-ctrl-c-ctrl-c-hook' for more information.")
20363 (defvar org-metareturn-hook nil
20364 "Hook for functions attaching themselves to `M-RET'.
20365 See `org-ctrl-c-ctrl-c-hook' for more information.")
20366 (defvar org-shiftup-hook nil
20367 "Hook for functions attaching themselves to `S-up'.
20368 See `org-ctrl-c-ctrl-c-hook' for more information.")
20369 (defvar org-shiftup-final-hook nil
20370 "Hook for functions attaching themselves to `S-up'.
20371 This one runs after all other options except shift-select have been excluded.
20372 See `org-ctrl-c-ctrl-c-hook' for more information.")
20373 (defvar org-shiftdown-hook nil
20374 "Hook for functions attaching themselves to `S-down'.
20375 See `org-ctrl-c-ctrl-c-hook' for more information.")
20376 (defvar org-shiftdown-final-hook nil
20377 "Hook for functions attaching themselves to `S-down'.
20378 This one runs after all other options except shift-select have been excluded.
20379 See `org-ctrl-c-ctrl-c-hook' for more information.")
20380 (defvar org-shiftleft-hook nil
20381 "Hook for functions attaching themselves to `S-left'.
20382 See `org-ctrl-c-ctrl-c-hook' for more information.")
20383 (defvar org-shiftleft-final-hook nil
20384 "Hook for functions attaching themselves to `S-left'.
20385 This one runs after all other options except shift-select have been excluded.
20386 See `org-ctrl-c-ctrl-c-hook' for more information.")
20387 (defvar org-shiftright-hook nil
20388 "Hook for functions attaching themselves to `S-right'.
20389 See `org-ctrl-c-ctrl-c-hook' for more information.")
20390 (defvar org-shiftright-final-hook nil
20391 "Hook for functions attaching themselves to `S-right'.
20392 This one runs after all other options except shift-select have been excluded.
20393 See `org-ctrl-c-ctrl-c-hook' for more information.")
20395 (defun org-modifier-cursor-error ()
20396 "Throw an error, a modified cursor command was applied in wrong context."
20397 (user-error "This command is active in special context like tables, headlines or items"))
20399 (defun org-shiftselect-error ()
20400 "Throw an error because Shift-Cursor command was applied in wrong context."
20401 (if (and (boundp 'shift-select-mode) shift-select-mode)
20402 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20403 (user-error "This command works only in special context like headlines or timestamps")))
20405 (defun org-call-for-shift-select (cmd)
20406 (let ((this-command-keys-shift-translated t))
20407 (call-interactively cmd)))
20409 (defun org-shifttab (&optional arg)
20410 "Global visibility cycling or move to previous table field.
20411 Call `org-table-previous-field' within a table.
20412 When ARG is nil, cycle globally through visibility states.
20413 When ARG is a numeric prefix, show contents of this level."
20414 (interactive "P")
20415 (cond
20416 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20417 ((integerp arg)
20418 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20419 (message "Content view to level: %d" arg)
20420 (org-content (prefix-numeric-value arg2))
20421 (org-cycle-show-empty-lines t)
20422 (setq org-cycle-global-status 'overview)))
20423 (t (call-interactively 'org-global-cycle))))
20425 (defun org-shiftmetaleft ()
20426 "Promote subtree or delete table column.
20427 Calls `org-promote-subtree', `org-outdent-item-tree', or
20428 `org-table-delete-column', depending on context. See the
20429 individual commands for more information."
20430 (interactive)
20431 (cond
20432 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20433 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20434 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20435 ((if (not (org-region-active-p)) (org-at-item-p)
20436 (save-excursion (goto-char (region-beginning))
20437 (org-at-item-p)))
20438 (call-interactively 'org-outdent-item-tree))
20439 (t (org-modifier-cursor-error))))
20441 (defun org-shiftmetaright ()
20442 "Demote subtree or insert table column.
20443 Calls `org-demote-subtree', `org-indent-item-tree', or
20444 `org-table-insert-column', depending on context. See the
20445 individual commands for more information."
20446 (interactive)
20447 (cond
20448 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20449 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20450 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20451 ((if (not (org-region-active-p)) (org-at-item-p)
20452 (save-excursion (goto-char (region-beginning))
20453 (org-at-item-p)))
20454 (call-interactively 'org-indent-item-tree))
20455 (t (org-modifier-cursor-error))))
20457 (defun org-shiftmetaup (&optional arg)
20458 "Drag the line at point up.
20459 In a table, kill the current row.
20460 On a clock timestamp, update the value of the timestamp like `S-<up>'
20461 but also adjust the previous clocked item in the clock history.
20462 Everywhere else, drag the line at point up."
20463 (interactive "P")
20464 (cond
20465 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20466 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20467 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20468 (call-interactively 'org-timestamp-up)))
20469 (t (call-interactively 'org-drag-line-backward))))
20471 (defun org-shiftmetadown (&optional arg)
20472 "Drag the line at point down.
20473 In a table, insert an empty row at the current line.
20474 On a clock timestamp, update the value of the timestamp like `S-<down>'
20475 but also adjust the previous clocked item in the clock history.
20476 Everywhere else, drag the line at point down."
20477 (interactive "P")
20478 (cond
20479 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20480 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20481 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20482 (call-interactively 'org-timestamp-down)))
20483 (t (call-interactively 'org-drag-line-forward))))
20485 (defsubst org-hidden-tree-error ()
20486 (user-error
20487 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20489 (defun org-metaleft (&optional arg)
20490 "Promote heading or move table column to left.
20491 Calls `org-do-promote' or `org-table-move-column', depending on context.
20492 With no specific context, calls the Emacs default `backward-word'.
20493 See the individual commands for more information."
20494 (interactive "P")
20495 (cond
20496 ((run-hook-with-args-until-success 'org-metaleft-hook))
20497 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20498 ((org-with-limited-levels
20499 (or (org-at-heading-p)
20500 (and (org-region-active-p)
20501 (save-excursion
20502 (goto-char (region-beginning))
20503 (org-at-heading-p)))))
20504 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20505 (call-interactively 'org-do-promote))
20506 ;; At an inline task.
20507 ((org-at-heading-p)
20508 (call-interactively 'org-inlinetask-promote))
20509 ((or (org-at-item-p)
20510 (and (org-region-active-p)
20511 (save-excursion
20512 (goto-char (region-beginning))
20513 (org-at-item-p))))
20514 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20515 (call-interactively 'org-outdent-item))
20516 (t (call-interactively 'backward-word))))
20518 (defun org-metaright (&optional arg)
20519 "Demote a subtree, a list item or move table column to right.
20520 In front of a drawer or a block keyword, indent it correctly.
20521 With no specific context, calls the Emacs default `forward-word'.
20522 See the individual commands for more information."
20523 (interactive "P")
20524 (cond
20525 ((run-hook-with-args-until-success 'org-metaright-hook))
20526 ((org-at-table-p) (call-interactively 'org-table-move-column))
20527 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20528 ((org-at-block-p) (call-interactively 'org-indent-block))
20529 ((org-with-limited-levels
20530 (or (org-at-heading-p)
20531 (and (org-region-active-p)
20532 (save-excursion
20533 (goto-char (region-beginning))
20534 (org-at-heading-p)))))
20535 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20536 (call-interactively 'org-do-demote))
20537 ;; At an inline task.
20538 ((org-at-heading-p)
20539 (call-interactively 'org-inlinetask-demote))
20540 ((or (org-at-item-p)
20541 (and (org-region-active-p)
20542 (save-excursion
20543 (goto-char (region-beginning))
20544 (org-at-item-p))))
20545 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20546 (call-interactively 'org-indent-item))
20547 (t (call-interactively 'forward-word))))
20549 (defun org-check-for-hidden (what)
20550 "Check if there are hidden headlines/items in the current visual line.
20551 WHAT can be either `headlines' or `items'. If the current line is
20552 an outline or item heading and it has a folded subtree below it,
20553 this function returns t, nil otherwise."
20554 (let ((re (cond
20555 ((eq what 'headlines) org-outline-regexp-bol)
20556 ((eq what 'items) (org-item-beginning-re))
20557 (t (error "This should not happen"))))
20558 beg end)
20559 (save-excursion
20560 (catch 'exit
20561 (unless (org-region-active-p)
20562 (setq beg (point-at-bol))
20563 (beginning-of-line 2)
20564 (while (and (not (eobp)) ;; this is like `next-line'
20565 (get-char-property (1- (point)) 'invisible))
20566 (beginning-of-line 2))
20567 (setq end (point))
20568 (goto-char beg)
20569 (goto-char (point-at-eol))
20570 (setq end (max end (point)))
20571 (while (re-search-forward re end t)
20572 (if (get-char-property (match-beginning 0) 'invisible)
20573 (throw 'exit t))))
20574 nil))))
20576 (defun org-metaup (&optional arg)
20577 "Move subtree up or move table row up.
20578 Calls `org-move-subtree-up' or `org-table-move-row' or
20579 `org-move-item-up', depending on context. See the individual commands
20580 for more information."
20581 (interactive "P")
20582 (cond
20583 ((run-hook-with-args-until-success 'org-metaup-hook))
20584 ((org-region-active-p)
20585 (let* ((a (min (region-beginning) (region-end)))
20586 (b (1- (max (region-beginning) (region-end))))
20587 (c (save-excursion (goto-char a)
20588 (move-beginning-of-line 0)))
20589 (d (save-excursion (goto-char a)
20590 (move-end-of-line 0) (point))))
20591 (transpose-regions a b c d)
20592 (goto-char c)))
20593 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20594 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20595 ((org-at-item-p) (call-interactively 'org-move-item-up))
20596 (t (org-drag-element-backward))))
20598 (defun org-metadown (&optional arg)
20599 "Move subtree down or move table row down.
20600 Calls `org-move-subtree-down' or `org-table-move-row' or
20601 `org-move-item-down', depending on context. See the individual
20602 commands for more information."
20603 (interactive "P")
20604 (cond
20605 ((run-hook-with-args-until-success 'org-metadown-hook))
20606 ((org-region-active-p)
20607 (let* ((a (min (region-beginning) (region-end)))
20608 (b (max (region-beginning) (region-end)))
20609 (c (save-excursion (goto-char b)
20610 (move-beginning-of-line 1)))
20611 (d (save-excursion (goto-char b)
20612 (move-end-of-line 1) (1+ (point)))))
20613 (transpose-regions a b c d)
20614 (goto-char d)))
20615 ((org-at-table-p) (call-interactively 'org-table-move-row))
20616 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20617 ((org-at-item-p) (call-interactively 'org-move-item-down))
20618 (t (org-drag-element-forward))))
20620 (defun org-shiftup (&optional arg)
20621 "Increase item in timestamp or increase priority of current headline.
20622 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20623 depending on context. See the individual commands for more information."
20624 (interactive "P")
20625 (cond
20626 ((run-hook-with-args-until-success 'org-shiftup-hook))
20627 ((and org-support-shift-select (org-region-active-p))
20628 (org-call-for-shift-select 'previous-line))
20629 ((org-at-timestamp-p t)
20630 (call-interactively (if org-edit-timestamp-down-means-later
20631 'org-timestamp-down 'org-timestamp-up)))
20632 ((and (not (eq org-support-shift-select 'always))
20633 org-enable-priority-commands
20634 (org-at-heading-p))
20635 (call-interactively 'org-priority-up))
20636 ((and (not org-support-shift-select) (org-at-item-p))
20637 (call-interactively 'org-previous-item))
20638 ((org-clocktable-try-shift 'up arg))
20639 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20640 (org-support-shift-select
20641 (org-call-for-shift-select 'previous-line))
20642 (t (org-shiftselect-error))))
20644 (defun org-shiftdown (&optional arg)
20645 "Decrease item in timestamp or decrease priority of current headline.
20646 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20647 depending on context. See the individual commands for more information."
20648 (interactive "P")
20649 (cond
20650 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20651 ((and org-support-shift-select (org-region-active-p))
20652 (org-call-for-shift-select 'next-line))
20653 ((org-at-timestamp-p t)
20654 (call-interactively (if org-edit-timestamp-down-means-later
20655 'org-timestamp-up 'org-timestamp-down)))
20656 ((and (not (eq org-support-shift-select 'always))
20657 org-enable-priority-commands
20658 (org-at-heading-p))
20659 (call-interactively 'org-priority-down))
20660 ((and (not org-support-shift-select) (org-at-item-p))
20661 (call-interactively 'org-next-item))
20662 ((org-clocktable-try-shift 'down arg))
20663 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20664 (org-support-shift-select
20665 (org-call-for-shift-select 'next-line))
20666 (t (org-shiftselect-error))))
20668 (defun org-shiftright (&optional arg)
20669 "Cycle the thing at point or in the current line, depending on context.
20670 Depending on context, this does one of the following:
20672 - switch a timestamp at point one day into the future
20673 - on a headline, switch to the next TODO keyword.
20674 - on an item, switch entire list to the next bullet type
20675 - on a property line, switch to the next allowed value
20676 - on a clocktable definition line, move time block into the future"
20677 (interactive "P")
20678 (cond
20679 ((run-hook-with-args-until-success 'org-shiftright-hook))
20680 ((and org-support-shift-select (org-region-active-p))
20681 (org-call-for-shift-select 'forward-char))
20682 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20683 ((and (not (eq org-support-shift-select 'always))
20684 (org-at-heading-p))
20685 (let ((org-inhibit-logging
20686 (not org-treat-S-cursor-todo-selection-as-state-change))
20687 (org-inhibit-blocking
20688 (not org-treat-S-cursor-todo-selection-as-state-change)))
20689 (org-call-with-arg 'org-todo 'right)))
20690 ((or (and org-support-shift-select
20691 (not (eq org-support-shift-select 'always))
20692 (org-at-item-bullet-p))
20693 (and (not org-support-shift-select) (org-at-item-p)))
20694 (org-call-with-arg 'org-cycle-list-bullet nil))
20695 ((and (not (eq org-support-shift-select 'always))
20696 (org-at-property-p))
20697 (call-interactively 'org-property-next-allowed-value))
20698 ((org-clocktable-try-shift 'right arg))
20699 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20700 (org-support-shift-select
20701 (org-call-for-shift-select 'forward-char))
20702 (t (org-shiftselect-error))))
20704 (defun org-shiftleft (&optional arg)
20705 "Cycle the thing at point or in the current line, depending on context.
20706 Depending on context, this does one of the following:
20708 - switch a timestamp at point one day into the past
20709 - on a headline, switch to the previous TODO keyword.
20710 - on an item, switch entire list to the previous bullet type
20711 - on a property line, switch to the previous allowed value
20712 - on a clocktable definition line, move time block into the past"
20713 (interactive "P")
20714 (cond
20715 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20716 ((and org-support-shift-select (org-region-active-p))
20717 (org-call-for-shift-select 'backward-char))
20718 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20719 ((and (not (eq org-support-shift-select 'always))
20720 (org-at-heading-p))
20721 (let ((org-inhibit-logging
20722 (not org-treat-S-cursor-todo-selection-as-state-change))
20723 (org-inhibit-blocking
20724 (not org-treat-S-cursor-todo-selection-as-state-change)))
20725 (org-call-with-arg 'org-todo 'left)))
20726 ((or (and org-support-shift-select
20727 (not (eq org-support-shift-select 'always))
20728 (org-at-item-bullet-p))
20729 (and (not org-support-shift-select) (org-at-item-p)))
20730 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20731 ((and (not (eq org-support-shift-select 'always))
20732 (org-at-property-p))
20733 (call-interactively 'org-property-previous-allowed-value))
20734 ((org-clocktable-try-shift 'left arg))
20735 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20736 (org-support-shift-select
20737 (org-call-for-shift-select 'backward-char))
20738 (t (org-shiftselect-error))))
20740 (defun org-shiftcontrolright ()
20741 "Switch to next TODO set."
20742 (interactive)
20743 (cond
20744 ((and org-support-shift-select (org-region-active-p))
20745 (org-call-for-shift-select 'forward-word))
20746 ((and (not (eq org-support-shift-select 'always))
20747 (org-at-heading-p))
20748 (org-call-with-arg 'org-todo 'nextset))
20749 (org-support-shift-select
20750 (org-call-for-shift-select 'forward-word))
20751 (t (org-shiftselect-error))))
20753 (defun org-shiftcontrolleft ()
20754 "Switch to previous TODO set."
20755 (interactive)
20756 (cond
20757 ((and org-support-shift-select (org-region-active-p))
20758 (org-call-for-shift-select 'backward-word))
20759 ((and (not (eq org-support-shift-select 'always))
20760 (org-at-heading-p))
20761 (org-call-with-arg 'org-todo 'previousset))
20762 (org-support-shift-select
20763 (org-call-for-shift-select 'backward-word))
20764 (t (org-shiftselect-error))))
20766 (defun org-shiftcontrolup (&optional n)
20767 "Change timestamps synchronously up in CLOCK log lines.
20768 Optional argument N tells to change by that many units."
20769 (interactive "P")
20770 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20771 (let (org-support-shift-select)
20772 (org-clock-timestamps-up n))
20773 (user-error "Not at a clock log")))
20775 (defun org-shiftcontroldown (&optional n)
20776 "Change timestamps synchronously down in CLOCK log lines.
20777 Optional argument N tells to change by that many units."
20778 (interactive "P")
20779 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20780 (let (org-support-shift-select)
20781 (org-clock-timestamps-down n))
20782 (user-error "Not at a clock log")))
20784 (defun org-increase-number-at-point (&optional inc)
20785 "Increment the number at point.
20786 With an optional prefix numeric argument INC, increment using
20787 this numeric value."
20788 (interactive "p")
20789 (if (not (number-at-point))
20790 (user-error "Not on a number")
20791 (unless inc (setq inc 1))
20792 (let ((pos (point))
20793 (beg (skip-chars-backward "-+^/*0-9eE."))
20794 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20795 (setq nap (buffer-substring-no-properties
20796 (+ pos beg) (+ pos beg end)))
20797 (delete-region (+ pos beg) (+ pos beg end))
20798 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20799 (when (org-at-table-p)
20800 (org-table-align)
20801 (org-table-end-of-field 1))))
20803 (defun org-decrease-number-at-point (&optional inc)
20804 "Decrement the number at point.
20805 With an optional prefix numeric argument INC, decrement using
20806 this numeric value."
20807 (interactive "p")
20808 (org-increase-number-at-point (- inc)))
20810 (defun org-ctrl-c-ret ()
20811 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20812 (interactive)
20813 (cond
20814 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20815 (t (call-interactively 'org-insert-heading))))
20817 (defun org-find-visible ()
20818 (let ((s (point)))
20819 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20820 (get-char-property s 'invisible)))
20822 (defun org-find-invisible ()
20823 (let ((s (point)))
20824 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20825 (not (get-char-property s 'invisible))))
20828 (defun org-copy-visible (beg end)
20829 "Copy the visible parts of the region."
20830 (interactive "r")
20831 (let (snippets s)
20832 (save-excursion
20833 (save-restriction
20834 (narrow-to-region beg end)
20835 (setq s (goto-char (point-min)))
20836 (while (not (= (point) (point-max)))
20837 (goto-char (org-find-invisible))
20838 (push (buffer-substring s (point)) snippets)
20839 (setq s (goto-char (org-find-visible))))))
20840 (kill-new (apply 'concat (nreverse snippets)))))
20842 (defun org-copy-special ()
20843 "Copy region in table or copy current subtree.
20844 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20845 See the individual commands for more information."
20846 (interactive)
20847 (call-interactively
20848 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20850 (defun org-cut-special ()
20851 "Cut region in table or cut current subtree.
20852 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20853 See the individual commands for more information."
20854 (interactive)
20855 (call-interactively
20856 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20858 (defun org-paste-special (arg)
20859 "Paste rectangular region into table, or past subtree relative to level.
20860 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20861 See the individual commands for more information."
20862 (interactive "P")
20863 (if (org-at-table-p)
20864 (org-table-paste-rectangle)
20865 (org-paste-subtree arg)))
20867 (defsubst org-in-fixed-width-region-p ()
20868 "Is point in a fixed-width region?"
20869 (save-match-data
20870 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20872 (defun org-edit-special (&optional arg)
20873 "Call a special editor for the element at point.
20874 When at a table, call the formula editor with `org-table-edit-formulas'.
20875 When in a source code block, call `org-edit-src-code'.
20876 When in a fixed-width region, call `org-edit-fixed-width-region'.
20877 When in an export block, call `org-edit-export-block'.
20878 When at an #+INCLUDE keyword, visit the included file.
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 src-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,
20924 ;; which is an object. Thus, scan deeper.
20925 (if (eq (org-element-type (org-element-context element)) 'link)
20926 (call-interactively 'ffap)
20927 (user-error "No special environment to edit here"))))))
20929 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20930 (defun org-ctrl-c-ctrl-c (&optional arg)
20931 "Set tags in headline, or update according to changed information at point.
20933 This command does many different things, depending on context:
20935 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20936 this is what we do.
20938 - If the cursor is on a statistics cookie, update it.
20940 - If the cursor is in a headline, prompt for tags and insert them
20941 into the current line, aligned to `org-tags-column'. When called
20942 with prefix arg, realign all tags in the current buffer.
20944 - If the cursor is in one of the special #+KEYWORD lines, this
20945 triggers scanning the buffer for these lines and updating the
20946 information.
20948 - If the cursor is inside a table, realign the table. This command
20949 works even if the automatic table editor has been turned off.
20951 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20952 the entire table.
20954 - If the cursor is at a footnote reference or definition, jump to
20955 the corresponding definition or references, respectively.
20957 - If the cursor is a the beginning of a dynamic block, update it.
20959 - If the current buffer is a capture buffer, close note and file it.
20961 - If the cursor is on a <<<target>>>, update radio targets and
20962 corresponding links in this buffer.
20964 - If the cursor is on a numbered item in a plain list, renumber the
20965 ordered list.
20967 - If the cursor is on a checkbox, toggle it.
20969 - If the cursor is on a code block, evaluate it. The variable
20970 `org-confirm-babel-evaluate' can be used to control prompting
20971 before code block evaluation, by default every code block
20972 evaluation requires confirmation. Code block evaluation can be
20973 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20974 (interactive "P")
20975 (cond
20976 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20977 org-occur-highlights)
20978 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20979 (org-remove-occur-highlights)
20980 (message "Temporary highlights/overlays removed from current buffer"))
20981 ((and (local-variable-p 'org-finish-function (current-buffer))
20982 (fboundp org-finish-function))
20983 (funcall org-finish-function))
20984 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20986 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20987 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20988 (user-error "C-c C-c can do nothing useful at this location"))
20989 (let* ((context (org-element-context))
20990 (type (org-element-type context)))
20991 (case type
20992 ;; When at a link, act according to the parent instead.
20993 (link (setq context (org-element-property :parent context))
20994 (setq type (org-element-type context)))
20995 ;; Unsupported object types: refer to the first supported
20996 ;; element or object containing it.
20997 ((bold code entity export-snippet inline-babel-call inline-src-block
20998 italic latex-fragment line-break macro strike-through subscript
20999 superscript underline verbatim)
21000 (setq context
21001 (org-element-lineage
21002 context '(radio-target paragraph verse-block table-cell)))))
21003 ;; For convenience: at the first line of a paragraph on the
21004 ;; same line as an item, apply function on that item instead.
21005 (when (eq type 'paragraph)
21006 (let ((parent (org-element-property :parent context)))
21007 (when (and (eq (org-element-type parent) 'item)
21008 (= (line-beginning-position)
21009 (org-element-property :begin parent)))
21010 (setq context parent type 'item))))
21011 ;; Act according to type of element or object at point.
21012 (case type
21013 (clock (org-clock-update-time-maybe))
21014 (dynamic-block
21015 (save-excursion
21016 (goto-char (org-element-property :post-affiliated context))
21017 (org-update-dblock)))
21018 (footnote-definition
21019 (goto-char (org-element-property :post-affiliated context))
21020 (call-interactively 'org-footnote-action))
21021 (footnote-reference (call-interactively 'org-footnote-action))
21022 ((headline inlinetask)
21023 (save-excursion (goto-char (org-element-property :begin context))
21024 (call-interactively 'org-set-tags)))
21025 (item
21026 ;; At an item: a double C-u set checkbox to "[-]"
21027 ;; unconditionally, whereas a single one will toggle its
21028 ;; presence. Without an universal argument, if the item
21029 ;; has a checkbox, toggle it. Otherwise repair the list.
21030 (let* ((box (org-element-property :checkbox context))
21031 (struct (org-element-property :structure context))
21032 (old-struct (copy-tree struct))
21033 (parents (org-list-parents-alist struct))
21034 (prevs (org-list-prevs-alist struct))
21035 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21036 (org-list-set-checkbox
21037 (org-element-property :begin context) struct
21038 (cond ((equal arg '(16)) "[-]")
21039 ((and (not box) (equal arg '(4))) "[ ]")
21040 ((or (not box) (equal arg '(4))) nil)
21041 ((eq box 'on) "[ ]")
21042 (t "[X]")))
21043 ;; Mimic `org-list-write-struct' but with grabbing
21044 ;; a return value from `org-list-struct-fix-box'.
21045 (org-list-struct-fix-ind struct parents 2)
21046 (org-list-struct-fix-item-end struct)
21047 (org-list-struct-fix-bul struct prevs)
21048 (org-list-struct-fix-ind struct parents)
21049 (let ((block-item
21050 (org-list-struct-fix-box struct parents prevs orderedp)))
21051 (if (and box (equal struct old-struct))
21052 (if (equal arg '(16))
21053 (message "Checkboxes already reset")
21054 (user-error "Cannot toggle this checkbox: %s"
21055 (if (eq box 'on)
21056 "all subitems checked"
21057 "unchecked subitems")))
21058 (org-list-struct-apply-struct struct old-struct)
21059 (org-update-checkbox-count-maybe))
21060 (when block-item
21061 (message "Checkboxes were removed due to empty box at line %d"
21062 (org-current-line block-item))))))
21063 (keyword
21064 (let ((org-inhibit-startup-visibility-stuff t)
21065 (org-startup-align-all-tables nil))
21066 (when (boundp 'org-table-coordinate-overlays)
21067 (mapc 'delete-overlay org-table-coordinate-overlays)
21068 (setq org-table-coordinate-overlays nil))
21069 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21070 (message "Local setup has been refreshed"))
21071 (plain-list
21072 ;; At a plain list, with a double C-u argument, set
21073 ;; checkboxes of each item to "[-]", whereas a single one
21074 ;; will toggle their presence according to the state of the
21075 ;; first item in the list. Without an argument, repair the
21076 ;; list.
21077 (let* ((begin (org-element-property :contents-begin context))
21078 (beginm (move-marker (make-marker) begin))
21079 (struct (org-element-property :structure context))
21080 (old-struct (copy-tree struct))
21081 (first-box (save-excursion
21082 (goto-char begin)
21083 (looking-at org-list-full-item-re)
21084 (match-string-no-properties 3)))
21085 (new-box (cond ((equal arg '(16)) "[-]")
21086 ((equal arg '(4)) (unless first-box "[ ]"))
21087 ((equal first-box "[X]") "[ ]")
21088 (t "[X]"))))
21089 (cond
21090 (arg
21091 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21092 (org-list-get-all-items
21093 begin struct (org-list-prevs-alist struct))))
21094 ((and first-box (eq (point) begin))
21095 ;; For convenience, when point is at bol on the first
21096 ;; item of the list and no argument is provided, simply
21097 ;; toggle checkbox of that item, if any.
21098 (org-list-set-checkbox begin struct new-box)))
21099 (org-list-write-struct
21100 struct (org-list-parents-alist struct) old-struct)
21101 (org-update-checkbox-count-maybe)
21102 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21103 ((property-drawer node-property)
21104 (call-interactively 'org-property-action))
21105 ((radio-target target)
21106 (call-interactively 'org-update-radio-target-regexp))
21107 (statistics-cookie
21108 (call-interactively 'org-update-statistics-cookies))
21109 ((table table-cell table-row)
21110 ;; At a table, recalculate every field and align it. Also
21111 ;; send the table if necessary. If the table has
21112 ;; a `table.el' type, just give up. At a table row or
21113 ;; cell, maybe recalculate line but always align table.
21114 (if (eq (org-element-property :type context) 'table.el)
21115 (message "Use C-c ' to edit table.el tables")
21116 (let ((org-enable-table-editor t))
21117 (if (or (eq type 'table)
21118 ;; Check if point is at a TBLFM line.
21119 (and (eq type 'table-row)
21120 (= (point) (org-element-property :end context))))
21121 (save-excursion
21122 (if (org-at-TBLFM-p)
21123 (progn (require 'org-table)
21124 (org-table-calc-current-TBLFM))
21125 (goto-char (org-element-property :contents-begin context))
21126 (org-call-with-arg 'org-table-recalculate (or arg t))
21127 (orgtbl-send-table 'maybe)))
21128 (org-table-maybe-eval-formula)
21129 (cond (arg (call-interactively 'org-table-recalculate))
21130 ((org-table-maybe-recalculate-line))
21131 (t (org-table-align)))))))
21132 (timestamp (org-timestamp-change 0 'day))
21133 (otherwise
21134 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21135 (user-error
21136 "C-c C-c can do nothing useful at this location")))))))))
21138 (defun org-mode-restart ()
21139 (interactive)
21140 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21141 (funcall major-mode)
21142 (hack-local-variables)
21143 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21144 (org-indent-mode -1)))
21145 (message "%s restarted" major-mode))
21147 (defun org-kill-note-or-show-branches ()
21148 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21149 (interactive)
21150 (if (not org-finish-function)
21151 (progn
21152 (hide-subtree)
21153 (call-interactively 'show-branches))
21154 (let ((org-note-abort t))
21155 (funcall org-finish-function))))
21157 (defun org-open-line (n)
21158 "Insert a new row in tables, call `open-line' elsewhere.
21159 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21160 (interactive "*p")
21161 (cond
21162 ((not org-special-ctrl-o)
21163 (open-line n))
21164 ((org-at-table-p)
21165 (org-table-insert-row))
21167 (open-line n))))
21169 (defun org-return (&optional indent)
21170 "Goto next table row or insert a newline.
21172 Calls `org-table-next-row' or `newline', depending on context.
21174 When optional INDENT argument is non-nil, call
21175 `newline-and-indent' instead of `newline'.
21177 When `org-return-follows-link' is non-nil and point is on
21178 a timestamp or a link, call `org-open-at-point'. However, it
21179 will not happen if point is in a table or on a \"dead\"
21180 object (e.g., within a comment). In these case, you need to use
21181 `org-open-at-point' directly."
21182 (interactive)
21183 (if (and (save-excursion
21184 (beginning-of-line)
21185 (looking-at org-todo-line-regexp))
21186 (match-beginning 3)
21187 (>= (point) (match-beginning 3)))
21188 ;; Point is on headline tags. Do not break them: add a newline
21189 ;; after the headline instead.
21190 (progn (org-show-entry)
21191 (end-of-line)
21192 (if indent (newline-and-indent) (newline)))
21193 (let* ((context (if org-return-follows-link (org-element-context)
21194 (org-element-at-point)))
21195 (type (org-element-type context)))
21196 (cond
21197 ;; In a table, call `org-table-next-row'.
21198 ((or (and (eq type 'table)
21199 (>= (point) (org-element-property :contents-begin context))
21200 (< (point) (org-element-property :contents-end context)))
21201 (org-element-lineage context '(table-row table-cell) t))
21202 (org-table-justify-field-maybe)
21203 (call-interactively #'org-table-next-row))
21204 ;; On a link or a timestamp but not on white spaces after it,
21205 ;; call `org-open-line' if `org-return-follows-link' allows it.
21206 ((and org-return-follows-link
21207 (memq type '(link timestamp))
21208 (< (point)
21209 (save-excursion (goto-char (org-element-property :end context))
21210 (skip-chars-backward " \t")
21211 (point))))
21212 (call-interactively #'org-open-at-point))
21213 ;; In a list, make sure indenting keeps trailing text within.
21214 ((and indent
21215 (not (eolp))
21216 (org-element-lineage context '(item)))
21217 (let ((trailing-data
21218 (delete-and-extract-region (point) (line-end-position))))
21219 (newline-and-indent)
21220 (save-excursion (insert trailing-data))))
21221 (t (if indent (newline-and-indent) (newline)))))))
21223 (defun org-return-indent ()
21224 "Goto next table row or insert a newline and indent.
21225 Calls `org-table-next-row' or `newline-and-indent', depending on
21226 context. See the individual commands for more information."
21227 (interactive)
21228 (org-return t))
21230 (defun org-ctrl-c-star ()
21231 "Compute table, or change heading status of lines.
21232 Calls `org-table-recalculate' or `org-toggle-heading',
21233 depending on context."
21234 (interactive)
21235 (cond
21236 ((org-at-table-p)
21237 (call-interactively 'org-table-recalculate))
21239 ;; Convert all lines in region to list items
21240 (call-interactively 'org-toggle-heading))))
21242 (defun org-ctrl-c-minus ()
21243 "Insert separator line in table or modify bullet status of line.
21244 Also turns a plain line or a region of lines into list items.
21245 Calls `org-table-insert-hline', `org-toggle-item', or
21246 `org-cycle-list-bullet', depending on context."
21247 (interactive)
21248 (cond
21249 ((org-at-table-p)
21250 (call-interactively 'org-table-insert-hline))
21251 ((org-region-active-p)
21252 (call-interactively 'org-toggle-item))
21253 ((org-in-item-p)
21254 (call-interactively 'org-cycle-list-bullet))
21256 (call-interactively 'org-toggle-item))))
21258 (defun org-toggle-item (arg)
21259 "Convert headings or normal lines to items, items to normal lines.
21260 If there is no active region, only the current line is considered.
21262 If the first non blank line in the region is a headline, convert
21263 all headlines to items, shifting text accordingly.
21265 If it is an item, convert all items to normal lines.
21267 If it is normal text, change region into a list of items.
21268 With a prefix argument ARG, change the region in a single item."
21269 (interactive "P")
21270 (let ((shift-text
21271 (function
21272 ;; Shift text in current section to IND, from point to END.
21273 ;; The function leaves point to END line.
21274 (lambda (ind end)
21275 (let ((min-i 1000) (end (copy-marker end)))
21276 ;; First determine the minimum indentation (MIN-I) of
21277 ;; the text.
21278 (save-excursion
21279 (catch 'exit
21280 (while (< (point) end)
21281 (let ((i (org-get-indentation)))
21282 (cond
21283 ;; Skip blank lines and inline tasks.
21284 ((looking-at "^[ \t]*$"))
21285 ((looking-at org-outline-regexp-bol))
21286 ;; We can't find less than 0 indentation.
21287 ((zerop i) (throw 'exit (setq min-i 0)))
21288 ((< i min-i) (setq min-i i))))
21289 (forward-line))))
21290 ;; Then indent each line so that a line indented to
21291 ;; MIN-I becomes indented to IND. Ignore blank lines
21292 ;; and inline tasks in the process.
21293 (let ((delta (- ind min-i)))
21294 (while (< (point) end)
21295 (unless (or (looking-at "^[ \t]*$")
21296 (looking-at org-outline-regexp-bol))
21297 (org-indent-line-to (+ (org-get-indentation) delta)))
21298 (forward-line)))))))
21299 (skip-blanks
21300 (function
21301 ;; Return beginning of first non-blank line, starting from
21302 ;; line at POS.
21303 (lambda (pos)
21304 (save-excursion
21305 (goto-char pos)
21306 (skip-chars-forward " \r\t\n")
21307 (point-at-bol)))))
21308 beg end)
21309 ;; Determine boundaries of changes.
21310 (if (org-region-active-p)
21311 (setq beg (funcall skip-blanks (region-beginning))
21312 end (copy-marker (region-end)))
21313 (setq beg (funcall skip-blanks (point-at-bol))
21314 end (copy-marker (point-at-eol))))
21315 ;; Depending on the starting line, choose an action on the text
21316 ;; between BEG and END.
21317 (org-with-limited-levels
21318 (save-excursion
21319 (goto-char beg)
21320 (cond
21321 ;; Case 1. Start at an item: de-itemize. Note that it only
21322 ;; happens when a region is active: `org-ctrl-c-minus'
21323 ;; would call `org-cycle-list-bullet' otherwise.
21324 ((org-at-item-p)
21325 (while (< (point) end)
21326 (when (org-at-item-p)
21327 (skip-chars-forward " \t")
21328 (delete-region (point) (match-end 0)))
21329 (forward-line)))
21330 ;; Case 2. Start at an heading: convert to items.
21331 ((org-at-heading-p)
21332 (let* ((bul (org-list-bullet-string "-"))
21333 (bul-len (length bul))
21334 (done (org-entry-is-done-p))
21335 (todo (org-entry-is-todo-p))
21336 ;; Indentation of the first heading. It should be
21337 ;; relative to the indentation of its parent, if any.
21338 (start-ind (save-excursion
21339 (cond
21340 ((not org-adapt-indentation) 0)
21341 ((not (outline-previous-heading)) 0)
21342 (t (length (match-string 0))))))
21343 ;; Level of first heading. Further headings will be
21344 ;; compared to it to determine hierarchy in the list.
21345 (ref-level (org-reduced-level (org-outline-level))))
21346 (when (or done todo) (org-todo ""))
21347 (while (< (point) end)
21348 (let* ((level (org-reduced-level (org-outline-level)))
21349 (delta (max 0 (- level ref-level))))
21350 ;; If current headline is less indented than the first
21351 ;; one, set it as reference, in order to preserve
21352 ;; subtrees.
21353 (when (< level ref-level) (setq ref-level level))
21354 (replace-match bul t t)
21355 (org-indent-line-to (+ start-ind (* delta bul-len)))
21356 (when (or done todo)
21357 (let* ((struct (org-list-struct))
21358 (old (copy-tree struct)))
21359 (org-list-set-checkbox (line-beginning-position)
21360 struct
21361 (if done "[X]" "[ ]"))
21362 (org-list-write-struct struct
21363 (org-list-parents-alist struct)
21364 old)))
21365 ;; Ensure all text down to END (or SECTION-END) belongs
21366 ;; to the newly created item.
21367 (let ((section-end (save-excursion
21368 (or (outline-next-heading) (point)))))
21369 (forward-line)
21370 (funcall shift-text
21371 (+ start-ind (* (1+ delta) bul-len))
21372 (min end section-end)))))))
21373 ;; Case 3. Normal line with ARG: make the first line of region
21374 ;; an item, and shift indentation of others lines to
21375 ;; set them as item's body.
21376 (arg (let* ((bul (org-list-bullet-string "-"))
21377 (bul-len (length bul))
21378 (ref-ind (org-get-indentation)))
21379 (skip-chars-forward " \t")
21380 (insert bul)
21381 (forward-line)
21382 (while (< (point) end)
21383 ;; Ensure that lines less indented than first one
21384 ;; still get included in item body.
21385 (funcall shift-text
21386 (+ ref-ind bul-len)
21387 (min end (save-excursion (or (outline-next-heading)
21388 (point)))))
21389 (forward-line))))
21390 ;; Case 4. Normal line without ARG: turn each non-item line
21391 ;; into an item.
21393 (while (< (point) end)
21394 (unless (or (org-at-heading-p) (org-at-item-p))
21395 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21396 (replace-match
21397 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21398 (forward-line))))))))
21400 (defun org-toggle-heading (&optional nstars)
21401 "Convert headings to normal text, or items or text to headings.
21402 If there is no active region, only convert the current line.
21404 With a \\[universal-argument] prefix, convert the whole list at
21405 point into heading.
21407 In a region:
21409 - If the first non blank line is a headline, remove the stars
21410 from all headlines in the region.
21412 - If it is a normal line, turn each and every normal line (i.e.,
21413 not an heading or an item) in the region into headings. If you
21414 want to convert only the first line of this region, use one
21415 universal prefix argument.
21417 - If it is a plain list item, turn all plain list items into headings.
21419 When converting a line into a heading, the number of stars is chosen
21420 such that the lines become children of the current entry. However,
21421 when a numeric prefix argument is given, its value determines the
21422 number of stars to add."
21423 (interactive "P")
21424 (let ((skip-blanks
21425 (function
21426 ;; Return beginning of first non-blank line, starting from
21427 ;; line at POS.
21428 (lambda (pos)
21429 (save-excursion
21430 (goto-char pos)
21431 (while (org-at-comment-p) (forward-line))
21432 (skip-chars-forward " \r\t\n")
21433 (point-at-bol)))))
21434 beg end toggled)
21435 ;; Determine boundaries of changes. If a universal prefix has
21436 ;; been given, put the list in a region. If region ends at a bol,
21437 ;; do not consider the last line to be in the region.
21439 (when (and current-prefix-arg (org-at-item-p))
21440 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21441 (org-mark-element))
21443 (if (org-region-active-p)
21444 (setq beg (funcall skip-blanks (region-beginning))
21445 end (copy-marker (save-excursion
21446 (goto-char (region-end))
21447 (if (bolp) (point) (point-at-eol)))))
21448 (setq beg (funcall skip-blanks (point-at-bol))
21449 end (copy-marker (point-at-eol))))
21450 ;; Ensure inline tasks don't count as headings.
21451 (org-with-limited-levels
21452 (save-excursion
21453 (goto-char beg)
21454 (cond
21455 ;; Case 1. Started at an heading: de-star headings.
21456 ((org-at-heading-p)
21457 (while (< (point) end)
21458 (when (org-at-heading-p t)
21459 (looking-at org-outline-regexp) (replace-match "")
21460 (setq toggled t))
21461 (forward-line)))
21462 ;; Case 2. Started at an item: change items into headlines.
21463 ;; One star will be added by `org-list-to-subtree'.
21464 ((org-at-item-p)
21465 (while (< (point) end)
21466 (when (org-at-item-p)
21467 ;; Pay attention to cases when region ends before list.
21468 (let* ((struct (org-list-struct))
21469 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21470 (save-restriction
21471 (narrow-to-region (point) list-end)
21472 (insert (org-list-to-subtree (org-list-parse-list t)))))
21473 (setq toggled t))
21474 (forward-line)))
21475 ;; Case 3. Started at normal text: make every line an heading,
21476 ;; skipping headlines and items.
21477 (t (let* ((stars
21478 (make-string
21479 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21480 (add-stars
21481 (cond (nstars "") ; stars from prefix only
21482 ((equal stars "") "*") ; before first heading
21483 (org-odd-levels-only "**") ; inside heading, odd
21484 (t "*"))) ; inside heading, oddeven
21485 (rpl (concat stars add-stars " "))
21486 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21487 (while (< (point) (if (equal nstars '(4)) lend end))
21488 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21489 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21490 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21491 (forward-line)))))))
21492 (unless toggled (message "Cannot toggle heading from here"))))
21494 (defun org-meta-return (&optional arg)
21495 "Insert a new heading or wrap a region in a table.
21496 Calls `org-insert-heading' or `org-table-wrap-region', depending
21497 on context. See the individual commands for more information."
21498 (interactive "P")
21499 (org-check-before-invisible-edit 'insert)
21500 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21501 (let* ((element (org-element-at-point))
21502 (type (org-element-type element)))
21503 (when (eq type 'table-row)
21504 (setq element (org-element-property :parent element))
21505 (setq type 'table))
21506 (if (and (eq type 'table)
21507 (eq (org-element-property :type element) 'org)
21508 (>= (point) (org-element-property :contents-begin element))
21509 (< (point) (org-element-property :contents-end element)))
21510 (call-interactively 'org-table-wrap-region)
21511 (call-interactively 'org-insert-heading)))))
21513 ;;; Menu entries
21515 (defsubst org-in-subtree-not-table-p ()
21516 "Are we in a subtree and not in a table?"
21517 (and (not (org-before-first-heading-p))
21518 (not (org-at-table-p))))
21520 ;; Define the Org-mode menus
21521 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21522 '("Tbl"
21523 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21524 ["Next Field" org-cycle (org-at-table-p)]
21525 ["Previous Field" org-shifttab (org-at-table-p)]
21526 ["Next Row" org-return (org-at-table-p)]
21527 "--"
21528 ["Blank Field" org-table-blank-field (org-at-table-p)]
21529 ["Edit Field" org-table-edit-field (org-at-table-p)]
21530 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21531 "--"
21532 ("Column"
21533 ["Move Column Left" org-metaleft (org-at-table-p)]
21534 ["Move Column Right" org-metaright (org-at-table-p)]
21535 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21536 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21537 ("Row"
21538 ["Move Row Up" org-metaup (org-at-table-p)]
21539 ["Move Row Down" org-metadown (org-at-table-p)]
21540 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21541 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21542 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21543 "--"
21544 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21545 ("Rectangle"
21546 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21547 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21548 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21549 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21550 "--"
21551 ("Calculate"
21552 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21553 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21554 ["Edit Formulas" org-edit-special (org-at-table-p)]
21555 "--"
21556 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21557 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21558 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21559 "--"
21560 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21561 "--"
21562 ["Sum Column/Rectangle" org-table-sum
21563 (or (org-at-table-p) (org-region-active-p))]
21564 ["Which Column?" org-table-current-column (org-at-table-p)])
21565 ["Debug Formulas"
21566 org-table-toggle-formula-debugger
21567 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21568 ["Show Col/Row Numbers"
21569 org-table-toggle-coordinate-overlays
21570 :style toggle
21571 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21572 "--"
21573 ["Create" org-table-create (and (not (org-at-table-p))
21574 org-enable-table-editor)]
21575 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21576 ["Import from File" org-table-import (not (org-at-table-p))]
21577 ["Export to File" org-table-export (org-at-table-p)]
21578 "--"
21579 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21580 "--"
21581 ("Plot"
21582 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21583 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21585 (easy-menu-define org-org-menu org-mode-map "Org menu"
21586 '("Org"
21587 ("Show/Hide"
21588 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21589 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21590 ["Sparse Tree..." org-sparse-tree t]
21591 ["Reveal Context" org-reveal t]
21592 ["Show All" show-all t]
21593 "--"
21594 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21595 "--"
21596 ["New Heading" org-insert-heading t]
21597 ("Navigate Headings"
21598 ["Up" outline-up-heading t]
21599 ["Next" outline-next-visible-heading t]
21600 ["Previous" outline-previous-visible-heading t]
21601 ["Next Same Level" outline-forward-same-level t]
21602 ["Previous Same Level" outline-backward-same-level t]
21603 "--"
21604 ["Jump" org-goto t])
21605 ("Edit Structure"
21606 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21607 "--"
21608 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21609 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21610 "--"
21611 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21612 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21613 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21614 "--"
21615 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21616 "--"
21617 ["Copy visible text" org-copy-visible t]
21618 "--"
21619 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21620 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21621 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21622 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21623 "--"
21624 ["Sort Region/Children" org-sort t]
21625 "--"
21626 ["Convert to odd levels" org-convert-to-odd-levels t]
21627 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21628 ("Editing"
21629 ["Emphasis..." org-emphasize t]
21630 ["Edit Source Example" org-edit-special t]
21631 "--"
21632 ["Footnote new/jump" org-footnote-action t]
21633 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21634 ("Archive"
21635 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21636 "--"
21637 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21638 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21639 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21641 "--"
21642 ("Hyperlinks"
21643 ["Store Link (Global)" org-store-link t]
21644 ["Find existing link to here" org-occur-link-in-agenda-files t]
21645 ["Insert Link" org-insert-link t]
21646 ["Follow Link" org-open-at-point t]
21647 "--"
21648 ["Next link" org-next-link t]
21649 ["Previous link" org-previous-link t]
21650 "--"
21651 ["Descriptive Links"
21652 org-toggle-link-display
21653 :style radio
21654 :selected org-descriptive-links
21656 ["Literal Links"
21657 org-toggle-link-display
21658 :style radio
21659 :selected (not org-descriptive-links)])
21660 "--"
21661 ("TODO Lists"
21662 ["TODO/DONE/-" org-todo t]
21663 ("Select keyword"
21664 ["Next keyword" org-shiftright (org-at-heading-p)]
21665 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21666 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21667 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21668 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21669 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21670 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21671 "--"
21672 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21673 :selected org-enforce-todo-dependencies :style toggle :active t]
21674 "Settings for tree at point"
21675 ["Do Children sequentially" org-toggle-ordered-property :style radio
21676 :selected (org-entry-get nil "ORDERED")
21677 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21678 ["Do Children parallel" org-toggle-ordered-property :style radio
21679 :selected (not (org-entry-get nil "ORDERED"))
21680 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21681 "--"
21682 ["Set Priority" org-priority t]
21683 ["Priority Up" org-shiftup t]
21684 ["Priority Down" org-shiftdown t]
21685 "--"
21686 ["Get news from all feeds" org-feed-update-all t]
21687 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21688 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21689 ("TAGS and Properties"
21690 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21691 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21692 "--"
21693 ["Set property" org-set-property (not (org-before-first-heading-p))]
21694 ["Column view of properties" org-columns t]
21695 ["Insert Column View DBlock" org-insert-columns-dblock t])
21696 ("Dates and Scheduling"
21697 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21698 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21699 ("Change Date"
21700 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21701 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21702 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21703 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21704 ["Compute Time Range" org-evaluate-time-range t]
21705 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21706 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21707 "--"
21708 ["Custom time format" org-toggle-time-stamp-overlays
21709 :style radio :selected org-display-custom-times]
21710 "--"
21711 ["Goto Calendar" org-goto-calendar t]
21712 ["Date from Calendar" org-date-from-calendar t]
21713 "--"
21714 ["Start/Restart Timer" org-timer-start t]
21715 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21716 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21717 ["Insert Timer String" org-timer t]
21718 ["Insert Timer Item" org-timer-item t])
21719 ("Logging work"
21720 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21721 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21722 ["Clock out" org-clock-out t]
21723 ["Clock cancel" org-clock-cancel t]
21724 "--"
21725 ["Mark as default task" org-clock-mark-default-task t]
21726 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21727 ["Goto running clock" org-clock-goto t]
21728 "--"
21729 ["Display times" org-clock-display t]
21730 ["Create clock table" org-clock-report t]
21731 "--"
21732 ["Record DONE time"
21733 (progn (setq org-log-done (not org-log-done))
21734 (message "Switching to %s will %s record a timestamp"
21735 (car org-done-keywords)
21736 (if org-log-done "automatically" "not")))
21737 :style toggle :selected org-log-done])
21738 "--"
21739 ["Agenda Command..." org-agenda t]
21740 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21741 ("File List for Agenda")
21742 ("Special views current file"
21743 ["TODO Tree" org-show-todo-tree t]
21744 ["Check Deadlines" org-check-deadlines t]
21745 ["Timeline" org-timeline t]
21746 ["Tags/Property tree" org-match-sparse-tree t])
21747 "--"
21748 ["Export/Publish..." org-export-dispatch t]
21749 ("LaTeX"
21750 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21751 :selected org-cdlatex-mode]
21752 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21753 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21754 ["Modify math symbol" org-cdlatex-math-modify
21755 (org-inside-LaTeX-fragment-p)]
21756 ["Insert citation" org-reftex-citation t]
21757 "--"
21758 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21759 "--"
21760 ("MobileOrg"
21761 ["Push Files and Views" org-mobile-push t]
21762 ["Get Captured and Flagged" org-mobile-pull t]
21763 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21764 "--"
21765 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21766 "--"
21767 ("Documentation"
21768 ["Show Version" org-version t]
21769 ["Info Documentation" org-info t])
21770 ("Customize"
21771 ["Browse Org Group" org-customize t]
21772 "--"
21773 ["Expand This Menu" org-create-customize-menu
21774 (fboundp 'customize-menu-create)])
21775 ["Send bug report" org-submit-bug-report t]
21776 "--"
21777 ("Refresh/Reload"
21778 ["Refresh setup current buffer" org-mode-restart t]
21779 ["Reload Org (after update)" org-reload t]
21780 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21783 (defun org-info (&optional node)
21784 "Read documentation for Org-mode in the info system.
21785 With optional NODE, go directly to that node."
21786 (interactive)
21787 (info (format "(org)%s" (or node ""))))
21789 ;;;###autoload
21790 (defun org-submit-bug-report ()
21791 "Submit a bug report on Org-mode via mail.
21793 Don't hesitate to report any problems or inaccurate documentation.
21795 If you don't have setup sending mail from (X)Emacs, please copy the
21796 output buffer into your mail program, as it gives us important
21797 information about your Org-mode version and configuration."
21798 (interactive)
21799 (require 'reporter)
21800 (org-load-modules-maybe)
21801 (org-require-autoloaded-modules)
21802 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21803 (reporter-submit-bug-report
21804 "emacs-orgmode@gnu.org"
21805 (org-version nil 'full)
21806 (let (list)
21807 (save-window-excursion
21808 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21809 (delete-other-windows)
21810 (erase-buffer)
21811 (insert "You are about to submit a bug report to the Org-mode mailing list.
21813 We would like to add your full Org-mode and Outline configuration to the
21814 bug report. This greatly simplifies the work of the maintainer and
21815 other experts on the mailing list.
21817 HOWEVER, some variables you have customized may contain private
21818 information. The names of customers, colleagues, or friends, might
21819 appear in the form of file names, tags, todo states, or search strings.
21820 If you answer yes to the prompt, you might want to check and remove
21821 such private information before sending the email.")
21822 (add-text-properties (point-min) (point-max) '(face org-warning))
21823 (when (yes-or-no-p "Include your Org-mode configuration ")
21824 (mapatoms
21825 (lambda (v)
21826 (and (boundp v)
21827 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21828 (or (and (symbol-value v)
21829 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21830 (and
21831 (get v 'custom-type) (get v 'standard-value)
21832 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21833 (push v list)))))
21834 (kill-buffer (get-buffer "*Warn about privacy*"))
21835 list))
21836 nil nil
21837 "Remember to cover the basics, that is, what you expected to happen and
21838 what in fact did happen. You don't know how to make a good report? See
21840 http://orgmode.org/manual/Feedback.html#Feedback
21842 Your bug report will be posted to the Org-mode mailing list.
21843 ------------------------------------------------------------------------")
21844 (save-excursion
21845 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21846 (replace-match "\\1Bug: \\3 [\\2]")))))
21849 (defun org-install-agenda-files-menu ()
21850 (let ((bl (buffer-list)))
21851 (save-excursion
21852 (while bl
21853 (set-buffer (pop bl))
21854 (if (derived-mode-p 'org-mode) (setq bl nil)))
21855 (when (derived-mode-p 'org-mode)
21856 (easy-menu-change
21857 '("Org") "File List for Agenda"
21858 (append
21859 (list
21860 ["Edit File List" (org-edit-agenda-file-list) t]
21861 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21862 ["Remove Current File from List" org-remove-file t]
21863 ["Cycle through agenda files" org-cycle-agenda-files t]
21864 ["Occur in all agenda files" org-occur-in-agenda-files t]
21865 "--")
21866 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21868 ;;;; Documentation
21870 (defun org-require-autoloaded-modules ()
21871 (interactive)
21872 (mapc 'require
21873 '(org-agenda org-archive org-attach org-clock org-colview org-id
21874 org-table org-timer)))
21876 ;;;###autoload
21877 (defun org-reload (&optional uncompiled)
21878 "Reload all org lisp files.
21879 With prefix arg UNCOMPILED, load the uncompiled versions."
21880 (interactive "P")
21881 (require 'loadhist)
21882 (let* ((org-dir (org-find-library-dir "org"))
21883 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21884 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21885 (remove-re (mapconcat 'identity
21886 (mapcar (lambda (f) (concat "^" f "$"))
21887 (list (if (featurep 'xemacs)
21888 "org-colview"
21889 "org-colview-xemacs")
21890 "org" "org-loaddefs" "org-version"))
21891 "\\|"))
21892 (feats (delete-dups
21893 (mapcar 'file-name-sans-extension
21894 (mapcar 'file-name-nondirectory
21895 (delq nil
21896 (mapcar 'feature-file
21897 features))))))
21898 (lfeat (append
21899 (sort
21900 (setq feats
21901 (delq nil (mapcar
21902 (lambda (f)
21903 (if (and (string-match feature-re f)
21904 (not (string-match remove-re f)))
21905 f nil))
21906 feats)))
21907 'string-lessp)
21908 (list "org-version" "org")))
21909 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21910 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21911 load-uncore load-misses)
21912 (setq load-misses
21913 (delq 't
21914 (mapcar (lambda (f)
21915 (or (org-load-noerror-mustsuffix (concat org-dir f))
21916 (and (string= org-dir contrib-dir)
21917 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21918 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21919 (add-to-list 'load-uncore f 'append)
21922 lfeat)))
21923 (if load-uncore
21924 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21925 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21926 (if load-misses
21927 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21928 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21929 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21931 ;;;###autoload
21932 (defun org-customize ()
21933 "Call the customize function with org as argument."
21934 (interactive)
21935 (org-load-modules-maybe)
21936 (org-require-autoloaded-modules)
21937 (customize-browse 'org))
21939 (defun org-create-customize-menu ()
21940 "Create a full customization menu for Org-mode, insert it into the menu."
21941 (interactive)
21942 (org-load-modules-maybe)
21943 (org-require-autoloaded-modules)
21944 (if (fboundp 'customize-menu-create)
21945 (progn
21946 (easy-menu-change
21947 '("Org") "Customize"
21948 `(["Browse Org group" org-customize t]
21949 "--"
21950 ,(customize-menu-create 'org)
21951 ["Set" Custom-set t]
21952 ["Save" Custom-save t]
21953 ["Reset to Current" Custom-reset-current t]
21954 ["Reset to Saved" Custom-reset-saved t]
21955 ["Reset to Standard Settings" Custom-reset-standard t]))
21956 (message "\"Org\"-menu now contains full customization menu"))
21957 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21959 ;;;; Miscellaneous stuff
21961 ;;; Generally useful functions
21963 (defsubst org-get-at-eol (property n)
21964 "Get text property PROPERTY at the end of line less N characters."
21965 (get-text-property (- (point-at-eol) n) property))
21967 (defun org-find-text-property-in-string (prop s)
21968 "Return the first non-nil value of property PROP in string S."
21969 (or (get-text-property 0 prop s)
21970 (get-text-property (or (next-single-property-change 0 prop s) 0)
21971 prop s)))
21973 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21974 "Display the given MESSAGE as a warning."
21975 (if (fboundp 'display-warning)
21976 (display-warning 'org message
21977 (if (featurep 'xemacs) 'warning :warning))
21978 (let ((buf (get-buffer-create "*Org warnings*")))
21979 (with-current-buffer buf
21980 (goto-char (point-max))
21981 (insert "Warning (Org): " message)
21982 (unless (bolp)
21983 (newline)))
21984 (display-buffer buf)
21985 (sit-for 0))))
21987 (defun org-eval (form)
21988 "Eval FORM and return result."
21989 (condition-case error
21990 (eval form)
21991 (error (format "%%![Error: %s]" error))))
21993 (defun org-in-clocktable-p ()
21994 "Check if the cursor is in a clocktable."
21995 (let ((pos (point)) start)
21996 (save-excursion
21997 (end-of-line 1)
21998 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21999 (setq start (match-beginning 0))
22000 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22001 (>= (match-end 0) pos)
22002 start))))
22004 (defun org-in-verbatim-emphasis ()
22005 (save-match-data
22006 (and (org-in-regexp org-emph-re 2)
22007 (>= (point) (match-beginning 3))
22008 (<= (point) (match-end 4))
22009 (member (match-string 3) '("=" "~")))))
22011 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22012 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22013 (if (and marker (marker-buffer marker)
22014 (buffer-live-p (marker-buffer marker)))
22015 (progn
22016 (org-pop-to-buffer-same-window (marker-buffer marker))
22017 (if (or (> marker (point-max)) (< marker (point-min)))
22018 (widen))
22019 (goto-char marker)
22020 (org-show-context 'org-goto))
22021 (if bookmark
22022 (bookmark-jump bookmark)
22023 (error "Cannot find location"))))
22025 (defun org-quote-csv-field (s)
22026 "Quote field for inclusion in CSV material."
22027 (if (string-match "[\",]" s)
22028 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22031 (defun org-force-self-insert (N)
22032 "Needed to enforce self-insert under remapping."
22033 (interactive "p")
22034 (self-insert-command N))
22036 (defun org-string-width (s)
22037 "Compute width of string, ignoring invisible characters.
22038 This ignores character with invisibility property `org-link', and also
22039 characters with property `org-cwidth', because these will become invisible
22040 upon the next fontification round."
22041 (let (b l)
22042 (when (or (eq t buffer-invisibility-spec)
22043 (assq 'org-link buffer-invisibility-spec))
22044 (while (setq b (text-property-any 0 (length s)
22045 'invisible 'org-link s))
22046 (setq s (concat (substring s 0 b)
22047 (substring s (or (next-single-property-change
22048 b 'invisible s) (length s)))))))
22049 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22050 (setq s (concat (substring s 0 b)
22051 (substring s (or (next-single-property-change
22052 b 'org-cwidth s) (length s))))))
22053 (setq l (string-width s) b -1)
22054 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22055 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22058 (defun org-shorten-string (s maxlength)
22059 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22060 If the string is shorter or has length MAXLENGTH, just return the
22061 original string. If it is longer, the functions finds a space in the
22062 string, breaks this string off at that locations and adds three dots
22063 as ellipsis. Including the ellipsis, the string will not be longer
22064 than MAXLENGTH. If finding a good breaking point in the string does
22065 not work, the string is just chopped off in the middle of a word
22066 if necessary."
22067 (if (<= (length s) maxlength)
22069 (let* ((n (max (- maxlength 4) 1))
22070 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22071 (if (string-match re s)
22072 (concat (match-string 1 s) "...")
22073 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22075 (defun org-get-indentation (&optional line)
22076 "Get the indentation of the current line, interpreting tabs.
22077 When LINE is given, assume it represents a line and compute its indentation."
22078 (if line
22079 (if (string-match "^ *" (org-remove-tabs line))
22080 (match-end 0))
22081 (save-excursion
22082 (beginning-of-line 1)
22083 (skip-chars-forward " \t")
22084 (current-column))))
22086 (defun org-get-string-indentation (s)
22087 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22088 (let ((n -1) (i 0) (w tab-width) c)
22089 (catch 'exit
22090 (while (< (setq n (1+ n)) (length s))
22091 (setq c (aref s n))
22092 (cond ((= c ?\ ) (setq i (1+ i)))
22093 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22094 (t (throw 'exit t)))))
22097 (defun org-remove-tabs (s &optional width)
22098 "Replace tabulators in S with spaces.
22099 Assumes that s is a single line, starting in column 0."
22100 (setq width (or width tab-width))
22101 (while (string-match "\t" s)
22102 (setq s (replace-match
22103 (make-string
22104 (- (* width (/ (+ (match-beginning 0) width) width))
22105 (match-beginning 0)) ?\ )
22106 t t s)))
22109 (defun org-fix-indentation (line ind)
22110 "Fix indentation in LINE.
22111 IND is a cons cell with target and minimum indentation.
22112 If the current indentation in LINE is smaller than the minimum,
22113 leave it alone. If it is larger than ind, set it to the target."
22114 (let* ((l (org-remove-tabs line))
22115 (i (org-get-indentation l))
22116 (i1 (car ind)) (i2 (cdr ind)))
22117 (if (>= i i2) (setq l (substring line i2)))
22118 (if (> i1 0)
22119 (concat (make-string i1 ?\ ) l)
22120 l)))
22122 (defun org-remove-indentation (code &optional n)
22123 "Remove the maximum common indentation from the lines in CODE.
22124 N may optionally be the number of spaces to remove."
22125 (with-temp-buffer
22126 (insert code)
22127 (org-do-remove-indentation n)
22128 (buffer-string)))
22130 (defun org-do-remove-indentation (&optional n)
22131 "Remove the maximum common indentation from the buffer."
22132 (untabify (point-min) (point-max))
22133 (let ((min 10000) re)
22134 (if n
22135 (setq min n)
22136 (goto-char (point-min))
22137 (while (re-search-forward "^ *[^ \n]" nil t)
22138 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22139 (unless (or (= min 0) (= min 10000))
22140 (setq re (format "^ \\{%d\\}" min))
22141 (goto-char (point-min))
22142 (while (re-search-forward re nil t)
22143 (replace-match "")
22144 (end-of-line 1))
22145 min)))
22147 (defun org-fill-template (template alist)
22148 "Find each %key of ALIST in TEMPLATE and replace it."
22149 (let ((case-fold-search nil)
22150 entry key value)
22151 (setq alist (sort (copy-sequence alist)
22152 (lambda (a b) (< (length (car a)) (length (car b))))))
22153 (while (setq entry (pop alist))
22154 (setq template
22155 (replace-regexp-in-string
22156 (concat "%" (regexp-quote (car entry)))
22157 (or (cdr entry) "") template t t)))
22158 template))
22160 (defun org-base-buffer (buffer)
22161 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22162 (if (not buffer)
22163 buffer
22164 (or (buffer-base-buffer buffer)
22165 buffer)))
22167 (defun org-wrap (string &optional width lines)
22168 "Wrap string to either a number of lines, or a width in characters.
22169 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22170 that costs. If there is a word longer than WIDTH, the text is actually
22171 wrapped to the length of that word.
22172 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22173 many lines, whatever width that takes.
22174 The return value is a list of lines, without newlines at the end."
22175 (let* ((words (org-split-string string "[ \t\n]+"))
22176 (maxword (apply 'max (mapcar 'org-string-width words)))
22177 w ll)
22178 (cond (width
22179 (org-do-wrap words (max maxword width)))
22180 (lines
22181 (setq w maxword)
22182 (setq ll (org-do-wrap words maxword))
22183 (if (<= (length ll) lines)
22185 (setq ll words)
22186 (while (> (length ll) lines)
22187 (setq w (1+ w))
22188 (setq ll (org-do-wrap words w)))
22189 ll))
22190 (t (error "Cannot wrap this")))))
22192 (defun org-do-wrap (words width)
22193 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22194 (let (lines line)
22195 (while words
22196 (setq line (pop words))
22197 (while (and words (< (+ (length line) (length (car words))) width))
22198 (setq line (concat line " " (pop words))))
22199 (setq lines (push line lines)))
22200 (nreverse lines)))
22202 (defun org-split-string (string &optional separators)
22203 "Splits STRING into substrings at SEPARATORS.
22204 No empty strings are returned if there are matches at the beginning
22205 and end of string."
22206 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
22207 (start 0)
22208 notfirst
22209 (list nil))
22210 (while (and (string-match rexp string
22211 (if (and notfirst
22212 (= start (match-beginning 0))
22213 (< start (length string)))
22214 (1+ start) start))
22215 (< (match-beginning 0) (length string)))
22216 (setq notfirst t)
22217 (or (eq (match-beginning 0) 0)
22218 (and (eq (match-beginning 0) (match-end 0))
22219 (eq (match-beginning 0) start))
22220 (setq list
22221 (cons (substring string start (match-beginning 0))
22222 list)))
22223 (setq start (match-end 0)))
22224 (or (eq start (length string))
22225 (setq list
22226 (cons (substring string start)
22227 list)))
22228 (nreverse list)))
22230 (defun org-quote-vert (s)
22231 "Replace \"|\" with \"\\vert\"."
22232 (while (string-match "|" s)
22233 (setq s (replace-match "\\vert" t t s)))
22236 (defun org-uuidgen-p (s)
22237 "Is S an ID created by UUIDGEN?"
22238 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22240 (defun org-in-src-block-p (&optional inside)
22241 "Whether point is in a code source block.
22242 When INSIDE is non-nil, don't consider we are within a src block
22243 when point is at #+BEGIN_SRC or #+END_SRC."
22244 (let ((case-fold-search t) ov)
22245 (or (and (eq (get-char-property (point) 'src-block) t))
22246 (and (not inside)
22247 (save-match-data
22248 (save-excursion
22249 (beginning-of-line)
22250 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22252 (defun org-context ()
22253 "Return a list of contexts of the current cursor position.
22254 If several contexts apply, all are returned.
22255 Each context entry is a list with a symbol naming the context, and
22256 two positions indicating start and end of the context. Possible
22257 contexts are:
22259 :headline anywhere in a headline
22260 :headline-stars on the leading stars in a headline
22261 :todo-keyword on a TODO keyword (including DONE) in a headline
22262 :tags on the TAGS in a headline
22263 :priority on the priority cookie in a headline
22264 :item on the first line of a plain list item
22265 :item-bullet on the bullet/number of a plain list item
22266 :checkbox on the checkbox in a plain list item
22267 :table in an org-mode table
22268 :table-special on a special filed in a table
22269 :table-table in a table.el table
22270 :clocktable in a clocktable
22271 :src-block in a source block
22272 :link on a hyperlink
22273 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22274 :target on a <<target>>
22275 :radio-target on a <<<radio-target>>>
22276 :latex-fragment on a LaTeX fragment
22277 :latex-preview on a LaTeX fragment with overlaid preview image
22279 This function expects the position to be visible because it uses font-lock
22280 faces as a help to recognize the following contexts: :table-special, :link,
22281 and :keyword."
22282 (let* ((f (get-text-property (point) 'face))
22283 (faces (if (listp f) f (list f)))
22284 (case-fold-search t)
22285 (p (point)) clist o)
22286 ;; First the large context
22287 (cond
22288 ((org-at-heading-p t)
22289 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22290 (when (progn
22291 (beginning-of-line 1)
22292 (looking-at org-todo-line-tags-regexp))
22293 (push (org-point-in-group p 1 :headline-stars) clist)
22294 (push (org-point-in-group p 2 :todo-keyword) clist)
22295 (push (org-point-in-group p 4 :tags) clist))
22296 (goto-char p)
22297 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22298 (if (looking-at "\\[#[A-Z0-9]\\]")
22299 (push (org-point-in-group p 0 :priority) clist)))
22301 ((org-at-item-p)
22302 (push (org-point-in-group p 2 :item-bullet) clist)
22303 (push (list :item (point-at-bol)
22304 (save-excursion (org-end-of-item) (point)))
22305 clist)
22306 (and (org-at-item-checkbox-p)
22307 (push (org-point-in-group p 0 :checkbox) clist)))
22309 ((org-at-table-p)
22310 (push (list :table (org-table-begin) (org-table-end)) clist)
22311 (if (memq 'org-formula faces)
22312 (push (list :table-special
22313 (previous-single-property-change p 'face)
22314 (next-single-property-change p 'face)) clist)))
22315 ((org-at-table-p 'any)
22316 (push (list :table-table) clist)))
22317 (goto-char p)
22319 (let ((case-fold-search t))
22320 ;; New the "medium" contexts: clocktables, source blocks
22321 (cond ((org-in-clocktable-p)
22322 (push (list :clocktable
22323 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22324 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22325 (match-beginning 1))
22326 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22327 (match-end 0))) clist))
22328 ((org-in-src-block-p)
22329 (push (list :src-block
22330 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22331 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22332 (match-beginning 1))
22333 (and (search-forward "#+END_SRC" nil t)
22334 (match-beginning 0))) clist))))
22335 (goto-char p)
22337 ;; Now the small context
22338 (cond
22339 ((org-at-timestamp-p)
22340 (push (org-point-in-group p 0 :timestamp) clist))
22341 ((memq 'org-link faces)
22342 (push (list :link
22343 (previous-single-property-change p 'face)
22344 (next-single-property-change p 'face)) clist))
22345 ((memq 'org-special-keyword faces)
22346 (push (list :keyword
22347 (previous-single-property-change p 'face)
22348 (next-single-property-change p 'face)) clist))
22349 ((org-at-target-p)
22350 (push (org-point-in-group p 0 :target) clist)
22351 (goto-char (1- (match-beginning 0)))
22352 (if (looking-at org-radio-target-regexp)
22353 (push (org-point-in-group p 0 :radio-target) clist))
22354 (goto-char p))
22355 ((setq o (car (delq nil
22356 (mapcar
22357 (lambda (x)
22358 (if (memq x org-latex-fragment-image-overlays) x))
22359 (overlays-at (point))))))
22360 (push (list :latex-fragment
22361 (overlay-start o) (overlay-end o)) clist)
22362 (push (list :latex-preview
22363 (overlay-start o) (overlay-end o)) clist))
22364 ((org-inside-LaTeX-fragment-p)
22365 ;; FIXME: positions wrong.
22366 (push (list :latex-fragment (point) (point)) clist)))
22368 (setq clist (nreverse (delq nil clist)))
22369 clist))
22371 (defun org-in-regexp (re &optional nlines visually)
22372 "Check if point is inside a match of RE.
22374 Normally only the current line is checked, but you can include
22375 NLINES extra lines after point into the search. If VISUALLY is
22376 set, require that the cursor is not after the match but really
22377 on, so that the block visually is on the match."
22378 (catch 'exit
22379 (let ((pos (point))
22380 (eol (point-at-eol (+ 1 (or nlines 0))))
22381 (inc (if visually 1 0)))
22382 (save-excursion
22383 (beginning-of-line (- 1 (or nlines 0)))
22384 (while (re-search-forward re eol t)
22385 (if (and (<= (match-beginning 0) pos)
22386 (>= (+ inc (match-end 0)) pos))
22387 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22388 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22389 "Org mode 8.3")
22391 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22392 "Non-nil when point is between matches of START-RE and END-RE.
22394 Also return a non-nil value when point is on one of the matches.
22396 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22397 buffer positions. Default values are the positions of headlines
22398 surrounding the point.
22400 The functions returns a cons cell whose car (resp. cdr) is the
22401 position before START-RE (resp. after END-RE)."
22402 (save-match-data
22403 (let ((pos (point))
22404 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22405 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22406 beg end)
22407 (save-excursion
22408 ;; Point is on a block when on START-RE or if START-RE can be
22409 ;; found before it...
22410 (and (or (org-in-regexp start-re)
22411 (re-search-backward start-re limit-up t))
22412 (setq beg (match-beginning 0))
22413 ;; ... and END-RE after it...
22414 (goto-char (match-end 0))
22415 (re-search-forward end-re limit-down t)
22416 (> (setq end (match-end 0)) pos)
22417 ;; ... without another START-RE in-between.
22418 (goto-char (match-beginning 0))
22419 (not (re-search-backward start-re (1+ beg) t))
22420 ;; Return value.
22421 (cons beg end))))))
22423 (defun org-in-block-p (names)
22424 "Non-nil when point belongs to a block whose name belongs to NAMES.
22426 NAMES is a list of strings containing names of blocks.
22428 Return first block name matched, or nil. Beware that in case of
22429 nested blocks, the returned name may not belong to the closest
22430 block from point."
22431 (save-match-data
22432 (catch 'exit
22433 (let ((case-fold-search t)
22434 (lim-up (save-excursion (outline-previous-heading)))
22435 (lim-down (save-excursion (outline-next-heading))))
22436 (mapc (lambda (name)
22437 (let ((n (regexp-quote name)))
22438 (when (org-between-regexps-p
22439 (concat "^[ \t]*#\\+begin_" n)
22440 (concat "^[ \t]*#\\+end_" n)
22441 lim-up lim-down)
22442 (throw 'exit n))))
22443 names))
22444 nil)))
22446 (defun org-occur-in-agenda-files (regexp &optional nlines)
22447 "Call `multi-occur' with buffers for all agenda files."
22448 (interactive "sOrg-files matching: \np")
22449 (let* ((files (org-agenda-files))
22450 (tnames (mapcar 'file-truename files))
22451 (extra org-agenda-text-search-extra-files)
22453 (when (eq (car extra) 'agenda-archives)
22454 (setq extra (cdr extra))
22455 (setq files (org-add-archive-files files)))
22456 (while (setq f (pop extra))
22457 (unless (member (file-truename f) tnames)
22458 (add-to-list 'files f 'append)
22459 (add-to-list 'tnames (file-truename f) 'append)))
22460 (multi-occur
22461 (mapcar (lambda (x)
22462 (with-current-buffer
22463 (or (get-file-buffer x) (find-file-noselect x))
22464 (widen)
22465 (current-buffer)))
22466 files)
22467 regexp)))
22469 (if (boundp 'occur-mode-find-occurrence-hook)
22470 ;; Emacs 23
22471 (add-hook 'occur-mode-find-occurrence-hook
22472 (lambda ()
22473 (when (derived-mode-p 'org-mode)
22474 (org-reveal))))
22475 ;; Emacs 22
22476 (defadvice occur-mode-goto-occurrence
22477 (after org-occur-reveal activate)
22478 (and (derived-mode-p 'org-mode) (org-reveal)))
22479 (defadvice occur-mode-goto-occurrence-other-window
22480 (after org-occur-reveal activate)
22481 (and (derived-mode-p 'org-mode) (org-reveal)))
22482 (defadvice occur-mode-display-occurrence
22483 (after org-occur-reveal activate)
22484 (when (derived-mode-p 'org-mode)
22485 (let ((pos (occur-mode-find-occurrence)))
22486 (with-current-buffer (marker-buffer pos)
22487 (save-excursion
22488 (goto-char pos)
22489 (org-reveal)))))))
22491 (defun org-occur-link-in-agenda-files ()
22492 "Create a link and search for it in the agendas.
22493 The link is not stored in `org-stored-links', it is just created
22494 for the search purpose."
22495 (interactive)
22496 (let ((link (condition-case nil
22497 (org-store-link nil)
22498 (error "Unable to create a link to here"))))
22499 (org-occur-in-agenda-files (regexp-quote link))))
22501 (defun org-reverse-string (string)
22502 "Return the reverse of STRING."
22503 (apply 'string (reverse (string-to-list string))))
22505 ;; defsubst org-uniquify must be defined before first use
22507 (defun org-uniquify-alist (alist)
22508 "Merge elements of ALIST with the same key.
22510 For example, in this alist:
22512 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22513 => '((a 1 3) (b 2))
22515 merge (a 1) and (a 3) into (a 1 3).
22517 The function returns the new ALIST."
22518 (let (rtn)
22519 (mapc
22520 (lambda (e)
22521 (let (n)
22522 (if (not (assoc (car e) rtn))
22523 (push e rtn)
22524 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22525 (setq rtn (assq-delete-all (car e) rtn))
22526 (push n rtn))))
22527 alist)
22528 rtn))
22530 (defun org-delete-all (elts list)
22531 "Remove all elements in ELTS from LIST."
22532 (while elts
22533 (setq list (delete (pop elts) list)))
22534 list)
22536 (defun org-count (cl-item cl-seq)
22537 "Count the number of occurrences of ITEM in SEQ.
22538 Taken from `count' in cl-seq.el with all keyword arguments removed."
22539 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22540 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22541 (while (< cl-start cl-end)
22542 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22543 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22544 (setq cl-start (1+ cl-start)))
22545 cl-count))
22547 (defun org-remove-if (predicate seq)
22548 "Remove everything from SEQ that fulfills PREDICATE."
22549 (let (res e)
22550 (while seq
22551 (setq e (pop seq))
22552 (if (not (funcall predicate e)) (push e res)))
22553 (nreverse res)))
22555 (defun org-remove-if-not (predicate seq)
22556 "Remove everything from SEQ that does not fulfill PREDICATE."
22557 (let (res e)
22558 (while seq
22559 (setq e (pop seq))
22560 (if (funcall predicate e) (push e res)))
22561 (nreverse res)))
22563 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22564 "Reduce two-argument FUNCTION across SEQ.
22565 Taken from `reduce' in cl-seq.el with all keyword arguments but
22566 \":initial-value\" removed."
22567 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22568 (cadr (memq :initial-value cl-keys)))
22569 (cl-seq (pop cl-seq))
22570 (t (funcall cl-func)))))
22571 (while cl-seq
22572 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22573 cl-accum))
22575 (defun org-every (pred seq)
22576 "Return true if PREDICATE is true of every element of SEQ.
22577 Adapted from `every' in cl.el."
22578 (catch 'org-every
22579 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22582 (defun org-some (pred seq)
22583 "Return true if PREDICATE is true of any element of SEQ.
22584 Adapted from `some' in cl.el."
22585 (catch 'org-some
22586 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22587 nil))
22589 (defun org-back-over-empty-lines ()
22590 "Move backwards over whitespace, to the beginning of the first empty line.
22591 Returns the number of empty lines passed."
22592 (let ((pos (point)))
22593 (if (cdr (assoc 'heading org-blank-before-new-entry))
22594 (skip-chars-backward " \t\n\r")
22595 (unless (eobp)
22596 (forward-line -1)))
22597 (beginning-of-line 2)
22598 (goto-char (min (point) pos))
22599 (count-lines (point) pos)))
22601 (defun org-skip-whitespace ()
22602 (skip-chars-forward " \t\n\r"))
22604 (defun org-point-in-group (point group &optional context)
22605 "Check if POINT is in match-group GROUP.
22606 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22607 match. If the match group does not exist or point is not inside it,
22608 return nil."
22609 (and (match-beginning group)
22610 (>= point (match-beginning group))
22611 (<= point (match-end group))
22612 (if context
22613 (list context (match-beginning group) (match-end group))
22614 t)))
22616 (defun org-switch-to-buffer-other-window (&rest args)
22617 "Switch to buffer in a second window on the current frame.
22618 In particular, do not allow pop-up frames.
22619 Returns the newly created buffer."
22620 (org-no-popups
22621 (apply 'switch-to-buffer-other-window args)))
22623 (defun org-combine-plists (&rest plists)
22624 "Create a single property list from all plists in PLISTS.
22625 The process starts by copying the first list, and then setting properties
22626 from the other lists. Settings in the last list are the most significant
22627 ones and overrule settings in the other lists."
22628 (let ((rtn (copy-sequence (pop plists)))
22629 p v ls)
22630 (while plists
22631 (setq ls (pop plists))
22632 (while ls
22633 (setq p (pop ls) v (pop ls))
22634 (setq rtn (plist-put rtn p v))))
22635 rtn))
22637 (defun org-replace-escapes (string table)
22638 "Replace %-escapes in STRING with values in TABLE.
22639 TABLE is an association list with keys like \"%a\" and string values.
22640 The sequences in STRING may contain normal field width and padding information,
22641 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22642 so values can contain further %-escapes if they are define later in TABLE."
22643 (let ((tbl (copy-alist table))
22644 (case-fold-search nil)
22645 (pchg 0)
22646 e re rpl)
22647 (while (setq e (pop tbl))
22648 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22649 (when (and (cdr e) (string-match re (cdr e)))
22650 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22651 (safe "SREF"))
22652 (add-text-properties 0 3 (list 'sref sref) safe)
22653 (setcdr e (replace-match safe t t (cdr e)))))
22654 (while (string-match re string)
22655 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22656 (cdr e)))
22657 (setq string (replace-match rpl t t string))))
22658 (while (setq pchg (next-property-change pchg string))
22659 (let ((sref (get-text-property pchg 'sref string)))
22660 (when (and sref (string-match "SREF" string pchg))
22661 (setq string (replace-match sref t t string)))))
22662 string))
22664 (defun org-sublist (list start end)
22665 "Return a section of LIST, from START to END.
22666 Counting starts at 1."
22667 (let (rtn (c start))
22668 (setq list (nthcdr (1- start) list))
22669 (while (and list (<= c end))
22670 (push (pop list) rtn)
22671 (setq c (1+ c)))
22672 (nreverse rtn)))
22674 (defun org-find-base-buffer-visiting (file)
22675 "Like `find-buffer-visiting' but always return the base buffer and
22676 not an indirect buffer."
22677 (let ((buf (or (get-file-buffer file)
22678 (find-buffer-visiting file))))
22679 (if buf
22680 (or (buffer-base-buffer buf) buf)
22681 nil)))
22683 (defun org-image-file-name-regexp (&optional extensions)
22684 "Return regexp matching the file names of images.
22685 If EXTENSIONS is given, only match these."
22686 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22687 (image-file-name-regexp)
22688 (let ((image-file-name-extensions
22689 (or extensions
22690 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22691 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22692 (concat "\\."
22693 (regexp-opt (nconc (mapcar 'upcase
22694 image-file-name-extensions)
22695 image-file-name-extensions)
22697 "\\'"))))
22699 (defun org-file-image-p (file &optional extensions)
22700 "Return non-nil if FILE is an image."
22701 (save-match-data
22702 (string-match (org-image-file-name-regexp extensions) file)))
22704 (defun org-get-cursor-date (&optional with-time)
22705 "Return the date at cursor in as a time.
22706 This works in the calendar and in the agenda, anywhere else it just
22707 returns the current time.
22708 If WITH-TIME is non-nil, returns the time of the event at point (in
22709 the agenda) or the current time of the day."
22710 (let (date day defd tp tm hod mod)
22711 (when with-time
22712 (setq tp (get-text-property (point) 'time))
22713 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22714 (setq hod (string-to-number (match-string 1 tp))
22715 mod (string-to-number (match-string 2 tp))))
22716 (or tp (setq hod (nth 2 (decode-time (current-time)))
22717 mod (nth 1 (decode-time (current-time))))))
22718 (cond
22719 ((eq major-mode 'calendar-mode)
22720 (setq date (calendar-cursor-to-date)
22721 defd (encode-time 0 (or mod 0) (or hod 0)
22722 (nth 1 date) (nth 0 date) (nth 2 date))))
22723 ((eq major-mode 'org-agenda-mode)
22724 (setq day (get-text-property (point) 'day))
22725 (if day
22726 (setq date (calendar-gregorian-from-absolute day)
22727 defd (encode-time 0 (or mod 0) (or hod 0)
22728 (nth 1 date) (nth 0 date) (nth 2 date))))))
22729 (or defd (current-time))))
22731 (defun org-mark-subtree (&optional up)
22732 "Mark the current subtree.
22733 This puts point at the start of the current subtree, and mark at
22734 the end. If a numeric prefix UP is given, move up into the
22735 hierarchy of headlines by UP levels before marking the subtree."
22736 (interactive "P")
22737 (org-with-limited-levels
22738 (cond ((org-at-heading-p) (beginning-of-line))
22739 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22740 (t (outline-previous-visible-heading 1))))
22741 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22742 (if (org-called-interactively-p 'any)
22743 (call-interactively 'org-mark-element)
22744 (org-mark-element)))
22747 ;;; Indentation
22749 (defun org--get-expected-indentation (element contentsp)
22750 "Expected indentation column for current line, according to ELEMENT.
22751 ELEMENT is an element containing point. CONTENTSP is non-nil
22752 when indentation is to be computed according to contents of
22753 ELEMENT."
22754 (let ((type (org-element-type element))
22755 (start (org-element-property :begin element)))
22756 (org-with-wide-buffer
22757 (cond
22758 (contentsp
22759 (case type
22760 (footnote-definition 0)
22761 ((headline inlinetask nil)
22762 (if (not org-adapt-indentation) 0
22763 (let ((level (org-current-level)))
22764 (if level (1+ level) 0))))
22765 (item
22766 (org-list-item-body-column
22767 (org-element-property :post-affiliated element)))
22768 (plain-list
22769 (save-excursion
22770 (goto-char (org-element-property :post-affiliated element))
22771 (org-get-indentation)))
22772 (otherwise
22773 (goto-char start)
22774 (org-get-indentation))))
22775 ((memq type '(headline inlinetask nil))
22776 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22777 (org--get-expected-indentation element t)
22779 ((eq type 'footnote-definition) 0)
22780 ;; First paragraph of a footnote definition or an item.
22781 ;; Indent like parent.
22782 ((< (line-beginning-position) start)
22783 (org--get-expected-indentation
22784 (org-element-property :parent element) t))
22785 ;; At first line: indent according to previous sibling, if any,
22786 ;; ignoring footnote definitions and inline tasks, or parent's
22787 ;; contents.
22788 ((= (line-beginning-position) start)
22789 (catch 'exit
22790 (while t
22791 (if (= (point-min) start) (throw 'exit 0)
22792 (goto-char (1- start))
22793 (let* ((previous (org-element-at-point))
22794 (parent previous))
22795 (while (and parent (<= (org-element-property :end parent) start))
22796 (setq previous parent
22797 parent (org-element-property :parent parent)))
22798 (cond
22799 ((not previous) (throw 'exit 0))
22800 ((> (org-element-property :end previous) start)
22801 (throw 'exit (org--get-expected-indentation previous t)))
22802 ((memq (org-element-type previous)
22803 '(footnote-definition inlinetask))
22804 (setq start (org-element-property :begin previous)))
22805 (t (goto-char (org-element-property :begin previous))
22806 (throw 'exit
22807 (if (bolp) (org-get-indentation)
22808 ;; At first paragraph in an item or
22809 ;; a footnote definition.
22810 (org--get-expected-indentation
22811 (org-element-property :parent previous) t))))))))))
22812 ;; Otherwise, move to the first non-blank line above.
22814 (beginning-of-line)
22815 (let ((pos (point)))
22816 (skip-chars-backward " \r\t\n")
22817 (cond
22818 ;; Two blank lines end a footnote definition or a plain
22819 ;; list. When we indent an empty line after them, the
22820 ;; containing list or footnote definition is over, so it
22821 ;; qualifies as a previous sibling. Therefore, we indent
22822 ;; like its first line.
22823 ((and (memq type '(footnote-definition plain-list))
22824 (> (count-lines (point) pos) 2))
22825 (goto-char start)
22826 (org-get-indentation))
22827 ;; Line above is the first one of a paragraph at the
22828 ;; beginning of an item or a footnote definition. Indent
22829 ;; like parent.
22830 ((< (line-beginning-position) start)
22831 (org--get-expected-indentation
22832 (org-element-property :parent element) t))
22833 ;; POS is after contents in a greater element. Indent like
22834 ;; the beginning of the element.
22836 ;; As a special case, if point is at the end of a footnote
22837 ;; definition or an item, indent like the very last element
22838 ;; within.
22839 ((and (not (eq type 'paragraph))
22840 (let ((cend (org-element-property :contents-end element)))
22841 (and cend (<= cend pos))))
22842 (if (memq type '(footnote-definition item plain-list))
22843 (org--get-expected-indentation (org-element-at-point) nil)
22844 (goto-char start)
22845 (org-get-indentation)))
22846 ;; In any other case, indent like the current line.
22847 (t (org-get-indentation)))))))))
22849 (defun org--align-node-property ()
22850 "Align node property at point.
22851 Alignment is done according to `org-property-format', which see."
22852 (when (save-excursion
22853 (beginning-of-line)
22854 (looking-at org-property-re))
22855 (replace-match
22856 (concat (match-string 4)
22857 (org-trim
22858 (format org-property-format (match-string 1) (match-string 3))))
22859 t t)))
22861 (defun org-indent-line ()
22862 "Indent line depending on context.
22864 Indentation is done according to the following rules:
22866 - Footnote definitions, headlines and inline tasks have to
22867 start at column 0.
22869 - On the very first line of an element, consider, in order, the
22870 next rules until one matches:
22872 1. If there's a sibling element before, ignoring footnote
22873 definitions and inline tasks, indent like its first line.
22875 2. If element has a parent, indent like its contents. More
22876 precisely, if parent is an item, indent after the
22877 description part, if any, or the bullet (see
22878 `org-list-description-max-indent'). Else, indent like
22879 parent's first line.
22881 3. Otherwise, indent relatively to current level, if
22882 `org-adapt-indentation' is non-nil, or to left margin.
22884 - On a blank line at the end of an element, indent according to
22885 the type of the element. More precisely
22887 1. If element is a plain list, an item, or a footnote
22888 definition, indent like the very last element within.
22890 2. If element is a paragraph, indent like its last non blank
22891 line.
22893 3. Otherwise, indent like its very first line.
22895 - In the code part of a source block, use language major mode
22896 to indent current line if `org-src-tab-acts-natively' is
22897 non-nil. If it is nil, do nothing.
22899 - Otherwise, indent like the first non-blank line above.
22901 The function doesn't indent an item as it could break the whole
22902 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22903 \\[org-shiftmetaright].
22905 Also align node properties according to `org-property-format'."
22906 (interactive)
22907 (cond
22908 (orgstruct-is-++
22909 (let ((indent-line-function
22910 (cadadr (assq 'indent-line-function org-fb-vars))))
22911 (indent-according-to-mode)))
22912 ((org-at-heading-p) 'noindent)
22914 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22915 (type (org-element-type element)))
22916 (cond ((and (memq type '(plain-list item))
22917 (= (line-beginning-position)
22918 (org-element-property :post-affiliated element)))
22919 'noindent)
22920 ((and (eq type 'src-block)
22921 org-src-tab-acts-natively
22922 (> (line-beginning-position)
22923 (org-element-property :post-affiliated element))
22924 (< (line-beginning-position)
22925 (org-with-wide-buffer
22926 (goto-char (org-element-property :end element))
22927 (skip-chars-backward " \r\t\n")
22928 (line-beginning-position))))
22929 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22931 (let ((column (org--get-expected-indentation element nil)))
22932 ;; Preserve current column.
22933 (if (<= (current-column) (current-indentation))
22934 (org-indent-line-to column)
22935 (save-excursion (org-indent-line-to column))))
22936 ;; Align node property. Also preserve current column.
22937 (when (eq type 'node-property)
22938 (let ((column (current-column)))
22939 (org--align-node-property)
22940 (org-move-to-column column)))))))))
22942 (defun org-indent-region (start end)
22943 "Indent each non-blank line in the region.
22944 Called from a program, START and END specify the region to
22945 indent. The function will not indent contents of example blocks,
22946 verse blocks and export blocks as leading white spaces are
22947 assumed to be significant there."
22948 (interactive "r")
22949 (save-excursion
22950 (goto-char start)
22951 (skip-chars-forward " \r\t\n")
22952 (unless (eobp) (beginning-of-line))
22953 (let ((indent-to
22954 (lambda (ind pos)
22955 ;; Set IND as indentation for all lines between point and
22956 ;; POS or END, whichever comes first. Blank lines are
22957 ;; ignored. Leave point after POS once done.
22958 (let ((limit (copy-marker (min end pos))))
22959 (while (< (point) limit)
22960 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
22961 (forward-line))
22962 (set-marker limit nil))))
22963 (end (copy-marker end)))
22964 (while (< (point) end)
22965 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
22966 (let* ((element (org-element-at-point))
22967 (type (org-element-type element))
22968 (element-end (copy-marker (org-element-property :end element)))
22969 (ind (org--get-expected-indentation element nil)))
22970 (cond
22971 ((or (memq type '(paragraph table table-row))
22972 (not (or (org-element-property :contents-begin element)
22973 (memq type
22974 '(example-block export-block src-block)))))
22975 ;; Elements here are indented as a single block. Also
22976 ;; align node properties.
22977 (when (eq type 'node-property)
22978 (org--align-node-property)
22979 (beginning-of-line))
22980 (funcall indent-to ind element-end))
22982 ;; Elements in this category consist of three parts:
22983 ;; before the contents, the contents, and after the
22984 ;; contents. The contents are treated specially,
22985 ;; according to the element type, or not indented at
22986 ;; all. Other parts are indented as a single block.
22987 (let* ((post (copy-marker
22988 (org-element-property :post-affiliated element)))
22989 (cbeg
22990 (copy-marker
22991 (cond
22992 ((not (org-element-property :contents-begin element))
22993 ;; Fake contents for source blocks.
22994 (org-with-wide-buffer
22995 (goto-char post)
22996 (forward-line)
22997 (point)))
22998 ((memq type '(footnote-definition item plain-list))
22999 ;; Contents in these elements could start on
23000 ;; the same line as the beginning of the
23001 ;; element. Make sure we start indenting
23002 ;; from the second line.
23003 (org-with-wide-buffer
23004 (goto-char post)
23005 (end-of-line)
23006 (skip-chars-forward " \r\t\n")
23007 (if (eobp) (point) (line-beginning-position))))
23008 (t (org-element-property :contents-begin element)))))
23009 (cend (copy-marker
23010 (or (org-element-property :contents-end element)
23011 ;; Fake contents for source blocks.
23012 (org-with-wide-buffer
23013 (goto-char element-end)
23014 (skip-chars-backward " \r\t\n")
23015 (line-beginning-position)))
23016 t)))
23017 ;; Do not change items indentation individually as it
23018 ;; might break the list as a whole. On the other
23019 ;; hand, when at a plain list, indent it as a whole.
23020 (cond ((eq type 'plain-list)
23021 (let ((offset (- ind (org-get-indentation))))
23022 (unless (zerop offset)
23023 (indent-rigidly (org-element-property :begin element)
23024 (org-element-property :end element)
23025 offset))
23026 (goto-char cbeg)))
23027 ((eq type 'item) (goto-char cbeg))
23028 (t (funcall indent-to ind cbeg)))
23029 (when (< (point) end)
23030 (case type
23031 ((example-block export-block verse-block))
23032 (src-block
23033 ;; In a source block, indent source code
23034 ;; according to language major mode, but only if
23035 ;; `org-src-tab-acts-natively' is non-nil.
23036 (when (and (< (point) end) org-src-tab-acts-natively)
23037 (ignore-errors
23038 (org-babel-do-in-edit-buffer
23039 (indent-region (point-min) (point-max))))))
23040 (t (org-indent-region (point) (min cend end))))
23041 (goto-char (min cend end))
23042 (when (< (point) end) (funcall indent-to ind element-end)))
23043 (set-marker post nil)
23044 (set-marker cbeg nil)
23045 (set-marker cend nil))))
23046 (set-marker element-end nil))))
23047 (set-marker end nil))))
23049 (defun org-indent-drawer ()
23050 "Indent the drawer at point."
23051 (interactive)
23052 (unless (save-excursion
23053 (beginning-of-line)
23054 (org-looking-at-p org-drawer-regexp))
23055 (user-error "Not at a drawer"))
23056 (let ((element (org-element-at-point)))
23057 (unless (memq (org-element-type element) '(drawer property-drawer))
23058 (user-error "Not at a drawer"))
23059 (org-with-wide-buffer
23060 (org-indent-region (org-element-property :begin element)
23061 (org-element-property :end element))))
23062 (message "Drawer at point indented"))
23064 (defun org-indent-block ()
23065 "Indent the block at point."
23066 (interactive)
23067 (unless (save-excursion
23068 (beginning-of-line)
23069 (let ((case-fold-search t))
23070 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23071 (user-error "Not at a block"))
23072 (let ((element (org-element-at-point)))
23073 (unless (memq (org-element-type element)
23074 '(comment-block center-block dynamic-block example-block
23075 export-block quote-block special-block
23076 src-block verse-block))
23077 (user-error "Not at a block"))
23078 (org-with-wide-buffer
23079 (org-indent-region (org-element-property :begin element)
23080 (org-element-property :end element))))
23081 (message "Block at point indented"))
23084 ;;; Filling
23086 ;; We use our own fill-paragraph and auto-fill functions.
23088 ;; `org-fill-paragraph' relies on adaptive filling and context
23089 ;; checking. Appropriate `fill-prefix' is computed with
23090 ;; `org-adaptive-fill-function'.
23092 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23093 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23094 ;; `org-adaptive-fill-function' value. Internally,
23095 ;; `org-comment-line-break-function' breaks the line.
23097 ;; `org-setup-filling' installs filling and auto-filling related
23098 ;; variables during `org-mode' initialization.
23100 (defvar org-element-paragraph-separate) ; org-element.el
23101 (defun org-setup-filling ()
23102 (require 'org-element)
23103 ;; Prevent auto-fill from inserting unwanted new items.
23104 (when (boundp 'fill-nobreak-predicate)
23105 (org-set-local
23106 'fill-nobreak-predicate
23107 (org-uniquify
23108 (append fill-nobreak-predicate
23109 '(org-fill-line-break-nobreak-p
23110 org-fill-paragraph-with-timestamp-nobreak-p)))))
23111 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23112 (org-set-local 'paragraph-start paragraph-ending)
23113 (org-set-local 'paragraph-separate paragraph-ending))
23114 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23115 (org-set-local 'auto-fill-inhibit-regexp nil)
23116 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23117 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23118 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23120 (defun org-fill-line-break-nobreak-p ()
23121 "Non-nil when a new line at point would create an Org line break."
23122 (save-excursion
23123 (skip-chars-backward "[ \t]")
23124 (skip-chars-backward "\\\\")
23125 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23127 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23128 "Non-nil when a new line at point would split a timestamp."
23129 (and (org-at-timestamp-p t)
23130 (not (looking-at org-ts-regexp-both))))
23132 (declare-function message-in-body-p "message" ())
23133 (defvar orgtbl-line-start-regexp) ; From org-table.el
23134 (defun org-adaptive-fill-function ()
23135 "Compute a fill prefix for the current line.
23136 Return fill prefix, as a string, or nil if current line isn't
23137 meant to be filled. For convenience, if `adaptive-fill-regexp'
23138 matches in paragraphs or comments, use it."
23139 (catch 'exit
23140 (when (derived-mode-p 'message-mode)
23141 (save-excursion
23142 (beginning-of-line)
23143 (cond ((not (message-in-body-p)) (throw 'exit nil))
23144 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23145 ((looking-at message-cite-prefix-regexp)
23146 (throw 'exit (match-string-no-properties 0)))
23147 ((looking-at org-outline-regexp)
23148 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23149 (org-with-wide-buffer
23150 (unless (org-at-heading-p)
23151 (let* ((p (line-beginning-position))
23152 (element (save-excursion
23153 (beginning-of-line)
23154 (org-element-at-point)))
23155 (type (org-element-type element))
23156 (post-affiliated (org-element-property :post-affiliated element)))
23157 (unless (< p post-affiliated)
23158 (case type
23159 (comment
23160 (save-excursion
23161 (beginning-of-line)
23162 (looking-at "[ \t]*")
23163 (concat (match-string 0) "# ")))
23164 (footnote-definition "")
23165 ((item plain-list)
23166 (make-string (org-list-item-body-column post-affiliated) ?\s))
23167 (paragraph
23168 ;; Fill prefix is usually the same as the current line,
23169 ;; unless the paragraph is at the beginning of an item.
23170 (let ((parent (org-element-property :parent element)))
23171 (save-excursion
23172 (beginning-of-line)
23173 (cond ((eq (org-element-type parent) 'item)
23174 (make-string (org-list-item-body-column
23175 (org-element-property :begin parent))
23176 ?\s))
23177 ((and adaptive-fill-regexp
23178 ;; Locally disable
23179 ;; `adaptive-fill-function' to let
23180 ;; `fill-context-prefix' handle
23181 ;; `adaptive-fill-regexp' variable.
23182 (let (adaptive-fill-function)
23183 (fill-context-prefix
23184 post-affiliated
23185 (org-element-property :end element)))))
23186 ((looking-at "[ \t]+") (match-string 0))
23187 (t "")))))
23188 (comment-block
23189 ;; Only fill contents if P is within block boundaries.
23190 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23191 (forward-line)
23192 (point)))
23193 (cend (save-excursion
23194 (goto-char (org-element-property :end element))
23195 (skip-chars-backward " \r\t\n")
23196 (line-beginning-position))))
23197 (when (and (>= p cbeg) (< p cend))
23198 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23199 (match-string 0)
23200 "")))))))))))
23202 (declare-function message-goto-body "message" ())
23203 (defvar message-cite-prefix-regexp) ; From message.el
23204 (defun org-fill-paragraph (&optional justify)
23205 "Fill element at point, when applicable.
23207 This function only applies to comment blocks, comments, example
23208 blocks and paragraphs. Also, as a special case, re-align table
23209 when point is at one.
23211 If JUSTIFY is non-nil (interactively, with prefix argument),
23212 justify as well. If `sentence-end-double-space' is non-nil, then
23213 period followed by one space does not end a sentence, so don't
23214 break a line there. The variable `fill-column' controls the
23215 width for filling.
23217 For convenience, when point is at a plain list, an item or
23218 a footnote definition, try to fill the first paragraph within."
23219 (interactive)
23220 (if (and (derived-mode-p 'message-mode)
23221 (or (not (message-in-body-p))
23222 (save-excursion (move-beginning-of-line 1)
23223 (looking-at message-cite-prefix-regexp))))
23224 ;; First ensure filling is correct in message-mode.
23225 (let ((fill-paragraph-function
23226 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23227 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23228 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23229 (paragraph-separate
23230 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23231 (fill-paragraph nil))
23232 (with-syntax-table org-mode-transpose-word-syntax-table
23233 ;; Move to end of line in order to get the first paragraph
23234 ;; within a plain list or a footnote definition.
23235 (let ((element (save-excursion
23236 (end-of-line)
23237 (or (ignore-errors (org-element-at-point))
23238 (user-error "An element cannot be parsed line %d"
23239 (line-number-at-pos (point)))))))
23240 ;; First check if point is in a blank line at the beginning of
23241 ;; the buffer. In that case, ignore filling.
23242 (case (org-element-type element)
23243 ;; Use major mode filling function is src blocks.
23244 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23245 ;; Align Org tables, leave table.el tables as-is.
23246 (table-row (org-table-align) t)
23247 (table
23248 (when (eq (org-element-property :type element) 'org)
23249 (save-excursion
23250 (goto-char (org-element-property :post-affiliated element))
23251 (org-table-align)))
23253 (paragraph
23254 ;; Paragraphs may contain `line-break' type objects.
23255 (let ((beg (max (point-min)
23256 (org-element-property :contents-begin element)))
23257 (end (min (point-max)
23258 (org-element-property :contents-end element))))
23259 ;; Do nothing if point is at an affiliated keyword.
23260 (if (< (line-end-position) beg) t
23261 (when (derived-mode-p 'message-mode)
23262 ;; In `message-mode', do not fill following citation
23263 ;; in current paragraph nor text before message body.
23264 (let ((body-start (save-excursion (message-goto-body))))
23265 (when body-start (setq beg (max body-start beg))))
23266 (when (save-excursion
23267 (re-search-forward
23268 (concat "^" message-cite-prefix-regexp) end t))
23269 (setq end (match-beginning 0))))
23270 ;; Fill paragraph, taking line breaks into account.
23271 (save-excursion
23272 (goto-char beg)
23273 (let ((cuts (list beg)))
23274 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23275 (when (eq 'line-break
23276 (org-element-type
23277 (save-excursion (backward-char)
23278 (org-element-context))))
23279 (push (point) cuts)))
23280 (dolist (c (delq end cuts))
23281 (fill-region-as-paragraph c end justify)
23282 (setq end c))))
23283 t)))
23284 ;; Contents of `comment-block' type elements should be
23285 ;; filled as plain text, but only if point is within block
23286 ;; markers.
23287 (comment-block
23288 (let* ((case-fold-search t)
23289 (beg (save-excursion
23290 (goto-char (org-element-property :begin element))
23291 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23292 (forward-line)
23293 (point)))
23294 (end (save-excursion
23295 (goto-char (org-element-property :end element))
23296 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23297 (line-beginning-position))))
23298 (if (or (< (point) beg) (> (point) end)) t
23299 (fill-region-as-paragraph
23300 (save-excursion (end-of-line)
23301 (re-search-backward "^[ \t]*$" beg 'move)
23302 (line-beginning-position))
23303 (save-excursion (beginning-of-line)
23304 (re-search-forward "^[ \t]*$" end 'move)
23305 (line-beginning-position))
23306 justify))))
23307 ;; Fill comments.
23308 (comment
23309 (let ((begin (org-element-property :post-affiliated element))
23310 (end (org-element-property :end element)))
23311 (when (and (>= (point) begin) (<= (point) end))
23312 (let ((begin (save-excursion
23313 (end-of-line)
23314 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23315 (progn (forward-line) (point))
23316 begin)))
23317 (end (save-excursion
23318 (end-of-line)
23319 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23320 (1- (line-beginning-position))
23321 (skip-chars-backward " \r\t\n")
23322 (line-end-position)))))
23323 ;; Do not fill comments when at a blank line.
23324 (when (> end begin)
23325 (let ((fill-prefix
23326 (save-excursion
23327 (beginning-of-line)
23328 (looking-at "[ \t]*#")
23329 (let ((comment-prefix (match-string 0)))
23330 (goto-char (match-end 0))
23331 (if (looking-at adaptive-fill-regexp)
23332 (concat comment-prefix (match-string 0))
23333 (concat comment-prefix " "))))))
23334 (save-excursion
23335 (fill-region-as-paragraph begin end justify))))))
23337 ;; Ignore every other element.
23338 (otherwise t))))))
23340 (defun org-auto-fill-function ()
23341 "Auto-fill function."
23342 ;; Check if auto-filling is meaningful.
23343 (let ((fc (current-fill-column)))
23344 (when (and fc (> (current-column) fc))
23345 (let* ((fill-prefix (org-adaptive-fill-function))
23346 ;; Enforce empty fill prefix, if required. Otherwise, it
23347 ;; will be computed again.
23348 (adaptive-fill-mode (not (equal fill-prefix ""))))
23349 (when fill-prefix (do-auto-fill))))))
23351 (defun org-comment-line-break-function (&optional soft)
23352 "Break line at point and indent, continuing comment if within one.
23353 The inserted newline is marked hard if variable
23354 `use-hard-newlines' is true, unless optional argument SOFT is
23355 non-nil."
23356 (if soft (insert-and-inherit ?\n) (newline 1))
23357 (save-excursion (forward-char -1) (delete-horizontal-space))
23358 (delete-horizontal-space)
23359 (indent-to-left-margin)
23360 (insert-before-markers-and-inherit fill-prefix))
23363 ;;; Fixed Width Areas
23365 (defun org-toggle-fixed-width ()
23366 "Toggle fixed-width markup.
23368 Add or remove fixed-width markup on current line, whenever it
23369 makes sense. Return an error otherwise.
23371 If a region is active and if it contains only fixed-width areas
23372 or blank lines, remove all fixed-width markup in it. If the
23373 region contains anything else, convert all non-fixed-width lines
23374 to fixed-width ones.
23376 Blank lines at the end of the region are ignored unless the
23377 region only contains such lines."
23378 (interactive)
23379 (if (not (org-region-active-p))
23380 ;; No region:
23382 ;; Remove fixed width marker only in a fixed-with element.
23384 ;; Add fixed width maker in paragraphs, in blank lines after
23385 ;; elements or at the beginning of a headline or an inlinetask,
23386 ;; and before any one-line elements (e.g., a clock).
23387 (progn
23388 (beginning-of-line)
23389 (let* ((element (org-element-at-point))
23390 (type (org-element-type element)))
23391 (cond
23392 ((and (eq type 'fixed-width)
23393 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23394 (replace-match
23395 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23396 ((and (memq type '(babel-call clock comment diary-sexp headline
23397 horizontal-rule keyword paragraph
23398 planning))
23399 (<= (org-element-property :post-affiliated element) (point)))
23400 (skip-chars-forward " \t")
23401 (insert ": "))
23402 ((and (org-looking-at-p "[ \t]*$")
23403 (or (eq type 'inlinetask)
23404 (save-excursion
23405 (skip-chars-forward " \r\t\n")
23406 (<= (org-element-property :end element) (point)))))
23407 (delete-region (point) (line-end-position))
23408 (org-indent-line)
23409 (insert ": "))
23410 (t (user-error "Cannot insert a fixed-width line here")))))
23411 ;; Region active.
23412 (let* ((begin (save-excursion
23413 (goto-char (region-beginning))
23414 (line-beginning-position)))
23415 (end (copy-marker
23416 (save-excursion
23417 (goto-char (region-end))
23418 (unless (eolp) (beginning-of-line))
23419 (if (save-excursion (re-search-backward "\\S-" begin t))
23420 (progn (skip-chars-backward " \r\t\n") (point))
23421 (point)))))
23422 (all-fixed-width-p
23423 (catch 'not-all-p
23424 (save-excursion
23425 (goto-char begin)
23426 (skip-chars-forward " \r\t\n")
23427 (when (eobp) (throw 'not-all-p nil))
23428 (while (< (point) end)
23429 (let ((element (org-element-at-point)))
23430 (if (eq (org-element-type element) 'fixed-width)
23431 (goto-char (org-element-property :end element))
23432 (throw 'not-all-p nil))))
23433 t))))
23434 (if all-fixed-width-p
23435 (save-excursion
23436 (goto-char begin)
23437 (while (< (point) end)
23438 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23439 (replace-match
23440 "" nil nil nil
23441 (if (= (line-end-position) (match-end 0)) 0 1)))
23442 (forward-line)))
23443 (let ((min-ind (point-max)))
23444 ;; Find minimum indentation across all lines.
23445 (save-excursion
23446 (goto-char begin)
23447 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23448 (setq min-ind 0)
23449 (catch 'zerop
23450 (while (< (point) end)
23451 (unless (org-looking-at-p "[ \t]*$")
23452 (let ((ind (org-get-indentation)))
23453 (setq min-ind (min min-ind ind))
23454 (when (zerop ind) (throw 'zerop t))))
23455 (forward-line)))))
23456 ;; Loop over all lines and add fixed-width markup everywhere
23457 ;; but in fixed-width lines.
23458 (save-excursion
23459 (goto-char begin)
23460 (while (< (point) end)
23461 (cond
23462 ((org-at-heading-p)
23463 (insert ": ")
23464 (forward-line)
23465 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23466 (insert ":")
23467 (forward-line)))
23468 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23469 (let* ((element (org-element-at-point))
23470 (element-end (org-element-property :end element)))
23471 (if (eq (org-element-type element) 'fixed-width)
23472 (progn (goto-char element-end)
23473 (skip-chars-backward " \r\t\n")
23474 (forward-line))
23475 (let ((limit (min end element-end)))
23476 (while (< (point) limit)
23477 (org-move-to-column min-ind t)
23478 (insert ": ")
23479 (forward-line))))))
23481 (org-move-to-column min-ind t)
23482 (insert ": ")
23483 (forward-line)))))))
23484 (set-marker end nil))))
23487 ;;; Comments
23489 ;; Org comments syntax is quite complex. It requires the entire line
23490 ;; to be just a comment. Also, even with the right syntax at the
23491 ;; beginning of line, some some elements (i.e. verse-block or
23492 ;; example-block) don't accept comments. Usual Emacs comment commands
23493 ;; cannot cope with those requirements. Therefore, Org replaces them.
23495 ;; Org still relies on `comment-dwim', but cannot trust
23496 ;; `comment-only-p'. So, `comment-region-function' and
23497 ;; `uncomment-region-function' both point
23498 ;; to`org-comment-or-uncomment-region'. Eventually,
23499 ;; `org-insert-comment' takes care of insertion of comments at the
23500 ;; beginning of line.
23502 ;; `org-setup-comments-handling' install comments related variables
23503 ;; during `org-mode' initialization.
23505 (defun org-setup-comments-handling ()
23506 (interactive)
23507 (org-set-local 'comment-use-syntax nil)
23508 (org-set-local 'comment-start "# ")
23509 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23510 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23511 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23512 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23514 (defun org-insert-comment ()
23515 "Insert an empty comment above current line.
23516 If the line is empty, insert comment at its beginning. When
23517 point is within a source block, comment according to the related
23518 major mode."
23519 (if (let ((element (org-element-at-point)))
23520 (and (eq (org-element-type element) 'src-block)
23521 (< (save-excursion
23522 (goto-char (org-element-property :post-affiliated element))
23523 (line-end-position))
23524 (point))
23525 (> (save-excursion
23526 (goto-char (org-element-property :end element))
23527 (skip-chars-backward " \r\t\n")
23528 (line-beginning-position))
23529 (point))))
23530 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23531 (beginning-of-line)
23532 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23533 (open-line 1))
23534 (org-indent-line)
23535 (insert "# ")))
23537 (defvar comment-empty-lines) ; From newcomment.el.
23538 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23539 "Comment or uncomment each non-blank line in the region.
23540 Uncomment each non-blank line between BEG and END if it only
23541 contains commented lines. Otherwise, comment them. If region is
23542 strictly within a source block, use appropriate comment syntax."
23543 (if (let ((element (org-element-at-point)))
23544 (and (eq (org-element-type element) 'src-block)
23545 (< (save-excursion
23546 (goto-char (org-element-property :post-affiliated element))
23547 (line-end-position))
23548 beg)
23549 (>= (save-excursion
23550 (goto-char (org-element-property :end element))
23551 (skip-chars-backward " \r\t\n")
23552 (line-beginning-position))
23553 end)))
23554 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23555 (save-restriction
23556 ;; Restrict region
23557 (narrow-to-region (save-excursion (goto-char beg)
23558 (skip-chars-forward " \r\t\n" end)
23559 (line-beginning-position))
23560 (save-excursion (goto-char end)
23561 (skip-chars-backward " \r\t\n" beg)
23562 (line-end-position)))
23563 (let ((uncommentp
23564 ;; UNCOMMENTP is non-nil when every non blank line between
23565 ;; BEG and END is a comment.
23566 (save-excursion
23567 (goto-char (point-min))
23568 (while (and (not (eobp))
23569 (let ((element (org-element-at-point)))
23570 (and (eq (org-element-type element) 'comment)
23571 (goto-char (min (point-max)
23572 (org-element-property
23573 :end element)))))))
23574 (eobp))))
23575 (if uncommentp
23576 ;; Only blank lines and comments in region: uncomment it.
23577 (save-excursion
23578 (goto-char (point-min))
23579 (while (not (eobp))
23580 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23581 (replace-match "" nil nil nil 1))
23582 (forward-line)))
23583 ;; Comment each line in region.
23584 (let ((min-indent (point-max)))
23585 ;; First find the minimum indentation across all lines.
23586 (save-excursion
23587 (goto-char (point-min))
23588 (while (and (not (eobp)) (not (zerop min-indent)))
23589 (unless (looking-at "[ \t]*$")
23590 (setq min-indent (min min-indent (current-indentation))))
23591 (forward-line)))
23592 ;; Then loop over all lines.
23593 (save-excursion
23594 (goto-char (point-min))
23595 (while (not (eobp))
23596 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23597 ;; Don't get fooled by invisible text (e.g. link path)
23598 ;; when moving to column MIN-INDENT.
23599 (let ((buffer-invisibility-spec nil))
23600 (org-move-to-column min-indent t))
23601 (insert comment-start))
23602 (forward-line)))))))))
23604 (defun org-comment-dwim (arg)
23605 "Call `comment-dwim' within a source edit buffer if needed."
23606 (interactive "*P")
23607 (if (org-in-src-block-p)
23608 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23609 (call-interactively 'comment-dwim)))
23612 ;;; Timestamps API
23614 ;; This section contains tools to operate on timestamp objects, as
23615 ;; returned by, e.g. `org-element-context'.
23617 (defun org-timestamp--to-internal-time (timestamp &optional end)
23618 "Encode TIMESTAMP object into Emacs internal time.
23619 Use end of date range or time range when END is non-nil."
23620 (apply #'encode-time
23621 (cons 0
23622 (mapcar
23623 (lambda (prop) (or (org-element-property prop timestamp) 0))
23624 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23625 '(:minute-start :hour-start :day-start :month-start
23626 :year-start))))))
23628 (defun org-timestamp-has-time-p (timestamp)
23629 "Non-nil when TIMESTAMP has a time specified."
23630 (org-element-property :hour-start timestamp))
23632 (defun org-timestamp-format (timestamp format &optional end utc)
23633 "Format a TIMESTAMP object into a string.
23635 FORMAT is a format specifier to be passed to
23636 `format-time-string'.
23638 When optional argument END is non-nil, use end of date-range or
23639 time-range, if possible.
23641 When optional argument UTC is non-nil, time will be expressed as
23642 Universal Time."
23643 (format-time-string
23644 format (org-timestamp--to-internal-time timestamp end) utc))
23646 (defun org-timestamp-split-range (timestamp &optional end)
23647 "Extract a TIMESTAMP object from a date or time range.
23649 END, when non-nil, means extract the end of the range.
23650 Otherwise, extract its start.
23652 Return a new timestamp object."
23653 (let ((type (org-element-property :type timestamp)))
23654 (if (memq type '(active inactive diary)) timestamp
23655 (let ((split-ts (org-element-copy timestamp)))
23656 ;; Set new type.
23657 (org-element-put-property
23658 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23659 ;; Copy start properties over end properties if END is
23660 ;; non-nil. Otherwise, copy end properties over `start' ones.
23661 (let ((p-alist '((:minute-start . :minute-end)
23662 (:hour-start . :hour-end)
23663 (:day-start . :day-end)
23664 (:month-start . :month-end)
23665 (:year-start . :year-end))))
23666 (dolist (p-cell p-alist)
23667 (org-element-put-property
23668 split-ts
23669 (funcall (if end #'car #'cdr) p-cell)
23670 (org-element-property
23671 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23672 ;; Eventually refresh `:raw-value'.
23673 (org-element-put-property split-ts :raw-value nil)
23674 (org-element-put-property
23675 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23677 (defun org-timestamp-translate (timestamp &optional boundary)
23678 "Translate TIMESTAMP object to custom format.
23680 Format string is defined in `org-time-stamp-custom-formats',
23681 which see.
23683 When optional argument BOUNDARY is non-nil, it is either the
23684 symbol `start' or `end'. In this case, only translate the
23685 starting or ending part of TIMESTAMP if it is a date or time
23686 range. Otherwise, translate both parts.
23688 Return timestamp as-is if `org-display-custom-times' is nil or if
23689 it has a `diary' type."
23690 (let ((type (org-element-property :type timestamp)))
23691 (if (or (not org-display-custom-times) (eq type 'diary))
23692 (org-element-interpret-data timestamp)
23693 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23694 org-time-stamp-custom-formats)))
23695 (if (and (not boundary) (memq type '(active-range inactive-range)))
23696 (concat (org-timestamp-format timestamp fmt)
23697 "--"
23698 (org-timestamp-format timestamp fmt t))
23699 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23703 ;;; Other stuff.
23705 (defun org-reftex-citation ()
23706 "Use reftex-citation to insert a citation into the buffer.
23707 This looks for a line like
23709 #+BIBLIOGRAPHY: foo plain option:-d
23711 and derives from it that foo.bib is the bibliography file relevant
23712 for this document. It then installs the necessary environment for RefTeX
23713 to work in this buffer and calls `reftex-citation' to insert a citation
23714 into the buffer.
23716 Export of such citations to both LaTeX and HTML is handled by the contributed
23717 package ox-bibtex by Taru Karttunen."
23718 (interactive)
23719 (let ((reftex-docstruct-symbol 'rds)
23720 (reftex-cite-format "\\cite{%l}")
23721 rds bib)
23722 (save-excursion
23723 (save-restriction
23724 (widen)
23725 (let ((case-fold-search t)
23726 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23727 (if (not (save-excursion
23728 (or (re-search-forward re nil t)
23729 (re-search-backward re nil t))))
23730 (user-error "No bibliography defined in file")
23731 (setq bib (concat (match-string 1) ".bib")
23732 rds (list (list 'bib bib)))))))
23733 (call-interactively 'reftex-citation)))
23735 ;;;; Functions extending outline functionality
23737 (defun org-beginning-of-line (&optional arg)
23738 "Go to the beginning of the current line. If that is invisible, continue
23739 to a visible line beginning. This makes the function of C-a more intuitive.
23740 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23741 first attempt, and only move to after the tags when the cursor is already
23742 beyond the end of the headline."
23743 (interactive "P")
23744 (let ((pos (point))
23745 (special (if (consp org-special-ctrl-a/e)
23746 (car org-special-ctrl-a/e)
23747 org-special-ctrl-a/e))
23748 deactivate-mark refpos)
23749 (if (org-bound-and-true-p visual-line-mode)
23750 (beginning-of-visual-line 1)
23751 (beginning-of-line 1))
23752 (if (and arg (fboundp 'move-beginning-of-line))
23753 (call-interactively 'move-beginning-of-line)
23754 (if (bobp)
23756 (backward-char 1)
23757 (if (org-truely-invisible-p)
23758 (while (and (not (bobp)) (org-truely-invisible-p))
23759 (backward-char 1)
23760 (beginning-of-line 1))
23761 (forward-char 1))))
23762 (when special
23763 (cond
23764 ((and (looking-at org-complex-heading-regexp)
23765 (= (char-after (match-end 1)) ?\ ))
23766 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23767 (point-at-eol)))
23768 (goto-char
23769 (if (eq special t)
23770 (cond ((> pos refpos) refpos)
23771 ((= pos (point)) refpos)
23772 (t (point)))
23773 (cond ((> pos (point)) (point))
23774 ((not (eq last-command this-command)) (point))
23775 (t refpos)))))
23776 ((org-at-item-p)
23777 ;; Being at an item and not looking at an the item means point
23778 ;; was previously moved to beginning of a visual line, which
23779 ;; doesn't contain the item. Therefore, do nothing special,
23780 ;; just stay here.
23781 (when (looking-at org-list-full-item-re)
23782 ;; Set special position at first white space character after
23783 ;; bullet, and check-box, if any.
23784 (let ((after-bullet
23785 (let ((box (match-end 3)))
23786 (if (not box) (match-end 1)
23787 (let ((after (char-after box)))
23788 (if (and after (= after ? )) (1+ box) box))))))
23789 ;; Special case: Move point to special position when
23790 ;; currently after it or at beginning of line.
23791 (if (eq special t)
23792 (when (or (> pos after-bullet) (= (point) pos))
23793 (goto-char after-bullet))
23794 ;; Reversed case: Move point to special position when
23795 ;; point was already at beginning of line and command is
23796 ;; repeated.
23797 (when (and (= (point) pos) (eq last-command this-command))
23798 (goto-char after-bullet))))))))
23799 (org-no-warnings
23800 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23801 (setq disable-point-adjustment
23802 (or (not (invisible-p (point)))
23803 (not (invisible-p (max (point-min) (1- (point))))))))
23805 (defun org-end-of-line (&optional arg)
23806 "Go to the end of the line.
23807 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23808 tags on the first attempt, and only move to after the tags when
23809 the cursor is already beyond the end of the headline."
23810 (interactive "P")
23811 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23812 org-special-ctrl-a/e))
23813 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23814 'end-of-visual-line)
23815 ((fboundp 'move-end-of-line) 'move-end-of-line)
23816 (t 'end-of-line)))
23817 deactivate-mark)
23818 (if (or (not special) arg) (call-interactively move-fun)
23819 (let* ((element (save-excursion (beginning-of-line)
23820 (org-element-at-point)))
23821 (type (org-element-type element)))
23822 (cond
23823 ((memq type '(headline inlinetask))
23824 (let ((pos (point)))
23825 (beginning-of-line 1)
23826 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23827 (if (eq special t)
23828 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23829 (goto-char (match-beginning 1))
23830 (goto-char (match-end 0)))
23831 (if (or (< pos (match-end 0))
23832 (not (eq this-command last-command)))
23833 (goto-char (match-end 0))
23834 (goto-char (match-beginning 1))))
23835 (call-interactively move-fun))))
23836 ((outline-invisible-p (line-end-position))
23837 ;; If element is hidden, `move-end-of-line' would put point
23838 ;; after it. Use `end-of-line' to stay on current line.
23839 (call-interactively 'end-of-line))
23840 (t (call-interactively move-fun)))))
23841 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23842 (setq disable-point-adjustment
23843 (or (not (invisible-p (point)))
23844 (not (invisible-p (max (point-min) (1- (point))))))))
23846 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23847 (define-key org-mode-map "\C-e" 'org-end-of-line)
23849 (defun org-backward-sentence (&optional arg)
23850 "Go to beginning of sentence, or beginning of table field.
23851 This will call `backward-sentence' or `org-table-beginning-of-field',
23852 depending on context."
23853 (interactive "P")
23854 (let* ((element (org-element-at-point))
23855 (contents-begin (org-element-property :contents-begin element))
23856 (table (org-element-lineage element '(table) t)))
23857 (if (and table
23858 (> (point) contents-begin)
23859 (<= (point) (org-element-property :contents-end table)))
23860 (call-interactively #'org-table-beginning-of-field)
23861 (save-restriction
23862 (when (and contents-begin
23863 (< (point-min) contents-begin)
23864 (> (point) contents-begin))
23865 (narrow-to-region contents-begin
23866 (org-element-property :contents-end element)))
23867 (call-interactively #'backward-sentence)))))
23869 (defun org-forward-sentence (&optional arg)
23870 "Go to end of sentence, or end of table field.
23871 This will call `forward-sentence' or `org-table-end-of-field',
23872 depending on context."
23873 (interactive "P")
23874 (let* ((element (org-element-at-point))
23875 (contents-end (org-element-property :contents-end element))
23876 (table (org-element-lineage element '(table) t)))
23877 (if (and table
23878 (>= (point) (org-element-property :contents-begin table))
23879 (< (point) contents-end))
23880 (call-interactively #'org-table-end-of-field)
23881 (save-restriction
23882 (when (and contents-end
23883 (> (point-max) contents-end)
23884 ;; Skip blank lines between elements.
23885 (< (org-element-property :end element)
23886 (save-excursion (goto-char contents-end)
23887 (skip-chars-forward " \r\t\n"))))
23888 (narrow-to-region (org-element-property :contents-begin element)
23889 contents-end))
23890 (call-interactively #'forward-sentence)))))
23892 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23893 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23895 (defun org-kill-line (&optional arg)
23896 "Kill line, to tags or end of line."
23897 (interactive "P")
23898 (cond
23899 ((or (not org-special-ctrl-k)
23900 (bolp)
23901 (not (org-at-heading-p)))
23902 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23903 org-ctrl-k-protect-subtree)
23904 (if (or (eq org-ctrl-k-protect-subtree 'error)
23905 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23906 (user-error "C-k aborted as it would kill a hidden subtree")))
23907 (call-interactively
23908 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23909 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23910 (kill-region (point) (match-beginning 1))
23911 (org-set-tags nil t))
23912 (t (kill-region (point) (point-at-eol)))))
23914 (define-key org-mode-map "\C-k" 'org-kill-line)
23916 (defun org-yank (&optional arg)
23917 "Yank. If the kill is a subtree, treat it specially.
23918 This command will look at the current kill and check if is a single
23919 subtree, or a series of subtrees[1]. If it passes the test, and if the
23920 cursor is at the beginning of a line or after the stars of a currently
23921 empty headline, then the yank is handled specially. How exactly depends
23922 on the value of the following variables, both set by default.
23924 `org-yank-folded-subtrees'
23925 When set, the subtree(s) will be folded after insertion, but only
23926 if doing so would now swallow text after the yanked text.
23928 `org-yank-adjusted-subtrees'
23929 When set, the subtree will be promoted or demoted in order to
23930 fit into the local outline tree structure, which means that the
23931 level will be adjusted so that it becomes the smaller one of the
23932 two *visible* surrounding headings.
23934 Any prefix to this command will cause `yank' to be called directly with
23935 no special treatment. In particular, a simple \\[universal-argument] prefix \
23936 will just
23937 plainly yank the text as it is.
23939 \[1] The test checks if the first non-white line is a heading
23940 and if there are no other headings with fewer stars."
23941 (interactive "P")
23942 (org-yank-generic 'yank arg))
23944 (defun org-yank-generic (command arg)
23945 "Perform some yank-like command.
23947 This function implements the behavior described in the `org-yank'
23948 documentation. However, it has been generalized to work for any
23949 interactive command with similar behavior."
23951 ;; pretend to be command COMMAND
23952 (setq this-command command)
23954 (if arg
23955 (call-interactively command)
23957 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23958 (and (org-kill-is-subtree-p)
23959 (or (bolp)
23960 (and (looking-at "[ \t]*$")
23961 (string-match
23962 "\\`\\*+\\'"
23963 (buffer-substring (point-at-bol) (point)))))))
23964 swallowp)
23965 (cond
23966 ((and subtreep org-yank-folded-subtrees)
23967 (let ((beg (point))
23968 end)
23969 (if (and subtreep org-yank-adjusted-subtrees)
23970 (org-paste-subtree nil nil 'for-yank)
23971 (call-interactively command))
23973 (setq end (point))
23974 (goto-char beg)
23975 (when (and (bolp) subtreep
23976 (not (setq swallowp
23977 (org-yank-folding-would-swallow-text beg end))))
23978 (org-with-limited-levels
23979 (or (looking-at org-outline-regexp)
23980 (re-search-forward org-outline-regexp-bol end t))
23981 (while (and (< (point) end) (looking-at org-outline-regexp))
23982 (hide-subtree)
23983 (org-cycle-show-empty-lines 'folded)
23984 (condition-case nil
23985 (outline-forward-same-level 1)
23986 (error (goto-char end))))))
23987 (when swallowp
23988 (message
23989 "Inserted text not folded because that would swallow text"))
23991 (goto-char end)
23992 (skip-chars-forward " \t\n\r")
23993 (beginning-of-line 1)
23994 (push-mark beg 'nomsg)))
23995 ((and subtreep org-yank-adjusted-subtrees)
23996 (let ((beg (point-at-bol)))
23997 (org-paste-subtree nil nil 'for-yank)
23998 (push-mark beg 'nomsg)))
24000 (call-interactively command))))))
24002 (defun org-yank-folding-would-swallow-text (beg end)
24003 "Would hide-subtree at BEG swallow any text after END?"
24004 (let (level)
24005 (org-with-limited-levels
24006 (save-excursion
24007 (goto-char beg)
24008 (when (or (looking-at org-outline-regexp)
24009 (re-search-forward org-outline-regexp-bol end t))
24010 (setq level (org-outline-level)))
24011 (goto-char end)
24012 (skip-chars-forward " \t\r\n\v\f")
24013 (if (or (eobp)
24014 (and (bolp) (looking-at org-outline-regexp)
24015 (<= (org-outline-level) level)))
24016 nil ; Nothing would be swallowed
24017 t))))) ; something would swallow
24019 (define-key org-mode-map "\C-y" 'org-yank)
24021 (defun org-truely-invisible-p ()
24022 "Check if point is at a character currently not visible.
24023 This version does not only check the character property, but also
24024 `visible-mode'."
24025 ;; Early versions of noutline don't have `outline-invisible-p'.
24026 (if (org-bound-and-true-p visible-mode)
24028 (outline-invisible-p)))
24030 (defun org-invisible-p2 ()
24031 "Check if point is at a character currently not visible."
24032 (save-excursion
24033 (if (and (eolp) (not (bobp))) (backward-char 1))
24034 ;; Early versions of noutline don't have `outline-invisible-p'.
24035 (outline-invisible-p)))
24037 (defun org-back-to-heading (&optional invisible-ok)
24038 "Call `outline-back-to-heading', but provide a better error message."
24039 (condition-case nil
24040 (outline-back-to-heading invisible-ok)
24041 (error (error "Before first headline at position %d in buffer %s"
24042 (point) (current-buffer)))))
24044 (defun org-before-first-heading-p ()
24045 "Before first heading?"
24046 (save-excursion
24047 (end-of-line)
24048 (null (re-search-backward org-outline-regexp-bol nil t))))
24050 (defun org-at-heading-p (&optional ignored)
24051 (outline-on-heading-p t))
24052 ;; Compatibility alias with Org versions < 7.8.03
24053 (defalias 'org-on-heading-p 'org-at-heading-p)
24055 (defun org-in-commented-heading-p (&optional no-inheritance)
24056 "Non-nil if point is under a commented heading.
24057 This function also checks ancestors of the current headline,
24058 unless optional argument NO-INHERITANCE is non-nil."
24059 (cond
24060 ((org-before-first-heading-p) nil)
24061 ((let ((headline (nth 4 (org-heading-components))))
24062 (and headline
24063 (let ((case-fold-search nil))
24064 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24065 headline)))))
24066 (no-inheritance nil)
24068 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24070 (defun org-at-comment-p nil
24071 "Is cursor in a commented line?"
24072 (save-excursion
24073 (save-match-data
24074 (beginning-of-line)
24075 (looking-at "^[ \t]*# "))))
24077 (defun org-at-drawer-p nil
24078 "Is cursor at a drawer keyword?"
24079 (save-excursion
24080 (move-beginning-of-line 1)
24081 (looking-at org-drawer-regexp)))
24083 (defun org-at-block-p nil
24084 "Is cursor at a block keyword?"
24085 (save-excursion
24086 (move-beginning-of-line 1)
24087 (looking-at org-block-regexp)))
24089 (defun org-point-at-end-of-empty-headline ()
24090 "If point is at the end of an empty headline, return t, else nil.
24091 If the heading only contains a TODO keyword, it is still still considered
24092 empty."
24093 (and (looking-at "[ \t]*$")
24094 (when org-todo-line-regexp
24095 (save-excursion
24096 (beginning-of-line 1)
24097 (let ((case-fold-search nil))
24098 (looking-at org-todo-line-regexp)
24099 (string= (match-string 3) ""))))))
24101 (defun org-at-heading-or-item-p ()
24102 (or (org-at-heading-p) (org-at-item-p)))
24104 (defun org-at-target-p ()
24105 (or (org-in-regexp org-radio-target-regexp)
24106 (org-in-regexp org-target-regexp)))
24107 ;; Compatibility alias with Org versions < 7.8.03
24108 (defalias 'org-on-target-p 'org-at-target-p)
24110 (defun org-up-heading-all (arg)
24111 "Move to the heading line of which the present line is a subheading.
24112 This function considers both visible and invisible heading lines.
24113 With argument, move up ARG levels."
24114 (if (fboundp 'outline-up-heading-all)
24115 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24116 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24118 (defun org-up-heading-safe ()
24119 "Move to the heading line of which the present line is a subheading.
24120 This version will not throw an error. It will return the level of the
24121 headline found, or nil if no higher level is found.
24123 Also, this function will be a lot faster than `outline-up-heading',
24124 because it relies on stars being the outline starters. This can really
24125 make a significant difference in outlines with very many siblings."
24126 (when (ignore-errors (org-back-to-heading t))
24127 (let ((level-up (1- (funcall outline-level))))
24128 (and (> level-up 0)
24129 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24130 (funcall outline-level)))))
24132 (defun org-first-sibling-p ()
24133 "Is this heading the first child of its parents?"
24134 (interactive)
24135 (let ((re org-outline-regexp-bol)
24136 level l)
24137 (unless (org-at-heading-p t)
24138 (user-error "Not at a heading"))
24139 (setq level (funcall outline-level))
24140 (save-excursion
24141 (if (not (re-search-backward re nil t))
24143 (setq l (funcall outline-level))
24144 (< l level)))))
24146 (defun org-goto-sibling (&optional previous)
24147 "Goto the next sibling, even if it is invisible.
24148 When PREVIOUS is set, go to the previous sibling instead. Returns t
24149 when a sibling was found. When none is found, return nil and don't
24150 move point."
24151 (let ((fun (if previous 're-search-backward 're-search-forward))
24152 (pos (point))
24153 (re org-outline-regexp-bol)
24154 level l)
24155 (when (ignore-errors (org-back-to-heading t))
24156 (setq level (funcall outline-level))
24157 (catch 'exit
24158 (or previous (forward-char 1))
24159 (while (funcall fun re nil t)
24160 (setq l (funcall outline-level))
24161 (when (< l level) (goto-char pos) (throw 'exit nil))
24162 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24163 (goto-char pos)
24164 nil))))
24166 (defun org-show-siblings ()
24167 "Show all siblings of the current headline."
24168 (save-excursion
24169 (while (org-goto-sibling) (org-flag-heading nil)))
24170 (save-excursion
24171 (while (org-goto-sibling 'previous)
24172 (org-flag-heading nil))))
24174 (defun org-goto-first-child ()
24175 "Goto the first child, even if it is invisible.
24176 Return t when a child was found. Otherwise don't move point and
24177 return nil."
24178 (let (level (pos (point)) (re org-outline-regexp-bol))
24179 (when (ignore-errors (org-back-to-heading t))
24180 (setq level (outline-level))
24181 (forward-char 1)
24182 (if (and (re-search-forward re nil t) (> (outline-level) level))
24183 (progn (goto-char (match-beginning 0)) t)
24184 (goto-char pos) nil))))
24186 (defun org-show-hidden-entry ()
24187 "Show an entry where even the heading is hidden."
24188 (save-excursion
24189 (org-show-entry)))
24191 (defun org-flag-heading (flag &optional entry)
24192 "Flag the current heading. FLAG non-nil means make invisible.
24193 When ENTRY is non-nil, show the entire entry."
24194 (save-excursion
24195 (org-back-to-heading t)
24196 ;; Check if we should show the entire entry
24197 (if entry
24198 (progn
24199 (org-show-entry)
24200 (save-excursion
24201 (and (outline-next-heading)
24202 (org-flag-heading nil))))
24203 (outline-flag-region (max (point-min) (1- (point)))
24204 (save-excursion (outline-end-of-heading) (point))
24205 flag))))
24207 (defun org-get-next-sibling ()
24208 "Move to next heading of the same level, and return point.
24209 If there is no such heading, return nil.
24210 This is like outline-next-sibling, but invisible headings are ok."
24211 (let ((level (funcall outline-level)))
24212 (outline-next-heading)
24213 (while (and (not (eobp)) (> (funcall outline-level) level))
24214 (outline-next-heading))
24215 (if (or (eobp) (< (funcall outline-level) level))
24217 (point))))
24219 (defun org-get-last-sibling ()
24220 "Move to previous heading of the same level, and return point.
24221 If there is no such heading, return nil."
24222 (let ((opoint (point))
24223 (level (funcall outline-level)))
24224 (outline-previous-heading)
24225 (when (and (/= (point) opoint) (outline-on-heading-p t))
24226 (while (and (> (funcall outline-level) level)
24227 (not (bobp)))
24228 (outline-previous-heading))
24229 (if (< (funcall outline-level) level)
24231 (point)))))
24233 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24234 "Goto to the end of a subtree."
24235 ;; This contains an exact copy of the original function, but it uses
24236 ;; `org-back-to-heading', to make it work also in invisible
24237 ;; trees. And is uses an invisible-ok argument.
24238 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24239 ;; Furthermore, when used inside Org, finding the end of a large subtree
24240 ;; with many children and grandchildren etc, this can be much faster
24241 ;; than the outline version.
24242 (org-back-to-heading invisible-ok)
24243 (let ((first t)
24244 (level (funcall outline-level)))
24245 (if (and (derived-mode-p 'org-mode) (< level 1000))
24246 ;; A true heading (not a plain list item), in Org-mode
24247 ;; This means we can easily find the end by looking
24248 ;; only for the right number of stars. Using a regexp to do
24249 ;; this is so much faster than using a Lisp loop.
24250 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24251 (forward-char 1)
24252 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24253 ;; something else, do it the slow way
24254 (while (and (not (eobp))
24255 (or first (> (funcall outline-level) level)))
24256 (setq first nil)
24257 (outline-next-heading)))
24258 (unless to-heading
24259 (if (memq (preceding-char) '(?\n ?\^M))
24260 (progn
24261 ;; Go to end of line before heading
24262 (forward-char -1)
24263 (if (memq (preceding-char) '(?\n ?\^M))
24264 ;; leave blank line before heading
24265 (forward-char -1))))))
24266 (point))
24268 (defun org-end-of-meta-data (&optional full)
24269 "Skip planning line and properties drawer in current entry.
24270 When optional argument FULL is non-nil, also skip empty lines,
24271 clocking lines and regular drawers at the beginning of the
24272 entry."
24273 (org-back-to-heading t)
24274 (forward-line)
24275 (when (org-looking-at-p org-planning-line-re) (forward-line))
24276 (when (looking-at org-property-drawer-re)
24277 (goto-char (match-end 0))
24278 (forward-line))
24279 (when (and full (not (org-at-heading-p)))
24280 (catch 'exit
24281 (let ((end (save-excursion (outline-next-heading) (point)))
24282 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24283 (while (not (eobp))
24284 (cond ((org-looking-at-p org-drawer-regexp)
24285 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24286 (forward-line)
24287 (throw 'exit t)))
24288 ((org-looking-at-p re) (forward-line))
24289 (t (throw 'exit t))))))))
24291 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24292 "Move forward to the ARG'th subheading at same level as this one.
24293 Stop at the first and last subheadings of a superior heading.
24294 Normally this only looks at visible headings, but when INVISIBLE-OK is
24295 non-nil it will also look at invisible ones."
24296 (interactive "p")
24297 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24298 (if (and arg (< arg 0))
24299 (goto-char (point-min))
24300 (outline-next-heading))
24301 (org-at-heading-p)
24302 (let ((level (- (match-end 0) (match-beginning 0) 1))
24303 (f (if (and arg (< arg 0))
24304 're-search-backward
24305 're-search-forward))
24306 (count (if arg (abs arg) 1))
24307 (result (point)))
24308 (while (and (prog1 (> count 0)
24309 (forward-char (if (and arg (< arg 0)) -1 1)))
24310 (funcall f org-outline-regexp-bol nil 'move))
24311 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24312 (cond ((< l level) (setq count 0))
24313 ((and (= l level)
24314 (or invisible-ok
24315 (progn
24316 (goto-char (line-beginning-position))
24317 (not (outline-invisible-p)))))
24318 (setq count (1- count))
24319 (when (eq l level)
24320 (setq result (point)))))))
24321 (goto-char result))
24322 (beginning-of-line 1)))
24324 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24325 "Move backward to the ARG'th subheading at same level as this one.
24326 Stop at the first and last subheadings of a superior heading."
24327 (interactive "p")
24328 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24330 (defun org-next-visible-heading (arg)
24331 "Move to the next visible heading.
24333 This function wraps `outline-next-visible-heading' with
24334 `org-with-limited-levels' in order to skip over inline tasks and
24335 respect customization of `org-odd-levels-only'."
24336 (interactive "p")
24337 (org-with-limited-levels
24338 (outline-next-visible-heading arg)))
24340 (defun org-previous-visible-heading (arg)
24341 "Move to the next visible heading.
24343 This function wraps `outline-previous-visible-heading' with
24344 `org-with-limited-levels' in order to skip over inline tasks and
24345 respect customization of `org-odd-levels-only'."
24346 (interactive "p")
24347 (org-with-limited-levels
24348 (outline-previous-visible-heading arg)))
24350 (defun org-next-block (arg &optional backward block-regexp)
24351 "Jump to the next block.
24352 With a prefix argument ARG, jump forward ARG many source blocks.
24353 When BACKWARD is non-nil, jump to the previous block.
24354 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24355 (interactive "p")
24356 (let ((re (or block-regexp org-block-regexp))
24357 (re-search-fn (or (and backward 're-search-backward)
24358 're-search-forward)))
24359 (if (looking-at re) (forward-char 1))
24360 (condition-case nil
24361 (funcall re-search-fn re nil nil arg)
24362 (error (user-error "No %s code blocks"
24363 (if backward "previous" "further" ))))
24364 (goto-char (match-beginning 0)) (org-show-context)))
24366 (defun org-previous-block (arg &optional block-regexp)
24367 "Jump to the previous block.
24368 With a prefix argument ARG, jump backward ARG many source blocks.
24369 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24370 (interactive "p")
24371 (org-next-block arg t block-regexp))
24373 (defun org-forward-paragraph ()
24374 "Move forward to beginning of next paragraph or equivalent.
24376 The function moves point to the beginning of the next visible
24377 structural element, which can be a paragraph, a table, a list
24378 item, etc. It also provides some special moves for convenience:
24380 - On an affiliated keyword, jump to the beginning of the
24381 relative element.
24382 - On an item or a footnote definition, move to the second
24383 element inside, if any.
24384 - On a table or a property drawer, jump after it.
24385 - On a verse or source block, stop after blank lines."
24386 (interactive)
24387 (when (eobp) (user-error "Cannot move further down"))
24388 (let* ((deactivate-mark nil)
24389 (element (org-element-at-point))
24390 (type (org-element-type element))
24391 (post-affiliated (org-element-property :post-affiliated element))
24392 (contents-begin (org-element-property :contents-begin element))
24393 (contents-end (org-element-property :contents-end element))
24394 (end (let ((end (org-element-property :end element)) (parent element))
24395 (while (and (setq parent (org-element-property :parent parent))
24396 (= (org-element-property :contents-end parent) end))
24397 (setq end (org-element-property :end parent)))
24398 end)))
24399 (cond ((not element)
24400 (skip-chars-forward " \r\t\n")
24401 (or (eobp) (beginning-of-line)))
24402 ;; On affiliated keywords, move to element's beginning.
24403 ((< (point) post-affiliated)
24404 (goto-char post-affiliated))
24405 ;; At a table row, move to the end of the table. Similarly,
24406 ;; at a node property, move to the end of the property
24407 ;; drawer.
24408 ((memq type '(node-property table-row))
24409 (goto-char (org-element-property
24410 :end (org-element-property :parent element))))
24411 ((memq type '(property-drawer table)) (goto-char end))
24412 ;; Consider blank lines as separators in verse and source
24413 ;; blocks to ease editing.
24414 ((memq type '(src-block verse-block))
24415 (when (eq type 'src-block)
24416 (setq contents-end
24417 (save-excursion (goto-char end)
24418 (skip-chars-backward " \r\t\n")
24419 (line-beginning-position))))
24420 (beginning-of-line)
24421 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24422 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24423 (goto-char end)
24424 (skip-chars-forward " \r\t\n")
24425 (if (= (point) contents-end) (goto-char end)
24426 (beginning-of-line))))
24427 ;; With no contents, just skip element.
24428 ((not contents-begin) (goto-char end))
24429 ;; If contents are invisible, skip the element altogether.
24430 ((outline-invisible-p (line-end-position))
24431 (case type
24432 (headline
24433 (org-with-limited-levels (outline-next-visible-heading 1)))
24434 ;; At a plain list, make sure we move to the next item
24435 ;; instead of skipping the whole list.
24436 (plain-list (forward-char)
24437 (org-forward-paragraph))
24438 (otherwise (goto-char end))))
24439 ((>= (point) contents-end) (goto-char end))
24440 ((>= (point) contents-begin)
24441 ;; This can only happen on paragraphs and plain lists.
24442 (case type
24443 (paragraph (goto-char end))
24444 ;; At a plain list, try to move to second element in
24445 ;; first item, if possible.
24446 (plain-list (end-of-line)
24447 (org-forward-paragraph))))
24448 ;; When contents start on the middle of a line (e.g. in
24449 ;; items and footnote definitions), try to reach first
24450 ;; element starting after current line.
24451 ((> (line-end-position) contents-begin)
24452 (end-of-line)
24453 (org-forward-paragraph))
24454 (t (goto-char contents-begin)))))
24456 (defun org-backward-paragraph ()
24457 "Move backward to start of previous paragraph or equivalent.
24459 The function moves point to the beginning of the current
24460 structural element, which can be a paragraph, a table, a list
24461 item, etc., or to the beginning of the previous visible one if
24462 point is already there. It also provides some special moves for
24463 convenience:
24465 - On an affiliated keyword, jump to the first one.
24466 - On a table or a property drawer, move to its beginning.
24467 - On a verse or source block, stop before blank lines."
24468 (interactive)
24469 (when (bobp) (user-error "Cannot move further up"))
24470 (let* ((deactivate-mark nil)
24471 (element (org-element-at-point))
24472 (type (org-element-type element))
24473 (contents-begin (org-element-property :contents-begin element))
24474 (contents-end (org-element-property :contents-end element))
24475 (post-affiliated (org-element-property :post-affiliated element))
24476 (begin (org-element-property :begin element)))
24477 (cond
24478 ((not element) (goto-char (point-min)))
24479 ((= (point) begin)
24480 (backward-char)
24481 (org-backward-paragraph))
24482 ((<= (point) post-affiliated) (goto-char begin))
24483 ((memq type '(node-property table-row))
24484 (goto-char (org-element-property
24485 :post-affiliated (org-element-property :parent element))))
24486 ((memq type '(property-drawer table)) (goto-char begin))
24487 ((memq type '(src-block verse-block))
24488 (when (eq type 'src-block)
24489 (setq contents-begin
24490 (save-excursion (goto-char begin) (forward-line) (point))))
24491 (if (= (point) contents-begin) (goto-char post-affiliated)
24492 ;; Inside a verse block, see blank lines as paragraph
24493 ;; separators.
24494 (let ((origin (point)))
24495 (skip-chars-backward " \r\t\n" contents-begin)
24496 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24497 (skip-chars-forward " \r\t\n" origin)
24498 (if (= (point) origin) (goto-char contents-begin)
24499 (beginning-of-line))))))
24500 ((not contents-begin) (goto-char (or post-affiliated begin)))
24501 ((eq type 'paragraph)
24502 (goto-char contents-begin)
24503 ;; When at first paragraph in an item or a footnote definition,
24504 ;; move directly to beginning of line.
24505 (let ((parent-contents
24506 (org-element-property
24507 :contents-begin (org-element-property :parent element))))
24508 (when (and parent-contents (= parent-contents contents-begin))
24509 (beginning-of-line))))
24510 ;; At the end of a greater element, move to the beginning of the
24511 ;; last element within.
24512 ((>= (point) contents-end)
24513 (goto-char (1- contents-end))
24514 (org-backward-paragraph))
24515 (t (goto-char (or post-affiliated begin))))
24516 ;; Ensure we never leave point invisible.
24517 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24519 (defun org-forward-element ()
24520 "Move forward by one element.
24521 Move to the next element at the same level, when possible."
24522 (interactive)
24523 (cond ((eobp) (user-error "Cannot move further down"))
24524 ((org-with-limited-levels (org-at-heading-p))
24525 (let ((origin (point)))
24526 (goto-char (org-end-of-subtree nil t))
24527 (unless (org-with-limited-levels (org-at-heading-p))
24528 (goto-char origin)
24529 (user-error "Cannot move further down"))))
24531 (let* ((elem (org-element-at-point))
24532 (end (org-element-property :end elem))
24533 (parent (org-element-property :parent elem)))
24534 (cond ((and parent (= (org-element-property :contents-end parent) end))
24535 (goto-char (org-element-property :end parent)))
24536 ((integer-or-marker-p end) (goto-char end))
24537 (t (message "No element at point")))))))
24539 (defun org-backward-element ()
24540 "Move backward by one element.
24541 Move to the previous element at the same level, when possible."
24542 (interactive)
24543 (cond ((bobp) (user-error "Cannot move further up"))
24544 ((org-with-limited-levels (org-at-heading-p))
24545 ;; At a headline, move to the previous one, if any, or stay
24546 ;; here.
24547 (let ((origin (point)))
24548 (org-with-limited-levels (org-backward-heading-same-level 1))
24549 ;; When current headline has no sibling above, move to its
24550 ;; parent.
24551 (when (= (point) origin)
24552 (or (org-with-limited-levels (org-up-heading-safe))
24553 (progn (goto-char origin)
24554 (user-error "Cannot move further up"))))))
24556 (let* ((elem (org-element-at-point))
24557 (beg (org-element-property :begin elem)))
24558 (cond
24559 ;; Move to beginning of current element if point isn't
24560 ;; there already.
24561 ((null beg) (message "No element at point"))
24562 ((/= (point) beg) (goto-char beg))
24563 (t (goto-char beg)
24564 (skip-chars-backward " \r\t\n")
24565 (unless (bobp)
24566 (let ((prev (org-element-at-point)))
24567 (goto-char (org-element-property :begin prev))
24568 (while (and (setq prev (org-element-property :parent prev))
24569 (<= (org-element-property :end prev) beg))
24570 (goto-char (org-element-property :begin prev)))))))))))
24572 (defun org-up-element ()
24573 "Move to upper element."
24574 (interactive)
24575 (if (org-with-limited-levels (org-at-heading-p))
24576 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24577 (let* ((elem (org-element-at-point))
24578 (parent (org-element-property :parent elem)))
24579 (if parent (goto-char (org-element-property :begin parent))
24580 (if (org-with-limited-levels (org-before-first-heading-p))
24581 (user-error "No surrounding element")
24582 (org-with-limited-levels (org-back-to-heading)))))))
24584 (defvar org-element-greater-elements)
24585 (defun org-down-element ()
24586 "Move to inner element."
24587 (interactive)
24588 (let ((element (org-element-at-point)))
24589 (cond
24590 ((memq (org-element-type element) '(plain-list table))
24591 (goto-char (org-element-property :contents-begin element))
24592 (forward-char))
24593 ((memq (org-element-type element) org-element-greater-elements)
24594 ;; If contents are hidden, first disclose them.
24595 (when (outline-invisible-p (line-end-position)) (org-cycle))
24596 (goto-char (or (org-element-property :contents-begin element)
24597 (user-error "No content for this element"))))
24598 (t (user-error "No inner element")))))
24600 (defun org-drag-element-backward ()
24601 "Move backward element at point."
24602 (interactive)
24603 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24604 (let* ((elem (org-element-at-point))
24605 (prev-elem
24606 (save-excursion
24607 (goto-char (org-element-property :begin elem))
24608 (skip-chars-backward " \r\t\n")
24609 (unless (bobp)
24610 (let* ((beg (org-element-property :begin elem))
24611 (prev (org-element-at-point))
24612 (up prev))
24613 (while (and (setq up (org-element-property :parent up))
24614 (<= (org-element-property :end up) beg))
24615 (setq prev up))
24616 prev)))))
24617 ;; Error out if no previous element or previous element is
24618 ;; a parent of the current one.
24619 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24620 (user-error "Cannot drag element backward")
24621 (let ((pos (point)))
24622 (org-element-swap-A-B prev-elem elem)
24623 (goto-char (+ (org-element-property :begin prev-elem)
24624 (- pos (org-element-property :begin elem)))))))))
24626 (defun org-drag-element-forward ()
24627 "Move forward element at point."
24628 (interactive)
24629 (let* ((pos (point))
24630 (elem (org-element-at-point)))
24631 (when (= (point-max) (org-element-property :end elem))
24632 (user-error "Cannot drag element forward"))
24633 (goto-char (org-element-property :end elem))
24634 (let ((next-elem (org-element-at-point)))
24635 (when (or (org-element-nested-p elem next-elem)
24636 (and (eq (org-element-type next-elem) 'headline)
24637 (not (eq (org-element-type elem) 'headline))))
24638 (goto-char pos)
24639 (user-error "Cannot drag element forward"))
24640 ;; Compute new position of point: it's shifted by NEXT-ELEM
24641 ;; body's length (without final blanks) and by the length of
24642 ;; blanks between ELEM and NEXT-ELEM.
24643 (let ((size-next (- (save-excursion
24644 (goto-char (org-element-property :end next-elem))
24645 (skip-chars-backward " \r\t\n")
24646 (forward-line)
24647 ;; Small correction if buffer doesn't end
24648 ;; with a newline character.
24649 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24650 (org-element-property :begin next-elem)))
24651 (size-blank (- (org-element-property :end elem)
24652 (save-excursion
24653 (goto-char (org-element-property :end elem))
24654 (skip-chars-backward " \r\t\n")
24655 (forward-line)
24656 (point)))))
24657 (org-element-swap-A-B elem next-elem)
24658 (goto-char (+ pos size-next size-blank))))))
24660 (defun org-drag-line-forward (arg)
24661 "Drag the line at point ARG lines forward."
24662 (interactive "p")
24663 (dotimes (n (abs arg))
24664 (let ((c (current-column)))
24665 (if (< 0 arg)
24666 (progn
24667 (beginning-of-line 2)
24668 (transpose-lines 1)
24669 (beginning-of-line 0))
24670 (transpose-lines 1)
24671 (beginning-of-line -1))
24672 (org-move-to-column c))))
24674 (defun org-drag-line-backward (arg)
24675 "Drag the line at point ARG lines backward."
24676 (interactive "p")
24677 (org-drag-line-forward (- arg)))
24679 (defun org-mark-element ()
24680 "Put point at beginning of this element, mark at end.
24682 Interactively, if this command is repeated or (in Transient Mark
24683 mode) if the mark is active, it marks the next element after the
24684 ones already marked."
24685 (interactive)
24686 (let (deactivate-mark)
24687 (if (and (org-called-interactively-p 'any)
24688 (or (and (eq last-command this-command) (mark t))
24689 (and transient-mark-mode mark-active)))
24690 (set-mark
24691 (save-excursion
24692 (goto-char (mark))
24693 (goto-char (org-element-property :end (org-element-at-point)))))
24694 (let ((element (org-element-at-point)))
24695 (end-of-line)
24696 (push-mark (org-element-property :end element) t t)
24697 (goto-char (org-element-property :begin element))))))
24699 (defun org-narrow-to-element ()
24700 "Narrow buffer to current element."
24701 (interactive)
24702 (let ((elem (org-element-at-point)))
24703 (cond
24704 ((eq (car elem) 'headline)
24705 (narrow-to-region
24706 (org-element-property :begin elem)
24707 (org-element-property :end elem)))
24708 ((memq (car elem) org-element-greater-elements)
24709 (narrow-to-region
24710 (org-element-property :contents-begin elem)
24711 (org-element-property :contents-end elem)))
24713 (narrow-to-region
24714 (org-element-property :begin elem)
24715 (org-element-property :end elem))))))
24717 (defun org-transpose-element ()
24718 "Transpose current and previous elements, keeping blank lines between.
24719 Point is moved after both elements."
24720 (interactive)
24721 (org-skip-whitespace)
24722 (let ((end (org-element-property :end (org-element-at-point))))
24723 (org-drag-element-backward)
24724 (goto-char end)))
24726 (defun org-unindent-buffer ()
24727 "Un-indent the visible part of the buffer.
24728 Relative indentation (between items, inside blocks, etc.) isn't
24729 modified."
24730 (interactive)
24731 (unless (eq major-mode 'org-mode)
24732 (user-error "Cannot un-indent a buffer not in Org mode"))
24733 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24734 unindent-tree ; For byte-compiler.
24735 (unindent-tree
24736 (function
24737 (lambda (contents)
24738 (mapc
24739 (lambda (element)
24740 (if (memq (org-element-type element) '(headline section))
24741 (funcall unindent-tree (org-element-contents element))
24742 (save-excursion
24743 (save-restriction
24744 (narrow-to-region
24745 (org-element-property :begin element)
24746 (org-element-property :end element))
24747 (org-do-remove-indentation)))))
24748 (reverse contents))))))
24749 (funcall unindent-tree (org-element-contents parse-tree))))
24751 (defun org-show-subtree ()
24752 "Show everything after this heading at deeper levels."
24753 (interactive)
24754 (outline-flag-region
24755 (point)
24756 (save-excursion
24757 (org-end-of-subtree t t))
24758 nil))
24760 (defun org-show-entry ()
24761 "Show the body directly following this heading.
24762 Show the heading too, if it is currently invisible."
24763 (interactive)
24764 (save-excursion
24765 (ignore-errors
24766 (org-back-to-heading t)
24767 (outline-flag-region
24768 (max (point-min) (1- (point)))
24769 (save-excursion
24770 (if (re-search-forward
24771 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24772 (match-beginning 1)
24773 (point-max)))
24774 nil)
24775 (org-cycle-hide-drawers 'children))))
24777 (defun org-make-options-regexp (kwds &optional extra)
24778 "Make a regular expression for keyword lines.
24779 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24780 when non-nil, is a regexp matching keywords names."
24781 (concat "^[ \t]*#\\+\\("
24782 (regexp-opt kwds)
24783 (and extra (concat (and kwds "\\|") extra))
24784 "\\):[ \t]*\\(.*\\)"))
24786 ;; Make isearch reveal the necessary context
24787 (defun org-isearch-end ()
24788 "Reveal context after isearch exits."
24789 (when isearch-success ; only if search was successful
24790 (if (featurep 'xemacs)
24791 ;; Under XEmacs, the hook is run in the correct place,
24792 ;; we directly show the context.
24793 (org-show-context 'isearch)
24794 ;; In Emacs the hook runs *before* restoring the overlays.
24795 ;; So we have to use a one-time post-command-hook to do this.
24796 ;; (Emacs 22 has a special variable, see function `org-mode')
24797 (unless (and (boundp 'isearch-mode-end-hook-quit)
24798 isearch-mode-end-hook-quit)
24799 ;; Only when the isearch was not quitted.
24800 (org-add-hook 'post-command-hook 'org-isearch-post-command
24801 'append 'local)))))
24803 (defun org-isearch-post-command ()
24804 "Remove self from hook, and show context."
24805 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24806 (org-show-context 'isearch))
24809 ;;;; Integration with and fixes for other packages
24811 ;;; Imenu support
24813 (defvar org-imenu-markers nil
24814 "All markers currently used by Imenu.")
24815 (make-variable-buffer-local 'org-imenu-markers)
24817 (defun org-imenu-new-marker (&optional pos)
24818 "Return a new marker for use by Imenu, and remember the marker."
24819 (let ((m (make-marker)))
24820 (move-marker m (or pos (point)))
24821 (push m org-imenu-markers)
24824 (defun org-imenu-get-tree ()
24825 "Produce the index for Imenu."
24826 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24827 (setq org-imenu-markers nil)
24828 (let* ((n org-imenu-depth)
24829 (re (concat "^" (org-get-limited-outline-regexp)))
24830 (subs (make-vector (1+ n) nil))
24831 (last-level 0)
24832 m level head0 head)
24833 (save-excursion
24834 (save-restriction
24835 (widen)
24836 (goto-char (point-max))
24837 (while (re-search-backward re nil t)
24838 (setq level (org-reduced-level (funcall outline-level)))
24839 (when (and (<= level n)
24840 (looking-at org-complex-heading-regexp)
24841 (setq head0 (org-match-string-no-properties 4)))
24842 (setq head (org-link-display-format head0)
24843 m (org-imenu-new-marker))
24844 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24845 (if (>= level last-level)
24846 (push (cons head m) (aref subs level))
24847 (push (cons head (aref subs (1+ level))) (aref subs level))
24848 (loop for i from (1+ level) to n do (aset subs i nil)))
24849 (setq last-level level)))))
24850 (aref subs 1)))
24852 (eval-after-load "imenu"
24853 '(progn
24854 (add-hook 'imenu-after-jump-hook
24855 (lambda ()
24856 (if (derived-mode-p 'org-mode)
24857 (org-show-context 'org-goto))))))
24859 (defun org-link-display-format (link)
24860 "Replace a link with its the description.
24861 If there is no description, use the link target."
24862 (save-match-data
24863 (if (string-match org-bracket-link-analytic-regexp link)
24864 (replace-match (if (match-end 5)
24865 (match-string 5 link)
24866 (concat (match-string 1 link)
24867 (match-string 3 link)))
24868 nil t link)
24869 link)))
24871 (defun org-toggle-link-display ()
24872 "Toggle the literal or descriptive display of links."
24873 (interactive)
24874 (if org-descriptive-links
24875 (progn (org-remove-from-invisibility-spec '(org-link))
24876 (org-restart-font-lock)
24877 (setq org-descriptive-links nil))
24878 (progn (add-to-invisibility-spec '(org-link))
24879 (org-restart-font-lock)
24880 (setq org-descriptive-links t))))
24882 ;; Speedbar support
24884 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24885 "Overlay marking the agenda restriction line in speedbar.")
24886 (overlay-put org-speedbar-restriction-lock-overlay
24887 'face 'org-agenda-restriction-lock)
24888 (overlay-put org-speedbar-restriction-lock-overlay
24889 'help-echo "Agendas are currently limited to this item.")
24890 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24892 (defun org-speedbar-set-agenda-restriction ()
24893 "Restrict future agenda commands to the location at point in speedbar.
24894 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24895 (interactive)
24896 (require 'org-agenda)
24897 (let (p m tp np dir txt)
24898 (cond
24899 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24900 'org-imenu t))
24901 (setq m (get-text-property p 'org-imenu-marker))
24902 (with-current-buffer (marker-buffer m)
24903 (goto-char m)
24904 (org-agenda-set-restriction-lock 'subtree)))
24905 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24906 'speedbar-function 'speedbar-find-file))
24907 (setq tp (previous-single-property-change
24908 (1+ p) 'speedbar-function)
24909 np (next-single-property-change
24910 tp 'speedbar-function)
24911 dir (speedbar-line-directory)
24912 txt (buffer-substring-no-properties (or tp (point-min))
24913 (or np (point-max))))
24914 (with-current-buffer (find-file-noselect
24915 (let ((default-directory dir))
24916 (expand-file-name txt)))
24917 (unless (derived-mode-p 'org-mode)
24918 (user-error "Cannot restrict to non-Org-mode file"))
24919 (org-agenda-set-restriction-lock 'file)))
24920 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24921 (move-overlay org-speedbar-restriction-lock-overlay
24922 (point-at-bol) (point-at-eol))
24923 (setq current-prefix-arg nil)
24924 (org-agenda-maybe-redo)))
24926 (defvar speedbar-file-key-map)
24927 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24928 (eval-after-load "speedbar"
24929 '(progn
24930 (speedbar-add-supported-extension ".org")
24931 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24932 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24933 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24934 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24935 (add-hook 'speedbar-visiting-tag-hook
24936 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24938 ;;; Fixes and Hacks for problems with other packages
24940 (defun org--flyspell-object-check-p (element)
24941 "Non-nil when Flyspell can check object at point.
24942 ELEMENT is the element at point."
24943 (let ((object (save-excursion
24944 (when (org-looking-at-p "\\>") (backward-char))
24945 (org-element-context element))))
24946 (case (org-element-type object)
24947 ;; Prevent checks in links due to keybinding conflict with
24948 ;; Flyspell.
24949 ((code entity export-snippet inline-babel-call
24950 inline-src-block line-break latex-fragment link macro
24951 statistics-cookie target timestamp verbatim)
24952 nil)
24953 (footnote-reference
24954 ;; Only in inline footnotes, within the definition.
24955 (and (eq (org-element-property :type object) 'inline)
24956 (< (save-excursion
24957 (goto-char (org-element-property :begin object))
24958 (search-forward ":" nil t 2))
24959 (point))))
24960 (otherwise t))))
24962 (defun org-mode-flyspell-verify ()
24963 "Function used for `flyspell-generic-check-word-predicate'."
24964 (if (org-at-heading-p)
24965 ;; At a headline or an inlinetask, check title only. This is
24966 ;; faster than relying on `org-element-at-point'.
24967 (and (save-excursion (beginning-of-line)
24968 (and (let ((case-fold-search t))
24969 (not (looking-at "\\*+ END[ \t]*$")))
24970 (looking-at org-complex-heading-regexp)))
24971 (match-beginning 4)
24972 (>= (point) (match-beginning 4))
24973 (or (not (match-beginning 5))
24974 (< (point) (match-beginning 5))))
24975 (let* ((element (org-element-at-point))
24976 (post-affiliated (org-element-property :post-affiliated element)))
24977 (cond
24978 ;; Ignore checks in all affiliated keywords but captions.
24979 ((< (point) post-affiliated)
24980 (and (save-excursion
24981 (beginning-of-line)
24982 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24983 (> (point) (match-end 0))
24984 (org--flyspell-object-check-p element)))
24985 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24986 ((let ((log (org-log-into-drawer)))
24987 (and log
24988 (let ((drawer (org-element-lineage element '(drawer))))
24989 (and drawer
24990 (eq (compare-strings
24991 log nil nil
24992 (org-element-property :drawer-name drawer) nil nil t)
24993 t)))))
24994 nil)
24996 (case (org-element-type element)
24997 ((comment quote-section) t)
24998 (comment-block
24999 ;; Allow checks between block markers, not on them.
25000 (and (> (line-beginning-position) post-affiliated)
25001 (save-excursion
25002 (end-of-line)
25003 (skip-chars-forward " \r\t\n")
25004 (< (point) (org-element-property :end element)))))
25005 ;; Arbitrary list of keywords where checks are meaningful.
25006 ;; Make sure point is on the value part of the element.
25007 (keyword
25008 (and (member (org-element-property :key element)
25009 '("DESCRIPTION" "TITLE"))
25010 (save-excursion
25011 (search-backward ":" (line-beginning-position) t))))
25012 ;; Check is globally allowed in paragraphs verse blocks and
25013 ;; table rows (after affiliated keywords) but some objects
25014 ;; must not be affected.
25015 ((paragraph table-row verse-block)
25016 (let ((cbeg (org-element-property :contents-begin element))
25017 (cend (org-element-property :contents-end element)))
25018 (and cbeg (>= (point) cbeg) (< (point) cend)
25019 (org--flyspell-object-check-p element))))))))))
25020 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25022 (defun org-remove-flyspell-overlays-in (beg end)
25023 "Remove flyspell overlays in region."
25024 (and (org-bound-and-true-p flyspell-mode)
25025 (fboundp 'flyspell-delete-region-overlays)
25026 (flyspell-delete-region-overlays beg end)))
25028 (defvar flyspell-delayed-commands)
25029 (eval-after-load "flyspell"
25030 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25032 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25033 (eval-after-load "bookmark"
25034 '(if (boundp 'bookmark-after-jump-hook)
25035 ;; We can use the hook
25036 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25037 ;; Hook not available, use advice
25038 (defadvice bookmark-jump (after org-make-visible activate)
25039 "Make the position visible."
25040 (org-bookmark-jump-unhide))))
25042 ;; Make sure saveplace shows the location if it was hidden
25043 (eval-after-load "saveplace"
25044 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25045 "Make the position visible."
25046 (org-bookmark-jump-unhide)))
25048 ;; Make sure ecb shows the location if it was hidden
25049 (eval-after-load "ecb"
25050 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25051 "Make hierarchy visible when jumping into location from ECB tree buffer."
25052 (if (derived-mode-p 'org-mode)
25053 (org-show-context))))
25055 (defun org-bookmark-jump-unhide ()
25056 "Unhide the current position, to show the bookmark location."
25057 (and (derived-mode-p 'org-mode)
25058 (or (outline-invisible-p)
25059 (save-excursion (goto-char (max (point-min) (1- (point))))
25060 (outline-invisible-p)))
25061 (org-show-context 'bookmark-jump)))
25063 (defun org-mark-jump-unhide ()
25064 "Make the point visible with `org-show-context' after jumping to the mark."
25065 (when (and (derived-mode-p 'org-mode)
25066 (outline-invisible-p))
25067 (org-show-context 'mark-goto)))
25069 (eval-after-load "simple"
25070 '(defadvice pop-to-mark-command (after org-make-visible activate)
25071 "Make the point visible with `org-show-context'."
25072 (org-mark-jump-unhide)))
25074 (eval-after-load "simple"
25075 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25076 "Make the point visible with `org-show-context'."
25077 (org-mark-jump-unhide)))
25079 (eval-after-load "simple"
25080 '(defadvice pop-global-mark (after org-make-visible activate)
25081 "Make the point visible with `org-show-context'."
25082 (org-mark-jump-unhide)))
25084 ;; Make session.el ignore our circular variable
25085 (defvar session-globals-exclude)
25086 (eval-after-load "session"
25087 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25089 ;;;; Finish up
25091 (provide 'org)
25093 (run-hooks 'org-load-hook)
25095 ;;; org.el ends here