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.
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/>.
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
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
50 ;; http://orgmode.org/org.html#Installation
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
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
78 (require 'format-spec
)
80 (or (equal this-command
'eval-buffer
)
82 (load (concat (file-name-directory load-file-name
)
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
94 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
95 ;; some places -- e.g. see the macro `org-with-limited-levels'.
97 ;; In Org buffers, the value of `outline-regexp' is that of
98 ;; `org-outline-regexp'. The only function still directly relying on
99 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
100 ;; job when `orgstruct-mode' is active.
101 (defvar org-outline-regexp
"\\*+ "
102 "Regexp to match Org headlines.")
104 (defvar org-outline-regexp-bol
"^\\*+ "
105 "Regexp to match Org headlines.
106 This is similar to `org-outline-regexp' but additionally makes
107 sure that we are at the beginning of the line.")
109 (defvar org-heading-regexp
"^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
110 "Matches a headline, putting stars and text into groups.
111 Stars are put in group 1 and the trimmed body in group 2.")
113 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
114 (unless (boundp 'calendar-view-holidays-initially-flag
)
115 (org-defvaralias 'calendar-view-holidays-initially-flag
116 'view-calendar-holidays-initially
))
117 (unless (boundp 'calendar-view-diary-initially-flag
)
118 (org-defvaralias 'calendar-view-diary-initially-flag
119 'view-diary-entries-initially
))
120 (unless (boundp 'diary-fancy-buffer
)
121 (org-defvaralias 'diary-fancy-buffer
'fancy-diary-buffer
))
123 (declare-function cdlatex-environment
"ext:cdlatex" (environment item
))
124 (declare-function org-add-archive-files
"org-archive" (files))
125 (declare-function org-agenda-entry-get-agenda-timestamp
"org-agenda" (pom))
126 (declare-function org-agenda-list
"org-agenda" (&optional arg start-day span
))
127 (declare-function org-agenda-redo
"org-agenda" (&optional all
))
128 (declare-function org-babel-do-in-edit-buffer
"ob-core" (&rest body
))
129 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
130 (declare-function org-beamer-mode
"ox-beamer" ())
131 (declare-function org-clock-get-last-clock-out-time
"org-clock" ())
132 (declare-function org-clock-out
"org-clock" (&optional switch-to-state fail-quietly at-time
))
133 (declare-function org-clock-remove-overlays
"org-clock" (&optional beg end noremove
))
134 (declare-function org-clock-sum
"org-clock" (&optional tstart tend headline-filter propname
))
135 (declare-function org-clock-sum-current-item
"org-clock" (&optional tstart
))
136 (declare-function org-clock-timestamps-down
"org-clock" (&optional n
))
137 (declare-function org-clock-timestamps-up
"org-clock" (&optional n
))
138 (declare-function org-clock-update-time-maybe
"org-clock" ())
139 (declare-function org-clocktable-shift
"org-clock" (dir n
))
140 (declare-function org-element-at-point
"org-element" ())
141 (declare-function org-element-cache-refresh
"org-element" (pos))
142 (declare-function org-element-cache-reset
"org-element" (&optional all
))
143 (declare-function org-element-contents
"org-element" (element))
144 (declare-function org-element-context
"org-element" (&optional element
))
145 (declare-function org-element-copy
"org-element" (datum))
146 (declare-function org-element-interpret-data
"org-element" (data &optional parent
))
147 (declare-function org-element-lineage
"org-element" (blob &optional types with-self
))
148 (declare-function org-element-nested-p
"org-element" (elem-a elem-b
))
149 (declare-function org-element-parse-buffer
"org-element" (&optional granularity visible-only
))
150 (declare-function org-element-property
"org-element" (property element
))
151 (declare-function org-element-put-property
"org-element" (element property value
))
152 (declare-function org-element-swap-A-B
"org-element" (elem-a elem-b
))
153 (declare-function org-element-type
"org-element" (element))
154 (declare-function org-element-update-syntax
"org-element" ())
155 (declare-function org-id-find-id-file
"org-id" (id))
156 (declare-function org-id-get-create
"org-id" (&optional force
))
157 (declare-function org-inlinetask-at-task-p
"org-inlinetask" ())
158 (declare-function org-inlinetask-outline-regexp
"org-inlinetask" ())
159 (declare-function org-inlinetask-toggle-visibility
"org-inlinetask" ())
160 (declare-function org-plot
/gnuplot
"org-plot" (&optional params
))
161 (declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label
))
162 (declare-function org-table-align
"org-table" ())
163 (declare-function org-table-begin
"org-table" (&optional table-type
))
164 (declare-function org-table-beginning-of-field
"org-table" (&optional n
))
165 (declare-function org-table-blank-field
"org-table" ())
166 (declare-function org-table-calc-current-TBLFM
"org-table" (&optional arg
))
167 (declare-function org-table-edit-field
"org-table" (arg))
168 (declare-function org-table-end
"org-table" (&optional table-type
))
169 (declare-function org-table-end-of-field
"org-table" (&optional n
))
170 (declare-function org-table-insert-row
"org-table" (&optional arg
))
171 (declare-function org-table-justify-field-maybe
"org-table" (&optional new
))
172 (declare-function org-table-maybe-eval-formula
"org-table" ())
173 (declare-function org-table-maybe-recalculate-line
"org-table" ())
174 (declare-function org-table-next-row
"org-table" ())
175 (declare-function org-table-paste-rectangle
"org-table" ())
176 (declare-function org-tags-view
"org-agenda" (&optional todo-only match
))
177 (declare-function orgtbl-ascii-plot
"org-table" (&optional ask
))
178 (declare-function orgtbl-mode
"org-table" (&optional arg
))
180 (defsubst org-uniquify
(list)
181 "Non-destructively remove duplicate elements from LIST."
182 (let ((res (copy-sequence list
))) (delete-dups res
)))
184 (defsubst org-get-at-bol
(property)
185 "Get text property PROPERTY at the beginning of line."
186 (get-text-property (point-at-bol) property
))
188 (defsubst org-trim
(s)
189 "Remove whitespace at the beginning and the end of string S."
190 (replace-regexp-in-string
192 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s
)))
194 ;; load languages based on value of `org-babel-load-languages'
195 (defvar org-babel-load-languages
)
198 (defun org-babel-do-load-languages (sym value
)
199 "Load the languages defined in `org-babel-load-languages'."
200 (set-default sym value
)
202 (let ((active (cdr pair
)) (lang (symbol-name (car pair
))))
205 (require (intern (concat "ob-" lang
))))
207 (funcall 'fmakunbound
208 (intern (concat "org-babel-execute:" lang
)))
209 (funcall 'fmakunbound
210 (intern (concat "org-babel-expand-body:" lang
)))))))
211 org-babel-load-languages
))
213 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
215 (defun org-babel-load-file (file &optional compile
)
216 "Load Emacs Lisp source code blocks in the Org-mode FILE.
217 This function exports the source code using `org-babel-tangle'
218 and then loads the resulting file using `load-file'. With prefix
219 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
220 file to byte-code before it is loaded."
221 (interactive "fFile to load: \nP")
222 (let* ((age (lambda (file)
224 (time-subtract (current-time)
225 (nth 5 (or (file-attributes (file-truename file
))
226 (file-attributes file
)))))))
227 (base-name (file-name-sans-extension file
))
228 (exported-file (concat base-name
".el")))
229 ;; tangle if the org-mode file is newer than the elisp file
230 (unless (and (file-exists-p exported-file
)
231 (> (funcall age file
) (funcall age exported-file
)))
232 ;; Tangle-file traversal returns reversed list of tangled files
233 ;; and we want to evaluate the first target.
235 (car (last (org-babel-tangle-file file exported-file
"emacs-lisp")))))
238 (progn (byte-compile-file exported-file
'load
)
239 "Compiled and loaded")
240 (progn (load-file exported-file
) "Loaded"))
243 (defcustom org-babel-load-languages
'((emacs-lisp . t
))
244 "Languages which can be evaluated in Org-mode buffers.
245 This list can be used to load support for any of the languages
246 below, note that each language will depend on a different set of
247 system executables and/or Emacs modes. When a language is
248 \"loaded\", then code blocks in that language can be evaluated
249 with `org-babel-execute-src-block' bound by default to C-c
250 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
251 be set to remove code block evaluation from the C-c C-c
252 keybinding. By default only Emacs Lisp (which has no
253 requirements) is loaded."
255 :set
'org-babel-do-load-languages
257 :type
'(alist :tag
"Babel Languages"
260 (const :tag
"Awk" awk
)
263 (const :tag
"Asymptote" asymptote
)
264 (const :tag
"Calc" calc
)
265 (const :tag
"Clojure" clojure
)
266 (const :tag
"CSS" css
)
267 (const :tag
"Ditaa" ditaa
)
268 (const :tag
"Dot" dot
)
269 (const :tag
"Emacs Lisp" emacs-lisp
)
270 (const :tag
"Forth" forth
)
271 (const :tag
"Fortran" fortran
)
272 (const :tag
"Gnuplot" gnuplot
)
273 (const :tag
"Haskell" haskell
)
276 (const :tag
"Java" java
)
277 (const :tag
"Javascript" js
)
278 (const :tag
"LaTeX" latex
)
279 (const :tag
"Ledger" ledger
)
280 (const :tag
"Lilypond" lilypond
)
281 (const :tag
"Lisp" lisp
)
282 (const :tag
"Makefile" makefile
)
283 (const :tag
"Maxima" maxima
)
284 (const :tag
"Matlab" matlab
)
285 (const :tag
"Mscgen" mscgen
)
286 (const :tag
"Ocaml" ocaml
)
287 (const :tag
"Octave" octave
)
288 (const :tag
"Org" org
)
289 (const :tag
"Perl" perl
)
290 (const :tag
"Pico Lisp" picolisp
)
291 (const :tag
"PlantUML" plantuml
)
292 (const :tag
"Python" python
)
293 (const :tag
"Ruby" ruby
)
294 (const :tag
"Sass" sass
)
295 (const :tag
"Scala" scala
)
296 (const :tag
"Scheme" scheme
)
297 (const :tag
"Screen" screen
)
298 (const :tag
"Shell Script" shell
)
299 (const :tag
"Shen" shen
)
300 (const :tag
"Sql" sql
)
301 (const :tag
"Sqlite" sqlite
)
302 (const :tag
"ebnf2ps" ebnf2ps
))
303 :value-type
(boolean :tag
"Activate" :value t
)))
305 ;;;; Customization variables
306 (defcustom org-clone-delete-id nil
307 "Remove ID property of clones of a subtree.
308 When non-nil, clones of a subtree don't inherit the ID property.
309 Otherwise they inherit the ID property with a new unique
319 (defun org-version (&optional here full message
)
320 "Show the org-mode version.
321 Interactively, or when MESSAGE is non-nil, show it in echo area.
322 With prefix argument, or when HERE is non-nil, insert it at point.
323 In non-interactive uses, a reduced version string is output unless
325 (interactive (list current-prefix-arg t
(not current-prefix-arg
)))
326 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
327 (save-load-suffixes (when (boundp 'load-suffixes
) load-suffixes
))
328 (load-suffixes (list ".el"))
329 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
331 (and (fboundp 'org-release
) (fboundp 'org-git-version
))
332 (org-load-noerror-mustsuffix (concat org-dir
"org-version"))))
333 (load-suffixes save-load-suffixes
)
334 (org-version (org-release))
335 (git-version (org-git-version))
336 (version (format "Org-mode version %s (%s @ %s)"
340 (if (string= org-dir org-install-dir
)
342 (concat "mixed installation! " org-install-dir
" and " org-dir
))
343 "org-loaddefs.el can not be found!")))
344 (version1 (if full version org-version
)))
345 (when here
(insert version1
))
346 (when message
(message "%s" version1
))
349 (defconst org-version
(org-version))
356 (defconst org-block-regexp
357 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
358 "Regular expression for hiding blocks.")
360 (defconst org-dblock-start-re
361 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
362 "Matches the start line of a dynamic block, with parameters.")
364 (defconst org-dblock-end-re
"^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
365 "Matches the end of a dynamic block.")
367 ;;;; Clock and Planning
369 (defconst org-clock-string
"CLOCK:"
370 "String used as prefix for timestamps clocking work hours on an item.")
372 (defvar org-closed-string
"CLOSED:"
373 "String used as the prefix for timestamps logging closing a TODO entry.")
375 (defvar org-deadline-string
"DEADLINE:"
376 "String to mark deadline entries.
377 A deadline is this string, followed by a time stamp. Should be a word,
378 terminated by a colon. You can insert a schedule keyword and
379 a timestamp with \\[org-deadline].")
381 (defvar org-scheduled-string
"SCHEDULED:"
382 "String to mark scheduled TODO entries.
383 A schedule is this string, followed by a time stamp. Should be a word,
384 terminated by a colon. You can insert a schedule keyword and
385 a timestamp with \\[org-schedule].")
387 (defconst org-ds-keyword-length
391 (list org-deadline-string org-scheduled-string
392 org-clock-string org-closed-string
))))
393 "Maximum length of the DEADLINE and SCHEDULED keywords.")
395 (defconst org-planning-line-re
398 (list org-closed-string org-deadline-string org-scheduled-string
)
400 "Matches a line with planning info.
401 Matched keyword is in group 1.")
403 (defconst org-clock-line-re
404 (concat "^[ \t]*" org-clock-string
)
405 "Matches a line with clock info.")
407 (defconst org-deadline-regexp
(concat "\\<" org-deadline-string
)
408 "Matches the DEADLINE keyword.")
410 (defconst org-deadline-time-regexp
411 (concat "\\<" org-deadline-string
" *<\\([^>]+\\)>")
412 "Matches the DEADLINE keyword together with a time stamp.")
414 (defconst org-deadline-time-hour-regexp
415 (concat "\\<" org-deadline-string
416 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
417 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
419 (defconst org-deadline-line-regexp
420 (concat "\\<\\(" org-deadline-string
"\\).*")
421 "Matches the DEADLINE keyword and the rest of the line.")
423 (defconst org-scheduled-regexp
(concat "\\<" org-scheduled-string
)
424 "Matches the SCHEDULED keyword.")
426 (defconst org-scheduled-time-regexp
427 (concat "\\<" org-scheduled-string
" *<\\([^>]+\\)>")
428 "Matches the SCHEDULED keyword together with a time stamp.")
430 (defconst org-scheduled-time-hour-regexp
431 (concat "\\<" org-scheduled-string
432 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
433 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
435 (defconst org-closed-time-regexp
436 (concat "\\<" org-closed-string
" *\\[\\([^]]+\\)\\]")
437 "Matches the CLOSED keyword together with a time stamp.")
439 (defconst org-keyword-time-regexp
442 (list org-scheduled-string org-deadline-string org-closed-string
445 " *[[<]\\([^]>]+\\)[]>]")
446 "Matches any of the 4 keywords, together with the time stamp.")
448 (defconst org-keyword-time-not-clock-regexp
452 (list org-scheduled-string org-deadline-string org-closed-string
) t
)
453 " *[[<]\\([^]>]+\\)[]>]")
454 "Matches any of the 3 keywords, together with the time stamp.")
456 (defconst org-maybe-keyword-time-regexp
459 (list org-scheduled-string org-deadline-string org-closed-string
463 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
466 "Matches a timestamp, possibly preceded by a keyword.")
468 (defconst org-all-time-keywords
469 (mapcar (lambda (w) (substring w
0 -
1))
470 (list org-scheduled-string org-deadline-string
471 org-clock-string org-closed-string
))
472 "List of time keywords.")
476 (defconst org-drawer-regexp
"^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
477 "Matches first or last line of a hidden block.
478 Group 1 contains drawer's name or \"END\".")
480 (defconst org-property-start-re
"^[ \t]*:PROPERTIES:[ \t]*$"
481 "Regular expression matching the first line of a property drawer.")
483 (defconst org-property-end-re
"^[ \t]*:END:[ \t]*$"
484 "Regular expression matching the last line of a property drawer.")
486 (defconst org-clock-drawer-start-re
"^[ \t]*:CLOCK:[ \t]*$"
487 "Regular expression matching the first line of a clock drawer.")
489 (defconst org-clock-drawer-end-re
"^[ \t]*:END:[ \t]*$"
490 "Regular expression matching the last line of a clock drawer.")
492 (defconst org-property-drawer-re
493 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
494 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
495 "[ \t]*:END:[ \t]*$")
496 "Matches an entire property drawer.")
498 (defconst org-clock-drawer-re
499 (concat "\\(" org-clock-drawer-start-re
"\\)[^\000]*?\\("
500 org-clock-drawer-end-re
"\\)\n?")
501 "Matches an entire clock drawer.")
505 (defconst org-heading-keyword-regexp-format
506 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
507 "Printf format for a regexp matching a headline with some keyword.
508 This regexp will match the headline of any node which has the
509 exact keyword that is put into the format. The keyword isn't in
510 any group by default, but the stars and the body are.")
512 (defconst org-heading-keyword-maybe-regexp-format
513 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
514 "Printf format for a regexp matching a headline, possibly with some keyword.
515 This regexp can match any headline with the specified keyword, or
516 without a keyword. The keyword isn't in any group by default,
517 but the stars and the body are.")
519 (defconst org-archive-tag
"ARCHIVE"
520 "The tag that marks a subtree as archived.
521 An archived subtree does not open during visibility cycling, and does
522 not contribute to the agenda listings.")
524 (defconst org-comment-string
"COMMENT"
525 "Entries starting with this keyword will never be exported.
526 An entry can be toggled between COMMENT and normal with
527 \\[org-toggle-comment].")
530 ;;;; LaTeX Environments and Fragments
532 (defconst org-latex-regexps
533 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t
)
534 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
535 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
536 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil
)
537 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil
)
538 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil
)
539 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil
)
540 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil
))
541 "Regular expressions for matching embedded LaTeX.")
545 (defconst org-effort-property
"Effort"
546 "The property that is being used to keep track of effort estimates.
547 Effort estimates given in this property need to have the format H:MM.")
551 (defconst org-table-any-line-regexp
"^[ \t]*\\(|\\|\\+-[-+]\\)"
552 "Detect an org-type or table-type table.")
554 (defconst org-table-line-regexp
"^[ \t]*|"
555 "Detect an org-type table line.")
557 (defconst org-table-dataline-regexp
"^[ \t]*|[^-]"
558 "Detect an org-type table line.")
560 (defconst org-table-hline-regexp
"^[ \t]*|-"
561 "Detect an org-type table hline.")
563 (defconst org-table1-hline-regexp
"^[ \t]*\\+-[-+]"
564 "Detect a table-type table hline.")
566 (defconst org-table-any-border-regexp
"^[ \t]*[^|+ \t]"
567 "Detect the first line outside a table when searching from within it.
568 This works for both table types.")
570 (defconst org-TBLFM-regexp
"^[ \t]*#\\+TBLFM: "
571 "Detect a #+TBLFM line.")
575 (defconst org-ts-regexp
"<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
576 "Regular expression for fast time stamp matching.")
578 (defconst org-ts-regexp-inactive
579 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
580 "Regular expression for fast inactive time stamp matching.")
582 (defconst org-ts-regexp-both
"[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
583 "Regular expression for fast time stamp matching.")
585 (defconst org-ts-regexp0
586 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
587 "Regular expression matching time strings for analysis.
588 This one does not require the space after the date, so it can be used
589 on a string that terminates immediately after the date.")
591 (defconst org-ts-regexp1
"\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
592 "Regular expression matching time strings for analysis.")
594 (defconst org-ts-regexp2
(concat "<" org-ts-regexp1
"[^>\n]\\{0,16\\}>")
595 "Regular expression matching time stamps, with groups.")
597 (defconst org-ts-regexp3
(concat "[[<]" org-ts-regexp1
"[^]>\n]\\{0,16\\}[]>]")
598 "Regular expression matching time stamps (also [..]), with groups.")
600 (defconst org-tr-regexp
(concat org-ts-regexp
"--?-?" org-ts-regexp
)
601 "Regular expression matching a time stamp range.")
603 (defconst org-tr-regexp-both
604 (concat org-ts-regexp-both
"--?-?" org-ts-regexp-both
)
605 "Regular expression matching a time stamp range.")
607 (defconst org-tsr-regexp
(concat org-ts-regexp
"\\(--?-?"
608 org-ts-regexp
"\\)?")
609 "Regular expression matching a time stamp or time stamp range.")
611 (defconst org-tsr-regexp-both
612 (concat org-ts-regexp-both
"\\(--?-?"
613 org-ts-regexp-both
"\\)?")
614 "Regular expression matching a time stamp or time stamp range.
615 The time stamps may be either active or inactive.")
617 (defconst org-repeat-re
618 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
619 "Regular expression for specifying repeated events.
620 After a match, group 1 contains the repeat expression.")
622 (defconst org-time-stamp-formats
'("<%Y-%m-%d %a>" .
"<%Y-%m-%d %a %H:%M>")
623 "Formats for `format-time-string' which are used for time stamps.")
626 ;;; The custom variables
629 "Outline-based notes management and organizer."
634 (defcustom org-mode-hook nil
635 "Mode hook for Org-mode, run after the mode was turned on."
639 (defcustom org-load-hook nil
640 "Hook that is run after org.el has been loaded."
644 (defcustom org-log-buffer-setup-hook nil
645 "Hook that is run after an Org log buffer is created."
650 (defvar org-modules
) ; defined below
651 (defvar org-modules-loaded nil
652 "Have the modules been loaded already?")
654 (defun org-load-modules-maybe (&optional force
)
655 "Load all extensions listed in `org-modules'."
656 (when (or force
(not org-modules-loaded
))
658 (condition-case nil
(require ext
)
659 (error (message "Problems while trying to load feature `%s'" ext
))))
661 (setq org-modules-loaded t
)))
663 (defun org-set-modules (var value
)
664 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
666 (when (featurep 'org
)
667 (org-load-modules-maybe 'force
)
668 (org-element-cache-reset 'all
)))
670 (defcustom org-modules
'(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail
)
671 "Modules that should always be loaded together with org.el.
673 If a description starts with <C>, the file is not part of Emacs
674 and loading it will require that you have downloaded and properly
675 installed the Org mode distribution.
677 You can also use this system to load external packages (i.e. neither Org
678 core modules, nor modules from the CONTRIB directory). Just add symbols
679 to the end of the list. If the package is called org-xyz.el, then you need
680 to add the symbol `xyz', and the package must have a call to:
684 For export specific modules, see also `org-export-backends'."
686 :set
'org-set-modules
688 :package-version
'(Org .
"8.0")
691 (const :tag
" bbdb: Links to BBDB entries" org-bbdb
)
692 (const :tag
" bibtex: Links to BibTeX entries" org-bibtex
)
693 (const :tag
" crypt: Encryption of subtrees" org-crypt
)
694 (const :tag
" ctags: Access to Emacs tags with links" org-ctags
)
695 (const :tag
" docview: Links to doc-view buffers" org-docview
)
696 (const :tag
" gnus: Links to GNUS folders/messages" org-gnus
)
697 (const :tag
" habit: Track your consistency with habits" org-habit
)
698 (const :tag
" id: Global IDs for identifying entries" org-id
)
699 (const :tag
" info: Links to Info nodes" org-info
)
700 (const :tag
" inlinetask: Tasks independent of outline hierarchy" org-inlinetask
)
701 (const :tag
" irc: Links to IRC/ERC chat sessions" org-irc
)
702 (const :tag
" mhe: Links to MHE folders/messages" org-mhe
)
703 (const :tag
" mouse: Additional mouse support" org-mouse
)
704 (const :tag
" protocol: Intercept calls from emacsclient" org-protocol
)
705 (const :tag
" rmail: Links to RMAIL folders/messages" org-rmail
)
706 (const :tag
" w3m: Special cut/paste from w3m to Org-mode." org-w3m
)
708 (const :tag
"C annotate-file: Annotate a file with org syntax" org-annotate-file
)
709 (const :tag
"C bookmark: Org-mode links to bookmarks" org-bookmark
)
710 (const :tag
"C bullets: Add overlays to headlines stars" org-bullets
)
711 (const :tag
"C checklist: Extra functions for checklists in repeated tasks" org-checklist
)
712 (const :tag
"C choose: Use TODO keywords to mark decisions states" org-choose
)
713 (const :tag
"C collector: Collect properties into tables" org-collector
)
714 (const :tag
"C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend
)
715 (const :tag
"C drill: Flashcards and spaced repetition for Org-mode" org-drill
)
716 (const :tag
"C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol
)
717 (const :tag
"C eshell Support for links to working directories in eshell" org-eshell
)
718 (const :tag
"C eval-light: Evaluate inbuffer-code on demand" org-eval-light
)
719 (const :tag
"C eval: Include command output as text" org-eval
)
720 (const :tag
"C eww: Store link to url of eww" org-eww
)
721 (const :tag
"C expiry: Expiry mechanism for Org-mode entries" org-expiry
)
722 (const :tag
"C favtable: Lookup table of favorite references and links" org-favtable
)
723 (const :tag
"C git-link: Provide org links to specific file version" org-git-link
)
724 (const :tag
"C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query
)
725 (const :tag
"C invoice: Help manage client invoices in Org-mode" org-invoice
)
726 (const :tag
"C jira: Add a jira:ticket protocol to Org-mode" org-jira
)
727 (const :tag
"C learn: SuperMemo's incremental learning algorithm" org-learn
)
728 (const :tag
"C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal
)
729 (const :tag
"C mac-link: Grab links and url from various mac Applications" org-mac-link
)
730 (const :tag
"C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix
)
731 (const :tag
"C man: Support for links to manpages in Org-mode" org-man
)
732 (const :tag
"C mew: Links to Mew folders/messages" org-mew
)
733 (const :tag
"C mtags: Support for muse-like tags" org-mtags
)
734 (const :tag
"C notmuch: Provide org links to notmuch searches or messages" org-notmuch
)
735 (const :tag
"C panel: Simple routines for us with bad memory" org-panel
)
736 (const :tag
"C registry: A registry for Org-mode links" org-registry
)
737 (const :tag
"C screen: Visit screen sessions through Org-mode links" org-screen
)
738 (const :tag
"C secretary: Team management with org-mode" org-secretary
)
739 (const :tag
"C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert
)
740 (const :tag
"C toc: Table of contents for Org-mode buffer" org-toc
)
741 (const :tag
"C track: Keep up with Org-mode development" org-track
)
742 (const :tag
"C velocity Something like Notational Velocity for Org" org-velocity
)
743 (const :tag
"C vm: Links to VM folders/messages" org-vm
)
744 (const :tag
"C wikinodes: CamelCase wiki-like links" org-wikinodes
)
745 (const :tag
"C wl: Links to Wanderlust folders/messages" org-wl
)
746 (repeat :tag
"External packages" :inline t
(symbol :tag
"Package"))))
748 (defvar org-export-registered-backends
) ; From ox.el.
749 (declare-function org-export-derived-backend-p
"ox" (backend &rest backends
))
750 (declare-function org-export-backend-name
"ox" (backend))
751 (defcustom org-export-backends
'(ascii html icalendar latex
)
752 "List of export back-ends that should be always available.
754 If a description starts with <C>, the file is not part of Emacs
755 and loading it will require that you have downloaded and properly
756 installed the Org mode distribution.
758 Unlike to `org-modules', libraries in this list will not be
759 loaded along with Org, but only once the export framework is
762 This variable needs to be set before org.el is loaded. If you
763 need to make a change while Emacs is running, use the customize
764 interface or run the following code, where VAL stands for the new
765 value of the variable, after updating it:
768 \(setq org-export-registered-backends
771 \(let ((name (org-export-backend-name backend)))
775 \(and (org-export-derived-backend-p b name)
776 \(throw 'parentp t)))))))
777 org-export-registered-backends))
778 \(let ((new-list (mapcar #'org-export-backend-name
779 org-export-registered-backends)))
780 \(dolist (backend val)
782 \((not (load (format \"ox-%s\" backend) t t))
783 \(message \"Problems while trying to load export back-end `%s'\"
785 \((not (memq backend new-list)) (push backend new-list))))
786 \(set-default 'org-export-backends new-list)))
788 Adding a back-end to this list will also pull the back-end it
793 :package-version
'(Org .
"8.0")
794 :initialize
'custom-initialize-set
795 :set
(lambda (var val
)
796 (if (not (featurep 'ox
)) (set-default var val
)
797 ;; Any back-end not required anymore (not present in VAL and not
798 ;; a parent of any back-end in the new value) is removed from the
799 ;; list of registered back-ends.
800 (setq org-export-registered-backends
803 (let ((name (org-export-backend-name backend
)))
807 (and (org-export-derived-backend-p b name
)
808 (throw 'parentp t
)))))))
809 org-export-registered-backends
))
810 ;; Now build NEW-LIST of both new back-ends and required
812 (let ((new-list (mapcar #'org-export-backend-name
813 org-export-registered-backends
)))
814 (dolist (backend val
)
816 ((not (load (format "ox-%s" backend
) t t
))
817 (message "Problems while trying to load export back-end `%s'"
819 ((not (memq backend new-list
)) (push backend new-list
))))
820 ;; Set VAR to that list with fixed dependencies.
821 (set-default var new-list
))))
822 :type
'(set :greedy t
823 (const :tag
" ascii Export buffer to ASCII format" ascii
)
824 (const :tag
" beamer Export buffer to Beamer presentation" beamer
)
825 (const :tag
" html Export buffer to HTML format" html
)
826 (const :tag
" icalendar Export buffer to iCalendar format" icalendar
)
827 (const :tag
" latex Export buffer to LaTeX format" latex
)
828 (const :tag
" man Export buffer to MAN format" man
)
829 (const :tag
" md Export buffer to Markdown format" md
)
830 (const :tag
" odt Export buffer to ODT format" odt
)
831 (const :tag
" org Export buffer to Org format" org
)
832 (const :tag
" texinfo Export buffer to Texinfo format" texinfo
)
833 (const :tag
"C confluence Export buffer to Confluence Wiki format" confluence
)
834 (const :tag
"C deck Export buffer to deck.js presentations" deck
)
835 (const :tag
"C freemind Export buffer to Freemind mindmap format" freemind
)
836 (const :tag
"C groff Export buffer to Groff format" groff
)
837 (const :tag
"C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter
)
838 (const :tag
"C RSS 2.0 Export buffer to RSS 2.0 format" rss
)
839 (const :tag
"C s5 Export buffer to s5 presentations" s5
)
840 (const :tag
"C taskjuggler Export buffer to TaskJuggler format" taskjuggler
)))
845 (condition-case nil
(require (intern (format "ox-%s" backend
)))
846 (error (message "Problems while trying to load export back-end `%s'"
848 org-export-backends
))
850 (defcustom org-support-shift-select nil
851 "Non-nil means make shift-cursor commands select text when possible.
853 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
854 start selecting a region, or enlarge regions started in this way.
855 In Org-mode, in special contexts, these same keys are used for
856 other purposes, important enough to compete with shift selection.
857 Org tries to balance these needs by supporting `shift-select-mode'
858 outside these special contexts, under control of this variable.
860 The default of this variable is nil, to avoid confusing behavior. Shifted
861 cursor keys will then execute Org commands in the following contexts:
862 - on a headline, changing TODO state (left/right) and priority (up/down)
863 - on a time stamp, changing the time
864 - in a plain list item, changing the bullet type
865 - in a property definition line, switching between allowed values
866 - in the BEGIN line of a clock table (changing the time block).
867 Outside these contexts, the commands will throw an error.
869 When this variable is t and the cursor is not in a special
870 context, Org-mode will support shift-selection for making and
871 enlarging regions. To make this more effective, the bullet
872 cycling will no longer happen anywhere in an item line, but only
873 if the cursor is exactly on the bullet.
875 If you set this variable to the symbol `always', then the keys
876 will not be special in headlines, property lines, and item lines,
877 to make shift selection work there as well. If this is what you
878 want, you can use the following alternative commands: `C-c C-t'
879 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
880 can be used to switch TODO sets, `C-c -' to cycle item bullet
881 types, and properties can be edited by hand or in column view.
883 However, when the cursor is on a timestamp, shift-cursor commands
884 will still edit the time stamp - this is just too good to give up.
886 XEmacs user should have this variable set to nil, because
887 `shift-select-mode' is in Emacs 23 or later only."
890 (const :tag
"Never" nil
)
891 (const :tag
"When outside special context" t
)
892 (const :tag
"Everywhere except timestamps" always
)))
894 (defcustom org-loop-over-headlines-in-active-region nil
895 "Shall some commands act upon headlines in the active region?
897 When set to `t', some commands will be performed in all headlines
898 within the active region.
900 When set to `start-level', some commands will be performed in all
901 headlines within the active region, provided that these headlines
902 are of the same level than the first one.
904 When set to a string, those commands will be performed on the
905 matching headlines within the active region. Such string must be
906 a tags/property/todo match as it is used in the agenda tags view.
908 The list of commands is: `org-schedule', `org-deadline',
909 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
910 `org-archive-to-archive-sibling'. The archiving commands skip
911 already archived entries."
912 :type
'(choice (const :tag
"Don't loop" nil
)
913 (const :tag
"All headlines in active region" t
)
914 (const :tag
"In active region, headlines at the same level than the first one" start-level
)
915 (string :tag
"Tags/Property/Todo matcher"))
920 (defgroup org-startup nil
921 "Options concerning startup of Org-mode."
925 (defcustom org-startup-folded t
926 "Non-nil means entering Org-mode will switch to OVERVIEW.
927 This can also be configured on a per-file basis by adding one of
928 the following lines anywhere in the buffer:
930 #+STARTUP: fold (or `overview', this is equivalent)
931 #+STARTUP: nofold (or `showall', this is equivalent)
933 #+STARTUP: showeverything
935 By default, this option is ignored when Org opens agenda files
936 for the first time. If you want the agenda to honor the startup
937 option, set `org-agenda-inhibit-startup' to nil."
940 (const :tag
"nofold: show all" nil
)
941 (const :tag
"fold: overview" t
)
942 (const :tag
"content: all headlines" content
)
943 (const :tag
"show everything, even drawers" showeverything
)))
945 (defcustom org-startup-truncated t
946 "Non-nil means entering Org-mode will set `truncate-lines'.
947 This is useful since some lines containing links can be very long and
948 uninteresting. Also tables look terrible when wrapped."
952 (defcustom org-startup-indented nil
953 "Non-nil means turn on `org-indent-mode' on startup.
954 This can also be configured on a per-file basis by adding one of
955 the following lines anywhere in the buffer:
959 :group
'org-structure
961 (const :tag
"Not" nil
)
962 (const :tag
"Globally (slow on startup in large files)" t
)))
964 (defcustom org-use-sub-superscripts t
965 "Non-nil means interpret \"_\" and \"^\" for display.
967 If you want to control how Org exports those characters, see
968 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
969 used to be an alias for `org-export-with-sub-superscripts' in
970 Org <8.0, it is not anymore.
972 When this option is turned on, you can use TeX-like syntax for
973 sub- and superscripts within the buffer. Several characters after
974 \"_\" or \"^\" will be considered as a single item - so grouping
975 with {} is normally not needed. For example, the following things
976 will be parsed as single sub- or superscripts:
978 10^24 or 10^tau several digits will be considered 1 item.
979 10^-12 or 10^-tau a leading sign with digits or a word
980 x^2-y^3 will be read as x^2 - y^3, because items are
981 terminated by almost any nonword/nondigit char.
982 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
984 Still, ambiguity is possible. So when in doubt, use {} to enclose
985 the sub/superscript. If you set this variable to the symbol `{}',
986 the braces are *required* in order to trigger interpretations as
987 sub/superscript. This can be helpful in documents that need \"_\"
988 frequently in plain text."
991 :package-version
'(Org .
"8.0")
993 (const :tag
"Always interpret" t
)
994 (const :tag
"Only with braces" {})
995 (const :tag
"Never interpret" nil
)))
997 (defcustom org-startup-with-beamer-mode nil
998 "Non-nil means turn on `org-beamer-mode' on startup.
999 This can also be configured on a per-file basis by adding one of
1000 the following lines anywhere in the buffer:
1007 (defcustom org-startup-align-all-tables nil
1008 "Non-nil means align all tables when visiting a file.
1009 This is useful when the column width in tables is forced with <N> cookies
1010 in table fields. Such tables will look correct only after the first re-align.
1011 This can also be configured on a per-file basis by adding one of
1012 the following lines anywhere in the buffer:
1018 (defcustom org-startup-with-inline-images nil
1019 "Non-nil means show inline images when loading a new Org file.
1020 This can also be configured on a per-file basis by adding one of
1021 the following lines anywhere in the buffer:
1022 #+STARTUP: inlineimages
1023 #+STARTUP: noinlineimages"
1028 (defcustom org-startup-with-latex-preview nil
1029 "Non-nil means preview LaTeX fragments when loading a new Org file.
1031 This can also be configured on a per-file basis by adding one of
1032 the following lines anywhere in the buffer:
1033 #+STARTUP: latexpreview
1034 #+STARTUP: nolatexpreview"
1037 :package-version
'(Org .
"8.0")
1040 (defcustom org-insert-mode-line-in-empty-file nil
1041 "Non-nil means insert the first line setting Org-mode in empty files.
1042 When the function `org-mode' is called interactively in an empty file, this
1043 normally means that the file name does not automatically trigger Org-mode.
1044 To ensure that the file will always be in Org-mode in the future, a
1045 line enforcing Org-mode will be inserted into the buffer, if this option
1050 (defcustom org-replace-disputed-keys nil
1051 "Non-nil means use alternative key bindings for some keys.
1052 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1053 These keys are also used by other packages like shift-selection-mode'
1054 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1055 If you want to use Org-mode together with one of these other modes,
1056 or more generally if you would like to move some Org-mode commands to
1057 other keys, set this variable and configure the keys with the variable
1058 `org-disputed-keys'.
1060 This option is only relevant at load-time of Org-mode, and must be set
1061 *before* org.el is loaded. Changing it requires a restart of Emacs to
1066 (defcustom org-use-extra-keys nil
1067 "Non-nil means use extra key sequence definitions for certain commands.
1068 This happens automatically if you run XEmacs or if `window-system'
1069 is nil. This variable lets you do the same manually. You must
1070 set it before loading org.
1072 Example: on Carbon Emacs 22 running graphically, with an external
1073 keyboard on a Powerbook, the default way of setting M-left might
1074 not work for either Alt or ESC. Setting this variable will make
1079 (org-defvaralias 'org-CUA-compatible
'org-replace-disputed-keys
)
1081 (defcustom org-disputed-keys
1082 '(([(shift up
)] .
[(meta p
)])
1083 ([(shift down
)] .
[(meta n
)])
1084 ([(shift left
)] .
[(meta -
)])
1085 ([(shift right
)] .
[(meta +)])
1086 ([(control shift right
)] .
[(meta shift
+)])
1087 ([(control shift left
)] .
[(meta shift -
)]))
1088 "Keys for which Org-mode and other modes compete.
1089 This is an alist, cars are the default keys, second element specifies
1090 the alternative to use when `org-replace-disputed-keys' is t.
1092 Keys can be specified in any syntax supported by `define-key'.
1093 The value of this option takes effect only at Org-mode's startup,
1094 therefore you'll have to restart Emacs to apply it after changing."
1098 (defun org-key (key)
1099 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1100 Or return the original if not disputed.
1101 Also apply the translations defined in `org-xemacs-key-equivalents'."
1102 (when org-replace-disputed-keys
1103 (let* ((nkey (key-description key
))
1104 (x (org-find-if (lambda (x)
1105 (equal (key-description (car x
)) nkey
))
1106 org-disputed-keys
)))
1107 (setq key
(if x
(cdr x
) key
))))
1108 (when (featurep 'xemacs
)
1109 (setq key
(or (cdr (assoc key org-xemacs-key-equivalents
)) key
)))
1112 (defun org-find-if (predicate seq
)
1115 (if (funcall predicate
(car seq
))
1116 (throw 'exit
(car seq
))
1119 (defun org-defkey (keymap key def
)
1120 "Define a key, possibly translated, as returned by `org-key'."
1121 (define-key keymap
(org-key key
) def
))
1123 (defcustom org-ellipsis nil
1124 "The ellipsis to use in the Org-mode outline.
1125 When nil, just use the standard three dots.
1126 When a string, use that string instead.
1127 When a face, use the standard 3 dots, but with the specified face.
1128 The change affects only Org-mode (which will then use its own display table).
1129 Changing this requires executing \\[org-mode] in a buffer to become
1132 :type
'(choice (const :tag
"Default" nil
)
1133 (face :tag
"Face" :value org-warning
)
1134 (string :tag
"String" :value
"...#")))
1136 (defvar org-display-table nil
1137 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1139 (defgroup org-keywords nil
1140 "Keywords in Org-mode."
1144 (defcustom org-closed-keep-when-no-todo nil
1145 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1147 :group
'org-keywords
1149 :package-version
'(Org .
"8.0")
1152 (defgroup org-structure nil
1153 "Options concerning the general structure of Org-mode files."
1154 :tag
"Org Structure"
1157 (defgroup org-reveal-location nil
1158 "Options about how to make context of a location visible."
1159 :tag
"Org Reveal Location"
1160 :group
'org-structure
)
1162 (defcustom org-show-context-detail
'((isearch . lineage
)
1163 (bookmark-jump . lineage
)
1164 (default . ancestors
))
1165 "Alist between context and visibility span when revealing a location.
1167 \\<org-mode-map>Some actions may move point into invisible
1168 locations. As a consequence, Org always expose a neighborhood
1169 around point. How much is shown depends on the initial action,
1170 or context. Valid contexts are
1172 agenda when exposing an entry from the agenda
1173 org-goto when using the command `org-goto' (\\[org-goto])
1174 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1175 tags-tree when constructing a sparse tree based on tags matches
1176 link-search when exposing search matches associated with a link
1177 mark-goto when exposing the jump goal of a mark
1178 bookmark-jump when exposing a bookmark location
1179 isearch when exiting from an incremental search
1180 default default for all contexts not set explicitly
1182 Allowed visibility spans are
1184 minimal show current headline; if point is not on headline,
1187 local show current headline, entry and next headline
1189 ancestors show current headline and its direct ancestors; if
1190 point is not on headline, also show entry
1192 lineage show current headline, its direct ancestors and all
1193 their children; if point is not on headline, also show
1194 entry and first child
1196 tree show current headline, its direct ancestors and all
1197 their children; if point is not on headline, also show
1198 entry and all children
1200 canonical show current headline, its direct ancestors along with
1201 their entries and children; if point is not located on
1202 the headline, also show current entry and all children
1204 As special cases, a nil or t value means show all contexts in
1205 `minimal' or `canonical' view, respectively.
1207 Some views can make displayed information very compact, but also
1208 make it harder to edit the location of the match. In such
1209 a case, use the command `org-reveal' (\\[org-reveal]) to show
1211 :group
'org-reveal-location
1213 :package-version
'(Org .
"8.3")
1215 (const :tag
"Canonical" t
)
1216 (const :tag
"Minimal" nil
)
1217 (repeat :greedy t
:tag
"Individual contexts"
1219 (choice :tag
"Context"
1226 (const bookmark-jump
)
1229 (choice :tag
"Detail level"
1235 (const canonical
))))))
1237 (defcustom org-indirect-buffer-display
'other-window
1238 "How should indirect tree buffers be displayed?
1239 This applies to indirect buffers created with the commands
1240 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1242 current-window Display in the current window
1243 other-window Just display in another window.
1244 dedicated-frame Create one new frame, and re-use it each time.
1245 new-frame Make a new frame each time. Note that in this case
1246 previously-made indirect buffers are kept, and you need to
1247 kill these buffers yourself."
1248 :group
'org-structure
1249 :group
'org-agenda-windows
1251 (const :tag
"In current window" current-window
)
1252 (const :tag
"In current frame, other window" other-window
)
1253 (const :tag
"Each time a new frame" new-frame
)
1254 (const :tag
"One dedicated frame" dedicated-frame
)))
1256 (defcustom org-use-speed-commands nil
1257 "Non-nil means activate single letter commands at beginning of a headline.
1258 This may also be a function to test for appropriate locations where speed
1259 commands should be active.
1261 For example, to activate speed commands when the point is on any
1262 star at the beginning of the headline, you can do this:
1264 (setq org-use-speed-commands
1265 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1266 :group
'org-structure
1268 (const :tag
"Never" nil
)
1269 (const :tag
"At beginning of headline stars" t
)
1272 (defcustom org-speed-commands-user nil
1273 "Alist of additional speed commands.
1274 This list will be checked before `org-speed-commands-default'
1275 when the variable `org-use-speed-commands' is non-nil
1276 and when the cursor is at the beginning of a headline.
1277 The car if each entry is a string with a single letter, which must
1278 be assigned to `self-insert-command' in the global map.
1279 The cdr is either a command to be called interactively, a function
1280 to be called, or a form to be evaluated.
1281 An entry that is just a list with a single string will be interpreted
1282 as a descriptive headline that will be added when listing the speed
1283 commands in the Help buffer using the `?' speed command."
1284 :group
'org-structure
1285 :type
'(repeat :value
("k" . ignore
)
1286 (choice :value
("k" . ignore
)
1287 (list :tag
"Descriptive Headline" (string :tag
"Headline"))
1288 (cons :tag
"Letter and Command"
1289 (string :tag
"Command letter")
1294 (defcustom org-bookmark-names-plist
1295 '(:last-capture
"org-capture-last-stored"
1296 :last-refile
"org-refile-last-stored"
1297 :last-capture-marker
"org-capture-last-stored-marker")
1298 "Names for bookmarks automatically set by some Org commands.
1299 This can provide strings as names for a number of bookmarks Org sets
1300 automatically. The following keys are currently implemented:
1302 :last-capture-marker
1304 When a key does not show up in the property list, the corresponding bookmark
1306 :group
'org-structure
1309 (defgroup org-cycle nil
1310 "Options concerning visibility cycling in Org-mode."
1312 :group
'org-structure
)
1314 (defcustom org-cycle-skip-children-state-if-no-children t
1315 "Non-nil means skip CHILDREN state in entries that don't have any."
1319 (defcustom org-cycle-max-level nil
1320 "Maximum level which should still be subject to visibility cycling.
1321 Levels higher than this will, for cycling, be treated as text, not a headline.
1322 When `org-odd-levels-only' is set, a value of N in this variable actually
1323 means 2N-1 stars as the limiting headline.
1324 When nil, cycle all levels.
1325 Note that the limiting level of cycling is also influenced by
1326 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1327 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1331 (const :tag
"No limit" nil
)
1332 (integer :tag
"Maximum level")))
1334 (defcustom org-hide-block-startup nil
1335 "Non-nil means entering Org-mode will fold all blocks.
1336 This can also be set in on a per-file basis with
1338 #+STARTUP: hideblocks
1339 #+STARTUP: showblocks"
1344 (defcustom org-cycle-global-at-bob nil
1345 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1346 This makes it possible to do global cycling without having to use S-TAB or
1347 \\[universal-argument] TAB. For this special case to work, the first line
1348 of the buffer must not be a headline -- it may be empty or some other text.
1349 When used in this way, `org-cycle-hook' is disabled temporarily to make
1350 sure the cursor stays at the beginning of the buffer. When this option is
1351 nil, don't do anything special at the beginning of the buffer."
1355 (defcustom org-cycle-level-after-item
/entry-creation t
1356 "Non-nil means cycle entry level or item indentation in new empty entries.
1358 When the cursor is at the end of an empty headline, i.e., with only stars
1359 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1360 and then all possible ancestor states, before returning to the original state.
1361 This makes data entry extremely fast: M-RET to create a new headline,
1362 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1364 When the cursor is at the end of an empty plain list item, one TAB will
1365 make it a subitem, two or more tabs will back up to make this an item
1366 higher up in the item hierarchy."
1370 (defcustom org-cycle-emulate-tab t
1371 "Where should `org-cycle' emulate TAB.
1373 white Only in completely white lines
1374 whitestart Only at the beginning of lines, before the first non-white char
1375 t Everywhere except in headlines
1376 exc-hl-bol Everywhere except at the start of a headline
1377 If TAB is used in a place where it does not emulate TAB, the current subtree
1378 visibility is cycled."
1380 :type
'(choice (const :tag
"Never" nil
)
1381 (const :tag
"Only in completely white lines" white
)
1382 (const :tag
"Before first char in a line" whitestart
)
1383 (const :tag
"Everywhere except in headlines" t
)
1384 (const :tag
"Everywhere except at bol in headlines" exc-hl-bol
)))
1386 (defcustom org-cycle-separator-lines
2
1387 "Number of empty lines needed to keep an empty line between collapsed trees.
1388 If you leave an empty line between the end of a subtree and the following
1389 headline, this empty line is hidden when the subtree is folded.
1390 Org-mode will leave (exactly) one empty line visible if the number of
1391 empty lines is equal or larger to the number given in this variable.
1392 So the default 2 means at least 2 empty lines after the end of a subtree
1393 are needed to produce free space between a collapsed subtree and the
1396 If the number is negative, and the number of empty lines is at least -N,
1397 all empty lines are shown.
1399 Special case: when 0, never leave empty lines in collapsed view."
1402 (put 'org-cycle-separator-lines
'safe-local-variable
'integerp
)
1404 (defcustom org-pre-cycle-hook nil
1405 "Hook that is run before visibility cycling is happening.
1406 The function(s) in this hook must accept a single argument which indicates
1407 the new state that will be set right after running this hook. The
1408 argument is a symbol. Before a global state change, it can have the values
1409 `overview', `content', or `all'. Before a local state change, it can have
1410 the values `folded', `children', or `subtree'."
1414 (defcustom org-cycle-hook
'(org-cycle-hide-archived-subtrees
1415 org-cycle-hide-drawers
1416 org-cycle-show-empty-lines
1417 org-optimize-window-after-visibility-change
)
1418 "Hook that is run after `org-cycle' has changed the buffer visibility.
1419 The function(s) in this hook must accept a single argument which indicates
1420 the new state that was set by the most recent `org-cycle' command. The
1421 argument is a symbol. After a global state change, it can have the values
1422 `overview', `contents', or `all'. After a local state change, it can have
1423 the values `folded', `children', or `subtree'."
1427 :package-version
'(Org .
"8.3"))
1429 (defgroup org-edit-structure nil
1430 "Options concerning structure editing in Org-mode."
1431 :tag
"Org Edit Structure"
1432 :group
'org-structure
)
1434 (defcustom org-odd-levels-only nil
1435 "Non-nil means skip even levels and only use odd levels for the outline.
1436 This has the effect that two stars are being added/taken away in
1437 promotion/demotion commands. It also influences how levels are
1438 handled by the exporters.
1439 Changing it requires restart of `font-lock-mode' to become effective
1440 for fontification also in regions already fontified.
1441 You may also set this on a per-file basis by adding one of the following
1442 lines to the buffer:
1446 :group
'org-edit-structure
1447 :group
'org-appearance
1450 (defcustom org-adapt-indentation t
1451 "Non-nil means adapt indentation to outline node level.
1453 When this variable is set, Org assumes that you write outlines by
1454 indenting text in each node to align with the headline (after the
1455 stars). The following issues are influenced by this variable:
1457 - The indentation is increased by one space in a demotion
1458 command, and decreased by one in a promotion command. However,
1459 in the latter case, if shifting some line in the entry body
1460 would alter document structure (e.g., insert a new headline),
1461 indentation is not changed at all.
1463 - Property drawers and planning information is inserted indented
1464 when this variable is set. When nil, they will not be indented.
1466 - TAB indents a line relative to current level. The lines below
1467 a headline will be indented when this variable is set.
1469 Note that this is all about true indentation, by adding and
1470 removing space characters. See also `org-indent.el' which does
1471 level-dependent indentation in a virtual way, i.e. at display
1473 :group
'org-edit-structure
1476 (defcustom org-special-ctrl-a
/e nil
1477 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1479 When t, `C-a' will bring back the cursor to the beginning of the
1480 headline text, i.e. after the stars and after a possible TODO
1481 keyword. In an item, this will be the position after bullet and
1482 check-box, if any. When the cursor is already at that position,
1483 another `C-a' will bring it to the beginning of the line.
1485 `C-e' will jump to the end of the headline, ignoring the presence
1486 of tags in the headline. A second `C-e' will then jump to the
1487 true end of the line, after any tags. This also means that, when
1488 this variable is non-nil, `C-e' also will never jump beyond the
1489 end of the heading of a folded section, i.e. not after the
1492 When set to the symbol `reversed', the first `C-a' or `C-e' works
1493 normally, going to the true line boundary first. Only a directly
1494 following, identical keypress will bring the cursor to the
1497 This may also be a cons cell where the behavior for `C-a' and
1498 `C-e' is set separately."
1499 :group
'org-edit-structure
1501 (const :tag
"off" nil
)
1502 (const :tag
"on: after stars/bullet and before tags first" t
)
1503 (const :tag
"reversed: true line boundary first" reversed
)
1504 (cons :tag
"Set C-a and C-e separately"
1505 (choice :tag
"Special C-a"
1506 (const :tag
"off" nil
)
1507 (const :tag
"on: after stars/bullet first" t
)
1508 (const :tag
"reversed: before stars/bullet first" reversed
))
1509 (choice :tag
"Special C-e"
1510 (const :tag
"off" nil
)
1511 (const :tag
"on: before tags first" t
)
1512 (const :tag
"reversed: after tags first" reversed
)))))
1513 (org-defvaralias 'org-special-ctrl-a
'org-special-ctrl-a
/e
)
1515 (defcustom org-special-ctrl-k nil
1516 "Non-nil means `C-k' will behave specially in headlines.
1517 When nil, `C-k' will call the default `kill-line' command.
1518 When t, the following will happen while the cursor is in the headline:
1520 - When the cursor is at the beginning of a headline, kill the entire
1521 line and possible the folded subtree below the line.
1522 - When in the middle of the headline text, kill the headline up to the tags.
1523 - When after the headline text, kill the tags."
1524 :group
'org-edit-structure
1527 (defcustom org-ctrl-k-protect-subtree nil
1528 "Non-nil means, do not delete a hidden subtree with C-k.
1529 When set to the symbol `error', simply throw an error when C-k is
1530 used to kill (part-of) a headline that has hidden text behind it.
1531 Any other non-nil value will result in a query to the user, if it is
1532 OK to kill that hidden subtree. When nil, kill without remorse."
1533 :group
'org-edit-structure
1536 (const :tag
"Do not protect hidden subtrees" nil
)
1537 (const :tag
"Protect hidden subtrees with a security query" t
)
1538 (const :tag
"Never kill a hidden subtree with C-k" error
)))
1540 (defcustom org-special-ctrl-o t
1541 "Non-nil means, make `C-o' insert a row in tables."
1542 :group
'org-edit-structure
1545 (defcustom org-catch-invisible-edits nil
1546 "Check if in invisible region before inserting or deleting a character.
1549 nil Do not check, so just do invisible edits.
1550 error Throw an error and do nothing.
1551 show Make point visible, and do the requested edit.
1552 show-and-error Make point visible, then throw an error and abort the edit.
1553 smart Make point visible, and do insertion/deletion if it is
1554 adjacent to visible text and the change feels predictable.
1555 Never delete a previously invisible character or add in the
1556 middle or right after an invisible region. Basically, this
1557 allows insertion and backward-delete right before ellipses.
1558 FIXME: maybe in this case we should not even show?"
1559 :group
'org-edit-structure
1562 (const :tag
"Do not check" nil
)
1563 (const :tag
"Throw error when trying to edit" error
)
1564 (const :tag
"Unhide, but do not do the edit" show-and-error
)
1565 (const :tag
"Show invisible part and do the edit" show
)
1566 (const :tag
"Be smart and do the right thing" smart
)))
1568 (defcustom org-yank-folded-subtrees t
1569 "Non-nil means when yanking subtrees, fold them.
1570 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1571 it starts with a heading and all other headings in it are either children
1572 or siblings, then fold all the subtrees. However, do this only if no
1573 text after the yank would be swallowed into a folded tree by this action."
1574 :group
'org-edit-structure
1577 (defcustom org-yank-adjusted-subtrees nil
1578 "Non-nil means when yanking subtrees, adjust the level.
1579 With this setting, `org-paste-subtree' is used to insert the subtree, see
1580 this function for details."
1581 :group
'org-edit-structure
1584 (defcustom org-M-RET-may-split-line
'((default . t
))
1585 "Non-nil means M-RET will split the line at the cursor position.
1586 When nil, it will go to the end of the line before making a
1588 You may also set this option in a different way for different
1589 contexts. Valid contexts are:
1591 headline when creating a new headline
1592 item when creating a new item
1593 table in a table field
1594 default the value to be used for all contexts not explicitly
1596 :group
'org-structure
1599 (const :tag
"Always" t
)
1600 (const :tag
"Never" nil
)
1601 (repeat :greedy t
:tag
"Individual contexts"
1603 (choice :tag
"Context"
1611 (defcustom org-insert-heading-respect-content nil
1612 "Non-nil means insert new headings after the current subtree.
1613 When nil, the new heading is created directly after the current line.
1614 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1615 this variable on for the duration of the command."
1616 :group
'org-structure
1619 (defcustom org-blank-before-new-entry
'((heading . auto
)
1620 (plain-list-item . auto
))
1621 "Should `org-insert-heading' leave a blank line before new heading/item?
1622 The value is an alist, with `heading' and `plain-list-item' as CAR,
1623 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1624 which case Org will look at the surrounding headings/items and try to
1625 make an intelligent decision whether to insert a blank line or not.
1627 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1628 the setting here is ignored and no empty line is inserted to avoid breaking
1629 the list structure."
1630 :group
'org-edit-structure
1632 (cons (const heading
)
1633 (choice (const :tag
"Never" nil
)
1634 (const :tag
"Always" t
)
1635 (const :tag
"Auto" auto
)))
1636 (cons (const plain-list-item
)
1637 (choice (const :tag
"Never" nil
)
1638 (const :tag
"Always" t
)
1639 (const :tag
"Auto" auto
)))))
1641 (defcustom org-insert-heading-hook nil
1642 "Hook being run after inserting a new heading."
1643 :group
'org-edit-structure
1646 (defcustom org-enable-fixed-width-editor t
1647 "Non-nil means lines starting with \":\" are treated as fixed-width.
1648 This currently only means they are never auto-wrapped.
1649 When nil, such lines will be treated like ordinary lines."
1650 :group
'org-edit-structure
1653 (defcustom org-goto-auto-isearch t
1654 "Non-nil means typing characters in `org-goto' starts incremental search.
1655 When nil, you can use these keybindings to navigate the buffer:
1657 q Quit the org-goto interface
1658 n Go to the next visible heading
1659 p Go to the previous visible heading
1660 f Go one heading forward on same level
1661 b Go one heading backward on same level
1662 u Go one heading up"
1663 :group
'org-edit-structure
1666 (defgroup org-sparse-trees nil
1667 "Options concerning sparse trees in Org-mode."
1668 :tag
"Org Sparse Trees"
1669 :group
'org-structure
)
1671 (defcustom org-highlight-sparse-tree-matches t
1672 "Non-nil means highlight all matches that define a sparse tree.
1673 The highlights will automatically disappear the next time the buffer is
1674 changed by an edit command."
1675 :group
'org-sparse-trees
1678 (defcustom org-remove-highlights-with-change t
1679 "Non-nil means any change to the buffer will remove temporary highlights.
1680 Such highlights are created by `org-occur' and `org-clock-display'.
1681 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1682 The highlights created by `org-toggle-latex-fragment' always need
1683 `C-c C-x C-l' to be removed."
1684 :group
'org-sparse-trees
1689 (defcustom org-occur-hook
'(org-first-headline-recenter)
1690 "Hook that is run after `org-occur' has constructed a sparse tree.
1691 This can be used to recenter the window to show as much of the structure
1693 :group
'org-sparse-trees
1696 (defgroup org-imenu-and-speedbar nil
1697 "Options concerning imenu and speedbar in Org-mode."
1698 :tag
"Org Imenu and Speedbar"
1699 :group
'org-structure
)
1701 (defcustom org-imenu-depth
2
1702 "The maximum level for Imenu access to Org-mode headlines.
1703 This also applied for speedbar access."
1704 :group
'org-imenu-and-speedbar
1707 (defgroup org-table nil
1708 "Options concerning tables in Org-mode."
1712 (defcustom org-enable-table-editor
'optimized
1713 "Non-nil means lines starting with \"|\" are handled by the table editor.
1714 When nil, such lines will be treated like ordinary lines.
1716 When equal to the symbol `optimized', the table editor will be optimized to
1718 - Automatic overwrite mode in front of whitespace in table fields.
1719 This makes the structure of the table stay in tact as long as the edited
1720 field does not exceed the column width.
1721 - Minimize the number of realigns. Normally, the table is aligned each time
1722 TAB or RET are pressed to move to another field. With optimization this
1723 happens only if changes to a field might have changed the column width.
1724 Optimization requires replacing the functions `self-insert-command',
1725 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1726 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1727 very good at guessing when a re-align will be necessary, but you can always
1728 force one with \\[org-ctrl-c-ctrl-c].
1730 If you would like to use the optimized version in Org-mode, but the
1731 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1733 This variable can be used to turn on and off the table editor during a session,
1734 but in order to toggle optimization, a restart is required.
1736 See also the variable `org-table-auto-blank-field'."
1739 (const :tag
"off" nil
)
1741 (const :tag
"on, optimized" optimized
)))
1743 (defcustom org-self-insert-cluster-for-undo
(or (featurep 'xemacs
)
1744 (version<= emacs-version
"24.1"))
1745 "Non-nil means cluster self-insert commands for undo when possible.
1746 If this is set, then, like in the Emacs command loop, 20 consecutive
1747 characters will be undone together.
1748 This is configurable, because there is some impact on typing performance."
1752 (defcustom org-table-tab-recognizes-table.el t
1753 "Non-nil means TAB will automatically notice a table.el table.
1754 When it sees such a table, it moves point into it and - if necessary -
1755 calls `table-recognize-table'."
1756 :group
'org-table-editing
1759 (defgroup org-link nil
1760 "Options concerning links in Org-mode."
1764 (defvar org-link-abbrev-alist-local nil
1765 "Buffer-local version of `org-link-abbrev-alist', which see.
1766 The value of this is taken from the #+LINK lines.")
1767 (make-variable-buffer-local 'org-link-abbrev-alist-local
)
1769 (defcustom org-link-abbrev-alist nil
1770 "Alist of link abbreviations.
1771 The car of each element is a string, to be replaced at the start of a link.
1772 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1773 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1775 [[linkkey:tag][description]]
1777 The 'linkkey' must be a word word, starting with a letter, followed
1778 by letters, numbers, '-' or '_'.
1780 If REPLACE is a string, the tag will simply be appended to create the link.
1781 If the string contains \"%s\", the tag will be inserted there. If the string
1782 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1783 at that point (see the function `url-hexify-string'). If the string contains
1784 the specifier \"%(my-function)\", then the custom function `my-function' will
1785 be invoked: this function takes the tag as its only argument and must return
1788 REPLACE may also be a function that will be called with the tag as the
1789 only argument to create the link, which should be returned as a string.
1791 See the manual for examples."
1795 (string :tag
"Protocol")
1797 (string :tag
"Format")
1800 (defcustom org-descriptive-links t
1801 "Non-nil means Org will display descriptive links.
1802 E.g. [[http://orgmode.org][Org website]] will be displayed as
1803 \"Org Website\", hiding the link itself and just displaying its
1804 description. When set to `nil', Org will display the full links
1807 You can interactively set the value of this variable by calling
1808 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1812 (defcustom org-link-file-path-type
'adaptive
1813 "How the path name in file links should be stored.
1816 relative Relative to the current directory, i.e. the directory of the file
1817 into which the link is being inserted.
1818 absolute Absolute path, if possible with ~ for home directory.
1819 noabbrev Absolute path, no abbreviation of home directory.
1820 adaptive Use relative path for files in the current directory and sub-
1821 directories of it. For other files, use an absolute path."
1829 (defvaralias 'org-activate-links
'org-highlight-links
)
1830 (defcustom org-highlight-links
'(bracket angle plain radio tag date footnote
)
1831 "Types of links that should be highlighted in Org-mode files.
1833 This is a list of symbols, each one of them leading to the
1834 highlighting of a certain link type.
1836 You can still open links that are not highlighted.
1838 In principle, it does not hurt to turn on highlighting for all
1839 link types. There may be a small gain when turning off unused
1840 link types. The types are:
1842 bracket The recommended [[link][description]] or [[link]] links with hiding.
1843 angle Links in angular brackets that may contain whitespace like
1844 <bbdb:Carsten Dominik>.
1845 plain Plain links in normal text, no whitespace, like http://google.com.
1846 radio Text that is matched by a radio target, see manual for details.
1847 tag Tag settings in a headline (link to tag search).
1848 date Time stamps (link to calendar).
1849 footnote Footnote labels.
1851 If you set this variable during an Emacs session, use `org-mode-restart'
1852 in the Org buffer so that the change takes effect."
1854 :group
'org-appearance
1855 :type
'(set :greedy t
1856 (const :tag
"Double bracket links" bracket
)
1857 (const :tag
"Angular bracket links" angle
)
1858 (const :tag
"Plain text links" plain
)
1859 (const :tag
"Radio target matches" radio
)
1860 (const :tag
"Tags" tag
)
1861 (const :tag
"Timestamps" date
)
1862 (const :tag
"Footnotes" footnote
)))
1864 (defcustom org-make-link-description-function nil
1865 "Function to use for generating link descriptions from links.
1866 When nil, the link location will be used. This function must take
1867 two parameters: the first one is the link, the second one is the
1868 description generated by `org-insert-link'. The function should
1869 return the description to use."
1871 :type
'(choice (const nil
) (function)))
1873 (defgroup org-link-store nil
1874 "Options concerning storing links in Org-mode."
1875 :tag
"Org Store Link"
1878 (defcustom org-url-hexify-p t
1879 "When non-nil, hexify URL when creating a link."
1882 :group
'org-link-store
)
1884 (defcustom org-email-link-description-format
"Email %c: %.30s"
1885 "Format of the description part of a link to an email or usenet message.
1886 The following %-escapes will be replaced by corresponding information:
1888 %F full \"From\" field
1889 %f name, taken from \"From\" field, address if no name
1890 %T full \"To\" field
1891 %t first name in \"To\" field, address if no name
1892 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1893 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1898 You may use normal field width specification between the % and the letter.
1899 This is for example useful to limit the length of the subject.
1901 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1902 :group
'org-link-store
1905 (defcustom org-from-is-user-regexp
1907 (when (and user-mail-address
(not (string= user-mail-address
"")))
1908 (setq r1
(concat "\\<" (regexp-quote user-mail-address
) "\\>")))
1909 (when (and user-full-name
(not (string= user-full-name
"")))
1910 (setq r2
(concat "\\<" (regexp-quote user-full-name
) "\\>")))
1911 (if (and r1 r2
) (concat r1
"\\|" r2
) (or r1 r2
)))
1912 "Regexp matched against the \"From:\" header of an email or usenet message.
1913 It should match if the message is from the user him/herself."
1914 :group
'org-link-store
1917 (defcustom org-context-in-file-links t
1918 "Non-nil means file links from `org-store-link' contain context.
1919 A search string will be added to the file name with :: as separator and
1920 used to find the context when the link is activated by the command
1921 `org-open-at-point'. When this option is t, the entire active region
1922 will be placed in the search string of the file link. If set to a
1923 positive integer, only the first n lines of context will be stored.
1925 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1926 negates this setting for the duration of the command."
1927 :group
'org-link-store
1928 :type
'(choice boolean integer
))
1930 (defcustom org-keep-stored-link-after-insertion nil
1931 "Non-nil means keep link in list for entire session.
1933 The command `org-store-link' adds a link pointing to the current
1934 location to an internal list. These links accumulate during a session.
1935 The command `org-insert-link' can be used to insert links into any
1936 Org-mode file (offering completion for all stored links). When this
1937 option is nil, every link which has been inserted once using \\[org-insert-link]
1938 will be removed from the list, to make completing the unused links
1940 :group
'org-link-store
1943 (defgroup org-link-follow nil
1944 "Options concerning following links in Org-mode."
1945 :tag
"Org Follow Link"
1948 (defcustom org-link-translation-function nil
1949 "Function to translate links with different syntax to Org syntax.
1950 This can be used to translate links created for example by the Planner
1951 or emacs-wiki packages to Org syntax.
1952 The function must accept two parameters, a TYPE containing the link
1953 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1954 which is everything after the link protocol. It should return a cons
1955 with possibly modified values of type and path.
1956 Org contains a function for this, so if you set this variable to
1957 `org-translate-link-from-planner', you should be able follow many
1958 links created by planner."
1959 :group
'org-link-follow
1960 :type
'(choice (const nil
) (function)))
1962 (defcustom org-follow-link-hook nil
1963 "Hook that is run after a link has been followed."
1964 :group
'org-link-follow
1967 (defcustom org-tab-follows-link nil
1968 "Non-nil means on links TAB will follow the link.
1969 Needs to be set before org.el is loaded.
1970 This really should not be used, it does not make sense, and the
1971 implementation is bad."
1972 :group
'org-link-follow
1975 (defcustom org-return-follows-link nil
1976 "Non-nil means on links RET will follow the link.
1977 In tables, the special behavior of RET has precedence."
1978 :group
'org-link-follow
1981 (defcustom org-mouse-1-follows-link
1982 (if (boundp 'mouse-1-click-follows-link
) mouse-1-click-follows-link t
)
1983 "Non-nil means mouse-1 on a link will follow the link.
1984 A longer mouse click will still set point. Does not work on XEmacs.
1985 Needs to be set before org.el is loaded."
1986 :group
'org-link-follow
1988 :package-version
'(Org .
"8.3")
1990 (const :tag
"A double click follows the link" double
)
1991 (const :tag
"Unconditionally follow the link with mouse-1" t
)
1992 (integer :tag
"mouse-1 click does not follow the link if longer than N ms" 450)))
1994 (defcustom org-mark-ring-length
4
1995 "Number of different positions to be recorded in the ring.
1996 Changing this requires a restart of Emacs to work correctly."
1997 :group
'org-link-follow
2000 (defcustom org-link-search-must-match-exact-headline
'query-to-create
2001 "Non-nil means internal links in Org files must exactly match a headline.
2002 When nil, the link search tries to match a phrase with all words
2003 in the search text."
2004 :group
'org-link-follow
2007 (const :tag
"Use fuzzy text search" nil
)
2008 (const :tag
"Match only exact headline" t
)
2009 (const :tag
"Match exact headline or query to create it"
2012 (defcustom org-link-frame-setup
2013 '((vm . vm-visit-folder-other-frame
)
2014 (vm-imap . vm-visit-imap-folder-other-frame
)
2015 (gnus . org-gnus-no-new-news
)
2016 (file . find-file-other-window
)
2017 (wl . wl-other-frame
))
2018 "Setup the frame configuration for following links.
2019 When following a link with Emacs, it may often be useful to display
2020 this link in another window or frame. This variable can be used to
2021 set this up for the different types of links.
2024 `vm-visit-folder-other-window'
2025 `vm-visit-folder-other-frame'
2026 For Gnus, use any of
2029 `org-gnus-no-new-news'
2030 For FILE, use any of
2032 `find-file-other-window'
2033 `find-file-other-frame'
2034 For Wanderlust use any of
2037 For the calendar, use the variable `calendar-setup'.
2038 For BBDB, it is currently only possible to display the matches in
2040 :group
'org-link-follow
2044 (const vm-visit-folder
)
2045 (const vm-visit-folder-other-window
)
2046 (const vm-visit-folder-other-frame
)))
2047 (cons (const vm-imap
)
2049 (const vm-visit-imap-folder
)
2050 (const vm-visit-imap-folder-other-window
)
2051 (const vm-visit-imap-folder-other-frame
)))
2055 (const gnus-other-frame
)
2056 (const org-gnus-no-new-news
)))
2060 (const find-file-other-window
)
2061 (const find-file-other-frame
)))
2065 (const wl-other-frame
)))))
2067 (defcustom org-display-internal-link-with-indirect-buffer nil
2068 "Non-nil means use indirect buffer to display infile links.
2069 Activating internal links (from one location in a file to another location
2070 in the same file) normally just jumps to the location. When the link is
2071 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2073 another window. When this option is set, the other window actually displays
2074 an indirect buffer clone of the current buffer, to avoid any visibility
2075 changes to the current buffer."
2076 :group
'org-link-follow
2079 (defcustom org-open-non-existing-files nil
2080 "Non-nil means `org-open-file' will open non-existing files.
2081 When nil, an error will be generated.
2082 This variable applies only to external applications because they
2083 might choke on non-existing files. If the link is to a file that
2084 will be opened in Emacs, the variable is ignored."
2085 :group
'org-link-follow
2088 (defcustom org-open-directory-means-index-dot-org nil
2089 "Non-nil means a link to a directory really means to index.org.
2090 When nil, following a directory link will run dired or open a finder/explorer
2091 window on that directory."
2092 :group
'org-link-follow
2095 (defcustom org-confirm-shell-link-function
'yes-or-no-p
2096 "Non-nil means ask for confirmation before executing shell links.
2097 Shell links can be dangerous: just think about a link
2099 [[shell:rm -rf ~/*][Google Search]]
2101 This link would show up in your Org-mode document as \"Google Search\",
2102 but really it would remove your entire home directory.
2103 Therefore we advise against setting this variable to nil.
2104 Just change it to `y-or-n-p' if you want to confirm with a
2105 single keystroke rather than having to type \"yes\"."
2106 :group
'org-link-follow
2108 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2109 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2110 (const :tag
"no confirmation (dangerous)" nil
)))
2111 (put 'org-confirm-shell-link-function
2112 'safe-local-variable
2113 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2115 (defcustom org-confirm-shell-link-not-regexp
""
2116 "A regexp to skip confirmation for shell links."
2117 :group
'org-link-follow
2121 (defcustom org-confirm-elisp-link-function
'yes-or-no-p
2122 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2123 Elisp links can be dangerous: just think about a link
2125 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2127 This link would show up in your Org-mode document as \"Google Search\",
2128 but really it would remove your entire home directory.
2129 Therefore we advise against setting this variable to nil.
2130 Just change it to `y-or-n-p' if you want to confirm with a
2131 single keystroke rather than having to type \"yes\"."
2132 :group
'org-link-follow
2134 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2135 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2136 (const :tag
"no confirmation (dangerous)" nil
)))
2137 (put 'org-confirm-shell-link-function
2138 'safe-local-variable
2139 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2141 (defcustom org-confirm-elisp-link-not-regexp
""
2142 "A regexp to skip confirmation for Elisp links."
2143 :group
'org-link-follow
2147 (defconst org-file-apps-defaults-gnu
2151 "Default file applications on a UNIX or GNU/Linux system.
2152 See `org-file-apps'.")
2154 (defconst org-file-apps-defaults-macosx
2157 (system .
"open %s")
2159 ("eps.gz" .
"gv %s")
2161 ("fig" .
"xfig %s"))
2162 "Default file applications on a MacOS X system.
2163 The system \"open\" is known as a default, but we use X11 applications
2164 for some files for which the OS does not have a good default.
2165 See `org-file-apps'.")
2167 (defconst org-file-apps-defaults-windowsnt
2171 (list (if (featurep 'xemacs
)
2172 'mswindows-shell-execute
2176 (list (if (featurep 'xemacs
)
2177 'mswindows-shell-execute
2180 "Default file applications on a Windows NT system.
2181 The system \"open\" is used for most files.
2182 See `org-file-apps'.")
2184 (defcustom org-file-apps
2185 '((auto-mode . emacs
)
2186 ("\\.mm\\'" . default
)
2187 ("\\.x?html?\\'" . default
)
2188 ("\\.pdf\\'" . default
))
2189 "External applications for opening `file:path' items in a document.
2190 Org-mode uses system defaults for different file types, but
2191 you can use this variable to set the application for a given file
2192 extension. The entries in this list are cons cells where the car identifies
2193 files and the cdr the corresponding command. Possible values for the
2195 \"string\" A string as a file identifier can be interpreted in different
2196 ways, depending on its contents:
2198 - Alphanumeric characters only:
2199 Match links with this file extension.
2200 Example: (\"pdf\" . \"evince %s\")
2201 to open PDFs with evince.
2203 - Regular expression: Match links where the
2204 filename matches the regexp. If you want to
2205 use groups here, use shy groups.
2207 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2208 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2209 to open *.html and *.xhtml with firefox.
2211 - Regular expression which contains (non-shy) groups:
2212 Match links where the whole link, including \"::\", and
2213 anything after that, matches the regexp.
2214 In a custom command string, %1, %2, etc. are replaced with
2215 the parts of the link that were matched by the groups.
2216 For backwards compatibility, if a command string is given
2217 that does not use any of the group matches, this case is
2218 handled identically to the second one (i.e. match against
2220 In a custom lisp form, you can access the group matches with
2221 (match-string n link).
2223 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2224 to open [[file:document.pdf::5]] with evince at page 5.
2226 `directory' Matches a directory
2227 `remote' Matches a remote file, accessible through tramp or efs.
2228 Remote files most likely should be visited through Emacs
2229 because external applications cannot handle such paths.
2230 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2231 so all files Emacs knows how to handle. Using this with
2232 command `emacs' will open most files in Emacs. Beware that this
2233 will also open html files inside Emacs, unless you add
2234 (\"html\" . default) to the list as well.
2235 t Default for files not matched by any of the other options.
2236 `system' The system command to open files, like `open' on Windows
2237 and Mac OS X, and mailcap under GNU/Linux. This is the command
2238 that will be selected if you call `C-c C-o' with a double
2239 \\[universal-argument] \\[universal-argument] prefix.
2241 Possible values for the command are:
2242 `emacs' The file will be visited by the current Emacs process.
2243 `default' Use the default application for this file type, which is the
2244 association for t in the list, most likely in the system-specific
2246 This can be used to overrule an unwanted setting in the
2247 system-specific variable.
2248 `system' Use the system command for opening files, like \"open\".
2249 This command is specified by the entry whose car is `system'.
2250 Most likely, the system-specific version of this variable
2251 does define this command, but you can overrule/replace it
2253 string A command to be executed by a shell; %s will be replaced
2254 by the path to the file.
2255 sexp A Lisp form which will be evaluated. The file path will
2256 be available in the Lisp variable `file'.
2257 For more examples, see the system specific constants
2258 `org-file-apps-defaults-macosx'
2259 `org-file-apps-defaults-windowsnt'
2260 `org-file-apps-defaults-gnu'."
2261 :group
'org-link-follow
2263 (cons (choice :value
""
2264 (string :tag
"Extension")
2265 (const :tag
"System command to open files" system
)
2266 (const :tag
"Default for unrecognized files" t
)
2267 (const :tag
"Remote file" remote
)
2268 (const :tag
"Links to a directory" directory
)
2269 (const :tag
"Any files that have Emacs modes"
2272 (const :tag
"Visit with Emacs" emacs
)
2273 (const :tag
"Use default" default
)
2274 (const :tag
"Use the system command" system
)
2275 (string :tag
"Command")
2276 (sexp :tag
"Lisp form")))))
2278 (defcustom org-doi-server-url
"http://dx.doi.org/"
2279 "The URL of the DOI server."
2282 :group
'org-link-follow
)
2284 (defgroup org-refile nil
2285 "Options concerning refiling entries in Org-mode."
2289 (defcustom org-directory
"~/org"
2290 "Directory with org files.
2291 This is just a default location to look for Org files. There is no need
2292 at all to put your files into this directory. It is only used in the
2293 following situations:
2295 1. When a capture template specifies a target file that is not an
2296 absolute path. The path will then be interpreted relative to
2298 2. When a capture note is filed away in an interactive way (when exiting the
2299 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2300 with `org-directory' as the default path."
2305 (defcustom org-default-notes-file
(convert-standard-filename "~/.notes")
2306 "Default target for storing notes.
2307 Used as a fall back file for org-capture.el, for templates that
2308 do not specify a target file."
2313 (defcustom org-goto-interface
'outline
2314 "The default interface to be used for `org-goto'.
2316 outline The interface shows an outline of the relevant file
2317 and the correct heading is found by moving through
2318 the outline or by searching with incremental search.
2319 outline-path-completion Headlines in the current buffer are offered via
2320 completion. This is the interface also used by
2321 the refile command."
2324 (const :tag
"Outline" outline
)
2325 (const :tag
"Outline-path-completion" outline-path-completion
)))
2327 (defcustom org-goto-max-level
5
2328 "Maximum target level when running `org-goto' with refile interface."
2332 (defcustom org-reverse-note-order nil
2333 "Non-nil means store new notes at the beginning of a file or entry.
2334 When nil, new notes will be filed to the end of a file or entry.
2335 This can also be a list with cons cells of regular expressions that
2336 are matched against file names, and values."
2340 (const :tag
"Reverse always" t
)
2341 (const :tag
"Reverse never" nil
)
2342 (repeat :tag
"By file name regexp"
2343 (cons regexp boolean
))))
2345 (defcustom org-log-refile nil
2346 "Information to record when a task is refiled.
2348 Possible values are:
2350 nil Don't add anything
2351 time Add a time stamp to the task
2352 note Prompt for a note and add it with template `org-log-note-headings'
2354 This option can also be set with on a per-file-basis with
2356 #+STARTUP: nologrefile
2357 #+STARTUP: logrefile
2358 #+STARTUP: lognoterefile
2360 You can have local logging settings for a subtree by setting the LOGGING
2361 property to one or more of these keywords.
2363 When bulk-refiling from the agenda, the value `note' is forbidden and
2364 will temporarily be changed to `time'."
2366 :group
'org-progress
2369 (const :tag
"No logging" nil
)
2370 (const :tag
"Record timestamp" time
)
2371 (const :tag
"Record timestamp with note." note
)))
2373 (defcustom org-refile-targets nil
2374 "Targets for refiling entries with \\[org-refile].
2375 This is a list of cons cells. Each cell contains:
2376 - a specification of the files to be considered, either a list of files,
2377 or a symbol whose function or variable value will be used to retrieve
2378 a file name or a list of file names. If you use `org-agenda-files' for
2379 that, all agenda files will be scanned for targets. Nil means consider
2380 headings in the current buffer.
2381 - A specification of how to find candidate refile targets. This may be
2383 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2384 This tag has to be present in all target headlines, inheritance will
2386 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2388 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2389 headlines that are refiling targets.
2390 - a cons cell (:level . N). Any headline of level N is considered a target.
2391 Note that, when `org-odd-levels-only' is set, level corresponds to
2392 order in hierarchy, not to the number of stars.
2393 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2394 Note that, when `org-odd-levels-only' is set, level corresponds to
2395 order in hierarchy, not to the number of stars.
2397 Each element of this list generates a set of possible targets.
2398 The union of these sets is presented (with completion) to
2399 the user by `org-refile'.
2401 You can set the variable `org-refile-target-verify-function' to a function
2402 to verify each headline found by the simple criteria above.
2404 When this variable is nil, all top-level headlines in the current buffer
2405 are used, equivalent to the value `((nil . (:level . 1))'."
2409 (choice :value org-agenda-files
2410 (const :tag
"All agenda files" org-agenda-files
)
2411 (const :tag
"Current buffer" nil
)
2412 (function) (variable) (file))
2413 (choice :tag
"Identify target headline by"
2414 (cons :tag
"Specific tag" (const :value
:tag
) (string))
2415 (cons :tag
"TODO keyword" (const :value
:todo
) (string))
2416 (cons :tag
"Regular expression" (const :value
:regexp
) (regexp))
2417 (cons :tag
"Level number" (const :value
:level
) (integer))
2418 (cons :tag
"Max Level number" (const :value
:maxlevel
) (integer))))))
2420 (defcustom org-refile-target-verify-function nil
2421 "Function to verify if the headline at point should be a refile target.
2422 The function will be called without arguments, with point at the
2423 beginning of the headline. It should return t and leave point
2424 where it is if the headline is a valid target for refiling.
2426 If the target should not be selected, the function must return nil.
2427 In addition to this, it may move point to a place from where the search
2428 should be continued. For example, the function may decide that the entire
2429 subtree of the current entry should be excluded and move point to the end
2436 (defcustom org-refile-use-cache nil
2437 "Non-nil means cache refile targets to speed up the process.
2438 The cache for a particular file will be updated automatically when
2439 the buffer has been killed, or when any of the marker used for flagging
2440 refile targets no longer points at a live buffer.
2441 If you have added new entries to a buffer that might themselves be targets,
2442 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2443 find that easier, `C-u C-u C-u C-c C-w'."
2448 (defcustom org-refile-use-outline-path nil
2449 "Non-nil means provide refile targets as paths.
2450 So a level 3 headline will be available as level1/level2/level3.
2452 When the value is `file', also include the file name (without directory)
2453 into the path. In this case, you can also stop the completion after
2454 the file name, to get entries inserted as top level in the file.
2456 When `full-file-path', include the full file path."
2459 (const :tag
"Not" nil
)
2460 (const :tag
"Yes" t
)
2461 (const :tag
"Start with file name" file
)
2462 (const :tag
"Start with full file path" full-file-path
)))
2464 (defcustom org-outline-path-complete-in-steps t
2465 "Non-nil means complete the outline path in hierarchical steps.
2466 When Org-mode uses the refile interface to select an outline path
2467 \(see variable `org-refile-use-outline-path'), the completion of
2468 the path can be done in a single go, or it can be done in steps down
2469 the headline hierarchy. Going in steps is probably the best if you
2470 do not use a special completion package like `ido' or `icicles'.
2471 However, when using these packages, going in one step can be very
2472 fast, while still showing the whole path to the entry."
2476 (defcustom org-refile-allow-creating-parent-nodes nil
2477 "Non-nil means allow to create new nodes as refile targets.
2478 New nodes are then created by adding \"/new node name\" to the completion
2479 of an existing node. When the value of this variable is `confirm',
2480 new node creation must be confirmed by the user (recommended).
2481 When nil, the completion must match an existing entry.
2483 Note that, if the new heading is not seen by the criteria
2484 listed in `org-refile-targets', multiple instances of the same
2485 heading would be created by trying again to file under the new
2489 (const :tag
"Never" nil
)
2490 (const :tag
"Always" t
)
2491 (const :tag
"Prompt for confirmation" confirm
)))
2493 (defcustom org-refile-active-region-within-subtree nil
2494 "Non-nil means also refile active region within a subtree.
2496 By default `org-refile' doesn't allow refiling regions if they
2497 don't contain a set of subtrees, but it might be convenient to
2498 do so sometimes: in that case, the first line of the region is
2499 converted to a headline before refiling."
2504 (defgroup org-todo nil
2505 "Options concerning TODO items in Org-mode."
2509 (defgroup org-progress nil
2510 "Options concerning Progress logging in Org-mode."
2514 (defvar org-todo-interpretation-widgets
2515 '((:tag
"Sequence (cycling hits every state)" sequence
)
2516 (:tag
"Type (cycling directly to DONE)" type
))
2517 "The available interpretation symbols for customizing `org-todo-keywords'.
2518 Interested libraries should add to this list.")
2520 (defcustom org-todo-keywords
'((sequence "TODO" "DONE"))
2521 "List of TODO entry keyword sequences and their interpretation.
2522 \\<org-mode-map>This is a list of sequences.
2524 Each sequence starts with a symbol, either `sequence' or `type',
2525 indicating if the keywords should be interpreted as a sequence of
2526 action steps, or as different types of TODO items. The first
2527 keywords are states requiring action - these states will select a headline
2528 for inclusion into the global TODO list Org-mode produces. If one of
2529 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2530 signify that no further action is necessary. If \"|\" is not found,
2531 the last keyword is treated as the only DONE state of the sequence.
2533 The command \\[org-todo] cycles an entry through these states, and one
2534 additional state where no keyword is present. For details about this
2535 cycling, see the manual.
2537 TODO keywords and interpretation can also be set on a per-file basis with
2538 the special #+SEQ_TODO and #+TYP_TODO lines.
2540 Each keyword can optionally specify a character for fast state selection
2541 \(in combination with the variable `org-use-fast-todo-selection')
2542 and specifiers for state change logging, using the same syntax that
2543 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2544 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2545 indicates to record a time stamp each time this state is selected.
2547 Each keyword may also specify if a timestamp or a note should be
2548 recorded when entering or leaving the state, by adding additional
2549 characters in the parenthesis after the keyword. This looks like this:
2550 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2551 record only the time of the state change. With X and Y being either
2552 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2553 Y when leaving the state if and only if the *target* state does not
2554 define X. You may omit any of the fast-selection key or X or /Y,
2555 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2557 For backward compatibility, this variable may also be just a list
2558 of keywords. In this case the interpretation (sequence or type) will be
2559 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2561 :group
'org-keywords
2563 (repeat :tag
"Old syntax, just keywords"
2564 (string :tag
"Keyword"))
2565 (repeat :tag
"New syntax"
2568 :tag
"Interpretation"
2569 ;;Quick and dirty way to see
2570 ;;`org-todo-interpretations'. This takes the
2571 ;;place of item arguments
2579 org-todo-interpretation-widgets
))
2582 (string :tag
"Keyword"))))))
2584 (defvar org-todo-keywords-1 nil
2585 "All TODO and DONE keywords active in a buffer.")
2586 (make-variable-buffer-local 'org-todo-keywords-1
)
2587 (defvar org-todo-keywords-for-agenda nil
)
2588 (defvar org-done-keywords-for-agenda nil
)
2589 (defvar org-todo-keyword-alist-for-agenda nil
)
2590 (defvar org-tag-alist-for-agenda nil
2591 "Alist of all tags from all agenda files.")
2592 (defvar org-tag-groups-alist-for-agenda nil
2593 "Alist of all groups tags from all current agenda files.")
2594 (defvar org-tag-groups-alist nil
)
2595 (make-variable-buffer-local 'org-tag-groups-alist
)
2596 (defvar org-agenda-contributing-files nil
)
2597 (defvar org-not-done-keywords nil
)
2598 (make-variable-buffer-local 'org-not-done-keywords
)
2599 (defvar org-done-keywords nil
)
2600 (make-variable-buffer-local 'org-done-keywords
)
2601 (defvar org-todo-heads nil
)
2602 (make-variable-buffer-local 'org-todo-heads
)
2603 (defvar org-todo-sets nil
)
2604 (make-variable-buffer-local 'org-todo-sets
)
2605 (defvar org-todo-log-states nil
)
2606 (make-variable-buffer-local 'org-todo-log-states
)
2607 (defvar org-todo-kwd-alist nil
)
2608 (make-variable-buffer-local 'org-todo-kwd-alist
)
2609 (defvar org-todo-key-alist nil
)
2610 (make-variable-buffer-local 'org-todo-key-alist
)
2611 (defvar org-todo-key-trigger nil
)
2612 (make-variable-buffer-local 'org-todo-key-trigger
)
2614 (defcustom org-todo-interpretation
'sequence
2615 "Controls how TODO keywords are interpreted.
2616 This variable is in principle obsolete and is only used for
2617 backward compatibility, if the interpretation of todo keywords is
2618 not given already in `org-todo-keywords'. See that variable for
2621 :group
'org-keywords
2622 :type
'(choice (const sequence
)
2625 (defcustom org-use-fast-todo-selection t
2626 "Non-nil means use the fast todo selection scheme with C-c C-t.
2627 This variable describes if and under what circumstances the cycling
2628 mechanism for TODO keywords will be replaced by a single-key, direct
2631 When nil, fast selection is never used.
2633 When the symbol `prefix', it will be used when `org-todo' is called
2634 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2635 `C-u t' in an agenda buffer.
2637 When t, fast selection is used by default. In this case, the prefix
2638 argument forces cycling instead.
2640 In all cases, the special interface is only used if access keys have
2641 actually been assigned by the user, i.e. if keywords in the configuration
2642 are followed by a letter in parenthesis, like TODO(t)."
2645 (const :tag
"Never" nil
)
2646 (const :tag
"By default" t
)
2647 (const :tag
"Only with C-u C-c C-t" prefix
)))
2649 (defcustom org-provide-todo-statistics t
2650 "Non-nil means update todo statistics after insert and toggle.
2651 ALL-HEADLINES means update todo statistics by including headlines
2652 with no TODO keyword as well, counting them as not done.
2653 A list of TODO keywords means the same, but skip keywords that are
2655 When set to a list of two lists, the first list contains keywords
2656 to consider as TODO keywords, the second list contains keywords
2657 to consider as DONE keywords.
2659 When this is set, todo statistics is updated in the parent of the
2660 current entry each time a todo state is changed."
2663 (const :tag
"Yes, only for TODO entries" t
)
2664 (const :tag
"Yes, including all entries" all-headlines
)
2665 (repeat :tag
"Yes, for TODOs in this list"
2666 (string :tag
"TODO keyword"))
2667 (list :tag
"Yes, for TODOs and DONEs in these lists"
2668 (repeat (string :tag
"TODO keyword"))
2669 (repeat (string :tag
"DONE keyword")))
2670 (other :tag
"No TODO statistics" nil
)))
2672 (defcustom org-hierarchical-todo-statistics t
2673 "Non-nil means TODO statistics covers just direct children.
2674 When nil, all entries in the subtree are considered.
2675 This has only an effect if `org-provide-todo-statistics' is set.
2676 To set this to nil for only a single subtree, use a COOKIE_DATA
2677 property and include the word \"recursive\" into the value."
2681 (defcustom org-after-todo-state-change-hook nil
2682 "Hook which is run after the state of a TODO item was changed.
2683 The new state (a string with a TODO keyword, or nil) is available in the
2684 Lisp variable `org-state'."
2688 (defvar org-blocker-hook nil
2689 "Hook for functions that are allowed to block a state change.
2691 Functions in this hook should not modify the buffer.
2692 Each function gets as its single argument a property list,
2693 see `org-trigger-hook' for more information about this list.
2695 If any of the functions in this hook returns nil, the state change
2698 (defvar org-trigger-hook nil
2699 "Hook for functions that are triggered by a state change.
2701 Each function gets as its single argument a property list with at
2702 least the following elements:
2704 (:type type-of-change :position pos-at-entry-start
2705 :from old-state :to new-state)
2707 Depending on the type, more properties may be present.
2709 This mechanism is currently implemented for:
2713 :type todo-state-change
2714 :from previous state (keyword as a string), or nil, or a symbol
2715 'todo' or 'done', to indicate the general type of state.
2716 :to new state, like in :from")
2718 (defcustom org-enforce-todo-dependencies nil
2719 "Non-nil means undone TODO entries will block switching the parent to DONE.
2720 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2721 be blocked if any prior sibling is not yet done.
2722 Finally, if the parent is blocked because of ordered siblings of its own,
2723 the child will also be blocked."
2724 :set
(lambda (var val
)
2727 (add-hook 'org-blocker-hook
2728 'org-block-todo-from-children-or-siblings-or-parent
)
2729 (remove-hook 'org-blocker-hook
2730 'org-block-todo-from-children-or-siblings-or-parent
)))
2734 (defcustom org-enforce-todo-checkbox-dependencies nil
2735 "Non-nil means unchecked boxes will block switching the parent to DONE.
2736 When this is nil, checkboxes have no influence on switching TODO states.
2737 When non-nil, you first need to check off all check boxes before the TODO
2738 entry can be switched to DONE.
2739 This variable needs to be set before org.el is loaded, and you need to
2740 restart Emacs after a change to make the change effective. The only way
2741 to change is while Emacs is running is through the customize interface."
2742 :set
(lambda (var val
)
2745 (add-hook 'org-blocker-hook
2746 'org-block-todo-from-checkboxes
)
2747 (remove-hook 'org-blocker-hook
2748 'org-block-todo-from-checkboxes
)))
2752 (defcustom org-treat-insert-todo-heading-as-state-change nil
2753 "Non-nil means inserting a TODO heading is treated as state change.
2754 So when the command \\[org-insert-todo-heading] is used, state change
2755 logging will apply if appropriate. When nil, the new TODO item will
2756 be inserted directly, and no logging will take place."
2760 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2761 "Non-nil means switching TODO states with S-cursor counts as state change.
2762 This is the default behavior. However, setting this to nil allows a
2763 convenient way to select a TODO state and bypass any logging associated
2768 (defcustom org-todo-state-tags-triggers nil
2769 "Tag changes that should be triggered by TODO state changes.
2770 This is a list. Each entry is
2772 (state-change (tag . flag) .......)
2774 State-change can be a string with a state, and empty string to indicate the
2775 state that has no TODO keyword, or it can be one of the symbols `todo'
2776 or `done', meaning any not-done or done state, respectively."
2780 (cons (choice :tag
"When changing to"
2781 (const :tag
"Not-done state" todo
)
2782 (const :tag
"Done state" done
)
2783 (string :tag
"State"))
2785 (cons :tag
"Tag action"
2787 (choice (const :tag
"Add" t
) (const :tag
"Remove" nil
)))))))
2789 (defcustom org-log-done nil
2790 "Information to record when a task moves to the DONE state.
2792 Possible values are:
2794 nil Don't add anything, just change the keyword
2795 time Add a time stamp to the task
2796 note Prompt for a note and add it with template `org-log-note-headings'
2798 This option can also be set with on a per-file-basis with
2800 #+STARTUP: nologdone
2802 #+STARTUP: lognotedone
2804 You can have local logging settings for a subtree by setting the LOGGING
2805 property to one or more of these keywords."
2807 :group
'org-progress
2809 (const :tag
"No logging" nil
)
2810 (const :tag
"Record CLOSED timestamp" time
)
2811 (const :tag
"Record CLOSED timestamp with note." note
)))
2813 ;; Normalize old uses of org-log-done.
2815 ((eq org-log-done t
) (setq org-log-done
'time
))
2816 ((and (listp org-log-done
) (memq 'done org-log-done
))
2817 (setq org-log-done
'note
)))
2819 (defcustom org-log-reschedule nil
2820 "Information to record when the scheduling date of a tasks is modified.
2822 Possible values are:
2824 nil Don't add anything, just change the date
2825 time Add a time stamp to the task
2826 note Prompt for a note and add it with template `org-log-note-headings'
2828 This option can also be set with on a per-file-basis with
2830 #+STARTUP: nologreschedule
2831 #+STARTUP: logreschedule
2832 #+STARTUP: lognotereschedule"
2834 :group
'org-progress
2836 (const :tag
"No logging" nil
)
2837 (const :tag
"Record timestamp" time
)
2838 (const :tag
"Record timestamp with note." note
)))
2840 (defcustom org-log-redeadline nil
2841 "Information to record when the deadline date of a tasks is modified.
2843 Possible values are:
2845 nil Don't add anything, just change the date
2846 time Add a time stamp to the task
2847 note Prompt for a note and add it with template `org-log-note-headings'
2849 This option can also be set with on a per-file-basis with
2851 #+STARTUP: nologredeadline
2852 #+STARTUP: logredeadline
2853 #+STARTUP: lognoteredeadline
2855 You can have local logging settings for a subtree by setting the LOGGING
2856 property to one or more of these keywords."
2858 :group
'org-progress
2860 (const :tag
"No logging" nil
)
2861 (const :tag
"Record timestamp" time
)
2862 (const :tag
"Record timestamp with note." note
)))
2864 (defcustom org-log-note-clock-out nil
2865 "Non-nil means record a note when clocking out of an item.
2866 This can also be configured on a per-file basis by adding one of
2867 the following lines anywhere in the buffer:
2869 #+STARTUP: lognoteclock-out
2870 #+STARTUP: nolognoteclock-out"
2872 :group
'org-progress
2875 (defcustom org-log-done-with-time t
2876 "Non-nil means the CLOSED time stamp will contain date and time.
2877 When nil, only the date will be recorded."
2878 :group
'org-progress
2881 (defcustom org-log-note-headings
2882 '((done .
"CLOSING NOTE %t")
2883 (state .
"State %-12s from %-12S %t")
2884 (note .
"Note taken on %t")
2885 (reschedule .
"Rescheduled from %S on %t")
2886 (delschedule .
"Not scheduled, was %S on %t")
2887 (redeadline .
"New deadline from %S on %t")
2888 (deldeadline .
"Removed deadline, was %S on %t")
2889 (refile .
"Refiled on %t")
2891 "Headings for notes added to entries.
2892 The value is an alist, with the car being a symbol indicating the note
2893 context, and the cdr is the heading to be used. The heading may also be the
2895 %t in the heading will be replaced by a time stamp.
2896 %T will be an active time stamp instead the default inactive one
2897 %d will be replaced by a short-format time stamp.
2898 %D will be replaced by an active short-format time stamp.
2899 %s will be replaced by the new TODO state, in double quotes.
2900 %S will be replaced by the old TODO state, in double quotes.
2901 %u will be replaced by the user name.
2902 %U will be replaced by the full user name.
2904 In fact, it is not a good idea to change the `state' entry, because
2905 agenda log mode depends on the format of these entries."
2907 :group
'org-progress
2908 :type
'(list :greedy t
2909 (cons (const :tag
"Heading when closing an item" done
) string
)
2911 "Heading when changing todo state (todo sequence only)"
2913 (cons (const :tag
"Heading when just taking a note" note
) string
)
2914 (cons (const :tag
"Heading when rescheduling" reschedule
) string
)
2915 (cons (const :tag
"Heading when an item is no longer scheduled" delschedule
) string
)
2916 (cons (const :tag
"Heading when changing deadline" redeadline
) string
)
2917 (cons (const :tag
"Heading when deleting a deadline" deldeadline
) string
)
2918 (cons (const :tag
"Heading when refiling" refile
) string
)
2919 (cons (const :tag
"Heading when clocking out" clock-out
) string
)))
2921 (unless (assq 'note org-log-note-headings
)
2922 (push '(note .
"%t") org-log-note-headings
))
2924 (defcustom org-log-into-drawer nil
2925 "Non-nil means insert state change notes and time stamps into a drawer.
2926 When nil, state changes notes will be inserted after the headline and
2927 any scheduling and clock lines, but not inside a drawer.
2929 The value of this variable should be the name of the drawer to use.
2930 LOGBOOK is proposed as the default drawer for this purpose, you can
2931 also set this to a string to define the drawer of your choice.
2933 A value of t is also allowed, representing \"LOGBOOK\".
2935 A value of t or nil can also be set with on a per-file-basis with
2937 #+STARTUP: logdrawer
2938 #+STARTUP: nologdrawer
2940 If this variable is set, `org-log-state-notes-insert-after-drawers'
2943 You can set the property LOG_INTO_DRAWER to overrule this setting for
2946 Do not check directly this variable in a Lisp program. Call
2947 function `org-log-into-drawer' instead."
2949 :group
'org-progress
2951 (const :tag
"Not into a drawer" nil
)
2952 (const :tag
"LOGBOOK" t
)
2953 (string :tag
"Other")))
2955 (org-defvaralias 'org-log-state-notes-into-drawer
'org-log-into-drawer
)
2957 (defun org-log-into-drawer ()
2958 "Name of the log drawer, as a string, or nil.
2959 This is the value of `org-log-into-drawer'. However, if the
2960 current entry has or inherits a LOG_INTO_DRAWER property, it will
2961 be used instead of the default value."
2962 (let ((p (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit t
)))
2963 (cond ((equal p
"nil") nil
)
2964 ((equal p
"t") "LOGBOOK")
2967 ((stringp org-log-into-drawer
) org-log-into-drawer
)
2968 (org-log-into-drawer "LOGBOOK"))))
2970 (defcustom org-log-state-notes-insert-after-drawers nil
2971 "Non-nil means insert state change notes after any drawers in entry.
2972 Only the drawers that *immediately* follow the headline and the
2973 deadline/scheduled line are skipped.
2974 When nil, insert notes right after the heading and perhaps the line
2975 with deadline/scheduling if present.
2977 This variable will have no effect if `org-log-into-drawer' is
2980 :group
'org-progress
2983 (defcustom org-log-states-order-reversed t
2984 "Non-nil means the latest state note will be directly after heading.
2985 When nil, the state change notes will be ordered according to time.
2987 This option can also be set with on a per-file-basis with
2989 #+STARTUP: logstatesreversed
2990 #+STARTUP: nologstatesreversed"
2992 :group
'org-progress
2995 (defcustom org-todo-repeat-to-state nil
2996 "The TODO state to which a repeater should return the repeating task.
2997 By default this is the first task in a TODO sequence, or the previous state
2998 in a TODO_TYP set. But you can specify another task here.
2999 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3002 :type
'(choice (const :tag
"Head of sequence" nil
)
3003 (string :tag
"Specific state")))
3005 (defcustom org-log-repeat
'time
3006 "Non-nil means record moving through the DONE state when triggering repeat.
3007 An auto-repeating task is immediately switched back to TODO when
3008 marked DONE. If you are not logging state changes (by adding \"@\"
3009 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3010 record a closing note, there will be no record of the task moving
3011 through DONE. This variable forces taking a note anyway.
3013 nil Don't force a record
3014 time Record a time stamp
3015 note Prompt for a note and add it with template `org-log-note-headings'
3017 This option can also be set with on a per-file-basis with
3019 #+STARTUP: nologrepeat
3020 #+STARTUP: logrepeat
3021 #+STARTUP: lognoterepeat
3023 You can have local logging settings for a subtree by setting the LOGGING
3024 property to one or more of these keywords."
3026 :group
'org-progress
3028 (const :tag
"Don't force a record" nil
)
3029 (const :tag
"Force recording the DONE state" time
)
3030 (const :tag
"Force recording a note with the DONE state" note
)))
3033 (defgroup org-priorities nil
3034 "Priorities in Org-mode."
3035 :tag
"Org Priorities"
3038 (defcustom org-enable-priority-commands t
3039 "Non-nil means priority commands are active.
3040 When nil, these commands will be disabled, so that you never accidentally
3042 :group
'org-priorities
3045 (defcustom org-highest-priority ?A
3046 "The highest priority of TODO items. A character like ?A, ?B etc.
3047 Must have a smaller ASCII number than `org-lowest-priority'."
3048 :group
'org-priorities
3051 (defcustom org-lowest-priority ?C
3052 "The lowest priority of TODO items. A character like ?A, ?B etc.
3053 Must have a larger ASCII number than `org-highest-priority'."
3054 :group
'org-priorities
3057 (defcustom org-default-priority ?B
3058 "The default priority of TODO items.
3059 This is the priority an item gets if no explicit priority is given.
3060 When starting to cycle on an empty priority the first step in the cycle
3061 depends on `org-priority-start-cycle-with-default'. The resulting first
3062 step priority must not exceed the range from `org-highest-priority' to
3063 `org-lowest-priority' which means that `org-default-priority' has to be
3064 in this range exclusive or inclusive the range boundaries. Else the
3065 first step refuses to set the default and the second will fall back
3066 to (depending on the command used) the highest or lowest priority."
3067 :group
'org-priorities
3070 (defcustom org-priority-start-cycle-with-default t
3071 "Non-nil means start with default priority when starting to cycle.
3072 When this is nil, the first step in the cycle will be (depending on the
3073 command used) one higher or lower than the default priority.
3074 See also `org-default-priority'."
3075 :group
'org-priorities
3078 (defcustom org-get-priority-function nil
3079 "Function to extract the priority from a string.
3080 The string is normally the headline. If this is nil Org computes the
3081 priority from the priority cookie like [#A] in the headline. It returns
3082 an integer, increasing by 1000 for each priority level.
3083 The user can set a different function here, which should take a string
3084 as an argument and return the numeric priority."
3085 :group
'org-priorities
3091 (defgroup org-time nil
3092 "Options concerning time stamps and deadlines in Org-mode."
3096 (defcustom org-time-stamp-rounding-minutes
'(0 5)
3097 "Number of minutes to round time stamps to.
3098 These are two values, the first applies when first creating a time stamp.
3099 The second applies when changing it with the commands `S-up' and `S-down'.
3100 When changing the time stamp, this means that it will change in steps
3101 of N minutes, as given by the second value.
3103 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3104 numbers should be factors of 60, so for example 5, 10, 15.
3106 When this is larger than 1, you can still force an exact time stamp by using
3107 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3108 and by using a prefix arg to `S-up/down' to specify the exact number
3109 of minutes to shift."
3111 :get
(lambda (var) ; Make sure both elements are there
3112 (if (integerp (default-value var
))
3113 (list (default-value var
) 5)
3114 (default-value var
)))
3116 (integer :tag
"when inserting times")
3117 (integer :tag
"when modifying times")))
3119 ;; Normalize old customizations of this variable.
3120 (when (integerp org-time-stamp-rounding-minutes
)
3121 (setq org-time-stamp-rounding-minutes
3122 (list org-time-stamp-rounding-minutes
3123 org-time-stamp-rounding-minutes
)))
3125 (defcustom org-display-custom-times nil
3126 "Non-nil means overlay custom formats over all time stamps.
3127 The formats are defined through the variable `org-time-stamp-custom-formats'.
3128 To turn this on on a per-file basis, insert anywhere in the file:
3129 #+STARTUP: customtime"
3133 (make-variable-buffer-local 'org-display-custom-times
)
3135 (defcustom org-time-stamp-custom-formats
3136 '("<%m/%d/%y %a>" .
"<%m/%d/%y %a %H:%M>") ; american
3137 "Custom formats for time stamps. See `format-time-string' for the syntax.
3138 These are overlaid over the default ISO format if the variable
3139 `org-display-custom-times' is set. Time like %H:%M should be at the
3140 end of the second format. The custom formats are also honored by export
3141 commands, if custom time display is turned on at the time of export."
3145 (defun org-time-stamp-format (&optional long inactive
)
3146 "Get the right format for a time string."
3147 (let ((f (if long
(cdr org-time-stamp-formats
)
3148 (car org-time-stamp-formats
))))
3150 (concat "[" (substring f
1 -
1) "]")
3153 (defcustom org-time-clocksum-format
3154 '(:days
"%dd " :hours
"%d" :require-hours t
:minutes
":%02d" :require-minutes t
)
3155 "The format string used when creating CLOCKSUM lines.
3156 This is also used when Org mode generates a time duration.
3158 The value can be a single format string containing two
3159 %-sequences, which will be filled with the number of hours and
3160 minutes in that order.
3162 Alternatively, the value can be a plist associating any of the
3163 keys :years, :months, :weeks, :days, :hours or :minutes with
3164 format strings. The time duration is formatted using only the
3165 time components that are needed and concatenating the results.
3166 If a time unit in absent, it falls back to the next smallest
3169 The keys :require-years, :require-months, :require-days,
3170 :require-weeks, :require-hours, :require-minutes are also
3171 meaningful. A non-nil value for these keys indicates that the
3172 corresponding time component should always be included, even if
3178 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3181 means durations longer than a day will be expressed in days,
3182 hours and minutes, and durations less than a day will always be
3183 expressed in hours and minutes (even for durations less than an
3188 \(:days \"%dd\" :minutes \"%dm\")
3190 means durations longer than a day will be expressed in days and
3191 minutes, and durations less than a day will be expressed entirely
3192 in minutes (even for durations longer than an hour)."
3196 :package-version
'(Org .
"8.0")
3197 :type
'(choice (string :tag
"Format string")
3199 (group :inline t
(const :tag
"Years" :years
)
3200 (string :tag
"Format string"))
3202 (const :tag
"Always show years" :require-years
)
3204 (group :inline t
(const :tag
"Months" :months
)
3205 (string :tag
"Format string"))
3207 (const :tag
"Always show months" :require-months
)
3209 (group :inline t
(const :tag
"Weeks" :weeks
)
3210 (string :tag
"Format string"))
3212 (const :tag
"Always show weeks" :require-weeks
)
3214 (group :inline t
(const :tag
"Days" :days
)
3215 (string :tag
"Format string"))
3217 (const :tag
"Always show days" :require-days
)
3219 (group :inline t
(const :tag
"Hours" :hours
)
3220 (string :tag
"Format string"))
3222 (const :tag
"Always show hours" :require-hours
)
3224 (group :inline t
(const :tag
"Minutes" :minutes
)
3225 (string :tag
"Format string"))
3227 (const :tag
"Always show minutes" :require-minutes
)
3230 (defcustom org-time-clocksum-use-fractional nil
3231 "When non-nil, \\[org-clock-display] uses fractional times.
3232 See `org-time-clocksum-format' for more on time clock formats."
3238 (defcustom org-time-clocksum-use-effort-durations nil
3239 "When non-nil, \\[org-clock-display] uses effort durations.
3240 E.g. by default, one day is considered to be a 8 hours effort,
3241 so a task that has been clocked for 16 hours will be displayed
3242 as during 2 days in the clock display or in the clocktable.
3244 See `org-effort-durations' on how to set effort durations
3245 and `org-time-clocksum-format' for more on time clock formats."
3249 :package-version
'(Org .
"8.0")
3252 (defcustom org-time-clocksum-fractional-format
"%.2f"
3253 "The format string used when creating CLOCKSUM lines,
3254 or when Org mode generates a time duration, if
3255 `org-time-clocksum-use-fractional' is enabled.
3257 The value can be a single format string containing one
3258 %-sequence, which will be filled with the number of hours as
3261 Alternatively, the value can be a plist associating any of the
3262 keys :years, :months, :weeks, :days, :hours or :minutes with
3263 a format string. The time duration is formatted using the
3264 largest time unit which gives a non-zero integer part. If all
3265 specified formats have zero integer part, the smallest time unit
3268 :type
'(choice (string :tag
"Format string")
3269 (set (group :inline t
(const :tag
"Years" :years
)
3270 (string :tag
"Format string"))
3271 (group :inline t
(const :tag
"Months" :months
)
3272 (string :tag
"Format string"))
3273 (group :inline t
(const :tag
"Weeks" :weeks
)
3274 (string :tag
"Format string"))
3275 (group :inline t
(const :tag
"Days" :days
)
3276 (string :tag
"Format string"))
3277 (group :inline t
(const :tag
"Hours" :hours
)
3278 (string :tag
"Format string"))
3279 (group :inline t
(const :tag
"Minutes" :minutes
)
3280 (string :tag
"Format string")))))
3282 (defcustom org-deadline-warning-days
14
3283 "Number of days before expiration during which a deadline becomes active.
3284 This variable governs the display in sparse trees and in the agenda.
3285 When 0 or negative, it means use this number (the absolute value of it)
3286 even if a deadline has a different individual lead time specified.
3288 Custom commands can set this variable in the options section."
3290 :group
'org-agenda-daily
/weekly
3293 (defcustom org-scheduled-delay-days
0
3294 "Number of days before a scheduled item becomes active.
3295 This variable governs the display in sparse trees and in the agenda.
3296 The default value (i.e. 0) means: don't delay scheduled item.
3297 When negative, it means use this number (the absolute value of it)
3298 even if a scheduled item has a different individual delay time
3301 Custom commands can set this variable in the options section."
3303 :group
'org-agenda-daily
/weekly
3305 :package-version
'(Org .
"8.0")
3308 (defcustom org-read-date-prefer-future t
3309 "Non-nil means assume future for incomplete date input from user.
3310 This affects the following situations:
3311 1. The user gives a month but not a year.
3312 For example, if it is April and you enter \"feb 2\", this will be read
3313 as Feb 2, *next* year. \"May 5\", however, will be this year.
3314 2. The user gives a day, but no month.
3315 For example, if today is the 15th, and you enter \"3\", Org-mode will
3316 read this as the third of *next* month. However, if you enter \"17\",
3317 it will be considered as *this* month.
3319 If you set this variable to the symbol `time', then also the following
3322 3. If the user gives a time.
3323 If the time is before now, it will be interpreted as tomorrow.
3325 Currently none of this works for ISO week specifications.
3327 When this option is nil, the current day, month and year will always be
3330 See also `org-agenda-jump-prefer-future'."
3333 (const :tag
"Never" nil
)
3334 (const :tag
"Check month and day" t
)
3335 (const :tag
"Check month, day, and time" time
)))
3337 (defcustom org-agenda-jump-prefer-future
'org-read-date-prefer-future
3338 "Should the agenda jump command prefer the future for incomplete dates?
3339 The default is to do the same as configured in `org-read-date-prefer-future'.
3340 But you can also set a deviating value here.
3341 This may t or nil, or the symbol `org-read-date-prefer-future'."
3346 (const :tag
"Use org-read-date-prefer-future"
3347 org-read-date-prefer-future
)
3348 (const :tag
"Never" nil
)
3349 (const :tag
"Always" t
)))
3351 (defcustom org-read-date-force-compatible-dates t
3352 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3354 Depending on the system Emacs is running on, certain dates cannot
3355 be represented with the type used internally to represent time.
3356 Dates between 1970-1-1 and 2038-1-1 can always be represented
3357 correctly. Some systems allow for earlier dates, some for later,
3358 some for both. One way to find out it to insert any date into an
3359 Org buffer, putting the cursor on the year and hitting S-up and
3360 S-down to test the range.
3362 When this variable is set to t, the date/time prompt will not let
3363 you specify dates outside the 1970-2037 range, so it is certain that
3364 these dates will work in whatever version of Emacs you are
3365 running, and also that you can move a file from one Emacs implementation
3366 to another. WHenever Org is forcing the year for you, it will display
3369 When this variable is nil, Org will check if the date is
3370 representable in the specific Emacs implementation you are using.
3371 If not, it will force a year, usually the current year, and beep
3372 to remind you. Currently this setting is not recommended because
3373 the likelihood that you will open your Org files in an Emacs that
3374 has limited date range is not negligible.
3376 A workaround for this problem is to use diary sexp dates for time
3377 stamps outside of this range."
3382 (defcustom org-read-date-display-live t
3383 "Non-nil means display current interpretation of date prompt live.
3384 This display will be in an overlay, in the minibuffer."
3388 (defcustom org-read-date-popup-calendar t
3389 "Non-nil means pop up a calendar when prompting for a date.
3390 In the calendar, the date can be selected with mouse-1. However, the
3391 minibuffer will also be active, and you can simply enter the date as well.
3392 When nil, only the minibuffer will be available."
3395 (org-defvaralias 'org-popup-calendar-for-date-prompt
3396 'org-read-date-popup-calendar
)
3398 (make-obsolete-variable
3399 'org-read-date-minibuffer-setup-hook
3400 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3401 (defcustom org-read-date-minibuffer-setup-hook nil
3402 "Hook to be used to set up keys for the date/time interface.
3403 Add key definitions to `minibuffer-local-map', which will be a
3406 WARNING: This option is obsolete, you should use
3407 `org-read-date-minibuffer-local-map' to set up keys."
3411 (defcustom org-extend-today-until
0
3412 "The hour when your day really ends. Must be an integer.
3413 This has influence for the following applications:
3414 - When switching the agenda to \"today\". It it is still earlier than
3415 the time given here, the day recognized as TODAY is actually yesterday.
3416 - When a date is read from the user and it is still before the time given
3417 here, the current date and time will be assumed to be yesterday, 23:59.
3418 Also, timestamps inserted in capture templates follow this rule.
3420 IMPORTANT: This is a feature whose implementation is and likely will
3421 remain incomplete. Really, it is only here because past midnight seems to
3422 be the favorite working time of John Wiegley :-)"
3426 (defcustom org-use-effective-time nil
3427 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3428 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3429 \"effective time\" of any timestamps between midnight and 8am will be
3430 23:59 of the previous day."
3435 (defcustom org-use-last-clock-out-time-as-effective-time nil
3436 "When non-nil, use the last clock out time for `org-todo'.
3437 Note that this option has precedence over the combined use of
3438 `org-use-effective-time' and `org-extend-today-until'."
3441 :package-version
'(Org .
"8.0")
3444 (defcustom org-edit-timestamp-down-means-later nil
3445 "Non-nil means S-down will increase the time in a time stamp.
3446 When nil, S-up will increase."
3450 (defcustom org-calendar-follow-timestamp-change t
3451 "Non-nil means make the calendar window follow timestamp changes.
3452 When a timestamp is modified and the calendar window is visible, it will be
3453 moved to the new date."
3457 (defgroup org-tags nil
3458 "Options concerning tags in Org-mode."
3462 (defcustom org-tag-alist nil
3463 "List of tags allowed in Org-mode files.
3464 When this list is nil, Org-mode will base TAG input on what is already in the
3466 The value of this variable is an alist, the car of each entry must be a
3467 keyword as a string, the cdr may be a character that is used to select
3468 that tag through the fast-tag-selection interface.
3469 See the manual for details."
3473 (cons (string :tag
"Tag name")
3474 (character :tag
"Access char"))
3475 (list :tag
"Start radio group"
3477 (option (string :tag
"Group description")))
3478 (list :tag
"Start tag group, non distinct"
3479 (const :startgrouptag
)
3480 (option (string :tag
"Group description")))
3481 (list :tag
"Group tags delimiter"
3483 (list :tag
"End radio group"
3485 (option (string :tag
"Group description")))
3486 (list :tag
"End tag group, non distinct"
3487 (const :endgrouptag
)
3488 (option (string :tag
"Group description")))
3489 (const :tag
"New line" (:newline
)))))
3491 (defcustom org-tag-persistent-alist nil
3492 "List of tags that will always appear in all Org-mode files.
3493 This is in addition to any in buffer settings or customizations
3495 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3496 The value of this variable is an alist, the car of each entry must be a
3497 keyword as a string, the cdr may be a character that is used to select
3498 that tag through the fast-tag-selection interface.
3499 See the manual for details.
3500 To disable these tags on a per-file basis, insert anywhere in the file:
3505 (cons (string :tag
"Tag name")
3506 (character :tag
"Access char"))
3507 (const :tag
"Start radio group" (:startgroup
))
3508 (const :tag
"Group tags delimiter" (:grouptags
))
3509 (const :tag
"End radio group" (:endgroup
))
3510 (const :tag
"New line" (:newline
)))))
3512 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3513 "If non-nil, always offer completion for all tags of all agenda files.
3514 Instead of customizing this variable directly, you might want to
3515 set it locally for capture buffers, because there no list of
3516 tags in that file can be created dynamically (there are none).
3518 (add-hook 'org-capture-mode-hook
3520 (set (make-local-variable
3521 'org-complete-tags-always-offer-all-agenda-tags)
3527 (defvar org-file-tags nil
3528 "List of tags that can be inherited by all entries in the file.
3529 The tags will be inherited if the variable `org-use-tag-inheritance'
3530 says they should be.
3531 This variable is populated from #+FILETAGS lines.")
3533 (defcustom org-use-fast-tag-selection
'auto
3534 "Non-nil means use fast tag selection scheme.
3535 This is a special interface to select and deselect tags with single keys.
3536 When nil, fast selection is never used.
3537 When the symbol `auto', fast selection is used if and only if selection
3538 characters for tags have been configured, either through the variable
3539 `org-tag-alist' or through a #+TAGS line in the buffer.
3540 When t, fast selection is always used and selection keys are assigned
3541 automatically if necessary."
3544 (const :tag
"Always" t
)
3545 (const :tag
"Never" nil
)
3546 (const :tag
"When selection characters are configured" auto
)))
3548 (defcustom org-fast-tag-selection-single-key nil
3549 "Non-nil means fast tag selection exits after first change.
3550 When nil, you have to press RET to exit it.
3551 During fast tag selection, you can toggle this flag with `C-c'.
3552 This variable can also have the value `expert'. In this case, the window
3553 displaying the tags menu is not even shown, until you press C-c again."
3556 (const :tag
"No" nil
)
3557 (const :tag
"Yes" t
)
3558 (const :tag
"Expert" expert
)))
3560 (defvar org-fast-tag-selection-include-todo nil
3561 "Non-nil means fast tags selection interface will also offer TODO states.
3562 This is an undocumented feature, you should not rely on it.")
3564 (defcustom org-tags-column
(if (featurep 'xemacs
) -
76 -
77)
3565 "The column to which tags should be indented in a headline.
3566 If this number is positive, it specifies the column. If it is negative,
3567 it means that the tags should be flushright to that column. For example,
3568 -80 works well for a normal 80 character screen.
3569 When 0, place tags directly after headline text, with only one space in
3574 (defcustom org-auto-align-tags t
3575 "Non-nil keeps tags aligned when modifying headlines.
3576 Some operations (i.e. demoting) change the length of a headline and
3577 therefore shift the tags around. With this option turned on, after
3578 each such operation the tags are again aligned to `org-tags-column'."
3582 (defcustom org-use-tag-inheritance t
3583 "Non-nil means tags in levels apply also for sublevels.
3584 When nil, only the tags directly given in a specific line apply there.
3585 This may also be a list of tags that should be inherited, or a regexp that
3586 matches tags that should be inherited. Additional control is possible
3587 with the variable `org-tags-exclude-from-inheritance' which gives an
3588 explicit list of tags to be excluded from inheritance, even if the value of
3589 `org-use-tag-inheritance' would select it for inheritance.
3591 If this option is t, a match early-on in a tree can lead to a large
3592 number of matches in the subtree when constructing the agenda or creating
3593 a sparse tree. If you only want to see the first match in a tree during
3594 a search, check out the variable `org-tags-match-list-sublevels'."
3597 (const :tag
"Not" nil
)
3598 (const :tag
"Always" t
)
3599 (repeat :tag
"Specific tags" (string :tag
"Tag"))
3600 (regexp :tag
"Tags matched by regexp")))
3602 (defcustom org-tags-exclude-from-inheritance nil
3603 "List of tags that should never be inherited.
3604 This is a way to exclude a few tags from inheritance. For way to do
3605 the opposite, to actively allow inheritance for selected tags,
3606 see the variable `org-use-tag-inheritance'."
3608 :type
'(repeat (string :tag
"Tag")))
3610 (defun org-tag-inherit-p (tag)
3611 "Check if TAG is one that should be inherited."
3613 ((member tag org-tags-exclude-from-inheritance
) nil
)
3614 ((eq org-use-tag-inheritance t
) t
)
3615 ((not org-use-tag-inheritance
) nil
)
3616 ((stringp org-use-tag-inheritance
)
3617 (string-match org-use-tag-inheritance tag
))
3618 ((listp org-use-tag-inheritance
)
3619 (member tag org-use-tag-inheritance
))
3620 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3622 (defcustom org-tags-match-list-sublevels t
3623 "Non-nil means list also sublevels of headlines matching a search.
3624 This variable applies to tags/property searches, and also to stuck
3625 projects because this search is based on a tags match as well.
3627 When set to the symbol `indented', sublevels are indented with
3630 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3631 the sublevels of a headline matching a tag search often also match
3632 the same search. Listing all of them can create very long lists.
3633 Setting this variable to nil causes subtrees of a match to be skipped.
3635 This variable is semi-obsolete and probably should always be true. It
3636 is better to limit inheritance to certain tags using the variables
3637 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3640 (const :tag
"No, don't list them" nil
)
3641 (const :tag
"Yes, do list them" t
)
3642 (const :tag
"List them, indented with leading dots" indented
)))
3644 (defcustom org-tags-sort-function nil
3645 "When set, tags are sorted using this function as a comparator."
3648 (const :tag
"No sorting" nil
)
3649 (const :tag
"Alphabetical" string
<)
3650 (const :tag
"Reverse alphabetical" string
>)
3651 (function :tag
"Custom function" nil
)))
3653 (defvar org-tags-history nil
3654 "History of minibuffer reads for tags.")
3655 (defvar org-last-tags-completion-table nil
3656 "The last used completion table for tags.")
3657 (defvar org-after-tags-change-hook nil
3658 "Hook that is run after the tags in a line have changed.")
3660 (defgroup org-properties nil
3661 "Options concerning properties in Org-mode."
3662 :tag
"Org Properties"
3665 (defcustom org-property-format
"%-10s %s"
3666 "How property key/value pairs should be formatted by `indent-line'.
3667 When `indent-line' hits a property definition, it will format the line
3668 according to this format, mainly to make sure that the values are
3669 lined-up with respect to each other."
3670 :group
'org-properties
3673 (defcustom org-properties-postprocess-alist nil
3674 "Alist of properties and functions to adjust inserted values.
3675 Elements of this alist must be of the form
3677 ([string] [function])
3679 where [string] must be a property name and [function] must be a
3680 lambda expression: this lambda expression must take one argument,
3681 the value to adjust, and return the new value as a string.
3683 For example, this element will allow the property \"Remaining\"
3684 to be updated wrt the relation between the \"Effort\" property
3685 and the clock summary:
3687 ((\"Remaining\" (lambda(value)
3688 (let ((clocksum (org-clock-sum-current-item))
3689 (effort (org-duration-string-to-minutes
3690 (org-entry-get (point) \"Effort\"))))
3691 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3692 :group
'org-properties
3694 :type
'(alist :key-type
(string :tag
"Property")
3695 :value-type
(function :tag
"Function")))
3697 (defcustom org-use-property-inheritance nil
3698 "Non-nil means properties apply also for sublevels.
3700 This setting is chiefly used during property searches. Turning it on can
3701 cause significant overhead when doing a search, which is why it is not
3704 When nil, only the properties directly given in the current entry count.
3705 When t, every property is inherited. The value may also be a list of
3706 properties that should have inheritance, or a regular expression matching
3707 properties that should be inherited.
3709 However, note that some special properties use inheritance under special
3710 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3711 and the properties ending in \"_ALL\" when they are used as descriptor
3712 for valid values of a property.
3714 Note for programmers:
3715 When querying an entry with `org-entry-get', you can control if inheritance
3716 should be used. By default, `org-entry-get' looks only at the local
3717 properties. You can request inheritance by setting the inherit argument
3718 to t (to force inheritance) or to `selective' (to respect the setting
3720 :group
'org-properties
3722 (const :tag
"Not" nil
)
3723 (const :tag
"Always" t
)
3724 (repeat :tag
"Specific properties" (string :tag
"Property"))
3725 (regexp :tag
"Properties matched by regexp")))
3727 (defun org-property-inherit-p (property)
3728 "Check if PROPERTY is one that should be inherited."
3730 ((eq org-use-property-inheritance t
) t
)
3731 ((not org-use-property-inheritance
) nil
)
3732 ((stringp org-use-property-inheritance
)
3733 (string-match org-use-property-inheritance property
))
3734 ((listp org-use-property-inheritance
)
3735 (member property org-use-property-inheritance
))
3736 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3738 (defcustom org-columns-default-format
"%25ITEM %TODO %3PRIORITY %TAGS"
3739 "The default column format, if no other format has been defined.
3740 This variable can be set on the per-file basis by inserting a line
3742 #+COLUMNS: %25ITEM ....."
3743 :group
'org-properties
3746 (defcustom org-columns-ellipses
".."
3747 "The ellipses to be used when a field in column view is truncated.
3748 When this is the empty string, as many characters as possible are shown,
3749 but then there will be no visual indication that the field has been truncated.
3750 When this is a string of length N, the last N characters of a truncated
3751 field are replaced by this string. If the column is narrower than the
3752 ellipses string, only part of the ellipses string will be shown."
3753 :group
'org-properties
3756 (defcustom org-columns-modify-value-for-display-function nil
3757 "Function that modifies values for display in column view.
3758 For example, it can be used to cut out a certain part from a time stamp.
3759 The function must take 2 arguments:
3761 column-title The title of the column (*not* the property name)
3762 value The value that should be modified.
3764 The function should return the value that should be displayed,
3765 or nil if the normal value should be used."
3766 :group
'org-properties
3767 :type
'(choice (const nil
) (function)))
3769 (defconst org-global-properties-fixed
3770 '(("VISIBILITY_ALL" .
"folded children content all")
3771 ("CLOCK_MODELINE_TOTAL_ALL" .
"current today repeat all auto"))
3772 "List of property/value pairs that can be inherited by any entry.
3774 These are fixed values, for the preset properties. The user variable
3775 that can be used to add to this list is `org-global-properties'.
3777 The entries in this list are cons cells where the car is a property
3778 name and cdr is a string with the value. If the value represents
3779 multiple items like an \"_ALL\" property, separate the items by
3782 (defcustom org-global-properties nil
3783 "List of property/value pairs that can be inherited by any entry.
3785 This list will be combined with the constant `org-global-properties-fixed'.
3787 The entries in this list are cons cells where the car is a property
3788 name and cdr is a string with the value.
3790 You can set buffer-local values for the same purpose in the variable
3791 `org-file-properties' this by adding lines like
3793 #+PROPERTY: NAME VALUE"
3794 :group
'org-properties
3796 (cons (string :tag
"Property")
3797 (string :tag
"Value"))))
3799 (defvar org-file-properties nil
3800 "List of property/value pairs that can be inherited by any entry.
3801 Valid for the current buffer.
3802 This variable is populated from #+PROPERTY lines.")
3803 (make-variable-buffer-local 'org-file-properties
)
3805 (defgroup org-agenda nil
3806 "Options concerning agenda views in Org-mode."
3810 (defvar org-category nil
3811 "Variable used by org files to set a category for agenda display.
3812 Such files should use a file variable to set it, for example
3814 # -*- mode: org; org-category: \"ELisp\"
3816 or contain a special line
3820 If the file does not specify a category, then file's base name
3822 (make-variable-buffer-local 'org-category
)
3823 (put 'org-category
'safe-local-variable
(lambda (x) (or (symbolp x
) (stringp x
))))
3825 (defcustom org-agenda-files nil
3826 "The files to be used for agenda display.
3827 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3828 \\[org-remove-file]. You can also use customize to edit the list.
3830 If an entry is a directory, all files in that directory that are matched by
3831 `org-agenda-file-regexp' will be part of the file list.
3833 If the value of the variable is not a list but a single file name, then
3834 the list of agenda files is actually stored and maintained in that file, one
3835 agenda file per line. In this file paths can be given relative to
3836 `org-directory'. Tilde expansion and environment variable substitution
3840 (repeat :tag
"List of files and directories" file
)
3841 (file :tag
"Store list in a file\n" :value
"~/.agenda_files")))
3843 (defcustom org-agenda-file-regexp
"\\`[^.].*\\.org\\'"
3844 "Regular expression to match files for `org-agenda-files'.
3845 If any element in the list in that variable contains a directory instead
3846 of a normal file, all files in that directory that are matched by this
3847 regular expression will be included."
3851 (defcustom org-agenda-text-search-extra-files nil
3852 "List of extra files to be searched by text search commands.
3853 These files will be searched in addition to the agenda files by the
3854 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3855 Note that these files will only be searched for text search commands,
3856 not for the other agenda views like todo lists, tag searches or the weekly
3857 agenda. This variable is intended to list notes and possibly archive files
3858 that should also be searched by these two commands.
3859 In fact, if the first element in the list is the symbol `agenda-archives',
3860 then all archive files of all agenda files will be added to the search
3863 :type
'(set :greedy t
3864 (const :tag
"Agenda Archives" agenda-archives
)
3865 (repeat :inline t
(file))))
3867 (org-defvaralias 'org-agenda-multi-occur-extra-files
3868 'org-agenda-text-search-extra-files
)
3870 (defcustom org-agenda-skip-unavailable-files nil
3871 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3872 A nil value means to remove them, after a query, from the list."
3876 (defcustom org-calendar-to-agenda-key
[?c
]
3877 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3878 The command `org-calendar-goto-agenda' will be bound to this key. The
3879 default is the character `c' because then `c' can be used to switch back and
3880 forth between agenda and calendar."
3884 (defcustom org-calendar-insert-diary-entry-key
[?i
]
3885 "The key to be installed in `calendar-mode-map' for adding diary entries.
3886 This option is irrelevant until `org-agenda-diary-file' has been configured
3887 to point to an Org-mode file. When that is the case, the command
3888 `org-agenda-diary-entry' will be bound to the key given here, by default
3889 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3890 if you want to continue doing this, you need to change this to a different
3895 (defcustom org-agenda-diary-file
'diary-file
3896 "File to which to add new entries with the `i' key in agenda and calendar.
3897 When this is the symbol `diary-file', the functionality in the Emacs
3898 calendar will be used to add entries to the `diary-file'. But when this
3899 points to a file, `org-agenda-diary-entry' will be used instead."
3902 (const :tag
"The standard Emacs diary file" diary-file
)
3903 (file :tag
"Special Org file diary entries")))
3905 (eval-after-load "calendar"
3907 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3908 'org-calendar-goto-agenda
)
3909 (add-hook 'calendar-mode-hook
3911 (unless (eq org-agenda-diary-file
'diary-file
)
3912 (define-key calendar-mode-map
3913 org-calendar-insert-diary-entry-key
3914 'org-agenda-diary-entry
))))))
3916 (defgroup org-latex nil
3917 "Options for embedding LaTeX code into Org-mode."
3921 (defcustom org-format-latex-options
3922 '(:foreground default
:background default
:scale
1.0
3923 :html-foreground
"Black" :html-background
"Transparent"
3924 :html-scale
1.0 :matchers
("begin" "$1" "$" "$$" "\\(" "\\["))
3925 "Options for creating images from LaTeX fragments.
3926 This is a property list with the following properties:
3927 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3928 `default' means use the foreground of the default face.
3929 `auto' means use the foreground from the text face.
3930 :background the background color, or \"Transparent\".
3931 `default' means use the background of the default face.
3932 `auto' means use the background from the text face.
3933 :scale a scaling factor for the size of the images, to get more pixels
3934 :html-foreground, :html-background, :html-scale
3935 the same numbers for HTML export.
3936 :matchers a list indicating which matchers should be used to
3937 find LaTeX fragments. Valid members of this list are:
3938 \"begin\" find environments
3939 \"$1\" find single characters surrounded by $.$
3940 \"$\" find math expressions surrounded by $...$
3941 \"$$\" find math expressions surrounded by $$....$$
3942 \"\\(\" find math expressions surrounded by \\(...\\)
3943 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3947 (defcustom org-format-latex-signal-error t
3948 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3949 When nil, just push out a message."
3954 (defcustom org-latex-to-mathml-jar-file nil
3955 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3956 Use this to specify additional executable file say a jar file.
3958 When using MathToWeb as the converter, specify the full-path to
3959 your mathtoweb.jar file."
3963 (const :tag
"None" nil
)
3964 (file :tag
"JAR file" :must-match t
)))
3966 (defcustom org-latex-to-mathml-convert-command nil
3967 "Command to convert LaTeX fragments to MathML.
3968 Replace format-specifiers in the command as noted below and use
3969 `shell-command' to convert LaTeX to MathML.
3970 %j: Executable file in fully expanded form as specified by
3971 `org-latex-to-mathml-jar-file'.
3972 %I: Input LaTeX file in fully expanded form.
3973 %i: The latex fragment to be converted.
3974 %o: Output MathML file.
3975 This command is used by `org-create-math-formula'.
3977 When using MathToWeb as the converter, set this to
3978 \"java -jar %j -unicode -force -df %o %I\".
3980 When using LaTeXML set this to
3981 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3985 (const :tag
"None" nil
)
3986 (string :tag
"\nShell command")))
3988 (defcustom org-latex-create-formula-image-program
'dvipng
3989 "Program to convert LaTeX fragments with.
3991 dvipng Process the LaTeX fragments to dvi file, then convert
3992 dvi files to png files using dvipng.
3993 This will also include processing of non-math environments.
3994 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3995 to convert pdf files to png files"
3999 (const :tag
"dvipng" dvipng
)
4000 (const :tag
"imagemagick" imagemagick
)))
4002 (defcustom org-latex-preview-ltxpng-directory
"ltxpng/"
4003 "Path to store latex preview images.
4004 A relative path here creates many directories relative to the
4005 processed org files paths. An absolute path puts all preview
4006 images at the same place."
4011 (defun org-format-latex-mathml-available-p ()
4012 "Return t if `org-latex-to-mathml-convert-command' is usable."
4014 (when (and (boundp 'org-latex-to-mathml-convert-command
)
4015 org-latex-to-mathml-convert-command
)
4016 (let ((executable (car (split-string
4017 org-latex-to-mathml-convert-command
))))
4018 (when (executable-find executable
)
4020 "%j" org-latex-to-mathml-convert-command
)
4021 (file-readable-p org-latex-to-mathml-jar-file
)
4024 (defcustom org-format-latex-header
"\\documentclass{article}
4025 \\usepackage[usenames]{color}
4028 \\pagestyle{empty} % do not remove
4029 % The settings below are copied from fullpage.sty
4030 \\setlength{\\textwidth}{\\paperwidth}
4031 \\addtolength{\\textwidth}{-3cm}
4032 \\setlength{\\oddsidemargin}{1.5cm}
4033 \\addtolength{\\oddsidemargin}{-2.54cm}
4034 \\setlength{\\evensidemargin}{\\oddsidemargin}
4035 \\setlength{\\textheight}{\\paperheight}
4036 \\addtolength{\\textheight}{-\\headheight}
4037 \\addtolength{\\textheight}{-\\headsep}
4038 \\addtolength{\\textheight}{-\\footskip}
4039 \\addtolength{\\textheight}{-3cm}
4040 \\setlength{\\topmargin}{1.5cm}
4041 \\addtolength{\\topmargin}{-2.54cm}"
4042 "The document header used for processing LaTeX fragments.
4043 It is imperative that this header make sure that no page number
4044 appears on the page. The package defined in the variables
4045 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4046 will either replace the placeholder \"[PACKAGES]\" in this
4047 header, or they will be appended."
4051 (defun org-set-packages-alist (var val
)
4052 "Set the packages alist and make sure it has 3 elements per entry."
4053 (set var
(mapcar (lambda (x)
4054 (if (and (consp x
) (= (length x
) 2))
4055 (list (car x
) (nth 1 x
) t
)
4059 (defun org-get-packages-alist (var)
4060 "Get the packages alist and make sure it has 3 elements per entry."
4062 (if (and (consp x
) (= (length x
) 2))
4063 (list (car x
) (nth 1 x
) t
)
4065 (default-value var
)))
4067 (defcustom org-latex-default-packages-alist
4068 '(("AUTO" "inputenc" t
)
4073 ("" "longtable" nil
)
4077 ("normalem" "ulem" t
)
4086 "Alist of default packages to be inserted in the header.
4088 Change this only if one of the packages here causes an
4089 incompatibility with another package you are using.
4091 The packages in this list are needed by one part or another of
4092 Org mode to function properly:
4094 - inputenc, fontenc: for basic font and character selection
4095 - fixltx2e: Important patches of LaTeX itself
4096 - graphicx: for including images
4097 - grffile: allow periods and spaces in graphics file names
4098 - longtable: For multipage tables
4099 - float, wrapfig: for figure placement
4100 - rotating: for sideways figures and tables
4101 - ulem: for underline and strike-through
4102 - amsmath: for subscript and superscript and math environments
4103 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4104 for interpreting the entities in `org-entities'. You can skip
4105 some of these packages if you don't use any of their symbols.
4106 - capt-of: for captions outside of floats
4107 - hyperref: for cross references
4109 Therefore you should not modify this variable unless you know
4110 what you are doing. The one reason to change it anyway is that
4111 you might be loading some other package that conflicts with one
4112 of the default packages. Each element is either a cell or
4115 A cell is of the format:
4117 \( \"options\" \"package\" SNIPPET-FLAG).
4119 If SNIPPET-FLAG is non-nil, the package also needs to be included
4120 when compiling LaTeX snippets into images for inclusion into
4123 A string will be inserted as-is in the header of the document."
4125 :group
'org-export-latex
4126 :set
'org-set-packages-alist
4127 :get
'org-get-packages-alist
4131 (list :tag
"options/package pair"
4132 (string :tag
"options")
4133 (string :tag
"package")
4134 (boolean :tag
"Snippet"))
4135 (string :tag
"A line of LaTeX"))))
4137 (defcustom org-latex-packages-alist nil
4138 "Alist of packages to be inserted in every LaTeX header.
4140 These will be inserted after `org-latex-default-packages-alist'.
4141 Each element is either a cell or a string.
4143 A cell is of the format:
4145 \(\"options\" \"package\" SNIPPET-FLAG)
4147 SNIPPET-FLAG, when non-nil, indicates that this package is also
4148 needed when turning LaTeX snippets into images for inclusion into
4151 A string will be inserted as-is in the header of the document.
4153 Make sure that you only list packages here which:
4155 - you want in every file;
4156 - do not conflict with the setup in `org-format-latex-header';
4157 - do not conflict with the default packages in
4158 `org-latex-default-packages-alist'."
4160 :group
'org-export-latex
4161 :set
'org-set-packages-alist
4162 :get
'org-get-packages-alist
4165 (list :tag
"options/package pair"
4166 (string :tag
"options")
4167 (string :tag
"package")
4168 (boolean :tag
"Snippet"))
4169 (string :tag
"A line of LaTeX"))))
4171 (defgroup org-appearance nil
4172 "Settings for Org-mode appearance."
4173 :tag
"Org Appearance"
4176 (defcustom org-level-color-stars-only nil
4177 "Non-nil means fontify only the stars in each headline.
4178 When nil, the entire headline is fontified.
4179 Changing it requires restart of `font-lock-mode' to become effective
4180 also in regions already fontified."
4181 :group
'org-appearance
4184 (defcustom org-hide-leading-stars nil
4185 "Non-nil means hide the first N-1 stars in a headline.
4186 This works by using the face `org-hide' for these stars. This
4187 face is white for a light background, and black for a dark
4188 background. You may have to customize the face `org-hide' to
4190 Changing it requires restart of `font-lock-mode' to become effective
4191 also in regions already fontified.
4192 You may also set this on a per-file basis by adding one of the following
4193 lines to the buffer:
4195 #+STARTUP: hidestars
4196 #+STARTUP: showstars"
4197 :group
'org-appearance
4200 (defcustom org-hidden-keywords nil
4201 "List of symbols corresponding to keywords to be hidden the org buffer.
4202 For example, a value '(title) for this list will make the document's title
4203 appear in the buffer without the initial #+TITLE: keyword."
4204 :group
'org-appearance
4206 :type
'(set (const :tag
"#+AUTHOR" author
)
4207 (const :tag
"#+DATE" date
)
4208 (const :tag
"#+EMAIL" email
)
4209 (const :tag
"#+TITLE" title
)))
4211 (defcustom org-custom-properties nil
4212 "List of properties (as strings) with a special meaning.
4213 The default use of these custom properties is to let the user
4214 hide them with `org-toggle-custom-properties-visibility'."
4215 :group
'org-properties
4216 :group
'org-appearance
4218 :type
'(repeat (string :tag
"Property Name")))
4220 (defcustom org-fontify-done-headline nil
4221 "Non-nil means change the face of a headline if it is marked DONE.
4222 Normally, only the TODO/DONE keyword indicates the state of a headline.
4223 When this is non-nil, the headline after the keyword is set to the
4224 `org-headline-done' as an additional indication."
4225 :group
'org-appearance
4228 (defcustom org-fontify-emphasized-text t
4229 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4230 Changing this variable requires a restart of Emacs to take effect."
4231 :group
'org-appearance
4234 (defcustom org-fontify-whole-heading-line nil
4235 "Non-nil means fontify the whole line for headings.
4236 This is useful when setting a background color for the
4238 :group
'org-appearance
4241 (defcustom org-highlight-latex-and-related nil
4242 "Non-nil means highlight LaTeX related syntax in the buffer.
4243 When non nil, the value should be a list containing any of the
4245 `latex' Highlight LaTeX snippets and environments.
4246 `script' Highlight subscript and superscript.
4247 `entities' Highlight entities."
4248 :group
'org-appearance
4250 :package-version
'(Org .
"8.0")
4252 (const :tag
"No highlighting" nil
)
4253 (set :greedy t
:tag
"Highlight"
4254 (const :tag
"LaTeX snippets and environments" latex
)
4255 (const :tag
"Subscript and superscript" script
)
4256 (const :tag
"Entities" entities
))))
4258 (defcustom org-hide-emphasis-markers nil
4259 "Non-nil mean font-lock should hide the emphasis marker characters."
4260 :group
'org-appearance
4263 (defcustom org-hide-macro-markers nil
4264 "Non-nil mean font-lock should hide the brackets marking macro calls."
4265 :group
'org-appearance
4268 (defcustom org-pretty-entities nil
4269 "Non-nil means show entities as UTF8 characters.
4270 When nil, the \\name form remains in the buffer."
4271 :group
'org-appearance
4275 (defcustom org-pretty-entities-include-sub-superscripts t
4276 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4277 :group
'org-appearance
4281 (defvar org-emph-re nil
4282 "Regular expression for matching emphasis.
4283 After a match, the match groups contain these elements:
4284 0 The match of the full regular expression, including the characters
4285 before and after the proper match
4286 1 The character before the proper match, or empty at beginning of line
4287 2 The proper match, including the leading and trailing markers
4288 3 The leading marker like * or /, indicating the type of highlighting
4289 4 The text between the emphasis markers, not including the markers
4290 5 The character after the match, empty at the end of a line")
4291 (defvar org-verbatim-re nil
4292 "Regular expression for matching verbatim text.")
4293 (defvar org-emphasis-regexp-components
) ; defined just below
4294 (defvar org-emphasis-alist
) ; defined just below
4295 (defun org-set-emph-re (var val
)
4296 "Set variable and compute the emphasis regular expression."
4298 (when (and (boundp 'org-emphasis-alist
)
4299 (boundp 'org-emphasis-regexp-components
)
4300 org-emphasis-alist org-emphasis-regexp-components
)
4301 (let* ((e org-emphasis-regexp-components
)
4307 (body1 (concat body
"*?"))
4308 (markers (mapconcat 'car org-emphasis-alist
""))
4309 (vmarkers (mapconcat
4310 (lambda (x) (if (eq (nth 2 x
) 'verbatim
) (car x
) ""))
4311 org-emphasis-alist
"")))
4312 ;; make sure special characters appear at the right position in the class
4313 (if (string-match "\\^" markers
)
4314 (setq markers
(concat (replace-match "" t t markers
) "^")))
4315 (if (string-match "-" markers
)
4316 (setq markers
(concat (replace-match "" t t markers
) "-")))
4317 (if (string-match "\\^" vmarkers
)
4318 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "^")))
4319 (if (string-match "-" vmarkers
)
4320 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "-")))
4322 (setq body1
(concat body1
"\\(?:\n" body
"*?\\)\\{0,"
4323 (int-to-string nl
) "\\}")))
4326 (concat "\\([" pre
"]\\|^\\)"
4328 "\\([" markers
"]\\)"
4336 "\\([" post
"]\\|$\\)"))
4337 (setq org-verbatim-re
4338 (concat "\\([" pre
"]\\|^\\)"
4340 "\\([" vmarkers
"]\\)"
4348 "\\([" post
"]\\|$\\)")))))
4350 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4351 ;; set this option proved cumbersome. See this message/thread:
4352 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4353 (defvar org-emphasis-regexp-components
4354 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4355 "Components used to build the regular expression for emphasis.
4356 This is a list with five entries. Terminology: In an emphasis string
4357 like \" *strong word* \", we call the initial space PREMATCH, the final
4358 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4359 and \"trong wor\" is the body. The different components in this variable
4360 specify what is allowed/forbidden in each part:
4362 pre Chars allowed as prematch. Beginning of line will be allowed too.
4363 post Chars allowed as postmatch. End of line will be allowed too.
4364 border The chars *forbidden* as border characters.
4365 body-regexp A regexp like \".\" to match a body character. Don't use
4366 non-shy groups here, and don't allow newline here.
4367 newline The maximum number of newlines allowed in an emphasis exp.
4369 You need to reload Org or to restart Emacs after customizing this.")
4371 (defcustom org-emphasis-alist
4375 ("=" org-verbatim verbatim
)
4376 ("~" org-code verbatim
)
4377 ("+" ,(if (featurep 'xemacs
) 'org-table
'(:strike-through t
))))
4378 "Alist of characters and faces to emphasize text.
4379 Text starting and ending with a special character will be emphasized,
4380 for example *bold*, _underlined_ and /italic/. This variable sets the
4381 marker characters and the face to be used by font-lock for highlighting
4382 in Org-mode Emacs buffers.
4384 You need to reload Org or to restart Emacs after customizing this."
4385 :group
'org-appearance
4386 :set
'org-set-emph-re
4388 :package-version
'(Org .
"8.0")
4391 (string :tag
"Marker character")
4393 (face :tag
"Font-lock-face")
4394 (plist :tag
"Face property list"))
4395 (option (const verbatim
)))))
4397 (defvar org-protecting-blocks
4398 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4399 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4400 This is needed for font-lock setup.")
4402 ;;; Miscellaneous options
4404 (defgroup org-completion nil
4405 "Completion in Org-mode."
4406 :tag
"Org Completion"
4409 (defcustom org-completion-use-ido nil
4410 "Non-nil means use ido completion wherever possible.
4411 Note that `ido-mode' must be active for this variable to be relevant.
4412 If you decide to turn this variable on, you might well want to turn off
4413 `org-outline-path-complete-in-steps'.
4414 See also `org-completion-use-iswitchb'."
4415 :group
'org-completion
4418 (defcustom org-completion-use-iswitchb nil
4419 "Non-nil means use iswitchb completion wherever possible.
4420 Note that `iswitchb-mode' must be active for this variable to be relevant.
4421 If you decide to turn this variable on, you might well want to turn off
4422 `org-outline-path-complete-in-steps'.
4423 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4424 :group
'org-completion
4427 (defcustom org-completion-fallback-command
'hippie-expand
4428 "The expansion command called by \\[pcomplete] in normal context.
4429 Normal means, no org-mode-specific context."
4430 :group
'org-completion
4433 ;;; Functions and variables from their packages
4434 ;; Declared here to avoid compiler warnings
4437 (defvar outline-mode-menu-heading
)
4438 (defvar outline-mode-menu-show
)
4439 (defvar outline-mode-menu-hide
)
4440 (defvar zmacs-regions
) ; XEmacs regions
4443 (defvar mark-active
)
4446 (declare-function calendar-iso-to-absolute
"cal-iso" (date))
4447 (declare-function calendar-forward-day
"cal-move" (arg))
4448 (declare-function calendar-goto-date
"cal-move" (date))
4449 (declare-function calendar-goto-today
"cal-move" ())
4450 (declare-function calendar-iso-from-absolute
"cal-iso" (date))
4451 (defvar calc-embedded-close-formula
)
4452 (defvar calc-embedded-open-formula
)
4453 (declare-function cdlatex-tab
"ext:cdlatex" ())
4454 (declare-function cdlatex-compute-tables
"ext:cdlatex" ())
4455 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
4456 (defvar font-lock-unfontify-region-function
)
4457 (declare-function iswitchb-read-buffer
"iswitchb"
4458 (prompt &optional default require-match start matches-set
))
4459 (defvar iswitchb-temp-buflist
)
4460 (declare-function org-gnus-follow-link
"org-gnus" (&optional group article
))
4461 (defvar org-agenda-tags-todo-honor-ignore-options
)
4462 (declare-function org-agenda-skip
"org-agenda" ())
4464 org-agenda-format-item
"org-agenda"
4465 (extra txt
&optional level category tags dotime noprefix remove-re habitp
))
4466 (declare-function org-agenda-new-marker
"org-agenda" (&optional pos
))
4467 (declare-function org-agenda-change-all-lines
"org-agenda"
4468 (newhead hdmarker
&optional fixface just-this
))
4469 (declare-function org-agenda-set-restriction-lock
"org-agenda" (&optional type
))
4470 (declare-function org-agenda-maybe-redo
"org-agenda" ())
4471 (declare-function org-agenda-save-markers-for-cut-and-paste
"org-agenda"
4473 (declare-function org-agenda-copy-local-variable
"org-agenda" (var))
4474 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4475 "org-agenda" (&optional end
))
4476 (declare-function org-inlinetask-remove-END-maybe
"org-inlinetask" ())
4477 (declare-function org-inlinetask-in-task-p
"org-inlinetask" ())
4478 (declare-function org-inlinetask-goto-beginning
"org-inlinetask" ())
4479 (declare-function org-inlinetask-goto-end
"org-inlinetask" ())
4480 (declare-function org-indent-mode
"org-indent" (&optional arg
))
4481 (declare-function parse-time-string
"parse-time" (string))
4482 (declare-function org-attach-reveal
"org-attach" (&optional if-exists
))
4483 (declare-function orgtbl-send-table
"org-table" (&optional maybe
))
4484 (defvar remember-data-file
)
4485 (defvar texmathp-why
)
4486 (declare-function speedbar-line-directory
"speedbar" (&optional depth
))
4487 (declare-function table--at-cell-p
"table" (position &optional object at-column
))
4488 (declare-function calc-eval
"calc" (str &optional separator
&rest args
))
4491 (defun turn-on-orgtbl ()
4492 "Unconditionally turn on `orgtbl-mode'."
4493 (require 'org-table
)
4496 (defun org-at-table-p (&optional table-type
)
4497 "Return t if the cursor is inside an org-type table.
4498 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4499 (if org-enable-table-editor
4501 (beginning-of-line 1)
4502 (looking-at (if table-type org-table-any-line-regexp
4503 org-table-line-regexp
)))
4505 (defsubst org-table-p
() (org-at-table-p))
4507 (defun org-at-table.el-p
()
4508 "Return t if and only if we are at a table.el table."
4509 (and (org-at-table-p 'any
)
4511 (goto-char (org-table-begin 'any
))
4512 (looking-at org-table1-hline-regexp
))))
4514 (defun org-table-recognize-table.el
()
4515 "If there is a table.el table nearby, recognize it and move into it."
4516 (if org-table-tab-recognizes-table.el
4517 (if (org-at-table.el-p
)
4519 (beginning-of-line 1)
4520 (if (looking-at org-table-dataline-regexp
)
4522 (if (looking-at org-table1-hline-regexp
)
4524 (beginning-of-line 2)
4525 (if (looking-at org-table-any-border-regexp
)
4526 (beginning-of-line -
1)))))
4527 (if (re-search-forward "|" (org-table-end t
) t
)
4530 (if (table--at-cell-p (point))
4532 (message "recognizing table.el table...")
4533 (table-recognize-table)
4534 (message "recognizing table.el table...done")))
4535 (error "This should not happen"))
4540 (defun org-at-table-hline-p ()
4541 "Return t if the cursor is inside a hline in a table."
4542 (if org-enable-table-editor
4544 (beginning-of-line 1)
4545 (looking-at org-table-hline-regexp
))
4548 (defun org-table-map-tables (function &optional quietly
)
4549 "Apply FUNCTION to the start of all tables in the buffer."
4553 (goto-char (point-min))
4554 (while (re-search-forward org-table-any-line-regexp nil t
)
4556 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4557 (beginning-of-line 1)
4558 (when (and (looking-at org-table-line-regexp
)
4559 ;; Exclude tables in src/example/verbatim/clocktable blocks
4560 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4561 (save-excursion (funcall function
))
4562 (or (looking-at org-table-line-regexp
)
4564 (re-search-forward org-table-any-border-regexp nil
1))))
4565 (unless quietly
(message "Mapping tables: done")))
4567 (declare-function org-clock-save-markers-for-cut-and-paste
"org-clock" (beg end
))
4568 (declare-function org-clock-update-mode-line
"org-clock" ())
4569 (declare-function org-resolve-clocks
"org-clock"
4570 (&optional also-non-dangling-p prompt last-valid
))
4572 (defun org-at-TBLFM-p (&optional pos
)
4573 "Non-nil when point (or POS) is in #+TBLFM line."
4575 (goto-char (or pos
(point)))
4577 (and (eq (org-element-type (org-element-at-point)) 'table
)
4578 (looking-at org-TBLFM-regexp
))))
4580 (defvar org-clock-start-time
)
4581 (defvar org-clock-marker
(make-marker)
4582 "Marker recording the last clock-in.")
4583 (defvar org-clock-hd-marker
(make-marker)
4584 "Marker recording the last clock-in, but the headline position.")
4585 (defvar org-clock-heading
""
4586 "The heading of the current clock entry.")
4587 (defun org-clock-is-active ()
4588 "Return the buffer where the clock is currently running.
4589 Return nil if no clock is running."
4590 (marker-buffer org-clock-marker
))
4592 (defun org-check-running-clock ()
4593 "Check if the current buffer contains the running clock.
4594 If yes, offer to stop it and to save the buffer with the changes."
4595 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
4596 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4599 (when (y-or-n-p "Save changed buffer?")
4602 (defun org-clocktable-try-shift (dir n
)
4603 "Check if this line starts a clock table, if yes, shift the time block."
4604 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4605 (org-clocktable-shift dir n
)))
4608 (defun org-clock-persistence-insinuate ()
4609 "Set up hooks for clock persistence."
4610 (require 'org-clock
)
4611 (add-hook 'org-mode-hook
'org-clock-load
)
4612 (add-hook 'kill-emacs-hook
'org-clock-save
))
4614 (defgroup org-archive nil
4615 "Options concerning archiving in Org-mode."
4617 :group
'org-structure
)
4619 (defcustom org-archive-location
"%s_archive::"
4620 "The location where subtrees should be archived.
4622 The value of this variable is a string, consisting of two parts,
4623 separated by a double-colon. The first part is a filename and
4624 the second part is a headline.
4626 When the filename is omitted, archiving happens in the same file.
4627 %s in the filename will be replaced by the current file
4628 name (without the directory part). Archiving to a different file
4629 is useful to keep archived entries from contributing to the
4632 The archived entries will be filed as subtrees of the specified
4633 headline. When the headline is omitted, the subtrees are simply
4634 filed away at the end of the file, as top-level entries. Also in
4635 the heading you can use %s to represent the file name, this can be
4636 useful when using the same archive for a number of different files.
4638 Here are a few examples:
4640 If the current file is Projects.org, archive in file
4641 Projects.org_archive, as top-level trees. This is the default.
4643 \"::* Archived Tasks\"
4644 Archive in the current file, under the top-level headline
4645 \"* Archived Tasks\".
4647 \"~/org/archive.org::\"
4648 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4650 \"~/org/archive.org::* From %s\"
4651 Archive in file ~/org/archive.org (absolute path), under headlines
4652 \"From FILENAME\" where file name is the current file name.
4654 \"~/org/datetree.org::datetree/* Finished Tasks\"
4655 The \"datetree/\" string is special, signifying to archive
4656 items to the datetree. Items are placed in either the CLOSED
4657 date of the item, or the current date if there is no CLOSED date.
4658 The heading will be a subentry to the current date. There doesn't
4659 need to be a heading, but there always needs to be a slash after
4660 datetree. For example, to store archived items directly in the
4661 datetree, use \"~/org/datetree.org::datetree/\".
4663 \"basement::** Finished Tasks\"
4664 Archive in file ./basement (relative path), as level 3 trees
4665 below the level 2 heading \"** Finished Tasks\".
4667 You may set this option on a per-file basis by adding to the buffer a
4670 #+ARCHIVE: basement::** Finished Tasks
4672 You may also define it locally for a subtree by setting an ARCHIVE property
4673 in the entry. If such a property is found in an entry, or anywhere up
4674 the hierarchy, it will be used."
4678 (defcustom org-agenda-skip-archived-trees t
4679 "Non-nil means the agenda will skip any items located in archived trees.
4680 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4681 variable is no longer recommended, you should leave it at the value t.
4682 Instead, use the key `v' to cycle the archives-mode in the agenda."
4684 :group
'org-agenda-skip
4687 (defcustom org-columns-skip-archived-trees t
4688 "Non-nil means ignore archived trees when creating column view."
4690 :group
'org-properties
4693 (defcustom org-cycle-open-archived-trees nil
4694 "Non-nil means `org-cycle' will open archived trees.
4695 An archived tree is a tree marked with the tag ARCHIVE.
4696 When nil, archived trees will stay folded. You can still open them with
4697 normal outline commands like `show-all', but not with the cycling commands."
4702 (defcustom org-sparse-tree-open-archived-trees nil
4703 "Non-nil means sparse tree construction shows matches in archived trees.
4704 When nil, matches in these trees are highlighted, but the trees are kept in
4707 :group
'org-sparse-trees
4710 (defcustom org-sparse-tree-default-date-type nil
4711 "The default date type when building a sparse tree.
4712 When this is nil, a date is a scheduled or a deadline timestamp.
4713 Otherwise, these types are allowed:
4716 active: only active timestamps (<...>)
4717 inactive: only inactive timestamps ([...])
4718 scheduled: only scheduled timestamps
4719 deadline: only deadline timestamps"
4720 :type
'(choice (const :tag
"Scheduled or deadline" nil
)
4721 (const :tag
"All timestamps" all
)
4722 (const :tag
"Only active timestamps" active
)
4723 (const :tag
"Only inactive timestamps" inactive
)
4724 (const :tag
"Only scheduled timestamps" scheduled
)
4725 (const :tag
"Only deadline timestamps" deadline
)
4726 (const :tag
"Only closed timestamps" closed
))
4728 :package-version
'(Org .
"8.3")
4729 :group
'org-sparse-trees
)
4731 (defun org-cycle-hide-archived-subtrees (state)
4732 "Re-hide all archived subtrees after a visibility state change."
4733 (when (and (not org-cycle-open-archived-trees
)
4734 (not (memq state
'(overview folded
))))
4736 (let* ((globalp (memq state
'(contents all
)))
4737 (beg (if globalp
(point-min) (point)))
4738 (end (if globalp
(point-max) (org-end-of-subtree t
))))
4739 (org-hide-archived-subtrees beg end
)
4741 (if (looking-at (concat ".*:" org-archive-tag
":"))
4742 (message "%s" (substitute-command-keys
4743 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4745 (defun org-force-cycle-archived ()
4746 "Cycle subtree even if it is archived."
4748 (setq this-command
'org-cycle
)
4749 (let ((org-cycle-open-archived-trees t
))
4750 (call-interactively 'org-cycle
)))
4752 (defun org-hide-archived-subtrees (beg end
)
4753 "Re-hide all archived subtrees after a visibility state change."
4754 (org-with-wide-buffer
4755 (let ((case-fold-search nil
)
4756 (re (concat org-outline-regexp-bol
".*:" org-archive-tag
":")))
4758 (while (and (< (point) end
) (re-search-forward re end t
))
4759 (when (member org-archive-tag
(org-get-tags))
4760 (org-flag-subtree t
)
4761 (org-end-of-subtree t
))))))
4763 (declare-function outline-end-of-heading
"outline" ())
4764 (declare-function outline-flag-region
"outline" (from to flag
))
4765 (defun org-flag-subtree (flag)
4767 (org-back-to-heading t
)
4768 (outline-end-of-heading)
4769 (outline-flag-region (point)
4770 (progn (org-end-of-subtree t
) (point))
4773 (defalias 'org-advertized-archive-subtree
'org-archive-subtree
)
4775 ;; Declare Column View Code
4777 (declare-function org-columns-number-to-string
"org-colview" (n fmt
&optional printf
))
4778 (declare-function org-columns-get-format-and-top-level
"org-colview" ())
4779 (declare-function org-columns-compute
"org-colview" (property))
4783 (declare-function org-id-store-link
"org-id")
4784 (declare-function org-id-locations-load
"org-id")
4785 (declare-function org-id-locations-save
"org-id")
4786 (defvar org-id-track-globally
)
4788 ;;; Variables for pre-computed regular expressions, all buffer local
4790 (defvar org-todo-regexp nil
4791 "Matches any of the TODO state keywords.")
4792 (make-variable-buffer-local 'org-todo-regexp
)
4793 (defvar org-not-done-regexp nil
4794 "Matches any of the TODO state keywords except the last one.")
4795 (make-variable-buffer-local 'org-not-done-regexp
)
4796 (defvar org-not-done-heading-regexp nil
4797 "Matches a TODO headline that is not done.")
4798 (make-variable-buffer-local 'org-not-done-heading-regexp
)
4799 (defvar org-todo-line-regexp nil
4800 "Matches a headline and puts TODO state into group 2 if present.")
4801 (make-variable-buffer-local 'org-todo-line-regexp
)
4802 (defvar org-complex-heading-regexp nil
4803 "Matches a headline and puts everything into groups:
4805 group 2: The todo keyword, maybe
4806 group 3: Priority cookie
4807 group 4: True headline
4809 (make-variable-buffer-local 'org-complex-heading-regexp
)
4810 (defvar org-complex-heading-regexp-format nil
4811 "Printf format to make regexp to match an exact headline.
4812 This regexp will match the headline of any node which has the
4813 exact headline text that is put into the format, but may have any
4814 TODO state, priority and tags.")
4815 (make-variable-buffer-local 'org-complex-heading-regexp-format
)
4816 (defvar org-todo-line-tags-regexp nil
4817 "Matches a headline and puts TODO state into group 2 if present.
4818 Also put tags into group 4 if tags are present.")
4819 (make-variable-buffer-local 'org-todo-line-tags-regexp
)
4821 (defconst org-plain-time-of-day-regexp
4824 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4827 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4829 "Regular expression to match a plain time or time range.
4830 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4831 groups carry important information:
4833 1 the first time, range or not
4834 8 the second time, if it is a range.")
4836 (defconst org-plain-time-extension-regexp
4839 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4840 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4841 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4842 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4843 groups carry important information:
4846 9 minutes of duration")
4848 (defconst org-stamp-time-of-day-regexp
4850 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4851 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4853 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4854 "Regular expression to match a timestamp time or time range.
4855 After a match, the following groups carry important information:
4857 1 date plus weekday, for back referencing to make sure both times are on the same day
4858 2 the first time, range or not
4859 4 the second time, if it is a range.")
4861 (defconst org-startup-options
4862 '(("fold" org-startup-folded t
)
4863 ("overview" org-startup-folded t
)
4864 ("nofold" org-startup-folded nil
)
4865 ("showall" org-startup-folded nil
)
4866 ("showeverything" org-startup-folded showeverything
)
4867 ("content" org-startup-folded content
)
4868 ("indent" org-startup-indented t
)
4869 ("noindent" org-startup-indented nil
)
4870 ("hidestars" org-hide-leading-stars t
)
4871 ("showstars" org-hide-leading-stars nil
)
4872 ("odd" org-odd-levels-only t
)
4873 ("oddeven" org-odd-levels-only nil
)
4874 ("align" org-startup-align-all-tables t
)
4875 ("noalign" org-startup-align-all-tables nil
)
4876 ("inlineimages" org-startup-with-inline-images t
)
4877 ("noinlineimages" org-startup-with-inline-images nil
)
4878 ("latexpreview" org-startup-with-latex-preview t
)
4879 ("nolatexpreview" org-startup-with-latex-preview nil
)
4880 ("customtime" org-display-custom-times t
)
4881 ("logdone" org-log-done time
)
4882 ("lognotedone" org-log-done note
)
4883 ("nologdone" org-log-done nil
)
4884 ("lognoteclock-out" org-log-note-clock-out t
)
4885 ("nolognoteclock-out" org-log-note-clock-out nil
)
4886 ("logrepeat" org-log-repeat state
)
4887 ("lognoterepeat" org-log-repeat note
)
4888 ("logdrawer" org-log-into-drawer t
)
4889 ("nologdrawer" org-log-into-drawer nil
)
4890 ("logstatesreversed" org-log-states-order-reversed t
)
4891 ("nologstatesreversed" org-log-states-order-reversed nil
)
4892 ("nologrepeat" org-log-repeat nil
)
4893 ("logreschedule" org-log-reschedule time
)
4894 ("lognotereschedule" org-log-reschedule note
)
4895 ("nologreschedule" org-log-reschedule nil
)
4896 ("logredeadline" org-log-redeadline time
)
4897 ("lognoteredeadline" org-log-redeadline note
)
4898 ("nologredeadline" org-log-redeadline nil
)
4899 ("logrefile" org-log-refile time
)
4900 ("lognoterefile" org-log-refile note
)
4901 ("nologrefile" org-log-refile nil
)
4902 ("fninline" org-footnote-define-inline t
)
4903 ("nofninline" org-footnote-define-inline nil
)
4904 ("fnlocal" org-footnote-section nil
)
4905 ("fnauto" org-footnote-auto-label t
)
4906 ("fnprompt" org-footnote-auto-label nil
)
4907 ("fnconfirm" org-footnote-auto-label confirm
)
4908 ("fnplain" org-footnote-auto-label plain
)
4909 ("fnadjust" org-footnote-auto-adjust t
)
4910 ("nofnadjust" org-footnote-auto-adjust nil
)
4911 ("constcgs" constants-unit-system cgs
)
4912 ("constSI" constants-unit-system SI
)
4913 ("noptag" org-tag-persistent-alist nil
)
4914 ("hideblocks" org-hide-block-startup t
)
4915 ("nohideblocks" org-hide-block-startup nil
)
4916 ("beamer" org-startup-with-beamer-mode t
)
4917 ("entitiespretty" org-pretty-entities t
)
4918 ("entitiesplain" org-pretty-entities nil
))
4919 "Variable associated with STARTUP options for org-mode.
4920 Each element is a list of three items: the startup options (as written
4921 in the #+STARTUP line), the corresponding variable, and the value to set
4922 this variable to if the option is found. An optional forth element PUSH
4923 means to push this value onto the list in the variable.")
4925 (defcustom org-group-tags t
4926 "When non-nil (the default), use group tags.
4927 This can be turned on/off through `org-toggle-tags-groups'."
4932 (defvar org-inhibit-startup nil
) ; Dynamically-scoped param.
4934 (defun org-toggle-tags-groups ()
4935 "Toggle support for group tags.
4936 Support for group tags is controlled by the option
4937 `org-group-tags', which is non-nil by default."
4939 (setq org-group-tags
(not org-group-tags
))
4940 (cond ((and (derived-mode-p 'org-agenda-mode
)
4943 ((derived-mode-p 'org-mode
)
4944 (let ((org-inhibit-startup t
)) (org-mode))))
4945 (message "Groups tags support has been turned %s"
4946 (if org-group-tags
"on" "off")))
4948 (defun org-set-regexps-and-options (&optional tags-only
)
4949 "Precompute regular expressions used in the current buffer.
4950 When optional argument TAGS-ONLY is non-nil, only compute tags
4951 related expressions."
4952 (when (derived-mode-p 'org-mode
)
4953 (let ((alist (org--setup-collect-keywords
4954 (org-make-options-regexp
4955 (append '("FILETAGS" "TAGS" "SETUPFILE")
4956 (and (not tags-only
)
4957 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4958 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4959 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4960 (org--setup-process-tags
4961 (cdr (assq 'tags alist
)) (cdr (assq 'filetags alist
)))
4964 (org-set-local 'org-file-properties
(cdr (assq 'property alist
)))
4965 ;; Archive location.
4966 (let ((archive (cdr (assq 'archive alist
))))
4967 (when archive
(org-set-local 'org-archive-location archive
)))
4969 (let ((cat (org-string-nw-p (cdr (assq 'category alist
)))))
4971 (org-set-local 'org-category
(intern cat
))
4972 (org-set-local 'org-file-properties
4973 (org--update-property-plist
4974 "CATEGORY" cat org-file-properties
))))
4976 (let ((column (cdr (assq 'columns alist
))))
4977 (when column
(org-set-local 'org-columns-default-format column
)))
4979 (setq org-table-formula-constants-local
(cdr (assq 'constants alist
)))
4980 ;; Link abbreviations.
4981 (let ((links (cdr (assq 'link alist
))))
4982 (when links
(setq org-link-abbrev-alist-local
(nreverse links
))))
4984 (let ((priorities (cdr (assq 'priorities alist
))))
4986 (org-set-local 'org-highest-priority
(nth 0 priorities
))
4987 (org-set-local 'org-lowest-priority
(nth 1 priorities
))
4988 (org-set-local 'org-default-priority
(nth 2 priorities
))))
4990 (let ((scripts (assq 'scripts alist
)))
4992 (org-set-local 'org-use-sub-superscripts
(cdr scripts
))))
4994 (let ((startup (cdr (assq 'startup alist
))))
4995 (dolist (option startup
)
4996 (let ((entry (assoc-string option org-startup-options t
)))
4998 (let ((var (nth 1 entry
))
4999 (val (nth 2 entry
)))
5000 (if (not (nth 3 entry
)) (org-set-local var val
)
5001 (unless (listp (symbol-value var
))
5002 (org-set-local var nil
))
5003 (add-to-list var val
)))))))
5005 (org-set-local 'org-todo-kwd-alist nil
)
5006 (org-set-local 'org-todo-key-alist nil
)
5007 (org-set-local 'org-todo-key-trigger nil
)
5008 (org-set-local 'org-todo-keywords-1 nil
)
5009 (org-set-local 'org-done-keywords nil
)
5010 (org-set-local 'org-todo-heads nil
)
5011 (org-set-local 'org-todo-sets nil
)
5012 (org-set-local 'org-todo-log-states nil
)
5013 (let ((todo-sequences
5014 (or (nreverse (cdr (assq 'todo alist
)))
5015 (let ((d (default-value 'org-todo-keywords
)))
5016 (if (not (stringp (car d
))) d
5017 ;; XXX: Backward compatibility code.
5018 (list (cons org-todo-interpretation d
)))))))
5019 (dolist (sequence todo-sequences
)
5020 (let* ((sequence (or (run-hook-with-args-until-success
5021 'org-todo-setup-filter-hook sequence
)
5023 (sequence-type (car sequence
))
5024 (keywords (cdr sequence
))
5025 (sep (member "|" keywords
))
5027 (dolist (k (remove "|" keywords
))
5028 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5030 (error "Invalid TODO keyword %s" k
))
5031 (let ((name (match-string 1 k
))
5032 (key (match-string 2 k
))
5033 (log (org-extract-log-state-settings k
)))
5035 (push (cons name
(and key
(string-to-char key
))) alist
)
5036 (when log
(push log org-todo-log-states
))))
5037 (let* ((names (nreverse names
))
5038 (done (if sep
(org-remove-keyword-keys (cdr sep
))
5041 (tail (list sequence-type head
(car done
) (org-last done
))))
5042 (add-to-list 'org-todo-heads head
'append
)
5043 (push names org-todo-sets
)
5044 (setq org-done-keywords
(append org-done-keywords done nil
))
5045 (setq org-todo-keywords-1
(append org-todo-keywords-1 names nil
))
5046 (setq org-todo-key-alist
5047 (append org-todo-key-alist
5049 (append '((:startgroup
))
5052 (dolist (k names
) (push (cons k tail
) org-todo-kwd-alist
))))))
5053 (setq org-todo-sets
(nreverse org-todo-sets
)
5054 org-todo-kwd-alist
(nreverse org-todo-kwd-alist
)
5055 org-todo-key-trigger
(delq nil
(mapcar #'cdr org-todo-key-alist
))
5056 org-todo-key-alist
(org-assign-fast-keys org-todo-key-alist
))
5057 ;; Compute the regular expressions and other local variables.
5058 ;; Using `org-outline-regexp-bol' would complicate them much,
5059 ;; because of the fixed white space at the end of that string.
5060 (if (not org-done-keywords
)
5061 (setq org-done-keywords
5062 (and org-todo-keywords-1
(last org-todo-keywords-1
))))
5063 (setq org-not-done-keywords
5064 (org-delete-all org-done-keywords
5065 (copy-sequence org-todo-keywords-1
))
5066 org-todo-regexp
(regexp-opt org-todo-keywords-1 t
)
5067 org-not-done-regexp
(regexp-opt org-not-done-keywords t
)
5068 org-not-done-heading-regexp
5069 (format org-heading-keyword-regexp-format org-not-done-regexp
)
5070 org-todo-line-regexp
5071 (format org-heading-keyword-maybe-regexp-format org-todo-regexp
)
5072 org-complex-heading-regexp
5073 (concat "^\\(\\*+\\)"
5074 "\\(?: +" org-todo-regexp
"\\)?"
5075 "\\(?: +\\(\\[#.\\]\\)\\)?"
5076 "\\(?: +\\(.*?\\)\\)??"
5077 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5079 org-complex-heading-regexp-format
5080 (concat "^\\(\\*+\\)"
5081 "\\(?: +" org-todo-regexp
"\\)?"
5082 "\\(?: +\\(\\[#.\\]\\)\\)?"
5084 ;; Stats cookies can be stuck to body.
5085 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5087 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5089 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5091 org-todo-line-tags-regexp
5092 (concat "^\\(\\*+\\)"
5093 "\\(?: +" org-todo-regexp
"\\)?"
5094 "\\(?: +\\(.*?\\)\\)??"
5095 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5097 (org-compute-latex-and-related-regexp)))))
5099 (defun org--setup-collect-keywords (regexp &optional files alist
)
5100 "Return setup keywords values as an alist.
5102 REGEXP matches a subset of setup keywords. FILES is a list of
5103 file names already visited. It is used to avoid circular setup
5104 files. ALIST, when non-nil, is the alist computed so far.
5106 Return value contains the following keys: `archive', `category',
5107 `columns', `constants', `filetags', `link', `priorities',
5108 `property', `scripts', `startup', `tags' and `todo'."
5109 (org-with-wide-buffer
5110 (goto-char (point-min))
5111 (let ((case-fold-search t
))
5112 (while (re-search-forward regexp nil t
)
5113 (let ((element (org-element-at-point)))
5114 (when (eq (org-element-type element
) 'keyword
)
5115 (let ((key (org-element-property :key element
))
5116 (value (org-element-property :value element
)))
5118 ((equal key
"ARCHIVE")
5119 (when (org-string-nw-p value
)
5120 (push (cons 'archive value
) alist
)))
5121 ((equal key
"CATEGORY") (push (cons 'category value
) alist
))
5122 ((equal key
"COLUMNS") (push (cons 'columns value
) alist
))
5123 ((equal key
"CONSTANTS")
5124 (let* ((constants (assq 'constants alist
))
5125 (store (cdr constants
)))
5126 (dolist (pair (org-split-string value
))
5127 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5129 (let* ((name (match-string 1 pair
))
5130 (value (match-string 2 pair
))
5131 (old (assoc name store
)))
5132 (if old
(setcdr old value
)
5133 (push (cons name value
) store
)))))
5134 (if constants
(setcdr constants store
)
5135 (push (cons 'constants store
) alist
))))
5136 ((equal key
"FILETAGS")
5137 (when (org-string-nw-p value
)
5138 (let ((old (assq 'filetags alist
))
5140 (mapcar (lambda (x) (org-split-string x
":"))
5141 (org-split-string value
)))))
5142 (if old
(setcdr old
(append new
(cdr old
)))
5143 (push (cons 'filetags new
) alist
)))))
5145 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value
)
5146 (let ((links (assq 'link alist
))
5147 (pair (cons (org-match-string-no-properties 1 value
)
5148 (org-match-string-no-properties 2 value
))))
5149 (if links
(push pair
(cdr links
))
5150 (push (list 'link pair
) alist
)))))
5151 ((equal key
"OPTIONS")
5152 (when (and (org-string-nw-p value
)
5153 (string-match "\\^:\\(t\\|nil\\|{}\\)" value
))
5154 (push (cons 'scripts
(read (match-string 1 value
))) alist
)))
5155 ((equal key
"PRIORITIES")
5156 (push (cons 'priorities
5157 (let ((prio (org-split-string value
)))
5158 (if (< (length prio
) 3) '(?A ?C ?B
)
5159 (mapcar #'string-to-char prio
))))
5161 ((equal key
"PROPERTY")
5162 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value
)
5163 (let* ((property (assq 'property alist
))
5164 (value (org--update-property-plist
5165 (org-match-string-no-properties 1 value
)
5166 (org-match-string-no-properties 2 value
)
5168 (if property
(setcdr property value
)
5169 (push (cons 'property value
) alist
)))))
5170 ((equal key
"STARTUP")
5171 (let ((startup (assq 'startup alist
)))
5174 (append (cdr startup
) (org-split-string value
)))
5175 (push (cons 'startup
(org-split-string value
)) alist
))))
5177 (let ((tag-cell (assq 'tags alist
)))
5180 (append (cdr tag-cell
)
5182 (org-split-string value
)))
5183 (push (cons 'tags
(org-split-string value
)) alist
))))
5184 ((member key
'("TODO" "SEQ_TODO" "TYP_TODO"))
5185 (let ((todo (assq 'todo alist
))
5186 (value (cons (if (equal key
"TYP_TODO") 'type
'sequence
)
5187 (org-split-string value
))))
5188 (if todo
(push value
(cdr todo
))
5189 (push (list 'todo value
) alist
))))
5190 ((equal key
"SETUPFILE")
5191 (unless buffer-read-only
; Do not check in Gnus messages.
5192 (let ((f (and (org-string-nw-p value
)
5194 (org-remove-double-quotes value
)))))
5195 (when (and f
(file-readable-p f
) (not (member f files
)))
5197 (insert-file-contents f
)
5199 ;; Fake Org mode to benefit from cache
5200 ;; without recurring needlessly.
5201 (let ((major-mode 'org-mode
))
5202 (org--setup-collect-keywords
5203 regexp
(cons f files
) alist
)))))))))))))))
5206 (defun org--setup-process-tags (tags filetags
)
5207 "Precompute variables used for tags.
5208 TAGS is a list of tags and tag group symbols, as strings.
5209 FILETAGS is a list of tags, as strings."
5210 ;; Process the file tags.
5211 (org-set-local 'org-file-tags
5212 (mapcar #'org-add-prop-inherited filetags
))
5213 ;; Provide default tags if no local tags are found.
5214 (when (and (not tags
) org-tag-alist
)
5216 (mapcar (lambda (tag)
5220 (:startgrouptag
"[")
5224 (otherwise (concat (car tag
)
5225 (and (characterp (cdr tag
))
5226 (format "(%c)" (cdr tag
)))))))
5228 ;; Process the tags.
5229 (org-set-local 'org-tag-groups-alist nil
)
5230 (org-set-local 'org-tag-alist nil
)
5233 (let ((e (car tags
)))
5234 (setq tags
(cdr tags
))
5237 (push '(:startgroup
) org-tag-alist
)
5238 (when (equal (nth 1 tags
) ":") (setq group-flag t
)))
5240 (push '(:endgroup
) org-tag-alist
)
5241 (setq group-flag nil
))
5243 (push '(:startgrouptag
) org-tag-alist
)
5244 (when (equal (nth 1 tags
) ":") (setq group-flag t
)))
5246 (push '(:endgrouptag
) org-tag-alist
)
5247 (setq group-flag nil
))
5249 (push '(:grouptags
) org-tag-alist
)
5250 (setq group-flag
'append
))
5251 ((equal e
"\\n") (push '(:newline
) org-tag-alist
))
5253 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5254 "\\|{.+?}\\)" ; regular expression
5255 "\\(?:(\\(.\\))\\)?\\'")) e
)
5256 (let ((tag (match-string 1 e
))
5257 (key (and (match-beginning 2)
5258 (string-to-char (match-string 2 e
)))))
5259 (cond ((eq group-flag
'append
)
5260 (setcar org-tag-groups-alist
5261 (append (car org-tag-groups-alist
) (list tag
))))
5262 (group-flag (push (list tag
) org-tag-groups-alist
)))
5263 ;; Push all tags in groups, no matter if they already exist.
5264 (unless (and (not group-flag
) (assoc tag org-tag-alist
))
5265 (push (cons tag key
) org-tag-alist
))))))))
5266 (setq org-tag-alist
(nreverse org-tag-alist
)))
5268 (defun org-file-contents (file &optional noerror
)
5269 "Return the contents of FILE, as a string."
5270 (if (and file
(file-readable-p file
))
5272 (insert-file-contents file
)
5274 (funcall (if noerror
'message
'error
)
5275 "Cannot read file \"%s\"%s"
5277 (let ((from (buffer-file-name (buffer-base-buffer))))
5278 (if from
(concat " (referenced in file \"" from
"\")") "")))))
5280 (defun org-extract-log-state-settings (x)
5281 "Extract the log state setting from a TODO keyword string.
5282 This will extract info from a string like \"WAIT(w@/!)\"."
5283 (let (kw key log1 log2
)
5284 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x
)
5285 (setq kw
(match-string 1 x
)
5286 key
(and (match-end 2) (match-string 2 x
))
5287 log1
(and (match-end 3) (match-string 3 x
))
5288 log2
(and (match-end 4) (match-string 4 x
)))
5291 (and log1
(if (equal log1
"!") 'time
'note
))
5292 (and log2
(if (equal log2
"!") 'time
'note
)))))))
5294 (defun org-remove-keyword-keys (list)
5295 "Remove a pair of parenthesis at the end of each string in LIST."
5297 (if (string-match "(.*)$" x
)
5298 (substring x
0 (match-beginning 0))
5302 (defun org-assign-fast-keys (alist)
5303 "Assign fast keys to a keyword-key alist.
5304 Respect keys that are already there."
5305 (let (new e
(alt ?
0))
5306 (while (setq e
(pop alist
))
5307 (if (or (memq (car e
) '(:newline
:grouptags
:endgroup
:startgroup
))
5308 (cdr e
)) ;; Key already assigned.
5310 (let ((clist (string-to-list (downcase (car e
))))
5311 (used (append new alist
)))
5312 (when (= (car clist
) ?
@)
5314 (while (and clist
(rassoc (car clist
) used
))
5317 (while (rassoc alt used
)
5319 (push (cons (car e
) (or (car clist
) alt
)) new
))))
5322 ;;; Some variables used in various places
5324 (defvar org-window-configuration nil
5325 "Used in various places to store a window configuration.")
5326 (defvar org-selected-window nil
5327 "Used in various places to store a window configuration.")
5328 (defvar org-finish-function nil
5329 "Function to be called when `C-c C-c' is used.
5330 This is for getting out of special buffers like capture.")
5333 ;; FIXME: Occasionally check by commenting these, to make sure
5334 ;; no other functions uses these, forgetting to let-bind them.
5335 (org-no-warnings (defvar entry
)) ;; unprefixed, from calendar.el
5336 (defvar org-last-state
)
5337 (org-no-warnings (defvar date
)) ;; unprefixed, from calendar.el
5339 ;; Defined somewhere in this file, but used before definition.
5340 (defvar org-entities
) ;; defined in org-entities.el
5341 (defvar org-struct-menu
)
5342 (defvar org-org-menu
)
5343 (defvar org-tbl-menu
)
5345 ;;;; Define the Org-mode
5347 ;; We use a before-change function to check if a table might need
5349 (defvar org-table-may-need-update t
5350 "Indicates that a table might need an update.
5351 This variable is set by `org-before-change-function'.
5352 `org-table-align' sets it back to nil.")
5353 (defun org-before-change-function (beg end
)
5354 "Every change indicates that a table might need an update."
5355 (setq org-table-may-need-update t
))
5356 (defvar org-mode-map
)
5357 (defvar org-inhibit-startup-visibility-stuff nil
) ; Dynamically-scoped param.
5358 (defvar org-agenda-keep-modes nil
) ; Dynamically-scoped param.
5359 (defvar org-inhibit-logging nil
) ; Dynamically-scoped param.
5360 (defvar org-inhibit-blocking nil
) ; Dynamically-scoped param.
5361 (defvar org-table-buffer-is-an nil
)
5363 (defvar bidi-paragraph-direction
)
5364 (defvar buffer-face-mode-face
)
5367 (if (and (not (keymapp outline-mode-map
)) (featurep 'allout
))
5368 (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"))
5369 (require 'noutline
"noutline" 'noerror
) ;; stock XEmacs does not have it
5371 ;; Other stuff we need.
5372 (require 'time-date
)
5373 (unless (fboundp 'time-subtract
) (defalias 'time-subtract
'subtract-time
))
5375 (autoload 'easy-menu-add
"easymenu")
5378 ;; (require 'org-macs) moved higher up in the file before it is first used
5379 (require 'org-entities
)
5380 ;; (require 'org-compat) moved higher up in the file before it is first used
5381 (require 'org-faces
)
5383 (require 'org-pcomplete
)
5385 (require 'org-footnote
)
5386 (require 'org-macro
)
5392 (define-derived-mode org-mode outline-mode
"Org"
5393 "Outline-based notes management and organizer, alias
5394 \"Carsten's outline-mode for keeping track of everything.\"
5396 Org-mode develops organizational tasks around a NOTES file which
5397 contains information about projects as plain text. Org-mode is
5398 implemented on top of outline-mode, which is ideal to keep the content
5399 of large files well structured. It supports ToDo items, deadlines and
5400 time stamps, which magically appear in the diary listing of the Emacs
5401 calendar. Tables are easily created with a built-in table editor.
5402 Plain text URL-like links connect to websites, emails (VM), Usenet
5403 messages (Gnus), BBDB entries, and any files related to the project.
5404 For printing and sharing of notes, an Org-mode file (or a part of it)
5405 can be exported as a structured ASCII or HTML file.
5407 The following commands are available:
5411 ;; Get rid of Outline menus, they are not needed
5412 ;; Need to do this here because define-derived-mode sets up
5413 ;; the keymap so late. Still, it is a waste to call this each time
5414 ;; we switch another buffer into org-mode.
5415 (if (featurep 'xemacs
)
5416 (when (boundp 'outline-mode-menu-heading
)
5417 ;; Assume this is Greg's port, it uses easymenu
5418 (easy-menu-remove outline-mode-menu-heading
)
5419 (easy-menu-remove outline-mode-menu-show
)
5420 (easy-menu-remove outline-mode-menu-hide
))
5421 (define-key org-mode-map
[menu-bar headings
] 'undefined
)
5422 (define-key org-mode-map
[menu-bar hide
] 'undefined
)
5423 (define-key org-mode-map
[menu-bar show
] 'undefined
))
5425 (org-load-modules-maybe)
5426 (easy-menu-add org-org-menu
)
5427 (easy-menu-add org-tbl-menu
)
5428 (org-install-agenda-files-menu)
5429 (if org-descriptive-links
(add-to-invisibility-spec '(org-link)))
5430 (add-to-invisibility-spec '(org-cwidth))
5431 (add-to-invisibility-spec '(org-hide-block . t
))
5432 (when (featurep 'xemacs
)
5433 (org-set-local 'line-move-ignore-invisible t
))
5434 (org-set-local 'outline-regexp org-outline-regexp
)
5435 (org-set-local 'outline-level
'org-outline-level
)
5436 (setq bidi-paragraph-direction
'left-to-right
)
5437 (when (and org-ellipsis
5438 (fboundp 'set-display-table-slot
) (boundp 'buffer-display-table
)
5439 (fboundp 'make-glyph-code
))
5440 (unless org-display-table
5441 (setq org-display-table
(make-display-table)))
5442 (set-display-table-slot
5445 (lambda (c) (make-glyph-code c
(and (not (stringp org-ellipsis
))
5447 (if (stringp org-ellipsis
) org-ellipsis
"..."))))
5448 (setq buffer-display-table org-display-table
))
5449 (org-set-regexps-and-options)
5450 (org-set-font-lock-defaults)
5451 (when (and org-tag-faces
(not org-tags-special-faces-re
))
5452 ;; tag faces set outside customize.... force initialization.
5453 (org-set-tag-faces 'org-tag-faces org-tag-faces
))
5455 (org-set-local 'calc-embedded-open-mode
"# ")
5456 ;; Modify a few syntax entries
5457 (modify-syntax-entry ?
@ "w")
5458 (modify-syntax-entry ?
\" "\"")
5459 (modify-syntax-entry ?
\\ "_")
5460 (modify-syntax-entry ?~
"_")
5461 (if org-startup-truncated
(setq truncate-lines t
))
5462 (when org-startup-indented
(require 'org-indent
) (org-indent-mode 1))
5463 (org-set-local 'font-lock-unfontify-region-function
5464 'org-unfontify-region
)
5465 ;; Activate before-change-function
5466 (org-set-local 'org-table-may-need-update t
)
5467 (org-add-hook 'before-change-functions
'org-before-change-function nil
5469 ;; Check for running clock before killing a buffer
5470 (org-add-hook 'kill-buffer-hook
'org-check-running-clock nil
'local
)
5471 ;; Initialize macros templates.
5472 (org-macro-initialize-templates)
5473 ;; Initialize radio targets.
5474 (org-update-radio-target-regexp)
5476 (org-set-local 'indent-line-function
'org-indent-line
)
5477 (org-set-local 'indent-region-function
'org-indent-region
)
5478 ;; Filling and auto-filling.
5481 (org-setup-comments-handling)
5482 ;; Initialize cache.
5483 (org-element-cache-reset)
5484 ;; Beginning/end of defun
5485 (org-set-local 'beginning-of-defun-function
'org-backward-element
)
5486 (org-set-local 'end-of-defun-function
5488 (if (not (org-at-heading-p))
5489 (org-forward-element)
5490 (org-forward-element)
5491 (forward-char -
1))))
5492 ;; Next error for sparse trees
5493 (org-set-local 'next-error-function
'org-occur-next-match
)
5494 ;; Make sure dependence stuff works reliably, even for users who set it
5496 (if org-enforce-todo-dependencies
5497 (add-hook 'org-blocker-hook
5498 'org-block-todo-from-children-or-siblings-or-parent
)
5499 (remove-hook 'org-blocker-hook
5500 'org-block-todo-from-children-or-siblings-or-parent
))
5501 (if org-enforce-todo-checkbox-dependencies
5502 (add-hook 'org-blocker-hook
5503 'org-block-todo-from-checkboxes
)
5504 (remove-hook 'org-blocker-hook
5505 'org-block-todo-from-checkboxes
))
5507 ;; Align options lines
5509 'align-mode-rules-list
5510 '((org-in-buffer-settings
5511 (regexp .
"^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5512 (modes .
'(org-mode)))))
5515 (org-set-local 'imenu-create-index-function
5516 'org-imenu-get-tree
)
5518 ;; Make isearch reveal context
5519 (if (or (featurep 'xemacs
)
5520 (not (boundp 'outline-isearch-open-invisible-function
)))
5521 ;; Emacs 21 and XEmacs make use of the hook
5522 (org-add-hook 'isearch-mode-end-hook
'org-isearch-end
'append
'local
)
5523 ;; Emacs 22 deals with this through a special variable
5524 (org-set-local 'outline-isearch-open-invisible-function
5525 (lambda (&rest ignore
) (org-show-context 'isearch
))))
5527 ;; Setup the pcomplete hooks
5528 (set (make-local-variable 'pcomplete-command-completion-function
)
5529 'org-pcomplete-initial
)
5530 (set (make-local-variable 'pcomplete-command-name-function
)
5531 'org-command-at-point
)
5532 (set (make-local-variable 'pcomplete-default-completion-function
)
5534 (set (make-local-variable 'pcomplete-parse-arguments-function
)
5535 'org-parse-arguments
)
5536 (set (make-local-variable 'pcomplete-termination-string
) "")
5537 (when (>= emacs-major-version
23)
5538 (set (make-local-variable 'buffer-face-mode-face
) 'org-default
))
5540 ;; If empty file that did not turn on org-mode automatically, make it to.
5541 (if (and org-insert-mode-line-in-empty-file
5542 (org-called-interactively-p 'any
)
5543 (= (point-min) (point-max)))
5544 (insert "# -*- mode: org -*-\n\n"))
5545 (unless org-inhibit-startup
5547 (and org-startup-with-beamer-mode
(org-beamer-mode))
5548 (when org-startup-align-all-tables
5549 (org-table-map-tables 'org-table-align
'quietly
))
5550 (when org-startup-with-inline-images
5551 (org-display-inline-images))
5552 (when org-startup-with-latex-preview
5553 (org-toggle-latex-fragment))
5554 (unless org-inhibit-startup-visibility-stuff
5555 (org-set-startup-visibility))
5556 (org-refresh-effort-properties)))
5557 ;; Try to set org-hide correctly
5558 (let ((foreground (org-find-invisible-foreground)))
5560 (set-face-foreground 'org-hide foreground
))))
5562 ;; Update `customize-package-emacs-version-alist'
5563 (add-to-list 'customize-package-emacs-version-alist
5564 '(Org ("6.21b" .
"23.1") ("6.33x" .
"23.2")
5565 ("7.8.11" .
"24.1") ("7.9.4" .
"24.3")
5566 ("8.2.6" .
"24.4") ("8.3" .
"25.1")))
5568 (defvar org-mode-transpose-word-syntax-table
5569 (let ((st (make-syntax-table text-mode-syntax-table
)))
5570 (mapc (lambda(c) (modify-syntax-entry
5571 (string-to-char (car c
)) "w p" st
))
5575 (when (fboundp 'abbrev-table-put
)
5576 (abbrev-table-put org-mode-abbrev-table
5577 :parents
(list text-mode-abbrev-table
)))
5579 (defun org-find-invisible-foreground ()
5580 (let ((candidates (remove
5583 (list (face-background 'default
)
5584 (face-background 'org-default
))
5587 (when (boundp alist
)
5588 (cdr (assoc 'background-color
(symbol-value alist
)))))
5589 '(default-frame-alist initial-frame-alist window-system-default-frame-alist
))
5590 (list (face-foreground 'org-hide
))))))
5591 (car (remove nil candidates
))))
5593 (defun org-current-time (&optional rounding-minutes past
)
5594 "Current time, possibly rounded to ROUNDING-MINUTES.
5595 When ROUNDING-MINUTES is not an integer, fall back on the car of
5596 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5597 the rounding returns a past time."
5598 (let ((r (or (and (integerp rounding-minutes
) rounding-minutes
)
5599 (car org-time-stamp-rounding-minutes
)))
5600 (time (decode-time)) res
)
5605 (append (list 0 (* r
(floor (+ .5 (/ (float (nth 1 time
)) r
)))))
5607 (if (and past
(< (org-float-time (time-subtract (current-time) res
)) 0))
5608 (seconds-to-time (- (org-float-time res
) (* r
60)))
5612 "Return today date, considering `org-extend-today-until'."
5614 (time-subtract (current-time)
5615 (list 0 (* 3600 org-extend-today-until
) 0))))
5617 ;;;; Font-Lock stuff, including the activators
5619 (defvar org-mouse-map
(make-sparse-keymap))
5620 (org-defkey org-mouse-map
[mouse-2
] 'org-open-at-mouse
)
5621 (org-defkey org-mouse-map
[mouse-3
] 'org-find-file-at-mouse
)
5622 (when org-mouse-1-follows-link
5623 (org-defkey org-mouse-map
[follow-link
] 'mouse-face
))
5624 (when org-tab-follows-link
5625 (org-defkey org-mouse-map
[(tab)] 'org-open-at-point
)
5626 (org-defkey org-mouse-map
"\C-i" 'org-open-at-point
))
5628 (require 'font-lock
)
5630 (defconst org-non-link-chars
"]\t\n\r<>")
5631 (defvar org-link-types
'("http" "https" "ftp" "mailto" "file" "file+emacs"
5632 "file+sys" "news" "shell" "elisp" "doi" "message"
5634 (defvar org-link-types-re nil
5635 "Matches a link that has a url-like prefix like \"http:\"")
5636 (defvar org-link-re-with-space nil
5637 "Matches a link with spaces, optional angular brackets around it.")
5638 (defvar org-link-re-with-space2 nil
5639 "Matches a link with spaces, optional angular brackets around it.")
5640 (defvar org-link-re-with-space3 nil
5641 "Matches a link with spaces, only for internal part in bracket links.")
5642 (defvar org-angle-link-re nil
5643 "Matches link with angular brackets, spaces are allowed.")
5644 (defvar org-plain-link-re nil
5645 "Matches plain link, without spaces.")
5646 (defvar org-bracket-link-regexp nil
5647 "Matches a link in double brackets.")
5648 (defvar org-bracket-link-analytic-regexp nil
5649 "Regular expression used to analyze links.
5650 Here is what the match groups contain after a match:
5656 (defvar org-bracket-link-analytic-regexp
++ nil
5657 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5658 (defvar org-any-link-re nil
5659 "Regular expression matching any link.")
5661 (defconst org-match-sexp-depth
3
5662 "Number of stacked braces for sub/superscript matching.")
5664 (defun org-create-multibrace-regexp (left right n
)
5665 "Create a regular expression which will match a balanced sexp.
5666 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5667 as single character strings.
5668 The regexp returned will match the entire expression including the
5669 delimiters. It will also define a single group which contains the
5670 match except for the outermost delimiters. The maximum depth of
5671 stacked delimiters is N. Escaping delimiters is not possible."
5672 (let* ((nothing (concat "[^" left right
"]*?"))
5675 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
5678 re
(concat re or next
)
5679 next
(concat "\\(?:" nothing left next right
"\\)+" nothing
)))
5680 (concat left
"\\(" re
"\\)" right
)))
5682 (defconst org-match-substring-regexp
5684 "\\(\\S-\\)\\([_^]\\)\\("
5685 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
5687 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
5689 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5690 "The regular expression matching a sub- or superscript.")
5692 (defconst org-match-substring-with-braces-regexp
5694 "\\(\\S-\\)\\([_^]\\)"
5695 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)")
5696 "The regular expression matching a sub- or superscript, forcing braces.")
5698 (defun org-make-link-regexps ()
5699 "Update the link regular expressions.
5700 This should be called after the variable `org-link-types' has changed."
5701 (let ((types-re (regexp-opt org-link-types t
)))
5702 (setq org-link-types-re
5703 (concat "\\`" types-re
":")
5704 org-link-re-with-space
5705 (concat "<?" types-re
":"
5706 "\\([^" org-non-link-chars
" ]"
5707 "[^" org-non-link-chars
"]*"
5708 "[^" org-non-link-chars
" ]\\)>?")
5709 org-link-re-with-space2
5710 (concat "<?" types-re
":"
5711 "\\([^" org-non-link-chars
" ]"
5713 "[^" org-non-link-chars
" ]\\)>?")
5714 org-link-re-with-space3
5715 (concat "<?" types-re
":"
5716 "\\([^" org-non-link-chars
" ]"
5719 (concat "<" types-re
":"
5720 "\\([^" org-non-link-chars
" ]"
5721 "[^" org-non-link-chars
"]*"
5726 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5727 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5728 org-bracket-link-regexp
5729 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5730 org-bracket-link-analytic-regexp
5733 "\\(" types-re
":\\)?"
5736 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5738 org-bracket-link-analytic-regexp
++
5741 "\\(" (regexp-opt (cons "coderef" org-link-types
) t
) ":\\)?"
5744 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5747 (concat "\\(" org-bracket-link-regexp
"\\)\\|\\("
5748 org-angle-link-re
"\\)\\|\\("
5749 org-plain-link-re
"\\)"))))
5751 (org-make-link-regexps)
5753 (defvar org-emph-face nil
)
5755 (defun org-do-emphasis-faces (limit)
5756 "Run through the buffer and emphasize strings."
5758 (while (and (not rtn
) (re-search-forward org-emph-re limit t
))
5759 (let* ((border (char-after (match-beginning 3)))
5760 (bre (regexp-quote (char-to-string border
))))
5761 (if (and (not (= border
(char-after (match-beginning 4))))
5762 (not (save-match-data
5763 (string-match (concat bre
".*" bre
)
5764 (replace-regexp-in-string
5766 (substring (match-string 2) 1 -
1))))))
5769 (setq a
(assoc (match-string 3) org-emphasis-alist
))
5770 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5774 (org-remove-flyspell-overlays-in
5775 (match-beginning 0) (match-end 0)))
5776 (add-text-properties (match-beginning 2) (match-end 2)
5777 '(font-lock-multiline t org-emphasis t
))
5778 (when org-hide-emphasis-markers
5779 (add-text-properties (match-end 4) (match-beginning 5)
5780 '(invisible org-link
))
5781 (add-text-properties (match-beginning 3) (match-end 3)
5782 '(invisible org-link
))))))
5783 (goto-char (1+ (match-beginning 0))))
5786 (defun org-emphasize (&optional char
)
5787 "Insert or change an emphasis, i.e. a font like bold or italic.
5788 If there is an active region, change that region to a new emphasis.
5789 If there is no region, just insert the marker characters and position
5790 the cursor between them.
5791 CHAR should be the marker character. If it is a space, it means to
5792 remove the emphasis of the selected region.
5793 If CHAR is not given (for example in an interactive call) it will be
5796 (let ((erc org-emphasis-regexp-components
)
5798 (string "") beg end move c s
)
5799 (if (org-region-active-p)
5800 (setq beg
(region-beginning) end
(region-end)
5801 string
(buffer-substring beg end
))
5805 (message "Emphasis marker or tag: [%s]"
5806 (mapconcat (lambda(e) (car e
)) org-emphasis-alist
""))
5807 (setq char
(read-char-exclusive)))
5808 (if (equal char ?\
)
5809 (setq s
"" move nil
)
5810 (unless (assoc (char-to-string char
) org-emphasis-alist
)
5811 (user-error "No such emphasis marker: \"%c\"" char
))
5812 (setq s
(char-to-string char
)))
5813 (while (and (> (length string
) 1)
5814 (equal (substring string
0 1) (substring string -
1))
5815 (assoc (substring string
0 1) org-emphasis-alist
))
5816 (setq string
(substring string
1 -
1)))
5817 (setq string
(concat s string s
))
5818 (if beg
(delete-region beg end
))
5820 (string-match (concat "[" (nth 0 erc
) "\n]")
5821 (char-to-string (char-before (point)))))
5824 (string-match (concat "[" (nth 1 erc
) "\n]")
5825 (char-to-string (char-after (point)))))
5826 (insert " ") (backward-char 1))
5828 (and move
(backward-char 1))))
5830 (defconst org-nonsticky-props
5831 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link
))
5833 (defsubst org-rear-nonsticky-at
(pos)
5834 (add-text-properties (1- pos
) pos
(list 'rear-nonsticky org-nonsticky-props
)))
5836 (defun org-activate-plain-links (limit)
5837 "Add link properties for plain links."
5839 (when (and (re-search-forward (concat org-plain-link-re
) limit t
)
5840 (not (member 'org-tag
5841 (get-text-property (1- (match-beginning 0)) 'face
)))
5842 (not (org-in-src-block-p)))
5843 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5844 (setq f
(get-text-property (match-beginning 0) 'face
))
5845 (setq hl
(org-match-string-no-properties 0))
5846 (if (or (eq f
'org-tag
)
5847 (and (listp f
) (memq 'org-tag f
)))
5849 (add-text-properties (match-beginning 0) (match-end 0)
5850 (list 'mouse-face
'highlight
5852 'htmlize-link
`(:uri
,hl
)
5853 'keymap org-mouse-map
))
5854 (org-rear-nonsticky-at (match-end 0)))
5857 (defun org-activate-code (limit)
5858 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t
)
5860 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5861 (remove-text-properties (match-beginning 0) (match-end 0)
5862 '(display t invisible t intangible t
))
5865 (defcustom org-src-fontify-natively t
5866 "When non-nil, fontify code in code blocks."
5869 :package-version
'(Org .
"8.3")
5870 :group
'org-appearance
5873 (defcustom org-allow-promoting-top-level-subtree nil
5874 "When non-nil, allow promoting a top level subtree.
5875 The leading star of the top level headline will be replaced
5879 :group
'org-appearance
)
5881 (defun org-fontify-meta-lines-and-blocks (limit)
5883 (org-fontify-meta-lines-and-blocks-1 limit
)
5884 (error (message "org-mode fontification error"))))
5886 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5887 "Fontify #+ lines and blocks."
5888 (let ((case-fold-search t
))
5889 (if (re-search-forward
5890 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5892 (let ((beg (match-beginning 0))
5893 (block-start (match-end 0))
5895 (lang (match-string 7))
5896 (beg1 (line-beginning-position 2))
5897 (dc1 (downcase (match-string 2)))
5898 (dc3 (downcase (match-string 3)))
5899 end end1 quoting block-type ovl
)
5901 ((and (match-end 4) (equal dc3
"+begin"))
5903 (setq block-type
(downcase (match-string 5))
5904 quoting
(member block-type org-protecting-blocks
))
5905 (when (re-search-forward
5906 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5907 nil t
) ;; on purpose, we look further than LIMIT
5908 (setq end
(min (point-max) (match-end 0))
5909 end1
(min (point-max) (1- (match-beginning 0))))
5910 (setq block-end
(match-beginning 0))
5912 (org-remove-flyspell-overlays-in beg1 end1
)
5913 (remove-text-properties beg end
5914 '(display t invisible t intangible t
)))
5915 (add-text-properties
5916 beg end
'(font-lock-fontified t font-lock-multiline t
))
5917 (add-text-properties beg beg1
'(face org-meta-line
))
5918 (org-remove-flyspell-overlays-in beg beg1
)
5919 (add-text-properties ; For end_src
5920 end1
(min (point-max) (1+ end
)) '(face org-meta-line
))
5921 (org-remove-flyspell-overlays-in end1 end
)
5923 ((and lang
(not (string= lang
"")) org-src-fontify-natively
)
5924 (org-src-font-lock-fontify-block lang block-start block-end
)
5925 (add-text-properties beg1 block-end
'(src-block t
)))
5927 (add-text-properties beg1
(min (point-max) (1+ end1
))
5928 '(face org-block
))) ; end of source block
5929 ((not org-fontify-quote-and-verse-blocks
))
5930 ((string= block-type
"quote")
5931 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-quote
)))
5932 ((string= block-type
"verse")
5933 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-verse
))))
5934 (add-text-properties beg beg1
'(face org-block-begin-line
))
5935 (add-text-properties (min (point-max) (1+ end
)) (min (point-max) (1+ end1
))
5936 '(face org-block-end-line
))
5938 ((member dc1
'("+title:" "+author:" "+email:" "+date:"))
5939 (org-remove-flyspell-overlays-in
5941 (if (equal "+title:" dc1
) (match-end 2) (match-end 0)))
5942 (add-text-properties
5944 (if (member (intern (substring dc1
1 -
1)) org-hidden-keywords
)
5945 '(font-lock-fontified t invisible t
)
5946 '(font-lock-fontified t face org-document-info-keyword
)))
5947 (add-text-properties
5948 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5949 (if (string-equal dc1
"+title:")
5950 '(font-lock-fontified t face org-document-title
)
5951 '(font-lock-fontified t face org-document-info
))))
5952 ((equal dc1
"+caption:")
5953 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5954 (remove-text-properties (match-beginning 0) (match-end 0)
5955 '(display t invisible t intangible t
))
5956 (add-text-properties (match-beginning 1) (match-end 3)
5957 '(font-lock-fontified t face org-meta-line
))
5958 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5959 '(font-lock-fontified t face org-block
))
5961 ((member dc3
'(" " ""))
5962 (org-remove-flyspell-overlays-in beg
(match-end 0))
5963 (add-text-properties
5965 '(font-lock-fontified t face font-lock-comment-face
)))
5966 (t ;; just any other in-buffer setting, but not indented
5967 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5968 (remove-text-properties (match-beginning 0) (match-end 0)
5969 '(display t invisible t intangible t
))
5970 (add-text-properties beg
(match-end 0)
5971 '(font-lock-fontified t face org-meta-line
))
5974 (defun org-fontify-drawers (limit)
5976 (when (re-search-forward org-drawer-regexp limit t
)
5977 (add-text-properties
5978 (match-beginning 0) (match-end 0)
5979 '(font-lock-fontified t face org-special-keyword
))
5980 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5983 (defun org-fontify-macros (limit)
5985 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t
)
5986 (add-text-properties
5987 (match-beginning 0) (match-end 0)
5988 '(font-lock-fontified t face org-macro
))
5989 (when org-hide-macro-markers
5990 (add-text-properties (match-end 2) (match-beginning 2)
5992 (add-text-properties (match-beginning 1) (match-end 1)
5994 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5997 (defun org-activate-angle-links (limit)
5998 "Add text properties for angle links."
5999 (if (and (re-search-forward org-angle-link-re limit t
)
6000 (not (org-in-src-block-p)))
6002 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6003 (add-text-properties (match-beginning 0) (match-end 0)
6004 (list 'mouse-face
'highlight
6005 'keymap org-mouse-map
))
6006 (org-rear-nonsticky-at (match-end 0))
6009 (defun org-activate-footnote-links (limit)
6010 "Add text properties for footnotes."
6011 (let ((fn (org-footnote-next-reference-or-definition limit
)))
6013 (let* ((beg (nth 1 fn
))
6016 (referencep (/= (line-beginning-position) beg
)))
6017 (when (and referencep
(nth 3 fn
))
6020 (search-forward (or label
"fn:"))
6021 (org-remove-flyspell-overlays-in beg
(match-end 0))))
6022 (add-text-properties beg end
6023 (list 'mouse-face
'highlight
6024 'keymap org-mouse-map
6026 (if referencep
"Footnote reference"
6027 "Footnote definition")
6028 'font-lock-fontified t
6029 'font-lock-multiline t
6030 'face
'org-footnote
))))))
6032 (defun org-activate-bracket-links (limit)
6033 "Add text properties for bracketed links."
6034 (if (and (re-search-forward org-bracket-link-regexp limit t
)
6035 (not (org-in-src-block-p)))
6036 (let* ((hl (org-match-string-no-properties 1))
6037 (help (concat "LINK: " (save-match-data (org-link-unescape hl
))))
6038 (ip (org-maybe-intangible
6039 (list 'invisible
'org-link
6040 'keymap org-mouse-map
'mouse-face
'highlight
6041 'font-lock-multiline t
'help-echo help
6042 'htmlize-link
`(:uri
,hl
))))
6043 (vp (list 'keymap org-mouse-map
'mouse-face
'highlight
6044 'font-lock-multiline t
'help-echo help
6045 'htmlize-link
`(:uri
,hl
))))
6046 ;; We need to remove the invisible property here. Table narrowing
6047 ;; may have made some of this invisible.
6048 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6049 (remove-text-properties (match-beginning 0) (match-end 0)
6053 (add-text-properties (match-beginning 0) (match-beginning 3) ip
)
6054 (org-rear-nonsticky-at (match-beginning 3))
6055 (add-text-properties (match-beginning 3) (match-end 3) vp
)
6056 (org-rear-nonsticky-at (match-end 3))
6057 (add-text-properties (match-end 3) (match-end 0) ip
)
6058 (org-rear-nonsticky-at (match-end 0)))
6059 (add-text-properties (match-beginning 0) (match-beginning 1) ip
)
6060 (org-rear-nonsticky-at (match-beginning 1))
6061 (add-text-properties (match-beginning 1) (match-end 1) vp
)
6062 (org-rear-nonsticky-at (match-end 1))
6063 (add-text-properties (match-end 1) (match-end 0) ip
)
6064 (org-rear-nonsticky-at (match-end 0)))
6067 (defun org-activate-dates (limit)
6068 "Add text properties for dates."
6069 (if (and (re-search-forward org-tsr-regexp-both limit t
)
6070 (not (equal (char-before (match-beginning 0)) 91)))
6072 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6073 (add-text-properties (match-beginning 0) (match-end 0)
6074 (list 'mouse-face
'highlight
6075 'keymap org-mouse-map
))
6076 (org-rear-nonsticky-at (match-end 0))
6077 (when org-display-custom-times
6079 (org-display-custom-time (match-beginning 3) (match-end 3)))
6080 (org-display-custom-time (match-beginning 1) (match-end 1)))
6083 (defvar org-target-link-regexp nil
6084 "Regular expression matching radio targets in plain text.")
6085 (make-variable-buffer-local 'org-target-link-regexp
)
6087 (defconst org-target-regexp
(let ((border "[^<>\n\r \t]"))
6088 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6089 border border border
))
6090 "Regular expression matching a link target.")
6092 (defconst org-radio-target-regexp
(format "<%s>" org-target-regexp
)
6093 "Regular expression matching a radio target.")
6095 (defconst org-any-target-regexp
6096 (format "%s\\|%s" org-radio-target-regexp org-target-regexp
)
6097 "Regular expression matching any target.")
6099 (defun org-activate-target-links (limit)
6100 "Add text properties for target matches."
6101 (when org-target-link-regexp
6102 (let ((case-fold-search t
))
6103 (if (re-search-forward org-target-link-regexp limit t
)
6105 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6106 (add-text-properties (match-beginning 1) (match-end 1)
6107 (list 'mouse-face
'highlight
6108 'keymap org-mouse-map
6109 'help-echo
"Radio target link"
6110 'org-linked-text t
))
6111 (org-rear-nonsticky-at (match-end 1))
6114 (defun org-update-radio-target-regexp ()
6115 "Find all radio targets in this file and update the regular expression.
6116 Also refresh fontification if needed."
6118 (let ((old-regexp org-target-link-regexp
)
6119 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6120 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6122 (org-with-wide-buffer
6123 (goto-char (point-min))
6125 (while (re-search-forward org-radio-target-regexp nil t
)
6126 ;; Make sure point is really within the object.
6128 (let ((obj (org-element-context)))
6129 (when (eq (org-element-type obj
) 'radio-target
)
6130 (add-to-list 'rtn
(org-element-property :value obj
)))))
6132 (setq org-target-link-regexp
6137 (replace-regexp-in-string
6138 " +" "\\s-+" (regexp-quote x
) t t
))
6142 (unless (equal old-regexp org-target-link-regexp
)
6144 (let ((regexp (cond ((not old-regexp
) org-target-link-regexp
)
6145 ((not org-target-link-regexp
) old-regexp
)
6150 (substring re
(length before-re
)
6151 (- (length after-re
))))
6152 (list old-regexp org-target-link-regexp
)
6155 (org-with-wide-buffer
6156 (goto-char (point-min))
6157 (while (re-search-forward regexp nil t
)
6158 (org-element-cache-refresh (match-beginning 1)))))
6159 ;; Re fontify buffer.
6160 (when (memq 'radio org-highlight-links
)
6161 (org-restart-font-lock)))))
6163 (defun org-hide-wide-columns (limit)
6165 (setq s
(text-property-any (point) (or limit
(point-max))
6168 (setq e
(next-single-property-change s
'org-cwidth
))
6169 (add-text-properties s e
(org-maybe-intangible '(invisible org-cwidth
)))
6173 (defvar org-latex-and-related-regexp nil
6174 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6176 (defun org-compute-latex-and-related-regexp ()
6177 "Compute regular expression for LaTeX, entities and sub/superscript.
6178 Result depends on variable `org-highlight-latex-and-related'."
6180 'org-latex-and-related-regexp
6182 (cond ((not (memq 'script org-highlight-latex-and-related
)) nil
)
6183 ((eq org-use-sub-superscripts
'{})
6184 (list org-match-substring-with-braces-regexp
))
6185 (org-use-sub-superscripts (list org-match-substring-regexp
))))
6187 (when (memq 'latex org-highlight-latex-and-related
)
6188 (let ((matchers (plist-get org-format-latex-options
:matchers
)))
6191 (and (member (car x
) matchers
) (nth 1 x
)))
6192 org-latex-regexps
)))))
6194 (when (memq 'entities org-highlight-latex-and-related
)
6195 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6196 (mapconcat 'identity
(append re-latex re-entities re-sub
) "\\|"))))
6198 (defun org-do-latex-and-related (limit)
6199 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6200 LIMIT bounds the search for syntax to highlight. Stop at first
6201 highlighted object, if any. Return t if some highlighting was
6202 done, nil otherwise."
6203 (when (org-string-nw-p org-latex-and-related-regexp
)
6205 (while (re-search-forward org-latex-and-related-regexp limit t
)
6206 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6208 '(org-code org-verbatim underline
))
6209 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6213 (font-lock-prepend-text-property
6214 (+ offset
(match-beginning 0)) (match-end 0)
6215 'face
'org-latex-and-related
)
6216 (add-text-properties (+ offset
(match-beginning 0)) (match-end 0)
6217 '(font-lock-multiline t
)))
6221 (defun org-restart-font-lock ()
6222 "Restart `font-lock-mode', to force refontification."
6223 (when (and (boundp 'font-lock-mode
) font-lock-mode
)
6225 (font-lock-mode 1)))
6227 (defun org-activate-tags (limit)
6228 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t
)
6230 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6231 (add-text-properties (match-beginning 1) (match-end 1)
6232 (list 'mouse-face
'highlight
6233 'keymap org-mouse-map
))
6234 (org-rear-nonsticky-at (match-end 1))
6237 (defun org-outline-level ()
6238 "Compute the outline level of the heading at point.
6240 If this is called at a normal headline, the level is the number
6241 of stars. Use `org-reduced-level' to remove the effect of
6242 `org-odd-levels'. Unlike to `org-current-level', this function
6243 takes into consideration inlinetasks."
6244 (org-with-wide-buffer
6246 (if (re-search-backward org-outline-regexp-bol nil t
)
6247 (1- (- (match-end 0) (match-beginning 0)))
6250 (defvar org-font-lock-keywords nil
)
6252 (defsubst org-re-property
(property &optional literal allow-null value
)
6253 "Return a regexp matching a PROPERTY line.
6255 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6256 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6257 non-nil, match properties even without a value.
6259 Match group 3 is set to the value when it exists. If there is no
6260 value and ALLOW-NULL is non-nil, it is set to the empty string.
6262 With optional argument VALUE, match only property lines with
6263 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6264 unless LITERAL is non-nil."
6267 (format "\\(?1::\\(?2:%s\\):\\)"
6268 (if literal property
(regexp-quote property
)))
6270 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6271 (if literal value
(regexp-quote value
))))
6273 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6275 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6277 (defconst org-property-re
6278 (org-re-property "\\S-+" 'literal t
)
6279 "Regular expression matching a property line.
6280 There are four matching groups:
6281 1: :PROPKEY: including the leading and trailing colon,
6282 2: PROPKEY without the leading and trailing colon,
6283 3: PROPVAL without leading or trailing spaces,
6284 4: the indentation of the current line,
6285 5: trailing whitespace.")
6287 (defvar org-font-lock-hook nil
6288 "Functions to be called for special font lock stuff.")
6290 (defvar org-font-lock-set-keywords-hook nil
6291 "Functions that can manipulate `org-font-lock-extra-keywords'.
6292 This is called after `org-font-lock-extra-keywords' is defined, but before
6293 it is installed to be used by font lock. This can be useful if something
6294 needs to be inserted at a specific position in the font-lock sequence.")
6296 (defun org-font-lock-hook (limit)
6297 "Run `org-font-lock-hook' within LIMIT."
6298 (run-hook-with-args 'org-font-lock-hook limit
))
6300 (defun org-set-font-lock-defaults ()
6301 "Set font lock defaults for the current buffer."
6302 (let* ((em org-fontify-emphasized-text
)
6303 (lk org-highlight-links
)
6304 (org-font-lock-extra-keywords
6307 '(org-font-lock-hook)
6309 `(,(if org-fontify-whole-heading-line
6310 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6311 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6312 (1 (org-get-level-face 1))
6313 (2 (org-get-level-face 2))
6314 (3 (org-get-level-face 3)))
6316 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6319 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t
))
6320 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t
))
6321 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t
))
6322 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t
))
6324 '(org-fontify-drawers)
6326 (list org-property-re
6327 '(1 'org-special-keyword t
)
6328 '(3 'org-property-value t
))
6330 (if (memq 'tag lk
) '(org-activate-tags (1 'org-tag prepend
)))
6331 (if (memq 'angle lk
) '(org-activate-angle-links (0 'org-link t
)))
6332 (if (memq 'plain lk
) '(org-activate-plain-links (0 'org-link t
)))
6333 (if (memq 'bracket lk
) '(org-activate-bracket-links (0 'org-link t
)))
6334 (if (memq 'radio lk
) '(org-activate-target-links (1 'org-link t
)))
6335 (if (memq 'date lk
) '(org-activate-dates (0 'org-date t
)))
6336 (if (memq 'footnote lk
) '(org-activate-footnote-links))
6338 (list org-any-target-regexp
'(0 'org-target t
))
6340 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t
))
6342 '(org-fontify-macros)
6343 '(org-hide-wide-columns (0 nil append
))
6345 (list (format org-heading-keyword-regexp-format
6347 '(2 (org-get-todo-face 2) t
))
6349 (if org-fontify-done-headline
6350 (list (format org-heading-keyword-regexp-format
6353 (mapconcat 'regexp-quote org-done-keywords
"\\|")
6355 '(2 'org-headline-done t
))
6358 '(org-font-lock-add-priority-faces)
6360 '(org-font-lock-add-tag-faces)
6362 (if (and org-group-tags org-tag-groups-alist
)
6363 (list (concat org-outline-regexp-bol
".+\\(:"
6364 (regexp-opt (mapcar 'car org-tag-groups-alist
))
6366 '(1 'org-tag-group prepend
)))
6368 (list (concat "\\<" org-comment-string
) '(0 'org-special-keyword t
))
6369 (list (concat "\\<" org-deadline-string
) '(0 'org-special-keyword t
))
6370 (list (concat "\\<" org-scheduled-string
) '(0 'org-special-keyword t
))
6371 (list (concat "\\<" org-closed-string
) '(0 'org-special-keyword t
))
6372 (list (concat "\\<" org-clock-string
) '(0 'org-special-keyword t
))
6375 (if (featurep 'xemacs
)
6376 '(org-do-emphasis-faces (0 nil append
))
6377 '(org-do-emphasis-faces)))
6379 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6380 1 'org-checkbox prepend
)
6381 (if (cdr (assq 'checkbox org-list-automatic-rules
))
6382 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6383 (0 (org-get-checkbox-statistics-face) t
)))
6384 ;; Description list items
6385 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6386 1 'org-list-dt prepend
)
6387 ;; ARCHIVEd headings
6389 org-outline-regexp-bol
6390 "\\(.*:" org-archive-tag
":.*\\)")
6391 '(1 'org-archived prepend
))
6393 '(org-do-latex-and-related)
6394 '(org-fontify-entities)
6395 '(org-raise-scripts)
6397 '(org-activate-code (1 'org-code t
))
6400 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6403 '(9 'org-special-keyword t
))
6404 ;; Blocks and meta lines
6405 '(org-fontify-meta-lines-and-blocks))))
6406 (setq org-font-lock-extra-keywords
(delq nil org-font-lock-extra-keywords
))
6407 (run-hooks 'org-font-lock-set-keywords-hook
)
6408 ;; Now set the full font-lock-keywords
6409 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords
)
6410 (org-set-local 'font-lock-defaults
6411 '(org-font-lock-keywords t nil nil backward-paragraph
))
6412 (kill-local-variable 'font-lock-keywords
) nil
))
6414 (defun org-toggle-pretty-entities ()
6415 "Toggle the composition display of entities as UTF8 characters."
6417 (org-set-local 'org-pretty-entities
(not org-pretty-entities
))
6418 (org-restart-font-lock)
6419 (if org-pretty-entities
6420 (message "Entities are now displayed as UTF8 characters")
6423 (org-decompose-region (point-min) (point-max))
6424 (message "Entities are now displayed as plain text"))))
6426 (defvar org-custom-properties-overlays nil
6427 "List of overlays used for custom properties.")
6428 (make-variable-buffer-local 'org-custom-properties-overlays
)
6430 (defun org-toggle-custom-properties-visibility ()
6431 "Display or hide properties in `org-custom-properties'."
6433 (if org-custom-properties-overlays
6434 (progn (mapc #'delete-overlay org-custom-properties-overlays
)
6435 (setq org-custom-properties-overlays nil
))
6436 (when org-custom-properties
6437 (org-with-wide-buffer
6438 (goto-char (point-min))
6439 (let ((regexp (org-re-property (regexp-opt org-custom-properties
) t t
)))
6440 (while (re-search-forward regexp nil t
)
6441 (let ((end (cdr (save-match-data (org-get-property-block)))))
6442 (when (and end
(< (point) end
))
6443 ;; Hide first custom property in current drawer.
6444 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6445 (overlay-put o
'invisible t
)
6446 (overlay-put o
'org-custom-property t
)
6447 (push o org-custom-properties-overlays
))
6448 ;; Hide additional custom properties in the same drawer.
6449 (while (re-search-forward regexp end t
)
6450 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6451 (overlay-put o
'invisible t
)
6452 (overlay-put o
'org-custom-property t
)
6453 (push o org-custom-properties-overlays
)))))
6454 ;; Each entry is limited to a single property drawer.
6455 (outline-next-heading)))))))
6457 (defun org-fontify-entities (limit)
6458 "Find an entity to fontify."
6460 (when org-pretty-entities
6462 ;; "\_ "-family is left out on purpose. Only the first one,
6463 ;; i.e., "\_ ", could be fontified anyway, and it would be
6464 ;; confusing when adding a second white space character.
6465 (while (re-search-forward
6466 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6468 (if (and (not (org-at-comment-p))
6469 (setq ee
(org-entity-get (match-string 1)))
6470 (= (length (nth 6 ee
)) 1))
6472 ((end (if (equal (match-string 2) "{}")
6475 (add-text-properties
6476 (match-beginning 0) end
6477 (list 'font-lock-fontified t
))
6478 (compose-region (match-beginning 0) end
6484 (defun org-fontify-like-in-org-mode (s &optional odd-levels
)
6485 "Fontify string S like in Org-mode."
6488 (let ((org-odd-levels-only odd-levels
))
6496 (defun org-get-level-face (n)
6497 "Get the right face for match N in font-lock matching of headlines."
6498 (setq org-l
(- (match-end 2) (match-beginning 1) 1))
6499 (if org-odd-levels-only
(setq org-l
(1+ (/ org-l
2))))
6500 (if org-cycle-level-faces
6501 (setq org-f
(nth (%
(1- org-l
) org-n-level-faces
) org-level-faces
))
6502 (setq org-f
(nth (1- (min org-l org-n-level-faces
)) org-level-faces
)))
6504 ((eq n
1) (if org-hide-leading-stars
'org-hide org-f
))
6506 (t (if org-level-color-stars-only nil org-f
))))
6509 (defun org-get-todo-face (kwd)
6510 "Get the right face for a TODO keyword KWD.
6511 If KWD is a number, get the corresponding match group."
6512 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6513 (or (org-face-from-face-or-color
6514 'todo
'org-todo
(cdr (assoc kwd org-todo-keyword-faces
)))
6515 (and (member kwd org-done-keywords
) 'org-done
)
6518 (defun org-face-from-face-or-color (context inherit face-or-color
)
6519 "Create a face list that inherits INHERIT, but sets the foreground color.
6520 When FACE-OR-COLOR is not a string, just return it."
6521 (if (stringp face-or-color
)
6522 (list :inherit inherit
6523 (cdr (assoc context org-faces-easy-properties
))
6527 (defun org-font-lock-add-tag-faces (limit)
6528 "Add the special tag faces."
6529 (when (and org-tag-faces org-tags-special-faces-re
)
6530 (while (re-search-forward org-tags-special-faces-re limit t
)
6531 (add-text-properties (match-beginning 1) (match-end 1)
6532 (list 'face
(org-get-tag-face 1)
6533 'font-lock-fontified t
))
6534 (backward-char 1))))
6536 (defun org-font-lock-add-priority-faces (limit)
6537 "Add the special priority faces."
6538 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t
)
6539 (when (save-match-data (org-at-heading-p))
6540 (add-text-properties
6541 (match-beginning 0) (match-end 0)
6542 (list 'face
(or (org-face-from-face-or-color
6543 'priority
'org-priority
6544 (cdr (assoc (char-after (match-beginning 1))
6545 org-priority-faces
)))
6547 'font-lock-fontified t
)))))
6549 (defun org-get-tag-face (kwd)
6550 "Get the right face for a TODO keyword KWD.
6551 If KWD is a number, get the corresponding match group."
6552 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6553 (or (org-face-from-face-or-color
6554 'tag
'org-tag
(cdr (assoc kwd org-tag-faces
)))
6557 (defun org-unfontify-region (beg end
&optional maybe_loudly
)
6558 "Remove fontification and activation overlays from links."
6559 (font-lock-default-unfontify-region beg end
)
6560 (let* ((buffer-undo-list t
)
6561 (inhibit-read-only t
) (inhibit-point-motion-hooks t
)
6562 (inhibit-modification-hooks t
)
6563 deactivate-mark buffer-file-name buffer-file-truename
)
6564 (org-decompose-region beg end
)
6565 (remove-text-properties beg end
6566 '(mouse-face t keymap t org-linked-text t
6567 invisible t intangible t
6569 (org-remove-font-lock-display-properties beg end
)))
6571 (defconst org-script-display
'(((raise -
0.3) (height 0.7))
6572 ((raise 0.3) (height 0.7))
6575 "Display properties for showing superscripts and subscripts.")
6577 (defun org-remove-font-lock-display-properties (beg end
)
6578 "Remove specific display properties that have been added by font lock.
6579 The will remove the raise properties that are used to show superscripts
6583 (setq next
(next-single-property-change beg
'display nil end
)
6584 prop
(get-text-property beg
'display
))
6585 (if (member prop org-script-display
)
6586 (put-text-property beg next
'display nil
))
6589 (defun org-raise-scripts (limit)
6590 "Add raise properties to sub/superscripts."
6591 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
)
6592 (if (re-search-forward
6593 (if (eq org-use-sub-superscripts t
)
6594 org-match-substring-regexp
6595 org-match-substring-with-braces-regexp
)
6597 (let* ((pos (point)) table-p comment-p
6598 (mpos (match-beginning 3))
6599 (emph-p (get-text-property mpos
'org-emphasis
))
6600 (link-p (get-text-property mpos
'mouse-face
))
6601 (keyw-p (eq 'org-special-keyword
(get-text-property mpos
'face
))))
6602 (goto-char (point-at-bol))
6603 (setq table-p
(org-looking-at-p org-table-dataline-regexp
)
6604 comment-p
(org-looking-at-p "^[ \t]*#[ +]"))
6607 (if (member (char-after) '(?_ ?^
)) (goto-char (1- pos
)))
6608 (if (or comment-p emph-p link-p keyw-p
)
6610 (put-text-property (match-beginning 3) (match-end 0)
6612 (if (equal (char-after (match-beginning 2)) ?^
)
6613 (nth (if table-p
3 1) org-script-display
)
6614 (nth (if table-p
2 0) org-script-display
)))
6615 (add-text-properties (match-beginning 2) (match-end 2)
6617 'org-dwidth t
'org-dwidth-n
1))
6618 (if (and (eq (char-after (match-beginning 3)) ?
{)
6619 (eq (char-before (match-end 3)) ?
}))
6621 (add-text-properties
6622 (match-beginning 3) (1+ (match-beginning 3))
6623 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))
6624 (add-text-properties
6625 (1- (match-end 3)) (match-end 3)
6626 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))))
6629 ;;;; Visibility cycling, including org-goto and indirect buffer
6633 (defvar org-cycle-global-status nil
)
6634 (make-variable-buffer-local 'org-cycle-global-status
)
6635 (put 'org-cycle-global-status
'org-state t
)
6636 (defvar org-cycle-subtree-status nil
)
6637 (make-variable-buffer-local 'org-cycle-subtree-status
)
6638 (put 'org-cycle-subtree-status
'org-state t
)
6640 (defvar org-inlinetask-min-level
)
6642 (defun org-unlogged-message (&rest args
)
6643 "Display a message, but avoid logging it in the *Messages* buffer."
6644 (let ((message-log-max nil
))
6645 (apply 'message args
)))
6648 (defun org-cycle (&optional arg
)
6649 "TAB-action and visibility cycling for Org-mode.
6651 This is the command invoked in Org-mode by the TAB key. Its main purpose
6652 is outline visibility cycling, but it also invokes other actions
6653 in special contexts.
6655 - When this function is called with a prefix argument, rotate the entire
6656 buffer through 3 states (global cycling)
6657 1. OVERVIEW: Show only top-level headlines.
6658 2. CONTENTS: Show all headlines of all levels, but no body text.
6659 3. SHOW ALL: Show everything.
6660 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6661 determined by the variable `org-startup-folded', and by any VISIBILITY
6662 properties in the buffer.
6663 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6664 including any drawers.
6666 - When inside a table, re-align the table and move to the next field.
6668 - When point is at the beginning of a headline, rotate the subtree started
6669 by this line through 3 different states (local cycling)
6670 1. FOLDED: Only the main headline is shown.
6671 2. CHILDREN: The main headline and the direct children are shown.
6672 From this state, you can move to one of the children
6673 and zoom in further.
6674 3. SUBTREE: Show the entire subtree, including body text.
6675 If there is no subtree, switch directly from CHILDREN to FOLDED.
6677 - When point is at the beginning of an empty headline and the variable
6678 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6679 of the headline by demoting and promoting it to likely levels. This
6680 speeds up creation document structure by pressing TAB once or several
6681 times right after creating a new headline.
6683 - When there is a numeric prefix, go up to a heading with level ARG, do
6684 a `show-subtree' and return to the previous cursor position. If ARG
6685 is negative, go up that many levels.
6687 - When point is not at the beginning of a headline, execute the global
6688 binding for TAB, which is re-indenting the line. See the option
6689 `org-cycle-emulate-tab' for details.
6691 - Special case: if point is at the beginning of the buffer and there is
6692 no headline in line 1, this function will act as if called with prefix arg
6693 (C-u TAB, same as S-TAB) also when called without prefix arg.
6694 But only if also the variable `org-cycle-global-at-bob' is t."
6696 (org-load-modules-maybe)
6697 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook
)
6698 (and org-cycle-level-after-item
/entry-creation
6699 (or (org-cycle-level)
6700 (org-cycle-item-indentation))))
6702 (or org-cycle-max-level
6703 (and (boundp 'org-inlinetask-min-level
)
6704 org-inlinetask-min-level
6705 (1- org-inlinetask-min-level
))))
6706 (nstars (and limit-level
6707 (if org-odd-levels-only
6708 (and limit-level
(1- (* limit-level
2)))
6711 (if (not (derived-mode-p 'org-mode
))
6713 (concat "\\*" (if nstars
(format "\\{1,%d\\} " nstars
) "+ "))))
6714 (bob-special (and org-cycle-global-at-bob
(not arg
) (bobp)
6715 (not (looking-at org-outline-regexp
))))
6718 (delq 'org-optimize-window-after-visibility-change
6719 (copy-sequence org-cycle-hook
))
6723 (if (or bob-special
(equal arg
'(4)))
6724 ;; special case: use global cycling
6730 (setq last-command
'dummy
)
6731 (org-set-startup-visibility)
6732 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6736 (org-unlogged-message "Entire buffer visible, including drawers"))
6738 ;; Try cdlatex TAB completion
6739 ((org-try-cdlatex-tab))
6741 ;; Table: enter it or move to the next field.
6742 ((org-at-table-p 'any
)
6743 (if (org-at-table.el-p
)
6744 (message "Use C-c ' to edit table.el tables")
6745 (if arg
(org-table-edit-field t
)
6746 (org-table-justify-field-maybe)
6747 (call-interactively 'org-table-next-field
))))
6749 ((run-hook-with-args-until-success
6750 'org-tab-after-check-for-table-hook
))
6752 ;; Global cycling: delegate to `org-cycle-internal-global'.
6753 ((eq arg t
) (org-cycle-internal-global))
6755 ;; Drawers: delegate to `org-flag-drawer'.
6757 (beginning-of-line 1)
6758 (looking-at org-drawer-regexp
))
6759 (org-flag-drawer ; toggle block visibility
6760 (not (get-char-property (match-end 0) 'invisible
))))
6762 ;; Show-subtree, ARG levels up from here.
6765 (org-back-to-heading)
6766 (outline-up-heading (if (< arg
0) (- arg
)
6767 (- (funcall outline-level
) arg
)))
6768 (org-show-subtree)))
6770 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6771 ((and (featurep 'org-inlinetask
)
6772 (org-inlinetask-at-task-p)
6773 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6774 (org-inlinetask-toggle-visibility))
6776 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6777 ((and (or (and org-cycle-include-plain-lists
(org-at-item-p))
6778 (save-excursion (move-beginning-of-line 1)
6779 (looking-at org-outline-regexp
)))
6780 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6781 (org-cycle-internal-local))
6783 ;; From there: TAB emulation and template completion.
6784 (buffer-read-only (org-back-to-heading))
6786 ((run-hook-with-args-until-success
6787 'org-tab-after-check-for-cycling-hook
))
6789 ((org-try-structure-completion))
6791 ((run-hook-with-args-until-success
6792 'org-tab-before-tab-emulation-hook
))
6794 ((and (eq org-cycle-emulate-tab
'exc-hl-bol
)
6796 (not (looking-at org-outline-regexp
))))
6797 (call-interactively (global-key-binding "\t")))
6799 ((if (and (memq org-cycle-emulate-tab
'(white whitestart
))
6800 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6801 (or (and (eq org-cycle-emulate-tab
'white
)
6802 (= (match-end 0) (point-at-eol)))
6803 (and (eq org-cycle-emulate-tab
'whitestart
)
6804 (>= (match-end 0) pos
))))
6806 (eq org-cycle-emulate-tab t
))
6807 (call-interactively (global-key-binding "\t")))
6810 (org-back-to-heading)
6813 (defun org-cycle-internal-global ()
6814 "Do the global cycling action."
6815 ;; Hack to avoid display of messages for .org attachments in Gnus
6816 (let ((ga (string-match "\\*fontification" (buffer-name))))
6818 ((and (eq last-command this-command
)
6819 (eq org-cycle-global-status
'overview
))
6820 ;; We just created the overview - now do table of contents
6821 ;; This can be slow in very large buffers, so indicate action
6822 (run-hook-with-args 'org-pre-cycle-hook
'contents
)
6823 (unless ga
(org-unlogged-message "CONTENTS..."))
6825 (unless ga
(org-unlogged-message "CONTENTS...done"))
6826 (setq org-cycle-global-status
'contents
)
6827 (run-hook-with-args 'org-cycle-hook
'contents
))
6829 ((and (eq last-command this-command
)
6830 (eq org-cycle-global-status
'contents
))
6831 ;; We just showed the table of contents - now show everything
6832 (run-hook-with-args 'org-pre-cycle-hook
'all
)
6834 (unless ga
(org-unlogged-message "SHOW ALL"))
6835 (setq org-cycle-global-status
'all
)
6836 (run-hook-with-args 'org-cycle-hook
'all
))
6839 ;; Default action: go to overview
6840 (run-hook-with-args 'org-pre-cycle-hook
'overview
)
6842 (unless ga
(org-unlogged-message "OVERVIEW"))
6843 (setq org-cycle-global-status
'overview
)
6844 (run-hook-with-args 'org-cycle-hook
'overview
)))))
6846 (defvar org-called-with-limited-levels nil
6847 "Non-nil when `org-with-limited-levels' is currently active.")
6849 (defun org-cycle-internal-local ()
6850 "Do the local cycling action."
6851 (let ((goal-column 0) eoh eol eos has-children children-skipped struct
)
6852 ;; First, determine end of headline (EOH), end of subtree or item
6853 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6858 (setq struct
(org-list-struct))
6859 (setq eoh
(point-at-eol))
6860 (setq eos
(org-list-get-item-end-before-blank (point) struct
))
6861 (setq has-children
(org-list-has-child-p (point) struct
)))
6862 (org-back-to-heading)
6863 (setq eoh
(save-excursion (outline-end-of-heading) (point)))
6864 (setq eos
(save-excursion (org-end-of-subtree t t
)
6865 (when (bolp) (backward-char)) (point)))
6868 (let ((level (funcall outline-level
)))
6869 (outline-next-heading)
6870 (and (org-at-heading-p t
)
6871 (> (funcall outline-level
) level
))))
6873 (org-list-search-forward (org-item-beginning-re) eos t
)))))
6874 ;; Determine end invisible part of buffer (EOL)
6875 (beginning-of-line 2)
6876 ;; XEmacs doesn't have `next-single-char-property-change'
6877 (if (featurep 'xemacs
)
6878 (while (and (not (eobp)) ;; this is like `next-line'
6879 (get-char-property (1- (point)) 'invisible
))
6880 (beginning-of-line 2))
6881 (while (and (not (eobp)) ;; this is like `next-line'
6882 (get-char-property (1- (point)) 'invisible
))
6883 (goto-char (next-single-char-property-change (point) 'invisible
))
6884 (and (eolp) (beginning-of-line 2))))
6886 ;; Find out what to do next and set `this-command'
6889 ;; Nothing is hidden behind this heading
6890 (unless (org-before-first-heading-p)
6891 (run-hook-with-args 'org-pre-cycle-hook
'empty
))
6892 (org-unlogged-message "EMPTY ENTRY")
6893 (setq org-cycle-subtree-status nil
)
6896 (outline-next-heading)
6897 (if (outline-invisible-p) (org-flag-heading nil
))))
6898 ((and (or (>= eol eos
)
6899 (not (string-match "\\S-" (buffer-substring eol eos
))))
6901 (not (setq children-skipped
6902 org-cycle-skip-children-state-if-no-children
))))
6903 ;; Entire subtree is hidden in one line: children view
6904 (unless (org-before-first-heading-p)
6905 (run-hook-with-args 'org-pre-cycle-hook
'children
))
6907 (org-list-set-item-visibility (point-at-bol) struct
'children
)
6909 (org-with-limited-levels (show-children))
6910 ;; FIXME: This slows down the func way too much.
6911 ;; How keep drawers hidden in subtree anyway?
6912 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6913 ;; (org-cycle-hide-drawers 'subtree))
6915 ;; Fold every list in subtree to top-level items.
6916 (when (eq org-cycle-include-plain-lists
'integrate
)
6918 (org-back-to-heading)
6919 (while (org-list-search-forward (org-item-beginning-re) eos t
)
6920 (beginning-of-line 1)
6921 (let* ((struct (org-list-struct))
6922 (prevs (org-list-prevs-alist struct
))
6923 (end (org-list-get-bottom-point struct
)))
6924 (mapc (lambda (e) (org-list-set-item-visibility e struct
'folded
))
6925 (org-list-get-all-items (point) struct prevs
))
6926 (goto-char (if (< end eos
) end eos
)))))))
6927 (org-unlogged-message "CHILDREN")
6930 (outline-next-heading)
6931 (if (outline-invisible-p) (org-flag-heading nil
)))
6932 (setq org-cycle-subtree-status
'children
)
6933 (unless (org-before-first-heading-p)
6934 (run-hook-with-args 'org-cycle-hook
'children
)))
6935 ((or children-skipped
6936 (and (eq last-command this-command
)
6937 (eq org-cycle-subtree-status
'children
)))
6938 ;; We just showed the children, or no children are there,
6939 ;; now show everything.
6940 (unless (org-before-first-heading-p)
6941 (run-hook-with-args 'org-pre-cycle-hook
'subtree
))
6942 (outline-flag-region eoh eos nil
)
6943 (org-unlogged-message
6944 (if children-skipped
"SUBTREE (NO CHILDREN)" "SUBTREE"))
6945 (setq org-cycle-subtree-status
'subtree
)
6946 (unless (org-before-first-heading-p)
6947 (run-hook-with-args 'org-cycle-hook
'subtree
)))
6949 ;; Default action: hide the subtree.
6950 (run-hook-with-args 'org-pre-cycle-hook
'folded
)
6951 (outline-flag-region eoh eos t
)
6952 (org-unlogged-message "FOLDED")
6953 (setq org-cycle-subtree-status
'folded
)
6954 (unless (org-before-first-heading-p)
6955 (run-hook-with-args 'org-cycle-hook
'folded
))))))
6958 (defun org-global-cycle (&optional arg
)
6959 "Cycle the global visibility. For details see `org-cycle'.
6960 With \\[universal-argument] prefix arg, switch to startup visibility.
6961 With a numeric prefix, show all headlines up to that level."
6963 (let ((org-cycle-include-plain-lists
6964 (if (derived-mode-p 'org-mode
) org-cycle-include-plain-lists nil
)))
6968 (hide-sublevels arg
)
6969 (setq org-cycle-global-status
'contents
))
6971 (org-set-startup-visibility)
6972 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6974 (org-cycle '(4))))))
6976 (defun org-set-startup-visibility ()
6977 "Set the visibility required by startup options and properties."
6979 ((eq org-startup-folded t
)
6981 ((eq org-startup-folded
'content
)
6983 ((or (eq org-startup-folded
'showeverything
)
6984 (eq org-startup-folded nil
))
6986 (unless (eq org-startup-folded
'showeverything
)
6987 (if org-hide-block-startup
(org-hide-block-all))
6988 (org-set-visibility-according-to-property 'no-cleanup
)
6989 (org-cycle-hide-archived-subtrees 'all
)
6990 (org-cycle-hide-drawers 'all
)
6991 (org-cycle-show-empty-lines t
)))
6993 (defun org-set-visibility-according-to-property (&optional no-cleanup
)
6994 "Switch subtree visibilities according to :VISIBILITY: property."
6996 (let (org-show-entry-below)
6997 (org-with-wide-buffer
6998 (goto-char (point-min))
6999 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t
)
7000 (if (not (org-at-property-p)) (outline-next-heading)
7001 (let ((state (match-string 3)))
7003 (org-back-to-heading t
)
7007 ((equal state
"folded")
7009 ((equal state
"children")
7010 (org-show-hidden-entry)
7012 ((equal state
"content")
7015 (org-narrow-to-subtree)
7017 ((member state
'("all" "showall"))
7018 (show-subtree)))))))
7020 (org-cycle-hide-archived-subtrees 'all
)
7021 (org-cycle-hide-drawers 'all
)
7022 (org-cycle-show-empty-lines 'all
)))))
7024 ;; This function uses outline-regexp instead of the more fundamental
7025 ;; org-outline-regexp so that org-cycle-global works outside of Org
7026 ;; buffers, where outline-regexp is needed.
7027 (defun org-overview ()
7028 "Switch to overview mode, showing only top-level headlines.
7029 This shows all headlines with a level equal or greater than the level
7030 of the first headline in the buffer. This is important, because if the
7031 first headline is not level one, then (hide-sublevels 1) gives confusing
7037 (goto-char (point-min))
7038 (if (re-search-forward (concat "^" outline-regexp
) nil t
)
7040 (goto-char (match-beginning 0))
7041 (funcall outline-level
))))))
7042 (and level
(hide-sublevels level
)))))
7044 (defun org-content (&optional arg
)
7045 "Show all headlines in the buffer, like a table of contents.
7046 With numerical argument N, show content up to level N."
7050 ;; Visit all headings and show their offspring
7051 (and (integerp arg
) (org-overview))
7052 (goto-char (point-max))
7054 (while (and (progn (condition-case nil
7055 (outline-previous-visible-heading 1)
7056 (error (goto-char (point-min))))
7058 (looking-at org-outline-regexp
))
7060 (show-children (1- arg
))
7062 (if (bobp) (throw 'exit nil
))))))
7064 (defun org-optimize-window-after-visibility-change (state)
7065 "Adjust the window after a change in outline visibility.
7066 This function is the default value of the hook `org-cycle-hook'."
7067 (when (get-buffer-window (current-buffer))
7069 ((eq state
'content
) nil
)
7070 ((eq state
'all
) nil
)
7071 ((eq state
'folded
) nil
)
7072 ((eq state
'children
) (or (org-subtree-end-visible-p) (recenter 1)))
7073 ((eq state
'subtree
) (or (org-subtree-end-visible-p) (recenter 1))))))
7075 (defun org-remove-empty-overlays-at (pos)
7076 "Remove outline overlays that do not contain non-white stuff."
7079 (and (eq 'outline
(overlay-get o
'invisible
))
7080 (not (string-match "\\S-" (buffer-substring (overlay-start o
)
7082 (delete-overlay o
)))
7085 (defun org-clean-visibility-after-subtree-move ()
7086 "Fix visibility issues after moving a subtree."
7087 ;; First, find a reasonable region to look at:
7088 ;; Start two siblings above, end three below
7089 (let* ((beg (save-excursion
7090 (and (org-get-last-sibling)
7091 (org-get-last-sibling))
7093 (end (save-excursion
7094 (and (org-get-next-sibling)
7095 (org-get-next-sibling)
7096 (org-get-next-sibling))
7097 (if (org-at-heading-p)
7100 (level (looking-at "\\*+"))
7101 (re (if level
(concat "^" (regexp-quote (match-string 0)) " "))))
7104 (narrow-to-region beg end
)
7106 ;; Properly fold already folded siblings
7107 (goto-char (point-min))
7108 (while (re-search-forward re nil t
)
7109 (if (and (not (outline-invisible-p))
7111 (goto-char (point-at-eol)) (outline-invisible-p)))
7113 (org-cycle-show-empty-lines 'overview
)
7114 (org-cycle-hide-drawers 'overview
)))))
7116 (defun org-cycle-show-empty-lines (state)
7117 "Show empty lines above all visible headlines.
7118 The region to be covered depends on STATE when called through
7119 `org-cycle-hook'. Lisp program can use t for STATE to get the
7120 entire buffer covered. Note that an empty line is only shown if there
7121 are at least `org-cycle-separator-lines' empty lines before the headline."
7122 (when (/= org-cycle-separator-lines
0)
7124 (let* ((n (abs org-cycle-separator-lines
))
7126 ((= n
1) "\\(\n[ \t]*\n\\*+\\) ")
7127 ((= n
2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7128 (t (let ((ns (number-to-string (- n
2))))
7129 (concat "^\\(?:[ \t]*\n\\)\\{" ns
"," ns
"\\}"
7130 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7133 ((memq state
'(overview contents t
))
7134 (setq beg
(point-min) end
(point-max)))
7135 ((memq state
'(children folded
))
7137 end
(progn (org-end-of-subtree t t
)
7138 (line-beginning-position 2)))))
7141 (while (re-search-forward re end t
)
7142 (unless (get-char-property (match-end 1) 'invisible
)
7143 (let ((e (match-end 1))
7144 (b (if (>= org-cycle-separator-lines
0)
7147 (goto-char (match-beginning 0))
7148 (skip-chars-backward " \t\n")
7149 (line-end-position)))))
7150 (outline-flag-region b e nil
))))))))
7151 ;; Never hide empty lines at the end of the file.
7153 (goto-char (point-max))
7154 (outline-previous-heading)
7155 (outline-end-of-heading)
7156 (if (and (looking-at "[ \t\n]+")
7157 (= (match-end 0) (point-max)))
7158 (outline-flag-region (point) (match-end 0) nil
))))
7160 (defun org-show-empty-lines-in-parent ()
7161 "Move to the parent and re-show empty lines before visible headlines."
7163 (let ((context (if (org-up-heading-safe) 'children
'overview
)))
7164 (org-cycle-show-empty-lines context
))))
7166 (defun org-files-list ()
7167 "Return `org-agenda-files' list, plus all open org-mode files.
7168 This is useful for operations that need to scan all of a user's
7169 open and agenda-wise Org files."
7170 (let ((files (mapcar 'expand-file-name
(org-agenda-files))))
7171 (dolist (buf (buffer-list))
7172 (with-current-buffer buf
7173 (if (and (derived-mode-p 'org-mode
) (buffer-file-name))
7174 (let ((file (expand-file-name (buffer-file-name))))
7175 (unless (member file files
)
7176 (push file files
))))))
7179 (defsubst org-entry-beginning-position
()
7180 "Return the beginning position of the current entry."
7181 (save-excursion (outline-back-to-heading t
) (point)))
7183 (defsubst org-entry-end-position
()
7184 "Return the end position of the current entry."
7185 (save-excursion (outline-next-heading) (point)))
7187 (defun org-cycle-hide-drawers (state &optional exceptions
)
7188 "Re-hide all drawers after a visibility state change.
7189 When non-nil, optional argument EXCEPTIONS is a list of strings
7190 specifying which drawers should not be hidden."
7191 (when (and (derived-mode-p 'org-mode
)
7192 (not (memq state
'(overview folded contents
))))
7194 (let* ((globalp (memq state
'(contents all
)))
7195 (beg (if globalp
(point-min) (point)))
7196 (end (if globalp
(point-max)
7197 (if (eq state
'children
)
7198 (save-excursion (outline-next-heading) (point))
7199 (org-end-of-subtree t
)))))
7201 (while (re-search-forward org-drawer-regexp
(max end
(point)) t
)
7202 (unless (member-ignore-case (match-string 1) exceptions
)
7203 (let ((drawer (org-element-at-point)))
7204 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7205 (org-flag-drawer t drawer
)
7206 ;; Make sure to skip drawer entirely or we might flag
7207 ;; it another time when matching its ending line with
7208 ;; `org-drawer-regexp'.
7209 (goto-char (org-element-property :end drawer
))))))))))
7211 (defun org-flag-drawer (flag &optional element
)
7212 "When FLAG is non-nil, hide the drawer we are at.
7213 Otherwise make it visible. When optional argument ELEMENT is
7214 a parsed drawer, as returned by `org-element-at-point', hide or
7215 show that drawer instead."
7216 (when (save-excursion
7218 (org-looking-at-p org-drawer-regexp
))
7219 (let ((drawer (or element
(org-element-at-point))))
7220 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7221 (let ((post (org-element-property :post-affiliated drawer
)))
7223 (outline-flag-region
7224 (progn (goto-char post
) (line-end-position))
7225 (progn (goto-char (org-element-property :end drawer
))
7226 (skip-chars-backward " \r\t\n")
7227 (line-end-position))
7229 ;; When the drawer is hidden away, make sure point lies in
7230 ;; a visible part of the buffer.
7231 (when (and flag
(> (line-beginning-position) post
))
7232 (goto-char post
)))))))
7234 (defun org-subtree-end-visible-p ()
7235 "Is the end of the current subtree visible?"
7236 (pos-visible-in-window-p
7237 (save-excursion (org-end-of-subtree t
) (point))))
7239 (defun org-first-headline-recenter ()
7240 "Move cursor to the first headline and recenter the headline."
7241 (goto-char (point-min))
7242 (when (re-search-forward (concat "^\\(" org-outline-regexp
"\\)") nil t
)
7243 (set-window-start (selected-window) (point-at-bol))))
7245 ;;; Saving and restoring visibility
7247 (defun org-outline-overlay-data (&optional use-markers
)
7248 "Return a list of the locations of all outline overlays.
7249 These are overlays with the `invisible' property value `outline'.
7250 The return value is a list of cons cells, with start and stop
7251 positions for each overlay.
7252 If USE-MARKERS is set, return the positions as markers."
7259 (when (eq (overlay-get o
'invisible
) 'outline
)
7260 (setq beg
(overlay-start o
)
7261 end
(overlay-end o
))
7262 (and beg end
(> end beg
)
7264 (cons (copy-marker beg
)
7265 (copy-marker end t
))
7267 (overlays-in (point-min) (point-max))))))))
7269 (defun org-set-outline-overlay-data (data)
7270 "Create visibility overlays for all positions in DATA.
7271 DATA should have been made by `org-outline-overlay-data'."
7278 (outline-flag-region (car c
) (cdr c
) t
))
7281 ;;; Folding of blocks
7283 (defvar org-hide-block-overlays nil
7284 "Overlays hiding blocks.")
7285 (make-variable-buffer-local 'org-hide-block-overlays
)
7287 (defun org-block-map (function &optional start end
)
7288 "Call FUNCTION at the head of all source blocks in the current buffer.
7289 Optional arguments START and END can be used to limit the range."
7290 (let ((start (or start
(point-min)))
7291 (end (or end
(point-max))))
7294 (while (and (< (point) end
) (re-search-forward org-block-regexp end t
))
7297 (goto-char (match-beginning 0))
7298 (funcall function
)))))))
7300 (defun org-hide-block-toggle-all ()
7301 "Toggle the visibility of all blocks in the current buffer."
7302 (org-block-map 'org-hide-block-toggle
))
7304 (defun org-hide-block-all ()
7305 "Fold all blocks in the current buffer."
7307 (org-show-block-all)
7308 (org-block-map 'org-hide-block-toggle-maybe
))
7310 (defun org-show-block-all ()
7311 "Unfold all blocks in the current buffer."
7313 (mapc 'delete-overlay org-hide-block-overlays
)
7314 (setq org-hide-block-overlays nil
))
7316 (defun org-hide-block-toggle-maybe ()
7317 "Toggle visibility of block at point.
7318 Unlike to `org-hide-block-toggle', this function does not throw
7319 an error. Return a non-nil value when toggling is successful."
7321 (ignore-errors (org-hide-block-toggle)))
7323 (defun org-hide-block-toggle (&optional force
)
7324 "Toggle the visibility of the current block.
7325 When optional argument FORCE is `off', make block visible. If it
7326 is non-nil, hide it unconditionally. Throw an error when not at
7327 a block. Return a non-nil value when toggling is successful."
7329 (let ((element (org-element-at-point)))
7330 (unless (memq (org-element-type element
)
7331 '(center-block comment-block dynamic-block example-block
7332 export-block quote-block special-block
7333 src-block verse-block
))
7334 (user-error "Not at a block"))
7335 (let* ((start (save-excursion
7336 (goto-char (org-element-property :post-affiliated element
))
7337 (line-end-position)))
7338 (end (save-excursion
7339 (goto-char (org-element-property :end element
))
7340 (skip-chars-backward " \r\t\n")
7341 (line-end-position)))
7342 (overlays (overlays-at start
)))
7344 ;; Do nothing when not before or at the block opening line or
7345 ;; at the block closing line.
7346 ((let ((eol (line-end-position))) (and (> eol start
) (/= eol end
))) nil
)
7347 ((and (not (eq force
'off
))
7348 (not (memq t
(mapcar
7350 (eq (overlay-get o
'invisible
) 'org-hide-block
))
7352 (let ((ov (make-overlay start end
)))
7353 (overlay-put ov
'invisible
'org-hide-block
)
7354 ;; Make the block accessible to `isearch'.
7356 ov
'isearch-open-invisible
7358 (when (memq ov org-hide-block-overlays
)
7359 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7360 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7361 (delete-overlay ov
))))
7362 (push ov org-hide-block-overlays
)
7363 ;; When the block is hidden away, make sure point is left in
7364 ;; a visible part of the buffer.
7365 (when (> (line-beginning-position) start
)
7367 (beginning-of-line))
7368 ;; Signal successful toggling.
7370 ((or (not force
) (eq force
'off
))
7371 (dolist (ov overlays t
)
7372 (when (memq ov org-hide-block-overlays
)
7373 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7374 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7375 (delete-overlay ov
))))))))
7377 ;; org-tab-after-check-for-cycling-hook
7378 (add-hook 'org-tab-first-hook
'org-hide-block-toggle-maybe
)
7379 ;; Remove overlays when changing major mode
7380 (add-hook 'org-mode-hook
7381 (lambda () (org-add-hook 'change-major-mode-hook
7382 'org-show-block-all
'append
'local
)))
7386 (defvar org-goto-window-configuration nil
)
7387 (defvar org-goto-marker nil
)
7388 (defvar org-goto-map
)
7389 (defun org-goto-map ()
7390 "Set the keymap `org-goto'."
7392 (let ((map (make-sparse-keymap)))
7393 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7394 mouse-drag-region universal-argument org-occur
))
7396 (while (setq cmd
(pop cmds
))
7397 (substitute-key-definition cmd cmd map global-map
)))
7398 (suppress-keymap map
)
7399 (org-defkey map
"\C-m" 'org-goto-ret
)
7400 (org-defkey map
[(return)] 'org-goto-ret
)
7401 (org-defkey map
[(left)] 'org-goto-left
)
7402 (org-defkey map
[(right)] 'org-goto-right
)
7403 (org-defkey map
[(control ?g
)] 'org-goto-quit
)
7404 (org-defkey map
"\C-i" 'org-cycle
)
7405 (org-defkey map
[(tab)] 'org-cycle
)
7406 (org-defkey map
[(down)] 'outline-next-visible-heading
)
7407 (org-defkey map
[(up)] 'outline-previous-visible-heading
)
7408 (if org-goto-auto-isearch
7409 (if (fboundp 'define-key-after
)
7410 (define-key-after map
[t] 'org-goto-local-auto-isearch)
7412 (org-defkey map "q" 'org-goto-quit)
7413 (org-defkey map "n" 'outline-next-visible-heading)
7414 (org-defkey map "p" 'outline-previous-visible-heading)
7415 (org-defkey map "f" 'outline-forward-same-level)
7416 (org-defkey map "b" 'outline-backward-same-level)
7417 (org-defkey map "u" 'outline-up-heading))
7418 (org-defkey map "/" 'org-occur)
7419 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7420 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7421 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7422 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7423 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7426 (defconst org-goto-help
7427 "Browse buffer copy, to find location or copy text.%s
7428 RET=jump to location C-g=quit and return to previous location
7429 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7431 (defvar org-goto-start-pos) ; dynamically scoped parameter
7433 (defun org-goto (&optional alternative-interface)
7434 "Look up a different location in the current file, keeping current visibility.
7436 When you want look-up or go to a different location in a
7437 document, the fastest way is often to fold the entire buffer and
7438 then dive into the tree. This method has the disadvantage, that
7439 the previous location will be folded, which may not be what you
7442 This command works around this by showing a copy of the current
7443 buffer in an indirect buffer, in overview mode. You can dive
7444 into the tree in that copy, use org-occur and incremental search
7445 to find a location. When pressing RET or `Q', the command
7446 returns to the original buffer in which the visibility is still
7447 unchanged. After RET it will also jump to the location selected
7448 in the indirect buffer and expose the headline hierarchy above.
7450 With a prefix argument, use the alternative interface: e.g. if
7451 `org-goto-interface' is 'outline use 'outline-path-completion."
7454 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7455 (org-refile-use-outline-path t)
7456 (org-refile-target-verify-function nil)
7458 (if (not alternative-interface)
7460 (if (eq org-goto-interface 'outline)
7461 'outline-path-completion
7463 (org-goto-start-pos (point))
7465 (if (eq interface 'outline)
7466 (car (org-get-location (current-buffer) org-goto-help))
7467 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7468 (org-refile-check-position pa)
7472 (org-mark-ring-push org-goto-start-pos)
7473 (goto-char selected-point)
7474 (if (or (outline-invisible-p) (org-invisible-p2))
7475 (org-show-context 'org-goto)))
7478 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7479 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7480 (defvar org-goto-local-auto-isearch-map) ; defined below
7482 (defun org-get-location (buf help)
7483 "Let the user select a location in the Org-mode buffer BUF.
7484 This function uses a recursive edit. It returns the selected position
7487 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7488 (isearch-hide-immediately nil)
7489 (isearch-search-fun-function
7490 (lambda () 'org-goto-local-search-headings))
7491 (org-goto-selected-point org-goto-exit-command))
7493 (save-window-excursion
7494 (delete-other-windows)
7495 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7496 (org-pop-to-buffer-same-window
7498 (make-indirect-buffer (current-buffer) "*org-goto*")
7499 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7500 (with-output-to-temp-buffer "*Org Help*"
7501 (princ (format help (if org-goto-auto-isearch
7502 " Just type for auto-isearch."
7503 " n/p/f/b/u to navigate, q to quit."))))
7504 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7505 (setq buffer-read-only nil)
7506 (let ((org-startup-truncated t)
7507 (org-startup-folded nil)
7508 (org-startup-align-all-tables nil))
7511 (setq buffer-read-only t)
7512 (if (and (boundp 'org-goto-start-pos)
7513 (integer-or-marker-p org-goto-start-pos))
7514 (progn (goto-char org-goto-start-pos)
7515 (when (outline-invisible-p)
7516 (org-show-set-visibility 'lineage)))
7517 (goto-char (point-min)))
7518 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7519 (message "Select location and press RET")
7520 (use-local-map org-goto-map)
7522 (kill-buffer "*org-goto*")
7523 (cons org-goto-selected-point org-goto-exit-command))))
7525 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7526 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7527 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7528 (if (fboundp 'isearch-other-control-char)
7530 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7531 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7532 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7533 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7534 (define-key org-goto-local-auto-isearch-map [return] nil))
7536 (defun org-goto-local-search-headings (string bound noerror)
7537 "Search and make sure that any matches are in headlines."
7539 (while (if isearch-forward
7540 (search-forward string bound noerror)
7541 (search-backward string bound noerror))
7542 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7543 (and (member :headline context)
7544 (not (member :tags context))))
7545 (throw 'return (point))))))
7547 (defun org-goto-local-auto-isearch ()
7550 (goto-char (point-min))
7551 (let ((keys (this-command-keys)))
7552 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7554 (isearch-process-search-char (string-to-char keys)))))
7556 (defun org-goto-ret (&optional arg)
7557 "Finish `org-goto' by going to the new location."
7559 (setq org-goto-selected-point (point)
7560 org-goto-exit-command 'return)
7563 (defun org-goto-left ()
7564 "Finish `org-goto' by going to the new location."
7566 (if (org-at-heading-p)
7568 (beginning-of-line 1)
7569 (setq org-goto-selected-point (point)
7570 org-goto-exit-command 'left)
7572 (user-error "Not on a heading")))
7574 (defun org-goto-right ()
7575 "Finish `org-goto' by going to the new location."
7577 (if (org-at-heading-p)
7579 (setq org-goto-selected-point (point)
7580 org-goto-exit-command 'right)
7582 (user-error "Not on a heading")))
7584 (defun org-goto-quit ()
7585 "Finish `org-goto' without cursor motion."
7587 (setq org-goto-selected-point nil)
7588 (setq org-goto-exit-command 'quit)
7591 ;;; Indirect buffer display of subtrees
7593 (defvar org-indirect-dedicated-frame nil
7594 "This is the frame being used for indirect tree display.")
7595 (defvar org-last-indirect-buffer nil)
7597 (defun org-tree-to-indirect-buffer (&optional arg)
7598 "Create indirect buffer and narrow it to current subtree.
7599 With a numerical prefix ARG, go up to this level and then take that tree.
7600 If ARG is negative, go up that many levels.
7602 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7603 indirect buffer previously made with this command, to avoid proliferation of
7604 indirect buffers. However, when you call the command with a \
7605 \\[universal-argument] prefix, or
7606 when `org-indirect-buffer-display' is `new-frame', the last buffer
7607 is kept so that you can work with several indirect buffers at the same time.
7608 If `org-indirect-buffer-display' is `dedicated-frame', the \
7609 \\[universal-argument] prefix also
7610 requests that a new frame be made for the new buffer, so that the dedicated
7611 frame is not changed."
7613 (let ((cbuf (current-buffer))
7614 (cwin (selected-window))
7616 beg end level heading ibuf)
7618 (org-back-to-heading t)
7620 (setq level (org-outline-level))
7621 (if (< arg 0) (setq arg (+ level arg)))
7622 (while (> (setq level (org-outline-level)) arg)
7623 (org-up-heading-safe)))
7625 heading (org-get-heading))
7626 (org-end-of-subtree t t)
7627 (if (org-at-heading-p) (backward-char 1))
7629 (if (and (buffer-live-p org-last-indirect-buffer)
7630 (not (eq org-indirect-buffer-display 'new-frame))
7632 (kill-buffer org-last-indirect-buffer))
7633 (setq ibuf (org-get-indirect-buffer cbuf heading)
7634 org-last-indirect-buffer ibuf)
7636 ((or (eq org-indirect-buffer-display 'new-frame)
7637 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7638 (select-frame (make-frame))
7639 (delete-other-windows)
7640 (org-pop-to-buffer-same-window ibuf)
7641 (org-set-frame-title heading))
7642 ((eq org-indirect-buffer-display 'dedicated-frame)
7644 (select-frame (or (and org-indirect-dedicated-frame
7645 (frame-live-p org-indirect-dedicated-frame)
7646 org-indirect-dedicated-frame)
7647 (setq org-indirect-dedicated-frame (make-frame)))))
7648 (delete-other-windows)
7649 (org-pop-to-buffer-same-window ibuf)
7650 (org-set-frame-title (concat "Indirect: " heading)))
7651 ((eq org-indirect-buffer-display 'current-window)
7652 (org-pop-to-buffer-same-window ibuf))
7653 ((eq org-indirect-buffer-display 'other-window)
7654 (pop-to-buffer ibuf))
7655 (t (error "Invalid value")))
7656 (if (featurep 'xemacs)
7657 (save-excursion (org-mode) (turn-on-font-lock)))
7658 (narrow-to-region beg end)
7661 (run-hook-with-args 'org-cycle-hook 'all)
7662 (and (window-live-p cwin) (select-window cwin))))
7664 (defun org-get-indirect-buffer (&optional buffer heading)
7665 (setq buffer (or buffer (current-buffer)))
7666 (let ((n 1) (base (buffer-name buffer)) bname)
7667 (while (buffer-live-p
7671 (if heading (concat heading "-" (number-to-string n))
7672 (number-to-string n))))))
7675 (make-indirect-buffer buffer bname 'clone)
7676 (error (make-indirect-buffer buffer bname)))))
7678 (defun org-set-frame-title (title)
7679 "Set the title of the current frame to the string TITLE."
7680 ;; FIXME: how to name a single frame in XEmacs???
7681 (unless (featurep 'xemacs)
7682 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7684 ;;;; Structure editing
7686 ;;; Inserting headlines
7688 (defun org-previous-line-empty-p (&optional next)
7689 "Is the previous line a blank line?
7690 When NEXT is non-nil, check the next line instead."
7693 (or (beginning-of-line (if next 2 0)) t)
7695 (looking-at "[ \t]*$")))))
7697 (defun org-insert-heading (&optional arg invisible-ok top-level)
7698 "Insert a new heading or an item with the same depth at point.
7700 If point is at the beginning of a heading or a list item, insert
7701 a new heading or a new item above the current one. If point is
7702 at the beginning of a normal line, turn the line into a heading.
7704 If point is in the middle of a headline or a list item, split the
7705 headline or the item and create a new headline/item with the text
7706 in the current line after point \(see `org-M-RET-may-split-line'
7707 on how to modify this behavior).
7709 With one universal prefix argument, set the user option
7710 `org-insert-heading-respect-content' to t for the duration of
7711 the command. This modifies the behavior described above in this
7712 ways: on list items and at the beginning of normal lines, force
7713 the insertion of a heading after the current subtree.
7715 With two universal prefix arguments, insert the heading at the
7716 end of the grandparent subtree. For example, if point is within
7717 a 2nd-level heading, then it will insert a 2nd-level heading at
7718 the end of the 1st-level parent heading.
7720 If point is at the beginning of a headline, insert a sibling
7721 before the current headline. If point is not at the beginning,
7722 split the line and create a new headline with the text in the
7723 current line after point \(see `org-M-RET-may-split-line' on how
7724 to modify this behavior).
7726 If point is at the beginning of a normal line, turn this line
7729 When INVISIBLE-OK is set, stop at invisible headlines when going
7730 back. This is important for non-interactive uses of the
7733 When optional argument TOP-LEVEL is non-nil, insert a level 1
7734 heading, unconditionally."
7736 (if (org-called-interactively-p 'any) (org-reveal))
7737 (let ((itemp (and (not top-level) (org-in-item-p)))
7738 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7739 (respect-content (or org-insert-heading-respect-content
7741 (initial-content ""))
7745 ((or (= (buffer-size) 0)
7746 (and (not (save-excursion
7747 (and (ignore-errors (org-back-to-heading invisible-ok))
7748 (org-at-heading-p))))
7749 (or arg (not itemp))))
7750 ;; At beginning of buffer or so high up that only a heading
7752 (cond ((and (bolp) (not respect-content)) (insert "* "))
7753 ((not respect-content)
7754 (unless may-split (end-of-line))
7756 ((re-search-forward org-outline-regexp-bol nil t)
7760 (t (goto-char (point-max))
7762 (run-hooks 'org-insert-heading-hook))
7764 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7767 ;; Maybe move at the end of the subtree
7768 (when (equal arg '(16))
7769 (org-up-heading-safe)
7770 (org-end-of-subtree t))
7775 (on-heading (org-at-heading-p))
7776 (empty-line-p (if on-heading
7777 (org-previous-line-empty-p)
7778 ;; We will decide later
7780 ;; Get a level string to fall back on.
7782 (if (org-before-first-heading-p) "*"
7784 (org-back-to-heading t)
7785 (if (org-previous-line-empty-p) (setq empty-line-p t))
7786 (looking-at org-outline-regexp)
7787 (make-string (1- (length (match-string 0))) ?*))))
7792 (org-back-to-heading invisible-ok)
7793 (when (and (not on-heading)
7794 (featurep 'org-inlinetask)
7795 (integerp org-inlinetask-min-level)
7796 (>= (length (match-string 0))
7797 org-inlinetask-min-level))
7798 ;; Find a heading level before the inline
7800 (while (and (setq level (org-up-heading-safe))
7801 (>= level org-inlinetask-min-level)))
7802 (if (org-at-heading-p)
7803 (org-back-to-heading invisible-ok)
7804 (error "This should not happen")))
7805 (unless (and (save-excursion
7807 (org-backward-heading-same-level
7809 (= (point) (match-beginning 0)))
7810 (not (org-previous-line-empty-p t)))
7811 (setq empty-line-p (or empty-line-p
7812 (org-previous-line-empty-p))))
7814 (error (or fix-level "* ")))))
7815 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7816 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7817 pos hide-previous previous-pos)
7819 ;; If we insert after content, move there and clean up
7821 (when (and respect-content
7822 (not (org-looking-at-p org-outline-regexp-bol)))
7823 (if (not (org-before-first-heading-p))
7824 (org-end-of-subtree nil t)
7825 (re-search-forward org-outline-regexp-bol)
7826 (beginning-of-line 0))
7827 (skip-chars-backward " \r\t\n")
7828 (and (not (looking-back "^\\*+"))
7829 (looking-at "[ \t]+") (replace-match ""))
7830 (unless (eobp) (forward-char 1))
7831 (when (looking-at "^\\*")
7832 (unless (bobp) (backward-char 1))
7835 ;; If we are splitting, grab the text that should be moved
7836 ;; to the new headline.
7838 (if (org-on-heading-p)
7839 ;; This is a heading: split intelligently (keeping
7841 (let ((pos (point)))
7843 (unless (looking-at org-complex-heading-regexp)
7844 (error "This should not happen"))
7845 (when (and (match-beginning 4)
7846 (> pos (match-beginning 4))
7847 (< pos (match-end 4)))
7848 (setq initial-content (buffer-substring pos (match-end 4)))
7850 (delete-region (point) (match-end 4))
7851 (if (looking-at "[ \t]*$")
7853 (insert (make-string (length initial-content) ?\s)))
7854 (setq initial-content (org-trim initial-content)))
7857 (setq initial-content
7859 (delete-and-extract-region (point) (line-end-position))))))
7861 ;; If we are at the beginning of the line, insert before it.
7862 ;; Otherwise, after it.
7864 ((and (bolp) (looking-at "[ \t]*$")))
7865 ((bolp) (save-excursion (insert "\n")))
7869 ;; Insert the new heading
7872 (insert initial-content)
7873 (unless (and blank (org-previous-line-empty-p))
7874 (org-N-empty-lines-before-current (if blank 1 0)))
7875 ;; Adjust visibility, which may be messed up if we removed
7876 ;; blank lines while previous entry was hidden.
7877 (let ((bol (line-beginning-position)))
7878 (dolist (o (overlays-at (1- bol)))
7879 (when (and (eq (overlay-get o 'invisible) 'outline)
7880 (eq (overlay-end o) bol))
7881 (move-overlay o (overlay-start o) (1- bol)))))
7882 (run-hooks 'org-insert-heading-hook)))))))
7884 (defun org-N-empty-lines-before-current (N)
7885 "Make the number of empty lines before current exactly N.
7886 So this will delete or add empty lines."
7890 (skip-chars-backward " \r\t\n")
7891 (unless (bolp) (forward-line))
7892 (delete-region (point) p))
7893 (when (> N 0) (insert (make-string N ?\n)))))
7895 (defun org-get-heading (&optional no-tags no-todo)
7896 "Return the heading of the current entry, without the stars.
7897 When NO-TAGS is non-nil, don't include tags.
7898 When NO-TODO is non-nil, don't include TODO keywords."
7900 (org-back-to-heading t)
7902 ((and no-tags no-todo)
7903 (looking-at org-complex-heading-regexp)
7906 (looking-at (concat org-outline-regexp
7908 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7911 (looking-at org-todo-line-regexp)
7913 (t (looking-at org-heading-regexp)
7914 (match-string 2)))))
7916 (defvar orgstruct-mode) ; defined below
7918 (defun org-heading-components ()
7919 "Return the components of the current heading.
7920 This is a list with the following elements:
7921 - the level as an integer
7922 - the reduced level, different if `org-odd-levels-only' is set.
7923 - the TODO keyword, or nil
7924 - the priority character, like ?A, or nil if no priority is given
7925 - the headline text itself, or the tags string if no headline text
7926 - the tags string, or nil."
7928 (org-back-to-heading t)
7929 (if (let (case-fold-search)
7933 org-complex-heading-regexp)))
7935 (list (length (match-string 1))
7936 (org-reduced-level (length (match-string 1)))
7941 (list (length (match-string 1))
7942 (org-reduced-level (length (match-string 1)))
7943 (org-match-string-no-properties 2)
7944 (and (match-end 3) (aref (match-string 3) 2))
7945 (org-match-string-no-properties 4)
7946 (org-match-string-no-properties 5))))))
7948 (defun org-get-entry ()
7949 "Get the entry text, after heading, entire subtree."
7951 (org-back-to-heading t)
7952 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7954 (defun org-insert-heading-after-current ()
7955 "Insert a new heading with same level as current, after current subtree."
7957 (org-back-to-heading)
7958 (org-insert-heading)
7959 (org-move-subtree-down)
7962 (defun org-insert-heading-respect-content (&optional invisible-ok)
7963 "Insert heading with `org-insert-heading-respect-content' set to t."
7965 (org-insert-heading '(4) invisible-ok))
7967 (defun org-insert-todo-heading-respect-content (&optional force-state)
7968 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7970 (org-insert-todo-heading force-state '(4)))
7972 (defun org-insert-todo-heading (arg &optional force-heading)
7973 "Insert a new heading with the same level and TODO state as current heading.
7974 If the heading has no TODO state, or if the state is DONE, use the first
7975 state (TODO by default). Also with one prefix arg, force first state. With
7976 two prefix args, force inserting at the end of the parent subtree."
7978 (when (or force-heading (not (org-insert-item 'checkbox)))
7979 (org-insert-heading (or (and (equal arg '(16)) '(16))
7982 (org-back-to-heading)
7983 (outline-previous-heading)
7984 (looking-at org-todo-line-regexp))
7987 (if (or (equal arg '(4))
7988 (not (match-beginning 2))
7989 (member (match-string 2) org-done-keywords))
7990 (car org-todo-keywords-1)
7994 (run-hook-with-args-until-success
7995 'org-todo-get-default-hook new-mark-x nil)
7997 (beginning-of-line 1)
7998 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7999 (if org-treat-insert-todo-heading-as-state-change
8001 (insert new-mark " "))))
8002 (when org-provide-todo-statistics
8003 (org-update-parent-todo-statistics))))
8005 (defun org-insert-subheading (arg)
8006 "Insert a new subheading and demote it.
8007 Works for outline headings and for plain lists alike."
8009 (org-insert-heading arg)
8011 ((org-at-heading-p) (org-do-demote))
8012 ((org-at-item-p) (org-indent-item))))
8014 (defun org-insert-todo-subheading (arg)
8015 "Insert a new subheading with TODO keyword or checkbox and demote it.
8016 Works for outline headings and for plain lists alike."
8018 (org-insert-todo-heading arg)
8020 ((org-at-heading-p) (org-do-demote))
8021 ((org-at-item-p) (org-indent-item))))
8023 ;;; Promotion and Demotion
8025 (defvar org-after-demote-entry-hook nil
8026 "Hook run after an entry has been demoted.
8027 The cursor will be at the beginning of the entry.
8028 When a subtree is being demoted, the hook will be called for each node.")
8030 (defvar org-after-promote-entry-hook nil
8031 "Hook run after an entry has been promoted.
8032 The cursor will be at the beginning of the entry.
8033 When a subtree is being promoted, the hook will be called for each node.")
8035 (defun org-promote-subtree ()
8036 "Promote the entire subtree.
8037 See also `org-promote'."
8040 (org-with-limited-levels (org-map-tree 'org-promote)))
8041 (org-fix-position-after-promote))
8043 (defun org-demote-subtree ()
8044 "Demote the entire subtree. See `org-demote'.
8045 See also `org-promote'."
8048 (org-with-limited-levels (org-map-tree 'org-demote)))
8049 (org-fix-position-after-promote))
8052 (defun org-do-promote ()
8053 "Promote the current heading higher up the tree.
8054 If the region is active in `transient-mark-mode', promote all headings
8058 (if (org-region-active-p)
8059 (org-map-region 'org-promote (region-beginning) (region-end))
8061 (org-fix-position-after-promote))
8063 (defun org-do-demote ()
8064 "Demote the current heading lower down the tree.
8065 If the region is active in `transient-mark-mode', demote all headings
8069 (if (org-region-active-p)
8070 (org-map-region 'org-demote (region-beginning) (region-end))
8072 (org-fix-position-after-promote))
8074 (defun org-fix-position-after-promote ()
8075 "Make sure that after pro/demotion cursor position is right."
8076 (let ((pos (point)))
8077 (when (save-excursion
8078 (beginning-of-line 1)
8079 (looking-at org-todo-line-regexp)
8080 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8081 (cond ((eobp) (insert " "))
8082 ((eolp) (insert " "))
8083 ((equal (char-after) ?\ ) (forward-char 1))))))
8085 (defun org-current-level ()
8086 "Return the level of the current entry, or nil if before the first headline.
8087 The level is the number of stars at the beginning of the
8088 headline. Use `org-reduced-level' to remove the effect of
8089 `org-odd-levels'. Unlike to `org-outline-level', this function
8090 ignores inlinetasks."
8091 (let ((level (org-with-limited-levels (org-outline-level))))
8092 (and (> level 0) level)))
8094 (defun org-get-previous-line-level ()
8095 "Return the outline depth of the last headline before the current line.
8096 Returns 0 for the first headline in the buffer, and nil if before the
8098 (and (org-current-level)
8099 (or (and (/= (line-beginning-position) (point-min))
8100 (save-excursion (beginning-of-line 0) (org-current-level)))
8103 (defun org-reduced-level (l)
8104 "Compute the effective level of a heading.
8105 This takes into account the setting of `org-odd-levels-only'."
8108 (org-odd-levels-only (1+ (floor (/ l 2))))
8111 (defun org-level-increment ()
8112 "Return the number of stars that will be added or removed at a
8113 time to headlines when structure editing, based on the value of
8114 `org-odd-levels-only'."
8115 (if org-odd-levels-only 2 1))
8117 (defun org-get-valid-level (level &optional change)
8118 "Rectify a level change under the influence of `org-odd-levels-only'
8119 LEVEL is a current level, CHANGE is by how much the level should be
8120 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8121 even level numbers will become the next higher odd number."
8122 (if org-odd-levels-only
8123 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8124 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8125 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8126 (max 1 (+ level (or change 0)))))
8128 (if (boundp 'define-obsolete-function-alias)
8129 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8130 (define-obsolete-function-alias 'org-get-legal-level
8131 'org-get-valid-level)
8132 (define-obsolete-function-alias 'org-get-legal-level
8133 'org-get-valid-level "23.1")))
8135 (defun org-promote ()
8136 "Promote the current heading higher up the tree."
8137 (org-with-wide-buffer
8138 (org-back-to-heading t)
8139 (let* ((after-change-functions (remq 'flyspell-after-change-function
8140 after-change-functions))
8141 (level (save-match-data (funcall outline-level)))
8142 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8143 (diff (abs (- level (length up-head) -1))))
8145 ((and (= level 1) org-allow-promoting-top-level-subtree)
8146 (replace-match "# " nil t))
8148 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8149 (t (replace-match up-head nil t)))
8151 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8152 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8153 (run-hooks 'org-after-promote-entry-hook))))
8155 (defun org-demote ()
8156 "Demote the current heading lower down the tree."
8157 (org-with-wide-buffer
8158 (org-back-to-heading t)
8159 (let* ((after-change-functions (remq 'flyspell-after-change-function
8160 after-change-functions))
8161 (level (save-match-data (funcall outline-level)))
8162 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8163 (diff (abs (- level (length down-head) -1))))
8164 (replace-match down-head nil t)
8165 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8166 (when org-adapt-indentation (org-fixup-indentation diff))
8167 (run-hooks 'org-after-demote-entry-hook))))
8169 (defun org-cycle-level ()
8170 "Cycle the level of an empty headline through possible states.
8171 This goes first to child, then to parent, level, then up the hierarchy.
8172 After top level, it switches back to sibling level."
8174 (let ((org-adapt-indentation nil))
8175 (when (org-point-at-end-of-empty-headline)
8176 (setq this-command 'org-cycle-level) ; Only needed for caching
8177 (let ((cur-level (org-current-level))
8178 (prev-level (org-get-previous-line-level)))
8180 ;; If first headline in file, promote to top-level.
8182 (loop repeat (/ (- cur-level 1) (org-level-increment))
8183 do (org-do-promote)))
8184 ;; If same level as prev, demote one.
8185 ((= prev-level cur-level)
8187 ;; If parent is top-level, promote to top level if not already.
8189 (loop repeat (/ (- cur-level 1) (org-level-increment))
8190 do (org-do-promote)))
8191 ;; If top-level, return to prev-level.
8193 (loop repeat (/ (- prev-level 1) (org-level-increment))
8194 do (org-do-demote)))
8195 ;; If less than prev-level, promote one.
8196 ((< cur-level prev-level)
8198 ;; If deeper than prev-level, promote until higher than
8200 ((> cur-level prev-level)
8201 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8202 do (org-do-promote))))
8205 (defun org-map-tree (fun)
8206 "Call FUN for every heading underneath the current one."
8207 (org-back-to-heading)
8208 (let ((level (funcall outline-level)))
8212 (outline-next-heading)
8213 (> (funcall outline-level) level))
8217 (defun org-map-region (fun beg end)
8218 "Call FUN for every heading between BEG and END."
8219 (let ((org-ignore-region t))
8221 (setq end (copy-marker end))
8223 (if (and (re-search-forward org-outline-regexp-bol nil t)
8227 (outline-next-heading)
8232 (defun org-fixup-indentation (diff)
8233 "Change the indentation in the current entry by DIFF.
8235 DIFF is an integer. Indentation is done according to the
8238 - Planning information and property drawers are always indented
8239 according to the new level of the headline;
8241 - Footnote definitions and their contents are ignored;
8243 - Inlinetasks' boundaries are not shifted;
8245 - Empty lines are ignored;
8247 - Other lines' indentation are shifted by DIFF columns, unless
8248 it would introduce a structural change in the document, in
8249 which case no shifting is done at all.
8251 Assume point is at a heading or an inlinetask beginning."
8252 (org-with-wide-buffer
8253 (narrow-to-region (line-beginning-position)
8255 (if (org-with-limited-levels (org-at-heading-p))
8256 (org-with-limited-levels (outline-next-heading))
8257 (org-inlinetask-goto-end))
8260 ;; Indent properly planning info and property drawer.
8261 (when (org-looking-at-p org-planning-line-re)
8264 (when (looking-at org-property-drawer-re)
8265 (goto-char (match-end 0))
8267 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8269 (when (zerop diff) (throw 'no-shift nil))
8270 ;; If DIFF is negative, first check if a shift is possible at all
8271 ;; (e.g., it doesn't break structure). This can only happen if
8272 ;; some contents are not properly indented.
8273 (let ((case-fold-search t))
8275 (let ((diff (- diff))
8276 (forbidden-re (concat org-outline-regexp
8278 (substring org-footnote-definition-re 1))))
8282 ((org-looking-at-p "[ \t]*$") (forward-line))
8283 ((and (org-looking-at-p org-footnote-definition-re)
8284 (let ((e (org-element-at-point)))
8285 (and (eq (org-element-type e) 'footnote-definition)
8286 (goto-char (org-element-property :end e))))))
8287 ((org-looking-at-p org-outline-regexp) (forward-line))
8288 ;; Give up if shifting would move before column 0 or
8289 ;; if it would introduce a headline or a footnote
8292 (skip-chars-forward " \t")
8293 (let ((ind (current-column)))
8294 (when (or (< ind diff)
8295 (and (= ind diff) (org-looking-at-p forbidden-re)))
8296 (throw 'no-shift nil)))
8297 ;; Ignore contents of example blocks and source
8298 ;; blocks if their indentation is meant to be
8299 ;; preserved. Jump to block's closing line.
8301 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8302 (let ((e (org-element-at-point)))
8303 (and (memq (org-element-type e)
8304 '(example-block src-block))
8305 (or org-src-preserve-indentation
8306 (org-element-property :preserve-indent e))
8307 (goto-char (org-element-property :end e))
8308 (progn (skip-chars-backward " \r\t\n")
8311 (forward-line))))))))
8312 ;; Shift lines but footnote definitions, inlinetasks boundaries
8313 ;; by DIFF. Also skip contents of source or example blocks
8314 ;; when indentation is meant to be preserved.
8317 ((and (org-looking-at-p org-footnote-definition-re)
8318 (let ((e (org-element-at-point)))
8319 (and (eq (org-element-type e) 'footnote-definition)
8320 (goto-char (org-element-property :end e))))))
8321 ((org-looking-at-p org-outline-regexp) (forward-line))
8322 ((org-looking-at-p "[ \t]*$") (forward-line))
8324 (org-indent-line-to (+ (org-get-indentation) diff))
8326 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8327 (let ((e (org-element-at-point)))
8328 (and (memq (org-element-type e)
8329 '(example-block src-block))
8330 (or org-src-preserve-indentation
8331 (org-element-property :preserve-indent e))
8332 (goto-char (org-element-property :end e))
8333 (progn (skip-chars-backward " \r\t\n")
8336 (forward-line)))))))))
8338 (defun org-convert-to-odd-levels ()
8339 "Convert an org-mode file with all levels allowed to one with odd levels.
8340 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8343 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8344 (let ((outline-level 'org-outline-level)
8345 (org-odd-levels-only nil) n)
8347 (goto-char (point-min))
8348 (while (re-search-forward "^\\*\\*+ " nil t)
8349 (setq n (- (length (match-string 0)) 2))
8350 (while (>= (setq n (1- n)) 0)
8352 (end-of-line 1))))))
8354 (defun org-convert-to-oddeven-levels ()
8355 "Convert an org-mode file with only odd levels to one with odd/even levels.
8356 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8357 file contains a section with an even level, conversion would
8358 destroy the structure of the file. An error is signaled in this
8361 (goto-char (point-min))
8362 ;; First check if there are no even levels
8363 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8364 (org-show-set-visibility 'canonical)
8365 (error "Not all levels are odd in this file. Conversion not possible"))
8366 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8367 (let ((outline-regexp org-outline-regexp)
8368 (outline-level 'org-outline-level)
8369 (org-odd-levels-only nil) n)
8371 (goto-char (point-min))
8372 (while (re-search-forward "^\\*\\*+ " nil t)
8373 (setq n (/ (1- (length (match-string 0))) 2))
8374 (while (>= (setq n (1- n)) 0)
8376 (end-of-line 1))))))
8378 (defun org-tr-level (n)
8379 "Make N odd if required."
8380 (if org-odd-levels-only (1+ (/ n 2)) n))
8382 ;;; Vertical tree motion, cutting and pasting of subtrees
8384 (defun org-move-subtree-up (&optional arg)
8385 "Move the current subtree up past ARG headlines of the same level."
8387 (org-move-subtree-down (- (prefix-numeric-value arg))))
8389 (defun org-move-subtree-down (&optional arg)
8390 "Move the current subtree down past ARG headlines of the same level."
8392 (setq arg (prefix-numeric-value arg))
8393 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8394 'org-get-last-sibling))
8395 (ins-point (make-marker))
8397 (col (current-column))
8398 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8400 (org-back-to-heading)
8403 (setq ne-beg (org-back-over-empty-lines))
8406 (save-excursion (outline-end-of-heading)
8407 (setq folded (outline-invisible-p)))
8408 (progn (org-end-of-subtree nil t)
8409 (unless (eobp) (backward-char))))
8410 (outline-next-heading)
8411 (setq ne-end (org-back-over-empty-lines))
8414 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8415 ;; include less whitespace
8418 (forward-line (- ne-beg ne-end))
8419 (setq beg (point))))
8420 ;; Find insertion point, with error handling
8422 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8423 (progn (goto-char beg0)
8424 (user-error "Cannot move past superior level or buffer limit")))
8425 (setq cnt (1- cnt)))
8427 ;; Moving forward - still need to move over subtree
8428 (progn (org-end-of-subtree t t)
8430 (org-back-over-empty-lines)
8431 (or (bolp) (newline)))))
8432 (setq ne-ins (org-back-over-empty-lines))
8433 (move-marker ins-point (point))
8434 (setq txt (buffer-substring beg end))
8435 (org-save-markers-in-region beg end)
8436 (delete-region beg end)
8437 (org-remove-empty-overlays-at beg)
8438 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8439 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8440 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8441 (let ((bbb (point)))
8442 (insert-before-markers txt)
8443 (org-reinstall-markers-in-region bbb)
8444 (move-marker ins-point bbb))
8445 (or (bolp) (insert "\n"))
8446 (setq ins-end (point))
8447 (goto-char ins-point)
8448 (org-skip-whitespace)
8449 (when (and (< arg 0)
8450 (org-first-sibling-p)
8452 ;; Move whitespace back to beginning
8455 (let ((kill-whole-line t))
8456 (kill-line (- ne-ins ne-beg)) (point)))
8457 (insert (make-string (- ne-ins ne-beg) ?\n)))
8458 (move-marker ins-point nil)
8463 (org-cycle-hide-drawers 'children))
8464 (org-clean-visibility-after-subtree-move)
8465 ;; move back to the initial column we were at
8466 (move-to-column col)))
8468 (defvar org-subtree-clip ""
8469 "Clipboard for cut and paste of subtrees.
8470 This is actually only a copy of the kill, because we use the normal kill
8471 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8473 (defvar org-subtree-clip-folded nil
8474 "Was the last copied subtree folded?
8475 This is used to fold the tree back after pasting.")
8477 (defun org-cut-subtree (&optional n)
8478 "Cut the current subtree into the clipboard.
8479 With prefix arg N, cut this many sequential subtrees.
8480 This is a short-hand for marking the subtree and then cutting it."
8482 (org-copy-subtree n 'cut))
8484 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8485 "Copy the current subtree it in the clipboard.
8486 With prefix arg N, copy this many sequential subtrees.
8487 This is a short-hand for marking the subtree and then copying it.
8488 If CUT is non-nil, actually cut the subtree.
8489 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8490 of some markers in the region, even if CUT is non-nil. This is
8491 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8493 (let (beg end folded (beg0 (point)))
8494 (if (org-called-interactively-p 'any)
8495 (org-back-to-heading nil) ; take what looks like a subtree
8496 (org-back-to-heading t)) ; take what is really there
8498 (skip-chars-forward " \t\r\n")
8501 (outline-next-heading)
8502 (save-excursion (outline-end-of-heading)
8503 (setq folded (outline-invisible-p)))
8504 (ignore-errors (org-forward-heading-same-level (1- n) t))
8505 (org-end-of-subtree t t)))
8506 ;; Include the end of an inlinetask
8507 (when (and (featurep 'org-inlinetask)
8508 (looking-at-p (concat (org-inlinetask-outline-regexp)
8514 (setq org-subtree-clip-folded folded)
8515 (when (or cut force-store-markers)
8516 (org-save-markers-in-region beg end))
8517 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8518 (setq org-subtree-clip (current-kill 0))
8519 (message "%s: Subtree(s) with %d characters"
8520 (if cut "Cut" "Copied")
8521 (length org-subtree-clip)))))
8523 (defun org-paste-subtree (&optional level tree for-yank remove)
8524 "Paste the clipboard as a subtree, with modification of headline level.
8525 The entire subtree is promoted or demoted in order to match a new headline
8528 If the cursor is at the beginning of a headline, the same level as
8529 that headline is used to paste the tree.
8531 If not, the new level is derived from the *visible* headings
8532 before and after the insertion point, and taken to be the inferior headline
8533 level of the two. So if the previous visible heading is level 3 and the
8534 next is level 4 (or vice versa), level 4 will be used for insertion.
8535 This makes sure that the subtree remains an independent subtree and does
8536 not swallow low level entries.
8538 You can also force a different level, either by using a numeric prefix
8539 argument, or by inserting the heading marker by hand. For example, if the
8540 cursor is after \"*****\", then the tree will be shifted to level 5.
8542 If optional TREE is given, use this text instead of the kill ring.
8544 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8545 move back over whitespace before inserting, and move point to the end of
8546 the inserted text when done.
8548 When REMOVE is non-nil, remove the subtree from the clipboard."
8550 (setq tree (or tree (and kill-ring (current-kill 0))))
8551 (unless (org-kill-is-subtree-p tree)
8553 (substitute-command-keys
8554 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8555 (org-with-limited-levels
8556 (let* ((visp (not (outline-invisible-p)))
8558 (^re_ "\\(\\*+\\)[ \t]*")
8559 (old-level (if (string-match org-outline-regexp-bol txt)
8560 (- (match-end 0) (match-beginning 0) 1)
8562 (force-level (cond (level (prefix-numeric-value level))
8563 ((and (looking-at "[ \t]*$")
8565 "^\\*+$" (buffer-substring
8566 (point-at-bol) (point))))
8567 (- (match-end 0) (match-beginning 0)))
8569 (looking-at org-outline-regexp))
8570 (- (match-end 0) (point) 1))))
8571 (previous-level (save-excursion
8574 (outline-previous-visible-heading 1)
8575 (if (looking-at ^re_)
8576 (- (match-end 0) (match-beginning 0) 1)
8579 (next-level (save-excursion
8582 (or (looking-at org-outline-regexp)
8583 (outline-next-visible-heading 1))
8584 (if (looking-at ^re_)
8585 (- (match-end 0) (match-beginning 0) 1)
8588 (new-level (or force-level (max previous-level next-level)))
8589 (shift (if (or (= old-level -1)
8591 (= old-level new-level))
8593 (- new-level old-level)))
8594 (delta (if (> shift 0) -1 1))
8595 (func (if (> shift 0) 'org-demote 'org-promote))
8596 (org-odd-levels-only nil)
8598 ;; Remove the forced level indicator
8600 (delete-region (point-at-bol) (point)))
8602 (beginning-of-line (if (bolp) 1 2))
8604 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8605 (insert-before-markers txt)
8606 (unless (string-match "\n\\'" txt) (insert "\n"))
8607 (setq newend (point))
8608 (org-reinstall-markers-in-region beg)
8611 (skip-chars-forward " \t\n\r")
8613 (if (and (outline-invisible-p) visp)
8614 (save-excursion (outline-show-heading)))
8615 ;; Shift if necessary
8618 (narrow-to-region beg end)
8619 (while (not (= shift 0))
8620 (org-map-region func (point-min) (point-max))
8621 (setq shift (+ delta shift)))
8622 (goto-char (point-min))
8623 (setq newend (point-max))))
8624 (when (or (org-called-interactively-p 'interactive) for-yank)
8625 (message "Clipboard pasted as level %d subtree" new-level))
8626 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8628 (eq org-subtree-clip (current-kill 0))
8629 org-subtree-clip-folded)
8630 ;; The tree was folded before it was killed/copied
8632 (and for-yank (goto-char newend))
8633 (and remove (setq kill-ring (cdr kill-ring))))))
8635 (defun org-kill-is-subtree-p (&optional txt)
8636 "Check if the current kill is an outline subtree, or a set of trees.
8637 Returns nil if kill does not start with a headline, or if the first
8638 headline level is not the largest headline level in the tree.
8639 So this will actually accept several entries of equal levels as well,
8640 which is OK for `org-paste-subtree'.
8641 If optional TXT is given, check this string instead of the current kill."
8642 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8643 (re (org-get-limited-outline-regexp))
8644 (^re (concat "^" re))
8645 (start-level (and kill
8647 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8649 (- (match-end 2) (match-beginning 2) 1)))
8650 (start (1+ (or (match-beginning 2) -1))))
8651 (if (not start-level)
8653 nil) ;; does not even start with a heading
8655 (while (setq start (string-match ^re kill (1+ start)))
8656 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8660 (defvar org-markers-to-move nil
8661 "Markers that should be moved with a cut-and-paste operation.
8662 Those markers are stored together with their positions relative to
8663 the start of the region.")
8665 (defun org-save-markers-in-region (beg end)
8666 "Check markers in region.
8667 If these markers are between BEG and END, record their position relative
8668 to BEG, so that after moving the block of text, we can put the markers back
8670 This function gets called just before an entry or tree gets cut from the
8671 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8672 called immediately, to move the markers with the entries."
8673 (setq org-markers-to-move nil)
8674 (when (featurep 'org-clock)
8675 (org-clock-save-markers-for-cut-and-paste beg end))
8676 (when (featurep 'org-agenda)
8677 (org-agenda-save-markers-for-cut-and-paste beg end)))
8679 (defun org-check-and-save-marker (marker beg end)
8680 "Check if MARKER is between BEG and END.
8681 If yes, remember the marker and the distance to BEG."
8682 (when (and (marker-buffer marker)
8683 (equal (marker-buffer marker) (current-buffer)))
8684 (if (and (>= marker beg) (< marker end))
8685 (push (cons marker (- marker beg)) org-markers-to-move))))
8687 (defun org-reinstall-markers-in-region (beg)
8688 "Move all remembered markers to their position relative to BEG."
8690 (move-marker (car x) (+ beg (cdr x))))
8691 org-markers-to-move)
8692 (setq org-markers-to-move nil))
8694 (defun org-narrow-to-subtree ()
8695 "Narrow buffer to the current subtree."
8699 (org-with-limited-levels
8701 (progn (org-back-to-heading t) (point))
8702 (progn (org-end-of-subtree t t)
8703 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8706 (defun org-narrow-to-block ()
8707 "Narrow buffer to the current block."
8709 (let* ((case-fold-search t)
8710 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8711 "^[ \t]*#\\+end_.*")))
8713 (narrow-to-region (car blockp) (cdr blockp))
8714 (user-error "Not in a block"))))
8716 (defun org-clone-subtree-with-time-shift (n &optional shift)
8717 "Clone the task (subtree) at point N times.
8718 The clones will be inserted as siblings.
8720 In interactive use, the user will be prompted for the number of
8721 clones to be produced. If the entry has a timestamp, the user
8722 will also be prompted for a time shift, which may be a repeater
8723 as used in time stamps, for example `+3d'. To disable this,
8724 you can call the function with a universal prefix argument.
8726 When a valid repeater is given and the entry contains any time
8727 stamps, the clones will become a sequence in time, with time
8728 stamps in the subtree shifted for each clone produced. If SHIFT
8729 is nil or the empty string, time stamps will be left alone. The
8730 ID property of the original subtree is removed.
8732 If the original subtree did contain time stamps with a repeater,
8733 the following will happen:
8734 - the repeater will be removed in each clone
8735 - an additional clone will be produced, with the current, unshifted
8736 date(s) in the entry.
8737 - the original entry will be placed *after* all the clones, with
8739 - the start days in the repeater in the original entry will be shifted
8740 to past the last clone.
8741 In this way you can spell out a number of instances of a repeating task,
8742 and still retain the repeater to cover future instances of the task."
8743 (interactive "nNumber of clones to produce: ")
8746 (if (and (not (equal current-prefix-arg '(4)))
8748 (re-search-forward org-ts-regexp-both
8750 (org-end-of-subtree t)
8752 (read-from-minibuffer
8753 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8754 ""))) ;; No time shift
8756 (drawer-re org-drawer-regexp)
8757 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8758 beg end template task idprop
8759 shift-n shift-what doshift nmin nmax)
8760 (if (not (and (integerp n) (> n 0)))
8761 (user-error "Invalid number of replications %s" n))
8762 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8763 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8765 (user-error "Invalid shift specification %s" shift))
8767 (setq shift-n (string-to-number (match-string 1 shift))
8768 shift-what (cdr (assoc (match-string 2 shift)
8769 '(("d" . day) ("w" . week)
8770 ("m" . month) ("y" . year))))))
8771 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8772 (setq nmin 1 nmax n)
8773 (org-back-to-heading t)
8775 (setq idprop (org-entry-get nil "ID"))
8776 (org-end-of-subtree t t)
8777 (or (bolp) (insert "\n"))
8779 (setq template (buffer-substring beg end))
8781 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8782 (delete-region beg end)
8784 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8786 (loop for n from nmin to nmax do
8791 (goto-char (point-min))
8793 (and idprop (if org-clone-delete-id
8794 (org-entry-delete nil "ID")
8795 (org-id-get-create t)))
8797 (while (re-search-forward org-clock-re nil t)
8799 (goto-char (point-min))
8800 (while (re-search-forward drawer-re nil t)
8801 (org-remove-empty-drawer-at (point))))
8802 (goto-char (point-min))
8804 (while (re-search-forward org-ts-regexp-both nil t)
8805 (org-timestamp-change (* n shift-n) shift-what))
8806 (unless (= n n-no-remove)
8807 (goto-char (point-min))
8808 (while (re-search-forward org-ts-regexp nil t)
8810 (goto-char (match-beginning 0))
8811 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8812 (delete-region (match-beginning 1) (match-end 1)))))))
8813 (setq task (buffer-string)))
8819 (defun org-sort (with-case)
8820 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8821 Optional argument WITH-CASE means sort case-sensitively."
8824 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8825 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8827 (org-call-with-arg 'org-sort-entries with-case))))
8829 (defun org-sort-remove-invisible (s)
8830 "Remove invisible links from string S."
8831 (remove-text-properties 0 (length s) org-rm-props s)
8832 (while (string-match org-bracket-link-regexp s)
8833 (setq s (replace-match (if (match-end 2)
8835 (match-string 1 s)) t t s)))
8836 (let ((st (format " %s " s)))
8837 (while (string-match org-emph-re st)
8838 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8839 (setq s (substring st 1 -1)))
8842 (defvar org-priority-regexp) ; defined later in the file
8844 (defvar org-after-sorting-entries-or-items-hook nil
8845 "Hook that is run after a bunch of entries or items have been sorted.
8846 When children are sorted, the cursor is in the parent line when this
8847 hook gets called. When a region or a plain list is sorted, the cursor
8848 will be in the first entry of the sorted region/list.")
8850 (defun org-sort-entries
8851 (&optional with-case sorting-type getkey-func compare-func property)
8852 "Sort entries on a certain level of an outline tree.
8853 If there is an active region, the entries in the region are sorted.
8854 Else, if the cursor is before the first entry, sort the top-level items.
8855 Else, the children of the entry at point are sorted.
8857 Sorting can be alphabetically, numerically, by date/time as given by
8858 a time stamp, by a property, by priority order, or by a custom function.
8860 The command prompts for the sorting type unless it has been given to the
8861 function through the SORTING-TYPE argument, which needs to be a character,
8862 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8863 the precise meaning of each character:
8865 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8866 c By creation time, which is assumed to be the first inactive time stamp
8867 at the beginning of a line.
8868 d By deadline date/time.
8870 n Numerically, by converting the beginning of the entry/item to a number.
8871 o By order of TODO keywords.
8872 p By priority according to the cookie.
8873 r By the value of a property.
8874 s By scheduled date/time.
8875 t By date/time, either the first active time stamp in the entry, or, if
8876 none exist, by the first inactive one.
8878 Capital letters will reverse the sort order.
8880 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8881 called with point at the beginning of the record. It must return either
8882 a string or a number that should serve as the sorting key for that record.
8884 Comparing entries ignores case by default. However, with an optional argument
8885 WITH-CASE, the sorting considers case as well.
8887 Sorting is done against the visible part of the headlines, it ignores hidden
8890 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8892 (let ((case-func (if with-case 'identity 'downcase))
8894 ;; The clock marker is lost when using `sort-subr', let's
8895 ;; store the clocking string.
8896 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8898 (goto-char org-clock-marker)
8899 (looking-back "^.*") (match-string-no-properties 0))))
8900 start beg end stars re re2
8902 ;; Find beginning and end of region to sort
8904 ((org-region-active-p)
8905 ;; we will sort the region
8906 (setq end (region-end)
8908 (goto-char (region-beginning))
8909 (if (not (org-at-heading-p)) (outline-next-heading))
8910 (setq start (point)))
8911 ((or (org-at-heading-p)
8912 (ignore-errors (progn (org-back-to-heading) t)))
8913 ;; we will sort the children of the current headline
8914 (org-back-to-heading)
8916 end (progn (org-end-of-subtree t t)
8917 (or (bolp) (insert "\n"))
8918 (when (>= (org-back-over-empty-lines) 1)
8924 (outline-next-heading))
8926 ;; we will sort the top-level entries in this file
8927 (goto-char (point-min))
8928 (or (org-at-heading-p) (outline-next-heading))
8929 (setq start (point))
8930 (goto-char (point-max))
8931 (beginning-of-line 1)
8932 (when (looking-at ".*?\\S-")
8933 ;; File ends in a non-white line
8936 (setq end (point-max))
8937 (setq what "top-level")
8942 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8944 (looking-at "\\(\\*+\\)")
8945 (setq stars (match-string 1)
8946 re (concat "^" (regexp-quote stars) " +")
8947 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8948 txt (buffer-substring beg end))
8949 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8950 (if (and (not (equal stars "*")) (string-match re2 txt))
8951 (user-error "Region to sort contains a level above the first entry"))
8953 (unless sorting-type
8955 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8956 [t]ime
[s]cheduled [d]eadline [c]reated cloc[k]ing
8957 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8959 (setq sorting-type (read-char-exclusive))
8962 (and (= (downcase sorting-type) ?f)
8964 (org-icompleting-read "Sort using function: "
8965 obarray 'fboundp t nil nil))
8966 (setq getkey-func (intern getkey-func))))
8968 (and (= (downcase sorting-type) ?r)
8971 (org-icompleting-read "Property: "
8972 (mapcar 'list (org-buffer-property-keys t))
8975 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8976 (message "Sorting entries...")
8979 (narrow-to-region start end)
8980 (let ((dcst (downcase sorting-type))
8981 (case-fold-search nil)
8982 (now (current-time)))
8984 (/= dcst sorting-type)
8985 ;; This function moves to the beginning character of the "record" to
8988 (if (re-search-forward re nil t)
8989 (goto-char (match-beginning 0))
8990 (goto-char (point-max))))
8991 ;; This function moves to the last character of the "record" being
8996 (outline-forward-same-level 1)
8998 (goto-char (point-max))))))
8999 ;; This function returns the value that gets sorted against.
9003 (if (looking-at org-complex-heading-regexp)
9004 (string-to-number (org-sort-remove-invisible (match-string 4)))
9007 (if (looking-at org-complex-heading-regexp)
9008 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9011 (or (get-text-property (point) :org-clock-minutes) 0))
9013 (let ((end (save-excursion (outline-next-heading) (point))))
9014 (if (or (re-search-forward org-ts-regexp end t)
9015 (re-search-forward org-ts-regexp-both end t))
9016 (org-time-string-to-seconds (match-string 0))
9017 (org-float-time now))))
9019 (let ((end (save-excursion (outline-next-heading) (point))))
9020 (if (re-search-forward
9021 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9023 (org-time-string-to-seconds (match-string 0))
9024 (org-float-time now))))
9026 (let ((end (save-excursion (outline-next-heading) (point))))
9027 (if (re-search-forward org-scheduled-time-regexp end t)
9028 (org-time-string-to-seconds (match-string 1))
9029 (org-float-time now))))
9031 (let ((end (save-excursion (outline-next-heading) (point))))
9032 (if (re-search-forward org-deadline-time-regexp end t)
9033 (org-time-string-to-seconds (match-string 1))
9034 (org-float-time now))))
9036 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9037 (string-to-char (match-string 2))
9038 org-default-priority))
9040 (or (org-entry-get nil property) ""))
9042 (if (looking-at org-complex-heading-regexp)
9043 (let* ((m (match-string 2))
9044 (s (if (member m org-done-keywords) '- '+)))
9045 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9049 (setq tmp (funcall getkey-func))
9050 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9052 (error "Invalid key function `%s'" getkey-func)))
9053 (t (error "Invalid sorting type `%c'" sorting-type))))
9056 ((= dcst ?a) 'string<)
9057 ((= dcst ?f) compare-func)
9058 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9059 (run-hooks 'org-after-sorting-entries-or-items-hook)
9060 ;; Reset the clock marker if needed
9064 (search-forward cmstr nil t)
9065 (move-marker org-clock-marker (point))))
9066 (message "Sorting entries...done")))
9068 ;;; The orgstruct minor mode
9070 ;; Define a minor mode which can be used in other modes in order to
9071 ;; integrate the org-mode structure editing commands.
9073 ;; This is really a hack, because the org-mode structure commands use
9074 ;; keys which normally belong to the major mode. Here is how it
9075 ;; works: The minor mode defines all the keys necessary to operate the
9076 ;; structure commands, but wraps the commands into a function which
9077 ;; tests if the cursor is currently at a headline or a plain list
9078 ;; item. If that is the case, the structure command is used,
9079 ;; temporarily setting many Org-mode variables like regular
9080 ;; expressions for filling etc. However, when any of those keys is
9081 ;; used at a different location, function uses `key-binding' to look
9082 ;; up if the key has an associated command in another currently active
9083 ;; keymap (minor modes, major mode, global), and executes that
9084 ;; command. There might be problems if any of the keys is otherwise
9085 ;; used as a prefix key.
9087 (defcustom orgstruct-heading-prefix-regexp ""
9088 "Regexp that matches the custom prefix of Org headlines in
9089 orgstruct(++)-mode."
9092 :package-version '(Org . "8.3")
9094 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9096 (defcustom orgstruct-setup-hook nil
9097 "Hook run after orgstruct-mode-map is filled."
9100 :package-version '(Org . "8.0")
9103 (defvar orgstruct-initialized nil)
9105 (defvar org-local-vars nil
9106 "List of local variables, for use by `orgstruct-mode'.")
9109 (define-minor-mode orgstruct-mode
9110 "Toggle the minor mode `orgstruct-mode'.
9111 This mode is for using Org-mode structure commands in other
9112 modes. The following keys behave as if Org-mode were active, if
9113 the cursor is on a headline, or on a plain list item (both as
9114 defined by Org-mode)."
9115 nil " OrgStruct" (make-sparse-keymap)
9116 (funcall (if orgstruct-mode
9117 'add-to-invisibility-spec
9118 'remove-from-invisibility-spec)
9120 (when orgstruct-mode
9121 (org-load-modules-maybe)
9122 (unless orgstruct-initialized
9124 (setq orgstruct-initialized t))))
9127 (defun turn-on-orgstruct ()
9128 "Unconditionally turn on `orgstruct-mode'."
9131 (defvar org-fb-vars nil)
9132 (make-variable-buffer-local 'org-fb-vars)
9133 (defun orgstruct++-mode (&optional arg)
9134 "Toggle `orgstruct-mode', the enhanced version of it.
9135 In addition to setting orgstruct-mode, this also exports all
9136 indentation and autofilling variables from org-mode into the
9137 buffer. It will also recognize item context in multiline items."
9139 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9141 (progn (orgstruct-mode -1)
9143 (org-set-local (car v)
9144 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9147 (setq org-fb-vars nil)
9148 (unless org-local-vars
9149 (setq org-local-vars (org-get-local-variables)))
9154 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9155 (symbol-name (car x)))
9156 (setq var (car x) val (nth 1 x))
9157 (push (list var `(quote ,(eval var))) org-fb-vars)
9158 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9160 (org-set-local 'orgstruct-is-++ t))))
9162 (defvar orgstruct-is-++ nil
9163 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9164 (make-variable-buffer-local 'orgstruct-is-++)
9167 (defun turn-on-orgstruct++ ()
9168 "Unconditionally turn on `orgstruct++-mode'."
9169 (orgstruct++-mode 1))
9171 (defun orgstruct-error ()
9172 "Error when there is no default binding for a structure key."
9174 (funcall (if (fboundp 'user-error)
9177 "This key has no function outside structure elements"))
9179 (defun orgstruct-setup ()
9180 "Setup orgstruct keymap."
9181 (dolist (cell '((org-demote . t)
9185 (org-shiftmetaleft . t)
9186 (org-shiftmetaright . t)
9187 org-backward-element
9188 org-backward-heading-same-level
9193 org-forward-heading-same-level
9195 org-insert-heading-respect-content
9196 org-kill-note-or-show-branches
9201 org-narrow-to-subtree
9216 outline-next-visible-heading
9217 outline-previous-visible-heading
9221 (let ((f (or (car-safe cell) cell))
9222 (disable-when-heading-prefix (cdr-safe cell)))
9224 (let ((new-bindings))
9225 (dolist (binding (nconc (where-is-internal f org-mode-map)
9226 (where-is-internal f outline-mode-map)))
9227 (push binding new-bindings)
9228 ;; TODO use local-function-key-map
9229 (dolist (rep '(("<tab>" . "TAB")
9230 ("<return>" . "RET")
9231 ("<escape>" . "ESC")
9232 ("<delete>" . "DEL")))
9233 (setq binding (read-kbd-macro
9234 (let ((case-fold-search))
9235 (replace-regexp-in-string
9236 (regexp-quote (cdr rep))
9238 (key-description binding)))))
9239 (pushnew binding new-bindings :test 'equal)))
9240 (dolist (binding new-bindings)
9241 (let ((key (lookup-key orgstruct-mode-map binding)))
9242 (when (or (not key) (numberp key))
9244 (org-defkey orgstruct-mode-map
9246 (orgstruct-make-binding
9247 f binding disable-when-heading-prefix))))))))))
9248 (run-hooks 'orgstruct-setup-hook))
9250 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9251 "Create a function for binding in the structure minor mode.
9252 FUN is the command to call inside a table. KEY is the key that
9253 should be checked in for a command to execute outside of tables.
9254 Non-nil `disable-when-heading-prefix' means to disable the command
9255 if `orgstruct-heading-prefix-regexp' is not empty."
9256 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9259 (while (fboundp (intern nname))
9260 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9261 (setq name (intern nname)))
9263 (let ((bindings '((org-heading-regexp
9265 orgstruct-heading-prefix-regexp
9266 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9268 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9269 (org-outline-regexp-bol
9270 (concat "^" org-outline-regexp))
9271 (outline-regexp org-outline-regexp)
9272 (outline-heading-end-regexp "\n")
9273 (outline-level 'org-outline-level)
9274 (outline-heading-alist))))
9276 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9277 "Outside of structure, run the binding of `"
9278 (key-description key) "'."
9279 (when disable-when-heading-prefix
9281 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9282 "back to the default binding due to limitations of Org's implementation of\n"
9283 "`" (symbol-name fun) "'.")))
9286 ,(and disable-when-heading-prefix
9287 '(not (string= orgstruct-heading-prefix-regexp ""))))
9292 (org-context-p 'headline 'item
9294 '(org-insert-heading
9295 org-insert-heading-respect-content
9297 '(when orgstruct-is-++
9300 (let* ((orgstruct-mode)
9307 ("<\\([^>]*\\)tab>" . "\\1TAB")
9308 ("<\\([^>]*\\)return>" . "\\1RET")
9309 ("<\\([^>]*\\)escape>" . "\\1ESC")
9310 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9313 (setq key (read-kbd-macro
9314 (let ((case-fold-search))
9315 (replace-regexp-in-string
9318 (key-description key))))))
9319 (when (key-binding key)
9320 (throw 'exit (key-binding key))))))))
9321 (if (keymapp binding)
9322 (org-set-transient-map binding)
9323 (let ((func (or binding
9325 'orgstruct-error))))
9327 (call-interactively func)))))
9328 (org-run-like-in-org-mode
9332 (call-interactively ',fun)))))))))
9335 (defun org-contextualize-keys (alist contexts)
9336 "Return valid elements in ALIST depending on CONTEXTS.
9338 `org-agenda-custom-commands' or `org-capture-templates' are the
9339 values used for ALIST, and `org-agenda-custom-commands-contexts'
9340 or `org-capture-templates-contexts' are the associated contexts
9343 ;; normalize contexts
9345 (lambda(c) (cond ((listp (cadr c))
9346 (list (car c) (car c) (cadr c)))
9347 ((string= "" (cadr c))
9348 (list (car c) (car c) (caddr c)))
9351 ;; loop over all commands or templates
9352 (while (setq c (pop a))
9355 ((not (assoc (car c) contexts))
9357 ((and (assoc (car c) contexts)
9358 (setq vrules (org-contextualize-validate-key
9361 (when (not (equal (car vr) (cadr vr)))
9362 (setq repl vr))) vrules)
9363 (if (not repl) (push c r)
9364 (push (cadr repl) s)
9367 (cdr (or (assoc (cadr repl) alist)
9368 (error "Undefined key `%s' as contextual replacement for `%s'"
9369 (cadr repl) (car c)))))
9371 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9376 (let ((tpl (car x)))
9380 (equal y tpl)) s))) x)))
9383 (defun org-contextualize-validate-key (key contexts)
9384 "Check CONTEXTS for agenda or capture KEY."
9386 (while (setq r (pop contexts))
9390 (and (equal key (car r))
9391 (if (functionp rr) (funcall rr)
9392 (or (and (eq (car rr) 'in-file)
9394 (string-match (cdr rr) (buffer-file-name)))
9395 (and (eq (car rr) 'in-mode)
9396 (string-match (cdr rr) (symbol-name major-mode)))
9397 (and (eq (car rr) 'in-buffer)
9398 (string-match (cdr rr) (buffer-name)))
9399 (when (and (eq (car rr) 'not-in-file)
9401 (not (string-match (cdr rr) (buffer-file-name))))
9402 (when (eq (car rr) 'not-in-mode)
9403 (not (string-match (cdr rr) (symbol-name major-mode))))
9404 (when (eq (car rr) 'not-in-buffer)
9405 (not (string-match (cdr rr) (buffer-name)))))))
9408 (delete-dups (delq nil res))))
9410 (defun org-context-p (&rest contexts)
9411 "Check if local context is any of CONTEXTS.
9412 Possible values in the list of contexts are `table', `headline', and `item'."
9413 (let ((pos (point)))
9414 (goto-char (point-at-bol))
9415 (prog1 (or (and (memq 'table contexts)
9416 (looking-at "[ \t]*|"))
9417 (and (memq 'headline contexts)
9418 (looking-at org-outline-regexp))
9419 (and (memq 'item contexts)
9420 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9421 (and (memq 'item-body contexts)
9425 (defun org-get-local-variables ()
9426 "Return a list of all local variables in an Org mode buffer."
9428 (with-current-buffer (get-buffer-create "*Org tmp*")
9431 (setq varlist (buffer-local-variables)))
9432 (kill-buffer "*Org tmp*")
9439 (list (car x) (cdr x))))
9440 (if (and (not (get (car x) 'org-state))
9442 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9443 (symbol-name (car x))))
9447 (defun org-clone-local-variables (from-buffer &optional regexp)
9448 "Clone local variables from FROM-BUFFER.
9449 Optional argument REGEXP selects variables to clone."
9452 (and (symbolp (car pair))
9454 (string-match regexp (symbol-name (car pair))))
9455 (set (make-local-variable (car pair))
9457 (buffer-local-variables from-buffer)))
9460 (defun org-run-like-in-org-mode (cmd)
9461 "Run a command, pretending that the current buffer is in Org-mode.
9462 This will temporarily bind local variables that are typically bound in
9463 Org-mode to the values they have in Org-mode, and then interactively
9465 (org-load-modules-maybe)
9466 (unless org-local-vars
9467 (setq org-local-vars (org-get-local-variables)))
9469 (dolist (var org-local-vars)
9470 (when (or (not (boundp (car var)))
9471 (eq (symbol-value (car var))
9472 (default-value (car var))))
9473 (push (list (car var) `(quote ,(cadr var))) binds)))
9475 (call-interactively (quote ,cmd))))))
9477 (defun org-get-category (&optional pos force-refresh)
9478 "Get the category applying to position POS."
9480 (if force-refresh (org-refresh-category-properties))
9481 (let ((pos (or pos (point))))
9482 (or (get-text-property pos 'org-category)
9483 (progn (org-refresh-category-properties)
9484 (get-text-property pos 'org-category))))))
9486 ;;; Refresh properties
9488 (defun org-refresh-properties (dprop tprop)
9489 "Refresh buffer text properties.
9490 DPROP is the drawer property and TPROP is either the
9491 corresponding text property to set, or an alist with each element
9492 being a text property (as a symbol) and a function to apply to
9493 the value of the drawer property."
9494 (let ((case-fold-search t)
9495 (inhibit-read-only t))
9496 (org-with-silent-modifications
9500 (goto-char (point-min))
9501 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9502 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9504 (defun org-refresh-property (tprop p)
9505 "Refresh the buffer text property TPROP from the drawer property P.
9506 The refresh happens only for the current tree (not subtree)."
9507 (unless (org-before-first-heading-p)
9509 (org-back-to-heading t)
9511 ;; TPROP is a text property symbol
9513 (point) (or (outline-next-heading) (point-max)) tprop p)
9514 ;; TPROP is an alist with (properties . function) elements
9518 (line-beginning-position) (or (outline-next-heading) (point-max))
9520 (funcall (cdr al) p))))))))
9522 (defun org-refresh-category-properties ()
9523 "Refresh category text properties in the buffer."
9524 (let ((case-fold-search t)
9525 (inhibit-read-only t)
9527 (cond ((null org-category)
9528 (if buffer-file-name
9529 (file-name-sans-extension
9530 (file-name-nondirectory buffer-file-name))
9532 ((symbolp org-category) (symbol-name org-category))
9534 (org-with-silent-modifications
9535 (org-with-wide-buffer
9536 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9537 ;; This is the default category for the buffer. If none is
9538 ;; found, fall-back to `org-category' or buffer file name.
9540 (point-min) (point-max)
9542 (catch 'buffer-category
9543 (goto-char (point-max))
9544 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9545 (let ((element (org-element-at-point)))
9546 (when (eq (org-element-type element) 'keyword)
9547 (throw 'buffer-category
9548 (org-element-property :value element)))))
9550 ;; Set sub-tree specific categories.
9551 (goto-char (point-min))
9552 (let ((regexp (org-re-property "CATEGORY")))
9553 (while (re-search-forward regexp nil t)
9554 (let ((value (org-match-string-no-properties 3)))
9555 (when (org-at-property-p)
9557 (save-excursion (org-back-to-heading t) (point))
9558 (save-excursion (org-end-of-subtree t t) (point))
9562 (defun org-refresh-stats-properties ()
9563 "Refresh stats text properties in the buffer."
9565 (org-with-silent-modifications
9569 (goto-char (point-min))
9570 (while (re-search-forward
9571 (concat org-outline-regexp-bol ".*"
9572 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9574 (setq stats (cond ((equal (match-string 3) "0") 0)
9576 (/ (* (string-to-number (match-string 2)) 100)
9577 (string-to-number (match-string 3))))
9578 (t (string-to-number (match-string 1)))))
9579 (org-back-to-heading t)
9580 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9581 'org-stats stats)))))))
9583 (defun org-refresh-effort-properties ()
9584 "Refresh effort properties"
9585 (org-refresh-properties
9587 '((effort . identity)
9588 (effort-minutes . org-duration-string-to-minutes))))
9592 ;;; Link abbreviations
9594 (defun org-link-expand-abbrev (link)
9595 "Apply replacements as defined in `org-link-abbrev-alist'."
9596 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9597 (let* ((key (match-string 1 link))
9598 (as (or (assoc key org-link-abbrev-alist-local)
9599 (assoc key org-link-abbrev-alist)))
9600 (tag (and (match-end 2) (match-string 3 link)))
9606 ((symbolp rpl) (funcall rpl tag))
9607 ((string-match "%(\\([^)]+\\))" rpl)
9610 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9611 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9612 ((string-match "%h" rpl)
9613 (replace-match (url-hexify-string (or tag "")) t t rpl))
9614 (t (concat rpl tag)))))
9617 ;;; Storing and inserting links
9619 (defvar org-insert-link-history nil
9620 "Minibuffer history for links inserted with `org-insert-link'.")
9622 (defvar org-stored-links nil
9623 "Contains the links stored with `org-store-link'.")
9625 (defvar org-store-link-plist nil
9626 "Plist with info about the most recently link created with `org-store-link'.")
9628 (defvar org-link-protocols nil
9629 "Link protocols added to Org-mode using `org-add-link-type'.")
9631 (defvar org-store-link-functions nil
9632 "List of functions that are called to create and store a link.
9633 Each function will be called in turn until one returns a non-nil
9634 value. Each function should check if it is responsible for creating
9635 this link (for example by looking at the major mode).
9636 If not, it must exit and return nil.
9637 If yes, it should return a non-nil value after a calling
9638 `org-store-link-props' with a list of properties and values.
9639 Special properties are:
9641 :type The link prefix, like \"http\". This must be given.
9642 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9643 This is obligatory as well.
9644 :description Optional default description for the second pair
9645 of brackets in an Org-mode link. The user can still change
9646 this when inserting this link into an Org-mode buffer.
9648 In addition to these, any additional properties can be specified
9649 and then used in capture templates.")
9651 (defun org-add-link-type (type &optional follow export)
9652 "Add TYPE to the list of `org-link-types'.
9653 Re-compute all regular expressions depending on `org-link-types'
9655 FOLLOW and EXPORT are two functions.
9657 FOLLOW should take the link path as the single argument and do whatever
9658 is necessary to follow the link, for example find a file or display
9661 EXPORT should format the link path for export to one of the export formats.
9662 It should be a function accepting three arguments:
9664 path the path of the link, the text after the prefix (like \"http:\")
9665 desc the description of the link, if any
9666 format the export format, a symbol like `html' or `latex' or `ascii'.
9668 The function may use the FORMAT information to return different values
9669 depending on the format. The return value will be put literally into
9670 the exported file. If the return value is nil, this means Org should
9671 do what it normally does with links which do not have EXPORT defined.
9673 Org mode has a built-in default for exporting links. If you are happy with
9674 this default, there is no need to define an export function for the link
9675 type. For a simple example of an export function, see `org-bbdb.el'."
9676 (add-to-list 'org-link-types type t)
9677 (org-make-link-regexps)
9678 (org-element-update-syntax)
9679 (if (assoc type org-link-protocols)
9680 (setcdr (assoc type org-link-protocols) (list follow export))
9681 (push (list type follow export) org-link-protocols)))
9683 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9684 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9687 (defun org-store-link (arg)
9688 "\\<org-mode-map>Store an org-link to the current location.
9689 This link is added to `org-stored-links' and can later be inserted
9690 into an org-buffer with \\[org-insert-link].
9692 For some link types, a prefix arg is interpreted.
9693 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9694 For file links, arg negates `org-context-in-file-links'.
9696 A double prefix arg force skipping storing functions that are not
9699 A triple prefix arg force storing a link for each line in the
9702 (org-load-modules-maybe)
9703 (if (and (equal arg '(64)) (org-region-active-p))
9705 (let ((end (region-end)))
9706 (goto-char (region-beginning))
9708 (while (< (point-at-eol) end)
9709 (move-end-of-line 1) (activate-mark)
9710 (let (current-prefix-arg)
9711 (call-interactively 'org-store-link))
9712 (move-beginning-of-line 2)
9713 (set-mark (point)))))
9714 (org-with-limited-levels
9715 (setq org-store-link-plist nil)
9716 (let (link cpltxt desc description search
9717 txt custom-id agenda-link sfuns sfunsn)
9720 ;; Store a link using an external link type
9721 ((and (not (equal arg '(16)))
9724 nil (mapcar (lambda (f)
9725 (let (fs) (if (funcall f) (push f fs))))
9726 org-store-link-functions))
9727 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9728 (or (and (cdr sfuns)
9731 "Which function for creating the link? "
9732 sfunsn nil t (car sfunsn)))))
9733 (funcall (caar sfuns)))
9734 (setq link (plist-get org-store-link-plist :link)
9735 desc (or (plist-get org-store-link-plist
9736 :description) link))))
9738 ;; Store a link from a source code buffer.
9739 ((org-src-edit-buffer-p)
9743 (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
9745 (setq link (format "(%s)" (org-match-string-no-properties 1))))
9746 ((org-called-interactively-p 'any)
9748 (while (or (not label)
9749 (org-with-wide-buffer
9750 (goto-char (point-min))
9752 (regexp-quote (format org-coderef-label-format label))
9754 (when label (message "Label exists already") (sit-for 2))
9755 (setq label (read-string "Code line label: " label)))
9757 (setq link (format org-coderef-label-format label))
9758 (let ((gc (- 79 (length link))))
9759 (if (< (current-column) gc) (org-move-to-column gc t)
9762 (setq link (concat "(" label ")") desc nil)))
9763 (t (setq link nil))))
9765 ;; We are in the agenda, link to referenced location
9766 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9767 (let ((m (or (get-text-property (point) 'org-hd-marker)
9768 (get-text-property (point) 'org-marker))))
9770 (org-with-point-at m
9772 (if (org-called-interactively-p 'any)
9773 (call-interactively 'org-store-link)
9774 (org-store-link nil)))))))
9776 ((eq major-mode 'calendar-mode)
9777 (let ((cd (calendar-cursor-to-date)))
9780 (car org-time-stamp-formats)
9782 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9784 (org-store-link-props :type "calendar" :date cd)))
9786 ((eq major-mode 'help-mode)
9787 (setq link (concat "help:" (save-excursion
9788 (goto-char (point-min))
9789 (looking-at "^[^ ]+")
9791 (org-store-link-props :type "help"))
9793 ((eq major-mode 'w3-mode)
9794 (setq cpltxt (if (and (buffer-name)
9795 (not (string-match "Untitled" (buffer-name))))
9798 link (url-view-url t))
9799 (org-store-link-props :type "w3" :url (url-view-url t)))
9801 ((eq major-mode 'image-mode)
9802 (setq cpltxt (concat "file:"
9803 (abbreviate-file-name buffer-file-name))
9805 (org-store-link-props :type "image" :file buffer-file-name))
9807 ;; In dired, store a link to the file of the current line
9808 ((derived-mode-p 'dired-mode)
9809 (let ((file (dired-get-filename nil t)))
9811 (abbreviate-file-name
9812 (expand-file-name (dired-get-filename nil t)))
9813 ;; otherwise, no file so use current directory.
9815 (setq cpltxt (concat "file:" file)
9818 ((setq search (run-hook-with-args-until-success
9819 'org-create-file-search-functions))
9820 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9822 (setq cpltxt (or description link)))
9824 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9825 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9827 ;; Store a link using the target at point
9828 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9831 (abbreviate-file-name
9832 (buffer-file-name (buffer-base-buffer)))
9833 "::" (match-string 1))
9835 ((and (featurep 'org-id)
9836 (or (eq org-id-link-to-org-use-id t)
9837 (and (org-called-interactively-p 'any)
9838 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9839 (and (eq org-id-link-to-org-use-id
9840 'create-if-interactive-and-no-custom-id)
9842 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9843 ;; Store a link using the ID at point
9844 (setq link (condition-case nil
9845 (prog1 (org-id-store-link)
9846 (setq desc (or (plist-get org-store-link-plist
9850 ;; Probably before first headline, link only to file
9852 (abbreviate-file-name
9853 (buffer-file-name (buffer-base-buffer))))))))
9855 ;; Just link to current headline
9856 (setq cpltxt (concat "file:"
9857 (abbreviate-file-name
9858 (buffer-file-name (buffer-base-buffer)))))
9859 ;; Add a context search string
9860 (when (org-xor org-context-in-file-links arg)
9861 (let* ((ee (org-element-at-point))
9862 (et (org-element-type ee))
9863 (ev (plist-get (cadr ee) :value))
9864 (ek (plist-get (cadr ee) :key))
9865 (eok (and (stringp ek) (string-match "name" ek))))
9867 ((org-at-heading-p) nil)
9868 ((and (eq et 'keyword) eok) ev)
9869 ((org-region-active-p)
9870 (buffer-substring (region-beginning) (region-end)))))
9871 (when (or (null txt) (string-match "\\S-" txt))
9875 (org-make-org-heading-search-string txt)
9877 desc (or (and (eq et 'keyword) eok ev)
9878 (nth 4 (ignore-errors (org-heading-components)))
9880 (if (string-match "::\\'" cpltxt)
9881 (setq cpltxt (substring cpltxt 0 -2)))
9882 (setq link cpltxt))))
9884 ((buffer-file-name (buffer-base-buffer))
9885 ;; Just link to this file here.
9886 (setq cpltxt (concat "file:"
9887 (abbreviate-file-name
9888 (buffer-file-name (buffer-base-buffer)))))
9889 ;; Add a context string.
9890 (when (org-xor org-context-in-file-links arg)
9891 (setq txt (if (org-region-active-p)
9892 (buffer-substring (region-beginning) (region-end))
9893 (buffer-substring (point-at-bol) (point-at-eol))))
9894 ;; Only use search option if there is some text.
9895 (when (string-match "\\S-" txt)
9897 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9901 ((org-called-interactively-p 'interactive)
9902 (user-error "No method for storing a link from this buffer"))
9904 (t (setq link nil)))
9906 ;; We're done setting link and desc, clean up
9907 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9908 (setq link (or link cpltxt)
9909 desc (or desc cpltxt))
9910 (cond ((equal desc "NONE") (setq desc nil))
9911 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9912 (let ((d0 (match-string 3 desc))
9913 (p0 (match-string 5 desc)))
9915 (replace-regexp-in-string
9916 org-bracket-link-regexp
9918 (if (equal (length (match-string 0 desc))
9919 (length desc)) "*" "")) desc)))))
9922 (if (not (and (or (org-called-interactively-p 'any)
9923 executing-kbd-macro) link))
9924 (or agenda-link (and link (org-make-link-string link desc)))
9925 (push (list link desc) org-stored-links)
9926 (message "Stored: %s" (or desc link))
9928 (setq link (concat "file:" (abbreviate-file-name
9929 (buffer-file-name)) "::#" custom-id))
9930 (push (list link desc) org-stored-links))
9931 (car org-stored-links))))))
9933 (defun org-store-link-props (&rest plist)
9934 "Store link properties, extract names and addresses."
9936 (when (setq x (plist-get plist :from))
9937 (setq adr (mail-extract-address-components x))
9938 (setq plist (plist-put plist :fromname (car adr)))
9939 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9940 (when (setq x (plist-get plist :to))
9941 (setq adr (mail-extract-address-components x))
9942 (setq plist (plist-put plist :toname (car adr)))
9943 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9944 (let ((from (plist-get plist :from))
9945 (to (plist-get plist :to)))
9946 (when (and from to org-from-is-user-regexp)
9948 (plist-put plist :fromto
9949 (if (string-match org-from-is-user-regexp from)
9951 (concat "from %f"))))))
9952 (setq org-store-link-plist plist))
9954 (defun org-add-link-props (&rest plist)
9955 "Add these properties to the link property list."
9958 (setq key (pop plist) value (pop plist))
9959 (setq org-store-link-plist
9960 (plist-put org-store-link-plist key value)))))
9962 (defun org-email-link-description (&optional fmt)
9963 "Return the description part of an email link.
9964 This takes information from `org-store-link-plist' and formats it
9965 according to FMT (default from `org-email-link-description-format')."
9966 (setq fmt (or fmt org-email-link-description-format))
9967 (let* ((p org-store-link-plist)
9968 (to (plist-get p :toaddress))
9969 (from (plist-get p :fromaddress))
9972 (cons "%c" (plist-get p :fromto))
9973 (cons "%F" (plist-get p :from))
9974 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9975 (cons "%T" (plist-get p :to))
9976 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9977 (cons "%s" (plist-get p :subject))
9978 (cons "%d" (plist-get p :date))
9979 (cons "%m" (plist-get p :message-id)))))
9980 (when (string-match "%c" fmt)
9981 ;; Check if the user wrote this message
9982 (if (and org-from-is-user-regexp from to
9983 (save-match-data (string-match org-from-is-user-regexp from)))
9984 (setq fmt (replace-match "to %t" t t fmt))
9985 (setq fmt (replace-match "from %f" t t fmt))))
9986 (org-replace-escapes fmt table)))
9988 (defun org-make-org-heading-search-string (&optional string)
9989 "Make search string for the current headline or STRING."
9991 (and (derived-mode-p 'org-mode)
9993 (org-back-to-heading t)
9994 (org-element-property :raw-value (org-element-at-point))))))
9995 (lines org-context-in-file-links))
9996 (or string (setq s (concat "*" s))) ; Add * for headlines
9997 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9998 (when (and string (integerp lines) (> lines 0))
9999 (let ((slines (org-split-string s "\n")))
10000 (when (< lines (length slines))
10003 (reverse (nthcdr (- (length slines) lines)
10004 (reverse slines))) "\n")))))
10005 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10007 (defun org-make-link-string (link &optional description)
10008 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10009 (unless (string-match "\\S-" link)
10010 (error "Empty link"))
10011 (when (and description
10012 (stringp description)
10013 (not (string-match "\\S-" description)))
10014 (setq description nil))
10015 (when (stringp description)
10016 ;; Remove brackets from the description, they are fatal.
10017 (while (string-match "\\[" description)
10018 (setq description (replace-match "{" t t description)))
10019 (while (string-match "\\]" description)
10020 (setq description (replace-match "}" t t description))))
10021 (when (equal link description)
10022 ;; No description needed, it is identical
10023 (setq description nil))
10024 (when (and (not description)
10025 (not (string-match (org-image-file-name-regexp) link))
10026 (not (equal link (org-link-escape link))))
10027 (setq description (org-extract-attributes link)))
10029 (cond ((string-match (org-image-file-name-regexp) link) link)
10030 ((string-match org-link-types-re link)
10031 (concat (match-string 1 link)
10032 (org-link-escape (substring link (match-end 1)))))
10033 (t (org-link-escape link))))
10034 (concat "[[" link "]"
10035 (if description (concat "[" description "]") "")
10038 (defconst org-link-escape-chars
10041 "List of characters that should be escaped in a link when stored to Org.
10042 This is the list that is used for internal purposes.")
10044 (defconst org-link-escape-chars-browser
10047 "List of characters to be escaped before handing over to the browser.
10048 If you consider using this constant then you probably want to use
10049 the function `org-link-escape-browser' instead. See there why
10050 this constant is a candidate to be removed once Org drops support
10051 for Emacs 24.1 and 24.2.")
10053 (defun org-link-escape (text &optional table merge)
10054 "Return percent escaped representation of TEXT.
10055 TEXT is a string with the text to escape.
10056 Optional argument TABLE is a list with characters that should be
10057 escaped. When nil, `org-link-escape-chars' is used.
10058 If optional argument MERGE is set, merge TABLE into
10059 `org-link-escape-chars'."
10060 ;; Don't escape chars in internal links
10061 (if (string-match "^\\*[[:alnum:]]+" text)
10065 (mapc (lambda (defchr)
10066 (unless (member defchr table)
10067 (setq table (cons defchr table))))
10068 org-link-escape-chars))
10070 (setq table org-link-escape-chars)))
10073 (if (or (member char table)
10074 (and (or (< char 32) (= char ?\%) (> char 126))
10076 (mapconcat (lambda (sequence-element)
10077 (format "%%%.2X" sequence-element))
10078 (or (encode-coding-char char 'utf-8)
10079 (error "Unable to percent escape character: %s"
10080 (char-to-string char))) "")
10081 (char-to-string char))) text "")))
10083 (defun org-link-escape-browser (text)
10084 "Escape some characters before handing over to the browser.
10085 This function is a candidate to be removed together with the
10086 constant `org-link-escape-chars-browser' once Org drops support
10087 for Emacs 24.1 and 24.2. All calls to this function will have to
10088 be replaced with `url-encode-url' which is available since Emacs
10090 ;; Example with the Org link
10091 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10092 ;; to open the browser with +subject:"Release 8.2" filled into the
10093 ;; query field: In this case the variable TEXT contains the
10094 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10095 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10096 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10097 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10098 (if (fboundp 'url-encode-url)
10099 (url-encode-url text)
10100 (if (org-string-match-p
10101 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10103 (org-link-escape text org-link-escape-chars-browser)
10106 (defun org-link-unescape (str)
10107 "Unhex hexified Unicode strings as returned from the JavaScript function
10108 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10109 (unless (and (null str) (string= "" str))
10110 (let ((pos 0) (case-fold-search t) unhexed)
10111 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10112 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10113 (setq str (replace-match unhexed t t str))
10114 (setq pos (+ pos (length unhexed))))))
10117 (defun org-link-unescape-compound (hex)
10118 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10119 Note: this function also decodes single byte encodings like
10120 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10122 (let* ((bytes (cdr (split-string hex "%")))
10127 (let* ((val (string-to-number (pop bytes) 16))
10131 ((>= val 252) (cons 6 252))
10132 ((>= val 248) (cons 5 248))
10133 ((>= val 240) (cons 4 240))
10134 ((>= val 224) (cons 3 224))
10135 ((>= val 192) (cons 2 192))
10138 (if (>= val 192) (setq eat (car shift-xor)))
10139 (setq val (logxor val (cdr shift-xor)))
10140 (setq sum (+ (lsh sum (car shift-xor)) val))
10141 (if (> eat 0) (setq eat (- eat 1)))
10143 ((= 0 eat) ;multi byte
10144 (setq ret (concat ret (org-char-to-string sum)))
10146 ((not bytes) ; single byte(s)
10147 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10150 (defun org-link-unescape-single-byte-sequence (hex)
10151 "Unhexify hex-encoded single byte character sequences."
10152 (mapconcat (lambda (byte)
10153 (char-to-string (string-to-number byte 16)))
10154 (cdr (split-string hex "%")) ""))
10156 (defun org-xor (a b)
10160 (defun org-fixup-message-id-for-http (s)
10161 "Replace special characters in a message id, so it can be used in an http query."
10162 (when (string-match "%" s)
10163 (setq s (mapconcat (lambda (c)
10166 (char-to-string c)))
10168 (while (string-match "<" s)
10169 (setq s (replace-match "%3C" t t s)))
10170 (while (string-match ">" s)
10171 (setq s (replace-match "%3E" t t s)))
10172 (while (string-match "@" s)
10173 (setq s (replace-match "%40" t t s)))
10176 (defun org-link-prettify (link)
10177 "Return a human-readable representation of LINK.
10178 The car of LINK must be a raw link.
10179 The cdr of LINK must be either a link description or nil."
10180 (let ((desc (or (cadr link) "<no description>")))
10181 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10182 "<" (car link) ">")))
10185 (defun org-insert-link-global ()
10186 "Insert a link like Org-mode does.
10187 This command can be called in any mode to insert a link in Org-mode syntax."
10189 (org-load-modules-maybe)
10190 (org-run-like-in-org-mode 'org-insert-link))
10192 (defun org-insert-all-links (arg &optional pre post)
10193 "Insert all links in `org-stored-links'.
10194 When a universal prefix, do not delete the links from `org-stored-links'.
10195 When `ARG' is a number, insert the last N link(s).
10196 `PRE' and `POST' are optional arguments to define a string to
10197 prepend or to append."
10199 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10200 (links (copy-seq org-stored-links))
10202 (po (or post "\n"))
10204 (if (null org-stored-links)
10205 (message "No link to insert")
10206 (while (and (or (listp arg) (>= arg cnt))
10207 (setq l (if (listp arg)
10209 (pop org-stored-links))))
10210 (setq cnt (1+ cnt))
10212 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10215 (defun org-insert-last-stored-link (arg)
10216 "Insert the last link stored in `org-stored-links'."
10218 (org-insert-all-links arg "" "\n"))
10220 (defun org-link-fontify-links-to-this-file ()
10221 "Fontify links to the current file in `org-stored-links'."
10222 (let ((f (buffer-file-name)) a b)
10223 (setq a (mapcar (lambda(l)
10224 (let ((ll (car l)))
10225 (when (and (string-match "^file:\\(.+\\)::" ll)
10226 (equal f (expand-file-name (match-string 1 ll))))
10229 (when (featurep 'org-id)
10230 (setq b (mapcar (lambda(l)
10231 (let ((ll (car l)))
10232 (when (and (string-match "^id:\\(.+\\)$" ll)
10233 (equal f (expand-file-name
10234 (or (org-id-find-id-file
10235 (match-string 1 ll)) ""))))
10237 org-stored-links)))
10239 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10240 (delq nil (append a b)))))
10242 (defvar org-link-links-in-this-file nil)
10243 (defun org-insert-link (&optional complete-file link-location default-description)
10244 "Insert a link. At the prompt, enter the link.
10246 Completion can be used to insert any of the link protocol prefixes like
10247 http or ftp in use.
10249 The history can be used to select a link previously stored with
10250 `org-store-link'. When the empty string is entered (i.e. if you just
10251 press RET at the prompt), the link defaults to the most recently
10252 stored link. As SPC triggers completion in the minibuffer, you need to
10253 use M-SPC or C-q SPC to force the insertion of a space character.
10255 You will also be prompted for a description, and if one is given, it will
10256 be displayed in the buffer instead of the link.
10258 If there is already a link at point, this command will allow you to edit link
10259 and description parts.
10261 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10262 be selected using completion. The path to the file will be relative to the
10263 current directory if the file is in the current directory or a subdirectory.
10264 Otherwise, the link will be the absolute path as completed in the minibuffer
10265 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10266 option `org-link-file-path-type'.
10268 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10269 the current directory or below.
10271 With three \\[universal-argument] prefixes, negate the meaning of
10272 `org-keep-stored-link-after-insertion'.
10274 If `org-make-link-description-function' is non-nil, this function will be
10275 called with the link target, and the result will be the default
10278 If the LINK-LOCATION parameter is non-nil, this value will be
10279 used as the link location instead of reading one interactively.
10281 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10282 be used as the default description."
10284 (let* ((wcf (current-window-configuration))
10285 (origbuf (current-buffer))
10286 (region (if (org-region-active-p)
10287 (buffer-substring (region-beginning) (region-end))))
10288 (remove (and region (list (region-beginning) (region-end))))
10290 tmphist ; byte-compile incorrectly complains about this
10291 (link link-location)
10292 (abbrevs org-link-abbrev-alist-local)
10293 entry file all-prefixes auto-desc)
10295 (link-location) ; specified by arg, just use it.
10296 ((org-in-regexp org-bracket-link-regexp 1)
10297 ;; We do have a link at point, and we are going to edit it.
10298 (setq remove (list (match-beginning 0) (match-end 0)))
10299 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10300 (setq link (read-string "Link: "
10302 (org-match-string-no-properties 1)))))
10303 ((or (org-in-regexp org-angle-link-re)
10304 (org-in-regexp org-plain-link-re))
10305 ;; Convert to bracket link
10306 (setq remove (list (match-beginning 0) (match-end 0))
10307 link (read-string "Link: "
10308 (org-remove-angle-brackets (match-string 0)))))
10309 ((member complete-file '((4) (16)))
10310 ;; Completing read for file names.
10311 (setq link (org-file-complete-link complete-file)))
10313 ;; Read link, with completion for stored links.
10314 (org-link-fontify-links-to-this-file)
10315 (org-switch-to-buffer-other-window "*Org Links*")
10316 (with-current-buffer "*Org Links*"
10318 (insert "Insert a link.
10319 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10320 (when org-stored-links
10321 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10322 (insert (mapconcat 'org-link-prettify
10323 (reverse org-stored-links) "\n")))
10324 (goto-char (point-min)))
10325 (let ((cw (selected-window)))
10326 (select-window (get-buffer-window "*Org Links*" 'visible))
10327 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10328 (unless (pos-visible-in-window-p (point-max))
10329 (org-fit-window-to-buffer))
10330 (and (window-live-p cw) (select-window cw)))
10331 ;; Fake a link history, containing the stored links.
10332 (setq tmphist (append (mapcar 'car org-stored-links)
10333 org-insert-link-history))
10334 (setq all-prefixes (append (mapcar 'car abbrevs)
10335 (mapcar 'car org-link-abbrev-alist)
10340 (org-completing-read
10343 (mapcar (lambda (x) (concat x ":"))
10345 (mapcar 'car org-stored-links))
10348 (caar org-stored-links)))
10349 (if (not (string-match "\\S-" link))
10350 (user-error "No link selected"))
10352 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10354 (if (or (member link all-prefixes)
10355 (and (equal ":" (substring link -1))
10356 (member (substring link 0 -1) all-prefixes)
10357 (setq link (substring link 0 -1))))
10358 (setq link (with-current-buffer origbuf
10359 (org-link-try-special-completion link)))))
10360 (set-window-configuration wcf)
10361 (kill-buffer "*Org Links*"))
10362 (setq entry (assoc link org-stored-links))
10363 (or entry (push link org-insert-link-history))
10364 (setq desc (or desc (nth 1 entry)))))
10366 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10367 (not org-keep-stored-link-after-insertion))
10368 (setq org-stored-links (delq (assoc link org-stored-links)
10369 org-stored-links)))
10371 (if (and (string-match org-plain-link-re link)
10372 (not (string-match org-ts-regexp link)))
10373 ;; URL-like link, normalize the use of angular brackets.
10374 (setq link (org-remove-angle-brackets link)))
10376 ;; Check if we are linking to the current file with a search
10377 ;; option If yes, simplify the link by using only the search
10379 (when (and buffer-file-name
10380 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10381 (let* ((path (match-string 1 link))
10382 (case-fold-search nil)
10383 (search (match-string 2 link)))
10385 (if (equal (file-truename buffer-file-name) (file-truename path))
10386 ;; We are linking to this same file, with a search option
10387 (setq link search)))))
10389 ;; Check if we can/should use a relative path. If yes, simplify the link
10390 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10391 (let* ((type (match-string 1 link))
10392 (path (match-string 2 link))
10394 (case-fold-search nil))
10396 ((or (eq org-link-file-path-type 'absolute)
10397 (equal complete-file '(16)))
10398 (setq path (abbreviate-file-name (expand-file-name path))))
10399 ((eq org-link-file-path-type 'noabbrev)
10400 (setq path (expand-file-name path)))
10401 ((eq org-link-file-path-type 'relative)
10402 (setq path (file-relative-name path)))
10405 (if (string-match (concat "^" (regexp-quote
10407 (file-name-as-directory
10408 default-directory))))
10409 (expand-file-name path))
10410 ;; We are linking a file with relative path name.
10411 (setq path (substring (expand-file-name path)
10413 (setq path (abbreviate-file-name (expand-file-name path)))))))
10414 (setq link (concat type path))
10415 (if (equal desc origpath)
10416 (setq desc path))))
10418 (if org-make-link-description-function
10420 (or (condition-case nil
10421 (funcall org-make-link-description-function link desc)
10422 (error (progn (message "Can't get link description from `%s'"
10423 (symbol-name org-make-link-description-function))
10425 (read-string "Description: " default-description)))
10426 (if default-description (setq desc default-description)
10427 (setq desc (or (and auto-desc desc)
10428 (read-string "Description: " desc)))))
10430 (unless (string-match "\\S-" desc) (setq desc nil))
10431 (if remove (apply 'delete-region remove))
10432 (insert (org-make-link-string link desc))))
10434 (defun org-link-try-special-completion (type)
10435 "If there is completion support for link type TYPE, offer it."
10436 (let ((fun (intern (concat "org-" type "-complete-link"))))
10437 (if (functionp fun)
10439 (read-string "Link (no completion support): " (concat type ":")))))
10441 (defun org-file-complete-link (&optional arg)
10442 "Create a file link using completion."
10443 (let ((file (org-iread-file-name "File: "))
10444 (pwd (file-name-as-directory (expand-file-name ".")))
10445 (pwd1 (file-name-as-directory (abbreviate-file-name
10446 (expand-file-name ".")))))
10447 (cond ((equal arg '(16))
10449 (abbreviate-file-name (expand-file-name file))))
10451 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10452 (concat "file:" (match-string 1 file)))
10454 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10455 (expand-file-name file))
10457 (match-string 1 (expand-file-name file))))
10458 (t (concat "file:" file)))))
10460 (defun org-iread-file-name (&rest args)
10461 "Read-file-name using `ido-mode' speedup if available.
10462 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10463 See `read-file-name' for a description of parameters."
10464 (org-without-partial-completion
10465 (if (and org-completion-use-ido
10466 (fboundp 'ido-read-file-name)
10467 (org-bound-and-true-p ido-mode)
10468 (listp (nth 1 args)))
10469 (let ((ido-enter-matching-directory nil))
10470 (apply #'ido-read-file-name args))
10471 (apply #'read-file-name args))))
10473 (defun org-completing-read (&rest args)
10474 "Completing-read with SPACE being a normal character."
10475 (let ((enable-recursive-minibuffers t)
10476 (minibuffer-local-completion-map
10477 (copy-keymap minibuffer-local-completion-map)))
10478 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10479 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10480 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10481 (apply 'org-icompleting-read args)))
10483 (defun org-completing-read-no-i (&rest args)
10484 (let (org-completion-use-ido org-completion-use-iswitchb)
10485 (apply 'org-completing-read args)))
10487 (defun org-iswitchb-completing-read (prompt choices &rest args)
10488 "Use iswitch as a completing-read replacement to choose from choices.
10489 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10491 (let* ((iswitchb-use-virtual-buffers nil)
10492 (iswitchb-make-buflist-hook
10494 (setq iswitchb-temp-buflist choices))))
10495 (iswitchb-read-buffer prompt)))
10497 (defun org-icompleting-read (&rest args)
10498 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10499 Should be called like `completing-read'."
10500 (org-without-partial-completion
10501 (if (not (listp (nth 1 args)))
10502 ;; Ido only supports lists as the COLLECTION argument. Use
10503 ;; default completion function when second argument is not
10505 (apply #'completing-read args)
10506 (let ((ido-enter-matching-directory nil))
10507 (apply (cond ((and org-completion-use-ido
10508 (fboundp 'ido-completing-read)
10509 (org-bound-and-true-p ido-mode))
10510 #'ido-completing-read)
10511 ((and org-completion-use-iswitchb
10512 (org-bound-and-true-p iswitchb-mode))
10513 #'org-iswitchb-completing-read)
10514 (t #'completing-read))
10517 (defun org-extract-attributes (s)
10518 "Extract the attributes cookie from a string and set as text property."
10519 (let (a attr (start 0) key value)
10521 (when (string-match "{{\\([^}]+\\)}}$" s)
10522 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10523 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10524 (setq key (match-string 1 a) value (match-string 2 a)
10525 start (match-end 0)
10526 attr (plist-put attr (intern key) value))))
10527 (org-add-props s nil 'org-attr attr))
10530 ;;; Opening/following a link
10532 (defvar org-link-search-failed nil)
10534 (defvar org-open-link-functions nil
10535 "Hook for functions finding a plain text link.
10536 These functions must take a single argument, the link content.
10537 They will be called for links that look like [[link text][description]]
10538 when LINK TEXT does not have a protocol like \"http:\" and does not look
10539 like a filename (e.g. \"./blue.png\").
10541 These functions will be called *before* Org attempts to resolve the
10542 link by doing text searches in the current buffer - so if you want a
10543 link \"[[target]]\" to still find \"<<target>>\", your function should
10544 handle this as a special case.
10546 When the function does handle the link, it must return a non-nil value.
10547 If it decides that it is not responsible for this link, it must return
10548 nil to indicate that that Org-mode can continue with other options
10549 like exact and fuzzy text search.")
10551 (defun org-next-link (&optional search-backward)
10552 "Move forward to the next link.
10553 If the link is in hidden text, expose it."
10555 (when (and org-link-search-failed (eq this-command last-command))
10556 (goto-char (point-min))
10557 (message "Link search wrapped back to beginning of buffer"))
10558 (setq org-link-search-failed nil)
10559 (let* ((pos (point))
10561 (a (assoc :link ct))
10562 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10563 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10564 ((looking-at org-any-link-re)
10565 ;; Don't stay stuck at link without an org-link face
10566 (forward-char (if search-backward -1 1))))
10567 (if (funcall srch-fun org-any-link-re nil t)
10569 (goto-char (match-beginning 0))
10570 (if (outline-invisible-p) (org-show-context)))
10572 (setq org-link-search-failed t)
10573 (message "No further link found"))))
10575 (defun org-previous-link ()
10576 "Move backward to the previous link.
10577 If the link is in hidden text, expose it."
10579 (funcall 'org-next-link t))
10581 (defun org-translate-link (s)
10582 "Translate a link string if a translation function has been defined."
10583 (if (and org-link-translation-function
10584 (fboundp org-link-translation-function)
10585 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10587 (setq s (funcall org-link-translation-function
10588 (match-string 1 s) (match-string 2 s)))
10589 (concat (car s) ":" (cdr s)))
10592 (defun org-translate-link-from-planner (type path)
10593 "Translate a link from Emacs Planner syntax so that Org can follow it.
10594 This is still an experimental function, your mileage may vary."
10596 ((member type '("http" "https" "news" "ftp"))
10597 ;; standard Internet links are the same.
10599 ((and (equal type "irc") (string-match "^//" path))
10600 ;; Planner has two / at the beginning of an irc link, we have 1.
10601 ;; We should have zero, actually....
10602 (setq path (substring path 1)))
10603 ((and (equal type "lisp") (string-match "^/" path))
10604 ;; Planner has a slash, we do not.
10605 (setq type "elisp" path (substring path 1)))
10606 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10607 ;; A typical message link. Planner has the id after the final slash,
10608 ;; we separate it with a hash mark
10609 (setq path (concat (match-string 1 path) "#"
10610 (org-remove-angle-brackets (match-string 2 path))))))
10613 (defun org-find-file-at-mouse (ev)
10614 "Open file link or URL at mouse."
10616 (mouse-set-point ev)
10617 (org-open-at-point 'in-emacs))
10619 (defun org-open-at-mouse (ev)
10620 "Open file link or URL at mouse.
10621 See the docstring of `org-open-file' for details."
10623 (mouse-set-point ev)
10624 (if (eq major-mode 'org-agenda-mode)
10625 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10626 (org-open-at-point))
10628 (defvar org-window-config-before-follow-link nil
10629 "The window configuration before following a link.
10630 This is saved in case the need arises to restore it.")
10632 (defvar org-open-link-marker (make-marker)
10633 "Marker pointing to the location where `org-open-at-point' was called.")
10636 (defun org-open-at-point-global ()
10637 "Follow a link like Org-mode does.
10638 This command can be called in any mode to follow a link that has
10641 (org-run-like-in-org-mode 'org-open-at-point))
10644 (defun org-open-link-from-string (s &optional arg reference-buffer)
10645 "Open a link in the string S, as if it was in Org-mode."
10646 (interactive "sLink: \nP")
10647 (let ((reference-buffer (or reference-buffer (current-buffer))))
10649 (let ((org-inhibit-startup (not reference-buffer)))
10652 (goto-char (point-min))
10653 (when reference-buffer
10654 (setq org-link-abbrev-alist-local
10655 (with-current-buffer reference-buffer
10656 org-link-abbrev-alist-local)))
10657 (org-open-at-point arg reference-buffer)))))
10659 (defvar org-open-at-point-functions nil
10660 "Hook that is run when following a link at point.
10662 Functions in this hook must return t if they identify and follow
10663 a link at point. If they don't find anything interesting at point,
10664 they must return nil.")
10666 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10667 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10668 (defun org-open-at-point (&optional arg reference-buffer)
10669 "Open link, timestamp, footnote or tags at point.
10671 When point is on a link, follow it. Normally, files will be
10672 opened by an appropriate application. If the optional prefix
10673 argument ARG is non-nil, Emacs will visit the file. With
10674 a double prefix argument, try to open outside of Emacs, in the
10675 application the system uses for this file type.
10677 When point is on a timestamp, open the agenda at the day
10680 When point is a footnote definition, move to the first reference
10681 found. If it is on a reference, move to the associated
10684 When point is on a headline, display a list of every link in the
10685 entry, so it is possible to pick one, or all, of them. If point
10686 is on a tag, call `org-tags-view' instead.
10688 When optional argument REFERENCE-BUFFER is non-nil, it should
10689 specify a buffer from where the link search should happen. This
10690 is used internally by `org-open-link-from-string'.
10692 On top of syntactically correct links, this function will open
10693 the link at point in comments or comment blocks and the first
10694 link in a property drawer line."
10696 ;; On a code block, open block's results.
10697 (unless (call-interactively 'org-babel-open-src-block-result)
10698 (org-load-modules-maybe)
10699 (move-marker org-open-link-marker (point))
10700 (setq org-window-config-before-follow-link (current-window-configuration))
10701 (org-remove-occur-highlights nil nil t)
10702 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10704 ;; Only consider supported types, even if they are not
10705 ;; the closest one.
10706 (org-element-lineage
10707 (org-element-context)
10708 '(comment comment-block footnote-definition footnote-reference
10709 headline inlinetask keyword link node-property
10712 (type (org-element-type context))
10713 (value (org-element-property :value context)))
10715 ((not context) (user-error "No link found"))
10716 ;; Exception: open timestamps and links in properties
10717 ;; drawers, keywords and comments.
10718 ((memq type '(comment comment-block keyword node-property))
10719 (cond ((org-in-regexp org-any-link-re)
10720 (org-open-link-from-string (match-string-no-properties 0)))
10721 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10722 (org-follow-timestamp-link))
10723 (t (user-error "No link found"))))
10724 ;; On a headline or an inlinetask, but not on a timestamp,
10725 ;; a link, a footnote reference or on tags.
10726 ((and (memq type '(headline inlinetask))
10728 (progn (save-excursion (beginning-of-line)
10729 (looking-at org-complex-heading-regexp))
10730 (or (not (match-beginning 5))
10731 (< (point) (match-beginning 5)))))
10732 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10734 (links-end (cdr data)))
10736 (dolist (link (if (stringp links) (list links) links))
10737 (search-forward link nil links-end)
10738 (goto-char (match-beginning 0))
10739 (org-open-at-point))
10740 (require 'org-attach)
10741 (org-attach-reveal 'if-exists))))
10742 ;; Do nothing on white spaces after an object, unless point
10743 ;; is right after it.
10746 (goto-char (org-element-property :end context))
10747 (skip-chars-backward " \t")
10749 (user-error "No link found"))
10750 ((eq type 'timestamp) (org-follow-timestamp-link))
10751 ;; On tags within a headline or an inlinetask.
10752 ((and (memq type '(headline inlinetask))
10753 (progn (save-excursion (beginning-of-line)
10754 (looking-at org-complex-heading-regexp))
10755 (and (match-beginning 5)
10756 (>= (point) (match-beginning 5)))))
10757 (org-tags-view arg (substring (match-string 5) 0 -1)))
10759 ;; When link is located within the description of another
10760 ;; link (e.g., an inline image), always open the parent
10762 (let*((link (let ((up (org-element-property :parent context)))
10763 (if (eq (org-element-type up) 'link) up context)))
10764 (type (org-element-property :type link))
10765 (path (org-link-unescape (org-element-property :path link))))
10766 ;; Switch back to REFERENCE-BUFFER needed when called in
10767 ;; a temporary buffer through `org-open-link-from-string'.
10768 (with-current-buffer (or reference-buffer (current-buffer))
10770 ((equal type "file")
10771 (if (string-match "[*?{]" (file-name-nondirectory path))
10773 ;; Look into `org-link-protocols' in order to find
10774 ;; a DEDICATED-FUNCTION to open file. The function
10775 ;; will be applied on raw link instead of parsed
10776 ;; link due to the limitation in `org-add-link-type'
10777 ;; ("open" function called with a single argument).
10778 ;; If no such function is found, fallback to
10779 ;; `org-open-file'.
10781 ;; Note : "file+emacs" and "file+sys" types are
10782 ;; hard-coded in order to escape the previous
10784 (let* ((option (org-element-property :search-option link))
10785 (app (org-element-property :application link))
10786 (dedicated-function
10787 (nth 1 (assoc app org-link-protocols))))
10788 (if dedicated-function
10789 (funcall dedicated-function
10791 (and option (concat "::" option))))
10792 (apply 'org-open-file
10795 ((equal app "emacs") 'emacs)
10796 ((equal app "sys") 'system))
10797 (cond ((not option) nil)
10798 ((org-string-match-p "\\`[0-9]+\\'" option)
10799 (list (string-to-number option)))
10801 (org-link-unescape option)))))))))
10802 ((assoc type org-link-protocols)
10803 (funcall (nth 1 (assoc type org-link-protocols)) path))
10804 ((equal type "help")
10805 (let ((f-or-v (intern path)))
10806 (cond ((fboundp f-or-v) (describe-function f-or-v))
10807 ((boundp f-or-v) (describe-variable f-or-v))
10808 (t (error "Not a known function or variable")))))
10809 ((member type '("http" "https" "ftp" "mailto" "news"))
10810 (browse-url (org-link-escape-browser (concat type ":" path))))
10811 ((equal type "doi")
10813 (org-link-escape-browser (concat org-doi-server-url path))))
10814 ((equal type "message") (browse-url (concat type ":" path)))
10815 ((equal type "shell")
10816 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10818 (if (or (and (org-string-nw-p
10819 org-confirm-shell-link-not-regexp)
10821 org-confirm-shell-link-not-regexp cmd))
10822 (not org-confirm-shell-link-function)
10823 (funcall org-confirm-shell-link-function
10824 (format "Execute \"%s\" in shell? "
10825 (org-add-props cmd nil
10826 'face 'org-warning))))
10828 (message "Executing %s" cmd)
10829 (shell-command cmd buf)
10830 (when (featurep 'midnight)
10831 (setq clean-buffer-list-kill-buffer-names
10832 (cons (buffer-name buf)
10833 clean-buffer-list-kill-buffer-names))))
10834 (user-error "Abort"))))
10835 ((equal type "elisp")
10837 (if (or (and (org-string-nw-p
10838 org-confirm-elisp-link-not-regexp)
10839 (org-string-match-p
10840 org-confirm-elisp-link-not-regexp cmd))
10841 (not org-confirm-elisp-link-function)
10842 (funcall org-confirm-elisp-link-function
10843 (format "Execute \"%s\" as elisp? "
10844 (org-add-props cmd nil
10845 'face 'org-warning))))
10846 (message "%s => %s" cmd
10847 (if (eq (string-to-char cmd) ?\()
10849 (call-interactively (read cmd))))
10850 (user-error "Abort"))))
10853 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10854 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10855 (unless (run-hook-with-args-until-success
10856 'org-open-link-functions path)
10857 (if (not arg) (org-mark-ring-push)
10858 (switch-to-buffer-other-window
10859 (org-get-buffer-for-internal-link (current-buffer))))
10860 (let ((cmd `(org-link-search
10861 ,(if (member type '("custom-id" "coderef"))
10862 (org-element-property :raw-link link)
10864 ,(cond ((equal arg '(4)) 'occur)
10865 ((equal arg '(16)) 'org-occur))
10866 ,(org-element-property :begin link))))
10867 (condition-case nil
10868 (let ((org-link-search-inhibit-query t))
10870 (error (progn (widen) (eval cmd)))))))
10871 (t (browse-url-at-point))))))
10872 ;; On a footnote reference or at a footnote definition's label.
10873 ((or (eq type 'footnote-reference)
10874 (and (eq type 'footnote-definition)
10876 ;; Do not validate action when point is on the
10877 ;; spaces right after the footnote label, in
10878 ;; order to be on par with behaviour on links.
10879 (skip-chars-forward " \t")
10881 (org-element-property :contents-begin context)))
10882 (if begin (< (point) begin)
10883 (= (org-element-property :post-affiliated context)
10884 (line-beginning-position)))))))
10885 (org-footnote-action))
10886 (t (user-error "No link found")))))
10887 (move-marker org-open-link-marker nil)
10888 (run-hook-with-args 'org-follow-link-hook)))
10890 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10891 "Offer links in the current entry and return the selected link.
10892 If there is only one link, return it.
10893 If NTH is an integer, return the NTH link found.
10894 If ZERO is a string, check also this string for a link, and if
10895 there is one, return it."
10896 (with-current-buffer buffer
10902 (in-emacs (if (integerp nth) nil nth))
10903 have-zero end links link c)
10904 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10905 (push (match-string 0 zero) links)
10906 (setq cnt (1- cnt) have-zero t))
10908 (org-back-to-heading t)
10909 (setq end (save-excursion (outline-next-heading) (point)))
10910 (while (re-search-forward org-any-link-re end t)
10911 (push (match-string 0) links))
10912 (setq links (org-uniquify (reverse links))))
10915 (message "No links"))
10916 ((equal (length links) 1)
10917 (setq link (car links)))
10918 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10919 (setq link (nth (if have-zero nth (1- nth)) links)))
10920 (t ; we have to select a link
10922 (save-window-excursion
10923 (delete-other-windows)
10924 (with-output-to-temp-buffer "*Select Link*"
10926 (if (not (string-match org-bracket-link-regexp l))
10927 (princ (format "[%c] %s\n" (incf cnt)
10928 (org-remove-angle-brackets l)))
10930 (princ (format "[%c] %s (%s)\n" (incf cnt)
10931 (match-string 3 l) (match-string 1 l)))
10932 (princ (format "[%c] %s\n" (incf cnt)
10933 (match-string 1 l))))))
10935 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10936 (message "Select link to open, RET to open all:")
10937 (setq c (read-char-exclusive))
10938 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10939 (when (equal c ?q) (user-error "Abort"))
10940 (if (equal c ?\C-m)
10942 (setq nth (- c ?0))
10943 (if have-zero (setq nth (1+ nth)))
10944 (unless (and (integerp nth) (>= (length links) nth))
10945 (user-error "Invalid link selection"))
10946 (setq link (nth (1- nth) links)))))
10947 (cons link end))))))
10949 ;; TODO: These functions are deprecated since `org-open-at-point'
10950 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10951 (defun org-open-file-with-system (path)
10952 "Open file at PATH using the system way of opening it."
10953 (org-open-file path 'system))
10954 (defun org-open-file-with-emacs (path)
10955 "Open file at PATH in Emacs."
10956 (org-open-file path 'emacs))
10961 (defvar org-create-file-search-functions nil
10962 "List of functions to construct the right search string for a file link.
10963 These functions are called in turn with point at the location to
10964 which the link should point.
10966 A function in the hook should first test if it would like to
10967 handle this file type, for example by checking the `major-mode'
10968 or the file extension. If it decides not to handle this file, it
10969 should just return nil to give other functions a chance. If it
10970 does handle the file, it must return the search string to be used
10971 when following the link. The search string will be part of the
10972 file link, given after a double colon, and `org-open-at-point'
10973 will automatically search for it. If special measures must be
10974 taken to make the search successful, another function should be
10975 added to the companion hook `org-execute-file-search-functions',
10978 A function in this hook may also use `setq' to set the variable
10979 `description' to provide a suggestion for the descriptive text to
10980 be used for this link when it gets inserted into an Org-mode
10981 buffer with \\[org-insert-link].")
10983 (defvar org-execute-file-search-functions nil
10984 "List of functions to execute a file search triggered by a link.
10986 Functions added to this hook must accept a single argument, the
10987 search string that was part of the file link, the part after the
10988 double colon. The function must first check if it would like to
10989 handle this search, for example by checking the `major-mode' or
10990 the file extension. If it decides not to handle this search, it
10991 should just return nil to give other functions a chance. If it
10992 does handle the search, it must return a non-nil value to keep
10993 other functions from trying.
10995 Each function can access the current prefix argument through the
10996 variable `current-prefix-arg'. Note that a single prefix is used
10997 to force opening a link in Emacs, so it may be good to only use a
10998 numeric or double prefix to guide the search function.
11000 In case this is needed, a function in this hook can also restore
11001 the window configuration before `org-open-at-point' was called using:
11003 (set-window-configuration org-window-config-before-follow-link)")
11005 (defun org-link-search (s &optional type avoid-pos stealth)
11006 "Search for a link search option.
11007 If S is surrounded by forward slashes, it is interpreted as a
11008 regular expression. In org-mode files, this will create an `org-occur'
11009 sparse tree. In ordinary files, `occur' will be used to list matches.
11010 If the current buffer is in `dired-mode', grep will be used to search
11011 in all files. If AVOID-POS is given, ignore matches near that position.
11013 When optional argument STEALTH is non-nil, do not modify
11014 visibility around point, thus ignoring `org-show-context-detail'
11016 (let ((case-fold-search t)
11017 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
11018 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
11019 (append '(("") (" ") ("\t") ("\n"))
11020 org-emphasis-alist)
11023 words re0 re2 re4_ re4 re5 re2a re2a_ reall)
11025 ;; First check if there are any special search functions
11026 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11027 ;; Now try the builtin stuff
11028 ((and (eq (aref s0 0) ?#)
11030 (let ((match (org-find-property "CUSTOM_ID" (substring s0 1))))
11031 (and match (goto-char match) (setf type 'dedicated)))))
11033 (goto-char (point-min))
11036 (concat "<<" (regexp-quote s0) ">>") nil t)
11037 (setq type 'dedicated
11038 pos (match-beginning 0))))
11039 ;; There is an exact target for this
11042 (goto-char (point-min))
11045 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11046 (setq type 'dedicated pos (match-beginning 0))))
11047 ;; Found an element with a matching #+name affiliated keyword.
11049 ((and (string-match "^(\\(.*\\))$" s0)
11051 (goto-char (point-min))
11054 (concat "[^[]" (regexp-quote
11055 (format org-coderef-label-format
11056 (match-string 1 s0))))
11058 (setq type 'dedicated
11059 pos (1+ (match-beginning 0))))))
11060 ;; There is a coderef target for this
11062 ((string-match "^/\\(.*\\)/$" s)
11063 ;; A regular expression
11065 ((derived-mode-p 'org-mode)
11066 (org-occur (match-string 1 s)))
11067 (t (org-do-occur (match-string 1 s)))))
11068 ((and (derived-mode-p 'org-mode)
11069 (or (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11070 org-link-search-must-match-exact-headline))
11071 ;; Headline search.
11072 (goto-char (point-min))
11074 ((let (case-fold-search)
11076 (let* ((wspace "[ \t]")
11077 (wspaceopt (concat wspace "*"))
11078 (cookie (concat "\\(?:"
11080 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11083 (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)")))
11085 org-outline-regexp-bol
11086 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11087 "\\(?:\\[#.\\][ \t]+\\)?"
11088 "\\(?:" org-comment-string "[ \t]+\\)?"
11090 (mapconcat #'identity
11091 (org-split-string (regexp-quote s))
11094 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11097 ;; OK, found a match
11098 (setq type 'dedicated)
11099 (goto-char (match-beginning 0)))
11100 ((and (not org-link-search-inhibit-query)
11101 (eq org-link-search-must-match-exact-headline 'query-to-create)
11102 (y-or-n-p "No match - create this as a new heading? "))
11103 (goto-char (point-max))
11104 (unless (bolp) (newline))
11105 (org-insert-heading nil t t)
11107 (beginning-of-line 0))
11110 (error "No match"))))
11112 ;; A normal search string
11113 (remove-text-properties
11115 '(face nil mouse-face nil keymap nil fontified nil) s)
11116 ;; Make a series of regular expressions to find a match
11117 (setq words (org-split-string s "[ \n\r\t]+")
11119 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11120 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11122 re2a_ (concat "\\(" (mapconcat 'downcase words
11123 "[ \t\r\n]+") "\\)[ \t\r\n]")
11124 re2a (concat "[ \t\r\n]" re2a_)
11125 re4_ (concat "\\(" (mapconcat 'downcase words
11126 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11127 re4 (concat "[^a-zA-Z_]" re4_)
11129 re5 (concat ".*" re4)
11130 reall (concat "\\(" re0 "\\)\\|\\(" re2 "\\)\\|\\(" re4
11131 "\\)\\|\\(" re5 "\\)"))
11133 ((eq type 'org-occur) (org-occur reall))
11134 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11135 (t (goto-char (point-min))
11137 (if (or (and (org-search-not-self 1 re0 nil t)
11138 (setq type 'dedicated))
11139 (org-search-not-self 1 re2 nil t)
11140 (org-search-not-self 1 re2a nil t)
11141 (org-search-not-self 1 re4 nil t)
11142 (org-search-not-self 1 re5 nil t))
11143 (goto-char (match-beginning 1))
11145 (error "No match"))))))
11146 (and (derived-mode-p 'org-mode)
11148 (org-show-context 'link-search))
11151 (defun org-search-not-self (group &rest args)
11152 "Execute `re-search-forward', but only accept matches that do not
11153 enclose the position of `org-open-link-marker'."
11154 (let ((m org-open-link-marker))
11156 (while (apply 're-search-forward args)
11157 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11158 (goto-char (match-end group))
11159 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11160 (> (match-beginning 0) (marker-position m))
11161 (< (match-end 0) (marker-position m)))
11163 (or (not (org-in-regexp
11164 org-bracket-link-analytic-regexp 1))
11165 (not (match-end 4)) ; no description
11166 (and (<= (match-beginning 4) (point))
11167 (>= (match-end 4) (point))))))
11168 (throw 'exit (point))))))))
11170 (defun org-get-buffer-for-internal-link (buffer)
11171 "Return a buffer to be used for displaying the link target of internal links."
11173 ((not org-display-internal-link-with-indirect-buffer)
11175 ((string-match "(Clone)$" (buffer-name buffer))
11176 (message "Buffer is already a clone, not making another one")
11177 ;; we also do not modify visibility in this case
11179 (t ; make a new indirect buffer for displaying the link
11180 (let* ((bn (buffer-name buffer))
11181 (ibn (concat bn "(Clone)"))
11182 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11183 (with-current-buffer ib (org-overview))
11186 (defun org-do-occur (regexp &optional cleanup)
11187 "Call the Emacs command `occur'.
11188 If CLEANUP is non-nil, remove the printout of the regular expression
11189 in the *Occur* buffer. This is useful if the regex is long and not useful
11193 (let ((cwin (selected-window)) win beg end)
11194 (when (setq win (get-buffer-window "*Occur*"))
11195 (select-window win))
11196 (goto-char (point-min))
11197 (when (re-search-forward "match[a-z]+" nil t)
11198 (setq beg (match-end 0))
11199 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11200 (setq end (1- (match-beginning 0)))))
11201 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11202 (goto-char (point-min))
11203 (select-window cwin))))
11205 ;;; The mark ring for links jumps
11207 (defvar org-mark-ring nil
11208 "Mark ring for positions before jumps in Org-mode.")
11209 (defvar org-mark-ring-last-goto nil
11210 "Last position in the mark ring used to go back.")
11211 ;; Fill and close the ring
11212 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11213 (loop for i from 1 to org-mark-ring-length do
11214 (push (make-marker) org-mark-ring))
11215 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11218 (defun org-mark-ring-push (&optional pos buffer)
11219 "Put the current position or POS into the mark ring and rotate it."
11221 (setq pos (or pos (point)))
11222 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11223 (move-marker (car org-mark-ring)
11225 (or buffer (current-buffer)))
11227 (substitute-command-keys
11228 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11230 (defun org-mark-ring-goto (&optional n)
11231 "Jump to the previous position in the mark ring.
11232 With prefix arg N, jump back that many stored positions. When
11233 called several times in succession, walk through the entire ring.
11234 Org-mode commands jumping to a different position in the current file,
11235 or to another Org-mode file, automatically push the old position
11239 (if (eq last-command this-command)
11240 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11241 (setq p org-mark-ring))
11242 (setq org-mark-ring-last-goto p)
11244 (org-pop-to-buffer-same-window (marker-buffer m))
11246 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11248 (defun org-remove-angle-brackets (s)
11249 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11250 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11252 (defun org-add-angle-brackets (s)
11253 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11254 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11256 (defun org-remove-double-quotes (s)
11257 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11258 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11261 ;;; Following specific links
11263 (defun org-follow-timestamp-link ()
11264 "Open an agenda view for the time-stamp date/range at point."
11266 ((org-at-date-range-p t)
11267 (let ((org-agenda-start-on-weekday)
11268 (t1 (match-string 1))
11269 (t2 (match-string 2)) tt1 tt2)
11270 (setq tt1 (time-to-days (org-time-string-to-time t1))
11271 tt2 (time-to-days (org-time-string-to-time t2)))
11272 (let ((org-agenda-buffer-tmp-name
11273 (format "*Org Agenda(a:%s)"
11274 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11275 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11276 ((org-at-timestamp-p t)
11277 (let ((org-agenda-buffer-tmp-name
11278 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11279 (org-agenda-list nil (time-to-days (org-time-string-to-time
11280 (substring (match-string 1) 0 10)))
11282 (t (error "This should not happen"))))
11285 ;;; Following file links
11286 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11287 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11288 (declare-function mailcap-mime-info
11289 "mailcap" (string &optional request no-decode))
11290 (defvar org-wait nil)
11291 (defun org-open-file (path &optional in-emacs line search)
11292 "Open the file at PATH.
11293 First, this expands any special file name abbreviations. Then the
11294 configuration variable `org-file-apps' is checked if it contains an
11295 entry for this file type, and if yes, the corresponding command is launched.
11297 If no application is found, Emacs simply visits the file.
11299 With optional prefix argument IN-EMACS, Emacs will visit the file.
11300 With a double \\[universal-argument] \\[universal-argument] \
11301 prefix arg, Org tries to avoid opening in Emacs
11302 and to use an external application to visit the file.
11304 Optional LINE specifies a line to go to, optional SEARCH a string
11305 to search for. If LINE or SEARCH is given, the file will be
11306 opened in Emacs, unless an entry from org-file-apps that makes
11307 use of groups in a regexp matches.
11309 If you want to change the way frames are used when following a
11310 link, please customize `org-link-frame-setup'.
11312 If the file does not exist, an error is thrown."
11313 (let* ((file (if (equal path "")
11315 (substitute-in-file-name (expand-file-name path))))
11316 (file-apps (append org-file-apps (org-default-apps)))
11317 (apps (org-remove-if
11318 'org-file-apps-entry-match-against-dlink-p file-apps))
11319 (apps-dlink (org-remove-if-not
11320 'org-file-apps-entry-match-against-dlink-p file-apps))
11321 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11322 (dirp (if remp nil (file-directory-p file)))
11323 (file (if (and dirp org-open-directory-means-index-dot-org)
11324 (concat (file-name-as-directory file) "index.org")
11326 (a-m-a-p (assq 'auto-mode apps))
11327 (dfile (downcase file))
11328 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11329 (link (cond ((and (eq line nil)
11333 (concat file "::" (number-to-string line)))
11335 (concat file "::" search))))
11336 (dlink (downcase link))
11337 (old-buffer (current-buffer))
11339 (old-mode major-mode)
11340 ext cmd link-match-data)
11341 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11342 (setq ext (match-string 1 dfile))
11343 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11344 (setq ext (match-string 1 dfile))))
11346 ((member in-emacs '((16) system))
11347 (setq cmd (cdr (assoc 'system apps))))
11348 (in-emacs (setq cmd 'emacs))
11350 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11351 (and dirp (cdr (assoc 'directory apps)))
11352 ; first, try matching against apps-dlink
11353 ; if we get a match here, store the match data for later
11354 (let ((match (assoc-default dlink apps-dlink
11357 (progn (setq link-match-data (match-data))
11359 (progn (setq in-emacs (or in-emacs line search))
11360 nil))) ; if we have no match in apps-dlink,
11361 ; always open the file in emacs if line or search
11362 ; is given (for backwards compatibility)
11363 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11365 (cdr (assoc ext apps))
11366 (cdr (assoc t apps))))))
11367 (when (eq cmd 'system)
11368 (setq cmd (cdr (assoc 'system apps))))
11369 (when (eq cmd 'default)
11370 (setq cmd (cdr (assoc t apps))))
11371 (when (eq cmd 'mailcap)
11373 (mailcap-parse-mailcaps)
11374 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11375 (command (mailcap-mime-info mime-type)))
11376 (if (stringp command)
11378 (setq cmd 'emacs))))
11379 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11380 (not (file-exists-p file))
11381 (not org-open-non-existing-files))
11382 (user-error "No such file: %s" file))
11384 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11385 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11386 (while (string-match "['\"]%s['\"]" cmd)
11387 (setq cmd (replace-match "%s" t t cmd)))
11388 (while (string-match "%s" cmd)
11389 (setq cmd (replace-match
11391 (shell-quote-argument
11392 (convert-standard-filename file)))
11395 ;; Replace "%1", "%2" etc. in command with group matches from regex
11397 (let ((match-index 1)
11398 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11399 (set-match-data link-match-data)
11400 (while (<= match-index number-of-groups)
11401 (let ((regex (concat "%" (number-to-string match-index)))
11402 (replace-with (match-string match-index dlink)))
11403 (while (string-match regex cmd)
11404 (setq cmd (replace-match replace-with t t cmd))))
11405 (setq match-index (+ match-index 1)))))
11407 (save-window-excursion
11408 (message "Running %s...done" cmd)
11409 (start-process-shell-command cmd nil cmd)
11410 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11413 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11415 (if line (progn (org-goto-line line)
11416 (if (derived-mode-p 'org-mode)
11418 (if search (org-link-search search))))
11420 (let ((file (convert-standard-filename file)))
11422 (set-match-data link-match-data)
11424 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11425 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11426 (or (not (equal old-buffer (current-buffer)))
11427 (not (equal old-pos (point))))
11428 (org-mark-ring-push old-pos old-buffer))))
11430 (defun org-file-apps-entry-match-against-dlink-p (entry)
11431 "This function returns non-nil if `entry' uses a regular
11432 expression which should be matched against the whole link by
11435 It assumes that is the case when the entry uses a regular
11436 expression which has at least one grouping construct and the
11437 action is either a lisp form or a command string containing
11438 '%1', i.e. using at least one subexpression match as a
11440 (let ((selector (car entry))
11441 (action (cdr entry)))
11442 (if (stringp selector)
11443 (and (> (regexp-opt-depth selector) 0)
11444 (or (and (stringp action)
11445 (string-match "%[0-9]" action))
11449 (defun org-default-apps ()
11450 "Return the default applications for this operating system."
11452 ((eq system-type 'darwin)
11453 org-file-apps-defaults-macosx)
11454 ((eq system-type 'windows-nt)
11455 org-file-apps-defaults-windowsnt)
11456 (t org-file-apps-defaults-gnu)))
11458 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11459 "Convert extensions to regular expressions in the cars of LIST.
11460 Also, weed out any non-string entries, because the return value is used
11461 only for regexp matching.
11462 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11463 point to the symbol `emacs', indicating that the file should
11464 be opened in Emacs."
11467 (mapcar (lambda (x)
11468 (if (not (stringp (car x)))
11470 (if (string-match "\\W" (car x))
11472 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11475 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11477 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11478 (defun org-file-remote-p (file)
11479 "Test whether FILE specifies a location on a remote system.
11480 Return non-nil if the location is indeed remote.
11482 For example, the filename \"/user@host:/foo\" specifies a location
11483 on the system \"/user@host:\"."
11484 (cond ((fboundp 'file-remote-p)
11485 (file-remote-p file))
11486 ((fboundp 'tramp-handle-file-remote-p)
11487 (tramp-handle-file-remote-p file))
11488 ((and (boundp 'ange-ftp-name-format)
11489 (string-match (car ange-ftp-name-format) file))
11495 (defun org-get-org-file ()
11496 "Read a filename, with default directory `org-directory'."
11497 (let ((default (or org-default-notes-file remember-data-file)))
11498 (read-file-name (format "File name [%s]: " default)
11499 (file-name-as-directory org-directory)
11502 (defun org-notes-order-reversed-p ()
11503 "Check if the current file should receive notes in reversed order."
11505 ((not org-reverse-note-order) nil)
11506 ((eq t org-reverse-note-order) t)
11507 ((not (listp org-reverse-note-order)) nil)
11509 (let ((all org-reverse-note-order)
11511 (while (setq entry (pop all))
11512 (if (string-match (car entry) buffer-file-name)
11513 (throw 'exit (cdr entry))))
11516 (defvar org-refile-target-table nil
11517 "The list of refile targets, created by `org-refile'.")
11519 (defvar org-agenda-new-buffers nil
11520 "Buffers created to visit agenda files.")
11522 (defvar org-refile-cache nil
11523 "Cache for refile targets.")
11525 (defvar org-refile-markers nil
11526 "All the markers used for caching refile locations.")
11528 (defun org-refile-marker (pos)
11529 "Get a new refile marker, but only if caching is in use."
11530 (if (not org-refile-use-cache)
11532 (let ((m (make-marker)))
11533 (move-marker m pos)
11534 (push m org-refile-markers)
11537 (defun org-refile-cache-clear ()
11538 "Clear the refile cache and disable all the markers."
11539 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11540 (setq org-refile-markers nil)
11541 (setq org-refile-cache nil)
11542 (message "Refile cache has been cleared"))
11544 (defun org-refile-cache-check-set (set)
11545 "Check if all the markers in the cache still have live buffers."
11548 (while (and set (setq marker (nth 3 (pop set))))
11549 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11550 (when (and marker (null (marker-buffer marker)))
11551 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11553 (throw 'exit nil)))
11556 (defun org-refile-cache-put (set &rest identifiers)
11557 "Push the refile targets SET into the cache, under IDENTIFIERS."
11558 (let* ((key (sha1 (prin1-to-string identifiers)))
11559 (entry (assoc key org-refile-cache)))
11562 (push (cons key set) org-refile-cache))))
11564 (defun org-refile-cache-get (&rest identifiers)
11565 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11567 ((not org-refile-cache) nil)
11568 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11570 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11571 org-refile-cache))))
11572 (and set (org-refile-cache-check-set set) set)))))
11574 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11575 "Produce a table with refile targets."
11576 (let ((case-fold-search nil)
11577 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11578 (entries (or org-refile-targets '((nil . (:level . 1)))))
11579 targets tgs txt re files f desc descre fast-path-p level pos0)
11580 (message "Getting targets...")
11581 (with-current-buffer (or default-buffer (current-buffer))
11582 (while (setq entry (pop entries))
11583 (setq files (car entry) desc (cdr entry))
11584 (setq fast-path-p nil)
11586 ((null files) (setq files (list (current-buffer))))
11587 ((eq files 'org-agenda-files)
11588 (setq files (org-agenda-files 'unrestricted)))
11589 ((and (symbolp files) (fboundp files))
11590 (setq files (funcall files)))
11591 ((and (symbolp files) (boundp files))
11592 (setq files (symbol-value files))))
11593 (if (stringp files) (setq files (list files)))
11595 ((eq (car desc) :tag)
11596 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11597 ((eq (car desc) :todo)
11598 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11599 ((eq (car desc) :regexp)
11600 (setq descre (cdr desc)))
11601 ((eq (car desc) :level)
11602 (setq descre (concat "^\\*\\{" (number-to-string
11603 (if org-odd-levels-only
11604 (1- (* 2 (cdr desc)))
11607 ((eq (car desc) :maxlevel)
11608 (setq fast-path-p t)
11609 (setq descre (concat "^\\*\\{1," (number-to-string
11610 (if org-odd-levels-only
11611 (1- (* 2 (cdr desc)))
11614 (t (error "Bad refiling target description %s" desc)))
11615 (while (setq f (pop files))
11616 (with-current-buffer
11617 (if (bufferp f) f (org-get-agenda-file-buffer f))
11619 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11621 (if (bufferp f) (setq f (buffer-file-name
11622 (buffer-base-buffer f))))
11623 (setq f (and f (expand-file-name f)))
11624 (if (eq org-refile-use-outline-path 'file)
11625 (push (list (file-name-nondirectory f) f nil nil) tgs))
11629 (goto-char (point-min))
11630 (while (re-search-forward descre nil t)
11631 (goto-char (setq pos0 (point-at-bol)))
11633 (when org-refile-target-verify-function
11635 (or (funcall org-refile-target-verify-function)
11637 (when (and (looking-at org-complex-heading-regexp)
11638 (not (member (match-string 4) excluded-entries))
11640 (setq level (org-reduced-level
11641 (- (match-end 1) (match-beginning 1)))
11642 txt (org-link-display-format (match-string 4))
11643 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11644 re (format org-complex-heading-regexp-format
11645 (regexp-quote (match-string 4))))
11646 (when org-refile-use-outline-path
11647 (setq txt (mapconcat
11650 (if (eq org-refile-use-outline-path
11652 (list (file-name-nondirectory
11654 (buffer-base-buffer))))
11655 (if (eq org-refile-use-outline-path
11657 (list (buffer-file-name
11658 (buffer-base-buffer)))))
11659 (org-get-outline-path fast-path-p
11663 (push (list txt f re (org-refile-marker (point)))
11665 (when (= (point) pos0)
11666 ;; verification function has not moved point
11667 (goto-char (point-at-eol))))))))
11668 (when org-refile-use-cache
11669 (org-refile-cache-put tgs (buffer-file-name) descre))
11670 (setq targets (append tgs targets))))))
11671 (message "Getting targets...done")
11672 (nreverse targets)))
11674 (defun org-protect-slash (s)
11675 (while (string-match "/" s)
11676 (setq s (replace-match "\\" t t s)))
11679 (defvar org-olpa (make-vector 20 nil))
11681 (defun org-get-outline-path (&optional fastp level heading)
11682 "Return the outline path to the current entry, as a list.
11684 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11685 routine which makes outline path derivations for an entire file,
11686 avoiding backtracing. Refile target collection makes use of that."
11690 (error "Outline path failure, more than 19 levels"))
11691 (loop for i from level upto 19 do
11692 (aset org-olpa i nil))
11694 (delq nil (append org-olpa nil))
11695 (aset org-olpa level heading)))
11696 (let (rtn case-fold-search)
11700 (while (org-up-heading-safe)
11701 (when (looking-at org-complex-heading-regexp)
11703 (replace-regexp-in-string
11704 ;; Remove statistical/checkboxes cookies
11705 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11706 (org-match-string-no-properties 4)))
11710 (defun org-format-outline-path (path &optional width prefix separator)
11711 "Format the outline path PATH for display.
11712 WIDTH is the maximum number of characters that is available.
11713 PREFIX is a prefix to be included in the returned string,
11714 such as the file name.
11715 SEPARATOR is inserted between the different parts of the path,
11716 the default is \"/\"."
11717 (setq width (or width 79))
11718 (if prefix (setq width (- width (length prefix))))
11721 (let* ((nsteps (length path))
11722 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11723 (maxwidth (if (<= total-width width)
11724 10000 ;; everything fits
11725 ;; we need to shorten the level headings
11726 (/ (- width nsteps) nsteps)))
11727 (org-odd-levels-only nil)
11729 (total (1+ (length prefix))))
11730 (setq maxwidth (max maxwidth 10))
11732 (if prefix (or separator "/"))
11736 (if (and (= n nsteps) (< maxwidth 10000))
11737 (setq maxwidth (- total-width total)))
11738 (if (< (length h) maxwidth)
11739 (progn (setq total (+ total (length h) 1)) h)
11740 (setq h (substring h 0 (- maxwidth 2))
11741 total (+ total maxwidth 1))
11742 (if (string-match "[ \t]+\\'" h)
11743 (setq h (substring h 0 (match-beginning 0))))
11744 (setq h (concat h "..")))
11745 (org-add-props h nil 'face
11746 (nth (% (1- n) org-n-level-faces)
11749 path (or separator "/"))))))
11751 (defun org-display-outline-path (&optional file current separator just-return-string)
11752 "Display the current outline path in the echo area.
11754 If FILE is non-nil, prepend the output with the file name.
11755 If CURRENT is non-nil, append the current heading to the output.
11756 SEPARATOR is passed through to `org-format-outline-path'. It separates
11757 the different parts of the path and defaults to \"/\".
11758 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11760 (let* (case-fold-search
11761 (bfn (buffer-file-name (buffer-base-buffer)))
11762 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11764 (if current (setq path (append path
11766 (org-back-to-heading t)
11767 (if (looking-at org-complex-heading-regexp)
11768 (list (match-string 4)))))))
11770 (org-format-outline-path
11773 (and file bfn (concat (file-name-nondirectory bfn) separator))
11775 (if just-return-string
11776 (org-no-properties res)
11777 (org-unlogged-message "%s" res))))
11779 (defvar org-refile-history nil
11780 "History for refiling operations.")
11782 (defvar org-after-refile-insert-hook nil
11783 "Hook run after `org-refile' has inserted its stuff at the new location.
11784 Note that this is still *before* the stuff will be removed from
11785 the *old* location.")
11787 (defvar org-capture-last-stored-marker)
11788 (defvar org-refile-keep nil
11789 "Non-nil means `org-refile' will copy instead of refile.")
11792 "Like `org-refile', but copy."
11794 (let ((org-refile-keep t))
11795 (funcall 'org-refile nil nil nil "Copy")))
11797 (defun org-refile (&optional arg default-buffer rfloc msg)
11798 "Move the entry or entries at point to another heading.
11799 The list of target headings is compiled using the information in
11800 `org-refile-targets', which see.
11802 At the target location, the entry is filed as a subitem of the
11803 target heading. Depending on `org-reverse-note-order', the new
11804 subitem will either be the first or the last subitem.
11806 If there is an active region, all entries in that region will be
11807 refiled. However, the region must fulfill the requirement that
11808 the first heading sets the top-level of the moved text.
11810 With prefix arg ARG, the command will only visit the target
11811 location and not actually move anything.
11813 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11814 refiling operation has put the subtree.
11816 With a numeric prefix argument of `2', refile to the running clock.
11818 With a numeric prefix argument of `3', emulate `org-refile-keep'
11819 being set to `t' and copy to the target location, don't move it.
11820 Beware that keeping refiled entries may result in duplicated ID
11823 RFLOC can be a refile location obtained in a different way.
11825 MSG is a string to replace \"Refile\" in the default prompt with
11826 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11828 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11830 If you are using target caching (see `org-refile-use-cache'), you
11831 have to clear the target cache in order to find new targets.
11832 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11833 prefix argument (`C-u C-u C-u C-c C-w')."
11835 (if (member arg '(0 (64)))
11836 (org-refile-cache-clear)
11837 (let* ((actionmsg (cond (msg msg)
11838 ((equal arg 3) "Refile (and keep)")
11840 (cbuf (current-buffer))
11841 (regionp (org-region-active-p))
11842 (region-start (and regionp (region-beginning)))
11843 (region-end (and regionp (region-end)))
11844 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11845 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11846 pos it nbuf file re level reversed)
11847 (setq last-command nil)
11849 (goto-char region-start)
11850 (or (bolp) (goto-char (point-at-bol)))
11851 (setq region-start (point))
11852 (unless (or (org-kill-is-subtree-p
11853 (buffer-substring region-start region-end))
11854 (prog1 org-refile-active-region-within-subtree
11855 (let ((s (point-at-eol)))
11856 (org-toggle-heading)
11857 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11858 (user-error "The region is not a (sequence of) subtree(s)")))
11859 (if (equal arg '(16))
11860 (org-refile-goto-last-stored)
11863 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11865 (setq it (list (or org-clock-heading "running clock")
11867 (marker-buffer org-clock-hd-marker))
11869 (marker-position org-clock-hd-marker)))
11872 (let (heading-text)
11874 (unless (and arg (listp arg))
11875 (org-back-to-heading t)
11877 (replace-regexp-in-string
11878 org-bracket-link-regexp
11880 (nth 4 (org-heading-components)))))
11881 (org-refile-get-location
11882 (cond ((and arg (listp arg)) "Goto")
11883 (regionp (concat actionmsg " region to"))
11884 (t (concat actionmsg " subtree \""
11885 heading-text "\" to")))
11887 (and (not (equal '(4) arg))
11888 org-refile-allow-creating-parent-nodes)
11890 (setq file (nth 1 it)
11895 (equal (buffer-file-name) file)
11897 (and (>= pos region-start)
11898 (<= pos region-end))
11899 (and (>= pos (point))
11900 (< pos (save-excursion
11901 (org-end-of-subtree t t))))))
11902 (error "Cannot refile to position inside the tree or region"))
11903 (setq nbuf (or (find-buffer-visiting file)
11904 (find-file-noselect file)))
11905 (if (and arg (not (equal arg 3)))
11907 (org-pop-to-buffer-same-window nbuf)
11909 (org-show-context 'org-goto))
11912 (org-kill-new (buffer-substring region-start region-end))
11913 (org-save-markers-in-region region-start region-end))
11914 (org-copy-subtree 1 nil t))
11915 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11916 (find-file-noselect file)))
11917 (setq reversed (org-notes-order-reversed-p))
11924 (looking-at org-outline-regexp)
11925 (setq level (org-get-valid-level (funcall outline-level) 1))
11928 (or (outline-next-heading) (point-max))
11929 (or (save-excursion (org-get-next-sibling))
11930 (org-end-of-subtree t t)
11934 (goto-char (point-max))
11935 (goto-char (point-min))
11936 (or (outline-next-heading) (goto-char (point-max)))))
11937 (if (not (bolp)) (newline))
11938 (org-paste-subtree level nil nil t)
11939 (when org-log-refile
11940 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11941 (unless (eq org-log-refile 'note)
11942 (save-excursion (org-add-log-note))))
11943 (and org-auto-align-tags
11944 (let ((org-loop-over-headlines-in-active-region nil))
11945 (org-set-tags nil t)))
11946 (let ((bookmark-name (plist-get org-bookmark-names-plist
11948 (when bookmark-name
11949 (with-demoted-errors
11950 (bookmark-set bookmark-name))))
11951 ;; If we are refiling for capture, make sure that the
11952 ;; last-capture pointers point here
11953 (when (org-bound-and-true-p org-refile-for-capture)
11954 (let ((bookmark-name (plist-get org-bookmark-names-plist
11955 :last-capture-marker)))
11956 (when bookmark-name
11957 (with-demoted-errors
11958 (bookmark-set bookmark-name))))
11959 (move-marker org-capture-last-stored-marker (point)))
11960 (if (fboundp 'deactivate-mark) (deactivate-mark))
11961 (run-hooks 'org-after-refile-insert-hook))))
11962 (unless org-refile-keep
11964 (delete-region (point) (+ (point) (- region-end region-start)))
11966 (and (org-back-to-heading t) (point))
11967 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11968 (when (featurep 'org-inlinetask)
11969 (org-inlinetask-remove-END-maybe))
11970 (setq org-markers-to-move nil)
11971 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11973 (defun org-refile-goto-last-stored ()
11974 "Go to the location where the last refile was stored."
11976 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11977 (message "This is the location of the last refile"))
11979 (defun org-refile--get-location (refloc tbl)
11980 "When user refile to REFLOC, find the associated target in TBL.
11981 Also check `org-refile-target-table'."
11985 (lambda (r) (or (assoc r tbl)
11986 (assoc r org-refile-target-table)))
11987 (list (replace-regexp-in-string "/$" "" refloc)
11988 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11990 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11992 "Prompt the user for a refile location, using PROMPT.
11993 PROMPT should not be suffixed with a colon and a space, because
11994 this function appends the default value from
11995 `org-refile-history' automatically, if that is not empty.
11996 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11997 this is used for the GOTO interface."
11998 (let ((org-refile-targets org-refile-targets)
11999 (org-refile-use-outline-path org-refile-use-outline-path)
12001 (when (and (derived-mode-p 'org-mode)
12002 (not org-refile-use-cache)
12006 (setq excluded-entries
12007 (append excluded-entries (list (org-get-heading t t)))))))
12008 (setq org-refile-target-table
12009 (org-refile-get-targets default-buffer excluded-entries)))
12010 (unless org-refile-target-table
12011 (user-error "No refile targets"))
12012 (let* ((cbuf (current-buffer))
12013 (partial-completion-mode nil)
12014 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12015 (cfunc (if (and org-refile-use-outline-path
12016 org-outline-path-complete-in-steps)
12017 'org-olpath-completing-read
12018 'org-icompleting-read))
12019 (extra (if org-refile-use-outline-path "/" ""))
12020 (cbnex (concat (buffer-name) extra))
12021 (filename (and cfn (expand-file-name cfn)))
12024 (if (and (not (member org-refile-use-outline-path
12025 '(file full-file-path)))
12026 (not (equal filename (nth 1 x))))
12027 (cons (concat (car x) extra " ("
12028 (file-name-nondirectory (nth 1 x)) ")")
12030 (cons (concat (car x) extra) (cdr x))))
12031 org-refile-target-table))
12032 (completion-ignore-case t)
12034 (prompt (concat prompt
12035 (or (and (car org-refile-history)
12036 (concat " (default " (car org-refile-history) ")"))
12037 (and (assoc cbnex tbl) (setq cdef cbnex)
12038 (concat " (default " cbnex ")"))) ": "))
12039 pa answ parent-target child parent old-hist)
12040 (setq old-hist org-refile-history)
12041 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12042 nil 'org-refile-history (or cdef (car org-refile-history))))
12043 (if (setq pa (org-refile--get-location answ tbl))
12045 (org-refile-check-position pa)
12046 (when (or (not org-refile-history)
12047 (not (eq old-hist org-refile-history))
12048 (not (equal (car pa) (car org-refile-history))))
12049 (setq org-refile-history
12050 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12052 (cdr org-refile-history))))
12053 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12054 (pop org-refile-history)))
12056 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12058 (setq parent (match-string 1 answ)
12059 child (match-string 2 answ))
12060 (setq parent-target (org-refile--get-location parent tbl))
12061 (when (and parent-target
12062 (or (eq new-nodes t)
12063 (and (eq new-nodes 'confirm)
12064 (y-or-n-p (format "Create new node \"%s\"? "
12066 (org-refile-new-child parent-target child)))
12067 (user-error "Invalid target location")))))
12069 (declare-function org-string-nw-p "org-macs" (s))
12070 (defun org-refile-check-position (refile-pointer)
12071 "Check if the refile pointer matches the headline to which it points."
12072 (let* ((file (nth 1 refile-pointer))
12073 (re (nth 2 refile-pointer))
12074 (pos (nth 3 refile-pointer))
12076 (if (and (not (markerp pos)) (not file))
12077 (user-error "Please indicate a target file in the refile path")
12078 (when (org-string-nw-p re)
12079 (setq buffer (if (markerp pos)
12080 (marker-buffer pos)
12081 (or (find-buffer-visiting file)
12082 (find-file-noselect file))))
12083 (with-current-buffer buffer
12088 (beginning-of-line 1)
12089 (unless (org-looking-at-p re)
12090 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12092 (defun org-refile-new-child (parent-target child)
12093 "Use refile target PARENT-TARGET to add new CHILD below it."
12094 (unless parent-target
12095 (error "Cannot find parent for new node"))
12096 (let ((file (nth 1 parent-target))
12097 (pos (nth 3 parent-target))
12099 (with-current-buffer (or (find-buffer-visiting file)
12100 (find-file-noselect file))
12106 (goto-char (point-max))
12107 (if (not (bolp)) (newline)))
12108 (when (looking-at org-outline-regexp)
12109 (setq level (funcall outline-level))
12110 (org-end-of-subtree t t))
12111 (org-back-over-empty-lines)
12112 (insert "\n" (make-string
12113 (if pos (org-get-valid-level level 1) 1) ?*)
12115 (beginning-of-line 0)
12116 (list (concat (car parent-target) "/" child) file "" (point)))))))
12118 (defun org-olpath-completing-read (prompt collection &rest args)
12119 "Read an outline path like a file name."
12120 (let ((thetable collection)
12121 (org-completion-use-ido nil) ; does not work with ido.
12122 (org-completion-use-iswitchb nil)) ; or iswitchb
12123 (apply #'org-icompleting-read
12125 (lambda (string predicate &optional flag)
12127 ((eq flag nil) (try-completion string thetable))
12129 (let ((l (length string)))
12130 (mapcar (lambda (x)
12131 (let ((r (substring x l))
12132 (f (if (string-match " ([^)]*)$" x)
12135 (if (string-match "/" r)
12136 (concat string (substring r 0 (match-end 0)) f)
12138 (all-completions string thetable predicate))))
12140 ((eq flag 'lambda) (assoc string thetable))))
12143 ;;;; Dynamic blocks
12145 (defun org-find-dblock (name)
12146 "Find the first dynamic block with name NAME in the buffer.
12147 If not found, stay at current position and return nil."
12148 (let ((case-fold-search t) pos)
12150 (goto-char (point-min))
12151 (setq pos (and (re-search-forward
12152 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12153 (match-beginning 0))))
12154 (if pos (goto-char pos))
12157 (defun org-create-dblock (plist)
12158 "Create a dynamic block section, with parameters taken from PLIST.
12159 PLIST must contain a :name entry which is used as the name of the block."
12160 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12163 (let ((col (current-column))
12164 (name (plist-get plist :name)))
12165 (insert "#+BEGIN: " name)
12167 (if (eq (car plist) :name)
12168 (setq plist (cddr plist))
12169 (insert " " (prin1-to-string (pop plist)))))
12170 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12171 (beginning-of-line -2)))
12173 (defun org-prepare-dblock ()
12174 "Prepare dynamic block for refresh.
12175 This empties the block, puts the cursor at the insert position and returns
12176 the property list including an extra property :name with the block name."
12177 (unless (looking-at org-dblock-start-re)
12178 (user-error "Not at a dynamic block"))
12179 (let* ((begdel (1+ (match-end 0)))
12180 (name (org-no-properties (match-string 1)))
12181 (params (append (list :name name)
12182 (read (concat "(" (match-string 3) ")")))))
12184 (beginning-of-line 1)
12185 (skip-chars-forward " \t")
12186 (setq params (plist-put params :indentation-column (current-column))))
12187 (unless (re-search-forward org-dblock-end-re nil t)
12188 (error "Dynamic block not terminated"))
12191 (list :content (buffer-substring
12192 begdel (match-beginning 0)))))
12193 (delete-region begdel (match-beginning 0))
12198 (defun org-map-dblocks (&optional command)
12199 "Apply COMMAND to all dynamic blocks in the current buffer.
12200 If COMMAND is not given, use `org-update-dblock'."
12201 (let ((cmd (or command 'org-update-dblock)))
12203 (goto-char (point-min))
12204 (while (re-search-forward org-dblock-start-re nil t)
12205 (goto-char (match-beginning 0))
12207 (condition-case nil
12209 (error (message "Error during update of dynamic block"))))
12210 (unless (re-search-forward org-dblock-end-re nil t)
12211 (error "Dynamic block not terminated"))))))
12213 (defun org-dblock-update (&optional arg)
12214 "User command for updating dynamic blocks.
12215 Update the dynamic block at point. With prefix ARG, update all dynamic
12216 blocks in the buffer."
12219 (org-update-all-dblocks)
12220 (or (looking-at org-dblock-start-re)
12221 (org-beginning-of-dblock))
12222 (org-update-dblock)))
12224 (defun org-update-dblock ()
12225 "Update the dynamic block at point.
12226 This means to empty the block, parse for parameters and then call
12227 the correct writing function."
12230 (let* ((win (selected-window))
12232 (line (org-current-line))
12233 (params (org-prepare-dblock))
12234 (name (plist-get params :name))
12235 (indent (plist-get params :indentation-column))
12236 (cmd (intern (concat "org-dblock-write:" name))))
12237 (message "Updating dynamic block `%s' at line %d..." name line)
12238 (funcall cmd params)
12239 (message "Updating dynamic block `%s' at line %d...done" name line)
12241 (when (and indent (> indent 0))
12242 (setq indent (make-string indent ?\ ))
12244 (select-window win)
12245 (org-beginning-of-dblock)
12247 (while (not (looking-at org-dblock-end-re))
12249 (beginning-of-line 2))
12250 (when (looking-at org-dblock-end-re)
12251 (and (looking-at "[ \t]+")
12252 (replace-match ""))
12253 (insert indent)))))))
12255 (defun org-beginning-of-dblock ()
12256 "Find the beginning of the dynamic block at point.
12257 Error if there is no such block at point."
12258 (let ((pos (point))
12261 (if (and (re-search-backward org-dblock-start-re nil t)
12262 (setq beg (match-beginning 0))
12263 (re-search-forward org-dblock-end-re nil t)
12264 (> (match-end 0) pos))
12267 (error "Not in a dynamic block"))))
12269 (defun org-update-all-dblocks ()
12270 "Update all dynamic blocks in the buffer.
12271 This function can be used in a hook."
12273 (when (derived-mode-p 'org-mode)
12274 (org-map-dblocks 'org-update-dblock)))
12279 (declare-function org-export-backend-name "org-export" (cl-x))
12280 (declare-function org-export-backend-options "org-export" (cl-x))
12281 (defun org-get-export-keywords ()
12282 "Return a list of all currently understood export keywords.
12283 Export keywords include options, block names, attributes and
12284 keywords relative to each registered export back-end."
12287 (org-bound-and-true-p org-export-registered-backends)
12288 (delq nil keywords))
12289 ;; Back-end name (for keywords, like #+LATEX:)
12290 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12291 (dolist (option-entry (org-export-backend-options backend))
12292 ;; Back-end options.
12293 (push (nth 1 option-entry) keywords)))))
12295 (defconst org-options-keywords
12296 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12297 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12298 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12299 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12300 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12302 (defcustom org-structure-template-alist
12303 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12304 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12305 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12306 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12307 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12308 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12309 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12311 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12313 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12316 ("I" "#+INCLUDE: %file ?"))
12317 "Structure completion elements.
12318 This is a list of abbreviation keys and values. The value gets inserted
12319 if you type `<' followed by the key and then press the completion key,
12320 usually `TAB'. %file will be replaced by a file name after prompting
12321 for the file using completion. The cursor will be placed at the position
12322 of the `?` in the template.
12323 There are two templates for each key, the first uses the original Org syntax,
12324 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12325 the default when the /org-mtags.el/ module has been loaded. See also the
12326 variable `org-mtags-prefer-muse-templates'."
12327 :group 'org-completion
12330 (string :tag "Key")
12331 (string :tag "Template")))
12333 :package-version '(Org . "8.3"))
12335 (defun org-try-structure-completion ()
12336 "Try to complete a structure template before point.
12337 This looks for strings like \"<e\" on an otherwise empty line and
12339 (let ((l (buffer-substring (point-at-bol) (point)))
12341 (when (and (looking-at "[ \t]*$")
12342 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12343 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12344 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12345 (match-beginning 1)) a)
12348 (defun org-complete-expand-structure-template (start cell)
12349 "Expand a structure template."
12350 (let ((rpl (nth 1 cell))
12352 (delete-region start (point))
12353 (when (string-match "\\`[ \t]*#\\+" rpl)
12356 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12357 (setq ind (buffer-substring (point-at-bol) (point))))
12359 (setq start (point))
12360 (if (string-match "%file" rpl)
12361 (setq rpl (replace-match
12365 (abbreviate-file-name (read-file-name "Include file: ")))
12368 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12369 (concat "\n" ind)))
12371 (if (re-search-backward "\\?" start t) (delete-char 1))))
12373 ;;;; TODO, DEADLINE, Comments
12375 (defun org-toggle-comment ()
12376 "Change the COMMENT state of an entry."
12379 (org-back-to-heading)
12380 (looking-at org-complex-heading-regexp)
12381 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12382 (skip-chars-forward " \t")
12383 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12384 (if (org-in-commented-heading-p t)
12385 (delete-region (point)
12386 (progn (search-forward " " (line-end-position) 'move)
12387 (skip-chars-forward " \t")
12389 (insert org-comment-string)
12390 (unless (eolp) (insert " ")))))
12392 (defvar org-last-todo-state-is-todo nil
12393 "This is non-nil when the last TODO state change led to a TODO state.
12394 If the last change removed the TODO tag or switched to DONE, then
12397 (defvar org-setting-tags nil) ; dynamically skipped
12399 (defvar org-todo-setup-filter-hook nil
12400 "Hook for functions that pre-filter todo specs.
12401 Each function takes a todo spec and returns either nil or the spec
12402 transformed into canonical form." )
12404 (defvar org-todo-get-default-hook nil
12405 "Hook for functions that get a default item for todo.
12406 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12407 nil or a string to be used for the todo mark." )
12409 (defvar org-agenda-headline-snapshot-before-repeat)
12411 (defun org-current-effective-time ()
12412 "Return current time adjusted for `org-extend-today-until' variable."
12413 (let* ((ct (org-current-time))
12414 (dct (decode-time ct))
12417 (org-use-last-clock-out-time-as-effective-time
12418 (or (org-clock-get-last-clock-out-time) ct))
12419 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12420 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12424 (defun org-todo-yesterday (&optional arg)
12425 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12427 (if (eq major-mode 'org-agenda-mode)
12428 (apply 'org-agenda-todo-yesterday arg)
12429 (let* ((org-use-effective-time t)
12430 (hour (third (decode-time
12431 (org-current-time))))
12432 (org-extend-today-until (1+ hour)))
12435 (defvar org-block-entry-blocking ""
12436 "First entry preventing the TODO state change.")
12438 (defun org-cancel-repeater ()
12439 "Cancel a repeater by setting its numeric value to zero."
12442 (org-back-to-heading t)
12443 (let ((bound1 (point))
12444 (bound0 (save-excursion (outline-next-heading) (point))))
12445 (when (re-search-forward
12446 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12447 org-deadline-time-regexp "\\)\\|\\("
12448 org-ts-regexp "\\)")
12450 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12451 (replace-match "0" t nil nil 1))))))
12453 (defun org-todo (&optional arg)
12454 "Change the TODO state of an item.
12455 The state of an item is given by a keyword at the start of the heading,
12457 *** TODO Write paper
12460 The different keywords are specified in the variable `org-todo-keywords'.
12461 By default the available states are \"TODO\" and \"DONE\".
12462 So for this example: when the item starts with TODO, it is changed to DONE.
12463 When it starts with DONE, the DONE is removed. And when neither TODO nor
12464 DONE are present, add TODO at the beginning of the heading.
12466 With \\[universal-argument] prefix arg, use completion to determine the new \
12468 With numeric prefix arg, switch to that state.
12469 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12470 keywords (nextset).
12471 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12472 With a numeric prefix arg of 0, inhibit note taking for the change.
12473 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12475 When called through ELisp, arg is also interpreted in the following way:
12476 'none -> empty state
12477 \"\"(empty string) -> switch to empty state
12478 'done -> switch to DONE
12479 'nextset -> switch to the next set of keywords
12480 'previousset -> switch to the previous set of keywords
12481 \"WAITING\" -> switch to the specified keyword, but only if it
12482 really is a member of `org-todo-keywords'."
12484 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12485 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12486 'region-start-level 'region))
12487 org-loop-over-headlines-in-active-region)
12490 org-loop-over-headlines-in-active-region
12491 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12492 (if (equal arg '(16)) (setq arg 'nextset))
12493 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12494 (let ((org-blocker-hook org-blocker-hook)
12497 (when (equal arg '(64))
12498 (setq arg nil org-blocker-hook nil))
12499 (when (and org-blocker-hook
12500 (or org-inhibit-blocking
12501 (org-entry-get nil "NOBLOCKING")))
12502 (setq org-blocker-hook nil))
12505 (org-back-to-heading t)
12506 (when (org-in-commented-heading-p t)
12507 (org-toggle-comment)
12509 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12510 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12511 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12512 (let* ((match-data (match-data))
12513 (startpos (point-at-bol))
12514 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12515 (org-log-done org-log-done)
12516 (org-log-repeat org-log-repeat)
12517 (org-todo-log-states org-todo-log-states)
12518 (org-inhibit-logging
12520 (progn (setq arg nil) 'note) org-inhibit-logging))
12521 (this (match-string 1))
12522 (hl-pos (match-beginning 0))
12523 (head (org-get-todo-sequence-head this))
12524 (ass (assoc head org-todo-kwd-alist))
12525 (interpret (nth 1 ass))
12526 (done-word (nth 3 ass))
12527 (final-done-word (nth 4 ass))
12528 (org-last-state (or this ""))
12529 (completion-ignore-case t)
12530 (member (member this org-todo-keywords-1))
12531 (tail (cdr member))
12533 ((and org-todo-key-trigger
12534 (or (and (equal arg '(4))
12535 (eq org-use-fast-todo-selection 'prefix))
12536 (and (not arg) org-use-fast-todo-selection
12537 (not (eq org-use-fast-todo-selection
12539 ;; Use fast selection
12540 (org-fast-todo-selection))
12541 ((and (equal arg '(4))
12542 (or (not org-use-fast-todo-selection)
12543 (not org-todo-key-trigger)))
12544 ;; Read a state with completion
12545 (org-icompleting-read
12546 "State: " (mapcar 'list org-todo-keywords-1)
12550 (if tail (car tail) nil)
12551 (car org-todo-keywords-1)))
12553 (if (equal member org-todo-keywords-1)
12556 (nth (- (length org-todo-keywords-1)
12558 org-todo-keywords-1)
12559 (org-last org-todo-keywords-1))))
12560 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12561 (setq arg nil))) ; hack to fall back to cycling
12563 ;; user or caller requests a specific state
12565 ((equal arg "") nil)
12566 ((eq arg 'none) nil)
12567 ((eq arg 'done) (or done-word (car org-done-keywords)))
12569 (or (car (cdr (member head org-todo-heads)))
12570 (car org-todo-heads)))
12571 ((eq arg 'previousset)
12572 (let ((org-todo-heads (reverse org-todo-heads)))
12573 (or (car (cdr (member head org-todo-heads)))
12574 (car org-todo-heads))))
12575 ((car (member arg org-todo-keywords-1)))
12577 (user-error "State `%s' not valid in this file" arg))
12578 ((nth (1- (prefix-numeric-value arg))
12579 org-todo-keywords-1))))
12580 ((null member) (or head (car org-todo-keywords-1)))
12581 ((equal this final-done-word) nil) ;; -> make empty
12582 ((null tail) nil) ;; -> first entry
12583 ((memq interpret '(type priority))
12584 (if (eq this-command last-command)
12586 (if (> (length tail) 0)
12587 (or done-word (car org-done-keywords))
12592 (run-hook-with-args-until-success
12593 'org-todo-get-default-hook org-state org-last-state)
12595 (next (if org-state (concat " " org-state " ") " "))
12596 (change-plist (list :type 'todo-state-change :from this :to org-state
12597 :position startpos))
12599 (when org-blocker-hook
12600 (setq org-last-todo-state-is-todo
12601 (not (member this org-done-keywords)))
12602 (unless (save-excursion
12604 (org-with-wide-buffer
12605 (run-hook-with-args-until-failure
12606 'org-blocker-hook change-plist))))
12607 (if (org-called-interactively-p 'interactive)
12608 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12609 this org-state org-block-entry-blocking)
12611 (message "TODO state change from %s to %s blocked (by \"%s\")"
12612 this org-state org-block-entry-blocking)
12613 (throw 'exit nil))))
12614 (store-match-data match-data)
12615 (replace-match next t t)
12616 (cond ((equal this org-state)
12617 (message "TODO state was already %s" (org-trim next)))
12618 ((pos-visible-in-window-p hl-pos)
12619 (message "TODO state changed to %s" (org-trim next))))
12621 (setq head (org-get-todo-sequence-head org-state)
12622 ass (assoc head org-todo-kwd-alist)
12623 interpret (nth 1 ass)
12624 done-word (nth 3 ass)
12625 final-done-word (nth 4 ass)))
12626 (when (memq arg '(nextset previousset))
12627 (message "Keyword-Set %d/%d: %s"
12628 (- (length org-todo-sets) -1
12629 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12630 (length org-todo-sets)
12631 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12632 (setq org-last-todo-state-is-todo
12633 (not (member org-state org-done-keywords)))
12634 (setq now-done-p (and (member org-state org-done-keywords)
12635 (not (member this org-done-keywords))))
12636 (and logging (org-local-logging logging))
12637 (when (and (or org-todo-log-states org-log-done)
12638 (not (eq org-inhibit-logging t))
12639 (not (memq arg '(nextset previousset))))
12640 ;; we need to look at recording a time and note
12641 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12642 (nth 2 (assoc this org-todo-log-states))))
12643 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12644 (setq dolog 'time))
12645 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12647 (member org-state org-not-done-keywords)
12648 (not (member this org-not-done-keywords))))
12649 ;; This is now a todo state and was not one before
12650 ;; If there was a CLOSED time stamp, get rid of it.
12651 (org-add-planning-info nil nil 'closed))
12652 (when (and now-done-p org-log-done)
12653 ;; It is now done, and it was not done before
12654 (org-add-planning-info 'closed (org-current-effective-time))
12655 (if (and (not dolog) (eq 'note org-log-done))
12656 (org-add-log-setup 'done org-state this 'findpos 'note)))
12657 (when (and org-state dolog)
12658 ;; This is a non-nil state, and we need to log it
12659 (org-add-log-setup 'state org-state this 'findpos dolog)))
12660 ;; Fixup tag positioning
12661 (org-todo-trigger-tag-changes org-state)
12662 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12663 (when org-provide-todo-statistics
12664 (org-update-parent-todo-statistics))
12665 (run-hooks 'org-after-todo-state-change-hook)
12666 (if (and arg (not (member org-state org-done-keywords)))
12667 (setq head (org-get-todo-sequence-head org-state)))
12668 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12669 ;; Do we need to trigger a repeat?
12671 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12672 ;; This is for the agenda, take a snapshot of the headline.
12674 (setq org-agenda-headline-snapshot-before-repeat
12675 (org-get-heading))))
12676 (org-auto-repeat-maybe org-state))
12677 ;; Fixup cursor location if close to the keyword
12678 (if (and (outline-on-heading-p)
12680 (save-excursion (beginning-of-line 1)
12681 (looking-at org-todo-line-regexp))
12682 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12684 (goto-char (or (match-end 2) (match-end 1)))
12685 (and (looking-at " ") (just-one-space))))
12686 (when org-trigger-hook
12688 (run-hook-with-args 'org-trigger-hook change-plist)))
12689 (when commentp (org-toggle-comment))))))))
12691 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12692 "Block turning an entry into a TODO, using the hierarchy.
12693 This checks whether the current task should be blocked from state
12694 changes. Such blocking occurs when:
12696 1. The task has children which are not all in a completed state.
12698 2. A task has a parent with the property :ORDERED:, and there
12699 are siblings prior to the current task with incomplete
12702 3. The parent of the task is blocked because it has siblings that should
12703 be done first, or is child of a block grandparent TODO entry."
12705 (if (not org-enforce-todo-dependencies)
12706 t ; if locally turned off don't block
12708 ;; If this is not a todo state change, or if this entry is already DONE,
12710 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12711 (member (plist-get change-plist :from)
12712 (cons 'done org-done-keywords))
12713 (member (plist-get change-plist :to)
12714 (cons 'todo org-not-done-keywords))
12715 (not (plist-get change-plist :to)))
12716 (throw 'dont-block t))
12717 ;; If this task has children, and any are undone, it's blocked
12719 (org-back-to-heading t)
12720 (let ((this-level (funcall outline-level)))
12721 (outline-next-heading)
12722 (let ((child-level (funcall outline-level)))
12723 (while (and (not (eobp))
12724 (> child-level this-level))
12725 ;; this todo has children, check whether they are all
12727 (if (and (not (org-entry-is-done-p))
12728 (org-entry-is-todo-p))
12729 (progn (setq org-block-entry-blocking (org-get-heading))
12730 (throw 'dont-block nil)))
12731 (outline-next-heading)
12732 (setq child-level (funcall outline-level))))))
12733 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12734 ;; any previous siblings are undone, it's blocked
12736 (org-back-to-heading t)
12737 (let* ((pos (point))
12738 (parent-pos (and (org-up-heading-safe) (point))))
12739 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12740 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12742 (re-search-forward org-not-done-heading-regexp pos t))
12743 (setq org-block-entry-blocking (match-string 0))
12744 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12745 ;; Search further up the hierarchy, to see if an ancestor is blocked
12747 (goto-char parent-pos)
12748 (if (not (looking-at org-not-done-heading-regexp))
12749 (throw 'dont-block t)) ; do not block, parent is not a TODO
12751 (setq 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"))
12755 (re-search-forward org-not-done-heading-regexp pos t)
12756 (setq org-block-entry-blocking (org-get-heading)))
12757 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12759 (defcustom org-track-ordered-property-with-tag nil
12760 "Should the ORDERED property also be shown as a tag?
12761 The ORDERED property decides if an entry should require subtasks to be
12762 completed in sequence. Since a property is not very visible, setting
12763 this option means that toggling the ORDERED property with the command
12764 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12765 not relevant for the behavior, but it makes things more visible.
12767 Note that toggling the tag with tags commands will not change the property
12768 and therefore not influence behavior!
12770 This can be t, meaning the tag ORDERED should be used, It can also be a
12771 string to select a different tag for this task."
12774 (const :tag "No tracking" nil)
12775 (const :tag "Track with ORDERED tag" t)
12776 (string :tag "Use other tag")))
12778 (defun org-toggle-ordered-property ()
12779 "Toggle the ORDERED property of the current entry.
12780 For better visibility, you can track the value of this property with a tag.
12781 See variable `org-track-ordered-property-with-tag'."
12783 (let* ((t1 org-track-ordered-property-with-tag)
12784 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12786 (org-back-to-heading)
12787 (if (org-entry-get nil "ORDERED")
12789 (org-delete-property "ORDERED")
12790 (and tag (org-toggle-tag tag 'off))
12791 (message "Subtasks can be completed in arbitrary order"))
12792 (org-entry-put nil "ORDERED" "t")
12793 (and tag (org-toggle-tag tag 'on))
12794 (message "Subtasks must be completed in sequence")))))
12796 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12797 (defun org-block-todo-from-checkboxes (change-plist)
12798 "Block turning an entry into a TODO, using checkboxes.
12799 This checks whether the current task should be blocked from state
12800 changes because there are unchecked boxes in this entry."
12801 (if (not org-enforce-todo-checkbox-dependencies)
12802 t ; if locally turned off don't block
12804 ;; If this is not a todo state change, or if this entry is already DONE,
12806 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12807 (member (plist-get change-plist :from)
12808 (cons 'done org-done-keywords))
12809 (member (plist-get change-plist :to)
12810 (cons 'todo org-not-done-keywords))
12811 (not (plist-get change-plist :to)))
12812 (throw 'dont-block t))
12813 ;; If this task has checkboxes that are not checked, it's blocked
12815 (org-back-to-heading t)
12816 (let ((beg (point)) end)
12817 (outline-next-heading)
12820 (if (org-list-search-forward
12821 (concat (org-item-beginning-re)
12822 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12826 (if (boundp 'org-blocked-by-checkboxes)
12827 (setq org-blocked-by-checkboxes t))
12828 (throw 'dont-block nil)))))
12829 t))) ; do not block
12831 (defun org-entry-blocked-p ()
12832 "Is the current entry blocked?"
12833 (org-with-silent-modifications
12834 (if (org-entry-get nil "NOBLOCKING")
12835 nil ;; Never block this entry
12836 (not (run-hook-with-args-until-failure
12838 (list :type 'todo-state-change
12843 (defun org-update-statistics-cookies (all)
12844 "Update the statistics cookie, either from TODO or from checkboxes.
12845 This should be called with the cursor in a line with a statistics cookie."
12849 (org-update-checkbox-count 'all)
12850 (org-map-entries 'org-update-parent-todo-statistics))
12851 (if (not (org-at-heading-p))
12852 (org-update-checkbox-count)
12853 (let ((pos (point-marker))
12855 (ignore-errors (org-back-to-heading t))
12856 (if (not (org-at-heading-p))
12857 (org-update-checkbox-count)
12858 (setq l1 (org-outline-level))
12859 (setq end (save-excursion
12860 (outline-next-heading)
12861 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12863 (if (and (save-excursion
12865 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12866 (not (save-excursion (re-search-forward
12867 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12868 (org-update-checkbox-count)
12869 (if (and l2 (> l2 l1))
12872 (org-update-parent-todo-statistics))
12874 (beginning-of-line 1)
12875 (while (re-search-forward
12876 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12878 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12880 (move-marker pos nil)))))
12882 (defvar org-entry-property-inherited-from) ;; defined below
12883 (defun org-update-parent-todo-statistics ()
12884 "Update any statistics cookie in the parent of the current headline.
12885 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12886 the entire subtree and this will travel up the hierarchy and update
12887 statistics everywhere."
12888 (let* ((prop (save-excursion (org-up-heading-safe)
12889 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12890 (recursive (or (not org-hierarchical-todo-statistics)
12891 (and prop (string-match "\\<recursive\\>" prop))))
12892 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12895 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12896 level ltoggle l1 new ndel
12897 (cnt-all 0) (cnt-done 0) is-percent kwd
12898 checkbox-beg ov ovs ove cookie-present)
12901 (beginning-of-line 1)
12902 (setq ltoggle (funcall outline-level))
12903 ;; Three situations are to consider:
12905 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12906 ;; to the top-level ancestor on the headline;
12908 ;; 2. If parent has "recursive" property, repeat up to the
12909 ;; headline setting that property, taking inheritance into
12912 ;; 3. Else, move up to direct parent and proceed only once.
12913 (while (and (setq level (org-up-heading-safe))
12914 (or recursive first)
12916 (setq first nil cookie-present nil)
12920 (downcase (or (org-entry-get nil "COOKIE_DATA")
12923 (while (re-search-forward box-re (point-at-eol) t)
12924 (setq cnt-all 0 cnt-done 0 cookie-present t)
12925 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12927 (unless (outline-next-heading) (throw 'exit nil))
12928 (while (and (looking-at org-complex-heading-regexp)
12929 (> (setq l1 (length (match-string 1))) level))
12930 (setq kwd (and (or recursive (= l1 ltoggle))
12932 (if (or (eq org-provide-todo-statistics 'all-headlines)
12933 (and (eq org-provide-todo-statistics t)
12934 (or (member kwd org-done-keywords)))
12935 (and (listp org-provide-todo-statistics)
12936 (stringp (car org-provide-todo-statistics))
12937 (or (member kwd org-provide-todo-statistics)
12938 (member kwd org-done-keywords)))
12939 (and (listp org-provide-todo-statistics)
12940 (listp (car org-provide-todo-statistics))
12941 (or (member kwd (car org-provide-todo-statistics))
12942 (and (member kwd org-done-keywords)
12943 (member kwd (cadr org-provide-todo-statistics))))))
12944 (setq cnt-all (1+ cnt-all))
12945 (if (eq org-provide-todo-statistics t)
12946 (and kwd (setq cnt-all (1+ cnt-all)))))
12947 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12948 (member kwd org-done-keywords))
12949 (and (listp org-provide-todo-statistics)
12950 (listp (car org-provide-todo-statistics))
12951 (member kwd org-done-keywords)
12952 (member kwd (cadr org-provide-todo-statistics)))
12953 (and (listp org-provide-todo-statistics)
12954 (stringp (car org-provide-todo-statistics))
12955 (member kwd org-done-keywords)))
12956 (setq cnt-done (1+ cnt-done)))
12957 (outline-next-heading)))
12960 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12961 (format "[%d/%d]" cnt-done cnt-all))
12962 ndel (- (match-end 0) checkbox-beg))
12963 ;; handle overlays when updating cookie from column view
12964 (when (setq ov (car (overlays-at checkbox-beg)))
12965 (setq ovs (overlay-start ov) ove (overlay-end ov))
12966 (delete-overlay ov))
12967 (goto-char checkbox-beg)
12969 (delete-region (point) (+ (point) ndel))
12970 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12971 (when ov (move-overlay ov ovs ove)))
12972 (when cookie-present
12973 (run-hook-with-args 'org-after-todo-statistics-hook
12974 cnt-done (- cnt-all cnt-done))))))
12975 (run-hooks 'org-todo-statistics-hook)))
12977 (defvar org-after-todo-statistics-hook nil
12978 "Hook that is called after a TODO statistics cookie has been updated.
12979 Each function is called with two arguments: the number of not-done entries
12980 and the number of done entries.
12982 For example, the following function, when added to this hook, will switch
12983 an entry to DONE when all children are done, and back to TODO when new
12984 entries are set to a TODO status. Note that this hook is only called
12985 when there is a statistics cookie in the headline!
12987 (defun org-summary-todo (n-done n-not-done)
12988 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12989 (let (org-log-done org-log-states) ; turn off logging
12990 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12993 (defvar org-todo-statistics-hook nil
12994 "Hook that is run whenever Org thinks TODO statistics should be updated.
12995 This hook runs even if there is no statistics cookie present, in which case
12996 `org-after-todo-statistics-hook' would not run.")
12998 (defun org-todo-trigger-tag-changes (state)
12999 "Apply the changes defined in `org-todo-state-tags-triggers'."
13000 (let ((l org-todo-state-tags-triggers)
13002 (when (or (not state) (equal state ""))
13003 (setq changes (append changes (cdr (assoc "" l)))))
13004 (when (and (stringp state) (> (length state) 0))
13005 (setq changes (append changes (cdr (assoc state l)))))
13006 (when (member state org-not-done-keywords)
13007 (setq changes (append changes (cdr (assoc 'todo l)))))
13008 (when (member state org-done-keywords)
13009 (setq changes (append changes (cdr (assoc 'done l)))))
13010 (dolist (c changes)
13011 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13013 (defun org-local-logging (value)
13014 "Get logging settings from a property VALUE."
13016 ;; directly set the variables, they are already local.
13017 (setq org-log-done nil
13019 org-todo-log-states nil)
13020 (setq words (org-split-string value))
13021 (while (setq w (pop words))
13023 ((setq a (assoc w org-startup-options))
13024 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13025 (set (nth 1 a) (nth 2 a))))
13026 ((setq a (org-extract-log-state-settings w))
13027 (and (member (car a) org-todo-keywords-1)
13028 (push a org-todo-log-states)))))))
13030 (defun org-get-todo-sequence-head (kwd)
13031 "Return the head of the TODO sequence to which KWD belongs.
13032 If KWD is not set, check if there is a text property remembering the
13037 (or (get-text-property (point-at-bol) 'org-todo-head)
13039 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13040 nil (point-at-eol)))
13041 (get-text-property p 'org-todo-head))))
13042 ((not (member kwd org-todo-keywords-1))
13043 (car org-todo-keywords-1))
13044 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13046 (defun org-fast-todo-selection ()
13047 "Fast TODO keyword selection with single keys.
13048 Returns the new TODO keyword, or nil if no state change should occur."
13049 (let* ((fulltable org-todo-key-alist)
13050 (done-keywords org-done-keywords) ;; needed for the faces.
13051 (maxlen (apply 'max (mapcar
13053 (if (stringp (car x)) (string-width (car x)) 0))
13056 (fwidth (+ maxlen 3 1 3))
13057 (ncol (/ (- (window-width) 4) fwidth))
13061 (save-window-excursion
13063 (set-buffer (get-buffer-create " *Org todo*"))
13064 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13066 (org-set-local 'org-done-keywords done-keywords)
13067 (setq tbl fulltable cnt 0)
13068 (while (setq e (pop tbl))
13070 ((equal e '(:startgroup))
13071 (push '() groups) (setq ingroup t)
13072 (when (not (= cnt 0))
13076 ((equal e '(:endgroup))
13077 (setq ingroup nil cnt 0)
13079 ((equal e '(:newline))
13080 (when (not (= cnt 0))
13084 (while (equal (car tbl) '(:newline))
13086 (setq tbl (cdr tbl)))))
13088 (setq tg (car e) c (cdr e))
13089 (if ingroup (push tg (car groups)))
13090 (setq tg (org-add-props tg nil 'face
13091 (org-get-todo-face tg)))
13092 (if (and (= cnt 0) (not ingroup)) (insert " "))
13093 (insert "[" c "] " tg (make-string
13094 (- fwidth 4 (length tg)) ?\ ))
13095 (when (= (setq cnt (1+ cnt)) ncol)
13097 (if ingroup (insert " "))
13100 (goto-char (point-min))
13101 (if (not expert) (org-fit-window-to-buffer))
13102 (message "[a-z..]:Set [SPC]:clear")
13103 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13106 (and (= c ?q) (not (rassoc c fulltable))))
13107 (setq quit-flag t))
13109 ((setq e (rassoc c fulltable) tg (car e))
13111 (t (setq quit-flag t)))))))
13113 (defun org-entry-is-todo-p ()
13114 (member (org-get-todo-state) org-not-done-keywords))
13116 (defun org-entry-is-done-p ()
13117 (member (org-get-todo-state) org-done-keywords))
13119 (defun org-get-todo-state ()
13120 "Return the TODO keyword of the current subtree."
13122 (org-back-to-heading t)
13123 (and (looking-at org-todo-line-regexp)
13125 (match-string 2))))
13127 (defun org-at-date-range-p (&optional inactive-ok)
13128 "Is the cursor inside a date range?"
13132 (let ((pos (point)))
13133 (skip-chars-backward "^[<\r\n")
13134 (skip-chars-backward "<[")
13135 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13136 (>= (match-end 0) pos)
13138 (skip-chars-backward "^<[\r\n")
13139 (skip-chars-backward "<[")
13140 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13141 (>= (match-end 0) pos)
13145 (defun org-get-repeat (&optional tagline)
13146 "Check if there is a deadline/schedule with repeater in this entry."
13149 (org-back-to-heading t)
13150 (and (re-search-forward (if tagline
13151 (concat tagline "\\s-*" org-repeat-re)
13153 (org-entry-end-position) t)
13154 (match-string-no-properties 1)))))
13156 (defvar org-last-changed-timestamp)
13157 (defvar org-last-inserted-timestamp)
13158 (defvar org-log-post-message)
13159 (defvar org-log-note-purpose)
13160 (defvar org-log-note-how nil)
13161 (defvar org-log-note-extra)
13162 (defun org-auto-repeat-maybe (done-word)
13163 "Check if the current headline contains a repeated deadline/schedule.
13164 If yes, set TODO state back to what it was and change the base date
13165 of repeating deadline/scheduled time stamps to new date.
13166 This function is run automatically after each state change to a DONE state."
13167 ;; last-state is dynamically scoped into this function
13168 (let* ((repeat (org-get-repeat))
13169 (aa (assoc org-last-state org-todo-kwd-alist))
13170 (interpret (nth 1 aa))
13172 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13173 (msg "Entry repeats: ")
13175 (org-todo-log-states nil)
13176 re type n what ts time to-state)
13177 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13178 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13179 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13180 org-todo-repeat-to-state))
13181 (unless (and to-state (member to-state org-todo-keywords-1))
13182 (setq to-state (if (eq interpret 'type) org-last-state head)))
13183 (org-todo to-state)
13184 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13185 (org-entry-put nil "LAST_REPEAT" (format-time-string
13186 (org-time-stamp-format t t))))
13187 (when org-log-repeat
13188 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13189 (memq 'org-add-log-note post-command-hook))
13190 ;; OK, we are already setup for some record
13191 (if (eq org-log-repeat 'note)
13192 ;; make sure we take a note, not only a time stamp
13193 (setq org-log-note-how 'note))
13194 ;; Set up for taking a record
13195 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13197 'findpos org-log-repeat)))
13198 (org-back-to-heading t)
13199 (org-add-planning-info nil nil 'closed)
13200 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13201 org-deadline-time-regexp "\\)\\|\\("
13202 org-ts-regexp "\\)"))
13203 (while (re-search-forward
13204 re (save-excursion (outline-next-heading) (point)) t)
13205 (setq type (if (match-end 1) org-scheduled-string
13206 (if (match-end 3) org-deadline-string "Plain:"))
13207 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13208 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13209 (setq n (string-to-number (match-string 2 ts))
13210 what (match-string 3 ts))
13211 (if (equal what "w") (setq n (* n 7) what "d"))
13212 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13213 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13214 ;; Preparation, see if we need to modify the start date for the change
13215 (when (match-end 1)
13216 (setq time (save-match-data (org-time-string-to-time ts)))
13218 ((equal (match-string 1 ts) ".")
13219 ;; Shift starting date to today
13220 (org-timestamp-change
13221 (- (org-today) (time-to-days time))
13223 ((equal (match-string 1 ts) "+")
13224 (let ((nshiftmax 10) (nshift 0))
13225 (while (or (= nshift 0)
13226 (<= (time-to-days time)
13227 (time-to-days (current-time))))
13228 (when (= (incf nshift) nshiftmax)
13229 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13230 (user-error "Abort")))
13231 (org-timestamp-change n (cdr (assoc what whata)))
13232 (org-at-timestamp-p t)
13233 (setq ts (match-string 1))
13234 (setq time (save-match-data (org-time-string-to-time ts)))))
13235 (org-timestamp-change (- n) (cdr (assoc what whata)))
13236 ;; rematch, so that we have everything in place for the real shift
13237 (org-at-timestamp-p t)
13238 (setq ts (match-string 1))
13239 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13240 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13241 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13242 (setq org-log-post-message msg)
13243 (message "%s" msg))))
13245 (defun org-show-todo-tree (arg)
13246 "Make a compact tree which shows all headlines marked with TODO.
13247 The tree will show the lines where the regexp matches, and all higher
13248 headlines above the match.
13249 With a \\[universal-argument] prefix, prompt for a regexp to match.
13250 With a numeric prefix N, construct a sparse tree for the Nth element
13251 of `org-todo-keywords-1'."
13253 (let ((case-fold-search nil)
13255 (cond ((null arg) org-not-done-regexp)
13257 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13258 (mapcar 'list org-todo-keywords-1))))
13260 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13262 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13263 (regexp-quote (nth (1- (prefix-numeric-value arg))
13264 org-todo-keywords-1)))
13265 (t (user-error "Invalid prefix argument: %s" arg)))))
13266 (message "%d TODO entries found"
13267 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13269 (defun org-deadline (arg &optional time)
13270 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13271 With one universal prefix argument, remove any deadline from the item.
13272 With two universal prefix arguments, prompt for a warning delay.
13273 With argument TIME, set the deadline at the corresponding date. TIME
13274 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13276 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13277 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13278 'region-start-level 'region))
13279 org-loop-over-headlines-in-active-region)
13281 `(org-deadline ',arg ,time)
13282 org-loop-over-headlines-in-active-region
13283 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13284 (let* ((old-date (org-entry-get nil "DEADLINE"))
13285 (old-date-time (if old-date (org-time-string-to-time old-date)))
13286 (repeater (and old-date
13288 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13290 (match-string 1 old-date))))
13293 (when (and old-date org-log-redeadline)
13294 (org-add-log-setup 'deldeadline nil old-date 'findpos
13295 org-log-redeadline))
13296 (org-remove-timestamp-with-keyword org-deadline-string)
13297 (message "Item no longer has a deadline."))
13300 (org-back-to-heading t)
13301 (if (re-search-forward
13302 org-deadline-time-regexp
13303 (save-excursion (outline-next-heading) (point)) t)
13304 (let* ((rpl0 (match-string 1))
13305 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13307 (concat org-deadline-string
13313 (org-read-date nil t nil "Warn starting from" old-date-time)))
13314 (time-to-days old-date-time))))
13316 (user-error "No deadline information to update"))))
13318 (org-add-planning-info 'deadline time 'closed)
13319 (when (and old-date org-log-redeadline
13320 (not (equal old-date
13321 (substring org-last-inserted-timestamp 1 -1))))
13322 (org-add-log-setup 'redeadline nil old-date 'findpos
13323 org-log-redeadline))
13326 (org-back-to-heading t)
13327 (when (re-search-forward (concat org-deadline-string " "
13328 org-last-inserted-timestamp)
13330 (outline-next-heading) (point)) t)
13331 (goto-char (1- (match-end 0)))
13332 (insert " " repeater)
13333 (setq org-last-inserted-timestamp
13334 (concat (substring org-last-inserted-timestamp 0 -1)
13336 (substring org-last-inserted-timestamp -1))))))
13337 (message "Deadline on %s" org-last-inserted-timestamp))))))
13339 (defun org-schedule (arg &optional time)
13340 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13341 With one universal prefix argument, remove any scheduling date from the item.
13342 With two universal prefix arguments, prompt for a delay cookie.
13343 With argument TIME, scheduled at the corresponding date. TIME can
13344 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13346 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13347 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13348 'region-start-level 'region))
13349 org-loop-over-headlines-in-active-region)
13351 `(org-schedule ',arg ,time)
13352 org-loop-over-headlines-in-active-region
13353 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13354 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13355 (old-date-time (if old-date (org-time-string-to-time old-date)))
13356 (repeater (and old-date
13358 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13360 (match-string 1 old-date))))
13364 (when (and old-date org-log-reschedule)
13365 (org-add-log-setup 'delschedule nil old-date 'findpos
13366 org-log-reschedule))
13367 (org-remove-timestamp-with-keyword org-scheduled-string)
13368 (message "Item is no longer scheduled.")))
13371 (org-back-to-heading t)
13372 (if (re-search-forward
13373 org-scheduled-time-regexp
13374 (save-excursion (outline-next-heading) (point)) t)
13375 (let* ((rpl0 (match-string 1))
13376 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13378 (concat org-scheduled-string
13384 (org-read-date nil t nil "Delay until" old-date-time)))
13385 (time-to-days old-date-time))))
13387 (user-error "No scheduled information to update"))))
13389 (org-add-planning-info 'scheduled time 'closed)
13390 (when (and old-date org-log-reschedule
13391 (not (equal old-date
13392 (substring org-last-inserted-timestamp 1 -1))))
13393 (org-add-log-setup 'reschedule nil old-date 'findpos
13394 org-log-reschedule))
13397 (org-back-to-heading t)
13398 (when (re-search-forward (concat org-scheduled-string " "
13399 org-last-inserted-timestamp)
13401 (outline-next-heading) (point)) t)
13402 (goto-char (1- (match-end 0)))
13403 (insert " " repeater)
13404 (setq org-last-inserted-timestamp
13405 (concat (substring org-last-inserted-timestamp 0 -1)
13407 (substring org-last-inserted-timestamp -1))))))
13408 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13410 (defun org-get-scheduled-time (pom &optional inherit)
13411 "Get the scheduled time as a time tuple, of a format suitable
13412 for calling org-schedule with, or if there is no scheduling,
13414 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13416 (apply 'encode-time (org-parse-time-string time)))))
13418 (defun org-get-deadline-time (pom &optional inherit)
13419 "Get the deadline as a time tuple, of a format suitable for
13420 calling org-deadline with, or if there is no scheduling, returns
13422 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13424 (apply 'encode-time (org-parse-time-string time)))))
13426 (defun org-remove-timestamp-with-keyword (keyword)
13427 "Remove all time stamps with KEYWORD in the current entry."
13428 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13431 (org-back-to-heading t)
13433 (outline-next-heading)
13434 (while (re-search-backward re beg t)
13436 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13437 (equal (char-before) ?\ ))
13438 (backward-delete-char 1)
13439 (if (string-match "^[ \t]*$" (buffer-substring
13440 (point-at-bol) (point-at-eol)))
13441 (delete-region (point-at-bol)
13442 (min (point-max) (1+ (point-at-eol))))))))))
13444 (defvar org-time-was-given) ; dynamically scoped parameter
13445 (defvar org-end-time-was-given) ; dynamically scoped parameter
13447 (defun org-at-planning-p ()
13448 "Non-nil when point is on a planning info line."
13449 ;; This is as accurate and faster than `org-element-at-point' since
13450 ;; planning info location is fixed in the section.
13451 (org-with-wide-buffer
13452 (beginning-of-line)
13453 (and (org-looking-at-p org-planning-line-re)
13456 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13457 (org-back-to-heading t)
13458 (org-with-limited-levels (org-back-to-heading t)))
13459 (line-beginning-position 2))))))
13461 (defun org-add-planning-info (what &optional time &rest remove)
13462 "Insert new timestamp with keyword in the planning line.
13463 WHAT indicates what kind of time stamp to add. It is a symbol
13464 among `closed', `deadline', `scheduled' and nil. TIME indicates
13465 the time to use. If none is given, the user is prompted for
13466 a date. REMOVE indicates what kind of entries to remove. An old
13467 WHAT entry will also be removed."
13468 (let (org-time-was-given org-end-time-was-given default-time default-input)
13470 (when (and (memq what '(scheduled deadline))
13472 (and (stringp time)
13473 (string-match "^[-+]+[0-9]" time))))
13474 ;; Try to get a default date/time from existing timestamp
13476 (org-back-to-heading t)
13477 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13478 (when (re-search-forward (if (eq what 'scheduled)
13479 org-scheduled-time-regexp
13480 org-deadline-time-regexp)
13482 (setq ts (match-string 1)
13483 default-time (apply 'encode-time (org-parse-time-string ts))
13484 default-input (and ts (org-get-compact-tod ts)))))))
13488 ;; This is a string (relative or absolute), set
13490 (apply #'encode-time
13491 (org-read-date-analyze
13492 time default-time (decode-time default-time)))
13493 ;; If necessary, get the time from the user
13494 (or time (org-read-date nil 'to-time nil nil
13495 default-time default-input)))))
13497 (org-with-wide-buffer
13498 (org-back-to-heading t)
13500 (unless (bolp) (insert "\n"))
13501 (cond ((org-looking-at-p org-planning-line-re)
13502 ;; Move to current indentation.
13503 (skip-chars-forward " \t")
13504 ;; Check if we have to remove something.
13505 (dolist (type (if what (cons what remove) remove))
13506 (when (save-excursion
13509 (closed org-closed-time-regexp)
13510 (deadline org-deadline-time-regexp)
13511 (scheduled org-scheduled-time-regexp)
13512 (otherwise (error "Invalid planning type: %s" type)))
13513 (line-end-position) t))
13515 (when (looking-at "--+<[^>]+>") (replace-match ""))
13516 (when (and (not what) (eq type 'closed))
13518 (beginning-of-line)
13519 (if (looking-at "[ \t]*$")
13520 (delete-region (point) (1+ (point-at-eol)))))))
13521 ;; Remove leading white spaces.
13522 (when (and (not (bolp)) (looking-at "[ \t]+")) (replace-match ""))))
13523 ((not what) (throw 'exit nil)) ; Nothing to do.
13524 (t (insert-before-markers "\n")
13526 (when org-adapt-indentation
13527 (org-indent-to-column (1+ (org-outline-level))))))
13529 ;; Insert planning keyword.
13531 (closed org-closed-string)
13532 (deadline org-deadline-string)
13533 (scheduled org-scheduled-string)
13534 (otherwise (error "Invalid planning type: %s" what)))
13536 ;; Insert associated timestamp.
13537 (let ((ts (org-insert-time-stamp
13539 (or org-time-was-given
13540 (and (eq what 'closed) org-log-done-with-time))
13542 nil nil (list org-end-time-was-given))))
13543 (unless (eolp) (insert " "))
13546 (defvar org-log-note-marker (make-marker))
13547 (defvar org-log-note-purpose nil)
13548 (defvar org-log-note-state nil)
13549 (defvar org-log-note-previous-state nil)
13550 (defvar org-log-note-extra nil)
13551 (defvar org-log-note-window-configuration nil)
13552 (defvar org-log-note-return-to (make-marker))
13553 (defvar org-log-note-effective-time nil
13554 "Remembered current time so that dynamically scoped
13555 `org-extend-today-until' affects tha timestamps in state change
13558 (defvar org-log-post-message nil
13559 "Message to be displayed after a log note has been stored.
13560 The auto-repeater uses this.")
13562 (defun org-add-note ()
13563 "Add a note to the current entry.
13564 This is done in the same way as adding a state change note."
13566 (org-add-log-setup 'note nil nil 'findpos nil))
13568 (defun org-log-beginning (&optional create)
13569 "Return expected start of log notes in current entry.
13570 When optional argument CREATE is non-nil, the function creates
13571 a drawer to store notes, if necessary. Returned position ignores
13573 (org-with-wide-buffer
13574 (org-end-of-meta-data)
13575 (let ((end (if (org-at-heading-p) (point)
13576 (save-excursion (outline-next-heading) (point))))
13577 (drawer (org-log-into-drawer)))
13580 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13581 (case-fold-search t))
13583 ;; Try to find existing drawer.
13584 (while (re-search-forward regexp end t)
13585 (let ((element (org-element-at-point)))
13586 (when (eq (org-element-type element) 'drawer)
13587 (let ((cend (org-element-property :contents-end element)))
13588 (when (and (not org-log-states-order-reversed) cend)
13590 (throw 'exit nil))))
13591 ;; No drawer found. Create one, if permitted.
13593 (unless (bolp) (insert "\n"))
13594 (let ((beg (point)))
13595 (insert ":" drawer ":\n:END:\n")
13596 (org-indent-region beg (point)))
13597 (end-of-line -1)))))
13598 (org-log-state-notes-insert-after-drawers
13599 (while (and (looking-at org-drawer-regexp)
13600 (progn (goto-char (match-end 0))
13601 (re-search-forward org-property-end-re end t)))
13603 (if (bolp) (point) (line-beginning-position 2))))
13605 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13606 "Set up the post command hook to take a note.
13607 If this is about to TODO state change, the new state is expected in STATE.
13608 When FINDPOS is non-nil, find the correct position for the note in
13609 the current entry. If not, assume that it can be inserted at point.
13610 HOW is an indicator what kind of note should be created.
13611 EXTRA is additional text that will be inserted into the notes buffer."
13612 (org-with-wide-buffer
13614 (goto-char (org-log-beginning t))
13615 (unless org-log-states-order-reversed
13616 (org-skip-over-state-notes)
13617 (skip-chars-backward " \t\n\r")
13619 (move-marker org-log-note-marker (point))
13620 ;; Preserve position even if a property drawer is inserted in the
13622 (set-marker-insertion-type org-log-note-marker t)
13623 (setq org-log-note-purpose purpose
13624 org-log-note-state state
13625 org-log-note-previous-state prev-state
13626 org-log-note-how how
13627 org-log-note-extra extra
13628 org-log-note-effective-time (org-current-effective-time))
13629 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13631 (defun org-skip-over-state-notes ()
13632 "Skip past the list of State notes in an entry."
13633 (when (ignore-errors (goto-char (org-in-item-p)))
13634 (let* ((struct (org-list-struct))
13635 (prevs (org-list-prevs-alist struct))
13637 (concat "[ \t]*- +"
13638 (replace-regexp-in-string
13640 (org-replace-escapes
13641 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13642 `(("%d" . ,org-ts-regexp-inactive)
13643 ("%D" . ,org-ts-regexp)
13644 ("%s" . "\"\\S-+\"")
13645 ("%S" . "\"\\S-+\"")
13646 ("%t" . ,org-ts-regexp-inactive)
13647 ("%T" . ,org-ts-regexp)
13649 ("%U" . ".*?")))))))
13650 (while (org-looking-at-p regexp)
13651 (goto-char (or (org-list-get-next-item (point) struct prevs)
13652 (org-list-get-item-end (point) struct)))))))
13654 (defun org-add-log-note (&optional purpose)
13655 "Pop up a window for taking a note, and add this note later at point."
13656 (remove-hook 'post-command-hook 'org-add-log-note)
13657 (setq org-log-note-window-configuration (current-window-configuration))
13658 (delete-other-windows)
13659 (move-marker org-log-note-return-to (point))
13660 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13661 (goto-char org-log-note-marker)
13662 (org-switch-to-buffer-other-window "*Org Note*")
13664 (if (memq org-log-note-how '(time state))
13665 (let (current-prefix-arg) (org-store-log-note))
13666 (let ((org-inhibit-startup t)) (org-mode))
13667 (insert (format "# Insert note for %s.
13668 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13670 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13671 ((eq org-log-note-purpose 'done) "closed todo item")
13672 ((eq org-log-note-purpose 'state)
13673 (format "state change from \"%s\" to \"%s\""
13674 (or org-log-note-previous-state "")
13675 (or org-log-note-state "")))
13676 ((eq org-log-note-purpose 'reschedule)
13678 ((eq org-log-note-purpose 'delschedule)
13679 "no longer scheduled")
13680 ((eq org-log-note-purpose 'redeadline)
13681 "changing deadline")
13682 ((eq org-log-note-purpose 'deldeadline)
13683 "removing deadline")
13684 ((eq org-log-note-purpose 'refile)
13686 ((eq org-log-note-purpose 'note)
13688 (t (error "This should not happen")))))
13689 (if org-log-note-extra (insert org-log-note-extra))
13690 (org-set-local 'org-finish-function 'org-store-log-note)
13691 (run-hooks 'org-log-buffer-setup-hook)))
13693 (defvar org-note-abort nil) ; dynamically scoped
13694 (defun org-store-log-note ()
13695 "Finish taking a log note, and insert it to where it belongs."
13696 (let ((txt (buffer-string)))
13697 (kill-buffer (current-buffer))
13698 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13699 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13700 (setq txt (replace-match "" t t txt)))
13701 (if (string-match "\\s-+\\'" txt)
13702 (setq txt (replace-match "" t t txt)))
13703 (setq lines (org-split-string txt "\n"))
13704 (when (and note (string-match "\\S-" note))
13706 (org-replace-escapes
13708 (list (cons "%u" (user-login-name))
13709 (cons "%U" user-full-name)
13710 (cons "%t" (format-time-string
13711 (org-time-stamp-format 'long 'inactive)
13712 org-log-note-effective-time))
13713 (cons "%T" (format-time-string
13714 (org-time-stamp-format 'long nil)
13715 org-log-note-effective-time))
13716 (cons "%d" (format-time-string
13717 (org-time-stamp-format nil 'inactive)
13718 org-log-note-effective-time))
13719 (cons "%D" (format-time-string
13720 (org-time-stamp-format nil nil)
13721 org-log-note-effective-time))
13722 (cons "%s" (if org-log-note-state
13723 (concat "\"" org-log-note-state "\"")
13725 (cons "%S" (if org-log-note-previous-state
13726 (concat "\"" org-log-note-previous-state "\"")
13728 (when lines (setq note (concat note " \\\\")))
13730 (when (or current-prefix-arg org-note-abort)
13731 (when (org-log-into-drawer)
13732 (org-remove-empty-drawer-at org-log-note-marker))
13735 (with-current-buffer (marker-buffer org-log-note-marker)
13736 (org-with-wide-buffer
13737 (goto-char org-log-note-marker)
13738 (move-marker org-log-note-marker nil)
13739 ;; Make sure point is at the beginning of an empty line.
13740 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13741 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13742 ;; In an existing list, add a new item at the top level.
13743 ;; Otherwise, indent line like a regular one.
13744 (let ((itemp (org-in-item-p)))
13746 (org-indent-line-to
13747 (let ((struct (save-excursion
13748 (goto-char itemp) (org-list-struct))))
13749 (org-list-get-ind (org-list-get-top-point struct) struct)))
13750 (org-indent-line)))
13751 (insert (org-list-bullet-string "-") (pop lines))
13752 (let ((ind (org-list-item-body-column (line-beginning-position))))
13753 (dolist (line lines)
13755 (org-indent-line-to ind)
13757 (message "Note stored")
13758 (org-back-to-heading t)
13759 (org-cycle-hide-drawers 'children))
13760 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13761 ;; from within `org-add-log-note' because `buffer-undo-list'
13762 ;; is then modified outside of `org-with-remote-undo'.
13763 (when (eq this-command 'org-agenda-todo)
13764 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13765 ;; Don't add undo information when called from `org-agenda-todo'
13766 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13767 (set-window-configuration org-log-note-window-configuration)
13768 (with-current-buffer (marker-buffer org-log-note-return-to)
13769 (goto-char org-log-note-return-to))
13770 (move-marker org-log-note-return-to nil)
13771 (and org-log-post-message (message "%s" org-log-post-message))))
13773 (defun org-remove-empty-drawer-at (pos)
13774 "Remove an empty drawer at position POS.
13775 POS may also be a marker."
13776 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13777 (org-with-wide-buffer
13779 (let ((drawer (org-element-at-point)))
13780 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13781 (not (org-element-property :contents-begin drawer)))
13782 (delete-region (org-element-property :begin drawer)
13783 (progn (goto-char (org-element-property :end drawer))
13784 (skip-chars-backward " \r\t\n")
13788 (defvar org-ts-type nil)
13789 (defun org-sparse-tree (&optional arg type)
13790 "Create a sparse tree, prompt for the details.
13791 This command can create sparse trees. You first need to select the type
13792 of match used to create the tree:
13794 t Show all TODO entries.
13795 T Show entries with a specific TODO keyword.
13796 m Show entries selected by a tags/property match.
13797 p Enter a property name and its value (both with completion on existing
13798 names/values) and show entries with that property.
13799 r Show entries matching a regular expression (`/' can be used as well).
13800 b Show deadlines and scheduled items before a date.
13801 a Show deadlines and scheduled items after a date.
13802 d Show deadlines due within `org-deadline-warning-days'.
13803 D Show deadlines and scheduled items between a date range."
13805 (setq type (or type org-sparse-tree-default-date-type))
13806 (setq org-ts-type type)
13807 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13808 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13809 [c]ycle through date types: %s"
13811 (all "all timestamps")
13812 (scheduled "only scheduled")
13813 (deadline "only deadline")
13814 (active "only active timestamps")
13815 (inactive "only inactive timestamps")
13816 (closed "with a closed time-stamp")
13817 (otherwise "scheduled/deadline")))
13818 (let ((answer (read-char-exclusive)))
13824 (memq type '(nil all scheduled deadline active inactive closed)))))
13825 (?d (call-interactively 'org-check-deadlines))
13826 (?b (call-interactively 'org-check-before-date))
13827 (?a (call-interactively 'org-check-after-date))
13828 (?D (call-interactively 'org-check-dates-range))
13829 (?t (call-interactively 'org-show-todo-tree))
13830 (?T (org-show-todo-tree '(4)))
13831 (?m (call-interactively 'org-match-sparse-tree))
13833 (let* ((kwd (org-icompleting-read
13834 "Property: " (mapcar 'list (org-buffer-property-keys))))
13835 (value (org-icompleting-read
13836 "Value: " (mapcar 'list (org-property-values kwd)))))
13837 (unless (string-match "\\`{.*}\\'" value)
13838 (setq value (concat "\"" value "\"")))
13839 (org-match-sparse-tree arg (concat kwd "=" value))))
13840 ((?r ?R ?/) (call-interactively 'org-occur))
13841 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13843 (defvar org-occur-highlights nil
13844 "List of overlays used for occur matches.")
13845 (make-variable-buffer-local 'org-occur-highlights)
13846 (defvar org-occur-parameters nil
13847 "Parameters of the active org-occur calls.
13848 This is a list, each call to org-occur pushes as cons cell,
13849 containing the regular expression and the callback, onto the list.
13850 The list can contain several entries if `org-occur' has been called
13851 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13852 will only contain one set of parameters. When the highlights are
13853 removed (for example with `C-c C-c', or with the next edit (depending
13854 on `org-remove-highlights-with-change'), this variable is emptied
13856 (make-variable-buffer-local 'org-occur-parameters)
13858 (defun org-occur (regexp &optional keep-previous callback)
13859 "Make a compact tree which shows all matches of REGEXP.
13860 The tree will show the lines where the regexp matches, and all higher
13861 headlines above the match. It will also show the heading after the match,
13862 to make sure editing the matching entry is easy.
13863 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13864 call to `org-occur' will be kept, to allow stacking of calls to this
13866 If CALLBACK is non-nil, it is a function which is called to confirm
13867 that the match should indeed be shown."
13868 (interactive "sRegexp: \nP")
13869 (when (equal regexp "")
13870 (user-error "Regexp cannot be empty"))
13871 (unless keep-previous
13872 (org-remove-occur-highlights nil nil t))
13873 (push (cons regexp callback) org-occur-parameters)
13876 (goto-char (point-min))
13877 (if (or (not keep-previous) ; do not want to keep
13878 (not org-occur-highlights)) ; no previous matches
13881 (while (re-search-forward regexp nil t)
13882 (when (or (not callback)
13883 (save-match-data (funcall callback)))
13884 (setq cnt (1+ cnt))
13885 (when org-highlight-sparse-tree-matches
13886 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13887 (org-show-context 'occur-tree))))
13888 (when org-remove-highlights-with-change
13889 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13891 (unless org-sparse-tree-open-archived-trees
13892 (org-hide-archived-subtrees (point-min) (point-max)))
13893 (run-hooks 'org-occur-hook)
13894 (if (org-called-interactively-p 'interactive)
13895 (message "%d match(es) for regexp %s" cnt regexp))
13898 (defun org-occur-next-match (&optional n reset)
13899 "Function for `next-error-function' to find sparse tree matches.
13900 N is the number of matches to move, when negative move backwards.
13901 RESET is entirely ignored - this function always goes back to the
13902 starting point when no match is found."
13903 (let* ((limit (if (< n 0) (point-min) (point-max)))
13904 (search-func (if (< n 0)
13905 'previous-single-char-property-change
13906 'next-single-char-property-change))
13911 (while (setq p1 (funcall search-func (point) 'org-type))
13912 (when (equal p1 limit)
13914 (user-error "No more matches"))
13915 (when (equal (get-char-property p1 'org-type) 'org-occur)
13919 (throw 'exit (point))))
13922 (user-error "No more matches"))))
13924 (defun org-show-context (&optional key)
13925 "Make sure point and context are visible.
13926 Optional argument KEY, when non-nil, is a symbol. See
13927 `org-show-context-detail' for allowed values and how much is to
13929 (org-show-set-visibility
13930 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13931 ((cdr (assq key org-show-context-detail)))
13932 (t (cdr (assq 'default org-show-context-detail))))))
13934 (defun org-show-set-visibility (detail)
13935 "Set visibility around point according to DETAIL.
13936 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13937 `tree', `canonical' or t. See `org-show-context-detail' for more
13939 (unless (org-before-first-heading-p)
13940 ;; Show current heading and possibly its entry, following headline
13941 ;; or all children.
13942 (if (and (org-at-heading-p) (not (eq detail 'local)))
13943 (org-flag-heading nil)
13945 (org-with-limited-levels
13947 ((tree canonical t) (show-children))
13948 ((nil minimal ancestors))
13950 (outline-next-heading)
13951 (org-flag-heading nil))))))
13952 ;; Show all siblings.
13953 (when (eq detail 'lineage) (org-show-siblings))
13954 ;; Show ancestors, possibly with their children.
13955 (when (memq detail '(ancestors lineage tree canonical t))
13957 (while (org-up-heading-safe)
13958 (org-flag-heading nil)
13959 (when (memq detail '(canonical t)) (org-show-entry))
13960 (when (memq detail '(tree canonical t)) (show-children)))))))
13962 (defvar org-reveal-start-hook nil
13963 "Hook run before revealing a location.")
13965 (defun org-reveal (&optional siblings)
13966 "Show current entry, hierarchy above it, and the following headline.
13968 This can be used to show a consistent set of context around
13969 locations exposed with `org-show-context'.
13971 With optional argument SIBLINGS, on each level of the hierarchy all
13972 siblings are shown. This repairs the tree structure to what it would
13973 look like when opened with hierarchical calls to `org-cycle'.
13975 With double optional argument \\[universal-argument] \\[universal-argument], \
13976 go to the parent and show the
13979 (run-hooks 'org-reveal-start-hook)
13980 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
13981 ((equal siblings '(16))
13983 (when (org-up-heading-safe)
13985 (run-hook-with-args 'org-cycle-hook 'subtree))))
13986 (t (org-show-set-visibility 'lineage))))
13988 (defun org-highlight-new-match (beg end)
13989 "Highlight from BEG to END and mark the highlight is an occur headline."
13990 (let ((ov (make-overlay beg end)))
13991 (overlay-put ov 'face 'secondary-selection)
13992 (overlay-put ov 'org-type 'org-occur)
13993 (push ov org-occur-highlights)))
13995 (defun org-remove-occur-highlights (&optional beg end noremove)
13996 "Remove the occur highlights from the buffer.
13997 BEG and END are ignored. If NOREMOVE is nil, remove this function
13998 from the `before-change-functions' in the current buffer."
14000 (unless org-inhibit-highlight-removal
14001 (mapc 'delete-overlay org-occur-highlights)
14002 (setq org-occur-highlights nil)
14003 (setq org-occur-parameters nil)
14005 (remove-hook 'before-change-functions
14006 'org-remove-occur-highlights 'local))))
14010 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14011 "Regular expression matching the priority indicator.")
14013 (defvar org-remove-priority-next-time nil)
14015 (defun org-priority-up ()
14016 "Increase the priority of the current item."
14018 (org-priority 'up))
14020 (defun org-priority-down ()
14021 "Decrease the priority of the current item."
14023 (org-priority 'down))
14025 (defun org-priority (&optional action show)
14026 "Change the priority of an item.
14027 ACTION can be `set', `up', `down', or a character."
14029 (if (equal action '(4))
14030 (org-show-priority)
14031 (unless org-enable-priority-commands
14032 (user-error "Priority commands are disabled"))
14033 (setq action (or action 'set))
14034 (let (current new news have remove)
14036 (org-back-to-heading t)
14037 (if (looking-at org-priority-regexp)
14038 (setq current (string-to-char (match-string 2))
14041 ((eq action 'remove)
14042 (setq remove t new ?\ ))
14043 ((or (eq action 'set)
14044 (if (featurep 'xemacs) (characterp action) (integerp action)))
14045 (if (not (eq action 'set))
14047 (message "Priority %c-%c, SPC to remove: "
14048 org-highest-priority org-lowest-priority)
14050 (setq new (read-char-exclusive))))
14051 (if (and (= (upcase org-highest-priority) org-highest-priority)
14052 (= (upcase org-lowest-priority) org-lowest-priority))
14053 (setq new (upcase new)))
14054 (cond ((equal new ?\ ) (setq remove t))
14055 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14056 (user-error "Priority must be between `%c' and `%c'"
14057 org-highest-priority org-lowest-priority))))
14060 (1- current) ; normal cycling
14061 ;; last priority was empty
14062 (if (eq last-command this-command)
14063 org-lowest-priority ; wrap around empty to lowest
14065 (if org-priority-start-cycle-with-default
14066 org-default-priority
14067 (1- org-default-priority))))))
14070 (1+ current) ; normal cycling
14071 ;; last priority was empty
14072 (if (eq last-command this-command)
14073 org-highest-priority ; wrap around empty to highest
14075 (if org-priority-start-cycle-with-default
14076 org-default-priority
14077 (1+ org-default-priority))))))
14078 (t (user-error "Invalid action")))
14079 (if (or (< (upcase new) org-highest-priority)
14080 (> (upcase new) org-lowest-priority))
14081 (if (and (memq action '(up down))
14082 (not have) (not (eq last-command this-command)))
14083 ;; `new' is from default priority
14085 "The default can not be set, see `org-default-priority' why")
14086 ;; normal cycling: `new' is beyond highest/lowest priority
14087 ;; and is wrapped around to the empty priority
14089 (setq news (format "%c" new))
14092 (replace-match "" t t nil 1)
14093 (replace-match news t t nil 2))
14095 (user-error "No priority cookie found in line")
14096 (let ((case-fold-search nil))
14097 (looking-at org-todo-line-regexp))
14100 (goto-char (match-end 2))
14101 (insert " [#" news "]"))
14102 (goto-char (match-beginning 3))
14103 (insert "[#" news "] "))))
14104 (org-set-tags nil 'align))
14106 (message "Priority removed")
14107 (message "Priority of current item set to %s" news)))))
14109 (defun org-show-priority ()
14110 "Show the priority of the current item.
14111 This priority is composed of the main priority given with the [#A] cookies,
14112 and by additional input from the age of a schedules or deadline entry."
14114 (let ((pri (if (eq major-mode 'org-agenda-mode)
14115 (org-get-at-bol 'priority)
14118 (beginning-of-line)
14119 (and (looking-at org-heading-regexp)
14120 (org-get-priority (match-string 0))))))))
14121 (message "Priority is %d" (if pri pri -1000))))
14123 (defun org-get-priority (s)
14124 "Find priority cookie and return priority."
14126 (if (functionp org-get-priority-function)
14127 (funcall org-get-priority-function)
14128 (if (not (string-match org-priority-regexp s))
14129 (* 1000 (- org-lowest-priority org-default-priority))
14130 (* 1000 (- org-lowest-priority
14131 (string-to-char (match-string 2 s))))))))
14135 (defvar org-agenda-archives-mode)
14136 (defvar org-map-continue-from nil
14137 "Position from where mapping should continue.
14138 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14140 (defvar org-scanner-tags nil
14141 "The current tag list while the tags scanner is running.")
14142 (defvar org-trust-scanner-tags nil
14143 "Should `org-get-tags-at' use the tags for the scanner.
14144 This is for internal dynamical scoping only.
14145 When this is non-nil, the function `org-get-tags-at' will return the value
14146 of `org-scanner-tags' instead of building the list by itself. This
14147 can lead to large speed-ups when the tags scanner is used in a file with
14148 many entries, and when the list of tags is retrieved, for example to
14149 obtain a list of properties. Building the tags list for each entry in such
14150 a file becomes an N^2 operation - but with this variable set, it scales
14153 (defun org-scan-tags (action matcher todo-only &optional start-level)
14154 "Scan headline tags with inheritance and produce output ACTION.
14156 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14157 or `agenda' to produce an entry list for an agenda view. It can also be
14158 a Lisp form or a function that should be called at each matched headline, in
14159 this case the return value is a list of all return values from these calls.
14161 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14162 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14163 only lines with a not-done TODO keyword are included in the output.
14164 This should be the same variable that was scoped into
14165 and set by `org-make-tags-matcher' when it constructed MATCHER.
14167 START-LEVEL can be a string with asterisks, reducing the scope to
14168 headlines matching this string."
14169 (require 'org-agenda)
14170 (let* ((re (concat "^"
14172 ;; Get the correct level to match
14173 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14174 org-outline-regexp)
14176 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14177 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14178 (props (list 'face 'default
14179 'done-face 'org-agenda-done
14180 'undone-face 'default
14181 'mouse-face 'highlight
14182 'org-not-done-regexp org-not-done-regexp
14183 'org-todo-regexp org-todo-regexp
14184 'org-complex-heading-regexp org-complex-heading-regexp
14186 (format "mouse-2 or RET jump to org file %s"
14187 (abbreviate-file-name
14188 (or (buffer-file-name (buffer-base-buffer))
14189 (buffer-name (buffer-base-buffer)))))))
14190 (org-map-continue-from nil)
14191 lspos tags tags-list
14192 (tags-alist (list (cons 0 org-file-tags)))
14193 (llast 0) rtn rtn1 level category i txt
14194 todo marker entry priority
14195 ts-date ts-date-type ts-date-pair)
14196 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14197 (setq action (list 'lambda nil action)))
14199 (goto-char (point-min))
14200 (when (eq action 'sparse-tree)
14202 (org-remove-occur-highlights))
14203 (while (let (case-fold-search)
14204 (re-search-forward re nil t))
14205 (setq org-map-continue-from nil)
14207 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14208 tags (if (match-end 4) (org-match-string-no-properties 4)))
14209 (goto-char (setq lspos (match-beginning 0)))
14210 (setq level (org-reduced-level (org-outline-level))
14211 category (org-get-category))
14212 (when (eq action 'agenda)
14213 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14214 ts-date (car ts-date-pair)
14215 ts-date-type (cdr ts-date-pair)))
14216 (setq i llast llast level)
14217 ;; remove tag lists from same and sublevels
14218 (while (>= i level)
14219 (when (setq entry (assoc i tags-alist))
14220 (setq tags-alist (delete entry tags-alist)))
14222 ;; add the next tags
14224 (setq tags (org-split-string tags ":")
14226 (cons (cons level tags) tags-alist)))
14227 ;; compile tags for current headline
14229 (if org-use-tag-inheritance
14230 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14232 org-scanner-tags tags-list)
14233 (when org-use-tag-inheritance
14234 (setcdr (car tags-alist)
14235 (mapcar (lambda (x)
14236 (setq x (copy-sequence x))
14237 (org-add-prop-inherited x))
14238 (cdar tags-alist))))
14239 (when (and tags org-use-tag-inheritance
14240 (or (not (eq t org-use-tag-inheritance))
14241 org-tags-exclude-from-inheritance))
14242 ;; selective inheritance, remove uninherited ones
14243 (setcdr (car tags-alist)
14244 (org-remove-uninherited-tags (cdar tags-alist))))
14247 ;; eval matcher only when the todo condition is OK
14248 (and (or (not todo-only) (member todo org-not-done-keywords))
14249 (let ((case-fold-search t) (org-trust-scanner-tags t))
14252 ;; Call the skipper, but return t if it does not skip,
14253 ;; so that the `and' form continues evaluating
14255 (unless (eq action 'sparse-tree) (org-agenda-skip))
14258 ;; Check if timestamps are deselecting this entry
14259 (or (not todo-only)
14260 (and (member todo org-not-done-keywords)
14261 (or (not org-agenda-tags-todo-honor-ignore-options)
14262 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14264 ;; select this headline
14266 ((eq action 'sparse-tree)
14267 (and org-highlight-sparse-tree-matches
14268 (org-get-heading) (match-end 0)
14269 (org-highlight-new-match
14270 (match-beginning 1) (match-end 1)))
14271 (org-show-context 'tags-tree))
14272 ((eq action 'agenda)
14273 (setq txt (org-agenda-format-item
14276 (if (eq org-tags-match-list-sublevels 'indented)
14277 (make-string (1- level) ?.) "")
14279 (make-string level ?\s)
14282 priority (org-get-priority txt))
14284 (setq marker (org-agenda-new-marker))
14285 (org-add-props txt props
14286 'org-marker marker 'org-hd-marker marker 'org-category category
14290 'type (concat "tagsmatch" ts-date-type))
14292 ((functionp action)
14293 (setq org-map-continue-from nil)
14295 (setq rtn1 (funcall action))
14297 (t (user-error "Invalid action")))
14299 ;; if we are to skip sublevels, jump to end of subtree
14300 (unless org-tags-match-list-sublevels
14301 (org-end-of-subtree t)
14302 (backward-char 1))))
14303 ;; Get the correct position from where to continue
14304 (if org-map-continue-from
14305 (goto-char org-map-continue-from)
14306 (and (= (point) lspos) (end-of-line 1)))))
14307 (when (and (eq action 'sparse-tree)
14308 (not org-sparse-tree-open-archived-trees))
14309 (org-hide-archived-subtrees (point-min) (point-max)))
14312 (defun org-remove-uninherited-tags (tags)
14313 "Remove all tags that are not inherited from the list TAGS."
14315 ((eq org-use-tag-inheritance t)
14316 (if org-tags-exclude-from-inheritance
14317 (org-delete-all org-tags-exclude-from-inheritance tags)
14319 ((not org-use-tag-inheritance) nil)
14320 ((stringp org-use-tag-inheritance)
14323 (if (and (string-match org-use-tag-inheritance x)
14324 (not (member x org-tags-exclude-from-inheritance)))
14327 ((listp org-use-tag-inheritance)
14330 (if (member x org-use-tag-inheritance) x nil))
14333 (defun org-match-sparse-tree (&optional todo-only match)
14334 "Create a sparse tree according to tags string MATCH.
14335 MATCH can contain positive and negative selection of tags, like
14336 \"+WORK+URGENT-WITHBOSS\".
14337 If optional argument TODO-ONLY is non-nil, only select lines that are
14340 (org-agenda-prepare-buffers (list (current-buffer)))
14341 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14343 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14345 (defvar org-cached-props nil)
14346 (defun org-cached-entry-get (pom property)
14347 (if (or (eq t org-use-property-inheritance)
14348 (and (stringp org-use-property-inheritance)
14349 (let ((case-fold-search t))
14350 (org-string-match-p org-use-property-inheritance property)))
14351 (and (listp org-use-property-inheritance)
14352 (member-ignore-case property org-use-property-inheritance)))
14353 ;; Caching is not possible, check it directly.
14354 (org-entry-get pom property 'inherit)
14355 ;; Get all properties, so we can do complicated checks easily.
14356 (cdr (assoc-string property
14357 (or org-cached-props
14358 (setq org-cached-props (org-entry-properties pom)))
14361 (defun org-global-tags-completion-table (&optional files)
14362 "Return the list of all tags in all agenda buffer/files.
14363 Optional FILES argument is a list of files which can be used
14364 instead of the agenda files."
14371 (set-buffer (find-file-noselect file))
14372 (append (org-get-buffer-tags)
14373 (mapcar (lambda (x) (if (stringp (car-safe x))
14374 (list (car-safe x)) nil))
14376 (if (and files (car files))
14378 (org-agenda-files))))))))
14380 (defun org-make-tags-matcher (match)
14381 "Create the TAGS/TODO matcher form for the selection string MATCH.
14383 The variable `todo-only' is scoped dynamically into this function.
14384 It will be set to t if the matcher restricts matching to TODO entries,
14385 otherwise will not be touched.
14387 Returns a cons of the selection string MATCH and the constructed
14388 lisp form implementing the matcher. The matcher is to be evaluated
14389 at an Org entry, with point on the headline, and returns t if the
14390 entry matches the selection string MATCH. The returned lisp form
14391 references two variables with information about the entry, which
14392 must be bound around the form's evaluation: todo, the TODO keyword
14393 at the entry (or nil of none); and tags-list, the list of all tags
14394 at the entry including inherited ones. Additionally, the category
14395 of the entry (if any) must be specified as the text property
14396 'org-category on the headline.
14398 See also `org-scan-tags'.
14400 (declare (special todo-only))
14401 (unless (boundp 'todo-only)
14402 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14404 ;; Get a new match request, with completion against the global
14405 ;; tags table and the local tags in current buffer
14406 (let ((org-last-tags-completion-table
14408 (delq nil (append (org-get-buffer-tags)
14409 (org-global-tags-completion-table))))))
14410 (setq match (org-completing-read-no-i
14411 "Match: " 'org-tags-completion-function nil nil nil
14412 'org-tags-history))))
14414 ;; Parse the string and create a lisp form
14415 (let ((match0 match)
14416 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14418 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14419 orterms term orlist re-p str-p level-p level-op time-p
14420 prop-p pn pv po gv rest (start 0) (ss 0))
14421 ;; Expand group tags
14422 (setq match (org-tags-expand match))
14424 ;; Check if there is a TODO part of this match, which would be the
14425 ;; part after a "/". TO make sure that this slash is not part of
14426 ;; a property value to be matched against, we also check that there
14427 ;; is no " after that slash.
14428 ;; First, find the last slash
14429 (while (string-match "/+" match ss)
14430 (setq start (match-beginning 0) ss (match-end 0)))
14431 (if (and (string-match "/+" match start)
14432 (not (save-match-data (string-match "\"" match start))))
14433 ;; match contains also a todo-matching request
14435 (setq tagsmatch (substring match 0 (match-beginning 0))
14436 todomatch (substring match (match-end 0)))
14437 (if (string-match "^!" todomatch)
14438 (setq todo-only t todomatch (substring todomatch 1)))
14439 (if (string-match "^\\s-*$" todomatch)
14440 (setq todomatch nil)))
14441 ;; only matching tags
14442 (setq tagsmatch match todomatch nil))
14444 ;; Make the tags matcher
14445 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14446 (setq tagsmatcher t)
14447 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14448 (while (setq term (pop orterms))
14449 (while (and (equal (substring term -1) "\\") orterms)
14450 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14451 (while (string-match re term)
14452 (setq rest (substring term (match-end 0))
14453 minus (and (match-end 1)
14454 (equal (match-string 1 term) "-"))
14455 tag (save-match-data (replace-regexp-in-string
14457 (match-string 2 term)))
14458 re-p (equal (string-to-char tag) ?{)
14459 level-p (match-end 4)
14460 prop-p (match-end 5)
14462 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14464 (setq level-op (org-op-to-function (match-string 3 term)))
14465 `(,level-op level ,(string-to-number
14466 (match-string 4 term))))
14468 (setq pn (match-string 5 term)
14469 po (match-string 6 term)
14470 pv (match-string 7 term)
14471 re-p (equal (string-to-char pv) ?{)
14472 str-p (equal (string-to-char pv) ?\")
14473 time-p (save-match-data
14474 (string-match "^\"[[<].*[]>]\"$" pv))
14475 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14476 (if time-p (setq pv (org-matcher-time pv)))
14477 (setq po (org-op-to-function po (if time-p 'time str-p)))
14479 ((equal pn "CATEGORY")
14480 (setq gv '(get-text-property (point) 'org-category)))
14484 (setq gv `(org-cached-entry-get nil ,pn))))
14487 `(not (string-match ,pv (or ,gv "")))
14488 `(string-match ,pv (or ,gv "")))
14490 `(,po (or ,gv "") ,pv)
14491 `(,po (string-to-number (or ,gv ""))
14492 ,(string-to-number pv) ))))
14493 (t `(member ,tag tags-list)))
14494 mm (if minus (list 'not mm) mm)
14496 (push mm tagsmatcher))
14497 (push (if (> (length tagsmatcher) 1)
14498 (cons 'and tagsmatcher)
14501 (setq tagsmatcher nil))
14502 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14504 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14505 ;; Make the todo matcher
14506 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14507 (setq todomatcher t)
14508 (setq orterms (org-split-string todomatch "|") orlist nil)
14509 (while (setq term (pop orterms))
14510 (while (string-match re term)
14511 (setq minus (and (match-end 1)
14512 (equal (match-string 1 term) "-"))
14513 kwd (match-string 2 term)
14514 re-p (equal (string-to-char kwd) ?{)
14515 term (substring term (match-end 0))
14517 `(string-match ,(substring kwd 1 -1) todo)
14518 (list 'equal 'todo kwd))
14519 mm (if minus (list 'not mm) mm))
14520 (push mm todomatcher))
14521 (push (if (> (length todomatcher) 1)
14522 (cons 'and todomatcher)
14525 (setq todomatcher nil))
14526 (setq todomatcher (if (> (length orlist) 1)
14527 (cons 'or orlist) (car orlist))))
14529 ;; Return the string and lisp forms of the matcher
14530 (setq matcher (if todomatcher
14531 (list 'and tagsmatcher todomatcher)
14534 (setq matcher (list 'and '(member todo org-not-done-keywords)
14536 (cons match0 matcher)))
14538 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14539 "Expand group tags in MATCH.
14541 This replaces every group tag in MATCH with a regexp tag search.
14542 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14543 will be replaced like this:
14545 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14546 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14547 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14549 Replacing by a regexp preserves the structure of the match.
14550 E.g., this expansion
14552 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14554 will match anything tagged with \"Lab\" and \"Home\", or tagged
14555 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14557 A group tag in MATCH can contain regular expressions of its own.
14558 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14559 will be replaced like this:
14561 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14563 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14564 assumed to be a single group tag, and the function will return
14565 the list of tags in this group.
14567 When DOWNCASE is non-nil, expand downcased TAGS."
14569 (let* ((case-fold-search t)
14570 (stable org-mode-syntax-table)
14571 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14572 (taggroups (if downcased
14573 (mapcar (lambda (tg) (mapcar #'downcase tg))
14576 (taggroups-keys (mapcar #'car taggroups))
14577 (return-match (if downcased (downcase match) match))
14579 (work-already-expanded tags-already-expanded)
14580 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14581 ;; @ and _ are allowed as word-components in tags.
14582 (modify-syntax-entry ?@ "w" stable)
14583 (modify-syntax-entry ?_ "w" stable)
14584 ;; Temporarily replace regexp-expressions in the match-expression.
14585 (while (string-match "{.+?}" return-match)
14587 (push (match-string 0 return-match) regexps-in-match)
14588 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14589 (while (and taggroups-keys
14590 (with-syntax-table stable
14592 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14593 (regexp-opt taggroups-keys) "\\>\\)") return-match)))
14594 (let* ((dir (match-string 1 return-match))
14595 (tag (match-string 2 return-match))
14596 (tag (if downcased (downcase tag) tag)))
14597 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14598 (member tag work-already-expanded))
14599 (setq tags-in-group (assoc tag taggroups))
14600 (push tag work-already-expanded)
14601 ;; Recursively expand each tag in the group, if the tag hasn't
14602 ;; already been expanded. Restore the match-data after all recursive calls.
14604 (let (tags-expanded)
14605 (dolist (x (cdr tags-in-group))
14606 (if (and (member x taggroups-keys)
14607 (not (member x work-already-expanded)))
14608 (setq tags-expanded
14611 (org-tags-expand x t downcased
14612 work-already-expanded)
14614 (setq tags-expanded
14615 (append (list x) tags-expanded)))
14616 (setq work-already-expanded
14618 (append tags-expanded
14619 work-already-expanded))))
14620 (setq tags-in-group
14621 (delete-dups (cons (car tags-in-group)
14623 ;; Filter tag-regexps from tags.
14624 (setq regexp-in-group-escaped
14625 (delq nil (mapcar (lambda (x)
14627 (and (equal "{" (substring x 0 1))
14628 (equal "}" (substring x -1))
14633 (mapcar (lambda (x)
14634 (substring x 1 -1))
14635 regexp-in-group-escaped)
14637 (delq nil (mapcar (lambda (x)
14639 (and (not (equal "{" (substring x 0 1)))
14640 (not (equal "}" (substring x -1)))
14644 ;; If single-as-list, do no more in the while-loop.
14645 (if (not single-as-list)
14647 (when regexp-in-group
14648 (setq regexp-in-group
14650 (mapconcat 'identity regexp-in-group
14652 (setq tags-in-group
14655 (regexp-opt tags-in-group)
14659 (when (stringp tags-in-group)
14660 (org-add-props tags-in-group '(grouptag t)))
14662 (replace-match tags-in-group t t return-match)))
14663 (setq tags-in-group
14664 (append regexp-in-group-escaped tags-in-group))))
14665 (setq taggroups-keys (delete tag taggroups-keys))))
14666 ;; Add the regular expressions back into the match-expression again.
14667 (while regexps-in-match
14668 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14669 (pop regexps-in-match)
14673 (if tags-in-group tags-in-group (list return-match))
14676 (list (if downcased (downcase match) match))
14679 (defun org-op-to-function (op &optional stringp)
14680 "Turn an operator into the appropriate function."
14683 ((equal op "<" ) '(< string< org-time<))
14684 ((equal op ">" ) '(> org-string> org-time>))
14685 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14686 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14687 ((member op '("=" "==")) '(= string= org-time=))
14688 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14689 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14691 (defun org<> (a b) (not (= a b)))
14692 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14693 (defun org-string>= (a b) (not (string< a b)))
14694 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14695 (defun org-string<> (a b) (not (string= a b)))
14696 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14697 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14698 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14699 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14700 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14701 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14703 "Convert S to a floating point time.
14704 If S is already a number, just return it. If it is a string, parse
14705 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14709 (condition-case nil
14710 (float-time (apply 'encode-time (org-parse-time-string s)))
14714 (defun org-time-today ()
14715 "Time in seconds today at 0:00.
14716 Returns the float number of seconds since the beginning of the
14717 epoch to the beginning of today (00:00)."
14718 (float-time (apply 'encode-time
14719 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14721 (defun org-matcher-time (s)
14722 "Interpret a time comparison value."
14725 ((string= s "<now>") (float-time))
14726 ((string= s "<today>") (org-time-today))
14727 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14728 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14729 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14730 (+ (org-time-today)
14731 (* (string-to-number (match-string 1 s))
14732 (cdr (assoc (match-string 2 s)
14733 '(("d" . 86400.0) ("w" . 604800.0)
14734 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14737 (defun org-match-any-p (re list)
14738 "Does re match any element of list?"
14739 (setq list (mapcar (lambda (x) (string-match re x)) list))
14742 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14743 (defvar org-tags-overlay (make-overlay 1 1))
14744 (org-detach-overlay org-tags-overlay)
14746 (defun org-get-local-tags-at (&optional pos)
14747 "Get a list of tags defined in the current headline."
14748 (org-get-tags-at pos 'local))
14750 (defun org-get-local-tags ()
14751 "Get a list of tags defined in the current headline."
14752 (org-get-tags-at nil 'local))
14754 (defun org-get-tags-at (&optional pos local)
14755 "Get a list of all headline tags applicable at POS.
14756 POS defaults to point. If tags are inherited, the list contains
14757 the targets in the same sequence as the headlines appear, i.e.
14758 the tags of the current headline come last.
14759 When LOCAL is non-nil, only return tags from the current headline,
14760 ignore inherited ones."
14762 (if (and org-trust-scanner-tags
14763 (or (not pos) (equal pos (point)))
14766 (let (tags ltags lastpos parent)
14770 (goto-char (or pos (point)))
14773 (condition-case nil
14775 (org-back-to-heading t)
14776 (while (not (equal lastpos (point)))
14777 (setq lastpos (point))
14779 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14780 (setq ltags (org-split-string
14781 (org-match-string-no-properties 1) ":"))
14783 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14786 (org-remove-uninherited-tags ltags)
14789 (or org-use-tag-inheritance (throw 'done t))
14790 (if local (throw 'done t))
14791 (or (org-up-heading-safe) (error nil))
14796 (reverse (delete-dups
14798 (org-remove-uninherited-tags
14799 org-file-tags) tags)))))))))
14801 (defun org-add-prop-inherited (s)
14802 (add-text-properties 0 (length s) '(inherited t) s)
14805 (defun org-toggle-tag (tag &optional onoff)
14806 "Toggle the tag TAG for the current line.
14807 If ONOFF is `on' or `off', don't toggle but set to this state."
14810 (org-back-to-heading t)
14811 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14814 (setq current (match-string 1))
14815 (replace-match ""))
14817 (setq current (nreverse (org-split-string current ":")))
14821 (or (member tag current) (push tag current)))
14823 (or (not (member tag current)) (setq current (delete tag current))))
14824 (t (if (member tag current)
14825 (setq current (delete tag current))
14827 (push tag current))))
14831 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14832 (org-set-tags nil t))
14833 (delete-horizontal-space))
14834 (run-hooks 'org-after-tags-change-hook))
14837 (defun org-align-tags-here (to-col)
14838 ;; Assumes that this is a headline
14839 "Align tags on the current headline to TO-COL."
14840 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14841 (beginning-of-line 1)
14842 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14843 (< pos (match-beginning 2)))
14845 (setq tags-l (- (match-end 2) (match-beginning 2)))
14846 (goto-char (match-beginning 1))
14848 (delete-region (point) (1+ (match-beginning 2)))
14849 (setq ncol (max (current-column)
14853 (- (abs to-col) tags-l))))
14855 (insert (make-string (- ncol (current-column)) ?\ ))
14856 (setq ncol (current-column))
14857 (when indent-tabs-mode (tabify p (point-at-eol)))
14858 (org-move-to-column (min ncol col)))
14861 (defun org-set-tags-command (&optional arg just-align)
14862 "Call the set-tags command for the current entry."
14864 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14865 (org-set-tags arg just-align)
14867 (unless (and (org-region-active-p)
14868 org-loop-over-headlines-in-active-region)
14869 (org-back-to-heading t))
14870 (org-set-tags arg just-align))))
14872 (defun org-set-tags-to (data)
14873 "Set the tags of the current entry to DATA, replacing the current tags.
14874 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14875 If DATA is nil or the empty string, any tags will be removed."
14876 (interactive "sTags: ")
14880 ((equal data "") "")
14882 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14885 (concat ":" (mapconcat 'identity data ":") ":"))))
14888 (org-back-to-heading t)
14889 (when (looking-at org-complex-heading-regexp)
14892 (goto-char (match-beginning 5))
14894 (delete-region (point) (point-at-eol))
14895 (org-set-tags nil 'align))
14896 (goto-char (point-at-eol))
14898 (org-set-tags nil 'align)))
14899 (beginning-of-line 1)
14900 (if (looking-at ".*?\\([ \t]+\\)$")
14901 (delete-region (match-beginning 1) (match-end 1))))))
14903 (defun org-align-all-tags ()
14904 "Align the tags i all headings."
14907 (or (ignore-errors (org-back-to-heading t))
14908 (outline-next-heading))
14909 (if (org-at-heading-p)
14911 (message "No headings"))))
14913 (defvar org-indent-indentation-per-level)
14914 (defun org-set-tags (&optional arg just-align)
14915 "Set the tags for the current headline.
14916 With prefix ARG, realign all tags in headings in the current buffer.
14917 When JUST-ALIGN is non-nil, only align tags."
14919 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14920 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14921 'region-start-level 'region))
14922 org-loop-over-headlines-in-active-region)
14924 ;; We don't use ARG and JUST-ALIGN here because these args
14925 ;; are not useful when looping over headlines.
14927 org-loop-over-headlines-in-active-region
14928 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14929 (let* ((re org-outline-regexp-bol)
14930 (current (unless arg (org-get-tags-string)))
14931 (col (current-column))
14932 (org-setting-tags t)
14933 table current-tags inherited-tags ; computed below when needed
14934 tags p0 c0 c1 rpl di tc level)
14937 (goto-char (point-min))
14938 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14939 (while (re-search-forward re nil t)
14940 (org-set-tags nil t)
14942 (message "All tags realigned to column %d" org-tags-column))
14944 (setq tags current)
14945 ;; Get a new set of tags from the user
14947 (setq table (append org-tag-persistent-alist
14948 (or org-tag-alist (org-get-buffer-tags))
14950 org-complete-tags-always-offer-all-agenda-tags
14951 (org-global-tags-completion-table
14952 (org-agenda-files))))
14953 org-last-tags-completion-table table
14954 current-tags (org-split-string current ":")
14955 inherited-tags (nreverse
14956 (nthcdr (length current-tags)
14957 (nreverse (org-get-tags-at))))
14959 (if (or (eq t org-use-fast-tag-selection)
14960 (and org-use-fast-tag-selection
14961 (delq nil (mapcar 'cdr table))))
14962 (org-fast-tag-selection
14963 current-tags inherited-tags table
14964 (if org-fast-tag-selection-include-todo
14965 org-todo-key-alist))
14966 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14968 (org-icompleting-read "Tags: "
14969 'org-tags-completion-function
14970 nil nil current 'org-tags-history))))))
14971 (while (string-match "[-+&]+" tags)
14972 ;; No boolean logic, just a list
14973 (setq tags (replace-match ":" t t tags))))
14975 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14977 (if org-tags-sort-function
14978 (setq tags (mapconcat 'identity
14979 (sort (org-split-string
14980 tags (org-re "[^[:alnum:]_@#%]+"))
14981 org-tags-sort-function) ":")))
14983 (if (string-match "\\`[\t ]*\\'" tags)
14985 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14986 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14988 ;; Insert new tags at the correct column
14989 (beginning-of-line 1)
14990 (setq level (or (and (looking-at org-outline-regexp)
14991 (- (match-end 0) (point) 1))
14994 ((and (equal current "") (equal tags "")))
14995 ((re-search-forward
14996 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14998 (if (equal tags "")
15000 (goto-char (match-beginning 0))
15001 (setq c0 (current-column)
15002 ;; compute offset for the case of org-indent-mode active
15003 di (if (org-bound-and-true-p org-indent-mode)
15004 (* (1- org-indent-indentation-per-level) (1- level))
15006 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
15007 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
15008 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
15009 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15010 (replace-match rpl t t)
15011 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15013 (t (error "Tags alignment failed")))
15014 (org-move-to-column col)
15016 (run-hooks 'org-after-tags-change-hook))))))
15018 (defun org-change-tag-in-region (beg end tag off)
15019 "Add or remove TAG for each entry in the region.
15020 This works in the agenda, and also in an org-mode buffer."
15022 (list (region-beginning) (region-end)
15023 (let ((org-last-tags-completion-table
15024 (if (derived-mode-p 'org-mode)
15026 (delq nil (append (org-get-buffer-tags)
15027 (org-global-tags-completion-table))))
15028 (org-global-tags-completion-table))))
15029 (org-icompleting-read
15030 "Tag: " 'org-tags-completion-function nil nil nil
15031 'org-tags-history))
15033 (message "[s]et or
[r]emove? ")
15034 (equal (read-char-exclusive) ?r))))
15035 (if (fboundp 'deactivate-mark) (deactivate-mark))
15036 (let ((agendap (equal major-mode 'org-agenda-mode))
15037 l1 l2 m buf pos newhead (cnt 0))
15039 (setq l2 (1- (org-current-line)))
15041 (setq l1 (org-current-line))
15042 (loop for l from l1 to l2 do
15044 (setq m (get-text-property (point) 'org-hd-marker))
15045 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15047 (setq buf (if agendap (marker-buffer m) (current-buffer))
15048 pos (if agendap m (point)))
15049 (with-current-buffer buf
15053 (setq cnt (1+ cnt))
15054 (org-toggle-tag tag (if off 'off 'on))
15055 (setq newhead (org-get-heading)))))
15056 (and agendap (org-agenda-change-all-lines newhead m))))
15057 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15059 (defun org-tags-completion-function (string predicate &optional flag)
15060 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15061 (confirm (lambda (x) (stringp (car x)))))
15062 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15063 (setq s1 (match-string 1 string)
15064 s2 (match-string 2 string))
15065 (setq s1 "" s2 string))
15069 (setq rtn (try-completion s2 ctable confirm))
15072 (concat s1 s2 (substring rtn (length s2))
15073 (if (and org-add-colon-after-tag-completion
15074 (assoc rtn ctable))
15079 (all-completions s2 ctable confirm))
15082 (assoc s2 ctable)))))
15084 (defun org-fast-tag-insert (kwd tags face &optional end)
15085 "Insert KDW, and the TAGS, the latter with face FACE.
15087 (insert (format "%-12s" (concat kwd ":"))
15088 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15091 (defun org-fast-tag-show-exit (flag)
15094 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15095 (replace-match ""))
15098 (org-move-to-column (- (window-width) 19) t)
15099 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15101 (defun org-set-current-tags-overlay (current prefix)
15102 "Add an overlay to CURRENT tag with PREFIX."
15103 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15104 (if (featurep 'xemacs)
15105 (org-overlay-display org-tags-overlay (concat prefix s)
15106 'secondary-selection)
15107 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15108 (org-overlay-display org-tags-overlay (concat prefix s)))))
15110 (defvar org-last-tag-selection-key nil)
15111 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15112 "Fast tag selection with single keys.
15113 CURRENT is the current list of tags in the headline, INHERITED is the
15114 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15115 possibly with grouping information. TODO-TABLE is a similar table with
15116 TODO keywords, should these have keys assigned to them.
15117 If the keys are nil, a-z are automatically assigned.
15118 Returns the new tags string, or nil to not change the current settings."
15119 (let* ((fulltable (append table todo-table))
15120 (maxlen (apply 'max (mapcar
15122 (if (stringp (car x)) (string-width (car x)) 0))
15124 (buf (current-buffer))
15125 (expert (eq org-fast-tag-selection-single-key 'expert))
15127 (fwidth (+ maxlen 3 1 3))
15128 (ncol (/ (- (window-width) 4) fwidth))
15131 tg cnt e c char c1 c2 ntable tbl rtn
15132 ov-start ov-end ov-prefix
15133 (exit-after-next org-fast-tag-selection-single-key)
15134 (done-keywords org-done-keywords)
15135 groups ingroup intaggroup)
15137 (beginning-of-line 1)
15139 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15140 (setq ov-start (match-beginning 1)
15141 ov-end (match-end 1)
15143 (setq ov-start (1- (point-at-eol))
15144 ov-end (1+ ov-start))
15145 (skip-chars-forward "^\n\r")
15148 (buffer-substring (1- (point)) (point))
15149 (if (> (current-column) org-tags-column)
15151 (make-string (- org-tags-column (current-column)) ?\ ))))))
15152 (move-overlay org-tags-overlay ov-start ov-end)
15153 (save-window-excursion
15155 (set-buffer (get-buffer-create " *Org tags*"))
15156 (delete-other-windows)
15157 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15158 (org-switch-to-buffer-other-window " *Org tags*"))
15160 (org-set-local 'org-done-keywords done-keywords)
15161 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15162 (org-fast-tag-insert "Current" current c-face "\n\n")
15163 (org-fast-tag-show-exit exit-after-next)
15164 (org-set-current-tags-overlay current ov-prefix)
15165 (setq tbl fulltable char ?a cnt 0)
15166 (while (setq e (pop tbl))
15168 ((eq (car e) :startgroup)
15169 (push '() groups) (setq ingroup t)
15170 (unless (zerop cnt)
15173 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15174 ((eq (car e) :endgroup)
15175 (setq ingroup nil cnt 0)
15176 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15177 ((eq (car e) :startgrouptag)
15178 (setq intaggroup t)
15179 (unless (zerop cnt)
15183 ((eq (car e) :endgrouptag)
15184 (setq intaggroup nil cnt 0)
15186 ((equal e '(:newline))
15187 (unless (zerop cnt)
15191 (while (equal (car tbl) '(:newline))
15193 (setq tbl (cdr tbl)))))
15194 ((equal e '(:grouptags)) (insert " : "))
15196 (setq tg (copy-sequence (car e)) c2 nil)
15199 ;; automatically assign a character.
15200 (setq c1 (string-to-char
15201 (downcase (substring
15202 tg (if (= (string-to-char tg) ?@) 1 0)))))
15203 (if (or (rassoc c1 ntable) (rassoc c1 table))
15204 (while (or (rassoc char ntable) (rassoc char table))
15205 (setq char (1+ char)))
15207 (setq c (or c2 char)))
15208 (when ingroup (push tg (car groups)))
15209 (setq tg (org-add-props tg nil 'face
15211 ((not (assoc tg table))
15212 (org-get-todo-face tg))
15213 ((member tg current) c-face)
15214 ((member tg inherited) i-face))))
15215 (when (equal (caar tbl) :grouptags)
15216 (org-add-props tg nil 'face 'org-tag-group))
15217 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15218 (insert "[" c "] " tg (make-string
15219 (- fwidth 4 (length tg)) ?\ ))
15220 (push (cons tg c) ntable)
15221 (when (= (incf cnt) ncol)
15223 (when (or ingroup intaggroup) (insert " "))
15225 (setq ntable (nreverse ntable))
15227 (goto-char (point-min))
15228 (unless expert (org-fit-window-to-buffer))
15232 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15233 (if (not groups) "no " "")
15234 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15235 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15236 (setq org-last-tag-selection-key c)
15238 ((= c ?\r) (throw 'exit t))
15240 (setq groups (not groups))
15241 (goto-char (point-min))
15242 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15245 (org-fast-tag-show-exit
15246 (setq exit-after-next (not exit-after-next)))
15248 (delete-other-windows)
15249 (set-window-buffer (split-window-vertically) " *Org tags*")
15250 (org-switch-to-buffer-other-window " *Org tags*")
15251 (org-fit-window-to-buffer)))
15253 (and (= c ?q) (not (rassoc c ntable))))
15254 (org-detach-overlay org-tags-overlay)
15255 (setq quit-flag t))
15258 (when exit-after-next (setq exit-after-next 'now)))
15260 (condition-case nil
15261 (setq tg (org-icompleting-read
15264 (with-current-buffer buf
15265 (org-get-buffer-tags)))))
15266 (quit (setq tg "")))
15267 (when (string-match "\\S-" tg)
15268 (add-to-list 'buffer-tags (list tg))
15269 (if (member tg current)
15270 (setq current (delete tg current))
15271 (push tg current)))
15272 (when exit-after-next (setq exit-after-next 'now)))
15273 ((setq e (rassoc c todo-table) tg (car e))
15274 (with-current-buffer buf
15275 (save-excursion (org-todo tg)))
15276 (when exit-after-next (setq exit-after-next 'now)))
15277 ((setq e (rassoc c ntable) tg (car e))
15278 (if (member tg current)
15279 (setq current (delete tg current))
15280 (loop for g in groups do
15281 (when (member tg g)
15282 (dolist (x g) (setq current (delete x current)))))
15284 (when exit-after-next (setq exit-after-next 'now))))
15286 ;; Create a sorted list
15290 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15291 (when (eq exit-after-next 'now) (throw 'exit t))
15292 (goto-char (point-min))
15293 (beginning-of-line 2)
15294 (delete-region (point) (point-at-eol))
15295 (org-fast-tag-insert "Current" current c-face)
15296 (org-set-current-tags-overlay current ov-prefix)
15297 (while (re-search-forward
15298 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15299 (setq tg (match-string 1))
15300 (add-text-properties
15301 (match-beginning 1) (match-end 1)
15304 ((member tg current) c-face)
15305 ((member tg inherited) i-face)
15306 (t (get-text-property (match-beginning 1) 'face))))))
15307 (goto-char (point-min)))))
15308 (org-detach-overlay org-tags-overlay)
15310 (mapconcat 'identity current ":")
15313 (defun org-get-tags-string ()
15314 "Get the TAGS string in the current headline."
15315 (unless (org-at-heading-p t)
15316 (user-error "Not on a heading"))
15318 (beginning-of-line 1)
15319 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15320 (org-match-string-no-properties 1)
15323 (defun org-get-tags ()
15324 "Get the list of tags specified in the current headline."
15325 (org-split-string (org-get-tags-string) ":"))
15327 (defun org-get-buffer-tags ()
15328 "Get a table of all tags used in the buffer, for completion."
15329 (org-with-wide-buffer
15330 (goto-char (point-min))
15331 (let ((tag-re (concat org-outline-regexp-bol
15332 "\\(?:.*?[ \t]\\)?"
15333 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15335 (while (re-search-forward tag-re nil t)
15336 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15338 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15340 ;;;; The mapping API
15342 (defun org-map-entries (func &optional match scope &rest skip)
15343 "Call FUNC at each headline selected by MATCH in SCOPE.
15345 FUNC is a function or a lisp form. The function will be called without
15346 arguments, with the cursor positioned at the beginning of the headline.
15347 The return values of all calls to the function will be collected and
15348 returned as a list.
15350 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15351 does not need to preserve point. After evaluation, the cursor will be
15352 moved to the end of the line (presumably of the headline of the
15353 processed entry) and search continues from there. Under some
15354 circumstances, this may not produce the wanted results. For example,
15355 if you have removed (e.g. archived) the current (sub)tree it could
15356 mean that the next entry will be skipped entirely. In such cases, you
15357 can specify the position from where search should continue by making
15358 FUNC set the variable `org-map-continue-from' to the desired buffer
15361 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15362 Only headlines that are matched by this query will be considered during
15363 the iteration. When MATCH is nil or t, all headlines will be
15364 visited by the iteration.
15366 SCOPE determines the scope of this command. It can be any of:
15368 nil The current buffer, respecting the restriction if any
15369 tree The subtree started with the entry at point
15370 region The entries within the active region, if any
15372 The entries within the active region, but only those at
15373 the same level than the first one.
15374 file The current buffer, without restriction
15376 The current buffer, and any archives associated with it
15377 agenda All agenda files
15378 agenda-with-archives
15379 All agenda files with any archive files associated with them
15381 If this is a list, all files in the list will be scanned
15383 The remaining args are treated as settings for the skipping facilities of
15384 the scanner. The following items can be given here:
15386 archive skip trees with the archive tag
15387 comment skip trees with the COMMENT keyword
15388 function or Emacs Lisp form:
15389 will be used as value for `org-agenda-skip-function', so
15390 whenever the function returns a position, FUNC will not be
15391 called for that entry and search will continue from the
15394 If your function needs to retrieve the tags including inherited tags
15395 at the *current* entry, you can use the value of the variable
15396 `org-scanner-tags' which will be much faster than getting the value
15397 with `org-get-tags-at'. If your function gets properties with
15398 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15399 to t around the call to `org-entry-properties' to get the same speedup.
15400 Note that if your function moves around to retrieve tags and properties at
15401 a *different* entry, you cannot use these techniques."
15402 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15403 (not (org-region-active-p)))
15404 (let* ((org-agenda-archives-mode nil) ; just to make sure
15405 (org-agenda-skip-archived-trees (memq 'archive skip))
15406 (org-agenda-skip-comment-trees (memq 'comment skip))
15407 (org-agenda-skip-function
15408 (car (org-delete-all '(comment archive) skip)))
15409 (org-tags-match-list-sublevels t)
15410 (start-level (eq scope 'region-start-level))
15412 org-todo-keywords-for-agenda
15413 org-done-keywords-for-agenda
15414 org-todo-keyword-alist-for-agenda
15415 org-tag-alist-for-agenda
15419 ((eq match t) (setq matcher t))
15420 ((eq match nil) (setq matcher t))
15421 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15425 (cond ((eq scope 'tree)
15426 (org-back-to-heading t)
15427 (org-narrow-to-subtree)
15429 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15430 (org-region-active-p))
15431 ;; If needed, set start-level to a string like "2"
15434 (goto-char (region-beginning))
15435 (unless (org-at-heading-p) (outline-next-heading))
15436 (setq start-level (org-current-level))))
15437 (narrow-to-region (region-beginning)
15439 (goto-char (region-end))
15440 (unless (and (bolp) (org-at-heading-p))
15441 (outline-next-heading))
15447 (org-agenda-prepare-buffers
15448 (list (buffer-file-name (current-buffer))))
15449 (setq res (org-scan-tags func matcher todo-only start-level)))
15450 ;; Get the right scope
15452 ((and scope (listp scope) (symbolp (car scope)))
15453 (setq scope (eval scope)))
15454 ((eq scope 'agenda)
15455 (setq scope (org-agenda-files t)))
15456 ((eq scope 'agenda-with-archives)
15457 (setq scope (org-agenda-files t))
15458 (setq scope (org-add-archive-files scope)))
15460 (setq scope (list (buffer-file-name))))
15461 ((eq scope 'file-with-archives)
15462 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15463 (org-agenda-prepare-buffers scope)
15464 (while (setq file (pop scope))
15465 (with-current-buffer (org-find-base-buffer-visiting file)
15469 (goto-char (point-min))
15470 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15475 (defconst org-special-properties
15476 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15477 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15478 "The special properties valid in Org mode.
15479 These are properties that are not defined in the property drawer,
15480 but in some other way.")
15482 (defconst org-default-properties
15483 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15484 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15485 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15486 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15487 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15488 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15489 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15490 "Some properties that are used by Org mode for various purposes.
15491 Being in this list makes sure that they are offered for completion.")
15493 (defun org--update-property-plist (key val props)
15494 "Associate KEY to VAL in alist PROPS.
15495 Modifications are made by side-effect. Return new alist."
15496 (let* ((appending (string= (substring key -1) "+"))
15497 (key (if appending (substring key 0 -1) key))
15498 (old (assoc-string key props t)))
15499 (if (not old) (cons (cons key val) props)
15500 (setcdr old (if appending (concat (cdr old) " " val) val))
15503 (defun org-get-property-block (&optional beg force)
15504 "Return the (beg . end) range of the body of the property drawer.
15505 BEG is the beginning of the current subtree, or of the part
15506 before the first headline. If it is not given, it will be found.
15507 If the drawer does not exist, create it if FORCE is non-nil, or
15509 (org-with-wide-buffer
15510 (when beg (goto-char beg))
15511 (unless (org-before-first-heading-p)
15512 (let ((beg (cond (beg)
15513 ((or (not (featurep 'org-inlinetask))
15514 (org-inlinetask-in-task-p))
15515 (org-back-to-heading t))
15516 (t (org-with-limited-levels (org-back-to-heading t))))))
15518 (when (org-looking-at-p org-planning-line-re) (forward-line))
15519 (cond ((looking-at org-property-drawer-re)
15521 (cons (point) (progn (goto-char (match-end 0))
15522 (line-beginning-position))))
15525 (org-insert-property-drawer)
15526 (let ((pos (save-excursion (search-forward ":END:")
15527 (line-beginning-position))))
15528 (cons pos pos))))))))
15530 (defun org-at-property-p ()
15531 "Non-nil when point is inside a property drawer.
15532 See `org-property-re' for match data, if applicable."
15534 (beginning-of-line)
15535 (and (looking-at org-property-re)
15536 (let ((property-drawer (save-match-data (org-get-property-block))))
15537 (and property-drawer
15538 (>= (point) (car property-drawer))
15539 (< (point) (cdr property-drawer)))))))
15541 (defun org-property-action ()
15542 "Do an action on properties."
15544 (unless (org-at-property-p) (user-error "Not at a property"))
15545 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15546 (let ((c (read-char-exclusive)))
15548 (?s (call-interactively #'org-set-property))
15549 (?d (call-interactively #'org-delete-property))
15550 (?D (call-interactively #'org-delete-property-globally))
15551 (?c (call-interactively #'org-compute-property-at-point))
15552 (otherwise (user-error "No such property action %c" c)))))
15554 (defun org-inc-effort ()
15555 "Increment the value of the effort property in the current entry."
15557 (org-set-effort nil t))
15559 (defvar org-clock-effort) ; Defined in org-clock.el.
15560 (defvar org-clock-current-task) ; Defined in org-clock.el.
15561 (defun org-set-effort (&optional value increment)
15562 "Set the effort property of the current entry.
15563 With numerical prefix arg, use the nth allowed value, 0 stands for the
15564 10th allowed value.
15566 When INCREMENT is non-nil, set the property to the next allowed value."
15568 (if (equal value 0) (setq value 10))
15569 (let* ((completion-ignore-case t)
15570 (prop org-effort-property)
15571 (cur (org-entry-get nil prop))
15572 (allowed (org-property-get-allowed-values nil prop 'table))
15573 (existing (mapcar 'list (org-property-values prop)))
15574 (heading (nth 4 (org-heading-components)))
15577 ((stringp value) value)
15578 ((and allowed (integerp value))
15579 (or (car (nth (1- value) allowed))
15580 (car (org-last allowed))))
15581 ((and allowed increment)
15582 (or (caadr (member (list cur) allowed))
15583 (user-error "Allowed effort values are not set")))
15585 (message "Select 1-9,0, [RET%s]: %s"
15586 (if cur (concat "=" cur) "")
15587 (mapconcat 'car allowed " "))
15588 (setq rpl (read-char-exclusive))
15589 (if (equal rpl ?\r)
15591 (setq rpl (- rpl ?0))
15592 (if (equal rpl 0) (setq rpl 10))
15593 (if (and (> rpl 0) (<= rpl (length allowed)))
15594 (car (nth (1- rpl) allowed))
15595 (org-completing-read "Effort: " allowed nil))))
15597 (let (org-completion-use-ido org-completion-use-iswitchb)
15598 (org-completing-read
15599 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15600 (concat "[" cur "]") "")
15602 existing nil nil "" nil cur))))))
15603 (unless (equal (org-entry-get nil prop) val)
15604 (org-entry-put nil prop val))
15605 (org-refresh-property
15606 '((effort . identity)
15607 (effort-minutes . org-duration-string-to-minutes))
15609 (when (string= heading org-clock-current-task)
15610 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15611 (org-clock-update-mode-line))
15612 (message "%s is now %s" prop val)))
15614 (defun org-entry-properties (&optional pom which)
15615 "Get all properties of the current entry.
15617 When POM is a buffer position, get all properties from the entry
15620 This includes the TODO keyword, the tags, time strings for
15621 deadline, scheduled, and clocking, and any additional properties
15622 defined in the entry.
15624 If WHICH is nil or `all', get all properties. If WHICH is
15625 `special' or `standard', only get that subclass. If WHICH is
15626 a string, only get that property.
15628 Return value is an alist. Keys are properties, as upcased
15630 (org-with-point-at pom
15631 (when (and (derived-mode-p 'org-mode)
15632 (ignore-errors (org-back-to-heading t)))
15634 (let* ((beg (point))
15635 (specific (and (stringp which) (upcase which)))
15636 (which (cond ((not specific) which)
15637 ((member specific org-special-properties) 'special)
15640 ;; Get the special properties, like TODO and TAGS.
15641 (when (memq which '(nil all special))
15642 (when (or (not specific) (string= specific "CLOCKSUM"))
15643 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15645 (push (cons "CLOCKSUM"
15646 (org-columns-number-to-string
15647 (/ (float clocksum) 60.) 'add_times))
15649 (when specific (throw 'exit props)))
15650 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15651 (let ((clocksumt (get-text-property (point)
15652 :org-clock-minutes-today)))
15654 (push (cons "CLOCKSUM_T"
15655 (org-columns-number-to-string
15656 (/ (float clocksumt) 60.) 'add_times))
15658 (when specific (throw 'exit props)))
15659 (when (or (not specific) (string= specific "ITEM"))
15660 (when (looking-at org-complex-heading-regexp)
15663 (org-match-string-no-properties 1)
15664 (let ((title (org-match-string-no-properties 4)))
15665 (when (org-string-nw-p title)
15666 (concat " " (org-remove-tabs title))))))
15668 (when specific (throw 'exit props)))
15669 (when (or (not specific) (string= specific "TODO"))
15670 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15671 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15672 (when specific (throw 'exit props)))
15673 (when (or (not specific) (string= specific "PRIORITY"))
15674 (when (looking-at org-priority-regexp)
15675 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15676 (when specific (throw 'exit props)))
15677 (when (or (not specific) (string= specific "FILE"))
15678 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15680 (when specific (throw 'exit props)))
15681 (when (or (not specific) (string= specific "TAGS"))
15682 (let ((value (org-string-nw-p (org-get-tags-string))))
15683 (when value (push (cons "TAGS" value) props)))
15684 (when specific (throw 'exit props)))
15685 (when (or (not specific) (string= specific "ALLTAGS"))
15686 (let ((value (org-get-tags-at)))
15688 (push (cons "ALLTAGS"
15689 (format ":%s:" (mapconcat #'identity value ":")))
15691 (when specific (throw 'exit props)))
15692 (when (or (not specific) (string= specific "BLOCKED"))
15693 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15694 (when specific (throw 'exit props)))
15695 (when (or (not specific)
15696 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15698 (when (org-looking-at-p org-planning-line-re)
15700 (let ((bol (line-beginning-position))
15701 ;; Backward compatibility: time keywords used to
15702 ;; be configurable (before 8.3). Make sure we
15703 ;; get the correct keyword.
15704 (key-assoc `(("CLOSED" . ,org-closed-string)
15705 ("DEADLINE" . ,org-deadline-string)
15706 ("SCHEDULED" . ,org-scheduled-string))))
15707 (dolist (pair (if specific (list (assoc specific key-assoc))
15710 (when (search-backward (cdr pair) bol t)
15711 (goto-char (match-end 0))
15712 (skip-chars-forward " \t")
15713 (and (looking-at org-ts-regexp-both)
15714 (push (cons (car pair)
15715 (org-match-string-no-properties 0))
15717 (when specific (throw 'exit props)))
15718 (when (or (not specific)
15719 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15722 (let ((regexp (if (or (string= specific "TIMESTAMP")
15723 (assoc "TIMESTAMP_IA" ts))
15725 org-ts-regexp-both)))
15727 (while (re-search-forward regexp end t)
15729 (let ((object (org-element-context)))
15730 ;; Accept to match timestamps in node
15731 ;; properties, too.
15732 (when (memq (org-element-type object)
15733 '(node-property timestamp))
15735 (org-element-property :type object)))
15737 ((and (memq type '(active active-range))
15738 (not (equal specific "TIMESTAMP_IA")))
15739 (unless (assoc "TIMESTAMP" ts)
15740 (push (cons "TIMESTAMP"
15741 (org-element-property
15742 :raw-value object))
15744 (when specific (throw 'exit ts))))
15745 ((and (memq type '(inactive inactive-range))
15746 (not (string= specific "TIMESTAMP")))
15747 (unless (assoc "TIMESTAMP_IA" ts)
15748 (push (cons "TIMESTAMP_IA"
15749 (org-element-property
15750 :raw-value object))
15752 (when specific (throw 'exit ts))))))
15753 ;; Both timestamp types are found,
15754 ;; move to next part.
15755 (when (= (length ts) 2) (throw 'next ts)))))
15758 ;; First look for timestamps within headline.
15759 (let ((ts (funcall find-ts (line-end-position) nil)))
15760 (if (= (length ts) 2) (setq props (nconc ts props))
15762 ;; Then find timestamps in the section, skipping
15764 (when (org-looking-at-p org-planning-line-re)
15766 (let ((end (save-excursion (outline-next-heading))))
15767 (setq props (nconc (funcall find-ts end ts) props))))))))
15768 ;; Get the standard properties, like :PROP:.
15769 (when (memq which '(nil all standard))
15770 ;; If we are looking after a specific property, delegate
15771 ;; to `org-entry-get', which is faster. However, make an
15772 ;; exception for "CATEGORY", since it can be also set
15773 ;; through keywords (i.e. #+CATEGORY).
15774 (if (and specific (not (equal specific "CATEGORY")))
15775 (let ((value (org-entry-get beg specific nil t)))
15776 (throw 'exit (and value (list (cons specific value)))))
15777 (let ((range (org-get-property-block beg)))
15779 (let ((end (cdr range)) seen-base)
15780 (goto-char (car range))
15781 ;; Unlike to `org--update-property-plist', we
15782 ;; handle the case where base values is found
15783 ;; after its extension. We also forbid standard
15784 ;; properties to be named as special properties.
15785 (while (re-search-forward org-property-re end t)
15786 (let* ((key (upcase (org-match-string-no-properties 2)))
15787 (extendp (org-string-match-p "\\+\\'" key))
15788 (key-base (if extendp (substring key 0 -1) key))
15789 (value (org-match-string-no-properties 3)))
15791 ((member-ignore-case key-base org-special-properties))
15794 (org--update-property-plist key value props)))
15795 ((member key seen-base))
15796 (t (push key seen-base)
15797 (let ((p (assoc-string key props t)))
15798 (if p (setcdr p (concat value " " (cdr p)))
15799 (push (cons key value) props))))))))))))
15800 (unless (assoc "CATEGORY" props)
15801 (push (cons "CATEGORY" (org-get-category beg)) props)
15802 (when (string= specific "CATEGORY") (throw 'exit props)))
15804 (append (get-text-property beg 'org-summaries) props))))))
15806 (defun org-entry-get (pom property &optional inherit literal-nil)
15807 "Get value of PROPERTY for entry or content at point-or-marker POM.
15809 If INHERIT is non-nil and the entry does not have the property,
15810 then also check higher levels of the hierarchy. If INHERIT is
15811 the symbol `selective', use inheritance only if the setting in
15812 `org-use-property-inheritance' selects PROPERTY for inheritance.
15814 If the property is present but empty, the return value is the
15815 empty string. If the property is not present at all, nil is
15816 returned. In any other case, return the value as a string.
15817 Search is case-insensitive.
15819 If LITERAL-NIL is set, return the string value \"nil\" as
15820 a string, do not interpret it as the list atom nil. This is used
15821 for inheritance when a \"nil\" value can supersede a non-nil
15822 value higher up the hierarchy."
15823 (org-with-point-at pom
15825 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15826 ;; We need a special property. Use `org-entry-properties' to
15827 ;; retrieve it, but specify the wanted property.
15828 (cdr (assoc-string property (org-entry-properties nil property))))
15830 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15831 (org-entry-get-with-inheritance property literal-nil))
15833 (let ((range (org-get-property-block)))
15835 (let* ((case-fold-search t)
15839 (or (assoc-string property org-file-properties t)
15840 (assoc-string property org-global-properties t)
15842 property org-global-properties-fixed t))))
15843 ;; Make sure to not re-use GLOBAL as
15844 ;; `org--update-property-plist' would alter it by
15846 (and global (list (cons property (cdr global))))))
15849 (when (re-search-forward (org-re-property key nil t) end t)
15851 (org--update-property-plist
15852 key (org-match-string-no-properties 3) props))))))
15853 (goto-char (car range))
15854 ;; Find base value.
15855 (save-excursion (funcall find-value property))
15856 ;; Find additional values.
15857 (let ((property+ (concat property "+")))
15858 (while (funcall find-value property+)))
15859 ;; Return final value.
15860 (let ((val (cdr (assoc-string property props t))))
15861 (if literal-nil val (org-not-nil val))))))))))
15863 (defun org-property-or-variable-value (var &optional inherit)
15864 "Check if there is a property fixing the value of VAR.
15865 If yes, return this value. If not, return the current value of the variable."
15866 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15867 (if (and prop (stringp prop) (string-match "\\S-" prop))
15869 (symbol-value var))))
15871 (defun org-entry-delete (pom property)
15872 "Delete PROPERTY from entry at point-or-marker POM.
15873 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15874 non-nil when a property was removed."
15875 (unless (member property org-special-properties)
15876 (org-with-point-at pom
15877 (let ((range (org-get-property-block)))
15879 (let* ((begin (car range))
15880 (origin (cdr range))
15881 (end (copy-marker origin))
15882 (re (org-re-property
15883 (concat (regexp-quote property) "\\+?") t t)))
15885 (while (re-search-forward re end t)
15886 (delete-region (match-beginning 0) (line-beginning-position 2)))
15887 ;; If drawer is empty, remove it altogether.
15888 (when (= begin end)
15889 (delete-region (line-beginning-position 0)
15890 (line-beginning-position 2)))
15891 ;; Return non-nil if some property was removed.
15892 (prog1 (/= end origin) (set-marker end nil))))))))
15894 ;; Multi-values properties are properties that contain multiple values
15895 ;; These values are assumed to be single words, separated by whitespace.
15896 (defun org-entry-add-to-multivalued-property (pom property value)
15897 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15898 (let* ((old (org-entry-get pom property))
15899 (values (and old (org-split-string old "[ \t]"))))
15900 (setq value (org-entry-protect-space value))
15901 (unless (member value values)
15902 (setq values (append values (list value)))
15903 (org-entry-put pom property
15904 (mapconcat 'identity values " ")))))
15906 (defun org-entry-remove-from-multivalued-property (pom property value)
15907 "Remove VALUE from 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 (when (member value values)
15912 (setq values (delete value values))
15913 (org-entry-put pom property
15914 (mapconcat 'identity values " ")))))
15916 (defun org-entry-member-in-multivalued-property (pom property value)
15917 "Is VALUE one of the 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 (member value values)))
15923 (defun org-entry-get-multivalued-property (pom property)
15924 "Return a list of values in a multivalued property."
15925 (let* ((value (org-entry-get pom property))
15926 (values (and value (org-split-string value "[ \t]"))))
15927 (mapcar 'org-entry-restore-space values)))
15929 (defun org-entry-put-multivalued-property (pom property &rest values)
15930 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15931 VALUES should be a list of strings. Spaces will be protected."
15932 (org-entry-put pom property
15933 (mapconcat 'org-entry-protect-space values " "))
15934 (let* ((value (org-entry-get pom property))
15935 (values (and value (org-split-string value "[ \t]"))))
15936 (mapcar 'org-entry-restore-space values)))
15938 (defun org-entry-protect-space (s)
15939 "Protect spaces and newline in string S."
15940 (while (string-match " " s)
15941 (setq s (replace-match "%20" t t s)))
15942 (while (string-match "\n" s)
15943 (setq s (replace-match "%0A" t t s)))
15946 (defun org-entry-restore-space (s)
15947 "Restore spaces and newline in string S."
15948 (while (string-match "%20" s)
15949 (setq s (replace-match " " t t s)))
15950 (while (string-match "%0A" s)
15951 (setq s (replace-match "\n" t t s)))
15954 (defvar org-entry-property-inherited-from (make-marker)
15955 "Marker pointing to the entry from where a property was inherited.
15956 Each call to `org-entry-get-with-inheritance' will set this marker to the
15957 location of the entry where the inheritance search matched. If there was
15958 no match, the marker will point nowhere.
15959 Note that also `org-entry-get' calls this function, if the INHERIT flag
15962 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15963 "Get PROPERTY of entry or content at point, search higher levels if needed.
15964 The search will stop at the first ancestor which has the property defined.
15965 If the value found is \"nil\", return nil to show that the property
15966 should be considered as undefined (this is the meaning of nil here).
15967 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15968 (move-marker org-entry-property-inherited-from nil)
15970 (org-with-wide-buffer
15973 (when (setq value (org-entry-get nil property nil literal-nil))
15974 (org-back-to-heading t)
15975 (move-marker org-entry-property-inherited-from (point))
15977 (or (org-up-heading-safe) (throw 'exit nil)))))
15980 (cdr (or (assoc-string property org-file-properties t)
15981 (assoc-string property org-global-properties t)
15982 (assoc-string property org-global-properties-fixed t)))))
15983 (if literal-nil value (org-not-nil value))))
15985 (defvar org-property-changed-functions nil
15986 "Hook called when the value of a property has changed.
15987 Each hook function should accept two arguments, the name of the property
15988 and the new value.")
15990 (defun org-entry-put (pom property value)
15991 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15993 If the value is `nil', it is converted to the empty string. If
15994 it is not a string, an error is raised.
15996 PROPERTY can be any regular property (see
15997 `org-special-properties'). It can also be \"TODO\",
15998 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16000 For the last two properties, VALUE may have any of the special
16001 values \"earlier\" and \"later\". The function then increases or
16002 decreases scheduled or deadline date by one day."
16003 (cond ((null value) (setq value ""))
16004 ((not (stringp value)) (error "Properties values should be strings")))
16005 (org-with-point-at pom
16006 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16007 (org-back-to-heading t)
16008 (org-with-limited-levels (org-back-to-heading t)))
16009 (let ((beg (point)))
16011 ((equal property "TODO")
16012 (cond ((not (org-string-nw-p value)) (setq value 'none))
16013 ((not (member value org-todo-keywords-1))
16014 (user-error "\"%s\" is not a valid TODO state" value)))
16016 (org-set-tags nil 'align))
16017 ((equal property "PRIORITY")
16018 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16019 (org-set-tags nil 'align))
16020 ((equal property "SCHEDULED")
16022 (if (and (org-looking-at-p org-planning-line-re)
16024 org-scheduled-time-regexp (line-end-position) t))
16025 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16026 ((string= value "later") (org-timestamp-change 1 'day))
16027 ((string= value "") (org-schedule '(4)))
16028 (t (org-schedule nil value)))
16029 (if (member value '("earlier" "later" ""))
16030 (call-interactively #'org-schedule)
16031 (org-schedule nil value))))
16032 ((equal property "DEADLINE")
16034 (if (and (org-looking-at-p org-planning-line-re)
16036 org-deadline-time-regexp (line-end-position) t))
16037 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16038 ((string= value "later") (org-timestamp-change 1 'day))
16039 ((string= value "") (org-deadline '(4)))
16040 (t (org-deadline nil value)))
16041 (if (member value '("earlier" "later" ""))
16042 (call-interactively #'org-deadline)
16043 (org-deadline nil value))))
16044 ((member property org-special-properties)
16045 (error "The %s property cannot be set with `org-entry-put'" property))
16047 (let* ((range (org-get-property-block beg 'force))
16049 (case-fold-search t))
16050 (goto-char (car range))
16051 (if (re-search-forward (org-re-property property nil t) end t)
16052 (progn (delete-region (match-beginning 0) (match-end 0))
16053 (goto-char (match-beginning 0)))
16057 (insert ":" property ":")
16058 (when value (insert " " value))
16059 (org-indent-line)))))
16060 (run-hook-with-args 'org-property-changed-functions property value)))
16062 (defun org-buffer-property-keys (&optional specials defaults columns)
16063 "Get all property keys in the current buffer.
16065 When SPECIALS is non-nil, also list the special properties that
16066 reflect things like tags and TODO state.
16068 When DEFAULTS is non-nil, also include properties that has
16069 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16070 DESCRIPTION, LOCATION, and LOGGING and others.
16072 When COLUMNS in non-nil, also include property names given in
16073 COLUMN formats in the current buffer."
16074 (let ((case-fold-search t)
16076 (and specials org-special-properties)
16077 (and defaults (cons org-effort-property org-default-properties))
16079 (org-with-wide-buffer
16080 (goto-char (point-min))
16081 (while (re-search-forward org-property-start-re nil t)
16082 (let ((range (org-get-property-block)))
16085 (when (and (not (org-before-first-heading-p))
16086 (y-or-n-p (format "Malformed drawer at %d, repair?"
16087 (line-beginning-position))))
16088 (org-get-property-block nil t))
16090 (goto-char (car range))
16091 (let ((begin (car range))
16093 ;; Make sure that found property block is not located
16094 ;; before current point, as it would generate an infloop.
16095 ;; It can happen, for example, in the following
16102 ;; *************** Inlinetask
16107 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16108 (while (< (point) end)
16109 (let ((p (progn (looking-at org-property-re)
16110 (org-match-string-no-properties 2))))
16111 ;; Only add true property name, not extension symbol.
16112 (add-to-list 'props
16113 (if (not (org-string-match-p "\\+\\'" p)) p
16114 (substring p 0 -1))))
16116 (outline-next-heading)))
16118 (goto-char (point-min))
16119 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16120 (let ((element (org-element-at-point)))
16121 (when (memq (org-element-type element) '(keyword node-property))
16122 (let ((value (org-element-property :value element))
16124 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16125 (setq start (match-end 0))
16126 (let ((p (org-match-string-no-properties 1 value)))
16127 (unless (member-ignore-case p org-special-properties)
16128 (add-to-list 'props p))))))))))
16129 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16131 (defun org-property-values (key)
16132 "List all non-nil values of property KEY in current buffer."
16133 (org-with-wide-buffer
16134 (goto-char (point-min))
16135 (let ((case-fold-search t)
16136 (re (org-re-property key))
16138 (while (re-search-forward re nil t)
16139 (add-to-list 'values (org-entry-get (point) key)))
16142 (defun org-insert-property-drawer ()
16143 "Insert a property drawer into the current entry."
16144 (org-with-wide-buffer
16145 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16146 (org-back-to-heading t)
16147 (org-with-limited-levels (org-back-to-heading t)))
16149 (when (org-looking-at-p org-planning-line-re) (forward-line))
16150 (unless (org-looking-at-p org-property-drawer-re)
16151 (let ((inhibit-read-only t))
16152 (unless (bolp) (insert "\n"))
16153 (let ((begin (point)))
16154 (insert ":PROPERTIES:\n:END:\n")
16155 (org-indent-region begin (point)))))))
16157 (defun org-insert-drawer (&optional arg drawer)
16158 "Insert a drawer at point.
16160 When optional argument ARG is non-nil, insert a property drawer.
16162 Optional argument DRAWER, when non-nil, is a string representing
16163 drawer's name. Otherwise, the user is prompted for a name.
16165 If a region is active, insert the drawer around that region
16168 Point is left between drawer's boundaries."
16170 (let* ((drawer (if arg "PROPERTIES"
16171 (or drawer (read-from-minibuffer "Drawer: ")))))
16173 ;; With C-u, fall back on `org-insert-property-drawer'
16174 (arg (org-insert-property-drawer))
16175 ;; Check validity of suggested drawer's name.
16176 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16177 (user-error "Invalid drawer name"))
16178 ;; With an active region, insert a drawer at point.
16179 ((not (org-region-active-p))
16181 (unless (bolp) (insert "\n"))
16182 (insert (format ":%s:\n\n:END:\n" drawer))
16183 (forward-line -2)))
16184 ;; Otherwise, insert the drawer at point
16186 (let ((rbeg (region-beginning))
16187 (rend (copy-marker (region-end))))
16191 (beginning-of-line)
16192 (when (save-excursion
16193 (re-search-forward org-outline-regexp-bol rend t))
16194 (user-error "Drawers cannot contain headlines"))
16195 ;; Position point at the beginning of the first
16196 ;; non-blank line in region. Insert drawer's opening
16197 ;; there, then indent it.
16198 (org-skip-whitespace)
16199 (beginning-of-line)
16200 (insert ":" drawer ":\n")
16202 (indent-for-tab-command)
16203 ;; Move point to the beginning of the first blank line
16204 ;; after the last non-blank line in region. Insert
16205 ;; drawer's closing, then indent it.
16207 (skip-chars-backward " \r\t\n")
16209 (deactivate-mark t)
16210 (indent-for-tab-command)
16211 (unless (eolp) (insert "\n")))
16212 ;; Clear marker, whatever the outcome of insertion is.
16213 (set-marker rend nil)))))))
16215 (defvar org-property-set-functions-alist nil
16216 "Property set function alist.
16217 Each entry should have the following format:
16219 (PROPERTY . READ-FUNCTION)
16221 The read function will be called with the same argument as
16222 `org-completing-read'.")
16224 (defun org-set-property-function (property)
16225 "Get the function that should be used to set PROPERTY.
16226 This is computed according to `org-property-set-functions-alist'."
16227 (or (cdr (assoc property org-property-set-functions-alist))
16228 'org-completing-read))
16230 (defun org-read-property-value (property)
16231 "Read PROPERTY value from user."
16232 (let* ((completion-ignore-case t)
16233 (allowed (org-property-get-allowed-values nil property 'table))
16234 (cur (org-entry-get nil property))
16235 (prompt (concat property " value"
16236 (if (and cur (string-match "\\S-" cur))
16237 (concat " [" cur "]") "") ": "))
16238 (set-function (org-set-property-function property))
16240 (funcall set-function prompt allowed nil
16241 (not (get-text-property 0 'org-unrestricted
16243 (let (org-completion-use-ido org-completion-use-iswitchb)
16244 (funcall set-function prompt
16245 (mapcar 'list (org-property-values property))
16246 nil nil "" nil cur)))))
16249 (defvar org-last-set-property nil)
16250 (defvar org-last-set-property-value nil)
16251 (defun org-read-property-name ()
16252 "Read a property name."
16253 (let ((completion-ignore-case t)
16254 (default-prop (or (and (org-at-property-p)
16255 (org-match-string-no-properties 2))
16256 org-last-set-property)))
16257 (org-completing-read
16259 (if default-prop (concat " [" default-prop "]") "")
16261 (mapcar #'list (org-buffer-property-keys nil t t))
16262 nil nil nil nil default-prop)))
16264 (defun org-set-property-and-value (use-last)
16265 "Allow to set [PROPERTY]: [value] direction from prompt.
16266 When use-default, don't even ask, just use the last
16267 \"[PROPERTY]: [value]\" string from the history."
16269 (let* ((completion-ignore-case t)
16270 (pv (or (and use-last org-last-set-property-value)
16271 (org-completing-read
16272 "Enter a \"[Property]: [value]\" pair: "
16273 nil nil nil nil nil
16274 org-last-set-property-value)))
16276 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16277 (setq prop (match-string 1 pv)
16278 val (match-string 2 pv))
16279 (org-set-property prop val))))
16281 (defun org-set-property (property value)
16282 "In the current entry, set PROPERTY to VALUE.
16283 When called interactively, this will prompt for a property name, offering
16284 completion on existing and default properties. And then it will prompt
16285 for a value, offering completion either on allowed values (via an inherited
16286 xxx_ALL property) or on existing values in other instances of this property
16287 in the current file."
16288 (interactive (list nil nil))
16289 (let* ((property (or property (org-read-property-name)))
16290 (value (or value (org-read-property-value property)))
16291 (fn (cdr (assoc property org-properties-postprocess-alist))))
16292 (setq org-last-set-property property)
16293 (setq org-last-set-property-value (concat property ": " value))
16294 ;; Possibly postprocess the inserted value:
16295 (when fn (setq value (funcall fn value)))
16296 (unless (equal (org-entry-get nil property) value)
16297 (org-entry-put nil property value))))
16299 (defun org-find-property (property &optional value)
16300 "Find first entry in buffer that sets PROPERTY.
16302 When optional argument VALUE is non-nil, only consider an entry
16303 if it contains PROPERTY set to this value. If PROPERTY should be
16304 explicitly set to nil, use string \"nil\" for VALUE.
16306 Return position where the entry begins, or nil if there is no
16307 such entry. If narrowing is in effect, only search the visible
16308 part of the buffer."
16310 (goto-char (point-min))
16311 (let ((case-fold-search t)
16312 (re (org-re-property property nil (not value) value)))
16314 (while (re-search-forward re nil t)
16315 (when (if value (org-at-property-p)
16316 (org-entry-get (point) property nil t))
16317 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16319 (defun org-delete-property (property)
16320 "In the current entry, delete PROPERTY."
16322 (let* ((completion-ignore-case t)
16323 (cat (org-entry-get (point) "CATEGORY"))
16324 (props0 (org-entry-properties nil 'standard))
16325 (props (if cat props0
16326 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16327 (prop (if (< 1 (length props))
16328 (org-icompleting-read "Property: " props nil t)
16332 (message "No property to delete in this entry")
16333 (org-entry-delete nil property)
16334 (message "Property \"%s\" deleted" property)))
16336 (defun org-delete-property-globally (property)
16337 "Remove PROPERTY globally, from all entries.
16338 This function ignores narrowing, if any."
16340 (let* ((completion-ignore-case t)
16341 (prop (org-icompleting-read
16342 "Globally remove property: "
16343 (mapcar #'list (org-buffer-property-keys)))))
16345 (org-with-wide-buffer
16346 (goto-char (point-min))
16348 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16349 (while (re-search-forward re nil t)
16350 (when (org-entry-delete (point) property) (incf count)))
16351 (message "Property \"%s\" removed from %d entries" property count))))
16353 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16355 (defun org-compute-property-at-point ()
16356 "Compute the property at point.
16357 This looks for an enclosing column format, extracts the operator and
16358 then applies it to the property in the column format's scope."
16360 (unless (org-at-property-p)
16361 (user-error "Not at a property"))
16362 (let ((prop (org-match-string-no-properties 2)))
16363 (org-columns-get-format-and-top-level)
16364 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16365 (user-error "No operator defined for property %s" prop))
16366 (org-columns-compute prop)))
16368 (defvar org-property-allowed-value-functions nil
16369 "Hook for functions supplying allowed values for a specific property.
16370 The functions must take a single argument, the name of the property, and
16371 return a flat list of allowed values. If \":ETC\" is one of
16372 the values, this means that these values are intended as defaults for
16373 completion, but that other values should be allowed too.
16374 The functions must return nil if they are not responsible for this
16377 (defun org-property-get-allowed-values (pom property &optional table)
16378 "Get allowed values for the property PROPERTY.
16379 When TABLE is non-nil, return an alist that can directly be used for
16383 ((equal property "TODO")
16384 (setq vals (org-with-point-at pom
16385 (append org-todo-keywords-1 '("")))))
16386 ((equal property "PRIORITY")
16387 (let ((n org-lowest-priority))
16388 (while (>= n org-highest-priority)
16389 (push (char-to-string n) vals)
16391 ((equal property "CATEGORY"))
16392 ((member property org-special-properties))
16393 ((setq vals (run-hook-with-args-until-success
16394 'org-property-allowed-value-functions property)))
16396 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16397 (when (and vals (string-match "\\S-" vals))
16398 (setq vals (car (read-from-string (concat "(" vals ")"))))
16399 (setq vals (mapcar (lambda (x)
16400 (cond ((stringp x) x)
16401 ((numberp x) (number-to-string x))
16402 ((symbolp x) (symbol-name x))
16405 (when (member ":ETC" vals)
16406 (setq vals (remove ":ETC" vals))
16407 (org-add-props (car vals) '(org-unrestricted t)))
16408 (if table (mapcar 'list vals) vals)))
16410 (defun org-property-previous-allowed-value (&optional previous)
16411 "Switch to the next allowed value for this property."
16413 (org-property-next-allowed-value t))
16415 (defun org-property-next-allowed-value (&optional previous)
16416 "Switch to the next allowed value for this property."
16418 (unless (org-at-property-p)
16419 (user-error "Not at a property"))
16420 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16421 (key (match-string 2))
16422 (value (match-string 3))
16423 (allowed (or (org-property-get-allowed-values (point) key)
16424 (and (member value '("[ ]" "[-]" "[X]"))
16426 (heading (save-match-data (nth 4 (org-heading-components))))
16429 (user-error "Allowed values for this property have not been defined"))
16430 (if previous (setq allowed (reverse allowed)))
16431 (if (member value allowed)
16432 (setq nval (car (cdr (member value allowed)))))
16433 (setq nval (or nval (car allowed)))
16434 (if (equal nval value)
16435 (user-error "Only one allowed value for this property"))
16436 (org-at-property-p)
16437 (replace-match (concat " :" key ": " nval) t t)
16439 (beginning-of-line 1)
16440 (skip-chars-forward " \t")
16441 (when (equal prop org-effort-property)
16442 (org-refresh-property
16443 '((effort . identity)
16444 (effort-minutes . org-duration-string-to-minutes))
16446 (when (string= org-clock-current-task heading)
16447 (setq org-clock-effort nval)
16448 (org-clock-update-mode-line)))
16449 (run-hook-with-args 'org-property-changed-functions key nval)))
16451 (defun org-find-olp (path &optional this-buffer)
16452 "Return a marker pointing to the entry at outline path OLP.
16453 If anything goes wrong, throw an error.
16454 You can wrap this call to catch the error like this:
16456 (condition-case msg
16457 (org-mobile-locate-entry (match-string 4))
16458 (error (nth 1 msg)))
16460 The return value will then be either a string with the error message,
16461 or a marker if everything is OK.
16463 If THIS-BUFFER is set, the outline path does not contain a file,
16465 (let* ((file (if this-buffer buffer-file-name (pop path)))
16466 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16470 limit re end found pos heading cnt flevel)
16471 (unless buffer (error "File not found :%s" file))
16472 (with-current-buffer buffer
16476 (setq limit (point-max))
16477 (goto-char (point-min))
16478 (while (setq heading (pop path))
16479 (setq re (format org-complex-heading-regexp-format
16480 (regexp-quote heading)))
16481 (setq cnt 0 pos (point))
16482 (while (re-search-forward re end t)
16483 (setq level (- (match-end 1) (match-beginning 1)))
16484 (if (and (>= level lmin) (<= level lmax))
16485 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16486 (when (= cnt 0) (error "Heading not found on level %d: %s"
16488 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16491 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16492 (setq end (save-excursion (org-end-of-subtree t t))))
16493 (when (org-at-heading-p)
16494 (point-marker)))))))
16496 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16497 "Find node HEADING in BUFFER.
16498 Return a marker to the heading if it was found, or nil if not.
16499 If POS-ONLY is set, return just the position instead of a marker.
16501 The heading text must match exact, but it may have a TODO keyword,
16502 a priority cookie and tags in the standard locations."
16503 (with-current-buffer (or buffer (current-buffer))
16507 (goto-char (point-min))
16508 (let (case-fold-search)
16509 (if (re-search-forward
16510 (format org-complex-heading-regexp-format
16511 (regexp-quote heading)) nil t)
16513 (match-beginning 0)
16514 (move-marker (make-marker) (match-beginning 0)))))))))
16516 (defun org-find-exact-heading-in-directory (heading &optional dir)
16517 "Find Org node headline HEADING in all .org files in directory DIR.
16518 When the target headline is found, return a marker to this location."
16519 (let ((files (directory-files (or dir default-directory)
16520 t "\\`[^.#].*\\.org\\'"))
16521 file visiting m buffer)
16523 (while (setq file (pop files))
16524 (message "trying %s" file)
16525 (setq visiting (org-find-base-buffer-visiting file))
16526 (setq buffer (or visiting (find-file-noselect file)))
16527 (setq m (org-find-exact-headline-in-buffer
16529 (when (and (not m) (not visiting)) (kill-buffer buffer))
16530 (and m (throw 'found m))))))
16532 (defun org-find-entry-with-id (ident)
16533 "Locate the entry that contains the ID property with exact value IDENT.
16534 IDENT can be a string, a symbol or a number, this function will search for
16535 the string representation of it.
16536 Return the position where this entry starts, or nil if there is no such entry."
16537 (interactive "sID: ")
16539 ((stringp ident) ident)
16540 ((symbolp ident) (symbol-name ident))
16541 ((numberp ident) (number-to-string ident))
16542 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16543 (org-with-wide-buffer (org-find-property "ID" id))))
16547 (defvar org-last-changed-timestamp nil)
16548 (defvar org-last-inserted-timestamp nil
16549 "The last time stamp inserted with `org-insert-time-stamp'.")
16550 (defvar org-ts-what) ; dynamically scoped parameter
16552 (defun org-time-stamp (arg &optional inactive)
16553 "Prompt for a date/time and insert a time stamp.
16555 If the user specifies a time like HH:MM or if this command is
16556 called with at least one prefix argument, the time stamp contains
16557 the date and the time. Otherwise, only the date is included.
16559 All parts of a date not specified by the user are filled in from
16560 the timestamp at point, if any, or the current date/time
16563 If there is already a timestamp at the cursor, it is replaced.
16565 With two universal prefix arguments, insert an active timestamp
16566 with the current time without prompting the user.
16568 When called from lisp, the timestamp is inactive if INACTIVE is
16572 (cond ((org-at-date-range-p t)
16574 (goto-char (match-beginning 0))
16575 (looking-at (if inactive org-ts-regexp-both org-ts-regexp)))
16577 ((org-at-timestamp-p t) (match-string 0))))
16578 ;; Default time is either the timestamp at point or today.
16579 ;; When entering a range, only the range start is considered.
16580 (default-time (if (not ts) (current-time)
16581 (apply #'encode-time (org-parse-time-string ts))))
16582 (default-input (and ts (org-get-compact-tod ts)))
16584 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16585 (match-string 0 ts)))
16587 org-end-time-was-given
16589 (and (if (equal arg '(16)) (current-time)
16590 ;; Preserve `this-command' and `last-command'.
16591 (let ((this-command this-command)
16592 (last-command last-command))
16594 arg 'totime nil nil default-time default-input
16598 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16599 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16601 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16603 ;; Make sure we're on a timestamp. When in the middle of a date
16604 ;; range, move arbitrarily to range end.
16605 (unless (org-at-timestamp-p t)
16606 (skip-chars-forward "-")
16607 (org-at-timestamp-p t))
16609 (setq org-last-changed-timestamp
16610 (org-insert-time-stamp
16611 time (or org-time-was-given arg)
16612 inactive nil nil (list org-end-time-was-given)))
16615 (insert " " repeater)
16616 (setq org-last-changed-timestamp
16617 (concat (substring org-last-inserted-timestamp 0 -1)
16618 " " repeater ">")))
16619 (message "Timestamp updated"))
16620 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16621 (t (org-insert-time-stamp
16622 time (or org-time-was-given arg) inactive nil nil
16623 (list org-end-time-was-given))))))
16625 ;; FIXME: can we use this for something else, like computing time differences?
16626 (defun org-get-compact-tod (s)
16627 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16628 (let* ((t1 (match-string 1 s))
16629 (h1 (string-to-number (match-string 2 s)))
16630 (m1 (string-to-number (match-string 3 s)))
16631 (t2 (and (match-end 4) (match-string 5 s)))
16632 (h2 (and t2 (string-to-number (match-string 6 s))))
16633 (m2 (and t2 (string-to-number (match-string 7 s))))
16637 (setq dh (- h2 h1) dm (- m2 m1))
16638 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16639 (concat t1 "+" (number-to-string dh)
16640 (and (/= 0 dm) (format ":%02d" dm)))))))
16642 (defun org-time-stamp-inactive (&optional arg)
16643 "Insert an inactive time stamp.
16644 An inactive time stamp is enclosed in square brackets instead of angle
16645 brackets. It is inactive in the sense that it does not trigger agenda entries,
16646 does not link to the calendar and cannot be changed with the S-cursor keys.
16647 So these are more for recording a certain time/date."
16649 (org-time-stamp arg 'inactive))
16651 (defvar org-date-ovl (make-overlay 1 1))
16652 (overlay-put org-date-ovl 'face 'org-date-selected)
16653 (org-detach-overlay org-date-ovl)
16655 (defvar org-ans1) ; dynamically scoped parameter
16656 (defvar org-ans2) ; dynamically scoped parameter
16658 (defvar org-plain-time-of-day-regexp) ; defined below
16660 (defvar org-overriding-default-time nil) ; dynamically scoped
16661 (defvar org-read-date-overlay nil)
16662 (defvar org-dcst nil) ; dynamically scoped
16663 (defvar org-read-date-history nil)
16664 (defvar org-read-date-final-answer nil)
16665 (defvar org-read-date-analyze-futurep nil)
16666 (defvar org-read-date-analyze-forced-year nil)
16667 (defvar org-read-date-inactive)
16669 (defvar org-read-date-minibuffer-local-map
16670 (let* ((map (make-sparse-keymap)))
16671 (set-keymap-parent map minibuffer-local-map)
16672 (org-defkey map (kbd ".")
16673 (lambda () (interactive)
16674 ;; Are we at the beginning of the prompt?
16675 (if (looking-back "^[^:]+: ")
16676 (org-eval-in-calendar '(calendar-goto-today))
16678 (org-defkey map (kbd "C-.")
16679 (lambda () (interactive)
16680 (org-eval-in-calendar '(calendar-goto-today))))
16681 (org-defkey map [(meta shift left)]
16682 (lambda () (interactive)
16683 (org-eval-in-calendar '(calendar-backward-month 1))))
16684 (org-defkey map [(meta shift right)]
16685 (lambda () (interactive)
16686 (org-eval-in-calendar '(calendar-forward-month 1))))
16687 (org-defkey map [(meta shift up)]
16688 (lambda () (interactive)
16689 (org-eval-in-calendar '(calendar-backward-year 1))))
16690 (org-defkey map [(meta shift down)]
16691 (lambda () (interactive)
16692 (org-eval-in-calendar '(calendar-forward-year 1))))
16693 (org-defkey map [?\e (shift left)]
16694 (lambda () (interactive)
16695 (org-eval-in-calendar '(calendar-backward-month 1))))
16696 (org-defkey map [?\e (shift right)]
16697 (lambda () (interactive)
16698 (org-eval-in-calendar '(calendar-forward-month 1))))
16699 (org-defkey map [?\e (shift up)]
16700 (lambda () (interactive)
16701 (org-eval-in-calendar '(calendar-backward-year 1))))
16702 (org-defkey map [?\e (shift down)]
16703 (lambda () (interactive)
16704 (org-eval-in-calendar '(calendar-forward-year 1))))
16705 (org-defkey map [(shift up)]
16706 (lambda () (interactive)
16707 (org-eval-in-calendar '(calendar-backward-week 1))))
16708 (org-defkey map [(shift down)]
16709 (lambda () (interactive)
16710 (org-eval-in-calendar '(calendar-forward-week 1))))
16711 (org-defkey map [(shift left)]
16712 (lambda () (interactive)
16713 (org-eval-in-calendar '(calendar-backward-day 1))))
16714 (org-defkey map [(shift right)]
16715 (lambda () (interactive)
16716 (org-eval-in-calendar '(calendar-forward-day 1))))
16717 (org-defkey map "!"
16718 (lambda () (interactive)
16719 (org-eval-in-calendar '(diary-view-entries))
16721 (org-defkey map ">"
16722 (lambda () (interactive)
16723 (org-eval-in-calendar '(calendar-scroll-left 1))))
16724 (org-defkey map "<"
16725 (lambda () (interactive)
16726 (org-eval-in-calendar '(calendar-scroll-right 1))))
16727 (org-defkey map "\C-v"
16728 (lambda () (interactive)
16729 (org-eval-in-calendar
16730 '(calendar-scroll-left-three-months 1))))
16731 (org-defkey map "\M-v"
16732 (lambda () (interactive)
16733 (org-eval-in-calendar
16734 '(calendar-scroll-right-three-months 1))))
16736 "Keymap for minibuffer commands when using `org-read-date'.")
16739 (defvar org-defdecode)
16740 (defvar org-with-time)
16742 (defun org-read-date (&optional org-with-time to-time from-string prompt
16743 default-time default-input inactive)
16744 "Read a date, possibly a time, and make things smooth for the user.
16745 The prompt will suggest to enter an ISO date, but you can also enter anything
16746 which will at least partially be understood by `parse-time-string'.
16747 Unrecognized parts of the date will default to the current day, month, year,
16748 hour and minute. If this command is called to replace a timestamp at point,
16749 or to enter the second timestamp of a range, the default time is taken
16750 from the existing stamp. Furthermore, the command prefers the future,
16751 so if you are giving a date where the year is not given, and the day-month
16752 combination is already past in the current year, it will assume you
16753 mean next year. For details, see the manual. A few examples:
16755 3-2-5 --> 2003-02-05
16756 feb 15 --> currentyear-02-15
16757 2/15 --> currentyear-02-15
16758 sep 12 9 --> 2009-09-12
16759 12:45 --> today 12:45
16760 22 sept 0:34 --> currentyear-09-22 0:34
16761 12 --> currentyear-currentmonth-12
16762 Fri --> nearest Friday after today
16763 -Tue --> last Tuesday
16766 Furthermore you can specify a relative date by giving, as the *first* thing
16767 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16768 change in days weeks, months, years.
16769 With a single plus or minus, the date is relative to today. With a double
16770 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16771 +4d --> four days from today
16772 +4 --> same as above
16773 +2w --> two weeks from today
16774 ++5 --> five days from default date
16776 The function understands only English month and weekday abbreviations.
16778 While prompting, a calendar is popped up - you can also select the
16779 date with the mouse (button 1). The calendar shows a period of three
16780 months. To scroll it to other months, use the keys `>' and `<'.
16781 If you don't like the calendar, turn it off with
16782 \(setq org-read-date-popup-calendar nil)
16784 With optional argument TO-TIME, the date will immediately be converted
16785 to an internal time.
16786 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16787 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16788 still enter a time, and this function will inform the calling routine
16789 about this change. The calling routine may then choose to change the
16790 format used to insert the time stamp into the buffer to include the time.
16791 With optional argument FROM-STRING, read from this string instead from
16792 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16793 the time/date that is used for everything that is not specified by the
16795 (require 'parse-time)
16796 (let* ((org-time-stamp-rounding-minutes
16797 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16798 (org-dcst org-display-custom-times)
16799 (ct (org-current-time))
16800 (org-def (or org-overriding-default-time default-time ct))
16801 (org-defdecode (decode-time org-def))
16803 (when (< (nth 2 org-defdecode) org-extend-today-until)
16804 (setcar (nthcdr 2 org-defdecode) -1)
16805 (setcar (nthcdr 1 org-defdecode) 59)
16806 (setq org-def (apply 'encode-time org-defdecode)
16807 org-defdecode (decode-time org-def)))))
16808 (cur-frame (selected-frame))
16809 (mouse-autoselect-window nil) ; Don't let the mouse jump
16810 (calendar-frame-setup nil)
16811 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16812 (calendar-move-hook nil)
16813 (calendar-view-diary-initially-flag nil)
16814 (calendar-view-holidays-initially-flag nil)
16815 (timestr (format-time-string
16816 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16817 (prompt (concat (if prompt (concat prompt " ") "")
16818 (format "Date+time [%s]: " timestr)))
16819 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16822 (from-string (setq ans from-string))
16823 (org-read-date-popup-calendar
16825 (save-window-excursion
16827 (when (eq calendar-setup 'calendar-only)
16829 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16830 (select-frame cal-frame))
16831 (org-eval-in-calendar '(setq cursor-type nil) t)
16834 (calendar-forward-day (- (time-to-days org-def)
16835 (calendar-absolute-from-gregorian
16836 (calendar-current-date))))
16837 (org-eval-in-calendar nil t)
16838 (let* ((old-map (current-local-map))
16839 (map (copy-keymap calendar-mode-map))
16840 (minibuffer-local-map
16841 (copy-keymap org-read-date-minibuffer-local-map)))
16842 (org-defkey map (kbd "RET") 'org-calendar-select)
16843 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16844 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16847 (use-local-map map)
16848 (setq org-read-date-inactive inactive)
16849 (add-hook 'post-command-hook 'org-read-date-display)
16850 (setq org-ans0 (read-string prompt default-input
16851 'org-read-date-history nil))
16852 ;; org-ans0: from prompt
16853 ;; org-ans1: from mouse click
16854 ;; org-ans2: from calendar motion
16855 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16856 (remove-hook 'post-command-hook 'org-read-date-display)
16857 (use-local-map old-map)
16858 (when org-read-date-overlay
16859 (delete-overlay org-read-date-overlay)
16860 (setq org-read-date-overlay nil)))))
16861 (bury-buffer "*Calendar*")
16863 (delete-frame cal-frame)
16864 (select-frame-set-input-focus cur-frame))))))
16866 (t ; Naked prompt only
16868 (setq ans (read-string prompt default-input
16869 'org-read-date-history timestr))
16870 (when org-read-date-overlay
16871 (delete-overlay org-read-date-overlay)
16872 (setq org-read-date-overlay nil)))))
16874 (setq final (org-read-date-analyze ans org-def org-defdecode))
16876 (when org-read-date-analyze-forced-year
16877 (message "Year was forced into %s"
16878 (if org-read-date-force-compatible-dates
16879 "compatible range (1970-2037)"
16880 "range representable on this machine"))
16883 ;; One round trip to get rid of 34th of August and stuff like that....
16884 (setq final (decode-time (apply 'encode-time final)))
16886 (setq org-read-date-final-answer ans)
16889 (apply 'encode-time final)
16890 (if (and (boundp 'org-time-was-given) org-time-was-given)
16891 (format "%04d-%02d-%02d %02d:%02d"
16892 (nth 5 final) (nth 4 final) (nth 3 final)
16893 (nth 2 final) (nth 1 final))
16894 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16896 (defun org-read-date-display ()
16897 "Display the current date prompt interpretation in the minibuffer."
16898 (when org-read-date-display-live
16899 (when org-read-date-overlay
16900 (delete-overlay org-read-date-overlay))
16901 (when (minibufferp (current-buffer))
16904 (while (not (equal (buffer-substring
16905 (max (point-min) (- (point) 4)) (point))
16908 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16909 " " (or org-ans1 org-ans2)))
16910 (org-end-time-was-given nil)
16911 (f (org-read-date-analyze ans org-def org-defdecode))
16913 org-time-stamp-custom-formats
16914 org-time-stamp-formats))
16915 (fmt (if (or org-with-time
16916 (and (boundp 'org-time-was-given) org-time-was-given))
16919 (txt (format-time-string fmt (apply 'encode-time f)))
16920 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16921 (txt (concat "=> " txt)))
16922 (when (and org-end-time-was-given
16923 (string-match org-plain-time-of-day-regexp txt))
16924 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16925 org-end-time-was-given
16926 (substring txt (match-end 0)))))
16927 (when org-read-date-analyze-futurep
16928 (setq txt (concat txt " (=>F)")))
16929 (setq org-read-date-overlay
16930 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16931 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16933 (defun org-read-date-analyze (ans org-def org-defdecode)
16934 "Analyze the combined answer of the date prompt."
16935 ;; FIXME: cleanup and comment
16936 (let ((nowdecode (decode-time (current-time)))
16937 delta deltan deltaw deltadef year month day
16938 hour minute second wday pm h2 m2 tl wday1
16939 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16940 (setq org-read-date-analyze-futurep nil
16941 org-read-date-analyze-forced-year nil)
16942 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16945 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16946 (setq ans (replace-match "" t t ans)
16948 deltaw (nth 1 delta)
16949 deltadef (nth 2 delta)))
16951 ;; Check if there is an iso week date in there. If yes, store the
16952 ;; info and postpone interpreting it until the rest of the parsing
16954 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16955 (setq iso-year (if (match-end 1)
16956 (org-small-year-to-year
16957 (string-to-number (match-string 1 ans))))
16958 iso-weekday (if (match-end 3)
16959 (string-to-number (match-string 3 ans)))
16960 iso-week (string-to-number (match-string 2 ans)))
16961 (setq ans (replace-match "" t t ans)))
16963 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16964 (when (string-match
16965 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16966 (setq year (if (match-end 2)
16967 (string-to-number (match-string 2 ans))
16968 (progn (setq kill-year t)
16969 (string-to-number (format-time-string "%Y"))))
16970 month (string-to-number (match-string 3 ans))
16971 day (string-to-number (match-string 4 ans)))
16972 (if (< year 100) (setq year (+ 2000 year)))
16973 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16976 ;; Help matching dotted european dates
16977 (when (string-match
16978 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16979 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16981 (string-to-number (format-time-string "%Y")))
16982 day (string-to-number (match-string 1 ans))
16983 month (string-to-number (match-string 2 ans))
16984 ans (replace-match (format "%04d-%02d-%02d" year month day)
16987 ;; Help matching american dates, like 5/30 or 5/30/7
16988 (when (string-match
16989 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16990 (setq year (if (match-end 4)
16991 (string-to-number (match-string 4 ans))
16992 (progn (setq kill-year t)
16993 (string-to-number (format-time-string "%Y"))))
16994 month (string-to-number (match-string 1 ans))
16995 day (string-to-number (match-string 2 ans)))
16996 (if (< year 100) (setq year (+ 2000 year)))
16997 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16999 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17000 ;; If there is a time with am/pm, and *no* time without it, we convert
17001 ;; so that matching will be successful.
17002 (loop for i from 1 to 2 do ; twice, for end time as well
17003 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17004 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17005 (setq hour (string-to-number (match-string 1 ans))
17006 minute (if (match-end 3)
17007 (string-to-number (match-string 3 ans))
17010 (string-to-char (downcase (match-string 4 ans)))))
17011 (if (and (= hour 12) (not pm))
17013 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17014 (setq ans (replace-match (format "%02d:%02d" hour minute)
17017 ;; Check if a time range is given as a duration
17018 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17019 (setq hour (string-to-number (match-string 1 ans))
17020 h2 (+ hour (string-to-number (match-string 3 ans)))
17021 minute (string-to-number (match-string 2 ans))
17022 m2 (+ minute (if (match-end 5) (string-to-number
17023 (match-string 5 ans))0)))
17024 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17025 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17028 ;; Check if there is a time range
17029 (when (boundp 'org-end-time-was-given)
17030 (setq org-time-was-given nil)
17031 (when (and (string-match org-plain-time-of-day-regexp ans)
17033 (setq org-end-time-was-given (match-string 8 ans))
17034 (setq ans (concat (substring ans 0 (match-beginning 7))
17035 (substring ans (match-end 7))))))
17037 (setq tl (parse-time-string ans)
17038 day (or (nth 3 tl) (nth 3 org-defdecode))
17041 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17042 ;; Day was specified. Make sure DAY+MONTH
17043 ;; combination happens in the future.
17046 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17047 (nth 4 nowdecode)))
17048 (t (nth 4 org-defdecode)))
17050 (cond ((and (not kill-year) (nth 5 tl)))
17051 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17052 ;; Month was guessed in the future and is at least
17053 ;; equal to NOWDECODE's. Fix year accordingly.
17055 (if (or (> month (nth 4 nowdecode))
17056 (>= day (nth 3 nowdecode)))
17058 (1+ (nth 5 nowdecode))))
17059 ;; Month was specified. Make sure MONTH+YEAR
17060 ;; combination happens in the future.
17063 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17064 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17065 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17066 (t (nth 5 nowdecode))))
17067 (t (nth 5 org-defdecode)))
17068 hour (or (nth 2 tl) (nth 2 org-defdecode))
17069 minute (or (nth 1 tl) (nth 1 org-defdecode))
17070 second (or (nth 0 tl) 0)
17073 (when (and (eq org-read-date-prefer-future 'time)
17074 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17075 (equal day (nth 3 nowdecode))
17076 (equal month (nth 4 nowdecode))
17077 (equal year (nth 5 nowdecode))
17079 (or (< (nth 2 tl) (nth 2 nowdecode))
17080 (and (= (nth 2 tl) (nth 2 nowdecode))
17082 (< (nth 1 tl) (nth 1 nowdecode)))))
17086 ;; Special date definitions below
17089 ;; There was an iso week
17092 (setq year (or iso-year year)
17093 day (or iso-weekday wday 1)
17094 wday nil ; to make sure that the trigger below does not match
17095 iso-date (calendar-gregorian-from-absolute
17096 (calendar-iso-to-absolute
17097 (list iso-week day year))))
17098 ; FIXME: Should we also push ISO weeks into the future?
17099 ; (when (and org-read-date-prefer-future
17101 ; (< (calendar-absolute-from-gregorian iso-date)
17102 ; (time-to-days (current-time))))
17103 ; (setq year (1+ year)
17104 ; iso-date (calendar-gregorian-from-absolute
17105 ; (calendar-iso-to-absolute
17106 ; (list iso-week day year)))))
17107 (setq month (car iso-date)
17108 year (nth 2 iso-date)
17109 day (nth 1 iso-date)))
17113 (let ((now (decode-time (current-time))))
17114 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17115 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17116 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17117 ((equal deltaw "m") (setq month (+ month deltan)))
17118 ((equal deltaw "y") (setq year (+ year deltan)))))
17119 ((and wday (not (nth 3 tl)))
17120 ;; Weekday was given, but no day, so pick that day in the week
17121 ;; on or after the derived date.
17122 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17123 (unless (equal wday wday1)
17124 (setq day (+ day (% (- wday wday1 -7) 7))))))
17125 (if (and (boundp 'org-time-was-given)
17127 (setq org-time-was-given t))
17128 (if (< year 100) (setq year (+ 2000 year)))
17129 ;; Check of the date is representable
17130 (if org-read-date-force-compatible-dates
17133 (setq year 1970 org-read-date-analyze-forced-year t))
17135 (setq year 2037 org-read-date-analyze-forced-year t)))
17136 (condition-case nil
17137 (ignore (encode-time second minute hour day month year))
17139 (setq year (nth 5 org-defdecode))
17140 (setq org-read-date-analyze-forced-year t))))
17141 (setq org-read-date-analyze-futurep futurep)
17142 (list second minute hour day month year)))
17144 (defvar parse-time-weekdays)
17145 (defun org-read-date-get-relative (s today default)
17146 "Check string S for special relative date string.
17147 TODAY and DEFAULT are internal times, for today and for a default.
17148 Return shift list (N what def-flag)
17149 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17150 N is the number of WHATs to shift.
17151 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17152 the DEFAULT date rather than TODAY."
17153 (require 'parse-time)
17157 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17159 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17160 "\\([ \t]\\|$\\)") s)
17161 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17162 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17163 (string-to-char (substring (match-string 1 s) -1))
17165 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17166 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17167 (what (if (match-end 3) (match-string 3 s) "d"))
17168 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17169 (date (if rel default today))
17170 (wday (nth 6 (decode-time date)))
17174 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17175 (if (= delta 0) (setq delta 7))
17178 (setq delta (- delta 7))
17179 (if (= delta 0) (setq delta -7))))
17180 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17181 (list delta "d" rel))
17182 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17184 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17185 "Turn a user-specified date into the internal representation.
17186 The internal representation needed by the calendar is (month day year).
17187 This is a wrapper to handle the brain-dead convention in calendar that
17188 user function argument order change dependent on argument order."
17189 (if (boundp 'calendar-date-style)
17191 ((eq calendar-date-style 'american)
17192 (list arg1 arg2 arg3))
17193 ((eq calendar-date-style 'european)
17194 (list arg2 arg1 arg3))
17195 ((eq calendar-date-style 'iso)
17196 (list arg2 arg3 arg1)))
17197 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17198 (if (org-bound-and-true-p european-calendar-style)
17199 (list arg2 arg1 arg3)
17200 (list arg1 arg2 arg3)))))
17202 (defun org-eval-in-calendar (form &optional keepdate)
17203 "Eval FORM in the calendar window and return to current window.
17204 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17205 otherwise stick to the current value of `org-ans2'."
17206 (let ((sf (selected-frame))
17207 (sw (selected-window)))
17208 (select-window (get-buffer-window "*Calendar*" t))
17210 (when (and (not keepdate) (calendar-cursor-to-date))
17211 (let* ((date (calendar-cursor-to-date))
17212 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17213 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17214 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17216 (org-select-frame-set-input-focus sf)))
17218 (defun org-calendar-select ()
17219 "Return to `org-read-date' with the date currently selected.
17220 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17222 (when (calendar-cursor-to-date)
17223 (let* ((date (calendar-cursor-to-date))
17224 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17225 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17226 (if (active-minibuffer-window) (exit-minibuffer))))
17228 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17229 "Insert a date stamp for the date given by the internal TIME.
17230 See `format-time-string' for the format of TIME.
17231 WITH-HM means use the stamp format that includes the time of the day.
17232 INACTIVE means use square brackets instead of angular ones, so that the
17233 stamp will not contribute to the agenda.
17234 PRE and POST are optional strings to be inserted before and after the
17236 The command returns the inserted time stamp."
17237 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17239 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17240 (insert-before-markers (or pre ""))
17241 (when (listp extra)
17242 (setq extra (car extra))
17243 (if (and (stringp extra)
17244 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17245 (setq extra (format "-%02d:%02d"
17246 (string-to-number (match-string 1 extra))
17247 (string-to-number (match-string 2 extra))))
17250 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17251 (insert-before-markers (setq stamp (format-time-string fmt time)))
17252 (insert-before-markers (or post ""))
17253 (setq org-last-inserted-timestamp stamp)))
17255 (defun org-toggle-time-stamp-overlays ()
17256 "Toggle the use of custom time stamp formats."
17258 (setq org-display-custom-times (not org-display-custom-times))
17259 (unless org-display-custom-times
17260 (let ((p (point-min)) (bmp (buffer-modified-p)))
17261 (while (setq p (next-single-property-change p 'display))
17262 (if (and (get-text-property p 'display)
17263 (eq (get-text-property p 'face) 'org-date))
17264 (remove-text-properties
17265 p (setq p (next-single-property-change p 'display))
17267 (set-buffer-modified-p bmp)))
17268 (if (featurep 'xemacs)
17269 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17270 (org-restart-font-lock)
17271 (setq org-table-may-need-update t)
17272 (if org-display-custom-times
17273 (message "Time stamps are overlaid with custom format")
17274 (message "Time stamp overlays removed")))
17276 (defun org-display-custom-time (beg end)
17277 "Overlay modified time stamp format over timestamp between BEG and END."
17278 (let* ((ts (buffer-substring beg end))
17279 t1 w1 with-hm tf time str w2 (off 0))
17281 (setq t1 (org-parse-time-string ts t))
17282 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17283 (setq off (- (match-end 0) (match-beginning 0)))))
17284 (setq end (- end off))
17285 (setq w1 (- end beg)
17286 with-hm (and (nth 1 t1) (nth 2 t1))
17287 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17288 time (org-fix-decoded-time t1)
17290 (format-time-string
17291 (substring tf 1 -1) (apply 'encode-time time))
17292 nil 'mouse-face 'highlight)
17294 (if (not (= w2 w1))
17295 (add-text-properties (1+ beg) (+ 2 beg)
17296 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17297 (if (featurep 'xemacs)
17299 (put-text-property beg end 'invisible t)
17300 (put-text-property beg end 'end-glyph (make-glyph str)))
17301 (put-text-property beg end 'display str))))
17303 (defun org-fix-decoded-time (time)
17304 "Set 0 instead of nil for the first 6 elements of time.
17305 Don't touch the rest."
17307 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17309 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17311 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17312 "Difference between TIMESTAMP-STRING and now in days.
17313 If SECONDS is non-nil, return the difference in seconds."
17314 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17315 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17316 (funcall fdiff (current-time)))))
17318 (defun org-deadline-close (timestamp-string &optional ndays)
17319 "Is the time in TIMESTAMP-STRING close to the current date?"
17320 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17321 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17322 (not (org-entry-is-done-p))))
17324 (defun org-get-wdays (ts &optional delay zero-delay)
17325 "Get the deadline lead time appropriate for timestring TS.
17326 When DELAY is non-nil, get the delay time for scheduled items
17327 instead of the deadline lead time. When ZERO-DELAY is non-nil
17328 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17329 don't try to find the delay cookie in the scheduled timestamp."
17330 (let ((tv (if delay org-scheduled-delay-days
17331 org-deadline-warning-days)))
17333 ((or (and delay (< tv 0))
17334 (and delay zero-delay (<= tv 0))
17335 (and (not delay) (<= tv 0)))
17336 ;; Enforce this value no matter what
17338 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17339 ;; lead time is specified.
17340 (floor (* (string-to-number (match-string 1 ts))
17341 (cdr (assoc (match-string 2 ts)
17342 '(("d" . 1) ("w" . 7)
17343 ("m" . 30.4) ("y" . 365.25)
17344 ("h" . 0.041667)))))))
17345 ;; go for the default.
17348 (defun org-calendar-select-mouse (ev)
17349 "Return to `org-read-date' with the date currently selected.
17350 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17352 (mouse-set-point ev)
17353 (when (calendar-cursor-to-date)
17354 (let* ((date (calendar-cursor-to-date))
17355 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17356 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17357 (if (active-minibuffer-window) (exit-minibuffer))))
17359 (defun org-check-deadlines (ndays)
17360 "Check if there are any deadlines due or past due.
17361 A deadline is considered due if it happens within `org-deadline-warning-days'
17362 days from today's date. If the deadline appears in an entry marked DONE,
17363 it is not shown. The prefix arg NDAYS can be used to test that many
17364 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17366 (let* ((org-warn-days
17368 ((equal ndays '(4)) 100000)
17369 (ndays (prefix-numeric-value ndays))
17370 (t (abs org-deadline-warning-days))))
17371 (case-fold-search nil)
17372 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17374 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17376 (message "%d deadlines past-due or due within %d days"
17377 (org-occur regexp nil callback)
17380 (defsubst org-re-timestamp (type)
17381 "Return a regexp for timestamp TYPE.
17382 Allowed values for TYPE are:
17384 all: all timestamps
17385 active: only active timestamps (<...>)
17386 inactive: only inactive timestamps ([...])
17387 scheduled: only scheduled timestamps
17388 deadline: only deadline timestamps
17389 closed: only closed time-stamps
17391 When TYPE is nil, fall back on returning a regexp that matches
17392 both scheduled and deadline timestamps."
17394 (all org-ts-regexp-both)
17395 (active org-ts-regexp)
17396 (inactive org-ts-regexp-inactive)
17397 (scheduled org-scheduled-time-regexp)
17398 (deadline org-deadline-time-regexp)
17399 (closed org-closed-time-regexp)
17402 (regexp-opt (list org-deadline-string org-scheduled-string))
17403 " *<\\([^>]+\\)>"))))
17405 (defun org-check-before-date (date)
17406 "Check if there are deadlines or scheduled entries before DATE."
17407 (interactive (list (org-read-date)))
17408 (let ((case-fold-search nil)
17409 (regexp (org-re-timestamp org-ts-type))
17412 (and ,(if (memq org-ts-type '(active inactive all))
17413 '(eq (org-element-type (org-element-context)) 'timestamp)
17414 '(org-at-planning-p))
17416 (org-time-string-to-time (match-string 1))
17417 (org-time-string-to-time date))))))
17418 (message "%d entries before %s"
17419 (org-occur regexp nil callback) date)))
17421 (defun org-check-after-date (date)
17422 "Check if there are deadlines or scheduled entries after DATE."
17423 (interactive (list (org-read-date)))
17424 (let ((case-fold-search nil)
17425 (regexp (org-re-timestamp org-ts-type))
17428 (and ,(if (memq org-ts-type '(active inactive all))
17429 '(eq (org-element-type (org-element-context)) 'timestamp)
17430 '(org-at-planning-p))
17432 (org-time-string-to-time (match-string 1))
17433 (org-time-string-to-time date)))))))
17434 (message "%d entries after %s"
17435 (org-occur regexp nil callback) date)))
17437 (defun org-check-dates-range (start-date end-date)
17438 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17439 (interactive (list (org-read-date nil nil nil "Range starts")
17440 (org-read-date nil nil nil "Range end")))
17441 (let ((case-fold-search nil)
17442 (regexp (org-re-timestamp org-ts-type))
17445 (let ((match (match-string 1)))
17447 ,(if (memq org-ts-type '(active inactive all))
17448 '(eq (org-element-type (org-element-context)) 'timestamp)
17449 '(org-at-planning-p))
17451 (org-time-string-to-time match)
17452 (org-time-string-to-time start-date)))
17454 (org-time-string-to-time match)
17455 (org-time-string-to-time end-date)))))))
17456 (message "%d entries between %s and %s"
17457 (org-occur regexp nil callback) start-date end-date)))
17459 (defun org-evaluate-time-range (&optional to-buffer)
17460 "Evaluate a time range by computing the difference between start and end.
17461 Normally the result is just printed in the echo area, but with prefix arg
17462 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17463 If the time range is actually in a table, the result is inserted into the
17465 For time difference computation, a year is assumed to be exactly 365
17466 days in order to avoid rounding problems."
17469 (org-clock-update-time-maybe)
17471 (unless (org-at-date-range-p t)
17472 (goto-char (point-at-bol))
17473 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17474 (if (not (org-at-date-range-p t))
17475 (user-error "Not at a time-stamp range, and none found in current line")))
17476 (let* ((ts1 (match-string 1))
17477 (ts2 (match-string 2))
17478 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17479 (match-end (match-end 0))
17480 (time1 (org-time-string-to-time ts1))
17481 (time2 (org-time-string-to-time ts2))
17482 (t1 (org-float-time time1))
17483 (t2 (org-float-time time2))
17484 (diff (abs (- t2 t1)))
17485 (negative (< (- t2 t1) 0))
17486 ;; (ys (floor (* 365 24 60 60)))
17489 (fy "%dy %dd %02d:%02d")
17491 (fd "%dd %02d:%02d")
17496 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17498 d (floor (/ diff ds)) diff (mod diff ds)
17499 h (floor (/ diff hs)) diff (mod diff hs)
17500 m (floor (/ diff 60)))
17501 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17503 d (floor (+ (/ diff ds) 0.5))
17505 (if (not to-buffer)
17506 (message "%s" (org-make-tdiff-string y d h m))
17507 (if (org-at-table-p)
17509 (goto-char match-end)
17511 (and (looking-at " *|") (goto-char (match-end 0))))
17512 (goto-char match-end))
17514 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17515 (replace-match ""))
17516 (if negative (insert " -"))
17517 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17518 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17519 (insert " " (format fh h m))))
17520 (if align (org-table-align))
17521 (message "Time difference inserted")))))
17523 (defun org-make-tdiff-string (y d h m)
17526 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17528 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17530 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17532 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17534 (apply 'format fmt (nreverse l))))
17536 (defun org-time-string-to-time (s &optional buffer pos)
17537 "Convert a timestamp string into internal time."
17538 (condition-case errdata
17539 (apply 'encode-time (org-parse-time-string s))
17540 (error (error "Bad timestamp `%s'%s\nError was: %s"
17541 s (if (not (and buffer pos))
17543 (format " at %d in buffer `%s'" pos buffer))
17546 (defun org-time-string-to-seconds (s)
17547 "Convert a timestamp string to a number of seconds."
17548 (org-float-time (org-time-string-to-time s)))
17550 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17551 "Convert a time stamp to an absolute day number.
17552 If there is a specifier for a cyclic time stamp, get the closest
17554 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17555 The variable `date' is bound by the calendar when this is called."
17557 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17558 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17561 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17562 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17563 (time-to-days (current-time))) (match-string 0 s)
17566 (condition-case errdata
17567 (apply 'encode-time (org-parse-time-string s))
17568 (error (error "Bad timestamp `%s'%s\nError was: %s"
17569 s (if (not (and buffer pos))
17571 (format " at %d in buffer `%s'" pos buffer))
17572 (cdr errdata))))))))
17574 (defun org-days-to-iso-week (days)
17575 "Return the iso week number."
17577 (car (calendar-iso-from-absolute days)))
17579 (defun org-small-year-to-year (year)
17580 "Convert 2-digit years into 4-digit years.
17581 YEAR is expanded into one of the 30 next years, if possible, or
17582 into a past one. Any year larger than 99 is returned unchanged."
17583 (if (>= year 100) year
17584 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17585 (century (/ current 100))
17586 (offset (- year (% current 100))))
17587 (cond ((> offset 30) (+ (* (1- century) 100) year))
17588 ((> offset -70) (+ (* century 100) year))
17589 (t (+ (* (1+ century) 100) year))))))
17591 (defun org-time-from-absolute (d)
17592 "Return the time corresponding to date D.
17593 D may be an absolute day number, or a calendar-type list (month day year)."
17594 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17595 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17597 (defun org-calendar-holiday ()
17598 "List of holidays, for Diary display in Org-mode."
17599 (require 'holidays)
17601 (if (fboundp 'calendar-check-holidays)
17602 'calendar-check-holidays 'check-calendar-holidays) date)))
17603 (if hl (mapconcat 'identity hl "; "))))
17605 (defun org-diary-sexp-entry (sexp entry date)
17606 "Process a SEXP diary ENTRY for DATE."
17607 (require 'diary-lib)
17608 (let ((result (if calendar-debug-sexp
17609 (let ((stack-trace-on-error t))
17610 (eval (car (read-from-string sexp))))
17611 (condition-case nil
17612 (eval (car (read-from-string sexp)))
17615 (message "Bad sexp at line %d in %s: %s"
17617 (buffer-file-name) sexp)
17619 (cond ((stringp result) (split-string result "; "))
17620 ((and (consp result)
17621 (not (consp (cdr result)))
17622 (stringp (cdr result))) (cdr result))
17623 ((and (consp result)
17624 (stringp (car result))) result)
17627 (defun org-diary-to-ical-string (frombuf)
17628 "Get iCalendar entries from diary entries in buffer FROMBUF.
17629 This uses the icalendar.el library."
17630 (let* ((tmpdir (if (featurep 'xemacs)
17632 temporary-file-directory))
17633 (tmpfile (make-temp-name
17634 (expand-file-name "orgics" tmpdir)))
17636 (with-current-buffer frombuf
17637 (icalendar-export-region (point-min) (point-max) tmpfile)
17638 (setq buf (find-buffer-visiting tmpfile))
17640 (goto-char (point-min))
17641 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17642 (setq b (match-beginning 0)))
17643 (goto-char (point-max))
17644 (if (re-search-backward "^END:VEVENT" nil t)
17645 (setq e (match-end 0)))
17646 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17648 (delete-file tmpfile)
17651 (defun org-closest-date (start current change prefer show-all)
17652 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17653 When PREFER is `past', return a date that is either CURRENT or past.
17654 When PREFER is `future', return a date that is either CURRENT or future.
17655 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17656 ;; Make the proper lists from the dates
17658 (let ((a1 '(("h" . hour)
17663 (shour (nth 2 (org-parse-time-string start)))
17664 dn dw sday cday n1 n2 n0
17665 d m y y1 y2 date1 date2 nmonths nm ny m2)
17667 (setq start (org-date-to-gregorian start)
17668 current (org-date-to-gregorian
17671 (time-to-days (current-time))))
17672 sday (calendar-absolute-from-gregorian start)
17673 cday (calendar-absolute-from-gregorian current))
17675 (if (<= cday sday) (throw 'exit sday))
17677 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17678 (setq dn (string-to-number (match-string 1 change))
17679 dw (cdr (assoc (match-string 2 change) a1)))
17680 (user-error "Invalid change specifier: %s" change))
17681 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17684 (let ((missing-hours
17685 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17687 (setq n1 (if (zerop missing-hours) cday
17688 (- cday (1+ (floor (/ missing-hours 24)))))
17689 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17691 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17694 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17695 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17696 (setq date1 (list m d y1)
17697 n1 (calendar-absolute-from-gregorian date1)
17698 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17699 n2 (calendar-absolute-from-gregorian date2)))
17701 ;; approx number of month between the two dates
17702 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17703 ;; How often does dn fit in there?
17704 (setq d (nth 1 start) m (car start) y (nth 2 start)
17705 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17707 ny (floor (/ m 12))
17710 (while (> m 12) (setq m (- m 12) y (1+ y)))
17711 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17712 (setq m2 (+ m dn) y2 y)
17713 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17714 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17715 (while (<= n2 cday)
17716 (setq n1 n2 m m2 y y2)
17717 (setq m2 (+ m dn) y2 y)
17718 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17719 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17720 ;; Make sure n1 is the earlier date
17721 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17724 ((eq prefer 'past) (if (= cday n2) n2 n1))
17725 ((eq prefer 'future) (if (= cday n1) n1 n2))
17726 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17728 ((eq prefer 'past) (if (= cday n2) n2 n1))
17729 ((eq prefer 'future) (if (= cday n1) n1 n2))
17730 (t (if (= cday n1) n1 n2)))))))
17732 (defun org-date-to-gregorian (date)
17733 "Turn any specification of DATE into a Gregorian date for the calendar."
17734 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17735 ((and (listp date) (= (length date) 3)) date)
17737 (setq date (org-parse-time-string date))
17738 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17740 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17742 (defun org-parse-time-string (s &optional nodefault)
17743 "Parse the standard Org-mode time string.
17744 This should be a lot faster than the normal `parse-time-string'.
17745 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17746 hour and minute fields will be nil if not given."
17747 (cond ((string-match org-ts-regexp0 s)
17749 (if (or (match-beginning 8) (not nodefault))
17750 (string-to-number (or (match-string 8 s) "0")))
17751 (if (or (match-beginning 7) (not nodefault))
17752 (string-to-number (or (match-string 7 s) "0")))
17753 (string-to-number (match-string 4 s))
17754 (string-to-number (match-string 3 s))
17755 (string-to-number (match-string 2 s))
17757 ((string-match "^<[^>]+>$" s)
17758 (decode-time (seconds-to-time (org-matcher-time s))))
17759 (t (error "Not a standard Org-mode time string: %s" s))))
17761 (defun org-timestamp-up (&optional arg)
17762 "Increase the date item at the cursor by one.
17763 If the cursor is on the year, change the year. If it is on the month,
17764 the day or the time, change that.
17765 With prefix ARG, change by that many units."
17767 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17769 (defun org-timestamp-down (&optional arg)
17770 "Decrease the date item at the cursor by one.
17771 If the cursor is on the year, change the year. If it is on the month,
17772 the day or the time, change that.
17773 With prefix ARG, change by that many units."
17775 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17777 (defun org-timestamp-up-day (&optional arg)
17778 "Increase the date in the time stamp by one day.
17779 With prefix ARG, change that many days."
17781 (if (and (not (org-at-timestamp-p t))
17782 (org-at-heading-p))
17784 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17786 (defun org-timestamp-down-day (&optional arg)
17787 "Decrease the date in the time stamp by one day.
17788 With prefix ARG, change that many days."
17790 (if (and (not (org-at-timestamp-p t))
17791 (org-at-heading-p))
17793 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17795 (defun org-at-timestamp-p (&optional inactive-ok)
17796 "Determine if the cursor is in or at a timestamp."
17798 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17800 (ans (or (looking-at tsr)
17802 (skip-chars-backward "^[<\n\r\t")
17803 (if (> (point) (point-min)) (backward-char 1))
17804 (and (looking-at tsr)
17805 (> (- (match-end 0) pos) -1))))))
17807 (boundp 'org-ts-what)
17810 ((= pos (match-beginning 0)) 'bracket)
17811 ;; Point is considered to be "on the bracket" whether
17812 ;; it's really on it or right after it.
17813 ((= pos (1- (match-end 0))) 'bracket)
17814 ((= pos (match-end 0)) 'after)
17815 ((org-pos-in-match-range pos 2) 'year)
17816 ((org-pos-in-match-range pos 3) 'month)
17817 ((org-pos-in-match-range pos 7) 'hour)
17818 ((org-pos-in-match-range pos 8) 'minute)
17819 ((or (org-pos-in-match-range pos 4)
17820 (org-pos-in-match-range pos 5)) 'day)
17821 ((and (> pos (or (match-end 8) (match-end 5)))
17822 (< pos (match-end 0)))
17823 (- pos (or (match-end 8) (match-end 5))))
17827 (defun org-toggle-timestamp-type ()
17828 "Toggle the type (<active> or [inactive]) of a time stamp."
17830 (when (org-at-timestamp-p t)
17831 (let ((beg (match-beginning 0)) (end (match-end 0))
17832 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17835 (while (re-search-forward "[][<>]" end t)
17836 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17838 (message "Timestamp is now %sactive"
17839 (if (equal (char-after beg) ?<) "" "in")))))
17841 (defun org-at-clock-log-p nil
17842 "Is the cursor on the clock log line?"
17844 (move-beginning-of-line 1)
17845 (looking-at org-clock-line-re)))
17847 (defvar org-clock-history) ; defined in org-clock.el
17848 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17849 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17850 "Change the date in the time stamp at point.
17851 The date will be changed by N times WHAT. WHAT can be `day', `month',
17852 `year', `minute', `second'. If WHAT is not given, the cursor position
17853 in the timestamp determines what will be changed.
17854 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17855 (let ((origin (point)) origin-cat
17857 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17860 ts time time0 fixnext clrgx)
17861 (if (not (org-at-timestamp-p t))
17862 (user-error "Not at a timestamp"))
17863 (if (and (not what) (eq org-ts-what 'bracket))
17864 (org-toggle-timestamp-type)
17865 ;; Point isn't on brackets. Remember the part of the time-stamp
17866 ;; the point was in. Indeed, size of time-stamps may change,
17867 ;; but point must be kept in the same category nonetheless.
17868 (setq origin-cat org-ts-what)
17869 (if (and (not what) (not (eq org-ts-what 'day))
17870 org-display-custom-times
17871 (get-text-property (point) 'display)
17872 (not (get-text-property (1- (point)) 'display)))
17873 (setq org-ts-what 'day))
17874 (setq org-ts-what (or what org-ts-what)
17875 inactive (= (char-after (match-beginning 0)) ?\[)
17876 ts (match-string 0))
17878 (when (string-match
17879 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17881 (setq extra (match-string 1 ts))
17882 (if suppress-tmp-delay
17883 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17884 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17886 (setq time0 (org-parse-time-string ts))
17888 (eq org-ts-what 'minute)
17889 (not current-prefix-arg))
17890 ;; This looks like s-up and s-down. Change by one rounding step.
17891 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17892 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17893 (setcar (cdr time0) (+ (nth 1 time0)
17894 (if (> n 0) (- rem) (- dm rem))))))
17896 (encode-time (or (car time0) 0)
17897 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17898 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17899 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17900 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17901 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17903 (when (and (member org-ts-what '(hour minute))
17905 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17906 (setq extra (org-modify-ts-extra
17908 (if (eq org-ts-what 'hour) 2 5)
17910 (when (integerp org-ts-what)
17911 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17912 (if (eq what 'calendar)
17913 (let ((cal-date (org-get-date-from-calendar)))
17914 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17915 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17916 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17917 (setcar time0 (or (car time0) 0))
17918 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17919 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17920 (setq time (apply 'encode-time time0))))
17921 ;; Insert the new time-stamp, and ensure point stays in the same
17922 ;; category as before (i.e. not after the last position in that
17924 (let ((pos (point)))
17925 ;; Stay before inserted string. `save-excursion' is of no use.
17926 (setq org-last-changed-timestamp
17927 (org-insert-time-stamp time with-hm inactive nil nil extra))
17930 (looking-at org-ts-regexp3)
17932 ;; `day' category ends before `hour' if any, or at
17933 ;; the end of the day name.
17934 ((eq origin-cat 'day)
17935 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17936 ((eq origin-cat 'hour) (min (match-end 7) origin))
17937 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17938 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17939 ;; `year' and `month' have both fixed size: point
17940 ;; couldn't have moved into another part.
17942 ;; Update clock if on a CLOCK line.
17943 (org-clock-update-time-maybe)
17944 ;; Maybe adjust the closest clock in `org-clock-history'
17945 (when org-clock-adjust-closest
17946 (if (not (and (org-at-clock-log-p)
17947 (< 1 (length (delq nil (mapcar 'marker-position
17948 org-clock-history))))))
17949 (message "No clock to adjust")
17950 (cond ((save-excursion ; fix previous clock?
17951 (re-search-backward org-ts-regexp0 nil t)
17952 (org-looking-back (concat org-clock-string " \\[")))
17953 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17954 ((save-excursion ; fix next clock?
17955 (re-search-backward org-ts-regexp0 nil t)
17956 (looking-at (concat org-ts-regexp0 "\\] =>")))
17957 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17958 (save-window-excursion
17959 ;; Find closest clock to point, adjust the previous/next one in history
17960 (let* ((p (save-excursion (org-back-to-heading t)))
17961 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17963 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17964 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17966 (message "No clock to adjust")
17968 (org-goto-marker-or-bmk clfixpos)
17970 (when (re-search-forward clrgx nil t)
17971 (goto-char (match-beginning 1))
17972 (let (org-clock-adjust-closest)
17973 (org-timestamp-change n org-ts-what updown))
17974 (message "Clock adjusted in %s for heading: %s"
17975 (file-name-nondirectory (buffer-file-name))
17976 (org-get-heading t t)))))))))
17977 ;; Try to recenter the calendar window, if any.
17978 (if (and org-calendar-follow-timestamp-change
17979 (get-buffer-window "*Calendar*" t)
17980 (memq org-ts-what '(day month year)))
17981 (org-recenter-calendar (time-to-days time))))))
17983 (defun org-modify-ts-extra (s pos n dm)
17984 "Change the different parts of the lead-time and repeat fields in timestamp."
17985 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17987 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17989 ((or (org-pos-in-match-range pos 2)
17990 (org-pos-in-match-range pos 3))
17991 (setq m (string-to-number (match-string 3 s))
17992 h (string-to-number (match-string 2 s)))
17993 (if (org-pos-in-match-range pos 2)
17995 (setq n (* dm (org-no-warnings (signum n))))
17996 (when (not (= 0 (setq rem (% m dm))))
17997 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17999 (if (< m 0) (setq m (+ m 60) h (1- h)))
18000 (if (> m 59) (setq m (- m 60) h (1+ h)))
18001 (setq h (min 24 (max 0 h)))
18002 (setq ng 1 new (format "-%02d:%02d" h m)))
18003 ((org-pos-in-match-range pos 6)
18004 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18005 ((org-pos-in-match-range pos 5)
18006 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18008 ((org-pos-in-match-range pos 9)
18009 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18010 ((org-pos-in-match-range pos 8)
18011 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18015 (substring s 0 (match-beginning ng))
18017 (substring s (match-end ng))))))
18020 (defun org-recenter-calendar (date)
18021 "If the calendar is visible, recenter it to DATE."
18022 (let ((cwin (get-buffer-window "*Calendar*" t)))
18024 (let ((calendar-move-hook nil))
18025 (with-selected-window cwin
18026 (calendar-goto-date (if (listp date) date
18027 (calendar-gregorian-from-absolute date))))))))
18029 (defun org-goto-calendar (&optional arg)
18030 "Go to the Emacs calendar at the current date.
18031 If there is a time stamp in the current line, go to that date.
18032 A prefix ARG can be used to force the current date."
18034 (let ((tsr org-ts-regexp) diff
18035 (calendar-move-hook nil)
18036 (calendar-view-holidays-initially-flag nil)
18037 (calendar-view-diary-initially-flag nil))
18038 (if (or (org-at-timestamp-p)
18040 (beginning-of-line 1)
18041 (looking-at (concat ".*" tsr))))
18042 (let ((d1 (time-to-days (current-time)))
18044 (org-time-string-to-time (match-string 1)))))
18045 (setq diff (- d2 d1))))
18047 (calendar-goto-today)
18048 (if (and diff (not arg)) (calendar-forward-day diff))))
18050 (defun org-get-date-from-calendar ()
18051 "Return a list (month day year) of date at point in calendar."
18052 (with-current-buffer "*Calendar*"
18054 (calendar-cursor-to-date))))
18056 (defun org-date-from-calendar ()
18057 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18058 If there is already a time stamp at the cursor position, update it."
18060 (if (org-at-timestamp-p t)
18061 (org-timestamp-change 0 'calendar)
18062 (let ((cal-date (org-get-date-from-calendar)))
18063 (org-insert-time-stamp
18064 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18066 (defcustom org-effort-durations
18070 ("w" . ,(* 60 8 5))
18071 ("m" . ,(* 60 8 5 4))
18072 ("y" . ,(* 60 8 5 40)))
18073 "Conversion factor to minutes for an effort modifier.
18075 Each entry has the form (MODIFIER . MINUTES).
18077 In an effort string, a number followed by MODIFIER is multiplied
18078 by the specified number of MINUTES to obtain an effort in
18081 For example, if the value of this variable is ((\"hours\" . 60)), then an
18082 effort string \"2hours\" is equivalent to 120 minutes."
18085 :package-version '(Org . "8.3")
18086 :type '(alist :key-type (string :tag "Modifier")
18087 :value-type (number :tag "Minutes")))
18089 (defun org-minutes-to-clocksum-string (m)
18090 "Format number of minutes as a clocksum string.
18091 The format is determined by `org-time-clocksum-format',
18092 `org-time-clocksum-use-fractional' and
18093 `org-time-clocksum-fractional-format' and
18094 `org-time-clocksum-use-effort-durations'."
18095 (let ((clocksum "")
18096 (m (round m)) ; Don't allow fractions of minutes
18098 (setq h (if org-time-clocksum-use-effort-durations
18099 (cdr (assoc "h" org-effort-durations)) 60)
18100 d (if org-time-clocksum-use-effort-durations
18101 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18102 w (if org-time-clocksum-use-effort-durations
18103 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18104 mo (if org-time-clocksum-use-effort-durations
18105 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18106 y (if org-time-clocksum-use-effort-durations
18107 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18108 ;; fractional format
18109 (if org-time-clocksum-use-fractional
18111 ;; single format string
18112 ((stringp org-time-clocksum-fractional-format)
18113 (format org-time-clocksum-fractional-format (/ m (float h))))
18114 ;; choice of fractional formats for different time units
18115 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18116 (> (/ (truncate m) (* y d h)) 0))
18117 (format fmt (/ m (* y d (float h)))))
18118 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18119 (> (/ (truncate m) (* mo d h)) 0))
18120 (format fmt (/ m (* mo d (float h)))))
18121 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18122 (> (/ (truncate m) (* w d h)) 0))
18123 (format fmt (/ m (* w d (float h)))))
18124 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18125 (> (/ (truncate m) (* d h)) 0))
18126 (format fmt (/ m (* d (float h)))))
18127 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18128 (> (/ (truncate m) h) 0))
18129 (format fmt (/ m (float h))))
18130 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18132 ;; fall back to smallest time unit with a format
18133 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18134 (format fmt (/ m (float h))))
18135 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18136 (format fmt (/ m (* d (float h)))))
18137 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18138 (format fmt (/ m (* w d (float h)))))
18139 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18140 (format fmt (/ m (* mo d (float h)))))
18141 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18142 (format fmt (/ m (* y d (float h))))))
18143 ;; standard (non-fractional) format, with single format string
18144 (if (stringp org-time-clocksum-format)
18145 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18146 ;; separate formats components
18147 (and (setq fmt (plist-get org-time-clocksum-format :years))
18148 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18149 (plist-get org-time-clocksum-format :require-years))
18150 (setq clocksum (concat clocksum (format fmt n))
18151 m (- m (* n y d h))))
18152 (and (setq fmt (plist-get org-time-clocksum-format :months))
18153 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18154 (plist-get org-time-clocksum-format :require-months))
18155 (setq clocksum (concat clocksum (format fmt n))
18156 m (- m (* n mo d h))))
18157 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18158 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18159 (plist-get org-time-clocksum-format :require-weeks))
18160 (setq clocksum (concat clocksum (format fmt n))
18161 m (- m (* n w d h))))
18162 (and (setq fmt (plist-get org-time-clocksum-format :days))
18163 (or (> (setq n (/ (truncate m) (* d h))) 0)
18164 (plist-get org-time-clocksum-format :require-days))
18165 (setq clocksum (concat clocksum (format fmt n))
18166 m (- m (* n d h))))
18167 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18168 (or (> (setq n (/ (truncate m) h)) 0)
18169 (plist-get org-time-clocksum-format :require-hours))
18170 (setq clocksum (concat clocksum (format fmt n))
18172 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18173 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18174 (setq clocksum (concat clocksum (format fmt m))))
18175 ;; return formatted time duration
18178 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18179 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18180 "Org mode version 8.0")
18182 (defun org-hours-to-clocksum-string (n)
18183 (org-minutes-to-clocksum-string (* n 60)))
18185 (defun org-hh:mm-string-to-minutes (s)
18186 "Convert a string H:MM to a number of minutes.
18187 If the string is just a number, interpret it as minutes.
18188 In fact, the first hh:mm or number in the string will be taken,
18189 there can be extra stuff in the string.
18190 If no number is found, the return value is 0."
18193 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18194 (+ (* (string-to-number (match-string 1 s)) 60)
18195 (string-to-number (match-string 2 s))))
18196 ((string-match "\\([0-9]+\\)" s)
18197 (string-to-number (match-string 1 s)))
18200 (defcustom org-image-actual-width t
18201 "Should we use the actual width of images when inlining them?
18203 When set to `t', always use the image width.
18205 When set to a number, use imagemagick (when available) to set
18206 the image's width to this value.
18208 When set to a number in a list, try to get the width from any
18209 #+ATTR.* keyword if it matches a width specification like
18211 #+ATTR_HTML: :width 300px
18213 and fall back on that number if none is found.
18215 When set to nil, try to get the width from an #+ATTR.* keyword
18216 and fall back on the original width if none is found.
18218 This requires Emacs >= 24.1, build with imagemagick support."
18219 :group 'org-appearance
18221 :package-version '(Org . "8.0")
18223 (const :tag "Use the image width" t)
18224 (integer :tag "Use a number of pixels")
18225 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18226 (const :tag "Use #+ATTR* or don't resize" nil)))
18228 (defcustom org-agenda-inhibit-startup nil
18229 "Inhibit startup when preparing agenda buffers.
18230 When this variable is `t', the initialization of the Org agenda
18231 buffers is inhibited: e.g. the visibility state is not set, the
18232 tables are not re-aligned, etc."
18235 :group 'org-agenda)
18237 (define-obsolete-variable-alias
18238 'org-agenda-ignore-drawer-properties
18239 'org-agenda-ignore-properties "25.1")
18241 (defcustom org-agenda-ignore-properties nil
18242 "Avoid updating text properties when building the agenda.
18243 Properties are used to prepare buffers for effort estimates,
18244 appointments, statistics and subtree-local categories.
18245 If you don't use these in the agenda, you can add them to this
18246 list and agenda building will be a bit faster.
18247 The value is a list, with zero or more of the symbols `effort', `appt',
18248 `stats' or `category'."
18249 :type '(set :greedy t
18255 :package-version '(Org . "8.3")
18256 :group 'org-agenda)
18258 (defun org-duration-string-to-minutes (s &optional output-to-string)
18259 "Convert a duration string S to minutes.
18261 A bare number is interpreted as minutes, modifiers can be set by
18262 customizing `org-effort-durations' (which see).
18264 Entries containing a colon are interpreted as H:MM by
18265 `org-hh:mm-string-to-minutes'."
18267 (re (concat "\\([0-9.]+\\) *\\("
18268 (regexp-opt (mapcar 'car org-effort-durations))
18270 (while (string-match re s)
18271 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18272 (string-to-number (match-string 1 s))))
18273 (setq s (replace-match "" nil t s)))
18274 (setq result (floor result))
18275 (incf result (org-hh:mm-string-to-minutes s))
18276 (if output-to-string (number-to-string result) result)))
18280 (defun org-save-all-org-buffers ()
18281 "Save all Org-mode buffers without user confirmation."
18283 (message "Saving all Org-mode buffers...")
18284 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18285 (when (featurep 'org-id) (org-id-locations-save))
18286 (message "Saving all Org-mode buffers... done"))
18288 (defun org-revert-all-org-buffers ()
18289 "Revert all Org-mode buffers.
18290 Prompt for confirmation when there are unsaved changes.
18291 Be sure you know what you are doing before letting this function
18292 overwrite your changes.
18294 This function is useful in a setup where one tracks org files
18295 with a version control system, to revert on one machine after pulling
18296 changes from another. I believe the procedure must be like this:
18298 1. M-x org-save-all-org-buffers
18299 2. Pull changes from the other machine, resolve conflicts
18300 3. M-x org-revert-all-org-buffers"
18302 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18303 (user-error "Abort"))
18305 (save-window-excursion
18308 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18309 (with-current-buffer b buffer-file-name))
18310 (org-pop-to-buffer-same-window b)
18311 (revert-buffer t 'no-confirm)))
18313 (when (and (featurep 'org-id) org-id-track-globally)
18314 (org-id-locations-load)))))
18319 (defun org-switchb (&optional arg)
18320 "Switch between Org buffers.
18321 With one prefix argument, restrict available buffers to files.
18322 With two prefix arguments, restrict available buffers to agenda files.
18324 Defaults to `iswitchb' for buffer name completion.
18325 Set `org-completion-use-ido' to make it use ido instead."
18327 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18328 ((equal arg '(16)) (org-buffer-list 'agenda))
18329 (t (org-buffer-list))))
18330 (org-completion-use-iswitchb org-completion-use-iswitchb)
18331 (org-completion-use-ido org-completion-use-ido))
18332 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18333 (setq org-completion-use-iswitchb t))
18334 (org-pop-to-buffer-same-window
18335 (org-icompleting-read "Org buffer: "
18336 (mapcar 'list (mapcar 'buffer-name blist))
18339 ;;; Define some older names previously used for this functionality
18341 (defalias 'org-ido-switchb 'org-switchb)
18343 (defalias 'org-iswitchb 'org-switchb)
18345 (defun org-buffer-list (&optional predicate exclude-tmp)
18346 "Return a list of Org buffers.
18347 PREDICATE can be `export', `files' or `agenda'.
18349 export restrict the list to Export buffers.
18350 files restrict the list to buffers visiting Org files.
18351 agenda restrict the list to buffers visiting agenda files.
18353 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18355 (agenda-files (and (eq predicate 'agenda)
18356 (mapcar 'file-truename (org-agenda-files t))))
18359 ((eq predicate 'files)
18360 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18361 ((eq predicate 'export)
18362 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18363 ((eq predicate 'agenda)
18365 (with-current-buffer b
18366 (and (derived-mode-p 'org-mode)
18367 (setq bfn (buffer-file-name b))
18368 (member (file-truename bfn) agenda-files)))))
18369 (t (lambda (b) (with-current-buffer b
18370 (or (derived-mode-p 'org-mode)
18371 (string-match "\*Org .*Export"
18372 (buffer-name b)))))))))
18376 (if (and (funcall filter b)
18377 (or (not exclude-tmp)
18378 (not (string-match "tmp" (buffer-name b)))))
18383 (defun org-agenda-files (&optional unrestricted archives)
18384 "Get the list of agenda files.
18385 Optional UNRESTRICTED means return the full list even if a restriction
18386 is currently in place.
18387 When ARCHIVES is t, include all archive files that are really being
18388 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18389 `org-agenda-archives-mode' is t."
18392 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18393 ((stringp org-agenda-files) (org-read-agenda-file-list))
18394 ((listp org-agenda-files) org-agenda-files)
18395 (t (error "Invalid value of `org-agenda-files'")))))
18396 (setq files (apply 'append
18397 (mapcar (lambda (f)
18398 (if (file-directory-p f)
18400 f t org-agenda-file-regexp)
18403 (when org-agenda-skip-unavailable-files
18404 (setq files (delq nil
18407 (and (file-readable-p file) file)))
18409 (when (or (eq archives t)
18410 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18411 (setq files (org-add-archive-files files)))
18414 (defun org-agenda-file-p (&optional file)
18415 "Return non-nil, if FILE is an agenda file.
18416 If FILE is omitted, use the file associated with the current
18418 (let ((fname (or file (buffer-file-name))))
18420 (member (file-truename fname)
18421 (mapcar #'file-truename (org-agenda-files t))))))
18423 (defun org-edit-agenda-file-list ()
18424 "Edit the list of agenda files.
18425 Depending on setup, this either uses customize to edit the variable
18426 `org-agenda-files', or it visits the file that is holding the list. In the
18427 latter case, the buffer is set up in a way that saving it automatically kills
18428 the buffer and restores the previous window configuration."
18430 (if (stringp org-agenda-files)
18431 (let ((cw (current-window-configuration)))
18432 (find-file org-agenda-files)
18433 (org-set-local 'org-window-configuration cw)
18434 (org-add-hook 'after-save-hook
18436 (set-window-configuration
18437 (prog1 org-window-configuration
18438 (kill-buffer (current-buffer))))
18439 (org-install-agenda-files-menu)
18440 (message "New agenda file list installed"))
18442 (message "%s" (substitute-command-keys
18443 "Edit list and finish with \\[save-buffer]")))
18444 (customize-variable 'org-agenda-files)))
18446 (defun org-store-new-agenda-file-list (list)
18447 "Set new value for the agenda file list and save it correctly."
18448 (if (stringp org-agenda-files)
18449 (let ((fe (org-read-agenda-file-list t)) b u)
18450 (while (setq b (find-buffer-visiting org-agenda-files))
18452 (with-temp-file org-agenda-files
18455 (lambda (f) ;; Keep un-expanded entries.
18456 (if (setq u (assoc f fe))
18461 (let ((org-mode-hook nil) (org-inhibit-startup t)
18462 (org-insert-mode-line-in-empty-file nil))
18463 (setq org-agenda-files list)
18464 (customize-save-variable 'org-agenda-files org-agenda-files))))
18466 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18467 "Read the list of agenda files from a file.
18468 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18469 filenames, used by `org-store-new-agenda-file-list' to write back
18470 un-expanded file names."
18471 (when (file-directory-p org-agenda-files)
18472 (error "`org-agenda-files' cannot be a single directory"))
18473 (when (stringp org-agenda-files)
18475 (insert-file-contents org-agenda-files)
18478 (let ((e (expand-file-name (substitute-in-file-name f)
18480 (if pair-with-expansion
18483 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18486 (defun org-cycle-agenda-files ()
18487 "Cycle through the files in `org-agenda-files'.
18488 If the current buffer visits an agenda file, find the next one in the list.
18489 If the current buffer does not, find the first agenda file."
18491 (let* ((fs (org-agenda-files t))
18492 (files (append fs (list (car fs))))
18493 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18495 (unless files (user-error "No agenda files"))
18497 (while (setq file (pop files))
18498 (if (equal (file-truename file) tcf)
18500 (find-file (car files))
18502 (find-file (car fs)))
18503 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18505 (defun org-agenda-file-to-front (&optional to-end)
18506 "Move/add the current file to the top of the agenda file list.
18507 If the file is not present in the list, it is added to the front. If it is
18508 present, it is moved there. With optional argument TO-END, add/move to the
18511 (let ((org-agenda-skip-unavailable-files nil)
18512 (file-alist (mapcar (lambda (x)
18513 (cons (file-truename x) x))
18514 (org-agenda-files t)))
18515 (ctf (file-truename
18516 (or buffer-file-name
18517 (user-error "Please save the current buffer to a file"))))
18519 (setq x (assoc ctf file-alist) had x)
18521 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18523 (setq file-alist (append (delq x file-alist) (list x)))
18524 (setq file-alist (cons x (delq x file-alist))))
18525 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18526 (org-install-agenda-files-menu)
18527 (message "File %s to %s of agenda file list"
18528 (if had "moved" "added") (if to-end "end" "front"))))
18530 (defun org-remove-file (&optional file)
18531 "Remove current file from the list of files in variable `org-agenda-files'.
18532 These are the files which are being checked for agenda entries.
18533 Optional argument FILE means use this file instead of the current."
18535 (let* ((org-agenda-skip-unavailable-files nil)
18536 (file (or file buffer-file-name
18537 (user-error "Current buffer does not visit a file")))
18538 (true-file (file-truename file))
18539 (afile (abbreviate-file-name file))
18540 (files (delq nil (mapcar
18542 (if (equal true-file
18545 (org-agenda-files t)))))
18546 (if (not (= (length files) (length (org-agenda-files t))))
18548 (org-store-new-agenda-file-list files)
18549 (org-install-agenda-files-menu)
18550 (message "Removed from Org Agenda list: %s" afile))
18551 (message "File was not in list: %s (not removed)" afile))))
18553 (defun org-file-menu-entry (file)
18554 (vector file (list 'find-file file) t))
18556 (defun org-check-agenda-file (file)
18557 "Make sure FILE exists. If not, ask user what to do."
18558 (when (not (file-exists-p file))
18559 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18560 (abbreviate-file-name file))
18561 (let ((r (downcase (read-char-exclusive))))
18564 (org-remove-file file)
18565 (throw 'nextfile t))
18566 (t (user-error "Abort"))))))
18568 (defun org-get-agenda-file-buffer (file)
18569 "Get an agenda buffer visiting FILE.
18570 If the buffer needs to be created, add it to the list of buffers
18571 which might be released later."
18572 (let ((buf (org-find-base-buffer-visiting file)))
18574 buf ; just return it
18575 ;; Make a new buffer and remember it
18576 (setq buf (find-file-noselect file))
18577 (if buf (push buf org-agenda-new-buffers))
18580 (defun org-release-buffers (blist)
18581 "Release all buffers in list, asking the user for confirmation when needed.
18582 When a buffer is unmodified, it is just killed. When modified, it is saved
18583 \(if the user agrees) and then killed."
18585 (while (setq buf (pop blist))
18586 (setq file (buffer-file-name buf))
18587 (when (and (buffer-modified-p buf)
18589 (y-or-n-p (format "Save file %s? " file)))
18590 (with-current-buffer buf (save-buffer)))
18591 (kill-buffer buf))))
18593 (defun org-agenda-prepare-buffers (files)
18594 "Create buffers for all agenda files, protect archived trees and comments."
18596 (let ((pa '(:org-archived t))
18597 (pc '(:org-comment t))
18598 (pall '(:org-archived t :org-comment t))
18599 (inhibit-read-only t)
18600 (org-inhibit-startup org-agenda-inhibit-startup)
18601 (rea (concat ":" org-archive-tag ":"))
18603 (setq org-tag-alist-for-agenda nil
18604 org-tag-groups-alist-for-agenda nil)
18607 (while (setq file (pop files))
18611 (org-check-agenda-file file)
18612 (set-buffer (org-get-agenda-file-buffer file)))
18614 (org-set-regexps-and-options 'tags-only)
18616 (or (memq 'category org-agenda-ignore-properties)
18617 (org-refresh-category-properties))
18618 (or (memq 'stats org-agenda-ignore-properties)
18619 (org-refresh-stats-properties))
18620 (or (memq 'effort org-agenda-ignore-properties)
18621 (org-refresh-effort-properties))
18622 (or (memq 'appt org-agenda-ignore-properties)
18623 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18624 (setq org-todo-keywords-for-agenda
18625 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18626 (setq org-done-keywords-for-agenda
18627 (append org-done-keywords-for-agenda org-done-keywords))
18628 (setq org-todo-keyword-alist-for-agenda
18629 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18630 (setq org-tag-alist-for-agenda
18632 (append org-tag-alist-for-agenda
18634 org-tag-persistent-alist)))
18636 (setq org-tag-groups-alist-for-agenda
18637 (org-uniquify-alist
18638 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18639 (org-with-silent-modifications
18641 (remove-text-properties (point-min) (point-max) pall)
18642 (when org-agenda-skip-archived-trees
18643 (goto-char (point-min))
18644 (while (re-search-forward rea nil t)
18645 (if (org-at-heading-p t)
18646 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18647 (goto-char (point-min))
18648 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18649 (while (re-search-forward re nil t)
18650 (when (save-match-data (org-in-commented-heading-p t))
18651 (add-text-properties
18652 (match-beginning 0) (org-end-of-subtree t) pc)))))
18653 (goto-char pos)))))
18654 (setq org-todo-keywords-for-agenda
18655 (org-uniquify org-todo-keywords-for-agenda))
18656 (setq org-todo-keyword-alist-for-agenda
18657 (org-uniquify org-todo-keyword-alist-for-agenda))))
18660 ;;;; CDLaTeX minor mode
18662 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18663 "Keymap for the minor `org-cdlatex-mode'.")
18665 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18666 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18667 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18668 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18669 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18671 (defvar org-cdlatex-texmathp-advice-is-done nil
18672 "Flag remembering if we have applied the advice to texmathp already.")
18674 (define-minor-mode org-cdlatex-mode
18675 "Toggle the minor `org-cdlatex-mode'.
18676 This mode supports entering LaTeX environment and math in LaTeX fragments
18678 \\{org-cdlatex-mode-map}"
18680 (when org-cdlatex-mode
18682 (run-hooks 'cdlatex-mode-hook)
18683 (cdlatex-compute-tables))
18684 (unless org-cdlatex-texmathp-advice-is-done
18685 (setq org-cdlatex-texmathp-advice-is-done t)
18686 (defadvice texmathp (around org-math-always-on activate)
18687 "Always return t in org-mode buffers.
18688 This is because we want to insert math symbols without dollars even outside
18689 the LaTeX math segments. If Orgmode thinks that point is actually inside
18690 an embedded LaTeX fragment, let texmathp do its job.
18691 \\[org-cdlatex-mode-map]"
18695 ((not (derived-mode-p 'org-mode)) ad-do-it)
18696 ((eq this-command 'cdlatex-math-symbol)
18697 (setq ad-return-value t
18698 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18700 (let ((p (org-inside-LaTeX-fragment-p)))
18701 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18702 (setq ad-return-value t
18703 texmathp-why '("Org-mode embedded math" . 0))
18704 (if p ad-do-it)))))))))
18706 (defun turn-on-org-cdlatex ()
18707 "Unconditionally turn on `org-cdlatex-mode'."
18708 (org-cdlatex-mode 1))
18710 (defun org-try-cdlatex-tab ()
18711 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18712 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18713 - inside a LaTeX fragment, or
18714 - after the first word in a line, where an abbreviation expansion could
18715 insert a LaTeX environment."
18716 (when org-cdlatex-mode
18718 ;; Before any word on the line: No expansion possible.
18719 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18720 ;; Just after first word on the line: Expand it. Make sure it
18721 ;; cannot happen on headlines, though.
18723 (skip-chars-backward "a-zA-Z0-9*")
18724 (skip-chars-backward " \t")
18725 (and (bolp) (not (org-at-heading-p))))
18727 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18729 (defun org-cdlatex-underscore-caret (&optional arg)
18730 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18731 Revert to the normal definition outside of these fragments."
18733 (if (org-inside-LaTeX-fragment-p)
18734 (call-interactively 'cdlatex-sub-superscript)
18735 (let (org-cdlatex-mode)
18736 (call-interactively (key-binding (vector last-input-event))))))
18738 (defun org-cdlatex-math-modify (&optional arg)
18739 "Execute `cdlatex-math-modify' in LaTeX fragments.
18740 Revert to the normal definition outside of these fragments."
18742 (if (org-inside-LaTeX-fragment-p)
18743 (call-interactively 'cdlatex-math-modify)
18744 (let (org-cdlatex-mode)
18745 (call-interactively (key-binding (vector last-input-event))))))
18747 (defun org-cdlatex-environment-indent (&optional environment item)
18748 "Execute `cdlatex-environment' and indent the inserted environment.
18750 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18752 The inserted environment is indented to current indentation
18753 unless point is at the beginning of the line, in which the
18754 environment remains unintended."
18756 ;; cdlatex-environment always return nil. Therefore, capture output
18757 ;; first and determine if an environment was selected.
18758 (let* ((beg (point-marker))
18759 (end (copy-marker (point) t))
18761 (ignore-errors (cdlatex-environment environment item))
18763 ;; Figure out how many lines to move forward after the
18764 ;; environment has been inserted.
18765 (lines (when inserted
18767 (- (loop while (< beg (point))
18769 do (forward-line -1)
18772 (if (progn (goto-char beg)
18773 (and (progn (skip-chars-forward " \t") (eolp))
18774 (progn (skip-chars-backward " \t") (bolp))))
18776 (env (org-trim (delete-and-extract-region beg end))))
18778 ;; Get indentation of next line unless at column 0.
18779 (let ((ind (if (bolp) 0
18781 (org-return-indent)
18782 (prog1 (org-get-indentation)
18783 (when (progn (skip-chars-forward " \t") (eolp))
18784 (delete-region beg (point)))))))
18785 (bol (progn (skip-chars-backward " \t") (bolp))))
18786 ;; Insert a newline before environment unless at column zero
18787 ;; to "escape" the current line. Insert a newline if
18788 ;; something is one the same line as \end{ENVIRONMENT}.
18790 (concat (unless bol "\n") env
18791 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18792 (unless (zerop ind)
18795 (while (< (point) end)
18796 (unless (eolp) (org-indent-line-to ind))
18799 (forward-line lines)
18800 (org-indent-line-to ind)))
18801 (set-marker beg nil)
18802 (set-marker end nil)))
18805 ;;;; LaTeX fragments
18807 (defun org-inside-LaTeX-fragment-p ()
18808 "Test if point is inside a LaTeX fragment.
18809 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18810 sequence appearing also before point.
18811 Even though the matchers for math are configurable, this function assumes
18812 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18813 delimiters are skipped when they have been removed by customization.
18814 The return value is nil, or a cons cell with the delimiter and the
18815 position of this delimiter.
18817 This function does a reasonably good job, but can locally be fooled by
18818 for example currency specifications. For example it will assume being in
18819 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18820 fragments that are properly closed, but during editing, we have to live
18821 with the uncertainty caused by missing closing delimiters. This function
18822 looks only before point, not after."
18824 (let ((pos (point))
18825 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18827 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18829 dd-on str (start 0) m re)
18832 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18833 re (nth 1 (assoc "$" org-latex-regexps)))
18834 (while (string-match re str start)
18836 ((= (match-end 0) (length str))
18837 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18838 ((= (match-end 0) (- (length str) 5))
18840 (t (setq start (match-end 0))))))
18841 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18843 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18844 (and (match-beginning 2) (throw 'exit nil))
18846 (while (re-search-backward "\\$\\$" lim t)
18847 (setq dd-on (not dd-on)))
18849 (if dd-on (cons "$$" m))))))
18851 (defun org-inside-latex-macro-p ()
18852 "Is point inside a LaTeX macro or its arguments?"
18855 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18857 (defvar org-latex-fragment-image-overlays nil
18858 "List of overlays carrying the images of latex fragments.")
18859 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18861 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18862 "Remove all overlays with LaTeX fragment images in current buffer.
18863 When optional arguments BEG and END are non-nil, remove all
18864 overlays between them instead. Return t when some overlays were
18865 removed, nil otherwise."
18867 (setq org-latex-fragment-image-overlays
18868 (let ((beg (or beg (point-min)))
18869 (end (or end (point-max))))
18872 (and (>= (overlay-start o) beg)
18873 (<= (overlay-end o) end)
18874 (progn (delete-overlay o)
18875 (or removedp (setq removedp t)))))
18876 org-latex-fragment-image-overlays)))
18879 (define-obsolete-function-alias
18880 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18881 (defun org-toggle-latex-fragment (&optional arg)
18882 "Preview the LaTeX fragment at point, or all locally or globally.
18884 If the cursor is on a LaTeX fragment, create the image and overlay
18885 it over the source code, if there is none. Remove it otherwise.
18886 If there is no fragment at point, display all fragments in the
18889 With prefix ARG, preview or clear image for all fragments in the
18890 current subtree or in the whole buffer when used before the first
18891 headline. With a double prefix ARG \\[universal-argument] \
18892 \\[universal-argument] preview or clear images
18893 for all fragments in the buffer."
18895 (unless (buffer-file-name (buffer-base-buffer))
18896 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18897 (when (display-graphic-p)
18900 (let ((window-start (window-start)) msg)
18903 ((or (equal arg '(16))
18904 (and (equal arg '(4))
18905 (org-with-limited-levels (org-before-first-heading-p))))
18906 (if (org-remove-latex-fragment-image-overlays)
18907 (progn (message "LaTeX fragments images removed from buffer")
18909 (setq msg "Creating images for buffer...")))
18911 (org-with-limited-levels (org-back-to-heading t))
18912 (let ((beg (point))
18913 (end (progn (org-end-of-subtree t) (point))))
18914 (if (org-remove-latex-fragment-image-overlays beg end)
18916 (message "LaTeX fragment images removed from subtree")
18918 (setq msg "Creating images for subtree...")
18919 (narrow-to-region beg end))))
18920 ((let ((datum (org-element-context)))
18921 (when (memq (org-element-type datum)
18922 '(latex-environment latex-fragment))
18923 (let* ((beg (org-element-property :begin datum))
18924 (end (org-element-property :end datum)))
18925 (if (org-remove-latex-fragment-image-overlays beg end)
18926 (progn (message "LaTeX fragment image removed")
18928 (narrow-to-region beg end)
18929 (setq msg "Creating image..."))))))
18931 (org-with-limited-levels
18932 (let ((beg (if (org-at-heading-p) (line-beginning-position)
18933 (outline-previous-heading)
18935 (end (progn (outline-next-heading) (point))))
18936 (if (org-remove-latex-fragment-image-overlays beg end)
18938 (message "LaTeX fragment images removed from section")
18940 (setq msg "Creating images for section...")
18941 (narrow-to-region beg end))))))
18942 (let ((file (buffer-file-name (buffer-base-buffer))))
18944 (concat org-latex-preview-ltxpng-directory
18945 (file-name-sans-extension (file-name-nondirectory file)))
18946 ;; Emacs cannot overlay images from remote hosts.
18947 ;; Create it in `temporary-file-directory' instead.
18948 (if (file-remote-p file) temporary-file-directory
18950 'overlays msg 'forbuffer
18951 org-latex-create-formula-image-program)))
18952 ;; Work around a bug that doesn't restore window's start
18953 ;; when widening back the buffer.
18954 (set-window-start nil window-start)
18955 (message (concat msg "done")))))))
18957 (defun org-format-latex
18958 (prefix &optional dir overlays msg forbuffer processing-type)
18959 "Replace LaTeX fragments with links to an image, and produce images.
18961 When optional argument OVERLAYS is non-nil, display the image on
18962 top of the fragment instead of replacing it.
18964 PROCESSING-TYPE is the conversion method to use, as a symbol.
18966 Some of the options can be changed using the variable
18967 `org-format-latex-options', which see."
18968 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18969 (unless (eq processing-type 'verbatim)
18970 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
18973 (goto-char (point-min))
18974 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
18975 (when (and overlays (memq processing-type '(dvipng imagemagick)))
18976 (overlay-recenter (point-max)))
18977 (while (re-search-forward math-regexp nil t)
18978 (unless (and overlays
18979 (eq (get-char-property (point) 'org-overlay-type)
18980 'org-latex-overlay))
18981 (let* ((context (org-element-context))
18982 (type (org-element-type context)))
18983 (when (memq type '(latex-environment latex-fragment))
18984 (let ((block-type (eq type 'latex-environment))
18985 (value (org-element-property :value context))
18986 (beg (org-element-property :begin context))
18987 (end (save-excursion
18988 (goto-char (org-element-property :end context))
18989 (skip-chars-backward " \r\t\n")
18991 (case processing-type
18993 ;; Prepare for MathJax processing.
18994 (if (eq (char-after beg) ?$)
18996 (delete-region beg end)
18997 (insert "\\(" (substring value 1 -1) "\\)"))
18999 ((dvipng imagemagick)
19000 ;; Process to an image.
19003 (let* ((face (face-at-point))
19004 ;; Get the colors from the face at point.
19006 (let ((color (plist-get org-format-latex-options
19008 (if (and forbuffer (eq color 'auto))
19009 (face-attribute face :foreground nil 'default)
19012 (let ((color (plist-get org-format-latex-options
19014 (if (and forbuffer (eq color 'auto))
19015 (face-attribute face :background nil 'default)
19017 (hash (sha1 (prin1-to-string
19018 (list org-format-latex-header
19019 org-latex-default-packages-alist
19020 org-latex-packages-alist
19021 org-format-latex-options
19022 forbuffer value fg bg))))
19023 (absprefix (expand-file-name prefix dir))
19024 (linkfile (format "%s_%s.png" prefix hash))
19025 (movefile (format "%s_%s.png" absprefix hash))
19026 (sep (and block-type "\n\n"))
19027 (link (concat sep "[[file:" linkfile "]]" sep))
19029 (org-combine-plists
19030 org-format-latex-options
19031 `(:foreground ,fg :background ,bg))))
19032 (when msg (message msg cnt))
19033 (unless checkdir-flag ; Ensure the directory exists.
19034 (setq checkdir-flag t)
19035 (let ((todir (file-name-directory absprefix)))
19036 (unless (file-directory-p todir)
19037 (make-directory todir t))))
19038 (unless (file-exists-p movefile)
19039 (org-create-formula-image
19040 value movefile options forbuffer processing-type))
19043 (dolist (o (overlays-in beg end))
19044 (when (eq (overlay-get o 'org-overlay-type)
19045 'org-latex-overlay)
19046 (delete-overlay o)))
19047 (let ((ov (make-overlay beg end)))
19050 'org-latex-overlay)
19051 (overlay-put ov 'evaporate t)
19052 (if (featurep 'xemacs)
19054 (overlay-put ov 'invisible t)
19058 (vector 'png :file movefile))))
19065 (push ov org-latex-fragment-image-overlays))
19067 (delete-region beg end)
19069 (org-add-props link
19070 (list 'org-latex-src
19071 (replace-regexp-in-string "\"" "" value)
19072 'org-latex-src-embed-type
19073 (if block-type 'paragraph 'character)))))))
19075 ;; Process to MathML.
19076 (unless (org-format-latex-mathml-available-p)
19077 (user-error "LaTeX to MathML converter not configured"))
19079 (when msg (message msg cnt))
19081 (delete-region beg end)
19082 (insert (org-format-latex-as-mathml
19083 value block-type prefix dir)))
19085 (error "Unknown conversion type %s for LaTeX fragments"
19086 processing-type)))))))))))
19088 (defun org-create-math-formula (latex-frag &optional mathml-file)
19089 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19090 Use `org-latex-to-mathml-convert-command'. If the conversion is
19091 sucessful, return the portion between \"<math...> </math>\"
19092 elements otherwise return nil. When MATHML-FILE is specified,
19093 write the results in to that file. When invoked as an
19094 interactive command, prompt for LATEX-FRAG, with initial value
19095 set to the current active region and echo the results for user
19097 (interactive (list (let ((frag (when (org-region-active-p)
19098 (buffer-substring-no-properties
19099 (region-beginning) (region-end)))))
19100 (read-string "LaTeX Fragment: " frag nil frag))))
19101 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19102 (let* ((tmp-in-file (file-relative-name
19103 (make-temp-name (expand-file-name "ltxmathml-in"))))
19104 (ignore (write-region latex-frag nil tmp-in-file))
19105 (tmp-out-file (file-relative-name
19106 (make-temp-name (expand-file-name "ltxmathml-out"))))
19108 org-latex-to-mathml-convert-command
19109 `((?j . ,(and org-latex-to-mathml-jar-file
19110 (shell-quote-argument
19112 org-latex-to-mathml-jar-file))))
19113 (?I . ,(shell-quote-argument tmp-in-file))
19115 (?o . ,(shell-quote-argument tmp-out-file)))))
19116 mathml shell-command-output)
19117 (when (org-called-interactively-p 'any)
19118 (unless (org-format-latex-mathml-available-p)
19119 (user-error "LaTeX to MathML converter not configured")))
19120 (message "Running %s" cmd)
19121 (setq shell-command-output (shell-command-to-string cmd))
19123 (when (file-readable-p tmp-out-file)
19124 (with-current-buffer (find-file-noselect tmp-out-file t)
19125 (goto-char (point-min))
19126 (when (re-search-forward
19129 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19134 (prog1 (match-string 0) (kill-buffer))))))
19138 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19140 (write-region mathml nil mathml-file))
19141 (when (org-called-interactively-p 'any)
19143 ((message "LaTeX to MathML conversion failed")
19144 (message shell-command-output)))
19145 (delete-file tmp-in-file)
19146 (when (file-exists-p tmp-out-file)
19147 (delete-file tmp-out-file))
19150 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19151 prefix &optional dir)
19152 "Use `org-create-math-formula' but check local cache first."
19153 (let* ((absprefix (expand-file-name prefix dir))
19154 (print-length nil) (print-level nil)
19155 (formula-id (concat
19160 org-latex-to-mathml-convert-command)))))
19161 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19162 (formula-cache-dir (file-name-directory formula-cache)))
19164 (unless (file-directory-p formula-cache-dir)
19165 (make-directory formula-cache-dir t))
19167 (unless (file-exists-p formula-cache)
19168 (org-create-math-formula latex-frag formula-cache))
19170 (if (file-exists-p formula-cache)
19171 ;; Successful conversion. Return the link to MathML file.
19173 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19174 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19175 'org-latex-src-embed-type (if latex-frag-type
19176 'paragraph 'character)))
19177 ;; Failed conversion. Return the LaTeX fragment verbatim
19180 (defun org-create-formula-image (string tofile options buffer &optional type)
19181 "Create an image from LaTeX source using dvipng or convert.
19182 This function calls either `org-create-formula-image-with-dvipng'
19183 or `org-create-formula-image-with-imagemagick' depending on the
19184 value of `org-latex-create-formula-image-program' or on the value
19185 of the optional TYPE variable.
19187 Note: ultimately these two function should be combined as they
19188 share a good deal of logic."
19189 (org-check-external-command
19190 "latex" "needed to convert LaTeX fragments to images")
19192 (case (or type org-latex-create-formula-image-program)
19194 (org-check-external-command
19195 "dvipng" "needed to convert LaTeX fragments to images")
19196 #'org-create-formula-image-with-dvipng)
19198 (org-check-external-command
19199 "convert" "you need to install imagemagick")
19200 #'org-create-formula-image-with-imagemagick)
19202 "Invalid value of `org-latex-create-formula-image-program'")))
19203 string tofile options buffer))
19205 (declare-function org-export-get-backend "ox" (name))
19206 (declare-function org-export--get-global-options "ox" (&optional backend))
19207 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19208 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19209 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19210 (defun org-create-formula--latex-header ()
19211 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19212 (let ((info (org-combine-plists (org-export--get-global-options
19213 (org-export-get-backend 'latex))
19214 (org-export--get-inbuffer-options
19215 (org-export-get-backend 'latex)))))
19216 (org-latex-guess-babel-language
19217 (org-latex-guess-inputenc
19218 (org-splice-latex-header
19219 org-format-latex-header
19220 org-latex-default-packages-alist
19221 org-latex-packages-alist t
19222 (plist-get info :latex-header)))
19225 (defun org--get-display-dpi ()
19226 "Get the DPI of the display.
19228 Assumes that the display has the same pixel width in the
19229 horizontal and vertical directions."
19230 (if (display-graphic-p)
19231 (round (/ (display-pixel-height)
19232 (/ (display-mm-height) 25.4)))
19233 (error "Attempt to calculate the dpi of a non-graphic display")))
19235 ;; This function borrows from Ganesh Swami's latex2png.el
19236 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19237 "This calls dvipng."
19238 (require 'ox-latex)
19239 (let* ((tmpdir (if (featurep 'xemacs)
19241 temporary-file-directory))
19242 (texfilebase (make-temp-name
19243 (expand-file-name "orgtex" tmpdir)))
19244 (texfile (concat texfilebase ".tex"))
19245 (dvifile (concat texfilebase ".dvi"))
19246 (pngfile (concat texfilebase ".png"))
19247 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19248 ;; This assumes that the display has the same pixel width in
19249 ;; the horizontal and vertical directions
19250 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19251 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19253 (bg (or (plist-get options (if buffer :background :html-background))
19255 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19256 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19257 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19258 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19259 (let ((latex-header (org-create-formula--latex-header)))
19260 (with-temp-file texfile
19261 (insert latex-header)
19262 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19263 (let ((dir default-directory))
19266 (call-process "latex" nil nil nil texfile))
19268 (if (not (file-exists-p dvifile))
19269 (progn (message "Failed to create dvi file from %s" texfile) nil)
19271 (if (featurep 'xemacs)
19272 (call-process "dvipng" nil nil nil
19277 (call-process "dvipng" nil nil nil
19280 ;;"-x" scale "-y" scale
19284 (if (not (file-exists-p pngfile))
19285 (if org-format-latex-signal-error
19286 (error "Failed to create png file from %s" texfile)
19287 (message "Failed to create png file from %s" texfile)
19289 ;; Use the requested file name and clean up
19290 (copy-file pngfile tofile 'replace)
19291 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19292 (if (file-exists-p (concat texfilebase e))
19293 (delete-file (concat texfilebase e))))
19296 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19297 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19298 "This calls convert, which is included into imagemagick."
19299 (require 'ox-latex)
19300 (let* ((tmpdir (if (featurep 'xemacs)
19302 temporary-file-directory))
19303 (texfilebase (make-temp-name
19304 (expand-file-name "orgtex" tmpdir)))
19305 (texfile (concat texfilebase ".tex"))
19306 (pdffile (concat texfilebase ".pdf"))
19307 (pngfile (concat texfilebase ".png"))
19308 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19309 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19310 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19312 (bg (or (plist-get options (if buffer :background :html-background))
19314 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19315 (setq fg (org-latex-color-format fg)))
19316 (if (eq bg 'default) (setq bg (org-latex-color :background))
19317 (setq bg (org-latex-color-format
19318 (if (string= bg "Transparent") "white" bg))))
19319 (let ((latex-header (org-create-formula--latex-header)))
19320 (with-temp-file texfile
19321 (insert latex-header)
19322 (insert "\n\\begin{document}\n"
19323 "\\definecolor{fg}{rgb}{" fg "}\n"
19324 "\\definecolor{bg}{rgb}{" bg "}\n"
19325 "\n\\pagecolor{bg}\n"
19329 "\n\\end{document}\n")))
19330 (org-latex-compile texfile t)
19331 (if (not (file-exists-p pdffile))
19332 (progn (message "Failed to create pdf file from %s" texfile) nil)
19334 (if (featurep 'xemacs)
19335 (call-process "convert" nil nil nil
19341 ;; "-sharpen" "0x1.0"
19343 (call-process "convert" nil nil nil
19349 ;; "-sharpen" "0x1.0"
19351 (if (not (file-exists-p pngfile))
19352 (if org-format-latex-signal-error
19353 (error "Failed to create png file from %s" texfile)
19354 (message "Failed to create png file from %s" texfile)
19356 ;; Use the requested file name and clean up
19357 (copy-file pngfile tofile 'replace)
19358 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19359 (if (file-exists-p (concat texfilebase e))
19360 (delete-file (concat texfilebase e))))
19363 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19364 "Fill a LaTeX header template TPL.
19365 In the template, the following place holders will be recognized:
19367 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19368 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19369 [PACKAGES] \\usepackage statements for PKG
19370 [NO-PACKAGES] do not include PKG
19371 [EXTRA] the string EXTRA
19372 [NO-EXTRA] do not include EXTRA
19374 For backward compatibility, if both the positive and the negative place
19375 holder is missing, the positive one (without the \"NO-\") will be
19376 assumed to be present at the end of the template.
19377 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19379 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19380 (let (rpl (end ""))
19381 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19382 (setq rpl (if (or (match-end 1) (not def-pkg))
19383 "" (org-latex-packages-to-string def-pkg snippets-p t))
19384 tpl (replace-match rpl t t tpl))
19385 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19387 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19388 (setq rpl (if (or (match-end 1) (not pkg))
19389 "" (org-latex-packages-to-string pkg snippets-p t))
19390 tpl (replace-match rpl t t tpl))
19393 (org-latex-packages-to-string pkg snippets-p)))))
19395 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19396 (setq rpl (if (or (match-end 1) (not extra))
19397 "" (concat extra "\n"))
19398 tpl (replace-match rpl t t tpl))
19399 (if (and extra (string-match "\\S-" extra))
19400 (setq end (concat end "\n" extra))))
19402 (if (string-match "\\S-" end)
19403 (concat tpl "\n" end)
19406 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19407 "Turn an alist of packages into a string with the \\usepackage macros."
19408 (setq pkg (mapconcat (lambda(p)
19411 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19412 (format "%% Package %s omitted" (cadr p)))
19413 ((equal "" (car p))
19414 (format "\\usepackage{%s}" (cadr p)))
19416 (format "\\usepackage[%s]{%s}"
19417 (car p) (cadr p)))))
19420 (if newline (concat pkg "\n") pkg))
19422 (defun org-dvipng-color (attr)
19423 "Return a RGB color specification for dvipng."
19424 (apply 'format "rgb %s %s %s"
19425 (mapcar 'org-normalize-color
19426 (if (featurep 'xemacs)
19427 (color-rgb-components
19428 (face-property 'default
19429 (cond ((eq attr :foreground) 'foreground)
19430 ((eq attr :background) 'background))))
19431 (color-values (face-attribute 'default attr nil))))))
19433 (defun org-dvipng-color-format (color-name)
19434 "Convert COLOR-NAME to a RGB color value for dvipng."
19435 (apply 'format "rgb %s %s %s"
19436 (mapcar 'org-normalize-color
19437 (color-values color-name))))
19439 (defun org-latex-color (attr)
19440 "Return a RGB color for the LaTeX color package."
19441 (apply 'format "%s,%s,%s"
19442 (mapcar 'org-normalize-color
19443 (if (featurep 'xemacs)
19444 (color-rgb-components
19445 (face-property 'default
19446 (cond ((eq attr :foreground) 'foreground)
19447 ((eq attr :background) 'background))))
19448 (color-values (face-attribute 'default attr nil))))))
19450 (defun org-latex-color-format (color-name)
19451 "Convert COLOR-NAME to a RGB color value."
19452 (apply 'format "%s,%s,%s"
19453 (mapcar 'org-normalize-color
19454 (color-values color-name))))
19456 (defun org-normalize-color (value)
19457 "Return string to be used as color value for an RGB component."
19458 (format "%g" (/ value 65535.0)))
19464 (defvar org-inline-image-overlays nil)
19465 (make-variable-buffer-local 'org-inline-image-overlays)
19467 (defun org-toggle-inline-images (&optional include-linked)
19468 "Toggle the display of inline images.
19469 INCLUDE-LINKED is passed to `org-display-inline-images'."
19471 (if org-inline-image-overlays
19473 (org-remove-inline-images)
19474 (when (org-called-interactively-p 'interactive)
19475 (message "Inline image display turned off")))
19476 (org-display-inline-images include-linked)
19477 (when (org-called-interactively-p 'interactive)
19478 (message (if org-inline-image-overlays
19479 (format "%d images displayed inline"
19480 (length org-inline-image-overlays))
19481 "No images to display inline")))))
19483 (defun org-redisplay-inline-images ()
19484 "Refresh the display of inline images."
19486 (if (not org-inline-image-overlays)
19487 (org-toggle-inline-images)
19488 (org-toggle-inline-images)
19489 (org-toggle-inline-images)))
19491 (defun org-display-inline-images (&optional include-linked refresh beg end)
19492 "Display inline images.
19494 An inline image is a link which follows either of these
19497 1. Its path is a file with an extension matching return value
19498 from `image-file-name-regexp' and it has no contents.
19500 2. Its description consists in a single link of the previous
19503 When optional argument INCLUDE-LINKED is non-nil, also links with
19504 a text description part will be inlined. This can be nice for
19505 a quick look at those images, but it does not reflect what
19506 exported files will look like.
19508 When optional argument REFRESH is non-nil, refresh existing
19509 images between BEG and END. This will create new image displays
19510 only if necessary. BEG and END default to the buffer
19513 (when (display-graphic-p)
19515 (org-remove-inline-images)
19516 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19517 (org-with-wide-buffer
19518 (goto-char (or beg (point-min)))
19519 (let ((case-fold-search t)
19520 (file-extension-re (org-image-file-name-regexp)))
19521 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19522 (let ((link (save-match-data (org-element-context))))
19523 ;; Check if we're at an inline image.
19524 (when (and (equal (org-element-property :type link) "file")
19526 (not (org-element-property :contents-begin link)))
19527 (let ((parent (org-element-property :parent link)))
19528 (or (not (eq (org-element-type parent) 'link))
19529 (not (cdr (org-element-contents parent)))))
19530 (org-string-match-p file-extension-re
19531 (org-element-property :path link)))
19532 (let ((file (expand-file-name (org-element-property :path link))))
19533 (when (file-exists-p file)
19535 ;; Apply `org-image-actual-width' specifications.
19537 ((not (image-type-available-p 'imagemagick)) nil)
19538 ((eq org-image-actual-width t) nil)
19539 ((listp org-image-actual-width)
19541 ;; First try to find a width among
19542 ;; attributes associated to the paragraph
19543 ;; containing link.
19546 (while (and (setq e (org-element-property
19548 (not (eq (org-element-type e)
19553 (goto-char (org-element-property :begin paragraph))
19556 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19557 (org-element-property
19558 :post-affiliated paragraph)
19560 (string-to-number (match-string 1))))))
19561 ;; Otherwise, fall-back to provided number.
19562 (car org-image-actual-width)))
19563 ((numberp org-image-actual-width)
19564 org-image-actual-width)))
19565 (old (get-char-property-and-overlay
19566 (org-element-property :begin link)
19567 'org-image-overlay)))
19568 (if (and (car-safe old) refresh)
19569 (image-refresh (overlay-get (cdr old) 'display))
19570 (let ((image (create-image file
19571 (and width 'imagemagick)
19576 ;; If inline image is the description
19577 ;; of another link, be sure to
19578 ;; consider the latter as the one to
19579 ;; apply the overlay on.
19581 (org-element-property :parent link)))
19582 (if (eq (org-element-type parent) 'link)
19586 (org-element-property :begin link)
19589 (org-element-property :end link))
19590 (skip-chars-backward " \t")
19592 (overlay-put ov 'display image)
19593 (overlay-put ov 'face 'default)
19594 (overlay-put ov 'org-image-overlay t)
19596 ov 'modification-hooks
19597 (list 'org-display-inline-remove-overlay))
19598 (push ov org-inline-image-overlays)))))))))))))))
19600 (define-obsolete-function-alias
19601 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19603 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19604 "Remove inline-display overlay if a corresponding region is modified."
19605 (let ((inhibit-modification-hooks t))
19606 (when (and ov after)
19607 (delete ov org-inline-image-overlays)
19608 (delete-overlay ov))))
19610 (defun org-remove-inline-images ()
19611 "Remove inline display of images."
19613 (mapc 'delete-overlay org-inline-image-overlays)
19614 (setq org-inline-image-overlays nil))
19618 ;; Outline functions from `outline-mode-prefix-map'
19619 ;; that can be remapped in Org:
19620 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19621 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19622 (define-key org-mode-map [remap outline-forward-same-level]
19623 'org-forward-heading-same-level)
19624 (define-key org-mode-map [remap outline-backward-same-level]
19625 'org-backward-heading-same-level)
19626 (define-key org-mode-map [remap show-branches]
19627 'org-kill-note-or-show-branches)
19628 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19629 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19630 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19631 (define-key org-mode-map [remap outline-next-visible-heading]
19632 'org-next-visible-heading)
19633 (define-key org-mode-map [remap outline-previous-visible-heading]
19634 'org-previous-visible-heading)
19636 ;; Outline functions from `outline-mode-prefix-map' that can not
19637 ;; be remapped in Org:
19639 ;; - the column "key binding" shows whether the Outline function is still
19640 ;; available in Org mode on the same key that it has been bound to in
19642 ;; - "overridden": key used for a different functionality in Org mode
19643 ;; - else: key still bound to the same Outline function in Org mode
19645 ;; | Outline function | key binding | Org replacement |
19646 ;; |------------------------------------+-------------+--------------------------|
19647 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19648 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19649 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19650 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19651 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19652 ;; | `show-entry' | overridden | no replacement |
19653 ;; | `show-children' | `C-c C-i' | visibility cycling |
19654 ;; | `show-branches' | `C-c C-k' | still same function |
19655 ;; | `show-subtree' | overridden | visibility cycling |
19656 ;; | `show-all' | overridden | no replacement |
19657 ;; | `hide-subtree' | overridden | visibility cycling |
19658 ;; | `hide-body' | overridden | no replacement |
19659 ;; | `hide-entry' | overridden | visibility cycling |
19660 ;; | `hide-leaves' | overridden | no replacement |
19661 ;; | `hide-sublevels' | overridden | no replacement |
19662 ;; | `hide-other' | overridden | no replacement |
19664 ;; Make `C-c C-x' a prefix key
19665 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19667 ;; TAB key with modifiers
19668 (org-defkey org-mode-map "\C-i" 'org-cycle)
19669 (org-defkey org-mode-map [(tab)] 'org-cycle)
19670 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19671 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19672 ;; The following line is necessary under Suse GNU/Linux
19673 (unless (featurep 'xemacs)
19674 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19675 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19676 (define-key org-mode-map [backtab] 'org-shifttab)
19678 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19679 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19680 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19682 ;; Cursor keys with modifiers
19683 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19684 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19685 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19686 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19688 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19689 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19690 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19691 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19692 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19693 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19695 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19696 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19697 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19698 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19700 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19701 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19702 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19703 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19706 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19707 (mapc (lambda (pair)
19708 (define-key org-babel-map (car pair) (cdr pair)))
19709 org-babel-key-bindings)
19711 ;;; Extra keys for tty access.
19712 ;; We only set them when really needed because otherwise the
19713 ;; menus don't show the simple keys
19715 (when (or org-use-extra-keys
19716 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19717 (not window-system))
19718 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19719 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19720 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19721 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19722 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19723 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19724 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19725 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19726 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19727 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19728 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19729 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19730 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19731 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19732 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19733 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19734 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19735 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19736 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19737 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19738 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19739 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19740 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19741 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19742 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19743 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19744 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19745 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19747 ;; All the other keys
19749 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19750 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19751 (if (boundp 'narrow-map)
19752 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19753 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19754 (if (boundp 'narrow-map)
19755 (org-defkey narrow-map "b" 'org-narrow-to-block)
19756 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19757 (if (boundp 'narrow-map)
19758 (org-defkey narrow-map "e" 'org-narrow-to-element)
19759 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19760 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19761 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19762 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19763 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19764 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19765 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19766 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19767 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19768 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19769 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19770 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19771 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19772 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19773 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19774 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19775 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19776 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19777 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19778 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19779 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19780 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19781 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19782 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19783 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19784 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19785 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19786 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19787 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19788 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19789 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19790 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19791 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19792 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19793 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19794 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19795 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19796 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19797 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19798 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19799 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19800 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19801 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19802 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19803 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19804 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19805 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19806 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19807 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19808 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19809 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19810 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19811 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19812 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19813 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19814 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19815 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19816 (org-defkey org-mode-map "\C-c^" 'org-sort)
19817 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19818 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19819 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19820 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19821 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19822 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19823 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19824 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19825 (org-defkey org-mode-map "\C-m" 'org-return)
19826 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19827 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19828 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19829 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19830 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19831 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19832 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19833 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19834 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19835 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19836 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19837 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19838 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19839 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19840 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19841 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19842 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19843 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19844 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19845 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19846 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19847 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19848 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19849 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19850 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19852 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19853 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19854 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19856 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19857 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19858 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19859 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19860 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19861 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19862 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19863 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19864 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19865 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19866 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19867 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19868 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19869 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19870 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19871 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19872 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19873 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19874 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19875 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19876 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19877 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19879 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19880 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19881 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19882 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19883 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19885 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19887 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19889 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19890 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19892 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19895 (when (featurep 'xemacs)
19896 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19899 (defconst org-speed-commands-default
19901 ("Outline Navigation")
19902 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19903 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19904 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19905 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19906 ("F" . org-next-block)
19907 ("B" . org-previous-block)
19908 ("u" . (org-speed-move-safe 'outline-up-heading))
19910 ("g" . (org-refile t))
19911 ("Outline Visibility")
19913 ("C" . org-shifttab)
19914 (" " . org-display-outline-path)
19915 ("s" . org-narrow-to-subtree)
19916 ("=" . org-columns)
19917 ("Outline Structure Editing")
19919 ("D" . org-metadown)
19920 ("r" . org-metaright)
19921 ("l" . org-metaleft)
19922 ("R" . org-shiftmetaright)
19923 ("L" . org-shiftmetaleft)
19924 ("i" . (progn (forward-char 1) (call-interactively
19925 'org-insert-heading-respect-content)))
19928 ("a" . org-archive-subtree-default-with-confirmation)
19929 ("@" . org-mark-subtree)
19930 ("#" . org-toggle-comment)
19932 ("I" . org-clock-in)
19933 ("O" . org-clock-out)
19934 ("Meta Data Editing")
19936 ("," . (org-priority))
19937 ("0" . (org-priority ?\ ))
19938 ("1" . (org-priority ?A))
19939 ("2" . (org-priority ?B))
19940 ("3" . (org-priority ?C))
19941 (":" . org-set-tags-command)
19942 ("e" . org-set-effort)
19943 ("E" . org-inc-effort)
19944 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19945 (org-entry-put (point) "APPT_WARNTIME" m)))
19946 ("Agenda Views etc")
19948 ("/" . org-sparse-tree)
19950 ("o" . org-open-at-point)
19951 ("?" . org-speed-command-help)
19952 ("<" . (org-agenda-set-restriction-lock 'subtree))
19953 (">" . (org-agenda-remove-restriction-lock))
19955 "The default speed commands.")
19957 (defun org-print-speed-command (e)
19958 (if (> (length (car e)) 1)
19963 (princ (make-string (length (car e)) ?-))
19967 (if (symbolp (cdr e))
19968 (princ (symbol-name (cdr e)))
19972 (defun org-speed-command-help ()
19973 "Show the available speed commands."
19975 (if (not org-use-speed-commands)
19976 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19977 (with-output-to-temp-buffer "*Help*"
19978 (princ "User-defined Speed commands\n===========================\n")
19979 (mapc 'org-print-speed-command org-speed-commands-user)
19981 (princ "Built-in Speed commands\n=======================\n")
19982 (mapc 'org-print-speed-command org-speed-commands-default))
19983 (with-current-buffer "*Help*"
19984 (setq truncate-lines t))))
19986 (defun org-speed-move-safe (cmd)
19987 "Execute CMD, but make sure that the cursor always ends up in a headline.
19988 If not, return to the original position and throw an error."
19990 (let ((pos (point)))
19991 (call-interactively cmd)
19992 (unless (and (bolp) (org-at-heading-p))
19994 (error "Boundary reached while executing %s" cmd))))
19996 (defvar org-self-insert-command-undo-counter 0)
19998 (defvar org-table-auto-blank-field) ; defined in org-table.el
19999 (defvar org-speed-command nil)
20001 (define-obsolete-function-alias
20002 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20004 (defun org-speed-command-activate (keys)
20005 "Hook for activating single-letter speed commands.
20006 `org-speed-commands-default' specifies a minimal command set.
20007 Use `org-speed-commands-user' for further customization."
20008 (when (or (and (bolp) (looking-at org-outline-regexp))
20009 (and (functionp org-use-speed-commands)
20010 (funcall org-use-speed-commands)))
20011 (cdr (assoc keys (append org-speed-commands-user
20012 org-speed-commands-default)))))
20014 (define-obsolete-function-alias
20015 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20017 (defun org-babel-speed-command-activate (keys)
20018 "Hook for activating single-letter code block commands."
20019 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20020 (cdr (assoc keys org-babel-key-bindings))))
20022 (defcustom org-speed-command-hook
20023 '(org-speed-command-default-hook org-babel-speed-command-hook)
20024 "Hook for activating speed commands at strategic locations.
20025 Hook functions are called in sequence until a valid handler is
20028 Each hook takes a single argument, a user-pressed command key
20029 which is also a `self-insert-command' from the global map.
20031 Within the hook, examine the cursor position and the command key
20032 and return nil or a valid handler as appropriate. Handler could
20033 be one of an interactive command, a function, or a form.
20035 Set `org-use-speed-commands' to non-nil value to enable this
20036 hook. The default setting is `org-speed-command-activate'."
20037 :group 'org-structure
20041 (defun org-self-insert-command (N)
20042 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20043 If the cursor is in a table looking at whitespace, the whitespace is
20044 overwritten, and the table is not marked as requiring realignment."
20046 (org-check-before-invisible-edit 'insert)
20048 ((and org-use-speed-commands
20049 (let ((kv (this-command-keys-vector)))
20050 (setq org-speed-command
20051 (run-hook-with-args-until-success
20052 'org-speed-command-hook
20053 (make-string 1 (aref kv (1- (length kv))))))))
20055 ((commandp org-speed-command)
20056 (setq this-command org-speed-command)
20057 (call-interactively org-speed-command))
20058 ((functionp org-speed-command)
20059 (funcall org-speed-command))
20060 ((and org-speed-command (listp org-speed-command))
20061 (eval org-speed-command))
20062 (t (let (org-use-speed-commands)
20063 (call-interactively 'org-self-insert-command)))))
20067 ;; check if we blank the field, and if that triggers align
20068 (and (featurep 'org-table) org-table-auto-blank-field
20070 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20071 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20072 ;; got extra space, this field does not determine column width
20073 (let (org-table-may-need-update) (org-table-blank-field))
20074 ;; no extra space, this field may determine column width
20075 (org-table-blank-field)))
20078 (looking-at "[^|\n]* |"))
20079 (let (org-table-may-need-update)
20080 (goto-char (1- (match-end 0)))
20081 (backward-delete-char 1)
20082 (goto-char (match-beginning 0))
20083 (self-insert-command N)))
20085 (setq org-table-may-need-update t)
20086 (self-insert-command N)
20087 (org-fix-tags-on-the-fly)
20088 (if org-self-insert-cluster-for-undo
20089 (if (not (eq last-command 'org-self-insert-command))
20090 (setq org-self-insert-command-undo-counter 1)
20091 (if (>= org-self-insert-command-undo-counter 20)
20092 (setq org-self-insert-command-undo-counter 1)
20093 (and (> org-self-insert-command-undo-counter 0)
20094 buffer-undo-list (listp buffer-undo-list)
20095 (not (cadr buffer-undo-list)) ; remove nil entry
20096 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20097 (setq org-self-insert-command-undo-counter
20098 (1+ org-self-insert-command-undo-counter))))))))
20100 (defun org-check-before-invisible-edit (kind)
20101 "Check is editing if kind KIND would be dangerous with invisible text around.
20102 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20103 ;; First, try to get out of here as quickly as possible, to reduce overhead
20104 (if (and org-catch-invisible-edits
20105 (or (not (boundp 'visible-mode)) (not visible-mode))
20106 (or (get-char-property (point) 'invisible)
20107 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20108 ;; OK, we need to take a closer look
20109 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20110 (invisible-before-point (if (bobp) nil (get-char-property
20111 (1- (point)) 'invisible)))
20112 (border-and-ok-direction
20114 ;; Check if we are acting predictably before invisible text
20115 (and invisible-at-point (not invisible-before-point)
20116 (memq kind '(insert delete-backward)))
20117 ;; Check if we are acting predictably after invisible text
20118 ;; This works not well, and I have turned it off. It seems
20119 ;; better to always show and stop after invisible text.
20120 ;; (and (not invisible-at-point) invisible-before-point
20121 ;; (memq kind '(insert delete)))
20123 (when (or (memq invisible-at-point '(outline org-hide-block t))
20124 (memq invisible-before-point '(outline org-hide-block t)))
20125 (if (eq org-catch-invisible-edits 'error)
20126 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20127 (if (and org-custom-properties-overlays
20128 (y-or-n-p "Display invisible properties in this buffer? "))
20129 (org-toggle-custom-properties-visibility)
20130 ;; Make the area visible
20132 (if invisible-before-point
20133 (goto-char (previous-single-char-property-change
20134 (point) 'invisible)))
20137 ((eq org-catch-invisible-edits 'show)
20138 ;; That's it, we do the edit after showing
20140 "Unfolding invisible region around point before editing")
20142 ((and (eq org-catch-invisible-edits 'smart)
20143 border-and-ok-direction)
20144 (message "Unfolding invisible region around point before editing"))
20146 ;; Don't do the edit, make the user repeat it in full visibility
20147 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20149 (defun org-fix-tags-on-the-fly ()
20150 (when (and (equal (char-after (point-at-bol)) ?*)
20151 (org-at-heading-p))
20152 (org-align-tags-here org-tags-column)))
20154 (defun org-delete-backward-char (N)
20155 "Like `delete-backward-char', insert whitespace at field end in tables.
20156 When deleting backwards, in tables this function will insert whitespace in
20157 front of the next \"|\" separator, to keep the table aligned. The table will
20158 still be marked for re-alignment if the field did fill the entire column,
20159 because, in this case the deletion might narrow the column."
20162 (org-check-before-invisible-edit 'delete-backward)
20163 (if (and (org-table-p)
20165 (string-match "|" (buffer-substring (point-at-bol) (point)))
20166 (looking-at ".*?|"))
20167 (let ((pos (point))
20168 (noalign (looking-at "[^|\n\r]* |"))
20169 (c org-table-may-need-update))
20170 (backward-delete-char N)
20171 (if (not overwrite-mode)
20173 (skip-chars-forward "^|")
20175 (goto-char (1- pos))))
20176 ;; noalign: if there were two spaces at the end, this field
20177 ;; does not determine the width of the column.
20178 (if noalign (setq org-table-may-need-update c)))
20179 (backward-delete-char N)
20180 (org-fix-tags-on-the-fly))))
20182 (defun org-delete-char (N)
20183 "Like `delete-char', but insert whitespace at field end in tables.
20184 When deleting characters, in tables this function will insert whitespace in
20185 front of the next \"|\" separator, to keep the table aligned. The table will
20186 still be marked for re-alignment if the field did fill the entire column,
20187 because, in this case the deletion might narrow the column."
20190 (org-check-before-invisible-edit 'delete)
20191 (if (and (org-table-p)
20193 (not (= (char-after) ?|))
20195 (if (looking-at ".*?|")
20196 (let ((pos (point))
20197 (noalign (looking-at "[^|\n\r]* |"))
20198 (c org-table-may-need-update))
20200 (concat (substring (match-string 0) 1 -1) " |") nil t)
20202 ;; noalign: if there were two spaces at the end, this field
20203 ;; does not determine the width of the column.
20204 (if noalign (setq org-table-may-need-update c)))
20207 (org-fix-tags-on-the-fly))))
20209 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20210 (put 'org-self-insert-command 'delete-selection
20212 (not (run-hook-with-args-until-success
20213 'self-insert-uses-region-functions))))
20214 (put 'orgtbl-self-insert-command 'delete-selection
20216 (not (run-hook-with-args-until-success
20217 'self-insert-uses-region-functions))))
20218 (put 'org-delete-char 'delete-selection 'supersede)
20219 (put 'org-delete-backward-char 'delete-selection 'supersede)
20220 (put 'org-yank 'delete-selection 'yank)
20222 ;; Make `flyspell-mode' delay after some commands
20223 (put 'org-self-insert-command 'flyspell-delayed t)
20224 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20225 (put 'org-delete-char 'flyspell-delayed t)
20226 (put 'org-delete-backward-char 'flyspell-delayed t)
20228 ;; Make pabbrev-mode expand after org-mode commands
20229 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20230 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20232 (defun org-remap (map &rest commands)
20233 "In MAP, remap the functions given in COMMANDS.
20234 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20237 (setq old (pop commands) new (pop commands))
20238 (if (fboundp 'command-remapping)
20239 (org-defkey map (vector 'remap old) new)
20240 (substitute-key-definition old new map global-map)))))
20242 (defun org-transpose-words ()
20243 "Transpose words for Org.
20244 This uses the `org-mode-transpose-word-syntax-table' syntax
20245 table, which interprets characters in `org-emphasis-alist' as
20246 word constituents."
20248 (with-syntax-table org-mode-transpose-word-syntax-table
20249 (call-interactively 'transpose-words)))
20250 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20252 (when (eq org-enable-table-editor 'optimized)
20253 ;; If the user wants maximum table support, we need to hijack
20254 ;; some standard editing functions
20255 (org-remap org-mode-map
20256 'self-insert-command 'org-self-insert-command
20257 'delete-char 'org-delete-char
20258 'delete-backward-char 'org-delete-backward-char)
20259 (org-defkey org-mode-map "|" 'org-force-self-insert))
20261 (defvar org-ctrl-c-ctrl-c-hook nil
20262 "Hook for functions attaching themselves to `C-c C-c'.
20264 This can be used to add additional functionality to the C-c C-c
20265 key which executes context-dependent commands. This hook is run
20266 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20267 run after the last test.
20269 Each function will be called with no arguments. The function
20270 must check if the context is appropriate for it to act. If yes,
20271 it should do its thing and then return a non-nil value. If the
20272 context is wrong, just do nothing and return nil.")
20274 (defvar org-ctrl-c-ctrl-c-final-hook nil
20275 "Hook for functions attaching themselves to `C-c C-c'.
20277 This can be used to add additional functionality to the C-c C-c
20278 key which executes context-dependent commands. This hook is run
20279 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20280 before the first test.
20282 Each function will be called with no arguments. The function
20283 must check if the context is appropriate for it to act. If yes,
20284 it should do its thing and then return a non-nil value. If the
20285 context is wrong, just do nothing and return nil.")
20287 (defvar org-tab-first-hook nil
20288 "Hook for functions to attach themselves to TAB.
20289 See `org-ctrl-c-ctrl-c-hook' for more information.
20290 This hook runs as the first action when TAB is pressed, even before
20291 `org-cycle' messes around with the `outline-regexp' to cater for
20292 inline tasks and plain list item folding.
20293 If any function in this hook returns t, any other actions that
20294 would have been caused by TAB (such as table field motion or visibility
20295 cycling) will not occur.")
20297 (defvar org-tab-after-check-for-table-hook nil
20298 "Hook for functions to attach themselves to TAB.
20299 See `org-ctrl-c-ctrl-c-hook' for more information.
20300 This hook runs after it has been established that the cursor is not in a
20301 table, but before checking if the cursor is in a headline or if global cycling
20303 If any function in this hook returns t, not other actions like visibility
20304 cycling will be done.")
20306 (defvar org-tab-after-check-for-cycling-hook nil
20307 "Hook for functions to attach themselves to TAB.
20308 See `org-ctrl-c-ctrl-c-hook' for more information.
20309 This hook runs after it has been established that not table field motion and
20310 not visibility should be done because of current context. This is probably
20311 the place where a package like yasnippets can hook in.")
20313 (defvar org-tab-before-tab-emulation-hook nil
20314 "Hook for functions to attach themselves to TAB.
20315 See `org-ctrl-c-ctrl-c-hook' for more information.
20316 This hook runs after every other options for TAB have been exhausted, but
20317 before indentation and \t insertion takes place.")
20319 (defvar org-metaleft-hook nil
20320 "Hook for functions attaching themselves to `M-left'.
20321 See `org-ctrl-c-ctrl-c-hook' for more information.")
20322 (defvar org-metaright-hook nil
20323 "Hook for functions attaching themselves to `M-right'.
20324 See `org-ctrl-c-ctrl-c-hook' for more information.")
20325 (defvar org-metaup-hook nil
20326 "Hook for functions attaching themselves to `M-up'.
20327 See `org-ctrl-c-ctrl-c-hook' for more information.")
20328 (defvar org-metadown-hook nil
20329 "Hook for functions attaching themselves to `M-down'.
20330 See `org-ctrl-c-ctrl-c-hook' for more information.")
20331 (defvar org-shiftmetaleft-hook nil
20332 "Hook for functions attaching themselves to `M-S-left'.
20333 See `org-ctrl-c-ctrl-c-hook' for more information.")
20334 (defvar org-shiftmetaright-hook nil
20335 "Hook for functions attaching themselves to `M-S-right'.
20336 See `org-ctrl-c-ctrl-c-hook' for more information.")
20337 (defvar org-shiftmetaup-hook nil
20338 "Hook for functions attaching themselves to `M-S-up'.
20339 See `org-ctrl-c-ctrl-c-hook' for more information.")
20340 (defvar org-shiftmetadown-hook nil
20341 "Hook for functions attaching themselves to `M-S-down'.
20342 See `org-ctrl-c-ctrl-c-hook' for more information.")
20343 (defvar org-metareturn-hook nil
20344 "Hook for functions attaching themselves to `M-RET'.
20345 See `org-ctrl-c-ctrl-c-hook' for more information.")
20346 (defvar org-shiftup-hook nil
20347 "Hook for functions attaching themselves to `S-up'.
20348 See `org-ctrl-c-ctrl-c-hook' for more information.")
20349 (defvar org-shiftup-final-hook nil
20350 "Hook for functions attaching themselves to `S-up'.
20351 This one runs after all other options except shift-select have been excluded.
20352 See `org-ctrl-c-ctrl-c-hook' for more information.")
20353 (defvar org-shiftdown-hook nil
20354 "Hook for functions attaching themselves to `S-down'.
20355 See `org-ctrl-c-ctrl-c-hook' for more information.")
20356 (defvar org-shiftdown-final-hook nil
20357 "Hook for functions attaching themselves to `S-down'.
20358 This one runs after all other options except shift-select have been excluded.
20359 See `org-ctrl-c-ctrl-c-hook' for more information.")
20360 (defvar org-shiftleft-hook nil
20361 "Hook for functions attaching themselves to `S-left'.
20362 See `org-ctrl-c-ctrl-c-hook' for more information.")
20363 (defvar org-shiftleft-final-hook nil
20364 "Hook for functions attaching themselves to `S-left'.
20365 This one runs after all other options except shift-select have been excluded.
20366 See `org-ctrl-c-ctrl-c-hook' for more information.")
20367 (defvar org-shiftright-hook nil
20368 "Hook for functions attaching themselves to `S-right'.
20369 See `org-ctrl-c-ctrl-c-hook' for more information.")
20370 (defvar org-shiftright-final-hook nil
20371 "Hook for functions attaching themselves to `S-right'.
20372 This one runs after all other options except shift-select have been excluded.
20373 See `org-ctrl-c-ctrl-c-hook' for more information.")
20375 (defun org-modifier-cursor-error ()
20376 "Throw an error, a modified cursor command was applied in wrong context."
20377 (user-error "This command is active in special context like tables, headlines or items"))
20379 (defun org-shiftselect-error ()
20380 "Throw an error because Shift-Cursor command was applied in wrong context."
20381 (if (and (boundp 'shift-select-mode) shift-select-mode)
20382 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20383 (user-error "This command works only in special context like headlines or timestamps")))
20385 (defun org-call-for-shift-select (cmd)
20386 (let ((this-command-keys-shift-translated t))
20387 (call-interactively cmd)))
20389 (defun org-shifttab (&optional arg)
20390 "Global visibility cycling or move to previous table field.
20391 Call `org-table-previous-field' within a table.
20392 When ARG is nil, cycle globally through visibility states.
20393 When ARG is a numeric prefix, show contents of this level."
20396 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20398 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20399 (message "Content view to level: %d" arg)
20400 (org-content (prefix-numeric-value arg2))
20401 (org-cycle-show-empty-lines t)
20402 (setq org-cycle-global-status 'overview)))
20403 (t (call-interactively 'org-global-cycle))))
20405 (defun org-shiftmetaleft ()
20406 "Promote subtree or delete table column.
20407 Calls `org-promote-subtree', `org-outdent-item-tree', or
20408 `org-table-delete-column', depending on context. See the
20409 individual commands for more information."
20412 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20413 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20414 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20415 ((if (not (org-region-active-p)) (org-at-item-p)
20416 (save-excursion (goto-char (region-beginning))
20418 (call-interactively 'org-outdent-item-tree))
20419 (t (org-modifier-cursor-error))))
20421 (defun org-shiftmetaright ()
20422 "Demote subtree or insert table column.
20423 Calls `org-demote-subtree', `org-indent-item-tree', or
20424 `org-table-insert-column', depending on context. See the
20425 individual commands for more information."
20428 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20429 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20430 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20431 ((if (not (org-region-active-p)) (org-at-item-p)
20432 (save-excursion (goto-char (region-beginning))
20434 (call-interactively 'org-indent-item-tree))
20435 (t (org-modifier-cursor-error))))
20437 (defun org-shiftmetaup (&optional arg)
20438 "Drag the line at point up.
20439 In a table, kill the current row.
20440 On a clock timestamp, update the value of the timestamp like `S-<up>'
20441 but also adjust the previous clocked item in the clock history.
20442 Everywhere else, drag the line at point up."
20445 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20446 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20447 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20448 (call-interactively 'org-timestamp-up)))
20449 (t (call-interactively 'org-drag-line-backward))))
20451 (defun org-shiftmetadown (&optional arg)
20452 "Drag the line at point down.
20453 In a table, insert an empty row at the current line.
20454 On a clock timestamp, update the value of the timestamp like `S-<down>'
20455 but also adjust the previous clocked item in the clock history.
20456 Everywhere else, drag the line at point down."
20459 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20460 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20461 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20462 (call-interactively 'org-timestamp-down)))
20463 (t (call-interactively 'org-drag-line-forward))))
20465 (defsubst org-hidden-tree-error ()
20467 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20469 (defun org-metaleft (&optional arg)
20470 "Promote heading, list item at point or move table column left.
20472 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20473 depending on context. With no specific context, calls the Emacs
20474 default `backward-word'. See the individual commands for more
20477 This function runs the hook `org-metaleft-hook' as a first step,
20478 and returns at first non-nil value."
20481 ((run-hook-with-args-until-success 'org-metaleft-hook))
20482 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20483 ((org-with-limited-levels
20484 (or (org-at-heading-p)
20485 (and (org-region-active-p)
20487 (goto-char (region-beginning))
20488 (org-at-heading-p)))))
20489 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20490 (call-interactively 'org-do-promote))
20491 ;; At an inline task.
20492 ((org-at-heading-p)
20493 (call-interactively 'org-inlinetask-promote))
20494 ((or (org-at-item-p)
20495 (and (org-region-active-p)
20497 (goto-char (region-beginning))
20499 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20500 (call-interactively 'org-outdent-item))
20501 (t (call-interactively 'backward-word))))
20503 (defun org-metaright (&optional arg)
20504 "Demote heading, list item at point or move table column right.
20506 In front of a drawer or a block keyword, indent it correctly.
20508 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20509 `org-indnet-drawer' or `org-indent-block' depending on context.
20510 With no specific context, calls the Emacs default `forward-word'.
20511 See the individual commands for more information.
20513 This function runs the hook `org-metaright-hook' as a first step,
20514 and returns at first non-nil value."
20517 ((run-hook-with-args-until-success 'org-metaright-hook))
20518 ((org-at-table-p) (call-interactively 'org-table-move-column))
20519 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20520 ((org-at-block-p) (call-interactively 'org-indent-block))
20521 ((org-with-limited-levels
20522 (or (org-at-heading-p)
20523 (and (org-region-active-p)
20525 (goto-char (region-beginning))
20526 (org-at-heading-p)))))
20527 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20528 (call-interactively 'org-do-demote))
20529 ;; At an inline task.
20530 ((org-at-heading-p)
20531 (call-interactively 'org-inlinetask-demote))
20532 ((or (org-at-item-p)
20533 (and (org-region-active-p)
20535 (goto-char (region-beginning))
20537 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20538 (call-interactively 'org-indent-item))
20539 (t (call-interactively 'forward-word))))
20541 (defun org-check-for-hidden (what)
20542 "Check if there are hidden headlines/items in the current visual line.
20543 WHAT can be either `headlines' or `items'. If the current line is
20544 an outline or item heading and it has a folded subtree below it,
20545 this function returns t, nil otherwise."
20547 ((eq what 'headlines) org-outline-regexp-bol)
20548 ((eq what 'items) (org-item-beginning-re))
20549 (t (error "This should not happen"))))
20553 (unless (org-region-active-p)
20554 (setq beg (point-at-bol))
20555 (beginning-of-line 2)
20556 (while (and (not (eobp)) ;; this is like `next-line'
20557 (get-char-property (1- (point)) 'invisible))
20558 (beginning-of-line 2))
20561 (goto-char (point-at-eol))
20562 (setq end (max end (point)))
20563 (while (re-search-forward re end t)
20564 (if (get-char-property (match-beginning 0) 'invisible)
20568 (defun org-metaup (&optional arg)
20569 "Move subtree up or move table row up.
20570 Calls `org-move-subtree-up' or `org-table-move-row' or
20571 `org-move-item-up', depending on context. See the individual commands
20572 for more information."
20575 ((run-hook-with-args-until-success 'org-metaup-hook))
20576 ((org-region-active-p)
20577 (let* ((a (min (region-beginning) (region-end)))
20578 (b (1- (max (region-beginning) (region-end))))
20579 (c (save-excursion (goto-char a)
20580 (move-beginning-of-line 0)))
20581 (d (save-excursion (goto-char a)
20582 (move-end-of-line 0) (point))))
20583 (transpose-regions a b c d)
20585 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20586 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20587 ((org-at-item-p) (call-interactively 'org-move-item-up))
20588 (t (org-drag-element-backward))))
20590 (defun org-metadown (&optional arg)
20591 "Move subtree down or move table row down.
20592 Calls `org-move-subtree-down' or `org-table-move-row' or
20593 `org-move-item-down', depending on context. See the individual
20594 commands for more information."
20597 ((run-hook-with-args-until-success 'org-metadown-hook))
20598 ((org-region-active-p)
20599 (let* ((a (min (region-beginning) (region-end)))
20600 (b (max (region-beginning) (region-end)))
20601 (c (save-excursion (goto-char b)
20602 (move-beginning-of-line 1)))
20603 (d (save-excursion (goto-char b)
20604 (move-end-of-line 1) (1+ (point)))))
20605 (transpose-regions a b c d)
20607 ((org-at-table-p) (call-interactively 'org-table-move-row))
20608 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20609 ((org-at-item-p) (call-interactively 'org-move-item-down))
20610 (t (org-drag-element-forward))))
20612 (defun org-shiftup (&optional arg)
20613 "Increase item in timestamp or increase priority of current headline.
20614 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20615 depending on context. See the individual commands for more information."
20618 ((run-hook-with-args-until-success 'org-shiftup-hook))
20619 ((and org-support-shift-select (org-region-active-p))
20620 (org-call-for-shift-select 'previous-line))
20621 ((org-at-timestamp-p t)
20622 (call-interactively (if org-edit-timestamp-down-means-later
20623 'org-timestamp-down 'org-timestamp-up)))
20624 ((and (not (eq org-support-shift-select 'always))
20625 org-enable-priority-commands
20626 (org-at-heading-p))
20627 (call-interactively 'org-priority-up))
20628 ((and (not org-support-shift-select) (org-at-item-p))
20629 (call-interactively 'org-previous-item))
20630 ((org-clocktable-try-shift 'up arg))
20631 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20632 (org-support-shift-select
20633 (org-call-for-shift-select 'previous-line))
20634 (t (org-shiftselect-error))))
20636 (defun org-shiftdown (&optional arg)
20637 "Decrease item in timestamp or decrease priority of current headline.
20638 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20639 depending on context. See the individual commands for more information."
20642 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20643 ((and org-support-shift-select (org-region-active-p))
20644 (org-call-for-shift-select 'next-line))
20645 ((org-at-timestamp-p t)
20646 (call-interactively (if org-edit-timestamp-down-means-later
20647 'org-timestamp-up 'org-timestamp-down)))
20648 ((and (not (eq org-support-shift-select 'always))
20649 org-enable-priority-commands
20650 (org-at-heading-p))
20651 (call-interactively 'org-priority-down))
20652 ((and (not org-support-shift-select) (org-at-item-p))
20653 (call-interactively 'org-next-item))
20654 ((org-clocktable-try-shift 'down arg))
20655 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20656 (org-support-shift-select
20657 (org-call-for-shift-select 'next-line))
20658 (t (org-shiftselect-error))))
20660 (defun org-shiftright (&optional arg)
20661 "Cycle the thing at point or in the current line, depending on context.
20662 Depending on context, this does one of the following:
20664 - switch a timestamp at point one day into the future
20665 - on a headline, switch to the next TODO keyword.
20666 - on an item, switch entire list to the next bullet type
20667 - on a property line, switch to the next allowed value
20668 - on a clocktable definition line, move time block into the future"
20671 ((run-hook-with-args-until-success 'org-shiftright-hook))
20672 ((and org-support-shift-select (org-region-active-p))
20673 (org-call-for-shift-select 'forward-char))
20674 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20675 ((and (not (eq org-support-shift-select 'always))
20676 (org-at-heading-p))
20677 (let ((org-inhibit-logging
20678 (not org-treat-S-cursor-todo-selection-as-state-change))
20679 (org-inhibit-blocking
20680 (not org-treat-S-cursor-todo-selection-as-state-change)))
20681 (org-call-with-arg 'org-todo 'right)))
20682 ((or (and org-support-shift-select
20683 (not (eq org-support-shift-select 'always))
20684 (org-at-item-bullet-p))
20685 (and (not org-support-shift-select) (org-at-item-p)))
20686 (org-call-with-arg 'org-cycle-list-bullet nil))
20687 ((and (not (eq org-support-shift-select 'always))
20688 (org-at-property-p))
20689 (call-interactively 'org-property-next-allowed-value))
20690 ((org-clocktable-try-shift 'right arg))
20691 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20692 (org-support-shift-select
20693 (org-call-for-shift-select 'forward-char))
20694 (t (org-shiftselect-error))))
20696 (defun org-shiftleft (&optional arg)
20697 "Cycle the thing at point or in the current line, depending on context.
20698 Depending on context, this does one of the following:
20700 - switch a timestamp at point one day into the past
20701 - on a headline, switch to the previous TODO keyword.
20702 - on an item, switch entire list to the previous bullet type
20703 - on a property line, switch to the previous allowed value
20704 - on a clocktable definition line, move time block into the past"
20707 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20708 ((and org-support-shift-select (org-region-active-p))
20709 (org-call-for-shift-select 'backward-char))
20710 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20711 ((and (not (eq org-support-shift-select 'always))
20712 (org-at-heading-p))
20713 (let ((org-inhibit-logging
20714 (not org-treat-S-cursor-todo-selection-as-state-change))
20715 (org-inhibit-blocking
20716 (not org-treat-S-cursor-todo-selection-as-state-change)))
20717 (org-call-with-arg 'org-todo 'left)))
20718 ((or (and org-support-shift-select
20719 (not (eq org-support-shift-select 'always))
20720 (org-at-item-bullet-p))
20721 (and (not org-support-shift-select) (org-at-item-p)))
20722 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20723 ((and (not (eq org-support-shift-select 'always))
20724 (org-at-property-p))
20725 (call-interactively 'org-property-previous-allowed-value))
20726 ((org-clocktable-try-shift 'left arg))
20727 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20728 (org-support-shift-select
20729 (org-call-for-shift-select 'backward-char))
20730 (t (org-shiftselect-error))))
20732 (defun org-shiftcontrolright ()
20733 "Switch to next TODO set."
20736 ((and org-support-shift-select (org-region-active-p))
20737 (org-call-for-shift-select 'forward-word))
20738 ((and (not (eq org-support-shift-select 'always))
20739 (org-at-heading-p))
20740 (org-call-with-arg 'org-todo 'nextset))
20741 (org-support-shift-select
20742 (org-call-for-shift-select 'forward-word))
20743 (t (org-shiftselect-error))))
20745 (defun org-shiftcontrolleft ()
20746 "Switch to previous TODO set."
20749 ((and org-support-shift-select (org-region-active-p))
20750 (org-call-for-shift-select 'backward-word))
20751 ((and (not (eq org-support-shift-select 'always))
20752 (org-at-heading-p))
20753 (org-call-with-arg 'org-todo 'previousset))
20754 (org-support-shift-select
20755 (org-call-for-shift-select 'backward-word))
20756 (t (org-shiftselect-error))))
20758 (defun org-shiftcontrolup (&optional n)
20759 "Change timestamps synchronously up in CLOCK log lines.
20760 Optional argument N tells to change by that many units."
20762 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20763 (let (org-support-shift-select)
20764 (org-clock-timestamps-up n))
20765 (user-error "Not at a clock log")))
20767 (defun org-shiftcontroldown (&optional n)
20768 "Change timestamps synchronously down in CLOCK log lines.
20769 Optional argument N tells to change by that many units."
20771 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20772 (let (org-support-shift-select)
20773 (org-clock-timestamps-down n))
20774 (user-error "Not at a clock log")))
20776 (defun org-increase-number-at-point (&optional inc)
20777 "Increment the number at point.
20778 With an optional prefix numeric argument INC, increment using
20779 this numeric value."
20781 (if (not (number-at-point))
20782 (user-error "Not on a number")
20783 (unless inc (setq inc 1))
20784 (let ((pos (point))
20785 (beg (skip-chars-backward "-+^/*0-9eE."))
20786 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20787 (setq nap (buffer-substring-no-properties
20788 (+ pos beg) (+ pos beg end)))
20789 (delete-region (+ pos beg) (+ pos beg end))
20790 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20791 (when (org-at-table-p)
20793 (org-table-end-of-field 1))))
20795 (defun org-decrease-number-at-point (&optional inc)
20796 "Decrement the number at point.
20797 With an optional prefix numeric argument INC, decrement using
20798 this numeric value."
20800 (org-increase-number-at-point (- inc)))
20802 (defun org-ctrl-c-ret ()
20803 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20806 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20807 (t (call-interactively 'org-insert-heading))))
20809 (defun org-find-visible ()
20811 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20812 (get-char-property s 'invisible)))
20814 (defun org-find-invisible ()
20816 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20817 (not (get-char-property s 'invisible))))
20820 (defun org-copy-visible (beg end)
20821 "Copy the visible parts of the region."
20826 (narrow-to-region beg end)
20827 (setq s (goto-char (point-min)))
20828 (while (not (= (point) (point-max)))
20829 (goto-char (org-find-invisible))
20830 (push (buffer-substring s (point)) snippets)
20831 (setq s (goto-char (org-find-visible))))))
20832 (kill-new (apply 'concat (nreverse snippets)))))
20834 (defun org-copy-special ()
20835 "Copy region in table or copy current subtree.
20836 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20837 See the individual commands for more information."
20839 (call-interactively
20840 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20842 (defun org-cut-special ()
20843 "Cut region in table or cut current subtree.
20844 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20845 See the individual commands for more information."
20847 (call-interactively
20848 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20850 (defun org-paste-special (arg)
20851 "Paste rectangular region into table, or past subtree relative to level.
20852 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20853 See the individual commands for more information."
20855 (if (org-at-table-p)
20856 (org-table-paste-rectangle)
20857 (org-paste-subtree arg)))
20859 (defsubst org-in-fixed-width-region-p ()
20860 "Is point in a fixed-width region?"
20862 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20864 (defun org-edit-special (&optional arg)
20865 "Call a special editor for the element at point.
20866 When at a table, call the formula editor with `org-table-edit-formulas'.
20867 When in a source code block, call `org-edit-src-code'.
20868 When in a fixed-width region, call `org-edit-fixed-width-region'.
20869 When in an export block, call `org-edit-export-block'.
20870 When at an #+INCLUDE keyword, visit the included file.
20871 When at a footnote reference, call `org-edit-footnote-reference'
20872 On a link, call `ffap' to visit the link at point.
20873 Otherwise, return a user error."
20875 (let ((element (org-element-at-point)))
20876 (assert (not buffer-read-only) nil
20877 "Buffer is read-only: %s" (buffer-name))
20878 (case (org-element-type element)
20880 (if (not arg) (org-edit-src-code)
20881 (let* ((info (org-babel-get-src-block-info))
20882 (lang (nth 0 info))
20883 (params (nth 2 info))
20884 (session (cdr (assq :session params))))
20885 (if (not session) (org-edit-src-code)
20886 ;; At a src-block with a session and function called with
20887 ;; an ARG: switch to the buffer related to the inferior
20890 (funcall (intern (concat "org-babel-prep-session:" lang))
20891 session params))))))
20893 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20894 (org-open-link-from-string
20897 (let ((value (org-element-property :value element)))
20898 (cond ((not (org-string-nw-p value))
20899 (user-error "No file to edit"))
20900 ((string-match "\\`\"\\(.*?\\)\"" value)
20901 (match-string 1 value))
20902 ((string-match "\\`[^ \t\"]\\S-*" value)
20903 (match-string 0 value))
20904 (t (user-error "No valid file specified")))))))
20905 (user-error "No special environment to edit here")))
20907 (if (eq (org-element-property :type element) 'table.el)
20908 (org-edit-table.el)
20909 (call-interactively 'org-table-edit-formulas)))
20910 ;; Only Org tables contain `table-row' type elements.
20911 (table-row (call-interactively 'org-table-edit-formulas))
20912 (example-block (org-edit-src-code))
20913 (export-block (org-edit-export-block))
20914 (fixed-width (org-edit-fixed-width-region))
20916 ;; No notable element at point. Though, we may be at a link or
20917 ;; a footnote reference, which are objects. Thus, scan deeper.
20918 (let ((context (org-element-context element)))
20919 (case (org-element-type context)
20920 (link (call-interactively #'ffap))
20921 (footnote-reference (org-edit-footnote-reference))
20922 (t (user-error "No special environment to edit here"))))))))
20924 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20925 (defun org-ctrl-c-ctrl-c (&optional arg)
20926 "Set tags in headline, or update according to changed information at point.
20928 This command does many different things, depending on context:
20930 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20931 this is what we do.
20933 - If the cursor is on a statistics cookie, update it.
20935 - If the cursor is in a headline, prompt for tags and insert them
20936 into the current line, aligned to `org-tags-column'. When called
20937 with prefix arg, realign all tags in the current buffer.
20939 - If the cursor is in one of the special #+KEYWORD lines, this
20940 triggers scanning the buffer for these lines and updating the
20943 - If the cursor is inside a table, realign the table. This command
20944 works even if the automatic table editor has been turned off.
20946 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20949 - If the cursor is at a footnote reference or definition, jump to
20950 the corresponding definition or references, respectively.
20952 - If the cursor is a the beginning of a dynamic block, update it.
20954 - If the current buffer is a capture buffer, close note and file it.
20956 - If the cursor is on a <<<target>>>, update radio targets and
20957 corresponding links in this buffer.
20959 - If the cursor is on a numbered item in a plain list, renumber the
20962 - If the cursor is on a checkbox, toggle it.
20964 - If the cursor is on a code block, evaluate it. The variable
20965 `org-confirm-babel-evaluate' can be used to control prompting
20966 before code block evaluation, by default every code block
20967 evaluation requires confirmation. Code block evaluation can be
20968 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20971 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20972 org-occur-highlights)
20973 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20974 (org-remove-occur-highlights)
20975 (message "Temporary highlights/overlays removed from current buffer"))
20976 ((and (local-variable-p 'org-finish-function (current-buffer))
20977 (fboundp org-finish-function))
20978 (funcall org-finish-function))
20979 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20981 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20982 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20983 (user-error "C-c C-c can do nothing useful at this location"))
20984 (let* ((context (org-element-context))
20985 (type (org-element-type context)))
20987 ;; When at a link, act according to the parent instead.
20988 (link (setq context (org-element-property :parent context))
20989 (setq type (org-element-type context)))
20990 ;; Unsupported object types: refer to the first supported
20991 ;; element or object containing it.
20992 ((bold code entity export-snippet inline-babel-call inline-src-block
20993 italic latex-fragment line-break macro strike-through subscript
20994 superscript underline verbatim)
20996 (org-element-lineage
20997 context '(radio-target paragraph verse-block table-cell)))))
20998 ;; For convenience: at the first line of a paragraph on the
20999 ;; same line as an item, apply function on that item instead.
21000 (when (eq type 'paragraph)
21001 (let ((parent (org-element-property :parent context)))
21002 (when (and (eq (org-element-type parent) 'item)
21003 (= (line-beginning-position)
21004 (org-element-property :begin parent)))
21005 (setq context parent type 'item))))
21006 ;; Act according to type of element or object at point.
21008 (clock (org-clock-update-time-maybe))
21011 (goto-char (org-element-property :post-affiliated context))
21012 (org-update-dblock)))
21013 (footnote-definition
21014 (goto-char (org-element-property :post-affiliated context))
21015 (call-interactively 'org-footnote-action))
21016 (footnote-reference (call-interactively 'org-footnote-action))
21017 ((headline inlinetask)
21018 (save-excursion (goto-char (org-element-property :begin context))
21019 (call-interactively 'org-set-tags)))
21021 ;; At an item: a double C-u set checkbox to "[-]"
21022 ;; unconditionally, whereas a single one will toggle its
21023 ;; presence. Without an universal argument, if the item
21024 ;; has a checkbox, toggle it. Otherwise repair the list.
21025 (let* ((box (org-element-property :checkbox context))
21026 (struct (org-element-property :structure context))
21027 (old-struct (copy-tree struct))
21028 (parents (org-list-parents-alist struct))
21029 (prevs (org-list-prevs-alist struct))
21030 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21031 (org-list-set-checkbox
21032 (org-element-property :begin context) struct
21033 (cond ((equal arg '(16)) "[-]")
21034 ((and (not box) (equal arg '(4))) "[ ]")
21035 ((or (not box) (equal arg '(4))) nil)
21036 ((eq box 'on) "[ ]")
21038 ;; Mimic `org-list-write-struct' but with grabbing
21039 ;; a return value from `org-list-struct-fix-box'.
21040 (org-list-struct-fix-ind struct parents 2)
21041 (org-list-struct-fix-item-end struct)
21042 (org-list-struct-fix-bul struct prevs)
21043 (org-list-struct-fix-ind struct parents)
21045 (org-list-struct-fix-box struct parents prevs orderedp)))
21046 (if (and box (equal struct old-struct))
21047 (if (equal arg '(16))
21048 (message "Checkboxes already reset")
21049 (user-error "Cannot toggle this checkbox: %s"
21051 "all subitems checked"
21052 "unchecked subitems")))
21053 (org-list-struct-apply-struct struct old-struct)
21054 (org-update-checkbox-count-maybe))
21056 (message "Checkboxes were removed due to empty box at line %d"
21057 (org-current-line block-item))))))
21059 (let ((org-inhibit-startup-visibility-stuff t)
21060 (org-startup-align-all-tables nil))
21061 (when (boundp 'org-table-coordinate-overlays)
21062 (mapc 'delete-overlay org-table-coordinate-overlays)
21063 (setq org-table-coordinate-overlays nil))
21064 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21065 (message "Local setup has been refreshed"))
21067 ;; At a plain list, with a double C-u argument, set
21068 ;; checkboxes of each item to "[-]", whereas a single one
21069 ;; will toggle their presence according to the state of the
21070 ;; first item in the list. Without an argument, repair the
21072 (let* ((begin (org-element-property :contents-begin context))
21073 (beginm (move-marker (make-marker) begin))
21074 (struct (org-element-property :structure context))
21075 (old-struct (copy-tree struct))
21076 (first-box (save-excursion
21078 (looking-at org-list-full-item-re)
21079 (match-string-no-properties 3)))
21080 (new-box (cond ((equal arg '(16)) "[-]")
21081 ((equal arg '(4)) (unless first-box "[ ]"))
21082 ((equal first-box "[X]") "[ ]")
21086 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21087 (org-list-get-all-items
21088 begin struct (org-list-prevs-alist struct))))
21089 ((and first-box (eq (point) begin))
21090 ;; For convenience, when point is at bol on the first
21091 ;; item of the list and no argument is provided, simply
21092 ;; toggle checkbox of that item, if any.
21093 (org-list-set-checkbox begin struct new-box)))
21094 (org-list-write-struct
21095 struct (org-list-parents-alist struct) old-struct)
21096 (org-update-checkbox-count-maybe)
21097 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21098 ((property-drawer node-property)
21099 (call-interactively 'org-property-action))
21100 ((radio-target target)
21101 (call-interactively 'org-update-radio-target-regexp))
21103 (call-interactively 'org-update-statistics-cookies))
21104 ((table table-cell table-row)
21105 ;; At a table, recalculate every field and align it. Also
21106 ;; send the table if necessary. If the table has
21107 ;; a `table.el' type, just give up. At a table row or
21108 ;; cell, maybe recalculate line but always align table.
21109 (if (eq (org-element-property :type context) 'table.el)
21110 (message "Use C-c ' to edit table.el tables")
21111 (let ((org-enable-table-editor t))
21112 (if (or (eq type 'table)
21113 ;; Check if point is at a TBLFM line.
21114 (and (eq type 'table-row)
21115 (= (point) (org-element-property :end context))))
21117 (if (org-at-TBLFM-p)
21118 (progn (require 'org-table)
21119 (org-table-calc-current-TBLFM))
21120 (goto-char (org-element-property :contents-begin context))
21121 (org-call-with-arg 'org-table-recalculate (or arg t))
21122 (orgtbl-send-table 'maybe)))
21123 (org-table-maybe-eval-formula)
21124 (cond (arg (call-interactively 'org-table-recalculate))
21125 ((org-table-maybe-recalculate-line))
21126 (t (org-table-align)))))))
21127 (timestamp (org-timestamp-change 0 'day))
21129 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21131 "C-c C-c can do nothing useful at this location")))))))))
21133 (defun org-mode-restart ()
21135 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21136 (funcall major-mode)
21137 (hack-local-variables)
21138 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21139 (org-indent-mode -1)))
21140 (message "%s restarted" major-mode))
21142 (defun org-kill-note-or-show-branches ()
21143 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21145 (if (not org-finish-function)
21148 (call-interactively 'show-branches))
21149 (let ((org-note-abort t))
21150 (funcall org-finish-function))))
21152 (defun org-delete-indentation (&optional ARG)
21153 "Join current line to previous and fix whitespace at join.
21155 If previous line is a headline add to headline title. Otherwise
21156 the function calls `delete-indentation'.
21158 With argument, join this line to following line."
21160 (if (save-excursion
21161 (if ARG (beginning-of-line)
21163 (looking-at org-complex-heading-regexp))
21165 (let ((tags-column (when (match-beginning 5)
21166 (save-excursion (goto-char (match-beginning 5))
21167 (current-column))))
21168 (string (concat " " (progn (when ARG (forward-line 1))
21169 (org-trim (delete-and-extract-region
21170 (line-beginning-position)
21171 (line-end-position)))))))
21172 (unless (bobp) (delete-region (point) (1- (point))))
21173 (goto-char (or (match-end 4)
21174 (match-beginning 5)
21176 (skip-chars-backward " \t")
21177 (save-excursion (insert string))
21178 ;; Adjust alignment of tags.
21180 (org-align-tags-here (if org-auto-align-tags
21183 (delete-indentation ARG)))
21185 (defun org-open-line (n)
21186 "Insert a new row in tables, call `open-line' elsewhere.
21187 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21190 ((not org-special-ctrl-o)
21193 (org-table-insert-row))
21197 (defun org-return (&optional indent)
21198 "Goto next table row or insert a newline.
21200 Calls `org-table-next-row' or `newline', depending on context.
21202 When optional INDENT argument is non-nil, call
21203 `newline-and-indent' instead of `newline'.
21205 When `org-return-follows-link' is non-nil and point is on
21206 a timestamp or a link, call `org-open-at-point'. However, it
21207 will not happen if point is in a table or on a \"dead\"
21208 object (e.g., within a comment). In these case, you need to use
21209 `org-open-at-point' directly."
21211 (if (and (not (bolp))
21212 (save-excursion (beginning-of-line)
21213 (looking-at org-complex-heading-regexp)))
21215 (let ((tags-column (when (match-beginning 5)
21216 (save-excursion (goto-char (match-beginning 5))
21217 (current-column))))
21218 ;; Test if before or after headline title.
21219 (string (when (and (match-end 4)
21220 (not (or (< (point)
21224 (goto-char (match-beginning 4))
21225 (skip-chars-backward " \t")
21227 (and (match-beginning 5)
21228 (>= (point) (match-beginning 5))))))
21229 ;; Point is on headline keywords, tags or cookies. Do not break
21230 ;; them: add a newline after the headline instead.
21232 (delete-and-extract-region (point) (match-end 4))))))
21233 ;; Adjust alignment of tags.
21234 (when (and tags-column string)
21235 (org-align-tags-here (if org-auto-align-tags
21240 (if indent (newline-and-indent) (newline))
21241 (and string (save-excursion (insert (org-trim string)))))
21242 (let* ((context (if org-return-follows-link (org-element-context)
21243 (org-element-at-point)))
21244 (type (org-element-type context)))
21246 ;; In a table, call `org-table-next-row'.
21247 ((or (and (eq type 'table)
21248 (>= (point) (org-element-property :contents-begin context))
21249 (< (point) (org-element-property :contents-end context)))
21250 (org-element-lineage context '(table-row table-cell) t))
21251 (org-table-justify-field-maybe)
21252 (call-interactively #'org-table-next-row))
21253 ;; On a link or a timestamp but not on white spaces after it,
21254 ;; call `org-open-line' if `org-return-follows-link' allows it.
21255 ((and org-return-follows-link
21256 (memq type '(link timestamp))
21258 (save-excursion (goto-char (org-element-property :end context))
21259 (skip-chars-backward " \t")
21261 (call-interactively #'org-open-at-point))
21262 ;; In a list, make sure indenting keeps trailing text within.
21265 (org-element-lineage context '(item)))
21266 (let ((trailing-data
21267 (delete-and-extract-region (point) (line-end-position))))
21268 (newline-and-indent)
21269 (save-excursion (insert trailing-data))))
21270 (t (if indent (newline-and-indent) (newline)))))))
21272 (defun org-return-indent ()
21273 "Goto next table row or insert a newline and indent.
21274 Calls `org-table-next-row' or `newline-and-indent', depending on
21275 context. See the individual commands for more information."
21279 (defun org-ctrl-c-star ()
21280 "Compute table, or change heading status of lines.
21281 Calls `org-table-recalculate' or `org-toggle-heading',
21282 depending on context."
21286 (call-interactively 'org-table-recalculate))
21288 ;; Convert all lines in region to list items
21289 (call-interactively 'org-toggle-heading))))
21291 (defun org-ctrl-c-minus ()
21292 "Insert separator line in table or modify bullet status of line.
21293 Also turns a plain line or a region of lines into list items.
21294 Calls `org-table-insert-hline', `org-toggle-item', or
21295 `org-cycle-list-bullet', depending on context."
21299 (call-interactively 'org-table-insert-hline))
21300 ((org-region-active-p)
21301 (call-interactively 'org-toggle-item))
21303 (call-interactively 'org-cycle-list-bullet))
21305 (call-interactively 'org-toggle-item))))
21307 (defun org-toggle-item (arg)
21308 "Convert headings or normal lines to items, items to normal lines.
21309 If there is no active region, only the current line is considered.
21311 If the first non blank line in the region is a headline, convert
21312 all headlines to items, shifting text accordingly.
21314 If it is an item, convert all items to normal lines.
21316 If it is normal text, change region into a list of items.
21317 With a prefix argument ARG, change the region in a single item."
21321 ;; Shift text in current section to IND, from point to END.
21322 ;; The function leaves point to END line.
21324 (let ((min-i 1000) (end (copy-marker end)))
21325 ;; First determine the minimum indentation (MIN-I) of
21329 (while (< (point) end)
21330 (let ((i (org-get-indentation)))
21332 ;; Skip blank lines and inline tasks.
21333 ((looking-at "^[ \t]*$"))
21334 ((looking-at org-outline-regexp-bol))
21335 ;; We can't find less than 0 indentation.
21336 ((zerop i) (throw 'exit (setq min-i 0)))
21337 ((< i min-i) (setq min-i i))))
21339 ;; Then indent each line so that a line indented to
21340 ;; MIN-I becomes indented to IND. Ignore blank lines
21341 ;; and inline tasks in the process.
21342 (let ((delta (- ind min-i)))
21343 (while (< (point) end)
21344 (unless (or (looking-at "^[ \t]*$")
21345 (looking-at org-outline-regexp-bol))
21346 (org-indent-line-to (+ (org-get-indentation) delta)))
21347 (forward-line)))))))
21350 ;; Return beginning of first non-blank line, starting from
21355 (skip-chars-forward " \r\t\n")
21358 ;; Determine boundaries of changes.
21359 (if (org-region-active-p)
21360 (setq beg (funcall skip-blanks (region-beginning))
21361 end (copy-marker (region-end)))
21362 (setq beg (funcall skip-blanks (point-at-bol))
21363 end (copy-marker (point-at-eol))))
21364 ;; Depending on the starting line, choose an action on the text
21365 ;; between BEG and END.
21366 (org-with-limited-levels
21370 ;; Case 1. Start at an item: de-itemize. Note that it only
21371 ;; happens when a region is active: `org-ctrl-c-minus'
21372 ;; would call `org-cycle-list-bullet' otherwise.
21374 (while (< (point) end)
21375 (when (org-at-item-p)
21376 (skip-chars-forward " \t")
21377 (delete-region (point) (match-end 0)))
21379 ;; Case 2. Start at an heading: convert to items.
21380 ((org-at-heading-p)
21381 (let* ((bul (org-list-bullet-string "-"))
21382 (bul-len (length bul))
21383 (done (org-entry-is-done-p))
21384 (todo (org-entry-is-todo-p))
21385 ;; Indentation of the first heading. It should be
21386 ;; relative to the indentation of its parent, if any.
21387 (start-ind (save-excursion
21389 ((not org-adapt-indentation) 0)
21390 ((not (outline-previous-heading)) 0)
21391 (t (length (match-string 0))))))
21392 ;; Level of first heading. Further headings will be
21393 ;; compared to it to determine hierarchy in the list.
21394 (ref-level (org-reduced-level (org-outline-level))))
21395 (when (or done todo) (org-todo ""))
21396 (while (< (point) end)
21397 (let* ((level (org-reduced-level (org-outline-level)))
21398 (delta (max 0 (- level ref-level))))
21399 ;; If current headline is less indented than the first
21400 ;; one, set it as reference, in order to preserve
21402 (when (< level ref-level) (setq ref-level level))
21403 (replace-match bul t t)
21404 (org-indent-line-to (+ start-ind (* delta bul-len)))
21405 (when (or done todo)
21406 (let* ((struct (org-list-struct))
21407 (old (copy-tree struct)))
21408 (org-list-set-checkbox (line-beginning-position)
21410 (if done "[X]" "[ ]"))
21411 (org-list-write-struct struct
21412 (org-list-parents-alist struct)
21414 ;; Ensure all text down to END (or SECTION-END) belongs
21415 ;; to the newly created item.
21416 (let ((section-end (save-excursion
21417 (or (outline-next-heading) (point)))))
21419 (funcall shift-text
21420 (+ start-ind (* (1+ delta) bul-len))
21421 (min end section-end)))))))
21422 ;; Case 3. Normal line with ARG: make the first line of region
21423 ;; an item, and shift indentation of others lines to
21424 ;; set them as item's body.
21425 (arg (let* ((bul (org-list-bullet-string "-"))
21426 (bul-len (length bul))
21427 (ref-ind (org-get-indentation)))
21428 (skip-chars-forward " \t")
21431 (while (< (point) end)
21432 ;; Ensure that lines less indented than first one
21433 ;; still get included in item body.
21434 (funcall shift-text
21435 (+ ref-ind bul-len)
21436 (min end (save-excursion (or (outline-next-heading)
21439 ;; Case 4. Normal line without ARG: turn each non-item line
21442 (while (< (point) end)
21443 (unless (or (org-at-heading-p) (org-at-item-p))
21444 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21446 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21447 (forward-line))))))))
21449 (defun org-toggle-heading (&optional nstars)
21450 "Convert headings to normal text, or items or text to headings.
21451 If there is no active region, only convert the current line.
21453 With a \\[universal-argument] prefix, convert the whole list at
21454 point into heading.
21458 - If the first non blank line is a headline, remove the stars
21459 from all headlines in the region.
21461 - If it is a normal line, turn each and every normal line (i.e.,
21462 not an heading or an item) in the region into headings. If you
21463 want to convert only the first line of this region, use one
21464 universal prefix argument.
21466 - If it is a plain list item, turn all plain list items into headings.
21468 When converting a line into a heading, the number of stars is chosen
21469 such that the lines become children of the current entry. However,
21470 when a numeric prefix argument is given, its value determines the
21471 number of stars to add."
21475 ;; Return beginning of first non-blank line, starting from
21480 (while (org-at-comment-p) (forward-line))
21481 (skip-chars-forward " \r\t\n")
21484 ;; Determine boundaries of changes. If a universal prefix has
21485 ;; been given, put the list in a region. If region ends at a bol,
21486 ;; do not consider the last line to be in the region.
21488 (when (and current-prefix-arg (org-at-item-p))
21489 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21490 (org-mark-element))
21492 (if (org-region-active-p)
21493 (setq beg (funcall skip-blanks (region-beginning))
21494 end (copy-marker (save-excursion
21495 (goto-char (region-end))
21496 (if (bolp) (point) (point-at-eol)))))
21497 (setq beg (funcall skip-blanks (point-at-bol))
21498 end (copy-marker (point-at-eol))))
21499 ;; Ensure inline tasks don't count as headings.
21500 (org-with-limited-levels
21504 ;; Case 1. Started at an heading: de-star headings.
21505 ((org-at-heading-p)
21506 (while (< (point) end)
21507 (when (org-at-heading-p t)
21508 (looking-at org-outline-regexp) (replace-match "")
21511 ;; Case 2. Started at an item: change items into headlines.
21512 ;; One star will be added by `org-list-to-subtree'.
21514 (while (< (point) end)
21515 (when (org-at-item-p)
21516 ;; Pay attention to cases when region ends before list.
21517 (let* ((struct (org-list-struct))
21518 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21520 (narrow-to-region (point) list-end)
21521 (insert (org-list-to-subtree (org-list-parse-list t)))))
21524 ;; Case 3. Started at normal text: make every line an heading,
21525 ;; skipping headlines and items.
21528 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21530 (cond (nstars "") ; stars from prefix only
21531 ((equal stars "") "*") ; before first heading
21532 (org-odd-levels-only "**") ; inside heading, odd
21533 (t "*"))) ; inside heading, oddeven
21534 (rpl (concat stars add-stars " "))
21535 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21536 (while (< (point) (if (equal nstars '(4)) lend end))
21537 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21538 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21539 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21540 (forward-line)))))))
21541 (unless toggled (message "Cannot toggle heading from here"))))
21543 (defun org-meta-return (&optional arg)
21544 "Insert a new heading or wrap a region in a table.
21545 Calls `org-insert-heading' or `org-table-wrap-region', depending
21546 on context. See the individual commands for more information."
21548 (org-check-before-invisible-edit 'insert)
21549 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21550 (let* ((element (org-element-at-point))
21551 (type (org-element-type element)))
21552 (when (eq type 'table-row)
21553 (setq element (org-element-property :parent element))
21554 (setq type 'table))
21555 (if (and (eq type 'table)
21556 (eq (org-element-property :type element) 'org)
21557 (>= (point) (org-element-property :contents-begin element))
21558 (< (point) (org-element-property :contents-end element)))
21559 (call-interactively 'org-table-wrap-region)
21560 (call-interactively 'org-insert-heading)))))
21564 (defsubst org-in-subtree-not-table-p ()
21565 "Are we in a subtree and not in a table?"
21566 (and (not (org-before-first-heading-p))
21567 (not (org-at-table-p))))
21569 ;; Define the Org-mode menus
21570 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21572 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21573 ["Next Field" org-cycle (org-at-table-p)]
21574 ["Previous Field" org-shifttab (org-at-table-p)]
21575 ["Next Row" org-return (org-at-table-p)]
21577 ["Blank Field" org-table-blank-field (org-at-table-p)]
21578 ["Edit Field" org-table-edit-field (org-at-table-p)]
21579 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21582 ["Move Column Left" org-metaleft (org-at-table-p)]
21583 ["Move Column Right" org-metaright (org-at-table-p)]
21584 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21585 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21587 ["Move Row Up" org-metaup (org-at-table-p)]
21588 ["Move Row Down" org-metadown (org-at-table-p)]
21589 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21590 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21591 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21593 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21595 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21596 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21597 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21598 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21601 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21602 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21603 ["Edit Formulas" org-edit-special (org-at-table-p)]
21605 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21606 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21607 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21609 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21611 ["Sum Column/Rectangle" org-table-sum
21612 (or (org-at-table-p) (org-region-active-p))]
21613 ["Which Column?" org-table-current-column (org-at-table-p)])
21615 org-table-toggle-formula-debugger
21616 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21617 ["Show Col/Row Numbers"
21618 org-table-toggle-coordinate-overlays
21620 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21622 ["Create" org-table-create (and (not (org-at-table-p))
21623 org-enable-table-editor)]
21624 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21625 ["Import from File" org-table-import (not (org-at-table-p))]
21626 ["Export to File" org-table-export (org-at-table-p)]
21628 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21631 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21632 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21634 (easy-menu-define org-org-menu org-mode-map "Org menu"
21637 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21638 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21639 ["Sparse Tree..." org-sparse-tree t]
21640 ["Reveal Context" org-reveal t]
21641 ["Show All" show-all t]
21643 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21645 ["New Heading" org-insert-heading t]
21646 ("Navigate Headings"
21647 ["Up" outline-up-heading t]
21648 ["Next" outline-next-visible-heading t]
21649 ["Previous" outline-previous-visible-heading t]
21650 ["Next Same Level" outline-forward-same-level t]
21651 ["Previous Same Level" outline-backward-same-level t]
21653 ["Jump" org-goto t])
21655 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21657 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21658 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21660 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21661 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21662 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21664 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21666 ["Copy visible text" org-copy-visible t]
21668 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21669 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21670 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21671 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21673 ["Sort Region/Children" org-sort t]
21675 ["Convert to odd levels" org-convert-to-odd-levels t]
21676 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21678 ["Emphasis..." org-emphasize t]
21679 ["Edit Source Example" org-edit-special t]
21681 ["Footnote new/jump" org-footnote-action t]
21682 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21684 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21686 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21687 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21688 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21692 ["Store Link (Global)" org-store-link t]
21693 ["Find existing link to here" org-occur-link-in-agenda-files t]
21694 ["Insert Link" org-insert-link t]
21695 ["Follow Link" org-open-at-point t]
21697 ["Next link" org-next-link t]
21698 ["Previous link" org-previous-link t]
21700 ["Descriptive Links"
21701 org-toggle-link-display
21703 :selected org-descriptive-links
21706 org-toggle-link-display
21708 :selected (not org-descriptive-links)])
21711 ["TODO/DONE/-" org-todo t]
21713 ["Next keyword" org-shiftright (org-at-heading-p)]
21714 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21715 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21716 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21717 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21718 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21719 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21721 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21722 :selected org-enforce-todo-dependencies :style toggle :active t]
21723 "Settings for tree at point"
21724 ["Do Children sequentially" org-toggle-ordered-property :style radio
21725 :selected (org-entry-get nil "ORDERED")
21726 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21727 ["Do Children parallel" org-toggle-ordered-property :style radio
21728 :selected (not (org-entry-get nil "ORDERED"))
21729 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21731 ["Set Priority" org-priority t]
21732 ["Priority Up" org-shiftup t]
21733 ["Priority Down" org-shiftdown t]
21735 ["Get news from all feeds" org-feed-update-all t]
21736 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21737 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21738 ("TAGS and Properties"
21739 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21740 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21742 ["Set property" org-set-property (not (org-before-first-heading-p))]
21743 ["Column view of properties" org-columns t]
21744 ["Insert Column View DBlock" org-insert-columns-dblock t])
21745 ("Dates and Scheduling"
21746 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21747 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21749 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21750 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21751 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21752 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21753 ["Compute Time Range" org-evaluate-time-range t]
21754 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21755 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21757 ["Custom time format" org-toggle-time-stamp-overlays
21758 :style radio :selected org-display-custom-times]
21760 ["Goto Calendar" org-goto-calendar t]
21761 ["Date from Calendar" org-date-from-calendar t]
21763 ["Start/Restart Timer" org-timer-start t]
21764 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21765 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21766 ["Insert Timer String" org-timer t]
21767 ["Insert Timer Item" org-timer-item t])
21769 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21770 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21771 ["Clock out" org-clock-out t]
21772 ["Clock cancel" org-clock-cancel t]
21774 ["Mark as default task" org-clock-mark-default-task t]
21775 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21776 ["Goto running clock" org-clock-goto t]
21778 ["Display times" org-clock-display t]
21779 ["Create clock table" org-clock-report t]
21781 ["Record DONE time"
21782 (progn (setq org-log-done (not org-log-done))
21783 (message "Switching to %s will %s record a timestamp"
21784 (car org-done-keywords)
21785 (if org-log-done "automatically" "not")))
21786 :style toggle :selected org-log-done])
21788 ["Agenda Command..." org-agenda t]
21789 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21790 ("File List for Agenda")
21791 ("Special views current file"
21792 ["TODO Tree" org-show-todo-tree t]
21793 ["Check Deadlines" org-check-deadlines t]
21794 ["Timeline" org-timeline t]
21795 ["Tags/Property tree" org-match-sparse-tree t])
21797 ["Export/Publish..." org-export-dispatch t]
21799 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21800 :selected org-cdlatex-mode]
21801 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21802 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21803 ["Modify math symbol" org-cdlatex-math-modify
21804 (org-inside-LaTeX-fragment-p)]
21805 ["Insert citation" org-reftex-citation t]
21807 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21810 ["Push Files and Views" org-mobile-push t]
21811 ["Get Captured and Flagged" org-mobile-pull t]
21812 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21814 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21817 ["Show Version" org-version t]
21818 ["Info Documentation" org-info t])
21820 ["Browse Org Group" org-customize t]
21822 ["Expand This Menu" org-create-customize-menu
21823 (fboundp 'customize-menu-create)])
21824 ["Send bug report" org-submit-bug-report t]
21827 ["Refresh setup current buffer" org-mode-restart t]
21828 ["Reload Org (after update)" org-reload t]
21829 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21832 (defun org-info (&optional node)
21833 "Read documentation for Org-mode in the info system.
21834 With optional NODE, go directly to that node."
21836 (info (format "(org)%s" (or node ""))))
21839 (defun org-submit-bug-report ()
21840 "Submit a bug report on Org-mode via mail.
21842 Don't hesitate to report any problems or inaccurate documentation.
21844 If you don't have setup sending mail from (X)Emacs, please copy the
21845 output buffer into your mail program, as it gives us important
21846 information about your Org-mode version and configuration."
21848 (require 'reporter)
21849 (org-load-modules-maybe)
21850 (org-require-autoloaded-modules)
21851 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21852 (reporter-submit-bug-report
21853 "emacs-orgmode@gnu.org"
21854 (org-version nil 'full)
21856 (save-window-excursion
21857 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21858 (delete-other-windows)
21860 (insert "You are about to submit a bug report to the Org-mode mailing list.
21862 We would like to add your full Org-mode and Outline configuration to the
21863 bug report. This greatly simplifies the work of the maintainer and
21864 other experts on the mailing list.
21866 HOWEVER, some variables you have customized may contain private
21867 information. The names of customers, colleagues, or friends, might
21868 appear in the form of file names, tags, todo states, or search strings.
21869 If you answer yes to the prompt, you might want to check and remove
21870 such private information before sending the email.")
21871 (add-text-properties (point-min) (point-max) '(face org-warning))
21872 (when (yes-or-no-p "Include your Org-mode configuration ")
21876 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21877 (or (and (symbol-value v)
21878 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21880 (get v 'custom-type) (get v 'standard-value)
21881 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21883 (kill-buffer (get-buffer "*Warn about privacy*"))
21886 "Remember to cover the basics, that is, what you expected to happen and
21887 what in fact did happen. You don't know how to make a good report? See
21889 http://orgmode.org/manual/Feedback.html#Feedback
21891 Your bug report will be posted to the Org-mode mailing list.
21892 ------------------------------------------------------------------------")
21894 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21895 (replace-match "\\1Bug: \\3 [\\2]")))))
21898 (defun org-install-agenda-files-menu ()
21899 (let ((bl (buffer-list)))
21902 (set-buffer (pop bl))
21903 (if (derived-mode-p 'org-mode) (setq bl nil)))
21904 (when (derived-mode-p 'org-mode)
21906 '("Org") "File List for Agenda"
21909 ["Edit File List" (org-edit-agenda-file-list) t]
21910 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21911 ["Remove Current File from List" org-remove-file t]
21912 ["Cycle through agenda files" org-cycle-agenda-files t]
21913 ["Occur in all agenda files" org-occur-in-agenda-files t]
21915 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21919 (defun org-require-autoloaded-modules ()
21922 '(org-agenda org-archive org-attach org-clock org-colview org-id
21923 org-table org-timer)))
21926 (defun org-reload (&optional uncompiled)
21927 "Reload all org lisp files.
21928 With prefix arg UNCOMPILED, load the uncompiled versions."
21930 (require 'loadhist)
21931 (let* ((org-dir (org-find-library-dir "org"))
21932 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21933 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21934 (remove-re (mapconcat 'identity
21935 (mapcar (lambda (f) (concat "^" f "$"))
21936 (list (if (featurep 'xemacs)
21938 "org-colview-xemacs")
21939 "org" "org-loaddefs" "org-version"))
21941 (feats (delete-dups
21942 (mapcar 'file-name-sans-extension
21943 (mapcar 'file-name-nondirectory
21945 (mapcar 'feature-file
21952 (if (and (string-match feature-re f)
21953 (not (string-match remove-re f)))
21957 (list "org-version" "org")))
21958 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21959 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21960 load-uncore load-misses)
21963 (mapcar (lambda (f)
21964 (or (org-load-noerror-mustsuffix (concat org-dir f))
21965 (and (string= org-dir contrib-dir)
21966 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21967 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21968 (add-to-list 'load-uncore f 'append)
21973 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21974 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21976 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21977 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21978 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21981 (defun org-customize ()
21982 "Call the customize function with org as argument."
21984 (org-load-modules-maybe)
21985 (org-require-autoloaded-modules)
21986 (customize-browse 'org))
21988 (defun org-create-customize-menu ()
21989 "Create a full customization menu for Org-mode, insert it into the menu."
21991 (org-load-modules-maybe)
21992 (org-require-autoloaded-modules)
21993 (if (fboundp 'customize-menu-create)
21996 '("Org") "Customize"
21997 `(["Browse Org group" org-customize t]
21999 ,(customize-menu-create 'org)
22000 ["Set" Custom-set t]
22001 ["Save" Custom-save t]
22002 ["Reset to Current" Custom-reset-current t]
22003 ["Reset to Saved" Custom-reset-saved t]
22004 ["Reset to Standard Settings" Custom-reset-standard t]))
22005 (message "\"Org\"-menu now contains full customization menu"))
22006 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22008 ;;;; Miscellaneous stuff
22010 ;;; Generally useful functions
22012 (defsubst org-get-at-eol (property n)
22013 "Get text property PROPERTY at the end of line less N characters."
22014 (get-text-property (- (point-at-eol) n) property))
22016 (defun org-find-text-property-in-string (prop s)
22017 "Return the first non-nil value of property PROP in string S."
22018 (or (get-text-property 0 prop s)
22019 (get-text-property (or (next-single-property-change 0 prop s) 0)
22022 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22023 "Display the given MESSAGE as a warning."
22024 (if (fboundp 'display-warning)
22025 (display-warning 'org message
22026 (if (featurep 'xemacs) 'warning :warning))
22027 (let ((buf (get-buffer-create "*Org warnings*")))
22028 (with-current-buffer buf
22029 (goto-char (point-max))
22030 (insert "Warning (Org): " message)
22033 (display-buffer buf)
22036 (defun org-eval (form)
22037 "Eval FORM and return result."
22038 (condition-case error
22040 (error (format "%%![Error: %s]" error))))
22042 (defun org-in-clocktable-p ()
22043 "Check if the cursor is in a clocktable."
22044 (let ((pos (point)) start)
22047 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22048 (setq start (match-beginning 0))
22049 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22050 (>= (match-end 0) pos)
22053 (defun org-in-verbatim-emphasis ()
22055 (and (org-in-regexp org-emph-re 2)
22056 (>= (point) (match-beginning 3))
22057 (<= (point) (match-end 4))
22058 (member (match-string 3) '("=" "~")))))
22060 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22061 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22062 (if (and marker (marker-buffer marker)
22063 (buffer-live-p (marker-buffer marker)))
22065 (org-pop-to-buffer-same-window (marker-buffer marker))
22066 (if (or (> marker (point-max)) (< marker (point-min)))
22069 (org-show-context 'org-goto))
22071 (bookmark-jump bookmark)
22072 (error "Cannot find location"))))
22074 (defun org-quote-csv-field (s)
22075 "Quote field for inclusion in CSV material."
22076 (if (string-match "[\",]" s)
22077 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22080 (defun org-force-self-insert (N)
22081 "Needed to enforce self-insert under remapping."
22083 (self-insert-command N))
22085 (defun org-string-width (s)
22086 "Compute width of string, ignoring invisible characters.
22087 This ignores character with invisibility property `org-link', and also
22088 characters with property `org-cwidth', because these will become invisible
22089 upon the next fontification round."
22091 (when (or (eq t buffer-invisibility-spec)
22092 (assq 'org-link buffer-invisibility-spec))
22093 (while (setq b (text-property-any 0 (length s)
22094 'invisible 'org-link s))
22095 (setq s (concat (substring s 0 b)
22096 (substring s (or (next-single-property-change
22097 b 'invisible s) (length s)))))))
22098 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22099 (setq s (concat (substring s 0 b)
22100 (substring s (or (next-single-property-change
22101 b 'org-cwidth s) (length s))))))
22102 (setq l (string-width s) b -1)
22103 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22104 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22107 (defun org-shorten-string (s maxlength)
22108 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22109 If the string is shorter or has length MAXLENGTH, just return the
22110 original string. If it is longer, the functions finds a space in the
22111 string, breaks this string off at that locations and adds three dots
22112 as ellipsis. Including the ellipsis, the string will not be longer
22113 than MAXLENGTH. If finding a good breaking point in the string does
22114 not work, the string is just chopped off in the middle of a word
22116 (if (<= (length s) maxlength)
22118 (let* ((n (max (- maxlength 4) 1))
22119 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22120 (if (string-match re s)
22121 (concat (match-string 1 s) "...")
22122 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22124 (defun org-get-indentation (&optional line)
22125 "Get the indentation of the current line, interpreting tabs.
22126 When LINE is given, assume it represents a line and compute its indentation."
22128 (if (string-match "^ *" (org-remove-tabs line))
22131 (beginning-of-line 1)
22132 (skip-chars-forward " \t")
22133 (current-column))))
22135 (defun org-get-string-indentation (s)
22136 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22137 (let ((n -1) (i 0) (w tab-width) c)
22139 (while (< (setq n (1+ n)) (length s))
22140 (setq c (aref s n))
22141 (cond ((= c ?\ ) (setq i (1+ i)))
22142 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22143 (t (throw 'exit t)))))
22146 (defun org-remove-tabs (s &optional width)
22147 "Replace tabulators in S with spaces.
22148 Assumes that s is a single line, starting in column 0."
22149 (setq width (or width tab-width))
22150 (while (string-match "\t" s)
22151 (setq s (replace-match
22153 (- (* width (/ (+ (match-beginning 0) width) width))
22154 (match-beginning 0)) ?\ )
22158 (defun org-fix-indentation (line ind)
22159 "Fix indentation in LINE.
22160 IND is a cons cell with target and minimum indentation.
22161 If the current indentation in LINE is smaller than the minimum,
22162 leave it alone. If it is larger than ind, set it to the target."
22163 (let* ((l (org-remove-tabs line))
22164 (i (org-get-indentation l))
22165 (i1 (car ind)) (i2 (cdr ind)))
22166 (if (>= i i2) (setq l (substring line i2)))
22168 (concat (make-string i1 ?\ ) l)
22171 (defun org-remove-indentation (code &optional n)
22172 "Remove the maximum common indentation from the lines in CODE.
22173 N may optionally be the number of spaces to remove."
22176 (org-do-remove-indentation n)
22179 (defun org-do-remove-indentation (&optional n)
22180 "Remove the maximum common indentation from the buffer."
22181 (untabify (point-min) (point-max))
22182 (let ((min 10000) re)
22185 (goto-char (point-min))
22186 (while (re-search-forward "^ *[^ \n]" nil t)
22187 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22188 (unless (or (= min 0) (= min 10000))
22189 (setq re (format "^ \\{%d\\}" min))
22190 (goto-char (point-min))
22191 (while (re-search-forward re nil t)
22196 (defun org-fill-template (template alist)
22197 "Find each %key of ALIST in TEMPLATE and replace it."
22198 (let ((case-fold-search nil)
22200 (setq alist (sort (copy-sequence alist)
22201 (lambda (a b) (< (length (car a)) (length (car b))))))
22202 (while (setq entry (pop alist))
22204 (replace-regexp-in-string
22205 (concat "%" (regexp-quote (car entry)))
22206 (or (cdr entry) "") template t t)))
22209 (defun org-base-buffer (buffer)
22210 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22213 (or (buffer-base-buffer buffer)
22216 (defun org-wrap (string &optional width lines)
22217 "Wrap string to either a number of lines, or a width in characters.
22218 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22219 that costs. If there is a word longer than WIDTH, the text is actually
22220 wrapped to the length of that word.
22221 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22222 many lines, whatever width that takes.
22223 The return value is a list of lines, without newlines at the end."
22224 (let* ((words (org-split-string string "[ \t\n]+"))
22225 (maxword (apply 'max (mapcar 'org-string-width words)))
22228 (org-do-wrap words (max maxword width)))
22231 (setq ll (org-do-wrap words maxword))
22232 (if (<= (length ll) lines)
22235 (while (> (length ll) lines)
22237 (setq ll (org-do-wrap words w)))
22239 (t (error "Cannot wrap this")))))
22241 (defun org-do-wrap (words width)
22242 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22245 (setq line (pop words))
22246 (while (and words (< (+ (length line) (length (car words))) width))
22247 (setq line (concat line " " (pop words))))
22248 (setq lines (push line lines)))
22251 (defun org-split-string (string &optional separators)
22252 "Splits STRING into substrings at SEPARATORS.
22253 No empty strings are returned if there are matches at the beginning
22254 and end of string."
22255 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
22259 (while (and (string-match rexp string
22261 (= start (match-beginning 0))
22262 (< start (length string)))
22264 (< (match-beginning 0) (length string)))
22266 (or (eq (match-beginning 0) 0)
22267 (and (eq (match-beginning 0) (match-end 0))
22268 (eq (match-beginning 0) start))
22270 (cons (substring string start (match-beginning 0))
22272 (setq start (match-end 0)))
22273 (or (eq start (length string))
22275 (cons (substring string start)
22279 (defun org-quote-vert (s)
22280 "Replace \"|\" with \"\\vert\"."
22281 (while (string-match "|" s)
22282 (setq s (replace-match "\\vert" t t s)))
22285 (defun org-uuidgen-p (s)
22286 "Is S an ID created by UUIDGEN?"
22287 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22289 (defun org-in-src-block-p (&optional inside)
22290 "Whether point is in a code source block.
22291 When INSIDE is non-nil, don't consider we are within a src block
22292 when point is at #+BEGIN_SRC or #+END_SRC."
22293 (let ((case-fold-search t) ov)
22294 (or (and (eq (get-char-property (point) 'src-block) t))
22298 (beginning-of-line)
22299 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22301 (defun org-context ()
22302 "Return a list of contexts of the current cursor position.
22303 If several contexts apply, all are returned.
22304 Each context entry is a list with a symbol naming the context, and
22305 two positions indicating start and end of the context. Possible
22308 :headline anywhere in a headline
22309 :headline-stars on the leading stars in a headline
22310 :todo-keyword on a TODO keyword (including DONE) in a headline
22311 :tags on the TAGS in a headline
22312 :priority on the priority cookie in a headline
22313 :item on the first line of a plain list item
22314 :item-bullet on the bullet/number of a plain list item
22315 :checkbox on the checkbox in a plain list item
22316 :table in an org-mode table
22317 :table-special on a special filed in a table
22318 :table-table in a table.el table
22319 :clocktable in a clocktable
22320 :src-block in a source block
22321 :link on a hyperlink
22322 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22323 :target on a <<target>>
22324 :radio-target on a <<<radio-target>>>
22325 :latex-fragment on a LaTeX fragment
22326 :latex-preview on a LaTeX fragment with overlaid preview image
22328 This function expects the position to be visible because it uses font-lock
22329 faces as a help to recognize the following contexts: :table-special, :link,
22331 (let* ((f (get-text-property (point) 'face))
22332 (faces (if (listp f) f (list f)))
22333 (case-fold-search t)
22334 (p (point)) clist o)
22335 ;; First the large context
22337 ((org-at-heading-p t)
22338 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22340 (beginning-of-line 1)
22341 (looking-at org-todo-line-tags-regexp))
22342 (push (org-point-in-group p 1 :headline-stars) clist)
22343 (push (org-point-in-group p 2 :todo-keyword) clist)
22344 (push (org-point-in-group p 4 :tags) clist))
22346 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22347 (if (looking-at "\\[#[A-Z0-9]\\]")
22348 (push (org-point-in-group p 0 :priority) clist)))
22351 (push (org-point-in-group p 2 :item-bullet) clist)
22352 (push (list :item (point-at-bol)
22353 (save-excursion (org-end-of-item) (point)))
22355 (and (org-at-item-checkbox-p)
22356 (push (org-point-in-group p 0 :checkbox) clist)))
22359 (push (list :table (org-table-begin) (org-table-end)) clist)
22360 (if (memq 'org-formula faces)
22361 (push (list :table-special
22362 (previous-single-property-change p 'face)
22363 (next-single-property-change p 'face)) clist)))
22364 ((org-at-table-p 'any)
22365 (push (list :table-table) clist)))
22368 (let ((case-fold-search t))
22369 ;; New the "medium" contexts: clocktables, source blocks
22370 (cond ((org-in-clocktable-p)
22371 (push (list :clocktable
22372 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22373 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22374 (match-beginning 1))
22375 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22376 (match-end 0))) clist))
22377 ((org-in-src-block-p)
22378 (push (list :src-block
22379 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22380 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22381 (match-beginning 1))
22382 (and (search-forward "#+END_SRC" nil t)
22383 (match-beginning 0))) clist))))
22386 ;; Now the small context
22388 ((org-at-timestamp-p)
22389 (push (org-point-in-group p 0 :timestamp) clist))
22390 ((memq 'org-link faces)
22392 (previous-single-property-change p 'face)
22393 (next-single-property-change p 'face)) clist))
22394 ((memq 'org-special-keyword faces)
22395 (push (list :keyword
22396 (previous-single-property-change p 'face)
22397 (next-single-property-change p 'face)) clist))
22399 (push (org-point-in-group p 0 :target) clist)
22400 (goto-char (1- (match-beginning 0)))
22401 (if (looking-at org-radio-target-regexp)
22402 (push (org-point-in-group p 0 :radio-target) clist))
22404 ((setq o (car (delq nil
22407 (if (memq x org-latex-fragment-image-overlays) x))
22408 (overlays-at (point))))))
22409 (push (list :latex-fragment
22410 (overlay-start o) (overlay-end o)) clist)
22411 (push (list :latex-preview
22412 (overlay-start o) (overlay-end o)) clist))
22413 ((org-inside-LaTeX-fragment-p)
22414 ;; FIXME: positions wrong.
22415 (push (list :latex-fragment (point) (point)) clist)))
22417 (setq clist (nreverse (delq nil clist)))
22420 (defun org-in-regexp (re &optional nlines visually)
22421 "Check if point is inside a match of RE.
22423 Normally only the current line is checked, but you can include
22424 NLINES extra lines after point into the search. If VISUALLY is
22425 set, require that the cursor is not after the match but really
22426 on, so that the block visually is on the match."
22428 (let ((pos (point))
22429 (eol (point-at-eol (+ 1 (or nlines 0))))
22430 (inc (if visually 1 0)))
22432 (beginning-of-line (- 1 (or nlines 0)))
22433 (while (re-search-forward re eol t)
22434 (if (and (<= (match-beginning 0) pos)
22435 (>= (+ inc (match-end 0)) pos))
22436 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22437 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22440 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22441 "Non-nil when point is between matches of START-RE and END-RE.
22443 Also return a non-nil value when point is on one of the matches.
22445 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22446 buffer positions. Default values are the positions of headlines
22447 surrounding the point.
22449 The functions returns a cons cell whose car (resp. cdr) is the
22450 position before START-RE (resp. after END-RE)."
22452 (let ((pos (point))
22453 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22454 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22457 ;; Point is on a block when on START-RE or if START-RE can be
22458 ;; found before it...
22459 (and (or (org-in-regexp start-re)
22460 (re-search-backward start-re limit-up t))
22461 (setq beg (match-beginning 0))
22462 ;; ... and END-RE after it...
22463 (goto-char (match-end 0))
22464 (re-search-forward end-re limit-down t)
22465 (> (setq end (match-end 0)) pos)
22466 ;; ... without another START-RE in-between.
22467 (goto-char (match-beginning 0))
22468 (not (re-search-backward start-re (1+ beg) t))
22470 (cons beg end))))))
22472 (defun org-in-block-p (names)
22473 "Non-nil when point belongs to a block whose name belongs to NAMES.
22475 NAMES is a list of strings containing names of blocks.
22477 Return first block name matched, or nil. Beware that in case of
22478 nested blocks, the returned name may not belong to the closest
22482 (let ((case-fold-search t)
22483 (lim-up (save-excursion (outline-previous-heading)))
22484 (lim-down (save-excursion (outline-next-heading))))
22485 (mapc (lambda (name)
22486 (let ((n (regexp-quote name)))
22487 (when (org-between-regexps-p
22488 (concat "^[ \t]*#\\+begin_" n)
22489 (concat "^[ \t]*#\\+end_" n)
22495 (defun org-occur-in-agenda-files (regexp &optional nlines)
22496 "Call `multi-occur' with buffers for all agenda files."
22497 (interactive "sOrg-files matching: \np")
22498 (let* ((files (org-agenda-files))
22499 (tnames (mapcar 'file-truename files))
22500 (extra org-agenda-text-search-extra-files)
22502 (when (eq (car extra) 'agenda-archives)
22503 (setq extra (cdr extra))
22504 (setq files (org-add-archive-files files)))
22505 (while (setq f (pop extra))
22506 (unless (member (file-truename f) tnames)
22507 (add-to-list 'files f 'append)
22508 (add-to-list 'tnames (file-truename f) 'append)))
22510 (mapcar (lambda (x)
22511 (with-current-buffer
22512 (or (get-file-buffer x) (find-file-noselect x))
22518 (if (boundp 'occur-mode-find-occurrence-hook)
22520 (add-hook 'occur-mode-find-occurrence-hook
22522 (when (derived-mode-p 'org-mode)
22525 (defadvice occur-mode-goto-occurrence
22526 (after org-occur-reveal activate)
22527 (and (derived-mode-p 'org-mode) (org-reveal)))
22528 (defadvice occur-mode-goto-occurrence-other-window
22529 (after org-occur-reveal activate)
22530 (and (derived-mode-p 'org-mode) (org-reveal)))
22531 (defadvice occur-mode-display-occurrence
22532 (after org-occur-reveal activate)
22533 (when (derived-mode-p 'org-mode)
22534 (let ((pos (occur-mode-find-occurrence)))
22535 (with-current-buffer (marker-buffer pos)
22540 (defun org-occur-link-in-agenda-files ()
22541 "Create a link and search for it in the agendas.
22542 The link is not stored in `org-stored-links', it is just created
22543 for the search purpose."
22545 (let ((link (condition-case nil
22546 (org-store-link nil)
22547 (error "Unable to create a link to here"))))
22548 (org-occur-in-agenda-files (regexp-quote link))))
22550 (defun org-reverse-string (string)
22551 "Return the reverse of STRING."
22552 (apply 'string (reverse (string-to-list string))))
22554 ;; defsubst org-uniquify must be defined before first use
22556 (defun org-uniquify-alist (alist)
22557 "Merge elements of ALIST with the same key.
22559 For example, in this alist:
22561 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22562 => '((a 1 3) (b 2))
22564 merge (a 1) and (a 3) into (a 1 3).
22566 The function returns the new ALIST."
22571 (if (not (assoc (car e) rtn))
22573 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22574 (setq rtn (assq-delete-all (car e) rtn))
22579 (defun org-delete-all (elts list)
22580 "Remove all elements in ELTS from LIST."
22582 (setq list (delete (pop elts) list)))
22585 (defun org-count (cl-item cl-seq)
22586 "Count the number of occurrences of ITEM in SEQ.
22587 Taken from `count' in cl-seq.el with all keyword arguments removed."
22588 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22589 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22590 (while (< cl-start cl-end)
22591 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22592 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22593 (setq cl-start (1+ cl-start)))
22596 (defun org-remove-if (predicate seq)
22597 "Remove everything from SEQ that fulfills PREDICATE."
22601 (if (not (funcall predicate e)) (push e res)))
22604 (defun org-remove-if-not (predicate seq)
22605 "Remove everything from SEQ that does not fulfill PREDICATE."
22609 (if (funcall predicate e) (push e res)))
22612 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22613 "Reduce two-argument FUNCTION across SEQ.
22614 Taken from `reduce' in cl-seq.el with all keyword arguments but
22615 \":initial-value\" removed."
22616 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22617 (cadr (memq :initial-value cl-keys)))
22618 (cl-seq (pop cl-seq))
22619 (t (funcall cl-func)))))
22621 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22624 (defun org-every (pred seq)
22625 "Return true if PREDICATE is true of every element of SEQ.
22626 Adapted from `every' in cl.el."
22628 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22631 (defun org-some (pred seq)
22632 "Return true if PREDICATE is true of any element of SEQ.
22633 Adapted from `some' in cl.el."
22635 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22638 (defun org-back-over-empty-lines ()
22639 "Move backwards over whitespace, to the beginning of the first empty line.
22640 Returns the number of empty lines passed."
22641 (let ((pos (point)))
22642 (if (cdr (assoc 'heading org-blank-before-new-entry))
22643 (skip-chars-backward " \t\n\r")
22645 (forward-line -1)))
22646 (beginning-of-line 2)
22647 (goto-char (min (point) pos))
22648 (count-lines (point) pos)))
22650 (defun org-skip-whitespace ()
22651 (skip-chars-forward " \t\n\r"))
22653 (defun org-point-in-group (point group &optional context)
22654 "Check if POINT is in match-group GROUP.
22655 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22656 match. If the match group does not exist or point is not inside it,
22658 (and (match-beginning group)
22659 (>= point (match-beginning group))
22660 (<= point (match-end group))
22662 (list context (match-beginning group) (match-end group))
22665 (defun org-switch-to-buffer-other-window (&rest args)
22666 "Switch to buffer in a second window on the current frame.
22667 In particular, do not allow pop-up frames.
22668 Returns the newly created buffer."
22670 (apply 'switch-to-buffer-other-window args)))
22672 (defun org-combine-plists (&rest plists)
22673 "Create a single property list from all plists in PLISTS.
22674 The process starts by copying the first list, and then setting properties
22675 from the other lists. Settings in the last list are the most significant
22676 ones and overrule settings in the other lists."
22677 (let ((rtn (copy-sequence (pop plists)))
22680 (setq ls (pop plists))
22682 (setq p (pop ls) v (pop ls))
22683 (setq rtn (plist-put rtn p v))))
22686 (defun org-replace-escapes (string table)
22687 "Replace %-escapes in STRING with values in TABLE.
22688 TABLE is an association list with keys like \"%a\" and string values.
22689 The sequences in STRING may contain normal field width and padding information,
22690 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22691 so values can contain further %-escapes if they are define later in TABLE."
22692 (let ((tbl (copy-alist table))
22693 (case-fold-search nil)
22696 (while (setq e (pop tbl))
22697 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22698 (when (and (cdr e) (string-match re (cdr e)))
22699 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22701 (add-text-properties 0 3 (list 'sref sref) safe)
22702 (setcdr e (replace-match safe t t (cdr e)))))
22703 (while (string-match re string)
22704 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22706 (setq string (replace-match rpl t t string))))
22707 (while (setq pchg (next-property-change pchg string))
22708 (let ((sref (get-text-property pchg 'sref string)))
22709 (when (and sref (string-match "SREF" string pchg))
22710 (setq string (replace-match sref t t string)))))
22713 (defun org-sublist (list start end)
22714 "Return a section of LIST, from START to END.
22715 Counting starts at 1."
22716 (let (rtn (c start))
22717 (setq list (nthcdr (1- start) list))
22718 (while (and list (<= c end))
22719 (push (pop list) rtn)
22723 (defun org-find-base-buffer-visiting (file)
22724 "Like `find-buffer-visiting' but always return the base buffer and
22725 not an indirect buffer."
22726 (let ((buf (or (get-file-buffer file)
22727 (find-buffer-visiting file))))
22729 (or (buffer-base-buffer buf) buf)
22732 (defun org-image-file-name-regexp (&optional extensions)
22733 "Return regexp matching the file names of images.
22734 If EXTENSIONS is given, only match these."
22735 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22736 (image-file-name-regexp)
22737 (let ((image-file-name-extensions
22739 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22740 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22742 (regexp-opt (nconc (mapcar 'upcase
22743 image-file-name-extensions)
22744 image-file-name-extensions)
22748 (defun org-file-image-p (file &optional extensions)
22749 "Return non-nil if FILE is an image."
22751 (string-match (org-image-file-name-regexp extensions) file)))
22753 (defun org-get-cursor-date (&optional with-time)
22754 "Return the date at cursor in as a time.
22755 This works in the calendar and in the agenda, anywhere else it just
22756 returns the current time.
22757 If WITH-TIME is non-nil, returns the time of the event at point (in
22758 the agenda) or the current time of the day."
22759 (let (date day defd tp tm hod mod)
22761 (setq tp (get-text-property (point) 'time))
22762 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22763 (setq hod (string-to-number (match-string 1 tp))
22764 mod (string-to-number (match-string 2 tp))))
22765 (or tp (setq hod (nth 2 (decode-time (current-time)))
22766 mod (nth 1 (decode-time (current-time))))))
22768 ((eq major-mode 'calendar-mode)
22769 (setq date (calendar-cursor-to-date)
22770 defd (encode-time 0 (or mod 0) (or hod 0)
22771 (nth 1 date) (nth 0 date) (nth 2 date))))
22772 ((eq major-mode 'org-agenda-mode)
22773 (setq day (get-text-property (point) 'day))
22775 (setq date (calendar-gregorian-from-absolute day)
22776 defd (encode-time 0 (or mod 0) (or hod 0)
22777 (nth 1 date) (nth 0 date) (nth 2 date))))))
22778 (or defd (current-time))))
22780 (defun org-mark-subtree (&optional up)
22781 "Mark the current subtree.
22782 This puts point at the start of the current subtree, and mark at
22783 the end. If a numeric prefix UP is given, move up into the
22784 hierarchy of headlines by UP levels before marking the subtree."
22786 (org-with-limited-levels
22787 (cond ((org-at-heading-p) (beginning-of-line))
22788 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22789 (t (outline-previous-visible-heading 1))))
22790 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22791 (if (org-called-interactively-p 'any)
22792 (call-interactively 'org-mark-element)
22793 (org-mark-element)))
22798 (defun org--get-expected-indentation (element contentsp)
22799 "Expected indentation column for current line, according to ELEMENT.
22800 ELEMENT is an element containing point. CONTENTSP is non-nil
22801 when indentation is to be computed according to contents of
22803 (let ((type (org-element-type element))
22804 (start (org-element-property :begin element))
22805 (post-affiliated (org-element-property :post-affiliated element)))
22806 (org-with-wide-buffer
22810 ((diary-sexp footnote-definition) 0)
22811 ((headline inlinetask nil)
22812 (if (not org-adapt-indentation) 0
22813 (let ((level (org-current-level)))
22814 (if level (1+ level) 0))))
22815 ((item plain-list) (org-list-item-body-column post-affiliated))
22818 (org-get-indentation))))
22819 ((memq type '(headline inlinetask nil))
22820 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22821 (org--get-expected-indentation element t)
22823 ((memq type '(diary-sexp footnote-definition)) 0)
22824 ;; First paragraph of a footnote definition or an item.
22825 ;; Indent like parent.
22826 ((< (line-beginning-position) start)
22827 (org--get-expected-indentation
22828 (org-element-property :parent element) t))
22829 ;; At first line: indent according to previous sibling, if any,
22830 ;; ignoring footnote definitions and inline tasks, or parent's
22832 ((= (line-beginning-position) start)
22835 (if (= (point-min) start) (throw 'exit 0)
22836 (goto-char (1- start))
22837 (let* ((previous (org-element-at-point))
22839 (while (and parent (<= (org-element-property :end parent) start))
22840 (setq previous parent
22841 parent (org-element-property :parent parent)))
22843 ((not previous) (throw 'exit 0))
22844 ((> (org-element-property :end previous) start)
22845 (throw 'exit (org--get-expected-indentation previous t)))
22846 ((memq (org-element-type previous)
22847 '(footnote-definition inlinetask))
22848 (setq start (org-element-property :begin previous)))
22849 (t (goto-char (org-element-property :begin previous))
22851 (if (bolp) (org-get-indentation)
22852 ;; At first paragraph in an item or
22853 ;; a footnote definition.
22854 (org--get-expected-indentation
22855 (org-element-property :parent previous) t))))))))))
22856 ;; Otherwise, move to the first non-blank line above.
22858 (beginning-of-line)
22859 (let ((pos (point)))
22860 (skip-chars-backward " \r\t\n")
22862 ;; Two blank lines end a footnote definition or a plain
22863 ;; list. When we indent an empty line after them, the
22864 ;; containing list or footnote definition is over, so it
22865 ;; qualifies as a previous sibling. Therefore, we indent
22866 ;; like its first line.
22867 ((and (memq type '(footnote-definition plain-list))
22868 (> (count-lines (point) pos) 2))
22870 (org-get-indentation))
22871 ;; Line above is the first one of a paragraph at the
22872 ;; beginning of an item or a footnote definition. Indent
22874 ((< (line-beginning-position) start)
22875 (org--get-expected-indentation
22876 (org-element-property :parent element) t))
22877 ;; Line above is the beginning of an element, i.e., point
22878 ;; was originally on the blank lines between element's start
22880 ((= (line-beginning-position) post-affiliated)
22881 (org--get-expected-indentation element t))
22882 ;; POS is after contents in a greater element. Indent like
22883 ;; the beginning of the element.
22885 ;; As a special case, if point is at the end of a footnote
22886 ;; definition or an item, indent like the very last element
22888 ((and (not (eq type 'paragraph))
22889 (let ((cend (org-element-property :contents-end element)))
22890 (and cend (<= cend pos))))
22891 (if (memq type '(footnote-definition item plain-list))
22892 (let ((last (org-element-at-point)))
22893 (org--get-expected-indentation
22895 (memq (org-element-type last)
22896 '(footnote-definition item plain-list))))
22898 (org-get-indentation)))
22899 ;; In any other case, indent like the current line.
22900 (t (org-get-indentation)))))))))
22902 (defun org--align-node-property ()
22903 "Align node property at point.
22904 Alignment is done according to `org-property-format', which see."
22905 (when (save-excursion
22906 (beginning-of-line)
22907 (looking-at org-property-re))
22909 (concat (match-string 4)
22911 (format org-property-format (match-string 1) (match-string 3))))
22914 (defun org-indent-line ()
22915 "Indent line depending on context.
22917 Indentation is done according to the following rules:
22919 - Footnote definitions, diary sexps, headlines and inline tasks
22920 have to start at column 0.
22922 - On the very first line of an element, consider, in order, the
22923 next rules until one matches:
22925 1. If there's a sibling element before, ignoring footnote
22926 definitions and inline tasks, indent like its first line.
22928 2. If element has a parent, indent like its contents. More
22929 precisely, if parent is an item, indent after the
22930 description part, if any, or the bullet (see
22931 `org-list-description-max-indent'). Else, indent like
22932 parent's first line.
22934 3. Otherwise, indent relatively to current level, if
22935 `org-adapt-indentation' is non-nil, or to left margin.
22937 - On a blank line at the end of an element, indent according to
22938 the type of the element. More precisely
22940 1. If element is a plain list, an item, or a footnote
22941 definition, indent like the very last element within.
22943 2. If element is a paragraph, indent like its last non blank
22946 3. Otherwise, indent like its very first line.
22948 - In the code part of a source block, use language major mode
22949 to indent current line if `org-src-tab-acts-natively' is
22950 non-nil. If it is nil, do nothing.
22952 - Otherwise, indent like the first non-blank line above.
22954 The function doesn't indent an item as it could break the whole
22955 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22956 \\[org-shiftmetaright].
22958 Also align node properties according to `org-property-format'."
22962 (let ((indent-line-function
22963 (cadadr (assq 'indent-line-function org-fb-vars))))
22964 (indent-according-to-mode)))
22965 ((org-at-heading-p) 'noindent)
22967 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22968 (type (org-element-type element)))
22969 (cond ((and (memq type '(plain-list item))
22970 (= (line-beginning-position)
22971 (org-element-property :post-affiliated element)))
22973 ((and (eq type 'src-block)
22974 org-src-tab-acts-natively
22975 (> (line-beginning-position)
22976 (org-element-property :post-affiliated element))
22977 (< (line-beginning-position)
22978 (org-with-wide-buffer
22979 (goto-char (org-element-property :end element))
22980 (skip-chars-backward " \r\t\n")
22981 (line-beginning-position))))
22982 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22984 (let ((column (org--get-expected-indentation element nil)))
22985 ;; Preserve current column.
22986 (if (<= (current-column) (current-indentation))
22987 (org-indent-line-to column)
22988 (save-excursion (org-indent-line-to column))))
22989 ;; Align node property. Also preserve current column.
22990 (when (eq type 'node-property)
22991 (let ((column (current-column)))
22992 (org--align-node-property)
22993 (org-move-to-column column)))))))))
22995 (defun org-indent-region (start end)
22996 "Indent each non-blank line in the region.
22997 Called from a program, START and END specify the region to
22998 indent. The function will not indent contents of example blocks,
22999 verse blocks and export blocks as leading white spaces are
23000 assumed to be significant there."
23004 (skip-chars-forward " \r\t\n")
23005 (unless (eobp) (beginning-of-line))
23008 ;; Set IND as indentation for all lines between point and
23009 ;; POS or END, whichever comes first. Blank lines are
23010 ;; ignored. Leave point after POS once done.
23011 (let ((limit (copy-marker (min end pos))))
23012 (while (< (point) limit)
23013 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23015 (set-marker limit nil))))
23016 (end (copy-marker end)))
23017 (while (< (point) end)
23018 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23019 (let* ((element (org-element-at-point))
23020 (type (org-element-type element))
23021 (element-end (copy-marker (org-element-property :end element)))
23022 (ind (org--get-expected-indentation element nil)))
23024 ((or (memq type '(paragraph table table-row))
23025 (not (or (org-element-property :contents-begin element)
23027 '(example-block export-block src-block)))))
23028 ;; Elements here are indented as a single block. Also
23029 ;; align node properties.
23030 (when (eq type 'node-property)
23031 (org--align-node-property)
23032 (beginning-of-line))
23033 (funcall indent-to ind element-end))
23035 ;; Elements in this category consist of three parts:
23036 ;; before the contents, the contents, and after the
23037 ;; contents. The contents are treated specially,
23038 ;; according to the element type, or not indented at
23039 ;; all. Other parts are indented as a single block.
23040 (let* ((post (copy-marker
23041 (org-element-property :post-affiliated element)))
23045 ((not (org-element-property :contents-begin element))
23046 ;; Fake contents for source blocks.
23047 (org-with-wide-buffer
23051 ((memq type '(footnote-definition item plain-list))
23052 ;; Contents in these elements could start on
23053 ;; the same line as the beginning of the
23054 ;; element. Make sure we start indenting
23055 ;; from the second line.
23056 (org-with-wide-buffer
23059 (skip-chars-forward " \r\t\n")
23060 (if (eobp) (point) (line-beginning-position))))
23061 (t (org-element-property :contents-begin element)))))
23063 (or (org-element-property :contents-end element)
23064 ;; Fake contents for source blocks.
23065 (org-with-wide-buffer
23066 (goto-char element-end)
23067 (skip-chars-backward " \r\t\n")
23068 (line-beginning-position)))
23070 ;; Do not change items indentation individually as it
23071 ;; might break the list as a whole. On the other
23072 ;; hand, when at a plain list, indent it as a whole.
23073 (cond ((eq type 'plain-list)
23074 (let ((offset (- ind (org-get-indentation))))
23075 (unless (zerop offset)
23076 (indent-rigidly (org-element-property :begin element)
23077 (org-element-property :end element)
23080 ((eq type 'item) (goto-char cbeg))
23081 (t (funcall indent-to ind cbeg)))
23082 (when (< (point) end)
23084 ((example-block export-block verse-block))
23086 ;; In a source block, indent source code
23087 ;; according to language major mode, but only if
23088 ;; `org-src-tab-acts-natively' is non-nil.
23089 (when (and (< (point) end) org-src-tab-acts-natively)
23091 (org-babel-do-in-edit-buffer
23092 (indent-region (point-min) (point-max))))))
23093 (t (org-indent-region (point) (min cend end))))
23094 (goto-char (min cend end))
23095 (when (< (point) end) (funcall indent-to ind element-end)))
23096 (set-marker post nil)
23097 (set-marker cbeg nil)
23098 (set-marker cend nil))))
23099 (set-marker element-end nil))))
23100 (set-marker end nil))))
23102 (defun org-indent-drawer ()
23103 "Indent the drawer at point."
23105 (unless (save-excursion
23106 (beginning-of-line)
23107 (org-looking-at-p org-drawer-regexp))
23108 (user-error "Not at a drawer"))
23109 (let ((element (org-element-at-point)))
23110 (unless (memq (org-element-type element) '(drawer property-drawer))
23111 (user-error "Not at a drawer"))
23112 (org-with-wide-buffer
23113 (org-indent-region (org-element-property :begin element)
23114 (org-element-property :end element))))
23115 (message "Drawer at point indented"))
23117 (defun org-indent-block ()
23118 "Indent the block at point."
23120 (unless (save-excursion
23121 (beginning-of-line)
23122 (let ((case-fold-search t))
23123 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23124 (user-error "Not at a block"))
23125 (let ((element (org-element-at-point)))
23126 (unless (memq (org-element-type element)
23127 '(comment-block center-block dynamic-block example-block
23128 export-block quote-block special-block
23129 src-block verse-block))
23130 (user-error "Not at a block"))
23131 (org-with-wide-buffer
23132 (org-indent-region (org-element-property :begin element)
23133 (org-element-property :end element))))
23134 (message "Block at point indented"))
23139 ;; We use our own fill-paragraph and auto-fill functions.
23141 ;; `org-fill-paragraph' relies on adaptive filling and context
23142 ;; checking. Appropriate `fill-prefix' is computed with
23143 ;; `org-adaptive-fill-function'.
23145 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23146 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23147 ;; `org-adaptive-fill-function' value. Internally,
23148 ;; `org-comment-line-break-function' breaks the line.
23150 ;; `org-setup-filling' installs filling and auto-filling related
23151 ;; variables during `org-mode' initialization.
23153 (defvar org-element-paragraph-separate) ; org-element.el
23154 (defun org-setup-filling ()
23155 (require 'org-element)
23156 ;; Prevent auto-fill from inserting unwanted new items.
23157 (when (boundp 'fill-nobreak-predicate)
23159 'fill-nobreak-predicate
23161 (append fill-nobreak-predicate
23162 '(org-fill-line-break-nobreak-p
23163 org-fill-paragraph-with-timestamp-nobreak-p)))))
23164 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23165 (org-set-local 'paragraph-start paragraph-ending)
23166 (org-set-local 'paragraph-separate paragraph-ending))
23167 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23168 (org-set-local 'auto-fill-inhibit-regexp nil)
23169 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23170 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23171 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23173 (defun org-fill-line-break-nobreak-p ()
23174 "Non-nil when a new line at point would create an Org line break."
23176 (skip-chars-backward "[ \t]")
23177 (skip-chars-backward "\\\\")
23178 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23180 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23181 "Non-nil when a new line at point would split a timestamp."
23182 (and (org-at-timestamp-p t)
23183 (not (looking-at org-ts-regexp-both))))
23185 (declare-function message-in-body-p "message" ())
23186 (defvar orgtbl-line-start-regexp) ; From org-table.el
23187 (defun org-adaptive-fill-function ()
23188 "Compute a fill prefix for the current line.
23189 Return fill prefix, as a string, or nil if current line isn't
23190 meant to be filled. For convenience, if `adaptive-fill-regexp'
23191 matches in paragraphs or comments, use it."
23193 (when (derived-mode-p 'message-mode)
23195 (beginning-of-line)
23196 (cond ((not (message-in-body-p)) (throw 'exit nil))
23197 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23198 ((looking-at message-cite-prefix-regexp)
23199 (throw 'exit (match-string-no-properties 0)))
23200 ((looking-at org-outline-regexp)
23201 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23202 (org-with-wide-buffer
23203 (unless (org-at-heading-p)
23204 (let* ((p (line-beginning-position))
23205 (element (save-excursion
23206 (beginning-of-line)
23207 (org-element-at-point)))
23208 (type (org-element-type element))
23209 (post-affiliated (org-element-property :post-affiliated element)))
23210 (unless (< p post-affiliated)
23214 (beginning-of-line)
23215 (looking-at "[ \t]*")
23216 (concat (match-string 0) "# ")))
23217 (footnote-definition "")
23219 (make-string (org-list-item-body-column post-affiliated) ?\s))
23221 ;; Fill prefix is usually the same as the current line,
23222 ;; unless the paragraph is at the beginning of an item.
23223 (let ((parent (org-element-property :parent element)))
23225 (beginning-of-line)
23226 (cond ((eq (org-element-type parent) 'item)
23227 (make-string (org-list-item-body-column
23228 (org-element-property :begin parent))
23230 ((and adaptive-fill-regexp
23232 ;; `adaptive-fill-function' to let
23233 ;; `fill-context-prefix' handle
23234 ;; `adaptive-fill-regexp' variable.
23235 (let (adaptive-fill-function)
23236 (fill-context-prefix
23238 (org-element-property :end element)))))
23239 ((looking-at "[ \t]+") (match-string 0))
23242 ;; Only fill contents if P is within block boundaries.
23243 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23246 (cend (save-excursion
23247 (goto-char (org-element-property :end element))
23248 (skip-chars-backward " \r\t\n")
23249 (line-beginning-position))))
23250 (when (and (>= p cbeg) (< p cend))
23251 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23255 (declare-function message-goto-body "message" ())
23256 (defvar message-cite-prefix-regexp) ; From message.el
23257 (defun org-fill-paragraph (&optional justify)
23258 "Fill element at point, when applicable.
23260 This function only applies to comment blocks, comments, example
23261 blocks and paragraphs. Also, as a special case, re-align table
23262 when point is at one.
23264 If JUSTIFY is non-nil (interactively, with prefix argument),
23265 justify as well. If `sentence-end-double-space' is non-nil, then
23266 period followed by one space does not end a sentence, so don't
23267 break a line there. The variable `fill-column' controls the
23270 For convenience, when point is at a plain list, an item or
23271 a footnote definition, try to fill the first paragraph within."
23273 (if (and (derived-mode-p 'message-mode)
23274 (or (not (message-in-body-p))
23275 (save-excursion (move-beginning-of-line 1)
23276 (looking-at message-cite-prefix-regexp))))
23277 ;; First ensure filling is correct in message-mode.
23278 (let ((fill-paragraph-function
23279 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23280 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23281 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23282 (paragraph-separate
23283 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23284 (fill-paragraph nil))
23285 (with-syntax-table org-mode-transpose-word-syntax-table
23286 ;; Move to end of line in order to get the first paragraph
23287 ;; within a plain list or a footnote definition.
23288 (let ((element (save-excursion
23290 (or (ignore-errors (org-element-at-point))
23291 (user-error "An element cannot be parsed line %d"
23292 (line-number-at-pos (point)))))))
23293 ;; First check if point is in a blank line at the beginning of
23294 ;; the buffer. In that case, ignore filling.
23295 (case (org-element-type element)
23296 ;; Use major mode filling function is src blocks.
23297 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23298 ;; Align Org tables, leave table.el tables as-is.
23299 (table-row (org-table-align) t)
23301 (when (eq (org-element-property :type element) 'org)
23303 (goto-char (org-element-property :post-affiliated element))
23304 (org-table-align)))
23307 ;; Paragraphs may contain `line-break' type objects.
23308 (let ((beg (max (point-min)
23309 (org-element-property :contents-begin element)))
23310 (end (min (point-max)
23311 (org-element-property :contents-end element))))
23312 ;; Do nothing if point is at an affiliated keyword.
23313 (if (< (line-end-position) beg) t
23314 (when (derived-mode-p 'message-mode)
23315 ;; In `message-mode', do not fill following citation
23316 ;; in current paragraph nor text before message body.
23317 (let ((body-start (save-excursion (message-goto-body))))
23318 (when body-start (setq beg (max body-start beg))))
23319 (when (save-excursion
23321 (concat "^" message-cite-prefix-regexp) end t))
23322 (setq end (match-beginning 0))))
23323 ;; Fill paragraph, taking line breaks into account.
23326 (let ((cuts (list beg)))
23327 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23328 (when (eq 'line-break
23330 (save-excursion (backward-char)
23331 (org-element-context))))
23332 (push (point) cuts)))
23333 (dolist (c (delq end cuts))
23334 (fill-region-as-paragraph c end justify)
23337 ;; Contents of `comment-block' type elements should be
23338 ;; filled as plain text, but only if point is within block
23341 (let* ((case-fold-search t)
23342 (beg (save-excursion
23343 (goto-char (org-element-property :begin element))
23344 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23347 (end (save-excursion
23348 (goto-char (org-element-property :end element))
23349 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23350 (line-beginning-position))))
23351 (if (or (< (point) beg) (> (point) end)) t
23352 (fill-region-as-paragraph
23353 (save-excursion (end-of-line)
23354 (re-search-backward "^[ \t]*$" beg 'move)
23355 (line-beginning-position))
23356 (save-excursion (beginning-of-line)
23357 (re-search-forward "^[ \t]*$" end 'move)
23358 (line-beginning-position))
23362 (let ((begin (org-element-property :post-affiliated element))
23363 (end (org-element-property :end element)))
23364 (when (and (>= (point) begin) (<= (point) end))
23365 (let ((begin (save-excursion
23367 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23368 (progn (forward-line) (point))
23370 (end (save-excursion
23372 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23373 (1- (line-beginning-position))
23374 (skip-chars-backward " \r\t\n")
23375 (line-end-position)))))
23376 ;; Do not fill comments when at a blank line.
23377 (when (> end begin)
23380 (beginning-of-line)
23381 (looking-at "[ \t]*#")
23382 (let ((comment-prefix (match-string 0)))
23383 (goto-char (match-end 0))
23384 (if (looking-at adaptive-fill-regexp)
23385 (concat comment-prefix (match-string 0))
23386 (concat comment-prefix " "))))))
23388 (fill-region-as-paragraph begin end justify))))))
23390 ;; Ignore every other element.
23393 (defun org-auto-fill-function ()
23394 "Auto-fill function."
23395 ;; Check if auto-filling is meaningful.
23396 (let ((fc (current-fill-column)))
23397 (when (and fc (> (current-column) fc))
23398 (let* ((fill-prefix (org-adaptive-fill-function))
23399 ;; Enforce empty fill prefix, if required. Otherwise, it
23400 ;; will be computed again.
23401 (adaptive-fill-mode (not (equal fill-prefix ""))))
23402 (when fill-prefix (do-auto-fill))))))
23404 (defun org-comment-line-break-function (&optional soft)
23405 "Break line at point and indent, continuing comment if within one.
23406 The inserted newline is marked hard if variable
23407 `use-hard-newlines' is true, unless optional argument SOFT is
23409 (if soft (insert-and-inherit ?\n) (newline 1))
23410 (save-excursion (forward-char -1) (delete-horizontal-space))
23411 (delete-horizontal-space)
23412 (indent-to-left-margin)
23413 (insert-before-markers-and-inherit fill-prefix))
23416 ;;; Fixed Width Areas
23418 (defun org-toggle-fixed-width ()
23419 "Toggle fixed-width markup.
23421 Add or remove fixed-width markup on current line, whenever it
23422 makes sense. Return an error otherwise.
23424 If a region is active and if it contains only fixed-width areas
23425 or blank lines, remove all fixed-width markup in it. If the
23426 region contains anything else, convert all non-fixed-width lines
23427 to fixed-width ones.
23429 Blank lines at the end of the region are ignored unless the
23430 region only contains such lines."
23432 (if (not (org-region-active-p))
23435 ;; Remove fixed width marker only in a fixed-with element.
23437 ;; Add fixed width maker in paragraphs, in blank lines after
23438 ;; elements or at the beginning of a headline or an inlinetask,
23439 ;; and before any one-line elements (e.g., a clock).
23441 (beginning-of-line)
23442 (let* ((element (org-element-at-point))
23443 (type (org-element-type element)))
23445 ((and (eq type 'fixed-width)
23446 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23448 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23449 ((and (memq type '(babel-call clock comment diary-sexp headline
23450 horizontal-rule keyword paragraph
23452 (<= (org-element-property :post-affiliated element) (point)))
23453 (skip-chars-forward " \t")
23455 ((and (org-looking-at-p "[ \t]*$")
23456 (or (eq type 'inlinetask)
23458 (skip-chars-forward " \r\t\n")
23459 (<= (org-element-property :end element) (point)))))
23460 (delete-region (point) (line-end-position))
23463 (t (user-error "Cannot insert a fixed-width line here")))))
23465 (let* ((begin (save-excursion
23466 (goto-char (region-beginning))
23467 (line-beginning-position)))
23470 (goto-char (region-end))
23471 (unless (eolp) (beginning-of-line))
23472 (if (save-excursion (re-search-backward "\\S-" begin t))
23473 (progn (skip-chars-backward " \r\t\n") (point))
23479 (skip-chars-forward " \r\t\n")
23480 (when (eobp) (throw 'not-all-p nil))
23481 (while (< (point) end)
23482 (let ((element (org-element-at-point)))
23483 (if (eq (org-element-type element) 'fixed-width)
23484 (goto-char (org-element-property :end element))
23485 (throw 'not-all-p nil))))
23487 (if all-fixed-width-p
23490 (while (< (point) end)
23491 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23494 (if (= (line-end-position) (match-end 0)) 0 1)))
23496 (let ((min-ind (point-max)))
23497 ;; Find minimum indentation across all lines.
23500 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23503 (while (< (point) end)
23504 (unless (org-looking-at-p "[ \t]*$")
23505 (let ((ind (org-get-indentation)))
23506 (setq min-ind (min min-ind ind))
23507 (when (zerop ind) (throw 'zerop t))))
23509 ;; Loop over all lines and add fixed-width markup everywhere
23510 ;; but in fixed-width lines.
23513 (while (< (point) end)
23515 ((org-at-heading-p)
23518 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23521 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23522 (let* ((element (org-element-at-point))
23523 (element-end (org-element-property :end element)))
23524 (if (eq (org-element-type element) 'fixed-width)
23525 (progn (goto-char element-end)
23526 (skip-chars-backward " \r\t\n")
23528 (let ((limit (min end element-end)))
23529 (while (< (point) limit)
23530 (org-move-to-column min-ind t)
23532 (forward-line))))))
23534 (org-move-to-column min-ind t)
23536 (forward-line)))))))
23537 (set-marker end nil))))
23542 ;; Org comments syntax is quite complex. It requires the entire line
23543 ;; to be just a comment. Also, even with the right syntax at the
23544 ;; beginning of line, some some elements (i.e. verse-block or
23545 ;; example-block) don't accept comments. Usual Emacs comment commands
23546 ;; cannot cope with those requirements. Therefore, Org replaces them.
23548 ;; Org still relies on `comment-dwim', but cannot trust
23549 ;; `comment-only-p'. So, `comment-region-function' and
23550 ;; `uncomment-region-function' both point
23551 ;; to`org-comment-or-uncomment-region'. Eventually,
23552 ;; `org-insert-comment' takes care of insertion of comments at the
23553 ;; beginning of line.
23555 ;; `org-setup-comments-handling' install comments related variables
23556 ;; during `org-mode' initialization.
23558 (defun org-setup-comments-handling ()
23560 (org-set-local 'comment-use-syntax nil)
23561 (org-set-local 'comment-start "# ")
23562 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23563 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23564 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23565 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23567 (defun org-insert-comment ()
23568 "Insert an empty comment above current line.
23569 If the line is empty, insert comment at its beginning. When
23570 point is within a source block, comment according to the related
23572 (if (let ((element (org-element-at-point)))
23573 (and (eq (org-element-type element) 'src-block)
23575 (goto-char (org-element-property :post-affiliated element))
23576 (line-end-position))
23579 (goto-char (org-element-property :end element))
23580 (skip-chars-backward " \r\t\n")
23581 (line-beginning-position))
23583 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23584 (beginning-of-line)
23585 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23590 (defvar comment-empty-lines) ; From newcomment.el.
23591 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23592 "Comment or uncomment each non-blank line in the region.
23593 Uncomment each non-blank line between BEG and END if it only
23594 contains commented lines. Otherwise, comment them. If region is
23595 strictly within a source block, use appropriate comment syntax."
23596 (if (let ((element (org-element-at-point)))
23597 (and (eq (org-element-type element) 'src-block)
23599 (goto-char (org-element-property :post-affiliated element))
23600 (line-end-position))
23602 (>= (save-excursion
23603 (goto-char (org-element-property :end element))
23604 (skip-chars-backward " \r\t\n")
23605 (line-beginning-position))
23607 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23610 (narrow-to-region (save-excursion (goto-char beg)
23611 (skip-chars-forward " \r\t\n" end)
23612 (line-beginning-position))
23613 (save-excursion (goto-char end)
23614 (skip-chars-backward " \r\t\n" beg)
23615 (line-end-position)))
23617 ;; UNCOMMENTP is non-nil when every non blank line between
23618 ;; BEG and END is a comment.
23620 (goto-char (point-min))
23621 (while (and (not (eobp))
23622 (let ((element (org-element-at-point)))
23623 (and (eq (org-element-type element) 'comment)
23624 (goto-char (min (point-max)
23625 (org-element-property
23626 :end element)))))))
23629 ;; Only blank lines and comments in region: uncomment it.
23631 (goto-char (point-min))
23632 (while (not (eobp))
23633 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23634 (replace-match "" nil nil nil 1))
23636 ;; Comment each line in region.
23637 (let ((min-indent (point-max)))
23638 ;; First find the minimum indentation across all lines.
23640 (goto-char (point-min))
23641 (while (and (not (eobp)) (not (zerop min-indent)))
23642 (unless (looking-at "[ \t]*$")
23643 (setq min-indent (min min-indent (current-indentation))))
23645 ;; Then loop over all lines.
23647 (goto-char (point-min))
23648 (while (not (eobp))
23649 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23650 ;; Don't get fooled by invisible text (e.g. link path)
23651 ;; when moving to column MIN-INDENT.
23652 (let ((buffer-invisibility-spec nil))
23653 (org-move-to-column min-indent t))
23654 (insert comment-start))
23655 (forward-line)))))))))
23657 (defun org-comment-dwim (arg)
23658 "Call `comment-dwim' within a source edit buffer if needed."
23660 (if (org-in-src-block-p)
23661 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23662 (call-interactively 'comment-dwim)))
23667 ;; This section contains tools to operate on timestamp objects, as
23668 ;; returned by, e.g. `org-element-context'.
23670 (defun org-timestamp--to-internal-time (timestamp &optional end)
23671 "Encode TIMESTAMP object into Emacs internal time.
23672 Use end of date range or time range when END is non-nil."
23673 (apply #'encode-time
23676 (lambda (prop) (or (org-element-property prop timestamp) 0))
23677 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23678 '(:minute-start :hour-start :day-start :month-start
23681 (defun org-timestamp-has-time-p (timestamp)
23682 "Non-nil when TIMESTAMP has a time specified."
23683 (org-element-property :hour-start timestamp))
23685 (defun org-timestamp-format (timestamp format &optional end utc)
23686 "Format a TIMESTAMP object into a string.
23688 FORMAT is a format specifier to be passed to
23689 `format-time-string'.
23691 When optional argument END is non-nil, use end of date-range or
23692 time-range, if possible.
23694 When optional argument UTC is non-nil, time will be expressed as
23696 (format-time-string
23697 format (org-timestamp--to-internal-time timestamp end) utc))
23699 (defun org-timestamp-split-range (timestamp &optional end)
23700 "Extract a TIMESTAMP object from a date or time range.
23702 END, when non-nil, means extract the end of the range.
23703 Otherwise, extract its start.
23705 Return a new timestamp object."
23706 (let ((type (org-element-property :type timestamp)))
23707 (if (memq type '(active inactive diary)) timestamp
23708 (let ((split-ts (org-element-copy timestamp)))
23710 (org-element-put-property
23711 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23712 ;; Copy start properties over end properties if END is
23713 ;; non-nil. Otherwise, copy end properties over `start' ones.
23714 (let ((p-alist '((:minute-start . :minute-end)
23715 (:hour-start . :hour-end)
23716 (:day-start . :day-end)
23717 (:month-start . :month-end)
23718 (:year-start . :year-end))))
23719 (dolist (p-cell p-alist)
23720 (org-element-put-property
23722 (funcall (if end #'car #'cdr) p-cell)
23723 (org-element-property
23724 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23725 ;; Eventually refresh `:raw-value'.
23726 (org-element-put-property split-ts :raw-value nil)
23727 (org-element-put-property
23728 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23730 (defun org-timestamp-translate (timestamp &optional boundary)
23731 "Translate TIMESTAMP object to custom format.
23733 Format string is defined in `org-time-stamp-custom-formats',
23736 When optional argument BOUNDARY is non-nil, it is either the
23737 symbol `start' or `end'. In this case, only translate the
23738 starting or ending part of TIMESTAMP if it is a date or time
23739 range. Otherwise, translate both parts.
23741 Return timestamp as-is if `org-display-custom-times' is nil or if
23742 it has a `diary' type."
23743 (let ((type (org-element-property :type timestamp)))
23744 (if (or (not org-display-custom-times) (eq type 'diary))
23745 (org-element-interpret-data timestamp)
23746 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23747 org-time-stamp-custom-formats)))
23748 (if (and (not boundary) (memq type '(active-range inactive-range)))
23749 (concat (org-timestamp-format timestamp fmt)
23751 (org-timestamp-format timestamp fmt t))
23752 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23758 (defun org-reftex-citation ()
23759 "Use reftex-citation to insert a citation into the buffer.
23760 This looks for a line like
23762 #+BIBLIOGRAPHY: foo plain option:-d
23764 and derives from it that foo.bib is the bibliography file relevant
23765 for this document. It then installs the necessary environment for RefTeX
23766 to work in this buffer and calls `reftex-citation' to insert a citation
23769 Export of such citations to both LaTeX and HTML is handled by the contributed
23770 package ox-bibtex by Taru Karttunen."
23772 (let ((reftex-docstruct-symbol 'rds)
23773 (reftex-cite-format "\\cite{%l}")
23778 (let ((case-fold-search t)
23779 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23780 (if (not (save-excursion
23781 (or (re-search-forward re nil t)
23782 (re-search-backward re nil t))))
23783 (user-error "No bibliography defined in file")
23784 (setq bib (concat (match-string 1) ".bib")
23785 rds (list (list 'bib bib)))))))
23786 (call-interactively 'reftex-citation)))
23788 ;;;; Functions extending outline functionality
23790 (defun org-beginning-of-line (&optional arg)
23791 "Go to the beginning of the current line. If that is invisible, continue
23792 to a visible line beginning. This makes the function of C-a more intuitive.
23793 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23794 first attempt, and only move to after the tags when the cursor is already
23795 beyond the end of the headline."
23797 (let ((pos (point))
23798 (special (if (consp org-special-ctrl-a/e)
23799 (car org-special-ctrl-a/e)
23800 org-special-ctrl-a/e))
23801 deactivate-mark refpos)
23802 (if (org-bound-and-true-p visual-line-mode)
23803 (beginning-of-visual-line 1)
23804 (beginning-of-line 1))
23805 (if (and arg (fboundp 'move-beginning-of-line))
23806 (call-interactively 'move-beginning-of-line)
23810 (if (org-truely-invisible-p)
23811 (while (and (not (bobp)) (org-truely-invisible-p))
23813 (beginning-of-line 1))
23814 (forward-char 1))))
23817 ((and (looking-at org-complex-heading-regexp)
23818 (= (char-after (match-end 1)) ?\ ))
23819 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23823 (cond ((> pos refpos) refpos)
23824 ((= pos (point)) refpos)
23826 (cond ((> pos (point)) (point))
23827 ((not (eq last-command this-command)) (point))
23830 ;; Being at an item and not looking at an the item means point
23831 ;; was previously moved to beginning of a visual line, which
23832 ;; doesn't contain the item. Therefore, do nothing special,
23834 (when (looking-at org-list-full-item-re)
23835 ;; Set special position at first white space character after
23836 ;; bullet, and check-box, if any.
23837 (let ((after-bullet
23838 (let ((box (match-end 3)))
23839 (if (not box) (match-end 1)
23840 (let ((after (char-after box)))
23841 (if (and after (= after ? )) (1+ box) box))))))
23842 ;; Special case: Move point to special position when
23843 ;; currently after it or at beginning of line.
23845 (when (or (> pos after-bullet) (= (point) pos))
23846 (goto-char after-bullet))
23847 ;; Reversed case: Move point to special position when
23848 ;; point was already at beginning of line and command is
23850 (when (and (= (point) pos) (eq last-command this-command))
23851 (goto-char after-bullet))))))))
23853 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23854 (setq disable-point-adjustment
23855 (or (not (invisible-p (point)))
23856 (not (invisible-p (max (point-min) (1- (point))))))))
23858 (defun org-end-of-line (&optional arg)
23859 "Go to the end of the line.
23860 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23861 tags on the first attempt, and only move to after the tags when
23862 the cursor is already beyond the end of the headline."
23864 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23865 org-special-ctrl-a/e))
23866 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23867 'end-of-visual-line)
23868 ((fboundp 'move-end-of-line) 'move-end-of-line)
23871 (if (or (not special) arg) (call-interactively move-fun)
23872 (let* ((element (save-excursion (beginning-of-line)
23873 (org-element-at-point)))
23874 (type (org-element-type element)))
23876 ((memq type '(headline inlinetask))
23877 (let ((pos (point)))
23878 (beginning-of-line 1)
23879 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23881 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23882 (goto-char (match-beginning 1))
23883 (goto-char (match-end 0)))
23884 (if (or (< pos (match-end 0))
23885 (not (eq this-command last-command)))
23886 (goto-char (match-end 0))
23887 (goto-char (match-beginning 1))))
23888 (call-interactively move-fun))))
23889 ((outline-invisible-p (line-end-position))
23890 ;; If element is hidden, `move-end-of-line' would put point
23891 ;; after it. Use `end-of-line' to stay on current line.
23892 (call-interactively 'end-of-line))
23893 (t (call-interactively move-fun)))))
23894 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23895 (setq disable-point-adjustment
23896 (or (not (invisible-p (point)))
23897 (not (invisible-p (max (point-min) (1- (point))))))))
23899 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23900 (define-key org-mode-map "\C-e" 'org-end-of-line)
23902 (defun org-backward-sentence (&optional arg)
23903 "Go to beginning of sentence, or beginning of table field.
23904 This will call `backward-sentence' or `org-table-beginning-of-field',
23905 depending on context."
23907 (let* ((element (org-element-at-point))
23908 (contents-begin (org-element-property :contents-begin element))
23909 (table (org-element-lineage element '(table) t)))
23911 (> (point) contents-begin)
23912 (<= (point) (org-element-property :contents-end table)))
23913 (call-interactively #'org-table-beginning-of-field)
23915 (when (and contents-begin
23916 (< (point-min) contents-begin)
23917 (> (point) contents-begin))
23918 (narrow-to-region contents-begin
23919 (org-element-property :contents-end element)))
23920 (call-interactively #'backward-sentence)))))
23922 (defun org-forward-sentence (&optional arg)
23923 "Go to end of sentence, or end of table field.
23924 This will call `forward-sentence' or `org-table-end-of-field',
23925 depending on context."
23927 (let* ((element (org-element-at-point))
23928 (contents-end (org-element-property :contents-end element))
23929 (table (org-element-lineage element '(table) t)))
23931 (>= (point) (org-element-property :contents-begin table))
23932 (< (point) contents-end))
23933 (call-interactively #'org-table-end-of-field)
23935 (when (and contents-end
23936 (> (point-max) contents-end)
23937 ;; Skip blank lines between elements.
23938 (< (org-element-property :end element)
23939 (save-excursion (goto-char contents-end)
23940 (skip-chars-forward " \r\t\n"))))
23941 (narrow-to-region (org-element-property :contents-begin element)
23943 (call-interactively #'forward-sentence)))))
23945 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23946 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23948 (defun org-kill-line (&optional arg)
23949 "Kill line, to tags or end of line."
23952 ((or (not org-special-ctrl-k)
23954 (not (org-at-heading-p)))
23955 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23956 org-ctrl-k-protect-subtree)
23957 (if (or (eq org-ctrl-k-protect-subtree 'error)
23958 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23959 (user-error "C-k aborted as it would kill a hidden subtree")))
23960 (call-interactively
23961 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23962 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23963 (kill-region (point) (match-beginning 1))
23964 (org-set-tags nil t))
23965 (t (kill-region (point) (point-at-eol)))))
23967 (define-key org-mode-map "\C-k" 'org-kill-line)
23969 (defun org-yank (&optional arg)
23970 "Yank. If the kill is a subtree, treat it specially.
23971 This command will look at the current kill and check if is a single
23972 subtree, or a series of subtrees[1]. If it passes the test, and if the
23973 cursor is at the beginning of a line or after the stars of a currently
23974 empty headline, then the yank is handled specially. How exactly depends
23975 on the value of the following variables, both set by default.
23977 `org-yank-folded-subtrees'
23978 When set, the subtree(s) will be folded after insertion, but only
23979 if doing so would now swallow text after the yanked text.
23981 `org-yank-adjusted-subtrees'
23982 When set, the subtree will be promoted or demoted in order to
23983 fit into the local outline tree structure, which means that the
23984 level will be adjusted so that it becomes the smaller one of the
23985 two *visible* surrounding headings.
23987 Any prefix to this command will cause `yank' to be called directly with
23988 no special treatment. In particular, a simple \\[universal-argument] prefix \
23990 plainly yank the text as it is.
23992 \[1] The test checks if the first non-white line is a heading
23993 and if there are no other headings with fewer stars."
23995 (org-yank-generic 'yank arg))
23997 (defun org-yank-generic (command arg)
23998 "Perform some yank-like command.
24000 This function implements the behavior described in the `org-yank'
24001 documentation. However, it has been generalized to work for any
24002 interactive command with similar behavior."
24004 ;; pretend to be command COMMAND
24005 (setq this-command command)
24008 (call-interactively command)
24010 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24011 (and (org-kill-is-subtree-p)
24013 (and (looking-at "[ \t]*$")
24016 (buffer-substring (point-at-bol) (point)))))))
24019 ((and subtreep org-yank-folded-subtrees)
24020 (let ((beg (point))
24022 (if (and subtreep org-yank-adjusted-subtrees)
24023 (org-paste-subtree nil nil 'for-yank)
24024 (call-interactively command))
24028 (when (and (bolp) subtreep
24029 (not (setq swallowp
24030 (org-yank-folding-would-swallow-text beg end))))
24031 (org-with-limited-levels
24032 (or (looking-at org-outline-regexp)
24033 (re-search-forward org-outline-regexp-bol end t))
24034 (while (and (< (point) end) (looking-at org-outline-regexp))
24036 (org-cycle-show-empty-lines 'folded)
24037 (condition-case nil
24038 (outline-forward-same-level 1)
24039 (error (goto-char end))))))
24042 "Inserted text not folded because that would swallow text"))
24045 (skip-chars-forward " \t\n\r")
24046 (beginning-of-line 1)
24047 (push-mark beg 'nomsg)))
24048 ((and subtreep org-yank-adjusted-subtrees)
24049 (let ((beg (point-at-bol)))
24050 (org-paste-subtree nil nil 'for-yank)
24051 (push-mark beg 'nomsg)))
24053 (call-interactively command))))))
24055 (defun org-yank-folding-would-swallow-text (beg end)
24056 "Would hide-subtree at BEG swallow any text after END?"
24058 (org-with-limited-levels
24061 (when (or (looking-at org-outline-regexp)
24062 (re-search-forward org-outline-regexp-bol end t))
24063 (setq level (org-outline-level)))
24065 (skip-chars-forward " \t\r\n\v\f")
24067 (and (bolp) (looking-at org-outline-regexp)
24068 (<= (org-outline-level) level)))
24069 nil ; Nothing would be swallowed
24070 t))))) ; something would swallow
24072 (define-key org-mode-map "\C-y" 'org-yank)
24074 (defun org-truely-invisible-p ()
24075 "Check if point is at a character currently not visible.
24076 This version does not only check the character property, but also
24078 ;; Early versions of noutline don't have `outline-invisible-p'.
24079 (if (org-bound-and-true-p visible-mode)
24081 (outline-invisible-p)))
24083 (defun org-invisible-p2 ()
24084 "Check if point is at a character currently not visible."
24086 (if (and (eolp) (not (bobp))) (backward-char 1))
24087 ;; Early versions of noutline don't have `outline-invisible-p'.
24088 (outline-invisible-p)))
24090 (defun org-back-to-heading (&optional invisible-ok)
24091 "Call `outline-back-to-heading', but provide a better error message."
24092 (condition-case nil
24093 (outline-back-to-heading invisible-ok)
24094 (error (error "Before first headline at position %d in buffer %s"
24095 (point) (current-buffer)))))
24097 (defun org-before-first-heading-p ()
24098 "Before first heading?"
24101 (null (re-search-backward org-outline-regexp-bol nil t))))
24103 (defun org-at-heading-p (&optional ignored)
24104 (outline-on-heading-p t))
24105 ;; Compatibility alias with Org versions < 7.8.03
24106 (defalias 'org-on-heading-p 'org-at-heading-p)
24108 (defun org-in-commented-heading-p (&optional no-inheritance)
24109 "Non-nil if point is under a commented heading.
24110 This function also checks ancestors of the current headline,
24111 unless optional argument NO-INHERITANCE is non-nil."
24113 ((org-before-first-heading-p) nil)
24114 ((let ((headline (nth 4 (org-heading-components))))
24116 (let ((case-fold-search nil))
24117 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24119 (no-inheritance nil)
24121 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24123 (defun org-at-comment-p nil
24124 "Is cursor in a commented line?"
24127 (beginning-of-line)
24128 (looking-at "^[ \t]*# "))))
24130 (defun org-at-drawer-p nil
24131 "Is cursor at a drawer keyword?"
24133 (move-beginning-of-line 1)
24134 (looking-at org-drawer-regexp)))
24136 (defun org-at-block-p nil
24137 "Is cursor at a block keyword?"
24139 (move-beginning-of-line 1)
24140 (looking-at org-block-regexp)))
24142 (defun org-point-at-end-of-empty-headline ()
24143 "If point is at the end of an empty headline, return t, else nil.
24144 If the heading only contains a TODO keyword, it is still still considered
24146 (and (looking-at "[ \t]*$")
24147 (when org-todo-line-regexp
24149 (beginning-of-line 1)
24150 (let ((case-fold-search nil))
24151 (looking-at org-todo-line-regexp)
24152 (string= (match-string 3) ""))))))
24154 (defun org-at-heading-or-item-p ()
24155 (or (org-at-heading-p) (org-at-item-p)))
24157 (defun org-at-target-p ()
24158 (or (org-in-regexp org-radio-target-regexp)
24159 (org-in-regexp org-target-regexp)))
24160 ;; Compatibility alias with Org versions < 7.8.03
24161 (defalias 'org-on-target-p 'org-at-target-p)
24163 (defun org-up-heading-all (arg)
24164 "Move to the heading line of which the present line is a subheading.
24165 This function considers both visible and invisible heading lines.
24166 With argument, move up ARG levels."
24167 (if (fboundp 'outline-up-heading-all)
24168 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24169 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24171 (defun org-up-heading-safe ()
24172 "Move to the heading line of which the present line is a subheading.
24173 This version will not throw an error. It will return the level of the
24174 headline found, or nil if no higher level is found.
24176 Also, this function will be a lot faster than `outline-up-heading',
24177 because it relies on stars being the outline starters. This can really
24178 make a significant difference in outlines with very many siblings."
24179 (when (ignore-errors (org-back-to-heading t))
24180 (let ((level-up (1- (funcall outline-level))))
24181 (and (> level-up 0)
24182 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24183 (funcall outline-level)))))
24185 (defun org-first-sibling-p ()
24186 "Is this heading the first child of its parents?"
24188 (let ((re org-outline-regexp-bol)
24190 (unless (org-at-heading-p t)
24191 (user-error "Not at a heading"))
24192 (setq level (funcall outline-level))
24194 (if (not (re-search-backward re nil t))
24196 (setq l (funcall outline-level))
24199 (defun org-goto-sibling (&optional previous)
24200 "Goto the next sibling, even if it is invisible.
24201 When PREVIOUS is set, go to the previous sibling instead. Returns t
24202 when a sibling was found. When none is found, return nil and don't
24204 (let ((fun (if previous 're-search-backward 're-search-forward))
24206 (re org-outline-regexp-bol)
24208 (when (ignore-errors (org-back-to-heading t))
24209 (setq level (funcall outline-level))
24211 (or previous (forward-char 1))
24212 (while (funcall fun re nil t)
24213 (setq l (funcall outline-level))
24214 (when (< l level) (goto-char pos) (throw 'exit nil))
24215 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24219 (defun org-show-siblings ()
24220 "Show all siblings of the current headline."
24222 (while (org-goto-sibling) (org-flag-heading nil)))
24224 (while (org-goto-sibling 'previous)
24225 (org-flag-heading nil))))
24227 (defun org-goto-first-child ()
24228 "Goto the first child, even if it is invisible.
24229 Return t when a child was found. Otherwise don't move point and
24231 (let (level (pos (point)) (re org-outline-regexp-bol))
24232 (when (ignore-errors (org-back-to-heading t))
24233 (setq level (outline-level))
24235 (if (and (re-search-forward re nil t) (> (outline-level) level))
24236 (progn (goto-char (match-beginning 0)) t)
24237 (goto-char pos) nil))))
24239 (defun org-show-hidden-entry ()
24240 "Show an entry where even the heading is hidden."
24244 (defun org-flag-heading (flag &optional entry)
24245 "Flag the current heading. FLAG non-nil means make invisible.
24246 When ENTRY is non-nil, show the entire entry."
24248 (org-back-to-heading t)
24249 ;; Check if we should show the entire entry
24254 (and (outline-next-heading)
24255 (org-flag-heading nil))))
24256 (outline-flag-region (max (point-min) (1- (point)))
24257 (save-excursion (outline-end-of-heading) (point))
24260 (defun org-get-next-sibling ()
24261 "Move to next heading of the same level, and return point.
24262 If there is no such heading, return nil.
24263 This is like outline-next-sibling, but invisible headings are ok."
24264 (let ((level (funcall outline-level)))
24265 (outline-next-heading)
24266 (while (and (not (eobp)) (> (funcall outline-level) level))
24267 (outline-next-heading))
24268 (if (or (eobp) (< (funcall outline-level) level))
24272 (defun org-get-last-sibling ()
24273 "Move to previous heading of the same level, and return point.
24274 If there is no such heading, return nil."
24275 (let ((opoint (point))
24276 (level (funcall outline-level)))
24277 (outline-previous-heading)
24278 (when (and (/= (point) opoint) (outline-on-heading-p t))
24279 (while (and (> (funcall outline-level) level)
24281 (outline-previous-heading))
24282 (if (< (funcall outline-level) level)
24286 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24287 "Goto to the end of a subtree."
24288 ;; This contains an exact copy of the original function, but it uses
24289 ;; `org-back-to-heading', to make it work also in invisible
24290 ;; trees. And is uses an invisible-ok argument.
24291 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24292 ;; Furthermore, when used inside Org, finding the end of a large subtree
24293 ;; with many children and grandchildren etc, this can be much faster
24294 ;; than the outline version.
24295 (org-back-to-heading invisible-ok)
24297 (level (funcall outline-level)))
24298 (if (and (derived-mode-p 'org-mode) (< level 1000))
24299 ;; A true heading (not a plain list item), in Org-mode
24300 ;; This means we can easily find the end by looking
24301 ;; only for the right number of stars. Using a regexp to do
24302 ;; this is so much faster than using a Lisp loop.
24303 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24305 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24306 ;; something else, do it the slow way
24307 (while (and (not (eobp))
24308 (or first (> (funcall outline-level) level)))
24310 (outline-next-heading)))
24312 (if (memq (preceding-char) '(?\n ?\^M))
24314 ;; Go to end of line before heading
24316 (if (memq (preceding-char) '(?\n ?\^M))
24317 ;; leave blank line before heading
24318 (forward-char -1))))))
24321 (defun org-end-of-meta-data (&optional full)
24322 "Skip planning line and properties drawer in current entry.
24323 When optional argument FULL is non-nil, also skip empty lines,
24324 clocking lines and regular drawers at the beginning of the
24326 (org-back-to-heading t)
24328 (when (org-looking-at-p org-planning-line-re) (forward-line))
24329 (when (looking-at org-property-drawer-re)
24330 (goto-char (match-end 0))
24332 (when (and full (not (org-at-heading-p)))
24334 (let ((end (save-excursion (outline-next-heading) (point)))
24335 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24336 (while (not (eobp))
24337 (cond ((org-looking-at-p org-drawer-regexp)
24338 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24341 ((org-looking-at-p re) (forward-line))
24342 (t (throw 'exit t))))))))
24344 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24345 "Move forward to the ARG'th subheading at same level as this one.
24346 Stop at the first and last subheadings of a superior heading.
24347 Normally this only looks at visible headings, but when INVISIBLE-OK is
24348 non-nil it will also look at invisible ones."
24350 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24351 (if (and arg (< arg 0))
24352 (goto-char (point-min))
24353 (outline-next-heading))
24355 (let ((level (- (match-end 0) (match-beginning 0) 1))
24356 (f (if (and arg (< arg 0))
24357 're-search-backward
24358 're-search-forward))
24359 (count (if arg (abs arg) 1))
24361 (while (and (prog1 (> count 0)
24362 (forward-char (if (and arg (< arg 0)) -1 1)))
24363 (funcall f org-outline-regexp-bol nil 'move))
24364 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24365 (cond ((< l level) (setq count 0))
24369 (goto-char (line-beginning-position))
24370 (not (outline-invisible-p)))))
24371 (setq count (1- count))
24373 (setq result (point)))))))
24374 (goto-char result))
24375 (beginning-of-line 1)))
24377 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24378 "Move backward to the ARG'th subheading at same level as this one.
24379 Stop at the first and last subheadings of a superior heading."
24381 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24383 (defun org-next-visible-heading (arg)
24384 "Move to the next visible heading.
24386 This function wraps `outline-next-visible-heading' with
24387 `org-with-limited-levels' in order to skip over inline tasks and
24388 respect customization of `org-odd-levels-only'."
24390 (org-with-limited-levels
24391 (outline-next-visible-heading arg)))
24393 (defun org-previous-visible-heading (arg)
24394 "Move to the next visible heading.
24396 This function wraps `outline-previous-visible-heading' with
24397 `org-with-limited-levels' in order to skip over inline tasks and
24398 respect customization of `org-odd-levels-only'."
24400 (org-with-limited-levels
24401 (outline-previous-visible-heading arg)))
24403 (defun org-next-block (arg &optional backward block-regexp)
24404 "Jump to the next block.
24406 With a prefix argument ARG, jump forward ARG many blocks.
24408 When BACKWARD is non-nil, jump to the previous block.
24410 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24411 Match data is set according to this regexp when the function
24414 Return point at beginning of the opening line of found block.
24415 Throw an error if no block is found."
24417 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24418 (case-fold-search t)
24419 (search-fn (if backward #'re-search-backward #'re-search-forward))
24423 (if backward (beginning-of-line) (end-of-line))
24424 (while (and (> count 0) (funcall search-fn re nil t))
24425 (let ((element (save-excursion
24426 (goto-char (match-beginning 0))
24427 (save-match-data (org-element-at-point)))))
24428 (when (and (memq (org-element-type element)
24429 '(center-block comment-block dynamic-block
24430 example-block export-block quote-block
24431 special-block src-block verse-block))
24432 (<= (match-beginning 0)
24433 (org-element-property :post-affiliated element)))
24434 (setq last-element element)
24437 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24438 (save-match-data (org-show-context)))
24440 (user-error "No %s code blocks" (if backward "previous" "further")))))
24442 (defun org-previous-block (arg &optional block-regexp)
24443 "Jump to the previous block.
24444 With a prefix argument ARG, jump backward ARG many source blocks.
24445 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24447 (org-next-block arg t block-regexp))
24449 (defun org-forward-paragraph ()
24450 "Move forward to beginning of next paragraph or equivalent.
24452 The function moves point to the beginning of the next visible
24453 structural element, which can be a paragraph, a table, a list
24454 item, etc. It also provides some special moves for convenience:
24456 - On an affiliated keyword, jump to the beginning of the
24458 - On an item or a footnote definition, move to the second
24459 element inside, if any.
24460 - On a table or a property drawer, jump after it.
24461 - On a verse or source block, stop after blank lines."
24463 (when (eobp) (user-error "Cannot move further down"))
24464 (let* ((deactivate-mark nil)
24465 (element (org-element-at-point))
24466 (type (org-element-type element))
24467 (post-affiliated (org-element-property :post-affiliated element))
24468 (contents-begin (org-element-property :contents-begin element))
24469 (contents-end (org-element-property :contents-end element))
24470 (end (let ((end (org-element-property :end element)) (parent element))
24471 (while (and (setq parent (org-element-property :parent parent))
24472 (= (org-element-property :contents-end parent) end))
24473 (setq end (org-element-property :end parent)))
24475 (cond ((not element)
24476 (skip-chars-forward " \r\t\n")
24477 (or (eobp) (beginning-of-line)))
24478 ;; On affiliated keywords, move to element's beginning.
24479 ((< (point) post-affiliated)
24480 (goto-char post-affiliated))
24481 ;; At a table row, move to the end of the table. Similarly,
24482 ;; at a node property, move to the end of the property
24484 ((memq type '(node-property table-row))
24485 (goto-char (org-element-property
24486 :end (org-element-property :parent element))))
24487 ((memq type '(property-drawer table)) (goto-char end))
24488 ;; Consider blank lines as separators in verse and source
24489 ;; blocks to ease editing.
24490 ((memq type '(src-block verse-block))
24491 (when (eq type 'src-block)
24493 (save-excursion (goto-char end)
24494 (skip-chars-backward " \r\t\n")
24495 (line-beginning-position))))
24496 (beginning-of-line)
24497 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24498 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24500 (skip-chars-forward " \r\t\n")
24501 (if (= (point) contents-end) (goto-char end)
24502 (beginning-of-line))))
24503 ;; With no contents, just skip element.
24504 ((not contents-begin) (goto-char end))
24505 ;; If contents are invisible, skip the element altogether.
24506 ((outline-invisible-p (line-end-position))
24509 (org-with-limited-levels (outline-next-visible-heading 1)))
24510 ;; At a plain list, make sure we move to the next item
24511 ;; instead of skipping the whole list.
24512 (plain-list (forward-char)
24513 (org-forward-paragraph))
24514 (otherwise (goto-char end))))
24515 ((>= (point) contents-end) (goto-char end))
24516 ((>= (point) contents-begin)
24517 ;; This can only happen on paragraphs and plain lists.
24519 (paragraph (goto-char end))
24520 ;; At a plain list, try to move to second element in
24521 ;; first item, if possible.
24522 (plain-list (end-of-line)
24523 (org-forward-paragraph))))
24524 ;; When contents start on the middle of a line (e.g. in
24525 ;; items and footnote definitions), try to reach first
24526 ;; element starting after current line.
24527 ((> (line-end-position) contents-begin)
24529 (org-forward-paragraph))
24530 (t (goto-char contents-begin)))))
24532 (defun org-backward-paragraph ()
24533 "Move backward to start of previous paragraph or equivalent.
24535 The function moves point to the beginning of the current
24536 structural element, which can be a paragraph, a table, a list
24537 item, etc., or to the beginning of the previous visible one if
24538 point is already there. It also provides some special moves for
24541 - On an affiliated keyword, jump to the first one.
24542 - On a table or a property drawer, move to its beginning.
24543 - On a verse or source block, stop before blank lines."
24545 (when (bobp) (user-error "Cannot move further up"))
24546 (let* ((deactivate-mark nil)
24547 (element (org-element-at-point))
24548 (type (org-element-type element))
24549 (contents-begin (org-element-property :contents-begin element))
24550 (contents-end (org-element-property :contents-end element))
24551 (post-affiliated (org-element-property :post-affiliated element))
24552 (begin (org-element-property :begin element)))
24554 ((not element) (goto-char (point-min)))
24557 (org-backward-paragraph))
24558 ((<= (point) post-affiliated) (goto-char begin))
24559 ((memq type '(node-property table-row))
24560 (goto-char (org-element-property
24561 :post-affiliated (org-element-property :parent element))))
24562 ((memq type '(property-drawer table)) (goto-char begin))
24563 ((memq type '(src-block verse-block))
24564 (when (eq type 'src-block)
24565 (setq contents-begin
24566 (save-excursion (goto-char begin) (forward-line) (point))))
24567 (if (= (point) contents-begin) (goto-char post-affiliated)
24568 ;; Inside a verse block, see blank lines as paragraph
24570 (let ((origin (point)))
24571 (skip-chars-backward " \r\t\n" contents-begin)
24572 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24573 (skip-chars-forward " \r\t\n" origin)
24574 (if (= (point) origin) (goto-char contents-begin)
24575 (beginning-of-line))))))
24576 ((not contents-begin) (goto-char (or post-affiliated begin)))
24577 ((eq type 'paragraph)
24578 (goto-char contents-begin)
24579 ;; When at first paragraph in an item or a footnote definition,
24580 ;; move directly to beginning of line.
24581 (let ((parent-contents
24582 (org-element-property
24583 :contents-begin (org-element-property :parent element))))
24584 (when (and parent-contents (= parent-contents contents-begin))
24585 (beginning-of-line))))
24586 ;; At the end of a greater element, move to the beginning of the
24587 ;; last element within.
24588 ((>= (point) contents-end)
24589 (goto-char (1- contents-end))
24590 (org-backward-paragraph))
24591 (t (goto-char (or post-affiliated begin))))
24592 ;; Ensure we never leave point invisible.
24593 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24595 (defun org-forward-element ()
24596 "Move forward by one element.
24597 Move to the next element at the same level, when possible."
24599 (cond ((eobp) (user-error "Cannot move further down"))
24600 ((org-with-limited-levels (org-at-heading-p))
24601 (let ((origin (point)))
24602 (goto-char (org-end-of-subtree nil t))
24603 (unless (org-with-limited-levels (org-at-heading-p))
24605 (user-error "Cannot move further down"))))
24607 (let* ((elem (org-element-at-point))
24608 (end (org-element-property :end elem))
24609 (parent (org-element-property :parent elem)))
24610 (cond ((and parent (= (org-element-property :contents-end parent) end))
24611 (goto-char (org-element-property :end parent)))
24612 ((integer-or-marker-p end) (goto-char end))
24613 (t (message "No element at point")))))))
24615 (defun org-backward-element ()
24616 "Move backward by one element.
24617 Move to the previous element at the same level, when possible."
24619 (cond ((bobp) (user-error "Cannot move further up"))
24620 ((org-with-limited-levels (org-at-heading-p))
24621 ;; At a headline, move to the previous one, if any, or stay
24623 (let ((origin (point)))
24624 (org-with-limited-levels (org-backward-heading-same-level 1))
24625 ;; When current headline has no sibling above, move to its
24627 (when (= (point) origin)
24628 (or (org-with-limited-levels (org-up-heading-safe))
24629 (progn (goto-char origin)
24630 (user-error "Cannot move further up"))))))
24632 (let* ((elem (org-element-at-point))
24633 (beg (org-element-property :begin elem)))
24635 ;; Move to beginning of current element if point isn't
24637 ((null beg) (message "No element at point"))
24638 ((/= (point) beg) (goto-char beg))
24640 (skip-chars-backward " \r\t\n")
24642 (let ((prev (org-element-at-point)))
24643 (goto-char (org-element-property :begin prev))
24644 (while (and (setq prev (org-element-property :parent prev))
24645 (<= (org-element-property :end prev) beg))
24646 (goto-char (org-element-property :begin prev)))))))))))
24648 (defun org-up-element ()
24649 "Move to upper element."
24651 (if (org-with-limited-levels (org-at-heading-p))
24652 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24653 (let* ((elem (org-element-at-point))
24654 (parent (org-element-property :parent elem)))
24655 (if parent (goto-char (org-element-property :begin parent))
24656 (if (org-with-limited-levels (org-before-first-heading-p))
24657 (user-error "No surrounding element")
24658 (org-with-limited-levels (org-back-to-heading)))))))
24660 (defvar org-element-greater-elements)
24661 (defun org-down-element ()
24662 "Move to inner element."
24664 (let ((element (org-element-at-point)))
24666 ((memq (org-element-type element) '(plain-list table))
24667 (goto-char (org-element-property :contents-begin element))
24669 ((memq (org-element-type element) org-element-greater-elements)
24670 ;; If contents are hidden, first disclose them.
24671 (when (outline-invisible-p (line-end-position)) (org-cycle))
24672 (goto-char (or (org-element-property :contents-begin element)
24673 (user-error "No content for this element"))))
24674 (t (user-error "No inner element")))))
24676 (defun org-drag-element-backward ()
24677 "Move backward element at point."
24679 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24680 (let* ((elem (org-element-at-point))
24683 (goto-char (org-element-property :begin elem))
24684 (skip-chars-backward " \r\t\n")
24686 (let* ((beg (org-element-property :begin elem))
24687 (prev (org-element-at-point))
24689 (while (and (setq up (org-element-property :parent up))
24690 (<= (org-element-property :end up) beg))
24693 ;; Error out if no previous element or previous element is
24694 ;; a parent of the current one.
24695 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24696 (user-error "Cannot drag element backward")
24697 (let ((pos (point)))
24698 (org-element-swap-A-B prev-elem elem)
24699 (goto-char (+ (org-element-property :begin prev-elem)
24700 (- pos (org-element-property :begin elem)))))))))
24702 (defun org-drag-element-forward ()
24703 "Move forward element at point."
24705 (let* ((pos (point))
24706 (elem (org-element-at-point)))
24707 (when (= (point-max) (org-element-property :end elem))
24708 (user-error "Cannot drag element forward"))
24709 (goto-char (org-element-property :end elem))
24710 (let ((next-elem (org-element-at-point)))
24711 (when (or (org-element-nested-p elem next-elem)
24712 (and (eq (org-element-type next-elem) 'headline)
24713 (not (eq (org-element-type elem) 'headline))))
24715 (user-error "Cannot drag element forward"))
24716 ;; Compute new position of point: it's shifted by NEXT-ELEM
24717 ;; body's length (without final blanks) and by the length of
24718 ;; blanks between ELEM and NEXT-ELEM.
24719 (let ((size-next (- (save-excursion
24720 (goto-char (org-element-property :end next-elem))
24721 (skip-chars-backward " \r\t\n")
24723 ;; Small correction if buffer doesn't end
24724 ;; with a newline character.
24725 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24726 (org-element-property :begin next-elem)))
24727 (size-blank (- (org-element-property :end elem)
24729 (goto-char (org-element-property :end elem))
24730 (skip-chars-backward " \r\t\n")
24733 (org-element-swap-A-B elem next-elem)
24734 (goto-char (+ pos size-next size-blank))))))
24736 (defun org-drag-line-forward (arg)
24737 "Drag the line at point ARG lines forward."
24739 (dotimes (n (abs arg))
24740 (let ((c (current-column)))
24743 (beginning-of-line 2)
24744 (transpose-lines 1)
24745 (beginning-of-line 0))
24746 (transpose-lines 1)
24747 (beginning-of-line -1))
24748 (org-move-to-column c))))
24750 (defun org-drag-line-backward (arg)
24751 "Drag the line at point ARG lines backward."
24753 (org-drag-line-forward (- arg)))
24755 (defun org-mark-element ()
24756 "Put point at beginning of this element, mark at end.
24758 Interactively, if this command is repeated or (in Transient Mark
24759 mode) if the mark is active, it marks the next element after the
24760 ones already marked."
24762 (let (deactivate-mark)
24763 (if (and (org-called-interactively-p 'any)
24764 (or (and (eq last-command this-command) (mark t))
24765 (and transient-mark-mode mark-active)))
24769 (goto-char (org-element-property :end (org-element-at-point)))))
24770 (let ((element (org-element-at-point)))
24772 (push-mark (org-element-property :end element) t t)
24773 (goto-char (org-element-property :begin element))))))
24775 (defun org-narrow-to-element ()
24776 "Narrow buffer to current element."
24778 (let ((elem (org-element-at-point)))
24780 ((eq (car elem) 'headline)
24782 (org-element-property :begin elem)
24783 (org-element-property :end elem)))
24784 ((memq (car elem) org-element-greater-elements)
24786 (org-element-property :contents-begin elem)
24787 (org-element-property :contents-end elem)))
24790 (org-element-property :begin elem)
24791 (org-element-property :end elem))))))
24793 (defun org-transpose-element ()
24794 "Transpose current and previous elements, keeping blank lines between.
24795 Point is moved after both elements."
24797 (org-skip-whitespace)
24798 (let ((end (org-element-property :end (org-element-at-point))))
24799 (org-drag-element-backward)
24802 (defun org-unindent-buffer ()
24803 "Un-indent the visible part of the buffer.
24804 Relative indentation (between items, inside blocks, etc.) isn't
24807 (unless (eq major-mode 'org-mode)
24808 (user-error "Cannot un-indent a buffer not in Org mode"))
24809 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24810 unindent-tree ; For byte-compiler.
24816 (if (memq (org-element-type element) '(headline section))
24817 (funcall unindent-tree (org-element-contents element))
24821 (org-element-property :begin element)
24822 (org-element-property :end element))
24823 (org-do-remove-indentation)))))
24824 (reverse contents))))))
24825 (funcall unindent-tree (org-element-contents parse-tree))))
24827 (defun org-show-subtree ()
24828 "Show everything after this heading at deeper levels."
24830 (outline-flag-region
24833 (org-end-of-subtree t t))
24836 (defun org-show-entry ()
24837 "Show the body directly following this heading.
24838 Show the heading too, if it is currently invisible."
24842 (org-back-to-heading t)
24843 (outline-flag-region
24844 (max (point-min) (1- (point)))
24846 (if (re-search-forward
24847 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24848 (match-beginning 1)
24851 (org-cycle-hide-drawers 'children))))
24853 (defun org-make-options-regexp (kwds &optional extra)
24854 "Make a regular expression for keyword lines.
24855 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24856 when non-nil, is a regexp matching keywords names."
24857 (concat "^[ \t]*#\\+\\("
24859 (and extra (concat (and kwds "\\|") extra))
24860 "\\):[ \t]*\\(.*\\)"))
24862 ;; Make isearch reveal the necessary context
24863 (defun org-isearch-end ()
24864 "Reveal context after isearch exits."
24865 (when isearch-success ; only if search was successful
24866 (if (featurep 'xemacs)
24867 ;; Under XEmacs, the hook is run in the correct place,
24868 ;; we directly show the context.
24869 (org-show-context 'isearch)
24870 ;; In Emacs the hook runs *before* restoring the overlays.
24871 ;; So we have to use a one-time post-command-hook to do this.
24872 ;; (Emacs 22 has a special variable, see function `org-mode')
24873 (unless (and (boundp 'isearch-mode-end-hook-quit)
24874 isearch-mode-end-hook-quit)
24875 ;; Only when the isearch was not quitted.
24876 (org-add-hook 'post-command-hook 'org-isearch-post-command
24877 'append 'local)))))
24879 (defun org-isearch-post-command ()
24880 "Remove self from hook, and show context."
24881 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24882 (org-show-context 'isearch))
24885 ;;;; Integration with and fixes for other packages
24889 (defvar org-imenu-markers nil
24890 "All markers currently used by Imenu.")
24891 (make-variable-buffer-local 'org-imenu-markers)
24893 (defun org-imenu-new-marker (&optional pos)
24894 "Return a new marker for use by Imenu, and remember the marker."
24895 (let ((m (make-marker)))
24896 (move-marker m (or pos (point)))
24897 (push m org-imenu-markers)
24900 (defun org-imenu-get-tree ()
24901 "Produce the index for Imenu."
24902 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24903 (setq org-imenu-markers nil)
24904 (let* ((n org-imenu-depth)
24905 (re (concat "^" (org-get-limited-outline-regexp)))
24906 (subs (make-vector (1+ n) nil))
24908 m level head0 head)
24912 (goto-char (point-max))
24913 (while (re-search-backward re nil t)
24914 (setq level (org-reduced-level (funcall outline-level)))
24915 (when (and (<= level n)
24916 (looking-at org-complex-heading-regexp)
24917 (setq head0 (org-match-string-no-properties 4)))
24918 (setq head (org-link-display-format head0)
24919 m (org-imenu-new-marker))
24920 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24921 (if (>= level last-level)
24922 (push (cons head m) (aref subs level))
24923 (push (cons head (aref subs (1+ level))) (aref subs level))
24924 (loop for i from (1+ level) to n do (aset subs i nil)))
24925 (setq last-level level)))))
24928 (eval-after-load "imenu"
24930 (add-hook 'imenu-after-jump-hook
24932 (if (derived-mode-p 'org-mode)
24933 (org-show-context 'org-goto))))))
24935 (defun org-link-display-format (link)
24936 "Replace a link with its the description.
24937 If there is no description, use the link target."
24939 (if (string-match org-bracket-link-analytic-regexp link)
24940 (replace-match (if (match-end 5)
24941 (match-string 5 link)
24942 (concat (match-string 1 link)
24943 (match-string 3 link)))
24947 (defun org-toggle-link-display ()
24948 "Toggle the literal or descriptive display of links."
24950 (if org-descriptive-links
24951 (progn (org-remove-from-invisibility-spec '(org-link))
24952 (org-restart-font-lock)
24953 (setq org-descriptive-links nil))
24954 (progn (add-to-invisibility-spec '(org-link))
24955 (org-restart-font-lock)
24956 (setq org-descriptive-links t))))
24958 ;; Speedbar support
24960 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24961 "Overlay marking the agenda restriction line in speedbar.")
24962 (overlay-put org-speedbar-restriction-lock-overlay
24963 'face 'org-agenda-restriction-lock)
24964 (overlay-put org-speedbar-restriction-lock-overlay
24965 'help-echo "Agendas are currently limited to this item.")
24966 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24968 (defun org-speedbar-set-agenda-restriction ()
24969 "Restrict future agenda commands to the location at point in speedbar.
24970 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24972 (require 'org-agenda)
24973 (let (p m tp np dir txt)
24975 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24977 (setq m (get-text-property p 'org-imenu-marker))
24978 (with-current-buffer (marker-buffer m)
24980 (org-agenda-set-restriction-lock 'subtree)))
24981 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24982 'speedbar-function 'speedbar-find-file))
24983 (setq tp (previous-single-property-change
24984 (1+ p) 'speedbar-function)
24985 np (next-single-property-change
24986 tp 'speedbar-function)
24987 dir (speedbar-line-directory)
24988 txt (buffer-substring-no-properties (or tp (point-min))
24989 (or np (point-max))))
24990 (with-current-buffer (find-file-noselect
24991 (let ((default-directory dir))
24992 (expand-file-name txt)))
24993 (unless (derived-mode-p 'org-mode)
24994 (user-error "Cannot restrict to non-Org-mode file"))
24995 (org-agenda-set-restriction-lock 'file)))
24996 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24997 (move-overlay org-speedbar-restriction-lock-overlay
24998 (point-at-bol) (point-at-eol))
24999 (setq current-prefix-arg nil)
25000 (org-agenda-maybe-redo)))
25002 (defvar speedbar-file-key-map)
25003 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25004 (eval-after-load "speedbar"
25006 (speedbar-add-supported-extension ".org")
25007 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25008 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25009 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25010 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25011 (add-hook 'speedbar-visiting-tag-hook
25012 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25014 ;;; Fixes and Hacks for problems with other packages
25016 (defun org--flyspell-object-check-p (element)
25017 "Non-nil when Flyspell can check object at point.
25018 ELEMENT is the element at point."
25019 (let ((object (save-excursion
25020 (when (org-looking-at-p "\\>") (backward-char))
25021 (org-element-context element))))
25022 (case (org-element-type object)
25023 ;; Prevent checks in links due to keybinding conflict with
25025 ((code entity export-snippet inline-babel-call
25026 inline-src-block line-break latex-fragment link macro
25027 statistics-cookie target timestamp verbatim)
25029 (footnote-reference
25030 ;; Only in inline footnotes, within the definition.
25031 (and (eq (org-element-property :type object) 'inline)
25033 (goto-char (org-element-property :begin object))
25034 (search-forward ":" nil t 2))
25038 (defun org-mode-flyspell-verify ()
25039 "Function used for `flyspell-generic-check-word-predicate'."
25040 (if (org-at-heading-p)
25041 ;; At a headline or an inlinetask, check title only. This is
25042 ;; faster than relying on `org-element-at-point'.
25043 (and (save-excursion (beginning-of-line)
25044 (and (let ((case-fold-search t))
25045 (not (looking-at "\\*+ END[ \t]*$")))
25046 (looking-at org-complex-heading-regexp)))
25047 (match-beginning 4)
25048 (>= (point) (match-beginning 4))
25049 (or (not (match-beginning 5))
25050 (< (point) (match-beginning 5))))
25051 (let* ((element (org-element-at-point))
25052 (post-affiliated (org-element-property :post-affiliated element)))
25054 ;; Ignore checks in all affiliated keywords but captions.
25055 ((< (point) post-affiliated)
25056 (and (save-excursion
25057 (beginning-of-line)
25058 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25059 (> (point) (match-end 0))
25060 (org--flyspell-object-check-p element)))
25061 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25062 ((let ((log (org-log-into-drawer)))
25064 (let ((drawer (org-element-lineage element '(drawer))))
25066 (eq (compare-strings
25068 (org-element-property :drawer-name drawer) nil nil t)
25072 (case (org-element-type element)
25073 ((comment quote-section) t)
25075 ;; Allow checks between block markers, not on them.
25076 (and (> (line-beginning-position) post-affiliated)
25079 (skip-chars-forward " \r\t\n")
25080 (< (point) (org-element-property :end element)))))
25081 ;; Arbitrary list of keywords where checks are meaningful.
25082 ;; Make sure point is on the value part of the element.
25084 (and (member (org-element-property :key element)
25085 '("DESCRIPTION" "TITLE"))
25087 (search-backward ":" (line-beginning-position) t))))
25088 ;; Check is globally allowed in paragraphs verse blocks and
25089 ;; table rows (after affiliated keywords) but some objects
25090 ;; must not be affected.
25091 ((paragraph table-row verse-block)
25092 (let ((cbeg (org-element-property :contents-begin element))
25093 (cend (org-element-property :contents-end element)))
25094 (and cbeg (>= (point) cbeg) (< (point) cend)
25095 (org--flyspell-object-check-p element))))))))))
25096 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25098 (defun org-remove-flyspell-overlays-in (beg end)
25099 "Remove flyspell overlays in region."
25100 (and (org-bound-and-true-p flyspell-mode)
25101 (fboundp 'flyspell-delete-region-overlays)
25102 (flyspell-delete-region-overlays beg end)))
25104 (defvar flyspell-delayed-commands)
25105 (eval-after-load "flyspell"
25106 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25108 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25109 (eval-after-load "bookmark"
25110 '(if (boundp 'bookmark-after-jump-hook)
25111 ;; We can use the hook
25112 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25113 ;; Hook not available, use advice
25114 (defadvice bookmark-jump (after org-make-visible activate)
25115 "Make the position visible."
25116 (org-bookmark-jump-unhide))))
25118 ;; Make sure saveplace shows the location if it was hidden
25119 (eval-after-load "saveplace"
25120 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25121 "Make the position visible."
25122 (org-bookmark-jump-unhide)))
25124 ;; Make sure ecb shows the location if it was hidden
25125 (eval-after-load "ecb"
25126 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25127 "Make hierarchy visible when jumping into location from ECB tree buffer."
25128 (if (derived-mode-p 'org-mode)
25129 (org-show-context))))
25131 (defun org-bookmark-jump-unhide ()
25132 "Unhide the current position, to show the bookmark location."
25133 (and (derived-mode-p 'org-mode)
25134 (or (outline-invisible-p)
25135 (save-excursion (goto-char (max (point-min) (1- (point))))
25136 (outline-invisible-p)))
25137 (org-show-context 'bookmark-jump)))
25139 (defun org-mark-jump-unhide ()
25140 "Make the point visible with `org-show-context' after jumping to the mark."
25141 (when (and (derived-mode-p 'org-mode)
25142 (outline-invisible-p))
25143 (org-show-context 'mark-goto)))
25145 (eval-after-load "simple"
25146 '(defadvice pop-to-mark-command (after org-make-visible activate)
25147 "Make the point visible with `org-show-context'."
25148 (org-mark-jump-unhide)))
25150 (eval-after-load "simple"
25151 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25152 "Make the point visible with `org-show-context'."
25153 (org-mark-jump-unhide)))
25155 (eval-after-load "simple"
25156 '(defadvice pop-global-mark (after org-make-visible activate)
25157 "Make the point visible with `org-show-context'."
25158 (org-mark-jump-unhide)))
25160 ;; Make session.el ignore our circular variable
25161 (defvar session-globals-exclude)
25162 (eval-after-load "session"
25163 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25169 (run-hooks 'org-load-hook)
25171 ;;; org.el ends here