1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
50 ;; http://orgmode.org/org.html#Installation
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
65 (defvar org-inhibit-highlight-removal nil
) ; dynamically scoped param
66 (defvar org-table-formula-constants-local nil
67 "Local version of `org-table-formula-constants'.")
68 (make-variable-buffer-local 'org-table-formula-constants-local
)
70 ;;;; Require other packages
78 (require 'format-spec
)
80 (or (equal this-command
'eval-buffer
)
82 (load (concat (file-name-directory load-file-name
)
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
94 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
95 ;; some places -- e.g. see the macro `org-with-limited-levels'.
97 ;; In Org buffers, the value of `outline-regexp' is that of
98 ;; `org-outline-regexp'. The only function still directly relying on
99 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
100 ;; job when `orgstruct-mode' is active.
101 (defvar org-outline-regexp
"\\*+ "
102 "Regexp to match Org headlines.")
104 (defvar org-outline-regexp-bol
"^\\*+ "
105 "Regexp to match Org headlines.
106 This is similar to `org-outline-regexp' but additionally makes
107 sure that we are at the beginning of the line.")
109 (defvar org-heading-regexp
"^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
110 "Matches a headline, putting stars and text into groups.
111 Stars are put in group 1 and the trimmed body in group 2.")
113 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
114 (unless (boundp 'calendar-view-holidays-initially-flag
)
115 (org-defvaralias 'calendar-view-holidays-initially-flag
116 'view-calendar-holidays-initially
))
117 (unless (boundp 'calendar-view-diary-initially-flag
)
118 (org-defvaralias 'calendar-view-diary-initially-flag
119 'view-diary-entries-initially
))
120 (unless (boundp 'diary-fancy-buffer
)
121 (org-defvaralias 'diary-fancy-buffer
'fancy-diary-buffer
))
123 (declare-function cdlatex-environment
"ext:cdlatex" (environment item
))
124 (declare-function org-add-archive-files
"org-archive" (files))
125 (declare-function org-agenda-entry-get-agenda-timestamp
"org-agenda" (pom))
126 (declare-function org-agenda-list
"org-agenda" (&optional arg start-day span
))
127 (declare-function org-agenda-redo
"org-agenda" (&optional all
))
128 (declare-function org-babel-do-in-edit-buffer
"ob-core" (&rest body
))
129 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
130 (declare-function org-beamer-mode
"ox-beamer" ())
131 (declare-function org-clock-get-last-clock-out-time
"org-clock" ())
132 (declare-function org-clock-out
"org-clock" (&optional switch-to-state fail-quietly at-time
))
133 (declare-function org-clock-remove-overlays
"org-clock" (&optional beg end noremove
))
134 (declare-function org-clock-sum
"org-clock" (&optional tstart tend headline-filter propname
))
135 (declare-function org-clock-sum-current-item
"org-clock" (&optional tstart
))
136 (declare-function org-clock-timestamps-down
"org-clock" (&optional n
))
137 (declare-function org-clock-timestamps-up
"org-clock" (&optional n
))
138 (declare-function org-clock-update-time-maybe
"org-clock" ())
139 (declare-function org-clocktable-shift
"org-clock" (dir n
))
140 (declare-function org-element-at-point
"org-element" ())
141 (declare-function org-element-cache-refresh
"org-element" (pos))
142 (declare-function org-element-cache-reset
"org-element" (&optional all
))
143 (declare-function org-element-contents
"org-element" (element))
144 (declare-function org-element-context
"org-element" (&optional element
))
145 (declare-function org-element-copy
"org-element" (datum))
146 (declare-function org-element-interpret-data
"org-element" (data &optional parent
))
147 (declare-function org-element-lineage
"org-element" (blob &optional types with-self
))
148 (declare-function org-element-nested-p
"org-element" (elem-a elem-b
))
149 (declare-function org-element-parse-buffer
"org-element" (&optional granularity visible-only
))
150 (declare-function org-element-property
"org-element" (property element
))
151 (declare-function org-element-put-property
"org-element" (element property value
))
152 (declare-function org-element-swap-A-B
"org-element" (elem-a elem-b
))
153 (declare-function org-element-type
"org-element" (element))
154 (declare-function org-element-update-syntax
"org-element" ())
155 (declare-function org-id-find-id-file
"org-id" (id))
156 (declare-function org-id-get-create
"org-id" (&optional force
))
157 (declare-function org-inlinetask-at-task-p
"org-inlinetask" ())
158 (declare-function org-inlinetask-outline-regexp
"org-inlinetask" ())
159 (declare-function org-inlinetask-toggle-visibility
"org-inlinetask" ())
160 (declare-function org-plot
/gnuplot
"org-plot" (&optional params
))
161 (declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label
))
162 (declare-function org-table-align
"org-table" ())
163 (declare-function org-table-begin
"org-table" (&optional table-type
))
164 (declare-function org-table-beginning-of-field
"org-table" (&optional n
))
165 (declare-function org-table-blank-field
"org-table" ())
166 (declare-function org-table-calc-current-TBLFM
"org-table" (&optional arg
))
167 (declare-function org-table-edit-field
"org-table" (arg))
168 (declare-function org-table-end
"org-table" (&optional table-type
))
169 (declare-function org-table-end-of-field
"org-table" (&optional n
))
170 (declare-function org-table-insert-row
"org-table" (&optional arg
))
171 (declare-function org-table-justify-field-maybe
"org-table" (&optional new
))
172 (declare-function org-table-maybe-eval-formula
"org-table" ())
173 (declare-function org-table-maybe-recalculate-line
"org-table" ())
174 (declare-function org-table-next-row
"org-table" ())
175 (declare-function org-table-paste-rectangle
"org-table" ())
176 (declare-function org-table-wrap-region
"org-table" (arg))
177 (declare-function org-tags-view
"org-agenda" (&optional todo-only match
))
178 (declare-function orgtbl-ascii-plot
"org-table" (&optional ask
))
179 (declare-function orgtbl-mode
"org-table" (&optional arg
))
181 (defsubst org-uniquify
(list)
182 "Non-destructively remove duplicate elements from LIST."
183 (let ((res (copy-sequence list
))) (delete-dups res
)))
185 (defsubst org-get-at-bol
(property)
186 "Get text property PROPERTY at the beginning of line."
187 (get-text-property (point-at-bol) property
))
189 (defsubst org-trim
(s)
190 "Remove whitespace at the beginning and the end of string S."
191 (replace-regexp-in-string
193 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s
)))
195 ;; load languages based on value of `org-babel-load-languages'
196 (defvar org-babel-load-languages
)
199 (defun org-babel-do-load-languages (sym value
)
200 "Load the languages defined in `org-babel-load-languages'."
201 (set-default sym value
)
203 (let ((active (cdr pair
)) (lang (symbol-name (car pair
))))
206 (require (intern (concat "ob-" lang
))))
208 (funcall 'fmakunbound
209 (intern (concat "org-babel-execute:" lang
)))
210 (funcall 'fmakunbound
211 (intern (concat "org-babel-expand-body:" lang
)))))))
212 org-babel-load-languages
))
214 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
216 (defun org-babel-load-file (file &optional compile
)
217 "Load Emacs Lisp source code blocks in the Org-mode FILE.
218 This function exports the source code using `org-babel-tangle'
219 and then loads the resulting file using `load-file'. With prefix
220 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
221 file to byte-code before it is loaded."
222 (interactive "fFile to load: \nP")
223 (let* ((age (lambda (file)
225 (time-subtract (current-time)
226 (nth 5 (or (file-attributes (file-truename file
))
227 (file-attributes file
)))))))
228 (base-name (file-name-sans-extension file
))
229 (exported-file (concat base-name
".el")))
230 ;; tangle if the org-mode file is newer than the elisp file
231 (unless (and (file-exists-p exported-file
)
232 (> (funcall age file
) (funcall age exported-file
)))
233 ;; Tangle-file traversal returns reversed list of tangled files
234 ;; and we want to evaluate the first target.
236 (car (last (org-babel-tangle-file file exported-file
"emacs-lisp")))))
239 (progn (byte-compile-file exported-file
'load
)
240 "Compiled and loaded")
241 (progn (load-file exported-file
) "Loaded"))
244 (defcustom org-babel-load-languages
'((emacs-lisp . t
))
245 "Languages which can be evaluated in Org-mode buffers.
246 This list can be used to load support for any of the languages
247 below, note that each language will depend on a different set of
248 system executables and/or Emacs modes. When a language is
249 \"loaded\", then code blocks in that language can be evaluated
250 with `org-babel-execute-src-block' bound by default to C-c
251 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
252 be set to remove code block evaluation from the C-c C-c
253 keybinding. By default only Emacs Lisp (which has no
254 requirements) is loaded."
256 :set
'org-babel-do-load-languages
258 :type
'(alist :tag
"Babel Languages"
261 (const :tag
"Awk" awk
)
264 (const :tag
"Asymptote" asymptote
)
265 (const :tag
"Calc" calc
)
266 (const :tag
"Clojure" clojure
)
267 (const :tag
"CSS" css
)
268 (const :tag
"Ditaa" ditaa
)
269 (const :tag
"Dot" dot
)
270 (const :tag
"Emacs Lisp" emacs-lisp
)
271 (const :tag
"Forth" forth
)
272 (const :tag
"Fortran" fortran
)
273 (const :tag
"Gnuplot" gnuplot
)
274 (const :tag
"Haskell" haskell
)
277 (const :tag
"Java" java
)
278 (const :tag
"Javascript" js
)
279 (const :tag
"LaTeX" latex
)
280 (const :tag
"Ledger" ledger
)
281 (const :tag
"Lilypond" lilypond
)
282 (const :tag
"Lisp" lisp
)
283 (const :tag
"Makefile" makefile
)
284 (const :tag
"Maxima" maxima
)
285 (const :tag
"Matlab" matlab
)
286 (const :tag
"Mscgen" mscgen
)
287 (const :tag
"Ocaml" ocaml
)
288 (const :tag
"Octave" octave
)
289 (const :tag
"Org" org
)
290 (const :tag
"Perl" perl
)
291 (const :tag
"Pico Lisp" picolisp
)
292 (const :tag
"PlantUML" plantuml
)
293 (const :tag
"Python" python
)
294 (const :tag
"Ruby" ruby
)
295 (const :tag
"Sass" sass
)
296 (const :tag
"Scala" scala
)
297 (const :tag
"Scheme" scheme
)
298 (const :tag
"Screen" screen
)
299 (const :tag
"Shell Script" shell
)
300 (const :tag
"Shen" shen
)
301 (const :tag
"Sql" sql
)
302 (const :tag
"Sqlite" sqlite
)
303 (const :tag
"ebnf2ps" ebnf2ps
))
304 :value-type
(boolean :tag
"Activate" :value t
)))
306 ;;;; Customization variables
307 (defcustom org-clone-delete-id nil
308 "Remove ID property of clones of a subtree.
309 When non-nil, clones of a subtree don't inherit the ID property.
310 Otherwise they inherit the ID property with a new unique
320 (defun org-version (&optional here full message
)
321 "Show the org-mode version.
322 Interactively, or when MESSAGE is non-nil, show it in echo area.
323 With prefix argument, or when HERE is non-nil, insert it at point.
324 In non-interactive uses, a reduced version string is output unless
326 (interactive (list current-prefix-arg t
(not current-prefix-arg
)))
327 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
328 (save-load-suffixes (when (boundp 'load-suffixes
) load-suffixes
))
329 (load-suffixes (list ".el"))
330 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
332 (and (fboundp 'org-release
) (fboundp 'org-git-version
))
333 (org-load-noerror-mustsuffix (concat org-dir
"org-version"))))
334 (load-suffixes save-load-suffixes
)
335 (org-version (org-release))
336 (git-version (org-git-version))
337 (version (format "Org-mode version %s (%s @ %s)"
341 (if (string= org-dir org-install-dir
)
343 (concat "mixed installation! " org-install-dir
" and " org-dir
))
344 "org-loaddefs.el can not be found!")))
345 (version1 (if full version org-version
)))
346 (when here
(insert version1
))
347 (when message
(message "%s" version1
))
350 (defconst org-version
(org-version))
357 (defconst org-block-regexp
358 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
359 "Regular expression for hiding blocks.")
361 (defconst org-dblock-start-re
362 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
363 "Matches the start line of a dynamic block, with parameters.")
365 (defconst org-dblock-end-re
"^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
366 "Matches the end of a dynamic block.")
368 ;;;; Clock and Planning
370 (defconst org-clock-string
"CLOCK:"
371 "String used as prefix for timestamps clocking work hours on an item.")
373 (defvar org-closed-string
"CLOSED:"
374 "String used as the prefix for timestamps logging closing a TODO entry.")
376 (defvar org-deadline-string
"DEADLINE:"
377 "String to mark deadline entries.
378 A deadline is this string, followed by a time stamp. Should be a word,
379 terminated by a colon. You can insert a schedule keyword and
380 a timestamp with \\[org-deadline].")
382 (defvar org-scheduled-string
"SCHEDULED:"
383 "String to mark scheduled TODO entries.
384 A schedule is this string, followed by a time stamp. Should be a word,
385 terminated by a colon. You can insert a schedule keyword and
386 a timestamp with \\[org-schedule].")
388 (defconst org-ds-keyword-length
392 (list org-deadline-string org-scheduled-string
393 org-clock-string org-closed-string
))))
394 "Maximum length of the DEADLINE and SCHEDULED keywords.")
396 (defconst org-planning-line-re
399 (list org-closed-string org-deadline-string org-scheduled-string
)
401 "Matches a line with planning info.
402 Matched keyword is in group 1.")
404 (defconst org-clock-line-re
405 (concat "^[ \t]*" org-clock-string
)
406 "Matches a line with clock info.")
408 (defconst org-deadline-regexp
(concat "\\<" org-deadline-string
)
409 "Matches the DEADLINE keyword.")
411 (defconst org-deadline-time-regexp
412 (concat "\\<" org-deadline-string
" *<\\([^>]+\\)>")
413 "Matches the DEADLINE keyword together with a time stamp.")
415 (defconst org-deadline-time-hour-regexp
416 (concat "\\<" org-deadline-string
417 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
418 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
420 (defconst org-deadline-line-regexp
421 (concat "\\<\\(" org-deadline-string
"\\).*")
422 "Matches the DEADLINE keyword and the rest of the line.")
424 (defconst org-scheduled-regexp
(concat "\\<" org-scheduled-string
)
425 "Matches the SCHEDULED keyword.")
427 (defconst org-scheduled-time-regexp
428 (concat "\\<" org-scheduled-string
" *<\\([^>]+\\)>")
429 "Matches the SCHEDULED keyword together with a time stamp.")
431 (defconst org-scheduled-time-hour-regexp
432 (concat "\\<" org-scheduled-string
433 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
434 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
436 (defconst org-closed-time-regexp
437 (concat "\\<" org-closed-string
" *\\[\\([^]]+\\)\\]")
438 "Matches the CLOSED keyword together with a time stamp.")
440 (defconst org-keyword-time-regexp
443 (list org-scheduled-string org-deadline-string org-closed-string
446 " *[[<]\\([^]>]+\\)[]>]")
447 "Matches any of the 4 keywords, together with the time stamp.")
449 (defconst org-keyword-time-not-clock-regexp
453 (list org-scheduled-string org-deadline-string org-closed-string
) t
)
454 " *[[<]\\([^]>]+\\)[]>]")
455 "Matches any of the 3 keywords, together with the time stamp.")
457 (defconst org-maybe-keyword-time-regexp
460 (list org-scheduled-string org-deadline-string org-closed-string
464 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
467 "Matches a timestamp, possibly preceded by a keyword.")
469 (defconst org-all-time-keywords
470 (mapcar (lambda (w) (substring w
0 -
1))
471 (list org-scheduled-string org-deadline-string
472 org-clock-string org-closed-string
))
473 "List of time keywords.")
477 (defconst org-drawer-regexp
"^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
478 "Matches first or last line of a hidden block.
479 Group 1 contains drawer's name or \"END\".")
481 (defconst org-property-start-re
"^[ \t]*:PROPERTIES:[ \t]*$"
482 "Regular expression matching the first line of a property drawer.")
484 (defconst org-property-end-re
"^[ \t]*:END:[ \t]*$"
485 "Regular expression matching the last line of a property drawer.")
487 (defconst org-clock-drawer-start-re
"^[ \t]*:CLOCK:[ \t]*$"
488 "Regular expression matching the first line of a clock drawer.")
490 (defconst org-clock-drawer-end-re
"^[ \t]*:END:[ \t]*$"
491 "Regular expression matching the last line of a clock drawer.")
493 (defconst org-property-drawer-re
494 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
495 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
496 "[ \t]*:END:[ \t]*$")
497 "Matches an entire property drawer.")
499 (defconst org-clock-drawer-re
500 (concat "\\(" org-clock-drawer-start-re
"\\)[^\000]*?\\("
501 org-clock-drawer-end-re
"\\)\n?")
502 "Matches an entire clock drawer.")
506 (defconst org-heading-keyword-regexp-format
507 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
508 "Printf format for a regexp matching a headline with some keyword.
509 This regexp will match the headline of any node which has the
510 exact keyword that is put into the format. The keyword isn't in
511 any group by default, but the stars and the body are.")
513 (defconst org-heading-keyword-maybe-regexp-format
514 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
515 "Printf format for a regexp matching a headline, possibly with some keyword.
516 This regexp can match any headline with the specified keyword, or
517 without a keyword. The keyword isn't in any group by default,
518 but the stars and the body are.")
520 (defconst org-archive-tag
"ARCHIVE"
521 "The tag that marks a subtree as archived.
522 An archived subtree does not open during visibility cycling, and does
523 not contribute to the agenda listings.")
525 (defconst org-comment-string
"COMMENT"
526 "Entries starting with this keyword will never be exported.
527 An entry can be toggled between COMMENT and normal with
528 \\[org-toggle-comment].")
531 ;;;; LaTeX Environments and Fragments
533 (defconst org-latex-regexps
534 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t
)
535 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
536 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
537 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil
)
538 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil
)
539 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil
)
540 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil
)
541 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil
))
542 "Regular expressions for matching embedded LaTeX.")
546 (defconst org-effort-property
"Effort"
547 "The property that is being used to keep track of effort estimates.
548 Effort estimates given in this property need to have the format H:MM.")
552 (defconst org-table-any-line-regexp
"^[ \t]*\\(|\\|\\+-[-+]\\)"
553 "Detect an org-type or table-type table.")
555 (defconst org-table-line-regexp
"^[ \t]*|"
556 "Detect an org-type table line.")
558 (defconst org-table-dataline-regexp
"^[ \t]*|[^-]"
559 "Detect an org-type table line.")
561 (defconst org-table-hline-regexp
"^[ \t]*|-"
562 "Detect an org-type table hline.")
564 (defconst org-table1-hline-regexp
"^[ \t]*\\+-[-+]"
565 "Detect a table-type table hline.")
567 (defconst org-table-any-border-regexp
"^[ \t]*[^|+ \t]"
568 "Detect the first line outside a table when searching from within it.
569 This works for both table types.")
571 (defconst org-TBLFM-regexp
"^[ \t]*#\\+TBLFM: "
572 "Detect a #+TBLFM line.")
576 (defconst org-ts-regexp
"<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
577 "Regular expression for fast time stamp matching.")
579 (defconst org-ts-regexp-inactive
580 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
581 "Regular expression for fast inactive time stamp matching.")
583 (defconst org-ts-regexp-both
"[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
584 "Regular expression for fast time stamp matching.")
586 (defconst org-ts-regexp0
587 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
588 "Regular expression matching time strings for analysis.
589 This one does not require the space after the date, so it can be used
590 on a string that terminates immediately after the date.")
592 (defconst org-ts-regexp1
"\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
593 "Regular expression matching time strings for analysis.")
595 (defconst org-ts-regexp2
(concat "<" org-ts-regexp1
"[^>\n]\\{0,16\\}>")
596 "Regular expression matching time stamps, with groups.")
598 (defconst org-ts-regexp3
(concat "[[<]" org-ts-regexp1
"[^]>\n]\\{0,16\\}[]>]")
599 "Regular expression matching time stamps (also [..]), with groups.")
601 (defconst org-tr-regexp
(concat org-ts-regexp
"--?-?" org-ts-regexp
)
602 "Regular expression matching a time stamp range.")
604 (defconst org-tr-regexp-both
605 (concat org-ts-regexp-both
"--?-?" org-ts-regexp-both
)
606 "Regular expression matching a time stamp range.")
608 (defconst org-tsr-regexp
(concat org-ts-regexp
"\\(--?-?"
609 org-ts-regexp
"\\)?")
610 "Regular expression matching a time stamp or time stamp range.")
612 (defconst org-tsr-regexp-both
613 (concat org-ts-regexp-both
"\\(--?-?"
614 org-ts-regexp-both
"\\)?")
615 "Regular expression matching a time stamp or time stamp range.
616 The time stamps may be either active or inactive.")
618 (defconst org-repeat-re
619 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
620 "Regular expression for specifying repeated events.
621 After a match, group 1 contains the repeat expression.")
623 (defconst org-time-stamp-formats
'("<%Y-%m-%d %a>" .
"<%Y-%m-%d %a %H:%M>")
624 "Formats for `format-time-string' which are used for time stamps.")
627 ;;; The custom variables
630 "Outline-based notes management and organizer."
635 (defcustom org-mode-hook nil
636 "Mode hook for Org-mode, run after the mode was turned on."
640 (defcustom org-load-hook nil
641 "Hook that is run after org.el has been loaded."
645 (defcustom org-log-buffer-setup-hook nil
646 "Hook that is run after an Org log buffer is created."
651 (defvar org-modules
) ; defined below
652 (defvar org-modules-loaded nil
653 "Have the modules been loaded already?")
655 (defun org-load-modules-maybe (&optional force
)
656 "Load all extensions listed in `org-modules'."
657 (when (or force
(not org-modules-loaded
))
659 (condition-case nil
(require ext
)
660 (error (message "Problems while trying to load feature `%s'" ext
))))
662 (setq org-modules-loaded t
)))
664 (defun org-set-modules (var value
)
665 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
667 (when (featurep 'org
)
668 (org-load-modules-maybe 'force
)
669 (org-element-cache-reset 'all
)))
671 (defcustom org-modules
'(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail
)
672 "Modules that should always be loaded together with org.el.
674 If a description starts with <C>, the file is not part of Emacs
675 and loading it will require that you have downloaded and properly
676 installed the Org mode distribution.
678 You can also use this system to load external packages (i.e. neither Org
679 core modules, nor modules from the CONTRIB directory). Just add symbols
680 to the end of the list. If the package is called org-xyz.el, then you need
681 to add the symbol `xyz', and the package must have a call to:
685 For export specific modules, see also `org-export-backends'."
687 :set
'org-set-modules
689 :package-version
'(Org .
"8.0")
692 (const :tag
" bbdb: Links to BBDB entries" org-bbdb
)
693 (const :tag
" bibtex: Links to BibTeX entries" org-bibtex
)
694 (const :tag
" crypt: Encryption of subtrees" org-crypt
)
695 (const :tag
" ctags: Access to Emacs tags with links" org-ctags
)
696 (const :tag
" docview: Links to doc-view buffers" org-docview
)
697 (const :tag
" gnus: Links to GNUS folders/messages" org-gnus
)
698 (const :tag
" habit: Track your consistency with habits" org-habit
)
699 (const :tag
" id: Global IDs for identifying entries" org-id
)
700 (const :tag
" info: Links to Info nodes" org-info
)
701 (const :tag
" inlinetask: Tasks independent of outline hierarchy" org-inlinetask
)
702 (const :tag
" irc: Links to IRC/ERC chat sessions" org-irc
)
703 (const :tag
" mhe: Links to MHE folders/messages" org-mhe
)
704 (const :tag
" mouse: Additional mouse support" org-mouse
)
705 (const :tag
" protocol: Intercept calls from emacsclient" org-protocol
)
706 (const :tag
" rmail: Links to RMAIL folders/messages" org-rmail
)
707 (const :tag
" w3m: Special cut/paste from w3m to Org-mode." org-w3m
)
709 (const :tag
"C annotate-file: Annotate a file with org syntax" org-annotate-file
)
710 (const :tag
"C bookmark: Org-mode links to bookmarks" org-bookmark
)
711 (const :tag
"C bullets: Add overlays to headlines stars" org-bullets
)
712 (const :tag
"C checklist: Extra functions for checklists in repeated tasks" org-checklist
)
713 (const :tag
"C choose: Use TODO keywords to mark decisions states" org-choose
)
714 (const :tag
"C collector: Collect properties into tables" org-collector
)
715 (const :tag
"C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend
)
716 (const :tag
"C drill: Flashcards and spaced repetition for Org-mode" org-drill
)
717 (const :tag
"C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol
)
718 (const :tag
"C eshell Support for links to working directories in eshell" org-eshell
)
719 (const :tag
"C eval-light: Evaluate inbuffer-code on demand" org-eval-light
)
720 (const :tag
"C eval: Include command output as text" org-eval
)
721 (const :tag
"C eww: Store link to url of eww" org-eww
)
722 (const :tag
"C expiry: Expiry mechanism for Org-mode entries" org-expiry
)
723 (const :tag
"C favtable: Lookup table of favorite references and links" org-favtable
)
724 (const :tag
"C git-link: Provide org links to specific file version" org-git-link
)
725 (const :tag
"C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query
)
726 (const :tag
"C invoice: Help manage client invoices in Org-mode" org-invoice
)
727 (const :tag
"C learn: SuperMemo's incremental learning algorithm" org-learn
)
728 (const :tag
"C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal
)
729 (const :tag
"C mac-link: Grab links and url from various mac Applications" org-mac-link
)
730 (const :tag
"C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix
)
731 (const :tag
"C man: Support for links to manpages in Org-mode" org-man
)
732 (const :tag
"C mew: Links to Mew folders/messages" org-mew
)
733 (const :tag
"C mtags: Support for muse-like tags" org-mtags
)
734 (const :tag
"C notmuch: Provide org links to notmuch searches or messages" org-notmuch
)
735 (const :tag
"C panel: Simple routines for us with bad memory" org-panel
)
736 (const :tag
"C registry: A registry for Org-mode links" org-registry
)
737 (const :tag
"C screen: Visit screen sessions through Org-mode links" org-screen
)
738 (const :tag
"C secretary: Team management with org-mode" org-secretary
)
739 (const :tag
"C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert
)
740 (const :tag
"C toc: Table of contents for Org-mode buffer" org-toc
)
741 (const :tag
"C track: Keep up with Org-mode development" org-track
)
742 (const :tag
"C velocity Something like Notational Velocity for Org" org-velocity
)
743 (const :tag
"C vm: Links to VM folders/messages" org-vm
)
744 (const :tag
"C wikinodes: CamelCase wiki-like links" org-wikinodes
)
745 (const :tag
"C wl: Links to Wanderlust folders/messages" org-wl
)
746 (repeat :tag
"External packages" :inline t
(symbol :tag
"Package"))))
748 (defvar org-export-registered-backends
) ; From ox.el.
749 (declare-function org-export-derived-backend-p
"ox" (backend &rest backends
))
750 (declare-function org-export-backend-name
"ox" (backend))
751 (defcustom org-export-backends
'(ascii html icalendar latex
)
752 "List of export back-ends that should be always available.
754 If a description starts with <C>, the file is not part of Emacs
755 and loading it will require that you have downloaded and properly
756 installed the Org mode distribution.
758 Unlike to `org-modules', libraries in this list will not be
759 loaded along with Org, but only once the export framework is
762 This variable needs to be set before org.el is loaded. If you
763 need to make a change while Emacs is running, use the customize
764 interface or run the following code, where VAL stands for the new
765 value of the variable, after updating it:
768 \(setq org-export-registered-backends
771 \(let ((name (org-export-backend-name backend)))
775 \(and (org-export-derived-backend-p b name)
776 \(throw 'parentp t)))))))
777 org-export-registered-backends))
778 \(let ((new-list (mapcar #'org-export-backend-name
779 org-export-registered-backends)))
780 \(dolist (backend val)
782 \((not (load (format \"ox-%s\" backend) t t))
783 \(message \"Problems while trying to load export back-end `%s'\"
785 \((not (memq backend new-list)) (push backend new-list))))
786 \(set-default 'org-export-backends new-list)))
788 Adding a back-end to this list will also pull the back-end it
793 :package-version
'(Org .
"8.0")
794 :initialize
'custom-initialize-set
795 :set
(lambda (var val
)
796 (if (not (featurep 'ox
)) (set-default var val
)
797 ;; Any back-end not required anymore (not present in VAL and not
798 ;; a parent of any back-end in the new value) is removed from the
799 ;; list of registered back-ends.
800 (setq org-export-registered-backends
803 (let ((name (org-export-backend-name backend
)))
807 (and (org-export-derived-backend-p b name
)
808 (throw 'parentp t
)))))))
809 org-export-registered-backends
))
810 ;; Now build NEW-LIST of both new back-ends and required
812 (let ((new-list (mapcar #'org-export-backend-name
813 org-export-registered-backends
)))
814 (dolist (backend val
)
816 ((not (load (format "ox-%s" backend
) t t
))
817 (message "Problems while trying to load export back-end `%s'"
819 ((not (memq backend new-list
)) (push backend new-list
))))
820 ;; Set VAR to that list with fixed dependencies.
821 (set-default var new-list
))))
822 :type
'(set :greedy t
823 (const :tag
" ascii Export buffer to ASCII format" ascii
)
824 (const :tag
" beamer Export buffer to Beamer presentation" beamer
)
825 (const :tag
" html Export buffer to HTML format" html
)
826 (const :tag
" icalendar Export buffer to iCalendar format" icalendar
)
827 (const :tag
" latex Export buffer to LaTeX format" latex
)
828 (const :tag
" man Export buffer to MAN format" man
)
829 (const :tag
" md Export buffer to Markdown format" md
)
830 (const :tag
" odt Export buffer to ODT format" odt
)
831 (const :tag
" org Export buffer to Org format" org
)
832 (const :tag
" texinfo Export buffer to Texinfo format" texinfo
)
833 (const :tag
"C confluence Export buffer to Confluence Wiki format" confluence
)
834 (const :tag
"C deck Export buffer to deck.js presentations" deck
)
835 (const :tag
"C freemind Export buffer to Freemind mindmap format" freemind
)
836 (const :tag
"C groff Export buffer to Groff format" groff
)
837 (const :tag
"C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter
)
838 (const :tag
"C RSS 2.0 Export buffer to RSS 2.0 format" rss
)
839 (const :tag
"C s5 Export buffer to s5 presentations" s5
)
840 (const :tag
"C taskjuggler Export buffer to TaskJuggler format" taskjuggler
)))
845 (condition-case nil
(require (intern (format "ox-%s" backend
)))
846 (error (message "Problems while trying to load export back-end `%s'"
848 org-export-backends
))
850 (defcustom org-support-shift-select nil
851 "Non-nil means make shift-cursor commands select text when possible.
853 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
854 start selecting a region, or enlarge regions started in this way.
855 In Org-mode, in special contexts, these same keys are used for
856 other purposes, important enough to compete with shift selection.
857 Org tries to balance these needs by supporting `shift-select-mode'
858 outside these special contexts, under control of this variable.
860 The default of this variable is nil, to avoid confusing behavior. Shifted
861 cursor keys will then execute Org commands in the following contexts:
862 - on a headline, changing TODO state (left/right) and priority (up/down)
863 - on a time stamp, changing the time
864 - in a plain list item, changing the bullet type
865 - in a property definition line, switching between allowed values
866 - in the BEGIN line of a clock table (changing the time block).
867 Outside these contexts, the commands will throw an error.
869 When this variable is t and the cursor is not in a special
870 context, Org-mode will support shift-selection for making and
871 enlarging regions. To make this more effective, the bullet
872 cycling will no longer happen anywhere in an item line, but only
873 if the cursor is exactly on the bullet.
875 If you set this variable to the symbol `always', then the keys
876 will not be special in headlines, property lines, and item lines,
877 to make shift selection work there as well. If this is what you
878 want, you can use the following alternative commands: `C-c C-t'
879 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
880 can be used to switch TODO sets, `C-c -' to cycle item bullet
881 types, and properties can be edited by hand or in column view.
883 However, when the cursor is on a timestamp, shift-cursor commands
884 will still edit the time stamp - this is just too good to give up.
886 XEmacs user should have this variable set to nil, because
887 `shift-select-mode' is in Emacs 23 or later only."
890 (const :tag
"Never" nil
)
891 (const :tag
"When outside special context" t
)
892 (const :tag
"Everywhere except timestamps" always
)))
894 (defcustom org-loop-over-headlines-in-active-region nil
895 "Shall some commands act upon headlines in the active region?
897 When set to t, some commands will be performed in all headlines
898 within the active region.
900 When set to `start-level', some commands will be performed in all
901 headlines within the active region, provided that these headlines
902 are of the same level than the first one.
904 When set to a string, those commands will be performed on the
905 matching headlines within the active region. Such string must be
906 a tags/property/todo match as it is used in the agenda tags view.
908 The list of commands is: `org-schedule', `org-deadline',
909 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
910 `org-archive-to-archive-sibling'. The archiving commands skip
911 already archived entries."
912 :type
'(choice (const :tag
"Don't loop" nil
)
913 (const :tag
"All headlines in active region" t
)
914 (const :tag
"In active region, headlines at the same level than the first one" start-level
)
915 (string :tag
"Tags/Property/Todo matcher"))
920 (defgroup org-startup nil
921 "Options concerning startup of Org-mode."
925 (defcustom org-startup-folded t
926 "Non-nil means entering Org-mode will switch to OVERVIEW.
927 This can also be configured on a per-file basis by adding one of
928 the following lines anywhere in the buffer:
930 #+STARTUP: fold (or `overview', this is equivalent)
931 #+STARTUP: nofold (or `showall', this is equivalent)
933 #+STARTUP: showeverything
935 By default, this option is ignored when Org opens agenda files
936 for the first time. If you want the agenda to honor the startup
937 option, set `org-agenda-inhibit-startup' to nil."
940 (const :tag
"nofold: show all" nil
)
941 (const :tag
"fold: overview" t
)
942 (const :tag
"content: all headlines" content
)
943 (const :tag
"show everything, even drawers" showeverything
)))
945 (defcustom org-startup-truncated t
946 "Non-nil means entering Org-mode will set `truncate-lines'.
947 This is useful since some lines containing links can be very long and
948 uninteresting. Also tables look terrible when wrapped."
952 (defcustom org-startup-indented nil
953 "Non-nil means turn on `org-indent-mode' on startup.
954 This can also be configured on a per-file basis by adding one of
955 the following lines anywhere in the buffer:
959 :group
'org-structure
961 (const :tag
"Not" nil
)
962 (const :tag
"Globally (slow on startup in large files)" t
)))
964 (defcustom org-use-sub-superscripts t
965 "Non-nil means interpret \"_\" and \"^\" for display.
967 If you want to control how Org exports those characters, see
968 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
969 used to be an alias for `org-export-with-sub-superscripts' in
970 Org <8.0, it is not anymore.
972 When this option is turned on, you can use TeX-like syntax for
973 sub- and superscripts within the buffer. Several characters after
974 \"_\" or \"^\" will be considered as a single item - so grouping
975 with {} is normally not needed. For example, the following things
976 will be parsed as single sub- or superscripts:
978 10^24 or 10^tau several digits will be considered 1 item.
979 10^-12 or 10^-tau a leading sign with digits or a word
980 x^2-y^3 will be read as x^2 - y^3, because items are
981 terminated by almost any nonword/nondigit char.
982 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
984 Still, ambiguity is possible. So when in doubt, use {} to enclose
985 the sub/superscript. If you set this variable to the symbol `{}',
986 the braces are *required* in order to trigger interpretations as
987 sub/superscript. This can be helpful in documents that need \"_\"
988 frequently in plain text."
991 :package-version
'(Org .
"8.0")
993 (const :tag
"Always interpret" t
)
994 (const :tag
"Only with braces" {})
995 (const :tag
"Never interpret" nil
)))
997 (defcustom org-startup-with-beamer-mode nil
998 "Non-nil means turn on `org-beamer-mode' on startup.
999 This can also be configured on a per-file basis by adding one of
1000 the following lines anywhere in the buffer:
1007 (defcustom org-startup-align-all-tables nil
1008 "Non-nil means align all tables when visiting a file.
1009 This is useful when the column width in tables is forced with <N> cookies
1010 in table fields. Such tables will look correct only after the first re-align.
1011 This can also be configured on a per-file basis by adding one of
1012 the following lines anywhere in the buffer:
1018 (defcustom org-startup-with-inline-images nil
1019 "Non-nil means show inline images when loading a new Org file.
1020 This can also be configured on a per-file basis by adding one of
1021 the following lines anywhere in the buffer:
1022 #+STARTUP: inlineimages
1023 #+STARTUP: noinlineimages"
1028 (defcustom org-startup-with-latex-preview nil
1029 "Non-nil means preview LaTeX fragments when loading a new Org file.
1031 This can also be configured on a per-file basis by adding one of
1032 the following lines anywhere in the buffer:
1033 #+STARTUP: latexpreview
1034 #+STARTUP: nolatexpreview"
1037 :package-version
'(Org .
"8.0")
1040 (defcustom org-insert-mode-line-in-empty-file nil
1041 "Non-nil means insert the first line setting Org-mode in empty files.
1042 When the function `org-mode' is called interactively in an empty file, this
1043 normally means that the file name does not automatically trigger Org-mode.
1044 To ensure that the file will always be in Org-mode in the future, a
1045 line enforcing Org-mode will be inserted into the buffer, if this option
1050 (defcustom org-replace-disputed-keys nil
1051 "Non-nil means use alternative key bindings for some keys.
1052 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1053 These keys are also used by other packages like shift-selection-mode'
1054 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1055 If you want to use Org-mode together with one of these other modes,
1056 or more generally if you would like to move some Org-mode commands to
1057 other keys, set this variable and configure the keys with the variable
1058 `org-disputed-keys'.
1060 This option is only relevant at load-time of Org-mode, and must be set
1061 *before* org.el is loaded. Changing it requires a restart of Emacs to
1066 (defcustom org-use-extra-keys nil
1067 "Non-nil means use extra key sequence definitions for certain commands.
1068 This happens automatically if you run XEmacs or if `window-system'
1069 is nil. This variable lets you do the same manually. You must
1070 set it before loading org.
1072 Example: on Carbon Emacs 22 running graphically, with an external
1073 keyboard on a Powerbook, the default way of setting M-left might
1074 not work for either Alt or ESC. Setting this variable will make
1079 (org-defvaralias 'org-CUA-compatible
'org-replace-disputed-keys
)
1081 (defcustom org-disputed-keys
1082 '(([(shift up
)] .
[(meta p
)])
1083 ([(shift down
)] .
[(meta n
)])
1084 ([(shift left
)] .
[(meta -
)])
1085 ([(shift right
)] .
[(meta +)])
1086 ([(control shift right
)] .
[(meta shift
+)])
1087 ([(control shift left
)] .
[(meta shift -
)]))
1088 "Keys for which Org-mode and other modes compete.
1089 This is an alist, cars are the default keys, second element specifies
1090 the alternative to use when `org-replace-disputed-keys' is t.
1092 Keys can be specified in any syntax supported by `define-key'.
1093 The value of this option takes effect only at Org-mode's startup,
1094 therefore you'll have to restart Emacs to apply it after changing."
1098 (defun org-key (key)
1099 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1100 Or return the original if not disputed.
1101 Also apply the translations defined in `org-xemacs-key-equivalents'."
1102 (when org-replace-disputed-keys
1103 (let* ((nkey (key-description key
))
1104 (x (org-find-if (lambda (x)
1105 (equal (key-description (car x
)) nkey
))
1106 org-disputed-keys
)))
1107 (setq key
(if x
(cdr x
) key
))))
1108 (when (featurep 'xemacs
)
1109 (setq key
(or (cdr (assoc key org-xemacs-key-equivalents
)) key
)))
1112 (defun org-find-if (predicate seq
)
1115 (if (funcall predicate
(car seq
))
1116 (throw 'exit
(car seq
))
1119 (defun org-defkey (keymap key def
)
1120 "Define a key, possibly translated, as returned by `org-key'."
1121 (define-key keymap
(org-key key
) def
))
1123 (defcustom org-ellipsis nil
1124 "The ellipsis to use in the Org-mode outline.
1125 When nil, just use the standard three dots.
1126 When a string, use that string instead.
1127 When a face, use the standard 3 dots, but with the specified face.
1128 The change affects only Org-mode (which will then use its own display table).
1129 Changing this requires executing \\[org-mode] in a buffer to become
1132 :type
'(choice (const :tag
"Default" nil
)
1133 (face :tag
"Face" :value org-warning
)
1134 (string :tag
"String" :value
"...#")))
1136 (defvar org-display-table nil
1137 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1139 (defgroup org-keywords nil
1140 "Keywords in Org-mode."
1144 (defcustom org-closed-keep-when-no-todo nil
1145 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1147 :group
'org-keywords
1149 :package-version
'(Org .
"8.0")
1152 (defgroup org-structure nil
1153 "Options concerning the general structure of Org-mode files."
1154 :tag
"Org Structure"
1157 (defgroup org-reveal-location nil
1158 "Options about how to make context of a location visible."
1159 :tag
"Org Reveal Location"
1160 :group
'org-structure
)
1162 (defcustom org-show-context-detail
'((isearch . lineage
)
1163 (bookmark-jump . lineage
)
1164 (default . ancestors
))
1165 "Alist between context and visibility span when revealing a location.
1167 \\<org-mode-map>Some actions may move point into invisible
1168 locations. As a consequence, Org always expose a neighborhood
1169 around point. How much is shown depends on the initial action,
1170 or context. Valid contexts are
1172 agenda when exposing an entry from the agenda
1173 org-goto when using the command `org-goto' (\\[org-goto])
1174 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1175 tags-tree when constructing a sparse tree based on tags matches
1176 link-search when exposing search matches associated with a link
1177 mark-goto when exposing the jump goal of a mark
1178 bookmark-jump when exposing a bookmark location
1179 isearch when exiting from an incremental search
1180 default default for all contexts not set explicitly
1182 Allowed visibility spans are
1184 minimal show current headline; if point is not on headline,
1187 local show current headline, entry and next headline
1189 ancestors show current headline and its direct ancestors; if
1190 point is not on headline, also show entry
1192 lineage show current headline, its direct ancestors and all
1193 their children; if point is not on headline, also show
1194 entry and first child
1196 tree show current headline, its direct ancestors and all
1197 their children; if point is not on headline, also show
1198 entry and all children
1200 canonical show current headline, its direct ancestors along with
1201 their entries and children; if point is not located on
1202 the headline, also show current entry and all children
1204 As special cases, a nil or t value means show all contexts in
1205 `minimal' or `canonical' view, respectively.
1207 Some views can make displayed information very compact, but also
1208 make it harder to edit the location of the match. In such
1209 a case, use the command `org-reveal' (\\[org-reveal]) to show
1211 :group
'org-reveal-location
1213 :package-version
'(Org .
"8.3")
1215 (const :tag
"Canonical" t
)
1216 (const :tag
"Minimal" nil
)
1217 (repeat :greedy t
:tag
"Individual contexts"
1219 (choice :tag
"Context"
1226 (const bookmark-jump
)
1229 (choice :tag
"Detail level"
1235 (const canonical
))))))
1237 (defcustom org-indirect-buffer-display
'other-window
1238 "How should indirect tree buffers be displayed?
1239 This applies to indirect buffers created with the commands
1240 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1242 current-window Display in the current window
1243 other-window Just display in another window.
1244 dedicated-frame Create one new frame, and re-use it each time.
1245 new-frame Make a new frame each time. Note that in this case
1246 previously-made indirect buffers are kept, and you need to
1247 kill these buffers yourself."
1248 :group
'org-structure
1249 :group
'org-agenda-windows
1251 (const :tag
"In current window" current-window
)
1252 (const :tag
"In current frame, other window" other-window
)
1253 (const :tag
"Each time a new frame" new-frame
)
1254 (const :tag
"One dedicated frame" dedicated-frame
)))
1256 (defcustom org-use-speed-commands nil
1257 "Non-nil means activate single letter commands at beginning of a headline.
1258 This may also be a function to test for appropriate locations where speed
1259 commands should be active.
1261 For example, to activate speed commands when the point is on any
1262 star at the beginning of the headline, you can do this:
1264 (setq org-use-speed-commands
1265 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1266 :group
'org-structure
1268 (const :tag
"Never" nil
)
1269 (const :tag
"At beginning of headline stars" t
)
1272 (defcustom org-speed-commands-user nil
1273 "Alist of additional speed commands.
1274 This list will be checked before `org-speed-commands-default'
1275 when the variable `org-use-speed-commands' is non-nil
1276 and when the cursor is at the beginning of a headline.
1277 The car if each entry is a string with a single letter, which must
1278 be assigned to `self-insert-command' in the global map.
1279 The cdr is either a command to be called interactively, a function
1280 to be called, or a form to be evaluated.
1281 An entry that is just a list with a single string will be interpreted
1282 as a descriptive headline that will be added when listing the speed
1283 commands in the Help buffer using the `?' speed command."
1284 :group
'org-structure
1285 :type
'(repeat :value
("k" . ignore
)
1286 (choice :value
("k" . ignore
)
1287 (list :tag
"Descriptive Headline" (string :tag
"Headline"))
1288 (cons :tag
"Letter and Command"
1289 (string :tag
"Command letter")
1294 (defcustom org-bookmark-names-plist
1295 '(:last-capture
"org-capture-last-stored"
1296 :last-refile
"org-refile-last-stored"
1297 :last-capture-marker
"org-capture-last-stored-marker")
1298 "Names for bookmarks automatically set by some Org commands.
1299 This can provide strings as names for a number of bookmarks Org sets
1300 automatically. The following keys are currently implemented:
1302 :last-capture-marker
1304 When a key does not show up in the property list, the corresponding bookmark
1306 :group
'org-structure
1309 (defgroup org-cycle nil
1310 "Options concerning visibility cycling in Org-mode."
1312 :group
'org-structure
)
1314 (defcustom org-cycle-skip-children-state-if-no-children t
1315 "Non-nil means skip CHILDREN state in entries that don't have any."
1319 (defcustom org-cycle-max-level nil
1320 "Maximum level which should still be subject to visibility cycling.
1321 Levels higher than this will, for cycling, be treated as text, not a headline.
1322 When `org-odd-levels-only' is set, a value of N in this variable actually
1323 means 2N-1 stars as the limiting headline.
1324 When nil, cycle all levels.
1325 Note that the limiting level of cycling is also influenced by
1326 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1327 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1331 (const :tag
"No limit" nil
)
1332 (integer :tag
"Maximum level")))
1334 (defcustom org-hide-block-startup nil
1335 "Non-nil means entering Org-mode will fold all blocks.
1336 This can also be set in on a per-file basis with
1338 #+STARTUP: hideblocks
1339 #+STARTUP: showblocks"
1344 (defcustom org-cycle-global-at-bob nil
1345 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1346 This makes it possible to do global cycling without having to use S-TAB or
1347 \\[universal-argument] TAB. For this special case to work, the first line
1348 of the buffer must not be a headline -- it may be empty or some other text.
1349 When used in this way, `org-cycle-hook' is disabled temporarily to make
1350 sure the cursor stays at the beginning of the buffer. When this option is
1351 nil, don't do anything special at the beginning of the buffer."
1355 (defcustom org-cycle-level-after-item
/entry-creation t
1356 "Non-nil means cycle entry level or item indentation in new empty entries.
1358 When the cursor is at the end of an empty headline, i.e., with only stars
1359 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1360 and then all possible ancestor states, before returning to the original state.
1361 This makes data entry extremely fast: M-RET to create a new headline,
1362 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1364 When the cursor is at the end of an empty plain list item, one TAB will
1365 make it a subitem, two or more tabs will back up to make this an item
1366 higher up in the item hierarchy."
1370 (defcustom org-cycle-emulate-tab t
1371 "Where should `org-cycle' emulate TAB.
1373 white Only in completely white lines
1374 whitestart Only at the beginning of lines, before the first non-white char
1375 t Everywhere except in headlines
1376 exc-hl-bol Everywhere except at the start of a headline
1377 If TAB is used in a place where it does not emulate TAB, the current subtree
1378 visibility is cycled."
1380 :type
'(choice (const :tag
"Never" nil
)
1381 (const :tag
"Only in completely white lines" white
)
1382 (const :tag
"Before first char in a line" whitestart
)
1383 (const :tag
"Everywhere except in headlines" t
)
1384 (const :tag
"Everywhere except at bol in headlines" exc-hl-bol
)))
1386 (defcustom org-cycle-separator-lines
2
1387 "Number of empty lines needed to keep an empty line between collapsed trees.
1388 If you leave an empty line between the end of a subtree and the following
1389 headline, this empty line is hidden when the subtree is folded.
1390 Org-mode will leave (exactly) one empty line visible if the number of
1391 empty lines is equal or larger to the number given in this variable.
1392 So the default 2 means at least 2 empty lines after the end of a subtree
1393 are needed to produce free space between a collapsed subtree and the
1396 If the number is negative, and the number of empty lines is at least -N,
1397 all empty lines are shown.
1399 Special case: when 0, never leave empty lines in collapsed view."
1402 (put 'org-cycle-separator-lines
'safe-local-variable
'integerp
)
1404 (defcustom org-pre-cycle-hook nil
1405 "Hook that is run before visibility cycling is happening.
1406 The function(s) in this hook must accept a single argument which indicates
1407 the new state that will be set right after running this hook. The
1408 argument is a symbol. Before a global state change, it can have the values
1409 `overview', `content', or `all'. Before a local state change, it can have
1410 the values `folded', `children', or `subtree'."
1414 (defcustom org-cycle-hook
'(org-cycle-hide-archived-subtrees
1415 org-cycle-hide-drawers
1416 org-cycle-show-empty-lines
1417 org-optimize-window-after-visibility-change
)
1418 "Hook that is run after `org-cycle' has changed the buffer visibility.
1419 The function(s) in this hook must accept a single argument which indicates
1420 the new state that was set by the most recent `org-cycle' command. The
1421 argument is a symbol. After a global state change, it can have the values
1422 `overview', `contents', or `all'. After a local state change, it can have
1423 the values `folded', `children', or `subtree'."
1427 :package-version
'(Org .
"8.3"))
1429 (defgroup org-edit-structure nil
1430 "Options concerning structure editing in Org-mode."
1431 :tag
"Org Edit Structure"
1432 :group
'org-structure
)
1434 (defcustom org-odd-levels-only nil
1435 "Non-nil means skip even levels and only use odd levels for the outline.
1436 This has the effect that two stars are being added/taken away in
1437 promotion/demotion commands. It also influences how levels are
1438 handled by the exporters.
1439 Changing it requires restart of `font-lock-mode' to become effective
1440 for fontification also in regions already fontified.
1441 You may also set this on a per-file basis by adding one of the following
1442 lines to the buffer:
1446 :group
'org-edit-structure
1447 :group
'org-appearance
1450 (defcustom org-adapt-indentation t
1451 "Non-nil means adapt indentation to outline node level.
1453 When this variable is set, Org assumes that you write outlines by
1454 indenting text in each node to align with the headline (after the
1455 stars). The following issues are influenced by this variable:
1457 - The indentation is increased by one space in a demotion
1458 command, and decreased by one in a promotion command. However,
1459 in the latter case, if shifting some line in the entry body
1460 would alter document structure (e.g., insert a new headline),
1461 indentation is not changed at all.
1463 - Property drawers and planning information is inserted indented
1464 when this variable is set. When nil, they will not be indented.
1466 - TAB indents a line relative to current level. The lines below
1467 a headline will be indented when this variable is set.
1469 Note that this is all about true indentation, by adding and
1470 removing space characters. See also `org-indent.el' which does
1471 level-dependent indentation in a virtual way, i.e. at display
1473 :group
'org-edit-structure
1476 (defcustom org-special-ctrl-a
/e nil
1477 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1479 When t, `C-a' will bring back the cursor to the beginning of the
1480 headline text, i.e. after the stars and after a possible TODO
1481 keyword. In an item, this will be the position after bullet and
1482 check-box, if any. When the cursor is already at that position,
1483 another `C-a' will bring it to the beginning of the line.
1485 `C-e' will jump to the end of the headline, ignoring the presence
1486 of tags in the headline. A second `C-e' will then jump to the
1487 true end of the line, after any tags. This also means that, when
1488 this variable is non-nil, `C-e' also will never jump beyond the
1489 end of the heading of a folded section, i.e. not after the
1492 When set to the symbol `reversed', the first `C-a' or `C-e' works
1493 normally, going to the true line boundary first. Only a directly
1494 following, identical keypress will bring the cursor to the
1497 This may also be a cons cell where the behavior for `C-a' and
1498 `C-e' is set separately."
1499 :group
'org-edit-structure
1501 (const :tag
"off" nil
)
1502 (const :tag
"on: after stars/bullet and before tags first" t
)
1503 (const :tag
"reversed: true line boundary first" reversed
)
1504 (cons :tag
"Set C-a and C-e separately"
1505 (choice :tag
"Special C-a"
1506 (const :tag
"off" nil
)
1507 (const :tag
"on: after stars/bullet first" t
)
1508 (const :tag
"reversed: before stars/bullet first" reversed
))
1509 (choice :tag
"Special C-e"
1510 (const :tag
"off" nil
)
1511 (const :tag
"on: before tags first" t
)
1512 (const :tag
"reversed: after tags first" reversed
)))))
1513 (org-defvaralias 'org-special-ctrl-a
'org-special-ctrl-a
/e
)
1515 (defcustom org-special-ctrl-k nil
1516 "Non-nil means `C-k' will behave specially in headlines.
1517 When nil, `C-k' will call the default `kill-line' command.
1518 When t, the following will happen while the cursor is in the headline:
1520 - When the cursor is at the beginning of a headline, kill the entire
1521 line and possible the folded subtree below the line.
1522 - When in the middle of the headline text, kill the headline up to the tags.
1523 - When after the headline text, kill the tags."
1524 :group
'org-edit-structure
1527 (defcustom org-ctrl-k-protect-subtree nil
1528 "Non-nil means, do not delete a hidden subtree with C-k.
1529 When set to the symbol `error', simply throw an error when C-k is
1530 used to kill (part-of) a headline that has hidden text behind it.
1531 Any other non-nil value will result in a query to the user, if it is
1532 OK to kill that hidden subtree. When nil, kill without remorse."
1533 :group
'org-edit-structure
1536 (const :tag
"Do not protect hidden subtrees" nil
)
1537 (const :tag
"Protect hidden subtrees with a security query" t
)
1538 (const :tag
"Never kill a hidden subtree with C-k" error
)))
1540 (defcustom org-special-ctrl-o t
1541 "Non-nil means, make `C-o' insert a row in tables."
1542 :group
'org-edit-structure
1545 (defcustom org-catch-invisible-edits nil
1546 "Check if in invisible region before inserting or deleting a character.
1549 nil Do not check, so just do invisible edits.
1550 error Throw an error and do nothing.
1551 show Make point visible, and do the requested edit.
1552 show-and-error Make point visible, then throw an error and abort the edit.
1553 smart Make point visible, and do insertion/deletion if it is
1554 adjacent to visible text and the change feels predictable.
1555 Never delete a previously invisible character or add in the
1556 middle or right after an invisible region. Basically, this
1557 allows insertion and backward-delete right before ellipses.
1558 FIXME: maybe in this case we should not even show?"
1559 :group
'org-edit-structure
1562 (const :tag
"Do not check" nil
)
1563 (const :tag
"Throw error when trying to edit" error
)
1564 (const :tag
"Unhide, but do not do the edit" show-and-error
)
1565 (const :tag
"Show invisible part and do the edit" show
)
1566 (const :tag
"Be smart and do the right thing" smart
)))
1568 (defcustom org-yank-folded-subtrees t
1569 "Non-nil means when yanking subtrees, fold them.
1570 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1571 it starts with a heading and all other headings in it are either children
1572 or siblings, then fold all the subtrees. However, do this only if no
1573 text after the yank would be swallowed into a folded tree by this action."
1574 :group
'org-edit-structure
1577 (defcustom org-yank-adjusted-subtrees nil
1578 "Non-nil means when yanking subtrees, adjust the level.
1579 With this setting, `org-paste-subtree' is used to insert the subtree, see
1580 this function for details."
1581 :group
'org-edit-structure
1584 (defcustom org-M-RET-may-split-line
'((default . t
))
1585 "Non-nil means M-RET will split the line at the cursor position.
1586 When nil, it will go to the end of the line before making a
1588 You may also set this option in a different way for different
1589 contexts. Valid contexts are:
1591 headline when creating a new headline
1592 item when creating a new item
1593 table in a table field
1594 default the value to be used for all contexts not explicitly
1596 :group
'org-structure
1599 (const :tag
"Always" t
)
1600 (const :tag
"Never" nil
)
1601 (repeat :greedy t
:tag
"Individual contexts"
1603 (choice :tag
"Context"
1611 (defcustom org-insert-heading-respect-content nil
1612 "Non-nil means insert new headings after the current subtree.
1613 When nil, the new heading is created directly after the current line.
1614 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1615 this variable on for the duration of the command."
1616 :group
'org-structure
1619 (defcustom org-blank-before-new-entry
'((heading . auto
)
1620 (plain-list-item . auto
))
1621 "Should `org-insert-heading' leave a blank line before new heading/item?
1622 The value is an alist, with `heading' and `plain-list-item' as CAR,
1623 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1624 which case Org will look at the surrounding headings/items and try to
1625 make an intelligent decision whether to insert a blank line or not.
1627 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1628 the setting here is ignored and no empty line is inserted to avoid breaking
1629 the list structure."
1630 :group
'org-edit-structure
1632 (cons (const heading
)
1633 (choice (const :tag
"Never" nil
)
1634 (const :tag
"Always" t
)
1635 (const :tag
"Auto" auto
)))
1636 (cons (const plain-list-item
)
1637 (choice (const :tag
"Never" nil
)
1638 (const :tag
"Always" t
)
1639 (const :tag
"Auto" auto
)))))
1641 (defcustom org-insert-heading-hook nil
1642 "Hook being run after inserting a new heading."
1643 :group
'org-edit-structure
1646 (defcustom org-enable-fixed-width-editor t
1647 "Non-nil means lines starting with \":\" are treated as fixed-width.
1648 This currently only means they are never auto-wrapped.
1649 When nil, such lines will be treated like ordinary lines."
1650 :group
'org-edit-structure
1653 (defcustom org-goto-auto-isearch t
1654 "Non-nil means typing characters in `org-goto' starts incremental search.
1655 When nil, you can use these keybindings to navigate the buffer:
1657 q Quit the org-goto interface
1658 n Go to the next visible heading
1659 p Go to the previous visible heading
1660 f Go one heading forward on same level
1661 b Go one heading backward on same level
1662 u Go one heading up"
1663 :group
'org-edit-structure
1666 (defgroup org-sparse-trees nil
1667 "Options concerning sparse trees in Org-mode."
1668 :tag
"Org Sparse Trees"
1669 :group
'org-structure
)
1671 (defcustom org-highlight-sparse-tree-matches t
1672 "Non-nil means highlight all matches that define a sparse tree.
1673 The highlights will automatically disappear the next time the buffer is
1674 changed by an edit command."
1675 :group
'org-sparse-trees
1678 (defcustom org-remove-highlights-with-change t
1679 "Non-nil means any change to the buffer will remove temporary highlights.
1680 Such highlights are created by `org-occur' and `org-clock-display'.
1681 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1682 The highlights created by `org-toggle-latex-fragment' always need
1683 `C-c C-x C-l' to be removed."
1684 :group
'org-sparse-trees
1689 (defcustom org-occur-hook
'(org-first-headline-recenter)
1690 "Hook that is run after `org-occur' has constructed a sparse tree.
1691 This can be used to recenter the window to show as much of the structure
1693 :group
'org-sparse-trees
1696 (defgroup org-imenu-and-speedbar nil
1697 "Options concerning imenu and speedbar in Org-mode."
1698 :tag
"Org Imenu and Speedbar"
1699 :group
'org-structure
)
1701 (defcustom org-imenu-depth
2
1702 "The maximum level for Imenu access to Org-mode headlines.
1703 This also applied for speedbar access."
1704 :group
'org-imenu-and-speedbar
1707 (defgroup org-table nil
1708 "Options concerning tables in Org-mode."
1712 (defcustom org-enable-table-editor
'optimized
1713 "Non-nil means lines starting with \"|\" are handled by the table editor.
1714 When nil, such lines will be treated like ordinary lines.
1716 When equal to the symbol `optimized', the table editor will be optimized to
1718 - Automatic overwrite mode in front of whitespace in table fields.
1719 This makes the structure of the table stay in tact as long as the edited
1720 field does not exceed the column width.
1721 - Minimize the number of realigns. Normally, the table is aligned each time
1722 TAB or RET are pressed to move to another field. With optimization this
1723 happens only if changes to a field might have changed the column width.
1724 Optimization requires replacing the functions `self-insert-command',
1725 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1726 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1727 very good at guessing when a re-align will be necessary, but you can always
1728 force one with \\[org-ctrl-c-ctrl-c].
1730 If you would like to use the optimized version in Org-mode, but the
1731 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1733 This variable can be used to turn on and off the table editor during a session,
1734 but in order to toggle optimization, a restart is required.
1736 See also the variable `org-table-auto-blank-field'."
1739 (const :tag
"off" nil
)
1741 (const :tag
"on, optimized" optimized
)))
1743 (defcustom org-self-insert-cluster-for-undo
(or (featurep 'xemacs
)
1744 (version<= emacs-version
"24.1"))
1745 "Non-nil means cluster self-insert commands for undo when possible.
1746 If this is set, then, like in the Emacs command loop, 20 consecutive
1747 characters will be undone together.
1748 This is configurable, because there is some impact on typing performance."
1752 (defcustom org-table-tab-recognizes-table.el t
1753 "Non-nil means TAB will automatically notice a table.el table.
1754 When it sees such a table, it moves point into it and - if necessary -
1755 calls `table-recognize-table'."
1756 :group
'org-table-editing
1759 (defgroup org-link nil
1760 "Options concerning links in Org-mode."
1764 (defvar org-link-abbrev-alist-local nil
1765 "Buffer-local version of `org-link-abbrev-alist', which see.
1766 The value of this is taken from the #+LINK lines.")
1767 (make-variable-buffer-local 'org-link-abbrev-alist-local
)
1769 (defcustom org-link-abbrev-alist nil
1770 "Alist of link abbreviations.
1771 The car of each element is a string, to be replaced at the start of a link.
1772 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1773 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1775 [[linkkey:tag][description]]
1777 The 'linkkey' must be a word word, starting with a letter, followed
1778 by letters, numbers, '-' or '_'.
1780 If REPLACE is a string, the tag will simply be appended to create the link.
1781 If the string contains \"%s\", the tag will be inserted there. If the string
1782 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1783 at that point (see the function `url-hexify-string'). If the string contains
1784 the specifier \"%(my-function)\", then the custom function `my-function' will
1785 be invoked: this function takes the tag as its only argument and must return
1788 REPLACE may also be a function that will be called with the tag as the
1789 only argument to create the link, which should be returned as a string.
1791 See the manual for examples."
1795 (string :tag
"Protocol")
1797 (string :tag
"Format")
1800 (defcustom org-descriptive-links t
1801 "Non-nil means Org will display descriptive links.
1802 E.g. [[http://orgmode.org][Org website]] will be displayed as
1803 \"Org Website\", hiding the link itself and just displaying its
1804 description. When set to nil, Org will display the full links
1807 You can interactively set the value of this variable by calling
1808 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1812 (defcustom org-link-file-path-type
'adaptive
1813 "How the path name in file links should be stored.
1816 relative Relative to the current directory, i.e. the directory of the file
1817 into which the link is being inserted.
1818 absolute Absolute path, if possible with ~ for home directory.
1819 noabbrev Absolute path, no abbreviation of home directory.
1820 adaptive Use relative path for files in the current directory and sub-
1821 directories of it. For other files, use an absolute path."
1829 (defvaralias 'org-activate-links
'org-highlight-links
)
1830 (defcustom org-highlight-links
'(bracket angle plain radio tag date footnote
)
1831 "Types of links that should be highlighted in Org-mode files.
1833 This is a list of symbols, each one of them leading to the
1834 highlighting of a certain link type.
1836 You can still open links that are not highlighted.
1838 In principle, it does not hurt to turn on highlighting for all
1839 link types. There may be a small gain when turning off unused
1840 link types. The types are:
1842 bracket The recommended [[link][description]] or [[link]] links with hiding.
1843 angle Links in angular brackets that may contain whitespace like
1844 <bbdb:Carsten Dominik>.
1845 plain Plain links in normal text, no whitespace, like http://google.com.
1846 radio Text that is matched by a radio target, see manual for details.
1847 tag Tag settings in a headline (link to tag search).
1848 date Time stamps (link to calendar).
1849 footnote Footnote labels.
1851 If you set this variable during an Emacs session, use `org-mode-restart'
1852 in the Org buffer so that the change takes effect."
1854 :group
'org-appearance
1855 :type
'(set :greedy t
1856 (const :tag
"Double bracket links" bracket
)
1857 (const :tag
"Angular bracket links" angle
)
1858 (const :tag
"Plain text links" plain
)
1859 (const :tag
"Radio target matches" radio
)
1860 (const :tag
"Tags" tag
)
1861 (const :tag
"Timestamps" date
)
1862 (const :tag
"Footnotes" footnote
)))
1864 (defcustom org-make-link-description-function nil
1865 "Function to use for generating link descriptions from links.
1866 When nil, the link location will be used. This function must take
1867 two parameters: the first one is the link, the second one is the
1868 description generated by `org-insert-link'. The function should
1869 return the description to use."
1871 :type
'(choice (const nil
) (function)))
1873 (defgroup org-link-store nil
1874 "Options concerning storing links in Org-mode."
1875 :tag
"Org Store Link"
1878 (defcustom org-url-hexify-p t
1879 "When non-nil, hexify URL when creating a link."
1882 :group
'org-link-store
)
1884 (defcustom org-email-link-description-format
"Email %c: %.30s"
1885 "Format of the description part of a link to an email or usenet message.
1886 The following %-escapes will be replaced by corresponding information:
1888 %F full \"From\" field
1889 %f name, taken from \"From\" field, address if no name
1890 %T full \"To\" field
1891 %t first name in \"To\" field, address if no name
1892 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1893 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1898 You may use normal field width specification between the % and the letter.
1899 This is for example useful to limit the length of the subject.
1901 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1902 :group
'org-link-store
1905 (defcustom org-from-is-user-regexp
1907 (when (and user-mail-address
(not (string= user-mail-address
"")))
1908 (setq r1
(concat "\\<" (regexp-quote user-mail-address
) "\\>")))
1909 (when (and user-full-name
(not (string= user-full-name
"")))
1910 (setq r2
(concat "\\<" (regexp-quote user-full-name
) "\\>")))
1911 (if (and r1 r2
) (concat r1
"\\|" r2
) (or r1 r2
)))
1912 "Regexp matched against the \"From:\" header of an email or usenet message.
1913 It should match if the message is from the user him/herself."
1914 :group
'org-link-store
1917 (defcustom org-context-in-file-links t
1918 "Non-nil means file links from `org-store-link' contain context.
1919 A search string will be added to the file name with :: as separator and
1920 used to find the context when the link is activated by the command
1921 `org-open-at-point'. When this option is t, the entire active region
1922 will be placed in the search string of the file link. If set to a
1923 positive integer, only the first n lines of context will be stored.
1925 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1926 negates this setting for the duration of the command."
1927 :group
'org-link-store
1928 :type
'(choice boolean integer
))
1930 (defcustom org-keep-stored-link-after-insertion nil
1931 "Non-nil means keep link in list for entire session.
1933 The command `org-store-link' adds a link pointing to the current
1934 location to an internal list. These links accumulate during a session.
1935 The command `org-insert-link' can be used to insert links into any
1936 Org-mode file (offering completion for all stored links). When this
1937 option is nil, every link which has been inserted once using \\[org-insert-link]
1938 will be removed from the list, to make completing the unused links
1940 :group
'org-link-store
1943 (defgroup org-link-follow nil
1944 "Options concerning following links in Org-mode."
1945 :tag
"Org Follow Link"
1948 (defcustom org-link-translation-function nil
1949 "Function to translate links with different syntax to Org syntax.
1950 This can be used to translate links created for example by the Planner
1951 or emacs-wiki packages to Org syntax.
1952 The function must accept two parameters, a TYPE containing the link
1953 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1954 which is everything after the link protocol. It should return a cons
1955 with possibly modified values of type and path.
1956 Org contains a function for this, so if you set this variable to
1957 `org-translate-link-from-planner', you should be able follow many
1958 links created by planner."
1959 :group
'org-link-follow
1960 :type
'(choice (const nil
) (function)))
1962 (defcustom org-follow-link-hook nil
1963 "Hook that is run after a link has been followed."
1964 :group
'org-link-follow
1967 (defcustom org-tab-follows-link nil
1968 "Non-nil means on links TAB will follow the link.
1969 Needs to be set before org.el is loaded.
1970 This really should not be used, it does not make sense, and the
1971 implementation is bad."
1972 :group
'org-link-follow
1975 (defcustom org-return-follows-link nil
1976 "Non-nil means on links RET will follow the link.
1977 In tables, the special behavior of RET has precedence."
1978 :group
'org-link-follow
1981 (defcustom org-mouse-1-follows-link
1982 (if (boundp 'mouse-1-click-follows-link
) mouse-1-click-follows-link t
)
1983 "Non-nil means mouse-1 on a link will follow the link.
1984 A longer mouse click will still set point. Does not work on XEmacs.
1985 Needs to be set before org.el is loaded."
1986 :group
'org-link-follow
1988 :package-version
'(Org .
"8.3")
1990 (const :tag
"A double click follows the link" double
)
1991 (const :tag
"Unconditionally follow the link with mouse-1" t
)
1992 (integer :tag
"mouse-1 click does not follow the link if longer than N ms" 450)))
1994 (defcustom org-mark-ring-length
4
1995 "Number of different positions to be recorded in the ring.
1996 Changing this requires a restart of Emacs to work correctly."
1997 :group
'org-link-follow
2000 (defcustom org-link-search-must-match-exact-headline
'query-to-create
2001 "Non-nil means internal links in Org files must exactly match a headline.
2002 When nil, the link search tries to match a phrase with all words
2003 in the search text."
2004 :group
'org-link-follow
2007 (const :tag
"Use fuzzy text search" nil
)
2008 (const :tag
"Match only exact headline" t
)
2009 (const :tag
"Match exact headline or query to create it"
2012 (defcustom org-link-frame-setup
2013 '((vm . vm-visit-folder-other-frame
)
2014 (vm-imap . vm-visit-imap-folder-other-frame
)
2015 (gnus . org-gnus-no-new-news
)
2016 (file . find-file-other-window
)
2017 (wl . wl-other-frame
))
2018 "Setup the frame configuration for following links.
2019 When following a link with Emacs, it may often be useful to display
2020 this link in another window or frame. This variable can be used to
2021 set this up for the different types of links.
2024 `vm-visit-folder-other-window'
2025 `vm-visit-folder-other-frame'
2026 For Gnus, use any of
2029 `org-gnus-no-new-news'
2030 For FILE, use any of
2032 `find-file-other-window'
2033 `find-file-other-frame'
2034 For Wanderlust use any of
2037 For the calendar, use the variable `calendar-setup'.
2038 For BBDB, it is currently only possible to display the matches in
2040 :group
'org-link-follow
2044 (const vm-visit-folder
)
2045 (const vm-visit-folder-other-window
)
2046 (const vm-visit-folder-other-frame
)))
2047 (cons (const vm-imap
)
2049 (const vm-visit-imap-folder
)
2050 (const vm-visit-imap-folder-other-window
)
2051 (const vm-visit-imap-folder-other-frame
)))
2055 (const gnus-other-frame
)
2056 (const org-gnus-no-new-news
)))
2060 (const find-file-other-window
)
2061 (const find-file-other-frame
)))
2065 (const wl-other-frame
)))))
2067 (defcustom org-display-internal-link-with-indirect-buffer nil
2068 "Non-nil means use indirect buffer to display infile links.
2069 Activating internal links (from one location in a file to another location
2070 in the same file) normally just jumps to the location. When the link is
2071 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2073 another window. When this option is set, the other window actually displays
2074 an indirect buffer clone of the current buffer, to avoid any visibility
2075 changes to the current buffer."
2076 :group
'org-link-follow
2079 (defcustom org-open-non-existing-files nil
2080 "Non-nil means `org-open-file' will open non-existing files.
2081 When nil, an error will be generated.
2082 This variable applies only to external applications because they
2083 might choke on non-existing files. If the link is to a file that
2084 will be opened in Emacs, the variable is ignored."
2085 :group
'org-link-follow
2088 (defcustom org-open-directory-means-index-dot-org nil
2089 "Non-nil means a link to a directory really means to index.org.
2090 When nil, following a directory link will run dired or open a finder/explorer
2091 window on that directory."
2092 :group
'org-link-follow
2095 (defcustom org-confirm-shell-link-function
'yes-or-no-p
2096 "Non-nil means ask for confirmation before executing shell links.
2097 Shell links can be dangerous: just think about a link
2099 [[shell:rm -rf ~/*][Google Search]]
2101 This link would show up in your Org-mode document as \"Google Search\",
2102 but really it would remove your entire home directory.
2103 Therefore we advise against setting this variable to nil.
2104 Just change it to `y-or-n-p' if you want to confirm with a
2105 single keystroke rather than having to type \"yes\"."
2106 :group
'org-link-follow
2108 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2109 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2110 (const :tag
"no confirmation (dangerous)" nil
)))
2111 (put 'org-confirm-shell-link-function
2112 'safe-local-variable
2113 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2115 (defcustom org-confirm-shell-link-not-regexp
""
2116 "A regexp to skip confirmation for shell links."
2117 :group
'org-link-follow
2121 (defcustom org-confirm-elisp-link-function
'yes-or-no-p
2122 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2123 Elisp links can be dangerous: just think about a link
2125 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2127 This link would show up in your Org-mode document as \"Google Search\",
2128 but really it would remove your entire home directory.
2129 Therefore we advise against setting this variable to nil.
2130 Just change it to `y-or-n-p' if you want to confirm with a
2131 single keystroke rather than having to type \"yes\"."
2132 :group
'org-link-follow
2134 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2135 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2136 (const :tag
"no confirmation (dangerous)" nil
)))
2137 (put 'org-confirm-shell-link-function
2138 'safe-local-variable
2139 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2141 (defcustom org-confirm-elisp-link-not-regexp
""
2142 "A regexp to skip confirmation for Elisp links."
2143 :group
'org-link-follow
2147 (defconst org-file-apps-defaults-gnu
2151 "Default file applications on a UNIX or GNU/Linux system.
2152 See `org-file-apps'.")
2154 (defconst org-file-apps-defaults-macosx
2157 (system .
"open %s")
2159 ("eps.gz" .
"gv %s")
2161 ("fig" .
"xfig %s"))
2162 "Default file applications on a MacOS X system.
2163 The system \"open\" is known as a default, but we use X11 applications
2164 for some files for which the OS does not have a good default.
2165 See `org-file-apps'.")
2167 (defconst org-file-apps-defaults-windowsnt
2171 (list (if (featurep 'xemacs
)
2172 'mswindows-shell-execute
2176 (list (if (featurep 'xemacs
)
2177 'mswindows-shell-execute
2180 "Default file applications on a Windows NT system.
2181 The system \"open\" is used for most files.
2182 See `org-file-apps'.")
2184 (defcustom org-file-apps
2185 '((auto-mode . emacs
)
2186 ("\\.mm\\'" . default
)
2187 ("\\.x?html?\\'" . default
)
2188 ("\\.pdf\\'" . default
))
2189 "External applications for opening `file:path' items in a document.
2190 Org-mode uses system defaults for different file types, but
2191 you can use this variable to set the application for a given file
2192 extension. The entries in this list are cons cells where the car identifies
2193 files and the cdr the corresponding command. Possible values for the
2195 \"string\" A string as a file identifier can be interpreted in different
2196 ways, depending on its contents:
2198 - Alphanumeric characters only:
2199 Match links with this file extension.
2200 Example: (\"pdf\" . \"evince %s\")
2201 to open PDFs with evince.
2203 - Regular expression: Match links where the
2204 filename matches the regexp. If you want to
2205 use groups here, use shy groups.
2207 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2208 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2209 to open *.html and *.xhtml with firefox.
2211 - Regular expression which contains (non-shy) groups:
2212 Match links where the whole link, including \"::\", and
2213 anything after that, matches the regexp.
2214 In a custom command string, %1, %2, etc. are replaced with
2215 the parts of the link that were matched by the groups.
2216 For backwards compatibility, if a command string is given
2217 that does not use any of the group matches, this case is
2218 handled identically to the second one (i.e. match against
2220 In a custom lisp form, you can access the group matches with
2221 (match-string n link).
2223 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2224 to open [[file:document.pdf::5]] with evince at page 5.
2226 `directory' Matches a directory
2227 `remote' Matches a remote file, accessible through tramp or efs.
2228 Remote files most likely should be visited through Emacs
2229 because external applications cannot handle such paths.
2230 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2231 so all files Emacs knows how to handle. Using this with
2232 command `emacs' will open most files in Emacs. Beware that this
2233 will also open html files inside Emacs, unless you add
2234 (\"html\" . default) to the list as well.
2235 t Default for files not matched by any of the other options.
2236 `system' The system command to open files, like `open' on Windows
2237 and Mac OS X, and mailcap under GNU/Linux. This is the command
2238 that will be selected if you call `C-c C-o' with a double
2239 \\[universal-argument] \\[universal-argument] prefix.
2241 Possible values for the command are:
2242 `emacs' The file will be visited by the current Emacs process.
2243 `default' Use the default application for this file type, which is the
2244 association for t in the list, most likely in the system-specific
2246 This can be used to overrule an unwanted setting in the
2247 system-specific variable.
2248 `system' Use the system command for opening files, like \"open\".
2249 This command is specified by the entry whose car is `system'.
2250 Most likely, the system-specific version of this variable
2251 does define this command, but you can overrule/replace it
2253 string A command to be executed by a shell; %s will be replaced
2254 by the path to the file.
2255 sexp A Lisp form which will be evaluated. The file path will
2256 be available in the Lisp variable `file'.
2257 For more examples, see the system specific constants
2258 `org-file-apps-defaults-macosx'
2259 `org-file-apps-defaults-windowsnt'
2260 `org-file-apps-defaults-gnu'."
2261 :group
'org-link-follow
2263 (cons (choice :value
""
2264 (string :tag
"Extension")
2265 (const :tag
"System command to open files" system
)
2266 (const :tag
"Default for unrecognized files" t
)
2267 (const :tag
"Remote file" remote
)
2268 (const :tag
"Links to a directory" directory
)
2269 (const :tag
"Any files that have Emacs modes"
2272 (const :tag
"Visit with Emacs" emacs
)
2273 (const :tag
"Use default" default
)
2274 (const :tag
"Use the system command" system
)
2275 (string :tag
"Command")
2276 (sexp :tag
"Lisp form")))))
2278 (defcustom org-doi-server-url
"http://dx.doi.org/"
2279 "The URL of the DOI server."
2282 :group
'org-link-follow
)
2284 (defgroup org-refile nil
2285 "Options concerning refiling entries in Org-mode."
2289 (defcustom org-directory
"~/org"
2290 "Directory with org files.
2291 This is just a default location to look for Org files. There is no need
2292 at all to put your files into this directory. It is only used in the
2293 following situations:
2295 1. When a capture template specifies a target file that is not an
2296 absolute path. The path will then be interpreted relative to
2298 2. When a capture note is filed away in an interactive way (when exiting the
2299 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2300 with `org-directory' as the default path."
2305 (defcustom org-default-notes-file
(convert-standard-filename "~/.notes")
2306 "Default target for storing notes.
2307 Used as a fall back file for org-capture.el, for templates that
2308 do not specify a target file."
2313 (defcustom org-goto-interface
'outline
2314 "The default interface to be used for `org-goto'.
2316 outline The interface shows an outline of the relevant file
2317 and the correct heading is found by moving through
2318 the outline or by searching with incremental search.
2319 outline-path-completion Headlines in the current buffer are offered via
2320 completion. This is the interface also used by
2321 the refile command."
2324 (const :tag
"Outline" outline
)
2325 (const :tag
"Outline-path-completion" outline-path-completion
)))
2327 (defcustom org-goto-max-level
5
2328 "Maximum target level when running `org-goto' with refile interface."
2332 (defcustom org-reverse-note-order nil
2333 "Non-nil means store new notes at the beginning of a file or entry.
2334 When nil, new notes will be filed to the end of a file or entry.
2335 This can also be a list with cons cells of regular expressions that
2336 are matched against file names, and values."
2340 (const :tag
"Reverse always" t
)
2341 (const :tag
"Reverse never" nil
)
2342 (repeat :tag
"By file name regexp"
2343 (cons regexp boolean
))))
2345 (defcustom org-log-refile nil
2346 "Information to record when a task is refiled.
2348 Possible values are:
2350 nil Don't add anything
2351 time Add a time stamp to the task
2352 note Prompt for a note and add it with template `org-log-note-headings'
2354 This option can also be set with on a per-file-basis with
2356 #+STARTUP: nologrefile
2357 #+STARTUP: logrefile
2358 #+STARTUP: lognoterefile
2360 You can have local logging settings for a subtree by setting the LOGGING
2361 property to one or more of these keywords.
2363 When bulk-refiling from the agenda, the value `note' is forbidden and
2364 will temporarily be changed to `time'."
2366 :group
'org-progress
2369 (const :tag
"No logging" nil
)
2370 (const :tag
"Record timestamp" time
)
2371 (const :tag
"Record timestamp with note." note
)))
2373 (defcustom org-refile-targets nil
2374 "Targets for refiling entries with \\[org-refile].
2375 This is a list of cons cells. Each cell contains:
2376 - a specification of the files to be considered, either a list of files,
2377 or a symbol whose function or variable value will be used to retrieve
2378 a file name or a list of file names. If you use `org-agenda-files' for
2379 that, all agenda files will be scanned for targets. Nil means consider
2380 headings in the current buffer.
2381 - A specification of how to find candidate refile targets. This may be
2383 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2384 This tag has to be present in all target headlines, inheritance will
2386 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2388 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2389 headlines that are refiling targets.
2390 - a cons cell (:level . N). Any headline of level N is considered a target.
2391 Note that, when `org-odd-levels-only' is set, level corresponds to
2392 order in hierarchy, not to the number of stars.
2393 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2394 Note that, when `org-odd-levels-only' is set, level corresponds to
2395 order in hierarchy, not to the number of stars.
2397 Each element of this list generates a set of possible targets.
2398 The union of these sets is presented (with completion) to
2399 the user by `org-refile'.
2401 You can set the variable `org-refile-target-verify-function' to a function
2402 to verify each headline found by the simple criteria above.
2404 When this variable is nil, all top-level headlines in the current buffer
2405 are used, equivalent to the value `((nil . (:level . 1))'."
2409 (choice :value org-agenda-files
2410 (const :tag
"All agenda files" org-agenda-files
)
2411 (const :tag
"Current buffer" nil
)
2412 (function) (variable) (file))
2413 (choice :tag
"Identify target headline by"
2414 (cons :tag
"Specific tag" (const :value
:tag
) (string))
2415 (cons :tag
"TODO keyword" (const :value
:todo
) (string))
2416 (cons :tag
"Regular expression" (const :value
:regexp
) (regexp))
2417 (cons :tag
"Level number" (const :value
:level
) (integer))
2418 (cons :tag
"Max Level number" (const :value
:maxlevel
) (integer))))))
2420 (defcustom org-refile-target-verify-function nil
2421 "Function to verify if the headline at point should be a refile target.
2422 The function will be called without arguments, with point at the
2423 beginning of the headline. It should return t and leave point
2424 where it is if the headline is a valid target for refiling.
2426 If the target should not be selected, the function must return nil.
2427 In addition to this, it may move point to a place from where the search
2428 should be continued. For example, the function may decide that the entire
2429 subtree of the current entry should be excluded and move point to the end
2436 (defcustom org-refile-use-cache nil
2437 "Non-nil means cache refile targets to speed up the process.
2438 The cache for a particular file will be updated automatically when
2439 the buffer has been killed, or when any of the marker used for flagging
2440 refile targets no longer points at a live buffer.
2441 If you have added new entries to a buffer that might themselves be targets,
2442 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2443 find that easier, `C-u C-u C-u C-c C-w'."
2448 (defcustom org-refile-use-outline-path nil
2449 "Non-nil means provide refile targets as paths.
2450 So a level 3 headline will be available as level1/level2/level3.
2452 When the value is `file', also include the file name (without directory)
2453 into the path. In this case, you can also stop the completion after
2454 the file name, to get entries inserted as top level in the file.
2456 When `full-file-path', include the full file path."
2459 (const :tag
"Not" nil
)
2460 (const :tag
"Yes" t
)
2461 (const :tag
"Start with file name" file
)
2462 (const :tag
"Start with full file path" full-file-path
)))
2464 (defcustom org-outline-path-complete-in-steps t
2465 "Non-nil means complete the outline path in hierarchical steps.
2466 When Org-mode uses the refile interface to select an outline path
2467 \(see variable `org-refile-use-outline-path'), the completion of
2468 the path can be done in a single go, or it can be done in steps down
2469 the headline hierarchy. Going in steps is probably the best if you
2470 do not use a special completion package like `ido' or `icicles'.
2471 However, when using these packages, going in one step can be very
2472 fast, while still showing the whole path to the entry."
2476 (defcustom org-refile-allow-creating-parent-nodes nil
2477 "Non-nil means allow to create new nodes as refile targets.
2478 New nodes are then created by adding \"/new node name\" to the completion
2479 of an existing node. When the value of this variable is `confirm',
2480 new node creation must be confirmed by the user (recommended).
2481 When nil, the completion must match an existing entry.
2483 Note that, if the new heading is not seen by the criteria
2484 listed in `org-refile-targets', multiple instances of the same
2485 heading would be created by trying again to file under the new
2489 (const :tag
"Never" nil
)
2490 (const :tag
"Always" t
)
2491 (const :tag
"Prompt for confirmation" confirm
)))
2493 (defcustom org-refile-active-region-within-subtree nil
2494 "Non-nil means also refile active region within a subtree.
2496 By default `org-refile' doesn't allow refiling regions if they
2497 don't contain a set of subtrees, but it might be convenient to
2498 do so sometimes: in that case, the first line of the region is
2499 converted to a headline before refiling."
2504 (defgroup org-todo nil
2505 "Options concerning TODO items in Org-mode."
2509 (defgroup org-progress nil
2510 "Options concerning Progress logging in Org-mode."
2514 (defvar org-todo-interpretation-widgets
2515 '((:tag
"Sequence (cycling hits every state)" sequence
)
2516 (:tag
"Type (cycling directly to DONE)" type
))
2517 "The available interpretation symbols for customizing `org-todo-keywords'.
2518 Interested libraries should add to this list.")
2520 (defcustom org-todo-keywords
'((sequence "TODO" "DONE"))
2521 "List of TODO entry keyword sequences and their interpretation.
2522 \\<org-mode-map>This is a list of sequences.
2524 Each sequence starts with a symbol, either `sequence' or `type',
2525 indicating if the keywords should be interpreted as a sequence of
2526 action steps, or as different types of TODO items. The first
2527 keywords are states requiring action - these states will select a headline
2528 for inclusion into the global TODO list Org-mode produces. If one of
2529 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2530 signify that no further action is necessary. If \"|\" is not found,
2531 the last keyword is treated as the only DONE state of the sequence.
2533 The command \\[org-todo] cycles an entry through these states, and one
2534 additional state where no keyword is present. For details about this
2535 cycling, see the manual.
2537 TODO keywords and interpretation can also be set on a per-file basis with
2538 the special #+SEQ_TODO and #+TYP_TODO lines.
2540 Each keyword can optionally specify a character for fast state selection
2541 \(in combination with the variable `org-use-fast-todo-selection')
2542 and specifiers for state change logging, using the same syntax that
2543 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2544 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2545 indicates to record a time stamp each time this state is selected.
2547 Each keyword may also specify if a timestamp or a note should be
2548 recorded when entering or leaving the state, by adding additional
2549 characters in the parenthesis after the keyword. This looks like this:
2550 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2551 record only the time of the state change. With X and Y being either
2552 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2553 Y when leaving the state if and only if the *target* state does not
2554 define X. You may omit any of the fast-selection key or X or /Y,
2555 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2557 For backward compatibility, this variable may also be just a list
2558 of keywords. In this case the interpretation (sequence or type) will be
2559 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2561 :group
'org-keywords
2563 (repeat :tag
"Old syntax, just keywords"
2564 (string :tag
"Keyword"))
2565 (repeat :tag
"New syntax"
2568 :tag
"Interpretation"
2569 ;;Quick and dirty way to see
2570 ;;`org-todo-interpretations'. This takes the
2571 ;;place of item arguments
2579 org-todo-interpretation-widgets
))
2582 (string :tag
"Keyword"))))))
2584 (defvar org-todo-keywords-1 nil
2585 "All TODO and DONE keywords active in a buffer.")
2586 (make-variable-buffer-local 'org-todo-keywords-1
)
2587 (defvar org-todo-keywords-for-agenda nil
)
2588 (defvar org-done-keywords-for-agenda nil
)
2589 (defvar org-todo-keyword-alist-for-agenda nil
)
2590 (defvar org-tag-alist-for-agenda nil
2591 "Alist of all tags from all agenda files.")
2592 (defvar org-tag-groups-alist-for-agenda nil
2593 "Alist of all groups tags from all current agenda files.")
2594 (defvar org-tag-groups-alist nil
)
2595 (make-variable-buffer-local 'org-tag-groups-alist
)
2596 (defvar org-agenda-contributing-files nil
)
2597 (defvar org-not-done-keywords nil
)
2598 (make-variable-buffer-local 'org-not-done-keywords
)
2599 (defvar org-done-keywords nil
)
2600 (make-variable-buffer-local 'org-done-keywords
)
2601 (defvar org-todo-heads nil
)
2602 (make-variable-buffer-local 'org-todo-heads
)
2603 (defvar org-todo-sets nil
)
2604 (make-variable-buffer-local 'org-todo-sets
)
2605 (defvar org-todo-log-states nil
)
2606 (make-variable-buffer-local 'org-todo-log-states
)
2607 (defvar org-todo-kwd-alist nil
)
2608 (make-variable-buffer-local 'org-todo-kwd-alist
)
2609 (defvar org-todo-key-alist nil
)
2610 (make-variable-buffer-local 'org-todo-key-alist
)
2611 (defvar org-todo-key-trigger nil
)
2612 (make-variable-buffer-local 'org-todo-key-trigger
)
2614 (defcustom org-todo-interpretation
'sequence
2615 "Controls how TODO keywords are interpreted.
2616 This variable is in principle obsolete and is only used for
2617 backward compatibility, if the interpretation of todo keywords is
2618 not given already in `org-todo-keywords'. See that variable for
2621 :group
'org-keywords
2622 :type
'(choice (const sequence
)
2625 (defcustom org-use-fast-todo-selection t
2626 "Non-nil means use the fast todo selection scheme with C-c C-t.
2627 This variable describes if and under what circumstances the cycling
2628 mechanism for TODO keywords will be replaced by a single-key, direct
2631 When nil, fast selection is never used.
2633 When the symbol `prefix', it will be used when `org-todo' is called
2634 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2635 `C-u t' in an agenda buffer.
2637 When t, fast selection is used by default. In this case, the prefix
2638 argument forces cycling instead.
2640 In all cases, the special interface is only used if access keys have
2641 actually been assigned by the user, i.e. if keywords in the configuration
2642 are followed by a letter in parenthesis, like TODO(t)."
2645 (const :tag
"Never" nil
)
2646 (const :tag
"By default" t
)
2647 (const :tag
"Only with C-u C-c C-t" prefix
)))
2649 (defcustom org-provide-todo-statistics t
2650 "Non-nil means update todo statistics after insert and toggle.
2651 ALL-HEADLINES means update todo statistics by including headlines
2652 with no TODO keyword as well, counting them as not done.
2653 A list of TODO keywords means the same, but skip keywords that are
2655 When set to a list of two lists, the first list contains keywords
2656 to consider as TODO keywords, the second list contains keywords
2657 to consider as DONE keywords.
2659 When this is set, todo statistics is updated in the parent of the
2660 current entry each time a todo state is changed."
2663 (const :tag
"Yes, only for TODO entries" t
)
2664 (const :tag
"Yes, including all entries" all-headlines
)
2665 (repeat :tag
"Yes, for TODOs in this list"
2666 (string :tag
"TODO keyword"))
2667 (list :tag
"Yes, for TODOs and DONEs in these lists"
2668 (repeat (string :tag
"TODO keyword"))
2669 (repeat (string :tag
"DONE keyword")))
2670 (other :tag
"No TODO statistics" nil
)))
2672 (defcustom org-hierarchical-todo-statistics t
2673 "Non-nil means TODO statistics covers just direct children.
2674 When nil, all entries in the subtree are considered.
2675 This has only an effect if `org-provide-todo-statistics' is set.
2676 To set this to nil for only a single subtree, use a COOKIE_DATA
2677 property and include the word \"recursive\" into the value."
2681 (defcustom org-after-todo-state-change-hook nil
2682 "Hook which is run after the state of a TODO item was changed.
2683 The new state (a string with a TODO keyword, or nil) is available in the
2684 Lisp variable `org-state'."
2688 (defvar org-blocker-hook nil
2689 "Hook for functions that are allowed to block a state change.
2691 Functions in this hook should not modify the buffer.
2692 Each function gets as its single argument a property list,
2693 see `org-trigger-hook' for more information about this list.
2695 If any of the functions in this hook returns nil, the state change
2698 (defvar org-trigger-hook nil
2699 "Hook for functions that are triggered by a state change.
2701 Each function gets as its single argument a property list with at
2702 least the following elements:
2704 (:type type-of-change :position pos-at-entry-start
2705 :from old-state :to new-state)
2707 Depending on the type, more properties may be present.
2709 This mechanism is currently implemented for:
2713 :type todo-state-change
2714 :from previous state (keyword as a string), or nil, or a symbol
2715 'todo' or 'done', to indicate the general type of state.
2716 :to new state, like in :from")
2718 (defcustom org-enforce-todo-dependencies nil
2719 "Non-nil means undone TODO entries will block switching the parent to DONE.
2720 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2721 be blocked if any prior sibling is not yet done.
2722 Finally, if the parent is blocked because of ordered siblings of its own,
2723 the child will also be blocked."
2724 :set
(lambda (var val
)
2727 (add-hook 'org-blocker-hook
2728 'org-block-todo-from-children-or-siblings-or-parent
)
2729 (remove-hook 'org-blocker-hook
2730 'org-block-todo-from-children-or-siblings-or-parent
)))
2734 (defcustom org-enforce-todo-checkbox-dependencies nil
2735 "Non-nil means unchecked boxes will block switching the parent to DONE.
2736 When this is nil, checkboxes have no influence on switching TODO states.
2737 When non-nil, you first need to check off all check boxes before the TODO
2738 entry can be switched to DONE.
2739 This variable needs to be set before org.el is loaded, and you need to
2740 restart Emacs after a change to make the change effective. The only way
2741 to change is while Emacs is running is through the customize interface."
2742 :set
(lambda (var val
)
2745 (add-hook 'org-blocker-hook
2746 'org-block-todo-from-checkboxes
)
2747 (remove-hook 'org-blocker-hook
2748 'org-block-todo-from-checkboxes
)))
2752 (defcustom org-treat-insert-todo-heading-as-state-change nil
2753 "Non-nil means inserting a TODO heading is treated as state change.
2754 So when the command \\[org-insert-todo-heading] is used, state change
2755 logging will apply if appropriate. When nil, the new TODO item will
2756 be inserted directly, and no logging will take place."
2760 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2761 "Non-nil means switching TODO states with S-cursor counts as state change.
2762 This is the default behavior. However, setting this to nil allows a
2763 convenient way to select a TODO state and bypass any logging associated
2768 (defcustom org-todo-state-tags-triggers nil
2769 "Tag changes that should be triggered by TODO state changes.
2770 This is a list. Each entry is
2772 (state-change (tag . flag) .......)
2774 State-change can be a string with a state, and empty string to indicate the
2775 state that has no TODO keyword, or it can be one of the symbols `todo'
2776 or `done', meaning any not-done or done state, respectively."
2780 (cons (choice :tag
"When changing to"
2781 (const :tag
"Not-done state" todo
)
2782 (const :tag
"Done state" done
)
2783 (string :tag
"State"))
2785 (cons :tag
"Tag action"
2787 (choice (const :tag
"Add" t
) (const :tag
"Remove" nil
)))))))
2789 (defcustom org-log-done nil
2790 "Information to record when a task moves to the DONE state.
2792 Possible values are:
2794 nil Don't add anything, just change the keyword
2795 time Add a time stamp to the task
2796 note Prompt for a note and add it with template `org-log-note-headings'
2798 This option can also be set with on a per-file-basis with
2800 #+STARTUP: nologdone
2802 #+STARTUP: lognotedone
2804 You can have local logging settings for a subtree by setting the LOGGING
2805 property to one or more of these keywords."
2807 :group
'org-progress
2809 (const :tag
"No logging" nil
)
2810 (const :tag
"Record CLOSED timestamp" time
)
2811 (const :tag
"Record CLOSED timestamp with note." note
)))
2813 ;; Normalize old uses of org-log-done.
2815 ((eq org-log-done t
) (setq org-log-done
'time
))
2816 ((and (listp org-log-done
) (memq 'done org-log-done
))
2817 (setq org-log-done
'note
)))
2819 (defcustom org-log-reschedule nil
2820 "Information to record when the scheduling date of a tasks is modified.
2822 Possible values are:
2824 nil Don't add anything, just change the date
2825 time Add a time stamp to the task
2826 note Prompt for a note and add it with template `org-log-note-headings'
2828 This option can also be set with on a per-file-basis with
2830 #+STARTUP: nologreschedule
2831 #+STARTUP: logreschedule
2832 #+STARTUP: lognotereschedule"
2834 :group
'org-progress
2836 (const :tag
"No logging" nil
)
2837 (const :tag
"Record timestamp" time
)
2838 (const :tag
"Record timestamp with note." note
)))
2840 (defcustom org-log-redeadline nil
2841 "Information to record when the deadline date of a tasks is modified.
2843 Possible values are:
2845 nil Don't add anything, just change the date
2846 time Add a time stamp to the task
2847 note Prompt for a note and add it with template `org-log-note-headings'
2849 This option can also be set with on a per-file-basis with
2851 #+STARTUP: nologredeadline
2852 #+STARTUP: logredeadline
2853 #+STARTUP: lognoteredeadline
2855 You can have local logging settings for a subtree by setting the LOGGING
2856 property to one or more of these keywords."
2858 :group
'org-progress
2860 (const :tag
"No logging" nil
)
2861 (const :tag
"Record timestamp" time
)
2862 (const :tag
"Record timestamp with note." note
)))
2864 (defcustom org-log-note-clock-out nil
2865 "Non-nil means record a note when clocking out of an item.
2866 This can also be configured on a per-file basis by adding one of
2867 the following lines anywhere in the buffer:
2869 #+STARTUP: lognoteclock-out
2870 #+STARTUP: nolognoteclock-out"
2872 :group
'org-progress
2875 (defcustom org-log-done-with-time t
2876 "Non-nil means the CLOSED time stamp will contain date and time.
2877 When nil, only the date will be recorded."
2878 :group
'org-progress
2881 (defcustom org-log-note-headings
2882 '((done .
"CLOSING NOTE %t")
2883 (state .
"State %-12s from %-12S %t")
2884 (note .
"Note taken on %t")
2885 (reschedule .
"Rescheduled from %S on %t")
2886 (delschedule .
"Not scheduled, was %S on %t")
2887 (redeadline .
"New deadline from %S on %t")
2888 (deldeadline .
"Removed deadline, was %S on %t")
2889 (refile .
"Refiled on %t")
2891 "Headings for notes added to entries.
2893 The value is an alist, with the car being a symbol indicating the
2894 note context, and the cdr is the heading to be used. The heading
2895 may also be the empty string. The following placeholders can be
2899 %T an active time stamp instead the default inactive one
2900 %d a short-format time stamp.
2901 %D an active short-format time stamp.
2902 %s the new TODO state or time stamp (inactive), in double quotes.
2903 %S the old TODO state or time stamp (inactive), in double quotes.
2907 In fact, it is not a good idea to change the `state' entry,
2908 because Agenda Log mode depends on the format of these entries."
2910 :group
'org-progress
2911 :type
'(list :greedy t
2912 (cons (const :tag
"Heading when closing an item" done
) string
)
2914 "Heading when changing todo state (todo sequence only)"
2916 (cons (const :tag
"Heading when just taking a note" note
) string
)
2917 (cons (const :tag
"Heading when rescheduling" reschedule
) string
)
2918 (cons (const :tag
"Heading when an item is no longer scheduled" delschedule
) string
)
2919 (cons (const :tag
"Heading when changing deadline" redeadline
) string
)
2920 (cons (const :tag
"Heading when deleting a deadline" deldeadline
) string
)
2921 (cons (const :tag
"Heading when refiling" refile
) string
)
2922 (cons (const :tag
"Heading when clocking out" clock-out
) string
)))
2924 (unless (assq 'note org-log-note-headings
)
2925 (push '(note .
"%t") org-log-note-headings
))
2927 (defcustom org-log-into-drawer nil
2928 "Non-nil means insert state change notes and time stamps into a drawer.
2929 When nil, state changes notes will be inserted after the headline and
2930 any scheduling and clock lines, but not inside a drawer.
2932 The value of this variable should be the name of the drawer to use.
2933 LOGBOOK is proposed as the default drawer for this purpose, you can
2934 also set this to a string to define the drawer of your choice.
2936 A value of t is also allowed, representing \"LOGBOOK\".
2938 A value of t or nil can also be set with on a per-file-basis with
2940 #+STARTUP: logdrawer
2941 #+STARTUP: nologdrawer
2943 If this variable is set, `org-log-state-notes-insert-after-drawers'
2946 You can set the property LOG_INTO_DRAWER to overrule this setting for
2949 Do not check directly this variable in a Lisp program. Call
2950 function `org-log-into-drawer' instead."
2952 :group
'org-progress
2954 (const :tag
"Not into a drawer" nil
)
2955 (const :tag
"LOGBOOK" t
)
2956 (string :tag
"Other")))
2958 (org-defvaralias 'org-log-state-notes-into-drawer
'org-log-into-drawer
)
2960 (defun org-log-into-drawer ()
2961 "Name of the log drawer, as a string, or nil.
2962 This is the value of `org-log-into-drawer'. However, if the
2963 current entry has or inherits a LOG_INTO_DRAWER property, it will
2964 be used instead of the default value."
2965 (let ((p (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit t
)))
2966 (cond ((equal p
"nil") nil
)
2967 ((equal p
"t") "LOGBOOK")
2970 ((stringp org-log-into-drawer
) org-log-into-drawer
)
2971 (org-log-into-drawer "LOGBOOK"))))
2973 (defcustom org-log-state-notes-insert-after-drawers nil
2974 "Non-nil means insert state change notes after any drawers in entry.
2975 Only the drawers that *immediately* follow the headline and the
2976 deadline/scheduled line are skipped.
2977 When nil, insert notes right after the heading and perhaps the line
2978 with deadline/scheduling if present.
2980 This variable will have no effect if `org-log-into-drawer' is
2983 :group
'org-progress
2986 (defcustom org-log-states-order-reversed t
2987 "Non-nil means the latest state note will be directly after heading.
2988 When nil, the state change notes will be ordered according to time.
2990 This option can also be set with on a per-file-basis with
2992 #+STARTUP: logstatesreversed
2993 #+STARTUP: nologstatesreversed"
2995 :group
'org-progress
2998 (defcustom org-todo-repeat-to-state nil
2999 "The TODO state to which a repeater should return the repeating task.
3000 By default this is the first task in a TODO sequence, or the previous state
3001 in a TODO_TYP set. But you can specify another task here.
3002 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3005 :type
'(choice (const :tag
"Head of sequence" nil
)
3006 (string :tag
"Specific state")))
3008 (defcustom org-log-repeat
'time
3009 "Non-nil means record moving through the DONE state when triggering repeat.
3010 An auto-repeating task is immediately switched back to TODO when
3011 marked DONE. If you are not logging state changes (by adding \"@\"
3012 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3013 record a closing note, there will be no record of the task moving
3014 through DONE. This variable forces taking a note anyway.
3016 nil Don't force a record
3017 time Record a time stamp
3018 note Prompt for a note and add it with template `org-log-note-headings'
3020 This option can also be set with on a per-file-basis with
3022 #+STARTUP: nologrepeat
3023 #+STARTUP: logrepeat
3024 #+STARTUP: lognoterepeat
3026 You can have local logging settings for a subtree by setting the LOGGING
3027 property to one or more of these keywords."
3029 :group
'org-progress
3031 (const :tag
"Don't force a record" nil
)
3032 (const :tag
"Force recording the DONE state" time
)
3033 (const :tag
"Force recording a note with the DONE state" note
)))
3036 (defgroup org-priorities nil
3037 "Priorities in Org-mode."
3038 :tag
"Org Priorities"
3041 (defcustom org-enable-priority-commands t
3042 "Non-nil means priority commands are active.
3043 When nil, these commands will be disabled, so that you never accidentally
3045 :group
'org-priorities
3048 (defcustom org-highest-priority ?A
3049 "The highest priority of TODO items. A character like ?A, ?B etc.
3050 Must have a smaller ASCII number than `org-lowest-priority'."
3051 :group
'org-priorities
3054 (defcustom org-lowest-priority ?C
3055 "The lowest priority of TODO items. A character like ?A, ?B etc.
3056 Must have a larger ASCII number than `org-highest-priority'."
3057 :group
'org-priorities
3060 (defcustom org-default-priority ?B
3061 "The default priority of TODO items.
3062 This is the priority an item gets if no explicit priority is given.
3063 When starting to cycle on an empty priority the first step in the cycle
3064 depends on `org-priority-start-cycle-with-default'. The resulting first
3065 step priority must not exceed the range from `org-highest-priority' to
3066 `org-lowest-priority' which means that `org-default-priority' has to be
3067 in this range exclusive or inclusive the range boundaries. Else the
3068 first step refuses to set the default and the second will fall back
3069 to (depending on the command used) the highest or lowest priority."
3070 :group
'org-priorities
3073 (defcustom org-priority-start-cycle-with-default t
3074 "Non-nil means start with default priority when starting to cycle.
3075 When this is nil, the first step in the cycle will be (depending on the
3076 command used) one higher or lower than the default priority.
3077 See also `org-default-priority'."
3078 :group
'org-priorities
3081 (defcustom org-get-priority-function nil
3082 "Function to extract the priority from a string.
3083 The string is normally the headline. If this is nil Org computes the
3084 priority from the priority cookie like [#A] in the headline. It returns
3085 an integer, increasing by 1000 for each priority level.
3086 The user can set a different function here, which should take a string
3087 as an argument and return the numeric priority."
3088 :group
'org-priorities
3094 (defgroup org-time nil
3095 "Options concerning time stamps and deadlines in Org-mode."
3099 (defcustom org-time-stamp-rounding-minutes
'(0 5)
3100 "Number of minutes to round time stamps to.
3101 These are two values, the first applies when first creating a time stamp.
3102 The second applies when changing it with the commands `S-up' and `S-down'.
3103 When changing the time stamp, this means that it will change in steps
3104 of N minutes, as given by the second value.
3106 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3107 numbers should be factors of 60, so for example 5, 10, 15.
3109 When this is larger than 1, you can still force an exact time stamp by using
3110 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3111 and by using a prefix arg to `S-up/down' to specify the exact number
3112 of minutes to shift."
3114 :get
(lambda (var) ; Make sure both elements are there
3115 (if (integerp (default-value var
))
3116 (list (default-value var
) 5)
3117 (default-value var
)))
3119 (integer :tag
"when inserting times")
3120 (integer :tag
"when modifying times")))
3122 ;; Normalize old customizations of this variable.
3123 (when (integerp org-time-stamp-rounding-minutes
)
3124 (setq org-time-stamp-rounding-minutes
3125 (list org-time-stamp-rounding-minutes
3126 org-time-stamp-rounding-minutes
)))
3128 (defcustom org-display-custom-times nil
3129 "Non-nil means overlay custom formats over all time stamps.
3130 The formats are defined through the variable `org-time-stamp-custom-formats'.
3131 To turn this on on a per-file basis, insert anywhere in the file:
3132 #+STARTUP: customtime"
3136 (make-variable-buffer-local 'org-display-custom-times
)
3138 (defcustom org-time-stamp-custom-formats
3139 '("<%m/%d/%y %a>" .
"<%m/%d/%y %a %H:%M>") ; american
3140 "Custom formats for time stamps. See `format-time-string' for the syntax.
3141 These are overlaid over the default ISO format if the variable
3142 `org-display-custom-times' is set. Time like %H:%M should be at the
3143 end of the second format. The custom formats are also honored by export
3144 commands, if custom time display is turned on at the time of export."
3148 (defun org-time-stamp-format (&optional long inactive
)
3149 "Get the right format for a time string."
3150 (let ((f (if long
(cdr org-time-stamp-formats
)
3151 (car org-time-stamp-formats
))))
3153 (concat "[" (substring f
1 -
1) "]")
3156 (defcustom org-time-clocksum-format
3157 '(:days
"%dd " :hours
"%d" :require-hours t
:minutes
":%02d" :require-minutes t
)
3158 "The format string used when creating CLOCKSUM lines.
3159 This is also used when Org mode generates a time duration.
3161 The value can be a single format string containing two
3162 %-sequences, which will be filled with the number of hours and
3163 minutes in that order.
3165 Alternatively, the value can be a plist associating any of the
3166 keys :years, :months, :weeks, :days, :hours or :minutes with
3167 format strings. The time duration is formatted using only the
3168 time components that are needed and concatenating the results.
3169 If a time unit in absent, it falls back to the next smallest
3172 The keys :require-years, :require-months, :require-days,
3173 :require-weeks, :require-hours, :require-minutes are also
3174 meaningful. A non-nil value for these keys indicates that the
3175 corresponding time component should always be included, even if
3181 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3184 means durations longer than a day will be expressed in days,
3185 hours and minutes, and durations less than a day will always be
3186 expressed in hours and minutes (even for durations less than an
3191 \(:days \"%dd\" :minutes \"%dm\")
3193 means durations longer than a day will be expressed in days and
3194 minutes, and durations less than a day will be expressed entirely
3195 in minutes (even for durations longer than an hour)."
3199 :package-version
'(Org .
"8.0")
3200 :type
'(choice (string :tag
"Format string")
3202 (group :inline t
(const :tag
"Years" :years
)
3203 (string :tag
"Format string"))
3205 (const :tag
"Always show years" :require-years
)
3207 (group :inline t
(const :tag
"Months" :months
)
3208 (string :tag
"Format string"))
3210 (const :tag
"Always show months" :require-months
)
3212 (group :inline t
(const :tag
"Weeks" :weeks
)
3213 (string :tag
"Format string"))
3215 (const :tag
"Always show weeks" :require-weeks
)
3217 (group :inline t
(const :tag
"Days" :days
)
3218 (string :tag
"Format string"))
3220 (const :tag
"Always show days" :require-days
)
3222 (group :inline t
(const :tag
"Hours" :hours
)
3223 (string :tag
"Format string"))
3225 (const :tag
"Always show hours" :require-hours
)
3227 (group :inline t
(const :tag
"Minutes" :minutes
)
3228 (string :tag
"Format string"))
3230 (const :tag
"Always show minutes" :require-minutes
)
3233 (defcustom org-time-clocksum-use-fractional nil
3234 "When non-nil, \\[org-clock-display] uses fractional times.
3235 See `org-time-clocksum-format' for more on time clock formats."
3241 (defcustom org-time-clocksum-use-effort-durations nil
3242 "When non-nil, \\[org-clock-display] uses effort durations.
3243 E.g. by default, one day is considered to be a 8 hours effort,
3244 so a task that has been clocked for 16 hours will be displayed
3245 as during 2 days in the clock display or in the clocktable.
3247 See `org-effort-durations' on how to set effort durations
3248 and `org-time-clocksum-format' for more on time clock formats."
3252 :package-version
'(Org .
"8.0")
3255 (defcustom org-time-clocksum-fractional-format
"%.2f"
3256 "The format string used when creating CLOCKSUM lines,
3257 or when Org mode generates a time duration, if
3258 `org-time-clocksum-use-fractional' is enabled.
3260 The value can be a single format string containing one
3261 %-sequence, which will be filled with the number of hours as
3264 Alternatively, the value can be a plist associating any of the
3265 keys :years, :months, :weeks, :days, :hours or :minutes with
3266 a format string. The time duration is formatted using the
3267 largest time unit which gives a non-zero integer part. If all
3268 specified formats have zero integer part, the smallest time unit
3271 :type
'(choice (string :tag
"Format string")
3272 (set (group :inline t
(const :tag
"Years" :years
)
3273 (string :tag
"Format string"))
3274 (group :inline t
(const :tag
"Months" :months
)
3275 (string :tag
"Format string"))
3276 (group :inline t
(const :tag
"Weeks" :weeks
)
3277 (string :tag
"Format string"))
3278 (group :inline t
(const :tag
"Days" :days
)
3279 (string :tag
"Format string"))
3280 (group :inline t
(const :tag
"Hours" :hours
)
3281 (string :tag
"Format string"))
3282 (group :inline t
(const :tag
"Minutes" :minutes
)
3283 (string :tag
"Format string")))))
3285 (defcustom org-deadline-warning-days
14
3286 "Number of days before expiration during which a deadline becomes active.
3287 This variable governs the display in sparse trees and in the agenda.
3288 When 0 or negative, it means use this number (the absolute value of it)
3289 even if a deadline has a different individual lead time specified.
3291 Custom commands can set this variable in the options section."
3293 :group
'org-agenda-daily
/weekly
3296 (defcustom org-scheduled-delay-days
0
3297 "Number of days before a scheduled item becomes active.
3298 This variable governs the display in sparse trees and in the agenda.
3299 The default value (i.e. 0) means: don't delay scheduled item.
3300 When negative, it means use this number (the absolute value of it)
3301 even if a scheduled item has a different individual delay time
3304 Custom commands can set this variable in the options section."
3306 :group
'org-agenda-daily
/weekly
3308 :package-version
'(Org .
"8.0")
3311 (defcustom org-read-date-prefer-future t
3312 "Non-nil means assume future for incomplete date input from user.
3313 This affects the following situations:
3314 1. The user gives a month but not a year.
3315 For example, if it is April and you enter \"feb 2\", this will be read
3316 as Feb 2, *next* year. \"May 5\", however, will be this year.
3317 2. The user gives a day, but no month.
3318 For example, if today is the 15th, and you enter \"3\", Org-mode will
3319 read this as the third of *next* month. However, if you enter \"17\",
3320 it will be considered as *this* month.
3322 If you set this variable to the symbol `time', then also the following
3325 3. If the user gives a time.
3326 If the time is before now, it will be interpreted as tomorrow.
3328 Currently none of this works for ISO week specifications.
3330 When this option is nil, the current day, month and year will always be
3333 See also `org-agenda-jump-prefer-future'."
3336 (const :tag
"Never" nil
)
3337 (const :tag
"Check month and day" t
)
3338 (const :tag
"Check month, day, and time" time
)))
3340 (defcustom org-agenda-jump-prefer-future
'org-read-date-prefer-future
3341 "Should the agenda jump command prefer the future for incomplete dates?
3342 The default is to do the same as configured in `org-read-date-prefer-future'.
3343 But you can also set a deviating value here.
3344 This may t or nil, or the symbol `org-read-date-prefer-future'."
3349 (const :tag
"Use org-read-date-prefer-future"
3350 org-read-date-prefer-future
)
3351 (const :tag
"Never" nil
)
3352 (const :tag
"Always" t
)))
3354 (defcustom org-read-date-force-compatible-dates t
3355 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3357 Depending on the system Emacs is running on, certain dates cannot
3358 be represented with the type used internally to represent time.
3359 Dates between 1970-1-1 and 2038-1-1 can always be represented
3360 correctly. Some systems allow for earlier dates, some for later,
3361 some for both. One way to find out it to insert any date into an
3362 Org buffer, putting the cursor on the year and hitting S-up and
3363 S-down to test the range.
3365 When this variable is set to t, the date/time prompt will not let
3366 you specify dates outside the 1970-2037 range, so it is certain that
3367 these dates will work in whatever version of Emacs you are
3368 running, and also that you can move a file from one Emacs implementation
3369 to another. WHenever Org is forcing the year for you, it will display
3372 When this variable is nil, Org will check if the date is
3373 representable in the specific Emacs implementation you are using.
3374 If not, it will force a year, usually the current year, and beep
3375 to remind you. Currently this setting is not recommended because
3376 the likelihood that you will open your Org files in an Emacs that
3377 has limited date range is not negligible.
3379 A workaround for this problem is to use diary sexp dates for time
3380 stamps outside of this range."
3385 (defcustom org-read-date-display-live t
3386 "Non-nil means display current interpretation of date prompt live.
3387 This display will be in an overlay, in the minibuffer."
3391 (defcustom org-read-date-popup-calendar t
3392 "Non-nil means pop up a calendar when prompting for a date.
3393 In the calendar, the date can be selected with mouse-1. However, the
3394 minibuffer will also be active, and you can simply enter the date as well.
3395 When nil, only the minibuffer will be available."
3398 (org-defvaralias 'org-popup-calendar-for-date-prompt
3399 'org-read-date-popup-calendar
)
3401 (make-obsolete-variable
3402 'org-read-date-minibuffer-setup-hook
3403 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3404 (defcustom org-read-date-minibuffer-setup-hook nil
3405 "Hook to be used to set up keys for the date/time interface.
3406 Add key definitions to `minibuffer-local-map', which will be a
3409 WARNING: This option is obsolete, you should use
3410 `org-read-date-minibuffer-local-map' to set up keys."
3414 (defcustom org-extend-today-until
0
3415 "The hour when your day really ends. Must be an integer.
3416 This has influence for the following applications:
3417 - When switching the agenda to \"today\". It it is still earlier than
3418 the time given here, the day recognized as TODAY is actually yesterday.
3419 - When a date is read from the user and it is still before the time given
3420 here, the current date and time will be assumed to be yesterday, 23:59.
3421 Also, timestamps inserted in capture templates follow this rule.
3423 IMPORTANT: This is a feature whose implementation is and likely will
3424 remain incomplete. Really, it is only here because past midnight seems to
3425 be the favorite working time of John Wiegley :-)"
3429 (defcustom org-use-effective-time nil
3430 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3431 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3432 \"effective time\" of any timestamps between midnight and 8am will be
3433 23:59 of the previous day."
3438 (defcustom org-use-last-clock-out-time-as-effective-time nil
3439 "When non-nil, use the last clock out time for `org-todo'.
3440 Note that this option has precedence over the combined use of
3441 `org-use-effective-time' and `org-extend-today-until'."
3444 :package-version
'(Org .
"8.0")
3447 (defcustom org-edit-timestamp-down-means-later nil
3448 "Non-nil means S-down will increase the time in a time stamp.
3449 When nil, S-up will increase."
3453 (defcustom org-calendar-follow-timestamp-change t
3454 "Non-nil means make the calendar window follow timestamp changes.
3455 When a timestamp is modified and the calendar window is visible, it will be
3456 moved to the new date."
3460 (defgroup org-tags nil
3461 "Options concerning tags in Org-mode."
3465 (defcustom org-tag-alist nil
3466 "List of tags allowed in Org-mode files.
3467 When this list is nil, Org-mode will base TAG input on what is already in the
3469 The value of this variable is an alist, the car of each entry must be a
3470 keyword as a string, the cdr may be a character that is used to select
3471 that tag through the fast-tag-selection interface.
3472 See the manual for details."
3476 (cons (string :tag
"Tag name")
3477 (character :tag
"Access char"))
3478 (list :tag
"Start radio group"
3480 (option (string :tag
"Group description")))
3481 (list :tag
"Start tag group, non distinct"
3482 (const :startgrouptag
)
3483 (option (string :tag
"Group description")))
3484 (list :tag
"Group tags delimiter"
3486 (list :tag
"End radio group"
3488 (option (string :tag
"Group description")))
3489 (list :tag
"End tag group, non distinct"
3490 (const :endgrouptag
)
3491 (option (string :tag
"Group description")))
3492 (const :tag
"New line" (:newline
)))))
3494 (defcustom org-tag-persistent-alist nil
3495 "List of tags that will always appear in all Org-mode files.
3496 This is in addition to any in buffer settings or customizations
3498 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3499 The value of this variable is an alist, the car of each entry must be a
3500 keyword as a string, the cdr may be a character that is used to select
3501 that tag through the fast-tag-selection interface.
3502 See the manual for details.
3503 To disable these tags on a per-file basis, insert anywhere in the file:
3508 (cons (string :tag
"Tag name")
3509 (character :tag
"Access char"))
3510 (const :tag
"Start radio group" (:startgroup
))
3511 (const :tag
"Group tags delimiter" (:grouptags
))
3512 (const :tag
"End radio group" (:endgroup
))
3513 (const :tag
"New line" (:newline
)))))
3515 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3516 "If non-nil, always offer completion for all tags of all agenda files.
3517 Instead of customizing this variable directly, you might want to
3518 set it locally for capture buffers, because there no list of
3519 tags in that file can be created dynamically (there are none).
3521 (add-hook 'org-capture-mode-hook
3523 (set (make-local-variable
3524 'org-complete-tags-always-offer-all-agenda-tags)
3530 (defvar org-file-tags nil
3531 "List of tags that can be inherited by all entries in the file.
3532 The tags will be inherited if the variable `org-use-tag-inheritance'
3533 says they should be.
3534 This variable is populated from #+FILETAGS lines.")
3536 (defcustom org-use-fast-tag-selection
'auto
3537 "Non-nil means use fast tag selection scheme.
3538 This is a special interface to select and deselect tags with single keys.
3539 When nil, fast selection is never used.
3540 When the symbol `auto', fast selection is used if and only if selection
3541 characters for tags have been configured, either through the variable
3542 `org-tag-alist' or through a #+TAGS line in the buffer.
3543 When t, fast selection is always used and selection keys are assigned
3544 automatically if necessary."
3547 (const :tag
"Always" t
)
3548 (const :tag
"Never" nil
)
3549 (const :tag
"When selection characters are configured" auto
)))
3551 (defcustom org-fast-tag-selection-single-key nil
3552 "Non-nil means fast tag selection exits after first change.
3553 When nil, you have to press RET to exit it.
3554 During fast tag selection, you can toggle this flag with `C-c'.
3555 This variable can also have the value `expert'. In this case, the window
3556 displaying the tags menu is not even shown, until you press C-c again."
3559 (const :tag
"No" nil
)
3560 (const :tag
"Yes" t
)
3561 (const :tag
"Expert" expert
)))
3563 (defvar org-fast-tag-selection-include-todo nil
3564 "Non-nil means fast tags selection interface will also offer TODO states.
3565 This is an undocumented feature, you should not rely on it.")
3567 (defcustom org-tags-column
(if (featurep 'xemacs
) -
76 -
77)
3568 "The column to which tags should be indented in a headline.
3569 If this number is positive, it specifies the column. If it is negative,
3570 it means that the tags should be flushright to that column. For example,
3571 -80 works well for a normal 80 character screen.
3572 When 0, place tags directly after headline text, with only one space in
3577 (defcustom org-auto-align-tags t
3578 "Non-nil keeps tags aligned when modifying headlines.
3579 Some operations (i.e. demoting) change the length of a headline and
3580 therefore shift the tags around. With this option turned on, after
3581 each such operation the tags are again aligned to `org-tags-column'."
3585 (defcustom org-use-tag-inheritance t
3586 "Non-nil means tags in levels apply also for sublevels.
3587 When nil, only the tags directly given in a specific line apply there.
3588 This may also be a list of tags that should be inherited, or a regexp that
3589 matches tags that should be inherited. Additional control is possible
3590 with the variable `org-tags-exclude-from-inheritance' which gives an
3591 explicit list of tags to be excluded from inheritance, even if the value of
3592 `org-use-tag-inheritance' would select it for inheritance.
3594 If this option is t, a match early-on in a tree can lead to a large
3595 number of matches in the subtree when constructing the agenda or creating
3596 a sparse tree. If you only want to see the first match in a tree during
3597 a search, check out the variable `org-tags-match-list-sublevels'."
3600 (const :tag
"Not" nil
)
3601 (const :tag
"Always" t
)
3602 (repeat :tag
"Specific tags" (string :tag
"Tag"))
3603 (regexp :tag
"Tags matched by regexp")))
3605 (defcustom org-tags-exclude-from-inheritance nil
3606 "List of tags that should never be inherited.
3607 This is a way to exclude a few tags from inheritance. For way to do
3608 the opposite, to actively allow inheritance for selected tags,
3609 see the variable `org-use-tag-inheritance'."
3611 :type
'(repeat (string :tag
"Tag")))
3613 (defun org-tag-inherit-p (tag)
3614 "Check if TAG is one that should be inherited."
3616 ((member tag org-tags-exclude-from-inheritance
) nil
)
3617 ((eq org-use-tag-inheritance t
) t
)
3618 ((not org-use-tag-inheritance
) nil
)
3619 ((stringp org-use-tag-inheritance
)
3620 (string-match org-use-tag-inheritance tag
))
3621 ((listp org-use-tag-inheritance
)
3622 (member tag org-use-tag-inheritance
))
3623 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3625 (defcustom org-tags-match-list-sublevels t
3626 "Non-nil means list also sublevels of headlines matching a search.
3627 This variable applies to tags/property searches, and also to stuck
3628 projects because this search is based on a tags match as well.
3630 When set to the symbol `indented', sublevels are indented with
3633 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3634 the sublevels of a headline matching a tag search often also match
3635 the same search. Listing all of them can create very long lists.
3636 Setting this variable to nil causes subtrees of a match to be skipped.
3638 This variable is semi-obsolete and probably should always be true. It
3639 is better to limit inheritance to certain tags using the variables
3640 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3643 (const :tag
"No, don't list them" nil
)
3644 (const :tag
"Yes, do list them" t
)
3645 (const :tag
"List them, indented with leading dots" indented
)))
3647 (defcustom org-tags-sort-function nil
3648 "When set, tags are sorted using this function as a comparator."
3651 (const :tag
"No sorting" nil
)
3652 (const :tag
"Alphabetical" string
<)
3653 (const :tag
"Reverse alphabetical" string
>)
3654 (function :tag
"Custom function" nil
)))
3656 (defvar org-tags-history nil
3657 "History of minibuffer reads for tags.")
3658 (defvar org-last-tags-completion-table nil
3659 "The last used completion table for tags.")
3660 (defvar org-after-tags-change-hook nil
3661 "Hook that is run after the tags in a line have changed.")
3663 (defgroup org-properties nil
3664 "Options concerning properties in Org-mode."
3665 :tag
"Org Properties"
3668 (defcustom org-property-format
"%-10s %s"
3669 "How property key/value pairs should be formatted by `indent-line'.
3670 When `indent-line' hits a property definition, it will format the line
3671 according to this format, mainly to make sure that the values are
3672 lined-up with respect to each other."
3673 :group
'org-properties
3676 (defcustom org-properties-postprocess-alist nil
3677 "Alist of properties and functions to adjust inserted values.
3678 Elements of this alist must be of the form
3680 ([string] [function])
3682 where [string] must be a property name and [function] must be a
3683 lambda expression: this lambda expression must take one argument,
3684 the value to adjust, and return the new value as a string.
3686 For example, this element will allow the property \"Remaining\"
3687 to be updated wrt the relation between the \"Effort\" property
3688 and the clock summary:
3690 ((\"Remaining\" (lambda(value)
3691 (let ((clocksum (org-clock-sum-current-item))
3692 (effort (org-duration-string-to-minutes
3693 (org-entry-get (point) \"Effort\"))))
3694 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3695 :group
'org-properties
3697 :type
'(alist :key-type
(string :tag
"Property")
3698 :value-type
(function :tag
"Function")))
3700 (defcustom org-use-property-inheritance nil
3701 "Non-nil means properties apply also for sublevels.
3703 This setting is chiefly used during property searches. Turning it on can
3704 cause significant overhead when doing a search, which is why it is not
3707 When nil, only the properties directly given in the current entry count.
3708 When t, every property is inherited. The value may also be a list of
3709 properties that should have inheritance, or a regular expression matching
3710 properties that should be inherited.
3712 However, note that some special properties use inheritance under special
3713 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3714 and the properties ending in \"_ALL\" when they are used as descriptor
3715 for valid values of a property.
3717 Note for programmers:
3718 When querying an entry with `org-entry-get', you can control if inheritance
3719 should be used. By default, `org-entry-get' looks only at the local
3720 properties. You can request inheritance by setting the inherit argument
3721 to t (to force inheritance) or to `selective' (to respect the setting
3723 :group
'org-properties
3725 (const :tag
"Not" nil
)
3726 (const :tag
"Always" t
)
3727 (repeat :tag
"Specific properties" (string :tag
"Property"))
3728 (regexp :tag
"Properties matched by regexp")))
3730 (defun org-property-inherit-p (property)
3731 "Check if PROPERTY is one that should be inherited."
3733 ((eq org-use-property-inheritance t
) t
)
3734 ((not org-use-property-inheritance
) nil
)
3735 ((stringp org-use-property-inheritance
)
3736 (string-match org-use-property-inheritance property
))
3737 ((listp org-use-property-inheritance
)
3738 (member property org-use-property-inheritance
))
3739 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3741 (defcustom org-columns-default-format
"%25ITEM %TODO %3PRIORITY %TAGS"
3742 "The default column format, if no other format has been defined.
3743 This variable can be set on the per-file basis by inserting a line
3745 #+COLUMNS: %25ITEM ....."
3746 :group
'org-properties
3749 (defcustom org-columns-ellipses
".."
3750 "The ellipses to be used when a field in column view is truncated.
3751 When this is the empty string, as many characters as possible are shown,
3752 but then there will be no visual indication that the field has been truncated.
3753 When this is a string of length N, the last N characters of a truncated
3754 field are replaced by this string. If the column is narrower than the
3755 ellipses string, only part of the ellipses string will be shown."
3756 :group
'org-properties
3759 (defcustom org-columns-modify-value-for-display-function nil
3760 "Function that modifies values for display in column view.
3761 For example, it can be used to cut out a certain part from a time stamp.
3762 The function must take 2 arguments:
3764 column-title The title of the column (*not* the property name)
3765 value The value that should be modified.
3767 The function should return the value that should be displayed,
3768 or nil if the normal value should be used."
3769 :group
'org-properties
3770 :type
'(choice (const nil
) (function)))
3772 (defconst org-global-properties-fixed
3773 '(("VISIBILITY_ALL" .
"folded children content all")
3774 ("CLOCK_MODELINE_TOTAL_ALL" .
"current today repeat all auto"))
3775 "List of property/value pairs that can be inherited by any entry.
3777 These are fixed values, for the preset properties. The user variable
3778 that can be used to add to this list is `org-global-properties'.
3780 The entries in this list are cons cells where the car is a property
3781 name and cdr is a string with the value. If the value represents
3782 multiple items like an \"_ALL\" property, separate the items by
3785 (defcustom org-global-properties nil
3786 "List of property/value pairs that can be inherited by any entry.
3788 This list will be combined with the constant `org-global-properties-fixed'.
3790 The entries in this list are cons cells where the car is a property
3791 name and cdr is a string with the value.
3793 You can set buffer-local values for the same purpose in the variable
3794 `org-file-properties' this by adding lines like
3796 #+PROPERTY: NAME VALUE"
3797 :group
'org-properties
3799 (cons (string :tag
"Property")
3800 (string :tag
"Value"))))
3802 (defvar org-file-properties nil
3803 "List of property/value pairs that can be inherited by any entry.
3804 Valid for the current buffer.
3805 This variable is populated from #+PROPERTY lines.")
3806 (make-variable-buffer-local 'org-file-properties
)
3808 (defgroup org-agenda nil
3809 "Options concerning agenda views in Org-mode."
3813 (defvar org-category nil
3814 "Variable used by org files to set a category for agenda display.
3815 Such files should use a file variable to set it, for example
3817 # -*- mode: org; org-category: \"ELisp\"
3819 or contain a special line
3823 If the file does not specify a category, then file's base name
3825 (make-variable-buffer-local 'org-category
)
3826 (put 'org-category
'safe-local-variable
(lambda (x) (or (symbolp x
) (stringp x
))))
3828 (defcustom org-agenda-files nil
3829 "The files to be used for agenda display.
3830 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3831 \\[org-remove-file]. You can also use customize to edit the list.
3833 If an entry is a directory, all files in that directory that are matched by
3834 `org-agenda-file-regexp' will be part of the file list.
3836 If the value of the variable is not a list but a single file name, then
3837 the list of agenda files is actually stored and maintained in that file, one
3838 agenda file per line. In this file paths can be given relative to
3839 `org-directory'. Tilde expansion and environment variable substitution
3843 (repeat :tag
"List of files and directories" file
)
3844 (file :tag
"Store list in a file\n" :value
"~/.agenda_files")))
3846 (defcustom org-agenda-file-regexp
"\\`[^.].*\\.org\\'"
3847 "Regular expression to match files for `org-agenda-files'.
3848 If any element in the list in that variable contains a directory instead
3849 of a normal file, all files in that directory that are matched by this
3850 regular expression will be included."
3854 (defcustom org-agenda-text-search-extra-files nil
3855 "List of extra files to be searched by text search commands.
3856 These files will be searched in addition to the agenda files by the
3857 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3858 Note that these files will only be searched for text search commands,
3859 not for the other agenda views like todo lists, tag searches or the weekly
3860 agenda. This variable is intended to list notes and possibly archive files
3861 that should also be searched by these two commands.
3862 In fact, if the first element in the list is the symbol `agenda-archives',
3863 then all archive files of all agenda files will be added to the search
3866 :type
'(set :greedy t
3867 (const :tag
"Agenda Archives" agenda-archives
)
3868 (repeat :inline t
(file))))
3870 (org-defvaralias 'org-agenda-multi-occur-extra-files
3871 'org-agenda-text-search-extra-files
)
3873 (defcustom org-agenda-skip-unavailable-files nil
3874 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3875 A nil value means to remove them, after a query, from the list."
3879 (defcustom org-calendar-to-agenda-key
[?c
]
3880 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3881 The command `org-calendar-goto-agenda' will be bound to this key. The
3882 default is the character `c' because then `c' can be used to switch back and
3883 forth between agenda and calendar."
3887 (defcustom org-calendar-insert-diary-entry-key
[?i
]
3888 "The key to be installed in `calendar-mode-map' for adding diary entries.
3889 This option is irrelevant until `org-agenda-diary-file' has been configured
3890 to point to an Org-mode file. When that is the case, the command
3891 `org-agenda-diary-entry' will be bound to the key given here, by default
3892 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3893 if you want to continue doing this, you need to change this to a different
3898 (defcustom org-agenda-diary-file
'diary-file
3899 "File to which to add new entries with the `i' key in agenda and calendar.
3900 When this is the symbol `diary-file', the functionality in the Emacs
3901 calendar will be used to add entries to the `diary-file'. But when this
3902 points to a file, `org-agenda-diary-entry' will be used instead."
3905 (const :tag
"The standard Emacs diary file" diary-file
)
3906 (file :tag
"Special Org file diary entries")))
3908 (eval-after-load "calendar"
3910 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3911 'org-calendar-goto-agenda
)
3912 (add-hook 'calendar-mode-hook
3914 (unless (eq org-agenda-diary-file
'diary-file
)
3915 (define-key calendar-mode-map
3916 org-calendar-insert-diary-entry-key
3917 'org-agenda-diary-entry
))))))
3919 (defgroup org-latex nil
3920 "Options for embedding LaTeX code into Org-mode."
3924 (defcustom org-format-latex-options
3925 '(:foreground default
:background default
:scale
1.0
3926 :html-foreground
"Black" :html-background
"Transparent"
3927 :html-scale
1.0 :matchers
("begin" "$1" "$" "$$" "\\(" "\\["))
3928 "Options for creating images from LaTeX fragments.
3929 This is a property list with the following properties:
3930 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3931 `default' means use the foreground of the default face.
3932 `auto' means use the foreground from the text face.
3933 :background the background color, or \"Transparent\".
3934 `default' means use the background of the default face.
3935 `auto' means use the background from the text face.
3936 :scale a scaling factor for the size of the images, to get more pixels
3937 :html-foreground, :html-background, :html-scale
3938 the same numbers for HTML export.
3939 :matchers a list indicating which matchers should be used to
3940 find LaTeX fragments. Valid members of this list are:
3941 \"begin\" find environments
3942 \"$1\" find single characters surrounded by $.$
3943 \"$\" find math expressions surrounded by $...$
3944 \"$$\" find math expressions surrounded by $$....$$
3945 \"\\(\" find math expressions surrounded by \\(...\\)
3946 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3950 (defcustom org-format-latex-signal-error t
3951 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3952 When nil, just push out a message."
3957 (defcustom org-latex-to-mathml-jar-file nil
3958 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3959 Use this to specify additional executable file say a jar file.
3961 When using MathToWeb as the converter, specify the full-path to
3962 your mathtoweb.jar file."
3966 (const :tag
"None" nil
)
3967 (file :tag
"JAR file" :must-match t
)))
3969 (defcustom org-latex-to-mathml-convert-command nil
3970 "Command to convert LaTeX fragments to MathML.
3971 Replace format-specifiers in the command as noted below and use
3972 `shell-command' to convert LaTeX to MathML.
3973 %j: Executable file in fully expanded form as specified by
3974 `org-latex-to-mathml-jar-file'.
3975 %I: Input LaTeX file in fully expanded form.
3976 %i: The latex fragment to be converted.
3977 %o: Output MathML file.
3979 This command is used by `org-create-math-formula'.
3981 When using MathToWeb as the converter, set this option to
3982 \"java -jar %j -unicode -force -df %o %I\".
3984 When using LaTeXML set this option to
3985 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3989 (const :tag
"None" nil
)
3990 (string :tag
"\nShell command")))
3992 (defcustom org-latex-create-formula-image-program
'dvipng
3993 "Program to convert LaTeX fragments with.
3995 dvipng Process the LaTeX fragments to dvi file, then convert
3996 dvi files to png files using dvipng.
3997 This will also include processing of non-math environments.
3998 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3999 to convert pdf files to png files"
4003 (const :tag
"dvipng" dvipng
)
4004 (const :tag
"imagemagick" imagemagick
)))
4006 (defcustom org-latex-preview-ltxpng-directory
"ltxpng/"
4007 "Path to store latex preview images.
4008 A relative path here creates many directories relative to the
4009 processed org files paths. An absolute path puts all preview
4010 images at the same place."
4015 (defun org-format-latex-mathml-available-p ()
4016 "Return t if `org-latex-to-mathml-convert-command' is usable."
4018 (when (and (boundp 'org-latex-to-mathml-convert-command
)
4019 org-latex-to-mathml-convert-command
)
4020 (let ((executable (car (split-string
4021 org-latex-to-mathml-convert-command
))))
4022 (when (executable-find executable
)
4024 "%j" org-latex-to-mathml-convert-command
)
4025 (file-readable-p org-latex-to-mathml-jar-file
)
4028 (defcustom org-format-latex-header
"\\documentclass{article}
4029 \\usepackage[usenames]{color}
4032 \\pagestyle{empty} % do not remove
4033 % The settings below are copied from fullpage.sty
4034 \\setlength{\\textwidth}{\\paperwidth}
4035 \\addtolength{\\textwidth}{-3cm}
4036 \\setlength{\\oddsidemargin}{1.5cm}
4037 \\addtolength{\\oddsidemargin}{-2.54cm}
4038 \\setlength{\\evensidemargin}{\\oddsidemargin}
4039 \\setlength{\\textheight}{\\paperheight}
4040 \\addtolength{\\textheight}{-\\headheight}
4041 \\addtolength{\\textheight}{-\\headsep}
4042 \\addtolength{\\textheight}{-\\footskip}
4043 \\addtolength{\\textheight}{-3cm}
4044 \\setlength{\\topmargin}{1.5cm}
4045 \\addtolength{\\topmargin}{-2.54cm}"
4046 "The document header used for processing LaTeX fragments.
4047 It is imperative that this header make sure that no page number
4048 appears on the page. The package defined in the variables
4049 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4050 will either replace the placeholder \"[PACKAGES]\" in this
4051 header, or they will be appended."
4055 (defun org-set-packages-alist (var val
)
4056 "Set the packages alist and make sure it has 3 elements per entry."
4057 (set var
(mapcar (lambda (x)
4058 (if (and (consp x
) (= (length x
) 2))
4059 (list (car x
) (nth 1 x
) t
)
4063 (defun org-get-packages-alist (var)
4064 "Get the packages alist and make sure it has 3 elements per entry."
4066 (if (and (consp x
) (= (length x
) 2))
4067 (list (car x
) (nth 1 x
) t
)
4069 (default-value var
)))
4071 (defcustom org-latex-default-packages-alist
4072 '(("AUTO" "inputenc" t
)
4077 ("" "longtable" nil
)
4080 ("normalem" "ulem" t
)
4085 ("" "hyperref" nil
))
4086 "Alist of default packages to be inserted in the header.
4088 Change this only if one of the packages here causes an
4089 incompatibility with another package you are using.
4091 The packages in this list are needed by one part or another of
4092 Org mode to function properly:
4094 - inputenc, fontenc: for basic font and character selection
4095 - fixltx2e: Important patches of LaTeX itself
4096 - graphicx: for including images
4097 - grffile: allow periods and spaces in graphics file names
4098 - longtable: For multipage tables
4099 - 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, 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
4129 :package-version
'(Org .
"8.3")
4132 (list :tag
"options/package pair"
4133 (string :tag
"options")
4134 (string :tag
"package")
4135 (boolean :tag
"Snippet"))
4136 (string :tag
"A line of LaTeX"))))
4138 (defcustom org-latex-packages-alist nil
4139 "Alist of packages to be inserted in every LaTeX header.
4141 These will be inserted after `org-latex-default-packages-alist'.
4142 Each element is either a cell or a string.
4144 A cell is of the format:
4146 \(\"options\" \"package\" SNIPPET-FLAG)
4148 SNIPPET-FLAG, when non-nil, indicates that this package is also
4149 needed when turning LaTeX snippets into images for inclusion into
4152 A string will be inserted as-is in the header of the document.
4154 Make sure that you only list packages here which:
4156 - you want in every file;
4157 - do not conflict with the setup in `org-format-latex-header';
4158 - do not conflict with the default packages in
4159 `org-latex-default-packages-alist'."
4161 :group
'org-export-latex
4162 :set
'org-set-packages-alist
4163 :get
'org-get-packages-alist
4166 (list :tag
"options/package pair"
4167 (string :tag
"options")
4168 (string :tag
"package")
4169 (boolean :tag
"Snippet"))
4170 (string :tag
"A line of LaTeX"))))
4172 (defgroup org-appearance nil
4173 "Settings for Org-mode appearance."
4174 :tag
"Org Appearance"
4177 (defcustom org-level-color-stars-only nil
4178 "Non-nil means fontify only the stars in each headline.
4179 When nil, the entire headline is fontified.
4180 Changing it requires restart of `font-lock-mode' to become effective
4181 also in regions already fontified."
4182 :group
'org-appearance
4185 (defcustom org-hide-leading-stars nil
4186 "Non-nil means hide the first N-1 stars in a headline.
4187 This works by using the face `org-hide' for these stars. This
4188 face is white for a light background, and black for a dark
4189 background. You may have to customize the face `org-hide' to
4191 Changing it requires restart of `font-lock-mode' to become effective
4192 also in regions already fontified.
4193 You may also set this on a per-file basis by adding one of the following
4194 lines to the buffer:
4196 #+STARTUP: hidestars
4197 #+STARTUP: showstars"
4198 :group
'org-appearance
4201 (defcustom org-hidden-keywords nil
4202 "List of symbols corresponding to keywords to be hidden the org buffer.
4203 For example, a value '(title) for this list will make the document's title
4204 appear in the buffer without the initial #+TITLE: keyword."
4205 :group
'org-appearance
4207 :type
'(set (const :tag
"#+AUTHOR" author
)
4208 (const :tag
"#+DATE" date
)
4209 (const :tag
"#+EMAIL" email
)
4210 (const :tag
"#+TITLE" title
)))
4212 (defcustom org-custom-properties nil
4213 "List of properties (as strings) with a special meaning.
4214 The default use of these custom properties is to let the user
4215 hide them with `org-toggle-custom-properties-visibility'."
4216 :group
'org-properties
4217 :group
'org-appearance
4219 :type
'(repeat (string :tag
"Property Name")))
4221 (defcustom org-fontify-done-headline nil
4222 "Non-nil means change the face of a headline if it is marked DONE.
4223 Normally, only the TODO/DONE keyword indicates the state of a headline.
4224 When this is non-nil, the headline after the keyword is set to the
4225 `org-headline-done' as an additional indication."
4226 :group
'org-appearance
4229 (defcustom org-fontify-emphasized-text t
4230 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4231 Changing this variable requires a restart of Emacs to take effect."
4232 :group
'org-appearance
4235 (defcustom org-fontify-whole-heading-line nil
4236 "Non-nil means fontify the whole line for headings.
4237 This is useful when setting a background color for the
4239 :group
'org-appearance
4242 (defcustom org-highlight-latex-and-related nil
4243 "Non-nil means highlight LaTeX related syntax in the buffer.
4244 When non nil, the value should be a list containing any of the
4246 `latex' Highlight LaTeX snippets and environments.
4247 `script' Highlight subscript and superscript.
4248 `entities' Highlight entities."
4249 :group
'org-appearance
4251 :package-version
'(Org .
"8.0")
4253 (const :tag
"No highlighting" nil
)
4254 (set :greedy t
:tag
"Highlight"
4255 (const :tag
"LaTeX snippets and environments" latex
)
4256 (const :tag
"Subscript and superscript" script
)
4257 (const :tag
"Entities" entities
))))
4259 (defcustom org-hide-emphasis-markers nil
4260 "Non-nil mean font-lock should hide the emphasis marker characters."
4261 :group
'org-appearance
4264 (defcustom org-hide-macro-markers nil
4265 "Non-nil mean font-lock should hide the brackets marking macro calls."
4266 :group
'org-appearance
4269 (defcustom org-pretty-entities nil
4270 "Non-nil means show entities as UTF8 characters.
4271 When nil, the \\name form remains in the buffer."
4272 :group
'org-appearance
4276 (defcustom org-pretty-entities-include-sub-superscripts t
4277 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4278 :group
'org-appearance
4282 (defvar org-emph-re nil
4283 "Regular expression for matching emphasis.
4284 After a match, the match groups contain these elements:
4285 0 The match of the full regular expression, including the characters
4286 before and after the proper match
4287 1 The character before the proper match, or empty at beginning of line
4288 2 The proper match, including the leading and trailing markers
4289 3 The leading marker like * or /, indicating the type of highlighting
4290 4 The text between the emphasis markers, not including the markers
4291 5 The character after the match, empty at the end of a line")
4292 (defvar org-verbatim-re nil
4293 "Regular expression for matching verbatim text.")
4294 (defvar org-emphasis-regexp-components
) ; defined just below
4295 (defvar org-emphasis-alist
) ; defined just below
4296 (defun org-set-emph-re (var val
)
4297 "Set variable and compute the emphasis regular expression."
4299 (when (and (boundp 'org-emphasis-alist
)
4300 (boundp 'org-emphasis-regexp-components
)
4301 org-emphasis-alist org-emphasis-regexp-components
)
4302 (let* ((e org-emphasis-regexp-components
)
4308 (body1 (concat body
"*?"))
4309 (markers (mapconcat 'car org-emphasis-alist
""))
4310 (vmarkers (mapconcat
4311 (lambda (x) (if (eq (nth 2 x
) 'verbatim
) (car x
) ""))
4312 org-emphasis-alist
"")))
4313 ;; make sure special characters appear at the right position in the class
4314 (if (string-match "\\^" markers
)
4315 (setq markers
(concat (replace-match "" t t markers
) "^")))
4316 (if (string-match "-" markers
)
4317 (setq markers
(concat (replace-match "" t t markers
) "-")))
4318 (if (string-match "\\^" vmarkers
)
4319 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "^")))
4320 (if (string-match "-" vmarkers
)
4321 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "-")))
4323 (setq body1
(concat body1
"\\(?:\n" body
"*?\\)\\{0,"
4324 (int-to-string nl
) "\\}")))
4327 (concat "\\([" pre
"]\\|^\\)"
4329 "\\([" markers
"]\\)"
4337 "\\([" post
"]\\|$\\)"))
4338 (setq org-verbatim-re
4339 (concat "\\([" pre
"]\\|^\\)"
4341 "\\([" vmarkers
"]\\)"
4349 "\\([" post
"]\\|$\\)")))))
4351 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4352 ;; set this option proved cumbersome. See this message/thread:
4353 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4354 (defvar org-emphasis-regexp-components
4355 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4356 "Components used to build the regular expression for emphasis.
4357 This is a list with five entries. Terminology: In an emphasis string
4358 like \" *strong word* \", we call the initial space PREMATCH, the final
4359 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4360 and \"trong wor\" is the body. The different components in this variable
4361 specify what is allowed/forbidden in each part:
4363 pre Chars allowed as prematch. Beginning of line will be allowed too.
4364 post Chars allowed as postmatch. End of line will be allowed too.
4365 border The chars *forbidden* as border characters.
4366 body-regexp A regexp like \".\" to match a body character. Don't use
4367 non-shy groups here, and don't allow newline here.
4368 newline The maximum number of newlines allowed in an emphasis exp.
4370 You need to reload Org or to restart Emacs after customizing this.")
4372 (defcustom org-emphasis-alist
4376 ("=" org-verbatim verbatim
)
4377 ("~" org-code verbatim
)
4378 ("+" ,(if (featurep 'xemacs
) 'org-table
'(:strike-through t
))))
4379 "Alist of characters and faces to emphasize text.
4380 Text starting and ending with a special character will be emphasized,
4381 for example *bold*, _underlined_ and /italic/. This variable sets the
4382 marker characters and the face to be used by font-lock for highlighting
4383 in Org-mode Emacs buffers.
4385 You need to reload Org or to restart Emacs after customizing this."
4386 :group
'org-appearance
4387 :set
'org-set-emph-re
4389 :package-version
'(Org .
"8.0")
4392 (string :tag
"Marker character")
4394 (face :tag
"Font-lock-face")
4395 (plist :tag
"Face property list"))
4396 (option (const verbatim
)))))
4398 (defvar org-protecting-blocks
4399 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4400 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4401 This is needed for font-lock setup.")
4403 ;;; Miscellaneous options
4405 (defgroup org-completion nil
4406 "Completion in Org-mode."
4407 :tag
"Org Completion"
4410 (defcustom org-completion-use-ido nil
4411 "Non-nil means use ido completion wherever possible.
4412 Note that `ido-mode' must be active for this variable to be relevant.
4413 If you decide to turn this variable on, you might well want to turn off
4414 `org-outline-path-complete-in-steps'.
4415 See also `org-completion-use-iswitchb'."
4416 :group
'org-completion
4419 (defcustom org-completion-use-iswitchb nil
4420 "Non-nil means use iswitchb completion wherever possible.
4421 Note that `iswitchb-mode' must be active for this variable to be relevant.
4422 If you decide to turn this variable on, you might well want to turn off
4423 `org-outline-path-complete-in-steps'.
4424 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4425 :group
'org-completion
4428 (defcustom org-completion-fallback-command
'hippie-expand
4429 "The expansion command called by \\[pcomplete] in normal context.
4430 Normal means, no org-mode-specific context."
4431 :group
'org-completion
4434 ;;; Functions and variables from their packages
4435 ;; Declared here to avoid compiler warnings
4438 (defvar outline-mode-menu-heading
)
4439 (defvar outline-mode-menu-show
)
4440 (defvar outline-mode-menu-hide
)
4441 (defvar zmacs-regions
) ; XEmacs regions
4444 (defvar mark-active
)
4447 (declare-function calendar-iso-to-absolute
"cal-iso" (date))
4448 (declare-function calendar-forward-day
"cal-move" (arg))
4449 (declare-function calendar-goto-date
"cal-move" (date))
4450 (declare-function calendar-goto-today
"cal-move" ())
4451 (declare-function calendar-iso-from-absolute
"cal-iso" (date))
4452 (defvar calc-embedded-close-formula
)
4453 (defvar calc-embedded-open-formula
)
4454 (declare-function cdlatex-tab
"ext:cdlatex" ())
4455 (declare-function cdlatex-compute-tables
"ext:cdlatex" ())
4456 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
4457 (defvar font-lock-unfontify-region-function
)
4458 (declare-function iswitchb-read-buffer
"iswitchb"
4459 (prompt &optional default require-match start matches-set
))
4460 (defvar iswitchb-temp-buflist
)
4461 (declare-function org-gnus-follow-link
"org-gnus" (&optional group article
))
4462 (defvar org-agenda-tags-todo-honor-ignore-options
)
4463 (declare-function org-agenda-skip
"org-agenda" ())
4465 org-agenda-format-item
"org-agenda"
4466 (extra txt
&optional level category tags dotime noprefix remove-re habitp
))
4467 (declare-function org-agenda-new-marker
"org-agenda" (&optional pos
))
4468 (declare-function org-agenda-change-all-lines
"org-agenda"
4469 (newhead hdmarker
&optional fixface just-this
))
4470 (declare-function org-agenda-set-restriction-lock
"org-agenda" (&optional type
))
4471 (declare-function org-agenda-maybe-redo
"org-agenda" ())
4472 (declare-function org-agenda-save-markers-for-cut-and-paste
"org-agenda"
4474 (declare-function org-agenda-copy-local-variable
"org-agenda" (var))
4475 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4476 "org-agenda" (&optional end
))
4477 (declare-function org-inlinetask-remove-END-maybe
"org-inlinetask" ())
4478 (declare-function org-inlinetask-in-task-p
"org-inlinetask" ())
4479 (declare-function org-inlinetask-goto-beginning
"org-inlinetask" ())
4480 (declare-function org-inlinetask-goto-end
"org-inlinetask" ())
4481 (declare-function org-indent-mode
"org-indent" (&optional arg
))
4482 (declare-function parse-time-string
"parse-time" (string))
4483 (declare-function org-attach-reveal
"org-attach" (&optional if-exists
))
4484 (declare-function orgtbl-send-table
"org-table" (&optional maybe
))
4485 (defvar remember-data-file
)
4486 (defvar texmathp-why
)
4487 (declare-function speedbar-line-directory
"speedbar" (&optional depth
))
4488 (declare-function table--at-cell-p
"table" (position &optional object at-column
))
4489 (declare-function calc-eval
"calc" (str &optional separator
&rest args
))
4492 (defun turn-on-orgtbl ()
4493 "Unconditionally turn on `orgtbl-mode'."
4494 (require 'org-table
)
4497 (defun org-at-table-p (&optional table-type
)
4498 "Non-nil if the cursor is inside an Org table.
4499 If TABLE-TYPE is non-nil, also check for table.el-type tables.
4500 If `org-enable-table-editor' is nil, return nil unconditionally."
4501 (and org-enable-table-editor
4504 (org-looking-at-p (if table-type
"[ \t]*[|+]" "[ \t]*|")))
4505 (let ((element (org-element-lineage (org-element-at-point) '(table) t
)))
4507 (or table-type
(eq (org-element-property :type element
) 'org
))))))
4508 (defsubst org-table-p
() (org-at-table-p))
4510 (defun org-at-table.el-p
()
4511 "Non-nil when point is at a table.el table."
4512 (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4513 (let ((element (org-element-at-point)))
4514 (and (eq (org-element-type element
) 'table
)
4515 (eq (org-element-property :type element
) 'table.el
)))))
4517 (defun org-table-recognize-table.el
()
4518 "If there is a table.el table nearby, recognize it and move into it."
4519 (when (and org-table-tab-recognizes-table.el
(org-at-table.el-p
))
4521 (unless (or (looking-at org-table-dataline-regexp
)
4522 (not (looking-at org-table1-hline-regexp
)))
4524 (when (looking-at org-table-any-border-regexp
)
4526 (if (re-search-forward "|" (org-table-end t
) t
)
4529 (if (table--at-cell-p (point)) t
4530 (message "recognizing table.el table...")
4531 (table-recognize-table)
4532 (message "recognizing table.el table...done")))
4533 (error "This should not happen"))))
4535 (defun org-at-table-hline-p ()
4536 "Non-nil when point is inside a hline in a table.
4537 Assume point is already in a table. If `org-enable-table-editor'
4538 is nil, return nil unconditionally."
4539 (and org-enable-table-editor
4542 (looking-at org-table-hline-regexp
))))
4544 (defun org-table-map-tables (function &optional quietly
)
4545 "Apply FUNCTION to the start of all tables in the buffer."
4549 (goto-char (point-min))
4550 (while (re-search-forward org-table-any-line-regexp nil t
)
4552 (message "Mapping tables: %d%%"
4553 (floor (* 100.0 (point)) (buffer-size))))
4554 (beginning-of-line 1)
4555 (when (and (looking-at org-table-line-regexp
)
4556 ;; Exclude tables in src/example/verbatim/clocktable blocks
4557 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4558 (save-excursion (funcall function
))
4559 (or (looking-at org-table-line-regexp
)
4561 (re-search-forward org-table-any-border-regexp nil
1))))
4562 (unless quietly
(message "Mapping tables: done")))
4564 (declare-function org-clock-save-markers-for-cut-and-paste
"org-clock" (beg end
))
4565 (declare-function org-clock-update-mode-line
"org-clock" ())
4566 (declare-function org-resolve-clocks
"org-clock"
4567 (&optional also-non-dangling-p prompt last-valid
))
4569 (defun org-at-TBLFM-p (&optional pos
)
4570 "Non-nil when point (or POS) is in #+TBLFM line."
4572 (goto-char (or pos
(point)))
4574 (and (let ((case-fold-search t
)) (looking-at org-TBLFM-regexp
))
4575 (eq (org-element-type (org-element-at-point)) 'table
))))
4577 (defvar org-clock-start-time
)
4578 (defvar org-clock-marker
(make-marker)
4579 "Marker recording the last clock-in.")
4580 (defvar org-clock-hd-marker
(make-marker)
4581 "Marker recording the last clock-in, but the headline position.")
4582 (defvar org-clock-heading
""
4583 "The heading of the current clock entry.")
4584 (defun org-clock-is-active ()
4585 "Return the buffer where the clock is currently running.
4586 Return nil if no clock is running."
4587 (marker-buffer org-clock-marker
))
4589 (defun org-check-running-clock ()
4590 "Check if the current buffer contains the running clock.
4591 If yes, offer to stop it and to save the buffer with the changes."
4592 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
4593 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4596 (when (y-or-n-p "Save changed buffer?")
4599 (defun org-clocktable-try-shift (dir n
)
4600 "Check if this line starts a clock table, if yes, shift the time block."
4601 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4602 (org-clocktable-shift dir n
)))
4605 (defun org-clock-persistence-insinuate ()
4606 "Set up hooks for clock persistence."
4607 (require 'org-clock
)
4608 (add-hook 'org-mode-hook
'org-clock-load
)
4609 (add-hook 'kill-emacs-hook
'org-clock-save
))
4611 (defgroup org-archive nil
4612 "Options concerning archiving in Org-mode."
4614 :group
'org-structure
)
4616 (defcustom org-archive-location
"%s_archive::"
4617 "The location where subtrees should be archived.
4619 The value of this variable is a string, consisting of two parts,
4620 separated by a double-colon. The first part is a filename and
4621 the second part is a headline.
4623 When the filename is omitted, archiving happens in the same file.
4624 %s in the filename will be replaced by the current file
4625 name (without the directory part). Archiving to a different file
4626 is useful to keep archived entries from contributing to the
4629 The archived entries will be filed as subtrees of the specified
4630 headline. When the headline is omitted, the subtrees are simply
4631 filed away at the end of the file, as top-level entries. Also in
4632 the heading you can use %s to represent the file name, this can be
4633 useful when using the same archive for a number of different files.
4635 Here are a few examples:
4637 If the current file is Projects.org, archive in file
4638 Projects.org_archive, as top-level trees. This is the default.
4640 \"::* Archived Tasks\"
4641 Archive in the current file, under the top-level headline
4642 \"* Archived Tasks\".
4644 \"~/org/archive.org::\"
4645 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4647 \"~/org/archive.org::* From %s\"
4648 Archive in file ~/org/archive.org (absolute path), under headlines
4649 \"From FILENAME\" where file name is the current file name.
4651 \"~/org/datetree.org::datetree/* Finished Tasks\"
4652 The \"datetree/\" string is special, signifying to archive
4653 items to the datetree. Items are placed in either the CLOSED
4654 date of the item, or the current date if there is no CLOSED date.
4655 The heading will be a subentry to the current date. There doesn't
4656 need to be a heading, but there always needs to be a slash after
4657 datetree. For example, to store archived items directly in the
4658 datetree, use \"~/org/datetree.org::datetree/\".
4660 \"basement::** Finished Tasks\"
4661 Archive in file ./basement (relative path), as level 3 trees
4662 below the level 2 heading \"** Finished Tasks\".
4664 You may set this option on a per-file basis by adding to the buffer a
4667 #+ARCHIVE: basement::** Finished Tasks
4669 You may also define it locally for a subtree by setting an ARCHIVE property
4670 in the entry. If such a property is found in an entry, or anywhere up
4671 the hierarchy, it will be used."
4675 (defcustom org-agenda-skip-archived-trees t
4676 "Non-nil means the agenda will skip any items located in archived trees.
4677 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4678 variable is no longer recommended, you should leave it at the value t.
4679 Instead, use the key `v' to cycle the archives-mode in the agenda."
4681 :group
'org-agenda-skip
4684 (defcustom org-columns-skip-archived-trees t
4685 "Non-nil means ignore archived trees when creating column view."
4687 :group
'org-properties
4690 (defcustom org-cycle-open-archived-trees nil
4691 "Non-nil means `org-cycle' will open archived trees.
4692 An archived tree is a tree marked with the tag ARCHIVE.
4693 When nil, archived trees will stay folded. You can still open them with
4694 normal outline commands like `show-all', but not with the cycling commands."
4699 (defcustom org-sparse-tree-open-archived-trees nil
4700 "Non-nil means sparse tree construction shows matches in archived trees.
4701 When nil, matches in these trees are highlighted, but the trees are kept in
4704 :group
'org-sparse-trees
4707 (defcustom org-sparse-tree-default-date-type nil
4708 "The default date type when building a sparse tree.
4709 When this is nil, a date is a scheduled or a deadline timestamp.
4710 Otherwise, these types are allowed:
4713 active: only active timestamps (<...>)
4714 inactive: only inactive timestamps ([...])
4715 scheduled: only scheduled timestamps
4716 deadline: only deadline timestamps"
4717 :type
'(choice (const :tag
"Scheduled or deadline" nil
)
4718 (const :tag
"All timestamps" all
)
4719 (const :tag
"Only active timestamps" active
)
4720 (const :tag
"Only inactive timestamps" inactive
)
4721 (const :tag
"Only scheduled timestamps" scheduled
)
4722 (const :tag
"Only deadline timestamps" deadline
)
4723 (const :tag
"Only closed timestamps" closed
))
4725 :package-version
'(Org .
"8.3")
4726 :group
'org-sparse-trees
)
4728 (defun org-cycle-hide-archived-subtrees (state)
4729 "Re-hide all archived subtrees after a visibility state change."
4730 (when (and (not org-cycle-open-archived-trees
)
4731 (not (memq state
'(overview folded
))))
4733 (let* ((globalp (memq state
'(contents all
)))
4734 (beg (if globalp
(point-min) (point)))
4735 (end (if globalp
(point-max) (org-end-of-subtree t
))))
4736 (org-hide-archived-subtrees beg end
)
4738 (if (looking-at (concat ".*:" org-archive-tag
":"))
4739 (message "%s" (substitute-command-keys
4740 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4742 (defun org-force-cycle-archived ()
4743 "Cycle subtree even if it is archived."
4745 (setq this-command
'org-cycle
)
4746 (let ((org-cycle-open-archived-trees t
))
4747 (call-interactively 'org-cycle
)))
4749 (defun org-hide-archived-subtrees (beg end
)
4750 "Re-hide all archived subtrees after a visibility state change."
4751 (org-with-wide-buffer
4752 (let ((case-fold-search nil
)
4753 (re (concat org-outline-regexp-bol
".*:" org-archive-tag
":")))
4755 (while (and (< (point) end
) (re-search-forward re end t
))
4756 (when (member org-archive-tag
(org-get-tags))
4757 (org-flag-subtree t
)
4758 (org-end-of-subtree t
))))))
4760 (declare-function outline-end-of-heading
"outline" ())
4761 (declare-function outline-flag-region
"outline" (from to flag
))
4762 (defun org-flag-subtree (flag)
4764 (org-back-to-heading t
)
4765 (outline-end-of-heading)
4766 (outline-flag-region (point)
4767 (progn (org-end-of-subtree t
) (point))
4770 (defalias 'org-advertized-archive-subtree
'org-archive-subtree
)
4772 ;; Declare Column View Code
4774 (declare-function org-columns-number-to-string
"org-colview" (n fmt
&optional printf
))
4775 (declare-function org-columns-get-format-and-top-level
"org-colview" ())
4776 (declare-function org-columns-compute
"org-colview" (property))
4780 (declare-function org-id-store-link
"org-id")
4781 (declare-function org-id-locations-load
"org-id")
4782 (declare-function org-id-locations-save
"org-id")
4783 (defvar org-id-track-globally
)
4785 ;;; Variables for pre-computed regular expressions, all buffer local
4787 (defvar org-todo-regexp nil
4788 "Matches any of the TODO state keywords.")
4789 (make-variable-buffer-local 'org-todo-regexp
)
4790 (defvar org-not-done-regexp nil
4791 "Matches any of the TODO state keywords except the last one.")
4792 (make-variable-buffer-local 'org-not-done-regexp
)
4793 (defvar org-not-done-heading-regexp nil
4794 "Matches a TODO headline that is not done.")
4795 (make-variable-buffer-local 'org-not-done-heading-regexp
)
4796 (defvar org-todo-line-regexp nil
4797 "Matches a headline and puts TODO state into group 2 if present.")
4798 (make-variable-buffer-local 'org-todo-line-regexp
)
4799 (defvar org-complex-heading-regexp nil
4800 "Matches a headline and puts everything into groups:
4802 group 2: The todo keyword, maybe
4803 group 3: Priority cookie
4804 group 4: True headline
4806 (make-variable-buffer-local 'org-complex-heading-regexp
)
4807 (defvar org-complex-heading-regexp-format nil
4808 "Printf format to make regexp to match an exact headline.
4809 This regexp will match the headline of any node which has the
4810 exact headline text that is put into the format, but may have any
4811 TODO state, priority and tags.")
4812 (make-variable-buffer-local 'org-complex-heading-regexp-format
)
4813 (defvar org-todo-line-tags-regexp nil
4814 "Matches a headline and puts TODO state into group 2 if present.
4815 Also put tags into group 4 if tags are present.")
4816 (make-variable-buffer-local 'org-todo-line-tags-regexp
)
4818 (defconst org-plain-time-of-day-regexp
4821 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4824 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4826 "Regular expression to match a plain time or time range.
4827 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4828 groups carry important information:
4830 1 the first time, range or not
4831 8 the second time, if it is a range.")
4833 (defconst org-plain-time-extension-regexp
4836 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4837 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4838 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4839 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4840 groups carry important information:
4843 9 minutes of duration")
4845 (defconst org-stamp-time-of-day-regexp
4847 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4848 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4850 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4851 "Regular expression to match a timestamp time or time range.
4852 After a match, the following groups carry important information:
4854 1 date plus weekday, for back referencing to make sure both times are on the same day
4855 2 the first time, range or not
4856 4 the second time, if it is a range.")
4858 (defconst org-startup-options
4859 '(("fold" org-startup-folded t
)
4860 ("overview" org-startup-folded t
)
4861 ("nofold" org-startup-folded nil
)
4862 ("showall" org-startup-folded nil
)
4863 ("showeverything" org-startup-folded showeverything
)
4864 ("content" org-startup-folded content
)
4865 ("indent" org-startup-indented t
)
4866 ("noindent" org-startup-indented nil
)
4867 ("hidestars" org-hide-leading-stars t
)
4868 ("showstars" org-hide-leading-stars nil
)
4869 ("odd" org-odd-levels-only t
)
4870 ("oddeven" org-odd-levels-only nil
)
4871 ("align" org-startup-align-all-tables t
)
4872 ("noalign" org-startup-align-all-tables nil
)
4873 ("inlineimages" org-startup-with-inline-images t
)
4874 ("noinlineimages" org-startup-with-inline-images nil
)
4875 ("latexpreview" org-startup-with-latex-preview t
)
4876 ("nolatexpreview" org-startup-with-latex-preview nil
)
4877 ("customtime" org-display-custom-times t
)
4878 ("logdone" org-log-done time
)
4879 ("lognotedone" org-log-done note
)
4880 ("nologdone" org-log-done nil
)
4881 ("lognoteclock-out" org-log-note-clock-out t
)
4882 ("nolognoteclock-out" org-log-note-clock-out nil
)
4883 ("logrepeat" org-log-repeat state
)
4884 ("lognoterepeat" org-log-repeat note
)
4885 ("logdrawer" org-log-into-drawer t
)
4886 ("nologdrawer" org-log-into-drawer nil
)
4887 ("logstatesreversed" org-log-states-order-reversed t
)
4888 ("nologstatesreversed" org-log-states-order-reversed nil
)
4889 ("nologrepeat" org-log-repeat nil
)
4890 ("logreschedule" org-log-reschedule time
)
4891 ("lognotereschedule" org-log-reschedule note
)
4892 ("nologreschedule" org-log-reschedule nil
)
4893 ("logredeadline" org-log-redeadline time
)
4894 ("lognoteredeadline" org-log-redeadline note
)
4895 ("nologredeadline" org-log-redeadline nil
)
4896 ("logrefile" org-log-refile time
)
4897 ("lognoterefile" org-log-refile note
)
4898 ("nologrefile" org-log-refile nil
)
4899 ("fninline" org-footnote-define-inline t
)
4900 ("nofninline" org-footnote-define-inline nil
)
4901 ("fnlocal" org-footnote-section nil
)
4902 ("fnauto" org-footnote-auto-label t
)
4903 ("fnprompt" org-footnote-auto-label nil
)
4904 ("fnconfirm" org-footnote-auto-label confirm
)
4905 ("fnplain" org-footnote-auto-label plain
)
4906 ("fnadjust" org-footnote-auto-adjust t
)
4907 ("nofnadjust" org-footnote-auto-adjust nil
)
4908 ("constcgs" constants-unit-system cgs
)
4909 ("constSI" constants-unit-system SI
)
4910 ("noptag" org-tag-persistent-alist nil
)
4911 ("hideblocks" org-hide-block-startup t
)
4912 ("nohideblocks" org-hide-block-startup nil
)
4913 ("beamer" org-startup-with-beamer-mode t
)
4914 ("entitiespretty" org-pretty-entities t
)
4915 ("entitiesplain" org-pretty-entities nil
))
4916 "Variable associated with STARTUP options for org-mode.
4917 Each element is a list of three items: the startup options (as written
4918 in the #+STARTUP line), the corresponding variable, and the value to set
4919 this variable to if the option is found. An optional forth element PUSH
4920 means to push this value onto the list in the variable.")
4922 (defcustom org-group-tags t
4923 "When non-nil (the default), use group tags.
4924 This can be turned on/off through `org-toggle-tags-groups'."
4929 (defvar org-inhibit-startup nil
) ; Dynamically-scoped param.
4931 (defun org-toggle-tags-groups ()
4932 "Toggle support for group tags.
4933 Support for group tags is controlled by the option
4934 `org-group-tags', which is non-nil by default."
4936 (setq org-group-tags
(not org-group-tags
))
4937 (cond ((and (derived-mode-p 'org-agenda-mode
)
4940 ((derived-mode-p 'org-mode
)
4941 (let ((org-inhibit-startup t
)) (org-mode))))
4942 (message "Groups tags support has been turned %s"
4943 (if org-group-tags
"on" "off")))
4945 (defun org-set-regexps-and-options (&optional tags-only
)
4946 "Precompute regular expressions used in the current buffer.
4947 When optional argument TAGS-ONLY is non-nil, only compute tags
4948 related expressions."
4949 (when (derived-mode-p 'org-mode
)
4950 (let ((alist (org--setup-collect-keywords
4951 (org-make-options-regexp
4952 (append '("FILETAGS" "TAGS" "SETUPFILE")
4953 (and (not tags-only
)
4954 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4955 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4956 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4957 (org--setup-process-tags
4958 (cdr (assq 'tags alist
)) (cdr (assq 'filetags alist
)))
4961 (org-set-local 'org-file-properties
(cdr (assq 'property alist
)))
4962 ;; Archive location.
4963 (let ((archive (cdr (assq 'archive alist
))))
4964 (when archive
(org-set-local 'org-archive-location archive
)))
4966 (let ((cat (org-string-nw-p (cdr (assq 'category alist
)))))
4968 (org-set-local 'org-category
(intern cat
))
4969 (org-set-local 'org-file-properties
4970 (org--update-property-plist
4971 "CATEGORY" cat org-file-properties
))))
4973 (let ((column (cdr (assq 'columns alist
))))
4974 (when column
(org-set-local 'org-columns-default-format column
)))
4976 (setq org-table-formula-constants-local
(cdr (assq 'constants alist
)))
4977 ;; Link abbreviations.
4978 (let ((links (cdr (assq 'link alist
))))
4979 (when links
(setq org-link-abbrev-alist-local
(nreverse links
))))
4981 (let ((priorities (cdr (assq 'priorities alist
))))
4983 (org-set-local 'org-highest-priority
(nth 0 priorities
))
4984 (org-set-local 'org-lowest-priority
(nth 1 priorities
))
4985 (org-set-local 'org-default-priority
(nth 2 priorities
))))
4987 (let ((scripts (assq 'scripts alist
)))
4989 (org-set-local 'org-use-sub-superscripts
(cdr scripts
))))
4991 (let ((startup (cdr (assq 'startup alist
))))
4992 (dolist (option startup
)
4993 (let ((entry (assoc-string option org-startup-options t
)))
4995 (let ((var (nth 1 entry
))
4996 (val (nth 2 entry
)))
4997 (if (not (nth 3 entry
)) (org-set-local var val
)
4998 (unless (listp (symbol-value var
))
4999 (org-set-local var nil
))
5000 (add-to-list var val
)))))))
5002 (org-set-local 'org-todo-kwd-alist nil
)
5003 (org-set-local 'org-todo-key-alist nil
)
5004 (org-set-local 'org-todo-key-trigger nil
)
5005 (org-set-local 'org-todo-keywords-1 nil
)
5006 (org-set-local 'org-done-keywords nil
)
5007 (org-set-local 'org-todo-heads nil
)
5008 (org-set-local 'org-todo-sets nil
)
5009 (org-set-local 'org-todo-log-states nil
)
5010 (let ((todo-sequences
5011 (or (nreverse (cdr (assq 'todo alist
)))
5012 (let ((d (default-value 'org-todo-keywords
)))
5013 (if (not (stringp (car d
))) d
5014 ;; XXX: Backward compatibility code.
5015 (list (cons org-todo-interpretation d
)))))))
5016 (dolist (sequence todo-sequences
)
5017 (let* ((sequence (or (run-hook-with-args-until-success
5018 'org-todo-setup-filter-hook sequence
)
5020 (sequence-type (car sequence
))
5021 (keywords (cdr sequence
))
5022 (sep (member "|" keywords
))
5024 (dolist (k (remove "|" keywords
))
5025 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5027 (error "Invalid TODO keyword %s" k
))
5028 (let ((name (match-string 1 k
))
5029 (key (match-string 2 k
))
5030 (log (org-extract-log-state-settings k
)))
5032 (push (cons name
(and key
(string-to-char key
))) alist
)
5033 (when log
(push log org-todo-log-states
))))
5034 (let* ((names (nreverse names
))
5035 (done (if sep
(org-remove-keyword-keys (cdr sep
))
5038 (tail (list sequence-type head
(car done
) (org-last done
))))
5039 (add-to-list 'org-todo-heads head
'append
)
5040 (push names org-todo-sets
)
5041 (setq org-done-keywords
(append org-done-keywords done nil
))
5042 (setq org-todo-keywords-1
(append org-todo-keywords-1 names nil
))
5043 (setq org-todo-key-alist
5044 (append org-todo-key-alist
5046 (append '((:startgroup
))
5049 (dolist (k names
) (push (cons k tail
) org-todo-kwd-alist
))))))
5050 (setq org-todo-sets
(nreverse org-todo-sets
)
5051 org-todo-kwd-alist
(nreverse org-todo-kwd-alist
)
5052 org-todo-key-trigger
(delq nil
(mapcar #'cdr org-todo-key-alist
))
5053 org-todo-key-alist
(org-assign-fast-keys org-todo-key-alist
))
5054 ;; Compute the regular expressions and other local variables.
5055 ;; Using `org-outline-regexp-bol' would complicate them much,
5056 ;; because of the fixed white space at the end of that string.
5057 (if (not org-done-keywords
)
5058 (setq org-done-keywords
5059 (and org-todo-keywords-1
(last org-todo-keywords-1
))))
5060 (setq org-not-done-keywords
5061 (org-delete-all org-done-keywords
5062 (copy-sequence org-todo-keywords-1
))
5063 org-todo-regexp
(regexp-opt org-todo-keywords-1 t
)
5064 org-not-done-regexp
(regexp-opt org-not-done-keywords t
)
5065 org-not-done-heading-regexp
5066 (format org-heading-keyword-regexp-format org-not-done-regexp
)
5067 org-todo-line-regexp
5068 (format org-heading-keyword-maybe-regexp-format org-todo-regexp
)
5069 org-complex-heading-regexp
5070 (concat "^\\(\\*+\\)"
5071 "\\(?: +" org-todo-regexp
"\\)?"
5072 "\\(?: +\\(\\[#.\\]\\)\\)?"
5073 "\\(?: +\\(.*?\\)\\)??"
5074 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5076 org-complex-heading-regexp-format
5077 (concat "^\\(\\*+\\)"
5078 "\\(?: +" org-todo-regexp
"\\)?"
5079 "\\(?: +\\(\\[#.\\]\\)\\)?"
5081 ;; Stats cookies can be stuck to body.
5082 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5084 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5086 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5088 org-todo-line-tags-regexp
5089 (concat "^\\(\\*+\\)"
5090 "\\(?: +" org-todo-regexp
"\\)?"
5091 "\\(?: +\\(.*?\\)\\)??"
5092 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5094 (org-compute-latex-and-related-regexp)))))
5096 (defun org--setup-collect-keywords (regexp &optional files alist
)
5097 "Return setup keywords values as an alist.
5099 REGEXP matches a subset of setup keywords. FILES is a list of
5100 file names already visited. It is used to avoid circular setup
5101 files. ALIST, when non-nil, is the alist computed so far.
5103 Return value contains the following keys: `archive', `category',
5104 `columns', `constants', `filetags', `link', `priorities',
5105 `property', `scripts', `startup', `tags' and `todo'."
5106 (org-with-wide-buffer
5107 (goto-char (point-min))
5108 (let ((case-fold-search t
))
5109 (while (re-search-forward regexp nil t
)
5110 (let ((element (org-element-at-point)))
5111 (when (eq (org-element-type element
) 'keyword
)
5112 (let ((key (org-element-property :key element
))
5113 (value (org-element-property :value element
)))
5115 ((equal key
"ARCHIVE")
5116 (when (org-string-nw-p value
)
5117 (push (cons 'archive value
) alist
)))
5118 ((equal key
"CATEGORY") (push (cons 'category value
) alist
))
5119 ((equal key
"COLUMNS") (push (cons 'columns value
) alist
))
5120 ((equal key
"CONSTANTS")
5121 (let* ((constants (assq 'constants alist
))
5122 (store (cdr constants
)))
5123 (dolist (pair (org-split-string value
))
5124 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5126 (let* ((name (match-string 1 pair
))
5127 (value (match-string 2 pair
))
5128 (old (assoc name store
)))
5129 (if old
(setcdr old value
)
5130 (push (cons name value
) store
)))))
5131 (if constants
(setcdr constants store
)
5132 (push (cons 'constants store
) alist
))))
5133 ((equal key
"FILETAGS")
5134 (when (org-string-nw-p value
)
5135 (let ((old (assq 'filetags alist
))
5137 (mapcar (lambda (x) (org-split-string x
":"))
5138 (org-split-string value
)))))
5139 (if old
(setcdr old
(append new
(cdr old
)))
5140 (push (cons 'filetags new
) alist
)))))
5142 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value
)
5143 (let ((links (assq 'link alist
))
5144 (pair (cons (org-match-string-no-properties 1 value
)
5145 (org-match-string-no-properties 2 value
))))
5146 (if links
(push pair
(cdr links
))
5147 (push (list 'link pair
) alist
)))))
5148 ((equal key
"OPTIONS")
5149 (when (and (org-string-nw-p value
)
5150 (string-match "\\^:\\(t\\|nil\\|{}\\)" value
))
5151 (push (cons 'scripts
(read (match-string 1 value
))) alist
)))
5152 ((equal key
"PRIORITIES")
5153 (push (cons 'priorities
5154 (let ((prio (org-split-string value
)))
5155 (if (< (length prio
) 3) '(?A ?C ?B
)
5156 (mapcar #'string-to-char prio
))))
5158 ((equal key
"PROPERTY")
5159 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value
)
5160 (let* ((property (assq 'property alist
))
5161 (value (org--update-property-plist
5162 (org-match-string-no-properties 1 value
)
5163 (org-match-string-no-properties 2 value
)
5165 (if property
(setcdr property value
)
5166 (push (cons 'property value
) alist
)))))
5167 ((equal key
"STARTUP")
5168 (let ((startup (assq 'startup alist
)))
5171 (append (cdr startup
) (org-split-string value
)))
5172 (push (cons 'startup
(org-split-string value
)) alist
))))
5174 (let ((tag-cell (assq 'tags alist
)))
5177 (append (cdr tag-cell
)
5179 (org-split-string value
)))
5180 (push (cons 'tags
(org-split-string value
)) alist
))))
5181 ((member key
'("TODO" "SEQ_TODO" "TYP_TODO"))
5182 (let ((todo (assq 'todo alist
))
5183 (value (cons (if (equal key
"TYP_TODO") 'type
'sequence
)
5184 (org-split-string value
))))
5185 (if todo
(push value
(cdr todo
))
5186 (push (list 'todo value
) alist
))))
5187 ((equal key
"SETUPFILE")
5188 (unless buffer-read-only
; Do not check in Gnus messages.
5189 (let ((f (and (org-string-nw-p value
)
5191 (org-remove-double-quotes value
)))))
5192 (when (and f
(file-readable-p f
) (not (member f files
)))
5194 (insert-file-contents f
)
5196 ;; Fake Org mode to benefit from cache
5197 ;; without recurring needlessly.
5198 (let ((major-mode 'org-mode
))
5199 (org--setup-collect-keywords
5200 regexp
(cons f files
) alist
)))))))))))))))
5203 (defun org--setup-process-tags (tags filetags
)
5204 "Precompute variables used for tags.
5205 TAGS is a list of tags and tag group symbols, as strings.
5206 FILETAGS is a list of tags, as strings."
5207 ;; Process the file tags.
5208 (org-set-local 'org-file-tags
5209 (mapcar #'org-add-prop-inherited filetags
))
5210 ;; Provide default tags if no local tags are found.
5211 (when (and (not tags
) org-tag-alist
)
5213 (mapcar (lambda (tag)
5217 (:startgrouptag
"[")
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 '(:startgrouptag
) org-tag-alist
)
5241 (when (equal (nth 1 tags
) ":") (setq group-flag t
)))
5243 (push '(:endgrouptag
) org-tag-alist
)
5244 (setq group-flag nil
))
5246 (push '(:grouptags
) org-tag-alist
)
5247 (setq group-flag
'append
))
5248 ((equal e
"\\n") (push '(:newline
) org-tag-alist
))
5250 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5251 "\\|{.+?}\\)" ; regular expression
5252 "\\(?:(\\(.\\))\\)?\\'")) e
)
5253 (let ((tag (match-string 1 e
))
5254 (key (and (match-beginning 2)
5255 (string-to-char (match-string 2 e
)))))
5256 (cond ((eq group-flag
'append
)
5257 (setcar org-tag-groups-alist
5258 (append (car org-tag-groups-alist
) (list tag
))))
5259 (group-flag (push (list tag
) org-tag-groups-alist
)))
5260 ;; Push all tags in groups, no matter if they already exist.
5261 (unless (and (not group-flag
) (assoc tag org-tag-alist
))
5262 (push (cons tag key
) org-tag-alist
))))))))
5263 (setq org-tag-alist
(nreverse org-tag-alist
)))
5265 (defun org-file-contents (file &optional noerror
)
5266 "Return the contents of FILE, as a string."
5267 (if (and file
(file-readable-p file
))
5269 (insert-file-contents file
)
5271 (funcall (if noerror
'message
'error
)
5272 "Cannot read file \"%s\"%s"
5274 (let ((from (buffer-file-name (buffer-base-buffer))))
5275 (if from
(concat " (referenced in file \"" from
"\")") "")))))
5277 (defun org-extract-log-state-settings (x)
5278 "Extract the log state setting from a TODO keyword string.
5279 This will extract info from a string like \"WAIT(w@/!)\"."
5280 (let (kw key log1 log2
)
5281 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x
)
5282 (setq kw
(match-string 1 x
)
5283 key
(and (match-end 2) (match-string 2 x
))
5284 log1
(and (match-end 3) (match-string 3 x
))
5285 log2
(and (match-end 4) (match-string 4 x
)))
5288 (and log1
(if (equal log1
"!") 'time
'note
))
5289 (and log2
(if (equal log2
"!") 'time
'note
)))))))
5291 (defun org-remove-keyword-keys (list)
5292 "Remove a pair of parenthesis at the end of each string in LIST."
5294 (if (string-match "(.*)$" x
)
5295 (substring x
0 (match-beginning 0))
5299 (defun org-assign-fast-keys (alist)
5300 "Assign fast keys to a keyword-key alist.
5301 Respect keys that are already there."
5302 (let (new e
(alt ?
0))
5303 (while (setq e
(pop alist
))
5304 (if (or (memq (car e
) '(:newline
:grouptags
:endgroup
:startgroup
))
5305 (cdr e
)) ;; Key already assigned.
5307 (let ((clist (string-to-list (downcase (car e
))))
5308 (used (append new alist
)))
5309 (when (= (car clist
) ?
@)
5311 (while (and clist
(rassoc (car clist
) used
))
5314 (while (rassoc alt used
)
5316 (push (cons (car e
) (or (car clist
) alt
)) new
))))
5319 ;;; Some variables used in various places
5321 (defvar org-window-configuration nil
5322 "Used in various places to store a window configuration.")
5323 (defvar org-selected-window nil
5324 "Used in various places to store a window configuration.")
5325 (defvar org-finish-function nil
5326 "Function to be called when `C-c C-c' is used.
5327 This is for getting out of special buffers like capture.")
5330 ;; FIXME: Occasionally check by commenting these, to make sure
5331 ;; no other functions uses these, forgetting to let-bind them.
5332 (org-no-warnings (defvar entry
)) ;; unprefixed, from calendar.el
5333 (defvar org-last-state
)
5334 (org-no-warnings (defvar date
)) ;; unprefixed, from calendar.el
5336 ;; Defined somewhere in this file, but used before definition.
5337 (defvar org-entities
) ;; defined in org-entities.el
5338 (defvar org-struct-menu
)
5339 (defvar org-org-menu
)
5340 (defvar org-tbl-menu
)
5342 ;;;; Define the Org-mode
5344 ;; We use a before-change function to check if a table might need
5346 (defvar org-table-may-need-update t
5347 "Indicates that a table might need an update.
5348 This variable is set by `org-before-change-function'.
5349 `org-table-align' sets it back to nil.")
5350 (defun org-before-change-function (beg end
)
5351 "Every change indicates that a table might need an update."
5352 (setq org-table-may-need-update t
))
5353 (defvar org-mode-map
)
5354 (defvar org-inhibit-startup-visibility-stuff nil
) ; Dynamically-scoped param.
5355 (defvar org-agenda-keep-modes nil
) ; Dynamically-scoped param.
5356 (defvar org-inhibit-logging nil
) ; Dynamically-scoped param.
5357 (defvar org-inhibit-blocking nil
) ; Dynamically-scoped param.
5358 (defvar org-table-buffer-is-an nil
)
5360 (defvar bidi-paragraph-direction
)
5361 (defvar buffer-face-mode-face
)
5364 (if (and (not (keymapp outline-mode-map
)) (featurep 'allout
))
5365 (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"))
5366 (require 'noutline
"noutline" 'noerror
) ;; stock XEmacs does not have it
5368 ;; Other stuff we need.
5369 (require 'time-date
)
5370 (unless (fboundp 'time-subtract
) (defalias 'time-subtract
'subtract-time
))
5372 (autoload 'easy-menu-add
"easymenu")
5375 ;; (require 'org-macs) moved higher up in the file before it is first used
5376 (require 'org-entities
)
5377 ;; (require 'org-compat) moved higher up in the file before it is first used
5378 (require 'org-faces
)
5380 (require 'org-pcomplete
)
5382 (require 'org-footnote
)
5383 (require 'org-macro
)
5389 (define-derived-mode org-mode outline-mode
"Org"
5390 "Outline-based notes management and organizer, alias
5391 \"Carsten's outline-mode for keeping track of everything.\"
5393 Org-mode develops organizational tasks around a NOTES file which
5394 contains information about projects as plain text. Org-mode is
5395 implemented on top of outline-mode, which is ideal to keep the content
5396 of large files well structured. It supports ToDo items, deadlines and
5397 time stamps, which magically appear in the diary listing of the Emacs
5398 calendar. Tables are easily created with a built-in table editor.
5399 Plain text URL-like links connect to websites, emails (VM), Usenet
5400 messages (Gnus), BBDB entries, and any files related to the project.
5401 For printing and sharing of notes, an Org-mode file (or a part of it)
5402 can be exported as a structured ASCII or HTML file.
5404 The following commands are available:
5408 ;; Get rid of Outline menus, they are not needed
5409 ;; Need to do this here because define-derived-mode sets up
5410 ;; the keymap so late. Still, it is a waste to call this each time
5411 ;; we switch another buffer into org-mode.
5412 (if (featurep 'xemacs
)
5413 (when (boundp 'outline-mode-menu-heading
)
5414 ;; Assume this is Greg's port, it uses easymenu
5415 (easy-menu-remove outline-mode-menu-heading
)
5416 (easy-menu-remove outline-mode-menu-show
)
5417 (easy-menu-remove outline-mode-menu-hide
))
5418 (define-key org-mode-map
[menu-bar headings
] 'undefined
)
5419 (define-key org-mode-map
[menu-bar hide
] 'undefined
)
5420 (define-key org-mode-map
[menu-bar show
] 'undefined
))
5422 (org-load-modules-maybe)
5423 (easy-menu-add org-org-menu
)
5424 (easy-menu-add org-tbl-menu
)
5425 (org-install-agenda-files-menu)
5426 (if org-descriptive-links
(add-to-invisibility-spec '(org-link)))
5427 (add-to-invisibility-spec '(org-cwidth))
5428 (add-to-invisibility-spec '(org-hide-block . t
))
5429 (when (featurep 'xemacs
)
5430 (org-set-local 'line-move-ignore-invisible t
))
5431 (org-set-local 'outline-regexp org-outline-regexp
)
5432 (org-set-local 'outline-level
'org-outline-level
)
5433 (setq bidi-paragraph-direction
'left-to-right
)
5434 (when (and org-ellipsis
5435 (fboundp 'set-display-table-slot
) (boundp 'buffer-display-table
)
5436 (fboundp 'make-glyph-code
))
5437 (unless org-display-table
5438 (setq org-display-table
(make-display-table)))
5439 (set-display-table-slot
5442 (lambda (c) (make-glyph-code c
(and (not (stringp org-ellipsis
))
5444 (if (stringp org-ellipsis
) org-ellipsis
"..."))))
5445 (setq buffer-display-table org-display-table
))
5446 (org-set-regexps-and-options)
5447 (org-set-font-lock-defaults)
5448 (when (and org-tag-faces
(not org-tags-special-faces-re
))
5449 ;; tag faces set outside customize.... force initialization.
5450 (org-set-tag-faces 'org-tag-faces org-tag-faces
))
5452 (org-set-local 'calc-embedded-open-mode
"# ")
5453 ;; Modify a few syntax entries
5454 (modify-syntax-entry ?
@ "w")
5455 (modify-syntax-entry ?
\" "\"")
5456 (modify-syntax-entry ?
\\ "_")
5457 (modify-syntax-entry ?~
"_")
5458 (if org-startup-truncated
(setq truncate-lines t
))
5459 (when org-startup-indented
(require 'org-indent
) (org-indent-mode 1))
5460 (org-set-local 'font-lock-unfontify-region-function
5461 'org-unfontify-region
)
5462 ;; Activate before-change-function
5463 (org-set-local 'org-table-may-need-update t
)
5464 (org-add-hook 'before-change-functions
'org-before-change-function nil
5466 ;; Check for running clock before killing a buffer
5467 (org-add-hook 'kill-buffer-hook
'org-check-running-clock nil
'local
)
5468 ;; Initialize macros templates.
5469 (org-macro-initialize-templates)
5470 ;; Initialize radio targets.
5471 (org-update-radio-target-regexp)
5473 (org-set-local 'indent-line-function
'org-indent-line
)
5474 (org-set-local 'indent-region-function
'org-indent-region
)
5475 ;; Filling and auto-filling.
5478 (org-setup-comments-handling)
5479 ;; Initialize cache.
5480 (org-element-cache-reset)
5481 ;; Beginning/end of defun
5482 (org-set-local 'beginning-of-defun-function
'org-backward-element
)
5483 (org-set-local 'end-of-defun-function
5485 (if (not (org-at-heading-p))
5486 (org-forward-element)
5487 (org-forward-element)
5488 (forward-char -
1))))
5489 ;; Next error for sparse trees
5490 (org-set-local 'next-error-function
'org-occur-next-match
)
5491 ;; Make sure dependence stuff works reliably, even for users who set it
5493 (if org-enforce-todo-dependencies
5494 (add-hook 'org-blocker-hook
5495 'org-block-todo-from-children-or-siblings-or-parent
)
5496 (remove-hook 'org-blocker-hook
5497 'org-block-todo-from-children-or-siblings-or-parent
))
5498 (if org-enforce-todo-checkbox-dependencies
5499 (add-hook 'org-blocker-hook
5500 'org-block-todo-from-checkboxes
)
5501 (remove-hook 'org-blocker-hook
5502 'org-block-todo-from-checkboxes
))
5504 ;; Align options lines
5506 'align-mode-rules-list
5507 '((org-in-buffer-settings
5508 (regexp .
"^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5509 (modes .
'(org-mode)))))
5512 (org-set-local 'imenu-create-index-function
5513 'org-imenu-get-tree
)
5515 ;; Make isearch reveal context
5516 (if (or (featurep 'xemacs
)
5517 (not (boundp 'outline-isearch-open-invisible-function
)))
5518 ;; Emacs 21 and XEmacs make use of the hook
5519 (org-add-hook 'isearch-mode-end-hook
'org-isearch-end
'append
'local
)
5520 ;; Emacs 22 deals with this through a special variable
5521 (org-set-local 'outline-isearch-open-invisible-function
5522 (lambda (&rest ignore
) (org-show-context 'isearch
))))
5524 ;; Setup the pcomplete hooks
5525 (set (make-local-variable 'pcomplete-command-completion-function
)
5526 'org-pcomplete-initial
)
5527 (set (make-local-variable 'pcomplete-command-name-function
)
5528 'org-command-at-point
)
5529 (set (make-local-variable 'pcomplete-default-completion-function
)
5531 (set (make-local-variable 'pcomplete-parse-arguments-function
)
5532 'org-parse-arguments
)
5533 (set (make-local-variable 'pcomplete-termination-string
) "")
5534 (when (>= emacs-major-version
23)
5535 (set (make-local-variable 'buffer-face-mode-face
) 'org-default
))
5537 ;; If empty file that did not turn on org-mode automatically, make it to.
5538 (if (and org-insert-mode-line-in-empty-file
5539 (org-called-interactively-p 'any
)
5540 (= (point-min) (point-max)))
5541 (insert "# -*- mode: org -*-\n\n"))
5542 (unless org-inhibit-startup
5544 (and org-startup-with-beamer-mode
(org-beamer-mode))
5545 (when org-startup-align-all-tables
5546 (org-table-map-tables 'org-table-align
'quietly
))
5547 (when org-startup-with-inline-images
5548 (org-display-inline-images))
5549 (when org-startup-with-latex-preview
5550 (org-toggle-latex-fragment))
5551 (unless org-inhibit-startup-visibility-stuff
5552 (org-set-startup-visibility))
5553 (org-refresh-effort-properties)))
5554 ;; Try to set org-hide correctly
5555 (let ((foreground (org-find-invisible-foreground)))
5557 (set-face-foreground 'org-hide foreground
))))
5559 ;; Update `customize-package-emacs-version-alist'
5560 (add-to-list 'customize-package-emacs-version-alist
5561 '(Org ("6.21b" .
"23.1") ("6.33x" .
"23.2")
5562 ("7.8.11" .
"24.1") ("7.9.4" .
"24.3")
5563 ("8.2.6" .
"24.4") ("8.3" .
"25.1")))
5565 (defvar org-mode-transpose-word-syntax-table
5566 (let ((st (make-syntax-table text-mode-syntax-table
)))
5567 (mapc (lambda(c) (modify-syntax-entry
5568 (string-to-char (car c
)) "w p" st
))
5572 (when (fboundp 'abbrev-table-put
)
5573 (abbrev-table-put org-mode-abbrev-table
5574 :parents
(list text-mode-abbrev-table
)))
5576 (defun org-find-invisible-foreground ()
5577 (let ((candidates (remove
5580 (list (face-background 'default
)
5581 (face-background 'org-default
))
5584 (when (boundp alist
)
5585 (cdr (assoc 'background-color
(symbol-value alist
)))))
5586 '(default-frame-alist initial-frame-alist window-system-default-frame-alist
))
5587 (list (face-foreground 'org-hide
))))))
5588 (car (remove nil candidates
))))
5590 (defun org-current-time (&optional rounding-minutes past
)
5591 "Current time, possibly rounded to ROUNDING-MINUTES.
5592 When ROUNDING-MINUTES is not an integer, fall back on the car of
5593 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5594 the rounding returns a past time."
5595 (let ((r (or (and (integerp rounding-minutes
) rounding-minutes
)
5596 (car org-time-stamp-rounding-minutes
)))
5597 (time (decode-time)) res
)
5602 (append (list 0 (* r
(floor (+ .5 (/ (float (nth 1 time
)) r
)))))
5604 (if (and past
(< (org-float-time (time-subtract (current-time) res
)) 0))
5605 (seconds-to-time (- (org-float-time res
) (* r
60)))
5609 "Return today date, considering `org-extend-today-until'."
5611 (time-subtract (current-time)
5612 (list 0 (* 3600 org-extend-today-until
) 0))))
5614 ;;;; Font-Lock stuff, including the activators
5616 (defvar org-mouse-map
(make-sparse-keymap))
5617 (org-defkey org-mouse-map
[mouse-2
] 'org-open-at-mouse
)
5618 (org-defkey org-mouse-map
[mouse-3
] 'org-find-file-at-mouse
)
5619 (when org-mouse-1-follows-link
5620 (org-defkey org-mouse-map
[follow-link
] 'mouse-face
))
5621 (when org-tab-follows-link
5622 (org-defkey org-mouse-map
[(tab)] 'org-open-at-point
)
5623 (org-defkey org-mouse-map
"\C-i" 'org-open-at-point
))
5625 (require 'font-lock
)
5627 (defconst org-non-link-chars
"]\t\n\r<>")
5628 (defvar org-link-types
'("http" "https" "ftp" "mailto" "file" "file+emacs"
5629 "file+sys" "news" "shell" "elisp" "doi" "message"
5631 (defvar org-link-types-re nil
5632 "Matches a link that has a url-like prefix like \"http:\"")
5633 (defvar org-link-re-with-space nil
5634 "Matches a link with spaces, optional angular brackets around it.")
5635 (defvar org-link-re-with-space2 nil
5636 "Matches a link with spaces, optional angular brackets around it.")
5637 (defvar org-link-re-with-space3 nil
5638 "Matches a link with spaces, only for internal part in bracket links.")
5639 (defvar org-angle-link-re nil
5640 "Matches link with angular brackets, spaces are allowed.")
5641 (defvar org-plain-link-re nil
5642 "Matches plain link, without spaces.")
5643 (defvar org-bracket-link-regexp nil
5644 "Matches a link in double brackets.")
5645 (defvar org-bracket-link-analytic-regexp nil
5646 "Regular expression used to analyze links.
5647 Here is what the match groups contain after a match:
5653 (defvar org-bracket-link-analytic-regexp
++ nil
5654 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5655 (defvar org-any-link-re nil
5656 "Regular expression matching any link.")
5658 (defconst org-match-sexp-depth
3
5659 "Number of stacked braces for sub/superscript matching.")
5661 (defun org-create-multibrace-regexp (left right n
)
5662 "Create a regular expression which will match a balanced sexp.
5663 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5664 as single character strings.
5665 The regexp returned will match the entire expression including the
5666 delimiters. It will also define a single group which contains the
5667 match except for the outermost delimiters. The maximum depth of
5668 stacked delimiters is N. Escaping delimiters is not possible."
5669 (let* ((nothing (concat "[^" left right
"]*?"))
5672 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
5675 re
(concat re or next
)
5676 next
(concat "\\(?:" nothing left next right
"\\)+" nothing
)))
5677 (concat left
"\\(" re
"\\)" right
)))
5679 (defconst org-match-substring-regexp
5681 "\\(\\S-\\)\\([_^]\\)\\("
5682 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
5684 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
5686 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5687 "The regular expression matching a sub- or superscript.")
5689 (defconst org-match-substring-with-braces-regexp
5691 "\\(\\S-\\)\\([_^]\\)"
5692 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)")
5693 "The regular expression matching a sub- or superscript, forcing braces.")
5695 (defun org-make-link-regexps ()
5696 "Update the link regular expressions.
5697 This should be called after the variable `org-link-types' has changed."
5698 (let ((types-re (regexp-opt org-link-types t
)))
5699 (setq org-link-types-re
5700 (concat "\\`" types-re
":")
5701 org-link-re-with-space
5702 (concat "<?" types-re
":"
5703 "\\([^" org-non-link-chars
" ]"
5704 "[^" org-non-link-chars
"]*"
5705 "[^" org-non-link-chars
" ]\\)>?")
5706 org-link-re-with-space2
5707 (concat "<?" types-re
":"
5708 "\\([^" org-non-link-chars
" ]"
5710 "[^" org-non-link-chars
" ]\\)>?")
5711 org-link-re-with-space3
5712 (concat "<?" types-re
":"
5713 "\\([^" org-non-link-chars
" ]"
5716 (format "<%s:\\(\n?\\(?:[^>\n]+\n?\\)*\\)>" types-re
)
5720 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5721 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5722 org-bracket-link-regexp
5723 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5724 org-bracket-link-analytic-regexp
5727 "\\(" types-re
":\\)?"
5730 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5732 org-bracket-link-analytic-regexp
++
5735 "\\(" (regexp-opt (cons "coderef" org-link-types
) t
) ":\\)?"
5738 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5741 (concat "\\(" org-bracket-link-regexp
"\\)\\|\\("
5742 org-angle-link-re
"\\)\\|\\("
5743 org-plain-link-re
"\\)"))))
5745 (org-make-link-regexps)
5747 (defvar org-emph-face nil
)
5749 (defun org-do-emphasis-faces (limit)
5750 "Run through the buffer and emphasize strings."
5752 (while (and (not rtn
) (re-search-forward org-emph-re limit t
))
5753 (let* ((border (char-after (match-beginning 3)))
5754 (bre (regexp-quote (char-to-string border
))))
5755 (if (and (not (= border
(char-after (match-beginning 4))))
5756 (not (save-match-data
5757 (string-match (concat bre
".*" bre
)
5758 (replace-regexp-in-string
5760 (substring (match-string 2) 1 -
1))))))
5763 (setq a
(assoc (match-string 3) org-emphasis-alist
))
5764 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5768 (org-remove-flyspell-overlays-in
5769 (match-beginning 0) (match-end 0)))
5770 (add-text-properties (match-beginning 2) (match-end 2)
5771 '(font-lock-multiline t org-emphasis t
))
5772 (when org-hide-emphasis-markers
5773 (add-text-properties (match-end 4) (match-beginning 5)
5774 '(invisible org-link
))
5775 (add-text-properties (match-beginning 3) (match-end 3)
5776 '(invisible org-link
))))))
5777 (goto-char (1+ (match-beginning 0))))
5780 (defun org-emphasize (&optional char
)
5781 "Insert or change an emphasis, i.e. a font like bold or italic.
5782 If there is an active region, change that region to a new emphasis.
5783 If there is no region, just insert the marker characters and position
5784 the cursor between them.
5785 CHAR should be the marker character. If it is a space, it means to
5786 remove the emphasis of the selected region.
5787 If CHAR is not given (for example in an interactive call) it will be
5790 (let ((erc org-emphasis-regexp-components
)
5792 (string "") beg end move c s
)
5793 (if (org-region-active-p)
5794 (setq beg
(region-beginning) end
(region-end)
5795 string
(buffer-substring beg end
))
5799 (message "Emphasis marker or tag: [%s]"
5800 (mapconcat (lambda(e) (car e
)) org-emphasis-alist
""))
5801 (setq char
(read-char-exclusive)))
5802 (if (equal char ?\
)
5803 (setq s
"" move nil
)
5804 (unless (assoc (char-to-string char
) org-emphasis-alist
)
5805 (user-error "No such emphasis marker: \"%c\"" char
))
5806 (setq s
(char-to-string char
)))
5807 (while (and (> (length string
) 1)
5808 (equal (substring string
0 1) (substring string -
1))
5809 (assoc (substring string
0 1) org-emphasis-alist
))
5810 (setq string
(substring string
1 -
1)))
5811 (setq string
(concat s string s
))
5812 (if beg
(delete-region beg end
))
5814 (string-match (concat "[" (nth 0 erc
) "\n]")
5815 (char-to-string (char-before (point)))))
5818 (string-match (concat "[" (nth 1 erc
) "\n]")
5819 (char-to-string (char-after (point)))))
5820 (insert " ") (backward-char 1))
5822 (and move
(backward-char 1))))
5824 (defconst org-nonsticky-props
5825 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link
))
5827 (defsubst org-rear-nonsticky-at
(pos)
5828 (add-text-properties (1- pos
) pos
(list 'rear-nonsticky org-nonsticky-props
)))
5830 (defun org-activate-plain-links (limit)
5831 "Add link properties for plain links."
5833 (when (and (re-search-forward (concat org-plain-link-re
) limit t
)
5834 (not (member 'org-tag
5835 (get-text-property (1- (match-beginning 0)) 'face
)))
5836 (not (org-in-src-block-p)))
5837 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5838 (setq f
(get-text-property (match-beginning 0) 'face
))
5839 (setq hl
(org-match-string-no-properties 0))
5840 (if (or (eq f
'org-tag
)
5841 (and (listp f
) (memq 'org-tag f
)))
5843 (add-text-properties (match-beginning 0) (match-end 0)
5844 (list 'mouse-face
'highlight
5846 'htmlize-link
`(:uri
,hl
)
5847 'keymap org-mouse-map
))
5848 (org-rear-nonsticky-at (match-end 0)))
5851 (defun org-activate-code (limit)
5852 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t
)
5854 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5855 (remove-text-properties (match-beginning 0) (match-end 0)
5856 '(display t invisible t intangible t
))
5859 (defcustom org-src-fontify-natively t
5860 "When non-nil, fontify code in code blocks."
5863 :package-version
'(Org .
"8.3")
5864 :group
'org-appearance
5867 (defcustom org-allow-promoting-top-level-subtree nil
5868 "When non-nil, allow promoting a top level subtree.
5869 The leading star of the top level headline will be replaced
5873 :group
'org-appearance
)
5875 (defun org-fontify-meta-lines-and-blocks (limit)
5877 (org-fontify-meta-lines-and-blocks-1 limit
)
5878 (error (message "org-mode fontification error"))))
5880 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5881 "Fontify #+ lines and blocks."
5882 (let ((case-fold-search t
))
5883 (if (re-search-forward
5884 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5886 (let ((beg (match-beginning 0))
5887 (block-start (match-end 0))
5889 (lang (match-string 7))
5890 (beg1 (line-beginning-position 2))
5891 (dc1 (downcase (match-string 2)))
5892 (dc3 (downcase (match-string 3)))
5893 end end1 quoting block-type ovl
)
5895 ((and (match-end 4) (equal dc3
"+begin"))
5897 (setq block-type
(downcase (match-string 5))
5898 quoting
(member block-type org-protecting-blocks
))
5899 (when (re-search-forward
5900 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5901 nil t
) ;; on purpose, we look further than LIMIT
5902 (setq end
(min (point-max) (match-end 0))
5903 end1
(min (point-max) (1- (match-beginning 0))))
5904 (setq block-end
(match-beginning 0))
5906 (org-remove-flyspell-overlays-in beg1 end1
)
5907 (remove-text-properties beg end
5908 '(display t invisible t intangible t
)))
5909 (add-text-properties
5910 beg end
'(font-lock-fontified t font-lock-multiline t
))
5911 (add-text-properties beg beg1
'(face org-meta-line
))
5912 (org-remove-flyspell-overlays-in beg beg1
)
5913 (add-text-properties ; For end_src
5914 end1
(min (point-max) (1+ end
)) '(face org-meta-line
))
5915 (org-remove-flyspell-overlays-in end1 end
)
5917 ((and lang
(not (string= lang
"")) org-src-fontify-natively
)
5918 (org-src-font-lock-fontify-block lang block-start block-end
)
5919 (add-text-properties beg1 block-end
'(src-block t
)))
5921 (add-text-properties beg1
(min (point-max) (1+ end1
))
5922 '(face org-block
))) ; end of source block
5923 ((not org-fontify-quote-and-verse-blocks
))
5924 ((string= block-type
"quote")
5925 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-quote
)))
5926 ((string= block-type
"verse")
5927 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-verse
))))
5928 (add-text-properties beg beg1
'(face org-block-begin-line
))
5929 (add-text-properties (min (point-max) (1+ end
)) (min (point-max) (1+ end1
))
5930 '(face org-block-end-line
))
5932 ((member dc1
'("+title:" "+author:" "+email:" "+date:"))
5933 (org-remove-flyspell-overlays-in
5935 (if (equal "+title:" dc1
) (match-end 2) (match-end 0)))
5936 (add-text-properties
5938 (if (member (intern (substring dc1
1 -
1)) org-hidden-keywords
)
5939 '(font-lock-fontified t invisible t
)
5940 '(font-lock-fontified t face org-document-info-keyword
)))
5941 (add-text-properties
5942 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5943 (if (string-equal dc1
"+title:")
5944 '(font-lock-fontified t face org-document-title
)
5945 '(font-lock-fontified t face org-document-info
))))
5946 ((equal dc1
"+caption:")
5947 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5948 (remove-text-properties (match-beginning 0) (match-end 0)
5949 '(display t invisible t intangible t
))
5950 (add-text-properties (match-beginning 1) (match-end 3)
5951 '(font-lock-fontified t face org-meta-line
))
5952 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5953 '(font-lock-fontified t face org-block
))
5955 ((member dc3
'(" " ""))
5956 (org-remove-flyspell-overlays-in beg
(match-end 0))
5957 (add-text-properties
5959 '(font-lock-fontified t face font-lock-comment-face
)))
5960 (t ;; just any other in-buffer setting, but not indented
5961 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5962 (remove-text-properties (match-beginning 0) (match-end 0)
5963 '(display t invisible t intangible t
))
5964 (add-text-properties beg
(match-end 0)
5965 '(font-lock-fontified t face org-meta-line
))
5968 (defun org-fontify-drawers (limit)
5970 (when (re-search-forward org-drawer-regexp limit t
)
5971 (add-text-properties
5972 (match-beginning 0) (match-end 0)
5973 '(font-lock-fontified t face org-special-keyword
))
5974 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5977 (defun org-fontify-macros (limit)
5979 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t
)
5980 (add-text-properties
5981 (match-beginning 0) (match-end 0)
5982 '(font-lock-fontified t face org-macro
))
5983 (when org-hide-macro-markers
5984 (add-text-properties (match-end 2) (match-beginning 2)
5986 (add-text-properties (match-beginning 1) (match-end 1)
5988 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5991 (defun org-activate-angle-links (limit)
5992 "Add text properties for angle links."
5993 (if (and (re-search-forward org-angle-link-re limit t
)
5994 (not (org-in-src-block-p)))
5996 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5997 (add-text-properties (match-beginning 0) (match-end 0)
5998 (list 'mouse-face
'highlight
5999 'keymap org-mouse-map
6000 'font-lock-multiline t
))
6001 (org-rear-nonsticky-at (match-end 0))
6004 (defun org-activate-footnote-links (limit)
6005 "Add text properties for footnotes."
6006 (let ((fn (org-footnote-next-reference-or-definition limit
)))
6008 (let* ((beg (nth 1 fn
))
6011 (referencep (/= (line-beginning-position) beg
)))
6012 (when (and referencep
(nth 3 fn
))
6015 (search-forward (or label
"fn:"))
6016 (org-remove-flyspell-overlays-in beg
(match-end 0))))
6017 (add-text-properties beg end
6018 (list 'mouse-face
'highlight
6019 'keymap org-mouse-map
6021 (if referencep
"Footnote reference"
6022 "Footnote definition")
6023 'font-lock-fontified t
6024 'font-lock-multiline t
6025 'face
'org-footnote
))))))
6027 (defun org-activate-bracket-links (limit)
6028 "Add text properties for bracketed links."
6029 (if (and (re-search-forward org-bracket-link-regexp limit t
)
6030 (not (org-in-src-block-p)))
6031 (let* ((hl (org-match-string-no-properties 1))
6032 (help (concat "LINK: " (save-match-data (org-link-unescape hl
))))
6033 (ip (org-maybe-intangible
6034 (list 'invisible
'org-link
6035 'keymap org-mouse-map
'mouse-face
'highlight
6036 'font-lock-multiline t
'help-echo help
6037 'htmlize-link
`(:uri
,hl
))))
6038 (vp (list 'keymap org-mouse-map
'mouse-face
'highlight
6039 'font-lock-multiline t
'help-echo help
6040 'htmlize-link
`(:uri
,hl
))))
6041 ;; We need to remove the invisible property here. Table narrowing
6042 ;; may have made some of this invisible.
6043 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6044 (remove-text-properties (match-beginning 0) (match-end 0)
6048 (add-text-properties (match-beginning 0) (match-beginning 3) ip
)
6049 (org-rear-nonsticky-at (match-beginning 3))
6050 (add-text-properties (match-beginning 3) (match-end 3) vp
)
6051 (org-rear-nonsticky-at (match-end 3))
6052 (add-text-properties (match-end 3) (match-end 0) ip
)
6053 (org-rear-nonsticky-at (match-end 0)))
6054 (add-text-properties (match-beginning 0) (match-beginning 1) ip
)
6055 (org-rear-nonsticky-at (match-beginning 1))
6056 (add-text-properties (match-beginning 1) (match-end 1) vp
)
6057 (org-rear-nonsticky-at (match-end 1))
6058 (add-text-properties (match-end 1) (match-end 0) ip
)
6059 (org-rear-nonsticky-at (match-end 0)))
6062 (defun org-activate-dates (limit)
6063 "Add text properties for dates."
6064 (if (and (re-search-forward org-tsr-regexp-both limit t
)
6065 (not (equal (char-before (match-beginning 0)) 91)))
6067 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6068 (add-text-properties (match-beginning 0) (match-end 0)
6069 (list 'mouse-face
'highlight
6070 'keymap org-mouse-map
))
6071 (org-rear-nonsticky-at (match-end 0))
6072 (when org-display-custom-times
6074 (org-display-custom-time (match-beginning 3) (match-end 3)))
6075 (org-display-custom-time (match-beginning 1) (match-end 1)))
6078 (defvar org-target-link-regexp nil
6079 "Regular expression matching radio targets in plain text.")
6080 (make-variable-buffer-local 'org-target-link-regexp
)
6082 (defconst org-target-regexp
(let ((border "[^<>\n\r \t]"))
6083 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6084 border border border
))
6085 "Regular expression matching a link target.")
6087 (defconst org-radio-target-regexp
(format "<%s>" org-target-regexp
)
6088 "Regular expression matching a radio target.")
6090 (defconst org-any-target-regexp
6091 (format "%s\\|%s" org-radio-target-regexp org-target-regexp
)
6092 "Regular expression matching any target.")
6094 (defun org-activate-target-links (limit)
6095 "Add text properties for target matches."
6096 (when org-target-link-regexp
6097 (let ((case-fold-search t
))
6098 (if (re-search-forward org-target-link-regexp limit t
)
6100 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6101 (add-text-properties (match-beginning 1) (match-end 1)
6102 (list 'mouse-face
'highlight
6103 'keymap org-mouse-map
6104 'help-echo
"Radio target link"
6105 'org-linked-text t
))
6106 (org-rear-nonsticky-at (match-end 1))
6109 (defun org-update-radio-target-regexp ()
6110 "Find all radio targets in this file and update the regular expression.
6111 Also refresh fontification if needed."
6113 (let ((old-regexp org-target-link-regexp
)
6114 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6115 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6117 (org-with-wide-buffer
6118 (goto-char (point-min))
6120 (while (re-search-forward org-radio-target-regexp nil t
)
6121 ;; Make sure point is really within the object.
6123 (let ((obj (org-element-context)))
6124 (when (eq (org-element-type obj
) 'radio-target
)
6125 (add-to-list 'rtn
(org-element-property :value obj
)))))
6127 (setq org-target-link-regexp
6132 (replace-regexp-in-string
6133 " +" "\\s-+" (regexp-quote x
) t t
))
6137 (unless (equal old-regexp org-target-link-regexp
)
6139 (let ((regexp (cond ((not old-regexp
) org-target-link-regexp
)
6140 ((not org-target-link-regexp
) old-regexp
)
6145 (substring re
(length before-re
)
6146 (- (length after-re
))))
6147 (list old-regexp org-target-link-regexp
)
6150 (org-with-wide-buffer
6151 (goto-char (point-min))
6152 (while (re-search-forward regexp nil t
)
6153 (org-element-cache-refresh (match-beginning 1)))))
6154 ;; Re fontify buffer.
6155 (when (memq 'radio org-highlight-links
)
6156 (org-restart-font-lock)))))
6158 (defun org-hide-wide-columns (limit)
6160 (setq s
(text-property-any (point) (or limit
(point-max))
6163 (setq e
(next-single-property-change s
'org-cwidth
))
6164 (add-text-properties s e
(org-maybe-intangible '(invisible org-cwidth
)))
6168 (defvar org-latex-and-related-regexp nil
6169 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6171 (defun org-compute-latex-and-related-regexp ()
6172 "Compute regular expression for LaTeX, entities and sub/superscript.
6173 Result depends on variable `org-highlight-latex-and-related'."
6175 'org-latex-and-related-regexp
6177 (cond ((not (memq 'script org-highlight-latex-and-related
)) nil
)
6178 ((eq org-use-sub-superscripts
'{})
6179 (list org-match-substring-with-braces-regexp
))
6180 (org-use-sub-superscripts (list org-match-substring-regexp
))))
6182 (when (memq 'latex org-highlight-latex-and-related
)
6183 (let ((matchers (plist-get org-format-latex-options
:matchers
)))
6186 (and (member (car x
) matchers
) (nth 1 x
)))
6187 org-latex-regexps
)))))
6189 (when (memq 'entities org-highlight-latex-and-related
)
6190 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6191 (mapconcat 'identity
(append re-latex re-entities re-sub
) "\\|"))))
6193 (defun org-do-latex-and-related (limit)
6194 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6195 LIMIT bounds the search for syntax to highlight. Stop at first
6196 highlighted object, if any. Return t if some highlighting was
6197 done, nil otherwise."
6198 (when (org-string-nw-p org-latex-and-related-regexp
)
6200 (while (re-search-forward org-latex-and-related-regexp limit t
)
6201 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6203 '(org-code org-verbatim underline
))
6204 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6208 (font-lock-prepend-text-property
6209 (+ offset
(match-beginning 0)) (match-end 0)
6210 'face
'org-latex-and-related
)
6211 (add-text-properties (+ offset
(match-beginning 0)) (match-end 0)
6212 '(font-lock-multiline t
)))
6216 (defun org-restart-font-lock ()
6217 "Restart `font-lock-mode', to force refontification."
6218 (when (and (boundp 'font-lock-mode
) font-lock-mode
)
6220 (font-lock-mode 1)))
6222 (defun org-activate-tags (limit)
6223 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t
)
6225 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6226 (add-text-properties (match-beginning 1) (match-end 1)
6227 (list 'mouse-face
'highlight
6228 'keymap org-mouse-map
))
6229 (org-rear-nonsticky-at (match-end 1))
6232 (defun org-outline-level ()
6233 "Compute the outline level of the heading at point.
6235 If this is called at a normal headline, the level is the number
6236 of stars. Use `org-reduced-level' to remove the effect of
6237 `org-odd-levels'. Unlike to `org-current-level', this function
6238 takes into consideration inlinetasks."
6239 (org-with-wide-buffer
6241 (if (re-search-backward org-outline-regexp-bol nil t
)
6242 (1- (- (match-end 0) (match-beginning 0)))
6245 (defvar org-font-lock-keywords nil
)
6247 (defsubst org-re-property
(property &optional literal allow-null value
)
6248 "Return a regexp matching a PROPERTY line.
6250 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6251 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6252 non-nil, match properties even without a value.
6254 Match group 3 is set to the value when it exists. If there is no
6255 value and ALLOW-NULL is non-nil, it is set to the empty string.
6257 With optional argument VALUE, match only property lines with
6258 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6259 unless LITERAL is non-nil."
6262 (format "\\(?1::\\(?2:%s\\):\\)"
6263 (if literal property
(regexp-quote property
)))
6265 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6266 (if literal value
(regexp-quote value
))))
6268 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6270 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6272 (defconst org-property-re
6273 (org-re-property "\\S-+" 'literal t
)
6274 "Regular expression matching a property line.
6275 There are four matching groups:
6276 1: :PROPKEY: including the leading and trailing colon,
6277 2: PROPKEY without the leading and trailing colon,
6278 3: PROPVAL without leading or trailing spaces,
6279 4: the indentation of the current line,
6280 5: trailing whitespace.")
6282 (defvar org-font-lock-hook nil
6283 "Functions to be called for special font lock stuff.")
6285 (defvar org-font-lock-set-keywords-hook nil
6286 "Functions that can manipulate `org-font-lock-extra-keywords'.
6287 This is called after `org-font-lock-extra-keywords' is defined, but before
6288 it is installed to be used by font lock. This can be useful if something
6289 needs to be inserted at a specific position in the font-lock sequence.")
6291 (defun org-font-lock-hook (limit)
6292 "Run `org-font-lock-hook' within LIMIT."
6293 (run-hook-with-args 'org-font-lock-hook limit
))
6295 (defun org-set-font-lock-defaults ()
6296 "Set font lock defaults for the current buffer."
6297 (let* ((em org-fontify-emphasized-text
)
6298 (lk org-highlight-links
)
6299 (org-font-lock-extra-keywords
6302 '(org-font-lock-hook)
6304 `(,(if org-fontify-whole-heading-line
6305 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6306 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6307 (1 (org-get-level-face 1))
6308 (2 (org-get-level-face 2))
6309 (3 (org-get-level-face 3)))
6311 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6314 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t
))
6315 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t
))
6316 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t
))
6317 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t
))
6319 '(org-fontify-drawers)
6321 (list org-property-re
6322 '(1 'org-special-keyword t
)
6323 '(3 'org-property-value t
))
6325 (if (memq 'tag lk
) '(org-activate-tags (1 'org-tag prepend
)))
6326 (if (memq 'angle lk
) '(org-activate-angle-links (0 'org-link t
)))
6327 (if (memq 'plain lk
) '(org-activate-plain-links (0 'org-link t
)))
6328 (if (memq 'bracket lk
) '(org-activate-bracket-links (0 'org-link t
)))
6329 (if (memq 'radio lk
) '(org-activate-target-links (1 'org-link t
)))
6330 (if (memq 'date lk
) '(org-activate-dates (0 'org-date t
)))
6331 (if (memq 'footnote lk
) '(org-activate-footnote-links))
6333 (list org-any-target-regexp
'(0 'org-target t
))
6335 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t
))
6337 '(org-fontify-macros)
6338 '(org-hide-wide-columns (0 nil append
))
6340 (list (format org-heading-keyword-regexp-format
6342 '(2 (org-get-todo-face 2) t
))
6344 (if org-fontify-done-headline
6345 (list (format org-heading-keyword-regexp-format
6348 (mapconcat 'regexp-quote org-done-keywords
"\\|")
6350 '(2 'org-headline-done t
))
6353 '(org-font-lock-add-priority-faces)
6355 '(org-font-lock-add-tag-faces)
6357 (if (and org-group-tags org-tag-groups-alist
)
6358 (list (concat org-outline-regexp-bol
".+\\(:"
6359 (regexp-opt (mapcar 'car org-tag-groups-alist
))
6361 '(1 'org-tag-group prepend
)))
6363 (list (concat "\\<" org-comment-string
) '(0 'org-special-keyword t
))
6364 (list (concat "\\<" org-deadline-string
) '(0 'org-special-keyword t
))
6365 (list (concat "\\<" org-scheduled-string
) '(0 'org-special-keyword t
))
6366 (list (concat "\\<" org-closed-string
) '(0 'org-special-keyword t
))
6367 (list (concat "\\<" org-clock-string
) '(0 'org-special-keyword t
))
6370 (if (featurep 'xemacs
)
6371 '(org-do-emphasis-faces (0 nil append
))
6372 '(org-do-emphasis-faces)))
6374 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6375 1 'org-checkbox prepend
)
6376 (if (cdr (assq 'checkbox org-list-automatic-rules
))
6377 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6378 (0 (org-get-checkbox-statistics-face) t
)))
6379 ;; Description list items
6380 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6381 1 'org-list-dt prepend
)
6382 ;; ARCHIVEd headings
6384 org-outline-regexp-bol
6385 "\\(.*:" org-archive-tag
":.*\\)")
6386 '(1 'org-archived prepend
))
6388 '(org-do-latex-and-related)
6389 '(org-fontify-entities)
6390 '(org-raise-scripts)
6392 '(org-activate-code (1 'org-code t
))
6395 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6398 '(9 'org-special-keyword t
))
6399 ;; Blocks and meta lines
6400 '(org-fontify-meta-lines-and-blocks))))
6401 (setq org-font-lock-extra-keywords
(delq nil org-font-lock-extra-keywords
))
6402 (run-hooks 'org-font-lock-set-keywords-hook
)
6403 ;; Now set the full font-lock-keywords
6404 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords
)
6405 (org-set-local 'font-lock-defaults
6406 '(org-font-lock-keywords t nil nil backward-paragraph
))
6407 (kill-local-variable 'font-lock-keywords
) nil
))
6409 (defun org-toggle-pretty-entities ()
6410 "Toggle the composition display of entities as UTF8 characters."
6412 (org-set-local 'org-pretty-entities
(not org-pretty-entities
))
6413 (org-restart-font-lock)
6414 (if org-pretty-entities
6415 (message "Entities are now displayed as UTF8 characters")
6418 (org-decompose-region (point-min) (point-max))
6419 (message "Entities are now displayed as plain text"))))
6421 (defvar org-custom-properties-overlays nil
6422 "List of overlays used for custom properties.")
6423 (make-variable-buffer-local 'org-custom-properties-overlays
)
6425 (defun org-toggle-custom-properties-visibility ()
6426 "Display or hide properties in `org-custom-properties'."
6428 (if org-custom-properties-overlays
6429 (progn (mapc #'delete-overlay org-custom-properties-overlays
)
6430 (setq org-custom-properties-overlays nil
))
6431 (when org-custom-properties
6432 (org-with-wide-buffer
6433 (goto-char (point-min))
6434 (let ((regexp (org-re-property (regexp-opt org-custom-properties
) t t
)))
6435 (while (re-search-forward regexp nil t
)
6436 (let ((end (cdr (save-match-data (org-get-property-block)))))
6437 (when (and end
(< (point) end
))
6438 ;; Hide first custom property in current drawer.
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 ;; Hide additional custom properties in the same drawer.
6444 (while (re-search-forward regexp end t
)
6445 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6446 (overlay-put o
'invisible t
)
6447 (overlay-put o
'org-custom-property t
)
6448 (push o org-custom-properties-overlays
)))))
6449 ;; Each entry is limited to a single property drawer.
6450 (outline-next-heading)))))))
6452 (defun org-fontify-entities (limit)
6453 "Find an entity to fontify."
6455 (when org-pretty-entities
6457 ;; "\_ "-family is left out on purpose. Only the first one,
6458 ;; i.e., "\_ ", could be fontified anyway, and it would be
6459 ;; confusing when adding a second white space character.
6460 (while (re-search-forward
6461 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6463 (if (and (not (org-at-comment-p))
6464 (setq ee
(org-entity-get (match-string 1)))
6465 (= (length (nth 6 ee
)) 1))
6467 ((end (if (equal (match-string 2) "{}")
6470 (add-text-properties
6471 (match-beginning 0) end
6472 (list 'font-lock-fontified t
))
6473 (compose-region (match-beginning 0) end
6479 (defun org-fontify-like-in-org-mode (s &optional odd-levels
)
6480 "Fontify string S like in Org-mode."
6483 (let ((org-odd-levels-only odd-levels
))
6491 (defun org-get-level-face (n)
6492 "Get the right face for match N in font-lock matching of headlines."
6493 (setq org-l
(- (match-end 2) (match-beginning 1) 1))
6494 (if org-odd-levels-only
(setq org-l
(1+ (/ org-l
2))))
6495 (if org-cycle-level-faces
6496 (setq org-f
(nth (%
(1- org-l
) org-n-level-faces
) org-level-faces
))
6497 (setq org-f
(nth (1- (min org-l org-n-level-faces
)) org-level-faces
)))
6499 ((eq n
1) (if org-hide-leading-stars
'org-hide org-f
))
6501 (t (if org-level-color-stars-only nil org-f
))))
6503 (defun org-face-from-face-or-color (context inherit face-or-color
)
6504 "Create a face list that inherits INHERIT, but sets the foreground color.
6505 When FACE-OR-COLOR is not a string, just return it."
6506 (if (stringp face-or-color
)
6507 (list :inherit inherit
6508 (cdr (assoc context org-faces-easy-properties
))
6512 (defun org-get-todo-face (kwd)
6513 "Get the right face for a TODO keyword KWD.
6514 If KWD is a number, get the corresponding match group."
6515 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6516 (or (org-face-from-face-or-color
6517 'todo
'org-todo
(cdr (assoc kwd org-todo-keyword-faces
)))
6518 (and (member kwd org-done-keywords
) 'org-done
)
6521 (defun org-get-priority-face (priority)
6522 "Get the right face for PRIORITY.
6523 PRIORITY is a character."
6524 (or (org-face-from-face-or-color
6525 'priority
'org-priority
(cdr (assq priority org-priority-faces
)))
6528 (defun org-get-tag-face (tag)
6529 "Get the right face for TAG.
6530 If TAG is a number, get the corresponding match group."
6531 (let ((tag (if (wholenump tag
) (match-string tag
) tag
)))
6532 (or (org-face-from-face-or-color
6533 'tag
'org-tag
(cdr (assoc tag org-tag-faces
)))
6536 (defun org-font-lock-add-priority-faces (limit)
6537 "Add the special priority faces."
6538 (while (re-search-forward "^\\*+ .*?\\(\\[#\\(.\\)\\]\\)" limit t
)
6539 (add-text-properties
6540 (match-beginning 1) (match-end 1)
6541 (list 'face
(org-get-priority-face (string-to-char (match-string 2)))
6542 'font-lock-fontified t
))))
6544 (defun org-font-lock-add-tag-faces (limit)
6545 "Add the special tag faces."
6546 (when (and org-tag-faces org-tags-special-faces-re
)
6547 (while (re-search-forward org-tags-special-faces-re limit t
)
6548 (add-text-properties (match-beginning 1) (match-end 1)
6549 (list 'face
(org-get-tag-face 1)
6550 'font-lock-fontified t
))
6551 (backward-char 1))))
6553 (defun org-unfontify-region (beg end
&optional maybe_loudly
)
6554 "Remove fontification and activation overlays from links."
6555 (font-lock-default-unfontify-region beg end
)
6556 (let* ((buffer-undo-list t
)
6557 (inhibit-read-only t
) (inhibit-point-motion-hooks t
)
6558 (inhibit-modification-hooks t
)
6559 deactivate-mark buffer-file-name buffer-file-truename
)
6560 (org-decompose-region beg end
)
6561 (remove-text-properties beg end
6562 '(mouse-face t keymap t org-linked-text t
6563 invisible t intangible t
6565 (org-remove-font-lock-display-properties beg end
)))
6567 (defconst org-script-display
'(((raise -
0.3) (height 0.7))
6568 ((raise 0.3) (height 0.7))
6571 "Display properties for showing superscripts and subscripts.")
6573 (defun org-remove-font-lock-display-properties (beg end
)
6574 "Remove specific display properties that have been added by font lock.
6575 The will remove the raise properties that are used to show superscripts
6579 (setq next
(next-single-property-change beg
'display nil end
)
6580 prop
(get-text-property beg
'display
))
6581 (if (member prop org-script-display
)
6582 (put-text-property beg next
'display nil
))
6585 (defun org-raise-scripts (limit)
6586 "Add raise properties to sub/superscripts."
6587 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
)
6588 (if (re-search-forward
6589 (if (eq org-use-sub-superscripts t
)
6590 org-match-substring-regexp
6591 org-match-substring-with-braces-regexp
)
6593 (let* ((pos (point)) table-p comment-p
6594 (mpos (match-beginning 3))
6595 (emph-p (get-text-property mpos
'org-emphasis
))
6596 (link-p (get-text-property mpos
'mouse-face
))
6597 (keyw-p (eq 'org-special-keyword
(get-text-property mpos
'face
))))
6598 (goto-char (point-at-bol))
6599 (setq table-p
(org-looking-at-p org-table-dataline-regexp
)
6600 comment-p
(org-looking-at-p "^[ \t]*#[ +]"))
6603 (if (member (char-after) '(?_ ?^
)) (goto-char (1- pos
)))
6604 (if (or comment-p emph-p link-p keyw-p
)
6606 (put-text-property (match-beginning 3) (match-end 0)
6608 (if (equal (char-after (match-beginning 2)) ?^
)
6609 (nth (if table-p
3 1) org-script-display
)
6610 (nth (if table-p
2 0) org-script-display
)))
6611 (add-text-properties (match-beginning 2) (match-end 2)
6613 'org-dwidth t
'org-dwidth-n
1))
6614 (if (and (eq (char-after (match-beginning 3)) ?
{)
6615 (eq (char-before (match-end 3)) ?
}))
6617 (add-text-properties
6618 (match-beginning 3) (1+ (match-beginning 3))
6619 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))
6620 (add-text-properties
6621 (1- (match-end 3)) (match-end 3)
6622 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))))
6625 ;;;; Visibility cycling, including org-goto and indirect buffer
6629 (defvar org-cycle-global-status nil
)
6630 (make-variable-buffer-local 'org-cycle-global-status
)
6631 (put 'org-cycle-global-status
'org-state t
)
6632 (defvar org-cycle-subtree-status nil
)
6633 (make-variable-buffer-local 'org-cycle-subtree-status
)
6634 (put 'org-cycle-subtree-status
'org-state t
)
6636 (defvar org-inlinetask-min-level
)
6638 (defun org-unlogged-message (&rest args
)
6639 "Display a message, but avoid logging it in the *Messages* buffer."
6640 (let ((message-log-max nil
))
6641 (apply 'message args
)))
6644 (defun org-cycle (&optional arg
)
6645 "TAB-action and visibility cycling for Org-mode.
6647 This is the command invoked in Org-mode by the TAB key. Its main purpose
6648 is outline visibility cycling, but it also invokes other actions
6649 in special contexts.
6651 - When this function is called with a prefix argument, rotate the entire
6652 buffer through 3 states (global cycling)
6653 1. OVERVIEW: Show only top-level headlines.
6654 2. CONTENTS: Show all headlines of all levels, but no body text.
6655 3. SHOW ALL: Show everything.
6656 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6657 determined by the variable `org-startup-folded', and by any VISIBILITY
6658 properties in the buffer.
6659 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6660 including any drawers.
6662 - When inside a table, re-align the table and move to the next field.
6664 - When point is at the beginning of a headline, rotate the subtree started
6665 by this line through 3 different states (local cycling)
6666 1. FOLDED: Only the main headline is shown.
6667 2. CHILDREN: The main headline and the direct children are shown.
6668 From this state, you can move to one of the children
6669 and zoom in further.
6670 3. SUBTREE: Show the entire subtree, including body text.
6671 If there is no subtree, switch directly from CHILDREN to FOLDED.
6673 - When point is at the beginning of an empty headline and the variable
6674 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6675 of the headline by demoting and promoting it to likely levels. This
6676 speeds up creation document structure by pressing TAB once or several
6677 times right after creating a new headline.
6679 - When there is a numeric prefix, go up to a heading with level ARG, do
6680 a `show-subtree' and return to the previous cursor position. If ARG
6681 is negative, go up that many levels.
6683 - When point is not at the beginning of a headline, execute the global
6684 binding for TAB, which is re-indenting the line. See the option
6685 `org-cycle-emulate-tab' for details.
6687 - Special case: if point is at the beginning of the buffer and there is
6688 no headline in line 1, this function will act as if called with prefix arg
6689 (C-u TAB, same as S-TAB) also when called without prefix arg.
6690 But only if also the variable `org-cycle-global-at-bob' is t."
6692 (org-load-modules-maybe)
6693 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook
)
6694 (and org-cycle-level-after-item
/entry-creation
6695 (or (org-cycle-level)
6696 (org-cycle-item-indentation))))
6698 (or org-cycle-max-level
6699 (and (boundp 'org-inlinetask-min-level
)
6700 org-inlinetask-min-level
6701 (1- org-inlinetask-min-level
))))
6702 (nstars (and limit-level
6703 (if org-odd-levels-only
6704 (and limit-level
(1- (* limit-level
2)))
6707 (if (not (derived-mode-p 'org-mode
))
6709 (concat "\\*" (if nstars
(format "\\{1,%d\\} " nstars
) "+ "))))
6710 (bob-special (and org-cycle-global-at-bob
(not arg
) (bobp)
6711 (not (looking-at org-outline-regexp
))))
6714 (delq 'org-optimize-window-after-visibility-change
6715 (copy-sequence org-cycle-hook
))
6719 (if (or bob-special
(equal arg
'(4)))
6720 ;; special case: use global cycling
6726 (setq last-command
'dummy
)
6727 (org-set-startup-visibility)
6728 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6732 (org-unlogged-message "Entire buffer visible, including drawers"))
6734 ;; Try cdlatex TAB completion
6735 ((org-try-cdlatex-tab))
6737 ;; Table: enter it or move to the next field.
6738 ((org-at-table-p 'any
)
6739 (if (org-at-table.el-p
)
6740 (message "Use C-c ' to edit table.el tables")
6741 (if arg
(org-table-edit-field t
)
6742 (org-table-justify-field-maybe)
6743 (call-interactively 'org-table-next-field
))))
6745 ((run-hook-with-args-until-success
6746 'org-tab-after-check-for-table-hook
))
6748 ;; Global cycling: delegate to `org-cycle-internal-global'.
6749 ((eq arg t
) (org-cycle-internal-global))
6751 ;; Drawers: delegate to `org-flag-drawer'.
6753 (beginning-of-line 1)
6754 (looking-at org-drawer-regexp
))
6755 (org-flag-drawer ; toggle block visibility
6756 (not (get-char-property (match-end 0) 'invisible
))))
6758 ;; Show-subtree, ARG levels up from here.
6761 (org-back-to-heading)
6762 (outline-up-heading (if (< arg
0) (- arg
)
6763 (- (funcall outline-level
) arg
)))
6764 (org-show-subtree)))
6766 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6767 ((and (featurep 'org-inlinetask
)
6768 (org-inlinetask-at-task-p)
6769 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6770 (org-inlinetask-toggle-visibility))
6772 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6773 ((and (or (and org-cycle-include-plain-lists
(org-at-item-p))
6774 (save-excursion (move-beginning-of-line 1)
6775 (looking-at org-outline-regexp
)))
6776 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6777 (org-cycle-internal-local))
6779 ;; From there: TAB emulation and template completion.
6780 (buffer-read-only (org-back-to-heading))
6782 ((run-hook-with-args-until-success
6783 'org-tab-after-check-for-cycling-hook
))
6785 ((org-try-structure-completion))
6787 ((run-hook-with-args-until-success
6788 'org-tab-before-tab-emulation-hook
))
6790 ((and (eq org-cycle-emulate-tab
'exc-hl-bol
)
6792 (not (looking-at org-outline-regexp
))))
6793 (call-interactively (global-key-binding "\t")))
6795 ((if (and (memq org-cycle-emulate-tab
'(white whitestart
))
6796 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6797 (or (and (eq org-cycle-emulate-tab
'white
)
6798 (= (match-end 0) (point-at-eol)))
6799 (and (eq org-cycle-emulate-tab
'whitestart
)
6800 (>= (match-end 0) pos
))))
6802 (eq org-cycle-emulate-tab t
))
6803 (call-interactively (global-key-binding "\t")))
6806 (org-back-to-heading)
6809 (defun org-cycle-internal-global ()
6810 "Do the global cycling action."
6811 ;; Hack to avoid display of messages for .org attachments in Gnus
6812 (let ((ga (string-match "\\*fontification" (buffer-name))))
6814 ((and (eq last-command this-command
)
6815 (eq org-cycle-global-status
'overview
))
6816 ;; We just created the overview - now do table of contents
6817 ;; This can be slow in very large buffers, so indicate action
6818 (run-hook-with-args 'org-pre-cycle-hook
'contents
)
6819 (unless ga
(org-unlogged-message "CONTENTS..."))
6821 (unless ga
(org-unlogged-message "CONTENTS...done"))
6822 (setq org-cycle-global-status
'contents
)
6823 (run-hook-with-args 'org-cycle-hook
'contents
))
6825 ((and (eq last-command this-command
)
6826 (eq org-cycle-global-status
'contents
))
6827 ;; We just showed the table of contents - now show everything
6828 (run-hook-with-args 'org-pre-cycle-hook
'all
)
6830 (unless ga
(org-unlogged-message "SHOW ALL"))
6831 (setq org-cycle-global-status
'all
)
6832 (run-hook-with-args 'org-cycle-hook
'all
))
6835 ;; Default action: go to overview
6836 (run-hook-with-args 'org-pre-cycle-hook
'overview
)
6838 (unless ga
(org-unlogged-message "OVERVIEW"))
6839 (setq org-cycle-global-status
'overview
)
6840 (run-hook-with-args 'org-cycle-hook
'overview
)))))
6842 (defvar org-called-with-limited-levels nil
6843 "Non-nil when `org-with-limited-levels' is currently active.")
6845 (defun org-cycle-internal-local ()
6846 "Do the local cycling action."
6847 (let ((goal-column 0) eoh eol eos has-children children-skipped struct
)
6848 ;; First, determine end of headline (EOH), end of subtree or item
6849 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6854 (setq struct
(org-list-struct))
6855 (setq eoh
(point-at-eol))
6856 (setq eos
(org-list-get-item-end-before-blank (point) struct
))
6857 (setq has-children
(org-list-has-child-p (point) struct
)))
6858 (org-back-to-heading)
6859 (setq eoh
(save-excursion (outline-end-of-heading) (point)))
6860 (setq eos
(save-excursion (org-end-of-subtree t t
)
6861 (when (bolp) (backward-char)) (point)))
6864 (let ((level (funcall outline-level
)))
6865 (outline-next-heading)
6866 (and (org-at-heading-p t
)
6867 (> (funcall outline-level
) level
))))
6869 (org-list-search-forward (org-item-beginning-re) eos t
)))))
6870 ;; Determine end invisible part of buffer (EOL)
6871 (beginning-of-line 2)
6872 ;; XEmacs doesn't have `next-single-char-property-change'
6873 (if (featurep 'xemacs
)
6874 (while (and (not (eobp)) ;; this is like `next-line'
6875 (get-char-property (1- (point)) 'invisible
))
6876 (beginning-of-line 2))
6877 (while (and (not (eobp)) ;; this is like `next-line'
6878 (get-char-property (1- (point)) 'invisible
))
6879 (goto-char (next-single-char-property-change (point) 'invisible
))
6880 (and (eolp) (beginning-of-line 2))))
6882 ;; Find out what to do next and set `this-command'
6885 ;; Nothing is hidden behind this heading
6886 (unless (org-before-first-heading-p)
6887 (run-hook-with-args 'org-pre-cycle-hook
'empty
))
6888 (org-unlogged-message "EMPTY ENTRY")
6889 (setq org-cycle-subtree-status nil
)
6892 (outline-next-heading)
6893 (if (outline-invisible-p) (org-flag-heading nil
))))
6894 ((and (or (>= eol eos
)
6895 (not (string-match "\\S-" (buffer-substring eol eos
))))
6897 (not (setq children-skipped
6898 org-cycle-skip-children-state-if-no-children
))))
6899 ;; Entire subtree is hidden in one line: children view
6900 (unless (org-before-first-heading-p)
6901 (run-hook-with-args 'org-pre-cycle-hook
'children
))
6903 (org-list-set-item-visibility (point-at-bol) struct
'children
)
6905 (org-with-limited-levels (show-children))
6906 ;; FIXME: This slows down the func way too much.
6907 ;; How keep drawers hidden in subtree anyway?
6908 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6909 ;; (org-cycle-hide-drawers 'subtree))
6911 ;; Fold every list in subtree to top-level items.
6912 (when (eq org-cycle-include-plain-lists
'integrate
)
6914 (org-back-to-heading)
6915 (while (org-list-search-forward (org-item-beginning-re) eos t
)
6916 (beginning-of-line 1)
6917 (let* ((struct (org-list-struct))
6918 (prevs (org-list-prevs-alist struct
))
6919 (end (org-list-get-bottom-point struct
)))
6920 (mapc (lambda (e) (org-list-set-item-visibility e struct
'folded
))
6921 (org-list-get-all-items (point) struct prevs
))
6922 (goto-char (if (< end eos
) end eos
)))))))
6923 (org-unlogged-message "CHILDREN")
6926 (outline-next-heading)
6927 (if (outline-invisible-p) (org-flag-heading nil
)))
6928 (setq org-cycle-subtree-status
'children
)
6929 (unless (org-before-first-heading-p)
6930 (run-hook-with-args 'org-cycle-hook
'children
)))
6931 ((or children-skipped
6932 (and (eq last-command this-command
)
6933 (eq org-cycle-subtree-status
'children
)))
6934 ;; We just showed the children, or no children are there,
6935 ;; now show everything.
6936 (unless (org-before-first-heading-p)
6937 (run-hook-with-args 'org-pre-cycle-hook
'subtree
))
6938 (outline-flag-region eoh eos nil
)
6939 (org-unlogged-message
6940 (if children-skipped
"SUBTREE (NO CHILDREN)" "SUBTREE"))
6941 (setq org-cycle-subtree-status
'subtree
)
6942 (unless (org-before-first-heading-p)
6943 (run-hook-with-args 'org-cycle-hook
'subtree
)))
6945 ;; Default action: hide the subtree.
6946 (run-hook-with-args 'org-pre-cycle-hook
'folded
)
6947 (outline-flag-region eoh eos t
)
6948 (org-unlogged-message "FOLDED")
6949 (setq org-cycle-subtree-status
'folded
)
6950 (unless (org-before-first-heading-p)
6951 (run-hook-with-args 'org-cycle-hook
'folded
))))))
6954 (defun org-global-cycle (&optional arg
)
6955 "Cycle the global visibility. For details see `org-cycle'.
6956 With \\[universal-argument] prefix arg, switch to startup visibility.
6957 With a numeric prefix, show all headlines up to that level."
6959 (let ((org-cycle-include-plain-lists
6960 (if (derived-mode-p 'org-mode
) org-cycle-include-plain-lists nil
)))
6964 (hide-sublevels arg
)
6965 (setq org-cycle-global-status
'contents
))
6967 (org-set-startup-visibility)
6968 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6970 (org-cycle '(4))))))
6972 (defun org-set-startup-visibility ()
6973 "Set the visibility required by startup options and properties."
6975 ((eq org-startup-folded t
)
6977 ((eq org-startup-folded
'content
)
6979 ((or (eq org-startup-folded
'showeverything
)
6980 (eq org-startup-folded nil
))
6982 (unless (eq org-startup-folded
'showeverything
)
6983 (if org-hide-block-startup
(org-hide-block-all))
6984 (org-set-visibility-according-to-property 'no-cleanup
)
6985 (org-cycle-hide-archived-subtrees 'all
)
6986 (org-cycle-hide-drawers 'all
)
6987 (org-cycle-show-empty-lines t
)))
6989 (defun org-set-visibility-according-to-property (&optional no-cleanup
)
6990 "Switch subtree visibilities according to :VISIBILITY: property."
6992 (let (org-show-entry-below)
6993 (org-with-wide-buffer
6994 (goto-char (point-min))
6995 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t
)
6996 (if (not (org-at-property-p)) (outline-next-heading)
6997 (let ((state (match-string 3)))
6999 (org-back-to-heading t
)
7003 ((equal state
"folded")
7005 ((equal state
"children")
7006 (org-show-hidden-entry)
7008 ((equal state
"content")
7011 (org-narrow-to-subtree)
7013 ((member state
'("all" "showall"))
7014 (show-subtree)))))))
7016 (org-cycle-hide-archived-subtrees 'all
)
7017 (org-cycle-hide-drawers 'all
)
7018 (org-cycle-show-empty-lines 'all
)))))
7020 ;; This function uses outline-regexp instead of the more fundamental
7021 ;; org-outline-regexp so that org-cycle-global works outside of Org
7022 ;; buffers, where outline-regexp is needed.
7023 (defun org-overview ()
7024 "Switch to overview mode, showing only top-level headlines.
7025 This shows all headlines with a level equal or greater than the level
7026 of the first headline in the buffer. This is important, because if the
7027 first headline is not level one, then (hide-sublevels 1) gives confusing
7033 (goto-char (point-min))
7034 (if (re-search-forward (concat "^" outline-regexp
) nil t
)
7036 (goto-char (match-beginning 0))
7037 (funcall outline-level
))))))
7038 (and level
(hide-sublevels level
)))))
7040 (defun org-content (&optional arg
)
7041 "Show all headlines in the buffer, like a table of contents.
7042 With numerical argument N, show content up to level N."
7046 ;; Visit all headings and show their offspring
7047 (and (integerp arg
) (org-overview))
7048 (goto-char (point-max))
7050 (while (and (progn (condition-case nil
7051 (outline-previous-visible-heading 1)
7052 (error (goto-char (point-min))))
7054 (looking-at org-outline-regexp
))
7056 (show-children (1- arg
))
7058 (if (bobp) (throw 'exit nil
))))))
7060 (defun org-optimize-window-after-visibility-change (state)
7061 "Adjust the window after a change in outline visibility.
7062 This function is the default value of the hook `org-cycle-hook'."
7063 (when (get-buffer-window (current-buffer))
7065 ((eq state
'content
) nil
)
7066 ((eq state
'all
) nil
)
7067 ((eq state
'folded
) nil
)
7068 ((eq state
'children
) (or (org-subtree-end-visible-p) (recenter 1)))
7069 ((eq state
'subtree
) (or (org-subtree-end-visible-p) (recenter 1))))))
7071 (defun org-remove-empty-overlays-at (pos)
7072 "Remove outline overlays that do not contain non-white stuff."
7075 (and (eq 'outline
(overlay-get o
'invisible
))
7076 (not (string-match "\\S-" (buffer-substring (overlay-start o
)
7078 (delete-overlay o
)))
7081 (defun org-clean-visibility-after-subtree-move ()
7082 "Fix visibility issues after moving a subtree."
7083 ;; First, find a reasonable region to look at:
7084 ;; Start two siblings above, end three below
7085 (let* ((beg (save-excursion
7086 (and (org-get-last-sibling)
7087 (org-get-last-sibling))
7089 (end (save-excursion
7090 (and (org-get-next-sibling)
7091 (org-get-next-sibling)
7092 (org-get-next-sibling))
7093 (if (org-at-heading-p)
7096 (level (looking-at "\\*+"))
7097 (re (if level
(concat "^" (regexp-quote (match-string 0)) " "))))
7100 (narrow-to-region beg end
)
7102 ;; Properly fold already folded siblings
7103 (goto-char (point-min))
7104 (while (re-search-forward re nil t
)
7105 (if (and (not (outline-invisible-p))
7107 (goto-char (point-at-eol)) (outline-invisible-p)))
7109 (org-cycle-show-empty-lines 'overview
)
7110 (org-cycle-hide-drawers 'overview
)))))
7112 (defun org-cycle-show-empty-lines (state)
7113 "Show empty lines above all visible headlines.
7114 The region to be covered depends on STATE when called through
7115 `org-cycle-hook'. Lisp program can use t for STATE to get the
7116 entire buffer covered. Note that an empty line is only shown if there
7117 are at least `org-cycle-separator-lines' empty lines before the headline."
7118 (when (/= org-cycle-separator-lines
0)
7120 (let* ((n (abs org-cycle-separator-lines
))
7122 ((= n
1) "\\(\n[ \t]*\n\\*+\\) ")
7123 ((= n
2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7124 (t (let ((ns (number-to-string (- n
2))))
7125 (concat "^\\(?:[ \t]*\n\\)\\{" ns
"," ns
"\\}"
7126 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7129 ((memq state
'(overview contents t
))
7130 (setq beg
(point-min) end
(point-max)))
7131 ((memq state
'(children folded
))
7133 end
(progn (org-end-of-subtree t t
)
7134 (line-beginning-position 2)))))
7137 (while (re-search-forward re end t
)
7138 (unless (get-char-property (match-end 1) 'invisible
)
7139 (let ((e (match-end 1))
7140 (b (if (>= org-cycle-separator-lines
0)
7143 (goto-char (match-beginning 0))
7144 (skip-chars-backward " \t\n")
7145 (line-end-position)))))
7146 (outline-flag-region b e nil
))))))))
7147 ;; Never hide empty lines at the end of the file.
7149 (goto-char (point-max))
7150 (outline-previous-heading)
7151 (outline-end-of-heading)
7152 (if (and (looking-at "[ \t\n]+")
7153 (= (match-end 0) (point-max)))
7154 (outline-flag-region (point) (match-end 0) nil
))))
7156 (defun org-show-empty-lines-in-parent ()
7157 "Move to the parent and re-show empty lines before visible headlines."
7159 (let ((context (if (org-up-heading-safe) 'children
'overview
)))
7160 (org-cycle-show-empty-lines context
))))
7162 (defun org-files-list ()
7163 "Return `org-agenda-files' list, plus all open org-mode files.
7164 This is useful for operations that need to scan all of a user's
7165 open and agenda-wise Org files."
7166 (let ((files (mapcar 'expand-file-name
(org-agenda-files))))
7167 (dolist (buf (buffer-list))
7168 (with-current-buffer buf
7169 (if (and (derived-mode-p 'org-mode
) (buffer-file-name))
7170 (let ((file (expand-file-name (buffer-file-name))))
7171 (unless (member file files
)
7172 (push file files
))))))
7175 (defsubst org-entry-beginning-position
()
7176 "Return the beginning position of the current entry."
7177 (save-excursion (outline-back-to-heading t
) (point)))
7179 (defsubst org-entry-end-position
()
7180 "Return the end position of the current entry."
7181 (save-excursion (outline-next-heading) (point)))
7183 (defun org-cycle-hide-drawers (state &optional exceptions
)
7184 "Re-hide all drawers after a visibility state change.
7185 When non-nil, optional argument EXCEPTIONS is a list of strings
7186 specifying which drawers should not be hidden."
7187 (when (and (derived-mode-p 'org-mode
)
7188 (not (memq state
'(overview folded contents
))))
7190 (let* ((globalp (memq state
'(contents all
)))
7191 (beg (if globalp
(point-min) (point)))
7192 (end (if globalp
(point-max)
7193 (if (eq state
'children
)
7194 (save-excursion (outline-next-heading) (point))
7195 (org-end-of-subtree t
)))))
7197 (while (re-search-forward org-drawer-regexp
(max end
(point)) t
)
7198 (unless (member-ignore-case (match-string 1) exceptions
)
7199 (let ((drawer (org-element-at-point)))
7200 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7201 (org-flag-drawer t drawer
)
7202 ;; Make sure to skip drawer entirely or we might flag
7203 ;; it another time when matching its ending line with
7204 ;; `org-drawer-regexp'.
7205 (goto-char (org-element-property :end drawer
))))))))))
7207 (defun org-flag-drawer (flag &optional element
)
7208 "When FLAG is non-nil, hide the drawer we are at.
7209 Otherwise make it visible. When optional argument ELEMENT is
7210 a parsed drawer, as returned by `org-element-at-point', hide or
7211 show that drawer instead."
7212 (when (save-excursion
7214 (org-looking-at-p org-drawer-regexp
))
7215 (let ((drawer (or element
(org-element-at-point))))
7216 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7217 (let ((post (org-element-property :post-affiliated drawer
)))
7219 (outline-flag-region
7220 (progn (goto-char post
) (line-end-position))
7221 (progn (goto-char (org-element-property :end drawer
))
7222 (skip-chars-backward " \r\t\n")
7223 (line-end-position))
7225 ;; When the drawer is hidden away, make sure point lies in
7226 ;; a visible part of the buffer.
7227 (when (and flag
(> (line-beginning-position) post
))
7228 (goto-char post
)))))))
7230 (defun org-subtree-end-visible-p ()
7231 "Is the end of the current subtree visible?"
7232 (pos-visible-in-window-p
7233 (save-excursion (org-end-of-subtree t
) (point))))
7235 (defun org-first-headline-recenter ()
7236 "Move cursor to the first headline and recenter the headline."
7237 (goto-char (point-min))
7238 (when (re-search-forward (concat "^\\(" org-outline-regexp
"\\)") nil t
)
7239 (set-window-start (selected-window) (point-at-bol))))
7241 ;;; Saving and restoring visibility
7243 (defun org-outline-overlay-data (&optional use-markers
)
7244 "Return a list of the locations of all outline overlays.
7245 These are overlays with the `invisible' property value `outline'.
7246 The return value is a list of cons cells, with start and stop
7247 positions for each overlay.
7248 If USE-MARKERS is set, return the positions as markers."
7255 (when (eq (overlay-get o
'invisible
) 'outline
)
7256 (setq beg
(overlay-start o
)
7257 end
(overlay-end o
))
7258 (and beg end
(> end beg
)
7260 (cons (copy-marker beg
)
7261 (copy-marker end t
))
7263 (overlays-in (point-min) (point-max))))))))
7265 (defun org-set-outline-overlay-data (data)
7266 "Create visibility overlays for all positions in DATA.
7267 DATA should have been made by `org-outline-overlay-data'."
7274 (outline-flag-region (car c
) (cdr c
) t
))
7277 ;;; Folding of blocks
7279 (defvar org-hide-block-overlays nil
7280 "Overlays hiding blocks.")
7281 (make-variable-buffer-local 'org-hide-block-overlays
)
7283 (defun org-block-map (function &optional start end
)
7284 "Call FUNCTION at the head of all source blocks in the current buffer.
7285 Optional arguments START and END can be used to limit the range."
7286 (let ((start (or start
(point-min)))
7287 (end (or end
(point-max))))
7290 (while (and (< (point) end
) (re-search-forward org-block-regexp end t
))
7293 (goto-char (match-beginning 0))
7294 (funcall function
)))))))
7296 (defun org-hide-block-toggle-all ()
7297 "Toggle the visibility of all blocks in the current buffer."
7298 (org-block-map 'org-hide-block-toggle
))
7300 (defun org-hide-block-all ()
7301 "Fold all blocks in the current buffer."
7303 (org-show-block-all)
7304 (org-block-map 'org-hide-block-toggle-maybe
))
7306 (defun org-show-block-all ()
7307 "Unfold all blocks in the current buffer."
7309 (mapc 'delete-overlay org-hide-block-overlays
)
7310 (setq org-hide-block-overlays nil
))
7312 (defun org-hide-block-toggle-maybe ()
7313 "Toggle visibility of block at point.
7314 Unlike to `org-hide-block-toggle', this function does not throw
7315 an error. Return a non-nil value when toggling is successful."
7317 (ignore-errors (org-hide-block-toggle)))
7319 (defun org-hide-block-toggle (&optional force
)
7320 "Toggle the visibility of the current block.
7321 When optional argument FORCE is `off', make block visible. If it
7322 is non-nil, hide it unconditionally. Throw an error when not at
7323 a block. Return a non-nil value when toggling is successful."
7325 (let ((element (org-element-at-point)))
7326 (unless (memq (org-element-type element
)
7327 '(center-block comment-block dynamic-block example-block
7328 export-block quote-block special-block
7329 src-block verse-block
))
7330 (user-error "Not at a block"))
7331 (let* ((start (save-excursion
7332 (goto-char (org-element-property :post-affiliated element
))
7333 (line-end-position)))
7334 (end (save-excursion
7335 (goto-char (org-element-property :end element
))
7336 (skip-chars-backward " \r\t\n")
7337 (line-end-position)))
7338 (overlays (overlays-at start
)))
7340 ;; Do nothing when not before or at the block opening line or
7341 ;; at the block closing line.
7342 ((let ((eol (line-end-position))) (and (> eol start
) (/= eol end
))) nil
)
7343 ((and (not (eq force
'off
))
7344 (not (memq t
(mapcar
7346 (eq (overlay-get o
'invisible
) 'org-hide-block
))
7348 (let ((ov (make-overlay start end
)))
7349 (overlay-put ov
'invisible
'org-hide-block
)
7350 ;; Make the block accessible to `isearch'.
7352 ov
'isearch-open-invisible
7354 (when (memq ov org-hide-block-overlays
)
7355 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7356 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7357 (delete-overlay ov
))))
7358 (push ov org-hide-block-overlays
)
7359 ;; When the block is hidden away, make sure point is left in
7360 ;; a visible part of the buffer.
7361 (when (> (line-beginning-position) start
)
7363 (beginning-of-line))
7364 ;; Signal successful toggling.
7366 ((or (not force
) (eq force
'off
))
7367 (dolist (ov overlays t
)
7368 (when (memq ov org-hide-block-overlays
)
7369 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7370 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7371 (delete-overlay ov
))))))))
7373 ;; org-tab-after-check-for-cycling-hook
7374 (add-hook 'org-tab-first-hook
'org-hide-block-toggle-maybe
)
7375 ;; Remove overlays when changing major mode
7376 (add-hook 'org-mode-hook
7377 (lambda () (org-add-hook 'change-major-mode-hook
7378 'org-show-block-all
'append
'local
)))
7382 (defvar org-goto-window-configuration nil
)
7383 (defvar org-goto-marker nil
)
7384 (defvar org-goto-map
)
7385 (defun org-goto-map ()
7386 "Set the keymap `org-goto'."
7388 (let ((map (make-sparse-keymap)))
7389 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7390 mouse-drag-region universal-argument org-occur
))
7392 (while (setq cmd
(pop cmds
))
7393 (substitute-key-definition cmd cmd map global-map
)))
7394 (suppress-keymap map
)
7395 (org-defkey map
"\C-m" 'org-goto-ret
)
7396 (org-defkey map
[(return)] 'org-goto-ret
)
7397 (org-defkey map
[(left)] 'org-goto-left
)
7398 (org-defkey map
[(right)] 'org-goto-right
)
7399 (org-defkey map
[(control ?g
)] 'org-goto-quit
)
7400 (org-defkey map
"\C-i" 'org-cycle
)
7401 (org-defkey map
[(tab)] 'org-cycle
)
7402 (org-defkey map
[(down)] 'outline-next-visible-heading
)
7403 (org-defkey map
[(up)] 'outline-previous-visible-heading
)
7404 (if org-goto-auto-isearch
7405 (if (fboundp 'define-key-after
)
7406 (define-key-after map
[t] 'org-goto-local-auto-isearch)
7408 (org-defkey map "q" 'org-goto-quit)
7409 (org-defkey map "n" 'outline-next-visible-heading)
7410 (org-defkey map "p" 'outline-previous-visible-heading)
7411 (org-defkey map "f" 'outline-forward-same-level)
7412 (org-defkey map "b" 'outline-backward-same-level)
7413 (org-defkey map "u" 'outline-up-heading))
7414 (org-defkey map "/" 'org-occur)
7415 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7416 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7417 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7418 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7419 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7422 (defconst org-goto-help
7423 "Browse buffer copy, to find location or copy text.%s
7424 RET=jump to location C-g=quit and return to previous location
7425 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7427 (defvar org-goto-start-pos) ; dynamically scoped parameter
7429 (defun org-goto (&optional alternative-interface)
7430 "Look up a different location in the current file, keeping current visibility.
7432 When you want look-up or go to a different location in a
7433 document, the fastest way is often to fold the entire buffer and
7434 then dive into the tree. This method has the disadvantage, that
7435 the previous location will be folded, which may not be what you
7438 This command works around this by showing a copy of the current
7439 buffer in an indirect buffer, in overview mode. You can dive
7440 into the tree in that copy, use org-occur and incremental search
7441 to find a location. When pressing RET or `Q', the command
7442 returns to the original buffer in which the visibility is still
7443 unchanged. After RET it will also jump to the location selected
7444 in the indirect buffer and expose the headline hierarchy above.
7446 With a prefix argument, use the alternative interface: e.g. if
7447 `org-goto-interface' is 'outline use 'outline-path-completion."
7450 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7451 (org-refile-use-outline-path t)
7452 (org-refile-target-verify-function nil)
7454 (if (not alternative-interface)
7456 (if (eq org-goto-interface 'outline)
7457 'outline-path-completion
7459 (org-goto-start-pos (point))
7461 (if (eq interface 'outline)
7462 (car (org-get-location (current-buffer) org-goto-help))
7463 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7464 (org-refile-check-position pa)
7468 (org-mark-ring-push org-goto-start-pos)
7469 (goto-char selected-point)
7470 (if (or (outline-invisible-p) (org-invisible-p2))
7471 (org-show-context 'org-goto)))
7474 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7475 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7476 (defvar org-goto-local-auto-isearch-map) ; defined below
7478 (defun org-get-location (buf help)
7479 "Let the user select a location in the Org-mode buffer BUF.
7480 This function uses a recursive edit. It returns the selected position
7483 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7484 (isearch-hide-immediately nil)
7485 (isearch-search-fun-function
7486 (lambda () 'org-goto-local-search-headings))
7487 (org-goto-selected-point org-goto-exit-command))
7489 (save-window-excursion
7490 (delete-other-windows)
7491 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7492 (org-pop-to-buffer-same-window
7494 (make-indirect-buffer (current-buffer) "*org-goto*")
7495 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7496 (with-output-to-temp-buffer "*Org Help*"
7497 (princ (format help (if org-goto-auto-isearch
7498 " Just type for auto-isearch."
7499 " n/p/f/b/u to navigate, q to quit."))))
7500 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7501 (setq buffer-read-only nil)
7502 (let ((org-startup-truncated t)
7503 (org-startup-folded nil)
7504 (org-startup-align-all-tables nil))
7507 (setq buffer-read-only t)
7508 (if (and (boundp 'org-goto-start-pos)
7509 (integer-or-marker-p org-goto-start-pos))
7510 (progn (goto-char org-goto-start-pos)
7511 (when (outline-invisible-p)
7512 (org-show-set-visibility 'lineage)))
7513 (goto-char (point-min)))
7514 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7515 (message "Select location and press RET")
7516 (use-local-map org-goto-map)
7518 (kill-buffer "*org-goto*")
7519 (cons org-goto-selected-point org-goto-exit-command))))
7521 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7522 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7523 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7524 (if (fboundp 'isearch-other-control-char)
7526 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7527 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7528 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7529 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7530 (define-key org-goto-local-auto-isearch-map [return] nil))
7532 (defun org-goto-local-search-headings (string bound noerror)
7533 "Search and make sure that any matches are in headlines."
7535 (while (if isearch-forward
7536 (search-forward string bound noerror)
7537 (search-backward string bound noerror))
7538 (when (save-match-data
7539 (and (save-excursion
7541 (looking-at org-complex-heading-regexp))
7542 (or (not (match-beginning 5))
7543 (< (point) (match-beginning 5)))))
7544 (throw 'return (point))))))
7546 (defun org-goto-local-auto-isearch ()
7549 (goto-char (point-min))
7550 (let ((keys (this-command-keys)))
7551 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7553 (isearch-process-search-char (string-to-char keys)))))
7555 (defun org-goto-ret (&optional arg)
7556 "Finish `org-goto' by going to the new location."
7558 (setq org-goto-selected-point (point)
7559 org-goto-exit-command 'return)
7562 (defun org-goto-left ()
7563 "Finish `org-goto' by going to the new location."
7565 (if (org-at-heading-p)
7567 (beginning-of-line 1)
7568 (setq org-goto-selected-point (point)
7569 org-goto-exit-command 'left)
7571 (user-error "Not on a heading")))
7573 (defun org-goto-right ()
7574 "Finish `org-goto' by going to the new location."
7576 (if (org-at-heading-p)
7578 (setq org-goto-selected-point (point)
7579 org-goto-exit-command 'right)
7581 (user-error "Not on a heading")))
7583 (defun org-goto-quit ()
7584 "Finish `org-goto' without cursor motion."
7586 (setq org-goto-selected-point nil)
7587 (setq org-goto-exit-command 'quit)
7590 ;;; Indirect buffer display of subtrees
7592 (defvar org-indirect-dedicated-frame nil
7593 "This is the frame being used for indirect tree display.")
7594 (defvar org-last-indirect-buffer nil)
7596 (defun org-tree-to-indirect-buffer (&optional arg)
7597 "Create indirect buffer and narrow it to current subtree.
7598 With a numerical prefix ARG, go up to this level and then take that tree.
7599 If ARG is negative, go up that many levels.
7601 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7602 indirect buffer previously made with this command, to avoid proliferation of
7603 indirect buffers. However, when you call the command with a \
7604 \\[universal-argument] prefix, or
7605 when `org-indirect-buffer-display' is `new-frame', the last buffer
7606 is kept so that you can work with several indirect buffers at the same time.
7607 If `org-indirect-buffer-display' is `dedicated-frame', the \
7608 \\[universal-argument] prefix also
7609 requests that a new frame be made for the new buffer, so that the dedicated
7610 frame is not changed."
7612 (let ((cbuf (current-buffer))
7613 (cwin (selected-window))
7615 beg end level heading ibuf)
7617 (org-back-to-heading t)
7619 (setq level (org-outline-level))
7620 (if (< arg 0) (setq arg (+ level arg)))
7621 (while (> (setq level (org-outline-level)) arg)
7622 (org-up-heading-safe)))
7624 heading (org-get-heading))
7625 (org-end-of-subtree t t)
7626 (if (org-at-heading-p) (backward-char 1))
7628 (if (and (buffer-live-p org-last-indirect-buffer)
7629 (not (eq org-indirect-buffer-display 'new-frame))
7631 (kill-buffer org-last-indirect-buffer))
7632 (setq ibuf (org-get-indirect-buffer cbuf heading)
7633 org-last-indirect-buffer ibuf)
7635 ((or (eq org-indirect-buffer-display 'new-frame)
7636 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7637 (select-frame (make-frame))
7638 (delete-other-windows)
7639 (org-pop-to-buffer-same-window ibuf)
7640 (org-set-frame-title heading))
7641 ((eq org-indirect-buffer-display 'dedicated-frame)
7643 (select-frame (or (and org-indirect-dedicated-frame
7644 (frame-live-p org-indirect-dedicated-frame)
7645 org-indirect-dedicated-frame)
7646 (setq org-indirect-dedicated-frame (make-frame)))))
7647 (delete-other-windows)
7648 (org-pop-to-buffer-same-window ibuf)
7649 (org-set-frame-title (concat "Indirect: " heading)))
7650 ((eq org-indirect-buffer-display 'current-window)
7651 (org-pop-to-buffer-same-window ibuf))
7652 ((eq org-indirect-buffer-display 'other-window)
7653 (pop-to-buffer ibuf))
7654 (t (error "Invalid value")))
7655 (if (featurep 'xemacs)
7656 (save-excursion (org-mode) (turn-on-font-lock)))
7657 (narrow-to-region beg end)
7660 (run-hook-with-args 'org-cycle-hook 'all)
7661 (and (window-live-p cwin) (select-window cwin))))
7663 (defun org-get-indirect-buffer (&optional buffer heading)
7664 (setq buffer (or buffer (current-buffer)))
7665 (let ((n 1) (base (buffer-name buffer)) bname)
7666 (while (buffer-live-p
7670 (if heading (concat heading "-" (number-to-string n))
7671 (number-to-string n))))))
7674 (make-indirect-buffer buffer bname 'clone)
7675 (error (make-indirect-buffer buffer bname)))))
7677 (defun org-set-frame-title (title)
7678 "Set the title of the current frame to the string TITLE."
7679 ;; FIXME: how to name a single frame in XEmacs???
7680 (unless (featurep 'xemacs)
7681 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7683 ;;;; Structure editing
7685 ;;; Inserting headlines
7687 (defun org-previous-line-empty-p (&optional next)
7688 "Is the previous line a blank line?
7689 When NEXT is non-nil, check the next line instead."
7692 (or (beginning-of-line (if next 2 0)) t)
7694 (looking-at "[ \t]*$")))))
7696 (defun org-insert-heading (&optional arg invisible-ok top-level)
7697 "Insert a new heading or an item with the same depth at point.
7699 If point is at the beginning of a heading or a list item, insert
7700 a new heading or a new item above the current one. If point is
7701 at the beginning of a normal line, turn the line into a heading.
7703 If point is in the middle of a headline or a list item, split the
7704 headline or the item and create a new headline/item with the text
7705 in the current line after point \(see `org-M-RET-may-split-line'
7706 on how to modify this behavior).
7708 With one universal prefix argument, set the user option
7709 `org-insert-heading-respect-content' to t for the duration of
7710 the command. This modifies the behavior described above in this
7711 ways: on list items and at the beginning of normal lines, force
7712 the insertion of a heading after the current subtree.
7714 With two universal prefix arguments, insert the heading at the
7715 end of the grandparent subtree. For example, if point is within
7716 a 2nd-level heading, then it will insert a 2nd-level heading at
7717 the end of the 1st-level parent heading.
7719 If point is at the beginning of a headline, insert a sibling
7720 before the current headline. If point is not at the beginning,
7721 split the line and create a new headline with the text in the
7722 current line after point \(see `org-M-RET-may-split-line' on how
7723 to modify this behavior).
7725 If point is at the beginning of a normal line, turn this line
7728 When INVISIBLE-OK is set, stop at invisible headlines when going
7729 back. This is important for non-interactive uses of the
7732 When optional argument TOP-LEVEL is non-nil, insert a level 1
7733 heading, unconditionally."
7735 (if (org-called-interactively-p 'any) (org-reveal))
7736 (let ((itemp (and (not top-level) (org-in-item-p)))
7737 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7738 (respect-content (or org-insert-heading-respect-content
7740 (initial-content ""))
7744 ((or (= (buffer-size) 0)
7745 (and (not (save-excursion
7746 (and (ignore-errors (org-back-to-heading invisible-ok))
7747 (org-at-heading-p))))
7748 (or arg (not itemp))))
7749 ;; At beginning of buffer or so high up that only a heading
7751 (cond ((and (bolp) (not respect-content)) (insert "* "))
7752 ((not respect-content)
7753 (unless may-split (end-of-line))
7755 ((re-search-forward org-outline-regexp-bol nil t)
7759 (t (goto-char (point-max))
7761 (run-hooks 'org-insert-heading-hook))
7763 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7766 ;; Maybe move at the end of the subtree
7767 (when (equal arg '(16))
7768 (org-up-heading-safe)
7769 (org-end-of-subtree t))
7774 (on-heading (org-at-heading-p))
7775 (empty-line-p (if on-heading
7776 (org-previous-line-empty-p)
7777 ;; We will decide later
7779 ;; Get a level string to fall back on.
7781 (if (org-before-first-heading-p) "*"
7783 (org-back-to-heading t)
7784 (if (org-previous-line-empty-p) (setq empty-line-p t))
7785 (looking-at org-outline-regexp)
7786 (make-string (1- (length (match-string 0))) ?*))))
7791 (org-back-to-heading invisible-ok)
7792 (when (and (not on-heading)
7793 (featurep 'org-inlinetask)
7794 (integerp org-inlinetask-min-level)
7795 (>= (length (match-string 0))
7796 org-inlinetask-min-level))
7797 ;; Find a heading level before the inline
7799 (while (and (setq level (org-up-heading-safe))
7800 (>= level org-inlinetask-min-level)))
7801 (if (org-at-heading-p)
7802 (org-back-to-heading invisible-ok)
7803 (error "This should not happen")))
7804 (unless (and (save-excursion
7806 (org-backward-heading-same-level
7808 (= (point) (match-beginning 0)))
7809 (not (org-previous-line-empty-p t)))
7810 (setq empty-line-p (or empty-line-p
7811 (org-previous-line-empty-p))))
7813 (error (or fix-level "* ")))))
7814 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7815 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7816 pos hide-previous previous-pos)
7818 ;; If we insert after content, move there and clean up
7820 (when (and respect-content
7821 (not (org-looking-at-p org-outline-regexp-bol)))
7822 (if (not (org-before-first-heading-p))
7823 (org-end-of-subtree nil t)
7824 (re-search-forward org-outline-regexp-bol)
7825 (beginning-of-line 0))
7826 (skip-chars-backward " \r\t\n")
7827 (and (not (looking-back "^\\*+" (line-beginning-position)))
7828 (looking-at "[ \t]+") (replace-match ""))
7829 (unless (eobp) (forward-char 1))
7830 (when (looking-at "^\\*")
7831 (unless (bobp) (backward-char 1))
7834 ;; If we are splitting, grab the text that should be moved
7835 ;; to the new headline.
7837 (if (org-on-heading-p)
7838 ;; This is a heading: split intelligently (keeping
7840 (let ((pos (point)))
7842 (unless (looking-at org-complex-heading-regexp)
7843 (error "This should not happen"))
7844 (when (and (match-beginning 4)
7845 (> pos (match-beginning 4))
7846 (< pos (match-end 4)))
7847 (setq initial-content (buffer-substring pos (match-end 4)))
7849 (delete-region (point) (match-end 4))
7850 (if (looking-at "[ \t]*$")
7852 (insert (make-string (length initial-content) ?\s)))
7853 (setq initial-content (org-trim initial-content)))
7856 (setq initial-content
7858 (delete-and-extract-region (point) (line-end-position))))))
7860 ;; If we are at the beginning of the line, insert before it.
7861 ;; Otherwise, after it.
7863 ((and (bolp) (looking-at "[ \t]*$")))
7864 ((bolp) (save-excursion (insert "\n")))
7868 ;; Insert the new heading
7871 (insert initial-content)
7872 (unless (and blank (org-previous-line-empty-p))
7873 (org-N-empty-lines-before-current (if blank 1 0)))
7874 ;; Adjust visibility, which may be messed up if we removed
7875 ;; blank lines while previous entry was hidden.
7876 (let ((bol (line-beginning-position)))
7877 (dolist (o (overlays-at (1- bol)))
7878 (when (and (eq (overlay-get o 'invisible) 'outline)
7879 (eq (overlay-end o) bol))
7880 (move-overlay o (overlay-start o) (1- bol)))))
7881 (run-hooks 'org-insert-heading-hook)))))))
7883 (defun org-N-empty-lines-before-current (N)
7884 "Make the number of empty lines before current exactly N.
7885 So this will delete or add empty lines."
7889 (skip-chars-backward " \r\t\n")
7890 (unless (bolp) (forward-line))
7891 (delete-region (point) p))
7892 (when (> N 0) (insert (make-string N ?\n)))))
7894 (defun org-get-heading (&optional no-tags no-todo)
7895 "Return the heading of the current entry, without the stars.
7896 When NO-TAGS is non-nil, don't include tags.
7897 When NO-TODO is non-nil, don't include TODO keywords."
7899 (org-back-to-heading t)
7901 ((and no-tags no-todo)
7902 (looking-at org-complex-heading-regexp)
7905 (looking-at (concat org-outline-regexp
7907 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7910 (looking-at org-todo-line-regexp)
7912 (t (looking-at org-heading-regexp)
7913 (match-string 2)))))
7915 (defvar orgstruct-mode) ; defined below
7917 (defun org-heading-components ()
7918 "Return the components of the current heading.
7919 This is a list with the following elements:
7920 - the level as an integer
7921 - the reduced level, different if `org-odd-levels-only' is set.
7922 - the TODO keyword, or nil
7923 - the priority character, like ?A, or nil if no priority is given
7924 - the headline text itself, or the tags string if no headline text
7925 - the tags string, or nil."
7927 (org-back-to-heading t)
7928 (if (let (case-fold-search)
7932 org-complex-heading-regexp)))
7934 (list (length (match-string 1))
7935 (org-reduced-level (length (match-string 1)))
7940 (list (length (match-string 1))
7941 (org-reduced-level (length (match-string 1)))
7942 (org-match-string-no-properties 2)
7943 (and (match-end 3) (aref (match-string 3) 2))
7944 (org-match-string-no-properties 4)
7945 (org-match-string-no-properties 5))))))
7947 (defun org-get-entry ()
7948 "Get the entry text, after heading, entire subtree."
7950 (org-back-to-heading t)
7951 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7953 (defun org-insert-heading-after-current ()
7954 "Insert a new heading with same level as current, after current subtree."
7956 (org-back-to-heading)
7957 (org-insert-heading)
7958 (org-move-subtree-down)
7961 (defun org-insert-heading-respect-content (&optional invisible-ok)
7962 "Insert heading with `org-insert-heading-respect-content' set to t."
7964 (org-insert-heading '(4) invisible-ok))
7966 (defun org-insert-todo-heading-respect-content (&optional force-state)
7967 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7969 (org-insert-todo-heading force-state '(4)))
7971 (defun org-insert-todo-heading (arg &optional force-heading)
7972 "Insert a new heading with the same level and TODO state as current heading.
7973 If the heading has no TODO state, or if the state is DONE, use the first
7974 state (TODO by default). Also with one prefix arg, force first state. With
7975 two prefix args, force inserting at the end of the parent subtree."
7977 (when (or force-heading (not (org-insert-item 'checkbox)))
7978 (org-insert-heading (or (and (equal arg '(16)) '(16))
7981 (org-back-to-heading)
7982 (outline-previous-heading)
7983 (looking-at org-todo-line-regexp))
7986 (if (or (equal arg '(4))
7987 (not (match-beginning 2))
7988 (member (match-string 2) org-done-keywords))
7989 (car org-todo-keywords-1)
7993 (run-hook-with-args-until-success
7994 'org-todo-get-default-hook new-mark-x nil)
7996 (beginning-of-line 1)
7997 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7998 (if org-treat-insert-todo-heading-as-state-change
8000 (insert new-mark " "))))
8001 (when org-provide-todo-statistics
8002 (org-update-parent-todo-statistics))))
8004 (defun org-insert-subheading (arg)
8005 "Insert a new subheading and demote it.
8006 Works for outline headings and for plain lists alike."
8008 (org-insert-heading arg)
8010 ((org-at-heading-p) (org-do-demote))
8011 ((org-at-item-p) (org-indent-item))))
8013 (defun org-insert-todo-subheading (arg)
8014 "Insert a new subheading with TODO keyword or checkbox and demote it.
8015 Works for outline headings and for plain lists alike."
8017 (org-insert-todo-heading arg)
8019 ((org-at-heading-p) (org-do-demote))
8020 ((org-at-item-p) (org-indent-item))))
8022 ;;; Promotion and Demotion
8024 (defvar org-after-demote-entry-hook nil
8025 "Hook run after an entry has been demoted.
8026 The cursor will be at the beginning of the entry.
8027 When a subtree is being demoted, the hook will be called for each node.")
8029 (defvar org-after-promote-entry-hook nil
8030 "Hook run after an entry has been promoted.
8031 The cursor will be at the beginning of the entry.
8032 When a subtree is being promoted, the hook will be called for each node.")
8034 (defun org-promote-subtree ()
8035 "Promote the entire subtree.
8036 See also `org-promote'."
8039 (org-with-limited-levels (org-map-tree 'org-promote)))
8040 (org-fix-position-after-promote))
8042 (defun org-demote-subtree ()
8043 "Demote the entire subtree. See `org-demote'.
8044 See also `org-promote'."
8047 (org-with-limited-levels (org-map-tree 'org-demote)))
8048 (org-fix-position-after-promote))
8051 (defun org-do-promote ()
8052 "Promote the current heading higher up the tree.
8053 If the region is active in `transient-mark-mode', promote all headings
8057 (if (org-region-active-p)
8058 (org-map-region 'org-promote (region-beginning) (region-end))
8060 (org-fix-position-after-promote))
8062 (defun org-do-demote ()
8063 "Demote the current heading lower down the tree.
8064 If the region is active in `transient-mark-mode', demote all headings
8068 (if (org-region-active-p)
8069 (org-map-region 'org-demote (region-beginning) (region-end))
8071 (org-fix-position-after-promote))
8073 (defun org-fix-position-after-promote ()
8074 "Make sure that after pro/demotion cursor position is right."
8075 (let ((pos (point)))
8076 (when (save-excursion
8077 (beginning-of-line 1)
8078 (looking-at org-todo-line-regexp)
8079 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8080 (cond ((eobp) (insert " "))
8081 ((eolp) (insert " "))
8082 ((equal (char-after) ?\ ) (forward-char 1))))))
8084 (defun org-current-level ()
8085 "Return the level of the current entry, or nil if before the first headline.
8086 The level is the number of stars at the beginning of the
8087 headline. Use `org-reduced-level' to remove the effect of
8088 `org-odd-levels'. Unlike to `org-outline-level', this function
8089 ignores inlinetasks."
8090 (let ((level (org-with-limited-levels (org-outline-level))))
8091 (and (> level 0) level)))
8093 (defun org-get-previous-line-level ()
8094 "Return the outline depth of the last headline before the current line.
8095 Returns 0 for the first headline in the buffer, and nil if before the
8097 (and (org-current-level)
8098 (or (and (/= (line-beginning-position) (point-min))
8099 (save-excursion (beginning-of-line 0) (org-current-level)))
8102 (defun org-reduced-level (l)
8103 "Compute the effective level of a heading.
8104 This takes into account the setting of `org-odd-levels-only'."
8107 (org-odd-levels-only (1+ (floor (/ l 2))))
8110 (defun org-level-increment ()
8111 "Return the number of stars that will be added or removed at a
8112 time to headlines when structure editing, based on the value of
8113 `org-odd-levels-only'."
8114 (if org-odd-levels-only 2 1))
8116 (defun org-get-valid-level (level &optional change)
8117 "Rectify a level change under the influence of `org-odd-levels-only'
8118 LEVEL is a current level, CHANGE is by how much the level should be
8119 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8120 even level numbers will become the next higher odd number."
8121 (if org-odd-levels-only
8122 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8123 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8124 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8125 (max 1 (+ level (or change 0)))))
8127 (if (boundp 'define-obsolete-function-alias)
8128 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8129 (define-obsolete-function-alias 'org-get-legal-level
8130 'org-get-valid-level)
8131 (define-obsolete-function-alias 'org-get-legal-level
8132 'org-get-valid-level "23.1")))
8134 (defun org-promote ()
8135 "Promote the current heading higher up the tree."
8136 (org-with-wide-buffer
8137 (org-back-to-heading t)
8138 (let* ((after-change-functions (remq 'flyspell-after-change-function
8139 after-change-functions))
8140 (level (save-match-data (funcall outline-level)))
8141 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8142 (diff (abs (- level (length up-head) -1))))
8144 ((and (= level 1) org-allow-promoting-top-level-subtree)
8145 (replace-match "# " nil t))
8147 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8148 (t (replace-match up-head nil t)))
8150 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8151 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8152 (run-hooks 'org-after-promote-entry-hook))))
8154 (defun org-demote ()
8155 "Demote the current heading lower down the tree."
8156 (org-with-wide-buffer
8157 (org-back-to-heading t)
8158 (let* ((after-change-functions (remq 'flyspell-after-change-function
8159 after-change-functions))
8160 (level (save-match-data (funcall outline-level)))
8161 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8162 (diff (abs (- level (length down-head) -1))))
8163 (replace-match down-head nil t)
8164 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8165 (when org-adapt-indentation (org-fixup-indentation diff))
8166 (run-hooks 'org-after-demote-entry-hook))))
8168 (defun org-cycle-level ()
8169 "Cycle the level of an empty headline through possible states.
8170 This goes first to child, then to parent, level, then up the hierarchy.
8171 After top level, it switches back to sibling level."
8173 (let ((org-adapt-indentation nil))
8174 (when (org-point-at-end-of-empty-headline)
8175 (setq this-command 'org-cycle-level) ; Only needed for caching
8176 (let ((cur-level (org-current-level))
8177 (prev-level (org-get-previous-line-level)))
8179 ;; If first headline in file, promote to top-level.
8181 (loop repeat (/ (- cur-level 1) (org-level-increment))
8182 do (org-do-promote)))
8183 ;; If same level as prev, demote one.
8184 ((= prev-level cur-level)
8186 ;; If parent is top-level, promote to top level if not already.
8188 (loop repeat (/ (- cur-level 1) (org-level-increment))
8189 do (org-do-promote)))
8190 ;; If top-level, return to prev-level.
8192 (loop repeat (/ (- prev-level 1) (org-level-increment))
8193 do (org-do-demote)))
8194 ;; If less than prev-level, promote one.
8195 ((< cur-level prev-level)
8197 ;; If deeper than prev-level, promote until higher than
8199 ((> cur-level prev-level)
8200 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8201 do (org-do-promote))))
8204 (defun org-map-tree (fun)
8205 "Call FUN for every heading underneath the current one."
8206 (org-back-to-heading)
8207 (let ((level (funcall outline-level)))
8211 (outline-next-heading)
8212 (> (funcall outline-level) level))
8216 (defun org-map-region (fun beg end)
8217 "Call FUN for every heading between BEG and END."
8218 (let ((org-ignore-region t))
8220 (setq end (copy-marker end))
8222 (if (and (re-search-forward org-outline-regexp-bol nil t)
8226 (outline-next-heading)
8231 (defun org-fixup-indentation (diff)
8232 "Change the indentation in the current entry by DIFF.
8234 DIFF is an integer. Indentation is done according to the
8237 - Planning information and property drawers are always indented
8238 according to the new level of the headline;
8240 - Footnote definitions and their contents are ignored;
8242 - Inlinetasks' boundaries are not shifted;
8244 - Empty lines are ignored;
8246 - Other lines' indentation are shifted by DIFF columns, unless
8247 it would introduce a structural change in the document, in
8248 which case no shifting is done at all.
8250 Assume point is at a heading or an inlinetask beginning."
8251 (org-with-wide-buffer
8252 (narrow-to-region (line-beginning-position)
8254 (if (org-with-limited-levels (org-at-heading-p))
8255 (org-with-limited-levels (outline-next-heading))
8256 (org-inlinetask-goto-end))
8259 ;; Indent properly planning info and property drawer.
8260 (when (org-looking-at-p org-planning-line-re)
8263 (when (looking-at org-property-drawer-re)
8264 (goto-char (match-end 0))
8266 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8268 (when (zerop diff) (throw 'no-shift nil))
8269 ;; If DIFF is negative, first check if a shift is possible at all
8270 ;; (e.g., it doesn't break structure). This can only happen if
8271 ;; some contents are not properly indented.
8272 (let ((case-fold-search t))
8274 (let ((diff (- diff))
8275 (forbidden-re (concat org-outline-regexp
8277 (substring org-footnote-definition-re 1))))
8281 ((org-looking-at-p "[ \t]*$") (forward-line))
8282 ((and (org-looking-at-p org-footnote-definition-re)
8283 (let ((e (org-element-at-point)))
8284 (and (eq (org-element-type e) 'footnote-definition)
8285 (goto-char (org-element-property :end e))))))
8286 ((org-looking-at-p org-outline-regexp) (forward-line))
8287 ;; Give up if shifting would move before column 0 or
8288 ;; if it would introduce a headline or a footnote
8291 (skip-chars-forward " \t")
8292 (let ((ind (current-column)))
8293 (when (or (< ind diff)
8294 (and (= ind diff) (org-looking-at-p forbidden-re)))
8295 (throw 'no-shift nil)))
8296 ;; Ignore contents of example blocks and source
8297 ;; blocks if their indentation is meant to be
8298 ;; preserved. Jump to block's closing line.
8300 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8301 (let ((e (org-element-at-point)))
8302 (and (memq (org-element-type e)
8303 '(example-block src-block))
8304 (or org-src-preserve-indentation
8305 (org-element-property :preserve-indent e))
8306 (goto-char (org-element-property :end e))
8307 (progn (skip-chars-backward " \r\t\n")
8310 (forward-line))))))))
8311 ;; Shift lines but footnote definitions, inlinetasks boundaries
8312 ;; by DIFF. Also skip contents of source or example blocks
8313 ;; when indentation is meant to be preserved.
8316 ((and (org-looking-at-p org-footnote-definition-re)
8317 (let ((e (org-element-at-point)))
8318 (and (eq (org-element-type e) 'footnote-definition)
8319 (goto-char (org-element-property :end e))))))
8320 ((org-looking-at-p org-outline-regexp) (forward-line))
8321 ((org-looking-at-p "[ \t]*$") (forward-line))
8323 (org-indent-line-to (+ (org-get-indentation) diff))
8325 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8326 (let ((e (org-element-at-point)))
8327 (and (memq (org-element-type e)
8328 '(example-block src-block))
8329 (or org-src-preserve-indentation
8330 (org-element-property :preserve-indent e))
8331 (goto-char (org-element-property :end e))
8332 (progn (skip-chars-backward " \r\t\n")
8335 (forward-line)))))))))
8337 (defun org-convert-to-odd-levels ()
8338 "Convert an org-mode file with all levels allowed to one with odd levels.
8339 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8342 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8343 (let ((outline-level 'org-outline-level)
8344 (org-odd-levels-only nil) n)
8346 (goto-char (point-min))
8347 (while (re-search-forward "^\\*\\*+ " nil t)
8348 (setq n (- (length (match-string 0)) 2))
8349 (while (>= (setq n (1- n)) 0)
8351 (end-of-line 1))))))
8353 (defun org-convert-to-oddeven-levels ()
8354 "Convert an org-mode file with only odd levels to one with odd/even levels.
8355 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8356 file contains a section with an even level, conversion would
8357 destroy the structure of the file. An error is signaled in this
8360 (goto-char (point-min))
8361 ;; First check if there are no even levels
8362 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8363 (org-show-set-visibility 'canonical)
8364 (error "Not all levels are odd in this file. Conversion not possible"))
8365 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8366 (let ((outline-regexp org-outline-regexp)
8367 (outline-level 'org-outline-level)
8368 (org-odd-levels-only nil) n)
8370 (goto-char (point-min))
8371 (while (re-search-forward "^\\*\\*+ " nil t)
8372 (setq n (/ (1- (length (match-string 0))) 2))
8373 (while (>= (setq n (1- n)) 0)
8375 (end-of-line 1))))))
8377 (defun org-tr-level (n)
8378 "Make N odd if required."
8379 (if org-odd-levels-only (1+ (/ n 2)) n))
8381 ;;; Vertical tree motion, cutting and pasting of subtrees
8383 (defun org-move-subtree-up (&optional arg)
8384 "Move the current subtree up past ARG headlines of the same level."
8386 (org-move-subtree-down (- (prefix-numeric-value arg))))
8388 (defun org-move-subtree-down (&optional arg)
8389 "Move the current subtree down past ARG headlines of the same level."
8391 (setq arg (prefix-numeric-value arg))
8392 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8393 'org-get-last-sibling))
8394 (ins-point (make-marker))
8396 (col (current-column))
8397 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8399 (org-back-to-heading)
8402 (setq ne-beg (org-back-over-empty-lines))
8405 (save-excursion (outline-end-of-heading)
8406 (setq folded (outline-invisible-p)))
8407 (progn (org-end-of-subtree nil t)
8408 (unless (eobp) (backward-char))))
8409 (outline-next-heading)
8410 (setq ne-end (org-back-over-empty-lines))
8413 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8414 ;; include less whitespace
8417 (forward-line (- ne-beg ne-end))
8418 (setq beg (point))))
8419 ;; Find insertion point, with error handling
8421 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8422 (progn (goto-char beg0)
8423 (user-error "Cannot move past superior level or buffer limit")))
8424 (setq cnt (1- cnt)))
8426 ;; Moving forward - still need to move over subtree
8427 (progn (org-end-of-subtree t t)
8429 (org-back-over-empty-lines)
8430 (or (bolp) (newline)))))
8431 (setq ne-ins (org-back-over-empty-lines))
8432 (move-marker ins-point (point))
8433 (setq txt (buffer-substring beg end))
8434 (org-save-markers-in-region beg end)
8435 (delete-region beg end)
8436 (org-remove-empty-overlays-at beg)
8437 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8438 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8439 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8440 (let ((bbb (point)))
8441 (insert-before-markers txt)
8442 (org-reinstall-markers-in-region bbb)
8443 (move-marker ins-point bbb))
8444 (or (bolp) (insert "\n"))
8445 (setq ins-end (point))
8446 (goto-char ins-point)
8447 (org-skip-whitespace)
8448 (when (and (< arg 0)
8449 (org-first-sibling-p)
8451 ;; Move whitespace back to beginning
8454 (let ((kill-whole-line t))
8455 (kill-line (- ne-ins ne-beg)) (point)))
8456 (insert (make-string (- ne-ins ne-beg) ?\n)))
8457 (move-marker ins-point nil)
8462 (org-cycle-hide-drawers 'children))
8463 (org-clean-visibility-after-subtree-move)
8464 ;; move back to the initial column we were at
8465 (move-to-column col)))
8467 (defvar org-subtree-clip ""
8468 "Clipboard for cut and paste of subtrees.
8469 This is actually only a copy of the kill, because we use the normal kill
8470 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8472 (defvar org-subtree-clip-folded nil
8473 "Was the last copied subtree folded?
8474 This is used to fold the tree back after pasting.")
8476 (defun org-cut-subtree (&optional n)
8477 "Cut the current subtree into the clipboard.
8478 With prefix arg N, cut this many sequential subtrees.
8479 This is a short-hand for marking the subtree and then cutting it."
8481 (org-copy-subtree n 'cut))
8483 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8484 "Copy the current subtree it in the clipboard.
8485 With prefix arg N, copy this many sequential subtrees.
8486 This is a short-hand for marking the subtree and then copying it.
8487 If CUT is non-nil, actually cut the subtree.
8488 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8489 of some markers in the region, even if CUT is non-nil. This is
8490 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8492 (let (beg end folded (beg0 (point)))
8493 (if (org-called-interactively-p 'any)
8494 (org-back-to-heading nil) ; take what looks like a subtree
8495 (org-back-to-heading t)) ; take what is really there
8497 (skip-chars-forward " \t\r\n")
8500 (outline-next-heading)
8501 (save-excursion (outline-end-of-heading)
8502 (setq folded (outline-invisible-p)))
8503 (ignore-errors (org-forward-heading-same-level (1- n) t))
8504 (org-end-of-subtree t t)))
8505 ;; Include the end of an inlinetask
8506 (when (and (featurep 'org-inlinetask)
8507 (looking-at-p (concat (org-inlinetask-outline-regexp)
8513 (setq org-subtree-clip-folded folded)
8514 (when (or cut force-store-markers)
8515 (org-save-markers-in-region beg end))
8516 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8517 (setq org-subtree-clip (current-kill 0))
8518 (message "%s: Subtree(s) with %d characters"
8519 (if cut "Cut" "Copied")
8520 (length org-subtree-clip)))))
8522 (defun org-paste-subtree (&optional level tree for-yank remove)
8523 "Paste the clipboard as a subtree, with modification of headline level.
8524 The entire subtree is promoted or demoted in order to match a new headline
8527 If the cursor is at the beginning of a headline, the same level as
8528 that headline is used to paste the tree.
8530 If not, the new level is derived from the *visible* headings
8531 before and after the insertion point, and taken to be the inferior headline
8532 level of the two. So if the previous visible heading is level 3 and the
8533 next is level 4 (or vice versa), level 4 will be used for insertion.
8534 This makes sure that the subtree remains an independent subtree and does
8535 not swallow low level entries.
8537 You can also force a different level, either by using a numeric prefix
8538 argument, or by inserting the heading marker by hand. For example, if the
8539 cursor is after \"*****\", then the tree will be shifted to level 5.
8541 If optional TREE is given, use this text instead of the kill ring.
8543 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8544 move back over whitespace before inserting, and move point to the end of
8545 the inserted text when done.
8547 When REMOVE is non-nil, remove the subtree from the clipboard."
8549 (setq tree (or tree (and kill-ring (current-kill 0))))
8550 (unless (org-kill-is-subtree-p tree)
8552 (substitute-command-keys
8553 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8554 (org-with-limited-levels
8555 (let* ((visp (not (outline-invisible-p)))
8557 (^re_ "\\(\\*+\\)[ \t]*")
8558 (old-level (if (string-match org-outline-regexp-bol txt)
8559 (- (match-end 0) (match-beginning 0) 1)
8561 (force-level (cond (level (prefix-numeric-value level))
8562 ((and (looking-at "[ \t]*$")
8564 "^\\*+$" (buffer-substring
8565 (point-at-bol) (point))))
8566 (- (match-end 0) (match-beginning 0)))
8568 (looking-at org-outline-regexp))
8569 (- (match-end 0) (point) 1))))
8570 (previous-level (save-excursion
8573 (outline-previous-visible-heading 1)
8574 (if (looking-at ^re_)
8575 (- (match-end 0) (match-beginning 0) 1)
8578 (next-level (save-excursion
8581 (or (looking-at org-outline-regexp)
8582 (outline-next-visible-heading 1))
8583 (if (looking-at ^re_)
8584 (- (match-end 0) (match-beginning 0) 1)
8587 (new-level (or force-level (max previous-level next-level)))
8588 (shift (if (or (= old-level -1)
8590 (= old-level new-level))
8592 (- new-level old-level)))
8593 (delta (if (> shift 0) -1 1))
8594 (func (if (> shift 0) 'org-demote 'org-promote))
8595 (org-odd-levels-only nil)
8597 ;; Remove the forced level indicator
8599 (delete-region (point-at-bol) (point)))
8601 (beginning-of-line (if (bolp) 1 2))
8603 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8604 (insert-before-markers txt)
8605 (unless (string-match "\n\\'" txt) (insert "\n"))
8606 (setq newend (point))
8607 (org-reinstall-markers-in-region beg)
8610 (skip-chars-forward " \t\n\r")
8612 (if (and (outline-invisible-p) visp)
8613 (save-excursion (outline-show-heading)))
8614 ;; Shift if necessary
8617 (narrow-to-region beg end)
8618 (while (not (= shift 0))
8619 (org-map-region func (point-min) (point-max))
8620 (setq shift (+ delta shift)))
8621 (goto-char (point-min))
8622 (setq newend (point-max))))
8623 (when (or (org-called-interactively-p 'interactive) for-yank)
8624 (message "Clipboard pasted as level %d subtree" new-level))
8625 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8627 (eq org-subtree-clip (current-kill 0))
8628 org-subtree-clip-folded)
8629 ;; The tree was folded before it was killed/copied
8631 (and for-yank (goto-char newend))
8632 (and remove (setq kill-ring (cdr kill-ring))))))
8634 (defun org-kill-is-subtree-p (&optional txt)
8635 "Check if the current kill is an outline subtree, or a set of trees.
8636 Returns nil if kill does not start with a headline, or if the first
8637 headline level is not the largest headline level in the tree.
8638 So this will actually accept several entries of equal levels as well,
8639 which is OK for `org-paste-subtree'.
8640 If optional TXT is given, check this string instead of the current kill."
8641 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8642 (re (org-get-limited-outline-regexp))
8643 (^re (concat "^" re))
8644 (start-level (and kill
8646 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8648 (- (match-end 2) (match-beginning 2) 1)))
8649 (start (1+ (or (match-beginning 2) -1))))
8650 (if (not start-level)
8652 nil) ;; does not even start with a heading
8654 (while (setq start (string-match ^re kill (1+ start)))
8655 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8659 (defvar org-markers-to-move nil
8660 "Markers that should be moved with a cut-and-paste operation.
8661 Those markers are stored together with their positions relative to
8662 the start of the region.")
8664 (defun org-save-markers-in-region (beg end)
8665 "Check markers in region.
8666 If these markers are between BEG and END, record their position relative
8667 to BEG, so that after moving the block of text, we can put the markers back
8669 This function gets called just before an entry or tree gets cut from the
8670 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8671 called immediately, to move the markers with the entries."
8672 (setq org-markers-to-move nil)
8673 (when (featurep 'org-clock)
8674 (org-clock-save-markers-for-cut-and-paste beg end))
8675 (when (featurep 'org-agenda)
8676 (org-agenda-save-markers-for-cut-and-paste beg end)))
8678 (defun org-check-and-save-marker (marker beg end)
8679 "Check if MARKER is between BEG and END.
8680 If yes, remember the marker and the distance to BEG."
8681 (when (and (marker-buffer marker)
8682 (equal (marker-buffer marker) (current-buffer)))
8683 (if (and (>= marker beg) (< marker end))
8684 (push (cons marker (- marker beg)) org-markers-to-move))))
8686 (defun org-reinstall-markers-in-region (beg)
8687 "Move all remembered markers to their position relative to BEG."
8689 (move-marker (car x) (+ beg (cdr x))))
8690 org-markers-to-move)
8691 (setq org-markers-to-move nil))
8693 (defun org-narrow-to-subtree ()
8694 "Narrow buffer to the current subtree."
8698 (org-with-limited-levels
8700 (progn (org-back-to-heading t) (point))
8701 (progn (org-end-of-subtree t t)
8702 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8705 (defun org-narrow-to-block ()
8706 "Narrow buffer to the current block."
8708 (let* ((case-fold-search t)
8709 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8710 "^[ \t]*#\\+end_.*")))
8712 (narrow-to-region (car blockp) (cdr blockp))
8713 (user-error "Not in a block"))))
8715 (defun org-clone-subtree-with-time-shift (n &optional shift)
8716 "Clone the task (subtree) at point N times.
8717 The clones will be inserted as siblings.
8719 In interactive use, the user will be prompted for the number of
8720 clones to be produced. If the entry has a timestamp, the user
8721 will also be prompted for a time shift, which may be a repeater
8722 as used in time stamps, for example `+3d'. To disable this,
8723 you can call the function with a universal prefix argument.
8725 When a valid repeater is given and the entry contains any time
8726 stamps, the clones will become a sequence in time, with time
8727 stamps in the subtree shifted for each clone produced. If SHIFT
8728 is nil or the empty string, time stamps will be left alone. The
8729 ID property of the original subtree is removed.
8731 If the original subtree did contain time stamps with a repeater,
8732 the following will happen:
8733 - the repeater will be removed in each clone
8734 - an additional clone will be produced, with the current, unshifted
8735 date(s) in the entry.
8736 - the original entry will be placed *after* all the clones, with
8738 - the start days in the repeater in the original entry will be shifted
8739 to past the last clone.
8740 In this way you can spell out a number of instances of a repeating task,
8741 and still retain the repeater to cover future instances of the task.
8743 As described above, N+1 clones are produced when the original
8744 subtree has a repeater. Setting N to 0, then, can be used to
8745 remove the repeater from a subtree and create a shifted clone
8746 with the original repeater."
8747 (interactive "nNumber of clones to produce: ")
8750 (if (and (not (equal current-prefix-arg '(4)))
8752 (re-search-forward org-ts-regexp-both
8754 (org-end-of-subtree t)
8756 (read-from-minibuffer
8757 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8758 ""))) ;; No time shift
8760 (drawer-re org-drawer-regexp)
8761 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8762 beg end template task idprop
8763 shift-n shift-what doshift nmin nmax)
8764 (unless (wholenump n)
8765 (user-error "Invalid number of replications %s" n))
8766 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8767 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8769 (user-error "Invalid shift specification %s" shift))
8771 (setq shift-n (string-to-number (match-string 1 shift))
8772 shift-what (cdr (assoc (match-string 2 shift)
8773 '(("d" . day) ("w" . week)
8774 ("m" . month) ("y" . year))))))
8775 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8776 (setq nmin 1 nmax n)
8777 (org-back-to-heading t)
8779 (setq idprop (org-entry-get nil "ID"))
8780 (org-end-of-subtree t t)
8781 (or (bolp) (insert "\n"))
8783 (setq template (buffer-substring beg end))
8785 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8786 (delete-region beg end)
8788 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8790 (loop for n from nmin to nmax do
8795 (goto-char (point-min))
8797 (and idprop (if org-clone-delete-id
8798 (org-entry-delete nil "ID")
8799 (org-id-get-create t)))
8801 (while (re-search-forward org-clock-re nil t)
8803 (goto-char (point-min))
8804 (while (re-search-forward drawer-re nil t)
8805 (org-remove-empty-drawer-at (point))))
8806 (goto-char (point-min))
8808 (while (re-search-forward org-ts-regexp-both nil t)
8809 (org-timestamp-change (* n shift-n) shift-what))
8810 (unless (= n n-no-remove)
8811 (goto-char (point-min))
8812 (while (re-search-forward org-ts-regexp nil t)
8814 (goto-char (match-beginning 0))
8815 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8816 (delete-region (match-beginning 1) (match-end 1)))))))
8817 (setq task (buffer-string)))
8823 (defun org-sort (with-case)
8824 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8825 Optional argument WITH-CASE means sort case-sensitively."
8828 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8829 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8831 (org-call-with-arg 'org-sort-entries with-case))))
8833 (defun org-sort-remove-invisible (s)
8834 "Remove invisible links from string S."
8835 (remove-text-properties 0 (length s) org-rm-props s)
8836 (while (string-match org-bracket-link-regexp s)
8837 (setq s (replace-match (if (match-end 2)
8839 (match-string 1 s)) t t s)))
8840 (let ((st (format " %s " s)))
8841 (while (string-match org-emph-re st)
8842 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8843 (setq s (substring st 1 -1)))
8846 (defvar org-priority-regexp) ; defined later in the file
8848 (defvar org-after-sorting-entries-or-items-hook nil
8849 "Hook that is run after a bunch of entries or items have been sorted.
8850 When children are sorted, the cursor is in the parent line when this
8851 hook gets called. When a region or a plain list is sorted, the cursor
8852 will be in the first entry of the sorted region/list.")
8854 (defun org-sort-entries
8855 (&optional with-case sorting-type getkey-func compare-func property)
8856 "Sort entries on a certain level of an outline tree.
8857 If there is an active region, the entries in the region are sorted.
8858 Else, if the cursor is before the first entry, sort the top-level items.
8859 Else, the children of the entry at point are sorted.
8861 Sorting can be alphabetically, numerically, by date/time as given by
8862 a time stamp, by a property, by priority order, or by a custom function.
8864 The command prompts for the sorting type unless it has been given to the
8865 function through the SORTING-TYPE argument, which needs to be a character,
8866 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8867 the precise meaning of each character:
8869 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8870 c By creation time, which is assumed to be the first inactive time stamp
8871 at the beginning of a line.
8872 d By deadline date/time.
8874 n Numerically, by converting the beginning of the entry/item to a number.
8875 o By order of TODO keywords.
8876 p By priority according to the cookie.
8877 r By the value of a property.
8878 s By scheduled date/time.
8879 t By date/time, either the first active time stamp in the entry, or, if
8880 none exist, by the first inactive one.
8882 Capital letters will reverse the sort order.
8884 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8885 called with point at the beginning of the record. It must return either
8886 a string or a number that should serve as the sorting key for that record.
8888 Comparing entries ignores case by default. However, with an optional argument
8889 WITH-CASE, the sorting considers case as well.
8891 Sorting is done against the visible part of the headlines, it ignores hidden
8894 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8896 (let ((case-func (if with-case 'identity 'downcase))
8898 ;; The clock marker is lost when using `sort-subr', let's
8899 ;; store the clocking string.
8900 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8902 (goto-char org-clock-marker)
8903 (buffer-substring-no-properties (line-beginning-position)
8905 start beg end stars re re2
8907 ;; Find beginning and end of region to sort
8909 ((org-region-active-p)
8910 ;; we will sort the region
8911 (setq end (region-end)
8913 (goto-char (region-beginning))
8914 (if (not (org-at-heading-p)) (outline-next-heading))
8915 (setq start (point)))
8916 ((or (org-at-heading-p)
8917 (ignore-errors (progn (org-back-to-heading) t)))
8918 ;; we will sort the children of the current headline
8919 (org-back-to-heading)
8921 end (progn (org-end-of-subtree t t)
8922 (or (bolp) (insert "\n"))
8923 (when (>= (org-back-over-empty-lines) 1)
8929 (outline-next-heading))
8931 ;; we will sort the top-level entries in this file
8932 (goto-char (point-min))
8933 (or (org-at-heading-p) (outline-next-heading))
8934 (setq start (point))
8935 (goto-char (point-max))
8936 (beginning-of-line 1)
8937 (when (looking-at ".*?\\S-")
8938 ;; File ends in a non-white line
8941 (setq end (point-max))
8942 (setq what "top-level")
8947 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8949 (looking-at "\\(\\*+\\)")
8950 (setq stars (match-string 1)
8951 re (concat "^" (regexp-quote stars) " +")
8952 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8953 txt (buffer-substring beg end))
8954 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8955 (if (and (not (equal stars "*")) (string-match re2 txt))
8956 (user-error "Region to sort contains a level above the first entry"))
8958 (unless sorting-type
8960 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8961 [t]ime
[s]cheduled [d]eadline [c]reated cloc[k]ing
8962 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8964 (setq sorting-type (read-char-exclusive))
8967 (and (= (downcase sorting-type) ?f)
8969 (org-icompleting-read "Sort using function: "
8970 obarray 'fboundp t nil nil))
8971 (setq getkey-func (intern getkey-func))))
8973 (and (= (downcase sorting-type) ?r)
8976 (org-icompleting-read "Property: "
8977 (mapcar 'list (org-buffer-property-keys t))
8980 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8981 (message "Sorting entries...")
8984 (narrow-to-region start end)
8985 (let ((dcst (downcase sorting-type))
8986 (case-fold-search nil)
8987 (now (current-time)))
8989 (/= dcst sorting-type)
8990 ;; This function moves to the beginning character of the "record" to
8993 (if (re-search-forward re nil t)
8994 (goto-char (match-beginning 0))
8995 (goto-char (point-max))))
8996 ;; This function moves to the last character of the "record" being
9001 (outline-forward-same-level 1)
9003 (goto-char (point-max))))))
9004 ;; This function returns the value that gets sorted against.
9008 (if (looking-at org-complex-heading-regexp)
9009 (string-to-number (org-sort-remove-invisible (match-string 4)))
9012 (if (looking-at org-complex-heading-regexp)
9013 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9016 (or (get-text-property (point) :org-clock-minutes) 0))
9018 (let ((end (save-excursion (outline-next-heading) (point))))
9019 (if (or (re-search-forward org-ts-regexp end t)
9020 (re-search-forward org-ts-regexp-both end t))
9021 (org-time-string-to-seconds (match-string 0))
9022 (org-float-time now))))
9024 (let ((end (save-excursion (outline-next-heading) (point))))
9025 (if (re-search-forward
9026 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9028 (org-time-string-to-seconds (match-string 0))
9029 (org-float-time now))))
9031 (let ((end (save-excursion (outline-next-heading) (point))))
9032 (if (re-search-forward org-scheduled-time-regexp end t)
9033 (org-time-string-to-seconds (match-string 1))
9034 (org-float-time now))))
9036 (let ((end (save-excursion (outline-next-heading) (point))))
9037 (if (re-search-forward org-deadline-time-regexp end t)
9038 (org-time-string-to-seconds (match-string 1))
9039 (org-float-time now))))
9041 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9042 (string-to-char (match-string 2))
9043 org-default-priority))
9045 (or (org-entry-get nil property) ""))
9047 (if (looking-at org-complex-heading-regexp)
9048 (let* ((m (match-string 2))
9049 (s (if (member m org-done-keywords) '- '+)))
9050 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9054 (setq tmp (funcall getkey-func))
9055 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9057 (error "Invalid key function `%s'" getkey-func)))
9058 (t (error "Invalid sorting type `%c'" sorting-type))))
9061 ((= dcst ?a) 'string<)
9062 ((= dcst ?f) compare-func)
9063 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9064 (run-hooks 'org-after-sorting-entries-or-items-hook)
9065 ;; Reset the clock marker if needed
9069 (search-forward cmstr nil t)
9070 (move-marker org-clock-marker (point))))
9071 (message "Sorting entries...done")))
9073 ;;; The orgstruct minor mode
9075 ;; Define a minor mode which can be used in other modes in order to
9076 ;; integrate the org-mode structure editing commands.
9078 ;; This is really a hack, because the org-mode structure commands use
9079 ;; keys which normally belong to the major mode. Here is how it
9080 ;; works: The minor mode defines all the keys necessary to operate the
9081 ;; structure commands, but wraps the commands into a function which
9082 ;; tests if the cursor is currently at a headline or a plain list
9083 ;; item. If that is the case, the structure command is used,
9084 ;; temporarily setting many Org-mode variables like regular
9085 ;; expressions for filling etc. However, when any of those keys is
9086 ;; used at a different location, function uses `key-binding' to look
9087 ;; up if the key has an associated command in another currently active
9088 ;; keymap (minor modes, major mode, global), and executes that
9089 ;; command. There might be problems if any of the keys is otherwise
9090 ;; used as a prefix key.
9092 (defcustom orgstruct-heading-prefix-regexp ""
9093 "Regexp that matches the custom prefix of Org headlines in
9094 orgstruct(++)-mode."
9097 :package-version '(Org . "8.3")
9099 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9101 (defcustom orgstruct-setup-hook nil
9102 "Hook run after orgstruct-mode-map is filled."
9105 :package-version '(Org . "8.0")
9108 (defvar orgstruct-initialized nil)
9110 (defvar org-local-vars nil
9111 "List of local variables, for use by `orgstruct-mode'.")
9114 (define-minor-mode orgstruct-mode
9115 "Toggle the minor mode `orgstruct-mode'.
9116 This mode is for using Org-mode structure commands in other
9117 modes. The following keys behave as if Org-mode were active, if
9118 the cursor is on a headline, or on a plain list item (both as
9119 defined by Org-mode)."
9120 nil " OrgStruct" (make-sparse-keymap)
9121 (funcall (if orgstruct-mode
9122 'add-to-invisibility-spec
9123 'remove-from-invisibility-spec)
9125 (when orgstruct-mode
9126 (org-load-modules-maybe)
9127 (unless orgstruct-initialized
9129 (setq orgstruct-initialized t))))
9132 (defun turn-on-orgstruct ()
9133 "Unconditionally turn on `orgstruct-mode'."
9136 (defvar org-fb-vars nil)
9137 (make-variable-buffer-local 'org-fb-vars)
9138 (defun orgstruct++-mode (&optional arg)
9139 "Toggle `orgstruct-mode', the enhanced version of it.
9140 In addition to setting orgstruct-mode, this also exports all
9141 indentation and autofilling variables from org-mode into the
9142 buffer. It will also recognize item context in multiline items."
9144 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9146 (progn (orgstruct-mode -1)
9148 (org-set-local (car v)
9149 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9152 (setq org-fb-vars nil)
9153 (unless org-local-vars
9154 (setq org-local-vars (org-get-local-variables)))
9159 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9160 (symbol-name (car x)))
9161 (setq var (car x) val (nth 1 x))
9162 (push (list var `(quote ,(eval var))) org-fb-vars)
9163 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9165 (org-set-local 'orgstruct-is-++ t))))
9167 (defvar orgstruct-is-++ nil
9168 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9169 (make-variable-buffer-local 'orgstruct-is-++)
9172 (defun turn-on-orgstruct++ ()
9173 "Unconditionally turn on `orgstruct++-mode'."
9174 (orgstruct++-mode 1))
9176 (defun orgstruct-error ()
9177 "Error when there is no default binding for a structure key."
9179 (funcall (if (fboundp 'user-error)
9182 "This key has no function outside structure elements"))
9184 (defun orgstruct-setup ()
9185 "Setup orgstruct keymap."
9186 (dolist (cell '((org-demote . t)
9190 (org-shiftmetaleft . t)
9191 (org-shiftmetaright . t)
9192 org-backward-element
9193 org-backward-heading-same-level
9198 org-forward-heading-same-level
9200 org-insert-heading-respect-content
9201 org-kill-note-or-show-branches
9206 org-narrow-to-subtree
9221 outline-next-visible-heading
9222 outline-previous-visible-heading
9226 (let ((f (or (car-safe cell) cell))
9227 (disable-when-heading-prefix (cdr-safe cell)))
9229 (let ((new-bindings))
9230 (dolist (binding (nconc (where-is-internal f org-mode-map)
9231 (where-is-internal f outline-mode-map)))
9232 (push binding new-bindings)
9233 ;; TODO use local-function-key-map
9234 (dolist (rep '(("<tab>" . "TAB")
9235 ("<return>" . "RET")
9236 ("<escape>" . "ESC")
9237 ("<delete>" . "DEL")))
9238 (setq binding (read-kbd-macro
9239 (let ((case-fold-search))
9240 (replace-regexp-in-string
9241 (regexp-quote (cdr rep))
9243 (key-description binding)))))
9244 (pushnew binding new-bindings :test 'equal)))
9245 (dolist (binding new-bindings)
9246 (let ((key (lookup-key orgstruct-mode-map binding)))
9247 (when (or (not key) (numberp key))
9249 (org-defkey orgstruct-mode-map
9251 (orgstruct-make-binding
9252 f binding disable-when-heading-prefix))))))))))
9253 (run-hooks 'orgstruct-setup-hook))
9255 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9256 "Create a function for binding in the structure minor mode.
9257 FUN is the command to call inside a table. KEY is the key that
9258 should be checked in for a command to execute outside of tables.
9259 Non-nil `disable-when-heading-prefix' means to disable the command
9260 if `orgstruct-heading-prefix-regexp' is not empty."
9261 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9264 (while (fboundp (intern nname))
9265 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9266 (setq name (intern nname)))
9268 (let ((bindings '((org-heading-regexp
9270 orgstruct-heading-prefix-regexp
9271 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9273 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9274 (org-outline-regexp-bol
9275 (concat "^" org-outline-regexp))
9276 (outline-regexp org-outline-regexp)
9277 (outline-heading-end-regexp "\n")
9278 (outline-level 'org-outline-level)
9279 (outline-heading-alist))))
9281 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9282 "Outside of structure, run the binding of `"
9283 (key-description key) "'."
9284 (when disable-when-heading-prefix
9286 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9287 "back to the default binding due to limitations of Org's implementation of\n"
9288 "`" (symbol-name fun) "'.")))
9291 ,(and disable-when-heading-prefix
9292 '(not (string= orgstruct-heading-prefix-regexp ""))))
9297 (org-context-p 'headline 'item
9299 '(org-insert-heading
9300 org-insert-heading-respect-content
9302 '(when orgstruct-is-++
9305 (let* ((orgstruct-mode)
9312 ("<\\([^>]*\\)tab>" . "\\1TAB")
9313 ("<\\([^>]*\\)return>" . "\\1RET")
9314 ("<\\([^>]*\\)escape>" . "\\1ESC")
9315 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9318 (setq key (read-kbd-macro
9319 (let ((case-fold-search))
9320 (replace-regexp-in-string
9323 (key-description key))))))
9324 (when (key-binding key)
9325 (throw 'exit (key-binding key))))))))
9326 (if (keymapp binding)
9327 (org-set-transient-map binding)
9328 (let ((func (or binding
9330 'orgstruct-error))))
9332 (call-interactively func)))))
9333 (org-run-like-in-org-mode
9337 (call-interactively ',fun)))))))))
9340 (defun org-contextualize-keys (alist contexts)
9341 "Return valid elements in ALIST depending on CONTEXTS.
9343 `org-agenda-custom-commands' or `org-capture-templates' are the
9344 values used for ALIST, and `org-agenda-custom-commands-contexts'
9345 or `org-capture-templates-contexts' are the associated contexts
9348 ;; normalize contexts
9350 (lambda(c) (cond ((listp (cadr c))
9351 (list (car c) (car c) (cadr c)))
9352 ((string= "" (cadr c))
9353 (list (car c) (car c) (caddr c)))
9356 ;; loop over all commands or templates
9357 (while (setq c (pop a))
9360 ((not (assoc (car c) contexts))
9362 ((and (assoc (car c) contexts)
9363 (setq vrules (org-contextualize-validate-key
9366 (when (not (equal (car vr) (cadr vr)))
9367 (setq repl vr))) vrules)
9368 (if (not repl) (push c r)
9369 (push (cadr repl) s)
9372 (cdr (or (assoc (cadr repl) alist)
9373 (error "Undefined key `%s' as contextual replacement for `%s'"
9374 (cadr repl) (car c)))))
9376 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9381 (let ((tpl (car x)))
9385 (equal y tpl)) s))) x)))
9388 (defun org-contextualize-validate-key (key contexts)
9389 "Check CONTEXTS for agenda or capture KEY."
9391 (while (setq r (pop contexts))
9395 (and (equal key (car r))
9396 (if (functionp rr) (funcall rr)
9397 (or (and (eq (car rr) 'in-file)
9399 (string-match (cdr rr) (buffer-file-name)))
9400 (and (eq (car rr) 'in-mode)
9401 (string-match (cdr rr) (symbol-name major-mode)))
9402 (and (eq (car rr) 'in-buffer)
9403 (string-match (cdr rr) (buffer-name)))
9404 (when (and (eq (car rr) 'not-in-file)
9406 (not (string-match (cdr rr) (buffer-file-name))))
9407 (when (eq (car rr) 'not-in-mode)
9408 (not (string-match (cdr rr) (symbol-name major-mode))))
9409 (when (eq (car rr) 'not-in-buffer)
9410 (not (string-match (cdr rr) (buffer-name)))))))
9413 (delete-dups (delq nil res))))
9415 (defun org-context-p (&rest contexts)
9416 "Check if local context is any of CONTEXTS.
9417 Possible values in the list of contexts are `table', `headline', and `item'."
9418 (let ((pos (point)))
9419 (goto-char (point-at-bol))
9420 (prog1 (or (and (memq 'table contexts)
9421 (looking-at "[ \t]*|"))
9422 (and (memq 'headline contexts)
9423 (looking-at org-outline-regexp))
9424 (and (memq 'item contexts)
9425 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9426 (and (memq 'item-body contexts)
9430 (defun org-get-local-variables ()
9431 "Return a list of all local variables in an Org mode buffer."
9433 (with-current-buffer (get-buffer-create "*Org tmp*")
9436 (setq varlist (buffer-local-variables)))
9437 (kill-buffer "*Org tmp*")
9444 (list (car x) (cdr x))))
9445 (if (and (not (get (car x) 'org-state))
9447 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9448 (symbol-name (car x))))
9452 (defun org-clone-local-variables (from-buffer &optional regexp)
9453 "Clone local variables from FROM-BUFFER.
9454 Optional argument REGEXP selects variables to clone."
9457 (and (symbolp (car pair))
9459 (string-match regexp (symbol-name (car pair))))
9460 (set (make-local-variable (car pair))
9462 (buffer-local-variables from-buffer)))
9465 (defun org-run-like-in-org-mode (cmd)
9466 "Run a command, pretending that the current buffer is in Org-mode.
9467 This will temporarily bind local variables that are typically bound in
9468 Org-mode to the values they have in Org-mode, and then interactively
9470 (org-load-modules-maybe)
9471 (unless org-local-vars
9472 (setq org-local-vars (org-get-local-variables)))
9474 (dolist (var org-local-vars)
9475 (when (or (not (boundp (car var)))
9476 (eq (symbol-value (car var))
9477 (default-value (car var))))
9478 (push (list (car var) `(quote ,(cadr var))) binds)))
9480 (call-interactively (quote ,cmd))))))
9482 (defun org-get-category (&optional pos force-refresh)
9483 "Get the category applying to position POS."
9485 (if force-refresh (org-refresh-category-properties))
9486 (let ((pos (or pos (point))))
9487 (or (get-text-property pos 'org-category)
9488 (progn (org-refresh-category-properties)
9489 (get-text-property pos 'org-category))))))
9491 ;;; Refresh properties
9493 (defun org-refresh-properties (dprop tprop)
9494 "Refresh buffer text properties.
9495 DPROP is the drawer property and TPROP is either the
9496 corresponding text property to set, or an alist with each element
9497 being a text property (as a symbol) and a function to apply to
9498 the value of the drawer property."
9499 (let ((case-fold-search t)
9500 (inhibit-read-only t))
9501 (org-with-silent-modifications
9505 (goto-char (point-min))
9506 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9507 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9509 (defun org-refresh-property (tprop p)
9510 "Refresh the buffer text property TPROP from the drawer property P.
9511 The refresh happens only for the current tree (not subtree)."
9512 (unless (org-before-first-heading-p)
9514 (org-back-to-heading t)
9516 ;; TPROP is a text property symbol
9518 (point) (or (outline-next-heading) (point-max)) tprop p)
9519 ;; TPROP is an alist with (properties . function) elements
9523 (line-beginning-position) (or (outline-next-heading) (point-max))
9525 (funcall (cdr al) p))))))))
9527 (defun org-refresh-category-properties ()
9528 "Refresh category text properties in the buffer."
9529 (let ((case-fold-search t)
9530 (inhibit-read-only t)
9532 (cond ((null org-category)
9533 (if buffer-file-name
9534 (file-name-sans-extension
9535 (file-name-nondirectory buffer-file-name))
9537 ((symbolp org-category) (symbol-name org-category))
9539 (org-with-silent-modifications
9540 (org-with-wide-buffer
9541 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9542 ;; This is the default category for the buffer. If none is
9543 ;; found, fall-back to `org-category' or buffer file name.
9545 (point-min) (point-max)
9547 (catch 'buffer-category
9548 (goto-char (point-max))
9549 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9550 (let ((element (org-element-at-point)))
9551 (when (eq (org-element-type element) 'keyword)
9552 (throw 'buffer-category
9553 (org-element-property :value element)))))
9555 ;; Set sub-tree specific categories.
9556 (goto-char (point-min))
9557 (let ((regexp (org-re-property "CATEGORY")))
9558 (while (re-search-forward regexp nil t)
9559 (let ((value (org-match-string-no-properties 3)))
9560 (when (org-at-property-p)
9562 (save-excursion (org-back-to-heading t) (point))
9563 (save-excursion (org-end-of-subtree t t) (point))
9567 (defun org-refresh-stats-properties ()
9568 "Refresh stats text properties in the buffer."
9570 (org-with-silent-modifications
9574 (goto-char (point-min))
9575 (while (re-search-forward
9576 (concat org-outline-regexp-bol ".*"
9577 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9579 (setq stats (cond ((equal (match-string 3) "0") 0)
9581 (/ (* (string-to-number (match-string 2)) 100)
9582 (string-to-number (match-string 3))))
9583 (t (string-to-number (match-string 1)))))
9584 (org-back-to-heading t)
9585 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9586 'org-stats stats)))))))
9588 (defun org-refresh-effort-properties ()
9589 "Refresh effort properties"
9590 (org-refresh-properties
9592 '((effort . identity)
9593 (effort-minutes . org-duration-string-to-minutes))))
9597 ;;; Link abbreviations
9599 (defun org-link-expand-abbrev (link)
9600 "Apply replacements as defined in `org-link-abbrev-alist'."
9601 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9602 (let* ((key (match-string 1 link))
9603 (as (or (assoc key org-link-abbrev-alist-local)
9604 (assoc key org-link-abbrev-alist)))
9605 (tag (and (match-end 2) (match-string 3 link)))
9611 ((symbolp rpl) (funcall rpl tag))
9612 ((string-match "%(\\([^)]+\\))" rpl)
9615 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9616 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9617 ((string-match "%h" rpl)
9618 (replace-match (url-hexify-string (or tag "")) t t rpl))
9619 (t (concat rpl tag)))))
9622 ;;; Storing and inserting links
9624 (defvar org-insert-link-history nil
9625 "Minibuffer history for links inserted with `org-insert-link'.")
9627 (defvar org-stored-links nil
9628 "Contains the links stored with `org-store-link'.")
9630 (defvar org-store-link-plist nil
9631 "Plist with info about the most recently link created with `org-store-link'.")
9633 (defvar org-link-protocols nil
9634 "Link protocols added to Org-mode using `org-add-link-type'.")
9636 (defvar org-store-link-functions nil
9637 "List of functions that are called to create and store a link.
9638 Each function will be called in turn until one returns a non-nil
9639 value. Each function should check if it is responsible for creating
9640 this link (for example by looking at the major mode).
9641 If not, it must exit and return nil.
9642 If yes, it should return a non-nil value after a calling
9643 `org-store-link-props' with a list of properties and values.
9644 Special properties are:
9646 :type The link prefix, like \"http\". This must be given.
9647 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9648 This is obligatory as well.
9649 :description Optional default description for the second pair
9650 of brackets in an Org-mode link. The user can still change
9651 this when inserting this link into an Org-mode buffer.
9653 In addition to these, any additional properties can be specified
9654 and then used in capture templates.")
9656 (defun org-add-link-type (type &optional follow export)
9657 "Add TYPE to the list of `org-link-types'.
9658 Re-compute all regular expressions depending on `org-link-types'
9660 FOLLOW and EXPORT are two functions.
9662 FOLLOW should take the link path as the single argument and do whatever
9663 is necessary to follow the link, for example find a file or display
9666 EXPORT should format the link path for export to one of the export formats.
9667 It should be a function accepting three arguments:
9669 path the path of the link, the text after the prefix (like \"http:\")
9670 desc the description of the link, if any
9671 format the export format, a symbol like `html' or `latex' or `ascii'.
9673 The function may use the FORMAT information to return different values
9674 depending on the format. The return value will be put literally into
9675 the exported file. If the return value is nil, this means Org should
9676 do what it normally does with links which do not have EXPORT defined.
9678 Org mode has a built-in default for exporting links. If you are happy with
9679 this default, there is no need to define an export function for the link
9680 type. For a simple example of an export function, see `org-bbdb.el'."
9681 (add-to-list 'org-link-types type t)
9682 (org-make-link-regexps)
9683 (org-element-update-syntax)
9684 (if (assoc type org-link-protocols)
9685 (setcdr (assoc type org-link-protocols) (list follow export))
9686 (push (list type follow export) org-link-protocols)))
9688 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9689 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9692 (defun org-store-link (arg)
9693 "\\<org-mode-map>Store an org-link to the current location.
9694 This link is added to `org-stored-links' and can later be inserted
9695 into an Org buffer with \\[org-insert-link].
9697 For some link types, a prefix ARG is interpreted.
9698 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9699 For file links, ARG negates `org-context-in-file-links'.
9701 A double prefix ARG force skipping storing functions that are not
9704 A triple prefix ARG force storing a link for each line in the
9707 (org-load-modules-maybe)
9708 (if (and (equal arg '(64)) (org-region-active-p))
9710 (let ((end (region-end)))
9711 (goto-char (region-beginning))
9713 (while (< (point-at-eol) end)
9714 (move-end-of-line 1) (activate-mark)
9715 (let (current-prefix-arg)
9716 (call-interactively 'org-store-link))
9717 (move-beginning-of-line 2)
9718 (set-mark (point)))))
9719 (org-with-limited-levels
9720 (setq org-store-link-plist nil)
9721 (let (link cpltxt desc description search
9722 txt custom-id agenda-link sfuns sfunsn)
9725 ;; Store a link using an external link type
9726 ((and (not (equal arg '(16)))
9729 nil (mapcar (lambda (f)
9730 (let (fs) (if (funcall f) (push f fs))))
9731 org-store-link-functions))
9732 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9733 (or (and (cdr sfuns)
9736 "Which function for creating the link? "
9737 sfunsn nil t (car sfunsn)))))
9738 (funcall (caar sfuns)))
9739 (setq link (plist-get org-store-link-plist :link)
9740 desc (or (plist-get org-store-link-plist
9741 :description) link))))
9743 ;; Store a link from a source code buffer.
9744 ((org-src-edit-buffer-p)
9748 (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
9750 (setq link (format "(%s)" (org-match-string-no-properties 1))))
9751 ((org-called-interactively-p 'any)
9753 (while (or (not label)
9754 (org-with-wide-buffer
9755 (goto-char (point-min))
9757 (regexp-quote (format org-coderef-label-format label))
9759 (when label (message "Label exists already") (sit-for 2))
9760 (setq label (read-string "Code line label: " label)))
9762 (setq link (format org-coderef-label-format label))
9763 (let ((gc (- 79 (length link))))
9764 (if (< (current-column) gc) (org-move-to-column gc t)
9767 (setq link (concat "(" label ")") desc nil)))
9768 (t (setq link nil))))
9770 ;; We are in the agenda, link to referenced location
9771 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9772 (let ((m (or (get-text-property (point) 'org-hd-marker)
9773 (get-text-property (point) 'org-marker))))
9775 (org-with-point-at m
9777 (if (org-called-interactively-p 'any)
9778 (call-interactively 'org-store-link)
9779 (org-store-link nil)))))))
9781 ((eq major-mode 'calendar-mode)
9782 (let ((cd (calendar-cursor-to-date)))
9785 (car org-time-stamp-formats)
9787 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9789 (org-store-link-props :type "calendar" :date cd)))
9791 ((eq major-mode 'help-mode)
9792 (setq link (concat "help:" (save-excursion
9793 (goto-char (point-min))
9794 (looking-at "^[^ ]+")
9796 (org-store-link-props :type "help"))
9798 ((eq major-mode 'w3-mode)
9799 (setq cpltxt (if (and (buffer-name)
9800 (not (string-match "Untitled" (buffer-name))))
9803 link (url-view-url t))
9804 (org-store-link-props :type "w3" :url (url-view-url t)))
9806 ((eq major-mode 'image-mode)
9807 (setq cpltxt (concat "file:"
9808 (abbreviate-file-name buffer-file-name))
9810 (org-store-link-props :type "image" :file buffer-file-name))
9812 ;; In dired, store a link to the file of the current line
9813 ((derived-mode-p 'dired-mode)
9814 (let ((file (dired-get-filename nil t)))
9816 (abbreviate-file-name
9817 (expand-file-name (dired-get-filename nil t)))
9818 ;; otherwise, no file so use current directory.
9820 (setq cpltxt (concat "file:" file)
9823 ((setq search (run-hook-with-args-until-success
9824 'org-create-file-search-functions))
9825 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9827 (setq cpltxt (or description link)))
9829 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9830 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9832 ;; Store a link using the target at point
9833 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9836 (abbreviate-file-name
9837 (buffer-file-name (buffer-base-buffer)))
9838 "::" (match-string 1))
9840 ((and (featurep 'org-id)
9841 (or (eq org-id-link-to-org-use-id t)
9842 (and (org-called-interactively-p 'any)
9843 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9844 (and (eq org-id-link-to-org-use-id
9845 'create-if-interactive-and-no-custom-id)
9847 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9848 ;; Store a link using the ID at point
9849 (setq link (condition-case nil
9850 (prog1 (org-id-store-link)
9851 (setq desc (or (plist-get org-store-link-plist
9855 ;; Probably before first headline, link only to file
9857 (abbreviate-file-name
9858 (buffer-file-name (buffer-base-buffer))))))))
9860 ;; Just link to current headline
9861 (setq cpltxt (concat "file:"
9862 (abbreviate-file-name
9863 (buffer-file-name (buffer-base-buffer)))))
9864 ;; Add a context search string
9865 (when (org-xor org-context-in-file-links arg)
9866 (let* ((ee (org-element-at-point))
9867 (et (org-element-type ee))
9868 (ev (plist-get (cadr ee) :value))
9869 (ek (plist-get (cadr ee) :key))
9870 (eok (and (stringp ek) (string-match "name" ek))))
9872 ((org-at-heading-p) nil)
9873 ((and (eq et 'keyword) eok) ev)
9874 ((org-region-active-p)
9875 (buffer-substring (region-beginning) (region-end)))))
9876 (when (or (null txt) (string-match "\\S-" txt))
9880 (org-make-org-heading-search-string txt)
9882 desc (or (and (eq et 'keyword) eok ev)
9883 (nth 4 (ignore-errors (org-heading-components)))
9885 (if (string-match "::\\'" cpltxt)
9886 (setq cpltxt (substring cpltxt 0 -2)))
9887 (setq link cpltxt))))
9889 ((buffer-file-name (buffer-base-buffer))
9890 ;; Just link to this file here.
9891 (setq cpltxt (concat "file:"
9892 (abbreviate-file-name
9893 (buffer-file-name (buffer-base-buffer)))))
9894 ;; Add a context string.
9895 (when (org-xor org-context-in-file-links arg)
9896 (setq txt (if (org-region-active-p)
9897 (buffer-substring (region-beginning) (region-end))
9898 (buffer-substring (point-at-bol) (point-at-eol))))
9899 ;; Only use search option if there is some text.
9900 (when (string-match "\\S-" txt)
9902 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9906 ((org-called-interactively-p 'interactive)
9907 (user-error "No method for storing a link from this buffer"))
9909 (t (setq link nil)))
9911 ;; We're done setting link and desc, clean up
9912 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9913 (setq link (or link cpltxt)
9914 desc (or desc cpltxt))
9915 (cond ((equal desc "NONE") (setq desc nil))
9916 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9917 (let ((d0 (match-string 3 desc))
9918 (p0 (match-string 5 desc)))
9920 (replace-regexp-in-string
9921 org-bracket-link-regexp
9923 (if (equal (length (match-string 0 desc))
9924 (length desc)) "*" "")) desc)))))
9927 (if (not (and (or (org-called-interactively-p 'any)
9928 executing-kbd-macro) link))
9929 (or agenda-link (and link (org-make-link-string link desc)))
9930 (push (list link desc) org-stored-links)
9931 (message "Stored: %s" (or desc link))
9933 (setq link (concat "file:" (abbreviate-file-name
9934 (buffer-file-name)) "::#" custom-id))
9935 (push (list link desc) org-stored-links))
9936 (car org-stored-links))))))
9938 (defun org-store-link-props (&rest plist)
9939 "Store link properties, extract names and addresses."
9941 (when (setq x (plist-get plist :from))
9942 (setq adr (mail-extract-address-components x))
9943 (setq plist (plist-put plist :fromname (car adr)))
9944 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9945 (when (setq x (plist-get plist :to))
9946 (setq adr (mail-extract-address-components x))
9947 (setq plist (plist-put plist :toname (car adr)))
9948 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9949 (let ((from (plist-get plist :from))
9950 (to (plist-get plist :to)))
9951 (when (and from to org-from-is-user-regexp)
9953 (plist-put plist :fromto
9954 (if (string-match org-from-is-user-regexp from)
9956 (concat "from %f"))))))
9957 (setq org-store-link-plist plist))
9959 (defun org-add-link-props (&rest plist)
9960 "Add these properties to the link property list."
9963 (setq key (pop plist) value (pop plist))
9964 (setq org-store-link-plist
9965 (plist-put org-store-link-plist key value)))))
9967 (defun org-email-link-description (&optional fmt)
9968 "Return the description part of an email link.
9969 This takes information from `org-store-link-plist' and formats it
9970 according to FMT (default from `org-email-link-description-format')."
9971 (setq fmt (or fmt org-email-link-description-format))
9972 (let* ((p org-store-link-plist)
9973 (to (plist-get p :toaddress))
9974 (from (plist-get p :fromaddress))
9977 (cons "%c" (plist-get p :fromto))
9978 (cons "%F" (plist-get p :from))
9979 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9980 (cons "%T" (plist-get p :to))
9981 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9982 (cons "%s" (plist-get p :subject))
9983 (cons "%d" (plist-get p :date))
9984 (cons "%m" (plist-get p :message-id)))))
9985 (when (string-match "%c" fmt)
9986 ;; Check if the user wrote this message
9987 (if (and org-from-is-user-regexp from to
9988 (save-match-data (string-match org-from-is-user-regexp from)))
9989 (setq fmt (replace-match "to %t" t t fmt))
9990 (setq fmt (replace-match "from %f" t t fmt))))
9991 (org-replace-escapes fmt table)))
9993 (defun org-make-org-heading-search-string (&optional string)
9994 "Make search string for the current headline or STRING."
9996 (and (derived-mode-p 'org-mode)
9998 (org-back-to-heading t)
9999 (org-element-property :raw-value (org-element-at-point))))))
10000 (lines org-context-in-file-links))
10001 (or string (setq s (concat "*" s))) ; Add * for headlines
10002 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10003 (when (and string (integerp lines) (> lines 0))
10004 (let ((slines (org-split-string s "\n")))
10005 (when (< lines (length slines))
10008 (reverse (nthcdr (- (length slines) lines)
10009 (reverse slines))) "\n")))))
10010 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10012 (defun org-make-link-string (link &optional description)
10013 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10014 (unless (org-string-nw-p link) (error "Empty link"))
10015 (let ((uri (cond ((string-match org-link-types-re link)
10016 (concat (match-string 1 link)
10017 (org-link-escape (substring link (match-end 1)))))
10018 ;; For readability, url-encode internal links only
10019 ;; when absolutely needed (i.e, when they contain
10020 ;; square brackets). File links however, are
10021 ;; encoded since, e.g., spaces are significant.
10022 ((or (file-name-absolute-p link)
10023 (org-string-match-p "\\`\\.\\.?/\\|[][]" link))
10024 (org-link-escape link))
10027 (and (org-string-nw-p description)
10028 ;; Remove brackets from description, as they are fatal.
10029 (replace-regexp-in-string
10030 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10031 (org-trim description)))))
10034 (if description (format "[%s]" description) ""))))
10036 (defconst org-link-escape-chars
10039 "List of characters that should be escaped in a link when stored to Org.
10040 This is the list that is used for internal purposes.")
10042 (defconst org-link-escape-chars-browser
10045 "List of characters to be escaped before handing over to the browser.
10046 If you consider using this constant then you probably want to use
10047 the function `org-link-escape-browser' instead. See there why
10048 this constant is a candidate to be removed once Org drops support
10049 for Emacs 24.1 and 24.2.")
10051 (defun org-link-escape (text &optional table merge)
10052 "Return percent escaped representation of TEXT.
10053 TEXT is a string with the text to escape.
10054 Optional argument TABLE is a list with characters that should be
10055 escaped. When nil, `org-link-escape-chars' is used.
10056 If optional argument MERGE is set, merge TABLE into
10057 `org-link-escape-chars'."
10058 (let ((characters-to-encode
10059 (cond ((null table) org-link-escape-chars)
10060 (merge (append org-link-escape-chars table))
10064 (if (or (memq c characters-to-encode)
10065 (and org-url-hexify-p (or (< c 32) (> c 126))))
10066 (mapconcat (lambda (e) (format "%%%.2X" e))
10067 (or (encode-coding-char c 'utf-8)
10068 (error "Unable to percent escape character: %c" c))
10070 (char-to-string c)))
10073 (defun org-link-escape-browser (text)
10074 "Escape some characters before handing over to the browser.
10075 This function is a candidate to be removed together with the
10076 constant `org-link-escape-chars-browser' once Org drops support
10077 for Emacs 24.1 and 24.2. All calls to this function will have to
10078 be replaced with `url-encode-url' which is available since Emacs
10080 ;; Example with the Org link
10081 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10082 ;; to open the browser with +subject:"Release 8.2" filled into the
10083 ;; query field: In this case the variable TEXT contains the
10084 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10085 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10086 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10087 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10088 (if (fboundp 'url-encode-url)
10089 (url-encode-url text)
10090 (if (org-string-match-p
10091 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10093 (org-link-escape text org-link-escape-chars-browser)
10096 (defun org-link-unescape (str)
10097 "Unhex hexified Unicode parts in string STR.
10098 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10099 reciprocal of `org-link-escape', which see."
10100 (if (org-string-nw-p str)
10101 (replace-regexp-in-string
10102 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10105 (defun org-link-unescape-compound (hex)
10106 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10107 Note: this function also decodes single byte encodings like
10108 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10110 (let* ((bytes (cdr (split-string hex "%")))
10115 (let* ((val (string-to-number (pop bytes) 16))
10119 ((>= val 252) (cons 6 252))
10120 ((>= val 248) (cons 5 248))
10121 ((>= val 240) (cons 4 240))
10122 ((>= val 224) (cons 3 224))
10123 ((>= val 192) (cons 2 192))
10126 (if (>= val 192) (setq eat (car shift-xor)))
10127 (setq val (logxor val (cdr shift-xor)))
10128 (setq sum (+ (lsh sum (car shift-xor)) val))
10129 (if (> eat 0) (setq eat (- eat 1)))
10131 ((= 0 eat) ;multi byte
10132 (setq ret (concat ret (org-char-to-string sum)))
10134 ((not bytes) ; single byte(s)
10135 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10138 (defun org-link-unescape-single-byte-sequence (hex)
10139 "Unhexify hex-encoded single byte character sequences."
10140 (mapconcat (lambda (byte)
10141 (char-to-string (string-to-number byte 16)))
10142 (cdr (split-string hex "%")) ""))
10144 (defun org-xor (a b)
10148 (defun org-fixup-message-id-for-http (s)
10149 "Replace special characters in a message id, so it can be used in an http query."
10150 (when (string-match "%" s)
10151 (setq s (mapconcat (lambda (c)
10154 (char-to-string c)))
10156 (while (string-match "<" s)
10157 (setq s (replace-match "%3C" t t s)))
10158 (while (string-match ">" s)
10159 (setq s (replace-match "%3E" t t s)))
10160 (while (string-match "@" s)
10161 (setq s (replace-match "%40" t t s)))
10164 (defun org-link-prettify (link)
10165 "Return a human-readable representation of LINK.
10166 The car of LINK must be a raw link.
10167 The cdr of LINK must be either a link description or nil."
10168 (let ((desc (or (cadr link) "<no description>")))
10169 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10170 "<" (car link) ">")))
10173 (defun org-insert-link-global ()
10174 "Insert a link like Org-mode does.
10175 This command can be called in any mode to insert a link in Org-mode syntax."
10177 (org-load-modules-maybe)
10178 (org-run-like-in-org-mode 'org-insert-link))
10180 (defun org-insert-all-links (arg &optional pre post)
10181 "Insert all links in `org-stored-links'.
10182 When a universal prefix, do not delete the links from `org-stored-links'.
10183 When `ARG' is a number, insert the last N link(s).
10184 `PRE' and `POST' are optional arguments to define a string to
10185 prepend or to append."
10187 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10188 (links (copy-seq org-stored-links))
10190 (po (or post "\n"))
10192 (if (null org-stored-links)
10193 (message "No link to insert")
10194 (while (and (or (listp arg) (>= arg cnt))
10195 (setq l (if (listp arg)
10197 (pop org-stored-links))))
10198 (setq cnt (1+ cnt))
10200 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10203 (defun org-insert-last-stored-link (arg)
10204 "Insert the last link stored in `org-stored-links'."
10206 (org-insert-all-links arg "" "\n"))
10208 (defun org-link-fontify-links-to-this-file ()
10209 "Fontify links to the current file in `org-stored-links'."
10210 (let ((f (buffer-file-name)) a b)
10211 (setq a (mapcar (lambda(l)
10212 (let ((ll (car l)))
10213 (when (and (string-match "^file:\\(.+\\)::" ll)
10214 (equal f (expand-file-name (match-string 1 ll))))
10217 (when (featurep 'org-id)
10218 (setq b (mapcar (lambda(l)
10219 (let ((ll (car l)))
10220 (when (and (string-match "^id:\\(.+\\)$" ll)
10221 (equal f (expand-file-name
10222 (or (org-id-find-id-file
10223 (match-string 1 ll)) ""))))
10225 org-stored-links)))
10227 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10228 (delq nil (append a b)))))
10230 (defvar org-link-links-in-this-file nil)
10231 (defun org-insert-link (&optional complete-file link-location default-description)
10232 "Insert a link. At the prompt, enter the link.
10234 Completion can be used to insert any of the link protocol prefixes like
10235 http or ftp in use.
10237 The history can be used to select a link previously stored with
10238 `org-store-link'. When the empty string is entered (i.e. if you just
10239 press RET at the prompt), the link defaults to the most recently
10240 stored link. As SPC triggers completion in the minibuffer, you need to
10241 use M-SPC or C-q SPC to force the insertion of a space character.
10243 You will also be prompted for a description, and if one is given, it will
10244 be displayed in the buffer instead of the link.
10246 If there is already a link at point, this command will allow you to edit link
10247 and description parts.
10249 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10250 be selected using completion. The path to the file will be relative to the
10251 current directory if the file is in the current directory or a subdirectory.
10252 Otherwise, the link will be the absolute path as completed in the minibuffer
10253 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10254 option `org-link-file-path-type'.
10256 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10257 the current directory or below.
10259 With three \\[universal-argument] prefixes, negate the meaning of
10260 `org-keep-stored-link-after-insertion'.
10262 If `org-make-link-description-function' is non-nil, this function will be
10263 called with the link target, and the result will be the default
10266 If the LINK-LOCATION parameter is non-nil, this value will be
10267 used as the link location instead of reading one interactively.
10269 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10270 be used as the default description."
10272 (let* ((wcf (current-window-configuration))
10273 (origbuf (current-buffer))
10274 (region (if (org-region-active-p)
10275 (buffer-substring (region-beginning) (region-end))))
10276 (remove (and region (list (region-beginning) (region-end))))
10278 tmphist ; byte-compile incorrectly complains about this
10279 (link link-location)
10280 (abbrevs org-link-abbrev-alist-local)
10281 entry file all-prefixes auto-desc)
10283 (link-location) ; specified by arg, just use it.
10284 ((org-in-regexp org-bracket-link-regexp 1)
10285 ;; We do have a link at point, and we are going to edit it.
10286 (setq remove (list (match-beginning 0) (match-end 0)))
10287 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10288 (setq link (read-string "Link: "
10290 (org-match-string-no-properties 1)))))
10291 ((or (org-in-regexp org-angle-link-re)
10292 (org-in-regexp org-plain-link-re))
10293 ;; Convert to bracket link
10294 (setq remove (list (match-beginning 0) (match-end 0))
10295 link (read-string "Link: "
10296 (org-remove-angle-brackets (match-string 0)))))
10297 ((member complete-file '((4) (16)))
10298 ;; Completing read for file names.
10299 (setq link (org-file-complete-link complete-file)))
10301 ;; Read link, with completion for stored links.
10302 (org-link-fontify-links-to-this-file)
10303 (org-switch-to-buffer-other-window "*Org Links*")
10304 (with-current-buffer "*Org Links*"
10306 (insert "Insert a link.
10307 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10308 (when org-stored-links
10309 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10310 (insert (mapconcat 'org-link-prettify
10311 (reverse org-stored-links) "\n")))
10312 (goto-char (point-min)))
10313 (let ((cw (selected-window)))
10314 (select-window (get-buffer-window "*Org Links*" 'visible))
10315 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10316 (unless (pos-visible-in-window-p (point-max))
10317 (org-fit-window-to-buffer))
10318 (and (window-live-p cw) (select-window cw)))
10319 ;; Fake a link history, containing the stored links.
10320 (setq tmphist (append (mapcar 'car org-stored-links)
10321 org-insert-link-history))
10322 (setq all-prefixes (append (mapcar 'car abbrevs)
10323 (mapcar 'car org-link-abbrev-alist)
10328 (org-completing-read
10331 (mapcar (lambda (x) (concat x ":"))
10333 (mapcar 'car org-stored-links))
10336 (caar org-stored-links)))
10337 (if (not (string-match "\\S-" link))
10338 (user-error "No link selected"))
10340 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10342 (if (or (member link all-prefixes)
10343 (and (equal ":" (substring link -1))
10344 (member (substring link 0 -1) all-prefixes)
10345 (setq link (substring link 0 -1))))
10346 (setq link (with-current-buffer origbuf
10347 (org-link-try-special-completion link)))))
10348 (set-window-configuration wcf)
10349 (kill-buffer "*Org Links*"))
10350 (setq entry (assoc link org-stored-links))
10351 (or entry (push link org-insert-link-history))
10352 (setq desc (or desc (nth 1 entry)))))
10354 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10355 (not org-keep-stored-link-after-insertion))
10356 (setq org-stored-links (delq (assoc link org-stored-links)
10357 org-stored-links)))
10359 (if (and (string-match org-plain-link-re link)
10360 (not (string-match org-ts-regexp link)))
10361 ;; URL-like link, normalize the use of angular brackets.
10362 (setq link (org-remove-angle-brackets link)))
10364 ;; Check if we are linking to the current file with a search
10365 ;; option If yes, simplify the link by using only the search
10367 (when (and buffer-file-name
10368 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10369 (let* ((path (match-string 1 link))
10370 (case-fold-search nil)
10371 (search (match-string 2 link)))
10373 (if (equal (file-truename buffer-file-name) (file-truename path))
10374 ;; We are linking to this same file, with a search option
10375 (setq link search)))))
10377 ;; Check if we can/should use a relative path. If yes, simplify the link
10378 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10379 (let* ((type (match-string 1 link))
10380 (path (match-string 2 link))
10382 (case-fold-search nil))
10384 ((or (eq org-link-file-path-type 'absolute)
10385 (equal complete-file '(16)))
10386 (setq path (abbreviate-file-name (expand-file-name path))))
10387 ((eq org-link-file-path-type 'noabbrev)
10388 (setq path (expand-file-name path)))
10389 ((eq org-link-file-path-type 'relative)
10390 (setq path (file-relative-name path)))
10393 (if (string-match (concat "^" (regexp-quote
10395 (file-name-as-directory
10396 default-directory))))
10397 (expand-file-name path))
10398 ;; We are linking a file with relative path name.
10399 (setq path (substring (expand-file-name path)
10401 (setq path (abbreviate-file-name (expand-file-name path)))))))
10402 (setq link (concat type path))
10403 (if (equal desc origpath)
10404 (setq desc path))))
10406 (if org-make-link-description-function
10408 (or (condition-case nil
10409 (funcall org-make-link-description-function link desc)
10410 (error (progn (message "Can't get link description from `%s'"
10411 (symbol-name org-make-link-description-function))
10413 (read-string "Description: " default-description)))
10414 (if default-description (setq desc default-description)
10415 (setq desc (or (and auto-desc desc)
10416 (read-string "Description: " desc)))))
10418 (unless (string-match "\\S-" desc) (setq desc nil))
10419 (if remove (apply 'delete-region remove))
10420 (insert (org-make-link-string link desc))))
10422 (defun org-link-try-special-completion (type)
10423 "If there is completion support for link type TYPE, offer it."
10424 (let ((fun (intern (concat "org-" type "-complete-link"))))
10425 (if (functionp fun)
10427 (read-string "Link (no completion support): " (concat type ":")))))
10429 (defun org-file-complete-link (&optional arg)
10430 "Create a file link using completion."
10431 (let ((file (org-iread-file-name "File: "))
10432 (pwd (file-name-as-directory (expand-file-name ".")))
10433 (pwd1 (file-name-as-directory (abbreviate-file-name
10434 (expand-file-name ".")))))
10435 (cond ((equal arg '(16))
10437 (abbreviate-file-name (expand-file-name file))))
10439 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10440 (concat "file:" (match-string 1 file)))
10442 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10443 (expand-file-name file))
10445 (match-string 1 (expand-file-name file))))
10446 (t (concat "file:" file)))))
10448 (defun org-iread-file-name (&rest args)
10449 "Read-file-name using `ido-mode' speedup if available.
10450 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10451 See `read-file-name' for a description of parameters."
10452 (org-without-partial-completion
10453 (if (and org-completion-use-ido
10454 (fboundp 'ido-read-file-name)
10455 (org-bound-and-true-p ido-mode)
10456 (listp (nth 1 args)))
10457 (let ((ido-enter-matching-directory nil))
10458 (apply #'ido-read-file-name args))
10459 (apply #'read-file-name args))))
10461 (defun org-completing-read (&rest args)
10462 "Completing-read with SPACE being a normal character."
10463 (let ((enable-recursive-minibuffers t)
10464 (minibuffer-local-completion-map
10465 (copy-keymap minibuffer-local-completion-map)))
10466 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10467 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10468 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10469 (apply 'org-icompleting-read args)))
10471 (defun org-completing-read-no-i (&rest args)
10472 (let (org-completion-use-ido org-completion-use-iswitchb)
10473 (apply 'org-completing-read args)))
10475 (defun org-iswitchb-completing-read (prompt choices &rest args)
10476 "Use iswitch as a completing-read replacement to choose from choices.
10477 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10479 (let* ((iswitchb-use-virtual-buffers nil)
10480 (iswitchb-make-buflist-hook
10482 (setq iswitchb-temp-buflist choices))))
10483 (iswitchb-read-buffer prompt)))
10485 (defun org-icompleting-read (&rest args)
10486 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10487 Should be called like `completing-read'."
10488 (org-without-partial-completion
10489 (if (not (listp (nth 1 args)))
10490 ;; Ido only supports lists as the COLLECTION argument. Use
10491 ;; default completion function when second argument is not
10493 (apply #'completing-read args)
10494 (let ((ido-enter-matching-directory nil))
10495 (apply (cond ((and org-completion-use-ido
10496 (fboundp 'ido-completing-read)
10497 (org-bound-and-true-p ido-mode))
10498 #'ido-completing-read)
10499 ((and org-completion-use-iswitchb
10500 (org-bound-and-true-p iswitchb-mode))
10501 #'org-iswitchb-completing-read)
10502 (t #'completing-read))
10505 ;;; Opening/following a link
10507 (defvar org-link-search-failed nil)
10509 (defvar org-open-link-functions nil
10510 "Hook for functions finding a plain text link.
10511 These functions must take a single argument, the link content.
10512 They will be called for links that look like [[link text][description]]
10513 when LINK TEXT does not have a protocol like \"http:\" and does not look
10514 like a filename (e.g. \"./blue.png\").
10516 These functions will be called *before* Org attempts to resolve the
10517 link by doing text searches in the current buffer - so if you want a
10518 link \"[[target]]\" to still find \"<<target>>\", your function should
10519 handle this as a special case.
10521 When the function does handle the link, it must return a non-nil value.
10522 If it decides that it is not responsible for this link, it must return
10523 nil to indicate that that Org-mode can continue with other options
10524 like exact and fuzzy text search.")
10526 (defun org-next-link (&optional search-backward)
10527 "Move forward to the next link.
10528 If the link is in hidden text, expose it."
10530 (when (and org-link-search-failed (eq this-command last-command))
10531 (goto-char (point-min))
10532 (message "Link search wrapped back to beginning of buffer"))
10533 (setq org-link-search-failed nil)
10534 (let* ((pos (point))
10536 (a (assoc :link ct))
10537 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10538 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10539 ((looking-at org-any-link-re)
10540 ;; Don't stay stuck at link without an org-link face
10541 (forward-char (if search-backward -1 1))))
10542 (if (funcall srch-fun org-any-link-re nil t)
10544 (goto-char (match-beginning 0))
10545 (if (outline-invisible-p) (org-show-context)))
10547 (setq org-link-search-failed t)
10548 (message "No further link found"))))
10550 (defun org-previous-link ()
10551 "Move backward to the previous link.
10552 If the link is in hidden text, expose it."
10554 (funcall 'org-next-link t))
10556 (defun org-translate-link (s)
10557 "Translate a link string if a translation function has been defined."
10558 (if (and org-link-translation-function
10559 (fboundp org-link-translation-function)
10560 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10562 (setq s (funcall org-link-translation-function
10563 (match-string 1 s) (match-string 2 s)))
10564 (concat (car s) ":" (cdr s)))
10567 (defun org-translate-link-from-planner (type path)
10568 "Translate a link from Emacs Planner syntax so that Org can follow it.
10569 This is still an experimental function, your mileage may vary."
10571 ((member type '("http" "https" "news" "ftp"))
10572 ;; standard Internet links are the same.
10574 ((and (equal type "irc") (string-match "^//" path))
10575 ;; Planner has two / at the beginning of an irc link, we have 1.
10576 ;; We should have zero, actually....
10577 (setq path (substring path 1)))
10578 ((and (equal type "lisp") (string-match "^/" path))
10579 ;; Planner has a slash, we do not.
10580 (setq type "elisp" path (substring path 1)))
10581 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10582 ;; A typical message link. Planner has the id after the final slash,
10583 ;; we separate it with a hash mark
10584 (setq path (concat (match-string 1 path) "#"
10585 (org-remove-angle-brackets (match-string 2 path))))))
10588 (defun org-find-file-at-mouse (ev)
10589 "Open file link or URL at mouse."
10591 (mouse-set-point ev)
10592 (org-open-at-point 'in-emacs))
10594 (defun org-open-at-mouse (ev)
10595 "Open file link or URL at mouse.
10596 See the docstring of `org-open-file' for details."
10598 (mouse-set-point ev)
10599 (if (eq major-mode 'org-agenda-mode)
10600 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10601 (org-open-at-point))
10603 (defvar org-window-config-before-follow-link nil
10604 "The window configuration before following a link.
10605 This is saved in case the need arises to restore it.")
10608 (defun org-open-at-point-global ()
10609 "Follow a link like Org-mode does.
10610 This command can be called in any mode to follow a link that has
10613 (org-run-like-in-org-mode 'org-open-at-point))
10616 (defun org-open-link-from-string (s &optional arg reference-buffer)
10617 "Open a link in the string S, as if it was in Org-mode."
10618 (interactive "sLink: \nP")
10619 (let ((reference-buffer (or reference-buffer (current-buffer))))
10621 (let ((org-inhibit-startup (not reference-buffer)))
10624 (goto-char (point-min))
10625 (when reference-buffer
10626 (setq org-link-abbrev-alist-local
10627 (with-current-buffer reference-buffer
10628 org-link-abbrev-alist-local)))
10629 (org-open-at-point arg reference-buffer)))))
10631 (defvar org-open-at-point-functions nil
10632 "Hook that is run when following a link at point.
10634 Functions in this hook must return t if they identify and follow
10635 a link at point. If they don't find anything interesting at point,
10636 they must return nil.")
10638 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10639 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10640 (defun org-open-at-point (&optional arg reference-buffer)
10641 "Open link, timestamp, footnote or tags at point.
10643 When point is on a link, follow it. Normally, files will be
10644 opened by an appropriate application. If the optional prefix
10645 argument ARG is non-nil, Emacs will visit the file. With
10646 a double prefix argument, try to open outside of Emacs, in the
10647 application the system uses for this file type.
10649 When point is on a timestamp, open the agenda at the day
10652 When point is a footnote definition, move to the first reference
10653 found. If it is on a reference, move to the associated
10656 When point is on a headline, display a list of every link in the
10657 entry, so it is possible to pick one, or all, of them. If point
10658 is on a tag, call `org-tags-view' instead.
10660 When optional argument REFERENCE-BUFFER is non-nil, it should
10661 specify a buffer from where the link search should happen. This
10662 is used internally by `org-open-link-from-string'.
10664 On top of syntactically correct links, this function will open
10665 the link at point in comments or comment blocks and the first
10666 link in a property drawer line."
10668 ;; On a code block, open block's results.
10669 (unless (call-interactively 'org-babel-open-src-block-result)
10670 (org-load-modules-maybe)
10671 (setq org-window-config-before-follow-link (current-window-configuration))
10672 (org-remove-occur-highlights nil nil t)
10673 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10675 ;; Only consider supported types, even if they are not
10676 ;; the closest one.
10677 (org-element-lineage
10678 (org-element-context)
10679 '(comment comment-block footnote-definition footnote-reference
10680 headline inlinetask keyword link node-property
10683 (type (org-element-type context))
10684 (value (org-element-property :value context)))
10686 ((not context) (user-error "No link found"))
10687 ;; Exception: open timestamps and links in properties
10688 ;; drawers, keywords and comments.
10689 ((memq type '(comment comment-block keyword node-property))
10690 (cond ((org-in-regexp org-any-link-re)
10691 (org-open-link-from-string (match-string-no-properties 0)))
10692 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10693 (org-follow-timestamp-link))
10694 (t (user-error "No link found"))))
10695 ;; On a headline or an inlinetask, but not on a timestamp,
10696 ;; a link, a footnote reference or on tags.
10697 ((and (memq type '(headline inlinetask))
10699 (progn (save-excursion (beginning-of-line)
10700 (looking-at org-complex-heading-regexp))
10701 (or (not (match-beginning 5))
10702 (< (point) (match-beginning 5)))))
10703 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10705 (links-end (cdr data)))
10707 (dolist (link (if (stringp links) (list links) links))
10708 (search-forward link nil links-end)
10709 (goto-char (match-beginning 0))
10710 (org-open-at-point))
10711 (require 'org-attach)
10712 (org-attach-reveal 'if-exists))))
10713 ;; Do nothing on white spaces after an object, unless point
10714 ;; is right after it.
10717 (goto-char (org-element-property :end context))
10718 (skip-chars-backward " \t")
10720 (user-error "No link found"))
10721 ((eq type 'timestamp) (org-follow-timestamp-link))
10722 ;; On tags within a headline or an inlinetask.
10723 ((and (memq type '(headline inlinetask))
10724 (progn (save-excursion (beginning-of-line)
10725 (looking-at org-complex-heading-regexp))
10726 (and (match-beginning 5)
10727 (>= (point) (match-beginning 5)))))
10728 (org-tags-view arg (substring (match-string 5) 0 -1)))
10730 ;; When link is located within the description of another
10731 ;; link (e.g., an inline image), always open the parent
10733 (let*((link (let ((up (org-element-property :parent context)))
10734 (if (eq (org-element-type up) 'link) up context)))
10735 (type (org-element-property :type link))
10736 (path (org-link-unescape (org-element-property :path link))))
10737 ;; Switch back to REFERENCE-BUFFER needed when called in
10738 ;; a temporary buffer through `org-open-link-from-string'.
10739 (with-current-buffer (or reference-buffer (current-buffer))
10741 ((equal type "file")
10742 (if (string-match "[*?{]" (file-name-nondirectory path))
10744 ;; Look into `org-link-protocols' in order to find
10745 ;; a DEDICATED-FUNCTION to open file. The function
10746 ;; will be applied on raw link instead of parsed
10747 ;; link due to the limitation in `org-add-link-type'
10748 ;; ("open" function called with a single argument).
10749 ;; If no such function is found, fallback to
10750 ;; `org-open-file'.
10752 ;; Note : "file+emacs" and "file+sys" types are
10753 ;; hard-coded in order to escape the previous
10755 (let* ((option (org-element-property :search-option link))
10756 (app (org-element-property :application link))
10757 (dedicated-function
10758 (nth 1 (assoc app org-link-protocols))))
10759 (if dedicated-function
10760 (funcall dedicated-function
10762 (and option (concat "::" option))))
10763 (apply #'org-open-file
10766 ((equal app "emacs") 'emacs)
10767 ((equal app "sys") 'system))
10768 (cond ((not option) nil)
10769 ((org-string-match-p "\\`[0-9]+\\'" option)
10770 (list (string-to-number option)))
10772 (org-link-unescape option)))))))))
10773 ((assoc type org-link-protocols)
10774 (funcall (nth 1 (assoc type org-link-protocols)) path))
10775 ((equal type "help")
10776 (let ((f-or-v (intern path)))
10777 (cond ((fboundp f-or-v) (describe-function f-or-v))
10778 ((boundp f-or-v) (describe-variable f-or-v))
10779 (t (error "Not a known function or variable")))))
10780 ((member type '("http" "https" "ftp" "mailto" "news"))
10781 (browse-url (org-link-escape-browser (concat type ":" path))))
10782 ((equal type "doi")
10784 (org-link-escape-browser (concat org-doi-server-url path))))
10785 ((equal type "message") (browse-url (concat type ":" path)))
10786 ((equal type "shell")
10787 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10789 (if (or (and (org-string-nw-p
10790 org-confirm-shell-link-not-regexp)
10792 org-confirm-shell-link-not-regexp cmd))
10793 (not org-confirm-shell-link-function)
10794 (funcall org-confirm-shell-link-function
10795 (format "Execute \"%s\" in shell? "
10796 (org-add-props cmd nil
10797 'face 'org-warning))))
10799 (message "Executing %s" cmd)
10800 (shell-command cmd buf)
10801 (when (featurep 'midnight)
10802 (setq clean-buffer-list-kill-buffer-names
10803 (cons (buffer-name buf)
10804 clean-buffer-list-kill-buffer-names))))
10805 (user-error "Abort"))))
10806 ((equal type "elisp")
10808 (if (or (and (org-string-nw-p
10809 org-confirm-elisp-link-not-regexp)
10810 (org-string-match-p
10811 org-confirm-elisp-link-not-regexp cmd))
10812 (not org-confirm-elisp-link-function)
10813 (funcall org-confirm-elisp-link-function
10814 (format "Execute \"%s\" as elisp? "
10815 (org-add-props cmd nil
10816 'face 'org-warning))))
10817 (message "%s => %s" cmd
10818 (if (eq (string-to-char cmd) ?\()
10820 (call-interactively (read cmd))))
10821 (user-error "Abort"))))
10824 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10825 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10826 (unless (run-hook-with-args-until-success
10827 'org-open-link-functions path)
10828 (if (not arg) (org-mark-ring-push)
10829 (switch-to-buffer-other-window
10830 (org-get-buffer-for-internal-link (current-buffer))))
10832 (org-with-wide-buffer
10833 (if (equal type "radio")
10834 (org-search-radio-target
10835 (org-element-property :path link))
10837 (if (member type '("custom-id" "coderef"))
10838 (org-element-property :raw-link link)
10840 ;; Prevent fuzzy links from matching
10842 (and (equal type "fuzzy")
10843 (+ 2 (org-element-property :begin link)))))
10845 (unless (and (<= (point-min) destination)
10846 (>= (point-max) destination))
10848 (goto-char destination))))
10849 (t (browse-url-at-point))))))
10850 ;; On a footnote reference or at a footnote definition's label.
10851 ((or (eq type 'footnote-reference)
10852 (and (eq type 'footnote-definition)
10854 ;; Do not validate action when point is on the
10855 ;; spaces right after the footnote label, in
10856 ;; order to be on par with behaviour on links.
10857 (skip-chars-forward " \t")
10859 (org-element-property :contents-begin context)))
10860 (if begin (< (point) begin)
10861 (= (org-element-property :post-affiliated context)
10862 (line-beginning-position)))))))
10863 (org-footnote-action))
10864 (t (user-error "No link found")))))
10865 (run-hook-with-args 'org-follow-link-hook)))
10867 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10868 "Offer links in the current entry and return the selected link.
10869 If there is only one link, return it.
10870 If NTH is an integer, return the NTH link found.
10871 If ZERO is a string, check also this string for a link, and if
10872 there is one, return it."
10873 (with-current-buffer buffer
10879 (in-emacs (if (integerp nth) nil nth))
10880 have-zero end links link c)
10881 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10882 (push (match-string 0 zero) links)
10883 (setq cnt (1- cnt) have-zero t))
10885 (org-back-to-heading t)
10886 (setq end (save-excursion (outline-next-heading) (point)))
10887 (while (re-search-forward org-any-link-re end t)
10888 (push (match-string 0) links))
10889 (setq links (org-uniquify (reverse links))))
10892 (message "No links"))
10893 ((equal (length links) 1)
10894 (setq link (car links)))
10895 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10896 (setq link (nth (if have-zero nth (1- nth)) links)))
10897 (t ; we have to select a link
10899 (save-window-excursion
10900 (delete-other-windows)
10901 (with-output-to-temp-buffer "*Select Link*"
10903 (if (not (string-match org-bracket-link-regexp l))
10904 (princ (format "[%c] %s\n" (incf cnt)
10905 (org-remove-angle-brackets l)))
10907 (princ (format "[%c] %s (%s)\n" (incf cnt)
10908 (match-string 3 l) (match-string 1 l)))
10909 (princ (format "[%c] %s\n" (incf cnt)
10910 (match-string 1 l))))))
10912 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10913 (message "Select link to open, RET to open all:")
10914 (setq c (read-char-exclusive))
10915 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10916 (when (equal c ?q) (user-error "Abort"))
10917 (if (equal c ?\C-m)
10919 (setq nth (- c ?0))
10920 (if have-zero (setq nth (1+ nth)))
10921 (unless (and (integerp nth) (>= (length links) nth))
10922 (user-error "Invalid link selection"))
10923 (setq link (nth (1- nth) links)))))
10924 (cons link end))))))
10926 ;; TODO: These functions are deprecated since `org-open-at-point'
10927 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10928 (defun org-open-file-with-system (path)
10929 "Open file at PATH using the system way of opening it."
10930 (org-open-file path 'system))
10931 (defun org-open-file-with-emacs (path)
10932 "Open file at PATH in Emacs."
10933 (org-open-file path 'emacs))
10938 (defvar org-create-file-search-functions nil
10939 "List of functions to construct the right search string for a file link.
10940 These functions are called in turn with point at the location to
10941 which the link should point.
10943 A function in the hook should first test if it would like to
10944 handle this file type, for example by checking the `major-mode'
10945 or the file extension. If it decides not to handle this file, it
10946 should just return nil to give other functions a chance. If it
10947 does handle the file, it must return the search string to be used
10948 when following the link. The search string will be part of the
10949 file link, given after a double colon, and `org-open-at-point'
10950 will automatically search for it. If special measures must be
10951 taken to make the search successful, another function should be
10952 added to the companion hook `org-execute-file-search-functions',
10955 A function in this hook may also use `setq' to set the variable
10956 `description' to provide a suggestion for the descriptive text to
10957 be used for this link when it gets inserted into an Org-mode
10958 buffer with \\[org-insert-link].")
10960 (defvar org-execute-file-search-functions nil
10961 "List of functions to execute a file search triggered by a link.
10963 Functions added to this hook must accept a single argument, the
10964 search string that was part of the file link, the part after the
10965 double colon. The function must first check if it would like to
10966 handle this search, for example by checking the `major-mode' or
10967 the file extension. If it decides not to handle this search, it
10968 should just return nil to give other functions a chance. If it
10969 does handle the search, it must return a non-nil value to keep
10970 other functions from trying.
10972 Each function can access the current prefix argument through the
10973 variable `current-prefix-arg'. Note that a single prefix is used
10974 to force opening a link in Emacs, so it may be good to only use a
10975 numeric or double prefix to guide the search function.
10977 In case this is needed, a function in this hook can also restore
10978 the window configuration before `org-open-at-point' was called using:
10980 (set-window-configuration org-window-config-before-follow-link)")
10982 (defun org-search-radio-target (target)
10983 "Search a radio target matching TARGET in current buffer.
10984 White spaces are not significant."
10985 (let ((re (format "<<<%s>>>"
10986 (mapconcat #'regexp-quote
10987 (org-split-string target "[ \t\n]+")
10988 "[ \t]+\\(?:\n[ \t]*\\)?")))
10990 (goto-char (point-min))
10991 (catch :radio-match
10992 (while (re-search-forward re nil t)
10994 (let ((object (org-element-context)))
10995 (when (eq (org-element-type object) 'radio-target)
10996 (goto-char (org-element-property :begin object))
10997 (org-show-context 'link-search)
10998 (throw :radio-match nil))))
11000 (user-error "No match for radio target: %s" target))))
11002 (defun org-link-search (s &optional avoid-pos stealth)
11003 "Search for a search string S.
11005 If S starts with \"#\", it triggers a custom ID search.
11007 If S is enclosed within parenthesis, it initiates a coderef
11010 If S is surrounded by forward slashes, it is interpreted as
11011 a regular expression. In Org mode files, this will create an
11012 `org-occur' sparse tree. In ordinary files, `occur' will be used
11013 to list matches. If the current buffer is in `dired-mode', grep
11014 will be used to search in all files.
11016 When AVOID-POS is given, ignore matches near that position.
11018 When optional argument STEALTH is non-nil, do not modify
11019 visibility around point, thus ignoring `org-show-context-detail'
11022 Search is case-insensitive and ignores white spaces. Return type
11023 of matched result, with is either `dedicated' or `fuzzy'."
11024 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11025 (let* ((case-fold-search t)
11027 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11028 (words (org-split-string s "[ \t\n]+"))
11029 (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
11030 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11033 ;; Check if there are any special search functions.
11034 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11035 ((eq (string-to-char s) ?#)
11036 ;; Look for a custom ID S if S starts with "#".
11037 (let* ((id (substring normalized 1))
11038 (match (org-find-property "CUSTOM_ID" id)))
11039 (if match (progn (goto-char match) (setf type 'dedicated))
11040 (error "No match for custom ID: %s" id))))
11041 ((string-match "\\`(\\(.*\\))\\'" normalized)
11042 ;; Look for coderef targets if S is enclosed within parenthesis.
11043 (let ((coderef (match-string-no-properties 1 normalized))
11044 (re (substring s-single-re 1 -1)))
11045 (goto-char (point-min))
11046 (catch :coderef-match
11047 (while (re-search-forward re nil t)
11048 (let ((element (org-element-at-point)))
11049 (when (and (memq (org-element-type element)
11050 '(example-block src-block))
11051 ;; Build proper regexp according to current
11052 ;; block's label format.
11055 (or (org-element-property :label-fmt element)
11056 org-coderef-label-format))))
11058 (beginning-of-line)
11059 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11060 (format label-fmt coderef))))))
11061 (setq type 'dedicated)
11062 (goto-char (match-beginning 1))
11063 (throw :coderef-match nil))))
11065 (error "No match for coderef: %s" coderef))))
11066 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11067 ;; Look for a regular expression.
11068 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11069 (match-string 1 s)))
11072 (let* ((starred (eq (string-to-char normalized) ?*))
11073 (headline-search (and (derived-mode-p 'org-mode)
11074 (or org-link-search-must-match-exact-headline
11077 ;; Look for targets, only if not in a headline search.
11078 ((and (not starred)
11079 (let ((target (format "<<%s>>" s-multi-re)))
11080 (catch :target-match
11081 (goto-char (point-min))
11082 (while (re-search-forward target nil t)
11084 (let ((context (org-element-context)))
11085 (when (eq (org-element-type context) 'target)
11086 (setq type 'dedicated)
11087 (goto-char (org-element-property :begin context))
11088 (throw :target-match t))))
11090 ;; Look for elements named after S, only if not in a headline
11092 ((and (not starred)
11093 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11095 (goto-char (point-min))
11096 (while (re-search-forward name nil t)
11097 (let ((element (org-element-at-point)))
11098 (when (equal (org-split-string
11099 (org-element-property :name element)
11102 (setq type 'dedicated)
11103 (beginning-of-line)
11104 (throw :name-match t))))
11106 ;; Regular text search. Prefer headlines in Org mode
11108 ((and (derived-mode-p 'org-mode)
11109 (let* ((wspace "[ \t]")
11110 (wspaceopt (concat wspace "*"))
11111 (cookie (concat "\\(?:"
11113 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11116 (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)"))
11118 org-outline-regexp-bol
11119 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11120 "\\(?:\\[#.\\][ \t]+\\)?"
11121 "\\(?:" org-comment-string "[ \t]+\\)?"
11123 (let ((title (mapconcat #'regexp-quote
11125 (concat sep "+"))))
11126 (if starred (substring title 1) title))
11128 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11130 (goto-char (point-min))
11131 (re-search-forward re nil t)))
11132 (goto-char (match-beginning 0))
11133 (setq type 'dedicated))
11134 ;; Offer to create non-existent headline depending on
11135 ;; `org-link-search-must-match-exact-headline'.
11136 ((and (derived-mode-p 'org-mode)
11137 (not org-link-search-inhibit-query)
11138 (eq org-link-search-must-match-exact-headline 'query-to-create)
11139 (yes-or-no-p "No match - create this as a new heading? "))
11140 (goto-char (point-max))
11141 (unless (bolp) (newline))
11142 (org-insert-heading nil t t)
11144 (beginning-of-line 0))
11145 ;; Only headlines are looked after. No need to process
11146 ;; further: throw an error.
11147 ((and (derived-mode-p 'org-mode)
11148 (or starred org-link-search-must-match-exact-headline))
11150 (error "No match for fuzzy expression: %s" normalized))
11151 ;; Regular text search.
11152 ((catch :fuzzy-match
11153 (goto-char (point-min))
11154 (while (re-search-forward s-multi-re nil t)
11155 ;; Skip match if it contains AVOID-POS or it is included
11156 ;; in a link with a description but outside the
11158 (unless (or (and avoid-pos
11159 (<= (match-beginning 0) avoid-pos)
11160 (> (match-end 0) avoid-pos))
11161 (and (save-match-data
11162 (org-in-regexp org-bracket-link-regexp))
11163 (match-beginning 3)
11164 (or (> (match-beginning 3) (point))
11165 (<= (match-end 3) (point)))
11166 (org-element-lineage
11167 (save-match-data (org-element-context))
11169 (goto-char (match-beginning 0))
11171 (throw :fuzzy-match t)))
11173 ;; All failed. Throw an error.
11174 (t (goto-char origin)
11175 (error "No match for fuzzy expression: %s" normalized))))))
11176 ;; Disclose surroundings of match, if appropriate.
11177 (when (and (derived-mode-p 'org-mode) (not stealth))
11178 (org-show-context 'link-search))
11181 (defun org-get-buffer-for-internal-link (buffer)
11182 "Return a buffer to be used for displaying the link target of internal links."
11184 ((not org-display-internal-link-with-indirect-buffer)
11186 ((string-match "(Clone)$" (buffer-name buffer))
11187 (message "Buffer is already a clone, not making another one")
11188 ;; we also do not modify visibility in this case
11190 (t ; make a new indirect buffer for displaying the link
11191 (let* ((bn (buffer-name buffer))
11192 (ibn (concat bn "(Clone)"))
11193 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11194 (with-current-buffer ib (org-overview))
11197 (defun org-do-occur (regexp &optional cleanup)
11198 "Call the Emacs command `occur'.
11199 If CLEANUP is non-nil, remove the printout of the regular expression
11200 in the *Occur* buffer. This is useful if the regex is long and not useful
11204 (let ((cwin (selected-window)) win beg end)
11205 (when (setq win (get-buffer-window "*Occur*"))
11206 (select-window win))
11207 (goto-char (point-min))
11208 (when (re-search-forward "match[a-z]+" nil t)
11209 (setq beg (match-end 0))
11210 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11211 (setq end (1- (match-beginning 0)))))
11212 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11213 (goto-char (point-min))
11214 (select-window cwin))))
11216 ;;; The mark ring for links jumps
11218 (defvar org-mark-ring nil
11219 "Mark ring for positions before jumps in Org-mode.")
11220 (defvar org-mark-ring-last-goto nil
11221 "Last position in the mark ring used to go back.")
11222 ;; Fill and close the ring
11223 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11224 (loop for i from 1 to org-mark-ring-length do
11225 (push (make-marker) org-mark-ring))
11226 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11229 (defun org-mark-ring-push (&optional pos buffer)
11230 "Put the current position or POS into the mark ring and rotate it."
11232 (setq pos (or pos (point)))
11233 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11234 (move-marker (car org-mark-ring)
11236 (or buffer (current-buffer)))
11238 (substitute-command-keys
11239 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11241 (defun org-mark-ring-goto (&optional n)
11242 "Jump to the previous position in the mark ring.
11243 With prefix arg N, jump back that many stored positions. When
11244 called several times in succession, walk through the entire ring.
11245 Org-mode commands jumping to a different position in the current file,
11246 or to another Org-mode file, automatically push the old position
11250 (if (eq last-command this-command)
11251 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11252 (setq p org-mark-ring))
11253 (setq org-mark-ring-last-goto p)
11255 (org-pop-to-buffer-same-window (marker-buffer m))
11257 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11259 (defun org-remove-angle-brackets (s)
11260 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11261 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11263 (defun org-add-angle-brackets (s)
11264 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11265 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11267 (defun org-remove-double-quotes (s)
11268 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11269 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11272 ;;; Following specific links
11274 (defun org-follow-timestamp-link ()
11275 "Open an agenda view for the time-stamp date/range at point."
11277 ((org-at-date-range-p t)
11278 (let ((org-agenda-start-on-weekday)
11279 (t1 (match-string 1))
11280 (t2 (match-string 2)) tt1 tt2)
11281 (setq tt1 (time-to-days (org-time-string-to-time t1))
11282 tt2 (time-to-days (org-time-string-to-time t2)))
11283 (let ((org-agenda-buffer-tmp-name
11284 (format "*Org Agenda(a:%s)"
11285 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11286 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11287 ((org-at-timestamp-p t)
11288 (let ((org-agenda-buffer-tmp-name
11289 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11290 (org-agenda-list nil (time-to-days (org-time-string-to-time
11291 (substring (match-string 1) 0 10)))
11293 (t (error "This should not happen"))))
11296 ;;; Following file links
11297 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11298 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11299 (declare-function mailcap-mime-info
11300 "mailcap" (string &optional request no-decode))
11301 (defvar org-wait nil)
11302 (defun org-open-file (path &optional in-emacs line search)
11303 "Open the file at PATH.
11304 First, this expands any special file name abbreviations. Then the
11305 configuration variable `org-file-apps' is checked if it contains an
11306 entry for this file type, and if yes, the corresponding command is launched.
11308 If no application is found, Emacs simply visits the file.
11310 With optional prefix argument IN-EMACS, Emacs will visit the file.
11311 With a double \\[universal-argument] \\[universal-argument] \
11312 prefix arg, Org tries to avoid opening in Emacs
11313 and to use an external application to visit the file.
11315 Optional LINE specifies a line to go to, optional SEARCH a string
11316 to search for. If LINE or SEARCH is given, the file will be
11317 opened in Emacs, unless an entry from org-file-apps that makes
11318 use of groups in a regexp matches.
11320 If you want to change the way frames are used when following a
11321 link, please customize `org-link-frame-setup'.
11323 If the file does not exist, an error is thrown."
11324 (let* ((file (if (equal path "")
11326 (substitute-in-file-name (expand-file-name path))))
11327 (file-apps (append org-file-apps (org-default-apps)))
11328 (apps (org-remove-if
11329 'org-file-apps-entry-match-against-dlink-p file-apps))
11330 (apps-dlink (org-remove-if-not
11331 'org-file-apps-entry-match-against-dlink-p file-apps))
11332 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11333 (dirp (if remp nil (file-directory-p file)))
11334 (file (if (and dirp org-open-directory-means-index-dot-org)
11335 (concat (file-name-as-directory file) "index.org")
11337 (a-m-a-p (assq 'auto-mode apps))
11338 (dfile (downcase file))
11339 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11340 (link (cond ((and (eq line nil)
11344 (concat file "::" (number-to-string line)))
11346 (concat file "::" search))))
11347 (dlink (downcase link))
11348 (old-buffer (current-buffer))
11350 (old-mode major-mode)
11351 ext cmd link-match-data)
11352 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11353 (setq ext (match-string 1 dfile))
11354 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11355 (setq ext (match-string 1 dfile))))
11357 ((member in-emacs '((16) system))
11358 (setq cmd (cdr (assoc 'system apps))))
11359 (in-emacs (setq cmd 'emacs))
11361 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11362 (and dirp (cdr (assoc 'directory apps)))
11363 ; first, try matching against apps-dlink
11364 ; if we get a match here, store the match data for later
11365 (let ((match (assoc-default dlink apps-dlink
11368 (progn (setq link-match-data (match-data))
11370 (progn (setq in-emacs (or in-emacs line search))
11371 nil))) ; if we have no match in apps-dlink,
11372 ; always open the file in emacs if line or search
11373 ; is given (for backwards compatibility)
11374 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11376 (cdr (assoc ext apps))
11377 (cdr (assoc t apps))))))
11378 (when (eq cmd 'system)
11379 (setq cmd (cdr (assoc 'system apps))))
11380 (when (eq cmd 'default)
11381 (setq cmd (cdr (assoc t apps))))
11382 (when (eq cmd 'mailcap)
11384 (mailcap-parse-mailcaps)
11385 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11386 (command (mailcap-mime-info mime-type)))
11387 (if (stringp command)
11389 (setq cmd 'emacs))))
11390 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11391 (not (file-exists-p file))
11392 (not org-open-non-existing-files))
11393 (user-error "No such file: %s" file))
11395 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11396 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11397 (while (string-match "['\"]%s['\"]" cmd)
11398 (setq cmd (replace-match "%s" t t cmd)))
11399 (while (string-match "%s" cmd)
11400 (setq cmd (replace-match
11402 (shell-quote-argument
11403 (convert-standard-filename file)))
11406 ;; Replace "%1", "%2" etc. in command with group matches from regex
11408 (let ((match-index 1)
11409 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11410 (set-match-data link-match-data)
11411 (while (<= match-index number-of-groups)
11412 (let ((regex (concat "%" (number-to-string match-index)))
11413 (replace-with (match-string match-index dlink)))
11414 (while (string-match regex cmd)
11415 (setq cmd (replace-match replace-with t t cmd))))
11416 (setq match-index (+ match-index 1)))))
11418 (save-window-excursion
11419 (message "Running %s...done" cmd)
11420 (start-process-shell-command cmd nil cmd)
11421 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11424 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11426 (if line (progn (org-goto-line line)
11427 (if (derived-mode-p 'org-mode)
11429 (if search (org-link-search search))))
11431 (let ((file (convert-standard-filename file)))
11433 (set-match-data link-match-data)
11435 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11436 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11437 (or (not (equal old-buffer (current-buffer)))
11438 (not (equal old-pos (point))))
11439 (org-mark-ring-push old-pos old-buffer))))
11441 (defun org-file-apps-entry-match-against-dlink-p (entry)
11442 "This function returns non-nil if `entry' uses a regular
11443 expression which should be matched against the whole link by
11446 It assumes that is the case when the entry uses a regular
11447 expression which has at least one grouping construct and the
11448 action is either a lisp form or a command string containing
11449 '%1', i.e. using at least one subexpression match as a
11451 (let ((selector (car entry))
11452 (action (cdr entry)))
11453 (if (stringp selector)
11454 (and (> (regexp-opt-depth selector) 0)
11455 (or (and (stringp action)
11456 (string-match "%[0-9]" action))
11460 (defun org-default-apps ()
11461 "Return the default applications for this operating system."
11463 ((eq system-type 'darwin)
11464 org-file-apps-defaults-macosx)
11465 ((eq system-type 'windows-nt)
11466 org-file-apps-defaults-windowsnt)
11467 (t org-file-apps-defaults-gnu)))
11469 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11470 "Convert extensions to regular expressions in the cars of LIST.
11471 Also, weed out any non-string entries, because the return value is used
11472 only for regexp matching.
11473 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11474 point to the symbol `emacs', indicating that the file should
11475 be opened in Emacs."
11478 (mapcar (lambda (x)
11479 (if (not (stringp (car x)))
11481 (if (string-match "\\W" (car x))
11483 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11486 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11488 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11489 (defun org-file-remote-p (file)
11490 "Test whether FILE specifies a location on a remote system.
11491 Return non-nil if the location is indeed remote.
11493 For example, the filename \"/user@host:/foo\" specifies a location
11494 on the system \"/user@host:\"."
11495 (cond ((fboundp 'file-remote-p)
11496 (file-remote-p file))
11497 ((fboundp 'tramp-handle-file-remote-p)
11498 (tramp-handle-file-remote-p file))
11499 ((and (boundp 'ange-ftp-name-format)
11500 (string-match (car ange-ftp-name-format) file))
11506 (defun org-get-org-file ()
11507 "Read a filename, with default directory `org-directory'."
11508 (let ((default (or org-default-notes-file remember-data-file)))
11509 (read-file-name (format "File name [%s]: " default)
11510 (file-name-as-directory org-directory)
11513 (defun org-notes-order-reversed-p ()
11514 "Check if the current file should receive notes in reversed order."
11516 ((not org-reverse-note-order) nil)
11517 ((eq t org-reverse-note-order) t)
11518 ((not (listp org-reverse-note-order)) nil)
11520 (let ((all org-reverse-note-order)
11522 (while (setq entry (pop all))
11523 (if (string-match (car entry) buffer-file-name)
11524 (throw 'exit (cdr entry))))
11527 (defvar org-refile-target-table nil
11528 "The list of refile targets, created by `org-refile'.")
11530 (defvar org-agenda-new-buffers nil
11531 "Buffers created to visit agenda files.")
11533 (defvar org-refile-cache nil
11534 "Cache for refile targets.")
11536 (defvar org-refile-markers nil
11537 "All the markers used for caching refile locations.")
11539 (defun org-refile-marker (pos)
11540 "Get a new refile marker, but only if caching is in use."
11541 (if (not org-refile-use-cache)
11543 (let ((m (make-marker)))
11544 (move-marker m pos)
11545 (push m org-refile-markers)
11548 (defun org-refile-cache-clear ()
11549 "Clear the refile cache and disable all the markers."
11550 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11551 (setq org-refile-markers nil)
11552 (setq org-refile-cache nil)
11553 (message "Refile cache has been cleared"))
11555 (defun org-refile-cache-check-set (set)
11556 "Check if all the markers in the cache still have live buffers."
11559 (while (and set (setq marker (nth 3 (pop set))))
11560 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11561 (when (and marker (null (marker-buffer marker)))
11562 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11564 (throw 'exit nil)))
11567 (defun org-refile-cache-put (set &rest identifiers)
11568 "Push the refile targets SET into the cache, under IDENTIFIERS."
11569 (let* ((key (sha1 (prin1-to-string identifiers)))
11570 (entry (assoc key org-refile-cache)))
11573 (push (cons key set) org-refile-cache))))
11575 (defun org-refile-cache-get (&rest identifiers)
11576 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11578 ((not org-refile-cache) nil)
11579 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11581 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11582 org-refile-cache))))
11583 (and set (org-refile-cache-check-set set) set)))))
11585 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11586 "Produce a table with refile targets."
11587 (let ((case-fold-search nil)
11588 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11589 (entries (or org-refile-targets '((nil . (:level . 1)))))
11590 targets tgs txt re files f desc descre fast-path-p level pos0)
11591 (message "Getting targets...")
11592 (with-current-buffer (or default-buffer (current-buffer))
11593 (while (setq entry (pop entries))
11594 (setq files (car entry) desc (cdr entry))
11595 (setq fast-path-p nil)
11597 ((null files) (setq files (list (current-buffer))))
11598 ((eq files 'org-agenda-files)
11599 (setq files (org-agenda-files 'unrestricted)))
11600 ((and (symbolp files) (fboundp files))
11601 (setq files (funcall files)))
11602 ((and (symbolp files) (boundp files))
11603 (setq files (symbol-value files))))
11604 (if (stringp files) (setq files (list files)))
11606 ((eq (car desc) :tag)
11607 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11608 ((eq (car desc) :todo)
11609 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11610 ((eq (car desc) :regexp)
11611 (setq descre (cdr desc)))
11612 ((eq (car desc) :level)
11613 (setq descre (concat "^\\*\\{" (number-to-string
11614 (if org-odd-levels-only
11615 (1- (* 2 (cdr desc)))
11618 ((eq (car desc) :maxlevel)
11619 (setq fast-path-p t)
11620 (setq descre (concat "^\\*\\{1," (number-to-string
11621 (if org-odd-levels-only
11622 (1- (* 2 (cdr desc)))
11625 (t (error "Bad refiling target description %s" desc)))
11626 (while (setq f (pop files))
11627 (with-current-buffer
11628 (if (bufferp f) f (org-get-agenda-file-buffer f))
11630 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11632 (if (bufferp f) (setq f (buffer-file-name
11633 (buffer-base-buffer f))))
11634 (setq f (and f (expand-file-name f)))
11635 (if (eq org-refile-use-outline-path 'file)
11636 (push (list (file-name-nondirectory f) f nil nil) tgs))
11640 (goto-char (point-min))
11641 (while (re-search-forward descre nil t)
11642 (goto-char (setq pos0 (point-at-bol)))
11644 (when org-refile-target-verify-function
11646 (or (funcall org-refile-target-verify-function)
11648 (when (and (looking-at org-complex-heading-regexp)
11649 (not (member (match-string 4) excluded-entries))
11651 (setq level (org-reduced-level
11652 (- (match-end 1) (match-beginning 1)))
11653 txt (org-link-display-format (match-string 4))
11654 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11655 re (format org-complex-heading-regexp-format
11656 (regexp-quote (match-string 4))))
11657 (when org-refile-use-outline-path
11658 (setq txt (mapconcat
11661 (if (eq org-refile-use-outline-path
11663 (list (file-name-nondirectory
11665 (buffer-base-buffer))))
11666 (if (eq org-refile-use-outline-path
11668 (list (buffer-file-name
11669 (buffer-base-buffer)))))
11670 (org-get-outline-path fast-path-p
11674 (push (list txt f re (org-refile-marker (point)))
11676 (when (= (point) pos0)
11677 ;; verification function has not moved point
11678 (goto-char (point-at-eol))))))))
11679 (when org-refile-use-cache
11680 (org-refile-cache-put tgs (buffer-file-name) descre))
11681 (setq targets (append tgs targets))))))
11682 (message "Getting targets...done")
11683 (nreverse targets)))
11685 (defun org-protect-slash (s)
11686 (while (string-match "/" s)
11687 (setq s (replace-match "\\" t t s)))
11690 (defvar org-olpa (make-vector 20 nil))
11692 (defun org-get-outline-path (&optional fastp level heading)
11693 "Return the outline path to the current entry, as a list.
11695 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11696 routine which makes outline path derivations for an entire file,
11697 avoiding backtracing. Refile target collection makes use of that."
11701 (error "Outline path failure, more than 19 levels"))
11702 (loop for i from level upto 19 do
11703 (aset org-olpa i nil))
11705 (delq nil (append org-olpa nil))
11706 (aset org-olpa level heading)))
11707 (let (rtn case-fold-search)
11711 (while (org-up-heading-safe)
11712 (when (looking-at org-complex-heading-regexp)
11714 (replace-regexp-in-string
11715 ;; Remove statistical/checkboxes cookies
11716 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11717 (org-match-string-no-properties 4)))
11721 (defun org-format-outline-path (path &optional width prefix separator)
11722 "Format the outline path PATH for display.
11723 WIDTH is the maximum number of characters that is available.
11724 PREFIX is a prefix to be included in the returned string,
11725 such as the file name.
11726 SEPARATOR is inserted between the different parts of the path,
11727 the default is \"/\"."
11728 (setq width (or width 79))
11729 (if prefix (setq width (- width (length prefix))))
11732 (let* ((nsteps (length path))
11733 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11734 (maxwidth (if (<= total-width width)
11735 10000 ;; everything fits
11736 ;; we need to shorten the level headings
11737 (/ (- width nsteps) nsteps)))
11738 (org-odd-levels-only nil)
11740 (total (1+ (length prefix))))
11741 (setq maxwidth (max maxwidth 10))
11743 (if prefix (or separator "/"))
11747 (if (and (= n nsteps) (< maxwidth 10000))
11748 (setq maxwidth (- total-width total)))
11749 (if (< (length h) maxwidth)
11750 (progn (setq total (+ total (length h) 1)) h)
11751 (setq h (substring h 0 (- maxwidth 2))
11752 total (+ total maxwidth 1))
11753 (if (string-match "[ \t]+\\'" h)
11754 (setq h (substring h 0 (match-beginning 0))))
11755 (setq h (concat h "..")))
11756 (org-add-props h nil 'face
11757 (nth (% (1- n) org-n-level-faces)
11760 path (or separator "/"))))))
11762 (defun org-display-outline-path (&optional file current separator just-return-string)
11763 "Display the current outline path in the echo area.
11765 If FILE is non-nil, prepend the output with the file name.
11766 If CURRENT is non-nil, append the current heading to the output.
11767 SEPARATOR is passed through to `org-format-outline-path'. It separates
11768 the different parts of the path and defaults to \"/\".
11769 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11771 (let* (case-fold-search
11772 (bfn (buffer-file-name (buffer-base-buffer)))
11773 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11775 (if current (setq path (append path
11777 (org-back-to-heading t)
11778 (if (looking-at org-complex-heading-regexp)
11779 (list (match-string 4)))))))
11781 (org-format-outline-path
11784 (and file bfn (concat (file-name-nondirectory bfn) separator))
11786 (if just-return-string
11787 (org-no-properties res)
11788 (org-unlogged-message "%s" res))))
11790 (defvar org-refile-history nil
11791 "History for refiling operations.")
11793 (defvar org-after-refile-insert-hook nil
11794 "Hook run after `org-refile' has inserted its stuff at the new location.
11795 Note that this is still *before* the stuff will be removed from
11796 the *old* location.")
11798 (defvar org-capture-last-stored-marker)
11799 (defvar org-refile-keep nil
11800 "Non-nil means `org-refile' will copy instead of refile.")
11803 "Like `org-refile', but copy."
11805 (let ((org-refile-keep t))
11806 (funcall 'org-refile nil nil nil "Copy")))
11808 (defun org-refile (&optional arg default-buffer rfloc msg)
11809 "Move the entry or entries at point to another heading.
11810 The list of target headings is compiled using the information in
11811 `org-refile-targets', which see.
11813 At the target location, the entry is filed as a subitem of the
11814 target heading. Depending on `org-reverse-note-order', the new
11815 subitem will either be the first or the last subitem.
11817 If there is an active region, all entries in that region will be
11818 refiled. However, the region must fulfill the requirement that
11819 the first heading sets the top-level of the moved text.
11821 With prefix arg ARG, the command will only visit the target
11822 location and not actually move anything.
11824 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11825 refiling operation has put the subtree.
11827 With a numeric prefix argument of `2', refile to the running clock.
11829 With a numeric prefix argument of `3', emulate `org-refile-keep'
11830 being set to t and copy to the target location, don't move it.
11831 Beware that keeping refiled entries may result in duplicated ID
11834 RFLOC can be a refile location obtained in a different way.
11836 MSG is a string to replace \"Refile\" in the default prompt with
11837 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11839 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11841 If you are using target caching (see `org-refile-use-cache'), you
11842 have to clear the target cache in order to find new targets.
11843 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11844 prefix argument (`C-u C-u C-u C-c C-w')."
11846 (if (member arg '(0 (64)))
11847 (org-refile-cache-clear)
11848 (let* ((actionmsg (cond (msg msg)
11849 ((equal arg 3) "Refile (and keep)")
11851 (cbuf (current-buffer))
11852 (regionp (org-region-active-p))
11853 (region-start (and regionp (region-beginning)))
11854 (region-end (and regionp (region-end)))
11855 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11856 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11857 pos it nbuf file re level reversed)
11858 (setq last-command nil)
11860 (goto-char region-start)
11861 (or (bolp) (goto-char (point-at-bol)))
11862 (setq region-start (point))
11863 (unless (or (org-kill-is-subtree-p
11864 (buffer-substring region-start region-end))
11865 (prog1 org-refile-active-region-within-subtree
11866 (let ((s (point-at-eol)))
11867 (org-toggle-heading)
11868 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11869 (user-error "The region is not a (sequence of) subtree(s)")))
11870 (if (equal arg '(16))
11871 (org-refile-goto-last-stored)
11874 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11876 (setq it (list (or org-clock-heading "running clock")
11878 (marker-buffer org-clock-hd-marker))
11880 (marker-position org-clock-hd-marker)))
11883 (let (heading-text)
11885 (unless (and arg (listp arg))
11886 (org-back-to-heading t)
11888 (replace-regexp-in-string
11889 org-bracket-link-regexp
11891 (nth 4 (org-heading-components)))))
11892 (org-refile-get-location
11893 (cond ((and arg (listp arg)) "Goto")
11894 (regionp (concat actionmsg " region to"))
11895 (t (concat actionmsg " subtree \""
11896 heading-text "\" to")))
11898 (and (not (equal '(4) arg))
11899 org-refile-allow-creating-parent-nodes)
11901 (setq file (nth 1 it)
11906 (equal (buffer-file-name) file)
11908 (and (>= pos region-start)
11909 (<= pos region-end))
11910 (and (>= pos (point))
11911 (< pos (save-excursion
11912 (org-end-of-subtree t t))))))
11913 (error "Cannot refile to position inside the tree or region"))
11914 (setq nbuf (or (find-buffer-visiting file)
11915 (find-file-noselect file)))
11916 (if (and arg (not (equal arg 3)))
11918 (org-pop-to-buffer-same-window nbuf)
11920 (org-show-context 'org-goto))
11923 (org-kill-new (buffer-substring region-start region-end))
11924 (org-save-markers-in-region region-start region-end))
11925 (org-copy-subtree 1 nil t))
11926 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11927 (find-file-noselect file)))
11928 (setq reversed (org-notes-order-reversed-p))
11935 (looking-at org-outline-regexp)
11936 (setq level (org-get-valid-level (funcall outline-level) 1))
11939 (or (outline-next-heading) (point-max))
11940 (or (save-excursion (org-get-next-sibling))
11941 (org-end-of-subtree t t)
11945 (goto-char (point-max))
11946 (goto-char (point-min))
11947 (or (outline-next-heading) (goto-char (point-max)))))
11948 (if (not (bolp)) (newline))
11949 (org-paste-subtree level nil nil t)
11950 (when org-log-refile
11951 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11952 (unless (eq org-log-refile 'note)
11953 (save-excursion (org-add-log-note))))
11954 (and org-auto-align-tags
11955 (let ((org-loop-over-headlines-in-active-region nil))
11956 (org-set-tags nil t)))
11957 (let ((bookmark-name (plist-get org-bookmark-names-plist
11959 (when bookmark-name
11960 (with-demoted-errors
11961 (bookmark-set bookmark-name))))
11962 ;; If we are refiling for capture, make sure that the
11963 ;; last-capture pointers point here
11964 (when (org-bound-and-true-p org-refile-for-capture)
11965 (let ((bookmark-name (plist-get org-bookmark-names-plist
11966 :last-capture-marker)))
11967 (when bookmark-name
11968 (with-demoted-errors
11969 (bookmark-set bookmark-name))))
11970 (move-marker org-capture-last-stored-marker (point)))
11971 (if (fboundp 'deactivate-mark) (deactivate-mark))
11972 (run-hooks 'org-after-refile-insert-hook))))
11973 (unless org-refile-keep
11975 (delete-region (point) (+ (point) (- region-end region-start)))
11977 (and (org-back-to-heading t) (point))
11978 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11979 (when (featurep 'org-inlinetask)
11980 (org-inlinetask-remove-END-maybe))
11981 (setq org-markers-to-move nil)
11982 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11984 (defun org-refile-goto-last-stored ()
11985 "Go to the location where the last refile was stored."
11987 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11988 (message "This is the location of the last refile"))
11990 (defun org-refile--get-location (refloc tbl)
11991 "When user refile to REFLOC, find the associated target in TBL.
11992 Also check `org-refile-target-table'."
11996 (lambda (r) (or (assoc r tbl)
11997 (assoc r org-refile-target-table)))
11998 (list (replace-regexp-in-string "/$" "" refloc)
11999 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12001 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
12003 "Prompt the user for a refile location, using PROMPT.
12004 PROMPT should not be suffixed with a colon and a space, because
12005 this function appends the default value from
12006 `org-refile-history' automatically, if that is not empty.
12007 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12008 this is used for the GOTO interface."
12009 (let ((org-refile-targets org-refile-targets)
12010 (org-refile-use-outline-path org-refile-use-outline-path)
12012 (when (and (derived-mode-p 'org-mode)
12013 (not org-refile-use-cache)
12017 (setq excluded-entries
12018 (append excluded-entries (list (org-get-heading t t)))))))
12019 (setq org-refile-target-table
12020 (org-refile-get-targets default-buffer excluded-entries)))
12021 (unless org-refile-target-table
12022 (user-error "No refile targets"))
12023 (let* ((cbuf (current-buffer))
12024 (partial-completion-mode nil)
12025 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12026 (cfunc (if (and org-refile-use-outline-path
12027 org-outline-path-complete-in-steps)
12028 'org-olpath-completing-read
12029 'org-icompleting-read))
12030 (extra (if org-refile-use-outline-path "/" ""))
12031 (cbnex (concat (buffer-name) extra))
12032 (filename (and cfn (expand-file-name cfn)))
12035 (if (and (not (member org-refile-use-outline-path
12036 '(file full-file-path)))
12037 (not (equal filename (nth 1 x))))
12038 (cons (concat (car x) extra " ("
12039 (file-name-nondirectory (nth 1 x)) ")")
12041 (cons (concat (car x) extra) (cdr x))))
12042 org-refile-target-table))
12043 (completion-ignore-case t)
12045 (prompt (concat prompt
12046 (or (and (car org-refile-history)
12047 (concat " (default " (car org-refile-history) ")"))
12048 (and (assoc cbnex tbl) (setq cdef cbnex)
12049 (concat " (default " cbnex ")"))) ": "))
12050 pa answ parent-target child parent old-hist)
12051 (setq old-hist org-refile-history)
12052 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12053 nil 'org-refile-history (or cdef (car org-refile-history))))
12054 (if (setq pa (org-refile--get-location answ tbl))
12056 (org-refile-check-position pa)
12057 (when (or (not org-refile-history)
12058 (not (eq old-hist org-refile-history))
12059 (not (equal (car pa) (car org-refile-history))))
12060 (setq org-refile-history
12061 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12063 (cdr org-refile-history))))
12064 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12065 (pop org-refile-history)))
12067 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12069 (setq parent (match-string 1 answ)
12070 child (match-string 2 answ))
12071 (setq parent-target (org-refile--get-location parent tbl))
12072 (when (and parent-target
12073 (or (eq new-nodes t)
12074 (and (eq new-nodes 'confirm)
12075 (y-or-n-p (format "Create new node \"%s\"? "
12077 (org-refile-new-child parent-target child)))
12078 (user-error "Invalid target location")))))
12080 (declare-function org-string-nw-p "org-macs" (s))
12081 (defun org-refile-check-position (refile-pointer)
12082 "Check if the refile pointer matches the headline to which it points."
12083 (let* ((file (nth 1 refile-pointer))
12084 (re (nth 2 refile-pointer))
12085 (pos (nth 3 refile-pointer))
12087 (if (and (not (markerp pos)) (not file))
12088 (user-error "Please indicate a target file in the refile path")
12089 (when (org-string-nw-p re)
12090 (setq buffer (if (markerp pos)
12091 (marker-buffer pos)
12092 (or (find-buffer-visiting file)
12093 (find-file-noselect file))))
12094 (with-current-buffer buffer
12099 (beginning-of-line 1)
12100 (unless (org-looking-at-p re)
12101 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12103 (defun org-refile-new-child (parent-target child)
12104 "Use refile target PARENT-TARGET to add new CHILD below it."
12105 (unless parent-target
12106 (error "Cannot find parent for new node"))
12107 (let ((file (nth 1 parent-target))
12108 (pos (nth 3 parent-target))
12110 (with-current-buffer (or (find-buffer-visiting file)
12111 (find-file-noselect file))
12117 (goto-char (point-max))
12118 (if (not (bolp)) (newline)))
12119 (when (looking-at org-outline-regexp)
12120 (setq level (funcall outline-level))
12121 (org-end-of-subtree t t))
12122 (org-back-over-empty-lines)
12123 (insert "\n" (make-string
12124 (if pos (org-get-valid-level level 1) 1) ?*)
12126 (beginning-of-line 0)
12127 (list (concat (car parent-target) "/" child) file "" (point)))))))
12129 (defun org-olpath-completing-read (prompt collection &rest args)
12130 "Read an outline path like a file name."
12131 (let ((thetable collection)
12132 (org-completion-use-ido nil) ; does not work with ido.
12133 (org-completion-use-iswitchb nil)) ; or iswitchb
12134 (apply #'org-icompleting-read
12136 (lambda (string predicate &optional flag)
12138 ((eq flag nil) (try-completion string thetable))
12140 (let ((l (length string)))
12141 (mapcar (lambda (x)
12142 (let ((r (substring x l))
12143 (f (if (string-match " ([^)]*)$" x)
12146 (if (string-match "/" r)
12147 (concat string (substring r 0 (match-end 0)) f)
12149 (all-completions string thetable predicate))))
12151 ((eq flag 'lambda) (assoc string thetable))))
12154 ;;;; Dynamic blocks
12156 (defun org-find-dblock (name)
12157 "Find the first dynamic block with name NAME in the buffer.
12158 If not found, stay at current position and return nil."
12159 (let ((case-fold-search t) pos)
12161 (goto-char (point-min))
12162 (setq pos (and (re-search-forward
12163 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12164 (match-beginning 0))))
12165 (if pos (goto-char pos))
12168 (defun org-create-dblock (plist)
12169 "Create a dynamic block section, with parameters taken from PLIST.
12170 PLIST must contain a :name entry which is used as the name of the block."
12171 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12174 (let ((col (current-column))
12175 (name (plist-get plist :name)))
12176 (insert "#+BEGIN: " name)
12178 (if (eq (car plist) :name)
12179 (setq plist (cddr plist))
12180 (insert " " (prin1-to-string (pop plist)))))
12181 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12182 (beginning-of-line -2)))
12184 (defun org-prepare-dblock ()
12185 "Prepare dynamic block for refresh.
12186 This empties the block, puts the cursor at the insert position and returns
12187 the property list including an extra property :name with the block name."
12188 (unless (looking-at org-dblock-start-re)
12189 (user-error "Not at a dynamic block"))
12190 (let* ((begdel (1+ (match-end 0)))
12191 (name (org-no-properties (match-string 1)))
12192 (params (append (list :name name)
12193 (read (concat "(" (match-string 3) ")")))))
12195 (beginning-of-line 1)
12196 (skip-chars-forward " \t")
12197 (setq params (plist-put params :indentation-column (current-column))))
12198 (unless (re-search-forward org-dblock-end-re nil t)
12199 (error "Dynamic block not terminated"))
12202 (list :content (buffer-substring
12203 begdel (match-beginning 0)))))
12204 (delete-region begdel (match-beginning 0))
12209 (defun org-map-dblocks (&optional command)
12210 "Apply COMMAND to all dynamic blocks in the current buffer.
12211 If COMMAND is not given, use `org-update-dblock'."
12212 (let ((cmd (or command 'org-update-dblock)))
12214 (goto-char (point-min))
12215 (while (re-search-forward org-dblock-start-re nil t)
12216 (goto-char (match-beginning 0))
12218 (condition-case nil
12220 (error (message "Error during update of dynamic block"))))
12221 (unless (re-search-forward org-dblock-end-re nil t)
12222 (error "Dynamic block not terminated"))))))
12224 (defun org-dblock-update (&optional arg)
12225 "User command for updating dynamic blocks.
12226 Update the dynamic block at point. With prefix ARG, update all dynamic
12227 blocks in the buffer."
12230 (org-update-all-dblocks)
12231 (or (looking-at org-dblock-start-re)
12232 (org-beginning-of-dblock))
12233 (org-update-dblock)))
12235 (defun org-update-dblock ()
12236 "Update the dynamic block at point.
12237 This means to empty the block, parse for parameters and then call
12238 the correct writing function."
12241 (let* ((win (selected-window))
12243 (line (org-current-line))
12244 (params (org-prepare-dblock))
12245 (name (plist-get params :name))
12246 (indent (plist-get params :indentation-column))
12247 (cmd (intern (concat "org-dblock-write:" name))))
12248 (message "Updating dynamic block `%s' at line %d..." name line)
12249 (funcall cmd params)
12250 (message "Updating dynamic block `%s' at line %d...done" name line)
12252 (when (and indent (> indent 0))
12253 (setq indent (make-string indent ?\ ))
12255 (select-window win)
12256 (org-beginning-of-dblock)
12258 (while (not (looking-at org-dblock-end-re))
12260 (beginning-of-line 2))
12261 (when (looking-at org-dblock-end-re)
12262 (and (looking-at "[ \t]+")
12263 (replace-match ""))
12264 (insert indent)))))))
12266 (defun org-beginning-of-dblock ()
12267 "Find the beginning of the dynamic block at point.
12268 Error if there is no such block at point."
12269 (let ((pos (point))
12272 (if (and (re-search-backward org-dblock-start-re nil t)
12273 (setq beg (match-beginning 0))
12274 (re-search-forward org-dblock-end-re nil t)
12275 (> (match-end 0) pos))
12278 (error "Not in a dynamic block"))))
12280 (defun org-update-all-dblocks ()
12281 "Update all dynamic blocks in the buffer.
12282 This function can be used in a hook."
12284 (when (derived-mode-p 'org-mode)
12285 (org-map-dblocks 'org-update-dblock)))
12290 (declare-function org-export-backend-name "org-export" (cl-x))
12291 (declare-function org-export-backend-options "org-export" (cl-x))
12292 (defun org-get-export-keywords ()
12293 "Return a list of all currently understood export keywords.
12294 Export keywords include options, block names, attributes and
12295 keywords relative to each registered export back-end."
12298 (org-bound-and-true-p org-export-registered-backends)
12299 (delq nil keywords))
12300 ;; Back-end name (for keywords, like #+LATEX:)
12301 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12302 (dolist (option-entry (org-export-backend-options backend))
12303 ;; Back-end options.
12304 (push (nth 1 option-entry) keywords)))))
12306 (defconst org-options-keywords
12307 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12308 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12309 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12310 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12311 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12313 (defcustom org-structure-template-alist
12314 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12315 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12316 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12317 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12318 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12319 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12320 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12322 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12324 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12327 ("I" "#+INCLUDE: %file ?"))
12328 "Structure completion elements.
12329 This is a list of abbreviation keys and values. The value gets inserted
12330 if you type `<' followed by the key and then press the completion key,
12331 usually `TAB'. %file will be replaced by a file name after prompting
12332 for the file using completion. The cursor will be placed at the position
12333 of the `?' in the template.
12334 There are two templates for each key, the first uses the original Org syntax,
12335 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12336 the default when the /org-mtags.el/ module has been loaded. See also the
12337 variable `org-mtags-prefer-muse-templates'."
12338 :group 'org-completion
12341 (string :tag "Key")
12342 (string :tag "Template")))
12344 :package-version '(Org . "8.3"))
12346 (defun org-try-structure-completion ()
12347 "Try to complete a structure template before point.
12348 This looks for strings like \"<e\" on an otherwise empty line and
12350 (let ((l (buffer-substring (point-at-bol) (point)))
12352 (when (and (looking-at "[ \t]*$")
12353 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12354 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12355 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12356 (match-beginning 1)) a)
12359 (defun org-complete-expand-structure-template (start cell)
12360 "Expand a structure template."
12361 (let ((rpl (nth 1 cell))
12363 (delete-region start (point))
12364 (when (string-match "\\`[ \t]*#\\+" rpl)
12367 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12368 (setq ind (buffer-substring (point-at-bol) (point))))
12370 (setq start (point))
12371 (if (string-match "%file" rpl)
12372 (setq rpl (replace-match
12376 (abbreviate-file-name (read-file-name "Include file: ")))
12379 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12380 (concat "\n" ind)))
12382 (if (re-search-backward "\\?" start t) (delete-char 1))))
12384 ;;;; TODO, DEADLINE, Comments
12386 (defun org-toggle-comment ()
12387 "Change the COMMENT state of an entry."
12390 (org-back-to-heading)
12391 (looking-at org-complex-heading-regexp)
12392 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12393 (skip-chars-forward " \t")
12394 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12395 (if (org-in-commented-heading-p t)
12396 (delete-region (point)
12397 (progn (search-forward " " (line-end-position) 'move)
12398 (skip-chars-forward " \t")
12400 (insert org-comment-string)
12401 (unless (eolp) (insert " ")))))
12403 (defvar org-last-todo-state-is-todo nil
12404 "This is non-nil when the last TODO state change led to a TODO state.
12405 If the last change removed the TODO tag or switched to DONE, then
12408 (defvar org-setting-tags nil) ; dynamically skipped
12410 (defvar org-todo-setup-filter-hook nil
12411 "Hook for functions that pre-filter todo specs.
12412 Each function takes a todo spec and returns either nil or the spec
12413 transformed into canonical form." )
12415 (defvar org-todo-get-default-hook nil
12416 "Hook for functions that get a default item for todo.
12417 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12418 nil or a string to be used for the todo mark." )
12420 (defvar org-agenda-headline-snapshot-before-repeat)
12422 (defun org-current-effective-time ()
12423 "Return current time adjusted for `org-extend-today-until' variable."
12424 (let* ((ct (org-current-time))
12425 (dct (decode-time ct))
12428 (org-use-last-clock-out-time-as-effective-time
12429 (or (org-clock-get-last-clock-out-time) ct))
12430 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12431 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12435 (defun org-todo-yesterday (&optional arg)
12436 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12438 (if (eq major-mode 'org-agenda-mode)
12439 (apply 'org-agenda-todo-yesterday arg)
12440 (let* ((org-use-effective-time t)
12441 (hour (third (decode-time
12442 (org-current-time))))
12443 (org-extend-today-until (1+ hour)))
12446 (defvar org-block-entry-blocking ""
12447 "First entry preventing the TODO state change.")
12449 (defun org-cancel-repeater ()
12450 "Cancel a repeater by setting its numeric value to zero."
12453 (org-back-to-heading t)
12454 (let ((bound1 (point))
12455 (bound0 (save-excursion (outline-next-heading) (point))))
12456 (when (re-search-forward
12457 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12458 org-deadline-time-regexp "\\)\\|\\("
12459 org-ts-regexp "\\)")
12461 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12462 (replace-match "0" t nil nil 1))))))
12464 (defun org-todo (&optional arg)
12465 "Change the TODO state of an item.
12466 The state of an item is given by a keyword at the start of the heading,
12468 *** TODO Write paper
12471 The different keywords are specified in the variable `org-todo-keywords'.
12472 By default the available states are \"TODO\" and \"DONE\".
12473 So for this example: when the item starts with TODO, it is changed to DONE.
12474 When it starts with DONE, the DONE is removed. And when neither TODO nor
12475 DONE are present, add TODO at the beginning of the heading.
12477 With \\[universal-argument] prefix arg, use completion to determine the new \
12479 With numeric prefix arg, switch to that state.
12480 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12481 keywords (nextset).
12482 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12483 With a numeric prefix arg of 0, inhibit note taking for the change.
12484 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12486 When called through ELisp, arg is also interpreted in the following way:
12487 'none -> empty state
12488 \"\"(empty string) -> switch to empty state
12489 'done -> switch to DONE
12490 'nextset -> switch to the next set of keywords
12491 'previousset -> switch to the previous set of keywords
12492 \"WAITING\" -> switch to the specified keyword, but only if it
12493 really is a member of `org-todo-keywords'."
12495 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12496 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12497 'region-start-level 'region))
12498 org-loop-over-headlines-in-active-region)
12501 org-loop-over-headlines-in-active-region
12502 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12503 (if (equal arg '(16)) (setq arg 'nextset))
12504 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12505 (let ((org-blocker-hook org-blocker-hook)
12508 (when (equal arg '(64))
12509 (setq arg nil org-blocker-hook nil))
12510 (when (and org-blocker-hook
12511 (or org-inhibit-blocking
12512 (org-entry-get nil "NOBLOCKING")))
12513 (setq org-blocker-hook nil))
12516 (org-back-to-heading t)
12517 (when (org-in-commented-heading-p t)
12518 (org-toggle-comment)
12520 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12521 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12522 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12523 (let* ((match-data (match-data))
12524 (startpos (point-at-bol))
12525 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12526 (org-log-done org-log-done)
12527 (org-log-repeat org-log-repeat)
12528 (org-todo-log-states org-todo-log-states)
12529 (org-inhibit-logging
12531 (progn (setq arg nil) 'note) org-inhibit-logging))
12532 (this (match-string 1))
12533 (hl-pos (match-beginning 0))
12534 (head (org-get-todo-sequence-head this))
12535 (ass (assoc head org-todo-kwd-alist))
12536 (interpret (nth 1 ass))
12537 (done-word (nth 3 ass))
12538 (final-done-word (nth 4 ass))
12539 (org-last-state (or this ""))
12540 (completion-ignore-case t)
12541 (member (member this org-todo-keywords-1))
12542 (tail (cdr member))
12544 ((and org-todo-key-trigger
12545 (or (and (equal arg '(4))
12546 (eq org-use-fast-todo-selection 'prefix))
12547 (and (not arg) org-use-fast-todo-selection
12548 (not (eq org-use-fast-todo-selection
12550 ;; Use fast selection
12551 (org-fast-todo-selection))
12552 ((and (equal arg '(4))
12553 (or (not org-use-fast-todo-selection)
12554 (not org-todo-key-trigger)))
12555 ;; Read a state with completion
12556 (org-icompleting-read
12557 "State: " (mapcar 'list org-todo-keywords-1)
12561 (if tail (car tail) nil)
12562 (car org-todo-keywords-1)))
12564 (if (equal member org-todo-keywords-1)
12567 (nth (- (length org-todo-keywords-1)
12569 org-todo-keywords-1)
12570 (org-last org-todo-keywords-1))))
12571 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12572 (setq arg nil))) ; hack to fall back to cycling
12574 ;; user or caller requests a specific state
12576 ((equal arg "") nil)
12577 ((eq arg 'none) nil)
12578 ((eq arg 'done) (or done-word (car org-done-keywords)))
12580 (or (car (cdr (member head org-todo-heads)))
12581 (car org-todo-heads)))
12582 ((eq arg 'previousset)
12583 (let ((org-todo-heads (reverse org-todo-heads)))
12584 (or (car (cdr (member head org-todo-heads)))
12585 (car org-todo-heads))))
12586 ((car (member arg org-todo-keywords-1)))
12588 (user-error "State `%s' not valid in this file" arg))
12589 ((nth (1- (prefix-numeric-value arg))
12590 org-todo-keywords-1))))
12591 ((null member) (or head (car org-todo-keywords-1)))
12592 ((equal this final-done-word) nil) ;; -> make empty
12593 ((null tail) nil) ;; -> first entry
12594 ((memq interpret '(type priority))
12595 (if (eq this-command last-command)
12597 (if (> (length tail) 0)
12598 (or done-word (car org-done-keywords))
12603 (run-hook-with-args-until-success
12604 'org-todo-get-default-hook org-state org-last-state)
12606 (next (if org-state (concat " " org-state " ") " "))
12607 (change-plist (list :type 'todo-state-change :from this :to org-state
12608 :position startpos))
12610 (when org-blocker-hook
12611 (setq org-last-todo-state-is-todo
12612 (not (member this org-done-keywords)))
12613 (unless (save-excursion
12615 (org-with-wide-buffer
12616 (run-hook-with-args-until-failure
12617 'org-blocker-hook change-plist))))
12618 (if (org-called-interactively-p 'interactive)
12619 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12620 this org-state org-block-entry-blocking)
12622 (message "TODO state change from %s to %s blocked (by \"%s\")"
12623 this org-state org-block-entry-blocking)
12624 (throw 'exit nil))))
12625 (store-match-data match-data)
12626 (replace-match next t t)
12627 (cond ((equal this org-state)
12628 (message "TODO state was already %s" (org-trim next)))
12629 ((pos-visible-in-window-p hl-pos)
12630 (message "TODO state changed to %s" (org-trim next))))
12632 (setq head (org-get-todo-sequence-head org-state)
12633 ass (assoc head org-todo-kwd-alist)
12634 interpret (nth 1 ass)
12635 done-word (nth 3 ass)
12636 final-done-word (nth 4 ass)))
12637 (when (memq arg '(nextset previousset))
12638 (message "Keyword-Set %d/%d: %s"
12639 (- (length org-todo-sets) -1
12640 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12641 (length org-todo-sets)
12642 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12643 (setq org-last-todo-state-is-todo
12644 (not (member org-state org-done-keywords)))
12645 (setq now-done-p (and (member org-state org-done-keywords)
12646 (not (member this org-done-keywords))))
12647 (and logging (org-local-logging logging))
12648 (when (and (or org-todo-log-states org-log-done)
12649 (not (eq org-inhibit-logging t))
12650 (not (memq arg '(nextset previousset))))
12651 ;; we need to look at recording a time and note
12652 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12653 (nth 2 (assoc this org-todo-log-states))))
12654 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12655 (setq dolog 'time))
12656 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12658 (member org-state org-not-done-keywords)
12659 (not (member this org-not-done-keywords))))
12660 ;; This is now a todo state and was not one before
12661 ;; If there was a CLOSED time stamp, get rid of it.
12662 (org-add-planning-info nil nil 'closed))
12663 (when (and now-done-p org-log-done)
12664 ;; It is now done, and it was not done before
12665 (org-add-planning-info 'closed (org-current-effective-time))
12666 (if (and (not dolog) (eq 'note org-log-done))
12667 (org-add-log-setup 'done org-state this 'findpos 'note)))
12668 (when (and org-state dolog)
12669 ;; This is a non-nil state, and we need to log it
12670 (org-add-log-setup 'state org-state this 'findpos dolog)))
12671 ;; Fixup tag positioning
12672 (org-todo-trigger-tag-changes org-state)
12673 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12674 (when org-provide-todo-statistics
12675 (org-update-parent-todo-statistics))
12676 (run-hooks 'org-after-todo-state-change-hook)
12677 (if (and arg (not (member org-state org-done-keywords)))
12678 (setq head (org-get-todo-sequence-head org-state)))
12679 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12680 ;; Do we need to trigger a repeat?
12682 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12683 ;; This is for the agenda, take a snapshot of the headline.
12685 (setq org-agenda-headline-snapshot-before-repeat
12686 (org-get-heading))))
12687 (org-auto-repeat-maybe org-state))
12688 ;; Fixup cursor location if close to the keyword
12689 (if (and (outline-on-heading-p)
12691 (save-excursion (beginning-of-line 1)
12692 (looking-at org-todo-line-regexp))
12693 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12695 (goto-char (or (match-end 2) (match-end 1)))
12696 (and (looking-at " ") (just-one-space))))
12697 (when org-trigger-hook
12699 (run-hook-with-args 'org-trigger-hook change-plist)))
12700 (when commentp (org-toggle-comment))))))))
12702 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12703 "Block turning an entry into a TODO, using the hierarchy.
12704 This checks whether the current task should be blocked from state
12705 changes. Such blocking occurs when:
12707 1. The task has children which are not all in a completed state.
12709 2. A task has a parent with the property :ORDERED:, and there
12710 are siblings prior to the current task with incomplete
12713 3. The parent of the task is blocked because it has siblings that should
12714 be done first, or is child of a block grandparent TODO entry."
12716 (if (not org-enforce-todo-dependencies)
12717 t ; if locally turned off don't block
12719 ;; If this is not a todo state change, or if this entry is already DONE,
12721 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12722 (member (plist-get change-plist :from)
12723 (cons 'done org-done-keywords))
12724 (member (plist-get change-plist :to)
12725 (cons 'todo org-not-done-keywords))
12726 (not (plist-get change-plist :to)))
12727 (throw 'dont-block t))
12728 ;; If this task has children, and any are undone, it's blocked
12730 (org-back-to-heading t)
12731 (let ((this-level (funcall outline-level)))
12732 (outline-next-heading)
12733 (let ((child-level (funcall outline-level)))
12734 (while (and (not (eobp))
12735 (> child-level this-level))
12736 ;; this todo has children, check whether they are all
12738 (if (and (not (org-entry-is-done-p))
12739 (org-entry-is-todo-p))
12740 (progn (setq org-block-entry-blocking (org-get-heading))
12741 (throw 'dont-block nil)))
12742 (outline-next-heading)
12743 (setq child-level (funcall outline-level))))))
12744 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12745 ;; any previous siblings are undone, it's blocked
12747 (org-back-to-heading t)
12748 (let* ((pos (point))
12749 (parent-pos (and (org-up-heading-safe) (point))))
12750 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12751 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12753 (re-search-forward org-not-done-heading-regexp pos t))
12754 (setq org-block-entry-blocking (match-string 0))
12755 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12756 ;; Search further up the hierarchy, to see if an ancestor is blocked
12758 (goto-char parent-pos)
12759 (if (not (looking-at org-not-done-heading-regexp))
12760 (throw 'dont-block t)) ; do not block, parent is not a TODO
12762 (setq parent-pos (and (org-up-heading-safe) (point)))
12763 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12764 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12766 (re-search-forward org-not-done-heading-regexp pos t)
12767 (setq org-block-entry-blocking (org-get-heading)))
12768 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12770 (defcustom org-track-ordered-property-with-tag nil
12771 "Should the ORDERED property also be shown as a tag?
12772 The ORDERED property decides if an entry should require subtasks to be
12773 completed in sequence. Since a property is not very visible, setting
12774 this option means that toggling the ORDERED property with the command
12775 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12776 not relevant for the behavior, but it makes things more visible.
12778 Note that toggling the tag with tags commands will not change the property
12779 and therefore not influence behavior!
12781 This can be t, meaning the tag ORDERED should be used, It can also be a
12782 string to select a different tag for this task."
12785 (const :tag "No tracking" nil)
12786 (const :tag "Track with ORDERED tag" t)
12787 (string :tag "Use other tag")))
12789 (defun org-toggle-ordered-property ()
12790 "Toggle the ORDERED property of the current entry.
12791 For better visibility, you can track the value of this property with a tag.
12792 See variable `org-track-ordered-property-with-tag'."
12794 (let* ((t1 org-track-ordered-property-with-tag)
12795 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12797 (org-back-to-heading)
12798 (if (org-entry-get nil "ORDERED")
12800 (org-delete-property "ORDERED")
12801 (and tag (org-toggle-tag tag 'off))
12802 (message "Subtasks can be completed in arbitrary order"))
12803 (org-entry-put nil "ORDERED" "t")
12804 (and tag (org-toggle-tag tag 'on))
12805 (message "Subtasks must be completed in sequence")))))
12807 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12808 (defun org-block-todo-from-checkboxes (change-plist)
12809 "Block turning an entry into a TODO, using checkboxes.
12810 This checks whether the current task should be blocked from state
12811 changes because there are unchecked boxes in this entry."
12812 (if (not org-enforce-todo-checkbox-dependencies)
12813 t ; if locally turned off don't block
12815 ;; If this is not a todo state change, or if this entry is already DONE,
12817 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12818 (member (plist-get change-plist :from)
12819 (cons 'done org-done-keywords))
12820 (member (plist-get change-plist :to)
12821 (cons 'todo org-not-done-keywords))
12822 (not (plist-get change-plist :to)))
12823 (throw 'dont-block t))
12824 ;; If this task has checkboxes that are not checked, it's blocked
12826 (org-back-to-heading t)
12827 (let ((beg (point)) end)
12828 (outline-next-heading)
12831 (if (org-list-search-forward
12832 (concat (org-item-beginning-re)
12833 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12837 (if (boundp 'org-blocked-by-checkboxes)
12838 (setq org-blocked-by-checkboxes t))
12839 (throw 'dont-block nil)))))
12840 t))) ; do not block
12842 (defun org-entry-blocked-p ()
12843 "Is the current entry blocked?"
12844 (org-with-silent-modifications
12845 (if (org-entry-get nil "NOBLOCKING")
12846 nil ;; Never block this entry
12847 (not (run-hook-with-args-until-failure
12849 (list :type 'todo-state-change
12854 (defun org-update-statistics-cookies (all)
12855 "Update the statistics cookie, either from TODO or from checkboxes.
12856 This should be called with the cursor in a line with a statistics cookie."
12860 (org-update-checkbox-count 'all)
12861 (org-map-entries 'org-update-parent-todo-statistics))
12862 (if (not (org-at-heading-p))
12863 (org-update-checkbox-count)
12864 (let ((pos (point-marker))
12866 (ignore-errors (org-back-to-heading t))
12867 (if (not (org-at-heading-p))
12868 (org-update-checkbox-count)
12869 (setq l1 (org-outline-level))
12870 (setq end (save-excursion
12871 (outline-next-heading)
12872 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12874 (if (and (save-excursion
12876 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12877 (not (save-excursion (re-search-forward
12878 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12879 (org-update-checkbox-count)
12880 (if (and l2 (> l2 l1))
12883 (org-update-parent-todo-statistics))
12885 (beginning-of-line 1)
12886 (while (re-search-forward
12887 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12889 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12891 (move-marker pos nil)))))
12893 (defvar org-entry-property-inherited-from) ;; defined below
12894 (defun org-update-parent-todo-statistics ()
12895 "Update any statistics cookie in the parent of the current headline.
12896 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12897 the entire subtree and this will travel up the hierarchy and update
12898 statistics everywhere."
12899 (let* ((prop (save-excursion (org-up-heading-safe)
12900 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12901 (recursive (or (not org-hierarchical-todo-statistics)
12902 (and prop (string-match "\\<recursive\\>" prop))))
12903 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12906 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12907 level ltoggle l1 new ndel
12908 (cnt-all 0) (cnt-done 0) is-percent kwd
12909 checkbox-beg ov ovs ove cookie-present)
12912 (beginning-of-line 1)
12913 (setq ltoggle (funcall outline-level))
12914 ;; Three situations are to consider:
12916 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12917 ;; to the top-level ancestor on the headline;
12919 ;; 2. If parent has "recursive" property, repeat up to the
12920 ;; headline setting that property, taking inheritance into
12923 ;; 3. Else, move up to direct parent and proceed only once.
12924 (while (and (setq level (org-up-heading-safe))
12925 (or recursive first)
12927 (setq first nil cookie-present nil)
12931 (downcase (or (org-entry-get nil "COOKIE_DATA")
12934 (while (re-search-forward box-re (point-at-eol) t)
12935 (setq cnt-all 0 cnt-done 0 cookie-present t)
12936 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12938 (unless (outline-next-heading) (throw 'exit nil))
12939 (while (and (looking-at org-complex-heading-regexp)
12940 (> (setq l1 (length (match-string 1))) level))
12941 (setq kwd (and (or recursive (= l1 ltoggle))
12943 (if (or (eq org-provide-todo-statistics 'all-headlines)
12944 (and (eq org-provide-todo-statistics t)
12945 (or (member kwd org-done-keywords)))
12946 (and (listp org-provide-todo-statistics)
12947 (stringp (car org-provide-todo-statistics))
12948 (or (member kwd org-provide-todo-statistics)
12949 (member kwd org-done-keywords)))
12950 (and (listp org-provide-todo-statistics)
12951 (listp (car org-provide-todo-statistics))
12952 (or (member kwd (car org-provide-todo-statistics))
12953 (and (member kwd org-done-keywords)
12954 (member kwd (cadr org-provide-todo-statistics))))))
12955 (setq cnt-all (1+ cnt-all))
12956 (if (eq org-provide-todo-statistics t)
12957 (and kwd (setq cnt-all (1+ cnt-all)))))
12958 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12959 (member kwd org-done-keywords))
12960 (and (listp org-provide-todo-statistics)
12961 (listp (car org-provide-todo-statistics))
12962 (member kwd org-done-keywords)
12963 (member kwd (cadr org-provide-todo-statistics)))
12964 (and (listp org-provide-todo-statistics)
12965 (stringp (car org-provide-todo-statistics))
12966 (member kwd org-done-keywords)))
12967 (setq cnt-done (1+ cnt-done)))
12968 (outline-next-heading)))
12971 (format "[%d%%]" (floor (* 100.0 cnt-done)
12973 (format "[%d/%d]" cnt-done cnt-all))
12974 ndel (- (match-end 0) checkbox-beg))
12975 ;; handle overlays when updating cookie from column view
12976 (when (setq ov (car (overlays-at checkbox-beg)))
12977 (setq ovs (overlay-start ov) ove (overlay-end ov))
12978 (delete-overlay ov))
12979 (goto-char checkbox-beg)
12981 (delete-region (point) (+ (point) ndel))
12982 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12983 (when ov (move-overlay ov ovs ove)))
12984 (when cookie-present
12985 (run-hook-with-args 'org-after-todo-statistics-hook
12986 cnt-done (- cnt-all cnt-done))))))
12987 (run-hooks 'org-todo-statistics-hook)))
12989 (defvar org-after-todo-statistics-hook nil
12990 "Hook that is called after a TODO statistics cookie has been updated.
12991 Each function is called with two arguments: the number of not-done entries
12992 and the number of done entries.
12994 For example, the following function, when added to this hook, will switch
12995 an entry to DONE when all children are done, and back to TODO when new
12996 entries are set to a TODO status. Note that this hook is only called
12997 when there is a statistics cookie in the headline!
12999 (defun org-summary-todo (n-done n-not-done)
13000 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13001 (let (org-log-done org-log-states) ; turn off logging
13002 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13005 (defvar org-todo-statistics-hook nil
13006 "Hook that is run whenever Org thinks TODO statistics should be updated.
13007 This hook runs even if there is no statistics cookie present, in which case
13008 `org-after-todo-statistics-hook' would not run.")
13010 (defun org-todo-trigger-tag-changes (state)
13011 "Apply the changes defined in `org-todo-state-tags-triggers'."
13012 (let ((l org-todo-state-tags-triggers)
13014 (when (or (not state) (equal state ""))
13015 (setq changes (append changes (cdr (assoc "" l)))))
13016 (when (and (stringp state) (> (length state) 0))
13017 (setq changes (append changes (cdr (assoc state l)))))
13018 (when (member state org-not-done-keywords)
13019 (setq changes (append changes (cdr (assoc 'todo l)))))
13020 (when (member state org-done-keywords)
13021 (setq changes (append changes (cdr (assoc 'done l)))))
13022 (dolist (c changes)
13023 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13025 (defun org-local-logging (value)
13026 "Get logging settings from a property VALUE."
13028 ;; directly set the variables, they are already local.
13029 (setq org-log-done nil
13031 org-todo-log-states nil)
13032 (setq words (org-split-string value))
13033 (while (setq w (pop words))
13035 ((setq a (assoc w org-startup-options))
13036 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13037 (set (nth 1 a) (nth 2 a))))
13038 ((setq a (org-extract-log-state-settings w))
13039 (and (member (car a) org-todo-keywords-1)
13040 (push a org-todo-log-states)))))))
13042 (defun org-get-todo-sequence-head (kwd)
13043 "Return the head of the TODO sequence to which KWD belongs.
13044 If KWD is not set, check if there is a text property remembering the
13049 (or (get-text-property (point-at-bol) 'org-todo-head)
13051 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13052 nil (point-at-eol)))
13053 (get-text-property p 'org-todo-head))))
13054 ((not (member kwd org-todo-keywords-1))
13055 (car org-todo-keywords-1))
13056 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13058 (defun org-fast-todo-selection ()
13059 "Fast TODO keyword selection with single keys.
13060 Returns the new TODO keyword, or nil if no state change should occur."
13061 (let* ((fulltable org-todo-key-alist)
13062 (done-keywords org-done-keywords) ;; needed for the faces.
13063 (maxlen (apply 'max (mapcar
13065 (if (stringp (car x)) (string-width (car x)) 0))
13068 (fwidth (+ maxlen 3 1 3))
13069 (ncol (/ (- (window-width) 4) fwidth))
13073 (save-window-excursion
13075 (set-buffer (get-buffer-create " *Org todo*"))
13076 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13078 (org-set-local 'org-done-keywords done-keywords)
13079 (setq tbl fulltable cnt 0)
13080 (while (setq e (pop tbl))
13082 ((equal e '(:startgroup))
13083 (push '() groups) (setq ingroup t)
13084 (when (not (= cnt 0))
13088 ((equal e '(:endgroup))
13089 (setq ingroup nil cnt 0)
13091 ((equal e '(:newline))
13092 (when (not (= cnt 0))
13096 (while (equal (car tbl) '(:newline))
13098 (setq tbl (cdr tbl)))))
13100 (setq tg (car e) c (cdr e))
13101 (if ingroup (push tg (car groups)))
13102 (setq tg (org-add-props tg nil 'face
13103 (org-get-todo-face tg)))
13104 (if (and (= cnt 0) (not ingroup)) (insert " "))
13105 (insert "[" c "] " tg (make-string
13106 (- fwidth 4 (length tg)) ?\ ))
13107 (when (= (setq cnt (1+ cnt)) ncol)
13109 (if ingroup (insert " "))
13112 (goto-char (point-min))
13113 (if (not expert) (org-fit-window-to-buffer))
13114 (message "[a-z..]:Set [SPC]:clear")
13115 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13118 (and (= c ?q) (not (rassoc c fulltable))))
13119 (setq quit-flag t))
13121 ((setq e (rassoc c fulltable) tg (car e))
13123 (t (setq quit-flag t)))))))
13125 (defun org-entry-is-todo-p ()
13126 (member (org-get-todo-state) org-not-done-keywords))
13128 (defun org-entry-is-done-p ()
13129 (member (org-get-todo-state) org-done-keywords))
13131 (defun org-get-todo-state ()
13132 "Return the TODO keyword of the current subtree."
13134 (org-back-to-heading t)
13135 (and (looking-at org-todo-line-regexp)
13137 (match-string 2))))
13139 (defun org-at-date-range-p (&optional inactive-ok)
13140 "Is the cursor inside a date range?"
13144 (let ((pos (point)))
13145 (skip-chars-backward "^[<\r\n")
13146 (skip-chars-backward "<[")
13147 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13148 (>= (match-end 0) pos)
13150 (skip-chars-backward "^<[\r\n")
13151 (skip-chars-backward "<[")
13152 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13153 (>= (match-end 0) pos)
13157 (defun org-get-repeat (&optional tagline)
13158 "Check if there is a deadline/schedule with repeater in this entry."
13161 (org-back-to-heading t)
13162 (and (re-search-forward (if tagline
13163 (concat tagline "\\s-*" org-repeat-re)
13165 (org-entry-end-position) t)
13166 (match-string-no-properties 1)))))
13168 (defvar org-last-changed-timestamp)
13169 (defvar org-last-inserted-timestamp)
13170 (defvar org-log-post-message)
13171 (defvar org-log-note-purpose)
13172 (defvar org-log-note-how nil)
13173 (defvar org-log-note-extra)
13174 (defun org-auto-repeat-maybe (done-word)
13175 "Check if the current headline contains a repeated deadline/schedule.
13176 If yes, set TODO state back to what it was and change the base date
13177 of repeating deadline/scheduled time stamps to new date.
13178 This function is run automatically after each state change to a DONE state."
13179 ;; last-state is dynamically scoped into this function
13180 (let* ((repeat (org-get-repeat))
13181 (aa (assoc org-last-state org-todo-kwd-alist))
13182 (interpret (nth 1 aa))
13184 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13185 (msg "Entry repeats: ")
13187 (org-todo-log-states nil)
13188 re type n what ts time to-state)
13189 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13190 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13191 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13192 org-todo-repeat-to-state))
13193 (unless (and to-state (member to-state org-todo-keywords-1))
13194 (setq to-state (if (eq interpret 'type) org-last-state head)))
13195 (org-todo to-state)
13196 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13197 (org-entry-put nil "LAST_REPEAT" (format-time-string
13198 (org-time-stamp-format t t))))
13199 (when org-log-repeat
13200 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13201 (memq 'org-add-log-note post-command-hook))
13202 ;; OK, we are already setup for some record
13203 (if (eq org-log-repeat 'note)
13204 ;; make sure we take a note, not only a time stamp
13205 (setq org-log-note-how 'note))
13206 ;; Set up for taking a record
13207 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13209 'findpos org-log-repeat)))
13210 (org-back-to-heading t)
13211 (org-add-planning-info nil nil 'closed)
13212 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13213 org-deadline-time-regexp "\\)\\|\\("
13214 org-ts-regexp "\\)"))
13215 (while (re-search-forward
13216 re (save-excursion (outline-next-heading) (point)) t)
13217 (setq type (if (match-end 1) org-scheduled-string
13218 (if (match-end 3) org-deadline-string "Plain:"))
13219 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13220 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13221 (setq n (string-to-number (match-string 2 ts))
13222 what (match-string 3 ts))
13223 (if (equal what "w") (setq n (* n 7) what "d"))
13224 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13225 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13226 ;; Preparation, see if we need to modify the start date for the change
13227 (when (match-end 1)
13228 (setq time (save-match-data (org-time-string-to-time ts)))
13230 ((equal (match-string 1 ts) ".")
13231 ;; Shift starting date to today
13232 (org-timestamp-change
13233 (- (org-today) (time-to-days time))
13235 ((equal (match-string 1 ts) "+")
13236 (let ((nshiftmax 10) (nshift 0))
13237 (while (or (= nshift 0)
13238 (<= (time-to-days time)
13239 (time-to-days (current-time))))
13240 (when (= (incf nshift) nshiftmax)
13241 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13242 (user-error "Abort")))
13243 (org-timestamp-change n (cdr (assoc what whata)))
13244 (org-at-timestamp-p t)
13245 (setq ts (match-string 1))
13246 (setq time (save-match-data (org-time-string-to-time ts)))))
13247 (org-timestamp-change (- n) (cdr (assoc what whata)))
13248 ;; rematch, so that we have everything in place for the real shift
13249 (org-at-timestamp-p t)
13250 (setq ts (match-string 1))
13251 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13252 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13253 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13254 (setq org-log-post-message msg)
13255 (message "%s" msg))))
13257 (defun org-show-todo-tree (arg)
13258 "Make a compact tree which shows all headlines marked with TODO.
13259 The tree will show the lines where the regexp matches, and all higher
13260 headlines above the match.
13261 With a \\[universal-argument] prefix, prompt for a regexp to match.
13262 With a numeric prefix N, construct a sparse tree for the Nth element
13263 of `org-todo-keywords-1'."
13265 (let ((case-fold-search nil)
13267 (cond ((null arg) org-not-done-regexp)
13269 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13270 (mapcar 'list org-todo-keywords-1))))
13272 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13274 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13275 (regexp-quote (nth (1- (prefix-numeric-value arg))
13276 org-todo-keywords-1)))
13277 (t (user-error "Invalid prefix argument: %s" arg)))))
13278 (message "%d TODO entries found"
13279 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13281 (defun org-deadline (arg &optional time)
13282 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13283 With one universal prefix argument, remove any deadline from the item.
13284 With two universal prefix arguments, prompt for a warning delay.
13285 With argument TIME, set the deadline at the corresponding date. TIME
13286 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13288 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13289 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13290 'region-start-level 'region))
13291 org-loop-over-headlines-in-active-region)
13293 `(org-deadline ',arg ,time)
13294 org-loop-over-headlines-in-active-region
13295 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13296 (let* ((old-date (org-entry-get nil "DEADLINE"))
13297 (old-date-time (if old-date (org-time-string-to-time old-date)))
13298 (repeater (and old-date
13300 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13302 (match-string 1 old-date))))
13305 (when (and old-date org-log-redeadline)
13306 (org-add-log-setup 'deldeadline nil old-date 'findpos
13307 org-log-redeadline))
13308 (org-remove-timestamp-with-keyword org-deadline-string)
13309 (message "Item no longer has a deadline."))
13312 (org-back-to-heading t)
13313 (if (re-search-forward
13314 org-deadline-time-regexp
13315 (save-excursion (outline-next-heading) (point)) t)
13316 (let* ((rpl0 (match-string 1))
13317 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13319 (concat org-deadline-string
13325 (org-read-date nil t nil "Warn starting from" old-date-time)))
13326 (time-to-days old-date-time))))
13328 (user-error "No deadline information to update"))))
13330 (org-add-planning-info 'deadline time 'closed)
13331 (when (and old-date org-log-redeadline
13332 (not (equal old-date
13333 (substring org-last-inserted-timestamp 1 -1))))
13334 (org-add-log-setup 'redeadline nil old-date 'findpos
13335 org-log-redeadline))
13338 (org-back-to-heading t)
13339 (when (re-search-forward (concat org-deadline-string " "
13340 org-last-inserted-timestamp)
13342 (outline-next-heading) (point)) t)
13343 (goto-char (1- (match-end 0)))
13344 (insert " " repeater)
13345 (setq org-last-inserted-timestamp
13346 (concat (substring org-last-inserted-timestamp 0 -1)
13348 (substring org-last-inserted-timestamp -1))))))
13349 (message "Deadline on %s" org-last-inserted-timestamp))))))
13351 (defun org-schedule (arg &optional time)
13352 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13353 With one universal prefix argument, remove any scheduling date from the item.
13354 With two universal prefix arguments, prompt for a delay cookie.
13355 With argument TIME, scheduled at the corresponding date. TIME can
13356 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13358 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13359 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13360 'region-start-level 'region))
13361 org-loop-over-headlines-in-active-region)
13363 `(org-schedule ',arg ,time)
13364 org-loop-over-headlines-in-active-region
13365 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13366 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13367 (old-date-time (if old-date (org-time-string-to-time old-date)))
13368 (repeater (and old-date
13370 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13372 (match-string 1 old-date))))
13376 (when (and old-date org-log-reschedule)
13377 (org-add-log-setup 'delschedule nil old-date 'findpos
13378 org-log-reschedule))
13379 (org-remove-timestamp-with-keyword org-scheduled-string)
13380 (message "Item is no longer scheduled.")))
13383 (org-back-to-heading t)
13384 (if (re-search-forward
13385 org-scheduled-time-regexp
13386 (save-excursion (outline-next-heading) (point)) t)
13387 (let* ((rpl0 (match-string 1))
13388 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13390 (concat org-scheduled-string
13396 (org-read-date nil t nil "Delay until" old-date-time)))
13397 (time-to-days old-date-time))))
13399 (user-error "No scheduled information to update"))))
13401 (org-add-planning-info 'scheduled time 'closed)
13402 (when (and old-date org-log-reschedule
13403 (not (equal old-date
13404 (substring org-last-inserted-timestamp 1 -1))))
13405 (org-add-log-setup 'reschedule nil old-date 'findpos
13406 org-log-reschedule))
13409 (org-back-to-heading t)
13410 (when (re-search-forward (concat org-scheduled-string " "
13411 org-last-inserted-timestamp)
13413 (outline-next-heading) (point)) t)
13414 (goto-char (1- (match-end 0)))
13415 (insert " " repeater)
13416 (setq org-last-inserted-timestamp
13417 (concat (substring org-last-inserted-timestamp 0 -1)
13419 (substring org-last-inserted-timestamp -1))))))
13420 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13422 (defun org-get-scheduled-time (pom &optional inherit)
13423 "Get the scheduled time as a time tuple, of a format suitable
13424 for calling org-schedule with, or if there is no scheduling,
13426 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13428 (apply 'encode-time (org-parse-time-string time)))))
13430 (defun org-get-deadline-time (pom &optional inherit)
13431 "Get the deadline as a time tuple, of a format suitable for
13432 calling org-deadline with, or if there is no scheduling, returns
13434 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13436 (apply 'encode-time (org-parse-time-string time)))))
13438 (defun org-remove-timestamp-with-keyword (keyword)
13439 "Remove all time stamps with KEYWORD in the current entry."
13440 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13443 (org-back-to-heading t)
13445 (outline-next-heading)
13446 (while (re-search-backward re beg t)
13448 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13449 (equal (char-before) ?\ ))
13450 (backward-delete-char 1)
13451 (if (string-match "^[ \t]*$" (buffer-substring
13452 (point-at-bol) (point-at-eol)))
13453 (delete-region (point-at-bol)
13454 (min (point-max) (1+ (point-at-eol))))))))))
13456 (defvar org-time-was-given) ; dynamically scoped parameter
13457 (defvar org-end-time-was-given) ; dynamically scoped parameter
13459 (defun org-at-planning-p ()
13460 "Non-nil when point is on a planning info line."
13461 ;; This is as accurate and faster than `org-element-at-point' since
13462 ;; planning info location is fixed in the section.
13463 (org-with-wide-buffer
13464 (beginning-of-line)
13465 (and (org-looking-at-p org-planning-line-re)
13468 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13469 (org-back-to-heading t)
13470 (org-with-limited-levels (org-back-to-heading t)))
13471 (line-beginning-position 2))))))
13473 (defun org-add-planning-info (what &optional time &rest remove)
13474 "Insert new timestamp with keyword in the planning line.
13475 WHAT indicates what kind of time stamp to add. It is a symbol
13476 among `closed', `deadline', `scheduled' and nil. TIME indicates
13477 the time to use. If none is given, the user is prompted for
13478 a date. REMOVE indicates what kind of entries to remove. An old
13479 WHAT entry will also be removed."
13480 (let (org-time-was-given org-end-time-was-given default-time default-input)
13482 (when (and (memq what '(scheduled deadline))
13484 (and (stringp time)
13485 (string-match "^[-+]+[0-9]" time))))
13486 ;; Try to get a default date/time from existing timestamp
13488 (org-back-to-heading t)
13489 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13490 (when (re-search-forward (if (eq what 'scheduled)
13491 org-scheduled-time-regexp
13492 org-deadline-time-regexp)
13494 (setq ts (match-string 1)
13495 default-time (apply 'encode-time (org-parse-time-string ts))
13496 default-input (and ts (org-get-compact-tod ts)))))))
13500 ;; This is a string (relative or absolute), set
13502 (apply #'encode-time
13503 (org-read-date-analyze
13504 time default-time (decode-time default-time)))
13505 ;; If necessary, get the time from the user
13506 (or time (org-read-date nil 'to-time nil nil
13507 default-time default-input)))))
13509 (org-with-wide-buffer
13510 (org-back-to-heading t)
13512 (unless (bolp) (insert "\n"))
13513 (cond ((org-looking-at-p org-planning-line-re)
13514 ;; Move to current indentation.
13515 (skip-chars-forward " \t")
13516 ;; Check if we have to remove something.
13517 (dolist (type (if what (cons what remove) remove))
13519 (when (re-search-forward
13523 (closed org-closed-time-regexp)
13524 (deadline org-deadline-time-regexp)
13525 (scheduled org-scheduled-time-regexp)
13527 (error "Invalid planning type: %s" type))))
13528 (line-end-position) t)
13530 (when (looking-at "--+<[^>]+>") (replace-match ""))
13531 (when (and (not what) (eq type 'closed))
13533 (beginning-of-line)
13534 (when (looking-at "[ \t]*$")
13535 (delete-region (point)
13536 (line-beginning-position 2)))))))
13537 ;; Remove leading white spaces.
13538 (when (looking-at "[ \t]+") (replace-match ""))))
13539 ((not what) (throw 'exit nil)) ; Nothing to do.
13540 (t (insert-before-markers "\n")
13542 (when org-adapt-indentation
13543 (org-indent-to-column (1+ (org-outline-level))))))
13545 ;; Insert planning keyword.
13547 (closed org-closed-string)
13548 (deadline org-deadline-string)
13549 (scheduled org-scheduled-string)
13550 (otherwise (error "Invalid planning type: %s" what)))
13552 ;; Insert associated timestamp.
13553 (let ((ts (org-insert-time-stamp
13555 (or org-time-was-given
13556 (and (eq what 'closed) org-log-done-with-time))
13558 nil nil (list org-end-time-was-given))))
13559 (unless (eolp) (insert " "))
13562 (defvar org-log-note-marker (make-marker))
13563 (defvar org-log-note-purpose nil)
13564 (defvar org-log-note-state nil)
13565 (defvar org-log-note-previous-state nil)
13566 (defvar org-log-note-extra nil)
13567 (defvar org-log-note-window-configuration nil)
13568 (defvar org-log-note-return-to (make-marker))
13569 (defvar org-log-note-effective-time nil
13570 "Remembered current time so that dynamically scoped
13571 `org-extend-today-until' affects tha timestamps in state change
13574 (defvar org-log-post-message nil
13575 "Message to be displayed after a log note has been stored.
13576 The auto-repeater uses this.")
13578 (defun org-add-note ()
13579 "Add a note to the current entry.
13580 This is done in the same way as adding a state change note."
13582 (org-add-log-setup 'note nil nil 'findpos nil))
13584 (defun org-log-beginning (&optional create)
13585 "Return expected start of log notes in current entry.
13586 When optional argument CREATE is non-nil, the function creates
13587 a drawer to store notes, if necessary. Returned position ignores
13589 (org-with-wide-buffer
13590 (org-end-of-meta-data)
13591 (let ((end (if (org-at-heading-p) (point)
13592 (save-excursion (outline-next-heading) (point))))
13593 (drawer (org-log-into-drawer)))
13596 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13597 (case-fold-search t))
13599 ;; Try to find existing drawer.
13600 (while (re-search-forward regexp end t)
13601 (let ((element (org-element-at-point)))
13602 (when (eq (org-element-type element) 'drawer)
13603 (let ((cend (org-element-property :contents-end element)))
13604 (when (and (not org-log-states-order-reversed) cend)
13606 (throw 'exit nil))))
13607 ;; No drawer found. Create one, if permitted.
13609 (unless (bolp) (insert "\n"))
13610 (let ((beg (point)))
13611 (insert ":" drawer ":\n:END:\n")
13612 (org-indent-region beg (point)))
13613 (end-of-line -1)))))
13614 (org-log-state-notes-insert-after-drawers
13615 (while (and (looking-at org-drawer-regexp)
13616 (progn (goto-char (match-end 0))
13617 (re-search-forward org-property-end-re end t)))
13619 (if (bolp) (point) (line-beginning-position 2))))
13621 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13622 "Set up the post command hook to take a note.
13623 If this is about to TODO state change, the new state is expected in STATE.
13624 When FINDPOS is non-nil, find the correct position for the note in
13625 the current entry. If not, assume that it can be inserted at point.
13626 HOW is an indicator what kind of note should be created.
13627 EXTRA is additional text that will be inserted into the notes buffer."
13628 (org-with-wide-buffer
13630 (goto-char (org-log-beginning t))
13631 (unless org-log-states-order-reversed
13632 (org-skip-over-state-notes)
13633 (skip-chars-backward " \t\n\r")
13635 (move-marker org-log-note-marker (point))
13636 ;; Preserve position even if a property drawer is inserted in the
13638 (set-marker-insertion-type org-log-note-marker t)
13639 (setq org-log-note-purpose purpose
13640 org-log-note-state state
13641 org-log-note-previous-state prev-state
13642 org-log-note-how how
13643 org-log-note-extra extra
13644 org-log-note-effective-time (org-current-effective-time))
13645 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13647 (defun org-skip-over-state-notes ()
13648 "Skip past the list of State notes in an entry."
13649 (when (ignore-errors (goto-char (org-in-item-p)))
13650 (let* ((struct (org-list-struct))
13651 (prevs (org-list-prevs-alist struct))
13653 (concat "[ \t]*- +"
13654 (replace-regexp-in-string
13656 (org-replace-escapes
13657 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13658 `(("%d" . ,org-ts-regexp-inactive)
13659 ("%D" . ,org-ts-regexp)
13660 ("%s" . "\"\\S-+\"")
13661 ("%S" . "\"\\S-+\"")
13662 ("%t" . ,org-ts-regexp-inactive)
13663 ("%T" . ,org-ts-regexp)
13665 ("%U" . ".*?")))))))
13666 (while (org-looking-at-p regexp)
13667 (goto-char (or (org-list-get-next-item (point) struct prevs)
13668 (org-list-get-item-end (point) struct)))))))
13670 (defun org-add-log-note (&optional purpose)
13671 "Pop up a window for taking a note, and add this note later at point."
13672 (remove-hook 'post-command-hook 'org-add-log-note)
13673 (setq org-log-note-window-configuration (current-window-configuration))
13674 (delete-other-windows)
13675 (move-marker org-log-note-return-to (point))
13676 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13677 (goto-char org-log-note-marker)
13678 (org-switch-to-buffer-other-window "*Org Note*")
13680 (if (memq org-log-note-how '(time state))
13681 (let (current-prefix-arg) (org-store-log-note))
13682 (let ((org-inhibit-startup t)) (org-mode))
13683 (insert (format "# Insert note for %s.
13684 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13686 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13687 ((eq org-log-note-purpose 'done) "closed todo item")
13688 ((eq org-log-note-purpose 'state)
13689 (format "state change from \"%s\" to \"%s\""
13690 (or org-log-note-previous-state "")
13691 (or org-log-note-state "")))
13692 ((eq org-log-note-purpose 'reschedule)
13694 ((eq org-log-note-purpose 'delschedule)
13695 "no longer scheduled")
13696 ((eq org-log-note-purpose 'redeadline)
13697 "changing deadline")
13698 ((eq org-log-note-purpose 'deldeadline)
13699 "removing deadline")
13700 ((eq org-log-note-purpose 'refile)
13702 ((eq org-log-note-purpose 'note)
13704 (t (error "This should not happen")))))
13705 (if org-log-note-extra (insert org-log-note-extra))
13706 (org-set-local 'org-finish-function 'org-store-log-note)
13707 (run-hooks 'org-log-buffer-setup-hook)))
13709 (defvar org-note-abort nil) ; dynamically scoped
13710 (defun org-store-log-note ()
13711 "Finish taking a log note, and insert it to where it belongs."
13712 (let ((txt (buffer-string)))
13713 (kill-buffer (current-buffer))
13714 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13715 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13716 (setq txt (replace-match "" t t txt)))
13717 (if (string-match "\\s-+\\'" txt)
13718 (setq txt (replace-match "" t t txt)))
13719 (setq lines (org-split-string txt "\n"))
13720 (when (and note (string-match "\\S-" note))
13722 (org-replace-escapes
13724 (list (cons "%u" (user-login-name))
13725 (cons "%U" user-full-name)
13726 (cons "%t" (format-time-string
13727 (org-time-stamp-format 'long 'inactive)
13728 org-log-note-effective-time))
13729 (cons "%T" (format-time-string
13730 (org-time-stamp-format 'long nil)
13731 org-log-note-effective-time))
13732 (cons "%d" (format-time-string
13733 (org-time-stamp-format nil 'inactive)
13734 org-log-note-effective-time))
13735 (cons "%D" (format-time-string
13736 (org-time-stamp-format nil nil)
13737 org-log-note-effective-time))
13739 ((not org-log-note-state) "")
13740 ((org-string-match-p org-ts-regexp
13741 org-log-note-state)
13743 (substring org-log-note-state 1 -1)))
13744 (t (format "\"%s\"" org-log-note-state))))
13747 ((not org-log-note-previous-state) "")
13748 ((org-string-match-p org-ts-regexp
13749 org-log-note-previous-state)
13752 org-log-note-previous-state 1 -1)))
13753 (t (format "\"%s\""
13754 org-log-note-previous-state)))))))
13755 (when lines (setq note (concat note " \\\\")))
13757 (when (or current-prefix-arg org-note-abort)
13758 (when (org-log-into-drawer)
13759 (org-remove-empty-drawer-at org-log-note-marker))
13762 (with-current-buffer (marker-buffer org-log-note-marker)
13763 (org-with-wide-buffer
13764 (goto-char org-log-note-marker)
13765 (move-marker org-log-note-marker nil)
13766 ;; Make sure point is at the beginning of an empty line.
13767 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13768 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13769 ;; In an existing list, add a new item at the top level.
13770 ;; Otherwise, indent line like a regular one.
13771 (let ((itemp (org-in-item-p)))
13773 (org-indent-line-to
13774 (let ((struct (save-excursion
13775 (goto-char itemp) (org-list-struct))))
13776 (org-list-get-ind (org-list-get-top-point struct) struct)))
13777 (org-indent-line)))
13778 (insert (org-list-bullet-string "-") (pop lines))
13779 (let ((ind (org-list-item-body-column (line-beginning-position))))
13780 (dolist (line lines)
13782 (org-indent-line-to ind)
13784 (message "Note stored")
13785 (org-back-to-heading t)
13786 (org-cycle-hide-drawers 'children))
13787 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13788 ;; from within `org-add-log-note' because `buffer-undo-list'
13789 ;; is then modified outside of `org-with-remote-undo'.
13790 (when (eq this-command 'org-agenda-todo)
13791 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13792 ;; Don't add undo information when called from `org-agenda-todo'
13793 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13794 (set-window-configuration org-log-note-window-configuration)
13795 (with-current-buffer (marker-buffer org-log-note-return-to)
13796 (goto-char org-log-note-return-to))
13797 (move-marker org-log-note-return-to nil)
13798 (and org-log-post-message (message "%s" org-log-post-message))))
13800 (defun org-remove-empty-drawer-at (pos)
13801 "Remove an empty drawer at position POS.
13802 POS may also be a marker."
13803 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13804 (org-with-wide-buffer
13806 (let ((drawer (org-element-at-point)))
13807 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13808 (not (org-element-property :contents-begin drawer)))
13809 (delete-region (org-element-property :begin drawer)
13810 (progn (goto-char (org-element-property :end drawer))
13811 (skip-chars-backward " \r\t\n")
13815 (defvar org-ts-type nil)
13816 (defun org-sparse-tree (&optional arg type)
13817 "Create a sparse tree, prompt for the details.
13818 This command can create sparse trees. You first need to select the type
13819 of match used to create the tree:
13821 t Show all TODO entries.
13822 T Show entries with a specific TODO keyword.
13823 m Show entries selected by a tags/property match.
13824 p Enter a property name and its value (both with completion on existing
13825 names/values) and show entries with that property.
13826 r Show entries matching a regular expression (`/' can be used as well).
13827 b Show deadlines and scheduled items before a date.
13828 a Show deadlines and scheduled items after a date.
13829 d Show deadlines due within `org-deadline-warning-days'.
13830 D Show deadlines and scheduled items between a date range."
13832 (setq type (or type org-sparse-tree-default-date-type))
13833 (setq org-ts-type type)
13834 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13835 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13836 [c]ycle through date types: %s"
13838 (all "all timestamps")
13839 (scheduled "only scheduled")
13840 (deadline "only deadline")
13841 (active "only active timestamps")
13842 (inactive "only inactive timestamps")
13843 (closed "with a closed time-stamp")
13844 (otherwise "scheduled/deadline")))
13845 (let ((answer (read-char-exclusive)))
13851 (memq type '(nil all scheduled deadline active inactive closed)))))
13852 (?d (call-interactively 'org-check-deadlines))
13853 (?b (call-interactively 'org-check-before-date))
13854 (?a (call-interactively 'org-check-after-date))
13855 (?D (call-interactively 'org-check-dates-range))
13856 (?t (call-interactively 'org-show-todo-tree))
13857 (?T (org-show-todo-tree '(4)))
13858 (?m (call-interactively 'org-match-sparse-tree))
13860 (let* ((kwd (org-icompleting-read
13861 "Property: " (mapcar 'list (org-buffer-property-keys))))
13862 (value (org-icompleting-read
13863 "Value: " (mapcar 'list (org-property-values kwd)))))
13864 (unless (string-match "\\`{.*}\\'" value)
13865 (setq value (concat "\"" value "\"")))
13866 (org-match-sparse-tree arg (concat kwd "=" value))))
13867 ((?r ?R ?/) (call-interactively 'org-occur))
13868 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13870 (defvar org-occur-highlights nil
13871 "List of overlays used for occur matches.")
13872 (make-variable-buffer-local 'org-occur-highlights)
13873 (defvar org-occur-parameters nil
13874 "Parameters of the active org-occur calls.
13875 This is a list, each call to org-occur pushes as cons cell,
13876 containing the regular expression and the callback, onto the list.
13877 The list can contain several entries if `org-occur' has been called
13878 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13879 will only contain one set of parameters. When the highlights are
13880 removed (for example with `C-c C-c', or with the next edit (depending
13881 on `org-remove-highlights-with-change'), this variable is emptied
13883 (make-variable-buffer-local 'org-occur-parameters)
13885 (defun org-occur (regexp &optional keep-previous callback)
13886 "Make a compact tree which shows all matches of REGEXP.
13887 The tree will show the lines where the regexp matches, and all higher
13888 headlines above the match. It will also show the heading after the match,
13889 to make sure editing the matching entry is easy.
13890 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13891 call to `org-occur' will be kept, to allow stacking of calls to this
13893 If CALLBACK is non-nil, it is a function which is called to confirm
13894 that the match should indeed be shown."
13895 (interactive "sRegexp: \nP")
13896 (when (equal regexp "")
13897 (user-error "Regexp cannot be empty"))
13898 (unless keep-previous
13899 (org-remove-occur-highlights nil nil t))
13900 (push (cons regexp callback) org-occur-parameters)
13903 (goto-char (point-min))
13904 (if (or (not keep-previous) ; do not want to keep
13905 (not org-occur-highlights)) ; no previous matches
13908 (while (re-search-forward regexp nil t)
13909 (when (or (not callback)
13910 (save-match-data (funcall callback)))
13911 (setq cnt (1+ cnt))
13912 (when org-highlight-sparse-tree-matches
13913 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13914 (org-show-context 'occur-tree))))
13915 (when org-remove-highlights-with-change
13916 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13918 (unless org-sparse-tree-open-archived-trees
13919 (org-hide-archived-subtrees (point-min) (point-max)))
13920 (run-hooks 'org-occur-hook)
13921 (if (org-called-interactively-p 'interactive)
13922 (message "%d match(es) for regexp %s" cnt regexp))
13925 (defun org-occur-next-match (&optional n reset)
13926 "Function for `next-error-function' to find sparse tree matches.
13927 N is the number of matches to move, when negative move backwards.
13928 RESET is entirely ignored - this function always goes back to the
13929 starting point when no match is found."
13930 (let* ((limit (if (< n 0) (point-min) (point-max)))
13931 (search-func (if (< n 0)
13932 'previous-single-char-property-change
13933 'next-single-char-property-change))
13938 (while (setq p1 (funcall search-func (point) 'org-type))
13939 (when (equal p1 limit)
13941 (user-error "No more matches"))
13942 (when (equal (get-char-property p1 'org-type) 'org-occur)
13946 (throw 'exit (point))))
13949 (user-error "No more matches"))))
13951 (defun org-show-context (&optional key)
13952 "Make sure point and context are visible.
13953 Optional argument KEY, when non-nil, is a symbol. See
13954 `org-show-context-detail' for allowed values and how much is to
13956 (org-show-set-visibility
13957 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13958 ((cdr (assq key org-show-context-detail)))
13959 (t (cdr (assq 'default org-show-context-detail))))))
13961 (defun org-show-set-visibility (detail)
13962 "Set visibility around point according to DETAIL.
13963 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13964 `tree', `canonical' or t. See `org-show-context-detail' for more
13966 (unless (org-before-first-heading-p)
13967 ;; Show current heading and possibly its entry, following headline
13968 ;; or all children.
13969 (if (and (org-at-heading-p) (not (eq detail 'local)))
13970 (org-flag-heading nil)
13972 (org-with-limited-levels
13974 ((tree canonical t) (show-children))
13975 ((nil minimal ancestors))
13977 (outline-next-heading)
13978 (org-flag-heading nil))))))
13979 ;; Show all siblings.
13980 (when (eq detail 'lineage) (org-show-siblings))
13981 ;; Show ancestors, possibly with their children.
13982 (when (memq detail '(ancestors lineage tree canonical t))
13984 (while (org-up-heading-safe)
13985 (org-flag-heading nil)
13986 (when (memq detail '(canonical t)) (org-show-entry))
13987 (when (memq detail '(tree canonical t)) (show-children)))))))
13989 (defvar org-reveal-start-hook nil
13990 "Hook run before revealing a location.")
13992 (defun org-reveal (&optional siblings)
13993 "Show current entry, hierarchy above it, and the following headline.
13995 This can be used to show a consistent set of context around
13996 locations exposed with `org-show-context'.
13998 With optional argument SIBLINGS, on each level of the hierarchy all
13999 siblings are shown. This repairs the tree structure to what it would
14000 look like when opened with hierarchical calls to `org-cycle'.
14002 With double optional argument \\[universal-argument] \\[universal-argument], \
14003 go to the parent and show the
14006 (run-hooks 'org-reveal-start-hook)
14007 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14008 ((equal siblings '(16))
14010 (when (org-up-heading-safe)
14012 (run-hook-with-args 'org-cycle-hook 'subtree))))
14013 (t (org-show-set-visibility 'lineage))))
14015 (defun org-highlight-new-match (beg end)
14016 "Highlight from BEG to END and mark the highlight is an occur headline."
14017 (let ((ov (make-overlay beg end)))
14018 (overlay-put ov 'face 'secondary-selection)
14019 (overlay-put ov 'org-type 'org-occur)
14020 (push ov org-occur-highlights)))
14022 (defun org-remove-occur-highlights (&optional beg end noremove)
14023 "Remove the occur highlights from the buffer.
14024 BEG and END are ignored. If NOREMOVE is nil, remove this function
14025 from the `before-change-functions' in the current buffer."
14027 (unless org-inhibit-highlight-removal
14028 (mapc 'delete-overlay org-occur-highlights)
14029 (setq org-occur-highlights nil)
14030 (setq org-occur-parameters nil)
14032 (remove-hook 'before-change-functions
14033 'org-remove-occur-highlights 'local))))
14037 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14038 "Regular expression matching the priority indicator.")
14040 (defvar org-remove-priority-next-time nil)
14042 (defun org-priority-up ()
14043 "Increase the priority of the current item."
14045 (org-priority 'up))
14047 (defun org-priority-down ()
14048 "Decrease the priority of the current item."
14050 (org-priority 'down))
14052 (defun org-priority (&optional action show)
14053 "Change the priority of an item.
14054 ACTION can be `set', `up', `down', or a character."
14056 (if (equal action '(4))
14057 (org-show-priority)
14058 (unless org-enable-priority-commands
14059 (user-error "Priority commands are disabled"))
14060 (setq action (or action 'set))
14061 (let (current new news have remove)
14063 (org-back-to-heading t)
14064 (if (looking-at org-priority-regexp)
14065 (setq current (string-to-char (match-string 2))
14068 ((eq action 'remove)
14069 (setq remove t new ?\ ))
14070 ((or (eq action 'set)
14071 (if (featurep 'xemacs) (characterp action) (integerp action)))
14072 (if (not (eq action 'set))
14074 (message "Priority %c-%c, SPC to remove: "
14075 org-highest-priority org-lowest-priority)
14077 (setq new (read-char-exclusive))))
14078 (if (and (= (upcase org-highest-priority) org-highest-priority)
14079 (= (upcase org-lowest-priority) org-lowest-priority))
14080 (setq new (upcase new)))
14081 (cond ((equal new ?\ ) (setq remove t))
14082 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14083 (user-error "Priority must be between `%c' and `%c'"
14084 org-highest-priority org-lowest-priority))))
14087 (1- current) ; normal cycling
14088 ;; last priority was empty
14089 (if (eq last-command this-command)
14090 org-lowest-priority ; wrap around empty to lowest
14092 (if org-priority-start-cycle-with-default
14093 org-default-priority
14094 (1- org-default-priority))))))
14097 (1+ current) ; normal cycling
14098 ;; last priority was empty
14099 (if (eq last-command this-command)
14100 org-highest-priority ; wrap around empty to highest
14102 (if org-priority-start-cycle-with-default
14103 org-default-priority
14104 (1+ org-default-priority))))))
14105 (t (user-error "Invalid action")))
14106 (if (or (< (upcase new) org-highest-priority)
14107 (> (upcase new) org-lowest-priority))
14108 (if (and (memq action '(up down))
14109 (not have) (not (eq last-command this-command)))
14110 ;; `new' is from default priority
14112 "The default can not be set, see `org-default-priority' why")
14113 ;; normal cycling: `new' is beyond highest/lowest priority
14114 ;; and is wrapped around to the empty priority
14116 (setq news (format "%c" new))
14119 (replace-match "" t t nil 1)
14120 (replace-match news t t nil 2))
14122 (user-error "No priority cookie found in line")
14123 (let ((case-fold-search nil))
14124 (looking-at org-todo-line-regexp))
14127 (goto-char (match-end 2))
14128 (insert " [#" news "]"))
14129 (goto-char (match-beginning 3))
14130 (insert "[#" news "] "))))
14131 (org-set-tags nil 'align))
14133 (message "Priority removed")
14134 (message "Priority of current item set to %s" news)))))
14136 (defun org-show-priority ()
14137 "Show the priority of the current item.
14138 This priority is composed of the main priority given with the [#A] cookies,
14139 and by additional input from the age of a schedules or deadline entry."
14141 (let ((pri (if (eq major-mode 'org-agenda-mode)
14142 (org-get-at-bol 'priority)
14145 (beginning-of-line)
14146 (and (looking-at org-heading-regexp)
14147 (org-get-priority (match-string 0))))))))
14148 (message "Priority is %d" (if pri pri -1000))))
14150 (defun org-get-priority (s)
14151 "Find priority cookie and return priority."
14153 (if (functionp org-get-priority-function)
14154 (funcall org-get-priority-function)
14155 (if (not (string-match org-priority-regexp s))
14156 (* 1000 (- org-lowest-priority org-default-priority))
14157 (* 1000 (- org-lowest-priority
14158 (string-to-char (match-string 2 s))))))))
14162 (defvar org-agenda-archives-mode)
14163 (defvar org-map-continue-from nil
14164 "Position from where mapping should continue.
14165 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14167 (defvar org-scanner-tags nil
14168 "The current tag list while the tags scanner is running.")
14169 (defvar org-trust-scanner-tags nil
14170 "Should `org-get-tags-at' use the tags for the scanner.
14171 This is for internal dynamical scoping only.
14172 When this is non-nil, the function `org-get-tags-at' will return the value
14173 of `org-scanner-tags' instead of building the list by itself. This
14174 can lead to large speed-ups when the tags scanner is used in a file with
14175 many entries, and when the list of tags is retrieved, for example to
14176 obtain a list of properties. Building the tags list for each entry in such
14177 a file becomes an N^2 operation - but with this variable set, it scales
14180 (defun org-scan-tags (action matcher todo-only &optional start-level)
14181 "Scan headline tags with inheritance and produce output ACTION.
14183 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14184 or `agenda' to produce an entry list for an agenda view. It can also be
14185 a Lisp form or a function that should be called at each matched headline, in
14186 this case the return value is a list of all return values from these calls.
14188 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14189 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14190 only lines with a not-done TODO keyword are included in the output.
14191 This should be the same variable that was scoped into
14192 and set by `org-make-tags-matcher' when it constructed MATCHER.
14194 START-LEVEL can be a string with asterisks, reducing the scope to
14195 headlines matching this string."
14196 (require 'org-agenda)
14197 (let* ((re (concat "^"
14199 ;; Get the correct level to match
14200 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14201 org-outline-regexp)
14203 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14204 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14205 (props (list 'face 'default
14206 'done-face 'org-agenda-done
14207 'undone-face 'default
14208 'mouse-face 'highlight
14209 'org-not-done-regexp org-not-done-regexp
14210 'org-todo-regexp org-todo-regexp
14211 'org-complex-heading-regexp org-complex-heading-regexp
14213 (format "mouse-2 or RET jump to org file %s"
14214 (abbreviate-file-name
14215 (or (buffer-file-name (buffer-base-buffer))
14216 (buffer-name (buffer-base-buffer)))))))
14217 (org-map-continue-from nil)
14218 lspos tags tags-list
14219 (tags-alist (list (cons 0 org-file-tags)))
14220 (llast 0) rtn rtn1 level category i txt
14221 todo marker entry priority
14222 ts-date ts-date-type ts-date-pair)
14223 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14224 (setq action (list 'lambda nil action)))
14226 (goto-char (point-min))
14227 (when (eq action 'sparse-tree)
14229 (org-remove-occur-highlights))
14230 (while (let (case-fold-search)
14231 (re-search-forward re nil t))
14232 (setq org-map-continue-from nil)
14234 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14235 tags (if (match-end 4) (org-match-string-no-properties 4)))
14236 (goto-char (setq lspos (match-beginning 0)))
14237 (setq level (org-reduced-level (org-outline-level))
14238 category (org-get-category))
14239 (when (eq action 'agenda)
14240 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14241 ts-date (car ts-date-pair)
14242 ts-date-type (cdr ts-date-pair)))
14243 (setq i llast llast level)
14244 ;; remove tag lists from same and sublevels
14245 (while (>= i level)
14246 (when (setq entry (assoc i tags-alist))
14247 (setq tags-alist (delete entry tags-alist)))
14249 ;; add the next tags
14251 (setq tags (org-split-string tags ":")
14253 (cons (cons level tags) tags-alist)))
14254 ;; compile tags for current headline
14256 (if org-use-tag-inheritance
14257 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14259 org-scanner-tags tags-list)
14260 (when org-use-tag-inheritance
14261 (setcdr (car tags-alist)
14262 (mapcar (lambda (x)
14263 (setq x (copy-sequence x))
14264 (org-add-prop-inherited x))
14265 (cdar tags-alist))))
14266 (when (and tags org-use-tag-inheritance
14267 (or (not (eq t org-use-tag-inheritance))
14268 org-tags-exclude-from-inheritance))
14269 ;; selective inheritance, remove uninherited ones
14270 (setcdr (car tags-alist)
14271 (org-remove-uninherited-tags (cdar tags-alist))))
14274 ;; eval matcher only when the todo condition is OK
14275 (and (or (not todo-only) (member todo org-not-done-keywords))
14276 (let ((case-fold-search t) (org-trust-scanner-tags t))
14279 ;; Call the skipper, but return t if it does not skip,
14280 ;; so that the `and' form continues evaluating
14282 (unless (eq action 'sparse-tree) (org-agenda-skip))
14285 ;; Check if timestamps are deselecting this entry
14286 (or (not todo-only)
14287 (and (member todo org-not-done-keywords)
14288 (or (not org-agenda-tags-todo-honor-ignore-options)
14289 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14291 ;; select this headline
14293 ((eq action 'sparse-tree)
14294 (and org-highlight-sparse-tree-matches
14295 (org-get-heading) (match-end 0)
14296 (org-highlight-new-match
14297 (match-beginning 1) (match-end 1)))
14298 (org-show-context 'tags-tree))
14299 ((eq action 'agenda)
14300 (setq txt (org-agenda-format-item
14303 (if (eq org-tags-match-list-sublevels 'indented)
14304 (make-string (1- level) ?.) "")
14306 (make-string level ?\s)
14309 priority (org-get-priority txt))
14311 (setq marker (org-agenda-new-marker))
14312 (org-add-props txt props
14313 'org-marker marker 'org-hd-marker marker 'org-category category
14317 'type (concat "tagsmatch" ts-date-type))
14319 ((functionp action)
14320 (setq org-map-continue-from nil)
14322 (setq rtn1 (funcall action))
14324 (t (user-error "Invalid action")))
14326 ;; if we are to skip sublevels, jump to end of subtree
14327 (unless org-tags-match-list-sublevels
14328 (org-end-of-subtree t)
14329 (backward-char 1))))
14330 ;; Get the correct position from where to continue
14331 (if org-map-continue-from
14332 (goto-char org-map-continue-from)
14333 (and (= (point) lspos) (end-of-line 1)))))
14334 (when (and (eq action 'sparse-tree)
14335 (not org-sparse-tree-open-archived-trees))
14336 (org-hide-archived-subtrees (point-min) (point-max)))
14339 (defun org-remove-uninherited-tags (tags)
14340 "Remove all tags that are not inherited from the list TAGS."
14342 ((eq org-use-tag-inheritance t)
14343 (if org-tags-exclude-from-inheritance
14344 (org-delete-all org-tags-exclude-from-inheritance tags)
14346 ((not org-use-tag-inheritance) nil)
14347 ((stringp org-use-tag-inheritance)
14350 (if (and (string-match org-use-tag-inheritance x)
14351 (not (member x org-tags-exclude-from-inheritance)))
14354 ((listp org-use-tag-inheritance)
14357 (if (member x org-use-tag-inheritance) x nil))
14360 (defun org-match-sparse-tree (&optional todo-only match)
14361 "Create a sparse tree according to tags string MATCH.
14362 MATCH can contain positive and negative selection of tags, like
14363 \"+WORK+URGENT-WITHBOSS\".
14364 If optional argument TODO-ONLY is non-nil, only select lines that are
14367 (org-agenda-prepare-buffers (list (current-buffer)))
14368 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14370 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14372 (defvar org-cached-props nil)
14373 (defun org-cached-entry-get (pom property)
14374 (if (or (eq t org-use-property-inheritance)
14375 (and (stringp org-use-property-inheritance)
14376 (let ((case-fold-search t))
14377 (org-string-match-p org-use-property-inheritance property)))
14378 (and (listp org-use-property-inheritance)
14379 (member-ignore-case property org-use-property-inheritance)))
14380 ;; Caching is not possible, check it directly.
14381 (org-entry-get pom property 'inherit)
14382 ;; Get all properties, so we can do complicated checks easily.
14383 (cdr (assoc-string property
14384 (or org-cached-props
14385 (setq org-cached-props (org-entry-properties pom)))
14388 (defun org-global-tags-completion-table (&optional files)
14389 "Return the list of all tags in all agenda buffer/files.
14390 Optional FILES argument is a list of files which can be used
14391 instead of the agenda files."
14398 (set-buffer (find-file-noselect file))
14399 (append (org-get-buffer-tags)
14400 (mapcar (lambda (x) (if (stringp (car-safe x))
14401 (list (car-safe x)) nil))
14403 (if (and files (car files))
14405 (org-agenda-files))))))))
14407 (defun org-make-tags-matcher (match)
14408 "Create the TAGS/TODO matcher form for the selection string MATCH.
14410 The variable `todo-only' is scoped dynamically into this function.
14411 It will be set to t if the matcher restricts matching to TODO entries,
14412 otherwise will not be touched.
14414 Returns a cons of the selection string MATCH and the constructed
14415 lisp form implementing the matcher. The matcher is to be evaluated
14416 at an Org entry, with point on the headline, and returns t if the
14417 entry matches the selection string MATCH. The returned lisp form
14418 references two variables with information about the entry, which
14419 must be bound around the form's evaluation: todo, the TODO keyword
14420 at the entry (or nil of none); and tags-list, the list of all tags
14421 at the entry including inherited ones. Additionally, the category
14422 of the entry (if any) must be specified as the text property
14423 'org-category on the headline.
14425 See also `org-scan-tags'.
14427 (declare (special todo-only))
14428 (unless (boundp 'todo-only)
14429 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14431 ;; Get a new match request, with completion against the global
14432 ;; tags table and the local tags in current buffer
14433 (let ((org-last-tags-completion-table
14435 (delq nil (append (org-get-buffer-tags)
14436 (org-global-tags-completion-table))))))
14437 (setq match (org-completing-read-no-i
14438 "Match: " 'org-tags-completion-function nil nil nil
14439 'org-tags-history))))
14441 ;; Parse the string and create a lisp form
14442 (let ((match0 match)
14443 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14445 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14446 orterms term orlist re-p str-p level-p level-op time-p
14447 prop-p pn pv po gv rest (start 0) (ss 0))
14448 ;; Expand group tags
14449 (setq match (org-tags-expand match))
14451 ;; Check if there is a TODO part of this match, which would be the
14452 ;; part after a "/". TO make sure that this slash is not part of
14453 ;; a property value to be matched against, we also check that there
14454 ;; is no " after that slash.
14455 ;; First, find the last slash
14456 (while (string-match "/+" match ss)
14457 (setq start (match-beginning 0) ss (match-end 0)))
14458 (if (and (string-match "/+" match start)
14459 (not (save-match-data (string-match "\"" match start))))
14460 ;; match contains also a todo-matching request
14462 (setq tagsmatch (substring match 0 (match-beginning 0))
14463 todomatch (substring match (match-end 0)))
14464 (if (string-match "^!" todomatch)
14465 (setq todo-only t todomatch (substring todomatch 1)))
14466 (if (string-match "^\\s-*$" todomatch)
14467 (setq todomatch nil)))
14468 ;; only matching tags
14469 (setq tagsmatch match todomatch nil))
14471 ;; Make the tags matcher
14472 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14473 (setq tagsmatcher t)
14474 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14475 (while (setq term (pop orterms))
14476 (while (and (equal (substring term -1) "\\") orterms)
14477 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14478 (while (string-match re term)
14479 (setq rest (substring term (match-end 0))
14480 minus (and (match-end 1)
14481 (equal (match-string 1 term) "-"))
14482 tag (save-match-data (replace-regexp-in-string
14484 (match-string 2 term)))
14485 re-p (equal (string-to-char tag) ?{)
14486 level-p (match-end 4)
14487 prop-p (match-end 5)
14489 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14491 (setq level-op (org-op-to-function (match-string 3 term)))
14492 `(,level-op level ,(string-to-number
14493 (match-string 4 term))))
14495 (setq pn (match-string 5 term)
14496 po (match-string 6 term)
14497 pv (match-string 7 term)
14498 re-p (equal (string-to-char pv) ?{)
14499 str-p (equal (string-to-char pv) ?\")
14500 time-p (save-match-data
14501 (string-match "^\"[[<].*[]>]\"$" pv))
14502 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14503 (if time-p (setq pv (org-matcher-time pv)))
14504 (setq po (org-op-to-function po (if time-p 'time str-p)))
14506 ((equal pn "CATEGORY")
14507 (setq gv '(get-text-property (point) 'org-category)))
14511 (setq gv `(org-cached-entry-get nil ,pn))))
14514 `(not (string-match ,pv (or ,gv "")))
14515 `(string-match ,pv (or ,gv "")))
14517 `(,po (or ,gv "") ,pv)
14518 `(,po (string-to-number (or ,gv ""))
14519 ,(string-to-number pv) ))))
14520 (t `(member ,tag tags-list)))
14521 mm (if minus (list 'not mm) mm)
14523 (push mm tagsmatcher))
14524 (push (if (> (length tagsmatcher) 1)
14525 (cons 'and tagsmatcher)
14528 (setq tagsmatcher nil))
14529 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14531 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14532 ;; Make the todo matcher
14533 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14534 (setq todomatcher t)
14535 (setq orterms (org-split-string todomatch "|") orlist nil)
14536 (while (setq term (pop orterms))
14537 (while (string-match re term)
14538 (setq minus (and (match-end 1)
14539 (equal (match-string 1 term) "-"))
14540 kwd (match-string 2 term)
14541 re-p (equal (string-to-char kwd) ?{)
14542 term (substring term (match-end 0))
14544 `(string-match ,(substring kwd 1 -1) todo)
14545 (list 'equal 'todo kwd))
14546 mm (if minus (list 'not mm) mm))
14547 (push mm todomatcher))
14548 (push (if (> (length todomatcher) 1)
14549 (cons 'and todomatcher)
14552 (setq todomatcher nil))
14553 (setq todomatcher (if (> (length orlist) 1)
14554 (cons 'or orlist) (car orlist))))
14556 ;; Return the string and lisp forms of the matcher
14557 (setq matcher (if todomatcher
14558 (list 'and tagsmatcher todomatcher)
14561 (setq matcher (list 'and '(member todo org-not-done-keywords)
14563 (cons match0 matcher)))
14565 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14566 "Expand group tags in MATCH.
14568 This replaces every group tag in MATCH with a regexp tag search.
14569 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14570 will be replaced like this:
14572 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14573 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14574 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14576 Replacing by a regexp preserves the structure of the match.
14577 E.g., this expansion
14579 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14581 will match anything tagged with \"Lab\" and \"Home\", or tagged
14582 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14584 A group tag in MATCH can contain regular expressions of its own.
14585 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14586 will be replaced like this:
14588 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14590 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14591 assumed to be a single group tag, and the function will return
14592 the list of tags in this group.
14594 When DOWNCASE is non-nil, expand downcased TAGS."
14596 (let* ((case-fold-search t)
14597 (stable org-mode-syntax-table)
14598 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14599 (taggroups (if downcased
14600 (mapcar (lambda (tg) (mapcar #'downcase tg))
14603 (taggroups-keys (mapcar #'car taggroups))
14604 (return-match (if downcased (downcase match) match))
14606 (work-already-expanded tags-already-expanded)
14607 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14608 ;; @ and _ are allowed as word-components in tags.
14609 (modify-syntax-entry ?@ "w" stable)
14610 (modify-syntax-entry ?_ "w" stable)
14611 ;; Temporarily replace regexp-expressions in the match-expression.
14612 (while (string-match "{.+?}" return-match)
14614 (push (match-string 0 return-match) regexps-in-match)
14615 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14616 (while (and taggroups-keys
14617 (with-syntax-table stable
14619 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14620 (regexp-opt taggroups-keys) "\\>\\)") return-match)))
14621 (let* ((dir (match-string 1 return-match))
14622 (tag (match-string 2 return-match))
14623 (tag (if downcased (downcase tag) tag)))
14624 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14625 (member tag work-already-expanded))
14626 (setq tags-in-group (assoc tag taggroups))
14627 (push tag work-already-expanded)
14628 ;; Recursively expand each tag in the group, if the tag hasn't
14629 ;; already been expanded. Restore the match-data after all recursive calls.
14631 (let (tags-expanded)
14632 (dolist (x (cdr tags-in-group))
14633 (if (and (member x taggroups-keys)
14634 (not (member x work-already-expanded)))
14635 (setq tags-expanded
14638 (org-tags-expand x t downcased
14639 work-already-expanded)
14641 (setq tags-expanded
14642 (append (list x) tags-expanded)))
14643 (setq work-already-expanded
14645 (append tags-expanded
14646 work-already-expanded))))
14647 (setq tags-in-group
14648 (delete-dups (cons (car tags-in-group)
14650 ;; Filter tag-regexps from tags.
14651 (setq regexp-in-group-escaped
14652 (delq nil (mapcar (lambda (x)
14654 (and (equal "{" (substring x 0 1))
14655 (equal "}" (substring x -1))
14660 (mapcar (lambda (x)
14661 (substring x 1 -1))
14662 regexp-in-group-escaped)
14664 (delq nil (mapcar (lambda (x)
14666 (and (not (equal "{" (substring x 0 1)))
14667 (not (equal "}" (substring x -1)))
14671 ;; If single-as-list, do no more in the while-loop.
14672 (if (not single-as-list)
14674 (when regexp-in-group
14675 (setq regexp-in-group
14677 (mapconcat 'identity regexp-in-group
14679 (setq tags-in-group
14682 (regexp-opt tags-in-group)
14686 (when (stringp tags-in-group)
14687 (org-add-props tags-in-group '(grouptag t)))
14689 (replace-match tags-in-group t t return-match)))
14690 (setq tags-in-group
14691 (append regexp-in-group-escaped tags-in-group))))
14692 (setq taggroups-keys (delete tag taggroups-keys))))
14693 ;; Add the regular expressions back into the match-expression again.
14694 (while regexps-in-match
14695 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14696 (pop regexps-in-match)
14700 (if tags-in-group tags-in-group (list return-match))
14703 (list (if downcased (downcase match) match))
14706 (defun org-op-to-function (op &optional stringp)
14707 "Turn an operator into the appropriate function."
14710 ((equal op "<" ) '(< string< org-time<))
14711 ((equal op ">" ) '(> org-string> org-time>))
14712 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14713 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14714 ((member op '("=" "==")) '(= string= org-time=))
14715 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14716 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14718 (defun org<> (a b) (not (= a b)))
14719 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14720 (defun org-string>= (a b) (not (string< a b)))
14721 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14722 (defun org-string<> (a b) (not (string= a b)))
14723 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14724 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14725 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14726 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14727 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14728 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14730 "Convert S to a floating point time.
14731 If S is already a number, just return it. If it is a string, parse
14732 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14736 (condition-case nil
14737 (float-time (apply 'encode-time (org-parse-time-string s)))
14741 (defun org-time-today ()
14742 "Time in seconds today at 0:00.
14743 Returns the float number of seconds since the beginning of the
14744 epoch to the beginning of today (00:00)."
14745 (float-time (apply 'encode-time
14746 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14748 (defun org-matcher-time (s)
14749 "Interpret a time comparison value."
14752 ((string= s "<now>") (float-time))
14753 ((string= s "<today>") (org-time-today))
14754 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14755 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14756 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14757 (+ (org-time-today)
14758 (* (string-to-number (match-string 1 s))
14759 (cdr (assoc (match-string 2 s)
14760 '(("d" . 86400.0) ("w" . 604800.0)
14761 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14764 (defun org-match-any-p (re list)
14765 "Does re match any element of list?"
14766 (setq list (mapcar (lambda (x) (string-match re x)) list))
14769 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14770 (defvar org-tags-overlay (make-overlay 1 1))
14771 (org-detach-overlay org-tags-overlay)
14773 (defun org-get-local-tags-at (&optional pos)
14774 "Get a list of tags defined in the current headline."
14775 (org-get-tags-at pos 'local))
14777 (defun org-get-local-tags ()
14778 "Get a list of tags defined in the current headline."
14779 (org-get-tags-at nil 'local))
14781 (defun org-get-tags-at (&optional pos local)
14782 "Get a list of all headline tags applicable at POS.
14783 POS defaults to point. If tags are inherited, the list contains
14784 the targets in the same sequence as the headlines appear, i.e.
14785 the tags of the current headline come last.
14786 When LOCAL is non-nil, only return tags from the current headline,
14787 ignore inherited ones."
14789 (if (and org-trust-scanner-tags
14790 (or (not pos) (equal pos (point)))
14793 (let (tags ltags lastpos parent)
14797 (goto-char (or pos (point)))
14800 (condition-case nil
14802 (org-back-to-heading t)
14803 (while (not (equal lastpos (point)))
14804 (setq lastpos (point))
14806 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14807 (setq ltags (org-split-string
14808 (org-match-string-no-properties 1) ":"))
14810 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14813 (org-remove-uninherited-tags ltags)
14816 (or org-use-tag-inheritance (throw 'done t))
14817 (if local (throw 'done t))
14818 (or (org-up-heading-safe) (error nil))
14823 (reverse (delete-dups
14825 (org-remove-uninherited-tags
14826 org-file-tags) tags)))))))))
14828 (defun org-add-prop-inherited (s)
14829 (add-text-properties 0 (length s) '(inherited t) s)
14832 (defun org-toggle-tag (tag &optional onoff)
14833 "Toggle the tag TAG for the current line.
14834 If ONOFF is `on' or `off', don't toggle but set to this state."
14837 (org-back-to-heading t)
14838 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14841 (setq current (match-string 1))
14842 (replace-match ""))
14844 (setq current (nreverse (org-split-string current ":")))
14848 (or (member tag current) (push tag current)))
14850 (or (not (member tag current)) (setq current (delete tag current))))
14851 (t (if (member tag current)
14852 (setq current (delete tag current))
14854 (push tag current))))
14858 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14859 (org-set-tags nil t))
14860 (delete-horizontal-space))
14861 (run-hooks 'org-after-tags-change-hook))
14864 (defun org-align-tags-here (to-col)
14865 ;; Assumes that this is a headline
14866 "Align tags on the current headline to TO-COL."
14867 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14868 (beginning-of-line 1)
14869 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14870 (< pos (match-beginning 2)))
14872 (setq tags-l (- (match-end 2) (match-beginning 2)))
14873 (goto-char (match-beginning 1))
14875 (delete-region (point) (1+ (match-beginning 2)))
14876 (setq ncol (max (current-column)
14880 (- (abs to-col) tags-l))))
14882 (insert (make-string (- ncol (current-column)) ?\ ))
14883 (setq ncol (current-column))
14884 (when indent-tabs-mode (tabify p (point-at-eol)))
14885 (org-move-to-column (min ncol col)))
14888 (defun org-set-tags-command (&optional arg just-align)
14889 "Call the set-tags command for the current entry."
14891 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14892 (org-set-tags arg just-align)
14894 (unless (and (org-region-active-p)
14895 org-loop-over-headlines-in-active-region)
14896 (org-back-to-heading t))
14897 (org-set-tags arg just-align))))
14899 (defun org-set-tags-to (data)
14900 "Set the tags of the current entry to DATA, replacing the current tags.
14901 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14902 If DATA is nil or the empty string, any tags will be removed."
14903 (interactive "sTags: ")
14907 ((equal data "") "")
14909 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14912 (concat ":" (mapconcat 'identity data ":") ":"))))
14915 (org-back-to-heading t)
14916 (when (looking-at org-complex-heading-regexp)
14919 (goto-char (match-beginning 5))
14921 (delete-region (point) (point-at-eol))
14922 (org-set-tags nil 'align))
14923 (goto-char (point-at-eol))
14925 (org-set-tags nil 'align)))
14926 (beginning-of-line 1)
14927 (if (looking-at ".*?\\([ \t]+\\)$")
14928 (delete-region (match-beginning 1) (match-end 1))))))
14930 (defun org-align-all-tags ()
14931 "Align the tags i all headings."
14934 (or (ignore-errors (org-back-to-heading t))
14935 (outline-next-heading))
14936 (if (org-at-heading-p)
14938 (message "No headings"))))
14940 (defvar org-indent-indentation-per-level)
14941 (defun org-set-tags (&optional arg just-align)
14942 "Set the tags for the current headline.
14943 With prefix ARG, realign all tags in headings in the current buffer.
14944 When JUST-ALIGN is non-nil, only align tags."
14946 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14947 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14948 'region-start-level
14950 org-loop-over-headlines-in-active-region)
14952 ;; We don't use ARG and JUST-ALIGN here because these args
14953 ;; are not useful when looping over headlines.
14955 org-loop-over-headlines-in-active-region
14957 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
14958 (let ((org-setting-tags t))
14961 (goto-char (point-min))
14962 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14963 (while (re-search-forward org-outline-regexp-bol nil t)
14964 (org-set-tags nil t)
14966 (message "All tags realigned to column %d" org-tags-column))
14967 (let* ((current (org-get-tags-string))
14968 (col (current-column))
14970 (if just-align current
14971 ;; Get a new set of tags from the user.
14975 org-last-tags-completion-table
14977 org-tag-persistent-alist
14978 (or org-tag-alist (org-get-buffer-tags))
14980 org-complete-tags-always-offer-all-agenda-tags
14981 (org-global-tags-completion-table
14982 (org-agenda-files))))))
14983 (current-tags (org-split-string current ":"))
14985 (nreverse (nthcdr (length current-tags)
14986 (nreverse (org-get-tags-at))))))
14987 (replace-regexp-in-string
14990 (if (or (eq t org-use-fast-tag-selection)
14991 (and org-use-fast-tag-selection
14992 (delq nil (mapcar #'cdr table))))
14993 (org-fast-tag-selection
14994 current-tags inherited-tags table
14995 (and org-fast-tag-selection-include-todo
14996 org-todo-key-alist))
14997 (let ((org-add-colon-after-tag-completion
14998 (< 1 (length table))))
15002 #'org-tags-completion-function
15003 nil nil current 'org-tags-history))))))))))
15005 (when org-tags-sort-function
15009 (sort (org-split-string tags (org-re "[^[:alnum:]_@#%]+"))
15010 org-tags-sort-function)
15013 (if (not (org-string-nw-p tags)) (setq tags "")
15014 (unless (string-match ":\\'" tags) (setq tags (concat tags ":")))
15015 (unless (string-match "\\`:" tags) (setq tags (concat ":" tags))))
15017 ;; Insert new tags at the correct column
15018 (beginning-of-line)
15019 (let ((level (if (looking-at org-outline-regexp)
15020 (- (match-end 0) (point) 1)
15023 ((and (equal current "") (equal tags "")))
15024 ((re-search-forward
15025 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15026 (line-end-position)
15028 (if (equal tags "") (replace-match "" t t)
15029 (goto-char (match-beginning 0))
15030 (let* ((c0 (current-column))
15031 ;; Compute offset for the case of org-indent-mode
15033 (di (if (org-bound-and-true-p org-indent-mode)
15034 (* (1- org-indent-indentation-per-level)
15037 (p0 (if (eq (char-before) ?*) (1+ (point)) (point)))
15038 (tc (+ org-tags-column
15039 (if (> org-tags-column 0) (- di) di)))
15042 (- (- tc) (string-width tags)))))
15043 (rpl (concat (make-string (max 0 (- c1 c0)) ?\s) tags)))
15044 (replace-match rpl t t)
15045 (when (and (not (featurep 'xemacs)) indent-tabs-mode)
15046 (tabify p0 (point))))))
15047 (t (error "Tags alignment failed"))))
15048 (org-move-to-column col))
15049 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15051 (defun org-change-tag-in-region (beg end tag off)
15052 "Add or remove TAG for each entry in the region.
15053 This works in the agenda, and also in an org-mode buffer."
15055 (list (region-beginning) (region-end)
15056 (let ((org-last-tags-completion-table
15057 (if (derived-mode-p 'org-mode)
15059 (delq nil (append (org-get-buffer-tags)
15060 (org-global-tags-completion-table))))
15061 (org-global-tags-completion-table))))
15062 (org-icompleting-read
15063 "Tag: " 'org-tags-completion-function nil nil nil
15064 'org-tags-history))
15066 (message "[s]et or
[r]emove? ")
15067 (equal (read-char-exclusive) ?r))))
15068 (if (fboundp 'deactivate-mark) (deactivate-mark))
15069 (let ((agendap (equal major-mode 'org-agenda-mode))
15070 l1 l2 m buf pos newhead (cnt 0))
15072 (setq l2 (1- (org-current-line)))
15074 (setq l1 (org-current-line))
15075 (loop for l from l1 to l2 do
15077 (setq m (get-text-property (point) 'org-hd-marker))
15078 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15080 (setq buf (if agendap (marker-buffer m) (current-buffer))
15081 pos (if agendap m (point)))
15082 (with-current-buffer buf
15086 (setq cnt (1+ cnt))
15087 (org-toggle-tag tag (if off 'off 'on))
15088 (setq newhead (org-get-heading)))))
15089 (and agendap (org-agenda-change-all-lines newhead m))))
15090 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15092 (defun org-tags-completion-function (string predicate &optional flag)
15093 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15094 (confirm (lambda (x) (stringp (car x)))))
15095 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15096 (setq s1 (match-string 1 string)
15097 s2 (match-string 2 string))
15098 (setq s1 "" s2 string))
15102 (setq rtn (try-completion s2 ctable confirm))
15105 (concat s1 s2 (substring rtn (length s2))
15106 (if (and org-add-colon-after-tag-completion
15107 (assoc rtn ctable))
15112 (all-completions s2 ctable confirm))
15115 (assoc s2 ctable)))))
15117 (defun org-fast-tag-insert (kwd tags face &optional end)
15118 "Insert KDW, and the TAGS, the latter with face FACE.
15120 (insert (format "%-12s" (concat kwd ":"))
15121 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15124 (defun org-fast-tag-show-exit (flag)
15127 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15128 (replace-match ""))
15131 (org-move-to-column (- (window-width) 19) t)
15132 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15134 (defun org-set-current-tags-overlay (current prefix)
15135 "Add an overlay to CURRENT tag with PREFIX."
15136 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15137 (if (featurep 'xemacs)
15138 (org-overlay-display org-tags-overlay (concat prefix s)
15139 'secondary-selection)
15140 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15141 (org-overlay-display org-tags-overlay (concat prefix s)))))
15143 (defvar org-last-tag-selection-key nil)
15144 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15145 "Fast tag selection with single keys.
15146 CURRENT is the current list of tags in the headline, INHERITED is the
15147 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15148 possibly with grouping information. TODO-TABLE is a similar table with
15149 TODO keywords, should these have keys assigned to them.
15150 If the keys are nil, a-z are automatically assigned.
15151 Returns the new tags string, or nil to not change the current settings."
15152 (let* ((fulltable (append table todo-table))
15153 (maxlen (apply 'max (mapcar
15155 (if (stringp (car x)) (string-width (car x)) 0))
15157 (buf (current-buffer))
15158 (expert (eq org-fast-tag-selection-single-key 'expert))
15160 (fwidth (+ maxlen 3 1 3))
15161 (ncol (/ (- (window-width) 4) fwidth))
15164 tg cnt e c char c1 c2 ntable tbl rtn
15165 ov-start ov-end ov-prefix
15166 (exit-after-next org-fast-tag-selection-single-key)
15167 (done-keywords org-done-keywords)
15168 groups ingroup intaggroup)
15170 (beginning-of-line 1)
15172 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15173 (setq ov-start (match-beginning 1)
15174 ov-end (match-end 1)
15176 (setq ov-start (1- (point-at-eol))
15177 ov-end (1+ ov-start))
15178 (skip-chars-forward "^\n\r")
15181 (buffer-substring (1- (point)) (point))
15182 (if (> (current-column) org-tags-column)
15184 (make-string (- org-tags-column (current-column)) ?\ ))))))
15185 (move-overlay org-tags-overlay ov-start ov-end)
15186 (save-window-excursion
15188 (set-buffer (get-buffer-create " *Org tags*"))
15189 (delete-other-windows)
15190 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15191 (org-switch-to-buffer-other-window " *Org tags*"))
15193 (org-set-local 'org-done-keywords done-keywords)
15194 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15195 (org-fast-tag-insert "Current" current c-face "\n\n")
15196 (org-fast-tag-show-exit exit-after-next)
15197 (org-set-current-tags-overlay current ov-prefix)
15198 (setq tbl fulltable char ?a cnt 0)
15199 (while (setq e (pop tbl))
15201 ((eq (car e) :startgroup)
15202 (push '() groups) (setq ingroup t)
15203 (unless (zerop cnt)
15206 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15207 ((eq (car e) :endgroup)
15208 (setq ingroup nil cnt 0)
15209 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15210 ((eq (car e) :startgrouptag)
15211 (setq intaggroup t)
15212 (unless (zerop cnt)
15216 ((eq (car e) :endgrouptag)
15217 (setq intaggroup nil cnt 0)
15219 ((equal e '(:newline))
15220 (unless (zerop cnt)
15224 (while (equal (car tbl) '(:newline))
15226 (setq tbl (cdr tbl)))))
15227 ((equal e '(:grouptags)) (insert " : "))
15229 (setq tg (copy-sequence (car e)) c2 nil)
15232 ;; automatically assign a character.
15233 (setq c1 (string-to-char
15234 (downcase (substring
15235 tg (if (= (string-to-char tg) ?@) 1 0)))))
15236 (if (or (rassoc c1 ntable) (rassoc c1 table))
15237 (while (or (rassoc char ntable) (rassoc char table))
15238 (setq char (1+ char)))
15240 (setq c (or c2 char)))
15241 (when ingroup (push tg (car groups)))
15242 (setq tg (org-add-props tg nil 'face
15244 ((not (assoc tg table))
15245 (org-get-todo-face tg))
15246 ((member tg current) c-face)
15247 ((member tg inherited) i-face))))
15248 (when (equal (caar tbl) :grouptags)
15249 (org-add-props tg nil 'face 'org-tag-group))
15250 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15251 (insert "[" c "] " tg (make-string
15252 (- fwidth 4 (length tg)) ?\ ))
15253 (push (cons tg c) ntable)
15254 (when (= (incf cnt) ncol)
15256 (when (or ingroup intaggroup) (insert " "))
15258 (setq ntable (nreverse ntable))
15260 (goto-char (point-min))
15261 (unless expert (org-fit-window-to-buffer))
15265 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15266 (if (not groups) "no " "")
15267 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15268 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15269 (setq org-last-tag-selection-key c)
15271 ((= c ?\r) (throw 'exit t))
15273 (setq groups (not groups))
15274 (goto-char (point-min))
15275 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15278 (org-fast-tag-show-exit
15279 (setq exit-after-next (not exit-after-next)))
15281 (delete-other-windows)
15282 (set-window-buffer (split-window-vertically) " *Org tags*")
15283 (org-switch-to-buffer-other-window " *Org tags*")
15284 (org-fit-window-to-buffer)))
15286 (and (= c ?q) (not (rassoc c ntable))))
15287 (org-detach-overlay org-tags-overlay)
15288 (setq quit-flag t))
15291 (when exit-after-next (setq exit-after-next 'now)))
15293 (condition-case nil
15294 (setq tg (org-icompleting-read
15297 (with-current-buffer buf
15298 (org-get-buffer-tags)))))
15299 (quit (setq tg "")))
15300 (when (string-match "\\S-" tg)
15301 (add-to-list 'buffer-tags (list tg))
15302 (if (member tg current)
15303 (setq current (delete tg current))
15304 (push tg current)))
15305 (when exit-after-next (setq exit-after-next 'now)))
15306 ((setq e (rassoc c todo-table) tg (car e))
15307 (with-current-buffer buf
15308 (save-excursion (org-todo tg)))
15309 (when exit-after-next (setq exit-after-next 'now)))
15310 ((setq e (rassoc c ntable) tg (car e))
15311 (if (member tg current)
15312 (setq current (delete tg current))
15313 (loop for g in groups do
15314 (when (member tg g)
15315 (dolist (x g) (setq current (delete x current)))))
15317 (when exit-after-next (setq exit-after-next 'now))))
15319 ;; Create a sorted list
15323 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15324 (when (eq exit-after-next 'now) (throw 'exit t))
15325 (goto-char (point-min))
15326 (beginning-of-line 2)
15327 (delete-region (point) (point-at-eol))
15328 (org-fast-tag-insert "Current" current c-face)
15329 (org-set-current-tags-overlay current ov-prefix)
15330 (while (re-search-forward
15331 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15332 (setq tg (match-string 1))
15333 (add-text-properties
15334 (match-beginning 1) (match-end 1)
15337 ((member tg current) c-face)
15338 ((member tg inherited) i-face)
15339 (t (get-text-property (match-beginning 1) 'face))))))
15340 (goto-char (point-min)))))
15341 (org-detach-overlay org-tags-overlay)
15343 (mapconcat 'identity current ":")
15346 (defun org-get-tags-string ()
15347 "Get the TAGS string in the current headline."
15348 (unless (org-at-heading-p t)
15349 (user-error "Not on a heading"))
15351 (beginning-of-line 1)
15352 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15353 (org-match-string-no-properties 1)
15356 (defun org-get-tags ()
15357 "Get the list of tags specified in the current headline."
15358 (org-split-string (org-get-tags-string) ":"))
15360 (defun org-get-buffer-tags ()
15361 "Get a table of all tags used in the buffer, for completion."
15362 (org-with-wide-buffer
15363 (goto-char (point-min))
15364 (let ((tag-re (concat org-outline-regexp-bol
15365 "\\(?:.*?[ \t]\\)?"
15366 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15368 (while (re-search-forward tag-re nil t)
15369 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15371 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15373 ;;;; The mapping API
15375 (defun org-map-entries (func &optional match scope &rest skip)
15376 "Call FUNC at each headline selected by MATCH in SCOPE.
15378 FUNC is a function or a lisp form. The function will be called without
15379 arguments, with the cursor positioned at the beginning of the headline.
15380 The return values of all calls to the function will be collected and
15381 returned as a list.
15383 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15384 does not need to preserve point. After evaluation, the cursor will be
15385 moved to the end of the line (presumably of the headline of the
15386 processed entry) and search continues from there. Under some
15387 circumstances, this may not produce the wanted results. For example,
15388 if you have removed (e.g. archived) the current (sub)tree it could
15389 mean that the next entry will be skipped entirely. In such cases, you
15390 can specify the position from where search should continue by making
15391 FUNC set the variable `org-map-continue-from' to the desired buffer
15394 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15395 Only headlines that are matched by this query will be considered during
15396 the iteration. When MATCH is nil or t, all headlines will be
15397 visited by the iteration.
15399 SCOPE determines the scope of this command. It can be any of:
15401 nil The current buffer, respecting the restriction if any
15402 tree The subtree started with the entry at point
15403 region The entries within the active region, if any
15405 The entries within the active region, but only those at
15406 the same level than the first one.
15407 file The current buffer, without restriction
15409 The current buffer, and any archives associated with it
15410 agenda All agenda files
15411 agenda-with-archives
15412 All agenda files with any archive files associated with them
15414 If this is a list, all files in the list will be scanned
15416 The remaining args are treated as settings for the skipping facilities of
15417 the scanner. The following items can be given here:
15419 archive skip trees with the archive tag
15420 comment skip trees with the COMMENT keyword
15421 function or Emacs Lisp form:
15422 will be used as value for `org-agenda-skip-function', so
15423 whenever the function returns a position, FUNC will not be
15424 called for that entry and search will continue from the
15427 If your function needs to retrieve the tags including inherited tags
15428 at the *current* entry, you can use the value of the variable
15429 `org-scanner-tags' which will be much faster than getting the value
15430 with `org-get-tags-at'. If your function gets properties with
15431 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15432 to t around the call to `org-entry-properties' to get the same speedup.
15433 Note that if your function moves around to retrieve tags and properties at
15434 a *different* entry, you cannot use these techniques."
15435 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15436 (not (org-region-active-p)))
15437 (let* ((org-agenda-archives-mode nil) ; just to make sure
15438 (org-agenda-skip-archived-trees (memq 'archive skip))
15439 (org-agenda-skip-comment-trees (memq 'comment skip))
15440 (org-agenda-skip-function
15441 (car (org-delete-all '(comment archive) skip)))
15442 (org-tags-match-list-sublevels t)
15443 (start-level (eq scope 'region-start-level))
15445 org-todo-keywords-for-agenda
15446 org-done-keywords-for-agenda
15447 org-todo-keyword-alist-for-agenda
15448 org-tag-alist-for-agenda
15452 ((eq match t) (setq matcher t))
15453 ((eq match nil) (setq matcher t))
15454 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15458 (cond ((eq scope 'tree)
15459 (org-back-to-heading t)
15460 (org-narrow-to-subtree)
15462 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15463 (org-region-active-p))
15464 ;; If needed, set start-level to a string like "2"
15467 (goto-char (region-beginning))
15468 (unless (org-at-heading-p) (outline-next-heading))
15469 (setq start-level (org-current-level))))
15470 (narrow-to-region (region-beginning)
15472 (goto-char (region-end))
15473 (unless (and (bolp) (org-at-heading-p))
15474 (outline-next-heading))
15480 (org-agenda-prepare-buffers
15481 (list (buffer-file-name (current-buffer))))
15482 (setq res (org-scan-tags func matcher todo-only start-level)))
15483 ;; Get the right scope
15485 ((and scope (listp scope) (symbolp (car scope)))
15486 (setq scope (eval scope)))
15487 ((eq scope 'agenda)
15488 (setq scope (org-agenda-files t)))
15489 ((eq scope 'agenda-with-archives)
15490 (setq scope (org-agenda-files t))
15491 (setq scope (org-add-archive-files scope)))
15493 (setq scope (list (buffer-file-name))))
15494 ((eq scope 'file-with-archives)
15495 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15496 (org-agenda-prepare-buffers scope)
15497 (while (setq file (pop scope))
15498 (with-current-buffer (org-find-base-buffer-visiting file)
15502 (goto-char (point-min))
15503 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15508 (defconst org-special-properties
15509 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15510 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15511 "The special properties valid in Org mode.
15512 These are properties that are not defined in the property drawer,
15513 but in some other way.")
15515 (defconst org-default-properties
15516 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15517 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15518 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15519 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15520 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15521 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15522 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15523 "Some properties that are used by Org mode for various purposes.
15524 Being in this list makes sure that they are offered for completion.")
15526 (defun org--update-property-plist (key val props)
15527 "Associate KEY to VAL in alist PROPS.
15528 Modifications are made by side-effect. Return new alist."
15529 (let* ((appending (string= (substring key -1) "+"))
15530 (key (if appending (substring key 0 -1) key))
15531 (old (assoc-string key props t)))
15532 (if (not old) (cons (cons key val) props)
15533 (setcdr old (if appending (concat (cdr old) " " val) val))
15536 (defun org-get-property-block (&optional beg force)
15537 "Return the (beg . end) range of the body of the property drawer.
15538 BEG is the beginning of the current subtree, or of the part
15539 before the first headline. If it is not given, it will be found.
15540 If the drawer does not exist, create it if FORCE is non-nil, or
15542 (org-with-wide-buffer
15543 (when beg (goto-char beg))
15544 (unless (org-before-first-heading-p)
15545 (let ((beg (cond (beg)
15546 ((or (not (featurep 'org-inlinetask))
15547 (org-inlinetask-in-task-p))
15548 (org-back-to-heading t))
15549 (t (org-with-limited-levels (org-back-to-heading t))))))
15551 (when (org-looking-at-p org-planning-line-re) (forward-line))
15552 (cond ((looking-at org-property-drawer-re)
15554 (cons (point) (progn (goto-char (match-end 0))
15555 (line-beginning-position))))
15558 (org-insert-property-drawer)
15559 (let ((pos (save-excursion (search-forward ":END:")
15560 (line-beginning-position))))
15561 (cons pos pos))))))))
15563 (defun org-at-property-p ()
15564 "Non-nil when point is inside a property drawer.
15565 See `org-property-re' for match data, if applicable."
15567 (beginning-of-line)
15568 (and (looking-at org-property-re)
15569 (let ((property-drawer (save-match-data (org-get-property-block))))
15570 (and property-drawer
15571 (>= (point) (car property-drawer))
15572 (< (point) (cdr property-drawer)))))))
15574 (defun org-property-action ()
15575 "Do an action on properties."
15577 (unless (org-at-property-p) (user-error "Not at a property"))
15578 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15579 (let ((c (read-char-exclusive)))
15581 (?s (call-interactively #'org-set-property))
15582 (?d (call-interactively #'org-delete-property))
15583 (?D (call-interactively #'org-delete-property-globally))
15584 (?c (call-interactively #'org-compute-property-at-point))
15585 (otherwise (user-error "No such property action %c" c)))))
15587 (defun org-inc-effort ()
15588 "Increment the value of the effort property in the current entry."
15590 (org-set-effort nil t))
15592 (defvar org-clock-effort) ; Defined in org-clock.el.
15593 (defvar org-clock-current-task) ; Defined in org-clock.el.
15594 (defun org-set-effort (&optional value increment)
15595 "Set the effort property of the current entry.
15596 With numerical prefix arg, use the nth allowed value, 0 stands for the
15597 10th allowed value.
15599 When INCREMENT is non-nil, set the property to the next allowed value."
15601 (if (equal value 0) (setq value 10))
15602 (let* ((completion-ignore-case t)
15603 (prop org-effort-property)
15604 (cur (org-entry-get nil prop))
15605 (allowed (org-property-get-allowed-values nil prop 'table))
15606 (existing (mapcar 'list (org-property-values prop)))
15607 (heading (nth 4 (org-heading-components)))
15610 ((stringp value) value)
15611 ((and allowed (integerp value))
15612 (or (car (nth (1- value) allowed))
15613 (car (org-last allowed))))
15614 ((and allowed increment)
15615 (or (caadr (member (list cur) allowed))
15616 (user-error "Allowed effort values are not set")))
15618 (message "Select 1-9,0, [RET%s]: %s"
15619 (if cur (concat "=" cur) "")
15620 (mapconcat 'car allowed " "))
15621 (setq rpl (read-char-exclusive))
15622 (if (equal rpl ?\r)
15624 (setq rpl (- rpl ?0))
15625 (if (equal rpl 0) (setq rpl 10))
15626 (if (and (> rpl 0) (<= rpl (length allowed)))
15627 (car (nth (1- rpl) allowed))
15628 (org-completing-read "Effort: " allowed nil))))
15630 (let (org-completion-use-ido org-completion-use-iswitchb)
15631 (org-completing-read
15632 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15633 (concat "[" cur "]") "")
15635 existing nil nil "" nil cur))))))
15636 (unless (equal (org-entry-get nil prop) val)
15637 (org-entry-put nil prop val))
15638 (org-refresh-property
15639 '((effort . identity)
15640 (effort-minutes . org-duration-string-to-minutes))
15642 (when (string= heading org-clock-current-task)
15643 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15644 (org-clock-update-mode-line))
15645 (message "%s is now %s" prop val)))
15647 (defun org-entry-properties (&optional pom which)
15648 "Get all properties of the current entry.
15650 When POM is a buffer position, get all properties from the entry
15653 This includes the TODO keyword, the tags, time strings for
15654 deadline, scheduled, and clocking, and any additional properties
15655 defined in the entry.
15657 If WHICH is nil or `all', get all properties. If WHICH is
15658 `special' or `standard', only get that subclass. If WHICH is
15659 a string, only get that property.
15661 Return value is an alist. Keys are properties, as upcased
15663 (org-with-point-at pom
15664 (when (and (derived-mode-p 'org-mode)
15665 (ignore-errors (org-back-to-heading t)))
15667 (let* ((beg (point))
15668 (specific (and (stringp which) (upcase which)))
15669 (which (cond ((not specific) which)
15670 ((member specific org-special-properties) 'special)
15673 ;; Get the special properties, like TODO and TAGS.
15674 (when (memq which '(nil all special))
15675 (when (or (not specific) (string= specific "CLOCKSUM"))
15676 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15678 (push (cons "CLOCKSUM"
15679 (org-columns-number-to-string
15680 (/ (float clocksum) 60.) 'add_times))
15682 (when specific (throw 'exit props)))
15683 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15684 (let ((clocksumt (get-text-property (point)
15685 :org-clock-minutes-today)))
15687 (push (cons "CLOCKSUM_T"
15688 (org-columns-number-to-string
15689 (/ (float clocksumt) 60.) 'add_times))
15691 (when specific (throw 'exit props)))
15692 (when (or (not specific) (string= specific "ITEM"))
15693 (when (looking-at org-complex-heading-regexp)
15696 (org-match-string-no-properties 1)
15697 (let ((title (org-match-string-no-properties 4)))
15698 (when (org-string-nw-p title)
15699 (concat " " (org-remove-tabs title))))))
15701 (when specific (throw 'exit props)))
15702 (when (or (not specific) (string= specific "TODO"))
15703 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15704 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15705 (when specific (throw 'exit props)))
15706 (when (or (not specific) (string= specific "PRIORITY"))
15707 (when (looking-at org-priority-regexp)
15708 (push (cons "PRIORITY" (org-match-string-no-properties 2))
15710 (when specific (throw 'exit props)))
15711 (when (or (not specific) (string= specific "FILE"))
15712 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15714 (when specific (throw 'exit props)))
15715 (when (or (not specific) (string= specific "TAGS"))
15716 (let ((value (org-string-nw-p (org-get-tags-string))))
15717 (when value (push (cons "TAGS" value) props)))
15718 (when specific (throw 'exit props)))
15719 (when (or (not specific) (string= specific "ALLTAGS"))
15720 (let ((value (org-get-tags-at)))
15722 (push (cons "ALLTAGS"
15723 (format ":%s:" (mapconcat #'identity value ":")))
15725 (when specific (throw 'exit props)))
15726 (when (or (not specific) (string= specific "BLOCKED"))
15727 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15728 (when specific (throw 'exit props)))
15729 (when (or (not specific)
15730 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15732 (when (org-looking-at-p org-planning-line-re)
15734 (let ((bol (line-beginning-position))
15735 ;; Backward compatibility: time keywords used to
15736 ;; be configurable (before 8.3). Make sure we
15737 ;; get the correct keyword.
15738 (key-assoc `(("CLOSED" . ,org-closed-string)
15739 ("DEADLINE" . ,org-deadline-string)
15740 ("SCHEDULED" . ,org-scheduled-string))))
15741 (dolist (pair (if specific (list (assoc specific key-assoc))
15744 (when (search-backward (cdr pair) bol t)
15745 (goto-char (match-end 0))
15746 (skip-chars-forward " \t")
15747 (and (looking-at org-ts-regexp-both)
15748 (push (cons (car pair)
15749 (org-match-string-no-properties 0))
15751 (when specific (throw 'exit props)))
15752 (when (or (not specific)
15753 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15756 (let ((regexp (cond
15757 ((string= specific "TIMESTAMP")
15759 ((string= specific "TIMESTAMP_IA")
15760 org-ts-regexp-inactive)
15761 ((assoc "TIMESTAMP_IA" ts)
15763 ((assoc "TIMESTAMP" ts)
15764 org-ts-regexp-inactive)
15765 (t org-ts-regexp-both))))
15767 (while (re-search-forward regexp end t)
15769 (let ((object (org-element-context)))
15770 ;; Accept to match timestamps in node
15771 ;; properties, too.
15772 (when (memq (org-element-type object)
15773 '(node-property timestamp))
15775 (org-element-property :type object)))
15777 ((and (memq type '(active active-range))
15778 (not (equal specific "TIMESTAMP_IA")))
15779 (unless (assoc "TIMESTAMP" ts)
15780 (push (cons "TIMESTAMP"
15781 (org-element-property
15782 :raw-value object))
15784 (when specific (throw 'exit ts))))
15785 ((and (memq type '(inactive inactive-range))
15786 (not (string= specific "TIMESTAMP")))
15787 (unless (assoc "TIMESTAMP_IA" ts)
15788 (push (cons "TIMESTAMP_IA"
15789 (org-element-property
15790 :raw-value object))
15792 (when specific (throw 'exit ts))))))
15793 ;; Both timestamp types are found,
15794 ;; move to next part.
15795 (when (= (length ts) 2) (throw 'next ts)))))
15798 ;; First look for timestamps within headline.
15799 (let ((ts (funcall find-ts (line-end-position) nil)))
15800 (if (= (length ts) 2) (setq props (nconc ts props))
15802 ;; Then find timestamps in the section, skipping
15804 (when (org-looking-at-p org-planning-line-re)
15806 (let ((end (save-excursion (outline-next-heading))))
15807 (setq props (nconc (funcall find-ts end ts) props))))))))
15808 ;; Get the standard properties, like :PROP:.
15809 (when (memq which '(nil all standard))
15810 ;; If we are looking after a specific property, delegate
15811 ;; to `org-entry-get', which is faster. However, make an
15812 ;; exception for "CATEGORY", since it can be also set
15813 ;; through keywords (i.e. #+CATEGORY).
15814 (if (and specific (not (equal specific "CATEGORY")))
15815 (let ((value (org-entry-get beg specific nil t)))
15816 (throw 'exit (and value (list (cons specific value)))))
15817 (let ((range (org-get-property-block beg)))
15819 (let ((end (cdr range)) seen-base)
15820 (goto-char (car range))
15821 ;; Unlike to `org--update-property-plist', we
15822 ;; handle the case where base values is found
15823 ;; after its extension. We also forbid standard
15824 ;; properties to be named as special properties.
15825 (while (re-search-forward org-property-re end t)
15826 (let* ((key (upcase (org-match-string-no-properties 2)))
15827 (extendp (org-string-match-p "\\+\\'" key))
15828 (key-base (if extendp (substring key 0 -1) key))
15829 (value (org-match-string-no-properties 3)))
15831 ((member-ignore-case key-base org-special-properties))
15834 (org--update-property-plist key value props)))
15835 ((member key seen-base))
15836 (t (push key seen-base)
15837 (let ((p (assoc-string key props t)))
15838 (if p (setcdr p (concat value " " (cdr p)))
15839 (push (cons key value) props))))))))))))
15840 (unless (assoc "CATEGORY" props)
15841 (push (cons "CATEGORY" (org-get-category beg)) props)
15842 (when (string= specific "CATEGORY") (throw 'exit props)))
15844 (append (get-text-property beg 'org-summaries) props))))))
15846 (defun org-property--local-values (property literal-nil)
15847 "Return value for PROPERTY in current entry.
15848 Value is a list whose care is the base value for PROPERTY and cdr
15849 a list of accumulated values. Return nil if neither is found in
15850 the entry. Also return nil when PROPERTY is set to \"nil\",
15851 unless LITERAL-NIL is non-nil."
15852 (let ((range (org-get-property-block)))
15854 (goto-char (car range))
15855 (let* ((case-fold-search t)
15860 (let ((v (and (re-search-forward
15861 (org-re-property property nil t) end t)
15862 (org-match-string-no-properties 3))))
15863 (list (if literal-nil v (org-not-nil v)))))))
15864 ;; Find additional values.
15865 (let* ((property+ (org-re-property (concat property "+") nil t)))
15866 (while (re-search-forward property+ end t)
15867 (push (org-match-string-no-properties 3) value)))
15868 ;; Return final values.
15869 (and (not (equal value '(nil))) (nreverse value))))))
15871 (defun org-entry-get (pom property &optional inherit literal-nil)
15872 "Get value of PROPERTY for entry or content at point-or-marker POM.
15874 If INHERIT is non-nil and the entry does not have the property,
15875 then also check higher levels of the hierarchy. If INHERIT is
15876 the symbol `selective', use inheritance only if the setting in
15877 `org-use-property-inheritance' selects PROPERTY for inheritance.
15879 If the property is present but empty, the return value is the
15880 empty string. If the property is not present at all, nil is
15881 returned. In any other case, return the value as a string.
15882 Search is case-insensitive.
15884 If LITERAL-NIL is set, return the string value \"nil\" as
15885 a string, do not interpret it as the list atom nil. This is used
15886 for inheritance when a \"nil\" value can supersede a non-nil
15887 value higher up the hierarchy."
15888 (org-with-point-at pom
15890 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15891 ;; We need a special property. Use `org-entry-properties' to
15892 ;; retrieve it, but specify the wanted property.
15893 (cdr (assoc-string property (org-entry-properties nil property))))
15895 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15896 (org-entry-get-with-inheritance property literal-nil))
15898 (let* ((local (org-property--local-values property literal-nil))
15899 (value (and local (mapconcat #'identity (delq nil local) " "))))
15900 (if literal-nil value (org-not-nil value)))))))
15902 (defun org-property-or-variable-value (var &optional inherit)
15903 "Check if there is a property fixing the value of VAR.
15904 If yes, return this value. If not, return the current value of the variable."
15905 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15906 (if (and prop (stringp prop) (string-match "\\S-" prop))
15908 (symbol-value var))))
15910 (defun org-entry-delete (pom property)
15911 "Delete PROPERTY from entry at point-or-marker POM.
15912 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15913 non-nil when a property was removed."
15914 (unless (member property org-special-properties)
15915 (org-with-point-at pom
15916 (let ((range (org-get-property-block)))
15918 (let* ((begin (car range))
15919 (origin (cdr range))
15920 (end (copy-marker origin))
15921 (re (org-re-property
15922 (concat (regexp-quote property) "\\+?") t t)))
15924 (while (re-search-forward re end t)
15925 (delete-region (match-beginning 0) (line-beginning-position 2)))
15926 ;; If drawer is empty, remove it altogether.
15927 (when (= begin end)
15928 (delete-region (line-beginning-position 0)
15929 (line-beginning-position 2)))
15930 ;; Return non-nil if some property was removed.
15931 (prog1 (/= end origin) (set-marker end nil))))))))
15933 ;; Multi-values properties are properties that contain multiple values
15934 ;; These values are assumed to be single words, separated by whitespace.
15935 (defun org-entry-add-to-multivalued-property (pom property value)
15936 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15937 (let* ((old (org-entry-get pom property))
15938 (values (and old (org-split-string old "[ \t]"))))
15939 (setq value (org-entry-protect-space value))
15940 (unless (member value values)
15941 (setq values (append values (list value)))
15942 (org-entry-put pom property
15943 (mapconcat 'identity values " ")))))
15945 (defun org-entry-remove-from-multivalued-property (pom property value)
15946 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15947 (let* ((old (org-entry-get pom property))
15948 (values (and old (org-split-string old "[ \t]"))))
15949 (setq value (org-entry-protect-space value))
15950 (when (member value values)
15951 (setq values (delete value values))
15952 (org-entry-put pom property
15953 (mapconcat 'identity values " ")))))
15955 (defun org-entry-member-in-multivalued-property (pom property value)
15956 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15957 (let* ((old (org-entry-get pom property))
15958 (values (and old (org-split-string old "[ \t]"))))
15959 (setq value (org-entry-protect-space value))
15960 (member value values)))
15962 (defun org-entry-get-multivalued-property (pom property)
15963 "Return a list of values in a multivalued property."
15964 (let* ((value (org-entry-get pom property))
15965 (values (and value (org-split-string value "[ \t]"))))
15966 (mapcar 'org-entry-restore-space values)))
15968 (defun org-entry-put-multivalued-property (pom property &rest values)
15969 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15970 VALUES should be a list of strings. Spaces will be protected."
15971 (org-entry-put pom property
15972 (mapconcat 'org-entry-protect-space values " "))
15973 (let* ((value (org-entry-get pom property))
15974 (values (and value (org-split-string value "[ \t]"))))
15975 (mapcar 'org-entry-restore-space values)))
15977 (defun org-entry-protect-space (s)
15978 "Protect spaces and newline in string S."
15979 (while (string-match " " s)
15980 (setq s (replace-match "%20" t t s)))
15981 (while (string-match "\n" s)
15982 (setq s (replace-match "%0A" t t s)))
15985 (defun org-entry-restore-space (s)
15986 "Restore spaces and newline in string S."
15987 (while (string-match "%20" s)
15988 (setq s (replace-match " " t t s)))
15989 (while (string-match "%0A" s)
15990 (setq s (replace-match "\n" t t s)))
15993 (defvar org-entry-property-inherited-from (make-marker)
15994 "Marker pointing to the entry from where a property was inherited.
15995 Each call to `org-entry-get-with-inheritance' will set this marker to the
15996 location of the entry where the inheritance search matched. If there was
15997 no match, the marker will point nowhere.
15998 Note that also `org-entry-get' calls this function, if the INHERIT flag
16001 (defun org-entry-get-with-inheritance (property &optional literal-nil)
16002 "Get PROPERTY of entry or content at point, search higher levels if needed.
16003 The search will stop at the first ancestor which has the property defined.
16004 If the value found is \"nil\", return nil to show that the property
16005 should be considered as undefined (this is the meaning of nil here).
16006 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16007 (move-marker org-entry-property-inherited-from nil)
16008 (org-with-wide-buffer
16012 (let ((v (org-property--local-values property literal-nil)))
16015 (concat (mapconcat #'identity (delq nil v) " ")
16020 (org-back-to-heading t)
16021 (move-marker org-entry-property-inherited-from (point))
16023 ((org-up-heading-safe))
16026 (cdr (or (assoc-string property org-file-properties t)
16027 (assoc-string property org-global-properties t)
16028 (assoc-string property org-global-properties-fixed t)))))
16029 (cond ((not global))
16030 (value (setq value (concat global " " value)))
16031 (t (setq value global))))
16032 (throw 'exit nil))))))
16033 (if literal-nil value (org-not-nil value)))))
16035 (defvar org-property-changed-functions nil
16036 "Hook called when the value of a property has changed.
16037 Each hook function should accept two arguments, the name of the property
16038 and the new value.")
16040 (defun org-entry-put (pom property value)
16041 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16043 If the value is nil, it is converted to the empty string. If
16044 it is not a string, an error is raised.
16046 PROPERTY can be any regular property (see
16047 `org-special-properties'). It can also be \"TODO\",
16048 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16050 For the last two properties, VALUE may have any of the special
16051 values \"earlier\" and \"later\". The function then increases or
16052 decreases scheduled or deadline date by one day."
16053 (cond ((null value) (setq value ""))
16054 ((not (stringp value)) (error "Properties values should be strings")))
16055 (org-with-point-at pom
16056 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16057 (org-back-to-heading t)
16058 (org-with-limited-levels (org-back-to-heading t)))
16059 (let ((beg (point)))
16061 ((equal property "TODO")
16062 (cond ((not (org-string-nw-p value)) (setq value 'none))
16063 ((not (member value org-todo-keywords-1))
16064 (user-error "\"%s\" is not a valid TODO state" value)))
16066 (org-set-tags nil 'align))
16067 ((equal property "PRIORITY")
16068 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16069 (org-set-tags nil 'align))
16070 ((equal property "SCHEDULED")
16072 (if (and (org-looking-at-p org-planning-line-re)
16074 org-scheduled-time-regexp (line-end-position) t))
16075 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16076 ((string= value "later") (org-timestamp-change 1 'day))
16077 ((string= value "") (org-schedule '(4)))
16078 (t (org-schedule nil value)))
16079 (if (member value '("earlier" "later" ""))
16080 (call-interactively #'org-schedule)
16081 (org-schedule nil value))))
16082 ((equal property "DEADLINE")
16084 (if (and (org-looking-at-p org-planning-line-re)
16086 org-deadline-time-regexp (line-end-position) t))
16087 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16088 ((string= value "later") (org-timestamp-change 1 'day))
16089 ((string= value "") (org-deadline '(4)))
16090 (t (org-deadline nil value)))
16091 (if (member value '("earlier" "later" ""))
16092 (call-interactively #'org-deadline)
16093 (org-deadline nil value))))
16094 ((member property org-special-properties)
16095 (error "The %s property cannot be set with `org-entry-put'" property))
16097 (let* ((range (org-get-property-block beg 'force))
16099 (case-fold-search t))
16100 (goto-char (car range))
16101 (if (re-search-forward (org-re-property property nil t) end t)
16102 (progn (delete-region (match-beginning 0) (match-end 0))
16103 (goto-char (match-beginning 0)))
16107 (insert ":" property ":")
16108 (when value (insert " " value))
16109 (org-indent-line)))))
16110 (run-hook-with-args 'org-property-changed-functions property value)))
16112 (defun org-buffer-property-keys (&optional specials defaults columns)
16113 "Get all property keys in the current buffer.
16115 When SPECIALS is non-nil, also list the special properties that
16116 reflect things like tags and TODO state.
16118 When DEFAULTS is non-nil, also include properties that has
16119 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16120 DESCRIPTION, LOCATION, and LOGGING and others.
16122 When COLUMNS in non-nil, also include property names given in
16123 COLUMN formats in the current buffer."
16124 (let ((case-fold-search t)
16126 (and specials org-special-properties)
16127 (and defaults (cons org-effort-property org-default-properties))
16129 (org-with-wide-buffer
16130 (goto-char (point-min))
16131 (while (re-search-forward org-property-start-re nil t)
16132 (let ((range (org-get-property-block)))
16135 (when (and (not (org-before-first-heading-p))
16136 (y-or-n-p (format "Malformed drawer at %d, repair?"
16137 (line-beginning-position))))
16138 (org-get-property-block nil t))
16140 (goto-char (car range))
16141 (let ((begin (car range))
16143 ;; Make sure that found property block is not located
16144 ;; before current point, as it would generate an infloop.
16145 ;; It can happen, for example, in the following
16152 ;; *************** Inlinetask
16157 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16158 (while (< (point) end)
16159 (let ((p (progn (looking-at org-property-re)
16160 (org-match-string-no-properties 2))))
16161 ;; Only add true property name, not extension symbol.
16162 (add-to-list 'props
16163 (if (not (org-string-match-p "\\+\\'" p)) p
16164 (substring p 0 -1))))
16166 (outline-next-heading)))
16168 (goto-char (point-min))
16169 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16170 (let ((element (org-element-at-point)))
16171 (when (memq (org-element-type element) '(keyword node-property))
16172 (let ((value (org-element-property :value element))
16174 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16175 (setq start (match-end 0))
16176 (let ((p (org-match-string-no-properties 1 value)))
16177 (unless (member-ignore-case p org-special-properties)
16178 (add-to-list 'props p))))))))))
16179 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16181 (defun org-property-values (key)
16182 "List all non-nil values of property KEY in current buffer."
16183 (org-with-wide-buffer
16184 (goto-char (point-min))
16185 (let ((case-fold-search t)
16186 (re (org-re-property key))
16188 (while (re-search-forward re nil t)
16189 (add-to-list 'values (org-entry-get (point) key)))
16192 (defun org-insert-property-drawer ()
16193 "Insert a property drawer into the current entry."
16194 (org-with-wide-buffer
16195 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16196 (org-back-to-heading t)
16197 (org-with-limited-levels (org-back-to-heading t)))
16199 (when (org-looking-at-p org-planning-line-re) (forward-line))
16200 (unless (org-looking-at-p org-property-drawer-re)
16201 (let ((inhibit-read-only t))
16202 (unless (bolp) (insert "\n"))
16203 (let ((begin (point)))
16204 (insert ":PROPERTIES:\n:END:\n")
16205 (org-indent-region begin (point)))))))
16207 (defun org-insert-drawer (&optional arg drawer)
16208 "Insert a drawer at point.
16210 When optional argument ARG is non-nil, insert a property drawer.
16212 Optional argument DRAWER, when non-nil, is a string representing
16213 drawer's name. Otherwise, the user is prompted for a name.
16215 If a region is active, insert the drawer around that region
16218 Point is left between drawer's boundaries."
16220 (let* ((drawer (if arg "PROPERTIES"
16221 (or drawer (read-from-minibuffer "Drawer: ")))))
16223 ;; With C-u, fall back on `org-insert-property-drawer'
16224 (arg (org-insert-property-drawer))
16225 ;; Check validity of suggested drawer's name.
16226 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16227 (user-error "Invalid drawer name"))
16228 ;; With an active region, insert a drawer at point.
16229 ((not (org-region-active-p))
16231 (unless (bolp) (insert "\n"))
16232 (insert (format ":%s:\n\n:END:\n" drawer))
16233 (forward-line -2)))
16234 ;; Otherwise, insert the drawer at point
16236 (let ((rbeg (region-beginning))
16237 (rend (copy-marker (region-end))))
16241 (beginning-of-line)
16242 (when (save-excursion
16243 (re-search-forward org-outline-regexp-bol rend t))
16244 (user-error "Drawers cannot contain headlines"))
16245 ;; Position point at the beginning of the first
16246 ;; non-blank line in region. Insert drawer's opening
16247 ;; there, then indent it.
16248 (org-skip-whitespace)
16249 (beginning-of-line)
16250 (insert ":" drawer ":\n")
16252 (indent-for-tab-command)
16253 ;; Move point to the beginning of the first blank line
16254 ;; after the last non-blank line in region. Insert
16255 ;; drawer's closing, then indent it.
16257 (skip-chars-backward " \r\t\n")
16259 (deactivate-mark t)
16260 (indent-for-tab-command)
16261 (unless (eolp) (insert "\n")))
16262 ;; Clear marker, whatever the outcome of insertion is.
16263 (set-marker rend nil)))))))
16265 (defvar org-property-set-functions-alist nil
16266 "Property set function alist.
16267 Each entry should have the following format:
16269 (PROPERTY . READ-FUNCTION)
16271 The read function will be called with the same argument as
16272 `org-completing-read'.")
16274 (defun org-set-property-function (property)
16275 "Get the function that should be used to set PROPERTY.
16276 This is computed according to `org-property-set-functions-alist'."
16277 (or (cdr (assoc property org-property-set-functions-alist))
16278 'org-completing-read))
16280 (defun org-read-property-value (property)
16281 "Read PROPERTY value from user."
16282 (let* ((completion-ignore-case t)
16283 (allowed (org-property-get-allowed-values nil property 'table))
16284 (cur (org-entry-get nil property))
16285 (prompt (concat property " value"
16286 (if (and cur (string-match "\\S-" cur))
16287 (concat " [" cur "]") "") ": "))
16288 (set-function (org-set-property-function property))
16290 (funcall set-function prompt allowed nil
16291 (not (get-text-property 0 'org-unrestricted
16293 (let (org-completion-use-ido org-completion-use-iswitchb)
16294 (funcall set-function prompt
16295 (mapcar 'list (org-property-values property))
16296 nil nil "" nil cur)))))
16299 (defvar org-last-set-property nil)
16300 (defvar org-last-set-property-value nil)
16301 (defun org-read-property-name ()
16302 "Read a property name."
16303 (let ((completion-ignore-case t)
16304 (default-prop (or (and (org-at-property-p)
16305 (org-match-string-no-properties 2))
16306 org-last-set-property)))
16307 (org-completing-read
16309 (if default-prop (concat " [" default-prop "]") "")
16311 (mapcar #'list (org-buffer-property-keys nil t t))
16312 nil nil nil nil default-prop)))
16314 (defun org-set-property-and-value (use-last)
16315 "Allow to set [PROPERTY]: [value] direction from prompt.
16316 When use-default, don't even ask, just use the last
16317 \"[PROPERTY]: [value]\" string from the history."
16319 (let* ((completion-ignore-case t)
16320 (pv (or (and use-last org-last-set-property-value)
16321 (org-completing-read
16322 "Enter a \"[Property]: [value]\" pair: "
16323 nil nil nil nil nil
16324 org-last-set-property-value)))
16326 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16327 (setq prop (match-string 1 pv)
16328 val (match-string 2 pv))
16329 (org-set-property prop val))))
16331 (defun org-set-property (property value)
16332 "In the current entry, set PROPERTY to VALUE.
16333 When called interactively, this will prompt for a property name, offering
16334 completion on existing and default properties. And then it will prompt
16335 for a value, offering completion either on allowed values (via an inherited
16336 xxx_ALL property) or on existing values in other instances of this property
16337 in the current file."
16338 (interactive (list nil nil))
16339 (let* ((property (or property (org-read-property-name)))
16340 (value (or value (org-read-property-value property)))
16341 (fn (cdr (assoc property org-properties-postprocess-alist))))
16342 (setq org-last-set-property property)
16343 (setq org-last-set-property-value (concat property ": " value))
16344 ;; Possibly postprocess the inserted value:
16345 (when fn (setq value (funcall fn value)))
16346 (unless (equal (org-entry-get nil property) value)
16347 (org-entry-put nil property value))))
16349 (defun org-find-property (property &optional value)
16350 "Find first entry in buffer that sets PROPERTY.
16352 When optional argument VALUE is non-nil, only consider an entry
16353 if it contains PROPERTY set to this value. If PROPERTY should be
16354 explicitly set to nil, use string \"nil\" for VALUE.
16356 Return position where the entry begins, or nil if there is no
16357 such entry. If narrowing is in effect, only search the visible
16358 part of the buffer."
16360 (goto-char (point-min))
16361 (let ((case-fold-search t)
16362 (re (org-re-property property nil (not value) value)))
16364 (while (re-search-forward re nil t)
16365 (when (if value (org-at-property-p)
16366 (org-entry-get (point) property nil t))
16367 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16369 (defun org-delete-property (property)
16370 "In the current entry, delete PROPERTY."
16372 (let* ((completion-ignore-case t)
16373 (cat (org-entry-get (point) "CATEGORY"))
16374 (props0 (org-entry-properties nil 'standard))
16375 (props (if cat props0
16376 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16377 (prop (if (< 1 (length props))
16378 (org-icompleting-read "Property: " props nil t)
16382 (message "No property to delete in this entry")
16383 (org-entry-delete nil property)
16384 (message "Property \"%s\" deleted" property)))
16386 (defun org-delete-property-globally (property)
16387 "Remove PROPERTY globally, from all entries.
16388 This function ignores narrowing, if any."
16390 (let* ((completion-ignore-case t)
16391 (prop (org-icompleting-read
16392 "Globally remove property: "
16393 (mapcar #'list (org-buffer-property-keys)))))
16395 (org-with-wide-buffer
16396 (goto-char (point-min))
16398 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16399 (while (re-search-forward re nil t)
16400 (when (org-entry-delete (point) property) (incf count)))
16401 (message "Property \"%s\" removed from %d entries" property count))))
16403 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16405 (defun org-compute-property-at-point ()
16406 "Compute the property at point.
16407 This looks for an enclosing column format, extracts the operator and
16408 then applies it to the property in the column format's scope."
16410 (unless (org-at-property-p)
16411 (user-error "Not at a property"))
16412 (let ((prop (org-match-string-no-properties 2)))
16413 (org-columns-get-format-and-top-level)
16414 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16415 (user-error "No operator defined for property %s" prop))
16416 (org-columns-compute prop)))
16418 (defvar org-property-allowed-value-functions nil
16419 "Hook for functions supplying allowed values for a specific property.
16420 The functions must take a single argument, the name of the property, and
16421 return a flat list of allowed values. If \":ETC\" is one of
16422 the values, this means that these values are intended as defaults for
16423 completion, but that other values should be allowed too.
16424 The functions must return nil if they are not responsible for this
16427 (defun org-property-get-allowed-values (pom property &optional table)
16428 "Get allowed values for the property PROPERTY.
16429 When TABLE is non-nil, return an alist that can directly be used for
16433 ((equal property "TODO")
16434 (setq vals (org-with-point-at pom
16435 (append org-todo-keywords-1 '("")))))
16436 ((equal property "PRIORITY")
16437 (let ((n org-lowest-priority))
16438 (while (>= n org-highest-priority)
16439 (push (char-to-string n) vals)
16441 ((equal property "CATEGORY"))
16442 ((member property org-special-properties))
16443 ((setq vals (run-hook-with-args-until-success
16444 'org-property-allowed-value-functions property)))
16446 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16447 (when (and vals (string-match "\\S-" vals))
16448 (setq vals (car (read-from-string (concat "(" vals ")"))))
16449 (setq vals (mapcar (lambda (x)
16450 (cond ((stringp x) x)
16451 ((numberp x) (number-to-string x))
16452 ((symbolp x) (symbol-name x))
16455 (when (member ":ETC" vals)
16456 (setq vals (remove ":ETC" vals))
16457 (org-add-props (car vals) '(org-unrestricted t)))
16458 (if table (mapcar 'list vals) vals)))
16460 (defun org-property-previous-allowed-value (&optional previous)
16461 "Switch to the next allowed value for this property."
16463 (org-property-next-allowed-value t))
16465 (defun org-property-next-allowed-value (&optional previous)
16466 "Switch to the next allowed value for this property."
16468 (unless (org-at-property-p)
16469 (user-error "Not at a property"))
16470 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16471 (key (match-string 2))
16472 (value (match-string 3))
16473 (allowed (or (org-property-get-allowed-values (point) key)
16474 (and (member value '("[ ]" "[-]" "[X]"))
16476 (heading (save-match-data (nth 4 (org-heading-components))))
16479 (user-error "Allowed values for this property have not been defined"))
16480 (if previous (setq allowed (reverse allowed)))
16481 (if (member value allowed)
16482 (setq nval (car (cdr (member value allowed)))))
16483 (setq nval (or nval (car allowed)))
16484 (if (equal nval value)
16485 (user-error "Only one allowed value for this property"))
16486 (org-at-property-p)
16487 (replace-match (concat " :" key ": " nval) t t)
16489 (beginning-of-line 1)
16490 (skip-chars-forward " \t")
16491 (when (equal prop org-effort-property)
16492 (org-refresh-property
16493 '((effort . identity)
16494 (effort-minutes . org-duration-string-to-minutes))
16496 (when (string= org-clock-current-task heading)
16497 (setq org-clock-effort nval)
16498 (org-clock-update-mode-line)))
16499 (run-hook-with-args 'org-property-changed-functions key nval)))
16501 (defun org-find-olp (path &optional this-buffer)
16502 "Return a marker pointing to the entry at outline path OLP.
16503 If anything goes wrong, throw an error.
16504 You can wrap this call to catch the error like this:
16506 (condition-case msg
16507 (org-mobile-locate-entry (match-string 4))
16508 (error (nth 1 msg)))
16510 The return value will then be either a string with the error message,
16511 or a marker if everything is OK.
16513 If THIS-BUFFER is set, the outline path does not contain a file,
16515 (let* ((file (if this-buffer buffer-file-name (pop path)))
16516 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16520 limit re end found pos heading cnt flevel)
16521 (unless buffer (error "File not found :%s" file))
16522 (with-current-buffer buffer
16526 (setq limit (point-max))
16527 (goto-char (point-min))
16528 (while (setq heading (pop path))
16529 (setq re (format org-complex-heading-regexp-format
16530 (regexp-quote heading)))
16531 (setq cnt 0 pos (point))
16532 (while (re-search-forward re end t)
16533 (setq level (- (match-end 1) (match-beginning 1)))
16534 (if (and (>= level lmin) (<= level lmax))
16535 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16536 (when (= cnt 0) (error "Heading not found on level %d: %s"
16538 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16541 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16542 (setq end (save-excursion (org-end-of-subtree t t))))
16543 (when (org-at-heading-p)
16544 (point-marker)))))))
16546 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16547 "Find node HEADING in BUFFER.
16548 Return a marker to the heading if it was found, or nil if not.
16549 If POS-ONLY is set, return just the position instead of a marker.
16551 The heading text must match exact, but it may have a TODO keyword,
16552 a priority cookie and tags in the standard locations."
16553 (with-current-buffer (or buffer (current-buffer))
16557 (goto-char (point-min))
16558 (let (case-fold-search)
16559 (if (re-search-forward
16560 (format org-complex-heading-regexp-format
16561 (regexp-quote heading)) nil t)
16563 (match-beginning 0)
16564 (move-marker (make-marker) (match-beginning 0)))))))))
16566 (defun org-find-exact-heading-in-directory (heading &optional dir)
16567 "Find Org node headline HEADING in all .org files in directory DIR.
16568 When the target headline is found, return a marker to this location."
16569 (let ((files (directory-files (or dir default-directory)
16570 t "\\`[^.#].*\\.org\\'"))
16571 file visiting m buffer)
16573 (while (setq file (pop files))
16574 (message "trying %s" file)
16575 (setq visiting (org-find-base-buffer-visiting file))
16576 (setq buffer (or visiting (find-file-noselect file)))
16577 (setq m (org-find-exact-headline-in-buffer
16579 (when (and (not m) (not visiting)) (kill-buffer buffer))
16580 (and m (throw 'found m))))))
16582 (defun org-find-entry-with-id (ident)
16583 "Locate the entry that contains the ID property with exact value IDENT.
16584 IDENT can be a string, a symbol or a number, this function will search for
16585 the string representation of it.
16586 Return the position where this entry starts, or nil if there is no such entry."
16587 (interactive "sID: ")
16589 ((stringp ident) ident)
16590 ((symbolp ident) (symbol-name ident))
16591 ((numberp ident) (number-to-string ident))
16592 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16593 (org-with-wide-buffer (org-find-property "ID" id))))
16597 (defvar org-last-changed-timestamp nil)
16598 (defvar org-last-inserted-timestamp nil
16599 "The last time stamp inserted with `org-insert-time-stamp'.")
16600 (defvar org-ts-what) ; dynamically scoped parameter
16602 (defun org-time-stamp (arg &optional inactive)
16603 "Prompt for a date/time and insert a time stamp.
16605 If the user specifies a time like HH:MM or if this command is
16606 called with at least one prefix argument, the time stamp contains
16607 the date and the time. Otherwise, only the date is included.
16609 All parts of a date not specified by the user are filled in from
16610 the timestamp at point, if any, or the current date/time
16613 If there is already a timestamp at the cursor, it is replaced.
16615 With two universal prefix arguments, insert an active timestamp
16616 with the current time without prompting the user.
16618 When called from lisp, the timestamp is inactive if INACTIVE is
16622 (cond ((org-at-date-range-p t)
16624 (goto-char (match-beginning 0))
16625 (looking-at (if inactive org-ts-regexp-both org-ts-regexp)))
16627 ((org-at-timestamp-p t) (match-string 0))))
16628 ;; Default time is either the timestamp at point or today.
16629 ;; When entering a range, only the range start is considered.
16630 (default-time (if (not ts) (current-time)
16631 (apply #'encode-time (org-parse-time-string ts))))
16632 (default-input (and ts (org-get-compact-tod ts)))
16634 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16635 (match-string 0 ts)))
16637 org-end-time-was-given
16639 (and (if (equal arg '(16)) (current-time)
16640 ;; Preserve `this-command' and `last-command'.
16641 (let ((this-command this-command)
16642 (last-command last-command))
16644 arg 'totime nil nil default-time default-input
16648 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16649 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16651 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16653 ;; Make sure we're on a timestamp. When in the middle of a date
16654 ;; range, move arbitrarily to range end.
16655 (unless (org-at-timestamp-p t)
16656 (skip-chars-forward "-")
16657 (org-at-timestamp-p t))
16659 (setq org-last-changed-timestamp
16660 (org-insert-time-stamp
16661 time (or org-time-was-given arg)
16662 inactive nil nil (list org-end-time-was-given)))
16665 (insert " " repeater)
16666 (setq org-last-changed-timestamp
16667 (concat (substring org-last-inserted-timestamp 0 -1)
16668 " " repeater ">")))
16669 (message "Timestamp updated"))
16670 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16671 (t (org-insert-time-stamp
16672 time (or org-time-was-given arg) inactive nil nil
16673 (list org-end-time-was-given))))))
16675 ;; FIXME: can we use this for something else, like computing time differences?
16676 (defun org-get-compact-tod (s)
16677 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16678 (let* ((t1 (match-string 1 s))
16679 (h1 (string-to-number (match-string 2 s)))
16680 (m1 (string-to-number (match-string 3 s)))
16681 (t2 (and (match-end 4) (match-string 5 s)))
16682 (h2 (and t2 (string-to-number (match-string 6 s))))
16683 (m2 (and t2 (string-to-number (match-string 7 s))))
16687 (setq dh (- h2 h1) dm (- m2 m1))
16688 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16689 (concat t1 "+" (number-to-string dh)
16690 (and (/= 0 dm) (format ":%02d" dm)))))))
16692 (defun org-time-stamp-inactive (&optional arg)
16693 "Insert an inactive time stamp.
16694 An inactive time stamp is enclosed in square brackets instead of angle
16695 brackets. It is inactive in the sense that it does not trigger agenda entries,
16696 does not link to the calendar and cannot be changed with the S-cursor keys.
16697 So these are more for recording a certain time/date."
16699 (org-time-stamp arg 'inactive))
16701 (defvar org-date-ovl (make-overlay 1 1))
16702 (overlay-put org-date-ovl 'face 'org-date-selected)
16703 (org-detach-overlay org-date-ovl)
16705 (defvar org-ans1) ; dynamically scoped parameter
16706 (defvar org-ans2) ; dynamically scoped parameter
16708 (defvar org-plain-time-of-day-regexp) ; defined below
16710 (defvar org-overriding-default-time nil) ; dynamically scoped
16711 (defvar org-read-date-overlay nil)
16712 (defvar org-dcst nil) ; dynamically scoped
16713 (defvar org-read-date-history nil)
16714 (defvar org-read-date-final-answer nil)
16715 (defvar org-read-date-analyze-futurep nil)
16716 (defvar org-read-date-analyze-forced-year nil)
16717 (defvar org-read-date-inactive)
16719 (defvar org-read-date-minibuffer-local-map
16720 (let* ((map (make-sparse-keymap)))
16721 (set-keymap-parent map minibuffer-local-map)
16722 (org-defkey map (kbd ".")
16723 (lambda () (interactive)
16724 ;; Are we at the beginning of the prompt?
16725 (if (looking-back "^[^:]+: ")
16726 (org-eval-in-calendar '(calendar-goto-today))
16728 (org-defkey map (kbd "C-.")
16729 (lambda () (interactive)
16730 (org-eval-in-calendar '(calendar-goto-today))))
16731 (org-defkey map [(meta shift left)]
16732 (lambda () (interactive)
16733 (org-eval-in-calendar '(calendar-backward-month 1))))
16734 (org-defkey map [(meta shift right)]
16735 (lambda () (interactive)
16736 (org-eval-in-calendar '(calendar-forward-month 1))))
16737 (org-defkey map [(meta shift up)]
16738 (lambda () (interactive)
16739 (org-eval-in-calendar '(calendar-backward-year 1))))
16740 (org-defkey map [(meta shift down)]
16741 (lambda () (interactive)
16742 (org-eval-in-calendar '(calendar-forward-year 1))))
16743 (org-defkey map [?\e (shift left)]
16744 (lambda () (interactive)
16745 (org-eval-in-calendar '(calendar-backward-month 1))))
16746 (org-defkey map [?\e (shift right)]
16747 (lambda () (interactive)
16748 (org-eval-in-calendar '(calendar-forward-month 1))))
16749 (org-defkey map [?\e (shift up)]
16750 (lambda () (interactive)
16751 (org-eval-in-calendar '(calendar-backward-year 1))))
16752 (org-defkey map [?\e (shift down)]
16753 (lambda () (interactive)
16754 (org-eval-in-calendar '(calendar-forward-year 1))))
16755 (org-defkey map [(shift up)]
16756 (lambda () (interactive)
16757 (org-eval-in-calendar '(calendar-backward-week 1))))
16758 (org-defkey map [(shift down)]
16759 (lambda () (interactive)
16760 (org-eval-in-calendar '(calendar-forward-week 1))))
16761 (org-defkey map [(shift left)]
16762 (lambda () (interactive)
16763 (org-eval-in-calendar '(calendar-backward-day 1))))
16764 (org-defkey map [(shift right)]
16765 (lambda () (interactive)
16766 (org-eval-in-calendar '(calendar-forward-day 1))))
16767 (org-defkey map "!"
16768 (lambda () (interactive)
16769 (org-eval-in-calendar '(diary-view-entries))
16771 (org-defkey map ">"
16772 (lambda () (interactive)
16773 (org-eval-in-calendar '(calendar-scroll-left 1))))
16774 (org-defkey map "<"
16775 (lambda () (interactive)
16776 (org-eval-in-calendar '(calendar-scroll-right 1))))
16777 (org-defkey map "\C-v"
16778 (lambda () (interactive)
16779 (org-eval-in-calendar
16780 '(calendar-scroll-left-three-months 1))))
16781 (org-defkey map "\M-v"
16782 (lambda () (interactive)
16783 (org-eval-in-calendar
16784 '(calendar-scroll-right-three-months 1))))
16786 "Keymap for minibuffer commands when using `org-read-date'.")
16789 (defvar org-defdecode)
16790 (defvar org-with-time)
16792 (defun org-read-date (&optional org-with-time to-time from-string prompt
16793 default-time default-input inactive)
16794 "Read a date, possibly a time, and make things smooth for the user.
16795 The prompt will suggest to enter an ISO date, but you can also enter anything
16796 which will at least partially be understood by `parse-time-string'.
16797 Unrecognized parts of the date will default to the current day, month, year,
16798 hour and minute. If this command is called to replace a timestamp at point,
16799 or to enter the second timestamp of a range, the default time is taken
16800 from the existing stamp. Furthermore, the command prefers the future,
16801 so if you are giving a date where the year is not given, and the day-month
16802 combination is already past in the current year, it will assume you
16803 mean next year. For details, see the manual. A few examples:
16805 3-2-5 --> 2003-02-05
16806 feb 15 --> currentyear-02-15
16807 2/15 --> currentyear-02-15
16808 sep 12 9 --> 2009-09-12
16809 12:45 --> today 12:45
16810 22 sept 0:34 --> currentyear-09-22 0:34
16811 12 --> currentyear-currentmonth-12
16812 Fri --> nearest Friday after today
16813 -Tue --> last Tuesday
16816 Furthermore you can specify a relative date by giving, as the *first* thing
16817 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16818 change in days weeks, months, years.
16819 With a single plus or minus, the date is relative to today. With a double
16820 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16821 +4d --> four days from today
16822 +4 --> same as above
16823 +2w --> two weeks from today
16824 ++5 --> five days from default date
16826 The function understands only English month and weekday abbreviations.
16828 While prompting, a calendar is popped up - you can also select the
16829 date with the mouse (button 1). The calendar shows a period of three
16830 months. To scroll it to other months, use the keys `>' and `<'.
16831 If you don't like the calendar, turn it off with
16832 \(setq org-read-date-popup-calendar nil)
16834 With optional argument TO-TIME, the date will immediately be converted
16835 to an internal time.
16836 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16837 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16838 still enter a time, and this function will inform the calling routine
16839 about this change. The calling routine may then choose to change the
16840 format used to insert the time stamp into the buffer to include the time.
16841 With optional argument FROM-STRING, read from this string instead from
16842 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16843 the time/date that is used for everything that is not specified by the
16845 (require 'parse-time)
16846 (let* ((org-time-stamp-rounding-minutes
16847 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16848 (org-dcst org-display-custom-times)
16849 (ct (org-current-time))
16850 (org-def (or org-overriding-default-time default-time ct))
16851 (org-defdecode (decode-time org-def))
16853 (when (< (nth 2 org-defdecode) org-extend-today-until)
16854 (setcar (nthcdr 2 org-defdecode) -1)
16855 (setcar (nthcdr 1 org-defdecode) 59)
16856 (setq org-def (apply 'encode-time org-defdecode)
16857 org-defdecode (decode-time org-def)))))
16858 (cur-frame (selected-frame))
16859 (mouse-autoselect-window nil) ; Don't let the mouse jump
16860 (calendar-frame-setup nil)
16861 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16862 (calendar-move-hook nil)
16863 (calendar-view-diary-initially-flag nil)
16864 (calendar-view-holidays-initially-flag nil)
16865 (timestr (format-time-string
16866 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16867 (prompt (concat (if prompt (concat prompt " ") "")
16868 (format "Date+time [%s]: " timestr)))
16869 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16872 (from-string (setq ans from-string))
16873 (org-read-date-popup-calendar
16875 (save-window-excursion
16877 (when (eq calendar-setup 'calendar-only)
16879 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16880 (select-frame cal-frame))
16881 (org-eval-in-calendar '(setq cursor-type nil) t)
16884 (calendar-forward-day (- (time-to-days org-def)
16885 (calendar-absolute-from-gregorian
16886 (calendar-current-date))))
16887 (org-eval-in-calendar nil t)
16888 (let* ((old-map (current-local-map))
16889 (map (copy-keymap calendar-mode-map))
16890 (minibuffer-local-map
16891 (copy-keymap org-read-date-minibuffer-local-map)))
16892 (org-defkey map (kbd "RET") 'org-calendar-select)
16893 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16894 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16897 (use-local-map map)
16898 (setq org-read-date-inactive inactive)
16899 (add-hook 'post-command-hook 'org-read-date-display)
16900 (setq org-ans0 (read-string prompt default-input
16901 'org-read-date-history nil))
16902 ;; org-ans0: from prompt
16903 ;; org-ans1: from mouse click
16904 ;; org-ans2: from calendar motion
16905 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16906 (remove-hook 'post-command-hook 'org-read-date-display)
16907 (use-local-map old-map)
16908 (when org-read-date-overlay
16909 (delete-overlay org-read-date-overlay)
16910 (setq org-read-date-overlay nil)))))
16911 (bury-buffer "*Calendar*")
16913 (delete-frame cal-frame)
16914 (select-frame-set-input-focus cur-frame))))))
16916 (t ; Naked prompt only
16918 (setq ans (read-string prompt default-input
16919 'org-read-date-history timestr))
16920 (when org-read-date-overlay
16921 (delete-overlay org-read-date-overlay)
16922 (setq org-read-date-overlay nil)))))
16924 (setq final (org-read-date-analyze ans org-def org-defdecode))
16926 (when org-read-date-analyze-forced-year
16927 (message "Year was forced into %s"
16928 (if org-read-date-force-compatible-dates
16929 "compatible range (1970-2037)"
16930 "range representable on this machine"))
16933 ;; One round trip to get rid of 34th of August and stuff like that....
16934 (setq final (decode-time (apply 'encode-time final)))
16936 (setq org-read-date-final-answer ans)
16939 (apply 'encode-time final)
16940 (if (and (boundp 'org-time-was-given) org-time-was-given)
16941 (format "%04d-%02d-%02d %02d:%02d"
16942 (nth 5 final) (nth 4 final) (nth 3 final)
16943 (nth 2 final) (nth 1 final))
16944 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16946 (defun org-read-date-display ()
16947 "Display the current date prompt interpretation in the minibuffer."
16948 (when org-read-date-display-live
16949 (when org-read-date-overlay
16950 (delete-overlay org-read-date-overlay))
16951 (when (minibufferp (current-buffer))
16954 (while (not (equal (buffer-substring
16955 (max (point-min) (- (point) 4)) (point))
16958 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16959 " " (or org-ans1 org-ans2)))
16960 (org-end-time-was-given nil)
16961 (f (org-read-date-analyze ans org-def org-defdecode))
16963 org-time-stamp-custom-formats
16964 org-time-stamp-formats))
16965 (fmt (if (or org-with-time
16966 (and (boundp 'org-time-was-given) org-time-was-given))
16969 (txt (format-time-string fmt (apply 'encode-time f)))
16970 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16971 (txt (concat "=> " txt)))
16972 (when (and org-end-time-was-given
16973 (string-match org-plain-time-of-day-regexp txt))
16974 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16975 org-end-time-was-given
16976 (substring txt (match-end 0)))))
16977 (when org-read-date-analyze-futurep
16978 (setq txt (concat txt " (=>F)")))
16979 (setq org-read-date-overlay
16980 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16981 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16983 (defun org-read-date-analyze (ans org-def org-defdecode)
16984 "Analyze the combined answer of the date prompt."
16985 ;; FIXME: cleanup and comment
16986 ;; Pass `current-time' result to `decode-time' (instead of calling
16987 ;; without arguments) so that only `current-time' has to be
16988 ;; overriden in tests.
16989 (let ((nowdecode (decode-time (current-time)))
16990 delta deltan deltaw deltadef year month day
16991 hour minute second wday pm h2 m2 tl wday1
16992 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16993 (setq org-read-date-analyze-futurep nil
16994 org-read-date-analyze-forced-year nil)
16995 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16998 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16999 (setq ans (replace-match "" t t ans)
17001 deltaw (nth 1 delta)
17002 deltadef (nth 2 delta)))
17004 ;; Check if there is an iso week date in there. If yes, store the
17005 ;; info and postpone interpreting it until the rest of the parsing
17007 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17008 (setq iso-year (if (match-end 1)
17009 (org-small-year-to-year
17010 (string-to-number (match-string 1 ans))))
17011 iso-weekday (if (match-end 3)
17012 (string-to-number (match-string 3 ans)))
17013 iso-week (string-to-number (match-string 2 ans)))
17014 (setq ans (replace-match "" t t ans)))
17016 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17017 (when (string-match
17018 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17019 (setq year (if (match-end 2)
17020 (string-to-number (match-string 2 ans))
17021 (progn (setq kill-year t)
17022 (string-to-number (format-time-string "%Y"))))
17023 month (string-to-number (match-string 3 ans))
17024 day (string-to-number (match-string 4 ans)))
17025 (if (< year 100) (setq year (+ 2000 year)))
17026 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17029 ;; Help matching dotted european dates
17030 (when (string-match
17031 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17032 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17034 (string-to-number (format-time-string "%Y")))
17035 day (string-to-number (match-string 1 ans))
17036 month (string-to-number (match-string 2 ans))
17037 ans (replace-match (format "%04d-%02d-%02d" year month day)
17040 ;; Help matching american dates, like 5/30 or 5/30/7
17041 (when (string-match
17042 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17043 (setq year (if (match-end 4)
17044 (string-to-number (match-string 4 ans))
17045 (progn (setq kill-year t)
17046 (string-to-number (format-time-string "%Y"))))
17047 month (string-to-number (match-string 1 ans))
17048 day (string-to-number (match-string 2 ans)))
17049 (if (< year 100) (setq year (+ 2000 year)))
17050 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17052 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17053 ;; If there is a time with am/pm, and *no* time without it, we convert
17054 ;; so that matching will be successful.
17055 (loop for i from 1 to 2 do ; twice, for end time as well
17056 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17057 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17058 (setq hour (string-to-number (match-string 1 ans))
17059 minute (if (match-end 3)
17060 (string-to-number (match-string 3 ans))
17063 (string-to-char (downcase (match-string 4 ans)))))
17064 (if (and (= hour 12) (not pm))
17066 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17067 (setq ans (replace-match (format "%02d:%02d" hour minute)
17070 ;; Check if a time range is given as a duration
17071 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17072 (setq hour (string-to-number (match-string 1 ans))
17073 h2 (+ hour (string-to-number (match-string 3 ans)))
17074 minute (string-to-number (match-string 2 ans))
17075 m2 (+ minute (if (match-end 5) (string-to-number
17076 (match-string 5 ans))0)))
17077 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17078 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17081 ;; Check if there is a time range
17082 (when (boundp 'org-end-time-was-given)
17083 (setq org-time-was-given nil)
17084 (when (and (string-match org-plain-time-of-day-regexp ans)
17086 (setq org-end-time-was-given (match-string 8 ans))
17087 (setq ans (concat (substring ans 0 (match-beginning 7))
17088 (substring ans (match-end 7))))))
17090 (setq tl (parse-time-string ans)
17091 day (or (nth 3 tl) (nth 3 org-defdecode))
17094 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17095 ;; Day was specified. Make sure DAY+MONTH
17096 ;; combination happens in the future.
17099 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17100 (nth 4 nowdecode)))
17101 (t (nth 4 org-defdecode)))
17103 (cond ((and (not kill-year) (nth 5 tl)))
17104 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17105 ;; Month was guessed in the future and is at least
17106 ;; equal to NOWDECODE's. Fix year accordingly.
17108 (if (or (> month (nth 4 nowdecode))
17109 (>= day (nth 3 nowdecode)))
17111 (1+ (nth 5 nowdecode))))
17112 ;; Month was specified. Make sure MONTH+YEAR
17113 ;; combination happens in the future.
17116 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17117 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17118 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17119 (t (nth 5 nowdecode))))
17120 (t (nth 5 org-defdecode)))
17121 hour (or (nth 2 tl) (nth 2 org-defdecode))
17122 minute (or (nth 1 tl) (nth 1 org-defdecode))
17123 second (or (nth 0 tl) 0)
17126 (when (and (eq org-read-date-prefer-future 'time)
17127 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17128 (equal day (nth 3 nowdecode))
17129 (equal month (nth 4 nowdecode))
17130 (equal year (nth 5 nowdecode))
17132 (or (< (nth 2 tl) (nth 2 nowdecode))
17133 (and (= (nth 2 tl) (nth 2 nowdecode))
17135 (< (nth 1 tl) (nth 1 nowdecode)))))
17139 ;; Special date definitions below
17142 ;; There was an iso week
17145 (setq year (or iso-year year)
17146 day (or iso-weekday wday 1)
17147 wday nil ; to make sure that the trigger below does not match
17148 iso-date (calendar-gregorian-from-absolute
17149 (calendar-iso-to-absolute
17150 (list iso-week day year))))
17151 ; FIXME: Should we also push ISO weeks into the future?
17152 ; (when (and org-read-date-prefer-future
17154 ; (< (calendar-absolute-from-gregorian iso-date)
17155 ; (time-to-days (current-time))))
17156 ; (setq year (1+ year)
17157 ; iso-date (calendar-gregorian-from-absolute
17158 ; (calendar-iso-to-absolute
17159 ; (list iso-week day year)))))
17160 (setq month (car iso-date)
17161 year (nth 2 iso-date)
17162 day (nth 1 iso-date)))
17166 ;; Pass `current-time' result to `decode-time' (instead of
17167 ;; calling without arguments) so that only `current-time' has
17168 ;; to be overriden in tests.
17169 (let ((now (decode-time (current-time))))
17170 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17171 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17172 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17173 ((equal deltaw "m") (setq month (+ month deltan)))
17174 ((equal deltaw "y") (setq year (+ year deltan)))))
17175 ((and wday (not (nth 3 tl)))
17176 ;; Weekday was given, but no day, so pick that day in the week
17177 ;; on or after the derived date.
17178 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17179 (unless (equal wday wday1)
17180 (setq day (+ day (% (- wday wday1 -7) 7))))))
17181 (if (and (boundp 'org-time-was-given)
17183 (setq org-time-was-given t))
17184 (if (< year 100) (setq year (+ 2000 year)))
17185 ;; Check of the date is representable
17186 (if org-read-date-force-compatible-dates
17189 (setq year 1970 org-read-date-analyze-forced-year t))
17191 (setq year 2037 org-read-date-analyze-forced-year t)))
17192 (condition-case nil
17193 (ignore (encode-time second minute hour day month year))
17195 (setq year (nth 5 org-defdecode))
17196 (setq org-read-date-analyze-forced-year t))))
17197 (setq org-read-date-analyze-futurep futurep)
17198 (list second minute hour day month year)))
17200 (defvar parse-time-weekdays)
17201 (defun org-read-date-get-relative (s today default)
17202 "Check string S for special relative date string.
17203 TODAY and DEFAULT are internal times, for today and for a default.
17204 Return shift list (N what def-flag)
17205 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17206 N is the number of WHATs to shift.
17207 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17208 the DEFAULT date rather than TODAY."
17209 (require 'parse-time)
17213 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17215 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17216 "\\([ \t]\\|$\\)") s)
17217 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17218 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17219 (string-to-char (substring (match-string 1 s) -1))
17221 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17222 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17223 (what (if (match-end 3) (match-string 3 s) "d"))
17224 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17225 (date (if rel default today))
17226 (wday (nth 6 (decode-time date)))
17230 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17231 (if (= delta 0) (setq delta 7))
17234 (setq delta (- delta 7))
17235 (if (= delta 0) (setq delta -7))))
17236 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17237 (list delta "d" rel))
17238 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17240 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17241 "Turn a user-specified date into the internal representation.
17242 The internal representation needed by the calendar is (month day year).
17243 This is a wrapper to handle the brain-dead convention in calendar that
17244 user function argument order change dependent on argument order."
17245 (if (boundp 'calendar-date-style)
17247 ((eq calendar-date-style 'american)
17248 (list arg1 arg2 arg3))
17249 ((eq calendar-date-style 'european)
17250 (list arg2 arg1 arg3))
17251 ((eq calendar-date-style 'iso)
17252 (list arg2 arg3 arg1)))
17253 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17254 (if (org-bound-and-true-p european-calendar-style)
17255 (list arg2 arg1 arg3)
17256 (list arg1 arg2 arg3)))))
17258 (defun org-eval-in-calendar (form &optional keepdate)
17259 "Eval FORM in the calendar window and return to current window.
17260 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17261 otherwise stick to the current value of `org-ans2'."
17262 (let ((sf (selected-frame))
17263 (sw (selected-window)))
17264 (select-window (get-buffer-window "*Calendar*" t))
17266 (when (and (not keepdate) (calendar-cursor-to-date))
17267 (let* ((date (calendar-cursor-to-date))
17268 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17269 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17270 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17272 (org-select-frame-set-input-focus sf)))
17274 (defun org-calendar-select ()
17275 "Return to `org-read-date' with the date currently selected.
17276 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
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-insert-time-stamp (time &optional with-hm inactive pre post extra)
17285 "Insert a date stamp for the date given by the internal TIME.
17286 See `format-time-string' for the format of TIME.
17287 WITH-HM means use the stamp format that includes the time of the day.
17288 INACTIVE means use square brackets instead of angular ones, so that the
17289 stamp will not contribute to the agenda.
17290 PRE and POST are optional strings to be inserted before and after the
17292 The command returns the inserted time stamp."
17293 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17295 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17296 (insert-before-markers (or pre ""))
17297 (when (listp extra)
17298 (setq extra (car extra))
17299 (if (and (stringp extra)
17300 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17301 (setq extra (format "-%02d:%02d"
17302 (string-to-number (match-string 1 extra))
17303 (string-to-number (match-string 2 extra))))
17306 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17307 (insert-before-markers (setq stamp (format-time-string fmt time)))
17308 (insert-before-markers (or post ""))
17309 (setq org-last-inserted-timestamp stamp)))
17311 (defun org-toggle-time-stamp-overlays ()
17312 "Toggle the use of custom time stamp formats."
17314 (setq org-display-custom-times (not org-display-custom-times))
17315 (unless org-display-custom-times
17316 (let ((p (point-min)) (bmp (buffer-modified-p)))
17317 (while (setq p (next-single-property-change p 'display))
17318 (if (and (get-text-property p 'display)
17319 (eq (get-text-property p 'face) 'org-date))
17320 (remove-text-properties
17321 p (setq p (next-single-property-change p 'display))
17323 (set-buffer-modified-p bmp)))
17324 (if (featurep 'xemacs)
17325 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17326 (org-restart-font-lock)
17327 (setq org-table-may-need-update t)
17328 (if org-display-custom-times
17329 (message "Time stamps are overlaid with custom format")
17330 (message "Time stamp overlays removed")))
17332 (defun org-display-custom-time (beg end)
17333 "Overlay modified time stamp format over timestamp between BEG and END."
17334 (let* ((ts (buffer-substring beg end))
17335 t1 w1 with-hm tf time str w2 (off 0))
17337 (setq t1 (org-parse-time-string ts t))
17338 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17339 (setq off (- (match-end 0) (match-beginning 0)))))
17340 (setq end (- end off))
17341 (setq w1 (- end beg)
17342 with-hm (and (nth 1 t1) (nth 2 t1))
17343 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17344 time (org-fix-decoded-time t1)
17346 (format-time-string
17347 (substring tf 1 -1) (apply 'encode-time time))
17348 nil 'mouse-face 'highlight)
17350 (if (not (= w2 w1))
17351 (add-text-properties (1+ beg) (+ 2 beg)
17352 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17353 (if (featurep 'xemacs)
17355 (put-text-property beg end 'invisible t)
17356 (put-text-property beg end 'end-glyph (make-glyph str)))
17357 (put-text-property beg end 'display str))))
17359 (defun org-fix-decoded-time (time)
17360 "Set 0 instead of nil for the first 6 elements of time.
17361 Don't touch the rest."
17363 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17365 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17367 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17368 "Difference between TIMESTAMP-STRING and now in days.
17369 If SECONDS is non-nil, return the difference in seconds."
17370 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17371 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17372 (funcall fdiff (current-time)))))
17374 (defun org-deadline-close (timestamp-string &optional ndays)
17375 "Is the time in TIMESTAMP-STRING close to the current date?"
17376 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17377 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17378 (not (org-entry-is-done-p))))
17380 (defun org-get-wdays (ts &optional delay zero-delay)
17381 "Get the deadline lead time appropriate for timestring TS.
17382 When DELAY is non-nil, get the delay time for scheduled items
17383 instead of the deadline lead time. When ZERO-DELAY is non-nil
17384 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17385 don't try to find the delay cookie in the scheduled timestamp."
17386 (let ((tv (if delay org-scheduled-delay-days
17387 org-deadline-warning-days)))
17389 ((or (and delay (< tv 0))
17390 (and delay zero-delay (<= tv 0))
17391 (and (not delay) (<= tv 0)))
17392 ;; Enforce this value no matter what
17394 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17395 ;; lead time is specified.
17396 (floor (* (string-to-number (match-string 1 ts))
17397 (cdr (assoc (match-string 2 ts)
17398 '(("d" . 1) ("w" . 7)
17399 ("m" . 30.4) ("y" . 365.25)
17400 ("h" . 0.041667)))))))
17401 ;; go for the default.
17404 (defun org-calendar-select-mouse (ev)
17405 "Return to `org-read-date' with the date currently selected.
17406 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17408 (mouse-set-point ev)
17409 (when (calendar-cursor-to-date)
17410 (let* ((date (calendar-cursor-to-date))
17411 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17412 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17413 (if (active-minibuffer-window) (exit-minibuffer))))
17415 (defun org-check-deadlines (ndays)
17416 "Check if there are any deadlines due or past due.
17417 A deadline is considered due if it happens within `org-deadline-warning-days'
17418 days from today's date. If the deadline appears in an entry marked DONE,
17419 it is not shown. The prefix arg NDAYS can be used to test that many
17420 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17422 (let* ((org-warn-days
17424 ((equal ndays '(4)) 100000)
17425 (ndays (prefix-numeric-value ndays))
17426 (t (abs org-deadline-warning-days))))
17427 (case-fold-search nil)
17428 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17430 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17432 (message "%d deadlines past-due or due within %d days"
17433 (org-occur regexp nil callback)
17436 (defsubst org-re-timestamp (type)
17437 "Return a regexp for timestamp TYPE.
17438 Allowed values for TYPE are:
17440 all: all timestamps
17441 active: only active timestamps (<...>)
17442 inactive: only inactive timestamps ([...])
17443 scheduled: only scheduled timestamps
17444 deadline: only deadline timestamps
17445 closed: only closed time-stamps
17447 When TYPE is nil, fall back on returning a regexp that matches
17448 both scheduled and deadline timestamps."
17450 (all org-ts-regexp-both)
17451 (active org-ts-regexp)
17452 (inactive org-ts-regexp-inactive)
17453 (scheduled org-scheduled-time-regexp)
17454 (deadline org-deadline-time-regexp)
17455 (closed org-closed-time-regexp)
17458 (regexp-opt (list org-deadline-string org-scheduled-string))
17459 " *<\\([^>]+\\)>"))))
17461 (defun org-check-before-date (date)
17462 "Check if there are deadlines or scheduled entries before DATE."
17463 (interactive (list (org-read-date)))
17464 (let ((case-fold-search nil)
17465 (regexp (org-re-timestamp org-ts-type))
17468 (and ,(if (memq org-ts-type '(active inactive all))
17469 '(eq (org-element-type (org-element-context)) 'timestamp)
17470 '(org-at-planning-p))
17472 (org-time-string-to-time (match-string 1))
17473 (org-time-string-to-time date))))))
17474 (message "%d entries before %s"
17475 (org-occur regexp nil callback) date)))
17477 (defun org-check-after-date (date)
17478 "Check if there are deadlines or scheduled entries after DATE."
17479 (interactive (list (org-read-date)))
17480 (let ((case-fold-search nil)
17481 (regexp (org-re-timestamp org-ts-type))
17484 (and ,(if (memq org-ts-type '(active inactive all))
17485 '(eq (org-element-type (org-element-context)) 'timestamp)
17486 '(org-at-planning-p))
17488 (org-time-string-to-time (match-string 1))
17489 (org-time-string-to-time date)))))))
17490 (message "%d entries after %s"
17491 (org-occur regexp nil callback) date)))
17493 (defun org-check-dates-range (start-date end-date)
17494 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17495 (interactive (list (org-read-date nil nil nil "Range starts")
17496 (org-read-date nil nil nil "Range end")))
17497 (let ((case-fold-search nil)
17498 (regexp (org-re-timestamp org-ts-type))
17501 (let ((match (match-string 1)))
17503 ,(if (memq org-ts-type '(active inactive all))
17504 '(eq (org-element-type (org-element-context)) 'timestamp)
17505 '(org-at-planning-p))
17507 (org-time-string-to-time match)
17508 (org-time-string-to-time start-date)))
17510 (org-time-string-to-time match)
17511 (org-time-string-to-time end-date)))))))
17512 (message "%d entries between %s and %s"
17513 (org-occur regexp nil callback) start-date end-date)))
17515 (defun org-evaluate-time-range (&optional to-buffer)
17516 "Evaluate a time range by computing the difference between start and end.
17517 Normally the result is just printed in the echo area, but with prefix arg
17518 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17519 If the time range is actually in a table, the result is inserted into the
17521 For time difference computation, a year is assumed to be exactly 365
17522 days in order to avoid rounding problems."
17525 (org-clock-update-time-maybe)
17527 (unless (org-at-date-range-p t)
17528 (goto-char (point-at-bol))
17529 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17530 (if (not (org-at-date-range-p t))
17531 (user-error "Not at a time-stamp range, and none found in current line")))
17532 (let* ((ts1 (match-string 1))
17533 (ts2 (match-string 2))
17534 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17535 (match-end (match-end 0))
17536 (time1 (org-time-string-to-time ts1))
17537 (time2 (org-time-string-to-time ts2))
17538 (t1 (org-float-time time1))
17539 (t2 (org-float-time time2))
17540 (diff (abs (- t2 t1)))
17541 (negative (< (- t2 t1) 0))
17542 ;; (ys (floor (* 365 24 60 60)))
17545 (fy "%dy %dd %02d:%02d")
17547 (fd "%dd %02d:%02d")
17552 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17554 d (floor (/ diff ds)) diff (mod diff ds)
17555 h (floor (/ diff hs)) diff (mod diff hs)
17556 m (floor (/ diff 60)))
17557 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17559 d (floor (+ (/ diff ds) 0.5))
17561 (if (not to-buffer)
17562 (message "%s" (org-make-tdiff-string y d h m))
17563 (if (org-at-table-p)
17565 (goto-char match-end)
17567 (and (looking-at " *|") (goto-char (match-end 0))))
17568 (goto-char match-end))
17570 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17571 (replace-match ""))
17572 (if negative (insert " -"))
17573 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17574 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17575 (insert " " (format fh h m))))
17576 (if align (org-table-align))
17577 (message "Time difference inserted")))))
17579 (defun org-make-tdiff-string (y d h m)
17582 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17584 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17586 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17588 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17590 (apply 'format fmt (nreverse l))))
17592 (defun org-time-string-to-time (s &optional buffer pos)
17593 "Convert a timestamp string into internal time."
17594 (condition-case errdata
17595 (apply 'encode-time (org-parse-time-string s))
17596 (error (error "Bad timestamp `%s'%s\nError was: %s"
17597 s (if (not (and buffer pos))
17599 (format " at %d in buffer `%s'" pos buffer))
17602 (defun org-time-string-to-seconds (s)
17603 "Convert a timestamp string to a number of seconds."
17604 (org-float-time (org-time-string-to-time s)))
17606 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17607 "Convert a time stamp to an absolute day number.
17608 If there is a specifier for a cyclic time stamp, get the closest
17610 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17611 The variable `date' is bound by the calendar when this is called."
17613 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17614 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17617 ((and daynr (string-match "\\+\\([0-9]+\\)[hdwmy]" s)
17618 (> (string-to-number (match-string 1 s)) 0))
17619 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17620 (time-to-days (current-time))) (match-string 0 s)
17623 (condition-case errdata
17624 (apply 'encode-time (org-parse-time-string s))
17625 (error (error "Bad timestamp `%s'%s\nError was: %s"
17626 s (if (not (and buffer pos))
17628 (format " at %d in buffer `%s'" pos buffer))
17629 (cdr errdata))))))))
17631 (defun org-days-to-iso-week (days)
17632 "Return the iso week number."
17634 (car (calendar-iso-from-absolute days)))
17636 (defun org-small-year-to-year (year)
17637 "Convert 2-digit years into 4-digit years.
17638 YEAR is expanded into one of the 30 next years, if possible, or
17639 into a past one. Any year larger than 99 is returned unchanged."
17640 (if (>= year 100) year
17641 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17642 (century (/ current 100))
17643 (offset (- year (% current 100))))
17644 (cond ((> offset 30) (+ (* (1- century) 100) year))
17645 ((> offset -70) (+ (* century 100) year))
17646 (t (+ (* (1+ century) 100) year))))))
17648 (defun org-time-from-absolute (d)
17649 "Return the time corresponding to date D.
17650 D may be an absolute day number, or a calendar-type list (month day year)."
17651 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17652 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17654 (defun org-calendar-holiday ()
17655 "List of holidays, for Diary display in Org-mode."
17656 (require 'holidays)
17658 (if (fboundp 'calendar-check-holidays)
17659 'calendar-check-holidays 'check-calendar-holidays) date)))
17660 (if hl (mapconcat 'identity hl "; "))))
17662 (defun org-diary-sexp-entry (sexp entry date)
17663 "Process a SEXP diary ENTRY for DATE."
17664 (require 'diary-lib)
17665 (let ((result (if calendar-debug-sexp
17666 (let ((stack-trace-on-error t))
17667 (eval (car (read-from-string sexp))))
17668 (condition-case nil
17669 (eval (car (read-from-string sexp)))
17672 (message "Bad sexp at line %d in %s: %s"
17674 (buffer-file-name) sexp)
17676 (cond ((stringp result) (split-string result "; "))
17677 ((and (consp result)
17678 (not (consp (cdr result)))
17679 (stringp (cdr result))) (cdr result))
17680 ((and (consp result)
17681 (stringp (car result))) result)
17684 (defun org-diary-to-ical-string (frombuf)
17685 "Get iCalendar entries from diary entries in buffer FROMBUF.
17686 This uses the icalendar.el library."
17687 (let* ((tmpdir (if (featurep 'xemacs)
17689 temporary-file-directory))
17690 (tmpfile (make-temp-name
17691 (expand-file-name "orgics" tmpdir)))
17693 (with-current-buffer frombuf
17694 (icalendar-export-region (point-min) (point-max) tmpfile)
17695 (setq buf (find-buffer-visiting tmpfile))
17697 (goto-char (point-min))
17698 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17699 (setq b (match-beginning 0)))
17700 (goto-char (point-max))
17701 (if (re-search-backward "^END:VEVENT" nil t)
17702 (setq e (match-end 0)))
17703 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17705 (delete-file tmpfile)
17708 (defun org-closest-date (start current change prefer show-all)
17709 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17710 When PREFER is `past', return a date that is either CURRENT or past.
17711 When PREFER is `future', return a date that is either CURRENT or future.
17712 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17713 ;; Make the proper lists from the dates
17715 (let ((a1 '(("h" . hour)
17720 (shour (nth 2 (org-parse-time-string start)))
17721 dn dw sday cday n1 n2 n0
17722 d m y y1 y2 date1 date2 nmonths nm ny m2)
17724 (setq start (org-date-to-gregorian start)
17725 current (org-date-to-gregorian
17728 (time-to-days (current-time))))
17729 sday (calendar-absolute-from-gregorian start)
17730 cday (calendar-absolute-from-gregorian current))
17732 (if (<= cday sday) (throw 'exit sday))
17734 (when (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17735 (setq dn (string-to-number (match-string 1 change))
17736 dw (cdr (assoc (match-string 2 change) a1))))
17737 (unless (and dn (> dn 0))
17738 (user-error "Invalid change specifier: %s" change))
17739 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17742 (let ((missing-hours
17743 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17745 (setq n1 (if (zerop missing-hours) cday
17746 (- cday (1+ (floor (/ missing-hours 24)))))
17747 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17749 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17752 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17753 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17754 (setq date1 (list m d y1)
17755 n1 (calendar-absolute-from-gregorian date1)
17756 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17757 n2 (calendar-absolute-from-gregorian date2)))
17759 ;; approx number of month between the two dates
17760 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17761 ;; How often does dn fit in there?
17762 (setq d (nth 1 start) m (car start) y (nth 2 start)
17763 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17765 ny (floor (/ m 12))
17768 (while (> m 12) (setq m (- m 12) y (1+ y)))
17769 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17770 (setq m2 (+ m dn) y2 y)
17771 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17772 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17773 (while (<= n2 cday)
17774 (setq n1 n2 m m2 y y2)
17775 (setq m2 (+ m dn) y2 y)
17776 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17777 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17778 ;; Make sure n1 is the earlier date
17779 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17782 ((eq prefer 'past) (if (= cday n2) n2 n1))
17783 ((eq prefer 'future) (if (= cday n1) n1 n2))
17784 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17786 ((eq prefer 'past) (if (= cday n2) n2 n1))
17787 ((eq prefer 'future) (if (= cday n1) n1 n2))
17788 (t (if (= cday n1) n1 n2)))))))
17790 (defun org-date-to-gregorian (date)
17791 "Turn any specification of DATE into a Gregorian date for the calendar."
17792 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17793 ((and (listp date) (= (length date) 3)) date)
17795 (setq date (org-parse-time-string date))
17796 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17798 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17800 (defun org-parse-time-string (s &optional nodefault)
17801 "Parse the standard Org-mode time string.
17802 This should be a lot faster than the normal `parse-time-string'.
17803 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17804 hour and minute fields will be nil if not given."
17805 (cond ((string-match org-ts-regexp0 s)
17807 (if (or (match-beginning 8) (not nodefault))
17808 (string-to-number (or (match-string 8 s) "0")))
17809 (if (or (match-beginning 7) (not nodefault))
17810 (string-to-number (or (match-string 7 s) "0")))
17811 (string-to-number (match-string 4 s))
17812 (string-to-number (match-string 3 s))
17813 (string-to-number (match-string 2 s))
17815 ((string-match "^<[^>]+>$" s)
17816 (decode-time (seconds-to-time (org-matcher-time s))))
17817 (t (error "Not a standard Org-mode time string: %s" s))))
17819 (defun org-timestamp-up (&optional arg)
17820 "Increase the date item at the cursor by one.
17821 If the cursor is on the year, change the year. If it is on the month,
17822 the day or the time, change that.
17823 With prefix ARG, change by that many units."
17825 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17827 (defun org-timestamp-down (&optional arg)
17828 "Decrease the date item at the cursor by one.
17829 If the cursor is on the year, change the year. If it is on the month,
17830 the day or the time, change that.
17831 With prefix ARG, change by that many units."
17833 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17835 (defun org-timestamp-up-day (&optional arg)
17836 "Increase the date in the time stamp by one day.
17837 With prefix ARG, change that many days."
17839 (if (and (not (org-at-timestamp-p t))
17840 (org-at-heading-p))
17842 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17844 (defun org-timestamp-down-day (&optional arg)
17845 "Decrease the date in the time stamp by one day.
17846 With prefix ARG, change that many days."
17848 (if (and (not (org-at-timestamp-p t))
17849 (org-at-heading-p))
17851 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17853 (defun org-at-timestamp-p (&optional inactive-ok)
17854 "Determine if the cursor is in or at a timestamp."
17856 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17858 (ans (or (looking-at tsr)
17860 (skip-chars-backward "^[<\n\r\t")
17861 (if (> (point) (point-min)) (backward-char 1))
17862 (and (looking-at tsr)
17863 (> (- (match-end 0) pos) -1))))))
17865 (boundp 'org-ts-what)
17868 ((= pos (match-beginning 0)) 'bracket)
17869 ;; Point is considered to be "on the bracket" whether
17870 ;; it's really on it or right after it.
17871 ((= pos (1- (match-end 0))) 'bracket)
17872 ((= pos (match-end 0)) 'after)
17873 ((org-pos-in-match-range pos 2) 'year)
17874 ((org-pos-in-match-range pos 3) 'month)
17875 ((org-pos-in-match-range pos 7) 'hour)
17876 ((org-pos-in-match-range pos 8) 'minute)
17877 ((or (org-pos-in-match-range pos 4)
17878 (org-pos-in-match-range pos 5)) 'day)
17879 ((and (> pos (or (match-end 8) (match-end 5)))
17880 (< pos (match-end 0)))
17881 (- pos (or (match-end 8) (match-end 5))))
17885 (defun org-toggle-timestamp-type ()
17886 "Toggle the type (<active> or [inactive]) of a time stamp."
17888 (when (org-at-timestamp-p t)
17889 (let ((beg (match-beginning 0)) (end (match-end 0))
17890 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17893 (while (re-search-forward "[][<>]" end t)
17894 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17896 (message "Timestamp is now %sactive"
17897 (if (equal (char-after beg) ?<) "" "in")))))
17899 (defun org-at-clock-log-p nil
17900 "Is the cursor on the clock log line?"
17902 (move-beginning-of-line 1)
17903 (looking-at org-clock-line-re)))
17905 (defvar org-clock-history) ; defined in org-clock.el
17906 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17907 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17908 "Change the date in the time stamp at point.
17909 The date will be changed by N times WHAT. WHAT can be `day', `month',
17910 `year', `minute', `second'. If WHAT is not given, the cursor position
17911 in the timestamp determines what will be changed.
17912 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17913 (let ((origin (point)) origin-cat
17915 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17918 ts time time0 fixnext clrgx)
17919 (if (not (org-at-timestamp-p t))
17920 (user-error "Not at a timestamp"))
17921 (if (and (not what) (eq org-ts-what 'bracket))
17922 (org-toggle-timestamp-type)
17923 ;; Point isn't on brackets. Remember the part of the time-stamp
17924 ;; the point was in. Indeed, size of time-stamps may change,
17925 ;; but point must be kept in the same category nonetheless.
17926 (setq origin-cat org-ts-what)
17927 (if (and (not what) (not (eq org-ts-what 'day))
17928 org-display-custom-times
17929 (get-text-property (point) 'display)
17930 (not (get-text-property (1- (point)) 'display)))
17931 (setq org-ts-what 'day))
17932 (setq org-ts-what (or what org-ts-what)
17933 inactive (= (char-after (match-beginning 0)) ?\[)
17934 ts (match-string 0))
17936 (when (string-match
17937 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17939 (setq extra (match-string 1 ts))
17940 (if suppress-tmp-delay
17941 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17942 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17944 (setq time0 (org-parse-time-string ts))
17946 (eq org-ts-what 'minute)
17947 (not current-prefix-arg))
17948 ;; This looks like s-up and s-down. Change by one rounding step.
17949 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17950 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17951 (setcar (cdr time0) (+ (nth 1 time0)
17952 (if (> n 0) (- rem) (- dm rem))))))
17954 (encode-time (or (car time0) 0)
17955 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17956 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17957 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17958 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17959 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17961 (when (and (member org-ts-what '(hour minute))
17963 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17964 (setq extra (org-modify-ts-extra
17966 (if (eq org-ts-what 'hour) 2 5)
17968 (when (integerp org-ts-what)
17969 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17970 (if (eq what 'calendar)
17971 (let ((cal-date (org-get-date-from-calendar)))
17972 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17973 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17974 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17975 (setcar time0 (or (car time0) 0))
17976 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17977 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17978 (setq time (apply 'encode-time time0))))
17979 ;; Insert the new time-stamp, and ensure point stays in the same
17980 ;; category as before (i.e. not after the last position in that
17982 (let ((pos (point)))
17983 ;; Stay before inserted string. `save-excursion' is of no use.
17984 (setq org-last-changed-timestamp
17985 (org-insert-time-stamp time with-hm inactive nil nil extra))
17988 (looking-at org-ts-regexp3)
17990 ;; `day' category ends before `hour' if any, or at
17991 ;; the end of the day name.
17992 ((eq origin-cat 'day)
17993 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17994 ((eq origin-cat 'hour) (min (match-end 7) origin))
17995 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17996 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17997 ;; `year' and `month' have both fixed size: point
17998 ;; couldn't have moved into another part.
18000 ;; Update clock if on a CLOCK line.
18001 (org-clock-update-time-maybe)
18002 ;; Maybe adjust the closest clock in `org-clock-history'
18003 (when org-clock-adjust-closest
18004 (if (not (and (org-at-clock-log-p)
18005 (< 1 (length (delq nil (mapcar 'marker-position
18006 org-clock-history))))))
18007 (message "No clock to adjust")
18008 (cond ((save-excursion ; fix previous clock?
18009 (re-search-backward org-ts-regexp0 nil t)
18010 (org-looking-back (concat org-clock-string " \\[")))
18011 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18012 ((save-excursion ; fix next clock?
18013 (re-search-backward org-ts-regexp0 nil t)
18014 (looking-at (concat org-ts-regexp0 "\\] =>")))
18015 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18016 (save-window-excursion
18017 ;; Find closest clock to point, adjust the previous/next one in history
18018 (let* ((p (save-excursion (org-back-to-heading t)))
18019 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18021 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18022 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
18024 (message "No clock to adjust")
18026 (org-goto-marker-or-bmk clfixpos)
18028 (when (re-search-forward clrgx nil t)
18029 (goto-char (match-beginning 1))
18030 (let (org-clock-adjust-closest)
18031 (org-timestamp-change n org-ts-what updown))
18032 (message "Clock adjusted in %s for heading: %s"
18033 (file-name-nondirectory (buffer-file-name))
18034 (org-get-heading t t)))))))))
18035 ;; Try to recenter the calendar window, if any.
18036 (if (and org-calendar-follow-timestamp-change
18037 (get-buffer-window "*Calendar*" t)
18038 (memq org-ts-what '(day month year)))
18039 (org-recenter-calendar (time-to-days time))))))
18041 (defun org-modify-ts-extra (s pos n dm)
18042 "Change the different parts of the lead-time and repeat fields in timestamp."
18043 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18045 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18047 ((or (org-pos-in-match-range pos 2)
18048 (org-pos-in-match-range pos 3))
18049 (setq m (string-to-number (match-string 3 s))
18050 h (string-to-number (match-string 2 s)))
18051 (if (org-pos-in-match-range pos 2)
18053 (setq n (* dm (org-no-warnings (signum n))))
18054 (when (not (= 0 (setq rem (% m dm))))
18055 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18057 (if (< m 0) (setq m (+ m 60) h (1- h)))
18058 (if (> m 59) (setq m (- m 60) h (1+ h)))
18059 (setq h (min 24 (max 0 h)))
18060 (setq ng 1 new (format "-%02d:%02d" h m)))
18061 ((org-pos-in-match-range pos 6)
18062 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18063 ((org-pos-in-match-range pos 5)
18064 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18066 ((org-pos-in-match-range pos 9)
18067 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18068 ((org-pos-in-match-range pos 8)
18069 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18073 (substring s 0 (match-beginning ng))
18075 (substring s (match-end ng))))))
18078 (defun org-recenter-calendar (date)
18079 "If the calendar is visible, recenter it to DATE."
18080 (let ((cwin (get-buffer-window "*Calendar*" t)))
18082 (let ((calendar-move-hook nil))
18083 (with-selected-window cwin
18084 (calendar-goto-date (if (listp date) date
18085 (calendar-gregorian-from-absolute date))))))))
18087 (defun org-goto-calendar (&optional arg)
18088 "Go to the Emacs calendar at the current date.
18089 If there is a time stamp in the current line, go to that date.
18090 A prefix ARG can be used to force the current date."
18092 (let ((tsr org-ts-regexp) diff
18093 (calendar-move-hook nil)
18094 (calendar-view-holidays-initially-flag nil)
18095 (calendar-view-diary-initially-flag nil))
18096 (if (or (org-at-timestamp-p)
18098 (beginning-of-line 1)
18099 (looking-at (concat ".*" tsr))))
18100 (let ((d1 (time-to-days (current-time)))
18102 (org-time-string-to-time (match-string 1)))))
18103 (setq diff (- d2 d1))))
18105 (calendar-goto-today)
18106 (if (and diff (not arg)) (calendar-forward-day diff))))
18108 (defun org-get-date-from-calendar ()
18109 "Return a list (month day year) of date at point in calendar."
18110 (with-current-buffer "*Calendar*"
18112 (calendar-cursor-to-date))))
18114 (defun org-date-from-calendar ()
18115 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18116 If there is already a time stamp at the cursor position, update it."
18118 (if (org-at-timestamp-p t)
18119 (org-timestamp-change 0 'calendar)
18120 (let ((cal-date (org-get-date-from-calendar)))
18121 (org-insert-time-stamp
18122 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18124 (defcustom org-effort-durations
18128 ("w" . ,(* 60 8 5))
18129 ("m" . ,(* 60 8 5 4))
18130 ("y" . ,(* 60 8 5 40)))
18131 "Conversion factor to minutes for an effort modifier.
18133 Each entry has the form (MODIFIER . MINUTES).
18135 In an effort string, a number followed by MODIFIER is multiplied
18136 by the specified number of MINUTES to obtain an effort in
18139 For example, if the value of this variable is ((\"hours\" . 60)), then an
18140 effort string \"2hours\" is equivalent to 120 minutes."
18143 :package-version '(Org . "8.3")
18144 :type '(alist :key-type (string :tag "Modifier")
18145 :value-type (number :tag "Minutes")))
18147 (defun org-minutes-to-clocksum-string (m)
18148 "Format number of minutes as a clocksum string.
18149 The format is determined by `org-time-clocksum-format',
18150 `org-time-clocksum-use-fractional' and
18151 `org-time-clocksum-fractional-format' and
18152 `org-time-clocksum-use-effort-durations'."
18153 (let ((clocksum "")
18154 (m (round m)) ; Don't allow fractions of minutes
18156 (setq h (if org-time-clocksum-use-effort-durations
18157 (cdr (assoc "h" org-effort-durations)) 60)
18158 d (if org-time-clocksum-use-effort-durations
18159 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18160 w (if org-time-clocksum-use-effort-durations
18161 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18162 mo (if org-time-clocksum-use-effort-durations
18163 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18164 y (if org-time-clocksum-use-effort-durations
18165 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18166 ;; fractional format
18167 (if org-time-clocksum-use-fractional
18169 ;; single format string
18170 ((stringp org-time-clocksum-fractional-format)
18171 (format org-time-clocksum-fractional-format (/ m (float h))))
18172 ;; choice of fractional formats for different time units
18173 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18174 (> (/ (truncate m) (* y d h)) 0))
18175 (format fmt (/ m (* y d (float h)))))
18176 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18177 (> (/ (truncate m) (* mo d h)) 0))
18178 (format fmt (/ m (* mo d (float h)))))
18179 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18180 (> (/ (truncate m) (* w d h)) 0))
18181 (format fmt (/ m (* w d (float h)))))
18182 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18183 (> (/ (truncate m) (* d h)) 0))
18184 (format fmt (/ m (* d (float h)))))
18185 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18186 (> (/ (truncate m) h) 0))
18187 (format fmt (/ m (float h))))
18188 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18190 ;; fall back to smallest time unit with a format
18191 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18192 (format fmt (/ m (float h))))
18193 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18194 (format fmt (/ m (* d (float h)))))
18195 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18196 (format fmt (/ m (* w d (float h)))))
18197 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18198 (format fmt (/ m (* mo d (float h)))))
18199 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18200 (format fmt (/ m (* y d (float h))))))
18201 ;; standard (non-fractional) format, with single format string
18202 (if (stringp org-time-clocksum-format)
18203 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18204 ;; separate formats components
18205 (and (setq fmt (plist-get org-time-clocksum-format :years))
18206 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18207 (plist-get org-time-clocksum-format :require-years))
18208 (setq clocksum (concat clocksum (format fmt n))
18209 m (- m (* n y d h))))
18210 (and (setq fmt (plist-get org-time-clocksum-format :months))
18211 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18212 (plist-get org-time-clocksum-format :require-months))
18213 (setq clocksum (concat clocksum (format fmt n))
18214 m (- m (* n mo d h))))
18215 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18216 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18217 (plist-get org-time-clocksum-format :require-weeks))
18218 (setq clocksum (concat clocksum (format fmt n))
18219 m (- m (* n w d h))))
18220 (and (setq fmt (plist-get org-time-clocksum-format :days))
18221 (or (> (setq n (/ (truncate m) (* d h))) 0)
18222 (plist-get org-time-clocksum-format :require-days))
18223 (setq clocksum (concat clocksum (format fmt n))
18224 m (- m (* n d h))))
18225 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18226 (or (> (setq n (/ (truncate m) h)) 0)
18227 (plist-get org-time-clocksum-format :require-hours))
18228 (setq clocksum (concat clocksum (format fmt n))
18230 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18231 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18232 (setq clocksum (concat clocksum (format fmt m))))
18233 ;; return formatted time duration
18236 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18237 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18238 "Org mode version 8.0")
18240 (defun org-hours-to-clocksum-string (n)
18241 (org-minutes-to-clocksum-string (* n 60)))
18243 (defun org-hh:mm-string-to-minutes (s)
18244 "Convert a string H:MM to a number of minutes.
18245 If the string is just a number, interpret it as minutes.
18246 In fact, the first hh:mm or number in the string will be taken,
18247 there can be extra stuff in the string.
18248 If no number is found, the return value is 0."
18251 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18252 (+ (* (string-to-number (match-string 1 s)) 60)
18253 (string-to-number (match-string 2 s))))
18254 ((string-match "\\([0-9]+\\)" s)
18255 (string-to-number (match-string 1 s)))
18258 (defcustom org-image-actual-width t
18259 "Should we use the actual width of images when inlining them?
18261 When set to t, always use the image width.
18263 When set to a number, use imagemagick (when available) to set
18264 the image's width to this value.
18266 When set to a number in a list, try to get the width from any
18267 #+ATTR.* keyword if it matches a width specification like
18269 #+ATTR_HTML: :width 300px
18271 and fall back on that number if none is found.
18273 When set to nil, try to get the width from an #+ATTR.* keyword
18274 and fall back on the original width if none is found.
18276 This requires Emacs >= 24.1, build with imagemagick support."
18277 :group 'org-appearance
18279 :package-version '(Org . "8.0")
18281 (const :tag "Use the image width" t)
18282 (integer :tag "Use a number of pixels")
18283 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18284 (const :tag "Use #+ATTR* or don't resize" nil)))
18286 (defcustom org-agenda-inhibit-startup nil
18287 "Inhibit startup when preparing agenda buffers.
18288 When this variable is t, the initialization of the Org agenda
18289 buffers is inhibited: e.g. the visibility state is not set, the
18290 tables are not re-aligned, etc."
18293 :group 'org-agenda)
18295 (define-obsolete-variable-alias
18296 'org-agenda-ignore-drawer-properties
18297 'org-agenda-ignore-properties "25.1")
18299 (defcustom org-agenda-ignore-properties nil
18300 "Avoid updating text properties when building the agenda.
18301 Properties are used to prepare buffers for effort estimates,
18302 appointments, statistics and subtree-local categories.
18303 If you don't use these in the agenda, you can add them to this
18304 list and agenda building will be a bit faster.
18305 The value is a list, with zero or more of the symbols `effort', `appt',
18306 `stats' or `category'."
18307 :type '(set :greedy t
18313 :package-version '(Org . "8.3")
18314 :group 'org-agenda)
18316 (defun org-duration-string-to-minutes (s &optional output-to-string)
18317 "Convert a duration string S to minutes.
18319 A bare number is interpreted as minutes, modifiers can be set by
18320 customizing `org-effort-durations' (which see).
18322 Entries containing a colon are interpreted as H:MM by
18323 `org-hh:mm-string-to-minutes'."
18325 (re (concat "\\([0-9.]+\\) *\\("
18326 (regexp-opt (mapcar 'car org-effort-durations))
18328 (while (string-match re s)
18329 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18330 (string-to-number (match-string 1 s))))
18331 (setq s (replace-match "" nil t s)))
18332 (setq result (floor result))
18333 (incf result (org-hh:mm-string-to-minutes s))
18334 (if output-to-string (number-to-string result) result)))
18338 (defun org-save-all-org-buffers ()
18339 "Save all Org-mode buffers without user confirmation."
18341 (message "Saving all Org-mode buffers...")
18342 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18343 (when (featurep 'org-id) (org-id-locations-save))
18344 (message "Saving all Org-mode buffers... done"))
18346 (defun org-revert-all-org-buffers ()
18347 "Revert all Org-mode buffers.
18348 Prompt for confirmation when there are unsaved changes.
18349 Be sure you know what you are doing before letting this function
18350 overwrite your changes.
18352 This function is useful in a setup where one tracks org files
18353 with a version control system, to revert on one machine after pulling
18354 changes from another. I believe the procedure must be like this:
18356 1. M-x org-save-all-org-buffers
18357 2. Pull changes from the other machine, resolve conflicts
18358 3. M-x org-revert-all-org-buffers"
18360 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18361 (user-error "Abort"))
18363 (save-window-excursion
18366 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18367 (with-current-buffer b buffer-file-name))
18368 (org-pop-to-buffer-same-window b)
18369 (revert-buffer t 'no-confirm)))
18371 (when (and (featurep 'org-id) org-id-track-globally)
18372 (org-id-locations-load)))))
18377 (defun org-switchb (&optional arg)
18378 "Switch between Org buffers.
18379 With one prefix argument, restrict available buffers to files.
18380 With two prefix arguments, restrict available buffers to agenda files.
18382 Defaults to `iswitchb' for buffer name completion.
18383 Set `org-completion-use-ido' to make it use ido instead."
18385 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18386 ((equal arg '(16)) (org-buffer-list 'agenda))
18387 (t (org-buffer-list))))
18388 (org-completion-use-iswitchb org-completion-use-iswitchb)
18389 (org-completion-use-ido org-completion-use-ido))
18390 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18391 (setq org-completion-use-iswitchb t))
18392 (org-pop-to-buffer-same-window
18393 (org-icompleting-read "Org buffer: "
18394 (mapcar 'list (mapcar 'buffer-name blist))
18397 ;;; Define some older names previously used for this functionality
18399 (defalias 'org-ido-switchb 'org-switchb)
18401 (defalias 'org-iswitchb 'org-switchb)
18403 (defun org-buffer-list (&optional predicate exclude-tmp)
18404 "Return a list of Org buffers.
18405 PREDICATE can be `export', `files' or `agenda'.
18407 export restrict the list to Export buffers.
18408 files restrict the list to buffers visiting Org files.
18409 agenda restrict the list to buffers visiting agenda files.
18411 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18413 (agenda-files (and (eq predicate 'agenda)
18414 (mapcar 'file-truename (org-agenda-files t))))
18417 ((eq predicate 'files)
18418 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18419 ((eq predicate 'export)
18420 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18421 ((eq predicate 'agenda)
18423 (with-current-buffer b
18424 (and (derived-mode-p 'org-mode)
18425 (setq bfn (buffer-file-name b))
18426 (member (file-truename bfn) agenda-files)))))
18427 (t (lambda (b) (with-current-buffer b
18428 (or (derived-mode-p 'org-mode)
18429 (string-match "\*Org .*Export"
18430 (buffer-name b)))))))))
18434 (if (and (funcall filter b)
18435 (or (not exclude-tmp)
18436 (not (string-match "tmp" (buffer-name b)))))
18441 (defun org-agenda-files (&optional unrestricted archives)
18442 "Get the list of agenda files.
18443 Optional UNRESTRICTED means return the full list even if a restriction
18444 is currently in place.
18445 When ARCHIVES is t, include all archive files that are really being
18446 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18447 `org-agenda-archives-mode' is t."
18450 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18451 ((stringp org-agenda-files) (org-read-agenda-file-list))
18452 ((listp org-agenda-files) org-agenda-files)
18453 (t (error "Invalid value of `org-agenda-files'")))))
18454 (setq files (apply 'append
18455 (mapcar (lambda (f)
18456 (if (file-directory-p f)
18458 f t org-agenda-file-regexp)
18461 (when org-agenda-skip-unavailable-files
18462 (setq files (delq nil
18465 (and (file-readable-p file) file)))
18467 (when (or (eq archives t)
18468 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18469 (setq files (org-add-archive-files files)))
18472 (defun org-agenda-file-p (&optional file)
18473 "Return non-nil, if FILE is an agenda file.
18474 If FILE is omitted, use the file associated with the current
18476 (let ((fname (or file (buffer-file-name))))
18478 (member (file-truename fname)
18479 (mapcar #'file-truename (org-agenda-files t))))))
18481 (defun org-edit-agenda-file-list ()
18482 "Edit the list of agenda files.
18483 Depending on setup, this either uses customize to edit the variable
18484 `org-agenda-files', or it visits the file that is holding the list. In the
18485 latter case, the buffer is set up in a way that saving it automatically kills
18486 the buffer and restores the previous window configuration."
18488 (if (stringp org-agenda-files)
18489 (let ((cw (current-window-configuration)))
18490 (find-file org-agenda-files)
18491 (org-set-local 'org-window-configuration cw)
18492 (org-add-hook 'after-save-hook
18494 (set-window-configuration
18495 (prog1 org-window-configuration
18496 (kill-buffer (current-buffer))))
18497 (org-install-agenda-files-menu)
18498 (message "New agenda file list installed"))
18500 (message "%s" (substitute-command-keys
18501 "Edit list and finish with \\[save-buffer]")))
18502 (customize-variable 'org-agenda-files)))
18504 (defun org-store-new-agenda-file-list (list)
18505 "Set new value for the agenda file list and save it correctly."
18506 (if (stringp org-agenda-files)
18507 (let ((fe (org-read-agenda-file-list t)) b u)
18508 (while (setq b (find-buffer-visiting org-agenda-files))
18510 (with-temp-file org-agenda-files
18513 (lambda (f) ;; Keep un-expanded entries.
18514 (if (setq u (assoc f fe))
18519 (let ((org-mode-hook nil) (org-inhibit-startup t)
18520 (org-insert-mode-line-in-empty-file nil))
18521 (setq org-agenda-files list)
18522 (customize-save-variable 'org-agenda-files org-agenda-files))))
18524 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18525 "Read the list of agenda files from a file.
18526 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18527 filenames, used by `org-store-new-agenda-file-list' to write back
18528 un-expanded file names."
18529 (when (file-directory-p org-agenda-files)
18530 (error "`org-agenda-files' cannot be a single directory"))
18531 (when (stringp org-agenda-files)
18533 (insert-file-contents org-agenda-files)
18536 (let ((e (expand-file-name (substitute-in-file-name f)
18538 (if pair-with-expansion
18541 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18544 (defun org-cycle-agenda-files ()
18545 "Cycle through the files in `org-agenda-files'.
18546 If the current buffer visits an agenda file, find the next one in the list.
18547 If the current buffer does not, find the first agenda file."
18549 (let* ((fs (org-agenda-files t))
18550 (files (append fs (list (car fs))))
18551 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18553 (unless files (user-error "No agenda files"))
18555 (while (setq file (pop files))
18556 (if (equal (file-truename file) tcf)
18558 (find-file (car files))
18560 (find-file (car fs)))
18561 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18563 (defun org-agenda-file-to-front (&optional to-end)
18564 "Move/add the current file to the top of the agenda file list.
18565 If the file is not present in the list, it is added to the front. If it is
18566 present, it is moved there. With optional argument TO-END, add/move to the
18569 (let ((org-agenda-skip-unavailable-files nil)
18570 (file-alist (mapcar (lambda (x)
18571 (cons (file-truename x) x))
18572 (org-agenda-files t)))
18573 (ctf (file-truename
18574 (or buffer-file-name
18575 (user-error "Please save the current buffer to a file"))))
18577 (setq x (assoc ctf file-alist) had x)
18579 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18581 (setq file-alist (append (delq x file-alist) (list x)))
18582 (setq file-alist (cons x (delq x file-alist))))
18583 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18584 (org-install-agenda-files-menu)
18585 (message "File %s to %s of agenda file list"
18586 (if had "moved" "added") (if to-end "end" "front"))))
18588 (defun org-remove-file (&optional file)
18589 "Remove current file from the list of files in variable `org-agenda-files'.
18590 These are the files which are being checked for agenda entries.
18591 Optional argument FILE means use this file instead of the current."
18593 (let* ((org-agenda-skip-unavailable-files nil)
18594 (file (or file buffer-file-name
18595 (user-error "Current buffer does not visit a file")))
18596 (true-file (file-truename file))
18597 (afile (abbreviate-file-name file))
18598 (files (delq nil (mapcar
18600 (if (equal true-file
18603 (org-agenda-files t)))))
18604 (if (not (= (length files) (length (org-agenda-files t))))
18606 (org-store-new-agenda-file-list files)
18607 (org-install-agenda-files-menu)
18608 (message "Removed from Org Agenda list: %s" afile))
18609 (message "File was not in list: %s (not removed)" afile))))
18611 (defun org-file-menu-entry (file)
18612 (vector file (list 'find-file file) t))
18614 (defun org-check-agenda-file (file)
18615 "Make sure FILE exists. If not, ask user what to do."
18616 (when (not (file-exists-p file))
18617 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18618 (abbreviate-file-name file))
18619 (let ((r (downcase (read-char-exclusive))))
18622 (org-remove-file file)
18623 (throw 'nextfile t))
18624 (t (user-error "Abort"))))))
18626 (defun org-get-agenda-file-buffer (file)
18627 "Get an agenda buffer visiting FILE.
18628 If the buffer needs to be created, add it to the list of buffers
18629 which might be released later."
18630 (let ((buf (org-find-base-buffer-visiting file)))
18632 buf ; just return it
18633 ;; Make a new buffer and remember it
18634 (setq buf (find-file-noselect file))
18635 (if buf (push buf org-agenda-new-buffers))
18638 (defun org-release-buffers (blist)
18639 "Release all buffers in list, asking the user for confirmation when needed.
18640 When a buffer is unmodified, it is just killed. When modified, it is saved
18641 \(if the user agrees) and then killed."
18643 (while (setq buf (pop blist))
18644 (setq file (buffer-file-name buf))
18645 (when (and (buffer-modified-p buf)
18647 (y-or-n-p (format "Save file %s? " file)))
18648 (with-current-buffer buf (save-buffer)))
18649 (kill-buffer buf))))
18651 (defun org-agenda-prepare-buffers (files)
18652 "Create buffers for all agenda files, protect archived trees and comments."
18654 (let ((pa '(:org-archived t))
18655 (pc '(:org-comment t))
18656 (pall '(:org-archived t :org-comment t))
18657 (inhibit-read-only t)
18658 (org-inhibit-startup org-agenda-inhibit-startup)
18659 (rea (concat ":" org-archive-tag ":"))
18661 (setq org-tag-alist-for-agenda nil
18662 org-tag-groups-alist-for-agenda nil)
18665 (while (setq file (pop files))
18669 (org-check-agenda-file file)
18670 (set-buffer (org-get-agenda-file-buffer file)))
18672 (org-set-regexps-and-options 'tags-only)
18674 (or (memq 'category org-agenda-ignore-properties)
18675 (org-refresh-category-properties))
18676 (or (memq 'stats org-agenda-ignore-properties)
18677 (org-refresh-stats-properties))
18678 (or (memq 'effort org-agenda-ignore-properties)
18679 (org-refresh-effort-properties))
18680 (or (memq 'appt org-agenda-ignore-properties)
18681 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18682 (setq org-todo-keywords-for-agenda
18683 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18684 (setq org-done-keywords-for-agenda
18685 (append org-done-keywords-for-agenda org-done-keywords))
18686 (setq org-todo-keyword-alist-for-agenda
18687 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18688 (setq org-tag-alist-for-agenda
18690 (append org-tag-alist-for-agenda
18692 org-tag-persistent-alist)))
18694 (setq org-tag-groups-alist-for-agenda
18695 (org-uniquify-alist
18696 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18697 (org-with-silent-modifications
18699 (remove-text-properties (point-min) (point-max) pall)
18700 (when org-agenda-skip-archived-trees
18701 (goto-char (point-min))
18702 (while (re-search-forward rea nil t)
18703 (if (org-at-heading-p t)
18704 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18705 (goto-char (point-min))
18706 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18707 (while (re-search-forward re nil t)
18708 (when (save-match-data (org-in-commented-heading-p t))
18709 (add-text-properties
18710 (match-beginning 0) (org-end-of-subtree t) pc)))))
18711 (goto-char pos)))))
18712 (setq org-todo-keywords-for-agenda
18713 (org-uniquify org-todo-keywords-for-agenda))
18714 (setq org-todo-keyword-alist-for-agenda
18715 (org-uniquify org-todo-keyword-alist-for-agenda))))
18718 ;;;; CDLaTeX minor mode
18720 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18721 "Keymap for the minor `org-cdlatex-mode'.")
18723 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18724 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18725 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18726 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18727 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18729 (defvar org-cdlatex-texmathp-advice-is-done nil
18730 "Flag remembering if we have applied the advice to texmathp already.")
18732 (define-minor-mode org-cdlatex-mode
18733 "Toggle the minor `org-cdlatex-mode'.
18734 This mode supports entering LaTeX environment and math in LaTeX fragments
18736 \\{org-cdlatex-mode-map}"
18738 (when org-cdlatex-mode
18740 (run-hooks 'cdlatex-mode-hook)
18741 (cdlatex-compute-tables))
18742 (unless org-cdlatex-texmathp-advice-is-done
18743 (setq org-cdlatex-texmathp-advice-is-done t)
18744 (defadvice texmathp (around org-math-always-on activate)
18745 "Always return t in org-mode buffers.
18746 This is because we want to insert math symbols without dollars even outside
18747 the LaTeX math segments. If Orgmode thinks that point is actually inside
18748 an embedded LaTeX fragment, let texmathp do its job.
18749 \\[org-cdlatex-mode-map]"
18753 ((not (derived-mode-p 'org-mode)) ad-do-it)
18754 ((eq this-command 'cdlatex-math-symbol)
18755 (setq ad-return-value t
18756 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18758 (let ((p (org-inside-LaTeX-fragment-p)))
18759 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18760 (setq ad-return-value t
18761 texmathp-why '("Org-mode embedded math" . 0))
18762 (if p ad-do-it)))))))))
18764 (defun turn-on-org-cdlatex ()
18765 "Unconditionally turn on `org-cdlatex-mode'."
18766 (org-cdlatex-mode 1))
18768 (defun org-try-cdlatex-tab ()
18769 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18770 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18771 - inside a LaTeX fragment, or
18772 - after the first word in a line, where an abbreviation expansion could
18773 insert a LaTeX environment."
18774 (when org-cdlatex-mode
18776 ;; Before any word on the line: No expansion possible.
18777 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18778 ;; Just after first word on the line: Expand it. Make sure it
18779 ;; cannot happen on headlines, though.
18781 (skip-chars-backward "a-zA-Z0-9*")
18782 (skip-chars-backward " \t")
18783 (and (bolp) (not (org-at-heading-p))))
18785 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18787 (defun org-cdlatex-underscore-caret (&optional arg)
18788 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18789 Revert to the normal definition outside of these fragments."
18791 (if (org-inside-LaTeX-fragment-p)
18792 (call-interactively 'cdlatex-sub-superscript)
18793 (let (org-cdlatex-mode)
18794 (call-interactively (key-binding (vector last-input-event))))))
18796 (defun org-cdlatex-math-modify (&optional arg)
18797 "Execute `cdlatex-math-modify' in LaTeX fragments.
18798 Revert to the normal definition outside of these fragments."
18800 (if (org-inside-LaTeX-fragment-p)
18801 (call-interactively 'cdlatex-math-modify)
18802 (let (org-cdlatex-mode)
18803 (call-interactively (key-binding (vector last-input-event))))))
18805 (defun org-cdlatex-environment-indent (&optional environment item)
18806 "Execute `cdlatex-environment' and indent the inserted environment.
18808 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18810 The inserted environment is indented to current indentation
18811 unless point is at the beginning of the line, in which the
18812 environment remains unintended."
18814 ;; cdlatex-environment always return nil. Therefore, capture output
18815 ;; first and determine if an environment was selected.
18816 (let* ((beg (point-marker))
18817 (end (copy-marker (point) t))
18819 (ignore-errors (cdlatex-environment environment item))
18821 ;; Figure out how many lines to move forward after the
18822 ;; environment has been inserted.
18823 (lines (when inserted
18825 (- (loop while (< beg (point))
18827 do (forward-line -1)
18830 (if (progn (goto-char beg)
18831 (and (progn (skip-chars-forward " \t") (eolp))
18832 (progn (skip-chars-backward " \t") (bolp))))
18834 (env (org-trim (delete-and-extract-region beg end))))
18836 ;; Get indentation of next line unless at column 0.
18837 (let ((ind (if (bolp) 0
18839 (org-return-indent)
18840 (prog1 (org-get-indentation)
18841 (when (progn (skip-chars-forward " \t") (eolp))
18842 (delete-region beg (point)))))))
18843 (bol (progn (skip-chars-backward " \t") (bolp))))
18844 ;; Insert a newline before environment unless at column zero
18845 ;; to "escape" the current line. Insert a newline if
18846 ;; something is one the same line as \end{ENVIRONMENT}.
18848 (concat (unless bol "\n") env
18849 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18850 (unless (zerop ind)
18853 (while (< (point) end)
18854 (unless (eolp) (org-indent-line-to ind))
18857 (forward-line lines)
18858 (org-indent-line-to ind)))
18859 (set-marker beg nil)
18860 (set-marker end nil)))
18863 ;;;; LaTeX fragments
18865 (defun org-inside-LaTeX-fragment-p ()
18866 "Test if point is inside a LaTeX fragment.
18867 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18868 sequence appearing also before point.
18869 Even though the matchers for math are configurable, this function assumes
18870 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18871 delimiters are skipped when they have been removed by customization.
18872 The return value is nil, or a cons cell with the delimiter and the
18873 position of this delimiter.
18875 This function does a reasonably good job, but can locally be fooled by
18876 for example currency specifications. For example it will assume being in
18877 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18878 fragments that are properly closed, but during editing, we have to live
18879 with the uncertainty caused by missing closing delimiters. This function
18880 looks only before point, not after."
18882 (let ((pos (point))
18883 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18885 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18887 dd-on str (start 0) m re)
18890 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18891 re (nth 1 (assoc "$" org-latex-regexps)))
18892 (while (string-match re str start)
18894 ((= (match-end 0) (length str))
18895 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18896 ((= (match-end 0) (- (length str) 5))
18898 (t (setq start (match-end 0))))))
18899 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18901 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18902 (and (match-beginning 2) (throw 'exit nil))
18904 (while (re-search-backward "\\$\\$" lim t)
18905 (setq dd-on (not dd-on)))
18907 (if dd-on (cons "$$" m))))))
18909 (defun org-inside-latex-macro-p ()
18910 "Is point inside a LaTeX macro or its arguments?"
18913 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18915 (defvar org-latex-fragment-image-overlays nil
18916 "List of overlays carrying the images of latex fragments.")
18917 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18919 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18920 "Remove all overlays with LaTeX fragment images in current buffer.
18921 When optional arguments BEG and END are non-nil, remove all
18922 overlays between them instead. Return t when some overlays were
18923 removed, nil otherwise."
18925 (setq org-latex-fragment-image-overlays
18926 (let ((beg (or beg (point-min)))
18927 (end (or end (point-max))))
18930 (and (>= (overlay-start o) beg)
18931 (<= (overlay-end o) end)
18932 (progn (delete-overlay o)
18933 (or removedp (setq removedp t)))))
18934 org-latex-fragment-image-overlays)))
18937 (define-obsolete-function-alias
18938 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18939 (defun org-toggle-latex-fragment (&optional arg)
18940 "Preview the LaTeX fragment at point, or all locally or globally.
18942 If the cursor is on a LaTeX fragment, create the image and overlay
18943 it over the source code, if there is none. Remove it otherwise.
18944 If there is no fragment at point, display all fragments in the
18947 With prefix ARG, preview or clear image for all fragments in the
18948 current subtree or in the whole buffer when used before the first
18949 headline. With a double prefix ARG \\[universal-argument] \
18950 \\[universal-argument] preview or clear images
18951 for all fragments in the buffer."
18953 (unless (buffer-file-name (buffer-base-buffer))
18954 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18955 (when (display-graphic-p)
18958 (let ((window-start (window-start)) msg)
18961 ((or (equal arg '(16))
18962 (and (equal arg '(4))
18963 (org-with-limited-levels (org-before-first-heading-p))))
18964 (if (org-remove-latex-fragment-image-overlays)
18965 (progn (message "LaTeX fragments images removed from buffer")
18967 (setq msg "Creating images for buffer...")))
18969 (org-with-limited-levels (org-back-to-heading t))
18970 (let ((beg (point))
18971 (end (progn (org-end-of-subtree t) (point))))
18972 (if (org-remove-latex-fragment-image-overlays beg end)
18974 (message "LaTeX fragment images removed from subtree")
18976 (setq msg "Creating images for subtree...")
18977 (narrow-to-region beg end))))
18978 ((let ((datum (org-element-context)))
18979 (when (memq (org-element-type datum)
18980 '(latex-environment latex-fragment))
18981 (let* ((beg (org-element-property :begin datum))
18982 (end (org-element-property :end datum)))
18983 (if (org-remove-latex-fragment-image-overlays beg end)
18984 (progn (message "LaTeX fragment image removed")
18986 (narrow-to-region beg end)
18987 (setq msg "Creating image..."))))))
18989 (org-with-limited-levels
18990 (let ((beg (if (org-at-heading-p) (line-beginning-position)
18991 (outline-previous-heading)
18993 (end (progn (outline-next-heading) (point))))
18994 (if (org-remove-latex-fragment-image-overlays beg end)
18996 (message "LaTeX fragment images removed from section")
18998 (setq msg "Creating images for section...")
18999 (narrow-to-region beg end))))))
19000 (let ((file (buffer-file-name (buffer-base-buffer))))
19002 (concat org-latex-preview-ltxpng-directory
19003 (file-name-sans-extension (file-name-nondirectory file)))
19004 ;; Emacs cannot overlay images from remote hosts.
19005 ;; Create it in `temporary-file-directory' instead.
19006 (if (file-remote-p file) temporary-file-directory
19008 'overlays msg 'forbuffer
19009 org-latex-create-formula-image-program)))
19010 ;; Work around a bug that doesn't restore window's start
19011 ;; when widening back the buffer.
19012 (set-window-start nil window-start)
19013 (message (concat msg "done")))))))
19015 (defun org-format-latex
19016 (prefix &optional dir overlays msg forbuffer processing-type)
19017 "Replace LaTeX fragments with links to an image, and produce images.
19019 When optional argument OVERLAYS is non-nil, display the image on
19020 top of the fragment instead of replacing it.
19022 PROCESSING-TYPE is the conversion method to use, as a symbol.
19024 Some of the options can be changed using the variable
19025 `org-format-latex-options', which see."
19026 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19027 (unless (eq processing-type 'verbatim)
19028 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19031 (goto-char (point-min))
19032 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19033 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19034 (overlay-recenter (point-max)))
19035 (while (re-search-forward math-regexp nil t)
19036 (unless (and overlays
19037 (eq (get-char-property (point) 'org-overlay-type)
19038 'org-latex-overlay))
19039 (let* ((context (org-element-context))
19040 (type (org-element-type context)))
19041 (when (memq type '(latex-environment latex-fragment))
19042 (let ((block-type (eq type 'latex-environment))
19043 (value (org-element-property :value context))
19044 (beg (org-element-property :begin context))
19045 (end (save-excursion
19046 (goto-char (org-element-property :end context))
19047 (skip-chars-backward " \r\t\n")
19049 (case processing-type
19051 ;; Prepare for MathJax processing.
19052 (if (eq (char-after beg) ?$)
19054 (delete-region beg end)
19055 (insert "\\(" (substring value 1 -1) "\\)"))
19057 ((dvipng imagemagick)
19058 ;; Process to an image.
19061 (let* ((face (face-at-point))
19062 ;; Get the colors from the face at point.
19064 (let ((color (plist-get org-format-latex-options
19066 (if (and forbuffer (eq color 'auto))
19067 (face-attribute face :foreground nil 'default)
19070 (let ((color (plist-get org-format-latex-options
19072 (if (and forbuffer (eq color 'auto))
19073 (face-attribute face :background nil 'default)
19075 (hash (sha1 (prin1-to-string
19076 (list org-format-latex-header
19077 org-latex-default-packages-alist
19078 org-latex-packages-alist
19079 org-format-latex-options
19080 forbuffer value fg bg))))
19081 (absprefix (expand-file-name prefix dir))
19082 (linkfile (format "%s_%s.png" prefix hash))
19083 (movefile (format "%s_%s.png" absprefix hash))
19084 (sep (and block-type "\n\n"))
19085 (link (concat sep "[[file:" linkfile "]]" sep))
19087 (org-combine-plists
19088 org-format-latex-options
19089 `(:foreground ,fg :background ,bg))))
19090 (when msg (message msg cnt))
19091 (unless checkdir-flag ; Ensure the directory exists.
19092 (setq checkdir-flag t)
19093 (let ((todir (file-name-directory absprefix)))
19094 (unless (file-directory-p todir)
19095 (make-directory todir t))))
19096 (unless (file-exists-p movefile)
19097 (org-create-formula-image
19098 value movefile options forbuffer processing-type))
19101 (dolist (o (overlays-in beg end))
19102 (when (eq (overlay-get o 'org-overlay-type)
19103 'org-latex-overlay)
19104 (delete-overlay o)))
19105 (let ((ov (make-overlay beg end)))
19108 'org-latex-overlay)
19109 (overlay-put ov 'evaporate t)
19110 (if (featurep 'xemacs)
19112 (overlay-put ov 'invisible t)
19116 (vector 'png :file movefile))))
19123 (push ov org-latex-fragment-image-overlays))
19125 (delete-region beg end)
19127 (org-add-props link
19128 (list 'org-latex-src
19129 (replace-regexp-in-string "\"" "" value)
19130 'org-latex-src-embed-type
19131 (if block-type 'paragraph 'character)))))))
19133 ;; Process to MathML.
19134 (unless (org-format-latex-mathml-available-p)
19135 (user-error "LaTeX to MathML converter not configured"))
19137 (when msg (message msg cnt))
19139 (delete-region beg end)
19140 (insert (org-format-latex-as-mathml
19141 value block-type prefix dir)))
19143 (error "Unknown conversion type %s for LaTeX fragments"
19144 processing-type)))))))))))
19146 (defun org-create-math-formula (latex-frag &optional mathml-file)
19147 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19148 Use `org-latex-to-mathml-convert-command'. If the conversion is
19149 sucessful, return the portion between \"<math...> </math>\"
19150 elements otherwise return nil. When MATHML-FILE is specified,
19151 write the results in to that file. When invoked as an
19152 interactive command, prompt for LATEX-FRAG, with initial value
19153 set to the current active region and echo the results for user
19155 (interactive (list (let ((frag (when (org-region-active-p)
19156 (buffer-substring-no-properties
19157 (region-beginning) (region-end)))))
19158 (read-string "LaTeX Fragment: " frag nil frag))))
19159 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19160 (let* ((tmp-in-file (file-relative-name
19161 (make-temp-name (expand-file-name "ltxmathml-in"))))
19162 (ignore (write-region latex-frag nil tmp-in-file))
19163 (tmp-out-file (file-relative-name
19164 (make-temp-name (expand-file-name "ltxmathml-out"))))
19166 org-latex-to-mathml-convert-command
19167 `((?j . ,(and org-latex-to-mathml-jar-file
19168 (shell-quote-argument
19170 org-latex-to-mathml-jar-file))))
19171 (?I . ,(shell-quote-argument tmp-in-file))
19173 (?o . ,(shell-quote-argument tmp-out-file)))))
19174 mathml shell-command-output)
19175 (when (org-called-interactively-p 'any)
19176 (unless (org-format-latex-mathml-available-p)
19177 (user-error "LaTeX to MathML converter not configured")))
19178 (message "Running %s" cmd)
19179 (setq shell-command-output (shell-command-to-string cmd))
19181 (when (file-readable-p tmp-out-file)
19182 (with-current-buffer (find-file-noselect tmp-out-file t)
19183 (goto-char (point-min))
19184 (when (re-search-forward
19187 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19192 (prog1 (match-string 0) (kill-buffer))))))
19196 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19198 (write-region mathml nil mathml-file))
19199 (when (org-called-interactively-p 'any)
19201 ((message "LaTeX to MathML conversion failed")
19202 (message shell-command-output)))
19203 (delete-file tmp-in-file)
19204 (when (file-exists-p tmp-out-file)
19205 (delete-file tmp-out-file))
19208 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19209 prefix &optional dir)
19210 "Use `org-create-math-formula' but check local cache first."
19211 (let* ((absprefix (expand-file-name prefix dir))
19212 (print-length nil) (print-level nil)
19213 (formula-id (concat
19218 org-latex-to-mathml-convert-command)))))
19219 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19220 (formula-cache-dir (file-name-directory formula-cache)))
19222 (unless (file-directory-p formula-cache-dir)
19223 (make-directory formula-cache-dir t))
19225 (unless (file-exists-p formula-cache)
19226 (org-create-math-formula latex-frag formula-cache))
19228 (if (file-exists-p formula-cache)
19229 ;; Successful conversion. Return the link to MathML file.
19231 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19232 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19233 'org-latex-src-embed-type (if latex-frag-type
19234 'paragraph 'character)))
19235 ;; Failed conversion. Return the LaTeX fragment verbatim
19238 (defun org-create-formula-image (string tofile options buffer &optional type)
19239 "Create an image from LaTeX source using dvipng or convert.
19240 This function calls either `org-create-formula-image-with-dvipng'
19241 or `org-create-formula-image-with-imagemagick' depending on the
19242 value of `org-latex-create-formula-image-program' or on the value
19243 of the optional TYPE variable.
19245 Note: ultimately these two function should be combined as they
19246 share a good deal of logic."
19247 (org-check-external-command
19248 "latex" "needed to convert LaTeX fragments to images")
19250 (case (or type org-latex-create-formula-image-program)
19252 (org-check-external-command
19253 "dvipng" "needed to convert LaTeX fragments to images")
19254 #'org-create-formula-image-with-dvipng)
19256 (org-check-external-command
19257 "convert" "you need to install imagemagick")
19258 #'org-create-formula-image-with-imagemagick)
19260 "Invalid value of `org-latex-create-formula-image-program'")))
19261 string tofile options buffer))
19263 (declare-function org-export-get-backend "ox" (name))
19264 (declare-function org-export--get-global-options "ox" (&optional backend))
19265 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19266 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19267 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19268 (defun org-create-formula--latex-header ()
19269 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19270 (let ((info (org-combine-plists (org-export--get-global-options
19271 (org-export-get-backend 'latex))
19272 (org-export--get-inbuffer-options
19273 (org-export-get-backend 'latex)))))
19274 (org-latex-guess-babel-language
19275 (org-latex-guess-inputenc
19276 (org-splice-latex-header
19277 org-format-latex-header
19278 org-latex-default-packages-alist
19279 org-latex-packages-alist t
19280 (plist-get info :latex-header)))
19283 (defun org--get-display-dpi ()
19284 "Get the DPI of the display.
19286 Assumes that the display has the same pixel width in the
19287 horizontal and vertical directions."
19288 (if (display-graphic-p)
19289 (round (/ (display-pixel-height)
19290 (/ (display-mm-height) 25.4)))
19291 (error "Attempt to calculate the dpi of a non-graphic display")))
19293 ;; This function borrows from Ganesh Swami's latex2png.el
19294 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19295 "This calls dvipng."
19296 (require 'ox-latex)
19297 (let* ((tmpdir (if (featurep 'xemacs)
19299 temporary-file-directory))
19300 (texfilebase (make-temp-name
19301 (expand-file-name "orgtex" tmpdir)))
19302 (texfile (concat texfilebase ".tex"))
19303 (dvifile (concat texfilebase ".dvi"))
19304 (pngfile (concat texfilebase ".png"))
19305 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19306 ;; This assumes that the display has the same pixel width in
19307 ;; the horizontal and vertical directions
19308 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19309 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19311 (bg (or (plist-get options (if buffer :background :html-background))
19313 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19314 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19315 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19316 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19317 (let ((latex-header (org-create-formula--latex-header)))
19318 (with-temp-file texfile
19319 (insert latex-header)
19320 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19321 (let ((dir default-directory))
19324 (call-process "latex" nil nil nil texfile))
19326 (if (not (file-exists-p dvifile))
19327 (progn (message "Failed to create dvi file from %s" texfile) nil)
19329 (if (featurep 'xemacs)
19330 (call-process "dvipng" nil nil nil
19335 (call-process "dvipng" nil nil nil
19338 ;;"-x" scale "-y" scale
19342 (if (not (file-exists-p pngfile))
19343 (if org-format-latex-signal-error
19344 (error "Failed to create png file from %s" texfile)
19345 (message "Failed to create png file from %s" texfile)
19347 ;; Use the requested file name and clean up
19348 (copy-file pngfile tofile 'replace)
19349 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19350 (if (file-exists-p (concat texfilebase e))
19351 (delete-file (concat texfilebase e))))
19354 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19355 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19356 "This calls convert, which is included into imagemagick."
19357 (require 'ox-latex)
19358 (let* ((tmpdir (if (featurep 'xemacs)
19360 temporary-file-directory))
19361 (texfilebase (make-temp-name
19362 (expand-file-name "orgtex" tmpdir)))
19363 (texfile (concat texfilebase ".tex"))
19364 (pdffile (concat texfilebase ".pdf"))
19365 (pngfile (concat texfilebase ".png"))
19366 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19367 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19368 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19370 (bg (or (plist-get options (if buffer :background :html-background))
19372 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19373 (setq fg (org-latex-color-format fg)))
19374 (if (eq bg 'default) (setq bg (org-latex-color :background))
19375 (setq bg (org-latex-color-format
19376 (if (string= bg "Transparent") "white" bg))))
19377 (let ((latex-header (org-create-formula--latex-header)))
19378 (with-temp-file texfile
19379 (insert latex-header)
19380 (insert "\n\\begin{document}\n"
19381 "\\definecolor{fg}{rgb}{" fg "}\n"
19382 "\\definecolor{bg}{rgb}{" bg "}\n"
19383 "\n\\pagecolor{bg}\n"
19387 "\n\\end{document}\n")))
19388 (org-latex-compile texfile t)
19389 (if (not (file-exists-p pdffile))
19390 (progn (message "Failed to create pdf file from %s" texfile) nil)
19392 (if (featurep 'xemacs)
19393 (call-process "convert" nil nil nil
19399 ;; "-sharpen" "0x1.0"
19401 (call-process "convert" nil nil nil
19407 ;; "-sharpen" "0x1.0"
19409 (if (not (file-exists-p pngfile))
19410 (if org-format-latex-signal-error
19411 (error "Failed to create png file from %s" texfile)
19412 (message "Failed to create png file from %s" texfile)
19414 ;; Use the requested file name and clean up
19415 (copy-file pngfile tofile 'replace)
19416 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19417 (if (file-exists-p (concat texfilebase e))
19418 (delete-file (concat texfilebase e))))
19421 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19422 "Fill a LaTeX header template TPL.
19423 In the template, the following place holders will be recognized:
19425 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19426 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19427 [PACKAGES] \\usepackage statements for PKG
19428 [NO-PACKAGES] do not include PKG
19429 [EXTRA] the string EXTRA
19430 [NO-EXTRA] do not include EXTRA
19432 For backward compatibility, if both the positive and the negative place
19433 holder is missing, the positive one (without the \"NO-\") will be
19434 assumed to be present at the end of the template.
19435 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19437 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19438 (let (rpl (end ""))
19439 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19440 (setq rpl (if (or (match-end 1) (not def-pkg))
19441 "" (org-latex-packages-to-string def-pkg snippets-p t))
19442 tpl (replace-match rpl t t tpl))
19443 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19445 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19446 (setq rpl (if (or (match-end 1) (not pkg))
19447 "" (org-latex-packages-to-string pkg snippets-p t))
19448 tpl (replace-match rpl t t tpl))
19451 (org-latex-packages-to-string pkg snippets-p)))))
19453 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19454 (setq rpl (if (or (match-end 1) (not extra))
19455 "" (concat extra "\n"))
19456 tpl (replace-match rpl t t tpl))
19457 (if (and extra (string-match "\\S-" extra))
19458 (setq end (concat end "\n" extra))))
19460 (if (string-match "\\S-" end)
19461 (concat tpl "\n" end)
19464 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19465 "Turn an alist of packages into a string with the \\usepackage macros."
19466 (setq pkg (mapconcat (lambda(p)
19469 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19470 (format "%% Package %s omitted" (cadr p)))
19471 ((equal "" (car p))
19472 (format "\\usepackage{%s}" (cadr p)))
19474 (format "\\usepackage[%s]{%s}"
19475 (car p) (cadr p)))))
19478 (if newline (concat pkg "\n") pkg))
19480 (defun org-dvipng-color (attr)
19481 "Return a RGB color specification for dvipng."
19482 (apply 'format "rgb %s %s %s"
19483 (mapcar 'org-normalize-color
19484 (if (featurep 'xemacs)
19485 (color-rgb-components
19486 (face-property 'default
19487 (cond ((eq attr :foreground) 'foreground)
19488 ((eq attr :background) 'background))))
19489 (color-values (face-attribute 'default attr nil))))))
19491 (defun org-dvipng-color-format (color-name)
19492 "Convert COLOR-NAME to a RGB color value for dvipng."
19493 (apply 'format "rgb %s %s %s"
19494 (mapcar 'org-normalize-color
19495 (color-values color-name))))
19497 (defun org-latex-color (attr)
19498 "Return a RGB color for the LaTeX color package."
19499 (apply 'format "%s,%s,%s"
19500 (mapcar 'org-normalize-color
19501 (if (featurep 'xemacs)
19502 (color-rgb-components
19503 (face-property 'default
19504 (cond ((eq attr :foreground) 'foreground)
19505 ((eq attr :background) 'background))))
19506 (color-values (face-attribute 'default attr nil))))))
19508 (defun org-latex-color-format (color-name)
19509 "Convert COLOR-NAME to a RGB color value."
19510 (apply 'format "%s,%s,%s"
19511 (mapcar 'org-normalize-color
19512 (color-values color-name))))
19514 (defun org-normalize-color (value)
19515 "Return string to be used as color value for an RGB component."
19516 (format "%g" (/ value 65535.0)))
19522 (defvar org-inline-image-overlays nil)
19523 (make-variable-buffer-local 'org-inline-image-overlays)
19525 (defun org-toggle-inline-images (&optional include-linked)
19526 "Toggle the display of inline images.
19527 INCLUDE-LINKED is passed to `org-display-inline-images'."
19529 (if org-inline-image-overlays
19531 (org-remove-inline-images)
19532 (when (org-called-interactively-p 'interactive)
19533 (message "Inline image display turned off")))
19534 (org-display-inline-images include-linked)
19535 (when (org-called-interactively-p 'interactive)
19536 (message (if org-inline-image-overlays
19537 (format "%d images displayed inline"
19538 (length org-inline-image-overlays))
19539 "No images to display inline")))))
19541 (defun org-redisplay-inline-images ()
19542 "Refresh the display of inline images."
19544 (if (not org-inline-image-overlays)
19545 (org-toggle-inline-images)
19546 (org-toggle-inline-images)
19547 (org-toggle-inline-images)))
19549 (defun org-display-inline-images (&optional include-linked refresh beg end)
19550 "Display inline images.
19552 An inline image is a link which follows either of these
19555 1. Its path is a file with an extension matching return value
19556 from `image-file-name-regexp' and it has no contents.
19558 2. Its description consists in a single link of the previous
19561 When optional argument INCLUDE-LINKED is non-nil, also links with
19562 a text description part will be inlined. This can be nice for
19563 a quick look at those images, but it does not reflect what
19564 exported files will look like.
19566 When optional argument REFRESH is non-nil, refresh existing
19567 images between BEG and END. This will create new image displays
19568 only if necessary. BEG and END default to the buffer
19571 (when (display-graphic-p)
19573 (org-remove-inline-images)
19574 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19575 (org-with-wide-buffer
19576 (goto-char (or beg (point-min)))
19577 (let ((case-fold-search t)
19578 (file-extension-re (org-image-file-name-regexp)))
19579 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19580 (let ((link (save-match-data (org-element-context))))
19581 ;; Check if we're at an inline image.
19582 (when (and (equal (org-element-property :type link) "file")
19584 (not (org-element-property :contents-begin link)))
19585 (let ((parent (org-element-property :parent link)))
19586 (or (not (eq (org-element-type parent) 'link))
19587 (not (cdr (org-element-contents parent)))))
19588 (org-string-match-p file-extension-re
19589 (org-element-property :path link)))
19590 (let ((file (expand-file-name
19592 (org-element-property :path link)))))
19593 (when (file-exists-p file)
19595 ;; Apply `org-image-actual-width' specifications.
19597 ((not (image-type-available-p 'imagemagick)) nil)
19598 ((eq org-image-actual-width t) nil)
19599 ((listp org-image-actual-width)
19601 ;; First try to find a width among
19602 ;; attributes associated to the paragraph
19603 ;; containing link.
19606 (while (and (setq e (org-element-property
19608 (not (eq (org-element-type e)
19613 (goto-char (org-element-property :begin paragraph))
19616 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19617 (org-element-property
19618 :post-affiliated paragraph)
19620 (string-to-number (match-string 1))))))
19621 ;; Otherwise, fall-back to provided number.
19622 (car org-image-actual-width)))
19623 ((numberp org-image-actual-width)
19624 org-image-actual-width)))
19625 (old (get-char-property-and-overlay
19626 (org-element-property :begin link)
19627 'org-image-overlay)))
19628 (if (and (car-safe old) refresh)
19629 (image-refresh (overlay-get (cdr old) 'display))
19630 (let ((image (create-image file
19631 (and width 'imagemagick)
19636 ;; If inline image is the description
19637 ;; of another link, be sure to
19638 ;; consider the latter as the one to
19639 ;; apply the overlay on.
19641 (org-element-property :parent link)))
19642 (if (eq (org-element-type parent) 'link)
19646 (org-element-property :begin link)
19649 (org-element-property :end link))
19650 (skip-chars-backward " \t")
19652 (overlay-put ov 'display image)
19653 (overlay-put ov 'face 'default)
19654 (overlay-put ov 'org-image-overlay t)
19656 ov 'modification-hooks
19657 (list 'org-display-inline-remove-overlay))
19658 (push ov org-inline-image-overlays)))))))))))))))
19660 (define-obsolete-function-alias
19661 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19663 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19664 "Remove inline-display overlay if a corresponding region is modified."
19665 (let ((inhibit-modification-hooks t))
19666 (when (and ov after)
19667 (delete ov org-inline-image-overlays)
19668 (delete-overlay ov))))
19670 (defun org-remove-inline-images ()
19671 "Remove inline display of images."
19673 (mapc 'delete-overlay org-inline-image-overlays)
19674 (setq org-inline-image-overlays nil))
19678 ;; Outline functions from `outline-mode-prefix-map'
19679 ;; that can be remapped in Org:
19680 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19681 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19682 (define-key org-mode-map [remap outline-forward-same-level]
19683 'org-forward-heading-same-level)
19684 (define-key org-mode-map [remap outline-backward-same-level]
19685 'org-backward-heading-same-level)
19686 (define-key org-mode-map [remap show-branches]
19687 'org-kill-note-or-show-branches)
19688 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19689 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19690 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19691 (define-key org-mode-map [remap outline-next-visible-heading]
19692 'org-next-visible-heading)
19693 (define-key org-mode-map [remap outline-previous-visible-heading]
19694 'org-previous-visible-heading)
19696 ;; Outline functions from `outline-mode-prefix-map' that can not
19697 ;; be remapped in Org:
19699 ;; - the column "key binding" shows whether the Outline function is still
19700 ;; available in Org mode on the same key that it has been bound to in
19702 ;; - "overridden": key used for a different functionality in Org mode
19703 ;; - else: key still bound to the same Outline function in Org mode
19705 ;; | Outline function | key binding | Org replacement |
19706 ;; |------------------------------------+-------------+--------------------------|
19707 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19708 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19709 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19710 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19711 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19712 ;; | `show-entry' | overridden | no replacement |
19713 ;; | `show-children' | `C-c C-i' | visibility cycling |
19714 ;; | `show-branches' | `C-c C-k' | still same function |
19715 ;; | `show-subtree' | overridden | visibility cycling |
19716 ;; | `show-all' | overridden | no replacement |
19717 ;; | `hide-subtree' | overridden | visibility cycling |
19718 ;; | `hide-body' | overridden | no replacement |
19719 ;; | `hide-entry' | overridden | visibility cycling |
19720 ;; | `hide-leaves' | overridden | no replacement |
19721 ;; | `hide-sublevels' | overridden | no replacement |
19722 ;; | `hide-other' | overridden | no replacement |
19724 ;; Make `C-c C-x' a prefix key
19725 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19727 ;; TAB key with modifiers
19728 (org-defkey org-mode-map "\C-i" 'org-cycle)
19729 (org-defkey org-mode-map [(tab)] 'org-cycle)
19730 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19731 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19732 ;; The following line is necessary under Suse GNU/Linux
19733 (unless (featurep 'xemacs)
19734 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19735 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19736 (define-key org-mode-map [backtab] 'org-shifttab)
19738 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19739 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19740 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19742 ;; Cursor keys with modifiers
19743 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19744 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19745 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19746 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19748 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19749 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19750 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19751 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19752 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19753 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19755 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19756 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19757 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19758 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19760 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19761 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19762 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19763 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19766 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19767 (mapc (lambda (pair)
19768 (define-key org-babel-map (car pair) (cdr pair)))
19769 org-babel-key-bindings)
19771 ;;; Extra keys for tty access.
19772 ;; We only set them when really needed because otherwise the
19773 ;; menus don't show the simple keys
19775 (when (or org-use-extra-keys
19776 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19777 (not window-system))
19778 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19779 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19780 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19781 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19782 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19783 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19784 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19785 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19786 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19787 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19788 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19789 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19790 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19791 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19792 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19793 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19794 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19795 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19796 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19797 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19798 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19799 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19800 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19801 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19802 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19803 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19804 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19805 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19807 ;; All the other keys
19809 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19810 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19811 (if (boundp 'narrow-map)
19812 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19813 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19814 (if (boundp 'narrow-map)
19815 (org-defkey narrow-map "b" 'org-narrow-to-block)
19816 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19817 (if (boundp 'narrow-map)
19818 (org-defkey narrow-map "e" 'org-narrow-to-element)
19819 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19820 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19821 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19822 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19823 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19824 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19825 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19826 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19827 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19828 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19829 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19830 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree)
19831 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19832 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19833 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19834 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19835 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19836 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19837 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19838 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19839 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19840 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19841 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19842 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19843 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19844 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19845 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19846 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19847 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19848 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19849 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19850 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19851 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19852 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19853 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19854 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19855 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19856 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19857 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19858 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19859 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19860 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19861 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19862 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19863 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19864 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19865 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19866 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19867 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19868 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19869 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19870 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19871 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19872 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19873 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19874 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19875 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19876 (org-defkey org-mode-map "\C-c^" 'org-sort)
19877 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19878 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19879 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19880 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19881 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19882 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19883 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19884 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19885 (org-defkey org-mode-map "\C-m" 'org-return)
19886 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19887 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19888 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19889 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19890 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19891 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19892 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19893 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19894 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19895 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19896 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19897 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19898 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19899 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19900 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19901 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19902 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19903 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19904 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19905 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19906 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19907 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19908 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19909 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19910 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19912 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19913 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19914 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19916 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19917 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19918 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19919 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19920 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19921 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19922 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19923 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19924 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19925 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19926 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19927 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19928 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19929 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19930 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19931 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19932 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19933 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19934 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19935 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19936 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19937 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19939 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19940 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19941 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19942 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19943 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19945 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19947 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19949 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19950 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19952 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19955 (when (featurep 'xemacs)
19956 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19959 (defconst org-speed-commands-default
19961 ("Outline Navigation")
19962 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19963 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19964 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19965 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19966 ("F" . org-next-block)
19967 ("B" . org-previous-block)
19968 ("u" . (org-speed-move-safe 'outline-up-heading))
19970 ("g" . (org-refile t))
19971 ("Outline Visibility")
19973 ("C" . org-shifttab)
19974 (" " . org-display-outline-path)
19975 ("s" . org-narrow-to-subtree)
19976 ("=" . org-columns)
19977 ("Outline Structure Editing")
19979 ("D" . org-metadown)
19980 ("r" . org-metaright)
19981 ("l" . org-metaleft)
19982 ("R" . org-shiftmetaright)
19983 ("L" . org-shiftmetaleft)
19984 ("i" . (progn (forward-char 1) (call-interactively
19985 'org-insert-heading-respect-content)))
19988 ("a" . org-archive-subtree-default-with-confirmation)
19989 ("@" . org-mark-subtree)
19990 ("#" . org-toggle-comment)
19992 ("I" . org-clock-in)
19993 ("O" . org-clock-out)
19994 ("Meta Data Editing")
19996 ("," . (org-priority))
19997 ("0" . (org-priority ?\ ))
19998 ("1" . (org-priority ?A))
19999 ("2" . (org-priority ?B))
20000 ("3" . (org-priority ?C))
20001 (":" . org-set-tags-command)
20002 ("e" . org-set-effort)
20003 ("E" . org-inc-effort)
20004 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
20005 (org-entry-put (point) "APPT_WARNTIME" m)))
20006 ("Agenda Views etc")
20008 ("/" . org-sparse-tree)
20010 ("o" . org-open-at-point)
20011 ("?" . org-speed-command-help)
20012 ("<" . (org-agenda-set-restriction-lock 'subtree))
20013 (">" . (org-agenda-remove-restriction-lock))
20015 "The default speed commands.")
20017 (defun org-print-speed-command (e)
20018 (if (> (length (car e)) 1)
20023 (princ (make-string (length (car e)) ?-))
20027 (if (symbolp (cdr e))
20028 (princ (symbol-name (cdr e)))
20032 (defun org-speed-command-help ()
20033 "Show the available speed commands."
20035 (if (not org-use-speed-commands)
20036 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20037 (with-output-to-temp-buffer "*Help*"
20038 (princ "User-defined Speed commands\n===========================\n")
20039 (mapc 'org-print-speed-command org-speed-commands-user)
20041 (princ "Built-in Speed commands\n=======================\n")
20042 (mapc 'org-print-speed-command org-speed-commands-default))
20043 (with-current-buffer "*Help*"
20044 (setq truncate-lines t))))
20046 (defun org-speed-move-safe (cmd)
20047 "Execute CMD, but make sure that the cursor always ends up in a headline.
20048 If not, return to the original position and throw an error."
20050 (let ((pos (point)))
20051 (call-interactively cmd)
20052 (unless (and (bolp) (org-at-heading-p))
20054 (error "Boundary reached while executing %s" cmd))))
20056 (defvar org-self-insert-command-undo-counter 0)
20058 (defvar org-table-auto-blank-field) ; defined in org-table.el
20059 (defvar org-speed-command nil)
20061 (define-obsolete-function-alias
20062 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20064 (defun org-speed-command-activate (keys)
20065 "Hook for activating single-letter speed commands.
20066 `org-speed-commands-default' specifies a minimal command set.
20067 Use `org-speed-commands-user' for further customization."
20068 (when (or (and (bolp) (looking-at org-outline-regexp))
20069 (and (functionp org-use-speed-commands)
20070 (funcall org-use-speed-commands)))
20071 (cdr (assoc keys (append org-speed-commands-user
20072 org-speed-commands-default)))))
20074 (define-obsolete-function-alias
20075 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20077 (defun org-babel-speed-command-activate (keys)
20078 "Hook for activating single-letter code block commands."
20079 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20080 (cdr (assoc keys org-babel-key-bindings))))
20082 (defcustom org-speed-command-hook
20083 '(org-speed-command-default-hook org-babel-speed-command-hook)
20084 "Hook for activating speed commands at strategic locations.
20085 Hook functions are called in sequence until a valid handler is
20088 Each hook takes a single argument, a user-pressed command key
20089 which is also a `self-insert-command' from the global map.
20091 Within the hook, examine the cursor position and the command key
20092 and return nil or a valid handler as appropriate. Handler could
20093 be one of an interactive command, a function, or a form.
20095 Set `org-use-speed-commands' to non-nil value to enable this
20096 hook. The default setting is `org-speed-command-activate'."
20097 :group 'org-structure
20101 (defun org-self-insert-command (N)
20102 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20103 If the cursor is in a table looking at whitespace, the whitespace is
20104 overwritten, and the table is not marked as requiring realignment."
20106 (org-check-before-invisible-edit 'insert)
20108 ((and org-use-speed-commands
20109 (let ((kv (this-command-keys-vector)))
20110 (setq org-speed-command
20111 (run-hook-with-args-until-success
20112 'org-speed-command-hook
20113 (make-string 1 (aref kv (1- (length kv))))))))
20115 ((commandp org-speed-command)
20116 (setq this-command org-speed-command)
20117 (call-interactively org-speed-command))
20118 ((functionp org-speed-command)
20119 (funcall org-speed-command))
20120 ((and org-speed-command (listp org-speed-command))
20121 (eval org-speed-command))
20122 (t (let (org-use-speed-commands)
20123 (call-interactively 'org-self-insert-command)))))
20127 ;; check if we blank the field, and if that triggers align
20128 (and (featurep 'org-table) org-table-auto-blank-field
20130 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20131 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20132 ;; got extra space, this field does not determine column width
20133 (let (org-table-may-need-update) (org-table-blank-field))
20134 ;; no extra space, this field may determine column width
20135 (org-table-blank-field)))
20138 (looking-at "[^|\n]* |"))
20139 (let (org-table-may-need-update)
20140 (goto-char (1- (match-end 0)))
20141 (backward-delete-char 1)
20142 (goto-char (match-beginning 0))
20143 (self-insert-command N)))
20145 (setq org-table-may-need-update t)
20146 (self-insert-command N)
20147 (org-fix-tags-on-the-fly)
20148 (if org-self-insert-cluster-for-undo
20149 (if (not (eq last-command 'org-self-insert-command))
20150 (setq org-self-insert-command-undo-counter 1)
20151 (if (>= org-self-insert-command-undo-counter 20)
20152 (setq org-self-insert-command-undo-counter 1)
20153 (and (> org-self-insert-command-undo-counter 0)
20154 buffer-undo-list (listp buffer-undo-list)
20155 (not (cadr buffer-undo-list)) ; remove nil entry
20156 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20157 (setq org-self-insert-command-undo-counter
20158 (1+ org-self-insert-command-undo-counter))))))))
20160 (defun org-check-before-invisible-edit (kind)
20161 "Check is editing if kind KIND would be dangerous with invisible text around.
20162 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20163 ;; First, try to get out of here as quickly as possible, to reduce overhead
20164 (if (and org-catch-invisible-edits
20165 (or (not (boundp 'visible-mode)) (not visible-mode))
20166 (or (get-char-property (point) 'invisible)
20167 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20168 ;; OK, we need to take a closer look
20169 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20170 (invisible-before-point (if (bobp) nil (get-char-property
20171 (1- (point)) 'invisible)))
20172 (border-and-ok-direction
20174 ;; Check if we are acting predictably before invisible text
20175 (and invisible-at-point (not invisible-before-point)
20176 (memq kind '(insert delete-backward)))
20177 ;; Check if we are acting predictably after invisible text
20178 ;; This works not well, and I have turned it off. It seems
20179 ;; better to always show and stop after invisible text.
20180 ;; (and (not invisible-at-point) invisible-before-point
20181 ;; (memq kind '(insert delete)))
20183 (when (or (memq invisible-at-point '(outline org-hide-block t))
20184 (memq invisible-before-point '(outline org-hide-block t)))
20185 (if (eq org-catch-invisible-edits 'error)
20186 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20187 (if (and org-custom-properties-overlays
20188 (y-or-n-p "Display invisible properties in this buffer? "))
20189 (org-toggle-custom-properties-visibility)
20190 ;; Make the area visible
20192 (if invisible-before-point
20193 (goto-char (previous-single-char-property-change
20194 (point) 'invisible)))
20197 ((eq org-catch-invisible-edits 'show)
20198 ;; That's it, we do the edit after showing
20200 "Unfolding invisible region around point before editing")
20202 ((and (eq org-catch-invisible-edits 'smart)
20203 border-and-ok-direction)
20204 (message "Unfolding invisible region around point before editing"))
20206 ;; Don't do the edit, make the user repeat it in full visibility
20207 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20209 (defun org-fix-tags-on-the-fly ()
20210 (when (and (equal (char-after (point-at-bol)) ?*)
20211 (org-at-heading-p))
20212 (org-align-tags-here org-tags-column)))
20214 (defun org-delete-backward-char (N)
20215 "Like `delete-backward-char', insert whitespace at field end in tables.
20216 When deleting backwards, in tables this function will insert whitespace in
20217 front of the next \"|\" separator, to keep the table aligned. The table will
20218 still be marked for re-alignment if the field did fill the entire column,
20219 because, in this case the deletion might narrow the column."
20222 (org-check-before-invisible-edit 'delete-backward)
20223 (if (and (org-table-p)
20225 (string-match "|" (buffer-substring (point-at-bol) (point)))
20226 (looking-at ".*?|"))
20227 (let ((pos (point))
20228 (noalign (looking-at "[^|\n\r]* |"))
20229 (c org-table-may-need-update))
20230 (backward-delete-char N)
20231 (if (not overwrite-mode)
20233 (skip-chars-forward "^|")
20235 (goto-char (1- pos))))
20236 ;; noalign: if there were two spaces at the end, this field
20237 ;; does not determine the width of the column.
20238 (if noalign (setq org-table-may-need-update c)))
20239 (backward-delete-char N)
20240 (org-fix-tags-on-the-fly))))
20242 (defun org-delete-char (N)
20243 "Like `delete-char', but insert whitespace at field end in tables.
20244 When deleting characters, in tables this function will insert whitespace in
20245 front of the next \"|\" separator, to keep the table aligned. The table will
20246 still be marked for re-alignment if the field did fill the entire column,
20247 because, in this case the deletion might narrow the column."
20250 (org-check-before-invisible-edit 'delete)
20251 (if (and (org-table-p)
20253 (not (= (char-after) ?|))
20255 (if (looking-at ".*?|")
20256 (let ((pos (point))
20257 (noalign (looking-at "[^|\n\r]* |"))
20258 (c org-table-may-need-update))
20260 (concat (substring (match-string 0) 1 -1) " |") nil t)
20262 ;; noalign: if there were two spaces at the end, this field
20263 ;; does not determine the width of the column.
20264 (if noalign (setq org-table-may-need-update c)))
20267 (org-fix-tags-on-the-fly))))
20269 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20270 (put 'org-self-insert-command 'delete-selection
20272 (not (run-hook-with-args-until-success
20273 'self-insert-uses-region-functions))))
20274 (put 'orgtbl-self-insert-command 'delete-selection
20276 (not (run-hook-with-args-until-success
20277 'self-insert-uses-region-functions))))
20278 (put 'org-delete-char 'delete-selection 'supersede)
20279 (put 'org-delete-backward-char 'delete-selection 'supersede)
20280 (put 'org-yank 'delete-selection 'yank)
20282 ;; Make `flyspell-mode' delay after some commands
20283 (put 'org-self-insert-command 'flyspell-delayed t)
20284 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20285 (put 'org-delete-char 'flyspell-delayed t)
20286 (put 'org-delete-backward-char 'flyspell-delayed t)
20288 ;; Make pabbrev-mode expand after org-mode commands
20289 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20290 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20292 (defun org-remap (map &rest commands)
20293 "In MAP, remap the functions given in COMMANDS.
20294 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20297 (setq old (pop commands) new (pop commands))
20298 (if (fboundp 'command-remapping)
20299 (org-defkey map (vector 'remap old) new)
20300 (substitute-key-definition old new map global-map)))))
20302 (defun org-transpose-words ()
20303 "Transpose words for Org.
20304 This uses the `org-mode-transpose-word-syntax-table' syntax
20305 table, which interprets characters in `org-emphasis-alist' as
20306 word constituents."
20308 (with-syntax-table org-mode-transpose-word-syntax-table
20309 (call-interactively 'transpose-words)))
20310 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20312 (when (eq org-enable-table-editor 'optimized)
20313 ;; If the user wants maximum table support, we need to hijack
20314 ;; some standard editing functions
20315 (org-remap org-mode-map
20316 'self-insert-command 'org-self-insert-command
20317 'delete-char 'org-delete-char
20318 'delete-backward-char 'org-delete-backward-char)
20319 (org-defkey org-mode-map "|" 'org-force-self-insert))
20321 (defvar org-ctrl-c-ctrl-c-hook nil
20322 "Hook for functions attaching themselves to `C-c C-c'.
20324 This can be used to add additional functionality to the C-c C-c
20325 key which executes context-dependent commands. This hook is run
20326 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20327 run after the last test.
20329 Each function will be called with no arguments. The function
20330 must check if the context is appropriate for it to act. If yes,
20331 it should do its thing and then return a non-nil value. If the
20332 context is wrong, just do nothing and return nil.")
20334 (defvar org-ctrl-c-ctrl-c-final-hook nil
20335 "Hook for functions attaching themselves to `C-c C-c'.
20337 This can be used to add additional functionality to the C-c C-c
20338 key which executes context-dependent commands. This hook is run
20339 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20340 before the first test.
20342 Each function will be called with no arguments. The function
20343 must check if the context is appropriate for it to act. If yes,
20344 it should do its thing and then return a non-nil value. If the
20345 context is wrong, just do nothing and return nil.")
20347 (defvar org-tab-first-hook nil
20348 "Hook for functions to attach themselves to TAB.
20349 See `org-ctrl-c-ctrl-c-hook' for more information.
20350 This hook runs as the first action when TAB is pressed, even before
20351 `org-cycle' messes around with the `outline-regexp' to cater for
20352 inline tasks and plain list item folding.
20353 If any function in this hook returns t, any other actions that
20354 would have been caused by TAB (such as table field motion or visibility
20355 cycling) will not occur.")
20357 (defvar org-tab-after-check-for-table-hook nil
20358 "Hook for functions to attach themselves to TAB.
20359 See `org-ctrl-c-ctrl-c-hook' for more information.
20360 This hook runs after it has been established that the cursor is not in a
20361 table, but before checking if the cursor is in a headline or if global cycling
20363 If any function in this hook returns t, not other actions like visibility
20364 cycling will be done.")
20366 (defvar org-tab-after-check-for-cycling-hook nil
20367 "Hook for functions to attach themselves to TAB.
20368 See `org-ctrl-c-ctrl-c-hook' for more information.
20369 This hook runs after it has been established that not table field motion and
20370 not visibility should be done because of current context. This is probably
20371 the place where a package like yasnippets can hook in.")
20373 (defvar org-tab-before-tab-emulation-hook nil
20374 "Hook for functions to attach themselves to TAB.
20375 See `org-ctrl-c-ctrl-c-hook' for more information.
20376 This hook runs after every other options for TAB have been exhausted, but
20377 before indentation and \t insertion takes place.")
20379 (defvar org-metaleft-hook nil
20380 "Hook for functions attaching themselves to `M-left'.
20381 See `org-ctrl-c-ctrl-c-hook' for more information.")
20382 (defvar org-metaright-hook nil
20383 "Hook for functions attaching themselves to `M-right'.
20384 See `org-ctrl-c-ctrl-c-hook' for more information.")
20385 (defvar org-metaup-hook nil
20386 "Hook for functions attaching themselves to `M-up'.
20387 See `org-ctrl-c-ctrl-c-hook' for more information.")
20388 (defvar org-metadown-hook nil
20389 "Hook for functions attaching themselves to `M-down'.
20390 See `org-ctrl-c-ctrl-c-hook' for more information.")
20391 (defvar org-shiftmetaleft-hook nil
20392 "Hook for functions attaching themselves to `M-S-left'.
20393 See `org-ctrl-c-ctrl-c-hook' for more information.")
20394 (defvar org-shiftmetaright-hook nil
20395 "Hook for functions attaching themselves to `M-S-right'.
20396 See `org-ctrl-c-ctrl-c-hook' for more information.")
20397 (defvar org-shiftmetaup-hook nil
20398 "Hook for functions attaching themselves to `M-S-up'.
20399 See `org-ctrl-c-ctrl-c-hook' for more information.")
20400 (defvar org-shiftmetadown-hook nil
20401 "Hook for functions attaching themselves to `M-S-down'.
20402 See `org-ctrl-c-ctrl-c-hook' for more information.")
20403 (defvar org-metareturn-hook nil
20404 "Hook for functions attaching themselves to `M-RET'.
20405 See `org-ctrl-c-ctrl-c-hook' for more information.")
20406 (defvar org-shiftup-hook nil
20407 "Hook for functions attaching themselves to `S-up'.
20408 See `org-ctrl-c-ctrl-c-hook' for more information.")
20409 (defvar org-shiftup-final-hook nil
20410 "Hook for functions attaching themselves to `S-up'.
20411 This one runs after all other options except shift-select have been excluded.
20412 See `org-ctrl-c-ctrl-c-hook' for more information.")
20413 (defvar org-shiftdown-hook nil
20414 "Hook for functions attaching themselves to `S-down'.
20415 See `org-ctrl-c-ctrl-c-hook' for more information.")
20416 (defvar org-shiftdown-final-hook nil
20417 "Hook for functions attaching themselves to `S-down'.
20418 This one runs after all other options except shift-select have been excluded.
20419 See `org-ctrl-c-ctrl-c-hook' for more information.")
20420 (defvar org-shiftleft-hook nil
20421 "Hook for functions attaching themselves to `S-left'.
20422 See `org-ctrl-c-ctrl-c-hook' for more information.")
20423 (defvar org-shiftleft-final-hook nil
20424 "Hook for functions attaching themselves to `S-left'.
20425 This one runs after all other options except shift-select have been excluded.
20426 See `org-ctrl-c-ctrl-c-hook' for more information.")
20427 (defvar org-shiftright-hook nil
20428 "Hook for functions attaching themselves to `S-right'.
20429 See `org-ctrl-c-ctrl-c-hook' for more information.")
20430 (defvar org-shiftright-final-hook nil
20431 "Hook for functions attaching themselves to `S-right'.
20432 This one runs after all other options except shift-select have been excluded.
20433 See `org-ctrl-c-ctrl-c-hook' for more information.")
20435 (defun org-modifier-cursor-error ()
20436 "Throw an error, a modified cursor command was applied in wrong context."
20437 (user-error "This command is active in special context like tables, headlines or items"))
20439 (defun org-shiftselect-error ()
20440 "Throw an error because Shift-Cursor command was applied in wrong context."
20441 (if (and (boundp 'shift-select-mode) shift-select-mode)
20442 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20443 (user-error "This command works only in special context like headlines or timestamps")))
20445 (defun org-call-for-shift-select (cmd)
20446 (let ((this-command-keys-shift-translated t))
20447 (call-interactively cmd)))
20449 (defun org-shifttab (&optional arg)
20450 "Global visibility cycling or move to previous table field.
20451 Call `org-table-previous-field' within a table.
20452 When ARG is nil, cycle globally through visibility states.
20453 When ARG is a numeric prefix, show contents of this level."
20456 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20458 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20459 (message "Content view to level: %d" arg)
20460 (org-content (prefix-numeric-value arg2))
20461 (org-cycle-show-empty-lines t)
20462 (setq org-cycle-global-status 'overview)))
20463 (t (call-interactively 'org-global-cycle))))
20465 (defun org-shiftmetaleft ()
20466 "Promote subtree or delete table column.
20467 Calls `org-promote-subtree', `org-outdent-item-tree', or
20468 `org-table-delete-column', depending on context. See the
20469 individual commands for more information."
20472 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20473 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20474 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20475 ((if (not (org-region-active-p)) (org-at-item-p)
20476 (save-excursion (goto-char (region-beginning))
20478 (call-interactively 'org-outdent-item-tree))
20479 (t (org-modifier-cursor-error))))
20481 (defun org-shiftmetaright ()
20482 "Demote subtree or insert table column.
20483 Calls `org-demote-subtree', `org-indent-item-tree', or
20484 `org-table-insert-column', depending on context. See the
20485 individual commands for more information."
20488 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20489 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20490 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20491 ((if (not (org-region-active-p)) (org-at-item-p)
20492 (save-excursion (goto-char (region-beginning))
20494 (call-interactively 'org-indent-item-tree))
20495 (t (org-modifier-cursor-error))))
20497 (defun org-shiftmetaup (&optional arg)
20498 "Drag the line at point up.
20499 In a table, kill the current row.
20500 On a clock timestamp, update the value of the timestamp like `S-<up>'
20501 but also adjust the previous clocked item in the clock history.
20502 Everywhere else, drag the line at point up."
20505 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20506 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20507 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20508 (call-interactively 'org-timestamp-up)))
20509 (t (call-interactively 'org-drag-line-backward))))
20511 (defun org-shiftmetadown (&optional arg)
20512 "Drag the line at point down.
20513 In a table, insert an empty row at the current line.
20514 On a clock timestamp, update the value of the timestamp like `S-<down>'
20515 but also adjust the previous clocked item in the clock history.
20516 Everywhere else, drag the line at point down."
20519 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20520 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20521 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20522 (call-interactively 'org-timestamp-down)))
20523 (t (call-interactively 'org-drag-line-forward))))
20525 (defsubst org-hidden-tree-error ()
20527 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20529 (defun org-metaleft (&optional arg)
20530 "Promote heading, list item at point or move table column left.
20532 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20533 depending on context. With no specific context, calls the Emacs
20534 default `backward-word'. See the individual commands for more
20537 This function runs the hook `org-metaleft-hook' as a first step,
20538 and returns at first non-nil value."
20541 ((run-hook-with-args-until-success 'org-metaleft-hook))
20542 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20543 ((org-with-limited-levels
20544 (or (org-at-heading-p)
20545 (and (org-region-active-p)
20547 (goto-char (region-beginning))
20548 (org-at-heading-p)))))
20549 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20550 (call-interactively 'org-do-promote))
20551 ;; At an inline task.
20552 ((org-at-heading-p)
20553 (call-interactively 'org-inlinetask-promote))
20554 ((or (org-at-item-p)
20555 (and (org-region-active-p)
20557 (goto-char (region-beginning))
20559 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20560 (call-interactively 'org-outdent-item))
20561 (t (call-interactively 'backward-word))))
20563 (defun org-metaright (&optional arg)
20564 "Demote heading, list item at point or move table column right.
20566 In front of a drawer or a block keyword, indent it correctly.
20568 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20569 `org-indnet-drawer' or `org-indent-block' depending on context.
20570 With no specific context, calls the Emacs default `forward-word'.
20571 See the individual commands for more information.
20573 This function runs the hook `org-metaright-hook' as a first step,
20574 and returns at first non-nil value."
20577 ((run-hook-with-args-until-success 'org-metaright-hook))
20578 ((org-at-table-p) (call-interactively 'org-table-move-column))
20579 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20580 ((org-at-block-p) (call-interactively 'org-indent-block))
20581 ((org-with-limited-levels
20582 (or (org-at-heading-p)
20583 (and (org-region-active-p)
20585 (goto-char (region-beginning))
20586 (org-at-heading-p)))))
20587 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20588 (call-interactively 'org-do-demote))
20589 ;; At an inline task.
20590 ((org-at-heading-p)
20591 (call-interactively 'org-inlinetask-demote))
20592 ((or (org-at-item-p)
20593 (and (org-region-active-p)
20595 (goto-char (region-beginning))
20597 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20598 (call-interactively 'org-indent-item))
20599 (t (call-interactively 'forward-word))))
20601 (defun org-check-for-hidden (what)
20602 "Check if there are hidden headlines/items in the current visual line.
20603 WHAT can be either `headlines' or `items'. If the current line is
20604 an outline or item heading and it has a folded subtree below it,
20605 this function returns t, nil otherwise."
20607 ((eq what 'headlines) org-outline-regexp-bol)
20608 ((eq what 'items) (org-item-beginning-re))
20609 (t (error "This should not happen"))))
20613 (unless (org-region-active-p)
20614 (setq beg (point-at-bol))
20615 (beginning-of-line 2)
20616 (while (and (not (eobp)) ;; this is like `next-line'
20617 (get-char-property (1- (point)) 'invisible))
20618 (beginning-of-line 2))
20621 (goto-char (point-at-eol))
20622 (setq end (max end (point)))
20623 (while (re-search-forward re end t)
20624 (if (get-char-property (match-beginning 0) 'invisible)
20628 (defun org-metaup (&optional arg)
20629 "Move subtree up or move table row up.
20630 Calls `org-move-subtree-up' or `org-table-move-row' or
20631 `org-move-item-up', depending on context. See the individual commands
20632 for more information."
20635 ((run-hook-with-args-until-success 'org-metaup-hook))
20636 ((org-region-active-p)
20637 (let* ((a (min (region-beginning) (region-end)))
20638 (b (1- (max (region-beginning) (region-end))))
20639 (c (save-excursion (goto-char a)
20640 (move-beginning-of-line 0)))
20641 (d (save-excursion (goto-char a)
20642 (move-end-of-line 0) (point))))
20643 (transpose-regions a b c d)
20645 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20646 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20647 ((org-at-item-p) (call-interactively 'org-move-item-up))
20648 (t (org-drag-element-backward))))
20650 (defun org-metadown (&optional arg)
20651 "Move subtree down or move table row down.
20652 Calls `org-move-subtree-down' or `org-table-move-row' or
20653 `org-move-item-down', depending on context. See the individual
20654 commands for more information."
20657 ((run-hook-with-args-until-success 'org-metadown-hook))
20658 ((org-region-active-p)
20659 (let* ((a (min (region-beginning) (region-end)))
20660 (b (max (region-beginning) (region-end)))
20661 (c (save-excursion (goto-char b)
20662 (move-beginning-of-line 1)))
20663 (d (save-excursion (goto-char b)
20664 (move-end-of-line 1) (1+ (point)))))
20665 (transpose-regions a b c d)
20667 ((org-at-table-p) (call-interactively 'org-table-move-row))
20668 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20669 ((org-at-item-p) (call-interactively 'org-move-item-down))
20670 (t (org-drag-element-forward))))
20672 (defun org-shiftup (&optional arg)
20673 "Increase item in timestamp or increase priority of current headline.
20674 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20675 depending on context. See the individual commands for more information."
20678 ((run-hook-with-args-until-success 'org-shiftup-hook))
20679 ((and org-support-shift-select (org-region-active-p))
20680 (org-call-for-shift-select 'previous-line))
20681 ((org-at-timestamp-p t)
20682 (call-interactively (if org-edit-timestamp-down-means-later
20683 'org-timestamp-down 'org-timestamp-up)))
20684 ((and (not (eq org-support-shift-select 'always))
20685 org-enable-priority-commands
20686 (org-at-heading-p))
20687 (call-interactively 'org-priority-up))
20688 ((and (not org-support-shift-select) (org-at-item-p))
20689 (call-interactively 'org-previous-item))
20690 ((org-clocktable-try-shift 'up arg))
20691 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20692 (org-support-shift-select
20693 (org-call-for-shift-select 'previous-line))
20694 (t (org-shiftselect-error))))
20696 (defun org-shiftdown (&optional arg)
20697 "Decrease item in timestamp or decrease priority of current headline.
20698 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20699 depending on context. See the individual commands for more information."
20702 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20703 ((and org-support-shift-select (org-region-active-p))
20704 (org-call-for-shift-select 'next-line))
20705 ((org-at-timestamp-p t)
20706 (call-interactively (if org-edit-timestamp-down-means-later
20707 'org-timestamp-up 'org-timestamp-down)))
20708 ((and (not (eq org-support-shift-select 'always))
20709 org-enable-priority-commands
20710 (org-at-heading-p))
20711 (call-interactively 'org-priority-down))
20712 ((and (not org-support-shift-select) (org-at-item-p))
20713 (call-interactively 'org-next-item))
20714 ((org-clocktable-try-shift 'down arg))
20715 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20716 (org-support-shift-select
20717 (org-call-for-shift-select 'next-line))
20718 (t (org-shiftselect-error))))
20720 (defun org-shiftright (&optional arg)
20721 "Cycle the thing at point or in the current line, depending on context.
20722 Depending on context, this does one of the following:
20724 - switch a timestamp at point one day into the future
20725 - on a headline, switch to the next TODO keyword.
20726 - on an item, switch entire list to the next bullet type
20727 - on a property line, switch to the next allowed value
20728 - on a clocktable definition line, move time block into the future"
20731 ((run-hook-with-args-until-success 'org-shiftright-hook))
20732 ((and org-support-shift-select (org-region-active-p))
20733 (org-call-for-shift-select 'forward-char))
20734 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20735 ((and (not (eq org-support-shift-select 'always))
20736 (org-at-heading-p))
20737 (let ((org-inhibit-logging
20738 (not org-treat-S-cursor-todo-selection-as-state-change))
20739 (org-inhibit-blocking
20740 (not org-treat-S-cursor-todo-selection-as-state-change)))
20741 (org-call-with-arg 'org-todo 'right)))
20742 ((or (and org-support-shift-select
20743 (not (eq org-support-shift-select 'always))
20744 (org-at-item-bullet-p))
20745 (and (not org-support-shift-select) (org-at-item-p)))
20746 (org-call-with-arg 'org-cycle-list-bullet nil))
20747 ((and (not (eq org-support-shift-select 'always))
20748 (org-at-property-p))
20749 (call-interactively 'org-property-next-allowed-value))
20750 ((org-clocktable-try-shift 'right arg))
20751 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20752 (org-support-shift-select
20753 (org-call-for-shift-select 'forward-char))
20754 (t (org-shiftselect-error))))
20756 (defun org-shiftleft (&optional arg)
20757 "Cycle the thing at point or in the current line, depending on context.
20758 Depending on context, this does one of the following:
20760 - switch a timestamp at point one day into the past
20761 - on a headline, switch to the previous TODO keyword.
20762 - on an item, switch entire list to the previous bullet type
20763 - on a property line, switch to the previous allowed value
20764 - on a clocktable definition line, move time block into the past"
20767 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20768 ((and org-support-shift-select (org-region-active-p))
20769 (org-call-for-shift-select 'backward-char))
20770 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20771 ((and (not (eq org-support-shift-select 'always))
20772 (org-at-heading-p))
20773 (let ((org-inhibit-logging
20774 (not org-treat-S-cursor-todo-selection-as-state-change))
20775 (org-inhibit-blocking
20776 (not org-treat-S-cursor-todo-selection-as-state-change)))
20777 (org-call-with-arg 'org-todo 'left)))
20778 ((or (and org-support-shift-select
20779 (not (eq org-support-shift-select 'always))
20780 (org-at-item-bullet-p))
20781 (and (not org-support-shift-select) (org-at-item-p)))
20782 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20783 ((and (not (eq org-support-shift-select 'always))
20784 (org-at-property-p))
20785 (call-interactively 'org-property-previous-allowed-value))
20786 ((org-clocktable-try-shift 'left arg))
20787 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20788 (org-support-shift-select
20789 (org-call-for-shift-select 'backward-char))
20790 (t (org-shiftselect-error))))
20792 (defun org-shiftcontrolright ()
20793 "Switch to next TODO set."
20796 ((and org-support-shift-select (org-region-active-p))
20797 (org-call-for-shift-select 'forward-word))
20798 ((and (not (eq org-support-shift-select 'always))
20799 (org-at-heading-p))
20800 (org-call-with-arg 'org-todo 'nextset))
20801 (org-support-shift-select
20802 (org-call-for-shift-select 'forward-word))
20803 (t (org-shiftselect-error))))
20805 (defun org-shiftcontrolleft ()
20806 "Switch to previous TODO set."
20809 ((and org-support-shift-select (org-region-active-p))
20810 (org-call-for-shift-select 'backward-word))
20811 ((and (not (eq org-support-shift-select 'always))
20812 (org-at-heading-p))
20813 (org-call-with-arg 'org-todo 'previousset))
20814 (org-support-shift-select
20815 (org-call-for-shift-select 'backward-word))
20816 (t (org-shiftselect-error))))
20818 (defun org-shiftcontrolup (&optional n)
20819 "Change timestamps synchronously up in CLOCK log lines.
20820 Optional argument N tells to change by that many units."
20822 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20823 (let (org-support-shift-select)
20824 (org-clock-timestamps-up n))
20825 (user-error "Not at a clock log")))
20827 (defun org-shiftcontroldown (&optional n)
20828 "Change timestamps synchronously down in CLOCK log lines.
20829 Optional argument N tells to change by that many units."
20831 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20832 (let (org-support-shift-select)
20833 (org-clock-timestamps-down n))
20834 (user-error "Not at a clock log")))
20836 (defun org-increase-number-at-point (&optional inc)
20837 "Increment the number at point.
20838 With an optional prefix numeric argument INC, increment using
20839 this numeric value."
20841 (if (not (number-at-point))
20842 (user-error "Not on a number")
20843 (unless inc (setq inc 1))
20844 (let ((pos (point))
20845 (beg (skip-chars-backward "-+^/*0-9eE."))
20846 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20847 (setq nap (buffer-substring-no-properties
20848 (+ pos beg) (+ pos beg end)))
20849 (delete-region (+ pos beg) (+ pos beg end))
20850 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20851 (when (org-at-table-p)
20853 (org-table-end-of-field 1))))
20855 (defun org-decrease-number-at-point (&optional inc)
20856 "Decrement the number at point.
20857 With an optional prefix numeric argument INC, decrement using
20858 this numeric value."
20860 (org-increase-number-at-point (- (or inc 1))))
20862 (defun org-ctrl-c-ret ()
20863 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20866 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20867 (t (call-interactively 'org-insert-heading))))
20869 (defun org-find-visible ()
20871 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20872 (get-char-property s 'invisible)))
20874 (defun org-find-invisible ()
20876 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20877 (not (get-char-property s 'invisible))))
20880 (defun org-copy-visible (beg end)
20881 "Copy the visible parts of the region."
20886 (narrow-to-region beg end)
20887 (setq s (goto-char (point-min)))
20888 (while (not (= (point) (point-max)))
20889 (goto-char (org-find-invisible))
20890 (push (buffer-substring s (point)) snippets)
20891 (setq s (goto-char (org-find-visible))))))
20892 (kill-new (apply 'concat (nreverse snippets)))))
20894 (defun org-copy-special ()
20895 "Copy region in table or copy current subtree.
20896 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20897 See the individual commands for more information."
20899 (call-interactively
20900 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20902 (defun org-cut-special ()
20903 "Cut region in table or cut current subtree.
20904 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20905 See the individual commands for more information."
20907 (call-interactively
20908 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20910 (defun org-paste-special (arg)
20911 "Paste rectangular region into table, or past subtree relative to level.
20912 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20913 See the individual commands for more information."
20915 (if (org-at-table-p)
20916 (org-table-paste-rectangle)
20917 (org-paste-subtree arg)))
20919 (defsubst org-in-fixed-width-region-p ()
20920 "Is point in a fixed-width region?"
20922 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20924 (defun org-edit-special (&optional arg)
20925 "Call a special editor for the element at point.
20926 When at a table, call the formula editor with `org-table-edit-formulas'.
20927 When in a source code block, call `org-edit-src-code'.
20928 When in a fixed-width region, call `org-edit-fixed-width-region'.
20929 When in an export block, call `org-edit-export-block'.
20930 When at an #+INCLUDE keyword, visit the included file.
20931 When at a footnote reference, call `org-edit-footnote-reference'
20932 On a link, call `ffap' to visit the link at point.
20933 Otherwise, return a user error."
20935 (let ((element (org-element-at-point)))
20936 (assert (not buffer-read-only) nil
20937 "Buffer is read-only: %s" (buffer-name))
20938 (case (org-element-type element)
20940 (if (not arg) (org-edit-src-code)
20941 (let* ((info (org-babel-get-src-block-info))
20942 (lang (nth 0 info))
20943 (params (nth 2 info))
20944 (session (cdr (assq :session params))))
20945 (if (not session) (org-edit-src-code)
20946 ;; At a src-block with a session and function called with
20947 ;; an ARG: switch to the buffer related to the inferior
20950 (funcall (intern (concat "org-babel-prep-session:" lang))
20951 session params))))))
20953 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20954 (org-open-link-from-string
20957 (let ((value (org-element-property :value element)))
20958 (cond ((not (org-string-nw-p value))
20959 (user-error "No file to edit"))
20960 ((string-match "\\`\"\\(.*?\\)\"" value)
20961 (match-string 1 value))
20962 ((string-match "\\`[^ \t\"]\\S-*" value)
20963 (match-string 0 value))
20964 (t (user-error "No valid file specified")))))))
20965 (user-error "No special environment to edit here")))
20967 (if (eq (org-element-property :type element) 'table.el)
20968 (org-edit-table.el)
20969 (call-interactively 'org-table-edit-formulas)))
20970 ;; Only Org tables contain `table-row' type elements.
20971 (table-row (call-interactively 'org-table-edit-formulas))
20972 (example-block (org-edit-src-code))
20973 (export-block (org-edit-export-block))
20974 (fixed-width (org-edit-fixed-width-region))
20976 ;; No notable element at point. Though, we may be at a link or
20977 ;; a footnote reference, which are objects. Thus, scan deeper.
20978 (let ((context (org-element-context element)))
20979 (case (org-element-type context)
20980 (link (call-interactively #'ffap))
20981 (footnote-reference (org-edit-footnote-reference))
20982 (t (user-error "No special environment to edit here"))))))))
20984 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20985 (defun org-ctrl-c-ctrl-c (&optional arg)
20986 "Set tags in headline, or update according to changed information at point.
20988 This command does many different things, depending on context:
20990 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20991 this is what we do.
20993 - If the cursor is on a statistics cookie, update it.
20995 - If the cursor is in a headline, prompt for tags and insert them
20996 into the current line, aligned to `org-tags-column'. When called
20997 with prefix arg, realign all tags in the current buffer.
20999 - If the cursor is in one of the special #+KEYWORD lines, this
21000 triggers scanning the buffer for these lines and updating the
21003 - If the cursor is inside a table, realign the table. This command
21004 works even if the automatic table editor has been turned off.
21006 - If the cursor is on a #+TBLFM line, re-apply the formulas to
21009 - If the cursor is at a footnote reference or definition, jump to
21010 the corresponding definition or references, respectively.
21012 - If the cursor is a the beginning of a dynamic block, update it.
21014 - If the current buffer is a capture buffer, close note and file it.
21016 - If the cursor is on a <<<target>>>, update radio targets and
21017 corresponding links in this buffer.
21019 - If the cursor is on a numbered item in a plain list, renumber the
21022 - If the cursor is on a checkbox, toggle it.
21024 - If the cursor is on a code block, evaluate it. The variable
21025 `org-confirm-babel-evaluate' can be used to control prompting
21026 before code block evaluation, by default every code block
21027 evaluation requires confirmation. Code block evaluation can be
21028 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21031 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
21032 org-occur-highlights)
21033 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21034 (org-remove-occur-highlights)
21035 (message "Temporary highlights/overlays removed from current buffer"))
21036 ((and (local-variable-p 'org-finish-function (current-buffer))
21037 (fboundp org-finish-function))
21038 (funcall org-finish-function))
21039 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21041 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
21042 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21043 (user-error "C-c C-c can do nothing useful at this location"))
21044 (let* ((context (org-element-context))
21045 (type (org-element-type context)))
21047 ;; When at a link, act according to the parent instead.
21048 (link (setq context (org-element-property :parent context))
21049 (setq type (org-element-type context)))
21050 ;; Unsupported object types: refer to the first supported
21051 ;; element or object containing it.
21052 ((bold code entity export-snippet inline-babel-call inline-src-block
21053 italic latex-fragment line-break macro strike-through subscript
21054 superscript underline verbatim)
21056 (org-element-lineage
21057 context '(radio-target paragraph verse-block table-cell)))))
21058 ;; For convenience: at the first line of a paragraph on the
21059 ;; same line as an item, apply function on that item instead.
21060 (when (eq type 'paragraph)
21061 (let ((parent (org-element-property :parent context)))
21062 (when (and (eq (org-element-type parent) 'item)
21063 (= (line-beginning-position)
21064 (org-element-property :begin parent)))
21065 (setq context parent type 'item))))
21066 ;; Act according to type of element or object at point.
21068 (clock (org-clock-update-time-maybe))
21071 (goto-char (org-element-property :post-affiliated context))
21072 (org-update-dblock)))
21073 (footnote-definition
21074 (goto-char (org-element-property :post-affiliated context))
21075 (call-interactively 'org-footnote-action))
21076 (footnote-reference (call-interactively 'org-footnote-action))
21077 ((headline inlinetask)
21078 (save-excursion (goto-char (org-element-property :begin context))
21079 (call-interactively 'org-set-tags)))
21081 ;; At an item: a double C-u set checkbox to "[-]"
21082 ;; unconditionally, whereas a single one will toggle its
21083 ;; presence. Without a universal argument, if the item
21084 ;; has a checkbox, toggle it. Otherwise repair the list.
21085 (let* ((box (org-element-property :checkbox context))
21086 (struct (org-element-property :structure context))
21087 (old-struct (copy-tree struct))
21088 (parents (org-list-parents-alist struct))
21089 (prevs (org-list-prevs-alist struct))
21090 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21091 (org-list-set-checkbox
21092 (org-element-property :begin context) struct
21093 (cond ((equal arg '(16)) "[-]")
21094 ((and (not box) (equal arg '(4))) "[ ]")
21095 ((or (not box) (equal arg '(4))) nil)
21096 ((eq box 'on) "[ ]")
21098 ;; Mimic `org-list-write-struct' but with grabbing
21099 ;; a return value from `org-list-struct-fix-box'.
21100 (org-list-struct-fix-ind struct parents 2)
21101 (org-list-struct-fix-item-end struct)
21102 (org-list-struct-fix-bul struct prevs)
21103 (org-list-struct-fix-ind struct parents)
21105 (org-list-struct-fix-box struct parents prevs orderedp)))
21106 (if (and box (equal struct old-struct))
21107 (if (equal arg '(16))
21108 (message "Checkboxes already reset")
21109 (user-error "Cannot toggle this checkbox: %s"
21111 "all subitems checked"
21112 "unchecked subitems")))
21113 (org-list-struct-apply-struct struct old-struct)
21114 (org-update-checkbox-count-maybe))
21116 (message "Checkboxes were removed due to empty box at line %d"
21117 (org-current-line block-item))))))
21119 (let ((org-inhibit-startup-visibility-stuff t)
21120 (org-startup-align-all-tables nil))
21121 (when (boundp 'org-table-coordinate-overlays)
21122 (mapc 'delete-overlay org-table-coordinate-overlays)
21123 (setq org-table-coordinate-overlays nil))
21124 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21125 (message "Local setup has been refreshed"))
21127 ;; At a plain list, with a double C-u argument, set
21128 ;; checkboxes of each item to "[-]", whereas a single one
21129 ;; will toggle their presence according to the state of the
21130 ;; first item in the list. Without an argument, repair the
21132 (let* ((begin (org-element-property :contents-begin context))
21133 (beginm (move-marker (make-marker) begin))
21134 (struct (org-element-property :structure context))
21135 (old-struct (copy-tree struct))
21136 (first-box (save-excursion
21138 (looking-at org-list-full-item-re)
21139 (match-string-no-properties 3)))
21140 (new-box (cond ((equal arg '(16)) "[-]")
21141 ((equal arg '(4)) (unless first-box "[ ]"))
21142 ((equal first-box "[X]") "[ ]")
21146 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21147 (org-list-get-all-items
21148 begin struct (org-list-prevs-alist struct))))
21149 ((and first-box (eq (point) begin))
21150 ;; For convenience, when point is at bol on the first
21151 ;; item of the list and no argument is provided, simply
21152 ;; toggle checkbox of that item, if any.
21153 (org-list-set-checkbox begin struct new-box)))
21154 (org-list-write-struct
21155 struct (org-list-parents-alist struct) old-struct)
21156 (org-update-checkbox-count-maybe)
21157 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21158 ((property-drawer node-property)
21159 (call-interactively 'org-property-action))
21160 ((radio-target target)
21161 (call-interactively 'org-update-radio-target-regexp))
21163 (call-interactively 'org-update-statistics-cookies))
21164 ((table table-cell table-row)
21165 ;; At a table, recalculate every field and align it. Also
21166 ;; send the table if necessary. If the table has
21167 ;; a `table.el' type, just give up. At a table row or
21168 ;; cell, maybe recalculate line but always align table.
21169 (if (eq (org-element-property :type context) 'table.el)
21170 (message "Use C-c ' to edit table.el tables")
21171 (let ((org-enable-table-editor t))
21172 (if (or (eq type 'table)
21173 ;; Check if point is at a TBLFM line.
21174 (and (eq type 'table-row)
21175 (= (point) (org-element-property :end context))))
21177 (if (org-at-TBLFM-p)
21178 (progn (require 'org-table)
21179 (org-table-calc-current-TBLFM))
21180 (goto-char (org-element-property :contents-begin context))
21181 (org-call-with-arg 'org-table-recalculate (or arg t))
21182 (orgtbl-send-table 'maybe)))
21183 (org-table-maybe-eval-formula)
21184 (cond (arg (call-interactively 'org-table-recalculate))
21185 ((org-table-maybe-recalculate-line))
21186 (t (org-table-align)))))))
21187 (timestamp (org-timestamp-change 0 'day))
21189 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21191 "C-c C-c can do nothing useful at this location")))))))))
21193 (defun org-mode-restart ()
21195 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21196 (funcall major-mode)
21197 (hack-local-variables)
21198 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21199 (org-indent-mode -1)))
21200 (message "%s restarted" major-mode))
21202 (defun org-kill-note-or-show-branches ()
21203 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21205 (if (not org-finish-function)
21208 (call-interactively 'show-branches))
21209 (let ((org-note-abort t))
21210 (funcall org-finish-function))))
21212 (defun org-delete-indentation (&optional ARG)
21213 "Join current line to previous and fix whitespace at join.
21215 If previous line is a headline add to headline title. Otherwise
21216 the function calls `delete-indentation'.
21218 With argument, join this line to following line."
21220 (if (save-excursion
21221 (if ARG (beginning-of-line)
21223 (looking-at org-complex-heading-regexp))
21225 (let ((tags-column (when (match-beginning 5)
21226 (save-excursion (goto-char (match-beginning 5))
21227 (current-column))))
21228 (string (concat " " (progn (when ARG (forward-line 1))
21229 (org-trim (delete-and-extract-region
21230 (line-beginning-position)
21231 (line-end-position)))))))
21232 (unless (bobp) (delete-region (point) (1- (point))))
21233 (goto-char (or (match-end 4)
21234 (match-beginning 5)
21236 (skip-chars-backward " \t")
21237 (save-excursion (insert string))
21238 ;; Adjust alignment of tags.
21240 (org-align-tags-here (if org-auto-align-tags
21243 (delete-indentation ARG)))
21245 (defun org-open-line (n)
21246 "Insert a new row in tables, call `open-line' elsewhere.
21247 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21250 ((not org-special-ctrl-o)
21253 (org-table-insert-row))
21257 (defun org-return (&optional indent)
21258 "Goto next table row or insert a newline.
21260 Calls `org-table-next-row' or `newline', depending on context.
21262 When optional INDENT argument is non-nil, call
21263 `newline-and-indent' instead of `newline'.
21265 When `org-return-follows-link' is non-nil and point is on
21266 a timestamp or a link, call `org-open-at-point'. However, it
21267 will not happen if point is in a table or on a \"dead\"
21268 object (e.g., within a comment). In these case, you need to use
21269 `org-open-at-point' directly."
21271 (if (and (not (bolp))
21272 (save-excursion (beginning-of-line)
21273 (looking-at org-complex-heading-regexp)))
21275 (let ((tags-column (when (match-beginning 5)
21276 (save-excursion (goto-char (match-beginning 5))
21277 (current-column))))
21278 ;; Test if before or after headline title.
21279 (string (when (and (match-end 4)
21280 (not (or (< (point)
21284 (goto-char (match-beginning 4))
21285 (skip-chars-backward " \t")
21287 (and (match-beginning 5)
21288 (>= (point) (match-beginning 5))))))
21289 ;; Point is on headline keywords, tags or cookies. Do not break
21290 ;; them: add a newline after the headline instead.
21292 (delete-and-extract-region (point) (match-end 4))))))
21293 ;; Adjust alignment of tags.
21294 (when (and tags-column string)
21295 (org-align-tags-here (if org-auto-align-tags
21300 (if indent (newline-and-indent) (newline))
21301 (and string (save-excursion (insert (org-trim string)))))
21302 (let* ((context (if org-return-follows-link (org-element-context)
21303 (org-element-at-point)))
21304 (type (org-element-type context)))
21306 ;; In a table, call `org-table-next-row'.
21307 ((or (and (eq type 'table)
21308 (>= (point) (org-element-property :contents-begin context))
21309 (< (point) (org-element-property :contents-end context)))
21310 (org-element-lineage context '(table-row table-cell) t))
21311 (org-table-justify-field-maybe)
21312 (call-interactively #'org-table-next-row))
21313 ;; On a link or a timestamp but not on white spaces after it,
21314 ;; call `org-open-line' if `org-return-follows-link' allows it.
21315 ((and org-return-follows-link
21316 (memq type '(link timestamp))
21318 (save-excursion (goto-char (org-element-property :end context))
21319 (skip-chars-backward " \t")
21321 (call-interactively #'org-open-at-point))
21322 ;; In a list, make sure indenting keeps trailing text within.
21325 (org-element-lineage context '(item)))
21326 (let ((trailing-data
21327 (delete-and-extract-region (point) (line-end-position))))
21328 (newline-and-indent)
21329 (save-excursion (insert trailing-data))))
21330 (t (if indent (newline-and-indent) (newline)))))))
21332 (defun org-return-indent ()
21333 "Goto next table row or insert a newline and indent.
21334 Calls `org-table-next-row' or `newline-and-indent', depending on
21335 context. See the individual commands for more information."
21339 (defun org-ctrl-c-star ()
21340 "Compute table, or change heading status of lines.
21341 Calls `org-table-recalculate' or `org-toggle-heading',
21342 depending on context."
21346 (call-interactively 'org-table-recalculate))
21348 ;; Convert all lines in region to list items
21349 (call-interactively 'org-toggle-heading))))
21351 (defun org-ctrl-c-minus ()
21352 "Insert separator line in table or modify bullet status of line.
21353 Also turns a plain line or a region of lines into list items.
21354 Calls `org-table-insert-hline', `org-toggle-item', or
21355 `org-cycle-list-bullet', depending on context."
21359 (call-interactively 'org-table-insert-hline))
21360 ((org-region-active-p)
21361 (call-interactively 'org-toggle-item))
21363 (call-interactively 'org-cycle-list-bullet))
21365 (call-interactively 'org-toggle-item))))
21367 (defun org-toggle-item (arg)
21368 "Convert headings or normal lines to items, items to normal lines.
21369 If there is no active region, only the current line is considered.
21371 If the first non blank line in the region is a headline, convert
21372 all headlines to items, shifting text accordingly.
21374 If it is an item, convert all items to normal lines.
21376 If it is normal text, change region into a list of items.
21377 With a prefix argument ARG, change the region in a single item."
21381 ;; Shift text in current section to IND, from point to END.
21382 ;; The function leaves point to END line.
21384 (let ((min-i 1000) (end (copy-marker end)))
21385 ;; First determine the minimum indentation (MIN-I) of
21389 (while (< (point) end)
21390 (let ((i (org-get-indentation)))
21392 ;; Skip blank lines and inline tasks.
21393 ((looking-at "^[ \t]*$"))
21394 ((looking-at org-outline-regexp-bol))
21395 ;; We can't find less than 0 indentation.
21396 ((zerop i) (throw 'exit (setq min-i 0)))
21397 ((< i min-i) (setq min-i i))))
21399 ;; Then indent each line so that a line indented to
21400 ;; MIN-I becomes indented to IND. Ignore blank lines
21401 ;; and inline tasks in the process.
21402 (let ((delta (- ind min-i)))
21403 (while (< (point) end)
21404 (unless (or (looking-at "^[ \t]*$")
21405 (looking-at org-outline-regexp-bol))
21406 (org-indent-line-to (+ (org-get-indentation) delta)))
21407 (forward-line)))))))
21410 ;; Return beginning of first non-blank line, starting from
21415 (skip-chars-forward " \r\t\n")
21418 ;; Determine boundaries of changes.
21419 (if (org-region-active-p)
21420 (setq beg (funcall skip-blanks (region-beginning))
21421 end (copy-marker (region-end)))
21422 (setq beg (funcall skip-blanks (point-at-bol))
21423 end (copy-marker (point-at-eol))))
21424 ;; Depending on the starting line, choose an action on the text
21425 ;; between BEG and END.
21426 (org-with-limited-levels
21430 ;; Case 1. Start at an item: de-itemize. Note that it only
21431 ;; happens when a region is active: `org-ctrl-c-minus'
21432 ;; would call `org-cycle-list-bullet' otherwise.
21434 (while (< (point) end)
21435 (when (org-at-item-p)
21436 (skip-chars-forward " \t")
21437 (delete-region (point) (match-end 0)))
21439 ;; Case 2. Start at an heading: convert to items.
21440 ((org-at-heading-p)
21441 (let* ((bul (org-list-bullet-string "-"))
21442 (bul-len (length bul))
21443 (done (org-entry-is-done-p))
21444 (todo (org-entry-is-todo-p))
21445 ;; Indentation of the first heading. It should be
21446 ;; relative to the indentation of its parent, if any.
21447 (start-ind (save-excursion
21449 ((not org-adapt-indentation) 0)
21450 ((not (outline-previous-heading)) 0)
21451 (t (length (match-string 0))))))
21452 ;; Level of first heading. Further headings will be
21453 ;; compared to it to determine hierarchy in the list.
21454 (ref-level (org-reduced-level (org-outline-level))))
21455 (when (or done todo) (org-todo ""))
21456 (while (< (point) end)
21457 (let* ((level (org-reduced-level (org-outline-level)))
21458 (delta (max 0 (- level ref-level))))
21459 ;; If current headline is less indented than the first
21460 ;; one, set it as reference, in order to preserve
21462 (when (< level ref-level) (setq ref-level level))
21463 (replace-match bul t t)
21464 (org-indent-line-to (+ start-ind (* delta bul-len)))
21465 (when (or done todo)
21466 (let* ((struct (org-list-struct))
21467 (old (copy-tree struct)))
21468 (org-list-set-checkbox (line-beginning-position)
21470 (if done "[X]" "[ ]"))
21471 (org-list-write-struct struct
21472 (org-list-parents-alist struct)
21474 ;; Ensure all text down to END (or SECTION-END) belongs
21475 ;; to the newly created item.
21476 (let ((section-end (save-excursion
21477 (or (outline-next-heading) (point)))))
21479 (funcall shift-text
21480 (+ start-ind (* (1+ delta) bul-len))
21481 (min end section-end)))))))
21482 ;; Case 3. Normal line with ARG: make the first line of region
21483 ;; an item, and shift indentation of others lines to
21484 ;; set them as item's body.
21485 (arg (let* ((bul (org-list-bullet-string "-"))
21486 (bul-len (length bul))
21487 (ref-ind (org-get-indentation)))
21488 (skip-chars-forward " \t")
21491 (while (< (point) end)
21492 ;; Ensure that lines less indented than first one
21493 ;; still get included in item body.
21494 (funcall shift-text
21495 (+ ref-ind bul-len)
21496 (min end (save-excursion (or (outline-next-heading)
21499 ;; Case 4. Normal line without ARG: turn each non-item line
21502 (while (< (point) end)
21503 (unless (or (org-at-heading-p) (org-at-item-p))
21504 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21506 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21507 (forward-line))))))))
21509 (defun org-toggle-heading (&optional nstars)
21510 "Convert headings to normal text, or items or text to headings.
21511 If there is no active region, only convert the current line.
21513 With a \\[universal-argument] prefix, convert the whole list at
21514 point into heading.
21518 - If the first non blank line is a headline, remove the stars
21519 from all headlines in the region.
21521 - If it is a normal line, turn each and every normal line (i.e.,
21522 not an heading or an item) in the region into headings. If you
21523 want to convert only the first line of this region, use one
21524 universal prefix argument.
21526 - If it is a plain list item, turn all plain list items into headings.
21528 When converting a line into a heading, the number of stars is chosen
21529 such that the lines become children of the current entry. However,
21530 when a numeric prefix argument is given, its value determines the
21531 number of stars to add."
21535 ;; Return beginning of first non-blank line, starting from
21540 (while (org-at-comment-p) (forward-line))
21541 (skip-chars-forward " \r\t\n")
21544 ;; Determine boundaries of changes. If a universal prefix has
21545 ;; been given, put the list in a region. If region ends at a bol,
21546 ;; do not consider the last line to be in the region.
21548 (when (and current-prefix-arg (org-at-item-p))
21549 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21550 (org-mark-element))
21552 (if (org-region-active-p)
21553 (setq beg (funcall skip-blanks (region-beginning))
21554 end (copy-marker (save-excursion
21555 (goto-char (region-end))
21556 (if (bolp) (point) (point-at-eol)))))
21557 (setq beg (funcall skip-blanks (point-at-bol))
21558 end (copy-marker (point-at-eol))))
21559 ;; Ensure inline tasks don't count as headings.
21560 (org-with-limited-levels
21564 ;; Case 1. Started at an heading: de-star headings.
21565 ((org-at-heading-p)
21566 (while (< (point) end)
21567 (when (org-at-heading-p t)
21568 (looking-at org-outline-regexp) (replace-match "")
21571 ;; Case 2. Started at an item: change items into headlines.
21572 ;; One star will be added by `org-list-to-subtree'.
21574 (while (< (point) end)
21575 (when (org-at-item-p)
21576 ;; Pay attention to cases when region ends before list.
21577 (let* ((struct (org-list-struct))
21578 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21580 (narrow-to-region (point) list-end)
21581 (insert (org-list-to-subtree (org-list-parse-list t)))))
21584 ;; Case 3. Started at normal text: make every line an heading,
21585 ;; skipping headlines and items.
21588 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21590 (cond (nstars "") ; stars from prefix only
21591 ((equal stars "") "*") ; before first heading
21592 (org-odd-levels-only "**") ; inside heading, odd
21593 (t "*"))) ; inside heading, oddeven
21594 (rpl (concat stars add-stars " "))
21595 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21596 (while (< (point) (if (equal nstars '(4)) lend end))
21597 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21598 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21599 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21600 (forward-line)))))))
21601 (unless toggled (message "Cannot toggle heading from here"))))
21603 (defun org-meta-return (&optional arg)
21604 "Insert a new heading or wrap a region in a table.
21605 Calls `org-insert-heading' or `org-table-wrap-region', depending
21606 on context. See the individual commands for more information."
21608 (org-check-before-invisible-edit 'insert)
21609 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21610 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21611 #'org-insert-heading))))
21615 (defsubst org-in-subtree-not-table-p ()
21616 "Are we in a subtree and not in a table?"
21617 (and (not (org-before-first-heading-p))
21618 (not (org-at-table-p))))
21620 ;; Define the Org-mode menus
21621 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21623 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21624 ["Next Field" org-cycle (org-at-table-p)]
21625 ["Previous Field" org-shifttab (org-at-table-p)]
21626 ["Next Row" org-return (org-at-table-p)]
21628 ["Blank Field" org-table-blank-field (org-at-table-p)]
21629 ["Edit Field" org-table-edit-field (org-at-table-p)]
21630 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21633 ["Move Column Left" org-metaleft (org-at-table-p)]
21634 ["Move Column Right" org-metaright (org-at-table-p)]
21635 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21636 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21638 ["Move Row Up" org-metaup (org-at-table-p)]
21639 ["Move Row Down" org-metadown (org-at-table-p)]
21640 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21641 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21642 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21644 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21646 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21647 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21648 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21649 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21652 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21653 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21654 ["Edit Formulas" org-edit-special (org-at-table-p)]
21656 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21657 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21658 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21660 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21662 ["Sum Column/Rectangle" org-table-sum
21663 (or (org-at-table-p) (org-region-active-p))]
21664 ["Which Column?" org-table-current-column (org-at-table-p)])
21666 org-table-toggle-formula-debugger
21667 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21668 ["Show Col/Row Numbers"
21669 org-table-toggle-coordinate-overlays
21671 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21673 ["Create" org-table-create (and (not (org-at-table-p))
21674 org-enable-table-editor)]
21675 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21676 ["Import from File" org-table-import (not (org-at-table-p))]
21677 ["Export to File" org-table-export (org-at-table-p)]
21679 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21682 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21683 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21685 (easy-menu-define org-org-menu org-mode-map "Org menu"
21688 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21689 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21690 ["Sparse Tree..." org-sparse-tree t]
21691 ["Reveal Context" org-reveal t]
21692 ["Show All" show-all t]
21694 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21696 ["New Heading" org-insert-heading t]
21697 ("Navigate Headings"
21698 ["Up" outline-up-heading t]
21699 ["Next" outline-next-visible-heading t]
21700 ["Previous" outline-previous-visible-heading t]
21701 ["Next Same Level" outline-forward-same-level t]
21702 ["Previous Same Level" outline-backward-same-level t]
21704 ["Jump" org-goto t])
21706 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21708 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21709 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21711 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21712 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21713 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21715 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21717 ["Copy visible text" org-copy-visible t]
21719 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21720 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21721 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21722 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21724 ["Sort Region/Children" org-sort t]
21726 ["Convert to odd levels" org-convert-to-odd-levels t]
21727 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21729 ["Emphasis..." org-emphasize t]
21730 ["Edit Source Example" org-edit-special t]
21732 ["Footnote new/jump" org-footnote-action t]
21733 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21735 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21737 ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
21738 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21739 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21743 ["Store Link (Global)" org-store-link t]
21744 ["Find existing link to here" org-occur-link-in-agenda-files t]
21745 ["Insert Link" org-insert-link t]
21746 ["Follow Link" org-open-at-point t]
21748 ["Next link" org-next-link t]
21749 ["Previous link" org-previous-link t]
21751 ["Descriptive Links"
21752 org-toggle-link-display
21754 :selected org-descriptive-links
21757 org-toggle-link-display
21759 :selected (not org-descriptive-links)])
21762 ["TODO/DONE/-" org-todo t]
21764 ["Next keyword" org-shiftright (org-at-heading-p)]
21765 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21766 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21767 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21768 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21769 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21770 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21772 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21773 :selected org-enforce-todo-dependencies :style toggle :active t]
21774 "Settings for tree at point"
21775 ["Do Children sequentially" org-toggle-ordered-property :style radio
21776 :selected (org-entry-get nil "ORDERED")
21777 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21778 ["Do Children parallel" org-toggle-ordered-property :style radio
21779 :selected (not (org-entry-get nil "ORDERED"))
21780 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21782 ["Set Priority" org-priority t]
21783 ["Priority Up" org-shiftup t]
21784 ["Priority Down" org-shiftdown t]
21786 ["Get news from all feeds" org-feed-update-all t]
21787 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21788 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21789 ("TAGS and Properties"
21790 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21791 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21793 ["Set property" org-set-property (not (org-before-first-heading-p))]
21794 ["Column view of properties" org-columns t]
21795 ["Insert Column View DBlock" org-insert-columns-dblock t])
21796 ("Dates and Scheduling"
21797 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21798 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21800 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21801 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21802 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21803 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21804 ["Compute Time Range" org-evaluate-time-range t]
21805 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21806 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21808 ["Custom time format" org-toggle-time-stamp-overlays
21809 :style radio :selected org-display-custom-times]
21811 ["Goto Calendar" org-goto-calendar t]
21812 ["Date from Calendar" org-date-from-calendar t]
21814 ["Start/Restart Timer" org-timer-start t]
21815 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21816 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21817 ["Insert Timer String" org-timer t]
21818 ["Insert Timer Item" org-timer-item t])
21820 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21821 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21822 ["Clock out" org-clock-out t]
21823 ["Clock cancel" org-clock-cancel t]
21825 ["Mark as default task" org-clock-mark-default-task t]
21826 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21827 ["Goto running clock" org-clock-goto t]
21829 ["Display times" org-clock-display t]
21830 ["Create clock table" org-clock-report t]
21832 ["Record DONE time"
21833 (progn (setq org-log-done (not org-log-done))
21834 (message "Switching to %s will %s record a timestamp"
21835 (car org-done-keywords)
21836 (if org-log-done "automatically" "not")))
21837 :style toggle :selected org-log-done])
21839 ["Agenda Command..." org-agenda t]
21840 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21841 ("File List for Agenda")
21842 ("Special views current file"
21843 ["TODO Tree" org-show-todo-tree t]
21844 ["Check Deadlines" org-check-deadlines t]
21845 ["Timeline" org-timeline t]
21846 ["Tags/Property tree" org-match-sparse-tree t])
21848 ["Export/Publish..." org-export-dispatch t]
21850 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21851 :selected org-cdlatex-mode]
21852 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21853 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21854 ["Modify math symbol" org-cdlatex-math-modify
21855 (org-inside-LaTeX-fragment-p)]
21856 ["Insert citation" org-reftex-citation t]
21858 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21861 ["Push Files and Views" org-mobile-push t]
21862 ["Get Captured and Flagged" org-mobile-pull t]
21863 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21865 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21868 ["Show Version" org-version t]
21869 ["Info Documentation" org-info t])
21871 ["Browse Org Group" org-customize t]
21873 ["Expand This Menu" org-create-customize-menu
21874 (fboundp 'customize-menu-create)])
21875 ["Send bug report" org-submit-bug-report t]
21878 ["Refresh setup current buffer" org-mode-restart t]
21879 ["Reload Org (after update)" org-reload t]
21880 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21883 (defun org-info (&optional node)
21884 "Read documentation for Org-mode in the info system.
21885 With optional NODE, go directly to that node."
21887 (info (format "(org)%s" (or node ""))))
21890 (defun org-submit-bug-report ()
21891 "Submit a bug report on Org-mode via mail.
21893 Don't hesitate to report any problems or inaccurate documentation.
21895 If you don't have setup sending mail from (X)Emacs, please copy the
21896 output buffer into your mail program, as it gives us important
21897 information about your Org-mode version and configuration."
21899 (require 'reporter)
21900 (org-load-modules-maybe)
21901 (org-require-autoloaded-modules)
21902 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21903 (reporter-submit-bug-report
21904 "emacs-orgmode@gnu.org"
21905 (org-version nil 'full)
21907 (save-window-excursion
21908 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21909 (delete-other-windows)
21911 (insert "You are about to submit a bug report to the Org-mode mailing list.
21913 We would like to add your full Org-mode and Outline configuration to the
21914 bug report. This greatly simplifies the work of the maintainer and
21915 other experts on the mailing list.
21917 HOWEVER, some variables you have customized may contain private
21918 information. The names of customers, colleagues, or friends, might
21919 appear in the form of file names, tags, todo states, or search strings.
21920 If you answer yes to the prompt, you might want to check and remove
21921 such private information before sending the email.")
21922 (add-text-properties (point-min) (point-max) '(face org-warning))
21923 (when (yes-or-no-p "Include your Org-mode configuration ")
21927 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21928 (or (and (symbol-value v)
21929 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21931 (get v 'custom-type) (get v 'standard-value)
21932 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21934 (kill-buffer (get-buffer "*Warn about privacy*"))
21937 "Remember to cover the basics, that is, what you expected to happen and
21938 what in fact did happen. You don't know how to make a good report? See
21940 http://orgmode.org/manual/Feedback.html#Feedback
21942 Your bug report will be posted to the Org-mode mailing list.
21943 ------------------------------------------------------------------------")
21945 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21946 (replace-match "\\1Bug: \\3 [\\2]")))))
21949 (defun org-install-agenda-files-menu ()
21950 (let ((bl (buffer-list)))
21953 (set-buffer (pop bl))
21954 (if (derived-mode-p 'org-mode) (setq bl nil)))
21955 (when (derived-mode-p 'org-mode)
21957 '("Org") "File List for Agenda"
21960 ["Edit File List" (org-edit-agenda-file-list) t]
21961 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21962 ["Remove Current File from List" org-remove-file t]
21963 ["Cycle through agenda files" org-cycle-agenda-files t]
21964 ["Occur in all agenda files" org-occur-in-agenda-files t]
21966 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21970 (defun org-require-autoloaded-modules ()
21973 '(org-agenda org-archive org-attach org-clock org-colview org-id
21974 org-table org-timer)))
21977 (defun org-reload (&optional uncompiled)
21978 "Reload all org lisp files.
21979 With prefix arg UNCOMPILED, load the uncompiled versions."
21981 (require 'loadhist)
21982 (let* ((org-dir (org-find-library-dir "org"))
21983 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21984 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21985 (remove-re (mapconcat 'identity
21986 (mapcar (lambda (f) (concat "^" f "$"))
21987 (list (if (featurep 'xemacs)
21989 "org-colview-xemacs")
21990 "org" "org-loaddefs" "org-version"))
21992 (feats (delete-dups
21993 (mapcar 'file-name-sans-extension
21994 (mapcar 'file-name-nondirectory
21996 (mapcar 'feature-file
22003 (if (and (string-match feature-re f)
22004 (not (string-match remove-re f)))
22008 (list "org-version" "org")))
22009 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
22010 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
22011 load-uncore load-misses)
22014 (mapcar (lambda (f)
22015 (or (org-load-noerror-mustsuffix (concat org-dir f))
22016 (and (string= org-dir contrib-dir)
22017 (org-load-noerror-mustsuffix (concat contrib-dir f)))
22018 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
22019 (add-to-list 'load-uncore f 'append)
22024 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
22025 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
22027 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
22028 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
22029 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
22032 (defun org-customize ()
22033 "Call the customize function with org as argument."
22035 (org-load-modules-maybe)
22036 (org-require-autoloaded-modules)
22037 (customize-browse 'org))
22039 (defun org-create-customize-menu ()
22040 "Create a full customization menu for Org-mode, insert it into the menu."
22042 (org-load-modules-maybe)
22043 (org-require-autoloaded-modules)
22044 (if (fboundp 'customize-menu-create)
22047 '("Org") "Customize"
22048 `(["Browse Org group" org-customize t]
22050 ,(customize-menu-create 'org)
22051 ["Set" Custom-set t]
22052 ["Save" Custom-save t]
22053 ["Reset to Current" Custom-reset-current t]
22054 ["Reset to Saved" Custom-reset-saved t]
22055 ["Reset to Standard Settings" Custom-reset-standard t]))
22056 (message "\"Org\"-menu now contains full customization menu"))
22057 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22059 ;;;; Miscellaneous stuff
22061 ;;; Generally useful functions
22063 (defsubst org-get-at-eol (property n)
22064 "Get text property PROPERTY at the end of line less N characters."
22065 (get-text-property (- (point-at-eol) n) property))
22067 (defun org-find-text-property-in-string (prop s)
22068 "Return the first non-nil value of property PROP in string S."
22069 (or (get-text-property 0 prop s)
22070 (get-text-property (or (next-single-property-change 0 prop s) 0)
22073 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22074 "Display the given MESSAGE as a warning."
22075 (if (fboundp 'display-warning)
22076 (display-warning 'org message
22077 (if (featurep 'xemacs) 'warning :warning))
22078 (let ((buf (get-buffer-create "*Org warnings*")))
22079 (with-current-buffer buf
22080 (goto-char (point-max))
22081 (insert "Warning (Org): " message)
22084 (display-buffer buf)
22087 (defun org-eval (form)
22088 "Eval FORM and return result."
22089 (condition-case error
22091 (error (format "%%![Error: %s]" error))))
22093 (defun org-in-clocktable-p ()
22094 "Check if the cursor is in a clocktable."
22095 (let ((pos (point)) start)
22098 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22099 (setq start (match-beginning 0))
22100 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22101 (>= (match-end 0) pos)
22104 (defun org-in-verbatim-emphasis ()
22106 (and (org-in-regexp org-emph-re 2)
22107 (>= (point) (match-beginning 3))
22108 (<= (point) (match-end 4))
22109 (member (match-string 3) '("=" "~")))))
22111 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22112 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22113 (if (and marker (marker-buffer marker)
22114 (buffer-live-p (marker-buffer marker)))
22116 (org-pop-to-buffer-same-window (marker-buffer marker))
22117 (if (or (> marker (point-max)) (< marker (point-min)))
22120 (org-show-context 'org-goto))
22122 (bookmark-jump bookmark)
22123 (error "Cannot find location"))))
22125 (defun org-quote-csv-field (s)
22126 "Quote field for inclusion in CSV material."
22127 (if (string-match "[\",]" s)
22128 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22131 (defun org-force-self-insert (N)
22132 "Needed to enforce self-insert under remapping."
22134 (self-insert-command N))
22136 (defun org-string-width (s)
22137 "Compute width of string, ignoring invisible characters.
22138 This ignores character with invisibility property `org-link', and also
22139 characters with property `org-cwidth', because these will become invisible
22140 upon the next fontification round."
22142 (when (or (eq t buffer-invisibility-spec)
22143 (assq 'org-link buffer-invisibility-spec))
22144 (while (setq b (text-property-any 0 (length s)
22145 'invisible 'org-link s))
22146 (setq s (concat (substring s 0 b)
22147 (substring s (or (next-single-property-change
22148 b 'invisible s) (length s)))))))
22149 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22150 (setq s (concat (substring s 0 b)
22151 (substring s (or (next-single-property-change
22152 b 'org-cwidth s) (length s))))))
22153 (setq l (string-width s) b -1)
22154 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22155 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22158 (defun org-shorten-string (s maxlength)
22159 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22160 If the string is shorter or has length MAXLENGTH, just return the
22161 original string. If it is longer, the functions finds a space in the
22162 string, breaks this string off at that locations and adds three dots
22163 as ellipsis. Including the ellipsis, the string will not be longer
22164 than MAXLENGTH. If finding a good breaking point in the string does
22165 not work, the string is just chopped off in the middle of a word
22167 (if (<= (length s) maxlength)
22169 (let* ((n (max (- maxlength 4) 1))
22170 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22171 (if (string-match re s)
22172 (concat (match-string 1 s) "...")
22173 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22175 (defun org-get-indentation (&optional line)
22176 "Get the indentation of the current line, interpreting tabs.
22177 When LINE is given, assume it represents a line and compute its indentation."
22179 (if (string-match "^ *" (org-remove-tabs line))
22182 (beginning-of-line 1)
22183 (skip-chars-forward " \t")
22184 (current-column))))
22186 (defun org-get-string-indentation (s)
22187 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22188 (let ((n -1) (i 0) (w tab-width) c)
22190 (while (< (setq n (1+ n)) (length s))
22191 (setq c (aref s n))
22192 (cond ((= c ?\ ) (setq i (1+ i)))
22193 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22194 (t (throw 'exit t)))))
22197 (defun org-remove-tabs (s &optional width)
22198 "Replace tabulators in S with spaces.
22199 Assumes that s is a single line, starting in column 0."
22200 (setq width (or width tab-width))
22201 (while (string-match "\t" s)
22202 (setq s (replace-match
22204 (- (* width (/ (+ (match-beginning 0) width) width))
22205 (match-beginning 0)) ?\ )
22209 (defun org-fix-indentation (line ind)
22210 "Fix indentation in LINE.
22211 IND is a cons cell with target and minimum indentation.
22212 If the current indentation in LINE is smaller than the minimum,
22213 leave it alone. If it is larger than ind, set it to the target."
22214 (let* ((l (org-remove-tabs line))
22215 (i (org-get-indentation l))
22216 (i1 (car ind)) (i2 (cdr ind)))
22217 (if (>= i i2) (setq l (substring line i2)))
22219 (concat (make-string i1 ?\ ) l)
22222 (defun org-remove-indentation (code &optional n)
22223 "Remove the maximum common indentation from the lines in CODE.
22224 N may optionally be the number of spaces to remove."
22227 (org-do-remove-indentation n)
22230 (defun org-do-remove-indentation (&optional n)
22231 "Remove the maximum common indentation from the buffer."
22232 (untabify (point-min) (point-max))
22233 (let ((min 10000) re)
22236 (goto-char (point-min))
22237 (while (re-search-forward "^ *[^ \n]" nil t)
22238 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22239 (unless (or (= min 0) (= min 10000))
22240 (setq re (format "^ \\{%d\\}" min))
22241 (goto-char (point-min))
22242 (while (re-search-forward re nil t)
22247 (defun org-fill-template (template alist)
22248 "Find each %key of ALIST in TEMPLATE and replace it."
22249 (let ((case-fold-search nil)
22251 (setq alist (sort (copy-sequence alist)
22252 (lambda (a b) (< (length (car a)) (length (car b))))))
22253 (while (setq entry (pop alist))
22255 (replace-regexp-in-string
22256 (concat "%" (regexp-quote (car entry)))
22257 (or (cdr entry) "") template t t)))
22260 (defun org-base-buffer (buffer)
22261 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22264 (or (buffer-base-buffer buffer)
22267 (defun org-wrap (string &optional width lines)
22268 "Wrap string to either a number of lines, or a width in characters.
22269 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22270 that costs. If there is a word longer than WIDTH, the text is actually
22271 wrapped to the length of that word.
22272 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22273 many lines, whatever width that takes.
22274 The return value is a list of lines, without newlines at the end."
22275 (let* ((words (org-split-string string "[ \t\n]+"))
22276 (maxword (apply 'max (mapcar 'org-string-width words)))
22279 (org-do-wrap words (max maxword width)))
22282 (setq ll (org-do-wrap words maxword))
22283 (if (<= (length ll) lines)
22286 (while (> (length ll) lines)
22288 (setq ll (org-do-wrap words w)))
22290 (t (error "Cannot wrap this")))))
22292 (defun org-do-wrap (words width)
22293 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22296 (setq line (pop words))
22297 (while (and words (< (+ (length line) (length (car words))) width))
22298 (setq line (concat line " " (pop words))))
22299 (setq lines (push line lines)))
22302 (defun org-split-string (string &optional separators)
22303 "Splits STRING into substrings at SEPARATORS.
22304 SEPARATORS is a regular expression.
22305 No empty strings are returned if there are matches at the beginning
22306 and end of string."
22307 ;; FIXME: why not use (split-string STRING SEPARATORS t)?
22308 (let ((start 0) notfirst list)
22309 (while (and (string-match (or separators "[ \f\t\n\r\v]+") string
22311 (= start (match-beginning 0))
22312 (< start (length string)))
22314 (< (match-beginning 0) (length string)))
22316 (or (eq (match-beginning 0) 0)
22317 (and (eq (match-beginning 0) (match-end 0))
22318 (eq (match-beginning 0) start))
22319 (push (substring string start (match-beginning 0)) list))
22320 (setq start (match-end 0)))
22321 (or (eq start (length string))
22322 (push (substring string start) list))
22325 (defun org-quote-vert (s)
22326 "Replace \"|\" with \"\\vert\"."
22327 (while (string-match "|" s)
22328 (setq s (replace-match "\\vert" t t s)))
22331 (defun org-uuidgen-p (s)
22332 "Is S an ID created by UUIDGEN?"
22333 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22335 (defun org-in-src-block-p (&optional inside)
22336 "Whether point is in a code source block.
22337 When INSIDE is non-nil, don't consider we are within a src block
22338 when point is at #+BEGIN_SRC or #+END_SRC."
22339 (let ((case-fold-search t) ov)
22340 (or (and (eq (get-char-property (point) 'src-block) t))
22344 (beginning-of-line)
22345 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22347 (defun org-context ()
22348 "Return a list of contexts of the current cursor position.
22349 If several contexts apply, all are returned.
22350 Each context entry is a list with a symbol naming the context, and
22351 two positions indicating start and end of the context. Possible
22354 :headline anywhere in a headline
22355 :headline-stars on the leading stars in a headline
22356 :todo-keyword on a TODO keyword (including DONE) in a headline
22357 :tags on the TAGS in a headline
22358 :priority on the priority cookie in a headline
22359 :item on the first line of a plain list item
22360 :item-bullet on the bullet/number of a plain list item
22361 :checkbox on the checkbox in a plain list item
22362 :table in an org-mode table
22363 :table-special on a special filed in a table
22364 :table-table in a table.el table
22365 :clocktable in a clocktable
22366 :src-block in a source block
22367 :link on a hyperlink
22368 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22369 :target on a <<target>>
22370 :radio-target on a <<<radio-target>>>
22371 :latex-fragment on a LaTeX fragment
22372 :latex-preview on a LaTeX fragment with overlaid preview image
22374 This function expects the position to be visible because it uses font-lock
22375 faces as a help to recognize the following contexts: :table-special, :link,
22377 (let* ((f (get-text-property (point) 'face))
22378 (faces (if (listp f) f (list f)))
22379 (case-fold-search t)
22380 (p (point)) clist o)
22381 ;; First the large context
22383 ((org-at-heading-p t)
22384 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22386 (beginning-of-line 1)
22387 (looking-at org-todo-line-tags-regexp))
22388 (push (org-point-in-group p 1 :headline-stars) clist)
22389 (push (org-point-in-group p 2 :todo-keyword) clist)
22390 (push (org-point-in-group p 4 :tags) clist))
22392 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22393 (if (looking-at "\\[#[A-Z0-9]\\]")
22394 (push (org-point-in-group p 0 :priority) clist)))
22397 (push (org-point-in-group p 2 :item-bullet) clist)
22398 (push (list :item (point-at-bol)
22399 (save-excursion (org-end-of-item) (point)))
22401 (and (org-at-item-checkbox-p)
22402 (push (org-point-in-group p 0 :checkbox) clist)))
22405 (push (list :table (org-table-begin) (org-table-end)) clist)
22406 (if (memq 'org-formula faces)
22407 (push (list :table-special
22408 (previous-single-property-change p 'face)
22409 (next-single-property-change p 'face)) clist)))
22410 ((org-at-table-p 'any)
22411 (push (list :table-table) clist)))
22414 (let ((case-fold-search t))
22415 ;; New the "medium" contexts: clocktables, source blocks
22416 (cond ((org-in-clocktable-p)
22417 (push (list :clocktable
22418 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22419 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22420 (match-beginning 1))
22421 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22422 (match-end 0))) clist))
22423 ((org-in-src-block-p)
22424 (push (list :src-block
22425 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22426 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22427 (match-beginning 1))
22428 (and (search-forward "#+END_SRC" nil t)
22429 (match-beginning 0))) clist))))
22432 ;; Now the small context
22434 ((org-at-timestamp-p)
22435 (push (org-point-in-group p 0 :timestamp) clist))
22436 ((memq 'org-link faces)
22438 (previous-single-property-change p 'face)
22439 (next-single-property-change p 'face)) clist))
22440 ((memq 'org-special-keyword faces)
22441 (push (list :keyword
22442 (previous-single-property-change p 'face)
22443 (next-single-property-change p 'face)) clist))
22445 (push (org-point-in-group p 0 :target) clist)
22446 (goto-char (1- (match-beginning 0)))
22447 (if (looking-at org-radio-target-regexp)
22448 (push (org-point-in-group p 0 :radio-target) clist))
22450 ((setq o (car (delq nil
22453 (if (memq x org-latex-fragment-image-overlays) x))
22454 (overlays-at (point))))))
22455 (push (list :latex-fragment
22456 (overlay-start o) (overlay-end o)) clist)
22457 (push (list :latex-preview
22458 (overlay-start o) (overlay-end o)) clist))
22459 ((org-inside-LaTeX-fragment-p)
22460 ;; FIXME: positions wrong.
22461 (push (list :latex-fragment (point) (point)) clist)))
22463 (setq clist (nreverse (delq nil clist)))
22466 (defun org-in-regexp (re &optional nlines visually)
22467 "Check if point is inside a match of RE.
22469 Normally only the current line is checked, but you can include
22470 NLINES extra lines after point into the search. If VISUALLY is
22471 set, require that the cursor is not after the match but really
22472 on, so that the block visually is on the match."
22474 (let ((pos (point))
22475 (eol (point-at-eol (+ 1 (or nlines 0))))
22476 (inc (if visually 1 0)))
22478 (beginning-of-line (- 1 (or nlines 0)))
22479 (while (re-search-forward re eol t)
22480 (if (and (<= (match-beginning 0) pos)
22481 (>= (+ inc (match-end 0)) pos))
22482 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22483 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22486 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22487 "Non-nil when point is between matches of START-RE and END-RE.
22489 Also return a non-nil value when point is on one of the matches.
22491 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22492 buffer positions. Default values are the positions of headlines
22493 surrounding the point.
22495 The functions returns a cons cell whose car (resp. cdr) is the
22496 position before START-RE (resp. after END-RE)."
22498 (let ((pos (point))
22499 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22500 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22503 ;; Point is on a block when on START-RE or if START-RE can be
22504 ;; found before it...
22505 (and (or (org-in-regexp start-re)
22506 (re-search-backward start-re limit-up t))
22507 (setq beg (match-beginning 0))
22508 ;; ... and END-RE after it...
22509 (goto-char (match-end 0))
22510 (re-search-forward end-re limit-down t)
22511 (> (setq end (match-end 0)) pos)
22512 ;; ... without another START-RE in-between.
22513 (goto-char (match-beginning 0))
22514 (not (re-search-backward start-re (1+ beg) t))
22516 (cons beg end))))))
22518 (defun org-in-block-p (names)
22519 "Non-nil when point belongs to a block whose name belongs to NAMES.
22521 NAMES is a list of strings containing names of blocks.
22523 Return first block name matched, or nil. Beware that in case of
22524 nested blocks, the returned name may not belong to the closest
22528 (let ((case-fold-search t)
22529 (lim-up (save-excursion (outline-previous-heading)))
22530 (lim-down (save-excursion (outline-next-heading))))
22531 (mapc (lambda (name)
22532 (let ((n (regexp-quote name)))
22533 (when (org-between-regexps-p
22534 (concat "^[ \t]*#\\+begin_" n)
22535 (concat "^[ \t]*#\\+end_" n)
22541 (defun org-occur-in-agenda-files (regexp &optional nlines)
22542 "Call `multi-occur' with buffers for all agenda files."
22543 (interactive "sOrg-files matching: \np")
22544 (let* ((files (org-agenda-files))
22545 (tnames (mapcar 'file-truename files))
22546 (extra org-agenda-text-search-extra-files)
22548 (when (eq (car extra) 'agenda-archives)
22549 (setq extra (cdr extra))
22550 (setq files (org-add-archive-files files)))
22551 (while (setq f (pop extra))
22552 (unless (member (file-truename f) tnames)
22553 (add-to-list 'files f 'append)
22554 (add-to-list 'tnames (file-truename f) 'append)))
22556 (mapcar (lambda (x)
22557 (with-current-buffer
22558 (or (get-file-buffer x) (find-file-noselect x))
22564 (if (boundp 'occur-mode-find-occurrence-hook)
22566 (add-hook 'occur-mode-find-occurrence-hook
22568 (when (derived-mode-p 'org-mode)
22571 (defadvice occur-mode-goto-occurrence
22572 (after org-occur-reveal activate)
22573 (and (derived-mode-p 'org-mode) (org-reveal)))
22574 (defadvice occur-mode-goto-occurrence-other-window
22575 (after org-occur-reveal activate)
22576 (and (derived-mode-p 'org-mode) (org-reveal)))
22577 (defadvice occur-mode-display-occurrence
22578 (after org-occur-reveal activate)
22579 (when (derived-mode-p 'org-mode)
22580 (let ((pos (occur-mode-find-occurrence)))
22581 (with-current-buffer (marker-buffer pos)
22586 (defun org-occur-link-in-agenda-files ()
22587 "Create a link and search for it in the agendas.
22588 The link is not stored in `org-stored-links', it is just created
22589 for the search purpose."
22591 (let ((link (condition-case nil
22592 (org-store-link nil)
22593 (error "Unable to create a link to here"))))
22594 (org-occur-in-agenda-files (regexp-quote link))))
22596 (defun org-reverse-string (string)
22597 "Return the reverse of STRING."
22598 (apply 'string (reverse (string-to-list string))))
22600 ;; defsubst org-uniquify must be defined before first use
22602 (defun org-uniquify-alist (alist)
22603 "Merge elements of ALIST with the same key.
22605 For example, in this alist:
22607 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22608 => '((a 1 3) (b 2))
22610 merge (a 1) and (a 3) into (a 1 3).
22612 The function returns the new ALIST."
22617 (if (not (assoc (car e) rtn))
22619 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22620 (setq rtn (assq-delete-all (car e) rtn))
22625 (defun org-delete-all (elts list)
22626 "Remove all elements in ELTS from LIST."
22628 (setq list (delete (pop elts) list)))
22631 (defun org-count (cl-item cl-seq)
22632 "Count the number of occurrences of ITEM in SEQ.
22633 Taken from `count' in cl-seq.el with all keyword arguments removed."
22634 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22635 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22636 (while (< cl-start cl-end)
22637 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22638 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22639 (setq cl-start (1+ cl-start)))
22642 (defun org-remove-if (predicate seq)
22643 "Remove everything from SEQ that fulfills PREDICATE."
22647 (if (not (funcall predicate e)) (push e res)))
22650 (defun org-remove-if-not (predicate seq)
22651 "Remove everything from SEQ that does not fulfill PREDICATE."
22655 (if (funcall predicate e) (push e res)))
22658 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22659 "Reduce two-argument FUNCTION across SEQ.
22660 Taken from `reduce' in cl-seq.el with all keyword arguments but
22661 \":initial-value\" removed."
22662 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22663 (cadr (memq :initial-value cl-keys)))
22664 (cl-seq (pop cl-seq))
22665 (t (funcall cl-func)))))
22667 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22670 (defun org-every (pred seq)
22671 "Return true if PREDICATE is true of every element of SEQ.
22672 Adapted from `every' in cl.el."
22674 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22677 (defun org-some (pred seq)
22678 "Return true if PREDICATE is true of any element of SEQ.
22679 Adapted from `some' in cl.el."
22681 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22684 (defun org-back-over-empty-lines ()
22685 "Move backwards over whitespace, to the beginning of the first empty line.
22686 Returns the number of empty lines passed."
22687 (let ((pos (point)))
22688 (if (cdr (assoc 'heading org-blank-before-new-entry))
22689 (skip-chars-backward " \t\n\r")
22691 (forward-line -1)))
22692 (beginning-of-line 2)
22693 (goto-char (min (point) pos))
22694 (count-lines (point) pos)))
22696 (defun org-skip-whitespace ()
22697 (skip-chars-forward " \t\n\r"))
22699 (defun org-point-in-group (point group &optional context)
22700 "Check if POINT is in match-group GROUP.
22701 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22702 match. If the match group does not exist or point is not inside it,
22704 (and (match-beginning group)
22705 (>= point (match-beginning group))
22706 (<= point (match-end group))
22708 (list context (match-beginning group) (match-end group))
22711 (defun org-switch-to-buffer-other-window (&rest args)
22712 "Switch to buffer in a second window on the current frame.
22713 In particular, do not allow pop-up frames.
22714 Returns the newly created buffer."
22716 (apply 'switch-to-buffer-other-window args)))
22718 (defun org-combine-plists (&rest plists)
22719 "Create a single property list from all plists in PLISTS.
22720 The process starts by copying the first list, and then setting properties
22721 from the other lists. Settings in the last list are the most significant
22722 ones and overrule settings in the other lists."
22723 (let ((rtn (copy-sequence (pop plists)))
22726 (setq ls (pop plists))
22728 (setq p (pop ls) v (pop ls))
22729 (setq rtn (plist-put rtn p v))))
22732 (defun org-replace-escapes (string table)
22733 "Replace %-escapes in STRING with values in TABLE.
22734 TABLE is an association list with keys like \"%a\" and string values.
22735 The sequences in STRING may contain normal field width and padding information,
22736 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22737 so values can contain further %-escapes if they are define later in TABLE."
22738 (let ((tbl (copy-alist table))
22739 (case-fold-search nil)
22742 (while (setq e (pop tbl))
22743 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22744 (when (and (cdr e) (string-match re (cdr e)))
22745 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22747 (add-text-properties 0 3 (list 'sref sref) safe)
22748 (setcdr e (replace-match safe t t (cdr e)))))
22749 (while (string-match re string)
22750 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22752 (setq string (replace-match rpl t t string))))
22753 (while (setq pchg (next-property-change pchg string))
22754 (let ((sref (get-text-property pchg 'sref string)))
22755 (when (and sref (string-match "SREF" string pchg))
22756 (setq string (replace-match sref t t string)))))
22759 (defun org-sublist (list start end)
22760 "Return a section of LIST, from START to END.
22761 Counting starts at 1."
22762 (let (rtn (c start))
22763 (setq list (nthcdr (1- start) list))
22764 (while (and list (<= c end))
22765 (push (pop list) rtn)
22769 (defun org-find-base-buffer-visiting (file)
22770 "Like `find-buffer-visiting' but always return the base buffer and
22771 not an indirect buffer."
22772 (let ((buf (or (get-file-buffer file)
22773 (find-buffer-visiting file))))
22775 (or (buffer-base-buffer buf) buf)
22778 (defun org-image-file-name-regexp (&optional extensions)
22779 "Return regexp matching the file names of images.
22780 If EXTENSIONS is given, only match these."
22781 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22782 (image-file-name-regexp)
22783 (let ((image-file-name-extensions
22785 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22786 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22788 (regexp-opt (nconc (mapcar 'upcase
22789 image-file-name-extensions)
22790 image-file-name-extensions)
22794 (defun org-file-image-p (file &optional extensions)
22795 "Return non-nil if FILE is an image."
22797 (string-match (org-image-file-name-regexp extensions) file)))
22799 (defun org-get-cursor-date (&optional with-time)
22800 "Return the date at cursor in as a time.
22801 This works in the calendar and in the agenda, anywhere else it just
22802 returns the current time.
22803 If WITH-TIME is non-nil, returns the time of the event at point (in
22804 the agenda) or the current time of the day."
22805 (let (date day defd tp tm hod mod)
22807 (setq tp (get-text-property (point) 'time))
22808 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22809 (setq hod (string-to-number (match-string 1 tp))
22810 mod (string-to-number (match-string 2 tp))))
22811 (or tp (let ((now (decode-time)))
22812 (setq hod (nth 2 now)
22813 mod (nth 1 now)))))
22815 ((eq major-mode 'calendar-mode)
22816 (setq date (calendar-cursor-to-date)
22817 defd (encode-time 0 (or mod 0) (or hod 0)
22818 (nth 1 date) (nth 0 date) (nth 2 date))))
22819 ((eq major-mode 'org-agenda-mode)
22820 (setq day (get-text-property (point) 'day))
22822 (setq date (calendar-gregorian-from-absolute day)
22823 defd (encode-time 0 (or mod 0) (or hod 0)
22824 (nth 1 date) (nth 0 date) (nth 2 date))))))
22825 (or defd (current-time))))
22827 (defun org-mark-subtree (&optional up)
22828 "Mark the current subtree.
22829 This puts point at the start of the current subtree, and mark at
22830 the end. If a numeric prefix UP is given, move up into the
22831 hierarchy of headlines by UP levels before marking the subtree."
22833 (org-with-limited-levels
22834 (cond ((org-at-heading-p) (beginning-of-line))
22835 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22836 (t (outline-previous-visible-heading 1))))
22837 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22838 (if (org-called-interactively-p 'any)
22839 (call-interactively 'org-mark-element)
22840 (org-mark-element)))
22845 (defun org--get-expected-indentation (element contentsp)
22846 "Expected indentation column for current line, according to ELEMENT.
22847 ELEMENT is an element containing point. CONTENTSP is non-nil
22848 when indentation is to be computed according to contents of
22850 (let ((type (org-element-type element))
22851 (start (org-element-property :begin element))
22852 (post-affiliated (org-element-property :post-affiliated element)))
22853 (org-with-wide-buffer
22857 ((diary-sexp footnote-definition) 0)
22858 ((headline inlinetask nil)
22859 (if (not org-adapt-indentation) 0
22860 (let ((level (org-current-level)))
22861 (if level (1+ level) 0))))
22862 ((item plain-list) (org-list-item-body-column post-affiliated))
22865 (org-get-indentation))))
22866 ((memq type '(headline inlinetask nil))
22867 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22868 (org--get-expected-indentation element t)
22870 ((memq type '(diary-sexp footnote-definition)) 0)
22871 ;; First paragraph of a footnote definition or an item.
22872 ;; Indent like parent.
22873 ((< (line-beginning-position) start)
22874 (org--get-expected-indentation
22875 (org-element-property :parent element) t))
22876 ;; At first line: indent according to previous sibling, if any,
22877 ;; ignoring footnote definitions and inline tasks, or parent's
22879 ((= (line-beginning-position) start)
22882 (if (= (point-min) start) (throw 'exit 0)
22883 (goto-char (1- start))
22884 (let* ((previous (org-element-at-point))
22886 (while (and parent (<= (org-element-property :end parent) start))
22887 (setq previous parent
22888 parent (org-element-property :parent parent)))
22890 ((not previous) (throw 'exit 0))
22891 ((> (org-element-property :end previous) start)
22892 (throw 'exit (org--get-expected-indentation previous t)))
22893 ((memq (org-element-type previous)
22894 '(footnote-definition inlinetask))
22895 (setq start (org-element-property :begin previous)))
22896 (t (goto-char (org-element-property :begin previous))
22898 (if (bolp) (org-get-indentation)
22899 ;; At first paragraph in an item or
22900 ;; a footnote definition.
22901 (org--get-expected-indentation
22902 (org-element-property :parent previous) t))))))))))
22903 ;; Otherwise, move to the first non-blank line above.
22905 (beginning-of-line)
22906 (let ((pos (point)))
22907 (skip-chars-backward " \r\t\n")
22909 ;; Two blank lines end a footnote definition or a plain
22910 ;; list. When we indent an empty line after them, the
22911 ;; containing list or footnote definition is over, so it
22912 ;; qualifies as a previous sibling. Therefore, we indent
22913 ;; like its first line.
22914 ((and (memq type '(footnote-definition plain-list))
22915 (> (count-lines (point) pos) 2))
22917 (org-get-indentation))
22918 ;; Line above is the first one of a paragraph at the
22919 ;; beginning of an item or a footnote definition. Indent
22921 ((< (line-beginning-position) start)
22922 (org--get-expected-indentation
22923 (org-element-property :parent element) t))
22924 ;; Line above is the beginning of an element, i.e., point
22925 ;; was originally on the blank lines between element's start
22927 ((= (line-beginning-position) post-affiliated)
22928 (org--get-expected-indentation element t))
22929 ;; POS is after contents in a greater element. Indent like
22930 ;; the beginning of the element.
22932 ;; As a special case, if point is at the end of a footnote
22933 ;; definition or an item, indent like the very last element
22935 ((and (not (eq type 'paragraph))
22936 (let ((cend (org-element-property :contents-end element)))
22937 (and cend (<= cend pos))))
22938 (if (memq type '(footnote-definition item plain-list))
22939 (let ((last (org-element-at-point)))
22940 (org--get-expected-indentation
22942 (memq (org-element-type last)
22943 '(footnote-definition item plain-list))))
22945 (org-get-indentation)))
22946 ;; In any other case, indent like the current line.
22947 (t (org-get-indentation)))))))))
22949 (defun org--align-node-property ()
22950 "Align node property at point.
22951 Alignment is done according to `org-property-format', which see."
22952 (when (save-excursion
22953 (beginning-of-line)
22954 (looking-at org-property-re))
22956 (concat (match-string 4)
22958 (format org-property-format (match-string 1) (match-string 3))))
22961 (defun org-indent-line ()
22962 "Indent line depending on context.
22964 Indentation is done according to the following rules:
22966 - Footnote definitions, diary sexps, headlines and inline tasks
22967 have to start at column 0.
22969 - On the very first line of an element, consider, in order, the
22970 next rules until one matches:
22972 1. If there's a sibling element before, ignoring footnote
22973 definitions and inline tasks, indent like its first line.
22975 2. If element has a parent, indent like its contents. More
22976 precisely, if parent is an item, indent after the
22977 description part, if any, or the bullet (see
22978 `org-list-description-max-indent'). Else, indent like
22979 parent's first line.
22981 3. Otherwise, indent relatively to current level, if
22982 `org-adapt-indentation' is non-nil, or to left margin.
22984 - On a blank line at the end of an element, indent according to
22985 the type of the element. More precisely
22987 1. If element is a plain list, an item, or a footnote
22988 definition, indent like the very last element within.
22990 2. If element is a paragraph, indent like its last non blank
22993 3. Otherwise, indent like its very first line.
22995 - In the code part of a source block, use language major mode
22996 to indent current line if `org-src-tab-acts-natively' is
22997 non-nil. If it is nil, do nothing.
22999 - Otherwise, indent like the first non-blank line above.
23001 The function doesn't indent an item as it could break the whole
23002 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
23003 \\[org-shiftmetaright].
23005 Also align node properties according to `org-property-format'."
23009 (let ((indent-line-function
23010 (cadadr (assq 'indent-line-function org-fb-vars))))
23011 (indent-according-to-mode)))
23012 ((org-at-heading-p) 'noindent)
23014 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
23015 (type (org-element-type element)))
23016 (cond ((and (memq type '(plain-list item))
23017 (= (line-beginning-position)
23018 (org-element-property :post-affiliated element)))
23020 ((and (eq type 'src-block)
23021 org-src-tab-acts-natively
23022 (> (line-beginning-position)
23023 (org-element-property :post-affiliated element))
23024 (< (line-beginning-position)
23025 (org-with-wide-buffer
23026 (goto-char (org-element-property :end element))
23027 (skip-chars-backward " \r\t\n")
23028 (line-beginning-position))))
23029 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
23031 (let ((column (org--get-expected-indentation element nil)))
23032 ;; Preserve current column.
23033 (if (<= (current-column) (current-indentation))
23034 (org-indent-line-to column)
23035 (save-excursion (org-indent-line-to column))))
23036 ;; Align node property. Also preserve current column.
23037 (when (eq type 'node-property)
23038 (let ((column (current-column)))
23039 (org--align-node-property)
23040 (org-move-to-column column)))))))))
23042 (defun org-indent-region (start end)
23043 "Indent each non-blank line in the region.
23044 Called from a program, START and END specify the region to
23045 indent. The function will not indent contents of example blocks,
23046 verse blocks and export blocks as leading white spaces are
23047 assumed to be significant there."
23051 (skip-chars-forward " \r\t\n")
23052 (unless (eobp) (beginning-of-line))
23055 ;; Set IND as indentation for all lines between point and
23056 ;; POS or END, whichever comes first. Blank lines are
23057 ;; ignored. Leave point after POS once done.
23058 (let ((limit (copy-marker (min end pos))))
23059 (while (< (point) limit)
23060 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23062 (set-marker limit nil))))
23063 (end (copy-marker end)))
23064 (while (< (point) end)
23065 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23066 (let* ((element (org-element-at-point))
23067 (type (org-element-type element))
23068 (element-end (copy-marker (org-element-property :end element)))
23069 (ind (org--get-expected-indentation element nil)))
23071 ((or (memq type '(paragraph table table-row))
23072 (not (or (org-element-property :contents-begin element)
23074 '(example-block export-block src-block)))))
23075 ;; Elements here are indented as a single block. Also
23076 ;; align node properties.
23077 (when (eq type 'node-property)
23078 (org--align-node-property)
23079 (beginning-of-line))
23080 (funcall indent-to ind element-end))
23082 ;; Elements in this category consist of three parts:
23083 ;; before the contents, the contents, and after the
23084 ;; contents. The contents are treated specially,
23085 ;; according to the element type, or not indented at
23086 ;; all. Other parts are indented as a single block.
23087 (let* ((post (copy-marker
23088 (org-element-property :post-affiliated element)))
23092 ((not (org-element-property :contents-begin element))
23093 ;; Fake contents for source blocks.
23094 (org-with-wide-buffer
23098 ((memq type '(footnote-definition item plain-list))
23099 ;; Contents in these elements could start on
23100 ;; the same line as the beginning of the
23101 ;; element. Make sure we start indenting
23102 ;; from the second line.
23103 (org-with-wide-buffer
23106 (skip-chars-forward " \r\t\n")
23107 (if (eobp) (point) (line-beginning-position))))
23108 (t (org-element-property :contents-begin element)))))
23110 (or (org-element-property :contents-end element)
23111 ;; Fake contents for source blocks.
23112 (org-with-wide-buffer
23113 (goto-char element-end)
23114 (skip-chars-backward " \r\t\n")
23115 (line-beginning-position)))
23117 ;; Do not change items indentation individually as it
23118 ;; might break the list as a whole. On the other
23119 ;; hand, when at a plain list, indent it as a whole.
23120 (cond ((eq type 'plain-list)
23121 (let ((offset (- ind (org-get-indentation))))
23122 (unless (zerop offset)
23123 (indent-rigidly (org-element-property :begin element)
23124 (org-element-property :end element)
23127 ((eq type 'item) (goto-char cbeg))
23128 (t (funcall indent-to ind cbeg)))
23129 (when (< (point) end)
23131 ((example-block export-block verse-block))
23133 ;; In a source block, indent source code
23134 ;; according to language major mode, but only if
23135 ;; `org-src-tab-acts-natively' is non-nil.
23136 (when (and (< (point) end) org-src-tab-acts-natively)
23138 (org-babel-do-in-edit-buffer
23139 (indent-region (point-min) (point-max))))))
23140 (t (org-indent-region (point) (min cend end))))
23141 (goto-char (min cend end))
23142 (when (< (point) end) (funcall indent-to ind element-end)))
23143 (set-marker post nil)
23144 (set-marker cbeg nil)
23145 (set-marker cend nil))))
23146 (set-marker element-end nil))))
23147 (set-marker end nil))))
23149 (defun org-indent-drawer ()
23150 "Indent the drawer at point."
23152 (unless (save-excursion
23153 (beginning-of-line)
23154 (org-looking-at-p org-drawer-regexp))
23155 (user-error "Not at a drawer"))
23156 (let ((element (org-element-at-point)))
23157 (unless (memq (org-element-type element) '(drawer property-drawer))
23158 (user-error "Not at a drawer"))
23159 (org-with-wide-buffer
23160 (org-indent-region (org-element-property :begin element)
23161 (org-element-property :end element))))
23162 (message "Drawer at point indented"))
23164 (defun org-indent-block ()
23165 "Indent the block at point."
23167 (unless (save-excursion
23168 (beginning-of-line)
23169 (let ((case-fold-search t))
23170 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23171 (user-error "Not at a block"))
23172 (let ((element (org-element-at-point)))
23173 (unless (memq (org-element-type element)
23174 '(comment-block center-block dynamic-block example-block
23175 export-block quote-block special-block
23176 src-block verse-block))
23177 (user-error "Not at a block"))
23178 (org-with-wide-buffer
23179 (org-indent-region (org-element-property :begin element)
23180 (org-element-property :end element))))
23181 (message "Block at point indented"))
23186 ;; We use our own fill-paragraph and auto-fill functions.
23188 ;; `org-fill-paragraph' relies on adaptive filling and context
23189 ;; checking. Appropriate `fill-prefix' is computed with
23190 ;; `org-adaptive-fill-function'.
23192 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23193 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23194 ;; `org-adaptive-fill-function' value. Internally,
23195 ;; `org-comment-line-break-function' breaks the line.
23197 ;; `org-setup-filling' installs filling and auto-filling related
23198 ;; variables during `org-mode' initialization.
23200 (defvar org-element-paragraph-separate) ; org-element.el
23201 (defun org-setup-filling ()
23202 (require 'org-element)
23203 ;; Prevent auto-fill from inserting unwanted new items.
23204 (when (boundp 'fill-nobreak-predicate)
23206 'fill-nobreak-predicate
23208 (append fill-nobreak-predicate
23209 '(org-fill-line-break-nobreak-p
23210 org-fill-paragraph-with-timestamp-nobreak-p)))))
23211 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23212 (org-set-local 'paragraph-start paragraph-ending)
23213 (org-set-local 'paragraph-separate paragraph-ending))
23214 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23215 (org-set-local 'auto-fill-inhibit-regexp nil)
23216 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23217 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23218 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23220 (defun org-fill-line-break-nobreak-p ()
23221 "Non-nil when a new line at point would create an Org line break."
23223 (skip-chars-backward "[ \t]")
23224 (skip-chars-backward "\\\\")
23225 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23227 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23228 "Non-nil when a new line at point would split a timestamp."
23229 (and (org-at-timestamp-p t)
23230 (not (looking-at org-ts-regexp-both))))
23232 (declare-function message-in-body-p "message" ())
23233 (defvar orgtbl-line-start-regexp) ; From org-table.el
23234 (defun org-adaptive-fill-function ()
23235 "Compute a fill prefix for the current line.
23236 Return fill prefix, as a string, or nil if current line isn't
23237 meant to be filled. For convenience, if `adaptive-fill-regexp'
23238 matches in paragraphs or comments, use it."
23240 (when (derived-mode-p 'message-mode)
23242 (beginning-of-line)
23243 (cond ((not (message-in-body-p)) (throw 'exit nil))
23244 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23245 ((looking-at message-cite-prefix-regexp)
23246 (throw 'exit (match-string-no-properties 0)))
23247 ((looking-at org-outline-regexp)
23248 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23249 (org-with-wide-buffer
23250 (unless (org-at-heading-p)
23251 (let* ((p (line-beginning-position))
23252 (element (save-excursion
23253 (beginning-of-line)
23254 (org-element-at-point)))
23255 (type (org-element-type element))
23256 (post-affiliated (org-element-property :post-affiliated element)))
23257 (unless (< p post-affiliated)
23261 (beginning-of-line)
23262 (looking-at "[ \t]*")
23263 (concat (match-string 0) "# ")))
23264 (footnote-definition "")
23266 (make-string (org-list-item-body-column post-affiliated) ?\s))
23268 ;; Fill prefix is usually the same as the current line,
23269 ;; unless the paragraph is at the beginning of an item.
23270 (let ((parent (org-element-property :parent element)))
23272 (beginning-of-line)
23273 (cond ((eq (org-element-type parent) 'item)
23274 (make-string (org-list-item-body-column
23275 (org-element-property :begin parent))
23277 ((and adaptive-fill-regexp
23279 ;; `adaptive-fill-function' to let
23280 ;; `fill-context-prefix' handle
23281 ;; `adaptive-fill-regexp' variable.
23282 (let (adaptive-fill-function)
23283 (fill-context-prefix
23285 (org-element-property :end element)))))
23286 ((looking-at "[ \t]+") (match-string 0))
23289 ;; Only fill contents if P is within block boundaries.
23290 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23293 (cend (save-excursion
23294 (goto-char (org-element-property :end element))
23295 (skip-chars-backward " \r\t\n")
23296 (line-beginning-position))))
23297 (when (and (>= p cbeg) (< p cend))
23298 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23302 (declare-function message-goto-body "message" ())
23303 (defvar message-cite-prefix-regexp) ; From message.el
23304 (defun org-fill-paragraph (&optional justify)
23305 "Fill element at point, when applicable.
23307 This function only applies to comment blocks, comments, example
23308 blocks and paragraphs. Also, as a special case, re-align table
23309 when point is at one.
23311 If JUSTIFY is non-nil (interactively, with prefix argument),
23312 justify as well. If `sentence-end-double-space' is non-nil, then
23313 period followed by one space does not end a sentence, so don't
23314 break a line there. The variable `fill-column' controls the
23317 For convenience, when point is at a plain list, an item or
23318 a footnote definition, try to fill the first paragraph within."
23320 (if (and (derived-mode-p 'message-mode)
23321 (or (not (message-in-body-p))
23322 (save-excursion (move-beginning-of-line 1)
23323 (looking-at message-cite-prefix-regexp))))
23324 ;; First ensure filling is correct in message-mode.
23325 (let ((fill-paragraph-function
23326 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23327 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23328 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23329 (paragraph-separate
23330 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23331 (fill-paragraph nil))
23332 (with-syntax-table org-mode-transpose-word-syntax-table
23333 ;; Move to end of line in order to get the first paragraph
23334 ;; within a plain list or a footnote definition.
23335 (let ((element (save-excursion
23337 (or (ignore-errors (org-element-at-point))
23338 (user-error "An element cannot be parsed line %d"
23339 (line-number-at-pos (point)))))))
23340 ;; First check if point is in a blank line at the beginning of
23341 ;; the buffer. In that case, ignore filling.
23342 (case (org-element-type element)
23343 ;; Use major mode filling function is src blocks.
23344 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23345 ;; Align Org tables, leave table.el tables as-is.
23346 (table-row (org-table-align) t)
23348 (when (eq (org-element-property :type element) 'org)
23350 (goto-char (org-element-property :post-affiliated element))
23351 (org-table-align)))
23354 ;; Paragraphs may contain `line-break' type objects.
23355 (let ((beg (max (point-min)
23356 (org-element-property :contents-begin element)))
23357 (end (min (point-max)
23358 (org-element-property :contents-end element))))
23359 ;; Do nothing if point is at an affiliated keyword.
23360 (if (< (line-end-position) beg) t
23361 (when (derived-mode-p 'message-mode)
23362 ;; In `message-mode', do not fill following citation
23363 ;; in current paragraph nor text before message body.
23364 (let ((body-start (save-excursion (message-goto-body))))
23365 (when body-start (setq beg (max body-start beg))))
23366 (when (save-excursion
23368 (concat "^" message-cite-prefix-regexp) end t))
23369 (setq end (match-beginning 0))))
23370 ;; Fill paragraph, taking line breaks into account.
23373 (let ((cuts (list beg)))
23374 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23375 (when (eq 'line-break
23377 (save-excursion (backward-char)
23378 (org-element-context))))
23379 (push (point) cuts)))
23380 (dolist (c (delq end cuts))
23381 (fill-region-as-paragraph c end justify)
23384 ;; Contents of `comment-block' type elements should be
23385 ;; filled as plain text, but only if point is within block
23388 (let* ((case-fold-search t)
23389 (beg (save-excursion
23390 (goto-char (org-element-property :begin element))
23391 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23394 (end (save-excursion
23395 (goto-char (org-element-property :end element))
23396 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23397 (line-beginning-position))))
23398 (if (or (< (point) beg) (> (point) end)) t
23399 (fill-region-as-paragraph
23400 (save-excursion (end-of-line)
23401 (re-search-backward "^[ \t]*$" beg 'move)
23402 (line-beginning-position))
23403 (save-excursion (beginning-of-line)
23404 (re-search-forward "^[ \t]*$" end 'move)
23405 (line-beginning-position))
23409 (let ((begin (org-element-property :post-affiliated element))
23410 (end (org-element-property :end element)))
23411 (when (and (>= (point) begin) (<= (point) end))
23412 (let ((begin (save-excursion
23414 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23415 (progn (forward-line) (point))
23417 (end (save-excursion
23419 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23420 (1- (line-beginning-position))
23421 (skip-chars-backward " \r\t\n")
23422 (line-end-position)))))
23423 ;; Do not fill comments when at a blank line.
23424 (when (> end begin)
23427 (beginning-of-line)
23428 (looking-at "[ \t]*#")
23429 (let ((comment-prefix (match-string 0)))
23430 (goto-char (match-end 0))
23431 (if (looking-at adaptive-fill-regexp)
23432 (concat comment-prefix (match-string 0))
23433 (concat comment-prefix " "))))))
23435 (fill-region-as-paragraph begin end justify))))))
23437 ;; Ignore every other element.
23440 (defun org-auto-fill-function ()
23441 "Auto-fill function."
23442 ;; Check if auto-filling is meaningful.
23443 (let ((fc (current-fill-column)))
23444 (when (and fc (> (current-column) fc))
23445 (let* ((fill-prefix (org-adaptive-fill-function))
23446 ;; Enforce empty fill prefix, if required. Otherwise, it
23447 ;; will be computed again.
23448 (adaptive-fill-mode (not (equal fill-prefix ""))))
23449 (when fill-prefix (do-auto-fill))))))
23451 (defun org-comment-line-break-function (&optional soft)
23452 "Break line at point and indent, continuing comment if within one.
23453 The inserted newline is marked hard if variable
23454 `use-hard-newlines' is true, unless optional argument SOFT is
23456 (if soft (insert-and-inherit ?\n) (newline 1))
23457 (save-excursion (forward-char -1) (delete-horizontal-space))
23458 (delete-horizontal-space)
23459 (indent-to-left-margin)
23460 (insert-before-markers-and-inherit fill-prefix))
23463 ;;; Fixed Width Areas
23465 (defun org-toggle-fixed-width ()
23466 "Toggle fixed-width markup.
23468 Add or remove fixed-width markup on current line, whenever it
23469 makes sense. Return an error otherwise.
23471 If a region is active and if it contains only fixed-width areas
23472 or blank lines, remove all fixed-width markup in it. If the
23473 region contains anything else, convert all non-fixed-width lines
23474 to fixed-width ones.
23476 Blank lines at the end of the region are ignored unless the
23477 region only contains such lines."
23479 (if (not (org-region-active-p))
23482 ;; Remove fixed width marker only in a fixed-with element.
23484 ;; Add fixed width maker in paragraphs, in blank lines after
23485 ;; elements or at the beginning of a headline or an inlinetask,
23486 ;; and before any one-line elements (e.g., a clock).
23488 (beginning-of-line)
23489 (let* ((element (org-element-at-point))
23490 (type (org-element-type element)))
23492 ((and (eq type 'fixed-width)
23493 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23495 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23496 ((and (memq type '(babel-call clock comment diary-sexp headline
23497 horizontal-rule keyword paragraph
23499 (<= (org-element-property :post-affiliated element) (point)))
23500 (skip-chars-forward " \t")
23502 ((and (org-looking-at-p "[ \t]*$")
23503 (or (eq type 'inlinetask)
23505 (skip-chars-forward " \r\t\n")
23506 (<= (org-element-property :end element) (point)))))
23507 (delete-region (point) (line-end-position))
23510 (t (user-error "Cannot insert a fixed-width line here")))))
23512 (let* ((begin (save-excursion
23513 (goto-char (region-beginning))
23514 (line-beginning-position)))
23517 (goto-char (region-end))
23518 (unless (eolp) (beginning-of-line))
23519 (if (save-excursion (re-search-backward "\\S-" begin t))
23520 (progn (skip-chars-backward " \r\t\n") (point))
23526 (skip-chars-forward " \r\t\n")
23527 (when (eobp) (throw 'not-all-p nil))
23528 (while (< (point) end)
23529 (let ((element (org-element-at-point)))
23530 (if (eq (org-element-type element) 'fixed-width)
23531 (goto-char (org-element-property :end element))
23532 (throw 'not-all-p nil))))
23534 (if all-fixed-width-p
23537 (while (< (point) end)
23538 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23541 (if (= (line-end-position) (match-end 0)) 0 1)))
23543 (let ((min-ind (point-max)))
23544 ;; Find minimum indentation across all lines.
23547 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23550 (while (< (point) end)
23551 (unless (org-looking-at-p "[ \t]*$")
23552 (let ((ind (org-get-indentation)))
23553 (setq min-ind (min min-ind ind))
23554 (when (zerop ind) (throw 'zerop t))))
23556 ;; Loop over all lines and add fixed-width markup everywhere
23557 ;; but in fixed-width lines.
23560 (while (< (point) end)
23562 ((org-at-heading-p)
23565 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23568 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23569 (let* ((element (org-element-at-point))
23570 (element-end (org-element-property :end element)))
23571 (if (eq (org-element-type element) 'fixed-width)
23572 (progn (goto-char element-end)
23573 (skip-chars-backward " \r\t\n")
23575 (let ((limit (min end element-end)))
23576 (while (< (point) limit)
23577 (org-move-to-column min-ind t)
23579 (forward-line))))))
23581 (org-move-to-column min-ind t)
23583 (forward-line)))))))
23584 (set-marker end nil))))
23589 ;; Org comments syntax is quite complex. It requires the entire line
23590 ;; to be just a comment. Also, even with the right syntax at the
23591 ;; beginning of line, some some elements (i.e. verse-block or
23592 ;; example-block) don't accept comments. Usual Emacs comment commands
23593 ;; cannot cope with those requirements. Therefore, Org replaces them.
23595 ;; Org still relies on `comment-dwim', but cannot trust
23596 ;; `comment-only-p'. So, `comment-region-function' and
23597 ;; `uncomment-region-function' both point
23598 ;; to`org-comment-or-uncomment-region'. Eventually,
23599 ;; `org-insert-comment' takes care of insertion of comments at the
23600 ;; beginning of line.
23602 ;; `org-setup-comments-handling' install comments related variables
23603 ;; during `org-mode' initialization.
23605 (defun org-setup-comments-handling ()
23607 (org-set-local 'comment-use-syntax nil)
23608 (org-set-local 'comment-start "# ")
23609 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23610 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23611 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23612 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23614 (defun org-insert-comment ()
23615 "Insert an empty comment above current line.
23616 If the line is empty, insert comment at its beginning. When
23617 point is within a source block, comment according to the related
23619 (if (let ((element (org-element-at-point)))
23620 (and (eq (org-element-type element) 'src-block)
23622 (goto-char (org-element-property :post-affiliated element))
23623 (line-end-position))
23626 (goto-char (org-element-property :end element))
23627 (skip-chars-backward " \r\t\n")
23628 (line-beginning-position))
23630 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23631 (beginning-of-line)
23632 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23637 (defvar comment-empty-lines) ; From newcomment.el.
23638 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23639 "Comment or uncomment each non-blank line in the region.
23640 Uncomment each non-blank line between BEG and END if it only
23641 contains commented lines. Otherwise, comment them. If region is
23642 strictly within a source block, use appropriate comment syntax."
23643 (if (let ((element (org-element-at-point)))
23644 (and (eq (org-element-type element) 'src-block)
23646 (goto-char (org-element-property :post-affiliated element))
23647 (line-end-position))
23649 (>= (save-excursion
23650 (goto-char (org-element-property :end element))
23651 (skip-chars-backward " \r\t\n")
23652 (line-beginning-position))
23654 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23657 (narrow-to-region (save-excursion (goto-char beg)
23658 (skip-chars-forward " \r\t\n" end)
23659 (line-beginning-position))
23660 (save-excursion (goto-char end)
23661 (skip-chars-backward " \r\t\n" beg)
23662 (line-end-position)))
23664 ;; UNCOMMENTP is non-nil when every non blank line between
23665 ;; BEG and END is a comment.
23667 (goto-char (point-min))
23668 (while (and (not (eobp))
23669 (let ((element (org-element-at-point)))
23670 (and (eq (org-element-type element) 'comment)
23671 (goto-char (min (point-max)
23672 (org-element-property
23673 :end element)))))))
23676 ;; Only blank lines and comments in region: uncomment it.
23678 (goto-char (point-min))
23679 (while (not (eobp))
23680 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23681 (replace-match "" nil nil nil 1))
23683 ;; Comment each line in region.
23684 (let ((min-indent (point-max)))
23685 ;; First find the minimum indentation across all lines.
23687 (goto-char (point-min))
23688 (while (and (not (eobp)) (not (zerop min-indent)))
23689 (unless (looking-at "[ \t]*$")
23690 (setq min-indent (min min-indent (current-indentation))))
23692 ;; Then loop over all lines.
23694 (goto-char (point-min))
23695 (while (not (eobp))
23696 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23697 ;; Don't get fooled by invisible text (e.g. link path)
23698 ;; when moving to column MIN-INDENT.
23699 (let ((buffer-invisibility-spec nil))
23700 (org-move-to-column min-indent t))
23701 (insert comment-start))
23702 (forward-line)))))))))
23704 (defun org-comment-dwim (arg)
23705 "Call `comment-dwim' within a source edit buffer if needed."
23707 (if (org-in-src-block-p)
23708 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23709 (call-interactively 'comment-dwim)))
23714 ;; This section contains tools to operate on timestamp objects, as
23715 ;; returned by, e.g. `org-element-context'.
23717 (defun org-timestamp--to-internal-time (timestamp &optional end)
23718 "Encode TIMESTAMP object into Emacs internal time.
23719 Use end of date range or time range when END is non-nil."
23720 (apply #'encode-time
23723 (lambda (prop) (or (org-element-property prop timestamp) 0))
23724 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23725 '(:minute-start :hour-start :day-start :month-start
23728 (defun org-timestamp-has-time-p (timestamp)
23729 "Non-nil when TIMESTAMP has a time specified."
23730 (org-element-property :hour-start timestamp))
23732 (defun org-timestamp-format (timestamp format &optional end utc)
23733 "Format a TIMESTAMP object into a string.
23735 FORMAT is a format specifier to be passed to
23736 `format-time-string'.
23738 When optional argument END is non-nil, use end of date-range or
23739 time-range, if possible.
23741 When optional argument UTC is non-nil, time will be expressed as
23743 (format-time-string
23744 format (org-timestamp--to-internal-time timestamp end) utc))
23746 (defun org-timestamp-split-range (timestamp &optional end)
23747 "Extract a TIMESTAMP object from a date or time range.
23749 END, when non-nil, means extract the end of the range.
23750 Otherwise, extract its start.
23752 Return a new timestamp object."
23753 (let ((type (org-element-property :type timestamp)))
23754 (if (memq type '(active inactive diary)) timestamp
23755 (let ((split-ts (org-element-copy timestamp)))
23757 (org-element-put-property
23758 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23759 ;; Copy start properties over end properties if END is
23760 ;; non-nil. Otherwise, copy end properties over `start' ones.
23761 (let ((p-alist '((:minute-start . :minute-end)
23762 (:hour-start . :hour-end)
23763 (:day-start . :day-end)
23764 (:month-start . :month-end)
23765 (:year-start . :year-end))))
23766 (dolist (p-cell p-alist)
23767 (org-element-put-property
23769 (funcall (if end #'car #'cdr) p-cell)
23770 (org-element-property
23771 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23772 ;; Eventually refresh `:raw-value'.
23773 (org-element-put-property split-ts :raw-value nil)
23774 (org-element-put-property
23775 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23777 (defun org-timestamp-translate (timestamp &optional boundary)
23778 "Translate TIMESTAMP object to custom format.
23780 Format string is defined in `org-time-stamp-custom-formats',
23783 When optional argument BOUNDARY is non-nil, it is either the
23784 symbol `start' or `end'. In this case, only translate the
23785 starting or ending part of TIMESTAMP if it is a date or time
23786 range. Otherwise, translate both parts.
23788 Return timestamp as-is if `org-display-custom-times' is nil or if
23789 it has a `diary' type."
23790 (let ((type (org-element-property :type timestamp)))
23791 (if (or (not org-display-custom-times) (eq type 'diary))
23792 (org-element-interpret-data timestamp)
23793 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23794 org-time-stamp-custom-formats)))
23795 (if (and (not boundary) (memq type '(active-range inactive-range)))
23796 (concat (org-timestamp-format timestamp fmt)
23798 (org-timestamp-format timestamp fmt t))
23799 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23805 (defun org-reftex-citation ()
23806 "Use reftex-citation to insert a citation into the buffer.
23807 This looks for a line like
23809 #+BIBLIOGRAPHY: foo plain option:-d
23811 and derives from it that foo.bib is the bibliography file relevant
23812 for this document. It then installs the necessary environment for RefTeX
23813 to work in this buffer and calls `reftex-citation' to insert a citation
23816 Export of such citations to both LaTeX and HTML is handled by the contributed
23817 package ox-bibtex by Taru Karttunen."
23819 (let ((reftex-docstruct-symbol 'rds)
23820 (reftex-cite-format "\\cite{%l}")
23825 (let ((case-fold-search t)
23826 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23827 (if (not (save-excursion
23828 (or (re-search-forward re nil t)
23829 (re-search-backward re nil t))))
23830 (user-error "No bibliography defined in file")
23831 (setq bib (concat (match-string 1) ".bib")
23832 rds (list (list 'bib bib)))))))
23833 (call-interactively 'reftex-citation)))
23835 ;;;; Functions extending outline functionality
23837 (defun org-beginning-of-line (&optional arg)
23838 "Go to the beginning of the current line. If that is invisible, continue
23839 to a visible line beginning. This makes the function of C-a more intuitive.
23840 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23841 first attempt, and only move to after the tags when the cursor is already
23842 beyond the end of the headline."
23844 (let ((pos (point))
23845 (special (if (consp org-special-ctrl-a/e)
23846 (car org-special-ctrl-a/e)
23847 org-special-ctrl-a/e))
23848 deactivate-mark refpos)
23849 (if (org-bound-and-true-p visual-line-mode)
23850 (beginning-of-visual-line 1)
23851 (beginning-of-line 1))
23852 (if (and arg (fboundp 'move-beginning-of-line))
23853 (call-interactively 'move-beginning-of-line)
23857 (if (org-truely-invisible-p)
23858 (while (and (not (bobp)) (org-truely-invisible-p))
23860 (beginning-of-line 1))
23861 (forward-char 1))))
23864 ((and (looking-at org-complex-heading-regexp)
23865 (eq (char-after (match-end 1)) ?\s))
23866 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23870 (cond ((> pos refpos) refpos)
23871 ((= pos (point)) refpos)
23873 (cond ((> pos (point)) (point))
23874 ((not (eq last-command this-command)) (point))
23877 ;; Being at an item and not looking at an the item means point
23878 ;; was previously moved to beginning of a visual line, which
23879 ;; doesn't contain the item. Therefore, do nothing special,
23881 (when (looking-at org-list-full-item-re)
23882 ;; Set special position at first white space character after
23883 ;; bullet, and check-box, if any.
23884 (let ((after-bullet
23885 (let ((box (match-end 3)))
23886 (if (not box) (match-end 1)
23887 (let ((after (char-after box)))
23888 (if (and after (= after ? )) (1+ box) box))))))
23889 ;; Special case: Move point to special position when
23890 ;; currently after it or at beginning of line.
23892 (when (or (> pos after-bullet) (= (point) pos))
23893 (goto-char after-bullet))
23894 ;; Reversed case: Move point to special position when
23895 ;; point was already at beginning of line and command is
23897 (when (and (= (point) pos) (eq last-command this-command))
23898 (goto-char after-bullet))))))))
23900 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23901 (setq disable-point-adjustment
23902 (or (not (invisible-p (point)))
23903 (not (invisible-p (max (point-min) (1- (point))))))))
23905 (defun org-end-of-line (&optional arg)
23906 "Go to the end of the line.
23907 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23908 tags on the first attempt, and only move to after the tags when
23909 the cursor is already beyond the end of the headline."
23911 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23912 org-special-ctrl-a/e))
23913 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23914 'end-of-visual-line)
23915 ((fboundp 'move-end-of-line) 'move-end-of-line)
23918 (if (or (not special) arg) (call-interactively move-fun)
23919 (let* ((element (save-excursion (beginning-of-line)
23920 (org-element-at-point)))
23921 (type (org-element-type element)))
23923 ((memq type '(headline inlinetask))
23924 (let ((pos (point)))
23925 (beginning-of-line 1)
23926 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23928 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23929 (goto-char (match-beginning 1))
23930 (goto-char (match-end 0)))
23931 (if (or (< pos (match-end 0))
23932 (not (eq this-command last-command)))
23933 (goto-char (match-end 0))
23934 (goto-char (match-beginning 1))))
23935 (call-interactively move-fun))))
23936 ((outline-invisible-p (line-end-position))
23937 ;; If element is hidden, `move-end-of-line' would put point
23938 ;; after it. Use `end-of-line' to stay on current line.
23939 (call-interactively 'end-of-line))
23940 (t (call-interactively move-fun)))))
23941 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23942 (setq disable-point-adjustment
23943 (or (not (invisible-p (point)))
23944 (not (invisible-p (max (point-min) (1- (point))))))))
23946 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23947 (define-key org-mode-map "\C-e" 'org-end-of-line)
23949 (defun org-backward-sentence (&optional arg)
23950 "Go to beginning of sentence, or beginning of table field.
23951 This will call `backward-sentence' or `org-table-beginning-of-field',
23952 depending on context."
23954 (let* ((element (org-element-at-point))
23955 (contents-begin (org-element-property :contents-begin element))
23956 (table (org-element-lineage element '(table) t)))
23958 (> (point) contents-begin)
23959 (<= (point) (org-element-property :contents-end table)))
23960 (call-interactively #'org-table-beginning-of-field)
23962 (when (and contents-begin
23963 (< (point-min) contents-begin)
23964 (> (point) contents-begin))
23965 (narrow-to-region contents-begin
23966 (org-element-property :contents-end element)))
23967 (call-interactively #'backward-sentence)))))
23969 (defun org-forward-sentence (&optional arg)
23970 "Go to end of sentence, or end of table field.
23971 This will call `forward-sentence' or `org-table-end-of-field',
23972 depending on context."
23974 (let* ((element (org-element-at-point))
23975 (contents-end (org-element-property :contents-end element))
23976 (table (org-element-lineage element '(table) t)))
23978 (>= (point) (org-element-property :contents-begin table))
23979 (< (point) contents-end))
23980 (call-interactively #'org-table-end-of-field)
23982 (when (and contents-end
23983 (> (point-max) contents-end)
23984 ;; Skip blank lines between elements.
23985 (< (org-element-property :end element)
23986 (save-excursion (goto-char contents-end)
23987 (skip-chars-forward " \r\t\n"))))
23988 (narrow-to-region (org-element-property :contents-begin element)
23990 (call-interactively #'forward-sentence)))))
23992 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23993 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23995 (defun org-kill-line (&optional arg)
23996 "Kill line, to tags or end of line."
23999 ((or (not org-special-ctrl-k)
24001 (not (org-at-heading-p)))
24002 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
24003 org-ctrl-k-protect-subtree)
24004 (if (or (eq org-ctrl-k-protect-subtree 'error)
24005 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
24006 (user-error "C-k aborted as it would kill a hidden subtree")))
24007 (call-interactively
24008 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
24009 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
24010 (kill-region (point) (match-beginning 1))
24011 (org-set-tags nil t))
24012 (t (kill-region (point) (point-at-eol)))))
24014 (define-key org-mode-map "\C-k" 'org-kill-line)
24016 (defun org-yank (&optional arg)
24017 "Yank. If the kill is a subtree, treat it specially.
24018 This command will look at the current kill and check if is a single
24019 subtree, or a series of subtrees[1]. If it passes the test, and if the
24020 cursor is at the beginning of a line or after the stars of a currently
24021 empty headline, then the yank is handled specially. How exactly depends
24022 on the value of the following variables, both set by default.
24024 `org-yank-folded-subtrees'
24025 When set, the subtree(s) will be folded after insertion, but only
24026 if doing so would now swallow text after the yanked text.
24028 `org-yank-adjusted-subtrees'
24029 When set, the subtree will be promoted or demoted in order to
24030 fit into the local outline tree structure, which means that the
24031 level will be adjusted so that it becomes the smaller one of the
24032 two *visible* surrounding headings.
24034 Any prefix to this command will cause `yank' to be called directly with
24035 no special treatment. In particular, a simple \\[universal-argument] prefix \
24037 plainly yank the text as it is.
24039 \[1] The test checks if the first non-white line is a heading
24040 and if there are no other headings with fewer stars."
24042 (org-yank-generic 'yank arg))
24044 (defun org-yank-generic (command arg)
24045 "Perform some yank-like command.
24047 This function implements the behavior described in the `org-yank'
24048 documentation. However, it has been generalized to work for any
24049 interactive command with similar behavior."
24051 ;; pretend to be command COMMAND
24052 (setq this-command command)
24055 (call-interactively command)
24057 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24058 (and (org-kill-is-subtree-p)
24060 (and (looking-at "[ \t]*$")
24063 (buffer-substring (point-at-bol) (point)))))))
24066 ((and subtreep org-yank-folded-subtrees)
24067 (let ((beg (point))
24069 (if (and subtreep org-yank-adjusted-subtrees)
24070 (org-paste-subtree nil nil 'for-yank)
24071 (call-interactively command))
24075 (when (and (bolp) subtreep
24076 (not (setq swallowp
24077 (org-yank-folding-would-swallow-text beg end))))
24078 (org-with-limited-levels
24079 (or (looking-at org-outline-regexp)
24080 (re-search-forward org-outline-regexp-bol end t))
24081 (while (and (< (point) end) (looking-at org-outline-regexp))
24083 (org-cycle-show-empty-lines 'folded)
24084 (condition-case nil
24085 (outline-forward-same-level 1)
24086 (error (goto-char end))))))
24089 "Inserted text not folded because that would swallow text"))
24092 (skip-chars-forward " \t\n\r")
24093 (beginning-of-line 1)
24094 (push-mark beg 'nomsg)))
24095 ((and subtreep org-yank-adjusted-subtrees)
24096 (let ((beg (point-at-bol)))
24097 (org-paste-subtree nil nil 'for-yank)
24098 (push-mark beg 'nomsg)))
24100 (call-interactively command))))))
24102 (defun org-yank-folding-would-swallow-text (beg end)
24103 "Would hide-subtree at BEG swallow any text after END?"
24105 (org-with-limited-levels
24108 (when (or (looking-at org-outline-regexp)
24109 (re-search-forward org-outline-regexp-bol end t))
24110 (setq level (org-outline-level)))
24112 (skip-chars-forward " \t\r\n\v\f")
24114 (and (bolp) (looking-at org-outline-regexp)
24115 (<= (org-outline-level) level)))
24116 nil ; Nothing would be swallowed
24117 t))))) ; something would swallow
24119 (define-key org-mode-map "\C-y" 'org-yank)
24121 (defun org-truely-invisible-p ()
24122 "Check if point is at a character currently not visible.
24123 This version does not only check the character property, but also
24125 ;; Early versions of noutline don't have `outline-invisible-p'.
24126 (if (org-bound-and-true-p visible-mode)
24128 (outline-invisible-p)))
24130 (defun org-invisible-p2 ()
24131 "Check if point is at a character currently not visible."
24133 (if (and (eolp) (not (bobp))) (backward-char 1))
24134 ;; Early versions of noutline don't have `outline-invisible-p'.
24135 (outline-invisible-p)))
24137 (defun org-back-to-heading (&optional invisible-ok)
24138 "Call `outline-back-to-heading', but provide a better error message."
24139 (condition-case nil
24140 (outline-back-to-heading invisible-ok)
24141 (error (error "Before first headline at position %d in buffer %s"
24142 (point) (current-buffer)))))
24144 (defun org-before-first-heading-p ()
24145 "Before first heading?"
24148 (null (re-search-backward org-outline-regexp-bol nil t))))
24150 (defun org-at-heading-p (&optional ignored)
24151 (outline-on-heading-p t))
24152 ;; Compatibility alias with Org versions < 7.8.03
24153 (defalias 'org-on-heading-p 'org-at-heading-p)
24155 (defun org-in-commented-heading-p (&optional no-inheritance)
24156 "Non-nil if point is under a commented heading.
24157 This function also checks ancestors of the current headline,
24158 unless optional argument NO-INHERITANCE is non-nil."
24160 ((org-before-first-heading-p) nil)
24161 ((let ((headline (nth 4 (org-heading-components))))
24163 (let ((case-fold-search nil))
24164 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24166 (no-inheritance nil)
24168 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24170 (defun org-at-comment-p nil
24171 "Is cursor in a commented line?"
24174 (beginning-of-line)
24175 (looking-at "^[ \t]*# "))))
24177 (defun org-at-drawer-p nil
24178 "Is cursor at a drawer keyword?"
24180 (move-beginning-of-line 1)
24181 (looking-at org-drawer-regexp)))
24183 (defun org-at-block-p nil
24184 "Is cursor at a block keyword?"
24186 (move-beginning-of-line 1)
24187 (looking-at org-block-regexp)))
24189 (defun org-point-at-end-of-empty-headline ()
24190 "If point is at the end of an empty headline, return t, else nil.
24191 If the heading only contains a TODO keyword, it is still still considered
24193 (and (looking-at "[ \t]*$")
24194 (when org-todo-line-regexp
24196 (beginning-of-line 1)
24197 (let ((case-fold-search nil))
24198 (looking-at org-todo-line-regexp)
24199 (string= (match-string 3) ""))))))
24201 (defun org-at-heading-or-item-p ()
24202 (or (org-at-heading-p) (org-at-item-p)))
24204 (defun org-at-target-p ()
24205 (or (org-in-regexp org-radio-target-regexp)
24206 (org-in-regexp org-target-regexp)))
24207 ;; Compatibility alias with Org versions < 7.8.03
24208 (defalias 'org-on-target-p 'org-at-target-p)
24210 (defun org-up-heading-all (arg)
24211 "Move to the heading line of which the present line is a subheading.
24212 This function considers both visible and invisible heading lines.
24213 With argument, move up ARG levels."
24214 (if (fboundp 'outline-up-heading-all)
24215 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24216 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24218 (defun org-up-heading-safe ()
24219 "Move to the heading line of which the present line is a subheading.
24220 This version will not throw an error. It will return the level of the
24221 headline found, or nil if no higher level is found.
24223 Also, this function will be a lot faster than `outline-up-heading',
24224 because it relies on stars being the outline starters. This can really
24225 make a significant difference in outlines with very many siblings."
24226 (when (ignore-errors (org-back-to-heading t))
24227 (let ((level-up (1- (funcall outline-level))))
24228 (and (> level-up 0)
24229 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24230 (funcall outline-level)))))
24232 (defun org-first-sibling-p ()
24233 "Is this heading the first child of its parents?"
24235 (let ((re org-outline-regexp-bol)
24237 (unless (org-at-heading-p t)
24238 (user-error "Not at a heading"))
24239 (setq level (funcall outline-level))
24241 (if (not (re-search-backward re nil t))
24243 (setq l (funcall outline-level))
24246 (defun org-goto-sibling (&optional previous)
24247 "Goto the next sibling, even if it is invisible.
24248 When PREVIOUS is set, go to the previous sibling instead. Returns t
24249 when a sibling was found. When none is found, return nil and don't
24251 (let ((fun (if previous 're-search-backward 're-search-forward))
24253 (re org-outline-regexp-bol)
24255 (when (ignore-errors (org-back-to-heading t))
24256 (setq level (funcall outline-level))
24258 (or previous (forward-char 1))
24259 (while (funcall fun re nil t)
24260 (setq l (funcall outline-level))
24261 (when (< l level) (goto-char pos) (throw 'exit nil))
24262 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24266 (defun org-show-siblings ()
24267 "Show all siblings of the current headline."
24269 (while (org-goto-sibling) (org-flag-heading nil)))
24271 (while (org-goto-sibling 'previous)
24272 (org-flag-heading nil))))
24274 (defun org-goto-first-child ()
24275 "Goto the first child, even if it is invisible.
24276 Return t when a child was found. Otherwise don't move point and
24278 (let (level (pos (point)) (re org-outline-regexp-bol))
24279 (when (ignore-errors (org-back-to-heading t))
24280 (setq level (outline-level))
24282 (if (and (re-search-forward re nil t) (> (outline-level) level))
24283 (progn (goto-char (match-beginning 0)) t)
24284 (goto-char pos) nil))))
24286 (defun org-show-hidden-entry ()
24287 "Show an entry where even the heading is hidden."
24291 (defun org-flag-heading (flag &optional entry)
24292 "Flag the current heading. FLAG non-nil means make invisible.
24293 When ENTRY is non-nil, show the entire entry."
24295 (org-back-to-heading t)
24296 ;; Check if we should show the entire entry
24301 (and (outline-next-heading)
24302 (org-flag-heading nil))))
24303 (outline-flag-region (max (point-min) (1- (point)))
24304 (save-excursion (outline-end-of-heading) (point))
24307 (defun org-get-next-sibling ()
24308 "Move to next heading of the same level, and return point.
24309 If there is no such heading, return nil.
24310 This is like outline-next-sibling, but invisible headings are ok."
24311 (let ((level (funcall outline-level)))
24312 (outline-next-heading)
24313 (while (and (not (eobp)) (> (funcall outline-level) level))
24314 (outline-next-heading))
24315 (if (or (eobp) (< (funcall outline-level) level))
24319 (defun org-get-last-sibling ()
24320 "Move to previous heading of the same level, and return point.
24321 If there is no such heading, return nil."
24322 (let ((opoint (point))
24323 (level (funcall outline-level)))
24324 (outline-previous-heading)
24325 (when (and (/= (point) opoint) (outline-on-heading-p t))
24326 (while (and (> (funcall outline-level) level)
24328 (outline-previous-heading))
24329 (if (< (funcall outline-level) level)
24333 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24334 "Goto to the end of a subtree."
24335 ;; This contains an exact copy of the original function, but it uses
24336 ;; `org-back-to-heading', to make it work also in invisible
24337 ;; trees. And is uses an invisible-ok argument.
24338 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24339 ;; Furthermore, when used inside Org, finding the end of a large subtree
24340 ;; with many children and grandchildren etc, this can be much faster
24341 ;; than the outline version.
24342 (org-back-to-heading invisible-ok)
24344 (level (funcall outline-level)))
24345 (if (and (derived-mode-p 'org-mode) (< level 1000))
24346 ;; A true heading (not a plain list item), in Org-mode
24347 ;; This means we can easily find the end by looking
24348 ;; only for the right number of stars. Using a regexp to do
24349 ;; this is so much faster than using a Lisp loop.
24350 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24352 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24353 ;; something else, do it the slow way
24354 (while (and (not (eobp))
24355 (or first (> (funcall outline-level) level)))
24357 (outline-next-heading)))
24359 (if (memq (preceding-char) '(?\n ?\^M))
24361 ;; Go to end of line before heading
24363 (if (memq (preceding-char) '(?\n ?\^M))
24364 ;; leave blank line before heading
24365 (forward-char -1))))))
24368 (defun org-end-of-meta-data (&optional full)
24369 "Skip planning line and properties drawer in current entry.
24370 When optional argument FULL is non-nil, also skip empty lines,
24371 clocking lines and regular drawers at the beginning of the
24373 (org-back-to-heading t)
24375 (when (org-looking-at-p org-planning-line-re) (forward-line))
24376 (when (looking-at org-property-drawer-re)
24377 (goto-char (match-end 0))
24379 (when (and full (not (org-at-heading-p)))
24381 (let ((end (save-excursion (outline-next-heading) (point)))
24382 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24383 (while (not (eobp))
24384 (cond ((org-looking-at-p org-drawer-regexp)
24385 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24388 ((org-looking-at-p re) (forward-line))
24389 (t (throw 'exit t))))))))
24391 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24392 "Move forward to the ARG'th subheading at same level as this one.
24393 Stop at the first and last subheadings of a superior heading.
24394 Normally this only looks at visible headings, but when INVISIBLE-OK is
24395 non-nil it will also look at invisible ones."
24397 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24398 (if (and arg (< arg 0))
24399 (goto-char (point-min))
24400 (outline-next-heading))
24402 (let ((level (- (match-end 0) (match-beginning 0) 1))
24403 (f (if (and arg (< arg 0))
24404 're-search-backward
24405 're-search-forward))
24406 (count (if arg (abs arg) 1))
24408 (while (and (prog1 (> count 0)
24409 (forward-char (if (and arg (< arg 0)) -1 1)))
24410 (funcall f org-outline-regexp-bol nil 'move))
24411 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24412 (cond ((< l level) (setq count 0))
24416 (goto-char (line-beginning-position))
24417 (not (outline-invisible-p)))))
24418 (setq count (1- count))
24420 (setq result (point)))))))
24421 (goto-char result))
24422 (beginning-of-line 1)))
24424 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24425 "Move backward to the ARG'th subheading at same level as this one.
24426 Stop at the first and last subheadings of a superior heading."
24428 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24430 (defun org-next-visible-heading (arg)
24431 "Move to the next visible heading.
24433 This function wraps `outline-next-visible-heading' with
24434 `org-with-limited-levels' in order to skip over inline tasks and
24435 respect customization of `org-odd-levels-only'."
24437 (org-with-limited-levels
24438 (outline-next-visible-heading arg)))
24440 (defun org-previous-visible-heading (arg)
24441 "Move to the next visible heading.
24443 This function wraps `outline-previous-visible-heading' with
24444 `org-with-limited-levels' in order to skip over inline tasks and
24445 respect customization of `org-odd-levels-only'."
24447 (org-with-limited-levels
24448 (outline-previous-visible-heading arg)))
24450 (defun org-next-block (arg &optional backward block-regexp)
24451 "Jump to the next block.
24453 With a prefix argument ARG, jump forward ARG many blocks.
24455 When BACKWARD is non-nil, jump to the previous block.
24457 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24458 Match data is set according to this regexp when the function
24461 Return point at beginning of the opening line of found block.
24462 Throw an error if no block is found."
24464 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24465 (case-fold-search t)
24466 (search-fn (if backward #'re-search-backward #'re-search-forward))
24470 (if backward (beginning-of-line) (end-of-line))
24471 (while (and (> count 0) (funcall search-fn re nil t))
24472 (let ((element (save-excursion
24473 (goto-char (match-beginning 0))
24474 (save-match-data (org-element-at-point)))))
24475 (when (and (memq (org-element-type element)
24476 '(center-block comment-block dynamic-block
24477 example-block export-block quote-block
24478 special-block src-block verse-block))
24479 (<= (match-beginning 0)
24480 (org-element-property :post-affiliated element)))
24481 (setq last-element element)
24484 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24485 (save-match-data (org-show-context)))
24487 (user-error "No %s code blocks" (if backward "previous" "further")))))
24489 (defun org-previous-block (arg &optional block-regexp)
24490 "Jump to the previous block.
24491 With a prefix argument ARG, jump backward ARG many source blocks.
24492 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24494 (org-next-block arg t block-regexp))
24496 (defun org-forward-paragraph ()
24497 "Move forward to beginning of next paragraph or equivalent.
24499 The function moves point to the beginning of the next visible
24500 structural element, which can be a paragraph, a table, a list
24501 item, etc. It also provides some special moves for convenience:
24503 - On an affiliated keyword, jump to the beginning of the
24505 - On an item or a footnote definition, move to the second
24506 element inside, if any.
24507 - On a table or a property drawer, jump after it.
24508 - On a verse or source block, stop after blank lines."
24510 (when (eobp) (user-error "Cannot move further down"))
24511 (let* ((deactivate-mark nil)
24512 (element (org-element-at-point))
24513 (type (org-element-type element))
24514 (post-affiliated (org-element-property :post-affiliated element))
24515 (contents-begin (org-element-property :contents-begin element))
24516 (contents-end (org-element-property :contents-end element))
24517 (end (let ((end (org-element-property :end element)) (parent element))
24518 (while (and (setq parent (org-element-property :parent parent))
24519 (= (org-element-property :contents-end parent) end))
24520 (setq end (org-element-property :end parent)))
24522 (cond ((not element)
24523 (skip-chars-forward " \r\t\n")
24524 (or (eobp) (beginning-of-line)))
24525 ;; On affiliated keywords, move to element's beginning.
24526 ((< (point) post-affiliated)
24527 (goto-char post-affiliated))
24528 ;; At a table row, move to the end of the table. Similarly,
24529 ;; at a node property, move to the end of the property
24531 ((memq type '(node-property table-row))
24532 (goto-char (org-element-property
24533 :end (org-element-property :parent element))))
24534 ((memq type '(property-drawer table)) (goto-char end))
24535 ;; Consider blank lines as separators in verse and source
24536 ;; blocks to ease editing.
24537 ((memq type '(src-block verse-block))
24538 (when (eq type 'src-block)
24540 (save-excursion (goto-char end)
24541 (skip-chars-backward " \r\t\n")
24542 (line-beginning-position))))
24543 (beginning-of-line)
24544 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24545 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24547 (skip-chars-forward " \r\t\n")
24548 (if (= (point) contents-end) (goto-char end)
24549 (beginning-of-line))))
24550 ;; With no contents, just skip element.
24551 ((not contents-begin) (goto-char end))
24552 ;; If contents are invisible, skip the element altogether.
24553 ((outline-invisible-p (line-end-position))
24556 (org-with-limited-levels (outline-next-visible-heading 1)))
24557 ;; At a plain list, make sure we move to the next item
24558 ;; instead of skipping the whole list.
24559 (plain-list (forward-char)
24560 (org-forward-paragraph))
24561 (otherwise (goto-char end))))
24562 ((>= (point) contents-end) (goto-char end))
24563 ((>= (point) contents-begin)
24564 ;; This can only happen on paragraphs and plain lists.
24566 (paragraph (goto-char end))
24567 ;; At a plain list, try to move to second element in
24568 ;; first item, if possible.
24569 (plain-list (end-of-line)
24570 (org-forward-paragraph))))
24571 ;; When contents start on the middle of a line (e.g. in
24572 ;; items and footnote definitions), try to reach first
24573 ;; element starting after current line.
24574 ((> (line-end-position) contents-begin)
24576 (org-forward-paragraph))
24577 (t (goto-char contents-begin)))))
24579 (defun org-backward-paragraph ()
24580 "Move backward to start of previous paragraph or equivalent.
24582 The function moves point to the beginning of the current
24583 structural element, which can be a paragraph, a table, a list
24584 item, etc., or to the beginning of the previous visible one if
24585 point is already there. It also provides some special moves for
24588 - On an affiliated keyword, jump to the first one.
24589 - On a table or a property drawer, move to its beginning.
24590 - On a verse or source block, stop before blank lines."
24592 (when (bobp) (user-error "Cannot move further up"))
24593 (let* ((deactivate-mark nil)
24594 (element (org-element-at-point))
24595 (type (org-element-type element))
24596 (contents-begin (org-element-property :contents-begin element))
24597 (contents-end (org-element-property :contents-end element))
24598 (post-affiliated (org-element-property :post-affiliated element))
24599 (begin (org-element-property :begin element)))
24601 ((not element) (goto-char (point-min)))
24604 (org-backward-paragraph))
24605 ((<= (point) post-affiliated) (goto-char begin))
24606 ((memq type '(node-property table-row))
24607 (goto-char (org-element-property
24608 :post-affiliated (org-element-property :parent element))))
24609 ((memq type '(property-drawer table)) (goto-char begin))
24610 ((memq type '(src-block verse-block))
24611 (when (eq type 'src-block)
24612 (setq contents-begin
24613 (save-excursion (goto-char begin) (forward-line) (point))))
24614 (if (= (point) contents-begin) (goto-char post-affiliated)
24615 ;; Inside a verse block, see blank lines as paragraph
24617 (let ((origin (point)))
24618 (skip-chars-backward " \r\t\n" contents-begin)
24619 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24620 (skip-chars-forward " \r\t\n" origin)
24621 (if (= (point) origin) (goto-char contents-begin)
24622 (beginning-of-line))))))
24623 ((not contents-begin) (goto-char (or post-affiliated begin)))
24624 ((eq type 'paragraph)
24625 (goto-char contents-begin)
24626 ;; When at first paragraph in an item or a footnote definition,
24627 ;; move directly to beginning of line.
24628 (let ((parent-contents
24629 (org-element-property
24630 :contents-begin (org-element-property :parent element))))
24631 (when (and parent-contents (= parent-contents contents-begin))
24632 (beginning-of-line))))
24633 ;; At the end of a greater element, move to the beginning of the
24634 ;; last element within.
24635 ((>= (point) contents-end)
24636 (goto-char (1- contents-end))
24637 (org-backward-paragraph))
24638 (t (goto-char (or post-affiliated begin))))
24639 ;; Ensure we never leave point invisible.
24640 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24642 (defun org-forward-element ()
24643 "Move forward by one element.
24644 Move to the next element at the same level, when possible."
24646 (cond ((eobp) (user-error "Cannot move further down"))
24647 ((org-with-limited-levels (org-at-heading-p))
24648 (let ((origin (point)))
24649 (goto-char (org-end-of-subtree nil t))
24650 (unless (org-with-limited-levels (org-at-heading-p))
24652 (user-error "Cannot move further down"))))
24654 (let* ((elem (org-element-at-point))
24655 (end (org-element-property :end elem))
24656 (parent (org-element-property :parent elem)))
24657 (cond ((and parent (= (org-element-property :contents-end parent) end))
24658 (goto-char (org-element-property :end parent)))
24659 ((integer-or-marker-p end) (goto-char end))
24660 (t (message "No element at point")))))))
24662 (defun org-backward-element ()
24663 "Move backward by one element.
24664 Move to the previous element at the same level, when possible."
24666 (cond ((bobp) (user-error "Cannot move further up"))
24667 ((org-with-limited-levels (org-at-heading-p))
24668 ;; At a headline, move to the previous one, if any, or stay
24670 (let ((origin (point)))
24671 (org-with-limited-levels (org-backward-heading-same-level 1))
24672 ;; When current headline has no sibling above, move to its
24674 (when (= (point) origin)
24675 (or (org-with-limited-levels (org-up-heading-safe))
24676 (progn (goto-char origin)
24677 (user-error "Cannot move further up"))))))
24679 (let* ((elem (org-element-at-point))
24680 (beg (org-element-property :begin elem)))
24682 ;; Move to beginning of current element if point isn't
24684 ((null beg) (message "No element at point"))
24685 ((/= (point) beg) (goto-char beg))
24687 (skip-chars-backward " \r\t\n")
24689 (let ((prev (org-element-at-point)))
24690 (goto-char (org-element-property :begin prev))
24691 (while (and (setq prev (org-element-property :parent prev))
24692 (<= (org-element-property :end prev) beg))
24693 (goto-char (org-element-property :begin prev)))))))))))
24695 (defun org-up-element ()
24696 "Move to upper element."
24698 (if (org-with-limited-levels (org-at-heading-p))
24699 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24700 (let* ((elem (org-element-at-point))
24701 (parent (org-element-property :parent elem)))
24702 (if parent (goto-char (org-element-property :begin parent))
24703 (if (org-with-limited-levels (org-before-first-heading-p))
24704 (user-error "No surrounding element")
24705 (org-with-limited-levels (org-back-to-heading)))))))
24707 (defvar org-element-greater-elements)
24708 (defun org-down-element ()
24709 "Move to inner element."
24711 (let ((element (org-element-at-point)))
24713 ((memq (org-element-type element) '(plain-list table))
24714 (goto-char (org-element-property :contents-begin element))
24716 ((memq (org-element-type element) org-element-greater-elements)
24717 ;; If contents are hidden, first disclose them.
24718 (when (outline-invisible-p (line-end-position)) (org-cycle))
24719 (goto-char (or (org-element-property :contents-begin element)
24720 (user-error "No content for this element"))))
24721 (t (user-error "No inner element")))))
24723 (defun org-drag-element-backward ()
24724 "Move backward element at point."
24726 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24727 (let* ((elem (org-element-at-point))
24730 (goto-char (org-element-property :begin elem))
24731 (skip-chars-backward " \r\t\n")
24733 (let* ((beg (org-element-property :begin elem))
24734 (prev (org-element-at-point))
24736 (while (and (setq up (org-element-property :parent up))
24737 (<= (org-element-property :end up) beg))
24740 ;; Error out if no previous element or previous element is
24741 ;; a parent of the current one.
24742 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24743 (user-error "Cannot drag element backward")
24744 (let ((pos (point)))
24745 (org-element-swap-A-B prev-elem elem)
24746 (goto-char (+ (org-element-property :begin prev-elem)
24747 (- pos (org-element-property :begin elem)))))))))
24749 (defun org-drag-element-forward ()
24750 "Move forward element at point."
24752 (let* ((pos (point))
24753 (elem (org-element-at-point)))
24754 (when (= (point-max) (org-element-property :end elem))
24755 (user-error "Cannot drag element forward"))
24756 (goto-char (org-element-property :end elem))
24757 (let ((next-elem (org-element-at-point)))
24758 (when (or (org-element-nested-p elem next-elem)
24759 (and (eq (org-element-type next-elem) 'headline)
24760 (not (eq (org-element-type elem) 'headline))))
24762 (user-error "Cannot drag element forward"))
24763 ;; Compute new position of point: it's shifted by NEXT-ELEM
24764 ;; body's length (without final blanks) and by the length of
24765 ;; blanks between ELEM and NEXT-ELEM.
24766 (let ((size-next (- (save-excursion
24767 (goto-char (org-element-property :end next-elem))
24768 (skip-chars-backward " \r\t\n")
24770 ;; Small correction if buffer doesn't end
24771 ;; with a newline character.
24772 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24773 (org-element-property :begin next-elem)))
24774 (size-blank (- (org-element-property :end elem)
24776 (goto-char (org-element-property :end elem))
24777 (skip-chars-backward " \r\t\n")
24780 (org-element-swap-A-B elem next-elem)
24781 (goto-char (+ pos size-next size-blank))))))
24783 (defun org-drag-line-forward (arg)
24784 "Drag the line at point ARG lines forward."
24786 (dotimes (n (abs arg))
24787 (let ((c (current-column)))
24790 (beginning-of-line 2)
24791 (transpose-lines 1)
24792 (beginning-of-line 0))
24793 (transpose-lines 1)
24794 (beginning-of-line -1))
24795 (org-move-to-column c))))
24797 (defun org-drag-line-backward (arg)
24798 "Drag the line at point ARG lines backward."
24800 (org-drag-line-forward (- arg)))
24802 (defun org-mark-element ()
24803 "Put point at beginning of this element, mark at end.
24805 Interactively, if this command is repeated or (in Transient Mark
24806 mode) if the mark is active, it marks the next element after the
24807 ones already marked."
24809 (let (deactivate-mark)
24810 (if (and (org-called-interactively-p 'any)
24811 (or (and (eq last-command this-command) (mark t))
24812 (and transient-mark-mode mark-active)))
24816 (goto-char (org-element-property :end (org-element-at-point)))))
24817 (let ((element (org-element-at-point)))
24819 (push-mark (org-element-property :end element) t t)
24820 (goto-char (org-element-property :begin element))))))
24822 (defun org-narrow-to-element ()
24823 "Narrow buffer to current element."
24825 (let ((elem (org-element-at-point)))
24827 ((eq (car elem) 'headline)
24829 (org-element-property :begin elem)
24830 (org-element-property :end elem)))
24831 ((memq (car elem) org-element-greater-elements)
24833 (org-element-property :contents-begin elem)
24834 (org-element-property :contents-end elem)))
24837 (org-element-property :begin elem)
24838 (org-element-property :end elem))))))
24840 (defun org-transpose-element ()
24841 "Transpose current and previous elements, keeping blank lines between.
24842 Point is moved after both elements."
24844 (org-skip-whitespace)
24845 (let ((end (org-element-property :end (org-element-at-point))))
24846 (org-drag-element-backward)
24849 (defun org-unindent-buffer ()
24850 "Un-indent the visible part of the buffer.
24851 Relative indentation (between items, inside blocks, etc.) isn't
24854 (unless (eq major-mode 'org-mode)
24855 (user-error "Cannot un-indent a buffer not in Org mode"))
24856 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24857 unindent-tree ; For byte-compiler.
24863 (if (memq (org-element-type element) '(headline section))
24864 (funcall unindent-tree (org-element-contents element))
24868 (org-element-property :begin element)
24869 (org-element-property :end element))
24870 (org-do-remove-indentation)))))
24871 (reverse contents))))))
24872 (funcall unindent-tree (org-element-contents parse-tree))))
24874 (defun org-show-subtree ()
24875 "Show everything after this heading at deeper levels."
24877 (outline-flag-region
24880 (org-end-of-subtree t t))
24883 (defun org-show-entry ()
24884 "Show the body directly following this heading.
24885 Show the heading too, if it is currently invisible."
24889 (org-back-to-heading t)
24890 (outline-flag-region
24891 (max (point-min) (1- (point)))
24893 (if (re-search-forward
24894 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24895 (match-beginning 1)
24898 (org-cycle-hide-drawers 'children))))
24900 (defun org-make-options-regexp (kwds &optional extra)
24901 "Make a regular expression for keyword lines.
24902 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24903 when non-nil, is a regexp matching keywords names."
24904 (concat "^[ \t]*#\\+\\("
24906 (and extra (concat (and kwds "\\|") extra))
24907 "\\):[ \t]*\\(.*\\)"))
24909 ;; Make isearch reveal the necessary context
24910 (defun org-isearch-end ()
24911 "Reveal context after isearch exits."
24912 (when isearch-success ; only if search was successful
24913 (if (featurep 'xemacs)
24914 ;; Under XEmacs, the hook is run in the correct place,
24915 ;; we directly show the context.
24916 (org-show-context 'isearch)
24917 ;; In Emacs the hook runs *before* restoring the overlays.
24918 ;; So we have to use a one-time post-command-hook to do this.
24919 ;; (Emacs 22 has a special variable, see function `org-mode')
24920 (unless (and (boundp 'isearch-mode-end-hook-quit)
24921 isearch-mode-end-hook-quit)
24922 ;; Only when the isearch was not quitted.
24923 (org-add-hook 'post-command-hook 'org-isearch-post-command
24924 'append 'local)))))
24926 (defun org-isearch-post-command ()
24927 "Remove self from hook, and show context."
24928 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24929 (org-show-context 'isearch))
24932 ;;;; Integration with and fixes for other packages
24936 (defvar org-imenu-markers nil
24937 "All markers currently used by Imenu.")
24938 (make-variable-buffer-local 'org-imenu-markers)
24940 (defun org-imenu-new-marker (&optional pos)
24941 "Return a new marker for use by Imenu, and remember the marker."
24942 (let ((m (make-marker)))
24943 (move-marker m (or pos (point)))
24944 (push m org-imenu-markers)
24947 (defun org-imenu-get-tree ()
24948 "Produce the index for Imenu."
24949 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24950 (setq org-imenu-markers nil)
24951 (let* ((n org-imenu-depth)
24952 (re (concat "^" (org-get-limited-outline-regexp)))
24953 (subs (make-vector (1+ n) nil))
24955 m level head0 head)
24959 (goto-char (point-max))
24960 (while (re-search-backward re nil t)
24961 (setq level (org-reduced-level (funcall outline-level)))
24962 (when (and (<= level n)
24963 (looking-at org-complex-heading-regexp)
24964 (setq head0 (org-match-string-no-properties 4)))
24965 (setq head (org-link-display-format head0)
24966 m (org-imenu-new-marker))
24967 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24968 (if (>= level last-level)
24969 (push (cons head m) (aref subs level))
24970 (push (cons head (aref subs (1+ level))) (aref subs level))
24971 (loop for i from (1+ level) to n do (aset subs i nil)))
24972 (setq last-level level)))))
24975 (eval-after-load "imenu"
24977 (add-hook 'imenu-after-jump-hook
24979 (if (derived-mode-p 'org-mode)
24980 (org-show-context 'org-goto))))))
24982 (defun org-link-display-format (link)
24983 "Replace a link with its the description.
24984 If there is no description, use the link target."
24986 (if (string-match org-bracket-link-analytic-regexp link)
24987 (replace-match (if (match-end 5)
24988 (match-string 5 link)
24989 (concat (match-string 1 link)
24990 (match-string 3 link)))
24994 (defun org-toggle-link-display ()
24995 "Toggle the literal or descriptive display of links."
24997 (if org-descriptive-links
24998 (progn (org-remove-from-invisibility-spec '(org-link))
24999 (org-restart-font-lock)
25000 (setq org-descriptive-links nil))
25001 (progn (add-to-invisibility-spec '(org-link))
25002 (org-restart-font-lock)
25003 (setq org-descriptive-links t))))
25005 ;; Speedbar support
25007 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
25008 "Overlay marking the agenda restriction line in speedbar.")
25009 (overlay-put org-speedbar-restriction-lock-overlay
25010 'face 'org-agenda-restriction-lock)
25011 (overlay-put org-speedbar-restriction-lock-overlay
25012 'help-echo "Agendas are currently limited to this item.")
25013 (org-detach-overlay org-speedbar-restriction-lock-overlay)
25015 (defun org-speedbar-set-agenda-restriction ()
25016 "Restrict future agenda commands to the location at point in speedbar.
25017 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
25019 (require 'org-agenda)
25020 (let (p m tp np dir txt)
25022 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25024 (setq m (get-text-property p 'org-imenu-marker))
25025 (with-current-buffer (marker-buffer m)
25027 (org-agenda-set-restriction-lock 'subtree)))
25028 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25029 'speedbar-function 'speedbar-find-file))
25030 (setq tp (previous-single-property-change
25031 (1+ p) 'speedbar-function)
25032 np (next-single-property-change
25033 tp 'speedbar-function)
25034 dir (speedbar-line-directory)
25035 txt (buffer-substring-no-properties (or tp (point-min))
25036 (or np (point-max))))
25037 (with-current-buffer (find-file-noselect
25038 (let ((default-directory dir))
25039 (expand-file-name txt)))
25040 (unless (derived-mode-p 'org-mode)
25041 (user-error "Cannot restrict to non-Org-mode file"))
25042 (org-agenda-set-restriction-lock 'file)))
25043 (t (user-error "Don't know how to restrict Org-mode's agenda")))
25044 (move-overlay org-speedbar-restriction-lock-overlay
25045 (point-at-bol) (point-at-eol))
25046 (setq current-prefix-arg nil)
25047 (org-agenda-maybe-redo)))
25049 (defvar speedbar-file-key-map)
25050 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25051 (eval-after-load "speedbar"
25053 (speedbar-add-supported-extension ".org")
25054 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25055 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25056 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25057 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25058 (add-hook 'speedbar-visiting-tag-hook
25059 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25061 ;;; Fixes and Hacks for problems with other packages
25063 (defun org--flyspell-object-check-p (element)
25064 "Non-nil when Flyspell can check object at point.
25065 ELEMENT is the element at point."
25066 (let ((object (save-excursion
25067 (when (org-looking-at-p "\\>") (backward-char))
25068 (org-element-context element))))
25069 (case (org-element-type object)
25070 ;; Prevent checks in links due to keybinding conflict with
25072 ((code entity export-snippet inline-babel-call
25073 inline-src-block line-break latex-fragment link macro
25074 statistics-cookie target timestamp verbatim)
25076 (footnote-reference
25077 ;; Only in inline footnotes, within the definition.
25078 (and (eq (org-element-property :type object) 'inline)
25080 (goto-char (org-element-property :begin object))
25081 (search-forward ":" nil t 2))
25085 (defun org-mode-flyspell-verify ()
25086 "Function used for `flyspell-generic-check-word-predicate'."
25087 (if (org-at-heading-p)
25088 ;; At a headline or an inlinetask, check title only. This is
25089 ;; faster than relying on `org-element-at-point'.
25090 (and (save-excursion (beginning-of-line)
25091 (and (let ((case-fold-search t))
25092 (not (looking-at "\\*+ END[ \t]*$")))
25093 (looking-at org-complex-heading-regexp)))
25094 (match-beginning 4)
25095 (>= (point) (match-beginning 4))
25096 (or (not (match-beginning 5))
25097 (< (point) (match-beginning 5))))
25098 (let* ((element (org-element-at-point))
25099 (post-affiliated (org-element-property :post-affiliated element)))
25101 ;; Ignore checks in all affiliated keywords but captions.
25102 ((< (point) post-affiliated)
25103 (and (save-excursion
25104 (beginning-of-line)
25105 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25106 (> (point) (match-end 0))
25107 (org--flyspell-object-check-p element)))
25108 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25109 ((let ((log (org-log-into-drawer)))
25111 (let ((drawer (org-element-lineage element '(drawer))))
25113 (eq (compare-strings
25115 (org-element-property :drawer-name drawer) nil nil t)
25119 (case (org-element-type element)
25120 ((comment quote-section) t)
25122 ;; Allow checks between block markers, not on them.
25123 (and (> (line-beginning-position) post-affiliated)
25126 (skip-chars-forward " \r\t\n")
25127 (< (point) (org-element-property :end element)))))
25128 ;; Arbitrary list of keywords where checks are meaningful.
25129 ;; Make sure point is on the value part of the element.
25131 (and (member (org-element-property :key element)
25132 '("DESCRIPTION" "TITLE"))
25134 (search-backward ":" (line-beginning-position) t))))
25135 ;; Check is globally allowed in paragraphs verse blocks and
25136 ;; table rows (after affiliated keywords) but some objects
25137 ;; must not be affected.
25138 ((paragraph table-row verse-block)
25139 (let ((cbeg (org-element-property :contents-begin element))
25140 (cend (org-element-property :contents-end element)))
25141 (and cbeg (>= (point) cbeg) (< (point) cend)
25142 (org--flyspell-object-check-p element))))))))))
25143 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25145 (defun org-remove-flyspell-overlays-in (beg end)
25146 "Remove flyspell overlays in region."
25147 (and (org-bound-and-true-p flyspell-mode)
25148 (fboundp 'flyspell-delete-region-overlays)
25149 (flyspell-delete-region-overlays beg end)))
25151 (defvar flyspell-delayed-commands)
25152 (eval-after-load "flyspell"
25153 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25155 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25156 (eval-after-load "bookmark"
25157 '(if (boundp 'bookmark-after-jump-hook)
25158 ;; We can use the hook
25159 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25160 ;; Hook not available, use advice
25161 (defadvice bookmark-jump (after org-make-visible activate)
25162 "Make the position visible."
25163 (org-bookmark-jump-unhide))))
25165 ;; Make sure saveplace shows the location if it was hidden
25166 (eval-after-load "saveplace"
25167 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25168 "Make the position visible."
25169 (org-bookmark-jump-unhide)))
25171 ;; Make sure ecb shows the location if it was hidden
25172 (eval-after-load "ecb"
25173 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25174 "Make hierarchy visible when jumping into location from ECB tree buffer."
25175 (if (derived-mode-p 'org-mode)
25176 (org-show-context))))
25178 (defun org-bookmark-jump-unhide ()
25179 "Unhide the current position, to show the bookmark location."
25180 (and (derived-mode-p 'org-mode)
25181 (or (outline-invisible-p)
25182 (save-excursion (goto-char (max (point-min) (1- (point))))
25183 (outline-invisible-p)))
25184 (org-show-context 'bookmark-jump)))
25186 (defun org-mark-jump-unhide ()
25187 "Make the point visible with `org-show-context' after jumping to the mark."
25188 (when (and (derived-mode-p 'org-mode)
25189 (outline-invisible-p))
25190 (org-show-context 'mark-goto)))
25192 (eval-after-load "simple"
25193 '(defadvice pop-to-mark-command (after org-make-visible activate)
25194 "Make the point visible with `org-show-context'."
25195 (org-mark-jump-unhide)))
25197 (eval-after-load "simple"
25198 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25199 "Make the point visible with `org-show-context'."
25200 (org-mark-jump-unhide)))
25202 (eval-after-load "simple"
25203 '(defadvice pop-global-mark (after org-make-visible activate)
25204 "Make the point visible with `org-show-context'."
25205 (org-mark-jump-unhide)))
25207 ;; Make session.el ignore our circular variable
25208 (defvar session-globals-exclude)
25209 (eval-after-load "session"
25210 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25216 (run-hooks 'org-load-hook)
25218 ;;; org.el ends here