1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2014 Free Software Foundation, Inc.
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 (declare-function cdlatex-environment
"ext:cdlatex" (environment item
))
96 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
97 ;; some places -- e.g. see the macro `org-with-limited-levels'.
99 ;; In Org buffers, the value of `outline-regexp' is that of
100 ;; `org-outline-regexp'. The only function still directly relying on
101 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
102 ;; job when `orgstruct-mode' is active.
103 (defvar org-outline-regexp
"\\*+ "
104 "Regexp to match Org headlines.")
106 (defvar org-outline-regexp-bol
"^\\*+ "
107 "Regexp to match Org headlines.
108 This is similar to `org-outline-regexp' but additionally makes
109 sure that we are at the beginning of the line.")
111 (defvar org-heading-regexp
"^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
112 "Matches a headline, putting stars and text into groups.
113 Stars are put in group 1 and the trimmed body in group 2.")
115 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
116 (unless (boundp 'calendar-view-holidays-initially-flag
)
117 (org-defvaralias 'calendar-view-holidays-initially-flag
118 'view-calendar-holidays-initially
))
119 (unless (boundp 'calendar-view-diary-initially-flag
)
120 (org-defvaralias 'calendar-view-diary-initially-flag
121 'view-diary-entries-initially
))
122 (unless (boundp 'diary-fancy-buffer
)
123 (org-defvaralias 'diary-fancy-buffer
'fancy-diary-buffer
))
125 (declare-function org-add-archive-files
"org-archive" (files))
127 (declare-function org-inlinetask-at-task-p
"org-inlinetask" ())
128 (declare-function org-inlinetask-outline-regexp
"org-inlinetask" ())
129 (declare-function org-inlinetask-toggle-visibility
"org-inlinetask" ())
130 (declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label
))
131 (declare-function org-clock-get-last-clock-out-time
"org-clock" ())
132 (declare-function org-clock-timestamps-up
"org-clock" (&optional n
))
133 (declare-function org-clock-timestamps-down
"org-clock" (&optional n
))
134 (declare-function org-clock-remove-overlays
"org-clock" (&optional beg end noremove
))
135 (declare-function org-clock-sum
"org-clock" (&optional tstart tend headline-filter propname
))
136 (declare-function org-clock-sum-current-item
"org-clock" (&optional tstart
))
137 (declare-function org-clock-update-time-maybe
"org-clock" ())
138 (declare-function org-clocktable-shift
"org-clock" (dir n
))
140 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
141 (declare-function org-babel-do-in-edit-buffer
"ob-core" (&rest body
))
142 (declare-function orgtbl-mode
"org-table" (&optional arg
))
143 (declare-function org-clock-out
"org-clock" (&optional switch-to-state fail-quietly at-time
))
144 (declare-function org-beamer-mode
"ox-beamer" ())
145 (declare-function org-table-blank-field
"org-table" ())
146 (declare-function org-table-edit-field
"org-table" (arg))
147 (declare-function org-table-insert-row
"org-table" (&optional arg
))
148 (declare-function org-table-justify-field-maybe
"org-table" (&optional new
))
149 (declare-function org-table-calc-current-TBLFM
"org-table" (&optional arg
))
150 (declare-function org-id-get-create
"org-id" (&optional force
))
151 (declare-function org-add-archive-files
"org-archive" (files))
152 (declare-function org-id-find-id-file
"org-id" (id))
153 (declare-function org-tags-view
"org-agenda" (&optional todo-only match
))
154 (declare-function org-agenda-list
"org-agenda" (&optional arg start-day span
))
155 (declare-function org-agenda-redo
"org-agenda" (&optional all
))
156 (declare-function org-table-align
"org-table" ())
157 (declare-function org-table-begin
"org-table" (&optional table-type
))
158 (declare-function org-table-blank-field
"org-table" ())
159 (declare-function org-table-end
"org-table" (&optional table-type
))
160 (declare-function org-table-end-of-field
"org-table" (&optional n
))
161 (declare-function org-table-insert-row
"org-table" (&optional arg
))
162 (declare-function org-table-paste-rectangle
"org-table" ())
163 (declare-function org-table-maybe-eval-formula
"org-table" ())
164 (declare-function org-table-maybe-recalculate-line
"org-table" ())
165 (declare-function orgtbl-ascii-plot
"org-table" (&optional ask
))
166 (declare-function org-plot
/gnuplot
"org-plot" (&optional params
))
168 (declare-function org-element-at-point
"org-element" ())
169 (declare-function org-element-cache-reset
"org-element" (&optional all
))
170 (declare-function org-element-cache-refresh
"org-element" (pos))
171 (declare-function org-element-contents
"org-element" (element))
172 (declare-function org-element-context
"org-element" (&optional element
))
173 (declare-function org-element-interpret-data
"org-element"
174 (data &optional parent
))
175 (declare-function org-element-nested-p
"org-element" (elem-a elem-b
))
176 (declare-function org-element-parse-buffer
"org-element"
177 (&optional granularity visible-only
))
178 (declare-function org-element-property
"org-element" (property element
))
179 (declare-function org-element-put-property
"org-element"
180 (element property value
))
181 (declare-function org-element-swap-A-B
"org-element" (elem-a elem-b
))
182 (declare-function org-element-parse-buffer
"org-element"
183 (&optional granularity visible-only
))
184 (declare-function org-element-type
"org-element" (element))
186 (defsubst org-uniquify
(list)
187 "Non-destructively remove duplicate elements from LIST."
188 (let ((res (copy-sequence list
))) (delete-dups res
)))
190 (defsubst org-get-at-bol
(property)
191 "Get text property PROPERTY at the beginning of line."
192 (get-text-property (point-at-bol) property
))
194 (defsubst org-trim
(s)
195 "Remove whitespace at the beginning and the end of string S."
196 (replace-regexp-in-string
198 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s
)))
200 ;; load languages based on value of `org-babel-load-languages'
201 (defvar org-babel-load-languages
)
204 (defun org-babel-do-load-languages (sym value
)
205 "Load the languages defined in `org-babel-load-languages'."
206 (set-default sym value
)
208 (let ((active (cdr pair
)) (lang (symbol-name (car pair
))))
211 (require (intern (concat "ob-" lang
))))
213 (funcall 'fmakunbound
214 (intern (concat "org-babel-execute:" lang
)))
215 (funcall 'fmakunbound
216 (intern (concat "org-babel-expand-body:" lang
)))))))
217 org-babel-load-languages
))
219 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
221 (defun org-babel-load-file (file &optional compile
)
222 "Load Emacs Lisp source code blocks in the Org-mode FILE.
223 This function exports the source code using `org-babel-tangle'
224 and then loads the resulting file using `load-file'. With prefix
225 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
226 file to byte-code before it is loaded."
227 (interactive "fFile to load: \nP")
228 (let* ((age (lambda (file)
230 (time-subtract (current-time)
231 (nth 5 (or (file-attributes (file-truename file
))
232 (file-attributes file
)))))))
233 (base-name (file-name-sans-extension file
))
234 (exported-file (concat base-name
".el")))
235 ;; tangle if the org-mode file is newer than the elisp file
236 (unless (and (file-exists-p exported-file
)
237 (> (funcall age file
) (funcall age exported-file
)))
239 (car (org-babel-tangle-file file exported-file
"emacs-lisp"))))
242 (progn (byte-compile-file exported-file
'load
)
243 "Compiled and loaded")
244 (progn (load-file exported-file
) "Loaded"))
247 (defcustom org-babel-load-languages
'((emacs-lisp . t
))
248 "Languages which can be evaluated in Org-mode buffers.
249 This list can be used to load support for any of the languages
250 below, note that each language will depend on a different set of
251 system executables and/or Emacs modes. When a language is
252 \"loaded\", then code blocks in that language can be evaluated
253 with `org-babel-execute-src-block' bound by default to C-c
254 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
255 be set to remove code block evaluation from the C-c C-c
256 keybinding. By default only Emacs Lisp (which has no
257 requirements) is loaded."
259 :set
'org-babel-do-load-languages
261 :type
'(alist :tag
"Babel Languages"
264 (const :tag
"Awk" awk
)
267 (const :tag
"Asymptote" asymptote
)
268 (const :tag
"Calc" calc
)
269 (const :tag
"Clojure" clojure
)
270 (const :tag
"CSS" css
)
271 (const :tag
"Ditaa" ditaa
)
272 (const :tag
"Dot" dot
)
273 (const :tag
"Emacs Lisp" emacs-lisp
)
274 (const :tag
"Forth" forth
)
275 (const :tag
"Fortran" fortran
)
276 (const :tag
"Gnuplot" gnuplot
)
277 (const :tag
"Haskell" haskell
)
280 (const :tag
"Java" java
)
281 (const :tag
"Javascript" js
)
282 (const :tag
"LaTeX" latex
)
283 (const :tag
"Ledger" ledger
)
284 (const :tag
"Lilypond" lilypond
)
285 (const :tag
"Lisp" lisp
)
286 (const :tag
"Makefile" makefile
)
287 (const :tag
"Maxima" maxima
)
288 (const :tag
"Matlab" matlab
)
289 (const :tag
"Mscgen" mscgen
)
290 (const :tag
"Ocaml" ocaml
)
291 (const :tag
"Octave" octave
)
292 (const :tag
"Org" org
)
293 (const :tag
"Perl" perl
)
294 (const :tag
"Pico Lisp" picolisp
)
295 (const :tag
"PlantUML" plantuml
)
296 (const :tag
"Python" python
)
297 (const :tag
"Ruby" ruby
)
298 (const :tag
"Sass" sass
)
299 (const :tag
"Scala" scala
)
300 (const :tag
"Scheme" scheme
)
301 (const :tag
"Screen" screen
)
302 (const :tag
"Shell Script" shell
)
303 (const :tag
"Shen" shen
)
304 (const :tag
"Sql" sql
)
305 (const :tag
"Sqlite" sqlite
)
306 (const :tag
"ebnf2ps" ebnf2ps
))
307 :value-type
(boolean :tag
"Activate" :value t
)))
309 ;;;; Customization variables
310 (defcustom org-clone-delete-id nil
311 "Remove ID property of clones of a subtree.
312 When non-nil, clones of a subtree don't inherit the ID property.
313 Otherwise they inherit the ID property with a new unique
323 (defun org-version (&optional here full message
)
324 "Show the org-mode version.
325 Interactively, or when MESSAGE is non-nil, show it in echo area.
326 With prefix argument, or when HERE is non-nil, insert it at point.
327 In non-interactive uses, a reduced version string is output unless
329 (interactive (list current-prefix-arg t
(not current-prefix-arg
)))
330 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
331 (save-load-suffixes (when (boundp 'load-suffixes
) load-suffixes
))
332 (load-suffixes (list ".el"))
333 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
335 (and (fboundp 'org-release
) (fboundp 'org-git-version
))
336 (org-load-noerror-mustsuffix (concat org-dir
"org-version"))))
337 (load-suffixes save-load-suffixes
)
338 (org-version (org-release))
339 (git-version (org-git-version))
340 (version (format "Org-mode version %s (%s @ %s)"
344 (if (string= org-dir org-install-dir
)
346 (concat "mixed installation! " org-install-dir
" and " org-dir
))
347 "org-loaddefs.el can not be found!")))
348 (version1 (if full version org-version
)))
349 (when here
(insert version1
))
350 (when message
(message "%s" version1
))
353 (defconst org-version
(org-version))
360 (defconst org-block-regexp
361 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
362 "Regular expression for hiding blocks.")
364 (defconst org-dblock-start-re
365 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
366 "Matches the start line of a dynamic block, with parameters.")
368 (defconst org-dblock-end-re
"^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
369 "Matches the end of a dynamic block.")
371 ;;;; Clock and Planning
373 (defconst org-clock-string
"CLOCK:"
374 "String used as prefix for timestamps clocking work hours on an item.")
376 (defconst org-closed-string
"CLOSED:"
377 "String used as the prefix for timestamps logging closing a TODO entry.")
379 (defconst org-deadline-string
"DEADLINE:"
380 "String to mark deadline entries.
381 A deadline is this string, followed by a time stamp. Should be a word,
382 terminated by a colon. You can insert a schedule keyword and
383 a timestamp with \\[org-deadline].")
385 (defconst org-scheduled-string
"SCHEDULED:"
386 "String to mark scheduled TODO entries.
387 A schedule is this string, followed by a time stamp. Should be a word,
388 terminated by a colon. You can insert a schedule keyword and
389 a timestamp with \\[org-schedule].")
391 (defconst org-ds-keyword-length
395 (list org-deadline-string org-scheduled-string
396 org-clock-string org-closed-string
))))
397 "Maximum length of the DEADLINE and SCHEDULED keywords.")
399 (defconst org-planning-line-re
402 (list org-closed-string org-deadline-string org-scheduled-string
)
404 "Matches a line with planning info.
405 Matched keyword is in group 1.")
407 (defconst org-clock-line-re
408 (concat "^[ \t]*" org-clock-string
)
409 "Matches a line with clock info.")
411 (defconst org-deadline-regexp
(concat "\\<" org-deadline-string
)
412 "Matches the DEADLINE keyword.")
414 (defconst org-deadline-time-regexp
415 (concat "\\<" org-deadline-string
" *<\\([^>]+\\)>")
416 "Matches the DEADLINE keyword together with a time stamp.")
418 (defconst org-deadline-time-hour-regexp
419 (concat "\\<" org-deadline-string
420 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
421 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
423 (defconst org-deadline-line-regexp
424 (concat "\\<\\(" org-deadline-string
"\\).*")
425 "Matches the DEADLINE keyword and the rest of the line.")
427 (defconst org-scheduled-regexp
(concat "\\<" org-scheduled-string
)
428 "Matches the SCHEDULED keyword.")
430 (defconst org-scheduled-time-regexp
431 (concat "\\<" org-scheduled-string
" *<\\([^>]+\\)>")
432 "Matches the SCHEDULED keyword together with a time stamp.")
434 (defconst org-scheduled-time-hour-regexp
435 (concat "\\<" org-scheduled-string
436 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
437 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
439 (defconst org-closed-time-regexp
440 (concat "\\<" org-closed-string
" *\\[\\([^]]+\\)\\]")
441 "Matches the CLOSED keyword together with a time stamp.")
443 (defconst org-keyword-time-regexp
446 (list org-scheduled-string org-deadline-string org-closed-string
449 " *[[<]\\([^]>]+\\)[]>]")
450 "Matches any of the 4 keywords, together with the time stamp.")
452 (defconst org-keyword-time-not-clock-regexp
456 (list org-scheduled-string org-deadline-string org-closed-string
) t
)
457 " *[[<]\\([^]>]+\\)[]>]")
458 "Matches any of the 3 keywords, together with the time stamp.")
460 (defconst org-maybe-keyword-time-regexp
463 (list org-scheduled-string org-deadline-string org-closed-string
467 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
470 "Matches a timestamp, possibly preceded by a keyword.")
472 (defconst org-all-time-keywords
473 (mapcar (lambda (w) (substring w
0 -
1))
474 (list org-scheduled-string org-deadline-string
475 org-clock-string org-closed-string
))
476 "List of time keywords.")
480 (defconst org-drawer-regexp
"^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
481 "Matches first or last line of a hidden block.
482 Group 1 contains drawer's name or \"END\".")
484 (defconst org-property-start-re
"^[ \t]*:PROPERTIES:[ \t]*$"
485 "Regular expression matching the first line of a property drawer.")
487 (defconst org-property-end-re
"^[ \t]*:END:[ \t]*$"
488 "Regular expression matching the last line of a property drawer.")
490 (defconst org-clock-drawer-start-re
"^[ \t]*:CLOCK:[ \t]*$"
491 "Regular expression matching the first line of a clock drawer.")
493 (defconst org-clock-drawer-end-re
"^[ \t]*:END:[ \t]*$"
494 "Regular expression matching the last line of a clock drawer.")
496 (defconst org-property-drawer-re
497 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
498 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
499 "[ \t]*:END:[ \t]*$")
500 "Matches an entire property drawer.")
502 (defconst org-clock-drawer-re
503 (concat "\\(" org-clock-drawer-start-re
"\\)[^\000]*?\\("
504 org-clock-drawer-end-re
"\\)\n?")
505 "Matches an entire clock drawer.")
509 (defconst org-heading-keyword-regexp-format
510 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
511 "Printf format for a regexp matching a headline with some keyword.
512 This regexp will match the headline of any node which has the
513 exact keyword that is put into the format. The keyword isn't in
514 any group by default, but the stars and the body are.")
516 (defconst org-heading-keyword-maybe-regexp-format
517 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
518 "Printf format for a regexp matching a headline, possibly with some keyword.
519 This regexp can match any headline with the specified keyword, or
520 without a keyword. The keyword isn't in any group by default,
521 but the stars and the body are.")
523 (defconst org-archive-tag
"ARCHIVE"
524 "The tag that marks a subtree as archived.
525 An archived subtree does not open during visibility cycling, and does
526 not contribute to the agenda listings.")
528 (defconst org-comment-string
"COMMENT"
529 "Entries starting with this keyword will never be exported.
530 An entry can be toggled between COMMENT and normal with
531 \\[org-toggle-comment].")
534 ;;;; LaTeX Environments and Fragments
536 (defconst org-latex-regexps
537 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t
)
538 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
539 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
540 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil
)
541 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil
)
542 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil
)
543 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil
)
544 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil
))
545 "Regular expressions for matching embedded LaTeX.")
549 (defconst org-effort-property
"Effort"
550 "The property that is being used to keep track of effort estimates.
551 Effort estimates given in this property need to have the format H:MM.")
555 (defconst org-table-any-line-regexp
"^[ \t]*\\(|\\|\\+-[-+]\\)"
556 "Detect an org-type or table-type table.")
558 (defconst org-table-line-regexp
"^[ \t]*|"
559 "Detect an org-type table line.")
561 (defconst org-table-dataline-regexp
"^[ \t]*|[^-]"
562 "Detect an org-type table line.")
564 (defconst org-table-hline-regexp
"^[ \t]*|-"
565 "Detect an org-type table hline.")
567 (defconst org-table1-hline-regexp
"^[ \t]*\\+-[-+]"
568 "Detect a table-type table hline.")
570 (defconst org-table-any-border-regexp
"^[ \t]*[^|+ \t]"
571 "Detect the first line outside a table when searching from within it.
572 This works for both table types.")
574 (defconst org-TBLFM-regexp
"^[ \t]*#\\+TBLFM: "
575 "Detect a #+TBLFM line.")
579 (defconst org-ts-regexp
"<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
580 "Regular expression for fast time stamp matching.")
582 (defconst org-ts-regexp-inactive
583 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
584 "Regular expression for fast inactive time stamp matching.")
586 (defconst org-ts-regexp-both
"[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
587 "Regular expression for fast time stamp matching.")
589 (defconst org-ts-regexp0
590 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
591 "Regular expression matching time strings for analysis.
592 This one does not require the space after the date, so it can be used
593 on a string that terminates immediately after the date.")
595 (defconst org-ts-regexp1
"\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
596 "Regular expression matching time strings for analysis.")
598 (defconst org-ts-regexp2
(concat "<" org-ts-regexp1
"[^>\n]\\{0,16\\}>")
599 "Regular expression matching time stamps, with groups.")
601 (defconst org-ts-regexp3
(concat "[[<]" org-ts-regexp1
"[^]>\n]\\{0,16\\}[]>]")
602 "Regular expression matching time stamps (also [..]), with groups.")
604 (defconst org-tr-regexp
(concat org-ts-regexp
"--?-?" org-ts-regexp
)
605 "Regular expression matching a time stamp range.")
607 (defconst org-tr-regexp-both
608 (concat org-ts-regexp-both
"--?-?" org-ts-regexp-both
)
609 "Regular expression matching a time stamp range.")
611 (defconst org-tsr-regexp
(concat org-ts-regexp
"\\(--?-?"
612 org-ts-regexp
"\\)?")
613 "Regular expression matching a time stamp or time stamp range.")
615 (defconst org-tsr-regexp-both
616 (concat org-ts-regexp-both
"\\(--?-?"
617 org-ts-regexp-both
"\\)?")
618 "Regular expression matching a time stamp or time stamp range.
619 The time stamps may be either active or inactive.")
621 (defconst org-repeat-re
622 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
623 "Regular expression for specifying repeated events.
624 After a match, group 1 contains the repeat expression.")
626 (defconst org-time-stamp-formats
'("<%Y-%m-%d %a>" .
"<%Y-%m-%d %a %H:%M>")
627 "Formats for `format-time-string' which are used for time stamps.")
630 ;;; The custom variables
633 "Outline-based notes management and organizer."
638 (defcustom org-mode-hook nil
639 "Mode hook for Org-mode, run after the mode was turned on."
643 (defcustom org-load-hook nil
644 "Hook that is run after org.el has been loaded."
648 (defcustom org-log-buffer-setup-hook nil
649 "Hook that is run after an Org log buffer is created."
654 (defvar org-modules
) ; defined below
655 (defvar org-modules-loaded nil
656 "Have the modules been loaded already?")
658 (defun org-load-modules-maybe (&optional force
)
659 "Load all extensions listed in `org-modules'."
660 (when (or force
(not org-modules-loaded
))
662 (condition-case nil
(require ext
)
663 (error (message "Problems while trying to load feature `%s'" ext
))))
665 (setq org-modules-loaded t
)))
667 (defun org-set-modules (var value
)
668 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
670 (when (featurep 'org
)
671 (org-load-modules-maybe 'force
)
672 (org-element-cache-reset 'all
)))
674 (defcustom org-modules
'(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail
)
675 "Modules that should always be loaded together with org.el.
677 If a description starts with <C>, the file is not part of Emacs
678 and loading it will require that you have downloaded and properly
679 installed the Org mode distribution.
681 You can also use this system to load external packages (i.e. neither Org
682 core modules, nor modules from the CONTRIB directory). Just add symbols
683 to the end of the list. If the package is called org-xyz.el, then you need
684 to add the symbol `xyz', and the package must have a call to:
688 For export specific modules, see also `org-export-backends'."
690 :set
'org-set-modules
692 :package-version
'(Org .
"8.0")
695 (const :tag
" bbdb: Links to BBDB entries" org-bbdb
)
696 (const :tag
" bibtex: Links to BibTeX entries" org-bibtex
)
697 (const :tag
" crypt: Encryption of subtrees" org-crypt
)
698 (const :tag
" ctags: Access to Emacs tags with links" org-ctags
)
699 (const :tag
" docview: Links to doc-view buffers" org-docview
)
700 (const :tag
" gnus: Links to GNUS folders/messages" org-gnus
)
701 (const :tag
" habit: Track your consistency with habits" org-habit
)
702 (const :tag
" id: Global IDs for identifying entries" org-id
)
703 (const :tag
" info: Links to Info nodes" org-info
)
704 (const :tag
" inlinetask: Tasks independent of outline hierarchy" org-inlinetask
)
705 (const :tag
" irc: Links to IRC/ERC chat sessions" org-irc
)
706 (const :tag
" mhe: Links to MHE folders/messages" org-mhe
)
707 (const :tag
" mouse: Additional mouse support" org-mouse
)
708 (const :tag
" protocol: Intercept calls from emacsclient" org-protocol
)
709 (const :tag
" rmail: Links to RMAIL folders/messages" org-rmail
)
710 (const :tag
" w3m: Special cut/paste from w3m to Org-mode." org-w3m
)
712 (const :tag
"C annotate-file: Annotate a file with org syntax" org-annotate-file
)
713 (const :tag
"C bookmark: Org-mode links to bookmarks" org-bookmark
)
714 (const :tag
"C bullets: Add overlays to headlines stars" org-bullets
)
715 (const :tag
"C checklist: Extra functions for checklists in repeated tasks" org-checklist
)
716 (const :tag
"C choose: Use TODO keywords to mark decisions states" org-choose
)
717 (const :tag
"C collector: Collect properties into tables" org-collector
)
718 (const :tag
"C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend
)
719 (const :tag
"C drill: Flashcards and spaced repetition for Org-mode" org-drill
)
720 (const :tag
"C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol
)
721 (const :tag
"C eshell Support for links to working directories in eshell" org-eshell
)
722 (const :tag
"C eval-light: Evaluate inbuffer-code on demand" org-eval-light
)
723 (const :tag
"C eval: Include command output as text" org-eval
)
724 (const :tag
"C eww: Store link to url of eww" org-eww
)
725 (const :tag
"C expiry: Expiry mechanism for Org-mode entries" org-expiry
)
726 (const :tag
"C favtable: Lookup table of favorite references and links" org-favtable
)
727 (const :tag
"C git-link: Provide org links to specific file version" org-git-link
)
728 (const :tag
"C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query
)
729 (const :tag
"C invoice: Help manage client invoices in Org-mode" org-invoice
)
730 (const :tag
"C jira: Add a jira:ticket protocol to Org-mode" org-jira
)
731 (const :tag
"C learn: SuperMemo's incremental learning algorithm" org-learn
)
732 (const :tag
"C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal
)
733 (const :tag
"C mac-link: Grab links and url from various mac Applications" org-mac-link
)
734 (const :tag
"C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix
)
735 (const :tag
"C man: Support for links to manpages in Org-mode" org-man
)
736 (const :tag
"C mew: Links to Mew folders/messages" org-mew
)
737 (const :tag
"C mtags: Support for muse-like tags" org-mtags
)
738 (const :tag
"C notmuch: Provide org links to notmuch searches or messages" org-notmuch
)
739 (const :tag
"C panel: Simple routines for us with bad memory" org-panel
)
740 (const :tag
"C registry: A registry for Org-mode links" org-registry
)
741 (const :tag
"C screen: Visit screen sessions through Org-mode links" org-screen
)
742 (const :tag
"C secretary: Team management with org-mode" org-secretary
)
743 (const :tag
"C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert
)
744 (const :tag
"C toc: Table of contents for Org-mode buffer" org-toc
)
745 (const :tag
"C track: Keep up with Org-mode development" org-track
)
746 (const :tag
"C velocity Something like Notational Velocity for Org" org-velocity
)
747 (const :tag
"C vm: Links to VM folders/messages" org-vm
)
748 (const :tag
"C wikinodes: CamelCase wiki-like links" org-wikinodes
)
749 (const :tag
"C wl: Links to Wanderlust folders/messages" org-wl
)
750 (repeat :tag
"External packages" :inline t
(symbol :tag
"Package"))))
752 (defvar org-export--registered-backends
) ; From ox.el.
753 (declare-function org-export-derived-backend-p
"ox" (backend &rest backends
))
754 (declare-function org-export-backend-name
"ox" (backend))
755 (defcustom org-export-backends
'(ascii html icalendar latex
)
756 "List of export back-ends that should be always available.
758 If a description starts with <C>, the file is not part of Emacs
759 and loading it will require that you have downloaded and properly
760 installed the Org mode distribution.
762 Unlike to `org-modules', libraries in this list will not be
763 loaded along with Org, but only once the export framework is
766 This variable needs to be set before org.el is loaded. If you
767 need to make a change while Emacs is running, use the customize
768 interface or run the following code, where VAL stands for the new
769 value of the variable, after updating it:
772 \(setq org-export--registered-backends
775 \(let ((name (org-export-backend-name backend)))
779 \(and (org-export-derived-backend-p b name)
780 \(throw 'parentp t)))))))
781 org-export--registered-backends))
782 \(let ((new-list (mapcar 'org-export-backend-name
783 org-export--registered-backends)))
784 \(dolist (backend val)
786 \((not (load (format \"ox-%s\" backend) t t))
787 \(message \"Problems while trying to load export back-end `%s'\"
789 \((not (memq backend new-list)) (push backend new-list))))
790 \(set-default 'org-export-backends new-list)))
792 Adding a back-end to this list will also pull the back-end it
797 :package-version
'(Org .
"8.0")
798 :initialize
'custom-initialize-set
799 :set
(lambda (var val
)
800 (if (not (featurep 'ox
)) (set-default var val
)
801 ;; Any back-end not required anymore (not present in VAL and not
802 ;; a parent of any back-end in the new value) is removed from the
803 ;; list of registered back-ends.
804 (setq org-export--registered-backends
807 (let ((name (org-export-backend-name backend
)))
811 (and (org-export-derived-backend-p b name
)
812 (throw 'parentp t
)))))))
813 org-export--registered-backends
))
814 ;; Now build NEW-LIST of both new back-ends and required
816 (let ((new-list (mapcar 'org-export-backend-name
817 org-export--registered-backends
)))
818 (dolist (backend val
)
820 ((not (load (format "ox-%s" backend
) t t
))
821 (message "Problems while trying to load export back-end `%s'"
823 ((not (memq backend new-list
)) (push backend new-list
))))
824 ;; Set VAR to that list with fixed dependencies.
825 (set-default var new-list
))))
826 :type
'(set :greedy t
827 (const :tag
" ascii Export buffer to ASCII format" ascii
)
828 (const :tag
" beamer Export buffer to Beamer presentation" beamer
)
829 (const :tag
" html Export buffer to HTML format" html
)
830 (const :tag
" icalendar Export buffer to iCalendar format" icalendar
)
831 (const :tag
" latex Export buffer to LaTeX format" latex
)
832 (const :tag
" man Export buffer to MAN format" man
)
833 (const :tag
" md Export buffer to Markdown format" md
)
834 (const :tag
" odt Export buffer to ODT format" odt
)
835 (const :tag
" org Export buffer to Org format" org
)
836 (const :tag
" texinfo Export buffer to Texinfo format" texinfo
)
837 (const :tag
"C confluence Export buffer to Confluence Wiki format" confluence
)
838 (const :tag
"C deck Export buffer to deck.js presentations" deck
)
839 (const :tag
"C freemind Export buffer to Freemind mindmap format" freemind
)
840 (const :tag
"C groff Export buffer to Groff format" groff
)
841 (const :tag
"C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter
)
842 (const :tag
"C RSS 2.0 Export buffer to RSS 2.0 format" rss
)
843 (const :tag
"C s5 Export buffer to s5 presentations" s5
)
844 (const :tag
"C taskjuggler Export buffer to TaskJuggler format" taskjuggler
)))
849 (condition-case nil
(require (intern (format "ox-%s" backend
)))
850 (error (message "Problems while trying to load export back-end `%s'"
852 org-export-backends
))
854 (defcustom org-support-shift-select nil
855 "Non-nil means make shift-cursor commands select text when possible.
857 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
858 start selecting a region, or enlarge regions started in this way.
859 In Org-mode, in special contexts, these same keys are used for
860 other purposes, important enough to compete with shift selection.
861 Org tries to balance these needs by supporting `shift-select-mode'
862 outside these special contexts, under control of this variable.
864 The default of this variable is nil, to avoid confusing behavior. Shifted
865 cursor keys will then execute Org commands in the following contexts:
866 - on a headline, changing TODO state (left/right) and priority (up/down)
867 - on a time stamp, changing the time
868 - in a plain list item, changing the bullet type
869 - in a property definition line, switching between allowed values
870 - in the BEGIN line of a clock table (changing the time block).
871 Outside these contexts, the commands will throw an error.
873 When this variable is t and the cursor is not in a special
874 context, Org-mode will support shift-selection for making and
875 enlarging regions. To make this more effective, the bullet
876 cycling will no longer happen anywhere in an item line, but only
877 if the cursor is exactly on the bullet.
879 If you set this variable to the symbol `always', then the keys
880 will not be special in headlines, property lines, and item lines,
881 to make shift selection work there as well. If this is what you
882 want, you can use the following alternative commands: `C-c C-t'
883 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
884 can be used to switch TODO sets, `C-c -' to cycle item bullet
885 types, and properties can be edited by hand or in column view.
887 However, when the cursor is on a timestamp, shift-cursor commands
888 will still edit the time stamp - this is just too good to give up.
890 XEmacs user should have this variable set to nil, because
891 `shift-select-mode' is in Emacs 23 or later only."
894 (const :tag
"Never" nil
)
895 (const :tag
"When outside special context" t
)
896 (const :tag
"Everywhere except timestamps" always
)))
898 (defcustom org-loop-over-headlines-in-active-region nil
899 "Shall some commands act upon headlines in the active region?
901 When set to `t', some commands will be performed in all headlines
902 within the active region.
904 When set to `start-level', some commands will be performed in all
905 headlines within the active region, provided that these headlines
906 are of the same level than the first one.
908 When set to a string, those commands will be performed on the
909 matching headlines within the active region. Such string must be
910 a tags/property/todo match as it is used in the agenda tags view.
912 The list of commands is: `org-schedule', `org-deadline',
913 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
914 `org-archive-to-archive-sibling'. The archiving commands skip
915 already archived entries."
916 :type
'(choice (const :tag
"Don't loop" nil
)
917 (const :tag
"All headlines in active region" t
)
918 (const :tag
"In active region, headlines at the same level than the first one" start-level
)
919 (string :tag
"Tags/Property/Todo matcher"))
924 (defgroup org-startup nil
925 "Options concerning startup of Org-mode."
929 (defcustom org-startup-folded t
930 "Non-nil means entering Org-mode will switch to OVERVIEW.
931 This can also be configured on a per-file basis by adding one of
932 the following lines anywhere in the buffer:
934 #+STARTUP: fold (or `overview', this is equivalent)
935 #+STARTUP: nofold (or `showall', this is equivalent)
937 #+STARTUP: showeverything
939 By default, this option is ignored when Org opens agenda files
940 for the first time. If you want the agenda to honor the startup
941 option, set `org-agenda-inhibit-startup' to nil."
944 (const :tag
"nofold: show all" nil
)
945 (const :tag
"fold: overview" t
)
946 (const :tag
"content: all headlines" content
)
947 (const :tag
"show everything, even drawers" showeverything
)))
949 (defcustom org-startup-truncated t
950 "Non-nil means entering Org-mode will set `truncate-lines'.
951 This is useful since some lines containing links can be very long and
952 uninteresting. Also tables look terrible when wrapped."
956 (defcustom org-startup-indented nil
957 "Non-nil means turn on `org-indent-mode' on startup.
958 This can also be configured on a per-file basis by adding one of
959 the following lines anywhere in the buffer:
963 :group
'org-structure
965 (const :tag
"Not" nil
)
966 (const :tag
"Globally (slow on startup in large files)" t
)))
968 (defcustom org-use-sub-superscripts t
969 "Non-nil means interpret \"_\" and \"^\" for display.
971 If you want to control how Org exports those characters, see
972 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
973 used to be an alias for `org-export-with-sub-superscripts' in
974 Org <8.0, it is not anymore.
976 When this option is turned on, you can use TeX-like syntax for
977 sub- and superscripts within the buffer. Several characters after
978 \"_\" or \"^\" will be considered as a single item - so grouping
979 with {} is normally not needed. For example, the following things
980 will be parsed as single sub- or superscripts:
982 10^24 or 10^tau several digits will be considered 1 item.
983 10^-12 or 10^-tau a leading sign with digits or a word
984 x^2-y^3 will be read as x^2 - y^3, because items are
985 terminated by almost any nonword/nondigit char.
986 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
988 Still, ambiguity is possible. So when in doubt, use {} to enclose
989 the sub/superscript. If you set this variable to the symbol `{}',
990 the braces are *required* in order to trigger interpretations as
991 sub/superscript. This can be helpful in documents that need \"_\"
992 frequently in plain text."
995 :package-version
'(Org .
"8.0")
997 (const :tag
"Always interpret" t
)
998 (const :tag
"Only with braces" {})
999 (const :tag
"Never interpret" nil
)))
1001 (defcustom org-startup-with-beamer-mode nil
1002 "Non-nil means turn on `org-beamer-mode' on startup.
1003 This can also be configured on a per-file basis by adding one of
1004 the following lines anywhere in the buffer:
1011 (defcustom org-startup-align-all-tables nil
1012 "Non-nil means align all tables when visiting a file.
1013 This is useful when the column width in tables is forced with <N> cookies
1014 in table fields. Such tables will look correct only after the first re-align.
1015 This can also be configured on a per-file basis by adding one of
1016 the following lines anywhere in the buffer:
1022 (defcustom org-startup-with-inline-images nil
1023 "Non-nil means show inline images when loading a new Org file.
1024 This can also be configured on a per-file basis by adding one of
1025 the following lines anywhere in the buffer:
1026 #+STARTUP: inlineimages
1027 #+STARTUP: noinlineimages"
1032 (defcustom org-startup-with-latex-preview nil
1033 "Non-nil means preview LaTeX fragments when loading a new Org file.
1035 This can also be configured on a per-file basis by adding one of
1036 the following lines anywhere in the buffer:
1037 #+STARTUP: latexpreview
1038 #+STARTUP: nolatexpreview"
1041 :package-version
'(Org .
"8.0")
1044 (defcustom org-insert-mode-line-in-empty-file nil
1045 "Non-nil means insert the first line setting Org-mode in empty files.
1046 When the function `org-mode' is called interactively in an empty file, this
1047 normally means that the file name does not automatically trigger Org-mode.
1048 To ensure that the file will always be in Org-mode in the future, a
1049 line enforcing Org-mode will be inserted into the buffer, if this option
1054 (defcustom org-replace-disputed-keys nil
1055 "Non-nil means use alternative key bindings for some keys.
1056 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1057 These keys are also used by other packages like shift-selection-mode'
1058 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1059 If you want to use Org-mode together with one of these other modes,
1060 or more generally if you would like to move some Org-mode commands to
1061 other keys, set this variable and configure the keys with the variable
1062 `org-disputed-keys'.
1064 This option is only relevant at load-time of Org-mode, and must be set
1065 *before* org.el is loaded. Changing it requires a restart of Emacs to
1070 (defcustom org-use-extra-keys nil
1071 "Non-nil means use extra key sequence definitions for certain commands.
1072 This happens automatically if you run XEmacs or if `window-system'
1073 is nil. This variable lets you do the same manually. You must
1074 set it before loading org.
1076 Example: on Carbon Emacs 22 running graphically, with an external
1077 keyboard on a Powerbook, the default way of setting M-left might
1078 not work for either Alt or ESC. Setting this variable will make
1083 (org-defvaralias 'org-CUA-compatible
'org-replace-disputed-keys
)
1085 (defcustom org-disputed-keys
1086 '(([(shift up
)] .
[(meta p
)])
1087 ([(shift down
)] .
[(meta n
)])
1088 ([(shift left
)] .
[(meta -
)])
1089 ([(shift right
)] .
[(meta +)])
1090 ([(control shift right
)] .
[(meta shift
+)])
1091 ([(control shift left
)] .
[(meta shift -
)]))
1092 "Keys for which Org-mode and other modes compete.
1093 This is an alist, cars are the default keys, second element specifies
1094 the alternative to use when `org-replace-disputed-keys' is t.
1096 Keys can be specified in any syntax supported by `define-key'.
1097 The value of this option takes effect only at Org-mode's startup,
1098 therefore you'll have to restart Emacs to apply it after changing."
1102 (defun org-key (key)
1103 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1104 Or return the original if not disputed.
1105 Also apply the translations defined in `org-xemacs-key-equivalents'."
1106 (when org-replace-disputed-keys
1107 (let* ((nkey (key-description key
))
1108 (x (org-find-if (lambda (x)
1109 (equal (key-description (car x
)) nkey
))
1110 org-disputed-keys
)))
1111 (setq key
(if x
(cdr x
) key
))))
1112 (when (featurep 'xemacs
)
1113 (setq key
(or (cdr (assoc key org-xemacs-key-equivalents
)) key
)))
1116 (defun org-find-if (predicate seq
)
1119 (if (funcall predicate
(car seq
))
1120 (throw 'exit
(car seq
))
1123 (defun org-defkey (keymap key def
)
1124 "Define a key, possibly translated, as returned by `org-key'."
1125 (define-key keymap
(org-key key
) def
))
1127 (defcustom org-ellipsis nil
1128 "The ellipsis to use in the Org-mode outline.
1129 When nil, just use the standard three dots.
1130 When a string, use that string instead.
1131 When a face, use the standard 3 dots, but with the specified face.
1132 The change affects only Org-mode (which will then use its own display table).
1133 Changing this requires executing \\[org-mode] in a buffer to become
1136 :type
'(choice (const :tag
"Default" nil
)
1137 (face :tag
"Face" :value org-warning
)
1138 (string :tag
"String" :value
"...#")))
1140 (defvar org-display-table nil
1141 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1143 (defgroup org-keywords nil
1144 "Keywords in Org-mode."
1148 (defcustom org-closed-keep-when-no-todo nil
1149 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1151 :group
'org-keywords
1153 :package-version
'(Org .
"8.0")
1156 (defgroup org-structure nil
1157 "Options concerning the general structure of Org-mode files."
1158 :tag
"Org Structure"
1161 (defgroup org-reveal-location nil
1162 "Options about how to make context of a location visible."
1163 :tag
"Org Reveal Location"
1164 :group
'org-structure
)
1166 (defconst org-context-choice
1168 (const :tag
"Always" t
)
1169 (const :tag
"Never" nil
)
1170 (repeat :greedy t
:tag
"Individual contexts"
1172 (choice :tag
"Context"
1179 (const bookmark-jump
)
1183 "Contexts for the reveal options.")
1185 (defcustom org-show-hierarchy-above
'((default . t
))
1186 "Non-nil means show full hierarchy when revealing a location.
1187 Org-mode often shows locations in an org-mode file which might have
1188 been invisible before. When this is set, the hierarchy of headings
1189 above the exposed location is shown.
1190 Turning this off for example for sparse trees makes them very compact.
1191 Instead of t, this can also be an alist specifying this option for different
1192 contexts. Valid contexts are
1193 agenda when exposing an entry from the agenda
1194 org-goto when using the command `org-goto' on key C-c C-j
1195 occur-tree when using the command `org-occur' on key C-c /
1196 tags-tree when constructing a sparse tree based on tags matches
1197 link-search when exposing search matches associated with a link
1198 mark-goto when exposing the jump goal of a mark
1199 bookmark-jump when exposing a bookmark location
1200 isearch when exiting from an incremental search
1201 default default for all contexts not set explicitly"
1202 :group
'org-reveal-location
1203 :type org-context-choice
)
1205 (defcustom org-show-following-heading
'((default . nil
))
1206 "Non-nil means show following heading when revealing a location.
1207 Org-mode often shows locations in an org-mode file which might have
1208 been invisible before. When this is set, the heading following the
1210 Turning this off for example for sparse trees makes them very compact,
1211 but makes it harder to edit the location of the match. In such a case,
1212 use the command \\[org-reveal] to show more context.
1213 Instead of t, this can also be an alist specifying this option for different
1214 contexts. See `org-show-hierarchy-above' for valid contexts."
1215 :group
'org-reveal-location
1216 :type org-context-choice
)
1218 (defcustom org-show-siblings
'((default . nil
) (isearch t
) (bookmark-jump t
))
1219 "Non-nil means show all sibling heading when revealing a location.
1220 Org-mode often shows locations in an org-mode file which might have
1221 been invisible before. When this is set, the sibling of the current entry
1222 heading are all made visible. If `org-show-hierarchy-above' is t,
1223 the same happens on each level of the hierarchy above the current entry.
1225 By default this is on for the isearch context, off for all other contexts.
1226 Turning this off for example for sparse trees makes them very compact,
1227 but makes it harder to edit the location of the match. In such a case,
1228 use the command \\[org-reveal] to show more context.
1229 Instead of t, this can also be an alist specifying this option for different
1230 contexts. See `org-show-hierarchy-above' for valid contexts."
1231 :group
'org-reveal-location
1232 :type org-context-choice
1234 :package-version
'(Org .
"8.0"))
1236 (defcustom org-show-entry-below
'((default . nil
))
1237 "Non-nil means show the entry below a headline when revealing a location.
1238 Org-mode often shows locations in an org-mode file which might have
1239 been invisible before. When this is set, the text below the headline that is
1240 exposed is also shown.
1242 By default this is off for all contexts.
1243 Instead of t, this can also be an alist specifying this option for different
1244 contexts. See `org-show-hierarchy-above' for valid contexts."
1245 :group
'org-reveal-location
1246 :type org-context-choice
)
1248 (defcustom org-indirect-buffer-display
'other-window
1249 "How should indirect tree buffers be displayed?
1250 This applies to indirect buffers created with the commands
1251 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1253 current-window Display in the current window
1254 other-window Just display in another window.
1255 dedicated-frame Create one new frame, and re-use it each time.
1256 new-frame Make a new frame each time. Note that in this case
1257 previously-made indirect buffers are kept, and you need to
1258 kill these buffers yourself."
1259 :group
'org-structure
1260 :group
'org-agenda-windows
1262 (const :tag
"In current window" current-window
)
1263 (const :tag
"In current frame, other window" other-window
)
1264 (const :tag
"Each time a new frame" new-frame
)
1265 (const :tag
"One dedicated frame" dedicated-frame
)))
1267 (defcustom org-use-speed-commands nil
1268 "Non-nil means activate single letter commands at beginning of a headline.
1269 This may also be a function to test for appropriate locations where speed
1270 commands should be active.
1272 For example, to activate speed commands when the point is on any
1273 star at the beginning of the headline, you can do this:
1275 (setq org-use-speed-commands
1276 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1277 :group
'org-structure
1279 (const :tag
"Never" nil
)
1280 (const :tag
"At beginning of headline stars" t
)
1283 (defcustom org-speed-commands-user nil
1284 "Alist of additional speed commands.
1285 This list will be checked before `org-speed-commands-default'
1286 when the variable `org-use-speed-commands' is non-nil
1287 and when the cursor is at the beginning of a headline.
1288 The car if each entry is a string with a single letter, which must
1289 be assigned to `self-insert-command' in the global map.
1290 The cdr is either a command to be called interactively, a function
1291 to be called, or a form to be evaluated.
1292 An entry that is just a list with a single string will be interpreted
1293 as a descriptive headline that will be added when listing the speed
1294 commands in the Help buffer using the `?' speed command."
1295 :group
'org-structure
1296 :type
'(repeat :value
("k" . ignore
)
1297 (choice :value
("k" . ignore
)
1298 (list :tag
"Descriptive Headline" (string :tag
"Headline"))
1299 (cons :tag
"Letter and Command"
1300 (string :tag
"Command letter")
1305 (defcustom org-bookmark-names-plist
1306 '(:last-capture
"org-capture-last-stored"
1307 :last-refile
"org-refile-last-stored"
1308 :last-capture-marker
"org-capture-last-stored-marker")
1309 "Names for bookmarks automatically set by some Org commands.
1310 This can provide strings as names for a number of bookmarks Org sets
1311 automatically. The following keys are currently implemented:
1313 :last-capture-marker
1315 When a key does not show up in the property list, the corresponding bookmark
1317 :group
'org-structure
1320 (defgroup org-cycle nil
1321 "Options concerning visibility cycling in Org-mode."
1323 :group
'org-structure
)
1325 (defcustom org-cycle-skip-children-state-if-no-children t
1326 "Non-nil means skip CHILDREN state in entries that don't have any."
1330 (defcustom org-cycle-max-level nil
1331 "Maximum level which should still be subject to visibility cycling.
1332 Levels higher than this will, for cycling, be treated as text, not a headline.
1333 When `org-odd-levels-only' is set, a value of N in this variable actually
1334 means 2N-1 stars as the limiting headline.
1335 When nil, cycle all levels.
1336 Note that the limiting level of cycling is also influenced by
1337 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1338 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1342 (const :tag
"No limit" nil
)
1343 (integer :tag
"Maximum level")))
1345 (defcustom org-hide-block-startup nil
1346 "Non-nil means entering Org-mode will fold all blocks.
1347 This can also be set in on a per-file basis with
1349 #+STARTUP: hideblocks
1350 #+STARTUP: showblocks"
1355 (defcustom org-cycle-global-at-bob nil
1356 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1357 This makes it possible to do global cycling without having to use S-TAB or
1358 \\[universal-argument] TAB. For this special case to work, the first line
1359 of the buffer must not be a headline -- it may be empty or some other text.
1360 When used in this way, `org-cycle-hook' is disabled temporarily to make
1361 sure the cursor stays at the beginning of the buffer. When this option is
1362 nil, don't do anything special at the beginning of the buffer."
1366 (defcustom org-cycle-level-after-item
/entry-creation t
1367 "Non-nil means cycle entry level or item indentation in new empty entries.
1369 When the cursor is at the end of an empty headline, i.e., with only stars
1370 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1371 and then all possible ancestor states, before returning to the original state.
1372 This makes data entry extremely fast: M-RET to create a new headline,
1373 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1375 When the cursor is at the end of an empty plain list item, one TAB will
1376 make it a subitem, two or more tabs will back up to make this an item
1377 higher up in the item hierarchy."
1381 (defcustom org-cycle-emulate-tab t
1382 "Where should `org-cycle' emulate TAB.
1384 white Only in completely white lines
1385 whitestart Only at the beginning of lines, before the first non-white char
1386 t Everywhere except in headlines
1387 exc-hl-bol Everywhere except at the start of a headline
1388 If TAB is used in a place where it does not emulate TAB, the current subtree
1389 visibility is cycled."
1391 :type
'(choice (const :tag
"Never" nil
)
1392 (const :tag
"Only in completely white lines" white
)
1393 (const :tag
"Before first char in a line" whitestart
)
1394 (const :tag
"Everywhere except in headlines" t
)
1395 (const :tag
"Everywhere except at bol in headlines" exc-hl-bol
)))
1397 (defcustom org-cycle-separator-lines
2
1398 "Number of empty lines needed to keep an empty line between collapsed trees.
1399 If you leave an empty line between the end of a subtree and the following
1400 headline, this empty line is hidden when the subtree is folded.
1401 Org-mode will leave (exactly) one empty line visible if the number of
1402 empty lines is equal or larger to the number given in this variable.
1403 So the default 2 means at least 2 empty lines after the end of a subtree
1404 are needed to produce free space between a collapsed subtree and the
1407 If the number is negative, and the number of empty lines is at least -N,
1408 all empty lines are shown.
1410 Special case: when 0, never leave empty lines in collapsed view."
1413 (put 'org-cycle-separator-lines
'safe-local-variable
'integerp
)
1415 (defcustom org-pre-cycle-hook nil
1416 "Hook that is run before visibility cycling is happening.
1417 The function(s) in this hook must accept a single argument which indicates
1418 the new state that will be set right after running this hook. The
1419 argument is a symbol. Before a global state change, it can have the values
1420 `overview', `content', or `all'. Before a local state change, it can have
1421 the values `folded', `children', or `subtree'."
1425 (defcustom org-cycle-hook
'(org-cycle-hide-archived-subtrees
1426 org-cycle-hide-drawers
1427 org-cycle-hide-inline-tasks
1428 org-cycle-show-empty-lines
1429 org-optimize-window-after-visibility-change
)
1430 "Hook that is run after `org-cycle' has changed the buffer visibility.
1431 The function(s) in this hook must accept a single argument which indicates
1432 the new state that was set by the most recent `org-cycle' command. The
1433 argument is a symbol. After a global state change, it can have the values
1434 `overview', `contents', or `all'. After a local state change, it can have
1435 the values `folded', `children', or `subtree'."
1439 (defgroup org-edit-structure nil
1440 "Options concerning structure editing in Org-mode."
1441 :tag
"Org Edit Structure"
1442 :group
'org-structure
)
1444 (defcustom org-odd-levels-only nil
1445 "Non-nil means skip even levels and only use odd levels for the outline.
1446 This has the effect that two stars are being added/taken away in
1447 promotion/demotion commands. It also influences how levels are
1448 handled by the exporters.
1449 Changing it requires restart of `font-lock-mode' to become effective
1450 for fontification also in regions already fontified.
1451 You may also set this on a per-file basis by adding one of the following
1452 lines to the buffer:
1456 :group
'org-edit-structure
1457 :group
'org-appearance
1460 (defcustom org-adapt-indentation t
1461 "Non-nil means adapt indentation to outline node level.
1463 When this variable is set, Org assumes that you write outlines by
1464 indenting text in each node to align with the headline (after the
1465 stars). The following issues are influenced by this variable:
1467 - The indentation is increased by one space in a demotion
1468 command, and decreased by one in a promotion command. However,
1469 in the latter case, if shifting some line in the entry body
1470 would alter document structure (e.g., insert a new headline),
1471 indentation is not changed at all.
1473 - Property drawers and planning information is inserted indented
1474 when this variable is set. When nil, they will not be indented.
1476 - TAB indents a line relative to current level. The lines below
1477 a headline will be indented when this variable is set.
1479 Note that this is all about true indentation, by adding and
1480 removing space characters. See also `org-indent.el' which does
1481 level-dependent indentation in a virtual way, i.e. at display
1483 :group
'org-edit-structure
1486 (defcustom org-special-ctrl-a
/e nil
1487 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1489 When t, `C-a' will bring back the cursor to the beginning of the
1490 headline text, i.e. after the stars and after a possible TODO
1491 keyword. In an item, this will be the position after bullet and
1492 check-box, if any. When the cursor is already at that position,
1493 another `C-a' will bring it to the beginning of the line.
1495 `C-e' will jump to the end of the headline, ignoring the presence
1496 of tags in the headline. A second `C-e' will then jump to the
1497 true end of the line, after any tags. This also means that, when
1498 this variable is non-nil, `C-e' also will never jump beyond the
1499 end of the heading of a folded section, i.e. not after the
1502 When set to the symbol `reversed', the first `C-a' or `C-e' works
1503 normally, going to the true line boundary first. Only a directly
1504 following, identical keypress will bring the cursor to the
1507 This may also be a cons cell where the behavior for `C-a' and
1508 `C-e' is set separately."
1509 :group
'org-edit-structure
1511 (const :tag
"off" nil
)
1512 (const :tag
"on: after stars/bullet and before tags first" t
)
1513 (const :tag
"reversed: true line boundary first" reversed
)
1514 (cons :tag
"Set C-a and C-e separately"
1515 (choice :tag
"Special C-a"
1516 (const :tag
"off" nil
)
1517 (const :tag
"on: after stars/bullet first" t
)
1518 (const :tag
"reversed: before stars/bullet first" reversed
))
1519 (choice :tag
"Special C-e"
1520 (const :tag
"off" nil
)
1521 (const :tag
"on: before tags first" t
)
1522 (const :tag
"reversed: after tags first" reversed
)))))
1523 (org-defvaralias 'org-special-ctrl-a
'org-special-ctrl-a
/e
)
1525 (defcustom org-special-ctrl-k nil
1526 "Non-nil means `C-k' will behave specially in headlines.
1527 When nil, `C-k' will call the default `kill-line' command.
1528 When t, the following will happen while the cursor is in the headline:
1530 - When the cursor is at the beginning of a headline, kill the entire
1531 line and possible the folded subtree below the line.
1532 - When in the middle of the headline text, kill the headline up to the tags.
1533 - When after the headline text, kill the tags."
1534 :group
'org-edit-structure
1537 (defcustom org-ctrl-k-protect-subtree nil
1538 "Non-nil means, do not delete a hidden subtree with C-k.
1539 When set to the symbol `error', simply throw an error when C-k is
1540 used to kill (part-of) a headline that has hidden text behind it.
1541 Any other non-nil value will result in a query to the user, if it is
1542 OK to kill that hidden subtree. When nil, kill without remorse."
1543 :group
'org-edit-structure
1546 (const :tag
"Do not protect hidden subtrees" nil
)
1547 (const :tag
"Protect hidden subtrees with a security query" t
)
1548 (const :tag
"Never kill a hidden subtree with C-k" error
)))
1550 (defcustom org-special-ctrl-o t
1551 "Non-nil means, make `C-o' insert a row in tables."
1552 :group
'org-edit-structure
1555 (defcustom org-catch-invisible-edits nil
1556 "Check if in invisible region before inserting or deleting a character.
1559 nil Do not check, so just do invisible edits.
1560 error Throw an error and do nothing.
1561 show Make point visible, and do the requested edit.
1562 show-and-error Make point visible, then throw an error and abort the edit.
1563 smart Make point visible, and do insertion/deletion if it is
1564 adjacent to visible text and the change feels predictable.
1565 Never delete a previously invisible character or add in the
1566 middle or right after an invisible region. Basically, this
1567 allows insertion and backward-delete right before ellipses.
1568 FIXME: maybe in this case we should not even show?"
1569 :group
'org-edit-structure
1572 (const :tag
"Do not check" nil
)
1573 (const :tag
"Throw error when trying to edit" error
)
1574 (const :tag
"Unhide, but do not do the edit" show-and-error
)
1575 (const :tag
"Show invisible part and do the edit" show
)
1576 (const :tag
"Be smart and do the right thing" smart
)))
1578 (defcustom org-yank-folded-subtrees t
1579 "Non-nil means when yanking subtrees, fold them.
1580 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1581 it starts with a heading and all other headings in it are either children
1582 or siblings, then fold all the subtrees. However, do this only if no
1583 text after the yank would be swallowed into a folded tree by this action."
1584 :group
'org-edit-structure
1587 (defcustom org-yank-adjusted-subtrees nil
1588 "Non-nil means when yanking subtrees, adjust the level.
1589 With this setting, `org-paste-subtree' is used to insert the subtree, see
1590 this function for details."
1591 :group
'org-edit-structure
1594 (defcustom org-M-RET-may-split-line
'((default . t
))
1595 "Non-nil means M-RET will split the line at the cursor position.
1596 When nil, it will go to the end of the line before making a
1598 You may also set this option in a different way for different
1599 contexts. Valid contexts are:
1601 headline when creating a new headline
1602 item when creating a new item
1603 table in a table field
1604 default the value to be used for all contexts not explicitly
1606 :group
'org-structure
1609 (const :tag
"Always" t
)
1610 (const :tag
"Never" nil
)
1611 (repeat :greedy t
:tag
"Individual contexts"
1613 (choice :tag
"Context"
1621 (defcustom org-insert-heading-respect-content nil
1622 "Non-nil means insert new headings after the current subtree.
1623 When nil, the new heading is created directly after the current line.
1624 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1625 this variable on for the duration of the command."
1626 :group
'org-structure
1629 (defcustom org-blank-before-new-entry
'((heading . auto
)
1630 (plain-list-item . auto
))
1631 "Should `org-insert-heading' leave a blank line before new heading/item?
1632 The value is an alist, with `heading' and `plain-list-item' as CAR,
1633 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1634 which case Org will look at the surrounding headings/items and try to
1635 make an intelligent decision whether to insert a blank line or not.
1637 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1638 the setting here is ignored and no empty line is inserted to avoid breaking
1639 the list structure."
1640 :group
'org-edit-structure
1642 (cons (const heading
)
1643 (choice (const :tag
"Never" nil
)
1644 (const :tag
"Always" t
)
1645 (const :tag
"Auto" auto
)))
1646 (cons (const plain-list-item
)
1647 (choice (const :tag
"Never" nil
)
1648 (const :tag
"Always" t
)
1649 (const :tag
"Auto" auto
)))))
1651 (defcustom org-insert-heading-hook nil
1652 "Hook being run after inserting a new heading."
1653 :group
'org-edit-structure
1656 (defcustom org-enable-fixed-width-editor t
1657 "Non-nil means lines starting with \":\" are treated as fixed-width.
1658 This currently only means they are never auto-wrapped.
1659 When nil, such lines will be treated like ordinary lines."
1660 :group
'org-edit-structure
1663 (defcustom org-goto-auto-isearch t
1664 "Non-nil means typing characters in `org-goto' starts incremental search.
1665 When nil, you can use these keybindings to navigate the buffer:
1667 q Quit the org-goto interface
1668 n Go to the next visible heading
1669 p Go to the previous visible heading
1670 f Go one heading forward on same level
1671 b Go one heading backward on same level
1672 u Go one heading up"
1673 :group
'org-edit-structure
1676 (defgroup org-sparse-trees nil
1677 "Options concerning sparse trees in Org-mode."
1678 :tag
"Org Sparse Trees"
1679 :group
'org-structure
)
1681 (defcustom org-highlight-sparse-tree-matches t
1682 "Non-nil means highlight all matches that define a sparse tree.
1683 The highlights will automatically disappear the next time the buffer is
1684 changed by an edit command."
1685 :group
'org-sparse-trees
1688 (defcustom org-remove-highlights-with-change t
1689 "Non-nil means any change to the buffer will remove temporary highlights.
1690 Such highlights are created by `org-occur' and `org-clock-display'.
1691 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1692 The highlights created by `org-toggle-latex-fragment' always need
1693 `C-c C-x C-l' to be removed."
1694 :group
'org-sparse-trees
1699 (defcustom org-occur-hook
'(org-first-headline-recenter)
1700 "Hook that is run after `org-occur' has constructed a sparse tree.
1701 This can be used to recenter the window to show as much of the structure
1703 :group
'org-sparse-trees
1706 (defgroup org-imenu-and-speedbar nil
1707 "Options concerning imenu and speedbar in Org-mode."
1708 :tag
"Org Imenu and Speedbar"
1709 :group
'org-structure
)
1711 (defcustom org-imenu-depth
2
1712 "The maximum level for Imenu access to Org-mode headlines.
1713 This also applied for speedbar access."
1714 :group
'org-imenu-and-speedbar
1717 (defgroup org-table nil
1718 "Options concerning tables in Org-mode."
1722 (defcustom org-enable-table-editor
'optimized
1723 "Non-nil means lines starting with \"|\" are handled by the table editor.
1724 When nil, such lines will be treated like ordinary lines.
1726 When equal to the symbol `optimized', the table editor will be optimized to
1728 - Automatic overwrite mode in front of whitespace in table fields.
1729 This makes the structure of the table stay in tact as long as the edited
1730 field does not exceed the column width.
1731 - Minimize the number of realigns. Normally, the table is aligned each time
1732 TAB or RET are pressed to move to another field. With optimization this
1733 happens only if changes to a field might have changed the column width.
1734 Optimization requires replacing the functions `self-insert-command',
1735 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1736 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1737 very good at guessing when a re-align will be necessary, but you can always
1738 force one with \\[org-ctrl-c-ctrl-c].
1740 If you would like to use the optimized version in Org-mode, but the
1741 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1743 This variable can be used to turn on and off the table editor during a session,
1744 but in order to toggle optimization, a restart is required.
1746 See also the variable `org-table-auto-blank-field'."
1749 (const :tag
"off" nil
)
1751 (const :tag
"on, optimized" optimized
)))
1753 (defcustom org-self-insert-cluster-for-undo
(or (featurep 'xemacs
)
1754 (version<= emacs-version
"24.1"))
1755 "Non-nil means cluster self-insert commands for undo when possible.
1756 If this is set, then, like in the Emacs command loop, 20 consecutive
1757 characters will be undone together.
1758 This is configurable, because there is some impact on typing performance."
1762 (defcustom org-table-tab-recognizes-table.el t
1763 "Non-nil means TAB will automatically notice a table.el table.
1764 When it sees such a table, it moves point into it and - if necessary -
1765 calls `table-recognize-table'."
1766 :group
'org-table-editing
1769 (defgroup org-link nil
1770 "Options concerning links in Org-mode."
1774 (defvar org-link-abbrev-alist-local nil
1775 "Buffer-local version of `org-link-abbrev-alist', which see.
1776 The value of this is taken from the #+LINK lines.")
1777 (make-variable-buffer-local 'org-link-abbrev-alist-local
)
1779 (defcustom org-link-abbrev-alist nil
1780 "Alist of link abbreviations.
1781 The car of each element is a string, to be replaced at the start of a link.
1782 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1783 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1785 [[linkkey:tag][description]]
1787 The 'linkkey' must be a word word, starting with a letter, followed
1788 by letters, numbers, '-' or '_'.
1790 If REPLACE is a string, the tag will simply be appended to create the link.
1791 If the string contains \"%s\", the tag will be inserted there. If the string
1792 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1793 at that point (see the function `url-hexify-string'). If the string contains
1794 the specifier \"%(my-function)\", then the custom function `my-function' will
1795 be invoked: this function takes the tag as its only argument and must return
1798 REPLACE may also be a function that will be called with the tag as the
1799 only argument to create the link, which should be returned as a string.
1801 See the manual for examples."
1805 (string :tag
"Protocol")
1807 (string :tag
"Format")
1810 (defcustom org-descriptive-links t
1811 "Non-nil means Org will display descriptive links.
1812 E.g. [[http://orgmode.org][Org website]] will be displayed as
1813 \"Org Website\", hiding the link itself and just displaying its
1814 description. When set to `nil', Org will display the full links
1817 You can interactively set the value of this variable by calling
1818 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1822 (defcustom org-link-file-path-type
'adaptive
1823 "How the path name in file links should be stored.
1826 relative Relative to the current directory, i.e. the directory of the file
1827 into which the link is being inserted.
1828 absolute Absolute path, if possible with ~ for home directory.
1829 noabbrev Absolute path, no abbreviation of home directory.
1830 adaptive Use relative path for files in the current directory and sub-
1831 directories of it. For other files, use an absolute path."
1839 (defvaralias 'org-activate-links
'org-highlight-links
)
1840 (defcustom org-highlight-links
'(bracket angle plain radio tag date footnote
)
1841 "Types of links that should be highlighted in Org-mode files.
1843 This is a list of symbols, each one of them leading to the
1844 highlighting of a certain link type.
1846 You can still open links that are not highlighted.
1848 In principle, it does not hurt to turn on highlighting for all
1849 link types. There may be a small gain when turning off unused
1850 link types. The types are:
1852 bracket The recommended [[link][description]] or [[link]] links with hiding.
1853 angle Links in angular brackets that may contain whitespace like
1854 <bbdb:Carsten Dominik>.
1855 plain Plain links in normal text, no whitespace, like http://google.com.
1856 radio Text that is matched by a radio target, see manual for details.
1857 tag Tag settings in a headline (link to tag search).
1858 date Time stamps (link to calendar).
1859 footnote Footnote labels.
1861 If you set this variable during an Emacs session, use `org-mode-restart'
1862 in the Org buffer so that the change takes effect."
1864 :group
'org-appearance
1865 :type
'(set :greedy t
1866 (const :tag
"Double bracket links" bracket
)
1867 (const :tag
"Angular bracket links" angle
)
1868 (const :tag
"Plain text links" plain
)
1869 (const :tag
"Radio target matches" radio
)
1870 (const :tag
"Tags" tag
)
1871 (const :tag
"Timestamps" date
)
1872 (const :tag
"Footnotes" footnote
)))
1874 (defcustom org-make-link-description-function nil
1875 "Function to use for generating link descriptions from links.
1876 When nil, the link location will be used. This function must take
1877 two parameters: the first one is the link, the second one is the
1878 description generated by `org-insert-link'. The function should
1879 return the description to use."
1881 :type
'(choice (const nil
) (function)))
1883 (defgroup org-link-store nil
1884 "Options concerning storing links in Org-mode."
1885 :tag
"Org Store Link"
1888 (defcustom org-url-hexify-p t
1889 "When non-nil, hexify URL when creating a link."
1892 :group
'org-link-store
)
1894 (defcustom org-email-link-description-format
"Email %c: %.30s"
1895 "Format of the description part of a link to an email or usenet message.
1896 The following %-escapes will be replaced by corresponding information:
1898 %F full \"From\" field
1899 %f name, taken from \"From\" field, address if no name
1900 %T full \"To\" field
1901 %t first name in \"To\" field, address if no name
1902 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1903 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1908 You may use normal field width specification between the % and the letter.
1909 This is for example useful to limit the length of the subject.
1911 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1912 :group
'org-link-store
1915 (defcustom org-from-is-user-regexp
1917 (when (and user-mail-address
(not (string= user-mail-address
"")))
1918 (setq r1
(concat "\\<" (regexp-quote user-mail-address
) "\\>")))
1919 (when (and user-full-name
(not (string= user-full-name
"")))
1920 (setq r2
(concat "\\<" (regexp-quote user-full-name
) "\\>")))
1921 (if (and r1 r2
) (concat r1
"\\|" r2
) (or r1 r2
)))
1922 "Regexp matched against the \"From:\" header of an email or usenet message.
1923 It should match if the message is from the user him/herself."
1924 :group
'org-link-store
1927 (defcustom org-context-in-file-links t
1928 "Non-nil means file links from `org-store-link' contain context.
1929 A search string will be added to the file name with :: as separator and
1930 used to find the context when the link is activated by the command
1931 `org-open-at-point'. When this option is t, the entire active region
1932 will be placed in the search string of the file link. If set to a
1933 positive integer, only the first n lines of context will be stored.
1935 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1936 negates this setting for the duration of the command."
1937 :group
'org-link-store
1938 :type
'(choice boolean integer
))
1940 (defcustom org-keep-stored-link-after-insertion nil
1941 "Non-nil means keep link in list for entire session.
1943 The command `org-store-link' adds a link pointing to the current
1944 location to an internal list. These links accumulate during a session.
1945 The command `org-insert-link' can be used to insert links into any
1946 Org-mode file (offering completion for all stored links). When this
1947 option is nil, every link which has been inserted once using \\[org-insert-link]
1948 will be removed from the list, to make completing the unused links
1950 :group
'org-link-store
1953 (defgroup org-link-follow nil
1954 "Options concerning following links in Org-mode."
1955 :tag
"Org Follow Link"
1958 (defcustom org-link-translation-function nil
1959 "Function to translate links with different syntax to Org syntax.
1960 This can be used to translate links created for example by the Planner
1961 or emacs-wiki packages to Org syntax.
1962 The function must accept two parameters, a TYPE containing the link
1963 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1964 which is everything after the link protocol. It should return a cons
1965 with possibly modified values of type and path.
1966 Org contains a function for this, so if you set this variable to
1967 `org-translate-link-from-planner', you should be able follow many
1968 links created by planner."
1969 :group
'org-link-follow
1970 :type
'(choice (const nil
) (function)))
1972 (defcustom org-follow-link-hook nil
1973 "Hook that is run after a link has been followed."
1974 :group
'org-link-follow
1977 (defcustom org-tab-follows-link nil
1978 "Non-nil means on links TAB will follow the link.
1979 Needs to be set before org.el is loaded.
1980 This really should not be used, it does not make sense, and the
1981 implementation is bad."
1982 :group
'org-link-follow
1985 (defcustom org-return-follows-link nil
1986 "Non-nil means on links RET will follow the link.
1987 In tables, the special behavior of RET has precedence."
1988 :group
'org-link-follow
1991 (defcustom org-mouse-1-follows-link
1992 (if (boundp 'mouse-1-click-follows-link
) mouse-1-click-follows-link t
)
1993 "Non-nil means mouse-1 on a link will follow the link.
1994 A longer mouse click will still set point. Does not work on XEmacs.
1995 Needs to be set before org.el is loaded."
1996 :group
'org-link-follow
1998 :package-version
'(Org .
"8.3")
2000 (const :tag
"A double click follows the link" double
)
2001 (const :tag
"Unconditionally follow the link with mouse-1" t
)
2002 (integer :tag
"mouse-1 click does not follow the link if longer than N ms" 450)))
2004 (defcustom org-mark-ring-length
4
2005 "Number of different positions to be recorded in the ring.
2006 Changing this requires a restart of Emacs to work correctly."
2007 :group
'org-link-follow
2010 (defcustom org-link-search-must-match-exact-headline
'query-to-create
2011 "Non-nil means internal links in Org files must exactly match a headline.
2012 When nil, the link search tries to match a phrase with all words
2013 in the search text."
2014 :group
'org-link-follow
2017 (const :tag
"Use fuzzy text search" nil
)
2018 (const :tag
"Match only exact headline" t
)
2019 (const :tag
"Match exact headline or query to create it"
2022 (defcustom org-link-frame-setup
2023 '((vm . vm-visit-folder-other-frame
)
2024 (vm-imap . vm-visit-imap-folder-other-frame
)
2025 (gnus . org-gnus-no-new-news
)
2026 (file . find-file-other-window
)
2027 (wl . wl-other-frame
))
2028 "Setup the frame configuration for following links.
2029 When following a link with Emacs, it may often be useful to display
2030 this link in another window or frame. This variable can be used to
2031 set this up for the different types of links.
2034 `vm-visit-folder-other-window'
2035 `vm-visit-folder-other-frame'
2036 For Gnus, use any of
2039 `org-gnus-no-new-news'
2040 For FILE, use any of
2042 `find-file-other-window'
2043 `find-file-other-frame'
2044 For Wanderlust use any of
2047 For the calendar, use the variable `calendar-setup'.
2048 For BBDB, it is currently only possible to display the matches in
2050 :group
'org-link-follow
2054 (const vm-visit-folder
)
2055 (const vm-visit-folder-other-window
)
2056 (const vm-visit-folder-other-frame
)))
2057 (cons (const vm-imap
)
2059 (const vm-visit-imap-folder
)
2060 (const vm-visit-imap-folder-other-window
)
2061 (const vm-visit-imap-folder-other-frame
)))
2065 (const gnus-other-frame
)
2066 (const org-gnus-no-new-news
)))
2070 (const find-file-other-window
)
2071 (const find-file-other-frame
)))
2075 (const wl-other-frame
)))))
2077 (defcustom org-display-internal-link-with-indirect-buffer nil
2078 "Non-nil means use indirect buffer to display infile links.
2079 Activating internal links (from one location in a file to another location
2080 in the same file) normally just jumps to the location. When the link is
2081 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2083 another window. When this option is set, the other window actually displays
2084 an indirect buffer clone of the current buffer, to avoid any visibility
2085 changes to the current buffer."
2086 :group
'org-link-follow
2089 (defcustom org-open-non-existing-files nil
2090 "Non-nil means `org-open-file' will open non-existing files.
2091 When nil, an error will be generated.
2092 This variable applies only to external applications because they
2093 might choke on non-existing files. If the link is to a file that
2094 will be opened in Emacs, the variable is ignored."
2095 :group
'org-link-follow
2098 (defcustom org-open-directory-means-index-dot-org nil
2099 "Non-nil means a link to a directory really means to index.org.
2100 When nil, following a directory link will run dired or open a finder/explorer
2101 window on that directory."
2102 :group
'org-link-follow
2105 (defcustom org-confirm-shell-link-function
'yes-or-no-p
2106 "Non-nil means ask for confirmation before executing shell links.
2107 Shell links can be dangerous: just think about a link
2109 [[shell:rm -rf ~/*][Google Search]]
2111 This link would show up in your Org-mode document as \"Google Search\",
2112 but really it would remove your entire home directory.
2113 Therefore we advise against setting this variable to nil.
2114 Just change it to `y-or-n-p' if you want to confirm with a
2115 single keystroke rather than having to type \"yes\"."
2116 :group
'org-link-follow
2118 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2119 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2120 (const :tag
"no confirmation (dangerous)" nil
)))
2121 (put 'org-confirm-shell-link-function
2122 'safe-local-variable
2123 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2125 (defcustom org-confirm-shell-link-not-regexp
""
2126 "A regexp to skip confirmation for shell links."
2127 :group
'org-link-follow
2131 (defcustom org-confirm-elisp-link-function
'yes-or-no-p
2132 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2133 Elisp links can be dangerous: just think about a link
2135 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2137 This link would show up in your Org-mode document as \"Google Search\",
2138 but really it would remove your entire home directory.
2139 Therefore we advise against setting this variable to nil.
2140 Just change it to `y-or-n-p' if you want to confirm with a
2141 single keystroke rather than having to type \"yes\"."
2142 :group
'org-link-follow
2144 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2145 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2146 (const :tag
"no confirmation (dangerous)" nil
)))
2147 (put 'org-confirm-shell-link-function
2148 'safe-local-variable
2149 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2151 (defcustom org-confirm-elisp-link-not-regexp
""
2152 "A regexp to skip confirmation for Elisp links."
2153 :group
'org-link-follow
2157 (defconst org-file-apps-defaults-gnu
2161 "Default file applications on a UNIX or GNU/Linux system.
2162 See `org-file-apps'.")
2164 (defconst org-file-apps-defaults-macosx
2167 (system .
"open %s")
2169 ("eps.gz" .
"gv %s")
2171 ("fig" .
"xfig %s"))
2172 "Default file applications on a MacOS X system.
2173 The system \"open\" is known as a default, but we use X11 applications
2174 for some files for which the OS does not have a good default.
2175 See `org-file-apps'.")
2177 (defconst org-file-apps-defaults-windowsnt
2181 (list (if (featurep 'xemacs
)
2182 'mswindows-shell-execute
2186 (list (if (featurep 'xemacs
)
2187 'mswindows-shell-execute
2190 "Default file applications on a Windows NT system.
2191 The system \"open\" is used for most files.
2192 See `org-file-apps'.")
2194 (defcustom org-file-apps
2195 '((auto-mode . emacs
)
2196 ("\\.mm\\'" . default
)
2197 ("\\.x?html?\\'" . default
)
2198 ("\\.pdf\\'" . default
))
2199 "External applications for opening `file:path' items in a document.
2200 Org-mode uses system defaults for different file types, but
2201 you can use this variable to set the application for a given file
2202 extension. The entries in this list are cons cells where the car identifies
2203 files and the cdr the corresponding command. Possible values for the
2205 \"string\" A string as a file identifier can be interpreted in different
2206 ways, depending on its contents:
2208 - Alphanumeric characters only:
2209 Match links with this file extension.
2210 Example: (\"pdf\" . \"evince %s\")
2211 to open PDFs with evince.
2213 - Regular expression: Match links where the
2214 filename matches the regexp. If you want to
2215 use groups here, use shy groups.
2217 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2218 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2219 to open *.html and *.xhtml with firefox.
2221 - Regular expression which contains (non-shy) groups:
2222 Match links where the whole link, including \"::\", and
2223 anything after that, matches the regexp.
2224 In a custom command string, %1, %2, etc. are replaced with
2225 the parts of the link that were matched by the groups.
2226 For backwards compatibility, if a command string is given
2227 that does not use any of the group matches, this case is
2228 handled identically to the second one (i.e. match against
2230 In a custom lisp form, you can access the group matches with
2231 (match-string n link).
2233 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2234 to open [[file:document.pdf::5]] with evince at page 5.
2236 `directory' Matches a directory
2237 `remote' Matches a remote file, accessible through tramp or efs.
2238 Remote files most likely should be visited through Emacs
2239 because external applications cannot handle such paths.
2240 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2241 so all files Emacs knows how to handle. Using this with
2242 command `emacs' will open most files in Emacs. Beware that this
2243 will also open html files inside Emacs, unless you add
2244 (\"html\" . default) to the list as well.
2245 t Default for files not matched by any of the other options.
2246 `system' The system command to open files, like `open' on Windows
2247 and Mac OS X, and mailcap under GNU/Linux. This is the command
2248 that will be selected if you call `C-c C-o' with a double
2249 \\[universal-argument] \\[universal-argument] prefix.
2251 Possible values for the command are:
2252 `emacs' The file will be visited by the current Emacs process.
2253 `default' Use the default application for this file type, which is the
2254 association for t in the list, most likely in the system-specific
2256 This can be used to overrule an unwanted setting in the
2257 system-specific variable.
2258 `system' Use the system command for opening files, like \"open\".
2259 This command is specified by the entry whose car is `system'.
2260 Most likely, the system-specific version of this variable
2261 does define this command, but you can overrule/replace it
2263 string A command to be executed by a shell; %s will be replaced
2264 by the path to the file.
2265 sexp A Lisp form which will be evaluated. The file path will
2266 be available in the Lisp variable `file'.
2267 For more examples, see the system specific constants
2268 `org-file-apps-defaults-macosx'
2269 `org-file-apps-defaults-windowsnt'
2270 `org-file-apps-defaults-gnu'."
2271 :group
'org-link-follow
2273 (cons (choice :value
""
2274 (string :tag
"Extension")
2275 (const :tag
"System command to open files" system
)
2276 (const :tag
"Default for unrecognized files" t
)
2277 (const :tag
"Remote file" remote
)
2278 (const :tag
"Links to a directory" directory
)
2279 (const :tag
"Any files that have Emacs modes"
2282 (const :tag
"Visit with Emacs" emacs
)
2283 (const :tag
"Use default" default
)
2284 (const :tag
"Use the system command" system
)
2285 (string :tag
"Command")
2286 (sexp :tag
"Lisp form")))))
2288 (defcustom org-doi-server-url
"http://dx.doi.org/"
2289 "The URL of the DOI server."
2292 :group
'org-link-follow
)
2294 (defgroup org-refile nil
2295 "Options concerning refiling entries in Org-mode."
2299 (defcustom org-directory
"~/org"
2300 "Directory with org files.
2301 This is just a default location to look for Org files. There is no need
2302 at all to put your files into this directory. It is only used in the
2303 following situations:
2305 1. When a capture template specifies a target file that is not an
2306 absolute path. The path will then be interpreted relative to
2308 2. When a capture note is filed away in an interactive way (when exiting the
2309 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2310 with `org-directory' as the default path."
2315 (defcustom org-default-notes-file
(convert-standard-filename "~/.notes")
2316 "Default target for storing notes.
2317 Used as a fall back file for org-capture.el, for templates that
2318 do not specify a target file."
2322 (const :tag
"Default from remember-data-file" nil
)
2325 (defcustom org-goto-interface
'outline
2326 "The default interface to be used for `org-goto'.
2328 outline The interface shows an outline of the relevant file
2329 and the correct heading is found by moving through
2330 the outline or by searching with incremental search.
2331 outline-path-completion Headlines in the current buffer are offered via
2332 completion. This is the interface also used by
2333 the refile command."
2336 (const :tag
"Outline" outline
)
2337 (const :tag
"Outline-path-completion" outline-path-completion
)))
2339 (defcustom org-goto-max-level
5
2340 "Maximum target level when running `org-goto' with refile interface."
2344 (defcustom org-reverse-note-order nil
2345 "Non-nil means store new notes at the beginning of a file or entry.
2346 When nil, new notes will be filed to the end of a file or entry.
2347 This can also be a list with cons cells of regular expressions that
2348 are matched against file names, and values."
2352 (const :tag
"Reverse always" t
)
2353 (const :tag
"Reverse never" nil
)
2354 (repeat :tag
"By file name regexp"
2355 (cons regexp boolean
))))
2357 (defcustom org-log-refile nil
2358 "Information to record when a task is refiled.
2360 Possible values are:
2362 nil Don't add anything
2363 time Add a time stamp to the task
2364 note Prompt for a note and add it with template `org-log-note-headings'
2366 This option can also be set with on a per-file-basis with
2368 #+STARTUP: nologrefile
2369 #+STARTUP: logrefile
2370 #+STARTUP: lognoterefile
2372 You can have local logging settings for a subtree by setting the LOGGING
2373 property to one or more of these keywords.
2375 When bulk-refiling from the agenda, the value `note' is forbidden and
2376 will temporarily be changed to `time'."
2378 :group
'org-progress
2381 (const :tag
"No logging" nil
)
2382 (const :tag
"Record timestamp" time
)
2383 (const :tag
"Record timestamp with note." note
)))
2385 (defcustom org-refile-targets nil
2386 "Targets for refiling entries with \\[org-refile].
2387 This is a list of cons cells. Each cell contains:
2388 - a specification of the files to be considered, either a list of files,
2389 or a symbol whose function or variable value will be used to retrieve
2390 a file name or a list of file names. If you use `org-agenda-files' for
2391 that, all agenda files will be scanned for targets. Nil means consider
2392 headings in the current buffer.
2393 - A specification of how to find candidate refile targets. This may be
2395 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2396 This tag has to be present in all target headlines, inheritance will
2398 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2400 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2401 headlines that are refiling targets.
2402 - a cons cell (:level . N). Any headline of level N is considered a target.
2403 Note that, when `org-odd-levels-only' is set, level corresponds to
2404 order in hierarchy, not to the number of stars.
2405 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2406 Note that, when `org-odd-levels-only' is set, level corresponds to
2407 order in hierarchy, not to the number of stars.
2409 Each element of this list generates a set of possible targets.
2410 The union of these sets is presented (with completion) to
2411 the user by `org-refile'.
2413 You can set the variable `org-refile-target-verify-function' to a function
2414 to verify each headline found by the simple criteria above.
2416 When this variable is nil, all top-level headlines in the current buffer
2417 are used, equivalent to the value `((nil . (:level . 1))'."
2421 (choice :value org-agenda-files
2422 (const :tag
"All agenda files" org-agenda-files
)
2423 (const :tag
"Current buffer" nil
)
2424 (function) (variable) (file))
2425 (choice :tag
"Identify target headline by"
2426 (cons :tag
"Specific tag" (const :value
:tag
) (string))
2427 (cons :tag
"TODO keyword" (const :value
:todo
) (string))
2428 (cons :tag
"Regular expression" (const :value
:regexp
) (regexp))
2429 (cons :tag
"Level number" (const :value
:level
) (integer))
2430 (cons :tag
"Max Level number" (const :value
:maxlevel
) (integer))))))
2432 (defcustom org-refile-target-verify-function nil
2433 "Function to verify if the headline at point should be a refile target.
2434 The function will be called without arguments, with point at the
2435 beginning of the headline. It should return t and leave point
2436 where it is if the headline is a valid target for refiling.
2438 If the target should not be selected, the function must return nil.
2439 In addition to this, it may move point to a place from where the search
2440 should be continued. For example, the function may decide that the entire
2441 subtree of the current entry should be excluded and move point to the end
2448 (defcustom org-refile-use-cache nil
2449 "Non-nil means cache refile targets to speed up the process.
2450 The cache for a particular file will be updated automatically when
2451 the buffer has been killed, or when any of the marker used for flagging
2452 refile targets no longer points at a live buffer.
2453 If you have added new entries to a buffer that might themselves be targets,
2454 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2455 find that easier, `C-u C-u C-u C-c C-w'."
2460 (defcustom org-refile-use-outline-path nil
2461 "Non-nil means provide refile targets as paths.
2462 So a level 3 headline will be available as level1/level2/level3.
2464 When the value is `file', also include the file name (without directory)
2465 into the path. In this case, you can also stop the completion after
2466 the file name, to get entries inserted as top level in the file.
2468 When `full-file-path', include the full file path."
2471 (const :tag
"Not" nil
)
2472 (const :tag
"Yes" t
)
2473 (const :tag
"Start with file name" file
)
2474 (const :tag
"Start with full file path" full-file-path
)))
2476 (defcustom org-outline-path-complete-in-steps t
2477 "Non-nil means complete the outline path in hierarchical steps.
2478 When Org-mode uses the refile interface to select an outline path
2479 \(see variable `org-refile-use-outline-path'), the completion of
2480 the path can be done is a single go, or if can be done in steps down
2481 the headline hierarchy. Going in steps is probably the best if you
2482 do not use a special completion package like `ido' or `icicles'.
2483 However, when using these packages, going in one step can be very
2484 fast, while still showing the whole path to the entry."
2488 (defcustom org-refile-allow-creating-parent-nodes nil
2489 "Non-nil means allow to create new nodes as refile targets.
2490 New nodes are then created by adding \"/new node name\" to the completion
2491 of an existing node. When the value of this variable is `confirm',
2492 new node creation must be confirmed by the user (recommended).
2493 When nil, the completion must match an existing entry.
2495 Note that, if the new heading is not seen by the criteria
2496 listed in `org-refile-targets', multiple instances of the same
2497 heading would be created by trying again to file under the new
2501 (const :tag
"Never" nil
)
2502 (const :tag
"Always" t
)
2503 (const :tag
"Prompt for confirmation" confirm
)))
2505 (defcustom org-refile-active-region-within-subtree nil
2506 "Non-nil means also refile active region within a subtree.
2508 By default `org-refile' doesn't allow refiling regions if they
2509 don't contain a set of subtrees, but it might be convenient to
2510 do so sometimes: in that case, the first line of the region is
2511 converted to a headline before refiling."
2516 (defgroup org-todo nil
2517 "Options concerning TODO items in Org-mode."
2521 (defgroup org-progress nil
2522 "Options concerning Progress logging in Org-mode."
2526 (defvar org-todo-interpretation-widgets
2527 '((:tag
"Sequence (cycling hits every state)" sequence
)
2528 (:tag
"Type (cycling directly to DONE)" type
))
2529 "The available interpretation symbols for customizing `org-todo-keywords'.
2530 Interested libraries should add to this list.")
2532 (defcustom org-todo-keywords
'((sequence "TODO" "DONE"))
2533 "List of TODO entry keyword sequences and their interpretation.
2534 \\<org-mode-map>This is a list of sequences.
2536 Each sequence starts with a symbol, either `sequence' or `type',
2537 indicating if the keywords should be interpreted as a sequence of
2538 action steps, or as different types of TODO items. The first
2539 keywords are states requiring action - these states will select a headline
2540 for inclusion into the global TODO list Org-mode produces. If one of
2541 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2542 signify that no further action is necessary. If \"|\" is not found,
2543 the last keyword is treated as the only DONE state of the sequence.
2545 The command \\[org-todo] cycles an entry through these states, and one
2546 additional state where no keyword is present. For details about this
2547 cycling, see the manual.
2549 TODO keywords and interpretation can also be set on a per-file basis with
2550 the special #+SEQ_TODO and #+TYP_TODO lines.
2552 Each keyword can optionally specify a character for fast state selection
2553 \(in combination with the variable `org-use-fast-todo-selection')
2554 and specifiers for state change logging, using the same syntax that
2555 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2556 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2557 indicates to record a time stamp each time this state is selected.
2559 Each keyword may also specify if a timestamp or a note should be
2560 recorded when entering or leaving the state, by adding additional
2561 characters in the parenthesis after the keyword. This looks like this:
2562 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2563 record only the time of the state change. With X and Y being either
2564 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2565 Y when leaving the state if and only if the *target* state does not
2566 define X. You may omit any of the fast-selection key or X or /Y,
2567 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2569 For backward compatibility, this variable may also be just a list
2570 of keywords. In this case the interpretation (sequence or type) will be
2571 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2573 :group
'org-keywords
2575 (repeat :tag
"Old syntax, just keywords"
2576 (string :tag
"Keyword"))
2577 (repeat :tag
"New syntax"
2580 :tag
"Interpretation"
2581 ;;Quick and dirty way to see
2582 ;;`org-todo-interpretations'. This takes the
2583 ;;place of item arguments
2591 org-todo-interpretation-widgets
))
2594 (string :tag
"Keyword"))))))
2596 (defvar org-todo-keywords-1 nil
2597 "All TODO and DONE keywords active in a buffer.")
2598 (make-variable-buffer-local 'org-todo-keywords-1
)
2599 (defvar org-todo-keywords-for-agenda nil
)
2600 (defvar org-done-keywords-for-agenda nil
)
2601 (defvar org-todo-keyword-alist-for-agenda nil
)
2602 (defvar org-tag-alist-for-agenda nil
2603 "Alist of all tags from all agenda files.")
2604 (defvar org-tag-groups-alist-for-agenda nil
2605 "Alist of all groups tags from all current agenda files.")
2606 (defvar org-tag-groups-alist nil
)
2607 (make-variable-buffer-local 'org-tag-groups-alist
)
2608 (defvar org-agenda-contributing-files nil
)
2609 (defvar org-not-done-keywords nil
)
2610 (make-variable-buffer-local 'org-not-done-keywords
)
2611 (defvar org-done-keywords nil
)
2612 (make-variable-buffer-local 'org-done-keywords
)
2613 (defvar org-todo-heads nil
)
2614 (make-variable-buffer-local 'org-todo-heads
)
2615 (defvar org-todo-sets nil
)
2616 (make-variable-buffer-local 'org-todo-sets
)
2617 (defvar org-todo-log-states nil
)
2618 (make-variable-buffer-local 'org-todo-log-states
)
2619 (defvar org-todo-kwd-alist nil
)
2620 (make-variable-buffer-local 'org-todo-kwd-alist
)
2621 (defvar org-todo-key-alist nil
)
2622 (make-variable-buffer-local 'org-todo-key-alist
)
2623 (defvar org-todo-key-trigger nil
)
2624 (make-variable-buffer-local 'org-todo-key-trigger
)
2626 (defcustom org-todo-interpretation
'sequence
2627 "Controls how TODO keywords are interpreted.
2628 This variable is in principle obsolete and is only used for
2629 backward compatibility, if the interpretation of todo keywords is
2630 not given already in `org-todo-keywords'. See that variable for
2633 :group
'org-keywords
2634 :type
'(choice (const sequence
)
2637 (defcustom org-use-fast-todo-selection t
2638 "Non-nil means use the fast todo selection scheme with C-c C-t.
2639 This variable describes if and under what circumstances the cycling
2640 mechanism for TODO keywords will be replaced by a single-key, direct
2643 When nil, fast selection is never used.
2645 When the symbol `prefix', it will be used when `org-todo' is called
2646 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2647 `C-u t' in an agenda buffer.
2649 When t, fast selection is used by default. In this case, the prefix
2650 argument forces cycling instead.
2652 In all cases, the special interface is only used if access keys have
2653 actually been assigned by the user, i.e. if keywords in the configuration
2654 are followed by a letter in parenthesis, like TODO(t)."
2657 (const :tag
"Never" nil
)
2658 (const :tag
"By default" t
)
2659 (const :tag
"Only with C-u C-c C-t" prefix
)))
2661 (defcustom org-provide-todo-statistics t
2662 "Non-nil means update todo statistics after insert and toggle.
2663 ALL-HEADLINES means update todo statistics by including headlines
2664 with no TODO keyword as well, counting them as not done.
2665 A list of TODO keywords means the same, but skip keywords that are
2667 When set to a list of two lists, the first list contains keywords
2668 to consider as TODO keywords, the second list contains keywords
2669 to consider as DONE keywords.
2671 When this is set, todo statistics is updated in the parent of the
2672 current entry each time a todo state is changed."
2675 (const :tag
"Yes, only for TODO entries" t
)
2676 (const :tag
"Yes, including all entries" all-headlines
)
2677 (repeat :tag
"Yes, for TODOs in this list"
2678 (string :tag
"TODO keyword"))
2679 (list :tag
"Yes, for TODOs and DONEs in these lists"
2680 (repeat (string :tag
"TODO keyword"))
2681 (repeat (string :tag
"DONE keyword")))
2682 (other :tag
"No TODO statistics" nil
)))
2684 (defcustom org-hierarchical-todo-statistics t
2685 "Non-nil means TODO statistics covers just direct children.
2686 When nil, all entries in the subtree are considered.
2687 This has only an effect if `org-provide-todo-statistics' is set.
2688 To set this to nil for only a single subtree, use a COOKIE_DATA
2689 property and include the word \"recursive\" into the value."
2693 (defcustom org-after-todo-state-change-hook nil
2694 "Hook which is run after the state of a TODO item was changed.
2695 The new state (a string with a TODO keyword, or nil) is available in the
2696 Lisp variable `org-state'."
2700 (defvar org-blocker-hook nil
2701 "Hook for functions that are allowed to block a state change.
2703 Functions in this hook should not modify the buffer.
2704 Each function gets as its single argument a property list,
2705 see `org-trigger-hook' for more information about this list.
2707 If any of the functions in this hook returns nil, the state change
2710 (defvar org-trigger-hook nil
2711 "Hook for functions that are triggered by a state change.
2713 Each function gets as its single argument a property list with at
2714 least the following elements:
2716 (:type type-of-change :position pos-at-entry-start
2717 :from old-state :to new-state)
2719 Depending on the type, more properties may be present.
2721 This mechanism is currently implemented for:
2725 :type todo-state-change
2726 :from previous state (keyword as a string), or nil, or a symbol
2727 'todo' or 'done', to indicate the general type of state.
2728 :to new state, like in :from")
2730 (defcustom org-enforce-todo-dependencies nil
2731 "Non-nil means undone TODO entries will block switching the parent to DONE.
2732 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2733 be blocked if any prior sibling is not yet done.
2734 Finally, if the parent is blocked because of ordered siblings of its own,
2735 the child will also be blocked."
2736 :set
(lambda (var val
)
2739 (add-hook 'org-blocker-hook
2740 'org-block-todo-from-children-or-siblings-or-parent
)
2741 (remove-hook 'org-blocker-hook
2742 'org-block-todo-from-children-or-siblings-or-parent
)))
2746 (defcustom org-enforce-todo-checkbox-dependencies nil
2747 "Non-nil means unchecked boxes will block switching the parent to DONE.
2748 When this is nil, checkboxes have no influence on switching TODO states.
2749 When non-nil, you first need to check off all check boxes before the TODO
2750 entry can be switched to DONE.
2751 This variable needs to be set before org.el is loaded, and you need to
2752 restart Emacs after a change to make the change effective. The only way
2753 to change is while Emacs is running is through the customize interface."
2754 :set
(lambda (var val
)
2757 (add-hook 'org-blocker-hook
2758 'org-block-todo-from-checkboxes
)
2759 (remove-hook 'org-blocker-hook
2760 'org-block-todo-from-checkboxes
)))
2764 (defcustom org-treat-insert-todo-heading-as-state-change nil
2765 "Non-nil means inserting a TODO heading is treated as state change.
2766 So when the command \\[org-insert-todo-heading] is used, state change
2767 logging will apply if appropriate. When nil, the new TODO item will
2768 be inserted directly, and no logging will take place."
2772 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2773 "Non-nil means switching TODO states with S-cursor counts as state change.
2774 This is the default behavior. However, setting this to nil allows a
2775 convenient way to select a TODO state and bypass any logging associated
2780 (defcustom org-todo-state-tags-triggers nil
2781 "Tag changes that should be triggered by TODO state changes.
2782 This is a list. Each entry is
2784 (state-change (tag . flag) .......)
2786 State-change can be a string with a state, and empty string to indicate the
2787 state that has no TODO keyword, or it can be one of the symbols `todo'
2788 or `done', meaning any not-done or done state, respectively."
2792 (cons (choice :tag
"When changing to"
2793 (const :tag
"Not-done state" todo
)
2794 (const :tag
"Done state" done
)
2795 (string :tag
"State"))
2797 (cons :tag
"Tag action"
2799 (choice (const :tag
"Add" t
) (const :tag
"Remove" nil
)))))))
2801 (defcustom org-log-done nil
2802 "Information to record when a task moves to the DONE state.
2804 Possible values are:
2806 nil Don't add anything, just change the keyword
2807 time Add a time stamp to the task
2808 note Prompt for a note and add it with template `org-log-note-headings'
2810 This option can also be set with on a per-file-basis with
2812 #+STARTUP: nologdone
2814 #+STARTUP: lognotedone
2816 You can have local logging settings for a subtree by setting the LOGGING
2817 property to one or more of these keywords."
2819 :group
'org-progress
2821 (const :tag
"No logging" nil
)
2822 (const :tag
"Record CLOSED timestamp" time
)
2823 (const :tag
"Record CLOSED timestamp with note." note
)))
2825 ;; Normalize old uses of org-log-done.
2827 ((eq org-log-done t
) (setq org-log-done
'time
))
2828 ((and (listp org-log-done
) (memq 'done org-log-done
))
2829 (setq org-log-done
'note
)))
2831 (defcustom org-log-reschedule nil
2832 "Information to record when the scheduling date of a tasks is modified.
2834 Possible values are:
2836 nil Don't add anything, just change the date
2837 time Add a time stamp to the task
2838 note Prompt for a note and add it with template `org-log-note-headings'
2840 This option can also be set with on a per-file-basis with
2842 #+STARTUP: nologreschedule
2843 #+STARTUP: logreschedule
2844 #+STARTUP: lognotereschedule"
2846 :group
'org-progress
2848 (const :tag
"No logging" nil
)
2849 (const :tag
"Record timestamp" time
)
2850 (const :tag
"Record timestamp with note." note
)))
2852 (defcustom org-log-redeadline nil
2853 "Information to record when the deadline date of a tasks is modified.
2855 Possible values are:
2857 nil Don't add anything, just change the date
2858 time Add a time stamp to the task
2859 note Prompt for a note and add it with template `org-log-note-headings'
2861 This option can also be set with on a per-file-basis with
2863 #+STARTUP: nologredeadline
2864 #+STARTUP: logredeadline
2865 #+STARTUP: lognoteredeadline
2867 You can have local logging settings for a subtree by setting the LOGGING
2868 property to one or more of these keywords."
2870 :group
'org-progress
2872 (const :tag
"No logging" nil
)
2873 (const :tag
"Record timestamp" time
)
2874 (const :tag
"Record timestamp with note." note
)))
2876 (defcustom org-log-note-clock-out nil
2877 "Non-nil means record a note when clocking out of an item.
2878 This can also be configured on a per-file basis by adding one of
2879 the following lines anywhere in the buffer:
2881 #+STARTUP: lognoteclock-out
2882 #+STARTUP: nolognoteclock-out"
2884 :group
'org-progress
2887 (defcustom org-log-done-with-time t
2888 "Non-nil means the CLOSED time stamp will contain date and time.
2889 When nil, only the date will be recorded."
2890 :group
'org-progress
2893 (defcustom org-log-note-headings
2894 '((done .
"CLOSING NOTE %t")
2895 (state .
"State %-12s from %-12S %t")
2896 (note .
"Note taken on %t")
2897 (reschedule .
"Rescheduled from %S on %t")
2898 (delschedule .
"Not scheduled, was %S on %t")
2899 (redeadline .
"New deadline from %S on %t")
2900 (deldeadline .
"Removed deadline, was %S on %t")
2901 (refile .
"Refiled on %t")
2903 "Headings for notes added to entries.
2904 The value is an alist, with the car being a symbol indicating the note
2905 context, and the cdr is the heading to be used. The heading may also be the
2907 %t in the heading will be replaced by a time stamp.
2908 %T will be an active time stamp instead the default inactive one
2909 %d will be replaced by a short-format time stamp.
2910 %D will be replaced by an active short-format time stamp.
2911 %s will be replaced by the new TODO state, in double quotes.
2912 %S will be replaced by the old TODO state, in double quotes.
2913 %u will be replaced by the user name.
2914 %U will be replaced by the full user name.
2916 In fact, it is not a good idea to change the `state' entry, because
2917 agenda log mode depends on the format of these entries."
2919 :group
'org-progress
2920 :type
'(list :greedy t
2921 (cons (const :tag
"Heading when closing an item" done
) string
)
2923 "Heading when changing todo state (todo sequence only)"
2925 (cons (const :tag
"Heading when just taking a note" note
) string
)
2926 (cons (const :tag
"Heading when rescheduling" reschedule
) string
)
2927 (cons (const :tag
"Heading when an item is no longer scheduled" delschedule
) string
)
2928 (cons (const :tag
"Heading when changing deadline" redeadline
) string
)
2929 (cons (const :tag
"Heading when deleting a deadline" deldeadline
) string
)
2930 (cons (const :tag
"Heading when refiling" refile
) string
)
2931 (cons (const :tag
"Heading when clocking out" clock-out
) string
)))
2933 (unless (assq 'note org-log-note-headings
)
2934 (push '(note .
"%t") org-log-note-headings
))
2936 (defcustom org-log-into-drawer nil
2937 "Non-nil means insert state change notes and time stamps into a drawer.
2938 When nil, state changes notes will be inserted after the headline and
2939 any scheduling and clock lines, but not inside a drawer.
2941 The value of this variable should be the name of the drawer to use.
2942 LOGBOOK is proposed as the default drawer for this purpose, you can
2943 also set this to a string to define the drawer of your choice.
2945 A value of t is also allowed, representing \"LOGBOOK\".
2947 A value of t or nil can also be set with on a per-file-basis with
2949 #+STARTUP: logdrawer
2950 #+STARTUP: nologdrawer
2952 If this variable is set, `org-log-state-notes-insert-after-drawers'
2955 You can set the property LOG_INTO_DRAWER to overrule this setting for
2958 Do not check directly this variable in a Lisp program. Call
2959 function `org-log-into-drawer' instead."
2961 :group
'org-progress
2963 (const :tag
"Not into a drawer" nil
)
2964 (const :tag
"LOGBOOK" t
)
2965 (string :tag
"Other")))
2967 (org-defvaralias 'org-log-state-notes-into-drawer
'org-log-into-drawer
)
2969 (defun org-log-into-drawer ()
2970 "Name of the log drawer, as a string, or nil.
2971 This is the value of `org-log-into-drawer'. However, if the
2972 current entry has or inherits a LOG_INTO_DRAWER property, it will
2973 be used instead of the default value."
2974 (let ((p (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit t
)))
2975 (cond ((equal p
"nil") nil
)
2976 ((equal p
"t") "LOGBOOK")
2979 ((stringp org-log-into-drawer
) org-log-into-drawer
)
2980 (org-log-into-drawer "LOGBOOK"))))
2982 (defcustom org-log-state-notes-insert-after-drawers nil
2983 "Non-nil means insert state change notes after any drawers in entry.
2984 Only the drawers that *immediately* follow the headline and the
2985 deadline/scheduled line are skipped.
2986 When nil, insert notes right after the heading and perhaps the line
2987 with deadline/scheduling if present.
2989 This variable will have no effect if `org-log-into-drawer' is
2992 :group
'org-progress
2995 (defcustom org-log-states-order-reversed t
2996 "Non-nil means the latest state note will be directly after heading.
2997 When nil, the state change notes will be ordered according to time.
2999 This option can also be set with on a per-file-basis with
3001 #+STARTUP: logstatesreversed
3002 #+STARTUP: nologstatesreversed"
3004 :group
'org-progress
3007 (defcustom org-todo-repeat-to-state nil
3008 "The TODO state to which a repeater should return the repeating task.
3009 By default this is the first task in a TODO sequence, or the previous state
3010 in a TODO_TYP set. But you can specify another task here.
3011 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3014 :type
'(choice (const :tag
"Head of sequence" nil
)
3015 (string :tag
"Specific state")))
3017 (defcustom org-log-repeat
'time
3018 "Non-nil means record moving through the DONE state when triggering repeat.
3019 An auto-repeating task is immediately switched back to TODO when
3020 marked DONE. If you are not logging state changes (by adding \"@\"
3021 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3022 record a closing note, there will be no record of the task moving
3023 through DONE. This variable forces taking a note anyway.
3025 nil Don't force a record
3026 time Record a time stamp
3027 note Prompt for a note and add it with template `org-log-note-headings'
3029 This option can also be set with on a per-file-basis with
3031 #+STARTUP: nologrepeat
3032 #+STARTUP: logrepeat
3033 #+STARTUP: lognoterepeat
3035 You can have local logging settings for a subtree by setting the LOGGING
3036 property to one or more of these keywords."
3038 :group
'org-progress
3040 (const :tag
"Don't force a record" nil
)
3041 (const :tag
"Force recording the DONE state" time
)
3042 (const :tag
"Force recording a note with the DONE state" note
)))
3045 (defgroup org-priorities nil
3046 "Priorities in Org-mode."
3047 :tag
"Org Priorities"
3050 (defcustom org-enable-priority-commands t
3051 "Non-nil means priority commands are active.
3052 When nil, these commands will be disabled, so that you never accidentally
3054 :group
'org-priorities
3057 (defcustom org-highest-priority ?A
3058 "The highest priority of TODO items. A character like ?A, ?B etc.
3059 Must have a smaller ASCII number than `org-lowest-priority'."
3060 :group
'org-priorities
3063 (defcustom org-lowest-priority ?C
3064 "The lowest priority of TODO items. A character like ?A, ?B etc.
3065 Must have a larger ASCII number than `org-highest-priority'."
3066 :group
'org-priorities
3069 (defcustom org-default-priority ?B
3070 "The default priority of TODO items.
3071 This is the priority an item gets if no explicit priority is given.
3072 When starting to cycle on an empty priority the first step in the cycle
3073 depends on `org-priority-start-cycle-with-default'. The resulting first
3074 step priority must not exceed the range from `org-highest-priority' to
3075 `org-lowest-priority' which means that `org-default-priority' has to be
3076 in this range exclusive or inclusive the range boundaries. Else the
3077 first step refuses to set the default and the second will fall back
3078 to (depending on the command used) the highest or lowest priority."
3079 :group
'org-priorities
3082 (defcustom org-priority-start-cycle-with-default t
3083 "Non-nil means start with default priority when starting to cycle.
3084 When this is nil, the first step in the cycle will be (depending on the
3085 command used) one higher or lower than the default priority.
3086 See also `org-default-priority'."
3087 :group
'org-priorities
3090 (defcustom org-get-priority-function nil
3091 "Function to extract the priority from a string.
3092 The string is normally the headline. If this is nil Org computes the
3093 priority from the priority cookie like [#A] in the headline. It returns
3094 an integer, increasing by 1000 for each priority level.
3095 The user can set a different function here, which should take a string
3096 as an argument and return the numeric priority."
3097 :group
'org-priorities
3103 (defgroup org-time nil
3104 "Options concerning time stamps and deadlines in Org-mode."
3108 (defcustom org-time-stamp-rounding-minutes
'(0 5)
3109 "Number of minutes to round time stamps to.
3110 These are two values, the first applies when first creating a time stamp.
3111 The second applies when changing it with the commands `S-up' and `S-down'.
3112 When changing the time stamp, this means that it will change in steps
3113 of N minutes, as given by the second value.
3115 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3116 numbers should be factors of 60, so for example 5, 10, 15.
3118 When this is larger than 1, you can still force an exact time stamp by using
3119 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3120 and by using a prefix arg to `S-up/down' to specify the exact number
3121 of minutes to shift."
3123 :get
(lambda (var) ; Make sure both elements are there
3124 (if (integerp (default-value var
))
3125 (list (default-value var
) 5)
3126 (default-value var
)))
3128 (integer :tag
"when inserting times")
3129 (integer :tag
"when modifying times")))
3131 ;; Normalize old customizations of this variable.
3132 (when (integerp org-time-stamp-rounding-minutes
)
3133 (setq org-time-stamp-rounding-minutes
3134 (list org-time-stamp-rounding-minutes
3135 org-time-stamp-rounding-minutes
)))
3137 (defcustom org-display-custom-times nil
3138 "Non-nil means overlay custom formats over all time stamps.
3139 The formats are defined through the variable `org-time-stamp-custom-formats'.
3140 To turn this on on a per-file basis, insert anywhere in the file:
3141 #+STARTUP: customtime"
3145 (make-variable-buffer-local 'org-display-custom-times
)
3147 (defcustom org-time-stamp-custom-formats
3148 '("<%m/%d/%y %a>" .
"<%m/%d/%y %a %H:%M>") ; american
3149 "Custom formats for time stamps. See `format-time-string' for the syntax.
3150 These are overlaid over the default ISO format if the variable
3151 `org-display-custom-times' is set. Time like %H:%M should be at the
3152 end of the second format. The custom formats are also honored by export
3153 commands, if custom time display is turned on at the time of export."
3157 (defun org-time-stamp-format (&optional long inactive
)
3158 "Get the right format for a time string."
3159 (let ((f (if long
(cdr org-time-stamp-formats
)
3160 (car org-time-stamp-formats
))))
3162 (concat "[" (substring f
1 -
1) "]")
3165 (defcustom org-time-clocksum-format
3166 '(:days
"%dd " :hours
"%d" :require-hours t
:minutes
":%02d" :require-minutes t
)
3167 "The format string used when creating CLOCKSUM lines.
3168 This is also used when Org mode generates a time duration.
3170 The value can be a single format string containing two
3171 %-sequences, which will be filled with the number of hours and
3172 minutes in that order.
3174 Alternatively, the value can be a plist associating any of the
3175 keys :years, :months, :weeks, :days, :hours or :minutes with
3176 format strings. The time duration is formatted using only the
3177 time components that are needed and concatenating the results.
3178 If a time unit in absent, it falls back to the next smallest
3181 The keys :require-years, :require-months, :require-days,
3182 :require-weeks, :require-hours, :require-minutes are also
3183 meaningful. A non-nil value for these keys indicates that the
3184 corresponding time component should always be included, even if
3190 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3193 means durations longer than a day will be expressed in days,
3194 hours and minutes, and durations less than a day will always be
3195 expressed in hours and minutes (even for durations less than an
3200 \(:days \"%dd\" :minutes \"%dm\")
3202 means durations longer than a day will be expressed in days and
3203 minutes, and durations less than a day will be expressed entirely
3204 in minutes (even for durations longer than an hour)."
3208 :package-version
'(Org .
"8.0")
3209 :type
'(choice (string :tag
"Format string")
3211 (group :inline t
(const :tag
"Years" :years
)
3212 (string :tag
"Format string"))
3214 (const :tag
"Always show years" :require-years
)
3216 (group :inline t
(const :tag
"Months" :months
)
3217 (string :tag
"Format string"))
3219 (const :tag
"Always show months" :require-months
)
3221 (group :inline t
(const :tag
"Weeks" :weeks
)
3222 (string :tag
"Format string"))
3224 (const :tag
"Always show weeks" :require-weeks
)
3226 (group :inline t
(const :tag
"Days" :days
)
3227 (string :tag
"Format string"))
3229 (const :tag
"Always show days" :require-days
)
3231 (group :inline t
(const :tag
"Hours" :hours
)
3232 (string :tag
"Format string"))
3234 (const :tag
"Always show hours" :require-hours
)
3236 (group :inline t
(const :tag
"Minutes" :minutes
)
3237 (string :tag
"Format string"))
3239 (const :tag
"Always show minutes" :require-minutes
)
3242 (defcustom org-time-clocksum-use-fractional nil
3243 "When non-nil, \\[org-clock-display] uses fractional times.
3244 See `org-time-clocksum-format' for more on time clock formats."
3250 (defcustom org-time-clocksum-use-effort-durations nil
3251 "When non-nil, \\[org-clock-display] uses effort durations.
3252 E.g. by default, one day is considered to be a 8 hours effort,
3253 so a task that has been clocked for 16 hours will be displayed
3254 as during 2 days in the clock display or in the clocktable.
3256 See `org-effort-durations' on how to set effort durations
3257 and `org-time-clocksum-format' for more on time clock formats."
3261 :package-version
'(Org .
"8.0")
3264 (defcustom org-time-clocksum-fractional-format
"%.2f"
3265 "The format string used when creating CLOCKSUM lines,
3266 or when Org mode generates a time duration, if
3267 `org-time-clocksum-use-fractional' is enabled.
3269 The value can be a single format string containing one
3270 %-sequence, which will be filled with the number of hours as
3273 Alternatively, the value can be a plist associating any of the
3274 keys :years, :months, :weeks, :days, :hours or :minutes with
3275 a format string. The time duration is formatted using the
3276 largest time unit which gives a non-zero integer part. If all
3277 specified formats have zero integer part, the smallest time unit
3280 :type
'(choice (string :tag
"Format string")
3281 (set (group :inline t
(const :tag
"Years" :years
)
3282 (string :tag
"Format string"))
3283 (group :inline t
(const :tag
"Months" :months
)
3284 (string :tag
"Format string"))
3285 (group :inline t
(const :tag
"Weeks" :weeks
)
3286 (string :tag
"Format string"))
3287 (group :inline t
(const :tag
"Days" :days
)
3288 (string :tag
"Format string"))
3289 (group :inline t
(const :tag
"Hours" :hours
)
3290 (string :tag
"Format string"))
3291 (group :inline t
(const :tag
"Minutes" :minutes
)
3292 (string :tag
"Format string")))))
3294 (defcustom org-deadline-warning-days
14
3295 "Number of days before expiration during which a deadline becomes active.
3296 This variable governs the display in sparse trees and in the agenda.
3297 When 0 or negative, it means use this number (the absolute value of it)
3298 even if a deadline has a different individual lead time specified.
3300 Custom commands can set this variable in the options section."
3302 :group
'org-agenda-daily
/weekly
3305 (defcustom org-scheduled-delay-days
0
3306 "Number of days before a scheduled item becomes active.
3307 This variable governs the display in sparse trees and in the agenda.
3308 The default value (i.e. 0) means: don't delay scheduled item.
3309 When negative, it means use this number (the absolute value of it)
3310 even if a scheduled item has a different individual delay time
3313 Custom commands can set this variable in the options section."
3315 :group
'org-agenda-daily
/weekly
3317 :package-version
'(Org .
"8.0")
3320 (defcustom org-read-date-prefer-future t
3321 "Non-nil means assume future for incomplete date input from user.
3322 This affects the following situations:
3323 1. The user gives a month but not a year.
3324 For example, if it is April and you enter \"feb 2\", this will be read
3325 as Feb 2, *next* year. \"May 5\", however, will be this year.
3326 2. The user gives a day, but no month.
3327 For example, if today is the 15th, and you enter \"3\", Org-mode will
3328 read this as the third of *next* month. However, if you enter \"17\",
3329 it will be considered as *this* month.
3331 If you set this variable to the symbol `time', then also the following
3334 3. If the user gives a time.
3335 If the time is before now, it will be interpreted as tomorrow.
3337 Currently none of this works for ISO week specifications.
3339 When this option is nil, the current day, month and year will always be
3342 See also `org-agenda-jump-prefer-future'."
3345 (const :tag
"Never" nil
)
3346 (const :tag
"Check month and day" t
)
3347 (const :tag
"Check month, day, and time" time
)))
3349 (defcustom org-agenda-jump-prefer-future
'org-read-date-prefer-future
3350 "Should the agenda jump command prefer the future for incomplete dates?
3351 The default is to do the same as configured in `org-read-date-prefer-future'.
3352 But you can also set a deviating value here.
3353 This may t or nil, or the symbol `org-read-date-prefer-future'."
3358 (const :tag
"Use org-read-date-prefer-future"
3359 org-read-date-prefer-future
)
3360 (const :tag
"Never" nil
)
3361 (const :tag
"Always" t
)))
3363 (defcustom org-read-date-force-compatible-dates t
3364 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3366 Depending on the system Emacs is running on, certain dates cannot
3367 be represented with the type used internally to represent time.
3368 Dates between 1970-1-1 and 2038-1-1 can always be represented
3369 correctly. Some systems allow for earlier dates, some for later,
3370 some for both. One way to find out it to insert any date into an
3371 Org buffer, putting the cursor on the year and hitting S-up and
3372 S-down to test the range.
3374 When this variable is set to t, the date/time prompt will not let
3375 you specify dates outside the 1970-2037 range, so it is certain that
3376 these dates will work in whatever version of Emacs you are
3377 running, and also that you can move a file from one Emacs implementation
3378 to another. WHenever Org is forcing the year for you, it will display
3381 When this variable is nil, Org will check if the date is
3382 representable in the specific Emacs implementation you are using.
3383 If not, it will force a year, usually the current year, and beep
3384 to remind you. Currently this setting is not recommended because
3385 the likelihood that you will open your Org files in an Emacs that
3386 has limited date range is not negligible.
3388 A workaround for this problem is to use diary sexp dates for time
3389 stamps outside of this range."
3394 (defcustom org-read-date-display-live t
3395 "Non-nil means display current interpretation of date prompt live.
3396 This display will be in an overlay, in the minibuffer."
3400 (defcustom org-read-date-popup-calendar t
3401 "Non-nil means pop up a calendar when prompting for a date.
3402 In the calendar, the date can be selected with mouse-1. However, the
3403 minibuffer will also be active, and you can simply enter the date as well.
3404 When nil, only the minibuffer will be available."
3407 (org-defvaralias 'org-popup-calendar-for-date-prompt
3408 'org-read-date-popup-calendar
)
3410 (make-obsolete-variable
3411 'org-read-date-minibuffer-setup-hook
3412 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3413 (defcustom org-read-date-minibuffer-setup-hook nil
3414 "Hook to be used to set up keys for the date/time interface.
3415 Add key definitions to `minibuffer-local-map', which will be a
3418 WARNING: This option is obsolete, you should use
3419 `org-read-date-minibuffer-local-map' to set up keys."
3423 (defcustom org-extend-today-until
0
3424 "The hour when your day really ends. Must be an integer.
3425 This has influence for the following applications:
3426 - When switching the agenda to \"today\". It it is still earlier than
3427 the time given here, the day recognized as TODAY is actually yesterday.
3428 - When a date is read from the user and it is still before the time given
3429 here, the current date and time will be assumed to be yesterday, 23:59.
3430 Also, timestamps inserted in capture templates follow this rule.
3432 IMPORTANT: This is a feature whose implementation is and likely will
3433 remain incomplete. Really, it is only here because past midnight seems to
3434 be the favorite working time of John Wiegley :-)"
3438 (defcustom org-use-effective-time nil
3439 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3440 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3441 \"effective time\" of any timestamps between midnight and 8am will be
3442 23:59 of the previous day."
3447 (defcustom org-use-last-clock-out-time-as-effective-time nil
3448 "When non-nil, use the last clock out time for `org-todo'.
3449 Note that this option has precedence over the combined use of
3450 `org-use-effective-time' and `org-extend-today-until'."
3453 :package-version
'(Org .
"8.0")
3456 (defcustom org-edit-timestamp-down-means-later nil
3457 "Non-nil means S-down will increase the time in a time stamp.
3458 When nil, S-up will increase."
3462 (defcustom org-calendar-follow-timestamp-change t
3463 "Non-nil means make the calendar window follow timestamp changes.
3464 When a timestamp is modified and the calendar window is visible, it will be
3465 moved to the new date."
3469 (defgroup org-tags nil
3470 "Options concerning tags in Org-mode."
3474 (defcustom org-tag-alist nil
3475 "List of tags allowed in Org-mode files.
3476 When this list is nil, Org-mode will base TAG input on what is already in the
3478 The value of this variable is an alist, the car of each entry must be a
3479 keyword as a string, the cdr may be a character that is used to select
3480 that tag through the fast-tag-selection interface.
3481 See the manual for details."
3485 (cons (string :tag
"Tag name")
3486 (character :tag
"Access char"))
3487 (list :tag
"Start radio group"
3489 (option (string :tag
"Group description")))
3490 (list :tag
"Group tags delimiter"
3492 (list :tag
"End radio group"
3494 (option (string :tag
"Group description")))
3495 (const :tag
"New line" (:newline
)))))
3497 (defcustom org-tag-persistent-alist nil
3498 "List of tags that will always appear in all Org-mode files.
3499 This is in addition to any in buffer settings or customizations
3501 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3502 The value of this variable is an alist, the car of each entry must be a
3503 keyword as a string, the cdr may be a character that is used to select
3504 that tag through the fast-tag-selection interface.
3505 See the manual for details.
3506 To disable these tags on a per-file basis, insert anywhere in the file:
3511 (cons (string :tag
"Tag name")
3512 (character :tag
"Access char"))
3513 (const :tag
"Start radio group" (:startgroup
))
3514 (const :tag
"Group tags delimiter" (:grouptags
))
3515 (const :tag
"End radio group" (:endgroup
))
3516 (const :tag
"New line" (:newline
)))))
3518 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3519 "If non-nil, always offer completion for all tags of all agenda files.
3520 Instead of customizing this variable directly, you might want to
3521 set it locally for capture buffers, because there no list of
3522 tags in that file can be created dynamically (there are none).
3524 (add-hook 'org-capture-mode-hook
3526 (set (make-local-variable
3527 'org-complete-tags-always-offer-all-agenda-tags)
3533 (defvar org-file-tags nil
3534 "List of tags that can be inherited by all entries in the file.
3535 The tags will be inherited if the variable `org-use-tag-inheritance'
3536 says they should be.
3537 This variable is populated from #+FILETAGS lines.")
3539 (defcustom org-use-fast-tag-selection
'auto
3540 "Non-nil means use fast tag selection scheme.
3541 This is a special interface to select and deselect tags with single keys.
3542 When nil, fast selection is never used.
3543 When the symbol `auto', fast selection is used if and only if selection
3544 characters for tags have been configured, either through the variable
3545 `org-tag-alist' or through a #+TAGS line in the buffer.
3546 When t, fast selection is always used and selection keys are assigned
3547 automatically if necessary."
3550 (const :tag
"Always" t
)
3551 (const :tag
"Never" nil
)
3552 (const :tag
"When selection characters are configured" auto
)))
3554 (defcustom org-fast-tag-selection-single-key nil
3555 "Non-nil means fast tag selection exits after first change.
3556 When nil, you have to press RET to exit it.
3557 During fast tag selection, you can toggle this flag with `C-c'.
3558 This variable can also have the value `expert'. In this case, the window
3559 displaying the tags menu is not even shown, until you press C-c again."
3562 (const :tag
"No" nil
)
3563 (const :tag
"Yes" t
)
3564 (const :tag
"Expert" expert
)))
3566 (defvar org-fast-tag-selection-include-todo nil
3567 "Non-nil means fast tags selection interface will also offer TODO states.
3568 This is an undocumented feature, you should not rely on it.")
3570 (defcustom org-tags-column
(if (featurep 'xemacs
) -
76 -
77)
3571 "The column to which tags should be indented in a headline.
3572 If this number is positive, it specifies the column. If it is negative,
3573 it means that the tags should be flushright to that column. For example,
3574 -80 works well for a normal 80 character screen.
3575 When 0, place tags directly after headline text, with only one space in
3580 (defcustom org-auto-align-tags t
3581 "Non-nil keeps tags aligned when modifying headlines.
3582 Some operations (i.e. demoting) change the length of a headline and
3583 therefore shift the tags around. With this option turned on, after
3584 each such operation the tags are again aligned to `org-tags-column'."
3588 (defcustom org-use-tag-inheritance t
3589 "Non-nil means tags in levels apply also for sublevels.
3590 When nil, only the tags directly given in a specific line apply there.
3591 This may also be a list of tags that should be inherited, or a regexp that
3592 matches tags that should be inherited. Additional control is possible
3593 with the variable `org-tags-exclude-from-inheritance' which gives an
3594 explicit list of tags to be excluded from inheritance, even if the value of
3595 `org-use-tag-inheritance' would select it for inheritance.
3597 If this option is t, a match early-on in a tree can lead to a large
3598 number of matches in the subtree when constructing the agenda or creating
3599 a sparse tree. If you only want to see the first match in a tree during
3600 a search, check out the variable `org-tags-match-list-sublevels'."
3603 (const :tag
"Not" nil
)
3604 (const :tag
"Always" t
)
3605 (repeat :tag
"Specific tags" (string :tag
"Tag"))
3606 (regexp :tag
"Tags matched by regexp")))
3608 (defcustom org-tags-exclude-from-inheritance nil
3609 "List of tags that should never be inherited.
3610 This is a way to exclude a few tags from inheritance. For way to do
3611 the opposite, to actively allow inheritance for selected tags,
3612 see the variable `org-use-tag-inheritance'."
3614 :type
'(repeat (string :tag
"Tag")))
3616 (defun org-tag-inherit-p (tag)
3617 "Check if TAG is one that should be inherited."
3619 ((member tag org-tags-exclude-from-inheritance
) nil
)
3620 ((eq org-use-tag-inheritance t
) t
)
3621 ((not org-use-tag-inheritance
) nil
)
3622 ((stringp org-use-tag-inheritance
)
3623 (string-match org-use-tag-inheritance tag
))
3624 ((listp org-use-tag-inheritance
)
3625 (member tag org-use-tag-inheritance
))
3626 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3628 (defcustom org-tags-match-list-sublevels t
3629 "Non-nil means list also sublevels of headlines matching a search.
3630 This variable applies to tags/property searches, and also to stuck
3631 projects because this search is based on a tags match as well.
3633 When set to the symbol `indented', sublevels are indented with
3636 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3637 the sublevels of a headline matching a tag search often also match
3638 the same search. Listing all of them can create very long lists.
3639 Setting this variable to nil causes subtrees of a match to be skipped.
3641 This variable is semi-obsolete and probably should always be true. It
3642 is better to limit inheritance to certain tags using the variables
3643 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3646 (const :tag
"No, don't list them" nil
)
3647 (const :tag
"Yes, do list them" t
)
3648 (const :tag
"List them, indented with leading dots" indented
)))
3650 (defcustom org-tags-sort-function nil
3651 "When set, tags are sorted using this function as a comparator."
3654 (const :tag
"No sorting" nil
)
3655 (const :tag
"Alphabetical" string
<)
3656 (const :tag
"Reverse alphabetical" string
>)
3657 (function :tag
"Custom function" nil
)))
3659 (defvar org-tags-history nil
3660 "History of minibuffer reads for tags.")
3661 (defvar org-last-tags-completion-table nil
3662 "The last used completion table for tags.")
3663 (defvar org-after-tags-change-hook nil
3664 "Hook that is run after the tags in a line have changed.")
3666 (defgroup org-properties nil
3667 "Options concerning properties in Org-mode."
3668 :tag
"Org Properties"
3671 (defcustom org-property-format
"%-10s %s"
3672 "How property key/value pairs should be formatted by `indent-line'.
3673 When `indent-line' hits a property definition, it will format the line
3674 according to this format, mainly to make sure that the values are
3675 lined-up with respect to each other."
3676 :group
'org-properties
3679 (defcustom org-properties-postprocess-alist nil
3680 "Alist of properties and functions to adjust inserted values.
3681 Elements of this alist must be of the form
3683 ([string] [function])
3685 where [string] must be a property name and [function] must be a
3686 lambda expression: this lambda expression must take one argument,
3687 the value to adjust, and return the new value as a string.
3689 For example, this element will allow the property \"Remaining\"
3690 to be updated wrt the relation between the \"Effort\" property
3691 and the clock summary:
3693 ((\"Remaining\" (lambda(value)
3694 (let ((clocksum (org-clock-sum-current-item))
3695 (effort (org-duration-string-to-minutes
3696 (org-entry-get (point) \"Effort\"))))
3697 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3698 :group
'org-properties
3700 :type
'(alist :key-type
(string :tag
"Property")
3701 :value-type
(function :tag
"Function")))
3703 (defcustom org-use-property-inheritance nil
3704 "Non-nil means properties apply also for sublevels.
3706 This setting is chiefly used during property searches. Turning it on can
3707 cause significant overhead when doing a search, which is why it is not
3710 When nil, only the properties directly given in the current entry count.
3711 When t, every property is inherited. The value may also be a list of
3712 properties that should have inheritance, or a regular expression matching
3713 properties that should be inherited.
3715 However, note that some special properties use inheritance under special
3716 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3717 and the properties ending in \"_ALL\" when they are used as descriptor
3718 for valid values of a property.
3720 Note for programmers:
3721 When querying an entry with `org-entry-get', you can control if inheritance
3722 should be used. By default, `org-entry-get' looks only at the local
3723 properties. You can request inheritance by setting the inherit argument
3724 to t (to force inheritance) or to `selective' (to respect the setting
3726 :group
'org-properties
3728 (const :tag
"Not" nil
)
3729 (const :tag
"Always" t
)
3730 (repeat :tag
"Specific properties" (string :tag
"Property"))
3731 (regexp :tag
"Properties matched by regexp")))
3733 (defun org-property-inherit-p (property)
3734 "Check if PROPERTY is one that should be inherited."
3736 ((eq org-use-property-inheritance t
) t
)
3737 ((not org-use-property-inheritance
) nil
)
3738 ((stringp org-use-property-inheritance
)
3739 (string-match org-use-property-inheritance property
))
3740 ((listp org-use-property-inheritance
)
3741 (member property org-use-property-inheritance
))
3742 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3744 (defcustom org-columns-default-format
"%25ITEM %TODO %3PRIORITY %TAGS"
3745 "The default column format, if no other format has been defined.
3746 This variable can be set on the per-file basis by inserting a line
3748 #+COLUMNS: %25ITEM ....."
3749 :group
'org-properties
3752 (defcustom org-columns-ellipses
".."
3753 "The ellipses to be used when a field in column view is truncated.
3754 When this is the empty string, as many characters as possible are shown,
3755 but then there will be no visual indication that the field has been truncated.
3756 When this is a string of length N, the last N characters of a truncated
3757 field are replaced by this string. If the column is narrower than the
3758 ellipses string, only part of the ellipses string will be shown."
3759 :group
'org-properties
3762 (defcustom org-columns-modify-value-for-display-function nil
3763 "Function that modifies values for display in column view.
3764 For example, it can be used to cut out a certain part from a time stamp.
3765 The function must take 2 arguments:
3767 column-title The title of the column (*not* the property name)
3768 value The value that should be modified.
3770 The function should return the value that should be displayed,
3771 or nil if the normal value should be used."
3772 :group
'org-properties
3773 :type
'(choice (const nil
) (function)))
3775 (defconst org-global-properties-fixed
3776 '(("VISIBILITY_ALL" .
"folded children content all")
3777 ("CLOCK_MODELINE_TOTAL_ALL" .
"current today repeat all auto"))
3778 "List of property/value pairs that can be inherited by any entry.
3780 These are fixed values, for the preset properties. The user variable
3781 that can be used to add to this list is `org-global-properties'.
3783 The entries in this list are cons cells where the car is a property
3784 name and cdr is a string with the value. If the value represents
3785 multiple items like an \"_ALL\" property, separate the items by
3788 (defcustom org-global-properties nil
3789 "List of property/value pairs that can be inherited by any entry.
3791 This list will be combined with the constant `org-global-properties-fixed'.
3793 The entries in this list are cons cells where the car is a property
3794 name and cdr is a string with the value.
3796 You can set buffer-local values for the same purpose in the variable
3797 `org-file-properties' this by adding lines like
3799 #+PROPERTY: NAME VALUE"
3800 :group
'org-properties
3802 (cons (string :tag
"Property")
3803 (string :tag
"Value"))))
3805 (defvar org-file-properties nil
3806 "List of property/value pairs that can be inherited by any entry.
3807 Valid for the current buffer.
3808 This variable is populated from #+PROPERTY lines.")
3809 (make-variable-buffer-local 'org-file-properties
)
3811 (defgroup org-agenda nil
3812 "Options concerning agenda views in Org-mode."
3816 (defvar org-category nil
3817 "Variable used by org files to set a category for agenda display.
3818 Such files should use a file variable to set it, for example
3820 # -*- mode: org; org-category: \"ELisp\"
3822 or contain a special line
3826 If the file does not specify a category, then file's base name
3828 (make-variable-buffer-local 'org-category
)
3829 (put 'org-category
'safe-local-variable
(lambda (x) (or (symbolp x
) (stringp x
))))
3831 (defcustom org-agenda-files nil
3832 "The files to be used for agenda display.
3833 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3834 \\[org-remove-file]. You can also use customize to edit the list.
3836 If an entry is a directory, all files in that directory that are matched by
3837 `org-agenda-file-regexp' will be part of the file list.
3839 If the value of the variable is not a list but a single file name, then
3840 the list of agenda files is actually stored and maintained in that file, one
3841 agenda file per line. In this file paths can be given relative to
3842 `org-directory'. Tilde expansion and environment variable substitution
3846 (repeat :tag
"List of files and directories" file
)
3847 (file :tag
"Store list in a file\n" :value
"~/.agenda_files")))
3849 (defcustom org-agenda-file-regexp
"\\`[^.].*\\.org\\'"
3850 "Regular expression to match files for `org-agenda-files'.
3851 If any element in the list in that variable contains a directory instead
3852 of a normal file, all files in that directory that are matched by this
3853 regular expression will be included."
3857 (defcustom org-agenda-text-search-extra-files nil
3858 "List of extra files to be searched by text search commands.
3859 These files will be searched in addition to the agenda files by the
3860 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3861 Note that these files will only be searched for text search commands,
3862 not for the other agenda views like todo lists, tag searches or the weekly
3863 agenda. This variable is intended to list notes and possibly archive files
3864 that should also be searched by these two commands.
3865 In fact, if the first element in the list is the symbol `agenda-archives',
3866 then all archive files of all agenda files will be added to the search
3869 :type
'(set :greedy t
3870 (const :tag
"Agenda Archives" agenda-archives
)
3871 (repeat :inline t
(file))))
3873 (org-defvaralias 'org-agenda-multi-occur-extra-files
3874 'org-agenda-text-search-extra-files
)
3876 (defcustom org-agenda-skip-unavailable-files nil
3877 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3878 A nil value means to remove them, after a query, from the list."
3882 (defcustom org-calendar-to-agenda-key
[?c
]
3883 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3884 The command `org-calendar-goto-agenda' will be bound to this key. The
3885 default is the character `c' because then `c' can be used to switch back and
3886 forth between agenda and calendar."
3890 (defcustom org-calendar-insert-diary-entry-key
[?i
]
3891 "The key to be installed in `calendar-mode-map' for adding diary entries.
3892 This option is irrelevant until `org-agenda-diary-file' has been configured
3893 to point to an Org-mode file. When that is the case, the command
3894 `org-agenda-diary-entry' will be bound to the key given here, by default
3895 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3896 if you want to continue doing this, you need to change this to a different
3901 (defcustom org-agenda-diary-file
'diary-file
3902 "File to which to add new entries with the `i' key in agenda and calendar.
3903 When this is the symbol `diary-file', the functionality in the Emacs
3904 calendar will be used to add entries to the `diary-file'. But when this
3905 points to a file, `org-agenda-diary-entry' will be used instead."
3908 (const :tag
"The standard Emacs diary file" diary-file
)
3909 (file :tag
"Special Org file diary entries")))
3911 (eval-after-load "calendar"
3913 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3914 'org-calendar-goto-agenda
)
3915 (add-hook 'calendar-mode-hook
3917 (unless (eq org-agenda-diary-file
'diary-file
)
3918 (define-key calendar-mode-map
3919 org-calendar-insert-diary-entry-key
3920 'org-agenda-diary-entry
))))))
3922 (defgroup org-latex nil
3923 "Options for embedding LaTeX code into Org-mode."
3927 (defcustom org-format-latex-options
3928 '(:foreground default
:background default
:scale
1.0
3929 :html-foreground
"Black" :html-background
"Transparent"
3930 :html-scale
1.0 :matchers
("begin" "$1" "$" "$$" "\\(" "\\["))
3931 "Options for creating images from LaTeX fragments.
3932 This is a property list with the following properties:
3933 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3934 `default' means use the foreground of the default face.
3935 `auto' means use the foreground from the text face.
3936 :background the background color, or \"Transparent\".
3937 `default' means use the background of the default face.
3938 `auto' means use the background from the text face.
3939 :scale a scaling factor for the size of the images, to get more pixels
3940 :html-foreground, :html-background, :html-scale
3941 the same numbers for HTML export.
3942 :matchers a list indicating which matchers should be used to
3943 find LaTeX fragments. Valid members of this list are:
3944 \"begin\" find environments
3945 \"$1\" find single characters surrounded by $.$
3946 \"$\" find math expressions surrounded by $...$
3947 \"$$\" find math expressions surrounded by $$....$$
3948 \"\\(\" find math expressions surrounded by \\(...\\)
3949 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3953 (defcustom org-format-latex-signal-error t
3954 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3955 When nil, just push out a message."
3960 (defcustom org-latex-to-mathml-jar-file nil
3961 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3962 Use this to specify additional executable file say a jar file.
3964 When using MathToWeb as the converter, specify the full-path to
3965 your mathtoweb.jar file."
3969 (const :tag
"None" nil
)
3970 (file :tag
"JAR file" :must-match t
)))
3972 (defcustom org-latex-to-mathml-convert-command nil
3973 "Command to convert LaTeX fragments to MathML.
3974 Replace format-specifiers in the command as noted below and use
3975 `shell-command' to convert LaTeX to MathML.
3976 %j: Executable file in fully expanded form as specified by
3977 `org-latex-to-mathml-jar-file'.
3978 %I: Input LaTeX file in fully expanded form
3979 %o: Output MathML file
3980 This command is used by `org-create-math-formula'.
3982 When using MathToWeb as the converter, set this to
3983 \"java -jar %j -unicode -force -df %o %I\"."
3987 (const :tag
"None" nil
)
3988 (string :tag
"\nShell command")))
3990 (defcustom org-latex-create-formula-image-program
'dvipng
3991 "Program to convert LaTeX fragments with.
3993 dvipng Process the LaTeX fragments to dvi file, then convert
3994 dvi files to png files using dvipng.
3995 This will also include processing of non-math environments.
3996 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3997 to convert pdf files to png files"
4001 (const :tag
"dvipng" dvipng
)
4002 (const :tag
"imagemagick" imagemagick
)))
4004 (defcustom org-latex-preview-ltxpng-directory
"ltxpng/"
4005 "Path to store latex preview images.
4006 A relative path here creates many directories relative to the
4007 processed org files paths. An absolute path puts all preview
4008 images at the same place."
4013 (defun org-format-latex-mathml-available-p ()
4014 "Return t if `org-latex-to-mathml-convert-command' is usable."
4016 (when (and (boundp 'org-latex-to-mathml-convert-command
)
4017 org-latex-to-mathml-convert-command
)
4018 (let ((executable (car (split-string
4019 org-latex-to-mathml-convert-command
))))
4020 (when (executable-find executable
)
4022 "%j" org-latex-to-mathml-convert-command
)
4023 (file-readable-p org-latex-to-mathml-jar-file
)
4026 (defcustom org-format-latex-header
"\\documentclass{article}
4027 \\usepackage[usenames]{color}
4030 \\pagestyle{empty} % do not remove
4031 % The settings below are copied from fullpage.sty
4032 \\setlength{\\textwidth}{\\paperwidth}
4033 \\addtolength{\\textwidth}{-3cm}
4034 \\setlength{\\oddsidemargin}{1.5cm}
4035 \\addtolength{\\oddsidemargin}{-2.54cm}
4036 \\setlength{\\evensidemargin}{\\oddsidemargin}
4037 \\setlength{\\textheight}{\\paperheight}
4038 \\addtolength{\\textheight}{-\\headheight}
4039 \\addtolength{\\textheight}{-\\headsep}
4040 \\addtolength{\\textheight}{-\\footskip}
4041 \\addtolength{\\textheight}{-3cm}
4042 \\setlength{\\topmargin}{1.5cm}
4043 \\addtolength{\\topmargin}{-2.54cm}"
4044 "The document header used for processing LaTeX fragments.
4045 It is imperative that this header make sure that no page number
4046 appears on the page. The package defined in the variables
4047 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4048 will either replace the placeholder \"[PACKAGES]\" in this
4049 header, or they will be appended."
4053 (defun org-set-packages-alist (var val
)
4054 "Set the packages alist and make sure it has 3 elements per entry."
4055 (set var
(mapcar (lambda (x)
4056 (if (and (consp x
) (= (length x
) 2))
4057 (list (car x
) (nth 1 x
) t
)
4061 (defun org-get-packages-alist (var)
4062 "Get the packages alist and make sure it has 3 elements per entry."
4064 (if (and (consp x
) (= (length x
) 2))
4065 (list (car x
) (nth 1 x
) t
)
4067 (default-value var
)))
4069 (defcustom org-latex-default-packages-alist
4070 '(("AUTO" "inputenc" t
)
4074 ("" "longtable" nil
)
4078 ("normalem" "ulem" t
)
4087 "Alist of default packages to be inserted in the header.
4089 Change this only if one of the packages here causes an
4090 incompatibility with another package you are using.
4092 The packages in this list are needed by one part or another of
4093 Org mode to function properly:
4095 - inputenc, fontenc: for basic font and character selection
4096 - fixltx2e: Important patches of LaTeX itself
4097 - graphicx: for including images
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-absolute-from-iso
"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 "Return t when point (or POS) is in #+TBLFM line."
4576 (goto-char (or pos
(point)))
4577 (beginning-of-line 1)
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
'scheduled-or-deadline
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" scheduled-or-deadline
)
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 :group
'org-sparse-trees
)
4730 (defun org-cycle-hide-archived-subtrees (state)
4731 "Re-hide all archived subtrees after a visibility state change."
4732 (when (and (not org-cycle-open-archived-trees
)
4733 (not (memq state
'(overview folded
))))
4735 (let* ((globalp (memq state
'(contents all
)))
4736 (beg (if globalp
(point-min) (point)))
4737 (end (if globalp
(point-max) (org-end-of-subtree t
))))
4738 (org-hide-archived-subtrees beg end
)
4740 (if (looking-at (concat ".*:" org-archive-tag
":"))
4741 (message "%s" (substitute-command-keys
4742 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4744 (defun org-force-cycle-archived ()
4745 "Cycle subtree even if it is archived."
4747 (setq this-command
'org-cycle
)
4748 (let ((org-cycle-open-archived-trees t
))
4749 (call-interactively 'org-cycle
)))
4751 (defun org-hide-archived-subtrees (beg end
)
4752 "Re-hide all archived subtrees after a visibility state change."
4753 (org-with-wide-buffer
4754 (let ((case-fold-search nil
)
4755 (re (concat org-outline-regexp-bol
".*:" org-archive-tag
":")))
4757 (while (and (< (point) end
) (re-search-forward re end t
))
4758 (when (member org-archive-tag
(org-get-tags))
4759 (org-flag-subtree t
)
4760 (org-end-of-subtree t
))))))
4762 (declare-function outline-end-of-heading
"outline" ())
4763 (declare-function outline-flag-region
"outline" (from to flag
))
4764 (defun org-flag-subtree (flag)
4766 (org-back-to-heading t
)
4767 (outline-end-of-heading)
4768 (outline-flag-region (point)
4769 (progn (org-end-of-subtree t
) (point))
4772 (defalias 'org-advertized-archive-subtree
'org-archive-subtree
)
4774 ;; Declare Column View Code
4776 (declare-function org-columns-number-to-string
"org-colview" (n fmt
&optional printf
))
4777 (declare-function org-columns-get-format-and-top-level
"org-colview" ())
4778 (declare-function org-columns-compute
"org-colview" (property))
4782 (declare-function org-id-store-link
"org-id")
4783 (declare-function org-id-locations-load
"org-id")
4784 (declare-function org-id-locations-save
"org-id")
4785 (defvar org-id-track-globally
)
4787 ;;; Variables for pre-computed regular expressions, all buffer local
4789 (defvar org-todo-regexp nil
4790 "Matches any of the TODO state keywords.")
4791 (make-variable-buffer-local 'org-todo-regexp
)
4792 (defvar org-not-done-regexp nil
4793 "Matches any of the TODO state keywords except the last one.")
4794 (make-variable-buffer-local 'org-not-done-regexp
)
4795 (defvar org-not-done-heading-regexp nil
4796 "Matches a TODO headline that is not done.")
4797 (make-variable-buffer-local 'org-not-done-regexp
)
4798 (defvar org-todo-line-regexp nil
4799 "Matches a headline and puts TODO state into group 2 if present.")
4800 (make-variable-buffer-local 'org-todo-line-regexp
)
4801 (defvar org-complex-heading-regexp nil
4802 "Matches a headline and puts everything into groups:
4804 group 2: The todo keyword, maybe
4805 group 3: Priority cookie
4806 group 4: True headline
4808 (make-variable-buffer-local 'org-complex-heading-regexp
)
4809 (defvar org-complex-heading-regexp-format nil
4810 "Printf format to make regexp to match an exact headline.
4811 This regexp will match the headline of any node which has the
4812 exact headline text that is put into the format, but may have any
4813 TODO state, priority and tags.")
4814 (make-variable-buffer-local 'org-complex-heading-regexp-format
)
4815 (defvar org-todo-line-tags-regexp nil
4816 "Matches a headline and puts TODO state into group 2 if present.
4817 Also put tags into group 4 if tags are present.")
4818 (make-variable-buffer-local 'org-todo-line-tags-regexp
)
4820 (defconst org-plain-time-of-day-regexp
4823 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4826 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4828 "Regular expression to match a plain time or time range.
4829 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4830 groups carry important information:
4832 1 the first time, range or not
4833 8 the second time, if it is a range.")
4835 (defconst org-plain-time-extension-regexp
4838 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4839 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4840 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4841 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4842 groups carry important information:
4845 9 minutes of duration")
4847 (defconst org-stamp-time-of-day-regexp
4849 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4850 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4852 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4853 "Regular expression to match a timestamp time or time range.
4854 After a match, the following groups carry important information:
4856 1 date plus weekday, for back referencing to make sure both times are on the same day
4857 2 the first time, range or not
4858 4 the second time, if it is a range.")
4860 (defconst org-startup-options
4861 '(("fold" org-startup-folded t
)
4862 ("overview" org-startup-folded t
)
4863 ("nofold" org-startup-folded nil
)
4864 ("showall" org-startup-folded nil
)
4865 ("showeverything" org-startup-folded showeverything
)
4866 ("content" org-startup-folded content
)
4867 ("indent" org-startup-indented t
)
4868 ("noindent" org-startup-indented nil
)
4869 ("hidestars" org-hide-leading-stars t
)
4870 ("showstars" org-hide-leading-stars nil
)
4871 ("odd" org-odd-levels-only t
)
4872 ("oddeven" org-odd-levels-only nil
)
4873 ("align" org-startup-align-all-tables t
)
4874 ("noalign" org-startup-align-all-tables nil
)
4875 ("inlineimages" org-startup-with-inline-images t
)
4876 ("noinlineimages" org-startup-with-inline-images nil
)
4877 ("latexpreview" org-startup-with-latex-preview t
)
4878 ("nolatexpreview" org-startup-with-latex-preview nil
)
4879 ("customtime" org-display-custom-times t
)
4880 ("logdone" org-log-done time
)
4881 ("lognotedone" org-log-done note
)
4882 ("nologdone" org-log-done nil
)
4883 ("lognoteclock-out" org-log-note-clock-out t
)
4884 ("nolognoteclock-out" org-log-note-clock-out nil
)
4885 ("logrepeat" org-log-repeat state
)
4886 ("lognoterepeat" org-log-repeat note
)
4887 ("logdrawer" org-log-into-drawer t
)
4888 ("nologdrawer" org-log-into-drawer nil
)
4889 ("logstatesreversed" org-log-states-order-reversed t
)
4890 ("nologstatesreversed" org-log-states-order-reversed nil
)
4891 ("nologrepeat" org-log-repeat nil
)
4892 ("logreschedule" org-log-reschedule time
)
4893 ("lognotereschedule" org-log-reschedule note
)
4894 ("nologreschedule" org-log-reschedule nil
)
4895 ("logredeadline" org-log-redeadline time
)
4896 ("lognoteredeadline" org-log-redeadline note
)
4897 ("nologredeadline" org-log-redeadline nil
)
4898 ("logrefile" org-log-refile time
)
4899 ("lognoterefile" org-log-refile note
)
4900 ("nologrefile" org-log-refile nil
)
4901 ("fninline" org-footnote-define-inline t
)
4902 ("nofninline" org-footnote-define-inline nil
)
4903 ("fnlocal" org-footnote-section nil
)
4904 ("fnauto" org-footnote-auto-label t
)
4905 ("fnprompt" org-footnote-auto-label nil
)
4906 ("fnconfirm" org-footnote-auto-label confirm
)
4907 ("fnplain" org-footnote-auto-label plain
)
4908 ("fnadjust" org-footnote-auto-adjust t
)
4909 ("nofnadjust" org-footnote-auto-adjust nil
)
4910 ("constcgs" constants-unit-system cgs
)
4911 ("constSI" constants-unit-system SI
)
4912 ("noptag" org-tag-persistent-alist nil
)
4913 ("hideblocks" org-hide-block-startup t
)
4914 ("nohideblocks" org-hide-block-startup nil
)
4915 ("beamer" org-startup-with-beamer-mode t
)
4916 ("entitiespretty" org-pretty-entities t
)
4917 ("entitiesplain" org-pretty-entities nil
))
4918 "Variable associated with STARTUP options for org-mode.
4919 Each element is a list of three items: the startup options (as written
4920 in the #+STARTUP line), the corresponding variable, and the value to set
4921 this variable to if the option is found. An optional forth element PUSH
4922 means to push this value onto the list in the variable.")
4924 (defcustom org-group-tags t
4925 "When non-nil (the default), use group tags.
4926 This can be turned on/off through `org-toggle-tags-groups'."
4931 (defvar org-inhibit-startup nil
) ; Dynamically-scoped param.
4933 (defun org-toggle-tags-groups ()
4934 "Toggle support for group tags.
4935 Support for group tags is controlled by the option
4936 `org-group-tags', which is non-nil by default."
4938 (setq org-group-tags
(not org-group-tags
))
4939 (cond ((and (derived-mode-p 'org-agenda-mode
)
4942 ((derived-mode-p 'org-mode
)
4943 (let ((org-inhibit-startup t
)) (org-mode))))
4944 (message "Groups tags support has been turned %s"
4945 (if org-group-tags
"on" "off")))
4947 (defun org-set-regexps-and-options (&optional tags-only
)
4948 "Precompute regular expressions used in the current buffer.
4949 When optional argument TAGS-ONLY is non-nil, only compute tags
4950 related expressions."
4951 (when (derived-mode-p 'org-mode
)
4952 (let ((alist (org--setup-collect-keywords
4953 (org-make-options-regexp
4954 (append '("FILETAGS" "TAGS" "SETUPFILE")
4955 (and (not tags-only
)
4956 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4957 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4958 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4959 (org--setup-process-tags
4960 (cdr (assq 'tags alist
)) (cdr (assq 'filetags alist
)))
4963 (org-set-local 'org-file-properties
(cdr (assq 'property alist
)))
4964 ;; Archive location.
4965 (let ((archive (cdr (assq 'archive alist
))))
4966 (when archive
(org-set-local 'org-archive-location archive
)))
4968 (let ((cat (org-string-nw-p (cdr (assq 'category alist
)))))
4970 (org-set-local 'org-category
(intern cat
))
4971 (org-set-local 'org-file-properties
4972 (org--update-property-plist
4973 "CATEGORY" cat org-file-properties
))))
4975 (let ((column (cdr (assq 'columns alist
))))
4976 (when column
(org-set-local 'org-columns-default-format column
)))
4978 (setq org-table-formula-constants-local
(cdr (assq 'constants alist
)))
4979 ;; Link abbreviations.
4980 (let ((links (cdr (assq 'link alist
))))
4981 (when links
(setq org-link-abbrev-alist-local
(nreverse links
))))
4983 (let ((priorities (cdr (assq 'priorities alist
))))
4985 (org-set-local 'org-highest-priority
(nth 0 priorities
))
4986 (org-set-local 'org-lowest-priority
(nth 1 priorities
))
4987 (org-set-local 'org-default-priority
(nth 2 priorities
))))
4989 (let ((scripts (assq 'scripts alist
)))
4991 (org-set-local 'org-use-sub-superscripts
(cdr scripts
))))
4993 (let ((startup (cdr (assq 'startup alist
))))
4994 (dolist (option startup
)
4995 (let ((entry (assoc-string option org-startup-options t
)))
4997 (let ((var (nth 1 entry
))
4998 (val (nth 2 entry
)))
4999 (if (not (nth 3 entry
)) (org-set-local var val
)
5000 (unless (listp (symbol-value var
))
5001 (org-set-local var nil
))
5002 (add-to-list var val
)))))))
5004 (org-set-local 'org-todo-kwd-alist nil
)
5005 (org-set-local 'org-todo-key-alist nil
)
5006 (org-set-local 'org-todo-key-trigger nil
)
5007 (org-set-local 'org-todo-keywords-1 nil
)
5008 (org-set-local 'org-done-keywords nil
)
5009 (org-set-local 'org-todo-heads nil
)
5010 (org-set-local 'org-todo-sets nil
)
5011 (org-set-local 'org-todo-log-states nil
)
5012 (let ((todo-sequences
5013 (or (nreverse (cdr (assq 'todo alist
)))
5014 (let ((d (default-value 'org-todo-keywords
)))
5015 (if (not (stringp (car d
))) d
5016 ;; XXX: Backward compatibility code.
5017 (list (cons org-todo-interpretation d
)))))))
5018 (dolist (sequence todo-sequences
)
5019 (let* ((sequence (or (run-hook-with-args-until-success
5020 'org-todo-setup-filter-hook sequence
)
5022 (sequence-type (car sequence
))
5023 (keywords (cdr sequence
))
5024 (sep (member "|" keywords
))
5026 (dolist (k (remove "|" keywords
))
5027 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5029 (error "Invalid TODO keyword %s" k
))
5030 (let ((name (match-string 1 k
))
5031 (key (match-string 2 k
))
5032 (log (org-extract-log-state-settings k
)))
5034 (push (cons name
(and key
(string-to-char key
))) alist
)
5035 (when log
(push log org-todo-log-states
))))
5036 (let* ((names (nreverse names
))
5037 (done (if sep
(org-remove-keyword-keys (cdr sep
))
5040 (tail (list sequence-type head
(car done
) (org-last done
))))
5041 (add-to-list 'org-todo-heads head
'append
)
5042 (push names org-todo-sets
)
5043 (setq org-done-keywords
(append org-done-keywords done nil
))
5044 (setq org-todo-keywords-1
(append org-todo-keywords-1 names nil
))
5045 (setq org-todo-key-alist
5046 (append org-todo-key-alist
5048 (append '((:startgroup
))
5051 (dolist (k names
) (push (cons k tail
) org-todo-kwd-alist
))))))
5052 (setq org-todo-sets
(nreverse org-todo-sets
)
5053 org-todo-kwd-alist
(nreverse org-todo-kwd-alist
)
5054 org-todo-key-trigger
(delq nil
(mapcar #'cdr org-todo-key-alist
))
5055 org-todo-key-alist
(org-assign-fast-keys org-todo-key-alist
))
5056 ;; Compute the regular expressions and other local variables.
5057 ;; Using `org-outline-regexp-bol' would complicate them much,
5058 ;; because of the fixed white space at the end of that string.
5059 (if (not org-done-keywords
)
5060 (setq org-done-keywords
5061 (and org-todo-keywords-1
(last org-todo-keywords-1
))))
5062 (setq org-not-done-keywords
5063 (org-delete-all org-done-keywords
5064 (copy-sequence org-todo-keywords-1
))
5065 org-todo-regexp
(regexp-opt org-todo-keywords-1 t
)
5066 org-not-done-regexp
(regexp-opt org-not-done-keywords t
)
5067 org-not-done-heading-regexp
5068 (format org-heading-keyword-regexp-format org-not-done-regexp
)
5069 org-todo-line-regexp
5070 (format org-heading-keyword-maybe-regexp-format org-todo-regexp
)
5071 org-complex-heading-regexp
5072 (concat "^\\(\\*+\\)"
5073 "\\(?: +" org-todo-regexp
"\\)?"
5074 "\\(?: +\\(\\[#.\\]\\)\\)?"
5075 "\\(?: +\\(.*?\\)\\)??"
5076 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5078 org-complex-heading-regexp-format
5079 (concat "^\\(\\*+\\)"
5080 "\\(?: +" org-todo-regexp
"\\)?"
5081 "\\(?: +\\(\\[#.\\]\\)\\)?"
5083 ;; Stats cookies can be stuck to body.
5084 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5086 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5088 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5090 org-todo-line-tags-regexp
5091 (concat "^\\(\\*+\\)"
5092 "\\(?: +" org-todo-regexp
"\\)?"
5093 "\\(?: +\\(.*?\\)\\)??"
5094 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5096 (org-compute-latex-and-related-regexp)))))
5098 (defun org--setup-collect-keywords (regexp &optional files alist
)
5099 "Return setup keywords values as an alist.
5101 REGEXP matches a subset of setup keywords. FILES is a list of
5102 file names already visited. It is used to avoid circular setup
5103 files. ALIST, when non-nil, is the alist computed so far.
5105 Return value contains the following keys: `archive', `category',
5106 `columns', `constants', `filetags', `link', `priorities',
5107 `property', `scripts', `startup', `tags' and `todo'."
5108 (org-with-wide-buffer
5109 (goto-char (point-min))
5110 (let ((case-fold-search t
))
5111 (while (re-search-forward regexp nil t
)
5112 (let ((element (org-element-at-point)))
5113 (when (eq (org-element-type element
) 'keyword
)
5114 (let ((key (org-element-property :key element
))
5115 (value (org-element-property :value element
)))
5117 ((equal key
"ARCHIVE")
5118 (when (org-string-nw-p value
)
5119 (push (cons 'archive value
) alist
)))
5120 ((equal key
"CATEGORY") (push (cons 'category value
) alist
))
5121 ((equal key
"COLUMNS") (push (cons 'columns value
) alist
))
5122 ((equal key
"CONSTANTS")
5123 (let* ((constants (assq 'constants alist
))
5124 (store (cdr constants
)))
5125 (dolist (pair (org-split-string value
))
5126 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5128 (let* ((name (match-string 1 pair
))
5129 (value (match-string 2 pair
))
5130 (old (assoc name store
)))
5131 (if old
(setcdr old value
)
5132 (push (cons name value
) store
)))))
5133 (if constants
(setcdr constants store
)
5134 (push (cons 'constants store
) alist
))))
5135 ((equal key
"FILETAGS")
5136 (when (org-string-nw-p value
)
5137 (let ((old (assq 'filetags alist
))
5139 (mapcar (lambda (x) (org-split-string x
":"))
5140 (org-split-string value
)))))
5141 (if old
(setcdr old
(append new
(cdr old
)))
5142 (push (cons 'filetags new
) alist
)))))
5144 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value
)
5145 (let ((links (assq 'link alist
))
5146 (pair (cons (org-match-string-no-properties 1 value
)
5147 (org-match-string-no-properties 2 value
))))
5148 (if links
(push pair
(cdr links
))
5149 (push (list 'link pair
) alist
)))))
5150 ((equal key
"OPTIONS")
5151 (when (and (org-string-nw-p value
)
5152 (string-match "\\^:\\(t\\|nil\\|{}\\)" value
))
5153 (push (cons 'scripts
(read (match-string 1 value
))) alist
)))
5154 ((equal key
"PRIORITIES")
5155 (push (cons 'priorities
5156 (let ((prio (org-split-string value
)))
5157 (if (< (length prio
) 3) '(?A ?C ?B
)
5158 (mapcar #'string-to-char prio
))))
5160 ((equal key
"PROPERTY")
5161 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value
)
5162 (let* ((property (assq 'property alist
))
5163 (value (org--update-property-plist
5164 (org-match-string-no-properties 1 value
)
5165 (org-match-string-no-properties 2 value
)
5167 (if property
(setcdr property value
)
5168 (push (cons 'property value
) alist
)))))
5169 ((equal key
"STARTUP")
5170 (let ((startup (assq 'startup alist
)))
5173 (append (cdr startup
) (org-split-string value
)))
5174 (push (cons 'startup
(org-split-string value
)) alist
))))
5176 (let ((tag-cell (assq 'tags alist
)))
5179 (append (cdr tag-cell
)
5181 (org-split-string value
)))
5182 (push (cons 'tags
(org-split-string value
)) alist
))))
5183 ((member key
'("TODO" "SEQ_TODO" "TYP_TODO"))
5184 (let ((todo (assq 'todo alist
))
5185 (value (cons (if (equal key
"TYP_TODO") 'type
'sequence
)
5186 (org-split-string value
))))
5187 (if todo
(push value
(cdr todo
))
5188 (push (list 'todo value
) alist
))))
5189 ((equal key
"SETUPFILE")
5190 (unless buffer-read-only
; Do not check in Gnus messages.
5191 (let ((f (and (org-string-nw-p value
)
5193 (org-remove-double-quotes value
)))))
5194 (when (and f
(file-readable-p f
) (not (member f files
)))
5196 (insert-file-contents f
)
5198 ;; Fake Org mode to benefit from cache
5199 ;; without recurring needlessly.
5200 (let ((major-mode 'org-mode
))
5201 (org--setup-collect-keywords
5202 regexp
(cons f files
) alist
)))))))))))))))
5205 (defun org--setup-process-tags (tags filetags
)
5206 "Precompute variables used for tags.
5207 TAGS is a list of tags and tag group symbols, as strings.
5208 FILETAGS is a list of tags, as strings."
5209 ;; Process the file tags.
5210 (org-set-local 'org-file-tags
5211 (mapcar #'org-add-prop-inherited filetags
))
5212 ;; Provide default tags if no local tags are found.
5213 (when (and (not tags
) org-tag-alist
)
5215 (mapcar (lambda (tag)
5221 (otherwise (concat (car tag
)
5222 (and (characterp (cdr tag
))
5223 (format "(%c)" (cdr tag
)))))))
5225 ;; Process the tags.
5226 (org-set-local 'org-tag-groups-alist nil
)
5227 (org-set-local 'org-tag-alist nil
)
5230 (let ((e (car tags
)))
5231 (setq tags
(cdr tags
))
5234 (push '(:startgroup
) org-tag-alist
)
5235 (when (equal (nth 1 tags
) ":") (setq group-flag t
)))
5237 (push '(:endgroup
) org-tag-alist
)
5238 (setq group-flag nil
))
5240 (push '(:grouptags
) org-tag-alist
)
5241 (setq group-flag
'append
))
5242 ((equal e
"\\n") (push '(:newline
) org-tag-alist
))
5244 (org-re "\\`\\([[:alnum:]_@#%]+\\)\\(?:(\\(.\\))\\)?\\'") e
)
5245 (let ((tag (match-string 1 e
))
5246 (key (and (match-beginning 2)
5247 (string-to-char (match-string 2 e
)))))
5248 (cond ((eq group-flag
'append
)
5249 (setcar org-tag-groups-alist
5250 (append (car org-tag-groups-alist
) (list tag
))))
5251 (group-flag (push (list tag
) org-tag-groups-alist
)))
5252 (unless (assoc tag org-tag-alist
)
5253 (push (cons tag key
) org-tag-alist
))))))))
5254 (setq org-tag-alist
(nreverse org-tag-alist
)))
5256 (defun org-file-contents (file &optional noerror
)
5257 "Return the contents of FILE, as a string."
5258 (if (and file
(file-readable-p file
))
5260 (insert-file-contents file
)
5262 (funcall (if noerror
'message
'error
)
5263 "Cannot read file \"%s\"%s"
5265 (let ((from (buffer-file-name (buffer-base-buffer))))
5266 (if from
(concat " (referenced in file \"" from
"\")") "")))))
5268 (defun org-extract-log-state-settings (x)
5269 "Extract the log state setting from a TODO keyword string.
5270 This will extract info from a string like \"WAIT(w@/!)\"."
5271 (let (kw key log1 log2
)
5272 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x
)
5273 (setq kw
(match-string 1 x
)
5274 key
(and (match-end 2) (match-string 2 x
))
5275 log1
(and (match-end 3) (match-string 3 x
))
5276 log2
(and (match-end 4) (match-string 4 x
)))
5279 (and log1
(if (equal log1
"!") 'time
'note
))
5280 (and log2
(if (equal log2
"!") 'time
'note
)))))))
5282 (defun org-remove-keyword-keys (list)
5283 "Remove a pair of parenthesis at the end of each string in LIST."
5285 (if (string-match "(.*)$" x
)
5286 (substring x
0 (match-beginning 0))
5290 (defun org-assign-fast-keys (alist)
5291 "Assign fast keys to a keyword-key alist.
5292 Respect keys that are already there."
5293 (let (new e
(alt ?
0))
5294 (while (setq e
(pop alist
))
5295 (if (or (memq (car e
) '(:newline
:grouptags
:endgroup
:startgroup
))
5296 (cdr e
)) ;; Key already assigned.
5298 (let ((clist (string-to-list (downcase (car e
))))
5299 (used (append new alist
)))
5300 (when (= (car clist
) ?
@)
5302 (while (and clist
(rassoc (car clist
) used
))
5305 (while (rassoc alt used
)
5307 (push (cons (car e
) (or (car clist
) alt
)) new
))))
5310 ;;; Some variables used in various places
5312 (defvar org-window-configuration nil
5313 "Used in various places to store a window configuration.")
5314 (defvar org-selected-window nil
5315 "Used in various places to store a window configuration.")
5316 (defvar org-finish-function nil
5317 "Function to be called when `C-c C-c' is used.
5318 This is for getting out of special buffers like capture.")
5321 ;; FIXME: Occasionally check by commenting these, to make sure
5322 ;; no other functions uses these, forgetting to let-bind them.
5323 (org-no-warnings (defvar entry
)) ;; unprefixed, from calendar.el
5324 (defvar org-last-state
)
5325 (org-no-warnings (defvar date
)) ;; unprefixed, from calendar.el
5327 ;; Defined somewhere in this file, but used before definition.
5328 (defvar org-entities
) ;; defined in org-entities.el
5329 (defvar org-struct-menu
)
5330 (defvar org-org-menu
)
5331 (defvar org-tbl-menu
)
5333 ;;;; Define the Org-mode
5335 ;; We use a before-change function to check if a table might need
5337 (defvar org-table-may-need-update t
5338 "Indicates that a table might need an update.
5339 This variable is set by `org-before-change-function'.
5340 `org-table-align' sets it back to nil.")
5341 (defun org-before-change-function (beg end
)
5342 "Every change indicates that a table might need an update."
5343 (setq org-table-may-need-update t
))
5344 (defvar org-mode-map
)
5345 (defvar org-inhibit-startup-visibility-stuff nil
) ; Dynamically-scoped param.
5346 (defvar org-agenda-keep-modes nil
) ; Dynamically-scoped param.
5347 (defvar org-inhibit-logging nil
) ; Dynamically-scoped param.
5348 (defvar org-inhibit-blocking nil
) ; Dynamically-scoped param.
5349 (defvar org-table-buffer-is-an nil
)
5351 (defvar bidi-paragraph-direction
)
5352 (defvar buffer-face-mode-face
)
5355 (if (and (not (keymapp outline-mode-map
)) (featurep 'allout
))
5356 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
5357 (require 'noutline
"noutline" 'noerror
) ;; stock XEmacs does not have it
5359 ;; Other stuff we need.
5360 (require 'time-date
)
5361 (unless (fboundp 'time-subtract
) (defalias 'time-subtract
'subtract-time
))
5365 ;; (require 'org-macs) moved higher up in the file before it is first used
5366 (require 'org-entities
)
5367 ;; (require 'org-compat) moved higher up in the file before it is first used
5368 (require 'org-faces
)
5370 (require 'org-pcomplete
)
5372 (require 'org-footnote
)
5373 (require 'org-macro
)
5379 (define-derived-mode org-mode outline-mode
"Org"
5380 "Outline-based notes management and organizer, alias
5381 \"Carsten's outline-mode for keeping track of everything.\"
5383 Org-mode develops organizational tasks around a NOTES file which
5384 contains information about projects as plain text. Org-mode is
5385 implemented on top of outline-mode, which is ideal to keep the content
5386 of large files well structured. It supports ToDo items, deadlines and
5387 time stamps, which magically appear in the diary listing of the Emacs
5388 calendar. Tables are easily created with a built-in table editor.
5389 Plain text URL-like links connect to websites, emails (VM), Usenet
5390 messages (Gnus), BBDB entries, and any files related to the project.
5391 For printing and sharing of notes, an Org-mode file (or a part of it)
5392 can be exported as a structured ASCII or HTML file.
5394 The following commands are available:
5398 ;; Get rid of Outline menus, they are not needed
5399 ;; Need to do this here because define-derived-mode sets up
5400 ;; the keymap so late. Still, it is a waste to call this each time
5401 ;; we switch another buffer into org-mode.
5402 (if (featurep 'xemacs
)
5403 (when (boundp 'outline-mode-menu-heading
)
5404 ;; Assume this is Greg's port, it uses easymenu
5405 (easy-menu-remove outline-mode-menu-heading
)
5406 (easy-menu-remove outline-mode-menu-show
)
5407 (easy-menu-remove outline-mode-menu-hide
))
5408 (define-key org-mode-map
[menu-bar headings
] 'undefined
)
5409 (define-key org-mode-map
[menu-bar hide
] 'undefined
)
5410 (define-key org-mode-map
[menu-bar show
] 'undefined
))
5412 (org-load-modules-maybe)
5413 (easy-menu-add org-org-menu
)
5414 (easy-menu-add org-tbl-menu
)
5415 (org-install-agenda-files-menu)
5416 (if org-descriptive-links
(add-to-invisibility-spec '(org-link)))
5417 (add-to-invisibility-spec '(org-cwidth))
5418 (add-to-invisibility-spec '(org-hide-block . t
))
5419 (when (featurep 'xemacs
)
5420 (org-set-local 'line-move-ignore-invisible t
))
5421 (org-set-local 'outline-regexp org-outline-regexp
)
5422 (org-set-local 'outline-level
'org-outline-level
)
5423 (setq bidi-paragraph-direction
'left-to-right
)
5424 (when (and org-ellipsis
5425 (fboundp 'set-display-table-slot
) (boundp 'buffer-display-table
)
5426 (fboundp 'make-glyph-code
))
5427 (unless org-display-table
5428 (setq org-display-table
(make-display-table)))
5429 (set-display-table-slot
5432 (lambda (c) (make-glyph-code c
(and (not (stringp org-ellipsis
))
5434 (if (stringp org-ellipsis
) org-ellipsis
"..."))))
5435 (setq buffer-display-table org-display-table
))
5436 (org-set-regexps-and-options)
5437 (org-set-font-lock-defaults)
5438 (when (and org-tag-faces
(not org-tags-special-faces-re
))
5439 ;; tag faces set outside customize.... force initialization.
5440 (org-set-tag-faces 'org-tag-faces org-tag-faces
))
5442 (org-set-local 'calc-embedded-open-mode
"# ")
5443 ;; Modify a few syntax entries
5444 (modify-syntax-entry ?
@ "w")
5445 (modify-syntax-entry ?
\" "\"")
5446 (modify-syntax-entry ?
\\ "_")
5447 (modify-syntax-entry ?~
"_")
5448 (if org-startup-truncated
(setq truncate-lines t
))
5449 (when org-startup-indented
(require 'org-indent
) (org-indent-mode 1))
5450 (org-set-local 'font-lock-unfontify-region-function
5451 'org-unfontify-region
)
5452 ;; Activate before-change-function
5453 (org-set-local 'org-table-may-need-update t
)
5454 (org-add-hook 'before-change-functions
'org-before-change-function nil
5456 ;; Check for running clock before killing a buffer
5457 (org-add-hook 'kill-buffer-hook
'org-check-running-clock nil
'local
)
5458 ;; Initialize macros templates.
5459 (org-macro-initialize-templates)
5460 ;; Initialize radio targets.
5461 (org-update-radio-target-regexp)
5463 (org-set-local 'indent-line-function
'org-indent-line
)
5464 (org-set-local 'indent-region-function
'org-indent-region
)
5465 ;; Filling and auto-filling.
5468 (org-setup-comments-handling)
5469 ;; Initialize cache.
5470 (org-element-cache-reset)
5471 ;; Beginning/end of defun
5472 (org-set-local 'beginning-of-defun-function
'org-backward-element
)
5473 (org-set-local 'end-of-defun-function
5475 (if (not (org-at-heading-p))
5476 (org-forward-element)
5477 (org-forward-element)
5478 (forward-char -
1))))
5479 ;; Next error for sparse trees
5480 (org-set-local 'next-error-function
'org-occur-next-match
)
5481 ;; Make sure dependence stuff works reliably, even for users who set it
5483 (if org-enforce-todo-dependencies
5484 (add-hook 'org-blocker-hook
5485 'org-block-todo-from-children-or-siblings-or-parent
)
5486 (remove-hook 'org-blocker-hook
5487 'org-block-todo-from-children-or-siblings-or-parent
))
5488 (if org-enforce-todo-checkbox-dependencies
5489 (add-hook 'org-blocker-hook
5490 'org-block-todo-from-checkboxes
)
5491 (remove-hook 'org-blocker-hook
5492 'org-block-todo-from-checkboxes
))
5494 ;; Align options lines
5496 'align-mode-rules-list
5497 '((org-in-buffer-settings
5498 (regexp .
"^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5499 (modes .
'(org-mode)))))
5502 (org-set-local 'imenu-create-index-function
5503 'org-imenu-get-tree
)
5505 ;; Make isearch reveal context
5506 (if (or (featurep 'xemacs
)
5507 (not (boundp 'outline-isearch-open-invisible-function
)))
5508 ;; Emacs 21 and XEmacs make use of the hook
5509 (org-add-hook 'isearch-mode-end-hook
'org-isearch-end
'append
'local
)
5510 ;; Emacs 22 deals with this through a special variable
5511 (org-set-local 'outline-isearch-open-invisible-function
5512 (lambda (&rest ignore
) (org-show-context 'isearch
))))
5514 ;; Setup the pcomplete hooks
5515 (set (make-local-variable 'pcomplete-command-completion-function
)
5516 'org-pcomplete-initial
)
5517 (set (make-local-variable 'pcomplete-command-name-function
)
5518 'org-command-at-point
)
5519 (set (make-local-variable 'pcomplete-default-completion-function
)
5521 (set (make-local-variable 'pcomplete-parse-arguments-function
)
5522 'org-parse-arguments
)
5523 (set (make-local-variable 'pcomplete-termination-string
) "")
5524 (when (>= emacs-major-version
23)
5525 (set (make-local-variable 'buffer-face-mode-face
) 'org-default
))
5527 ;; If empty file that did not turn on org-mode automatically, make it to.
5528 (if (and org-insert-mode-line-in-empty-file
5529 (org-called-interactively-p 'any
)
5530 (= (point-min) (point-max)))
5531 (insert "# -*- mode: org -*-\n\n"))
5532 (unless org-inhibit-startup
5534 (and org-startup-with-beamer-mode
(org-beamer-mode))
5535 (when org-startup-align-all-tables
5536 (org-table-map-tables 'org-table-align
'quietly
))
5537 (when org-startup-with-inline-images
5538 (org-display-inline-images))
5539 (when org-startup-with-latex-preview
5540 (org-toggle-latex-fragment))
5541 (unless org-inhibit-startup-visibility-stuff
5542 (org-set-startup-visibility))
5543 (org-refresh-effort-properties)))
5544 ;; Try to set org-hide correctly
5545 (let ((foreground (org-find-invisible-foreground)))
5547 (set-face-foreground 'org-hide foreground
))))
5549 ;; Update `customize-package-emacs-version-alist'
5550 (add-to-list 'customize-package-emacs-version-alist
5551 '(Org ("6.21b" .
"23.1") ("6.33x" .
"23.2")
5552 ("7.8.11" .
"24.1") ("7.9.4" .
"24.3")
5553 ("8.2.6" .
"24.4") ("8.3" .
"25.1")))
5555 (defvar org-mode-transpose-word-syntax-table
5556 (let ((st (make-syntax-table text-mode-syntax-table
)))
5557 (mapc (lambda(c) (modify-syntax-entry
5558 (string-to-char (car c
)) "w p" st
))
5562 (when (fboundp 'abbrev-table-put
)
5563 (abbrev-table-put org-mode-abbrev-table
5564 :parents
(list text-mode-abbrev-table
)))
5566 (defun org-find-invisible-foreground ()
5567 (let ((candidates (remove
5570 (list (face-background 'default
)
5571 (face-background 'org-default
))
5574 (when (boundp alist
)
5575 (cdr (assoc 'background-color
(symbol-value alist
)))))
5576 '(default-frame-alist initial-frame-alist window-system-default-frame-alist
))
5577 (list (face-foreground 'org-hide
))))))
5578 (car (remove nil candidates
))))
5580 (defun org-current-time (&optional rounding-minutes past
)
5581 "Current time, possibly rounded to ROUNDING-MINUTES.
5582 When ROUNDING-MINUTES is not an integer, fall back on the car of
5583 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5584 the rounding returns a past time."
5585 (let ((r (or (and (integerp rounding-minutes
) rounding-minutes
)
5586 (car org-time-stamp-rounding-minutes
)))
5587 (time (decode-time)) res
)
5592 (append (list 0 (* r
(floor (+ .5 (/ (float (nth 1 time
)) r
)))))
5594 (if (and past
(< (org-float-time (time-subtract (current-time) res
)) 0))
5595 (seconds-to-time (- (org-float-time res
) (* r
60)))
5599 "Return today date, considering `org-extend-today-until'."
5601 (time-subtract (current-time)
5602 (list 0 (* 3600 org-extend-today-until
) 0))))
5604 ;;;; Font-Lock stuff, including the activators
5606 (defvar org-mouse-map
(make-sparse-keymap))
5607 (org-defkey org-mouse-map
[mouse-2
] 'org-open-at-mouse
)
5608 (org-defkey org-mouse-map
[mouse-3
] 'org-find-file-at-mouse
)
5609 (when org-mouse-1-follows-link
5610 (org-defkey org-mouse-map
[follow-link
] 'mouse-face
))
5611 (when org-tab-follows-link
5612 (org-defkey org-mouse-map
[(tab)] 'org-open-at-point
)
5613 (org-defkey org-mouse-map
"\C-i" 'org-open-at-point
))
5615 (require 'font-lock
)
5617 (defconst org-non-link-chars
"]\t\n\r<>")
5618 (defvar org-link-types
'("http" "https" "ftp" "mailto" "file" "file+emacs"
5619 "file+sys" "news" "shell" "elisp" "doi" "message"
5621 (defvar org-link-types-re nil
5622 "Matches a link that has a url-like prefix like \"http:\"")
5623 (defvar org-link-re-with-space nil
5624 "Matches a link with spaces, optional angular brackets around it.")
5625 (defvar org-link-re-with-space2 nil
5626 "Matches a link with spaces, optional angular brackets around it.")
5627 (defvar org-link-re-with-space3 nil
5628 "Matches a link with spaces, only for internal part in bracket links.")
5629 (defvar org-angle-link-re nil
5630 "Matches link with angular brackets, spaces are allowed.")
5631 (defvar org-plain-link-re nil
5632 "Matches plain link, without spaces.")
5633 (defvar org-bracket-link-regexp nil
5634 "Matches a link in double brackets.")
5635 (defvar org-bracket-link-analytic-regexp nil
5636 "Regular expression used to analyze links.
5637 Here is what the match groups contain after a match:
5643 (defvar org-bracket-link-analytic-regexp
++ nil
5644 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5645 (defvar org-any-link-re nil
5646 "Regular expression matching any link.")
5648 (defconst org-match-sexp-depth
3
5649 "Number of stacked braces for sub/superscript matching.")
5651 (defun org-create-multibrace-regexp (left right n
)
5652 "Create a regular expression which will match a balanced sexp.
5653 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5654 as single character strings.
5655 The regexp returned will match the entire expression including the
5656 delimiters. It will also define a single group which contains the
5657 match except for the outermost delimiters. The maximum depth of
5658 stacked delimiters is N. Escaping delimiters is not possible."
5659 (let* ((nothing (concat "[^" left right
"]*?"))
5662 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
5665 re
(concat re or next
)
5666 next
(concat "\\(?:" nothing left next right
"\\)+" nothing
)))
5667 (concat left
"\\(" re
"\\)" right
)))
5669 (defconst org-match-substring-regexp
5671 "\\(\\S-\\)\\([_^]\\)\\("
5672 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
5674 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
5676 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5677 "The regular expression matching a sub- or superscript.")
5679 (defconst org-match-substring-with-braces-regexp
5681 "\\(\\S-\\)\\([_^]\\)"
5682 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)")
5683 "The regular expression matching a sub- or superscript, forcing braces.")
5685 (defun org-make-link-regexps ()
5686 "Update the link regular expressions.
5687 This should be called after the variable `org-link-types' has changed."
5688 (let ((types-re (regexp-opt org-link-types t
)))
5689 (setq org-link-types-re
5690 (concat "\\`" types-re
":")
5691 org-link-re-with-space
5692 (concat "<?" types-re
":"
5693 "\\([^" org-non-link-chars
" ]"
5694 "[^" org-non-link-chars
"]*"
5695 "[^" org-non-link-chars
" ]\\)>?")
5696 org-link-re-with-space2
5697 (concat "<?" types-re
":"
5698 "\\([^" org-non-link-chars
" ]"
5700 "[^" org-non-link-chars
" ]\\)>?")
5701 org-link-re-with-space3
5702 (concat "<?" types-re
":"
5703 "\\([^" org-non-link-chars
" ]"
5706 (concat "<" types-re
":"
5707 "\\([^" org-non-link-chars
" ]"
5708 "[^" org-non-link-chars
"]*"
5713 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5714 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5715 org-bracket-link-regexp
5716 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5717 org-bracket-link-analytic-regexp
5720 "\\(" types-re
":\\)?"
5723 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5725 org-bracket-link-analytic-regexp
++
5728 "\\(" (regexp-opt (cons "coderef" org-link-types
) t
) ":\\)?"
5731 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5734 (concat "\\(" org-bracket-link-regexp
"\\)\\|\\("
5735 org-angle-link-re
"\\)\\|\\("
5736 org-plain-link-re
"\\)"))))
5738 (org-make-link-regexps)
5740 (defvar org-emph-face nil
)
5742 (defun org-do-emphasis-faces (limit)
5743 "Run through the buffer and emphasize strings."
5745 (while (and (not rtn
) (re-search-forward org-emph-re limit t
))
5746 (let* ((border (char-after (match-beginning 3)))
5747 (bre (regexp-quote (char-to-string border
))))
5748 (if (and (not (= border
(char-after (match-beginning 4))))
5749 (not (save-match-data
5750 (string-match (concat bre
".*" bre
)
5751 (replace-regexp-in-string
5753 (substring (match-string 2) 1 -
1))))))
5756 (setq a
(assoc (match-string 3) org-emphasis-alist
))
5757 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5761 (org-remove-flyspell-overlays-in
5762 (match-beginning 0) (match-end 0)))
5763 (add-text-properties (match-beginning 2) (match-end 2)
5764 '(font-lock-multiline t org-emphasis t
))
5765 (when org-hide-emphasis-markers
5766 (add-text-properties (match-end 4) (match-beginning 5)
5767 '(invisible org-link
))
5768 (add-text-properties (match-beginning 3) (match-end 3)
5769 '(invisible org-link
))))))
5770 (goto-char (1+ (match-beginning 0))))
5773 (defun org-emphasize (&optional char
)
5774 "Insert or change an emphasis, i.e. a font like bold or italic.
5775 If there is an active region, change that region to a new emphasis.
5776 If there is no region, just insert the marker characters and position
5777 the cursor between them.
5778 CHAR should be the marker character. If it is a space, it means to
5779 remove the emphasis of the selected region.
5780 If CHAR is not given (for example in an interactive call) it will be
5783 (let ((erc org-emphasis-regexp-components
)
5785 (string "") beg end move c s
)
5786 (if (org-region-active-p)
5787 (setq beg
(region-beginning) end
(region-end)
5788 string
(buffer-substring beg end
))
5792 (message "Emphasis marker or tag: [%s]"
5793 (mapconcat (lambda(e) (car e
)) org-emphasis-alist
""))
5794 (setq char
(read-char-exclusive)))
5795 (if (equal char ?\
)
5796 (setq s
"" move nil
)
5797 (unless (assoc (char-to-string char
) org-emphasis-alist
)
5798 (user-error "No such emphasis marker: \"%c\"" char
))
5799 (setq s
(char-to-string char
)))
5800 (while (and (> (length string
) 1)
5801 (equal (substring string
0 1) (substring string -
1))
5802 (assoc (substring string
0 1) org-emphasis-alist
))
5803 (setq string
(substring string
1 -
1)))
5804 (setq string
(concat s string s
))
5805 (if beg
(delete-region beg end
))
5807 (string-match (concat "[" (nth 0 erc
) "\n]")
5808 (char-to-string (char-before (point)))))
5811 (string-match (concat "[" (nth 1 erc
) "\n]")
5812 (char-to-string (char-after (point)))))
5813 (insert " ") (backward-char 1))
5815 (and move
(backward-char 1))))
5817 (defconst org-nonsticky-props
5818 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link
))
5820 (defsubst org-rear-nonsticky-at
(pos)
5821 (add-text-properties (1- pos
) pos
(list 'rear-nonsticky org-nonsticky-props
)))
5823 (defun org-activate-plain-links (limit)
5824 "Add link properties for plain links."
5826 (when (and (re-search-forward (concat org-plain-link-re
) limit t
)
5827 (not (member 'org-tag
5828 (get-text-property (1- (match-beginning 0)) 'face
)))
5829 (not (org-in-src-block-p)))
5830 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5831 (setq f
(get-text-property (match-beginning 0) 'face
))
5832 (setq hl
(org-match-string-no-properties 0))
5833 (if (or (eq f
'org-tag
)
5834 (and (listp f
) (memq 'org-tag f
)))
5836 (add-text-properties (match-beginning 0) (match-end 0)
5837 (list 'mouse-face
'highlight
5839 'htmlize-link
`(:uri
,hl
)
5840 'keymap org-mouse-map
))
5841 (org-rear-nonsticky-at (match-end 0)))
5844 (defun org-activate-code (limit)
5845 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t
)
5847 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5848 (remove-text-properties (match-beginning 0) (match-end 0)
5849 '(display t invisible t intangible t
))
5852 (defcustom org-src-fontify-natively t
5853 "When non-nil, fontify code in code blocks."
5856 :package-version
'(Org .
"8.3")
5857 :group
'org-appearance
5860 (defcustom org-allow-promoting-top-level-subtree nil
5861 "When non-nil, allow promoting a top level subtree.
5862 The leading star of the top level headline will be replaced
5866 :group
'org-appearance
)
5868 (defun org-fontify-meta-lines-and-blocks (limit)
5870 (org-fontify-meta-lines-and-blocks-1 limit
)
5871 (error (message "org-mode fontification error"))))
5873 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5874 "Fontify #+ lines and blocks."
5875 (let ((case-fold-search t
))
5876 (if (re-search-forward
5877 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5879 (let ((beg (match-beginning 0))
5880 (block-start (match-end 0))
5882 (lang (match-string 7))
5883 (beg1 (line-beginning-position 2))
5884 (dc1 (downcase (match-string 2)))
5885 (dc3 (downcase (match-string 3)))
5886 end end1 quoting block-type ovl
)
5888 ((member dc1
'("+html:" "+ascii:" "+latex:"))
5889 ;; a single line of backend-specific content
5890 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5891 (remove-text-properties (match-beginning 0) (match-end 0)
5892 '(display t invisible t intangible t
))
5893 (add-text-properties (match-beginning 1) (match-end 3)
5894 '(font-lock-fontified t face org-meta-line
))
5895 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5896 '(font-lock-fontified t face org-block
))
5897 ; for backend-specific code
5899 ((and (match-end 4) (equal dc3
"+begin"))
5901 (setq block-type
(downcase (match-string 5))
5902 quoting
(member block-type org-protecting-blocks
))
5903 (when (re-search-forward
5904 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5905 nil t
) ;; on purpose, we look further than LIMIT
5906 (setq end
(min (point-max) (match-end 0))
5907 end1
(min (point-max) (1- (match-beginning 0))))
5908 (setq block-end
(match-beginning 0))
5910 (org-remove-flyspell-overlays-in beg1 end1
)
5911 (remove-text-properties beg end
5912 '(display t invisible t intangible t
)))
5913 (add-text-properties
5914 beg end
'(font-lock-fontified t font-lock-multiline t
))
5915 (add-text-properties beg beg1
'(face org-meta-line
))
5916 (org-remove-flyspell-overlays-in beg beg1
)
5917 (add-text-properties ; For end_src
5918 end1
(min (point-max) (1+ end
)) '(face org-meta-line
))
5919 (org-remove-flyspell-overlays-in end1 end
)
5921 ((and lang
(not (string= lang
"")) org-src-fontify-natively
)
5922 (org-src-font-lock-fontify-block lang block-start block-end
)
5923 (add-text-properties beg1 block-end
'(src-block t
)))
5925 (add-text-properties beg1
(min (point-max) (1+ end1
))
5926 '(face org-block
))) ; end of source block
5927 ((not org-fontify-quote-and-verse-blocks
))
5928 ((string= block-type
"quote")
5929 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-quote
)))
5930 ((string= block-type
"verse")
5931 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-verse
))))
5932 (add-text-properties beg beg1
'(face org-block-begin-line
))
5933 (add-text-properties (min (point-max) (1+ end
)) (min (point-max) (1+ end1
))
5934 '(face org-block-end-line
))
5936 ((member dc1
'("+title:" "+author:" "+email:" "+date:"))
5937 (org-remove-flyspell-overlays-in
5939 (if (equal "+title:" dc1
) (match-end 2) (match-end 0)))
5940 (add-text-properties
5942 (if (member (intern (substring dc1
1 -
1)) org-hidden-keywords
)
5943 '(font-lock-fontified t invisible t
)
5944 '(font-lock-fontified t face org-document-info-keyword
)))
5945 (add-text-properties
5946 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5947 (if (string-equal dc1
"+title:")
5948 '(font-lock-fontified t face org-document-title
)
5949 '(font-lock-fontified t face org-document-info
))))
5950 ((or (equal dc1
"+results")
5951 (member dc1
'("+begin:" "+end:" "+caption:" "+label:"
5952 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5953 "+call:" "+header:" "+headers:" "+name:"))
5954 (and (match-end 4) (equal dc3
"+attr")))
5955 (org-remove-flyspell-overlays-in
5957 (if (equal "+caption:" dc1
) (match-end 2) (match-end 0)))
5958 (add-text-properties
5960 '(font-lock-fontified t face org-meta-line
))
5962 ((member dc3
'(" " ""))
5963 (org-remove-flyspell-overlays-in beg
(match-end 0))
5964 (add-text-properties
5966 '(font-lock-fontified t face font-lock-comment-face
)))
5967 (t ;; just any other in-buffer setting, but not indented
5968 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5969 (add-text-properties
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.
6239 If this is called at a normal headline, the level is the number of stars.
6240 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6242 (if (not (ignore-errors (org-back-to-heading t
)))
6244 (looking-at org-outline-regexp
)
6245 (1- (- (match-end 0) (match-beginning 0))))))
6247 (defvar org-font-lock-keywords nil
)
6249 (defsubst org-re-property
(property &optional literal allow-null
)
6250 "Return a regexp matching a PROPERTY line.
6252 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6253 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6254 non-nil, match properties even without a value.
6256 Match group 3 is set to the value when it exists. If there is no
6257 value and ALLOW-NULL is non-nil, it is set to the empty string."
6260 (format "\\(?1::\\(?2:%s\\):\\)"
6261 (if literal property
(regexp-quote property
)))
6263 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$"
6264 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$")))
6266 (defconst org-property-re
6267 (org-re-property "\\S-+" 'literal t
)
6268 "Regular expression matching a property line.
6269 There are four matching groups:
6270 1: :PROPKEY: including the leading and trailing colon,
6271 2: PROPKEY without the leading and trailing colon,
6272 3: PROPVAL without leading or trailing spaces,
6273 4: the indentation of the current line,
6274 5: trailing whitespace.")
6276 (defvar org-font-lock-hook nil
6277 "Functions to be called for special font lock stuff.")
6279 (defvar org-font-lock-set-keywords-hook nil
6280 "Functions that can manipulate `org-font-lock-extra-keywords'.
6281 This is called after `org-font-lock-extra-keywords' is defined, but before
6282 it is installed to be used by font lock. This can be useful if something
6283 needs to be inserted at a specific position in the font-lock sequence.")
6285 (defun org-font-lock-hook (limit)
6286 "Run `org-font-lock-hook' within LIMIT."
6287 (run-hook-with-args 'org-font-lock-hook limit
))
6289 (defun org-set-font-lock-defaults ()
6290 "Set font lock defaults for the current buffer."
6291 (let* ((em org-fontify-emphasized-text
)
6292 (lk org-highlight-links
)
6293 (org-font-lock-extra-keywords
6296 '(org-font-lock-hook)
6298 `(,(if org-fontify-whole-heading-line
6299 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6300 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6301 (1 (org-get-level-face 1))
6302 (2 (org-get-level-face 2))
6303 (3 (org-get-level-face 3)))
6305 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6308 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t
))
6309 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t
))
6310 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t
))
6311 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t
))
6313 '(org-fontify-drawers)
6315 (list org-property-re
6316 '(1 'org-special-keyword t
)
6317 '(3 'org-property-value t
))
6319 (if (memq 'tag lk
) '(org-activate-tags (1 'org-tag prepend
)))
6320 (if (memq 'angle lk
) '(org-activate-angle-links (0 'org-link t
)))
6321 (if (memq 'plain lk
) '(org-activate-plain-links (0 'org-link t
)))
6322 (if (memq 'bracket lk
) '(org-activate-bracket-links (0 'org-link t
)))
6323 (if (memq 'radio lk
) '(org-activate-target-links (1 'org-link t
)))
6324 (if (memq 'date lk
) '(org-activate-dates (0 'org-date t
)))
6325 (if (memq 'footnote lk
) '(org-activate-footnote-links))
6327 (list org-any-target-regexp
'(0 'org-target t
))
6329 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t
))
6331 '(org-fontify-macros)
6332 '(org-hide-wide-columns (0 nil append
))
6334 (list (format org-heading-keyword-regexp-format
6336 '(2 (org-get-todo-face 2) t
))
6338 (if org-fontify-done-headline
6339 (list (format org-heading-keyword-regexp-format
6342 (mapconcat 'regexp-quote org-done-keywords
"\\|")
6344 '(2 'org-headline-done t
))
6347 '(org-font-lock-add-priority-faces)
6349 '(org-font-lock-add-tag-faces)
6351 (if (and org-group-tags org-tag-groups-alist
)
6352 (list (concat org-outline-regexp-bol
".+\\(:"
6353 (regexp-opt (mapcar 'car org-tag-groups-alist
))
6355 '(1 'org-tag-group prepend
)))
6357 (list (concat "\\<" org-comment-string
) '(0 'org-special-keyword t
))
6358 (list (concat "\\<" org-deadline-string
) '(0 'org-special-keyword t
))
6359 (list (concat "\\<" org-scheduled-string
) '(0 'org-special-keyword t
))
6360 (list (concat "\\<" org-closed-string
) '(0 'org-special-keyword t
))
6361 (list (concat "\\<" org-clock-string
) '(0 'org-special-keyword t
))
6364 (if (featurep 'xemacs
)
6365 '(org-do-emphasis-faces (0 nil append
))
6366 '(org-do-emphasis-faces)))
6368 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6369 1 'org-checkbox prepend
)
6370 (if (cdr (assq 'checkbox org-list-automatic-rules
))
6371 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6372 (0 (org-get-checkbox-statistics-face) t
)))
6373 ;; Description list items
6374 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6375 1 'org-list-dt prepend
)
6376 ;; ARCHIVEd headings
6378 org-outline-regexp-bol
6379 "\\(.*:" org-archive-tag
":.*\\)")
6380 '(1 'org-archived prepend
))
6382 '(org-do-latex-and-related)
6383 '(org-fontify-entities)
6384 '(org-raise-scripts)
6386 '(org-activate-code (1 'org-code t
))
6389 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6392 '(9 'org-special-keyword t
))
6393 ;; Blocks and meta lines
6394 '(org-fontify-meta-lines-and-blocks))))
6395 (setq org-font-lock-extra-keywords
(delq nil org-font-lock-extra-keywords
))
6396 (run-hooks 'org-font-lock-set-keywords-hook
)
6397 ;; Now set the full font-lock-keywords
6398 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords
)
6399 (org-set-local 'font-lock-defaults
6400 '(org-font-lock-keywords t nil nil backward-paragraph
))
6401 (kill-local-variable 'font-lock-keywords
) nil
))
6403 (defun org-toggle-pretty-entities ()
6404 "Toggle the composition display of entities as UTF8 characters."
6406 (org-set-local 'org-pretty-entities
(not org-pretty-entities
))
6407 (org-restart-font-lock)
6408 (if org-pretty-entities
6409 (message "Entities are now displayed as UTF8 characters")
6412 (org-decompose-region (point-min) (point-max))
6413 (message "Entities are now displayed as plain text"))))
6415 (defvar org-custom-properties-overlays nil
6416 "List of overlays used for custom properties.")
6417 (make-variable-buffer-local 'org-custom-properties-overlays
)
6419 (defun org-toggle-custom-properties-visibility ()
6420 "Display or hide properties in `org-custom-properties'."
6422 (if org-custom-properties-overlays
6423 (progn (mapc #'delete-overlay org-custom-properties-overlays
)
6424 (setq org-custom-properties-overlays nil
))
6425 (when org-custom-properties
6426 (org-with-wide-buffer
6427 (goto-char (point-min))
6428 (let ((regexp (org-re-property (regexp-opt org-custom-properties
) t t
)))
6429 (while (re-search-forward regexp nil t
)
6430 (let ((end (cdr (save-match-data (org-get-property-block)))))
6431 (when (and end
(< (point) end
))
6432 ;; Hide first custom property in current drawer.
6433 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6434 (overlay-put o
'invisible t
)
6435 (overlay-put o
'org-custom-property t
)
6436 (push o org-custom-properties-overlays
))
6437 ;; Hide additional custom properties in the same drawer.
6438 (while (re-search-forward regexp end t
)
6439 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6440 (overlay-put o
'invisible t
)
6441 (overlay-put o
'org-custom-property t
)
6442 (push o org-custom-properties-overlays
)))))
6443 ;; Each entry is limited to a single property drawer.
6444 (outline-next-heading)))))))
6446 (defun org-fontify-entities (limit)
6447 "Find an entity to fontify."
6449 (when org-pretty-entities
6451 (while (re-search-forward
6452 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6454 (if (and (not (org-at-comment-p))
6455 (setq ee
(org-entity-get (match-string 1)))
6456 (= (length (nth 6 ee
)) 1))
6458 ((end (if (equal (match-string 2) "{}")
6461 (add-text-properties
6462 (match-beginning 0) end
6463 (list 'font-lock-fontified t
))
6464 (compose-region (match-beginning 0) end
6470 (defun org-fontify-like-in-org-mode (s &optional odd-levels
)
6471 "Fontify string S like in Org-mode."
6474 (let ((org-odd-levels-only odd-levels
))
6482 (defun org-get-level-face (n)
6483 "Get the right face for match N in font-lock matching of headlines."
6484 (setq org-l
(- (match-end 2) (match-beginning 1) 1))
6485 (if org-odd-levels-only
(setq org-l
(1+ (/ org-l
2))))
6486 (if org-cycle-level-faces
6487 (setq org-f
(nth (%
(1- org-l
) org-n-level-faces
) org-level-faces
))
6488 (setq org-f
(nth (1- (min org-l org-n-level-faces
)) org-level-faces
)))
6490 ((eq n
1) (if org-hide-leading-stars
'org-hide org-f
))
6492 (t (if org-level-color-stars-only nil org-f
))))
6495 (defun org-get-todo-face (kwd)
6496 "Get the right face for a TODO keyword KWD.
6497 If KWD is a number, get the corresponding match group."
6498 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6499 (or (org-face-from-face-or-color
6500 'todo
'org-todo
(cdr (assoc kwd org-todo-keyword-faces
)))
6501 (and (member kwd org-done-keywords
) 'org-done
)
6504 (defun org-face-from-face-or-color (context inherit face-or-color
)
6505 "Create a face list that inherits INHERIT, but sets the foreground color.
6506 When FACE-OR-COLOR is not a string, just return it."
6507 (if (stringp face-or-color
)
6508 (list :inherit inherit
6509 (cdr (assoc context org-faces-easy-properties
))
6513 (defun org-font-lock-add-tag-faces (limit)
6514 "Add the special tag faces."
6515 (when (and org-tag-faces org-tags-special-faces-re
)
6516 (while (re-search-forward org-tags-special-faces-re limit t
)
6517 (add-text-properties (match-beginning 1) (match-end 1)
6518 (list 'face
(org-get-tag-face 1)
6519 'font-lock-fontified t
))
6520 (backward-char 1))))
6522 (defun org-font-lock-add-priority-faces (limit)
6523 "Add the special priority faces."
6524 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t
)
6525 (when (save-match-data (org-at-heading-p))
6526 (add-text-properties
6527 (match-beginning 0) (match-end 0)
6528 (list 'face
(or (org-face-from-face-or-color
6529 'priority
'org-priority
6530 (cdr (assoc (char-after (match-beginning 1))
6531 org-priority-faces
)))
6533 'font-lock-fontified t
)))))
6535 (defun org-get-tag-face (kwd)
6536 "Get the right face for a TODO keyword KWD.
6537 If KWD is a number, get the corresponding match group."
6538 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6539 (or (org-face-from-face-or-color
6540 'tag
'org-tag
(cdr (assoc kwd org-tag-faces
)))
6543 (defun org-unfontify-region (beg end
&optional maybe_loudly
)
6544 "Remove fontification and activation overlays from links."
6545 (font-lock-default-unfontify-region beg end
)
6546 (let* ((buffer-undo-list t
)
6547 (inhibit-read-only t
) (inhibit-point-motion-hooks t
)
6548 (inhibit-modification-hooks t
)
6549 deactivate-mark buffer-file-name buffer-file-truename
)
6550 (org-decompose-region beg end
)
6551 (remove-text-properties beg end
6552 '(mouse-face t keymap t org-linked-text t
6553 invisible t intangible t
6555 (org-remove-font-lock-display-properties beg end
)))
6557 (defconst org-script-display
'(((raise -
0.3) (height 0.7))
6558 ((raise 0.3) (height 0.7))
6561 "Display properties for showing superscripts and subscripts.")
6563 (defun org-remove-font-lock-display-properties (beg end
)
6564 "Remove specific display properties that have been added by font lock.
6565 The will remove the raise properties that are used to show superscripts
6569 (setq next
(next-single-property-change beg
'display nil end
)
6570 prop
(get-text-property beg
'display
))
6571 (if (member prop org-script-display
)
6572 (put-text-property beg next
'display nil
))
6575 (defun org-raise-scripts (limit)
6576 "Add raise properties to sub/superscripts."
6577 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
)
6578 (if (re-search-forward
6579 (if (eq org-use-sub-superscripts t
)
6580 org-match-substring-regexp
6581 org-match-substring-with-braces-regexp
)
6583 (let* ((pos (point)) table-p comment-p
6584 (mpos (match-beginning 3))
6585 (emph-p (get-text-property mpos
'org-emphasis
))
6586 (link-p (get-text-property mpos
'mouse-face
))
6587 (keyw-p (eq 'org-special-keyword
(get-text-property mpos
'face
))))
6588 (goto-char (point-at-bol))
6589 (setq table-p
(org-looking-at-p org-table-dataline-regexp
)
6590 comment-p
(org-looking-at-p "^[ \t]*#[ +]"))
6593 (if (member (char-after) '(?_ ?^
)) (goto-char (1- pos
)))
6594 (if (or comment-p emph-p link-p keyw-p
)
6596 (put-text-property (match-beginning 3) (match-end 0)
6598 (if (equal (char-after (match-beginning 2)) ?^
)
6599 (nth (if table-p
3 1) org-script-display
)
6600 (nth (if table-p
2 0) org-script-display
)))
6601 (add-text-properties (match-beginning 2) (match-end 2)
6603 'org-dwidth t
'org-dwidth-n
1))
6604 (if (and (eq (char-after (match-beginning 3)) ?
{)
6605 (eq (char-before (match-end 3)) ?
}))
6607 (add-text-properties
6608 (match-beginning 3) (1+ (match-beginning 3))
6609 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))
6610 (add-text-properties
6611 (1- (match-end 3)) (match-end 3)
6612 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))))
6615 ;;;; Visibility cycling, including org-goto and indirect buffer
6619 (defvar org-cycle-global-status nil
)
6620 (make-variable-buffer-local 'org-cycle-global-status
)
6621 (put 'org-cycle-global-status
'org-state t
)
6622 (defvar org-cycle-subtree-status nil
)
6623 (make-variable-buffer-local 'org-cycle-subtree-status
)
6624 (put 'org-cycle-subtree-status
'org-state t
)
6626 (defvar org-inlinetask-min-level
)
6628 (defun org-unlogged-message (&rest args
)
6629 "Display a message, but avoid logging it in the *Messages* buffer."
6630 (let ((message-log-max nil
))
6631 (apply 'message args
)))
6634 (defun org-cycle (&optional arg
)
6635 "TAB-action and visibility cycling for Org-mode.
6637 This is the command invoked in Org-mode by the TAB key. Its main purpose
6638 is outline visibility cycling, but it also invokes other actions
6639 in special contexts.
6641 - When this function is called with a prefix argument, rotate the entire
6642 buffer through 3 states (global cycling)
6643 1. OVERVIEW: Show only top-level headlines.
6644 2. CONTENTS: Show all headlines of all levels, but no body text.
6645 3. SHOW ALL: Show everything.
6646 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6647 determined by the variable `org-startup-folded', and by any VISIBILITY
6648 properties in the buffer.
6649 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6650 including any drawers.
6652 - When inside a table, re-align the table and move to the next field.
6654 - When point is at the beginning of a headline, rotate the subtree started
6655 by this line through 3 different states (local cycling)
6656 1. FOLDED: Only the main headline is shown.
6657 2. CHILDREN: The main headline and the direct children are shown.
6658 From this state, you can move to one of the children
6659 and zoom in further.
6660 3. SUBTREE: Show the entire subtree, including body text.
6661 If there is no subtree, switch directly from CHILDREN to FOLDED.
6663 - When point is at the beginning of an empty headline and the variable
6664 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6665 of the headline by demoting and promoting it to likely levels. This
6666 speeds up creation document structure by pressing TAB once or several
6667 times right after creating a new headline.
6669 - When there is a numeric prefix, go up to a heading with level ARG, do
6670 a `show-subtree' and return to the previous cursor position. If ARG
6671 is negative, go up that many levels.
6673 - When point is not at the beginning of a headline, execute the global
6674 binding for TAB, which is re-indenting the line. See the option
6675 `org-cycle-emulate-tab' for details.
6677 - Special case: if point is at the beginning of the buffer and there is
6678 no headline in line 1, this function will act as if called with prefix arg
6679 (C-u TAB, same as S-TAB) also when called without prefix arg.
6680 But only if also the variable `org-cycle-global-at-bob' is t."
6682 (org-load-modules-maybe)
6683 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook
)
6684 (and org-cycle-level-after-item
/entry-creation
6685 (or (org-cycle-level)
6686 (org-cycle-item-indentation))))
6688 (or org-cycle-max-level
6689 (and (boundp 'org-inlinetask-min-level
)
6690 org-inlinetask-min-level
6691 (1- org-inlinetask-min-level
))))
6692 (nstars (and limit-level
6693 (if org-odd-levels-only
6694 (and limit-level
(1- (* limit-level
2)))
6697 (if (not (derived-mode-p 'org-mode
))
6699 (concat "\\*" (if nstars
(format "\\{1,%d\\} " nstars
) "+ "))))
6700 (bob-special (and org-cycle-global-at-bob
(not arg
) (bobp)
6701 (not (looking-at org-outline-regexp
))))
6704 (delq 'org-optimize-window-after-visibility-change
6705 (copy-sequence org-cycle-hook
))
6709 (if (or bob-special
(equal arg
'(4)))
6710 ;; special case: use global cycling
6716 (setq last-command
'dummy
)
6717 (org-set-startup-visibility)
6718 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6722 (org-unlogged-message "Entire buffer visible, including drawers"))
6724 ;; Try cdlatex TAB completion
6725 ((org-try-cdlatex-tab))
6727 ;; Table: enter it or move to the next field.
6728 ((org-at-table-p 'any
)
6729 (if (org-at-table.el-p
)
6730 (message "Use C-c ' to edit table.el tables")
6731 (if arg
(org-table-edit-field t
)
6732 (org-table-justify-field-maybe)
6733 (call-interactively 'org-table-next-field
))))
6735 ((run-hook-with-args-until-success
6736 'org-tab-after-check-for-table-hook
))
6738 ;; Global cycling: delegate to `org-cycle-internal-global'.
6739 ((eq arg t
) (org-cycle-internal-global))
6741 ;; Drawers: delegate to `org-flag-drawer'.
6743 (beginning-of-line 1)
6744 (looking-at org-drawer-regexp
))
6745 (org-flag-drawer ; toggle block visibility
6746 (not (get-char-property (match-end 0) 'invisible
))))
6748 ;; Show-subtree, ARG levels up from here.
6751 (org-back-to-heading)
6752 (outline-up-heading (if (< arg
0) (- arg
)
6753 (- (funcall outline-level
) arg
)))
6754 (org-show-subtree)))
6756 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6757 ((and (featurep 'org-inlinetask
)
6758 (org-inlinetask-at-task-p)
6759 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6760 (org-inlinetask-toggle-visibility))
6762 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6763 ((and (or (and org-cycle-include-plain-lists
(org-at-item-p))
6764 (save-excursion (beginning-of-line 1)
6765 (looking-at org-outline-regexp
)))
6766 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6767 (org-cycle-internal-local))
6769 ;; From there: TAB emulation and template completion.
6770 (buffer-read-only (org-back-to-heading))
6772 ((run-hook-with-args-until-success
6773 'org-tab-after-check-for-cycling-hook
))
6775 ((org-try-structure-completion))
6777 ((run-hook-with-args-until-success
6778 'org-tab-before-tab-emulation-hook
))
6780 ((and (eq org-cycle-emulate-tab
'exc-hl-bol
)
6782 (not (looking-at org-outline-regexp
))))
6783 (call-interactively (global-key-binding "\t")))
6785 ((if (and (memq org-cycle-emulate-tab
'(white whitestart
))
6786 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6787 (or (and (eq org-cycle-emulate-tab
'white
)
6788 (= (match-end 0) (point-at-eol)))
6789 (and (eq org-cycle-emulate-tab
'whitestart
)
6790 (>= (match-end 0) pos
))))
6792 (eq org-cycle-emulate-tab t
))
6793 (call-interactively (global-key-binding "\t")))
6796 (org-back-to-heading)
6799 (defun org-cycle-internal-global ()
6800 "Do the global cycling action."
6801 ;; Hack to avoid display of messages for .org attachments in Gnus
6802 (let ((ga (string-match "\\*fontification" (buffer-name))))
6804 ((and (eq last-command this-command
)
6805 (eq org-cycle-global-status
'overview
))
6806 ;; We just created the overview - now do table of contents
6807 ;; This can be slow in very large buffers, so indicate action
6808 (run-hook-with-args 'org-pre-cycle-hook
'contents
)
6809 (unless ga
(org-unlogged-message "CONTENTS..."))
6811 (unless ga
(org-unlogged-message "CONTENTS...done"))
6812 (setq org-cycle-global-status
'contents
)
6813 (run-hook-with-args 'org-cycle-hook
'contents
))
6815 ((and (eq last-command this-command
)
6816 (eq org-cycle-global-status
'contents
))
6817 ;; We just showed the table of contents - now show everything
6818 (run-hook-with-args 'org-pre-cycle-hook
'all
)
6820 (unless ga
(org-unlogged-message "SHOW ALL"))
6821 (setq org-cycle-global-status
'all
)
6822 (run-hook-with-args 'org-cycle-hook
'all
))
6825 ;; Default action: go to overview
6826 (run-hook-with-args 'org-pre-cycle-hook
'overview
)
6828 (unless ga
(org-unlogged-message "OVERVIEW"))
6829 (setq org-cycle-global-status
'overview
)
6830 (run-hook-with-args 'org-cycle-hook
'overview
)))))
6832 (defvar org-called-with-limited-levels nil
6833 "Non-nil when `org-with-limited-levels' is currently active.")
6835 (defun org-cycle-internal-local ()
6836 "Do the local cycling action."
6837 (let ((goal-column 0) eoh eol eos has-children children-skipped struct
)
6838 ;; First, determine end of headline (EOH), end of subtree or item
6839 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6844 (setq struct
(org-list-struct))
6845 (setq eoh
(point-at-eol))
6846 (setq eos
(org-list-get-item-end-before-blank (point) struct
))
6847 (setq has-children
(org-list-has-child-p (point) struct
)))
6848 (org-back-to-heading)
6849 (setq eoh
(save-excursion (outline-end-of-heading) (point)))
6850 (setq eos
(save-excursion (org-end-of-subtree t t
)
6851 (when (bolp) (backward-char)) (point)))
6854 (let ((level (funcall outline-level
)))
6855 (outline-next-heading)
6856 (and (org-at-heading-p t
)
6857 (> (funcall outline-level
) level
))))
6859 (org-list-search-forward (org-item-beginning-re) eos t
)))))
6860 ;; Determine end invisible part of buffer (EOL)
6861 (beginning-of-line 2)
6862 ;; XEmacs doesn't have `next-single-char-property-change'
6863 (if (featurep 'xemacs
)
6864 (while (and (not (eobp)) ;; this is like `next-line'
6865 (get-char-property (1- (point)) 'invisible
))
6866 (beginning-of-line 2))
6867 (while (and (not (eobp)) ;; this is like `next-line'
6868 (get-char-property (1- (point)) 'invisible
))
6869 (goto-char (next-single-char-property-change (point) 'invisible
))
6870 (and (eolp) (beginning-of-line 2))))
6872 ;; Find out what to do next and set `this-command'
6875 ;; Nothing is hidden behind this heading
6876 (unless (org-before-first-heading-p)
6877 (run-hook-with-args 'org-pre-cycle-hook
'empty
))
6878 (org-unlogged-message "EMPTY ENTRY")
6879 (setq org-cycle-subtree-status nil
)
6882 (outline-next-heading)
6883 (if (outline-invisible-p) (org-flag-heading nil
))))
6884 ((and (or (>= eol eos
)
6885 (not (string-match "\\S-" (buffer-substring eol eos
))))
6887 (not (setq children-skipped
6888 org-cycle-skip-children-state-if-no-children
))))
6889 ;; Entire subtree is hidden in one line: children view
6890 (unless (org-before-first-heading-p)
6891 (run-hook-with-args 'org-pre-cycle-hook
'children
))
6893 (org-list-set-item-visibility (point-at-bol) struct
'children
)
6895 (org-with-limited-levels (show-children))
6896 ;; FIXME: This slows down the func way too much.
6897 ;; How keep drawers hidden in subtree anyway?
6898 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6899 ;; (org-cycle-hide-drawers 'subtree))
6901 ;; Fold every list in subtree to top-level items.
6902 (when (eq org-cycle-include-plain-lists
'integrate
)
6904 (org-back-to-heading)
6905 (while (org-list-search-forward (org-item-beginning-re) eos t
)
6906 (beginning-of-line 1)
6907 (let* ((struct (org-list-struct))
6908 (prevs (org-list-prevs-alist struct
))
6909 (end (org-list-get-bottom-point struct
)))
6910 (mapc (lambda (e) (org-list-set-item-visibility e struct
'folded
))
6911 (org-list-get-all-items (point) struct prevs
))
6912 (goto-char (if (< end eos
) end eos
)))))))
6913 (org-unlogged-message "CHILDREN")
6916 (outline-next-heading)
6917 (if (outline-invisible-p) (org-flag-heading nil
)))
6918 (setq org-cycle-subtree-status
'children
)
6919 (unless (org-before-first-heading-p)
6920 (run-hook-with-args 'org-cycle-hook
'children
)))
6921 ((or children-skipped
6922 (and (eq last-command this-command
)
6923 (eq org-cycle-subtree-status
'children
)))
6924 ;; We just showed the children, or no children are there,
6925 ;; now show everything.
6926 (unless (org-before-first-heading-p)
6927 (run-hook-with-args 'org-pre-cycle-hook
'subtree
))
6928 (outline-flag-region eoh eos nil
)
6929 (org-unlogged-message
6930 (if children-skipped
"SUBTREE (NO CHILDREN)" "SUBTREE"))
6931 (setq org-cycle-subtree-status
'subtree
)
6932 (unless (org-before-first-heading-p)
6933 (run-hook-with-args 'org-cycle-hook
'subtree
)))
6935 ;; Default action: hide the subtree.
6936 (run-hook-with-args 'org-pre-cycle-hook
'folded
)
6937 (outline-flag-region eoh eos t
)
6938 (org-unlogged-message "FOLDED")
6939 (setq org-cycle-subtree-status
'folded
)
6940 (unless (org-before-first-heading-p)
6941 (run-hook-with-args 'org-cycle-hook
'folded
))))))
6944 (defun org-global-cycle (&optional arg
)
6945 "Cycle the global visibility. For details see `org-cycle'.
6946 With \\[universal-argument] prefix arg, switch to startup visibility.
6947 With a numeric prefix, show all headlines up to that level."
6949 (let ((org-cycle-include-plain-lists
6950 (if (derived-mode-p 'org-mode
) org-cycle-include-plain-lists nil
)))
6954 (hide-sublevels arg
)
6955 (setq org-cycle-global-status
'contents
))
6957 (org-set-startup-visibility)
6958 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6960 (org-cycle '(4))))))
6962 (defun org-set-startup-visibility ()
6963 "Set the visibility required by startup options and properties."
6965 ((eq org-startup-folded t
)
6967 ((eq org-startup-folded
'content
)
6969 ((or (eq org-startup-folded
'showeverything
)
6970 (eq org-startup-folded nil
))
6972 (unless (eq org-startup-folded
'showeverything
)
6973 (if org-hide-block-startup
(org-hide-block-all))
6974 (org-set-visibility-according-to-property 'no-cleanup
)
6975 (org-cycle-hide-archived-subtrees 'all
)
6976 (org-cycle-hide-drawers 'all
)
6977 (org-cycle-show-empty-lines t
)))
6979 (defun org-set-visibility-according-to-property (&optional no-cleanup
)
6980 "Switch subtree visibilities according to :VISIBILITY: property."
6982 (let (org-show-entry-below state
)
6984 (goto-char (point-min))
6985 (while (re-search-forward
6986 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6988 (setq state
(match-string 1))
6990 (org-back-to-heading t
)
6994 ((equal state
'("fold" "folded"))
6996 ((equal state
"children")
6997 (org-show-hidden-entry)
6999 ((equal state
"content")
7002 (org-narrow-to-subtree)
7004 ((member state
'("all" "showall"))
7007 (org-cycle-hide-archived-subtrees 'all
)
7008 (org-cycle-hide-drawers 'all
)
7009 (org-cycle-show-empty-lines 'all
)))))
7011 ;; This function uses outline-regexp instead of the more fundamental
7012 ;; org-outline-regexp so that org-cycle-global works outside of Org
7013 ;; buffers, where outline-regexp is needed.
7014 (defun org-overview ()
7015 "Switch to overview mode, showing only top-level headlines.
7016 This shows all headlines with a level equal or greater than the level
7017 of the first headline in the buffer. This is important, because if the
7018 first headline is not level one, then (hide-sublevels 1) gives confusing
7024 (goto-char (point-min))
7025 (if (re-search-forward (concat "^" outline-regexp
) nil t
)
7027 (goto-char (match-beginning 0))
7028 (funcall outline-level
))))))
7029 (and level
(hide-sublevels level
)))))
7031 (defun org-content (&optional arg
)
7032 "Show all headlines in the buffer, like a table of contents.
7033 With numerical argument N, show content up to level N."
7037 ;; Visit all headings and show their offspring
7038 (and (integerp arg
) (org-overview))
7039 (goto-char (point-max))
7041 (while (and (progn (condition-case nil
7042 (outline-previous-visible-heading 1)
7043 (error (goto-char (point-min))))
7045 (looking-at org-outline-regexp
))
7047 (show-children (1- arg
))
7049 (if (bobp) (throw 'exit nil
))))))
7051 (defun org-optimize-window-after-visibility-change (state)
7052 "Adjust the window after a change in outline visibility.
7053 This function is the default value of the hook `org-cycle-hook'."
7054 (when (get-buffer-window (current-buffer))
7056 ((eq state
'content
) nil
)
7057 ((eq state
'all
) nil
)
7058 ((eq state
'folded
) nil
)
7059 ((eq state
'children
) (or (org-subtree-end-visible-p) (recenter 1)))
7060 ((eq state
'subtree
) (or (org-subtree-end-visible-p) (recenter 1))))))
7062 (defun org-remove-empty-overlays-at (pos)
7063 "Remove outline overlays that do not contain non-white stuff."
7066 (and (eq 'outline
(overlay-get o
'invisible
))
7067 (not (string-match "\\S-" (buffer-substring (overlay-start o
)
7069 (delete-overlay o
)))
7072 (defun org-clean-visibility-after-subtree-move ()
7073 "Fix visibility issues after moving a subtree."
7074 ;; First, find a reasonable region to look at:
7075 ;; Start two siblings above, end three below
7076 (let* ((beg (save-excursion
7077 (and (org-get-last-sibling)
7078 (org-get-last-sibling))
7080 (end (save-excursion
7081 (and (org-get-next-sibling)
7082 (org-get-next-sibling)
7083 (org-get-next-sibling))
7084 (if (org-at-heading-p)
7087 (level (looking-at "\\*+"))
7088 (re (if level
(concat "^" (regexp-quote (match-string 0)) " "))))
7091 (narrow-to-region beg end
)
7093 ;; Properly fold already folded siblings
7094 (goto-char (point-min))
7095 (while (re-search-forward re nil t
)
7096 (if (and (not (outline-invisible-p))
7098 (goto-char (point-at-eol)) (outline-invisible-p)))
7100 (org-cycle-show-empty-lines 'overview
)
7101 (org-cycle-hide-drawers 'overview
)))))
7103 (defun org-cycle-show-empty-lines (state)
7104 "Show empty lines above all visible headlines.
7105 The region to be covered depends on STATE when called through
7106 `org-cycle-hook'. Lisp program can use t for STATE to get the
7107 entire buffer covered. Note that an empty line is only shown if there
7108 are at least `org-cycle-separator-lines' empty lines before the headline."
7109 (when (not (= org-cycle-separator-lines
0))
7111 (let* ((n (abs org-cycle-separator-lines
))
7113 ((= n
1) "\\(\n[ \t]*\n\\*+\\) ")
7114 ((= n
2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7115 (t (let ((ns (number-to-string (- n
2))))
7116 (concat "^\\(?:[ \t]*\n\\)\\{" ns
"," ns
"\\}"
7117 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7120 ((memq state
'(overview contents t
))
7121 (setq beg
(point-min) end
(point-max)))
7122 ((memq state
'(children folded
))
7123 (setq beg
(point) end
(progn (org-end-of-subtree t t
)
7124 (beginning-of-line 2)
7128 (while (re-search-forward re end t
)
7129 (unless (get-char-property (match-end 1) 'invisible
)
7130 (setq e
(match-end 1))
7131 (if (< org-cycle-separator-lines
0)
7132 (setq b
(save-excursion
7133 (goto-char (match-beginning 0))
7134 (org-back-over-empty-lines)
7136 (goto-char (max (point-min) (1- (point))))
7140 (setq b
(match-beginning 1)))
7141 (outline-flag-region b e nil
)))))))
7142 ;; Never hide empty lines at the end of the file.
7144 (goto-char (point-max))
7145 (outline-previous-heading)
7146 (outline-end-of-heading)
7147 (if (and (looking-at "[ \t\n]+")
7148 (= (match-end 0) (point-max)))
7149 (outline-flag-region (point) (match-end 0) nil
))))
7151 (defun org-show-empty-lines-in-parent ()
7152 "Move to the parent and re-show empty lines before visible headlines."
7154 (let ((context (if (org-up-heading-safe) 'children
'overview
)))
7155 (org-cycle-show-empty-lines context
))))
7157 (defun org-files-list ()
7158 "Return `org-agenda-files' list, plus all open org-mode files.
7159 This is useful for operations that need to scan all of a user's
7160 open and agenda-wise Org files."
7161 (let ((files (mapcar 'expand-file-name
(org-agenda-files))))
7162 (dolist (buf (buffer-list))
7163 (with-current-buffer buf
7164 (if (and (derived-mode-p 'org-mode
) (buffer-file-name))
7165 (let ((file (expand-file-name (buffer-file-name))))
7166 (unless (member file files
)
7167 (push file files
))))))
7170 (defsubst org-entry-beginning-position
()
7171 "Return the beginning position of the current entry."
7172 (save-excursion (outline-back-to-heading t
) (point)))
7174 (defsubst org-entry-end-position
()
7175 "Return the end position of the current entry."
7176 (save-excursion (outline-next-heading) (point)))
7178 (defun org-cycle-hide-drawers (state &optional exceptions
)
7179 "Re-hide all drawers after a visibility state change.
7180 When non-nil, optional argument EXCEPTIONS is a list of strings
7181 specifying which drawers should not be hidden."
7182 (when (and (derived-mode-p 'org-mode
)
7183 (not (memq state
'(overview folded contents
))))
7185 (let* ((globalp (memq state
'(contents all
)))
7186 (beg (if globalp
(point-min) (point)))
7187 (end (if globalp
(point-max)
7188 (if (eq state
'children
)
7189 (save-excursion (outline-next-heading) (point))
7190 (org-end-of-subtree t
)))))
7192 (while (re-search-forward org-drawer-regexp
(max end
(point)) t
)
7193 (unless (member-ignore-case (match-string 1) exceptions
)
7194 (let ((drawer (org-element-at-point)))
7195 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7196 (org-flag-drawer t drawer
)
7197 ;; Make sure to skip drawer entirely or we might flag
7198 ;; it another time when matching its ending line with
7199 ;; `org-drawer-regexp'.
7200 (goto-char (org-element-property :end drawer
))))))))))
7202 (defun org-cycle-hide-inline-tasks (state)
7203 "Re-hide inline tasks when switching to 'contents or 'children
7207 (when (org-bound-and-true-p org-inlinetask-min-level
)
7208 (hide-sublevels (1- org-inlinetask-min-level
))))
7210 (when (featurep 'org-inlinetask
)
7212 (while (and (outline-next-heading)
7213 (org-inlinetask-at-task-p))
7214 (org-inlinetask-toggle-visibility)
7215 (org-inlinetask-goto-end)))))))
7217 (defun org-flag-drawer (flag &optional element
)
7218 "When FLAG is non-nil, hide the drawer we are at.
7219 Otherwise make it visible. When optional argument ELEMENT is
7220 a parsed drawer, as returned by `org-element-at-point', hide or
7221 show that drawer instead."
7222 (when (save-excursion
7224 (org-looking-at-p org-drawer-regexp
))
7225 (let ((drawer (or element
(org-element-at-point))))
7226 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7227 (let ((post (org-element-property :post-affiliated drawer
)))
7229 (outline-flag-region
7230 (progn (goto-char post
) (line-end-position))
7231 (progn (goto-char (org-element-property :end drawer
))
7232 (skip-chars-backward " \r\t\n")
7233 (line-end-position))
7235 ;; When the drawer is hidden away, make sure point lies in
7236 ;; a visible part of the buffer.
7237 (when (and flag
(> (line-beginning-position) post
))
7238 (goto-char post
)))))))
7240 (defun org-subtree-end-visible-p ()
7241 "Is the end of the current subtree visible?"
7242 (pos-visible-in-window-p
7243 (save-excursion (org-end-of-subtree t
) (point))))
7245 (defun org-first-headline-recenter ()
7246 "Move cursor to the first headline and recenter the headline."
7247 (goto-char (point-min))
7248 (when (re-search-forward (concat "^\\(" org-outline-regexp
"\\)") nil t
)
7249 (set-window-start (selected-window) (point-at-bol))))
7251 ;;; Saving and restoring visibility
7253 (defun org-outline-overlay-data (&optional use-markers
)
7254 "Return a list of the locations of all outline overlays.
7255 These are overlays with the `invisible' property value `outline'.
7256 The return value is a list of cons cells, with start and stop
7257 positions for each overlay.
7258 If USE-MARKERS is set, return the positions as markers."
7265 (when (eq (overlay-get o
'invisible
) 'outline
)
7266 (setq beg
(overlay-start o
)
7267 end
(overlay-end o
))
7268 (and beg end
(> end beg
)
7270 (cons (copy-marker beg
)
7271 (copy-marker end t
))
7273 (overlays-in (point-min) (point-max))))))))
7275 (defun org-set-outline-overlay-data (data)
7276 "Create visibility overlays for all positions in DATA.
7277 DATA should have been made by `org-outline-overlay-data'."
7284 (outline-flag-region (car c
) (cdr c
) t
))
7287 ;;; Folding of blocks
7289 (defvar org-hide-block-overlays nil
7290 "Overlays hiding blocks.")
7291 (make-variable-buffer-local 'org-hide-block-overlays
)
7293 (defun org-block-map (function &optional start end
)
7294 "Call FUNCTION at the head of all source blocks in the current buffer.
7295 Optional arguments START and END can be used to limit the range."
7296 (let ((start (or start
(point-min)))
7297 (end (or end
(point-max))))
7300 (while (and (< (point) end
) (re-search-forward org-block-regexp end t
))
7303 (goto-char (match-beginning 0))
7304 (funcall function
)))))))
7306 (defun org-hide-block-toggle-all ()
7307 "Toggle the visibility of all blocks in the current buffer."
7308 (org-block-map 'org-hide-block-toggle
))
7310 (defun org-hide-block-all ()
7311 "Fold all blocks in the current buffer."
7313 (org-show-block-all)
7314 (org-block-map 'org-hide-block-toggle-maybe
))
7316 (defun org-show-block-all ()
7317 "Unfold all blocks in the current buffer."
7319 (mapc 'delete-overlay org-hide-block-overlays
)
7320 (setq org-hide-block-overlays nil
))
7322 (defun org-hide-block-toggle-maybe ()
7323 "Toggle visibility of block at point.
7324 Unlike to `org-hide-block-toggle', this function does not throw
7325 an error. Return a non-nil value when toggling is successful."
7327 (ignore-errors (org-hide-block-toggle)))
7329 (defun org-hide-block-toggle (&optional force
)
7330 "Toggle the visibility of the current block.
7331 When optional argument FORCE is `off', make block visible. If it
7332 is non-nil, hide it unconditionally. Throw an error when not at
7333 a block. Return a non-nil value when toggling is successful."
7335 (let ((element (org-element-at-point)))
7336 (unless (memq (org-element-type element
)
7337 '(center-block comment-block dynamic-block example-block
7338 export-block quote-block special-block
7339 src-block verse-block
))
7340 (user-error "Not at a block"))
7341 (let* ((start (save-excursion
7342 (goto-char (org-element-property :post-affiliated element
))
7343 (line-end-position)))
7344 (end (save-excursion
7345 (goto-char (org-element-property :end element
))
7346 (skip-chars-backward " \r\t\n")
7347 (line-end-position)))
7348 (overlays (overlays-at start
)))
7350 ;; Do nothing when not before or at the block opening line or
7351 ;; at the block closing line.
7352 ((let ((eol (line-end-position))) (and (> eol start
) (/= eol end
))) nil
)
7353 ((and (not (eq force
'off
))
7354 (not (memq t
(mapcar
7356 (eq (overlay-get o
'invisible
) 'org-hide-block
))
7358 (let ((ov (make-overlay start end
)))
7359 (overlay-put ov
'invisible
'org-hide-block
)
7360 ;; Make the block accessible to `isearch'.
7362 ov
'isearch-open-invisible
7364 (when (memq ov org-hide-block-overlays
)
7365 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7366 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7367 (delete-overlay ov
))))
7368 (push ov org-hide-block-overlays
)
7369 ;; When the block is hidden away, make sure point is left in
7370 ;; a visible part of the buffer.
7371 (when (> (line-beginning-position) start
)
7373 (beginning-of-line))
7374 ;; Signal successful toggling.
7376 ((or (not force
) (eq force
'off
))
7377 (dolist (ov overlays t
)
7378 (when (memq ov org-hide-block-overlays
)
7379 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7380 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7381 (delete-overlay ov
))))))))
7383 ;; org-tab-after-check-for-cycling-hook
7384 (add-hook 'org-tab-first-hook
'org-hide-block-toggle-maybe
)
7385 ;; Remove overlays when changing major mode
7386 (add-hook 'org-mode-hook
7387 (lambda () (org-add-hook 'change-major-mode-hook
7388 'org-show-block-all
'append
'local
)))
7392 (defvar org-goto-window-configuration nil
)
7393 (defvar org-goto-marker nil
)
7394 (defvar org-goto-map
)
7395 (defun org-goto-map ()
7396 "Set the keymap `org-goto'."
7398 (let ((map (make-sparse-keymap)))
7399 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7400 mouse-drag-region universal-argument org-occur
))
7402 (while (setq cmd
(pop cmds
))
7403 (substitute-key-definition cmd cmd map global-map
)))
7404 (suppress-keymap map
)
7405 (org-defkey map
"\C-m" 'org-goto-ret
)
7406 (org-defkey map
[(return)] 'org-goto-ret
)
7407 (org-defkey map
[(left)] 'org-goto-left
)
7408 (org-defkey map
[(right)] 'org-goto-right
)
7409 (org-defkey map
[(control ?g
)] 'org-goto-quit
)
7410 (org-defkey map
"\C-i" 'org-cycle
)
7411 (org-defkey map
[(tab)] 'org-cycle
)
7412 (org-defkey map
[(down)] 'outline-next-visible-heading
)
7413 (org-defkey map
[(up)] 'outline-previous-visible-heading
)
7414 (if org-goto-auto-isearch
7415 (if (fboundp 'define-key-after
)
7416 (define-key-after map
[t] 'org-goto-local-auto-isearch)
7418 (org-defkey map "q" 'org-goto-quit)
7419 (org-defkey map "n" 'outline-next-visible-heading)
7420 (org-defkey map "p" 'outline-previous-visible-heading)
7421 (org-defkey map "f" 'outline-forward-same-level)
7422 (org-defkey map "b" 'outline-backward-same-level)
7423 (org-defkey map "u" 'outline-up-heading))
7424 (org-defkey map "/" 'org-occur)
7425 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7426 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7427 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7428 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7429 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7432 (defconst org-goto-help
7433 "Browse buffer copy, to find location or copy text.%s
7434 RET=jump to location C-g=quit and return to previous location
7435 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7437 (defvar org-goto-start-pos) ; dynamically scoped parameter
7439 (defun org-goto (&optional alternative-interface)
7440 "Look up a different location in the current file, keeping current visibility.
7442 When you want look-up or go to a different location in a
7443 document, the fastest way is often to fold the entire buffer and
7444 then dive into the tree. This method has the disadvantage, that
7445 the previous location will be folded, which may not be what you
7448 This command works around this by showing a copy of the current
7449 buffer in an indirect buffer, in overview mode. You can dive
7450 into the tree in that copy, use org-occur and incremental search
7451 to find a location. When pressing RET or `Q', the command
7452 returns to the original buffer in which the visibility is still
7453 unchanged. After RET it will also jump to the location selected
7454 in the indirect buffer and expose the headline hierarchy above.
7456 With a prefix argument, use the alternative interface: e.g. if
7457 `org-goto-interface' is 'outline use 'outline-path-completion."
7460 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7461 (org-refile-use-outline-path t)
7462 (org-refile-target-verify-function nil)
7464 (if (not alternative-interface)
7466 (if (eq org-goto-interface 'outline)
7467 'outline-path-completion
7469 (org-goto-start-pos (point))
7471 (if (eq interface 'outline)
7472 (car (org-get-location (current-buffer) org-goto-help))
7473 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7474 (org-refile-check-position pa)
7478 (org-mark-ring-push org-goto-start-pos)
7479 (goto-char selected-point)
7480 (if (or (outline-invisible-p) (org-invisible-p2))
7481 (org-show-context 'org-goto)))
7484 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7485 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7486 (defvar org-goto-local-auto-isearch-map) ; defined below
7488 (defun org-get-location (buf help)
7489 "Let the user select a location in the Org-mode buffer BUF.
7490 This function uses a recursive edit. It returns the selected position
7493 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7494 (isearch-hide-immediately nil)
7495 (isearch-search-fun-function
7496 (lambda () 'org-goto-local-search-headings))
7497 (org-goto-selected-point org-goto-exit-command))
7499 (save-window-excursion
7500 (delete-other-windows)
7501 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7502 (org-pop-to-buffer-same-window
7504 (make-indirect-buffer (current-buffer) "*org-goto*")
7505 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7506 (with-output-to-temp-buffer "*Org Help*"
7507 (princ (format help (if org-goto-auto-isearch
7508 " Just type for auto-isearch."
7509 " n/p/f/b/u to navigate, q to quit."))))
7510 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7511 (setq buffer-read-only nil)
7512 (let ((org-startup-truncated t)
7513 (org-startup-folded nil)
7514 (org-startup-align-all-tables nil))
7517 (setq buffer-read-only t)
7518 (if (and (boundp 'org-goto-start-pos)
7519 (integer-or-marker-p org-goto-start-pos))
7520 (let ((org-show-hierarchy-above t)
7521 (org-show-siblings t)
7522 (org-show-following-heading t))
7523 (goto-char org-goto-start-pos)
7524 (and (outline-invisible-p) (org-show-context)))
7525 (goto-char (point-min)))
7526 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7527 (message "Select location and press RET")
7528 (use-local-map org-goto-map)
7530 (kill-buffer "*org-goto*")
7531 (cons org-goto-selected-point org-goto-exit-command))))
7533 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7534 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7535 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7536 (if (fboundp 'isearch-other-control-char)
7538 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7539 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7540 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7541 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7542 (define-key org-goto-local-auto-isearch-map [return] nil))
7544 (defun org-goto-local-search-headings (string bound noerror)
7545 "Search and make sure that any matches are in headlines."
7547 (while (if isearch-forward
7548 (search-forward string bound noerror)
7549 (search-backward string bound noerror))
7550 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7551 (and (member :headline context)
7552 (not (member :tags context))))
7553 (throw 'return (point))))))
7555 (defun org-goto-local-auto-isearch ()
7558 (goto-char (point-min))
7559 (let ((keys (this-command-keys)))
7560 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7562 (isearch-process-search-char (string-to-char keys)))))
7564 (defun org-goto-ret (&optional arg)
7565 "Finish `org-goto' by going to the new location."
7567 (setq org-goto-selected-point (point)
7568 org-goto-exit-command 'return)
7571 (defun org-goto-left ()
7572 "Finish `org-goto' by going to the new location."
7574 (if (org-at-heading-p)
7576 (beginning-of-line 1)
7577 (setq org-goto-selected-point (point)
7578 org-goto-exit-command 'left)
7580 (user-error "Not on a heading")))
7582 (defun org-goto-right ()
7583 "Finish `org-goto' by going to the new location."
7585 (if (org-at-heading-p)
7587 (setq org-goto-selected-point (point)
7588 org-goto-exit-command 'right)
7590 (user-error "Not on a heading")))
7592 (defun org-goto-quit ()
7593 "Finish `org-goto' without cursor motion."
7595 (setq org-goto-selected-point nil)
7596 (setq org-goto-exit-command 'quit)
7599 ;;; Indirect buffer display of subtrees
7601 (defvar org-indirect-dedicated-frame nil
7602 "This is the frame being used for indirect tree display.")
7603 (defvar org-last-indirect-buffer nil)
7605 (defun org-tree-to-indirect-buffer (&optional arg)
7606 "Create indirect buffer and narrow it to current subtree.
7607 With a numerical prefix ARG, go up to this level and then take that tree.
7608 If ARG is negative, go up that many levels.
7610 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7611 indirect buffer previously made with this command, to avoid proliferation of
7612 indirect buffers. However, when you call the command with a \
7613 \\[universal-argument] prefix, or
7614 when `org-indirect-buffer-display' is `new-frame', the last buffer
7615 is kept so that you can work with several indirect buffers at the same time.
7616 If `org-indirect-buffer-display' is `dedicated-frame', the \
7617 \\[universal-argument] prefix also
7618 requests that a new frame be made for the new buffer, so that the dedicated
7619 frame is not changed."
7621 (let ((cbuf (current-buffer))
7622 (cwin (selected-window))
7624 beg end level heading ibuf)
7626 (org-back-to-heading t)
7628 (setq level (org-outline-level))
7629 (if (< arg 0) (setq arg (+ level arg)))
7630 (while (> (setq level (org-outline-level)) arg)
7631 (org-up-heading-safe)))
7633 heading (org-get-heading))
7634 (org-end-of-subtree t t)
7635 (if (org-at-heading-p) (backward-char 1))
7637 (if (and (buffer-live-p org-last-indirect-buffer)
7638 (not (eq org-indirect-buffer-display 'new-frame))
7640 (kill-buffer org-last-indirect-buffer))
7641 (setq ibuf (org-get-indirect-buffer cbuf heading)
7642 org-last-indirect-buffer ibuf)
7644 ((or (eq org-indirect-buffer-display 'new-frame)
7645 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7646 (select-frame (make-frame))
7647 (delete-other-windows)
7648 (org-pop-to-buffer-same-window ibuf)
7649 (org-set-frame-title heading))
7650 ((eq org-indirect-buffer-display 'dedicated-frame)
7652 (select-frame (or (and org-indirect-dedicated-frame
7653 (frame-live-p org-indirect-dedicated-frame)
7654 org-indirect-dedicated-frame)
7655 (setq org-indirect-dedicated-frame (make-frame)))))
7656 (delete-other-windows)
7657 (org-pop-to-buffer-same-window ibuf)
7658 (org-set-frame-title (concat "Indirect: " heading)))
7659 ((eq org-indirect-buffer-display 'current-window)
7660 (org-pop-to-buffer-same-window ibuf))
7661 ((eq org-indirect-buffer-display 'other-window)
7662 (pop-to-buffer ibuf))
7663 (t (error "Invalid value")))
7664 (if (featurep 'xemacs)
7665 (save-excursion (org-mode) (turn-on-font-lock)))
7666 (narrow-to-region beg end)
7669 (run-hook-with-args 'org-cycle-hook 'all)
7670 (and (window-live-p cwin) (select-window cwin))))
7672 (defun org-get-indirect-buffer (&optional buffer heading)
7673 (setq buffer (or buffer (current-buffer)))
7674 (let ((n 1) (base (buffer-name buffer)) bname)
7675 (while (buffer-live-p
7679 (if heading (concat heading "-" (number-to-string n))
7680 (number-to-string n))))))
7683 (make-indirect-buffer buffer bname 'clone)
7684 (error (make-indirect-buffer buffer bname)))))
7686 (defun org-set-frame-title (title)
7687 "Set the title of the current frame to the string TITLE."
7688 ;; FIXME: how to name a single frame in XEmacs???
7689 (unless (featurep 'xemacs)
7690 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7692 ;;;; Structure editing
7694 ;;; Inserting headlines
7696 (defun org-previous-line-empty-p (&optional next)
7697 "Is the previous line a blank line?
7698 When NEXT is non-nil, check the next line instead."
7701 (or (beginning-of-line (if next 2 0)) t)
7703 (looking-at "[ \t]*$")))))
7705 (defun org-insert-heading (&optional arg invisible-ok)
7706 "Insert a new heading or an item with the same depth at point.
7708 If point is at the beginning of a heading or a list item, insert
7709 a new heading or a new item above the current one. If point is
7710 at the beginning of a normal line, turn the line into a heading.
7712 If point is in the middle of a headline or a list item, split the
7713 headline or the item and create a new headline/item with the text
7714 in the current line after point \(see `org-M-RET-may-split-line'
7715 on how to modify this behavior).
7717 With one universal prefix argument, set the user option
7718 `org-insert-heading-respect-content' to t for the duration of
7719 the command. This modifies the behavior described above in this
7720 ways: on list items and at the beginning of normal lines, force
7721 the insertion of a heading after the current subtree.
7723 With two universal prefix arguments, insert the heading at the
7724 end of the grandparent subtree. For example, if point is within
7725 a 2nd-level heading, then it will insert a 2nd-level heading at
7726 the end of the 1st-level parent heading.
7728 If point is at the beginning of a headline, insert a sibling
7729 before the current headline. If point is not at the beginning,
7730 split the line and create a new headline with the text in the
7731 current line after point \(see `org-M-RET-may-split-line' on how
7732 to modify this behavior).
7734 If point is at the beginning of a normal line, turn this line
7737 When INVISIBLE-OK is set, stop at invisible headlines when going
7738 back. This is important for non-interactive uses of the
7741 (if (org-called-interactively-p 'any) (org-reveal))
7742 (let ((itemp (org-in-item-p))
7743 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7744 (respect-content (or org-insert-heading-respect-content
7746 (initial-content "")
7747 (adjust-empty-lines t))
7751 ((or (= (buffer-size) 0)
7752 (and (not (save-excursion
7753 (and (ignore-errors (org-back-to-heading invisible-ok))
7754 (org-at-heading-p))))
7755 (or arg (not itemp))))
7756 ;; At beginning of buffer or so high up that only a heading
7758 (cond ((and (bolp) (not respect-content)) (insert "* "))
7759 ((not respect-content)
7760 (unless may-split (end-of-line))
7762 ((re-search-forward org-outline-regexp-bol nil t)
7766 (t (goto-char (point-max))
7768 (run-hooks 'org-insert-heading-hook))
7770 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7773 ;; Maybe move at the end of the subtree
7774 (when (equal arg '(16))
7775 (org-up-heading-safe)
7776 (org-end-of-subtree t))
7781 (on-heading (org-at-heading-p))
7782 (empty-line-p (if on-heading
7783 (org-previous-line-empty-p)
7784 ;; We will decide later
7786 ;; Get a level string to fall back on
7788 (if (org-before-first-heading-p) "*"
7790 (org-back-to-heading t)
7791 (if (org-previous-line-empty-p) (setq empty-line-p t))
7792 (looking-at org-outline-regexp)
7793 (make-string (1- (length (match-string 0))) ?*))))
7798 (org-back-to-heading invisible-ok)
7799 (when (and (not on-heading)
7800 (featurep 'org-inlinetask)
7801 (integerp org-inlinetask-min-level)
7802 (>= (length (match-string 0))
7803 org-inlinetask-min-level))
7804 ;; Find a heading level before the inline task
7805 (while (and (setq level (org-up-heading-safe))
7806 (>= level org-inlinetask-min-level)))
7807 (if (org-at-heading-p)
7808 (org-back-to-heading invisible-ok)
7809 (error "This should not happen")))
7810 (unless (and (save-excursion
7812 (org-backward-heading-same-level
7814 (= (point) (match-beginning 0)))
7815 (not (org-previous-line-empty-p t)))
7816 (setq empty-line-p (or empty-line-p
7817 (org-previous-line-empty-p))))
7819 (error (or fix-level "* ")))))
7820 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7821 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7822 pos hide-previous previous-pos)
7824 ;; If we insert after content, move there and clean up whitespace
7825 (when (and respect-content
7826 (not (org-looking-at-p org-outline-regexp-bol)))
7827 (if (not (org-before-first-heading-p))
7828 (org-end-of-subtree nil t)
7829 (re-search-forward org-outline-regexp-bol)
7830 (beginning-of-line 0))
7831 (skip-chars-backward " \r\n")
7832 (and (not (looking-back "^\\*+"))
7833 (looking-at "[ \t]+") (replace-match ""))
7834 (unless (eobp) (forward-char 1))
7835 (when (looking-at "^\\*")
7836 (unless (bobp) (backward-char 1))
7839 ;; If we are splitting, grab the text that should be moved to the new headline
7841 (if (org-on-heading-p)
7842 ;; This is a heading, we split intelligently (keeping tags)
7843 (let ((pos (point)))
7844 (goto-char (point-at-bol))
7845 (unless (looking-at org-complex-heading-regexp)
7846 (error "This should not happen"))
7847 (when (and (match-beginning 4)
7848 (> pos (match-beginning 4))
7849 (< pos (match-end 4)))
7850 (setq initial-content (buffer-substring pos (match-end 4)))
7852 (delete-region (point) (match-end 4))
7853 (if (looking-at "[ \t]*$")
7855 (insert (make-string (length initial-content) ?\ )))
7856 (setq initial-content (org-trim initial-content)))
7859 (setq initial-content
7860 (org-trim (buffer-substring (point) (point-at-eol))))
7861 (delete-region (point) (point-at-eol))))
7863 ;; If we are at the beginning of the line, insert before it. Else after
7865 ((and (bolp) (looking-at "[ \t]*$")))
7866 ((and (bolp) (not (looking-at "[ \t]*$")))
7869 (goto-char (point-at-eol))
7872 ;; Insert the new heading
7875 (insert initial-content)
7876 (when adjust-empty-lines
7878 (and blank (not (org-previous-line-empty-p))))
7879 (org-N-empty-lines-before-current (if blank 1 0))))
7880 (run-hooks 'org-insert-heading-hook)))))))
7882 (defun org-N-empty-lines-before-current (N)
7883 "Make the number of empty lines before current exactly N.
7884 So this will delete or add empty lines."
7888 (skip-chars-backward " \r\t\n")
7889 (unless (bolp) (forward-line))
7890 (delete-region (point) p))
7891 (when (> N 0) (insert (make-string N ?\n)))))
7893 (defun org-get-heading (&optional no-tags no-todo)
7894 "Return the heading of the current entry, without the stars.
7895 When NO-TAGS is non-nil, don't include tags.
7896 When NO-TODO is non-nil, don't include TODO keywords."
7898 (org-back-to-heading t)
7900 ((and no-tags no-todo)
7901 (looking-at org-complex-heading-regexp)
7904 (looking-at (concat org-outline-regexp
7906 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7909 (looking-at org-todo-line-regexp)
7911 (t (looking-at org-heading-regexp)
7912 (match-string 2)))))
7914 (defvar orgstruct-mode) ; defined below
7916 (defun org-heading-components ()
7917 "Return the components of the current heading.
7918 This is a list with the following elements:
7919 - the level as an integer
7920 - the reduced level, different if `org-odd-levels-only' is set.
7921 - the TODO keyword, or nil
7922 - the priority character, like ?A, or nil if no priority is given
7923 - the headline text itself, or the tags string if no headline text
7924 - the tags string, or nil."
7926 (org-back-to-heading t)
7927 (if (let (case-fold-search)
7931 org-complex-heading-regexp)))
7933 (list (length (match-string 1))
7934 (org-reduced-level (length (match-string 1)))
7939 (list (length (match-string 1))
7940 (org-reduced-level (length (match-string 1)))
7941 (org-match-string-no-properties 2)
7942 (and (match-end 3) (aref (match-string 3) 2))
7943 (org-match-string-no-properties 4)
7944 (org-match-string-no-properties 5))))))
7946 (defun org-get-entry ()
7947 "Get the entry text, after heading, entire subtree."
7949 (org-back-to-heading t)
7950 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7952 (defun org-insert-heading-after-current ()
7953 "Insert a new heading with same level as current, after current subtree."
7955 (org-back-to-heading)
7956 (org-insert-heading)
7957 (org-move-subtree-down)
7960 (defun org-insert-heading-respect-content (&optional invisible-ok)
7961 "Insert heading with `org-insert-heading-respect-content' set to t."
7963 (org-insert-heading '(4) invisible-ok))
7965 (defun org-insert-todo-heading-respect-content (&optional force-state)
7966 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7968 (org-insert-todo-heading force-state '(4)))
7970 (defun org-insert-todo-heading (arg &optional force-heading)
7971 "Insert a new heading with the same level and TODO state as current heading.
7972 If the heading has no TODO state, or if the state is DONE, use the first
7973 state (TODO by default). Also with one prefix arg, force first state. With
7974 two prefix args, force inserting at the end of the parent subtree."
7976 (when (or force-heading (not (org-insert-item 'checkbox)))
7977 (org-insert-heading (or (and (equal arg '(16)) '(16))
7980 (org-back-to-heading)
7981 (outline-previous-heading)
7982 (looking-at org-todo-line-regexp))
7985 (if (or (equal arg '(4))
7986 (not (match-beginning 2))
7987 (member (match-string 2) org-done-keywords))
7988 (car org-todo-keywords-1)
7992 (run-hook-with-args-until-success
7993 'org-todo-get-default-hook new-mark-x nil)
7995 (beginning-of-line 1)
7996 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7997 (if org-treat-insert-todo-heading-as-state-change
7999 (insert new-mark " "))))
8000 (when org-provide-todo-statistics
8001 (org-update-parent-todo-statistics))))
8003 (defun org-insert-subheading (arg)
8004 "Insert a new subheading and demote it.
8005 Works for outline headings and for plain lists alike."
8007 (org-insert-heading arg)
8009 ((org-at-heading-p) (org-do-demote))
8010 ((org-at-item-p) (org-indent-item))))
8012 (defun org-insert-todo-subheading (arg)
8013 "Insert a new subheading with TODO keyword or checkbox and demote it.
8014 Works for outline headings and for plain lists alike."
8016 (org-insert-todo-heading arg)
8018 ((org-at-heading-p) (org-do-demote))
8019 ((org-at-item-p) (org-indent-item))))
8021 ;;; Promotion and Demotion
8023 (defvar org-after-demote-entry-hook nil
8024 "Hook run after an entry has been demoted.
8025 The cursor will be at the beginning of the entry.
8026 When a subtree is being demoted, the hook will be called for each node.")
8028 (defvar org-after-promote-entry-hook nil
8029 "Hook run after an entry has been promoted.
8030 The cursor will be at the beginning of the entry.
8031 When a subtree is being promoted, the hook will be called for each node.")
8033 (defun org-promote-subtree ()
8034 "Promote the entire subtree.
8035 See also `org-promote'."
8038 (org-with-limited-levels (org-map-tree 'org-promote)))
8039 (org-fix-position-after-promote))
8041 (defun org-demote-subtree ()
8042 "Demote the entire subtree. See `org-demote'.
8043 See also `org-promote'."
8046 (org-with-limited-levels (org-map-tree 'org-demote)))
8047 (org-fix-position-after-promote))
8050 (defun org-do-promote ()
8051 "Promote the current heading higher up the tree.
8052 If the region is active in `transient-mark-mode', promote all headings
8056 (if (org-region-active-p)
8057 (org-map-region 'org-promote (region-beginning) (region-end))
8059 (org-fix-position-after-promote))
8061 (defun org-do-demote ()
8062 "Demote the current heading lower down the tree.
8063 If the region is active in `transient-mark-mode', demote all headings
8067 (if (org-region-active-p)
8068 (org-map-region 'org-demote (region-beginning) (region-end))
8070 (org-fix-position-after-promote))
8072 (defun org-fix-position-after-promote ()
8073 "Make sure that after pro/demotion cursor position is right."
8074 (let ((pos (point)))
8075 (when (save-excursion
8076 (beginning-of-line 1)
8077 (looking-at org-todo-line-regexp)
8078 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8079 (cond ((eobp) (insert " "))
8080 ((eolp) (insert " "))
8081 ((equal (char-after) ?\ ) (forward-char 1))))))
8083 (defun org-current-level ()
8084 "Return the level of the current entry, or nil if before the first headline.
8085 The level is the number of stars at the beginning of the headline."
8087 (org-with-limited-levels
8088 (if (ignore-errors (org-back-to-heading t))
8089 (funcall outline-level)))))
8091 (defun org-get-previous-line-level ()
8092 "Return the outline depth of the last headline before the current line.
8093 Returns 0 for the first headline in the buffer, and nil if before the
8095 (and (org-current-level)
8096 (or (and (/= (line-beginning-position) (point-min))
8097 (save-excursion (beginning-of-line 0) (org-current-level)))
8100 (defun org-reduced-level (l)
8101 "Compute the effective level of a heading.
8102 This takes into account the setting of `org-odd-levels-only'."
8105 (org-odd-levels-only (1+ (floor (/ l 2))))
8108 (defun org-level-increment ()
8109 "Return the number of stars that will be added or removed at a
8110 time to headlines when structure editing, based on the value of
8111 `org-odd-levels-only'."
8112 (if org-odd-levels-only 2 1))
8114 (defun org-get-valid-level (level &optional change)
8115 "Rectify a level change under the influence of `org-odd-levels-only'
8116 LEVEL is a current level, CHANGE is by how much the level should be
8117 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8118 even level numbers will become the next higher odd number."
8119 (if org-odd-levels-only
8120 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8121 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8122 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8123 (max 1 (+ level (or change 0)))))
8125 (if (boundp 'define-obsolete-function-alias)
8126 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8127 (define-obsolete-function-alias 'org-get-legal-level
8128 'org-get-valid-level)
8129 (define-obsolete-function-alias 'org-get-legal-level
8130 'org-get-valid-level "23.1")))
8132 (defun org-promote ()
8133 "Promote the current heading higher up the tree."
8134 (org-with-wide-buffer
8135 (org-back-to-heading t)
8136 (let* ((after-change-functions (remq 'flyspell-after-change-function
8137 after-change-functions))
8138 (level (save-match-data (funcall outline-level)))
8139 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8140 (diff (abs (- level (length up-head) -1))))
8142 ((and (= level 1) org-allow-promoting-top-level-subtree)
8143 (replace-match "# " nil t))
8145 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8146 (t (replace-match up-head nil t)))
8148 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8149 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8150 (run-hooks 'org-after-promote-entry-hook))))
8152 (defun org-demote ()
8153 "Demote the current heading lower down the tree."
8154 (org-with-wide-buffer
8155 (org-back-to-heading t)
8156 (let* ((after-change-functions (remq 'flyspell-after-change-function
8157 after-change-functions))
8158 (level (save-match-data (funcall outline-level)))
8159 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8160 (diff (abs (- level (length down-head) -1))))
8161 (replace-match down-head nil t)
8162 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8163 (when org-adapt-indentation (org-fixup-indentation diff))
8164 (run-hooks 'org-after-demote-entry-hook))))
8166 (defun org-cycle-level ()
8167 "Cycle the level of an empty headline through possible states.
8168 This goes first to child, then to parent, level, then up the hierarchy.
8169 After top level, it switches back to sibling level."
8171 (let ((org-adapt-indentation nil))
8172 (when (org-point-at-end-of-empty-headline)
8173 (setq this-command 'org-cycle-level) ; Only needed for caching
8174 (let ((cur-level (org-current-level))
8175 (prev-level (org-get-previous-line-level)))
8177 ;; If first headline in file, promote to top-level.
8179 (loop repeat (/ (- cur-level 1) (org-level-increment))
8180 do (org-do-promote)))
8181 ;; If same level as prev, demote one.
8182 ((= prev-level cur-level)
8184 ;; If parent is top-level, promote to top level if not already.
8186 (loop repeat (/ (- cur-level 1) (org-level-increment))
8187 do (org-do-promote)))
8188 ;; If top-level, return to prev-level.
8190 (loop repeat (/ (- prev-level 1) (org-level-increment))
8191 do (org-do-demote)))
8192 ;; If less than prev-level, promote one.
8193 ((< cur-level prev-level)
8195 ;; If deeper than prev-level, promote until higher than
8197 ((> cur-level prev-level)
8198 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8199 do (org-do-promote))))
8202 (defun org-map-tree (fun)
8203 "Call FUN for every heading underneath the current one."
8204 (org-back-to-heading)
8205 (let ((level (funcall outline-level)))
8209 (outline-next-heading)
8210 (> (funcall outline-level) level))
8214 (defun org-map-region (fun beg end)
8215 "Call FUN for every heading between BEG and END."
8216 (let ((org-ignore-region t))
8218 (setq end (copy-marker end))
8220 (if (and (re-search-forward org-outline-regexp-bol nil t)
8224 (outline-next-heading)
8229 (defun org-fixup-indentation (diff)
8230 "Change the indentation in the current entry by DIFF.
8232 DIFF is an integer. Indentation is done according to the
8235 - Planning information and property drawers are always indented
8236 according to the new level of the headline;
8238 - Footnote definitions and their contents are ignored;
8240 - Inlinetasks' boundaries are not shifted;
8242 - Empty lines are ignored;
8244 - Other lines' indentation are shifted by DIFF columns, unless
8245 it would introduce a structural change in the document, in
8246 which case no shifting is done at all.
8248 Assume point is at a heading or an inlinetask beginning."
8249 (org-with-wide-buffer
8250 (narrow-to-region (line-beginning-position)
8252 (if (org-with-limited-levels (org-at-heading-p))
8253 (org-with-limited-levels (outline-next-heading))
8254 (org-inlinetask-goto-end))
8257 ;; Indent properly planning info and property drawer.
8258 (when (org-looking-at-p org-planning-line-re)
8261 (when (looking-at org-property-drawer-re)
8262 (goto-char (match-end 0))
8264 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8266 (when (zerop diff) (throw 'no-shift nil))
8267 ;; If DIFF is negative, first check if a shift is possible at all
8268 ;; (e.g., it doesn't break structure). This can only happen if
8269 ;; some contents are not properly indented.
8270 (let ((case-fold-search t))
8272 (let ((diff (- diff))
8273 (forbidden-re (concat org-outline-regexp
8275 (substring org-footnote-definition-re 1))))
8279 ((org-looking-at-p "[ \t]*$") (forward-line))
8280 ((and (org-looking-at-p org-footnote-definition-re)
8281 (let ((e (org-element-at-point)))
8282 (and (eq (org-element-type e) 'footnote-definition)
8283 (goto-char (org-element-property :end e))))))
8284 ((org-looking-at-p org-outline-regexp) (forward-line))
8285 ;; Give up if shifting would move before column 0 or
8286 ;; if it would introduce a headline or a footnote
8289 (skip-chars-forward " \t")
8290 (let ((ind (current-column)))
8291 (when (or (< ind diff)
8292 (and (= ind diff) (org-looking-at-p forbidden-re)))
8293 (throw 'no-shift nil)))
8294 ;; Ignore contents of example blocks and source
8295 ;; blocks if their indentation is meant to be
8296 ;; preserved. Jump to block's closing line.
8298 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8299 (let ((e (org-element-at-point)))
8300 (and (memq (org-element-type e)
8301 '(example-block src-block))
8302 (or org-src-preserve-indentation
8303 (org-element-property :preserve-indent e))
8304 (goto-char (org-element-property :end e))
8305 (progn (skip-chars-backward " \r\t\n")
8308 (forward-line))))))))
8309 ;; Shift lines but footnote definitions, inlinetasks boundaries
8310 ;; by DIFF. Also skip contents of source or example blocks
8311 ;; when indentation is meant to be preserved.
8314 ((and (org-looking-at-p org-footnote-definition-re)
8315 (let ((e (org-element-at-point)))
8316 (and (eq (org-element-type e) 'footnote-definition)
8317 (goto-char (org-element-property :end e))))))
8318 ((org-looking-at-p org-outline-regexp) (forward-line))
8319 ((org-looking-at-p "[ \t]*$") (forward-line))
8321 (org-indent-line-to (+ (org-get-indentation) diff))
8323 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8324 (let ((e (org-element-at-point)))
8325 (and (memq (org-element-type e)
8326 '(example-block src-block))
8327 (or org-src-preserve-indentation
8328 (org-element-property :preserve-indent e))
8329 (goto-char (org-element-property :end e))
8330 (progn (skip-chars-backward " \r\t\n")
8333 (forward-line)))))))))
8335 (defun org-convert-to-odd-levels ()
8336 "Convert an org-mode file with all levels allowed to one with odd levels.
8337 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8340 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8341 (let ((outline-level 'org-outline-level)
8342 (org-odd-levels-only nil) n)
8344 (goto-char (point-min))
8345 (while (re-search-forward "^\\*\\*+ " nil t)
8346 (setq n (- (length (match-string 0)) 2))
8347 (while (>= (setq n (1- n)) 0)
8349 (end-of-line 1))))))
8351 (defun org-convert-to-oddeven-levels ()
8352 "Convert an org-mode file with only odd levels to one with odd/even levels.
8353 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8354 file contains a section with an even level, conversion would
8355 destroy the structure of the file. An error is signaled in this
8358 (goto-char (point-min))
8359 ;; First check if there are no even levels
8360 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8361 (org-show-context t)
8362 (error "Not all levels are odd in this file. Conversion not possible"))
8363 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8364 (let ((outline-regexp org-outline-regexp)
8365 (outline-level 'org-outline-level)
8366 (org-odd-levels-only nil) n)
8368 (goto-char (point-min))
8369 (while (re-search-forward "^\\*\\*+ " nil t)
8370 (setq n (/ (1- (length (match-string 0))) 2))
8371 (while (>= (setq n (1- n)) 0)
8373 (end-of-line 1))))))
8375 (defun org-tr-level (n)
8376 "Make N odd if required."
8377 (if org-odd-levels-only (1+ (/ n 2)) n))
8379 ;;; Vertical tree motion, cutting and pasting of subtrees
8381 (defun org-move-subtree-up (&optional arg)
8382 "Move the current subtree up past ARG headlines of the same level."
8384 (org-move-subtree-down (- (prefix-numeric-value arg))))
8386 (defun org-move-subtree-down (&optional arg)
8387 "Move the current subtree down past ARG headlines of the same level."
8389 (setq arg (prefix-numeric-value arg))
8390 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8391 'org-get-last-sibling))
8392 (ins-point (make-marker))
8394 (col (current-column))
8395 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8397 (org-back-to-heading)
8400 (setq ne-beg (org-back-over-empty-lines))
8403 (save-excursion (outline-end-of-heading)
8404 (setq folded (outline-invisible-p)))
8405 (progn (org-end-of-subtree nil t)
8406 (unless (eobp) (backward-char))))
8407 (outline-next-heading)
8408 (setq ne-end (org-back-over-empty-lines))
8411 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8412 ;; include less whitespace
8415 (forward-line (- ne-beg ne-end))
8416 (setq beg (point))))
8417 ;; Find insertion point, with error handling
8419 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8420 (progn (goto-char beg0)
8421 (user-error "Cannot move past superior level or buffer limit")))
8422 (setq cnt (1- cnt)))
8424 ;; Moving forward - still need to move over subtree
8425 (progn (org-end-of-subtree t t)
8427 (org-back-over-empty-lines)
8428 (or (bolp) (newline)))))
8429 (setq ne-ins (org-back-over-empty-lines))
8430 (move-marker ins-point (point))
8431 (setq txt (buffer-substring beg end))
8432 (org-save-markers-in-region beg end)
8433 (delete-region beg end)
8434 (org-remove-empty-overlays-at beg)
8435 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8436 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8437 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8438 (let ((bbb (point)))
8439 (insert-before-markers txt)
8440 (org-reinstall-markers-in-region bbb)
8441 (move-marker ins-point bbb))
8442 (or (bolp) (insert "\n"))
8443 (setq ins-end (point))
8444 (goto-char ins-point)
8445 (org-skip-whitespace)
8446 (when (and (< arg 0)
8447 (org-first-sibling-p)
8449 ;; Move whitespace back to beginning
8452 (let ((kill-whole-line t))
8453 (kill-line (- ne-ins ne-beg)) (point)))
8454 (insert (make-string (- ne-ins ne-beg) ?\n)))
8455 (move-marker ins-point nil)
8460 (org-cycle-hide-drawers 'children))
8461 (org-clean-visibility-after-subtree-move)
8462 ;; move back to the initial column we were at
8463 (move-to-column col)))
8465 (defvar org-subtree-clip ""
8466 "Clipboard for cut and paste of subtrees.
8467 This is actually only a copy of the kill, because we use the normal kill
8468 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8470 (defvar org-subtree-clip-folded nil
8471 "Was the last copied subtree folded?
8472 This is used to fold the tree back after pasting.")
8474 (defun org-cut-subtree (&optional n)
8475 "Cut the current subtree into the clipboard.
8476 With prefix arg N, cut this many sequential subtrees.
8477 This is a short-hand for marking the subtree and then cutting it."
8479 (org-copy-subtree n 'cut))
8481 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8482 "Copy the current subtree it in the clipboard.
8483 With prefix arg N, copy this many sequential subtrees.
8484 This is a short-hand for marking the subtree and then copying it.
8485 If CUT is non-nil, actually cut the subtree.
8486 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8487 of some markers in the region, even if CUT is non-nil. This is
8488 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8490 (let (beg end folded (beg0 (point)))
8491 (if (org-called-interactively-p 'any)
8492 (org-back-to-heading nil) ; take what looks like a subtree
8493 (org-back-to-heading t)) ; take what is really there
8495 (skip-chars-forward " \t\r\n")
8498 (outline-next-heading)
8499 (save-excursion (outline-end-of-heading)
8500 (setq folded (outline-invisible-p)))
8501 (ignore-errors (org-forward-heading-same-level (1- n) t))
8502 (org-end-of-subtree t t)))
8506 (setq org-subtree-clip-folded folded)
8507 (when (or cut force-store-markers)
8508 (org-save-markers-in-region beg end))
8509 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8510 (setq org-subtree-clip (current-kill 0))
8511 (message "%s: Subtree(s) with %d characters"
8512 (if cut "Cut" "Copied")
8513 (length org-subtree-clip)))))
8515 (defun org-paste-subtree (&optional level tree for-yank remove)
8516 "Paste the clipboard as a subtree, with modification of headline level.
8517 The entire subtree is promoted or demoted in order to match a new headline
8520 If the cursor is at the beginning of a headline, the same level as
8521 that headline is used to paste the tree.
8523 If not, the new level is derived from the *visible* headings
8524 before and after the insertion point, and taken to be the inferior headline
8525 level of the two. So if the previous visible heading is level 3 and the
8526 next is level 4 (or vice versa), level 4 will be used for insertion.
8527 This makes sure that the subtree remains an independent subtree and does
8528 not swallow low level entries.
8530 You can also force a different level, either by using a numeric prefix
8531 argument, or by inserting the heading marker by hand. For example, if the
8532 cursor is after \"*****\", then the tree will be shifted to level 5.
8534 If optional TREE is given, use this text instead of the kill ring.
8536 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8537 move back over whitespace before inserting, and move point to the end of
8538 the inserted text when done.
8540 When REMOVE is non-nil, remove the subtree from the clipboard."
8542 (setq tree (or tree (and kill-ring (current-kill 0))))
8543 (unless (org-kill-is-subtree-p tree)
8545 (substitute-command-keys
8546 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8547 (org-with-limited-levels
8548 (let* ((visp (not (outline-invisible-p)))
8550 (^re_ "\\(\\*+\\)[ \t]*")
8551 (old-level (if (string-match org-outline-regexp-bol txt)
8552 (- (match-end 0) (match-beginning 0) 1)
8554 (force-level (cond (level (prefix-numeric-value level))
8555 ((and (looking-at "[ \t]*$")
8557 "^\\*+$" (buffer-substring
8558 (point-at-bol) (point))))
8559 (- (match-end 0) (match-beginning 0)))
8561 (looking-at org-outline-regexp))
8562 (- (match-end 0) (point) 1))))
8563 (previous-level (save-excursion
8566 (outline-previous-visible-heading 1)
8567 (if (looking-at ^re_)
8568 (- (match-end 0) (match-beginning 0) 1)
8571 (next-level (save-excursion
8574 (or (looking-at org-outline-regexp)
8575 (outline-next-visible-heading 1))
8576 (if (looking-at ^re_)
8577 (- (match-end 0) (match-beginning 0) 1)
8580 (new-level (or force-level (max previous-level next-level)))
8581 (shift (if (or (= old-level -1)
8583 (= old-level new-level))
8585 (- new-level old-level)))
8586 (delta (if (> shift 0) -1 1))
8587 (func (if (> shift 0) 'org-demote 'org-promote))
8588 (org-odd-levels-only nil)
8590 ;; Remove the forced level indicator
8592 (delete-region (point-at-bol) (point)))
8594 (beginning-of-line (if (bolp) 1 2))
8596 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8597 (insert-before-markers txt)
8598 (unless (string-match "\n\\'" txt) (insert "\n"))
8599 (setq newend (point))
8600 (org-reinstall-markers-in-region beg)
8603 (skip-chars-forward " \t\n\r")
8605 (if (and (outline-invisible-p) visp)
8606 (save-excursion (outline-show-heading)))
8607 ;; Shift if necessary
8610 (narrow-to-region beg end)
8611 (while (not (= shift 0))
8612 (org-map-region func (point-min) (point-max))
8613 (setq shift (+ delta shift)))
8614 (goto-char (point-min))
8615 (setq newend (point-max))))
8616 (when (or (org-called-interactively-p 'interactive) for-yank)
8617 (message "Clipboard pasted as level %d subtree" new-level))
8618 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8620 (eq org-subtree-clip (current-kill 0))
8621 org-subtree-clip-folded)
8622 ;; The tree was folded before it was killed/copied
8624 (and for-yank (goto-char newend))
8625 (and remove (setq kill-ring (cdr kill-ring))))))
8627 (defun org-kill-is-subtree-p (&optional txt)
8628 "Check if the current kill is an outline subtree, or a set of trees.
8629 Returns nil if kill does not start with a headline, or if the first
8630 headline level is not the largest headline level in the tree.
8631 So this will actually accept several entries of equal levels as well,
8632 which is OK for `org-paste-subtree'.
8633 If optional TXT is given, check this string instead of the current kill."
8634 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8635 (re (org-get-limited-outline-regexp))
8636 (^re (concat "^" re))
8637 (start-level (and kill
8639 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8641 (- (match-end 2) (match-beginning 2) 1)))
8642 (start (1+ (or (match-beginning 2) -1))))
8643 (if (not start-level)
8645 nil) ;; does not even start with a heading
8647 (while (setq start (string-match ^re kill (1+ start)))
8648 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8652 (defvar org-markers-to-move nil
8653 "Markers that should be moved with a cut-and-paste operation.
8654 Those markers are stored together with their positions relative to
8655 the start of the region.")
8657 (defun org-save-markers-in-region (beg end)
8658 "Check markers in region.
8659 If these markers are between BEG and END, record their position relative
8660 to BEG, so that after moving the block of text, we can put the markers back
8662 This function gets called just before an entry or tree gets cut from the
8663 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8664 called immediately, to move the markers with the entries."
8665 (setq org-markers-to-move nil)
8666 (when (featurep 'org-clock)
8667 (org-clock-save-markers-for-cut-and-paste beg end))
8668 (when (featurep 'org-agenda)
8669 (org-agenda-save-markers-for-cut-and-paste beg end)))
8671 (defun org-check-and-save-marker (marker beg end)
8672 "Check if MARKER is between BEG and END.
8673 If yes, remember the marker and the distance to BEG."
8674 (when (and (marker-buffer marker)
8675 (equal (marker-buffer marker) (current-buffer)))
8676 (if (and (>= marker beg) (< marker end))
8677 (push (cons marker (- marker beg)) org-markers-to-move))))
8679 (defun org-reinstall-markers-in-region (beg)
8680 "Move all remembered markers to their position relative to BEG."
8682 (move-marker (car x) (+ beg (cdr x))))
8683 org-markers-to-move)
8684 (setq org-markers-to-move nil))
8686 (defun org-narrow-to-subtree ()
8687 "Narrow buffer to the current subtree."
8691 (org-with-limited-levels
8693 (progn (org-back-to-heading t) (point))
8694 (progn (org-end-of-subtree t t)
8695 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8698 (defun org-narrow-to-block ()
8699 "Narrow buffer to the current block."
8701 (let* ((case-fold-search t)
8702 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8703 "^[ \t]*#\\+end_.*")))
8705 (narrow-to-region (car blockp) (cdr blockp))
8706 (user-error "Not in a block"))))
8708 (defun org-clone-subtree-with-time-shift (n &optional shift)
8709 "Clone the task (subtree) at point N times.
8710 The clones will be inserted as siblings.
8712 In interactive use, the user will be prompted for the number of
8713 clones to be produced. If the entry has a timestamp, the user
8714 will also be prompted for a time shift, which may be a repeater
8715 as used in time stamps, for example `+3d'. To disable this,
8716 you can call the function with a universal prefix argument.
8718 When a valid repeater is given and the entry contains any time
8719 stamps, the clones will become a sequence in time, with time
8720 stamps in the subtree shifted for each clone produced. If SHIFT
8721 is nil or the empty string, time stamps will be left alone. The
8722 ID property of the original subtree is removed.
8724 If the original subtree did contain time stamps with a repeater,
8725 the following will happen:
8726 - the repeater will be removed in each clone
8727 - an additional clone will be produced, with the current, unshifted
8728 date(s) in the entry.
8729 - the original entry will be placed *after* all the clones, with
8731 - the start days in the repeater in the original entry will be shifted
8732 to past the last clone.
8733 In this way you can spell out a number of instances of a repeating task,
8734 and still retain the repeater to cover future instances of the task."
8735 (interactive "nNumber of clones to produce: ")
8738 (if (and (not (equal current-prefix-arg '(4)))
8740 (re-search-forward org-ts-regexp-both
8742 (org-end-of-subtree t)
8744 (read-from-minibuffer
8745 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8746 ""))) ;; No time shift
8748 (drawer-re org-drawer-regexp)
8749 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8750 beg end template task idprop
8751 shift-n shift-what doshift nmin nmax)
8752 (if (not (and (integerp n) (> n 0)))
8753 (user-error "Invalid number of replications %s" n))
8754 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8755 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8757 (user-error "Invalid shift specification %s" shift))
8759 (setq shift-n (string-to-number (match-string 1 shift))
8760 shift-what (cdr (assoc (match-string 2 shift)
8761 '(("d" . day) ("w" . week)
8762 ("m" . month) ("y" . year))))))
8763 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8764 (setq nmin 1 nmax n)
8765 (org-back-to-heading t)
8767 (setq idprop (org-entry-get nil "ID"))
8768 (org-end-of-subtree t t)
8769 (or (bolp) (insert "\n"))
8771 (setq template (buffer-substring beg end))
8773 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8774 (delete-region beg end)
8776 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8778 (loop for n from nmin to nmax do
8783 (goto-char (point-min))
8785 (and idprop (if org-clone-delete-id
8786 (org-entry-delete nil "ID")
8787 (org-id-get-create t)))
8789 (while (re-search-forward org-clock-re nil t)
8791 (goto-char (point-min))
8792 (while (re-search-forward drawer-re nil t)
8793 (org-remove-empty-drawer-at (point))))
8794 (goto-char (point-min))
8796 (while (re-search-forward org-ts-regexp-both nil t)
8797 (org-timestamp-change (* n shift-n) shift-what))
8798 (unless (= n n-no-remove)
8799 (goto-char (point-min))
8800 (while (re-search-forward org-ts-regexp nil t)
8802 (goto-char (match-beginning 0))
8803 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8804 (delete-region (match-beginning 1) (match-end 1)))))))
8805 (setq task (buffer-string)))
8811 (defun org-sort (with-case)
8812 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8813 Optional argument WITH-CASE means sort case-sensitively."
8816 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8817 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8819 (org-call-with-arg 'org-sort-entries with-case))))
8821 (defun org-sort-remove-invisible (s)
8822 "Remove invisible links from string S."
8823 (remove-text-properties 0 (length s) org-rm-props s)
8824 (while (string-match org-bracket-link-regexp s)
8825 (setq s (replace-match (if (match-end 2)
8827 (match-string 1 s)) t t s)))
8828 (let ((st (format " %s " s)))
8829 (while (string-match org-emph-re st)
8830 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8831 (setq s (substring st 1 -1)))
8834 (defvar org-priority-regexp) ; defined later in the file
8836 (defvar org-after-sorting-entries-or-items-hook nil
8837 "Hook that is run after a bunch of entries or items have been sorted.
8838 When children are sorted, the cursor is in the parent line when this
8839 hook gets called. When a region or a plain list is sorted, the cursor
8840 will be in the first entry of the sorted region/list.")
8842 (defun org-sort-entries
8843 (&optional with-case sorting-type getkey-func compare-func property)
8844 "Sort entries on a certain level of an outline tree.
8845 If there is an active region, the entries in the region are sorted.
8846 Else, if the cursor is before the first entry, sort the top-level items.
8847 Else, the children of the entry at point are sorted.
8849 Sorting can be alphabetically, numerically, by date/time as given by
8850 a time stamp, by a property, by priority order, or by a custom function.
8852 The command prompts for the sorting type unless it has been given to the
8853 function through the SORTING-TYPE argument, which needs to be a character,
8854 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8855 the precise meaning of each character:
8857 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8858 c By creation time, which is assumed to be the first inactive time stamp
8859 at the beginning of a line.
8860 d By deadline date/time.
8862 n Numerically, by converting the beginning of the entry/item to a number.
8863 o By order of TODO keywords.
8864 p By priority according to the cookie.
8865 r By the value of a property.
8866 s By scheduled date/time.
8867 t By date/time, either the first active time stamp in the entry, or, if
8868 none exist, by the first inactive one.
8870 Capital letters will reverse the sort order.
8872 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8873 called with point at the beginning of the record. It must return either
8874 a string or a number that should serve as the sorting key for that record.
8876 Comparing entries ignores case by default. However, with an optional argument
8877 WITH-CASE, the sorting considers case as well.
8879 Sorting is done against the visible part of the headlines, it ignores hidden
8882 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8884 (let ((case-func (if with-case 'identity 'downcase))
8886 ;; The clock marker is lost when using `sort-subr', let's
8887 ;; store the clocking string.
8888 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8890 (goto-char org-clock-marker)
8891 (looking-back "^.*") (match-string-no-properties 0))))
8892 start beg end stars re re2
8894 ;; Find beginning and end of region to sort
8896 ((org-region-active-p)
8897 ;; we will sort the region
8898 (setq end (region-end)
8900 (goto-char (region-beginning))
8901 (if (not (org-at-heading-p)) (outline-next-heading))
8902 (setq start (point)))
8903 ((or (org-at-heading-p)
8904 (ignore-errors (progn (org-back-to-heading) t)))
8905 ;; we will sort the children of the current headline
8906 (org-back-to-heading)
8908 end (progn (org-end-of-subtree t t)
8909 (or (bolp) (insert "\n"))
8910 (when (>= (org-back-over-empty-lines) 1)
8916 (outline-next-heading))
8918 ;; we will sort the top-level entries in this file
8919 (goto-char (point-min))
8920 (or (org-at-heading-p) (outline-next-heading))
8921 (setq start (point))
8922 (goto-char (point-max))
8923 (beginning-of-line 1)
8924 (when (looking-at ".*?\\S-")
8925 ;; File ends in a non-white line
8928 (setq end (point-max))
8929 (setq what "top-level")
8934 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8936 (looking-at "\\(\\*+\\)")
8937 (setq stars (match-string 1)
8938 re (concat "^" (regexp-quote stars) " +")
8939 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8940 txt (buffer-substring beg end))
8941 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8942 (if (and (not (equal stars "*")) (string-match re2 txt))
8943 (user-error "Region to sort contains a level above the first entry"))
8945 (unless sorting-type
8947 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8948 [t]ime
[s]cheduled [d]eadline [c]reated cloc[k]ing
8949 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8951 (setq sorting-type (read-char-exclusive))
8954 (and (= (downcase sorting-type) ?f)
8956 (org-icompleting-read "Sort using function: "
8957 obarray 'fboundp t nil nil))
8958 (setq getkey-func (intern getkey-func))))
8960 (and (= (downcase sorting-type) ?r)
8963 (org-icompleting-read "Property: "
8964 (mapcar 'list (org-buffer-property-keys t))
8967 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8968 (message "Sorting entries...")
8971 (narrow-to-region start end)
8972 (let ((dcst (downcase sorting-type))
8973 (case-fold-search nil)
8974 (now (current-time)))
8976 (/= dcst sorting-type)
8977 ;; This function moves to the beginning character of the "record" to
8980 (if (re-search-forward re nil t)
8981 (goto-char (match-beginning 0))
8982 (goto-char (point-max))))
8983 ;; This function moves to the last character of the "record" being
8988 (outline-forward-same-level 1)
8990 (goto-char (point-max))))))
8991 ;; This function returns the value that gets sorted against.
8995 (if (looking-at org-complex-heading-regexp)
8996 (string-to-number (org-sort-remove-invisible (match-string 4)))
8999 (if (looking-at org-complex-heading-regexp)
9000 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9003 (or (get-text-property (point) :org-clock-minutes) 0))
9005 (let ((end (save-excursion (outline-next-heading) (point))))
9006 (if (or (re-search-forward org-ts-regexp end t)
9007 (re-search-forward org-ts-regexp-both end t))
9008 (org-time-string-to-seconds (match-string 0))
9009 (org-float-time now))))
9011 (let ((end (save-excursion (outline-next-heading) (point))))
9012 (if (re-search-forward
9013 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9015 (org-time-string-to-seconds (match-string 0))
9016 (org-float-time now))))
9018 (let ((end (save-excursion (outline-next-heading) (point))))
9019 (if (re-search-forward org-scheduled-time-regexp end t)
9020 (org-time-string-to-seconds (match-string 1))
9021 (org-float-time now))))
9023 (let ((end (save-excursion (outline-next-heading) (point))))
9024 (if (re-search-forward org-deadline-time-regexp end t)
9025 (org-time-string-to-seconds (match-string 1))
9026 (org-float-time now))))
9028 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9029 (string-to-char (match-string 2))
9030 org-default-priority))
9032 (or (org-entry-get nil property) ""))
9034 (if (looking-at org-complex-heading-regexp)
9035 (let* ((m (match-string 2))
9036 (s (if (member m org-done-keywords) '- '+)))
9037 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9041 (setq tmp (funcall getkey-func))
9042 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9044 (error "Invalid key function `%s'" getkey-func)))
9045 (t (error "Invalid sorting type `%c'" sorting-type))))
9048 ((= dcst ?a) 'string<)
9049 ((= dcst ?f) compare-func)
9050 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9051 (run-hooks 'org-after-sorting-entries-or-items-hook)
9052 ;; Reset the clock marker if needed
9056 (search-forward cmstr nil t)
9057 (move-marker org-clock-marker (point))))
9058 (message "Sorting entries...done")))
9060 (defun org-do-sort (table what &optional with-case sorting-type getkey-func compare-func)
9061 "Sort TABLE of WHAT according to SORTING-TYPE.
9062 The user will be prompted for the SORTING-TYPE if the call to this
9063 function does not specify it.
9064 WHAT is only for the prompt, to indicate what is being sorted.
9065 The sorting key will be extracted from the car of the elements of
9066 the table. If WITH-CASE is non-nil, the sorting will be case-sensitive.
9068 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
9069 a function to be called to extract the key. It must return either
9070 a string or a number that should serve as the sorting key for that
9071 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
9072 is specified interactively, the comparison will be either a string or
9073 numeric compare based on the type of the first key in the table."
9074 (unless sorting-type
9076 "Sort %s: [a]lphabetic, [n]umeric, [t]ime, [f]unc. A/N/T/F means reversed:"
9078 (setq sorting-type (read-char-exclusive)))
9079 (let (extractfun comparefun tempfun)
9080 ;; Define the appropriate functions
9083 (setq extractfun #'string-to-number
9084 comparefun (if (= sorting-type ?n) #'< #'>)))
9086 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
9087 (lambda(x) (downcase (org-sort-remove-invisible x))))
9088 comparefun (if (= sorting-type ?a) #'string< #'org-string>)))
9092 (cond ((or (string-match org-ts-regexp x)
9093 (string-match org-ts-regexp-both x))
9095 (org-time-string-to-time (match-string 0 x))))
9096 ((string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" x)
9097 (org-hh:mm-string-to-minutes x))
9099 comparefun (if (= sorting-type ?t) '< '>)))
9101 (setq tempfun (or getkey-func
9102 (intern (org-icompleting-read
9103 "Sort using function: "
9104 obarray #'fboundp t nil nil))))
9105 (let ((extract-string-p (stringp (funcall tempfun (caar table)))))
9106 (setq extractfun (if (and extract-string-p (not with-case))
9107 (lambda (x) (downcase (funcall tempfun x)))
9109 (setq comparefun (cond (compare-func
9110 (if (= sorting-type ?f) compare-func
9111 (lambda (a b) (funcall compare-func b a))))
9113 (if (= sorting-type ?f) #'string<
9115 (t (if (= sorting-type ?f) #'< #'>))))))
9116 (t (error "Invalid sorting type `%c'" sorting-type)))
9118 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
9120 (lambda (a b) (funcall comparefun (car a) (car b))))))
9122 ;;; The orgstruct minor mode
9124 ;; Define a minor mode which can be used in other modes in order to
9125 ;; integrate the org-mode structure editing commands.
9127 ;; This is really a hack, because the org-mode structure commands use
9128 ;; keys which normally belong to the major mode. Here is how it
9129 ;; works: The minor mode defines all the keys necessary to operate the
9130 ;; structure commands, but wraps the commands into a function which
9131 ;; tests if the cursor is currently at a headline or a plain list
9132 ;; item. If that is the case, the structure command is used,
9133 ;; temporarily setting many Org-mode variables like regular
9134 ;; expressions for filling etc. However, when any of those keys is
9135 ;; used at a different location, function uses `key-binding' to look
9136 ;; up if the key has an associated command in another currently active
9137 ;; keymap (minor modes, major mode, global), and executes that
9138 ;; command. There might be problems if any of the keys is otherwise
9139 ;; used as a prefix key.
9141 (defcustom orgstruct-heading-prefix-regexp ""
9142 "Regexp that matches the custom prefix of Org headlines in
9143 orgstruct(++)-mode."
9146 :package-version '(Org . "8.3")
9148 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9150 (defcustom orgstruct-setup-hook nil
9151 "Hook run after orgstruct-mode-map is filled."
9154 :package-version '(Org . "8.0")
9157 (defvar orgstruct-initialized nil)
9159 (defvar org-local-vars nil
9160 "List of local variables, for use by `orgstruct-mode'.")
9163 (define-minor-mode orgstruct-mode
9164 "Toggle the minor mode `orgstruct-mode'.
9165 This mode is for using Org-mode structure commands in other
9166 modes. The following keys behave as if Org-mode were active, if
9167 the cursor is on a headline, or on a plain list item (both as
9168 defined by Org-mode)."
9169 nil " OrgStruct" (make-sparse-keymap)
9170 (funcall (if orgstruct-mode
9171 'add-to-invisibility-spec
9172 'remove-from-invisibility-spec)
9174 (when orgstruct-mode
9175 (org-load-modules-maybe)
9176 (unless orgstruct-initialized
9178 (setq orgstruct-initialized t))))
9181 (defun turn-on-orgstruct ()
9182 "Unconditionally turn on `orgstruct-mode'."
9185 (defvar org-fb-vars nil)
9186 (make-variable-buffer-local 'org-fb-vars)
9187 (defun orgstruct++-mode (&optional arg)
9188 "Toggle `orgstruct-mode', the enhanced version of it.
9189 In addition to setting orgstruct-mode, this also exports all
9190 indentation and autofilling variables from org-mode into the
9191 buffer. It will also recognize item context in multiline items."
9193 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9195 (progn (orgstruct-mode -1)
9197 (org-set-local (car v)
9198 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9201 (setq org-fb-vars nil)
9202 (unless org-local-vars
9203 (setq org-local-vars (org-get-local-variables)))
9208 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9209 (symbol-name (car x)))
9210 (setq var (car x) val (nth 1 x))
9211 (push (list var `(quote ,(eval var))) org-fb-vars)
9212 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9214 (org-set-local 'orgstruct-is-++ t))))
9216 (defvar orgstruct-is-++ nil
9217 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9218 (make-variable-buffer-local 'orgstruct-is-++)
9221 (defun turn-on-orgstruct++ ()
9222 "Unconditionally turn on `orgstruct++-mode'."
9223 (orgstruct++-mode 1))
9225 (defun orgstruct-error ()
9226 "Error when there is no default binding for a structure key."
9228 (funcall (if (fboundp 'user-error)
9231 "This key has no function outside structure elements"))
9233 (defun orgstruct-setup ()
9234 "Setup orgstruct keymap."
9235 (dolist (cell '((org-demote . t)
9239 (org-shiftmetaleft . t)
9240 (org-shiftmetaright . t)
9241 org-backward-element
9242 org-backward-heading-same-level
9247 org-forward-heading-same-level
9249 org-insert-heading-respect-content
9250 org-kill-note-or-show-branches
9255 org-narrow-to-subtree
9270 outline-next-visible-heading
9271 outline-previous-visible-heading
9275 (let ((f (or (car-safe cell) cell))
9276 (disable-when-heading-prefix (cdr-safe cell)))
9278 (let ((new-bindings))
9279 (dolist (binding (nconc (where-is-internal f org-mode-map)
9280 (where-is-internal f outline-mode-map)))
9281 (push binding new-bindings)
9282 ;; TODO use local-function-key-map
9283 (dolist (rep '(("<tab>" . "TAB")
9284 ("<return>" . "RET")
9285 ("<escape>" . "ESC")
9286 ("<delete>" . "DEL")))
9287 (setq binding (read-kbd-macro
9288 (let ((case-fold-search))
9289 (replace-regexp-in-string
9290 (regexp-quote (cdr rep))
9292 (key-description binding)))))
9293 (pushnew binding new-bindings :test 'equal)))
9294 (dolist (binding new-bindings)
9295 (let ((key (lookup-key orgstruct-mode-map binding)))
9296 (when (or (not key) (numberp key))
9298 (org-defkey orgstruct-mode-map
9300 (orgstruct-make-binding
9301 f binding disable-when-heading-prefix))))))))))
9302 (run-hooks 'orgstruct-setup-hook))
9304 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9305 "Create a function for binding in the structure minor mode.
9306 FUN is the command to call inside a table. KEY is the key that
9307 should be checked in for a command to execute outside of tables.
9308 Non-nil `disable-when-heading-prefix' means to disable the command
9309 if `orgstruct-heading-prefix-regexp' is not empty."
9310 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9313 (while (fboundp (intern nname))
9314 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9315 (setq name (intern nname)))
9317 (let ((bindings '((org-heading-regexp
9319 orgstruct-heading-prefix-regexp
9320 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9322 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9323 (org-outline-regexp-bol
9324 (concat "^" org-outline-regexp))
9325 (outline-regexp org-outline-regexp)
9326 (outline-heading-end-regexp "\n")
9327 (outline-level 'org-outline-level)
9328 (outline-heading-alist))))
9330 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9331 "Outside of structure, run the binding of `"
9332 (key-description key) "'."
9333 (when disable-when-heading-prefix
9335 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9336 "back to the default binding due to limitations of Org's implementation of\n"
9337 "`" (symbol-name fun) "'.")))
9340 ,(and disable-when-heading-prefix
9341 '(not (string= orgstruct-heading-prefix-regexp ""))))
9346 (org-context-p 'headline 'item
9348 '(org-insert-heading
9349 org-insert-heading-respect-content
9351 '(when orgstruct-is-++
9354 (let* ((orgstruct-mode)
9361 ("<\\([^>]*\\)tab>" . "\\1TAB")
9362 ("<\\([^>]*\\)return>" . "\\1RET")
9363 ("<\\([^>]*\\)escape>" . "\\1ESC")
9364 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9367 (setq key (read-kbd-macro
9368 (let ((case-fold-search))
9369 (replace-regexp-in-string
9372 (key-description key))))))
9373 (when (key-binding key)
9374 (throw 'exit (key-binding key))))))))
9375 (if (keymapp binding)
9376 (org-set-transient-map binding)
9377 (let ((func (or binding
9379 'orgstruct-error))))
9381 (call-interactively func)))))
9382 (org-run-like-in-org-mode
9386 (call-interactively ',fun)))))))))
9389 (defun org-contextualize-keys (alist contexts)
9390 "Return valid elements in ALIST depending on CONTEXTS.
9392 `org-agenda-custom-commands' or `org-capture-templates' are the
9393 values used for ALIST, and `org-agenda-custom-commands-contexts'
9394 or `org-capture-templates-contexts' are the associated contexts
9397 ;; normalize contexts
9399 (lambda(c) (cond ((listp (cadr c))
9400 (list (car c) (car c) (cadr c)))
9401 ((string= "" (cadr c))
9402 (list (car c) (car c) (caddr c)))
9405 ;; loop over all commands or templates
9406 (while (setq c (pop a))
9409 ((not (assoc (car c) contexts))
9411 ((and (assoc (car c) contexts)
9412 (setq vrules (org-contextualize-validate-key
9415 (when (not (equal (car vr) (cadr vr)))
9416 (setq repl vr))) vrules)
9417 (if (not repl) (push c r)
9418 (push (cadr repl) s)
9421 (cdr (or (assoc (cadr repl) alist)
9422 (error "Undefined key `%s' as contextual replacement for `%s'"
9423 (cadr repl) (car c)))))
9425 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9430 (let ((tpl (car x)))
9434 (equal y tpl)) s))) x)))
9437 (defun org-contextualize-validate-key (key contexts)
9438 "Check CONTEXTS for agenda or capture KEY."
9440 (while (setq r (pop contexts))
9444 (and (equal key (car r))
9445 (if (functionp rr) (funcall rr)
9446 (or (and (eq (car rr) 'in-file)
9448 (string-match (cdr rr) (buffer-file-name)))
9449 (and (eq (car rr) 'in-mode)
9450 (string-match (cdr rr) (symbol-name major-mode)))
9451 (and (eq (car rr) 'in-buffer)
9452 (string-match (cdr rr) (buffer-name)))
9453 (when (and (eq (car rr) 'not-in-file)
9455 (not (string-match (cdr rr) (buffer-file-name))))
9456 (when (eq (car rr) 'not-in-mode)
9457 (not (string-match (cdr rr) (symbol-name major-mode))))
9458 (when (eq (car rr) 'not-in-buffer)
9459 (not (string-match (cdr rr) (buffer-name)))))))
9462 (delete-dups (delq nil res))))
9464 (defun org-context-p (&rest contexts)
9465 "Check if local context is any of CONTEXTS.
9466 Possible values in the list of contexts are `table', `headline', and `item'."
9467 (let ((pos (point)))
9468 (goto-char (point-at-bol))
9469 (prog1 (or (and (memq 'table contexts)
9470 (looking-at "[ \t]*|"))
9471 (and (memq 'headline contexts)
9472 (looking-at org-outline-regexp))
9473 (and (memq 'item contexts)
9474 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9475 (and (memq 'item-body contexts)
9479 (defun org-get-local-variables ()
9480 "Return a list of all local variables in an Org mode buffer."
9482 (with-current-buffer (get-buffer-create "*Org tmp*")
9485 (setq varlist (buffer-local-variables)))
9486 (kill-buffer "*Org tmp*")
9493 (list (car x) (cdr x))))
9494 (if (and (not (get (car x) 'org-state))
9496 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9497 (symbol-name (car x))))
9501 (defun org-clone-local-variables (from-buffer &optional regexp)
9502 "Clone local variables from FROM-BUFFER.
9503 Optional argument REGEXP selects variables to clone."
9506 (and (symbolp (car pair))
9508 (string-match regexp (symbol-name (car pair))))
9509 (set (make-local-variable (car pair))
9511 (buffer-local-variables from-buffer)))
9514 (defun org-run-like-in-org-mode (cmd)
9515 "Run a command, pretending that the current buffer is in Org-mode.
9516 This will temporarily bind local variables that are typically bound in
9517 Org-mode to the values they have in Org-mode, and then interactively
9519 (org-load-modules-maybe)
9520 (unless org-local-vars
9521 (setq org-local-vars (org-get-local-variables)))
9523 (dolist (var org-local-vars)
9524 (when (or (not (boundp (car var)))
9525 (eq (symbol-value (car var))
9526 (default-value (car var))))
9527 (push (list (car var) `(quote ,(cadr var))) binds)))
9529 (call-interactively (quote ,cmd))))))
9531 (defun org-get-category (&optional pos force-refresh)
9532 "Get the category applying to position POS."
9534 (if force-refresh (org-refresh-category-properties))
9535 (let ((pos (or pos (point))))
9536 (or (get-text-property pos 'org-category)
9537 (progn (org-refresh-category-properties)
9538 (get-text-property pos 'org-category))))))
9540 ;;; Refresh properties
9542 (defun org-refresh-properties (dprop tprop)
9543 "Refresh buffer text properties.
9544 DPROP is the drawer property and TPROP is either the
9545 corresponding text property to set, or an alist with each element
9546 being a text property (as a symbol) and a function to apply to
9547 the value of the drawer property."
9548 (let ((case-fold-search t)
9549 (inhibit-read-only t))
9550 (org-with-silent-modifications
9554 (goto-char (point-min))
9555 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9556 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9558 (defun org-refresh-property (tprop p)
9559 "Refresh the buffer text property TPROP from the drawer property P.
9560 The refresh happens only for the current tree (not subtree)."
9562 (org-back-to-heading t)
9563 ;; tprop is a text property symbol
9566 (point) (or (outline-next-heading) (point-max)) tprop p)
9567 ;; tprop is an alist with (properties . function) elements
9571 (point-at-bol) (or (outline-next-heading) (point-max))
9573 (funcall (cdr al) p))))
9576 (defun org-refresh-category-properties ()
9577 "Refresh category text properties in the buffer."
9578 (let ((case-fold-search t)
9579 (inhibit-read-only t)
9581 ((null org-category)
9582 (if buffer-file-name
9583 (file-name-sans-extension
9584 (file-name-nondirectory buffer-file-name))
9586 ((symbolp org-category) (symbol-name org-category))
9588 beg end cat pos optionp)
9589 (org-with-silent-modifications
9593 (goto-char (point-min))
9594 (put-text-property (point) (point-max) 'org-category def-cat)
9595 (while (re-search-forward
9596 "^[ \t]*\\(\\(?:#\\+\\|:\\)CATEGORY:\\)\\(.*\\)" nil t)
9597 (setq pos (match-end 0)
9598 optionp (equal (char-after (match-beginning 0)) ?#)
9599 cat (org-trim (match-string 2)))
9601 (setq beg (point-at-bol) end (point-max))
9602 (org-back-to-heading t)
9603 (setq beg (point) end (org-end-of-subtree t t)))
9604 (put-text-property beg end 'org-category cat)
9605 (goto-char pos)))))))
9607 (defun org-refresh-stats-properties ()
9608 "Refresh stats text properties in the buffer."
9610 (org-with-silent-modifications
9614 (goto-char (point-min))
9615 (while (re-search-forward
9616 (concat org-outline-regexp-bol ".*"
9617 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9619 (setq stats (cond ((equal (match-string 3) "0") 0)
9621 (/ (* (string-to-number (match-string 2)) 100)
9622 (string-to-number (match-string 3))))
9623 (t (string-to-number (match-string 1)))))
9624 (org-back-to-heading t)
9625 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9626 'org-stats stats)))))))
9628 (defun org-refresh-effort-properties ()
9629 "Refresh effort properties"
9630 (org-refresh-properties
9632 '((effort . identity)
9633 (effort-minutes . org-duration-string-to-minutes))))
9637 ;;; Link abbreviations
9639 (defun org-link-expand-abbrev (link)
9640 "Apply replacements as defined in `org-link-abbrev-alist'."
9641 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9642 (let* ((key (match-string 1 link))
9643 (as (or (assoc key org-link-abbrev-alist-local)
9644 (assoc key org-link-abbrev-alist)))
9645 (tag (and (match-end 2) (match-string 3 link)))
9651 ((symbolp rpl) (funcall rpl tag))
9652 ((string-match "%(\\([^)]+\\))" rpl)
9655 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9656 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9657 ((string-match "%h" rpl)
9658 (replace-match (url-hexify-string (or tag "")) t t rpl))
9659 (t (concat rpl tag)))))
9662 ;;; Storing and inserting links
9664 (defvar org-insert-link-history nil
9665 "Minibuffer history for links inserted with `org-insert-link'.")
9667 (defvar org-stored-links nil
9668 "Contains the links stored with `org-store-link'.")
9670 (defvar org-store-link-plist nil
9671 "Plist with info about the most recently link created with `org-store-link'.")
9673 (defvar org-link-protocols nil
9674 "Link protocols added to Org-mode using `org-add-link-type'.")
9676 (defvar org-store-link-functions nil
9677 "List of functions that are called to create and store a link.
9678 Each function will be called in turn until one returns a non-nil
9679 value. Each function should check if it is responsible for creating
9680 this link (for example by looking at the major mode).
9681 If not, it must exit and return nil.
9682 If yes, it should return a non-nil value after a calling
9683 `org-store-link-props' with a list of properties and values.
9684 Special properties are:
9686 :type The link prefix, like \"http\". This must be given.
9687 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9688 This is obligatory as well.
9689 :description Optional default description for the second pair
9690 of brackets in an Org-mode link. The user can still change
9691 this when inserting this link into an Org-mode buffer.
9693 In addition to these, any additional properties can be specified
9694 and then used in capture templates.")
9696 (defun org-add-link-type (type &optional follow export)
9697 "Add TYPE to the list of `org-link-types'.
9698 Re-compute all regular expressions depending on `org-link-types'
9700 FOLLOW and EXPORT are two functions.
9702 FOLLOW should take the link path as the single argument and do whatever
9703 is necessary to follow the link, for example find a file or display
9706 EXPORT should format the link path for export to one of the export formats.
9707 It should be a function accepting three arguments:
9709 path the path of the link, the text after the prefix (like \"http:\")
9710 desc the description of the link, if any, or a description added by
9711 org-export-normalize-links if there is none
9712 format the export format, a symbol like `html' or `latex' or `ascii'..
9714 The function may use the FORMAT information to return different values
9715 depending on the format. The return value will be put literally into
9716 the exported file. If the return value is nil, this means Org should
9717 do what it normally does with links which do not have EXPORT defined.
9719 Org mode has a built-in default for exporting links. If you are happy with
9720 this default, there is no need to define an export function for the link
9721 type. For a simple example of an export function, see `org-bbdb.el'."
9722 (add-to-list 'org-link-types type t)
9723 (org-make-link-regexps)
9724 (org-element-update-syntax)
9725 (if (assoc type org-link-protocols)
9726 (setcdr (assoc type org-link-protocols) (list follow export))
9727 (push (list type follow export) org-link-protocols)))
9729 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9730 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9733 (defun org-store-link (arg)
9734 "\\<org-mode-map>Store an org-link to the current location.
9735 This link is added to `org-stored-links' and can later be inserted
9736 into an org-buffer with \\[org-insert-link].
9738 For some link types, a prefix arg is interpreted.
9739 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9740 For file links, arg negates `org-context-in-file-links'.
9742 A double prefix arg force skipping storing functions that are not
9745 A triple prefix arg force storing a link for each line in the
9748 (org-load-modules-maybe)
9749 (if (and (equal arg '(64)) (org-region-active-p))
9751 (let ((end (region-end)))
9752 (goto-char (region-beginning))
9754 (while (< (point-at-eol) end)
9755 (move-end-of-line 1) (activate-mark)
9756 (let (current-prefix-arg)
9757 (call-interactively 'org-store-link))
9758 (move-beginning-of-line 2)
9759 (set-mark (point)))))
9760 (org-with-limited-levels
9761 (setq org-store-link-plist nil)
9762 (let (link cpltxt desc description search
9763 txt custom-id agenda-link sfuns sfunsn)
9766 ;; Store a link using an external link type
9767 ((and (not (equal arg '(16)))
9770 nil (mapcar (lambda (f)
9771 (let (fs) (if (funcall f) (push f fs))))
9772 org-store-link-functions))
9773 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9774 (or (and (cdr sfuns)
9777 "Which function for creating the link? "
9778 sfunsn nil t (car sfunsn)))))
9779 (funcall (caar sfuns)))
9780 (setq link (plist-get org-store-link-plist :link)
9781 desc (or (plist-get org-store-link-plist
9782 :description) link))))
9784 ;; Store a link from a source code buffer
9785 ((org-src-edit-buffer-p)
9787 (while (or (not label)
9791 (goto-char (point-min))
9793 (regexp-quote (format org-coderef-label-format label))
9795 (when label (message "Label exists already") (sit-for 2))
9796 (setq label (read-string "Code line label: " label)))
9798 (setq link (format org-coderef-label-format label))
9799 (setq gc (- 79 (length link)))
9800 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9802 (setq link (concat "(" label ")") desc nil)))
9804 ;; We are in the agenda, link to referenced location
9805 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9806 (let ((m (or (get-text-property (point) 'org-hd-marker)
9807 (get-text-property (point) 'org-marker))))
9809 (org-with-point-at m
9811 (if (org-called-interactively-p 'any)
9812 (call-interactively 'org-store-link)
9813 (org-store-link nil)))))))
9815 ((eq major-mode 'calendar-mode)
9816 (let ((cd (calendar-cursor-to-date)))
9819 (car org-time-stamp-formats)
9821 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9823 (org-store-link-props :type "calendar" :date cd)))
9825 ((eq major-mode 'help-mode)
9826 (setq link (concat "help:" (save-excursion
9827 (goto-char (point-min))
9828 (looking-at "^[^ ]+")
9830 (org-store-link-props :type "help"))
9832 ((eq major-mode 'w3-mode)
9833 (setq cpltxt (if (and (buffer-name)
9834 (not (string-match "Untitled" (buffer-name))))
9837 link (url-view-url t))
9838 (org-store-link-props :type "w3" :url (url-view-url t)))
9840 ((eq major-mode 'image-mode)
9841 (setq cpltxt (concat "file:"
9842 (abbreviate-file-name buffer-file-name))
9844 (org-store-link-props :type "image" :file buffer-file-name))
9846 ;; In dired, store a link to the file of the current line
9847 ((derived-mode-p 'dired-mode)
9848 (let ((file (dired-get-filename nil t)))
9850 (abbreviate-file-name
9851 (expand-file-name (dired-get-filename nil t)))
9852 ;; otherwise, no file so use current directory.
9854 (setq cpltxt (concat "file:" file)
9857 ((setq search (run-hook-with-args-until-success
9858 'org-create-file-search-functions))
9859 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9861 (setq cpltxt (or description link)))
9863 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9864 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9866 ;; Store a link using the target at point
9867 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9870 (abbreviate-file-name
9871 (buffer-file-name (buffer-base-buffer)))
9872 "::" (match-string 1))
9874 ((and (featurep 'org-id)
9875 (or (eq org-id-link-to-org-use-id t)
9876 (and (org-called-interactively-p 'any)
9877 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9878 (and (eq org-id-link-to-org-use-id
9879 'create-if-interactive-and-no-custom-id)
9881 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9882 ;; Store a link using the ID at point
9883 (setq link (condition-case nil
9884 (prog1 (org-id-store-link)
9885 (setq desc (or (plist-get org-store-link-plist
9889 ;; Probably before first headline, link only to file
9891 (abbreviate-file-name
9892 (buffer-file-name (buffer-base-buffer))))))))
9894 ;; Just link to current headline
9895 (setq cpltxt (concat "file:"
9896 (abbreviate-file-name
9897 (buffer-file-name (buffer-base-buffer)))))
9898 ;; Add a context search string
9899 (when (org-xor org-context-in-file-links arg)
9900 (let* ((ee (org-element-at-point))
9901 (et (org-element-type ee))
9902 (ev (plist-get (cadr ee) :value))
9903 (ek (plist-get (cadr ee) :key))
9904 (eok (and (stringp ek) (string-match "name" ek))))
9906 ((org-at-heading-p) nil)
9907 ((and (eq et 'keyword) eok) ev)
9908 ((org-region-active-p)
9909 (buffer-substring (region-beginning) (region-end)))))
9910 (when (or (null txt) (string-match "\\S-" txt))
9914 (org-make-org-heading-search-string txt)
9916 desc (or (and (eq et 'keyword) eok ev)
9917 (nth 4 (ignore-errors (org-heading-components)))
9919 (if (string-match "::\\'" cpltxt)
9920 (setq cpltxt (substring cpltxt 0 -2)))
9921 (setq link cpltxt))))
9923 ((buffer-file-name (buffer-base-buffer))
9924 ;; Just link to this file here.
9925 (setq cpltxt (concat "file:"
9926 (abbreviate-file-name
9927 (buffer-file-name (buffer-base-buffer)))))
9928 ;; Add a context string.
9929 (when (org-xor org-context-in-file-links arg)
9930 (setq txt (if (org-region-active-p)
9931 (buffer-substring (region-beginning) (region-end))
9932 (buffer-substring (point-at-bol) (point-at-eol))))
9933 ;; Only use search option if there is some text.
9934 (when (string-match "\\S-" txt)
9936 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9940 ((org-called-interactively-p 'interactive)
9941 (user-error "No method for storing a link from this buffer"))
9943 (t (setq link nil)))
9945 ;; We're done setting link and desc, clean up
9946 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9947 (setq link (or link cpltxt)
9948 desc (or desc cpltxt))
9949 (cond ((equal desc "NONE") (setq desc nil))
9950 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9951 (let ((d0 (match-string 3 desc))
9952 (p0 (match-string 5 desc)))
9954 (replace-regexp-in-string
9955 org-bracket-link-regexp
9957 (if (equal (length (match-string 0 desc))
9958 (length desc)) "*" "")) desc)))))
9961 (if (not (and (or (org-called-interactively-p 'any)
9962 executing-kbd-macro) link))
9963 (or agenda-link (and link (org-make-link-string link desc)))
9964 (push (list link desc) org-stored-links)
9965 (message "Stored: %s" (or desc link))
9967 (setq link (concat "file:" (abbreviate-file-name
9968 (buffer-file-name)) "::#" custom-id))
9969 (push (list link desc) org-stored-links))
9970 (car org-stored-links))))))
9972 (defun org-store-link-props (&rest plist)
9973 "Store link properties, extract names and addresses."
9975 (when (setq x (plist-get plist :from))
9976 (setq adr (mail-extract-address-components x))
9977 (setq plist (plist-put plist :fromname (car adr)))
9978 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9979 (when (setq x (plist-get plist :to))
9980 (setq adr (mail-extract-address-components x))
9981 (setq plist (plist-put plist :toname (car adr)))
9982 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9983 (let ((from (plist-get plist :from))
9984 (to (plist-get plist :to)))
9985 (when (and from to org-from-is-user-regexp)
9987 (plist-put plist :fromto
9988 (if (string-match org-from-is-user-regexp from)
9990 (concat "from %f"))))))
9991 (setq org-store-link-plist plist))
9993 (defun org-add-link-props (&rest plist)
9994 "Add these properties to the link property list."
9997 (setq key (pop plist) value (pop plist))
9998 (setq org-store-link-plist
9999 (plist-put org-store-link-plist key value)))))
10001 (defun org-email-link-description (&optional fmt)
10002 "Return the description part of an email link.
10003 This takes information from `org-store-link-plist' and formats it
10004 according to FMT (default from `org-email-link-description-format')."
10005 (setq fmt (or fmt org-email-link-description-format))
10006 (let* ((p org-store-link-plist)
10007 (to (plist-get p :toaddress))
10008 (from (plist-get p :fromaddress))
10011 (cons "%c" (plist-get p :fromto))
10012 (cons "%F" (plist-get p :from))
10013 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
10014 (cons "%T" (plist-get p :to))
10015 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
10016 (cons "%s" (plist-get p :subject))
10017 (cons "%d" (plist-get p :date))
10018 (cons "%m" (plist-get p :message-id)))))
10019 (when (string-match "%c" fmt)
10020 ;; Check if the user wrote this message
10021 (if (and org-from-is-user-regexp from to
10022 (save-match-data (string-match org-from-is-user-regexp from)))
10023 (setq fmt (replace-match "to %t" t t fmt))
10024 (setq fmt (replace-match "from %f" t t fmt))))
10025 (org-replace-escapes fmt table)))
10027 (defun org-make-org-heading-search-string (&optional string)
10028 "Make search string for the current headline or STRING."
10029 (let ((s (or string
10030 (and (derived-mode-p 'org-mode)
10032 (org-back-to-heading t)
10033 (org-element-property :raw-value (org-element-at-point))))))
10034 (lines org-context-in-file-links))
10035 (or string (setq s (concat "*" s))) ; Add * for headlines
10036 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10037 (when (and string (integerp lines) (> lines 0))
10038 (let ((slines (org-split-string s "\n")))
10039 (when (< lines (length slines))
10042 (reverse (nthcdr (- (length slines) lines)
10043 (reverse slines))) "\n")))))
10044 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10046 (defun org-make-link-string (link &optional description)
10047 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10048 (unless (string-match "\\S-" link)
10049 (error "Empty link"))
10050 (when (and description
10051 (stringp description)
10052 (not (string-match "\\S-" description)))
10053 (setq description nil))
10054 (when (stringp description)
10055 ;; Remove brackets from the description, they are fatal.
10056 (while (string-match "\\[" description)
10057 (setq description (replace-match "{" t t description)))
10058 (while (string-match "\\]" description)
10059 (setq description (replace-match "}" t t description))))
10060 (when (equal link description)
10061 ;; No description needed, it is identical
10062 (setq description nil))
10063 (when (and (not description)
10064 (not (string-match (org-image-file-name-regexp) link))
10065 (not (equal link (org-link-escape link))))
10066 (setq description (org-extract-attributes link)))
10068 (cond ((string-match (org-image-file-name-regexp) link) link)
10069 ((string-match org-link-types-re link)
10070 (concat (match-string 1 link)
10071 (org-link-escape (substring link (match-end 1)))))
10072 (t (org-link-escape link))))
10073 (concat "[[" link "]"
10074 (if description (concat "[" description "]") "")
10077 (defconst org-link-escape-chars
10080 "List of characters that should be escaped in a link when stored to Org.
10081 This is the list that is used for internal purposes.")
10083 (defconst org-link-escape-chars-browser
10086 "List of characters to be escaped before handing over to the browser.
10087 If you consider using this constant then you probably want to use
10088 the function `org-link-escape-browser' instead. See there why
10089 this constant is a candidate to be removed once Org drops support
10090 for Emacs 24.1 and 24.2.")
10092 (defun org-link-escape (text &optional table merge)
10093 "Return percent escaped representation of TEXT.
10094 TEXT is a string with the text to escape.
10095 Optional argument TABLE is a list with characters that should be
10096 escaped. When nil, `org-link-escape-chars' is used.
10097 If optional argument MERGE is set, merge TABLE into
10098 `org-link-escape-chars'."
10099 ;; Don't escape chars in internal links
10100 (if (string-match "^\\*[[:alnum:]]+" text)
10104 (mapc (lambda (defchr)
10105 (unless (member defchr table)
10106 (setq table (cons defchr table))))
10107 org-link-escape-chars))
10109 (setq table org-link-escape-chars)))
10112 (if (or (member char table)
10113 (and (or (< char 32) (= char ?\%) (> char 126))
10115 (mapconcat (lambda (sequence-element)
10116 (format "%%%.2X" sequence-element))
10117 (or (encode-coding-char char 'utf-8)
10118 (error "Unable to percent escape character: %s"
10119 (char-to-string char))) "")
10120 (char-to-string char))) text "")))
10122 (defun org-link-escape-browser (text)
10123 "Escape some characters before handing over to the browser.
10124 This function is a candidate to be removed together with the
10125 constant `org-link-escape-chars-browser' once Org drops support
10126 for Emacs 24.1 and 24.2. All calls to this function will have to
10127 be replaced with `url-encode-url' which is available since Emacs
10129 ;; Example with the Org link
10130 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10131 ;; to open the browser with +subject:"Release 8.2" filled into the
10132 ;; query field: In this case the variable TEXT contains the
10133 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10134 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10135 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10136 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10137 (if (fboundp 'url-encode-url)
10138 (url-encode-url text)
10139 (if (org-string-match-p
10140 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10142 (org-link-escape text org-link-escape-chars-browser)
10145 (defun org-link-unescape (str)
10146 "Unhex hexified Unicode strings as returned from the JavaScript function
10147 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10148 (unless (and (null str) (string= "" str))
10149 (let ((pos 0) (case-fold-search t) unhexed)
10150 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10151 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10152 (setq str (replace-match unhexed t t str))
10153 (setq pos (+ pos (length unhexed))))))
10156 (defun org-link-unescape-compound (hex)
10157 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10158 Note: this function also decodes single byte encodings like
10159 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10161 (let* ((bytes (cdr (split-string hex "%")))
10166 (let* ((val (string-to-number (pop bytes) 16))
10170 ((>= val 252) (cons 6 252))
10171 ((>= val 248) (cons 5 248))
10172 ((>= val 240) (cons 4 240))
10173 ((>= val 224) (cons 3 224))
10174 ((>= val 192) (cons 2 192))
10177 (if (>= val 192) (setq eat (car shift-xor)))
10178 (setq val (logxor val (cdr shift-xor)))
10179 (setq sum (+ (lsh sum (car shift-xor)) val))
10180 (if (> eat 0) (setq eat (- eat 1)))
10182 ((= 0 eat) ;multi byte
10183 (setq ret (concat ret (org-char-to-string sum)))
10185 ((not bytes) ; single byte(s)
10186 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10189 (defun org-link-unescape-single-byte-sequence (hex)
10190 "Unhexify hex-encoded single byte character sequences."
10191 (mapconcat (lambda (byte)
10192 (char-to-string (string-to-number byte 16)))
10193 (cdr (split-string hex "%")) ""))
10195 (defun org-xor (a b)
10199 (defun org-fixup-message-id-for-http (s)
10200 "Replace special characters in a message id, so it can be used in an http query."
10201 (when (string-match "%" s)
10202 (setq s (mapconcat (lambda (c)
10205 (char-to-string c)))
10207 (while (string-match "<" s)
10208 (setq s (replace-match "%3C" t t s)))
10209 (while (string-match ">" s)
10210 (setq s (replace-match "%3E" t t s)))
10211 (while (string-match "@" s)
10212 (setq s (replace-match "%40" t t s)))
10215 (defun org-link-prettify (link)
10216 "Return a human-readable representation of LINK.
10217 The car of LINK must be a raw link.
10218 The cdr of LINK must be either a link description or nil."
10219 (let ((desc (or (cadr link) "<no description>")))
10220 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10221 "<" (car link) ">")))
10224 (defun org-insert-link-global ()
10225 "Insert a link like Org-mode does.
10226 This command can be called in any mode to insert a link in Org-mode syntax."
10228 (org-load-modules-maybe)
10229 (org-run-like-in-org-mode 'org-insert-link))
10231 (defun org-insert-all-links (arg &optional pre post)
10232 "Insert all links in `org-stored-links'.
10233 When a universal prefix, do not delete the links from `org-stored-links'.
10234 When `ARG' is a number, insert the last N link(s).
10235 `PRE' and `POST' are optional arguments to define a string to
10236 prepend or to append."
10238 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10239 (links (copy-seq org-stored-links))
10241 (po (or post "\n"))
10243 (if (null org-stored-links)
10244 (message "No link to insert")
10245 (while (and (or (listp arg) (>= arg cnt))
10246 (setq l (if (listp arg)
10248 (pop org-stored-links))))
10249 (setq cnt (1+ cnt))
10251 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10254 (defun org-insert-last-stored-link (arg)
10255 "Insert the last link stored in `org-stored-links'."
10257 (org-insert-all-links arg "" "\n"))
10259 (defun org-link-fontify-links-to-this-file ()
10260 "Fontify links to the current file in `org-stored-links'."
10261 (let ((f (buffer-file-name)) a b)
10262 (setq a (mapcar (lambda(l)
10263 (let ((ll (car l)))
10264 (when (and (string-match "^file:\\(.+\\)::" ll)
10265 (equal f (expand-file-name (match-string 1 ll))))
10268 (when (featurep 'org-id)
10269 (setq b (mapcar (lambda(l)
10270 (let ((ll (car l)))
10271 (when (and (string-match "^id:\\(.+\\)$" ll)
10272 (equal f (expand-file-name
10273 (or (org-id-find-id-file
10274 (match-string 1 ll)) ""))))
10276 org-stored-links)))
10278 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10279 (delq nil (append a b)))))
10281 (defvar org-link-links-in-this-file nil)
10282 (defun org-insert-link (&optional complete-file link-location default-description)
10283 "Insert a link. At the prompt, enter the link.
10285 Completion can be used to insert any of the link protocol prefixes like
10286 http or ftp in use.
10288 The history can be used to select a link previously stored with
10289 `org-store-link'. When the empty string is entered (i.e. if you just
10290 press RET at the prompt), the link defaults to the most recently
10291 stored link. As SPC triggers completion in the minibuffer, you need to
10292 use M-SPC or C-q SPC to force the insertion of a space character.
10294 You will also be prompted for a description, and if one is given, it will
10295 be displayed in the buffer instead of the link.
10297 If there is already a link at point, this command will allow you to edit link
10298 and description parts.
10300 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10301 be selected using completion. The path to the file will be relative to the
10302 current directory if the file is in the current directory or a subdirectory.
10303 Otherwise, the link will be the absolute path as completed in the minibuffer
10304 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10305 option `org-link-file-path-type'.
10307 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10308 the current directory or below.
10310 With three \\[universal-argument] prefixes, negate the meaning of
10311 `org-keep-stored-link-after-insertion'.
10313 If `org-make-link-description-function' is non-nil, this function will be
10314 called with the link target, and the result will be the default
10317 If the LINK-LOCATION parameter is non-nil, this value will be
10318 used as the link location instead of reading one interactively.
10320 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10321 be used as the default description."
10323 (let* ((wcf (current-window-configuration))
10324 (origbuf (current-buffer))
10325 (region (if (org-region-active-p)
10326 (buffer-substring (region-beginning) (region-end))))
10327 (remove (and region (list (region-beginning) (region-end))))
10329 tmphist ; byte-compile incorrectly complains about this
10330 (link link-location)
10331 (abbrevs org-link-abbrev-alist-local)
10332 entry file all-prefixes auto-desc)
10334 (link-location) ; specified by arg, just use it.
10335 ((org-in-regexp org-bracket-link-regexp 1)
10336 ;; We do have a link at point, and we are going to edit it.
10337 (setq remove (list (match-beginning 0) (match-end 0)))
10338 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10339 (setq link (read-string "Link: "
10341 (org-match-string-no-properties 1)))))
10342 ((or (org-in-regexp org-angle-link-re)
10343 (org-in-regexp org-plain-link-re))
10344 ;; Convert to bracket link
10345 (setq remove (list (match-beginning 0) (match-end 0))
10346 link (read-string "Link: "
10347 (org-remove-angle-brackets (match-string 0)))))
10348 ((member complete-file '((4) (16)))
10349 ;; Completing read for file names.
10350 (setq link (org-file-complete-link complete-file)))
10352 ;; Read link, with completion for stored links.
10353 (org-link-fontify-links-to-this-file)
10354 (org-switch-to-buffer-other-window "*Org Links*")
10355 (with-current-buffer "*Org Links*"
10357 (insert "Insert a link.
10358 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10359 (when org-stored-links
10360 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10361 (insert (mapconcat 'org-link-prettify
10362 (reverse org-stored-links) "\n")))
10363 (goto-char (point-min)))
10364 (let ((cw (selected-window)))
10365 (select-window (get-buffer-window "*Org Links*" 'visible))
10366 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10367 (unless (pos-visible-in-window-p (point-max))
10368 (org-fit-window-to-buffer))
10369 (and (window-live-p cw) (select-window cw)))
10370 ;; Fake a link history, containing the stored links.
10371 (setq tmphist (append (mapcar 'car org-stored-links)
10372 org-insert-link-history))
10373 (setq all-prefixes (append (mapcar 'car abbrevs)
10374 (mapcar 'car org-link-abbrev-alist)
10379 (org-completing-read
10382 (mapcar (lambda (x) (concat x ":"))
10384 (mapcar 'car org-stored-links))
10387 (caar org-stored-links)))
10388 (if (not (string-match "\\S-" link))
10389 (user-error "No link selected"))
10391 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10393 (if (or (member link all-prefixes)
10394 (and (equal ":" (substring link -1))
10395 (member (substring link 0 -1) all-prefixes)
10396 (setq link (substring link 0 -1))))
10397 (setq link (with-current-buffer origbuf
10398 (org-link-try-special-completion link)))))
10399 (set-window-configuration wcf)
10400 (kill-buffer "*Org Links*"))
10401 (setq entry (assoc link org-stored-links))
10402 (or entry (push link org-insert-link-history))
10403 (setq desc (or desc (nth 1 entry)))))
10405 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10406 (not org-keep-stored-link-after-insertion))
10407 (setq org-stored-links (delq (assoc link org-stored-links)
10408 org-stored-links)))
10410 (if (and (string-match org-plain-link-re link)
10411 (not (string-match org-ts-regexp link)))
10412 ;; URL-like link, normalize the use of angular brackets.
10413 (setq link (org-remove-angle-brackets link)))
10415 ;; Check if we are linking to the current file with a search
10416 ;; option If yes, simplify the link by using only the search
10418 (when (and buffer-file-name
10419 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10420 (let* ((path (match-string 1 link))
10421 (case-fold-search nil)
10422 (search (match-string 2 link)))
10424 (if (equal (file-truename buffer-file-name) (file-truename path))
10425 ;; We are linking to this same file, with a search option
10426 (setq link search)))))
10428 ;; Check if we can/should use a relative path. If yes, simplify the link
10429 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10430 (let* ((type (match-string 1 link))
10431 (path (match-string 2 link))
10433 (case-fold-search nil))
10435 ((or (eq org-link-file-path-type 'absolute)
10436 (equal complete-file '(16)))
10437 (setq path (abbreviate-file-name (expand-file-name path))))
10438 ((eq org-link-file-path-type 'noabbrev)
10439 (setq path (expand-file-name path)))
10440 ((eq org-link-file-path-type 'relative)
10441 (setq path (file-relative-name path)))
10444 (if (string-match (concat "^" (regexp-quote
10446 (file-name-as-directory
10447 default-directory))))
10448 (expand-file-name path))
10449 ;; We are linking a file with relative path name.
10450 (setq path (substring (expand-file-name path)
10452 (setq path (abbreviate-file-name (expand-file-name path)))))))
10453 (setq link (concat type path))
10454 (if (equal desc origpath)
10455 (setq desc path))))
10457 (if org-make-link-description-function
10459 (or (condition-case nil
10460 (funcall org-make-link-description-function link desc)
10461 (error (progn (message "Can't get link description from `%s'"
10462 (symbol-name org-make-link-description-function))
10464 (read-string "Description: " default-description)))
10465 (if default-description (setq desc default-description)
10466 (setq desc (or (and auto-desc desc)
10467 (read-string "Description: " desc)))))
10469 (unless (string-match "\\S-" desc) (setq desc nil))
10470 (if remove (apply 'delete-region remove))
10471 (insert (org-make-link-string link desc))))
10473 (defun org-link-try-special-completion (type)
10474 "If there is completion support for link type TYPE, offer it."
10475 (let ((fun (intern (concat "org-" type "-complete-link"))))
10476 (if (functionp fun)
10478 (read-string "Link (no completion support): " (concat type ":")))))
10480 (defun org-file-complete-link (&optional arg)
10481 "Create a file link using completion."
10483 (setq file (org-iread-file-name "File: "))
10484 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10485 (pwd1 (file-name-as-directory (abbreviate-file-name
10486 (expand-file-name ".")))))
10491 (abbreviate-file-name (expand-file-name file)))))
10492 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10493 (setq link (concat "file:" (match-string 1 file))))
10494 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10495 (expand-file-name file))
10497 "file:" (match-string 1 (expand-file-name file)))))
10498 (t (setq link (concat "file:" file)))))
10501 (defun org-iread-file-name (&rest args)
10502 "Read-file-name using `ido-mode' speedup if available.
10503 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10504 See `read-file-name' for a description of parameters."
10505 (org-without-partial-completion
10506 (if (and org-completion-use-ido
10507 (fboundp 'ido-read-file-name)
10508 (boundp 'ido-mode) ido-mode
10509 (listp (second args)))
10510 (let ((ido-enter-matching-directory nil))
10511 (apply 'ido-read-file-name args))
10512 (apply 'read-file-name args))))
10514 (defun org-completing-read (&rest args)
10515 "Completing-read with SPACE being a normal character."
10516 (let ((enable-recursive-minibuffers t)
10517 (minibuffer-local-completion-map
10518 (copy-keymap minibuffer-local-completion-map)))
10519 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10520 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10521 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10522 (apply 'org-icompleting-read args)))
10524 (defun org-completing-read-no-i (&rest args)
10525 (let (org-completion-use-ido org-completion-use-iswitchb)
10526 (apply 'org-completing-read args)))
10528 (defun org-iswitchb-completing-read (prompt choices &rest args)
10529 "Use iswitch as a completing-read replacement to choose from choices.
10530 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10532 (let* ((iswitchb-use-virtual-buffers nil)
10533 (iswitchb-make-buflist-hook
10535 (setq iswitchb-temp-buflist choices))))
10536 (iswitchb-read-buffer prompt)))
10538 (defun org-icompleting-read (&rest args)
10539 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10540 (org-without-partial-completion
10541 (if (and org-completion-use-ido
10542 (fboundp 'ido-completing-read)
10543 (boundp 'ido-mode) ido-mode
10544 (listp (second args)))
10545 (let ((ido-enter-matching-directory nil))
10546 (apply 'ido-completing-read (concat (car args))
10547 (if (consp (car (nth 1 args)))
10548 (mapcar 'car (nth 1 args))
10551 (if (and org-completion-use-iswitchb
10552 (boundp 'iswitchb-mode) iswitchb-mode
10553 (listp (second args)))
10554 (apply 'org-iswitchb-completing-read (concat (car args))
10555 (if (consp (car (nth 1 args)))
10556 (mapcar 'car (nth 1 args))
10559 (apply 'completing-read args)))))
10561 (defun org-extract-attributes (s)
10562 "Extract the attributes cookie from a string and set as text property."
10563 (let (a attr (start 0) key value)
10565 (when (string-match "{{\\([^}]+\\)}}$" s)
10566 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10567 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10568 (setq key (match-string 1 a) value (match-string 2 a)
10569 start (match-end 0)
10570 attr (plist-put attr (intern key) value))))
10571 (org-add-props s nil 'org-attr attr))
10574 ;;; Opening/following a link
10576 (defvar org-link-search-failed nil)
10578 (defvar org-open-link-functions nil
10579 "Hook for functions finding a plain text link.
10580 These functions must take a single argument, the link content.
10581 They will be called for links that look like [[link text][description]]
10582 when LINK TEXT does not have a protocol like \"http:\" and does not look
10583 like a filename (e.g. \"./blue.png\").
10585 These functions will be called *before* Org attempts to resolve the
10586 link by doing text searches in the current buffer - so if you want a
10587 link \"[[target]]\" to still find \"<<target>>\", your function should
10588 handle this as a special case.
10590 When the function does handle the link, it must return a non-nil value.
10591 If it decides that it is not responsible for this link, it must return
10592 nil to indicate that that Org-mode can continue with other options
10593 like exact and fuzzy text search.")
10595 (defun org-next-link (&optional search-backward)
10596 "Move forward to the next link.
10597 If the link is in hidden text, expose it."
10599 (when (and org-link-search-failed (eq this-command last-command))
10600 (goto-char (point-min))
10601 (message "Link search wrapped back to beginning of buffer"))
10602 (setq org-link-search-failed nil)
10603 (let* ((pos (point))
10605 (a (assoc :link ct))
10606 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10607 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10608 ((looking-at org-any-link-re)
10609 ;; Don't stay stuck at link without an org-link face
10610 (forward-char (if search-backward -1 1))))
10611 (if (funcall srch-fun org-any-link-re nil t)
10613 (goto-char (match-beginning 0))
10614 (if (outline-invisible-p) (org-show-context)))
10616 (setq org-link-search-failed t)
10617 (message "No further link found"))))
10619 (defun org-previous-link ()
10620 "Move backward to the previous link.
10621 If the link is in hidden text, expose it."
10623 (funcall 'org-next-link t))
10625 (defun org-translate-link (s)
10626 "Translate a link string if a translation function has been defined."
10627 (if (and org-link-translation-function
10628 (fboundp org-link-translation-function)
10629 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10631 (setq s (funcall org-link-translation-function
10632 (match-string 1 s) (match-string 2 s)))
10633 (concat (car s) ":" (cdr s)))
10636 (defun org-translate-link-from-planner (type path)
10637 "Translate a link from Emacs Planner syntax so that Org can follow it.
10638 This is still an experimental function, your mileage may vary."
10640 ((member type '("http" "https" "news" "ftp"))
10641 ;; standard Internet links are the same.
10643 ((and (equal type "irc") (string-match "^//" path))
10644 ;; Planner has two / at the beginning of an irc link, we have 1.
10645 ;; We should have zero, actually....
10646 (setq path (substring path 1)))
10647 ((and (equal type "lisp") (string-match "^/" path))
10648 ;; Planner has a slash, we do not.
10649 (setq type "elisp" path (substring path 1)))
10650 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10651 ;; A typical message link. Planner has the id after the final slash,
10652 ;; we separate it with a hash mark
10653 (setq path (concat (match-string 1 path) "#"
10654 (org-remove-angle-brackets (match-string 2 path))))))
10657 (defun org-find-file-at-mouse (ev)
10658 "Open file link or URL at mouse."
10660 (mouse-set-point ev)
10661 (org-open-at-point 'in-emacs))
10663 (defun org-open-at-mouse (ev)
10664 "Open file link or URL at mouse.
10665 See the docstring of `org-open-file' for details."
10667 (mouse-set-point ev)
10668 (if (eq major-mode 'org-agenda-mode)
10669 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10670 (org-open-at-point))
10672 (defvar org-window-config-before-follow-link nil
10673 "The window configuration before following a link.
10674 This is saved in case the need arises to restore it.")
10676 (defvar org-open-link-marker (make-marker)
10677 "Marker pointing to the location where `org-open-at-point' was called.")
10680 (defun org-open-at-point-global ()
10681 "Follow a link like Org-mode does.
10682 This command can be called in any mode to follow a link that has
10685 (org-run-like-in-org-mode 'org-open-at-point))
10688 (defun org-open-link-from-string (s &optional arg reference-buffer)
10689 "Open a link in the string S, as if it was in Org-mode."
10690 (interactive "sLink: \nP")
10691 (let ((reference-buffer (or reference-buffer (current-buffer))))
10693 (let ((org-inhibit-startup (not reference-buffer)))
10696 (goto-char (point-min))
10697 (when reference-buffer
10698 (setq org-link-abbrev-alist-local
10699 (with-current-buffer reference-buffer
10700 org-link-abbrev-alist-local)))
10701 (org-open-at-point arg reference-buffer)))))
10703 (defvar org-open-at-point-functions nil
10704 "Hook that is run when following a link at point.
10706 Functions in this hook must return t if they identify and follow
10707 a link at point. If they don't find anything interesting at point,
10708 they must return nil.")
10710 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10711 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10712 (defun org-open-at-point (&optional arg reference-buffer)
10713 "Open link, timestamp, footnote or tags at point.
10715 When point is on a link, follow it. Normally, files will be
10716 opened by an appropriate application. If the optional prefix
10717 argument ARG is non-nil, Emacs will visit the file. With
10718 a double prefix argument, try to open outside of Emacs, in the
10719 application the system uses for this file type.
10721 When point is on a timestamp, open the agenda at the day
10724 When point is a footnote definition, move to the first reference
10725 found. If it is on a reference, move to the associated
10728 When point is on a headline, display a list of every link in the
10729 entry, so it is possible to pick one, or all, of them. If point
10730 is on a tag, call `org-tags-view' instead.
10732 When optional argument REFERENCE-BUFFER is non-nil, it should
10733 specify a buffer from where the link search should happen. This
10734 is used internally by `org-open-link-from-string'.
10736 On top of syntactically correct links, this function will open
10737 the link at point in comments or comment blocks and the first
10738 link in a property drawer line."
10740 ;; On a code block, open block's results.
10741 (unless (call-interactively 'org-babel-open-src-block-result)
10742 (org-load-modules-maybe)
10743 (move-marker org-open-link-marker (point))
10744 (setq org-window-config-before-follow-link (current-window-configuration))
10745 (org-remove-occur-highlights nil nil t)
10746 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10747 (let* ((context (org-element-context)) type value)
10748 ;; On an unsupported type, check if point is contained within
10750 (while (and (not (memq (setq type (org-element-type context))
10751 '(comment comment-block
10752 headline inlinetask link
10753 footnote-definition footnote-reference
10754 node-property timestamp)))
10755 (setq context (org-element-property :parent context))))
10756 (setq value (org-element-property :value context))
10758 ;; Blank lines at the beginning of buffer: bail out.
10759 ((not context) (user-error "No link found"))
10760 ;; Exception n°1: links in property drawers
10761 ((eq type 'node-property)
10762 (org-open-link-from-string
10763 (and (string-match org-any-link-re value)
10764 (match-string-no-properties 0 value))))
10765 ;; Exception n°2: links in comments.
10766 ((memq type '(comment comment-block))
10768 (skip-chars-forward "\\S-" (point-at-eol))
10769 (let ((string-rear (replace-regexp-in-string
10770 "^[ \t]*# [ \t]*" ""
10771 (buffer-substring (point) (line-beginning-position))))
10772 (string-front (buffer-substring (point) (line-end-position))))
10774 (let ((org-inhibit-startup t)) (org-mode))
10776 (goto-char (point-min))
10777 (when (and (search-forward string-rear nil t)
10778 (search-forward string-front (line-end-position) t))
10779 (goto-char (match-beginning 0))
10780 (org-open-at-point)
10781 (when (string= string-rear "") (forward-char)))))))
10782 ;; On a headline or an inlinetask, but not on a timestamp,
10783 ;; a link, a footnote reference or on tags.
10784 ((and (memq type '(headline inlinetask))
10786 (progn (save-excursion (beginning-of-line)
10787 (looking-at org-complex-heading-regexp))
10788 (or (not (match-beginning 5))
10789 (< (point) (match-beginning 5)))))
10790 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10792 (links-end (cdr data)))
10794 (dolist (link (if (stringp links) (list links) links))
10795 (search-forward link nil links-end)
10796 (goto-char (match-beginning 0))
10797 (org-open-at-point))
10798 (require 'org-attach)
10799 (org-attach-reveal 'if-exists))))
10800 ;; Do nothing on white spaces after an object, unless point
10801 ;; is right after it.
10804 (goto-char (org-element-property :end context))
10805 (skip-chars-backward " \t")
10807 (user-error "No link found"))
10808 ((eq type 'timestamp) (org-follow-timestamp-link))
10809 ;; On tags within a headline or an inlinetask.
10810 ((and (memq type '(headline inlinetask))
10811 (progn (save-excursion (beginning-of-line)
10812 (looking-at org-complex-heading-regexp))
10813 (and (match-beginning 5)
10814 (>= (point) (match-beginning 5)))))
10815 (org-tags-view arg (substring (match-string 5) 0 -1)))
10817 ;; When link is located within the description of another
10818 ;; link (e.g., an inline image), always open the parent
10820 (let*((link (let ((up (org-element-property :parent context)))
10821 (if (eq (org-element-type up) 'link) up context)))
10822 (type (org-element-property :type link))
10823 (path (org-link-unescape (org-element-property :path link))))
10824 ;; Switch back to REFERENCE-BUFFER needed when called in
10825 ;; a temporary buffer through `org-open-link-from-string'.
10826 (with-current-buffer (or reference-buffer (current-buffer))
10828 ((equal type "file")
10829 (if (string-match "[*?{]" (file-name-nondirectory path))
10831 ;; Look into `org-link-protocols' in order to find
10832 ;; a DEDICATED-FUNCTION to open file. The function
10833 ;; will be applied on raw link instead of parsed
10834 ;; link due to the limitation in `org-add-link-type'
10835 ;; ("open" function called with a single argument).
10836 ;; If no such function is found, fallback to
10837 ;; `org-open-file'.
10839 ;; Note : "file+emacs" and "file+sys" types are
10840 ;; hard-coded in order to escape the previous
10842 (let* ((option (org-element-property :search-option link))
10843 (app (org-element-property :application link))
10844 (dedicated-function
10845 (nth 1 (assoc app org-link-protocols))))
10846 (if dedicated-function
10847 (funcall dedicated-function
10849 (and option (concat "::" option))))
10850 (apply 'org-open-file
10853 ((equal app "emacs") 'emacs)
10854 ((equal app "sys") 'system))
10855 (cond ((not option) nil)
10856 ((org-string-match-p "\\`[0-9]+\\'" option)
10857 (list (string-to-number option)))
10859 (org-link-unescape option)))))))))
10860 ((assoc type org-link-protocols)
10861 (funcall (nth 1 (assoc type org-link-protocols)) path))
10862 ((equal type "help")
10863 (let ((f-or-v (intern path)))
10864 (cond ((fboundp f-or-v) (describe-function f-or-v))
10865 ((boundp f-or-v) (describe-variable f-or-v))
10866 (t (error "Not a known function or variable")))))
10867 ((member type '("http" "https" "ftp" "mailto" "news"))
10868 (browse-url (org-link-escape-browser (concat type ":" path))))
10869 ((equal type "doi")
10871 (org-link-escape-browser (concat org-doi-server-url path))))
10872 ((equal type "message") (browse-url (concat type ":" path)))
10873 ((equal type "shell")
10874 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10876 (if (or (and (org-string-nw-p
10877 org-confirm-shell-link-not-regexp)
10879 org-confirm-shell-link-not-regexp cmd))
10880 (not org-confirm-shell-link-function)
10881 (funcall org-confirm-shell-link-function
10882 (format "Execute \"%s\" in shell? "
10883 (org-add-props cmd nil
10884 'face 'org-warning))))
10886 (message "Executing %s" cmd)
10887 (shell-command cmd buf)
10888 (when (featurep 'midnight)
10889 (setq clean-buffer-list-kill-buffer-names
10891 clean-buffer-list-kill-buffer-names))))
10892 (user-error "Abort"))))
10893 ((equal type "elisp")
10895 (if (or (and (org-string-nw-p
10896 org-confirm-elisp-link-not-regexp)
10897 (org-string-match-p
10898 org-confirm-elisp-link-not-regexp cmd))
10899 (not org-confirm-elisp-link-function)
10900 (funcall org-confirm-elisp-link-function
10901 (format "Execute \"%s\" as elisp? "
10902 (org-add-props cmd nil
10903 'face 'org-warning))))
10904 (message "%s => %s" cmd
10905 (if (eq (string-to-char cmd) ?\()
10907 (call-interactively (read cmd))))
10908 (user-error "Abort"))))
10911 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10912 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10913 (unless (run-hook-with-args-until-success
10914 'org-open-link-functions path)
10915 (if (not arg) (org-mark-ring-push)
10916 (switch-to-buffer-other-window
10917 (org-get-buffer-for-internal-link (current-buffer))))
10918 (let ((cmd `(org-link-search
10919 ,(if (member type '("custom-id" "coderef"))
10920 (org-element-property :raw-link link)
10922 ,(cond ((equal arg '(4)) 'occur)
10923 ((equal arg '(16)) 'org-occur))
10924 ,(org-element-property :begin link))))
10925 (condition-case nil
10926 (let ((org-link-search-inhibit-query t))
10928 (error (progn (widen) (eval cmd)))))))
10929 (t (browse-url-at-point))))))
10930 ;; On a footnote reference or at a footnote definition's label.
10931 ((or (eq type 'footnote-reference)
10932 (and (eq type 'footnote-definition)
10934 ;; Do not validate action when point is on the
10935 ;; spaces right after the footnote label, in
10936 ;; order to be on par with behaviour on links.
10937 (skip-chars-forward " \t")
10939 (org-element-property :contents-begin context)))
10940 (if begin (< (point) begin)
10941 (= (org-element-property :post-affiliated context)
10942 (line-beginning-position)))))))
10943 (org-footnote-action))
10944 (t (user-error "No link found")))))
10945 (move-marker org-open-link-marker nil)
10946 (run-hook-with-args 'org-follow-link-hook)))
10948 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10949 "Offer links in the current entry and return the selected link.
10950 If there is only one link, return it.
10951 If NTH is an integer, return the NTH link found.
10952 If ZERO is a string, check also this string for a link, and if
10953 there is one, return it."
10954 (with-current-buffer buffer
10960 (in-emacs (if (integerp nth) nil nth))
10961 have-zero end links link c)
10962 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10963 (push (match-string 0 zero) links)
10964 (setq cnt (1- cnt) have-zero t))
10966 (org-back-to-heading t)
10967 (setq end (save-excursion (outline-next-heading) (point)))
10968 (while (re-search-forward org-any-link-re end t)
10969 (push (match-string 0) links))
10970 (setq links (org-uniquify (reverse links))))
10973 (message "No links"))
10974 ((equal (length links) 1)
10975 (setq link (car links)))
10976 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10977 (setq link (nth (if have-zero nth (1- nth)) links)))
10978 (t ; we have to select a link
10980 (save-window-excursion
10981 (delete-other-windows)
10982 (with-output-to-temp-buffer "*Select Link*"
10984 (if (not (string-match org-bracket-link-regexp l))
10985 (princ (format "[%c] %s\n" (incf cnt)
10986 (org-remove-angle-brackets l)))
10988 (princ (format "[%c] %s (%s)\n" (incf cnt)
10989 (match-string 3 l) (match-string 1 l)))
10990 (princ (format "[%c] %s\n" (incf cnt)
10991 (match-string 1 l))))))
10993 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10994 (message "Select link to open, RET to open all:")
10995 (setq c (read-char-exclusive))
10996 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10997 (when (equal c ?q) (user-error "Abort"))
10998 (if (equal c ?\C-m)
11000 (setq nth (- c ?0))
11001 (if have-zero (setq nth (1+ nth)))
11002 (unless (and (integerp nth) (>= (length links) nth))
11003 (user-error "Invalid link selection"))
11004 (setq link (nth (1- nth) links)))))
11005 (cons link end))))))
11007 ;; TODO: These functions are deprecated since `org-open-at-point'
11008 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
11009 (defun org-open-file-with-system (path)
11010 "Open file at PATH using the system way of opening it."
11011 (org-open-file path 'system))
11012 (defun org-open-file-with-emacs (path)
11013 "Open file at PATH in Emacs."
11014 (org-open-file path 'emacs))
11019 (defvar org-create-file-search-functions nil
11020 "List of functions to construct the right search string for a file link.
11021 These functions are called in turn with point at the location to
11022 which the link should point.
11024 A function in the hook should first test if it would like to
11025 handle this file type, for example by checking the `major-mode'
11026 or the file extension. If it decides not to handle this file, it
11027 should just return nil to give other functions a chance. If it
11028 does handle the file, it must return the search string to be used
11029 when following the link. The search string will be part of the
11030 file link, given after a double colon, and `org-open-at-point'
11031 will automatically search for it. If special measures must be
11032 taken to make the search successful, another function should be
11033 added to the companion hook `org-execute-file-search-functions',
11036 A function in this hook may also use `setq' to set the variable
11037 `description' to provide a suggestion for the descriptive text to
11038 be used for this link when it gets inserted into an Org-mode
11039 buffer with \\[org-insert-link].")
11041 (defvar org-execute-file-search-functions nil
11042 "List of functions to execute a file search triggered by a link.
11044 Functions added to this hook must accept a single argument, the
11045 search string that was part of the file link, the part after the
11046 double colon. The function must first check if it would like to
11047 handle this search, for example by checking the `major-mode' or
11048 the file extension. If it decides not to handle this search, it
11049 should just return nil to give other functions a chance. If it
11050 does handle the search, it must return a non-nil value to keep
11051 other functions from trying.
11053 Each function can access the current prefix argument through the
11054 variable `current-prefix-arg'. Note that a single prefix is used
11055 to force opening a link in Emacs, so it may be good to only use a
11056 numeric or double prefix to guide the search function.
11058 In case this is needed, a function in this hook can also restore
11059 the window configuration before `org-open-at-point' was called using:
11061 (set-window-configuration org-window-config-before-follow-link)")
11063 (defun org-link-search (s &optional type avoid-pos stealth)
11064 "Search for a link search option.
11065 If S is surrounded by forward slashes, it is interpreted as a
11066 regular expression. In org-mode files, this will create an `org-occur'
11067 sparse tree. In ordinary files, `occur' will be used to list matches.
11068 If the current buffer is in `dired-mode', grep will be used to search
11069 in all files. If AVOID-POS is given, ignore matches near that position.
11071 When optional argument STEALTH is non-nil, do not modify
11072 visibility around point, thus ignoring
11073 `org-show-hierarchy-above', `org-show-following-heading' and
11074 `org-show-siblings' variables."
11075 (let ((case-fold-search t)
11076 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
11077 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
11078 (append '(("") (" ") ("\t") ("\n"))
11079 org-emphasis-alist)
11082 (pre nil) (post nil)
11083 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
11085 ;; First check if there are any special search functions
11086 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11087 ;; Now try the builtin stuff
11088 ((and (equal (string-to-char s0) ?#)
11091 (goto-char (point-min))
11094 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
11095 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
11096 (setq type 'dedicated
11097 pos (match-beginning 0))))
11098 ;; There is an exact target for this
11100 (org-back-to-heading t)))
11102 (goto-char (point-min))
11105 (concat "<<" (regexp-quote s0) ">>") nil t)
11106 (setq type 'dedicated
11107 pos (match-beginning 0))))
11108 ;; There is an exact target for this
11111 (goto-char (point-min))
11114 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11115 (setq type 'dedicated pos (match-beginning 0))))
11116 ;; Found an element with a matching #+name affiliated keyword.
11118 ((and (string-match "^(\\(.*\\))$" s0)
11120 (goto-char (point-min))
11123 (concat "[^[]" (regexp-quote
11124 (format org-coderef-label-format
11125 (match-string 1 s0))))
11127 (setq type 'dedicated
11128 pos (1+ (match-beginning 0))))))
11129 ;; There is a coderef target for this
11131 ((string-match "^/\\(.*\\)/$" s)
11132 ;; A regular expression
11134 ((derived-mode-p 'org-mode)
11135 (org-occur (match-string 1 s)))
11136 (t (org-do-occur (match-string 1 s)))))
11137 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
11138 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11139 (goto-char (point-min))
11141 ((let (case-fold-search)
11142 (re-search-forward (format org-complex-heading-regexp-format
11145 ;; OK, found a match
11146 (setq type 'dedicated)
11147 (goto-char (match-beginning 0)))
11148 ((and (not org-link-search-inhibit-query)
11149 (eq org-link-search-must-match-exact-headline 'query-to-create)
11150 (y-or-n-p "No match - create this as a new heading? "))
11151 (goto-char (point-max))
11152 (or (bolp) (newline))
11153 (insert "* " s "\n")
11154 (beginning-of-line 0))
11157 (error "No match"))))
11159 ;; A normal search string
11160 (when (equal (string-to-char s) ?*)
11161 ;; Anchor on headlines, post may include tags.
11162 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
11163 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
11164 s (substring s 1)))
11165 (remove-text-properties
11167 '(face nil mouse-face nil keymap nil fontified nil) s)
11168 ;; Make a series of regular expressions to find a match
11169 (setq words (org-split-string s "[ \n\r\t]+")
11171 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11172 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11174 re2a_ (concat "\\(" (mapconcat 'downcase words
11175 "[ \t\r\n]+") "\\)[ \t\r\n]")
11176 re2a (concat "[ \t\r\n]" re2a_)
11177 re4_ (concat "\\(" (mapconcat 'downcase words
11178 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11179 re4 (concat "[^a-zA-Z_]" re4_)
11181 re1 (concat pre re2 post)
11182 re3 (concat pre (if pre re4_ re4) post)
11183 re5 (concat pre ".*" re4)
11184 re2 (concat pre re2)
11185 re2a (concat pre (if pre re2a_ re2a))
11186 re4 (concat pre (if pre re4_ re4))
11187 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
11188 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
11191 ((eq type 'org-occur) (org-occur reall))
11192 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11193 (t (goto-char (point-min))
11195 (if (or (and (org-search-not-self 1 re0 nil t)
11196 (setq type 'dedicated))
11197 (org-search-not-self 1 re1 nil t)
11198 (org-search-not-self 1 re2 nil t)
11199 (org-search-not-self 1 re2a nil t)
11200 (org-search-not-self 1 re3 nil t)
11201 (org-search-not-self 1 re4 nil t)
11202 (org-search-not-self 1 re5 nil t))
11203 (goto-char (match-beginning 1))
11205 (error "No match"))))))
11206 (and (derived-mode-p 'org-mode)
11208 (org-show-context 'link-search))
11211 (defun org-search-not-self (group &rest args)
11212 "Execute `re-search-forward', but only accept matches that do not
11213 enclose the position of `org-open-link-marker'."
11214 (let ((m org-open-link-marker))
11216 (while (apply 're-search-forward args)
11217 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11218 (goto-char (match-end group))
11219 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11220 (> (match-beginning 0) (marker-position m))
11221 (< (match-end 0) (marker-position m)))
11223 (or (not (org-in-regexp
11224 org-bracket-link-analytic-regexp 1))
11225 (not (match-end 4)) ; no description
11226 (and (<= (match-beginning 4) (point))
11227 (>= (match-end 4) (point))))))
11228 (throw 'exit (point))))))))
11230 (defun org-get-buffer-for-internal-link (buffer)
11231 "Return a buffer to be used for displaying the link target of internal links."
11233 ((not org-display-internal-link-with-indirect-buffer)
11235 ((string-match "(Clone)$" (buffer-name buffer))
11236 (message "Buffer is already a clone, not making another one")
11237 ;; we also do not modify visibility in this case
11239 (t ; make a new indirect buffer for displaying the link
11240 (let* ((bn (buffer-name buffer))
11241 (ibn (concat bn "(Clone)"))
11242 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11243 (with-current-buffer ib (org-overview))
11246 (defun org-do-occur (regexp &optional cleanup)
11247 "Call the Emacs command `occur'.
11248 If CLEANUP is non-nil, remove the printout of the regular expression
11249 in the *Occur* buffer. This is useful if the regex is long and not useful
11253 (let ((cwin (selected-window)) win beg end)
11254 (when (setq win (get-buffer-window "*Occur*"))
11255 (select-window win))
11256 (goto-char (point-min))
11257 (when (re-search-forward "match[a-z]+" nil t)
11258 (setq beg (match-end 0))
11259 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11260 (setq end (1- (match-beginning 0)))))
11261 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11262 (goto-char (point-min))
11263 (select-window cwin))))
11265 ;;; The mark ring for links jumps
11267 (defvar org-mark-ring nil
11268 "Mark ring for positions before jumps in Org-mode.")
11269 (defvar org-mark-ring-last-goto nil
11270 "Last position in the mark ring used to go back.")
11271 ;; Fill and close the ring
11272 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11273 (loop for i from 1 to org-mark-ring-length do
11274 (push (make-marker) org-mark-ring))
11275 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11278 (defun org-mark-ring-push (&optional pos buffer)
11279 "Put the current position or POS into the mark ring and rotate it."
11281 (setq pos (or pos (point)))
11282 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11283 (move-marker (car org-mark-ring)
11285 (or buffer (current-buffer)))
11287 (substitute-command-keys
11288 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11290 (defun org-mark-ring-goto (&optional n)
11291 "Jump to the previous position in the mark ring.
11292 With prefix arg N, jump back that many stored positions. When
11293 called several times in succession, walk through the entire ring.
11294 Org-mode commands jumping to a different position in the current file,
11295 or to another Org-mode file, automatically push the old position
11299 (if (eq last-command this-command)
11300 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11301 (setq p org-mark-ring))
11302 (setq org-mark-ring-last-goto p)
11304 (org-pop-to-buffer-same-window (marker-buffer m))
11306 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11308 (defun org-remove-angle-brackets (s)
11309 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11310 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11312 (defun org-add-angle-brackets (s)
11313 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11314 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11316 (defun org-remove-double-quotes (s)
11317 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11318 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11321 ;;; Following specific links
11323 (defun org-follow-timestamp-link ()
11324 "Open an agenda view for the time-stamp date/range at point."
11326 ((org-at-date-range-p t)
11327 (let ((org-agenda-start-on-weekday)
11328 (t1 (match-string 1))
11329 (t2 (match-string 2)) tt1 tt2)
11330 (setq tt1 (time-to-days (org-time-string-to-time t1))
11331 tt2 (time-to-days (org-time-string-to-time t2)))
11332 (let ((org-agenda-buffer-tmp-name
11333 (format "*Org Agenda(a:%s)"
11334 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11335 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11336 ((org-at-timestamp-p t)
11337 (let ((org-agenda-buffer-tmp-name
11338 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11339 (org-agenda-list nil (time-to-days (org-time-string-to-time
11340 (substring (match-string 1) 0 10)))
11342 (t (error "This should not happen"))))
11345 ;;; Following file links
11346 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11347 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11348 (declare-function mailcap-mime-info
11349 "mailcap" (string &optional request no-decode))
11350 (defvar org-wait nil)
11351 (defun org-open-file (path &optional in-emacs line search)
11352 "Open the file at PATH.
11353 First, this expands any special file name abbreviations. Then the
11354 configuration variable `org-file-apps' is checked if it contains an
11355 entry for this file type, and if yes, the corresponding command is launched.
11357 If no application is found, Emacs simply visits the file.
11359 With optional prefix argument IN-EMACS, Emacs will visit the file.
11360 With a double \\[universal-argument] \\[universal-argument] \
11361 prefix arg, Org tries to avoid opening in Emacs
11362 and to use an external application to visit the file.
11364 Optional LINE specifies a line to go to, optional SEARCH a string
11365 to search for. If LINE or SEARCH is given, the file will be
11366 opened in Emacs, unless an entry from org-file-apps that makes
11367 use of groups in a regexp matches.
11369 If you want to change the way frames are used when following a
11370 link, please customize `org-link-frame-setup'.
11372 If the file does not exist, an error is thrown."
11373 (let* ((file (if (equal path "")
11375 (substitute-in-file-name (expand-file-name path))))
11376 (file-apps (append org-file-apps (org-default-apps)))
11377 (apps (org-remove-if
11378 'org-file-apps-entry-match-against-dlink-p file-apps))
11379 (apps-dlink (org-remove-if-not
11380 'org-file-apps-entry-match-against-dlink-p file-apps))
11381 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11382 (dirp (if remp nil (file-directory-p file)))
11383 (file (if (and dirp org-open-directory-means-index-dot-org)
11384 (concat (file-name-as-directory file) "index.org")
11386 (a-m-a-p (assq 'auto-mode apps))
11387 (dfile (downcase file))
11388 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11389 (link (cond ((and (eq line nil)
11393 (concat file "::" (number-to-string line)))
11395 (concat file "::" search))))
11396 (dlink (downcase link))
11397 (old-buffer (current-buffer))
11399 (old-mode major-mode)
11400 ext cmd link-match-data)
11401 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11402 (setq ext (match-string 1 dfile))
11403 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11404 (setq ext (match-string 1 dfile))))
11406 ((member in-emacs '((16) system))
11407 (setq cmd (cdr (assoc 'system apps))))
11408 (in-emacs (setq cmd 'emacs))
11410 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11411 (and dirp (cdr (assoc 'directory apps)))
11412 ; first, try matching against apps-dlink
11413 ; if we get a match here, store the match data for later
11414 (let ((match (assoc-default dlink apps-dlink
11417 (progn (setq link-match-data (match-data))
11419 (progn (setq in-emacs (or in-emacs line search))
11420 nil))) ; if we have no match in apps-dlink,
11421 ; always open the file in emacs if line or search
11422 ; is given (for backwards compatibility)
11423 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11425 (cdr (assoc ext apps))
11426 (cdr (assoc t apps))))))
11427 (when (eq cmd 'system)
11428 (setq cmd (cdr (assoc 'system apps))))
11429 (when (eq cmd 'default)
11430 (setq cmd (cdr (assoc t apps))))
11431 (when (eq cmd 'mailcap)
11433 (mailcap-parse-mailcaps)
11434 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11435 (command (mailcap-mime-info mime-type)))
11436 (if (stringp command)
11438 (setq cmd 'emacs))))
11439 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11440 (not (file-exists-p file))
11441 (not org-open-non-existing-files))
11442 (user-error "No such file: %s" file))
11444 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11445 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11446 (while (string-match "['\"]%s['\"]" cmd)
11447 (setq cmd (replace-match "%s" t t cmd)))
11448 (while (string-match "%s" cmd)
11449 (setq cmd (replace-match
11451 (shell-quote-argument
11452 (convert-standard-filename file)))
11455 ;; Replace "%1", "%2" etc. in command with group matches from regex
11457 (let ((match-index 1)
11458 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11459 (set-match-data link-match-data)
11460 (while (<= match-index number-of-groups)
11461 (let ((regex (concat "%" (number-to-string match-index)))
11462 (replace-with (match-string match-index dlink)))
11463 (while (string-match regex cmd)
11464 (setq cmd (replace-match replace-with t t cmd))))
11465 (setq match-index (+ match-index 1)))))
11467 (save-window-excursion
11468 (message "Running %s...done" cmd)
11469 (start-process-shell-command cmd nil cmd)
11470 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11473 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11475 (if line (progn (org-goto-line line)
11476 (if (derived-mode-p 'org-mode)
11478 (if search (org-link-search search))))
11480 (let ((file (convert-standard-filename file)))
11482 (set-match-data link-match-data)
11484 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11485 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11486 (or (not (equal old-buffer (current-buffer)))
11487 (not (equal old-pos (point))))
11488 (org-mark-ring-push old-pos old-buffer))))
11490 (defun org-file-apps-entry-match-against-dlink-p (entry)
11491 "This function returns non-nil if `entry' uses a regular
11492 expression which should be matched against the whole link by
11495 It assumes that is the case when the entry uses a regular
11496 expression which has at least one grouping construct and the
11497 action is either a lisp form or a command string containing
11498 '%1', i.e. using at least one subexpression match as a
11500 (let ((selector (car entry))
11501 (action (cdr entry)))
11502 (if (stringp selector)
11503 (and (> (regexp-opt-depth selector) 0)
11504 (or (and (stringp action)
11505 (string-match "%[0-9]" action))
11509 (defun org-default-apps ()
11510 "Return the default applications for this operating system."
11512 ((eq system-type 'darwin)
11513 org-file-apps-defaults-macosx)
11514 ((eq system-type 'windows-nt)
11515 org-file-apps-defaults-windowsnt)
11516 (t org-file-apps-defaults-gnu)))
11518 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11519 "Convert extensions to regular expressions in the cars of LIST.
11520 Also, weed out any non-string entries, because the return value is used
11521 only for regexp matching.
11522 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11523 point to the symbol `emacs', indicating that the file should
11524 be opened in Emacs."
11527 (mapcar (lambda (x)
11528 (if (not (stringp (car x)))
11530 (if (string-match "\\W" (car x))
11532 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11535 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11537 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11538 (defun org-file-remote-p (file)
11539 "Test whether FILE specifies a location on a remote system.
11540 Return non-nil if the location is indeed remote.
11542 For example, the filename \"/user@host:/foo\" specifies a location
11543 on the system \"/user@host:\"."
11544 (cond ((fboundp 'file-remote-p)
11545 (file-remote-p file))
11546 ((fboundp 'tramp-handle-file-remote-p)
11547 (tramp-handle-file-remote-p file))
11548 ((and (boundp 'ange-ftp-name-format)
11549 (string-match (car ange-ftp-name-format) file))
11555 (defun org-get-org-file ()
11556 "Read a filename, with default directory `org-directory'."
11557 (let ((default (or org-default-notes-file remember-data-file)))
11558 (read-file-name (format "File name [%s]: " default)
11559 (file-name-as-directory org-directory)
11562 (defun org-notes-order-reversed-p ()
11563 "Check if the current file should receive notes in reversed order."
11565 ((not org-reverse-note-order) nil)
11566 ((eq t org-reverse-note-order) t)
11567 ((not (listp org-reverse-note-order)) nil)
11569 (let ((all org-reverse-note-order)
11571 (while (setq entry (pop all))
11572 (if (string-match (car entry) buffer-file-name)
11573 (throw 'exit (cdr entry))))
11576 (defvar org-refile-target-table nil
11577 "The list of refile targets, created by `org-refile'.")
11579 (defvar org-agenda-new-buffers nil
11580 "Buffers created to visit agenda files.")
11582 (defvar org-refile-cache nil
11583 "Cache for refile targets.")
11585 (defvar org-refile-markers nil
11586 "All the markers used for caching refile locations.")
11588 (defun org-refile-marker (pos)
11589 "Get a new refile marker, but only if caching is in use."
11590 (if (not org-refile-use-cache)
11592 (let ((m (make-marker)))
11593 (move-marker m pos)
11594 (push m org-refile-markers)
11597 (defun org-refile-cache-clear ()
11598 "Clear the refile cache and disable all the markers."
11599 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11600 (setq org-refile-markers nil)
11601 (setq org-refile-cache nil)
11602 (message "Refile cache has been cleared"))
11604 (defun org-refile-cache-check-set (set)
11605 "Check if all the markers in the cache still have live buffers."
11608 (while (and set (setq marker (nth 3 (pop set))))
11609 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11610 (when (and marker (null (marker-buffer marker)))
11611 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11613 (throw 'exit nil)))
11616 (defun org-refile-cache-put (set &rest identifiers)
11617 "Push the refile targets SET into the cache, under IDENTIFIERS."
11618 (let* ((key (sha1 (prin1-to-string identifiers)))
11619 (entry (assoc key org-refile-cache)))
11622 (push (cons key set) org-refile-cache))))
11624 (defun org-refile-cache-get (&rest identifiers)
11625 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11627 ((not org-refile-cache) nil)
11628 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11630 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11631 org-refile-cache))))
11632 (and set (org-refile-cache-check-set set) set)))))
11634 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11635 "Produce a table with refile targets."
11636 (let ((case-fold-search nil)
11637 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11638 (entries (or org-refile-targets '((nil . (:level . 1)))))
11639 targets tgs txt re files f desc descre fast-path-p level pos0)
11640 (message "Getting targets...")
11641 (with-current-buffer (or default-buffer (current-buffer))
11642 (while (setq entry (pop entries))
11643 (setq files (car entry) desc (cdr entry))
11644 (setq fast-path-p nil)
11646 ((null files) (setq files (list (current-buffer))))
11647 ((eq files 'org-agenda-files)
11648 (setq files (org-agenda-files 'unrestricted)))
11649 ((and (symbolp files) (fboundp files))
11650 (setq files (funcall files)))
11651 ((and (symbolp files) (boundp files))
11652 (setq files (symbol-value files))))
11653 (if (stringp files) (setq files (list files)))
11655 ((eq (car desc) :tag)
11656 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11657 ((eq (car desc) :todo)
11658 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11659 ((eq (car desc) :regexp)
11660 (setq descre (cdr desc)))
11661 ((eq (car desc) :level)
11662 (setq descre (concat "^\\*\\{" (number-to-string
11663 (if org-odd-levels-only
11664 (1- (* 2 (cdr desc)))
11667 ((eq (car desc) :maxlevel)
11668 (setq fast-path-p t)
11669 (setq descre (concat "^\\*\\{1," (number-to-string
11670 (if org-odd-levels-only
11671 (1- (* 2 (cdr desc)))
11674 (t (error "Bad refiling target description %s" desc)))
11675 (while (setq f (pop files))
11676 (with-current-buffer
11677 (if (bufferp f) f (org-get-agenda-file-buffer f))
11679 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11681 (if (bufferp f) (setq f (buffer-file-name
11682 (buffer-base-buffer f))))
11683 (setq f (and f (expand-file-name f)))
11684 (if (eq org-refile-use-outline-path 'file)
11685 (push (list (file-name-nondirectory f) f nil nil) tgs))
11689 (goto-char (point-min))
11690 (while (re-search-forward descre nil t)
11691 (goto-char (setq pos0 (point-at-bol)))
11693 (when org-refile-target-verify-function
11695 (or (funcall org-refile-target-verify-function)
11697 (when (and (looking-at org-complex-heading-regexp)
11698 (not (member (match-string 4) excluded-entries))
11700 (setq level (org-reduced-level
11701 (- (match-end 1) (match-beginning 1)))
11702 txt (org-link-display-format (match-string 4))
11703 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11704 re (format org-complex-heading-regexp-format
11705 (regexp-quote (match-string 4))))
11706 (when org-refile-use-outline-path
11707 (setq txt (mapconcat
11710 (if (eq org-refile-use-outline-path
11712 (list (file-name-nondirectory
11714 (buffer-base-buffer))))
11715 (if (eq org-refile-use-outline-path
11717 (list (buffer-file-name
11718 (buffer-base-buffer)))))
11719 (org-get-outline-path fast-path-p
11723 (push (list txt f re (org-refile-marker (point)))
11725 (when (= (point) pos0)
11726 ;; verification function has not moved point
11727 (goto-char (point-at-eol))))))))
11728 (when org-refile-use-cache
11729 (org-refile-cache-put tgs (buffer-file-name) descre))
11730 (setq targets (append tgs targets))))))
11731 (message "Getting targets...done")
11732 (nreverse targets)))
11734 (defun org-protect-slash (s)
11735 (while (string-match "/" s)
11736 (setq s (replace-match "\\" t t s)))
11739 (defvar org-olpa (make-vector 20 nil))
11741 (defun org-get-outline-path (&optional fastp level heading)
11742 "Return the outline path to the current entry, as a list.
11744 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11745 routine which makes outline path derivations for an entire file,
11746 avoiding backtracing. Refile target collection makes use of that."
11750 (error "Outline path failure, more than 19 levels"))
11751 (loop for i from level upto 19 do
11752 (aset org-olpa i nil))
11754 (delq nil (append org-olpa nil))
11755 (aset org-olpa level heading)))
11756 (let (rtn case-fold-search)
11760 (while (org-up-heading-safe)
11761 (when (looking-at org-complex-heading-regexp)
11763 (replace-regexp-in-string
11764 ;; Remove statistical/checkboxes cookies
11765 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11766 (org-match-string-no-properties 4)))
11770 (defun org-format-outline-path (path &optional width prefix separator)
11771 "Format the outline path PATH for display.
11772 WIDTH is the maximum number of characters that is available.
11773 PREFIX is a prefix to be included in the returned string,
11774 such as the file name.
11775 SEPARATOR is inserted between the different parts of the path,
11776 the default is \"/\"."
11777 (setq width (or width 79))
11778 (if prefix (setq width (- width (length prefix))))
11781 (let* ((nsteps (length path))
11782 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11783 (maxwidth (if (<= total-width width)
11784 10000 ;; everything fits
11785 ;; we need to shorten the level headings
11786 (/ (- width nsteps) nsteps)))
11787 (org-odd-levels-only nil)
11789 (total (1+ (length prefix))))
11790 (setq maxwidth (max maxwidth 10))
11792 (if prefix (or separator "/"))
11796 (if (and (= n nsteps) (< maxwidth 10000))
11797 (setq maxwidth (- total-width total)))
11798 (if (< (length h) maxwidth)
11799 (progn (setq total (+ total (length h) 1)) h)
11800 (setq h (substring h 0 (- maxwidth 2))
11801 total (+ total maxwidth 1))
11802 (if (string-match "[ \t]+\\'" h)
11803 (setq h (substring h 0 (match-beginning 0))))
11804 (setq h (concat h "..")))
11805 (org-add-props h nil 'face
11806 (nth (% (1- n) org-n-level-faces)
11809 path (or separator "/"))))))
11811 (defun org-display-outline-path (&optional file current separator just-return-string)
11812 "Display the current outline path in the echo area.
11814 If FILE is non-nil, prepend the output with the file name.
11815 If CURRENT is non-nil, append the current heading to the output.
11816 SEPARATOR is passed through to `org-format-outline-path'. It separates
11817 the different parts of the path and defaults to \"/\".
11818 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11820 (let* (case-fold-search
11821 (bfn (buffer-file-name (buffer-base-buffer)))
11822 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11824 (if current (setq path (append path
11826 (org-back-to-heading t)
11827 (if (looking-at org-complex-heading-regexp)
11828 (list (match-string 4)))))))
11830 (org-format-outline-path
11833 (and file bfn (concat (file-name-nondirectory bfn) separator))
11835 (if just-return-string
11836 (org-no-properties res)
11837 (org-unlogged-message "%s" res))))
11839 (defvar org-refile-history nil
11840 "History for refiling operations.")
11842 (defvar org-after-refile-insert-hook nil
11843 "Hook run after `org-refile' has inserted its stuff at the new location.
11844 Note that this is still *before* the stuff will be removed from
11845 the *old* location.")
11847 (defvar org-capture-last-stored-marker)
11848 (defvar org-refile-keep nil
11849 "Non-nil means `org-refile' will copy instead of refile.")
11852 "Like `org-refile', but copy."
11854 (let ((org-refile-keep t))
11855 (funcall 'org-refile nil nil nil "Copy")))
11857 (defun org-refile (&optional arg default-buffer rfloc msg)
11858 "Move the entry or entries at point to another heading.
11859 The list of target headings is compiled using the information in
11860 `org-refile-targets', which see.
11862 At the target location, the entry is filed as a subitem of the
11863 target heading. Depending on `org-reverse-note-order', the new
11864 subitem will either be the first or the last subitem.
11866 If there is an active region, all entries in that region will be
11867 refiled. However, the region must fulfill the requirement that
11868 the first heading sets the top-level of the moved text.
11870 With prefix arg ARG, the command will only visit the target
11871 location and not actually move anything.
11873 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11874 refiling operation has put the subtree.
11876 With a numeric prefix argument of `2', refile to the running clock.
11878 With a numeric prefix argument of `3', emulate `org-refile-keep'
11879 being set to `t' and copy to the target location, don't move it.
11880 Beware that keeping refiled entries may result in duplicated ID
11883 RFLOC can be a refile location obtained in a different way.
11885 MSG is a string to replace \"Refile\" in the default prompt with
11886 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11888 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11890 If you are using target caching (see `org-refile-use-cache'), you
11891 have to clear the target cache in order to find new targets.
11892 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11893 prefix argument (`C-u C-u C-u C-c C-w')."
11895 (if (member arg '(0 (64)))
11896 (org-refile-cache-clear)
11897 (let* ((actionmsg (cond (msg msg)
11898 ((equal arg 3) "Refile (and keep)")
11900 (cbuf (current-buffer))
11901 (regionp (org-region-active-p))
11902 (region-start (and regionp (region-beginning)))
11903 (region-end (and regionp (region-end)))
11904 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11905 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11906 pos it nbuf file re level reversed)
11907 (setq last-command nil)
11909 (goto-char region-start)
11910 (or (bolp) (goto-char (point-at-bol)))
11911 (setq region-start (point))
11912 (unless (or (org-kill-is-subtree-p
11913 (buffer-substring region-start region-end))
11914 (prog1 org-refile-active-region-within-subtree
11915 (let ((s (point-at-eol)))
11916 (org-toggle-heading)
11917 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11918 (user-error "The region is not a (sequence of) subtree(s)")))
11919 (if (equal arg '(16))
11920 (org-refile-goto-last-stored)
11923 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11925 (setq it (list (or org-clock-heading "running clock")
11927 (marker-buffer org-clock-hd-marker))
11929 (marker-position org-clock-hd-marker)))
11932 (let (heading-text)
11934 (unless (and arg (listp arg))
11935 (org-back-to-heading t)
11937 (replace-regexp-in-string
11938 org-bracket-link-regexp
11940 (nth 4 (org-heading-components)))))
11941 (org-refile-get-location
11942 (cond ((and arg (listp arg)) "Goto")
11943 (regionp (concat actionmsg " region to"))
11944 (t (concat actionmsg " subtree \""
11945 heading-text "\" to")))
11947 (and (not (equal '(4) arg))
11948 org-refile-allow-creating-parent-nodes)
11950 (setq file (nth 1 it)
11955 (equal (buffer-file-name) file)
11957 (and (>= pos region-start)
11958 (<= pos region-end))
11959 (and (>= pos (point))
11960 (< pos (save-excursion
11961 (org-end-of-subtree t t))))))
11962 (error "Cannot refile to position inside the tree or region"))
11963 (setq nbuf (or (find-buffer-visiting file)
11964 (find-file-noselect file)))
11965 (if (and arg (not (equal arg 3)))
11967 (org-pop-to-buffer-same-window nbuf)
11969 (org-show-context 'org-goto))
11972 (org-kill-new (buffer-substring region-start region-end))
11973 (org-save-markers-in-region region-start region-end))
11974 (org-copy-subtree 1 nil t))
11975 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11976 (find-file-noselect file)))
11977 (setq reversed (org-notes-order-reversed-p))
11984 (looking-at org-outline-regexp)
11985 (setq level (org-get-valid-level (funcall outline-level) 1))
11988 (or (outline-next-heading) (point-max))
11989 (or (save-excursion (org-get-next-sibling))
11990 (org-end-of-subtree t t)
11994 (goto-char (point-max))
11995 (goto-char (point-min))
11996 (or (outline-next-heading) (goto-char (point-max)))))
11997 (if (not (bolp)) (newline))
11998 (org-paste-subtree level nil nil t)
11999 (when org-log-refile
12000 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
12001 (unless (eq org-log-refile 'note)
12002 (save-excursion (org-add-log-note))))
12003 (and org-auto-align-tags
12004 (let ((org-loop-over-headlines-in-active-region nil))
12005 (org-set-tags nil t)))
12006 (let ((bookmark-name (plist-get org-bookmark-names-plist
12008 (when bookmark-name
12009 (with-demoted-errors
12010 (bookmark-set bookmark-name))))
12011 ;; If we are refiling for capture, make sure that the
12012 ;; last-capture pointers point here
12013 (when (org-bound-and-true-p org-refile-for-capture)
12014 (let ((bookmark-name (plist-get org-bookmark-names-plist
12015 :last-capture-marker)))
12016 (when bookmark-name
12017 (with-demoted-errors
12018 (bookmark-set bookmark-name))))
12019 (move-marker org-capture-last-stored-marker (point)))
12020 (if (fboundp 'deactivate-mark) (deactivate-mark))
12021 (run-hooks 'org-after-refile-insert-hook))))
12022 (unless org-refile-keep
12024 (delete-region (point) (+ (point) (- region-end region-start)))
12026 (and (org-back-to-heading t) (point))
12027 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
12028 (when (featurep 'org-inlinetask)
12029 (org-inlinetask-remove-END-maybe))
12030 (setq org-markers-to-move nil)
12031 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
12033 (defun org-refile-goto-last-stored ()
12034 "Go to the location where the last refile was stored."
12036 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
12037 (message "This is the location of the last refile"))
12039 (defun org-refile--get-location (refloc tbl)
12040 "When user refile to REFLOC, find the associated target in TBL.
12041 Also check `org-refile-target-table'."
12045 (lambda (r) (or (assoc r tbl)
12046 (assoc r org-refile-target-table)))
12047 (list (replace-regexp-in-string "/$" "" refloc)
12048 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12050 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
12052 "Prompt the user for a refile location, using PROMPT.
12053 PROMPT should not be suffixed with a colon and a space, because
12054 this function appends the default value from
12055 `org-refile-history' automatically, if that is not empty.
12056 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12057 this is used for the GOTO interface."
12058 (let ((org-refile-targets org-refile-targets)
12059 (org-refile-use-outline-path org-refile-use-outline-path)
12061 (when (and (derived-mode-p 'org-mode)
12062 (not org-refile-use-cache)
12066 (setq excluded-entries
12067 (append excluded-entries (list (org-get-heading t t)))))))
12068 (setq org-refile-target-table
12069 (org-refile-get-targets default-buffer excluded-entries)))
12070 (unless org-refile-target-table
12071 (user-error "No refile targets"))
12072 (let* ((cbuf (current-buffer))
12073 (partial-completion-mode nil)
12074 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12075 (cfunc (if (and org-refile-use-outline-path
12076 org-outline-path-complete-in-steps)
12077 'org-olpath-completing-read
12078 'org-icompleting-read))
12079 (extra (if org-refile-use-outline-path "/" ""))
12080 (cbnex (concat (buffer-name) extra))
12081 (filename (and cfn (expand-file-name cfn)))
12084 (if (and (not (member org-refile-use-outline-path
12085 '(file full-file-path)))
12086 (not (equal filename (nth 1 x))))
12087 (cons (concat (car x) extra " ("
12088 (file-name-nondirectory (nth 1 x)) ")")
12090 (cons (concat (car x) extra) (cdr x))))
12091 org-refile-target-table))
12092 (completion-ignore-case t)
12094 (prompt (concat prompt
12095 (or (and (car org-refile-history)
12096 (concat " (default " (car org-refile-history) ")"))
12097 (and (assoc cbnex tbl) (setq cdef cbnex)
12098 (concat " (default " cbnex ")"))) ": "))
12099 pa answ parent-target child parent old-hist)
12100 (setq old-hist org-refile-history)
12101 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12102 nil 'org-refile-history (or cdef (car org-refile-history))))
12103 (if (setq pa (org-refile--get-location answ tbl))
12105 (org-refile-check-position pa)
12106 (when (or (not org-refile-history)
12107 (not (eq old-hist org-refile-history))
12108 (not (equal (car pa) (car org-refile-history))))
12109 (setq org-refile-history
12110 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12112 (cdr org-refile-history))))
12113 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12114 (pop org-refile-history)))
12116 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12118 (setq parent (match-string 1 answ)
12119 child (match-string 2 answ))
12120 (setq parent-target (org-refile--get-location parent tbl))
12121 (when (and parent-target
12122 (or (eq new-nodes t)
12123 (and (eq new-nodes 'confirm)
12124 (y-or-n-p (format "Create new node \"%s\"? "
12126 (org-refile-new-child parent-target child)))
12127 (user-error "Invalid target location")))))
12129 (declare-function org-string-nw-p "org-macs" (s))
12130 (defun org-refile-check-position (refile-pointer)
12131 "Check if the refile pointer matches the headline to which it points."
12132 (let* ((file (nth 1 refile-pointer))
12133 (re (nth 2 refile-pointer))
12134 (pos (nth 3 refile-pointer))
12136 (if (and (not (markerp pos)) (not file))
12137 (user-error "Please indicate a target file in the refile path")
12138 (when (org-string-nw-p re)
12139 (setq buffer (if (markerp pos)
12140 (marker-buffer pos)
12141 (or (find-buffer-visiting file)
12142 (find-file-noselect file))))
12143 (with-current-buffer buffer
12148 (beginning-of-line 1)
12149 (unless (org-looking-at-p re)
12150 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12152 (defun org-refile-new-child (parent-target child)
12153 "Use refile target PARENT-TARGET to add new CHILD below it."
12154 (unless parent-target
12155 (error "Cannot find parent for new node"))
12156 (let ((file (nth 1 parent-target))
12157 (pos (nth 3 parent-target))
12159 (with-current-buffer (or (find-buffer-visiting file)
12160 (find-file-noselect file))
12166 (goto-char (point-max))
12167 (if (not (bolp)) (newline)))
12168 (when (looking-at org-outline-regexp)
12169 (setq level (funcall outline-level))
12170 (org-end-of-subtree t t))
12171 (org-back-over-empty-lines)
12172 (insert "\n" (make-string
12173 (if pos (org-get-valid-level level 1) 1) ?*)
12175 (beginning-of-line 0)
12176 (list (concat (car parent-target) "/" child) file "" (point)))))))
12178 (defun org-olpath-completing-read (prompt collection &rest args)
12179 "Read an outline path like a file name."
12180 (let ((thetable collection)
12181 (org-completion-use-ido nil) ; does not work with ido.
12182 (org-completion-use-iswitchb nil)) ; or iswitchb
12184 'org-icompleting-read prompt
12185 (lambda (string predicate &optional flag)
12186 (let (rtn r f (l (length string)))
12190 (try-completion string thetable))
12193 (setq rtn (all-completions string thetable predicate))
12196 (setq r (substring x l))
12197 (if (string-match " ([^)]*)$" x)
12198 (setq f (match-string 0 x))
12200 (if (string-match "/" r)
12201 (concat string (substring r 0 (match-end 0)) f)
12206 (assoc string thetable)))))
12209 ;;;; Dynamic blocks
12211 (defun org-find-dblock (name)
12212 "Find the first dynamic block with name NAME in the buffer.
12213 If not found, stay at current position and return nil."
12214 (let ((case-fold-search t) pos)
12216 (goto-char (point-min))
12217 (setq pos (and (re-search-forward
12218 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12219 (match-beginning 0))))
12220 (if pos (goto-char pos))
12223 (defun org-create-dblock (plist)
12224 "Create a dynamic block section, with parameters taken from PLIST.
12225 PLIST must contain a :name entry which is used as the name of the block."
12226 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12229 (let ((col (current-column))
12230 (name (plist-get plist :name)))
12231 (insert "#+BEGIN: " name)
12233 (if (eq (car plist) :name)
12234 (setq plist (cddr plist))
12235 (insert " " (prin1-to-string (pop plist)))))
12236 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12237 (beginning-of-line -2)))
12239 (defun org-prepare-dblock ()
12240 "Prepare dynamic block for refresh.
12241 This empties the block, puts the cursor at the insert position and returns
12242 the property list including an extra property :name with the block name."
12243 (unless (looking-at org-dblock-start-re)
12244 (user-error "Not at a dynamic block"))
12245 (let* ((begdel (1+ (match-end 0)))
12246 (name (org-no-properties (match-string 1)))
12247 (params (append (list :name name)
12248 (read (concat "(" (match-string 3) ")")))))
12250 (beginning-of-line 1)
12251 (skip-chars-forward " \t")
12252 (setq params (plist-put params :indentation-column (current-column))))
12253 (unless (re-search-forward org-dblock-end-re nil t)
12254 (error "Dynamic block not terminated"))
12257 (list :content (buffer-substring
12258 begdel (match-beginning 0)))))
12259 (delete-region begdel (match-beginning 0))
12264 (defun org-map-dblocks (&optional command)
12265 "Apply COMMAND to all dynamic blocks in the current buffer.
12266 If COMMAND is not given, use `org-update-dblock'."
12267 (let ((cmd (or command 'org-update-dblock)))
12269 (goto-char (point-min))
12270 (while (re-search-forward org-dblock-start-re nil t)
12271 (goto-char (match-beginning 0))
12273 (condition-case nil
12275 (error (message "Error during update of dynamic block"))))
12276 (unless (re-search-forward org-dblock-end-re nil t)
12277 (error "Dynamic block not terminated"))))))
12279 (defun org-dblock-update (&optional arg)
12280 "User command for updating dynamic blocks.
12281 Update the dynamic block at point. With prefix ARG, update all dynamic
12282 blocks in the buffer."
12285 (org-update-all-dblocks)
12286 (or (looking-at org-dblock-start-re)
12287 (org-beginning-of-dblock))
12288 (org-update-dblock)))
12290 (defun org-update-dblock ()
12291 "Update the dynamic block at point.
12292 This means to empty the block, parse for parameters and then call
12293 the correct writing function."
12296 (let* ((win (selected-window))
12298 (line (org-current-line))
12299 (params (org-prepare-dblock))
12300 (name (plist-get params :name))
12301 (indent (plist-get params :indentation-column))
12302 (cmd (intern (concat "org-dblock-write:" name))))
12303 (message "Updating dynamic block `%s' at line %d..." name line)
12304 (funcall cmd params)
12305 (message "Updating dynamic block `%s' at line %d...done" name line)
12307 (when (and indent (> indent 0))
12308 (setq indent (make-string indent ?\ ))
12310 (select-window win)
12311 (org-beginning-of-dblock)
12313 (while (not (looking-at org-dblock-end-re))
12315 (beginning-of-line 2))
12316 (when (looking-at org-dblock-end-re)
12317 (and (looking-at "[ \t]+")
12318 (replace-match ""))
12319 (insert indent)))))))
12321 (defun org-beginning-of-dblock ()
12322 "Find the beginning of the dynamic block at point.
12323 Error if there is no such block at point."
12324 (let ((pos (point))
12327 (if (and (re-search-backward org-dblock-start-re nil t)
12328 (setq beg (match-beginning 0))
12329 (re-search-forward org-dblock-end-re nil t)
12330 (> (match-end 0) pos))
12333 (error "Not in a dynamic block"))))
12335 (defun org-update-all-dblocks ()
12336 "Update all dynamic blocks in the buffer.
12337 This function can be used in a hook."
12339 (when (derived-mode-p 'org-mode)
12340 (org-map-dblocks 'org-update-dblock)))
12345 (declare-function org-export-backend-name "org-export" (cl-x))
12346 (declare-function org-export-backend-options "org-export" (cl-x))
12347 (defun org-get-export-keywords ()
12348 "Return a list of all currently understood export keywords.
12349 Export keywords include options, block names, attributes and
12350 keywords relative to each registered export back-end."
12353 (org-bound-and-true-p org-export--registered-backends)
12354 (delq nil keywords))
12355 ;; Back-end name (for keywords, like #+LATEX:)
12356 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12357 (dolist (option-entry (org-export-backend-options backend))
12358 ;; Back-end options.
12359 (push (nth 1 option-entry) keywords)))))
12361 (defconst org-options-keywords
12362 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12363 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12364 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12365 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12366 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12368 (defcustom org-structure-template-alist
12369 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12370 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12371 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12372 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12373 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12374 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12375 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12377 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12379 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12382 ("I" "#+INCLUDE: %file ?"))
12383 "Structure completion elements.
12384 This is a list of abbreviation keys and values. The value gets inserted
12385 if you type `<' followed by the key and then press the completion key,
12386 usually `TAB'. %file will be replaced by a file name after prompting
12387 for the file using completion. The cursor will be placed at the position
12388 of the `?` in the template.
12389 There are two templates for each key, the first uses the original Org syntax,
12390 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12391 the default when the /org-mtags.el/ module has been loaded. See also the
12392 variable `org-mtags-prefer-muse-templates'."
12393 :group 'org-completion
12396 (string :tag "Key")
12397 (string :tag "Template")))
12399 :package-version '(Org . "8.3"))
12401 (defun org-try-structure-completion ()
12402 "Try to complete a structure template before point.
12403 This looks for strings like \"<e\" on an otherwise empty line and
12405 (let ((l (buffer-substring (point-at-bol) (point)))
12407 (when (and (looking-at "[ \t]*$")
12408 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12409 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12410 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12411 (match-beginning 1)) a)
12414 (defun org-complete-expand-structure-template (start cell)
12415 "Expand a structure template."
12416 (let ((rpl (nth 1 cell))
12418 (delete-region start (point))
12419 (when (string-match "\\`[ \t]*#\\+" rpl)
12422 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12423 (setq ind (buffer-substring (point-at-bol) (point))))
12425 (setq start (point))
12426 (if (string-match "%file" rpl)
12427 (setq rpl (replace-match
12431 (abbreviate-file-name (read-file-name "Include file: ")))
12434 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12435 (concat "\n" ind)))
12437 (if (re-search-backward "\\?" start t) (delete-char 1))))
12439 ;;;; TODO, DEADLINE, Comments
12441 (defun org-toggle-comment ()
12442 "Change the COMMENT state of an entry."
12445 (org-back-to-heading)
12446 (looking-at org-complex-heading-regexp)
12447 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12448 (skip-chars-forward " \t")
12449 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12450 (if (org-in-commented-heading-p t)
12451 (delete-region (point)
12452 (progn (search-forward " " (line-end-position) 'move)
12453 (skip-chars-forward " \t")
12455 (insert org-comment-string)
12456 (unless (eolp) (insert " ")))))
12458 (defvar org-last-todo-state-is-todo nil
12459 "This is non-nil when the last TODO state change led to a TODO state.
12460 If the last change removed the TODO tag or switched to DONE, then
12463 (defvar org-setting-tags nil) ; dynamically skipped
12465 (defvar org-todo-setup-filter-hook nil
12466 "Hook for functions that pre-filter todo specs.
12467 Each function takes a todo spec and returns either nil or the spec
12468 transformed into canonical form." )
12470 (defvar org-todo-get-default-hook nil
12471 "Hook for functions that get a default item for todo.
12472 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12473 nil or a string to be used for the todo mark." )
12475 (defvar org-agenda-headline-snapshot-before-repeat)
12477 (defun org-current-effective-time ()
12478 "Return current time adjusted for `org-extend-today-until' variable."
12479 (let* ((ct (org-current-time))
12480 (dct (decode-time ct))
12483 (org-use-last-clock-out-time-as-effective-time
12484 (or (org-clock-get-last-clock-out-time) ct))
12485 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12486 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12490 (defun org-todo-yesterday (&optional arg)
12491 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12493 (if (eq major-mode 'org-agenda-mode)
12494 (apply 'org-agenda-todo-yesterday arg)
12495 (let* ((org-use-effective-time t)
12496 (hour (third (decode-time
12497 (org-current-time))))
12498 (org-extend-today-until (1+ hour)))
12501 (defvar org-block-entry-blocking ""
12502 "First entry preventing the TODO state change.")
12504 (defun org-cancel-repeater ()
12505 "Cancel a repeater by setting its numeric value to zero."
12508 (org-back-to-heading t)
12509 (let ((bound1 (point))
12510 (bound0 (save-excursion (outline-next-heading) (point))))
12511 (when (re-search-forward
12512 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12513 org-deadline-time-regexp "\\)\\|\\("
12514 org-ts-regexp "\\)")
12516 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12517 (replace-match "0" t nil nil 1))))))
12519 (defun org-todo (&optional arg)
12520 "Change the TODO state of an item.
12521 The state of an item is given by a keyword at the start of the heading,
12523 *** TODO Write paper
12526 The different keywords are specified in the variable `org-todo-keywords'.
12527 By default the available states are \"TODO\" and \"DONE\".
12528 So for this example: when the item starts with TODO, it is changed to DONE.
12529 When it starts with DONE, the DONE is removed. And when neither TODO nor
12530 DONE are present, add TODO at the beginning of the heading.
12532 With \\[universal-argument] prefix arg, use completion to determine the new \
12534 With numeric prefix arg, switch to that state.
12535 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12536 keywords (nextset).
12537 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12538 With a numeric prefix arg of 0, inhibit note taking for the change.
12539 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12541 When called through ELisp, arg is also interpreted in the following way:
12542 'none -> empty state
12543 \"\"(empty string) -> switch to empty state
12544 'done -> switch to DONE
12545 'nextset -> switch to the next set of keywords
12546 'previousset -> switch to the previous set of keywords
12547 \"WAITING\" -> switch to the specified keyword, but only if it
12548 really is a member of `org-todo-keywords'."
12550 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12551 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12552 'region-start-level 'region))
12553 org-loop-over-headlines-in-active-region)
12556 org-loop-over-headlines-in-active-region
12557 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12558 (if (equal arg '(16)) (setq arg 'nextset))
12559 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12560 (let ((org-blocker-hook org-blocker-hook)
12563 (when (equal arg '(64))
12564 (setq arg nil org-blocker-hook nil))
12565 (when (and org-blocker-hook
12566 (or org-inhibit-blocking
12567 (org-entry-get nil "NOBLOCKING")))
12568 (setq org-blocker-hook nil))
12571 (org-back-to-heading t)
12572 (when (org-in-commented-heading-p t)
12573 (org-toggle-comment)
12575 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12576 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12577 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12578 (let* ((match-data (match-data))
12579 (startpos (point-at-bol))
12580 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12581 (org-log-done org-log-done)
12582 (org-log-repeat org-log-repeat)
12583 (org-todo-log-states org-todo-log-states)
12584 (org-inhibit-logging
12586 (progn (setq arg nil) 'note) org-inhibit-logging))
12587 (this (match-string 1))
12588 (hl-pos (match-beginning 0))
12589 (head (org-get-todo-sequence-head this))
12590 (ass (assoc head org-todo-kwd-alist))
12591 (interpret (nth 1 ass))
12592 (done-word (nth 3 ass))
12593 (final-done-word (nth 4 ass))
12594 (org-last-state (or this ""))
12595 (completion-ignore-case t)
12596 (member (member this org-todo-keywords-1))
12597 (tail (cdr member))
12599 ((and org-todo-key-trigger
12600 (or (and (equal arg '(4))
12601 (eq org-use-fast-todo-selection 'prefix))
12602 (and (not arg) org-use-fast-todo-selection
12603 (not (eq org-use-fast-todo-selection
12605 ;; Use fast selection
12606 (org-fast-todo-selection))
12607 ((and (equal arg '(4))
12608 (or (not org-use-fast-todo-selection)
12609 (not org-todo-key-trigger)))
12610 ;; Read a state with completion
12611 (org-icompleting-read
12612 "State: " (mapcar 'list org-todo-keywords-1)
12616 (if tail (car tail) nil)
12617 (car org-todo-keywords-1)))
12619 (if (equal member org-todo-keywords-1)
12622 (nth (- (length org-todo-keywords-1)
12624 org-todo-keywords-1)
12625 (org-last org-todo-keywords-1))))
12626 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12627 (setq arg nil))) ; hack to fall back to cycling
12629 ;; user or caller requests a specific state
12631 ((equal arg "") nil)
12632 ((eq arg 'none) nil)
12633 ((eq arg 'done) (or done-word (car org-done-keywords)))
12635 (or (car (cdr (member head org-todo-heads)))
12636 (car org-todo-heads)))
12637 ((eq arg 'previousset)
12638 (let ((org-todo-heads (reverse org-todo-heads)))
12639 (or (car (cdr (member head org-todo-heads)))
12640 (car org-todo-heads))))
12641 ((car (member arg org-todo-keywords-1)))
12643 (user-error "State `%s' not valid in this file" arg))
12644 ((nth (1- (prefix-numeric-value arg))
12645 org-todo-keywords-1))))
12646 ((null member) (or head (car org-todo-keywords-1)))
12647 ((equal this final-done-word) nil) ;; -> make empty
12648 ((null tail) nil) ;; -> first entry
12649 ((memq interpret '(type priority))
12650 (if (eq this-command last-command)
12652 (if (> (length tail) 0)
12653 (or done-word (car org-done-keywords))
12658 (run-hook-with-args-until-success
12659 'org-todo-get-default-hook org-state org-last-state)
12661 (next (if org-state (concat " " org-state " ") " "))
12662 (change-plist (list :type 'todo-state-change :from this :to org-state
12663 :position startpos))
12665 (when org-blocker-hook
12666 (setq org-last-todo-state-is-todo
12667 (not (member this org-done-keywords)))
12668 (unless (save-excursion
12670 (org-with-wide-buffer
12671 (run-hook-with-args-until-failure
12672 'org-blocker-hook change-plist))))
12673 (if (org-called-interactively-p 'interactive)
12674 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12675 this org-state org-block-entry-blocking)
12677 (message "TODO state change from %s to %s blocked (by \"%s\")"
12678 this org-state org-block-entry-blocking)
12679 (throw 'exit nil))))
12680 (store-match-data match-data)
12681 (replace-match next t t)
12682 (cond ((equal this org-state)
12683 (message "TODO state was already %s" (org-trim next)))
12684 ((pos-visible-in-window-p hl-pos)
12685 (message "TODO state changed to %s" (org-trim next))))
12687 (setq head (org-get-todo-sequence-head org-state)
12688 ass (assoc head org-todo-kwd-alist)
12689 interpret (nth 1 ass)
12690 done-word (nth 3 ass)
12691 final-done-word (nth 4 ass)))
12692 (when (memq arg '(nextset previousset))
12693 (message "Keyword-Set %d/%d: %s"
12694 (- (length org-todo-sets) -1
12695 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12696 (length org-todo-sets)
12697 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12698 (setq org-last-todo-state-is-todo
12699 (not (member org-state org-done-keywords)))
12700 (setq now-done-p (and (member org-state org-done-keywords)
12701 (not (member this org-done-keywords))))
12702 (and logging (org-local-logging logging))
12703 (when (and (or org-todo-log-states org-log-done)
12704 (not (eq org-inhibit-logging t))
12705 (not (memq arg '(nextset previousset))))
12706 ;; we need to look at recording a time and note
12707 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12708 (nth 2 (assoc this org-todo-log-states))))
12709 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12710 (setq dolog 'time))
12711 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12713 (member org-state org-not-done-keywords)
12714 (not (member this org-not-done-keywords))))
12715 ;; This is now a todo state and was not one before
12716 ;; If there was a CLOSED time stamp, get rid of it.
12717 (org-add-planning-info nil nil 'closed))
12718 (when (and now-done-p org-log-done)
12719 ;; It is now done, and it was not done before
12720 (org-add-planning-info 'closed (org-current-effective-time))
12721 (if (and (not dolog) (eq 'note org-log-done))
12722 (org-add-log-setup 'done org-state this 'findpos 'note)))
12723 (when (and org-state dolog)
12724 ;; This is a non-nil state, and we need to log it
12725 (org-add-log-setup 'state org-state this 'findpos dolog)))
12726 ;; Fixup tag positioning
12727 (org-todo-trigger-tag-changes org-state)
12728 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12729 (when org-provide-todo-statistics
12730 (org-update-parent-todo-statistics))
12731 (run-hooks 'org-after-todo-state-change-hook)
12732 (if (and arg (not (member org-state org-done-keywords)))
12733 (setq head (org-get-todo-sequence-head org-state)))
12734 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12735 ;; Do we need to trigger a repeat?
12737 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12738 ;; This is for the agenda, take a snapshot of the headline.
12740 (setq org-agenda-headline-snapshot-before-repeat
12741 (org-get-heading))))
12742 (org-auto-repeat-maybe org-state))
12743 ;; Fixup cursor location if close to the keyword
12744 (if (and (outline-on-heading-p)
12746 (save-excursion (beginning-of-line 1)
12747 (looking-at org-todo-line-regexp))
12748 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12750 (goto-char (or (match-end 2) (match-end 1)))
12751 (and (looking-at " ") (just-one-space))))
12752 (when org-trigger-hook
12754 (run-hook-with-args 'org-trigger-hook change-plist)))
12755 (when commentp (org-toggle-comment))))))))
12757 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12758 "Block turning an entry into a TODO, using the hierarchy.
12759 This checks whether the current task should be blocked from state
12760 changes. Such blocking occurs when:
12762 1. The task has children which are not all in a completed state.
12764 2. A task has a parent with the property :ORDERED:, and there
12765 are siblings prior to the current task with incomplete
12768 3. The parent of the task is blocked because it has siblings that should
12769 be done first, or is child of a block grandparent TODO entry."
12771 (if (not org-enforce-todo-dependencies)
12772 t ; if locally turned off don't block
12774 ;; If this is not a todo state change, or if this entry is already DONE,
12776 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12777 (member (plist-get change-plist :from)
12778 (cons 'done org-done-keywords))
12779 (member (plist-get change-plist :to)
12780 (cons 'todo org-not-done-keywords))
12781 (not (plist-get change-plist :to)))
12782 (throw 'dont-block t))
12783 ;; If this task has children, and any are undone, it's blocked
12785 (org-back-to-heading t)
12786 (let ((this-level (funcall outline-level)))
12787 (outline-next-heading)
12788 (let ((child-level (funcall outline-level)))
12789 (while (and (not (eobp))
12790 (> child-level this-level))
12791 ;; this todo has children, check whether they are all
12793 (if (and (not (org-entry-is-done-p))
12794 (org-entry-is-todo-p))
12795 (progn (setq org-block-entry-blocking (org-get-heading))
12796 (throw 'dont-block nil)))
12797 (outline-next-heading)
12798 (setq child-level (funcall outline-level))))))
12799 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12800 ;; any previous siblings are undone, it's blocked
12802 (org-back-to-heading t)
12803 (let* ((pos (point))
12804 (parent-pos (and (org-up-heading-safe) (point))))
12805 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12806 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12808 (re-search-forward org-not-done-heading-regexp pos t))
12809 (setq org-block-entry-blocking (match-string 0))
12810 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12811 ;; Search further up the hierarchy, to see if an ancestor is blocked
12813 (goto-char parent-pos)
12814 (if (not (looking-at org-not-done-heading-regexp))
12815 (throw 'dont-block t)) ; do not block, parent is not a TODO
12817 (setq parent-pos (and (org-up-heading-safe) (point)))
12818 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12819 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12821 (re-search-forward org-not-done-heading-regexp pos t)
12822 (setq org-block-entry-blocking (org-get-heading)))
12823 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12825 (defcustom org-track-ordered-property-with-tag nil
12826 "Should the ORDERED property also be shown as a tag?
12827 The ORDERED property decides if an entry should require subtasks to be
12828 completed in sequence. Since a property is not very visible, setting
12829 this option means that toggling the ORDERED property with the command
12830 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12831 not relevant for the behavior, but it makes things more visible.
12833 Note that toggling the tag with tags commands will not change the property
12834 and therefore not influence behavior!
12836 This can be t, meaning the tag ORDERED should be used, It can also be a
12837 string to select a different tag for this task."
12840 (const :tag "No tracking" nil)
12841 (const :tag "Track with ORDERED tag" t)
12842 (string :tag "Use other tag")))
12844 (defun org-toggle-ordered-property ()
12845 "Toggle the ORDERED property of the current entry.
12846 For better visibility, you can track the value of this property with a tag.
12847 See variable `org-track-ordered-property-with-tag'."
12849 (let* ((t1 org-track-ordered-property-with-tag)
12850 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12852 (org-back-to-heading)
12853 (if (org-entry-get nil "ORDERED")
12855 (org-delete-property "ORDERED")
12856 (and tag (org-toggle-tag tag 'off))
12857 (message "Subtasks can be completed in arbitrary order"))
12858 (org-entry-put nil "ORDERED" "t")
12859 (and tag (org-toggle-tag tag 'on))
12860 (message "Subtasks must be completed in sequence")))))
12862 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12863 (defun org-block-todo-from-checkboxes (change-plist)
12864 "Block turning an entry into a TODO, using checkboxes.
12865 This checks whether the current task should be blocked from state
12866 changes because there are unchecked boxes in this entry."
12867 (if (not org-enforce-todo-checkbox-dependencies)
12868 t ; if locally turned off don't block
12870 ;; If this is not a todo state change, or if this entry is already DONE,
12872 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12873 (member (plist-get change-plist :from)
12874 (cons 'done org-done-keywords))
12875 (member (plist-get change-plist :to)
12876 (cons 'todo org-not-done-keywords))
12877 (not (plist-get change-plist :to)))
12878 (throw 'dont-block t))
12879 ;; If this task has checkboxes that are not checked, it's blocked
12881 (org-back-to-heading t)
12882 (let ((beg (point)) end)
12883 (outline-next-heading)
12886 (if (org-list-search-forward
12887 (concat (org-item-beginning-re)
12888 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12892 (if (boundp 'org-blocked-by-checkboxes)
12893 (setq org-blocked-by-checkboxes t))
12894 (throw 'dont-block nil)))))
12895 t))) ; do not block
12897 (defun org-entry-blocked-p ()
12898 "Is the current entry blocked?"
12899 (org-with-silent-modifications
12900 (if (org-entry-get nil "NOBLOCKING")
12901 nil ;; Never block this entry
12902 (not (run-hook-with-args-until-failure
12904 (list :type 'todo-state-change
12909 (defun org-update-statistics-cookies (all)
12910 "Update the statistics cookie, either from TODO or from checkboxes.
12911 This should be called with the cursor in a line with a statistics cookie."
12915 (org-update-checkbox-count 'all)
12916 (org-map-entries 'org-update-parent-todo-statistics))
12917 (if (not (org-at-heading-p))
12918 (org-update-checkbox-count)
12919 (let ((pos (point-marker))
12921 (ignore-errors (org-back-to-heading t))
12922 (if (not (org-at-heading-p))
12923 (org-update-checkbox-count)
12924 (setq l1 (org-outline-level))
12925 (setq end (save-excursion
12926 (outline-next-heading)
12927 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12929 (if (and (save-excursion
12931 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12932 (not (save-excursion (re-search-forward
12933 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12934 (org-update-checkbox-count)
12935 (if (and l2 (> l2 l1))
12938 (org-update-parent-todo-statistics))
12940 (beginning-of-line 1)
12941 (while (re-search-forward
12942 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12944 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12946 (move-marker pos nil)))))
12948 (defvar org-entry-property-inherited-from) ;; defined below
12949 (defun org-update-parent-todo-statistics ()
12950 "Update any statistics cookie in the parent of the current headline.
12951 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12952 the entire subtree and this will travel up the hierarchy and update
12953 statistics everywhere."
12954 (let* ((prop (save-excursion (org-up-heading-safe)
12955 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12956 (recursive (or (not org-hierarchical-todo-statistics)
12957 (and prop (string-match "\\<recursive\\>" prop))))
12958 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12961 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12962 level ltoggle l1 new ndel
12963 (cnt-all 0) (cnt-done 0) is-percent kwd
12964 checkbox-beg ov ovs ove cookie-present)
12967 (beginning-of-line 1)
12968 (setq ltoggle (funcall outline-level))
12969 ;; Three situations are to consider:
12971 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12972 ;; to the top-level ancestor on the headline;
12974 ;; 2. If parent has "recursive" property, repeat up to the
12975 ;; headline setting that property, taking inheritance into
12978 ;; 3. Else, move up to direct parent and proceed only once.
12979 (while (and (setq level (org-up-heading-safe))
12980 (or recursive first)
12982 (setq first nil cookie-present nil)
12986 (downcase (or (org-entry-get nil "COOKIE_DATA")
12989 (while (re-search-forward box-re (point-at-eol) t)
12990 (setq cnt-all 0 cnt-done 0 cookie-present t)
12991 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12993 (unless (outline-next-heading) (throw 'exit nil))
12994 (while (and (looking-at org-complex-heading-regexp)
12995 (> (setq l1 (length (match-string 1))) level))
12996 (setq kwd (and (or recursive (= l1 ltoggle))
12998 (if (or (eq org-provide-todo-statistics 'all-headlines)
12999 (and (eq org-provide-todo-statistics t)
13000 (or (member kwd org-done-keywords)))
13001 (and (listp org-provide-todo-statistics)
13002 (stringp (car org-provide-todo-statistics))
13003 (or (member kwd org-provide-todo-statistics)
13004 (member kwd org-done-keywords)))
13005 (and (listp org-provide-todo-statistics)
13006 (listp (car org-provide-todo-statistics))
13007 (or (member kwd (car org-provide-todo-statistics))
13008 (and (member kwd org-done-keywords)
13009 (member kwd (cadr org-provide-todo-statistics))))))
13010 (setq cnt-all (1+ cnt-all))
13011 (if (eq org-provide-todo-statistics t)
13012 (and kwd (setq cnt-all (1+ cnt-all)))))
13013 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
13014 (member kwd org-done-keywords))
13015 (and (listp org-provide-todo-statistics)
13016 (listp (car org-provide-todo-statistics))
13017 (member kwd org-done-keywords)
13018 (member kwd (cadr org-provide-todo-statistics)))
13019 (and (listp org-provide-todo-statistics)
13020 (stringp (car org-provide-todo-statistics))
13021 (member kwd org-done-keywords)))
13022 (setq cnt-done (1+ cnt-done)))
13023 (outline-next-heading)))
13026 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
13027 (format "[%d/%d]" cnt-done cnt-all))
13028 ndel (- (match-end 0) checkbox-beg))
13029 ;; handle overlays when updating cookie from column view
13030 (when (setq ov (car (overlays-at checkbox-beg)))
13031 (setq ovs (overlay-start ov) ove (overlay-end ov))
13032 (delete-overlay ov))
13033 (goto-char checkbox-beg)
13035 (delete-region (point) (+ (point) ndel))
13036 (when org-auto-align-tags (org-fix-tags-on-the-fly))
13037 (when ov (move-overlay ov ovs ove)))
13038 (when cookie-present
13039 (run-hook-with-args 'org-after-todo-statistics-hook
13040 cnt-done (- cnt-all cnt-done))))))
13041 (run-hooks 'org-todo-statistics-hook)))
13043 (defvar org-after-todo-statistics-hook nil
13044 "Hook that is called after a TODO statistics cookie has been updated.
13045 Each function is called with two arguments: the number of not-done entries
13046 and the number of done entries.
13048 For example, the following function, when added to this hook, will switch
13049 an entry to DONE when all children are done, and back to TODO when new
13050 entries are set to a TODO status. Note that this hook is only called
13051 when there is a statistics cookie in the headline!
13053 (defun org-summary-todo (n-done n-not-done)
13054 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13055 (let (org-log-done org-log-states) ; turn off logging
13056 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13059 (defvar org-todo-statistics-hook nil
13060 "Hook that is run whenever Org thinks TODO statistics should be updated.
13061 This hook runs even if there is no statistics cookie present, in which case
13062 `org-after-todo-statistics-hook' would not run.")
13064 (defun org-todo-trigger-tag-changes (state)
13065 "Apply the changes defined in `org-todo-state-tags-triggers'."
13066 (let ((l org-todo-state-tags-triggers)
13068 (when (or (not state) (equal state ""))
13069 (setq changes (append changes (cdr (assoc "" l)))))
13070 (when (and (stringp state) (> (length state) 0))
13071 (setq changes (append changes (cdr (assoc state l)))))
13072 (when (member state org-not-done-keywords)
13073 (setq changes (append changes (cdr (assoc 'todo l)))))
13074 (when (member state org-done-keywords)
13075 (setq changes (append changes (cdr (assoc 'done l)))))
13076 (dolist (c changes)
13077 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13079 (defun org-local-logging (value)
13080 "Get logging settings from a property VALUE."
13082 ;; directly set the variables, they are already local.
13083 (setq org-log-done nil
13085 org-todo-log-states nil)
13086 (setq words (org-split-string value))
13087 (while (setq w (pop words))
13089 ((setq a (assoc w org-startup-options))
13090 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13091 (set (nth 1 a) (nth 2 a))))
13092 ((setq a (org-extract-log-state-settings w))
13093 (and (member (car a) org-todo-keywords-1)
13094 (push a org-todo-log-states)))))))
13096 (defun org-get-todo-sequence-head (kwd)
13097 "Return the head of the TODO sequence to which KWD belongs.
13098 If KWD is not set, check if there is a text property remembering the
13103 (or (get-text-property (point-at-bol) 'org-todo-head)
13105 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13106 nil (point-at-eol)))
13107 (get-text-property p 'org-todo-head))))
13108 ((not (member kwd org-todo-keywords-1))
13109 (car org-todo-keywords-1))
13110 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13112 (defun org-fast-todo-selection ()
13113 "Fast TODO keyword selection with single keys.
13114 Returns the new TODO keyword, or nil if no state change should occur."
13115 (let* ((fulltable org-todo-key-alist)
13116 (done-keywords org-done-keywords) ;; needed for the faces.
13117 (maxlen (apply 'max (mapcar
13119 (if (stringp (car x)) (string-width (car x)) 0))
13122 (fwidth (+ maxlen 3 1 3))
13123 (ncol (/ (- (window-width) 4) fwidth))
13127 (save-window-excursion
13129 (set-buffer (get-buffer-create " *Org todo*"))
13130 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13132 (org-set-local 'org-done-keywords done-keywords)
13133 (setq tbl fulltable cnt 0)
13134 (while (setq e (pop tbl))
13136 ((equal e '(:startgroup))
13137 (push '() groups) (setq ingroup t)
13138 (when (not (= cnt 0))
13142 ((equal e '(:endgroup))
13143 (setq ingroup nil cnt 0)
13145 ((equal e '(:newline))
13146 (when (not (= cnt 0))
13150 (while (equal (car tbl) '(:newline))
13152 (setq tbl (cdr tbl)))))
13154 (setq tg (car e) c (cdr e))
13155 (if ingroup (push tg (car groups)))
13156 (setq tg (org-add-props tg nil 'face
13157 (org-get-todo-face tg)))
13158 (if (and (= cnt 0) (not ingroup)) (insert " "))
13159 (insert "[" c "] " tg (make-string
13160 (- fwidth 4 (length tg)) ?\ ))
13161 (when (= (setq cnt (1+ cnt)) ncol)
13163 (if ingroup (insert " "))
13166 (goto-char (point-min))
13167 (if (not expert) (org-fit-window-to-buffer))
13168 (message "[a-z..]:Set [SPC]:clear")
13169 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13172 (and (= c ?q) (not (rassoc c fulltable))))
13173 (setq quit-flag t))
13175 ((setq e (rassoc c fulltable) tg (car e))
13177 (t (setq quit-flag t)))))))
13179 (defun org-entry-is-todo-p ()
13180 (member (org-get-todo-state) org-not-done-keywords))
13182 (defun org-entry-is-done-p ()
13183 (member (org-get-todo-state) org-done-keywords))
13185 (defun org-get-todo-state ()
13186 "Return the TODO keyword of the current subtree."
13188 (org-back-to-heading t)
13189 (and (looking-at org-todo-line-regexp)
13191 (match-string 2))))
13193 (defun org-at-date-range-p (&optional inactive-ok)
13194 "Is the cursor inside a date range?"
13198 (let ((pos (point)))
13199 (skip-chars-backward "^[<\r\n")
13200 (skip-chars-backward "<[")
13201 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13202 (>= (match-end 0) pos)
13204 (skip-chars-backward "^<[\r\n")
13205 (skip-chars-backward "<[")
13206 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13207 (>= (match-end 0) pos)
13211 (defun org-get-repeat (&optional tagline)
13212 "Check if there is a deadline/schedule with repeater in this entry."
13215 (org-back-to-heading t)
13216 (and (re-search-forward (if tagline
13217 (concat tagline "\\s-*" org-repeat-re)
13219 (org-entry-end-position) t)
13220 (match-string-no-properties 1)))))
13222 (defvar org-last-changed-timestamp)
13223 (defvar org-last-inserted-timestamp)
13224 (defvar org-log-post-message)
13225 (defvar org-log-note-purpose)
13226 (defvar org-log-note-how nil)
13227 (defvar org-log-note-extra)
13228 (defun org-auto-repeat-maybe (done-word)
13229 "Check if the current headline contains a repeated deadline/schedule.
13230 If yes, set TODO state back to what it was and change the base date
13231 of repeating deadline/scheduled time stamps to new date.
13232 This function is run automatically after each state change to a DONE state."
13233 ;; last-state is dynamically scoped into this function
13234 (let* ((repeat (org-get-repeat))
13235 (aa (assoc org-last-state org-todo-kwd-alist))
13236 (interpret (nth 1 aa))
13238 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13239 (msg "Entry repeats: ")
13241 (org-todo-log-states nil)
13242 re type n what ts time to-state)
13243 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13244 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13245 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13246 org-todo-repeat-to-state))
13247 (unless (and to-state (member to-state org-todo-keywords-1))
13248 (setq to-state (if (eq interpret 'type) org-last-state head)))
13249 (org-todo to-state)
13250 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13251 (org-entry-put nil "LAST_REPEAT" (format-time-string
13252 (org-time-stamp-format t t))))
13253 (when org-log-repeat
13254 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13255 (memq 'org-add-log-note post-command-hook))
13256 ;; OK, we are already setup for some record
13257 (if (eq org-log-repeat 'note)
13258 ;; make sure we take a note, not only a time stamp
13259 (setq org-log-note-how 'note))
13260 ;; Set up for taking a record
13261 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13263 'findpos org-log-repeat)))
13264 (org-back-to-heading t)
13265 (org-add-planning-info nil nil 'closed)
13266 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13267 org-deadline-time-regexp "\\)\\|\\("
13268 org-ts-regexp "\\)"))
13269 (while (re-search-forward
13270 re (save-excursion (outline-next-heading) (point)) t)
13271 (setq type (if (match-end 1) org-scheduled-string
13272 (if (match-end 3) org-deadline-string "Plain:"))
13273 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13274 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13275 (setq n (string-to-number (match-string 2 ts))
13276 what (match-string 3 ts))
13277 (if (equal what "w") (setq n (* n 7) what "d"))
13278 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13279 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13280 ;; Preparation, see if we need to modify the start date for the change
13281 (when (match-end 1)
13282 (setq time (save-match-data (org-time-string-to-time ts)))
13284 ((equal (match-string 1 ts) ".")
13285 ;; Shift starting date to today
13286 (org-timestamp-change
13287 (- (org-today) (time-to-days time))
13289 ((equal (match-string 1 ts) "+")
13290 (let ((nshiftmax 10) (nshift 0))
13291 (while (or (= nshift 0)
13292 (<= (time-to-days time)
13293 (time-to-days (current-time))))
13294 (when (= (incf nshift) nshiftmax)
13295 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13296 (user-error "Abort")))
13297 (org-timestamp-change n (cdr (assoc what whata)))
13298 (org-at-timestamp-p t)
13299 (setq ts (match-string 1))
13300 (setq time (save-match-data (org-time-string-to-time ts)))))
13301 (org-timestamp-change (- n) (cdr (assoc what whata)))
13302 ;; rematch, so that we have everything in place for the real shift
13303 (org-at-timestamp-p t)
13304 (setq ts (match-string 1))
13305 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13306 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13307 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13308 (setq org-log-post-message msg)
13309 (message "%s" msg))))
13311 (defun org-show-todo-tree (arg)
13312 "Make a compact tree which shows all headlines marked with TODO.
13313 The tree will show the lines where the regexp matches, and all higher
13314 headlines above the match.
13315 With a \\[universal-argument] prefix, prompt for a regexp to match.
13316 With a numeric prefix N, construct a sparse tree for the Nth element
13317 of `org-todo-keywords-1'."
13319 (let ((case-fold-search nil)
13321 (cond ((null arg) org-not-done-regexp)
13323 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13324 (mapcar 'list org-todo-keywords-1))))
13326 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13328 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13329 (regexp-quote (nth (1- (prefix-numeric-value arg))
13330 org-todo-keywords-1)))
13331 (t (user-error "Invalid prefix argument: %s" arg)))))
13332 (message "%d TODO entries found"
13333 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13335 (defun org-deadline (arg &optional time)
13336 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13337 With one universal prefix argument, remove any deadline from the item.
13338 With two universal prefix arguments, prompt for a warning delay.
13339 With argument TIME, set the deadline at the corresponding date. TIME
13340 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13342 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13343 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13344 'region-start-level 'region))
13345 org-loop-over-headlines-in-active-region)
13347 `(org-deadline ',arg ,time)
13348 org-loop-over-headlines-in-active-region
13349 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13350 (let* ((old-date (org-entry-get nil "DEADLINE"))
13351 (old-date-time (if old-date (org-time-string-to-time old-date)))
13352 (repeater (and old-date
13354 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13356 (match-string 1 old-date))))
13359 (when (and old-date org-log-redeadline)
13360 (org-add-log-setup 'deldeadline nil old-date 'findpos
13361 org-log-redeadline))
13362 (org-remove-timestamp-with-keyword org-deadline-string)
13363 (message "Item no longer has a deadline."))
13366 (org-back-to-heading t)
13367 (if (re-search-forward
13368 org-deadline-time-regexp
13369 (save-excursion (outline-next-heading) (point)) t)
13370 (let* ((rpl0 (match-string 1))
13371 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13373 (concat org-deadline-string
13379 (org-read-date nil t nil "Warn starting from" old-date-time)))
13380 (time-to-days old-date-time))))
13382 (user-error "No deadline information to update"))))
13384 (org-add-planning-info 'deadline time 'closed)
13385 (when (and old-date org-log-redeadline
13386 (not (equal old-date
13387 (substring org-last-inserted-timestamp 1 -1))))
13388 (org-add-log-setup 'redeadline nil old-date 'findpos
13389 org-log-redeadline))
13392 (org-back-to-heading t)
13393 (when (re-search-forward (concat org-deadline-string " "
13394 org-last-inserted-timestamp)
13396 (outline-next-heading) (point)) t)
13397 (goto-char (1- (match-end 0)))
13398 (insert " " repeater)
13399 (setq org-last-inserted-timestamp
13400 (concat (substring org-last-inserted-timestamp 0 -1)
13402 (substring org-last-inserted-timestamp -1))))))
13403 (message "Deadline on %s" org-last-inserted-timestamp))))))
13405 (defun org-schedule (arg &optional time)
13406 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13407 With one universal prefix argument, remove any scheduling date from the item.
13408 With two universal prefix arguments, prompt for a delay cookie.
13409 With argument TIME, scheduled at the corresponding date. TIME can
13410 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13412 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13413 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13414 'region-start-level 'region))
13415 org-loop-over-headlines-in-active-region)
13417 `(org-schedule ',arg ,time)
13418 org-loop-over-headlines-in-active-region
13419 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13420 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13421 (old-date-time (if old-date (org-time-string-to-time old-date)))
13422 (repeater (and old-date
13424 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13426 (match-string 1 old-date))))
13430 (when (and old-date org-log-reschedule)
13431 (org-add-log-setup 'delschedule nil old-date 'findpos
13432 org-log-reschedule))
13433 (org-remove-timestamp-with-keyword org-scheduled-string)
13434 (message "Item is no longer scheduled.")))
13437 (org-back-to-heading t)
13438 (if (re-search-forward
13439 org-scheduled-time-regexp
13440 (save-excursion (outline-next-heading) (point)) t)
13441 (let* ((rpl0 (match-string 1))
13442 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13444 (concat org-scheduled-string
13450 (org-read-date nil t nil "Delay until" old-date-time)))
13451 (time-to-days old-date-time))))
13453 (user-error "No scheduled information to update"))))
13455 (org-add-planning-info 'scheduled time 'closed)
13456 (when (and old-date org-log-reschedule
13457 (not (equal old-date
13458 (substring org-last-inserted-timestamp 1 -1))))
13459 (org-add-log-setup 'reschedule nil old-date 'findpos
13460 org-log-reschedule))
13463 (org-back-to-heading t)
13464 (when (re-search-forward (concat org-scheduled-string " "
13465 org-last-inserted-timestamp)
13467 (outline-next-heading) (point)) t)
13468 (goto-char (1- (match-end 0)))
13469 (insert " " repeater)
13470 (setq org-last-inserted-timestamp
13471 (concat (substring org-last-inserted-timestamp 0 -1)
13473 (substring org-last-inserted-timestamp -1))))))
13474 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13476 (defun org-get-scheduled-time (pom &optional inherit)
13477 "Get the scheduled time as a time tuple, of a format suitable
13478 for calling org-schedule with, or if there is no scheduling,
13480 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13482 (apply 'encode-time (org-parse-time-string time)))))
13484 (defun org-get-deadline-time (pom &optional inherit)
13485 "Get the deadline as a time tuple, of a format suitable for
13486 calling org-deadline with, or if there is no scheduling, returns
13488 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13490 (apply 'encode-time (org-parse-time-string time)))))
13492 (defun org-remove-timestamp-with-keyword (keyword)
13493 "Remove all time stamps with KEYWORD in the current entry."
13494 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13497 (org-back-to-heading t)
13499 (outline-next-heading)
13500 (while (re-search-backward re beg t)
13502 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13503 (equal (char-before) ?\ ))
13504 (backward-delete-char 1)
13505 (if (string-match "^[ \t]*$" (buffer-substring
13506 (point-at-bol) (point-at-eol)))
13507 (delete-region (point-at-bol)
13508 (min (point-max) (1+ (point-at-eol))))))))))
13510 (defvar org-time-was-given) ; dynamically scoped parameter
13511 (defvar org-end-time-was-given) ; dynamically scoped parameter
13513 (defun org-add-planning-info (what &optional time &rest remove)
13514 "Insert new timestamp with keyword in the planning line.
13515 WHAT indicates what kind of time stamp to add. It is a symbol
13516 among `closed', `deadline', `scheduled' and nil. TIME indicates
13517 the time to use. If none is given, the user is prompted for
13518 a date. REMOVE indicates what kind of entries to remove. An old
13519 WHAT entry will also be removed."
13520 (let (org-time-was-given org-end-time-was-given default-time default-input)
13522 (when (and (memq what '(scheduled deadline))
13524 (and (stringp time)
13525 (string-match "^[-+]+[0-9]" time))))
13526 ;; Try to get a default date/time from existing timestamp
13528 (org-back-to-heading t)
13529 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13530 (when (re-search-forward (if (eq what 'scheduled)
13531 org-scheduled-time-regexp
13532 org-deadline-time-regexp)
13534 (setq ts (match-string 1)
13535 default-time (apply 'encode-time (org-parse-time-string ts))
13536 default-input (and ts (org-get-compact-tod ts)))))))
13540 ;; This is a string (relative or absolute), set
13542 (apply #'encode-time
13543 (org-read-date-analyze
13544 time default-time (decode-time default-time)))
13545 ;; If necessary, get the time from the user
13546 (or time (org-read-date nil 'to-time nil nil
13547 default-time default-input)))))
13549 (org-with-wide-buffer
13550 (org-back-to-heading t)
13552 (unless (bolp) (insert "\n"))
13553 (cond ((org-looking-at-p org-planning-line-re)
13554 ;; Move to current indentation.
13555 (skip-chars-forward " \t")
13556 ;; Check if we have to remove something.
13557 (dolist (type (if what (cons what remove) remove))
13558 (when (save-excursion
13561 (closed org-closed-time-regexp)
13562 (deadline org-deadline-time-regexp)
13563 (scheduled org-scheduled-time-regexp)
13564 (otherwise (error "Invalid planning type: %s" type)))
13565 (line-end-position) t))
13567 (when (looking-at "--+<[^>]+>") (replace-match ""))
13568 (when (and (not what) (eq type 'closed))
13570 (beginning-of-line)
13571 (if (looking-at "[ \t]*$")
13572 (delete-region (point) (1+ (point-at-eol)))))))
13573 ;; Remove leading white spaces.
13574 (when (and (not (bolp)) (looking-at "[ \t]+")) (replace-match ""))))
13575 ((not what) (throw 'exit nil)) ; Nothing to do.
13576 (t (insert-before-markers "\n")
13578 (when org-adapt-indentation
13579 (org-indent-to-column (1+ (org-outline-level))))))
13581 ;; Insert planning keyword.
13583 (closed org-closed-string)
13584 (deadline org-deadline-string)
13585 (scheduled org-scheduled-string)
13586 (otherwise (error "Invalid planning type: %s" what)))
13588 ;; Insert associated timestamp.
13589 (let ((ts (org-insert-time-stamp
13591 (or org-time-was-given
13592 (and (eq what 'closed) org-log-done-with-time))
13594 nil nil (list org-end-time-was-given))))
13595 (unless (eolp) (insert " "))
13598 (defvar org-log-note-marker (make-marker))
13599 (defvar org-log-note-purpose nil)
13600 (defvar org-log-note-state nil)
13601 (defvar org-log-note-previous-state nil)
13602 (defvar org-log-note-extra nil)
13603 (defvar org-log-note-window-configuration nil)
13604 (defvar org-log-note-return-to (make-marker))
13605 (defvar org-log-note-effective-time nil
13606 "Remembered current time so that dynamically scoped
13607 `org-extend-today-until' affects tha timestamps in state change
13610 (defvar org-log-post-message nil
13611 "Message to be displayed after a log note has been stored.
13612 The auto-repeater uses this.")
13614 (defun org-add-note ()
13615 "Add a note to the current entry.
13616 This is done in the same way as adding a state change note."
13618 (org-add-log-setup 'note nil nil 'findpos nil))
13620 (defun org-log-beginning (&optional create)
13621 "Return expected start of log notes in current entry.
13622 When optional argument CREATE is non-nil, the function creates
13623 a drawer to store notes, if necessary. Returned position ignores
13625 (org-with-wide-buffer
13626 (org-back-to-heading t)
13627 ;; Skip planning info and property drawer.
13629 (when (org-looking-at-p org-planning-line-re) (forward-line))
13630 (when (looking-at org-property-drawer-re)
13631 (goto-char (match-end 0))
13633 (if (org-at-heading-p) (point)
13634 (let ((end (save-excursion (outline-next-heading) (point)))
13635 (drawer (org-log-into-drawer)))
13638 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13639 (case-fold-search t))
13641 ;; Try to find existing drawer.
13642 (while (re-search-forward regexp end t)
13643 (let ((element (org-element-at-point)))
13644 (when (eq (org-element-type element) 'drawer)
13645 (let ((cend (org-element-property :contents-end element)))
13646 (when (and (not org-log-states-order-reversed) cend)
13648 (throw 'exit nil))))
13649 ;; No drawer found. Create one, if permitted.
13651 (unless (bolp) (insert "\n"))
13652 (let ((beg (point)))
13653 (insert ":" drawer ":\n:END:\n")
13654 (org-indent-region beg (point)))
13655 (end-of-line -1)))))
13656 (org-log-state-notes-insert-after-drawers
13657 (while (and (looking-at org-drawer-regexp)
13658 (progn (goto-char (match-end 0))
13659 (re-search-forward org-property-end-re end t)))
13661 (if (bolp) (point) (line-beginning-position 2)))))
13663 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13664 "Set up the post command hook to take a note.
13665 If this is about to TODO state change, the new state is expected in STATE.
13666 When FINDPOS is non-nil, find the correct position for the note in
13667 the current entry. If not, assume that it can be inserted at point.
13668 HOW is an indicator what kind of note should be created.
13669 EXTRA is additional text that will be inserted into the notes buffer."
13670 (org-with-wide-buffer
13672 (goto-char (org-log-beginning t))
13673 (unless org-log-states-order-reversed
13674 (org-skip-over-state-notes)
13675 (skip-chars-backward " \t\n\r")
13677 (move-marker org-log-note-marker (point))
13678 ;; Preserve position even if a property drawer is inserted in the
13680 (set-marker-insertion-type org-log-note-marker t)
13681 (setq org-log-note-purpose purpose
13682 org-log-note-state state
13683 org-log-note-previous-state prev-state
13684 org-log-note-how how
13685 org-log-note-extra extra
13686 org-log-note-effective-time (org-current-effective-time))
13687 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13689 (defun org-skip-over-state-notes ()
13690 "Skip past the list of State notes in an entry."
13691 (when (ignore-errors (goto-char (org-in-item-p)))
13692 (let* ((struct (org-list-struct))
13693 (prevs (org-list-prevs-alist struct))
13695 (concat "[ \t]*- +"
13696 (replace-regexp-in-string
13698 (org-replace-escapes
13699 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13700 `(("%d" . ,org-ts-regexp-inactive)
13701 ("%D" . ,org-ts-regexp)
13702 ("%s" . "\"\\S-+\"")
13703 ("%S" . "\"\\S-+\"")
13704 ("%t" . ,org-ts-regexp-inactive)
13705 ("%T" . ,org-ts-regexp)
13707 ("%U" . ".*?")))))))
13708 (while (org-looking-at-p regexp)
13709 (goto-char (or (org-list-get-next-item (point) struct prevs)
13710 (org-list-get-item-end (point) struct)))))))
13712 (defun org-add-log-note (&optional purpose)
13713 "Pop up a window for taking a note, and add this note later at point."
13714 (remove-hook 'post-command-hook 'org-add-log-note)
13715 (setq org-log-note-window-configuration (current-window-configuration))
13716 (delete-other-windows)
13717 (move-marker org-log-note-return-to (point))
13718 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13719 (goto-char org-log-note-marker)
13720 (org-switch-to-buffer-other-window "*Org Note*")
13722 (if (memq org-log-note-how '(time state))
13723 (let (current-prefix-arg) (org-store-log-note))
13724 (let ((org-inhibit-startup t)) (org-mode))
13725 (insert (format "# Insert note for %s.
13726 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13728 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13729 ((eq org-log-note-purpose 'done) "closed todo item")
13730 ((eq org-log-note-purpose 'state)
13731 (format "state change from \"%s\" to \"%s\""
13732 (or org-log-note-previous-state "")
13733 (or org-log-note-state "")))
13734 ((eq org-log-note-purpose 'reschedule)
13736 ((eq org-log-note-purpose 'delschedule)
13737 "no longer scheduled")
13738 ((eq org-log-note-purpose 'redeadline)
13739 "changing deadline")
13740 ((eq org-log-note-purpose 'deldeadline)
13741 "removing deadline")
13742 ((eq org-log-note-purpose 'refile)
13744 ((eq org-log-note-purpose 'note)
13746 (t (error "This should not happen")))))
13747 (if org-log-note-extra (insert org-log-note-extra))
13748 (org-set-local 'org-finish-function 'org-store-log-note)
13749 (run-hooks 'org-log-buffer-setup-hook)))
13751 (defvar org-note-abort nil) ; dynamically scoped
13752 (defun org-store-log-note ()
13753 "Finish taking a log note, and insert it to where it belongs."
13754 (let ((txt (buffer-string)))
13755 (kill-buffer (current-buffer))
13756 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13757 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13758 (setq txt (replace-match "" t t txt)))
13759 (if (string-match "\\s-+\\'" txt)
13760 (setq txt (replace-match "" t t txt)))
13761 (setq lines (org-split-string txt "\n"))
13762 (when (and note (string-match "\\S-" note))
13764 (org-replace-escapes
13766 (list (cons "%u" (user-login-name))
13767 (cons "%U" user-full-name)
13768 (cons "%t" (format-time-string
13769 (org-time-stamp-format 'long 'inactive)
13770 org-log-note-effective-time))
13771 (cons "%T" (format-time-string
13772 (org-time-stamp-format 'long nil)
13773 org-log-note-effective-time))
13774 (cons "%d" (format-time-string
13775 (org-time-stamp-format nil 'inactive)
13776 org-log-note-effective-time))
13777 (cons "%D" (format-time-string
13778 (org-time-stamp-format nil nil)
13779 org-log-note-effective-time))
13780 (cons "%s" (if org-log-note-state
13781 (concat "\"" org-log-note-state "\"")
13783 (cons "%S" (if org-log-note-previous-state
13784 (concat "\"" org-log-note-previous-state "\"")
13786 (when lines (setq note (concat note " \\\\")))
13788 (when (or current-prefix-arg org-note-abort)
13789 (when (org-log-into-drawer)
13790 (org-remove-empty-drawer-at org-log-note-marker))
13793 (with-current-buffer (marker-buffer org-log-note-marker)
13795 (goto-char org-log-note-marker)
13796 (move-marker org-log-note-marker nil)
13797 ;; Make sure point is at the beginning of an empty line.
13798 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13799 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13800 ;; In an existing list, add a new item at the top level.
13801 ;; Otherwise, indent line like a regular one.
13802 (let ((itemp (org-in-item-p)))
13804 (org-indent-line-to
13805 (let ((struct (save-excursion
13806 (goto-char itemp) (org-list-struct))))
13807 (org-list-get-ind (org-list-get-top-point struct) struct)))
13808 (org-indent-line)))
13809 (insert (org-list-bullet-string "-") (pop lines))
13810 (let ((ind (org-list-item-body-column (line-beginning-position))))
13811 (dolist (line lines)
13813 (org-indent-line-to ind)
13815 (message "Note stored")
13816 (org-back-to-heading t)
13817 (org-cycle-hide-drawers 'children))
13818 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13819 ;; from within `org-add-log-note' because `buffer-undo-list'
13820 ;; is then modified outside of `org-with-remote-undo'.
13821 (when (eq this-command 'org-agenda-todo)
13822 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13823 ;; Don't add undo information when called from `org-agenda-todo'
13824 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13825 (set-window-configuration org-log-note-window-configuration)
13826 (with-current-buffer (marker-buffer org-log-note-return-to)
13827 (goto-char org-log-note-return-to))
13828 (move-marker org-log-note-return-to nil)
13829 (and org-log-post-message (message "%s" org-log-post-message))))
13831 (defun org-remove-empty-drawer-at (pos)
13832 "Remove an empty drawer at position POS.
13833 POS may also be a marker."
13834 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13835 (org-with-wide-buffer
13837 (let ((drawer (org-element-at-point)))
13838 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13839 (not (org-element-property :contents-begin drawer)))
13840 (delete-region (org-element-property :begin drawer)
13841 (progn (goto-char (org-element-property :end drawer))
13842 (skip-chars-backward " \r\t\n")
13846 (defvar org-ts-type nil)
13847 (defun org-sparse-tree (&optional arg type)
13848 "Create a sparse tree, prompt for the details.
13849 This command can create sparse trees. You first need to select the type
13850 of match used to create the tree:
13852 t Show all TODO entries.
13853 T Show entries with a specific TODO keyword.
13854 m Show entries selected by a tags/property match.
13855 p Enter a property name and its value (both with completion on existing
13856 names/values) and show entries with that property.
13857 r Show entries matching a regular expression (`/' can be used as well).
13858 b Show deadlines and scheduled items before a date.
13859 a Show deadlines and scheduled items after a date.
13860 d Show deadlines due within `org-deadline-warning-days'.
13861 D Show deadlines and scheduled items between a date range."
13863 (setq type (or type org-sparse-tree-default-date-type))
13864 (setq org-ts-type type)
13865 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13866 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13867 [c]ycle through date types: %s"
13869 (all "all timestamps")
13870 (scheduled "only scheduled")
13871 (deadline "only deadline")
13872 (active "only active timestamps")
13873 (inactive "only inactive timestamps")
13874 (scheduled-or-deadline "scheduled/deadline")
13875 (closed "with a closed time-stamp")
13876 (otherwise "scheduled/deadline")))
13877 (let ((answer (read-char-exclusive)))
13882 (cadr (memq type '(scheduled-or-deadline all scheduled deadline active
13883 inactive closed)))))
13884 (?d (call-interactively 'org-check-deadlines))
13885 (?b (call-interactively 'org-check-before-date))
13886 (?a (call-interactively 'org-check-after-date))
13887 (?D (call-interactively 'org-check-dates-range))
13888 (?t (call-interactively 'org-show-todo-tree))
13889 (?T (org-show-todo-tree '(4)))
13890 (?m (call-interactively 'org-match-sparse-tree))
13892 (let* ((kwd (org-icompleting-read
13893 "Property: " (mapcar 'list (org-buffer-property-keys))))
13894 (value (org-icompleting-read
13895 "Value: " (mapcar 'list (org-property-values kwd)))))
13896 (unless (string-match "\\`{.*}\\'" value)
13897 (setq value (concat "\"" value "\"")))
13898 (org-match-sparse-tree arg (concat kwd "=" value))))
13899 ((?r ?R ?/) (call-interactively 'org-occur))
13900 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13902 (defvar org-occur-highlights nil
13903 "List of overlays used for occur matches.")
13904 (make-variable-buffer-local 'org-occur-highlights)
13905 (defvar org-occur-parameters nil
13906 "Parameters of the active org-occur calls.
13907 This is a list, each call to org-occur pushes as cons cell,
13908 containing the regular expression and the callback, onto the list.
13909 The list can contain several entries if `org-occur' has been called
13910 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13911 will only contain one set of parameters. When the highlights are
13912 removed (for example with `C-c C-c', or with the next edit (depending
13913 on `org-remove-highlights-with-change'), this variable is emptied
13915 (make-variable-buffer-local 'org-occur-parameters)
13917 (defun org-occur (regexp &optional keep-previous callback)
13918 "Make a compact tree which shows all matches of REGEXP.
13919 The tree will show the lines where the regexp matches, and all higher
13920 headlines above the match. It will also show the heading after the match,
13921 to make sure editing the matching entry is easy.
13922 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13923 call to `org-occur' will be kept, to allow stacking of calls to this
13925 If CALLBACK is non-nil, it is a function which is called to confirm
13926 that the match should indeed be shown."
13927 (interactive "sRegexp: \nP")
13928 (when (equal regexp "")
13929 (user-error "Regexp cannot be empty"))
13930 (unless keep-previous
13931 (org-remove-occur-highlights nil nil t))
13932 (push (cons regexp callback) org-occur-parameters)
13935 (goto-char (point-min))
13936 (if (or (not keep-previous) ; do not want to keep
13937 (not org-occur-highlights)) ; no previous matches
13940 (while (re-search-forward regexp nil t)
13941 (when (or (not callback)
13942 (save-match-data (funcall callback)))
13943 (setq cnt (1+ cnt))
13944 (when org-highlight-sparse-tree-matches
13945 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13946 (org-show-context 'occur-tree))))
13947 (when org-remove-highlights-with-change
13948 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13950 (unless org-sparse-tree-open-archived-trees
13951 (org-hide-archived-subtrees (point-min) (point-max)))
13952 (run-hooks 'org-occur-hook)
13953 (if (org-called-interactively-p 'interactive)
13954 (message "%d match(es) for regexp %s" cnt regexp))
13957 (defun org-occur-next-match (&optional n reset)
13958 "Function for `next-error-function' to find sparse tree matches.
13959 N is the number of matches to move, when negative move backwards.
13960 RESET is entirely ignored - this function always goes back to the
13961 starting point when no match is found."
13962 (let* ((limit (if (< n 0) (point-min) (point-max)))
13963 (search-func (if (< n 0)
13964 'previous-single-char-property-change
13965 'next-single-char-property-change))
13970 (while (setq p1 (funcall search-func (point) 'org-type))
13971 (when (equal p1 limit)
13973 (user-error "No more matches"))
13974 (when (equal (get-char-property p1 'org-type) 'org-occur)
13978 (throw 'exit (point))))
13981 (user-error "No more matches"))))
13983 (defun org-show-context (&optional key)
13984 "Make sure point and context are visible.
13985 How much context is shown depends upon the variables
13986 `org-show-hierarchy-above', `org-show-following-heading',
13987 `org-show-entry-below' and `org-show-siblings'."
13988 (let ((heading-p (org-at-heading-p t))
13989 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13990 (following-p (org-get-alist-option org-show-following-heading key))
13991 (entry-p (org-get-alist-option org-show-entry-below key))
13992 (siblings-p (org-get-alist-option org-show-siblings key)))
13993 ;; Show heading or entry text
13994 (if (and heading-p (not entry-p))
13995 (org-flag-heading nil) ; only show the heading
13996 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13997 (org-show-hidden-entry))) ; show entire entry
13999 ;; Show next sibling, or heading below text
14001 (and (if heading-p (org-goto-sibling) (outline-next-heading))
14002 (org-flag-heading nil))))
14003 (when siblings-p (org-show-siblings))
14005 ;; show all higher headings, possibly with siblings
14007 (while (and (ignore-errors (progn (org-up-heading-all 1) t))
14009 (org-flag-heading nil)
14010 (when siblings-p (org-show-siblings)))))))
14012 (defvar org-reveal-start-hook nil
14013 "Hook run before revealing a location.")
14015 (defun org-reveal (&optional siblings)
14016 "Show current entry, hierarchy above it, and the following headline.
14017 This can be used to show a consistent set of context around locations
14018 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
14019 not t for the search context.
14021 With optional argument SIBLINGS, on each level of the hierarchy all
14022 siblings are shown. This repairs the tree structure to what it would
14023 look like when opened with hierarchical calls to `org-cycle'.
14024 With double optional argument \\[universal-argument] \\[universal-argument], \
14025 go to the parent and show the
14028 (run-hooks 'org-reveal-start-hook)
14029 (let ((org-show-hierarchy-above t)
14030 (org-show-following-heading t)
14031 (org-show-siblings (if siblings t org-show-siblings)))
14032 (org-show-context nil))
14033 (when (equal siblings '(16))
14035 (when (org-up-heading-safe)
14037 (run-hook-with-args 'org-cycle-hook 'subtree)))))
14039 (defun org-highlight-new-match (beg end)
14040 "Highlight from BEG to END and mark the highlight is an occur headline."
14041 (let ((ov (make-overlay beg end)))
14042 (overlay-put ov 'face 'secondary-selection)
14043 (overlay-put ov 'org-type 'org-occur)
14044 (push ov org-occur-highlights)))
14046 (defun org-remove-occur-highlights (&optional beg end noremove)
14047 "Remove the occur highlights from the buffer.
14048 BEG and END are ignored. If NOREMOVE is nil, remove this function
14049 from the `before-change-functions' in the current buffer."
14051 (unless org-inhibit-highlight-removal
14052 (mapc 'delete-overlay org-occur-highlights)
14053 (setq org-occur-highlights nil)
14054 (setq org-occur-parameters nil)
14056 (remove-hook 'before-change-functions
14057 'org-remove-occur-highlights 'local))))
14061 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14062 "Regular expression matching the priority indicator.")
14064 (defvar org-remove-priority-next-time nil)
14066 (defun org-priority-up ()
14067 "Increase the priority of the current item."
14069 (org-priority 'up))
14071 (defun org-priority-down ()
14072 "Decrease the priority of the current item."
14074 (org-priority 'down))
14076 (defun org-priority (&optional action show)
14077 "Change the priority of an item.
14078 ACTION can be `set', `up', `down', or a character."
14080 (if (equal action '(4))
14081 (org-show-priority)
14082 (unless org-enable-priority-commands
14083 (user-error "Priority commands are disabled"))
14084 (setq action (or action 'set))
14085 (let (current new news have remove)
14087 (org-back-to-heading t)
14088 (if (looking-at org-priority-regexp)
14089 (setq current (string-to-char (match-string 2))
14092 ((eq action 'remove)
14093 (setq remove t new ?\ ))
14094 ((or (eq action 'set)
14095 (if (featurep 'xemacs) (characterp action) (integerp action)))
14096 (if (not (eq action 'set))
14098 (message "Priority %c-%c, SPC to remove: "
14099 org-highest-priority org-lowest-priority)
14101 (setq new (read-char-exclusive))))
14102 (if (and (= (upcase org-highest-priority) org-highest-priority)
14103 (= (upcase org-lowest-priority) org-lowest-priority))
14104 (setq new (upcase new)))
14105 (cond ((equal new ?\ ) (setq remove t))
14106 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14107 (user-error "Priority must be between `%c' and `%c'"
14108 org-highest-priority org-lowest-priority))))
14111 (1- current) ; normal cycling
14112 ;; last priority was empty
14113 (if (eq last-command this-command)
14114 org-lowest-priority ; wrap around empty to lowest
14116 (if org-priority-start-cycle-with-default
14117 org-default-priority
14118 (1- org-default-priority))))))
14121 (1+ current) ; normal cycling
14122 ;; last priority was empty
14123 (if (eq last-command this-command)
14124 org-highest-priority ; wrap around empty to highest
14126 (if org-priority-start-cycle-with-default
14127 org-default-priority
14128 (1+ org-default-priority))))))
14129 (t (user-error "Invalid action")))
14130 (if (or (< (upcase new) org-highest-priority)
14131 (> (upcase new) org-lowest-priority))
14132 (if (and (memq action '(up down))
14133 (not have) (not (eq last-command this-command)))
14134 ;; `new' is from default priority
14136 "The default can not be set, see `org-default-priority' why")
14137 ;; normal cycling: `new' is beyond highest/lowest priority
14138 ;; and is wrapped around to the empty priority
14140 (setq news (format "%c" new))
14143 (replace-match "" t t nil 1)
14144 (replace-match news t t nil 2))
14146 (user-error "No priority cookie found in line")
14147 (let ((case-fold-search nil))
14148 (looking-at org-todo-line-regexp))
14151 (goto-char (match-end 2))
14152 (insert " [#" news "]"))
14153 (goto-char (match-beginning 3))
14154 (insert "[#" news "] "))))
14155 (org-set-tags nil 'align))
14157 (message "Priority removed")
14158 (message "Priority of current item set to %s" news)))))
14160 (defun org-show-priority ()
14161 "Show the priority of the current item.
14162 This priority is composed of the main priority given with the [#A] cookies,
14163 and by additional input from the age of a schedules or deadline entry."
14165 (let ((pri (if (eq major-mode 'org-agenda-mode)
14166 (org-get-at-bol 'priority)
14169 (beginning-of-line)
14170 (and (looking-at org-heading-regexp)
14171 (org-get-priority (match-string 0))))))))
14172 (message "Priority is %d" (if pri pri -1000))))
14174 (defun org-get-priority (s)
14175 "Find priority cookie and return priority."
14177 (if (functionp org-get-priority-function)
14178 (funcall org-get-priority-function)
14179 (if (not (string-match org-priority-regexp s))
14180 (* 1000 (- org-lowest-priority org-default-priority))
14181 (* 1000 (- org-lowest-priority
14182 (string-to-char (match-string 2 s))))))))
14186 (defvar org-agenda-archives-mode)
14187 (defvar org-map-continue-from nil
14188 "Position from where mapping should continue.
14189 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14191 (defvar org-scanner-tags nil
14192 "The current tag list while the tags scanner is running.")
14193 (defvar org-trust-scanner-tags nil
14194 "Should `org-get-tags-at' use the tags for the scanner.
14195 This is for internal dynamical scoping only.
14196 When this is non-nil, the function `org-get-tags-at' will return the value
14197 of `org-scanner-tags' instead of building the list by itself. This
14198 can lead to large speed-ups when the tags scanner is used in a file with
14199 many entries, and when the list of tags is retrieved, for example to
14200 obtain a list of properties. Building the tags list for each entry in such
14201 a file becomes an N^2 operation - but with this variable set, it scales
14204 (defun org-scan-tags (action matcher todo-only &optional start-level)
14205 "Scan headline tags with inheritance and produce output ACTION.
14207 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14208 or `agenda' to produce an entry list for an agenda view. It can also be
14209 a Lisp form or a function that should be called at each matched headline, in
14210 this case the return value is a list of all return values from these calls.
14212 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14213 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14214 only lines with a not-done TODO keyword are included in the output.
14215 This should be the same variable that was scoped into
14216 and set by `org-make-tags-matcher' when it constructed MATCHER.
14218 START-LEVEL can be a string with asterisks, reducing the scope to
14219 headlines matching this string."
14220 (require 'org-agenda)
14221 (let* ((re (concat "^"
14223 ;; Get the correct level to match
14224 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14225 org-outline-regexp)
14227 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14228 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14229 (props (list 'face 'default
14230 'done-face 'org-agenda-done
14231 'undone-face 'default
14232 'mouse-face 'highlight
14233 'org-not-done-regexp org-not-done-regexp
14234 'org-todo-regexp org-todo-regexp
14235 'org-complex-heading-regexp org-complex-heading-regexp
14237 (format "mouse-2 or RET jump to org file %s"
14238 (abbreviate-file-name
14239 (or (buffer-file-name (buffer-base-buffer))
14240 (buffer-name (buffer-base-buffer)))))))
14241 (org-map-continue-from nil)
14242 lspos tags tags-list
14243 (tags-alist (list (cons 0 org-file-tags)))
14244 (llast 0) rtn rtn1 level category i txt
14245 todo marker entry priority)
14246 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14247 (setq action (list 'lambda nil action)))
14249 (goto-char (point-min))
14250 (when (eq action 'sparse-tree)
14252 (org-remove-occur-highlights))
14253 (while (let (case-fold-search)
14254 (re-search-forward re nil t))
14255 (setq org-map-continue-from nil)
14257 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14258 tags (if (match-end 4) (org-match-string-no-properties 4)))
14259 (goto-char (setq lspos (match-beginning 0)))
14260 (setq level (org-reduced-level (org-outline-level))
14261 category (org-get-category))
14262 (setq i llast llast level)
14263 ;; remove tag lists from same and sublevels
14264 (while (>= i level)
14265 (when (setq entry (assoc i tags-alist))
14266 (setq tags-alist (delete entry tags-alist)))
14268 ;; add the next tags
14270 (setq tags (org-split-string tags ":")
14272 (cons (cons level tags) tags-alist)))
14273 ;; compile tags for current headline
14275 (if org-use-tag-inheritance
14276 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14278 org-scanner-tags tags-list)
14279 (when org-use-tag-inheritance
14280 (setcdr (car tags-alist)
14281 (mapcar (lambda (x)
14282 (setq x (copy-sequence x))
14283 (org-add-prop-inherited x))
14284 (cdar tags-alist))))
14285 (when (and tags org-use-tag-inheritance
14286 (or (not (eq t org-use-tag-inheritance))
14287 org-tags-exclude-from-inheritance))
14288 ;; selective inheritance, remove uninherited ones
14289 (setcdr (car tags-alist)
14290 (org-remove-uninherited-tags (cdar tags-alist))))
14293 ;; eval matcher only when the todo condition is OK
14294 (and (or (not todo-only) (member todo org-not-done-keywords))
14295 (let ((case-fold-search t) (org-trust-scanner-tags t))
14298 ;; Call the skipper, but return t if it does not skip,
14299 ;; so that the `and' form continues evaluating
14301 (unless (eq action 'sparse-tree) (org-agenda-skip))
14304 ;; Check if timestamps are deselecting this entry
14305 (or (not todo-only)
14306 (and (member todo org-not-done-keywords)
14307 (or (not org-agenda-tags-todo-honor-ignore-options)
14308 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14310 ;; select this headline
14312 ((eq action 'sparse-tree)
14313 (and org-highlight-sparse-tree-matches
14314 (org-get-heading) (match-end 0)
14315 (org-highlight-new-match
14316 (match-beginning 1) (match-end 1)))
14317 (org-show-context 'tags-tree))
14318 ((eq action 'agenda)
14319 (setq txt (org-agenda-format-item
14322 (if (eq org-tags-match-list-sublevels 'indented)
14323 (make-string (1- level) ?.) "")
14327 priority (org-get-priority txt))
14329 (setq marker (org-agenda-new-marker))
14330 (org-add-props txt props
14331 'org-marker marker 'org-hd-marker marker 'org-category category
14333 'priority priority 'type "tagsmatch")
14335 ((functionp action)
14336 (setq org-map-continue-from nil)
14338 (setq rtn1 (funcall action))
14340 (t (user-error "Invalid action")))
14342 ;; if we are to skip sublevels, jump to end of subtree
14343 (unless org-tags-match-list-sublevels
14344 (org-end-of-subtree t)
14345 (backward-char 1))))
14346 ;; Get the correct position from where to continue
14347 (if org-map-continue-from
14348 (goto-char org-map-continue-from)
14349 (and (= (point) lspos) (end-of-line 1)))))
14350 (when (and (eq action 'sparse-tree)
14351 (not org-sparse-tree-open-archived-trees))
14352 (org-hide-archived-subtrees (point-min) (point-max)))
14355 (defun org-remove-uninherited-tags (tags)
14356 "Remove all tags that are not inherited from the list TAGS."
14358 ((eq org-use-tag-inheritance t)
14359 (if org-tags-exclude-from-inheritance
14360 (org-delete-all org-tags-exclude-from-inheritance tags)
14362 ((not org-use-tag-inheritance) nil)
14363 ((stringp org-use-tag-inheritance)
14366 (if (and (string-match org-use-tag-inheritance x)
14367 (not (member x org-tags-exclude-from-inheritance)))
14370 ((listp org-use-tag-inheritance)
14373 (if (member x org-use-tag-inheritance) x nil))
14376 (defun org-match-sparse-tree (&optional todo-only match)
14377 "Create a sparse tree according to tags string MATCH.
14378 MATCH can contain positive and negative selection of tags, like
14379 \"+WORK+URGENT-WITHBOSS\".
14380 If optional argument TODO-ONLY is non-nil, only select lines that are
14383 (org-agenda-prepare-buffers (list (current-buffer)))
14384 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14386 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14388 (defvar org-cached-props nil)
14389 (defun org-cached-entry-get (pom property)
14390 (if (or (eq t org-use-property-inheritance)
14391 (and (stringp org-use-property-inheritance)
14392 (let ((case-fold-search t))
14393 (org-string-match-p org-use-property-inheritance property)))
14394 (and (listp org-use-property-inheritance)
14395 (member-ignore-case property org-use-property-inheritance)))
14396 ;; Caching is not possible, check it directly.
14397 (org-entry-get pom property 'inherit)
14398 ;; Get all properties, so we can do complicated checks easily.
14399 (cdr (assoc-string property
14400 (or org-cached-props
14401 (setq org-cached-props (org-entry-properties pom)))
14404 (defun org-global-tags-completion-table (&optional files)
14405 "Return the list of all tags in all agenda buffer/files.
14406 Optional FILES argument is a list of files which can be used
14407 instead of the agenda files."
14414 (set-buffer (find-file-noselect file))
14415 (append (org-get-buffer-tags)
14416 (mapcar (lambda (x) (if (stringp (car-safe x))
14417 (list (car-safe x)) nil))
14419 (if (and files (car files))
14421 (org-agenda-files))))))))
14423 (defun org-make-tags-matcher (match)
14424 "Create the TAGS/TODO matcher form for the selection string MATCH.
14426 The variable `todo-only' is scoped dynamically into this function.
14427 It will be set to t if the matcher restricts matching to TODO entries,
14428 otherwise will not be touched.
14430 Returns a cons of the selection string MATCH and the constructed
14431 lisp form implementing the matcher. The matcher is to be evaluated
14432 at an Org entry, with point on the headline, and returns t if the
14433 entry matches the selection string MATCH. The returned lisp form
14434 references two variables with information about the entry, which
14435 must be bound around the form's evaluation: todo, the TODO keyword
14436 at the entry (or nil of none); and tags-list, the list of all tags
14437 at the entry including inherited ones. Additionally, the category
14438 of the entry (if any) must be specified as the text property
14439 'org-category on the headline.
14441 See also `org-scan-tags'.
14443 (declare (special todo-only))
14444 (unless (boundp 'todo-only)
14445 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14447 ;; Get a new match request, with completion against the global
14448 ;; tags table and the local tags in current buffer
14449 (let ((org-last-tags-completion-table
14451 (delq nil (append (org-get-buffer-tags)
14452 (org-global-tags-completion-table))))))
14453 (setq match (org-completing-read-no-i
14454 "Match: " 'org-tags-completion-function nil nil nil
14455 'org-tags-history))))
14457 ;; Parse the string and create a lisp form
14458 (let ((match0 match)
14459 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14461 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14462 orterms term orlist re-p str-p level-p level-op time-p
14463 prop-p pn pv po gv rest (start 0) (ss 0))
14464 ;; Expand group tags
14465 (setq match (org-tags-expand match))
14467 ;; Check if there is a TODO part of this match, which would be the
14468 ;; part after a "/". TO make sure that this slash is not part of
14469 ;; a property value to be matched against, we also check that there
14470 ;; is no " after that slash.
14471 ;; First, find the last slash
14472 (while (string-match "/+" match ss)
14473 (setq start (match-beginning 0) ss (match-end 0)))
14474 (if (and (string-match "/+" match start)
14475 (not (save-match-data (string-match "\"" match start))))
14476 ;; match contains also a todo-matching request
14478 (setq tagsmatch (substring match 0 (match-beginning 0))
14479 todomatch (substring match (match-end 0)))
14480 (if (string-match "^!" todomatch)
14481 (setq todo-only t todomatch (substring todomatch 1)))
14482 (if (string-match "^\\s-*$" todomatch)
14483 (setq todomatch nil)))
14484 ;; only matching tags
14485 (setq tagsmatch match todomatch nil))
14487 ;; Make the tags matcher
14488 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14489 (setq tagsmatcher t)
14490 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14491 (while (setq term (pop orterms))
14492 (while (and (equal (substring term -1) "\\") orterms)
14493 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14494 (while (string-match re term)
14495 (setq rest (substring term (match-end 0))
14496 minus (and (match-end 1)
14497 (equal (match-string 1 term) "-"))
14498 tag (save-match-data (replace-regexp-in-string
14500 (match-string 2 term)))
14501 re-p (equal (string-to-char tag) ?{)
14502 level-p (match-end 4)
14503 prop-p (match-end 5)
14505 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14507 (setq level-op (org-op-to-function (match-string 3 term)))
14508 `(,level-op level ,(string-to-number
14509 (match-string 4 term))))
14511 (setq pn (match-string 5 term)
14512 po (match-string 6 term)
14513 pv (match-string 7 term)
14514 re-p (equal (string-to-char pv) ?{)
14515 str-p (equal (string-to-char pv) ?\")
14516 time-p (save-match-data
14517 (string-match "^\"[[<].*[]>]\"$" pv))
14518 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14519 (if time-p (setq pv (org-matcher-time pv)))
14520 (setq po (org-op-to-function po (if time-p 'time str-p)))
14522 ((equal pn "CATEGORY")
14523 (setq gv '(get-text-property (point) 'org-category)))
14527 (setq gv `(org-cached-entry-get nil ,pn))))
14530 `(not (string-match ,pv (or ,gv "")))
14531 `(string-match ,pv (or ,gv "")))
14533 `(,po (or ,gv "") ,pv)
14534 `(,po (string-to-number (or ,gv ""))
14535 ,(string-to-number pv) ))))
14536 (t `(member ,tag tags-list)))
14537 mm (if minus (list 'not mm) mm)
14539 (push mm tagsmatcher))
14540 (push (if (> (length tagsmatcher) 1)
14541 (cons 'and tagsmatcher)
14544 (setq tagsmatcher nil))
14545 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14547 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14548 ;; Make the todo matcher
14549 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14550 (setq todomatcher t)
14551 (setq orterms (org-split-string todomatch "|") orlist nil)
14552 (while (setq term (pop orterms))
14553 (while (string-match re term)
14554 (setq minus (and (match-end 1)
14555 (equal (match-string 1 term) "-"))
14556 kwd (match-string 2 term)
14557 re-p (equal (string-to-char kwd) ?{)
14558 term (substring term (match-end 0))
14560 `(string-match ,(substring kwd 1 -1) todo)
14561 (list 'equal 'todo kwd))
14562 mm (if minus (list 'not mm) mm))
14563 (push mm todomatcher))
14564 (push (if (> (length todomatcher) 1)
14565 (cons 'and todomatcher)
14568 (setq todomatcher nil))
14569 (setq todomatcher (if (> (length orlist) 1)
14570 (cons 'or orlist) (car orlist))))
14572 ;; Return the string and lisp forms of the matcher
14573 (setq matcher (if todomatcher
14574 (list 'and tagsmatcher todomatcher)
14577 (setq matcher (list 'and '(member todo org-not-done-keywords)
14579 (cons match0 matcher)))
14581 (defun org-tags-expand (match &optional single-as-list downcased)
14582 "Expand group tags in MATCH.
14584 This replaces every group tag in MATCH with a regexp tag search.
14585 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14586 will be replaced like this:
14588 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14589 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14590 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14592 Replacing by a regexp preserves the structure of the match.
14593 E.g., this expansion
14595 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14597 will match anything tagged with \"Lab\" and \"Home\", or tagged
14598 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14600 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14601 assumed to be a single group tag, and the function will return
14602 the list of tags in this group.
14604 When DOWNCASE is non-nil, expand downcased TAGS."
14606 (let* ((case-fold-search t)
14607 (stable org-mode-syntax-table)
14608 (tal (or org-tag-groups-alist-for-agenda
14609 org-tag-groups-alist))
14611 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14612 (tml (mapcar 'car tal))
14613 (rtnmatch match) rpl)
14614 ;; @ and _ are allowed as word-components in tags
14615 (modify-syntax-entry ?@ "w" stable)
14616 (modify-syntax-entry ?_ "w" stable)
14618 (with-syntax-table stable
14620 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14621 (regexp-opt tml) "\\>\\)") rtnmatch)))
14622 (let* ((dir (match-string 1 rtnmatch))
14623 (tag (match-string 2 rtnmatch))
14624 (tag (if downcased (downcase tag) tag)))
14625 (setq tml (delete tag tml))
14626 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14627 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14628 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14629 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14630 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14632 (or (reverse rpl) (list rtnmatch))
14634 (if single-as-list (list (if downcased (downcase match) match))
14637 (defun org-op-to-function (op &optional stringp)
14638 "Turn an operator into the appropriate function."
14641 ((equal op "<" ) '(< string< org-time<))
14642 ((equal op ">" ) '(> org-string> org-time>))
14643 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14644 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14645 ((member op '("=" "==")) '(= string= org-time=))
14646 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14647 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14649 (defun org<> (a b) (not (= a b)))
14650 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14651 (defun org-string>= (a b) (not (string< a b)))
14652 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14653 (defun org-string<> (a b) (not (string= a b)))
14654 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14655 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14656 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14657 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14658 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14659 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14661 "Convert S to a floating point time.
14662 If S is already a number, just return it. If it is a string, parse
14663 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14667 (condition-case nil
14668 (float-time (apply 'encode-time (org-parse-time-string s)))
14672 (defun org-time-today ()
14673 "Time in seconds today at 0:00.
14674 Returns the float number of seconds since the beginning of the
14675 epoch to the beginning of today (00:00)."
14676 (float-time (apply 'encode-time
14677 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14679 (defun org-matcher-time (s)
14680 "Interpret a time comparison value."
14683 ((string= s "<now>") (float-time))
14684 ((string= s "<today>") (org-time-today))
14685 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14686 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14687 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14688 (+ (org-time-today)
14689 (* (string-to-number (match-string 1 s))
14690 (cdr (assoc (match-string 2 s)
14691 '(("d" . 86400.0) ("w" . 604800.0)
14692 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14695 (defun org-match-any-p (re list)
14696 "Does re match any element of list?"
14697 (setq list (mapcar (lambda (x) (string-match re x)) list))
14700 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14701 (defvar org-tags-overlay (make-overlay 1 1))
14702 (org-detach-overlay org-tags-overlay)
14704 (defun org-get-local-tags-at (&optional pos)
14705 "Get a list of tags defined in the current headline."
14706 (org-get-tags-at pos 'local))
14708 (defun org-get-local-tags ()
14709 "Get a list of tags defined in the current headline."
14710 (org-get-tags-at nil 'local))
14712 (defun org-get-tags-at (&optional pos local)
14713 "Get a list of all headline tags applicable at POS.
14714 POS defaults to point. If tags are inherited, the list contains
14715 the targets in the same sequence as the headlines appear, i.e.
14716 the tags of the current headline come last.
14717 When LOCAL is non-nil, only return tags from the current headline,
14718 ignore inherited ones."
14720 (if (and org-trust-scanner-tags
14721 (or (not pos) (equal pos (point)))
14724 (let (tags ltags lastpos parent)
14728 (goto-char (or pos (point)))
14731 (condition-case nil
14733 (org-back-to-heading t)
14734 (while (not (equal lastpos (point)))
14735 (setq lastpos (point))
14737 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14738 (setq ltags (org-split-string
14739 (org-match-string-no-properties 1) ":"))
14741 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14744 (org-remove-uninherited-tags ltags)
14747 (or org-use-tag-inheritance (throw 'done t))
14748 (if local (throw 'done t))
14749 (or (org-up-heading-safe) (error nil))
14754 (reverse (delete-dups
14756 (org-remove-uninherited-tags
14757 org-file-tags) tags)))))))))
14759 (defun org-add-prop-inherited (s)
14760 (add-text-properties 0 (length s) '(inherited t) s)
14763 (defun org-toggle-tag (tag &optional onoff)
14764 "Toggle the tag TAG for the current line.
14765 If ONOFF is `on' or `off', don't toggle but set to this state."
14768 (org-back-to-heading t)
14769 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14772 (setq current (match-string 1))
14773 (replace-match ""))
14775 (setq current (nreverse (org-split-string current ":")))
14779 (or (member tag current) (push tag current)))
14781 (or (not (member tag current)) (setq current (delete tag current))))
14782 (t (if (member tag current)
14783 (setq current (delete tag current))
14785 (push tag current))))
14789 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14790 (org-set-tags nil t))
14791 (delete-horizontal-space))
14792 (run-hooks 'org-after-tags-change-hook))
14795 (defun org-align-tags-here (to-col)
14796 ;; Assumes that this is a headline
14797 "Align tags on the current headline to TO-COL."
14798 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14799 (beginning-of-line 1)
14800 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14801 (< pos (match-beginning 2)))
14803 (setq tags-l (- (match-end 2) (match-beginning 2)))
14804 (goto-char (match-beginning 1))
14806 (delete-region (point) (1+ (match-beginning 2)))
14807 (setq ncol (max (current-column)
14811 (- (abs to-col) tags-l))))
14813 (insert (make-string (- ncol (current-column)) ?\ ))
14814 (setq ncol (current-column))
14815 (when indent-tabs-mode (tabify p (point-at-eol)))
14816 (org-move-to-column (min ncol col)))
14819 (defun org-set-tags-command (&optional arg just-align)
14820 "Call the set-tags command for the current entry."
14822 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14823 (org-set-tags arg just-align)
14825 (unless (and (org-region-active-p)
14826 org-loop-over-headlines-in-active-region)
14827 (org-back-to-heading t))
14828 (org-set-tags arg just-align))))
14830 (defun org-set-tags-to (data)
14831 "Set the tags of the current entry to DATA, replacing the current tags.
14832 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14833 If DATA is nil or the empty string, any tags will be removed."
14834 (interactive "sTags: ")
14838 ((equal data "") "")
14840 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14843 (concat ":" (mapconcat 'identity data ":") ":"))))
14846 (org-back-to-heading t)
14847 (when (looking-at org-complex-heading-regexp)
14850 (goto-char (match-beginning 5))
14852 (delete-region (point) (point-at-eol))
14853 (org-set-tags nil 'align))
14854 (goto-char (point-at-eol))
14856 (org-set-tags nil 'align)))
14857 (beginning-of-line 1)
14858 (if (looking-at ".*?\\([ \t]+\\)$")
14859 (delete-region (match-beginning 1) (match-end 1))))))
14861 (defun org-align-all-tags ()
14862 "Align the tags i all headings."
14865 (or (ignore-errors (org-back-to-heading t))
14866 (outline-next-heading))
14867 (if (org-at-heading-p)
14869 (message "No headings"))))
14871 (defvar org-indent-indentation-per-level)
14872 (defun org-set-tags (&optional arg just-align)
14873 "Set the tags for the current headline.
14874 With prefix ARG, realign all tags in headings in the current buffer.
14875 When JUST-ALIGN is non-nil, only align tags."
14877 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14878 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14879 'region-start-level 'region))
14880 org-loop-over-headlines-in-active-region)
14882 ;; We don't use ARG and JUST-ALIGN here because these args
14883 ;; are not useful when looping over headlines.
14885 org-loop-over-headlines-in-active-region
14886 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14887 (let* ((re org-outline-regexp-bol)
14888 (current (unless arg (org-get-tags-string)))
14889 (col (current-column))
14890 (org-setting-tags t)
14891 table current-tags inherited-tags ; computed below when needed
14892 tags p0 c0 c1 rpl di tc level)
14895 (goto-char (point-min))
14896 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14897 (while (re-search-forward re nil t)
14898 (org-set-tags nil t)
14900 (message "All tags realigned to column %d" org-tags-column))
14902 (setq tags current)
14903 ;; Get a new set of tags from the user
14905 (setq table (append org-tag-persistent-alist
14906 (or org-tag-alist (org-get-buffer-tags))
14908 org-complete-tags-always-offer-all-agenda-tags
14909 (org-global-tags-completion-table
14910 (org-agenda-files))))
14911 org-last-tags-completion-table table
14912 current-tags (org-split-string current ":")
14913 inherited-tags (nreverse
14914 (nthcdr (length current-tags)
14915 (nreverse (org-get-tags-at))))
14917 (if (or (eq t org-use-fast-tag-selection)
14918 (and org-use-fast-tag-selection
14919 (delq nil (mapcar 'cdr table))))
14920 (org-fast-tag-selection
14921 current-tags inherited-tags table
14922 (if org-fast-tag-selection-include-todo
14923 org-todo-key-alist))
14924 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14926 (org-icompleting-read "Tags: "
14927 'org-tags-completion-function
14928 nil nil current 'org-tags-history))))))
14929 (while (string-match "[-+&]+" tags)
14930 ;; No boolean logic, just a list
14931 (setq tags (replace-match ":" t t tags))))
14933 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14935 (if org-tags-sort-function
14936 (setq tags (mapconcat 'identity
14937 (sort (org-split-string
14938 tags (org-re "[^[:alnum:]_@#%]+"))
14939 org-tags-sort-function) ":")))
14941 (if (string-match "\\`[\t ]*\\'" tags)
14943 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14944 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14946 ;; Insert new tags at the correct column
14947 (beginning-of-line 1)
14948 (setq level (or (and (looking-at org-outline-regexp)
14949 (- (match-end 0) (point) 1))
14952 ((and (equal current "") (equal tags "")))
14953 ((re-search-forward
14954 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14956 (if (equal tags "")
14958 (goto-char (match-beginning 0))
14959 (setq c0 (current-column)
14960 ;; compute offset for the case of org-indent-mode active
14961 di (if (org-bound-and-true-p org-indent-mode)
14962 (* (1- org-indent-indentation-per-level) (1- level))
14964 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14965 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14966 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
14967 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14968 (replace-match rpl t t)
14969 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14971 (t (error "Tags alignment failed")))
14972 (org-move-to-column col)
14974 (run-hooks 'org-after-tags-change-hook))))))
14976 (defun org-change-tag-in-region (beg end tag off)
14977 "Add or remove TAG for each entry in the region.
14978 This works in the agenda, and also in an org-mode buffer."
14980 (list (region-beginning) (region-end)
14981 (let ((org-last-tags-completion-table
14982 (if (derived-mode-p 'org-mode)
14984 (delq nil (append (org-get-buffer-tags)
14985 (org-global-tags-completion-table))))
14986 (org-global-tags-completion-table))))
14987 (org-icompleting-read
14988 "Tag: " 'org-tags-completion-function nil nil nil
14989 'org-tags-history))
14991 (message "[s]et or
[r]emove? ")
14992 (equal (read-char-exclusive) ?r))))
14993 (if (fboundp 'deactivate-mark) (deactivate-mark))
14994 (let ((agendap (equal major-mode 'org-agenda-mode))
14995 l1 l2 m buf pos newhead (cnt 0))
14997 (setq l2 (1- (org-current-line)))
14999 (setq l1 (org-current-line))
15000 (loop for l from l1 to l2 do
15002 (setq m (get-text-property (point) 'org-hd-marker))
15003 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15005 (setq buf (if agendap (marker-buffer m) (current-buffer))
15006 pos (if agendap m (point)))
15007 (with-current-buffer buf
15011 (setq cnt (1+ cnt))
15012 (org-toggle-tag tag (if off 'off 'on))
15013 (setq newhead (org-get-heading)))))
15014 (and agendap (org-agenda-change-all-lines newhead m))))
15015 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15017 (defun org-tags-completion-function (string predicate &optional flag)
15018 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15019 (confirm (lambda (x) (stringp (car x)))))
15020 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15021 (setq s1 (match-string 1 string)
15022 s2 (match-string 2 string))
15023 (setq s1 "" s2 string))
15027 (setq rtn (try-completion s2 ctable confirm))
15030 (concat s1 s2 (substring rtn (length s2))
15031 (if (and org-add-colon-after-tag-completion
15032 (assoc rtn ctable))
15037 (all-completions s2 ctable confirm))
15040 (assoc s2 ctable)))))
15042 (defun org-fast-tag-insert (kwd tags face &optional end)
15043 "Insert KDW, and the TAGS, the latter with face FACE.
15045 (insert (format "%-12s" (concat kwd ":"))
15046 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15049 (defun org-fast-tag-show-exit (flag)
15052 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15053 (replace-match ""))
15056 (org-move-to-column (- (window-width) 19) t)
15057 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15059 (defun org-set-current-tags-overlay (current prefix)
15060 "Add an overlay to CURRENT tag with PREFIX."
15061 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15062 (if (featurep 'xemacs)
15063 (org-overlay-display org-tags-overlay (concat prefix s)
15064 'secondary-selection)
15065 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15066 (org-overlay-display org-tags-overlay (concat prefix s)))))
15068 (defvar org-last-tag-selection-key nil)
15069 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15070 "Fast tag selection with single keys.
15071 CURRENT is the current list of tags in the headline, INHERITED is the
15072 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15073 possibly with grouping information. TODO-TABLE is a similar table with
15074 TODO keywords, should these have keys assigned to them.
15075 If the keys are nil, a-z are automatically assigned.
15076 Returns the new tags string, or nil to not change the current settings."
15077 (let* ((fulltable (append table todo-table))
15078 (maxlen (apply 'max (mapcar
15080 (if (stringp (car x)) (string-width (car x)) 0))
15082 (buf (current-buffer))
15083 (expert (eq org-fast-tag-selection-single-key 'expert))
15085 (fwidth (+ maxlen 3 1 3))
15086 (ncol (/ (- (window-width) 4) fwidth))
15089 tg cnt e c char c1 c2 ntable tbl rtn
15090 ov-start ov-end ov-prefix
15091 (exit-after-next org-fast-tag-selection-single-key)
15092 (done-keywords org-done-keywords)
15095 (beginning-of-line 1)
15097 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15098 (setq ov-start (match-beginning 1)
15099 ov-end (match-end 1)
15101 (setq ov-start (1- (point-at-eol))
15102 ov-end (1+ ov-start))
15103 (skip-chars-forward "^\n\r")
15106 (buffer-substring (1- (point)) (point))
15107 (if (> (current-column) org-tags-column)
15109 (make-string (- org-tags-column (current-column)) ?\ ))))))
15110 (move-overlay org-tags-overlay ov-start ov-end)
15111 (save-window-excursion
15113 (set-buffer (get-buffer-create " *Org tags*"))
15114 (delete-other-windows)
15115 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15116 (org-switch-to-buffer-other-window " *Org tags*"))
15118 (org-set-local 'org-done-keywords done-keywords)
15119 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15120 (org-fast-tag-insert "Current" current c-face "\n\n")
15121 (org-fast-tag-show-exit exit-after-next)
15122 (org-set-current-tags-overlay current ov-prefix)
15123 (setq tbl fulltable char ?a cnt 0)
15124 (while (setq e (pop tbl))
15126 ((equal (car e) :startgroup)
15127 (push '() groups) (setq ingroup t)
15128 (when (not (= cnt 0))
15131 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15132 ((equal (car e) :endgroup)
15133 (setq ingroup nil cnt 0)
15134 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15135 ((equal e '(:newline))
15136 (when (not (= cnt 0))
15140 (while (equal (car tbl) '(:newline))
15142 (setq tbl (cdr tbl)))))
15143 ((equal e '(:grouptags)) nil)
15145 (setq tg (copy-sequence (car e)) c2 nil)
15148 ;; automatically assign a character.
15149 (setq c1 (string-to-char
15150 (downcase (substring
15151 tg (if (= (string-to-char tg) ?@) 1 0)))))
15152 (if (or (rassoc c1 ntable) (rassoc c1 table))
15153 (while (or (rassoc char ntable) (rassoc char table))
15154 (setq char (1+ char)))
15156 (setq c (or c2 char)))
15157 (if ingroup (push tg (car groups)))
15158 (setq tg (org-add-props tg nil 'face
15160 ((not (assoc tg table))
15161 (org-get-todo-face tg))
15162 ((member tg current) c-face)
15163 ((member tg inherited) i-face))))
15164 (if (equal (caar tbl) :grouptags)
15165 (org-add-props tg nil 'face 'org-tag-group))
15166 (if (and (= cnt 0) (not ingroup)) (insert " "))
15167 (insert "[" c "] " tg (make-string
15168 (- fwidth 4 (length tg)) ?\ ))
15169 (push (cons tg c) ntable)
15170 (when (= (setq cnt (1+ cnt)) ncol)
15172 (if ingroup (insert " "))
15174 (setq ntable (nreverse ntable))
15176 (goto-char (point-min))
15177 (if (not expert) (org-fit-window-to-buffer))
15181 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15182 (if (not groups) "no " "")
15183 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15184 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15185 (setq org-last-tag-selection-key c)
15187 ((= c ?\r) (throw 'exit t))
15189 (setq groups (not groups))
15190 (goto-char (point-min))
15191 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15194 (org-fast-tag-show-exit
15195 (setq exit-after-next (not exit-after-next)))
15197 (delete-other-windows)
15198 (set-window-buffer (split-window-vertically) " *Org tags*")
15199 (org-switch-to-buffer-other-window " *Org tags*")
15200 (org-fit-window-to-buffer)))
15202 (and (= c ?q) (not (rassoc c ntable))))
15203 (org-detach-overlay org-tags-overlay)
15204 (setq quit-flag t))
15207 (if exit-after-next (setq exit-after-next 'now)))
15209 (condition-case nil
15210 (setq tg (org-icompleting-read
15213 (with-current-buffer buf
15214 (org-get-buffer-tags)))))
15215 (quit (setq tg "")))
15216 (when (string-match "\\S-" tg)
15217 (add-to-list 'buffer-tags (list tg))
15218 (if (member tg current)
15219 (setq current (delete tg current))
15220 (push tg current)))
15221 (if exit-after-next (setq exit-after-next 'now)))
15222 ((setq e (rassoc c todo-table) tg (car e))
15223 (with-current-buffer buf
15224 (save-excursion (org-todo tg)))
15225 (if exit-after-next (setq exit-after-next 'now)))
15226 ((setq e (rassoc c ntable) tg (car e))
15227 (if (member tg current)
15228 (setq current (delete tg current))
15229 (loop for g in groups do
15232 (setq current (delete x current)))
15235 (if exit-after-next (setq exit-after-next 'now))))
15237 ;; Create a sorted list
15241 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15242 (if (eq exit-after-next 'now) (throw 'exit t))
15243 (goto-char (point-min))
15244 (beginning-of-line 2)
15245 (delete-region (point) (point-at-eol))
15246 (org-fast-tag-insert "Current" current c-face)
15247 (org-set-current-tags-overlay current ov-prefix)
15248 (while (re-search-forward
15249 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15250 (setq tg (match-string 1))
15251 (add-text-properties
15252 (match-beginning 1) (match-end 1)
15255 ((member tg current) c-face)
15256 ((member tg inherited) i-face)
15257 (t (get-text-property (match-beginning 1) 'face))))))
15258 (goto-char (point-min)))))
15259 (org-detach-overlay org-tags-overlay)
15261 (mapconcat 'identity current ":")
15264 (defun org-get-tags-string ()
15265 "Get the TAGS string in the current headline."
15266 (unless (org-at-heading-p t)
15267 (user-error "Not on a heading"))
15269 (beginning-of-line 1)
15270 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15271 (org-match-string-no-properties 1)
15274 (defun org-get-tags ()
15275 "Get the list of tags specified in the current headline."
15276 (org-split-string (org-get-tags-string) ":"))
15278 (defun org-get-buffer-tags ()
15279 "Get a table of all tags used in the buffer, for completion."
15280 (org-with-wide-buffer
15281 (goto-char (point-min))
15282 (let ((tag-re (concat org-outline-regexp-bol
15283 "\\(?:.*?[ \t]\\)?"
15284 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15286 (while (re-search-forward tag-re nil t)
15287 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15289 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15291 ;;;; The mapping API
15293 (defun org-map-entries (func &optional match scope &rest skip)
15294 "Call FUNC at each headline selected by MATCH in SCOPE.
15296 FUNC is a function or a lisp form. The function will be called without
15297 arguments, with the cursor positioned at the beginning of the headline.
15298 The return values of all calls to the function will be collected and
15299 returned as a list.
15301 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15302 does not need to preserve point. After evaluation, the cursor will be
15303 moved to the end of the line (presumably of the headline of the
15304 processed entry) and search continues from there. Under some
15305 circumstances, this may not produce the wanted results. For example,
15306 if you have removed (e.g. archived) the current (sub)tree it could
15307 mean that the next entry will be skipped entirely. In such cases, you
15308 can specify the position from where search should continue by making
15309 FUNC set the variable `org-map-continue-from' to the desired buffer
15312 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15313 Only headlines that are matched by this query will be considered during
15314 the iteration. When MATCH is nil or t, all headlines will be
15315 visited by the iteration.
15317 SCOPE determines the scope of this command. It can be any of:
15319 nil The current buffer, respecting the restriction if any
15320 tree The subtree started with the entry at point
15321 region The entries within the active region, if any
15323 The entries within the active region, but only those at
15324 the same level than the first one.
15325 file The current buffer, without restriction
15327 The current buffer, and any archives associated with it
15328 agenda All agenda files
15329 agenda-with-archives
15330 All agenda files with any archive files associated with them
15332 If this is a list, all files in the list will be scanned
15334 The remaining args are treated as settings for the skipping facilities of
15335 the scanner. The following items can be given here:
15337 archive skip trees with the archive tag
15338 comment skip trees with the COMMENT keyword
15339 function or Emacs Lisp form:
15340 will be used as value for `org-agenda-skip-function', so
15341 whenever the function returns a position, FUNC will not be
15342 called for that entry and search will continue from the
15345 If your function needs to retrieve the tags including inherited tags
15346 at the *current* entry, you can use the value of the variable
15347 `org-scanner-tags' which will be much faster than getting the value
15348 with `org-get-tags-at'. If your function gets properties with
15349 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15350 to t around the call to `org-entry-properties' to get the same speedup.
15351 Note that if your function moves around to retrieve tags and properties at
15352 a *different* entry, you cannot use these techniques."
15353 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15354 (not (org-region-active-p)))
15355 (let* ((org-agenda-archives-mode nil) ; just to make sure
15356 (org-agenda-skip-archived-trees (memq 'archive skip))
15357 (org-agenda-skip-comment-trees (memq 'comment skip))
15358 (org-agenda-skip-function
15359 (car (org-delete-all '(comment archive) skip)))
15360 (org-tags-match-list-sublevels t)
15361 (start-level (eq scope 'region-start-level))
15363 org-todo-keywords-for-agenda
15364 org-done-keywords-for-agenda
15365 org-todo-keyword-alist-for-agenda
15366 org-tag-alist-for-agenda
15370 ((eq match t) (setq matcher t))
15371 ((eq match nil) (setq matcher t))
15372 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15376 (cond ((eq scope 'tree)
15377 (org-back-to-heading t)
15378 (org-narrow-to-subtree)
15380 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15381 (org-region-active-p))
15382 ;; If needed, set start-level to a string like "2"
15385 (goto-char (region-beginning))
15386 (unless (org-at-heading-p) (outline-next-heading))
15387 (setq start-level (org-current-level))))
15388 (narrow-to-region (region-beginning)
15390 (goto-char (region-end))
15391 (unless (and (bolp) (org-at-heading-p))
15392 (outline-next-heading))
15398 (org-agenda-prepare-buffers
15399 (list (buffer-file-name (current-buffer))))
15400 (setq res (org-scan-tags func matcher todo-only start-level)))
15401 ;; Get the right scope
15403 ((and scope (listp scope) (symbolp (car scope)))
15404 (setq scope (eval scope)))
15405 ((eq scope 'agenda)
15406 (setq scope (org-agenda-files t)))
15407 ((eq scope 'agenda-with-archives)
15408 (setq scope (org-agenda-files t))
15409 (setq scope (org-add-archive-files scope)))
15411 (setq scope (list (buffer-file-name))))
15412 ((eq scope 'file-with-archives)
15413 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15414 (org-agenda-prepare-buffers scope)
15415 (while (setq file (pop scope))
15416 (with-current-buffer (org-find-base-buffer-visiting file)
15420 (goto-char (point-min))
15421 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15426 (defconst org-special-properties
15427 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15428 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15429 "The special properties valid in Org mode.
15430 These are properties that are not defined in the property drawer,
15431 but in some other way.")
15433 (defconst org-default-properties
15434 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15435 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15436 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15437 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15438 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15439 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15440 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15441 "Some properties that are used by Org mode for various purposes.
15442 Being in this list makes sure that they are offered for completion.")
15444 (defun org--update-property-plist (key val props)
15445 "Associate KEY to VAL in alist PROPS.
15446 Modifications are made by side-effect. Return new alist."
15447 (let* ((appending (string= (substring key -1) "+"))
15448 (key (if appending (substring key 0 -1) key))
15449 (old (assoc-string key props t)))
15450 (if (not old) (cons (cons key val) props)
15451 (setcdr old (if appending (concat (cdr old) " " val) val))
15454 (defun org-get-property-block (&optional beg force)
15455 "Return the (beg . end) range of the body of the property drawer.
15456 BEG is the beginning of the current subtree, or of the part
15457 before the first headline. If it is not given, it will be found.
15458 If the drawer does not exist, create it if FORCE is non-nil, or
15460 (org-with-wide-buffer
15461 (when beg (goto-char beg))
15462 (unless (org-before-first-heading-p)
15463 (let ((beg (cond (beg)
15464 ((or (not (featurep 'org-inlinetask))
15465 (org-inlinetask-in-task-p))
15466 (org-back-to-heading t))
15467 (t (org-with-limited-levels (org-back-to-heading t))))))
15469 (when (org-looking-at-p org-planning-line-re) (forward-line))
15470 (cond ((looking-at org-property-drawer-re)
15472 (cons (point) (progn (goto-char (match-end 0))
15473 (line-beginning-position))))
15476 (org-insert-property-drawer)
15477 (let ((pos (save-excursion (search-forward ":END:")
15478 (line-beginning-position))))
15479 (cons pos pos))))))))
15481 (defun org-at-property-p ()
15482 "Non-nil when point is inside a property drawer.
15483 See `org-property-re' for match data, if applicable."
15485 (beginning-of-line)
15486 (and (looking-at org-property-re)
15487 (let ((property-drawer (save-match-data (org-get-property-block))))
15488 (and property-drawer (< (point) (cdr property-drawer)))))))
15490 (defun org-property-action ()
15491 "Do an action on properties."
15493 (unless (org-at-property-p) (user-error "Not at a property"))
15494 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15495 (let ((c (read-char-exclusive)))
15497 (?s (call-interactively #'org-set-property))
15498 (?d (call-interactively #'org-delete-property))
15499 (?D (call-interactively #'org-delete-property-globally))
15500 (?c (call-interactively #'org-compute-property-at-point))
15501 (otherwise (user-error "No such property action %c" c)))))
15503 (defun org-inc-effort ()
15504 "Increment the value of the effort property in the current entry."
15506 (org-set-effort nil t))
15508 (defvar org-clock-effort) ; Defined in org-clock.el.
15509 (defvar org-clock-current-task) ; Defined in org-clock.el.
15510 (defun org-set-effort (&optional value increment)
15511 "Set the effort property of the current entry.
15512 With numerical prefix arg, use the nth allowed value, 0 stands for the
15513 10th allowed value.
15515 When INCREMENT is non-nil, set the property to the next allowed value."
15517 (if (equal value 0) (setq value 10))
15518 (let* ((completion-ignore-case t)
15519 (prop org-effort-property)
15520 (cur (org-entry-get nil prop))
15521 (allowed (org-property-get-allowed-values nil prop 'table))
15522 (existing (mapcar 'list (org-property-values prop)))
15523 (heading (nth 4 (org-heading-components)))
15526 ((stringp value) value)
15527 ((and allowed (integerp value))
15528 (or (car (nth (1- value) allowed))
15529 (car (org-last allowed))))
15530 ((and allowed increment)
15531 (or (caadr (member (list cur) allowed))
15532 (user-error "Allowed effort values are not set")))
15534 (message "Select 1-9,0, [RET%s]: %s"
15535 (if cur (concat "=" cur) "")
15536 (mapconcat 'car allowed " "))
15537 (setq rpl (read-char-exclusive))
15538 (if (equal rpl ?\r)
15540 (setq rpl (- rpl ?0))
15541 (if (equal rpl 0) (setq rpl 10))
15542 (if (and (> rpl 0) (<= rpl (length allowed)))
15543 (car (nth (1- rpl) allowed))
15544 (org-completing-read "Effort: " allowed nil))))
15546 (let (org-completion-use-ido org-completion-use-iswitchb)
15547 (org-completing-read
15548 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15549 (concat "[" cur "]") "")
15551 existing nil nil "" nil cur))))))
15552 (unless (equal (org-entry-get nil prop) val)
15553 (org-entry-put nil prop val))
15554 (org-refresh-property
15555 '((effort . identity)
15556 (effort-minutes . org-duration-string-to-minutes))
15558 (when (string= heading org-clock-current-task)
15559 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15560 (org-clock-update-mode-line))
15561 (message "%s is now %s" prop val)))
15563 (defun org-entry-properties (&optional pom which)
15564 "Get all properties of the current entry.
15566 When POM is a buffer position, get all properties from the entry
15569 This includes the TODO keyword, the tags, time strings for
15570 deadline, scheduled, and clocking, and any additional properties
15571 defined in the entry.
15573 If WHICH is nil or `all', get all properties. If WHICH is
15574 `special' or `standard', only get that subclass. If WHICH is
15575 a string, only get that property.
15577 Return value is an alist. Keys are properties, as upcased
15579 (org-with-point-at pom
15580 (when (and (derived-mode-p 'org-mode)
15581 (ignore-errors (org-back-to-heading t)))
15583 (let* ((beg (point))
15584 (specific (and (stringp which) (upcase which)))
15585 (which (cond ((not specific) which)
15586 ((member specific org-special-properties) 'special)
15589 ;; Get the special properties, like TODO and TAGS.
15590 (when (memq which '(nil all special))
15591 (when (or (not specific) (string= specific "CLOCKSUM"))
15592 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15594 (push (cons "CLOCKSUM"
15595 (org-columns-number-to-string
15596 (/ (float clocksum) 60.) 'add_times))
15598 (when specific (throw 'exit props)))
15599 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15600 (let ((clocksumt (get-text-property (point)
15601 :org-clock-minutes-today)))
15603 (push (cons "CLOCKSUM_T"
15604 (org-columns-number-to-string
15605 (/ (float clocksumt) 60.) 'add_times))
15607 (when specific (throw 'exit props)))
15608 (when (or (not specific) (string= specific "ITEM"))
15609 (when (looking-at org-complex-heading-regexp)
15612 (org-match-string-no-properties 1)
15613 (let ((title (org-match-string-no-properties 4)))
15614 (when (org-string-nw-p title)
15615 (concat " " (org-remove-tabs title))))))
15617 (when specific (throw 'exit props)))
15618 (when (or (not specific) (string= specific "TODO"))
15619 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15620 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15621 (when specific (throw 'exit props)))
15622 (when (or (not specific) (string= specific "PRIORITY"))
15623 (when (looking-at org-priority-regexp)
15624 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15625 (when specific (throw 'exit props)))
15626 (when (or (not specific) (string= specific "FILE"))
15627 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15629 (when specific (throw 'exit props)))
15630 (when (or (not specific) (string= specific "TAGS"))
15631 (let ((value (org-string-nw-p (org-get-tags-string))))
15632 (when value (push (cons "TAGS" value) props)))
15633 (when specific (throw 'exit props)))
15634 (when (or (not specific) (string= specific "ALLTAGS"))
15635 (let ((value (org-get-tags-at)))
15637 (push (cons "ALLTAGS"
15638 (format ":%s:" (mapconcat #'identity value ":")))
15640 (when specific (throw 'exit props)))
15641 (when (or (not specific) (string= specific "BLOCKED"))
15642 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15643 (when specific (throw 'exit props)))
15644 (when (or (not specific)
15645 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15647 (when (org-looking-at-p org-planning-line-re)
15649 (let ((bol (line-beginning-position))
15650 ;; Backward compatibility: time keywords used to
15651 ;; be configurable (before 8.3). Make sure we
15652 ;; get the correct keyword.
15653 (key-assoc `(("CLOSED" . ,org-closed-string)
15654 ("DEADLINE" . ,org-deadline-string)
15655 ("SCHEDULED" . ,org-scheduled-string))))
15656 (dolist (pair (if specific (list (assoc specific key-assoc))
15659 (when (search-backward (cdr pair) bol t)
15660 (goto-char (match-end 0))
15661 (skip-chars-forward " \t")
15662 (and (looking-at org-ts-regexp-both)
15663 (push (cons (car pair)
15664 (org-match-string-no-properties 0))
15666 (when specific (throw 'exit props)))
15667 (when (or (not specific)
15668 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15671 (let ((regexp (if (or (string= specific "TIMESTAMP")
15672 (assoc "TIMESTAMP_IA" ts))
15674 org-ts-regexp-both)))
15676 (while (re-search-forward regexp end t)
15678 (let ((object (org-element-context)))
15679 ;; Accept to match timestamps in node
15680 ;; properties, too.
15681 (when (memq (org-element-type object)
15682 '(node-property timestamp))
15684 (org-element-property :type object)))
15686 ((and (memq type '(active active-range))
15687 (not (equal specific "TIMESTAMP_IA")))
15688 (unless (assoc "TIMESTAMP" ts)
15689 (push (cons "TIMESTAMP"
15690 (org-element-property
15691 :raw-value object))
15693 (when specific (throw 'exit ts))))
15694 ((and (memq type '(inactive inactive-range))
15695 (not (string= specific "TIMESTAMP")))
15696 (unless (assoc "TIMESTAMP_IA" ts)
15697 (push (cons "TIMESTAMP_IA"
15698 (org-element-property
15699 :raw-value object))
15701 (when specific (throw 'exit ts))))))
15702 ;; Both timestamp types are found,
15703 ;; move to next part.
15704 (when (= (length ts) 2) (throw 'next ts)))))
15707 ;; First look for timestamps within headline.
15708 (let ((ts (funcall find-ts (line-end-position) nil)))
15709 (if (= (length ts) 2) (setq props (nconc ts props))
15711 ;; Then find timestamps in the section, skipping
15713 (when (org-looking-at-p org-planning-line-re)
15715 (let ((end (save-excursion (outline-next-heading))))
15716 (setq props (nconc (funcall find-ts end ts) props))))))))
15717 ;; Get the standard properties, like :PROP:.
15718 (when (memq which '(nil all standard))
15719 ;; If we are looking after a specific property, delegate
15720 ;; to `org-entry-get', which is faster. However, make an
15721 ;; exception for "CATEGORY", since it can be also set
15722 ;; through keywords (i.e. #+CATEGORY).
15723 (if (and specific (not (equal specific "CATEGORY")))
15724 (let ((value (org-entry-get beg specific nil t)))
15725 (throw 'exit (and value (list (cons specific value)))))
15726 (let ((range (org-get-property-block beg)))
15728 (let ((end (cdr range)) seen-base)
15729 (goto-char (car range))
15730 ;; Unlike to `org--update-property-plist', we
15731 ;; handle the case where base values is found
15732 ;; after its extension. We also forbid standard
15733 ;; properties to be named as special properties.
15734 (while (re-search-forward org-property-re end t)
15735 (let* ((key (upcase (org-match-string-no-properties 2)))
15736 (extendp (org-string-match-p "\\+\\'" key))
15737 (key-base (if extendp (substring key 0 -1) key))
15738 (value (org-match-string-no-properties 3)))
15740 ((member-ignore-case key-base org-special-properties))
15743 (org--update-property-plist key value props)))
15744 ((member key seen-base))
15745 (t (push key seen-base)
15746 (let ((p (assoc-string key props t)))
15747 (if p (setcdr p (concat value " " (cdr p)))
15748 (push (cons key value) props))))))))))))
15749 (unless (assoc "CATEGORY" props)
15750 (push (cons "CATEGORY" (org-get-category beg)) props)
15751 (when (string= specific "CATEGORY") (throw 'exit props)))
15753 (append (get-text-property beg 'org-summaries) props))))))
15755 (defun org-entry-get (pom property &optional inherit literal-nil)
15756 "Get value of PROPERTY for entry or content at point-or-marker POM.
15758 If INHERIT is non-nil and the entry does not have the property,
15759 then also check higher levels of the hierarchy. If INHERIT is
15760 the symbol `selective', use inheritance only if the setting in
15761 `org-use-property-inheritance' selects PROPERTY for inheritance.
15763 If the property is present but empty, the return value is the
15764 empty string. If the property is not present at all, nil is
15765 returned. In any other case, return the value as a string.
15766 Search is case-insensitive.
15768 If LITERAL-NIL is set, return the string value \"nil\" as
15769 a string, do not interpret it as the list atom nil. This is used
15770 for inheritance when a \"nil\" value can supersede a non-nil
15771 value higher up the hierarchy."
15772 (org-with-point-at pom
15775 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15776 (org-entry-get-with-inheritance property literal-nil))
15777 ((member-ignore-case property org-special-properties)
15778 ;; We need a special property. Use `org-entry-properties' to
15779 ;; retrieve it, but specify the wanted property.
15780 (cdr (assoc-string property (org-entry-properties nil property))))
15782 (let ((range (org-get-property-block)))
15784 (let* ((case-fold-search t)
15788 (or (assoc-string property org-file-properties t)
15789 (assoc-string property org-global-properties t)
15791 property org-global-properties-fixed t))))
15792 ;; Make sure to not re-use GLOBAL as
15793 ;; `org--update-property-plist' would alter it by
15795 (and global (list (cons property (cdr global))))))
15798 (when (re-search-forward (org-re-property key nil t) end t)
15800 (org--update-property-plist
15801 key (org-match-string-no-properties 3) props))))))
15802 (goto-char (car range))
15803 ;; Find base value.
15804 (save-excursion (funcall find-value property))
15805 ;; Find additional values.
15806 (let ((property+ (concat property "+")))
15807 (while (funcall find-value property+)))
15808 ;; Return final value.
15809 (let ((val (cdr (assoc-string property props t))))
15810 (if literal-nil val (org-not-nil val))))))))))
15812 (defun org-property-or-variable-value (var &optional inherit)
15813 "Check if there is a property fixing the value of VAR.
15814 If yes, return this value. If not, return the current value of the variable."
15815 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15816 (if (and prop (stringp prop) (string-match "\\S-" prop))
15818 (symbol-value var))))
15820 (defun org-entry-delete (pom property)
15821 "Delete the property PROPERTY from entry at point-or-marker POM."
15822 (unless (member property org-special-properties)
15823 (org-with-point-at pom
15824 (let ((range (org-get-property-block)))
15826 (let ((begin (car range))
15827 (end (copy-marker (cdr range))))
15829 (when (re-search-forward (org-re-property property nil t) end t)
15830 (delete-region (match-beginning 0) (line-beginning-position 2))
15831 ;; If drawer is empty, remove it altogether.
15832 (when (= begin end)
15833 (delete-region (line-beginning-position 0)
15834 (line-beginning-position 2)))
15835 (set-marker end nil))))))))
15837 ;; Multi-values properties are properties that contain multiple values
15838 ;; These values are assumed to be single words, separated by whitespace.
15839 (defun org-entry-add-to-multivalued-property (pom property value)
15840 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15841 (let* ((old (org-entry-get pom property))
15842 (values (and old (org-split-string old "[ \t]"))))
15843 (setq value (org-entry-protect-space value))
15844 (unless (member value values)
15845 (setq values (append values (list value)))
15846 (org-entry-put pom property
15847 (mapconcat 'identity values " ")))))
15849 (defun org-entry-remove-from-multivalued-property (pom property value)
15850 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15851 (let* ((old (org-entry-get pom property))
15852 (values (and old (org-split-string old "[ \t]"))))
15853 (setq value (org-entry-protect-space value))
15854 (when (member value values)
15855 (setq values (delete value values))
15856 (org-entry-put pom property
15857 (mapconcat 'identity values " ")))))
15859 (defun org-entry-member-in-multivalued-property (pom property value)
15860 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15861 (let* ((old (org-entry-get pom property))
15862 (values (and old (org-split-string old "[ \t]"))))
15863 (setq value (org-entry-protect-space value))
15864 (member value values)))
15866 (defun org-entry-get-multivalued-property (pom property)
15867 "Return a list of values in a multivalued property."
15868 (let* ((value (org-entry-get pom property))
15869 (values (and value (org-split-string value "[ \t]"))))
15870 (mapcar 'org-entry-restore-space values)))
15872 (defun org-entry-put-multivalued-property (pom property &rest values)
15873 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15874 VALUES should be a list of strings. Spaces will be protected."
15875 (org-entry-put pom property
15876 (mapconcat 'org-entry-protect-space values " "))
15877 (let* ((value (org-entry-get pom property))
15878 (values (and value (org-split-string value "[ \t]"))))
15879 (mapcar 'org-entry-restore-space values)))
15881 (defun org-entry-protect-space (s)
15882 "Protect spaces and newline in string S."
15883 (while (string-match " " s)
15884 (setq s (replace-match "%20" t t s)))
15885 (while (string-match "\n" s)
15886 (setq s (replace-match "%0A" t t s)))
15889 (defun org-entry-restore-space (s)
15890 "Restore spaces and newline in string S."
15891 (while (string-match "%20" s)
15892 (setq s (replace-match " " t t s)))
15893 (while (string-match "%0A" s)
15894 (setq s (replace-match "\n" t t s)))
15897 (defvar org-entry-property-inherited-from (make-marker)
15898 "Marker pointing to the entry from where a property was inherited.
15899 Each call to `org-entry-get-with-inheritance' will set this marker to the
15900 location of the entry where the inheritance search matched. If there was
15901 no match, the marker will point nowhere.
15902 Note that also `org-entry-get' calls this function, if the INHERIT flag
15905 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15906 "Get PROPERTY of entry or content at point, search higher levels if needed.
15907 The search will stop at the first ancestor which has the property defined.
15908 If the value found is \"nil\", return nil to show that the property
15909 should be considered as undefined (this is the meaning of nil here).
15910 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15911 (move-marker org-entry-property-inherited-from nil)
15913 (org-with-wide-buffer
15916 (when (setq value (org-entry-get nil property nil literal-nil))
15917 (org-back-to-heading t)
15918 (move-marker org-entry-property-inherited-from (point))
15920 (or (org-up-heading-safe) (throw 'exit nil)))))
15923 (cdr (or (assoc-string property org-file-properties t)
15924 (assoc-string property org-global-properties t)
15925 (assoc-string property org-global-properties-fixed t)))))
15926 (if literal-nil value (org-not-nil value))))
15928 (defvar org-property-changed-functions nil
15929 "Hook called when the value of a property has changed.
15930 Each hook function should accept two arguments, the name of the property
15931 and the new value.")
15933 (defun org-entry-put (pom property value)
15934 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15936 If the value is `nil', it is converted to the empty string. If
15937 it is not a string, an error is raised.
15939 PROPERTY can be any regular property (see
15940 `org-special-properties'). It can also be \"TODO\",
15941 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
15943 For the last two properties, VALUE may have any of the special
15944 values \"earlier\" and \"later\". The function then increases or
15945 decreases scheduled or deadline date by one day."
15946 (cond ((null value) (setq value ""))
15947 ((not (stringp value)) (error "Properties values should be strings")))
15948 (org-with-point-at pom
15949 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
15950 (org-back-to-heading t)
15951 (org-with-limited-levels (org-back-to-heading t)))
15952 (let ((beg (point)))
15954 ((equal property "TODO")
15955 (cond ((not (org-string-nw-p value)) (setq value 'none))
15956 ((not (member value org-todo-keywords-1))
15957 (user-error "\"%s\" is not a valid TODO state" value)))
15959 (org-set-tags nil 'align))
15960 ((equal property "PRIORITY")
15961 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
15962 (org-set-tags nil 'align))
15963 ((equal property "SCHEDULED")
15965 (if (and (org-looking-at-p org-planning-line-re)
15967 org-scheduled-time-regexp (line-end-position) t))
15968 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15969 ((string= value "later") (org-timestamp-change 1 'day))
15970 ((string= value "") (org-schedule '(4)))
15971 (t (org-schedule nil value)))
15972 (if (member value '("earlier" "later" ""))
15973 (call-interactively #'org-schedule)
15974 (org-schedule nil value))))
15975 ((equal property "DEADLINE")
15977 (if (and (org-looking-at-p org-planning-line-re)
15979 org-deadline-time-regexp (line-end-position) t))
15980 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15981 ((string= value "later") (org-timestamp-change 1 'day))
15982 ((string= value "") (org-deadline '(4)))
15983 (t (org-deadline nil value)))
15984 (if (member value '("earlier" "later" ""))
15985 (call-interactively #'org-deadline)
15986 (org-deadline nil value))))
15987 ((member property org-special-properties)
15988 (error "The %s property cannot be set with `org-entry-put'" property))
15990 (let* ((range (org-get-property-block beg 'force))
15992 (case-fold-search t))
15993 (goto-char (car range))
15994 (if (re-search-forward (org-re-property property nil t) end t)
15995 (progn (delete-region (match-beginning 0) (match-end 0))
15996 (goto-char (match-beginning 0)))
16000 (insert ":" property ":")
16001 (when value (insert " " value))
16002 (org-indent-line)))))
16003 (run-hook-with-args 'org-property-changed-functions property value)))
16005 (defun org-buffer-property-keys (&optional specials defaults columns)
16006 "Get all property keys in the current buffer.
16008 When SPECIALS is non-nil, also list the special properties that
16009 reflect things like tags and TODO state.
16011 When DEFAULTS is non-nil, also include properties that has
16012 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16013 DESCRIPTION, LOCATION, and LOGGING and others.
16015 When COLUMNS in non-nil, also include property names given in
16016 COLUMN formats in the current buffer."
16017 (let ((case-fold-search t)
16019 (and specials org-special-properties)
16020 (and defaults (cons org-effort-property org-default-properties))
16022 (org-with-wide-buffer
16023 (goto-char (point-min))
16024 (while (re-search-forward org-property-start-re nil t)
16025 (let ((range (org-get-property-block)))
16028 (when (and (not (org-before-first-heading-p))
16029 (y-or-n-p (format "Malformed drawer at %d, repair?"
16030 (line-beginning-position))))
16031 (org-get-property-block nil t))
16033 (goto-char (car range))
16034 (let ((begin (car range))
16036 ;; Make sure that found property block is not located
16037 ;; before current point, as it would generate an infloop.
16038 ;; It can happen, for example, in the following
16045 ;; *************** Inlinetask
16050 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16051 (while (< (point) end)
16052 (let ((p (progn (looking-at org-property-re)
16053 (org-match-string-no-properties 2))))
16054 ;; Only add true property name, not extension symbol.
16055 (add-to-list 'props
16056 (if (not (org-string-match-p "\\+\\'" p)) p
16057 (substring p 0 -1))))
16059 (outline-next-heading)))
16061 (goto-char (point-min))
16062 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16063 (let ((element (org-element-at-point)))
16064 (when (memq (org-element-type element) '(keyword node-property))
16065 (let ((value (org-element-property :value element))
16067 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16068 (setq start (match-end 0))
16069 (let ((p (org-match-string-no-properties 1 value)))
16070 (unless (member-ignore-case p org-special-properties)
16071 (add-to-list 'props p))))))))))
16072 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16074 (defun org-property-values (key)
16075 "List all non-nil values of property KEY in current buffer."
16076 (org-with-wide-buffer
16077 (goto-char (point-min))
16078 (let ((case-fold-search t)
16079 (re (org-re-property key))
16081 (while (re-search-forward re nil t)
16082 (add-to-list 'values (org-entry-get (point) key)))
16085 (defun org-insert-property-drawer ()
16086 "Insert a property drawer into the current entry."
16087 (org-with-wide-buffer
16088 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16089 (org-back-to-heading t)
16090 (org-with-limited-levels (org-back-to-heading t)))
16092 (when (org-looking-at-p org-planning-line-re) (forward-line))
16093 (unless (org-looking-at-p org-property-drawer-re)
16094 (let ((inhibit-read-only t))
16095 (unless (bolp) (insert "\n"))
16096 (let ((begin (point)))
16097 (insert ":PROPERTIES:\n:END:\n")
16098 (org-indent-region begin (point)))))))
16100 (defun org-insert-drawer (&optional arg drawer)
16101 "Insert a drawer at point.
16103 When optional argument ARG is non-nil, insert a property drawer.
16105 Optional argument DRAWER, when non-nil, is a string representing
16106 drawer's name. Otherwise, the user is prompted for a name.
16108 If a region is active, insert the drawer around that region
16111 Point is left between drawer's boundaries."
16113 (let* ((drawer (if arg "PROPERTIES"
16114 (or drawer (read-from-minibuffer "Drawer: ")))))
16116 ;; With C-u, fall back on `org-insert-property-drawer'
16117 (arg (org-insert-property-drawer))
16118 ;; Check validity of suggested drawer's name.
16119 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16120 (user-error "Invalid drawer name"))
16121 ;; With an active region, insert a drawer at point.
16122 ((not (org-region-active-p))
16124 (unless (bolp) (insert "\n"))
16125 (insert (format ":%s:\n\n:END:\n" drawer))
16126 (forward-line -2)))
16127 ;; Otherwise, insert the drawer at point
16129 (let ((rbeg (region-beginning))
16130 (rend (copy-marker (region-end))))
16134 (beginning-of-line)
16135 (when (save-excursion
16136 (re-search-forward org-outline-regexp-bol rend t))
16137 (user-error "Drawers cannot contain headlines"))
16138 ;; Position point at the beginning of the first
16139 ;; non-blank line in region. Insert drawer's opening
16140 ;; there, then indent it.
16141 (org-skip-whitespace)
16142 (beginning-of-line)
16143 (insert ":" drawer ":\n")
16145 (indent-for-tab-command)
16146 ;; Move point to the beginning of the first blank line
16147 ;; after the last non-blank line in region. Insert
16148 ;; drawer's closing, then indent it.
16150 (skip-chars-backward " \r\t\n")
16152 (deactivate-mark t)
16153 (indent-for-tab-command)
16154 (unless (eolp) (insert "\n")))
16155 ;; Clear marker, whatever the outcome of insertion is.
16156 (set-marker rend nil)))))))
16158 (defvar org-property-set-functions-alist nil
16159 "Property set function alist.
16160 Each entry should have the following format:
16162 (PROPERTY . READ-FUNCTION)
16164 The read function will be called with the same argument as
16165 `org-completing-read'.")
16167 (defun org-set-property-function (property)
16168 "Get the function that should be used to set PROPERTY.
16169 This is computed according to `org-property-set-functions-alist'."
16170 (or (cdr (assoc property org-property-set-functions-alist))
16171 'org-completing-read))
16173 (defun org-read-property-value (property)
16174 "Read PROPERTY value from user."
16175 (let* ((completion-ignore-case t)
16176 (allowed (org-property-get-allowed-values nil property 'table))
16177 (cur (org-entry-get nil property))
16178 (prompt (concat property " value"
16179 (if (and cur (string-match "\\S-" cur))
16180 (concat " [" cur "]") "") ": "))
16181 (set-function (org-set-property-function property))
16183 (funcall set-function prompt allowed nil
16184 (not (get-text-property 0 'org-unrestricted
16186 (let (org-completion-use-ido org-completion-use-iswitchb)
16187 (funcall set-function prompt
16188 (mapcar 'list (org-property-values property))
16189 nil nil "" nil cur)))))
16192 (defvar org-last-set-property nil)
16193 (defvar org-last-set-property-value nil)
16194 (defun org-read-property-name ()
16195 "Read a property name."
16196 (let* ((completion-ignore-case t)
16197 (keys (org-buffer-property-keys nil t t))
16198 (default-prop (or (save-excursion
16200 (beginning-of-line)
16201 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
16202 (null (string= (match-string 1) "END"))
16203 (match-string 1))))
16204 org-last-set-property))
16205 (property (org-icompleting-read
16207 (if default-prop (concat " [" default-prop "]") "")
16209 (mapcar 'list keys)
16212 (if (member property keys)
16214 (or (cdr (assoc (downcase property)
16215 (mapcar (lambda (x) (cons (downcase x) x))
16219 (defun org-set-property-and-value (use-last)
16220 "Allow to set [PROPERTY]: [value] direction from prompt.
16221 When use-default, don't even ask, just use the last
16222 \"[PROPERTY]: [value]\" string from the history."
16224 (let* ((completion-ignore-case t)
16225 (pv (or (and use-last org-last-set-property-value)
16226 (org-completing-read
16227 "Enter a \"[Property]: [value]\" pair: "
16228 nil nil nil nil nil
16229 org-last-set-property-value)))
16231 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16232 (setq prop (match-string 1 pv)
16233 val (match-string 2 pv))
16234 (org-set-property prop val))))
16236 (defun org-set-property (property value)
16237 "In the current entry, set PROPERTY to VALUE.
16238 When called interactively, this will prompt for a property name, offering
16239 completion on existing and default properties. And then it will prompt
16240 for a value, offering completion either on allowed values (via an inherited
16241 xxx_ALL property) or on existing values in other instances of this property
16242 in the current file."
16243 (interactive (list nil nil))
16244 (let* ((property (or property (org-read-property-name)))
16245 (value (or value (org-read-property-value property)))
16246 (fn (cdr (assoc property org-properties-postprocess-alist))))
16247 (setq org-last-set-property property)
16248 (setq org-last-set-property-value (concat property ": " value))
16249 ;; Possibly postprocess the inserted value:
16250 (when fn (setq value (funcall fn value)))
16251 (unless (equal (org-entry-get nil property) value)
16252 (org-entry-put nil property value))))
16254 (defun org-delete-property (property)
16255 "In the current entry, delete PROPERTY."
16257 (let* ((completion-ignore-case t)
16258 (cat (org-entry-get (point) "CATEGORY"))
16259 (props0 (org-entry-properties nil 'standard))
16260 (props (if cat props0
16261 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16262 (prop (if (< 1 (length props))
16263 (org-icompleting-read "Property: " props nil t)
16267 (message "No property to delete in this entry")
16268 (org-entry-delete nil property)
16269 (message "Property \"%s\" deleted" property)))
16271 (defun org-delete-property-globally (property)
16272 "Remove PROPERTY globally, from all entries."
16274 (let* ((completion-ignore-case t)
16275 (prop (org-icompleting-read
16276 "Globally remove property: "
16277 (mapcar 'list (org-buffer-property-keys)))))
16282 (goto-char (point-min))
16284 (while (re-search-forward
16285 (org-re-property property)
16287 (setq cnt (1+ cnt))
16288 (delete-region (match-beginning 0) (1+ (point-at-eol))))
16289 (message "Property \"%s\" removed from %d entries" property cnt)))))
16291 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16293 (defun org-compute-property-at-point ()
16294 "Compute the property at point.
16295 This looks for an enclosing column format, extracts the operator and
16296 then applies it to the property in the column format's scope."
16298 (unless (org-at-property-p)
16299 (user-error "Not at a property"))
16300 (let ((prop (org-match-string-no-properties 2)))
16301 (org-columns-get-format-and-top-level)
16302 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16303 (user-error "No operator defined for property %s" prop))
16304 (org-columns-compute prop)))
16306 (defvar org-property-allowed-value-functions nil
16307 "Hook for functions supplying allowed values for a specific property.
16308 The functions must take a single argument, the name of the property, and
16309 return a flat list of allowed values. If \":ETC\" is one of
16310 the values, this means that these values are intended as defaults for
16311 completion, but that other values should be allowed too.
16312 The functions must return nil if they are not responsible for this
16315 (defun org-property-get-allowed-values (pom property &optional table)
16316 "Get allowed values for the property PROPERTY.
16317 When TABLE is non-nil, return an alist that can directly be used for
16321 ((equal property "TODO")
16322 (setq vals (org-with-point-at pom
16323 (append org-todo-keywords-1 '("")))))
16324 ((equal property "PRIORITY")
16325 (let ((n org-lowest-priority))
16326 (while (>= n org-highest-priority)
16327 (push (char-to-string n) vals)
16329 ((member property org-special-properties))
16330 ((setq vals (run-hook-with-args-until-success
16331 'org-property-allowed-value-functions property)))
16333 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16334 (when (and vals (string-match "\\S-" vals))
16335 (setq vals (car (read-from-string (concat "(" vals ")"))))
16336 (setq vals (mapcar (lambda (x)
16337 (cond ((stringp x) x)
16338 ((numberp x) (number-to-string x))
16339 ((symbolp x) (symbol-name x))
16342 (when (member ":ETC" vals)
16343 (setq vals (remove ":ETC" vals))
16344 (org-add-props (car vals) '(org-unrestricted t)))
16345 (if table (mapcar 'list vals) vals)))
16347 (defun org-property-previous-allowed-value (&optional previous)
16348 "Switch to the next allowed value for this property."
16350 (org-property-next-allowed-value t))
16352 (defun org-property-next-allowed-value (&optional previous)
16353 "Switch to the next allowed value for this property."
16355 (unless (org-at-property-p)
16356 (user-error "Not at a property"))
16357 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16358 (key (match-string 2))
16359 (value (match-string 3))
16360 (allowed (or (org-property-get-allowed-values (point) key)
16361 (and (member value '("[ ]" "[-]" "[X]"))
16363 (heading (save-match-data (nth 4 (org-heading-components))))
16366 (user-error "Allowed values for this property have not been defined"))
16367 (if previous (setq allowed (reverse allowed)))
16368 (if (member value allowed)
16369 (setq nval (car (cdr (member value allowed)))))
16370 (setq nval (or nval (car allowed)))
16371 (if (equal nval value)
16372 (user-error "Only one allowed value for this property"))
16373 (org-at-property-p)
16374 (replace-match (concat " :" key ": " nval) t t)
16376 (beginning-of-line 1)
16377 (skip-chars-forward " \t")
16378 (when (equal prop org-effort-property)
16379 (org-refresh-property
16380 '((effort . identity)
16381 (effort-minutes . org-duration-string-to-minutes))
16383 (when (string= org-clock-current-task heading)
16384 (setq org-clock-effort nval)
16385 (org-clock-update-mode-line)))
16386 (run-hook-with-args 'org-property-changed-functions key nval)))
16388 (defun org-find-olp (path &optional this-buffer)
16389 "Return a marker pointing to the entry at outline path OLP.
16390 If anything goes wrong, throw an error.
16391 You can wrap this call to catch the error like this:
16393 (condition-case msg
16394 (org-mobile-locate-entry (match-string 4))
16395 (error (nth 1 msg)))
16397 The return value will then be either a string with the error message,
16398 or a marker if everything is OK.
16400 If THIS-BUFFER is set, the outline path does not contain a file,
16402 (let* ((file (if this-buffer buffer-file-name (pop path)))
16403 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16407 limit re end found pos heading cnt flevel)
16408 (unless buffer (error "File not found :%s" file))
16409 (with-current-buffer buffer
16413 (setq limit (point-max))
16414 (goto-char (point-min))
16415 (while (setq heading (pop path))
16416 (setq re (format org-complex-heading-regexp-format
16417 (regexp-quote heading)))
16418 (setq cnt 0 pos (point))
16419 (while (re-search-forward re end t)
16420 (setq level (- (match-end 1) (match-beginning 1)))
16421 (if (and (>= level lmin) (<= level lmax))
16422 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16423 (when (= cnt 0) (error "Heading not found on level %d: %s"
16425 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16428 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16429 (setq end (save-excursion (org-end-of-subtree t t))))
16430 (when (org-at-heading-p)
16431 (point-marker)))))))
16433 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16434 "Find node HEADING in BUFFER.
16435 Return a marker to the heading if it was found, or nil if not.
16436 If POS-ONLY is set, return just the position instead of a marker.
16438 The heading text must match exact, but it may have a TODO keyword,
16439 a priority cookie and tags in the standard locations."
16440 (with-current-buffer (or buffer (current-buffer))
16444 (goto-char (point-min))
16445 (let (case-fold-search)
16446 (if (re-search-forward
16447 (format org-complex-heading-regexp-format
16448 (regexp-quote heading)) nil t)
16450 (match-beginning 0)
16451 (move-marker (make-marker) (match-beginning 0)))))))))
16453 (defun org-find-exact-heading-in-directory (heading &optional dir)
16454 "Find Org node headline HEADING in all .org files in directory DIR.
16455 When the target headline is found, return a marker to this location."
16456 (let ((files (directory-files (or dir default-directory)
16457 t "\\`[^.#].*\\.org\\'"))
16458 file visiting m buffer)
16460 (while (setq file (pop files))
16461 (message "trying %s" file)
16462 (setq visiting (org-find-base-buffer-visiting file))
16463 (setq buffer (or visiting (find-file-noselect file)))
16464 (setq m (org-find-exact-headline-in-buffer
16466 (when (and (not m) (not visiting)) (kill-buffer buffer))
16467 (and m (throw 'found m))))))
16469 (defun org-find-entry-with-id (ident)
16470 "Locate the entry that contains the ID property with exact value IDENT.
16471 IDENT can be a string, a symbol or a number, this function will search for
16472 the string representation of it.
16473 Return the position where this entry starts, or nil if there is no such entry."
16474 (interactive "sID: ")
16476 ((stringp ident) ident)
16477 ((symbol-name ident) (symbol-name ident))
16478 ((numberp ident) (number-to-string ident))
16479 (t (error "IDENT %s must be a string, symbol or number" ident))))
16480 (case-fold-search nil))
16484 (goto-char (point-min))
16485 (when (re-search-forward
16486 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16488 (org-back-to-heading t)
16493 (defvar org-last-changed-timestamp nil)
16494 (defvar org-last-inserted-timestamp nil
16495 "The last time stamp inserted with `org-insert-time-stamp'.")
16496 (defvar org-ts-what) ; dynamically scoped parameter
16498 (defun org-time-stamp (arg &optional inactive)
16499 "Prompt for a date/time and insert a time stamp.
16500 If the user specifies a time like HH:MM or if this command is
16501 called with at least one prefix argument, the time stamp contains
16502 the date and the time. Otherwise, only the date is be included.
16504 All parts of a date not specified by the user is filled in from
16505 the current date/time. So if you just press return without
16506 typing anything, the time stamp will represent the current
16509 If there is already a timestamp at the cursor, it will be
16512 With two universal prefix arguments, insert an active timestamp
16513 with the current time without prompting the user.
16515 When called from lisp, the timestamp is inactive if INACTIVE is
16520 ;; Default time is either today, or, when entering a range,
16521 ;; the range start.
16522 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16524 (re-search-backward
16525 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16526 (- (point) 20) t)))
16527 (apply 'encode-time (org-parse-time-string (match-string 1)))
16529 (default-input (and ts (org-get-compact-tod ts)))
16530 (repeater (save-excursion
16532 (beginning-of-line)
16533 (when (re-search-forward
16534 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16535 (save-excursion (progn (end-of-line) (point))) t)
16536 (match-string 0)))))
16537 org-time-was-given org-end-time-was-given time)
16539 ((and (org-at-timestamp-p t)
16540 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16541 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16543 (setq time (let ((this-command this-command))
16544 (org-read-date arg 'totime nil nil
16545 default-time default-input inactive)))
16546 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16547 ((org-at-timestamp-p t)
16548 (setq time (let ((this-command this-command))
16549 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16550 (when (org-at-timestamp-p t) ; just to get the match data
16551 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16553 (setq org-last-changed-timestamp
16554 (org-insert-time-stamp
16555 time (or org-time-was-given arg)
16556 inactive nil nil (list org-end-time-was-given)))
16557 (when repeater (goto-char (1- (point))) (insert " " repeater)
16558 (setq org-last-changed-timestamp
16559 (concat (substring org-last-inserted-timestamp 0 -1)
16560 " " repeater ">"))))
16561 (message "Timestamp updated"))
16563 (org-insert-time-stamp (current-time) t inactive))
16565 (setq time (let ((this-command this-command))
16566 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16567 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16568 nil nil (list org-end-time-was-given))))))
16570 ;; FIXME: can we use this for something else, like computing time differences?
16571 (defun org-get-compact-tod (s)
16572 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16573 (let* ((t1 (match-string 1 s))
16574 (h1 (string-to-number (match-string 2 s)))
16575 (m1 (string-to-number (match-string 3 s)))
16576 (t2 (and (match-end 4) (match-string 5 s)))
16577 (h2 (and t2 (string-to-number (match-string 6 s))))
16578 (m2 (and t2 (string-to-number (match-string 7 s))))
16582 (setq dh (- h2 h1) dm (- m2 m1))
16583 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16584 (concat t1 "+" (number-to-string dh)
16585 (and (/= 0 dm) (format ":%02d" dm)))))))
16587 (defun org-time-stamp-inactive (&optional arg)
16588 "Insert an inactive time stamp.
16589 An inactive time stamp is enclosed in square brackets instead of angle
16590 brackets. It is inactive in the sense that it does not trigger agenda entries,
16591 does not link to the calendar and cannot be changed with the S-cursor keys.
16592 So these are more for recording a certain time/date."
16594 (org-time-stamp arg 'inactive))
16596 (defvar org-date-ovl (make-overlay 1 1))
16597 (overlay-put org-date-ovl 'face 'org-date-selected)
16598 (org-detach-overlay org-date-ovl)
16600 (defvar org-ans1) ; dynamically scoped parameter
16601 (defvar org-ans2) ; dynamically scoped parameter
16603 (defvar org-plain-time-of-day-regexp) ; defined below
16605 (defvar org-overriding-default-time nil) ; dynamically scoped
16606 (defvar org-read-date-overlay nil)
16607 (defvar org-dcst nil) ; dynamically scoped
16608 (defvar org-read-date-history nil)
16609 (defvar org-read-date-final-answer nil)
16610 (defvar org-read-date-analyze-futurep nil)
16611 (defvar org-read-date-analyze-forced-year nil)
16612 (defvar org-read-date-inactive)
16614 (defvar org-read-date-minibuffer-local-map
16615 (let* ((map (make-sparse-keymap)))
16616 (set-keymap-parent map minibuffer-local-map)
16617 (org-defkey map (kbd ".")
16618 (lambda () (interactive)
16619 ;; Are we at the beginning of the prompt?
16620 (if (looking-back "^[^:]+: ")
16621 (org-eval-in-calendar '(calendar-goto-today))
16623 (org-defkey map (kbd "C-.")
16624 (lambda () (interactive)
16625 (org-eval-in-calendar '(calendar-goto-today))))
16626 (org-defkey map [(meta shift left)]
16627 (lambda () (interactive)
16628 (org-eval-in-calendar '(calendar-backward-month 1))))
16629 (org-defkey map [(meta shift right)]
16630 (lambda () (interactive)
16631 (org-eval-in-calendar '(calendar-forward-month 1))))
16632 (org-defkey map [(meta shift up)]
16633 (lambda () (interactive)
16634 (org-eval-in-calendar '(calendar-backward-year 1))))
16635 (org-defkey map [(meta shift down)]
16636 (lambda () (interactive)
16637 (org-eval-in-calendar '(calendar-forward-year 1))))
16638 (org-defkey map [?\e (shift left)]
16639 (lambda () (interactive)
16640 (org-eval-in-calendar '(calendar-backward-month 1))))
16641 (org-defkey map [?\e (shift right)]
16642 (lambda () (interactive)
16643 (org-eval-in-calendar '(calendar-forward-month 1))))
16644 (org-defkey map [?\e (shift up)]
16645 (lambda () (interactive)
16646 (org-eval-in-calendar '(calendar-backward-year 1))))
16647 (org-defkey map [?\e (shift down)]
16648 (lambda () (interactive)
16649 (org-eval-in-calendar '(calendar-forward-year 1))))
16650 (org-defkey map [(shift up)]
16651 (lambda () (interactive)
16652 (org-eval-in-calendar '(calendar-backward-week 1))))
16653 (org-defkey map [(shift down)]
16654 (lambda () (interactive)
16655 (org-eval-in-calendar '(calendar-forward-week 1))))
16656 (org-defkey map [(shift left)]
16657 (lambda () (interactive)
16658 (org-eval-in-calendar '(calendar-backward-day 1))))
16659 (org-defkey map [(shift right)]
16660 (lambda () (interactive)
16661 (org-eval-in-calendar '(calendar-forward-day 1))))
16662 (org-defkey map "!"
16663 (lambda () (interactive)
16664 (org-eval-in-calendar '(diary-view-entries))
16666 (org-defkey map ">"
16667 (lambda () (interactive)
16668 (org-eval-in-calendar '(calendar-scroll-left 1))))
16669 (org-defkey map "<"
16670 (lambda () (interactive)
16671 (org-eval-in-calendar '(calendar-scroll-right 1))))
16672 (org-defkey map "\C-v"
16673 (lambda () (interactive)
16674 (org-eval-in-calendar
16675 '(calendar-scroll-left-three-months 1))))
16676 (org-defkey map "\M-v"
16677 (lambda () (interactive)
16678 (org-eval-in-calendar
16679 '(calendar-scroll-right-three-months 1))))
16681 "Keymap for minibuffer commands when using `org-read-date'.")
16684 (defvar org-defdecode)
16685 (defvar org-with-time)
16687 (defun org-read-date (&optional org-with-time to-time from-string prompt
16688 default-time default-input inactive)
16689 "Read a date, possibly a time, and make things smooth for the user.
16690 The prompt will suggest to enter an ISO date, but you can also enter anything
16691 which will at least partially be understood by `parse-time-string'.
16692 Unrecognized parts of the date will default to the current day, month, year,
16693 hour and minute. If this command is called to replace a timestamp at point,
16694 or to enter the second timestamp of a range, the default time is taken
16695 from the existing stamp. Furthermore, the command prefers the future,
16696 so if you are giving a date where the year is not given, and the day-month
16697 combination is already past in the current year, it will assume you
16698 mean next year. For details, see the manual. A few examples:
16700 3-2-5 --> 2003-02-05
16701 feb 15 --> currentyear-02-15
16702 2/15 --> currentyear-02-15
16703 sep 12 9 --> 2009-09-12
16704 12:45 --> today 12:45
16705 22 sept 0:34 --> currentyear-09-22 0:34
16706 12 --> currentyear-currentmonth-12
16707 Fri --> nearest Friday after today
16708 -Tue --> last Tuesday
16711 Furthermore you can specify a relative date by giving, as the *first* thing
16712 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16713 change in days weeks, months, years.
16714 With a single plus or minus, the date is relative to today. With a double
16715 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16716 +4d --> four days from today
16717 +4 --> same as above
16718 +2w --> two weeks from today
16719 ++5 --> five days from default date
16721 The function understands only English month and weekday abbreviations.
16723 While prompting, a calendar is popped up - you can also select the
16724 date with the mouse (button 1). The calendar shows a period of three
16725 months. To scroll it to other months, use the keys `>' and `<'.
16726 If you don't like the calendar, turn it off with
16727 \(setq org-read-date-popup-calendar nil)
16729 With optional argument TO-TIME, the date will immediately be converted
16730 to an internal time.
16731 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16732 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16733 still enter a time, and this function will inform the calling routine
16734 about this change. The calling routine may then choose to change the
16735 format used to insert the time stamp into the buffer to include the time.
16736 With optional argument FROM-STRING, read from this string instead from
16737 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16738 the time/date that is used for everything that is not specified by the
16740 (require 'parse-time)
16741 (let* ((org-time-stamp-rounding-minutes
16742 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16743 (org-dcst org-display-custom-times)
16744 (ct (org-current-time))
16745 (org-def (or org-overriding-default-time default-time ct))
16746 (org-defdecode (decode-time org-def))
16748 (when (< (nth 2 org-defdecode) org-extend-today-until)
16749 (setcar (nthcdr 2 org-defdecode) -1)
16750 (setcar (nthcdr 1 org-defdecode) 59)
16751 (setq org-def (apply 'encode-time org-defdecode)
16752 org-defdecode (decode-time org-def)))))
16753 (cur-frame (selected-frame))
16754 (mouse-autoselect-window nil) ; Don't let the mouse jump
16755 (calendar-frame-setup nil)
16756 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16757 (calendar-move-hook nil)
16758 (calendar-view-diary-initially-flag nil)
16759 (calendar-view-holidays-initially-flag nil)
16760 (timestr (format-time-string
16761 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16762 (prompt (concat (if prompt (concat prompt " ") "")
16763 (format "Date+time [%s]: " timestr)))
16764 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16767 (from-string (setq ans from-string))
16768 (org-read-date-popup-calendar
16770 (save-window-excursion
16772 (when (eq calendar-setup 'calendar-only)
16774 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16775 (select-frame cal-frame))
16776 (org-eval-in-calendar '(setq cursor-type nil) t)
16779 (calendar-forward-day (- (time-to-days org-def)
16780 (calendar-absolute-from-gregorian
16781 (calendar-current-date))))
16782 (org-eval-in-calendar nil t)
16783 (let* ((old-map (current-local-map))
16784 (map (copy-keymap calendar-mode-map))
16785 (minibuffer-local-map
16786 (copy-keymap org-read-date-minibuffer-local-map)))
16787 (org-defkey map (kbd "RET") 'org-calendar-select)
16788 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16789 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16792 (use-local-map map)
16793 (setq org-read-date-inactive inactive)
16794 (add-hook 'post-command-hook 'org-read-date-display)
16795 (setq org-ans0 (read-string prompt default-input
16796 'org-read-date-history nil))
16797 ;; org-ans0: from prompt
16798 ;; org-ans1: from mouse click
16799 ;; org-ans2: from calendar motion
16800 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16801 (remove-hook 'post-command-hook 'org-read-date-display)
16802 (use-local-map old-map)
16803 (when org-read-date-overlay
16804 (delete-overlay org-read-date-overlay)
16805 (setq org-read-date-overlay nil)))))
16806 (bury-buffer "*Calendar*")
16808 (delete-frame cal-frame)
16809 (select-frame-set-input-focus cur-frame))))))
16811 (t ; Naked prompt only
16813 (setq ans (read-string prompt default-input
16814 'org-read-date-history timestr))
16815 (when org-read-date-overlay
16816 (delete-overlay org-read-date-overlay)
16817 (setq org-read-date-overlay nil)))))
16819 (setq final (org-read-date-analyze ans org-def org-defdecode))
16821 (when org-read-date-analyze-forced-year
16822 (message "Year was forced into %s"
16823 (if org-read-date-force-compatible-dates
16824 "compatible range (1970-2037)"
16825 "range representable on this machine"))
16828 ;; One round trip to get rid of 34th of August and stuff like that....
16829 (setq final (decode-time (apply 'encode-time final)))
16831 (setq org-read-date-final-answer ans)
16834 (apply 'encode-time final)
16835 (if (and (boundp 'org-time-was-given) org-time-was-given)
16836 (format "%04d-%02d-%02d %02d:%02d"
16837 (nth 5 final) (nth 4 final) (nth 3 final)
16838 (nth 2 final) (nth 1 final))
16839 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16841 (defun org-read-date-display ()
16842 "Display the current date prompt interpretation in the minibuffer."
16843 (when org-read-date-display-live
16844 (when org-read-date-overlay
16845 (delete-overlay org-read-date-overlay))
16846 (when (minibufferp (current-buffer))
16849 (while (not (equal (buffer-substring
16850 (max (point-min) (- (point) 4)) (point))
16853 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16854 " " (or org-ans1 org-ans2)))
16855 (org-end-time-was-given nil)
16856 (f (org-read-date-analyze ans org-def org-defdecode))
16858 org-time-stamp-custom-formats
16859 org-time-stamp-formats))
16860 (fmt (if (or org-with-time
16861 (and (boundp 'org-time-was-given) org-time-was-given))
16864 (txt (format-time-string fmt (apply 'encode-time f)))
16865 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16866 (txt (concat "=> " txt)))
16867 (when (and org-end-time-was-given
16868 (string-match org-plain-time-of-day-regexp txt))
16869 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16870 org-end-time-was-given
16871 (substring txt (match-end 0)))))
16872 (when org-read-date-analyze-futurep
16873 (setq txt (concat txt " (=>F)")))
16874 (setq org-read-date-overlay
16875 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16876 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16878 (defun org-read-date-analyze (ans org-def org-defdecode)
16879 "Analyze the combined answer of the date prompt."
16880 ;; FIXME: cleanup and comment
16881 (let ((nowdecode (decode-time (current-time)))
16882 delta deltan deltaw deltadef year month day
16883 hour minute second wday pm h2 m2 tl wday1
16884 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16885 (setq org-read-date-analyze-futurep nil
16886 org-read-date-analyze-forced-year nil)
16887 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16890 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16891 (setq ans (replace-match "" t t ans)
16893 deltaw (nth 1 delta)
16894 deltadef (nth 2 delta)))
16896 ;; Check if there is an iso week date in there. If yes, store the
16897 ;; info and postpone interpreting it until the rest of the parsing
16899 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16900 (setq iso-year (if (match-end 1)
16901 (org-small-year-to-year
16902 (string-to-number (match-string 1 ans))))
16903 iso-weekday (if (match-end 3)
16904 (string-to-number (match-string 3 ans)))
16905 iso-week (string-to-number (match-string 2 ans)))
16906 (setq ans (replace-match "" t t ans)))
16908 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16909 (when (string-match
16910 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16911 (setq year (if (match-end 2)
16912 (string-to-number (match-string 2 ans))
16913 (progn (setq kill-year t)
16914 (string-to-number (format-time-string "%Y"))))
16915 month (string-to-number (match-string 3 ans))
16916 day (string-to-number (match-string 4 ans)))
16917 (if (< year 100) (setq year (+ 2000 year)))
16918 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16921 ;; Help matching dotted european dates
16922 (when (string-match
16923 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16924 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16926 (string-to-number (format-time-string "%Y")))
16927 day (string-to-number (match-string 1 ans))
16928 month (string-to-number (match-string 2 ans))
16929 ans (replace-match (format "%04d-%02d-%02d" year month day)
16932 ;; Help matching american dates, like 5/30 or 5/30/7
16933 (when (string-match
16934 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16935 (setq year (if (match-end 4)
16936 (string-to-number (match-string 4 ans))
16937 (progn (setq kill-year t)
16938 (string-to-number (format-time-string "%Y"))))
16939 month (string-to-number (match-string 1 ans))
16940 day (string-to-number (match-string 2 ans)))
16941 (if (< year 100) (setq year (+ 2000 year)))
16942 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16944 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16945 ;; If there is a time with am/pm, and *no* time without it, we convert
16946 ;; so that matching will be successful.
16947 (loop for i from 1 to 2 do ; twice, for end time as well
16948 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16949 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16950 (setq hour (string-to-number (match-string 1 ans))
16951 minute (if (match-end 3)
16952 (string-to-number (match-string 3 ans))
16955 (string-to-char (downcase (match-string 4 ans)))))
16956 (if (and (= hour 12) (not pm))
16958 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16959 (setq ans (replace-match (format "%02d:%02d" hour minute)
16962 ;; Check if a time range is given as a duration
16963 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16964 (setq hour (string-to-number (match-string 1 ans))
16965 h2 (+ hour (string-to-number (match-string 3 ans)))
16966 minute (string-to-number (match-string 2 ans))
16967 m2 (+ minute (if (match-end 5) (string-to-number
16968 (match-string 5 ans))0)))
16969 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16970 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16973 ;; Check if there is a time range
16974 (when (boundp 'org-end-time-was-given)
16975 (setq org-time-was-given nil)
16976 (when (and (string-match org-plain-time-of-day-regexp ans)
16978 (setq org-end-time-was-given (match-string 8 ans))
16979 (setq ans (concat (substring ans 0 (match-beginning 7))
16980 (substring ans (match-end 7))))))
16982 (setq tl (parse-time-string ans)
16983 day (or (nth 3 tl) (nth 3 org-defdecode))
16984 month (or (nth 4 tl)
16985 (if (and org-read-date-prefer-future
16986 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16987 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16988 (nth 4 org-defdecode)))
16989 year (or (and (not kill-year) (nth 5 tl))
16990 (if (and org-read-date-prefer-future
16991 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16992 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16993 (nth 5 org-defdecode)))
16994 hour (or (nth 2 tl) (nth 2 org-defdecode))
16995 minute (or (nth 1 tl) (nth 1 org-defdecode))
16996 second (or (nth 0 tl) 0)
16999 (when (and (eq org-read-date-prefer-future 'time)
17000 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17001 (equal day (nth 3 nowdecode))
17002 (equal month (nth 4 nowdecode))
17003 (equal year (nth 5 nowdecode))
17005 (or (< (nth 2 tl) (nth 2 nowdecode))
17006 (and (= (nth 2 tl) (nth 2 nowdecode))
17008 (< (nth 1 tl) (nth 1 nowdecode)))))
17012 ;; Special date definitions below
17015 ;; There was an iso week
17018 (setq year (or iso-year year)
17019 day (or iso-weekday wday 1)
17020 wday nil ; to make sure that the trigger below does not match
17021 iso-date (calendar-gregorian-from-absolute
17022 (calendar-absolute-from-iso
17023 (list iso-week day year))))
17024 ; FIXME: Should we also push ISO weeks into the future?
17025 ; (when (and org-read-date-prefer-future
17027 ; (< (calendar-absolute-from-gregorian iso-date)
17028 ; (time-to-days (current-time))))
17029 ; (setq year (1+ year)
17030 ; iso-date (calendar-gregorian-from-absolute
17031 ; (calendar-absolute-from-iso
17032 ; (list iso-week day year)))))
17033 (setq month (car iso-date)
17034 year (nth 2 iso-date)
17035 day (nth 1 iso-date)))
17039 (let ((now (decode-time (current-time))))
17040 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17041 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17042 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17043 ((equal deltaw "m") (setq month (+ month deltan)))
17044 ((equal deltaw "y") (setq year (+ year deltan)))))
17045 ((and wday (not (nth 3 tl)))
17046 ;; Weekday was given, but no day, so pick that day in the week
17047 ;; on or after the derived date.
17048 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17049 (unless (equal wday wday1)
17050 (setq day (+ day (% (- wday wday1 -7) 7))))))
17051 (if (and (boundp 'org-time-was-given)
17053 (setq org-time-was-given t))
17054 (if (< year 100) (setq year (+ 2000 year)))
17055 ;; Check of the date is representable
17056 (if org-read-date-force-compatible-dates
17059 (setq year 1970 org-read-date-analyze-forced-year t))
17061 (setq year 2037 org-read-date-analyze-forced-year t)))
17062 (condition-case nil
17063 (ignore (encode-time second minute hour day month year))
17065 (setq year (nth 5 org-defdecode))
17066 (setq org-read-date-analyze-forced-year t))))
17067 (setq org-read-date-analyze-futurep futurep)
17068 (list second minute hour day month year)))
17070 (defvar parse-time-weekdays)
17071 (defun org-read-date-get-relative (s today default)
17072 "Check string S for special relative date string.
17073 TODAY and DEFAULT are internal times, for today and for a default.
17074 Return shift list (N what def-flag)
17075 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17076 N is the number of WHATs to shift.
17077 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17078 the DEFAULT date rather than TODAY."
17079 (require 'parse-time)
17083 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17085 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17086 "\\([ \t]\\|$\\)") s)
17087 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17088 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17089 (string-to-char (substring (match-string 1 s) -1))
17091 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17092 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17093 (what (if (match-end 3) (match-string 3 s) "d"))
17094 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17095 (date (if rel default today))
17096 (wday (nth 6 (decode-time date)))
17100 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17101 (if (= delta 0) (setq delta 7))
17104 (setq delta (- delta 7))
17105 (if (= delta 0) (setq delta -7))))
17106 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17107 (list delta "d" rel))
17108 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17110 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17111 "Turn a user-specified date into the internal representation.
17112 The internal representation needed by the calendar is (month day year).
17113 This is a wrapper to handle the brain-dead convention in calendar that
17114 user function argument order change dependent on argument order."
17115 (if (boundp 'calendar-date-style)
17117 ((eq calendar-date-style 'american)
17118 (list arg1 arg2 arg3))
17119 ((eq calendar-date-style 'european)
17120 (list arg2 arg1 arg3))
17121 ((eq calendar-date-style 'iso)
17122 (list arg2 arg3 arg1)))
17123 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17124 (if (org-bound-and-true-p european-calendar-style)
17125 (list arg2 arg1 arg3)
17126 (list arg1 arg2 arg3)))))
17128 (defun org-eval-in-calendar (form &optional keepdate)
17129 "Eval FORM in the calendar window and return to current window.
17130 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17131 otherwise stick to the current value of `org-ans2'."
17132 (let ((sf (selected-frame))
17133 (sw (selected-window)))
17134 (select-window (get-buffer-window "*Calendar*" t))
17136 (when (and (not keepdate) (calendar-cursor-to-date))
17137 (let* ((date (calendar-cursor-to-date))
17138 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17139 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17140 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17142 (org-select-frame-set-input-focus sf)))
17144 (defun org-calendar-select ()
17145 "Return to `org-read-date' with the date currently selected.
17146 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17148 (when (calendar-cursor-to-date)
17149 (let* ((date (calendar-cursor-to-date))
17150 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17151 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17152 (if (active-minibuffer-window) (exit-minibuffer))))
17154 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17155 "Insert a date stamp for the date given by the internal TIME.
17156 WITH-HM means use the stamp format that includes the time of the day.
17157 INACTIVE means use square brackets instead of angular ones, so that the
17158 stamp will not contribute to the agenda.
17159 PRE and POST are optional strings to be inserted before and after the
17161 The command returns the inserted time stamp."
17162 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17164 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17165 (insert-before-markers (or pre ""))
17166 (when (listp extra)
17167 (setq extra (car extra))
17168 (if (and (stringp extra)
17169 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17170 (setq extra (format "-%02d:%02d"
17171 (string-to-number (match-string 1 extra))
17172 (string-to-number (match-string 2 extra))))
17175 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17176 (insert-before-markers (setq stamp (format-time-string fmt time)))
17177 (insert-before-markers (or post ""))
17178 (setq org-last-inserted-timestamp stamp)))
17180 (defun org-toggle-time-stamp-overlays ()
17181 "Toggle the use of custom time stamp formats."
17183 (setq org-display-custom-times (not org-display-custom-times))
17184 (unless org-display-custom-times
17185 (let ((p (point-min)) (bmp (buffer-modified-p)))
17186 (while (setq p (next-single-property-change p 'display))
17187 (if (and (get-text-property p 'display)
17188 (eq (get-text-property p 'face) 'org-date))
17189 (remove-text-properties
17190 p (setq p (next-single-property-change p 'display))
17192 (set-buffer-modified-p bmp)))
17193 (if (featurep 'xemacs)
17194 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17195 (org-restart-font-lock)
17196 (setq org-table-may-need-update t)
17197 (if org-display-custom-times
17198 (message "Time stamps are overlaid with custom format")
17199 (message "Time stamp overlays removed")))
17201 (defun org-display-custom-time (beg end)
17202 "Overlay modified time stamp format over timestamp between BEG and END."
17203 (let* ((ts (buffer-substring beg end))
17204 t1 w1 with-hm tf time str w2 (off 0))
17206 (setq t1 (org-parse-time-string ts t))
17207 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17208 (setq off (- (match-end 0) (match-beginning 0)))))
17209 (setq end (- end off))
17210 (setq w1 (- end beg)
17211 with-hm (and (nth 1 t1) (nth 2 t1))
17212 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17213 time (org-fix-decoded-time t1)
17215 (format-time-string
17216 (substring tf 1 -1) (apply 'encode-time time))
17217 nil 'mouse-face 'highlight)
17219 (if (not (= w2 w1))
17220 (add-text-properties (1+ beg) (+ 2 beg)
17221 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17222 (if (featurep 'xemacs)
17224 (put-text-property beg end 'invisible t)
17225 (put-text-property beg end 'end-glyph (make-glyph str)))
17226 (put-text-property beg end 'display str))))
17228 (defun org-fix-decoded-time (time)
17229 "Set 0 instead of nil for the first 6 elements of time.
17230 Don't touch the rest."
17232 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17234 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17236 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17237 "Difference between TIMESTAMP-STRING and now in days.
17238 If SECONDS is non-nil, return the difference in seconds."
17239 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17240 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17241 (funcall fdiff (current-time)))))
17243 (defun org-deadline-close (timestamp-string &optional ndays)
17244 "Is the time in TIMESTAMP-STRING close to the current date?"
17245 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17246 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17247 (not (org-entry-is-done-p))))
17249 (defun org-get-wdays (ts &optional delay zero-delay)
17250 "Get the deadline lead time appropriate for timestring TS.
17251 When DELAY is non-nil, get the delay time for scheduled items
17252 instead of the deadline lead time. When ZERO-DELAY is non-nil
17253 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17254 don't try to find the delay cookie in the scheduled timestamp."
17255 (let ((tv (if delay org-scheduled-delay-days
17256 org-deadline-warning-days)))
17258 ((or (and delay (< tv 0))
17259 (and delay zero-delay (<= tv 0))
17260 (and (not delay) (<= tv 0)))
17261 ;; Enforce this value no matter what
17263 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17264 ;; lead time is specified.
17265 (floor (* (string-to-number (match-string 1 ts))
17266 (cdr (assoc (match-string 2 ts)
17267 '(("d" . 1) ("w" . 7)
17268 ("m" . 30.4) ("y" . 365.25)
17269 ("h" . 0.041667)))))))
17270 ;; go for the default.
17273 (defun org-calendar-select-mouse (ev)
17274 "Return to `org-read-date' with the date currently selected.
17275 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17277 (mouse-set-point ev)
17278 (when (calendar-cursor-to-date)
17279 (let* ((date (calendar-cursor-to-date))
17280 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17281 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17282 (if (active-minibuffer-window) (exit-minibuffer))))
17284 (defun org-check-deadlines (ndays)
17285 "Check if there are any deadlines due or past due.
17286 A deadline is considered due if it happens within `org-deadline-warning-days'
17287 days from today's date. If the deadline appears in an entry marked DONE,
17288 it is not shown. The prefix arg NDAYS can be used to test that many
17289 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17291 (let* ((org-warn-days
17293 ((equal ndays '(4)) 100000)
17294 (ndays (prefix-numeric-value ndays))
17295 (t (abs org-deadline-warning-days))))
17296 (case-fold-search nil)
17297 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17299 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17301 (message "%d deadlines past-due or due within %d days"
17302 (org-occur regexp nil callback)
17305 (defsubst org-re-timestamp (type)
17306 "Return a regexp for timestamp TYPE.
17307 Allowed values for TYPE are:
17309 all: all timestamps
17310 active: only active timestamps (<...>)
17311 inactive: only inactive timestamps ([...])
17312 scheduled: only scheduled timestamps
17313 deadline: only deadline timestamps
17314 closed: only closed time-stamps
17316 When TYPE is nil, fall back on returning a regexp that matches
17317 both scheduled and deadline timestamps."
17318 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
17319 ((eq type 'active) org-ts-regexp)
17320 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]")
17321 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
17322 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17323 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
17324 ((eq type 'scheduled-or-deadline)
17325 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
17327 (defun org-check-before-date (date)
17328 "Check if there are deadlines or scheduled entries before DATE."
17329 (interactive (list (org-read-date)))
17330 (let ((case-fold-search nil)
17331 (regexp (org-re-timestamp org-ts-type))
17333 (lambda () (time-less-p
17334 (org-time-string-to-time (match-string 1))
17335 (org-time-string-to-time date)))))
17336 (message "%d entries before %s"
17337 (org-occur regexp nil callback) date)))
17339 (defun org-check-after-date (date)
17340 "Check if there are deadlines or scheduled entries after DATE."
17341 (interactive (list (org-read-date)))
17342 (let ((case-fold-search nil)
17343 (regexp (org-re-timestamp org-ts-type))
17347 (org-time-string-to-time (match-string 1))
17348 (org-time-string-to-time date))))))
17349 (message "%d entries after %s"
17350 (org-occur regexp nil callback) date)))
17352 (defun org-check-dates-range (start-date end-date)
17353 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17354 (interactive (list (org-read-date nil nil nil "Range starts")
17355 (org-read-date nil nil nil "Range end")))
17356 (let ((case-fold-search nil)
17357 (regexp (org-re-timestamp org-ts-type))
17360 (let ((match (match-string 1)))
17363 (org-time-string-to-time match)
17364 (org-time-string-to-time start-date)))
17366 (org-time-string-to-time match)
17367 (org-time-string-to-time end-date)))))))
17368 (message "%d entries between %s and %s"
17369 (org-occur regexp nil callback) start-date end-date)))
17371 (defun org-evaluate-time-range (&optional to-buffer)
17372 "Evaluate a time range by computing the difference between start and end.
17373 Normally the result is just printed in the echo area, but with prefix arg
17374 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17375 If the time range is actually in a table, the result is inserted into the
17377 For time difference computation, a year is assumed to be exactly 365
17378 days in order to avoid rounding problems."
17381 (org-clock-update-time-maybe)
17383 (unless (org-at-date-range-p t)
17384 (goto-char (point-at-bol))
17385 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17386 (if (not (org-at-date-range-p t))
17387 (user-error "Not at a time-stamp range, and none found in current line")))
17388 (let* ((ts1 (match-string 1))
17389 (ts2 (match-string 2))
17390 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17391 (match-end (match-end 0))
17392 (time1 (org-time-string-to-time ts1))
17393 (time2 (org-time-string-to-time ts2))
17394 (t1 (org-float-time time1))
17395 (t2 (org-float-time time2))
17396 (diff (abs (- t2 t1)))
17397 (negative (< (- t2 t1) 0))
17398 ;; (ys (floor (* 365 24 60 60)))
17401 (fy "%dy %dd %02d:%02d")
17403 (fd "%dd %02d:%02d")
17408 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17410 d (floor (/ diff ds)) diff (mod diff ds)
17411 h (floor (/ diff hs)) diff (mod diff hs)
17412 m (floor (/ diff 60)))
17413 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17415 d (floor (+ (/ diff ds) 0.5))
17417 (if (not to-buffer)
17418 (message "%s" (org-make-tdiff-string y d h m))
17419 (if (org-at-table-p)
17421 (goto-char match-end)
17423 (and (looking-at " *|") (goto-char (match-end 0))))
17424 (goto-char match-end))
17426 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17427 (replace-match ""))
17428 (if negative (insert " -"))
17429 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17430 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17431 (insert " " (format fh h m))))
17432 (if align (org-table-align))
17433 (message "Time difference inserted")))))
17435 (defun org-make-tdiff-string (y d h m)
17438 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17440 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17442 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17444 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17446 (apply 'format fmt (nreverse l))))
17448 (defun org-time-string-to-time (s &optional buffer pos)
17449 "Convert a timestamp string into internal time."
17450 (condition-case errdata
17451 (apply 'encode-time (org-parse-time-string s))
17452 (error (error "Bad timestamp `%s'%s\nError was: %s"
17453 s (if (not (and buffer pos))
17455 (format " at %d in buffer `%s'" pos buffer))
17458 (defun org-time-string-to-seconds (s)
17459 "Convert a timestamp string to a number of seconds."
17460 (org-float-time (org-time-string-to-time s)))
17462 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17463 "Convert a time stamp to an absolute day number.
17464 If there is a specifier for a cyclic time stamp, get the closest
17466 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17467 The variable `date' is bound by the calendar when this is called."
17469 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17470 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17473 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17474 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17475 (time-to-days (current-time))) (match-string 0 s)
17478 (condition-case errdata
17479 (apply 'encode-time (org-parse-time-string s))
17480 (error (error "Bad timestamp `%s'%s\nError was: %s"
17481 s (if (not (and buffer pos))
17483 (format " at %d in buffer `%s'" pos buffer))
17484 (cdr errdata))))))))
17486 (defun org-days-to-iso-week (days)
17487 "Return the iso week number."
17489 (car (calendar-iso-from-absolute days)))
17491 (defun org-small-year-to-year (year)
17492 "Convert 2-digit years into 4-digit years.
17493 YEAR is expanded into one of the 30 next years, if possible, or
17494 into a past one. Any year larger than 99 is returned unchanged."
17495 (if (>= year 100) year
17496 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17497 (century (/ current 100))
17498 (offset (- year (% current 100))))
17499 (cond ((> offset 30) (+ (* (1- century) 100) year))
17500 ((> offset -70) (+ (* century 100) year))
17501 (t (+ (* (1+ century) 100) year))))))
17503 (defun org-time-from-absolute (d)
17504 "Return the time corresponding to date D.
17505 D may be an absolute day number, or a calendar-type list (month day year)."
17506 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17507 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17509 (defun org-calendar-holiday ()
17510 "List of holidays, for Diary display in Org-mode."
17511 (require 'holidays)
17513 (if (fboundp 'calendar-check-holidays)
17514 'calendar-check-holidays 'check-calendar-holidays) date)))
17515 (if hl (mapconcat 'identity hl "; "))))
17517 (defun org-diary-sexp-entry (sexp entry date)
17518 "Process a SEXP diary ENTRY for DATE."
17519 (require 'diary-lib)
17520 (let ((result (if calendar-debug-sexp
17521 (let ((stack-trace-on-error t))
17522 (eval (car (read-from-string sexp))))
17523 (condition-case nil
17524 (eval (car (read-from-string sexp)))
17527 (message "Bad sexp at line %d in %s: %s"
17529 (buffer-file-name) sexp)
17531 (cond ((stringp result) (split-string result "; "))
17532 ((and (consp result)
17533 (not (consp (cdr result)))
17534 (stringp (cdr result))) (cdr result))
17535 ((and (consp result)
17536 (stringp (car result))) result)
17539 (defun org-diary-to-ical-string (frombuf)
17540 "Get iCalendar entries from diary entries in buffer FROMBUF.
17541 This uses the icalendar.el library."
17542 (let* ((tmpdir (if (featurep 'xemacs)
17544 temporary-file-directory))
17545 (tmpfile (make-temp-name
17546 (expand-file-name "orgics" tmpdir)))
17548 (with-current-buffer frombuf
17549 (icalendar-export-region (point-min) (point-max) tmpfile)
17550 (setq buf (find-buffer-visiting tmpfile))
17552 (goto-char (point-min))
17553 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17554 (setq b (match-beginning 0)))
17555 (goto-char (point-max))
17556 (if (re-search-backward "^END:VEVENT" nil t)
17557 (setq e (match-end 0)))
17558 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17560 (delete-file tmpfile)
17563 (defun org-closest-date (start current change prefer show-all)
17564 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17565 When PREFER is `past', return a date that is either CURRENT or past.
17566 When PREFER is `future', return a date that is either CURRENT or future.
17567 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17568 ;; Make the proper lists from the dates
17570 (let ((a1 '(("h" . hour)
17575 (shour (nth 2 (org-parse-time-string start)))
17576 dn dw sday cday n1 n2 n0
17577 d m y y1 y2 date1 date2 nmonths nm ny m2)
17579 (setq start (org-date-to-gregorian start)
17580 current (org-date-to-gregorian
17583 (time-to-days (current-time))))
17584 sday (calendar-absolute-from-gregorian start)
17585 cday (calendar-absolute-from-gregorian current))
17587 (if (<= cday sday) (throw 'exit sday))
17589 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17590 (setq dn (string-to-number (match-string 1 change))
17591 dw (cdr (assoc (match-string 2 change) a1)))
17592 (user-error "Invalid change specifier: %s" change))
17593 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17596 (let ((missing-hours
17597 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17599 (setq n1 (if (zerop missing-hours) cday
17600 (- cday (1+ (floor (/ missing-hours 24)))))
17601 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17603 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17606 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17607 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17608 (setq date1 (list m d y1)
17609 n1 (calendar-absolute-from-gregorian date1)
17610 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17611 n2 (calendar-absolute-from-gregorian date2)))
17613 ;; approx number of month between the two dates
17614 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17615 ;; How often does dn fit in there?
17616 (setq d (nth 1 start) m (car start) y (nth 2 start)
17617 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17619 ny (floor (/ m 12))
17622 (while (> m 12) (setq m (- m 12) y (1+ y)))
17623 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17624 (setq m2 (+ m dn) y2 y)
17625 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17626 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17627 (while (<= n2 cday)
17628 (setq n1 n2 m m2 y y2)
17629 (setq m2 (+ m dn) y2 y)
17630 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17631 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17632 ;; Make sure n1 is the earlier date
17633 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17636 ((eq prefer 'past) (if (= cday n2) n2 n1))
17637 ((eq prefer 'future) (if (= cday n1) n1 n2))
17638 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17640 ((eq prefer 'past) (if (= cday n2) n2 n1))
17641 ((eq prefer 'future) (if (= cday n1) n1 n2))
17642 (t (if (= cday n1) n1 n2)))))))
17644 (defun org-date-to-gregorian (date)
17645 "Turn any specification of DATE into a Gregorian date for the calendar."
17646 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17647 ((and (listp date) (= (length date) 3)) date)
17649 (setq date (org-parse-time-string date))
17650 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17652 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17654 (defun org-parse-time-string (s &optional nodefault)
17655 "Parse the standard Org-mode time string.
17656 This should be a lot faster than the normal `parse-time-string'.
17657 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17658 hour and minute fields will be nil if not given."
17659 (cond ((string-match org-ts-regexp0 s)
17661 (if (or (match-beginning 8) (not nodefault))
17662 (string-to-number (or (match-string 8 s) "0")))
17663 (if (or (match-beginning 7) (not nodefault))
17664 (string-to-number (or (match-string 7 s) "0")))
17665 (string-to-number (match-string 4 s))
17666 (string-to-number (match-string 3 s))
17667 (string-to-number (match-string 2 s))
17669 ((string-match "^<[^>]+>$" s)
17670 (decode-time (seconds-to-time (org-matcher-time s))))
17671 (t (error "Not a standard Org-mode time string: %s" s))))
17673 (defun org-timestamp-up (&optional arg)
17674 "Increase the date item at the cursor by one.
17675 If the cursor is on the year, change the year. If it is on the month,
17676 the day or the time, change that.
17677 With prefix ARG, change by that many units."
17679 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17681 (defun org-timestamp-down (&optional arg)
17682 "Decrease the date item at the cursor by one.
17683 If the cursor is on the year, change the year. If it is on the month,
17684 the day or the time, change that.
17685 With prefix ARG, change by that many units."
17687 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17689 (defun org-timestamp-up-day (&optional arg)
17690 "Increase the date in the time stamp by one day.
17691 With prefix ARG, change that many days."
17693 (if (and (not (org-at-timestamp-p t))
17694 (org-at-heading-p))
17696 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17698 (defun org-timestamp-down-day (&optional arg)
17699 "Decrease the date in the time stamp by one day.
17700 With prefix ARG, change that many days."
17702 (if (and (not (org-at-timestamp-p t))
17703 (org-at-heading-p))
17705 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17707 (defun org-at-timestamp-p (&optional inactive-ok)
17708 "Determine if the cursor is in or at a timestamp."
17710 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17712 (ans (or (looking-at tsr)
17714 (skip-chars-backward "^[<\n\r\t")
17715 (if (> (point) (point-min)) (backward-char 1))
17716 (and (looking-at tsr)
17717 (> (- (match-end 0) pos) -1))))))
17719 (boundp 'org-ts-what)
17722 ((= pos (match-beginning 0)) 'bracket)
17723 ;; Point is considered to be "on the bracket" whether
17724 ;; it's really on it or right after it.
17725 ((= pos (1- (match-end 0))) 'bracket)
17726 ((= pos (match-end 0)) 'after)
17727 ((org-pos-in-match-range pos 2) 'year)
17728 ((org-pos-in-match-range pos 3) 'month)
17729 ((org-pos-in-match-range pos 7) 'hour)
17730 ((org-pos-in-match-range pos 8) 'minute)
17731 ((or (org-pos-in-match-range pos 4)
17732 (org-pos-in-match-range pos 5)) 'day)
17733 ((and (> pos (or (match-end 8) (match-end 5)))
17734 (< pos (match-end 0)))
17735 (- pos (or (match-end 8) (match-end 5))))
17739 (defun org-toggle-timestamp-type ()
17740 "Toggle the type (<active> or [inactive]) of a time stamp."
17742 (when (org-at-timestamp-p t)
17743 (let ((beg (match-beginning 0)) (end (match-end 0))
17744 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17747 (while (re-search-forward "[][<>]" end t)
17748 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17750 (message "Timestamp is now %sactive"
17751 (if (equal (char-after beg) ?<) "" "in")))))
17753 (defun org-at-clock-log-p nil
17754 "Is the cursor on the clock log line?"
17756 (move-beginning-of-line 1)
17757 (looking-at org-clock-line-re)))
17759 (defvar org-clock-history) ; defined in org-clock.el
17760 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17761 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17762 "Change the date in the time stamp at point.
17763 The date will be changed by N times WHAT. WHAT can be `day', `month',
17764 `year', `minute', `second'. If WHAT is not given, the cursor position
17765 in the timestamp determines what will be changed.
17766 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17767 (let ((origin (point)) origin-cat
17769 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17772 ts time time0 fixnext clrgx)
17773 (if (not (org-at-timestamp-p t))
17774 (user-error "Not at a timestamp"))
17775 (if (and (not what) (eq org-ts-what 'bracket))
17776 (org-toggle-timestamp-type)
17777 ;; Point isn't on brackets. Remember the part of the time-stamp
17778 ;; the point was in. Indeed, size of time-stamps may change,
17779 ;; but point must be kept in the same category nonetheless.
17780 (setq origin-cat org-ts-what)
17781 (if (and (not what) (not (eq org-ts-what 'day))
17782 org-display-custom-times
17783 (get-text-property (point) 'display)
17784 (not (get-text-property (1- (point)) 'display)))
17785 (setq org-ts-what 'day))
17786 (setq org-ts-what (or what org-ts-what)
17787 inactive (= (char-after (match-beginning 0)) ?\[)
17788 ts (match-string 0))
17790 (when (string-match
17791 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17793 (setq extra (match-string 1 ts))
17794 (if suppress-tmp-delay
17795 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17796 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17798 (setq time0 (org-parse-time-string ts))
17800 (eq org-ts-what 'minute)
17801 (not current-prefix-arg))
17802 ;; This looks like s-up and s-down. Change by one rounding step.
17803 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17804 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17805 (setcar (cdr time0) (+ (nth 1 time0)
17806 (if (> n 0) (- rem) (- dm rem))))))
17808 (encode-time (or (car time0) 0)
17809 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17810 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17811 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17812 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17813 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17815 (when (and (member org-ts-what '(hour minute))
17817 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17818 (setq extra (org-modify-ts-extra
17820 (if (eq org-ts-what 'hour) 2 5)
17822 (when (integerp org-ts-what)
17823 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17824 (if (eq what 'calendar)
17825 (let ((cal-date (org-get-date-from-calendar)))
17826 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17827 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17828 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17829 (setcar time0 (or (car time0) 0))
17830 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17831 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17832 (setq time (apply 'encode-time time0))))
17833 ;; Insert the new time-stamp, and ensure point stays in the same
17834 ;; category as before (i.e. not after the last position in that
17836 (let ((pos (point)))
17837 ;; Stay before inserted string. `save-excursion' is of no use.
17838 (setq org-last-changed-timestamp
17839 (org-insert-time-stamp time with-hm inactive nil nil extra))
17842 (looking-at org-ts-regexp3)
17844 ;; `day' category ends before `hour' if any, or at
17845 ;; the end of the day name.
17846 ((eq origin-cat 'day)
17847 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17848 ((eq origin-cat 'hour) (min (match-end 7) origin))
17849 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17850 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17851 ;; `year' and `month' have both fixed size: point
17852 ;; couldn't have moved into another part.
17854 ;; Update clock if on a CLOCK line.
17855 (org-clock-update-time-maybe)
17856 ;; Maybe adjust the closest clock in `org-clock-history'
17857 (when org-clock-adjust-closest
17858 (if (not (and (org-at-clock-log-p)
17859 (< 1 (length (delq nil (mapcar 'marker-position
17860 org-clock-history))))))
17861 (message "No clock to adjust")
17862 (cond ((save-excursion ; fix previous clock?
17863 (re-search-backward org-ts-regexp0 nil t)
17864 (org-looking-back (concat org-clock-string " \\[")))
17865 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17866 ((save-excursion ; fix next clock?
17867 (re-search-backward org-ts-regexp0 nil t)
17868 (looking-at (concat org-ts-regexp0 "\\] =>")))
17869 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17870 (save-window-excursion
17871 ;; Find closest clock to point, adjust the previous/next one in history
17872 (let* ((p (save-excursion (org-back-to-heading t)))
17873 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17875 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17876 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17878 (message "No clock to adjust")
17880 (org-goto-marker-or-bmk clfixpos)
17882 (when (re-search-forward clrgx nil t)
17883 (goto-char (match-beginning 1))
17884 (let (org-clock-adjust-closest)
17885 (org-timestamp-change n org-ts-what updown))
17886 (message "Clock adjusted in %s for heading: %s"
17887 (file-name-nondirectory (buffer-file-name))
17888 (org-get-heading t t)))))))))
17889 ;; Try to recenter the calendar window, if any.
17890 (if (and org-calendar-follow-timestamp-change
17891 (get-buffer-window "*Calendar*" t)
17892 (memq org-ts-what '(day month year)))
17893 (org-recenter-calendar (time-to-days time))))))
17895 (defun org-modify-ts-extra (s pos n dm)
17896 "Change the different parts of the lead-time and repeat fields in timestamp."
17897 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17899 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17901 ((or (org-pos-in-match-range pos 2)
17902 (org-pos-in-match-range pos 3))
17903 (setq m (string-to-number (match-string 3 s))
17904 h (string-to-number (match-string 2 s)))
17905 (if (org-pos-in-match-range pos 2)
17907 (setq n (* dm (org-no-warnings (signum n))))
17908 (when (not (= 0 (setq rem (% m dm))))
17909 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17911 (if (< m 0) (setq m (+ m 60) h (1- h)))
17912 (if (> m 59) (setq m (- m 60) h (1+ h)))
17913 (setq h (min 24 (max 0 h)))
17914 (setq ng 1 new (format "-%02d:%02d" h m)))
17915 ((org-pos-in-match-range pos 6)
17916 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17917 ((org-pos-in-match-range pos 5)
17918 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17920 ((org-pos-in-match-range pos 9)
17921 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17922 ((org-pos-in-match-range pos 8)
17923 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17927 (substring s 0 (match-beginning ng))
17929 (substring s (match-end ng))))))
17932 (defun org-recenter-calendar (date)
17933 "If the calendar is visible, recenter it to DATE."
17934 (let ((cwin (get-buffer-window "*Calendar*" t)))
17936 (let ((calendar-move-hook nil))
17937 (with-selected-window cwin
17938 (calendar-goto-date (if (listp date) date
17939 (calendar-gregorian-from-absolute date))))))))
17941 (defun org-goto-calendar (&optional arg)
17942 "Go to the Emacs calendar at the current date.
17943 If there is a time stamp in the current line, go to that date.
17944 A prefix ARG can be used to force the current date."
17946 (let ((tsr org-ts-regexp) diff
17947 (calendar-move-hook nil)
17948 (calendar-view-holidays-initially-flag nil)
17949 (calendar-view-diary-initially-flag nil))
17950 (if (or (org-at-timestamp-p)
17952 (beginning-of-line 1)
17953 (looking-at (concat ".*" tsr))))
17954 (let ((d1 (time-to-days (current-time)))
17956 (org-time-string-to-time (match-string 1)))))
17957 (setq diff (- d2 d1))))
17959 (calendar-goto-today)
17960 (if (and diff (not arg)) (calendar-forward-day diff))))
17962 (defun org-get-date-from-calendar ()
17963 "Return a list (month day year) of date at point in calendar."
17964 (with-current-buffer "*Calendar*"
17966 (calendar-cursor-to-date))))
17968 (defun org-date-from-calendar ()
17969 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17970 If there is already a time stamp at the cursor position, update it."
17972 (if (org-at-timestamp-p t)
17973 (org-timestamp-change 0 'calendar)
17974 (let ((cal-date (org-get-date-from-calendar)))
17975 (org-insert-time-stamp
17976 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17978 (defcustom org-effort-durations
17982 ("w" . ,(* 60 8 5))
17983 ("m" . ,(* 60 8 5 4))
17984 ("y" . ,(* 60 8 5 40)))
17985 "Conversion factor to minutes for an effort modifier.
17987 Each entry has the form (MODIFIER . MINUTES).
17989 In an effort string, a number followed by MODIFIER is multiplied
17990 by the specified number of MINUTES to obtain an effort in
17993 For example, if the value of this variable is ((\"hours\" . 60)), then an
17994 effort string \"2hours\" is equivalent to 120 minutes."
17997 :package-version '(Org . "8.3")
17998 :type '(alist :key-type (string :tag "Modifier")
17999 :value-type (number :tag "Minutes")))
18001 (defun org-minutes-to-clocksum-string (m)
18002 "Format number of minutes as a clocksum string.
18003 The format is determined by `org-time-clocksum-format',
18004 `org-time-clocksum-use-fractional' and
18005 `org-time-clocksum-fractional-format' and
18006 `org-time-clocksum-use-effort-durations'."
18007 (let ((clocksum "")
18008 (m (round m)) ; Don't allow fractions of minutes
18010 (setq h (if org-time-clocksum-use-effort-durations
18011 (cdr (assoc "h" org-effort-durations)) 60)
18012 d (if org-time-clocksum-use-effort-durations
18013 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18014 w (if org-time-clocksum-use-effort-durations
18015 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18016 mo (if org-time-clocksum-use-effort-durations
18017 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18018 y (if org-time-clocksum-use-effort-durations
18019 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18020 ;; fractional format
18021 (if org-time-clocksum-use-fractional
18023 ;; single format string
18024 ((stringp org-time-clocksum-fractional-format)
18025 (format org-time-clocksum-fractional-format (/ m (float h))))
18026 ;; choice of fractional formats for different time units
18027 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18028 (> (/ (truncate m) (* y d h)) 0))
18029 (format fmt (/ m (* y d (float h)))))
18030 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18031 (> (/ (truncate m) (* mo d h)) 0))
18032 (format fmt (/ m (* mo d (float h)))))
18033 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18034 (> (/ (truncate m) (* w d h)) 0))
18035 (format fmt (/ m (* w d (float h)))))
18036 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18037 (> (/ (truncate m) (* d h)) 0))
18038 (format fmt (/ m (* d (float h)))))
18039 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18040 (> (/ (truncate m) h) 0))
18041 (format fmt (/ m (float h))))
18042 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18044 ;; fall back to smallest time unit with a format
18045 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18046 (format fmt (/ m (float h))))
18047 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18048 (format fmt (/ m (* d (float h)))))
18049 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18050 (format fmt (/ m (* w d (float h)))))
18051 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18052 (format fmt (/ m (* mo d (float h)))))
18053 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18054 (format fmt (/ m (* y d (float h))))))
18055 ;; standard (non-fractional) format, with single format string
18056 (if (stringp org-time-clocksum-format)
18057 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18058 ;; separate formats components
18059 (and (setq fmt (plist-get org-time-clocksum-format :years))
18060 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18061 (plist-get org-time-clocksum-format :require-years))
18062 (setq clocksum (concat clocksum (format fmt n))
18063 m (- m (* n y d h))))
18064 (and (setq fmt (plist-get org-time-clocksum-format :months))
18065 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18066 (plist-get org-time-clocksum-format :require-months))
18067 (setq clocksum (concat clocksum (format fmt n))
18068 m (- m (* n mo d h))))
18069 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18070 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18071 (plist-get org-time-clocksum-format :require-weeks))
18072 (setq clocksum (concat clocksum (format fmt n))
18073 m (- m (* n w d h))))
18074 (and (setq fmt (plist-get org-time-clocksum-format :days))
18075 (or (> (setq n (/ (truncate m) (* d h))) 0)
18076 (plist-get org-time-clocksum-format :require-days))
18077 (setq clocksum (concat clocksum (format fmt n))
18078 m (- m (* n d h))))
18079 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18080 (or (> (setq n (/ (truncate m) h)) 0)
18081 (plist-get org-time-clocksum-format :require-hours))
18082 (setq clocksum (concat clocksum (format fmt n))
18084 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18085 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18086 (setq clocksum (concat clocksum (format fmt m))))
18087 ;; return formatted time duration
18090 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18091 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18092 "Org mode version 8.0")
18094 (defun org-hours-to-clocksum-string (n)
18095 (org-minutes-to-clocksum-string (* n 60)))
18097 (defun org-hh:mm-string-to-minutes (s)
18098 "Convert a string H:MM to a number of minutes.
18099 If the string is just a number, interpret it as minutes.
18100 In fact, the first hh:mm or number in the string will be taken,
18101 there can be extra stuff in the string.
18102 If no number is found, the return value is 0."
18105 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18106 (+ (* (string-to-number (match-string 1 s)) 60)
18107 (string-to-number (match-string 2 s))))
18108 ((string-match "\\([0-9]+\\)" s)
18109 (string-to-number (match-string 1 s)))
18112 (defcustom org-image-actual-width t
18113 "Should we use the actual width of images when inlining them?
18115 When set to `t', always use the image width.
18117 When set to a number, use imagemagick (when available) to set
18118 the image's width to this value.
18120 When set to a number in a list, try to get the width from any
18121 #+ATTR.* keyword if it matches a width specification like
18123 #+ATTR_HTML: :width 300px
18125 and fall back on that number if none is found.
18127 When set to nil, try to get the width from an #+ATTR.* keyword
18128 and fall back on the original width if none is found.
18130 This requires Emacs >= 24.1, build with imagemagick support."
18131 :group 'org-appearance
18133 :package-version '(Org . "8.0")
18135 (const :tag "Use the image width" t)
18136 (integer :tag "Use a number of pixels")
18137 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18138 (const :tag "Use #+ATTR* or don't resize" nil)))
18140 (defcustom org-agenda-inhibit-startup nil
18141 "Inhibit startup when preparing agenda buffers.
18142 When this variable is `t', the initialization of the Org agenda
18143 buffers is inhibited: e.g. the visibility state is not set, the
18144 tables are not re-aligned, etc."
18147 :group 'org-agenda)
18149 (define-obsolete-variable-alias
18150 'org-agenda-ignore-drawer-properties
18151 'org-agenda-ignore-properties "25.1")
18153 (defcustom org-agenda-ignore-properties nil
18154 "Avoid updating text properties when building the agenda.
18155 Properties are used to prepare buffers for effort estimates,
18156 appointments, statistics and subtree-local categories.
18157 If you don't use these in the agenda, you can add them to this
18158 list and agenda building will be a bit faster.
18159 The value is a list, with zero or more of the symbols `effort', `appt',
18160 `stats' or `category'."
18161 :type '(set :greedy t
18167 :package-version '(Org . "8.3")
18168 :group 'org-agenda)
18170 (defun org-duration-string-to-minutes (s &optional output-to-string)
18171 "Convert a duration string S to minutes.
18173 A bare number is interpreted as minutes, modifiers can be set by
18174 customizing `org-effort-durations' (which see).
18176 Entries containing a colon are interpreted as H:MM by
18177 `org-hh:mm-string-to-minutes'."
18179 (re (concat "\\([0-9.]+\\) *\\("
18180 (regexp-opt (mapcar 'car org-effort-durations))
18182 (while (string-match re s)
18183 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18184 (string-to-number (match-string 1 s))))
18185 (setq s (replace-match "" nil t s)))
18186 (setq result (floor result))
18187 (incf result (org-hh:mm-string-to-minutes s))
18188 (if output-to-string (number-to-string result) result)))
18192 (defun org-save-all-org-buffers ()
18193 "Save all Org-mode buffers without user confirmation."
18195 (message "Saving all Org-mode buffers...")
18196 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18197 (when (featurep 'org-id) (org-id-locations-save))
18198 (message "Saving all Org-mode buffers... done"))
18200 (defun org-revert-all-org-buffers ()
18201 "Revert all Org-mode buffers.
18202 Prompt for confirmation when there are unsaved changes.
18203 Be sure you know what you are doing before letting this function
18204 overwrite your changes.
18206 This function is useful in a setup where one tracks org files
18207 with a version control system, to revert on one machine after pulling
18208 changes from another. I believe the procedure must be like this:
18210 1. M-x org-save-all-org-buffers
18211 2. Pull changes from the other machine, resolve conflicts
18212 3. M-x org-revert-all-org-buffers"
18214 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18215 (user-error "Abort"))
18217 (save-window-excursion
18220 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18221 (with-current-buffer b buffer-file-name))
18222 (org-pop-to-buffer-same-window b)
18223 (revert-buffer t 'no-confirm)))
18225 (when (and (featurep 'org-id) org-id-track-globally)
18226 (org-id-locations-load)))))
18231 (defun org-switchb (&optional arg)
18232 "Switch between Org buffers.
18233 With one prefix argument, restrict available buffers to files.
18234 With two prefix arguments, restrict available buffers to agenda files.
18236 Defaults to `iswitchb' for buffer name completion.
18237 Set `org-completion-use-ido' to make it use ido instead."
18239 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18240 ((equal arg '(16)) (org-buffer-list 'agenda))
18241 (t (org-buffer-list))))
18242 (org-completion-use-iswitchb org-completion-use-iswitchb)
18243 (org-completion-use-ido org-completion-use-ido))
18244 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18245 (setq org-completion-use-iswitchb t))
18246 (org-pop-to-buffer-same-window
18247 (org-icompleting-read "Org buffer: "
18248 (mapcar 'list (mapcar 'buffer-name blist))
18251 ;;; Define some older names previously used for this functionality
18253 (defalias 'org-ido-switchb 'org-switchb)
18255 (defalias 'org-iswitchb 'org-switchb)
18257 (defun org-buffer-list (&optional predicate exclude-tmp)
18258 "Return a list of Org buffers.
18259 PREDICATE can be `export', `files' or `agenda'.
18261 export restrict the list to Export buffers.
18262 files restrict the list to buffers visiting Org files.
18263 agenda restrict the list to buffers visiting agenda files.
18265 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18267 (agenda-files (and (eq predicate 'agenda)
18268 (mapcar 'file-truename (org-agenda-files t))))
18271 ((eq predicate 'files)
18272 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18273 ((eq predicate 'export)
18274 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18275 ((eq predicate 'agenda)
18277 (with-current-buffer b
18278 (and (derived-mode-p 'org-mode)
18279 (setq bfn (buffer-file-name b))
18280 (member (file-truename bfn) agenda-files)))))
18281 (t (lambda (b) (with-current-buffer b
18282 (or (derived-mode-p 'org-mode)
18283 (string-match "\*Org .*Export"
18284 (buffer-name b)))))))))
18288 (if (and (funcall filter b)
18289 (or (not exclude-tmp)
18290 (not (string-match "tmp" (buffer-name b)))))
18295 (defun org-agenda-files (&optional unrestricted archives)
18296 "Get the list of agenda files.
18297 Optional UNRESTRICTED means return the full list even if a restriction
18298 is currently in place.
18299 When ARCHIVES is t, include all archive files that are really being
18300 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18301 `org-agenda-archives-mode' is t."
18304 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18305 ((stringp org-agenda-files) (org-read-agenda-file-list))
18306 ((listp org-agenda-files) org-agenda-files)
18307 (t (error "Invalid value of `org-agenda-files'")))))
18308 (setq files (apply 'append
18309 (mapcar (lambda (f)
18310 (if (file-directory-p f)
18312 f t org-agenda-file-regexp)
18315 (when org-agenda-skip-unavailable-files
18316 (setq files (delq nil
18319 (and (file-readable-p file) file)))
18321 (when (or (eq archives t)
18322 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18323 (setq files (org-add-archive-files files)))
18326 (defun org-agenda-file-p (&optional file)
18327 "Return non-nil, if FILE is an agenda file.
18328 If FILE is omitted, use the file associated with the current
18330 (let ((fname (or file (buffer-file-name))))
18332 (member (file-truename fname)
18333 (mapcar #'file-truename (org-agenda-files t))))))
18335 (defun org-edit-agenda-file-list ()
18336 "Edit the list of agenda files.
18337 Depending on setup, this either uses customize to edit the variable
18338 `org-agenda-files', or it visits the file that is holding the list. In the
18339 latter case, the buffer is set up in a way that saving it automatically kills
18340 the buffer and restores the previous window configuration."
18342 (if (stringp org-agenda-files)
18343 (let ((cw (current-window-configuration)))
18344 (find-file org-agenda-files)
18345 (org-set-local 'org-window-configuration cw)
18346 (org-add-hook 'after-save-hook
18348 (set-window-configuration
18349 (prog1 org-window-configuration
18350 (kill-buffer (current-buffer))))
18351 (org-install-agenda-files-menu)
18352 (message "New agenda file list installed"))
18354 (message "%s" (substitute-command-keys
18355 "Edit list and finish with \\[save-buffer]")))
18356 (customize-variable 'org-agenda-files)))
18358 (defun org-store-new-agenda-file-list (list)
18359 "Set new value for the agenda file list and save it correctly."
18360 (if (stringp org-agenda-files)
18361 (let ((fe (org-read-agenda-file-list t)) b u)
18362 (while (setq b (find-buffer-visiting org-agenda-files))
18364 (with-temp-file org-agenda-files
18367 (lambda (f) ;; Keep un-expanded entries.
18368 (if (setq u (assoc f fe))
18373 (let ((org-mode-hook nil) (org-inhibit-startup t)
18374 (org-insert-mode-line-in-empty-file nil))
18375 (setq org-agenda-files list)
18376 (customize-save-variable 'org-agenda-files org-agenda-files))))
18378 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18379 "Read the list of agenda files from a file.
18380 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18381 filenames, used by `org-store-new-agenda-file-list' to write back
18382 un-expanded file names."
18383 (when (file-directory-p org-agenda-files)
18384 (error "`org-agenda-files' cannot be a single directory"))
18385 (when (stringp org-agenda-files)
18387 (insert-file-contents org-agenda-files)
18390 (let ((e (expand-file-name (substitute-in-file-name f)
18392 (if pair-with-expansion
18395 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18398 (defun org-cycle-agenda-files ()
18399 "Cycle through the files in `org-agenda-files'.
18400 If the current buffer visits an agenda file, find the next one in the list.
18401 If the current buffer does not, find the first agenda file."
18403 (let* ((fs (org-agenda-files t))
18404 (files (append fs (list (car fs))))
18405 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18407 (unless files (user-error "No agenda files"))
18409 (while (setq file (pop files))
18410 (if (equal (file-truename file) tcf)
18412 (find-file (car files))
18414 (find-file (car fs)))
18415 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18417 (defun org-agenda-file-to-front (&optional to-end)
18418 "Move/add the current file to the top of the agenda file list.
18419 If the file is not present in the list, it is added to the front. If it is
18420 present, it is moved there. With optional argument TO-END, add/move to the
18423 (let ((org-agenda-skip-unavailable-files nil)
18424 (file-alist (mapcar (lambda (x)
18425 (cons (file-truename x) x))
18426 (org-agenda-files t)))
18427 (ctf (file-truename
18428 (or buffer-file-name
18429 (user-error "Please save the current buffer to a file"))))
18431 (setq x (assoc ctf file-alist) had x)
18433 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18435 (setq file-alist (append (delq x file-alist) (list x)))
18436 (setq file-alist (cons x (delq x file-alist))))
18437 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18438 (org-install-agenda-files-menu)
18439 (message "File %s to %s of agenda file list"
18440 (if had "moved" "added") (if to-end "end" "front"))))
18442 (defun org-remove-file (&optional file)
18443 "Remove current file from the list of files in variable `org-agenda-files'.
18444 These are the files which are being checked for agenda entries.
18445 Optional argument FILE means use this file instead of the current."
18447 (let* ((org-agenda-skip-unavailable-files nil)
18448 (file (or file buffer-file-name
18449 (user-error "Current buffer does not visit a file")))
18450 (true-file (file-truename file))
18451 (afile (abbreviate-file-name file))
18452 (files (delq nil (mapcar
18454 (if (equal true-file
18457 (org-agenda-files t)))))
18458 (if (not (= (length files) (length (org-agenda-files t))))
18460 (org-store-new-agenda-file-list files)
18461 (org-install-agenda-files-menu)
18462 (message "Removed from Org Agenda list: %s" afile))
18463 (message "File was not in list: %s (not removed)" afile))))
18465 (defun org-file-menu-entry (file)
18466 (vector file (list 'find-file file) t))
18468 (defun org-check-agenda-file (file)
18469 "Make sure FILE exists. If not, ask user what to do."
18470 (when (not (file-exists-p file))
18471 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18472 (abbreviate-file-name file))
18473 (let ((r (downcase (read-char-exclusive))))
18476 (org-remove-file file)
18477 (throw 'nextfile t))
18478 (t (user-error "Abort"))))))
18480 (defun org-get-agenda-file-buffer (file)
18481 "Get an agenda buffer visiting FILE.
18482 If the buffer needs to be created, add it to the list of buffers
18483 which might be released later."
18484 (let ((buf (org-find-base-buffer-visiting file)))
18486 buf ; just return it
18487 ;; Make a new buffer and remember it
18488 (setq buf (find-file-noselect file))
18489 (if buf (push buf org-agenda-new-buffers))
18492 (defun org-release-buffers (blist)
18493 "Release all buffers in list, asking the user for confirmation when needed.
18494 When a buffer is unmodified, it is just killed. When modified, it is saved
18495 \(if the user agrees) and then killed."
18497 (while (setq buf (pop blist))
18498 (setq file (buffer-file-name buf))
18499 (when (and (buffer-modified-p buf)
18501 (y-or-n-p (format "Save file %s? " file)))
18502 (with-current-buffer buf (save-buffer)))
18503 (kill-buffer buf))))
18505 (defun org-agenda-prepare-buffers (files)
18506 "Create buffers for all agenda files, protect archived trees and comments."
18508 (let ((pa '(:org-archived t))
18509 (pc '(:org-comment t))
18510 (pall '(:org-archived t :org-comment t))
18511 (inhibit-read-only t)
18512 (org-inhibit-startup org-agenda-inhibit-startup)
18513 (rea (concat ":" org-archive-tag ":"))
18515 (setq org-tag-alist-for-agenda nil
18516 org-tag-groups-alist-for-agenda nil)
18519 (while (setq file (pop files))
18523 (org-check-agenda-file file)
18524 (set-buffer (org-get-agenda-file-buffer file)))
18526 (org-set-regexps-and-options 'tags-only)
18528 (or (memq 'category org-agenda-ignore-properties)
18529 (org-refresh-category-properties))
18530 (or (memq 'stats org-agenda-ignore-properties)
18531 (org-refresh-stats-properties))
18532 (or (memq 'effort org-agenda-ignore-properties)
18533 (org-refresh-effort-properties))
18534 (or (memq 'appt org-agenda-ignore-properties)
18535 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18536 (setq org-todo-keywords-for-agenda
18537 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18538 (setq org-done-keywords-for-agenda
18539 (append org-done-keywords-for-agenda org-done-keywords))
18540 (setq org-todo-keyword-alist-for-agenda
18541 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18542 (setq org-tag-alist-for-agenda
18544 (append org-tag-alist-for-agenda
18546 org-tag-persistent-alist)))
18548 (setq org-tag-groups-alist-for-agenda
18549 (org-uniquify-alist
18550 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18551 (org-with-silent-modifications
18553 (remove-text-properties (point-min) (point-max) pall)
18554 (when org-agenda-skip-archived-trees
18555 (goto-char (point-min))
18556 (while (re-search-forward rea nil t)
18557 (if (org-at-heading-p t)
18558 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18559 (goto-char (point-min))
18560 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18561 (while (re-search-forward re nil t)
18562 (when (save-match-data (org-in-commented-heading-p t))
18563 (add-text-properties
18564 (match-beginning 0) (org-end-of-subtree t) pc)))))
18565 (goto-char pos)))))
18566 (setq org-todo-keywords-for-agenda
18567 (org-uniquify org-todo-keywords-for-agenda))
18568 (setq org-todo-keyword-alist-for-agenda
18569 (org-uniquify org-todo-keyword-alist-for-agenda))))
18572 ;;;; CDLaTeX minor mode
18574 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18575 "Keymap for the minor `org-cdlatex-mode'.")
18577 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18578 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18579 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18580 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18581 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18583 (defvar org-cdlatex-texmathp-advice-is-done nil
18584 "Flag remembering if we have applied the advice to texmathp already.")
18586 (define-minor-mode org-cdlatex-mode
18587 "Toggle the minor `org-cdlatex-mode'.
18588 This mode supports entering LaTeX environment and math in LaTeX fragments
18590 \\{org-cdlatex-mode-map}"
18592 (when org-cdlatex-mode
18594 (run-hooks 'cdlatex-mode-hook)
18595 (cdlatex-compute-tables))
18596 (unless org-cdlatex-texmathp-advice-is-done
18597 (setq org-cdlatex-texmathp-advice-is-done t)
18598 (defadvice texmathp (around org-math-always-on activate)
18599 "Always return t in org-mode buffers.
18600 This is because we want to insert math symbols without dollars even outside
18601 the LaTeX math segments. If Orgmode thinks that point is actually inside
18602 an embedded LaTeX fragment, let texmathp do its job.
18603 \\[org-cdlatex-mode-map]"
18607 ((not (derived-mode-p 'org-mode)) ad-do-it)
18608 ((eq this-command 'cdlatex-math-symbol)
18609 (setq ad-return-value t
18610 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18612 (let ((p (org-inside-LaTeX-fragment-p)))
18613 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18614 (setq ad-return-value t
18615 texmathp-why '("Org-mode embedded math" . 0))
18616 (if p ad-do-it)))))))))
18618 (defun turn-on-org-cdlatex ()
18619 "Unconditionally turn on `org-cdlatex-mode'."
18620 (org-cdlatex-mode 1))
18622 (defun org-try-cdlatex-tab ()
18623 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18624 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18625 - inside a LaTeX fragment, or
18626 - after the first word in a line, where an abbreviation expansion could
18627 insert a LaTeX environment."
18628 (when org-cdlatex-mode
18630 ;; Before any word on the line: No expansion possible.
18631 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18632 ;; Just after first word on the line: Expand it. Make sure it
18633 ;; cannot happen on headlines, though.
18635 (skip-chars-backward "a-zA-Z0-9*")
18636 (skip-chars-backward " \t")
18637 (and (bolp) (not (org-at-heading-p))))
18639 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18641 (defun org-cdlatex-underscore-caret (&optional arg)
18642 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18643 Revert to the normal definition outside of these fragments."
18645 (if (org-inside-LaTeX-fragment-p)
18646 (call-interactively 'cdlatex-sub-superscript)
18647 (let (org-cdlatex-mode)
18648 (call-interactively (key-binding (vector last-input-event))))))
18650 (defun org-cdlatex-math-modify (&optional arg)
18651 "Execute `cdlatex-math-modify' in LaTeX fragments.
18652 Revert to the normal definition outside of these fragments."
18654 (if (org-inside-LaTeX-fragment-p)
18655 (call-interactively 'cdlatex-math-modify)
18656 (let (org-cdlatex-mode)
18657 (call-interactively (key-binding (vector last-input-event))))))
18659 (defun org-cdlatex-environment-indent (&optional environment item)
18660 "Execute `cdlatex-environment' and indent the inserted environment."
18662 (cdlatex-environment environment item)
18663 (let ((element (org-element-at-point)))
18664 (org-indent-region (org-element-property :begin element)
18665 (org-element-property :end element))))
18668 ;;;; LaTeX fragments
18670 (defun org-inside-LaTeX-fragment-p ()
18671 "Test if point is inside a LaTeX fragment.
18672 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18673 sequence appearing also before point.
18674 Even though the matchers for math are configurable, this function assumes
18675 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18676 delimiters are skipped when they have been removed by customization.
18677 The return value is nil, or a cons cell with the delimiter and the
18678 position of this delimiter.
18680 This function does a reasonably good job, but can locally be fooled by
18681 for example currency specifications. For example it will assume being in
18682 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18683 fragments that are properly closed, but during editing, we have to live
18684 with the uncertainty caused by missing closing delimiters. This function
18685 looks only before point, not after."
18687 (let ((pos (point))
18688 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18690 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18692 dd-on str (start 0) m re)
18695 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18696 re (nth 1 (assoc "$" org-latex-regexps)))
18697 (while (string-match re str start)
18699 ((= (match-end 0) (length str))
18700 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18701 ((= (match-end 0) (- (length str) 5))
18703 (t (setq start (match-end 0))))))
18704 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18706 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18707 (and (match-beginning 2) (throw 'exit nil))
18709 (while (re-search-backward "\\$\\$" lim t)
18710 (setq dd-on (not dd-on)))
18712 (if dd-on (cons "$$" m))))))
18714 (defun org-inside-latex-macro-p ()
18715 "Is point inside a LaTeX macro or its arguments?"
18718 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18720 (defvar org-latex-fragment-image-overlays nil
18721 "List of overlays carrying the images of latex fragments.")
18722 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18724 (defun org-remove-latex-fragment-image-overlays ()
18725 "Remove all overlays with LaTeX fragment images in current buffer."
18726 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18727 (setq org-latex-fragment-image-overlays nil))
18729 (define-obsolete-function-alias
18730 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18731 (defun org-toggle-latex-fragment (&optional subtree)
18732 "Preview the LaTeX fragment at point, or all locally or globally.
18733 If the cursor is in a LaTeX fragment, create the image and overlay
18734 it over the source code. If there is no fragment at point, display
18735 all fragments in the current text, from one headline to the next. With
18736 prefix SUBTREE, display all fragments in the current subtree. With a
18737 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18738 the cursor is before the first headline,
18739 display all fragments in the buffer.
18740 The images can be removed again with \\[org-toggle-latex-fragment]."
18742 (unless (buffer-file-name (buffer-base-buffer))
18743 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18744 (if org-latex-fragment-image-overlays
18745 (progn (org-remove-latex-fragment-image-overlays)
18746 (message "LaTeX fragments images removed"))
18747 (when (display-graphic-p)
18748 (org-remove-latex-fragment-image-overlays)
18749 (org-with-wide-buffer
18752 ((equal subtree '(16))
18753 (setq beg (point-min) end (point-max)
18754 msg "Creating images for buffer...%s"))
18755 ((equal subtree '(4))
18756 (org-back-to-heading)
18757 (setq beg (point) end (org-end-of-subtree t)
18758 msg "Creating images for subtree...%s"))
18759 ((let ((context (org-element-context)))
18760 (when (memq (org-element-type context)
18761 '(latex-environment latex-fragment))
18762 (setq beg (org-element-property :begin context)
18763 end (org-element-property :end context)
18764 msg "Creating image...%s"))))
18765 ((org-before-first-heading-p)
18766 (setq beg (point-min) end (point-max)
18767 msg "Creating images for buffer...%s"))
18769 (org-back-to-heading)
18770 (setq beg (point) end (progn (outline-next-heading) (point))
18771 msg "Creating images for entry...%s")))
18773 (narrow-to-region beg end)
18776 (concat org-latex-preview-ltxpng-directory
18777 (file-name-sans-extension
18778 (file-name-nondirectory
18779 (buffer-file-name (buffer-base-buffer)))))
18780 default-directory 'overlays msg 'forbuffer
18781 org-latex-create-formula-image-program)
18782 (message msg "done. Use `C-c C-x C-l' to remove images."))))))
18784 (defun org-format-latex
18785 (prefix &optional dir overlays msg forbuffer processing-type)
18786 "Replace LaTeX fragments with links to an image, and produce images.
18787 Some of the options can be changed using the variable
18788 `org-format-latex-options'."
18789 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18790 (unless (eq processing-type 'verbatim)
18791 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
18794 (goto-char (point-min))
18795 (while (re-search-forward math-regexp nil t)
18796 (unless (and overlays
18797 (eq (get-char-property (point) 'org-overlay-type)
18798 'org-latex-overlay))
18799 (let* ((context (org-element-context))
18800 (type (org-element-type context)))
18801 (when (memq type '(latex-environment latex-fragment))
18802 (let ((block-type (eq type 'latex-environment))
18803 (value (org-element-property :value context))
18804 (beg (org-element-property :begin context))
18805 (end (save-excursion
18806 (goto-char (org-element-property :end context))
18807 (skip-chars-backward " \r\t\n")
18809 (case processing-type
18811 ;; Prepare for MathJax processing.
18812 (if (eq (char-after beg) ?$)
18814 (delete-region beg end)
18815 (insert "\\(" (substring value 1 -1) "\\)"))
18817 ((dvipng imagemagick)
18818 ;; Process to an image.
18821 (let* ((face (face-at-point))
18822 ;; Get the colors from the face at point.
18824 (let ((color (plist-get org-format-latex-options
18826 (if (and forbuffer (eq color 'auto))
18827 (face-attribute face :foreground nil 'default)
18830 (let ((color (plist-get org-format-latex-options
18832 (if (and forbuffer (eq color 'auto))
18833 (face-attribute face :background nil 'default)
18835 (hash (sha1 (prin1-to-string
18836 (list org-format-latex-header
18837 org-latex-default-packages-alist
18838 org-latex-packages-alist
18839 org-format-latex-options
18840 forbuffer value fg bg))))
18841 (absprefix (expand-file-name prefix dir))
18842 (linkfile (format "%s_%s.png" prefix hash))
18843 (movefile (format "%s_%s.png" absprefix hash))
18844 (sep (and block-type "\n\n"))
18845 (link (concat sep "[[file:" linkfile "]]" sep))
18847 (org-combine-plists
18848 org-format-latex-options
18849 `(:foreground ,fg :background ,bg))))
18850 (when msg (message msg cnt))
18851 (unless checkdir-flag ; Ensure the directory exists.
18852 (setq checkdir-flag t)
18853 (let ((todir (file-name-directory absprefix)))
18854 (unless (file-directory-p todir)
18855 (make-directory todir t))))
18856 (unless (file-exists-p movefile)
18857 (org-create-formula-image
18858 value movefile options forbuffer processing-type))
18861 (dolist (o (overlays-in beg end))
18862 (when (eq (overlay-get o 'org-overlay-type)
18863 'org-latex-overlay)
18864 (delete-overlay o)))
18865 (let ((ov (make-overlay beg end)))
18868 'org-latex-overlay)
18869 (if (featurep 'xemacs)
18871 (overlay-put ov 'invisible t)
18875 (vector 'png :file movefile))))
18882 (push ov org-latex-fragment-image-overlays))
18884 (delete-region beg end)
18886 (org-add-props link
18887 (list 'org-latex-src
18888 (replace-regexp-in-string "\"" "" value)
18889 'org-latex-src-embed-type
18890 (if block-type 'paragraph 'character)))))))
18892 ;; Process to MathML.
18893 (unless (org-format-latex-mathml-available-p)
18894 (user-error "LaTeX to MathML converter not configured"))
18896 (when msg (message msg cnt))
18898 (delete-region beg end)
18899 (insert (org-format-latex-as-mathml
18900 value block-type prefix dir)))
18902 (error "Unknown conversion type %s for LaTeX fragments"
18903 processing-type)))))))))))
18905 (defun org-create-math-formula (latex-frag &optional mathml-file)
18906 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18907 Use `org-latex-to-mathml-convert-command'. If the conversion is
18908 sucessful, return the portion between \"<math...> </math>\"
18909 elements otherwise return nil. When MATHML-FILE is specified,
18910 write the results in to that file. When invoked as an
18911 interactive command, prompt for LATEX-FRAG, with initial value
18912 set to the current active region and echo the results for user
18914 (interactive (list (let ((frag (when (org-region-active-p)
18915 (buffer-substring-no-properties
18916 (region-beginning) (region-end)))))
18917 (read-string "LaTeX Fragment: " frag nil frag))))
18918 (unless latex-frag (user-error "Invalid LaTeX fragment"))
18919 (let* ((tmp-in-file (file-relative-name
18920 (make-temp-name (expand-file-name "ltxmathml-in"))))
18921 (ignore (write-region latex-frag nil tmp-in-file))
18922 (tmp-out-file (file-relative-name
18923 (make-temp-name (expand-file-name "ltxmathml-out"))))
18925 org-latex-to-mathml-convert-command
18926 `((?j . ,(shell-quote-argument
18927 (expand-file-name org-latex-to-mathml-jar-file)))
18928 (?I . ,(shell-quote-argument tmp-in-file))
18929 (?o . ,(shell-quote-argument tmp-out-file)))))
18930 mathml shell-command-output)
18931 (when (org-called-interactively-p 'any)
18932 (unless (org-format-latex-mathml-available-p)
18933 (user-error "LaTeX to MathML converter not configured")))
18934 (message "Running %s" cmd)
18935 (setq shell-command-output (shell-command-to-string cmd))
18937 (when (file-readable-p tmp-out-file)
18938 (with-current-buffer (find-file-noselect tmp-out-file t)
18939 (goto-char (point-min))
18940 (when (re-search-forward
18943 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18945 (regexp-quote "</math>")) nil t)
18946 (prog1 (match-string 0) (kill-buffer))))))
18950 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18952 (write-region mathml nil mathml-file))
18953 (when (org-called-interactively-p 'any)
18955 ((message "LaTeX to MathML conversion failed")
18956 (message shell-command-output)))
18957 (delete-file tmp-in-file)
18958 (when (file-exists-p tmp-out-file)
18959 (delete-file tmp-out-file))
18962 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18963 prefix &optional dir)
18964 "Use `org-create-math-formula' but check local cache first."
18965 (let* ((absprefix (expand-file-name prefix dir))
18966 (print-length nil) (print-level nil)
18967 (formula-id (concat
18972 org-latex-to-mathml-convert-command)))))
18973 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18974 (formula-cache-dir (file-name-directory formula-cache)))
18976 (unless (file-directory-p formula-cache-dir)
18977 (make-directory formula-cache-dir t))
18979 (unless (file-exists-p formula-cache)
18980 (org-create-math-formula latex-frag formula-cache))
18982 (if (file-exists-p formula-cache)
18983 ;; Successful conversion. Return the link to MathML file.
18985 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18986 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18987 'org-latex-src-embed-type (if latex-frag-type
18988 'paragraph 'character)))
18989 ;; Failed conversion. Return the LaTeX fragment verbatim
18992 (defun org-create-formula-image (string tofile options buffer &optional type)
18993 "Create an image from LaTeX source using dvipng or convert.
18994 This function calls either `org-create-formula-image-with-dvipng'
18995 or `org-create-formula-image-with-imagemagick' depending on the
18996 value of `org-latex-create-formula-image-program' or on the value
18997 of the optional TYPE variable.
18999 Note: ultimately these two function should be combined as they
19000 share a good deal of logic."
19001 (org-check-external-command
19002 "latex" "needed to convert LaTeX fragments to images")
19004 (case (or type org-latex-create-formula-image-program)
19006 (org-check-external-command
19007 "dvipng" "needed to convert LaTeX fragments to images")
19008 'org-create-formula-image-with-dvipng)
19010 (org-check-external-command
19011 "convert" "you need to install imagemagick")
19012 'org-create-formula-image-with-imagemagick)
19014 "Invalid value of `org-latex-create-formula-image-program'")))
19015 string tofile options buffer))
19017 (declare-function org-export-get-backend "ox" (name))
19018 (declare-function org-export--get-global-options "ox" (&optional backend))
19019 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19020 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19021 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19022 (defun org-create-formula--latex-header ()
19023 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19024 (let ((info (org-combine-plists (org-export--get-global-options
19025 (org-export-get-backend 'latex))
19026 (org-export--get-inbuffer-options
19027 (org-export-get-backend 'latex)))))
19028 (org-latex-guess-babel-language
19029 (org-latex-guess-inputenc
19030 (org-splice-latex-header
19031 org-format-latex-header
19032 org-latex-default-packages-alist
19033 org-latex-packages-alist t
19034 (plist-get info :latex-header)))
19037 ;; This function borrows from Ganesh Swami's latex2png.el
19038 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19039 "This calls dvipng."
19040 (require 'ox-latex)
19041 (let* ((tmpdir (if (featurep 'xemacs)
19043 temporary-file-directory))
19044 (texfilebase (make-temp-name
19045 (expand-file-name "orgtex" tmpdir)))
19046 (texfile (concat texfilebase ".tex"))
19047 (dvifile (concat texfilebase ".dvi"))
19048 (pngfile (concat texfilebase ".png"))
19049 (fnh (if (featurep 'xemacs)
19050 (font-height (face-font 'default))
19051 (face-attribute 'default :height nil)))
19052 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19053 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
19054 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19056 (bg (or (plist-get options (if buffer :background :html-background))
19058 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19059 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19060 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19061 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19062 (let ((latex-header (org-create-formula--latex-header)))
19063 (with-temp-file texfile
19064 (insert latex-header)
19065 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19066 (let ((dir default-directory))
19069 (call-process "latex" nil nil nil texfile))
19071 (if (not (file-exists-p dvifile))
19072 (progn (message "Failed to create dvi file from %s" texfile) nil)
19074 (if (featurep 'xemacs)
19075 (call-process "dvipng" nil nil nil
19080 (call-process "dvipng" nil nil nil
19083 ;;"-x" scale "-y" scale
19087 (if (not (file-exists-p pngfile))
19088 (if org-format-latex-signal-error
19089 (error "Failed to create png file from %s" texfile)
19090 (message "Failed to create png file from %s" texfile)
19092 ;; Use the requested file name and clean up
19093 (copy-file pngfile tofile 'replace)
19094 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19095 (if (file-exists-p (concat texfilebase e))
19096 (delete-file (concat texfilebase e))))
19099 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19100 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19101 "This calls convert, which is included into imagemagick."
19102 (require 'ox-latex)
19103 (let* ((tmpdir (if (featurep 'xemacs)
19105 temporary-file-directory))
19106 (texfilebase (make-temp-name
19107 (expand-file-name "orgtex" tmpdir)))
19108 (texfile (concat texfilebase ".tex"))
19109 (pdffile (concat texfilebase ".pdf"))
19110 (pngfile (concat texfilebase ".png"))
19111 (fnh (if (featurep 'xemacs)
19112 (font-height (face-font 'default))
19113 (face-attribute 'default :height nil)))
19114 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19115 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
19116 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19118 (bg (or (plist-get options (if buffer :background :html-background))
19120 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19121 (setq fg (org-latex-color-format fg)))
19122 (if (eq bg 'default) (setq bg (org-latex-color :background))
19123 (setq bg (org-latex-color-format
19124 (if (string= bg "Transparent") "white" bg))))
19125 (let ((latex-header (org-create-formula--latex-header)))
19126 (with-temp-file texfile
19127 (insert latex-header)
19128 (insert "\n\\begin{document}\n"
19129 "\\definecolor{fg}{rgb}{" fg "}\n"
19130 "\\definecolor{bg}{rgb}{" bg "}\n"
19131 "\n\\pagecolor{bg}\n"
19135 "\n\\end{document}\n")))
19136 (org-latex-compile texfile t)
19137 (if (not (file-exists-p pdffile))
19138 (progn (message "Failed to create pdf file from %s" texfile) nil)
19140 (if (featurep 'xemacs)
19141 (call-process "convert" nil nil nil
19147 ;; "-sharpen" "0x1.0"
19149 (call-process "convert" nil nil nil
19155 ;; "-sharpen" "0x1.0"
19157 (if (not (file-exists-p pngfile))
19158 (if org-format-latex-signal-error
19159 (error "Failed to create png file from %s" texfile)
19160 (message "Failed to create png file from %s" texfile)
19162 ;; Use the requested file name and clean up
19163 (copy-file pngfile tofile 'replace)
19164 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19165 (if (file-exists-p (concat texfilebase e))
19166 (delete-file (concat texfilebase e))))
19169 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19170 "Fill a LaTeX header template TPL.
19171 In the template, the following place holders will be recognized:
19173 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19174 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19175 [PACKAGES] \\usepackage statements for PKG
19176 [NO-PACKAGES] do not include PKG
19177 [EXTRA] the string EXTRA
19178 [NO-EXTRA] do not include EXTRA
19180 For backward compatibility, if both the positive and the negative place
19181 holder is missing, the positive one (without the \"NO-\") will be
19182 assumed to be present at the end of the template.
19183 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19185 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19186 (let (rpl (end ""))
19187 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19188 (setq rpl (if (or (match-end 1) (not def-pkg))
19189 "" (org-latex-packages-to-string def-pkg snippets-p t))
19190 tpl (replace-match rpl t t tpl))
19191 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19193 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19194 (setq rpl (if (or (match-end 1) (not pkg))
19195 "" (org-latex-packages-to-string pkg snippets-p t))
19196 tpl (replace-match rpl t t tpl))
19199 (org-latex-packages-to-string pkg snippets-p)))))
19201 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19202 (setq rpl (if (or (match-end 1) (not extra))
19203 "" (concat extra "\n"))
19204 tpl (replace-match rpl t t tpl))
19205 (if (and extra (string-match "\\S-" extra))
19206 (setq end (concat end "\n" extra))))
19208 (if (string-match "\\S-" end)
19209 (concat tpl "\n" end)
19212 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19213 "Turn an alist of packages into a string with the \\usepackage macros."
19214 (setq pkg (mapconcat (lambda(p)
19217 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19218 (format "%% Package %s omitted" (cadr p)))
19219 ((equal "" (car p))
19220 (format "\\usepackage{%s}" (cadr p)))
19222 (format "\\usepackage[%s]{%s}"
19223 (car p) (cadr p)))))
19226 (if newline (concat pkg "\n") pkg))
19228 (defun org-dvipng-color (attr)
19229 "Return a RGB color specification for dvipng."
19230 (apply 'format "rgb %s %s %s"
19231 (mapcar 'org-normalize-color
19232 (if (featurep 'xemacs)
19233 (color-rgb-components
19234 (face-property 'default
19235 (cond ((eq attr :foreground) 'foreground)
19236 ((eq attr :background) 'background))))
19237 (color-values (face-attribute 'default attr nil))))))
19239 (defun org-dvipng-color-format (color-name)
19240 "Convert COLOR-NAME to a RGB color value for dvipng."
19241 (apply 'format "rgb %s %s %s"
19242 (mapcar 'org-normalize-color
19243 (color-values color-name))))
19245 (defun org-latex-color (attr)
19246 "Return a RGB color for the LaTeX color package."
19247 (apply 'format "%s,%s,%s"
19248 (mapcar 'org-normalize-color
19249 (if (featurep 'xemacs)
19250 (color-rgb-components
19251 (face-property 'default
19252 (cond ((eq attr :foreground) 'foreground)
19253 ((eq attr :background) 'background))))
19254 (color-values (face-attribute 'default attr nil))))))
19256 (defun org-latex-color-format (color-name)
19257 "Convert COLOR-NAME to a RGB color value."
19258 (apply 'format "%s,%s,%s"
19259 (mapcar 'org-normalize-color
19260 (color-values color-name))))
19262 (defun org-normalize-color (value)
19263 "Return string to be used as color value for an RGB component."
19264 (format "%g" (/ value 65535.0)))
19270 (defvar org-inline-image-overlays nil)
19271 (make-variable-buffer-local 'org-inline-image-overlays)
19273 (defun org-toggle-inline-images (&optional include-linked)
19274 "Toggle the display of inline images.
19275 INCLUDE-LINKED is passed to `org-display-inline-images'."
19277 (if org-inline-image-overlays
19279 (org-remove-inline-images)
19280 (message "Inline image display turned off"))
19281 (org-display-inline-images include-linked)
19282 (if (and (org-called-interactively-p)
19283 org-inline-image-overlays)
19284 (message "%d images displayed inline"
19285 (length org-inline-image-overlays))
19286 (message "No images to display inline"))))
19288 (defun org-redisplay-inline-images ()
19289 "Refresh the display of inline images."
19291 (if (not org-inline-image-overlays)
19292 (org-toggle-inline-images)
19293 (org-toggle-inline-images)
19294 (org-toggle-inline-images)))
19296 (defun org-display-inline-images (&optional include-linked refresh beg end)
19297 "Display inline images.
19299 An inline image is a link which follows either of these
19302 1. Its path is a file with an extension matching return value
19303 from `image-file-name-regexp' and it has no contents.
19305 2. Its description consists in a single link of the previous
19308 When optional argument INCLUDE-LINKED is non-nil, also links with
19309 a text description part will be inlined. This can be nice for
19310 a quick look at those images, but it does not reflect what
19311 exported files will look like.
19313 When optional argument REFRESH is non-nil, refresh existing
19314 images between BEG and END. This will create new image displays
19315 only if necessary. BEG and END default to the buffer
19318 (when (display-graphic-p)
19320 (org-remove-inline-images)
19321 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19322 (org-with-wide-buffer
19323 (goto-char (or beg (point-min)))
19324 (let ((case-fold-search t)
19325 (file-extension-re (org-image-file-name-regexp)))
19326 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19327 (let ((link (save-match-data (org-element-context))))
19328 ;; Check if we're at an inline image.
19329 (when (and (equal (org-element-property :type link) "file")
19331 (not (org-element-property :contents-begin link)))
19332 (let ((parent (org-element-property :parent link)))
19333 (or (not (eq (org-element-type parent) 'link))
19334 (not (cdr (org-element-contents parent)))))
19335 (org-string-match-p file-extension-re
19336 (org-element-property :path link)))
19337 (let ((file (expand-file-name (org-element-property :path link))))
19338 (when (file-exists-p file)
19340 ;; Apply `org-image-actual-width' specifications.
19342 ((not (image-type-available-p 'imagemagick)) nil)
19343 ((eq org-image-actual-width t) nil)
19344 ((listp org-image-actual-width)
19346 ;; First try to find a width among
19347 ;; attributes associated to the paragraph
19348 ;; containing link.
19351 (while (and (setq e (org-element-property
19353 (not (eq (org-element-type e)
19358 (goto-char (org-element-property :begin paragraph))
19361 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19362 (org-element-property
19363 :post-affiliated paragraph)
19365 (string-to-number (match-string 1))))))
19366 ;; Otherwise, fall-back to provided number.
19367 (car org-image-actual-width)))
19368 ((numberp org-image-actual-width)
19369 org-image-actual-width)))
19370 (old (get-char-property-and-overlay
19371 (org-element-property :begin link)
19372 'org-image-overlay)))
19373 (if (and (car-safe old) refresh)
19374 (image-refresh (overlay-get (cdr old) 'display))
19375 (let ((image (create-image file
19376 (and width 'imagemagick)
19381 ;; If inline image is the description
19382 ;; of another link, be sure to
19383 ;; consider the latter as the one to
19384 ;; apply the overlay on.
19386 (org-element-property :parent link)))
19387 (if (eq (org-element-type parent) 'link)
19391 (org-element-property :begin link)
19394 (org-element-property :end link))
19395 (skip-chars-backward " \t")
19397 (overlay-put ov 'display image)
19398 (overlay-put ov 'face 'default)
19399 (overlay-put ov 'org-image-overlay t)
19401 ov 'modification-hooks
19402 (list 'org-display-inline-remove-overlay))
19403 (push ov org-inline-image-overlays)))))))))))))))
19405 (define-obsolete-function-alias
19406 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19408 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19409 "Remove inline-display overlay if a corresponding region is modified."
19410 (let ((inhibit-modification-hooks t))
19411 (when (and ov after)
19412 (delete ov org-inline-image-overlays)
19413 (delete-overlay ov))))
19415 (defun org-remove-inline-images ()
19416 "Remove inline display of images."
19418 (mapc 'delete-overlay org-inline-image-overlays)
19419 (setq org-inline-image-overlays nil))
19423 ;; Outline functions from `outline-mode-prefix-map'
19424 ;; that can be remapped in Org:
19425 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19426 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19427 (define-key org-mode-map [remap outline-forward-same-level]
19428 'org-forward-heading-same-level)
19429 (define-key org-mode-map [remap outline-backward-same-level]
19430 'org-backward-heading-same-level)
19431 (define-key org-mode-map [remap show-branches]
19432 'org-kill-note-or-show-branches)
19433 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19434 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19435 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19437 ;; Outline functions from `outline-mode-prefix-map' that can not
19438 ;; be remapped in Org:
19440 ;; - the column "key binding" shows whether the Outline function is still
19441 ;; available in Org mode on the same key that it has been bound to in
19443 ;; - "overridden": key used for a different functionality in Org mode
19444 ;; - else: key still bound to the same Outline function in Org mode
19446 ;; | Outline function | key binding | Org replacement |
19447 ;; |------------------------------------+-------------+-----------------------|
19448 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
19449 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
19450 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19451 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19452 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19453 ;; | `show-entry' | overridden | no replacement |
19454 ;; | `show-children' | `C-c C-i' | visibility cycling |
19455 ;; | `show-branches' | `C-c C-k' | still same function |
19456 ;; | `show-subtree' | overridden | visibility cycling |
19457 ;; | `show-all' | overridden | no replacement |
19458 ;; | `hide-subtree' | overridden | visibility cycling |
19459 ;; | `hide-body' | overridden | no replacement |
19460 ;; | `hide-entry' | overridden | visibility cycling |
19461 ;; | `hide-leaves' | overridden | no replacement |
19462 ;; | `hide-sublevels' | overridden | no replacement |
19463 ;; | `hide-other' | overridden | no replacement |
19465 ;; Make `C-c C-x' a prefix key
19466 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19468 ;; TAB key with modifiers
19469 (org-defkey org-mode-map "\C-i" 'org-cycle)
19470 (org-defkey org-mode-map [(tab)] 'org-cycle)
19471 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19472 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19473 ;; The following line is necessary under Suse GNU/Linux
19474 (unless (featurep 'xemacs)
19475 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19476 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19477 (define-key org-mode-map [backtab] 'org-shifttab)
19479 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19480 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19481 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19483 ;; Cursor keys with modifiers
19484 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19485 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19486 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19487 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19489 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19490 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19491 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19492 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19493 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19494 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19496 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19497 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19498 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19499 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19501 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19502 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19503 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19504 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19507 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19508 (mapc (lambda (pair)
19509 (define-key org-babel-map (car pair) (cdr pair)))
19510 org-babel-key-bindings)
19512 ;;; Extra keys for tty access.
19513 ;; We only set them when really needed because otherwise the
19514 ;; menus don't show the simple keys
19516 (when (or org-use-extra-keys
19517 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19518 (not window-system))
19519 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19520 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19521 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19522 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19523 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19524 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19525 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19526 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19527 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19528 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19529 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19530 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19531 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19532 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19533 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19534 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19535 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19536 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19537 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19538 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19539 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19540 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19541 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19542 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19543 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19544 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19545 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19546 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19548 ;; All the other keys
19550 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19551 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19552 (if (boundp 'narrow-map)
19553 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19554 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19555 (if (boundp 'narrow-map)
19556 (org-defkey narrow-map "b" 'org-narrow-to-block)
19557 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19558 (if (boundp 'narrow-map)
19559 (org-defkey narrow-map "e" 'org-narrow-to-element)
19560 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19561 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19562 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19563 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19564 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19565 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19566 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19567 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19568 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19569 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19570 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19571 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19572 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19573 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19574 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19575 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19576 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19577 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19578 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19579 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19580 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19581 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19582 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19583 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19584 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19585 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19586 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19587 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19588 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19589 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19590 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19591 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19592 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19593 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19594 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19595 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19596 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19597 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19598 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19599 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19600 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19601 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19602 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19603 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19604 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19605 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19606 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19607 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19608 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19609 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19610 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19611 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19612 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19613 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19614 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19615 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19616 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19617 (org-defkey org-mode-map "\C-c^" 'org-sort)
19618 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19619 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19620 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19621 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19622 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19623 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19624 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19625 (org-defkey org-mode-map "\C-m" 'org-return)
19626 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19627 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19628 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19629 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19630 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19631 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19632 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19633 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19634 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19635 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19636 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19637 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19638 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19639 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19640 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19641 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19642 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19643 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19644 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19645 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19646 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19647 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19648 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19649 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19650 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19652 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19653 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19654 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19656 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19657 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19658 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19659 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19660 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19661 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19662 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19663 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19664 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19665 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19666 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19667 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19668 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19669 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19670 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19671 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19672 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19673 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19674 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19675 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19676 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19677 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19678 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19680 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19681 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19682 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19683 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19684 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19686 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19688 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19690 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19691 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19693 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19696 (when (featurep 'xemacs)
19697 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19700 (defconst org-speed-commands-default
19702 ("Outline Navigation")
19703 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19704 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19705 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19706 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19707 ("F" . org-next-block)
19708 ("B" . org-previous-block)
19709 ("u" . (org-speed-move-safe 'outline-up-heading))
19711 ("g" . (org-refile t))
19712 ("Outline Visibility")
19714 ("C" . org-shifttab)
19715 (" " . org-display-outline-path)
19716 ("s" . org-narrow-to-subtree)
19717 ("=" . org-columns)
19718 ("Outline Structure Editing")
19720 ("D" . org-metadown)
19721 ("r" . org-metaright)
19722 ("l" . org-metaleft)
19723 ("R" . org-shiftmetaright)
19724 ("L" . org-shiftmetaleft)
19725 ("i" . (progn (forward-char 1) (call-interactively
19726 'org-insert-heading-respect-content)))
19729 ("a" . org-archive-subtree-default-with-confirmation)
19730 ("@" . org-mark-subtree)
19731 ("#" . org-toggle-comment)
19733 ("I" . org-clock-in)
19734 ("O" . org-clock-out)
19735 ("Meta Data Editing")
19737 ("," . (org-priority))
19738 ("0" . (org-priority ?\ ))
19739 ("1" . (org-priority ?A))
19740 ("2" . (org-priority ?B))
19741 ("3" . (org-priority ?C))
19742 (":" . org-set-tags-command)
19743 ("e" . org-set-effort)
19744 ("E" . org-inc-effort)
19745 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19746 (org-entry-put (point) "APPT_WARNTIME" m)))
19747 ("Agenda Views etc")
19749 ("/" . org-sparse-tree)
19751 ("o" . org-open-at-point)
19752 ("?" . org-speed-command-help)
19753 ("<" . (org-agenda-set-restriction-lock 'subtree))
19754 (">" . (org-agenda-remove-restriction-lock))
19756 "The default speed commands.")
19758 (defun org-print-speed-command (e)
19759 (if (> (length (car e)) 1)
19764 (princ (make-string (length (car e)) ?-))
19768 (if (symbolp (cdr e))
19769 (princ (symbol-name (cdr e)))
19773 (defun org-speed-command-help ()
19774 "Show the available speed commands."
19776 (if (not org-use-speed-commands)
19777 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19778 (with-output-to-temp-buffer "*Help*"
19779 (princ "User-defined Speed commands\n===========================\n")
19780 (mapc 'org-print-speed-command org-speed-commands-user)
19782 (princ "Built-in Speed commands\n=======================\n")
19783 (mapc 'org-print-speed-command org-speed-commands-default))
19784 (with-current-buffer "*Help*"
19785 (setq truncate-lines t))))
19787 (defun org-speed-move-safe (cmd)
19788 "Execute CMD, but make sure that the cursor always ends up in a headline.
19789 If not, return to the original position and throw an error."
19791 (let ((pos (point)))
19792 (call-interactively cmd)
19793 (unless (and (bolp) (org-at-heading-p))
19795 (error "Boundary reached while executing %s" cmd))))
19797 (defvar org-self-insert-command-undo-counter 0)
19799 (defvar org-table-auto-blank-field) ; defined in org-table.el
19800 (defvar org-speed-command nil)
19802 (define-obsolete-function-alias
19803 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19805 (defun org-speed-command-activate (keys)
19806 "Hook for activating single-letter speed commands.
19807 `org-speed-commands-default' specifies a minimal command set.
19808 Use `org-speed-commands-user' for further customization."
19809 (when (or (and (bolp) (looking-at org-outline-regexp))
19810 (and (functionp org-use-speed-commands)
19811 (funcall org-use-speed-commands)))
19812 (cdr (assoc keys (append org-speed-commands-user
19813 org-speed-commands-default)))))
19815 (define-obsolete-function-alias
19816 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19818 (defun org-babel-speed-command-activate (keys)
19819 "Hook for activating single-letter code block commands."
19820 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19821 (cdr (assoc keys org-babel-key-bindings))))
19823 (defcustom org-speed-command-hook
19824 '(org-speed-command-default-hook org-babel-speed-command-hook)
19825 "Hook for activating speed commands at strategic locations.
19826 Hook functions are called in sequence until a valid handler is
19829 Each hook takes a single argument, a user-pressed command key
19830 which is also a `self-insert-command' from the global map.
19832 Within the hook, examine the cursor position and the command key
19833 and return nil or a valid handler as appropriate. Handler could
19834 be one of an interactive command, a function, or a form.
19836 Set `org-use-speed-commands' to non-nil value to enable this
19837 hook. The default setting is `org-speed-command-activate'."
19838 :group 'org-structure
19842 (defun org-self-insert-command (N)
19843 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19844 If the cursor is in a table looking at whitespace, the whitespace is
19845 overwritten, and the table is not marked as requiring realignment."
19847 (org-check-before-invisible-edit 'insert)
19849 ((and org-use-speed-commands
19850 (let ((kv (this-command-keys-vector)))
19851 (setq org-speed-command
19852 (run-hook-with-args-until-success
19853 'org-speed-command-hook
19854 (make-string 1 (aref kv (1- (length kv))))))))
19856 ((commandp org-speed-command)
19857 (setq this-command org-speed-command)
19858 (call-interactively org-speed-command))
19859 ((functionp org-speed-command)
19860 (funcall org-speed-command))
19861 ((and org-speed-command (listp org-speed-command))
19862 (eval org-speed-command))
19863 (t (let (org-use-speed-commands)
19864 (call-interactively 'org-self-insert-command)))))
19868 ;; check if we blank the field, and if that triggers align
19869 (and (featurep 'org-table) org-table-auto-blank-field
19871 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
19872 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19873 ;; got extra space, this field does not determine column width
19874 (let (org-table-may-need-update) (org-table-blank-field))
19875 ;; no extra space, this field may determine column width
19876 (org-table-blank-field)))
19879 (looking-at "[^|\n]* |"))
19880 (let (org-table-may-need-update)
19881 (goto-char (1- (match-end 0)))
19882 (backward-delete-char 1)
19883 (goto-char (match-beginning 0))
19884 (self-insert-command N)))
19886 (setq org-table-may-need-update t)
19887 (self-insert-command N)
19888 (org-fix-tags-on-the-fly)
19889 (if org-self-insert-cluster-for-undo
19890 (if (not (eq last-command 'org-self-insert-command))
19891 (setq org-self-insert-command-undo-counter 1)
19892 (if (>= org-self-insert-command-undo-counter 20)
19893 (setq org-self-insert-command-undo-counter 1)
19894 (and (> org-self-insert-command-undo-counter 0)
19895 buffer-undo-list (listp buffer-undo-list)
19896 (not (cadr buffer-undo-list)) ; remove nil entry
19897 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19898 (setq org-self-insert-command-undo-counter
19899 (1+ org-self-insert-command-undo-counter))))))))
19901 (defun org-check-before-invisible-edit (kind)
19902 "Check is editing if kind KIND would be dangerous with invisible text around.
19903 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19904 ;; First, try to get out of here as quickly as possible, to reduce overhead
19905 (if (and org-catch-invisible-edits
19906 (or (not (boundp 'visible-mode)) (not visible-mode))
19907 (or (get-char-property (point) 'invisible)
19908 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19909 ;; OK, we need to take a closer look
19910 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19911 (invisible-before-point (if (bobp) nil (get-char-property
19912 (1- (point)) 'invisible)))
19913 (border-and-ok-direction
19915 ;; Check if we are acting predictably before invisible text
19916 (and invisible-at-point (not invisible-before-point)
19917 (memq kind '(insert delete-backward)))
19918 ;; Check if we are acting predictably after invisible text
19919 ;; This works not well, and I have turned it off. It seems
19920 ;; better to always show and stop after invisible text.
19921 ;; (and (not invisible-at-point) invisible-before-point
19922 ;; (memq kind '(insert delete)))
19924 (when (or (memq invisible-at-point '(outline org-hide-block t))
19925 (memq invisible-before-point '(outline org-hide-block t)))
19926 (if (eq org-catch-invisible-edits 'error)
19927 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19928 (if (and org-custom-properties-overlays
19929 (y-or-n-p "Display invisible properties in this buffer? "))
19930 (org-toggle-custom-properties-visibility)
19931 ;; Make the area visible
19933 (if invisible-before-point
19934 (goto-char (previous-single-char-property-change
19935 (point) 'invisible)))
19938 ((eq org-catch-invisible-edits 'show)
19939 ;; That's it, we do the edit after showing
19941 "Unfolding invisible region around point before editing")
19943 ((and (eq org-catch-invisible-edits 'smart)
19944 border-and-ok-direction)
19945 (message "Unfolding invisible region around point before editing"))
19947 ;; Don't do the edit, make the user repeat it in full visibility
19948 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19950 (defun org-fix-tags-on-the-fly ()
19951 (when (and (equal (char-after (point-at-bol)) ?*)
19952 (org-at-heading-p))
19953 (org-align-tags-here org-tags-column)))
19955 (defun org-delete-backward-char (N)
19956 "Like `delete-backward-char', insert whitespace at field end in tables.
19957 When deleting backwards, in tables this function will insert whitespace in
19958 front of the next \"|\" separator, to keep the table aligned. The table will
19959 still be marked for re-alignment if the field did fill the entire column,
19960 because, in this case the deletion might narrow the column."
19963 (org-check-before-invisible-edit 'delete-backward)
19964 (if (and (org-table-p)
19966 (string-match "|" (buffer-substring (point-at-bol) (point)))
19967 (looking-at ".*?|"))
19968 (let ((pos (point))
19969 (noalign (looking-at "[^|\n\r]* |"))
19970 (c org-table-may-need-update))
19971 (backward-delete-char N)
19972 (if (not overwrite-mode)
19974 (skip-chars-forward "^|")
19976 (goto-char (1- pos))))
19977 ;; noalign: if there were two spaces at the end, this field
19978 ;; does not determine the width of the column.
19979 (if noalign (setq org-table-may-need-update c)))
19980 (backward-delete-char N)
19981 (org-fix-tags-on-the-fly))))
19983 (defun org-delete-char (N)
19984 "Like `delete-char', but insert whitespace at field end in tables.
19985 When deleting characters, in tables this function will insert whitespace in
19986 front of the next \"|\" separator, to keep the table aligned. The table will
19987 still be marked for re-alignment if the field did fill the entire column,
19988 because, in this case the deletion might narrow the column."
19991 (org-check-before-invisible-edit 'delete)
19992 (if (and (org-table-p)
19994 (not (= (char-after) ?|))
19996 (if (looking-at ".*?|")
19997 (let ((pos (point))
19998 (noalign (looking-at "[^|\n\r]* |"))
19999 (c org-table-may-need-update))
20001 (concat (substring (match-string 0) 1 -1) " |") nil t)
20003 ;; noalign: if there were two spaces at the end, this field
20004 ;; does not determine the width of the column.
20005 (if noalign (setq org-table-may-need-update c)))
20008 (org-fix-tags-on-the-fly))))
20010 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20011 (put 'org-self-insert-command 'delete-selection
20013 (not (run-hook-with-args-until-success
20014 'self-insert-uses-region-functions))))
20015 (put 'orgtbl-self-insert-command 'delete-selection
20017 (not (run-hook-with-args-until-success
20018 'self-insert-uses-region-functions))))
20019 (put 'org-delete-char 'delete-selection 'supersede)
20020 (put 'org-delete-backward-char 'delete-selection 'supersede)
20021 (put 'org-yank 'delete-selection 'yank)
20023 ;; Make `flyspell-mode' delay after some commands
20024 (put 'org-self-insert-command 'flyspell-delayed t)
20025 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20026 (put 'org-delete-char 'flyspell-delayed t)
20027 (put 'org-delete-backward-char 'flyspell-delayed t)
20029 ;; Make pabbrev-mode expand after org-mode commands
20030 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20031 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20033 (defun org-remap (map &rest commands)
20034 "In MAP, remap the functions given in COMMANDS.
20035 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20038 (setq old (pop commands) new (pop commands))
20039 (if (fboundp 'command-remapping)
20040 (org-defkey map (vector 'remap old) new)
20041 (substitute-key-definition old new map global-map)))))
20043 (defun org-transpose-words ()
20044 "Transpose words for Org.
20045 This uses the `org-mode-transpose-word-syntax-table' syntax
20046 table, which interprets characters in `org-emphasis-alist' as
20047 word constituents."
20049 (with-syntax-table org-mode-transpose-word-syntax-table
20050 (call-interactively 'transpose-words)))
20051 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20053 (when (eq org-enable-table-editor 'optimized)
20054 ;; If the user wants maximum table support, we need to hijack
20055 ;; some standard editing functions
20056 (org-remap org-mode-map
20057 'self-insert-command 'org-self-insert-command
20058 'delete-char 'org-delete-char
20059 'delete-backward-char 'org-delete-backward-char)
20060 (org-defkey org-mode-map "|" 'org-force-self-insert))
20062 (defvar org-ctrl-c-ctrl-c-hook nil
20063 "Hook for functions attaching themselves to `C-c C-c'.
20065 This can be used to add additional functionality to the C-c C-c
20066 key which executes context-dependent commands. This hook is run
20067 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20068 run after the last test.
20070 Each function will be called with no arguments. The function
20071 must check if the context is appropriate for it to act. If yes,
20072 it should do its thing and then return a non-nil value. If the
20073 context is wrong, just do nothing and return nil.")
20075 (defvar org-ctrl-c-ctrl-c-final-hook nil
20076 "Hook for functions attaching themselves to `C-c C-c'.
20078 This can be used to add additional functionality to the C-c C-c
20079 key which executes context-dependent commands. This hook is run
20080 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20081 before the first test.
20083 Each function will be called with no arguments. The function
20084 must check if the context is appropriate for it to act. If yes,
20085 it should do its thing and then return a non-nil value. If the
20086 context is wrong, just do nothing and return nil.")
20088 (defvar org-tab-first-hook nil
20089 "Hook for functions to attach themselves to TAB.
20090 See `org-ctrl-c-ctrl-c-hook' for more information.
20091 This hook runs as the first action when TAB is pressed, even before
20092 `org-cycle' messes around with the `outline-regexp' to cater for
20093 inline tasks and plain list item folding.
20094 If any function in this hook returns t, any other actions that
20095 would have been caused by TAB (such as table field motion or visibility
20096 cycling) will not occur.")
20098 (defvar org-tab-after-check-for-table-hook nil
20099 "Hook for functions to attach themselves to TAB.
20100 See `org-ctrl-c-ctrl-c-hook' for more information.
20101 This hook runs after it has been established that the cursor is not in a
20102 table, but before checking if the cursor is in a headline or if global cycling
20104 If any function in this hook returns t, not other actions like visibility
20105 cycling will be done.")
20107 (defvar org-tab-after-check-for-cycling-hook nil
20108 "Hook for functions to attach themselves to TAB.
20109 See `org-ctrl-c-ctrl-c-hook' for more information.
20110 This hook runs after it has been established that not table field motion and
20111 not visibility should be done because of current context. This is probably
20112 the place where a package like yasnippets can hook in.")
20114 (defvar org-tab-before-tab-emulation-hook nil
20115 "Hook for functions to attach themselves to TAB.
20116 See `org-ctrl-c-ctrl-c-hook' for more information.
20117 This hook runs after every other options for TAB have been exhausted, but
20118 before indentation and \t insertion takes place.")
20120 (defvar org-metaleft-hook nil
20121 "Hook for functions attaching themselves to `M-left'.
20122 See `org-ctrl-c-ctrl-c-hook' for more information.")
20123 (defvar org-metaright-hook nil
20124 "Hook for functions attaching themselves to `M-right'.
20125 See `org-ctrl-c-ctrl-c-hook' for more information.")
20126 (defvar org-metaup-hook nil
20127 "Hook for functions attaching themselves to `M-up'.
20128 See `org-ctrl-c-ctrl-c-hook' for more information.")
20129 (defvar org-metadown-hook nil
20130 "Hook for functions attaching themselves to `M-down'.
20131 See `org-ctrl-c-ctrl-c-hook' for more information.")
20132 (defvar org-shiftmetaleft-hook nil
20133 "Hook for functions attaching themselves to `M-S-left'.
20134 See `org-ctrl-c-ctrl-c-hook' for more information.")
20135 (defvar org-shiftmetaright-hook nil
20136 "Hook for functions attaching themselves to `M-S-right'.
20137 See `org-ctrl-c-ctrl-c-hook' for more information.")
20138 (defvar org-shiftmetaup-hook nil
20139 "Hook for functions attaching themselves to `M-S-up'.
20140 See `org-ctrl-c-ctrl-c-hook' for more information.")
20141 (defvar org-shiftmetadown-hook nil
20142 "Hook for functions attaching themselves to `M-S-down'.
20143 See `org-ctrl-c-ctrl-c-hook' for more information.")
20144 (defvar org-metareturn-hook nil
20145 "Hook for functions attaching themselves to `M-RET'.
20146 See `org-ctrl-c-ctrl-c-hook' for more information.")
20147 (defvar org-shiftup-hook nil
20148 "Hook for functions attaching themselves to `S-up'.
20149 See `org-ctrl-c-ctrl-c-hook' for more information.")
20150 (defvar org-shiftup-final-hook nil
20151 "Hook for functions attaching themselves to `S-up'.
20152 This one runs after all other options except shift-select have been excluded.
20153 See `org-ctrl-c-ctrl-c-hook' for more information.")
20154 (defvar org-shiftdown-hook nil
20155 "Hook for functions attaching themselves to `S-down'.
20156 See `org-ctrl-c-ctrl-c-hook' for more information.")
20157 (defvar org-shiftdown-final-hook nil
20158 "Hook for functions attaching themselves to `S-down'.
20159 This one runs after all other options except shift-select have been excluded.
20160 See `org-ctrl-c-ctrl-c-hook' for more information.")
20161 (defvar org-shiftleft-hook nil
20162 "Hook for functions attaching themselves to `S-left'.
20163 See `org-ctrl-c-ctrl-c-hook' for more information.")
20164 (defvar org-shiftleft-final-hook nil
20165 "Hook for functions attaching themselves to `S-left'.
20166 This one runs after all other options except shift-select have been excluded.
20167 See `org-ctrl-c-ctrl-c-hook' for more information.")
20168 (defvar org-shiftright-hook nil
20169 "Hook for functions attaching themselves to `S-right'.
20170 See `org-ctrl-c-ctrl-c-hook' for more information.")
20171 (defvar org-shiftright-final-hook nil
20172 "Hook for functions attaching themselves to `S-right'.
20173 This one runs after all other options except shift-select have been excluded.
20174 See `org-ctrl-c-ctrl-c-hook' for more information.")
20176 (defun org-modifier-cursor-error ()
20177 "Throw an error, a modified cursor command was applied in wrong context."
20178 (user-error "This command is active in special context like tables, headlines or items"))
20180 (defun org-shiftselect-error ()
20181 "Throw an error because Shift-Cursor command was applied in wrong context."
20182 (if (and (boundp 'shift-select-mode) shift-select-mode)
20183 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20184 (user-error "This command works only in special context like headlines or timestamps")))
20186 (defun org-call-for-shift-select (cmd)
20187 (let ((this-command-keys-shift-translated t))
20188 (call-interactively cmd)))
20190 (defun org-shifttab (&optional arg)
20191 "Global visibility cycling or move to previous table field.
20192 Call `org-table-previous-field' within a table.
20193 When ARG is nil, cycle globally through visibility states.
20194 When ARG is a numeric prefix, show contents of this level."
20197 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20199 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20200 (message "Content view to level: %d" arg)
20201 (org-content (prefix-numeric-value arg2))
20202 (org-cycle-show-empty-lines t)
20203 (setq org-cycle-global-status 'overview)))
20204 (t (call-interactively 'org-global-cycle))))
20206 (defun org-shiftmetaleft ()
20207 "Promote subtree or delete table column.
20208 Calls `org-promote-subtree', `org-outdent-item-tree', or
20209 `org-table-delete-column', depending on context. See the
20210 individual commands for more information."
20213 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20214 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20215 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20216 ((if (not (org-region-active-p)) (org-at-item-p)
20217 (save-excursion (goto-char (region-beginning))
20219 (call-interactively 'org-outdent-item-tree))
20220 (t (org-modifier-cursor-error))))
20222 (defun org-shiftmetaright ()
20223 "Demote subtree or insert table column.
20224 Calls `org-demote-subtree', `org-indent-item-tree', or
20225 `org-table-insert-column', depending on context. See the
20226 individual commands for more information."
20229 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20230 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20231 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20232 ((if (not (org-region-active-p)) (org-at-item-p)
20233 (save-excursion (goto-char (region-beginning))
20235 (call-interactively 'org-indent-item-tree))
20236 (t (org-modifier-cursor-error))))
20238 (defun org-shiftmetaup (&optional arg)
20239 "Drag the line at point up.
20240 In a table, kill the current row.
20241 On a clock timestamp, update the value of the timestamp like `S-<up>'
20242 but also adjust the previous clocked item in the clock history.
20243 Everywhere else, drag the line at point up."
20246 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20247 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20248 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20249 (call-interactively 'org-timestamp-up)))
20250 (t (call-interactively 'org-drag-line-backward))))
20252 (defun org-shiftmetadown (&optional arg)
20253 "Drag the line at point down.
20254 In a table, insert an empty row at the current line.
20255 On a clock timestamp, update the value of the timestamp like `S-<down>'
20256 but also adjust the previous clocked item in the clock history.
20257 Everywhere else, drag the line at point down."
20260 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20261 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20262 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20263 (call-interactively 'org-timestamp-down)))
20264 (t (call-interactively 'org-drag-line-forward))))
20266 (defsubst org-hidden-tree-error ()
20268 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20270 (defun org-metaleft (&optional arg)
20271 "Promote heading or move table column to left.
20272 Calls `org-do-promote' or `org-table-move-column', depending on context.
20273 With no specific context, calls the Emacs default `backward-word'.
20274 See the individual commands for more information."
20277 ((run-hook-with-args-until-success 'org-metaleft-hook))
20278 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20279 ((org-with-limited-levels
20280 (or (org-at-heading-p)
20281 (and (org-region-active-p)
20283 (goto-char (region-beginning))
20284 (org-at-heading-p)))))
20285 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20286 (call-interactively 'org-do-promote))
20287 ;; At an inline task.
20288 ((org-at-heading-p)
20289 (call-interactively 'org-inlinetask-promote))
20290 ((or (org-at-item-p)
20291 (and (org-region-active-p)
20293 (goto-char (region-beginning))
20295 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20296 (call-interactively 'org-outdent-item))
20297 (t (call-interactively 'backward-word))))
20299 (defun org-metaright (&optional arg)
20300 "Demote a subtree, a list item or move table column to right.
20301 In front of a drawer or a block keyword, indent it correctly.
20302 With no specific context, calls the Emacs default `forward-word'.
20303 See the individual commands for more information."
20306 ((run-hook-with-args-until-success 'org-metaright-hook))
20307 ((org-at-table-p) (call-interactively 'org-table-move-column))
20308 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20309 ((org-at-block-p) (call-interactively 'org-indent-block))
20310 ((org-with-limited-levels
20311 (or (org-at-heading-p)
20312 (and (org-region-active-p)
20314 (goto-char (region-beginning))
20315 (org-at-heading-p)))))
20316 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20317 (call-interactively 'org-do-demote))
20318 ;; At an inline task.
20319 ((org-at-heading-p)
20320 (call-interactively 'org-inlinetask-demote))
20321 ((or (org-at-item-p)
20322 (and (org-region-active-p)
20324 (goto-char (region-beginning))
20326 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20327 (call-interactively 'org-indent-item))
20328 (t (call-interactively 'forward-word))))
20330 (defun org-check-for-hidden (what)
20331 "Check if there are hidden headlines/items in the current visual line.
20332 WHAT can be either `headlines' or `items'. If the current line is
20333 an outline or item heading and it has a folded subtree below it,
20334 this function returns t, nil otherwise."
20336 ((eq what 'headlines) org-outline-regexp-bol)
20337 ((eq what 'items) (org-item-beginning-re))
20338 (t (error "This should not happen"))))
20342 (unless (org-region-active-p)
20343 (setq beg (point-at-bol))
20344 (beginning-of-line 2)
20345 (while (and (not (eobp)) ;; this is like `next-line'
20346 (get-char-property (1- (point)) 'invisible))
20347 (beginning-of-line 2))
20350 (goto-char (point-at-eol))
20351 (setq end (max end (point)))
20352 (while (re-search-forward re end t)
20353 (if (get-char-property (match-beginning 0) 'invisible)
20357 (defun org-metaup (&optional arg)
20358 "Move subtree up or move table row up.
20359 Calls `org-move-subtree-up' or `org-table-move-row' or
20360 `org-move-item-up', depending on context. See the individual commands
20361 for more information."
20364 ((run-hook-with-args-until-success 'org-metaup-hook))
20365 ((org-region-active-p)
20366 (let* ((a (min (region-beginning) (region-end)))
20367 (b (1- (max (region-beginning) (region-end))))
20368 (c (save-excursion (goto-char a)
20369 (move-beginning-of-line 0)))
20370 (d (save-excursion (goto-char a)
20371 (move-end-of-line 0) (point))))
20372 (transpose-regions a b c d)
20374 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20375 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20376 ((org-at-item-p) (call-interactively 'org-move-item-up))
20377 (t (org-drag-element-backward))))
20379 (defun org-metadown (&optional arg)
20380 "Move subtree down or move table row down.
20381 Calls `org-move-subtree-down' or `org-table-move-row' or
20382 `org-move-item-down', depending on context. See the individual
20383 commands for more information."
20386 ((run-hook-with-args-until-success 'org-metadown-hook))
20387 ((org-region-active-p)
20388 (let* ((a (min (region-beginning) (region-end)))
20389 (b (max (region-beginning) (region-end)))
20390 (c (save-excursion (goto-char b)
20391 (move-beginning-of-line 1)))
20392 (d (save-excursion (goto-char b)
20393 (move-end-of-line 1) (1+ (point)))))
20394 (transpose-regions a b c d)
20396 ((org-at-table-p) (call-interactively 'org-table-move-row))
20397 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20398 ((org-at-item-p) (call-interactively 'org-move-item-down))
20399 (t (org-drag-element-forward))))
20401 (defun org-shiftup (&optional arg)
20402 "Increase item in timestamp or increase priority of current headline.
20403 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20404 depending on context. See the individual commands for more information."
20407 ((run-hook-with-args-until-success 'org-shiftup-hook))
20408 ((and org-support-shift-select (org-region-active-p))
20409 (org-call-for-shift-select 'previous-line))
20410 ((org-at-timestamp-p t)
20411 (call-interactively (if org-edit-timestamp-down-means-later
20412 'org-timestamp-down 'org-timestamp-up)))
20413 ((and (not (eq org-support-shift-select 'always))
20414 org-enable-priority-commands
20415 (org-at-heading-p))
20416 (call-interactively 'org-priority-up))
20417 ((and (not org-support-shift-select) (org-at-item-p))
20418 (call-interactively 'org-previous-item))
20419 ((org-clocktable-try-shift 'up arg))
20420 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20421 (org-support-shift-select
20422 (org-call-for-shift-select 'previous-line))
20423 (t (org-shiftselect-error))))
20425 (defun org-shiftdown (&optional arg)
20426 "Decrease item in timestamp or decrease priority of current headline.
20427 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20428 depending on context. See the individual commands for more information."
20431 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20432 ((and org-support-shift-select (org-region-active-p))
20433 (org-call-for-shift-select 'next-line))
20434 ((org-at-timestamp-p t)
20435 (call-interactively (if org-edit-timestamp-down-means-later
20436 'org-timestamp-up 'org-timestamp-down)))
20437 ((and (not (eq org-support-shift-select 'always))
20438 org-enable-priority-commands
20439 (org-at-heading-p))
20440 (call-interactively 'org-priority-down))
20441 ((and (not org-support-shift-select) (org-at-item-p))
20442 (call-interactively 'org-next-item))
20443 ((org-clocktable-try-shift 'down arg))
20444 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20445 (org-support-shift-select
20446 (org-call-for-shift-select 'next-line))
20447 (t (org-shiftselect-error))))
20449 (defun org-shiftright (&optional arg)
20450 "Cycle the thing at point or in the current line, depending on context.
20451 Depending on context, this does one of the following:
20453 - switch a timestamp at point one day into the future
20454 - on a headline, switch to the next TODO keyword.
20455 - on an item, switch entire list to the next bullet type
20456 - on a property line, switch to the next allowed value
20457 - on a clocktable definition line, move time block into the future"
20460 ((run-hook-with-args-until-success 'org-shiftright-hook))
20461 ((and org-support-shift-select (org-region-active-p))
20462 (org-call-for-shift-select 'forward-char))
20463 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20464 ((and (not (eq org-support-shift-select 'always))
20465 (org-at-heading-p))
20466 (let ((org-inhibit-logging
20467 (not org-treat-S-cursor-todo-selection-as-state-change))
20468 (org-inhibit-blocking
20469 (not org-treat-S-cursor-todo-selection-as-state-change)))
20470 (org-call-with-arg 'org-todo 'right)))
20471 ((or (and org-support-shift-select
20472 (not (eq org-support-shift-select 'always))
20473 (org-at-item-bullet-p))
20474 (and (not org-support-shift-select) (org-at-item-p)))
20475 (org-call-with-arg 'org-cycle-list-bullet nil))
20476 ((and (not (eq org-support-shift-select 'always))
20477 (org-at-property-p))
20478 (call-interactively 'org-property-next-allowed-value))
20479 ((org-clocktable-try-shift 'right arg))
20480 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20481 (org-support-shift-select
20482 (org-call-for-shift-select 'forward-char))
20483 (t (org-shiftselect-error))))
20485 (defun org-shiftleft (&optional arg)
20486 "Cycle the thing at point or in the current line, depending on context.
20487 Depending on context, this does one of the following:
20489 - switch a timestamp at point one day into the past
20490 - on a headline, switch to the previous TODO keyword.
20491 - on an item, switch entire list to the previous bullet type
20492 - on a property line, switch to the previous allowed value
20493 - on a clocktable definition line, move time block into the past"
20496 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20497 ((and org-support-shift-select (org-region-active-p))
20498 (org-call-for-shift-select 'backward-char))
20499 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20500 ((and (not (eq org-support-shift-select 'always))
20501 (org-at-heading-p))
20502 (let ((org-inhibit-logging
20503 (not org-treat-S-cursor-todo-selection-as-state-change))
20504 (org-inhibit-blocking
20505 (not org-treat-S-cursor-todo-selection-as-state-change)))
20506 (org-call-with-arg 'org-todo 'left)))
20507 ((or (and org-support-shift-select
20508 (not (eq org-support-shift-select 'always))
20509 (org-at-item-bullet-p))
20510 (and (not org-support-shift-select) (org-at-item-p)))
20511 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20512 ((and (not (eq org-support-shift-select 'always))
20513 (org-at-property-p))
20514 (call-interactively 'org-property-previous-allowed-value))
20515 ((org-clocktable-try-shift 'left arg))
20516 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20517 (org-support-shift-select
20518 (org-call-for-shift-select 'backward-char))
20519 (t (org-shiftselect-error))))
20521 (defun org-shiftcontrolright ()
20522 "Switch to next TODO set."
20525 ((and org-support-shift-select (org-region-active-p))
20526 (org-call-for-shift-select 'forward-word))
20527 ((and (not (eq org-support-shift-select 'always))
20528 (org-at-heading-p))
20529 (org-call-with-arg 'org-todo 'nextset))
20530 (org-support-shift-select
20531 (org-call-for-shift-select 'forward-word))
20532 (t (org-shiftselect-error))))
20534 (defun org-shiftcontrolleft ()
20535 "Switch to previous TODO set."
20538 ((and org-support-shift-select (org-region-active-p))
20539 (org-call-for-shift-select 'backward-word))
20540 ((and (not (eq org-support-shift-select 'always))
20541 (org-at-heading-p))
20542 (org-call-with-arg 'org-todo 'previousset))
20543 (org-support-shift-select
20544 (org-call-for-shift-select 'backward-word))
20545 (t (org-shiftselect-error))))
20547 (defun org-shiftcontrolup (&optional n)
20548 "Change timestamps synchronously up in CLOCK log lines.
20549 Optional argument N tells to change by that many units."
20551 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20552 (let (org-support-shift-select)
20553 (org-clock-timestamps-up n))
20554 (user-error "Not at a clock log")))
20556 (defun org-shiftcontroldown (&optional n)
20557 "Change timestamps synchronously down in CLOCK log lines.
20558 Optional argument N tells to change by that many units."
20560 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20561 (let (org-support-shift-select)
20562 (org-clock-timestamps-down n))
20563 (user-error "Not at a clock log")))
20565 (defun org-increase-number-at-point (&optional inc)
20566 "Increment the number at point.
20567 With an optional prefix numeric argument INC, increment using
20568 this numeric value."
20570 (if (not (number-at-point))
20571 (user-error "Not on a number")
20572 (unless inc (setq inc 1))
20573 (let ((pos (point))
20574 (beg (skip-chars-backward "-+^/*0-9eE."))
20575 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20576 (setq nap (buffer-substring-no-properties
20577 (+ pos beg) (+ pos beg end)))
20578 (delete-region (+ pos beg) (+ pos beg end))
20579 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20580 (when (org-at-table-p)
20582 (org-table-end-of-field 1))))
20584 (defun org-decrease-number-at-point (&optional inc)
20585 "Decrement the number at point.
20586 With an optional prefix numeric argument INC, decrement using
20587 this numeric value."
20589 (org-increase-number-at-point (- inc)))
20591 (defun org-ctrl-c-ret ()
20592 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20595 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20596 (t (call-interactively 'org-insert-heading))))
20598 (defun org-find-visible ()
20600 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20601 (get-char-property s 'invisible)))
20603 (defun org-find-invisible ()
20605 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20606 (not (get-char-property s 'invisible))))
20609 (defun org-copy-visible (beg end)
20610 "Copy the visible parts of the region."
20615 (narrow-to-region beg end)
20616 (setq s (goto-char (point-min)))
20617 (while (not (= (point) (point-max)))
20618 (goto-char (org-find-invisible))
20619 (push (buffer-substring s (point)) snippets)
20620 (setq s (goto-char (org-find-visible))))))
20621 (kill-new (apply 'concat (nreverse snippets)))))
20623 (defun org-copy-special ()
20624 "Copy region in table or copy current subtree.
20625 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20626 See the individual commands for more information."
20628 (call-interactively
20629 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20631 (defun org-cut-special ()
20632 "Cut region in table or cut current subtree.
20633 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20634 See the individual commands for more information."
20636 (call-interactively
20637 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20639 (defun org-paste-special (arg)
20640 "Paste rectangular region into table, or past subtree relative to level.
20641 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20642 See the individual commands for more information."
20644 (if (org-at-table-p)
20645 (org-table-paste-rectangle)
20646 (org-paste-subtree arg)))
20648 (defsubst org-in-fixed-width-region-p ()
20649 "Is point in a fixed-width region?"
20651 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20653 (defun org-edit-special (&optional arg)
20654 "Call a special editor for the element at point.
20655 When at a table, call the formula editor with `org-table-edit-formulas'.
20656 When in a source code block, call `org-edit-src-code'.
20657 When in a fixed-width region, call `org-edit-fixed-width-region'.
20658 When in an export block, call `org-edit-export-block'.
20659 When at an #+INCLUDE keyword, visit the included file.
20660 On a link, call `ffap' to visit the link at point.
20661 Otherwise, return a user error."
20663 (let ((element (org-element-at-point)))
20664 (assert (not buffer-read-only) nil
20665 "Buffer is read-only: %s" (buffer-name))
20666 (case (org-element-type element)
20668 (if (not arg) (org-edit-src-code)
20669 (let* ((info (org-babel-get-src-block-info))
20670 (lang (nth 0 info))
20671 (params (nth 2 info))
20672 (session (cdr (assq :session params))))
20673 (if (not session) (org-edit-src-code)
20674 ;; At a src-block with a session and function called with
20675 ;; an ARG: switch to the buffer related to the inferior
20678 (funcall (intern (concat "org-babel-prep-session:" lang))
20679 session params))))))
20681 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20682 (org-open-link-from-string
20685 (let ((value (org-element-property :value element)))
20686 (cond ((not (org-string-nw-p value))
20687 (user-error "No file to edit"))
20688 ((string-match "\\`\"\\(.*?\\)\"" value)
20689 (match-string 1 value))
20690 ((string-match "\\`[^ \t\"]\\S-*" value)
20691 (match-string 0 value))
20692 (t (user-error "No valid file specified")))))))
20693 (user-error "No special environment to edit here")))
20695 (if (eq (org-element-property :type element) 'table.el)
20696 (org-edit-table.el)
20697 (call-interactively 'org-table-edit-formulas)))
20698 ;; Only Org tables contain `table-row' type elements.
20699 (table-row (call-interactively 'org-table-edit-formulas))
20700 ((example-block src-block) (org-edit-src-code))
20701 (export-block (org-edit-export-block))
20702 (fixed-width (org-edit-fixed-width-region))
20704 ;; No notable element at point. Though, we may be at a link,
20705 ;; which is an object. Thus, scan deeper.
20706 (if (eq (org-element-type (org-element-context element)) 'link)
20707 (call-interactively 'ffap)
20708 (user-error "No special environment to edit here"))))))
20710 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20711 (defun org-ctrl-c-ctrl-c (&optional arg)
20712 "Set tags in headline, or update according to changed information at point.
20714 This command does many different things, depending on context:
20716 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20717 this is what we do.
20719 - If the cursor is on a statistics cookie, update it.
20721 - If the cursor is in a headline, prompt for tags and insert them
20722 into the current line, aligned to `org-tags-column'. When called
20723 with prefix arg, realign all tags in the current buffer.
20725 - If the cursor is in one of the special #+KEYWORD lines, this
20726 triggers scanning the buffer for these lines and updating the
20729 - If the cursor is inside a table, realign the table. This command
20730 works even if the automatic table editor has been turned off.
20732 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20735 - If the cursor is at a footnote reference or definition, jump to
20736 the corresponding definition or references, respectively.
20738 - If the cursor is a the beginning of a dynamic block, update it.
20740 - If the current buffer is a capture buffer, close note and file it.
20742 - If the cursor is on a <<<target>>>, update radio targets and
20743 corresponding links in this buffer.
20745 - If the cursor is on a numbered item in a plain list, renumber the
20748 - If the cursor is on a checkbox, toggle it.
20750 - If the cursor is on a code block, evaluate it. The variable
20751 `org-confirm-babel-evaluate' can be used to control prompting
20752 before code block evaluation, by default every code block
20753 evaluation requires confirmation. Code block evaluation can be
20754 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20757 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20758 org-occur-highlights)
20759 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20760 (org-remove-occur-highlights)
20761 (message "Temporary highlights/overlays removed from current buffer"))
20762 ((and (local-variable-p 'org-finish-function (current-buffer))
20763 (fboundp org-finish-function))
20764 (funcall org-finish-function))
20765 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20767 (let* ((context (org-element-context)) (type (org-element-type context)))
20768 ;; Test if point is within a blank line.
20769 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20770 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20771 (user-error "C-c C-c can do nothing useful at this location"))
20773 ;; When at a link, act according to the parent instead.
20774 (link (setq context (org-element-property :parent context))
20775 (setq type (org-element-type context)))
20776 ;; Unsupported object types: refer to the first supported
20777 ;; element or object containing it.
20778 ((bold code entity export-snippet inline-babel-call inline-src-block
20779 italic latex-fragment line-break macro strike-through subscript
20780 superscript underline verbatim)
20781 (while (and (setq context (org-element-property :parent context))
20782 (not (memq (setq type (org-element-type context))
20783 '(radio-target paragraph verse-block
20785 ;; For convenience: at the first line of a paragraph on the
20786 ;; same line as an item, apply function on that item instead.
20787 (when (eq type 'paragraph)
20788 (let ((parent (org-element-property :parent context)))
20789 (when (and (eq (org-element-type parent) 'item)
20790 (= (point-at-bol) (org-element-property :begin parent)))
20791 (setq context parent type 'item))))
20792 ;; Act according to type of element or object at point.
20794 (clock (org-clock-update-time-maybe))
20797 (goto-char (org-element-property :post-affiliated context))
20798 (org-update-dblock)))
20799 (footnote-definition
20800 (goto-char (org-element-property :post-affiliated context))
20801 (call-interactively 'org-footnote-action))
20802 (footnote-reference (call-interactively 'org-footnote-action))
20803 ((headline inlinetask)
20804 (save-excursion (goto-char (org-element-property :begin context))
20805 (call-interactively 'org-set-tags)))
20807 ;; At an item: a double C-u set checkbox to "[-]"
20808 ;; unconditionally, whereas a single one will toggle its
20809 ;; presence. Without an universal argument, if the item
20810 ;; has a checkbox, toggle it. Otherwise repair the list.
20811 (let* ((box (org-element-property :checkbox context))
20812 (struct (org-element-property :structure context))
20813 (old-struct (copy-tree struct))
20814 (parents (org-list-parents-alist struct))
20815 (prevs (org-list-prevs-alist struct))
20816 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20817 (org-list-set-checkbox
20818 (org-element-property :begin context) struct
20819 (cond ((equal arg '(16)) "[-]")
20820 ((and (not box) (equal arg '(4))) "[ ]")
20821 ((or (not box) (equal arg '(4))) nil)
20822 ((eq box 'on) "[ ]")
20824 ;; Mimic `org-list-write-struct' but with grabbing
20825 ;; a return value from `org-list-struct-fix-box'.
20826 (org-list-struct-fix-ind struct parents 2)
20827 (org-list-struct-fix-item-end struct)
20828 (org-list-struct-fix-bul struct prevs)
20829 (org-list-struct-fix-ind struct parents)
20831 (org-list-struct-fix-box struct parents prevs orderedp)))
20832 (if (and box (equal struct old-struct))
20833 (if (equal arg '(16))
20834 (message "Checkboxes already reset")
20835 (user-error "Cannot toggle this checkbox: %s"
20837 "all subitems checked"
20838 "unchecked subitems")))
20839 (org-list-struct-apply-struct struct old-struct)
20840 (org-update-checkbox-count-maybe))
20842 (message "Checkboxes were removed due to empty box at line %d"
20843 (org-current-line block-item))))))
20845 (let ((org-inhibit-startup-visibility-stuff t)
20846 (org-startup-align-all-tables nil))
20847 (when (boundp 'org-table-coordinate-overlays)
20848 (mapc 'delete-overlay org-table-coordinate-overlays)
20849 (setq org-table-coordinate-overlays nil))
20850 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20851 (message "Local setup has been refreshed"))
20853 ;; At a plain list, with a double C-u argument, set
20854 ;; checkboxes of each item to "[-]", whereas a single one
20855 ;; will toggle their presence according to the state of the
20856 ;; first item in the list. Without an argument, repair the
20858 (let* ((begin (org-element-property :contents-begin context))
20859 (beginm (move-marker (make-marker) begin))
20860 (struct (org-element-property :structure context))
20861 (old-struct (copy-tree struct))
20862 (first-box (save-excursion
20864 (looking-at org-list-full-item-re)
20865 (match-string-no-properties 3)))
20866 (new-box (cond ((equal arg '(16)) "[-]")
20867 ((equal arg '(4)) (unless first-box "[ ]"))
20868 ((equal first-box "[X]") "[ ]")
20872 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20873 (org-list-get-all-items
20874 begin struct (org-list-prevs-alist struct))))
20875 ((and first-box (eq (point) begin))
20876 ;; For convenience, when point is at bol on the first
20877 ;; item of the list and no argument is provided, simply
20878 ;; toggle checkbox of that item, if any.
20879 (org-list-set-checkbox begin struct new-box)))
20880 (org-list-write-struct
20881 struct (org-list-parents-alist struct) old-struct)
20882 (org-update-checkbox-count-maybe)
20883 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20884 ((property-drawer node-property)
20885 (call-interactively 'org-property-action))
20886 ((radio-target target)
20887 (call-interactively 'org-update-radio-target-regexp))
20889 (call-interactively 'org-update-statistics-cookies))
20890 ((table table-cell table-row)
20891 ;; At a table, recalculate every field and align it. Also
20892 ;; send the table if necessary. If the table has
20893 ;; a `table.el' type, just give up. At a table row or
20894 ;; cell, maybe recalculate line but always align table.
20895 (if (eq (org-element-property :type context) 'table.el)
20896 (message "Use C-c ' to edit table.el tables")
20897 (let ((org-enable-table-editor t))
20898 (if (or (eq type 'table)
20899 ;; Check if point is at a TBLFM line.
20900 (and (eq type 'table-row)
20901 (= (point) (org-element-property :end context))))
20903 (if (org-at-TBLFM-p)
20904 (progn (require 'org-table)
20905 (org-table-calc-current-TBLFM))
20906 (goto-char (org-element-property :contents-begin context))
20907 (org-call-with-arg 'org-table-recalculate (or arg t))
20908 (orgtbl-send-table 'maybe)))
20909 (org-table-maybe-eval-formula)
20910 (cond (arg (call-interactively 'org-table-recalculate))
20911 ((org-table-maybe-recalculate-line))
20912 (t (org-table-align)))))))
20913 (timestamp (org-timestamp-change 0 'day))
20915 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20917 "C-c C-c can do nothing useful at this location")))))))))
20919 (defun org-mode-restart ()
20921 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20922 (funcall major-mode)
20923 (hack-local-variables)
20924 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20925 (org-indent-mode -1)))
20926 (message "%s restarted" major-mode))
20928 (defun org-kill-note-or-show-branches ()
20929 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20931 (if (not org-finish-function)
20934 (call-interactively 'show-branches))
20935 (let ((org-note-abort t))
20936 (funcall org-finish-function))))
20938 (defun org-open-line (n)
20939 "Insert a new row in tables, call `open-line' elsewhere.
20940 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20943 ((not org-special-ctrl-o)
20946 (org-table-insert-row))
20950 (defun org-return (&optional indent)
20951 "Goto next table row or insert a newline.
20953 Calls `org-table-next-row' or `newline', depending on context.
20955 When optional INDENT argument is non-nil, call
20956 `newline-and-indent' instead of `newline'.
20958 When `org-return-follows-link' is non-nil and point is on
20959 a timestamp or a link, call `org-open-at-point'. However, it
20960 will not happen if point is in a table or on a \"dead\"
20961 object (e.g., within a comment). In these case, you need to use
20962 `org-open-at-point' directly."
20964 (if (and (save-excursion
20965 (beginning-of-line)
20966 (looking-at org-todo-line-regexp))
20967 (match-beginning 3)
20968 (>= (point) (match-beginning 3)))
20969 ;; Point is on headline tags. Do not break them: add a newline
20970 ;; after the headline instead.
20971 (progn (org-show-entry)
20973 (if indent (newline-and-indent) (newline)))
20974 (let* ((context (if org-return-follows-link (org-element-context)
20975 (org-element-at-point)))
20976 (type (org-element-type context)))
20978 ;; In a table, call `org-table-next-row'.
20979 ((or (and (eq type 'table)
20980 (>= (point) (org-element-property :contents-begin context))
20981 (< (point) (org-element-property :contents-end context)))
20982 (org-element-lineage context '(table-row table-cell) t))
20983 (org-table-justify-field-maybe)
20984 (call-interactively #'org-table-next-row))
20985 ;; On a link or a timestamp but not on white spaces after it,
20986 ;; call `org-open-line' if `org-return-follows-link' allows it.
20987 ((and org-return-follows-link
20988 (memq type '(link timestamp))
20990 (save-excursion (goto-char (org-element-property :end context))
20991 (skip-chars-backward " \t")
20993 (call-interactively #'org-open-at-point))
20994 ;; In a list, make sure indenting keeps trailing text within.
20997 (org-element-lineage context '(item plain-list) t))
20998 (let ((trailing-data
20999 (delete-and-extract-region (point) (line-end-position))))
21000 (newline-and-indent)
21001 (save-excursion (insert trailing-data))))
21002 (t (if indent (newline-and-indent) (newline)))))))
21004 (defun org-return-indent ()
21005 "Goto next table row or insert a newline and indent.
21006 Calls `org-table-next-row' or `newline-and-indent', depending on
21007 context. See the individual commands for more information."
21011 (defun org-ctrl-c-star ()
21012 "Compute table, or change heading status of lines.
21013 Calls `org-table-recalculate' or `org-toggle-heading',
21014 depending on context."
21018 (call-interactively 'org-table-recalculate))
21020 ;; Convert all lines in region to list items
21021 (call-interactively 'org-toggle-heading))))
21023 (defun org-ctrl-c-minus ()
21024 "Insert separator line in table or modify bullet status of line.
21025 Also turns a plain line or a region of lines into list items.
21026 Calls `org-table-insert-hline', `org-toggle-item', or
21027 `org-cycle-list-bullet', depending on context."
21031 (call-interactively 'org-table-insert-hline))
21032 ((org-region-active-p)
21033 (call-interactively 'org-toggle-item))
21035 (call-interactively 'org-cycle-list-bullet))
21037 (call-interactively 'org-toggle-item))))
21039 (defun org-toggle-item (arg)
21040 "Convert headings or normal lines to items, items to normal lines.
21041 If there is no active region, only the current line is considered.
21043 If the first non blank line in the region is a headline, convert
21044 all headlines to items, shifting text accordingly.
21046 If it is an item, convert all items to normal lines.
21048 If it is normal text, change region into a list of items.
21049 With a prefix argument ARG, change the region in a single item."
21053 ;; Shift text in current section to IND, from point to END.
21054 ;; The function leaves point to END line.
21056 (let ((min-i 1000) (end (copy-marker end)))
21057 ;; First determine the minimum indentation (MIN-I) of
21061 (while (< (point) end)
21062 (let ((i (org-get-indentation)))
21064 ;; Skip blank lines and inline tasks.
21065 ((looking-at "^[ \t]*$"))
21066 ((looking-at org-outline-regexp-bol))
21067 ;; We can't find less than 0 indentation.
21068 ((zerop i) (throw 'exit (setq min-i 0)))
21069 ((< i min-i) (setq min-i i))))
21071 ;; Then indent each line so that a line indented to
21072 ;; MIN-I becomes indented to IND. Ignore blank lines
21073 ;; and inline tasks in the process.
21074 (let ((delta (- ind min-i)))
21075 (while (< (point) end)
21076 (unless (or (looking-at "^[ \t]*$")
21077 (looking-at org-outline-regexp-bol))
21078 (org-indent-line-to (+ (org-get-indentation) delta)))
21079 (forward-line)))))))
21082 ;; Return beginning of first non-blank line, starting from
21087 (skip-chars-forward " \r\t\n")
21090 ;; Determine boundaries of changes.
21091 (if (org-region-active-p)
21092 (setq beg (funcall skip-blanks (region-beginning))
21093 end (copy-marker (region-end)))
21094 (setq beg (funcall skip-blanks (point-at-bol))
21095 end (copy-marker (point-at-eol))))
21096 ;; Depending on the starting line, choose an action on the text
21097 ;; between BEG and END.
21098 (org-with-limited-levels
21102 ;; Case 1. Start at an item: de-itemize. Note that it only
21103 ;; happens when a region is active: `org-ctrl-c-minus'
21104 ;; would call `org-cycle-list-bullet' otherwise.
21106 (while (< (point) end)
21107 (when (org-at-item-p)
21108 (skip-chars-forward " \t")
21109 (delete-region (point) (match-end 0)))
21111 ;; Case 2. Start at an heading: convert to items.
21112 ((org-at-heading-p)
21113 (let* ((bul (org-list-bullet-string "-"))
21114 (bul-len (length bul))
21115 (done (org-entry-is-done-p))
21116 (todo (org-entry-is-todo-p))
21117 ;; Indentation of the first heading. It should be
21118 ;; relative to the indentation of its parent, if any.
21119 (start-ind (save-excursion
21121 ((not org-adapt-indentation) 0)
21122 ((not (outline-previous-heading)) 0)
21123 (t (length (match-string 0))))))
21124 ;; Level of first heading. Further headings will be
21125 ;; compared to it to determine hierarchy in the list.
21126 (ref-level (org-reduced-level (org-outline-level))))
21127 (when (or done todo) (org-todo ""))
21128 (while (< (point) end)
21129 (let* ((level (org-reduced-level (org-outline-level)))
21130 (delta (max 0 (- level ref-level))))
21131 ;; If current headline is less indented than the first
21132 ;; one, set it as reference, in order to preserve
21134 (when (< level ref-level) (setq ref-level level))
21135 (replace-match bul t t)
21136 (org-indent-line-to (+ start-ind (* delta bul-len)))
21137 (when (or done todo)
21138 (let* ((struct (org-list-struct))
21139 (old (copy-tree struct)))
21140 (org-list-set-checkbox (line-beginning-position)
21142 (if done "[X]" "[ ]"))
21143 (org-list-write-struct struct
21144 (org-list-parents-alist struct)
21146 ;; Ensure all text down to END (or SECTION-END) belongs
21147 ;; to the newly created item.
21148 (let ((section-end (save-excursion
21149 (or (outline-next-heading) (point)))))
21151 (funcall shift-text
21152 (+ start-ind (* (1+ delta) bul-len))
21153 (min end section-end)))))))
21154 ;; Case 3. Normal line with ARG: make the first line of region
21155 ;; an item, and shift indentation of others lines to
21156 ;; set them as item's body.
21157 (arg (let* ((bul (org-list-bullet-string "-"))
21158 (bul-len (length bul))
21159 (ref-ind (org-get-indentation)))
21160 (skip-chars-forward " \t")
21163 (while (< (point) end)
21164 ;; Ensure that lines less indented than first one
21165 ;; still get included in item body.
21166 (funcall shift-text
21167 (+ ref-ind bul-len)
21168 (min end (save-excursion (or (outline-next-heading)
21171 ;; Case 4. Normal line without ARG: turn each non-item line
21174 (while (< (point) end)
21175 (unless (or (org-at-heading-p) (org-at-item-p))
21176 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21178 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21179 (forward-line))))))))
21181 (defun org-toggle-heading (&optional nstars)
21182 "Convert headings to normal text, or items or text to headings.
21183 If there is no active region, only convert the current line.
21185 With a \\[universal-argument] prefix, convert the whole list at
21186 point into heading.
21190 - If the first non blank line is a headline, remove the stars
21191 from all headlines in the region.
21193 - If it is a normal line, turn each and every normal line (i.e.,
21194 not an heading or an item) in the region into headings. If you
21195 want to convert only the first line of this region, use one
21196 universal prefix argument.
21198 - If it is a plain list item, turn all plain list items into headings.
21200 When converting a line into a heading, the number of stars is chosen
21201 such that the lines become children of the current entry. However,
21202 when a numeric prefix argument is given, its value determines the
21203 number of stars to add."
21207 ;; Return beginning of first non-blank line, starting from
21212 (while (org-at-comment-p) (forward-line))
21213 (skip-chars-forward " \r\t\n")
21216 ;; Determine boundaries of changes. If a universal prefix has
21217 ;; been given, put the list in a region. If region ends at a bol,
21218 ;; do not consider the last line to be in the region.
21220 (when (and current-prefix-arg (org-at-item-p))
21221 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21222 (org-mark-element))
21224 (if (org-region-active-p)
21225 (setq beg (funcall skip-blanks (region-beginning))
21226 end (copy-marker (save-excursion
21227 (goto-char (region-end))
21228 (if (bolp) (point) (point-at-eol)))))
21229 (setq beg (funcall skip-blanks (point-at-bol))
21230 end (copy-marker (point-at-eol))))
21231 ;; Ensure inline tasks don't count as headings.
21232 (org-with-limited-levels
21236 ;; Case 1. Started at an heading: de-star headings.
21237 ((org-at-heading-p)
21238 (while (< (point) end)
21239 (when (org-at-heading-p t)
21240 (looking-at org-outline-regexp) (replace-match "")
21243 ;; Case 2. Started at an item: change items into headlines.
21244 ;; One star will be added by `org-list-to-subtree'.
21246 (let* ((stars (make-string
21247 ;; subtract the star that will be added again by
21248 ;; `org-list-to-subtree'
21249 (if (numberp nstars) (1- nstars)
21250 (or (org-current-level) 0))
21253 (cond (nstars "") ; stars from prefix only
21254 ((equal stars "") "") ; before first heading
21255 (org-odd-levels-only "*") ; inside heading, odd
21256 (t "")))) ; inside heading, oddeven
21257 (while (< (point) end)
21258 (when (org-at-item-p)
21259 ;; Pay attention to cases when region ends before list.
21260 (let* ((struct (org-list-struct))
21261 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21263 (narrow-to-region (point) list-end)
21265 (org-list-to-subtree
21266 (org-list-parse-list t)
21267 '(:istart (concat stars add-stars (funcall get-stars depth))
21268 :icount (concat stars add-stars (funcall get-stars depth)))))))
21271 ;; Case 3. Started at normal text: make every line an heading,
21272 ;; skipping headlines and items.
21275 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21277 (cond (nstars "") ; stars from prefix only
21278 ((equal stars "") "*") ; before first heading
21279 (org-odd-levels-only "**") ; inside heading, odd
21280 (t "*"))) ; inside heading, oddeven
21281 (rpl (concat stars add-stars " "))
21282 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21283 (while (< (point) (if (equal nstars '(4)) lend end))
21284 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21285 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21286 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21287 (forward-line)))))))
21288 (unless toggled (message "Cannot toggle heading from here"))))
21290 (defun org-meta-return (&optional arg)
21291 "Insert a new heading or wrap a region in a table.
21292 Calls `org-insert-heading' or `org-table-wrap-region', depending
21293 on context. See the individual commands for more information."
21295 (org-check-before-invisible-edit 'insert)
21296 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21297 (let* ((element (org-element-at-point))
21298 (type (org-element-type element)))
21299 (when (eq type 'table-row)
21300 (setq element (org-element-property :parent element))
21301 (setq type 'table))
21302 (if (and (eq type 'table)
21303 (eq (org-element-property :type element) 'org)
21304 (>= (point) (org-element-property :contents-begin element))
21305 (< (point) (org-element-property :contents-end element)))
21306 (call-interactively 'org-table-wrap-region)
21307 (call-interactively 'org-insert-heading)))))
21311 (defsubst org-in-subtree-not-table-p ()
21312 "Are we in a subtree and not in a table?"
21313 (and (not (org-before-first-heading-p))
21314 (not (org-at-table-p))))
21316 ;; Define the Org-mode menus
21317 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21319 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21320 ["Next Field" org-cycle (org-at-table-p)]
21321 ["Previous Field" org-shifttab (org-at-table-p)]
21322 ["Next Row" org-return (org-at-table-p)]
21324 ["Blank Field" org-table-blank-field (org-at-table-p)]
21325 ["Edit Field" org-table-edit-field (org-at-table-p)]
21326 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21329 ["Move Column Left" org-metaleft (org-at-table-p)]
21330 ["Move Column Right" org-metaright (org-at-table-p)]
21331 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21332 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21334 ["Move Row Up" org-metaup (org-at-table-p)]
21335 ["Move Row Down" org-metadown (org-at-table-p)]
21336 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21337 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21338 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21340 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21342 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21343 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21344 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21345 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21348 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21349 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21350 ["Edit Formulas" org-edit-special (org-at-table-p)]
21352 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21353 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21354 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21356 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21358 ["Sum Column/Rectangle" org-table-sum
21359 (or (org-at-table-p) (org-region-active-p))]
21360 ["Which Column?" org-table-current-column (org-at-table-p)])
21362 org-table-toggle-formula-debugger
21363 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21364 ["Show Col/Row Numbers"
21365 org-table-toggle-coordinate-overlays
21367 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21369 ["Create" org-table-create (and (not (org-at-table-p))
21370 org-enable-table-editor)]
21371 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21372 ["Import from File" org-table-import (not (org-at-table-p))]
21373 ["Export to File" org-table-export (org-at-table-p)]
21375 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21378 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21379 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21381 (easy-menu-define org-org-menu org-mode-map "Org menu"
21384 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21385 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21386 ["Sparse Tree..." org-sparse-tree t]
21387 ["Reveal Context" org-reveal t]
21388 ["Show All" show-all t]
21390 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21392 ["New Heading" org-insert-heading t]
21393 ("Navigate Headings"
21394 ["Up" outline-up-heading t]
21395 ["Next" outline-next-visible-heading t]
21396 ["Previous" outline-previous-visible-heading t]
21397 ["Next Same Level" outline-forward-same-level t]
21398 ["Previous Same Level" outline-backward-same-level t]
21400 ["Jump" org-goto t])
21402 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21404 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21405 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21407 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21408 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21409 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21411 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21413 ["Copy visible text" org-copy-visible t]
21415 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21416 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21417 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21418 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21420 ["Sort Region/Children" org-sort t]
21422 ["Convert to odd levels" org-convert-to-odd-levels t]
21423 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21425 ["Emphasis..." org-emphasize t]
21426 ["Edit Source Example" org-edit-special t]
21428 ["Footnote new/jump" org-footnote-action t]
21429 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21431 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21433 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21434 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21435 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21439 ["Store Link (Global)" org-store-link t]
21440 ["Find existing link to here" org-occur-link-in-agenda-files t]
21441 ["Insert Link" org-insert-link t]
21442 ["Follow Link" org-open-at-point t]
21444 ["Next link" org-next-link t]
21445 ["Previous link" org-previous-link t]
21447 ["Descriptive Links"
21448 org-toggle-link-display
21450 :selected org-descriptive-links
21453 org-toggle-link-display
21455 :selected (not org-descriptive-links)])
21458 ["TODO/DONE/-" org-todo t]
21460 ["Next keyword" org-shiftright (org-at-heading-p)]
21461 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21462 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21463 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21464 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21465 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21466 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21468 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21469 :selected org-enforce-todo-dependencies :style toggle :active t]
21470 "Settings for tree at point"
21471 ["Do Children sequentially" org-toggle-ordered-property :style radio
21472 :selected (org-entry-get nil "ORDERED")
21473 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21474 ["Do Children parallel" org-toggle-ordered-property :style radio
21475 :selected (not (org-entry-get nil "ORDERED"))
21476 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21478 ["Set Priority" org-priority t]
21479 ["Priority Up" org-shiftup t]
21480 ["Priority Down" org-shiftdown t]
21482 ["Get news from all feeds" org-feed-update-all t]
21483 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21484 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21485 ("TAGS and Properties"
21486 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21487 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21489 ["Set property" org-set-property (not (org-before-first-heading-p))]
21490 ["Column view of properties" org-columns t]
21491 ["Insert Column View DBlock" org-insert-columns-dblock t])
21492 ("Dates and Scheduling"
21493 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21494 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21496 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21497 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21498 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21499 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21500 ["Compute Time Range" org-evaluate-time-range t]
21501 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21502 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21504 ["Custom time format" org-toggle-time-stamp-overlays
21505 :style radio :selected org-display-custom-times]
21507 ["Goto Calendar" org-goto-calendar t]
21508 ["Date from Calendar" org-date-from-calendar t]
21510 ["Start/Restart Timer" org-timer-start t]
21511 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21512 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21513 ["Insert Timer String" org-timer t]
21514 ["Insert Timer Item" org-timer-item t])
21516 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21517 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21518 ["Clock out" org-clock-out t]
21519 ["Clock cancel" org-clock-cancel t]
21521 ["Mark as default task" org-clock-mark-default-task t]
21522 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21523 ["Goto running clock" org-clock-goto t]
21525 ["Display times" org-clock-display t]
21526 ["Create clock table" org-clock-report t]
21528 ["Record DONE time"
21529 (progn (setq org-log-done (not org-log-done))
21530 (message "Switching to %s will %s record a timestamp"
21531 (car org-done-keywords)
21532 (if org-log-done "automatically" "not")))
21533 :style toggle :selected org-log-done])
21535 ["Agenda Command..." org-agenda t]
21536 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21537 ("File List for Agenda")
21538 ("Special views current file"
21539 ["TODO Tree" org-show-todo-tree t]
21540 ["Check Deadlines" org-check-deadlines t]
21541 ["Timeline" org-timeline t]
21542 ["Tags/Property tree" org-match-sparse-tree t])
21544 ["Export/Publish..." org-export-dispatch t]
21546 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21547 :selected org-cdlatex-mode]
21548 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21549 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21550 ["Modify math symbol" org-cdlatex-math-modify
21551 (org-inside-LaTeX-fragment-p)]
21552 ["Insert citation" org-reftex-citation t]
21554 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21557 ["Push Files and Views" org-mobile-push t]
21558 ["Get Captured and Flagged" org-mobile-pull t]
21559 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21561 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21564 ["Show Version" org-version t]
21565 ["Info Documentation" org-info t])
21567 ["Browse Org Group" org-customize t]
21569 ["Expand This Menu" org-create-customize-menu
21570 (fboundp 'customize-menu-create)])
21571 ["Send bug report" org-submit-bug-report t]
21574 ["Refresh setup current buffer" org-mode-restart t]
21575 ["Reload Org (after update)" org-reload t]
21576 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21579 (defun org-info (&optional node)
21580 "Read documentation for Org-mode in the info system.
21581 With optional NODE, go directly to that node."
21583 (info (format "(org)%s" (or node ""))))
21586 (defun org-submit-bug-report ()
21587 "Submit a bug report on Org-mode via mail.
21589 Don't hesitate to report any problems or inaccurate documentation.
21591 If you don't have setup sending mail from (X)Emacs, please copy the
21592 output buffer into your mail program, as it gives us important
21593 information about your Org-mode version and configuration."
21595 (require 'reporter)
21596 (org-load-modules-maybe)
21597 (org-require-autoloaded-modules)
21598 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21599 (reporter-submit-bug-report
21600 "emacs-orgmode@gnu.org"
21601 (org-version nil 'full)
21603 (save-window-excursion
21604 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21605 (delete-other-windows)
21607 (insert "You are about to submit a bug report to the Org-mode mailing list.
21609 We would like to add your full Org-mode and Outline configuration to the
21610 bug report. This greatly simplifies the work of the maintainer and
21611 other experts on the mailing list.
21613 HOWEVER, some variables you have customized may contain private
21614 information. The names of customers, colleagues, or friends, might
21615 appear in the form of file names, tags, todo states, or search strings.
21616 If you answer yes to the prompt, you might want to check and remove
21617 such private information before sending the email.")
21618 (add-text-properties (point-min) (point-max) '(face org-warning))
21619 (when (yes-or-no-p "Include your Org-mode configuration ")
21623 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21624 (or (and (symbol-value v)
21625 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21627 (get v 'custom-type) (get v 'standard-value)
21628 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21630 (kill-buffer (get-buffer "*Warn about privacy*"))
21633 "Remember to cover the basics, that is, what you expected to happen and
21634 what in fact did happen. You don't know how to make a good report? See
21636 http://orgmode.org/manual/Feedback.html#Feedback
21638 Your bug report will be posted to the Org-mode mailing list.
21639 ------------------------------------------------------------------------")
21641 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21642 (replace-match "\\1Bug: \\3 [\\2]")))))
21645 (defun org-install-agenda-files-menu ()
21646 (let ((bl (buffer-list)))
21649 (set-buffer (pop bl))
21650 (if (derived-mode-p 'org-mode) (setq bl nil)))
21651 (when (derived-mode-p 'org-mode)
21653 '("Org") "File List for Agenda"
21656 ["Edit File List" (org-edit-agenda-file-list) t]
21657 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21658 ["Remove Current File from List" org-remove-file t]
21659 ["Cycle through agenda files" org-cycle-agenda-files t]
21660 ["Occur in all agenda files" org-occur-in-agenda-files t]
21662 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21666 (defun org-require-autoloaded-modules ()
21669 '(org-agenda org-archive org-attach org-clock org-colview org-id
21670 org-table org-timer)))
21673 (defun org-reload (&optional uncompiled)
21674 "Reload all org lisp files.
21675 With prefix arg UNCOMPILED, load the uncompiled versions."
21677 (require 'loadhist)
21678 (let* ((org-dir (org-find-library-dir "org"))
21679 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21680 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21681 (remove-re (mapconcat 'identity
21682 (mapcar (lambda (f) (concat "^" f "$"))
21683 (list (if (featurep 'xemacs)
21685 "org-colview-xemacs")
21686 "org" "org-loaddefs" "org-version"))
21688 (feats (delete-dups
21689 (mapcar 'file-name-sans-extension
21690 (mapcar 'file-name-nondirectory
21692 (mapcar 'feature-file
21699 (if (and (string-match feature-re f)
21700 (not (string-match remove-re f)))
21704 (list "org-version" "org")))
21705 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21706 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21707 load-uncore load-misses)
21710 (mapcar (lambda (f)
21711 (or (org-load-noerror-mustsuffix (concat org-dir f))
21712 (and (string= org-dir contrib-dir)
21713 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21714 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21715 (add-to-list 'load-uncore f 'append)
21720 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21721 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21723 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21724 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21725 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21728 (defun org-customize ()
21729 "Call the customize function with org as argument."
21731 (org-load-modules-maybe)
21732 (org-require-autoloaded-modules)
21733 (customize-browse 'org))
21735 (defun org-create-customize-menu ()
21736 "Create a full customization menu for Org-mode, insert it into the menu."
21738 (org-load-modules-maybe)
21739 (org-require-autoloaded-modules)
21740 (if (fboundp 'customize-menu-create)
21743 '("Org") "Customize"
21744 `(["Browse Org group" org-customize t]
21746 ,(customize-menu-create 'org)
21747 ["Set" Custom-set t]
21748 ["Save" Custom-save t]
21749 ["Reset to Current" Custom-reset-current t]
21750 ["Reset to Saved" Custom-reset-saved t]
21751 ["Reset to Standard Settings" Custom-reset-standard t]))
21752 (message "\"Org\"-menu now contains full customization menu"))
21753 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21755 ;;;; Miscellaneous stuff
21757 ;;; Generally useful functions
21759 (defsubst org-get-at-eol (property n)
21760 "Get text property PROPERTY at the end of line less N characters."
21761 (get-text-property (- (point-at-eol) n) property))
21763 (defun org-find-text-property-in-string (prop s)
21764 "Return the first non-nil value of property PROP in string S."
21765 (or (get-text-property 0 prop s)
21766 (get-text-property (or (next-single-property-change 0 prop s) 0)
21769 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21770 "Display the given MESSAGE as a warning."
21771 (if (fboundp 'display-warning)
21772 (display-warning 'org message
21773 (if (featurep 'xemacs) 'warning :warning))
21774 (let ((buf (get-buffer-create "*Org warnings*")))
21775 (with-current-buffer buf
21776 (goto-char (point-max))
21777 (insert "Warning (Org): " message)
21780 (display-buffer buf)
21783 (defun org-eval (form)
21784 "Eval FORM and return result."
21785 (condition-case error
21787 (error (format "%%![Error: %s]" error))))
21789 (defun org-in-clocktable-p ()
21790 "Check if the cursor is in a clocktable."
21791 (let ((pos (point)) start)
21794 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21795 (setq start (match-beginning 0))
21796 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21797 (>= (match-end 0) pos)
21800 (defun org-in-verbatim-emphasis ()
21802 (and (org-in-regexp org-emph-re 2)
21803 (>= (point) (match-beginning 3))
21804 (<= (point) (match-end 4))
21805 (member (match-string 3) '("=" "~")))))
21807 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21808 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21809 (if (and marker (marker-buffer marker)
21810 (buffer-live-p (marker-buffer marker)))
21812 (org-pop-to-buffer-same-window (marker-buffer marker))
21813 (if (or (> marker (point-max)) (< marker (point-min)))
21816 (org-show-context 'org-goto))
21818 (bookmark-jump bookmark)
21819 (error "Cannot find location"))))
21821 (defun org-quote-csv-field (s)
21822 "Quote field for inclusion in CSV material."
21823 (if (string-match "[\",]" s)
21824 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21827 (defun org-force-self-insert (N)
21828 "Needed to enforce self-insert under remapping."
21830 (self-insert-command N))
21832 (defun org-string-width (s)
21833 "Compute width of string, ignoring invisible characters.
21834 This ignores character with invisibility property `org-link', and also
21835 characters with property `org-cwidth', because these will become invisible
21836 upon the next fontification round."
21838 (when (or (eq t buffer-invisibility-spec)
21839 (assq 'org-link buffer-invisibility-spec))
21840 (while (setq b (text-property-any 0 (length s)
21841 'invisible 'org-link s))
21842 (setq s (concat (substring s 0 b)
21843 (substring s (or (next-single-property-change
21844 b 'invisible s) (length s)))))))
21845 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21846 (setq s (concat (substring s 0 b)
21847 (substring s (or (next-single-property-change
21848 b 'org-cwidth s) (length s))))))
21849 (setq l (string-width s) b -1)
21850 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21851 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21854 (defun org-shorten-string (s maxlength)
21855 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21856 If the string is shorter or has length MAXLENGTH, just return the
21857 original string. If it is longer, the functions finds a space in the
21858 string, breaks this string off at that locations and adds three dots
21859 as ellipsis. Including the ellipsis, the string will not be longer
21860 than MAXLENGTH. If finding a good breaking point in the string does
21861 not work, the string is just chopped off in the middle of a word
21863 (if (<= (length s) maxlength)
21865 (let* ((n (max (- maxlength 4) 1))
21866 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21867 (if (string-match re s)
21868 (concat (match-string 1 s) "...")
21869 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21871 (defun org-get-indentation (&optional line)
21872 "Get the indentation of the current line, interpreting tabs.
21873 When LINE is given, assume it represents a line and compute its indentation."
21875 (if (string-match "^ *" (org-remove-tabs line))
21878 (beginning-of-line 1)
21879 (skip-chars-forward " \t")
21880 (current-column))))
21882 (defun org-get-string-indentation (s)
21883 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21884 (let ((n -1) (i 0) (w tab-width) c)
21886 (while (< (setq n (1+ n)) (length s))
21887 (setq c (aref s n))
21888 (cond ((= c ?\ ) (setq i (1+ i)))
21889 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21890 (t (throw 'exit t)))))
21893 (defun org-remove-tabs (s &optional width)
21894 "Replace tabulators in S with spaces.
21895 Assumes that s is a single line, starting in column 0."
21896 (setq width (or width tab-width))
21897 (while (string-match "\t" s)
21898 (setq s (replace-match
21900 (- (* width (/ (+ (match-beginning 0) width) width))
21901 (match-beginning 0)) ?\ )
21905 (defun org-fix-indentation (line ind)
21906 "Fix indentation in LINE.
21907 IND is a cons cell with target and minimum indentation.
21908 If the current indentation in LINE is smaller than the minimum,
21909 leave it alone. If it is larger than ind, set it to the target."
21910 (let* ((l (org-remove-tabs line))
21911 (i (org-get-indentation l))
21912 (i1 (car ind)) (i2 (cdr ind)))
21913 (if (>= i i2) (setq l (substring line i2)))
21915 (concat (make-string i1 ?\ ) l)
21918 (defun org-remove-indentation (code &optional n)
21919 "Remove the maximum common indentation from the lines in CODE.
21920 N may optionally be the number of spaces to remove."
21923 (org-do-remove-indentation n)
21926 (defun org-do-remove-indentation (&optional n)
21927 "Remove the maximum common indentation from the buffer."
21928 (untabify (point-min) (point-max))
21929 (let ((min 10000) re)
21932 (goto-char (point-min))
21933 (while (re-search-forward "^ *[^ \n]" nil t)
21934 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21935 (unless (or (= min 0) (= min 10000))
21936 (setq re (format "^ \\{%d\\}" min))
21937 (goto-char (point-min))
21938 (while (re-search-forward re nil t)
21943 (defun org-fill-template (template alist)
21944 "Find each %key of ALIST in TEMPLATE and replace it."
21945 (let ((case-fold-search nil)
21947 (setq alist (sort (copy-sequence alist)
21948 (lambda (a b) (< (length (car a)) (length (car b))))))
21949 (while (setq entry (pop alist))
21951 (replace-regexp-in-string
21952 (concat "%" (regexp-quote (car entry)))
21953 (or (cdr entry) "") template t t)))
21956 (defun org-base-buffer (buffer)
21957 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21960 (or (buffer-base-buffer buffer)
21963 (defun org-wrap (string &optional width lines)
21964 "Wrap string to either a number of lines, or a width in characters.
21965 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21966 that costs. If there is a word longer than WIDTH, the text is actually
21967 wrapped to the length of that word.
21968 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21969 many lines, whatever width that takes.
21970 The return value is a list of lines, without newlines at the end."
21971 (let* ((words (org-split-string string "[ \t\n]+"))
21972 (maxword (apply 'max (mapcar 'org-string-width words)))
21975 (org-do-wrap words (max maxword width)))
21978 (setq ll (org-do-wrap words maxword))
21979 (if (<= (length ll) lines)
21982 (while (> (length ll) lines)
21984 (setq ll (org-do-wrap words w)))
21986 (t (error "Cannot wrap this")))))
21988 (defun org-do-wrap (words width)
21989 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21992 (setq line (pop words))
21993 (while (and words (< (+ (length line) (length (car words))) width))
21994 (setq line (concat line " " (pop words))))
21995 (setq lines (push line lines)))
21998 (defun org-split-string (string &optional separators)
21999 "Splits STRING into substrings at SEPARATORS.
22000 No empty strings are returned if there are matches at the beginning
22001 and end of string."
22002 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
22006 (while (and (string-match rexp string
22008 (= start (match-beginning 0))
22009 (< start (length string)))
22011 (< (match-beginning 0) (length string)))
22013 (or (eq (match-beginning 0) 0)
22014 (and (eq (match-beginning 0) (match-end 0))
22015 (eq (match-beginning 0) start))
22017 (cons (substring string start (match-beginning 0))
22019 (setq start (match-end 0)))
22020 (or (eq start (length string))
22022 (cons (substring string start)
22026 (defun org-quote-vert (s)
22027 "Replace \"|\" with \"\\vert\"."
22028 (while (string-match "|" s)
22029 (setq s (replace-match "\\vert" t t s)))
22032 (defun org-uuidgen-p (s)
22033 "Is S an ID created by UUIDGEN?"
22034 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22036 (defun org-in-src-block-p (&optional inside)
22037 "Whether point is in a code source block.
22038 When INSIDE is non-nil, don't consider we are within a src block
22039 when point is at #+BEGIN_SRC or #+END_SRC."
22040 (let ((case-fold-search t) ov)
22041 (or (and (eq (get-char-property (point) 'src-block) t))
22045 (beginning-of-line)
22046 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22048 (defun org-context ()
22049 "Return a list of contexts of the current cursor position.
22050 If several contexts apply, all are returned.
22051 Each context entry is a list with a symbol naming the context, and
22052 two positions indicating start and end of the context. Possible
22055 :headline anywhere in a headline
22056 :headline-stars on the leading stars in a headline
22057 :todo-keyword on a TODO keyword (including DONE) in a headline
22058 :tags on the TAGS in a headline
22059 :priority on the priority cookie in a headline
22060 :item on the first line of a plain list item
22061 :item-bullet on the bullet/number of a plain list item
22062 :checkbox on the checkbox in a plain list item
22063 :table in an org-mode table
22064 :table-special on a special filed in a table
22065 :table-table in a table.el table
22066 :clocktable in a clocktable
22067 :src-block in a source block
22068 :link on a hyperlink
22069 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22070 :target on a <<target>>
22071 :radio-target on a <<<radio-target>>>
22072 :latex-fragment on a LaTeX fragment
22073 :latex-preview on a LaTeX fragment with overlaid preview image
22075 This function expects the position to be visible because it uses font-lock
22076 faces as a help to recognize the following contexts: :table-special, :link,
22078 (let* ((f (get-text-property (point) 'face))
22079 (faces (if (listp f) f (list f)))
22080 (case-fold-search t)
22081 (p (point)) clist o)
22082 ;; First the large context
22084 ((org-at-heading-p t)
22085 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22087 (beginning-of-line 1)
22088 (looking-at org-todo-line-tags-regexp))
22089 (push (org-point-in-group p 1 :headline-stars) clist)
22090 (push (org-point-in-group p 2 :todo-keyword) clist)
22091 (push (org-point-in-group p 4 :tags) clist))
22093 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22094 (if (looking-at "\\[#[A-Z0-9]\\]")
22095 (push (org-point-in-group p 0 :priority) clist)))
22098 (push (org-point-in-group p 2 :item-bullet) clist)
22099 (push (list :item (point-at-bol)
22100 (save-excursion (org-end-of-item) (point)))
22102 (and (org-at-item-checkbox-p)
22103 (push (org-point-in-group p 0 :checkbox) clist)))
22106 (push (list :table (org-table-begin) (org-table-end)) clist)
22107 (if (memq 'org-formula faces)
22108 (push (list :table-special
22109 (previous-single-property-change p 'face)
22110 (next-single-property-change p 'face)) clist)))
22111 ((org-at-table-p 'any)
22112 (push (list :table-table) clist)))
22115 (let ((case-fold-search t))
22116 ;; New the "medium" contexts: clocktables, source blocks
22117 (cond ((org-in-clocktable-p)
22118 (push (list :clocktable
22119 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22120 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22121 (match-beginning 1))
22122 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22123 (match-end 0))) clist))
22124 ((org-in-src-block-p)
22125 (push (list :src-block
22126 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22127 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22128 (match-beginning 1))
22129 (and (search-forward "#+END_SRC" nil t)
22130 (match-beginning 0))) clist))))
22133 ;; Now the small context
22135 ((org-at-timestamp-p)
22136 (push (org-point-in-group p 0 :timestamp) clist))
22137 ((memq 'org-link faces)
22139 (previous-single-property-change p 'face)
22140 (next-single-property-change p 'face)) clist))
22141 ((memq 'org-special-keyword faces)
22142 (push (list :keyword
22143 (previous-single-property-change p 'face)
22144 (next-single-property-change p 'face)) clist))
22146 (push (org-point-in-group p 0 :target) clist)
22147 (goto-char (1- (match-beginning 0)))
22148 (if (looking-at org-radio-target-regexp)
22149 (push (org-point-in-group p 0 :radio-target) clist))
22151 ((setq o (car (delq nil
22154 (if (memq x org-latex-fragment-image-overlays) x))
22155 (overlays-at (point))))))
22156 (push (list :latex-fragment
22157 (overlay-start o) (overlay-end o)) clist)
22158 (push (list :latex-preview
22159 (overlay-start o) (overlay-end o)) clist))
22160 ((org-inside-LaTeX-fragment-p)
22161 ;; FIXME: positions wrong.
22162 (push (list :latex-fragment (point) (point)) clist)))
22164 (setq clist (nreverse (delq nil clist)))
22167 ;; FIXME: Compare with at-regexp-p Do we need both?
22168 (defun org-in-regexp (re &optional nlines visually)
22169 "Check if point is inside a match of regexp.
22170 Normally only the current line is checked, but you can include NLINES extra
22171 lines both before and after point into the search.
22172 If VISUALLY is set, require that the cursor is not after the match but
22173 really on, so that the block visually is on the match."
22175 (let ((pos (point))
22176 (eol (point-at-eol (+ 1 (or nlines 0))))
22177 (inc (if visually 1 0)))
22179 (beginning-of-line (- 1 (or nlines 0)))
22180 (while (re-search-forward re eol t)
22181 (if (and (<= (match-beginning 0) pos)
22182 (>= (+ inc (match-end 0)) pos))
22183 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22185 (defun org-at-regexp-p (regexp)
22186 "Is point inside a match of REGEXP in the current line?"
22189 (let ((pos (point)) (end (point-at-eol)))
22190 (beginning-of-line 1)
22191 (while (re-search-forward regexp end t)
22192 (if (and (<= (match-beginning 0) pos)
22193 (>= (match-end 0) pos))
22197 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22198 "Non-nil when point is between matches of START-RE and END-RE.
22200 Also return a non-nil value when point is on one of the matches.
22202 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22203 buffer positions. Default values are the positions of headlines
22204 surrounding the point.
22206 The functions returns a cons cell whose car (resp. cdr) is the
22207 position before START-RE (resp. after END-RE)."
22209 (let ((pos (point))
22210 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22211 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22214 ;; Point is on a block when on START-RE or if START-RE can be
22215 ;; found before it...
22216 (and (or (org-at-regexp-p start-re)
22217 (re-search-backward start-re limit-up t))
22218 (setq beg (match-beginning 0))
22219 ;; ... and END-RE after it...
22220 (goto-char (match-end 0))
22221 (re-search-forward end-re limit-down t)
22222 (> (setq end (match-end 0)) pos)
22223 ;; ... without another START-RE in-between.
22224 (goto-char (match-beginning 0))
22225 (not (re-search-backward start-re (1+ beg) t))
22227 (cons beg end))))))
22229 (defun org-in-block-p (names)
22230 "Non-nil when point belongs to a block whose name belongs to NAMES.
22232 NAMES is a list of strings containing names of blocks.
22234 Return first block name matched, or nil. Beware that in case of
22235 nested blocks, the returned name may not belong to the closest
22239 (let ((case-fold-search t)
22240 (lim-up (save-excursion (outline-previous-heading)))
22241 (lim-down (save-excursion (outline-next-heading))))
22242 (mapc (lambda (name)
22243 (let ((n (regexp-quote name)))
22244 (when (org-between-regexps-p
22245 (concat "^[ \t]*#\\+begin_" n)
22246 (concat "^[ \t]*#\\+end_" n)
22252 (defun org-in-drawer-p ()
22253 "Non-nil if point is within a drawer.
22254 If point is within a drawer, return it, as parsed data."
22255 (let ((element (save-match-data (org-element-at-point))))
22256 (while (and element (not (memq (org-element-type element)
22257 '(drawer property-drawer))))
22258 (setq element (org-element-property :parent element)))
22261 (defun org-occur-in-agenda-files (regexp &optional nlines)
22262 "Call `multi-occur' with buffers for all agenda files."
22263 (interactive "sOrg-files matching: \np")
22264 (let* ((files (org-agenda-files))
22265 (tnames (mapcar 'file-truename files))
22266 (extra org-agenda-text-search-extra-files)
22268 (when (eq (car extra) 'agenda-archives)
22269 (setq extra (cdr extra))
22270 (setq files (org-add-archive-files files)))
22271 (while (setq f (pop extra))
22272 (unless (member (file-truename f) tnames)
22273 (add-to-list 'files f 'append)
22274 (add-to-list 'tnames (file-truename f) 'append)))
22276 (mapcar (lambda (x)
22277 (with-current-buffer
22278 (or (get-file-buffer x) (find-file-noselect x))
22284 (if (boundp 'occur-mode-find-occurrence-hook)
22286 (add-hook 'occur-mode-find-occurrence-hook
22288 (when (derived-mode-p 'org-mode)
22291 (defadvice occur-mode-goto-occurrence
22292 (after org-occur-reveal activate)
22293 (and (derived-mode-p 'org-mode) (org-reveal)))
22294 (defadvice occur-mode-goto-occurrence-other-window
22295 (after org-occur-reveal activate)
22296 (and (derived-mode-p 'org-mode) (org-reveal)))
22297 (defadvice occur-mode-display-occurrence
22298 (after org-occur-reveal activate)
22299 (when (derived-mode-p 'org-mode)
22300 (let ((pos (occur-mode-find-occurrence)))
22301 (with-current-buffer (marker-buffer pos)
22306 (defun org-occur-link-in-agenda-files ()
22307 "Create a link and search for it in the agendas.
22308 The link is not stored in `org-stored-links', it is just created
22309 for the search purpose."
22311 (let ((link (condition-case nil
22312 (org-store-link nil)
22313 (error "Unable to create a link to here"))))
22314 (org-occur-in-agenda-files (regexp-quote link))))
22316 (defun org-reverse-string (string)
22317 "Return the reverse of STRING."
22318 (apply 'string (reverse (string-to-list string))))
22320 ;; defsubst org-uniquify must be defined before first use
22322 (defun org-uniquify-alist (alist)
22323 "Merge elements of ALIST with the same key.
22325 For example, in this alist:
22327 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22328 => '((a 1 3) (b 2))
22330 merge (a 1) and (a 3) into (a 1 3).
22332 The function returns the new ALIST."
22337 (if (not (assoc (car e) rtn))
22339 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22340 (setq rtn (assq-delete-all (car e) rtn))
22345 (defun org-delete-all (elts list)
22346 "Remove all elements in ELTS from LIST."
22348 (setq list (delete (pop elts) list)))
22351 (defun org-count (cl-item cl-seq)
22352 "Count the number of occurrences of ITEM in SEQ.
22353 Taken from `count' in cl-seq.el with all keyword arguments removed."
22354 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22355 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22356 (while (< cl-start cl-end)
22357 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22358 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22359 (setq cl-start (1+ cl-start)))
22362 (defun org-remove-if (predicate seq)
22363 "Remove everything from SEQ that fulfills PREDICATE."
22367 (if (not (funcall predicate e)) (push e res)))
22370 (defun org-remove-if-not (predicate seq)
22371 "Remove everything from SEQ that does not fulfill PREDICATE."
22375 (if (funcall predicate e) (push e res)))
22378 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22379 "Reduce two-argument FUNCTION across SEQ.
22380 Taken from `reduce' in cl-seq.el with all keyword arguments but
22381 \":initial-value\" removed."
22382 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22383 (cadr (memq :initial-value cl-keys)))
22384 (cl-seq (pop cl-seq))
22385 (t (funcall cl-func)))))
22387 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22390 (defun org-every (pred seq)
22391 "Return true if PREDICATE is true of every element of SEQ.
22392 Adapted from `every' in cl.el."
22394 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22397 (defun org-some (pred seq)
22398 "Return true if PREDICATE is true of any element of SEQ.
22399 Adapted from `some' in cl.el."
22401 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22404 (defun org-back-over-empty-lines ()
22405 "Move backwards over whitespace, to the beginning of the first empty line.
22406 Returns the number of empty lines passed."
22407 (let ((pos (point)))
22408 (if (cdr (assoc 'heading org-blank-before-new-entry))
22409 (skip-chars-backward " \t\n\r")
22411 (forward-line -1)))
22412 (beginning-of-line 2)
22413 (goto-char (min (point) pos))
22414 (count-lines (point) pos)))
22416 (defun org-skip-whitespace ()
22417 (skip-chars-forward " \t\n\r"))
22419 (defun org-point-in-group (point group &optional context)
22420 "Check if POINT is in match-group GROUP.
22421 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22422 match. If the match group does not exist or point is not inside it,
22424 (and (match-beginning group)
22425 (>= point (match-beginning group))
22426 (<= point (match-end group))
22428 (list context (match-beginning group) (match-end group))
22431 (defun org-switch-to-buffer-other-window (&rest args)
22432 "Switch to buffer in a second window on the current frame.
22433 In particular, do not allow pop-up frames.
22434 Returns the newly created buffer."
22436 (apply 'switch-to-buffer-other-window args)))
22438 (defun org-combine-plists (&rest plists)
22439 "Create a single property list from all plists in PLISTS.
22440 The process starts by copying the first list, and then setting properties
22441 from the other lists. Settings in the last list are the most significant
22442 ones and overrule settings in the other lists."
22443 (let ((rtn (copy-sequence (pop plists)))
22446 (setq ls (pop plists))
22448 (setq p (pop ls) v (pop ls))
22449 (setq rtn (plist-put rtn p v))))
22452 (defun org-replace-escapes (string table)
22453 "Replace %-escapes in STRING with values in TABLE.
22454 TABLE is an association list with keys like \"%a\" and string values.
22455 The sequences in STRING may contain normal field width and padding information,
22456 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22457 so values can contain further %-escapes if they are define later in TABLE."
22458 (let ((tbl (copy-alist table))
22459 (case-fold-search nil)
22462 (while (setq e (pop tbl))
22463 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22464 (when (and (cdr e) (string-match re (cdr e)))
22465 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22467 (add-text-properties 0 3 (list 'sref sref) safe)
22468 (setcdr e (replace-match safe t t (cdr e)))))
22469 (while (string-match re string)
22470 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22472 (setq string (replace-match rpl t t string))))
22473 (while (setq pchg (next-property-change pchg string))
22474 (let ((sref (get-text-property pchg 'sref string)))
22475 (when (and sref (string-match "SREF" string pchg))
22476 (setq string (replace-match sref t t string)))))
22479 (defun org-sublist (list start end)
22480 "Return a section of LIST, from START to END.
22481 Counting starts at 1."
22482 (let (rtn (c start))
22483 (setq list (nthcdr (1- start) list))
22484 (while (and list (<= c end))
22485 (push (pop list) rtn)
22489 (defun org-find-base-buffer-visiting (file)
22490 "Like `find-buffer-visiting' but always return the base buffer and
22491 not an indirect buffer."
22492 (let ((buf (or (get-file-buffer file)
22493 (find-buffer-visiting file))))
22495 (or (buffer-base-buffer buf) buf)
22498 (defun org-image-file-name-regexp (&optional extensions)
22499 "Return regexp matching the file names of images.
22500 If EXTENSIONS is given, only match these."
22501 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22502 (image-file-name-regexp)
22503 (let ((image-file-name-extensions
22505 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22506 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22508 (regexp-opt (nconc (mapcar 'upcase
22509 image-file-name-extensions)
22510 image-file-name-extensions)
22514 (defun org-file-image-p (file &optional extensions)
22515 "Return non-nil if FILE is an image."
22517 (string-match (org-image-file-name-regexp extensions) file)))
22519 (defun org-get-cursor-date (&optional with-time)
22520 "Return the date at cursor in as a time.
22521 This works in the calendar and in the agenda, anywhere else it just
22522 returns the current time.
22523 If WITH-TIME is non-nil, returns the time of the event at point (in
22524 the agenda) or the current time of the day."
22525 (let (date day defd tp tm hod mod)
22527 (setq tp (get-text-property (point) 'time))
22528 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22529 (setq hod (string-to-number (match-string 1 tp))
22530 mod (string-to-number (match-string 2 tp))))
22531 (or tp (setq hod (nth 2 (decode-time (current-time)))
22532 mod (nth 1 (decode-time (current-time))))))
22534 ((eq major-mode 'calendar-mode)
22535 (setq date (calendar-cursor-to-date)
22536 defd (encode-time 0 (or mod 0) (or hod 0)
22537 (nth 1 date) (nth 0 date) (nth 2 date))))
22538 ((eq major-mode 'org-agenda-mode)
22539 (setq day (get-text-property (point) 'day))
22541 (setq date (calendar-gregorian-from-absolute day)
22542 defd (encode-time 0 (or mod 0) (or hod 0)
22543 (nth 1 date) (nth 0 date) (nth 2 date))))))
22544 (or defd (current-time))))
22546 (defun org-mark-subtree (&optional up)
22547 "Mark the current subtree.
22548 This puts point at the start of the current subtree, and mark at
22549 the end. If a numeric prefix UP is given, move up into the
22550 hierarchy of headlines by UP levels before marking the subtree."
22552 (org-with-limited-levels
22553 (cond ((org-at-heading-p) (beginning-of-line))
22554 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22555 (t (outline-previous-visible-heading 1))))
22556 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22557 (if (org-called-interactively-p 'any)
22558 (call-interactively 'org-mark-element)
22559 (org-mark-element)))
22564 (defun org--get-expected-indentation (element contentsp)
22565 "Expected indentation column for current line, according to ELEMENT.
22566 ELEMENT is an element containing point. CONTENTSP is non-nil
22567 when indentation is to be computed according to contents of
22569 (let ((type (org-element-type element))
22570 (start (org-element-property :begin element)))
22571 (org-with-wide-buffer
22575 (footnote-definition 0)
22576 ((headline inlinetask nil)
22577 (if (not org-adapt-indentation) 0
22578 (let ((level (org-current-level)))
22579 (if level (1+ level) 0))))
22581 (org-list-item-body-column
22582 (org-element-property :post-affiliated element)))
22585 (goto-char (org-element-property :post-affiliated element))
22586 (org-get-indentation)))
22589 (org-get-indentation))))
22590 ((memq type '(headline inlinetask nil))
22591 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22592 (org--get-expected-indentation element t)
22594 ((eq type 'footnote-definition) 0)
22595 ;; First paragraph of a footnote definition or an item.
22596 ;; Indent like parent.
22597 ((< (line-beginning-position) start)
22598 (org--get-expected-indentation
22599 (org-element-property :parent element) t))
22600 ;; At first line: indent according to previous sibling, if any,
22601 ;; ignoring footnote definitions and inline tasks, or parent's
22603 ((= (line-beginning-position) start)
22606 (if (= (point-min) start) (throw 'exit 0)
22607 (goto-char (1- start))
22608 (let* ((previous (org-element-at-point))
22610 (while (and parent (<= (org-element-property :end parent) start))
22611 (setq previous parent
22612 parent (org-element-property :parent parent)))
22614 ((not previous) (throw 'exit 0))
22615 ((> (org-element-property :end previous) start)
22616 (throw 'exit (org--get-expected-indentation previous t)))
22617 ((memq (org-element-type previous)
22618 '(footnote-definition inlinetask))
22619 (setq start (org-element-property :begin previous)))
22620 (t (goto-char (org-element-property :begin previous))
22622 (if (bolp) (org-get-indentation)
22623 ;; At first paragraph in an item or
22624 ;; a footnote definition.
22625 (org--get-expected-indentation
22626 (org-element-property :parent previous) t))))))))))
22627 ;; Otherwise, move to the first non-blank line above.
22629 (beginning-of-line)
22630 (let ((pos (point)))
22631 (skip-chars-backward " \r\t\n")
22633 ;; Two blank lines end a footnote definition or a plain
22634 ;; list. When we indent an empty line after them, the
22635 ;; containing list or footnote definition is over, so it
22636 ;; qualifies as a previous sibling. Therefore, we indent
22637 ;; like its first line.
22638 ((and (memq type '(footnote-definition plain-list))
22639 (> (count-lines (point) pos) 2))
22641 (org-get-indentation))
22642 ;; Line above is the first one of a paragraph at the
22643 ;; beginning of an item or a footnote definition. Indent
22645 ((< (line-beginning-position) start)
22646 (org--get-expected-indentation
22647 (org-element-property :parent element) t))
22648 ;; POS is after contents in a greater element. Indent like
22649 ;; the beginning of the element.
22651 ;; As a special case, if point is at the end of a footnote
22652 ;; definition or an item, indent like the very last element
22654 ((and (not (eq type 'paragraph))
22655 (let ((cend (org-element-property :contents-end element)))
22656 (and cend (<= cend pos))))
22657 (if (memq type '(footnote-definition item plain-list))
22658 (org--get-expected-indentation (org-element-at-point) nil)
22660 (org-get-indentation)))
22661 ;; In any other case, indent like the current line.
22662 (t (org-get-indentation)))))))))
22664 (defun org--align-node-property ()
22665 "Align node property at point.
22666 Alignment is done according to `org-property-format', which see."
22667 (when (save-excursion
22668 (beginning-of-line)
22669 (looking-at org-property-re))
22671 (concat (match-string 4)
22673 (format org-property-format (match-string 1) (match-string 3))))
22676 (defun org-indent-line ()
22677 "Indent line depending on context.
22679 Indentation is done according to the following rules:
22681 - Footnote definitions, headlines and inline tasks have to
22684 - On the very first line of an element, consider, in order, the
22685 next rules until one matches:
22687 1. If there's a sibling element before, ignoring footnote
22688 definitions and inline tasks, indent like its first line.
22690 2. If element has a parent, indent like its contents. More
22691 precisely, if parent is an item, indent after the
22692 description part, if any, or the bullet (see
22693 `org-list-description-max-indent'). Else, indent like
22694 parent's first line.
22696 3. Otherwise, indent relatively to current level, if
22697 `org-adapt-indentation' is non-nil, or to left margin.
22699 - On a blank line at the end of an element, indent according to
22700 the type of the element. More precisely
22702 1. If element is a plain list, an item, or a footnote
22703 definition, indent like the very last element within.
22705 2. If element is a paragraph, indent like its last non blank
22708 3. Otherwise, indent like its very first line.
22710 - In the code part of a source block, use language major mode
22711 to indent current line if `org-src-tab-acts-natively' is
22712 non-nil. If it is nil, do nothing.
22714 - Otherwise, indent like the first non-blank line above.
22716 The function doesn't indent an item as it could break the whole
22717 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22718 \\[org-shiftmetaright].
22720 Also align node properties according to `org-property-format'."
22724 (let ((indent-line-function
22725 (cadadr (assq 'indent-line-function org-fb-vars))))
22726 (indent-according-to-mode)))
22727 ((org-at-heading-p) 'noindent)
22729 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22730 (type (org-element-type element)))
22731 (cond ((and (memq type '(plain-list item))
22732 (= (line-beginning-position)
22733 (org-element-property :post-affiliated element)))
22735 ((and (eq type 'src-block)
22736 org-src-tab-acts-natively
22737 (> (line-beginning-position)
22738 (org-element-property :post-affiliated element))
22739 (< (line-beginning-position)
22740 (org-with-wide-buffer
22741 (goto-char (org-element-property :end element))
22742 (skip-chars-backward " \r\t\n")
22743 (line-beginning-position))))
22744 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22746 (let ((column (org--get-expected-indentation element nil)))
22747 ;; Preserve current column.
22748 (if (<= (current-column) (current-indentation))
22749 (org-indent-line-to column)
22750 (save-excursion (org-indent-line-to column))))
22751 ;; Align node property. Also preserve current column.
22752 (when (eq type 'node-property)
22753 (let ((column (current-column)))
22754 (org--align-node-property)
22755 (org-move-to-column column)))))))))
22757 (defun org-indent-region (start end)
22758 "Indent each non-blank line in the region.
22759 Called from a program, START and END specify the region to
22760 indent. The function will not indent contents of example blocks,
22761 verse blocks and export blocks as leading white spaces are
22762 assumed to be significant there."
22766 (skip-chars-forward " \r\t\n")
22767 (unless (eobp) (beginning-of-line))
22770 ;; Set IND as indentation for all lines between point and
22771 ;; POS or END, whichever comes first. Blank lines are
22772 ;; ignored. Leave point after POS once done.
22773 (let ((limit (copy-marker (min end pos))))
22774 (while (< (point) limit)
22775 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
22777 (set-marker limit nil))))
22778 (end (copy-marker end)))
22779 (while (< (point) end)
22780 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
22781 (let* ((element (org-element-at-point))
22782 (type (org-element-type element))
22783 (element-end (copy-marker (org-element-property :end element)))
22784 (ind (org--get-expected-indentation element nil)))
22786 ((or (memq type '(paragraph table table-row))
22787 (not (or (org-element-property :contents-begin element)
22789 '(example-block export-block src-block)))))
22790 ;; Elements here are indented as a single block. Also
22791 ;; align node properties.
22792 (when (eq type 'node-property)
22793 (org--align-node-property)
22794 (beginning-of-line))
22795 (funcall indent-to ind element-end))
22797 ;; Elements in this category consist of three parts:
22798 ;; before the contents, the contents, and after the
22799 ;; contents. The contents are treated specially,
22800 ;; according to the element type, or not indented at
22801 ;; all. Other parts are indented as a single block.
22802 (let* ((post (copy-marker
22803 (org-element-property :post-affiliated element)))
22807 ((not (org-element-property :contents-begin element))
22808 ;; Fake contents for source blocks.
22809 (org-with-wide-buffer
22813 ((memq type '(footnote-definition item plain-list))
22814 ;; Contents in these elements could start on
22815 ;; the same line as the beginning of the
22816 ;; element. Make sure we start indenting
22817 ;; from the second line.
22818 (org-with-wide-buffer
22821 (skip-chars-forward " \r\t\n")
22822 (if (eobp) (point) (line-beginning-position))))
22823 (t (org-element-property :contents-begin element)))))
22825 (or (org-element-property :contents-end element)
22826 ;; Fake contents for source blocks.
22827 (org-with-wide-buffer
22828 (goto-char element-end)
22829 (skip-chars-backward " \r\t\n")
22830 (line-beginning-position)))
22832 ;; Do not change items indentation individually as it
22833 ;; might break the list as a whole. On the other
22834 ;; hand, when at a plain list, indent it as a whole.
22835 (cond ((eq type 'plain-list)
22836 (let ((offset (- ind (org-get-indentation))))
22837 (unless (zerop offset)
22838 (indent-rigidly (org-element-property :begin element)
22839 (org-element-property :end element)
22842 ((eq type 'item) (goto-char cbeg))
22843 (t (funcall indent-to ind cbeg)))
22844 (when (< (point) end)
22846 ((example-block export-block verse-block))
22848 ;; In a source block, indent source code
22849 ;; according to language major mode, but only if
22850 ;; `org-src-tab-acts-natively' is non-nil.
22851 (when (and (< (point) end) org-src-tab-acts-natively)
22853 (org-babel-do-in-edit-buffer
22854 (indent-region (point-min) (point-max))))))
22855 (t (org-indent-region (point) (min cend end))))
22856 (goto-char (min cend end))
22857 (when (< (point) end) (funcall indent-to ind element-end)))
22858 (set-marker post nil)
22859 (set-marker cbeg nil)
22860 (set-marker cend nil))))
22861 (set-marker element-end nil))))
22862 (set-marker end nil))))
22864 (defun org-indent-drawer ()
22865 "Indent the drawer at point."
22867 (unless (save-excursion
22868 (beginning-of-line)
22869 (org-looking-at-p org-drawer-regexp))
22870 (user-error "Not at a drawer"))
22871 (let ((element (org-element-at-point)))
22872 (unless (memq (org-element-type element) '(drawer property-drawer))
22873 (user-error "Not at a drawer"))
22874 (org-with-wide-buffer
22875 (org-indent-region (org-element-property :begin element)
22876 (org-element-property :end element))))
22877 (message "Drawer at point indented"))
22879 (defun org-indent-block ()
22880 "Indent the block at point."
22882 (unless (save-excursion
22883 (beginning-of-line)
22884 (let ((case-fold-search t))
22885 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
22886 (user-error "Not at a block"))
22887 (let ((element (org-element-at-point)))
22888 (unless (memq (org-element-type element)
22889 '(comment-block center-block dynamic-block example-block
22890 export-block quote-block special-block
22891 src-block verse-block))
22892 (user-error "Not at a block"))
22893 (org-with-wide-buffer
22894 (org-indent-region (org-element-property :begin element)
22895 (org-element-property :end element))))
22896 (message "Block at point indented"))
22901 ;; We use our own fill-paragraph and auto-fill functions.
22903 ;; `org-fill-paragraph' relies on adaptive filling and context
22904 ;; checking. Appropriate `fill-prefix' is computed with
22905 ;; `org-adaptive-fill-function'.
22907 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22908 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22909 ;; `org-adaptive-fill-function' value. Internally,
22910 ;; `org-comment-line-break-function' breaks the line.
22912 ;; `org-setup-filling' installs filling and auto-filling related
22913 ;; variables during `org-mode' initialization.
22915 (defvar org-element-paragraph-separate) ; org-element.el
22916 (defun org-setup-filling ()
22917 (require 'org-element)
22918 ;; Prevent auto-fill from inserting unwanted new items.
22919 (when (boundp 'fill-nobreak-predicate)
22921 'fill-nobreak-predicate
22923 (append fill-nobreak-predicate
22924 '(org-fill-line-break-nobreak-p
22925 org-fill-paragraph-with-timestamp-nobreak-p)))))
22926 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22927 (org-set-local 'paragraph-start paragraph-ending)
22928 (org-set-local 'paragraph-separate paragraph-ending))
22929 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22930 (org-set-local 'auto-fill-inhibit-regexp nil)
22931 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22932 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22933 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22935 (defun org-fill-line-break-nobreak-p ()
22936 "Non-nil when a new line at point would create an Org line break."
22938 (skip-chars-backward "[ \t]")
22939 (skip-chars-backward "\\\\")
22940 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22942 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22943 "Non-nil when a new line at point would split a timestamp."
22944 (and (org-at-timestamp-p t)
22945 (not (looking-at org-ts-regexp-both))))
22947 (declare-function message-in-body-p "message" ())
22948 (defvar orgtbl-line-start-regexp) ; From org-table.el
22949 (defun org-adaptive-fill-function ()
22950 "Compute a fill prefix for the current line.
22951 Return fill prefix, as a string, or nil if current line isn't
22952 meant to be filled. For convenience, if `adaptive-fill-regexp'
22953 matches in paragraphs or comments, use it."
22955 (when (derived-mode-p 'message-mode)
22957 (beginning-of-line)
22958 (cond ((or (not (message-in-body-p))
22959 (looking-at orgtbl-line-start-regexp))
22961 ((looking-at message-cite-prefix-regexp)
22962 (throw 'exit (match-string-no-properties 0)))
22963 ((looking-at org-outline-regexp)
22964 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
22965 (org-with-wide-buffer
22966 (unless (org-at-heading-p)
22967 (let* ((p (line-beginning-position))
22968 (element (save-excursion
22969 (beginning-of-line)
22970 (org-element-at-point)))
22971 (type (org-element-type element))
22972 (post-affiliated (org-element-property :post-affiliated element)))
22973 (unless (< p post-affiliated)
22977 (beginning-of-line)
22978 (looking-at "[ \t]*")
22979 (concat (match-string 0) "# ")))
22980 (footnote-definition "")
22982 (make-string (org-list-item-body-column post-affiliated) ?\s))
22984 ;; Fill prefix is usually the same as the current line,
22985 ;; unless the paragraph is at the beginning of an item.
22986 (let ((parent (org-element-property :parent element)))
22988 (beginning-of-line)
22989 (cond ((eq (org-element-type parent) 'item)
22990 (make-string (org-list-item-body-column
22991 (org-element-property :begin parent))
22993 ((and adaptive-fill-regexp
22995 ;; `adaptive-fill-function' to let
22996 ;; `fill-context-prefix' handle
22997 ;; `adaptive-fill-regexp' variable.
22998 (let (adaptive-fill-function)
22999 (fill-context-prefix
23001 (org-element-property :end element)))))
23002 ((looking-at "[ \t]+") (match-string 0))
23005 ;; Only fill contents if P is within block boundaries.
23006 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23009 (cend (save-excursion
23010 (goto-char (org-element-property :end element))
23011 (skip-chars-backward " \r\t\n")
23012 (line-beginning-position))))
23013 (when (and (>= p cbeg) (< p cend))
23014 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23018 (declare-function message-goto-body "message" ())
23019 (defvar message-cite-prefix-regexp) ; From message.el
23020 (defun org-fill-paragraph (&optional justify)
23021 "Fill element at point, when applicable.
23023 This function only applies to comment blocks, comments, example
23024 blocks and paragraphs. Also, as a special case, re-align table
23025 when point is at one.
23027 If JUSTIFY is non-nil (interactively, with prefix argument),
23028 justify as well. If `sentence-end-double-space' is non-nil, then
23029 period followed by one space does not end a sentence, so don't
23030 break a line there. The variable `fill-column' controls the
23033 For convenience, when point is at a plain list, an item or
23034 a footnote definition, try to fill the first paragraph within."
23036 (if (and (derived-mode-p 'message-mode)
23037 (or (not (message-in-body-p))
23038 (save-excursion (move-beginning-of-line 1)
23039 (looking-at message-cite-prefix-regexp))))
23040 ;; First ensure filling is correct in message-mode.
23041 (let ((fill-paragraph-function
23042 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23043 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23044 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23045 (paragraph-separate
23046 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23047 (fill-paragraph nil))
23048 (with-syntax-table org-mode-transpose-word-syntax-table
23049 ;; Move to end of line in order to get the first paragraph
23050 ;; within a plain list or a footnote definition.
23051 (let ((element (save-excursion
23053 (or (ignore-errors (org-element-at-point))
23054 (user-error "An element cannot be parsed line %d"
23055 (line-number-at-pos (point)))))))
23056 ;; First check if point is in a blank line at the beginning of
23057 ;; the buffer. In that case, ignore filling.
23058 (case (org-element-type element)
23059 ;; Use major mode filling function is src blocks.
23060 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23061 ;; Align Org tables, leave table.el tables as-is.
23062 (table-row (org-table-align) t)
23064 (when (eq (org-element-property :type element) 'org)
23066 (goto-char (org-element-property :post-affiliated element))
23067 (org-table-align)))
23070 ;; Paragraphs may contain `line-break' type objects.
23071 (let ((beg (max (point-min)
23072 (org-element-property :contents-begin element)))
23073 (end (min (point-max)
23074 (org-element-property :contents-end element))))
23075 ;; Do nothing if point is at an affiliated keyword.
23076 (if (< (line-end-position) beg) t
23077 (when (derived-mode-p 'message-mode)
23078 ;; In `message-mode', do not fill following citation
23079 ;; in current paragraph nor text before message body.
23080 (let ((body-start (save-excursion (message-goto-body))))
23081 (when body-start (setq beg (max body-start beg))))
23082 (when (save-excursion
23084 (concat "^" message-cite-prefix-regexp) end t))
23085 (setq end (match-beginning 0))))
23086 ;; Fill paragraph, taking line breaks into account.
23089 (let ((cuts (list beg)))
23090 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23091 (when (eq 'line-break
23093 (save-excursion (backward-char)
23094 (org-element-context))))
23095 (push (point) cuts)))
23096 (dolist (c (delq end cuts))
23097 (fill-region-as-paragraph c end justify)
23100 ;; Contents of `comment-block' type elements should be
23101 ;; filled as plain text, but only if point is within block
23104 (let* ((case-fold-search t)
23105 (beg (save-excursion
23106 (goto-char (org-element-property :begin element))
23107 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23110 (end (save-excursion
23111 (goto-char (org-element-property :end element))
23112 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23113 (line-beginning-position))))
23114 (if (or (< (point) beg) (> (point) end)) t
23115 (fill-region-as-paragraph
23116 (save-excursion (end-of-line)
23117 (re-search-backward "^[ \t]*$" beg 'move)
23118 (line-beginning-position))
23119 (save-excursion (beginning-of-line)
23120 (re-search-forward "^[ \t]*$" end 'move)
23121 (line-beginning-position))
23125 (let ((begin (org-element-property :post-affiliated element))
23126 (end (org-element-property :end element)))
23127 (when (and (>= (point) begin) (<= (point) end))
23128 (let ((begin (save-excursion
23130 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23131 (progn (forward-line) (point))
23133 (end (save-excursion
23135 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23136 (1- (line-beginning-position))
23137 (skip-chars-backward " \r\t\n")
23138 (line-end-position)))))
23139 ;; Do not fill comments when at a blank line.
23140 (when (> end begin)
23143 (beginning-of-line)
23144 (looking-at "[ \t]*#")
23145 (let ((comment-prefix (match-string 0)))
23146 (goto-char (match-end 0))
23147 (if (looking-at adaptive-fill-regexp)
23148 (concat comment-prefix (match-string 0))
23149 (concat comment-prefix " "))))))
23151 (fill-region-as-paragraph begin end justify))))))
23153 ;; Ignore every other element.
23156 (defun org-auto-fill-function ()
23157 "Auto-fill function."
23158 ;; Check if auto-filling is meaningful.
23159 (let ((fc (current-fill-column)))
23160 (when (and fc (> (current-column) fc))
23161 (let* ((fill-prefix (org-adaptive-fill-function))
23162 ;; Enforce empty fill prefix, if required. Otherwise, it
23163 ;; will be computed again.
23164 (adaptive-fill-mode (not (equal fill-prefix ""))))
23165 (when fill-prefix (do-auto-fill))))))
23167 (defun org-comment-line-break-function (&optional soft)
23168 "Break line at point and indent, continuing comment if within one.
23169 The inserted newline is marked hard if variable
23170 `use-hard-newlines' is true, unless optional argument SOFT is
23172 (if soft (insert-and-inherit ?\n) (newline 1))
23173 (save-excursion (forward-char -1) (delete-horizontal-space))
23174 (delete-horizontal-space)
23175 (indent-to-left-margin)
23176 (insert-before-markers-and-inherit fill-prefix))
23179 ;;; Fixed Width Areas
23181 (defun org-toggle-fixed-width ()
23182 "Toggle fixed-width markup.
23184 Add or remove fixed-width markup on current line, whenever it
23185 makes sense. Return an error otherwise.
23187 If a region is active and if it contains only fixed-width areas
23188 or blank lines, remove all fixed-width markup in it. If the
23189 region contains anything else, convert all non-fixed-width lines
23190 to fixed-width ones.
23192 Blank lines at the end of the region are ignored unless the
23193 region only contains such lines."
23195 (if (not (org-region-active-p))
23198 ;; Remove fixed width marker only in a fixed-with element.
23200 ;; Add fixed width maker in paragraphs, in blank lines after
23201 ;; elements or at the beginning of a headline or an inlinetask,
23202 ;; and before any one-line elements (e.g., a clock).
23204 (beginning-of-line)
23205 (let* ((element (org-element-at-point))
23206 (type (org-element-type element)))
23208 ((and (eq type 'fixed-width)
23209 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23211 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23212 ((and (memq type '(babel-call clock comment diary-sexp headline
23213 horizontal-rule keyword paragraph
23215 (<= (org-element-property :post-affiliated element) (point)))
23216 (skip-chars-forward " \t")
23218 ((and (org-looking-at-p "[ \t]*$")
23219 (or (eq type 'inlinetask)
23221 (skip-chars-forward " \r\t\n")
23222 (<= (org-element-property :end element) (point)))))
23223 (delete-region (point) (line-end-position))
23226 (t (user-error "Cannot insert a fixed-width line here")))))
23228 (let* ((begin (save-excursion
23229 (goto-char (region-beginning))
23230 (line-beginning-position)))
23233 (goto-char (region-end))
23234 (unless (eolp) (beginning-of-line))
23235 (if (save-excursion (re-search-backward "\\S-" begin t))
23236 (progn (skip-chars-backward " \r\t\n") (point))
23242 (skip-chars-forward " \r\t\n")
23243 (when (eobp) (throw 'not-all-p nil))
23244 (while (< (point) end)
23245 (let ((element (org-element-at-point)))
23246 (if (eq (org-element-type element) 'fixed-width)
23247 (goto-char (org-element-property :end element))
23248 (throw 'not-all-p nil))))
23250 (if all-fixed-width-p
23253 (while (< (point) end)
23254 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23257 (if (= (line-end-position) (match-end 0)) 0 1)))
23259 (let ((min-ind (point-max)))
23260 ;; Find minimum indentation across all lines.
23263 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23266 (while (< (point) end)
23267 (unless (org-looking-at-p "[ \t]*$")
23268 (let ((ind (org-get-indentation)))
23269 (setq min-ind (min min-ind ind))
23270 (when (zerop ind) (throw 'zerop t))))
23272 ;; Loop over all lines and add fixed-width markup everywhere
23273 ;; but in fixed-width lines.
23276 (while (< (point) end)
23278 ((org-at-heading-p)
23281 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23284 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23285 (let* ((element (org-element-at-point))
23286 (element-end (org-element-property :end element)))
23287 (if (eq (org-element-type element) 'fixed-width)
23288 (progn (goto-char element-end)
23289 (skip-chars-backward " \r\t\n")
23291 (let ((limit (min end element-end)))
23292 (while (< (point) limit)
23293 (org-move-to-column min-ind t)
23295 (forward-line))))))
23297 (org-move-to-column min-ind t)
23299 (forward-line)))))))
23300 (set-marker end nil))))
23305 ;; Org comments syntax is quite complex. It requires the entire line
23306 ;; to be just a comment. Also, even with the right syntax at the
23307 ;; beginning of line, some some elements (i.e. verse-block or
23308 ;; example-block) don't accept comments. Usual Emacs comment commands
23309 ;; cannot cope with those requirements. Therefore, Org replaces them.
23311 ;; Org still relies on `comment-dwim', but cannot trust
23312 ;; `comment-only-p'. So, `comment-region-function' and
23313 ;; `uncomment-region-function' both point
23314 ;; to`org-comment-or-uncomment-region'. Eventually,
23315 ;; `org-insert-comment' takes care of insertion of comments at the
23316 ;; beginning of line.
23318 ;; `org-setup-comments-handling' install comments related variables
23319 ;; during `org-mode' initialization.
23321 (defun org-setup-comments-handling ()
23323 (org-set-local 'comment-use-syntax nil)
23324 (org-set-local 'comment-start "# ")
23325 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23326 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23327 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23328 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23330 (defun org-insert-comment ()
23331 "Insert an empty comment above current line.
23332 If the line is empty, insert comment at its beginning. When
23333 point is within a source block, comment according to the related
23335 (if (let ((element (org-element-at-point)))
23336 (and (eq (org-element-type element) 'src-block)
23338 (goto-char (org-element-property :post-affiliated element))
23339 (line-end-position))
23342 (goto-char (org-element-property :end element))
23343 (skip-chars-backward " \r\t\n")
23344 (line-beginning-position))
23346 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23347 (beginning-of-line)
23348 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23353 (defvar comment-empty-lines) ; From newcomment.el.
23354 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23355 "Comment or uncomment each non-blank line in the region.
23356 Uncomment each non-blank line between BEG and END if it only
23357 contains commented lines. Otherwise, comment them. If region is
23358 strictly within a source block, use appropriate comment syntax."
23359 (if (let ((element (org-element-at-point)))
23360 (and (eq (org-element-type element) 'src-block)
23362 (goto-char (org-element-property :post-affiliated element))
23363 (line-end-position))
23365 (>= (save-excursion
23366 (goto-char (org-element-property :end element))
23367 (skip-chars-backward " \r\t\n")
23368 (line-beginning-position))
23370 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23373 (narrow-to-region (save-excursion (goto-char beg)
23374 (skip-chars-forward " \r\t\n" end)
23375 (line-beginning-position))
23376 (save-excursion (goto-char end)
23377 (skip-chars-backward " \r\t\n" beg)
23378 (line-end-position)))
23380 ;; UNCOMMENTP is non-nil when every non blank line between
23381 ;; BEG and END is a comment.
23383 (goto-char (point-min))
23384 (while (and (not (eobp))
23385 (let ((element (org-element-at-point)))
23386 (and (eq (org-element-type element) 'comment)
23387 (goto-char (min (point-max)
23388 (org-element-property
23389 :end element)))))))
23392 ;; Only blank lines and comments in region: uncomment it.
23394 (goto-char (point-min))
23395 (while (not (eobp))
23396 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23397 (replace-match "" nil nil nil 1))
23399 ;; Comment each line in region.
23400 (let ((min-indent (point-max)))
23401 ;; First find the minimum indentation across all lines.
23403 (goto-char (point-min))
23404 (while (and (not (eobp)) (not (zerop min-indent)))
23405 (unless (looking-at "[ \t]*$")
23406 (setq min-indent (min min-indent (current-indentation))))
23408 ;; Then loop over all lines.
23410 (goto-char (point-min))
23411 (while (not (eobp))
23412 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23413 ;; Don't get fooled by invisible text (e.g. link path)
23414 ;; when moving to column MIN-INDENT.
23415 (let ((buffer-invisibility-spec nil))
23416 (org-move-to-column min-indent t))
23417 (insert comment-start))
23418 (forward-line)))))))))
23420 (defun org-comment-dwim (arg)
23421 "Call `comment-dwim' within a source edit buffer if needed."
23423 (if (org-in-src-block-p)
23424 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23425 (call-interactively 'comment-dwim)))
23430 ;; This section contains tools to operate on timestamp objects, as
23431 ;; returned by, e.g. `org-element-context'.
23433 (defun org-timestamp-has-time-p (timestamp)
23434 "Non-nil when TIMESTAMP has a time specified."
23435 (org-element-property :hour-start timestamp))
23437 (defun org-timestamp-format (timestamp format &optional end utc)
23438 "Format a TIMESTAMP element into a string.
23440 FORMAT is a format specifier to be passed to
23441 `format-time-string'.
23443 When optional argument END is non-nil, use end of date-range or
23444 time-range, if possible.
23446 When optional argument UTC is non-nil, time will be expressed as
23448 (format-time-string
23450 (apply 'encode-time
23453 (lambda (prop) (or (org-element-property prop timestamp) 0))
23454 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23455 '(:minute-start :hour-start :day-start :month-start
23459 (defun org-timestamp-split-range (timestamp &optional end)
23460 "Extract a timestamp object from a date or time range.
23462 TIMESTAMP is a timestamp object. END, when non-nil, means extract
23463 the end of the range. Otherwise, extract its start.
23465 Return a new timestamp object sharing the same parent as
23467 (let ((type (org-element-property :type timestamp)))
23468 (if (memq type '(active inactive diary)) timestamp
23469 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
23471 (org-element-put-property
23472 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23473 ;; Copy start properties over end properties if END is
23474 ;; non-nil. Otherwise, copy end properties over `start' ones.
23475 (let ((p-alist '((:minute-start . :minute-end)
23476 (:hour-start . :hour-end)
23477 (:day-start . :day-end)
23478 (:month-start . :month-end)
23479 (:year-start . :year-end))))
23480 (dolist (p-cell p-alist)
23481 (org-element-put-property
23483 (funcall (if end 'car 'cdr) p-cell)
23484 (org-element-property
23485 (funcall (if end 'cdr 'car) p-cell) split-ts)))
23486 ;; Eventually refresh `:raw-value'.
23487 (org-element-put-property split-ts :raw-value nil)
23488 (org-element-put-property
23489 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23491 (defun org-timestamp-translate (timestamp &optional boundary)
23492 "Translate TIMESTAMP object to custom format.
23494 Format string is defined in `org-time-stamp-custom-formats',
23497 When optional argument BOUNDARY is non-nil, it is either the
23498 symbol `start' or `end'. In this case, only translate the
23499 starting or ending part of TIMESTAMP if it is a date or time
23500 range. Otherwise, translate both parts.
23502 Return timestamp as-is if `org-display-custom-times' is nil or if
23503 it has a `diary' type."
23504 (let ((type (org-element-property :type timestamp)))
23505 (if (or (not org-display-custom-times) (eq type 'diary))
23506 (org-element-interpret-data timestamp)
23507 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23508 org-time-stamp-custom-formats)))
23509 (if (and (not boundary) (memq type '(active-range inactive-range)))
23510 (concat (org-timestamp-format timestamp fmt)
23512 (org-timestamp-format timestamp fmt t))
23513 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23519 (defun org-reftex-citation ()
23520 "Use reftex-citation to insert a citation into the buffer.
23521 This looks for a line like
23523 #+BIBLIOGRAPHY: foo plain option:-d
23525 and derives from it that foo.bib is the bibliography file relevant
23526 for this document. It then installs the necessary environment for RefTeX
23527 to work in this buffer and calls `reftex-citation' to insert a citation
23530 Export of such citations to both LaTeX and HTML is handled by the contributed
23531 package ox-bibtex by Taru Karttunen."
23533 (let ((reftex-docstruct-symbol 'rds)
23534 (reftex-cite-format "\\cite{%l}")
23539 (let ((case-fold-search t)
23540 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23541 (if (not (save-excursion
23542 (or (re-search-forward re nil t)
23543 (re-search-backward re nil t))))
23544 (user-error "No bibliography defined in file")
23545 (setq bib (concat (match-string 1) ".bib")
23546 rds (list (list 'bib bib)))))))
23547 (call-interactively 'reftex-citation)))
23549 ;;;; Functions extending outline functionality
23551 (defun org-beginning-of-line (&optional arg)
23552 "Go to the beginning of the current line. If that is invisible, continue
23553 to a visible line beginning. This makes the function of C-a more intuitive.
23554 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23555 first attempt, and only move to after the tags when the cursor is already
23556 beyond the end of the headline."
23558 (let ((pos (point))
23559 (special (if (consp org-special-ctrl-a/e)
23560 (car org-special-ctrl-a/e)
23561 org-special-ctrl-a/e))
23562 deactivate-mark refpos)
23563 (if (org-bound-and-true-p visual-line-mode)
23564 (beginning-of-visual-line 1)
23565 (beginning-of-line 1))
23566 (if (and arg (fboundp 'move-beginning-of-line))
23567 (call-interactively 'move-beginning-of-line)
23571 (if (org-truely-invisible-p)
23572 (while (and (not (bobp)) (org-truely-invisible-p))
23574 (beginning-of-line 1))
23575 (forward-char 1))))
23578 ((and (looking-at org-complex-heading-regexp)
23579 (= (char-after (match-end 1)) ?\ ))
23580 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23584 (cond ((> pos refpos) refpos)
23585 ((= pos (point)) refpos)
23587 (cond ((> pos (point)) (point))
23588 ((not (eq last-command this-command)) (point))
23591 ;; Being at an item and not looking at an the item means point
23592 ;; was previously moved to beginning of a visual line, which
23593 ;; doesn't contain the item. Therefore, do nothing special,
23595 (when (looking-at org-list-full-item-re)
23596 ;; Set special position at first white space character after
23597 ;; bullet, and check-box, if any.
23598 (let ((after-bullet
23599 (let ((box (match-end 3)))
23600 (if (not box) (match-end 1)
23601 (let ((after (char-after box)))
23602 (if (and after (= after ? )) (1+ box) box))))))
23603 ;; Special case: Move point to special position when
23604 ;; currently after it or at beginning of line.
23606 (when (or (> pos after-bullet) (= (point) pos))
23607 (goto-char after-bullet))
23608 ;; Reversed case: Move point to special position when
23609 ;; point was already at beginning of line and command is
23611 (when (and (= (point) pos) (eq last-command this-command))
23612 (goto-char after-bullet))))))))
23614 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23615 (setq disable-point-adjustment
23616 (or (not (invisible-p (point)))
23617 (not (invisible-p (max (point-min) (1- (point))))))))
23619 (defun org-end-of-line (&optional arg)
23620 "Go to the end of the line.
23621 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23622 tags on the first attempt, and only move to after the tags when
23623 the cursor is already beyond the end of the headline."
23625 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23626 org-special-ctrl-a/e))
23627 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23628 'end-of-visual-line)
23629 ((fboundp 'move-end-of-line) 'move-end-of-line)
23632 (if (or (not special) arg) (call-interactively move-fun)
23633 (let* ((element (save-excursion (beginning-of-line)
23634 (org-element-at-point)))
23635 (type (org-element-type element)))
23637 ((memq type '(headline inlinetask))
23638 (let ((pos (point)))
23639 (beginning-of-line 1)
23640 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23642 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23643 (goto-char (match-beginning 1))
23644 (goto-char (match-end 0)))
23645 (if (or (< pos (match-end 0))
23646 (not (eq this-command last-command)))
23647 (goto-char (match-end 0))
23648 (goto-char (match-beginning 1))))
23649 (call-interactively move-fun))))
23650 ((outline-invisible-p (line-end-position))
23651 ;; If element is hidden, `move-end-of-line' would put point
23652 ;; after it. Use `end-of-line' to stay on current line.
23653 (call-interactively 'end-of-line))
23654 (t (call-interactively move-fun)))))
23655 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23656 (setq disable-point-adjustment
23657 (or (not (invisible-p (point)))
23658 (not (invisible-p (max (point-min) (1- (point))))))))
23660 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23661 (define-key org-mode-map "\C-e" 'org-end-of-line)
23663 (defun org-backward-sentence (&optional arg)
23664 "Go to beginning of sentence, or beginning of table field.
23665 This will call `backward-sentence' or `org-table-beginning-of-field',
23666 depending on context."
23669 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
23670 (t (call-interactively 'backward-sentence))))
23672 (defun org-forward-sentence (&optional arg)
23673 "Go to end of sentence, or end of table field.
23674 This will call `forward-sentence' or `org-table-end-of-field',
23675 depending on context."
23678 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
23679 (t (call-interactively 'forward-sentence))))
23681 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23682 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23684 (defun org-kill-line (&optional arg)
23685 "Kill line, to tags or end of line."
23688 ((or (not org-special-ctrl-k)
23690 (not (org-at-heading-p)))
23691 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23692 org-ctrl-k-protect-subtree)
23693 (if (or (eq org-ctrl-k-protect-subtree 'error)
23694 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23695 (user-error "C-k aborted as it would kill a hidden subtree")))
23696 (call-interactively
23697 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23698 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23699 (kill-region (point) (match-beginning 1))
23700 (org-set-tags nil t))
23701 (t (kill-region (point) (point-at-eol)))))
23703 (define-key org-mode-map "\C-k" 'org-kill-line)
23705 (defun org-yank (&optional arg)
23706 "Yank. If the kill is a subtree, treat it specially.
23707 This command will look at the current kill and check if is a single
23708 subtree, or a series of subtrees[1]. If it passes the test, and if the
23709 cursor is at the beginning of a line or after the stars of a currently
23710 empty headline, then the yank is handled specially. How exactly depends
23711 on the value of the following variables, both set by default.
23713 `org-yank-folded-subtrees'
23714 When set, the subtree(s) will be folded after insertion, but only
23715 if doing so would now swallow text after the yanked text.
23717 `org-yank-adjusted-subtrees'
23718 When set, the subtree will be promoted or demoted in order to
23719 fit into the local outline tree structure, which means that the
23720 level will be adjusted so that it becomes the smaller one of the
23721 two *visible* surrounding headings.
23723 Any prefix to this command will cause `yank' to be called directly with
23724 no special treatment. In particular, a simple \\[universal-argument] prefix \
23726 plainly yank the text as it is.
23728 \[1] The test checks if the first non-white line is a heading
23729 and if there are no other headings with fewer stars."
23731 (org-yank-generic 'yank arg))
23733 (defun org-yank-generic (command arg)
23734 "Perform some yank-like command.
23736 This function implements the behavior described in the `org-yank'
23737 documentation. However, it has been generalized to work for any
23738 interactive command with similar behavior."
23740 ;; pretend to be command COMMAND
23741 (setq this-command command)
23744 (call-interactively command)
23746 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23747 (and (org-kill-is-subtree-p)
23749 (and (looking-at "[ \t]*$")
23752 (buffer-substring (point-at-bol) (point)))))))
23755 ((and subtreep org-yank-folded-subtrees)
23756 (let ((beg (point))
23758 (if (and subtreep org-yank-adjusted-subtrees)
23759 (org-paste-subtree nil nil 'for-yank)
23760 (call-interactively command))
23764 (when (and (bolp) subtreep
23765 (not (setq swallowp
23766 (org-yank-folding-would-swallow-text beg end))))
23767 (org-with-limited-levels
23768 (or (looking-at org-outline-regexp)
23769 (re-search-forward org-outline-regexp-bol end t))
23770 (while (and (< (point) end) (looking-at org-outline-regexp))
23772 (org-cycle-show-empty-lines 'folded)
23773 (condition-case nil
23774 (outline-forward-same-level 1)
23775 (error (goto-char end))))))
23778 "Inserted text not folded because that would swallow text"))
23781 (skip-chars-forward " \t\n\r")
23782 (beginning-of-line 1)
23783 (push-mark beg 'nomsg)))
23784 ((and subtreep org-yank-adjusted-subtrees)
23785 (let ((beg (point-at-bol)))
23786 (org-paste-subtree nil nil 'for-yank)
23787 (push-mark beg 'nomsg)))
23789 (call-interactively command))))))
23791 (defun org-yank-folding-would-swallow-text (beg end)
23792 "Would hide-subtree at BEG swallow any text after END?"
23794 (org-with-limited-levels
23797 (when (or (looking-at org-outline-regexp)
23798 (re-search-forward org-outline-regexp-bol end t))
23799 (setq level (org-outline-level)))
23801 (skip-chars-forward " \t\r\n\v\f")
23803 (and (bolp) (looking-at org-outline-regexp)
23804 (<= (org-outline-level) level)))
23805 nil ; Nothing would be swallowed
23806 t))))) ; something would swallow
23808 (define-key org-mode-map "\C-y" 'org-yank)
23810 (defun org-truely-invisible-p ()
23811 "Check if point is at a character currently not visible.
23812 This version does not only check the character property, but also
23814 ;; Early versions of noutline don't have `outline-invisible-p'.
23815 (if (org-bound-and-true-p visible-mode)
23817 (outline-invisible-p)))
23819 (defun org-invisible-p2 ()
23820 "Check if point is at a character currently not visible."
23822 (if (and (eolp) (not (bobp))) (backward-char 1))
23823 ;; Early versions of noutline don't have `outline-invisible-p'.
23824 (outline-invisible-p)))
23826 (defun org-back-to-heading (&optional invisible-ok)
23827 "Call `outline-back-to-heading', but provide a better error message."
23828 (condition-case nil
23829 (outline-back-to-heading invisible-ok)
23830 (error (error "Before first headline at position %d in buffer %s"
23831 (point) (current-buffer)))))
23833 (defun org-before-first-heading-p ()
23834 "Before first heading?"
23837 (null (re-search-backward org-outline-regexp-bol nil t))))
23839 (defun org-at-heading-p (&optional ignored)
23840 (outline-on-heading-p t))
23841 ;; Compatibility alias with Org versions < 7.8.03
23842 (defalias 'org-on-heading-p 'org-at-heading-p)
23844 (defun org-in-commented-heading-p (&optional no-inheritance)
23845 "Non-nil if point is under a commented heading.
23846 This function also checks ancestors of the current headline,
23847 unless optional argument NO-INHERITANCE is non-nil."
23849 ((org-before-first-heading-p) nil)
23850 ((let ((headline (nth 4 (org-heading-components))))
23852 (let ((case-fold-search nil))
23853 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
23855 (no-inheritance nil)
23857 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
23859 (defun org-at-comment-p nil
23860 "Is cursor in a commented line?"
23863 (beginning-of-line)
23864 (looking-at "^[ \t]*# "))))
23866 (defun org-at-drawer-p nil
23867 "Is cursor at a drawer keyword?"
23869 (move-beginning-of-line 1)
23870 (looking-at org-drawer-regexp)))
23872 (defun org-at-block-p nil
23873 "Is cursor at a block keyword?"
23875 (move-beginning-of-line 1)
23876 (looking-at org-block-regexp)))
23878 (defun org-point-at-end-of-empty-headline ()
23879 "If point is at the end of an empty headline, return t, else nil.
23880 If the heading only contains a TODO keyword, it is still still considered
23882 (and (looking-at "[ \t]*$")
23883 (when org-todo-line-regexp
23885 (beginning-of-line 1)
23886 (let ((case-fold-search nil))
23887 (looking-at org-todo-line-regexp)
23888 (string= (match-string 3) ""))))))
23890 (defun org-at-heading-or-item-p ()
23891 (or (org-at-heading-p) (org-at-item-p)))
23893 (defun org-at-target-p ()
23894 (or (org-in-regexp org-radio-target-regexp)
23895 (org-in-regexp org-target-regexp)))
23896 ;; Compatibility alias with Org versions < 7.8.03
23897 (defalias 'org-on-target-p 'org-at-target-p)
23899 (defun org-up-heading-all (arg)
23900 "Move to the heading line of which the present line is a subheading.
23901 This function considers both visible and invisible heading lines.
23902 With argument, move up ARG levels."
23903 (if (fboundp 'outline-up-heading-all)
23904 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23905 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23907 (defun org-up-heading-safe ()
23908 "Move to the heading line of which the present line is a subheading.
23909 This version will not throw an error. It will return the level of the
23910 headline found, or nil if no higher level is found.
23912 Also, this function will be a lot faster than `outline-up-heading',
23913 because it relies on stars being the outline starters. This can really
23914 make a significant difference in outlines with very many siblings."
23915 (when (ignore-errors (org-back-to-heading t))
23916 (let ((level-up (1- (funcall outline-level))))
23917 (and (> level-up 0)
23918 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
23919 (funcall outline-level)))))
23921 (defun org-first-sibling-p ()
23922 "Is this heading the first child of its parents?"
23924 (let ((re org-outline-regexp-bol)
23926 (unless (org-at-heading-p t)
23927 (user-error "Not at a heading"))
23928 (setq level (funcall outline-level))
23930 (if (not (re-search-backward re nil t))
23932 (setq l (funcall outline-level))
23935 (defun org-goto-sibling (&optional previous)
23936 "Goto the next sibling, even if it is invisible.
23937 When PREVIOUS is set, go to the previous sibling instead. Returns t
23938 when a sibling was found. When none is found, return nil and don't
23940 (let ((fun (if previous 're-search-backward 're-search-forward))
23942 (re org-outline-regexp-bol)
23944 (when (ignore-errors (org-back-to-heading t))
23945 (setq level (funcall outline-level))
23947 (or previous (forward-char 1))
23948 (while (funcall fun re nil t)
23949 (setq l (funcall outline-level))
23950 (when (< l level) (goto-char pos) (throw 'exit nil))
23951 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23955 (defun org-show-siblings ()
23956 "Show all siblings of the current headline."
23958 (while (org-goto-sibling) (org-flag-heading nil)))
23960 (while (org-goto-sibling 'previous)
23961 (org-flag-heading nil))))
23963 (defun org-goto-first-child ()
23964 "Goto the first child, even if it is invisible.
23965 Return t when a child was found. Otherwise don't move point and
23967 (let (level (pos (point)) (re org-outline-regexp-bol))
23968 (when (ignore-errors (org-back-to-heading t))
23969 (setq level (outline-level))
23971 (if (and (re-search-forward re nil t) (> (outline-level) level))
23972 (progn (goto-char (match-beginning 0)) t)
23973 (goto-char pos) nil))))
23975 (defun org-show-hidden-entry ()
23976 "Show an entry where even the heading is hidden."
23980 (defun org-flag-heading (flag &optional entry)
23981 "Flag the current heading. FLAG non-nil means make invisible.
23982 When ENTRY is non-nil, show the entire entry."
23984 (org-back-to-heading t)
23985 ;; Check if we should show the entire entry
23990 (and (outline-next-heading)
23991 (org-flag-heading nil))))
23992 (outline-flag-region (max (point-min) (1- (point)))
23993 (save-excursion (outline-end-of-heading) (point))
23996 (defun org-get-next-sibling ()
23997 "Move to next heading of the same level, and return point.
23998 If there is no such heading, return nil.
23999 This is like outline-next-sibling, but invisible headings are ok."
24000 (let ((level (funcall outline-level)))
24001 (outline-next-heading)
24002 (while (and (not (eobp)) (> (funcall outline-level) level))
24003 (outline-next-heading))
24004 (if (or (eobp) (< (funcall outline-level) level))
24008 (defun org-get-last-sibling ()
24009 "Move to previous heading of the same level, and return point.
24010 If there is no such heading, return nil."
24011 (let ((opoint (point))
24012 (level (funcall outline-level)))
24013 (outline-previous-heading)
24014 (when (and (/= (point) opoint) (outline-on-heading-p t))
24015 (while (and (> (funcall outline-level) level)
24017 (outline-previous-heading))
24018 (if (< (funcall outline-level) level)
24022 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24023 "Goto to the end of a subtree."
24024 ;; This contains an exact copy of the original function, but it uses
24025 ;; `org-back-to-heading', to make it work also in invisible
24026 ;; trees. And is uses an invisible-ok argument.
24027 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24028 ;; Furthermore, when used inside Org, finding the end of a large subtree
24029 ;; with many children and grandchildren etc, this can be much faster
24030 ;; than the outline version.
24031 (org-back-to-heading invisible-ok)
24033 (level (funcall outline-level)))
24034 (if (and (derived-mode-p 'org-mode) (< level 1000))
24035 ;; A true heading (not a plain list item), in Org-mode
24036 ;; This means we can easily find the end by looking
24037 ;; only for the right number of stars. Using a regexp to do
24038 ;; this is so much faster than using a Lisp loop.
24039 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24041 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24042 ;; something else, do it the slow way
24043 (while (and (not (eobp))
24044 (or first (> (funcall outline-level) level)))
24046 (outline-next-heading)))
24048 (if (memq (preceding-char) '(?\n ?\^M))
24050 ;; Go to end of line before heading
24052 (if (memq (preceding-char) '(?\n ?\^M))
24053 ;; leave blank line before heading
24054 (forward-char -1))))))
24057 (defun org-end-of-meta-data-and-drawers ()
24058 "Jump to the first text after meta data and drawers in the current entry.
24059 This will move over empty lines, lines with planning time stamps,
24060 clocking lines, and drawers."
24061 (org-back-to-heading t)
24062 (let ((end (save-excursion (outline-next-heading) (point)))
24063 (re (concat "\\(" org-drawer-regexp "\\)"
24064 "\\|" "[ \t]*" org-keyword-time-regexp)))
24066 (while (re-search-forward re end t)
24067 (if (not (match-end 1))
24068 ;; empty or planning line
24070 ;; a drawer, find the end
24071 (re-search-forward "^[ \t]*:END:" end 'move)
24073 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
24076 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24077 "Move forward to the ARG'th subheading at same level as this one.
24078 Stop at the first and last subheadings of a superior heading.
24079 Normally this only looks at visible headings, but when INVISIBLE-OK is
24080 non-nil it will also look at invisible ones."
24082 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24083 (if (and arg (< arg 0))
24084 (goto-char (point-min))
24085 (outline-next-heading))
24087 (let ((level (- (match-end 0) (match-beginning 0) 1))
24088 (f (if (and arg (< arg 0))
24089 're-search-backward
24090 're-search-forward))
24091 (count (if arg (abs arg) 1))
24093 (while (and (prog1 (> count 0)
24094 (forward-char (if (and arg (< arg 0)) -1 1)))
24095 (funcall f org-outline-regexp-bol nil 'move))
24096 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24097 (cond ((< l level) (setq count 0))
24101 (goto-char (line-beginning-position))
24102 (not (outline-invisible-p)))))
24103 (setq count (1- count))
24105 (setq result (point)))))))
24106 (goto-char result))
24107 (beginning-of-line 1)))
24109 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24110 "Move backward to the ARG'th subheading at same level as this one.
24111 Stop at the first and last subheadings of a superior heading."
24113 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24115 (defun org-next-block (arg &optional backward block-regexp)
24116 "Jump to the next block.
24117 With a prefix argument ARG, jump forward ARG many source blocks.
24118 When BACKWARD is non-nil, jump to the previous block.
24119 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24121 (let ((re (or block-regexp org-block-regexp))
24122 (re-search-fn (or (and backward 're-search-backward)
24123 're-search-forward)))
24124 (if (looking-at re) (forward-char 1))
24125 (condition-case nil
24126 (funcall re-search-fn re nil nil arg)
24127 (error (user-error "No %s code blocks"
24128 (if backward "previous" "further" ))))
24129 (goto-char (match-beginning 0)) (org-show-context)))
24131 (defun org-previous-block (arg &optional block-regexp)
24132 "Jump to the previous block.
24133 With a prefix argument ARG, jump backward ARG many source blocks.
24134 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24136 (org-next-block arg t block-regexp))
24138 (defun org-forward-paragraph ()
24139 "Move forward to beginning of next paragraph or equivalent.
24141 The function moves point to the beginning of the next visible
24142 structural element, which can be a paragraph, a table, a list
24143 item, etc. It also provides some special moves for convenience:
24145 - On an affiliated keyword, jump to the beginning of the
24147 - On an item or a footnote definition, move to the second
24148 element inside, if any.
24149 - On a table or a property drawer, jump after it.
24150 - On a verse or source block, stop after blank lines."
24152 (when (eobp) (user-error "Cannot move further down"))
24153 (let* ((deactivate-mark nil)
24154 (element (org-element-at-point))
24155 (type (org-element-type element))
24156 (post-affiliated (org-element-property :post-affiliated element))
24157 (contents-begin (org-element-property :contents-begin element))
24158 (contents-end (org-element-property :contents-end element))
24159 (end (let ((end (org-element-property :end element)) (parent element))
24160 (while (and (setq parent (org-element-property :parent parent))
24161 (= (org-element-property :contents-end parent) end))
24162 (setq end (org-element-property :end parent)))
24164 (cond ((not element)
24165 (skip-chars-forward " \r\t\n")
24166 (or (eobp) (beginning-of-line)))
24167 ;; On affiliated keywords, move to element's beginning.
24168 ((< (point) post-affiliated)
24169 (goto-char post-affiliated))
24170 ;; At a table row, move to the end of the table. Similarly,
24171 ;; at a node property, move to the end of the property
24173 ((memq type '(node-property table-row))
24174 (goto-char (org-element-property
24175 :end (org-element-property :parent element))))
24176 ((memq type '(property-drawer table)) (goto-char end))
24177 ;; Consider blank lines as separators in verse and source
24178 ;; blocks to ease editing.
24179 ((memq type '(src-block verse-block))
24180 (when (eq type 'src-block)
24182 (save-excursion (goto-char end)
24183 (skip-chars-backward " \r\t\n")
24184 (line-beginning-position))))
24185 (beginning-of-line)
24186 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24187 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24189 (skip-chars-forward " \r\t\n")
24190 (if (= (point) contents-end) (goto-char end)
24191 (beginning-of-line))))
24192 ;; With no contents, just skip element.
24193 ((not contents-begin) (goto-char end))
24194 ;; If contents are invisible, skip the element altogether.
24195 ((outline-invisible-p (line-end-position))
24198 (org-with-limited-levels (outline-next-visible-heading 1)))
24199 ;; At a plain list, make sure we move to the next item
24200 ;; instead of skipping the whole list.
24201 (plain-list (forward-char)
24202 (org-forward-paragraph))
24203 (otherwise (goto-char end))))
24204 ((>= (point) contents-end) (goto-char end))
24205 ((>= (point) contents-begin)
24206 ;; This can only happen on paragraphs and plain lists.
24208 (paragraph (goto-char end))
24209 ;; At a plain list, try to move to second element in
24210 ;; first item, if possible.
24211 (plain-list (end-of-line)
24212 (org-forward-paragraph))))
24213 ;; When contents start on the middle of a line (e.g. in
24214 ;; items and footnote definitions), try to reach first
24215 ;; element starting after current line.
24216 ((> (line-end-position) contents-begin)
24218 (org-forward-paragraph))
24219 (t (goto-char contents-begin)))))
24221 (defun org-backward-paragraph ()
24222 "Move backward to start of previous paragraph or equivalent.
24224 The function moves point to the beginning of the current
24225 structural element, which can be a paragraph, a table, a list
24226 item, etc., or to the beginning of the previous visible one if
24227 point is already there. It also provides some special moves for
24230 - On an affiliated keyword, jump to the first one.
24231 - On a table or a property drawer, move to its beginning.
24232 - On a verse or source block, stop before blank lines."
24234 (when (bobp) (user-error "Cannot move further up"))
24235 (let* ((deactivate-mark nil)
24236 (element (org-element-at-point))
24237 (type (org-element-type element))
24238 (contents-begin (org-element-property :contents-begin element))
24239 (contents-end (org-element-property :contents-end element))
24240 (post-affiliated (org-element-property :post-affiliated element))
24241 (begin (org-element-property :begin element)))
24243 ((not element) (goto-char (point-min)))
24246 (org-backward-paragraph))
24247 ((<= (point) post-affiliated) (goto-char begin))
24248 ((memq type '(node-property table-row))
24249 (goto-char (org-element-property
24250 :post-affiliated (org-element-property :parent element))))
24251 ((memq type '(property-drawer table)) (goto-char begin))
24252 ((memq type '(src-block verse-block))
24253 (when (eq type 'src-block)
24254 (setq contents-begin
24255 (save-excursion (goto-char begin) (forward-line) (point))))
24256 (if (= (point) contents-begin) (goto-char post-affiliated)
24257 ;; Inside a verse block, see blank lines as paragraph
24259 (let ((origin (point)))
24260 (skip-chars-backward " \r\t\n" contents-begin)
24261 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24262 (skip-chars-forward " \r\t\n" origin)
24263 (if (= (point) origin) (goto-char contents-begin)
24264 (beginning-of-line))))))
24265 ((not contents-begin) (goto-char (or post-affiliated begin)))
24266 ((eq type 'paragraph)
24267 (goto-char contents-begin)
24268 ;; When at first paragraph in an item or a footnote definition,
24269 ;; move directly to beginning of line.
24270 (let ((parent-contents
24271 (org-element-property
24272 :contents-begin (org-element-property :parent element))))
24273 (when (and parent-contents (= parent-contents contents-begin))
24274 (beginning-of-line))))
24275 ;; At the end of a greater element, move to the beginning of the
24276 ;; last element within.
24277 ((>= (point) contents-end)
24278 (goto-char (1- contents-end))
24279 (org-backward-paragraph))
24280 (t (goto-char (or post-affiliated begin))))
24281 ;; Ensure we never leave point invisible.
24282 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24284 (defun org-forward-element ()
24285 "Move forward by one element.
24286 Move to the next element at the same level, when possible."
24288 (cond ((eobp) (user-error "Cannot move further down"))
24289 ((org-with-limited-levels (org-at-heading-p))
24290 (let ((origin (point)))
24291 (goto-char (org-end-of-subtree nil t))
24292 (unless (org-with-limited-levels (org-at-heading-p))
24294 (user-error "Cannot move further down"))))
24296 (let* ((elem (org-element-at-point))
24297 (end (org-element-property :end elem))
24298 (parent (org-element-property :parent elem)))
24299 (cond ((and parent (= (org-element-property :contents-end parent) end))
24300 (goto-char (org-element-property :end parent)))
24301 ((integer-or-marker-p end) (goto-char end))
24302 (t (message "No element at point")))))))
24304 (defun org-backward-element ()
24305 "Move backward by one element.
24306 Move to the previous element at the same level, when possible."
24308 (cond ((bobp) (user-error "Cannot move further up"))
24309 ((org-with-limited-levels (org-at-heading-p))
24310 ;; At a headline, move to the previous one, if any, or stay
24312 (let ((origin (point)))
24313 (org-with-limited-levels (org-backward-heading-same-level 1))
24314 ;; When current headline has no sibling above, move to its
24316 (when (= (point) origin)
24317 (or (org-with-limited-levels (org-up-heading-safe))
24318 (progn (goto-char origin)
24319 (user-error "Cannot move further up"))))))
24321 (let* ((elem (org-element-at-point))
24322 (beg (org-element-property :begin elem)))
24324 ;; Move to beginning of current element if point isn't
24326 ((null beg) (message "No element at point"))
24327 ((/= (point) beg) (goto-char beg))
24329 (skip-chars-backward " \r\t\n")
24331 (let ((prev (org-element-at-point)))
24332 (goto-char (org-element-property :begin prev))
24333 (while (and (setq prev (org-element-property :parent prev))
24334 (<= (org-element-property :end prev) beg))
24335 (goto-char (org-element-property :begin prev)))))))))))
24337 (defun org-up-element ()
24338 "Move to upper element."
24340 (if (org-with-limited-levels (org-at-heading-p))
24341 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24342 (let* ((elem (org-element-at-point))
24343 (parent (org-element-property :parent elem)))
24344 (if parent (goto-char (org-element-property :begin parent))
24345 (if (org-with-limited-levels (org-before-first-heading-p))
24346 (user-error "No surrounding element")
24347 (org-with-limited-levels (org-back-to-heading)))))))
24349 (defvar org-element-greater-elements)
24350 (defun org-down-element ()
24351 "Move to inner element."
24353 (let ((element (org-element-at-point)))
24355 ((memq (org-element-type element) '(plain-list table))
24356 (goto-char (org-element-property :contents-begin element))
24358 ((memq (org-element-type element) org-element-greater-elements)
24359 ;; If contents are hidden, first disclose them.
24360 (when (outline-invisible-p (line-end-position)) (org-cycle))
24361 (goto-char (or (org-element-property :contents-begin element)
24362 (user-error "No content for this element"))))
24363 (t (user-error "No inner element")))))
24365 (defun org-drag-element-backward ()
24366 "Move backward element at point."
24368 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24369 (let* ((elem (org-element-at-point))
24372 (goto-char (org-element-property :begin elem))
24373 (skip-chars-backward " \r\t\n")
24375 (let* ((beg (org-element-property :begin elem))
24376 (prev (org-element-at-point))
24378 (while (and (setq up (org-element-property :parent up))
24379 (<= (org-element-property :end up) beg))
24382 ;; Error out if no previous element or previous element is
24383 ;; a parent of the current one.
24384 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24385 (user-error "Cannot drag element backward")
24386 (let ((pos (point)))
24387 (org-element-swap-A-B prev-elem elem)
24388 (goto-char (+ (org-element-property :begin prev-elem)
24389 (- pos (org-element-property :begin elem)))))))))
24391 (defun org-drag-element-forward ()
24392 "Move forward element at point."
24394 (let* ((pos (point))
24395 (elem (org-element-at-point)))
24396 (when (= (point-max) (org-element-property :end elem))
24397 (user-error "Cannot drag element forward"))
24398 (goto-char (org-element-property :end elem))
24399 (let ((next-elem (org-element-at-point)))
24400 (when (or (org-element-nested-p elem next-elem)
24401 (and (eq (org-element-type next-elem) 'headline)
24402 (not (eq (org-element-type elem) 'headline))))
24404 (user-error "Cannot drag element forward"))
24405 ;; Compute new position of point: it's shifted by NEXT-ELEM
24406 ;; body's length (without final blanks) and by the length of
24407 ;; blanks between ELEM and NEXT-ELEM.
24408 (let ((size-next (- (save-excursion
24409 (goto-char (org-element-property :end next-elem))
24410 (skip-chars-backward " \r\t\n")
24412 ;; Small correction if buffer doesn't end
24413 ;; with a newline character.
24414 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24415 (org-element-property :begin next-elem)))
24416 (size-blank (- (org-element-property :end elem)
24418 (goto-char (org-element-property :end elem))
24419 (skip-chars-backward " \r\t\n")
24422 (org-element-swap-A-B elem next-elem)
24423 (goto-char (+ pos size-next size-blank))))))
24425 (defun org-drag-line-forward (arg)
24426 "Drag the line at point ARG lines forward."
24428 (dotimes (n (abs arg))
24429 (let ((c (current-column)))
24432 (beginning-of-line 2)
24433 (transpose-lines 1)
24434 (beginning-of-line 0))
24435 (transpose-lines 1)
24436 (beginning-of-line -1))
24437 (org-move-to-column c))))
24439 (defun org-drag-line-backward (arg)
24440 "Drag the line at point ARG lines backward."
24442 (org-drag-line-forward (- arg)))
24444 (defun org-mark-element ()
24445 "Put point at beginning of this element, mark at end.
24447 Interactively, if this command is repeated or (in Transient Mark
24448 mode) if the mark is active, it marks the next element after the
24449 ones already marked."
24451 (let (deactivate-mark)
24452 (if (and (org-called-interactively-p 'any)
24453 (or (and (eq last-command this-command) (mark t))
24454 (and transient-mark-mode mark-active)))
24458 (goto-char (org-element-property :end (org-element-at-point)))))
24459 (let ((element (org-element-at-point)))
24461 (push-mark (org-element-property :end element) t t)
24462 (goto-char (org-element-property :begin element))))))
24464 (defun org-narrow-to-element ()
24465 "Narrow buffer to current element."
24467 (let ((elem (org-element-at-point)))
24469 ((eq (car elem) 'headline)
24471 (org-element-property :begin elem)
24472 (org-element-property :end elem)))
24473 ((memq (car elem) org-element-greater-elements)
24475 (org-element-property :contents-begin elem)
24476 (org-element-property :contents-end elem)))
24479 (org-element-property :begin elem)
24480 (org-element-property :end elem))))))
24482 (defun org-transpose-element ()
24483 "Transpose current and previous elements, keeping blank lines between.
24484 Point is moved after both elements."
24486 (org-skip-whitespace)
24487 (let ((end (org-element-property :end (org-element-at-point))))
24488 (org-drag-element-backward)
24491 (defun org-unindent-buffer ()
24492 "Un-indent the visible part of the buffer.
24493 Relative indentation (between items, inside blocks, etc.) isn't
24496 (unless (eq major-mode 'org-mode)
24497 (user-error "Cannot un-indent a buffer not in Org mode"))
24498 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24499 unindent-tree ; For byte-compiler.
24505 (if (memq (org-element-type element) '(headline section))
24506 (funcall unindent-tree (org-element-contents element))
24510 (org-element-property :begin element)
24511 (org-element-property :end element))
24512 (org-do-remove-indentation)))))
24513 (reverse contents))))))
24514 (funcall unindent-tree (org-element-contents parse-tree))))
24516 (defun org-show-subtree ()
24517 "Show everything after this heading at deeper levels."
24519 (outline-flag-region
24522 (org-end-of-subtree t t))
24525 (defun org-show-entry ()
24526 "Show the body directly following this heading.
24527 Show the heading too, if it is currently invisible."
24531 (org-back-to-heading t)
24532 (outline-flag-region
24533 (max (point-min) (1- (point)))
24535 (if (re-search-forward
24536 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24537 (match-beginning 1)
24540 (org-cycle-hide-drawers 'children))))
24542 (defun org-make-options-regexp (kwds &optional extra)
24543 "Make a regular expression for keyword lines.
24544 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24545 when non-nil, is a regexp matching keywords names."
24546 (concat "^[ \t]*#\\+\\("
24548 (and extra (concat (and kwds "\\|") extra))
24549 "\\):[ \t]*\\(.*\\)"))
24551 ;; Make isearch reveal the necessary context
24552 (defun org-isearch-end ()
24553 "Reveal context after isearch exits."
24554 (when isearch-success ; only if search was successful
24555 (if (featurep 'xemacs)
24556 ;; Under XEmacs, the hook is run in the correct place,
24557 ;; we directly show the context.
24558 (org-show-context 'isearch)
24559 ;; In Emacs the hook runs *before* restoring the overlays.
24560 ;; So we have to use a one-time post-command-hook to do this.
24561 ;; (Emacs 22 has a special variable, see function `org-mode')
24562 (unless (and (boundp 'isearch-mode-end-hook-quit)
24563 isearch-mode-end-hook-quit)
24564 ;; Only when the isearch was not quitted.
24565 (org-add-hook 'post-command-hook 'org-isearch-post-command
24566 'append 'local)))))
24568 (defun org-isearch-post-command ()
24569 "Remove self from hook, and show context."
24570 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24571 (org-show-context 'isearch))
24574 ;;;; Integration with and fixes for other packages
24578 (defvar org-imenu-markers nil
24579 "All markers currently used by Imenu.")
24580 (make-variable-buffer-local 'org-imenu-markers)
24582 (defun org-imenu-new-marker (&optional pos)
24583 "Return a new marker for use by Imenu, and remember the marker."
24584 (let ((m (make-marker)))
24585 (move-marker m (or pos (point)))
24586 (push m org-imenu-markers)
24589 (defun org-imenu-get-tree ()
24590 "Produce the index for Imenu."
24591 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24592 (setq org-imenu-markers nil)
24593 (let* ((n org-imenu-depth)
24594 (re (concat "^" (org-get-limited-outline-regexp)))
24595 (subs (make-vector (1+ n) nil))
24597 m level head0 head)
24601 (goto-char (point-max))
24602 (while (re-search-backward re nil t)
24603 (setq level (org-reduced-level (funcall outline-level)))
24604 (when (and (<= level n)
24605 (looking-at org-complex-heading-regexp)
24606 (setq head0 (org-match-string-no-properties 4)))
24607 (setq head (org-link-display-format head0)
24608 m (org-imenu-new-marker))
24609 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24610 (if (>= level last-level)
24611 (push (cons head m) (aref subs level))
24612 (push (cons head (aref subs (1+ level))) (aref subs level))
24613 (loop for i from (1+ level) to n do (aset subs i nil)))
24614 (setq last-level level)))))
24617 (eval-after-load "imenu"
24619 (add-hook 'imenu-after-jump-hook
24621 (if (derived-mode-p 'org-mode)
24622 (org-show-context 'org-goto))))))
24624 (defun org-link-display-format (link)
24625 "Replace a link with its the description.
24626 If there is no description, use the link target."
24628 (if (string-match org-bracket-link-analytic-regexp link)
24629 (replace-match (if (match-end 5)
24630 (match-string 5 link)
24631 (concat (match-string 1 link)
24632 (match-string 3 link)))
24636 (defun org-toggle-link-display ()
24637 "Toggle the literal or descriptive display of links."
24639 (if org-descriptive-links
24640 (progn (org-remove-from-invisibility-spec '(org-link))
24641 (org-restart-font-lock)
24642 (setq org-descriptive-links nil))
24643 (progn (add-to-invisibility-spec '(org-link))
24644 (org-restart-font-lock)
24645 (setq org-descriptive-links t))))
24647 ;; Speedbar support
24649 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24650 "Overlay marking the agenda restriction line in speedbar.")
24651 (overlay-put org-speedbar-restriction-lock-overlay
24652 'face 'org-agenda-restriction-lock)
24653 (overlay-put org-speedbar-restriction-lock-overlay
24654 'help-echo "Agendas are currently limited to this item.")
24655 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24657 (defun org-speedbar-set-agenda-restriction ()
24658 "Restrict future agenda commands to the location at point in speedbar.
24659 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24661 (require 'org-agenda)
24662 (let (p m tp np dir txt)
24664 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24666 (setq m (get-text-property p 'org-imenu-marker))
24667 (with-current-buffer (marker-buffer m)
24669 (org-agenda-set-restriction-lock 'subtree)))
24670 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24671 'speedbar-function 'speedbar-find-file))
24672 (setq tp (previous-single-property-change
24673 (1+ p) 'speedbar-function)
24674 np (next-single-property-change
24675 tp 'speedbar-function)
24676 dir (speedbar-line-directory)
24677 txt (buffer-substring-no-properties (or tp (point-min))
24678 (or np (point-max))))
24679 (with-current-buffer (find-file-noselect
24680 (let ((default-directory dir))
24681 (expand-file-name txt)))
24682 (unless (derived-mode-p 'org-mode)
24683 (user-error "Cannot restrict to non-Org-mode file"))
24684 (org-agenda-set-restriction-lock 'file)))
24685 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24686 (move-overlay org-speedbar-restriction-lock-overlay
24687 (point-at-bol) (point-at-eol))
24688 (setq current-prefix-arg nil)
24689 (org-agenda-maybe-redo)))
24691 (defvar speedbar-file-key-map)
24692 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24693 (eval-after-load "speedbar"
24695 (speedbar-add-supported-extension ".org")
24696 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24697 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24698 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24699 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24700 (add-hook 'speedbar-visiting-tag-hook
24701 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24703 ;;; Fixes and Hacks for problems with other packages
24705 (defun org--flyspell-object-check-p (element)
24706 "Non-nil when Flyspell can check object at point.
24707 ELEMENT is the element at point."
24708 (let ((object (save-excursion
24709 (when (org-looking-at-p "\\>") (backward-char))
24710 (org-element-context element))))
24711 (case (org-element-type object)
24712 ;; Prevent checks in links due to keybinding conflict with
24714 ((code entity export-snippet inline-babel-call
24715 inline-src-block line-break latex-fragment link macro
24716 statistics-cookie target timestamp verbatim)
24718 (footnote-reference
24719 ;; Only in inline footnotes, within the definition.
24720 (and (eq (org-element-property :type object) 'inline)
24722 (goto-char (org-element-property :begin object))
24723 (search-forward ":" nil t 2))
24727 (defun org-mode-flyspell-verify ()
24728 "Function used for `flyspell-generic-check-word-predicate'."
24729 (if (org-at-heading-p)
24730 ;; At a headline or an inlinetask, check title only. This is
24731 ;; faster than relying on `org-element-at-point'.
24732 (and (save-excursion (beginning-of-line)
24733 (and (let ((case-fold-search t))
24734 (not (looking-at "\\*+ END[ \t]*$")))
24735 (looking-at org-complex-heading-regexp)))
24736 (match-beginning 4)
24737 (>= (point) (match-beginning 4))
24738 (or (not (match-beginning 5))
24739 (< (point) (match-beginning 5))))
24740 (let* ((element (org-element-at-point))
24741 (post-affiliated (org-element-property :post-affiliated element)))
24743 ;; Ignore checks in all affiliated keywords but captions.
24744 ((< (point) post-affiliated)
24745 (and (save-excursion
24746 (beginning-of-line)
24747 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24748 (> (point) (match-end 0))
24749 (org--flyspell-object-check-p element)))
24750 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24751 ((let ((log (org-log-into-drawer)))
24753 (let ((drawer (org-element-lineage element '(drawer))))
24755 (eq (compare-strings
24757 (org-element-property :drawer-name drawer) nil nil t)
24761 (case (org-element-type element)
24762 ((comment quote-section) t)
24764 ;; Allow checks between block markers, not on them.
24765 (and (> (line-beginning-position) post-affiliated)
24768 (skip-chars-forward " \r\t\n")
24769 (< (point) (org-element-property :end element)))))
24770 ;; Arbitrary list of keywords where checks are meaningful.
24771 ;; Make sure point is on the value part of the element.
24773 (and (member (org-element-property :key element)
24774 '("DESCRIPTION" "TITLE"))
24776 (beginning-of-line) (search-forward ":") (point))
24778 ;; Check is globally allowed in paragraphs verse blocks and
24779 ;; table rows (after affiliated keywords) but some objects
24780 ;; must not be affected.
24781 ((paragraph table-row verse-block)
24782 (let ((cbeg (org-element-property :contents-begin element))
24783 (cend (org-element-property :contents-end element)))
24784 (and cbeg (>= (point) cbeg) (< (point) cend)
24785 (org--flyspell-object-check-p element))))))))))
24786 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
24788 (defun org-remove-flyspell-overlays-in (beg end)
24789 "Remove flyspell overlays in region."
24790 (and (org-bound-and-true-p flyspell-mode)
24791 (fboundp 'flyspell-delete-region-overlays)
24792 (flyspell-delete-region-overlays beg end)))
24794 (defvar flyspell-delayed-commands)
24795 (eval-after-load "flyspell"
24796 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
24798 ;; Make `bookmark-jump' shows the jump location if it was hidden.
24799 (eval-after-load "bookmark"
24800 '(if (boundp 'bookmark-after-jump-hook)
24801 ;; We can use the hook
24802 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
24803 ;; Hook not available, use advice
24804 (defadvice bookmark-jump (after org-make-visible activate)
24805 "Make the position visible."
24806 (org-bookmark-jump-unhide))))
24808 ;; Make sure saveplace shows the location if it was hidden
24809 (eval-after-load "saveplace"
24810 '(defadvice save-place-find-file-hook (after org-make-visible activate)
24811 "Make the position visible."
24812 (org-bookmark-jump-unhide)))
24814 ;; Make sure ecb shows the location if it was hidden
24815 (eval-after-load "ecb"
24816 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
24817 "Make hierarchy visible when jumping into location from ECB tree buffer."
24818 (if (derived-mode-p 'org-mode)
24819 (org-show-context))))
24821 (defun org-bookmark-jump-unhide ()
24822 "Unhide the current position, to show the bookmark location."
24823 (and (derived-mode-p 'org-mode)
24824 (or (outline-invisible-p)
24825 (save-excursion (goto-char (max (point-min) (1- (point))))
24826 (outline-invisible-p)))
24827 (org-show-context 'bookmark-jump)))
24829 (defun org-mark-jump-unhide ()
24830 "Make the point visible with `org-show-context' after jumping to the mark."
24831 (when (and (derived-mode-p 'org-mode)
24832 (outline-invisible-p))
24833 (org-show-context 'mark-goto)))
24835 (eval-after-load "simple"
24836 '(defadvice pop-to-mark-command (after org-make-visible activate)
24837 "Make the point visible with `org-show-context'."
24838 (org-mark-jump-unhide)))
24840 (eval-after-load "simple"
24841 '(defadvice exchange-point-and-mark (after org-make-visible activate)
24842 "Make the point visible with `org-show-context'."
24843 (org-mark-jump-unhide)))
24845 (eval-after-load "simple"
24846 '(defadvice pop-global-mark (after org-make-visible activate)
24847 "Make the point visible with `org-show-context'."
24848 (org-mark-jump-unhide)))
24850 ;; Make session.el ignore our circular variable
24851 (defvar session-globals-exclude)
24852 (eval-after-load "session"
24853 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24859 (run-hooks 'org-load-hook)
24861 ;;; org.el ends here